bsd/sys/ubc_internal.h

   1 /*
   2  * Copyright (c) 1999-2008 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*
  29  *      File:   ubc.h
  30  *      Author: Umesh Vaishampayan [umeshv@apple.com]
  31  *              05-Aug-1999     umeshv  Created.
  32  *
  33  *      Header file for Unified Buffer Cache.
  34  *
  35  */
  36
  37 #ifndef _SYS_UBC_INTERNAL_H_
  38 #define _SYS_UBC_INTERNAL_H_
  39
  40 #include <sys/appleapiopts.h>
  41 #include <sys/types.h>
  42 #include <sys/kernel_types.h>
  43 #include <sys/ucred.h>
  44 #include <sys/vnode.h>
  45 #include <sys/ubc.h>
  46 #include <sys/mman.h>
  47 #include <sys/codesign.h>
  48
  49 #include <sys/cdefs.h>
  50
  51 #include <kern/locks.h>
  52 #include <mach/memory_object_types.h>
  53
  54
  55 #define UBC_INFO_NULL   ((struct ubc_info *) 0)
  56
  57
  58 extern struct zone      *ubc_info_zone;
  59
  60 /*
  61  * Maximum number of vfs clusters per vnode
  62  */
  63 #define MAX_CLUSTERS    CONFIG_MAX_CLUSTERS
  64
  65 #define SPARSE_PUSH_LIMIT 4     /* limit on number of concurrent sparse pushes outside of the cl_lockw */
  66                                 /* once we reach this limit, we'll hold the lock */
  67
  68 struct cl_extent {
  69         daddr64_t       b_addr;
  70         daddr64_t       e_addr;
  71 };
  72
  73 struct cl_wextent {
  74         daddr64_t       b_addr;
  75         daddr64_t       e_addr;
  76         int             io_flags;
  77 };
  78
  79 struct cl_readahead {
  80         lck_mtx_t       cl_lockr;
  81         daddr64_t       cl_lastr;                       /* last block read by client */
  82         daddr64_t       cl_maxra;                       /* last block prefetched by the read ahead */
  83         int             cl_ralen;                       /* length of last prefetch */
  84 };
  85
  86 struct cl_writebehind {
  87         lck_mtx_t       cl_lockw;
  88         void    *       cl_scmap;                       /* pointer to sparse cluster map */
  89         off_t           cl_last_write;                  /* offset of the end of the last write */
  90         off_t           cl_seq_written;                 /* sequentially written bytes */
  91         int             cl_sparse_pushes;               /* number of pushes outside of the cl_lockw in progress */
  92         int             cl_sparse_wait;                 /* synchronous push is in progress */
  93         int             cl_number;                      /* number of packed write behind clusters currently valid */
  94         struct cl_wextent cl_clusters[MAX_CLUSTERS];    /* packed write behind clusters */
  95 };
  96
  97 struct cs_hash;
  98
  99 struct cs_blob {
 100         struct cs_blob  *csb_next;
 101         cpu_type_t      csb_cpu_type;
 102         unsigned int    csb_flags;
 103         off_t           csb_base_offset;        /* Offset of Mach-O binary in fat binary */
 104         off_t           csb_start_offset;       /* Blob coverage area start, from csb_base_offset */
 105         off_t           csb_end_offset;         /* Blob coverage area end, from csb_base_offset */
 106         ipc_port_t      csb_mem_handle;
 107         vm_size_t       csb_mem_size;
 108         vm_offset_t     csb_mem_offset;
 109         vm_address_t    csb_mem_kaddr;
 110         unsigned char   csb_cdhash[CS_CDHASH_LEN];
 111         struct cs_hash  *csb_hashtype;
 112         const char      *csb_teamid;
 113         unsigned int    csb_platform_binary:1;
 114         unsigned int    csb_platform_path:1;
 115 };
 116
 117 /*
 118  *      The following data structure keeps the information to associate
 119  *      a vnode to the correspondig VM objects.
 120  */
 121 struct ubc_info {
 122         memory_object_t         ui_pager;       /* pager */
 123         memory_object_control_t ui_control;     /* VM control for the pager */
 124         vnode_t                 ui_vnode;       /* vnode for this ubc_info */
 125         kauth_cred_t            ui_ucred;       /* holds credentials for NFS paging */
 126         off_t                   ui_size;        /* file size for the vnode */
 127         uint32_t                ui_flags;       /* flags */
 128         uint32_t                cs_add_gen;     /* generation count when csblob was validated */
 129
 130         struct  cl_readahead   *cl_rahead;      /* cluster read ahead context */
 131         struct  cl_writebehind *cl_wbehind;     /* cluster write behind context */
 132
 133         struct timespec         cs_mtime;       /* modify time of file when
 134                                                    first cs_blob was loaded */
 135         struct  cs_blob         *cs_blobs;      /* for CODE SIGNING */
 136 #if CHECK_CS_VALIDATION_BITMAP
 137         void                    *cs_valid_bitmap;     /* right now: used only for signed files on the read-only root volume */
 138         uint64_t                cs_valid_bitmap_size; /* Save original bitmap size in case the file size changes.
 139                                                        * In the future, we may want to reconsider changing the
 140                                                        * underlying bitmap to reflect the new file size changes.
 141                                                        */
 142 #endif /* CHECK_CS_VALIDATION_BITMAP */
 143 };
 144
 145 /* Defines for ui_flags */
 146 #define UI_NONE         0x00000000      /* none */
 147 #define UI_HASPAGER     0x00000001      /* has a pager associated */
 148 #define UI_INITED       0x00000002      /* newly initialized vnode */
 149 #define UI_HASOBJREF    0x00000004      /* hold a reference on object */
 150 #define UI_WASMAPPED    0x00000008      /* vnode was mapped */
 151 #define UI_ISMAPPED     0x00000010      /* vnode is currently mapped */
 152 #define UI_MAPBUSY      0x00000020      /* vnode is being mapped or unmapped */
 153 #define UI_MAPWAITING   0x00000040      /* someone waiting for UI_MAPBUSY */
 154 #define UI_MAPPEDWRITE  0x00000080      /* it's mapped with PROT_WRITE */
 155
 156 /*
 157  * exported primitives for loadable file systems.
 158  */
 159
 160 __BEGIN_DECLS
 161 __private_extern__ void ubc_init(void);
 162 __private_extern__ int  ubc_umount(mount_t mp);
 163 __private_extern__ void ubc_unmountall(void);
 164 __private_extern__ memory_object_t ubc_getpager(vnode_t);
 165 __private_extern__ void ubc_destroy_named(vnode_t);
 166
 167 /* internal only */
 168 __private_extern__ void cluster_release(struct ubc_info *);
 169 __private_extern__ uint32_t cluster_max_io_size(mount_t, int);
 170 __private_extern__ uint32_t cluster_throttle_io_limit(vnode_t, uint32_t *);
 171
 172
 173 /* Flags for ubc_getobject() */
 174 #define UBC_FLAGS_NONE          0x0000
 175 #define UBC_HOLDOBJECT          0x0001
 176 #define UBC_FOR_PAGEOUT         0x0002
 177
 178 memory_object_control_t ubc_getobject(vnode_t, int);
 179 boolean_t       ubc_strict_uncached_IO(vnode_t);
 180
 181 int     ubc_info_init(vnode_t);
 182 int     ubc_info_init_withsize(vnode_t, off_t);
 183 void    ubc_info_deallocate(struct ubc_info *);
 184
 185 int     ubc_isinuse(vnode_t, int);
 186 int     ubc_isinuse_locked(vnode_t, int, int);
 187
 188 int     ubc_getcdhash(vnode_t, off_t, unsigned char *);
 189
 190 __attribute__((pure)) boolean_t ubc_is_mapped(const struct vnode *, boolean_t *writable);
 191 __attribute__((pure)) boolean_t ubc_is_mapped_writable(const struct vnode *);
 192
 193 #ifdef XNU_KERNEL_PRIVATE
 194 int UBCINFOEXISTS(const struct vnode *);
 195 #endif /* XNU_KERNEL_PRIVATE */
 196
 197 /* code signing */
 198 struct cs_blob;
 199 int     ubc_cs_blob_add(vnode_t, cpu_type_t, off_t, vm_address_t, vm_size_t, int, struct cs_blob **);
 200 int     ubc_cs_sigpup_add(vnode_t, vm_address_t, vm_size_t);
 201 struct cs_blob *ubc_get_cs_blobs(vnode_t);
 202 void    ubc_get_cs_mtime(vnode_t, struct timespec *);
 203 int     ubc_cs_getcdhash(vnode_t, off_t, unsigned char *);
 204 kern_return_t ubc_cs_blob_allocate(vm_offset_t *, vm_size_t *);
 205 void ubc_cs_blob_deallocate(vm_offset_t, vm_size_t);
 206
 207 kern_return_t   ubc_cs_validation_bitmap_allocate( vnode_t );
 208 void            ubc_cs_validation_bitmap_deallocate( vnode_t );
 209 __END_DECLS
 210
 211
 212 #endif  /* _SYS_UBC_INTERNAL_H_ */
 213