]> git.saurik.com Git - apple/xnu.git/blame - bsd/sys/vnode_internal.h
xnu-6153.41.3.tar.gz
[apple/xnu.git] / bsd / sys / vnode_internal.h
CommitLineData
91447636 1/*
316670eb 2 * Copyright (c) 2000-2012 Apple Inc. All rights reserved.
5d5c5d0d 3 *
2d21ac55 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
0a7de745 5 *
2d21ac55
A
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.
0a7de745 14 *
2d21ac55
A
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
0a7de745 17 *
2d21ac55
A
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
8f6c56a5
A
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55
A
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.
0a7de745 25 *
2d21ac55 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
91447636
A
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 */
2d21ac55
A
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
91447636
A
70#ifndef _SYS_VNODE_INTERNAL_H_
71#define _SYS_VNODE_INTERNAL_H_
72
91447636
A
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 <sys/vfs_context.h>
2d21ac55 88#include <sys/sysctl.h>
91447636
A
89
90
91struct lockf;
2d21ac55 92struct label;
91447636
A
93
94LIST_HEAD(buflists, buf);
95
6d2010ae
A
96#if CONFIG_TRIGGERS
97/*
98 * VFS Internal (private) trigger vnode resolver info.
99 */
100struct vnode_resolve {
0a7de745
A
101 lck_mtx_t vr_lock; /* protects vnode_resolve_t fields */
102 trigger_vnode_resolve_callback_t vr_resolve_func;
103 trigger_vnode_unresolve_callback_t vr_unresolve_func;
104 trigger_vnode_rearm_callback_t vr_rearm_func;
105 trigger_vnode_reclaim_callback_t vr_reclaim_func;
106 void * vr_data; /* private data for resolver */
107 uint32_t vr_flags;
108 uint32_t vr_lastseq;
6d2010ae
A
109};
110typedef struct vnode_resolve *vnode_resolve_t;
111
112/* private vr_flags */
113#define VNT_RESOLVED (1UL << 31)
114#define VNT_VFS_UNMOUNTED (1UL << 30)
0a7de745 115#define VNT_EXTERNAL (1UL << 29)
6d2010ae
A
116
117#endif /* CONFIG_TRIGGERS */
118
91447636
A
119/*
120 * Reading or writing any of these items requires holding the appropriate lock.
121 * v_freelist is locked by the global vnode_list_lock
122 * v_mntvnodes is locked by the mount_lock
123 * v_nclinks and v_ncchildren are protected by the global name_cache_lock
124 * v_cleanblkhd and v_dirtyblkhd and v_iterblkflags are locked via the global buf_mtxp
125 * the rest of the structure is protected by the vnode_lock
126 */
127struct vnode {
0a7de745
A
128 lck_mtx_t v_lock; /* vnode mutex */
129 TAILQ_ENTRY(vnode) v_freelist; /* vnode freelist */
130 TAILQ_ENTRY(vnode) v_mntvnodes; /* vnodes for mount point */
131 TAILQ_HEAD(, namecache) v_ncchildren; /* name cache entries that regard us as their parent */
132 LIST_HEAD(, namecache) v_nclinks; /* name cache entries that name this vnode */
133 vnode_t v_defer_reclaimlist; /* in case we have to defer the reclaim to avoid recursion */
134 uint32_t v_listflag; /* flags protected by the vnode_list_lock (see below) */
135 uint32_t v_flag; /* vnode flags (see below) */
136 uint16_t v_lflag; /* vnode local and named ref flags */
137 uint8_t v_iterblkflags; /* buf iterator flags */
138 uint8_t v_references; /* number of times io_count has been granted */
139 int32_t v_kusecount; /* count of in-kernel refs */
140 int32_t v_usecount; /* reference count of users */
141 int32_t v_iocount; /* iocounters */
142 void * v_owner; /* act that owns the vnode */
143 uint16_t v_type; /* vnode type */
144 uint16_t v_tag; /* type of underlying data */
145 uint32_t v_id; /* identity of vnode contents */
91447636 146 union {
0a7de745
A
147 struct mount *vu_mountedhere;/* ptr to mounted vfs (VDIR) */
148 struct socket *vu_socket; /* unix ipc (VSOCK) */
149 struct specinfo *vu_specinfo; /* device (VCHR, VBLK) */
150 struct fifoinfo *vu_fifoinfo; /* fifo (VFIFO) */
151 struct ubc_info *vu_ubcinfo; /* valid for (VREG) */
91447636 152 } v_un;
0a7de745
A
153 struct buflists v_cleanblkhd; /* clean blocklist head */
154 struct buflists v_dirtyblkhd; /* dirty blocklist head */
155 struct klist v_knotes; /* knotes attached to this vnode */
156 /*
2d21ac55 157 * the following 4 fields are protected
0a7de745 158 * by the name_cache_lock held in
2d21ac55
A
159 * excluive mode
160 */
0a7de745
A
161 kauth_cred_t v_cred; /* last authorized credential */
162 kauth_action_t v_authorized_actions; /* current authorized actions for v_cred */
163 int v_cred_timestamp; /* determine if entry is stale for MNTK_AUTH_OPAQUE */
164 int v_nc_generation; /* changes when nodes are removed from the name cache */
165 /*
2d21ac55
A
166 * back to the vnode lock for protection
167 */
0a7de745
A
168 int32_t v_numoutput; /* num of writes in progress */
169 int32_t v_writecount; /* reference count of writers */
170 const char *v_name; /* name component of the vnode */
171 vnode_t v_parent; /* pointer to parent vnode */
172 struct lockf *v_lockf; /* advisory lock list head */
173 int(**v_op)(void *); /* vnode operations vector */
174 mount_t v_mount; /* ptr to vfs we are in */
175 void * v_data; /* private data for fs */
2d21ac55 176#if CONFIG_MACF
0a7de745 177 struct label *v_label; /* MAC security label */
2d21ac55 178#endif
6d2010ae 179#if CONFIG_TRIGGERS
0a7de745 180 vnode_resolve_t v_resolve; /* trigger vnode resolve info (VDIR only) */
6d2010ae 181#endif /* CONFIG_TRIGGERS */
cb323159
A
182#if CONFIG_FIRMLINKS
183 vnode_t v_fmlink; /* firmlink if set (VDIR only), Points to source
184 * if VFLINKTARGET is set, if VFLINKTARGET is not
185 * set, points to target */
186#endif /* CONFIG_FIRMLINKS */
91447636
A
187};
188
0a7de745
A
189#define v_mountedhere v_un.vu_mountedhere
190#define v_socket v_un.vu_socket
191#define v_specinfo v_un.vu_specinfo
192#define v_fifoinfo v_un.vu_fifoinfo
193#define v_ubcinfo v_un.vu_ubcinfo
91447636
A
194
195
196/*
197 * v_iterblkflags
198 */
0a7de745
A
199#define VBI_ITER 0x1
200#define VBI_ITERWANT 0x2
201#define VBI_CLEAN 0x4
202#define VBI_DIRTY 0x8
203#define VBI_NEWBUF 0x10
91447636 204
2d21ac55
A
205/*
206 * v_listflag
207 */
0a7de745
A
208#define VLIST_RAGE 0x01 /* vnode is currently in the rapid age list */
209#define VLIST_DEAD 0x02 /* vnode is currently in the dead list */
210#define VLIST_ASYNC_WORK 0x04 /* vnode is currently on the deferred async work queue */
91447636
A
211
212/*
213 * v_lflags
214 */
0a7de745
A
215#define VL_SUSPENDED 0x0001 /* vnode is suspended */
216#define VL_DRAIN 0x0002 /* vnode is being drained */
217#define VL_TERMINATE 0x0004 /* vnode is in the process of being recycled */
218#define VL_TERMWANT 0x0008 /* there's a waiter for recycle finish (vnode_getiocount)*/
219#define VL_DEAD 0x0010 /* vnode is dead, cleaned of filesystem-specific info */
220#define VL_MARKTERM 0x0020 /* vnode should be recycled when no longer referenced */
221#define VL_NEEDINACTIVE 0x0080 /* delay VNOP_INACTIVE until iocount goes to 0 */
222
223#define VL_LABEL 0x0100 /* vnode is marked for labeling */
224#define VL_LABELWAIT 0x0200 /* vnode is marked for labeling */
225#define VL_LABELED 0x0400 /* vnode is labeled */
226#define VL_LWARNED 0x0800
227#define VL_HASSTREAMS 0x1000 /* vnode has had at least one associated named stream vnode (may not have one any longer) */
228
229#define VNAMED_UBC 0x2000 /* ubc named reference */
230#define VNAMED_MOUNT 0x4000 /* mount point named reference */
231#define VNAMED_FSHASH 0x8000 /* FS hash named reference */
91447636 232
91447636
A
233/*
234 * v_flags
235 */
0a7de745
A
236#define VROOT 0x000001 /* root of its file system */
237#define VTEXT 0x000002 /* vnode is a pure text prototype */
238#define VSYSTEM 0x000004 /* vnode being used by kernel */
239#define VISTTY 0x000008 /* vnode represents a tty */
240#define VRAGE 0x000010 /* vnode is in rapid age state */
241#define VBDEVVP 0x000020 /* vnode created by bdevvp */
242#define VDEVFLUSH 0x000040 /* device vnode after vflush */
243#define VMOUNT 0x000080 /* mount operation in progress */
244#define VBWAIT 0x000100 /* waiting for output to complete */
245#define VSHARED_DYLD 0x000200 /* vnode is a dyld shared cache file */
246#define VNOCACHE_DATA 0x000400 /* don't keep data cached once it's been consumed */
247#define VSTANDARD 0x000800 /* vnode obtained from common pool */
248#define VAGE 0x001000 /* Insert vnode at head of free list */
249#define VRAOFF 0x002000 /* read ahead disabled */
250#define VNCACHEABLE 0x004000 /* vnode is allowed to be put back in name cache */
c910b4d9 251#if NAMEDSTREAMS
0a7de745 252#define VISSHADOW 0x008000 /* vnode is a shadow file */
c910b4d9 253#endif
0a7de745
A
254#define VSWAP 0x010000 /* vnode is being used as swapfile */
255#define VTHROTTLED 0x020000 /* writes or pageouts have been throttled */
256/* wakeup tasks waiting when count falls below threshold */
257#define VNOFLUSH 0x040000 /* don't vflush() if SKIPSYSTEM */
258#define VLOCKLOCAL 0x080000 /* this vnode does adv locking in vfs */
259#define VISHARDLINK 0x100000 /* hard link needs special processing on lookup and in volfs */
260#define VISUNION 0x200000 /* union special processing */
261#define VISNAMEDSTREAM 0x400000 /* vnode is a named stream (eg HFS resource fork) */
2d21ac55 262#define VOPENEVT 0x800000 /* if process is P_CHECKOPENEVT, then or in the O_EVTONLY flag on open */
6d2010ae 263#define VNEEDSSNAPSHOT 0x1000000
0a7de745
A
264#define VNOCS 0x2000000 /* is there no code signature available */
265#define VISDIRTY 0x4000000 /* vnode will need IO if reclaimed */
3e170ce0
A
266#define VFASTDEVCANDIDATE 0x8000000 /* vnode is a candidate to store on a fast device */
267#define VAUTOCANDIDATE 0x10000000 /* vnode was automatically marked as a fast-dev candidate */
cb323159 268#define VFMLINKTARGET 0x20000000 /* vnode is firmlink target */
3e170ce0 269/*
0a7de745
A
270 * 0x40000000 not used
271 * 0x80000000 not used.
272 */
fe8ab488
A
273
274/*
275 * This structure describes vnode data which is specific to a file descriptor.
276 * It is currently used only for file descriptors which are for opened for
277 * directories.
278 */
279struct fd_vn_data {
280 lck_mtx_t fv_lock; /* Used to serialize directory enumeration on fd */
281 off_t fv_offset; /* Offset to be used */
282 void *fv_dircookie; /* If FS doesn't like offsets in directories */
283 caddr_t fv_buf; /* Temporary buffer to store directory entries */
284 size_t fv_bufsiz; /* Valid size of fv_buf */
285 size_t fv_bufdone; /* How much of fv_buf is processed */
286 size_t fv_bufallocsiz; /* Allocation size determined for Buffer*/
287 off_t fv_soff; /* Starting FS offset for this buffer */
288 off_t fv_eoff; /* Ending FS offset for this buffer */
289 int fv_eofflag;/* Does fv_eoff represent EOF ? */
290};
291
292/*
293 * FV_DIRBUF_START_SIZ is the initial size of the buffer passed to VNOP_READDIR.
294 * That may not be enough for some filesytems so the current algorithm works its
295 * way upto FV_DIRBUF_MAX_SIZ
296 */
0a7de745
A
297#define FV_DIRBUF_DIRENTRY_SIZ (sizeof(struct direntry))
298#define FV_DIRBUF_START_SIZ FV_DIRBUF_DIRENTRY_SIZ
299#define FV_DIRBUF_MAX_SIZ (4*(sizeof(struct direntry)))
fe8ab488
A
300
301#define FV_LOCK(fvd) lck_mtx_lock(&(((struct fd_vn_data *)fvd)->fv_lock))
302#define FV_UNLOCK(fvd) lck_mtx_unlock(&(((struct fd_vn_data *)fvd)->fv_lock))
91447636
A
303
304/*
305 * Global vnode data.
306 */
0a7de745 307extern struct vnode *rootvnode; /* root (i.e. "/") vnode */
91447636 308
b7266188 309#ifdef CONFIG_IMGSRC_ACCESS
0a7de745
A
310#define MAX_IMAGEBOOT_NESTING 2
311extern struct vnode *imgsrc_rootvnodes[];
b7266188
A
312#endif /* CONFIG_IMGSRC_ACCESS */
313
91447636
A
314
315/*
316 * Mods for exensibility.
317 */
318
319/*
320 * Flags for vdesc_flags:
321 */
0a7de745 322#define VDESC_MAX_VPS 16
91447636 323/* Low order 16 flag bits are reserved for willrele flags for vp arguments. */
0a7de745
A
324#define VDESC_VP0_WILLRELE 0x00001
325#define VDESC_VP1_WILLRELE 0x00002
326#define VDESC_VP2_WILLRELE 0x00004
327#define VDESC_VP3_WILLRELE 0x00008
328#define VDESC_NOMAP_VPP 0x00100
329#define VDESC_VPP_WILLRELE 0x00200
813fb2f6 330
0a7de745 331#define VDESC_DISABLED 0x10000 /* descriptor defined but op is unused, has no op slot */
91447636
A
332
333/*
334 * VDESC_NO_OFFSET is used to identify the end of the offset list
335 * and in places where no such field exists.
336 */
337#define VDESC_NO_OFFSET -1
338
339/*
340 * This structure describes the vnode operation taking place.
341 */
342struct vnodeop_desc {
0a7de745
A
343 int vdesc_offset; /* offset in vector--first for speed */
344 const char *vdesc_name; /* a readable name for debugging */
345 int vdesc_flags; /* VDESC_* flags */
91447636
A
346
347 /*
348 * These ops are used by bypass routines to map and locate arguments.
349 * Creds and procs are not needed in bypass routines, but sometimes
350 * they are useful to (for example) transport layers.
351 * Nameidata is useful because it has a cred in it.
352 */
0a7de745
A
353 int *vdesc_vp_offsets; /* list ended by VDESC_NO_OFFSET */
354 int vdesc_vpp_offset; /* return vpp location */
355 int vdesc_cred_offset; /* cred location, if any */
356 int vdesc_proc_offset; /* proc location, if any */
357 int vdesc_componentname_offset; /* if any */
358 int vdesc_context_offset; /* context location, if any */
91447636
A
359 /*
360 * Finally, we've got a list of private data (about each operation)
361 * for each transport layer. (Support to manage this list is not
362 * yet part of BSD.)
363 */
0a7de745 364 caddr_t *vdesc_transports;
91447636
A
365};
366
367/*
368 * A list of all the operation descs.
369 */
370extern struct vnodeop_desc *vnodeop_descs[];
371
91447636
A
372
373/*
374 * This macro is very helpful in defining those offsets in the vdesc struct.
375 *
376 * This is stolen from X11R4. I ingored all the fancy stuff for
377 * Crays, so if you decide to port this to such a serious machine,
378 * you might want to consult Intrisics.h's XtOffset{,Of,To}.
379 */
0a7de745
A
380#define VOPARG_OFFSET(p_type, field) \
381 ((int) (((char *) (&(((p_type)NULL)->field))) - ((char *) NULL)))
382#define VOPARG_OFFSETOF(s_type, field) \
91447636 383 VOPARG_OFFSET(s_type*,field)
0a7de745 384#define VOPARG_OFFSETTO(S_TYPE, S_OFFSET, STRUCT_P) \
91447636
A
385 ((S_TYPE)(((char*)(STRUCT_P))+(S_OFFSET)))
386
387
388
389/*
390 * VOCALL calls an op given an ops vector. We break it out because BSD's
391 * vclean changes the ops vector and then wants to call ops with the old
392 * vector.
393 */
0a7de745 394#define VOCALL(OPSV, OFF, AP) (( *((OPSV)[(OFF)])) (AP))
91447636
A
395
396/*
397 * This call works for vnodes in the kernel.
398 */
0a7de745 399#define VCALL(VP, OFF, AP) VOCALL((VP)->v_op,(OFF),(AP))
91447636
A
400#define VDESC(OP) (& __CONCAT(OP,_desc))
401#define VOFFSET(OP) (VDESC(OP)->vdesc_offset)
402
0c530ab8 403struct ostat;
91447636 404
39037602 405/* bdevvp moved to vnode.h as private KPI */
0a7de745
A
406void cvtstat(struct stat *st, struct ostat *ost);
407void vprint(const char *label, struct vnode *vp);
91447636
A
408
409
b0d623f7 410__private_extern__ int set_package_extensions_table(user_addr_t data, int nentries, int maxwidth);
0a7de745
A
411int vn_rdwr_64(enum uio_rw rw, struct vnode *vp, uint64_t base,
412 int64_t len, off_t offset, enum uio_seg segflg,
413 int ioflg, kauth_cred_t cred, int64_t *aresid,
414 struct proc *p);
2d21ac55 415#if CONFIG_MACF
0a7de745
A
416int vn_setlabel(struct vnode *vp, struct label *intlabel,
417 vfs_context_t context);
2d21ac55 418#endif
0a7de745
A
419void fifo_printinfo(struct vnode *vp);
420int vn_open(struct nameidata *ndp, int fmode, int cmode);
421int vn_open_modflags(struct nameidata *ndp, int *fmode, int cmode);
422int vn_open_auth(struct nameidata *ndp, int *fmode, struct vnode_attr *);
423int vn_close(vnode_t, int flags, vfs_context_t ctx);
6d2010ae
A
424errno_t vn_remove(vnode_t dvp, vnode_t *vpp, struct nameidata *ndp, int32_t flags, struct vnode_attr *vap, vfs_context_t ctx);
425errno_t vn_rename(struct vnode *fdvp, struct vnode **fvpp, struct componentname *fcnp, struct vnode_attr *fvap,
0a7de745
A
426 struct vnode *tdvp, struct vnode **tvpp, struct componentname *tcnp, struct vnode_attr *tvap,
427 uint32_t flags, vfs_context_t ctx);
91447636 428
0a7de745 429void lock_vnode_and_post(vnode_t, int);
b0d623f7
A
430
431#define post_event_if_success(_vp, _error, _event) \
432 do { \
0a7de745
A
433 if (0 == (_error)) { \
434 lock_vnode_and_post((_vp), (_event)); \
435 } \
436 } while (0)
437
6d2010ae 438/* Authorization subroutines */
0a7de745
A
439int vn_authorize_open_existing(vnode_t vp, struct componentname *cnp, int fmode, vfs_context_t ctx, void *reserved);
440int vn_authorize_create(vnode_t, struct componentname *, struct vnode_attr *, vfs_context_t, void*);
441int vn_attribute_prepare(vnode_t dvp, struct vnode_attr *vap, uint32_t *defaulted_fieldsp, vfs_context_t ctx);
442void vn_attribute_cleanup(struct vnode_attr *vap, uint32_t defaulted_fields);
0a7de745
A
443int vn_authorize_rename(struct vnode *fdvp, struct vnode *fvp, struct componentname *fcnp,
444 struct vnode *tdvp, struct vnode *tvp, struct componentname *tcnp,
445 vfs_context_t ctx, void *reserved);
446int vn_authorize_renamex(struct vnode *fdvp, struct vnode *fvp, struct componentname *fcnp,
447 struct vnode *tdvp, struct vnode *tvp, struct componentname *tcnp,
448 vfs_context_t ctx, vfs_rename_flags_t flags, void *reserved);
449int vn_authorize_renamex_with_paths(struct vnode *fdvp, struct vnode *fvp, struct componentname *fcnp, const char *from_path,
450 struct vnode *tdvp, struct vnode *tvp, struct componentname *tcnp, const char *to_path,
451 vfs_context_t ctx, vfs_rename_flags_t flags, void *reserved);
452int vn_authorize_rmdir(vnode_t dvp, vnode_t vp, struct componentname *cnp, vfs_context_t ctx, void *reserved);
6d2010ae
A
453
454typedef int (*vn_create_authorizer_t)(vnode_t, struct componentname *, struct vnode_attr *, vfs_context_t, void*);
455int vn_authorize_mkdir(vnode_t, struct componentname *, struct vnode_attr *, vfs_context_t, void*);
456int vn_authorize_null(vnode_t, struct componentname *, struct vnode_attr *, vfs_context_t, void*);
813fb2f6
A
457int vnode_attr_authorize_dir_clone(struct vnode_attr *vap, kauth_action_t action,
458 struct vnode_attr *dvap, vnode_t sdvp, mount_t mp, dir_clone_authorizer_op_t vattr_op,
5ba3f43e 459 uint32_t flags, vfs_context_t ctx, void *reserved);
6d2010ae 460/* End of authorization subroutines */
b0d623f7 461
0a7de745
A
462#define VN_CREATE_NOAUTH (1<<0)
463#define VN_CREATE_NOINHERIT (1<<1)
464#define VN_CREATE_UNION (1<<2)
465#define VN_CREATE_NOLABEL (1<<3)
466#define VN_CREATE_DOOPEN (1<<4) /* Open file if a batched operation is available */
6d2010ae 467errno_t vn_create(vnode_t, vnode_t *, struct nameidata *, struct vnode_attr *, uint32_t, int, uint32_t*, vfs_context_t);
0a7de745
A
468int vn_mkdir(vnode_t dvp, vnode_t *vpp, struct nameidata *ndp, struct vnode_attr *vap, vfs_context_t ctx);
469int vn_rmdir(vnode_t dvp, vnode_t *vpp, struct nameidata *ndp, struct vnode_attr *vap, vfs_context_t ctx);
91447636 470
0a7de745
A
471int vn_getxattr(vnode_t, const char *, uio_t, size_t *, int, vfs_context_t);
472int vn_setxattr(vnode_t, const char *, uio_t, int, vfs_context_t);
473int vn_removexattr(vnode_t, const char *, int, vfs_context_t);
474int vn_listxattr(vnode_t, uio_t, size_t *, int, vfs_context_t);
91447636 475
2d21ac55
A
476#if NAMEDSTREAMS
477errno_t vnode_getnamedstream(vnode_t, vnode_t *, const char *, enum nsoperation, int, vfs_context_t);
478errno_t vnode_makenamedstream(vnode_t, vnode_t *, const char *, int, vfs_context_t);
479errno_t vnode_removenamedstream(vnode_t, vnode_t, const char *, int, vfs_context_t);
480errno_t vnode_flushnamedstream(vnode_t vp, vnode_t svp, vfs_context_t context);
39236c6e 481errno_t vnode_relenamedstream(vnode_t vp, vnode_t svp);
0a7de745 482errno_t vnode_verifynamedstream(vnode_t vp);
2d21ac55
A
483#endif
484
2d21ac55 485
0a7de745
A
486void nchinit(void);
487int resize_namecache(int newsize);
488void name_cache_lock_shared(void);
489void name_cache_lock(void);
490void name_cache_unlock(void);
491void cache_enter_with_gen(vnode_t dvp, vnode_t vp, struct componentname *cnp, int gen);
b0d623f7 492const char *cache_enter_create(vnode_t dvp, vnode_t vp, struct componentname *cnp);
91447636 493
0a7de745 494extern int nc_disabled;
91447636 495
0a7de745 496#define vnode_lock_convert(v) lck_mtx_convert_spin(&(v)->v_lock)
2d21ac55 497
0a7de745 498void vnode_lock_spin(vnode_t);
2d21ac55
A
499
500
0a7de745
A
501void vnode_list_lock(void);
502void vnode_list_unlock(void);
6d2010ae 503
0a7de745
A
504#define VNODE_REF_FORCE 0x1
505int vnode_ref_ext(vnode_t, int, int);
6d2010ae 506
0a7de745 507void vnode_rele_internal(vnode_t, int, int, int);
593a1d5f 508#ifdef BSD_KERNEL_PRIVATE
0a7de745
A
509int vnode_getalways(vnode_t);
510int vget_internal(vnode_t, int, int);
6d2010ae 511errno_t vnode_getiocount(vnode_t, unsigned int, int);
593a1d5f 512#endif /* BSD_KERNEL_PRIVATE */
0a7de745
A
513int vnode_get_locked(vnode_t);
514int vnode_put_locked(vnode_t);
91447636 515
0a7de745
A
516int vnode_issock(vnode_t);
517int vnode_isaliased(vnode_t);
91447636 518
0a7de745
A
519void unlock_fsnode(vnode_t, int *);
520int lock_fsnode(vnode_t, int *);
91447636 521
0a7de745
A
522errno_t vnode_resume(vnode_t);
523errno_t vnode_suspend(vnode_t);
2d21ac55 524
91447636 525
0a7de745 526errno_t vnode_mtime(vnode_t, struct timespec *, vfs_context_t);
fe8ab488 527errno_t vnode_flags(vnode_t, uint32_t *, vfs_context_t);
15129b1c 528
0a7de745
A
529errno_t vnode_size(vnode_t, off_t *, vfs_context_t);
530errno_t vnode_setsize(vnode_t, off_t, int ioflag, vfs_context_t);
531int vnode_setattr_fallback(vnode_t vp, struct vnode_attr *vap, vfs_context_t ctx);
532int vnode_isspec(vnode_t vp);
91447636 533
6d2010ae
A
534
535#ifdef BSD_KERNEL_PRIVATE
536
537typedef uint32_t compound_vnop_id_t;
0a7de745
A
538#define COMPOUND_VNOP_OPEN 0x01
539#define COMPOUND_VNOP_MKDIR 0x02
540#define COMPOUND_VNOP_RENAME 0x04
541#define COMPOUND_VNOP_REMOVE 0x08
542#define COMPOUND_VNOP_RMDIR 0x10
543
544int vnode_compound_rename_available(vnode_t vp);
545int vnode_compound_rmdir_available(vnode_t vp);
546int vnode_compound_mkdir_available(vnode_t vp);
547int vnode_compound_remove_available(vnode_t vp);
548int vnode_compound_open_available(vnode_t vp);
549int vnode_compound_op_available(vnode_t, compound_vnop_id_t);
6d2010ae
A
550#endif /* BSD_KERNEL_PRIVATE */
551
2d21ac55
A
552void vn_setunionwait(vnode_t);
553void vn_checkunionwait(vnode_t);
554void vn_clearunionwait(vnode_t, int);
555
91447636
A
556void SPECHASH_LOCK(void);
557void SPECHASH_UNLOCK(void);
558
0a7de745 559void vnode_authorize_init(void);
2d21ac55 560
0a7de745 561void vfsinit(void);
b0d623f7
A
562void vnode_lock(vnode_t);
563void vnode_unlock(vnode_t);
2d21ac55 564
3e170ce0 565void vn_print_state(vnode_t /* vp */, const char * /* fmt */, ...)
0a7de745 566__printflike(2, 3);
3e170ce0
A
567
568#if DEVELOPMENT || DEBUG
0a7de745
A
569#define VNASSERT(exp, vp, msg) \
570do { \
571 if (__improbable(!(exp))) { \
572 vn_print_state(vp, "VNASSERT failed %s:%d\n", __FILE__, \
573 __LINE__); \
574 panic msg; \
575 } \
3e170ce0
A
576} while (0)
577#else
578#define VNASSERT(exp, vp, msg)
579#endif /* DEVELOPMENT || DEBUG */
580
2d21ac55
A
581/*
582 * XXX exported symbols; should be static
583 */
0a7de745
A
584void vfs_op_init(void);
585void vfs_opv_init(void);
91447636 586
b0d623f7 587#ifdef BSD_KERNEL_PRIVATE
fe8ab488 588int vfs_sysctl_node SYSCTL_HANDLER_ARGS;
b0d623f7 589void vnode_setneedinactive(vnode_t);
0a7de745 590int vnode_hasnamedstreams(vnode_t); /* Does this vnode have associated named streams? */
6d2010ae 591
fe8ab488
A
592errno_t
593vnode_readdir64(struct vnode *vp, struct uio *uio, int flags, int *eofflag,
0a7de745 594 int *numdirent, vfs_context_t ctxp);
fe8ab488
A
595
596void vnode_setswapmount(vnode_t);
0a7de745 597int64_t vnode_getswappin_avail(vnode_t);
fe8ab488 598
0a7de745 599int vnode_get_snapdir(vnode_t, vnode_t *, vfs_context_t);
39037602 600
6d2010ae
A
601#if CONFIG_TRIGGERS
602/* VFS Internal Vnode Trigger Interfaces (Private) */
603int vnode_trigger_resolve(vnode_t, struct nameidata *, vfs_context_t);
604void vnode_trigger_rearm(vnode_t, vfs_context_t);
605void vfs_nested_trigger_unmounts(mount_t, int, vfs_context_t);
606#endif /* CONFIG_TRIGGERS */
607
0a7de745 608int build_path_with_parent(vnode_t, vnode_t /* parent */, char *, int, int *, int, vfs_context_t);
5ba3f43e 609
cb323159
A
610void nspace_resolver_init(void);
611void nspace_resolver_exited(struct proc *);
612
613int vnode_materialize_dataless_file(vnode_t, uint64_t);
614
6d2010ae 615#endif /* BSD_KERNEL_PRIVATE */
b0d623f7 616
91447636 617#endif /* !_SYS_VNODE_INTERNAL_H_ */