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 /* defns for ubc_msync() and ubc_msync */
  44
  45 #define UBC_PUSHDIRTY   0x01    /* clean any dirty pages in the specified range to the backing store */
  46 #define UBC_PUSHALL     0x02    /* push both dirty and precious pages to the backing store */
  47 #define UBC_INVALIDATE  0x04    /* invalidate pages in the specified range... may be used with UBC_PUSHDIRTY/ALL */
  48 #define UBC_SYNC        0x08    /* wait for I/Os generated by UBC_PUSHDIRTY to complete */
  49
  50 __BEGIN_DECLS
  51
  52 off_t           ubc_blktooff(struct vnode *, daddr64_t);
  53 daddr64_t       ubc_offtoblk(struct vnode *, off_t);
  54 off_t   ubc_getsize(struct vnode *);
  55 int     ubc_setsize(struct vnode *, off_t);
  56
  57 #ifdef KERNEL_PRIVATE
  58
  59 enum {
  60         UBC_SETSIZE_NO_FS_REENTRY = 1
  61 };
  62 typedef uint32_t ubc_setsize_opts_t;
  63
  64 errno_t ubc_setsize_ex(vnode_t vp, off_t nsize, ubc_setsize_opts_t opts);
  65
  66 #endif // KERNEL_PRIVATE
  67
  68 kauth_cred_t ubc_getcred(struct vnode *);
  69 struct thread;
  70 int     ubc_setthreadcred(struct vnode *, struct proc *, struct thread *);
  71
  72 errno_t ubc_msync(vnode_t, off_t, off_t, off_t *, int);
  73 int     ubc_pages_resident(vnode_t);
  74 int     ubc_page_op(vnode_t, off_t, int, ppnum_t *, int *);
  75 int     ubc_range_op(vnode_t, off_t, off_t, int, int *);
  76
  77 #ifdef KERNEL_PRIVATE
  78 /* This API continues to exist only until <rdar://4714366> is resolved */
  79 int     ubc_setcred(struct vnode *, struct proc *) __deprecated;
  80 /* code signing */
  81 struct cs_blob;
  82 struct cs_blob *ubc_cs_blob_get(vnode_t, cpu_type_t, off_t);
  83
  84 /* apis to handle generation count for cs blob */
  85 void cs_blob_reset_cache(void);
  86 int ubc_cs_blob_revalidate(vnode_t, struct cs_blob *, int);
  87 int ubc_cs_generation_check(vnode_t);
  88
  89 int cs_entitlements_blob_get(proc_t, void **, size_t *);
  90 int cs_blob_get(proc_t, void **, size_t *);
  91 const char *cs_identity_get(proc_t);
  92 #endif
  93
  94 /* cluster IO routines */
  95 int     advisory_read(vnode_t, off_t, off_t, int);
  96 int     advisory_read_ext(vnode_t, off_t, off_t, int, int (*)(buf_t, void *), void *, int);
  97
  98 int     cluster_read(vnode_t, struct uio *, off_t, int);
  99 int     cluster_read_ext(vnode_t, struct uio *, off_t, int, int (*)(buf_t, void *), void *);
 100
 101 int     cluster_write(vnode_t, struct uio *, off_t, off_t, off_t, off_t, int);
 102 int     cluster_write_ext(vnode_t, struct uio *, off_t, off_t, off_t, off_t, int, int (*)(buf_t, void *), void *);
 103
 104 int     cluster_pageout(vnode_t, upl_t, upl_offset_t, off_t, int, off_t, int);
 105 int     cluster_pageout_ext(vnode_t, upl_t, upl_offset_t, off_t, int, off_t, int, int (*)(buf_t, void *), void *);
 106
 107 int     cluster_pagein(vnode_t, upl_t, upl_offset_t, off_t, int, off_t, int);
 108 int     cluster_pagein_ext(vnode_t, upl_t, upl_offset_t, off_t, int, off_t, int, int (*)(buf_t, void *), void *);
 109
 110 int     cluster_push(vnode_t, int);
 111 int     cluster_push_ext(vnode_t, int, int (*)(buf_t, void *), void *);
 112
 113 int     cluster_bp(buf_t);
 114 int     cluster_bp_ext(buf_t, int (*)(buf_t, void *), void *);
 115
 116 void    cluster_zero(upl_t, upl_offset_t, int, buf_t);
 117
 118 int     cluster_copy_upl_data(uio_t, upl_t, int, int *);
 119 int     cluster_copy_ubc_data(vnode_t, uio_t, int *, int);
 120
 121
 122 /* UPL routines */
 123 int     ubc_create_upl(vnode_t, off_t, int, upl_t *, upl_page_info_t **, int);
 124 int     ubc_upl_map(upl_t, vm_offset_t *);
 125 int     ubc_upl_unmap(upl_t);
 126 int     ubc_upl_commit(upl_t);
 127 int     ubc_upl_commit_range(upl_t, upl_offset_t, upl_size_t, int);
 128 int     ubc_upl_abort(upl_t, int);
 129 int     ubc_upl_abort_range(upl_t, upl_offset_t, upl_size_t, int);
 130 void    ubc_upl_range_needed(upl_t, int, int);
 131
 132 upl_page_info_t *ubc_upl_pageinfo(upl_t);
 133 upl_size_t ubc_upl_maxbufsize(void);
 134
 135 int     is_file_clean(vnode_t, off_t);
 136
 137 __END_DECLS
 138
 139 #endif  /* _SYS_UBC_H_ */
 140