1 | /* |
2 | * Copyright (c) 2000-2012 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 | /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */ |
29 | /* |
30 | * Copyright (c) 1989, 1993 |
31 | * The Regents of the University of California. All rights reserved. |
32 | * |
33 | * Redistribution and use in source and binary forms, with or without |
34 | * modification, are permitted provided that the following conditions |
35 | * are met: |
36 | * 1. Redistributions of source code must retain the above copyright |
37 | * notice, this list of conditions and the following disclaimer. |
38 | * 2. Redistributions in binary form must reproduce the above copyright |
39 | * notice, this list of conditions and the following disclaimer in the |
40 | * documentation and/or other materials provided with the distribution. |
41 | * 3. All advertising materials mentioning features or use of this software |
42 | * must display the following acknowledgement: |
43 | * This product includes software developed by the University of |
44 | * California, Berkeley and its contributors. |
45 | * 4. Neither the name of the University nor the names of its contributors |
46 | * may be used to endorse or promote products derived from this software |
47 | * without specific prior written permission. |
48 | * |
49 | * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND |
50 | * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
51 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
52 | * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE |
53 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
54 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
55 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
56 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
57 | * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
58 | * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
59 | * SUCH DAMAGE. |
60 | * |
61 | * @(#)vnode.h 8.17 (Berkeley) 5/20/95 |
62 | */ |
63 | /* |
64 | * NOTICE: This file was modified by SPARTA, Inc. in 2005 to introduce |
65 | * support for mandatory and extensible security protections. This notice |
66 | * is included in support of clause 2.2 (b) of the Apple Public License, |
67 | * Version 2.0. |
68 | */ |
69 | |
70 | #ifndef _SYS_VNODE_INTERNAL_H_ |
71 | #define _SYS_VNODE_INTERNAL_H_ |
72 | |
73 | #include <sys/appleapiopts.h> |
74 | #include <sys/cdefs.h> |
75 | #include <sys/queue.h> |
76 | #include <sys/lock.h> |
77 | |
78 | #include <sys/time.h> |
79 | #include <sys/uio.h> |
80 | |
81 | #include <sys/vm.h> |
82 | #include <sys/systm.h> |
83 | #include <kern/locks.h> |
84 | #include <vm/vm_kern.h> |
85 | #include <sys/vnode.h> |
86 | #include <sys/namei.h> |
87 | #include <kern/smr.h> |
88 | #include <sys/vfs_context.h> |
89 | #include <sys/sysctl.h> |
90 | |
91 | |
92 | struct lockf; |
93 | struct label; |
94 | |
95 | LIST_HEAD(buflists, buf); |
96 | |
97 | #if CONFIG_TRIGGERS |
98 | /* |
99 | * VFS Internal (private) trigger vnode resolver info. |
100 | */ |
101 | struct vnode_resolve { |
102 | lck_mtx_t vr_lock; /* protects vnode_resolve_t fields */ |
103 | trigger_vnode_resolve_callback_t vr_resolve_func; |
104 | trigger_vnode_unresolve_callback_t vr_unresolve_func; |
105 | trigger_vnode_rearm_callback_t vr_rearm_func; |
106 | trigger_vnode_reclaim_callback_t vr_reclaim_func; |
107 | void * vr_data; /* private data for resolver */ |
108 | uint32_t vr_flags; |
109 | uint32_t vr_lastseq; |
110 | }; |
111 | typedef struct vnode_resolve *vnode_resolve_t; |
112 | |
113 | /* private vr_flags */ |
114 | #define VNT_RESOLVED (1UL << 31) |
115 | #define VNT_VFS_UNMOUNTED (1UL << 30) |
116 | #define VNT_EXTERNAL (1UL << 29) |
117 | |
118 | #endif /* CONFIG_TRIGGERS */ |
119 | |
120 | #if CONFIG_IOCOUNT_TRACE |
121 | #define IOCOUNT_TRACE_VGET 0 |
122 | #define IOCOUNT_TRACE_VPUT 1 |
123 | #define IOCOUNT_TRACE_MAX_TYPES 2 |
124 | #define IOCOUNT_TRACE_MAX_IDX 16 |
125 | #define IOCOUNT_TRACE_MAX_FRAMES 10 |
126 | |
127 | struct vnode_iocount_trace { |
128 | int idx; |
129 | int counts[IOCOUNT_TRACE_MAX_IDX]; |
130 | void *stacks[IOCOUNT_TRACE_MAX_IDX][IOCOUNT_TRACE_MAX_FRAMES]; |
131 | }; |
132 | typedef struct vnode_iocount_trace *vnode_iocount_trace_t; |
133 | #endif /* CONFIG_IOCOUNT_TRACE */ |
134 | |
135 | #if CONFIG_FILE_LEASES |
136 | #define FL_FLAG_RELEASE_PENDING 0x00000001 |
137 | #define FL_FLAG_DOWNGRADE_PENDING 0x00000002 |
138 | |
139 | struct file_lease { |
140 | LIST_ENTRY(file_lease) fl_link; |
141 | struct fileglob *fl_fg; /* The file that the lease is placed on */ |
142 | pid_t fl_pid; /* The process's pid that owns the lease */ |
143 | int fl_type; /* The file lease type: F_RDLCK, F_WRLCK */ |
144 | uint32_t fl_flags; /* The file lease flags */ |
145 | uint64_t fl_release_start; /* The lease release start time */ |
146 | uint64_t fl_downgrade_start; /* The lease downgrade start time */ |
147 | }; |
148 | typedef struct file_lease *file_lease_t; |
149 | #endif /* CONFIG_FILE_LEASES */ |
150 | |
151 | /* |
152 | * Reading or writing any of these items requires holding the appropriate lock. |
153 | * v_freelist is locked by the global vnode_list_lock |
154 | * v_mntvnodes is locked by the mount_lock |
155 | * v_nclinks and v_ncchildren are protected by the global name_cache_lock |
156 | * v_cleanblkhd and v_dirtyblkhd and v_iterblkflags are locked via the global buf_mtx |
157 | * the rest of the structure is protected by the vnode_lock |
158 | */ |
159 | struct vnode { |
160 | lck_mtx_t v_lock; /* vnode mutex */ |
161 | TAILQ_ENTRY(vnode) v_freelist; /* vnode freelist */ |
162 | TAILQ_ENTRY(vnode) v_mntvnodes; /* vnodes for mount point */ |
163 | TAILQ_HEAD(, namecache) v_ncchildren; /* name cache entries that regard us as their parent */ |
164 | LIST_HEAD(, namecache) v_nclinks; /* name cache entries that name this vnode */ |
165 | vnode_t v_defer_reclaimlist; /* in case we have to defer the reclaim to avoid recursion */ |
166 | uint32_t v_listflag; /* flags protected by the vnode_list_lock (see below) */ |
167 | uint32_t v_flag; /* vnode flags (see below) */ |
168 | uint16_t v_lflag; /* vnode local and named ref flags */ |
169 | uint8_t v_iterblkflags; /* buf iterator flags */ |
170 | uint8_t v_references; /* number of times io_count has been granted */ |
171 | int32_t v_kusecount; /* count of in-kernel refs */ |
172 | int32_t v_usecount; /* reference count of users */ |
173 | int32_t v_iocount; /* iocounters */ |
174 | void * XNU_PTRAUTH_SIGNED_PTR("vnode.v_owner" ) v_owner; /* act that owns the vnode */ |
175 | uint16_t v_type; /* vnode type */ |
176 | uint16_t v_tag; /* type of underlying data */ |
177 | uint32_t v_id; /* identity of vnode contents */ |
178 | union { |
179 | struct mount * XNU_PTRAUTH_SIGNED_PTR("vnode.v_data" ) vu_mountedhere; /* ptr to mounted vfs (VDIR) */ |
180 | struct socket * XNU_PTRAUTH_SIGNED_PTR("vnode.vu_socket" ) vu_socket; /* unix ipc (VSOCK) */ |
181 | struct specinfo * XNU_PTRAUTH_SIGNED_PTR("vnode.vu_specinfo" ) vu_specinfo; /* device (VCHR, VBLK) */ |
182 | struct fifoinfo * XNU_PTRAUTH_SIGNED_PTR("vnode.vu_fifoinfo" ) vu_fifoinfo; /* fifo (VFIFO) */ |
183 | struct ubc_info * XNU_PTRAUTH_SIGNED_PTR("vnode.vu_ubcinfo" ) vu_ubcinfo; /* valid for (VREG) */ |
184 | } v_un; |
185 | struct buflists v_cleanblkhd; /* clean blocklist head */ |
186 | struct buflists v_dirtyblkhd; /* dirty blocklist head */ |
187 | struct klist v_knotes; /* knotes attached to this vnode */ |
188 | /* |
189 | * the following 4 fields are protected |
190 | * by the name_cache_lock held in |
191 | * excluive mode |
192 | */ |
193 | kauth_cred_t XNU_PTRAUTH_SIGNED_PTR("vnode.v_cred" ) v_cred; /* last authorized credential */ |
194 | kauth_action_t v_authorized_actions; /* current authorized actions for v_cred */ |
195 | int v_cred_timestamp; /* determine if entry is stale for MNTK_AUTH_OPAQUE */ |
196 | int v_nc_generation; /* changes when nodes are removed from the name cache */ |
197 | /* |
198 | * back to the vnode lock for protection |
199 | */ |
200 | int32_t v_numoutput; /* num of writes in progress */ |
201 | int32_t v_writecount; /* reference count of writers */ |
202 | uint32_t v_holdcount; /* reference to keep vnode from being freed after reclaim */ |
203 | const char *v_name; /* name component of the vnode */ |
204 | vnode_t XNU_PTRAUTH_SIGNED_PTR("vnode.v_parent" ) v_parent; /* pointer to parent vnode */ |
205 | struct lockf *v_lockf; /* advisory lock list head */ |
206 | int(**v_op)(void *); /* vnode operations vector */ |
207 | mount_t XNU_PTRAUTH_SIGNED_PTR("vnode.v_mount" ) v_mount; /* ptr to vfs we are in */ |
208 | void * v_data; /* private data for fs */ |
209 | #if CONFIG_MACF |
210 | struct label *v_label; /* MAC security label */ |
211 | #endif |
212 | #if CONFIG_TRIGGERS |
213 | vnode_resolve_t v_resolve; /* trigger vnode resolve info (VDIR only) */ |
214 | #endif /* CONFIG_TRIGGERS */ |
215 | #if CONFIG_FIRMLINKS |
216 | vnode_t v_fmlink; /* firmlink if set (VDIR only), Points to source |
217 | * if VFLINKTARGET is set, if VFLINKTARGET is not |
218 | * set, points to target */ |
219 | #endif /* CONFIG_FIRMLINKS */ |
220 | #if CONFIG_IO_COMPRESSION_STATS |
221 | io_compression_stats_t io_compression_stats; /* IO compression statistics */ |
222 | #endif /* CONFIG_IO_COMPRESSION_STATS */ |
223 | |
224 | #if CONFIG_IOCOUNT_TRACE |
225 | vnode_iocount_trace_t v_iocount_trace; |
226 | #endif /* CONFIG_IOCOUNT_TRACE */ |
227 | |
228 | #if CONFIG_FILE_LEASES |
229 | LIST_HEAD(fl_head, file_lease) v_leases; /* list of leases in place */ |
230 | #endif /* CONFIG_FILE_LEASES */ |
231 | }; |
232 | |
233 | #define v_mountedhere v_un.vu_mountedhere |
234 | #define v_socket v_un.vu_socket |
235 | #define v_specinfo v_un.vu_specinfo |
236 | #define v_fifoinfo v_un.vu_fifoinfo |
237 | #define v_ubcinfo v_un.vu_ubcinfo |
238 | |
239 | |
240 | /* |
241 | * v_iterblkflags |
242 | */ |
243 | #define VBI_ITER 0x1 |
244 | #define VBI_ITERWANT 0x2 |
245 | #define VBI_CLEAN 0x4 |
246 | #define VBI_DIRTY 0x8 |
247 | #define VBI_NEWBUF 0x10 |
248 | |
249 | /* |
250 | * v_listflag |
251 | */ |
252 | #define VLIST_RAGE 0x01 /* vnode is currently in the rapid age list */ |
253 | #define VLIST_DEAD 0x02 /* vnode is currently in the dead list */ |
254 | #define VLIST_ASYNC_WORK 0x04 /* vnode is currently on the deferred async work queue */ |
255 | #define VLIST_NO_REUSE 0x08 /* vnode should not be reused, will be deallocated */ |
256 | |
257 | /* |
258 | * v_lflags |
259 | */ |
260 | #define VL_SUSPENDED 0x0001 /* vnode is suspended */ |
261 | #define VL_DRAIN 0x0002 /* vnode is being drained */ |
262 | #define VL_TERMINATE 0x0004 /* vnode is in the process of being recycled */ |
263 | #define VL_TERMWANT 0x0008 /* there's a waiter for recycle finish (vnode_getiocount)*/ |
264 | #define VL_DEAD 0x0010 /* vnode is dead, cleaned of filesystem-specific info */ |
265 | #define VL_MARKTERM 0x0020 /* vnode should be recycled when no longer referenced */ |
266 | #define VL_OPSCHANGE 0x0040 /* device vnode is changing vnodeops */ |
267 | #define VL_NEEDINACTIVE 0x0080 /* delay VNOP_INACTIVE until iocount goes to 0 */ |
268 | |
269 | #define VL_LABEL 0x0100 /* vnode is marked for labeling */ |
270 | #define VL_LABELWAIT 0x0200 /* vnode is marked for labeling */ |
271 | #define VL_LABELED 0x0400 /* vnode is labeled */ |
272 | #define VL_LWARNED 0x0800 |
273 | #define VL_HASSTREAMS 0x1000 /* vnode has had at least one associated named stream vnode (may not have one any longer) */ |
274 | |
275 | #define VNAMED_UBC 0x2000 /* ubc named reference */ |
276 | #define VNAMED_MOUNT 0x4000 /* mount point named reference */ |
277 | #define VNAMED_FSHASH 0x8000 /* FS hash named reference */ |
278 | |
279 | /* |
280 | * v_flags |
281 | */ |
282 | #define VROOT 0x000001 /* root of its file system */ |
283 | #define VTEXT 0x000002 /* vnode is a pure text prototype */ |
284 | #define VSYSTEM 0x000004 /* vnode being used by kernel */ |
285 | #define VISTTY 0x000008 /* vnode represents a tty */ |
286 | #define VRAGE 0x000010 /* vnode is in rapid age state */ |
287 | #define VBDEVVP 0x000020 /* vnode created by bdevvp */ |
288 | #define VDEVFLUSH 0x000040 /* device vnode after vflush */ |
289 | #define VMOUNT 0x000080 /* mount operation in progress */ |
290 | #define VBWAIT 0x000100 /* waiting for output to complete */ |
291 | #define VSHARED_DYLD 0x000200 /* vnode is a dyld shared cache file */ |
292 | #define VNOCACHE_DATA 0x000400 /* don't keep data cached once it's been consumed */ |
293 | #define VSTANDARD 0x000800 /* vnode obtained from common pool */ |
294 | #define VAGE 0x001000 /* Insert vnode at head of free list */ |
295 | #define VRAOFF 0x002000 /* read ahead disabled */ |
296 | #define VNCACHEABLE 0x004000 /* vnode is allowed to be put back in name cache */ |
297 | #if NAMEDSTREAMS |
298 | #define VISSHADOW 0x008000 /* vnode is a shadow file */ |
299 | #endif |
300 | #define VSWAP 0x010000 /* vnode is being used as swapfile */ |
301 | #define VTHROTTLED 0x020000 /* writes or pageouts have been throttled */ |
302 | /* wakeup tasks waiting when count falls below threshold */ |
303 | #define VNOFLUSH 0x040000 /* don't vflush() if SKIPSYSTEM */ |
304 | #define VLOCKLOCAL 0x080000 /* this vnode does adv locking in vfs */ |
305 | #define VISHARDLINK 0x100000 /* hard link needs special processing on lookup and in volfs */ |
306 | #define VISUNION 0x200000 /* union special processing */ |
307 | #define VISNAMEDSTREAM 0x400000 /* vnode is a named stream (eg HFS resource fork) */ |
308 | #define VOPENEVT 0x800000 /* if process is P_CHECKOPENEVT, then or in the O_EVTONLY flag on open */ |
309 | #define VCANDEALLOC 0x1000000 |
310 | #define VNOCS 0x2000000 /* is there no code signature available */ |
311 | #define VISDIRTY 0x4000000 /* vnode will need IO if reclaimed */ |
312 | #define VFASTDEVCANDIDATE 0x8000000 /* vnode is a candidate to store on a fast device */ |
313 | #define VAUTOCANDIDATE 0x10000000 /* vnode was automatically marked as a fast-dev candidate */ |
314 | #define VFMLINKTARGET 0x20000000 /* vnode is firmlink target */ |
315 | #define VMOUNTEDHERE 0x40000000 /* vnode is a mountpoint */ |
316 | /* |
317 | * 0x80000000 not used. |
318 | */ |
319 | |
320 | /* |
321 | * This structure describes vnode data which is specific to a file descriptor. |
322 | * It is currently used only for file descriptors which are for opened for |
323 | * directories. |
324 | */ |
325 | struct fd_vn_data { |
326 | lck_mtx_t fv_lock; /* Used to serialize directory enumeration on fd */ |
327 | off_t fv_offset; /* Offset to be used */ |
328 | void *fv_dircookie; /* If FS doesn't like offsets in directories */ |
329 | caddr_t fv_buf; /* Temporary buffer to store directory entries */ |
330 | size_t fv_bufsiz; /* Valid size of fv_buf */ |
331 | size_t fv_bufdone; /* How much of fv_buf is processed */ |
332 | size_t fv_bufallocsiz; /* Allocation size determined for Buffer*/ |
333 | off_t fv_soff; /* Starting FS offset for this buffer */ |
334 | off_t fv_eoff; /* Ending FS offset for this buffer */ |
335 | int fv_eofflag;/* Does fv_eoff represent EOF ? */ |
336 | }; |
337 | |
338 | /* |
339 | * FV_DIRBUF_START_SIZ is the initial size of the buffer passed to VNOP_READDIR. |
340 | * That may not be enough for some filesytems so the current algorithm works its |
341 | * way upto FV_DIRBUF_MAX_SIZ |
342 | */ |
343 | #define FV_DIRBUF_DIRENTRY_SIZ (sizeof(struct direntry)) |
344 | #define FV_DIRBUF_START_SIZ FV_DIRBUF_DIRENTRY_SIZ |
345 | #define FV_DIRBUF_MAX_SIZ (4*(sizeof(struct direntry))) |
346 | |
347 | #define FV_LOCK(fvd) lck_mtx_lock(&(((struct fd_vn_data *)fvd)->fv_lock)) |
348 | #define FV_UNLOCK(fvd) lck_mtx_unlock(&(((struct fd_vn_data *)fvd)->fv_lock)) |
349 | |
350 | /* |
351 | * Global vnode data. |
352 | */ |
353 | extern struct vnode *rootvnode; /* root (i.e. "/") vnode */ |
354 | |
355 | #ifdef CONFIG_IMGSRC_ACCESS |
356 | #define MAX_IMAGEBOOT_NESTING 2 |
357 | extern struct vnode *imgsrc_rootvnodes[]; |
358 | #endif /* CONFIG_IMGSRC_ACCESS */ |
359 | |
360 | |
361 | /* |
362 | * Mods for exensibility. |
363 | */ |
364 | |
365 | /* |
366 | * Flags for vdesc_flags: |
367 | */ |
368 | #define VDESC_MAX_VPS 16 |
369 | /* Low order 16 flag bits are reserved for willrele flags for vp arguments. */ |
370 | #define VDESC_VP0_WILLRELE 0x00001 |
371 | #define VDESC_VP1_WILLRELE 0x00002 |
372 | #define VDESC_VP2_WILLRELE 0x00004 |
373 | #define VDESC_VP3_WILLRELE 0x00008 |
374 | #define VDESC_NOMAP_VPP 0x00100 |
375 | #define VDESC_VPP_WILLRELE 0x00200 |
376 | |
377 | #define VDESC_DISABLED 0x10000 /* descriptor defined but op is unused, has no op slot */ |
378 | |
379 | /* |
380 | * VDESC_NO_OFFSET is used to identify the end of the offset list |
381 | * and in places where no such field exists. |
382 | */ |
383 | #define VDESC_NO_OFFSET -1 |
384 | |
385 | /* |
386 | * This structure describes the vnode operation taking place. |
387 | */ |
388 | struct vnodeop_desc { |
389 | int vdesc_offset; /* offset in vector--first for speed */ |
390 | const char *vdesc_name; /* a readable name for debugging */ |
391 | int vdesc_flags; /* VDESC_* flags */ |
392 | |
393 | /* |
394 | * These ops are used by bypass routines to map and locate arguments. |
395 | * Creds and procs are not needed in bypass routines, but sometimes |
396 | * they are useful to (for example) transport layers. |
397 | * Nameidata is useful because it has a cred in it. |
398 | */ |
399 | int *vdesc_vp_offsets; /* list ended by VDESC_NO_OFFSET */ |
400 | int vdesc_vpp_offset; /* return vpp location */ |
401 | int vdesc_cred_offset; /* cred location, if any */ |
402 | int vdesc_proc_offset; /* proc location, if any */ |
403 | int vdesc_componentname_offset; /* if any */ |
404 | int vdesc_context_offset; /* context location, if any */ |
405 | /* |
406 | * Finally, we've got a list of private data (about each operation) |
407 | * for each transport layer. (Support to manage this list is not |
408 | * yet part of BSD.) |
409 | */ |
410 | caddr_t *vdesc_transports; |
411 | }; |
412 | |
413 | /* |
414 | * A list of all the operation descs. |
415 | */ |
416 | extern struct vnodeop_desc *vnodeop_descs[]; |
417 | |
418 | |
419 | /* |
420 | * This macro is very helpful in defining those offsets in the vdesc struct. |
421 | * |
422 | * This is stolen from X11R4. I ingored all the fancy stuff for |
423 | * Crays, so if you decide to port this to such a serious machine, |
424 | * you might want to consult Intrisics.h's XtOffset{,Of,To}. |
425 | */ |
426 | #define VOPARG_OFFSET(p_type, field) \ |
427 | ((int) (((char *) (&(((p_type)NULL)->field))) - ((char *) NULL))) |
428 | #define VOPARG_OFFSETOF(s_type, field) \ |
429 | VOPARG_OFFSET(s_type*,field) |
430 | #define VOPARG_OFFSETTO(S_TYPE, S_OFFSET, STRUCT_P) \ |
431 | ((S_TYPE)(((char*)(STRUCT_P))+(S_OFFSET))) |
432 | |
433 | |
434 | |
435 | /* |
436 | * VOCALL calls an op given an ops vector. We break it out because BSD's |
437 | * vclean changes the ops vector and then wants to call ops with the old |
438 | * vector. |
439 | */ |
440 | #define VOCALL(OPSV, OFF, AP) (( *((OPSV)[(OFF)])) (AP)) |
441 | |
442 | /* |
443 | * This call works for vnodes in the kernel. |
444 | */ |
445 | #define VCALL(VP, OFF, AP) VOCALL((VP)->v_op,(OFF),(AP)) |
446 | #define VDESC(OP) (& __CONCAT(OP,_desc)) |
447 | #define VOFFSET(OP) (VDESC(OP)->vdesc_offset) |
448 | |
449 | struct ostat; |
450 | |
451 | /* bdevvp moved to vnode.h as private KPI */ |
452 | void cvtstat(struct stat *st, struct ostat *ost); |
453 | void vprint(const char *label, struct vnode *vp); |
454 | |
455 | |
456 | __private_extern__ int set_package_extensions_table(user_addr_t data, int nentries, int maxwidth); |
457 | int vn_rdwr_64(enum uio_rw rw, struct vnode *vp, uint64_t base, |
458 | int64_t len, off_t offset, enum uio_seg segflg, |
459 | int ioflg, kauth_cred_t cred, int64_t *aresid, |
460 | struct proc *p); |
461 | #if CONFIG_MACF |
462 | int vn_setlabel(struct vnode *vp, struct label *intlabel, |
463 | vfs_context_t context); |
464 | #endif |
465 | void fifo_printinfo(struct vnode *vp); |
466 | int vn_open(struct nameidata *ndp, int fmode, int cmode); |
467 | int vn_open_modflags(struct nameidata *ndp, int *fmode, int cmode); |
468 | int vn_open_auth(struct nameidata *ndp, int *fmode, struct vnode_attr *, vnode_t authvp); |
469 | int vn_close(vnode_t, int flags, vfs_context_t ctx); |
470 | errno_t vn_remove(vnode_t dvp, vnode_t *vpp, struct nameidata *ndp, int32_t flags, struct vnode_attr *vap, vfs_context_t ctx); |
471 | errno_t vn_rename(struct vnode *fdvp, struct vnode **fvpp, struct componentname *fcnp, struct vnode_attr *fvap, |
472 | struct vnode *tdvp, struct vnode **tvpp, struct componentname *tcnp, struct vnode_attr *tvap, |
473 | uint32_t flags, vfs_context_t ctx); |
474 | |
475 | void lock_vnode_and_post(vnode_t, int); |
476 | |
477 | #define post_event_if_success(_vp, _error, _event) \ |
478 | do { \ |
479 | if (0 == (_error)) { \ |
480 | lock_vnode_and_post((_vp), (_event)); \ |
481 | } \ |
482 | } while (0) |
483 | |
484 | /* Authorization subroutines */ |
485 | int vn_authorize_open_existing(vnode_t vp, struct componentname *cnp, int fmode, vfs_context_t ctx, void *reserved); |
486 | int vn_authorize_create(vnode_t, struct componentname *, struct vnode_attr *, vfs_context_t, void*); |
487 | int vn_attribute_prepare(vnode_t dvp, struct vnode_attr *vap, uint32_t *defaulted_fieldsp, vfs_context_t ctx); |
488 | void vn_attribute_cleanup(struct vnode_attr *vap, uint32_t defaulted_fields); |
489 | int vn_authorize_rename(struct vnode *fdvp, struct vnode *fvp, struct componentname *fcnp, |
490 | struct vnode *tdvp, struct vnode *tvp, struct componentname *tcnp, |
491 | vfs_context_t ctx, void *reserved); |
492 | int vn_authorize_renamex(struct vnode *fdvp, struct vnode *fvp, struct componentname *fcnp, |
493 | struct vnode *tdvp, struct vnode *tvp, struct componentname *tcnp, |
494 | vfs_context_t ctx, vfs_rename_flags_t flags, void *reserved); |
495 | int vn_authorize_renamex_with_paths(struct vnode *fdvp, struct vnode *fvp, struct componentname *fcnp, const char *from_path, |
496 | struct vnode *tdvp, struct vnode *tvp, struct componentname *tcnp, const char *to_path, |
497 | vfs_context_t ctx, vfs_rename_flags_t flags, void *reserved); |
498 | |
499 | typedef int (*vn_create_authorizer_t)(vnode_t, struct componentname *, struct vnode_attr *, vfs_context_t, void*); |
500 | int vn_authorize_mkdir(vnode_t, struct componentname *, struct vnode_attr *, vfs_context_t, void*); |
501 | int vn_authorize_null(vnode_t, struct componentname *, struct vnode_attr *, vfs_context_t, void*); |
502 | int vnode_attr_authorize_dir_clone(struct vnode_attr *vap, kauth_action_t action, |
503 | struct vnode_attr *dvap, vnode_t sdvp, mount_t mp, dir_clone_authorizer_op_t vattr_op, |
504 | uint32_t flags, vfs_context_t ctx, void *reserved); |
505 | /* End of authorization subroutines */ |
506 | |
507 | void vnode_attr_handle_uid_and_gid(struct vnode_attr *vap, mount_t mp, vfs_context_t ctx); |
508 | |
509 | #define VN_CREATE_NOAUTH (1<<0) |
510 | #define VN_CREATE_NOINHERIT (1<<1) |
511 | #define VN_CREATE_UNION (1<<2) |
512 | #define VN_CREATE_NOLABEL (1<<3) |
513 | #define VN_CREATE_DOOPEN (1<<4) /* Open file if a batched operation is available */ |
514 | errno_t vn_create(vnode_t, vnode_t *, struct nameidata *, struct vnode_attr *, uint32_t, int, uint32_t*, vfs_context_t); |
515 | int vn_mkdir(vnode_t dvp, vnode_t *vpp, struct nameidata *ndp, struct vnode_attr *vap, vfs_context_t ctx); |
516 | int vn_rmdir(vnode_t dvp, vnode_t *vpp, struct nameidata *ndp, struct vnode_attr *vap, vfs_context_t ctx); |
517 | |
518 | int vn_getxattr(vnode_t, const char *, uio_t, size_t *, int, vfs_context_t); |
519 | int vn_setxattr(vnode_t, const char *, uio_t, int, vfs_context_t); |
520 | int vn_removexattr(vnode_t, const char *, int, vfs_context_t); |
521 | int vn_listxattr(vnode_t, uio_t, size_t *, int, vfs_context_t); |
522 | |
523 | #if NAMEDSTREAMS |
524 | errno_t vnode_getnamedstream(vnode_t, vnode_t *, const char *, enum nsoperation, int, vfs_context_t); |
525 | errno_t vnode_makenamedstream(vnode_t, vnode_t *, const char *, int, vfs_context_t); |
526 | errno_t vnode_removenamedstream(vnode_t, vnode_t, const char *, int, vfs_context_t); |
527 | errno_t vnode_flushnamedstream(vnode_t vp, vnode_t svp, vfs_context_t context); |
528 | errno_t vnode_relenamedstream(vnode_t vp, vnode_t svp); |
529 | errno_t vnode_verifynamedstream(vnode_t vp); |
530 | #endif |
531 | |
532 | |
533 | void nchinit(void); |
534 | int resize_namecache(int newsize); |
535 | void name_cache_lock_shared(void); |
536 | boolean_t name_cache_lock_shared_to_exclusive(void); |
537 | void name_cache_lock(void); |
538 | void name_cache_unlock(void); |
539 | void cache_enter_with_gen(vnode_t dvp, vnode_t vp, struct componentname *cnp, int gen); |
540 | const char *cache_enter_create(vnode_t dvp, vnode_t vp, struct componentname *cnp); |
541 | |
542 | extern int nc_disabled; |
543 | |
544 | #define vnode_lock_convert(v) lck_mtx_convert_spin(&(v)->v_lock) |
545 | |
546 | void vnode_lock_spin(vnode_t); |
547 | |
548 | |
549 | void vnode_list_lock(void); |
550 | void vnode_list_unlock(void); |
551 | |
552 | #define VNODE_REF_FORCE 0x1 |
553 | int vnode_ref_ext(vnode_t, int, int); |
554 | |
555 | void vnode_rele_internal(vnode_t, int, int, int); |
556 | #ifdef BSD_KERNEL_PRIVATE |
557 | int vnode_getalways(vnode_t); |
558 | int (vnode_t); |
559 | int vget_internal(vnode_t, int, int); |
560 | errno_t vnode_getiocount(vnode_t, unsigned int, int); |
561 | vnode_t vnode_getparent_if_different(vnode_t, vnode_t); |
562 | #endif /* BSD_KERNEL_PRIVATE */ |
563 | int vnode_get_locked(vnode_t); |
564 | int vnode_put_locked(vnode_t); |
565 | #ifdef BSD_KERNEL_PRIVATE |
566 | int (vnode_t); |
567 | vnode_t vnode_drop_and_unlock(vnode_t); |
568 | #endif /* BSD_KERNEL_PRIVATE */ |
569 | |
570 | int vnode_issock(vnode_t); |
571 | int vnode_isaliased(vnode_t); |
572 | |
573 | void unlock_fsnode(vnode_t, int *); |
574 | int lock_fsnode(vnode_t, int *); |
575 | |
576 | errno_t vnode_resume(vnode_t); |
577 | errno_t vnode_suspend(vnode_t); |
578 | |
579 | |
580 | errno_t vnode_mtime(vnode_t, struct timespec *, vfs_context_t); |
581 | errno_t vnode_flags(vnode_t, uint32_t *, vfs_context_t); |
582 | |
583 | errno_t vnode_size(vnode_t, off_t *, vfs_context_t); |
584 | errno_t vnode_setsize(vnode_t, off_t, int ioflag, vfs_context_t); |
585 | int vnode_setattr_fallback(vnode_t vp, struct vnode_attr *vap, vfs_context_t ctx); |
586 | int vnode_isspec(vnode_t vp); |
587 | |
588 | |
589 | #ifdef BSD_KERNEL_PRIVATE |
590 | |
591 | typedef uint32_t compound_vnop_id_t; |
592 | #define COMPOUND_VNOP_OPEN 0x01 |
593 | #define COMPOUND_VNOP_MKDIR 0x02 |
594 | #define COMPOUND_VNOP_RENAME 0x04 |
595 | #define COMPOUND_VNOP_REMOVE 0x08 |
596 | #define COMPOUND_VNOP_RMDIR 0x10 |
597 | |
598 | int vnode_compound_rename_available(vnode_t vp); |
599 | int vnode_compound_rmdir_available(vnode_t vp); |
600 | int vnode_compound_mkdir_available(vnode_t vp); |
601 | int vnode_compound_remove_available(vnode_t vp); |
602 | int vnode_compound_open_available(vnode_t vp); |
603 | int vnode_compound_op_available(vnode_t, compound_vnop_id_t); |
604 | #endif /* BSD_KERNEL_PRIVATE */ |
605 | |
606 | void vn_setunionwait(vnode_t); |
607 | void vn_checkunionwait(vnode_t); |
608 | void vn_clearunionwait(vnode_t, int); |
609 | |
610 | void SPECHASH_LOCK(void); |
611 | void SPECHASH_UNLOCK(void); |
612 | lck_mtx_t * SPECHASH_LOCK_ADDR(void); |
613 | |
614 | void vnode_authorize_init(void); |
615 | |
616 | void vfsinit(void); |
617 | void vnode_lock(vnode_t); |
618 | void vnode_unlock(vnode_t); |
619 | |
620 | void vn_print_state(vnode_t /* vp */, const char * /* fmt */, ...) |
621 | __printflike(2, 3); |
622 | |
623 | #if DEVELOPMENT || DEBUG |
624 | #define VNASSERT(exp, vp, msg) \ |
625 | do { \ |
626 | if (__improbable(!(exp))) { \ |
627 | vn_print_state(vp, "VNASSERT failed %s:%d\n", __FILE__, \ |
628 | __LINE__); \ |
629 | panic msg; \ |
630 | } \ |
631 | } while (0) |
632 | #else |
633 | #define VNASSERT(exp, vp, msg) |
634 | #endif /* DEVELOPMENT || DEBUG */ |
635 | |
636 | /* |
637 | * XXX exported symbols; should be static |
638 | */ |
639 | void vfs_op_init(void); |
640 | void vfs_opv_init(void); |
641 | |
642 | #ifdef BSD_KERNEL_PRIVATE |
643 | int vfs_sysctl_node SYSCTL_HANDLER_ARGS; |
644 | void vnode_setneedinactive(vnode_t); |
645 | int vnode_hasnamedstreams(vnode_t); /* Does this vnode have associated named streams? */ |
646 | |
647 | errno_t |
648 | vnode_readdir64(struct vnode *vp, struct uio *uio, int flags, int *eofflag, |
649 | int *numdirent, vfs_context_t ctxp); |
650 | |
651 | void vnode_setswapmount(vnode_t); |
652 | int64_t vnode_getswappin_avail(vnode_t); |
653 | |
654 | int vnode_get_snapdir(vnode_t, vnode_t *, vfs_context_t); |
655 | |
656 | #if CONFIG_TRIGGERS |
657 | /* VFS Internal Vnode Trigger Interfaces (Private) */ |
658 | int vnode_trigger_resolve(vnode_t, struct nameidata *, vfs_context_t); |
659 | void vnode_trigger_rearm(vnode_t, vfs_context_t); |
660 | void vfs_nested_trigger_unmounts(mount_t, int, vfs_context_t); |
661 | #endif /* CONFIG_TRIGGERS */ |
662 | |
663 | int build_path_with_parent(vnode_t, vnode_t /* parent */, char *, int, int *, size_t *, int, vfs_context_t); |
664 | |
665 | void nspace_resolver_init(void); |
666 | void nspace_resolver_exited(struct proc *); |
667 | |
668 | int vnode_isinuse_locked(vnode_t, int, int ); |
669 | |
670 | kauth_cred_t vnode_cred(vnode_t); |
671 | |
672 | int fsgetpath_internal(vfs_context_t, int, uint64_t, vm_size_t, caddr_t, uint32_t options, int *); |
673 | |
674 | #endif /* BSD_KERNEL_PRIVATE */ |
675 | |
676 | #if CONFIG_IO_COMPRESSION_STATS |
677 | /* |
678 | * update the IO compression stats tracked at block granularity |
679 | */ |
680 | int vnode_updateiocompressionblockstats(vnode_t vp, uint32_t size_bucket); |
681 | |
682 | /* |
683 | * update the IO compression stats tracked for the buffer |
684 | */ |
685 | int vnode_updateiocompressionbufferstats(vnode_t vp, uint64_t uncompressed_size, uint64_t compressed_size, uint32_t size_bucket, uint32_t compression_bucket); |
686 | |
687 | #endif /* CONFIG_IO_COMPRESSION_STATS */ |
688 | |
689 | extern bool rootvp_is_ssd; |
690 | |
691 | #if CONFIG_FILE_LEASES |
692 | int vnode_setlease(vnode_t vp, struct fileglob *fg, int fl_type, int expcounts, |
693 | vfs_context_t ctx); |
694 | int vnode_getlease(vnode_t vp); |
695 | int vnode_breaklease(vnode_t vp, uint32_t oflags, vfs_context_t ctx); |
696 | void vnode_breakdirlease(vnode_t vp, bool need_parent, uint32_t oflags); |
697 | void vnode_revokelease(vnode_t vp, bool locked); |
698 | #endif /* CONFIG_FILE_LEASES */ |
699 | |
700 | #define VFS_SMR_DECLARE \ |
701 | extern smr_t vfs_smr |
702 | |
703 | #define VFS_SMR() vfs_smr |
704 | #define vfs_smr_enter() smr_enter(VFS_SMR()) |
705 | #define vfs_smr_leave() smr_leave(VFS_SMR()) |
706 | #define vfs_smr_synchronize() smr_synchronize(VFS_SMR()) |
707 | |
708 | bool vnode_hold_smr(vnode_t); |
709 | |
710 | #endif /* !_SYS_VNODE_INTERNAL_H_ */ |
711 | |