2 * Copyright (c) 2000-2018 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
79 #include <sys/param.h>
80 #include <sys/systm.h>
81 #include <sys/proc_internal.h>
82 #include <sys/kauth.h>
83 #include <sys/mount_internal.h>
86 #include <sys/vnode.h>
87 #include <sys/vnode_internal.h>
89 #include <sys/namei.h>
90 #include <sys/ucred.h>
91 #include <sys/buf_internal.h>
92 #include <sys/errno.h>
93 #include <sys/malloc.h>
94 #include <sys/uio_internal.h>
96 #include <sys/domain.h>
98 #include <sys/syslog.h>
99 #include <sys/ubc_internal.h>
101 #include <sys/sysctl.h>
102 #include <sys/filedesc.h>
103 #include <sys/event.h>
104 #include <sys/kdebug.h>
105 #include <sys/kauth.h>
106 #include <sys/user.h>
107 #include <sys/systm.h>
108 #include <sys/kern_memorystatus.h>
109 #include <sys/lockf.h>
110 #include <miscfs/fifofs/fifo.h>
113 #include <machine/machine_routines.h>
115 #include <kern/assert.h>
116 #include <mach/kern_return.h>
117 #include <kern/thread.h>
118 #include <kern/sched_prim.h>
120 #include <miscfs/specfs/specdev.h>
122 #include <mach/mach_types.h>
123 #include <mach/memory_object_types.h>
124 #include <mach/memory_object_control.h>
126 #include <kern/kalloc.h> /* kalloc()/kfree() */
127 #include <kern/clock.h> /* delay_for_interval() */
128 #include <libkern/OSAtomic.h> /* OSAddAtomic() */
130 #include <console/video_console.h>
134 #include <libkern/OSDebug.h>
137 #include <vm/vm_protos.h> /* vnode_pager_vrele() */
140 #include <security/mac_framework.h>
143 #include <vfs/vfs_disk_conditioner.h>
144 #include <libkern/section_keywords.h>
146 extern lck_grp_t
*vnode_lck_grp
;
147 extern lck_attr_t
*vnode_lck_attr
;
150 extern lck_grp_t
*trigger_vnode_lck_grp
;
151 extern lck_attr_t
*trigger_vnode_lck_attr
;
154 extern lck_mtx_t
* mnt_list_mtx_lock
;
156 enum vtype iftovt_tab
[16] = {
157 VNON
, VFIFO
, VCHR
, VNON
, VDIR
, VNON
, VBLK
, VNON
,
158 VREG
, VNON
, VLNK
, VNON
, VSOCK
, VNON
, VNON
, VBAD
,
160 int vttoif_tab
[9] = {
161 0, S_IFREG
, S_IFDIR
, S_IFBLK
, S_IFCHR
, S_IFLNK
,
162 S_IFSOCK
, S_IFIFO
, S_IFMT
,
166 /* XXX These should be in a BSD accessible Mach header, but aren't. */
167 extern void memory_object_mark_used(
168 memory_object_control_t control
);
170 extern void memory_object_mark_unused(
171 memory_object_control_t control
,
174 extern void memory_object_mark_io_tracking(
175 memory_object_control_t control
);
177 /* XXX next protptype should be from <nfs/nfs.h> */
178 extern int nfs_vinvalbuf(vnode_t
, int, vfs_context_t
, int);
180 extern int paniclog_append_noflush(const char *format
, ...);
182 /* XXX next prototytype should be from libsa/stdlib.h> but conflicts libkern */
183 __private_extern__
void qsort(
187 int (*)(const void *, const void *));
189 __private_extern__
void vntblinit(void);
190 __private_extern__
int unlink1(vfs_context_t
, vnode_t
, user_addr_t
,
193 extern int system_inshutdown
;
195 static void vnode_list_add(vnode_t
);
196 static void vnode_async_list_add(vnode_t
);
197 static void vnode_list_remove(vnode_t
);
198 static void vnode_list_remove_locked(vnode_t
);
200 static void vnode_abort_advlocks(vnode_t
);
201 static errno_t
vnode_drain(vnode_t
);
202 static void vgone(vnode_t
, int flags
);
203 static void vclean(vnode_t vp
, int flag
);
204 static void vnode_reclaim_internal(vnode_t
, int, int, int);
206 static void vnode_dropiocount (vnode_t
);
208 static vnode_t
checkalias(vnode_t vp
, dev_t nvp_rdev
);
209 static int vnode_reload(vnode_t
);
210 static int vnode_isinuse_locked(vnode_t
, int, int);
212 static int unmount_callback(mount_t
, __unused
void *);
214 static void insmntque(vnode_t vp
, mount_t mp
);
215 static int mount_getvfscnt(void);
216 static int mount_fillfsids(fsid_t
*, int );
217 static void vnode_iterate_setup(mount_t
);
218 int vnode_umount_preflight(mount_t
, vnode_t
, int);
219 static int vnode_iterate_prepare(mount_t
);
220 static int vnode_iterate_reloadq(mount_t
);
221 static void vnode_iterate_clear(mount_t
);
222 static mount_t
vfs_getvfs_locked(fsid_t
*);
223 static int vn_create_reg(vnode_t dvp
, vnode_t
*vpp
, struct nameidata
*ndp
,
224 struct vnode_attr
*vap
, uint32_t flags
, int fmode
, uint32_t *statusp
, vfs_context_t ctx
);
225 static int vnode_authattr_new_internal(vnode_t dvp
, struct vnode_attr
*vap
, int noauth
, uint32_t *defaulted_fieldsp
, vfs_context_t ctx
);
227 errno_t
rmdir_remove_orphaned_appleDouble(vnode_t
, vfs_context_t
, int *);
230 static void record_vp(vnode_t vp
, int count
);
233 #if CONFIG_JETSAM && (DEVELOPMENT || DEBUG)
234 extern int bootarg_no_vnode_jetsam
; /* from bsd_init.c default value is 0 */
235 #endif /* CONFIG_JETSAM && (DEVELOPMENT || DEBUG) */
237 boolean_t root_is_CF_drive
= FALSE
;
240 static int vnode_resolver_create(mount_t
, vnode_t
, struct vnode_trigger_param
*, boolean_t external
);
241 static void vnode_resolver_detach(vnode_t
);
244 TAILQ_HEAD(freelst
, vnode
) vnode_free_list
; /* vnode free list */
245 TAILQ_HEAD(deadlst
, vnode
) vnode_dead_list
; /* vnode dead list */
246 TAILQ_HEAD(async_work_lst
, vnode
) vnode_async_work_list
;
249 TAILQ_HEAD(ragelst
, vnode
) vnode_rage_list
; /* vnode rapid age list */
250 struct timeval rage_tv
;
254 #define RAGE_LIMIT_MIN 100
255 #define RAGE_TIME_LIMIT 5
257 struct mntlist mountlist
; /* mounted filesystem list */
258 static int nummounts
= 0;
261 #define VLISTCHECK(fun, vp, list) \
262 if ((vp)->v_freelist.tqe_prev == (struct vnode **)0xdeadb) \
263 panic("%s: %s vnode not on %slist", (fun), (list), (list));
265 #define VLISTCHECK(fun, vp, list)
266 #endif /* DIAGNOSTIC */
268 #define VLISTNONE(vp) \
270 (vp)->v_freelist.tqe_next = (struct vnode *)0; \
271 (vp)->v_freelist.tqe_prev = (struct vnode **)0xdeadb; \
274 #define VONLIST(vp) \
275 ((vp)->v_freelist.tqe_prev != (struct vnode **)0xdeadb)
277 /* remove a vnode from free vnode list */
278 #define VREMFREE(fun, vp) \
280 VLISTCHECK((fun), (vp), "free"); \
281 TAILQ_REMOVE(&vnode_free_list, (vp), v_freelist); \
287 /* remove a vnode from dead vnode list */
288 #define VREMDEAD(fun, vp) \
290 VLISTCHECK((fun), (vp), "dead"); \
291 TAILQ_REMOVE(&vnode_dead_list, (vp), v_freelist); \
293 vp->v_listflag &= ~VLIST_DEAD; \
298 /* remove a vnode from async work vnode list */
299 #define VREMASYNC_WORK(fun, vp) \
301 VLISTCHECK((fun), (vp), "async_work"); \
302 TAILQ_REMOVE(&vnode_async_work_list, (vp), v_freelist); \
304 vp->v_listflag &= ~VLIST_ASYNC_WORK; \
305 async_work_vnodes--; \
309 /* remove a vnode from rage vnode list */
310 #define VREMRAGE(fun, vp) \
312 if ( !(vp->v_listflag & VLIST_RAGE)) \
313 panic("VREMRAGE: vp not on rage list"); \
314 VLISTCHECK((fun), (vp), "rage"); \
315 TAILQ_REMOVE(&vnode_rage_list, (vp), v_freelist); \
317 vp->v_listflag &= ~VLIST_RAGE; \
321 static void async_work_continue(void);
324 * Initialize the vnode management data structures.
326 __private_extern__
void
329 thread_t thread
= THREAD_NULL
;
331 TAILQ_INIT(&vnode_free_list
);
332 TAILQ_INIT(&vnode_rage_list
);
333 TAILQ_INIT(&vnode_dead_list
);
334 TAILQ_INIT(&vnode_async_work_list
);
335 TAILQ_INIT(&mountlist
);
337 microuptime(&rage_tv
);
338 rage_limit
= desiredvnodes
/ 100;
340 if (rage_limit
< RAGE_LIMIT_MIN
)
341 rage_limit
= RAGE_LIMIT_MIN
;
344 * create worker threads
346 kernel_thread_start((thread_continue_t
)async_work_continue
, NULL
, &thread
);
347 thread_deallocate(thread
);
350 /* the timeout is in 10 msecs */
352 vnode_waitforwrites(vnode_t vp
, int output_target
, int slpflag
, int slptimeout
, const char *msg
) {
356 KERNEL_DEBUG(0x3010280 | DBG_FUNC_START
, (int)vp
, output_target
, vp
->v_numoutput
, 0, 0);
358 if (vp
->v_numoutput
> output_target
) {
364 while ((vp
->v_numoutput
> output_target
) && error
== 0) {
366 vp
->v_flag
|= VTHROTTLED
;
368 vp
->v_flag
|= VBWAIT
;
370 ts
.tv_sec
= (slptimeout
/100);
371 ts
.tv_nsec
= (slptimeout
% 1000) * 10 * NSEC_PER_USEC
* 1000 ;
372 error
= msleep((caddr_t
)&vp
->v_numoutput
, &vp
->v_lock
, (slpflag
| (PRIBIO
+ 1)), msg
, &ts
);
378 KERNEL_DEBUG(0x3010280 | DBG_FUNC_END
, (int)vp
, output_target
, vp
->v_numoutput
, error
, 0);
385 vnode_startwrite(vnode_t vp
) {
387 OSAddAtomic(1, &vp
->v_numoutput
);
392 vnode_writedone(vnode_t vp
)
397 OSAddAtomic(-1, &vp
->v_numoutput
);
401 if (vp
->v_numoutput
< 0)
402 panic("vnode_writedone: numoutput < 0");
404 if ((vp
->v_flag
& VTHROTTLED
)) {
405 vp
->v_flag
&= ~VTHROTTLED
;
408 if ((vp
->v_flag
& VBWAIT
) && (vp
->v_numoutput
== 0)) {
409 vp
->v_flag
&= ~VBWAIT
;
415 wakeup((caddr_t
)&vp
->v_numoutput
);
422 vnode_hasdirtyblks(vnode_t vp
)
424 struct cl_writebehind
*wbp
;
427 * Not taking the buf_mtxp as there is little
428 * point doing it. Even if the lock is taken the
429 * state can change right after that. If their
430 * needs to be a synchronization, it must be driven
433 if (vp
->v_dirtyblkhd
.lh_first
)
436 if (!UBCINFOEXISTS(vp
))
439 wbp
= vp
->v_ubcinfo
->cl_wbehind
;
441 if (wbp
&& (wbp
->cl_number
|| wbp
->cl_scmap
))
448 vnode_hascleanblks(vnode_t vp
)
451 * Not taking the buf_mtxp as there is little
452 * point doing it. Even if the lock is taken the
453 * state can change right after that. If their
454 * needs to be a synchronization, it must be driven
457 if (vp
->v_cleanblkhd
.lh_first
)
463 vnode_iterate_setup(mount_t mp
)
465 mp
->mnt_lflag
|= MNT_LITER
;
469 vnode_umount_preflight(mount_t mp
, vnode_t skipvp
, int flags
)
473 TAILQ_FOREACH(vp
, &mp
->mnt_vnodelist
, v_mntvnodes
) {
474 if (vp
->v_type
== VDIR
)
478 if ((flags
& SKIPSYSTEM
) && ((vp
->v_flag
& VSYSTEM
) || (vp
->v_flag
& VNOFLUSH
)))
480 if ((flags
& SKIPSWAP
) && (vp
->v_flag
& VSWAP
))
482 if ((flags
& WRITECLOSE
) && (vp
->v_writecount
== 0 || vp
->v_type
!= VREG
))
485 /* Look for busy vnode */
486 if ((vp
->v_usecount
!= 0) && ((vp
->v_usecount
- vp
->v_kusecount
) != 0)) {
489 } else if (vp
->v_iocount
> 0) {
490 /* Busy if iocount is > 0 for more than 3 seconds */
491 tsleep(&vp
->v_iocount
, PVFS
, "vnode_drain_network", 3 * hz
);
492 if (vp
->v_iocount
> 0)
502 * This routine prepares iteration by moving all the vnodes to worker queue
503 * called with mount lock held
506 vnode_iterate_prepare(mount_t mp
)
510 if (TAILQ_EMPTY(&mp
->mnt_vnodelist
)) {
515 vp
= TAILQ_FIRST(&mp
->mnt_vnodelist
);
516 vp
->v_mntvnodes
.tqe_prev
= &(mp
->mnt_workerqueue
.tqh_first
);
517 mp
->mnt_workerqueue
.tqh_first
= mp
->mnt_vnodelist
.tqh_first
;
518 mp
->mnt_workerqueue
.tqh_last
= mp
->mnt_vnodelist
.tqh_last
;
520 TAILQ_INIT(&mp
->mnt_vnodelist
);
521 if (mp
->mnt_newvnodes
.tqh_first
!= NULL
)
522 panic("vnode_iterate_prepare: newvnode when entering vnode");
523 TAILQ_INIT(&mp
->mnt_newvnodes
);
529 /* called with mount lock held */
531 vnode_iterate_reloadq(mount_t mp
)
535 /* add the remaining entries in workerq to the end of mount vnode list */
536 if (!TAILQ_EMPTY(&mp
->mnt_workerqueue
)) {
538 mvp
= TAILQ_LAST(&mp
->mnt_vnodelist
, vnodelst
);
540 /* Joining the workerque entities to mount vnode list */
542 mvp
->v_mntvnodes
.tqe_next
= mp
->mnt_workerqueue
.tqh_first
;
544 mp
->mnt_vnodelist
.tqh_first
= mp
->mnt_workerqueue
.tqh_first
;
545 mp
->mnt_workerqueue
.tqh_first
->v_mntvnodes
.tqe_prev
= mp
->mnt_vnodelist
.tqh_last
;
546 mp
->mnt_vnodelist
.tqh_last
= mp
->mnt_workerqueue
.tqh_last
;
547 TAILQ_INIT(&mp
->mnt_workerqueue
);
550 /* add the newvnodes to the head of mount vnode list */
551 if (!TAILQ_EMPTY(&mp
->mnt_newvnodes
)) {
553 nlvp
= TAILQ_LAST(&mp
->mnt_newvnodes
, vnodelst
);
555 mp
->mnt_newvnodes
.tqh_first
->v_mntvnodes
.tqe_prev
= &mp
->mnt_vnodelist
.tqh_first
;
556 nlvp
->v_mntvnodes
.tqe_next
= mp
->mnt_vnodelist
.tqh_first
;
557 if(mp
->mnt_vnodelist
.tqh_first
)
558 mp
->mnt_vnodelist
.tqh_first
->v_mntvnodes
.tqe_prev
= &nlvp
->v_mntvnodes
.tqe_next
;
560 mp
->mnt_vnodelist
.tqh_last
= mp
->mnt_newvnodes
.tqh_last
;
561 mp
->mnt_vnodelist
.tqh_first
= mp
->mnt_newvnodes
.tqh_first
;
562 TAILQ_INIT(&mp
->mnt_newvnodes
);
571 vnode_iterate_clear(mount_t mp
)
573 mp
->mnt_lflag
&= ~MNT_LITER
;
578 #include <i386/panic_hooks.h>
580 struct vnode_iterate_panic_hook
{
586 static void vnode_iterate_panic_hook(panic_hook_t
*hook_
)
588 struct vnode_iterate_panic_hook
*hook
= (struct vnode_iterate_panic_hook
*)hook_
;
589 panic_phys_range_t range
;
592 if (panic_phys_range_before(hook
->mp
, &phys
, &range
)) {
593 paniclog_append_noflush("mp = %p, phys = %p, prev (%p: %p-%p)\n",
594 hook
->mp
, phys
, range
.type
, range
.phys_start
,
595 range
.phys_start
+ range
.len
);
597 paniclog_append_noflush("mp = %p, phys = %p, prev (!)\n", hook
->mp
, phys
);
600 if (panic_phys_range_before(hook
->vp
, &phys
, &range
)) {
601 paniclog_append_noflush("vp = %p, phys = %p, prev (%p: %p-%p)\n",
602 hook
->vp
, phys
, range
.type
, range
.phys_start
,
603 range
.phys_start
+ range
.len
);
605 paniclog_append_noflush("vp = %p, phys = %p, prev (!)\n", hook
->vp
, phys
);
607 panic_dump_mem((void *)(((vm_offset_t
)hook
->mp
-4096) & ~4095), 12288);
609 #endif //CONFIG_EMBEDDED
612 vnode_iterate(mount_t mp
, int flags
, int (*callout
)(struct vnode
*, void *),
620 * The mount iterate mutex is held for the duration of the iteration.
621 * This can be done by a state flag on the mount structure but we can
622 * run into priority inversion issues sometimes.
623 * Using a mutex allows us to benefit from the priority donation
624 * mechanisms in the kernel for locks. This mutex should never be
625 * acquired in spin mode and it should be acquired before attempting to
626 * acquire the mount lock.
628 mount_iterate_lock(mp
);
632 vnode_iterate_setup(mp
);
634 /* If it returns 0 then there is nothing to do */
635 retval
= vnode_iterate_prepare(mp
);
638 vnode_iterate_clear(mp
);
640 mount_iterate_unlock(mp
);
645 struct vnode_iterate_panic_hook hook
;
648 panic_hook(&hook
.hook
, vnode_iterate_panic_hook
);
650 /* iterate over all the vnodes */
651 while (!TAILQ_EMPTY(&mp
->mnt_workerqueue
)) {
652 vp
= TAILQ_FIRST(&mp
->mnt_workerqueue
);
656 TAILQ_REMOVE(&mp
->mnt_workerqueue
, vp
, v_mntvnodes
);
657 TAILQ_INSERT_TAIL(&mp
->mnt_vnodelist
, vp
, v_mntvnodes
);
659 if ((vp
->v_data
== NULL
) || (vp
->v_type
== VNON
) || (vp
->v_mount
!= mp
)) {
664 if ( vget_internal(vp
, vid
, (flags
| VNODE_NODEAD
| VNODE_WITHID
| VNODE_NOSUSPEND
))) {
668 if (flags
& VNODE_RELOAD
) {
670 * we're reloading the filesystem
671 * cast out any inactive vnodes...
673 if (vnode_reload(vp
)) {
674 /* vnode will be recycled on the refcount drop */
681 retval
= callout(vp
, arg
);
685 case VNODE_RETURNED_DONE
:
687 if (retval
== VNODE_RETURNED_DONE
) {
694 case VNODE_CLAIMED_DONE
:
707 panic_unhook(&hook
.hook
);
709 (void)vnode_iterate_reloadq(mp
);
710 vnode_iterate_clear(mp
);
712 mount_iterate_unlock(mp
);
717 mount_lock_renames(mount_t mp
)
719 lck_mtx_lock(&mp
->mnt_renamelock
);
723 mount_unlock_renames(mount_t mp
)
725 lck_mtx_unlock(&mp
->mnt_renamelock
);
729 mount_iterate_lock(mount_t mp
)
731 lck_mtx_lock(&mp
->mnt_iter_lock
);
735 mount_iterate_unlock(mount_t mp
)
737 lck_mtx_unlock(&mp
->mnt_iter_lock
);
741 mount_lock(mount_t mp
)
743 lck_mtx_lock(&mp
->mnt_mlock
);
747 mount_lock_spin(mount_t mp
)
749 lck_mtx_lock_spin(&mp
->mnt_mlock
);
753 mount_unlock(mount_t mp
)
755 lck_mtx_unlock(&mp
->mnt_mlock
);
760 mount_ref(mount_t mp
, int locked
)
773 mount_drop(mount_t mp
, int locked
)
780 if (mp
->mnt_count
== 0 && (mp
->mnt_lflag
& MNT_LDRAIN
))
781 wakeup(&mp
->mnt_lflag
);
789 mount_iterref(mount_t mp
, int locked
)
795 if (mp
->mnt_iterref
< 0) {
806 mount_isdrained(mount_t mp
, int locked
)
812 if (mp
->mnt_iterref
< 0)
822 mount_iterdrop(mount_t mp
)
826 wakeup(&mp
->mnt_iterref
);
831 mount_iterdrain(mount_t mp
)
834 while (mp
->mnt_iterref
)
835 msleep((caddr_t
)&mp
->mnt_iterref
, mnt_list_mtx_lock
, PVFS
, "mount_iterdrain", NULL
);
836 /* mount iterations drained */
837 mp
->mnt_iterref
= -1;
841 mount_iterreset(mount_t mp
)
844 if (mp
->mnt_iterref
== -1)
849 /* always called with mount lock held */
851 mount_refdrain(mount_t mp
)
853 if (mp
->mnt_lflag
& MNT_LDRAIN
)
854 panic("already in drain");
855 mp
->mnt_lflag
|= MNT_LDRAIN
;
857 while (mp
->mnt_count
)
858 msleep((caddr_t
)&mp
->mnt_lflag
, &mp
->mnt_mlock
, PVFS
, "mount_drain", NULL
);
860 if (mp
->mnt_vnodelist
.tqh_first
!= NULL
)
861 panic("mount_refdrain: dangling vnode");
863 mp
->mnt_lflag
&= ~MNT_LDRAIN
;
868 /* Tags the mount point as not supportine extended readdir for NFS exports */
870 mount_set_noreaddirext(mount_t mp
) {
872 mp
->mnt_kern_flag
|= MNTK_DENY_READDIREXT
;
877 * Mark a mount point as busy. Used to synchronize access and to delay
881 vfs_busy(mount_t mp
, int flags
)
885 if (mp
->mnt_lflag
& MNT_LDEAD
)
890 if (mp
->mnt_lflag
& MNT_LUNMOUNT
) {
891 if (flags
& LK_NOWAIT
|| mp
->mnt_lflag
& MNT_LDEAD
) {
897 * Since all busy locks are shared except the exclusive
898 * lock granted when unmounting, the only place that a
899 * wakeup needs to be done is at the release of the
900 * exclusive lock at the end of dounmount.
902 mp
->mnt_lflag
|= MNT_LWAIT
;
903 msleep((caddr_t
)mp
, &mp
->mnt_mlock
, (PVFS
| PDROP
), "vfsbusy", NULL
);
909 lck_rw_lock_shared(&mp
->mnt_rwlock
);
912 * Until we are granted the rwlock, it's possible for the mount point to
913 * change state, so re-evaluate before granting the vfs_busy.
915 if (mp
->mnt_lflag
& (MNT_LDEAD
| MNT_LUNMOUNT
)) {
916 lck_rw_done(&mp
->mnt_rwlock
);
923 * Free a busy filesystem.
926 vfs_unbusy(mount_t mp
)
928 lck_rw_done(&mp
->mnt_rwlock
);
934 vfs_rootmountfailed(mount_t mp
) {
937 mp
->mnt_vtable
->vfc_refcount
--;
942 mount_lock_destroy(mp
);
945 mac_mount_label_destroy(mp
);
948 FREE_ZONE(mp
, sizeof(struct mount
), M_MOUNT
);
952 * Lookup a filesystem type, and if found allocate and initialize
953 * a mount structure for it.
955 * Devname is usually updated by mount(8) after booting.
958 vfs_rootmountalloc_internal(struct vfstable
*vfsp
, const char *devname
)
962 mp
= _MALLOC_ZONE(sizeof(struct mount
), M_MOUNT
, M_WAITOK
);
963 bzero((char *)mp
, sizeof(struct mount
));
965 /* Initialize the default IO constraints */
966 mp
->mnt_maxreadcnt
= mp
->mnt_maxwritecnt
= MAXPHYS
;
967 mp
->mnt_segreadcnt
= mp
->mnt_segwritecnt
= 32;
968 mp
->mnt_maxsegreadsize
= mp
->mnt_maxreadcnt
;
969 mp
->mnt_maxsegwritesize
= mp
->mnt_maxwritecnt
;
970 mp
->mnt_devblocksize
= DEV_BSIZE
;
971 mp
->mnt_alignmentmask
= PAGE_MASK
;
972 mp
->mnt_ioqueue_depth
= MNT_DEFAULT_IOQUEUE_DEPTH
;
975 mp
->mnt_realrootvp
= NULLVP
;
976 mp
->mnt_authcache_ttl
= CACHED_LOOKUP_RIGHT_TTL
;
977 mp
->mnt_throttle_mask
= LOWPRI_MAX_NUM_DEV
- 1;
978 mp
->mnt_devbsdunit
= 0;
981 (void)vfs_busy(mp
, LK_NOWAIT
);
983 TAILQ_INIT(&mp
->mnt_vnodelist
);
984 TAILQ_INIT(&mp
->mnt_workerqueue
);
985 TAILQ_INIT(&mp
->mnt_newvnodes
);
987 mp
->mnt_vtable
= vfsp
;
988 mp
->mnt_op
= vfsp
->vfc_vfsops
;
989 mp
->mnt_flag
= MNT_RDONLY
| MNT_ROOTFS
;
990 mp
->mnt_vnodecovered
= NULLVP
;
991 //mp->mnt_stat.f_type = vfsp->vfc_typenum;
992 mp
->mnt_flag
|= vfsp
->vfc_flags
& MNT_VISFLAGMASK
;
995 vfsp
->vfc_refcount
++;
998 strlcpy(mp
->mnt_vfsstat
.f_fstypename
, vfsp
->vfc_name
, MFSTYPENAMELEN
);
999 mp
->mnt_vfsstat
.f_mntonname
[0] = '/';
1000 /* XXX const poisoning layering violation */
1001 (void) copystr((const void *)devname
, mp
->mnt_vfsstat
.f_mntfromname
, MAXPATHLEN
- 1, NULL
);
1004 mac_mount_label_init(mp
);
1005 mac_mount_label_associate(vfs_context_kernel(), mp
);
1011 vfs_rootmountalloc(const char *fstypename
, const char *devname
, mount_t
*mpp
)
1013 struct vfstable
*vfsp
;
1015 for (vfsp
= vfsconf
; vfsp
; vfsp
= vfsp
->vfc_next
)
1016 if (!strncmp(vfsp
->vfc_name
, fstypename
,
1017 sizeof(vfsp
->vfc_name
)))
1022 *mpp
= vfs_rootmountalloc_internal(vfsp
, devname
);
1030 #define DBG_MOUNTROOT (FSDBG_CODE(DBG_MOUNT, 0))
1033 * Find an appropriate filesystem to use for the root. If a filesystem
1034 * has not been preselected, walk through the list of known filesystems
1035 * trying those that have mountroot routines, and try them until one
1036 * works or we have tried them all.
1038 extern int (*mountroot
)(void);
1046 struct vfstable
*vfsp
;
1047 vfs_context_t ctx
= vfs_context_kernel();
1048 struct vfs_attr vfsattr
;
1051 vnode_t bdevvp_rootvp
;
1053 KDBG_RELEASE(DBG_MOUNTROOT
| DBG_FUNC_START
);
1054 if (mountroot
!= NULL
) {
1056 * used for netboot which follows a different set of rules
1058 error
= (*mountroot
)();
1060 KDBG_RELEASE(DBG_MOUNTROOT
| DBG_FUNC_END
, error
, 0);
1063 if ((error
= bdevvp(rootdev
, &rootvp
))) {
1064 printf("vfs_mountroot: can't setup bdevvp\n");
1066 KDBG_RELEASE(DBG_MOUNTROOT
| DBG_FUNC_END
, error
, 1);
1070 * 4951998 - code we call in vfc_mountroot may replace rootvp
1071 * so keep a local copy for some house keeping.
1073 bdevvp_rootvp
= rootvp
;
1075 for (vfsp
= vfsconf
; vfsp
; vfsp
= vfsp
->vfc_next
) {
1076 if (vfsp
->vfc_mountroot
== NULL
1077 && !ISSET(vfsp
->vfc_vfsflags
, VFC_VFSCANMOUNTROOT
)) {
1081 mp
= vfs_rootmountalloc_internal(vfsp
, "root_device");
1082 mp
->mnt_devvp
= rootvp
;
1084 if (vfsp
->vfc_mountroot
)
1085 error
= (*vfsp
->vfc_mountroot
)(mp
, rootvp
, ctx
);
1087 error
= VFS_MOUNT(mp
, rootvp
, 0, ctx
);
1090 if ( bdevvp_rootvp
!= rootvp
) {
1093 * bump the iocount and fix up mnt_devvp for the
1094 * new rootvp (it will already have a usecount taken)...
1095 * drop the iocount and the usecount on the orignal
1096 * since we are no longer going to use it...
1098 vnode_getwithref(rootvp
);
1099 mp
->mnt_devvp
= rootvp
;
1101 vnode_rele(bdevvp_rootvp
);
1102 vnode_put(bdevvp_rootvp
);
1104 mp
->mnt_devvp
->v_specflags
|= SI_MOUNTEDON
;
1111 * cache the IO attributes for the underlying physical media...
1112 * an error return indicates the underlying driver doesn't
1113 * support all the queries necessary... however, reasonable
1114 * defaults will have been set, so no reason to bail or care
1116 vfs_init_io_attributes(rootvp
, mp
);
1118 if (mp
->mnt_ioflags
& MNT_IOFLAGS_FUSION_DRIVE
) {
1119 root_is_CF_drive
= TRUE
;
1123 * Shadow the VFC_VFSNATIVEXATTR flag to MNTK_EXTENDED_ATTRS.
1125 if (mp
->mnt_vtable
->vfc_vfsflags
& VFC_VFSNATIVEXATTR
) {
1126 mp
->mnt_kern_flag
|= MNTK_EXTENDED_ATTRS
;
1128 if (mp
->mnt_vtable
->vfc_vfsflags
& VFC_VFSPREFLIGHT
) {
1129 mp
->mnt_kern_flag
|= MNTK_UNMOUNT_PREFLIGHT
;
1132 #if !CONFIG_EMBEDDED
1135 if (MNTK_VIRTUALDEV
& mp
->mnt_kern_flag
) speed
= 128;
1136 else if (disk_conditioner_mount_is_ssd(mp
)) speed
= 7*256;
1138 vc_progress_setdiskspeed(speed
);
1141 * Probe root file system for additional features.
1143 (void)VFS_START(mp
, 0, ctx
);
1145 VFSATTR_INIT(&vfsattr
);
1146 VFSATTR_WANTED(&vfsattr
, f_capabilities
);
1147 if (vfs_getattr(mp
, &vfsattr
, ctx
) == 0 &&
1148 VFSATTR_IS_SUPPORTED(&vfsattr
, f_capabilities
)) {
1149 if ((vfsattr
.f_capabilities
.capabilities
[VOL_CAPABILITIES_INTERFACES
] & VOL_CAP_INT_EXTENDED_ATTR
) &&
1150 (vfsattr
.f_capabilities
.valid
[VOL_CAPABILITIES_INTERFACES
] & VOL_CAP_INT_EXTENDED_ATTR
)) {
1151 mp
->mnt_kern_flag
|= MNTK_EXTENDED_ATTRS
;
1154 if ((vfsattr
.f_capabilities
.capabilities
[VOL_CAPABILITIES_INTERFACES
] & VOL_CAP_INT_NAMEDSTREAMS
) &&
1155 (vfsattr
.f_capabilities
.valid
[VOL_CAPABILITIES_INTERFACES
] & VOL_CAP_INT_NAMEDSTREAMS
)) {
1156 mp
->mnt_kern_flag
|= MNTK_NAMED_STREAMS
;
1159 if ((vfsattr
.f_capabilities
.capabilities
[VOL_CAPABILITIES_FORMAT
] & VOL_CAP_FMT_PATH_FROM_ID
) &&
1160 (vfsattr
.f_capabilities
.valid
[VOL_CAPABILITIES_FORMAT
] & VOL_CAP_FMT_PATH_FROM_ID
)) {
1161 mp
->mnt_kern_flag
|= MNTK_PATH_FROM_ID
;
1164 if ((vfsattr
.f_capabilities
.capabilities
[VOL_CAPABILITIES_FORMAT
] & VOL_CAP_FMT_DIR_HARDLINKS
) &&
1165 (vfsattr
.f_capabilities
.valid
[VOL_CAPABILITIES_FORMAT
] & VOL_CAP_FMT_DIR_HARDLINKS
)) {
1166 mp
->mnt_kern_flag
|= MNTK_DIR_HARDLINKS
;
1171 * get rid of iocount reference returned
1172 * by bdevvp (or picked up by us on the substitued
1173 * rootvp)... it (or we) will have also taken
1174 * a usecount reference which we want to keep
1179 if ((vfs_flags(mp
) & MNT_MULTILABEL
) == 0) {
1180 KDBG_RELEASE(DBG_MOUNTROOT
| DBG_FUNC_END
, 0, 2);
1184 error
= VFS_ROOT(mp
, &vp
, ctx
);
1186 printf("%s() VFS_ROOT() returned %d\n",
1188 dounmount(mp
, MNT_FORCE
, 0, ctx
);
1191 error
= vnode_label(mp
, NULL
, vp
, NULL
, 0, ctx
);
1193 * get rid of reference provided by VFS_ROOT
1198 printf("%s() vnode_label() returned %d\n",
1200 dounmount(mp
, MNT_FORCE
, 0, ctx
);
1204 KDBG_RELEASE(DBG_MOUNTROOT
| DBG_FUNC_END
, 0, 3);
1210 vfs_rootmountfailed(mp
);
1212 if (error
!= EINVAL
)
1213 printf("%s_mountroot failed: %d\n", vfsp
->vfc_name
, error
);
1215 KDBG_RELEASE(DBG_MOUNTROOT
| DBG_FUNC_END
, error
? error
: ENODEV
, 4);
1220 * Lookup a mount point by filesystem identifier.
1224 vfs_getvfs(fsid_t
*fsid
)
1226 return (mount_list_lookupby_fsid(fsid
, 0, 0));
1229 static struct mount
*
1230 vfs_getvfs_locked(fsid_t
*fsid
)
1232 return(mount_list_lookupby_fsid(fsid
, 1, 0));
1236 vfs_getvfs_by_mntonname(char *path
)
1238 mount_t retmp
= (mount_t
)0;
1242 TAILQ_FOREACH(mp
, &mountlist
, mnt_list
) {
1243 if (!strncmp(mp
->mnt_vfsstat
.f_mntonname
, path
,
1244 sizeof(mp
->mnt_vfsstat
.f_mntonname
))) {
1246 if (mount_iterref(retmp
, 1))
1252 mount_list_unlock();
1256 /* generation number for creation of new fsids */
1257 u_short mntid_gen
= 0;
1259 * Get a new unique fsid
1262 vfs_getnewfsid(struct mount
*mp
)
1270 /* generate a new fsid */
1271 mtype
= mp
->mnt_vtable
->vfc_typenum
;
1272 if (++mntid_gen
== 0)
1274 tfsid
.val
[0] = makedev(nblkdev
+ mtype
, mntid_gen
);
1275 tfsid
.val
[1] = mtype
;
1277 while (vfs_getvfs_locked(&tfsid
)) {
1278 if (++mntid_gen
== 0)
1280 tfsid
.val
[0] = makedev(nblkdev
+ mtype
, mntid_gen
);
1283 mp
->mnt_vfsstat
.f_fsid
.val
[0] = tfsid
.val
[0];
1284 mp
->mnt_vfsstat
.f_fsid
.val
[1] = tfsid
.val
[1];
1285 mount_list_unlock();
1289 * Routines having to do with the management of the vnode table.
1291 extern int (**dead_vnodeop_p
)(void *);
1292 long numvnodes
, freevnodes
, deadvnodes
, async_work_vnodes
;
1295 int async_work_timed_out
= 0;
1296 int async_work_handled
= 0;
1297 int dead_vnode_wanted
= 0;
1298 int dead_vnode_waited
= 0;
1301 * Move a vnode from one mount queue to another.
1304 insmntque(vnode_t vp
, mount_t mp
)
1308 * Delete from old mount point vnode list, if on one.
1310 if ( (lmp
= vp
->v_mount
) != NULL
&& lmp
!= dead_mountp
) {
1311 if ((vp
->v_lflag
& VNAMED_MOUNT
) == 0)
1312 panic("insmntque: vp not in mount vnode list");
1313 vp
->v_lflag
&= ~VNAMED_MOUNT
;
1315 mount_lock_spin(lmp
);
1319 if (vp
->v_mntvnodes
.tqe_next
== NULL
) {
1320 if (TAILQ_LAST(&lmp
->mnt_vnodelist
, vnodelst
) == vp
)
1321 TAILQ_REMOVE(&lmp
->mnt_vnodelist
, vp
, v_mntvnodes
);
1322 else if (TAILQ_LAST(&lmp
->mnt_newvnodes
, vnodelst
) == vp
)
1323 TAILQ_REMOVE(&lmp
->mnt_newvnodes
, vp
, v_mntvnodes
);
1324 else if (TAILQ_LAST(&lmp
->mnt_workerqueue
, vnodelst
) == vp
)
1325 TAILQ_REMOVE(&lmp
->mnt_workerqueue
, vp
, v_mntvnodes
);
1327 vp
->v_mntvnodes
.tqe_next
->v_mntvnodes
.tqe_prev
= vp
->v_mntvnodes
.tqe_prev
;
1328 *vp
->v_mntvnodes
.tqe_prev
= vp
->v_mntvnodes
.tqe_next
;
1330 vp
->v_mntvnodes
.tqe_next
= NULL
;
1331 vp
->v_mntvnodes
.tqe_prev
= NULL
;
1337 * Insert into list of vnodes for the new mount point, if available.
1339 if ((vp
->v_mount
= mp
) != NULL
) {
1340 mount_lock_spin(mp
);
1341 if ((vp
->v_mntvnodes
.tqe_next
!= 0) && (vp
->v_mntvnodes
.tqe_prev
!= 0))
1342 panic("vp already in mount list");
1343 if (mp
->mnt_lflag
& MNT_LITER
)
1344 TAILQ_INSERT_HEAD(&mp
->mnt_newvnodes
, vp
, v_mntvnodes
);
1346 TAILQ_INSERT_HEAD(&mp
->mnt_vnodelist
, vp
, v_mntvnodes
);
1347 if (vp
->v_lflag
& VNAMED_MOUNT
)
1348 panic("insmntque: vp already in mount vnode list");
1349 vp
->v_lflag
|= VNAMED_MOUNT
;
1357 * Create a vnode for a block device.
1358 * Used for root filesystem, argdev, and swap areas.
1359 * Also used for memory file system special devices.
1362 bdevvp(dev_t dev
, vnode_t
*vpp
)
1366 struct vnode_fsparam vfsp
;
1367 struct vfs_context context
;
1374 context
.vc_thread
= current_thread();
1375 context
.vc_ucred
= FSCRED
;
1377 vfsp
.vnfs_mp
= (struct mount
*)0;
1378 vfsp
.vnfs_vtype
= VBLK
;
1379 vfsp
.vnfs_str
= "bdevvp";
1380 vfsp
.vnfs_dvp
= NULL
;
1381 vfsp
.vnfs_fsnode
= NULL
;
1382 vfsp
.vnfs_cnp
= NULL
;
1383 vfsp
.vnfs_vops
= spec_vnodeop_p
;
1384 vfsp
.vnfs_rdev
= dev
;
1385 vfsp
.vnfs_filesize
= 0;
1387 vfsp
.vnfs_flags
= VNFS_NOCACHE
| VNFS_CANTCACHE
;
1389 vfsp
.vnfs_marksystem
= 0;
1390 vfsp
.vnfs_markroot
= 0;
1392 if ( (error
= vnode_create(VNCREATE_FLAVOR
, VCREATESIZE
, &vfsp
, &nvp
)) ) {
1396 vnode_lock_spin(nvp
);
1397 nvp
->v_flag
|= VBDEVVP
;
1398 nvp
->v_tag
= VT_NON
; /* set this to VT_NON so during aliasing it can be replaced */
1400 if ( (error
= vnode_ref(nvp
)) ) {
1401 panic("bdevvp failed: vnode_ref");
1404 if ( (error
= VNOP_FSYNC(nvp
, MNT_WAIT
, &context
)) ) {
1405 panic("bdevvp failed: fsync");
1408 if ( (error
= buf_invalidateblks(nvp
, BUF_WRITE_DATA
, 0, 0)) ) {
1409 panic("bdevvp failed: invalidateblks");
1415 * XXXMAC: We can't put a MAC check here, the system will
1416 * panic without this vnode.
1420 if ( (error
= VNOP_OPEN(nvp
, FREAD
, &context
)) ) {
1421 panic("bdevvp failed: open");
1430 * Check to see if the new vnode represents a special device
1431 * for which we already have a vnode (either because of
1432 * bdevvp() or because of a different vnode representing
1433 * the same block device). If such an alias exists, deallocate
1434 * the existing contents and return the aliased vnode. The
1435 * caller is responsible for filling it with its new contents.
1438 checkalias(struct vnode
*nvp
, dev_t nvp_rdev
)
1442 struct specinfo
*sin
= NULL
;
1445 vpp
= &speclisth
[SPECHASH(nvp_rdev
)];
1449 for (vp
= *vpp
; vp
; vp
= vp
->v_specnext
) {
1450 if (nvp_rdev
== vp
->v_rdev
&& nvp
->v_type
== vp
->v_type
) {
1459 if (vnode_getwithvid(vp
,vid
)) {
1463 * Termination state is checked in vnode_getwithvid
1468 * Alias, but not in use, so flush it out.
1470 if ((vp
->v_iocount
== 1) && (vp
->v_usecount
== 0)) {
1471 vnode_reclaim_internal(vp
, 1, 1, 0);
1472 vnode_put_locked(vp
);
1478 if (vp
== NULL
|| vp
->v_tag
!= VT_NON
) {
1480 MALLOC_ZONE(sin
, struct specinfo
*, sizeof(struct specinfo
),
1481 M_SPECINFO
, M_WAITOK
);
1484 nvp
->v_specinfo
= sin
;
1485 bzero(nvp
->v_specinfo
, sizeof(struct specinfo
));
1486 nvp
->v_rdev
= nvp_rdev
;
1487 nvp
->v_specflags
= 0;
1488 nvp
->v_speclastr
= -1;
1489 nvp
->v_specinfo
->si_opencount
= 0;
1490 nvp
->v_specinfo
->si_initted
= 0;
1491 nvp
->v_specinfo
->si_throttleable
= 0;
1495 /* We dropped the lock, someone could have added */
1497 for (vp
= *vpp
; vp
; vp
= vp
->v_specnext
) {
1498 if (nvp_rdev
== vp
->v_rdev
&& nvp
->v_type
== vp
->v_type
) {
1506 nvp
->v_hashchain
= vpp
;
1507 nvp
->v_specnext
= *vpp
;
1511 nvp
->v_specflags
|= SI_ALIASED
;
1512 vp
->v_specflags
|= SI_ALIASED
;
1514 vnode_put_locked(vp
);
1524 FREE_ZONE(sin
, sizeof(struct specinfo
), M_SPECINFO
);
1527 if ((vp
->v_flag
& (VBDEVVP
| VDEVFLUSH
)) != 0)
1530 panic("checkalias with VT_NON vp that shouldn't: %p", vp
);
1537 * Get a reference on a particular vnode and lock it if requested.
1538 * If the vnode was on the inactive list, remove it from the list.
1539 * If the vnode was on the free list, remove it from the list and
1540 * move it to inactive list as needed.
1541 * The vnode lock bit is set if the vnode is being eliminated in
1542 * vgone. The process is awakened when the transition is completed,
1543 * and an error returned to indicate that the vnode is no longer
1544 * usable (possibly having been changed to a new file system type).
1547 vget_internal(vnode_t vp
, int vid
, int vflags
)
1551 vnode_lock_spin(vp
);
1553 if ((vflags
& VNODE_WRITEABLE
) && (vp
->v_writecount
== 0))
1555 * vnode to be returned only if it has writers opened
1559 error
= vnode_getiocount(vp
, vid
, vflags
);
1567 * Returns: 0 Success
1568 * ENOENT No such file or directory [terminating]
1571 vnode_ref(vnode_t vp
)
1574 return (vnode_ref_ext(vp
, 0, 0));
1578 * Returns: 0 Success
1579 * ENOENT No such file or directory [terminating]
1582 vnode_ref_ext(vnode_t vp
, int fmode
, int flags
)
1586 vnode_lock_spin(vp
);
1589 * once all the current call sites have been fixed to insure they have
1590 * taken an iocount, we can toughen this assert up and insist that the
1591 * iocount is non-zero... a non-zero usecount doesn't insure correctness
1593 if (vp
->v_iocount
<= 0 && vp
->v_usecount
<= 0)
1594 panic("vnode_ref_ext: vp %p has no valid reference %d, %d", vp
, vp
->v_iocount
, vp
->v_usecount
);
1597 * if you are the owner of drain/termination, can acquire usecount
1599 if ((flags
& VNODE_REF_FORCE
) == 0) {
1600 if ((vp
->v_lflag
& (VL_DRAIN
| VL_TERMINATE
| VL_DEAD
))) {
1601 if (vp
->v_owner
!= current_thread()) {
1609 if (fmode
& FWRITE
) {
1610 if (++vp
->v_writecount
<= 0)
1611 panic("vnode_ref_ext: v_writecount");
1613 if (fmode
& O_EVTONLY
) {
1614 if (++vp
->v_kusecount
<= 0)
1615 panic("vnode_ref_ext: v_kusecount");
1617 if (vp
->v_flag
& VRAGE
) {
1620 ut
= get_bsdthread_info(current_thread());
1622 if ( !(current_proc()->p_lflag
& P_LRAGE_VNODES
) &&
1623 !(ut
->uu_flag
& UT_RAGE_VNODES
)) {
1625 * a 'normal' process accessed this vnode
1626 * so make sure its no longer marked
1627 * for rapid aging... also, make sure
1628 * it gets removed from the rage list...
1629 * when v_usecount drops back to 0, it
1630 * will be put back on the real free list
1632 vp
->v_flag
&= ~VRAGE
;
1633 vp
->v_references
= 0;
1634 vnode_list_remove(vp
);
1637 if (vp
->v_usecount
== 1 && vp
->v_type
== VREG
&& !(vp
->v_flag
& VSYSTEM
)) {
1639 if (vp
->v_ubcinfo
) {
1640 vnode_lock_convert(vp
);
1641 memory_object_mark_used(vp
->v_ubcinfo
->ui_control
);
1652 vnode_on_reliable_media(vnode_t vp
)
1654 if ( !(vp
->v_mount
->mnt_kern_flag
& MNTK_VIRTUALDEV
) && (vp
->v_mount
->mnt_flag
& MNT_LOCAL
) )
1660 vnode_async_list_add(vnode_t vp
)
1664 if (VONLIST(vp
) || (vp
->v_lflag
& (VL_TERMINATE
|VL_DEAD
)))
1665 panic("vnode_async_list_add: %p is in wrong state", vp
);
1667 TAILQ_INSERT_HEAD(&vnode_async_work_list
, vp
, v_freelist
);
1668 vp
->v_listflag
|= VLIST_ASYNC_WORK
;
1670 async_work_vnodes
++;
1672 vnode_list_unlock();
1674 wakeup(&vnode_async_work_list
);
1680 * put the vnode on appropriate free list.
1681 * called with vnode LOCKED
1684 vnode_list_add(vnode_t vp
)
1686 boolean_t need_dead_wakeup
= FALSE
;
1689 lck_mtx_assert(&vp
->v_lock
, LCK_MTX_ASSERT_OWNED
);
1695 * if it is already on a list or non zero references return
1697 if (VONLIST(vp
) || (vp
->v_usecount
!= 0) || (vp
->v_iocount
!= 0) || (vp
->v_lflag
& VL_TERMINATE
))
1701 * In vclean, we might have deferred ditching locked buffers
1702 * because something was still referencing them (indicated by
1703 * usecount). We can ditch them now.
1705 if (ISSET(vp
->v_lflag
, VL_DEAD
)
1706 && (!LIST_EMPTY(&vp
->v_cleanblkhd
) || !LIST_EMPTY(&vp
->v_dirtyblkhd
))) {
1707 ++vp
->v_iocount
; // Probably not necessary, but harmless
1712 buf_invalidateblks(vp
, BUF_INVALIDATE_LOCKED
, 0, 0);
1714 vnode_dropiocount(vp
);
1720 if ((vp
->v_flag
& VRAGE
) && !(vp
->v_lflag
& VL_DEAD
)) {
1722 * add the new guy to the appropriate end of the RAGE list
1724 if ((vp
->v_flag
& VAGE
))
1725 TAILQ_INSERT_HEAD(&vnode_rage_list
, vp
, v_freelist
);
1727 TAILQ_INSERT_TAIL(&vnode_rage_list
, vp
, v_freelist
);
1729 vp
->v_listflag
|= VLIST_RAGE
;
1733 * reset the timestamp for the last inserted vp on the RAGE
1734 * queue to let new_vnode know that its not ok to start stealing
1735 * from this list... as long as we're actively adding to this list
1736 * we'll push out the vnodes we want to donate to the real free list
1737 * once we stop pushing, we'll let some time elapse before we start
1738 * stealing them in the new_vnode routine
1740 microuptime(&rage_tv
);
1743 * if VL_DEAD, insert it at head of the dead list
1744 * else insert at tail of LRU list or at head if VAGE is set
1746 if ( (vp
->v_lflag
& VL_DEAD
)) {
1747 TAILQ_INSERT_HEAD(&vnode_dead_list
, vp
, v_freelist
);
1748 vp
->v_listflag
|= VLIST_DEAD
;
1751 if (dead_vnode_wanted
) {
1752 dead_vnode_wanted
--;
1753 need_dead_wakeup
= TRUE
;
1756 } else if ( (vp
->v_flag
& VAGE
) ) {
1757 TAILQ_INSERT_HEAD(&vnode_free_list
, vp
, v_freelist
);
1758 vp
->v_flag
&= ~VAGE
;
1761 TAILQ_INSERT_TAIL(&vnode_free_list
, vp
, v_freelist
);
1765 vnode_list_unlock();
1767 if (need_dead_wakeup
== TRUE
)
1768 wakeup_one((caddr_t
)&dead_vnode_wanted
);
1773 * remove the vnode from appropriate free list.
1774 * called with vnode LOCKED and
1775 * the list lock held
1778 vnode_list_remove_locked(vnode_t vp
)
1782 * the v_listflag field is
1783 * protected by the vnode_list_lock
1785 if (vp
->v_listflag
& VLIST_RAGE
)
1786 VREMRAGE("vnode_list_remove", vp
);
1787 else if (vp
->v_listflag
& VLIST_DEAD
)
1788 VREMDEAD("vnode_list_remove", vp
);
1789 else if (vp
->v_listflag
& VLIST_ASYNC_WORK
)
1790 VREMASYNC_WORK("vnode_list_remove", vp
);
1792 VREMFREE("vnode_list_remove", vp
);
1798 * remove the vnode from appropriate free list.
1799 * called with vnode LOCKED
1802 vnode_list_remove(vnode_t vp
)
1805 lck_mtx_assert(&vp
->v_lock
, LCK_MTX_ASSERT_OWNED
);
1808 * we want to avoid taking the list lock
1809 * in the case where we're not on the free
1810 * list... this will be true for most
1811 * directories and any currently in use files
1813 * we're guaranteed that we can't go from
1814 * the not-on-list state to the on-list
1815 * state since we hold the vnode lock...
1816 * all calls to vnode_list_add are done
1817 * under the vnode lock... so we can
1818 * check for that condition (the prevelant one)
1819 * without taking the list lock
1824 * however, we're not guaranteed that
1825 * we won't go from the on-list state
1826 * to the not-on-list state until we
1827 * hold the vnode_list_lock... this
1828 * is due to "new_vnode" removing vnodes
1829 * from the free list uder the list_lock
1830 * w/o the vnode lock... so we need to
1831 * check again whether we're currently
1834 vnode_list_remove_locked(vp
);
1836 vnode_list_unlock();
1842 vnode_rele(vnode_t vp
)
1844 vnode_rele_internal(vp
, 0, 0, 0);
1849 vnode_rele_ext(vnode_t vp
, int fmode
, int dont_reenter
)
1851 vnode_rele_internal(vp
, fmode
, dont_reenter
, 0);
1856 vnode_rele_internal(vnode_t vp
, int fmode
, int dont_reenter
, int locked
)
1860 vnode_lock_spin(vp
);
1863 lck_mtx_assert(&vp
->v_lock
, LCK_MTX_ASSERT_OWNED
);
1865 if (--vp
->v_usecount
< 0)
1866 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
);
1868 if (fmode
& FWRITE
) {
1869 if (--vp
->v_writecount
< 0)
1870 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
);
1872 if (fmode
& O_EVTONLY
) {
1873 if (--vp
->v_kusecount
< 0)
1874 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
);
1876 if (vp
->v_kusecount
> vp
->v_usecount
)
1877 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
);
1879 if ((vp
->v_iocount
> 0) || (vp
->v_usecount
> 0)) {
1881 * vnode is still busy... if we're the last
1882 * usecount, mark for a future call to VNOP_INACTIVE
1883 * when the iocount finally drops to 0
1885 if (vp
->v_usecount
== 0) {
1886 vp
->v_lflag
|= VL_NEEDINACTIVE
;
1887 vp
->v_flag
&= ~(VNOCACHE_DATA
| VRAOFF
| VOPENEVT
);
1891 vp
->v_flag
&= ~(VNOCACHE_DATA
| VRAOFF
| VOPENEVT
);
1893 if (ISSET(vp
->v_lflag
, VL_TERMINATE
| VL_DEAD
) || dont_reenter
) {
1895 * vnode is being cleaned, or
1896 * we've requested that we don't reenter
1897 * the filesystem on this release...in
1898 * the latter case, we'll mark the vnode aged
1901 if ( !(vp
->v_lflag
& (VL_TERMINATE
| VL_DEAD
| VL_MARKTERM
)) ) {
1902 vp
->v_lflag
|= VL_NEEDINACTIVE
;
1904 if (vnode_on_reliable_media(vp
) == FALSE
|| vp
->v_flag
& VISDIRTY
) {
1905 vnode_async_list_add(vp
);
1916 * at this point both the iocount and usecount
1918 * pick up an iocount so that we can call
1919 * VNOP_INACTIVE with the vnode lock unheld
1925 vp
->v_lflag
&= ~VL_NEEDINACTIVE
;
1928 VNOP_INACTIVE(vp
, vfs_context_current());
1930 vnode_lock_spin(vp
);
1932 * because we dropped the vnode lock to call VNOP_INACTIVE
1933 * the state of the vnode may have changed... we may have
1934 * picked up an iocount, usecount or the MARKTERM may have
1935 * been set... we need to reevaluate the reference counts
1936 * to determine if we can call vnode_reclaim_internal at
1937 * this point... if the reference counts are up, we'll pick
1938 * up the MARKTERM state when they get subsequently dropped
1940 if ( (vp
->v_iocount
== 1) && (vp
->v_usecount
== 0) &&
1941 ((vp
->v_lflag
& (VL_MARKTERM
| VL_TERMINATE
| VL_DEAD
)) == VL_MARKTERM
)) {
1944 ut
= get_bsdthread_info(current_thread());
1946 if (ut
->uu_defer_reclaims
) {
1947 vp
->v_defer_reclaimlist
= ut
->uu_vreclaims
;
1948 ut
->uu_vreclaims
= vp
;
1951 vnode_lock_convert(vp
);
1952 vnode_reclaim_internal(vp
, 1, 1, 0);
1954 vnode_dropiocount(vp
);
1957 if (vp
->v_usecount
== 0 && vp
->v_type
== VREG
&& !(vp
->v_flag
& VSYSTEM
)) {
1959 if (vp
->v_ubcinfo
) {
1960 vnode_lock_convert(vp
);
1961 memory_object_mark_unused(vp
->v_ubcinfo
->ui_control
, (vp
->v_flag
& VRAGE
) == VRAGE
);
1970 * Remove any vnodes in the vnode table belonging to mount point mp.
1972 * If MNT_NOFORCE is specified, there should not be any active ones,
1973 * return error if any are found (nb: this is a user error, not a
1974 * system error). If MNT_FORCE is specified, detach any active vnodes
1978 int busyprt
= 0; /* print out busy vnodes */
1982 vflush(struct mount
*mp
, struct vnode
*skipvp
, int flags
)
1991 * See comments in vnode_iterate() for the rationale for this lock
1993 mount_iterate_lock(mp
);
1996 vnode_iterate_setup(mp
);
1998 * On regular unmounts(not forced) do a
1999 * quick check for vnodes to be in use. This
2000 * preserves the caching of vnodes. automounter
2001 * tries unmounting every so often to see whether
2002 * it is still busy or not.
2004 if (((flags
& FORCECLOSE
)==0) && ((mp
->mnt_kern_flag
& MNTK_UNMOUNT_PREFLIGHT
) != 0)) {
2005 if (vnode_umount_preflight(mp
, skipvp
, flags
)) {
2006 vnode_iterate_clear(mp
);
2008 mount_iterate_unlock(mp
);
2013 /* If it returns 0 then there is nothing to do */
2014 retval
= vnode_iterate_prepare(mp
);
2017 vnode_iterate_clear(mp
);
2019 mount_iterate_unlock(mp
);
2023 /* iterate over all the vnodes */
2024 while (!TAILQ_EMPTY(&mp
->mnt_workerqueue
)) {
2026 vp
= TAILQ_FIRST(&mp
->mnt_workerqueue
);
2027 TAILQ_REMOVE(&mp
->mnt_workerqueue
, vp
, v_mntvnodes
);
2028 TAILQ_INSERT_TAIL(&mp
->mnt_vnodelist
, vp
, v_mntvnodes
);
2030 if ( (vp
->v_mount
!= mp
) || (vp
== skipvp
)) {
2036 vnode_lock_spin(vp
);
2038 // If vnode is already terminating, wait for it...
2039 while (vp
->v_id
== vid
&& ISSET(vp
->v_lflag
, VL_TERMINATE
)) {
2040 vp
->v_lflag
|= VL_TERMWANT
;
2041 msleep(&vp
->v_lflag
, &vp
->v_lock
, PVFS
, "vflush", NULL
);
2044 if ((vp
->v_id
!= vid
) || ISSET(vp
->v_lflag
, VL_DEAD
)) {
2051 * If requested, skip over vnodes marked VSYSTEM.
2052 * Skip over all vnodes marked VNOFLUSH.
2054 if ((flags
& SKIPSYSTEM
) && ((vp
->v_flag
& VSYSTEM
) ||
2055 (vp
->v_flag
& VNOFLUSH
))) {
2061 * If requested, skip over vnodes marked VSWAP.
2063 if ((flags
& SKIPSWAP
) && (vp
->v_flag
& VSWAP
)) {
2069 * If requested, skip over vnodes marked VROOT.
2071 if ((flags
& SKIPROOT
) && (vp
->v_flag
& VROOT
)) {
2077 * If WRITECLOSE is set, only flush out regular file
2078 * vnodes open for writing.
2080 if ((flags
& WRITECLOSE
) &&
2081 (vp
->v_writecount
== 0 || vp
->v_type
!= VREG
)) {
2087 * If the real usecount is 0, all we need to do is clear
2088 * out the vnode data structures and we are done.
2090 if (((vp
->v_usecount
== 0) ||
2091 ((vp
->v_usecount
- vp
->v_kusecount
) == 0))) {
2093 vnode_lock_convert(vp
);
2094 vp
->v_iocount
++; /* so that drain waits for * other iocounts */
2098 vnode_reclaim_internal(vp
, 1, 1, 0);
2099 vnode_dropiocount(vp
);
2108 * If FORCECLOSE is set, forcibly close the vnode.
2109 * For block or character devices, revert to an
2110 * anonymous device. For all other files, just kill them.
2112 if (flags
& FORCECLOSE
) {
2113 vnode_lock_convert(vp
);
2115 if (vp
->v_type
!= VBLK
&& vp
->v_type
!= VCHR
) {
2116 vp
->v_iocount
++; /* so that drain waits * for other iocounts */
2120 vnode_abort_advlocks(vp
);
2121 vnode_reclaim_internal(vp
, 1, 1, 0);
2122 vnode_dropiocount(vp
);
2127 vp
->v_lflag
&= ~VL_DEAD
;
2128 vp
->v_op
= spec_vnodeop_p
;
2129 vp
->v_flag
|= VDEVFLUSH
;
2137 vprint("vflush: busy vnode", vp
);
2144 /* At this point the worker queue is completed */
2145 if (busy
&& ((flags
& FORCECLOSE
)==0) && reclaimed
) {
2148 (void)vnode_iterate_reloadq(mp
);
2149 /* returned with mount lock held */
2153 /* if new vnodes were created in between retry the reclaim */
2154 if ( vnode_iterate_reloadq(mp
) != 0) {
2155 if (!(busy
&& ((flags
& FORCECLOSE
)==0)))
2158 vnode_iterate_clear(mp
);
2160 mount_iterate_unlock(mp
);
2162 if (busy
&& ((flags
& FORCECLOSE
)==0))
2167 long num_recycledvnodes
= 0;
2169 * Disassociate the underlying file system from a vnode.
2170 * The vnode lock is held on entry.
2173 vclean(vnode_t vp
, int flags
)
2175 vfs_context_t ctx
= vfs_context_current();
2178 int already_terminating
;
2185 * Check to see if the vnode is in use.
2186 * If so we have to reference it before we clean it out
2187 * so that its count cannot fall to zero and generate a
2188 * race against ourselves to recycle it.
2190 active
= vp
->v_usecount
;
2193 * just in case we missed sending a needed
2194 * VNOP_INACTIVE, we'll do it now
2196 need_inactive
= (vp
->v_lflag
& VL_NEEDINACTIVE
);
2198 vp
->v_lflag
&= ~VL_NEEDINACTIVE
;
2201 * Prevent the vnode from being recycled or
2202 * brought into use while we clean it out.
2204 already_terminating
= (vp
->v_lflag
& VL_TERMINATE
);
2206 vp
->v_lflag
|= VL_TERMINATE
;
2209 is_namedstream
= vnode_isnamedstream(vp
);
2214 OSAddAtomicLong(1, &num_recycledvnodes
);
2216 if (flags
& DOCLOSE
)
2217 clflags
|= IO_NDELAY
;
2218 if (flags
& REVOKEALL
)
2219 clflags
|= IO_REVOKE
;
2221 if (active
&& (flags
& DOCLOSE
))
2222 VNOP_CLOSE(vp
, clflags
, ctx
);
2225 * Clean out any buffers associated with the vnode.
2227 if (flags
& DOCLOSE
) {
2229 if (vp
->v_tag
== VT_NFS
)
2230 nfs_vinvalbuf(vp
, V_SAVE
, ctx
, 0);
2234 VNOP_FSYNC(vp
, MNT_WAIT
, ctx
);
2237 * If the vnode is still in use (by the journal for
2238 * example) we don't want to invalidate locked buffers
2239 * here. In that case, either the journal will tidy them
2240 * up, or we will deal with it when the usecount is
2241 * finally released in vnode_rele_internal.
2243 buf_invalidateblks(vp
, BUF_WRITE_DATA
| (active
? 0 : BUF_INVALIDATE_LOCKED
), 0, 0);
2245 if (UBCINFOEXISTS(vp
))
2247 * Clean the pages in VM.
2249 (void)ubc_msync(vp
, (off_t
)0, ubc_getsize(vp
), NULL
, UBC_PUSHALL
| UBC_INVALIDATE
| UBC_SYNC
);
2251 if (active
|| need_inactive
)
2252 VNOP_INACTIVE(vp
, ctx
);
2255 if ((is_namedstream
!= 0) && (vp
->v_parent
!= NULLVP
)) {
2256 vnode_t pvp
= vp
->v_parent
;
2258 /* Delete the shadow stream file before we reclaim its vnode */
2259 if (vnode_isshadow(vp
)) {
2260 vnode_relenamedstream(pvp
, vp
);
2264 * No more streams associated with the parent. We
2265 * have a ref on it, so its identity is stable.
2266 * If the parent is on an opaque volume, then we need to know
2267 * whether it has associated named streams.
2269 if (vfs_authopaque(pvp
->v_mount
)) {
2270 vnode_lock_spin(pvp
);
2271 pvp
->v_lflag
&= ~VL_HASSTREAMS
;
2278 * Destroy ubc named reference
2279 * cluster_release is done on this path
2280 * along with dropping the reference on the ucred
2281 * (and in the case of forced unmount of an mmap-ed file,
2282 * the ubc reference on the vnode is dropped here too).
2284 ubc_destroy_named(vp
);
2288 * cleanup trigger info from vnode (if any)
2291 vnode_resolver_detach(vp
);
2295 * Reclaim the vnode.
2297 if (VNOP_RECLAIM(vp
, ctx
))
2298 panic("vclean: cannot reclaim");
2300 // make sure the name & parent ptrs get cleaned out!
2301 vnode_update_identity(vp
, NULLVP
, NULL
, 0, 0, VNODE_UPDATE_PARENT
| VNODE_UPDATE_NAME
| VNODE_UPDATE_PURGE
);
2306 * Remove the vnode from any mount list it might be on. It is not
2307 * safe to do this any earlier because unmount needs to wait for
2308 * any vnodes to terminate and it cannot do that if it cannot find
2311 insmntque(vp
, (struct mount
*)0);
2313 vp
->v_mount
= dead_mountp
;
2314 vp
->v_op
= dead_vnodeop_p
;
2318 vp
->v_lflag
|= VL_DEAD
;
2319 vp
->v_flag
&= ~VISDIRTY
;
2321 if (already_terminating
== 0) {
2322 vp
->v_lflag
&= ~VL_TERMINATE
;
2324 * Done with purge, notify sleepers of the grim news.
2326 if (vp
->v_lflag
& VL_TERMWANT
) {
2327 vp
->v_lflag
&= ~VL_TERMWANT
;
2328 wakeup(&vp
->v_lflag
);
2334 * Eliminate all activity associated with the requested vnode
2335 * and with all vnodes aliased to the requested vnode.
2339 vn_revoke(vnode_t vp
, int flags
, __unused vfs_context_t a_context
)
2341 vn_revoke(vnode_t vp
, __unused
int flags
, __unused vfs_context_t a_context
)
2348 if ((flags
& REVOKEALL
) == 0)
2349 panic("vnop_revoke");
2352 if (vnode_isaliased(vp
)) {
2354 * If a vgone (or vclean) is already in progress,
2355 * return an immediate error
2357 if (vp
->v_lflag
& VL_TERMINATE
)
2361 * Ensure that vp will not be vgone'd while we
2362 * are eliminating its aliases.
2365 while ((vp
->v_specflags
& SI_ALIASED
)) {
2366 for (vq
= *vp
->v_hashchain
; vq
; vq
= vq
->v_specnext
) {
2367 if (vq
->v_rdev
!= vp
->v_rdev
||
2368 vq
->v_type
!= vp
->v_type
|| vp
== vq
)
2372 if (vnode_getwithvid(vq
,vid
)){
2377 if (!(vq
->v_lflag
& VL_TERMINATE
)) {
2378 vnode_reclaim_internal(vq
, 1, 1, 0);
2380 vnode_put_locked(vq
);
2389 if (vp
->v_lflag
& VL_TERMINATE
) {
2393 vnode_reclaim_internal(vp
, 1, 0, REVOKEALL
);
2400 * Recycle an unused vnode to the front of the free list.
2401 * Release the passed interlock if the vnode will be recycled.
2404 vnode_recycle(struct vnode
*vp
)
2406 vnode_lock_spin(vp
);
2408 if (vp
->v_iocount
|| vp
->v_usecount
) {
2409 vp
->v_lflag
|= VL_MARKTERM
;
2413 vnode_lock_convert(vp
);
2414 vnode_reclaim_internal(vp
, 1, 0, 0);
2422 vnode_reload(vnode_t vp
)
2424 vnode_lock_spin(vp
);
2426 if ((vp
->v_iocount
> 1) || vp
->v_usecount
) {
2430 if (vp
->v_iocount
<= 0)
2431 panic("vnode_reload with no iocount %d", vp
->v_iocount
);
2433 /* mark for release when iocount is dopped */
2434 vp
->v_lflag
|= VL_MARKTERM
;
2442 vgone(vnode_t vp
, int flags
)
2448 * Clean out the filesystem specific data.
2449 * vclean also takes care of removing the
2450 * vnode from any mount list it might be on
2452 vclean(vp
, flags
| DOCLOSE
);
2455 * If special device, remove it from special device alias list
2458 if ((vp
->v_type
== VBLK
|| vp
->v_type
== VCHR
) && vp
->v_specinfo
!= 0) {
2460 if (*vp
->v_hashchain
== vp
) {
2461 *vp
->v_hashchain
= vp
->v_specnext
;
2463 for (vq
= *vp
->v_hashchain
; vq
; vq
= vq
->v_specnext
) {
2464 if (vq
->v_specnext
!= vp
)
2466 vq
->v_specnext
= vp
->v_specnext
;
2470 panic("missing bdev");
2472 if (vp
->v_specflags
& SI_ALIASED
) {
2474 for (vq
= *vp
->v_hashchain
; vq
; vq
= vq
->v_specnext
) {
2475 if (vq
->v_rdev
!= vp
->v_rdev
||
2476 vq
->v_type
!= vp
->v_type
)
2483 panic("missing alias");
2485 vx
->v_specflags
&= ~SI_ALIASED
;
2486 vp
->v_specflags
&= ~SI_ALIASED
;
2490 struct specinfo
*tmp
= vp
->v_specinfo
;
2491 vp
->v_specinfo
= NULL
;
2492 FREE_ZONE((void *)tmp
, sizeof(struct specinfo
), M_SPECINFO
);
2498 * Lookup a vnode by device number.
2501 check_mountedon(dev_t dev
, enum vtype type
, int *errorp
)
2509 for (vp
= speclisth
[SPECHASH(dev
)]; vp
; vp
= vp
->v_specnext
) {
2510 if (dev
!= vp
->v_rdev
|| type
!= vp
->v_type
)
2514 if (vnode_getwithvid(vp
,vid
))
2516 vnode_lock_spin(vp
);
2517 if ((vp
->v_usecount
> 0) || (vp
->v_iocount
> 1)) {
2519 if ((*errorp
= vfs_mountedon(vp
)) != 0)
2531 * Calculate the total number of references to a special device.
2540 if (!vnode_isspec(vp
)) {
2541 return (vp
->v_usecount
- vp
->v_kusecount
);
2545 if (!vnode_isaliased(vp
))
2546 return (vp
->v_specinfo
->si_opencount
);
2551 * Grab first vnode and its vid.
2553 vq
= *vp
->v_hashchain
;
2554 vid
= vq
? vq
->v_id
: 0;
2560 * Attempt to get the vnode outside the SPECHASH lock.
2562 if (vnode_getwithvid(vq
, vid
)) {
2567 if (vq
->v_rdev
== vp
->v_rdev
&& vq
->v_type
== vp
->v_type
) {
2568 if ((vq
->v_usecount
== 0) && (vq
->v_iocount
== 1) && vq
!= vp
) {
2570 * Alias, but not in use, so flush it out.
2572 vnode_reclaim_internal(vq
, 1, 1, 0);
2573 vnode_put_locked(vq
);
2577 count
+= vq
->v_specinfo
->si_opencount
;
2583 * must do this with the reference still held on 'vq'
2584 * so that it can't be destroyed while we're poking
2585 * through v_specnext
2587 vnext
= vq
->v_specnext
;
2588 vid
= vnext
? vnext
->v_id
: 0;
2600 int prtactive
= 0; /* 1 => print out reclaim of active vnodes */
2603 * Print out a description of a vnode.
2605 static const char *typename
[] =
2606 { "VNON", "VREG", "VDIR", "VBLK", "VCHR", "VLNK", "VSOCK", "VFIFO", "VBAD" };
2609 vprint(const char *label
, struct vnode
*vp
)
2614 printf("%s: ", label
);
2615 printf("type %s, usecount %d, writecount %d",
2616 typename
[vp
->v_type
], vp
->v_usecount
, vp
->v_writecount
);
2618 if (vp
->v_flag
& VROOT
)
2619 strlcat(sbuf
, "|VROOT", sizeof(sbuf
));
2620 if (vp
->v_flag
& VTEXT
)
2621 strlcat(sbuf
, "|VTEXT", sizeof(sbuf
));
2622 if (vp
->v_flag
& VSYSTEM
)
2623 strlcat(sbuf
, "|VSYSTEM", sizeof(sbuf
));
2624 if (vp
->v_flag
& VNOFLUSH
)
2625 strlcat(sbuf
, "|VNOFLUSH", sizeof(sbuf
));
2626 if (vp
->v_flag
& VBWAIT
)
2627 strlcat(sbuf
, "|VBWAIT", sizeof(sbuf
));
2628 if (vnode_isaliased(vp
))
2629 strlcat(sbuf
, "|VALIASED", sizeof(sbuf
));
2630 if (sbuf
[0] != '\0')
2631 printf(" flags (%s)", &sbuf
[1]);
2636 vn_getpath(struct vnode
*vp
, char *pathbuf
, int *len
)
2638 return build_path(vp
, pathbuf
, *len
, len
, BUILDPATH_NO_FS_ENTER
, vfs_context_current());
2642 vn_getpath_fsenter(struct vnode
*vp
, char *pathbuf
, int *len
)
2644 return build_path(vp
, pathbuf
, *len
, len
, 0, vfs_context_current());
2648 * vn_getpath_fsenter_with_parent will reenter the file system to fine the path of the
2649 * vnode. It requires that there are IO counts on both the vnode and the directory vnode.
2651 * vn_getpath_fsenter is called by MAC hooks to authorize operations for every thing, but
2652 * unlink, rmdir and rename. For these operation the MAC hook calls vn_getpath. This presents
2653 * problems where if the path can not be found from the name cache, those operations can
2654 * erroneously fail with EPERM even though the call should succeed. When removing or moving
2655 * file system objects with operations such as unlink or rename, those operations need to
2656 * take IO counts on the target and containing directory. Calling vn_getpath_fsenter from a
2657 * MAC hook from these operations during forced unmount operations can lead to dead
2658 * lock. This happens when the operation starts, IO counts are taken on the containing
2659 * directories and targets. Before the MAC hook is called a forced unmount from another
2660 * thread takes place and blocks on the on going operation's directory vnode in vdrain.
2661 * After which, the MAC hook gets called and calls vn_getpath_fsenter. vn_getpath_fsenter
2662 * is called with the understanding that there is an IO count on the target. If in
2663 * build_path the directory vnode is no longer in the cache, then the parent object id via
2664 * vnode_getattr from the target is obtain and used to call VFS_VGET to get the parent
2665 * vnode. The file system's VFS_VGET then looks up by inode in its hash and tries to get
2666 * an IO count. But VFS_VGET "sees" the directory vnode is in vdrain and can block
2667 * depending on which version and how it calls the vnode_get family of interfaces.
2669 * N.B. A reasonable interface to use is vnode_getwithvid. This interface was modified to
2670 * call vnode_getiocount with VNODE_DRAINO, so it will happily get an IO count and not
2671 * cause issues, but there is no guarantee that all or any file systems are doing that.
2673 * vn_getpath_fsenter_with_parent can enter the file system safely since there is a known
2674 * IO count on the directory vnode by calling build_path_with_parent.
2678 vn_getpath_fsenter_with_parent(struct vnode
*dvp
, struct vnode
*vp
, char *pathbuf
, int *len
)
2680 return build_path_with_parent(vp
, dvp
, pathbuf
, *len
, len
, 0, vfs_context_current());
2684 vn_getcdhash(struct vnode
*vp
, off_t offset
, unsigned char *cdhash
)
2686 return ubc_cs_getcdhash(vp
, offset
, cdhash
);
2690 static char *extension_table
=NULL
;
2692 static int max_ext_width
;
2695 extension_cmp(const void *a
, const void *b
)
2697 return (strlen((const char *)a
) - strlen((const char *)b
));
2702 // This is the api LaunchServices uses to inform the kernel
2703 // the list of package extensions to ignore.
2705 // Internally we keep the list sorted by the length of the
2706 // the extension (from longest to shortest). We sort the
2707 // list of extensions so that we can speed up our searches
2708 // when comparing file names -- we only compare extensions
2709 // that could possibly fit into the file name, not all of
2710 // them (i.e. a short 8 character name can't have an 8
2711 // character extension).
2713 extern lck_mtx_t
*pkg_extensions_lck
;
2715 __private_extern__
int
2716 set_package_extensions_table(user_addr_t data
, int nentries
, int maxwidth
)
2718 char *new_exts
, *old_exts
;
2721 if (nentries
<= 0 || nentries
> 1024 || maxwidth
<= 0 || maxwidth
> 255) {
2726 // allocate one byte extra so we can guarantee null termination
2727 MALLOC(new_exts
, char *, (nentries
* maxwidth
) + 1, M_TEMP
, M_WAITOK
);
2728 if (new_exts
== NULL
) {
2732 error
= copyin(data
, new_exts
, nentries
* maxwidth
);
2734 FREE(new_exts
, M_TEMP
);
2738 new_exts
[(nentries
* maxwidth
)] = '\0'; // guarantee null termination of the block
2740 qsort(new_exts
, nentries
, maxwidth
, extension_cmp
);
2742 lck_mtx_lock(pkg_extensions_lck
);
2744 old_exts
= extension_table
;
2745 extension_table
= new_exts
;
2747 max_ext_width
= maxwidth
;
2749 lck_mtx_unlock(pkg_extensions_lck
);
2752 FREE(old_exts
, M_TEMP
);
2759 int is_package_name(const char *name
, int len
)
2762 const char *ptr
, *name_ext
;
2769 for(ptr
=name
; *ptr
!= '\0'; ptr
++) {
2775 // if there is no "." extension, it can't match
2776 if (name_ext
== NULL
) {
2780 // advance over the "."
2783 lck_mtx_lock(pkg_extensions_lck
);
2785 // now iterate over all the extensions to see if any match
2786 ptr
= &extension_table
[0];
2787 for(i
=0; i
< nexts
; i
++, ptr
+=max_ext_width
) {
2788 extlen
= strlen(ptr
);
2789 if (strncasecmp(name_ext
, ptr
, extlen
) == 0 && name_ext
[extlen
] == '\0') {
2791 lck_mtx_unlock(pkg_extensions_lck
);
2796 lck_mtx_unlock(pkg_extensions_lck
);
2798 // if we get here, no extension matched
2803 vn_path_package_check(__unused vnode_t vp
, char *path
, int pathlen
, int *component
)
2814 while(end
< path
+ pathlen
&& *end
!= '\0') {
2815 while(end
< path
+ pathlen
&& *end
== '/' && *end
!= '\0') {
2821 while(end
< path
+ pathlen
&& *end
!= '/' && *end
!= '\0') {
2825 if (end
> path
+ pathlen
) {
2826 // hmm, string wasn't null terminated
2831 if (is_package_name(ptr
, end
- ptr
)) {
2844 * Determine if a name is inappropriate for a searchfs query.
2845 * This list consists of /System currently.
2848 int vn_searchfs_inappropriate_name(const char *name
, int len
) {
2849 const char *bad_names
[] = { "System" };
2850 int bad_len
[] = { 6 };
2853 for(i
=0; i
< (int) (sizeof(bad_names
) / sizeof(bad_names
[0])); i
++) {
2854 if (len
== bad_len
[i
] && strncmp(name
, bad_names
[i
], strlen(bad_names
[i
]) + 1) == 0) {
2859 // if we get here, no name matched
2864 * Top level filesystem related information gathering.
2866 extern unsigned int vfs_nummntops
;
2869 * The VFS_NUMMNTOPS shouldn't be at name[1] since
2870 * is a VFS generic variable. Since we no longer support
2871 * VT_UFS, we reserve its value to support this sysctl node.
2873 * It should have been:
2874 * name[0]: VFS_GENERIC
2875 * name[1]: VFS_NUMMNTOPS
2877 SYSCTL_INT(_vfs
, VFS_NUMMNTOPS
, nummntops
,
2878 CTLFLAG_RD
| CTLFLAG_KERN
| CTLFLAG_LOCKED
,
2879 &vfs_nummntops
, 0, "");
2882 vfs_sysctl(int *name __unused
, u_int namelen __unused
,
2883 user_addr_t oldp __unused
, size_t *oldlenp __unused
,
2884 user_addr_t newp __unused
, size_t newlen __unused
, proc_t p __unused
);
2887 vfs_sysctl(int *name __unused
, u_int namelen __unused
,
2888 user_addr_t oldp __unused
, size_t *oldlenp __unused
,
2889 user_addr_t newp __unused
, size_t newlen __unused
, proc_t p __unused
)
2896 // The following code disallows specific sysctl's that came through
2897 // the direct sysctl interface (vfs_sysctl_node) instead of the newer
2898 // sysctl_vfs_ctlbyfsid() interface. We can not allow these selectors
2899 // through vfs_sysctl_node() because it passes the user's oldp pointer
2900 // directly to the file system which (for these selectors) casts it
2901 // back to a struct sysctl_req and then proceed to use SYSCTL_IN()
2902 // which jumps through an arbitrary function pointer. When called
2903 // through the sysctl_vfs_ctlbyfsid() interface this does not happen
2904 // and so it's safe.
2906 // Unfortunately we have to pull in definitions from AFP and SMB and
2907 // perform explicit name checks on the file system to determine if
2908 // these selectors are being used.
2911 #define AFPFS_VFS_CTL_GETID 0x00020001
2912 #define AFPFS_VFS_CTL_NETCHANGE 0x00020002
2913 #define AFPFS_VFS_CTL_VOLCHANGE 0x00020003
2915 #define SMBFS_SYSCTL_REMOUNT 1
2916 #define SMBFS_SYSCTL_REMOUNT_INFO 2
2917 #define SMBFS_SYSCTL_GET_SERVER_SHARE 3
2921 is_bad_sysctl_name(struct vfstable
*vfsp
, int selector_name
)
2923 switch(selector_name
) {
2926 case VFS_CTL_NOLOCKS
:
2927 case VFS_CTL_NSTATUS
:
2930 case VFS_CTL_SERVERINFO
:
2937 // the more complicated check for some of SMB's special values
2938 if (strcmp(vfsp
->vfc_name
, "smbfs") == 0) {
2939 switch(selector_name
) {
2940 case SMBFS_SYSCTL_REMOUNT
:
2941 case SMBFS_SYSCTL_REMOUNT_INFO
:
2942 case SMBFS_SYSCTL_GET_SERVER_SHARE
:
2945 } else if (strcmp(vfsp
->vfc_name
, "afpfs") == 0) {
2946 switch(selector_name
) {
2947 case AFPFS_VFS_CTL_GETID
:
2948 case AFPFS_VFS_CTL_NETCHANGE
:
2949 case AFPFS_VFS_CTL_VOLCHANGE
:
2955 // If we get here we passed all the checks so the selector is ok
2961 int vfs_sysctl_node SYSCTL_HANDLER_ARGS
2964 struct vfstable
*vfsp
;
2968 fstypenum
= oidp
->oid_number
;
2972 /* all sysctl names at this level should have at least one name slot for the FS */
2974 return (EISDIR
); /* overloaded */
2977 for (vfsp
= vfsconf
; vfsp
; vfsp
= vfsp
->vfc_next
)
2978 if (vfsp
->vfc_typenum
== fstypenum
) {
2979 vfsp
->vfc_refcount
++;
2982 mount_list_unlock();
2988 if (is_bad_sysctl_name(vfsp
, name
[0])) {
2989 printf("vfs: bad selector 0x%.8x for old-style sysctl(). use the sysctl-by-fsid interface instead\n", name
[0]);
2993 error
= (vfsp
->vfc_vfsops
->vfs_sysctl
)(name
, namelen
, req
->oldptr
, &req
->oldlen
, req
->newptr
, req
->newlen
, vfs_context_current());
2996 vfsp
->vfc_refcount
--;
2997 mount_list_unlock();
3003 * Check to see if a filesystem is mounted on a block device.
3006 vfs_mountedon(struct vnode
*vp
)
3012 if (vp
->v_specflags
& SI_MOUNTEDON
) {
3016 if (vp
->v_specflags
& SI_ALIASED
) {
3017 for (vq
= *vp
->v_hashchain
; vq
; vq
= vq
->v_specnext
) {
3018 if (vq
->v_rdev
!= vp
->v_rdev
||
3019 vq
->v_type
!= vp
->v_type
)
3021 if (vq
->v_specflags
& SI_MOUNTEDON
) {
3032 struct unmount_info
{
3033 int u_errs
; // Total failed unmounts
3034 int u_busy
; // EBUSY failed unmounts
3038 unmount_callback(mount_t mp
, void *arg
)
3042 struct unmount_info
*uip
= arg
;
3045 mount_iterdrop(mp
); // avoid vfs_iterate deadlock in dounmount()
3047 MALLOC_ZONE(mntname
, void *, MAXPATHLEN
, M_NAMEI
, M_WAITOK
);
3049 strlcpy(mntname
, mp
->mnt_vfsstat
.f_mntonname
, MAXPATHLEN
);
3051 error
= dounmount(mp
, MNT_FORCE
, 1, vfs_context_current());
3054 printf("Unmount of %s failed (%d)\n", mntname
? mntname
:"?", error
);
3059 FREE_ZONE(mntname
, MAXPATHLEN
, M_NAMEI
);
3061 return (VFS_RETURNED
);
3065 * Unmount all filesystems. The list is traversed in reverse order
3066 * of mounting to avoid dependencies.
3067 * Busy mounts are retried.
3069 __private_extern__
void
3070 vfs_unmountall(void)
3072 int mounts
, sec
= 1;
3073 struct unmount_info ui
;
3076 ui
.u_errs
= ui
.u_busy
= 0;
3077 vfs_iterate(VFS_ITERATE_CB_DROPREF
| VFS_ITERATE_TAIL_FIRST
, unmount_callback
, &ui
);
3078 mounts
= mount_getvfscnt();
3082 if (ui
.u_busy
> 0) { // Busy mounts - wait & retry
3083 tsleep(&nummounts
, PVFS
, "busy mount", sec
* hz
);
3087 printf("Unmounting timed out\n");
3088 } else if (ui
.u_errs
< mounts
) {
3089 // If the vfs_iterate missed mounts in progress - wait a bit
3090 tsleep(&nummounts
, PVFS
, "missed mount", 2 * hz
);
3095 * This routine is called from vnode_pager_deallocate out of the VM
3096 * The path to vnode_pager_deallocate can only be initiated by ubc_destroy_named
3097 * on a vnode that has a UBCINFO
3099 __private_extern__
void
3100 vnode_pager_vrele(vnode_t vp
)
3102 struct ubc_info
*uip
;
3104 vnode_lock_spin(vp
);
3106 vp
->v_lflag
&= ~VNAMED_UBC
;
3107 if (vp
->v_usecount
!= 0) {
3109 * At the eleventh hour, just before the ubcinfo is
3110 * destroyed, ensure the ubc-specific v_usecount
3111 * reference has gone. We use v_usecount != 0 as a hint;
3112 * ubc_unmap() does nothing if there's no mapping.
3114 * This case is caused by coming here via forced unmount,
3115 * versus the usual vm_object_deallocate() path.
3116 * In the forced unmount case, ubc_destroy_named()
3117 * releases the pager before memory_object_last_unmap()
3122 vnode_lock_spin(vp
);
3125 uip
= vp
->v_ubcinfo
;
3126 vp
->v_ubcinfo
= UBC_INFO_NULL
;
3130 ubc_info_deallocate(uip
);
3134 #include <sys/disk.h>
3136 u_int32_t rootunit
= (u_int32_t
)-1;
3139 extern int lowpri_throttle_enabled
;
3140 extern int iosched_enabled
;
3144 vfs_init_io_attributes(vnode_t devvp
, mount_t mp
)
3147 off_t readblockcnt
= 0;
3148 off_t writeblockcnt
= 0;
3149 off_t readmaxcnt
= 0;
3150 off_t writemaxcnt
= 0;
3151 off_t readsegcnt
= 0;
3152 off_t writesegcnt
= 0;
3153 off_t readsegsize
= 0;
3154 off_t writesegsize
= 0;
3155 off_t alignment
= 0;
3156 u_int32_t minsaturationbytecount
= 0;
3157 u_int32_t ioqueue_depth
= 0;
3161 vfs_context_t ctx
= vfs_context_current();
3162 dk_corestorage_info_t cs_info
;
3163 boolean_t cs_present
= FALSE
;;
3168 VNOP_IOCTL(devvp
, DKIOCGETTHROTTLEMASK
, (caddr_t
)&mp
->mnt_throttle_mask
, 0, NULL
);
3170 * as a reasonable approximation, only use the lowest bit of the mask
3171 * to generate a disk unit number
3173 mp
->mnt_devbsdunit
= num_trailing_0(mp
->mnt_throttle_mask
);
3175 if (devvp
== rootvp
)
3176 rootunit
= mp
->mnt_devbsdunit
;
3178 if (mp
->mnt_devbsdunit
== rootunit
) {
3180 * this mount point exists on the same device as the root
3181 * partition, so it comes under the hard throttle control...
3182 * this is true even for the root mount point itself
3184 mp
->mnt_kern_flag
|= MNTK_ROOTDEV
;
3187 * force the spec device to re-cache
3188 * the underlying block size in case
3189 * the filesystem overrode the initial value
3191 set_fsblocksize(devvp
);
3194 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETBLOCKSIZE
,
3195 (caddr_t
)&blksize
, 0, ctx
)))
3198 mp
->mnt_devblocksize
= blksize
;
3201 * set the maximum possible I/O size
3202 * this may get clipped to a smaller value
3203 * based on which constraints are being advertised
3204 * and if those advertised constraints result in a smaller
3205 * limit for a given I/O
3207 mp
->mnt_maxreadcnt
= MAX_UPL_SIZE_BYTES
;
3208 mp
->mnt_maxwritecnt
= MAX_UPL_SIZE_BYTES
;
3210 if (VNOP_IOCTL(devvp
, DKIOCISVIRTUAL
, (caddr_t
)&isvirtual
, 0, ctx
) == 0) {
3212 mp
->mnt_kern_flag
|= MNTK_VIRTUALDEV
;
3214 if (VNOP_IOCTL(devvp
, DKIOCISSOLIDSTATE
, (caddr_t
)&isssd
, 0, ctx
) == 0) {
3216 mp
->mnt_kern_flag
|= MNTK_SSD
;
3218 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETFEATURES
,
3219 (caddr_t
)&features
, 0, ctx
)))
3222 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETMAXBLOCKCOUNTREAD
,
3223 (caddr_t
)&readblockcnt
, 0, ctx
)))
3226 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETMAXBLOCKCOUNTWRITE
,
3227 (caddr_t
)&writeblockcnt
, 0, ctx
)))
3230 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETMAXBYTECOUNTREAD
,
3231 (caddr_t
)&readmaxcnt
, 0, ctx
)))
3234 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETMAXBYTECOUNTWRITE
,
3235 (caddr_t
)&writemaxcnt
, 0, ctx
)))
3238 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETMAXSEGMENTCOUNTREAD
,
3239 (caddr_t
)&readsegcnt
, 0, ctx
)))
3242 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETMAXSEGMENTCOUNTWRITE
,
3243 (caddr_t
)&writesegcnt
, 0, ctx
)))
3246 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETMAXSEGMENTBYTECOUNTREAD
,
3247 (caddr_t
)&readsegsize
, 0, ctx
)))
3250 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETMAXSEGMENTBYTECOUNTWRITE
,
3251 (caddr_t
)&writesegsize
, 0, ctx
)))
3254 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETMINSEGMENTALIGNMENTBYTECOUNT
,
3255 (caddr_t
)&alignment
, 0, ctx
)))
3258 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETCOMMANDPOOLSIZE
,
3259 (caddr_t
)&ioqueue_depth
, 0, ctx
)))
3263 mp
->mnt_maxreadcnt
= (readmaxcnt
> UINT32_MAX
) ? UINT32_MAX
: readmaxcnt
;
3266 temp
= readblockcnt
* blksize
;
3267 temp
= (temp
> UINT32_MAX
) ? UINT32_MAX
: temp
;
3269 if (temp
< mp
->mnt_maxreadcnt
)
3270 mp
->mnt_maxreadcnt
= (u_int32_t
)temp
;
3274 mp
->mnt_maxwritecnt
= (writemaxcnt
> UINT32_MAX
) ? UINT32_MAX
: writemaxcnt
;
3276 if (writeblockcnt
) {
3277 temp
= writeblockcnt
* blksize
;
3278 temp
= (temp
> UINT32_MAX
) ? UINT32_MAX
: temp
;
3280 if (temp
< mp
->mnt_maxwritecnt
)
3281 mp
->mnt_maxwritecnt
= (u_int32_t
)temp
;
3285 temp
= (readsegcnt
> UINT16_MAX
) ? UINT16_MAX
: readsegcnt
;
3287 temp
= mp
->mnt_maxreadcnt
/ PAGE_SIZE
;
3289 if (temp
> UINT16_MAX
)
3292 mp
->mnt_segreadcnt
= (u_int16_t
)temp
;
3295 temp
= (writesegcnt
> UINT16_MAX
) ? UINT16_MAX
: writesegcnt
;
3297 temp
= mp
->mnt_maxwritecnt
/ PAGE_SIZE
;
3299 if (temp
> UINT16_MAX
)
3302 mp
->mnt_segwritecnt
= (u_int16_t
)temp
;
3305 temp
= (readsegsize
> UINT32_MAX
) ? UINT32_MAX
: readsegsize
;
3307 temp
= mp
->mnt_maxreadcnt
;
3308 mp
->mnt_maxsegreadsize
= (u_int32_t
)temp
;
3311 temp
= (writesegsize
> UINT32_MAX
) ? UINT32_MAX
: writesegsize
;
3313 temp
= mp
->mnt_maxwritecnt
;
3314 mp
->mnt_maxsegwritesize
= (u_int32_t
)temp
;
3317 temp
= (alignment
> PAGE_SIZE
) ? PAGE_MASK
: alignment
- 1;
3320 mp
->mnt_alignmentmask
= temp
;
3323 if (ioqueue_depth
> MNT_DEFAULT_IOQUEUE_DEPTH
)
3324 temp
= ioqueue_depth
;
3326 temp
= MNT_DEFAULT_IOQUEUE_DEPTH
;
3328 mp
->mnt_ioqueue_depth
= temp
;
3329 mp
->mnt_ioscale
= MNT_IOSCALE(mp
->mnt_ioqueue_depth
);
3331 if (mp
->mnt_ioscale
> 1)
3332 printf("ioqueue_depth = %d, ioscale = %d\n", (int)mp
->mnt_ioqueue_depth
, (int)mp
->mnt_ioscale
);
3334 if (features
& DK_FEATURE_FORCE_UNIT_ACCESS
)
3335 mp
->mnt_ioflags
|= MNT_IOFLAGS_FUA_SUPPORTED
;
3337 if (VNOP_IOCTL(devvp
, DKIOCGETIOMINSATURATIONBYTECOUNT
, (caddr_t
)&minsaturationbytecount
, 0, ctx
) == 0) {
3338 mp
->mnt_minsaturationbytecount
= minsaturationbytecount
;
3340 mp
->mnt_minsaturationbytecount
= 0;
3343 if (VNOP_IOCTL(devvp
, DKIOCCORESTORAGE
, (caddr_t
)&cs_info
, 0, ctx
) == 0)
3346 if (features
& DK_FEATURE_UNMAP
) {
3347 mp
->mnt_ioflags
|= MNT_IOFLAGS_UNMAP_SUPPORTED
;
3349 if (cs_present
== TRUE
)
3350 mp
->mnt_ioflags
|= MNT_IOFLAGS_CSUNMAP_SUPPORTED
;
3352 if (cs_present
== TRUE
) {
3354 * for now we'll use the following test as a proxy for
3355 * the underlying drive being FUSION in nature
3357 if ((cs_info
.flags
& DK_CORESTORAGE_PIN_YOUR_METADATA
))
3358 mp
->mnt_ioflags
|= MNT_IOFLAGS_FUSION_DRIVE
;
3360 /* Check for APFS Fusion */
3361 dk_apfs_flavour_t flavour
;
3362 if ((VNOP_IOCTL(devvp
, DKIOCGETAPFSFLAVOUR
, (caddr_t
)&flavour
, 0, ctx
) == 0) &&
3363 (flavour
== DK_APFS_FUSION
)) {
3364 mp
->mnt_ioflags
|= MNT_IOFLAGS_FUSION_DRIVE
;
3369 if (iosched_enabled
&& (features
& DK_FEATURE_PRIORITY
)) {
3370 mp
->mnt_ioflags
|= MNT_IOFLAGS_IOSCHED_SUPPORTED
;
3371 throttle_info_disable_throttle(mp
->mnt_devbsdunit
, (mp
->mnt_ioflags
& MNT_IOFLAGS_FUSION_DRIVE
) != 0);
3373 #endif /* CONFIG_IOSCHED */
3377 static struct klist fs_klist
;
3378 lck_grp_t
*fs_klist_lck_grp
;
3379 lck_mtx_t
*fs_klist_lock
;
3382 vfs_event_init(void)
3385 klist_init(&fs_klist
);
3386 fs_klist_lck_grp
= lck_grp_alloc_init("fs_klist", NULL
);
3387 fs_klist_lock
= lck_mtx_alloc_init(fs_klist_lck_grp
, NULL
);
3391 vfs_event_signal(fsid_t
*fsid
, u_int32_t event
, intptr_t data
)
3393 if (event
== VQ_DEAD
|| event
== VQ_NOTRESP
) {
3394 struct mount
*mp
= vfs_getvfs(fsid
);
3396 mount_lock_spin(mp
);
3398 mp
->mnt_kern_flag
&= ~MNT_LNOTRESP
; // Now responding
3400 mp
->mnt_kern_flag
|= MNT_LNOTRESP
; // Not responding
3405 lck_mtx_lock(fs_klist_lock
);
3406 KNOTE(&fs_klist
, event
);
3407 lck_mtx_unlock(fs_klist_lock
);
3411 * return the number of mounted filesystems.
3414 sysctl_vfs_getvfscnt(void)
3416 return(mount_getvfscnt());
3421 mount_getvfscnt(void)
3427 mount_list_unlock();
3435 mount_fillfsids(fsid_t
*fsidlst
, int count
)
3442 TAILQ_FOREACH(mp
, &mountlist
, mnt_list
) {
3443 if (actual
<= count
) {
3444 fsidlst
[actual
] = mp
->mnt_vfsstat
.f_fsid
;
3448 mount_list_unlock();
3454 * fill in the array of fsid_t's up to a max of 'count', the actual
3455 * number filled in will be set in '*actual'. If there are more fsid_t's
3456 * than room in fsidlst then ENOMEM will be returned and '*actual' will
3457 * have the actual count.
3458 * having *actual filled out even in the error case is depended upon.
3461 sysctl_vfs_getvfslist(fsid_t
*fsidlst
, int count
, int *actual
)
3467 TAILQ_FOREACH(mp
, &mountlist
, mnt_list
) {
3469 if (*actual
<= count
)
3470 fsidlst
[(*actual
) - 1] = mp
->mnt_vfsstat
.f_fsid
;
3472 mount_list_unlock();
3473 return (*actual
<= count
? 0 : ENOMEM
);
3477 sysctl_vfs_vfslist(__unused
struct sysctl_oid
*oidp
, __unused
void *arg1
,
3478 __unused
int arg2
, struct sysctl_req
*req
)
3484 /* This is a readonly node. */
3485 if (req
->newptr
!= USER_ADDR_NULL
)
3488 /* they are querying us so just return the space required. */
3489 if (req
->oldptr
== USER_ADDR_NULL
) {
3490 req
->oldidx
= sysctl_vfs_getvfscnt() * sizeof(fsid_t
);
3495 * Retrieve an accurate count of the amount of space required to copy
3496 * out all the fsids in the system.
3498 space
= req
->oldlen
;
3499 req
->oldlen
= sysctl_vfs_getvfscnt() * sizeof(fsid_t
);
3501 /* they didn't give us enough space. */
3502 if (space
< req
->oldlen
)
3505 MALLOC(fsidlst
, fsid_t
*, req
->oldlen
, M_TEMP
, M_WAITOK
| M_ZERO
);
3506 if (fsidlst
== NULL
) {
3510 error
= sysctl_vfs_getvfslist(fsidlst
, req
->oldlen
/ sizeof(fsid_t
),
3513 * If we get back ENOMEM, then another mount has been added while we
3514 * slept in malloc above. If this is the case then try again.
3516 if (error
== ENOMEM
) {
3517 FREE(fsidlst
, M_TEMP
);
3518 req
->oldlen
= space
;
3522 error
= SYSCTL_OUT(req
, fsidlst
, actual
* sizeof(fsid_t
));
3524 FREE(fsidlst
, M_TEMP
);
3529 * Do a sysctl by fsid.
3532 sysctl_vfs_ctlbyfsid(__unused
struct sysctl_oid
*oidp
, void *arg1
, int arg2
,
3533 struct sysctl_req
*req
)
3535 union union_vfsidctl vc
;
3537 struct vfsstatfs
*sp
;
3538 int *name
, flags
, namelen
;
3539 int error
=0, gotref
=0;
3540 vfs_context_t ctx
= vfs_context_current();
3541 proc_t p
= req
->p
; /* XXX req->p != current_proc()? */
3542 boolean_t is_64_bit
;
3546 is_64_bit
= proc_is64bit(p
);
3548 error
= SYSCTL_IN(req
, &vc
, is_64_bit
? sizeof(vc
.vc64
):sizeof(vc
.vc32
));
3551 if (vc
.vc32
.vc_vers
!= VFS_CTL_VERS1
) { /* works for 32 and 64 */
3555 mp
= mount_list_lookupby_fsid(&vc
.vc32
.vc_fsid
, 0, 1); /* works for 32 and 64 */
3561 /* reset so that the fs specific code can fetch it. */
3564 * Note if this is a VFS_CTL then we pass the actual sysctl req
3565 * in for "oldp" so that the lower layer can DTRT and use the
3566 * SYSCTL_IN/OUT routines.
3568 if (mp
->mnt_op
->vfs_sysctl
!= NULL
) {
3570 if (vfs_64bitready(mp
)) {
3571 error
= mp
->mnt_op
->vfs_sysctl(name
, namelen
,
3572 CAST_USER_ADDR_T(req
),
3573 NULL
, USER_ADDR_NULL
, 0,
3581 error
= mp
->mnt_op
->vfs_sysctl(name
, namelen
,
3582 CAST_USER_ADDR_T(req
),
3583 NULL
, USER_ADDR_NULL
, 0,
3586 if (error
!= ENOTSUP
) {
3591 case VFS_CTL_UMOUNT
:
3594 req
->newptr
= vc
.vc64
.vc_ptr
;
3595 req
->newlen
= (size_t)vc
.vc64
.vc_len
;
3598 req
->newptr
= CAST_USER_ADDR_T(vc
.vc32
.vc_ptr
);
3599 req
->newlen
= vc
.vc32
.vc_len
;
3601 error
= SYSCTL_IN(req
, &flags
, sizeof(flags
));
3608 /* safedounmount consumes a ref */
3609 error
= safedounmount(mp
, flags
, ctx
);
3611 case VFS_CTL_STATFS
:
3614 req
->newptr
= vc
.vc64
.vc_ptr
;
3615 req
->newlen
= (size_t)vc
.vc64
.vc_len
;
3618 req
->newptr
= CAST_USER_ADDR_T(vc
.vc32
.vc_ptr
);
3619 req
->newlen
= vc
.vc32
.vc_len
;
3621 error
= SYSCTL_IN(req
, &flags
, sizeof(flags
));
3624 sp
= &mp
->mnt_vfsstat
;
3625 if (((flags
& MNT_NOWAIT
) == 0 || (flags
& (MNT_WAIT
| MNT_DWAIT
))) &&
3626 (error
= vfs_update_vfsstat(mp
, ctx
, VFS_USER_EVENT
)))
3629 struct user64_statfs sfs
;
3630 bzero(&sfs
, sizeof(sfs
));
3631 sfs
.f_flags
= mp
->mnt_flag
& MNT_VISFLAGMASK
;
3632 sfs
.f_type
= mp
->mnt_vtable
->vfc_typenum
;
3633 sfs
.f_bsize
= (user64_long_t
)sp
->f_bsize
;
3634 sfs
.f_iosize
= (user64_long_t
)sp
->f_iosize
;
3635 sfs
.f_blocks
= (user64_long_t
)sp
->f_blocks
;
3636 sfs
.f_bfree
= (user64_long_t
)sp
->f_bfree
;
3637 sfs
.f_bavail
= (user64_long_t
)sp
->f_bavail
;
3638 sfs
.f_files
= (user64_long_t
)sp
->f_files
;
3639 sfs
.f_ffree
= (user64_long_t
)sp
->f_ffree
;
3640 sfs
.f_fsid
= sp
->f_fsid
;
3641 sfs
.f_owner
= sp
->f_owner
;
3643 if (mp
->mnt_kern_flag
& MNTK_TYPENAME_OVERRIDE
) {
3644 strlcpy(&sfs
.f_fstypename
[0], &mp
->fstypename_override
[0], MFSNAMELEN
);
3648 strlcpy(sfs
.f_fstypename
, sp
->f_fstypename
, MFSNAMELEN
);
3650 strlcpy(sfs
.f_mntonname
, sp
->f_mntonname
, MNAMELEN
);
3651 strlcpy(sfs
.f_mntfromname
, sp
->f_mntfromname
, MNAMELEN
);
3653 error
= SYSCTL_OUT(req
, &sfs
, sizeof(sfs
));
3656 struct user32_statfs sfs
;
3657 bzero(&sfs
, sizeof(sfs
));
3658 sfs
.f_flags
= mp
->mnt_flag
& MNT_VISFLAGMASK
;
3659 sfs
.f_type
= mp
->mnt_vtable
->vfc_typenum
;
3662 * It's possible for there to be more than 2^^31 blocks in the filesystem, so we
3663 * have to fudge the numbers here in that case. We inflate the blocksize in order
3664 * to reflect the filesystem size as best we can.
3666 if (sp
->f_blocks
> INT_MAX
) {
3670 * Work out how far we have to shift the block count down to make it fit.
3671 * Note that it's possible to have to shift so far that the resulting
3672 * blocksize would be unreportably large. At that point, we will clip
3673 * any values that don't fit.
3675 * For safety's sake, we also ensure that f_iosize is never reported as
3676 * being smaller than f_bsize.
3678 for (shift
= 0; shift
< 32; shift
++) {
3679 if ((sp
->f_blocks
>> shift
) <= INT_MAX
)
3681 if ((((long long)sp
->f_bsize
) << (shift
+ 1)) > INT_MAX
)
3684 #define __SHIFT_OR_CLIP(x, s) ((((x) >> (s)) > INT_MAX) ? INT_MAX : ((x) >> (s)))
3685 sfs
.f_blocks
= (user32_long_t
)__SHIFT_OR_CLIP(sp
->f_blocks
, shift
);
3686 sfs
.f_bfree
= (user32_long_t
)__SHIFT_OR_CLIP(sp
->f_bfree
, shift
);
3687 sfs
.f_bavail
= (user32_long_t
)__SHIFT_OR_CLIP(sp
->f_bavail
, shift
);
3688 #undef __SHIFT_OR_CLIP
3689 sfs
.f_bsize
= (user32_long_t
)(sp
->f_bsize
<< shift
);
3690 sfs
.f_iosize
= lmax(sp
->f_iosize
, sp
->f_bsize
);
3692 sfs
.f_bsize
= (user32_long_t
)sp
->f_bsize
;
3693 sfs
.f_iosize
= (user32_long_t
)sp
->f_iosize
;
3694 sfs
.f_blocks
= (user32_long_t
)sp
->f_blocks
;
3695 sfs
.f_bfree
= (user32_long_t
)sp
->f_bfree
;
3696 sfs
.f_bavail
= (user32_long_t
)sp
->f_bavail
;
3698 sfs
.f_files
= (user32_long_t
)sp
->f_files
;
3699 sfs
.f_ffree
= (user32_long_t
)sp
->f_ffree
;
3700 sfs
.f_fsid
= sp
->f_fsid
;
3701 sfs
.f_owner
= sp
->f_owner
;
3704 if (mp
->mnt_kern_flag
& MNTK_TYPENAME_OVERRIDE
) {
3705 strlcpy(&sfs
.f_fstypename
[0], &mp
->fstypename_override
[0], MFSNAMELEN
);
3709 strlcpy(sfs
.f_fstypename
, sp
->f_fstypename
, MFSNAMELEN
);
3711 strlcpy(sfs
.f_mntonname
, sp
->f_mntonname
, MNAMELEN
);
3712 strlcpy(sfs
.f_mntfromname
, sp
->f_mntfromname
, MNAMELEN
);
3714 error
= SYSCTL_OUT(req
, &sfs
, sizeof(sfs
));
3727 static int filt_fsattach(struct knote
*kn
, struct kevent_internal_s
*kev
);
3728 static void filt_fsdetach(struct knote
*kn
);
3729 static int filt_fsevent(struct knote
*kn
, long hint
);
3730 static int filt_fstouch(struct knote
*kn
, struct kevent_internal_s
*kev
);
3731 static int filt_fsprocess(struct knote
*kn
, struct filt_process_s
*data
, struct kevent_internal_s
*kev
);
3732 SECURITY_READ_ONLY_EARLY(struct filterops
) fs_filtops
= {
3733 .f_attach
= filt_fsattach
,
3734 .f_detach
= filt_fsdetach
,
3735 .f_event
= filt_fsevent
,
3736 .f_touch
= filt_fstouch
,
3737 .f_process
= filt_fsprocess
,
3741 filt_fsattach(struct knote
*kn
, __unused
struct kevent_internal_s
*kev
)
3743 lck_mtx_lock(fs_klist_lock
);
3744 KNOTE_ATTACH(&fs_klist
, kn
);
3745 lck_mtx_unlock(fs_klist_lock
);
3748 * filter only sees future events,
3749 * so it can't be fired already.
3755 filt_fsdetach(struct knote
*kn
)
3757 lck_mtx_lock(fs_klist_lock
);
3758 KNOTE_DETACH(&fs_klist
, kn
);
3759 lck_mtx_unlock(fs_klist_lock
);
3763 filt_fsevent(struct knote
*kn
, long hint
)
3766 * Backwards compatibility:
3767 * Other filters would do nothing if kn->kn_sfflags == 0
3770 if ((kn
->kn_sfflags
== 0) || (kn
->kn_sfflags
& hint
)) {
3771 kn
->kn_fflags
|= hint
;
3774 return (kn
->kn_fflags
!= 0);
3778 filt_fstouch(struct knote
*kn
, struct kevent_internal_s
*kev
)
3782 lck_mtx_lock(fs_klist_lock
);
3784 kn
->kn_sfflags
= kev
->fflags
;
3787 * the above filter function sets bits even if nobody is looking for them.
3788 * Just preserve those bits even in the new mask is more selective
3791 * For compatibility with previous implementations, we leave kn_fflags
3792 * as they were before.
3794 //if (kn->kn_sfflags)
3795 // kn->kn_fflags &= kn->kn_sfflags;
3796 res
= (kn
->kn_fflags
!= 0);
3798 lck_mtx_unlock(fs_klist_lock
);
3804 filt_fsprocess(struct knote
*kn
, struct filt_process_s
*data
, struct kevent_internal_s
*kev
)
3806 #pragma unused(data)
3809 lck_mtx_lock(fs_klist_lock
);
3810 res
= (kn
->kn_fflags
!= 0);
3812 *kev
= kn
->kn_kevent
;
3813 kn
->kn_flags
|= EV_CLEAR
; /* automatic */
3817 lck_mtx_unlock(fs_klist_lock
);
3822 sysctl_vfs_noremotehang(__unused
struct sysctl_oid
*oidp
,
3823 __unused
void *arg1
, __unused
int arg2
, struct sysctl_req
*req
)
3829 /* We need a pid. */
3830 if (req
->newptr
== USER_ADDR_NULL
)
3833 error
= SYSCTL_IN(req
, &pid
, sizeof(pid
));
3837 p
= proc_find(pid
< 0 ? -pid
: pid
);
3842 * Fetching the value is ok, but we only fetch if the old
3845 if (req
->oldptr
!= USER_ADDR_NULL
) {
3846 out
= !((p
->p_flag
& P_NOREMOTEHANG
) == 0);
3848 error
= SYSCTL_OUT(req
, &out
, sizeof(out
));
3852 /* cansignal offers us enough security. */
3853 if (p
!= req
->p
&& proc_suser(req
->p
) != 0) {
3859 OSBitAndAtomic(~((uint32_t)P_NOREMOTEHANG
), &p
->p_flag
);
3861 OSBitOrAtomic(P_NOREMOTEHANG
, &p
->p_flag
);
3868 sysctl_vfs_generic_conf SYSCTL_HANDLER_ARGS
3871 struct vfstable
*vfsp
;
3872 struct vfsconf vfsc
= {};
3880 } else if (namelen
> 1) {
3885 for (vfsp
= vfsconf
; vfsp
; vfsp
= vfsp
->vfc_next
)
3886 if (vfsp
->vfc_typenum
== name
[0])
3890 mount_list_unlock();
3894 vfsc
.vfc_reserved1
= 0;
3895 bcopy(vfsp
->vfc_name
, vfsc
.vfc_name
, sizeof(vfsc
.vfc_name
));
3896 vfsc
.vfc_typenum
= vfsp
->vfc_typenum
;
3897 vfsc
.vfc_refcount
= vfsp
->vfc_refcount
;
3898 vfsc
.vfc_flags
= vfsp
->vfc_flags
;
3899 vfsc
.vfc_reserved2
= 0;
3900 vfsc
.vfc_reserved3
= 0;
3902 mount_list_unlock();
3903 return (SYSCTL_OUT(req
, &vfsc
, sizeof(struct vfsconf
)));
3906 /* the vfs.generic. branch. */
3907 SYSCTL_NODE(_vfs
, VFS_GENERIC
, generic
, CTLFLAG_RW
| CTLFLAG_LOCKED
, NULL
, "vfs generic hinge");
3908 /* retreive a list of mounted filesystem fsid_t */
3909 SYSCTL_PROC(_vfs_generic
, OID_AUTO
, vfsidlist
,
3910 CTLTYPE_STRUCT
| CTLFLAG_RD
| CTLFLAG_LOCKED
,
3911 NULL
, 0, sysctl_vfs_vfslist
, "S,fsid", "List of mounted filesystem ids");
3912 /* perform operations on filesystem via fsid_t */
3913 SYSCTL_NODE(_vfs_generic
, OID_AUTO
, ctlbyfsid
, CTLFLAG_RW
| CTLFLAG_LOCKED
,
3914 sysctl_vfs_ctlbyfsid
, "ctlbyfsid");
3915 SYSCTL_PROC(_vfs_generic
, OID_AUTO
, noremotehang
, CTLFLAG_RW
| CTLFLAG_ANYBODY
,
3916 NULL
, 0, sysctl_vfs_noremotehang
, "I", "noremotehang");
3917 SYSCTL_INT(_vfs_generic
, VFS_MAXTYPENUM
, maxtypenum
,
3918 CTLFLAG_RD
| CTLFLAG_KERN
| CTLFLAG_LOCKED
,
3919 &maxvfstypenum
, 0, "");
3920 SYSCTL_INT(_vfs_generic
, OID_AUTO
, sync_timeout
, CTLFLAG_RW
| CTLFLAG_LOCKED
, &sync_timeout_seconds
, 0, "");
3921 SYSCTL_NODE(_vfs_generic
, VFS_CONF
, conf
,
3922 CTLFLAG_RD
| CTLFLAG_LOCKED
,
3923 sysctl_vfs_generic_conf
, "");
3925 /* Indicate that the root file system unmounted cleanly */
3926 static int vfs_root_unmounted_cleanly
= 0;
3927 SYSCTL_INT(_vfs_generic
, OID_AUTO
, root_unmounted_cleanly
, CTLFLAG_RD
, &vfs_root_unmounted_cleanly
, 0, "Root filesystem was unmounted cleanly");
3930 vfs_set_root_unmounted_cleanly(void)
3932 vfs_root_unmounted_cleanly
= 1;
3936 * Print vnode state.
3939 vn_print_state(struct vnode
*vp
, const char *fmt
, ...)
3942 char perm_str
[] = "(VM_KERNEL_ADDRPERM pointer)";
3943 char fs_name
[MFSNAMELEN
];
3948 printf("vp 0x%0llx %s: ", (uint64_t)VM_KERNEL_ADDRPERM(vp
), perm_str
);
3949 printf("tag %d, type %d\n", vp
->v_tag
, vp
->v_type
);
3951 printf(" iocount %d, usecount %d, kusecount %d references %d\n",
3952 vp
->v_iocount
, vp
->v_usecount
, vp
->v_kusecount
, vp
->v_references
);
3953 printf(" writecount %d, numoutput %d\n", vp
->v_writecount
,
3956 printf(" flag 0x%x, lflag 0x%x, listflag 0x%x\n", vp
->v_flag
,
3957 vp
->v_lflag
, vp
->v_listflag
);
3959 if (vp
->v_mount
== NULL
|| vp
->v_mount
== dead_mountp
) {
3960 strlcpy(fs_name
, "deadfs", MFSNAMELEN
);
3962 vfs_name(vp
->v_mount
, fs_name
);
3965 printf(" v_data 0x%0llx %s\n",
3966 (vp
->v_data
? (uint64_t)VM_KERNEL_ADDRPERM(vp
->v_data
) : 0),
3968 printf(" v_mount 0x%0llx %s vfs_name %s\n",
3969 (vp
->v_mount
? (uint64_t)VM_KERNEL_ADDRPERM(vp
->v_mount
) : 0),
3973 long num_reusedvnodes
= 0;
3977 process_vp(vnode_t vp
, int want_vp
, int *deferred
)
3985 vnode_list_remove_locked(vp
);
3987 vnode_list_unlock();
3989 vnode_lock_spin(vp
);
3992 * We could wait for the vnode_lock after removing the vp from the freelist
3993 * and the vid is bumped only at the very end of reclaim. So it is possible
3994 * that we are looking at a vnode that is being terminated. If so skip it.
3996 if ((vpid
!= vp
->v_id
) || (vp
->v_usecount
!= 0) || (vp
->v_iocount
!= 0) ||
3997 VONLIST(vp
) || (vp
->v_lflag
& VL_TERMINATE
)) {
3999 * we lost the race between dropping the list lock
4000 * and picking up the vnode_lock... someone else
4001 * used this vnode and it is now in a new state
4007 if ( (vp
->v_lflag
& (VL_NEEDINACTIVE
| VL_MARKTERM
)) == VL_NEEDINACTIVE
) {
4009 * we did a vnode_rele_ext that asked for
4010 * us not to reenter the filesystem during
4011 * the release even though VL_NEEDINACTIVE was
4012 * set... we'll do it here by doing a
4013 * vnode_get/vnode_put
4015 * pick up an iocount so that we can call
4016 * vnode_put and drive the VNOP_INACTIVE...
4017 * vnode_put will either leave us off
4018 * the freelist if a new ref comes in,
4019 * or put us back on the end of the freelist
4020 * or recycle us if we were marked for termination...
4021 * so we'll just go grab a new candidate
4027 vnode_put_locked(vp
);
4033 * Checks for anyone racing us for recycle
4035 if (vp
->v_type
!= VBAD
) {
4036 if (want_vp
&& (vnode_on_reliable_media(vp
) == FALSE
|| (vp
->v_flag
& VISDIRTY
))) {
4037 vnode_async_list_add(vp
);
4044 if (vp
->v_lflag
& VL_DEAD
)
4045 panic("new_vnode(%p): the vnode is VL_DEAD but not VBAD", vp
);
4047 vnode_lock_convert(vp
);
4048 (void)vnode_reclaim_internal(vp
, 1, want_vp
, 0);
4052 panic("new_vnode(%p): vp on list", vp
);
4053 if (vp
->v_usecount
|| vp
->v_iocount
|| vp
->v_kusecount
||
4054 (vp
->v_lflag
& (VNAMED_UBC
| VNAMED_MOUNT
| VNAMED_FSHASH
)))
4055 panic("new_vnode(%p): free vnode still referenced", vp
);
4056 if ((vp
->v_mntvnodes
.tqe_prev
!= 0) && (vp
->v_mntvnodes
.tqe_next
!= 0))
4057 panic("new_vnode(%p): vnode seems to be on mount list", vp
);
4058 if ( !LIST_EMPTY(&vp
->v_nclinks
) || !TAILQ_EMPTY(&vp
->v_ncchildren
))
4059 panic("new_vnode(%p): vnode still hooked into the name cache", vp
);
4068 __attribute__((noreturn
))
4070 async_work_continue(void)
4072 struct async_work_lst
*q
;
4076 q
= &vnode_async_work_list
;
4082 if ( TAILQ_EMPTY(q
) ) {
4083 assert_wait(q
, (THREAD_UNINT
));
4085 vnode_list_unlock();
4087 thread_block((thread_continue_t
)async_work_continue
);
4091 async_work_handled
++;
4093 vp
= TAILQ_FIRST(q
);
4095 vp
= process_vp(vp
, 0, &deferred
);
4098 panic("found VBAD vp (%p) on async queue", vp
);
4104 new_vnode(vnode_t
*vpp
)
4107 uint32_t retries
= 0, max_retries
= 100; /* retry incase of tablefull */
4108 int force_alloc
= 0, walk_count
= 0;
4109 boolean_t need_reliable_vp
= FALSE
;
4111 struct timeval initial_tv
;
4112 struct timeval current_tv
;
4113 proc_t curproc
= current_proc();
4115 initial_tv
.tv_sec
= 0;
4121 if (need_reliable_vp
== TRUE
)
4122 async_work_timed_out
++;
4124 if ((numvnodes
- deadvnodes
) < desiredvnodes
|| force_alloc
) {
4127 if ( !TAILQ_EMPTY(&vnode_dead_list
)) {
4129 * Can always reuse a dead one
4131 vp
= TAILQ_FIRST(&vnode_dead_list
);
4135 * no dead vnodes available... if we're under
4136 * the limit, we'll create a new vnode
4139 vnode_list_unlock();
4141 MALLOC_ZONE(vp
, struct vnode
*, sizeof(*vp
), M_VNODE
, M_WAITOK
);
4142 bzero((char *)vp
, sizeof(*vp
));
4143 VLISTNONE(vp
); /* avoid double queue removal */
4144 lck_mtx_init(&vp
->v_lock
, vnode_lck_grp
, vnode_lck_attr
);
4146 TAILQ_INIT(&vp
->v_ncchildren
);
4148 klist_init(&vp
->v_knotes
);
4150 vp
->v_id
= ts
.tv_nsec
;
4151 vp
->v_flag
= VSTANDARD
;
4154 if (mac_vnode_label_init_needed(vp
))
4155 mac_vnode_label_init(vp
);
4161 microuptime(¤t_tv
);
4163 #define MAX_WALK_COUNT 1000
4165 if ( !TAILQ_EMPTY(&vnode_rage_list
) &&
4166 (ragevnodes
>= rage_limit
||
4167 (current_tv
.tv_sec
- rage_tv
.tv_sec
) >= RAGE_TIME_LIMIT
)) {
4169 TAILQ_FOREACH(vp
, &vnode_rage_list
, v_freelist
) {
4170 if ( !(vp
->v_listflag
& VLIST_RAGE
))
4171 panic("new_vnode: vp (%p) on RAGE list not marked VLIST_RAGE", vp
);
4173 // if we're a dependency-capable process, skip vnodes that can
4174 // cause recycling deadlocks. (i.e. this process is diskimages
4175 // helper and the vnode is in a disk image). Querying the
4176 // mnt_kern_flag for the mount's virtual device status
4177 // is safer than checking the mnt_dependent_process, which
4178 // may not be updated if there are multiple devnode layers
4179 // in between the disk image and the final consumer.
4181 if ((curproc
->p_flag
& P_DEPENDENCY_CAPABLE
) == 0 || vp
->v_mount
== NULL
||
4182 (vp
->v_mount
->mnt_kern_flag
& MNTK_VIRTUALDEV
) == 0) {
4184 * if need_reliable_vp == TRUE, then we've already sent one or more
4185 * non-reliable vnodes to the async thread for processing and timed
4186 * out waiting for a dead vnode to show up. Use the MAX_WALK_COUNT
4187 * mechanism to first scan for a reliable vnode before forcing
4188 * a new vnode to be created
4190 if (need_reliable_vp
== FALSE
|| vnode_on_reliable_media(vp
) == TRUE
)
4194 // don't iterate more than MAX_WALK_COUNT vnodes to
4195 // avoid keeping the vnode list lock held for too long.
4197 if (walk_count
++ > MAX_WALK_COUNT
) {
4204 if (vp
== NULL
&& !TAILQ_EMPTY(&vnode_free_list
)) {
4206 * Pick the first vp for possible reuse
4209 TAILQ_FOREACH(vp
, &vnode_free_list
, v_freelist
) {
4211 // if we're a dependency-capable process, skip vnodes that can
4212 // cause recycling deadlocks. (i.e. this process is diskimages
4213 // helper and the vnode is in a disk image). Querying the
4214 // mnt_kern_flag for the mount's virtual device status
4215 // is safer than checking the mnt_dependent_process, which
4216 // may not be updated if there are multiple devnode layers
4217 // in between the disk image and the final consumer.
4219 if ((curproc
->p_flag
& P_DEPENDENCY_CAPABLE
) == 0 || vp
->v_mount
== NULL
||
4220 (vp
->v_mount
->mnt_kern_flag
& MNTK_VIRTUALDEV
) == 0) {
4222 * if need_reliable_vp == TRUE, then we've already sent one or more
4223 * non-reliable vnodes to the async thread for processing and timed
4224 * out waiting for a dead vnode to show up. Use the MAX_WALK_COUNT
4225 * mechanism to first scan for a reliable vnode before forcing
4226 * a new vnode to be created
4228 if (need_reliable_vp
== FALSE
|| vnode_on_reliable_media(vp
) == TRUE
)
4232 // don't iterate more than MAX_WALK_COUNT vnodes to
4233 // avoid keeping the vnode list lock held for too long.
4235 if (walk_count
++ > MAX_WALK_COUNT
) {
4243 // if we don't have a vnode and the walk_count is >= MAX_WALK_COUNT
4244 // then we're trying to create a vnode on behalf of a
4245 // process like diskimages-helper that has file systems
4246 // mounted on top of itself (and thus we can't reclaim
4247 // vnodes in the file systems on top of us). if we can't
4248 // find a vnode to reclaim then we'll just have to force
4251 if (vp
== NULL
&& walk_count
>= MAX_WALK_COUNT
) {
4253 vnode_list_unlock();
4259 * we've reached the system imposed maximum number of vnodes
4260 * but there isn't a single one available
4261 * wait a bit and then retry... if we can't get a vnode
4262 * after our target number of retries, than log a complaint
4264 if (++retries
<= max_retries
) {
4265 vnode_list_unlock();
4266 delay_for_interval(1, 1000 * 1000);
4270 vnode_list_unlock();
4272 log(LOG_EMERG
, "%d desired, %d numvnodes, "
4273 "%d free, %d dead, %d async, %d rage\n",
4274 desiredvnodes
, numvnodes
, freevnodes
, deadvnodes
, async_work_vnodes
, ragevnodes
);
4277 #if DEVELOPMENT || DEBUG
4278 if (bootarg_no_vnode_jetsam
)
4279 panic("vnode table is full\n");
4280 #endif /* DEVELOPMENT || DEBUG */
4283 * Running out of vnodes tends to make a system unusable. Start killing
4284 * processes that jetsam knows are killable.
4286 if (memorystatus_kill_on_vnode_limit() == FALSE
) {
4288 * If jetsam can't find any more processes to kill and there
4289 * still aren't any free vnodes, panic. Hopefully we'll get a
4290 * panic log to tell us why we ran out.
4292 panic("vnode table is full\n");
4296 * Now that we've killed someone, wait a bit and continue looking
4297 * (with fewer retries before trying another kill).
4299 delay_for_interval(3, 1000 * 1000);
4309 if ((vp
= process_vp(vp
, 1, &deferred
)) == NULLVP
) {
4312 struct timeval elapsed_tv
;
4314 if (initial_tv
.tv_sec
== 0)
4315 microuptime(&initial_tv
);
4319 dead_vnode_waited
++;
4320 dead_vnode_wanted
++;
4323 * note that we're only going to explicitly wait 10ms
4324 * for a dead vnode to become available, since even if one
4325 * isn't available, a reliable vnode might now be available
4326 * at the head of the VRAGE or free lists... if so, we
4327 * can satisfy the new_vnode request with less latency then waiting
4328 * for the full 100ms duration we're ultimately willing to tolerate
4330 assert_wait_timeout((caddr_t
)&dead_vnode_wanted
, (THREAD_INTERRUPTIBLE
), 10000, NSEC_PER_USEC
);
4332 vnode_list_unlock();
4334 thread_block(THREAD_CONTINUE_NULL
);
4336 microuptime(&elapsed_tv
);
4338 timevalsub(&elapsed_tv
, &initial_tv
);
4339 elapsed_msecs
= elapsed_tv
.tv_sec
* 1000 + elapsed_tv
.tv_usec
/ 1000;
4341 if (elapsed_msecs
>= 100) {
4343 * we've waited long enough... 100ms is
4344 * somewhat arbitrary for this case, but the
4345 * normal worst case latency used for UI
4346 * interaction is 100ms, so I've chosen to
4349 * setting need_reliable_vp to TRUE
4350 * forces us to find a reliable vnode
4351 * that we can process synchronously, or
4352 * to create a new one if the scan for
4353 * a reliable one hits the scan limit
4355 need_reliable_vp
= TRUE
;
4360 OSAddAtomicLong(1, &num_reusedvnodes
);
4365 * We should never see VL_LABELWAIT or VL_LABEL here.
4366 * as those operations hold a reference.
4368 assert ((vp
->v_lflag
& VL_LABELWAIT
) != VL_LABELWAIT
);
4369 assert ((vp
->v_lflag
& VL_LABEL
) != VL_LABEL
);
4370 if (vp
->v_lflag
& VL_LABELED
) {
4371 vnode_lock_convert(vp
);
4372 mac_vnode_label_recycle(vp
);
4373 } else if (mac_vnode_label_init_needed(vp
)) {
4374 vnode_lock_convert(vp
);
4375 mac_vnode_label_init(vp
);
4382 vp
->v_writecount
= 0;
4383 vp
->v_references
= 0;
4384 vp
->v_iterblkflags
= 0;
4385 vp
->v_flag
= VSTANDARD
;
4386 /* vbad vnodes can point to dead_mountp */
4388 vp
->v_defer_reclaimlist
= (vnode_t
)0;
4399 vnode_lock(vnode_t vp
)
4401 lck_mtx_lock(&vp
->v_lock
);
4405 vnode_lock_spin(vnode_t vp
)
4407 lck_mtx_lock_spin(&vp
->v_lock
);
4411 vnode_unlock(vnode_t vp
)
4413 lck_mtx_unlock(&vp
->v_lock
);
4419 vnode_get(struct vnode
*vp
)
4423 vnode_lock_spin(vp
);
4424 retval
= vnode_get_locked(vp
);
4431 vnode_get_locked(struct vnode
*vp
)
4434 lck_mtx_assert(&vp
->v_lock
, LCK_MTX_ASSERT_OWNED
);
4436 if ((vp
->v_iocount
== 0) && (vp
->v_lflag
& (VL_TERMINATE
| VL_DEAD
))) {
4447 * vnode_getwithvid() cuts in line in front of a vnode drain (that is,
4448 * while the vnode is draining, but at no point after that) to prevent
4449 * deadlocks when getting vnodes from filesystem hashes while holding
4450 * resources that may prevent other iocounts from being released.
4453 vnode_getwithvid(vnode_t vp
, uint32_t vid
)
4455 return(vget_internal(vp
, vid
, ( VNODE_NODEAD
| VNODE_WITHID
| VNODE_DRAINO
)));
4459 * vnode_getwithvid_drainok() is like vnode_getwithvid(), but *does* block behind a vnode
4460 * drain; it exists for use in the VFS name cache, where we really do want to block behind
4461 * vnode drain to prevent holding off an unmount.
4464 vnode_getwithvid_drainok(vnode_t vp
, uint32_t vid
)
4466 return(vget_internal(vp
, vid
, ( VNODE_NODEAD
| VNODE_WITHID
)));
4470 vnode_getwithref(vnode_t vp
)
4472 return(vget_internal(vp
, 0, 0));
4476 __private_extern__
int
4477 vnode_getalways(vnode_t vp
)
4479 return(vget_internal(vp
, 0, VNODE_ALWAYS
));
4483 vnode_put(vnode_t vp
)
4487 vnode_lock_spin(vp
);
4488 retval
= vnode_put_locked(vp
);
4495 vn_set_dead(vnode_t vp
)
4498 vp
->v_op
= dead_vnodeop_p
;
4502 vp
->v_lflag
|= VL_DEAD
;
4506 vnode_put_locked(vnode_t vp
)
4508 vfs_context_t ctx
= vfs_context_current(); /* hoist outside loop */
4511 lck_mtx_assert(&vp
->v_lock
, LCK_MTX_ASSERT_OWNED
);
4514 if (vp
->v_iocount
< 1)
4515 panic("vnode_put(%p): iocount < 1", vp
);
4517 if ((vp
->v_usecount
> 0) || (vp
->v_iocount
> 1)) {
4518 vnode_dropiocount(vp
);
4521 if ((vp
->v_lflag
& (VL_DEAD
| VL_NEEDINACTIVE
)) == VL_NEEDINACTIVE
) {
4523 vp
->v_lflag
&= ~VL_NEEDINACTIVE
;
4526 VNOP_INACTIVE(vp
, ctx
);
4528 vnode_lock_spin(vp
);
4530 * because we had to drop the vnode lock before calling
4531 * VNOP_INACTIVE, the state of this vnode may have changed...
4532 * we may pick up both VL_MARTERM and either
4533 * an iocount or a usecount while in the VNOP_INACTIVE call
4534 * we don't want to call vnode_reclaim_internal on a vnode
4535 * that has active references on it... so loop back around
4536 * and reevaluate the state
4540 vp
->v_lflag
&= ~VL_NEEDINACTIVE
;
4542 if ((vp
->v_lflag
& (VL_MARKTERM
| VL_TERMINATE
| VL_DEAD
)) == VL_MARKTERM
) {
4543 vnode_lock_convert(vp
);
4544 vnode_reclaim_internal(vp
, 1, 1, 0);
4546 vnode_dropiocount(vp
);
4552 /* is vnode_t in use by others? */
4554 vnode_isinuse(vnode_t vp
, int refcnt
)
4556 return(vnode_isinuse_locked(vp
, refcnt
, 0));
4559 int vnode_usecount(vnode_t vp
)
4561 return vp
->v_usecount
;
4564 int vnode_iocount(vnode_t vp
)
4566 return vp
->v_iocount
;
4570 vnode_isinuse_locked(vnode_t vp
, int refcnt
, int locked
)
4575 vnode_lock_spin(vp
);
4576 if ((vp
->v_type
!= VREG
) && ((vp
->v_usecount
- vp
->v_kusecount
) > refcnt
)) {
4580 if (vp
->v_type
== VREG
) {
4581 retval
= ubc_isinuse_locked(vp
, refcnt
, 1);
4591 /* resume vnode_t */
4593 vnode_resume(vnode_t vp
)
4595 if ((vp
->v_lflag
& VL_SUSPENDED
) && vp
->v_owner
== current_thread()) {
4597 vnode_lock_spin(vp
);
4598 vp
->v_lflag
&= ~VL_SUSPENDED
;
4602 wakeup(&vp
->v_iocount
);
4608 * Please do not use on more than one vnode at a time as it may
4610 * xxx should we explicity prevent this from happening?
4614 vnode_suspend(vnode_t vp
)
4616 if (vp
->v_lflag
& VL_SUSPENDED
) {
4620 vnode_lock_spin(vp
);
4623 * xxx is this sufficient to check if a vnode_drain is
4627 if (vp
->v_owner
== NULL
) {
4628 vp
->v_lflag
|= VL_SUSPENDED
;
4629 vp
->v_owner
= current_thread();
4637 * Release any blocked locking requests on the vnode.
4638 * Used for forced-unmounts.
4640 * XXX What about network filesystems?
4643 vnode_abort_advlocks(vnode_t vp
)
4645 if (vp
->v_flag
& VLOCKLOCAL
)
4646 lf_abort_advlocks(vp
);
4651 vnode_drain(vnode_t vp
)
4654 if (vp
->v_lflag
& VL_DRAIN
) {
4655 panic("vnode_drain: recursive drain");
4658 vp
->v_lflag
|= VL_DRAIN
;
4659 vp
->v_owner
= current_thread();
4661 while (vp
->v_iocount
> 1)
4662 msleep(&vp
->v_iocount
, &vp
->v_lock
, PVFS
, "vnode_drain", NULL
);
4664 vp
->v_lflag
&= ~VL_DRAIN
;
4671 * if the number of recent references via vnode_getwithvid or vnode_getwithref
4672 * exceeds this threshold, than 'UN-AGE' the vnode by removing it from
4673 * the LRU list if it's currently on it... once the iocount and usecount both drop
4674 * to 0, it will get put back on the end of the list, effectively making it younger
4675 * this allows us to keep actively referenced vnodes in the list without having
4676 * to constantly remove and add to the list each time a vnode w/o a usecount is
4677 * referenced which costs us taking and dropping a global lock twice.
4678 * However, if the vnode is marked DIRTY, we want to pull it out much earlier
4680 #define UNAGE_THRESHHOLD 25
4681 #define UNAGE_DIRTYTHRESHHOLD 6
4684 vnode_getiocount(vnode_t vp
, unsigned int vid
, int vflags
)
4686 int nodead
= vflags
& VNODE_NODEAD
;
4687 int nosusp
= vflags
& VNODE_NOSUSPEND
;
4688 int always
= vflags
& VNODE_ALWAYS
;
4689 int beatdrain
= vflags
& VNODE_DRAINO
;
4690 int withvid
= vflags
& VNODE_WITHID
;
4696 * if it is a dead vnode with deadfs
4698 if (nodead
&& (vp
->v_lflag
& VL_DEAD
) && ((vp
->v_type
== VBAD
) || (vp
->v_data
== 0))) {
4702 * will return VL_DEAD ones
4704 if ((vp
->v_lflag
& (VL_SUSPENDED
| VL_DRAIN
| VL_TERMINATE
)) == 0 ) {
4708 * if suspended vnodes are to be failed
4710 if (nosusp
&& (vp
->v_lflag
& VL_SUSPENDED
)) {
4714 * if you are the owner of drain/suspend/termination , can acquire iocount
4715 * check for VL_TERMINATE; it does not set owner
4717 if ((vp
->v_lflag
& (VL_DRAIN
| VL_SUSPENDED
| VL_TERMINATE
)) &&
4718 (vp
->v_owner
== current_thread())) {
4726 * If this vnode is getting drained, there are some cases where
4727 * we can't block or, in case of tty vnodes, want to be
4730 if (vp
->v_lflag
& VL_DRAIN
) {
4732 * In some situations, we want to get an iocount
4733 * even if the vnode is draining to prevent deadlock,
4734 * e.g. if we're in the filesystem, potentially holding
4735 * resources that could prevent other iocounts from
4741 * Don't block if the vnode's mount point is unmounting as
4742 * we may be the thread the unmount is itself waiting on
4743 * Only callers who pass in vids (at this point, we've already
4744 * handled nosusp and nodead) are expecting error returns
4745 * from this function, so only we can only return errors for
4746 * those. ENODEV is intended to inform callers that the call
4747 * failed because an unmount is in progress.
4749 if (withvid
&& (vp
->v_mount
) && vfs_isunmount(vp
->v_mount
))
4752 if (vnode_istty(vp
)) {
4757 vnode_lock_convert(vp
);
4759 if (vp
->v_lflag
& VL_TERMINATE
) {
4762 vp
->v_lflag
|= VL_TERMWANT
;
4764 error
= msleep(&vp
->v_lflag
, &vp
->v_lock
,
4765 (PVFS
| sleepflg
), "vnode getiocount", NULL
);
4769 msleep(&vp
->v_iocount
, &vp
->v_lock
, PVFS
, "vnode_getiocount", NULL
);
4771 if (withvid
&& vid
!= vp
->v_id
) {
4774 if (++vp
->v_references
>= UNAGE_THRESHHOLD
||
4775 (vp
->v_flag
& VISDIRTY
&& vp
->v_references
>= UNAGE_DIRTYTHRESHHOLD
)) {
4776 vp
->v_references
= 0;
4777 vnode_list_remove(vp
);
4787 vnode_dropiocount (vnode_t vp
)
4789 if (vp
->v_iocount
< 1)
4790 panic("vnode_dropiocount(%p): v_iocount < 1", vp
);
4796 if ((vp
->v_lflag
& (VL_DRAIN
| VL_SUSPENDED
)) && (vp
->v_iocount
<= 1))
4797 wakeup(&vp
->v_iocount
);
4802 vnode_reclaim(struct vnode
* vp
)
4804 vnode_reclaim_internal(vp
, 0, 0, 0);
4809 vnode_reclaim_internal(struct vnode
* vp
, int locked
, int reuse
, int flags
)
4816 if (vp
->v_lflag
& VL_TERMINATE
) {
4817 panic("vnode reclaim in progress");
4819 vp
->v_lflag
|= VL_TERMINATE
;
4821 vn_clearunionwait(vp
, 1);
4825 isfifo
= (vp
->v_type
== VFIFO
);
4827 if (vp
->v_type
!= VBAD
)
4828 vgone(vp
, flags
); /* clean and reclaim the vnode */
4831 * give the vnode a new identity so that vnode_getwithvid will fail
4832 * on any stale cache accesses...
4833 * grab the list_lock so that if we're in "new_vnode"
4834 * behind the list_lock trying to steal this vnode, the v_id is stable...
4835 * once new_vnode drops the list_lock, it will block trying to take
4836 * the vnode lock until we release it... at that point it will evaluate
4837 * whether the v_vid has changed
4838 * also need to make sure that the vnode isn't on a list where "new_vnode"
4839 * can find it after the v_id has been bumped until we are completely done
4840 * with the vnode (i.e. putting it back on a list has to be the very last
4841 * thing we do to this vnode... many of the callers of vnode_reclaim_internal
4842 * are holding an io_count on the vnode... they need to drop the io_count
4843 * BEFORE doing a vnode_list_add or make sure to hold the vnode lock until
4844 * they are completely done with the vnode
4848 vnode_list_remove_locked(vp
);
4851 vnode_list_unlock();
4854 struct fifoinfo
* fip
;
4856 fip
= vp
->v_fifoinfo
;
4857 vp
->v_fifoinfo
= NULL
;
4863 panic("vnode_reclaim_internal: cleaned vnode isn't");
4864 if (vp
->v_numoutput
)
4865 panic("vnode_reclaim_internal: clean vnode has pending I/O's");
4866 if (UBCINFOEXISTS(vp
))
4867 panic("vnode_reclaim_internal: ubcinfo not cleaned");
4869 panic("vnode_reclaim_internal: vparent not removed");
4871 panic("vnode_reclaim_internal: vname not removed");
4873 vp
->v_socket
= NULL
;
4875 vp
->v_lflag
&= ~VL_TERMINATE
;
4878 KNOTE(&vp
->v_knotes
, NOTE_REVOKE
);
4880 /* Make sure that when we reuse the vnode, no knotes left over */
4881 klist_init(&vp
->v_knotes
);
4883 if (vp
->v_lflag
& VL_TERMWANT
) {
4884 vp
->v_lflag
&= ~VL_TERMWANT
;
4885 wakeup(&vp
->v_lflag
);
4889 * make sure we get on the
4890 * dead list if appropriate
4899 vnode_create_internal(uint32_t flavor
, uint32_t size
, void *data
, vnode_t
*vpp
,
4909 struct componentname
*cnp
;
4910 struct vnode_fsparam
*param
= (struct vnode_fsparam
*)data
;
4912 struct vnode_trigger_param
*tinfo
= NULL
;
4923 /* Do quick sanity check on the parameters. */
4924 if ((param
== NULL
) || (param
->vnfs_vtype
== VBAD
)) {
4930 if ((flavor
== VNCREATE_TRIGGER
) && (size
== VNCREATE_TRIGGER_SIZE
)) {
4931 tinfo
= (struct vnode_trigger_param
*)data
;
4933 /* Validate trigger vnode input */
4934 if ((param
->vnfs_vtype
!= VDIR
) ||
4935 (tinfo
->vnt_resolve_func
== NULL
) ||
4936 (tinfo
->vnt_flags
& ~VNT_VALID_MASK
)) {
4940 /* Fall through a normal create (params will be the same) */
4941 flavor
= VNCREATE_FLAVOR
;
4945 if ((flavor
!= VNCREATE_FLAVOR
) || (size
!= VCREATESIZE
)) {
4951 if (!existing_vnode
) {
4952 if ((error
= new_vnode(&vp
)) ) {
4956 /* Make it so that it can be released by a vnode_put) */
4963 * A vnode obtained by vnode_create_empty has been passed to
4964 * vnode_initialize - Unset VL_DEAD set by vn_set_dead. After
4965 * this point, it is set back on any error.
4967 * N.B. vnode locking - We make the same assumptions as the
4968 * "unsplit" vnode_create did - i.e. it is safe to update the
4969 * vnode's fields without the vnode lock. This vnode has been
4970 * out and about with the filesystem and hopefully nothing
4971 * was done to the vnode between the vnode_create_empty and
4972 * now when it has come in through vnode_initialize.
4974 vp
->v_lflag
&= ~VL_DEAD
;
4977 dvp
= param
->vnfs_dvp
;
4978 cnp
= param
->vnfs_cnp
;
4980 vp
->v_op
= param
->vnfs_vops
;
4981 vp
->v_type
= param
->vnfs_vtype
;
4982 vp
->v_data
= param
->vnfs_fsnode
;
4984 if (param
->vnfs_markroot
)
4985 vp
->v_flag
|= VROOT
;
4986 if (param
->vnfs_marksystem
)
4987 vp
->v_flag
|= VSYSTEM
;
4988 if (vp
->v_type
== VREG
) {
4989 error
= ubc_info_init_withsize(vp
, param
->vnfs_filesize
);
4999 if (param
->vnfs_mp
->mnt_ioflags
& MNT_IOFLAGS_IOSCHED_SUPPORTED
)
5000 memory_object_mark_io_tracking(vp
->v_ubcinfo
->ui_control
);
5008 * For trigger vnodes, attach trigger info to vnode
5010 if ((vp
->v_type
== VDIR
) && (tinfo
!= NULL
)) {
5012 * Note: has a side effect of incrementing trigger count on the
5013 * mount if successful, which we would need to undo on a
5014 * subsequent failure.
5019 error
= vnode_resolver_create(param
->vnfs_mp
, vp
, tinfo
, FALSE
);
5021 printf("vnode_create: vnode_resolver_create() err %d\n", error
);
5031 if (vp
->v_type
== VCHR
|| vp
->v_type
== VBLK
) {
5033 vp
->v_tag
= VT_DEVFS
; /* callers will reset if needed (bdevvp) */
5035 if ( (nvp
= checkalias(vp
, param
->vnfs_rdev
)) ) {
5037 * if checkalias returns a vnode, it will be locked
5039 * first get rid of the unneeded vnode we acquired
5042 vp
->v_op
= spec_vnodeop_p
;
5044 vp
->v_lflag
= VL_DEAD
;
5050 * switch to aliased vnode and finish
5056 vp
->v_op
= param
->vnfs_vops
;
5057 vp
->v_type
= param
->vnfs_vtype
;
5058 vp
->v_data
= param
->vnfs_fsnode
;
5061 insmntque(vp
, param
->vnfs_mp
);
5066 if (VCHR
== vp
->v_type
) {
5067 u_int maj
= major(vp
->v_rdev
);
5069 if (maj
< (u_int
)nchrdev
&& cdevsw
[maj
].d_type
== D_TTY
)
5070 vp
->v_flag
|= VISTTY
;
5074 if (vp
->v_type
== VFIFO
) {
5075 struct fifoinfo
*fip
;
5077 MALLOC(fip
, struct fifoinfo
*,
5078 sizeof(*fip
), M_TEMP
, M_WAITOK
);
5079 bzero(fip
, sizeof(struct fifoinfo
));
5080 vp
->v_fifoinfo
= fip
;
5082 /* The file systems must pass the address of the location where
5083 * they store the vnode pointer. When we add the vnode into the mount
5084 * list and name cache they become discoverable. So the file system node
5085 * must have the connection to vnode setup by then
5089 /* Add fs named reference. */
5090 if (param
->vnfs_flags
& VNFS_ADDFSREF
) {
5091 vp
->v_lflag
|= VNAMED_FSHASH
;
5093 if (param
->vnfs_mp
) {
5094 if (param
->vnfs_mp
->mnt_kern_flag
& MNTK_LOCK_LOCAL
)
5095 vp
->v_flag
|= VLOCKLOCAL
;
5097 if ((vp
->v_freelist
.tqe_prev
!= (struct vnode
**)0xdeadb))
5098 panic("insmntque: vp on the free list\n");
5101 * enter in mount vnode list
5103 insmntque(vp
, param
->vnfs_mp
);
5106 if (dvp
&& vnode_ref(dvp
) == 0) {
5110 if (dvp
&& ((param
->vnfs_flags
& (VNFS_NOCACHE
| VNFS_CANTCACHE
)) == 0)) {
5112 * enter into name cache
5113 * we've got the info to enter it into the name cache now
5114 * cache_enter_create will pick up an extra reference on
5115 * the name entered into the string cache
5117 vp
->v_name
= cache_enter_create(dvp
, vp
, cnp
);
5119 vp
->v_name
= vfs_addname(cnp
->cn_nameptr
, cnp
->cn_namelen
, cnp
->cn_hash
, 0);
5121 if ((cnp
->cn_flags
& UNIONCREATED
) == UNIONCREATED
)
5122 vp
->v_flag
|= VISUNION
;
5124 if ((param
->vnfs_flags
& VNFS_CANTCACHE
) == 0) {
5126 * this vnode is being created as cacheable in the name cache
5127 * this allows us to re-enter it in the cache
5129 vp
->v_flag
|= VNCACHEABLE
;
5131 ut
= get_bsdthread_info(current_thread());
5133 if ((current_proc()->p_lflag
& P_LRAGE_VNODES
) ||
5134 (ut
->uu_flag
& (UT_RAGE_VNODES
| UT_KERN_RAGE_VNODES
))) {
5136 * process has indicated that it wants any
5137 * vnodes created on its behalf to be rapidly
5138 * aged to reduce the impact on the cached set
5141 * if UT_KERN_RAGE_VNODES is set, then the
5142 * kernel internally wants vnodes to be rapidly
5143 * aged, even if the process hasn't requested
5146 vp
->v_flag
|= VRAGE
;
5149 #if CONFIG_SECLUDED_MEMORY
5150 switch (secluded_for_filecache
) {
5153 * secluded_for_filecache == 0:
5154 * + no file contents in secluded pool
5159 * secluded_for_filecache == 1:
5161 * + files from /Applications/ are OK
5162 * + files from /Applications/Camera are not OK
5163 * + no files that are open for write
5165 if (vnode_vtype(vp
) == VREG
&&
5166 vnode_mount(vp
) != NULL
&&
5167 (! (vfs_flags(vnode_mount(vp
)) & MNT_ROOTFS
))) {
5168 /* not from root filesystem: eligible for secluded pages */
5169 memory_object_mark_eligible_for_secluded(
5170 ubc_getobject(vp
, UBC_FLAGS_NONE
),
5176 * secluded_for_filecache == 2:
5177 * + all read-only files OK, except:
5178 * + dyld_shared_cache_arm64*
5182 if (vnode_vtype(vp
) == VREG
) {
5183 memory_object_mark_eligible_for_secluded(
5184 ubc_getobject(vp
, UBC_FLAGS_NONE
),
5191 #endif /* CONFIG_SECLUDED_MEMORY */
5196 if (existing_vnode
) {
5203 * The following api creates a vnode and associates all the parameter specified in vnode_fsparam
5204 * structure and returns a vnode handle with a reference. device aliasing is handled here so checkalias
5205 * is obsoleted by this.
5208 vnode_create(uint32_t flavor
, uint32_t size
, void *data
, vnode_t
*vpp
)
5211 return (vnode_create_internal(flavor
, size
, data
, vpp
, 1));
5215 vnode_create_empty(vnode_t
*vpp
)
5218 return (vnode_create_internal(VNCREATE_FLAVOR
, VCREATESIZE
, NULL
,
5223 vnode_initialize(uint32_t flavor
, uint32_t size
, void *data
, vnode_t
*vpp
)
5225 if (*vpp
== NULLVP
) {
5226 panic("NULL vnode passed to vnode_initialize");
5228 #if DEVELOPMENT || DEBUG
5230 * We lock to check that vnode is fit for unlocked use in
5231 * vnode_create_internal.
5233 vnode_lock_spin(*vpp
);
5234 VNASSERT(((*vpp
)->v_iocount
== 1), *vpp
,
5235 ("vnode_initialize : iocount not 1, is %d", (*vpp
)->v_iocount
));
5236 VNASSERT(((*vpp
)->v_usecount
== 0), *vpp
,
5237 ("vnode_initialize : usecount not 0, is %d", (*vpp
)->v_usecount
));
5238 VNASSERT(((*vpp
)->v_lflag
& VL_DEAD
), *vpp
,
5239 ("vnode_initialize : v_lflag does not have VL_DEAD, is 0x%x",
5241 VNASSERT(((*vpp
)->v_data
== NULL
), *vpp
,
5242 ("vnode_initialize : v_data not NULL"));
5245 return (vnode_create_internal(flavor
, size
, data
, vpp
, 1));
5249 vnode_addfsref(vnode_t vp
)
5251 vnode_lock_spin(vp
);
5252 if (vp
->v_lflag
& VNAMED_FSHASH
)
5253 panic("add_fsref: vp already has named reference");
5254 if ((vp
->v_freelist
.tqe_prev
!= (struct vnode
**)0xdeadb))
5255 panic("addfsref: vp on the free list\n");
5256 vp
->v_lflag
|= VNAMED_FSHASH
;
5262 vnode_removefsref(vnode_t vp
)
5264 vnode_lock_spin(vp
);
5265 if ((vp
->v_lflag
& VNAMED_FSHASH
) == 0)
5266 panic("remove_fsref: no named reference");
5267 vp
->v_lflag
&= ~VNAMED_FSHASH
;
5275 vfs_iterate(int flags
, int (*callout
)(mount_t
, void *), void *arg
)
5280 int count
, actualcount
, i
;
5282 int indx_start
, indx_stop
, indx_incr
;
5283 int cb_dropref
= (flags
& VFS_ITERATE_CB_DROPREF
);
5285 count
= mount_getvfscnt();
5288 fsid_list
= (fsid_t
*)kalloc(count
* sizeof(fsid_t
));
5289 allocmem
= (void *)fsid_list
;
5291 actualcount
= mount_fillfsids(fsid_list
, count
);
5294 * Establish the iteration direction
5295 * VFS_ITERATE_TAIL_FIRST overrides default head first order (oldest first)
5297 if (flags
& VFS_ITERATE_TAIL_FIRST
) {
5298 indx_start
= actualcount
- 1;
5301 } else /* Head first by default */ {
5303 indx_stop
= actualcount
;
5307 for (i
=indx_start
; i
!= indx_stop
; i
+= indx_incr
) {
5309 /* obtain the mount point with iteration reference */
5310 mp
= mount_list_lookupby_fsid(&fsid_list
[i
], 0, 1);
5312 if(mp
== (struct mount
*)0)
5315 if (mp
->mnt_lflag
& (MNT_LDEAD
| MNT_LUNMOUNT
)) {
5323 /* iterate over all the vnodes */
5324 ret
= callout(mp
, arg
);
5327 * Drop the iterref here if the callback didn't do it.
5328 * Note: If cb_dropref is set the mp may no longer exist.
5335 case VFS_RETURNED_DONE
:
5336 if (ret
== VFS_RETURNED_DONE
) {
5342 case VFS_CLAIMED_DONE
:
5353 kfree(allocmem
, (count
* sizeof(fsid_t
)));
5358 * Update the vfsstatfs structure in the mountpoint.
5359 * MAC: Parameter eventtype added, indicating whether the event that
5360 * triggered this update came from user space, via a system call
5361 * (VFS_USER_EVENT) or an internal kernel call (VFS_KERNEL_EVENT).
5364 vfs_update_vfsstat(mount_t mp
, vfs_context_t ctx
, __unused
int eventtype
)
5370 * Request the attributes we want to propagate into
5371 * the per-mount vfsstat structure.
5374 VFSATTR_WANTED(&va
, f_iosize
);
5375 VFSATTR_WANTED(&va
, f_blocks
);
5376 VFSATTR_WANTED(&va
, f_bfree
);
5377 VFSATTR_WANTED(&va
, f_bavail
);
5378 VFSATTR_WANTED(&va
, f_bused
);
5379 VFSATTR_WANTED(&va
, f_files
);
5380 VFSATTR_WANTED(&va
, f_ffree
);
5381 VFSATTR_WANTED(&va
, f_bsize
);
5382 VFSATTR_WANTED(&va
, f_fssubtype
);
5384 if ((error
= vfs_getattr(mp
, &va
, ctx
)) != 0) {
5385 KAUTH_DEBUG("STAT - filesystem returned error %d", error
);
5389 if (eventtype
== VFS_USER_EVENT
) {
5390 error
= mac_mount_check_getattr(ctx
, mp
, &va
);
5396 * Unpack into the per-mount structure.
5398 * We only overwrite these fields, which are likely to change:
5406 * And these which are not, but which the FS has no other way
5407 * of providing to us:
5413 if (VFSATTR_IS_SUPPORTED(&va
, f_bsize
)) {
5414 /* 4822056 - protect against malformed server mount */
5415 mp
->mnt_vfsstat
.f_bsize
= (va
.f_bsize
> 0 ? va
.f_bsize
: 512);
5417 mp
->mnt_vfsstat
.f_bsize
= mp
->mnt_devblocksize
; /* default from the device block size */
5419 if (VFSATTR_IS_SUPPORTED(&va
, f_iosize
)) {
5420 mp
->mnt_vfsstat
.f_iosize
= va
.f_iosize
;
5422 mp
->mnt_vfsstat
.f_iosize
= 1024 * 1024; /* 1MB sensible I/O size */
5424 if (VFSATTR_IS_SUPPORTED(&va
, f_blocks
))
5425 mp
->mnt_vfsstat
.f_blocks
= va
.f_blocks
;
5426 if (VFSATTR_IS_SUPPORTED(&va
, f_bfree
))
5427 mp
->mnt_vfsstat
.f_bfree
= va
.f_bfree
;
5428 if (VFSATTR_IS_SUPPORTED(&va
, f_bavail
))
5429 mp
->mnt_vfsstat
.f_bavail
= va
.f_bavail
;
5430 if (VFSATTR_IS_SUPPORTED(&va
, f_bused
))
5431 mp
->mnt_vfsstat
.f_bused
= va
.f_bused
;
5432 if (VFSATTR_IS_SUPPORTED(&va
, f_files
))
5433 mp
->mnt_vfsstat
.f_files
= va
.f_files
;
5434 if (VFSATTR_IS_SUPPORTED(&va
, f_ffree
))
5435 mp
->mnt_vfsstat
.f_ffree
= va
.f_ffree
;
5437 /* this is unlikely to change, but has to be queried for */
5438 if (VFSATTR_IS_SUPPORTED(&va
, f_fssubtype
))
5439 mp
->mnt_vfsstat
.f_fssubtype
= va
.f_fssubtype
;
5445 mount_list_add(mount_t mp
)
5450 if (system_inshutdown
!= 0) {
5453 TAILQ_INSERT_TAIL(&mountlist
, mp
, mnt_list
);
5457 mount_list_unlock();
5463 mount_list_remove(mount_t mp
)
5466 TAILQ_REMOVE(&mountlist
, mp
, mnt_list
);
5468 mp
->mnt_list
.tqe_next
= NULL
;
5469 mp
->mnt_list
.tqe_prev
= NULL
;
5470 mount_list_unlock();
5474 mount_lookupby_volfsid(int volfs_id
, int withref
)
5476 mount_t cur_mount
= (mount_t
)0;
5480 TAILQ_FOREACH(mp
, &mountlist
, mnt_list
) {
5481 if (!(mp
->mnt_kern_flag
& MNTK_UNMOUNT
) &&
5482 (mp
->mnt_kern_flag
& MNTK_PATH_FROM_ID
) &&
5483 (mp
->mnt_vfsstat
.f_fsid
.val
[0] == volfs_id
)) {
5486 if (mount_iterref(cur_mount
, 1)) {
5487 cur_mount
= (mount_t
)0;
5488 mount_list_unlock();
5495 mount_list_unlock();
5496 if (withref
&& (cur_mount
!= (mount_t
)0)) {
5498 if (vfs_busy(mp
, LK_NOWAIT
) != 0) {
5499 cur_mount
= (mount_t
)0;
5508 mount_list_lookupby_fsid(fsid_t
*fsid
, int locked
, int withref
)
5510 mount_t retmp
= (mount_t
)0;
5515 TAILQ_FOREACH(mp
, &mountlist
, mnt_list
)
5516 if (mp
->mnt_vfsstat
.f_fsid
.val
[0] == fsid
->val
[0] &&
5517 mp
->mnt_vfsstat
.f_fsid
.val
[1] == fsid
->val
[1]) {
5520 if (mount_iterref(retmp
, 1))
5527 mount_list_unlock();
5532 vnode_lookup(const char *path
, int flags
, vnode_t
*vpp
, vfs_context_t ctx
)
5534 struct nameidata nd
;
5536 u_int32_t ndflags
= 0;
5542 if (flags
& VNODE_LOOKUP_NOFOLLOW
)
5547 if (flags
& VNODE_LOOKUP_NOCROSSMOUNT
)
5548 ndflags
|= NOCROSSMOUNT
;
5550 if (flags
& VNODE_LOOKUP_CROSSMOUNTNOWAIT
)
5551 ndflags
|= CN_NBMOUNTLOOK
;
5553 /* XXX AUDITVNPATH1 needed ? */
5554 NDINIT(&nd
, LOOKUP
, OP_LOOKUP
, ndflags
, UIO_SYSSPACE
,
5555 CAST_USER_ADDR_T(path
), ctx
);
5557 if ((error
= namei(&nd
)))
5566 vnode_open(const char *path
, int fmode
, int cmode
, int flags
, vnode_t
*vpp
, vfs_context_t ctx
)
5568 struct nameidata nd
;
5570 u_int32_t ndflags
= 0;
5573 if (ctx
== NULL
) { /* XXX technically an error */
5574 ctx
= vfs_context_current();
5577 if (fmode
& O_NOFOLLOW
)
5578 lflags
|= VNODE_LOOKUP_NOFOLLOW
;
5580 if (lflags
& VNODE_LOOKUP_NOFOLLOW
)
5585 if (lflags
& VNODE_LOOKUP_NOCROSSMOUNT
)
5586 ndflags
|= NOCROSSMOUNT
;
5588 if (lflags
& VNODE_LOOKUP_CROSSMOUNTNOWAIT
)
5589 ndflags
|= CN_NBMOUNTLOOK
;
5591 /* XXX AUDITVNPATH1 needed ? */
5592 NDINIT(&nd
, LOOKUP
, OP_OPEN
, ndflags
, UIO_SYSSPACE
,
5593 CAST_USER_ADDR_T(path
), ctx
);
5595 if ((error
= vn_open(&nd
, fmode
, cmode
)))
5604 vnode_close(vnode_t vp
, int flags
, vfs_context_t ctx
)
5609 ctx
= vfs_context_current();
5612 error
= vn_close(vp
, flags
, ctx
);
5618 vnode_mtime(vnode_t vp
, struct timespec
*mtime
, vfs_context_t ctx
)
5620 struct vnode_attr va
;
5624 VATTR_WANTED(&va
, va_modify_time
);
5625 error
= vnode_getattr(vp
, &va
, ctx
);
5627 *mtime
= va
.va_modify_time
;
5632 vnode_flags(vnode_t vp
, uint32_t *flags
, vfs_context_t ctx
)
5634 struct vnode_attr va
;
5638 VATTR_WANTED(&va
, va_flags
);
5639 error
= vnode_getattr(vp
, &va
, ctx
);
5641 *flags
= va
.va_flags
;
5646 * Returns: 0 Success
5650 vnode_size(vnode_t vp
, off_t
*sizep
, vfs_context_t ctx
)
5652 struct vnode_attr va
;
5656 VATTR_WANTED(&va
, va_data_size
);
5657 error
= vnode_getattr(vp
, &va
, ctx
);
5659 *sizep
= va
.va_data_size
;
5664 vnode_setsize(vnode_t vp
, off_t size
, int ioflag
, vfs_context_t ctx
)
5666 struct vnode_attr va
;
5669 VATTR_SET(&va
, va_data_size
, size
);
5670 va
.va_vaflags
= ioflag
& 0xffff;
5671 return(vnode_setattr(vp
, &va
, ctx
));
5675 vnode_setdirty(vnode_t vp
)
5677 vnode_lock_spin(vp
);
5678 vp
->v_flag
|= VISDIRTY
;
5684 vnode_cleardirty(vnode_t vp
)
5686 vnode_lock_spin(vp
);
5687 vp
->v_flag
&= ~VISDIRTY
;
5693 vnode_isdirty(vnode_t vp
)
5697 vnode_lock_spin(vp
);
5698 dirty
= (vp
->v_flag
& VISDIRTY
) ? 1 : 0;
5705 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
)
5707 /* Only use compound VNOP for compound operation */
5708 if (vnode_compound_open_available(dvp
) && ((flags
& VN_CREATE_DOOPEN
) != 0)) {
5710 return VNOP_COMPOUND_OPEN(dvp
, vpp
, ndp
, O_CREAT
, fmode
, statusp
, vap
, ctx
);
5712 return VNOP_CREATE(dvp
, vpp
, &ndp
->ni_cnd
, vap
, ctx
);
5717 * Create a filesystem object of arbitrary type with arbitrary attributes in
5718 * the spevied directory with the specified name.
5720 * Parameters: dvp Pointer to the vnode of the directory
5721 * in which to create the object.
5722 * vpp Pointer to the area into which to
5723 * return the vnode of the created object.
5724 * cnp Component name pointer from the namei
5725 * data structure, containing the name to
5726 * use for the create object.
5727 * vap Pointer to the vnode_attr structure
5728 * describing the object to be created,
5729 * including the type of object.
5730 * flags VN_* flags controlling ACL inheritance
5731 * and whether or not authorization is to
5732 * be required for the operation.
5734 * Returns: 0 Success
5737 * Implicit: *vpp Contains the vnode of the object that
5738 * was created, if successful.
5739 * *cnp May be modified by the underlying VFS.
5740 * *vap May be modified by the underlying VFS.
5741 * modified by either ACL inheritance or
5744 * be modified, even if the operation is
5747 * Notes: The kauth_filesec_t in 'vap', if any, is in host byte order.
5749 * Modification of '*cnp' and '*vap' by the underlying VFS is
5750 * strongly discouraged.
5752 * XXX: This function is a 'vn_*' function; it belongs in vfs_vnops.c
5754 * XXX: We should enummerate the possible errno values here, and where
5755 * in the code they originated.
5758 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
)
5760 errno_t error
, old_error
;
5761 vnode_t vp
= (vnode_t
)0;
5763 struct componentname
*cnp
;
5768 batched
= namei_compound_available(dvp
, ndp
) ? TRUE
: FALSE
;
5770 KAUTH_DEBUG("%p CREATE - '%s'", dvp
, cnp
->cn_nameptr
);
5772 if (flags
& VN_CREATE_NOINHERIT
)
5773 vap
->va_vaflags
|= VA_NOINHERIT
;
5774 if (flags
& VN_CREATE_NOAUTH
)
5775 vap
->va_vaflags
|= VA_NOAUTH
;
5777 * Handle ACL inheritance, initialize vap.
5779 error
= vn_attribute_prepare(dvp
, vap
, &defaulted
, ctx
);
5784 if (vap
->va_type
!= VREG
&& (fmode
!= 0 || (flags
& VN_CREATE_DOOPEN
) || statusp
)) {
5785 panic("Open parameters, but not a regular file.");
5787 if ((fmode
!= 0) && ((flags
& VN_CREATE_DOOPEN
) == 0)) {
5788 panic("Mode for open, but not trying to open...");
5793 * Create the requested node.
5795 switch(vap
->va_type
) {
5797 error
= vn_create_reg(dvp
, vpp
, ndp
, vap
, flags
, fmode
, statusp
, ctx
);
5800 error
= vn_mkdir(dvp
, vpp
, ndp
, vap
, ctx
);
5806 error
= VNOP_MKNOD(dvp
, vpp
, cnp
, vap
, ctx
);
5809 panic("vnode_create: unknown vtype %d", vap
->va_type
);
5812 KAUTH_DEBUG("%p CREATE - error %d returned by filesystem", dvp
, error
);
5820 if (!(flags
& VN_CREATE_NOLABEL
)) {
5821 error
= vnode_label(vnode_mount(vp
), dvp
, vp
, cnp
, VNODE_LABEL_CREATE
, ctx
);
5828 * If some of the requested attributes weren't handled by the VNOP,
5829 * use our fallback code.
5831 if (!VATTR_ALL_SUPPORTED(vap
) && *vpp
) {
5832 KAUTH_DEBUG(" CREATE - doing fallback with ACL %p", vap
->va_acl
);
5833 error
= vnode_setattr_fallback(*vpp
, vap
, ctx
);
5838 if ((error
!= 0) && (vp
!= (vnode_t
)0)) {
5840 /* If we've done a compound open, close */
5841 if (batched
&& (old_error
== 0) && (vap
->va_type
== VREG
)) {
5842 VNOP_CLOSE(vp
, fmode
, ctx
);
5845 /* Need to provide notifications if a create succeeded */
5854 * For creation VNOPs, this is the equivalent of
5855 * lookup_handle_found_vnode.
5857 if (kdebug_enable
&& *vpp
)
5858 kdebug_lookup(*vpp
, cnp
);
5861 vn_attribute_cleanup(vap
, defaulted
);
5866 static kauth_scope_t vnode_scope
;
5867 static int vnode_authorize_callback(kauth_cred_t credential
, void *idata
, kauth_action_t action
,
5868 uintptr_t arg0
, uintptr_t arg1
, uintptr_t arg2
, uintptr_t arg3
);
5869 static int vnode_authorize_callback_int(kauth_action_t action
, vfs_context_t ctx
,
5870 vnode_t vp
, vnode_t dvp
, int *errorp
);
5872 typedef struct _vnode_authorize_context
{
5874 struct vnode_attr
*vap
;
5876 struct vnode_attr
*dvap
;
5880 #define _VAC_IS_OWNER (1<<0)
5881 #define _VAC_IN_GROUP (1<<1)
5882 #define _VAC_IS_DIR_OWNER (1<<2)
5883 #define _VAC_IN_DIR_GROUP (1<<3)
5884 #define _VAC_NO_VNODE_POINTERS (1<<4)
5888 vnode_authorize_init(void)
5890 vnode_scope
= kauth_register_scope(KAUTH_SCOPE_VNODE
, vnode_authorize_callback
, NULL
);
5893 #define VATTR_PREPARE_DEFAULTED_UID 0x1
5894 #define VATTR_PREPARE_DEFAULTED_GID 0x2
5895 #define VATTR_PREPARE_DEFAULTED_MODE 0x4
5898 vn_attribute_prepare(vnode_t dvp
, struct vnode_attr
*vap
, uint32_t *defaulted_fieldsp
, vfs_context_t ctx
)
5900 kauth_acl_t nacl
= NULL
, oacl
= NULL
;
5904 * Handle ACL inheritance.
5906 if (!(vap
->va_vaflags
& VA_NOINHERIT
) && vfs_extendedsecurity(dvp
->v_mount
)) {
5907 /* save the original filesec */
5908 if (VATTR_IS_ACTIVE(vap
, va_acl
)) {
5913 if ((error
= kauth_acl_inherit(dvp
,
5916 vap
->va_type
== VDIR
,
5918 KAUTH_DEBUG("%p CREATE - error %d processing inheritance", dvp
, error
);
5923 * If the generated ACL is NULL, then we can save ourselves some effort
5924 * by clearing the active bit.
5927 VATTR_CLEAR_ACTIVE(vap
, va_acl
);
5929 vap
->va_base_acl
= oacl
;
5930 VATTR_SET(vap
, va_acl
, nacl
);
5934 error
= vnode_authattr_new_internal(dvp
, vap
, (vap
->va_vaflags
& VA_NOAUTH
), defaulted_fieldsp
, ctx
);
5936 vn_attribute_cleanup(vap
, *defaulted_fieldsp
);
5943 vn_attribute_cleanup(struct vnode_attr
*vap
, uint32_t defaulted_fields
)
5946 * If the caller supplied a filesec in vap, it has been replaced
5947 * now by the post-inheritance copy. We need to put the original back
5948 * and free the inherited product.
5950 kauth_acl_t nacl
, oacl
;
5952 if (VATTR_IS_ACTIVE(vap
, va_acl
)) {
5954 oacl
= vap
->va_base_acl
;
5957 VATTR_SET(vap
, va_acl
, oacl
);
5958 vap
->va_base_acl
= NULL
;
5960 VATTR_CLEAR_ACTIVE(vap
, va_acl
);
5964 kauth_acl_free(nacl
);
5968 if ((defaulted_fields
& VATTR_PREPARE_DEFAULTED_MODE
) != 0) {
5969 VATTR_CLEAR_ACTIVE(vap
, va_mode
);
5971 if ((defaulted_fields
& VATTR_PREPARE_DEFAULTED_GID
) != 0) {
5972 VATTR_CLEAR_ACTIVE(vap
, va_gid
);
5974 if ((defaulted_fields
& VATTR_PREPARE_DEFAULTED_UID
) != 0) {
5975 VATTR_CLEAR_ACTIVE(vap
, va_uid
);
5982 vn_authorize_unlink(vnode_t dvp
, vnode_t vp
, struct componentname
*cnp
, vfs_context_t ctx
, __unused
void *reserved
)
5990 * Normally, unlinking of directories is not supported.
5991 * However, some file systems may have limited support.
5993 if ((vp
->v_type
== VDIR
) &&
5994 !(vp
->v_mount
->mnt_kern_flag
& MNTK_DIR_HARDLINKS
)) {
5995 return (EPERM
); /* POSIX */
5998 /* authorize the delete operation */
6001 error
= mac_vnode_check_unlink(ctx
, dvp
, vp
, cnp
);
6004 error
= vnode_authorize(vp
, dvp
, KAUTH_VNODE_DELETE
, ctx
);
6010 vn_authorize_open_existing(vnode_t vp
, struct componentname
*cnp
, int fmode
, vfs_context_t ctx
, void *reserved
)
6012 /* Open of existing case */
6013 kauth_action_t action
;
6015 if (cnp
->cn_ndp
== NULL
) {
6018 if (reserved
!= NULL
) {
6019 panic("reserved not NULL.");
6023 /* XXX may do duplicate work here, but ignore that for now (idempotent) */
6024 if (vfs_flags(vnode_mount(vp
)) & MNT_MULTILABEL
) {
6025 error
= vnode_label(vnode_mount(vp
), NULL
, vp
, NULL
, 0, ctx
);
6031 if ( (fmode
& O_DIRECTORY
) && vp
->v_type
!= VDIR
) {
6035 if (vp
->v_type
== VSOCK
&& vp
->v_tag
!= VT_FDESC
) {
6036 return (EOPNOTSUPP
); /* Operation not supported on socket */
6039 if (vp
->v_type
== VLNK
&& (fmode
& O_NOFOLLOW
) != 0) {
6040 return (ELOOP
); /* O_NOFOLLOW was specified and the target is a symbolic link */
6043 /* disallow write operations on directories */
6044 if (vnode_isdir(vp
) && (fmode
& (FWRITE
| O_TRUNC
))) {
6048 if ((cnp
->cn_ndp
->ni_flag
& NAMEI_TRAILINGSLASH
)) {
6049 if (vp
->v_type
!= VDIR
) {
6055 /* If a file being opened is a shadow file containing
6056 * namedstream data, ignore the macf checks because it
6057 * is a kernel internal file and access should always
6060 if (!(vnode_isshadow(vp
) && vnode_isnamedstream(vp
))) {
6061 error
= mac_vnode_check_open(ctx
, vp
, fmode
);
6068 /* compute action to be authorized */
6070 if (fmode
& FREAD
) {
6071 action
|= KAUTH_VNODE_READ_DATA
;
6073 if (fmode
& (FWRITE
| O_TRUNC
)) {
6075 * If we are writing, appending, and not truncating,
6076 * indicate that we are appending so that if the
6077 * UF_APPEND or SF_APPEND bits are set, we do not deny
6080 if ((fmode
& O_APPEND
) && !(fmode
& O_TRUNC
)) {
6081 action
|= KAUTH_VNODE_APPEND_DATA
;
6083 action
|= KAUTH_VNODE_WRITE_DATA
;
6086 error
= vnode_authorize(vp
, NULL
, action
, ctx
);
6088 if (error
== EACCES
) {
6090 * Shadow files may exist on-disk with a different UID/GID
6091 * than that of the current context. Verify that this file
6092 * is really a shadow file. If it was created successfully
6093 * then it should be authorized.
6095 if (vnode_isshadow(vp
) && vnode_isnamedstream (vp
)) {
6096 error
= vnode_verifynamedstream(vp
);
6105 vn_authorize_create(vnode_t dvp
, struct componentname
*cnp
, struct vnode_attr
*vap
, vfs_context_t ctx
, void *reserved
)
6113 if (cnp
->cn_ndp
== NULL
) {
6114 panic("NULL cn_ndp");
6116 if (reserved
!= NULL
) {
6117 panic("reserved not NULL.");
6120 /* Only validate path for creation if we didn't do a complete lookup */
6121 if (cnp
->cn_ndp
->ni_flag
& NAMEI_UNFINISHED
) {
6122 error
= lookup_validate_creation_path(cnp
->cn_ndp
);
6128 error
= mac_vnode_check_create(ctx
, dvp
, cnp
, vap
);
6131 #endif /* CONFIG_MACF */
6133 return (vnode_authorize(dvp
, NULL
, KAUTH_VNODE_ADD_FILE
, ctx
));
6137 vn_authorize_rename(struct vnode
*fdvp
, struct vnode
*fvp
, struct componentname
*fcnp
,
6138 struct vnode
*tdvp
, struct vnode
*tvp
, struct componentname
*tcnp
,
6139 vfs_context_t ctx
, void *reserved
)
6141 return vn_authorize_renamex(fdvp
, fvp
, fcnp
, tdvp
, tvp
, tcnp
, ctx
, 0, reserved
);
6145 vn_authorize_renamex(struct vnode
*fdvp
, struct vnode
*fvp
, struct componentname
*fcnp
,
6146 struct vnode
*tdvp
, struct vnode
*tvp
, struct componentname
*tcnp
,
6147 vfs_context_t ctx
, vfs_rename_flags_t flags
, void *reserved
)
6150 return vn_authorize_renamex_with_paths(fdvp
, fvp
, fcnp
, NULL
, tdvp
, tvp
, tcnp
, NULL
, ctx
, flags
, reserved
);
6154 vn_authorize_renamex_with_paths(struct vnode
*fdvp
, struct vnode
*fvp
, struct componentname
*fcnp
, const char *from_path
,
6155 struct vnode
*tdvp
, struct vnode
*tvp
, struct componentname
*tcnp
, const char *to_path
,
6156 vfs_context_t ctx
, vfs_rename_flags_t flags
, void *reserved
)
6160 bool swap
= flags
& VFS_RENAME_SWAP
;
6162 if (reserved
!= NULL
) {
6163 panic("Passed something other than NULL as reserved field!");
6167 * Avoid renaming "." and "..".
6169 * XXX No need to check for this in the FS. We should always have the leaves
6170 * in VFS in this case.
6172 if (fvp
->v_type
== VDIR
&&
6174 (fcnp
->cn_namelen
== 1 && fcnp
->cn_nameptr
[0] == '.') ||
6175 ((fcnp
->cn_flags
| tcnp
->cn_flags
) & ISDOTDOT
)) ) {
6180 if (tvp
== NULLVP
&& vnode_compound_rename_available(tdvp
)) {
6181 error
= lookup_validate_creation_path(tcnp
->cn_ndp
);
6186 /***** <MACF> *****/
6188 error
= mac_vnode_check_rename(ctx
, fdvp
, fvp
, fcnp
, tdvp
, tvp
, tcnp
);
6192 error
= mac_vnode_check_rename(ctx
, tdvp
, tvp
, tcnp
, fdvp
, fvp
, fcnp
);
6197 /***** </MACF> *****/
6199 /***** <MiscChecks> *****/
6202 if (fvp
->v_type
== VDIR
&& tvp
->v_type
!= VDIR
) {
6205 } else if (fvp
->v_type
!= VDIR
&& tvp
->v_type
== VDIR
) {
6212 * Caller should have already checked this and returned
6213 * ENOENT. If we send back ENOENT here, caller will retry
6214 * which isn't what we want so we send back EINVAL here
6227 * The following edge case is caught here:
6228 * (to cannot be a descendent of from)
6241 if (tdvp
->v_parent
== fvp
) {
6246 if (swap
&& fdvp
->v_parent
== tvp
) {
6250 /***** </MiscChecks> *****/
6252 /***** <Kauth> *****/
6255 * As part of the Kauth step, we call out to allow 3rd-party
6256 * fileop notification of "about to rename". This is needed
6257 * in the event that 3rd-parties need to know that the DELETE
6258 * authorization is actually part of a rename. It's important
6259 * that we guarantee that the DELETE call-out will always be
6260 * made if the WILL_RENAME call-out is made. Another fileop
6261 * call-out will be performed once the operation is completed.
6262 * We can ignore the result of kauth_authorize_fileop().
6264 * N.B. We are passing the vnode and *both* paths to each
6265 * call; kauth_authorize_fileop() extracts the "from" path
6266 * when posting a KAUTH_FILEOP_WILL_RENAME notification.
6267 * As such, we only post these notifications if all of the
6268 * information we need is provided.
6272 kauth_action_t f
= 0, t
= 0;
6275 * Directories changing parents need ...ADD_SUBDIR... to
6276 * permit changing ".."
6279 if (vnode_isdir(fvp
))
6280 f
= KAUTH_VNODE_ADD_SUBDIRECTORY
;
6281 if (vnode_isdir(tvp
))
6282 t
= KAUTH_VNODE_ADD_SUBDIRECTORY
;
6284 if (to_path
!= NULL
)
6285 kauth_authorize_fileop(vfs_context_ucred(ctx
),
6286 KAUTH_FILEOP_WILL_RENAME
,
6288 (uintptr_t)to_path
);
6289 error
= vnode_authorize(fvp
, fdvp
, KAUTH_VNODE_DELETE
| f
, ctx
);
6292 if (from_path
!= NULL
)
6293 kauth_authorize_fileop(vfs_context_ucred(ctx
),
6294 KAUTH_FILEOP_WILL_RENAME
,
6296 (uintptr_t)from_path
);
6297 error
= vnode_authorize(tvp
, tdvp
, KAUTH_VNODE_DELETE
| t
, ctx
);
6300 f
= vnode_isdir(fvp
) ? KAUTH_VNODE_ADD_SUBDIRECTORY
: KAUTH_VNODE_ADD_FILE
;
6301 t
= vnode_isdir(tvp
) ? KAUTH_VNODE_ADD_SUBDIRECTORY
: KAUTH_VNODE_ADD_FILE
;
6303 error
= vnode_authorize(fdvp
, NULL
, f
| t
, ctx
);
6305 error
= vnode_authorize(fdvp
, NULL
, t
, ctx
);
6308 error
= vnode_authorize(tdvp
, NULL
, f
, ctx
);
6314 if ((tvp
!= NULL
) && vnode_isdir(tvp
)) {
6317 } else if (tdvp
!= fdvp
) {
6322 * must have delete rights to remove the old name even in
6323 * the simple case of fdvp == tdvp.
6325 * If fvp is a directory, and we are changing it's parent,
6326 * then we also need rights to rewrite its ".." entry as well.
6328 if (to_path
!= NULL
)
6329 kauth_authorize_fileop(vfs_context_ucred(ctx
),
6330 KAUTH_FILEOP_WILL_RENAME
,
6332 (uintptr_t)to_path
);
6333 if (vnode_isdir(fvp
)) {
6334 if ((error
= vnode_authorize(fvp
, fdvp
, KAUTH_VNODE_DELETE
| KAUTH_VNODE_ADD_SUBDIRECTORY
, ctx
)) != 0)
6337 if ((error
= vnode_authorize(fvp
, fdvp
, KAUTH_VNODE_DELETE
, ctx
)) != 0)
6341 /* moving into tdvp or tvp, must have rights to add */
6342 if ((error
= vnode_authorize(((tvp
!= NULL
) && vnode_isdir(tvp
)) ? tvp
: tdvp
,
6344 vnode_isdir(fvp
) ? KAUTH_VNODE_ADD_SUBDIRECTORY
: KAUTH_VNODE_ADD_FILE
,
6349 /* node staying in same directory, must be allowed to add new name */
6350 if ((error
= vnode_authorize(fdvp
, NULL
,
6351 vnode_isdir(fvp
) ? KAUTH_VNODE_ADD_SUBDIRECTORY
: KAUTH_VNODE_ADD_FILE
, ctx
)) != 0)
6354 /* overwriting tvp */
6355 if ((tvp
!= NULL
) && !vnode_isdir(tvp
) &&
6356 ((error
= vnode_authorize(tvp
, tdvp
, KAUTH_VNODE_DELETE
, ctx
)) != 0)) {
6361 /***** </Kauth> *****/
6363 /* XXX more checks? */
6369 vn_authorize_mkdir(vnode_t dvp
, struct componentname
*cnp
, struct vnode_attr
*vap
, vfs_context_t ctx
, void *reserved
)
6376 if (reserved
!= NULL
) {
6377 panic("reserved not NULL in vn_authorize_mkdir()");
6380 /* XXX A hack for now, to make shadow files work */
6381 if (cnp
->cn_ndp
== NULL
) {
6385 if (vnode_compound_mkdir_available(dvp
)) {
6386 error
= lookup_validate_creation_path(cnp
->cn_ndp
);
6392 error
= mac_vnode_check_create(ctx
,
6398 /* authorize addition of a directory to the parent */
6399 if ((error
= vnode_authorize(dvp
, NULL
, KAUTH_VNODE_ADD_SUBDIRECTORY
, ctx
)) != 0)
6407 vn_authorize_rmdir(vnode_t dvp
, vnode_t vp
, struct componentname
*cnp
, vfs_context_t ctx
, void *reserved
)
6414 if (reserved
!= NULL
) {
6415 panic("Non-NULL reserved argument to vn_authorize_rmdir()");
6418 if (vp
->v_type
!= VDIR
) {
6420 * rmdir only deals with directories
6427 * No rmdir "." please.
6433 error
= mac_vnode_check_unlink(ctx
, dvp
,
6439 return vnode_authorize(vp
, dvp
, KAUTH_VNODE_DELETE
, ctx
);
6443 * Authorizer for directory cloning. This does not use vnodes but instead
6444 * uses prefilled vnode attributes from the filesystem.
6446 * The same function is called to set up the attributes required, perform the
6447 * authorization and cleanup (if required)
6450 vnode_attr_authorize_dir_clone(struct vnode_attr
*vap
, kauth_action_t action
,
6451 struct vnode_attr
*dvap
, __unused vnode_t sdvp
, mount_t mp
,
6452 dir_clone_authorizer_op_t vattr_op
, uint32_t flags
, vfs_context_t ctx
,
6453 __unused
void *reserved
)
6456 int is_suser
= vfs_context_issuser(ctx
);
6458 if (vattr_op
== OP_VATTR_SETUP
) {
6462 * When ACL inheritence is implemented, both vap->va_acl and
6463 * dvap->va_acl will be required (even as superuser).
6465 VATTR_WANTED(vap
, va_type
);
6466 VATTR_WANTED(vap
, va_mode
);
6467 VATTR_WANTED(vap
, va_flags
);
6468 VATTR_WANTED(vap
, va_uid
);
6469 VATTR_WANTED(vap
, va_gid
);
6472 VATTR_WANTED(dvap
, va_flags
);
6477 * If not superuser, we have to evaluate ACLs and
6478 * need the target directory gid to set the initial
6479 * gid of the new object.
6481 VATTR_WANTED(vap
, va_acl
);
6483 VATTR_WANTED(dvap
, va_gid
);
6484 } else if (dvap
&& (flags
& VNODE_CLONEFILE_NOOWNERCOPY
)) {
6485 VATTR_WANTED(dvap
, va_gid
);
6488 } else if (vattr_op
== OP_VATTR_CLEANUP
) {
6489 return (0); /* Nothing to do for now */
6492 /* dvap isn't used for authorization */
6493 error
= vnode_attr_authorize(vap
, NULL
, mp
, action
, ctx
);
6499 * vn_attribute_prepare should be able to accept attributes as well as
6500 * vnodes but for now we do this inline.
6502 if (!is_suser
|| (flags
& VNODE_CLONEFILE_NOOWNERCOPY
)) {
6504 * If the filesystem is mounted IGNORE_OWNERSHIP and an explicit
6505 * owner is set, that owner takes ownership of all new files.
6507 if ((mp
->mnt_flag
& MNT_IGNORE_OWNERSHIP
) &&
6508 (mp
->mnt_fsowner
!= KAUTH_UID_NONE
)) {
6509 VATTR_SET(vap
, va_uid
, mp
->mnt_fsowner
);
6511 /* default owner is current user */
6512 VATTR_SET(vap
, va_uid
,
6513 kauth_cred_getuid(vfs_context_ucred(ctx
)));
6516 if ((mp
->mnt_flag
& MNT_IGNORE_OWNERSHIP
) &&
6517 (mp
->mnt_fsgroup
!= KAUTH_GID_NONE
)) {
6518 VATTR_SET(vap
, va_gid
, mp
->mnt_fsgroup
);
6521 * default group comes from parent object,
6522 * fallback to current user
6524 if (VATTR_IS_SUPPORTED(dvap
, va_gid
)) {
6525 VATTR_SET(vap
, va_gid
, dvap
->va_gid
);
6527 VATTR_SET(vap
, va_gid
,
6528 kauth_cred_getgid(vfs_context_ucred(ctx
)));
6533 /* Inherit SF_RESTRICTED bit from destination directory only */
6534 if (VATTR_IS_ACTIVE(vap
, va_flags
)) {
6535 VATTR_SET(vap
, va_flags
,
6536 ((vap
->va_flags
& ~(UF_DATAVAULT
| SF_RESTRICTED
)))); /* Turn off from source */
6537 if (VATTR_IS_ACTIVE(dvap
, va_flags
))
6538 VATTR_SET(vap
, va_flags
,
6539 vap
->va_flags
| (dvap
->va_flags
& (UF_DATAVAULT
| SF_RESTRICTED
)));
6540 } else if (VATTR_IS_ACTIVE(dvap
, va_flags
)) {
6541 VATTR_SET(vap
, va_flags
, (dvap
->va_flags
& (UF_DATAVAULT
| SF_RESTRICTED
)));
6549 * Authorize an operation on a vnode.
6551 * This is KPI, but here because it needs vnode_scope.
6553 * Returns: 0 Success
6554 * kauth_authorize_action:EPERM ...
6555 * xlate => EACCES Permission denied
6556 * kauth_authorize_action:0 Success
6557 * kauth_authorize_action: Depends on callback return; this is
6558 * usually only vnode_authorize_callback(),
6559 * but may include other listerners, if any
6567 vnode_authorize(vnode_t vp
, vnode_t dvp
, kauth_action_t action
, vfs_context_t ctx
)
6572 * We can't authorize against a dead vnode; allow all operations through so that
6573 * the correct error can be returned.
6575 if (vp
->v_type
== VBAD
)
6579 result
= kauth_authorize_action(vnode_scope
, vfs_context_ucred(ctx
), action
,
6580 (uintptr_t)ctx
, (uintptr_t)vp
, (uintptr_t)dvp
, (uintptr_t)&error
);
6581 if (result
== EPERM
) /* traditional behaviour */
6583 /* did the lower layers give a better error return? */
6584 if ((result
!= 0) && (error
!= 0))
6590 * Test for vnode immutability.
6592 * The 'append' flag is set when the authorization request is constrained
6593 * to operations which only request the right to append to a file.
6595 * The 'ignore' flag is set when an operation modifying the immutability flags
6596 * is being authorized. We check the system securelevel to determine which
6597 * immutability flags we can ignore.
6600 vnode_immutable(struct vnode_attr
*vap
, int append
, int ignore
)
6604 /* start with all bits precluding the operation */
6605 mask
= IMMUTABLE
| APPEND
;
6607 /* if appending only, remove the append-only bits */
6611 /* ignore only set when authorizing flags changes */
6613 if (securelevel
<= 0) {
6614 /* in insecure state, flags do not inhibit changes */
6617 /* in secure state, user flags don't inhibit */
6618 mask
&= ~(UF_IMMUTABLE
| UF_APPEND
);
6621 KAUTH_DEBUG("IMMUTABLE - file flags 0x%x mask 0x%x append = %d ignore = %d", vap
->va_flags
, mask
, append
, ignore
);
6622 if ((vap
->va_flags
& mask
) != 0)
6628 vauth_node_owner(struct vnode_attr
*vap
, kauth_cred_t cred
)
6632 /* default assumption is not-owner */
6636 * If the filesystem has given us a UID, we treat this as authoritative.
6638 if (vap
&& VATTR_IS_SUPPORTED(vap
, va_uid
)) {
6639 result
= (vap
->va_uid
== kauth_cred_getuid(cred
)) ? 1 : 0;
6641 /* we could test the owner UUID here if we had a policy for it */
6649 * Description: Ask if a cred is a member of the group owning the vnode object
6651 * Parameters: vap vnode attribute
6652 * vap->va_gid group owner of vnode object
6653 * cred credential to check
6654 * ismember pointer to where to put the answer
6655 * idontknow Return this if we can't get an answer
6657 * Returns: 0 Success
6658 * idontknow Can't get information
6659 * kauth_cred_ismember_gid:? Error from kauth subsystem
6660 * kauth_cred_ismember_gid:? Error from kauth subsystem
6663 vauth_node_group(struct vnode_attr
*vap
, kauth_cred_t cred
, int *ismember
, int idontknow
)
6672 * The caller is expected to have asked the filesystem for a group
6673 * at some point prior to calling this function. The answer may
6674 * have been that there is no group ownership supported for the
6675 * vnode object, in which case we return
6677 if (vap
&& VATTR_IS_SUPPORTED(vap
, va_gid
)) {
6678 error
= kauth_cred_ismember_gid(cred
, vap
->va_gid
, &result
);
6680 * Credentials which are opted into external group membership
6681 * resolution which are not known to the external resolver
6682 * will result in an ENOENT error. We translate this into
6683 * the appropriate 'idontknow' response for our caller.
6685 * XXX We do not make a distinction here between an ENOENT
6686 * XXX arising from a response from the external resolver,
6687 * XXX and an ENOENT which is internally generated. This is
6688 * XXX a deficiency of the published kauth_cred_ismember_gid()
6689 * XXX KPI which can not be overcome without new KPI. For
6690 * XXX all currently known cases, however, this wil result
6691 * XXX in correct behaviour.
6693 if (error
== ENOENT
)
6697 * XXX We could test the group UUID here if we had a policy for it,
6698 * XXX but this is problematic from the perspective of synchronizing
6699 * XXX group UUID and POSIX GID ownership of a file and keeping the
6700 * XXX values coherent over time. The problem is that the local
6701 * XXX system will vend transient group UUIDs for unknown POSIX GID
6702 * XXX values, and these are not persistent, whereas storage of values
6703 * XXX is persistent. One potential solution to this is a local
6704 * XXX (persistent) replica of remote directory entries and vended
6705 * XXX local ids in a local directory server (think in terms of a
6706 * XXX caching DNS server).
6715 vauth_file_owner(vauth_ctx vcp
)
6719 if (vcp
->flags_valid
& _VAC_IS_OWNER
) {
6720 result
= (vcp
->flags
& _VAC_IS_OWNER
) ? 1 : 0;
6722 result
= vauth_node_owner(vcp
->vap
, vcp
->ctx
->vc_ucred
);
6724 /* cache our result */
6725 vcp
->flags_valid
|= _VAC_IS_OWNER
;
6727 vcp
->flags
|= _VAC_IS_OWNER
;
6729 vcp
->flags
&= ~_VAC_IS_OWNER
;
6737 * vauth_file_ingroup
6739 * Description: Ask if a user is a member of the group owning the directory
6741 * Parameters: vcp The vnode authorization context that
6742 * contains the user and directory info
6743 * vcp->flags_valid Valid flags
6744 * vcp->flags Flags values
6745 * vcp->vap File vnode attributes
6746 * vcp->ctx VFS Context (for user)
6747 * ismember pointer to where to put the answer
6748 * idontknow Return this if we can't get an answer
6750 * Returns: 0 Success
6751 * vauth_node_group:? Error from vauth_node_group()
6753 * Implicit returns: *ismember 0 The user is not a group member
6754 * 1 The user is a group member
6757 vauth_file_ingroup(vauth_ctx vcp
, int *ismember
, int idontknow
)
6761 /* Check for a cached answer first, to avoid the check if possible */
6762 if (vcp
->flags_valid
& _VAC_IN_GROUP
) {
6763 *ismember
= (vcp
->flags
& _VAC_IN_GROUP
) ? 1 : 0;
6766 /* Otherwise, go look for it */
6767 error
= vauth_node_group(vcp
->vap
, vcp
->ctx
->vc_ucred
, ismember
, idontknow
);
6770 /* cache our result */
6771 vcp
->flags_valid
|= _VAC_IN_GROUP
;
6773 vcp
->flags
|= _VAC_IN_GROUP
;
6775 vcp
->flags
&= ~_VAC_IN_GROUP
;
6784 vauth_dir_owner(vauth_ctx vcp
)
6788 if (vcp
->flags_valid
& _VAC_IS_DIR_OWNER
) {
6789 result
= (vcp
->flags
& _VAC_IS_DIR_OWNER
) ? 1 : 0;
6791 result
= vauth_node_owner(vcp
->dvap
, vcp
->ctx
->vc_ucred
);
6793 /* cache our result */
6794 vcp
->flags_valid
|= _VAC_IS_DIR_OWNER
;
6796 vcp
->flags
|= _VAC_IS_DIR_OWNER
;
6798 vcp
->flags
&= ~_VAC_IS_DIR_OWNER
;
6807 * Description: Ask if a user is a member of the group owning the directory
6809 * Parameters: vcp The vnode authorization context that
6810 * contains the user and directory info
6811 * vcp->flags_valid Valid flags
6812 * vcp->flags Flags values
6813 * vcp->dvap Dir vnode attributes
6814 * vcp->ctx VFS Context (for user)
6815 * ismember pointer to where to put the answer
6816 * idontknow Return this if we can't get an answer
6818 * Returns: 0 Success
6819 * vauth_node_group:? Error from vauth_node_group()
6821 * Implicit returns: *ismember 0 The user is not a group member
6822 * 1 The user is a group member
6825 vauth_dir_ingroup(vauth_ctx vcp
, int *ismember
, int idontknow
)
6829 /* Check for a cached answer first, to avoid the check if possible */
6830 if (vcp
->flags_valid
& _VAC_IN_DIR_GROUP
) {
6831 *ismember
= (vcp
->flags
& _VAC_IN_DIR_GROUP
) ? 1 : 0;
6834 /* Otherwise, go look for it */
6835 error
= vauth_node_group(vcp
->dvap
, vcp
->ctx
->vc_ucred
, ismember
, idontknow
);
6838 /* cache our result */
6839 vcp
->flags_valid
|= _VAC_IN_DIR_GROUP
;
6841 vcp
->flags
|= _VAC_IN_DIR_GROUP
;
6843 vcp
->flags
&= ~_VAC_IN_DIR_GROUP
;
6851 * Test the posix permissions in (vap) to determine whether (credential)
6852 * may perform (action)
6855 vnode_authorize_posix(vauth_ctx vcp
, int action
, int on_dir
)
6857 struct vnode_attr
*vap
;
6858 int needed
, error
, owner_ok
, group_ok
, world_ok
, ismember
;
6859 #ifdef KAUTH_DEBUG_ENABLE
6860 const char *where
= "uninitialized";
6861 # define _SETWHERE(c) where = c;
6863 # define _SETWHERE(c)
6866 /* checking file or directory? */
6876 * We want to do as little work here as possible. So first we check
6877 * which sets of permissions grant us the access we need, and avoid checking
6878 * whether specific permissions grant access when more generic ones would.
6881 /* owner permissions */
6885 if (action
& VWRITE
)
6889 owner_ok
= (needed
& vap
->va_mode
) == needed
;
6891 /* group permissions */
6895 if (action
& VWRITE
)
6899 group_ok
= (needed
& vap
->va_mode
) == needed
;
6901 /* world permissions */
6905 if (action
& VWRITE
)
6909 world_ok
= (needed
& vap
->va_mode
) == needed
;
6911 /* If granted/denied by all three, we're done */
6912 if (owner_ok
&& group_ok
&& world_ok
) {
6916 if (!owner_ok
&& !group_ok
&& !world_ok
) {
6922 /* Check ownership (relatively cheap) */
6923 if ((on_dir
&& vauth_dir_owner(vcp
)) ||
6924 (!on_dir
&& vauth_file_owner(vcp
))) {
6931 /* Not owner; if group and world both grant it we're done */
6932 if (group_ok
&& world_ok
) {
6933 _SETWHERE("group/world");
6936 if (!group_ok
&& !world_ok
) {
6937 _SETWHERE("group/world");
6942 /* Check group membership (most expensive) */
6943 ismember
= 0; /* Default to allow, if the target has no group owner */
6946 * In the case we can't get an answer about the user from the call to
6947 * vauth_dir_ingroup() or vauth_file_ingroup(), we want to fail on
6948 * the side of caution, rather than simply granting access, or we will
6949 * fail to correctly implement exclusion groups, so we set the third
6950 * parameter on the basis of the state of 'group_ok'.
6953 error
= vauth_dir_ingroup(vcp
, &ismember
, (!group_ok
? EACCES
: 0));
6955 error
= vauth_file_ingroup(vcp
, &ismember
, (!group_ok
? EACCES
: 0));
6969 /* Not owner, not in group, use world result */
6977 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",
6978 vcp
->vp
, (error
== 0) ? "ALLOWED" : "DENIED", where
,
6979 (action
& VREAD
) ? "r" : "-",
6980 (action
& VWRITE
) ? "w" : "-",
6981 (action
& VEXEC
) ? "x" : "-",
6983 (vap
->va_mode
& S_IRUSR
) ? "r" : "-",
6984 (vap
->va_mode
& S_IWUSR
) ? "w" : "-",
6985 (vap
->va_mode
& S_IXUSR
) ? "x" : "-",
6986 (vap
->va_mode
& S_IRGRP
) ? "r" : "-",
6987 (vap
->va_mode
& S_IWGRP
) ? "w" : "-",
6988 (vap
->va_mode
& S_IXGRP
) ? "x" : "-",
6989 (vap
->va_mode
& S_IROTH
) ? "r" : "-",
6990 (vap
->va_mode
& S_IWOTH
) ? "w" : "-",
6991 (vap
->va_mode
& S_IXOTH
) ? "x" : "-",
6992 kauth_cred_getuid(vcp
->ctx
->vc_ucred
),
6993 on_dir
? vcp
->dvap
->va_uid
: vcp
->vap
->va_uid
,
6994 on_dir
? vcp
->dvap
->va_gid
: vcp
->vap
->va_gid
);
6999 * Authorize the deletion of the node vp from the directory dvp.
7002 * - Neither the node nor the directory are immutable.
7003 * - The user is not the superuser.
7005 * The precedence of factors for authorizing or denying delete for a credential
7007 * 1) Explicit ACE on the node. (allow or deny DELETE)
7008 * 2) Explicit ACE on the directory (allow or deny DELETE_CHILD).
7010 * If there are conflicting ACEs on the node and the directory, the node
7013 * 3) Sticky bit on the directory.
7014 * Deletion is not permitted if the directory is sticky and the caller is
7015 * not owner of the node or directory. The sticky bit rules are like a deny
7016 * delete ACE except lower in priority than ACL's either allowing or denying
7019 * 4) POSIX permisions on the directory.
7021 * As an optimization, we cache whether or not delete child is permitted
7022 * on directories. This enables us to skip directory ACL and POSIX checks
7023 * as we already have the result from those checks. However, we always check the
7024 * node ACL and, if the directory has the sticky bit set, we always check its
7025 * ACL (even for a directory with an authorized delete child). Furthermore,
7026 * caching the delete child authorization is independent of the sticky bit
7027 * being set as it is only applicable in determining whether the node can be
7031 vnode_authorize_delete(vauth_ctx vcp
, boolean_t cached_delete_child
)
7033 struct vnode_attr
*vap
= vcp
->vap
;
7034 struct vnode_attr
*dvap
= vcp
->dvap
;
7035 kauth_cred_t cred
= vcp
->ctx
->vc_ucred
;
7036 struct kauth_acl_eval eval
;
7037 int error
, ismember
;
7039 /* Check the ACL on the node first */
7040 if (VATTR_IS_NOT(vap
, va_acl
, NULL
)) {
7041 eval
.ae_requested
= KAUTH_VNODE_DELETE
;
7042 eval
.ae_acl
= &vap
->va_acl
->acl_ace
[0];
7043 eval
.ae_count
= vap
->va_acl
->acl_entrycount
;
7044 eval
.ae_options
= 0;
7045 if (vauth_file_owner(vcp
))
7046 eval
.ae_options
|= KAUTH_AEVAL_IS_OWNER
;
7048 * We use ENOENT as a marker to indicate we could not get
7049 * information in order to delay evaluation until after we
7050 * have the ACL evaluation answer. Previously, we would
7051 * always deny the operation at this point.
7053 if ((error
= vauth_file_ingroup(vcp
, &ismember
, ENOENT
)) != 0 && error
!= ENOENT
)
7055 if (error
== ENOENT
)
7056 eval
.ae_options
|= KAUTH_AEVAL_IN_GROUP_UNKNOWN
;
7058 eval
.ae_options
|= KAUTH_AEVAL_IN_GROUP
;
7059 eval
.ae_exp_gall
= KAUTH_VNODE_GENERIC_ALL_BITS
;
7060 eval
.ae_exp_gread
= KAUTH_VNODE_GENERIC_READ_BITS
;
7061 eval
.ae_exp_gwrite
= KAUTH_VNODE_GENERIC_WRITE_BITS
;
7062 eval
.ae_exp_gexec
= KAUTH_VNODE_GENERIC_EXECUTE_BITS
;
7064 if ((error
= kauth_acl_evaluate(cred
, &eval
)) != 0) {
7065 KAUTH_DEBUG("%p ERROR during ACL processing - %d", vcp
->vp
, error
);
7069 switch(eval
.ae_result
) {
7070 case KAUTH_RESULT_DENY
:
7071 KAUTH_DEBUG("%p DENIED - denied by ACL", vcp
->vp
);
7073 case KAUTH_RESULT_ALLOW
:
7074 KAUTH_DEBUG("%p ALLOWED - granted by ACL", vcp
->vp
);
7076 case KAUTH_RESULT_DEFER
:
7078 /* Defer to directory */
7079 KAUTH_DEBUG("%p DEFERRED - by file ACL", vcp
->vp
);
7085 * Without a sticky bit, a previously authorized delete child is
7086 * sufficient to authorize this delete.
7088 * If the sticky bit is set, a directory ACL which allows delete child
7089 * overrides a (potential) sticky bit deny. The authorized delete child
7090 * cannot tell us if it was authorized because of an explicit delete
7091 * child allow ACE or because of POSIX permisions so we have to check
7092 * the directory ACL everytime if the directory has a sticky bit.
7094 if (!(dvap
->va_mode
& S_ISTXT
) && cached_delete_child
) {
7095 KAUTH_DEBUG("%p ALLOWED - granted by directory ACL or POSIX permissions and no sticky bit on directory", vcp
->vp
);
7099 /* check the ACL on the directory */
7100 if (VATTR_IS_NOT(dvap
, va_acl
, NULL
)) {
7101 eval
.ae_requested
= KAUTH_VNODE_DELETE_CHILD
;
7102 eval
.ae_acl
= &dvap
->va_acl
->acl_ace
[0];
7103 eval
.ae_count
= dvap
->va_acl
->acl_entrycount
;
7104 eval
.ae_options
= 0;
7105 if (vauth_dir_owner(vcp
))
7106 eval
.ae_options
|= KAUTH_AEVAL_IS_OWNER
;
7108 * We use ENOENT as a marker to indicate we could not get
7109 * information in order to delay evaluation until after we
7110 * have the ACL evaluation answer. Previously, we would
7111 * always deny the operation at this point.
7113 if ((error
= vauth_dir_ingroup(vcp
, &ismember
, ENOENT
)) != 0 && error
!= ENOENT
)
7115 if (error
== ENOENT
)
7116 eval
.ae_options
|= KAUTH_AEVAL_IN_GROUP_UNKNOWN
;
7118 eval
.ae_options
|= KAUTH_AEVAL_IN_GROUP
;
7119 eval
.ae_exp_gall
= KAUTH_VNODE_GENERIC_ALL_BITS
;
7120 eval
.ae_exp_gread
= KAUTH_VNODE_GENERIC_READ_BITS
;
7121 eval
.ae_exp_gwrite
= KAUTH_VNODE_GENERIC_WRITE_BITS
;
7122 eval
.ae_exp_gexec
= KAUTH_VNODE_GENERIC_EXECUTE_BITS
;
7125 * If there is no entry, we are going to defer to other
7126 * authorization mechanisms.
7128 error
= kauth_acl_evaluate(cred
, &eval
);
7131 KAUTH_DEBUG("%p ERROR during ACL processing - %d", vcp
->vp
, error
);
7134 switch(eval
.ae_result
) {
7135 case KAUTH_RESULT_DENY
:
7136 KAUTH_DEBUG("%p DENIED - denied by directory ACL", vcp
->vp
);
7138 case KAUTH_RESULT_ALLOW
:
7139 KAUTH_DEBUG("%p ALLOWED - granted by directory ACL", vcp
->vp
);
7140 if (!cached_delete_child
&& vcp
->dvp
) {
7141 vnode_cache_authorized_action(vcp
->dvp
,
7142 vcp
->ctx
, KAUTH_VNODE_DELETE_CHILD
);
7145 case KAUTH_RESULT_DEFER
:
7147 /* Deferred by directory ACL */
7148 KAUTH_DEBUG("%p DEFERRED - directory ACL", vcp
->vp
);
7154 * From this point, we can't explicitly allow and if we reach the end
7155 * of the function without a denial, then the delete is authorized.
7157 if (!cached_delete_child
) {
7158 if (vnode_authorize_posix(vcp
, VWRITE
, 1 /* on_dir */) != 0) {
7159 KAUTH_DEBUG("%p DENIED - denied by posix permisssions", vcp
->vp
);
7163 * Cache the authorized action on the vnode if allowed by the
7164 * directory ACL or POSIX permissions. It is correct to cache
7165 * this action even if sticky bit would deny deleting the node.
7168 vnode_cache_authorized_action(vcp
->dvp
, vcp
->ctx
,
7169 KAUTH_VNODE_DELETE_CHILD
);
7173 /* enforce sticky bit behaviour */
7174 if ((dvap
->va_mode
& S_ISTXT
) && !vauth_file_owner(vcp
) && !vauth_dir_owner(vcp
)) {
7175 KAUTH_DEBUG("%p DENIED - sticky bit rules (user %d file %d dir %d)",
7176 vcp
->vp
, cred
->cr_posix
.cr_uid
, vap
->va_uid
, dvap
->va_uid
);
7180 /* not denied, must be OK */
7186 * Authorize an operation based on the node's attributes.
7189 vnode_authorize_simple(vauth_ctx vcp
, kauth_ace_rights_t acl_rights
, kauth_ace_rights_t preauth_rights
, boolean_t
*found_deny
)
7191 struct vnode_attr
*vap
= vcp
->vap
;
7192 kauth_cred_t cred
= vcp
->ctx
->vc_ucred
;
7193 struct kauth_acl_eval eval
;
7194 int error
, ismember
;
7195 mode_t posix_action
;
7198 * If we are the file owner, we automatically have some rights.
7200 * Do we need to expand this to support group ownership?
7202 if (vauth_file_owner(vcp
))
7203 acl_rights
&= ~(KAUTH_VNODE_WRITE_SECURITY
);
7206 * If we are checking both TAKE_OWNERSHIP and WRITE_SECURITY, we can
7207 * mask the latter. If TAKE_OWNERSHIP is requested the caller is about to
7208 * change ownership to themselves, and WRITE_SECURITY is implicitly
7209 * granted to the owner. We need to do this because at this point
7210 * WRITE_SECURITY may not be granted as the caller is not currently
7213 if ((acl_rights
& KAUTH_VNODE_TAKE_OWNERSHIP
) &&
7214 (acl_rights
& KAUTH_VNODE_WRITE_SECURITY
))
7215 acl_rights
&= ~KAUTH_VNODE_WRITE_SECURITY
;
7217 if (acl_rights
== 0) {
7218 KAUTH_DEBUG("%p ALLOWED - implicit or no rights required", vcp
->vp
);
7222 /* if we have an ACL, evaluate it */
7223 if (VATTR_IS_NOT(vap
, va_acl
, NULL
)) {
7224 eval
.ae_requested
= acl_rights
;
7225 eval
.ae_acl
= &vap
->va_acl
->acl_ace
[0];
7226 eval
.ae_count
= vap
->va_acl
->acl_entrycount
;
7227 eval
.ae_options
= 0;
7228 if (vauth_file_owner(vcp
))
7229 eval
.ae_options
|= KAUTH_AEVAL_IS_OWNER
;
7231 * We use ENOENT as a marker to indicate we could not get
7232 * information in order to delay evaluation until after we
7233 * have the ACL evaluation answer. Previously, we would
7234 * always deny the operation at this point.
7236 if ((error
= vauth_file_ingroup(vcp
, &ismember
, ENOENT
)) != 0 && error
!= ENOENT
)
7238 if (error
== ENOENT
)
7239 eval
.ae_options
|= KAUTH_AEVAL_IN_GROUP_UNKNOWN
;
7241 eval
.ae_options
|= KAUTH_AEVAL_IN_GROUP
;
7242 eval
.ae_exp_gall
= KAUTH_VNODE_GENERIC_ALL_BITS
;
7243 eval
.ae_exp_gread
= KAUTH_VNODE_GENERIC_READ_BITS
;
7244 eval
.ae_exp_gwrite
= KAUTH_VNODE_GENERIC_WRITE_BITS
;
7245 eval
.ae_exp_gexec
= KAUTH_VNODE_GENERIC_EXECUTE_BITS
;
7247 if ((error
= kauth_acl_evaluate(cred
, &eval
)) != 0) {
7248 KAUTH_DEBUG("%p ERROR during ACL processing - %d", vcp
->vp
, error
);
7252 switch(eval
.ae_result
) {
7253 case KAUTH_RESULT_DENY
:
7254 KAUTH_DEBUG("%p DENIED - by ACL", vcp
->vp
);
7255 return(EACCES
); /* deny, deny, counter-allege */
7256 case KAUTH_RESULT_ALLOW
:
7257 KAUTH_DEBUG("%p ALLOWED - all rights granted by ACL", vcp
->vp
);
7259 case KAUTH_RESULT_DEFER
:
7261 /* Effectively the same as !delete_child_denied */
7262 KAUTH_DEBUG("%p DEFERRED - directory ACL", vcp
->vp
);
7266 *found_deny
= eval
.ae_found_deny
;
7268 /* fall through and evaluate residual rights */
7270 /* no ACL, everything is residual */
7271 eval
.ae_residual
= acl_rights
;
7275 * Grant residual rights that have been pre-authorized.
7277 eval
.ae_residual
&= ~preauth_rights
;
7280 * We grant WRITE_ATTRIBUTES to the owner if it hasn't been denied.
7282 if (vauth_file_owner(vcp
))
7283 eval
.ae_residual
&= ~KAUTH_VNODE_WRITE_ATTRIBUTES
;
7285 if (eval
.ae_residual
== 0) {
7286 KAUTH_DEBUG("%p ALLOWED - rights already authorized", vcp
->vp
);
7291 * Bail if we have residual rights that can't be granted by posix permissions,
7292 * or aren't presumed granted at this point.
7294 * XXX these can be collapsed for performance
7296 if (eval
.ae_residual
& KAUTH_VNODE_CHANGE_OWNER
) {
7297 KAUTH_DEBUG("%p DENIED - CHANGE_OWNER not permitted", vcp
->vp
);
7300 if (eval
.ae_residual
& KAUTH_VNODE_WRITE_SECURITY
) {
7301 KAUTH_DEBUG("%p DENIED - WRITE_SECURITY not permitted", vcp
->vp
);
7306 if (eval
.ae_residual
& KAUTH_VNODE_DELETE
)
7307 panic("vnode_authorize: can't be checking delete permission here");
7311 * Compute the fallback posix permissions that will satisfy the remaining
7315 if (eval
.ae_residual
& (KAUTH_VNODE_READ_DATA
|
7316 KAUTH_VNODE_LIST_DIRECTORY
|
7317 KAUTH_VNODE_READ_EXTATTRIBUTES
))
7318 posix_action
|= VREAD
;
7319 if (eval
.ae_residual
& (KAUTH_VNODE_WRITE_DATA
|
7320 KAUTH_VNODE_ADD_FILE
|
7321 KAUTH_VNODE_ADD_SUBDIRECTORY
|
7322 KAUTH_VNODE_DELETE_CHILD
|
7323 KAUTH_VNODE_WRITE_ATTRIBUTES
|
7324 KAUTH_VNODE_WRITE_EXTATTRIBUTES
))
7325 posix_action
|= VWRITE
;
7326 if (eval
.ae_residual
& (KAUTH_VNODE_EXECUTE
|
7327 KAUTH_VNODE_SEARCH
))
7328 posix_action
|= VEXEC
;
7330 if (posix_action
!= 0) {
7331 return(vnode_authorize_posix(vcp
, posix_action
, 0 /* !on_dir */));
7333 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",
7335 (eval
.ae_residual
& KAUTH_VNODE_READ_DATA
)
7336 ? vnode_isdir(vcp
->vp
) ? " LIST_DIRECTORY" : " READ_DATA" : "",
7337 (eval
.ae_residual
& KAUTH_VNODE_WRITE_DATA
)
7338 ? vnode_isdir(vcp
->vp
) ? " ADD_FILE" : " WRITE_DATA" : "",
7339 (eval
.ae_residual
& KAUTH_VNODE_EXECUTE
)
7340 ? vnode_isdir(vcp
->vp
) ? " SEARCH" : " EXECUTE" : "",
7341 (eval
.ae_residual
& KAUTH_VNODE_DELETE
)
7343 (eval
.ae_residual
& KAUTH_VNODE_APPEND_DATA
)
7344 ? vnode_isdir(vcp
->vp
) ? " ADD_SUBDIRECTORY" : " APPEND_DATA" : "",
7345 (eval
.ae_residual
& KAUTH_VNODE_DELETE_CHILD
)
7346 ? " DELETE_CHILD" : "",
7347 (eval
.ae_residual
& KAUTH_VNODE_READ_ATTRIBUTES
)
7348 ? " READ_ATTRIBUTES" : "",
7349 (eval
.ae_residual
& KAUTH_VNODE_WRITE_ATTRIBUTES
)
7350 ? " WRITE_ATTRIBUTES" : "",
7351 (eval
.ae_residual
& KAUTH_VNODE_READ_EXTATTRIBUTES
)
7352 ? " READ_EXTATTRIBUTES" : "",
7353 (eval
.ae_residual
& KAUTH_VNODE_WRITE_EXTATTRIBUTES
)
7354 ? " WRITE_EXTATTRIBUTES" : "",
7355 (eval
.ae_residual
& KAUTH_VNODE_READ_SECURITY
)
7356 ? " READ_SECURITY" : "",
7357 (eval
.ae_residual
& KAUTH_VNODE_WRITE_SECURITY
)
7358 ? " WRITE_SECURITY" : "",
7359 (eval
.ae_residual
& KAUTH_VNODE_CHECKIMMUTABLE
)
7360 ? " CHECKIMMUTABLE" : "",
7361 (eval
.ae_residual
& KAUTH_VNODE_CHANGE_OWNER
)
7362 ? " CHANGE_OWNER" : "");
7366 * Lack of required Posix permissions implies no reason to deny access.
7372 * Check for file immutability.
7375 vnode_authorize_checkimmutable(mount_t mp
, struct vnode_attr
*vap
, int rights
, int ignore
)
7381 * Perform immutability checks for operations that change data.
7383 * Sockets, fifos and devices require special handling.
7385 switch(vap
->va_type
) {
7391 * Writing to these nodes does not change the filesystem data,
7392 * so forget that it's being tried.
7394 rights
&= ~KAUTH_VNODE_WRITE_DATA
;
7401 if (rights
& KAUTH_VNODE_WRITE_RIGHTS
) {
7403 /* check per-filesystem options if possible */
7406 /* check for no-EA filesystems */
7407 if ((rights
& KAUTH_VNODE_WRITE_EXTATTRIBUTES
) &&
7408 (vfs_flags(mp
) & MNT_NOUSERXATTR
)) {
7409 KAUTH_DEBUG("%p DENIED - filesystem disallowed extended attributes", vp
);
7410 error
= EACCES
; /* User attributes disabled */
7416 * check for file immutability. first, check if the requested rights are
7417 * allowable for a UF_APPEND file.
7420 if (vap
->va_type
== VDIR
) {
7421 if ((rights
& (KAUTH_VNODE_ADD_FILE
| KAUTH_VNODE_ADD_SUBDIRECTORY
| KAUTH_VNODE_WRITE_EXTATTRIBUTES
)) == rights
)
7424 if ((rights
& (KAUTH_VNODE_APPEND_DATA
| KAUTH_VNODE_WRITE_EXTATTRIBUTES
)) == rights
)
7427 if ((error
= vnode_immutable(vap
, append
, ignore
)) != 0) {
7428 KAUTH_DEBUG("%p DENIED - file is immutable", vp
);
7437 * Handle authorization actions for filesystems that advertise that the
7438 * server will be enforcing.
7440 * Returns: 0 Authorization should be handled locally
7441 * 1 Authorization was handled by the FS
7443 * Note: Imputed returns will only occur if the authorization request
7444 * was handled by the FS.
7446 * Imputed: *resultp, modified Return code from FS when the request is
7447 * handled by the FS.
7452 vnode_authorize_opaque(vnode_t vp
, int *resultp
, kauth_action_t action
, vfs_context_t ctx
)
7457 * If the vp is a device node, socket or FIFO it actually represents a local
7458 * endpoint, so we need to handle it locally.
7460 switch(vp
->v_type
) {
7471 * In the advisory request case, if the filesystem doesn't think it's reliable
7472 * we will attempt to formulate a result ourselves based on VNOP_GETATTR data.
7474 if ((action
& KAUTH_VNODE_ACCESS
) && !vfs_authopaqueaccess(vp
->v_mount
))
7478 * Let the filesystem have a say in the matter. It's OK for it to not implemnent
7479 * VNOP_ACCESS, as most will authorise inline with the actual request.
7481 if ((error
= VNOP_ACCESS(vp
, action
, ctx
)) != ENOTSUP
) {
7483 KAUTH_DEBUG("%p DENIED - opaque filesystem VNOP_ACCESS denied access", vp
);
7488 * Typically opaque filesystems do authorisation in-line, but exec is a special case. In
7489 * order to be reasonably sure that exec will be permitted, we try a bit harder here.
7491 if ((action
& KAUTH_VNODE_EXECUTE
) && (vp
->v_type
== VREG
)) {
7492 /* try a VNOP_OPEN for readonly access */
7493 if ((error
= VNOP_OPEN(vp
, FREAD
, ctx
)) != 0) {
7495 KAUTH_DEBUG("%p DENIED - EXECUTE denied because file could not be opened readonly", vp
);
7498 VNOP_CLOSE(vp
, FREAD
, ctx
);
7502 * We don't have any reason to believe that the request has to be denied at this point,
7503 * so go ahead and allow it.
7506 KAUTH_DEBUG("%p ALLOWED - bypassing access check for non-local filesystem", vp
);
7514 * Returns: KAUTH_RESULT_ALLOW
7517 * Imputed: *arg3, modified Error code in the deny case
7518 * EROFS Read-only file system
7519 * EACCES Permission denied
7520 * EPERM Operation not permitted [no execute]
7521 * vnode_getattr:ENOMEM Not enough space [only if has filesec]
7523 * vnode_authorize_opaque:*arg2 ???
7524 * vnode_authorize_checkimmutable:???
7525 * vnode_authorize_delete:???
7526 * vnode_authorize_simple:???
7531 vnode_authorize_callback(__unused kauth_cred_t cred
, __unused
void *idata
,
7532 kauth_action_t action
, uintptr_t arg0
, uintptr_t arg1
, uintptr_t arg2
,
7536 vnode_t cvp
= NULLVP
;
7538 int result
= KAUTH_RESULT_DENY
;
7539 int parent_iocount
= 0;
7540 int parent_action
; /* In case we need to use namedstream's data fork for cached rights*/
7542 ctx
= (vfs_context_t
)arg0
;
7544 dvp
= (vnode_t
)arg2
;
7547 * if there are 2 vnodes passed in, we don't know at
7548 * this point which rights to look at based on the
7549 * combined action being passed in... defer until later...
7550 * otherwise check the kauth 'rights' cache hung
7551 * off of the vnode we're interested in... if we've already
7552 * been granted the right we're currently interested in,
7553 * we can just return success... otherwise we'll go through
7554 * the process of authorizing the requested right(s)... if that
7555 * succeeds, we'll add the right(s) to the cache.
7556 * VNOP_SETATTR and VNOP_SETXATTR will invalidate this cache
7564 * For named streams on local-authorization volumes, rights are cached on the parent;
7565 * authorization is determined by looking at the parent's properties anyway, so storing
7566 * on the parent means that we don't recompute for the named stream and that if
7567 * we need to flush rights (e.g. on VNOP_SETATTR()) we don't need to track down the
7568 * stream to flush its cache separately. If we miss in the cache, then we authorize
7569 * as if there were no cached rights (passing the named stream vnode and desired rights to
7570 * vnode_authorize_callback_int()).
7572 * On an opaquely authorized volume, we don't know the relationship between the
7573 * data fork's properties and the rights granted on a stream. Thus, named stream vnodes
7574 * on such a volume are authorized directly (rather than using the parent) and have their
7575 * own caches. When a named stream vnode is created, we mark the parent as having a named
7576 * stream. On a VNOP_SETATTR() for the parent that may invalidate cached authorization, we
7577 * find the stream and flush its cache.
7579 if (vnode_isnamedstream(vp
) && (!vfs_authopaque(vp
->v_mount
))) {
7580 cvp
= vnode_getparent(vp
);
7581 if (cvp
!= NULLVP
) {
7585 goto defer
; /* If we can't use the parent, take the slow path */
7588 /* Have to translate some actions */
7589 parent_action
= action
;
7590 if (parent_action
& KAUTH_VNODE_READ_DATA
) {
7591 parent_action
&= ~KAUTH_VNODE_READ_DATA
;
7592 parent_action
|= KAUTH_VNODE_READ_EXTATTRIBUTES
;
7594 if (parent_action
& KAUTH_VNODE_WRITE_DATA
) {
7595 parent_action
&= ~KAUTH_VNODE_WRITE_DATA
;
7596 parent_action
|= KAUTH_VNODE_WRITE_EXTATTRIBUTES
;
7604 if (vnode_cache_is_authorized(cvp
, ctx
, parent_iocount
? parent_action
: action
) == TRUE
) {
7605 result
= KAUTH_RESULT_ALLOW
;
7609 result
= vnode_authorize_callback_int(action
, ctx
, vp
, dvp
, (int *)arg3
);
7611 if (result
== KAUTH_RESULT_ALLOW
&& cvp
!= NULLVP
) {
7612 KAUTH_DEBUG("%p - caching action = %x", cvp
, action
);
7613 vnode_cache_authorized_action(cvp
, ctx
, action
);
7617 if (parent_iocount
) {
7625 vnode_attr_authorize_internal(vauth_ctx vcp
, mount_t mp
,
7626 kauth_ace_rights_t rights
, int is_suser
, boolean_t
*found_deny
,
7627 int noimmutable
, int parent_authorized_for_delete_child
)
7632 * Check for immutability.
7634 * In the deletion case, parent directory immutability vetoes specific
7637 if ((result
= vnode_authorize_checkimmutable(mp
, vcp
->vap
, rights
,
7641 if ((rights
& KAUTH_VNODE_DELETE
) &&
7642 !parent_authorized_for_delete_child
) {
7643 result
= vnode_authorize_checkimmutable(mp
, vcp
->dvap
,
7644 KAUTH_VNODE_DELETE_CHILD
, 0);
7650 * Clear rights that have been authorized by reaching this point, bail if nothing left to
7653 rights
&= ~(KAUTH_VNODE_LINKTARGET
| KAUTH_VNODE_CHECKIMMUTABLE
);
7658 * If we're not the superuser, authorize based on file properties;
7659 * note that even if parent_authorized_for_delete_child is TRUE, we
7660 * need to check on the node itself.
7663 /* process delete rights */
7664 if ((rights
& KAUTH_VNODE_DELETE
) &&
7665 ((result
= vnode_authorize_delete(vcp
, parent_authorized_for_delete_child
)) != 0))
7668 /* process remaining rights */
7669 if ((rights
& ~KAUTH_VNODE_DELETE
) &&
7670 (result
= vnode_authorize_simple(vcp
, rights
, rights
& KAUTH_VNODE_DELETE
, found_deny
)) != 0)
7674 * Execute is only granted to root if one of the x bits is set. This check only
7675 * makes sense if the posix mode bits are actually supported.
7677 if ((rights
& KAUTH_VNODE_EXECUTE
) &&
7678 (vcp
->vap
->va_type
== VREG
) &&
7679 VATTR_IS_SUPPORTED(vcp
->vap
, va_mode
) &&
7680 !(vcp
->vap
->va_mode
& (S_IXUSR
| S_IXGRP
| S_IXOTH
))) {
7682 KAUTH_DEBUG("%p DENIED - root execute requires at least one x bit in 0x%x", vp
, va
.va_mode
);
7686 /* Assume that there were DENYs so we don't wrongly cache KAUTH_VNODE_SEARCHBYANYONE */
7689 KAUTH_DEBUG("%p ALLOWED - caller is superuser", vp
);
7696 vnode_authorize_callback_int(kauth_action_t action
, vfs_context_t ctx
,
7697 vnode_t vp
, vnode_t dvp
, int *errorp
)
7699 struct _vnode_authorize_context auth_context
;
7702 kauth_ace_rights_t rights
;
7703 struct vnode_attr va
, dva
;
7706 boolean_t parent_authorized_for_delete_child
= FALSE
;
7707 boolean_t found_deny
= FALSE
;
7708 boolean_t parent_ref
= FALSE
;
7709 boolean_t is_suser
= FALSE
;
7711 vcp
= &auth_context
;
7716 * Note that we authorize against the context, not the passed cred
7717 * (the same thing anyway)
7719 cred
= ctx
->vc_ucred
;
7726 vcp
->flags
= vcp
->flags_valid
= 0;
7729 if ((ctx
== NULL
) || (vp
== NULL
) || (cred
== NULL
))
7730 panic("vnode_authorize: bad arguments (context %p vp %p cred %p)", ctx
, vp
, cred
);
7733 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)",
7734 vp
, vfs_context_proc(ctx
)->p_comm
,
7735 (action
& KAUTH_VNODE_ACCESS
) ? "access" : "auth",
7736 (action
& KAUTH_VNODE_READ_DATA
) ? vnode_isdir(vp
) ? " LIST_DIRECTORY" : " READ_DATA" : "",
7737 (action
& KAUTH_VNODE_WRITE_DATA
) ? vnode_isdir(vp
) ? " ADD_FILE" : " WRITE_DATA" : "",
7738 (action
& KAUTH_VNODE_EXECUTE
) ? vnode_isdir(vp
) ? " SEARCH" : " EXECUTE" : "",
7739 (action
& KAUTH_VNODE_DELETE
) ? " DELETE" : "",
7740 (action
& KAUTH_VNODE_APPEND_DATA
) ? vnode_isdir(vp
) ? " ADD_SUBDIRECTORY" : " APPEND_DATA" : "",
7741 (action
& KAUTH_VNODE_DELETE_CHILD
) ? " DELETE_CHILD" : "",
7742 (action
& KAUTH_VNODE_READ_ATTRIBUTES
) ? " READ_ATTRIBUTES" : "",
7743 (action
& KAUTH_VNODE_WRITE_ATTRIBUTES
) ? " WRITE_ATTRIBUTES" : "",
7744 (action
& KAUTH_VNODE_READ_EXTATTRIBUTES
) ? " READ_EXTATTRIBUTES" : "",
7745 (action
& KAUTH_VNODE_WRITE_EXTATTRIBUTES
) ? " WRITE_EXTATTRIBUTES" : "",
7746 (action
& KAUTH_VNODE_READ_SECURITY
) ? " READ_SECURITY" : "",
7747 (action
& KAUTH_VNODE_WRITE_SECURITY
) ? " WRITE_SECURITY" : "",
7748 (action
& KAUTH_VNODE_CHANGE_OWNER
) ? " CHANGE_OWNER" : "",
7749 (action
& KAUTH_VNODE_NOIMMUTABLE
) ? " (noimmutable)" : "",
7750 vnode_isdir(vp
) ? "directory" : "file",
7751 vp
->v_name
? vp
->v_name
: "<NULL>", action
, vp
, dvp
);
7754 * Extract the control bits from the action, everything else is
7757 noimmutable
= (action
& KAUTH_VNODE_NOIMMUTABLE
) ? 1 : 0;
7758 rights
= action
& ~(KAUTH_VNODE_ACCESS
| KAUTH_VNODE_NOIMMUTABLE
);
7760 if (rights
& KAUTH_VNODE_DELETE
) {
7763 panic("vnode_authorize: KAUTH_VNODE_DELETE test requires a directory");
7766 * check to see if we've already authorized the parent
7767 * directory for deletion of its children... if so, we
7768 * can skip a whole bunch of work... we will still have to
7769 * authorize that this specific child can be removed
7771 if (vnode_cache_is_authorized(dvp
, ctx
, KAUTH_VNODE_DELETE_CHILD
) == TRUE
)
7772 parent_authorized_for_delete_child
= TRUE
;
7779 * Check for read-only filesystems.
7781 if ((rights
& KAUTH_VNODE_WRITE_RIGHTS
) &&
7782 (vp
->v_mount
->mnt_flag
& MNT_RDONLY
) &&
7783 ((vp
->v_type
== VREG
) || (vp
->v_type
== VDIR
) ||
7784 (vp
->v_type
== VLNK
) || (vp
->v_type
== VCPLX
) ||
7785 (rights
& KAUTH_VNODE_DELETE
) || (rights
& KAUTH_VNODE_DELETE_CHILD
))) {
7791 * Check for noexec filesystems.
7793 if ((rights
& KAUTH_VNODE_EXECUTE
) && (vp
->v_type
== VREG
) && (vp
->v_mount
->mnt_flag
& MNT_NOEXEC
)) {
7799 * Handle cases related to filesystems with non-local enforcement.
7800 * This call can return 0, in which case we will fall through to perform a
7801 * check based on VNOP_GETATTR data. Otherwise it returns 1 and sets
7802 * an appropriate result, at which point we can return immediately.
7804 if ((vp
->v_mount
->mnt_kern_flag
& MNTK_AUTH_OPAQUE
) && vnode_authorize_opaque(vp
, &result
, action
, ctx
))
7808 * If the vnode is a namedstream (extended attribute) data vnode (eg.
7809 * a resource fork), *_DATA becomes *_EXTATTRIBUTES.
7811 if (vnode_isnamedstream(vp
)) {
7812 if (rights
& KAUTH_VNODE_READ_DATA
) {
7813 rights
&= ~KAUTH_VNODE_READ_DATA
;
7814 rights
|= KAUTH_VNODE_READ_EXTATTRIBUTES
;
7816 if (rights
& KAUTH_VNODE_WRITE_DATA
) {
7817 rights
&= ~KAUTH_VNODE_WRITE_DATA
;
7818 rights
|= KAUTH_VNODE_WRITE_EXTATTRIBUTES
;
7822 * Point 'vp' to the namedstream's parent for ACL checking
7824 if ((vp
->v_parent
!= NULL
) &&
7825 (vget_internal(vp
->v_parent
, 0, VNODE_NODEAD
| VNODE_DRAINO
) == 0)) {
7827 vcp
->vp
= vp
= vp
->v_parent
;
7831 if (vfs_context_issuser(ctx
)) {
7833 * if we're not asking for execute permissions or modifications,
7834 * then we're done, this action is authorized.
7836 if (!(rights
& (KAUTH_VNODE_EXECUTE
| KAUTH_VNODE_WRITE_RIGHTS
)))
7843 * Get vnode attributes and extended security information for the vnode
7844 * and directory if required.
7846 * If we're root we only want mode bits and flags for checking
7847 * execute and immutability.
7849 VATTR_WANTED(&va
, va_mode
);
7850 VATTR_WANTED(&va
, va_flags
);
7852 VATTR_WANTED(&va
, va_uid
);
7853 VATTR_WANTED(&va
, va_gid
);
7854 VATTR_WANTED(&va
, va_acl
);
7856 if ((result
= vnode_getattr(vp
, &va
, ctx
)) != 0) {
7857 KAUTH_DEBUG("%p ERROR - failed to get vnode attributes - %d", vp
, result
);
7860 VATTR_WANTED(&va
, va_type
);
7861 VATTR_RETURN(&va
, va_type
, vnode_vtype(vp
));
7864 VATTR_WANTED(&dva
, va_mode
);
7865 VATTR_WANTED(&dva
, va_flags
);
7867 VATTR_WANTED(&dva
, va_uid
);
7868 VATTR_WANTED(&dva
, va_gid
);
7869 VATTR_WANTED(&dva
, va_acl
);
7871 if ((result
= vnode_getattr(vcp
->dvp
, &dva
, ctx
)) != 0) {
7872 KAUTH_DEBUG("%p ERROR - failed to get directory vnode attributes - %d", vp
, result
);
7875 VATTR_WANTED(&dva
, va_type
);
7876 VATTR_RETURN(&dva
, va_type
, vnode_vtype(vcp
->dvp
));
7879 result
= vnode_attr_authorize_internal(vcp
, vp
->v_mount
, rights
, is_suser
,
7880 &found_deny
, noimmutable
, parent_authorized_for_delete_child
);
7882 if (VATTR_IS_SUPPORTED(&va
, va_acl
) && (va
.va_acl
!= NULL
))
7883 kauth_acl_free(va
.va_acl
);
7884 if (VATTR_IS_SUPPORTED(&dva
, va_acl
) && (dva
.va_acl
!= NULL
))
7885 kauth_acl_free(dva
.va_acl
);
7891 KAUTH_DEBUG("%p DENIED - auth denied", vp
);
7892 return(KAUTH_RESULT_DENY
);
7894 if ((rights
& KAUTH_VNODE_SEARCH
) && found_deny
== FALSE
&& vp
->v_type
== VDIR
) {
7896 * if we were successfully granted the right to search this directory
7897 * and there were NO ACL DENYs for search and the posix permissions also don't
7898 * deny execute, we can synthesize a global right that allows anyone to
7899 * traverse this directory during a pathname lookup without having to
7900 * match the credential associated with this cache of rights.
7902 * Note that we can correctly cache KAUTH_VNODE_SEARCHBYANYONE
7903 * only if we actually check ACLs which we don't for root. As
7904 * a workaround, the lookup fast path checks for root.
7906 if (!VATTR_IS_SUPPORTED(&va
, va_mode
) ||
7907 ((va
.va_mode
& (S_IXUSR
| S_IXGRP
| S_IXOTH
)) ==
7908 (S_IXUSR
| S_IXGRP
| S_IXOTH
))) {
7909 vnode_cache_authorized_action(vp
, ctx
, KAUTH_VNODE_SEARCHBYANYONE
);
7917 * Note that this implies that we will allow requests for no rights, as well as
7918 * for rights that we do not recognise. There should be none of these.
7920 KAUTH_DEBUG("%p ALLOWED - auth granted", vp
);
7921 return(KAUTH_RESULT_ALLOW
);
7925 vnode_attr_authorize_init(struct vnode_attr
*vap
, struct vnode_attr
*dvap
,
7926 kauth_action_t action
, vfs_context_t ctx
)
7929 VATTR_WANTED(vap
, va_type
);
7930 VATTR_WANTED(vap
, va_mode
);
7931 VATTR_WANTED(vap
, va_flags
);
7934 if (action
& KAUTH_VNODE_DELETE
) {
7935 VATTR_WANTED(dvap
, va_type
);
7936 VATTR_WANTED(dvap
, va_mode
);
7937 VATTR_WANTED(dvap
, va_flags
);
7939 } else if (action
& KAUTH_VNODE_DELETE
) {
7943 if (!vfs_context_issuser(ctx
)) {
7944 VATTR_WANTED(vap
, va_uid
);
7945 VATTR_WANTED(vap
, va_gid
);
7946 VATTR_WANTED(vap
, va_acl
);
7947 if (dvap
&& (action
& KAUTH_VNODE_DELETE
)) {
7948 VATTR_WANTED(dvap
, va_uid
);
7949 VATTR_WANTED(dvap
, va_gid
);
7950 VATTR_WANTED(dvap
, va_acl
);
7958 vnode_attr_authorize(struct vnode_attr
*vap
, struct vnode_attr
*dvap
, mount_t mp
,
7959 kauth_action_t action
, vfs_context_t ctx
)
7961 struct _vnode_authorize_context auth_context
;
7963 kauth_ace_rights_t rights
;
7965 boolean_t found_deny
;
7966 boolean_t is_suser
= FALSE
;
7969 vcp
= &auth_context
;
7975 vcp
->flags
= vcp
->flags_valid
= 0;
7977 noimmutable
= (action
& KAUTH_VNODE_NOIMMUTABLE
) ? 1 : 0;
7978 rights
= action
& ~(KAUTH_VNODE_ACCESS
| KAUTH_VNODE_NOIMMUTABLE
);
7981 * Check for read-only filesystems.
7983 if ((rights
& KAUTH_VNODE_WRITE_RIGHTS
) &&
7984 mp
&& (mp
->mnt_flag
& MNT_RDONLY
) &&
7985 ((vap
->va_type
== VREG
) || (vap
->va_type
== VDIR
) ||
7986 (vap
->va_type
== VLNK
) || (rights
& KAUTH_VNODE_DELETE
) ||
7987 (rights
& KAUTH_VNODE_DELETE_CHILD
))) {
7993 * Check for noexec filesystems.
7995 if ((rights
& KAUTH_VNODE_EXECUTE
) &&
7996 (vap
->va_type
== VREG
) && mp
&& (mp
->mnt_flag
& MNT_NOEXEC
)) {
8001 if (vfs_context_issuser(ctx
)) {
8003 * if we're not asking for execute permissions or modifications,
8004 * then we're done, this action is authorized.
8006 if (!(rights
& (KAUTH_VNODE_EXECUTE
| KAUTH_VNODE_WRITE_RIGHTS
)))
8010 if (!VATTR_IS_SUPPORTED(vap
, va_uid
) ||
8011 !VATTR_IS_SUPPORTED(vap
, va_gid
) ||
8012 (mp
&& vfs_extendedsecurity(mp
) && !VATTR_IS_SUPPORTED(vap
, va_acl
))) {
8013 panic("vnode attrs not complete for vnode_attr_authorize\n");
8017 result
= vnode_attr_authorize_internal(vcp
, mp
, rights
, is_suser
,
8018 &found_deny
, noimmutable
, FALSE
);
8020 if (result
== EPERM
)
8028 vnode_authattr_new(vnode_t dvp
, struct vnode_attr
*vap
, int noauth
, vfs_context_t ctx
)
8030 return vnode_authattr_new_internal(dvp
, vap
, noauth
, NULL
, ctx
);
8034 * Check that the attribute information in vattr can be legally applied to
8035 * a new file by the context.
8038 vnode_authattr_new_internal(vnode_t dvp
, struct vnode_attr
*vap
, int noauth
, uint32_t *defaulted_fieldsp
, vfs_context_t ctx
)
8041 int has_priv_suser
, ismember
, defaulted_owner
, defaulted_group
, defaulted_mode
;
8042 uint32_t inherit_flags
;
8046 struct vnode_attr dva
;
8050 if (defaulted_fieldsp
) {
8051 *defaulted_fieldsp
= 0;
8054 defaulted_owner
= defaulted_group
= defaulted_mode
= 0;
8059 * Require that the filesystem support extended security to apply any.
8061 if (!vfs_extendedsecurity(dvp
->v_mount
) &&
8062 (VATTR_IS_ACTIVE(vap
, va_acl
) || VATTR_IS_ACTIVE(vap
, va_uuuid
) || VATTR_IS_ACTIVE(vap
, va_guuid
))) {
8068 * Default some fields.
8073 * If the filesystem is mounted IGNORE_OWNERSHIP and an explicit owner is set, that
8074 * owner takes ownership of all new files.
8076 if ((dmp
->mnt_flag
& MNT_IGNORE_OWNERSHIP
) && (dmp
->mnt_fsowner
!= KAUTH_UID_NONE
)) {
8077 VATTR_SET(vap
, va_uid
, dmp
->mnt_fsowner
);
8078 defaulted_owner
= 1;
8080 if (!VATTR_IS_ACTIVE(vap
, va_uid
)) {
8081 /* default owner is current user */
8082 VATTR_SET(vap
, va_uid
, kauth_cred_getuid(vfs_context_ucred(ctx
)));
8083 defaulted_owner
= 1;
8088 * We need the dvp's va_flags and *may* need the gid of the directory,
8089 * we ask for both here.
8092 VATTR_WANTED(&dva
, va_gid
);
8093 VATTR_WANTED(&dva
, va_flags
);
8094 if ((error
= vnode_getattr(dvp
, &dva
, ctx
)) != 0)
8098 * If the filesystem is mounted IGNORE_OWNERSHIP and an explicit grouo is set, that
8099 * group takes ownership of all new files.
8101 if ((dmp
->mnt_flag
& MNT_IGNORE_OWNERSHIP
) && (dmp
->mnt_fsgroup
!= KAUTH_GID_NONE
)) {
8102 VATTR_SET(vap
, va_gid
, dmp
->mnt_fsgroup
);
8103 defaulted_group
= 1;
8105 if (!VATTR_IS_ACTIVE(vap
, va_gid
)) {
8106 /* default group comes from parent object, fallback to current user */
8107 if (VATTR_IS_SUPPORTED(&dva
, va_gid
)) {
8108 VATTR_SET(vap
, va_gid
, dva
.va_gid
);
8110 VATTR_SET(vap
, va_gid
, kauth_cred_getgid(vfs_context_ucred(ctx
)));
8112 defaulted_group
= 1;
8116 if (!VATTR_IS_ACTIVE(vap
, va_flags
))
8117 VATTR_SET(vap
, va_flags
, 0);
8119 /* Determine if SF_RESTRICTED should be inherited from the parent
8121 if (VATTR_IS_SUPPORTED(&dva
, va_flags
)) {
8122 inherit_flags
= dva
.va_flags
& (UF_DATAVAULT
| SF_RESTRICTED
);
8125 /* default mode is everything, masked with current umask */
8126 if (!VATTR_IS_ACTIVE(vap
, va_mode
)) {
8127 VATTR_SET(vap
, va_mode
, ACCESSPERMS
& ~vfs_context_proc(ctx
)->p_fd
->fd_cmask
);
8128 KAUTH_DEBUG("ATTR - defaulting new file mode to %o from umask %o", vap
->va_mode
, vfs_context_proc(ctx
)->p_fd
->fd_cmask
);
8131 /* set timestamps to now */
8132 if (!VATTR_IS_ACTIVE(vap
, va_create_time
)) {
8133 nanotime(&vap
->va_create_time
);
8134 VATTR_SET_ACTIVE(vap
, va_create_time
);
8138 * Check for attempts to set nonsensical fields.
8140 if (vap
->va_active
& ~VNODE_ATTR_NEWOBJ
) {
8142 KAUTH_DEBUG("ATTR - ERROR - attempt to set unsupported new-file attributes %llx",
8143 vap
->va_active
& ~VNODE_ATTR_NEWOBJ
);
8148 * Quickly check for the applicability of any enforcement here.
8149 * Tests below maintain the integrity of the local security model.
8151 if (vfs_authopaque(dvp
->v_mount
))
8155 * We need to know if the caller is the superuser, or if the work is
8156 * otherwise already authorised.
8158 cred
= vfs_context_ucred(ctx
);
8160 /* doing work for the kernel */
8163 has_priv_suser
= vfs_context_issuser(ctx
);
8167 if (VATTR_IS_ACTIVE(vap
, va_flags
)) {
8168 if (has_priv_suser
) {
8169 if ((vap
->va_flags
& (UF_SETTABLE
| SF_SETTABLE
)) != vap
->va_flags
) {
8171 KAUTH_DEBUG(" DENIED - superuser attempt to set illegal flag(s)");
8175 if ((vap
->va_flags
& UF_SETTABLE
) != vap
->va_flags
) {
8177 KAUTH_DEBUG(" DENIED - user attempt to set illegal flag(s)");
8183 /* if not superuser, validate legality of new-item attributes */
8184 if (!has_priv_suser
) {
8185 if (!defaulted_mode
&& VATTR_IS_ACTIVE(vap
, va_mode
)) {
8187 if (vap
->va_mode
& S_ISGID
) {
8188 if ((error
= kauth_cred_ismember_gid(cred
, vap
->va_gid
, &ismember
)) != 0) {
8189 KAUTH_DEBUG("ATTR - ERROR: got %d checking for membership in %d", error
, vap
->va_gid
);
8193 KAUTH_DEBUG(" DENIED - can't set SGID bit, not a member of %d", vap
->va_gid
);
8200 if ((vap
->va_mode
& S_ISUID
) && (vap
->va_uid
!= kauth_cred_getuid(cred
))) {
8201 KAUTH_DEBUG("ATTR - ERROR: illegal attempt to set the setuid bit");
8206 if (!defaulted_owner
&& (vap
->va_uid
!= kauth_cred_getuid(cred
))) {
8207 KAUTH_DEBUG(" DENIED - cannot create new item owned by %d", vap
->va_uid
);
8211 if (!defaulted_group
) {
8212 if ((error
= kauth_cred_ismember_gid(cred
, vap
->va_gid
, &ismember
)) != 0) {
8213 KAUTH_DEBUG(" ERROR - got %d checking for membership in %d", error
, vap
->va_gid
);
8217 KAUTH_DEBUG(" DENIED - cannot create new item with group %d - not a member", vap
->va_gid
);
8223 /* initialising owner/group UUID */
8224 if (VATTR_IS_ACTIVE(vap
, va_uuuid
)) {
8225 if ((error
= kauth_cred_getguid(cred
, &changer
)) != 0) {
8226 KAUTH_DEBUG(" ERROR - got %d trying to get caller UUID", error
);
8227 /* XXX ENOENT here - no GUID - should perhaps become EPERM */
8230 if (!kauth_guid_equal(&vap
->va_uuuid
, &changer
)) {
8231 KAUTH_DEBUG(" ERROR - cannot create item with supplied owner UUID - not us");
8236 if (VATTR_IS_ACTIVE(vap
, va_guuid
)) {
8237 if ((error
= kauth_cred_ismember_guid(cred
, &vap
->va_guuid
, &ismember
)) != 0) {
8238 KAUTH_DEBUG(" ERROR - got %d trying to check group membership", error
);
8242 KAUTH_DEBUG(" ERROR - cannot create item with supplied group UUID - not a member");
8249 if (inherit_flags
) {
8250 /* Apply SF_RESTRICTED to the file if its parent directory was
8251 * restricted. This is done at the end so that root is not
8252 * required if this flag is only set due to inheritance. */
8253 VATTR_SET(vap
, va_flags
, (vap
->va_flags
| inherit_flags
));
8255 if (defaulted_fieldsp
) {
8256 if (defaulted_mode
) {
8257 *defaulted_fieldsp
|= VATTR_PREPARE_DEFAULTED_MODE
;
8259 if (defaulted_group
) {
8260 *defaulted_fieldsp
|= VATTR_PREPARE_DEFAULTED_GID
;
8262 if (defaulted_owner
) {
8263 *defaulted_fieldsp
|= VATTR_PREPARE_DEFAULTED_UID
;
8270 * Check that the attribute information in vap can be legally written by the
8273 * Call this when you're not sure about the vnode_attr; either its contents
8274 * have come from an unknown source, or when they are variable.
8276 * Returns errno, or zero and sets *actionp to the KAUTH_VNODE_* actions that
8277 * must be authorized to be permitted to write the vattr.
8280 vnode_authattr(vnode_t vp
, struct vnode_attr
*vap
, kauth_action_t
*actionp
, vfs_context_t ctx
)
8282 struct vnode_attr ova
;
8283 kauth_action_t required_action
;
8284 int error
, has_priv_suser
, ismember
, chowner
, chgroup
, clear_suid
, clear_sgid
;
8293 required_action
= 0;
8297 * Quickly check for enforcement applicability.
8299 if (vfs_authopaque(vp
->v_mount
))
8303 * Check for attempts to set nonsensical fields.
8305 if (vap
->va_active
& VNODE_ATTR_RDONLY
) {
8306 KAUTH_DEBUG("ATTR - ERROR: attempt to set readonly attribute(s)");
8312 * We need to know if the caller is the superuser.
8314 cred
= vfs_context_ucred(ctx
);
8315 has_priv_suser
= kauth_cred_issuser(cred
);
8318 * If any of the following are changing, we need information from the old file:
8325 if (VATTR_IS_ACTIVE(vap
, va_uid
) ||
8326 VATTR_IS_ACTIVE(vap
, va_gid
) ||
8327 VATTR_IS_ACTIVE(vap
, va_mode
) ||
8328 VATTR_IS_ACTIVE(vap
, va_uuuid
) ||
8329 VATTR_IS_ACTIVE(vap
, va_guuid
)) {
8330 VATTR_WANTED(&ova
, va_mode
);
8331 VATTR_WANTED(&ova
, va_uid
);
8332 VATTR_WANTED(&ova
, va_gid
);
8333 VATTR_WANTED(&ova
, va_uuuid
);
8334 VATTR_WANTED(&ova
, va_guuid
);
8335 KAUTH_DEBUG("ATTR - security information changing, fetching existing attributes");
8339 * If timestamps are being changed, we need to know who the file is owned
8342 if (VATTR_IS_ACTIVE(vap
, va_create_time
) ||
8343 VATTR_IS_ACTIVE(vap
, va_change_time
) ||
8344 VATTR_IS_ACTIVE(vap
, va_modify_time
) ||
8345 VATTR_IS_ACTIVE(vap
, va_access_time
) ||
8346 VATTR_IS_ACTIVE(vap
, va_backup_time
) ||
8347 VATTR_IS_ACTIVE(vap
, va_addedtime
)) {
8349 VATTR_WANTED(&ova
, va_uid
);
8350 #if 0 /* enable this when we support UUIDs as official owners */
8351 VATTR_WANTED(&ova
, va_uuuid
);
8353 KAUTH_DEBUG("ATTR - timestamps changing, fetching uid and GUID");
8357 * If flags are being changed, we need the old flags.
8359 if (VATTR_IS_ACTIVE(vap
, va_flags
)) {
8360 KAUTH_DEBUG("ATTR - flags changing, fetching old flags");
8361 VATTR_WANTED(&ova
, va_flags
);
8365 * If ACLs are being changed, we need the old ACLs.
8367 if (VATTR_IS_ACTIVE(vap
, va_acl
)) {
8368 KAUTH_DEBUG("ATTR - acl changing, fetching old flags");
8369 VATTR_WANTED(&ova
, va_acl
);
8373 * If the size is being set, make sure it's not a directory.
8375 if (VATTR_IS_ACTIVE(vap
, va_data_size
)) {
8376 /* size is only meaningful on regular files, don't permit otherwise */
8377 if (!vnode_isreg(vp
)) {
8378 KAUTH_DEBUG("ATTR - ERROR: size change requested on non-file");
8379 error
= vnode_isdir(vp
) ? EISDIR
: EINVAL
;
8387 KAUTH_DEBUG("ATTR - fetching old attributes %016llx", ova
.va_active
);
8388 if ((error
= vnode_getattr(vp
, &ova
, ctx
)) != 0) {
8389 KAUTH_DEBUG(" ERROR - got %d trying to get attributes", error
);
8394 * Size changes require write access to the file data.
8396 if (VATTR_IS_ACTIVE(vap
, va_data_size
)) {
8397 /* if we can't get the size, or it's different, we need write access */
8398 KAUTH_DEBUG("ATTR - size change, requiring WRITE_DATA");
8399 required_action
|= KAUTH_VNODE_WRITE_DATA
;
8403 * Changing timestamps?
8405 * Note that we are only called to authorize user-requested time changes;
8406 * side-effect time changes are not authorized. Authorisation is only
8407 * required for existing files.
8409 * Non-owners are not permitted to change the time on an existing
8410 * file to anything other than the current time.
8412 if (VATTR_IS_ACTIVE(vap
, va_create_time
) ||
8413 VATTR_IS_ACTIVE(vap
, va_change_time
) ||
8414 VATTR_IS_ACTIVE(vap
, va_modify_time
) ||
8415 VATTR_IS_ACTIVE(vap
, va_access_time
) ||
8416 VATTR_IS_ACTIVE(vap
, va_backup_time
) ||
8417 VATTR_IS_ACTIVE(vap
, va_addedtime
)) {
8419 * The owner and root may set any timestamps they like,
8420 * provided that the file is not immutable. The owner still needs
8421 * WRITE_ATTRIBUTES (implied by ownership but still deniable).
8423 if (has_priv_suser
|| vauth_node_owner(&ova
, cred
)) {
8424 KAUTH_DEBUG("ATTR - root or owner changing timestamps");
8425 required_action
|= KAUTH_VNODE_CHECKIMMUTABLE
| KAUTH_VNODE_WRITE_ATTRIBUTES
;
8427 /* just setting the current time? */
8428 if (vap
->va_vaflags
& VA_UTIMES_NULL
) {
8429 KAUTH_DEBUG("ATTR - non-root/owner changing timestamps, requiring WRITE_ATTRIBUTES");
8430 required_action
|= KAUTH_VNODE_WRITE_ATTRIBUTES
;
8432 KAUTH_DEBUG("ATTR - ERROR: illegal timestamp modification attempted");
8440 * Changing file mode?
8442 if (VATTR_IS_ACTIVE(vap
, va_mode
) && VATTR_IS_SUPPORTED(&ova
, va_mode
) && (ova
.va_mode
!= vap
->va_mode
)) {
8443 KAUTH_DEBUG("ATTR - mode change from %06o to %06o", ova
.va_mode
, vap
->va_mode
);
8446 * Mode changes always have the same basic auth requirements.
8448 if (has_priv_suser
) {
8449 KAUTH_DEBUG("ATTR - superuser mode change, requiring immutability check");
8450 required_action
|= KAUTH_VNODE_CHECKIMMUTABLE
;
8452 /* need WRITE_SECURITY */
8453 KAUTH_DEBUG("ATTR - non-superuser mode change, requiring WRITE_SECURITY");
8454 required_action
|= KAUTH_VNODE_WRITE_SECURITY
;
8458 * Can't set the setgid bit if you're not in the group and not root. Have to have
8459 * existing group information in the case we're not setting it right now.
8461 if (vap
->va_mode
& S_ISGID
) {
8462 required_action
|= KAUTH_VNODE_CHECKIMMUTABLE
; /* always required */
8463 if (!has_priv_suser
) {
8464 if (VATTR_IS_ACTIVE(vap
, va_gid
)) {
8465 group
= vap
->va_gid
;
8466 } else if (VATTR_IS_SUPPORTED(&ova
, va_gid
)) {
8469 KAUTH_DEBUG("ATTR - ERROR: setgid but no gid available");
8474 * This might be too restrictive; WRITE_SECURITY might be implied by
8475 * membership in this case, rather than being an additional requirement.
8477 if ((error
= kauth_cred_ismember_gid(cred
, group
, &ismember
)) != 0) {
8478 KAUTH_DEBUG("ATTR - ERROR: got %d checking for membership in %d", error
, vap
->va_gid
);
8482 KAUTH_DEBUG(" DENIED - can't set SGID bit, not a member of %d", group
);
8490 * Can't set the setuid bit unless you're root or the file's owner.
8492 if (vap
->va_mode
& S_ISUID
) {
8493 required_action
|= KAUTH_VNODE_CHECKIMMUTABLE
; /* always required */
8494 if (!has_priv_suser
) {
8495 if (VATTR_IS_ACTIVE(vap
, va_uid
)) {
8496 owner
= vap
->va_uid
;
8497 } else if (VATTR_IS_SUPPORTED(&ova
, va_uid
)) {
8500 KAUTH_DEBUG("ATTR - ERROR: setuid but no uid available");
8504 if (owner
!= kauth_cred_getuid(cred
)) {
8506 * We could allow this if WRITE_SECURITY is permitted, perhaps.
8508 KAUTH_DEBUG("ATTR - ERROR: illegal attempt to set the setuid bit");
8517 * Validate/mask flags changes. This checks that only the flags in
8518 * the UF_SETTABLE mask are being set, and preserves the flags in
8519 * the SF_SETTABLE case.
8521 * Since flags changes may be made in conjunction with other changes,
8522 * we will ask the auth code to ignore immutability in the case that
8523 * the SF_* flags are not set and we are only manipulating the file flags.
8526 if (VATTR_IS_ACTIVE(vap
, va_flags
)) {
8527 /* compute changing flags bits */
8528 if (VATTR_IS_SUPPORTED(&ova
, va_flags
)) {
8529 fdelta
= vap
->va_flags
^ ova
.va_flags
;
8531 fdelta
= vap
->va_flags
;
8535 KAUTH_DEBUG("ATTR - flags changing, requiring WRITE_SECURITY");
8536 required_action
|= KAUTH_VNODE_WRITE_SECURITY
;
8538 /* check that changing bits are legal */
8539 if (has_priv_suser
) {
8541 * The immutability check will prevent us from clearing the SF_*
8542 * flags unless the system securelevel permits it, so just check
8543 * for legal flags here.
8545 if (fdelta
& ~(UF_SETTABLE
| SF_SETTABLE
)) {
8547 KAUTH_DEBUG(" DENIED - superuser attempt to set illegal flag(s)");
8551 if (fdelta
& ~UF_SETTABLE
) {
8553 KAUTH_DEBUG(" DENIED - user attempt to set illegal flag(s)");
8558 * If the caller has the ability to manipulate file flags,
8559 * security is not reduced by ignoring them for this operation.
8561 * A more complete test here would consider the 'after' states of the flags
8562 * to determine whether it would permit the operation, but this becomes
8565 * Ignoring immutability is conditional on securelevel; this does not bypass
8566 * the SF_* flags if securelevel > 0.
8568 required_action
|= KAUTH_VNODE_NOIMMUTABLE
;
8573 * Validate ownership information.
8582 * Note that if the filesystem didn't give us a UID, we expect that it doesn't
8583 * support them in general, and will ignore it if/when we try to set it.
8584 * We might want to clear the uid out of vap completely here.
8586 if (VATTR_IS_ACTIVE(vap
, va_uid
)) {
8587 if (VATTR_IS_SUPPORTED(&ova
, va_uid
) && (vap
->va_uid
!= ova
.va_uid
)) {
8588 if (!has_priv_suser
&& (kauth_cred_getuid(cred
) != vap
->va_uid
)) {
8589 KAUTH_DEBUG(" DENIED - non-superuser cannot change ownershipt to a third party");
8600 * Note that if the filesystem didn't give us a GID, we expect that it doesn't
8601 * support them in general, and will ignore it if/when we try to set it.
8602 * We might want to clear the gid out of vap completely here.
8604 if (VATTR_IS_ACTIVE(vap
, va_gid
)) {
8605 if (VATTR_IS_SUPPORTED(&ova
, va_gid
) && (vap
->va_gid
!= ova
.va_gid
)) {
8606 if (!has_priv_suser
) {
8607 if ((error
= kauth_cred_ismember_gid(cred
, vap
->va_gid
, &ismember
)) != 0) {
8608 KAUTH_DEBUG(" ERROR - got %d checking for membership in %d", error
, vap
->va_gid
);
8612 KAUTH_DEBUG(" DENIED - group change from %d to %d but not a member of target group",
8613 ova
.va_gid
, vap
->va_gid
);
8624 * Owner UUID being set or changed.
8626 if (VATTR_IS_ACTIVE(vap
, va_uuuid
)) {
8627 /* if the owner UUID is not actually changing ... */
8628 if (VATTR_IS_SUPPORTED(&ova
, va_uuuid
)) {
8629 if (kauth_guid_equal(&vap
->va_uuuid
, &ova
.va_uuuid
))
8630 goto no_uuuid_change
;
8633 * If the current owner UUID is a null GUID, check
8634 * it against the UUID corresponding to the owner UID.
8636 if (kauth_guid_equal(&ova
.va_uuuid
, &kauth_null_guid
) &&
8637 VATTR_IS_SUPPORTED(&ova
, va_uid
)) {
8640 if (kauth_cred_uid2guid(ova
.va_uid
, &uid_guid
) == 0 &&
8641 kauth_guid_equal(&vap
->va_uuuid
, &uid_guid
))
8642 goto no_uuuid_change
;
8647 * The owner UUID cannot be set by a non-superuser to anything other than
8648 * their own or a null GUID (to "unset" the owner UUID).
8649 * Note that file systems must be prepared to handle the
8650 * null UUID case in a manner appropriate for that file
8653 if (!has_priv_suser
) {
8654 if ((error
= kauth_cred_getguid(cred
, &changer
)) != 0) {
8655 KAUTH_DEBUG(" ERROR - got %d trying to get caller UUID", error
);
8656 /* XXX ENOENT here - no UUID - should perhaps become EPERM */
8659 if (!kauth_guid_equal(&vap
->va_uuuid
, &changer
) &&
8660 !kauth_guid_equal(&vap
->va_uuuid
, &kauth_null_guid
)) {
8661 KAUTH_DEBUG(" ERROR - cannot set supplied owner UUID - not us / null");
8671 * Group UUID being set or changed.
8673 if (VATTR_IS_ACTIVE(vap
, va_guuid
)) {
8674 /* if the group UUID is not actually changing ... */
8675 if (VATTR_IS_SUPPORTED(&ova
, va_guuid
)) {
8676 if (kauth_guid_equal(&vap
->va_guuid
, &ova
.va_guuid
))
8677 goto no_guuid_change
;
8680 * If the current group UUID is a null UUID, check
8681 * it against the UUID corresponding to the group GID.
8683 if (kauth_guid_equal(&ova
.va_guuid
, &kauth_null_guid
) &&
8684 VATTR_IS_SUPPORTED(&ova
, va_gid
)) {
8687 if (kauth_cred_gid2guid(ova
.va_gid
, &gid_guid
) == 0 &&
8688 kauth_guid_equal(&vap
->va_guuid
, &gid_guid
))
8689 goto no_guuid_change
;
8694 * The group UUID cannot be set by a non-superuser to anything other than
8695 * one of which they are a member or a null GUID (to "unset"
8697 * Note that file systems must be prepared to handle the
8698 * null UUID case in a manner appropriate for that file
8701 if (!has_priv_suser
) {
8702 if (kauth_guid_equal(&vap
->va_guuid
, &kauth_null_guid
))
8704 else if ((error
= kauth_cred_ismember_guid(cred
, &vap
->va_guuid
, &ismember
)) != 0) {
8705 KAUTH_DEBUG(" ERROR - got %d trying to check group membership", error
);
8709 KAUTH_DEBUG(" ERROR - cannot set supplied group UUID - not a member / null");
8719 * Compute authorisation for group/ownership changes.
8721 if (chowner
|| chgroup
|| clear_suid
|| clear_sgid
) {
8722 if (has_priv_suser
) {
8723 KAUTH_DEBUG("ATTR - superuser changing file owner/group, requiring immutability check");
8724 required_action
|= KAUTH_VNODE_CHECKIMMUTABLE
;
8727 KAUTH_DEBUG("ATTR - ownership change, requiring TAKE_OWNERSHIP");
8728 required_action
|= KAUTH_VNODE_TAKE_OWNERSHIP
;
8730 if (chgroup
&& !chowner
) {
8731 KAUTH_DEBUG("ATTR - group change, requiring WRITE_SECURITY");
8732 required_action
|= KAUTH_VNODE_WRITE_SECURITY
;
8738 * clear set-uid and set-gid bits. POSIX only requires this for
8739 * non-privileged processes but we do it even for root.
8741 if (VATTR_IS_ACTIVE(vap
, va_mode
)) {
8742 newmode
= vap
->va_mode
;
8743 } else if (VATTR_IS_SUPPORTED(&ova
, va_mode
)) {
8744 newmode
= ova
.va_mode
;
8746 KAUTH_DEBUG("CHOWN - trying to change owner but cannot get mode from filesystem to mask setugid bits");
8750 /* chown always clears setuid/gid bits. An exception is made for
8751 * setattrlist executed by a root process to set <uid, gid, mode> on a file:
8752 * setattrlist is allowed to set the new mode on the file and change (chown)
8755 if (newmode
& (S_ISUID
| S_ISGID
)) {
8756 if (!VATTR_IS_ACTIVE(vap
, va_mode
) || !has_priv_suser
) {
8757 KAUTH_DEBUG("CHOWN - masking setugid bits from mode %o to %o",
8758 newmode
, newmode
& ~(S_ISUID
| S_ISGID
));
8759 newmode
&= ~(S_ISUID
| S_ISGID
);
8761 VATTR_SET(vap
, va_mode
, newmode
);
8766 * Authorise changes in the ACL.
8768 if (VATTR_IS_ACTIVE(vap
, va_acl
)) {
8770 /* no existing ACL */
8771 if (!VATTR_IS_ACTIVE(&ova
, va_acl
) || (ova
.va_acl
== NULL
)) {
8774 if (vap
->va_acl
!= NULL
) {
8775 required_action
|= KAUTH_VNODE_WRITE_SECURITY
;
8776 KAUTH_DEBUG("CHMOD - adding ACL");
8779 /* removing an existing ACL */
8780 } else if (vap
->va_acl
== NULL
) {
8781 required_action
|= KAUTH_VNODE_WRITE_SECURITY
;
8782 KAUTH_DEBUG("CHMOD - removing ACL");
8784 /* updating an existing ACL */
8786 if (vap
->va_acl
->acl_entrycount
!= ova
.va_acl
->acl_entrycount
) {
8787 /* entry count changed, must be different */
8788 required_action
|= KAUTH_VNODE_WRITE_SECURITY
;
8789 KAUTH_DEBUG("CHMOD - adding/removing ACL entries");
8790 } else if (vap
->va_acl
->acl_entrycount
> 0) {
8791 /* both ACLs have the same ACE count, said count is 1 or more, bitwise compare ACLs */
8792 if (memcmp(&vap
->va_acl
->acl_ace
[0], &ova
.va_acl
->acl_ace
[0],
8793 sizeof(struct kauth_ace
) * vap
->va_acl
->acl_entrycount
)) {
8794 required_action
|= KAUTH_VNODE_WRITE_SECURITY
;
8795 KAUTH_DEBUG("CHMOD - changing ACL entries");
8802 * Other attributes that require authorisation.
8804 if (VATTR_IS_ACTIVE(vap
, va_encoding
))
8805 required_action
|= KAUTH_VNODE_WRITE_ATTRIBUTES
;
8808 if (VATTR_IS_SUPPORTED(&ova
, va_acl
) && (ova
.va_acl
!= NULL
))
8809 kauth_acl_free(ova
.va_acl
);
8811 *actionp
= required_action
;
8816 setlocklocal_callback(struct vnode
*vp
, __unused
void *cargs
)
8818 vnode_lock_spin(vp
);
8819 vp
->v_flag
|= VLOCKLOCAL
;
8822 return (VNODE_RETURNED
);
8826 vfs_setlocklocal(mount_t mp
)
8828 mount_lock_spin(mp
);
8829 mp
->mnt_kern_flag
|= MNTK_LOCK_LOCAL
;
8833 * The number of active vnodes is expected to be
8834 * very small when vfs_setlocklocal is invoked.
8836 vnode_iterate(mp
, 0, setlocklocal_callback
, NULL
);
8840 vfs_setcompoundopen(mount_t mp
)
8842 mount_lock_spin(mp
);
8843 mp
->mnt_compound_ops
|= COMPOUND_VNOP_OPEN
;
8848 vnode_setswapmount(vnode_t vp
)
8850 mount_lock(vp
->v_mount
);
8851 vp
->v_mount
->mnt_kern_flag
|= MNTK_SWAP_MOUNT
;
8852 mount_unlock(vp
->v_mount
);
8857 vnode_getswappin_avail(vnode_t vp
)
8859 int64_t max_swappin_avail
= 0;
8861 mount_lock(vp
->v_mount
);
8862 if (vp
->v_mount
->mnt_ioflags
& MNT_IOFLAGS_SWAPPIN_SUPPORTED
)
8863 max_swappin_avail
= vp
->v_mount
->mnt_max_swappin_available
;
8864 mount_unlock(vp
->v_mount
);
8866 return (max_swappin_avail
);
8871 vn_setunionwait(vnode_t vp
)
8873 vnode_lock_spin(vp
);
8874 vp
->v_flag
|= VISUNION
;
8880 vn_checkunionwait(vnode_t vp
)
8882 vnode_lock_spin(vp
);
8883 while ((vp
->v_flag
& VISUNION
) == VISUNION
)
8884 msleep((caddr_t
)&vp
->v_flag
, &vp
->v_lock
, 0, 0, 0);
8889 vn_clearunionwait(vnode_t vp
, int locked
)
8892 vnode_lock_spin(vp
);
8893 if((vp
->v_flag
& VISUNION
) == VISUNION
) {
8894 vp
->v_flag
&= ~VISUNION
;
8895 wakeup((caddr_t
)&vp
->v_flag
);
8902 * Removes orphaned apple double files during a rmdir
8904 * 1. vnode_suspend().
8905 * 2. Call VNOP_READDIR() till the end of directory is reached.
8906 * 3. Check if the directory entries returned are regular files with name starting with "._". If not, return ENOTEMPTY.
8907 * 4. Continue (2) and (3) till end of directory is reached.
8908 * 5. If all the entries in the directory were files with "._" name, delete all the files.
8910 * 7. If deletion of all files succeeded, call VNOP_RMDIR() again.
8913 errno_t
rmdir_remove_orphaned_appleDouble(vnode_t vp
, vfs_context_t ctx
, int * restart_flag
)
8916 #define UIO_BUFF_SIZE 2048
8918 int eofflag
, siz
= UIO_BUFF_SIZE
, nentries
= 0;
8919 int open_flag
= 0, full_erase_flag
= 0;
8920 char uio_buf
[ UIO_SIZEOF(1) ];
8927 error
= vnode_suspend(vp
);
8930 * restart_flag is set so that the calling rmdir sleeps and resets
8940 MALLOC(rbuf
, caddr_t
, siz
, M_TEMP
, M_WAITOK
);
8942 auio
= uio_createwithbuffer(1, 0, UIO_SYSSPACE
, UIO_READ
,
8943 &uio_buf
[0], sizeof(uio_buf
));
8944 if (!rbuf
|| !auio
) {
8949 uio_setoffset(auio
,0);
8953 if ((error
= VNOP_OPEN(vp
, FREAD
, ctx
)))
8959 * First pass checks if all files are appleDouble files.
8963 siz
= UIO_BUFF_SIZE
;
8964 uio_reset(auio
, uio_offset(auio
), UIO_SYSSPACE
, UIO_READ
);
8965 uio_addiov(auio
, CAST_USER_ADDR_T(rbuf
), UIO_BUFF_SIZE
);
8967 if((error
= VNOP_READDIR(vp
, auio
, 0, &eofflag
, &nentries
, ctx
)))
8970 if (uio_resid(auio
) != 0)
8971 siz
-= uio_resid(auio
);
8974 * Iterate through directory
8976 dir_pos
= (void*) rbuf
;
8977 dir_end
= (void*) (rbuf
+ siz
);
8978 dp
= (struct dirent
*) (dir_pos
);
8980 if (dir_pos
== dir_end
)
8983 while (dir_pos
< dir_end
) {
8985 * Check for . and .. as well as directories
8987 if (dp
->d_ino
!= 0 &&
8988 !((dp
->d_namlen
== 1 && dp
->d_name
[0] == '.') ||
8989 (dp
->d_namlen
== 2 && dp
->d_name
[0] == '.' && dp
->d_name
[1] == '.'))) {
8991 * Check for irregular files and ._ files
8992 * If there is a ._._ file abort the op
8994 if ( dp
->d_namlen
< 2 ||
8995 strncmp(dp
->d_name
,"._",2) ||
8996 (dp
->d_namlen
>= 4 && !strncmp(&(dp
->d_name
[2]), "._",2))) {
9001 dir_pos
= (void*) ((uint8_t*)dir_pos
+ dp
->d_reclen
);
9002 dp
= (struct dirent
*)dir_pos
;
9006 * workaround for HFS/NFS setting eofflag before end of file
9008 if (vp
->v_tag
== VT_HFS
&& nentries
> 2)
9011 if (vp
->v_tag
== VT_NFS
) {
9012 if (eofflag
&& !full_erase_flag
) {
9013 full_erase_flag
= 1;
9015 uio_reset(auio
, 0, UIO_SYSSPACE
, UIO_READ
);
9017 else if (!eofflag
&& full_erase_flag
)
9018 full_erase_flag
= 0;
9023 * If we've made it here all the files in the dir are ._ files.
9024 * We can delete the files even though the node is suspended
9025 * because we are the owner of the file.
9028 uio_reset(auio
, 0, UIO_SYSSPACE
, UIO_READ
);
9030 full_erase_flag
= 0;
9033 siz
= UIO_BUFF_SIZE
;
9034 uio_reset(auio
, uio_offset(auio
), UIO_SYSSPACE
, UIO_READ
);
9035 uio_addiov(auio
, CAST_USER_ADDR_T(rbuf
), UIO_BUFF_SIZE
);
9037 error
= VNOP_READDIR(vp
, auio
, 0, &eofflag
, &nentries
, ctx
);
9042 if (uio_resid(auio
) != 0)
9043 siz
-= uio_resid(auio
);
9046 * Iterate through directory
9048 dir_pos
= (void*) rbuf
;
9049 dir_end
= (void*) (rbuf
+ siz
);
9050 dp
= (struct dirent
*) dir_pos
;
9052 if (dir_pos
== dir_end
)
9055 while (dir_pos
< dir_end
) {
9057 * Check for . and .. as well as directories
9059 if (dp
->d_ino
!= 0 &&
9060 !((dp
->d_namlen
== 1 && dp
->d_name
[0] == '.') ||
9061 (dp
->d_namlen
== 2 && dp
->d_name
[0] == '.' && dp
->d_name
[1] == '.'))
9064 error
= unlink1(ctx
, vp
,
9065 CAST_USER_ADDR_T(dp
->d_name
), UIO_SYSSPACE
,
9066 VNODE_REMOVE_SKIP_NAMESPACE_EVENT
|
9067 VNODE_REMOVE_NO_AUDIT_PATH
);
9069 if (error
&& error
!= ENOENT
) {
9074 dir_pos
= (void*) ((uint8_t*)dir_pos
+ dp
->d_reclen
);
9075 dp
= (struct dirent
*)dir_pos
;
9079 * workaround for HFS/NFS setting eofflag before end of file
9081 if (vp
->v_tag
== VT_HFS
&& nentries
> 2)
9084 if (vp
->v_tag
== VT_NFS
) {
9085 if (eofflag
&& !full_erase_flag
) {
9086 full_erase_flag
= 1;
9088 uio_reset(auio
, 0, UIO_SYSSPACE
, UIO_READ
);
9090 else if (!eofflag
&& full_erase_flag
)
9091 full_erase_flag
= 0;
9101 VNOP_CLOSE(vp
, FREAD
, ctx
);
9116 lock_vnode_and_post(vnode_t vp
, int kevent_num
)
9118 /* Only take the lock if there's something there! */
9119 if (vp
->v_knotes
.slh_first
!= NULL
) {
9121 KNOTE(&vp
->v_knotes
, kevent_num
);
9126 void panic_print_vnodes(void);
9128 /* define PANIC_PRINTS_VNODES only if investigation is required. */
9129 #ifdef PANIC_PRINTS_VNODES
9131 static const char *__vtype(uint16_t vtype
)
9160 * build a path from the bottom up
9161 * NOTE: called from the panic path - no alloc'ing of memory and no locks!
9163 static char *__vpath(vnode_t vp
, char *str
, int len
, int depth
)
9171 /* str + len is the start of the string we created */
9175 /* follow mount vnodes to get the full path */
9176 if ((vp
->v_flag
& VROOT
)) {
9177 if (vp
->v_mount
!= NULL
&& vp
->v_mount
->mnt_vnodecovered
) {
9178 return __vpath(vp
->v_mount
->mnt_vnodecovered
,
9185 vnm_len
= strlen(src
);
9186 if (vnm_len
> len
) {
9187 /* truncate the name to fit in the string */
9188 src
+= (vnm_len
- len
);
9192 /* start from the back and copy just characters (no NULLs) */
9194 /* this will chop off leaf path (file) names */
9196 dst
= str
+ len
- vnm_len
;
9197 memcpy(dst
, src
, vnm_len
);
9203 if (vp
->v_parent
&& len
> 1) {
9204 /* follow parents up the chain */
9207 return __vpath(vp
->v_parent
, str
, len
, depth
+ 1);
9213 #define SANE_VNODE_PRINT_LIMIT 5000
9214 void panic_print_vnodes(void)
9223 paniclog_append_noflush("\n***** VNODES *****\n"
9224 "TYPE UREF ICNT PATH\n");
9226 /* NULL-terminate the path name */
9227 vname
[sizeof(vname
)-1] = '\0';
9230 * iterate all vnodelist items in all mounts (mntlist) -> mnt_vnodelist
9232 TAILQ_FOREACH(mnt
, &mountlist
, mnt_list
) {
9234 if (!ml_validate_nofault((vm_offset_t
)mnt
, sizeof(mount_t
))) {
9235 paniclog_append_noflush("Unable to iterate the mount list %p - encountered an invalid mount pointer %p \n",
9240 TAILQ_FOREACH(vp
, &mnt
->mnt_vnodelist
, v_mntvnodes
) {
9242 if (!ml_validate_nofault((vm_offset_t
)vp
, sizeof(vnode_t
))) {
9243 paniclog_append_noflush("Unable to iterate the vnode list %p - encountered an invalid vnode pointer %p \n",
9244 &mnt
->mnt_vnodelist
, vp
);
9248 if (++nvnodes
> SANE_VNODE_PRINT_LIMIT
)
9250 type
= __vtype(vp
->v_type
);
9251 nm
= __vpath(vp
, vname
, sizeof(vname
)-1, 0);
9252 paniclog_append_noflush("%s %0d %0d %s\n",
9253 type
, vp
->v_usecount
, vp
->v_iocount
, nm
);
9258 #else /* !PANIC_PRINTS_VNODES */
9259 void panic_print_vnodes(void)
9267 static void record_vp(vnode_t vp
, int count
) {
9274 if ((vp
->v_flag
& VSYSTEM
))
9277 ut
= get_bsdthread_info(current_thread());
9278 ut
->uu_iocount
+= count
;
9281 if (ut
->uu_vpindex
< 32) {
9282 OSBacktrace((void **)&ut
->uu_pcs
[ut
->uu_vpindex
][0], 10);
9284 ut
->uu_vps
[ut
->uu_vpindex
] = vp
;
9294 #define TRIG_DEBUG 0
9297 #define TRIG_LOG(...) do { printf("%s: ", __FUNCTION__); printf(__VA_ARGS__); } while (0)
9299 #define TRIG_LOG(...)
9303 * Resolver result functions
9307 vfs_resolver_result(uint32_t seq
, enum resolver_status stat
, int aux
)
9310 * |<--- 32 --->|<--- 28 --->|<- 4 ->|
9311 * sequence auxiliary status
9313 return (((uint64_t)seq
) << 32) |
9314 (((uint64_t)(aux
& 0x0fffffff)) << 4) |
9315 (uint64_t)(stat
& 0x0000000F);
9318 enum resolver_status
9319 vfs_resolver_status(resolver_result_t result
)
9321 /* lower 4 bits is status */
9322 return (result
& 0x0000000F);
9326 vfs_resolver_sequence(resolver_result_t result
)
9328 /* upper 32 bits is sequence */
9329 return (uint32_t)(result
>> 32);
9333 vfs_resolver_auxiliary(resolver_result_t result
)
9335 /* 28 bits of auxiliary */
9336 return (int)(((uint32_t)(result
& 0xFFFFFFF0)) >> 4);
9341 * Call in for resolvers to update vnode trigger state
9344 vnode_trigger_update(vnode_t vp
, resolver_result_t result
)
9348 enum resolver_status stat
;
9350 if (vp
->v_resolve
== NULL
) {
9354 stat
= vfs_resolver_status(result
);
9355 seq
= vfs_resolver_sequence(result
);
9357 if ((stat
!= RESOLVER_RESOLVED
) && (stat
!= RESOLVER_UNRESOLVED
)) {
9362 lck_mtx_lock(&rp
->vr_lock
);
9364 if (seq
> rp
->vr_lastseq
) {
9365 if (stat
== RESOLVER_RESOLVED
)
9366 rp
->vr_flags
|= VNT_RESOLVED
;
9368 rp
->vr_flags
&= ~VNT_RESOLVED
;
9370 rp
->vr_lastseq
= seq
;
9373 lck_mtx_unlock(&rp
->vr_lock
);
9379 vnode_resolver_attach(vnode_t vp
, vnode_resolve_t rp
, boolean_t ref
)
9383 vnode_lock_spin(vp
);
9384 if (vp
->v_resolve
!= NULL
) {
9393 error
= vnode_ref_ext(vp
, O_EVTONLY
, VNODE_REF_FORCE
);
9395 panic("VNODE_REF_FORCE didn't help...");
9403 * VFS internal interfaces for vnode triggers
9405 * vnode must already have an io count on entry
9406 * v_resolve is stable when io count is non-zero
9409 vnode_resolver_create(mount_t mp
, vnode_t vp
, struct vnode_trigger_param
*tinfo
, boolean_t external
)
9416 /* minimum pointer test (debugging) */
9417 if (tinfo
->vnt_data
)
9418 byte
= *((char *)tinfo
->vnt_data
);
9420 MALLOC(rp
, vnode_resolve_t
, sizeof(*rp
), M_TEMP
, M_WAITOK
);
9424 lck_mtx_init(&rp
->vr_lock
, trigger_vnode_lck_grp
, trigger_vnode_lck_attr
);
9426 rp
->vr_resolve_func
= tinfo
->vnt_resolve_func
;
9427 rp
->vr_unresolve_func
= tinfo
->vnt_unresolve_func
;
9428 rp
->vr_rearm_func
= tinfo
->vnt_rearm_func
;
9429 rp
->vr_reclaim_func
= tinfo
->vnt_reclaim_func
;
9430 rp
->vr_data
= tinfo
->vnt_data
;
9432 rp
->vr_flags
= tinfo
->vnt_flags
& VNT_VALID_MASK
;
9434 rp
->vr_flags
|= VNT_EXTERNAL
;
9437 result
= vnode_resolver_attach(vp
, rp
, external
);
9443 OSAddAtomic(1, &mp
->mnt_numtriggers
);
9454 vnode_resolver_release(vnode_resolve_t rp
)
9457 * Give them a chance to free any private data
9459 if (rp
->vr_data
&& rp
->vr_reclaim_func
) {
9460 rp
->vr_reclaim_func(NULLVP
, rp
->vr_data
);
9463 lck_mtx_destroy(&rp
->vr_lock
, trigger_vnode_lck_grp
);
9468 /* Called after the vnode has been drained */
9470 vnode_resolver_detach(vnode_t vp
)
9475 mp
= vnode_mount(vp
);
9479 vp
->v_resolve
= NULL
;
9482 if ((rp
->vr_flags
& VNT_EXTERNAL
) != 0) {
9483 vnode_rele_ext(vp
, O_EVTONLY
, 1);
9486 vnode_resolver_release(rp
);
9488 /* Keep count of active trigger vnodes per mount */
9489 OSAddAtomic(-1, &mp
->mnt_numtriggers
);
9494 vnode_trigger_rearm(vnode_t vp
, vfs_context_t ctx
)
9497 resolver_result_t result
;
9498 enum resolver_status status
;
9501 if ((vp
->v_resolve
== NULL
) ||
9502 (vp
->v_resolve
->vr_rearm_func
== NULL
) ||
9503 (vp
->v_resolve
->vr_flags
& VNT_AUTO_REARM
) == 0) {
9508 lck_mtx_lock(&rp
->vr_lock
);
9511 * Check if VFS initiated this unmount. If so, we'll catch it after the unresolve completes.
9513 if (rp
->vr_flags
& VNT_VFS_UNMOUNTED
) {
9514 lck_mtx_unlock(&rp
->vr_lock
);
9518 /* Check if this vnode is already armed */
9519 if ((rp
->vr_flags
& VNT_RESOLVED
) == 0) {
9520 lck_mtx_unlock(&rp
->vr_lock
);
9524 lck_mtx_unlock(&rp
->vr_lock
);
9526 result
= rp
->vr_rearm_func(vp
, 0, rp
->vr_data
, ctx
);
9527 status
= vfs_resolver_status(result
);
9528 seq
= vfs_resolver_sequence(result
);
9530 lck_mtx_lock(&rp
->vr_lock
);
9531 if (seq
> rp
->vr_lastseq
) {
9532 if (status
== RESOLVER_UNRESOLVED
)
9533 rp
->vr_flags
&= ~VNT_RESOLVED
;
9534 rp
->vr_lastseq
= seq
;
9536 lck_mtx_unlock(&rp
->vr_lock
);
9541 vnode_trigger_resolve(vnode_t vp
, struct nameidata
*ndp
, vfs_context_t ctx
)
9544 enum path_operation op
;
9545 resolver_result_t result
;
9546 enum resolver_status status
;
9549 /* Only trigger on topmost vnodes */
9550 if ((vp
->v_resolve
== NULL
) ||
9551 (vp
->v_resolve
->vr_resolve_func
== NULL
) ||
9552 (vp
->v_mountedhere
!= NULL
)) {
9557 lck_mtx_lock(&rp
->vr_lock
);
9559 /* Check if this vnode is already resolved */
9560 if (rp
->vr_flags
& VNT_RESOLVED
) {
9561 lck_mtx_unlock(&rp
->vr_lock
);
9565 lck_mtx_unlock(&rp
->vr_lock
);
9568 int rv
= mac_vnode_check_trigger_resolve(ctx
, vp
, &ndp
->ni_cnd
);
9575 * assumes that resolver will not access this trigger vnode (otherwise the kernel will deadlock)
9576 * is there anyway to know this???
9577 * there can also be other legitimate lookups in parallel
9579 * XXX - should we call this on a separate thread with a timeout?
9581 * XXX - should we use ISLASTCN to pick the op value??? Perhaps only leafs should
9582 * get the richer set and non-leafs should get generic OP_LOOKUP? TBD
9584 op
= (ndp
->ni_op
< OP_MAXOP
) ? ndp
->ni_op
: OP_LOOKUP
;
9586 result
= rp
->vr_resolve_func(vp
, &ndp
->ni_cnd
, op
, 0, rp
->vr_data
, ctx
);
9587 status
= vfs_resolver_status(result
);
9588 seq
= vfs_resolver_sequence(result
);
9590 lck_mtx_lock(&rp
->vr_lock
);
9591 if (seq
> rp
->vr_lastseq
) {
9592 if (status
== RESOLVER_RESOLVED
)
9593 rp
->vr_flags
|= VNT_RESOLVED
;
9594 rp
->vr_lastseq
= seq
;
9596 lck_mtx_unlock(&rp
->vr_lock
);
9598 /* On resolver errors, propagate the error back up */
9599 return (status
== RESOLVER_ERROR
? vfs_resolver_auxiliary(result
) : 0);
9603 vnode_trigger_unresolve(vnode_t vp
, int flags
, vfs_context_t ctx
)
9606 resolver_result_t result
;
9607 enum resolver_status status
;
9610 if ((vp
->v_resolve
== NULL
) || (vp
->v_resolve
->vr_unresolve_func
== NULL
)) {
9615 lck_mtx_lock(&rp
->vr_lock
);
9617 /* Check if this vnode is already resolved */
9618 if ((rp
->vr_flags
& VNT_RESOLVED
) == 0) {
9619 printf("vnode_trigger_unresolve: not currently resolved\n");
9620 lck_mtx_unlock(&rp
->vr_lock
);
9624 rp
->vr_flags
|= VNT_VFS_UNMOUNTED
;
9626 lck_mtx_unlock(&rp
->vr_lock
);
9630 * assumes that resolver will not access this trigger vnode (otherwise the kernel will deadlock)
9631 * there can also be other legitimate lookups in parallel
9633 * XXX - should we call this on a separate thread with a timeout?
9636 result
= rp
->vr_unresolve_func(vp
, flags
, rp
->vr_data
, ctx
);
9637 status
= vfs_resolver_status(result
);
9638 seq
= vfs_resolver_sequence(result
);
9640 lck_mtx_lock(&rp
->vr_lock
);
9641 if (seq
> rp
->vr_lastseq
) {
9642 if (status
== RESOLVER_UNRESOLVED
)
9643 rp
->vr_flags
&= ~VNT_RESOLVED
;
9644 rp
->vr_lastseq
= seq
;
9646 rp
->vr_flags
&= ~VNT_VFS_UNMOUNTED
;
9647 lck_mtx_unlock(&rp
->vr_lock
);
9649 /* On resolver errors, propagate the error back up */
9650 return (status
== RESOLVER_ERROR
? vfs_resolver_auxiliary(result
) : 0);
9654 triggerisdescendant(mount_t mp
, mount_t rmp
)
9659 * walk up vnode covered chain looking for a match
9661 name_cache_lock_shared();
9666 /* did we encounter "/" ? */
9667 if (mp
->mnt_flag
& MNT_ROOTFS
)
9670 vp
= mp
->mnt_vnodecovered
;
9681 name_cache_unlock();
9686 struct trigger_unmount_info
{
9691 uint32_t trigger_vid
;
9696 trigger_unmount_callback(mount_t mp
, void * arg
)
9698 struct trigger_unmount_info
* infop
= (struct trigger_unmount_info
*)arg
;
9699 boolean_t mountedtrigger
= FALSE
;
9702 * When we encounter the top level mount we're done
9704 if (mp
== infop
->top_mp
)
9705 return (VFS_RETURNED_DONE
);
9707 if ((mp
->mnt_vnodecovered
== NULL
) ||
9708 (vnode_getwithref(mp
->mnt_vnodecovered
) != 0)) {
9709 return (VFS_RETURNED
);
9712 if ((mp
->mnt_vnodecovered
->v_mountedhere
== mp
) &&
9713 (mp
->mnt_vnodecovered
->v_resolve
!= NULL
) &&
9714 (mp
->mnt_vnodecovered
->v_resolve
->vr_flags
& VNT_RESOLVED
)) {
9715 mountedtrigger
= TRUE
;
9717 vnode_put(mp
->mnt_vnodecovered
);
9720 * When we encounter a mounted trigger, check if its under the top level mount
9722 if ( !mountedtrigger
|| !triggerisdescendant(mp
, infop
->top_mp
) )
9723 return (VFS_RETURNED
);
9726 * Process any pending nested mount (now that its not referenced)
9728 if ((infop
->trigger_vp
!= NULLVP
) &&
9729 (vnode_getwithvid(infop
->trigger_vp
, infop
->trigger_vid
) == 0)) {
9730 vnode_t vp
= infop
->trigger_vp
;
9733 infop
->trigger_vp
= NULLVP
;
9735 if (mp
== vp
->v_mountedhere
) {
9737 printf("trigger_unmount_callback: unexpected match '%s'\n",
9738 mp
->mnt_vfsstat
.f_mntonname
);
9739 return (VFS_RETURNED
);
9741 if (infop
->trigger_mp
!= vp
->v_mountedhere
) {
9743 printf("trigger_unmount_callback: trigger mnt changed! (%p != %p)\n",
9744 infop
->trigger_mp
, vp
->v_mountedhere
);
9748 error
= vnode_trigger_unresolve(vp
, infop
->flags
, infop
->ctx
);
9751 printf("unresolving: '%s', err %d\n",
9752 vp
->v_mountedhere
? vp
->v_mountedhere
->mnt_vfsstat
.f_mntonname
:
9754 return (VFS_RETURNED_DONE
); /* stop iteration on errors */
9759 * We can't call resolver here since we hold a mount iter
9760 * ref on mp so save its covered vp for later processing
9762 infop
->trigger_vp
= mp
->mnt_vnodecovered
;
9763 if ((infop
->trigger_vp
!= NULLVP
) &&
9764 (vnode_getwithref(infop
->trigger_vp
) == 0)) {
9765 if (infop
->trigger_vp
->v_mountedhere
== mp
) {
9766 infop
->trigger_vid
= infop
->trigger_vp
->v_id
;
9767 infop
->trigger_mp
= mp
;
9769 vnode_put(infop
->trigger_vp
);
9772 return (VFS_RETURNED
);
9776 * Attempt to unmount any trigger mounts nested underneath a mount.
9777 * This is a best effort attempt and no retries are performed here.
9779 * Note: mp->mnt_rwlock is held exclusively on entry (so be carefull)
9783 vfs_nested_trigger_unmounts(mount_t mp
, int flags
, vfs_context_t ctx
)
9785 struct trigger_unmount_info info
;
9787 /* Must have trigger vnodes */
9788 if (mp
->mnt_numtriggers
== 0) {
9791 /* Avoid recursive requests (by checking covered vnode) */
9792 if ((mp
->mnt_vnodecovered
!= NULL
) &&
9793 (vnode_getwithref(mp
->mnt_vnodecovered
) == 0)) {
9794 boolean_t recursive
= FALSE
;
9796 if ((mp
->mnt_vnodecovered
->v_mountedhere
== mp
) &&
9797 (mp
->mnt_vnodecovered
->v_resolve
!= NULL
) &&
9798 (mp
->mnt_vnodecovered
->v_resolve
->vr_flags
& VNT_VFS_UNMOUNTED
)) {
9801 vnode_put(mp
->mnt_vnodecovered
);
9807 * Attempt to unmount any nested trigger mounts (best effort)
9811 info
.trigger_vp
= NULLVP
;
9812 info
.trigger_vid
= 0;
9813 info
.trigger_mp
= NULL
;
9816 (void) vfs_iterate(VFS_ITERATE_TAIL_FIRST
, trigger_unmount_callback
, &info
);
9819 * Process remaining nested mount (now that its not referenced)
9821 if ((info
.trigger_vp
!= NULLVP
) &&
9822 (vnode_getwithvid(info
.trigger_vp
, info
.trigger_vid
) == 0)) {
9823 vnode_t vp
= info
.trigger_vp
;
9825 if (info
.trigger_mp
== vp
->v_mountedhere
) {
9826 (void) vnode_trigger_unresolve(vp
, flags
, ctx
);
9833 vfs_addtrigger(mount_t mp
, const char *relpath
, struct vnode_trigger_info
*vtip
, vfs_context_t ctx
)
9835 struct nameidata nd
;
9838 struct vnode_trigger_param vtp
;
9841 * Must be called for trigger callback, wherein rwlock is held
9843 lck_rw_assert(&mp
->mnt_rwlock
, LCK_RW_ASSERT_HELD
);
9845 TRIG_LOG("Adding trigger at %s\n", relpath
);
9846 TRIG_LOG("Trying VFS_ROOT\n");
9849 * We do a lookup starting at the root of the mountpoint, unwilling
9850 * to cross into other mountpoints.
9852 res
= VFS_ROOT(mp
, &rvp
, ctx
);
9857 TRIG_LOG("Trying namei\n");
9859 NDINIT(&nd
, LOOKUP
, OP_LOOKUP
, USEDVP
| NOCROSSMOUNT
| FOLLOW
, UIO_SYSSPACE
,
9860 CAST_USER_ADDR_T(relpath
), ctx
);
9872 TRIG_LOG("Trying vnode_resolver_create()\n");
9875 * Set up blob. vnode_create() takes a larger structure
9876 * with creation info, and we needed something different
9877 * for this case. One needs to win, or we need to munge both;
9878 * vnode_create() wins.
9880 bzero(&vtp
, sizeof(vtp
));
9881 vtp
.vnt_resolve_func
= vtip
->vti_resolve_func
;
9882 vtp
.vnt_unresolve_func
= vtip
->vti_unresolve_func
;
9883 vtp
.vnt_rearm_func
= vtip
->vti_rearm_func
;
9884 vtp
.vnt_reclaim_func
= vtip
->vti_reclaim_func
;
9885 vtp
.vnt_reclaim_func
= vtip
->vti_reclaim_func
;
9886 vtp
.vnt_data
= vtip
->vti_data
;
9887 vtp
.vnt_flags
= vtip
->vti_flags
;
9889 res
= vnode_resolver_create(mp
, vp
, &vtp
, TRUE
);
9892 TRIG_LOG("Returning %d\n", res
);
9896 #endif /* CONFIG_TRIGGERS */
9898 vm_offset_t
kdebug_vnode(vnode_t vp
)
9900 return VM_KERNEL_ADDRPERM(vp
);
9903 static int flush_cache_on_write
= 0;
9904 SYSCTL_INT (_kern
, OID_AUTO
, flush_cache_on_write
,
9905 CTLFLAG_RW
| CTLFLAG_LOCKED
, &flush_cache_on_write
, 0,
9906 "always flush the drive cache on writes to uncached files");
9908 int vnode_should_flush_after_write(vnode_t vp
, int ioflag
)
9910 return (flush_cache_on_write
9911 && (ISSET(ioflag
, IO_NOCACHE
) || vnode_isnocache(vp
)));
9915 * sysctl for use by disk I/O tracing tools to get the list of existing
9919 struct vnode_trace_paths_context
{
9921 long path
[MAXPATHLEN
/ sizeof (long) + 1]; /* + 1 in case sizeof (long) does not divide MAXPATHLEN */
9924 static int vnode_trace_path_callback(struct vnode
*vp
, void *arg
) {
9926 struct vnode_trace_paths_context
*ctx
;
9930 len
= sizeof (ctx
->path
);
9931 rv
= vn_getpath(vp
, (char *)ctx
->path
, &len
);
9932 /* vn_getpath() NUL-terminates, and len includes the NUL */
9935 kdebug_vfs_lookup(ctx
->path
, len
, vp
,
9936 KDBG_VFS_LOOKUP_FLAG_LOOKUP
| KDBG_VFS_LOOKUP_FLAG_NOPROCFILT
);
9938 if (++(ctx
->count
) == 1000) {
9939 thread_yield_to_preemption();
9944 return VNODE_RETURNED
;
9947 static int vfs_trace_paths_callback(mount_t mp
, void *arg
) {
9948 if (mp
->mnt_flag
& MNT_LOCAL
)
9949 vnode_iterate(mp
, VNODE_ITERATE_ALL
, vnode_trace_path_callback
, arg
);
9951 return VFS_RETURNED
;
9954 static int sysctl_vfs_trace_paths SYSCTL_HANDLER_ARGS
{
9955 struct vnode_trace_paths_context ctx
;
9962 if (!kauth_cred_issuser(kauth_cred_get()))
9965 if (!kdebug_enable
|| !kdebug_debugid_enabled(VFS_LOOKUP
))
9968 bzero(&ctx
, sizeof (struct vnode_trace_paths_context
));
9970 vfs_iterate(0, vfs_trace_paths_callback
, &ctx
);
9975 SYSCTL_PROC(_vfs_generic
, OID_AUTO
, trace_paths
, CTLFLAG_RD
| CTLFLAG_LOCKED
| CTLFLAG_MASKED
, NULL
, 0, &sysctl_vfs_trace_paths
, "-", "trace_paths");