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