2 * Copyright (c) 2000-2012 Apple Inc. All rights reserved.
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
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.
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
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.
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
28 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
30 * Copyright (c) 1989, 1993
31 * The Regents of the University of California. All rights reserved.
32 * (c) UNIX System Laboratories, Inc.
33 * All or some portions of this file are derived from material licensed
34 * to the University of California by American Telephone and Telegraph
35 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
36 * the permission of UNIX System Laboratories, Inc.
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions
41 * 1. Redistributions of source code must retain the above copyright
42 * notice, this list of conditions and the following disclaimer.
43 * 2. Redistributions in binary form must reproduce the above copyright
44 * notice, this list of conditions and the following disclaimer in the
45 * documentation and/or other materials provided with the distribution.
46 * 3. All advertising materials mentioning features or use of this software
47 * must display the following acknowledgement:
48 * This product includes software developed by the University of
49 * California, Berkeley and its contributors.
50 * 4. Neither the name of the University nor the names of its contributors
51 * may be used to endorse or promote products derived from this software
52 * without specific prior written permission.
54 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
55 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
56 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
57 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
58 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
59 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
60 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
61 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
62 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
63 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
66 * @(#)vfs_subr.c 8.31 (Berkeley) 5/26/95
69 * NOTICE: This file was modified by SPARTA, Inc. in 2005 to introduce
70 * support for mandatory and extensible security protections. This notice
71 * is included in support of clause 2.2 (b) of the Apple Public License,
76 * External virtual filesystem routines
80 #include <sys/param.h>
81 #include <sys/systm.h>
82 #include <sys/proc_internal.h>
83 #include <sys/kauth.h>
84 #include <sys/mount_internal.h>
87 #include <sys/vnode.h>
88 #include <sys/vnode_internal.h>
90 #include <sys/namei.h>
91 #include <sys/ucred.h>
92 #include <sys/buf_internal.h>
93 #include <sys/errno.h>
94 #include <sys/malloc.h>
95 #include <sys/uio_internal.h>
97 #include <sys/domain.h>
99 #include <sys/syslog.h>
100 #include <sys/ubc_internal.h>
102 #include <sys/sysctl.h>
103 #include <sys/filedesc.h>
104 #include <sys/event.h>
105 #include <sys/kdebug.h>
106 #include <sys/kauth.h>
107 #include <sys/user.h>
108 #include <sys/systm.h>
109 #include <sys/kern_memorystatus.h>
110 #include <sys/lockf.h>
111 #include <miscfs/fifofs/fifo.h>
114 #include <machine/spl.h>
117 #include <kern/assert.h>
118 #include <mach/kern_return.h>
119 #include <kern/thread.h>
120 #include <kern/sched_prim.h>
122 #include <miscfs/specfs/specdev.h>
124 #include <mach/mach_types.h>
125 #include <mach/memory_object_types.h>
126 #include <mach/memory_object_control.h>
128 #include <kern/kalloc.h> /* kalloc()/kfree() */
129 #include <kern/clock.h> /* delay_for_interval() */
130 #include <libkern/OSAtomic.h> /* OSAddAtomic() */
134 #include <libkern/OSDebug.h>
137 #include <vm/vm_protos.h> /* vnode_pager_vrele() */
140 #include <security/mac_framework.h>
143 extern lck_grp_t
*vnode_lck_grp
;
144 extern lck_attr_t
*vnode_lck_attr
;
147 extern lck_grp_t
*trigger_vnode_lck_grp
;
148 extern lck_attr_t
*trigger_vnode_lck_attr
;
151 extern lck_mtx_t
* mnt_list_mtx_lock
;
153 enum vtype iftovt_tab
[16] = {
154 VNON
, VFIFO
, VCHR
, VNON
, VDIR
, VNON
, VBLK
, VNON
,
155 VREG
, VNON
, VLNK
, VNON
, VSOCK
, VNON
, VNON
, VBAD
,
157 int vttoif_tab
[9] = {
158 0, S_IFREG
, S_IFDIR
, S_IFBLK
, S_IFCHR
, S_IFLNK
,
159 S_IFSOCK
, S_IFIFO
, S_IFMT
,
163 /* XXX These should be in a BSD accessible Mach header, but aren't. */
164 extern void memory_object_mark_used(
165 memory_object_control_t control
);
167 extern void memory_object_mark_unused(
168 memory_object_control_t control
,
172 /* XXX next protptype should be from <nfs/nfs.h> */
173 extern int nfs_vinvalbuf(vnode_t
, int, vfs_context_t
, int);
175 /* XXX next prototytype should be from libsa/stdlib.h> but conflicts libkern */
176 __private_extern__
void qsort(
180 int (*)(const void *, const void *));
182 extern kern_return_t
adjust_vm_object_cache(vm_size_t oval
, vm_size_t nval
);
183 __private_extern__
void vntblinit(void);
184 __private_extern__ kern_return_t
reset_vmobjectcache(unsigned int val1
,
186 __private_extern__
int unlink1(vfs_context_t
, struct nameidata
*, int);
188 extern int system_inshutdown
;
190 static void vnode_list_add(vnode_t
);
191 static void vnode_async_list_add(vnode_t
);
192 static void vnode_list_remove(vnode_t
);
193 static void vnode_list_remove_locked(vnode_t
);
195 static void vnode_abort_advlocks(vnode_t
);
196 static errno_t
vnode_drain(vnode_t
);
197 static void vgone(vnode_t
, int flags
);
198 static void vclean(vnode_t vp
, int flag
);
199 static void vnode_reclaim_internal(vnode_t
, int, int, int);
201 static void vnode_dropiocount (vnode_t
);
203 static vnode_t
checkalias(vnode_t vp
, dev_t nvp_rdev
);
204 static int vnode_reload(vnode_t
);
205 static int vnode_isinuse_locked(vnode_t
, int, int);
207 static void insmntque(vnode_t vp
, mount_t mp
);
208 static int mount_getvfscnt(void);
209 static int mount_fillfsids(fsid_t
*, int );
210 static void vnode_iterate_setup(mount_t
);
211 int vnode_umount_preflight(mount_t
, vnode_t
, int);
212 static int vnode_iterate_prepare(mount_t
);
213 static int vnode_iterate_reloadq(mount_t
);
214 static void vnode_iterate_clear(mount_t
);
215 static mount_t
vfs_getvfs_locked(fsid_t
*);
216 static int vn_create_reg(vnode_t dvp
, vnode_t
*vpp
, struct nameidata
*ndp
,
217 struct vnode_attr
*vap
, uint32_t flags
, int fmode
, uint32_t *statusp
, vfs_context_t ctx
);
218 static int vnode_authattr_new_internal(vnode_t dvp
, struct vnode_attr
*vap
, int noauth
, uint32_t *defaulted_fieldsp
, vfs_context_t ctx
);
220 errno_t
rmdir_remove_orphaned_appleDouble(vnode_t
, vfs_context_t
, int *);
223 static void record_vp(vnode_t vp
, int count
);
227 static int vnode_resolver_create(mount_t
, vnode_t
, struct vnode_trigger_param
*, boolean_t external
);
228 static void vnode_resolver_detach(vnode_t
);
231 TAILQ_HEAD(freelst
, vnode
) vnode_free_list
; /* vnode free list */
232 TAILQ_HEAD(deadlst
, vnode
) vnode_dead_list
; /* vnode dead list */
233 TAILQ_HEAD(async_work_lst
, vnode
) vnode_async_work_list
;
236 TAILQ_HEAD(ragelst
, vnode
) vnode_rage_list
; /* vnode rapid age list */
237 struct timeval rage_tv
;
241 #define RAGE_LIMIT_MIN 100
242 #define RAGE_TIME_LIMIT 5
244 struct mntlist mountlist
; /* mounted filesystem list */
245 static int nummounts
= 0;
248 #define VLISTCHECK(fun, vp, list) \
249 if ((vp)->v_freelist.tqe_prev == (struct vnode **)0xdeadb) \
250 panic("%s: %s vnode not on %slist", (fun), (list), (list));
252 #define VLISTCHECK(fun, vp, list)
253 #endif /* DIAGNOSTIC */
255 #define VLISTNONE(vp) \
257 (vp)->v_freelist.tqe_next = (struct vnode *)0; \
258 (vp)->v_freelist.tqe_prev = (struct vnode **)0xdeadb; \
261 #define VONLIST(vp) \
262 ((vp)->v_freelist.tqe_prev != (struct vnode **)0xdeadb)
264 /* remove a vnode from free vnode list */
265 #define VREMFREE(fun, vp) \
267 VLISTCHECK((fun), (vp), "free"); \
268 TAILQ_REMOVE(&vnode_free_list, (vp), v_freelist); \
274 /* remove a vnode from dead vnode list */
275 #define VREMDEAD(fun, vp) \
277 VLISTCHECK((fun), (vp), "dead"); \
278 TAILQ_REMOVE(&vnode_dead_list, (vp), v_freelist); \
280 vp->v_listflag &= ~VLIST_DEAD; \
285 /* remove a vnode from async work vnode list */
286 #define VREMASYNC_WORK(fun, vp) \
288 VLISTCHECK((fun), (vp), "async_work"); \
289 TAILQ_REMOVE(&vnode_async_work_list, (vp), v_freelist); \
291 vp->v_listflag &= ~VLIST_ASYNC_WORK; \
292 async_work_vnodes--; \
296 /* remove a vnode from rage vnode list */
297 #define VREMRAGE(fun, vp) \
299 if ( !(vp->v_listflag & VLIST_RAGE)) \
300 panic("VREMRAGE: vp not on rage list"); \
301 VLISTCHECK((fun), (vp), "rage"); \
302 TAILQ_REMOVE(&vnode_rage_list, (vp), v_freelist); \
304 vp->v_listflag &= ~VLIST_RAGE; \
310 * vnodetarget hasn't been used in a long time, but
311 * it was exported for some reason... I'm leaving in
312 * place for now... it should be deprecated out of the
313 * exports and removed eventually.
315 u_int32_t vnodetarget
; /* target for vnreclaim() */
316 #define VNODE_FREE_TARGET 20 /* Default value for vnodetarget */
319 * We need quite a few vnodes on the free list to sustain the
320 * rapid stat() the compilation process does, and still benefit from the name
321 * cache. Having too few vnodes on the free list causes serious disk
322 * thrashing as we cycle through them.
324 #define VNODE_FREE_MIN CONFIG_VNODE_FREE_MIN /* freelist should have at least this many */
327 static void async_work_continue(void);
330 * Initialize the vnode management data structures.
332 __private_extern__
void
335 thread_t thread
= THREAD_NULL
;
337 TAILQ_INIT(&vnode_free_list
);
338 TAILQ_INIT(&vnode_rage_list
);
339 TAILQ_INIT(&vnode_dead_list
);
340 TAILQ_INIT(&vnode_async_work_list
);
341 TAILQ_INIT(&mountlist
);
344 vnodetarget
= VNODE_FREE_TARGET
;
346 microuptime(&rage_tv
);
347 rage_limit
= desiredvnodes
/ 100;
349 if (rage_limit
< RAGE_LIMIT_MIN
)
350 rage_limit
= RAGE_LIMIT_MIN
;
353 * Scale the vm_object_cache to accomodate the vnodes
356 (void) adjust_vm_object_cache(0, desiredvnodes
- VNODE_FREE_MIN
);
359 * create worker threads
361 kernel_thread_start((thread_continue_t
)async_work_continue
, NULL
, &thread
);
362 thread_deallocate(thread
);
365 /* Reset the VM Object Cache with the values passed in */
366 __private_extern__ kern_return_t
367 reset_vmobjectcache(unsigned int val1
, unsigned int val2
)
369 vm_size_t oval
= val1
- VNODE_FREE_MIN
;
376 if(val2
< VNODE_FREE_MIN
)
379 nval
= val2
- VNODE_FREE_MIN
;
381 return(adjust_vm_object_cache(oval
, nval
));
385 /* the timeout is in 10 msecs */
387 vnode_waitforwrites(vnode_t vp
, int output_target
, int slpflag
, int slptimeout
, const char *msg
) {
391 KERNEL_DEBUG(0x3010280 | DBG_FUNC_START
, (int)vp
, output_target
, vp
->v_numoutput
, 0, 0);
393 if (vp
->v_numoutput
> output_target
) {
399 while ((vp
->v_numoutput
> output_target
) && error
== 0) {
401 vp
->v_flag
|= VTHROTTLED
;
403 vp
->v_flag
|= VBWAIT
;
405 ts
.tv_sec
= (slptimeout
/100);
406 ts
.tv_nsec
= (slptimeout
% 1000) * 10 * NSEC_PER_USEC
* 1000 ;
407 error
= msleep((caddr_t
)&vp
->v_numoutput
, &vp
->v_lock
, (slpflag
| (PRIBIO
+ 1)), msg
, &ts
);
413 KERNEL_DEBUG(0x3010280 | DBG_FUNC_END
, (int)vp
, output_target
, vp
->v_numoutput
, error
, 0);
420 vnode_startwrite(vnode_t vp
) {
422 OSAddAtomic(1, &vp
->v_numoutput
);
427 vnode_writedone(vnode_t vp
)
432 OSAddAtomic(-1, &vp
->v_numoutput
);
436 if (vp
->v_numoutput
< 0)
437 panic("vnode_writedone: numoutput < 0");
439 if ((vp
->v_flag
& VTHROTTLED
)) {
440 vp
->v_flag
&= ~VTHROTTLED
;
443 if ((vp
->v_flag
& VBWAIT
) && (vp
->v_numoutput
== 0)) {
444 vp
->v_flag
&= ~VBWAIT
;
450 wakeup((caddr_t
)&vp
->v_numoutput
);
457 vnode_hasdirtyblks(vnode_t vp
)
459 struct cl_writebehind
*wbp
;
462 * Not taking the buf_mtxp as there is little
463 * point doing it. Even if the lock is taken the
464 * state can change right after that. If their
465 * needs to be a synchronization, it must be driven
468 if (vp
->v_dirtyblkhd
.lh_first
)
471 if (!UBCINFOEXISTS(vp
))
474 wbp
= vp
->v_ubcinfo
->cl_wbehind
;
476 if (wbp
&& (wbp
->cl_number
|| wbp
->cl_scmap
))
483 vnode_hascleanblks(vnode_t vp
)
486 * Not taking the buf_mtxp as there is little
487 * point doing it. Even if the lock is taken the
488 * state can change right after that. If their
489 * needs to be a synchronization, it must be driven
492 if (vp
->v_cleanblkhd
.lh_first
)
498 vnode_iterate_setup(mount_t mp
)
500 while (mp
->mnt_lflag
& MNT_LITER
) {
501 mp
->mnt_lflag
|= MNT_LITERWAIT
;
502 msleep((caddr_t
)mp
, &mp
->mnt_mlock
, PVFS
, "vnode_iterate_setup", NULL
);
505 mp
->mnt_lflag
|= MNT_LITER
;
510 vnode_umount_preflight(mount_t mp
, vnode_t skipvp
, int flags
)
514 TAILQ_FOREACH(vp
, &mp
->mnt_vnodelist
, v_mntvnodes
) {
515 /* disable preflight only for udf, a hack to be removed after 4073176 is fixed */
516 if (vp
->v_tag
== VT_UDF
)
518 if (vp
->v_type
== VDIR
)
522 if ((flags
& SKIPSYSTEM
) && ((vp
->v_flag
& VSYSTEM
) ||
523 (vp
->v_flag
& VNOFLUSH
)))
525 if ((flags
& SKIPSWAP
) && (vp
->v_flag
& VSWAP
))
527 if ((flags
& WRITECLOSE
) &&
528 (vp
->v_writecount
== 0 || vp
->v_type
!= VREG
))
530 /* Look for busy vnode */
531 if (((vp
->v_usecount
!= 0) &&
532 ((vp
->v_usecount
- vp
->v_kusecount
) != 0)))
540 * This routine prepares iteration by moving all the vnodes to worker queue
541 * called with mount lock held
544 vnode_iterate_prepare(mount_t mp
)
548 if (TAILQ_EMPTY(&mp
->mnt_vnodelist
)) {
553 vp
= TAILQ_FIRST(&mp
->mnt_vnodelist
);
554 vp
->v_mntvnodes
.tqe_prev
= &(mp
->mnt_workerqueue
.tqh_first
);
555 mp
->mnt_workerqueue
.tqh_first
= mp
->mnt_vnodelist
.tqh_first
;
556 mp
->mnt_workerqueue
.tqh_last
= mp
->mnt_vnodelist
.tqh_last
;
558 TAILQ_INIT(&mp
->mnt_vnodelist
);
559 if (mp
->mnt_newvnodes
.tqh_first
!= NULL
)
560 panic("vnode_iterate_prepare: newvnode when entering vnode");
561 TAILQ_INIT(&mp
->mnt_newvnodes
);
567 /* called with mount lock held */
569 vnode_iterate_reloadq(mount_t mp
)
573 /* add the remaining entries in workerq to the end of mount vnode list */
574 if (!TAILQ_EMPTY(&mp
->mnt_workerqueue
)) {
576 mvp
= TAILQ_LAST(&mp
->mnt_vnodelist
, vnodelst
);
578 /* Joining the workerque entities to mount vnode list */
580 mvp
->v_mntvnodes
.tqe_next
= mp
->mnt_workerqueue
.tqh_first
;
582 mp
->mnt_vnodelist
.tqh_first
= mp
->mnt_workerqueue
.tqh_first
;
583 mp
->mnt_workerqueue
.tqh_first
->v_mntvnodes
.tqe_prev
= mp
->mnt_vnodelist
.tqh_last
;
584 mp
->mnt_vnodelist
.tqh_last
= mp
->mnt_workerqueue
.tqh_last
;
585 TAILQ_INIT(&mp
->mnt_workerqueue
);
588 /* add the newvnodes to the head of mount vnode list */
589 if (!TAILQ_EMPTY(&mp
->mnt_newvnodes
)) {
591 nlvp
= TAILQ_LAST(&mp
->mnt_newvnodes
, vnodelst
);
593 mp
->mnt_newvnodes
.tqh_first
->v_mntvnodes
.tqe_prev
= &mp
->mnt_vnodelist
.tqh_first
;
594 nlvp
->v_mntvnodes
.tqe_next
= mp
->mnt_vnodelist
.tqh_first
;
595 if(mp
->mnt_vnodelist
.tqh_first
)
596 mp
->mnt_vnodelist
.tqh_first
->v_mntvnodes
.tqe_prev
= &nlvp
->v_mntvnodes
.tqe_next
;
598 mp
->mnt_vnodelist
.tqh_last
= mp
->mnt_newvnodes
.tqh_last
;
599 mp
->mnt_vnodelist
.tqh_first
= mp
->mnt_newvnodes
.tqh_first
;
600 TAILQ_INIT(&mp
->mnt_newvnodes
);
609 vnode_iterate_clear(mount_t mp
)
611 mp
->mnt_lflag
&= ~MNT_LITER
;
612 if (mp
->mnt_lflag
& MNT_LITERWAIT
) {
613 mp
->mnt_lflag
&= ~MNT_LITERWAIT
;
620 vnode_iterate(mount_t mp
, int flags
, int (*callout
)(struct vnode
*, void *),
629 vnode_iterate_setup(mp
);
631 /* it is returns 0 then there is nothing to do */
632 retval
= vnode_iterate_prepare(mp
);
635 vnode_iterate_clear(mp
);
640 /* iterate over all the vnodes */
641 while (!TAILQ_EMPTY(&mp
->mnt_workerqueue
)) {
642 vp
= TAILQ_FIRST(&mp
->mnt_workerqueue
);
643 TAILQ_REMOVE(&mp
->mnt_workerqueue
, vp
, v_mntvnodes
);
644 TAILQ_INSERT_TAIL(&mp
->mnt_vnodelist
, vp
, v_mntvnodes
);
646 if ((vp
->v_data
== NULL
) || (vp
->v_type
== VNON
) || (vp
->v_mount
!= mp
)) {
651 if ( vget_internal(vp
, vid
, (flags
| VNODE_NODEAD
| VNODE_WITHID
| VNODE_NOSUSPEND
))) {
655 if (flags
& VNODE_RELOAD
) {
657 * we're reloading the filesystem
658 * cast out any inactive vnodes...
660 if (vnode_reload(vp
)) {
661 /* vnode will be recycled on the refcount drop */
668 retval
= callout(vp
, arg
);
672 case VNODE_RETURNED_DONE
:
674 if (retval
== VNODE_RETURNED_DONE
) {
681 case VNODE_CLAIMED_DONE
:
693 (void)vnode_iterate_reloadq(mp
);
694 vnode_iterate_clear(mp
);
700 mount_lock_renames(mount_t mp
)
702 lck_mtx_lock(&mp
->mnt_renamelock
);
706 mount_unlock_renames(mount_t mp
)
708 lck_mtx_unlock(&mp
->mnt_renamelock
);
712 mount_lock(mount_t mp
)
714 lck_mtx_lock(&mp
->mnt_mlock
);
718 mount_lock_spin(mount_t mp
)
720 lck_mtx_lock_spin(&mp
->mnt_mlock
);
724 mount_unlock(mount_t mp
)
726 lck_mtx_unlock(&mp
->mnt_mlock
);
731 mount_ref(mount_t mp
, int locked
)
744 mount_drop(mount_t mp
, int locked
)
751 if (mp
->mnt_count
== 0 && (mp
->mnt_lflag
& MNT_LDRAIN
))
752 wakeup(&mp
->mnt_lflag
);
760 mount_iterref(mount_t mp
, int locked
)
766 if (mp
->mnt_iterref
< 0) {
777 mount_isdrained(mount_t mp
, int locked
)
783 if (mp
->mnt_iterref
< 0)
793 mount_iterdrop(mount_t mp
)
797 wakeup(&mp
->mnt_iterref
);
802 mount_iterdrain(mount_t mp
)
805 while (mp
->mnt_iterref
)
806 msleep((caddr_t
)&mp
->mnt_iterref
, mnt_list_mtx_lock
, PVFS
, "mount_iterdrain", NULL
);
807 /* mount iterations drained */
808 mp
->mnt_iterref
= -1;
812 mount_iterreset(mount_t mp
)
815 if (mp
->mnt_iterref
== -1)
820 /* always called with mount lock held */
822 mount_refdrain(mount_t mp
)
824 if (mp
->mnt_lflag
& MNT_LDRAIN
)
825 panic("already in drain");
826 mp
->mnt_lflag
|= MNT_LDRAIN
;
828 while (mp
->mnt_count
)
829 msleep((caddr_t
)&mp
->mnt_lflag
, &mp
->mnt_mlock
, PVFS
, "mount_drain", NULL
);
831 if (mp
->mnt_vnodelist
.tqh_first
!= NULL
)
832 panic("mount_refdrain: dangling vnode");
834 mp
->mnt_lflag
&= ~MNT_LDRAIN
;
839 /* Tags the mount point as not supportine extended readdir for NFS exports */
841 mount_set_noreaddirext(mount_t mp
) {
843 mp
->mnt_kern_flag
|= MNTK_DENY_READDIREXT
;
848 * Mark a mount point as busy. Used to synchronize access and to delay
852 vfs_busy(mount_t mp
, int flags
)
856 if (mp
->mnt_lflag
& MNT_LDEAD
)
859 if (mp
->mnt_lflag
& MNT_LUNMOUNT
) {
860 if (flags
& LK_NOWAIT
)
865 if (mp
->mnt_lflag
& MNT_LDEAD
) {
869 if (mp
->mnt_lflag
& MNT_LUNMOUNT
) {
870 mp
->mnt_lflag
|= MNT_LWAIT
;
872 * Since all busy locks are shared except the exclusive
873 * lock granted when unmounting, the only place that a
874 * wakeup needs to be done is at the release of the
875 * exclusive lock at the end of dounmount.
877 msleep((caddr_t
)mp
, &mp
->mnt_mlock
, (PVFS
| PDROP
), "vfsbusy", NULL
);
883 lck_rw_lock_shared(&mp
->mnt_rwlock
);
886 * until we are granted the rwlock, it's possible for the mount point to
887 * change state, so reevaluate before granting the vfs_busy
889 if (mp
->mnt_lflag
& (MNT_LDEAD
| MNT_LUNMOUNT
)) {
890 lck_rw_done(&mp
->mnt_rwlock
);
897 * Free a busy filesystem.
901 vfs_unbusy(mount_t mp
)
903 lck_rw_done(&mp
->mnt_rwlock
);
909 vfs_rootmountfailed(mount_t mp
) {
912 mp
->mnt_vtable
->vfc_refcount
--;
917 mount_lock_destroy(mp
);
920 mac_mount_label_destroy(mp
);
923 FREE_ZONE(mp
, sizeof(struct mount
), M_MOUNT
);
927 * Lookup a filesystem type, and if found allocate and initialize
928 * a mount structure for it.
930 * Devname is usually updated by mount(8) after booting.
933 vfs_rootmountalloc_internal(struct vfstable
*vfsp
, const char *devname
)
937 mp
= _MALLOC_ZONE(sizeof(struct mount
), M_MOUNT
, M_WAITOK
);
938 bzero((char *)mp
, sizeof(struct mount
));
940 /* Initialize the default IO constraints */
941 mp
->mnt_maxreadcnt
= mp
->mnt_maxwritecnt
= MAXPHYS
;
942 mp
->mnt_segreadcnt
= mp
->mnt_segwritecnt
= 32;
943 mp
->mnt_maxsegreadsize
= mp
->mnt_maxreadcnt
;
944 mp
->mnt_maxsegwritesize
= mp
->mnt_maxwritecnt
;
945 mp
->mnt_devblocksize
= DEV_BSIZE
;
946 mp
->mnt_alignmentmask
= PAGE_MASK
;
947 mp
->mnt_ioqueue_depth
= MNT_DEFAULT_IOQUEUE_DEPTH
;
950 mp
->mnt_realrootvp
= NULLVP
;
951 mp
->mnt_authcache_ttl
= CACHED_LOOKUP_RIGHT_TTL
;
952 mp
->mnt_throttle_mask
= LOWPRI_MAX_NUM_DEV
- 1;
953 mp
->mnt_devbsdunit
= 0;
956 (void)vfs_busy(mp
, LK_NOWAIT
);
958 TAILQ_INIT(&mp
->mnt_vnodelist
);
959 TAILQ_INIT(&mp
->mnt_workerqueue
);
960 TAILQ_INIT(&mp
->mnt_newvnodes
);
962 mp
->mnt_vtable
= vfsp
;
963 mp
->mnt_op
= vfsp
->vfc_vfsops
;
964 mp
->mnt_flag
= MNT_RDONLY
| MNT_ROOTFS
;
965 mp
->mnt_vnodecovered
= NULLVP
;
966 //mp->mnt_stat.f_type = vfsp->vfc_typenum;
967 mp
->mnt_flag
|= vfsp
->vfc_flags
& MNT_VISFLAGMASK
;
970 vfsp
->vfc_refcount
++;
973 strncpy(mp
->mnt_vfsstat
.f_fstypename
, vfsp
->vfc_name
, MFSTYPENAMELEN
);
974 mp
->mnt_vfsstat
.f_mntonname
[0] = '/';
975 /* XXX const poisoning layering violation */
976 (void) copystr((const void *)devname
, mp
->mnt_vfsstat
.f_mntfromname
, MAXPATHLEN
- 1, NULL
);
979 mac_mount_label_init(mp
);
980 mac_mount_label_associate(vfs_context_kernel(), mp
);
986 vfs_rootmountalloc(const char *fstypename
, const char *devname
, mount_t
*mpp
)
988 struct vfstable
*vfsp
;
990 for (vfsp
= vfsconf
; vfsp
; vfsp
= vfsp
->vfc_next
)
991 if (!strncmp(vfsp
->vfc_name
, fstypename
,
992 sizeof(vfsp
->vfc_name
)))
997 *mpp
= vfs_rootmountalloc_internal(vfsp
, devname
);
1007 * Find an appropriate filesystem to use for the root. If a filesystem
1008 * has not been preselected, walk through the list of known filesystems
1009 * trying those that have mountroot routines, and try them until one
1010 * works or we have tried them all.
1012 extern int (*mountroot
)(void);
1020 struct vfstable
*vfsp
;
1021 vfs_context_t ctx
= vfs_context_kernel();
1022 struct vfs_attr vfsattr
;
1025 vnode_t bdevvp_rootvp
;
1027 if (mountroot
!= NULL
) {
1029 * used for netboot which follows a different set of rules
1031 error
= (*mountroot
)();
1034 if ((error
= bdevvp(rootdev
, &rootvp
))) {
1035 printf("vfs_mountroot: can't setup bdevvp\n");
1039 * 4951998 - code we call in vfc_mountroot may replace rootvp
1040 * so keep a local copy for some house keeping.
1042 bdevvp_rootvp
= rootvp
;
1044 for (vfsp
= vfsconf
; vfsp
; vfsp
= vfsp
->vfc_next
) {
1045 if (vfsp
->vfc_mountroot
== NULL
)
1048 mp
= vfs_rootmountalloc_internal(vfsp
, "root_device");
1049 mp
->mnt_devvp
= rootvp
;
1051 if ((error
= (*vfsp
->vfc_mountroot
)(mp
, rootvp
, ctx
)) == 0) {
1052 if ( bdevvp_rootvp
!= rootvp
) {
1055 * bump the iocount and fix up mnt_devvp for the
1056 * new rootvp (it will already have a usecount taken)...
1057 * drop the iocount and the usecount on the orignal
1058 * since we are no longer going to use it...
1060 vnode_getwithref(rootvp
);
1061 mp
->mnt_devvp
= rootvp
;
1063 vnode_rele(bdevvp_rootvp
);
1064 vnode_put(bdevvp_rootvp
);
1066 mp
->mnt_devvp
->v_specflags
|= SI_MOUNTEDON
;
1073 * cache the IO attributes for the underlying physical media...
1074 * an error return indicates the underlying driver doesn't
1075 * support all the queries necessary... however, reasonable
1076 * defaults will have been set, so no reason to bail or care
1078 vfs_init_io_attributes(rootvp
, mp
);
1081 * Shadow the VFC_VFSNATIVEXATTR flag to MNTK_EXTENDED_ATTRS.
1083 if (mp
->mnt_vtable
->vfc_vfsflags
& VFC_VFSNATIVEXATTR
) {
1084 mp
->mnt_kern_flag
|= MNTK_EXTENDED_ATTRS
;
1086 if (mp
->mnt_vtable
->vfc_vfsflags
& VFC_VFSPREFLIGHT
) {
1087 mp
->mnt_kern_flag
|= MNTK_UNMOUNT_PREFLIGHT
;
1091 * Probe root file system for additional features.
1093 (void)VFS_START(mp
, 0, ctx
);
1095 VFSATTR_INIT(&vfsattr
);
1096 VFSATTR_WANTED(&vfsattr
, f_capabilities
);
1097 if (vfs_getattr(mp
, &vfsattr
, ctx
) == 0 &&
1098 VFSATTR_IS_SUPPORTED(&vfsattr
, f_capabilities
)) {
1099 if ((vfsattr
.f_capabilities
.capabilities
[VOL_CAPABILITIES_INTERFACES
] & VOL_CAP_INT_EXTENDED_ATTR
) &&
1100 (vfsattr
.f_capabilities
.valid
[VOL_CAPABILITIES_INTERFACES
] & VOL_CAP_INT_EXTENDED_ATTR
)) {
1101 mp
->mnt_kern_flag
|= MNTK_EXTENDED_ATTRS
;
1104 if ((vfsattr
.f_capabilities
.capabilities
[VOL_CAPABILITIES_INTERFACES
] & VOL_CAP_INT_NAMEDSTREAMS
) &&
1105 (vfsattr
.f_capabilities
.valid
[VOL_CAPABILITIES_INTERFACES
] & VOL_CAP_INT_NAMEDSTREAMS
)) {
1106 mp
->mnt_kern_flag
|= MNTK_NAMED_STREAMS
;
1109 if ((vfsattr
.f_capabilities
.capabilities
[VOL_CAPABILITIES_FORMAT
] & VOL_CAP_FMT_PATH_FROM_ID
) &&
1110 (vfsattr
.f_capabilities
.valid
[VOL_CAPABILITIES_FORMAT
] & VOL_CAP_FMT_PATH_FROM_ID
)) {
1111 mp
->mnt_kern_flag
|= MNTK_PATH_FROM_ID
;
1116 * get rid of iocount reference returned
1117 * by bdevvp (or picked up by us on the substitued
1118 * rootvp)... it (or we) will have also taken
1119 * a usecount reference which we want to keep
1124 if ((vfs_flags(mp
) & MNT_MULTILABEL
) == 0)
1127 error
= VFS_ROOT(mp
, &vp
, ctx
);
1129 printf("%s() VFS_ROOT() returned %d\n",
1131 dounmount(mp
, MNT_FORCE
, 0, ctx
);
1134 error
= vnode_label(mp
, NULL
, vp
, NULL
, 0, ctx
);
1136 * get rid of reference provided by VFS_ROOT
1141 printf("%s() vnode_label() returned %d\n",
1143 dounmount(mp
, MNT_FORCE
, 0, ctx
);
1152 vfs_rootmountfailed(mp
);
1154 if (error
!= EINVAL
)
1155 printf("%s_mountroot failed: %d\n", vfsp
->vfc_name
, error
);
1161 * Lookup a mount point by filesystem identifier.
1165 vfs_getvfs(fsid_t
*fsid
)
1167 return (mount_list_lookupby_fsid(fsid
, 0, 0));
1170 static struct mount
*
1171 vfs_getvfs_locked(fsid_t
*fsid
)
1173 return(mount_list_lookupby_fsid(fsid
, 1, 0));
1177 vfs_getvfs_by_mntonname(char *path
)
1179 mount_t retmp
= (mount_t
)0;
1183 TAILQ_FOREACH(mp
, &mountlist
, mnt_list
) {
1184 if (!strncmp(mp
->mnt_vfsstat
.f_mntonname
, path
,
1185 sizeof(mp
->mnt_vfsstat
.f_mntonname
))) {
1187 if (mount_iterref(retmp
, 1))
1193 mount_list_unlock();
1197 /* generation number for creation of new fsids */
1198 u_short mntid_gen
= 0;
1200 * Get a new unique fsid
1203 vfs_getnewfsid(struct mount
*mp
)
1212 /* generate a new fsid */
1213 mtype
= mp
->mnt_vtable
->vfc_typenum
;
1214 if (++mntid_gen
== 0)
1216 tfsid
.val
[0] = makedev(nblkdev
+ mtype
, mntid_gen
);
1217 tfsid
.val
[1] = mtype
;
1219 TAILQ_FOREACH(nmp
, &mountlist
, mnt_list
) {
1220 while (vfs_getvfs_locked(&tfsid
)) {
1221 if (++mntid_gen
== 0)
1223 tfsid
.val
[0] = makedev(nblkdev
+ mtype
, mntid_gen
);
1226 mp
->mnt_vfsstat
.f_fsid
.val
[0] = tfsid
.val
[0];
1227 mp
->mnt_vfsstat
.f_fsid
.val
[1] = tfsid
.val
[1];
1228 mount_list_unlock();
1232 * Routines having to do with the management of the vnode table.
1234 extern int (**dead_vnodeop_p
)(void *);
1235 long numvnodes
, freevnodes
, deadvnodes
, async_work_vnodes
;
1238 int async_work_timed_out
= 0;
1239 int async_work_handled
= 0;
1240 int dead_vnode_wanted
= 0;
1241 int dead_vnode_waited
= 0;
1244 * Move a vnode from one mount queue to another.
1247 insmntque(vnode_t vp
, mount_t mp
)
1251 * Delete from old mount point vnode list, if on one.
1253 if ( (lmp
= vp
->v_mount
) != NULL
&& lmp
!= dead_mountp
) {
1254 if ((vp
->v_lflag
& VNAMED_MOUNT
) == 0)
1255 panic("insmntque: vp not in mount vnode list");
1256 vp
->v_lflag
&= ~VNAMED_MOUNT
;
1258 mount_lock_spin(lmp
);
1262 if (vp
->v_mntvnodes
.tqe_next
== NULL
) {
1263 if (TAILQ_LAST(&lmp
->mnt_vnodelist
, vnodelst
) == vp
)
1264 TAILQ_REMOVE(&lmp
->mnt_vnodelist
, vp
, v_mntvnodes
);
1265 else if (TAILQ_LAST(&lmp
->mnt_newvnodes
, vnodelst
) == vp
)
1266 TAILQ_REMOVE(&lmp
->mnt_newvnodes
, vp
, v_mntvnodes
);
1267 else if (TAILQ_LAST(&lmp
->mnt_workerqueue
, vnodelst
) == vp
)
1268 TAILQ_REMOVE(&lmp
->mnt_workerqueue
, vp
, v_mntvnodes
);
1270 vp
->v_mntvnodes
.tqe_next
->v_mntvnodes
.tqe_prev
= vp
->v_mntvnodes
.tqe_prev
;
1271 *vp
->v_mntvnodes
.tqe_prev
= vp
->v_mntvnodes
.tqe_next
;
1273 vp
->v_mntvnodes
.tqe_next
= NULL
;
1274 vp
->v_mntvnodes
.tqe_prev
= NULL
;
1280 * Insert into list of vnodes for the new mount point, if available.
1282 if ((vp
->v_mount
= mp
) != NULL
) {
1283 mount_lock_spin(mp
);
1284 if ((vp
->v_mntvnodes
.tqe_next
!= 0) && (vp
->v_mntvnodes
.tqe_prev
!= 0))
1285 panic("vp already in mount list");
1286 if (mp
->mnt_lflag
& MNT_LITER
)
1287 TAILQ_INSERT_HEAD(&mp
->mnt_newvnodes
, vp
, v_mntvnodes
);
1289 TAILQ_INSERT_HEAD(&mp
->mnt_vnodelist
, vp
, v_mntvnodes
);
1290 if (vp
->v_lflag
& VNAMED_MOUNT
)
1291 panic("insmntque: vp already in mount vnode list");
1292 vp
->v_lflag
|= VNAMED_MOUNT
;
1300 * Create a vnode for a block device.
1301 * Used for root filesystem, argdev, and swap areas.
1302 * Also used for memory file system special devices.
1305 bdevvp(dev_t dev
, vnode_t
*vpp
)
1309 struct vnode_fsparam vfsp
;
1310 struct vfs_context context
;
1317 context
.vc_thread
= current_thread();
1318 context
.vc_ucred
= FSCRED
;
1320 vfsp
.vnfs_mp
= (struct mount
*)0;
1321 vfsp
.vnfs_vtype
= VBLK
;
1322 vfsp
.vnfs_str
= "bdevvp";
1323 vfsp
.vnfs_dvp
= NULL
;
1324 vfsp
.vnfs_fsnode
= NULL
;
1325 vfsp
.vnfs_cnp
= NULL
;
1326 vfsp
.vnfs_vops
= spec_vnodeop_p
;
1327 vfsp
.vnfs_rdev
= dev
;
1328 vfsp
.vnfs_filesize
= 0;
1330 vfsp
.vnfs_flags
= VNFS_NOCACHE
| VNFS_CANTCACHE
;
1332 vfsp
.vnfs_marksystem
= 0;
1333 vfsp
.vnfs_markroot
= 0;
1335 if ( (error
= vnode_create(VNCREATE_FLAVOR
, VCREATESIZE
, &vfsp
, &nvp
)) ) {
1339 vnode_lock_spin(nvp
);
1340 nvp
->v_flag
|= VBDEVVP
;
1341 nvp
->v_tag
= VT_NON
; /* set this to VT_NON so during aliasing it can be replaced */
1343 if ( (error
= vnode_ref(nvp
)) ) {
1344 panic("bdevvp failed: vnode_ref");
1347 if ( (error
= VNOP_FSYNC(nvp
, MNT_WAIT
, &context
)) ) {
1348 panic("bdevvp failed: fsync");
1351 if ( (error
= buf_invalidateblks(nvp
, BUF_WRITE_DATA
, 0, 0)) ) {
1352 panic("bdevvp failed: invalidateblks");
1358 * XXXMAC: We can't put a MAC check here, the system will
1359 * panic without this vnode.
1363 if ( (error
= VNOP_OPEN(nvp
, FREAD
, &context
)) ) {
1364 panic("bdevvp failed: open");
1373 * Check to see if the new vnode represents a special device
1374 * for which we already have a vnode (either because of
1375 * bdevvp() or because of a different vnode representing
1376 * the same block device). If such an alias exists, deallocate
1377 * the existing contents and return the aliased vnode. The
1378 * caller is responsible for filling it with its new contents.
1381 checkalias(struct vnode
*nvp
, dev_t nvp_rdev
)
1385 struct specinfo
*sin
= NULL
;
1388 vpp
= &speclisth
[SPECHASH(nvp_rdev
)];
1392 for (vp
= *vpp
; vp
; vp
= vp
->v_specnext
) {
1393 if (nvp_rdev
== vp
->v_rdev
&& nvp
->v_type
== vp
->v_type
) {
1402 if (vnode_getwithvid(vp
,vid
)) {
1406 * Termination state is checked in vnode_getwithvid
1411 * Alias, but not in use, so flush it out.
1413 if ((vp
->v_iocount
== 1) && (vp
->v_usecount
== 0)) {
1414 vnode_reclaim_internal(vp
, 1, 1, 0);
1415 vnode_put_locked(vp
);
1421 if (vp
== NULL
|| vp
->v_tag
!= VT_NON
) {
1423 MALLOC_ZONE(sin
, struct specinfo
*, sizeof(struct specinfo
),
1424 M_SPECINFO
, M_WAITOK
);
1427 nvp
->v_specinfo
= sin
;
1428 bzero(nvp
->v_specinfo
, sizeof(struct specinfo
));
1429 nvp
->v_rdev
= nvp_rdev
;
1430 nvp
->v_specflags
= 0;
1431 nvp
->v_speclastr
= -1;
1432 nvp
->v_specinfo
->si_opencount
= 0;
1433 nvp
->v_specinfo
->si_initted
= 0;
1434 nvp
->v_specinfo
->si_throttleable
= 0;
1438 /* We dropped the lock, someone could have added */
1440 for (vp
= *vpp
; vp
; vp
= vp
->v_specnext
) {
1441 if (nvp_rdev
== vp
->v_rdev
&& nvp
->v_type
== vp
->v_type
) {
1449 nvp
->v_hashchain
= vpp
;
1450 nvp
->v_specnext
= *vpp
;
1454 nvp
->v_specflags
|= SI_ALIASED
;
1455 vp
->v_specflags
|= SI_ALIASED
;
1457 vnode_put_locked(vp
);
1467 FREE_ZONE(sin
, sizeof(struct specinfo
), M_SPECINFO
);
1470 if ((vp
->v_flag
& (VBDEVVP
| VDEVFLUSH
)) != 0)
1473 panic("checkalias with VT_NON vp that shouldn't: %p", vp
);
1480 * Get a reference on a particular vnode and lock it if requested.
1481 * If the vnode was on the inactive list, remove it from the list.
1482 * If the vnode was on the free list, remove it from the list and
1483 * move it to inactive list as needed.
1484 * The vnode lock bit is set if the vnode is being eliminated in
1485 * vgone. The process is awakened when the transition is completed,
1486 * and an error returned to indicate that the vnode is no longer
1487 * usable (possibly having been changed to a new file system type).
1490 vget_internal(vnode_t vp
, int vid
, int vflags
)
1494 vnode_lock_spin(vp
);
1496 if ((vflags
& VNODE_WRITEABLE
) && (vp
->v_writecount
== 0))
1498 * vnode to be returned only if it has writers opened
1502 error
= vnode_getiocount(vp
, vid
, vflags
);
1510 * Returns: 0 Success
1511 * ENOENT No such file or directory [terminating]
1514 vnode_ref(vnode_t vp
)
1517 return (vnode_ref_ext(vp
, 0, 0));
1521 * Returns: 0 Success
1522 * ENOENT No such file or directory [terminating]
1525 vnode_ref_ext(vnode_t vp
, int fmode
, int flags
)
1529 vnode_lock_spin(vp
);
1532 * once all the current call sites have been fixed to insure they have
1533 * taken an iocount, we can toughen this assert up and insist that the
1534 * iocount is non-zero... a non-zero usecount doesn't insure correctness
1536 if (vp
->v_iocount
<= 0 && vp
->v_usecount
<= 0)
1537 panic("vnode_ref_ext: vp %p has no valid reference %d, %d", vp
, vp
->v_iocount
, vp
->v_usecount
);
1540 * if you are the owner of drain/termination, can acquire usecount
1542 if ((flags
& VNODE_REF_FORCE
) == 0) {
1543 if ((vp
->v_lflag
& (VL_DRAIN
| VL_TERMINATE
| VL_DEAD
))) {
1544 if (vp
->v_owner
!= current_thread()) {
1552 if (fmode
& FWRITE
) {
1553 if (++vp
->v_writecount
<= 0)
1554 panic("vnode_ref_ext: v_writecount");
1556 if (fmode
& O_EVTONLY
) {
1557 if (++vp
->v_kusecount
<= 0)
1558 panic("vnode_ref_ext: v_kusecount");
1560 if (vp
->v_flag
& VRAGE
) {
1563 ut
= get_bsdthread_info(current_thread());
1565 if ( !(current_proc()->p_lflag
& P_LRAGE_VNODES
) &&
1566 !(ut
->uu_flag
& UT_RAGE_VNODES
)) {
1568 * a 'normal' process accessed this vnode
1569 * so make sure its no longer marked
1570 * for rapid aging... also, make sure
1571 * it gets removed from the rage list...
1572 * when v_usecount drops back to 0, it
1573 * will be put back on the real free list
1575 vp
->v_flag
&= ~VRAGE
;
1576 vp
->v_references
= 0;
1577 vnode_list_remove(vp
);
1580 if (vp
->v_usecount
== 1 && vp
->v_type
== VREG
&& !(vp
->v_flag
& VSYSTEM
)) {
1582 if (vp
->v_ubcinfo
) {
1583 vnode_lock_convert(vp
);
1584 memory_object_mark_used(vp
->v_ubcinfo
->ui_control
);
1595 vnode_on_reliable_media(vnode_t vp
)
1597 if ( !(vp
->v_mount
->mnt_kern_flag
& MNTK_VIRTUALDEV
) && (vp
->v_mount
->mnt_flag
& MNT_LOCAL
) )
1603 vnode_async_list_add(vnode_t vp
)
1607 if (VONLIST(vp
) || (vp
->v_lflag
& (VL_TERMINATE
|VL_DEAD
)))
1608 panic("vnode_async_list_add: %p is in wrong state", vp
);
1610 TAILQ_INSERT_HEAD(&vnode_async_work_list
, vp
, v_freelist
);
1611 vp
->v_listflag
|= VLIST_ASYNC_WORK
;
1613 async_work_vnodes
++;
1615 vnode_list_unlock();
1617 wakeup(&vnode_async_work_list
);
1623 * put the vnode on appropriate free list.
1624 * called with vnode LOCKED
1627 vnode_list_add(vnode_t vp
)
1629 boolean_t need_dead_wakeup
= FALSE
;
1632 lck_mtx_assert(&vp
->v_lock
, LCK_MTX_ASSERT_OWNED
);
1635 * if it is already on a list or non zero references return
1637 if (VONLIST(vp
) || (vp
->v_usecount
!= 0) || (vp
->v_iocount
!= 0) || (vp
->v_lflag
& VL_TERMINATE
))
1642 if ((vp
->v_flag
& VRAGE
) && !(vp
->v_lflag
& VL_DEAD
)) {
1644 * add the new guy to the appropriate end of the RAGE list
1646 if ((vp
->v_flag
& VAGE
))
1647 TAILQ_INSERT_HEAD(&vnode_rage_list
, vp
, v_freelist
);
1649 TAILQ_INSERT_TAIL(&vnode_rage_list
, vp
, v_freelist
);
1651 vp
->v_listflag
|= VLIST_RAGE
;
1655 * reset the timestamp for the last inserted vp on the RAGE
1656 * queue to let new_vnode know that its not ok to start stealing
1657 * from this list... as long as we're actively adding to this list
1658 * we'll push out the vnodes we want to donate to the real free list
1659 * once we stop pushing, we'll let some time elapse before we start
1660 * stealing them in the new_vnode routine
1662 microuptime(&rage_tv
);
1665 * if VL_DEAD, insert it at head of the dead list
1666 * else insert at tail of LRU list or at head if VAGE is set
1668 if ( (vp
->v_lflag
& VL_DEAD
)) {
1669 TAILQ_INSERT_HEAD(&vnode_dead_list
, vp
, v_freelist
);
1670 vp
->v_listflag
|= VLIST_DEAD
;
1673 if (dead_vnode_wanted
) {
1674 dead_vnode_wanted
--;
1675 need_dead_wakeup
= TRUE
;
1678 } else if ( (vp
->v_flag
& VAGE
) ) {
1679 TAILQ_INSERT_HEAD(&vnode_free_list
, vp
, v_freelist
);
1680 vp
->v_flag
&= ~VAGE
;
1683 TAILQ_INSERT_TAIL(&vnode_free_list
, vp
, v_freelist
);
1687 vnode_list_unlock();
1689 if (need_dead_wakeup
== TRUE
)
1690 wakeup_one((caddr_t
)&dead_vnode_wanted
);
1695 * remove the vnode from appropriate free list.
1696 * called with vnode LOCKED and
1697 * the list lock held
1700 vnode_list_remove_locked(vnode_t vp
)
1704 * the v_listflag field is
1705 * protected by the vnode_list_lock
1707 if (vp
->v_listflag
& VLIST_RAGE
)
1708 VREMRAGE("vnode_list_remove", vp
);
1709 else if (vp
->v_listflag
& VLIST_DEAD
)
1710 VREMDEAD("vnode_list_remove", vp
);
1711 else if (vp
->v_listflag
& VLIST_ASYNC_WORK
)
1712 VREMASYNC_WORK("vnode_list_remove", vp
);
1714 VREMFREE("vnode_list_remove", vp
);
1720 * remove the vnode from appropriate free list.
1721 * called with vnode LOCKED
1724 vnode_list_remove(vnode_t vp
)
1727 lck_mtx_assert(&vp
->v_lock
, LCK_MTX_ASSERT_OWNED
);
1730 * we want to avoid taking the list lock
1731 * in the case where we're not on the free
1732 * list... this will be true for most
1733 * directories and any currently in use files
1735 * we're guaranteed that we can't go from
1736 * the not-on-list state to the on-list
1737 * state since we hold the vnode lock...
1738 * all calls to vnode_list_add are done
1739 * under the vnode lock... so we can
1740 * check for that condition (the prevelant one)
1741 * without taking the list lock
1746 * however, we're not guaranteed that
1747 * we won't go from the on-list state
1748 * to the not-on-list state until we
1749 * hold the vnode_list_lock... this
1750 * is due to "new_vnode" removing vnodes
1751 * from the free list uder the list_lock
1752 * w/o the vnode lock... so we need to
1753 * check again whether we're currently
1756 vnode_list_remove_locked(vp
);
1758 vnode_list_unlock();
1764 vnode_rele(vnode_t vp
)
1766 vnode_rele_internal(vp
, 0, 0, 0);
1771 vnode_rele_ext(vnode_t vp
, int fmode
, int dont_reenter
)
1773 vnode_rele_internal(vp
, fmode
, dont_reenter
, 0);
1778 vnode_rele_internal(vnode_t vp
, int fmode
, int dont_reenter
, int locked
)
1782 vnode_lock_spin(vp
);
1785 lck_mtx_assert(&vp
->v_lock
, LCK_MTX_ASSERT_OWNED
);
1787 if (--vp
->v_usecount
< 0)
1788 panic("vnode_rele_ext: vp %p usecount -ve : %d. v_tag = %d, v_type = %d, v_flag = %x.", vp
, vp
->v_usecount
, vp
->v_tag
, vp
->v_type
, vp
->v_flag
);
1790 if (fmode
& FWRITE
) {
1791 if (--vp
->v_writecount
< 0)
1792 panic("vnode_rele_ext: vp %p writecount -ve : %d. v_tag = %d, v_type = %d, v_flag = %x.", vp
, vp
->v_writecount
, vp
->v_tag
, vp
->v_type
, vp
->v_flag
);
1794 if (fmode
& O_EVTONLY
) {
1795 if (--vp
->v_kusecount
< 0)
1796 panic("vnode_rele_ext: vp %p kusecount -ve : %d. v_tag = %d, v_type = %d, v_flag = %x.", vp
, vp
->v_kusecount
, vp
->v_tag
, vp
->v_type
, vp
->v_flag
);
1798 if (vp
->v_kusecount
> vp
->v_usecount
)
1799 panic("vnode_rele_ext: vp %p kusecount(%d) out of balance with usecount(%d). v_tag = %d, v_type = %d, v_flag = %x.",vp
, vp
->v_kusecount
, vp
->v_usecount
, vp
->v_tag
, vp
->v_type
, vp
->v_flag
);
1801 if ((vp
->v_iocount
> 0) || (vp
->v_usecount
> 0)) {
1803 * vnode is still busy... if we're the last
1804 * usecount, mark for a future call to VNOP_INACTIVE
1805 * when the iocount finally drops to 0
1807 if (vp
->v_usecount
== 0) {
1808 vp
->v_lflag
|= VL_NEEDINACTIVE
;
1809 vp
->v_flag
&= ~(VNOCACHE_DATA
| VRAOFF
| VOPENEVT
);
1813 vp
->v_flag
&= ~(VNOCACHE_DATA
| VRAOFF
| VOPENEVT
);
1815 if ( (vp
->v_lflag
& (VL_TERMINATE
| VL_DEAD
)) || dont_reenter
) {
1817 * vnode is being cleaned, or
1818 * we've requested that we don't reenter
1819 * the filesystem on this release... in
1820 * this case, we'll mark the vnode aged
1821 * if it's been marked for termination
1824 if ( !(vp
->v_lflag
& (VL_TERMINATE
| VL_DEAD
| VL_MARKTERM
)) ) {
1825 vp
->v_lflag
|= VL_NEEDINACTIVE
;
1827 if (vnode_on_reliable_media(vp
) == FALSE
) {
1828 vnode_async_list_add(vp
);
1839 * at this point both the iocount and usecount
1841 * pick up an iocount so that we can call
1842 * VNOP_INACTIVE with the vnode lock unheld
1848 vp
->v_lflag
&= ~VL_NEEDINACTIVE
;
1851 VNOP_INACTIVE(vp
, vfs_context_current());
1853 vnode_lock_spin(vp
);
1855 * because we dropped the vnode lock to call VNOP_INACTIVE
1856 * the state of the vnode may have changed... we may have
1857 * picked up an iocount, usecount or the MARKTERM may have
1858 * been set... we need to reevaluate the reference counts
1859 * to determine if we can call vnode_reclaim_internal at
1860 * this point... if the reference counts are up, we'll pick
1861 * up the MARKTERM state when they get subsequently dropped
1863 if ( (vp
->v_iocount
== 1) && (vp
->v_usecount
== 0) &&
1864 ((vp
->v_lflag
& (VL_MARKTERM
| VL_TERMINATE
| VL_DEAD
)) == VL_MARKTERM
)) {
1867 ut
= get_bsdthread_info(current_thread());
1869 if (ut
->uu_defer_reclaims
) {
1870 vp
->v_defer_reclaimlist
= ut
->uu_vreclaims
;
1871 ut
->uu_vreclaims
= vp
;
1874 vnode_lock_convert(vp
);
1875 vnode_reclaim_internal(vp
, 1, 1, 0);
1877 vnode_dropiocount(vp
);
1880 if (vp
->v_usecount
== 0 && vp
->v_type
== VREG
&& !(vp
->v_flag
& VSYSTEM
)) {
1882 if (vp
->v_ubcinfo
) {
1883 vnode_lock_convert(vp
);
1884 memory_object_mark_unused(vp
->v_ubcinfo
->ui_control
, (vp
->v_flag
& VRAGE
) == VRAGE
);
1893 * Remove any vnodes in the vnode table belonging to mount point mp.
1895 * If MNT_NOFORCE is specified, there should not be any active ones,
1896 * return error if any are found (nb: this is a user error, not a
1897 * system error). If MNT_FORCE is specified, detach any active vnodes
1901 int busyprt
= 0; /* print out busy vnodes */
1903 struct ctldebug debug1
= { "busyprt", &busyprt
};
1908 vflush(struct mount
*mp
, struct vnode
*skipvp
, int flags
)
1917 vnode_iterate_setup(mp
);
1919 * On regular unmounts(not forced) do a
1920 * quick check for vnodes to be in use. This
1921 * preserves the caching of vnodes. automounter
1922 * tries unmounting every so often to see whether
1923 * it is still busy or not.
1925 if (((flags
& FORCECLOSE
)==0) && ((mp
->mnt_kern_flag
& MNTK_UNMOUNT_PREFLIGHT
) != 0)) {
1926 if (vnode_umount_preflight(mp
, skipvp
, flags
)) {
1927 vnode_iterate_clear(mp
);
1933 /* it is returns 0 then there is nothing to do */
1934 retval
= vnode_iterate_prepare(mp
);
1937 vnode_iterate_clear(mp
);
1942 /* iterate over all the vnodes */
1943 while (!TAILQ_EMPTY(&mp
->mnt_workerqueue
)) {
1945 vp
= TAILQ_FIRST(&mp
->mnt_workerqueue
);
1946 TAILQ_REMOVE(&mp
->mnt_workerqueue
, vp
, v_mntvnodes
);
1947 TAILQ_INSERT_TAIL(&mp
->mnt_vnodelist
, vp
, v_mntvnodes
);
1949 if ( (vp
->v_mount
!= mp
) || (vp
== skipvp
)) {
1955 vnode_lock_spin(vp
);
1957 if ((vp
->v_id
!= vid
) || ((vp
->v_lflag
& (VL_DEAD
| VL_TERMINATE
)))) {
1964 * If requested, skip over vnodes marked VSYSTEM.
1965 * Skip over all vnodes marked VNOFLUSH.
1967 if ((flags
& SKIPSYSTEM
) && ((vp
->v_flag
& VSYSTEM
) ||
1968 (vp
->v_flag
& VNOFLUSH
))) {
1974 * If requested, skip over vnodes marked VSWAP.
1976 if ((flags
& SKIPSWAP
) && (vp
->v_flag
& VSWAP
)) {
1982 * If requested, skip over vnodes marked VROOT.
1984 if ((flags
& SKIPROOT
) && (vp
->v_flag
& VROOT
)) {
1990 * If WRITECLOSE is set, only flush out regular file
1991 * vnodes open for writing.
1993 if ((flags
& WRITECLOSE
) &&
1994 (vp
->v_writecount
== 0 || vp
->v_type
!= VREG
)) {
2000 * If the real usecount is 0, all we need to do is clear
2001 * out the vnode data structures and we are done.
2003 if (((vp
->v_usecount
== 0) ||
2004 ((vp
->v_usecount
- vp
->v_kusecount
) == 0))) {
2006 vnode_lock_convert(vp
);
2007 vp
->v_iocount
++; /* so that drain waits for * other iocounts */
2011 vnode_reclaim_internal(vp
, 1, 1, 0);
2012 vnode_dropiocount(vp
);
2021 * If FORCECLOSE is set, forcibly close the vnode.
2022 * For block or character devices, revert to an
2023 * anonymous device. For all other files, just kill them.
2025 if (flags
& FORCECLOSE
) {
2026 vnode_lock_convert(vp
);
2028 if (vp
->v_type
!= VBLK
&& vp
->v_type
!= VCHR
) {
2029 vp
->v_iocount
++; /* so that drain waits * for other iocounts */
2033 vnode_abort_advlocks(vp
);
2034 vnode_reclaim_internal(vp
, 1, 1, 0);
2035 vnode_dropiocount(vp
);
2040 vp
->v_lflag
&= ~VL_DEAD
;
2041 vp
->v_op
= spec_vnodeop_p
;
2042 vp
->v_flag
|= VDEVFLUSH
;
2050 vprint("vflush: busy vnode", vp
);
2057 /* At this point the worker queue is completed */
2058 if (busy
&& ((flags
& FORCECLOSE
)==0) && reclaimed
) {
2061 (void)vnode_iterate_reloadq(mp
);
2062 /* returned with mount lock held */
2066 /* if new vnodes were created in between retry the reclaim */
2067 if ( vnode_iterate_reloadq(mp
) != 0) {
2068 if (!(busy
&& ((flags
& FORCECLOSE
)==0)))
2071 vnode_iterate_clear(mp
);
2074 if (busy
&& ((flags
& FORCECLOSE
)==0))
2079 long num_recycledvnodes
= 0;
2081 * Disassociate the underlying file system from a vnode.
2082 * The vnode lock is held on entry.
2085 vclean(vnode_t vp
, int flags
)
2087 vfs_context_t ctx
= vfs_context_current();
2090 int already_terminating
;
2097 * Check to see if the vnode is in use.
2098 * If so we have to reference it before we clean it out
2099 * so that its count cannot fall to zero and generate a
2100 * race against ourselves to recycle it.
2102 active
= vp
->v_usecount
;
2105 * just in case we missed sending a needed
2106 * VNOP_INACTIVE, we'll do it now
2108 need_inactive
= (vp
->v_lflag
& VL_NEEDINACTIVE
);
2110 vp
->v_lflag
&= ~VL_NEEDINACTIVE
;
2113 * Prevent the vnode from being recycled or
2114 * brought into use while we clean it out.
2116 already_terminating
= (vp
->v_lflag
& VL_TERMINATE
);
2118 vp
->v_lflag
|= VL_TERMINATE
;
2121 * remove the vnode from any mount list
2124 insmntque(vp
, (struct mount
*)0);
2127 is_namedstream
= vnode_isnamedstream(vp
);
2132 OSAddAtomicLong(1, &num_recycledvnodes
);
2134 if (flags
& DOCLOSE
)
2135 clflags
|= IO_NDELAY
;
2136 if (flags
& REVOKEALL
)
2137 clflags
|= IO_REVOKE
;
2139 if (active
&& (flags
& DOCLOSE
))
2140 VNOP_CLOSE(vp
, clflags
, ctx
);
2143 * Clean out any buffers associated with the vnode.
2145 if (flags
& DOCLOSE
) {
2147 if (vp
->v_tag
== VT_NFS
)
2148 nfs_vinvalbuf(vp
, V_SAVE
, ctx
, 0);
2152 VNOP_FSYNC(vp
, MNT_WAIT
, ctx
);
2153 buf_invalidateblks(vp
, BUF_WRITE_DATA
| BUF_INVALIDATE_LOCKED
, 0, 0);
2155 if (UBCINFOEXISTS(vp
))
2157 * Clean the pages in VM.
2159 (void)ubc_msync(vp
, (off_t
)0, ubc_getsize(vp
), NULL
, UBC_PUSHALL
| UBC_INVALIDATE
| UBC_SYNC
);
2161 if (active
|| need_inactive
)
2162 VNOP_INACTIVE(vp
, ctx
);
2165 if ((is_namedstream
!= 0) && (vp
->v_parent
!= NULLVP
)) {
2166 vnode_t pvp
= vp
->v_parent
;
2168 /* Delete the shadow stream file before we reclaim its vnode */
2169 if (vnode_isshadow(vp
)) {
2170 vnode_relenamedstream(pvp
, vp
);
2174 * No more streams associated with the parent. We
2175 * have a ref on it, so its identity is stable.
2176 * If the parent is on an opaque volume, then we need to know
2177 * whether it has associated named streams.
2179 if (vfs_authopaque(pvp
->v_mount
)) {
2180 vnode_lock_spin(pvp
);
2181 pvp
->v_lflag
&= ~VL_HASSTREAMS
;
2188 * Destroy ubc named reference
2189 * cluster_release is done on this path
2190 * along with dropping the reference on the ucred
2192 ubc_destroy_named(vp
);
2196 * cleanup trigger info from vnode (if any)
2199 vnode_resolver_detach(vp
);
2203 * Reclaim the vnode.
2205 if (VNOP_RECLAIM(vp
, ctx
))
2206 panic("vclean: cannot reclaim");
2208 // make sure the name & parent ptrs get cleaned out!
2209 vnode_update_identity(vp
, NULLVP
, NULL
, 0, 0, VNODE_UPDATE_PARENT
| VNODE_UPDATE_NAME
| VNODE_UPDATE_PURGE
);
2213 vp
->v_mount
= dead_mountp
;
2214 vp
->v_op
= dead_vnodeop_p
;
2218 vp
->v_lflag
|= VL_DEAD
;
2220 if (already_terminating
== 0) {
2221 vp
->v_lflag
&= ~VL_TERMINATE
;
2223 * Done with purge, notify sleepers of the grim news.
2225 if (vp
->v_lflag
& VL_TERMWANT
) {
2226 vp
->v_lflag
&= ~VL_TERMWANT
;
2227 wakeup(&vp
->v_lflag
);
2233 * Eliminate all activity associated with the requested vnode
2234 * and with all vnodes aliased to the requested vnode.
2238 vn_revoke(vnode_t vp
, int flags
, __unused vfs_context_t a_context
)
2240 vn_revoke(vnode_t vp
, __unused
int flags
, __unused vfs_context_t a_context
)
2247 if ((flags
& REVOKEALL
) == 0)
2248 panic("vnop_revoke");
2251 if (vnode_isaliased(vp
)) {
2253 * If a vgone (or vclean) is already in progress,
2254 * return an immediate error
2256 if (vp
->v_lflag
& VL_TERMINATE
)
2260 * Ensure that vp will not be vgone'd while we
2261 * are eliminating its aliases.
2264 while ((vp
->v_specflags
& SI_ALIASED
)) {
2265 for (vq
= *vp
->v_hashchain
; vq
; vq
= vq
->v_specnext
) {
2266 if (vq
->v_rdev
!= vp
->v_rdev
||
2267 vq
->v_type
!= vp
->v_type
|| vp
== vq
)
2271 if (vnode_getwithvid(vq
,vid
)){
2275 vnode_reclaim_internal(vq
, 0, 1, 0);
2283 vnode_reclaim_internal(vp
, 0, 0, REVOKEALL
);
2289 * Recycle an unused vnode to the front of the free list.
2290 * Release the passed interlock if the vnode will be recycled.
2293 vnode_recycle(struct vnode
*vp
)
2295 vnode_lock_spin(vp
);
2297 if (vp
->v_iocount
|| vp
->v_usecount
) {
2298 vp
->v_lflag
|= VL_MARKTERM
;
2302 vnode_lock_convert(vp
);
2303 vnode_reclaim_internal(vp
, 1, 0, 0);
2311 vnode_reload(vnode_t vp
)
2313 vnode_lock_spin(vp
);
2315 if ((vp
->v_iocount
> 1) || vp
->v_usecount
) {
2319 if (vp
->v_iocount
<= 0)
2320 panic("vnode_reload with no iocount %d", vp
->v_iocount
);
2322 /* mark for release when iocount is dopped */
2323 vp
->v_lflag
|= VL_MARKTERM
;
2331 vgone(vnode_t vp
, int flags
)
2337 * Clean out the filesystem specific data.
2338 * vclean also takes care of removing the
2339 * vnode from any mount list it might be on
2341 vclean(vp
, flags
| DOCLOSE
);
2344 * If special device, remove it from special device alias list
2347 if ((vp
->v_type
== VBLK
|| vp
->v_type
== VCHR
) && vp
->v_specinfo
!= 0) {
2349 if (*vp
->v_hashchain
== vp
) {
2350 *vp
->v_hashchain
= vp
->v_specnext
;
2352 for (vq
= *vp
->v_hashchain
; vq
; vq
= vq
->v_specnext
) {
2353 if (vq
->v_specnext
!= vp
)
2355 vq
->v_specnext
= vp
->v_specnext
;
2359 panic("missing bdev");
2361 if (vp
->v_specflags
& SI_ALIASED
) {
2363 for (vq
= *vp
->v_hashchain
; vq
; vq
= vq
->v_specnext
) {
2364 if (vq
->v_rdev
!= vp
->v_rdev
||
2365 vq
->v_type
!= vp
->v_type
)
2372 panic("missing alias");
2374 vx
->v_specflags
&= ~SI_ALIASED
;
2375 vp
->v_specflags
&= ~SI_ALIASED
;
2379 struct specinfo
*tmp
= vp
->v_specinfo
;
2380 vp
->v_specinfo
= NULL
;
2381 FREE_ZONE((void *)tmp
, sizeof(struct specinfo
), M_SPECINFO
);
2387 * Lookup a vnode by device number.
2390 check_mountedon(dev_t dev
, enum vtype type
, int *errorp
)
2398 for (vp
= speclisth
[SPECHASH(dev
)]; vp
; vp
= vp
->v_specnext
) {
2399 if (dev
!= vp
->v_rdev
|| type
!= vp
->v_type
)
2403 if (vnode_getwithvid(vp
,vid
))
2405 vnode_lock_spin(vp
);
2406 if ((vp
->v_usecount
> 0) || (vp
->v_iocount
> 1)) {
2408 if ((*errorp
= vfs_mountedon(vp
)) != 0)
2420 * Calculate the total number of references to a special device.
2430 if (!vnode_isaliased(vp
))
2431 return (vp
->v_specinfo
->si_opencount
);
2436 * Grab first vnode and its vid.
2438 vq
= *vp
->v_hashchain
;
2439 vid
= vq
? vq
->v_id
: 0;
2445 * Attempt to get the vnode outside the SPECHASH lock.
2447 if (vnode_getwithvid(vq
, vid
)) {
2452 if (vq
->v_rdev
== vp
->v_rdev
&& vq
->v_type
== vp
->v_type
) {
2453 if ((vq
->v_usecount
== 0) && (vq
->v_iocount
== 1) && vq
!= vp
) {
2455 * Alias, but not in use, so flush it out.
2457 vnode_reclaim_internal(vq
, 1, 1, 0);
2458 vnode_put_locked(vq
);
2462 count
+= vq
->v_specinfo
->si_opencount
;
2468 * must do this with the reference still held on 'vq'
2469 * so that it can't be destroyed while we're poking
2470 * through v_specnext
2472 vnext
= vq
->v_specnext
;
2473 vid
= vnext
? vnext
->v_id
: 0;
2485 int prtactive
= 0; /* 1 => print out reclaim of active vnodes */
2488 * Print out a description of a vnode.
2490 static const char *typename
[] =
2491 { "VNON", "VREG", "VDIR", "VBLK", "VCHR", "VLNK", "VSOCK", "VFIFO", "VBAD" };
2494 vprint(const char *label
, struct vnode
*vp
)
2499 printf("%s: ", label
);
2500 printf("type %s, usecount %d, writecount %d",
2501 typename
[vp
->v_type
], vp
->v_usecount
, vp
->v_writecount
);
2503 if (vp
->v_flag
& VROOT
)
2504 strlcat(sbuf
, "|VROOT", sizeof(sbuf
));
2505 if (vp
->v_flag
& VTEXT
)
2506 strlcat(sbuf
, "|VTEXT", sizeof(sbuf
));
2507 if (vp
->v_flag
& VSYSTEM
)
2508 strlcat(sbuf
, "|VSYSTEM", sizeof(sbuf
));
2509 if (vp
->v_flag
& VNOFLUSH
)
2510 strlcat(sbuf
, "|VNOFLUSH", sizeof(sbuf
));
2511 if (vp
->v_flag
& VBWAIT
)
2512 strlcat(sbuf
, "|VBWAIT", sizeof(sbuf
));
2513 if (vnode_isaliased(vp
))
2514 strlcat(sbuf
, "|VALIASED", sizeof(sbuf
));
2515 if (sbuf
[0] != '\0')
2516 printf(" flags (%s)", &sbuf
[1]);
2521 vn_getpath(struct vnode
*vp
, char *pathbuf
, int *len
)
2523 return build_path(vp
, pathbuf
, *len
, len
, BUILDPATH_NO_FS_ENTER
, vfs_context_current());
2527 vn_getpath_fsenter(struct vnode
*vp
, char *pathbuf
, int *len
)
2529 return build_path(vp
, pathbuf
, *len
, len
, 0, vfs_context_current());
2533 vn_getcdhash(struct vnode
*vp
, off_t offset
, unsigned char *cdhash
)
2535 return ubc_cs_getcdhash(vp
, offset
, cdhash
);
2539 static char *extension_table
=NULL
;
2541 static int max_ext_width
;
2544 extension_cmp(const void *a
, const void *b
)
2546 return (strlen((const char *)a
) - strlen((const char *)b
));
2551 // This is the api LaunchServices uses to inform the kernel
2552 // the list of package extensions to ignore.
2554 // Internally we keep the list sorted by the length of the
2555 // the extension (from longest to shortest). We sort the
2556 // list of extensions so that we can speed up our searches
2557 // when comparing file names -- we only compare extensions
2558 // that could possibly fit into the file name, not all of
2559 // them (i.e. a short 8 character name can't have an 8
2560 // character extension).
2562 extern lck_mtx_t
*pkg_extensions_lck
;
2564 __private_extern__
int
2565 set_package_extensions_table(user_addr_t data
, int nentries
, int maxwidth
)
2567 char *new_exts
, *old_exts
;
2570 if (nentries
<= 0 || nentries
> 1024 || maxwidth
<= 0 || maxwidth
> 255) {
2575 // allocate one byte extra so we can guarantee null termination
2576 MALLOC(new_exts
, char *, (nentries
* maxwidth
) + 1, M_TEMP
, M_WAITOK
);
2577 if (new_exts
== NULL
) {
2581 error
= copyin(data
, new_exts
, nentries
* maxwidth
);
2583 FREE(new_exts
, M_TEMP
);
2587 new_exts
[(nentries
* maxwidth
)] = '\0'; // guarantee null termination of the block
2589 qsort(new_exts
, nentries
, maxwidth
, extension_cmp
);
2591 lck_mtx_lock(pkg_extensions_lck
);
2593 old_exts
= extension_table
;
2594 extension_table
= new_exts
;
2596 max_ext_width
= maxwidth
;
2598 lck_mtx_unlock(pkg_extensions_lck
);
2601 FREE(old_exts
, M_TEMP
);
2608 __private_extern__
int
2609 is_package_name(const char *name
, int len
)
2612 const char *ptr
, *name_ext
;
2619 for(ptr
=name
; *ptr
!= '\0'; ptr
++) {
2625 // if there is no "." extension, it can't match
2626 if (name_ext
== NULL
) {
2630 // advance over the "."
2633 lck_mtx_lock(pkg_extensions_lck
);
2635 // now iterate over all the extensions to see if any match
2636 ptr
= &extension_table
[0];
2637 for(i
=0; i
< nexts
; i
++, ptr
+=max_ext_width
) {
2638 extlen
= strlen(ptr
);
2639 if (strncasecmp(name_ext
, ptr
, extlen
) == 0 && name_ext
[extlen
] == '\0') {
2641 lck_mtx_unlock(pkg_extensions_lck
);
2646 lck_mtx_unlock(pkg_extensions_lck
);
2648 // if we get here, no extension matched
2653 vn_path_package_check(__unused vnode_t vp
, char *path
, int pathlen
, int *component
)
2664 while(end
< path
+ pathlen
&& *end
!= '\0') {
2665 while(end
< path
+ pathlen
&& *end
== '/' && *end
!= '\0') {
2671 while(end
< path
+ pathlen
&& *end
!= '/' && *end
!= '\0') {
2675 if (end
> path
+ pathlen
) {
2676 // hmm, string wasn't null terminated
2681 if (is_package_name(ptr
, end
- ptr
)) {
2694 * Determine if a name is inappropriate for a searchfs query.
2695 * This list consists of /System currently.
2698 int vn_searchfs_inappropriate_name(const char *name
, int len
) {
2699 const char *bad_names
[] = { "System" };
2700 int bad_len
[] = { 6 };
2703 for(i
=0; i
< (int) (sizeof(bad_names
) / sizeof(bad_names
[0])); i
++) {
2704 if (len
== bad_len
[i
] && strncmp(name
, bad_names
[i
], strlen(bad_names
[i
]) + 1) == 0) {
2709 // if we get here, no name matched
2714 * Top level filesystem related information gathering.
2716 extern unsigned int vfs_nummntops
;
2719 vfs_sysctl(int *name
, u_int namelen
, user_addr_t oldp
, size_t *oldlenp
,
2720 user_addr_t newp
, size_t newlen
, proc_t p
)
2722 struct vfstable
*vfsp
;
2726 struct vfsconf vfsc
;
2728 if (namelen
> CTL_MAXNAME
) {
2732 /* All non VFS_GENERIC and in VFS_GENERIC,
2733 * VFS_MAXTYPENUM, VFS_CONF, VFS_SET_PACKAGE_EXTS
2734 * needs to have root priv to have modifiers.
2735 * For rest the userland_sysctl(CTLFLAG_ANYBODY) would cover.
2737 if ((newp
!= USER_ADDR_NULL
) && ((name
[0] != VFS_GENERIC
) ||
2738 ((name
[1] == VFS_MAXTYPENUM
) ||
2739 (name
[1] == VFS_CONF
) ||
2740 (name
[1] == VFS_SET_PACKAGE_EXTS
)))
2741 && (error
= suser(kauth_cred_get(), &p
->p_acflag
))) {
2745 * The VFS_NUMMNTOPS shouldn't be at name[0] since
2746 * is a VFS generic variable. So now we must check
2747 * namelen so we don't end up covering any UFS
2748 * variables (sinc UFS vfc_typenum is 1).
2750 * It should have been:
2751 * name[0]: VFS_GENERIC
2752 * name[1]: VFS_NUMMNTOPS
2754 if (namelen
== 1 && name
[0] == VFS_NUMMNTOPS
) {
2755 return (sysctl_rdint(oldp
, oldlenp
, newp
, vfs_nummntops
));
2758 /* all sysctl names at this level are at least name and field */
2760 return (EISDIR
); /* overloaded */
2761 if (name
[0] != VFS_GENERIC
) {
2764 for (vfsp
= vfsconf
; vfsp
; vfsp
= vfsp
->vfc_next
)
2765 if (vfsp
->vfc_typenum
== name
[0]) {
2766 vfsp
->vfc_refcount
++;
2769 mount_list_unlock();
2774 /* XXX current context proxy for proc p? */
2775 error
= ((*vfsp
->vfc_vfsops
->vfs_sysctl
)(&name
[1], namelen
- 1,
2776 oldp
, oldlenp
, newp
, newlen
,
2777 vfs_context_current()));
2780 vfsp
->vfc_refcount
--;
2781 mount_list_unlock();
2785 case VFS_MAXTYPENUM
:
2786 return (sysctl_rdint(oldp
, oldlenp
, newp
, maxvfsconf
));
2789 return (ENOTDIR
); /* overloaded */
2792 for (vfsp
= vfsconf
; vfsp
; vfsp
= vfsp
->vfc_next
)
2793 if (vfsp
->vfc_typenum
== name
[2])
2797 mount_list_unlock();
2801 vfsc
.vfc_reserved1
= 0;
2802 bcopy(vfsp
->vfc_name
, vfsc
.vfc_name
, sizeof(vfsc
.vfc_name
));
2803 vfsc
.vfc_typenum
= vfsp
->vfc_typenum
;
2804 vfsc
.vfc_refcount
= vfsp
->vfc_refcount
;
2805 vfsc
.vfc_flags
= vfsp
->vfc_flags
;
2806 vfsc
.vfc_reserved2
= 0;
2807 vfsc
.vfc_reserved3
= 0;
2809 mount_list_unlock();
2810 return (sysctl_rdstruct(oldp
, oldlenp
, newp
, &vfsc
,
2811 sizeof(struct vfsconf
)));
2813 case VFS_SET_PACKAGE_EXTS
:
2814 return set_package_extensions_table((user_addr_t
)((unsigned)name
[1]), name
[2], name
[3]);
2817 * We need to get back into the general MIB, so we need to re-prepend
2818 * CTL_VFS to our name and try userland_sysctl().
2821 usernamelen
= namelen
+ 1;
2822 MALLOC(username
, int *, usernamelen
* sizeof(*username
),
2824 bcopy(name
, username
+ 1, namelen
* sizeof(*name
));
2825 username
[0] = CTL_VFS
;
2826 error
= userland_sysctl(p
, username
, usernamelen
, oldp
,
2827 oldlenp
, newp
, newlen
, oldlenp
);
2828 FREE(username
, M_TEMP
);
2833 * Dump vnode list (via sysctl) - defunct
2834 * use "pstat" instead
2839 (__unused
struct sysctl_oid
*oidp
, __unused
void *arg1
, __unused
int arg2
, __unused
struct sysctl_req
*req
)
2844 SYSCTL_PROC(_kern
, KERN_VNODE
, vnode
,
2845 CTLTYPE_STRUCT
| CTLFLAG_RD
| CTLFLAG_MASKED
| CTLFLAG_LOCKED
,
2846 0, 0, sysctl_vnode
, "S,", "");
2850 * Check to see if a filesystem is mounted on a block device.
2853 vfs_mountedon(struct vnode
*vp
)
2859 if (vp
->v_specflags
& SI_MOUNTEDON
) {
2863 if (vp
->v_specflags
& SI_ALIASED
) {
2864 for (vq
= *vp
->v_hashchain
; vq
; vq
= vq
->v_specnext
) {
2865 if (vq
->v_rdev
!= vp
->v_rdev
||
2866 vq
->v_type
!= vp
->v_type
)
2868 if (vq
->v_specflags
& SI_MOUNTEDON
) {
2880 * Unmount all filesystems. The list is traversed in reverse order
2881 * of mounting to avoid dependencies.
2883 __private_extern__
void
2884 vfs_unmountall(void)
2890 * Since this only runs when rebooting, it is not interlocked.
2893 while(!TAILQ_EMPTY(&mountlist
)) {
2894 mp
= TAILQ_LAST(&mountlist
, mntlist
);
2895 mount_list_unlock();
2896 error
= dounmount(mp
, MNT_FORCE
, 0, vfs_context_current());
2897 if ((error
!= 0) && (error
!= EBUSY
)) {
2898 printf("unmount of %s failed (", mp
->mnt_vfsstat
.f_mntonname
);
2899 printf("%d)\n", error
);
2901 TAILQ_REMOVE(&mountlist
, mp
, mnt_list
);
2903 } else if (error
== EBUSY
) {
2904 /* If EBUSY is returned, the unmount was already in progress */
2905 printf("unmount of %p failed (", mp
);
2910 mount_list_unlock();
2915 * This routine is called from vnode_pager_deallocate out of the VM
2916 * The path to vnode_pager_deallocate can only be initiated by ubc_destroy_named
2917 * on a vnode that has a UBCINFO
2919 __private_extern__
void
2920 vnode_pager_vrele(vnode_t vp
)
2922 struct ubc_info
*uip
;
2924 vnode_lock_spin(vp
);
2926 vp
->v_lflag
&= ~VNAMED_UBC
;
2928 uip
= vp
->v_ubcinfo
;
2929 vp
->v_ubcinfo
= UBC_INFO_NULL
;
2933 ubc_info_deallocate(uip
);
2937 #include <sys/disk.h>
2939 u_int32_t rootunit
= (u_int32_t
)-1;
2942 vfs_init_io_attributes(vnode_t devvp
, mount_t mp
)
2945 off_t readblockcnt
= 0;
2946 off_t writeblockcnt
= 0;
2947 off_t readmaxcnt
= 0;
2948 off_t writemaxcnt
= 0;
2949 off_t readsegcnt
= 0;
2950 off_t writesegcnt
= 0;
2951 off_t readsegsize
= 0;
2952 off_t writesegsize
= 0;
2953 off_t alignment
= 0;
2954 off_t ioqueue_depth
= 0;
2958 vfs_context_t ctx
= vfs_context_current();
2963 VNOP_IOCTL(devvp
, DKIOCGETTHROTTLEMASK
, (caddr_t
)&mp
->mnt_throttle_mask
, 0, NULL
);
2965 * as a reasonable approximation, only use the lowest bit of the mask
2966 * to generate a disk unit number
2968 mp
->mnt_devbsdunit
= num_trailing_0(mp
->mnt_throttle_mask
);
2970 if (devvp
== rootvp
)
2971 rootunit
= mp
->mnt_devbsdunit
;
2973 if (mp
->mnt_devbsdunit
== rootunit
) {
2975 * this mount point exists on the same device as the root
2976 * partition, so it comes under the hard throttle control...
2977 * this is true even for the root mount point itself
2979 mp
->mnt_kern_flag
|= MNTK_ROOTDEV
;
2982 * force the spec device to re-cache
2983 * the underlying block size in case
2984 * the filesystem overrode the initial value
2986 set_fsblocksize(devvp
);
2989 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETBLOCKSIZE
,
2990 (caddr_t
)&blksize
, 0, ctx
)))
2993 mp
->mnt_devblocksize
= blksize
;
2996 * set the maximum possible I/O size
2997 * this may get clipped to a smaller value
2998 * based on which constraints are being advertised
2999 * and if those advertised constraints result in a smaller
3000 * limit for a given I/O
3002 mp
->mnt_maxreadcnt
= MAX_UPL_SIZE
* PAGE_SIZE
;
3003 mp
->mnt_maxwritecnt
= MAX_UPL_SIZE
* PAGE_SIZE
;
3005 if (VNOP_IOCTL(devvp
, DKIOCISVIRTUAL
, (caddr_t
)&isvirtual
, 0, ctx
) == 0) {
3007 mp
->mnt_kern_flag
|= MNTK_VIRTUALDEV
;
3009 if (VNOP_IOCTL(devvp
, DKIOCISSOLIDSTATE
, (caddr_t
)&isssd
, 0, ctx
) == 0) {
3011 mp
->mnt_kern_flag
|= MNTK_SSD
;
3013 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETFEATURES
,
3014 (caddr_t
)&features
, 0, ctx
)))
3017 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETMAXBLOCKCOUNTREAD
,
3018 (caddr_t
)&readblockcnt
, 0, ctx
)))
3021 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETMAXBLOCKCOUNTWRITE
,
3022 (caddr_t
)&writeblockcnt
, 0, ctx
)))
3025 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETMAXBYTECOUNTREAD
,
3026 (caddr_t
)&readmaxcnt
, 0, ctx
)))
3029 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETMAXBYTECOUNTWRITE
,
3030 (caddr_t
)&writemaxcnt
, 0, ctx
)))
3033 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETMAXSEGMENTCOUNTREAD
,
3034 (caddr_t
)&readsegcnt
, 0, ctx
)))
3037 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETMAXSEGMENTCOUNTWRITE
,
3038 (caddr_t
)&writesegcnt
, 0, ctx
)))
3041 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETMAXSEGMENTBYTECOUNTREAD
,
3042 (caddr_t
)&readsegsize
, 0, ctx
)))
3045 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETMAXSEGMENTBYTECOUNTWRITE
,
3046 (caddr_t
)&writesegsize
, 0, ctx
)))
3049 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETMINSEGMENTALIGNMENTBYTECOUNT
,
3050 (caddr_t
)&alignment
, 0, ctx
)))
3053 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETCOMMANDPOOLSIZE
,
3054 (caddr_t
)&ioqueue_depth
, 0, ctx
)))
3058 mp
->mnt_maxreadcnt
= (readmaxcnt
> UINT32_MAX
) ? UINT32_MAX
: readmaxcnt
;
3061 temp
= readblockcnt
* blksize
;
3062 temp
= (temp
> UINT32_MAX
) ? UINT32_MAX
: temp
;
3064 if (temp
< mp
->mnt_maxreadcnt
)
3065 mp
->mnt_maxreadcnt
= (u_int32_t
)temp
;
3069 mp
->mnt_maxwritecnt
= (writemaxcnt
> UINT32_MAX
) ? UINT32_MAX
: writemaxcnt
;
3071 if (writeblockcnt
) {
3072 temp
= writeblockcnt
* blksize
;
3073 temp
= (temp
> UINT32_MAX
) ? UINT32_MAX
: temp
;
3075 if (temp
< mp
->mnt_maxwritecnt
)
3076 mp
->mnt_maxwritecnt
= (u_int32_t
)temp
;
3080 temp
= (readsegcnt
> UINT16_MAX
) ? UINT16_MAX
: readsegcnt
;
3082 temp
= mp
->mnt_maxreadcnt
/ PAGE_SIZE
;
3084 if (temp
> UINT16_MAX
)
3087 mp
->mnt_segreadcnt
= (u_int16_t
)temp
;
3090 temp
= (writesegcnt
> UINT16_MAX
) ? UINT16_MAX
: writesegcnt
;
3092 temp
= mp
->mnt_maxwritecnt
/ PAGE_SIZE
;
3094 if (temp
> UINT16_MAX
)
3097 mp
->mnt_segwritecnt
= (u_int16_t
)temp
;
3100 temp
= (readsegsize
> UINT32_MAX
) ? UINT32_MAX
: readsegsize
;
3102 temp
= mp
->mnt_maxreadcnt
;
3103 mp
->mnt_maxsegreadsize
= (u_int32_t
)temp
;
3106 temp
= (writesegsize
> UINT32_MAX
) ? UINT32_MAX
: writesegsize
;
3108 temp
= mp
->mnt_maxwritecnt
;
3109 mp
->mnt_maxsegwritesize
= (u_int32_t
)temp
;
3112 temp
= (alignment
> PAGE_SIZE
) ? PAGE_MASK
: alignment
- 1;
3115 mp
->mnt_alignmentmask
= temp
;
3118 if (ioqueue_depth
> MNT_DEFAULT_IOQUEUE_DEPTH
)
3119 temp
= ioqueue_depth
;
3121 temp
= MNT_DEFAULT_IOQUEUE_DEPTH
;
3123 mp
->mnt_ioqueue_depth
= temp
;
3124 mp
->mnt_ioscale
= (mp
->mnt_ioqueue_depth
+ (MNT_DEFAULT_IOQUEUE_DEPTH
- 1)) / MNT_DEFAULT_IOQUEUE_DEPTH
;
3126 if (mp
->mnt_ioscale
> 1)
3127 printf("ioqueue_depth = %d, ioscale = %d\n", (int)mp
->mnt_ioqueue_depth
, (int)mp
->mnt_ioscale
);
3129 if (features
& DK_FEATURE_FORCE_UNIT_ACCESS
)
3130 mp
->mnt_ioflags
|= MNT_IOFLAGS_FUA_SUPPORTED
;
3132 if (features
& DK_FEATURE_UNMAP
)
3133 mp
->mnt_ioflags
|= MNT_IOFLAGS_UNMAP_SUPPORTED
;
3138 static struct klist fs_klist
;
3139 lck_grp_t
*fs_klist_lck_grp
;
3140 lck_mtx_t
*fs_klist_lock
;
3143 vfs_event_init(void)
3146 klist_init(&fs_klist
);
3147 fs_klist_lck_grp
= lck_grp_alloc_init("fs_klist", NULL
);
3148 fs_klist_lock
= lck_mtx_alloc_init(fs_klist_lck_grp
, NULL
);
3152 vfs_event_signal(fsid_t
*fsid
, u_int32_t event
, intptr_t data
)
3154 if (event
== VQ_DEAD
|| event
== VQ_NOTRESP
) {
3155 struct mount
*mp
= vfs_getvfs(fsid
);
3157 mount_lock_spin(mp
);
3159 mp
->mnt_kern_flag
&= ~MNT_LNOTRESP
; // Now responding
3161 mp
->mnt_kern_flag
|= MNT_LNOTRESP
; // Not responding
3166 lck_mtx_lock(fs_klist_lock
);
3167 KNOTE(&fs_klist
, event
);
3168 lck_mtx_unlock(fs_klist_lock
);
3172 * return the number of mounted filesystems.
3175 sysctl_vfs_getvfscnt(void)
3177 return(mount_getvfscnt());
3182 mount_getvfscnt(void)
3188 mount_list_unlock();
3196 mount_fillfsids(fsid_t
*fsidlst
, int count
)
3203 TAILQ_FOREACH(mp
, &mountlist
, mnt_list
) {
3204 if (actual
<= count
) {
3205 fsidlst
[actual
] = mp
->mnt_vfsstat
.f_fsid
;
3209 mount_list_unlock();
3215 * fill in the array of fsid_t's up to a max of 'count', the actual
3216 * number filled in will be set in '*actual'. If there are more fsid_t's
3217 * than room in fsidlst then ENOMEM will be returned and '*actual' will
3218 * have the actual count.
3219 * having *actual filled out even in the error case is depended upon.
3222 sysctl_vfs_getvfslist(fsid_t
*fsidlst
, int count
, int *actual
)
3228 TAILQ_FOREACH(mp
, &mountlist
, mnt_list
) {
3230 if (*actual
<= count
)
3231 fsidlst
[(*actual
) - 1] = mp
->mnt_vfsstat
.f_fsid
;
3233 mount_list_unlock();
3234 return (*actual
<= count
? 0 : ENOMEM
);
3238 sysctl_vfs_vfslist(__unused
struct sysctl_oid
*oidp
, __unused
void *arg1
,
3239 __unused
int arg2
, struct sysctl_req
*req
)
3245 /* This is a readonly node. */
3246 if (req
->newptr
!= USER_ADDR_NULL
)
3249 /* they are querying us so just return the space required. */
3250 if (req
->oldptr
== USER_ADDR_NULL
) {
3251 req
->oldidx
= sysctl_vfs_getvfscnt() * sizeof(fsid_t
);
3256 * Retrieve an accurate count of the amount of space required to copy
3257 * out all the fsids in the system.
3259 space
= req
->oldlen
;
3260 req
->oldlen
= sysctl_vfs_getvfscnt() * sizeof(fsid_t
);
3262 /* they didn't give us enough space. */
3263 if (space
< req
->oldlen
)
3266 MALLOC(fsidlst
, fsid_t
*, req
->oldlen
, M_TEMP
, M_WAITOK
);
3267 if (fsidlst
== NULL
) {
3271 error
= sysctl_vfs_getvfslist(fsidlst
, req
->oldlen
/ sizeof(fsid_t
),
3274 * If we get back ENOMEM, then another mount has been added while we
3275 * slept in malloc above. If this is the case then try again.
3277 if (error
== ENOMEM
) {
3278 FREE(fsidlst
, M_TEMP
);
3279 req
->oldlen
= space
;
3283 error
= SYSCTL_OUT(req
, fsidlst
, actual
* sizeof(fsid_t
));
3285 FREE(fsidlst
, M_TEMP
);
3290 * Do a sysctl by fsid.
3293 sysctl_vfs_ctlbyfsid(__unused
struct sysctl_oid
*oidp
, void *arg1
, int arg2
,
3294 struct sysctl_req
*req
)
3296 union union_vfsidctl vc
;
3298 struct vfsstatfs
*sp
;
3299 int *name
, flags
, namelen
;
3300 int error
=0, gotref
=0;
3301 vfs_context_t ctx
= vfs_context_current();
3302 proc_t p
= req
->p
; /* XXX req->p != current_proc()? */
3303 boolean_t is_64_bit
;
3307 is_64_bit
= proc_is64bit(p
);
3309 error
= SYSCTL_IN(req
, &vc
, is_64_bit
? sizeof(vc
.vc64
):sizeof(vc
.vc32
));
3312 if (vc
.vc32
.vc_vers
!= VFS_CTL_VERS1
) { /* works for 32 and 64 */
3316 mp
= mount_list_lookupby_fsid(&vc
.vc32
.vc_fsid
, 0, 1); /* works for 32 and 64 */
3322 /* reset so that the fs specific code can fetch it. */
3325 * Note if this is a VFS_CTL then we pass the actual sysctl req
3326 * in for "oldp" so that the lower layer can DTRT and use the
3327 * SYSCTL_IN/OUT routines.
3329 if (mp
->mnt_op
->vfs_sysctl
!= NULL
) {
3331 if (vfs_64bitready(mp
)) {
3332 error
= mp
->mnt_op
->vfs_sysctl(name
, namelen
,
3333 CAST_USER_ADDR_T(req
),
3334 NULL
, USER_ADDR_NULL
, 0,
3342 error
= mp
->mnt_op
->vfs_sysctl(name
, namelen
,
3343 CAST_USER_ADDR_T(req
),
3344 NULL
, USER_ADDR_NULL
, 0,
3347 if (error
!= ENOTSUP
) {
3352 case VFS_CTL_UMOUNT
:
3355 req
->newptr
= vc
.vc64
.vc_ptr
;
3356 req
->newlen
= (size_t)vc
.vc64
.vc_len
;
3359 req
->newptr
= CAST_USER_ADDR_T(vc
.vc32
.vc_ptr
);
3360 req
->newlen
= vc
.vc32
.vc_len
;
3362 error
= SYSCTL_IN(req
, &flags
, sizeof(flags
));
3369 /* safedounmount consumes a ref */
3370 error
= safedounmount(mp
, flags
, ctx
);
3372 case VFS_CTL_STATFS
:
3375 req
->newptr
= vc
.vc64
.vc_ptr
;
3376 req
->newlen
= (size_t)vc
.vc64
.vc_len
;
3379 req
->newptr
= CAST_USER_ADDR_T(vc
.vc32
.vc_ptr
);
3380 req
->newlen
= vc
.vc32
.vc_len
;
3382 error
= SYSCTL_IN(req
, &flags
, sizeof(flags
));
3385 sp
= &mp
->mnt_vfsstat
;
3386 if (((flags
& MNT_NOWAIT
) == 0 || (flags
& (MNT_WAIT
| MNT_DWAIT
))) &&
3387 (error
= vfs_update_vfsstat(mp
, ctx
, VFS_USER_EVENT
)))
3390 struct user64_statfs sfs
;
3391 bzero(&sfs
, sizeof(sfs
));
3392 sfs
.f_flags
= mp
->mnt_flag
& MNT_VISFLAGMASK
;
3393 sfs
.f_type
= mp
->mnt_vtable
->vfc_typenum
;
3394 sfs
.f_bsize
= (user64_long_t
)sp
->f_bsize
;
3395 sfs
.f_iosize
= (user64_long_t
)sp
->f_iosize
;
3396 sfs
.f_blocks
= (user64_long_t
)sp
->f_blocks
;
3397 sfs
.f_bfree
= (user64_long_t
)sp
->f_bfree
;
3398 sfs
.f_bavail
= (user64_long_t
)sp
->f_bavail
;
3399 sfs
.f_files
= (user64_long_t
)sp
->f_files
;
3400 sfs
.f_ffree
= (user64_long_t
)sp
->f_ffree
;
3401 sfs
.f_fsid
= sp
->f_fsid
;
3402 sfs
.f_owner
= sp
->f_owner
;
3404 if (mp
->mnt_kern_flag
& MNTK_TYPENAME_OVERRIDE
) {
3405 strlcpy(&sfs
.f_fstypename
[0], &mp
->fstypename_override
[0], MFSTYPENAMELEN
);
3407 strlcpy(sfs
.f_fstypename
, sp
->f_fstypename
, MFSNAMELEN
);
3409 strlcpy(sfs
.f_mntonname
, sp
->f_mntonname
, MNAMELEN
);
3410 strlcpy(sfs
.f_mntfromname
, sp
->f_mntfromname
, MNAMELEN
);
3412 error
= SYSCTL_OUT(req
, &sfs
, sizeof(sfs
));
3415 struct user32_statfs sfs
;
3416 bzero(&sfs
, sizeof(sfs
));
3417 sfs
.f_flags
= mp
->mnt_flag
& MNT_VISFLAGMASK
;
3418 sfs
.f_type
= mp
->mnt_vtable
->vfc_typenum
;
3421 * It's possible for there to be more than 2^^31 blocks in the filesystem, so we
3422 * have to fudge the numbers here in that case. We inflate the blocksize in order
3423 * to reflect the filesystem size as best we can.
3425 if (sp
->f_blocks
> INT_MAX
) {
3429 * Work out how far we have to shift the block count down to make it fit.
3430 * Note that it's possible to have to shift so far that the resulting
3431 * blocksize would be unreportably large. At that point, we will clip
3432 * any values that don't fit.
3434 * For safety's sake, we also ensure that f_iosize is never reported as
3435 * being smaller than f_bsize.
3437 for (shift
= 0; shift
< 32; shift
++) {
3438 if ((sp
->f_blocks
>> shift
) <= INT_MAX
)
3440 if ((((long long)sp
->f_bsize
) << (shift
+ 1)) > INT_MAX
)
3443 #define __SHIFT_OR_CLIP(x, s) ((((x) >> (s)) > INT_MAX) ? INT_MAX : ((x) >> (s)))
3444 sfs
.f_blocks
= (user32_long_t
)__SHIFT_OR_CLIP(sp
->f_blocks
, shift
);
3445 sfs
.f_bfree
= (user32_long_t
)__SHIFT_OR_CLIP(sp
->f_bfree
, shift
);
3446 sfs
.f_bavail
= (user32_long_t
)__SHIFT_OR_CLIP(sp
->f_bavail
, shift
);
3447 #undef __SHIFT_OR_CLIP
3448 sfs
.f_bsize
= (user32_long_t
)(sp
->f_bsize
<< shift
);
3449 sfs
.f_iosize
= lmax(sp
->f_iosize
, sp
->f_bsize
);
3451 sfs
.f_bsize
= (user32_long_t
)sp
->f_bsize
;
3452 sfs
.f_iosize
= (user32_long_t
)sp
->f_iosize
;
3453 sfs
.f_blocks
= (user32_long_t
)sp
->f_blocks
;
3454 sfs
.f_bfree
= (user32_long_t
)sp
->f_bfree
;
3455 sfs
.f_bavail
= (user32_long_t
)sp
->f_bavail
;
3457 sfs
.f_files
= (user32_long_t
)sp
->f_files
;
3458 sfs
.f_ffree
= (user32_long_t
)sp
->f_ffree
;
3459 sfs
.f_fsid
= sp
->f_fsid
;
3460 sfs
.f_owner
= sp
->f_owner
;
3462 if (mp
->mnt_kern_flag
& MNTK_TYPENAME_OVERRIDE
) {
3463 strlcpy(&sfs
.f_fstypename
[0], &mp
->fstypename_override
[0], MFSTYPENAMELEN
);
3465 strlcpy(sfs
.f_fstypename
, sp
->f_fstypename
, MFSNAMELEN
);
3467 strlcpy(sfs
.f_mntonname
, sp
->f_mntonname
, MNAMELEN
);
3468 strlcpy(sfs
.f_mntfromname
, sp
->f_mntfromname
, MNAMELEN
);
3470 error
= SYSCTL_OUT(req
, &sfs
, sizeof(sfs
));
3483 static int filt_fsattach(struct knote
*kn
);
3484 static void filt_fsdetach(struct knote
*kn
);
3485 static int filt_fsevent(struct knote
*kn
, long hint
);
3486 struct filterops fs_filtops
= {
3487 .f_attach
= filt_fsattach
,
3488 .f_detach
= filt_fsdetach
,
3489 .f_event
= filt_fsevent
,
3493 filt_fsattach(struct knote
*kn
)
3496 lck_mtx_lock(fs_klist_lock
);
3497 kn
->kn_flags
|= EV_CLEAR
;
3498 KNOTE_ATTACH(&fs_klist
, kn
);
3499 lck_mtx_unlock(fs_klist_lock
);
3504 filt_fsdetach(struct knote
*kn
)
3506 lck_mtx_lock(fs_klist_lock
);
3507 KNOTE_DETACH(&fs_klist
, kn
);
3508 lck_mtx_unlock(fs_klist_lock
);
3512 filt_fsevent(struct knote
*kn
, long hint
)
3515 * Backwards compatibility:
3516 * Other filters would do nothing if kn->kn_sfflags == 0
3519 if ((kn
->kn_sfflags
== 0) || (kn
->kn_sfflags
& hint
)) {
3520 kn
->kn_fflags
|= hint
;
3523 return (kn
->kn_fflags
!= 0);
3527 sysctl_vfs_noremotehang(__unused
struct sysctl_oid
*oidp
,
3528 __unused
void *arg1
, __unused
int arg2
, struct sysctl_req
*req
)
3534 /* We need a pid. */
3535 if (req
->newptr
== USER_ADDR_NULL
)
3538 error
= SYSCTL_IN(req
, &pid
, sizeof(pid
));
3542 p
= proc_find(pid
< 0 ? -pid
: pid
);
3547 * Fetching the value is ok, but we only fetch if the old
3550 if (req
->oldptr
!= USER_ADDR_NULL
) {
3551 out
= !((p
->p_flag
& P_NOREMOTEHANG
) == 0);
3553 error
= SYSCTL_OUT(req
, &out
, sizeof(out
));
3557 /* cansignal offers us enough security. */
3558 if (p
!= req
->p
&& proc_suser(req
->p
) != 0) {
3564 OSBitAndAtomic(~((uint32_t)P_NOREMOTEHANG
), &p
->p_flag
);
3566 OSBitOrAtomic(P_NOREMOTEHANG
, &p
->p_flag
);
3572 /* the vfs.generic. branch. */
3573 SYSCTL_NODE(_vfs
, VFS_GENERIC
, generic
, CTLFLAG_RW
| CTLFLAG_LOCKED
, NULL
, "vfs generic hinge");
3574 /* retreive a list of mounted filesystem fsid_t */
3575 SYSCTL_PROC(_vfs_generic
, OID_AUTO
, vfsidlist
, CTLFLAG_RD
| CTLFLAG_LOCKED
,
3576 NULL
, 0, sysctl_vfs_vfslist
, "S,fsid", "List of mounted filesystem ids");
3577 /* perform operations on filesystem via fsid_t */
3578 SYSCTL_NODE(_vfs_generic
, OID_AUTO
, ctlbyfsid
, CTLFLAG_RW
| CTLFLAG_LOCKED
,
3579 sysctl_vfs_ctlbyfsid
, "ctlbyfsid");
3580 SYSCTL_PROC(_vfs_generic
, OID_AUTO
, noremotehang
, CTLFLAG_RW
| CTLFLAG_ANYBODY
,
3581 NULL
, 0, sysctl_vfs_noremotehang
, "I", "noremotehang");
3584 long num_reusedvnodes
= 0;
3588 process_vp(vnode_t vp
, int want_vp
, int *deferred
)
3596 vnode_list_remove_locked(vp
);
3598 vnode_list_unlock();
3600 vnode_lock_spin(vp
);
3603 * We could wait for the vnode_lock after removing the vp from the freelist
3604 * and the vid is bumped only at the very end of reclaim. So it is possible
3605 * that we are looking at a vnode that is being terminated. If so skip it.
3607 if ((vpid
!= vp
->v_id
) || (vp
->v_usecount
!= 0) || (vp
->v_iocount
!= 0) ||
3608 VONLIST(vp
) || (vp
->v_lflag
& VL_TERMINATE
)) {
3610 * we lost the race between dropping the list lock
3611 * and picking up the vnode_lock... someone else
3612 * used this vnode and it is now in a new state
3618 if ( (vp
->v_lflag
& (VL_NEEDINACTIVE
| VL_MARKTERM
)) == VL_NEEDINACTIVE
) {
3620 * we did a vnode_rele_ext that asked for
3621 * us not to reenter the filesystem during
3622 * the release even though VL_NEEDINACTIVE was
3623 * set... we'll do it here by doing a
3624 * vnode_get/vnode_put
3626 * pick up an iocount so that we can call
3627 * vnode_put and drive the VNOP_INACTIVE...
3628 * vnode_put will either leave us off
3629 * the freelist if a new ref comes in,
3630 * or put us back on the end of the freelist
3631 * or recycle us if we were marked for termination...
3632 * so we'll just go grab a new candidate
3638 vnode_put_locked(vp
);
3644 * Checks for anyone racing us for recycle
3646 if (vp
->v_type
!= VBAD
) {
3647 if (want_vp
&& vnode_on_reliable_media(vp
) == FALSE
) {
3648 vnode_async_list_add(vp
);
3655 if (vp
->v_lflag
& VL_DEAD
)
3656 panic("new_vnode(%p): the vnode is VL_DEAD but not VBAD", vp
);
3658 vnode_lock_convert(vp
);
3659 (void)vnode_reclaim_internal(vp
, 1, want_vp
, 0);
3663 panic("new_vnode(%p): vp on list", vp
);
3664 if (vp
->v_usecount
|| vp
->v_iocount
|| vp
->v_kusecount
||
3665 (vp
->v_lflag
& (VNAMED_UBC
| VNAMED_MOUNT
| VNAMED_FSHASH
)))
3666 panic("new_vnode(%p): free vnode still referenced", vp
);
3667 if ((vp
->v_mntvnodes
.tqe_prev
!= 0) && (vp
->v_mntvnodes
.tqe_next
!= 0))
3668 panic("new_vnode(%p): vnode seems to be on mount list", vp
);
3669 if ( !LIST_EMPTY(&vp
->v_nclinks
) || !LIST_EMPTY(&vp
->v_ncchildren
))
3670 panic("new_vnode(%p): vnode still hooked into the name cache", vp
);
3682 async_work_continue(void)
3684 struct async_work_lst
*q
;
3688 q
= &vnode_async_work_list
;
3694 if ( TAILQ_EMPTY(q
) ) {
3695 assert_wait(q
, (THREAD_UNINT
));
3697 vnode_list_unlock();
3699 thread_block((thread_continue_t
)async_work_continue
);
3703 async_work_handled
++;
3705 vp
= TAILQ_FIRST(q
);
3707 vp
= process_vp(vp
, 0, &deferred
);
3710 panic("found VBAD vp (%p) on async queue", vp
);
3716 new_vnode(vnode_t
*vpp
)
3719 uint32_t retries
= 0, max_retries
= 100; /* retry incase of tablefull */
3720 int force_alloc
= 0, walk_count
= 0;
3721 boolean_t need_reliable_vp
= FALSE
;
3723 struct timeval initial_tv
;
3724 struct timeval current_tv
;
3725 proc_t curproc
= current_proc();
3727 initial_tv
.tv_sec
= 0;
3733 if (need_reliable_vp
== TRUE
)
3734 async_work_timed_out
++;
3736 if ((numvnodes
- deadvnodes
) < desiredvnodes
|| force_alloc
) {
3739 if ( !TAILQ_EMPTY(&vnode_dead_list
)) {
3741 * Can always reuse a dead one
3743 vp
= TAILQ_FIRST(&vnode_dead_list
);
3747 * no dead vnodes available... if we're under
3748 * the limit, we'll create a new vnode
3751 vnode_list_unlock();
3753 MALLOC_ZONE(vp
, struct vnode
*, sizeof(*vp
), M_VNODE
, M_WAITOK
);
3754 bzero((char *)vp
, sizeof(*vp
));
3755 VLISTNONE(vp
); /* avoid double queue removal */
3756 lck_mtx_init(&vp
->v_lock
, vnode_lck_grp
, vnode_lck_attr
);
3758 klist_init(&vp
->v_knotes
);
3760 vp
->v_id
= ts
.tv_nsec
;
3761 vp
->v_flag
= VSTANDARD
;
3764 if (mac_vnode_label_init_needed(vp
))
3765 mac_vnode_label_init(vp
);
3771 microuptime(¤t_tv
);
3773 #define MAX_WALK_COUNT 1000
3775 if ( !TAILQ_EMPTY(&vnode_rage_list
) &&
3776 (ragevnodes
>= rage_limit
||
3777 (current_tv
.tv_sec
- rage_tv
.tv_sec
) >= RAGE_TIME_LIMIT
)) {
3779 TAILQ_FOREACH(vp
, &vnode_rage_list
, v_freelist
) {
3780 if ( !(vp
->v_listflag
& VLIST_RAGE
))
3781 panic("new_vnode: vp (%p) on RAGE list not marked VLIST_RAGE", vp
);
3783 // if we're a dependency-capable process, skip vnodes that can
3784 // cause recycling deadlocks. (i.e. this process is diskimages
3785 // helper and the vnode is in a disk image). Querying the
3786 // mnt_kern_flag for the mount's virtual device status
3787 // is safer than checking the mnt_dependent_process, which
3788 // may not be updated if there are multiple devnode layers
3789 // in between the disk image and the final consumer.
3791 if ((curproc
->p_flag
& P_DEPENDENCY_CAPABLE
) == 0 || vp
->v_mount
== NULL
||
3792 (vp
->v_mount
->mnt_kern_flag
& MNTK_VIRTUALDEV
) == 0) {
3794 * if need_reliable_vp == TRUE, then we've already sent one or more
3795 * non-reliable vnodes to the async thread for processing and timed
3796 * out waiting for a dead vnode to show up. Use the MAX_WALK_COUNT
3797 * mechanism to first scan for a reliable vnode before forcing
3798 * a new vnode to be created
3800 if (need_reliable_vp
== FALSE
|| vnode_on_reliable_media(vp
) == TRUE
)
3804 // don't iterate more than MAX_WALK_COUNT vnodes to
3805 // avoid keeping the vnode list lock held for too long.
3807 if (walk_count
++ > MAX_WALK_COUNT
) {
3814 if (vp
== NULL
&& !TAILQ_EMPTY(&vnode_free_list
)) {
3816 * Pick the first vp for possible reuse
3819 TAILQ_FOREACH(vp
, &vnode_free_list
, v_freelist
) {
3821 // if we're a dependency-capable process, skip vnodes that can
3822 // cause recycling deadlocks. (i.e. this process is diskimages
3823 // helper and the vnode is in a disk image). Querying the
3824 // mnt_kern_flag for the mount's virtual device status
3825 // is safer than checking the mnt_dependent_process, which
3826 // may not be updated if there are multiple devnode layers
3827 // in between the disk image and the final consumer.
3829 if ((curproc
->p_flag
& P_DEPENDENCY_CAPABLE
) == 0 || vp
->v_mount
== NULL
||
3830 (vp
->v_mount
->mnt_kern_flag
& MNTK_VIRTUALDEV
) == 0) {
3832 * if need_reliable_vp == TRUE, then we've already sent one or more
3833 * non-reliable vnodes to the async thread for processing and timed
3834 * out waiting for a dead vnode to show up. Use the MAX_WALK_COUNT
3835 * mechanism to first scan for a reliable vnode before forcing
3836 * a new vnode to be created
3838 if (need_reliable_vp
== FALSE
|| vnode_on_reliable_media(vp
) == TRUE
)
3842 // don't iterate more than MAX_WALK_COUNT vnodes to
3843 // avoid keeping the vnode list lock held for too long.
3845 if (walk_count
++ > MAX_WALK_COUNT
) {
3853 // if we don't have a vnode and the walk_count is >= MAX_WALK_COUNT
3854 // then we're trying to create a vnode on behalf of a
3855 // process like diskimages-helper that has file systems
3856 // mounted on top of itself (and thus we can't reclaim
3857 // vnodes in the file systems on top of us). if we can't
3858 // find a vnode to reclaim then we'll just have to force
3861 if (vp
== NULL
&& walk_count
>= MAX_WALK_COUNT
) {
3863 vnode_list_unlock();
3869 * we've reached the system imposed maximum number of vnodes
3870 * but there isn't a single one available
3871 * wait a bit and then retry... if we can't get a vnode
3872 * after our target number of retries, than log a complaint
3874 if (++retries
<= max_retries
) {
3875 vnode_list_unlock();
3876 delay_for_interval(1, 1000 * 1000);
3880 vnode_list_unlock();
3882 log(LOG_EMERG
, "%d desired, %d numvnodes, "
3883 "%d free, %d dead, %d rage\n",
3884 desiredvnodes
, numvnodes
, freevnodes
, deadvnodes
, ragevnodes
);
3887 * Running out of vnodes tends to make a system unusable. Start killing
3888 * processes that jetsam knows are killable.
3890 if (memorystatus_kill_on_vnode_limit() == FALSE
) {
3892 * If jetsam can't find any more processes to kill and there
3893 * still aren't any free vnodes, panic. Hopefully we'll get a
3894 * panic log to tell us why we ran out.
3896 panic("vnode table is full\n");
3900 * Now that we've killed someone, wait a bit and continue looking
3901 * (with fewer retries before trying another kill).
3903 delay_for_interval(3, 1000 * 1000);
3913 if ((vp
= process_vp(vp
, 1, &deferred
)) == NULLVP
) {
3916 struct timeval elapsed_tv
;
3918 if (initial_tv
.tv_sec
== 0)
3919 microuptime(&initial_tv
);
3923 dead_vnode_waited
++;
3924 dead_vnode_wanted
++;
3927 * note that we're only going to explicitly wait 10ms
3928 * for a dead vnode to become available, since even if one
3929 * isn't available, a reliable vnode might now be available
3930 * at the head of the VRAGE or free lists... if so, we
3931 * can satisfy the new_vnode request with less latency then waiting
3932 * for the full 100ms duration we're ultimately willing to tolerate
3934 assert_wait_timeout((caddr_t
)&dead_vnode_wanted
, (THREAD_INTERRUPTIBLE
), 10000, NSEC_PER_USEC
);
3936 vnode_list_unlock();
3938 thread_block(THREAD_CONTINUE_NULL
);
3940 microuptime(&elapsed_tv
);
3942 timevalsub(&elapsed_tv
, &initial_tv
);
3943 elapsed_msecs
= elapsed_tv
.tv_sec
* 1000 + elapsed_tv
.tv_usec
/ 1000;
3945 if (elapsed_msecs
>= 100) {
3947 * we've waited long enough... 100ms is
3948 * somewhat arbitrary for this case, but the
3949 * normal worst case latency used for UI
3950 * interaction is 100ms, so I've chosen to
3953 * setting need_reliable_vp to TRUE
3954 * forces us to find a reliable vnode
3955 * that we can process synchronously, or
3956 * to create a new one if the scan for
3957 * a reliable one hits the scan limit
3959 need_reliable_vp
= TRUE
;
3964 OSAddAtomicLong(1, &num_reusedvnodes
);
3969 * We should never see VL_LABELWAIT or VL_LABEL here.
3970 * as those operations hold a reference.
3972 assert ((vp
->v_lflag
& VL_LABELWAIT
) != VL_LABELWAIT
);
3973 assert ((vp
->v_lflag
& VL_LABEL
) != VL_LABEL
);
3974 if (vp
->v_lflag
& VL_LABELED
) {
3975 vnode_lock_convert(vp
);
3976 mac_vnode_label_recycle(vp
);
3977 } else if (mac_vnode_label_init_needed(vp
)) {
3978 vnode_lock_convert(vp
);
3979 mac_vnode_label_init(vp
);
3986 vp
->v_writecount
= 0;
3987 vp
->v_references
= 0;
3988 vp
->v_iterblkflags
= 0;
3989 vp
->v_flag
= VSTANDARD
;
3990 /* vbad vnodes can point to dead_mountp */
3992 vp
->v_defer_reclaimlist
= (vnode_t
)0;
4003 vnode_lock(vnode_t vp
)
4005 lck_mtx_lock(&vp
->v_lock
);
4009 vnode_lock_spin(vnode_t vp
)
4011 lck_mtx_lock_spin(&vp
->v_lock
);
4015 vnode_unlock(vnode_t vp
)
4017 lck_mtx_unlock(&vp
->v_lock
);
4023 vnode_get(struct vnode
*vp
)
4027 vnode_lock_spin(vp
);
4028 retval
= vnode_get_locked(vp
);
4035 vnode_get_locked(struct vnode
*vp
)
4038 lck_mtx_assert(&vp
->v_lock
, LCK_MTX_ASSERT_OWNED
);
4040 if ((vp
->v_iocount
== 0) && (vp
->v_lflag
& (VL_TERMINATE
| VL_DEAD
))) {
4051 * vnode_getwithvid() cuts in line in front of a vnode drain (that is,
4052 * while the vnode is draining, but at no point after that) to prevent
4053 * deadlocks when getting vnodes from filesystem hashes while holding
4054 * resources that may prevent other iocounts from being released.
4057 vnode_getwithvid(vnode_t vp
, uint32_t vid
)
4059 return(vget_internal(vp
, vid
, ( VNODE_NODEAD
| VNODE_WITHID
| VNODE_DRAINO
)));
4063 * vnode_getwithvid_drainok() is like vnode_getwithvid(), but *does* block behind a vnode
4064 * drain; it exists for use in the VFS name cache, where we really do want to block behind
4065 * vnode drain to prevent holding off an unmount.
4068 vnode_getwithvid_drainok(vnode_t vp
, uint32_t vid
)
4070 return(vget_internal(vp
, vid
, ( VNODE_NODEAD
| VNODE_WITHID
)));
4074 vnode_getwithref(vnode_t vp
)
4076 return(vget_internal(vp
, 0, 0));
4080 __private_extern__
int
4081 vnode_getalways(vnode_t vp
)
4083 return(vget_internal(vp
, 0, VNODE_ALWAYS
));
4087 vnode_put(vnode_t vp
)
4091 vnode_lock_spin(vp
);
4092 retval
= vnode_put_locked(vp
);
4099 vnode_put_locked(vnode_t vp
)
4101 vfs_context_t ctx
= vfs_context_current(); /* hoist outside loop */
4104 lck_mtx_assert(&vp
->v_lock
, LCK_MTX_ASSERT_OWNED
);
4107 if (vp
->v_iocount
< 1)
4108 panic("vnode_put(%p): iocount < 1", vp
);
4110 if ((vp
->v_usecount
> 0) || (vp
->v_iocount
> 1)) {
4111 vnode_dropiocount(vp
);
4114 if ((vp
->v_lflag
& (VL_DEAD
| VL_NEEDINACTIVE
)) == VL_NEEDINACTIVE
) {
4116 vp
->v_lflag
&= ~VL_NEEDINACTIVE
;
4119 VNOP_INACTIVE(vp
, ctx
);
4121 vnode_lock_spin(vp
);
4123 * because we had to drop the vnode lock before calling
4124 * VNOP_INACTIVE, the state of this vnode may have changed...
4125 * we may pick up both VL_MARTERM and either
4126 * an iocount or a usecount while in the VNOP_INACTIVE call
4127 * we don't want to call vnode_reclaim_internal on a vnode
4128 * that has active references on it... so loop back around
4129 * and reevaluate the state
4133 vp
->v_lflag
&= ~VL_NEEDINACTIVE
;
4135 if ((vp
->v_lflag
& (VL_MARKTERM
| VL_TERMINATE
| VL_DEAD
)) == VL_MARKTERM
) {
4136 vnode_lock_convert(vp
);
4137 vnode_reclaim_internal(vp
, 1, 1, 0);
4139 vnode_dropiocount(vp
);
4145 /* is vnode_t in use by others? */
4147 vnode_isinuse(vnode_t vp
, int refcnt
)
4149 return(vnode_isinuse_locked(vp
, refcnt
, 0));
4154 vnode_isinuse_locked(vnode_t vp
, int refcnt
, int locked
)
4159 vnode_lock_spin(vp
);
4160 if ((vp
->v_type
!= VREG
) && ((vp
->v_usecount
- vp
->v_kusecount
) > refcnt
)) {
4164 if (vp
->v_type
== VREG
) {
4165 retval
= ubc_isinuse_locked(vp
, refcnt
, 1);
4175 /* resume vnode_t */
4177 vnode_resume(vnode_t vp
)
4179 if ((vp
->v_lflag
& VL_SUSPENDED
) && vp
->v_owner
== current_thread()) {
4181 vnode_lock_spin(vp
);
4182 vp
->v_lflag
&= ~VL_SUSPENDED
;
4186 wakeup(&vp
->v_iocount
);
4192 * Please do not use on more than one vnode at a time as it may
4194 * xxx should we explicity prevent this from happening?
4198 vnode_suspend(vnode_t vp
)
4200 if (vp
->v_lflag
& VL_SUSPENDED
) {
4204 vnode_lock_spin(vp
);
4207 * xxx is this sufficient to check if a vnode_drain is
4211 if (vp
->v_owner
== NULL
) {
4212 vp
->v_lflag
|= VL_SUSPENDED
;
4213 vp
->v_owner
= current_thread();
4221 * Release any blocked locking requests on the vnode.
4222 * Used for forced-unmounts.
4224 * XXX What about network filesystems?
4227 vnode_abort_advlocks(vnode_t vp
)
4229 if (vp
->v_flag
& VLOCKLOCAL
)
4230 lf_abort_advlocks(vp
);
4235 vnode_drain(vnode_t vp
)
4238 if (vp
->v_lflag
& VL_DRAIN
) {
4239 panic("vnode_drain: recursive drain");
4242 vp
->v_lflag
|= VL_DRAIN
;
4243 vp
->v_owner
= current_thread();
4245 while (vp
->v_iocount
> 1)
4246 msleep(&vp
->v_iocount
, &vp
->v_lock
, PVFS
, "vnode_drain", NULL
);
4248 vp
->v_lflag
&= ~VL_DRAIN
;
4255 * if the number of recent references via vnode_getwithvid or vnode_getwithref
4256 * exceeds this threshold, than 'UN-AGE' the vnode by removing it from
4257 * the LRU list if it's currently on it... once the iocount and usecount both drop
4258 * to 0, it will get put back on the end of the list, effectively making it younger
4259 * this allows us to keep actively referenced vnodes in the list without having
4260 * to constantly remove and add to the list each time a vnode w/o a usecount is
4261 * referenced which costs us taking and dropping a global lock twice.
4263 #define UNAGE_THRESHHOLD 25
4266 vnode_getiocount(vnode_t vp
, unsigned int vid
, int vflags
)
4268 int nodead
= vflags
& VNODE_NODEAD
;
4269 int nosusp
= vflags
& VNODE_NOSUSPEND
;
4270 int always
= vflags
& VNODE_ALWAYS
;
4271 int beatdrain
= vflags
& VNODE_DRAINO
;
4272 int withvid
= vflags
& VNODE_WITHID
;
4276 * if it is a dead vnode with deadfs
4278 if (nodead
&& (vp
->v_lflag
& VL_DEAD
) && ((vp
->v_type
== VBAD
) || (vp
->v_data
== 0))) {
4282 * will return VL_DEAD ones
4284 if ((vp
->v_lflag
& (VL_SUSPENDED
| VL_DRAIN
| VL_TERMINATE
)) == 0 ) {
4288 * if suspended vnodes are to be failed
4290 if (nosusp
&& (vp
->v_lflag
& VL_SUSPENDED
)) {
4294 * if you are the owner of drain/suspend/termination , can acquire iocount
4295 * check for VL_TERMINATE; it does not set owner
4297 if ((vp
->v_lflag
& (VL_DRAIN
| VL_SUSPENDED
| VL_TERMINATE
)) &&
4298 (vp
->v_owner
== current_thread())) {
4306 * If this vnode is getting drained, there are some cases where
4309 if (vp
->v_lflag
& VL_DRAIN
) {
4311 * In some situations, we want to get an iocount
4312 * even if the vnode is draining to prevent deadlock,
4313 * e.g. if we're in the filesystem, potentially holding
4314 * resources that could prevent other iocounts from
4320 * Don't block if the vnode's mount point is unmounting as
4321 * we may be the thread the unmount is itself waiting on
4322 * Only callers who pass in vids (at this point, we've already
4323 * handled nosusp and nodead) are expecting error returns
4324 * from this function, so only we can only return errors for
4325 * those. ENODEV is intended to inform callers that the call
4326 * failed because an unmount is in progress.
4328 if (withvid
&& (vp
->v_mount
) && vfs_isunmount(vp
->v_mount
))
4332 vnode_lock_convert(vp
);
4334 if (vp
->v_lflag
& VL_TERMINATE
) {
4335 vp
->v_lflag
|= VL_TERMWANT
;
4337 msleep(&vp
->v_lflag
, &vp
->v_lock
, PVFS
, "vnode getiocount", NULL
);
4339 msleep(&vp
->v_iocount
, &vp
->v_lock
, PVFS
, "vnode_getiocount", NULL
);
4341 if (withvid
&& vid
!= vp
->v_id
) {
4344 if (++vp
->v_references
>= UNAGE_THRESHHOLD
) {
4345 vp
->v_references
= 0;
4346 vnode_list_remove(vp
);
4356 vnode_dropiocount (vnode_t vp
)
4358 if (vp
->v_iocount
< 1)
4359 panic("vnode_dropiocount(%p): v_iocount < 1", vp
);
4365 if ((vp
->v_lflag
& (VL_DRAIN
| VL_SUSPENDED
)) && (vp
->v_iocount
<= 1))
4366 wakeup(&vp
->v_iocount
);
4371 vnode_reclaim(struct vnode
* vp
)
4373 vnode_reclaim_internal(vp
, 0, 0, 0);
4378 vnode_reclaim_internal(struct vnode
* vp
, int locked
, int reuse
, int flags
)
4385 if (vp
->v_lflag
& VL_TERMINATE
) {
4386 panic("vnode reclaim in progress");
4388 vp
->v_lflag
|= VL_TERMINATE
;
4390 vn_clearunionwait(vp
, 1);
4394 isfifo
= (vp
->v_type
== VFIFO
);
4396 if (vp
->v_type
!= VBAD
)
4397 vgone(vp
, flags
); /* clean and reclaim the vnode */
4400 * give the vnode a new identity so that vnode_getwithvid will fail
4401 * on any stale cache accesses...
4402 * grab the list_lock so that if we're in "new_vnode"
4403 * behind the list_lock trying to steal this vnode, the v_id is stable...
4404 * once new_vnode drops the list_lock, it will block trying to take
4405 * the vnode lock until we release it... at that point it will evaluate
4406 * whether the v_vid has changed
4407 * also need to make sure that the vnode isn't on a list where "new_vnode"
4408 * can find it after the v_id has been bumped until we are completely done
4409 * with the vnode (i.e. putting it back on a list has to be the very last
4410 * thing we do to this vnode... many of the callers of vnode_reclaim_internal
4411 * are holding an io_count on the vnode... they need to drop the io_count
4412 * BEFORE doing a vnode_list_add or make sure to hold the vnode lock until
4413 * they are completely done with the vnode
4417 vnode_list_remove_locked(vp
);
4420 vnode_list_unlock();
4423 struct fifoinfo
* fip
;
4425 fip
= vp
->v_fifoinfo
;
4426 vp
->v_fifoinfo
= NULL
;
4432 panic("vnode_reclaim_internal: cleaned vnode isn't");
4433 if (vp
->v_numoutput
)
4434 panic("vnode_reclaim_internal: clean vnode has pending I/O's");
4435 if (UBCINFOEXISTS(vp
))
4436 panic("vnode_reclaim_internal: ubcinfo not cleaned");
4438 panic("vnode_reclaim_internal: vparent not removed");
4440 panic("vnode_reclaim_internal: vname not removed");
4442 vp
->v_socket
= NULL
;
4444 vp
->v_lflag
&= ~VL_TERMINATE
;
4447 KNOTE(&vp
->v_knotes
, NOTE_REVOKE
);
4449 /* Make sure that when we reuse the vnode, no knotes left over */
4450 klist_init(&vp
->v_knotes
);
4452 if (vp
->v_lflag
& VL_TERMWANT
) {
4453 vp
->v_lflag
&= ~VL_TERMWANT
;
4454 wakeup(&vp
->v_lflag
);
4458 * make sure we get on the
4459 * dead list if appropriate
4468 * The following api creates a vnode and associates all the parameter specified in vnode_fsparam
4469 * structure and returns a vnode handle with a reference. device aliasing is handled here so checkalias
4470 * is obsoleted by this.
4473 vnode_create(uint32_t flavor
, uint32_t size
, void *data
, vnode_t
*vpp
)
4481 struct componentname
*cnp
;
4482 struct vnode_fsparam
*param
= (struct vnode_fsparam
*)data
;
4484 struct vnode_trigger_param
*tinfo
= NULL
;
4489 /* Do quick sanity check on the parameters. */
4490 if (param
->vnfs_vtype
== VBAD
) {
4495 if ((flavor
== VNCREATE_TRIGGER
) && (size
== VNCREATE_TRIGGER_SIZE
)) {
4496 tinfo
= (struct vnode_trigger_param
*)data
;
4498 /* Validate trigger vnode input */
4499 if ((param
->vnfs_vtype
!= VDIR
) ||
4500 (tinfo
->vnt_resolve_func
== NULL
) ||
4501 (tinfo
->vnt_flags
& ~VNT_VALID_MASK
)) {
4504 /* Fall through a normal create (params will be the same) */
4505 flavor
= VNCREATE_FLAVOR
;
4509 if ((flavor
!= VNCREATE_FLAVOR
) || (size
!= VCREATESIZE
))
4512 if ( (error
= new_vnode(&vp
)) )
4515 dvp
= param
->vnfs_dvp
;
4516 cnp
= param
->vnfs_cnp
;
4518 vp
->v_op
= param
->vnfs_vops
;
4519 vp
->v_type
= param
->vnfs_vtype
;
4520 vp
->v_data
= param
->vnfs_fsnode
;
4522 if (param
->vnfs_markroot
)
4523 vp
->v_flag
|= VROOT
;
4524 if (param
->vnfs_marksystem
)
4525 vp
->v_flag
|= VSYSTEM
;
4526 if (vp
->v_type
== VREG
) {
4527 error
= ubc_info_init_withsize(vp
, param
->vnfs_filesize
);
4533 vp
->v_op
= dead_vnodeop_p
;
4537 vp
->v_lflag
|= VL_DEAD
;
4549 * For trigger vnodes, attach trigger info to vnode
4551 if ((vp
->v_type
== VDIR
) && (tinfo
!= NULL
)) {
4553 * Note: has a side effect of incrementing trigger count on the
4554 * mount if successful, which we would need to undo on a
4555 * subsequent failure.
4560 error
= vnode_resolver_create(param
->vnfs_mp
, vp
, tinfo
, FALSE
);
4562 printf("vnode_create: vnode_resolver_create() err %d\n", error
);
4564 vp
->v_op
= dead_vnodeop_p
;
4568 vp
->v_lflag
|= VL_DEAD
;
4577 if (vp
->v_type
== VCHR
|| vp
->v_type
== VBLK
) {
4579 vp
->v_tag
= VT_DEVFS
; /* callers will reset if needed (bdevvp) */
4581 if ( (nvp
= checkalias(vp
, param
->vnfs_rdev
)) ) {
4583 * if checkalias returns a vnode, it will be locked
4585 * first get rid of the unneeded vnode we acquired
4588 vp
->v_op
= spec_vnodeop_p
;
4590 vp
->v_lflag
= VL_DEAD
;
4596 * switch to aliased vnode and finish
4602 vp
->v_op
= param
->vnfs_vops
;
4603 vp
->v_type
= param
->vnfs_vtype
;
4604 vp
->v_data
= param
->vnfs_fsnode
;
4607 insmntque(vp
, param
->vnfs_mp
);
4612 if (VCHR
== vp
->v_type
) {
4613 u_int maj
= major(vp
->v_rdev
);
4615 if (maj
< (u_int
)nchrdev
&& cdevsw
[maj
].d_type
== D_TTY
)
4616 vp
->v_flag
|= VISTTY
;
4620 if (vp
->v_type
== VFIFO
) {
4621 struct fifoinfo
*fip
;
4623 MALLOC(fip
, struct fifoinfo
*,
4624 sizeof(*fip
), M_TEMP
, M_WAITOK
);
4625 bzero(fip
, sizeof(struct fifoinfo
));
4626 vp
->v_fifoinfo
= fip
;
4628 /* The file systems must pass the address of the location where
4629 * they store the vnode pointer. When we add the vnode into the mount
4630 * list and name cache they become discoverable. So the file system node
4631 * must have the connection to vnode setup by then
4635 /* Add fs named reference. */
4636 if (param
->vnfs_flags
& VNFS_ADDFSREF
) {
4637 vp
->v_lflag
|= VNAMED_FSHASH
;
4639 if (param
->vnfs_mp
) {
4640 if (param
->vnfs_mp
->mnt_kern_flag
& MNTK_LOCK_LOCAL
)
4641 vp
->v_flag
|= VLOCKLOCAL
;
4643 if ((vp
->v_freelist
.tqe_prev
!= (struct vnode
**)0xdeadb))
4644 panic("insmntque: vp on the free list\n");
4647 * enter in mount vnode list
4649 insmntque(vp
, param
->vnfs_mp
);
4652 if (dvp
&& vnode_ref(dvp
) == 0) {
4656 if (dvp
&& ((param
->vnfs_flags
& (VNFS_NOCACHE
| VNFS_CANTCACHE
)) == 0)) {
4658 * enter into name cache
4659 * we've got the info to enter it into the name cache now
4660 * cache_enter_create will pick up an extra reference on
4661 * the name entered into the string cache
4663 vp
->v_name
= cache_enter_create(dvp
, vp
, cnp
);
4665 vp
->v_name
= vfs_addname(cnp
->cn_nameptr
, cnp
->cn_namelen
, cnp
->cn_hash
, 0);
4667 if ((cnp
->cn_flags
& UNIONCREATED
) == UNIONCREATED
)
4668 vp
->v_flag
|= VISUNION
;
4670 if ((param
->vnfs_flags
& VNFS_CANTCACHE
) == 0) {
4672 * this vnode is being created as cacheable in the name cache
4673 * this allows us to re-enter it in the cache
4675 vp
->v_flag
|= VNCACHEABLE
;
4677 ut
= get_bsdthread_info(current_thread());
4679 if ((current_proc()->p_lflag
& P_LRAGE_VNODES
) ||
4680 (ut
->uu_flag
& UT_RAGE_VNODES
)) {
4682 * process has indicated that it wants any
4683 * vnodes created on its behalf to be rapidly
4684 * aged to reduce the impact on the cached set
4687 vp
->v_flag
|= VRAGE
;
4693 vnode_addfsref(vnode_t vp
)
4695 vnode_lock_spin(vp
);
4696 if (vp
->v_lflag
& VNAMED_FSHASH
)
4697 panic("add_fsref: vp already has named reference");
4698 if ((vp
->v_freelist
.tqe_prev
!= (struct vnode
**)0xdeadb))
4699 panic("addfsref: vp on the free list\n");
4700 vp
->v_lflag
|= VNAMED_FSHASH
;
4706 vnode_removefsref(vnode_t vp
)
4708 vnode_lock_spin(vp
);
4709 if ((vp
->v_lflag
& VNAMED_FSHASH
) == 0)
4710 panic("remove_fsref: no named reference");
4711 vp
->v_lflag
&= ~VNAMED_FSHASH
;
4719 vfs_iterate(int flags
, int (*callout
)(mount_t
, void *), void *arg
)
4724 int count
, actualcount
, i
;
4726 int indx_start
, indx_stop
, indx_incr
;
4728 count
= mount_getvfscnt();
4731 fsid_list
= (fsid_t
*)kalloc(count
* sizeof(fsid_t
));
4732 allocmem
= (void *)fsid_list
;
4734 actualcount
= mount_fillfsids(fsid_list
, count
);
4737 * Establish the iteration direction
4738 * VFS_ITERATE_TAIL_FIRST overrides default head first order (oldest first)
4740 if (flags
& VFS_ITERATE_TAIL_FIRST
) {
4741 indx_start
= actualcount
- 1;
4744 } else /* Head first by default */ {
4746 indx_stop
= actualcount
;
4750 for (i
=indx_start
; i
!= indx_stop
; i
+= indx_incr
) {
4752 /* obtain the mount point with iteration reference */
4753 mp
= mount_list_lookupby_fsid(&fsid_list
[i
], 0, 1);
4755 if(mp
== (struct mount
*)0)
4758 if (mp
->mnt_lflag
& (MNT_LDEAD
| MNT_LUNMOUNT
)) {
4766 /* iterate over all the vnodes */
4767 ret
= callout(mp
, arg
);
4773 case VFS_RETURNED_DONE
:
4774 if (ret
== VFS_RETURNED_DONE
) {
4780 case VFS_CLAIMED_DONE
:
4791 kfree(allocmem
, (count
* sizeof(fsid_t
)));
4796 * Update the vfsstatfs structure in the mountpoint.
4797 * MAC: Parameter eventtype added, indicating whether the event that
4798 * triggered this update came from user space, via a system call
4799 * (VFS_USER_EVENT) or an internal kernel call (VFS_KERNEL_EVENT).
4802 vfs_update_vfsstat(mount_t mp
, vfs_context_t ctx
, __unused
int eventtype
)
4808 * Request the attributes we want to propagate into
4809 * the per-mount vfsstat structure.
4812 VFSATTR_WANTED(&va
, f_iosize
);
4813 VFSATTR_WANTED(&va
, f_blocks
);
4814 VFSATTR_WANTED(&va
, f_bfree
);
4815 VFSATTR_WANTED(&va
, f_bavail
);
4816 VFSATTR_WANTED(&va
, f_bused
);
4817 VFSATTR_WANTED(&va
, f_files
);
4818 VFSATTR_WANTED(&va
, f_ffree
);
4819 VFSATTR_WANTED(&va
, f_bsize
);
4820 VFSATTR_WANTED(&va
, f_fssubtype
);
4822 if (eventtype
== VFS_USER_EVENT
) {
4823 error
= mac_mount_check_getattr(ctx
, mp
, &va
);
4829 if ((error
= vfs_getattr(mp
, &va
, ctx
)) != 0) {
4830 KAUTH_DEBUG("STAT - filesystem returned error %d", error
);
4835 * Unpack into the per-mount structure.
4837 * We only overwrite these fields, which are likely to change:
4845 * And these which are not, but which the FS has no other way
4846 * of providing to us:
4852 if (VFSATTR_IS_SUPPORTED(&va
, f_bsize
)) {
4853 /* 4822056 - protect against malformed server mount */
4854 mp
->mnt_vfsstat
.f_bsize
= (va
.f_bsize
> 0 ? va
.f_bsize
: 512);
4856 mp
->mnt_vfsstat
.f_bsize
= mp
->mnt_devblocksize
; /* default from the device block size */
4858 if (VFSATTR_IS_SUPPORTED(&va
, f_iosize
)) {
4859 mp
->mnt_vfsstat
.f_iosize
= va
.f_iosize
;
4861 mp
->mnt_vfsstat
.f_iosize
= 1024 * 1024; /* 1MB sensible I/O size */
4863 if (VFSATTR_IS_SUPPORTED(&va
, f_blocks
))
4864 mp
->mnt_vfsstat
.f_blocks
= va
.f_blocks
;
4865 if (VFSATTR_IS_SUPPORTED(&va
, f_bfree
))
4866 mp
->mnt_vfsstat
.f_bfree
= va
.f_bfree
;
4867 if (VFSATTR_IS_SUPPORTED(&va
, f_bavail
))
4868 mp
->mnt_vfsstat
.f_bavail
= va
.f_bavail
;
4869 if (VFSATTR_IS_SUPPORTED(&va
, f_bused
))
4870 mp
->mnt_vfsstat
.f_bused
= va
.f_bused
;
4871 if (VFSATTR_IS_SUPPORTED(&va
, f_files
))
4872 mp
->mnt_vfsstat
.f_files
= va
.f_files
;
4873 if (VFSATTR_IS_SUPPORTED(&va
, f_ffree
))
4874 mp
->mnt_vfsstat
.f_ffree
= va
.f_ffree
;
4876 /* this is unlikely to change, but has to be queried for */
4877 if (VFSATTR_IS_SUPPORTED(&va
, f_fssubtype
))
4878 mp
->mnt_vfsstat
.f_fssubtype
= va
.f_fssubtype
;
4884 mount_list_add(mount_t mp
)
4889 if (system_inshutdown
!= 0) {
4892 TAILQ_INSERT_TAIL(&mountlist
, mp
, mnt_list
);
4896 mount_list_unlock();
4902 mount_list_remove(mount_t mp
)
4905 TAILQ_REMOVE(&mountlist
, mp
, mnt_list
);
4907 mp
->mnt_list
.tqe_next
= NULL
;
4908 mp
->mnt_list
.tqe_prev
= NULL
;
4909 mount_list_unlock();
4913 mount_lookupby_volfsid(int volfs_id
, int withref
)
4915 mount_t cur_mount
= (mount_t
)0;
4919 TAILQ_FOREACH(mp
, &mountlist
, mnt_list
) {
4920 if (!(mp
->mnt_kern_flag
& MNTK_UNMOUNT
) &&
4921 (mp
->mnt_kern_flag
& MNTK_PATH_FROM_ID
) &&
4922 (mp
->mnt_vfsstat
.f_fsid
.val
[0] == volfs_id
)) {
4925 if (mount_iterref(cur_mount
, 1)) {
4926 cur_mount
= (mount_t
)0;
4927 mount_list_unlock();
4934 mount_list_unlock();
4935 if (withref
&& (cur_mount
!= (mount_t
)0)) {
4937 if (vfs_busy(mp
, LK_NOWAIT
) != 0) {
4938 cur_mount
= (mount_t
)0;
4947 mount_list_lookupby_fsid(fsid_t
*fsid
, int locked
, int withref
)
4949 mount_t retmp
= (mount_t
)0;
4954 TAILQ_FOREACH(mp
, &mountlist
, mnt_list
)
4955 if (mp
->mnt_vfsstat
.f_fsid
.val
[0] == fsid
->val
[0] &&
4956 mp
->mnt_vfsstat
.f_fsid
.val
[1] == fsid
->val
[1]) {
4959 if (mount_iterref(retmp
, 1))
4966 mount_list_unlock();
4971 vnode_lookup(const char *path
, int flags
, vnode_t
*vpp
, vfs_context_t ctx
)
4973 struct nameidata nd
;
4975 u_int32_t ndflags
= 0;
4977 if (ctx
== NULL
) { /* XXX technically an error */
4978 ctx
= vfs_context_current();
4981 if (flags
& VNODE_LOOKUP_NOFOLLOW
)
4986 if (flags
& VNODE_LOOKUP_NOCROSSMOUNT
)
4987 ndflags
|= NOCROSSMOUNT
;
4988 if (flags
& VNODE_LOOKUP_DOWHITEOUT
)
4989 ndflags
|= DOWHITEOUT
;
4991 /* XXX AUDITVNPATH1 needed ? */
4992 NDINIT(&nd
, LOOKUP
, OP_LOOKUP
, ndflags
, UIO_SYSSPACE
,
4993 CAST_USER_ADDR_T(path
), ctx
);
4995 if ((error
= namei(&nd
)))
5004 vnode_open(const char *path
, int fmode
, int cmode
, int flags
, vnode_t
*vpp
, vfs_context_t ctx
)
5006 struct nameidata nd
;
5008 u_int32_t ndflags
= 0;
5011 if (ctx
== NULL
) { /* XXX technically an error */
5012 ctx
= vfs_context_current();
5015 if (fmode
& O_NOFOLLOW
)
5016 lflags
|= VNODE_LOOKUP_NOFOLLOW
;
5018 if (lflags
& VNODE_LOOKUP_NOFOLLOW
)
5023 if (lflags
& VNODE_LOOKUP_NOCROSSMOUNT
)
5024 ndflags
|= NOCROSSMOUNT
;
5025 if (lflags
& VNODE_LOOKUP_DOWHITEOUT
)
5026 ndflags
|= DOWHITEOUT
;
5028 /* XXX AUDITVNPATH1 needed ? */
5029 NDINIT(&nd
, LOOKUP
, OP_OPEN
, ndflags
, UIO_SYSSPACE
,
5030 CAST_USER_ADDR_T(path
), ctx
);
5032 if ((error
= vn_open(&nd
, fmode
, cmode
)))
5041 vnode_close(vnode_t vp
, int flags
, vfs_context_t ctx
)
5046 ctx
= vfs_context_current();
5049 error
= vn_close(vp
, flags
, ctx
);
5055 vnode_mtime(vnode_t vp
, struct timespec
*mtime
, vfs_context_t ctx
)
5057 struct vnode_attr va
;
5061 VATTR_WANTED(&va
, va_modify_time
);
5062 error
= vnode_getattr(vp
, &va
, ctx
);
5064 *mtime
= va
.va_modify_time
;
5069 * Returns: 0 Success
5073 vnode_size(vnode_t vp
, off_t
*sizep
, vfs_context_t ctx
)
5075 struct vnode_attr va
;
5079 VATTR_WANTED(&va
, va_data_size
);
5080 error
= vnode_getattr(vp
, &va
, ctx
);
5082 *sizep
= va
.va_data_size
;
5087 vnode_setsize(vnode_t vp
, off_t size
, int ioflag
, vfs_context_t ctx
)
5089 struct vnode_attr va
;
5092 VATTR_SET(&va
, va_data_size
, size
);
5093 va
.va_vaflags
= ioflag
& 0xffff;
5094 return(vnode_setattr(vp
, &va
, ctx
));
5098 vn_create_reg(vnode_t dvp
, vnode_t
*vpp
, struct nameidata
*ndp
, struct vnode_attr
*vap
, uint32_t flags
, int fmode
, uint32_t *statusp
, vfs_context_t ctx
)
5100 /* Only use compound VNOP for compound operation */
5101 if (vnode_compound_open_available(dvp
) && ((flags
& VN_CREATE_DOOPEN
) != 0)) {
5103 return VNOP_COMPOUND_OPEN(dvp
, vpp
, ndp
, VNOP_COMPOUND_OPEN_DO_CREATE
, fmode
, statusp
, vap
, ctx
);
5105 return VNOP_CREATE(dvp
, vpp
, &ndp
->ni_cnd
, vap
, ctx
);
5110 * Create a filesystem object of arbitrary type with arbitrary attributes in
5111 * the spevied directory with the specified name.
5113 * Parameters: dvp Pointer to the vnode of the directory
5114 * in which to create the object.
5115 * vpp Pointer to the area into which to
5116 * return the vnode of the created object.
5117 * cnp Component name pointer from the namei
5118 * data structure, containing the name to
5119 * use for the create object.
5120 * vap Pointer to the vnode_attr structure
5121 * describing the object to be created,
5122 * including the type of object.
5123 * flags VN_* flags controlling ACL inheritance
5124 * and whether or not authorization is to
5125 * be required for the operation.
5127 * Returns: 0 Success
5130 * Implicit: *vpp Contains the vnode of the object that
5131 * was created, if successful.
5132 * *cnp May be modified by the underlying VFS.
5133 * *vap May be modified by the underlying VFS.
5134 * modified by either ACL inheritance or
5137 * be modified, even if the operation is
5140 * Notes: The kauth_filesec_t in 'vap', if any, is in host byte order.
5142 * Modification of '*cnp' and '*vap' by the underlying VFS is
5143 * strongly discouraged.
5145 * XXX: This function is a 'vn_*' function; it belongs in vfs_vnops.c
5147 * XXX: We should enummerate the possible errno values here, and where
5148 * in the code they originated.
5151 vn_create(vnode_t dvp
, vnode_t
*vpp
, struct nameidata
*ndp
, struct vnode_attr
*vap
, uint32_t flags
, int fmode
, uint32_t *statusp
, vfs_context_t ctx
)
5153 errno_t error
, old_error
;
5154 vnode_t vp
= (vnode_t
)0;
5156 struct componentname
*cnp
;
5161 batched
= namei_compound_available(dvp
, ndp
) ? TRUE
: FALSE
;
5163 KAUTH_DEBUG("%p CREATE - '%s'", dvp
, cnp
->cn_nameptr
);
5165 if (flags
& VN_CREATE_NOINHERIT
)
5166 vap
->va_vaflags
|= VA_NOINHERIT
;
5167 if (flags
& VN_CREATE_NOAUTH
)
5168 vap
->va_vaflags
|= VA_NOAUTH
;
5170 * Handle ACL inheritance, initialize vap.
5172 error
= vn_attribute_prepare(dvp
, vap
, &defaulted
, ctx
);
5177 if (vap
->va_type
!= VREG
&& (fmode
!= 0 || (flags
& VN_CREATE_DOOPEN
) || statusp
)) {
5178 panic("Open parameters, but not a regular file.");
5180 if ((fmode
!= 0) && ((flags
& VN_CREATE_DOOPEN
) == 0)) {
5181 panic("Mode for open, but not trying to open...");
5185 * Create the requested node.
5187 switch(vap
->va_type
) {
5189 error
= vn_create_reg(dvp
, vpp
, ndp
, vap
, flags
, fmode
, statusp
, ctx
);
5192 error
= vn_mkdir(dvp
, vpp
, ndp
, vap
, ctx
);
5198 error
= VNOP_MKNOD(dvp
, vpp
, cnp
, vap
, ctx
);
5201 panic("vnode_create: unknown vtype %d", vap
->va_type
);
5204 KAUTH_DEBUG("%p CREATE - error %d returned by filesystem", dvp
, error
);
5212 if (!(flags
& VN_CREATE_NOLABEL
)) {
5213 error
= vnode_label(vnode_mount(vp
), dvp
, vp
, cnp
, VNODE_LABEL_CREATE
, ctx
);
5220 * If some of the requested attributes weren't handled by the VNOP,
5221 * use our fallback code.
5223 if (!VATTR_ALL_SUPPORTED(vap
) && *vpp
) {
5224 KAUTH_DEBUG(" CREATE - doing fallback with ACL %p", vap
->va_acl
);
5225 error
= vnode_setattr_fallback(*vpp
, vap
, ctx
);
5230 if ((error
!= 0) && (vp
!= (vnode_t
)0)) {
5232 /* If we've done a compound open, close */
5233 if (batched
&& (old_error
== 0) && (vap
->va_type
== VREG
)) {
5234 VNOP_CLOSE(vp
, fmode
, ctx
);
5237 /* Need to provide notifications if a create succeeded */
5245 vn_attribute_cleanup(vap
, defaulted
);
5250 static kauth_scope_t vnode_scope
;
5251 static int vnode_authorize_callback(kauth_cred_t credential
, void *idata
, kauth_action_t action
,
5252 uintptr_t arg0
, uintptr_t arg1
, uintptr_t arg2
, uintptr_t arg3
);
5253 static int vnode_authorize_callback_int(__unused kauth_cred_t credential
, __unused
void *idata
, kauth_action_t action
,
5254 uintptr_t arg0
, uintptr_t arg1
, uintptr_t arg2
, uintptr_t arg3
);
5256 typedef struct _vnode_authorize_context
{
5258 struct vnode_attr
*vap
;
5260 struct vnode_attr
*dvap
;
5264 #define _VAC_IS_OWNER (1<<0)
5265 #define _VAC_IN_GROUP (1<<1)
5266 #define _VAC_IS_DIR_OWNER (1<<2)
5267 #define _VAC_IN_DIR_GROUP (1<<3)
5271 vnode_authorize_init(void)
5273 vnode_scope
= kauth_register_scope(KAUTH_SCOPE_VNODE
, vnode_authorize_callback
, NULL
);
5276 #define VATTR_PREPARE_DEFAULTED_UID 0x1
5277 #define VATTR_PREPARE_DEFAULTED_GID 0x2
5278 #define VATTR_PREPARE_DEFAULTED_MODE 0x4
5281 vn_attribute_prepare(vnode_t dvp
, struct vnode_attr
*vap
, uint32_t *defaulted_fieldsp
, vfs_context_t ctx
)
5283 kauth_acl_t nacl
= NULL
, oacl
= NULL
;
5287 * Handle ACL inheritance.
5289 if (!(vap
->va_vaflags
& VA_NOINHERIT
) && vfs_extendedsecurity(dvp
->v_mount
)) {
5290 /* save the original filesec */
5291 if (VATTR_IS_ACTIVE(vap
, va_acl
)) {
5296 if ((error
= kauth_acl_inherit(dvp
,
5299 vap
->va_type
== VDIR
,
5301 KAUTH_DEBUG("%p CREATE - error %d processing inheritance", dvp
, error
);
5306 * If the generated ACL is NULL, then we can save ourselves some effort
5307 * by clearing the active bit.
5310 VATTR_CLEAR_ACTIVE(vap
, va_acl
);
5312 vap
->va_base_acl
= oacl
;
5313 VATTR_SET(vap
, va_acl
, nacl
);
5317 error
= vnode_authattr_new_internal(dvp
, vap
, (vap
->va_vaflags
& VA_NOAUTH
), defaulted_fieldsp
, ctx
);
5319 vn_attribute_cleanup(vap
, *defaulted_fieldsp
);
5326 vn_attribute_cleanup(struct vnode_attr
*vap
, uint32_t defaulted_fields
)
5329 * If the caller supplied a filesec in vap, it has been replaced
5330 * now by the post-inheritance copy. We need to put the original back
5331 * and free the inherited product.
5333 kauth_acl_t nacl
, oacl
;
5335 if (VATTR_IS_ACTIVE(vap
, va_acl
)) {
5337 oacl
= vap
->va_base_acl
;
5340 VATTR_SET(vap
, va_acl
, oacl
);
5341 vap
->va_base_acl
= NULL
;
5343 VATTR_CLEAR_ACTIVE(vap
, va_acl
);
5347 kauth_acl_free(nacl
);
5351 if ((defaulted_fields
& VATTR_PREPARE_DEFAULTED_MODE
) != 0) {
5352 VATTR_CLEAR_ACTIVE(vap
, va_mode
);
5354 if ((defaulted_fields
& VATTR_PREPARE_DEFAULTED_GID
) != 0) {
5355 VATTR_CLEAR_ACTIVE(vap
, va_gid
);
5357 if ((defaulted_fields
& VATTR_PREPARE_DEFAULTED_UID
) != 0) {
5358 VATTR_CLEAR_ACTIVE(vap
, va_uid
);
5365 vn_authorize_unlink(vnode_t dvp
, vnode_t vp
, struct componentname
*cnp
, vfs_context_t ctx
, __unused
void *reserved
)
5373 * Normally, unlinking of directories is not supported.
5374 * However, some file systems may have limited support.
5376 if ((vp
->v_type
== VDIR
) &&
5377 !(vp
->v_mount
->mnt_vtable
->vfc_vfsflags
& VFC_VFSDIRLINKS
)) {
5378 return (EPERM
); /* POSIX */
5381 /* authorize the delete operation */
5384 error
= mac_vnode_check_unlink(ctx
, dvp
, vp
, cnp
);
5387 error
= vnode_authorize(vp
, dvp
, KAUTH_VNODE_DELETE
, ctx
);
5393 vn_authorize_open_existing(vnode_t vp
, struct componentname
*cnp
, int fmode
, vfs_context_t ctx
, void *reserved
)
5395 /* Open of existing case */
5396 kauth_action_t action
;
5398 if (cnp
->cn_ndp
== NULL
) {
5401 if (reserved
!= NULL
) {
5402 panic("reserved not NULL.");
5406 /* XXX may do duplicate work here, but ignore that for now (idempotent) */
5407 if (vfs_flags(vnode_mount(vp
)) & MNT_MULTILABEL
) {
5408 error
= vnode_label(vnode_mount(vp
), NULL
, vp
, NULL
, 0, ctx
);
5414 if ( (fmode
& O_DIRECTORY
) && vp
->v_type
!= VDIR
) {
5418 if (vp
->v_type
== VSOCK
&& vp
->v_tag
!= VT_FDESC
) {
5419 return (EOPNOTSUPP
); /* Operation not supported on socket */
5422 if (vp
->v_type
== VLNK
&& (fmode
& O_NOFOLLOW
) != 0) {
5423 return (ELOOP
); /* O_NOFOLLOW was specified and the target is a symbolic link */
5426 /* disallow write operations on directories */
5427 if (vnode_isdir(vp
) && (fmode
& (FWRITE
| O_TRUNC
))) {
5431 if ((cnp
->cn_ndp
->ni_flag
& NAMEI_TRAILINGSLASH
)) {
5432 if (vp
->v_type
!= VDIR
) {
5438 /* If a file being opened is a shadow file containing
5439 * namedstream data, ignore the macf checks because it
5440 * is a kernel internal file and access should always
5443 if (!(vnode_isshadow(vp
) && vnode_isnamedstream(vp
))) {
5444 error
= mac_vnode_check_open(ctx
, vp
, fmode
);
5451 /* compute action to be authorized */
5453 if (fmode
& FREAD
) {
5454 action
|= KAUTH_VNODE_READ_DATA
;
5456 if (fmode
& (FWRITE
| O_TRUNC
)) {
5458 * If we are writing, appending, and not truncating,
5459 * indicate that we are appending so that if the
5460 * UF_APPEND or SF_APPEND bits are set, we do not deny
5463 if ((fmode
& O_APPEND
) && !(fmode
& O_TRUNC
)) {
5464 action
|= KAUTH_VNODE_APPEND_DATA
;
5466 action
|= KAUTH_VNODE_WRITE_DATA
;
5469 error
= vnode_authorize(vp
, NULL
, action
, ctx
);
5471 if (error
== EACCES
) {
5473 * Shadow files may exist on-disk with a different UID/GID
5474 * than that of the current context. Verify that this file
5475 * is really a shadow file. If it was created successfully
5476 * then it should be authorized.
5478 if (vnode_isshadow(vp
) && vnode_isnamedstream (vp
)) {
5479 error
= vnode_verifynamedstream(vp
);
5488 vn_authorize_create(vnode_t dvp
, struct componentname
*cnp
, struct vnode_attr
*vap
, vfs_context_t ctx
, void *reserved
)
5496 if (cnp
->cn_ndp
== NULL
) {
5497 panic("NULL cn_ndp");
5499 if (reserved
!= NULL
) {
5500 panic("reserved not NULL.");
5503 /* Only validate path for creation if we didn't do a complete lookup */
5504 if (cnp
->cn_ndp
->ni_flag
& NAMEI_UNFINISHED
) {
5505 error
= lookup_validate_creation_path(cnp
->cn_ndp
);
5511 error
= mac_vnode_check_create(ctx
, dvp
, cnp
, vap
);
5514 #endif /* CONFIG_MACF */
5516 return (vnode_authorize(dvp
, NULL
, KAUTH_VNODE_ADD_FILE
, ctx
));
5520 vn_authorize_rename(struct vnode
*fdvp
, struct vnode
*fvp
, struct componentname
*fcnp
,
5521 struct vnode
*tdvp
, struct vnode
*tvp
, struct componentname
*tcnp
,
5522 vfs_context_t ctx
, void *reserved
)
5527 if (reserved
!= NULL
) {
5528 panic("Passed something other than NULL as reserved field!");
5532 * Avoid renaming "." and "..".
5534 * XXX No need to check for this in the FS. We should always have the leaves
5535 * in VFS in this case.
5537 if (fvp
->v_type
== VDIR
&&
5539 (fcnp
->cn_namelen
== 1 && fcnp
->cn_nameptr
[0] == '.') ||
5540 ((fcnp
->cn_flags
| tcnp
->cn_flags
) & ISDOTDOT
)) ) {
5545 if (tvp
== NULLVP
&& vnode_compound_rename_available(tdvp
)) {
5546 error
= lookup_validate_creation_path(tcnp
->cn_ndp
);
5551 /***** <MACF> *****/
5553 error
= mac_vnode_check_rename_from(ctx
, fdvp
, fvp
, fcnp
);
5559 error
= mac_vnode_check_rename_to(ctx
,
5560 tdvp
, tvp
, fdvp
== tdvp
, tcnp
);
5564 /***** </MACF> *****/
5566 /***** <MiscChecks> *****/
5568 if (fvp
->v_type
== VDIR
&& tvp
->v_type
!= VDIR
) {
5571 } else if (fvp
->v_type
!= VDIR
&& tvp
->v_type
== VDIR
) {
5583 * The following edge case is caught here:
5584 * (to cannot be a descendent of from)
5597 if (tdvp
->v_parent
== fvp
) {
5601 /***** </MiscChecks> *****/
5603 /***** <Kauth> *****/
5606 if ((tvp
!= NULL
) && vnode_isdir(tvp
)) {
5609 } else if (tdvp
!= fdvp
) {
5615 * must have delete rights to remove the old name even in
5616 * the simple case of fdvp == tdvp.
5618 * If fvp is a directory, and we are changing it's parent,
5619 * then we also need rights to rewrite its ".." entry as well.
5621 if (vnode_isdir(fvp
)) {
5622 if ((error
= vnode_authorize(fvp
, fdvp
, KAUTH_VNODE_DELETE
| KAUTH_VNODE_ADD_SUBDIRECTORY
, ctx
)) != 0)
5625 if ((error
= vnode_authorize(fvp
, fdvp
, KAUTH_VNODE_DELETE
, ctx
)) != 0)
5629 /* moving into tdvp or tvp, must have rights to add */
5630 if ((error
= vnode_authorize(((tvp
!= NULL
) && vnode_isdir(tvp
)) ? tvp
: tdvp
,
5632 vnode_isdir(fvp
) ? KAUTH_VNODE_ADD_SUBDIRECTORY
: KAUTH_VNODE_ADD_FILE
,
5637 /* node staying in same directory, must be allowed to add new name */
5638 if ((error
= vnode_authorize(fdvp
, NULL
,
5639 vnode_isdir(fvp
) ? KAUTH_VNODE_ADD_SUBDIRECTORY
: KAUTH_VNODE_ADD_FILE
, ctx
)) != 0)
5642 /* overwriting tvp */
5643 if ((tvp
!= NULL
) && !vnode_isdir(tvp
) &&
5644 ((error
= vnode_authorize(tvp
, tdvp
, KAUTH_VNODE_DELETE
, ctx
)) != 0)) {
5648 /***** </Kauth> *****/
5650 /* XXX more checks? */
5656 vn_authorize_mkdir(vnode_t dvp
, struct componentname
*cnp
, struct vnode_attr
*vap
, vfs_context_t ctx
, void *reserved
)
5663 if (reserved
!= NULL
) {
5664 panic("reserved not NULL in vn_authorize_mkdir()");
5667 /* XXX A hack for now, to make shadow files work */
5668 if (cnp
->cn_ndp
== NULL
) {
5672 if (vnode_compound_mkdir_available(dvp
)) {
5673 error
= lookup_validate_creation_path(cnp
->cn_ndp
);
5679 error
= mac_vnode_check_create(ctx
,
5685 /* authorize addition of a directory to the parent */
5686 if ((error
= vnode_authorize(dvp
, NULL
, KAUTH_VNODE_ADD_SUBDIRECTORY
, ctx
)) != 0)
5694 vn_authorize_rmdir(vnode_t dvp
, vnode_t vp
, struct componentname
*cnp
, vfs_context_t ctx
, void *reserved
)
5701 if (reserved
!= NULL
) {
5702 panic("Non-NULL reserved argument to vn_authorize_rmdir()");
5705 if (vp
->v_type
!= VDIR
) {
5707 * rmdir only deals with directories
5714 * No rmdir "." please.
5720 error
= mac_vnode_check_unlink(ctx
, dvp
,
5726 return vnode_authorize(vp
, dvp
, KAUTH_VNODE_DELETE
, ctx
);
5730 * Authorize an operation on a vnode.
5732 * This is KPI, but here because it needs vnode_scope.
5734 * Returns: 0 Success
5735 * kauth_authorize_action:EPERM ...
5736 * xlate => EACCES Permission denied
5737 * kauth_authorize_action:0 Success
5738 * kauth_authorize_action: Depends on callback return; this is
5739 * usually only vnode_authorize_callback(),
5740 * but may include other listerners, if any
5748 vnode_authorize(vnode_t vp
, vnode_t dvp
, kauth_action_t action
, vfs_context_t ctx
)
5753 * We can't authorize against a dead vnode; allow all operations through so that
5754 * the correct error can be returned.
5756 if (vp
->v_type
== VBAD
)
5760 result
= kauth_authorize_action(vnode_scope
, vfs_context_ucred(ctx
), action
,
5761 (uintptr_t)ctx
, (uintptr_t)vp
, (uintptr_t)dvp
, (uintptr_t)&error
);
5762 if (result
== EPERM
) /* traditional behaviour */
5764 /* did the lower layers give a better error return? */
5765 if ((result
!= 0) && (error
!= 0))
5771 * Test for vnode immutability.
5773 * The 'append' flag is set when the authorization request is constrained
5774 * to operations which only request the right to append to a file.
5776 * The 'ignore' flag is set when an operation modifying the immutability flags
5777 * is being authorized. We check the system securelevel to determine which
5778 * immutability flags we can ignore.
5781 vnode_immutable(struct vnode_attr
*vap
, int append
, int ignore
)
5785 /* start with all bits precluding the operation */
5786 mask
= IMMUTABLE
| APPEND
;
5788 /* if appending only, remove the append-only bits */
5792 /* ignore only set when authorizing flags changes */
5794 if (securelevel
<= 0) {
5795 /* in insecure state, flags do not inhibit changes */
5798 /* in secure state, user flags don't inhibit */
5799 mask
&= ~(UF_IMMUTABLE
| UF_APPEND
);
5802 KAUTH_DEBUG("IMMUTABLE - file flags 0x%x mask 0x%x append = %d ignore = %d", vap
->va_flags
, mask
, append
, ignore
);
5803 if ((vap
->va_flags
& mask
) != 0)
5809 vauth_node_owner(struct vnode_attr
*vap
, kauth_cred_t cred
)
5813 /* default assumption is not-owner */
5817 * If the filesystem has given us a UID, we treat this as authoritative.
5819 if (vap
&& VATTR_IS_SUPPORTED(vap
, va_uid
)) {
5820 result
= (vap
->va_uid
== kauth_cred_getuid(cred
)) ? 1 : 0;
5822 /* we could test the owner UUID here if we had a policy for it */
5830 * Description: Ask if a cred is a member of the group owning the vnode object
5832 * Parameters: vap vnode attribute
5833 * vap->va_gid group owner of vnode object
5834 * cred credential to check
5835 * ismember pointer to where to put the answer
5836 * idontknow Return this if we can't get an answer
5838 * Returns: 0 Success
5839 * idontknow Can't get information
5840 * kauth_cred_ismember_gid:? Error from kauth subsystem
5841 * kauth_cred_ismember_gid:? Error from kauth subsystem
5844 vauth_node_group(struct vnode_attr
*vap
, kauth_cred_t cred
, int *ismember
, int idontknow
)
5853 * The caller is expected to have asked the filesystem for a group
5854 * at some point prior to calling this function. The answer may
5855 * have been that there is no group ownership supported for the
5856 * vnode object, in which case we return
5858 if (vap
&& VATTR_IS_SUPPORTED(vap
, va_gid
)) {
5859 error
= kauth_cred_ismember_gid(cred
, vap
->va_gid
, &result
);
5861 * Credentials which are opted into external group membership
5862 * resolution which are not known to the external resolver
5863 * will result in an ENOENT error. We translate this into
5864 * the appropriate 'idontknow' response for our caller.
5866 * XXX We do not make a distinction here between an ENOENT
5867 * XXX arising from a response from the external resolver,
5868 * XXX and an ENOENT which is internally generated. This is
5869 * XXX a deficiency of the published kauth_cred_ismember_gid()
5870 * XXX KPI which can not be overcome without new KPI. For
5871 * XXX all currently known cases, however, this wil result
5872 * XXX in correct behaviour.
5874 if (error
== ENOENT
)
5878 * XXX We could test the group UUID here if we had a policy for it,
5879 * XXX but this is problematic from the perspective of synchronizing
5880 * XXX group UUID and POSIX GID ownership of a file and keeping the
5881 * XXX values coherent over time. The problem is that the local
5882 * XXX system will vend transient group UUIDs for unknown POSIX GID
5883 * XXX values, and these are not persistent, whereas storage of values
5884 * XXX is persistent. One potential solution to this is a local
5885 * XXX (persistent) replica of remote directory entries and vended
5886 * XXX local ids in a local directory server (think in terms of a
5887 * XXX caching DNS server).
5896 vauth_file_owner(vauth_ctx vcp
)
5900 if (vcp
->flags_valid
& _VAC_IS_OWNER
) {
5901 result
= (vcp
->flags
& _VAC_IS_OWNER
) ? 1 : 0;
5903 result
= vauth_node_owner(vcp
->vap
, vcp
->ctx
->vc_ucred
);
5905 /* cache our result */
5906 vcp
->flags_valid
|= _VAC_IS_OWNER
;
5908 vcp
->flags
|= _VAC_IS_OWNER
;
5910 vcp
->flags
&= ~_VAC_IS_OWNER
;
5918 * vauth_file_ingroup
5920 * Description: Ask if a user is a member of the group owning the directory
5922 * Parameters: vcp The vnode authorization context that
5923 * contains the user and directory info
5924 * vcp->flags_valid Valid flags
5925 * vcp->flags Flags values
5926 * vcp->vap File vnode attributes
5927 * vcp->ctx VFS Context (for user)
5928 * ismember pointer to where to put the answer
5929 * idontknow Return this if we can't get an answer
5931 * Returns: 0 Success
5932 * vauth_node_group:? Error from vauth_node_group()
5934 * Implicit returns: *ismember 0 The user is not a group member
5935 * 1 The user is a group member
5938 vauth_file_ingroup(vauth_ctx vcp
, int *ismember
, int idontknow
)
5942 /* Check for a cached answer first, to avoid the check if possible */
5943 if (vcp
->flags_valid
& _VAC_IN_GROUP
) {
5944 *ismember
= (vcp
->flags
& _VAC_IN_GROUP
) ? 1 : 0;
5947 /* Otherwise, go look for it */
5948 error
= vauth_node_group(vcp
->vap
, vcp
->ctx
->vc_ucred
, ismember
, idontknow
);
5951 /* cache our result */
5952 vcp
->flags_valid
|= _VAC_IN_GROUP
;
5954 vcp
->flags
|= _VAC_IN_GROUP
;
5956 vcp
->flags
&= ~_VAC_IN_GROUP
;
5965 vauth_dir_owner(vauth_ctx vcp
)
5969 if (vcp
->flags_valid
& _VAC_IS_DIR_OWNER
) {
5970 result
= (vcp
->flags
& _VAC_IS_DIR_OWNER
) ? 1 : 0;
5972 result
= vauth_node_owner(vcp
->dvap
, vcp
->ctx
->vc_ucred
);
5974 /* cache our result */
5975 vcp
->flags_valid
|= _VAC_IS_DIR_OWNER
;
5977 vcp
->flags
|= _VAC_IS_DIR_OWNER
;
5979 vcp
->flags
&= ~_VAC_IS_DIR_OWNER
;
5988 * Description: Ask if a user is a member of the group owning the directory
5990 * Parameters: vcp The vnode authorization context that
5991 * contains the user and directory info
5992 * vcp->flags_valid Valid flags
5993 * vcp->flags Flags values
5994 * vcp->dvap Dir vnode attributes
5995 * vcp->ctx VFS Context (for user)
5996 * ismember pointer to where to put the answer
5997 * idontknow Return this if we can't get an answer
5999 * Returns: 0 Success
6000 * vauth_node_group:? Error from vauth_node_group()
6002 * Implicit returns: *ismember 0 The user is not a group member
6003 * 1 The user is a group member
6006 vauth_dir_ingroup(vauth_ctx vcp
, int *ismember
, int idontknow
)
6010 /* Check for a cached answer first, to avoid the check if possible */
6011 if (vcp
->flags_valid
& _VAC_IN_DIR_GROUP
) {
6012 *ismember
= (vcp
->flags
& _VAC_IN_DIR_GROUP
) ? 1 : 0;
6015 /* Otherwise, go look for it */
6016 error
= vauth_node_group(vcp
->dvap
, vcp
->ctx
->vc_ucred
, ismember
, idontknow
);
6019 /* cache our result */
6020 vcp
->flags_valid
|= _VAC_IN_DIR_GROUP
;
6022 vcp
->flags
|= _VAC_IN_DIR_GROUP
;
6024 vcp
->flags
&= ~_VAC_IN_DIR_GROUP
;
6032 * Test the posix permissions in (vap) to determine whether (credential)
6033 * may perform (action)
6036 vnode_authorize_posix(vauth_ctx vcp
, int action
, int on_dir
)
6038 struct vnode_attr
*vap
;
6039 int needed
, error
, owner_ok
, group_ok
, world_ok
, ismember
;
6040 #ifdef KAUTH_DEBUG_ENABLE
6041 const char *where
= "uninitialized";
6042 # define _SETWHERE(c) where = c;
6044 # define _SETWHERE(c)
6047 /* checking file or directory? */
6057 * We want to do as little work here as possible. So first we check
6058 * which sets of permissions grant us the access we need, and avoid checking
6059 * whether specific permissions grant access when more generic ones would.
6062 /* owner permissions */
6066 if (action
& VWRITE
)
6070 owner_ok
= (needed
& vap
->va_mode
) == needed
;
6072 /* group permissions */
6076 if (action
& VWRITE
)
6080 group_ok
= (needed
& vap
->va_mode
) == needed
;
6082 /* world permissions */
6086 if (action
& VWRITE
)
6090 world_ok
= (needed
& vap
->va_mode
) == needed
;
6092 /* If granted/denied by all three, we're done */
6093 if (owner_ok
&& group_ok
&& world_ok
) {
6097 if (!owner_ok
&& !group_ok
&& !world_ok
) {
6103 /* Check ownership (relatively cheap) */
6104 if ((on_dir
&& vauth_dir_owner(vcp
)) ||
6105 (!on_dir
&& vauth_file_owner(vcp
))) {
6112 /* Not owner; if group and world both grant it we're done */
6113 if (group_ok
&& world_ok
) {
6114 _SETWHERE("group/world");
6117 if (!group_ok
&& !world_ok
) {
6118 _SETWHERE("group/world");
6123 /* Check group membership (most expensive) */
6124 ismember
= 0; /* Default to allow, if the target has no group owner */
6127 * In the case we can't get an answer about the user from the call to
6128 * vauth_dir_ingroup() or vauth_file_ingroup(), we want to fail on
6129 * the side of caution, rather than simply granting access, or we will
6130 * fail to correctly implement exclusion groups, so we set the third
6131 * parameter on the basis of the state of 'group_ok'.
6134 error
= vauth_dir_ingroup(vcp
, &ismember
, (!group_ok
? EACCES
: 0));
6136 error
= vauth_file_ingroup(vcp
, &ismember
, (!group_ok
? EACCES
: 0));
6150 /* Not owner, not in group, use world result */
6158 KAUTH_DEBUG("%p %s - posix %s permissions : need %s%s%s %x have %s%s%s%s%s%s%s%s%s UID = %d file = %d,%d",
6159 vcp
->vp
, (error
== 0) ? "ALLOWED" : "DENIED", where
,
6160 (action
& VREAD
) ? "r" : "-",
6161 (action
& VWRITE
) ? "w" : "-",
6162 (action
& VEXEC
) ? "x" : "-",
6164 (vap
->va_mode
& S_IRUSR
) ? "r" : "-",
6165 (vap
->va_mode
& S_IWUSR
) ? "w" : "-",
6166 (vap
->va_mode
& S_IXUSR
) ? "x" : "-",
6167 (vap
->va_mode
& S_IRGRP
) ? "r" : "-",
6168 (vap
->va_mode
& S_IWGRP
) ? "w" : "-",
6169 (vap
->va_mode
& S_IXGRP
) ? "x" : "-",
6170 (vap
->va_mode
& S_IROTH
) ? "r" : "-",
6171 (vap
->va_mode
& S_IWOTH
) ? "w" : "-",
6172 (vap
->va_mode
& S_IXOTH
) ? "x" : "-",
6173 kauth_cred_getuid(vcp
->ctx
->vc_ucred
),
6174 on_dir
? vcp
->dvap
->va_uid
: vcp
->vap
->va_uid
,
6175 on_dir
? vcp
->dvap
->va_gid
: vcp
->vap
->va_gid
);
6180 * Authorize the deletion of the node vp from the directory dvp.
6183 * - Neither the node nor the directory are immutable.
6184 * - The user is not the superuser.
6186 * Deletion is not permitted if the directory is sticky and the caller is
6187 * not owner of the node or directory.
6189 * If either the node grants DELETE, or the directory grants DELETE_CHILD,
6190 * the node may be deleted. If neither denies the permission, and the
6191 * caller has Posix write access to the directory, then the node may be
6194 * As an optimization, we cache whether or not delete child is permitted
6195 * on directories without the sticky bit set.
6198 vnode_authorize_delete(vauth_ctx vcp
, boolean_t cached_delete_child
);
6200 vnode_authorize_delete(vauth_ctx vcp
, boolean_t cached_delete_child
)
6202 struct vnode_attr
*vap
= vcp
->vap
;
6203 struct vnode_attr
*dvap
= vcp
->dvap
;
6204 kauth_cred_t cred
= vcp
->ctx
->vc_ucred
;
6205 struct kauth_acl_eval eval
;
6206 int error
, delete_denied
, delete_child_denied
, ismember
;
6208 /* check the ACL on the directory */
6209 delete_child_denied
= 0;
6210 if (!cached_delete_child
&& VATTR_IS_NOT(dvap
, va_acl
, NULL
)) {
6211 eval
.ae_requested
= KAUTH_VNODE_DELETE_CHILD
;
6212 eval
.ae_acl
= &dvap
->va_acl
->acl_ace
[0];
6213 eval
.ae_count
= dvap
->va_acl
->acl_entrycount
;
6214 eval
.ae_options
= 0;
6215 if (vauth_dir_owner(vcp
))
6216 eval
.ae_options
|= KAUTH_AEVAL_IS_OWNER
;
6218 * We use ENOENT as a marker to indicate we could not get
6219 * information in order to delay evaluation until after we
6220 * have the ACL evaluation answer. Previously, we would
6221 * always deny the operation at this point.
6223 if ((error
= vauth_dir_ingroup(vcp
, &ismember
, ENOENT
)) != 0 && error
!= ENOENT
)
6225 if (error
== ENOENT
)
6226 eval
.ae_options
|= KAUTH_AEVAL_IN_GROUP_UNKNOWN
;
6228 eval
.ae_options
|= KAUTH_AEVAL_IN_GROUP
;
6229 eval
.ae_exp_gall
= KAUTH_VNODE_GENERIC_ALL_BITS
;
6230 eval
.ae_exp_gread
= KAUTH_VNODE_GENERIC_READ_BITS
;
6231 eval
.ae_exp_gwrite
= KAUTH_VNODE_GENERIC_WRITE_BITS
;
6232 eval
.ae_exp_gexec
= KAUTH_VNODE_GENERIC_EXECUTE_BITS
;
6235 * If there is no entry, we are going to defer to other
6236 * authorization mechanisms.
6238 error
= kauth_acl_evaluate(cred
, &eval
);
6241 KAUTH_DEBUG("%p ERROR during ACL processing - %d", vcp
->vp
, error
);
6244 switch(eval
.ae_result
) {
6245 case KAUTH_RESULT_DENY
:
6246 delete_child_denied
= 1;
6249 case KAUTH_RESULT_ALLOW
:
6250 KAUTH_DEBUG("%p ALLOWED - granted by directory ACL", vcp
->vp
);
6252 case KAUTH_RESULT_DEFER
:
6254 /* Effectively the same as !delete_child_denied */
6255 KAUTH_DEBUG("%p DEFERRED - directory ACL", vcp
->vp
);
6260 /* check the ACL on the node */
6262 if (VATTR_IS_NOT(vap
, va_acl
, NULL
)) {
6263 eval
.ae_requested
= KAUTH_VNODE_DELETE
;
6264 eval
.ae_acl
= &vap
->va_acl
->acl_ace
[0];
6265 eval
.ae_count
= vap
->va_acl
->acl_entrycount
;
6266 eval
.ae_options
= 0;
6267 if (vauth_file_owner(vcp
))
6268 eval
.ae_options
|= KAUTH_AEVAL_IS_OWNER
;
6270 * We use ENOENT as a marker to indicate we could not get
6271 * information in order to delay evaluation until after we
6272 * have the ACL evaluation answer. Previously, we would
6273 * always deny the operation at this point.
6275 if ((error
= vauth_file_ingroup(vcp
, &ismember
, ENOENT
)) != 0 && error
!= ENOENT
)
6277 if (error
== ENOENT
)
6278 eval
.ae_options
|= KAUTH_AEVAL_IN_GROUP_UNKNOWN
;
6280 eval
.ae_options
|= KAUTH_AEVAL_IN_GROUP
;
6281 eval
.ae_exp_gall
= KAUTH_VNODE_GENERIC_ALL_BITS
;
6282 eval
.ae_exp_gread
= KAUTH_VNODE_GENERIC_READ_BITS
;
6283 eval
.ae_exp_gwrite
= KAUTH_VNODE_GENERIC_WRITE_BITS
;
6284 eval
.ae_exp_gexec
= KAUTH_VNODE_GENERIC_EXECUTE_BITS
;
6286 if ((error
= kauth_acl_evaluate(cred
, &eval
)) != 0) {
6287 KAUTH_DEBUG("%p ERROR during ACL processing - %d", vcp
->vp
, error
);
6291 switch(eval
.ae_result
) {
6292 case KAUTH_RESULT_DENY
:
6295 case KAUTH_RESULT_ALLOW
:
6296 KAUTH_DEBUG("%p ALLOWED - granted by file ACL", vcp
->vp
);
6298 case KAUTH_RESULT_DEFER
:
6300 /* Effectively the same as !delete_child_denied */
6301 KAUTH_DEBUG("%p DEFERRED%s - by file ACL", vcp
->vp
, delete_denied
? "(DENY)" : "");
6306 /* if denied by ACL on directory or node, return denial */
6307 if (delete_denied
|| delete_child_denied
) {
6308 KAUTH_DEBUG("%p DENIED - denied by ACL", vcp
->vp
);
6312 /* enforce sticky bit behaviour */
6313 if ((dvap
->va_mode
& S_ISTXT
) && !vauth_file_owner(vcp
) && !vauth_dir_owner(vcp
)) {
6314 KAUTH_DEBUG("%p DENIED - sticky bit rules (user %d file %d dir %d)",
6315 vcp
->vp
, cred
->cr_posix
.cr_uid
, vap
->va_uid
, dvap
->va_uid
);
6319 /* check the directory */
6320 if (!cached_delete_child
&& (error
= vnode_authorize_posix(vcp
, VWRITE
, 1 /* on_dir */)) != 0) {
6321 KAUTH_DEBUG("%p DENIED - denied by posix permisssions", vcp
->vp
);
6325 /* not denied, must be OK */
6331 * Authorize an operation based on the node's attributes.
6334 vnode_authorize_simple(vauth_ctx vcp
, kauth_ace_rights_t acl_rights
, kauth_ace_rights_t preauth_rights
, boolean_t
*found_deny
)
6336 struct vnode_attr
*vap
= vcp
->vap
;
6337 kauth_cred_t cred
= vcp
->ctx
->vc_ucred
;
6338 struct kauth_acl_eval eval
;
6339 int error
, ismember
;
6340 mode_t posix_action
;
6343 * If we are the file owner, we automatically have some rights.
6345 * Do we need to expand this to support group ownership?
6347 if (vauth_file_owner(vcp
))
6348 acl_rights
&= ~(KAUTH_VNODE_WRITE_SECURITY
);
6351 * If we are checking both TAKE_OWNERSHIP and WRITE_SECURITY, we can
6352 * mask the latter. If TAKE_OWNERSHIP is requested the caller is about to
6353 * change ownership to themselves, and WRITE_SECURITY is implicitly
6354 * granted to the owner. We need to do this because at this point
6355 * WRITE_SECURITY may not be granted as the caller is not currently
6358 if ((acl_rights
& KAUTH_VNODE_TAKE_OWNERSHIP
) &&
6359 (acl_rights
& KAUTH_VNODE_WRITE_SECURITY
))
6360 acl_rights
&= ~KAUTH_VNODE_WRITE_SECURITY
;
6362 if (acl_rights
== 0) {
6363 KAUTH_DEBUG("%p ALLOWED - implicit or no rights required", vcp
->vp
);
6367 /* if we have an ACL, evaluate it */
6368 if (VATTR_IS_NOT(vap
, va_acl
, NULL
)) {
6369 eval
.ae_requested
= acl_rights
;
6370 eval
.ae_acl
= &vap
->va_acl
->acl_ace
[0];
6371 eval
.ae_count
= vap
->va_acl
->acl_entrycount
;
6372 eval
.ae_options
= 0;
6373 if (vauth_file_owner(vcp
))
6374 eval
.ae_options
|= KAUTH_AEVAL_IS_OWNER
;
6376 * We use ENOENT as a marker to indicate we could not get
6377 * information in order to delay evaluation until after we
6378 * have the ACL evaluation answer. Previously, we would
6379 * always deny the operation at this point.
6381 if ((error
= vauth_file_ingroup(vcp
, &ismember
, ENOENT
)) != 0 && error
!= ENOENT
)
6383 if (error
== ENOENT
)
6384 eval
.ae_options
|= KAUTH_AEVAL_IN_GROUP_UNKNOWN
;
6386 eval
.ae_options
|= KAUTH_AEVAL_IN_GROUP
;
6387 eval
.ae_exp_gall
= KAUTH_VNODE_GENERIC_ALL_BITS
;
6388 eval
.ae_exp_gread
= KAUTH_VNODE_GENERIC_READ_BITS
;
6389 eval
.ae_exp_gwrite
= KAUTH_VNODE_GENERIC_WRITE_BITS
;
6390 eval
.ae_exp_gexec
= KAUTH_VNODE_GENERIC_EXECUTE_BITS
;
6392 if ((error
= kauth_acl_evaluate(cred
, &eval
)) != 0) {
6393 KAUTH_DEBUG("%p ERROR during ACL processing - %d", vcp
->vp
, error
);
6397 switch(eval
.ae_result
) {
6398 case KAUTH_RESULT_DENY
:
6399 KAUTH_DEBUG("%p DENIED - by ACL", vcp
->vp
);
6400 return(EACCES
); /* deny, deny, counter-allege */
6401 case KAUTH_RESULT_ALLOW
:
6402 KAUTH_DEBUG("%p ALLOWED - all rights granted by ACL", vcp
->vp
);
6404 case KAUTH_RESULT_DEFER
:
6406 /* Effectively the same as !delete_child_denied */
6407 KAUTH_DEBUG("%p DEFERRED - directory ACL", vcp
->vp
);
6411 *found_deny
= eval
.ae_found_deny
;
6413 /* fall through and evaluate residual rights */
6415 /* no ACL, everything is residual */
6416 eval
.ae_residual
= acl_rights
;
6420 * Grant residual rights that have been pre-authorized.
6422 eval
.ae_residual
&= ~preauth_rights
;
6425 * We grant WRITE_ATTRIBUTES to the owner if it hasn't been denied.
6427 if (vauth_file_owner(vcp
))
6428 eval
.ae_residual
&= ~KAUTH_VNODE_WRITE_ATTRIBUTES
;
6430 if (eval
.ae_residual
== 0) {
6431 KAUTH_DEBUG("%p ALLOWED - rights already authorized", vcp
->vp
);
6436 * Bail if we have residual rights that can't be granted by posix permissions,
6437 * or aren't presumed granted at this point.
6439 * XXX these can be collapsed for performance
6441 if (eval
.ae_residual
& KAUTH_VNODE_CHANGE_OWNER
) {
6442 KAUTH_DEBUG("%p DENIED - CHANGE_OWNER not permitted", vcp
->vp
);
6445 if (eval
.ae_residual
& KAUTH_VNODE_WRITE_SECURITY
) {
6446 KAUTH_DEBUG("%p DENIED - WRITE_SECURITY not permitted", vcp
->vp
);
6451 if (eval
.ae_residual
& KAUTH_VNODE_DELETE
)
6452 panic("vnode_authorize: can't be checking delete permission here");
6456 * Compute the fallback posix permissions that will satisfy the remaining
6460 if (eval
.ae_residual
& (KAUTH_VNODE_READ_DATA
|
6461 KAUTH_VNODE_LIST_DIRECTORY
|
6462 KAUTH_VNODE_READ_EXTATTRIBUTES
))
6463 posix_action
|= VREAD
;
6464 if (eval
.ae_residual
& (KAUTH_VNODE_WRITE_DATA
|
6465 KAUTH_VNODE_ADD_FILE
|
6466 KAUTH_VNODE_ADD_SUBDIRECTORY
|
6467 KAUTH_VNODE_DELETE_CHILD
|
6468 KAUTH_VNODE_WRITE_ATTRIBUTES
|
6469 KAUTH_VNODE_WRITE_EXTATTRIBUTES
))
6470 posix_action
|= VWRITE
;
6471 if (eval
.ae_residual
& (KAUTH_VNODE_EXECUTE
|
6472 KAUTH_VNODE_SEARCH
))
6473 posix_action
|= VEXEC
;
6475 if (posix_action
!= 0) {
6476 return(vnode_authorize_posix(vcp
, posix_action
, 0 /* !on_dir */));
6478 KAUTH_DEBUG("%p ALLOWED - residual rights %s%s%s%s%s%s%s%s%s%s%s%s%s%s granted due to no posix mapping",
6480 (eval
.ae_residual
& KAUTH_VNODE_READ_DATA
)
6481 ? vnode_isdir(vcp
->vp
) ? " LIST_DIRECTORY" : " READ_DATA" : "",
6482 (eval
.ae_residual
& KAUTH_VNODE_WRITE_DATA
)
6483 ? vnode_isdir(vcp
->vp
) ? " ADD_FILE" : " WRITE_DATA" : "",
6484 (eval
.ae_residual
& KAUTH_VNODE_EXECUTE
)
6485 ? vnode_isdir(vcp
->vp
) ? " SEARCH" : " EXECUTE" : "",
6486 (eval
.ae_residual
& KAUTH_VNODE_DELETE
)
6488 (eval
.ae_residual
& KAUTH_VNODE_APPEND_DATA
)
6489 ? vnode_isdir(vcp
->vp
) ? " ADD_SUBDIRECTORY" : " APPEND_DATA" : "",
6490 (eval
.ae_residual
& KAUTH_VNODE_DELETE_CHILD
)
6491 ? " DELETE_CHILD" : "",
6492 (eval
.ae_residual
& KAUTH_VNODE_READ_ATTRIBUTES
)
6493 ? " READ_ATTRIBUTES" : "",
6494 (eval
.ae_residual
& KAUTH_VNODE_WRITE_ATTRIBUTES
)
6495 ? " WRITE_ATTRIBUTES" : "",
6496 (eval
.ae_residual
& KAUTH_VNODE_READ_EXTATTRIBUTES
)
6497 ? " READ_EXTATTRIBUTES" : "",
6498 (eval
.ae_residual
& KAUTH_VNODE_WRITE_EXTATTRIBUTES
)
6499 ? " WRITE_EXTATTRIBUTES" : "",
6500 (eval
.ae_residual
& KAUTH_VNODE_READ_SECURITY
)
6501 ? " READ_SECURITY" : "",
6502 (eval
.ae_residual
& KAUTH_VNODE_WRITE_SECURITY
)
6503 ? " WRITE_SECURITY" : "",
6504 (eval
.ae_residual
& KAUTH_VNODE_CHECKIMMUTABLE
)
6505 ? " CHECKIMMUTABLE" : "",
6506 (eval
.ae_residual
& KAUTH_VNODE_CHANGE_OWNER
)
6507 ? " CHANGE_OWNER" : "");
6511 * Lack of required Posix permissions implies no reason to deny access.
6517 * Check for file immutability.
6520 vnode_authorize_checkimmutable(vnode_t vp
, struct vnode_attr
*vap
, int rights
, int ignore
)
6527 * Perform immutability checks for operations that change data.
6529 * Sockets, fifos and devices require special handling.
6531 switch(vp
->v_type
) {
6537 * Writing to these nodes does not change the filesystem data,
6538 * so forget that it's being tried.
6540 rights
&= ~KAUTH_VNODE_WRITE_DATA
;
6547 if (rights
& KAUTH_VNODE_WRITE_RIGHTS
) {
6549 /* check per-filesystem options if possible */
6553 /* check for no-EA filesystems */
6554 if ((rights
& KAUTH_VNODE_WRITE_EXTATTRIBUTES
) &&
6555 (vfs_flags(mp
) & MNT_NOUSERXATTR
)) {
6556 KAUTH_DEBUG("%p DENIED - filesystem disallowed extended attributes", vp
);
6557 error
= EACCES
; /* User attributes disabled */
6563 * check for file immutability. first, check if the requested rights are
6564 * allowable for a UF_APPEND file.
6567 if (vp
->v_type
== VDIR
) {
6568 if ((rights
& (KAUTH_VNODE_ADD_FILE
| KAUTH_VNODE_ADD_SUBDIRECTORY
| KAUTH_VNODE_WRITE_EXTATTRIBUTES
)) == rights
)
6571 if ((rights
& (KAUTH_VNODE_APPEND_DATA
| KAUTH_VNODE_WRITE_EXTATTRIBUTES
)) == rights
)
6574 if ((error
= vnode_immutable(vap
, append
, ignore
)) != 0) {
6575 KAUTH_DEBUG("%p DENIED - file is immutable", vp
);
6584 * Handle authorization actions for filesystems that advertise that the
6585 * server will be enforcing.
6587 * Returns: 0 Authorization should be handled locally
6588 * 1 Authorization was handled by the FS
6590 * Note: Imputed returns will only occur if the authorization request
6591 * was handled by the FS.
6593 * Imputed: *resultp, modified Return code from FS when the request is
6594 * handled by the FS.
6599 vnode_authorize_opaque(vnode_t vp
, int *resultp
, kauth_action_t action
, vfs_context_t ctx
)
6604 * If the vp is a device node, socket or FIFO it actually represents a local
6605 * endpoint, so we need to handle it locally.
6607 switch(vp
->v_type
) {
6618 * In the advisory request case, if the filesystem doesn't think it's reliable
6619 * we will attempt to formulate a result ourselves based on VNOP_GETATTR data.
6621 if ((action
& KAUTH_VNODE_ACCESS
) && !vfs_authopaqueaccess(vp
->v_mount
))
6625 * Let the filesystem have a say in the matter. It's OK for it to not implemnent
6626 * VNOP_ACCESS, as most will authorise inline with the actual request.
6628 if ((error
= VNOP_ACCESS(vp
, action
, ctx
)) != ENOTSUP
) {
6630 KAUTH_DEBUG("%p DENIED - opaque filesystem VNOP_ACCESS denied access", vp
);
6635 * Typically opaque filesystems do authorisation in-line, but exec is a special case. In
6636 * order to be reasonably sure that exec will be permitted, we try a bit harder here.
6638 if ((action
& KAUTH_VNODE_EXECUTE
) && (vp
->v_type
== VREG
)) {
6639 /* try a VNOP_OPEN for readonly access */
6640 if ((error
= VNOP_OPEN(vp
, FREAD
, ctx
)) != 0) {
6642 KAUTH_DEBUG("%p DENIED - EXECUTE denied because file could not be opened readonly", vp
);
6645 VNOP_CLOSE(vp
, FREAD
, ctx
);
6649 * We don't have any reason to believe that the request has to be denied at this point,
6650 * so go ahead and allow it.
6653 KAUTH_DEBUG("%p ALLOWED - bypassing access check for non-local filesystem", vp
);
6661 * Returns: KAUTH_RESULT_ALLOW
6664 * Imputed: *arg3, modified Error code in the deny case
6665 * EROFS Read-only file system
6666 * EACCES Permission denied
6667 * EPERM Operation not permitted [no execute]
6668 * vnode_getattr:ENOMEM Not enough space [only if has filesec]
6670 * vnode_authorize_opaque:*arg2 ???
6671 * vnode_authorize_checkimmutable:???
6672 * vnode_authorize_delete:???
6673 * vnode_authorize_simple:???
6678 vnode_authorize_callback(kauth_cred_t cred
, void *idata
, kauth_action_t action
,
6679 uintptr_t arg0
, uintptr_t arg1
, uintptr_t arg2
, uintptr_t arg3
)
6682 vnode_t cvp
= NULLVP
;
6684 int result
= KAUTH_RESULT_DENY
;
6685 int parent_iocount
= 0;
6686 int parent_action
; /* In case we need to use namedstream's data fork for cached rights*/
6688 ctx
= (vfs_context_t
)arg0
;
6690 dvp
= (vnode_t
)arg2
;
6693 * if there are 2 vnodes passed in, we don't know at
6694 * this point which rights to look at based on the
6695 * combined action being passed in... defer until later...
6696 * otherwise check the kauth 'rights' cache hung
6697 * off of the vnode we're interested in... if we've already
6698 * been granted the right we're currently interested in,
6699 * we can just return success... otherwise we'll go through
6700 * the process of authorizing the requested right(s)... if that
6701 * succeeds, we'll add the right(s) to the cache.
6702 * VNOP_SETATTR and VNOP_SETXATTR will invalidate this cache
6710 * For named streams on local-authorization volumes, rights are cached on the parent;
6711 * authorization is determined by looking at the parent's properties anyway, so storing
6712 * on the parent means that we don't recompute for the named stream and that if
6713 * we need to flush rights (e.g. on VNOP_SETATTR()) we don't need to track down the
6714 * stream to flush its cache separately. If we miss in the cache, then we authorize
6715 * as if there were no cached rights (passing the named stream vnode and desired rights to
6716 * vnode_authorize_callback_int()).
6718 * On an opaquely authorized volume, we don't know the relationship between the
6719 * data fork's properties and the rights granted on a stream. Thus, named stream vnodes
6720 * on such a volume are authorized directly (rather than using the parent) and have their
6721 * own caches. When a named stream vnode is created, we mark the parent as having a named
6722 * stream. On a VNOP_SETATTR() for the parent that may invalidate cached authorization, we
6723 * find the stream and flush its cache.
6725 if (vnode_isnamedstream(vp
) && (!vfs_authopaque(vp
->v_mount
))) {
6726 cvp
= vnode_getparent(vp
);
6727 if (cvp
!= NULLVP
) {
6731 goto defer
; /* If we can't use the parent, take the slow path */
6734 /* Have to translate some actions */
6735 parent_action
= action
;
6736 if (parent_action
& KAUTH_VNODE_READ_DATA
) {
6737 parent_action
&= ~KAUTH_VNODE_READ_DATA
;
6738 parent_action
|= KAUTH_VNODE_READ_EXTATTRIBUTES
;
6740 if (parent_action
& KAUTH_VNODE_WRITE_DATA
) {
6741 parent_action
&= ~KAUTH_VNODE_WRITE_DATA
;
6742 parent_action
|= KAUTH_VNODE_WRITE_EXTATTRIBUTES
;
6750 if (vnode_cache_is_authorized(cvp
, ctx
, parent_iocount
? parent_action
: action
) == TRUE
) {
6751 result
= KAUTH_RESULT_ALLOW
;
6755 result
= vnode_authorize_callback_int(cred
, idata
, action
, arg0
, arg1
, arg2
, arg3
);
6757 if (result
== KAUTH_RESULT_ALLOW
&& cvp
!= NULLVP
) {
6758 KAUTH_DEBUG("%p - caching action = %x", cvp
, action
);
6759 vnode_cache_authorized_action(cvp
, ctx
, action
);
6763 if (parent_iocount
) {
6772 vnode_authorize_callback_int(__unused kauth_cred_t unused_cred
, __unused
void *idata
, kauth_action_t action
,
6773 uintptr_t arg0
, uintptr_t arg1
, uintptr_t arg2
, uintptr_t arg3
)
6775 struct _vnode_authorize_context auth_context
;
6780 kauth_ace_rights_t rights
;
6781 struct vnode_attr va
, dva
;
6785 boolean_t parent_authorized_for_delete_child
= FALSE
;
6786 boolean_t found_deny
= FALSE
;
6787 boolean_t parent_ref
= FALSE
;
6789 vcp
= &auth_context
;
6790 ctx
= vcp
->ctx
= (vfs_context_t
)arg0
;
6791 vp
= vcp
->vp
= (vnode_t
)arg1
;
6792 dvp
= vcp
->dvp
= (vnode_t
)arg2
;
6793 errorp
= (int *)arg3
;
6795 * Note that we authorize against the context, not the passed cred
6796 * (the same thing anyway)
6798 cred
= ctx
->vc_ucred
;
6805 vcp
->flags
= vcp
->flags_valid
= 0;
6808 if ((ctx
== NULL
) || (vp
== NULL
) || (cred
== NULL
))
6809 panic("vnode_authorize: bad arguments (context %p vp %p cred %p)", ctx
, vp
, cred
);
6812 KAUTH_DEBUG("%p AUTH - %s %s%s%s%s%s%s%s%s%s%s%s%s%s%s%s on %s '%s' (0x%x:%p/%p)",
6813 vp
, vfs_context_proc(ctx
)->p_comm
,
6814 (action
& KAUTH_VNODE_ACCESS
) ? "access" : "auth",
6815 (action
& KAUTH_VNODE_READ_DATA
) ? vnode_isdir(vp
) ? " LIST_DIRECTORY" : " READ_DATA" : "",
6816 (action
& KAUTH_VNODE_WRITE_DATA
) ? vnode_isdir(vp
) ? " ADD_FILE" : " WRITE_DATA" : "",
6817 (action
& KAUTH_VNODE_EXECUTE
) ? vnode_isdir(vp
) ? " SEARCH" : " EXECUTE" : "",
6818 (action
& KAUTH_VNODE_DELETE
) ? " DELETE" : "",
6819 (action
& KAUTH_VNODE_APPEND_DATA
) ? vnode_isdir(vp
) ? " ADD_SUBDIRECTORY" : " APPEND_DATA" : "",
6820 (action
& KAUTH_VNODE_DELETE_CHILD
) ? " DELETE_CHILD" : "",
6821 (action
& KAUTH_VNODE_READ_ATTRIBUTES
) ? " READ_ATTRIBUTES" : "",
6822 (action
& KAUTH_VNODE_WRITE_ATTRIBUTES
) ? " WRITE_ATTRIBUTES" : "",
6823 (action
& KAUTH_VNODE_READ_EXTATTRIBUTES
) ? " READ_EXTATTRIBUTES" : "",
6824 (action
& KAUTH_VNODE_WRITE_EXTATTRIBUTES
) ? " WRITE_EXTATTRIBUTES" : "",
6825 (action
& KAUTH_VNODE_READ_SECURITY
) ? " READ_SECURITY" : "",
6826 (action
& KAUTH_VNODE_WRITE_SECURITY
) ? " WRITE_SECURITY" : "",
6827 (action
& KAUTH_VNODE_CHANGE_OWNER
) ? " CHANGE_OWNER" : "",
6828 (action
& KAUTH_VNODE_NOIMMUTABLE
) ? " (noimmutable)" : "",
6829 vnode_isdir(vp
) ? "directory" : "file",
6830 vp
->v_name
? vp
->v_name
: "<NULL>", action
, vp
, dvp
);
6833 * Extract the control bits from the action, everything else is
6836 noimmutable
= (action
& KAUTH_VNODE_NOIMMUTABLE
) ? 1 : 0;
6837 rights
= action
& ~(KAUTH_VNODE_ACCESS
| KAUTH_VNODE_NOIMMUTABLE
);
6839 if (rights
& KAUTH_VNODE_DELETE
) {
6842 panic("vnode_authorize: KAUTH_VNODE_DELETE test requires a directory");
6845 * check to see if we've already authorized the parent
6846 * directory for deletion of its children... if so, we
6847 * can skip a whole bunch of work... we will still have to
6848 * authorize that this specific child can be removed
6850 if (vnode_cache_is_authorized(dvp
, ctx
, KAUTH_VNODE_DELETE_CHILD
) == TRUE
)
6851 parent_authorized_for_delete_child
= TRUE
;
6857 * Check for read-only filesystems.
6859 if ((rights
& KAUTH_VNODE_WRITE_RIGHTS
) &&
6860 (vp
->v_mount
->mnt_flag
& MNT_RDONLY
) &&
6861 ((vp
->v_type
== VREG
) || (vp
->v_type
== VDIR
) ||
6862 (vp
->v_type
== VLNK
) || (vp
->v_type
== VCPLX
) ||
6863 (rights
& KAUTH_VNODE_DELETE
) || (rights
& KAUTH_VNODE_DELETE_CHILD
))) {
6869 * Check for noexec filesystems.
6871 if ((rights
& KAUTH_VNODE_EXECUTE
) && (vp
->v_type
== VREG
) && (vp
->v_mount
->mnt_flag
& MNT_NOEXEC
)) {
6877 * Handle cases related to filesystems with non-local enforcement.
6878 * This call can return 0, in which case we will fall through to perform a
6879 * check based on VNOP_GETATTR data. Otherwise it returns 1 and sets
6880 * an appropriate result, at which point we can return immediately.
6882 if ((vp
->v_mount
->mnt_kern_flag
& MNTK_AUTH_OPAQUE
) && vnode_authorize_opaque(vp
, &result
, action
, ctx
))
6886 * Get vnode attributes and extended security information for the vnode
6887 * and directory if required.
6889 VATTR_WANTED(&va
, va_mode
);
6890 VATTR_WANTED(&va
, va_uid
);
6891 VATTR_WANTED(&va
, va_gid
);
6892 VATTR_WANTED(&va
, va_flags
);
6893 VATTR_WANTED(&va
, va_acl
);
6894 if ((result
= vnode_getattr(vp
, &va
, ctx
)) != 0) {
6895 KAUTH_DEBUG("%p ERROR - failed to get vnode attributes - %d", vp
, result
);
6899 VATTR_WANTED(&dva
, va_mode
);
6900 VATTR_WANTED(&dva
, va_uid
);
6901 VATTR_WANTED(&dva
, va_gid
);
6902 VATTR_WANTED(&dva
, va_flags
);
6903 VATTR_WANTED(&dva
, va_acl
);
6904 if ((result
= vnode_getattr(dvp
, &dva
, ctx
)) != 0) {
6905 KAUTH_DEBUG("%p ERROR - failed to get directory vnode attributes - %d", vp
, result
);
6911 * If the vnode is an extended attribute data vnode (eg. a resource fork), *_DATA becomes
6914 if (vnode_isnamedstream(vp
)) {
6915 if (rights
& KAUTH_VNODE_READ_DATA
) {
6916 rights
&= ~KAUTH_VNODE_READ_DATA
;
6917 rights
|= KAUTH_VNODE_READ_EXTATTRIBUTES
;
6919 if (rights
& KAUTH_VNODE_WRITE_DATA
) {
6920 rights
&= ~KAUTH_VNODE_WRITE_DATA
;
6921 rights
|= KAUTH_VNODE_WRITE_EXTATTRIBUTES
;
6926 * Point 'vp' to the resource fork's parent for ACL checking
6928 if (vnode_isnamedstream(vp
) &&
6929 (vp
->v_parent
!= NULL
) &&
6930 (vget_internal(vp
->v_parent
, 0, VNODE_NODEAD
| VNODE_DRAINO
) == 0)) {
6932 vcp
->vp
= vp
= vp
->v_parent
;
6933 if (VATTR_IS_SUPPORTED(&va
, va_acl
) && (va
.va_acl
!= NULL
))
6934 kauth_acl_free(va
.va_acl
);
6936 VATTR_WANTED(&va
, va_mode
);
6937 VATTR_WANTED(&va
, va_uid
);
6938 VATTR_WANTED(&va
, va_gid
);
6939 VATTR_WANTED(&va
, va_flags
);
6940 VATTR_WANTED(&va
, va_acl
);
6941 if ((result
= vnode_getattr(vp
, &va
, ctx
)) != 0)
6946 * Check for immutability.
6948 * In the deletion case, parent directory immutability vetoes specific
6951 if ((result
= vnode_authorize_checkimmutable(vp
, &va
, rights
, noimmutable
)) != 0)
6953 if ((rights
& KAUTH_VNODE_DELETE
) &&
6954 parent_authorized_for_delete_child
== FALSE
&&
6955 ((result
= vnode_authorize_checkimmutable(dvp
, &dva
, KAUTH_VNODE_DELETE_CHILD
, 0)) != 0))
6959 * Clear rights that have been authorized by reaching this point, bail if nothing left to
6962 rights
&= ~(KAUTH_VNODE_LINKTARGET
| KAUTH_VNODE_CHECKIMMUTABLE
);
6967 * If we're not the superuser, authorize based on file properties;
6968 * note that even if parent_authorized_for_delete_child is TRUE, we
6969 * need to check on the node itself.
6971 if (!vfs_context_issuser(ctx
)) {
6972 /* process delete rights */
6973 if ((rights
& KAUTH_VNODE_DELETE
) &&
6974 ((result
= vnode_authorize_delete(vcp
, parent_authorized_for_delete_child
)) != 0))
6977 /* process remaining rights */
6978 if ((rights
& ~KAUTH_VNODE_DELETE
) &&
6979 (result
= vnode_authorize_simple(vcp
, rights
, rights
& KAUTH_VNODE_DELETE
, &found_deny
)) != 0)
6984 * Execute is only granted to root if one of the x bits is set. This check only
6985 * makes sense if the posix mode bits are actually supported.
6987 if ((rights
& KAUTH_VNODE_EXECUTE
) &&
6988 (vp
->v_type
== VREG
) &&
6989 VATTR_IS_SUPPORTED(&va
, va_mode
) &&
6990 !(va
.va_mode
& (S_IXUSR
| S_IXGRP
| S_IXOTH
))) {
6992 KAUTH_DEBUG("%p DENIED - root execute requires at least one x bit in 0x%x", vp
, va
.va_mode
);
6996 KAUTH_DEBUG("%p ALLOWED - caller is superuser", vp
);
6999 if (VATTR_IS_SUPPORTED(&va
, va_acl
) && (va
.va_acl
!= NULL
))
7000 kauth_acl_free(va
.va_acl
);
7001 if (VATTR_IS_SUPPORTED(&dva
, va_acl
) && (dva
.va_acl
!= NULL
))
7002 kauth_acl_free(dva
.va_acl
);
7008 KAUTH_DEBUG("%p DENIED - auth denied", vp
);
7009 return(KAUTH_RESULT_DENY
);
7011 if ((rights
& KAUTH_VNODE_SEARCH
) && found_deny
== FALSE
&& vp
->v_type
== VDIR
) {
7013 * if we were successfully granted the right to search this directory
7014 * and there were NO ACL DENYs for search and the posix permissions also don't
7015 * deny execute, we can synthesize a global right that allows anyone to
7016 * traverse this directory during a pathname lookup without having to
7017 * match the credential associated with this cache of rights.
7019 if (!VATTR_IS_SUPPORTED(&va
, va_mode
) ||
7020 ((va
.va_mode
& (S_IXUSR
| S_IXGRP
| S_IXOTH
)) ==
7021 (S_IXUSR
| S_IXGRP
| S_IXOTH
))) {
7022 vnode_cache_authorized_action(vp
, ctx
, KAUTH_VNODE_SEARCHBYANYONE
);
7025 if ((rights
& KAUTH_VNODE_DELETE
) && parent_authorized_for_delete_child
== FALSE
) {
7027 * parent was successfully and newly authorized for content deletions
7028 * add it to the cache, but only if it doesn't have the sticky
7029 * bit set on it. This same check is done earlier guarding
7030 * fetching of dva, and if we jumped to out without having done
7031 * this, we will have returned already because of a non-zero
7034 if (VATTR_IS_SUPPORTED(&dva
, va_mode
) &&
7035 !(dva
.va_mode
& (S_ISVTX
))) {
7036 /* OK to cache delete rights */
7037 KAUTH_DEBUG("%p - caching DELETE_CHILD rights", dvp
);
7038 vnode_cache_authorized_action(dvp
, ctx
, KAUTH_VNODE_DELETE_CHILD
);
7044 * Note that this implies that we will allow requests for no rights, as well as
7045 * for rights that we do not recognise. There should be none of these.
7047 KAUTH_DEBUG("%p ALLOWED - auth granted", vp
);
7048 return(KAUTH_RESULT_ALLOW
);
7052 vnode_authattr_new(vnode_t dvp
, struct vnode_attr
*vap
, int noauth
, vfs_context_t ctx
)
7054 return vnode_authattr_new_internal(dvp
, vap
, noauth
, NULL
, ctx
);
7058 * Check that the attribute information in vattr can be legally applied to
7059 * a new file by the context.
7062 vnode_authattr_new_internal(vnode_t dvp
, struct vnode_attr
*vap
, int noauth
, uint32_t *defaulted_fieldsp
, vfs_context_t ctx
)
7065 int has_priv_suser
, ismember
, defaulted_owner
, defaulted_group
, defaulted_mode
;
7072 if (defaulted_fieldsp
) {
7073 *defaulted_fieldsp
= 0;
7076 defaulted_owner
= defaulted_group
= defaulted_mode
= 0;
7079 * Require that the filesystem support extended security to apply any.
7081 if (!vfs_extendedsecurity(dvp
->v_mount
) &&
7082 (VATTR_IS_ACTIVE(vap
, va_acl
) || VATTR_IS_ACTIVE(vap
, va_uuuid
) || VATTR_IS_ACTIVE(vap
, va_guuid
))) {
7088 * Default some fields.
7093 * If the filesystem is mounted IGNORE_OWNERSHIP and an explicit owner is set, that
7094 * owner takes ownership of all new files.
7096 if ((dmp
->mnt_flag
& MNT_IGNORE_OWNERSHIP
) && (dmp
->mnt_fsowner
!= KAUTH_UID_NONE
)) {
7097 VATTR_SET(vap
, va_uid
, dmp
->mnt_fsowner
);
7098 defaulted_owner
= 1;
7100 if (!VATTR_IS_ACTIVE(vap
, va_uid
)) {
7101 /* default owner is current user */
7102 VATTR_SET(vap
, va_uid
, kauth_cred_getuid(vfs_context_ucred(ctx
)));
7103 defaulted_owner
= 1;
7108 * If the filesystem is mounted IGNORE_OWNERSHIP and an explicit grouo is set, that
7109 * group takes ownership of all new files.
7111 if ((dmp
->mnt_flag
& MNT_IGNORE_OWNERSHIP
) && (dmp
->mnt_fsgroup
!= KAUTH_GID_NONE
)) {
7112 VATTR_SET(vap
, va_gid
, dmp
->mnt_fsgroup
);
7113 defaulted_group
= 1;
7115 if (!VATTR_IS_ACTIVE(vap
, va_gid
)) {
7116 /* default group comes from parent object, fallback to current user */
7117 struct vnode_attr dva
;
7119 VATTR_WANTED(&dva
, va_gid
);
7120 if ((error
= vnode_getattr(dvp
, &dva
, ctx
)) != 0)
7122 if (VATTR_IS_SUPPORTED(&dva
, va_gid
)) {
7123 VATTR_SET(vap
, va_gid
, dva
.va_gid
);
7125 VATTR_SET(vap
, va_gid
, kauth_cred_getgid(vfs_context_ucred(ctx
)));
7127 defaulted_group
= 1;
7131 if (!VATTR_IS_ACTIVE(vap
, va_flags
))
7132 VATTR_SET(vap
, va_flags
, 0);
7134 /* default mode is everything, masked with current umask */
7135 if (!VATTR_IS_ACTIVE(vap
, va_mode
)) {
7136 VATTR_SET(vap
, va_mode
, ACCESSPERMS
& ~vfs_context_proc(ctx
)->p_fd
->fd_cmask
);
7137 KAUTH_DEBUG("ATTR - defaulting new file mode to %o from umask %o", vap
->va_mode
, vfs_context_proc(ctx
)->p_fd
->fd_cmask
);
7140 /* set timestamps to now */
7141 if (!VATTR_IS_ACTIVE(vap
, va_create_time
)) {
7142 nanotime(&vap
->va_create_time
);
7143 VATTR_SET_ACTIVE(vap
, va_create_time
);
7147 * Check for attempts to set nonsensical fields.
7149 if (vap
->va_active
& ~VNODE_ATTR_NEWOBJ
) {
7151 KAUTH_DEBUG("ATTR - ERROR - attempt to set unsupported new-file attributes %llx",
7152 vap
->va_active
& ~VNODE_ATTR_NEWOBJ
);
7157 * Quickly check for the applicability of any enforcement here.
7158 * Tests below maintain the integrity of the local security model.
7160 if (vfs_authopaque(dvp
->v_mount
))
7164 * We need to know if the caller is the superuser, or if the work is
7165 * otherwise already authorised.
7167 cred
= vfs_context_ucred(ctx
);
7169 /* doing work for the kernel */
7172 has_priv_suser
= vfs_context_issuser(ctx
);
7176 if (VATTR_IS_ACTIVE(vap
, va_flags
)) {
7177 if (has_priv_suser
) {
7178 if ((vap
->va_flags
& (UF_SETTABLE
| SF_SETTABLE
)) != vap
->va_flags
) {
7180 KAUTH_DEBUG(" DENIED - superuser attempt to set illegal flag(s)");
7184 if ((vap
->va_flags
& UF_SETTABLE
) != vap
->va_flags
) {
7186 KAUTH_DEBUG(" DENIED - user attempt to set illegal flag(s)");
7192 /* if not superuser, validate legality of new-item attributes */
7193 if (!has_priv_suser
) {
7194 if (!defaulted_mode
&& VATTR_IS_ACTIVE(vap
, va_mode
)) {
7196 if (vap
->va_mode
& S_ISGID
) {
7197 if ((error
= kauth_cred_ismember_gid(cred
, vap
->va_gid
, &ismember
)) != 0) {
7198 KAUTH_DEBUG("ATTR - ERROR: got %d checking for membership in %d", error
, vap
->va_gid
);
7202 KAUTH_DEBUG(" DENIED - can't set SGID bit, not a member of %d", vap
->va_gid
);
7209 if ((vap
->va_mode
& S_ISUID
) && (vap
->va_uid
!= kauth_cred_getuid(cred
))) {
7210 KAUTH_DEBUG("ATTR - ERROR: illegal attempt to set the setuid bit");
7215 if (!defaulted_owner
&& (vap
->va_uid
!= kauth_cred_getuid(cred
))) {
7216 KAUTH_DEBUG(" DENIED - cannot create new item owned by %d", vap
->va_uid
);
7220 if (!defaulted_group
) {
7221 if ((error
= kauth_cred_ismember_gid(cred
, vap
->va_gid
, &ismember
)) != 0) {
7222 KAUTH_DEBUG(" ERROR - got %d checking for membership in %d", error
, vap
->va_gid
);
7226 KAUTH_DEBUG(" DENIED - cannot create new item with group %d - not a member", vap
->va_gid
);
7232 /* initialising owner/group UUID */
7233 if (VATTR_IS_ACTIVE(vap
, va_uuuid
)) {
7234 if ((error
= kauth_cred_getguid(cred
, &changer
)) != 0) {
7235 KAUTH_DEBUG(" ERROR - got %d trying to get caller UUID", error
);
7236 /* XXX ENOENT here - no GUID - should perhaps become EPERM */
7239 if (!kauth_guid_equal(&vap
->va_uuuid
, &changer
)) {
7240 KAUTH_DEBUG(" ERROR - cannot create item with supplied owner UUID - not us");
7245 if (VATTR_IS_ACTIVE(vap
, va_guuid
)) {
7246 if ((error
= kauth_cred_ismember_guid(cred
, &vap
->va_guuid
, &ismember
)) != 0) {
7247 KAUTH_DEBUG(" ERROR - got %d trying to check group membership", error
);
7251 KAUTH_DEBUG(" ERROR - cannot create item with supplied group UUID - not a member");
7258 if (defaulted_fieldsp
) {
7259 if (defaulted_mode
) {
7260 *defaulted_fieldsp
|= VATTR_PREPARE_DEFAULTED_MODE
;
7262 if (defaulted_group
) {
7263 *defaulted_fieldsp
|= VATTR_PREPARE_DEFAULTED_GID
;
7265 if (defaulted_owner
) {
7266 *defaulted_fieldsp
|= VATTR_PREPARE_DEFAULTED_UID
;
7273 * Check that the attribute information in vap can be legally written by the
7276 * Call this when you're not sure about the vnode_attr; either its contents
7277 * have come from an unknown source, or when they are variable.
7279 * Returns errno, or zero and sets *actionp to the KAUTH_VNODE_* actions that
7280 * must be authorized to be permitted to write the vattr.
7283 vnode_authattr(vnode_t vp
, struct vnode_attr
*vap
, kauth_action_t
*actionp
, vfs_context_t ctx
)
7285 struct vnode_attr ova
;
7286 kauth_action_t required_action
;
7287 int error
, has_priv_suser
, ismember
, chowner
, chgroup
, clear_suid
, clear_sgid
;
7296 required_action
= 0;
7300 * Quickly check for enforcement applicability.
7302 if (vfs_authopaque(vp
->v_mount
))
7306 * Check for attempts to set nonsensical fields.
7308 if (vap
->va_active
& VNODE_ATTR_RDONLY
) {
7309 KAUTH_DEBUG("ATTR - ERROR: attempt to set readonly attribute(s)");
7315 * We need to know if the caller is the superuser.
7317 cred
= vfs_context_ucred(ctx
);
7318 has_priv_suser
= kauth_cred_issuser(cred
);
7321 * If any of the following are changing, we need information from the old file:
7328 if (VATTR_IS_ACTIVE(vap
, va_uid
) ||
7329 VATTR_IS_ACTIVE(vap
, va_gid
) ||
7330 VATTR_IS_ACTIVE(vap
, va_mode
) ||
7331 VATTR_IS_ACTIVE(vap
, va_uuuid
) ||
7332 VATTR_IS_ACTIVE(vap
, va_guuid
)) {
7333 VATTR_WANTED(&ova
, va_mode
);
7334 VATTR_WANTED(&ova
, va_uid
);
7335 VATTR_WANTED(&ova
, va_gid
);
7336 VATTR_WANTED(&ova
, va_uuuid
);
7337 VATTR_WANTED(&ova
, va_guuid
);
7338 KAUTH_DEBUG("ATTR - security information changing, fetching existing attributes");
7342 * If timestamps are being changed, we need to know who the file is owned
7345 if (VATTR_IS_ACTIVE(vap
, va_create_time
) ||
7346 VATTR_IS_ACTIVE(vap
, va_change_time
) ||
7347 VATTR_IS_ACTIVE(vap
, va_modify_time
) ||
7348 VATTR_IS_ACTIVE(vap
, va_access_time
) ||
7349 VATTR_IS_ACTIVE(vap
, va_backup_time
)) {
7351 VATTR_WANTED(&ova
, va_uid
);
7352 #if 0 /* enable this when we support UUIDs as official owners */
7353 VATTR_WANTED(&ova
, va_uuuid
);
7355 KAUTH_DEBUG("ATTR - timestamps changing, fetching uid and GUID");
7359 * If flags are being changed, we need the old flags.
7361 if (VATTR_IS_ACTIVE(vap
, va_flags
)) {
7362 KAUTH_DEBUG("ATTR - flags changing, fetching old flags");
7363 VATTR_WANTED(&ova
, va_flags
);
7367 * If ACLs are being changed, we need the old ACLs.
7369 if (VATTR_IS_ACTIVE(vap
, va_acl
)) {
7370 KAUTH_DEBUG("ATTR - acl changing, fetching old flags");
7371 VATTR_WANTED(&ova
, va_acl
);
7375 * If the size is being set, make sure it's not a directory.
7377 if (VATTR_IS_ACTIVE(vap
, va_data_size
)) {
7378 /* size is meaningless on a directory, don't permit this */
7379 if (vnode_isdir(vp
)) {
7380 KAUTH_DEBUG("ATTR - ERROR: size change requested on a directory");
7389 KAUTH_DEBUG("ATTR - fetching old attributes %016llx", ova
.va_active
);
7390 if ((error
= vnode_getattr(vp
, &ova
, ctx
)) != 0) {
7391 KAUTH_DEBUG(" ERROR - got %d trying to get attributes", error
);
7396 * Size changes require write access to the file data.
7398 if (VATTR_IS_ACTIVE(vap
, va_data_size
)) {
7399 /* if we can't get the size, or it's different, we need write access */
7400 KAUTH_DEBUG("ATTR - size change, requiring WRITE_DATA");
7401 required_action
|= KAUTH_VNODE_WRITE_DATA
;
7405 * Changing timestamps?
7407 * Note that we are only called to authorize user-requested time changes;
7408 * side-effect time changes are not authorized. Authorisation is only
7409 * required for existing files.
7411 * Non-owners are not permitted to change the time on an existing
7412 * file to anything other than the current time.
7414 if (VATTR_IS_ACTIVE(vap
, va_create_time
) ||
7415 VATTR_IS_ACTIVE(vap
, va_change_time
) ||
7416 VATTR_IS_ACTIVE(vap
, va_modify_time
) ||
7417 VATTR_IS_ACTIVE(vap
, va_access_time
) ||
7418 VATTR_IS_ACTIVE(vap
, va_backup_time
)) {
7420 * The owner and root may set any timestamps they like,
7421 * provided that the file is not immutable. The owner still needs
7422 * WRITE_ATTRIBUTES (implied by ownership but still deniable).
7424 if (has_priv_suser
|| vauth_node_owner(&ova
, cred
)) {
7425 KAUTH_DEBUG("ATTR - root or owner changing timestamps");
7426 required_action
|= KAUTH_VNODE_CHECKIMMUTABLE
| KAUTH_VNODE_WRITE_ATTRIBUTES
;
7428 /* just setting the current time? */
7429 if (vap
->va_vaflags
& VA_UTIMES_NULL
) {
7430 KAUTH_DEBUG("ATTR - non-root/owner changing timestamps, requiring WRITE_ATTRIBUTES");
7431 required_action
|= KAUTH_VNODE_WRITE_ATTRIBUTES
;
7433 KAUTH_DEBUG("ATTR - ERROR: illegal timestamp modification attempted");
7441 * Changing file mode?
7443 if (VATTR_IS_ACTIVE(vap
, va_mode
) && VATTR_IS_SUPPORTED(&ova
, va_mode
) && (ova
.va_mode
!= vap
->va_mode
)) {
7444 KAUTH_DEBUG("ATTR - mode change from %06o to %06o", ova
.va_mode
, vap
->va_mode
);
7447 * Mode changes always have the same basic auth requirements.
7449 if (has_priv_suser
) {
7450 KAUTH_DEBUG("ATTR - superuser mode change, requiring immutability check");
7451 required_action
|= KAUTH_VNODE_CHECKIMMUTABLE
;
7453 /* need WRITE_SECURITY */
7454 KAUTH_DEBUG("ATTR - non-superuser mode change, requiring WRITE_SECURITY");
7455 required_action
|= KAUTH_VNODE_WRITE_SECURITY
;
7459 * Can't set the setgid bit if you're not in the group and not root. Have to have
7460 * existing group information in the case we're not setting it right now.
7462 if (vap
->va_mode
& S_ISGID
) {
7463 required_action
|= KAUTH_VNODE_CHECKIMMUTABLE
; /* always required */
7464 if (!has_priv_suser
) {
7465 if (VATTR_IS_ACTIVE(vap
, va_gid
)) {
7466 group
= vap
->va_gid
;
7467 } else if (VATTR_IS_SUPPORTED(&ova
, va_gid
)) {
7470 KAUTH_DEBUG("ATTR - ERROR: setgid but no gid available");
7475 * This might be too restrictive; WRITE_SECURITY might be implied by
7476 * membership in this case, rather than being an additional requirement.
7478 if ((error
= kauth_cred_ismember_gid(cred
, group
, &ismember
)) != 0) {
7479 KAUTH_DEBUG("ATTR - ERROR: got %d checking for membership in %d", error
, vap
->va_gid
);
7483 KAUTH_DEBUG(" DENIED - can't set SGID bit, not a member of %d", group
);
7491 * Can't set the setuid bit unless you're root or the file's owner.
7493 if (vap
->va_mode
& S_ISUID
) {
7494 required_action
|= KAUTH_VNODE_CHECKIMMUTABLE
; /* always required */
7495 if (!has_priv_suser
) {
7496 if (VATTR_IS_ACTIVE(vap
, va_uid
)) {
7497 owner
= vap
->va_uid
;
7498 } else if (VATTR_IS_SUPPORTED(&ova
, va_uid
)) {
7501 KAUTH_DEBUG("ATTR - ERROR: setuid but no uid available");
7505 if (owner
!= kauth_cred_getuid(cred
)) {
7507 * We could allow this if WRITE_SECURITY is permitted, perhaps.
7509 KAUTH_DEBUG("ATTR - ERROR: illegal attempt to set the setuid bit");
7518 * Validate/mask flags changes. This checks that only the flags in
7519 * the UF_SETTABLE mask are being set, and preserves the flags in
7520 * the SF_SETTABLE case.
7522 * Since flags changes may be made in conjunction with other changes,
7523 * we will ask the auth code to ignore immutability in the case that
7524 * the SF_* flags are not set and we are only manipulating the file flags.
7527 if (VATTR_IS_ACTIVE(vap
, va_flags
)) {
7528 /* compute changing flags bits */
7529 if (VATTR_IS_SUPPORTED(&ova
, va_flags
)) {
7530 fdelta
= vap
->va_flags
^ ova
.va_flags
;
7532 fdelta
= vap
->va_flags
;
7536 KAUTH_DEBUG("ATTR - flags changing, requiring WRITE_SECURITY");
7537 required_action
|= KAUTH_VNODE_WRITE_SECURITY
;
7539 /* check that changing bits are legal */
7540 if (has_priv_suser
) {
7542 * The immutability check will prevent us from clearing the SF_*
7543 * flags unless the system securelevel permits it, so just check
7544 * for legal flags here.
7546 if (fdelta
& ~(UF_SETTABLE
| SF_SETTABLE
)) {
7548 KAUTH_DEBUG(" DENIED - superuser attempt to set illegal flag(s)");
7552 if (fdelta
& ~UF_SETTABLE
) {
7554 KAUTH_DEBUG(" DENIED - user attempt to set illegal flag(s)");
7559 * If the caller has the ability to manipulate file flags,
7560 * security is not reduced by ignoring them for this operation.
7562 * A more complete test here would consider the 'after' states of the flags
7563 * to determine whether it would permit the operation, but this becomes
7566 * Ignoring immutability is conditional on securelevel; this does not bypass
7567 * the SF_* flags if securelevel > 0.
7569 required_action
|= KAUTH_VNODE_NOIMMUTABLE
;
7574 * Validate ownership information.
7583 * Note that if the filesystem didn't give us a UID, we expect that it doesn't
7584 * support them in general, and will ignore it if/when we try to set it.
7585 * We might want to clear the uid out of vap completely here.
7587 if (VATTR_IS_ACTIVE(vap
, va_uid
)) {
7588 if (VATTR_IS_SUPPORTED(&ova
, va_uid
) && (vap
->va_uid
!= ova
.va_uid
)) {
7589 if (!has_priv_suser
&& (kauth_cred_getuid(cred
) != vap
->va_uid
)) {
7590 KAUTH_DEBUG(" DENIED - non-superuser cannot change ownershipt to a third party");
7601 * Note that if the filesystem didn't give us a GID, we expect that it doesn't
7602 * support them in general, and will ignore it if/when we try to set it.
7603 * We might want to clear the gid out of vap completely here.
7605 if (VATTR_IS_ACTIVE(vap
, va_gid
)) {
7606 if (VATTR_IS_SUPPORTED(&ova
, va_gid
) && (vap
->va_gid
!= ova
.va_gid
)) {
7607 if (!has_priv_suser
) {
7608 if ((error
= kauth_cred_ismember_gid(cred
, vap
->va_gid
, &ismember
)) != 0) {
7609 KAUTH_DEBUG(" ERROR - got %d checking for membership in %d", error
, vap
->va_gid
);
7613 KAUTH_DEBUG(" DENIED - group change from %d to %d but not a member of target group",
7614 ova
.va_gid
, vap
->va_gid
);
7625 * Owner UUID being set or changed.
7627 if (VATTR_IS_ACTIVE(vap
, va_uuuid
)) {
7628 /* if the owner UUID is not actually changing ... */
7629 if (VATTR_IS_SUPPORTED(&ova
, va_uuuid
)) {
7630 if (kauth_guid_equal(&vap
->va_uuuid
, &ova
.va_uuuid
))
7631 goto no_uuuid_change
;
7634 * If the current owner UUID is a null GUID, check
7635 * it against the UUID corresponding to the owner UID.
7637 if (kauth_guid_equal(&ova
.va_uuuid
, &kauth_null_guid
) &&
7638 VATTR_IS_SUPPORTED(&ova
, va_uid
)) {
7641 if (kauth_cred_uid2guid(ova
.va_uid
, &uid_guid
) == 0 &&
7642 kauth_guid_equal(&vap
->va_uuuid
, &uid_guid
))
7643 goto no_uuuid_change
;
7648 * The owner UUID cannot be set by a non-superuser to anything other than
7649 * their own or a null GUID (to "unset" the owner UUID).
7650 * Note that file systems must be prepared to handle the
7651 * null UUID case in a manner appropriate for that file
7654 if (!has_priv_suser
) {
7655 if ((error
= kauth_cred_getguid(cred
, &changer
)) != 0) {
7656 KAUTH_DEBUG(" ERROR - got %d trying to get caller UUID", error
);
7657 /* XXX ENOENT here - no UUID - should perhaps become EPERM */
7660 if (!kauth_guid_equal(&vap
->va_uuuid
, &changer
) &&
7661 !kauth_guid_equal(&vap
->va_uuuid
, &kauth_null_guid
)) {
7662 KAUTH_DEBUG(" ERROR - cannot set supplied owner UUID - not us / null");
7672 * Group UUID being set or changed.
7674 if (VATTR_IS_ACTIVE(vap
, va_guuid
)) {
7675 /* if the group UUID is not actually changing ... */
7676 if (VATTR_IS_SUPPORTED(&ova
, va_guuid
)) {
7677 if (kauth_guid_equal(&vap
->va_guuid
, &ova
.va_guuid
))
7678 goto no_guuid_change
;
7681 * If the current group UUID is a null UUID, check
7682 * it against the UUID corresponding to the group GID.
7684 if (kauth_guid_equal(&ova
.va_guuid
, &kauth_null_guid
) &&
7685 VATTR_IS_SUPPORTED(&ova
, va_gid
)) {
7688 if (kauth_cred_gid2guid(ova
.va_gid
, &gid_guid
) == 0 &&
7689 kauth_guid_equal(&vap
->va_guuid
, &gid_guid
))
7690 goto no_guuid_change
;
7695 * The group UUID cannot be set by a non-superuser to anything other than
7696 * one of which they are a member or a null GUID (to "unset"
7698 * Note that file systems must be prepared to handle the
7699 * null UUID case in a manner appropriate for that file
7702 if (!has_priv_suser
) {
7703 if (kauth_guid_equal(&vap
->va_guuid
, &kauth_null_guid
))
7705 else if ((error
= kauth_cred_ismember_guid(cred
, &vap
->va_guuid
, &ismember
)) != 0) {
7706 KAUTH_DEBUG(" ERROR - got %d trying to check group membership", error
);
7710 KAUTH_DEBUG(" ERROR - cannot set supplied group UUID - not a member / null");
7720 * Compute authorisation for group/ownership changes.
7722 if (chowner
|| chgroup
|| clear_suid
|| clear_sgid
) {
7723 if (has_priv_suser
) {
7724 KAUTH_DEBUG("ATTR - superuser changing file owner/group, requiring immutability check");
7725 required_action
|= KAUTH_VNODE_CHECKIMMUTABLE
;
7728 KAUTH_DEBUG("ATTR - ownership change, requiring TAKE_OWNERSHIP");
7729 required_action
|= KAUTH_VNODE_TAKE_OWNERSHIP
;
7731 if (chgroup
&& !chowner
) {
7732 KAUTH_DEBUG("ATTR - group change, requiring WRITE_SECURITY");
7733 required_action
|= KAUTH_VNODE_WRITE_SECURITY
;
7736 /* clear set-uid and set-gid bits as required by Posix */
7737 if (VATTR_IS_ACTIVE(vap
, va_mode
)) {
7738 newmode
= vap
->va_mode
;
7739 } else if (VATTR_IS_SUPPORTED(&ova
, va_mode
)) {
7740 newmode
= ova
.va_mode
;
7742 KAUTH_DEBUG("CHOWN - trying to change owner but cannot get mode from filesystem to mask setugid bits");
7745 if (newmode
& (S_ISUID
| S_ISGID
)) {
7746 VATTR_SET(vap
, va_mode
, newmode
& ~(S_ISUID
| S_ISGID
));
7747 KAUTH_DEBUG("CHOWN - masking setugid bits from mode %o to %o", newmode
, vap
->va_mode
);
7753 * Authorise changes in the ACL.
7755 if (VATTR_IS_ACTIVE(vap
, va_acl
)) {
7757 /* no existing ACL */
7758 if (!VATTR_IS_ACTIVE(&ova
, va_acl
) || (ova
.va_acl
== NULL
)) {
7761 if (vap
->va_acl
!= NULL
) {
7762 required_action
|= KAUTH_VNODE_WRITE_SECURITY
;
7763 KAUTH_DEBUG("CHMOD - adding ACL");
7766 /* removing an existing ACL */
7767 } else if (vap
->va_acl
== NULL
) {
7768 required_action
|= KAUTH_VNODE_WRITE_SECURITY
;
7769 KAUTH_DEBUG("CHMOD - removing ACL");
7771 /* updating an existing ACL */
7773 if (vap
->va_acl
->acl_entrycount
!= ova
.va_acl
->acl_entrycount
) {
7774 /* entry count changed, must be different */
7775 required_action
|= KAUTH_VNODE_WRITE_SECURITY
;
7776 KAUTH_DEBUG("CHMOD - adding/removing ACL entries");
7777 } else if (vap
->va_acl
->acl_entrycount
> 0) {
7778 /* both ACLs have the same ACE count, said count is 1 or more, bitwise compare ACLs */
7779 if (memcmp(&vap
->va_acl
->acl_ace
[0], &ova
.va_acl
->acl_ace
[0],
7780 sizeof(struct kauth_ace
) * vap
->va_acl
->acl_entrycount
)) {
7781 required_action
|= KAUTH_VNODE_WRITE_SECURITY
;
7782 KAUTH_DEBUG("CHMOD - changing ACL entries");
7789 * Other attributes that require authorisation.
7791 if (VATTR_IS_ACTIVE(vap
, va_encoding
))
7792 required_action
|= KAUTH_VNODE_WRITE_ATTRIBUTES
;
7795 if (VATTR_IS_SUPPORTED(&ova
, va_acl
) && (ova
.va_acl
!= NULL
))
7796 kauth_acl_free(ova
.va_acl
);
7798 *actionp
= required_action
;
7803 setlocklocal_callback(struct vnode
*vp
, __unused
void *cargs
)
7805 vnode_lock_spin(vp
);
7806 vp
->v_flag
|= VLOCKLOCAL
;
7809 return (VNODE_RETURNED
);
7813 vfs_setlocklocal(mount_t mp
)
7815 mount_lock_spin(mp
);
7816 mp
->mnt_kern_flag
|= MNTK_LOCK_LOCAL
;
7820 * The number of active vnodes is expected to be
7821 * very small when vfs_setlocklocal is invoked.
7823 vnode_iterate(mp
, 0, setlocklocal_callback
, NULL
);
7827 vfs_setunmountpreflight(mount_t mp
)
7829 mount_lock_spin(mp
);
7830 mp
->mnt_kern_flag
|= MNTK_UNMOUNT_PREFLIGHT
;
7835 vfs_setcompoundopen(mount_t mp
)
7837 mount_lock_spin(mp
);
7838 mp
->mnt_compound_ops
|= COMPOUND_VNOP_OPEN
;
7843 vn_setunionwait(vnode_t vp
)
7845 vnode_lock_spin(vp
);
7846 vp
->v_flag
|= VISUNION
;
7852 vn_checkunionwait(vnode_t vp
)
7854 vnode_lock_spin(vp
);
7855 while ((vp
->v_flag
& VISUNION
) == VISUNION
)
7856 msleep((caddr_t
)&vp
->v_flag
, &vp
->v_lock
, 0, 0, 0);
7861 vn_clearunionwait(vnode_t vp
, int locked
)
7864 vnode_lock_spin(vp
);
7865 if((vp
->v_flag
& VISUNION
) == VISUNION
) {
7866 vp
->v_flag
&= ~VISUNION
;
7867 wakeup((caddr_t
)&vp
->v_flag
);
7874 * XXX - get "don't trigger mounts" flag for thread; used by autofs.
7876 extern int thread_notrigger(void);
7879 thread_notrigger(void)
7881 struct uthread
*uth
= (struct uthread
*)get_bsdthread_info(current_thread());
7882 return (uth
->uu_notrigger
);
7886 * Removes orphaned apple double files during a rmdir
7888 * 1. vnode_suspend().
7889 * 2. Call VNOP_READDIR() till the end of directory is reached.
7890 * 3. Check if the directory entries returned are regular files with name starting with "._". If not, return ENOTEMPTY.
7891 * 4. Continue (2) and (3) till end of directory is reached.
7892 * 5. If all the entries in the directory were files with "._" name, delete all the files.
7894 * 7. If deletion of all files succeeded, call VNOP_RMDIR() again.
7897 errno_t
rmdir_remove_orphaned_appleDouble(vnode_t vp
, vfs_context_t ctx
, int * restart_flag
)
7900 #define UIO_BUFF_SIZE 2048
7902 int eofflag
, siz
= UIO_BUFF_SIZE
, nentries
= 0;
7903 int open_flag
= 0, full_erase_flag
= 0;
7904 char uio_buf
[ UIO_SIZEOF(1) ];
7905 char *rbuf
= NULL
, *cpos
, *cend
;
7906 struct nameidata nd_temp
;
7910 error
= vnode_suspend(vp
);
7913 * restart_flag is set so that the calling rmdir sleeps and resets
7923 MALLOC(rbuf
, caddr_t
, siz
, M_TEMP
, M_WAITOK
);
7925 auio
= uio_createwithbuffer(1, 0, UIO_SYSSPACE
, UIO_READ
,
7926 &uio_buf
[0], sizeof(uio_buf
));
7927 if (!rbuf
|| !auio
) {
7932 uio_setoffset(auio
,0);
7936 if ((error
= VNOP_OPEN(vp
, FREAD
, ctx
)))
7942 * First pass checks if all files are appleDouble files.
7946 siz
= UIO_BUFF_SIZE
;
7947 uio_reset(auio
, uio_offset(auio
), UIO_SYSSPACE
, UIO_READ
);
7948 uio_addiov(auio
, CAST_USER_ADDR_T(rbuf
), UIO_BUFF_SIZE
);
7950 if((error
= VNOP_READDIR(vp
, auio
, 0, &eofflag
, &nentries
, ctx
)))
7953 if (uio_resid(auio
) != 0)
7954 siz
-= uio_resid(auio
);
7957 * Iterate through directory
7961 dp
= (struct dirent
*) cpos
;
7966 while ((cpos
< cend
)) {
7968 * Check for . and .. as well as directories
7970 if (dp
->d_ino
!= 0 &&
7971 !((dp
->d_namlen
== 1 && dp
->d_name
[0] == '.') ||
7972 (dp
->d_namlen
== 2 && dp
->d_name
[0] == '.' && dp
->d_name
[1] == '.'))) {
7974 * Check for irregular files and ._ files
7975 * If there is a ._._ file abort the op
7977 if ( dp
->d_namlen
< 2 ||
7978 strncmp(dp
->d_name
,"._",2) ||
7979 (dp
->d_namlen
>= 4 && !strncmp(&(dp
->d_name
[2]), "._",2))) {
7984 cpos
+= dp
->d_reclen
;
7985 dp
= (struct dirent
*)cpos
;
7989 * workaround for HFS/NFS setting eofflag before end of file
7991 if (vp
->v_tag
== VT_HFS
&& nentries
> 2)
7994 if (vp
->v_tag
== VT_NFS
) {
7995 if (eofflag
&& !full_erase_flag
) {
7996 full_erase_flag
= 1;
7998 uio_reset(auio
, 0, UIO_SYSSPACE
, UIO_READ
);
8000 else if (!eofflag
&& full_erase_flag
)
8001 full_erase_flag
= 0;
8006 * If we've made it here all the files in the dir are ._ files.
8007 * We can delete the files even though the node is suspended
8008 * because we are the owner of the file.
8011 uio_reset(auio
, 0, UIO_SYSSPACE
, UIO_READ
);
8013 full_erase_flag
= 0;
8016 siz
= UIO_BUFF_SIZE
;
8017 uio_reset(auio
, uio_offset(auio
), UIO_SYSSPACE
, UIO_READ
);
8018 uio_addiov(auio
, CAST_USER_ADDR_T(rbuf
), UIO_BUFF_SIZE
);
8020 error
= VNOP_READDIR(vp
, auio
, 0, &eofflag
, &nentries
, ctx
);
8025 if (uio_resid(auio
) != 0)
8026 siz
-= uio_resid(auio
);
8029 * Iterate through directory
8033 dp
= (struct dirent
*) cpos
;
8038 while ((cpos
< cend
)) {
8040 * Check for . and .. as well as directories
8042 if (dp
->d_ino
!= 0 &&
8043 !((dp
->d_namlen
== 1 && dp
->d_name
[0] == '.') ||
8044 (dp
->d_namlen
== 2 && dp
->d_name
[0] == '.' && dp
->d_name
[1] == '.'))
8047 NDINIT(&nd_temp
, DELETE
, OP_UNLINK
, USEDVP
,
8048 UIO_SYSSPACE
, CAST_USER_ADDR_T(dp
->d_name
),
8050 nd_temp
.ni_dvp
= vp
;
8051 error
= unlink1(ctx
, &nd_temp
, VNODE_REMOVE_SKIP_NAMESPACE_EVENT
);
8053 if (error
&& error
!= ENOENT
) {
8058 cpos
+= dp
->d_reclen
;
8059 dp
= (struct dirent
*)cpos
;
8063 * workaround for HFS/NFS setting eofflag before end of file
8065 if (vp
->v_tag
== VT_HFS
&& nentries
> 2)
8068 if (vp
->v_tag
== VT_NFS
) {
8069 if (eofflag
&& !full_erase_flag
) {
8070 full_erase_flag
= 1;
8072 uio_reset(auio
, 0, UIO_SYSSPACE
, UIO_READ
);
8074 else if (!eofflag
&& full_erase_flag
)
8075 full_erase_flag
= 0;
8085 VNOP_CLOSE(vp
, FREAD
, ctx
);
8099 lock_vnode_and_post(vnode_t vp
, int kevent_num
)
8101 /* Only take the lock if there's something there! */
8102 if (vp
->v_knotes
.slh_first
!= NULL
) {
8104 KNOTE(&vp
->v_knotes
, kevent_num
);
8110 static void record_vp(vnode_t vp
, int count
) {
8117 if ((vp
->v_flag
& VSYSTEM
))
8120 ut
= get_bsdthread_info(current_thread());
8121 ut
->uu_iocount
+= count
;
8124 if (ut
->uu_vpindex
< 32) {
8125 OSBacktrace((void **)&ut
->uu_pcs
[ut
->uu_vpindex
][0], 10);
8127 ut
->uu_vps
[ut
->uu_vpindex
] = vp
;
8137 #define TRIG_DEBUG 0
8140 #define TRIG_LOG(...) do { printf("%s: ", __FUNCTION__); printf(__VA_ARGS__); } while (0)
8142 #define TRIG_LOG(...)
8146 * Resolver result functions
8150 vfs_resolver_result(uint32_t seq
, enum resolver_status stat
, int aux
)
8153 * |<--- 32 --->|<--- 28 --->|<- 4 ->|
8154 * sequence auxiliary status
8156 return (((uint64_t)seq
) << 32) |
8157 (((uint64_t)(aux
& 0x0fffffff)) << 4) |
8158 (uint64_t)(stat
& 0x0000000F);
8161 enum resolver_status
8162 vfs_resolver_status(resolver_result_t result
)
8164 /* lower 4 bits is status */
8165 return (result
& 0x0000000F);
8169 vfs_resolver_sequence(resolver_result_t result
)
8171 /* upper 32 bits is sequence */
8172 return (uint32_t)(result
>> 32);
8176 vfs_resolver_auxiliary(resolver_result_t result
)
8178 /* 28 bits of auxiliary */
8179 return (int)(((uint32_t)(result
& 0xFFFFFFF0)) >> 4);
8184 * Call in for resolvers to update vnode trigger state
8187 vnode_trigger_update(vnode_t vp
, resolver_result_t result
)
8191 enum resolver_status stat
;
8193 if (vp
->v_resolve
== NULL
) {
8197 stat
= vfs_resolver_status(result
);
8198 seq
= vfs_resolver_sequence(result
);
8200 if ((stat
!= RESOLVER_RESOLVED
) && (stat
!= RESOLVER_UNRESOLVED
)) {
8205 lck_mtx_lock(&rp
->vr_lock
);
8207 if (seq
> rp
->vr_lastseq
) {
8208 if (stat
== RESOLVER_RESOLVED
)
8209 rp
->vr_flags
|= VNT_RESOLVED
;
8211 rp
->vr_flags
&= ~VNT_RESOLVED
;
8213 rp
->vr_lastseq
= seq
;
8216 lck_mtx_unlock(&rp
->vr_lock
);
8222 vnode_resolver_attach(vnode_t vp
, vnode_resolve_t rp
, boolean_t ref
)
8226 vnode_lock_spin(vp
);
8227 if (vp
->v_resolve
!= NULL
) {
8236 error
= vnode_ref_ext(vp
, O_EVTONLY
, VNODE_REF_FORCE
);
8238 panic("VNODE_REF_FORCE didn't help...");
8246 * VFS internal interfaces for vnode triggers
8248 * vnode must already have an io count on entry
8249 * v_resolve is stable when io count is non-zero
8252 vnode_resolver_create(mount_t mp
, vnode_t vp
, struct vnode_trigger_param
*tinfo
, boolean_t external
)
8259 /* minimum pointer test (debugging) */
8260 if (tinfo
->vnt_data
)
8261 byte
= *((char *)tinfo
->vnt_data
);
8263 MALLOC(rp
, vnode_resolve_t
, sizeof(*rp
), M_TEMP
, M_WAITOK
);
8267 lck_mtx_init(&rp
->vr_lock
, trigger_vnode_lck_grp
, trigger_vnode_lck_attr
);
8269 rp
->vr_resolve_func
= tinfo
->vnt_resolve_func
;
8270 rp
->vr_unresolve_func
= tinfo
->vnt_unresolve_func
;
8271 rp
->vr_rearm_func
= tinfo
->vnt_rearm_func
;
8272 rp
->vr_reclaim_func
= tinfo
->vnt_reclaim_func
;
8273 rp
->vr_data
= tinfo
->vnt_data
;
8275 rp
->vr_flags
= tinfo
->vnt_flags
& VNT_VALID_MASK
;
8277 rp
->vr_flags
|= VNT_EXTERNAL
;
8280 result
= vnode_resolver_attach(vp
, rp
, external
);
8286 OSAddAtomic(1, &mp
->mnt_numtriggers
);
8297 vnode_resolver_release(vnode_resolve_t rp
)
8300 * Give them a chance to free any private data
8302 if (rp
->vr_data
&& rp
->vr_reclaim_func
) {
8303 rp
->vr_reclaim_func(NULLVP
, rp
->vr_data
);
8306 lck_mtx_destroy(&rp
->vr_lock
, trigger_vnode_lck_grp
);
8311 /* Called after the vnode has been drained */
8313 vnode_resolver_detach(vnode_t vp
)
8318 mp
= vnode_mount(vp
);
8322 vp
->v_resolve
= NULL
;
8325 if ((rp
->vr_flags
& VNT_EXTERNAL
) != 0) {
8326 vnode_rele_ext(vp
, O_EVTONLY
, 1);
8329 vnode_resolver_release(rp
);
8331 /* Keep count of active trigger vnodes per mount */
8332 OSAddAtomic(-1, &mp
->mnt_numtriggers
);
8336 * Pathname operations that don't trigger a mount for trigger vnodes
8338 static const u_int64_t ignorable_pathops_mask
=
8344 1LL << OP_LISTXATTR
;
8347 vfs_istraditionaltrigger(enum path_operation op
, const struct componentname
*cnp
)
8349 if (cnp
->cn_flags
& ISLASTCN
)
8350 return ((1LL << op
) & ignorable_pathops_mask
) == 0;
8357 vnode_trigger_rearm(vnode_t vp
, vfs_context_t ctx
)
8360 resolver_result_t result
;
8361 enum resolver_status status
;
8364 if ((vp
->v_resolve
== NULL
) ||
8365 (vp
->v_resolve
->vr_rearm_func
== NULL
) ||
8366 (vp
->v_resolve
->vr_flags
& VNT_AUTO_REARM
) == 0) {
8371 lck_mtx_lock(&rp
->vr_lock
);
8374 * Check if VFS initiated this unmount. If so, we'll catch it after the unresolve completes.
8376 if (rp
->vr_flags
& VNT_VFS_UNMOUNTED
) {
8377 lck_mtx_unlock(&rp
->vr_lock
);
8381 /* Check if this vnode is already armed */
8382 if ((rp
->vr_flags
& VNT_RESOLVED
) == 0) {
8383 lck_mtx_unlock(&rp
->vr_lock
);
8387 lck_mtx_unlock(&rp
->vr_lock
);
8389 result
= rp
->vr_rearm_func(vp
, 0, rp
->vr_data
, ctx
);
8390 status
= vfs_resolver_status(result
);
8391 seq
= vfs_resolver_sequence(result
);
8393 lck_mtx_lock(&rp
->vr_lock
);
8394 if (seq
> rp
->vr_lastseq
) {
8395 if (status
== RESOLVER_UNRESOLVED
)
8396 rp
->vr_flags
&= ~VNT_RESOLVED
;
8397 rp
->vr_lastseq
= seq
;
8399 lck_mtx_unlock(&rp
->vr_lock
);
8404 vnode_trigger_resolve(vnode_t vp
, struct nameidata
*ndp
, vfs_context_t ctx
)
8407 enum path_operation op
;
8408 resolver_result_t result
;
8409 enum resolver_status status
;
8412 /* Only trigger on topmost vnodes */
8413 if ((vp
->v_resolve
== NULL
) ||
8414 (vp
->v_resolve
->vr_resolve_func
== NULL
) ||
8415 (vp
->v_mountedhere
!= NULL
)) {
8420 lck_mtx_lock(&rp
->vr_lock
);
8422 /* Check if this vnode is already resolved */
8423 if (rp
->vr_flags
& VNT_RESOLVED
) {
8424 lck_mtx_unlock(&rp
->vr_lock
);
8428 lck_mtx_unlock(&rp
->vr_lock
);
8432 * assumes that resolver will not access this trigger vnode (otherwise the kernel will deadlock)
8433 * is there anyway to know this???
8434 * there can also be other legitimate lookups in parallel
8436 * XXX - should we call this on a separate thread with a timeout?
8438 * XXX - should we use ISLASTCN to pick the op value??? Perhaps only leafs should
8439 * get the richer set and non-leafs should get generic OP_LOOKUP? TBD
8441 op
= (ndp
->ni_op
< OP_MAXOP
) ? ndp
->ni_op
: OP_LOOKUP
;
8443 result
= rp
->vr_resolve_func(vp
, &ndp
->ni_cnd
, op
, 0, rp
->vr_data
, ctx
);
8444 status
= vfs_resolver_status(result
);
8445 seq
= vfs_resolver_sequence(result
);
8447 lck_mtx_lock(&rp
->vr_lock
);
8448 if (seq
> rp
->vr_lastseq
) {
8449 if (status
== RESOLVER_RESOLVED
)
8450 rp
->vr_flags
|= VNT_RESOLVED
;
8451 rp
->vr_lastseq
= seq
;
8453 lck_mtx_unlock(&rp
->vr_lock
);
8455 /* On resolver errors, propagate the error back up */
8456 return (status
== RESOLVER_ERROR
? vfs_resolver_auxiliary(result
) : 0);
8460 vnode_trigger_unresolve(vnode_t vp
, int flags
, vfs_context_t ctx
)
8463 resolver_result_t result
;
8464 enum resolver_status status
;
8467 if ((vp
->v_resolve
== NULL
) || (vp
->v_resolve
->vr_unresolve_func
== NULL
)) {
8472 lck_mtx_lock(&rp
->vr_lock
);
8474 /* Check if this vnode is already resolved */
8475 if ((rp
->vr_flags
& VNT_RESOLVED
) == 0) {
8476 printf("vnode_trigger_unresolve: not currently resolved\n");
8477 lck_mtx_unlock(&rp
->vr_lock
);
8481 rp
->vr_flags
|= VNT_VFS_UNMOUNTED
;
8483 lck_mtx_unlock(&rp
->vr_lock
);
8487 * assumes that resolver will not access this trigger vnode (otherwise the kernel will deadlock)
8488 * there can also be other legitimate lookups in parallel
8490 * XXX - should we call this on a separate thread with a timeout?
8493 result
= rp
->vr_unresolve_func(vp
, flags
, rp
->vr_data
, ctx
);
8494 status
= vfs_resolver_status(result
);
8495 seq
= vfs_resolver_sequence(result
);
8497 lck_mtx_lock(&rp
->vr_lock
);
8498 if (seq
> rp
->vr_lastseq
) {
8499 if (status
== RESOLVER_UNRESOLVED
)
8500 rp
->vr_flags
&= ~VNT_RESOLVED
;
8501 rp
->vr_lastseq
= seq
;
8503 rp
->vr_flags
&= ~VNT_VFS_UNMOUNTED
;
8504 lck_mtx_unlock(&rp
->vr_lock
);
8506 /* On resolver errors, propagate the error back up */
8507 return (status
== RESOLVER_ERROR
? vfs_resolver_auxiliary(result
) : 0);
8511 triggerisdescendant(mount_t mp
, mount_t rmp
)
8516 * walk up vnode covered chain looking for a match
8518 name_cache_lock_shared();
8523 /* did we encounter "/" ? */
8524 if (mp
->mnt_flag
& MNT_ROOTFS
)
8527 vp
= mp
->mnt_vnodecovered
;
8538 name_cache_unlock();
8543 struct trigger_unmount_info
{
8548 uint32_t trigger_vid
;
8553 trigger_unmount_callback(mount_t mp
, void * arg
)
8555 struct trigger_unmount_info
* infop
= (struct trigger_unmount_info
*)arg
;
8556 boolean_t mountedtrigger
= FALSE
;
8559 * When we encounter the top level mount we're done
8561 if (mp
== infop
->top_mp
)
8562 return (VFS_RETURNED_DONE
);
8564 if ((mp
->mnt_vnodecovered
== NULL
) ||
8565 (vnode_getwithref(mp
->mnt_vnodecovered
) != 0)) {
8566 return (VFS_RETURNED
);
8569 if ((mp
->mnt_vnodecovered
->v_mountedhere
== mp
) &&
8570 (mp
->mnt_vnodecovered
->v_resolve
!= NULL
) &&
8571 (mp
->mnt_vnodecovered
->v_resolve
->vr_flags
& VNT_RESOLVED
)) {
8572 mountedtrigger
= TRUE
;
8574 vnode_put(mp
->mnt_vnodecovered
);
8577 * When we encounter a mounted trigger, check if its under the top level mount
8579 if ( !mountedtrigger
|| !triggerisdescendant(mp
, infop
->top_mp
) )
8580 return (VFS_RETURNED
);
8583 * Process any pending nested mount (now that its not referenced)
8585 if ((infop
->trigger_vp
!= NULLVP
) &&
8586 (vnode_getwithvid(infop
->trigger_vp
, infop
->trigger_vid
) == 0)) {
8587 vnode_t vp
= infop
->trigger_vp
;
8590 infop
->trigger_vp
= NULLVP
;
8592 if (mp
== vp
->v_mountedhere
) {
8594 printf("trigger_unmount_callback: unexpected match '%s'\n",
8595 mp
->mnt_vfsstat
.f_mntonname
);
8596 return (VFS_RETURNED
);
8598 if (infop
->trigger_mp
!= vp
->v_mountedhere
) {
8600 printf("trigger_unmount_callback: trigger mnt changed! (%p != %p)\n",
8601 infop
->trigger_mp
, vp
->v_mountedhere
);
8605 error
= vnode_trigger_unresolve(vp
, infop
->flags
, infop
->ctx
);
8608 printf("unresolving: '%s', err %d\n",
8609 vp
->v_mountedhere
? vp
->v_mountedhere
->mnt_vfsstat
.f_mntonname
:
8611 return (VFS_RETURNED_DONE
); /* stop iteration on errors */
8616 * We can't call resolver here since we hold a mount iter
8617 * ref on mp so save its covered vp for later processing
8619 infop
->trigger_vp
= mp
->mnt_vnodecovered
;
8620 if ((infop
->trigger_vp
!= NULLVP
) &&
8621 (vnode_getwithref(infop
->trigger_vp
) == 0)) {
8622 if (infop
->trigger_vp
->v_mountedhere
== mp
) {
8623 infop
->trigger_vid
= infop
->trigger_vp
->v_id
;
8624 infop
->trigger_mp
= mp
;
8626 vnode_put(infop
->trigger_vp
);
8629 return (VFS_RETURNED
);
8633 * Attempt to unmount any trigger mounts nested underneath a mount.
8634 * This is a best effort attempt and no retries are performed here.
8636 * Note: mp->mnt_rwlock is held exclusively on entry (so be carefull)
8640 vfs_nested_trigger_unmounts(mount_t mp
, int flags
, vfs_context_t ctx
)
8642 struct trigger_unmount_info info
;
8644 /* Must have trigger vnodes */
8645 if (mp
->mnt_numtriggers
== 0) {
8648 /* Avoid recursive requests (by checking covered vnode) */
8649 if ((mp
->mnt_vnodecovered
!= NULL
) &&
8650 (vnode_getwithref(mp
->mnt_vnodecovered
) == 0)) {
8651 boolean_t recursive
= FALSE
;
8653 if ((mp
->mnt_vnodecovered
->v_mountedhere
== mp
) &&
8654 (mp
->mnt_vnodecovered
->v_resolve
!= NULL
) &&
8655 (mp
->mnt_vnodecovered
->v_resolve
->vr_flags
& VNT_VFS_UNMOUNTED
)) {
8658 vnode_put(mp
->mnt_vnodecovered
);
8664 * Attempt to unmount any nested trigger mounts (best effort)
8668 info
.trigger_vp
= NULLVP
;
8669 info
.trigger_vid
= 0;
8670 info
.trigger_mp
= NULL
;
8673 (void) vfs_iterate(VFS_ITERATE_TAIL_FIRST
, trigger_unmount_callback
, &info
);
8676 * Process remaining nested mount (now that its not referenced)
8678 if ((info
.trigger_vp
!= NULLVP
) &&
8679 (vnode_getwithvid(info
.trigger_vp
, info
.trigger_vid
) == 0)) {
8680 vnode_t vp
= info
.trigger_vp
;
8682 if (info
.trigger_mp
== vp
->v_mountedhere
) {
8683 (void) vnode_trigger_unresolve(vp
, flags
, ctx
);
8690 vfs_addtrigger(mount_t mp
, const char *relpath
, struct vnode_trigger_info
*vtip
, vfs_context_t ctx
)
8692 struct nameidata nd
;
8695 struct vnode_trigger_param vtp
;
8698 * Must be called for trigger callback, wherein rwlock is held
8700 lck_rw_assert(&mp
->mnt_rwlock
, LCK_RW_ASSERT_HELD
);
8702 TRIG_LOG("Adding trigger at %s\n", relpath
);
8703 TRIG_LOG("Trying VFS_ROOT\n");
8706 * We do a lookup starting at the root of the mountpoint, unwilling
8707 * to cross into other mountpoints.
8709 res
= VFS_ROOT(mp
, &rvp
, ctx
);
8714 TRIG_LOG("Trying namei\n");
8716 NDINIT(&nd
, LOOKUP
, OP_LOOKUP
, USEDVP
| NOCROSSMOUNT
| FOLLOW
, UIO_SYSSPACE
,
8717 CAST_USER_ADDR_T(relpath
), ctx
);
8729 TRIG_LOG("Trying vnode_resolver_create()\n");
8732 * Set up blob. vnode_create() takes a larger structure
8733 * with creation info, and we needed something different
8734 * for this case. One needs to win, or we need to munge both;
8735 * vnode_create() wins.
8737 bzero(&vtp
, sizeof(vtp
));
8738 vtp
.vnt_resolve_func
= vtip
->vti_resolve_func
;
8739 vtp
.vnt_unresolve_func
= vtip
->vti_unresolve_func
;
8740 vtp
.vnt_rearm_func
= vtip
->vti_rearm_func
;
8741 vtp
.vnt_reclaim_func
= vtip
->vti_reclaim_func
;
8742 vtp
.vnt_reclaim_func
= vtip
->vti_reclaim_func
;
8743 vtp
.vnt_data
= vtip
->vti_data
;
8744 vtp
.vnt_flags
= vtip
->vti_flags
;
8746 res
= vnode_resolver_create(mp
, vp
, &vtp
, TRUE
);
8749 TRIG_LOG("Returning %d\n", res
);
8753 #endif /* CONFIG_TRIGGERS */