bsd/sys/ubc.h

   1 /*
   2  * Copyright (c) 1999-2007 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  *      Header file for Unified Buffer Cache.
  30  *
  31  */
  32
  33 #ifndef _SYS_UBC_H_
  34 #define _SYS_UBC_H_
  35
  36 #include <sys/appleapiopts.h>
  37 #include <sys/cdefs.h>
  38 #include <sys/kernel_types.h>
  39 #include <kern/locks.h>
  40 #include <mach/memory_object_types.h>
  41 #include <sys/ucred.h>
  42
  43 #ifdef KERNEL_PRIVATE
  44 #include <sys/imgact.h>
  45 #endif // KERNEL_PRIVATE
  46
  47 /* defns for ubc_msync() and ubc_msync */
  48
  49 #define UBC_PUSHDIRTY   0x01    /* clean any dirty pages in the specified range to the backing store */
  50 #define UBC_PUSHALL     0x02    /* push both dirty and precious pages to the backing store */
  51 #define UBC_INVALIDATE  0x04    /* invalidate pages in the specified range... may be used with UBC_PUSHDIRTY/ALL */
  52 #define UBC_SYNC        0x08    /* wait for I/Os generated by UBC_PUSHDIRTY to complete */
  53
  54 __BEGIN_DECLS
  55
  56 off_t           ubc_blktooff(struct vnode *, daddr64_t);
  57 daddr64_t       ubc_offtoblk(struct vnode *, off_t);
  58 off_t   ubc_getsize(struct vnode *);
  59 int     ubc_setsize(struct vnode *, off_t);
  60
  61 #ifdef KERNEL_PRIVATE
  62
  63 enum {
  64         UBC_SETSIZE_NO_FS_REENTRY = 1
  65 };
  66 typedef uint32_t ubc_setsize_opts_t;
  67
  68 errno_t ubc_setsize_ex(vnode_t vp, off_t nsize, ubc_setsize_opts_t opts);
  69
  70 #endif // KERNEL_PRIVATE
  71
  72 kauth_cred_t ubc_getcred(struct vnode *);
  73 struct thread;
  74 int     ubc_setthreadcred(struct vnode *, struct proc *, struct thread *);
  75
  76 errno_t ubc_msync(vnode_t, off_t, off_t, off_t *, int);
  77 int     ubc_pages_resident(vnode_t);
  78 int     ubc_page_op(vnode_t, off_t, int, ppnum_t *, int *);
  79 int     ubc_range_op(vnode_t, off_t, off_t, int, int *);
  80
  81 #ifdef KERNEL_PRIVATE
  82 /* This API continues to exist only until <rdar://4714366> is resolved */
  83 int     ubc_setcred(struct vnode *, struct proc *) __deprecated;
  84 /* code signing */
  85 struct cs_blob;
  86 struct cs_blob *ubc_cs_blob_get(vnode_t, cpu_type_t, off_t);
  87
  88 /* apis to handle generation count for cs blob */
  89 void cs_blob_reset_cache(void);
  90 int ubc_cs_blob_revalidate(vnode_t, struct cs_blob *, struct image_params *, int);
  91 int ubc_cs_generation_check(vnode_t);
  92
  93 int cs_entitlements_blob_get(proc_t, void **, size_t *);
  94 int cs_blob_get(proc_t, void **, size_t *);
  95 const char *cs_identity_get(proc_t);
  96
  97 #endif
  98
  99 /* cluster IO routines */
 100 int     advisory_read(vnode_t, off_t, off_t, int);
 101 int     advisory_read_ext(vnode_t, off_t, off_t, int, int (*)(buf_t, void *), void *, int);
 102
 103 int     cluster_read(vnode_t, struct uio *, off_t, int);
 104 int     cluster_read_ext(vnode_t, struct uio *, off_t, int, int (*)(buf_t, void *), void *);
 105
 106 int     cluster_write(vnode_t, struct uio *, off_t, off_t, off_t, off_t, int);
 107 int     cluster_write_ext(vnode_t, struct uio *, off_t, off_t, off_t, off_t, int, int (*)(buf_t, void *), void *);
 108
 109 int     cluster_pageout(vnode_t, upl_t, upl_offset_t, off_t, int, off_t, int);
 110 int     cluster_pageout_ext(vnode_t, upl_t, upl_offset_t, off_t, int, off_t, int, int (*)(buf_t, void *), void *);
 111
 112 int     cluster_pagein(vnode_t, upl_t, upl_offset_t, off_t, int, off_t, int);
 113 int     cluster_pagein_ext(vnode_t, upl_t, upl_offset_t, off_t, int, off_t, int, int (*)(buf_t, void *), void *);
 114
 115 int     cluster_push(vnode_t, int);
 116 int     cluster_push_ext(vnode_t, int, int (*)(buf_t, void *), void *);
 117 int     cluster_push_err(vnode_t, int, int (*)(buf_t, void *), void *, int *);
 118
 119 int     cluster_bp(buf_t);
 120 int     cluster_bp_ext(buf_t, int (*)(buf_t, void *), void *);
 121
 122 void    cluster_zero(upl_t, upl_offset_t, int, buf_t);
 123
 124 int     cluster_copy_upl_data(uio_t, upl_t, int, int *);
 125 int     cluster_copy_ubc_data(vnode_t, uio_t, int *, int);
 126
 127 typedef struct cl_direct_read_lock cl_direct_read_lock_t;
 128 cl_direct_read_lock_t *cluster_lock_direct_read(vnode_t vp, lck_rw_type_t exclusive);
 129 void cluster_unlock_direct_read(cl_direct_read_lock_t *lck);
 130
 131 /* UPL routines */
 132 #ifndef XNU_KERNEL_PRIVATE
 133 int     ubc_create_upl(vnode_t, off_t, int, upl_t *, upl_page_info_t **, int);
 134 #endif /* XNU_KERNEL_PRIVATE */
 135 int     ubc_upl_map(upl_t, vm_offset_t *);
 136 int     ubc_upl_unmap(upl_t);
 137 int     ubc_upl_commit(upl_t);
 138 int     ubc_upl_commit_range(upl_t, upl_offset_t, upl_size_t, int);
 139 int     ubc_upl_abort(upl_t, int);
 140 int     ubc_upl_abort_range(upl_t, upl_offset_t, upl_size_t, int);
 141 void    ubc_upl_range_needed(upl_t, int, int);
 142
 143 upl_page_info_t *ubc_upl_pageinfo(upl_t);
 144 upl_size_t ubc_upl_maxbufsize(void);
 145
 146 int     is_file_clean(vnode_t, off_t);
 147
 148 errno_t mach_to_bsd_errno(kern_return_t mach_err);
 149
 150 #ifdef KERNEL_PRIVATE
 151
 152 int     ubc_create_upl_external(vnode_t, off_t, int, upl_t *, upl_page_info_t **, int);
 153 #ifdef  XNU_KERNEL_PRIVATE
 154 int     ubc_create_upl_kernel(vnode_t, off_t, int, upl_t *, upl_page_info_t **, int, vm_tag_t);
 155 #endif  /* XNU_KERNEL_PRIVATE */
 156
 157 __attribute__((pure)) boolean_t ubc_is_mapped(const struct vnode *, boolean_t *writable);
 158 __attribute__((pure)) boolean_t ubc_is_mapped_writable(const struct vnode *);
 159
 160 uint32_t cluster_max_io_size(mount_t, int);
 161
 162 #endif
 163
 164 __END_DECLS
 165
 166 #endif  /* _SYS_UBC_H_ */
 167