2 * Copyright (c) 2000-2016 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/spl.h>
114 #include <machine/machine_routines.h>
116 #include <kern/assert.h>
117 #include <mach/kern_return.h>
118 #include <kern/thread.h>
119 #include <kern/sched_prim.h>
121 #include <miscfs/specfs/specdev.h>
123 #include <mach/mach_types.h>
124 #include <mach/memory_object_types.h>
125 #include <mach/memory_object_control.h>
127 #include <kern/kalloc.h> /* kalloc()/kfree() */
128 #include <kern/clock.h> /* delay_for_interval() */
129 #include <libkern/OSAtomic.h> /* OSAddAtomic() */
130 #include <console/video_console.h>
133 #include <libkern/OSDebug.h>
136 #include <vm/vm_protos.h> /* vnode_pager_vrele() */
139 #include <security/mac_framework.h>
142 extern lck_grp_t
*vnode_lck_grp
;
143 extern lck_attr_t
*vnode_lck_attr
;
146 extern lck_grp_t
*trigger_vnode_lck_grp
;
147 extern lck_attr_t
*trigger_vnode_lck_attr
;
150 extern lck_mtx_t
* mnt_list_mtx_lock
;
152 enum vtype iftovt_tab
[16] = {
153 VNON
, VFIFO
, VCHR
, VNON
, VDIR
, VNON
, VBLK
, VNON
,
154 VREG
, VNON
, VLNK
, VNON
, VSOCK
, VNON
, VNON
, VBAD
,
156 int vttoif_tab
[9] = {
157 0, S_IFREG
, S_IFDIR
, S_IFBLK
, S_IFCHR
, S_IFLNK
,
158 S_IFSOCK
, S_IFIFO
, S_IFMT
,
162 /* XXX These should be in a BSD accessible Mach header, but aren't. */
163 extern void memory_object_mark_used(
164 memory_object_control_t control
);
166 extern void memory_object_mark_unused(
167 memory_object_control_t control
,
170 extern void memory_object_mark_io_tracking(
171 memory_object_control_t control
);
173 /* XXX next protptype should be from <nfs/nfs.h> */
174 extern int nfs_vinvalbuf(vnode_t
, int, vfs_context_t
, int);
176 /* XXX next prototytype should be from libsa/stdlib.h> but conflicts libkern */
177 __private_extern__
void qsort(
181 int (*)(const void *, const void *));
183 extern kern_return_t
adjust_vm_object_cache(vm_size_t oval
, vm_size_t nval
);
184 __private_extern__
void vntblinit(void);
185 __private_extern__ kern_return_t
reset_vmobjectcache(unsigned int val1
,
187 __private_extern__
int unlink1(vfs_context_t
, vnode_t
, user_addr_t
,
190 extern int system_inshutdown
;
192 static void vnode_list_add(vnode_t
);
193 static void vnode_async_list_add(vnode_t
);
194 static void vnode_list_remove(vnode_t
);
195 static void vnode_list_remove_locked(vnode_t
);
197 static void vnode_abort_advlocks(vnode_t
);
198 static errno_t
vnode_drain(vnode_t
);
199 static void vgone(vnode_t
, int flags
);
200 static void vclean(vnode_t vp
, int flag
);
201 static void vnode_reclaim_internal(vnode_t
, int, int, int);
203 static void vnode_dropiocount (vnode_t
);
205 static vnode_t
checkalias(vnode_t vp
, dev_t nvp_rdev
);
206 static int vnode_reload(vnode_t
);
207 static int vnode_isinuse_locked(vnode_t
, int, int);
209 static int unmount_callback(mount_t
, __unused
void *);
211 static void insmntque(vnode_t vp
, mount_t mp
);
212 static int mount_getvfscnt(void);
213 static int mount_fillfsids(fsid_t
*, int );
214 static void vnode_iterate_setup(mount_t
);
215 int vnode_umount_preflight(mount_t
, vnode_t
, int);
216 static int vnode_iterate_prepare(mount_t
);
217 static int vnode_iterate_reloadq(mount_t
);
218 static void vnode_iterate_clear(mount_t
);
219 static mount_t
vfs_getvfs_locked(fsid_t
*);
220 static int vn_create_reg(vnode_t dvp
, vnode_t
*vpp
, struct nameidata
*ndp
,
221 struct vnode_attr
*vap
, uint32_t flags
, int fmode
, uint32_t *statusp
, vfs_context_t ctx
);
222 static int vnode_authattr_new_internal(vnode_t dvp
, struct vnode_attr
*vap
, int noauth
, uint32_t *defaulted_fieldsp
, vfs_context_t ctx
);
224 errno_t
rmdir_remove_orphaned_appleDouble(vnode_t
, vfs_context_t
, int *);
227 static void record_vp(vnode_t vp
, int count
);
230 #if CONFIG_JETSAM && (DEVELOPMENT || DEBUG)
231 extern int bootarg_no_vnode_jetsam
; /* from bsd_init.c default value is 0 */
232 #endif /* CONFIG_JETSAM && (DEVELOPMENT || DEBUG) */
234 boolean_t root_is_CF_drive
= FALSE
;
237 static int vnode_resolver_create(mount_t
, vnode_t
, struct vnode_trigger_param
*, boolean_t external
);
238 static void vnode_resolver_detach(vnode_t
);
241 TAILQ_HEAD(freelst
, vnode
) vnode_free_list
; /* vnode free list */
242 TAILQ_HEAD(deadlst
, vnode
) vnode_dead_list
; /* vnode dead list */
243 TAILQ_HEAD(async_work_lst
, vnode
) vnode_async_work_list
;
246 TAILQ_HEAD(ragelst
, vnode
) vnode_rage_list
; /* vnode rapid age list */
247 struct timeval rage_tv
;
251 #define RAGE_LIMIT_MIN 100
252 #define RAGE_TIME_LIMIT 5
254 struct mntlist mountlist
; /* mounted filesystem list */
255 static int nummounts
= 0;
258 #define VLISTCHECK(fun, vp, list) \
259 if ((vp)->v_freelist.tqe_prev == (struct vnode **)0xdeadb) \
260 panic("%s: %s vnode not on %slist", (fun), (list), (list));
262 #define VLISTCHECK(fun, vp, list)
263 #endif /* DIAGNOSTIC */
265 #define VLISTNONE(vp) \
267 (vp)->v_freelist.tqe_next = (struct vnode *)0; \
268 (vp)->v_freelist.tqe_prev = (struct vnode **)0xdeadb; \
271 #define VONLIST(vp) \
272 ((vp)->v_freelist.tqe_prev != (struct vnode **)0xdeadb)
274 /* remove a vnode from free vnode list */
275 #define VREMFREE(fun, vp) \
277 VLISTCHECK((fun), (vp), "free"); \
278 TAILQ_REMOVE(&vnode_free_list, (vp), v_freelist); \
284 /* remove a vnode from dead vnode list */
285 #define VREMDEAD(fun, vp) \
287 VLISTCHECK((fun), (vp), "dead"); \
288 TAILQ_REMOVE(&vnode_dead_list, (vp), v_freelist); \
290 vp->v_listflag &= ~VLIST_DEAD; \
295 /* remove a vnode from async work vnode list */
296 #define VREMASYNC_WORK(fun, vp) \
298 VLISTCHECK((fun), (vp), "async_work"); \
299 TAILQ_REMOVE(&vnode_async_work_list, (vp), v_freelist); \
301 vp->v_listflag &= ~VLIST_ASYNC_WORK; \
302 async_work_vnodes--; \
306 /* remove a vnode from rage vnode list */
307 #define VREMRAGE(fun, vp) \
309 if ( !(vp->v_listflag & VLIST_RAGE)) \
310 panic("VREMRAGE: vp not on rage list"); \
311 VLISTCHECK((fun), (vp), "rage"); \
312 TAILQ_REMOVE(&vnode_rage_list, (vp), v_freelist); \
314 vp->v_listflag &= ~VLIST_RAGE; \
320 * vnodetarget hasn't been used in a long time, but
321 * it was exported for some reason... I'm leaving in
322 * place for now... it should be deprecated out of the
323 * exports and removed eventually.
325 u_int32_t vnodetarget
; /* target for vnreclaim() */
326 #define VNODE_FREE_TARGET 20 /* Default value for vnodetarget */
329 * We need quite a few vnodes on the free list to sustain the
330 * rapid stat() the compilation process does, and still benefit from the name
331 * cache. Having too few vnodes on the free list causes serious disk
332 * thrashing as we cycle through them.
334 #define VNODE_FREE_MIN CONFIG_VNODE_FREE_MIN /* freelist should have at least this many */
337 static void async_work_continue(void);
340 * Initialize the vnode management data structures.
342 __private_extern__
void
345 thread_t thread
= THREAD_NULL
;
347 TAILQ_INIT(&vnode_free_list
);
348 TAILQ_INIT(&vnode_rage_list
);
349 TAILQ_INIT(&vnode_dead_list
);
350 TAILQ_INIT(&vnode_async_work_list
);
351 TAILQ_INIT(&mountlist
);
354 vnodetarget
= VNODE_FREE_TARGET
;
356 microuptime(&rage_tv
);
357 rage_limit
= desiredvnodes
/ 100;
359 if (rage_limit
< RAGE_LIMIT_MIN
)
360 rage_limit
= RAGE_LIMIT_MIN
;
363 * Scale the vm_object_cache to accomodate the vnodes
366 (void) adjust_vm_object_cache(0, desiredvnodes
- VNODE_FREE_MIN
);
369 * create worker threads
371 kernel_thread_start((thread_continue_t
)async_work_continue
, NULL
, &thread
);
372 thread_deallocate(thread
);
375 /* Reset the VM Object Cache with the values passed in */
376 __private_extern__ kern_return_t
377 reset_vmobjectcache(unsigned int val1
, unsigned int val2
)
379 vm_size_t oval
= val1
- VNODE_FREE_MIN
;
386 if(val2
< VNODE_FREE_MIN
)
389 nval
= val2
- VNODE_FREE_MIN
;
391 return(adjust_vm_object_cache(oval
, nval
));
395 /* the timeout is in 10 msecs */
397 vnode_waitforwrites(vnode_t vp
, int output_target
, int slpflag
, int slptimeout
, const char *msg
) {
401 KERNEL_DEBUG(0x3010280 | DBG_FUNC_START
, (int)vp
, output_target
, vp
->v_numoutput
, 0, 0);
403 if (vp
->v_numoutput
> output_target
) {
409 while ((vp
->v_numoutput
> output_target
) && error
== 0) {
411 vp
->v_flag
|= VTHROTTLED
;
413 vp
->v_flag
|= VBWAIT
;
415 ts
.tv_sec
= (slptimeout
/100);
416 ts
.tv_nsec
= (slptimeout
% 1000) * 10 * NSEC_PER_USEC
* 1000 ;
417 error
= msleep((caddr_t
)&vp
->v_numoutput
, &vp
->v_lock
, (slpflag
| (PRIBIO
+ 1)), msg
, &ts
);
423 KERNEL_DEBUG(0x3010280 | DBG_FUNC_END
, (int)vp
, output_target
, vp
->v_numoutput
, error
, 0);
430 vnode_startwrite(vnode_t vp
) {
432 OSAddAtomic(1, &vp
->v_numoutput
);
437 vnode_writedone(vnode_t vp
)
442 OSAddAtomic(-1, &vp
->v_numoutput
);
446 if (vp
->v_numoutput
< 0)
447 panic("vnode_writedone: numoutput < 0");
449 if ((vp
->v_flag
& VTHROTTLED
)) {
450 vp
->v_flag
&= ~VTHROTTLED
;
453 if ((vp
->v_flag
& VBWAIT
) && (vp
->v_numoutput
== 0)) {
454 vp
->v_flag
&= ~VBWAIT
;
460 wakeup((caddr_t
)&vp
->v_numoutput
);
467 vnode_hasdirtyblks(vnode_t vp
)
469 struct cl_writebehind
*wbp
;
472 * Not taking the buf_mtxp as there is little
473 * point doing it. Even if the lock is taken the
474 * state can change right after that. If their
475 * needs to be a synchronization, it must be driven
478 if (vp
->v_dirtyblkhd
.lh_first
)
481 if (!UBCINFOEXISTS(vp
))
484 wbp
= vp
->v_ubcinfo
->cl_wbehind
;
486 if (wbp
&& (wbp
->cl_number
|| wbp
->cl_scmap
))
493 vnode_hascleanblks(vnode_t vp
)
496 * Not taking the buf_mtxp as there is little
497 * point doing it. Even if the lock is taken the
498 * state can change right after that. If their
499 * needs to be a synchronization, it must be driven
502 if (vp
->v_cleanblkhd
.lh_first
)
508 vnode_iterate_setup(mount_t mp
)
510 mp
->mnt_lflag
|= MNT_LITER
;
514 vnode_umount_preflight(mount_t mp
, vnode_t skipvp
, int flags
)
518 TAILQ_FOREACH(vp
, &mp
->mnt_vnodelist
, v_mntvnodes
) {
519 if (vp
->v_type
== VDIR
)
523 if ((flags
& SKIPSYSTEM
) && ((vp
->v_flag
& VSYSTEM
) || (vp
->v_flag
& VNOFLUSH
)))
525 if ((flags
& SKIPSWAP
) && (vp
->v_flag
& VSWAP
))
527 if ((flags
& WRITECLOSE
) && (vp
->v_writecount
== 0 || vp
->v_type
!= VREG
))
530 /* Look for busy vnode */
531 if ((vp
->v_usecount
!= 0) && ((vp
->v_usecount
- vp
->v_kusecount
) != 0)) {
534 } else if (vp
->v_iocount
> 0) {
535 /* Busy if iocount is > 0 for more than 3 seconds */
536 tsleep(&vp
->v_iocount
, PVFS
, "vnode_drain_network", 3 * hz
);
537 if (vp
->v_iocount
> 0)
547 * This routine prepares iteration by moving all the vnodes to worker queue
548 * called with mount lock held
551 vnode_iterate_prepare(mount_t mp
)
555 if (TAILQ_EMPTY(&mp
->mnt_vnodelist
)) {
560 vp
= TAILQ_FIRST(&mp
->mnt_vnodelist
);
561 vp
->v_mntvnodes
.tqe_prev
= &(mp
->mnt_workerqueue
.tqh_first
);
562 mp
->mnt_workerqueue
.tqh_first
= mp
->mnt_vnodelist
.tqh_first
;
563 mp
->mnt_workerqueue
.tqh_last
= mp
->mnt_vnodelist
.tqh_last
;
565 TAILQ_INIT(&mp
->mnt_vnodelist
);
566 if (mp
->mnt_newvnodes
.tqh_first
!= NULL
)
567 panic("vnode_iterate_prepare: newvnode when entering vnode");
568 TAILQ_INIT(&mp
->mnt_newvnodes
);
574 /* called with mount lock held */
576 vnode_iterate_reloadq(mount_t mp
)
580 /* add the remaining entries in workerq to the end of mount vnode list */
581 if (!TAILQ_EMPTY(&mp
->mnt_workerqueue
)) {
583 mvp
= TAILQ_LAST(&mp
->mnt_vnodelist
, vnodelst
);
585 /* Joining the workerque entities to mount vnode list */
587 mvp
->v_mntvnodes
.tqe_next
= mp
->mnt_workerqueue
.tqh_first
;
589 mp
->mnt_vnodelist
.tqh_first
= mp
->mnt_workerqueue
.tqh_first
;
590 mp
->mnt_workerqueue
.tqh_first
->v_mntvnodes
.tqe_prev
= mp
->mnt_vnodelist
.tqh_last
;
591 mp
->mnt_vnodelist
.tqh_last
= mp
->mnt_workerqueue
.tqh_last
;
592 TAILQ_INIT(&mp
->mnt_workerqueue
);
595 /* add the newvnodes to the head of mount vnode list */
596 if (!TAILQ_EMPTY(&mp
->mnt_newvnodes
)) {
598 nlvp
= TAILQ_LAST(&mp
->mnt_newvnodes
, vnodelst
);
600 mp
->mnt_newvnodes
.tqh_first
->v_mntvnodes
.tqe_prev
= &mp
->mnt_vnodelist
.tqh_first
;
601 nlvp
->v_mntvnodes
.tqe_next
= mp
->mnt_vnodelist
.tqh_first
;
602 if(mp
->mnt_vnodelist
.tqh_first
)
603 mp
->mnt_vnodelist
.tqh_first
->v_mntvnodes
.tqe_prev
= &nlvp
->v_mntvnodes
.tqe_next
;
605 mp
->mnt_vnodelist
.tqh_last
= mp
->mnt_newvnodes
.tqh_last
;
606 mp
->mnt_vnodelist
.tqh_first
= mp
->mnt_newvnodes
.tqh_first
;
607 TAILQ_INIT(&mp
->mnt_newvnodes
);
616 vnode_iterate_clear(mount_t mp
)
618 mp
->mnt_lflag
&= ~MNT_LITER
;
622 #include <i386/panic_hooks.h>
624 struct vnode_iterate_panic_hook
{
630 static void vnode_iterate_panic_hook(panic_hook_t
*hook_
)
632 extern int kdb_log(const char *fmt
, ...);
633 struct vnode_iterate_panic_hook
*hook
= (struct vnode_iterate_panic_hook
*)hook_
;
634 panic_phys_range_t range
;
637 if (panic_phys_range_before(hook
->mp
, &phys
, &range
)) {
638 kdb_log("mp = %p, phys = %p, prev (%p: %p-%p)\n",
639 hook
->mp
, phys
, range
.type
, range
.phys_start
,
640 range
.phys_start
+ range
.len
);
642 kdb_log("mp = %p, phys = %p, prev (!)\n", hook
->mp
, phys
);
645 if (panic_phys_range_before(hook
->vp
, &phys
, &range
)) {
646 kdb_log("vp = %p, phys = %p, prev (%p: %p-%p)\n",
647 hook
->vp
, phys
, range
.type
, range
.phys_start
,
648 range
.phys_start
+ range
.len
);
650 kdb_log("vp = %p, phys = %p, prev (!)\n", hook
->vp
, phys
);
652 panic_dump_mem((void *)(((vm_offset_t
)hook
->mp
-4096) & ~4095), 12288);
656 vnode_iterate(mount_t mp
, int flags
, int (*callout
)(struct vnode
*, void *),
664 * The mount iterate mutex is held for the duration of the iteration.
665 * This can be done by a state flag on the mount structure but we can
666 * run into priority inversion issues sometimes.
667 * Using a mutex allows us to benefit from the priority donation
668 * mechanisms in the kernel for locks. This mutex should never be
669 * acquired in spin mode and it should be acquired before attempting to
670 * acquire the mount lock.
672 mount_iterate_lock(mp
);
676 vnode_iterate_setup(mp
);
678 /* If it returns 0 then there is nothing to do */
679 retval
= vnode_iterate_prepare(mp
);
682 vnode_iterate_clear(mp
);
684 mount_iterate_unlock(mp
);
688 struct vnode_iterate_panic_hook hook
;
691 panic_hook(&hook
.hook
, vnode_iterate_panic_hook
);
692 /* iterate over all the vnodes */
693 while (!TAILQ_EMPTY(&mp
->mnt_workerqueue
)) {
694 vp
= TAILQ_FIRST(&mp
->mnt_workerqueue
);
696 TAILQ_REMOVE(&mp
->mnt_workerqueue
, vp
, v_mntvnodes
);
697 TAILQ_INSERT_TAIL(&mp
->mnt_vnodelist
, vp
, v_mntvnodes
);
699 if ((vp
->v_data
== NULL
) || (vp
->v_type
== VNON
) || (vp
->v_mount
!= mp
)) {
704 if ( vget_internal(vp
, vid
, (flags
| VNODE_NODEAD
| VNODE_WITHID
| VNODE_NOSUSPEND
))) {
708 if (flags
& VNODE_RELOAD
) {
710 * we're reloading the filesystem
711 * cast out any inactive vnodes...
713 if (vnode_reload(vp
)) {
714 /* vnode will be recycled on the refcount drop */
721 retval
= callout(vp
, arg
);
725 case VNODE_RETURNED_DONE
:
727 if (retval
== VNODE_RETURNED_DONE
) {
734 case VNODE_CLAIMED_DONE
:
746 panic_unhook(&hook
.hook
);
747 (void)vnode_iterate_reloadq(mp
);
748 vnode_iterate_clear(mp
);
750 mount_iterate_unlock(mp
);
755 mount_lock_renames(mount_t mp
)
757 lck_mtx_lock(&mp
->mnt_renamelock
);
761 mount_unlock_renames(mount_t mp
)
763 lck_mtx_unlock(&mp
->mnt_renamelock
);
767 mount_iterate_lock(mount_t mp
)
769 lck_mtx_lock(&mp
->mnt_iter_lock
);
773 mount_iterate_unlock(mount_t mp
)
775 lck_mtx_unlock(&mp
->mnt_iter_lock
);
779 mount_lock(mount_t mp
)
781 lck_mtx_lock(&mp
->mnt_mlock
);
785 mount_lock_spin(mount_t mp
)
787 lck_mtx_lock_spin(&mp
->mnt_mlock
);
791 mount_unlock(mount_t mp
)
793 lck_mtx_unlock(&mp
->mnt_mlock
);
798 mount_ref(mount_t mp
, int locked
)
811 mount_drop(mount_t mp
, int locked
)
818 if (mp
->mnt_count
== 0 && (mp
->mnt_lflag
& MNT_LDRAIN
))
819 wakeup(&mp
->mnt_lflag
);
827 mount_iterref(mount_t mp
, int locked
)
833 if (mp
->mnt_iterref
< 0) {
844 mount_isdrained(mount_t mp
, int locked
)
850 if (mp
->mnt_iterref
< 0)
860 mount_iterdrop(mount_t mp
)
864 wakeup(&mp
->mnt_iterref
);
869 mount_iterdrain(mount_t mp
)
872 while (mp
->mnt_iterref
)
873 msleep((caddr_t
)&mp
->mnt_iterref
, mnt_list_mtx_lock
, PVFS
, "mount_iterdrain", NULL
);
874 /* mount iterations drained */
875 mp
->mnt_iterref
= -1;
879 mount_iterreset(mount_t mp
)
882 if (mp
->mnt_iterref
== -1)
887 /* always called with mount lock held */
889 mount_refdrain(mount_t mp
)
891 if (mp
->mnt_lflag
& MNT_LDRAIN
)
892 panic("already in drain");
893 mp
->mnt_lflag
|= MNT_LDRAIN
;
895 while (mp
->mnt_count
)
896 msleep((caddr_t
)&mp
->mnt_lflag
, &mp
->mnt_mlock
, PVFS
, "mount_drain", NULL
);
898 if (mp
->mnt_vnodelist
.tqh_first
!= NULL
)
899 panic("mount_refdrain: dangling vnode");
901 mp
->mnt_lflag
&= ~MNT_LDRAIN
;
906 /* Tags the mount point as not supportine extended readdir for NFS exports */
908 mount_set_noreaddirext(mount_t mp
) {
910 mp
->mnt_kern_flag
|= MNTK_DENY_READDIREXT
;
915 * Mark a mount point as busy. Used to synchronize access and to delay
919 vfs_busy(mount_t mp
, int flags
)
923 if (mp
->mnt_lflag
& MNT_LDEAD
)
928 if (mp
->mnt_lflag
& MNT_LUNMOUNT
) {
929 if (flags
& LK_NOWAIT
|| mp
->mnt_lflag
& MNT_LDEAD
) {
935 * Since all busy locks are shared except the exclusive
936 * lock granted when unmounting, the only place that a
937 * wakeup needs to be done is at the release of the
938 * exclusive lock at the end of dounmount.
940 mp
->mnt_lflag
|= MNT_LWAIT
;
941 msleep((caddr_t
)mp
, &mp
->mnt_mlock
, (PVFS
| PDROP
), "vfsbusy", NULL
);
947 lck_rw_lock_shared(&mp
->mnt_rwlock
);
950 * Until we are granted the rwlock, it's possible for the mount point to
951 * change state, so re-evaluate before granting the vfs_busy.
953 if (mp
->mnt_lflag
& (MNT_LDEAD
| MNT_LUNMOUNT
)) {
954 lck_rw_done(&mp
->mnt_rwlock
);
961 * Free a busy filesystem.
964 vfs_unbusy(mount_t mp
)
966 lck_rw_done(&mp
->mnt_rwlock
);
972 vfs_rootmountfailed(mount_t mp
) {
975 mp
->mnt_vtable
->vfc_refcount
--;
980 mount_lock_destroy(mp
);
983 mac_mount_label_destroy(mp
);
986 FREE_ZONE(mp
, sizeof(struct mount
), M_MOUNT
);
990 * Lookup a filesystem type, and if found allocate and initialize
991 * a mount structure for it.
993 * Devname is usually updated by mount(8) after booting.
996 vfs_rootmountalloc_internal(struct vfstable
*vfsp
, const char *devname
)
1000 mp
= _MALLOC_ZONE(sizeof(struct mount
), M_MOUNT
, M_WAITOK
);
1001 bzero((char *)mp
, sizeof(struct mount
));
1003 /* Initialize the default IO constraints */
1004 mp
->mnt_maxreadcnt
= mp
->mnt_maxwritecnt
= MAXPHYS
;
1005 mp
->mnt_segreadcnt
= mp
->mnt_segwritecnt
= 32;
1006 mp
->mnt_maxsegreadsize
= mp
->mnt_maxreadcnt
;
1007 mp
->mnt_maxsegwritesize
= mp
->mnt_maxwritecnt
;
1008 mp
->mnt_devblocksize
= DEV_BSIZE
;
1009 mp
->mnt_alignmentmask
= PAGE_MASK
;
1010 mp
->mnt_ioqueue_depth
= MNT_DEFAULT_IOQUEUE_DEPTH
;
1011 mp
->mnt_ioscale
= 1;
1012 mp
->mnt_ioflags
= 0;
1013 mp
->mnt_realrootvp
= NULLVP
;
1014 mp
->mnt_authcache_ttl
= CACHED_LOOKUP_RIGHT_TTL
;
1015 mp
->mnt_throttle_mask
= LOWPRI_MAX_NUM_DEV
- 1;
1016 mp
->mnt_devbsdunit
= 0;
1018 mount_lock_init(mp
);
1019 (void)vfs_busy(mp
, LK_NOWAIT
);
1021 TAILQ_INIT(&mp
->mnt_vnodelist
);
1022 TAILQ_INIT(&mp
->mnt_workerqueue
);
1023 TAILQ_INIT(&mp
->mnt_newvnodes
);
1025 mp
->mnt_vtable
= vfsp
;
1026 mp
->mnt_op
= vfsp
->vfc_vfsops
;
1027 mp
->mnt_flag
= MNT_RDONLY
| MNT_ROOTFS
;
1028 mp
->mnt_vnodecovered
= NULLVP
;
1029 //mp->mnt_stat.f_type = vfsp->vfc_typenum;
1030 mp
->mnt_flag
|= vfsp
->vfc_flags
& MNT_VISFLAGMASK
;
1033 vfsp
->vfc_refcount
++;
1034 mount_list_unlock();
1036 strlcpy(mp
->mnt_vfsstat
.f_fstypename
, vfsp
->vfc_name
, MFSTYPENAMELEN
);
1037 mp
->mnt_vfsstat
.f_mntonname
[0] = '/';
1038 /* XXX const poisoning layering violation */
1039 (void) copystr((const void *)devname
, mp
->mnt_vfsstat
.f_mntfromname
, MAXPATHLEN
- 1, NULL
);
1042 mac_mount_label_init(mp
);
1043 mac_mount_label_associate(vfs_context_kernel(), mp
);
1049 vfs_rootmountalloc(const char *fstypename
, const char *devname
, mount_t
*mpp
)
1051 struct vfstable
*vfsp
;
1053 for (vfsp
= vfsconf
; vfsp
; vfsp
= vfsp
->vfc_next
)
1054 if (!strncmp(vfsp
->vfc_name
, fstypename
,
1055 sizeof(vfsp
->vfc_name
)))
1060 *mpp
= vfs_rootmountalloc_internal(vfsp
, devname
);
1070 * Find an appropriate filesystem to use for the root. If a filesystem
1071 * has not been preselected, walk through the list of known filesystems
1072 * trying those that have mountroot routines, and try them until one
1073 * works or we have tried them all.
1075 extern int (*mountroot
)(void);
1083 struct vfstable
*vfsp
;
1084 vfs_context_t ctx
= vfs_context_kernel();
1085 struct vfs_attr vfsattr
;
1088 vnode_t bdevvp_rootvp
;
1090 if (mountroot
!= NULL
) {
1092 * used for netboot which follows a different set of rules
1094 error
= (*mountroot
)();
1097 if ((error
= bdevvp(rootdev
, &rootvp
))) {
1098 printf("vfs_mountroot: can't setup bdevvp\n");
1102 * 4951998 - code we call in vfc_mountroot may replace rootvp
1103 * so keep a local copy for some house keeping.
1105 bdevvp_rootvp
= rootvp
;
1107 for (vfsp
= vfsconf
; vfsp
; vfsp
= vfsp
->vfc_next
) {
1108 if (vfsp
->vfc_mountroot
== NULL
1109 && !ISSET(vfsp
->vfc_vfsflags
, VFC_VFSCANMOUNTROOT
)) {
1113 mp
= vfs_rootmountalloc_internal(vfsp
, "root_device");
1114 mp
->mnt_devvp
= rootvp
;
1116 if (vfsp
->vfc_mountroot
)
1117 error
= (*vfsp
->vfc_mountroot
)(mp
, rootvp
, ctx
);
1119 error
= VFS_MOUNT(mp
, rootvp
, 0, ctx
);
1122 if ( bdevvp_rootvp
!= rootvp
) {
1125 * bump the iocount and fix up mnt_devvp for the
1126 * new rootvp (it will already have a usecount taken)...
1127 * drop the iocount and the usecount on the orignal
1128 * since we are no longer going to use it...
1130 vnode_getwithref(rootvp
);
1131 mp
->mnt_devvp
= rootvp
;
1133 vnode_rele(bdevvp_rootvp
);
1134 vnode_put(bdevvp_rootvp
);
1136 mp
->mnt_devvp
->v_specflags
|= SI_MOUNTEDON
;
1143 * cache the IO attributes for the underlying physical media...
1144 * an error return indicates the underlying driver doesn't
1145 * support all the queries necessary... however, reasonable
1146 * defaults will have been set, so no reason to bail or care
1148 vfs_init_io_attributes(rootvp
, mp
);
1150 if (mp
->mnt_ioflags
& MNT_IOFLAGS_FUSION_DRIVE
) {
1151 root_is_CF_drive
= TRUE
;
1155 * Shadow the VFC_VFSNATIVEXATTR flag to MNTK_EXTENDED_ATTRS.
1157 if (mp
->mnt_vtable
->vfc_vfsflags
& VFC_VFSNATIVEXATTR
) {
1158 mp
->mnt_kern_flag
|= MNTK_EXTENDED_ATTRS
;
1160 if (mp
->mnt_vtable
->vfc_vfsflags
& VFC_VFSPREFLIGHT
) {
1161 mp
->mnt_kern_flag
|= MNTK_UNMOUNT_PREFLIGHT
;
1166 if (MNTK_VIRTUALDEV
& mp
->mnt_kern_flag
) speed
= 128;
1167 else if (MNTK_SSD
& mp
->mnt_kern_flag
) speed
= 7*256;
1169 vc_progress_setdiskspeed(speed
);
1171 * Probe root file system for additional features.
1173 (void)VFS_START(mp
, 0, ctx
);
1175 VFSATTR_INIT(&vfsattr
);
1176 VFSATTR_WANTED(&vfsattr
, f_capabilities
);
1177 if (vfs_getattr(mp
, &vfsattr
, ctx
) == 0 &&
1178 VFSATTR_IS_SUPPORTED(&vfsattr
, f_capabilities
)) {
1179 if ((vfsattr
.f_capabilities
.capabilities
[VOL_CAPABILITIES_INTERFACES
] & VOL_CAP_INT_EXTENDED_ATTR
) &&
1180 (vfsattr
.f_capabilities
.valid
[VOL_CAPABILITIES_INTERFACES
] & VOL_CAP_INT_EXTENDED_ATTR
)) {
1181 mp
->mnt_kern_flag
|= MNTK_EXTENDED_ATTRS
;
1184 if ((vfsattr
.f_capabilities
.capabilities
[VOL_CAPABILITIES_INTERFACES
] & VOL_CAP_INT_NAMEDSTREAMS
) &&
1185 (vfsattr
.f_capabilities
.valid
[VOL_CAPABILITIES_INTERFACES
] & VOL_CAP_INT_NAMEDSTREAMS
)) {
1186 mp
->mnt_kern_flag
|= MNTK_NAMED_STREAMS
;
1189 if ((vfsattr
.f_capabilities
.capabilities
[VOL_CAPABILITIES_FORMAT
] & VOL_CAP_FMT_PATH_FROM_ID
) &&
1190 (vfsattr
.f_capabilities
.valid
[VOL_CAPABILITIES_FORMAT
] & VOL_CAP_FMT_PATH_FROM_ID
)) {
1191 mp
->mnt_kern_flag
|= MNTK_PATH_FROM_ID
;
1194 if ((vfsattr
.f_capabilities
.capabilities
[VOL_CAPABILITIES_FORMAT
] & VOL_CAP_FMT_DIR_HARDLINKS
) &&
1195 (vfsattr
.f_capabilities
.valid
[VOL_CAPABILITIES_FORMAT
] & VOL_CAP_FMT_DIR_HARDLINKS
)) {
1196 mp
->mnt_kern_flag
|= MNTK_DIR_HARDLINKS
;
1201 * get rid of iocount reference returned
1202 * by bdevvp (or picked up by us on the substitued
1203 * rootvp)... it (or we) will have also taken
1204 * a usecount reference which we want to keep
1209 if ((vfs_flags(mp
) & MNT_MULTILABEL
) == 0)
1212 error
= VFS_ROOT(mp
, &vp
, ctx
);
1214 printf("%s() VFS_ROOT() returned %d\n",
1216 dounmount(mp
, MNT_FORCE
, 0, ctx
);
1219 error
= vnode_label(mp
, NULL
, vp
, NULL
, 0, ctx
);
1221 * get rid of reference provided by VFS_ROOT
1226 printf("%s() vnode_label() returned %d\n",
1228 dounmount(mp
, MNT_FORCE
, 0, ctx
);
1237 vfs_rootmountfailed(mp
);
1239 if (error
!= EINVAL
)
1240 printf("%s_mountroot failed: %d\n", vfsp
->vfc_name
, error
);
1246 * Lookup a mount point by filesystem identifier.
1250 vfs_getvfs(fsid_t
*fsid
)
1252 return (mount_list_lookupby_fsid(fsid
, 0, 0));
1255 static struct mount
*
1256 vfs_getvfs_locked(fsid_t
*fsid
)
1258 return(mount_list_lookupby_fsid(fsid
, 1, 0));
1262 vfs_getvfs_by_mntonname(char *path
)
1264 mount_t retmp
= (mount_t
)0;
1268 TAILQ_FOREACH(mp
, &mountlist
, mnt_list
) {
1269 if (!strncmp(mp
->mnt_vfsstat
.f_mntonname
, path
,
1270 sizeof(mp
->mnt_vfsstat
.f_mntonname
))) {
1272 if (mount_iterref(retmp
, 1))
1278 mount_list_unlock();
1282 /* generation number for creation of new fsids */
1283 u_short mntid_gen
= 0;
1285 * Get a new unique fsid
1288 vfs_getnewfsid(struct mount
*mp
)
1296 /* generate a new fsid */
1297 mtype
= mp
->mnt_vtable
->vfc_typenum
;
1298 if (++mntid_gen
== 0)
1300 tfsid
.val
[0] = makedev(nblkdev
+ mtype
, mntid_gen
);
1301 tfsid
.val
[1] = mtype
;
1303 while (vfs_getvfs_locked(&tfsid
)) {
1304 if (++mntid_gen
== 0)
1306 tfsid
.val
[0] = makedev(nblkdev
+ mtype
, mntid_gen
);
1309 mp
->mnt_vfsstat
.f_fsid
.val
[0] = tfsid
.val
[0];
1310 mp
->mnt_vfsstat
.f_fsid
.val
[1] = tfsid
.val
[1];
1311 mount_list_unlock();
1315 * Routines having to do with the management of the vnode table.
1317 extern int (**dead_vnodeop_p
)(void *);
1318 long numvnodes
, freevnodes
, deadvnodes
, async_work_vnodes
;
1321 int async_work_timed_out
= 0;
1322 int async_work_handled
= 0;
1323 int dead_vnode_wanted
= 0;
1324 int dead_vnode_waited
= 0;
1327 * Move a vnode from one mount queue to another.
1330 insmntque(vnode_t vp
, mount_t mp
)
1334 * Delete from old mount point vnode list, if on one.
1336 if ( (lmp
= vp
->v_mount
) != NULL
&& lmp
!= dead_mountp
) {
1337 if ((vp
->v_lflag
& VNAMED_MOUNT
) == 0)
1338 panic("insmntque: vp not in mount vnode list");
1339 vp
->v_lflag
&= ~VNAMED_MOUNT
;
1341 mount_lock_spin(lmp
);
1345 if (vp
->v_mntvnodes
.tqe_next
== NULL
) {
1346 if (TAILQ_LAST(&lmp
->mnt_vnodelist
, vnodelst
) == vp
)
1347 TAILQ_REMOVE(&lmp
->mnt_vnodelist
, vp
, v_mntvnodes
);
1348 else if (TAILQ_LAST(&lmp
->mnt_newvnodes
, vnodelst
) == vp
)
1349 TAILQ_REMOVE(&lmp
->mnt_newvnodes
, vp
, v_mntvnodes
);
1350 else if (TAILQ_LAST(&lmp
->mnt_workerqueue
, vnodelst
) == vp
)
1351 TAILQ_REMOVE(&lmp
->mnt_workerqueue
, vp
, v_mntvnodes
);
1353 vp
->v_mntvnodes
.tqe_next
->v_mntvnodes
.tqe_prev
= vp
->v_mntvnodes
.tqe_prev
;
1354 *vp
->v_mntvnodes
.tqe_prev
= vp
->v_mntvnodes
.tqe_next
;
1356 vp
->v_mntvnodes
.tqe_next
= NULL
;
1357 vp
->v_mntvnodes
.tqe_prev
= NULL
;
1363 * Insert into list of vnodes for the new mount point, if available.
1365 if ((vp
->v_mount
= mp
) != NULL
) {
1366 mount_lock_spin(mp
);
1367 if ((vp
->v_mntvnodes
.tqe_next
!= 0) && (vp
->v_mntvnodes
.tqe_prev
!= 0))
1368 panic("vp already in mount list");
1369 if (mp
->mnt_lflag
& MNT_LITER
)
1370 TAILQ_INSERT_HEAD(&mp
->mnt_newvnodes
, vp
, v_mntvnodes
);
1372 TAILQ_INSERT_HEAD(&mp
->mnt_vnodelist
, vp
, v_mntvnodes
);
1373 if (vp
->v_lflag
& VNAMED_MOUNT
)
1374 panic("insmntque: vp already in mount vnode list");
1375 vp
->v_lflag
|= VNAMED_MOUNT
;
1383 * Create a vnode for a block device.
1384 * Used for root filesystem, argdev, and swap areas.
1385 * Also used for memory file system special devices.
1388 bdevvp(dev_t dev
, vnode_t
*vpp
)
1392 struct vnode_fsparam vfsp
;
1393 struct vfs_context context
;
1400 context
.vc_thread
= current_thread();
1401 context
.vc_ucred
= FSCRED
;
1403 vfsp
.vnfs_mp
= (struct mount
*)0;
1404 vfsp
.vnfs_vtype
= VBLK
;
1405 vfsp
.vnfs_str
= "bdevvp";
1406 vfsp
.vnfs_dvp
= NULL
;
1407 vfsp
.vnfs_fsnode
= NULL
;
1408 vfsp
.vnfs_cnp
= NULL
;
1409 vfsp
.vnfs_vops
= spec_vnodeop_p
;
1410 vfsp
.vnfs_rdev
= dev
;
1411 vfsp
.vnfs_filesize
= 0;
1413 vfsp
.vnfs_flags
= VNFS_NOCACHE
| VNFS_CANTCACHE
;
1415 vfsp
.vnfs_marksystem
= 0;
1416 vfsp
.vnfs_markroot
= 0;
1418 if ( (error
= vnode_create(VNCREATE_FLAVOR
, VCREATESIZE
, &vfsp
, &nvp
)) ) {
1422 vnode_lock_spin(nvp
);
1423 nvp
->v_flag
|= VBDEVVP
;
1424 nvp
->v_tag
= VT_NON
; /* set this to VT_NON so during aliasing it can be replaced */
1426 if ( (error
= vnode_ref(nvp
)) ) {
1427 panic("bdevvp failed: vnode_ref");
1430 if ( (error
= VNOP_FSYNC(nvp
, MNT_WAIT
, &context
)) ) {
1431 panic("bdevvp failed: fsync");
1434 if ( (error
= buf_invalidateblks(nvp
, BUF_WRITE_DATA
, 0, 0)) ) {
1435 panic("bdevvp failed: invalidateblks");
1441 * XXXMAC: We can't put a MAC check here, the system will
1442 * panic without this vnode.
1446 if ( (error
= VNOP_OPEN(nvp
, FREAD
, &context
)) ) {
1447 panic("bdevvp failed: open");
1457 * Check to see if the new vnode represents a special device
1458 * for which we already have a vnode (either because of
1459 * bdevvp() or because of a different vnode representing
1460 * the same block device). If such an alias exists, deallocate
1461 * the existing contents and return the aliased vnode. The
1462 * caller is responsible for filling it with its new contents.
1465 checkalias(struct vnode
*nvp
, dev_t nvp_rdev
)
1469 struct specinfo
*sin
= NULL
;
1472 vpp
= &speclisth
[SPECHASH(nvp_rdev
)];
1476 for (vp
= *vpp
; vp
; vp
= vp
->v_specnext
) {
1477 if (nvp_rdev
== vp
->v_rdev
&& nvp
->v_type
== vp
->v_type
) {
1486 if (vnode_getwithvid(vp
,vid
)) {
1490 * Termination state is checked in vnode_getwithvid
1495 * Alias, but not in use, so flush it out.
1497 if ((vp
->v_iocount
== 1) && (vp
->v_usecount
== 0)) {
1498 vnode_reclaim_internal(vp
, 1, 1, 0);
1499 vnode_put_locked(vp
);
1505 if (vp
== NULL
|| vp
->v_tag
!= VT_NON
) {
1507 MALLOC_ZONE(sin
, struct specinfo
*, sizeof(struct specinfo
),
1508 M_SPECINFO
, M_WAITOK
);
1511 nvp
->v_specinfo
= sin
;
1512 bzero(nvp
->v_specinfo
, sizeof(struct specinfo
));
1513 nvp
->v_rdev
= nvp_rdev
;
1514 nvp
->v_specflags
= 0;
1515 nvp
->v_speclastr
= -1;
1516 nvp
->v_specinfo
->si_opencount
= 0;
1517 nvp
->v_specinfo
->si_initted
= 0;
1518 nvp
->v_specinfo
->si_throttleable
= 0;
1522 /* We dropped the lock, someone could have added */
1524 for (vp
= *vpp
; vp
; vp
= vp
->v_specnext
) {
1525 if (nvp_rdev
== vp
->v_rdev
&& nvp
->v_type
== vp
->v_type
) {
1533 nvp
->v_hashchain
= vpp
;
1534 nvp
->v_specnext
= *vpp
;
1538 nvp
->v_specflags
|= SI_ALIASED
;
1539 vp
->v_specflags
|= SI_ALIASED
;
1541 vnode_put_locked(vp
);
1551 FREE_ZONE(sin
, sizeof(struct specinfo
), M_SPECINFO
);
1554 if ((vp
->v_flag
& (VBDEVVP
| VDEVFLUSH
)) != 0)
1557 panic("checkalias with VT_NON vp that shouldn't: %p", vp
);
1564 * Get a reference on a particular vnode and lock it if requested.
1565 * If the vnode was on the inactive list, remove it from the list.
1566 * If the vnode was on the free list, remove it from the list and
1567 * move it to inactive list as needed.
1568 * The vnode lock bit is set if the vnode is being eliminated in
1569 * vgone. The process is awakened when the transition is completed,
1570 * and an error returned to indicate that the vnode is no longer
1571 * usable (possibly having been changed to a new file system type).
1574 vget_internal(vnode_t vp
, int vid
, int vflags
)
1578 vnode_lock_spin(vp
);
1580 if ((vflags
& VNODE_WRITEABLE
) && (vp
->v_writecount
== 0))
1582 * vnode to be returned only if it has writers opened
1586 error
= vnode_getiocount(vp
, vid
, vflags
);
1594 * Returns: 0 Success
1595 * ENOENT No such file or directory [terminating]
1598 vnode_ref(vnode_t vp
)
1601 return (vnode_ref_ext(vp
, 0, 0));
1605 * Returns: 0 Success
1606 * ENOENT No such file or directory [terminating]
1609 vnode_ref_ext(vnode_t vp
, int fmode
, int flags
)
1613 vnode_lock_spin(vp
);
1616 * once all the current call sites have been fixed to insure they have
1617 * taken an iocount, we can toughen this assert up and insist that the
1618 * iocount is non-zero... a non-zero usecount doesn't insure correctness
1620 if (vp
->v_iocount
<= 0 && vp
->v_usecount
<= 0)
1621 panic("vnode_ref_ext: vp %p has no valid reference %d, %d", vp
, vp
->v_iocount
, vp
->v_usecount
);
1624 * if you are the owner of drain/termination, can acquire usecount
1626 if ((flags
& VNODE_REF_FORCE
) == 0) {
1627 if ((vp
->v_lflag
& (VL_DRAIN
| VL_TERMINATE
| VL_DEAD
))) {
1628 if (vp
->v_owner
!= current_thread()) {
1636 if (fmode
& FWRITE
) {
1637 if (++vp
->v_writecount
<= 0)
1638 panic("vnode_ref_ext: v_writecount");
1640 if (fmode
& O_EVTONLY
) {
1641 if (++vp
->v_kusecount
<= 0)
1642 panic("vnode_ref_ext: v_kusecount");
1644 if (vp
->v_flag
& VRAGE
) {
1647 ut
= get_bsdthread_info(current_thread());
1649 if ( !(current_proc()->p_lflag
& P_LRAGE_VNODES
) &&
1650 !(ut
->uu_flag
& UT_RAGE_VNODES
)) {
1652 * a 'normal' process accessed this vnode
1653 * so make sure its no longer marked
1654 * for rapid aging... also, make sure
1655 * it gets removed from the rage list...
1656 * when v_usecount drops back to 0, it
1657 * will be put back on the real free list
1659 vp
->v_flag
&= ~VRAGE
;
1660 vp
->v_references
= 0;
1661 vnode_list_remove(vp
);
1664 if (vp
->v_usecount
== 1 && vp
->v_type
== VREG
&& !(vp
->v_flag
& VSYSTEM
)) {
1666 if (vp
->v_ubcinfo
) {
1667 vnode_lock_convert(vp
);
1668 memory_object_mark_used(vp
->v_ubcinfo
->ui_control
);
1679 vnode_on_reliable_media(vnode_t vp
)
1681 if ( !(vp
->v_mount
->mnt_kern_flag
& MNTK_VIRTUALDEV
) && (vp
->v_mount
->mnt_flag
& MNT_LOCAL
) )
1687 vnode_async_list_add(vnode_t vp
)
1691 if (VONLIST(vp
) || (vp
->v_lflag
& (VL_TERMINATE
|VL_DEAD
)))
1692 panic("vnode_async_list_add: %p is in wrong state", vp
);
1694 TAILQ_INSERT_HEAD(&vnode_async_work_list
, vp
, v_freelist
);
1695 vp
->v_listflag
|= VLIST_ASYNC_WORK
;
1697 async_work_vnodes
++;
1699 vnode_list_unlock();
1701 wakeup(&vnode_async_work_list
);
1707 * put the vnode on appropriate free list.
1708 * called with vnode LOCKED
1711 vnode_list_add(vnode_t vp
)
1713 boolean_t need_dead_wakeup
= FALSE
;
1716 lck_mtx_assert(&vp
->v_lock
, LCK_MTX_ASSERT_OWNED
);
1722 * if it is already on a list or non zero references return
1724 if (VONLIST(vp
) || (vp
->v_usecount
!= 0) || (vp
->v_iocount
!= 0) || (vp
->v_lflag
& VL_TERMINATE
))
1728 * In vclean, we might have deferred ditching locked buffers
1729 * because something was still referencing them (indicated by
1730 * usecount). We can ditch them now.
1732 if (ISSET(vp
->v_lflag
, VL_DEAD
)
1733 && (!LIST_EMPTY(&vp
->v_cleanblkhd
) || !LIST_EMPTY(&vp
->v_dirtyblkhd
))) {
1734 ++vp
->v_iocount
; // Probably not necessary, but harmless
1739 buf_invalidateblks(vp
, BUF_INVALIDATE_LOCKED
, 0, 0);
1741 vnode_dropiocount(vp
);
1747 if ((vp
->v_flag
& VRAGE
) && !(vp
->v_lflag
& VL_DEAD
)) {
1749 * add the new guy to the appropriate end of the RAGE list
1751 if ((vp
->v_flag
& VAGE
))
1752 TAILQ_INSERT_HEAD(&vnode_rage_list
, vp
, v_freelist
);
1754 TAILQ_INSERT_TAIL(&vnode_rage_list
, vp
, v_freelist
);
1756 vp
->v_listflag
|= VLIST_RAGE
;
1760 * reset the timestamp for the last inserted vp on the RAGE
1761 * queue to let new_vnode know that its not ok to start stealing
1762 * from this list... as long as we're actively adding to this list
1763 * we'll push out the vnodes we want to donate to the real free list
1764 * once we stop pushing, we'll let some time elapse before we start
1765 * stealing them in the new_vnode routine
1767 microuptime(&rage_tv
);
1770 * if VL_DEAD, insert it at head of the dead list
1771 * else insert at tail of LRU list or at head if VAGE is set
1773 if ( (vp
->v_lflag
& VL_DEAD
)) {
1774 TAILQ_INSERT_HEAD(&vnode_dead_list
, vp
, v_freelist
);
1775 vp
->v_listflag
|= VLIST_DEAD
;
1778 if (dead_vnode_wanted
) {
1779 dead_vnode_wanted
--;
1780 need_dead_wakeup
= TRUE
;
1783 } else if ( (vp
->v_flag
& VAGE
) ) {
1784 TAILQ_INSERT_HEAD(&vnode_free_list
, vp
, v_freelist
);
1785 vp
->v_flag
&= ~VAGE
;
1788 TAILQ_INSERT_TAIL(&vnode_free_list
, vp
, v_freelist
);
1792 vnode_list_unlock();
1794 if (need_dead_wakeup
== TRUE
)
1795 wakeup_one((caddr_t
)&dead_vnode_wanted
);
1800 * remove the vnode from appropriate free list.
1801 * called with vnode LOCKED and
1802 * the list lock held
1805 vnode_list_remove_locked(vnode_t vp
)
1809 * the v_listflag field is
1810 * protected by the vnode_list_lock
1812 if (vp
->v_listflag
& VLIST_RAGE
)
1813 VREMRAGE("vnode_list_remove", vp
);
1814 else if (vp
->v_listflag
& VLIST_DEAD
)
1815 VREMDEAD("vnode_list_remove", vp
);
1816 else if (vp
->v_listflag
& VLIST_ASYNC_WORK
)
1817 VREMASYNC_WORK("vnode_list_remove", vp
);
1819 VREMFREE("vnode_list_remove", vp
);
1825 * remove the vnode from appropriate free list.
1826 * called with vnode LOCKED
1829 vnode_list_remove(vnode_t vp
)
1832 lck_mtx_assert(&vp
->v_lock
, LCK_MTX_ASSERT_OWNED
);
1835 * we want to avoid taking the list lock
1836 * in the case where we're not on the free
1837 * list... this will be true for most
1838 * directories and any currently in use files
1840 * we're guaranteed that we can't go from
1841 * the not-on-list state to the on-list
1842 * state since we hold the vnode lock...
1843 * all calls to vnode_list_add are done
1844 * under the vnode lock... so we can
1845 * check for that condition (the prevelant one)
1846 * without taking the list lock
1851 * however, we're not guaranteed that
1852 * we won't go from the on-list state
1853 * to the not-on-list state until we
1854 * hold the vnode_list_lock... this
1855 * is due to "new_vnode" removing vnodes
1856 * from the free list uder the list_lock
1857 * w/o the vnode lock... so we need to
1858 * check again whether we're currently
1861 vnode_list_remove_locked(vp
);
1863 vnode_list_unlock();
1869 vnode_rele(vnode_t vp
)
1871 vnode_rele_internal(vp
, 0, 0, 0);
1876 vnode_rele_ext(vnode_t vp
, int fmode
, int dont_reenter
)
1878 vnode_rele_internal(vp
, fmode
, dont_reenter
, 0);
1883 vnode_rele_internal(vnode_t vp
, int fmode
, int dont_reenter
, int locked
)
1887 vnode_lock_spin(vp
);
1890 lck_mtx_assert(&vp
->v_lock
, LCK_MTX_ASSERT_OWNED
);
1892 if (--vp
->v_usecount
< 0)
1893 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
);
1895 if (fmode
& FWRITE
) {
1896 if (--vp
->v_writecount
< 0)
1897 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
);
1899 if (fmode
& O_EVTONLY
) {
1900 if (--vp
->v_kusecount
< 0)
1901 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
);
1903 if (vp
->v_kusecount
> vp
->v_usecount
)
1904 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
);
1906 if ((vp
->v_iocount
> 0) || (vp
->v_usecount
> 0)) {
1908 * vnode is still busy... if we're the last
1909 * usecount, mark for a future call to VNOP_INACTIVE
1910 * when the iocount finally drops to 0
1912 if (vp
->v_usecount
== 0) {
1913 vp
->v_lflag
|= VL_NEEDINACTIVE
;
1914 vp
->v_flag
&= ~(VNOCACHE_DATA
| VRAOFF
| VOPENEVT
);
1918 vp
->v_flag
&= ~(VNOCACHE_DATA
| VRAOFF
| VOPENEVT
);
1920 if (ISSET(vp
->v_lflag
, VL_TERMINATE
| VL_DEAD
) || dont_reenter
) {
1922 * vnode is being cleaned, or
1923 * we've requested that we don't reenter
1924 * the filesystem on this release...in
1925 * the latter case, we'll mark the vnode aged
1928 if ( !(vp
->v_lflag
& (VL_TERMINATE
| VL_DEAD
| VL_MARKTERM
)) ) {
1929 vp
->v_lflag
|= VL_NEEDINACTIVE
;
1931 if (vnode_on_reliable_media(vp
) == FALSE
|| vp
->v_flag
& VISDIRTY
) {
1932 vnode_async_list_add(vp
);
1943 * at this point both the iocount and usecount
1945 * pick up an iocount so that we can call
1946 * VNOP_INACTIVE with the vnode lock unheld
1952 vp
->v_lflag
&= ~VL_NEEDINACTIVE
;
1955 VNOP_INACTIVE(vp
, vfs_context_current());
1957 vnode_lock_spin(vp
);
1959 * because we dropped the vnode lock to call VNOP_INACTIVE
1960 * the state of the vnode may have changed... we may have
1961 * picked up an iocount, usecount or the MARKTERM may have
1962 * been set... we need to reevaluate the reference counts
1963 * to determine if we can call vnode_reclaim_internal at
1964 * this point... if the reference counts are up, we'll pick
1965 * up the MARKTERM state when they get subsequently dropped
1967 if ( (vp
->v_iocount
== 1) && (vp
->v_usecount
== 0) &&
1968 ((vp
->v_lflag
& (VL_MARKTERM
| VL_TERMINATE
| VL_DEAD
)) == VL_MARKTERM
)) {
1971 ut
= get_bsdthread_info(current_thread());
1973 if (ut
->uu_defer_reclaims
) {
1974 vp
->v_defer_reclaimlist
= ut
->uu_vreclaims
;
1975 ut
->uu_vreclaims
= vp
;
1978 vnode_lock_convert(vp
);
1979 vnode_reclaim_internal(vp
, 1, 1, 0);
1981 vnode_dropiocount(vp
);
1984 if (vp
->v_usecount
== 0 && vp
->v_type
== VREG
&& !(vp
->v_flag
& VSYSTEM
)) {
1986 if (vp
->v_ubcinfo
) {
1987 vnode_lock_convert(vp
);
1988 memory_object_mark_unused(vp
->v_ubcinfo
->ui_control
, (vp
->v_flag
& VRAGE
) == VRAGE
);
1997 * Remove any vnodes in the vnode table belonging to mount point mp.
1999 * If MNT_NOFORCE is specified, there should not be any active ones,
2000 * return error if any are found (nb: this is a user error, not a
2001 * system error). If MNT_FORCE is specified, detach any active vnodes
2005 int busyprt
= 0; /* print out busy vnodes */
2009 vflush(struct mount
*mp
, struct vnode
*skipvp
, int flags
)
2018 * See comments in vnode_iterate() for the rationale for this lock
2020 mount_iterate_lock(mp
);
2023 vnode_iterate_setup(mp
);
2025 * On regular unmounts(not forced) do a
2026 * quick check for vnodes to be in use. This
2027 * preserves the caching of vnodes. automounter
2028 * tries unmounting every so often to see whether
2029 * it is still busy or not.
2031 if (((flags
& FORCECLOSE
)==0) && ((mp
->mnt_kern_flag
& MNTK_UNMOUNT_PREFLIGHT
) != 0)) {
2032 if (vnode_umount_preflight(mp
, skipvp
, flags
)) {
2033 vnode_iterate_clear(mp
);
2035 mount_iterate_unlock(mp
);
2040 /* If it returns 0 then there is nothing to do */
2041 retval
= vnode_iterate_prepare(mp
);
2044 vnode_iterate_clear(mp
);
2046 mount_iterate_unlock(mp
);
2050 /* iterate over all the vnodes */
2051 while (!TAILQ_EMPTY(&mp
->mnt_workerqueue
)) {
2053 vp
= TAILQ_FIRST(&mp
->mnt_workerqueue
);
2054 TAILQ_REMOVE(&mp
->mnt_workerqueue
, vp
, v_mntvnodes
);
2055 TAILQ_INSERT_TAIL(&mp
->mnt_vnodelist
, vp
, v_mntvnodes
);
2057 if ( (vp
->v_mount
!= mp
) || (vp
== skipvp
)) {
2063 vnode_lock_spin(vp
);
2065 // If vnode is already terminating, wait for it...
2066 while (vp
->v_id
== vid
&& ISSET(vp
->v_lflag
, VL_TERMINATE
)) {
2067 vp
->v_lflag
|= VL_TERMWANT
;
2068 msleep(&vp
->v_lflag
, &vp
->v_lock
, PVFS
, "vflush", NULL
);
2071 if ((vp
->v_id
!= vid
) || ISSET(vp
->v_lflag
, VL_DEAD
)) {
2078 * If requested, skip over vnodes marked VSYSTEM.
2079 * Skip over all vnodes marked VNOFLUSH.
2081 if ((flags
& SKIPSYSTEM
) && ((vp
->v_flag
& VSYSTEM
) ||
2082 (vp
->v_flag
& VNOFLUSH
))) {
2088 * If requested, skip over vnodes marked VSWAP.
2090 if ((flags
& SKIPSWAP
) && (vp
->v_flag
& VSWAP
)) {
2096 * If requested, skip over vnodes marked VROOT.
2098 if ((flags
& SKIPROOT
) && (vp
->v_flag
& VROOT
)) {
2104 * If WRITECLOSE is set, only flush out regular file
2105 * vnodes open for writing.
2107 if ((flags
& WRITECLOSE
) &&
2108 (vp
->v_writecount
== 0 || vp
->v_type
!= VREG
)) {
2114 * If the real usecount is 0, all we need to do is clear
2115 * out the vnode data structures and we are done.
2117 if (((vp
->v_usecount
== 0) ||
2118 ((vp
->v_usecount
- vp
->v_kusecount
) == 0))) {
2120 vnode_lock_convert(vp
);
2121 vp
->v_iocount
++; /* so that drain waits for * other iocounts */
2125 vnode_reclaim_internal(vp
, 1, 1, 0);
2126 vnode_dropiocount(vp
);
2135 * If FORCECLOSE is set, forcibly close the vnode.
2136 * For block or character devices, revert to an
2137 * anonymous device. For all other files, just kill them.
2139 if (flags
& FORCECLOSE
) {
2140 vnode_lock_convert(vp
);
2142 if (vp
->v_type
!= VBLK
&& vp
->v_type
!= VCHR
) {
2143 vp
->v_iocount
++; /* so that drain waits * for other iocounts */
2147 vnode_abort_advlocks(vp
);
2148 vnode_reclaim_internal(vp
, 1, 1, 0);
2149 vnode_dropiocount(vp
);
2154 vp
->v_lflag
&= ~VL_DEAD
;
2155 vp
->v_op
= spec_vnodeop_p
;
2156 vp
->v_flag
|= VDEVFLUSH
;
2164 vprint("vflush: busy vnode", vp
);
2171 /* At this point the worker queue is completed */
2172 if (busy
&& ((flags
& FORCECLOSE
)==0) && reclaimed
) {
2175 (void)vnode_iterate_reloadq(mp
);
2176 /* returned with mount lock held */
2180 /* if new vnodes were created in between retry the reclaim */
2181 if ( vnode_iterate_reloadq(mp
) != 0) {
2182 if (!(busy
&& ((flags
& FORCECLOSE
)==0)))
2185 vnode_iterate_clear(mp
);
2187 mount_iterate_unlock(mp
);
2189 if (busy
&& ((flags
& FORCECLOSE
)==0))
2194 long num_recycledvnodes
= 0;
2196 * Disassociate the underlying file system from a vnode.
2197 * The vnode lock is held on entry.
2200 vclean(vnode_t vp
, int flags
)
2202 vfs_context_t ctx
= vfs_context_current();
2205 int already_terminating
;
2212 * Check to see if the vnode is in use.
2213 * If so we have to reference it before we clean it out
2214 * so that its count cannot fall to zero and generate a
2215 * race against ourselves to recycle it.
2217 active
= vp
->v_usecount
;
2220 * just in case we missed sending a needed
2221 * VNOP_INACTIVE, we'll do it now
2223 need_inactive
= (vp
->v_lflag
& VL_NEEDINACTIVE
);
2225 vp
->v_lflag
&= ~VL_NEEDINACTIVE
;
2228 * Prevent the vnode from being recycled or
2229 * brought into use while we clean it out.
2231 already_terminating
= (vp
->v_lflag
& VL_TERMINATE
);
2233 vp
->v_lflag
|= VL_TERMINATE
;
2236 is_namedstream
= vnode_isnamedstream(vp
);
2241 OSAddAtomicLong(1, &num_recycledvnodes
);
2243 if (flags
& DOCLOSE
)
2244 clflags
|= IO_NDELAY
;
2245 if (flags
& REVOKEALL
)
2246 clflags
|= IO_REVOKE
;
2248 if (active
&& (flags
& DOCLOSE
))
2249 VNOP_CLOSE(vp
, clflags
, ctx
);
2252 * Clean out any buffers associated with the vnode.
2254 if (flags
& DOCLOSE
) {
2256 if (vp
->v_tag
== VT_NFS
)
2257 nfs_vinvalbuf(vp
, V_SAVE
, ctx
, 0);
2261 VNOP_FSYNC(vp
, MNT_WAIT
, ctx
);
2264 * If the vnode is still in use (by the journal for
2265 * example) we don't want to invalidate locked buffers
2266 * here. In that case, either the journal will tidy them
2267 * up, or we will deal with it when the usecount is
2268 * finally released in vnode_rele_internal.
2270 buf_invalidateblks(vp
, BUF_WRITE_DATA
| (active
? 0 : BUF_INVALIDATE_LOCKED
), 0, 0);
2272 if (UBCINFOEXISTS(vp
))
2274 * Clean the pages in VM.
2276 (void)ubc_msync(vp
, (off_t
)0, ubc_getsize(vp
), NULL
, UBC_PUSHALL
| UBC_INVALIDATE
| UBC_SYNC
);
2278 if (active
|| need_inactive
)
2279 VNOP_INACTIVE(vp
, ctx
);
2282 if ((is_namedstream
!= 0) && (vp
->v_parent
!= NULLVP
)) {
2283 vnode_t pvp
= vp
->v_parent
;
2285 /* Delete the shadow stream file before we reclaim its vnode */
2286 if (vnode_isshadow(vp
)) {
2287 vnode_relenamedstream(pvp
, vp
);
2291 * No more streams associated with the parent. We
2292 * have a ref on it, so its identity is stable.
2293 * If the parent is on an opaque volume, then we need to know
2294 * whether it has associated named streams.
2296 if (vfs_authopaque(pvp
->v_mount
)) {
2297 vnode_lock_spin(pvp
);
2298 pvp
->v_lflag
&= ~VL_HASSTREAMS
;
2305 * Destroy ubc named reference
2306 * cluster_release is done on this path
2307 * along with dropping the reference on the ucred
2308 * (and in the case of forced unmount of an mmap-ed file,
2309 * the ubc reference on the vnode is dropped here too).
2311 ubc_destroy_named(vp
);
2315 * cleanup trigger info from vnode (if any)
2318 vnode_resolver_detach(vp
);
2322 * Reclaim the vnode.
2324 if (VNOP_RECLAIM(vp
, ctx
))
2325 panic("vclean: cannot reclaim");
2327 // make sure the name & parent ptrs get cleaned out!
2328 vnode_update_identity(vp
, NULLVP
, NULL
, 0, 0, VNODE_UPDATE_PARENT
| VNODE_UPDATE_NAME
| VNODE_UPDATE_PURGE
);
2333 * Remove the vnode from any mount list it might be on. It is not
2334 * safe to do this any earlier because unmount needs to wait for
2335 * any vnodes to terminate and it cannot do that if it cannot find
2338 insmntque(vp
, (struct mount
*)0);
2340 vp
->v_mount
= dead_mountp
;
2341 vp
->v_op
= dead_vnodeop_p
;
2345 vp
->v_lflag
|= VL_DEAD
;
2346 vp
->v_flag
&= ~VISDIRTY
;
2348 if (already_terminating
== 0) {
2349 vp
->v_lflag
&= ~VL_TERMINATE
;
2351 * Done with purge, notify sleepers of the grim news.
2353 if (vp
->v_lflag
& VL_TERMWANT
) {
2354 vp
->v_lflag
&= ~VL_TERMWANT
;
2355 wakeup(&vp
->v_lflag
);
2361 * Eliminate all activity associated with the requested vnode
2362 * and with all vnodes aliased to the requested vnode.
2366 vn_revoke(vnode_t vp
, int flags
, __unused vfs_context_t a_context
)
2368 vn_revoke(vnode_t vp
, __unused
int flags
, __unused vfs_context_t a_context
)
2375 if ((flags
& REVOKEALL
) == 0)
2376 panic("vnop_revoke");
2379 if (vnode_isaliased(vp
)) {
2381 * If a vgone (or vclean) is already in progress,
2382 * return an immediate error
2384 if (vp
->v_lflag
& VL_TERMINATE
)
2388 * Ensure that vp will not be vgone'd while we
2389 * are eliminating its aliases.
2392 while ((vp
->v_specflags
& SI_ALIASED
)) {
2393 for (vq
= *vp
->v_hashchain
; vq
; vq
= vq
->v_specnext
) {
2394 if (vq
->v_rdev
!= vp
->v_rdev
||
2395 vq
->v_type
!= vp
->v_type
|| vp
== vq
)
2399 if (vnode_getwithvid(vq
,vid
)){
2404 if (!(vq
->v_lflag
& VL_TERMINATE
)) {
2405 vnode_reclaim_internal(vq
, 1, 1, 0);
2407 vnode_put_locked(vq
);
2416 if (vp
->v_lflag
& VL_TERMINATE
) {
2420 vnode_reclaim_internal(vp
, 1, 0, REVOKEALL
);
2427 * Recycle an unused vnode to the front of the free list.
2428 * Release the passed interlock if the vnode will be recycled.
2431 vnode_recycle(struct vnode
*vp
)
2433 vnode_lock_spin(vp
);
2435 if (vp
->v_iocount
|| vp
->v_usecount
) {
2436 vp
->v_lflag
|= VL_MARKTERM
;
2440 vnode_lock_convert(vp
);
2441 vnode_reclaim_internal(vp
, 1, 0, 0);
2449 vnode_reload(vnode_t vp
)
2451 vnode_lock_spin(vp
);
2453 if ((vp
->v_iocount
> 1) || vp
->v_usecount
) {
2457 if (vp
->v_iocount
<= 0)
2458 panic("vnode_reload with no iocount %d", vp
->v_iocount
);
2460 /* mark for release when iocount is dopped */
2461 vp
->v_lflag
|= VL_MARKTERM
;
2469 vgone(vnode_t vp
, int flags
)
2475 * Clean out the filesystem specific data.
2476 * vclean also takes care of removing the
2477 * vnode from any mount list it might be on
2479 vclean(vp
, flags
| DOCLOSE
);
2482 * If special device, remove it from special device alias list
2485 if ((vp
->v_type
== VBLK
|| vp
->v_type
== VCHR
) && vp
->v_specinfo
!= 0) {
2487 if (*vp
->v_hashchain
== vp
) {
2488 *vp
->v_hashchain
= vp
->v_specnext
;
2490 for (vq
= *vp
->v_hashchain
; vq
; vq
= vq
->v_specnext
) {
2491 if (vq
->v_specnext
!= vp
)
2493 vq
->v_specnext
= vp
->v_specnext
;
2497 panic("missing bdev");
2499 if (vp
->v_specflags
& SI_ALIASED
) {
2501 for (vq
= *vp
->v_hashchain
; vq
; vq
= vq
->v_specnext
) {
2502 if (vq
->v_rdev
!= vp
->v_rdev
||
2503 vq
->v_type
!= vp
->v_type
)
2510 panic("missing alias");
2512 vx
->v_specflags
&= ~SI_ALIASED
;
2513 vp
->v_specflags
&= ~SI_ALIASED
;
2517 struct specinfo
*tmp
= vp
->v_specinfo
;
2518 vp
->v_specinfo
= NULL
;
2519 FREE_ZONE((void *)tmp
, sizeof(struct specinfo
), M_SPECINFO
);
2525 * Lookup a vnode by device number.
2528 check_mountedon(dev_t dev
, enum vtype type
, int *errorp
)
2536 for (vp
= speclisth
[SPECHASH(dev
)]; vp
; vp
= vp
->v_specnext
) {
2537 if (dev
!= vp
->v_rdev
|| type
!= vp
->v_type
)
2541 if (vnode_getwithvid(vp
,vid
))
2543 vnode_lock_spin(vp
);
2544 if ((vp
->v_usecount
> 0) || (vp
->v_iocount
> 1)) {
2546 if ((*errorp
= vfs_mountedon(vp
)) != 0)
2558 * Calculate the total number of references to a special device.
2567 if (!vnode_isspec(vp
)) {
2568 return (vp
->v_usecount
- vp
->v_kusecount
);
2572 if (!vnode_isaliased(vp
))
2573 return (vp
->v_specinfo
->si_opencount
);
2578 * Grab first vnode and its vid.
2580 vq
= *vp
->v_hashchain
;
2581 vid
= vq
? vq
->v_id
: 0;
2587 * Attempt to get the vnode outside the SPECHASH lock.
2589 if (vnode_getwithvid(vq
, vid
)) {
2594 if (vq
->v_rdev
== vp
->v_rdev
&& vq
->v_type
== vp
->v_type
) {
2595 if ((vq
->v_usecount
== 0) && (vq
->v_iocount
== 1) && vq
!= vp
) {
2597 * Alias, but not in use, so flush it out.
2599 vnode_reclaim_internal(vq
, 1, 1, 0);
2600 vnode_put_locked(vq
);
2604 count
+= vq
->v_specinfo
->si_opencount
;
2610 * must do this with the reference still held on 'vq'
2611 * so that it can't be destroyed while we're poking
2612 * through v_specnext
2614 vnext
= vq
->v_specnext
;
2615 vid
= vnext
? vnext
->v_id
: 0;
2627 int prtactive
= 0; /* 1 => print out reclaim of active vnodes */
2630 * Print out a description of a vnode.
2632 static const char *typename
[] =
2633 { "VNON", "VREG", "VDIR", "VBLK", "VCHR", "VLNK", "VSOCK", "VFIFO", "VBAD" };
2636 vprint(const char *label
, struct vnode
*vp
)
2641 printf("%s: ", label
);
2642 printf("type %s, usecount %d, writecount %d",
2643 typename
[vp
->v_type
], vp
->v_usecount
, vp
->v_writecount
);
2645 if (vp
->v_flag
& VROOT
)
2646 strlcat(sbuf
, "|VROOT", sizeof(sbuf
));
2647 if (vp
->v_flag
& VTEXT
)
2648 strlcat(sbuf
, "|VTEXT", sizeof(sbuf
));
2649 if (vp
->v_flag
& VSYSTEM
)
2650 strlcat(sbuf
, "|VSYSTEM", sizeof(sbuf
));
2651 if (vp
->v_flag
& VNOFLUSH
)
2652 strlcat(sbuf
, "|VNOFLUSH", sizeof(sbuf
));
2653 if (vp
->v_flag
& VBWAIT
)
2654 strlcat(sbuf
, "|VBWAIT", sizeof(sbuf
));
2655 if (vnode_isaliased(vp
))
2656 strlcat(sbuf
, "|VALIASED", sizeof(sbuf
));
2657 if (sbuf
[0] != '\0')
2658 printf(" flags (%s)", &sbuf
[1]);
2663 vn_getpath(struct vnode
*vp
, char *pathbuf
, int *len
)
2665 return build_path(vp
, pathbuf
, *len
, len
, BUILDPATH_NO_FS_ENTER
, vfs_context_current());
2669 vn_getpath_fsenter(struct vnode
*vp
, char *pathbuf
, int *len
)
2671 return build_path(vp
, pathbuf
, *len
, len
, 0, vfs_context_current());
2675 vn_getcdhash(struct vnode
*vp
, off_t offset
, unsigned char *cdhash
)
2677 return ubc_cs_getcdhash(vp
, offset
, cdhash
);
2681 static char *extension_table
=NULL
;
2683 static int max_ext_width
;
2686 extension_cmp(const void *a
, const void *b
)
2688 return (strlen((const char *)a
) - strlen((const char *)b
));
2693 // This is the api LaunchServices uses to inform the kernel
2694 // the list of package extensions to ignore.
2696 // Internally we keep the list sorted by the length of the
2697 // the extension (from longest to shortest). We sort the
2698 // list of extensions so that we can speed up our searches
2699 // when comparing file names -- we only compare extensions
2700 // that could possibly fit into the file name, not all of
2701 // them (i.e. a short 8 character name can't have an 8
2702 // character extension).
2704 extern lck_mtx_t
*pkg_extensions_lck
;
2706 __private_extern__
int
2707 set_package_extensions_table(user_addr_t data
, int nentries
, int maxwidth
)
2709 char *new_exts
, *old_exts
;
2712 if (nentries
<= 0 || nentries
> 1024 || maxwidth
<= 0 || maxwidth
> 255) {
2717 // allocate one byte extra so we can guarantee null termination
2718 MALLOC(new_exts
, char *, (nentries
* maxwidth
) + 1, M_TEMP
, M_WAITOK
);
2719 if (new_exts
== NULL
) {
2723 error
= copyin(data
, new_exts
, nentries
* maxwidth
);
2725 FREE(new_exts
, M_TEMP
);
2729 new_exts
[(nentries
* maxwidth
)] = '\0'; // guarantee null termination of the block
2731 qsort(new_exts
, nentries
, maxwidth
, extension_cmp
);
2733 lck_mtx_lock(pkg_extensions_lck
);
2735 old_exts
= extension_table
;
2736 extension_table
= new_exts
;
2738 max_ext_width
= maxwidth
;
2740 lck_mtx_unlock(pkg_extensions_lck
);
2743 FREE(old_exts
, M_TEMP
);
2750 int is_package_name(const char *name
, int len
)
2753 const char *ptr
, *name_ext
;
2760 for(ptr
=name
; *ptr
!= '\0'; ptr
++) {
2766 // if there is no "." extension, it can't match
2767 if (name_ext
== NULL
) {
2771 // advance over the "."
2774 lck_mtx_lock(pkg_extensions_lck
);
2776 // now iterate over all the extensions to see if any match
2777 ptr
= &extension_table
[0];
2778 for(i
=0; i
< nexts
; i
++, ptr
+=max_ext_width
) {
2779 extlen
= strlen(ptr
);
2780 if (strncasecmp(name_ext
, ptr
, extlen
) == 0 && name_ext
[extlen
] == '\0') {
2782 lck_mtx_unlock(pkg_extensions_lck
);
2787 lck_mtx_unlock(pkg_extensions_lck
);
2789 // if we get here, no extension matched
2794 vn_path_package_check(__unused vnode_t vp
, char *path
, int pathlen
, int *component
)
2805 while(end
< path
+ pathlen
&& *end
!= '\0') {
2806 while(end
< path
+ pathlen
&& *end
== '/' && *end
!= '\0') {
2812 while(end
< path
+ pathlen
&& *end
!= '/' && *end
!= '\0') {
2816 if (end
> path
+ pathlen
) {
2817 // hmm, string wasn't null terminated
2822 if (is_package_name(ptr
, end
- ptr
)) {
2835 * Determine if a name is inappropriate for a searchfs query.
2836 * This list consists of /System currently.
2839 int vn_searchfs_inappropriate_name(const char *name
, int len
) {
2840 const char *bad_names
[] = { "System" };
2841 int bad_len
[] = { 6 };
2844 for(i
=0; i
< (int) (sizeof(bad_names
) / sizeof(bad_names
[0])); i
++) {
2845 if (len
== bad_len
[i
] && strncmp(name
, bad_names
[i
], strlen(bad_names
[i
]) + 1) == 0) {
2850 // if we get here, no name matched
2855 * Top level filesystem related information gathering.
2857 extern unsigned int vfs_nummntops
;
2860 * The VFS_NUMMNTOPS shouldn't be at name[1] since
2861 * is a VFS generic variable. Since we no longer support
2862 * VT_UFS, we reserve its value to support this sysctl node.
2864 * It should have been:
2865 * name[0]: VFS_GENERIC
2866 * name[1]: VFS_NUMMNTOPS
2868 SYSCTL_INT(_vfs
, VFS_NUMMNTOPS
, nummntops
,
2869 CTLFLAG_RD
| CTLFLAG_KERN
| CTLFLAG_LOCKED
,
2870 &vfs_nummntops
, 0, "");
2873 vfs_sysctl(int *name __unused
, u_int namelen __unused
,
2874 user_addr_t oldp __unused
, size_t *oldlenp __unused
,
2875 user_addr_t newp __unused
, size_t newlen __unused
, proc_t p __unused
);
2878 vfs_sysctl(int *name __unused
, u_int namelen __unused
,
2879 user_addr_t oldp __unused
, size_t *oldlenp __unused
,
2880 user_addr_t newp __unused
, size_t newlen __unused
, proc_t p __unused
)
2887 // The following code disallows specific sysctl's that came through
2888 // the direct sysctl interface (vfs_sysctl_node) instead of the newer
2889 // sysctl_vfs_ctlbyfsid() interface. We can not allow these selectors
2890 // through vfs_sysctl_node() because it passes the user's oldp pointer
2891 // directly to the file system which (for these selectors) casts it
2892 // back to a struct sysctl_req and then proceed to use SYSCTL_IN()
2893 // which jumps through an arbitrary function pointer. When called
2894 // through the sysctl_vfs_ctlbyfsid() interface this does not happen
2895 // and so it's safe.
2897 // Unfortunately we have to pull in definitions from AFP and SMB and
2898 // perform explicit name checks on the file system to determine if
2899 // these selectors are being used.
2902 #define AFPFS_VFS_CTL_GETID 0x00020001
2903 #define AFPFS_VFS_CTL_NETCHANGE 0x00020002
2904 #define AFPFS_VFS_CTL_VOLCHANGE 0x00020003
2906 #define SMBFS_SYSCTL_REMOUNT 1
2907 #define SMBFS_SYSCTL_REMOUNT_INFO 2
2908 #define SMBFS_SYSCTL_GET_SERVER_SHARE 3
2912 is_bad_sysctl_name(struct vfstable
*vfsp
, int selector_name
)
2914 switch(selector_name
) {
2917 case VFS_CTL_NOLOCKS
:
2918 case VFS_CTL_NSTATUS
:
2921 case VFS_CTL_SERVERINFO
:
2928 // the more complicated check for some of SMB's special values
2929 if (strcmp(vfsp
->vfc_name
, "smbfs") == 0) {
2930 switch(selector_name
) {
2931 case SMBFS_SYSCTL_REMOUNT
:
2932 case SMBFS_SYSCTL_REMOUNT_INFO
:
2933 case SMBFS_SYSCTL_GET_SERVER_SHARE
:
2936 } else if (strcmp(vfsp
->vfc_name
, "afpfs") == 0) {
2937 switch(selector_name
) {
2938 case AFPFS_VFS_CTL_GETID
:
2939 case AFPFS_VFS_CTL_NETCHANGE
:
2940 case AFPFS_VFS_CTL_VOLCHANGE
:
2946 // If we get here we passed all the checks so the selector is ok
2952 int vfs_sysctl_node SYSCTL_HANDLER_ARGS
2955 struct vfstable
*vfsp
;
2959 fstypenum
= oidp
->oid_number
;
2963 /* all sysctl names at this level should have at least one name slot for the FS */
2965 return (EISDIR
); /* overloaded */
2968 for (vfsp
= vfsconf
; vfsp
; vfsp
= vfsp
->vfc_next
)
2969 if (vfsp
->vfc_typenum
== fstypenum
) {
2970 vfsp
->vfc_refcount
++;
2973 mount_list_unlock();
2979 if (is_bad_sysctl_name(vfsp
, name
[0])) {
2980 printf("vfs: bad selector 0x%.8x for old-style sysctl(). use the sysctl-by-fsid interface instead\n", name
[0]);
2984 error
= (vfsp
->vfc_vfsops
->vfs_sysctl
)(name
, namelen
, req
->oldptr
, &req
->oldlen
, req
->newptr
, req
->newlen
, vfs_context_current());
2987 vfsp
->vfc_refcount
--;
2988 mount_list_unlock();
2994 * Check to see if a filesystem is mounted on a block device.
2997 vfs_mountedon(struct vnode
*vp
)
3003 if (vp
->v_specflags
& SI_MOUNTEDON
) {
3007 if (vp
->v_specflags
& SI_ALIASED
) {
3008 for (vq
= *vp
->v_hashchain
; vq
; vq
= vq
->v_specnext
) {
3009 if (vq
->v_rdev
!= vp
->v_rdev
||
3010 vq
->v_type
!= vp
->v_type
)
3012 if (vq
->v_specflags
& SI_MOUNTEDON
) {
3023 struct unmount_info
{
3024 int u_errs
; // Total failed unmounts
3025 int u_busy
; // EBUSY failed unmounts
3029 unmount_callback(mount_t mp
, void *arg
)
3033 struct unmount_info
*uip
= arg
;
3036 mount_iterdrop(mp
); // avoid vfs_iterate deadlock in dounmount()
3038 MALLOC_ZONE(mntname
, void *, MAXPATHLEN
, M_NAMEI
, M_WAITOK
);
3040 strlcpy(mntname
, mp
->mnt_vfsstat
.f_mntonname
, MAXPATHLEN
);
3042 error
= dounmount(mp
, MNT_FORCE
, 1, vfs_context_current());
3045 printf("Unmount of %s failed (%d)\n", mntname
? mntname
:"?", error
);
3050 FREE_ZONE(mntname
, MAXPATHLEN
, M_NAMEI
);
3052 return (VFS_RETURNED
);
3056 * Unmount all filesystems. The list is traversed in reverse order
3057 * of mounting to avoid dependencies.
3058 * Busy mounts are retried.
3060 __private_extern__
void
3061 vfs_unmountall(void)
3063 int mounts
, sec
= 1;
3064 struct unmount_info ui
;
3067 ui
.u_errs
= ui
.u_busy
= 0;
3068 vfs_iterate(VFS_ITERATE_CB_DROPREF
| VFS_ITERATE_TAIL_FIRST
, unmount_callback
, &ui
);
3069 mounts
= mount_getvfscnt();
3073 if (ui
.u_busy
> 0) { // Busy mounts - wait & retry
3074 tsleep(&nummounts
, PVFS
, "busy mount", sec
* hz
);
3078 printf("Unmounting timed out\n");
3079 } else if (ui
.u_errs
< mounts
) {
3080 // If the vfs_iterate missed mounts in progress - wait a bit
3081 tsleep(&nummounts
, PVFS
, "missed mount", 2 * hz
);
3086 * This routine is called from vnode_pager_deallocate out of the VM
3087 * The path to vnode_pager_deallocate can only be initiated by ubc_destroy_named
3088 * on a vnode that has a UBCINFO
3090 __private_extern__
void
3091 vnode_pager_vrele(vnode_t vp
)
3093 struct ubc_info
*uip
;
3095 vnode_lock_spin(vp
);
3097 vp
->v_lflag
&= ~VNAMED_UBC
;
3098 if (vp
->v_usecount
!= 0) {
3100 * At the eleventh hour, just before the ubcinfo is
3101 * destroyed, ensure the ubc-specific v_usecount
3102 * reference has gone. We use v_usecount != 0 as a hint;
3103 * ubc_unmap() does nothing if there's no mapping.
3105 * This case is caused by coming here via forced unmount,
3106 * versus the usual vm_object_deallocate() path.
3107 * In the forced unmount case, ubc_destroy_named()
3108 * releases the pager before memory_object_last_unmap()
3113 vnode_lock_spin(vp
);
3116 uip
= vp
->v_ubcinfo
;
3117 vp
->v_ubcinfo
= UBC_INFO_NULL
;
3121 ubc_info_deallocate(uip
);
3125 #include <sys/disk.h>
3127 u_int32_t rootunit
= (u_int32_t
)-1;
3130 extern int lowpri_throttle_enabled
;
3131 extern int iosched_enabled
;
3135 vfs_init_io_attributes(vnode_t devvp
, mount_t mp
)
3138 off_t readblockcnt
= 0;
3139 off_t writeblockcnt
= 0;
3140 off_t readmaxcnt
= 0;
3141 off_t writemaxcnt
= 0;
3142 off_t readsegcnt
= 0;
3143 off_t writesegcnt
= 0;
3144 off_t readsegsize
= 0;
3145 off_t writesegsize
= 0;
3146 off_t alignment
= 0;
3147 u_int32_t minsaturationbytecount
= 0;
3148 u_int32_t ioqueue_depth
= 0;
3152 vfs_context_t ctx
= vfs_context_current();
3153 dk_corestorage_info_t cs_info
;
3154 boolean_t cs_present
= FALSE
;;
3159 VNOP_IOCTL(devvp
, DKIOCGETTHROTTLEMASK
, (caddr_t
)&mp
->mnt_throttle_mask
, 0, NULL
);
3161 * as a reasonable approximation, only use the lowest bit of the mask
3162 * to generate a disk unit number
3164 mp
->mnt_devbsdunit
= num_trailing_0(mp
->mnt_throttle_mask
);
3166 if (devvp
== rootvp
)
3167 rootunit
= mp
->mnt_devbsdunit
;
3169 if (mp
->mnt_devbsdunit
== rootunit
) {
3171 * this mount point exists on the same device as the root
3172 * partition, so it comes under the hard throttle control...
3173 * this is true even for the root mount point itself
3175 mp
->mnt_kern_flag
|= MNTK_ROOTDEV
;
3178 * force the spec device to re-cache
3179 * the underlying block size in case
3180 * the filesystem overrode the initial value
3182 set_fsblocksize(devvp
);
3185 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETBLOCKSIZE
,
3186 (caddr_t
)&blksize
, 0, ctx
)))
3189 mp
->mnt_devblocksize
= blksize
;
3192 * set the maximum possible I/O size
3193 * this may get clipped to a smaller value
3194 * based on which constraints are being advertised
3195 * and if those advertised constraints result in a smaller
3196 * limit for a given I/O
3198 mp
->mnt_maxreadcnt
= MAX_UPL_SIZE_BYTES
;
3199 mp
->mnt_maxwritecnt
= MAX_UPL_SIZE_BYTES
;
3201 if (VNOP_IOCTL(devvp
, DKIOCISVIRTUAL
, (caddr_t
)&isvirtual
, 0, ctx
) == 0) {
3203 mp
->mnt_kern_flag
|= MNTK_VIRTUALDEV
;
3205 if (VNOP_IOCTL(devvp
, DKIOCISSOLIDSTATE
, (caddr_t
)&isssd
, 0, ctx
) == 0) {
3207 mp
->mnt_kern_flag
|= MNTK_SSD
;
3209 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETFEATURES
,
3210 (caddr_t
)&features
, 0, ctx
)))
3213 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETMAXBLOCKCOUNTREAD
,
3214 (caddr_t
)&readblockcnt
, 0, ctx
)))
3217 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETMAXBLOCKCOUNTWRITE
,
3218 (caddr_t
)&writeblockcnt
, 0, ctx
)))
3221 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETMAXBYTECOUNTREAD
,
3222 (caddr_t
)&readmaxcnt
, 0, ctx
)))
3225 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETMAXBYTECOUNTWRITE
,
3226 (caddr_t
)&writemaxcnt
, 0, ctx
)))
3229 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETMAXSEGMENTCOUNTREAD
,
3230 (caddr_t
)&readsegcnt
, 0, ctx
)))
3233 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETMAXSEGMENTCOUNTWRITE
,
3234 (caddr_t
)&writesegcnt
, 0, ctx
)))
3237 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETMAXSEGMENTBYTECOUNTREAD
,
3238 (caddr_t
)&readsegsize
, 0, ctx
)))
3241 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETMAXSEGMENTBYTECOUNTWRITE
,
3242 (caddr_t
)&writesegsize
, 0, ctx
)))
3245 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETMINSEGMENTALIGNMENTBYTECOUNT
,
3246 (caddr_t
)&alignment
, 0, ctx
)))
3249 if ((error
= VNOP_IOCTL(devvp
, DKIOCGETCOMMANDPOOLSIZE
,
3250 (caddr_t
)&ioqueue_depth
, 0, ctx
)))
3254 mp
->mnt_maxreadcnt
= (readmaxcnt
> UINT32_MAX
) ? UINT32_MAX
: readmaxcnt
;
3257 temp
= readblockcnt
* blksize
;
3258 temp
= (temp
> UINT32_MAX
) ? UINT32_MAX
: temp
;
3260 if (temp
< mp
->mnt_maxreadcnt
)
3261 mp
->mnt_maxreadcnt
= (u_int32_t
)temp
;
3265 mp
->mnt_maxwritecnt
= (writemaxcnt
> UINT32_MAX
) ? UINT32_MAX
: writemaxcnt
;
3267 if (writeblockcnt
) {
3268 temp
= writeblockcnt
* blksize
;
3269 temp
= (temp
> UINT32_MAX
) ? UINT32_MAX
: temp
;
3271 if (temp
< mp
->mnt_maxwritecnt
)
3272 mp
->mnt_maxwritecnt
= (u_int32_t
)temp
;
3276 temp
= (readsegcnt
> UINT16_MAX
) ? UINT16_MAX
: readsegcnt
;
3278 temp
= mp
->mnt_maxreadcnt
/ PAGE_SIZE
;
3280 if (temp
> UINT16_MAX
)
3283 mp
->mnt_segreadcnt
= (u_int16_t
)temp
;
3286 temp
= (writesegcnt
> UINT16_MAX
) ? UINT16_MAX
: writesegcnt
;
3288 temp
= mp
->mnt_maxwritecnt
/ PAGE_SIZE
;
3290 if (temp
> UINT16_MAX
)
3293 mp
->mnt_segwritecnt
= (u_int16_t
)temp
;
3296 temp
= (readsegsize
> UINT32_MAX
) ? UINT32_MAX
: readsegsize
;
3298 temp
= mp
->mnt_maxreadcnt
;
3299 mp
->mnt_maxsegreadsize
= (u_int32_t
)temp
;
3302 temp
= (writesegsize
> UINT32_MAX
) ? UINT32_MAX
: writesegsize
;
3304 temp
= mp
->mnt_maxwritecnt
;
3305 mp
->mnt_maxsegwritesize
= (u_int32_t
)temp
;
3308 temp
= (alignment
> PAGE_SIZE
) ? PAGE_MASK
: alignment
- 1;
3311 mp
->mnt_alignmentmask
= temp
;
3314 if (ioqueue_depth
> MNT_DEFAULT_IOQUEUE_DEPTH
)
3315 temp
= ioqueue_depth
;
3317 temp
= MNT_DEFAULT_IOQUEUE_DEPTH
;
3319 mp
->mnt_ioqueue_depth
= temp
;
3320 mp
->mnt_ioscale
= (mp
->mnt_ioqueue_depth
+ (MNT_DEFAULT_IOQUEUE_DEPTH
- 1)) / MNT_DEFAULT_IOQUEUE_DEPTH
;
3322 if (mp
->mnt_ioscale
> 1)
3323 printf("ioqueue_depth = %d, ioscale = %d\n", (int)mp
->mnt_ioqueue_depth
, (int)mp
->mnt_ioscale
);
3325 if (features
& DK_FEATURE_FORCE_UNIT_ACCESS
)
3326 mp
->mnt_ioflags
|= MNT_IOFLAGS_FUA_SUPPORTED
;
3328 if (VNOP_IOCTL(devvp
, DKIOCGETIOMINSATURATIONBYTECOUNT
, (caddr_t
)&minsaturationbytecount
, 0, ctx
) == 0) {
3329 mp
->mnt_minsaturationbytecount
= minsaturationbytecount
;
3331 mp
->mnt_minsaturationbytecount
= 0;
3334 if (VNOP_IOCTL(devvp
, DKIOCCORESTORAGE
, (caddr_t
)&cs_info
, 0, ctx
) == 0)
3337 if (features
& DK_FEATURE_UNMAP
) {
3338 mp
->mnt_ioflags
|= MNT_IOFLAGS_UNMAP_SUPPORTED
;
3340 if (cs_present
== TRUE
)
3341 mp
->mnt_ioflags
|= MNT_IOFLAGS_CSUNMAP_SUPPORTED
;
3343 if (cs_present
== TRUE
) {
3345 * for now we'll use the following test as a proxy for
3346 * the underlying drive being FUSION in nature
3348 if ((cs_info
.flags
& DK_CORESTORAGE_PIN_YOUR_METADATA
))
3349 mp
->mnt_ioflags
|= MNT_IOFLAGS_FUSION_DRIVE
;
3353 if (iosched_enabled
&& (features
& DK_FEATURE_PRIORITY
)) {
3354 mp
->mnt_ioflags
|= MNT_IOFLAGS_IOSCHED_SUPPORTED
;
3355 throttle_info_disable_throttle(mp
->mnt_devbsdunit
, (mp
->mnt_ioflags
& MNT_IOFLAGS_FUSION_DRIVE
) != 0);
3357 #endif /* CONFIG_IOSCHED */
3361 static struct klist fs_klist
;
3362 lck_grp_t
*fs_klist_lck_grp
;
3363 lck_mtx_t
*fs_klist_lock
;
3366 vfs_event_init(void)
3369 klist_init(&fs_klist
);
3370 fs_klist_lck_grp
= lck_grp_alloc_init("fs_klist", NULL
);
3371 fs_klist_lock
= lck_mtx_alloc_init(fs_klist_lck_grp
, NULL
);
3375 vfs_event_signal(fsid_t
*fsid
, u_int32_t event
, intptr_t data
)
3377 if (event
== VQ_DEAD
|| event
== VQ_NOTRESP
) {
3378 struct mount
*mp
= vfs_getvfs(fsid
);
3380 mount_lock_spin(mp
);
3382 mp
->mnt_kern_flag
&= ~MNT_LNOTRESP
; // Now responding
3384 mp
->mnt_kern_flag
|= MNT_LNOTRESP
; // Not responding
3389 lck_mtx_lock(fs_klist_lock
);
3390 KNOTE(&fs_klist
, event
);
3391 lck_mtx_unlock(fs_klist_lock
);
3395 * return the number of mounted filesystems.
3398 sysctl_vfs_getvfscnt(void)
3400 return(mount_getvfscnt());
3405 mount_getvfscnt(void)
3411 mount_list_unlock();
3419 mount_fillfsids(fsid_t
*fsidlst
, int count
)
3426 TAILQ_FOREACH(mp
, &mountlist
, mnt_list
) {
3427 if (actual
<= count
) {
3428 fsidlst
[actual
] = mp
->mnt_vfsstat
.f_fsid
;
3432 mount_list_unlock();
3438 * fill in the array of fsid_t's up to a max of 'count', the actual
3439 * number filled in will be set in '*actual'. If there are more fsid_t's
3440 * than room in fsidlst then ENOMEM will be returned and '*actual' will
3441 * have the actual count.
3442 * having *actual filled out even in the error case is depended upon.
3445 sysctl_vfs_getvfslist(fsid_t
*fsidlst
, int count
, int *actual
)
3451 TAILQ_FOREACH(mp
, &mountlist
, mnt_list
) {
3453 if (*actual
<= count
)
3454 fsidlst
[(*actual
) - 1] = mp
->mnt_vfsstat
.f_fsid
;
3456 mount_list_unlock();
3457 return (*actual
<= count
? 0 : ENOMEM
);
3461 sysctl_vfs_vfslist(__unused
struct sysctl_oid
*oidp
, __unused
void *arg1
,
3462 __unused
int arg2
, struct sysctl_req
*req
)
3468 /* This is a readonly node. */
3469 if (req
->newptr
!= USER_ADDR_NULL
)
3472 /* they are querying us so just return the space required. */
3473 if (req
->oldptr
== USER_ADDR_NULL
) {
3474 req
->oldidx
= sysctl_vfs_getvfscnt() * sizeof(fsid_t
);
3479 * Retrieve an accurate count of the amount of space required to copy
3480 * out all the fsids in the system.
3482 space
= req
->oldlen
;
3483 req
->oldlen
= sysctl_vfs_getvfscnt() * sizeof(fsid_t
);
3485 /* they didn't give us enough space. */
3486 if (space
< req
->oldlen
)
3489 MALLOC(fsidlst
, fsid_t
*, req
->oldlen
, M_TEMP
, M_WAITOK
);
3490 if (fsidlst
== NULL
) {
3494 error
= sysctl_vfs_getvfslist(fsidlst
, req
->oldlen
/ sizeof(fsid_t
),
3497 * If we get back ENOMEM, then another mount has been added while we
3498 * slept in malloc above. If this is the case then try again.
3500 if (error
== ENOMEM
) {
3501 FREE(fsidlst
, M_TEMP
);
3502 req
->oldlen
= space
;
3506 error
= SYSCTL_OUT(req
, fsidlst
, actual
* sizeof(fsid_t
));
3508 FREE(fsidlst
, M_TEMP
);
3513 * Do a sysctl by fsid.
3516 sysctl_vfs_ctlbyfsid(__unused
struct sysctl_oid
*oidp
, void *arg1
, int arg2
,
3517 struct sysctl_req
*req
)
3519 union union_vfsidctl vc
;
3521 struct vfsstatfs
*sp
;
3522 int *name
, flags
, namelen
;
3523 int error
=0, gotref
=0;
3524 vfs_context_t ctx
= vfs_context_current();
3525 proc_t p
= req
->p
; /* XXX req->p != current_proc()? */
3526 boolean_t is_64_bit
;
3530 is_64_bit
= proc_is64bit(p
);
3532 error
= SYSCTL_IN(req
, &vc
, is_64_bit
? sizeof(vc
.vc64
):sizeof(vc
.vc32
));
3535 if (vc
.vc32
.vc_vers
!= VFS_CTL_VERS1
) { /* works for 32 and 64 */
3539 mp
= mount_list_lookupby_fsid(&vc
.vc32
.vc_fsid
, 0, 1); /* works for 32 and 64 */
3545 /* reset so that the fs specific code can fetch it. */
3548 * Note if this is a VFS_CTL then we pass the actual sysctl req
3549 * in for "oldp" so that the lower layer can DTRT and use the
3550 * SYSCTL_IN/OUT routines.
3552 if (mp
->mnt_op
->vfs_sysctl
!= NULL
) {
3554 if (vfs_64bitready(mp
)) {
3555 error
= mp
->mnt_op
->vfs_sysctl(name
, namelen
,
3556 CAST_USER_ADDR_T(req
),
3557 NULL
, USER_ADDR_NULL
, 0,
3565 error
= mp
->mnt_op
->vfs_sysctl(name
, namelen
,
3566 CAST_USER_ADDR_T(req
),
3567 NULL
, USER_ADDR_NULL
, 0,
3570 if (error
!= ENOTSUP
) {
3575 case VFS_CTL_UMOUNT
:
3578 req
->newptr
= vc
.vc64
.vc_ptr
;
3579 req
->newlen
= (size_t)vc
.vc64
.vc_len
;
3582 req
->newptr
= CAST_USER_ADDR_T(vc
.vc32
.vc_ptr
);
3583 req
->newlen
= vc
.vc32
.vc_len
;
3585 error
= SYSCTL_IN(req
, &flags
, sizeof(flags
));
3592 /* safedounmount consumes a ref */
3593 error
= safedounmount(mp
, flags
, ctx
);
3595 case VFS_CTL_STATFS
:
3598 req
->newptr
= vc
.vc64
.vc_ptr
;
3599 req
->newlen
= (size_t)vc
.vc64
.vc_len
;
3602 req
->newptr
= CAST_USER_ADDR_T(vc
.vc32
.vc_ptr
);
3603 req
->newlen
= vc
.vc32
.vc_len
;
3605 error
= SYSCTL_IN(req
, &flags
, sizeof(flags
));
3608 sp
= &mp
->mnt_vfsstat
;
3609 if (((flags
& MNT_NOWAIT
) == 0 || (flags
& (MNT_WAIT
| MNT_DWAIT
))) &&
3610 (error
= vfs_update_vfsstat(mp
, ctx
, VFS_USER_EVENT
)))
3613 struct user64_statfs sfs
;
3614 bzero(&sfs
, sizeof(sfs
));
3615 sfs
.f_flags
= mp
->mnt_flag
& MNT_VISFLAGMASK
;
3616 sfs
.f_type
= mp
->mnt_vtable
->vfc_typenum
;
3617 sfs
.f_bsize
= (user64_long_t
)sp
->f_bsize
;
3618 sfs
.f_iosize
= (user64_long_t
)sp
->f_iosize
;
3619 sfs
.f_blocks
= (user64_long_t
)sp
->f_blocks
;
3620 sfs
.f_bfree
= (user64_long_t
)sp
->f_bfree
;
3621 sfs
.f_bavail
= (user64_long_t
)sp
->f_bavail
;
3622 sfs
.f_files
= (user64_long_t
)sp
->f_files
;
3623 sfs
.f_ffree
= (user64_long_t
)sp
->f_ffree
;
3624 sfs
.f_fsid
= sp
->f_fsid
;
3625 sfs
.f_owner
= sp
->f_owner
;
3627 if (mp
->mnt_kern_flag
& MNTK_TYPENAME_OVERRIDE
) {
3628 strlcpy(&sfs
.f_fstypename
[0], &mp
->fstypename_override
[0], MFSTYPENAMELEN
);
3632 strlcpy(sfs
.f_fstypename
, sp
->f_fstypename
, MFSNAMELEN
);
3634 strlcpy(sfs
.f_mntonname
, sp
->f_mntonname
, MNAMELEN
);
3635 strlcpy(sfs
.f_mntfromname
, sp
->f_mntfromname
, MNAMELEN
);
3637 error
= SYSCTL_OUT(req
, &sfs
, sizeof(sfs
));
3640 struct user32_statfs sfs
;
3641 bzero(&sfs
, sizeof(sfs
));
3642 sfs
.f_flags
= mp
->mnt_flag
& MNT_VISFLAGMASK
;
3643 sfs
.f_type
= mp
->mnt_vtable
->vfc_typenum
;
3646 * It's possible for there to be more than 2^^31 blocks in the filesystem, so we
3647 * have to fudge the numbers here in that case. We inflate the blocksize in order
3648 * to reflect the filesystem size as best we can.
3650 if (sp
->f_blocks
> INT_MAX
) {
3654 * Work out how far we have to shift the block count down to make it fit.
3655 * Note that it's possible to have to shift so far that the resulting
3656 * blocksize would be unreportably large. At that point, we will clip
3657 * any values that don't fit.
3659 * For safety's sake, we also ensure that f_iosize is never reported as
3660 * being smaller than f_bsize.
3662 for (shift
= 0; shift
< 32; shift
++) {
3663 if ((sp
->f_blocks
>> shift
) <= INT_MAX
)
3665 if ((((long long)sp
->f_bsize
) << (shift
+ 1)) > INT_MAX
)
3668 #define __SHIFT_OR_CLIP(x, s) ((((x) >> (s)) > INT_MAX) ? INT_MAX : ((x) >> (s)))
3669 sfs
.f_blocks
= (user32_long_t
)__SHIFT_OR_CLIP(sp
->f_blocks
, shift
);
3670 sfs
.f_bfree
= (user32_long_t
)__SHIFT_OR_CLIP(sp
->f_bfree
, shift
);
3671 sfs
.f_bavail
= (user32_long_t
)__SHIFT_OR_CLIP(sp
->f_bavail
, shift
);
3672 #undef __SHIFT_OR_CLIP
3673 sfs
.f_bsize
= (user32_long_t
)(sp
->f_bsize
<< shift
);
3674 sfs
.f_iosize
= lmax(sp
->f_iosize
, sp
->f_bsize
);
3676 sfs
.f_bsize
= (user32_long_t
)sp
->f_bsize
;
3677 sfs
.f_iosize
= (user32_long_t
)sp
->f_iosize
;
3678 sfs
.f_blocks
= (user32_long_t
)sp
->f_blocks
;
3679 sfs
.f_bfree
= (user32_long_t
)sp
->f_bfree
;
3680 sfs
.f_bavail
= (user32_long_t
)sp
->f_bavail
;
3682 sfs
.f_files
= (user32_long_t
)sp
->f_files
;
3683 sfs
.f_ffree
= (user32_long_t
)sp
->f_ffree
;
3684 sfs
.f_fsid
= sp
->f_fsid
;
3685 sfs
.f_owner
= sp
->f_owner
;
3688 if (mp
->mnt_kern_flag
& MNTK_TYPENAME_OVERRIDE
) {
3689 strlcpy(&sfs
.f_fstypename
[0], &mp
->fstypename_override
[0], MFSTYPENAMELEN
);
3693 strlcpy(sfs
.f_fstypename
, sp
->f_fstypename
, MFSNAMELEN
);
3695 strlcpy(sfs
.f_mntonname
, sp
->f_mntonname
, MNAMELEN
);
3696 strlcpy(sfs
.f_mntfromname
, sp
->f_mntfromname
, MNAMELEN
);
3698 error
= SYSCTL_OUT(req
, &sfs
, sizeof(sfs
));
3711 static int filt_fsattach(struct knote
*kn
);
3712 static void filt_fsdetach(struct knote
*kn
);
3713 static int filt_fsevent(struct knote
*kn
, long hint
);
3714 static int filt_fstouch(struct knote
*kn
, struct kevent_internal_s
*kev
);
3715 static int filt_fsprocess(struct knote
*kn
, struct filt_process_s
*data
, struct kevent_internal_s
*kev
);
3716 struct filterops fs_filtops
= {
3717 .f_attach
= filt_fsattach
,
3718 .f_detach
= filt_fsdetach
,
3719 .f_event
= filt_fsevent
,
3720 .f_touch
= filt_fstouch
,
3721 .f_process
= filt_fsprocess
,
3725 filt_fsattach(struct knote
*kn
)
3727 lck_mtx_lock(fs_klist_lock
);
3728 KNOTE_ATTACH(&fs_klist
, kn
);
3729 lck_mtx_unlock(fs_klist_lock
);
3732 * filter only sees future events,
3733 * so it can't be fired already.
3739 filt_fsdetach(struct knote
*kn
)
3741 lck_mtx_lock(fs_klist_lock
);
3742 KNOTE_DETACH(&fs_klist
, kn
);
3743 lck_mtx_unlock(fs_klist_lock
);
3747 filt_fsevent(struct knote
*kn
, long hint
)
3750 * Backwards compatibility:
3751 * Other filters would do nothing if kn->kn_sfflags == 0
3754 if ((kn
->kn_sfflags
== 0) || (kn
->kn_sfflags
& hint
)) {
3755 kn
->kn_fflags
|= hint
;
3758 return (kn
->kn_fflags
!= 0);
3762 filt_fstouch(struct knote
*kn
, struct kevent_internal_s
*kev
)
3766 lck_mtx_lock(fs_klist_lock
);
3768 kn
->kn_sfflags
= kev
->fflags
;
3769 if ((kn
->kn_status
& KN_UDATA_SPECIFIC
) == 0)
3770 kn
->kn_udata
= kev
->udata
;
3773 * the above filter function sets bits even if nobody is looking for them.
3774 * Just preserve those bits even in the new mask is more selective
3777 * For compatibility with previous implementations, we leave kn_fflags
3778 * as they were before.
3780 //if (kn->kn_sfflags)
3781 // kn->kn_fflags &= kn->kn_sfflags;
3782 res
= (kn
->kn_fflags
!= 0);
3784 lck_mtx_unlock(fs_klist_lock
);
3790 filt_fsprocess(struct knote
*kn
, struct filt_process_s
*data
, struct kevent_internal_s
*kev
)
3792 #pragma unused(data)
3795 lck_mtx_lock(fs_klist_lock
);
3796 res
= (kn
->kn_fflags
!= 0);
3798 *kev
= kn
->kn_kevent
;
3799 kn
->kn_flags
|= EV_CLEAR
; /* automatic */
3803 lck_mtx_unlock(fs_klist_lock
);
3808 sysctl_vfs_noremotehang(__unused
struct sysctl_oid
*oidp
,
3809 __unused
void *arg1
, __unused
int arg2
, struct sysctl_req
*req
)
3815 /* We need a pid. */
3816 if (req
->newptr
== USER_ADDR_NULL
)
3819 error
= SYSCTL_IN(req
, &pid
, sizeof(pid
));
3823 p
= proc_find(pid
< 0 ? -pid
: pid
);
3828 * Fetching the value is ok, but we only fetch if the old
3831 if (req
->oldptr
!= USER_ADDR_NULL
) {
3832 out
= !((p
->p_flag
& P_NOREMOTEHANG
) == 0);
3834 error
= SYSCTL_OUT(req
, &out
, sizeof(out
));
3838 /* cansignal offers us enough security. */
3839 if (p
!= req
->p
&& proc_suser(req
->p
) != 0) {
3845 OSBitAndAtomic(~((uint32_t)P_NOREMOTEHANG
), &p
->p_flag
);
3847 OSBitOrAtomic(P_NOREMOTEHANG
, &p
->p_flag
);
3854 sysctl_vfs_generic_conf SYSCTL_HANDLER_ARGS
3857 struct vfstable
*vfsp
;
3858 struct vfsconf vfsc
;
3866 } else if (namelen
> 1) {
3871 for (vfsp
= vfsconf
; vfsp
; vfsp
= vfsp
->vfc_next
)
3872 if (vfsp
->vfc_typenum
== name
[0])
3876 mount_list_unlock();
3880 vfsc
.vfc_reserved1
= 0;
3881 bcopy(vfsp
->vfc_name
, vfsc
.vfc_name
, sizeof(vfsc
.vfc_name
));
3882 vfsc
.vfc_typenum
= vfsp
->vfc_typenum
;
3883 vfsc
.vfc_refcount
= vfsp
->vfc_refcount
;
3884 vfsc
.vfc_flags
= vfsp
->vfc_flags
;
3885 vfsc
.vfc_reserved2
= 0;
3886 vfsc
.vfc_reserved3
= 0;
3888 mount_list_unlock();
3889 return (SYSCTL_OUT(req
, &vfsc
, sizeof(struct vfsconf
)));
3892 /* the vfs.generic. branch. */
3893 SYSCTL_NODE(_vfs
, VFS_GENERIC
, generic
, CTLFLAG_RW
| CTLFLAG_LOCKED
, NULL
, "vfs generic hinge");
3894 /* retreive a list of mounted filesystem fsid_t */
3895 SYSCTL_PROC(_vfs_generic
, OID_AUTO
, vfsidlist
,
3896 CTLTYPE_STRUCT
| CTLFLAG_RD
| CTLFLAG_LOCKED
,
3897 NULL
, 0, sysctl_vfs_vfslist
, "S,fsid", "List of mounted filesystem ids");
3898 /* perform operations on filesystem via fsid_t */
3899 SYSCTL_NODE(_vfs_generic
, OID_AUTO
, ctlbyfsid
, CTLFLAG_RW
| CTLFLAG_LOCKED
,
3900 sysctl_vfs_ctlbyfsid
, "ctlbyfsid");
3901 SYSCTL_PROC(_vfs_generic
, OID_AUTO
, noremotehang
, CTLFLAG_RW
| CTLFLAG_ANYBODY
,
3902 NULL
, 0, sysctl_vfs_noremotehang
, "I", "noremotehang");
3903 SYSCTL_INT(_vfs_generic
, VFS_MAXTYPENUM
, maxtypenum
,
3904 CTLFLAG_RD
| CTLFLAG_KERN
| CTLFLAG_LOCKED
,
3905 &maxvfstypenum
, 0, "");
3906 SYSCTL_INT(_vfs_generic
, OID_AUTO
, sync_timeout
, CTLFLAG_RW
| CTLFLAG_LOCKED
, &sync_timeout
, 0, "");
3907 SYSCTL_NODE(_vfs_generic
, VFS_CONF
, conf
,
3908 CTLFLAG_RD
| CTLFLAG_LOCKED
,
3909 sysctl_vfs_generic_conf
, "");
3912 * Print vnode state.
3915 vn_print_state(struct vnode
*vp
, const char *fmt
, ...)
3918 char perm_str
[] = "(VM_KERNEL_ADDRPERM pointer)";
3919 char fs_name
[MFSNAMELEN
];
3924 printf("vp 0x%0llx %s: ", (uint64_t)VM_KERNEL_ADDRPERM(vp
), perm_str
);
3925 printf("tag %d, type %d\n", vp
->v_tag
, vp
->v_type
);
3927 printf(" iocount %d, usecount %d, kusecount %d references %d\n",
3928 vp
->v_iocount
, vp
->v_usecount
, vp
->v_kusecount
, vp
->v_references
);
3929 printf(" writecount %d, numoutput %d\n", vp
->v_writecount
,
3932 printf(" flag 0x%x, lflag 0x%x, listflag 0x%x\n", vp
->v_flag
,
3933 vp
->v_lflag
, vp
->v_listflag
);
3935 if (vp
->v_mount
== NULL
|| vp
->v_mount
== dead_mountp
) {
3936 strlcpy(fs_name
, "deadfs", MFSNAMELEN
);
3938 vfs_name(vp
->v_mount
, fs_name
);
3941 printf(" v_data 0x%0llx %s\n",
3942 (vp
->v_data
? (uint64_t)VM_KERNEL_ADDRPERM(vp
->v_data
) : 0),
3944 printf(" v_mount 0x%0llx %s vfs_name %s\n",
3945 (vp
->v_mount
? (uint64_t)VM_KERNEL_ADDRPERM(vp
->v_mount
) : 0),
3949 long num_reusedvnodes
= 0;
3953 process_vp(vnode_t vp
, int want_vp
, int *deferred
)
3961 vnode_list_remove_locked(vp
);
3963 vnode_list_unlock();
3965 vnode_lock_spin(vp
);
3968 * We could wait for the vnode_lock after removing the vp from the freelist
3969 * and the vid is bumped only at the very end of reclaim. So it is possible
3970 * that we are looking at a vnode that is being terminated. If so skip it.
3972 if ((vpid
!= vp
->v_id
) || (vp
->v_usecount
!= 0) || (vp
->v_iocount
!= 0) ||
3973 VONLIST(vp
) || (vp
->v_lflag
& VL_TERMINATE
)) {
3975 * we lost the race between dropping the list lock
3976 * and picking up the vnode_lock... someone else
3977 * used this vnode and it is now in a new state
3983 if ( (vp
->v_lflag
& (VL_NEEDINACTIVE
| VL_MARKTERM
)) == VL_NEEDINACTIVE
) {
3985 * we did a vnode_rele_ext that asked for
3986 * us not to reenter the filesystem during
3987 * the release even though VL_NEEDINACTIVE was
3988 * set... we'll do it here by doing a
3989 * vnode_get/vnode_put
3991 * pick up an iocount so that we can call
3992 * vnode_put and drive the VNOP_INACTIVE...
3993 * vnode_put will either leave us off
3994 * the freelist if a new ref comes in,
3995 * or put us back on the end of the freelist
3996 * or recycle us if we were marked for termination...
3997 * so we'll just go grab a new candidate
4003 vnode_put_locked(vp
);
4009 * Checks for anyone racing us for recycle
4011 if (vp
->v_type
!= VBAD
) {
4012 if (want_vp
&& (vnode_on_reliable_media(vp
) == FALSE
|| (vp
->v_flag
& VISDIRTY
))) {
4013 vnode_async_list_add(vp
);
4020 if (vp
->v_lflag
& VL_DEAD
)
4021 panic("new_vnode(%p): the vnode is VL_DEAD but not VBAD", vp
);
4023 vnode_lock_convert(vp
);
4024 (void)vnode_reclaim_internal(vp
, 1, want_vp
, 0);
4028 panic("new_vnode(%p): vp on list", vp
);
4029 if (vp
->v_usecount
|| vp
->v_iocount
|| vp
->v_kusecount
||
4030 (vp
->v_lflag
& (VNAMED_UBC
| VNAMED_MOUNT
| VNAMED_FSHASH
)))
4031 panic("new_vnode(%p): free vnode still referenced", vp
);
4032 if ((vp
->v_mntvnodes
.tqe_prev
!= 0) && (vp
->v_mntvnodes
.tqe_next
!= 0))
4033 panic("new_vnode(%p): vnode seems to be on mount list", vp
);
4034 if ( !LIST_EMPTY(&vp
->v_nclinks
) || !TAILQ_EMPTY(&vp
->v_ncchildren
))
4035 panic("new_vnode(%p): vnode still hooked into the name cache", vp
);
4044 __attribute__((noreturn
))
4046 async_work_continue(void)
4048 struct async_work_lst
*q
;
4052 q
= &vnode_async_work_list
;
4058 if ( TAILQ_EMPTY(q
) ) {
4059 assert_wait(q
, (THREAD_UNINT
));
4061 vnode_list_unlock();
4063 thread_block((thread_continue_t
)async_work_continue
);
4067 async_work_handled
++;
4069 vp
= TAILQ_FIRST(q
);
4071 vp
= process_vp(vp
, 0, &deferred
);
4074 panic("found VBAD vp (%p) on async queue", vp
);
4080 new_vnode(vnode_t
*vpp
)
4083 uint32_t retries
= 0, max_retries
= 100; /* retry incase of tablefull */
4084 int force_alloc
= 0, walk_count
= 0;
4085 boolean_t need_reliable_vp
= FALSE
;
4087 struct timeval initial_tv
;
4088 struct timeval current_tv
;
4089 proc_t curproc
= current_proc();
4091 initial_tv
.tv_sec
= 0;
4097 if (need_reliable_vp
== TRUE
)
4098 async_work_timed_out
++;
4100 if ((numvnodes
- deadvnodes
) < desiredvnodes
|| force_alloc
) {
4103 if ( !TAILQ_EMPTY(&vnode_dead_list
)) {
4105 * Can always reuse a dead one
4107 vp
= TAILQ_FIRST(&vnode_dead_list
);
4111 * no dead vnodes available... if we're under
4112 * the limit, we'll create a new vnode
4115 vnode_list_unlock();
4117 MALLOC_ZONE(vp
, struct vnode
*, sizeof(*vp
), M_VNODE
, M_WAITOK
);
4118 bzero((char *)vp
, sizeof(*vp
));
4119 VLISTNONE(vp
); /* avoid double queue removal */
4120 lck_mtx_init(&vp
->v_lock
, vnode_lck_grp
, vnode_lck_attr
);
4122 TAILQ_INIT(&vp
->v_ncchildren
);
4124 klist_init(&vp
->v_knotes
);
4126 vp
->v_id
= ts
.tv_nsec
;
4127 vp
->v_flag
= VSTANDARD
;
4130 if (mac_vnode_label_init_needed(vp
))
4131 mac_vnode_label_init(vp
);
4137 microuptime(¤t_tv
);
4139 #define MAX_WALK_COUNT 1000
4141 if ( !TAILQ_EMPTY(&vnode_rage_list
) &&
4142 (ragevnodes
>= rage_limit
||
4143 (current_tv
.tv_sec
- rage_tv
.tv_sec
) >= RAGE_TIME_LIMIT
)) {
4145 TAILQ_FOREACH(vp
, &vnode_rage_list
, v_freelist
) {
4146 if ( !(vp
->v_listflag
& VLIST_RAGE
))
4147 panic("new_vnode: vp (%p) on RAGE list not marked VLIST_RAGE", vp
);
4149 // if we're a dependency-capable process, skip vnodes that can
4150 // cause recycling deadlocks. (i.e. this process is diskimages
4151 // helper and the vnode is in a disk image). Querying the
4152 // mnt_kern_flag for the mount's virtual device status
4153 // is safer than checking the mnt_dependent_process, which
4154 // may not be updated if there are multiple devnode layers
4155 // in between the disk image and the final consumer.
4157 if ((curproc
->p_flag
& P_DEPENDENCY_CAPABLE
) == 0 || vp
->v_mount
== NULL
||
4158 (vp
->v_mount
->mnt_kern_flag
& MNTK_VIRTUALDEV
) == 0) {
4160 * if need_reliable_vp == TRUE, then we've already sent one or more
4161 * non-reliable vnodes to the async thread for processing and timed
4162 * out waiting for a dead vnode to show up. Use the MAX_WALK_COUNT
4163 * mechanism to first scan for a reliable vnode before forcing
4164 * a new vnode to be created
4166 if (need_reliable_vp
== FALSE
|| vnode_on_reliable_media(vp
) == TRUE
)
4170 // don't iterate more than MAX_WALK_COUNT vnodes to
4171 // avoid keeping the vnode list lock held for too long.
4173 if (walk_count
++ > MAX_WALK_COUNT
) {
4180 if (vp
== NULL
&& !TAILQ_EMPTY(&vnode_free_list
)) {
4182 * Pick the first vp for possible reuse
4185 TAILQ_FOREACH(vp
, &vnode_free_list
, v_freelist
) {
4187 // if we're a dependency-capable process, skip vnodes that can
4188 // cause recycling deadlocks. (i.e. this process is diskimages
4189 // helper and the vnode is in a disk image). Querying the
4190 // mnt_kern_flag for the mount's virtual device status
4191 // is safer than checking the mnt_dependent_process, which
4192 // may not be updated if there are multiple devnode layers
4193 // in between the disk image and the final consumer.
4195 if ((curproc
->p_flag
& P_DEPENDENCY_CAPABLE
) == 0 || vp
->v_mount
== NULL
||
4196 (vp
->v_mount
->mnt_kern_flag
& MNTK_VIRTUALDEV
) == 0) {
4198 * if need_reliable_vp == TRUE, then we've already sent one or more
4199 * non-reliable vnodes to the async thread for processing and timed
4200 * out waiting for a dead vnode to show up. Use the MAX_WALK_COUNT
4201 * mechanism to first scan for a reliable vnode before forcing
4202 * a new vnode to be created
4204 if (need_reliable_vp
== FALSE
|| vnode_on_reliable_media(vp
) == TRUE
)
4208 // don't iterate more than MAX_WALK_COUNT vnodes to
4209 // avoid keeping the vnode list lock held for too long.
4211 if (walk_count
++ > MAX_WALK_COUNT
) {
4219 // if we don't have a vnode and the walk_count is >= MAX_WALK_COUNT
4220 // then we're trying to create a vnode on behalf of a
4221 // process like diskimages-helper that has file systems
4222 // mounted on top of itself (and thus we can't reclaim
4223 // vnodes in the file systems on top of us). if we can't
4224 // find a vnode to reclaim then we'll just have to force
4227 if (vp
== NULL
&& walk_count
>= MAX_WALK_COUNT
) {
4229 vnode_list_unlock();
4235 * we've reached the system imposed maximum number of vnodes
4236 * but there isn't a single one available
4237 * wait a bit and then retry... if we can't get a vnode
4238 * after our target number of retries, than log a complaint
4240 if (++retries
<= max_retries
) {
4241 vnode_list_unlock();
4242 delay_for_interval(1, 1000 * 1000);
4246 vnode_list_unlock();
4248 log(LOG_EMERG
, "%d desired, %d numvnodes, "
4249 "%d free, %d dead, %d async, %d rage\n",
4250 desiredvnodes
, numvnodes
, freevnodes
, deadvnodes
, async_work_vnodes
, ragevnodes
);
4253 #if DEVELOPMENT || DEBUG
4254 if (bootarg_no_vnode_jetsam
)
4255 panic("vnode table is full\n");
4256 #endif /* DEVELOPMENT || DEBUG */
4259 * Running out of vnodes tends to make a system unusable. Start killing
4260 * processes that jetsam knows are killable.
4262 if (memorystatus_kill_on_vnode_limit() == FALSE
) {
4264 * If jetsam can't find any more processes to kill and there
4265 * still aren't any free vnodes, panic. Hopefully we'll get a
4266 * panic log to tell us why we ran out.
4268 panic("vnode table is full\n");
4272 * Now that we've killed someone, wait a bit and continue looking
4273 * (with fewer retries before trying another kill).
4275 delay_for_interval(3, 1000 * 1000);
4285 if ((vp
= process_vp(vp
, 1, &deferred
)) == NULLVP
) {
4288 struct timeval elapsed_tv
;
4290 if (initial_tv
.tv_sec
== 0)
4291 microuptime(&initial_tv
);
4295 dead_vnode_waited
++;
4296 dead_vnode_wanted
++;
4299 * note that we're only going to explicitly wait 10ms
4300 * for a dead vnode to become available, since even if one
4301 * isn't available, a reliable vnode might now be available
4302 * at the head of the VRAGE or free lists... if so, we
4303 * can satisfy the new_vnode request with less latency then waiting
4304 * for the full 100ms duration we're ultimately willing to tolerate
4306 assert_wait_timeout((caddr_t
)&dead_vnode_wanted
, (THREAD_INTERRUPTIBLE
), 10000, NSEC_PER_USEC
);
4308 vnode_list_unlock();
4310 thread_block(THREAD_CONTINUE_NULL
);
4312 microuptime(&elapsed_tv
);
4314 timevalsub(&elapsed_tv
, &initial_tv
);
4315 elapsed_msecs
= elapsed_tv
.tv_sec
* 1000 + elapsed_tv
.tv_usec
/ 1000;
4317 if (elapsed_msecs
>= 100) {
4319 * we've waited long enough... 100ms is
4320 * somewhat arbitrary for this case, but the
4321 * normal worst case latency used for UI
4322 * interaction is 100ms, so I've chosen to
4325 * setting need_reliable_vp to TRUE
4326 * forces us to find a reliable vnode
4327 * that we can process synchronously, or
4328 * to create a new one if the scan for
4329 * a reliable one hits the scan limit
4331 need_reliable_vp
= TRUE
;
4336 OSAddAtomicLong(1, &num_reusedvnodes
);
4341 * We should never see VL_LABELWAIT or VL_LABEL here.
4342 * as those operations hold a reference.
4344 assert ((vp
->v_lflag
& VL_LABELWAIT
) != VL_LABELWAIT
);
4345 assert ((vp
->v_lflag
& VL_LABEL
) != VL_LABEL
);
4346 if (vp
->v_lflag
& VL_LABELED
) {
4347 vnode_lock_convert(vp
);
4348 mac_vnode_label_recycle(vp
);
4349 } else if (mac_vnode_label_init_needed(vp
)) {
4350 vnode_lock_convert(vp
);
4351 mac_vnode_label_init(vp
);
4358 vp
->v_writecount
= 0;
4359 vp
->v_references
= 0;
4360 vp
->v_iterblkflags
= 0;
4361 vp
->v_flag
= VSTANDARD
;
4362 /* vbad vnodes can point to dead_mountp */
4364 vp
->v_defer_reclaimlist
= (vnode_t
)0;
4375 vnode_lock(vnode_t vp
)
4377 lck_mtx_lock(&vp
->v_lock
);
4381 vnode_lock_spin(vnode_t vp
)
4383 lck_mtx_lock_spin(&vp
->v_lock
);
4387 vnode_unlock(vnode_t vp
)
4389 lck_mtx_unlock(&vp
->v_lock
);
4395 vnode_get(struct vnode
*vp
)
4399 vnode_lock_spin(vp
);
4400 retval
= vnode_get_locked(vp
);
4407 vnode_get_locked(struct vnode
*vp
)
4410 lck_mtx_assert(&vp
->v_lock
, LCK_MTX_ASSERT_OWNED
);
4412 if ((vp
->v_iocount
== 0) && (vp
->v_lflag
& (VL_TERMINATE
| VL_DEAD
))) {
4423 * vnode_getwithvid() cuts in line in front of a vnode drain (that is,
4424 * while the vnode is draining, but at no point after that) to prevent
4425 * deadlocks when getting vnodes from filesystem hashes while holding
4426 * resources that may prevent other iocounts from being released.
4429 vnode_getwithvid(vnode_t vp
, uint32_t vid
)
4431 return(vget_internal(vp
, vid
, ( VNODE_NODEAD
| VNODE_WITHID
| VNODE_DRAINO
)));
4435 * vnode_getwithvid_drainok() is like vnode_getwithvid(), but *does* block behind a vnode
4436 * drain; it exists for use in the VFS name cache, where we really do want to block behind
4437 * vnode drain to prevent holding off an unmount.
4440 vnode_getwithvid_drainok(vnode_t vp
, uint32_t vid
)
4442 return(vget_internal(vp
, vid
, ( VNODE_NODEAD
| VNODE_WITHID
)));
4446 vnode_getwithref(vnode_t vp
)
4448 return(vget_internal(vp
, 0, 0));
4452 __private_extern__
int
4453 vnode_getalways(vnode_t vp
)
4455 return(vget_internal(vp
, 0, VNODE_ALWAYS
));
4459 vnode_put(vnode_t vp
)
4463 vnode_lock_spin(vp
);
4464 retval
= vnode_put_locked(vp
);
4471 vn_set_dead(vnode_t vp
)
4474 vp
->v_op
= dead_vnodeop_p
;
4478 vp
->v_lflag
|= VL_DEAD
;
4482 vnode_put_locked(vnode_t vp
)
4484 vfs_context_t ctx
= vfs_context_current(); /* hoist outside loop */
4487 lck_mtx_assert(&vp
->v_lock
, LCK_MTX_ASSERT_OWNED
);
4490 if (vp
->v_iocount
< 1)
4491 panic("vnode_put(%p): iocount < 1", vp
);
4493 if ((vp
->v_usecount
> 0) || (vp
->v_iocount
> 1)) {
4494 vnode_dropiocount(vp
);
4497 if ((vp
->v_lflag
& (VL_DEAD
| VL_NEEDINACTIVE
)) == VL_NEEDINACTIVE
) {
4499 vp
->v_lflag
&= ~VL_NEEDINACTIVE
;
4502 VNOP_INACTIVE(vp
, ctx
);
4504 vnode_lock_spin(vp
);
4506 * because we had to drop the vnode lock before calling
4507 * VNOP_INACTIVE, the state of this vnode may have changed...
4508 * we may pick up both VL_MARTERM and either
4509 * an iocount or a usecount while in the VNOP_INACTIVE call
4510 * we don't want to call vnode_reclaim_internal on a vnode
4511 * that has active references on it... so loop back around
4512 * and reevaluate the state
4516 vp
->v_lflag
&= ~VL_NEEDINACTIVE
;
4518 if ((vp
->v_lflag
& (VL_MARKTERM
| VL_TERMINATE
| VL_DEAD
)) == VL_MARKTERM
) {
4519 vnode_lock_convert(vp
);
4520 vnode_reclaim_internal(vp
, 1, 1, 0);
4522 vnode_dropiocount(vp
);
4528 /* is vnode_t in use by others? */
4530 vnode_isinuse(vnode_t vp
, int refcnt
)
4532 return(vnode_isinuse_locked(vp
, refcnt
, 0));
4535 int vnode_usecount(vnode_t vp
)
4537 return vp
->v_usecount
;
4540 int vnode_iocount(vnode_t vp
)
4542 return vp
->v_iocount
;
4546 vnode_isinuse_locked(vnode_t vp
, int refcnt
, int locked
)
4551 vnode_lock_spin(vp
);
4552 if ((vp
->v_type
!= VREG
) && ((vp
->v_usecount
- vp
->v_kusecount
) > refcnt
)) {
4556 if (vp
->v_type
== VREG
) {
4557 retval
= ubc_isinuse_locked(vp
, refcnt
, 1);
4567 /* resume vnode_t */
4569 vnode_resume(vnode_t vp
)
4571 if ((vp
->v_lflag
& VL_SUSPENDED
) && vp
->v_owner
== current_thread()) {
4573 vnode_lock_spin(vp
);
4574 vp
->v_lflag
&= ~VL_SUSPENDED
;
4578 wakeup(&vp
->v_iocount
);
4584 * Please do not use on more than one vnode at a time as it may
4586 * xxx should we explicity prevent this from happening?
4590 vnode_suspend(vnode_t vp
)
4592 if (vp
->v_lflag
& VL_SUSPENDED
) {
4596 vnode_lock_spin(vp
);
4599 * xxx is this sufficient to check if a vnode_drain is
4603 if (vp
->v_owner
== NULL
) {
4604 vp
->v_lflag
|= VL_SUSPENDED
;
4605 vp
->v_owner
= current_thread();
4613 * Release any blocked locking requests on the vnode.
4614 * Used for forced-unmounts.
4616 * XXX What about network filesystems?
4619 vnode_abort_advlocks(vnode_t vp
)
4621 if (vp
->v_flag
& VLOCKLOCAL
)
4622 lf_abort_advlocks(vp
);
4627 vnode_drain(vnode_t vp
)
4630 if (vp
->v_lflag
& VL_DRAIN
) {
4631 panic("vnode_drain: recursive drain");
4634 vp
->v_lflag
|= VL_DRAIN
;
4635 vp
->v_owner
= current_thread();
4637 while (vp
->v_iocount
> 1)
4638 msleep(&vp
->v_iocount
, &vp
->v_lock
, PVFS
, "vnode_drain", NULL
);
4640 vp
->v_lflag
&= ~VL_DRAIN
;
4647 * if the number of recent references via vnode_getwithvid or vnode_getwithref
4648 * exceeds this threshold, than 'UN-AGE' the vnode by removing it from
4649 * the LRU list if it's currently on it... once the iocount and usecount both drop
4650 * to 0, it will get put back on the end of the list, effectively making it younger
4651 * this allows us to keep actively referenced vnodes in the list without having
4652 * to constantly remove and add to the list each time a vnode w/o a usecount is
4653 * referenced which costs us taking and dropping a global lock twice.
4654 * However, if the vnode is marked DIRTY, we want to pull it out much earlier
4656 #define UNAGE_THRESHHOLD 25
4657 #define UNAGE_DIRTYTHRESHHOLD 6
4660 vnode_getiocount(vnode_t vp
, unsigned int vid
, int vflags
)
4662 int nodead
= vflags
& VNODE_NODEAD
;
4663 int nosusp
= vflags
& VNODE_NOSUSPEND
;
4664 int always
= vflags
& VNODE_ALWAYS
;
4665 int beatdrain
= vflags
& VNODE_DRAINO
;
4666 int withvid
= vflags
& VNODE_WITHID
;
4672 * if it is a dead vnode with deadfs
4674 if (nodead
&& (vp
->v_lflag
& VL_DEAD
) && ((vp
->v_type
== VBAD
) || (vp
->v_data
== 0))) {
4678 * will return VL_DEAD ones
4680 if ((vp
->v_lflag
& (VL_SUSPENDED
| VL_DRAIN
| VL_TERMINATE
)) == 0 ) {
4684 * if suspended vnodes are to be failed
4686 if (nosusp
&& (vp
->v_lflag
& VL_SUSPENDED
)) {
4690 * if you are the owner of drain/suspend/termination , can acquire iocount
4691 * check for VL_TERMINATE; it does not set owner
4693 if ((vp
->v_lflag
& (VL_DRAIN
| VL_SUSPENDED
| VL_TERMINATE
)) &&
4694 (vp
->v_owner
== current_thread())) {
4702 * If this vnode is getting drained, there are some cases where
4703 * we can't block or, in case of tty vnodes, want to be
4706 if (vp
->v_lflag
& VL_DRAIN
) {
4708 * In some situations, we want to get an iocount
4709 * even if the vnode is draining to prevent deadlock,
4710 * e.g. if we're in the filesystem, potentially holding
4711 * resources that could prevent other iocounts from
4717 * Don't block if the vnode's mount point is unmounting as
4718 * we may be the thread the unmount is itself waiting on
4719 * Only callers who pass in vids (at this point, we've already
4720 * handled nosusp and nodead) are expecting error returns
4721 * from this function, so only we can only return errors for
4722 * those. ENODEV is intended to inform callers that the call
4723 * failed because an unmount is in progress.
4725 if (withvid
&& (vp
->v_mount
) && vfs_isunmount(vp
->v_mount
))
4728 if (vnode_istty(vp
)) {
4733 vnode_lock_convert(vp
);
4735 if (vp
->v_lflag
& VL_TERMINATE
) {
4738 vp
->v_lflag
|= VL_TERMWANT
;
4740 error
= msleep(&vp
->v_lflag
, &vp
->v_lock
,
4741 (PVFS
| sleepflg
), "vnode getiocount", NULL
);
4745 msleep(&vp
->v_iocount
, &vp
->v_lock
, PVFS
, "vnode_getiocount", NULL
);
4747 if (withvid
&& vid
!= vp
->v_id
) {
4750 if (++vp
->v_references
>= UNAGE_THRESHHOLD
||
4751 (vp
->v_flag
& VISDIRTY
&& vp
->v_references
>= UNAGE_DIRTYTHRESHHOLD
)) {
4752 vp
->v_references
= 0;
4753 vnode_list_remove(vp
);
4763 vnode_dropiocount (vnode_t vp
)
4765 if (vp
->v_iocount
< 1)
4766 panic("vnode_dropiocount(%p): v_iocount < 1", vp
);
4772 if ((vp
->v_lflag
& (VL_DRAIN
| VL_SUSPENDED
)) && (vp
->v_iocount
<= 1))
4773 wakeup(&vp
->v_iocount
);
4778 vnode_reclaim(struct vnode
* vp
)
4780 vnode_reclaim_internal(vp
, 0, 0, 0);
4785 vnode_reclaim_internal(struct vnode
* vp
, int locked
, int reuse
, int flags
)
4792 if (vp
->v_lflag
& VL_TERMINATE
) {
4793 panic("vnode reclaim in progress");
4795 vp
->v_lflag
|= VL_TERMINATE
;
4797 vn_clearunionwait(vp
, 1);
4801 isfifo
= (vp
->v_type
== VFIFO
);
4803 if (vp
->v_type
!= VBAD
)
4804 vgone(vp
, flags
); /* clean and reclaim the vnode */
4807 * give the vnode a new identity so that vnode_getwithvid will fail
4808 * on any stale cache accesses...
4809 * grab the list_lock so that if we're in "new_vnode"
4810 * behind the list_lock trying to steal this vnode, the v_id is stable...
4811 * once new_vnode drops the list_lock, it will block trying to take
4812 * the vnode lock until we release it... at that point it will evaluate
4813 * whether the v_vid has changed
4814 * also need to make sure that the vnode isn't on a list where "new_vnode"
4815 * can find it after the v_id has been bumped until we are completely done
4816 * with the vnode (i.e. putting it back on a list has to be the very last
4817 * thing we do to this vnode... many of the callers of vnode_reclaim_internal
4818 * are holding an io_count on the vnode... they need to drop the io_count
4819 * BEFORE doing a vnode_list_add or make sure to hold the vnode lock until
4820 * they are completely done with the vnode
4824 vnode_list_remove_locked(vp
);
4827 vnode_list_unlock();
4830 struct fifoinfo
* fip
;
4832 fip
= vp
->v_fifoinfo
;
4833 vp
->v_fifoinfo
= NULL
;
4839 panic("vnode_reclaim_internal: cleaned vnode isn't");
4840 if (vp
->v_numoutput
)
4841 panic("vnode_reclaim_internal: clean vnode has pending I/O's");
4842 if (UBCINFOEXISTS(vp
))
4843 panic("vnode_reclaim_internal: ubcinfo not cleaned");
4845 panic("vnode_reclaim_internal: vparent not removed");
4847 panic("vnode_reclaim_internal: vname not removed");
4849 vp
->v_socket
= NULL
;
4851 vp
->v_lflag
&= ~VL_TERMINATE
;
4854 KNOTE(&vp
->v_knotes
, NOTE_REVOKE
);
4856 /* Make sure that when we reuse the vnode, no knotes left over */
4857 klist_init(&vp
->v_knotes
);
4859 if (vp
->v_lflag
& VL_TERMWANT
) {
4860 vp
->v_lflag
&= ~VL_TERMWANT
;
4861 wakeup(&vp
->v_lflag
);
4865 * make sure we get on the
4866 * dead list if appropriate
4875 vnode_create_internal(uint32_t flavor
, uint32_t size
, void *data
, vnode_t
*vpp
,
4885 struct componentname
*cnp
;
4886 struct vnode_fsparam
*param
= (struct vnode_fsparam
*)data
;
4888 struct vnode_trigger_param
*tinfo
= NULL
;
4899 /* Do quick sanity check on the parameters. */
4900 if ((param
== NULL
) || (param
->vnfs_vtype
== VBAD
)) {
4906 if ((flavor
== VNCREATE_TRIGGER
) && (size
== VNCREATE_TRIGGER_SIZE
)) {
4907 tinfo
= (struct vnode_trigger_param
*)data
;
4909 /* Validate trigger vnode input */
4910 if ((param
->vnfs_vtype
!= VDIR
) ||
4911 (tinfo
->vnt_resolve_func
== NULL
) ||
4912 (tinfo
->vnt_flags
& ~VNT_VALID_MASK
)) {
4916 /* Fall through a normal create (params will be the same) */
4917 flavor
= VNCREATE_FLAVOR
;
4921 if ((flavor
!= VNCREATE_FLAVOR
) || (size
!= VCREATESIZE
)) {
4927 if (!existing_vnode
) {
4928 if ((error
= new_vnode(&vp
)) ) {
4932 /* Make it so that it can be released by a vnode_put) */
4939 * A vnode obtained by vnode_create_empty has been passed to
4940 * vnode_initialize - Unset VL_DEAD set by vn_set_dead. After
4941 * this point, it is set back on any error.
4943 * N.B. vnode locking - We make the same assumptions as the
4944 * "unsplit" vnode_create did - i.e. it is safe to update the
4945 * vnode's fields without the vnode lock. This vnode has been
4946 * out and about with the filesystem and hopefully nothing
4947 * was done to the vnode between the vnode_create_empty and
4948 * now when it has come in through vnode_initialize.
4950 vp
->v_lflag
&= ~VL_DEAD
;
4953 dvp
= param
->vnfs_dvp
;
4954 cnp
= param
->vnfs_cnp
;
4956 vp
->v_op
= param
->vnfs_vops
;
4957 vp
->v_type
= param
->vnfs_vtype
;
4958 vp
->v_data
= param
->vnfs_fsnode
;
4960 if (param
->vnfs_markroot
)
4961 vp
->v_flag
|= VROOT
;
4962 if (param
->vnfs_marksystem
)
4963 vp
->v_flag
|= VSYSTEM
;
4964 if (vp
->v_type
== VREG
) {
4965 error
= ubc_info_init_withsize(vp
, param
->vnfs_filesize
);
4975 if (param
->vnfs_mp
->mnt_ioflags
& MNT_IOFLAGS_IOSCHED_SUPPORTED
)
4976 memory_object_mark_io_tracking(vp
->v_ubcinfo
->ui_control
);
4984 * For trigger vnodes, attach trigger info to vnode
4986 if ((vp
->v_type
== VDIR
) && (tinfo
!= NULL
)) {
4988 * Note: has a side effect of incrementing trigger count on the
4989 * mount if successful, which we would need to undo on a
4990 * subsequent failure.
4995 error
= vnode_resolver_create(param
->vnfs_mp
, vp
, tinfo
, FALSE
);
4997 printf("vnode_create: vnode_resolver_create() err %d\n", error
);
5007 if (vp
->v_type
== VCHR
|| vp
->v_type
== VBLK
) {
5009 vp
->v_tag
= VT_DEVFS
; /* callers will reset if needed (bdevvp) */
5011 if ( (nvp
= checkalias(vp
, param
->vnfs_rdev
)) ) {
5013 * if checkalias returns a vnode, it will be locked
5015 * first get rid of the unneeded vnode we acquired
5018 vp
->v_op
= spec_vnodeop_p
;
5020 vp
->v_lflag
= VL_DEAD
;
5026 * switch to aliased vnode and finish
5032 vp
->v_op
= param
->vnfs_vops
;
5033 vp
->v_type
= param
->vnfs_vtype
;
5034 vp
->v_data
= param
->vnfs_fsnode
;
5037 insmntque(vp
, param
->vnfs_mp
);
5042 if (VCHR
== vp
->v_type
) {
5043 u_int maj
= major(vp
->v_rdev
);
5045 if (maj
< (u_int
)nchrdev
&& cdevsw
[maj
].d_type
== D_TTY
)
5046 vp
->v_flag
|= VISTTY
;
5050 if (vp
->v_type
== VFIFO
) {
5051 struct fifoinfo
*fip
;
5053 MALLOC(fip
, struct fifoinfo
*,
5054 sizeof(*fip
), M_TEMP
, M_WAITOK
);
5055 bzero(fip
, sizeof(struct fifoinfo
));
5056 vp
->v_fifoinfo
= fip
;
5058 /* The file systems must pass the address of the location where
5059 * they store the vnode pointer. When we add the vnode into the mount
5060 * list and name cache they become discoverable. So the file system node
5061 * must have the connection to vnode setup by then
5065 /* Add fs named reference. */
5066 if (param
->vnfs_flags
& VNFS_ADDFSREF
) {
5067 vp
->v_lflag
|= VNAMED_FSHASH
;
5069 if (param
->vnfs_mp
) {
5070 if (param
->vnfs_mp
->mnt_kern_flag
& MNTK_LOCK_LOCAL
)
5071 vp
->v_flag
|= VLOCKLOCAL
;
5073 if ((vp
->v_freelist
.tqe_prev
!= (struct vnode
**)0xdeadb))
5074 panic("insmntque: vp on the free list\n");
5077 * enter in mount vnode list
5079 insmntque(vp
, param
->vnfs_mp
);
5082 if (dvp
&& vnode_ref(dvp
) == 0) {
5086 if (dvp
&& ((param
->vnfs_flags
& (VNFS_NOCACHE
| VNFS_CANTCACHE
)) == 0)) {
5088 * enter into name cache
5089 * we've got the info to enter it into the name cache now
5090 * cache_enter_create will pick up an extra reference on
5091 * the name entered into the string cache
5093 vp
->v_name
= cache_enter_create(dvp
, vp
, cnp
);
5095 vp
->v_name
= vfs_addname(cnp
->cn_nameptr
, cnp
->cn_namelen
, cnp
->cn_hash
, 0);
5097 if ((cnp
->cn_flags
& UNIONCREATED
) == UNIONCREATED
)
5098 vp
->v_flag
|= VISUNION
;
5100 if ((param
->vnfs_flags
& VNFS_CANTCACHE
) == 0) {
5102 * this vnode is being created as cacheable in the name cache
5103 * this allows us to re-enter it in the cache
5105 vp
->v_flag
|= VNCACHEABLE
;
5107 ut
= get_bsdthread_info(current_thread());
5109 if ((current_proc()->p_lflag
& P_LRAGE_VNODES
) ||
5110 (ut
->uu_flag
& UT_RAGE_VNODES
)) {
5112 * process has indicated that it wants any
5113 * vnodes created on its behalf to be rapidly
5114 * aged to reduce the impact on the cached set
5117 vp
->v_flag
|= VRAGE
;
5120 #if CONFIG_SECLUDED_MEMORY
5121 switch (secluded_for_filecache
) {
5124 * secluded_for_filecache == 0:
5125 * + no file contents in secluded pool
5130 * secluded_for_filecache == 1:
5132 * + files from /Applications/ are OK
5133 * + files from /Applications/Camera are not OK
5134 * + no files that are open for write
5136 if (vnode_vtype(vp
) == VREG
&&
5137 vnode_mount(vp
) != NULL
&&
5138 (! (vfs_flags(vnode_mount(vp
)) & MNT_ROOTFS
))) {
5139 /* not from root filesystem: eligible for secluded pages */
5140 memory_object_mark_eligible_for_secluded(
5141 ubc_getobject(vp
, UBC_FLAGS_NONE
),
5147 * secluded_for_filecache == 2:
5148 * + all read-only files OK, except:
5149 * + dyld_shared_cache_arm64*
5153 if (vnode_vtype(vp
) == VREG
) {
5154 memory_object_mark_eligible_for_secluded(
5155 ubc_getobject(vp
, UBC_FLAGS_NONE
),
5162 #endif /* CONFIG_SECLUDED_MEMORY */
5167 if (existing_vnode
) {
5174 * The following api creates a vnode and associates all the parameter specified in vnode_fsparam
5175 * structure and returns a vnode handle with a reference. device aliasing is handled here so checkalias
5176 * is obsoleted by this.
5179 vnode_create(uint32_t flavor
, uint32_t size
, void *data
, vnode_t
*vpp
)
5182 return (vnode_create_internal(flavor
, size
, data
, vpp
, 1));
5186 vnode_create_empty(vnode_t
*vpp
)
5189 return (vnode_create_internal(VNCREATE_FLAVOR
, VCREATESIZE
, NULL
,
5194 vnode_initialize(uint32_t flavor
, uint32_t size
, void *data
, vnode_t
*vpp
)
5196 if (*vpp
== NULLVP
) {
5197 panic("NULL vnode passed to vnode_initialize");
5199 #if DEVELOPMENT || DEBUG
5201 * We lock to check that vnode is fit for unlocked use in
5202 * vnode_create_internal.
5204 vnode_lock_spin(*vpp
);
5205 VNASSERT(((*vpp
)->v_iocount
== 1), *vpp
,
5206 ("vnode_initialize : iocount not 1, is %d", (*vpp
)->v_iocount
));
5207 VNASSERT(((*vpp
)->v_usecount
== 0), *vpp
,
5208 ("vnode_initialize : usecount not 0, is %d", (*vpp
)->v_usecount
));
5209 VNASSERT(((*vpp
)->v_lflag
& VL_DEAD
), *vpp
,
5210 ("vnode_initialize : v_lflag does not have VL_DEAD, is 0x%x",
5212 VNASSERT(((*vpp
)->v_data
== NULL
), *vpp
,
5213 ("vnode_initialize : v_data not NULL"));
5216 return (vnode_create_internal(flavor
, size
, data
, vpp
, 1));
5220 vnode_addfsref(vnode_t vp
)
5222 vnode_lock_spin(vp
);
5223 if (vp
->v_lflag
& VNAMED_FSHASH
)
5224 panic("add_fsref: vp already has named reference");
5225 if ((vp
->v_freelist
.tqe_prev
!= (struct vnode
**)0xdeadb))
5226 panic("addfsref: vp on the free list\n");
5227 vp
->v_lflag
|= VNAMED_FSHASH
;
5233 vnode_removefsref(vnode_t vp
)
5235 vnode_lock_spin(vp
);
5236 if ((vp
->v_lflag
& VNAMED_FSHASH
) == 0)
5237 panic("remove_fsref: no named reference");
5238 vp
->v_lflag
&= ~VNAMED_FSHASH
;
5246 vfs_iterate(int flags
, int (*callout
)(mount_t
, void *), void *arg
)
5251 int count
, actualcount
, i
;
5253 int indx_start
, indx_stop
, indx_incr
;
5254 int cb_dropref
= (flags
& VFS_ITERATE_CB_DROPREF
);
5256 count
= mount_getvfscnt();
5259 fsid_list
= (fsid_t
*)kalloc(count
* sizeof(fsid_t
));
5260 allocmem
= (void *)fsid_list
;
5262 actualcount
= mount_fillfsids(fsid_list
, count
);
5265 * Establish the iteration direction
5266 * VFS_ITERATE_TAIL_FIRST overrides default head first order (oldest first)
5268 if (flags
& VFS_ITERATE_TAIL_FIRST
) {
5269 indx_start
= actualcount
- 1;
5272 } else /* Head first by default */ {
5274 indx_stop
= actualcount
;
5278 for (i
=indx_start
; i
!= indx_stop
; i
+= indx_incr
) {
5280 /* obtain the mount point with iteration reference */
5281 mp
= mount_list_lookupby_fsid(&fsid_list
[i
], 0, 1);
5283 if(mp
== (struct mount
*)0)
5286 if (mp
->mnt_lflag
& (MNT_LDEAD
| MNT_LUNMOUNT
)) {
5294 /* iterate over all the vnodes */
5295 ret
= callout(mp
, arg
);
5298 * Drop the iterref here if the callback didn't do it.
5299 * Note: If cb_dropref is set the mp may no longer exist.
5306 case VFS_RETURNED_DONE
:
5307 if (ret
== VFS_RETURNED_DONE
) {
5313 case VFS_CLAIMED_DONE
:
5324 kfree(allocmem
, (count
* sizeof(fsid_t
)));
5329 * Update the vfsstatfs structure in the mountpoint.
5330 * MAC: Parameter eventtype added, indicating whether the event that
5331 * triggered this update came from user space, via a system call
5332 * (VFS_USER_EVENT) or an internal kernel call (VFS_KERNEL_EVENT).
5335 vfs_update_vfsstat(mount_t mp
, vfs_context_t ctx
, __unused
int eventtype
)
5341 * Request the attributes we want to propagate into
5342 * the per-mount vfsstat structure.
5345 VFSATTR_WANTED(&va
, f_iosize
);
5346 VFSATTR_WANTED(&va
, f_blocks
);
5347 VFSATTR_WANTED(&va
, f_bfree
);
5348 VFSATTR_WANTED(&va
, f_bavail
);
5349 VFSATTR_WANTED(&va
, f_bused
);
5350 VFSATTR_WANTED(&va
, f_files
);
5351 VFSATTR_WANTED(&va
, f_ffree
);
5352 VFSATTR_WANTED(&va
, f_bsize
);
5353 VFSATTR_WANTED(&va
, f_fssubtype
);
5355 if ((error
= vfs_getattr(mp
, &va
, ctx
)) != 0) {
5356 KAUTH_DEBUG("STAT - filesystem returned error %d", error
);
5360 if (eventtype
== VFS_USER_EVENT
) {
5361 error
= mac_mount_check_getattr(ctx
, mp
, &va
);
5367 * Unpack into the per-mount structure.
5369 * We only overwrite these fields, which are likely to change:
5377 * And these which are not, but which the FS has no other way
5378 * of providing to us:
5384 if (VFSATTR_IS_SUPPORTED(&va
, f_bsize
)) {
5385 /* 4822056 - protect against malformed server mount */
5386 mp
->mnt_vfsstat
.f_bsize
= (va
.f_bsize
> 0 ? va
.f_bsize
: 512);
5388 mp
->mnt_vfsstat
.f_bsize
= mp
->mnt_devblocksize
; /* default from the device block size */
5390 if (VFSATTR_IS_SUPPORTED(&va
, f_iosize
)) {
5391 mp
->mnt_vfsstat
.f_iosize
= va
.f_iosize
;
5393 mp
->mnt_vfsstat
.f_iosize
= 1024 * 1024; /* 1MB sensible I/O size */
5395 if (VFSATTR_IS_SUPPORTED(&va
, f_blocks
))
5396 mp
->mnt_vfsstat
.f_blocks
= va
.f_blocks
;
5397 if (VFSATTR_IS_SUPPORTED(&va
, f_bfree
))
5398 mp
->mnt_vfsstat
.f_bfree
= va
.f_bfree
;
5399 if (VFSATTR_IS_SUPPORTED(&va
, f_bavail
))
5400 mp
->mnt_vfsstat
.f_bavail
= va
.f_bavail
;
5401 if (VFSATTR_IS_SUPPORTED(&va
, f_bused
))
5402 mp
->mnt_vfsstat
.f_bused
= va
.f_bused
;
5403 if (VFSATTR_IS_SUPPORTED(&va
, f_files
))
5404 mp
->mnt_vfsstat
.f_files
= va
.f_files
;
5405 if (VFSATTR_IS_SUPPORTED(&va
, f_ffree
))
5406 mp
->mnt_vfsstat
.f_ffree
= va
.f_ffree
;
5408 /* this is unlikely to change, but has to be queried for */
5409 if (VFSATTR_IS_SUPPORTED(&va
, f_fssubtype
))
5410 mp
->mnt_vfsstat
.f_fssubtype
= va
.f_fssubtype
;
5416 mount_list_add(mount_t mp
)
5421 if (system_inshutdown
!= 0) {
5424 TAILQ_INSERT_TAIL(&mountlist
, mp
, mnt_list
);
5428 mount_list_unlock();
5434 mount_list_remove(mount_t mp
)
5437 TAILQ_REMOVE(&mountlist
, mp
, mnt_list
);
5439 mp
->mnt_list
.tqe_next
= NULL
;
5440 mp
->mnt_list
.tqe_prev
= NULL
;
5441 mount_list_unlock();
5445 mount_lookupby_volfsid(int volfs_id
, int withref
)
5447 mount_t cur_mount
= (mount_t
)0;
5451 TAILQ_FOREACH(mp
, &mountlist
, mnt_list
) {
5452 if (!(mp
->mnt_kern_flag
& MNTK_UNMOUNT
) &&
5453 (mp
->mnt_kern_flag
& MNTK_PATH_FROM_ID
) &&
5454 (mp
->mnt_vfsstat
.f_fsid
.val
[0] == volfs_id
)) {
5457 if (mount_iterref(cur_mount
, 1)) {
5458 cur_mount
= (mount_t
)0;
5459 mount_list_unlock();
5466 mount_list_unlock();
5467 if (withref
&& (cur_mount
!= (mount_t
)0)) {
5469 if (vfs_busy(mp
, LK_NOWAIT
) != 0) {
5470 cur_mount
= (mount_t
)0;
5479 mount_list_lookupby_fsid(fsid_t
*fsid
, int locked
, int withref
)
5481 mount_t retmp
= (mount_t
)0;
5486 TAILQ_FOREACH(mp
, &mountlist
, mnt_list
)
5487 if (mp
->mnt_vfsstat
.f_fsid
.val
[0] == fsid
->val
[0] &&
5488 mp
->mnt_vfsstat
.f_fsid
.val
[1] == fsid
->val
[1]) {
5491 if (mount_iterref(retmp
, 1))
5498 mount_list_unlock();
5503 vnode_lookup(const char *path
, int flags
, vnode_t
*vpp
, vfs_context_t ctx
)
5505 struct nameidata nd
;
5507 u_int32_t ndflags
= 0;
5513 if (flags
& VNODE_LOOKUP_NOFOLLOW
)
5518 if (flags
& VNODE_LOOKUP_NOCROSSMOUNT
)
5519 ndflags
|= NOCROSSMOUNT
;
5521 if (flags
& VNODE_LOOKUP_CROSSMOUNTNOWAIT
)
5522 ndflags
|= CN_NBMOUNTLOOK
;
5524 /* XXX AUDITVNPATH1 needed ? */
5525 NDINIT(&nd
, LOOKUP
, OP_LOOKUP
, ndflags
, UIO_SYSSPACE
,
5526 CAST_USER_ADDR_T(path
), ctx
);
5528 if ((error
= namei(&nd
)))
5537 vnode_open(const char *path
, int fmode
, int cmode
, int flags
, vnode_t
*vpp
, vfs_context_t ctx
)
5539 struct nameidata nd
;
5541 u_int32_t ndflags
= 0;
5544 if (ctx
== NULL
) { /* XXX technically an error */
5545 ctx
= vfs_context_current();
5548 if (fmode
& O_NOFOLLOW
)
5549 lflags
|= VNODE_LOOKUP_NOFOLLOW
;
5551 if (lflags
& VNODE_LOOKUP_NOFOLLOW
)
5556 if (lflags
& VNODE_LOOKUP_NOCROSSMOUNT
)
5557 ndflags
|= NOCROSSMOUNT
;
5559 if (lflags
& VNODE_LOOKUP_CROSSMOUNTNOWAIT
)
5560 ndflags
|= CN_NBMOUNTLOOK
;
5562 /* XXX AUDITVNPATH1 needed ? */
5563 NDINIT(&nd
, LOOKUP
, OP_OPEN
, ndflags
, UIO_SYSSPACE
,
5564 CAST_USER_ADDR_T(path
), ctx
);
5566 if ((error
= vn_open(&nd
, fmode
, cmode
)))
5575 vnode_close(vnode_t vp
, int flags
, vfs_context_t ctx
)
5580 ctx
= vfs_context_current();
5583 error
= vn_close(vp
, flags
, ctx
);
5589 vnode_mtime(vnode_t vp
, struct timespec
*mtime
, vfs_context_t ctx
)
5591 struct vnode_attr va
;
5595 VATTR_WANTED(&va
, va_modify_time
);
5596 error
= vnode_getattr(vp
, &va
, ctx
);
5598 *mtime
= va
.va_modify_time
;
5603 vnode_flags(vnode_t vp
, uint32_t *flags
, vfs_context_t ctx
)
5605 struct vnode_attr va
;
5609 VATTR_WANTED(&va
, va_flags
);
5610 error
= vnode_getattr(vp
, &va
, ctx
);
5612 *flags
= va
.va_flags
;
5617 * Returns: 0 Success
5621 vnode_size(vnode_t vp
, off_t
*sizep
, vfs_context_t ctx
)
5623 struct vnode_attr va
;
5627 VATTR_WANTED(&va
, va_data_size
);
5628 error
= vnode_getattr(vp
, &va
, ctx
);
5630 *sizep
= va
.va_data_size
;
5635 vnode_setsize(vnode_t vp
, off_t size
, int ioflag
, vfs_context_t ctx
)
5637 struct vnode_attr va
;
5640 VATTR_SET(&va
, va_data_size
, size
);
5641 va
.va_vaflags
= ioflag
& 0xffff;
5642 return(vnode_setattr(vp
, &va
, ctx
));
5646 vnode_setdirty(vnode_t vp
)
5648 vnode_lock_spin(vp
);
5649 vp
->v_flag
|= VISDIRTY
;
5655 vnode_cleardirty(vnode_t vp
)
5657 vnode_lock_spin(vp
);
5658 vp
->v_flag
&= ~VISDIRTY
;
5664 vnode_isdirty(vnode_t vp
)
5668 vnode_lock_spin(vp
);
5669 dirty
= (vp
->v_flag
& VISDIRTY
) ? 1 : 0;
5676 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
)
5678 /* Only use compound VNOP for compound operation */
5679 if (vnode_compound_open_available(dvp
) && ((flags
& VN_CREATE_DOOPEN
) != 0)) {
5681 return VNOP_COMPOUND_OPEN(dvp
, vpp
, ndp
, O_CREAT
, fmode
, statusp
, vap
, ctx
);
5683 return VNOP_CREATE(dvp
, vpp
, &ndp
->ni_cnd
, vap
, ctx
);
5688 * Create a filesystem object of arbitrary type with arbitrary attributes in
5689 * the spevied directory with the specified name.
5691 * Parameters: dvp Pointer to the vnode of the directory
5692 * in which to create the object.
5693 * vpp Pointer to the area into which to
5694 * return the vnode of the created object.
5695 * cnp Component name pointer from the namei
5696 * data structure, containing the name to
5697 * use for the create object.
5698 * vap Pointer to the vnode_attr structure
5699 * describing the object to be created,
5700 * including the type of object.
5701 * flags VN_* flags controlling ACL inheritance
5702 * and whether or not authorization is to
5703 * be required for the operation.
5705 * Returns: 0 Success
5708 * Implicit: *vpp Contains the vnode of the object that
5709 * was created, if successful.
5710 * *cnp May be modified by the underlying VFS.
5711 * *vap May be modified by the underlying VFS.
5712 * modified by either ACL inheritance or
5715 * be modified, even if the operation is
5718 * Notes: The kauth_filesec_t in 'vap', if any, is in host byte order.
5720 * Modification of '*cnp' and '*vap' by the underlying VFS is
5721 * strongly discouraged.
5723 * XXX: This function is a 'vn_*' function; it belongs in vfs_vnops.c
5725 * XXX: We should enummerate the possible errno values here, and where
5726 * in the code they originated.
5729 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
)
5731 errno_t error
, old_error
;
5732 vnode_t vp
= (vnode_t
)0;
5734 struct componentname
*cnp
;
5739 batched
= namei_compound_available(dvp
, ndp
) ? TRUE
: FALSE
;
5741 KAUTH_DEBUG("%p CREATE - '%s'", dvp
, cnp
->cn_nameptr
);
5743 if (flags
& VN_CREATE_NOINHERIT
)
5744 vap
->va_vaflags
|= VA_NOINHERIT
;
5745 if (flags
& VN_CREATE_NOAUTH
)
5746 vap
->va_vaflags
|= VA_NOAUTH
;
5748 * Handle ACL inheritance, initialize vap.
5750 error
= vn_attribute_prepare(dvp
, vap
, &defaulted
, ctx
);
5755 if (vap
->va_type
!= VREG
&& (fmode
!= 0 || (flags
& VN_CREATE_DOOPEN
) || statusp
)) {
5756 panic("Open parameters, but not a regular file.");
5758 if ((fmode
!= 0) && ((flags
& VN_CREATE_DOOPEN
) == 0)) {
5759 panic("Mode for open, but not trying to open...");
5764 * Create the requested node.
5766 switch(vap
->va_type
) {
5768 error
= vn_create_reg(dvp
, vpp
, ndp
, vap
, flags
, fmode
, statusp
, ctx
);
5771 error
= vn_mkdir(dvp
, vpp
, ndp
, vap
, ctx
);
5777 error
= VNOP_MKNOD(dvp
, vpp
, cnp
, vap
, ctx
);
5780 panic("vnode_create: unknown vtype %d", vap
->va_type
);
5783 KAUTH_DEBUG("%p CREATE - error %d returned by filesystem", dvp
, error
);
5791 if (!(flags
& VN_CREATE_NOLABEL
)) {
5792 error
= vnode_label(vnode_mount(vp
), dvp
, vp
, cnp
, VNODE_LABEL_CREATE
, ctx
);
5799 * If some of the requested attributes weren't handled by the VNOP,
5800 * use our fallback code.
5802 if (!VATTR_ALL_SUPPORTED(vap
) && *vpp
) {
5803 KAUTH_DEBUG(" CREATE - doing fallback with ACL %p", vap
->va_acl
);
5804 error
= vnode_setattr_fallback(*vpp
, vap
, ctx
);
5809 if ((error
!= 0) && (vp
!= (vnode_t
)0)) {
5811 /* If we've done a compound open, close */
5812 if (batched
&& (old_error
== 0) && (vap
->va_type
== VREG
)) {
5813 VNOP_CLOSE(vp
, fmode
, ctx
);
5816 /* Need to provide notifications if a create succeeded */
5824 vn_attribute_cleanup(vap
, defaulted
);
5829 static kauth_scope_t vnode_scope
;
5830 static int vnode_authorize_callback(kauth_cred_t credential
, void *idata
, kauth_action_t action
,
5831 uintptr_t arg0
, uintptr_t arg1
, uintptr_t arg2
, uintptr_t arg3
);
5832 static int vnode_authorize_callback_int(kauth_action_t action
, vfs_context_t ctx
,
5833 vnode_t vp
, vnode_t dvp
, int *errorp
);
5835 typedef struct _vnode_authorize_context
{
5837 struct vnode_attr
*vap
;
5839 struct vnode_attr
*dvap
;
5843 #define _VAC_IS_OWNER (1<<0)
5844 #define _VAC_IN_GROUP (1<<1)
5845 #define _VAC_IS_DIR_OWNER (1<<2)
5846 #define _VAC_IN_DIR_GROUP (1<<3)
5847 #define _VAC_NO_VNODE_POINTERS (1<<4)
5851 vnode_authorize_init(void)
5853 vnode_scope
= kauth_register_scope(KAUTH_SCOPE_VNODE
, vnode_authorize_callback
, NULL
);
5856 #define VATTR_PREPARE_DEFAULTED_UID 0x1
5857 #define VATTR_PREPARE_DEFAULTED_GID 0x2
5858 #define VATTR_PREPARE_DEFAULTED_MODE 0x4
5861 vn_attribute_prepare(vnode_t dvp
, struct vnode_attr
*vap
, uint32_t *defaulted_fieldsp
, vfs_context_t ctx
)
5863 kauth_acl_t nacl
= NULL
, oacl
= NULL
;
5867 * Handle ACL inheritance.
5869 if (!(vap
->va_vaflags
& VA_NOINHERIT
) && vfs_extendedsecurity(dvp
->v_mount
)) {
5870 /* save the original filesec */
5871 if (VATTR_IS_ACTIVE(vap
, va_acl
)) {
5876 if ((error
= kauth_acl_inherit(dvp
,
5879 vap
->va_type
== VDIR
,
5881 KAUTH_DEBUG("%p CREATE - error %d processing inheritance", dvp
, error
);
5886 * If the generated ACL is NULL, then we can save ourselves some effort
5887 * by clearing the active bit.
5890 VATTR_CLEAR_ACTIVE(vap
, va_acl
);
5892 vap
->va_base_acl
= oacl
;
5893 VATTR_SET(vap
, va_acl
, nacl
);
5897 error
= vnode_authattr_new_internal(dvp
, vap
, (vap
->va_vaflags
& VA_NOAUTH
), defaulted_fieldsp
, ctx
);
5899 vn_attribute_cleanup(vap
, *defaulted_fieldsp
);
5906 vn_attribute_cleanup(struct vnode_attr
*vap
, uint32_t defaulted_fields
)
5909 * If the caller supplied a filesec in vap, it has been replaced
5910 * now by the post-inheritance copy. We need to put the original back
5911 * and free the inherited product.
5913 kauth_acl_t nacl
, oacl
;
5915 if (VATTR_IS_ACTIVE(vap
, va_acl
)) {
5917 oacl
= vap
->va_base_acl
;
5920 VATTR_SET(vap
, va_acl
, oacl
);
5921 vap
->va_base_acl
= NULL
;
5923 VATTR_CLEAR_ACTIVE(vap
, va_acl
);
5927 kauth_acl_free(nacl
);
5931 if ((defaulted_fields
& VATTR_PREPARE_DEFAULTED_MODE
) != 0) {
5932 VATTR_CLEAR_ACTIVE(vap
, va_mode
);
5934 if ((defaulted_fields
& VATTR_PREPARE_DEFAULTED_GID
) != 0) {
5935 VATTR_CLEAR_ACTIVE(vap
, va_gid
);
5937 if ((defaulted_fields
& VATTR_PREPARE_DEFAULTED_UID
) != 0) {
5938 VATTR_CLEAR_ACTIVE(vap
, va_uid
);
5945 vn_authorize_unlink(vnode_t dvp
, vnode_t vp
, struct componentname
*cnp
, vfs_context_t ctx
, __unused
void *reserved
)
5953 * Normally, unlinking of directories is not supported.
5954 * However, some file systems may have limited support.
5956 if ((vp
->v_type
== VDIR
) &&
5957 !(vp
->v_mount
->mnt_kern_flag
& MNTK_DIR_HARDLINKS
)) {
5958 return (EPERM
); /* POSIX */
5961 /* authorize the delete operation */
5964 error
= mac_vnode_check_unlink(ctx
, dvp
, vp
, cnp
);
5967 error
= vnode_authorize(vp
, dvp
, KAUTH_VNODE_DELETE
, ctx
);
5973 vn_authorize_open_existing(vnode_t vp
, struct componentname
*cnp
, int fmode
, vfs_context_t ctx
, void *reserved
)
5975 /* Open of existing case */
5976 kauth_action_t action
;
5978 if (cnp
->cn_ndp
== NULL
) {
5981 if (reserved
!= NULL
) {
5982 panic("reserved not NULL.");
5986 /* XXX may do duplicate work here, but ignore that for now (idempotent) */
5987 if (vfs_flags(vnode_mount(vp
)) & MNT_MULTILABEL
) {
5988 error
= vnode_label(vnode_mount(vp
), NULL
, vp
, NULL
, 0, ctx
);
5994 if ( (fmode
& O_DIRECTORY
) && vp
->v_type
!= VDIR
) {
5998 if (vp
->v_type
== VSOCK
&& vp
->v_tag
!= VT_FDESC
) {
5999 return (EOPNOTSUPP
); /* Operation not supported on socket */
6002 if (vp
->v_type
== VLNK
&& (fmode
& O_NOFOLLOW
) != 0) {
6003 return (ELOOP
); /* O_NOFOLLOW was specified and the target is a symbolic link */
6006 /* disallow write operations on directories */
6007 if (vnode_isdir(vp
) && (fmode
& (FWRITE
| O_TRUNC
))) {
6011 if ((cnp
->cn_ndp
->ni_flag
& NAMEI_TRAILINGSLASH
)) {
6012 if (vp
->v_type
!= VDIR
) {
6018 /* If a file being opened is a shadow file containing
6019 * namedstream data, ignore the macf checks because it
6020 * is a kernel internal file and access should always
6023 if (!(vnode_isshadow(vp
) && vnode_isnamedstream(vp
))) {
6024 error
= mac_vnode_check_open(ctx
, vp
, fmode
);
6031 /* compute action to be authorized */
6033 if (fmode
& FREAD
) {
6034 action
|= KAUTH_VNODE_READ_DATA
;
6036 if (fmode
& (FWRITE
| O_TRUNC
)) {
6038 * If we are writing, appending, and not truncating,
6039 * indicate that we are appending so that if the
6040 * UF_APPEND or SF_APPEND bits are set, we do not deny
6043 if ((fmode
& O_APPEND
) && !(fmode
& O_TRUNC
)) {
6044 action
|= KAUTH_VNODE_APPEND_DATA
;
6046 action
|= KAUTH_VNODE_WRITE_DATA
;
6049 error
= vnode_authorize(vp
, NULL
, action
, ctx
);
6051 if (error
== EACCES
) {
6053 * Shadow files may exist on-disk with a different UID/GID
6054 * than that of the current context. Verify that this file
6055 * is really a shadow file. If it was created successfully
6056 * then it should be authorized.
6058 if (vnode_isshadow(vp
) && vnode_isnamedstream (vp
)) {
6059 error
= vnode_verifynamedstream(vp
);
6068 vn_authorize_create(vnode_t dvp
, struct componentname
*cnp
, struct vnode_attr
*vap
, vfs_context_t ctx
, void *reserved
)
6076 if (cnp
->cn_ndp
== NULL
) {
6077 panic("NULL cn_ndp");
6079 if (reserved
!= NULL
) {
6080 panic("reserved not NULL.");
6083 /* Only validate path for creation if we didn't do a complete lookup */
6084 if (cnp
->cn_ndp
->ni_flag
& NAMEI_UNFINISHED
) {
6085 error
= lookup_validate_creation_path(cnp
->cn_ndp
);
6091 error
= mac_vnode_check_create(ctx
, dvp
, cnp
, vap
);
6094 #endif /* CONFIG_MACF */
6096 return (vnode_authorize(dvp
, NULL
, KAUTH_VNODE_ADD_FILE
, ctx
));
6100 vn_authorize_rename(struct vnode
*fdvp
, struct vnode
*fvp
, struct componentname
*fcnp
,
6101 struct vnode
*tdvp
, struct vnode
*tvp
, struct componentname
*tcnp
,
6102 vfs_context_t ctx
, void *reserved
)
6104 return vn_authorize_renamex(fdvp
, fvp
, fcnp
, tdvp
, tvp
, tcnp
, ctx
, 0, reserved
);
6108 vn_authorize_renamex(struct vnode
*fdvp
, struct vnode
*fvp
, struct componentname
*fcnp
,
6109 struct vnode
*tdvp
, struct vnode
*tvp
, struct componentname
*tcnp
,
6110 vfs_context_t ctx
, vfs_rename_flags_t flags
, void *reserved
)
6114 bool swap
= flags
& VFS_RENAME_SWAP
;
6116 if (reserved
!= NULL
) {
6117 panic("Passed something other than NULL as reserved field!");
6121 * Avoid renaming "." and "..".
6123 * XXX No need to check for this in the FS. We should always have the leaves
6124 * in VFS in this case.
6126 if (fvp
->v_type
== VDIR
&&
6128 (fcnp
->cn_namelen
== 1 && fcnp
->cn_nameptr
[0] == '.') ||
6129 ((fcnp
->cn_flags
| tcnp
->cn_flags
) & ISDOTDOT
)) ) {
6134 if (tvp
== NULLVP
&& vnode_compound_rename_available(tdvp
)) {
6135 error
= lookup_validate_creation_path(tcnp
->cn_ndp
);
6140 /***** <MACF> *****/
6142 error
= mac_vnode_check_rename(ctx
, fdvp
, fvp
, fcnp
, tdvp
, tvp
, tcnp
);
6146 error
= mac_vnode_check_rename(ctx
, tdvp
, tvp
, tcnp
, fdvp
, fvp
, fcnp
);
6151 /***** </MACF> *****/
6153 /***** <MiscChecks> *****/
6156 if (fvp
->v_type
== VDIR
&& tvp
->v_type
!= VDIR
) {
6159 } else if (fvp
->v_type
!= VDIR
&& tvp
->v_type
== VDIR
) {
6166 * Caller should have already checked this and returned
6167 * ENOENT. If we send back ENOENT here, caller will retry
6168 * which isn't what we want so we send back EINVAL here
6181 * The following edge case is caught here:
6182 * (to cannot be a descendent of from)
6195 if (tdvp
->v_parent
== fvp
) {
6200 if (swap
&& fdvp
->v_parent
== tvp
) {
6204 /***** </MiscChecks> *****/
6206 /***** <Kauth> *****/
6209 kauth_action_t f
= 0, t
= 0;
6212 * Directories changing parents need ...ADD_SUBDIR... to
6213 * permit changing ".."
6216 if (vnode_isdir(fvp
))
6217 f
= KAUTH_VNODE_ADD_SUBDIRECTORY
;
6218 if (vnode_isdir(tvp
))
6219 t
= KAUTH_VNODE_ADD_SUBDIRECTORY
;
6221 error
= vnode_authorize(fvp
, fdvp
, KAUTH_VNODE_DELETE
| f
, ctx
);
6224 error
= vnode_authorize(tvp
, tdvp
, KAUTH_VNODE_DELETE
| t
, ctx
);
6227 f
= vnode_isdir(fvp
) ? KAUTH_VNODE_ADD_SUBDIRECTORY
: KAUTH_VNODE_ADD_FILE
;
6228 t
= vnode_isdir(tvp
) ? KAUTH_VNODE_ADD_SUBDIRECTORY
: KAUTH_VNODE_ADD_FILE
;
6230 error
= vnode_authorize(fdvp
, NULL
, f
| t
, ctx
);
6232 error
= vnode_authorize(fdvp
, NULL
, t
, ctx
);
6235 error
= vnode_authorize(tdvp
, NULL
, f
, ctx
);
6241 if ((tvp
!= NULL
) && vnode_isdir(tvp
)) {
6244 } else if (tdvp
!= fdvp
) {
6249 * must have delete rights to remove the old name even in
6250 * the simple case of fdvp == tdvp.
6252 * If fvp is a directory, and we are changing it's parent,
6253 * then we also need rights to rewrite its ".." entry as well.
6255 if (vnode_isdir(fvp
)) {
6256 if ((error
= vnode_authorize(fvp
, fdvp
, KAUTH_VNODE_DELETE
| KAUTH_VNODE_ADD_SUBDIRECTORY
, ctx
)) != 0)
6259 if ((error
= vnode_authorize(fvp
, fdvp
, KAUTH_VNODE_DELETE
, ctx
)) != 0)
6263 /* moving into tdvp or tvp, must have rights to add */
6264 if ((error
= vnode_authorize(((tvp
!= NULL
) && vnode_isdir(tvp
)) ? tvp
: tdvp
,
6266 vnode_isdir(fvp
) ? KAUTH_VNODE_ADD_SUBDIRECTORY
: KAUTH_VNODE_ADD_FILE
,
6271 /* node staying in same directory, must be allowed to add new name */
6272 if ((error
= vnode_authorize(fdvp
, NULL
,
6273 vnode_isdir(fvp
) ? KAUTH_VNODE_ADD_SUBDIRECTORY
: KAUTH_VNODE_ADD_FILE
, ctx
)) != 0)
6276 /* overwriting tvp */
6277 if ((tvp
!= NULL
) && !vnode_isdir(tvp
) &&
6278 ((error
= vnode_authorize(tvp
, tdvp
, KAUTH_VNODE_DELETE
, ctx
)) != 0)) {
6283 /***** </Kauth> *****/
6285 /* XXX more checks? */
6291 vn_authorize_mkdir(vnode_t dvp
, struct componentname
*cnp
, struct vnode_attr
*vap
, vfs_context_t ctx
, void *reserved
)
6298 if (reserved
!= NULL
) {
6299 panic("reserved not NULL in vn_authorize_mkdir()");
6302 /* XXX A hack for now, to make shadow files work */
6303 if (cnp
->cn_ndp
== NULL
) {
6307 if (vnode_compound_mkdir_available(dvp
)) {
6308 error
= lookup_validate_creation_path(cnp
->cn_ndp
);
6314 error
= mac_vnode_check_create(ctx
,
6320 /* authorize addition of a directory to the parent */
6321 if ((error
= vnode_authorize(dvp
, NULL
, KAUTH_VNODE_ADD_SUBDIRECTORY
, ctx
)) != 0)
6329 vn_authorize_rmdir(vnode_t dvp
, vnode_t vp
, struct componentname
*cnp
, vfs_context_t ctx
, void *reserved
)
6336 if (reserved
!= NULL
) {
6337 panic("Non-NULL reserved argument to vn_authorize_rmdir()");
6340 if (vp
->v_type
!= VDIR
) {
6342 * rmdir only deals with directories
6349 * No rmdir "." please.
6355 error
= mac_vnode_check_unlink(ctx
, dvp
,
6361 return vnode_authorize(vp
, dvp
, KAUTH_VNODE_DELETE
, ctx
);
6365 * Authorizer for directory cloning. This does not use vnodes but instead
6366 * uses prefilled vnode attributes from the filesystem.
6368 * The same function is called to set up the attributes required, perform the
6369 * authorization and cleanup (if required)
6372 vnode_attr_authorize_dir_clone(struct vnode_attr
*vap
, kauth_action_t action
,
6373 struct vnode_attr
*dvap
, __unused vnode_t sdvp
, mount_t mp
,
6374 dir_clone_authorizer_op_t vattr_op
, vfs_context_t ctx
,
6375 __unused
void *reserved
)
6378 int is_suser
= vfs_context_issuser(ctx
);
6380 if (vattr_op
== OP_VATTR_SETUP
) {
6384 * When ACL inheritence is implemented, both vap->va_acl and
6385 * dvap->va_acl will be required (even as superuser).
6387 VATTR_WANTED(vap
, va_type
);
6388 VATTR_WANTED(vap
, va_mode
);
6389 VATTR_WANTED(vap
, va_flags
);
6390 VATTR_WANTED(vap
, va_uid
);
6391 VATTR_WANTED(vap
, va_gid
);
6394 VATTR_WANTED(dvap
, va_flags
);
6399 * If not superuser, we have to evaluate ACLs and
6400 * need the target directory gid to set the initial
6401 * gid of the new object.
6403 VATTR_WANTED(vap
, va_acl
);
6405 VATTR_WANTED(dvap
, va_gid
);
6409 } else if (vattr_op
== OP_VATTR_CLEANUP
) {
6410 return (0); /* Nothing to do for now */
6413 /* dvap isn't used for authorization */
6414 error
= vnode_attr_authorize(vap
, NULL
, mp
, action
, ctx
);
6420 * vn_attribute_prepare should be able to accept attributes as well as
6421 * vnodes but for now we do this inline.
6425 * If the filesystem is mounted IGNORE_OWNERSHIP and an explicit
6426 * owner is set, that owner takes ownership of all new files.
6428 if ((mp
->mnt_flag
& MNT_IGNORE_OWNERSHIP
) &&
6429 (mp
->mnt_fsowner
!= KAUTH_UID_NONE
)) {
6430 VATTR_SET(vap
, va_uid
, mp
->mnt_fsowner
);
6432 /* default owner is current user */
6433 VATTR_SET(vap
, va_uid
,
6434 kauth_cred_getuid(vfs_context_ucred(ctx
)));
6437 if ((mp
->mnt_flag
& MNT_IGNORE_OWNERSHIP
) &&
6438 (mp
->mnt_fsgroup
!= KAUTH_GID_NONE
)) {
6439 VATTR_SET(vap
, va_gid
, mp
->mnt_fsgroup
);
6442 * default group comes from parent object,
6443 * fallback to current user
6445 if (VATTR_IS_SUPPORTED(dvap
, va_gid
)) {
6446 VATTR_SET(vap
, va_gid
, dvap
->va_gid
);
6448 VATTR_SET(vap
, va_gid
,
6449 kauth_cred_getgid(vfs_context_ucred(ctx
)));
6454 /* Inherit SF_RESTRICTED bit from destination directory only */
6455 if (VATTR_IS_ACTIVE(vap
, va_flags
)) {
6456 VATTR_SET(vap
, va_flags
,
6457 ((vap
->va_flags
& ~SF_RESTRICTED
))); /* Turn off from source */
6458 if (VATTR_IS_ACTIVE(dvap
, va_flags
))
6459 VATTR_SET(vap
, va_flags
,
6460 vap
->va_flags
| (dvap
->va_flags
& SF_RESTRICTED
));
6461 } else if (VATTR_IS_ACTIVE(dvap
, va_flags
)) {
6462 VATTR_SET(vap
, va_flags
, (dvap
->va_flags
& SF_RESTRICTED
));
6470 * Authorize an operation on a vnode.
6472 * This is KPI, but here because it needs vnode_scope.
6474 * Returns: 0 Success
6475 * kauth_authorize_action:EPERM ...
6476 * xlate => EACCES Permission denied
6477 * kauth_authorize_action:0 Success
6478 * kauth_authorize_action: Depends on callback return; this is
6479 * usually only vnode_authorize_callback(),
6480 * but may include other listerners, if any
6488 vnode_authorize(vnode_t vp
, vnode_t dvp
, kauth_action_t action
, vfs_context_t ctx
)
6493 * We can't authorize against a dead vnode; allow all operations through so that
6494 * the correct error can be returned.
6496 if (vp
->v_type
== VBAD
)
6500 result
= kauth_authorize_action(vnode_scope
, vfs_context_ucred(ctx
), action
,
6501 (uintptr_t)ctx
, (uintptr_t)vp
, (uintptr_t)dvp
, (uintptr_t)&error
);
6502 if (result
== EPERM
) /* traditional behaviour */
6504 /* did the lower layers give a better error return? */
6505 if ((result
!= 0) && (error
!= 0))
6511 * Test for vnode immutability.
6513 * The 'append' flag is set when the authorization request is constrained
6514 * to operations which only request the right to append to a file.
6516 * The 'ignore' flag is set when an operation modifying the immutability flags
6517 * is being authorized. We check the system securelevel to determine which
6518 * immutability flags we can ignore.
6521 vnode_immutable(struct vnode_attr
*vap
, int append
, int ignore
)
6525 /* start with all bits precluding the operation */
6526 mask
= IMMUTABLE
| APPEND
;
6528 /* if appending only, remove the append-only bits */
6532 /* ignore only set when authorizing flags changes */
6534 if (securelevel
<= 0) {
6535 /* in insecure state, flags do not inhibit changes */
6538 /* in secure state, user flags don't inhibit */
6539 mask
&= ~(UF_IMMUTABLE
| UF_APPEND
);
6542 KAUTH_DEBUG("IMMUTABLE - file flags 0x%x mask 0x%x append = %d ignore = %d", vap
->va_flags
, mask
, append
, ignore
);
6543 if ((vap
->va_flags
& mask
) != 0)
6549 vauth_node_owner(struct vnode_attr
*vap
, kauth_cred_t cred
)
6553 /* default assumption is not-owner */
6557 * If the filesystem has given us a UID, we treat this as authoritative.
6559 if (vap
&& VATTR_IS_SUPPORTED(vap
, va_uid
)) {
6560 result
= (vap
->va_uid
== kauth_cred_getuid(cred
)) ? 1 : 0;
6562 /* we could test the owner UUID here if we had a policy for it */
6570 * Description: Ask if a cred is a member of the group owning the vnode object
6572 * Parameters: vap vnode attribute
6573 * vap->va_gid group owner of vnode object
6574 * cred credential to check
6575 * ismember pointer to where to put the answer
6576 * idontknow Return this if we can't get an answer
6578 * Returns: 0 Success
6579 * idontknow Can't get information
6580 * kauth_cred_ismember_gid:? Error from kauth subsystem
6581 * kauth_cred_ismember_gid:? Error from kauth subsystem
6584 vauth_node_group(struct vnode_attr
*vap
, kauth_cred_t cred
, int *ismember
, int idontknow
)
6593 * The caller is expected to have asked the filesystem for a group
6594 * at some point prior to calling this function. The answer may
6595 * have been that there is no group ownership supported for the
6596 * vnode object, in which case we return
6598 if (vap
&& VATTR_IS_SUPPORTED(vap
, va_gid
)) {
6599 error
= kauth_cred_ismember_gid(cred
, vap
->va_gid
, &result
);
6601 * Credentials which are opted into external group membership
6602 * resolution which are not known to the external resolver
6603 * will result in an ENOENT error. We translate this into
6604 * the appropriate 'idontknow' response for our caller.
6606 * XXX We do not make a distinction here between an ENOENT
6607 * XXX arising from a response from the external resolver,
6608 * XXX and an ENOENT which is internally generated. This is
6609 * XXX a deficiency of the published kauth_cred_ismember_gid()
6610 * XXX KPI which can not be overcome without new KPI. For
6611 * XXX all currently known cases, however, this wil result
6612 * XXX in correct behaviour.
6614 if (error
== ENOENT
)
6618 * XXX We could test the group UUID here if we had a policy for it,
6619 * XXX but this is problematic from the perspective of synchronizing
6620 * XXX group UUID and POSIX GID ownership of a file and keeping the
6621 * XXX values coherent over time. The problem is that the local
6622 * XXX system will vend transient group UUIDs for unknown POSIX GID
6623 * XXX values, and these are not persistent, whereas storage of values
6624 * XXX is persistent. One potential solution to this is a local
6625 * XXX (persistent) replica of remote directory entries and vended
6626 * XXX local ids in a local directory server (think in terms of a
6627 * XXX caching DNS server).
6636 vauth_file_owner(vauth_ctx vcp
)
6640 if (vcp
->flags_valid
& _VAC_IS_OWNER
) {
6641 result
= (vcp
->flags
& _VAC_IS_OWNER
) ? 1 : 0;
6643 result
= vauth_node_owner(vcp
->vap
, vcp
->ctx
->vc_ucred
);
6645 /* cache our result */
6646 vcp
->flags_valid
|= _VAC_IS_OWNER
;
6648 vcp
->flags
|= _VAC_IS_OWNER
;
6650 vcp
->flags
&= ~_VAC_IS_OWNER
;
6658 * vauth_file_ingroup
6660 * Description: Ask if a user is a member of the group owning the directory
6662 * Parameters: vcp The vnode authorization context that
6663 * contains the user and directory info
6664 * vcp->flags_valid Valid flags
6665 * vcp->flags Flags values
6666 * vcp->vap File vnode attributes
6667 * vcp->ctx VFS Context (for user)
6668 * ismember pointer to where to put the answer
6669 * idontknow Return this if we can't get an answer
6671 * Returns: 0 Success
6672 * vauth_node_group:? Error from vauth_node_group()
6674 * Implicit returns: *ismember 0 The user is not a group member
6675 * 1 The user is a group member
6678 vauth_file_ingroup(vauth_ctx vcp
, int *ismember
, int idontknow
)
6682 /* Check for a cached answer first, to avoid the check if possible */
6683 if (vcp
->flags_valid
& _VAC_IN_GROUP
) {
6684 *ismember
= (vcp
->flags
& _VAC_IN_GROUP
) ? 1 : 0;
6687 /* Otherwise, go look for it */
6688 error
= vauth_node_group(vcp
->vap
, vcp
->ctx
->vc_ucred
, ismember
, idontknow
);
6691 /* cache our result */
6692 vcp
->flags_valid
|= _VAC_IN_GROUP
;
6694 vcp
->flags
|= _VAC_IN_GROUP
;
6696 vcp
->flags
&= ~_VAC_IN_GROUP
;
6705 vauth_dir_owner(vauth_ctx vcp
)
6709 if (vcp
->flags_valid
& _VAC_IS_DIR_OWNER
) {
6710 result
= (vcp
->flags
& _VAC_IS_DIR_OWNER
) ? 1 : 0;
6712 result
= vauth_node_owner(vcp
->dvap
, vcp
->ctx
->vc_ucred
);
6714 /* cache our result */
6715 vcp
->flags_valid
|= _VAC_IS_DIR_OWNER
;
6717 vcp
->flags
|= _VAC_IS_DIR_OWNER
;
6719 vcp
->flags
&= ~_VAC_IS_DIR_OWNER
;
6728 * Description: Ask if a user is a member of the group owning the directory
6730 * Parameters: vcp The vnode authorization context that
6731 * contains the user and directory info
6732 * vcp->flags_valid Valid flags
6733 * vcp->flags Flags values
6734 * vcp->dvap Dir vnode attributes
6735 * vcp->ctx VFS Context (for user)
6736 * ismember pointer to where to put the answer
6737 * idontknow Return this if we can't get an answer
6739 * Returns: 0 Success
6740 * vauth_node_group:? Error from vauth_node_group()
6742 * Implicit returns: *ismember 0 The user is not a group member
6743 * 1 The user is a group member
6746 vauth_dir_ingroup(vauth_ctx vcp
, int *ismember
, int idontknow
)
6750 /* Check for a cached answer first, to avoid the check if possible */
6751 if (vcp
->flags_valid
& _VAC_IN_DIR_GROUP
) {
6752 *ismember
= (vcp
->flags
& _VAC_IN_DIR_GROUP
) ? 1 : 0;
6755 /* Otherwise, go look for it */
6756 error
= vauth_node_group(vcp
->dvap
, vcp
->ctx
->vc_ucred
, ismember
, idontknow
);
6759 /* cache our result */
6760 vcp
->flags_valid
|= _VAC_IN_DIR_GROUP
;
6762 vcp
->flags
|= _VAC_IN_DIR_GROUP
;
6764 vcp
->flags
&= ~_VAC_IN_DIR_GROUP
;
6772 * Test the posix permissions in (vap) to determine whether (credential)
6773 * may perform (action)
6776 vnode_authorize_posix(vauth_ctx vcp
, int action
, int on_dir
)
6778 struct vnode_attr
*vap
;
6779 int needed
, error
, owner_ok
, group_ok
, world_ok
, ismember
;
6780 #ifdef KAUTH_DEBUG_ENABLE
6781 const char *where
= "uninitialized";
6782 # define _SETWHERE(c) where = c;
6784 # define _SETWHERE(c)
6787 /* checking file or directory? */
6797 * We want to do as little work here as possible. So first we check
6798 * which sets of permissions grant us the access we need, and avoid checking
6799 * whether specific permissions grant access when more generic ones would.
6802 /* owner permissions */
6806 if (action
& VWRITE
)
6810 owner_ok
= (needed
& vap
->va_mode
) == needed
;
6812 /* group permissions */
6816 if (action
& VWRITE
)
6820 group_ok
= (needed
& vap
->va_mode
) == needed
;
6822 /* world permissions */
6826 if (action
& VWRITE
)
6830 world_ok
= (needed
& vap
->va_mode
) == needed
;
6832 /* If granted/denied by all three, we're done */
6833 if (owner_ok
&& group_ok
&& world_ok
) {
6837 if (!owner_ok
&& !group_ok
&& !world_ok
) {
6843 /* Check ownership (relatively cheap) */
6844 if ((on_dir
&& vauth_dir_owner(vcp
)) ||
6845 (!on_dir
&& vauth_file_owner(vcp
))) {
6852 /* Not owner; if group and world both grant it we're done */
6853 if (group_ok
&& world_ok
) {
6854 _SETWHERE("group/world");
6857 if (!group_ok
&& !world_ok
) {
6858 _SETWHERE("group/world");
6863 /* Check group membership (most expensive) */
6864 ismember
= 0; /* Default to allow, if the target has no group owner */
6867 * In the case we can't get an answer about the user from the call to
6868 * vauth_dir_ingroup() or vauth_file_ingroup(), we want to fail on
6869 * the side of caution, rather than simply granting access, or we will
6870 * fail to correctly implement exclusion groups, so we set the third
6871 * parameter on the basis of the state of 'group_ok'.
6874 error
= vauth_dir_ingroup(vcp
, &ismember
, (!group_ok
? EACCES
: 0));
6876 error
= vauth_file_ingroup(vcp
, &ismember
, (!group_ok
? EACCES
: 0));
6890 /* Not owner, not in group, use world result */
6898 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",
6899 vcp
->vp
, (error
== 0) ? "ALLOWED" : "DENIED", where
,
6900 (action
& VREAD
) ? "r" : "-",
6901 (action
& VWRITE
) ? "w" : "-",
6902 (action
& VEXEC
) ? "x" : "-",
6904 (vap
->va_mode
& S_IRUSR
) ? "r" : "-",
6905 (vap
->va_mode
& S_IWUSR
) ? "w" : "-",
6906 (vap
->va_mode
& S_IXUSR
) ? "x" : "-",
6907 (vap
->va_mode
& S_IRGRP
) ? "r" : "-",
6908 (vap
->va_mode
& S_IWGRP
) ? "w" : "-",
6909 (vap
->va_mode
& S_IXGRP
) ? "x" : "-",
6910 (vap
->va_mode
& S_IROTH
) ? "r" : "-",
6911 (vap
->va_mode
& S_IWOTH
) ? "w" : "-",
6912 (vap
->va_mode
& S_IXOTH
) ? "x" : "-",
6913 kauth_cred_getuid(vcp
->ctx
->vc_ucred
),
6914 on_dir
? vcp
->dvap
->va_uid
: vcp
->vap
->va_uid
,
6915 on_dir
? vcp
->dvap
->va_gid
: vcp
->vap
->va_gid
);
6920 * Authorize the deletion of the node vp from the directory dvp.
6923 * - Neither the node nor the directory are immutable.
6924 * - The user is not the superuser.
6926 * The precedence of factors for authorizing or denying delete for a credential
6928 * 1) Explicit ACE on the node. (allow or deny DELETE)
6929 * 2) Explicit ACE on the directory (allow or deny DELETE_CHILD).
6931 * If there are conflicting ACEs on the node and the directory, the node
6934 * 3) Sticky bit on the directory.
6935 * Deletion is not permitted if the directory is sticky and the caller is
6936 * not owner of the node or directory. The sticky bit rules are like a deny
6937 * delete ACE except lower in priority than ACL's either allowing or denying
6940 * 4) POSIX permisions on the directory.
6942 * As an optimization, we cache whether or not delete child is permitted
6943 * on directories. This enables us to skip directory ACL and POSIX checks
6944 * as we already have the result from those checks. However, we always check the
6945 * node ACL and, if the directory has the sticky bit set, we always check its
6946 * ACL (even for a directory with an authorized delete child). Furthermore,
6947 * caching the delete child authorization is independent of the sticky bit
6948 * being set as it is only applicable in determining whether the node can be
6952 vnode_authorize_delete(vauth_ctx vcp
, boolean_t cached_delete_child
)
6954 struct vnode_attr
*vap
= vcp
->vap
;
6955 struct vnode_attr
*dvap
= vcp
->dvap
;
6956 kauth_cred_t cred
= vcp
->ctx
->vc_ucred
;
6957 struct kauth_acl_eval eval
;
6958 int error
, ismember
;
6960 /* Check the ACL on the node first */
6961 if (VATTR_IS_NOT(vap
, va_acl
, NULL
)) {
6962 eval
.ae_requested
= KAUTH_VNODE_DELETE
;
6963 eval
.ae_acl
= &vap
->va_acl
->acl_ace
[0];
6964 eval
.ae_count
= vap
->va_acl
->acl_entrycount
;
6965 eval
.ae_options
= 0;
6966 if (vauth_file_owner(vcp
))
6967 eval
.ae_options
|= KAUTH_AEVAL_IS_OWNER
;
6969 * We use ENOENT as a marker to indicate we could not get
6970 * information in order to delay evaluation until after we
6971 * have the ACL evaluation answer. Previously, we would
6972 * always deny the operation at this point.
6974 if ((error
= vauth_file_ingroup(vcp
, &ismember
, ENOENT
)) != 0 && error
!= ENOENT
)
6976 if (error
== ENOENT
)
6977 eval
.ae_options
|= KAUTH_AEVAL_IN_GROUP_UNKNOWN
;
6979 eval
.ae_options
|= KAUTH_AEVAL_IN_GROUP
;
6980 eval
.ae_exp_gall
= KAUTH_VNODE_GENERIC_ALL_BITS
;
6981 eval
.ae_exp_gread
= KAUTH_VNODE_GENERIC_READ_BITS
;
6982 eval
.ae_exp_gwrite
= KAUTH_VNODE_GENERIC_WRITE_BITS
;
6983 eval
.ae_exp_gexec
= KAUTH_VNODE_GENERIC_EXECUTE_BITS
;
6985 if ((error
= kauth_acl_evaluate(cred
, &eval
)) != 0) {
6986 KAUTH_DEBUG("%p ERROR during ACL processing - %d", vcp
->vp
, error
);
6990 switch(eval
.ae_result
) {
6991 case KAUTH_RESULT_DENY
:
6992 KAUTH_DEBUG("%p DENIED - denied by ACL", vcp
->vp
);
6994 case KAUTH_RESULT_ALLOW
:
6995 KAUTH_DEBUG("%p ALLOWED - granted by ACL", vcp
->vp
);
6997 case KAUTH_RESULT_DEFER
:
6999 /* Defer to directory */
7000 KAUTH_DEBUG("%p DEFERRED - by file ACL", vcp
->vp
);
7006 * Without a sticky bit, a previously authorized delete child is
7007 * sufficient to authorize this delete.
7009 * If the sticky bit is set, a directory ACL which allows delete child
7010 * overrides a (potential) sticky bit deny. The authorized delete child
7011 * cannot tell us if it was authorized because of an explicit delete
7012 * child allow ACE or because of POSIX permisions so we have to check
7013 * the directory ACL everytime if the directory has a sticky bit.
7015 if (!(dvap
->va_mode
& S_ISTXT
) && cached_delete_child
) {
7016 KAUTH_DEBUG("%p ALLOWED - granted by directory ACL or POSIX permissions and no sticky bit on directory", vcp
->vp
);
7020 /* check the ACL on the directory */
7021 if (VATTR_IS_NOT(dvap
, va_acl
, NULL
)) {
7022 eval
.ae_requested
= KAUTH_VNODE_DELETE_CHILD
;
7023 eval
.ae_acl
= &dvap
->va_acl
->acl_ace
[0];
7024 eval
.ae_count
= dvap
->va_acl
->acl_entrycount
;
7025 eval
.ae_options
= 0;
7026 if (vauth_dir_owner(vcp
))
7027 eval
.ae_options
|= KAUTH_AEVAL_IS_OWNER
;
7029 * We use ENOENT as a marker to indicate we could not get
7030 * information in order to delay evaluation until after we
7031 * have the ACL evaluation answer. Previously, we would
7032 * always deny the operation at this point.
7034 if ((error
= vauth_dir_ingroup(vcp
, &ismember
, ENOENT
)) != 0 && error
!= ENOENT
)
7036 if (error
== ENOENT
)
7037 eval
.ae_options
|= KAUTH_AEVAL_IN_GROUP_UNKNOWN
;
7039 eval
.ae_options
|= KAUTH_AEVAL_IN_GROUP
;
7040 eval
.ae_exp_gall
= KAUTH_VNODE_GENERIC_ALL_BITS
;
7041 eval
.ae_exp_gread
= KAUTH_VNODE_GENERIC_READ_BITS
;
7042 eval
.ae_exp_gwrite
= KAUTH_VNODE_GENERIC_WRITE_BITS
;
7043 eval
.ae_exp_gexec
= KAUTH_VNODE_GENERIC_EXECUTE_BITS
;
7046 * If there is no entry, we are going to defer to other
7047 * authorization mechanisms.
7049 error
= kauth_acl_evaluate(cred
, &eval
);
7052 KAUTH_DEBUG("%p ERROR during ACL processing - %d", vcp
->vp
, error
);
7055 switch(eval
.ae_result
) {
7056 case KAUTH_RESULT_DENY
:
7057 KAUTH_DEBUG("%p DENIED - denied by directory ACL", vcp
->vp
);
7059 case KAUTH_RESULT_ALLOW
:
7060 KAUTH_DEBUG("%p ALLOWED - granted by directory ACL", vcp
->vp
);
7061 if (!cached_delete_child
&& vcp
->dvp
) {
7062 vnode_cache_authorized_action(vcp
->dvp
,
7063 vcp
->ctx
, KAUTH_VNODE_DELETE_CHILD
);
7066 case KAUTH_RESULT_DEFER
:
7068 /* Deferred by directory ACL */
7069 KAUTH_DEBUG("%p DEFERRED - directory ACL", vcp
->vp
);
7075 * From this point, we can't explicitly allow and if we reach the end
7076 * of the function without a denial, then the delete is authorized.
7078 if (!cached_delete_child
) {
7079 if (vnode_authorize_posix(vcp
, VWRITE
, 1 /* on_dir */) != 0) {
7080 KAUTH_DEBUG("%p DENIED - denied by posix permisssions", vcp
->vp
);
7084 * Cache the authorized action on the vnode if allowed by the
7085 * directory ACL or POSIX permissions. It is correct to cache
7086 * this action even if sticky bit would deny deleting the node.
7089 vnode_cache_authorized_action(vcp
->dvp
, vcp
->ctx
,
7090 KAUTH_VNODE_DELETE_CHILD
);
7094 /* enforce sticky bit behaviour */
7095 if ((dvap
->va_mode
& S_ISTXT
) && !vauth_file_owner(vcp
) && !vauth_dir_owner(vcp
)) {
7096 KAUTH_DEBUG("%p DENIED - sticky bit rules (user %d file %d dir %d)",
7097 vcp
->vp
, cred
->cr_posix
.cr_uid
, vap
->va_uid
, dvap
->va_uid
);
7101 /* not denied, must be OK */
7107 * Authorize an operation based on the node's attributes.
7110 vnode_authorize_simple(vauth_ctx vcp
, kauth_ace_rights_t acl_rights
, kauth_ace_rights_t preauth_rights
, boolean_t
*found_deny
)
7112 struct vnode_attr
*vap
= vcp
->vap
;
7113 kauth_cred_t cred
= vcp
->ctx
->vc_ucred
;
7114 struct kauth_acl_eval eval
;
7115 int error
, ismember
;
7116 mode_t posix_action
;
7119 * If we are the file owner, we automatically have some rights.
7121 * Do we need to expand this to support group ownership?
7123 if (vauth_file_owner(vcp
))
7124 acl_rights
&= ~(KAUTH_VNODE_WRITE_SECURITY
);
7127 * If we are checking both TAKE_OWNERSHIP and WRITE_SECURITY, we can
7128 * mask the latter. If TAKE_OWNERSHIP is requested the caller is about to
7129 * change ownership to themselves, and WRITE_SECURITY is implicitly
7130 * granted to the owner. We need to do this because at this point
7131 * WRITE_SECURITY may not be granted as the caller is not currently
7134 if ((acl_rights
& KAUTH_VNODE_TAKE_OWNERSHIP
) &&
7135 (acl_rights
& KAUTH_VNODE_WRITE_SECURITY
))
7136 acl_rights
&= ~KAUTH_VNODE_WRITE_SECURITY
;
7138 if (acl_rights
== 0) {
7139 KAUTH_DEBUG("%p ALLOWED - implicit or no rights required", vcp
->vp
);
7143 /* if we have an ACL, evaluate it */
7144 if (VATTR_IS_NOT(vap
, va_acl
, NULL
)) {
7145 eval
.ae_requested
= acl_rights
;
7146 eval
.ae_acl
= &vap
->va_acl
->acl_ace
[0];
7147 eval
.ae_count
= vap
->va_acl
->acl_entrycount
;
7148 eval
.ae_options
= 0;
7149 if (vauth_file_owner(vcp
))
7150 eval
.ae_options
|= KAUTH_AEVAL_IS_OWNER
;
7152 * We use ENOENT as a marker to indicate we could not get
7153 * information in order to delay evaluation until after we
7154 * have the ACL evaluation answer. Previously, we would
7155 * always deny the operation at this point.
7157 if ((error
= vauth_file_ingroup(vcp
, &ismember
, ENOENT
)) != 0 && error
!= ENOENT
)
7159 if (error
== ENOENT
)
7160 eval
.ae_options
|= KAUTH_AEVAL_IN_GROUP_UNKNOWN
;
7162 eval
.ae_options
|= KAUTH_AEVAL_IN_GROUP
;
7163 eval
.ae_exp_gall
= KAUTH_VNODE_GENERIC_ALL_BITS
;
7164 eval
.ae_exp_gread
= KAUTH_VNODE_GENERIC_READ_BITS
;
7165 eval
.ae_exp_gwrite
= KAUTH_VNODE_GENERIC_WRITE_BITS
;
7166 eval
.ae_exp_gexec
= KAUTH_VNODE_GENERIC_EXECUTE_BITS
;
7168 if ((error
= kauth_acl_evaluate(cred
, &eval
)) != 0) {
7169 KAUTH_DEBUG("%p ERROR during ACL processing - %d", vcp
->vp
, error
);
7173 switch(eval
.ae_result
) {
7174 case KAUTH_RESULT_DENY
:
7175 KAUTH_DEBUG("%p DENIED - by ACL", vcp
->vp
);
7176 return(EACCES
); /* deny, deny, counter-allege */
7177 case KAUTH_RESULT_ALLOW
:
7178 KAUTH_DEBUG("%p ALLOWED - all rights granted by ACL", vcp
->vp
);
7180 case KAUTH_RESULT_DEFER
:
7182 /* Effectively the same as !delete_child_denied */
7183 KAUTH_DEBUG("%p DEFERRED - directory ACL", vcp
->vp
);
7187 *found_deny
= eval
.ae_found_deny
;
7189 /* fall through and evaluate residual rights */
7191 /* no ACL, everything is residual */
7192 eval
.ae_residual
= acl_rights
;
7196 * Grant residual rights that have been pre-authorized.
7198 eval
.ae_residual
&= ~preauth_rights
;
7201 * We grant WRITE_ATTRIBUTES to the owner if it hasn't been denied.
7203 if (vauth_file_owner(vcp
))
7204 eval
.ae_residual
&= ~KAUTH_VNODE_WRITE_ATTRIBUTES
;
7206 if (eval
.ae_residual
== 0) {
7207 KAUTH_DEBUG("%p ALLOWED - rights already authorized", vcp
->vp
);
7212 * Bail if we have residual rights that can't be granted by posix permissions,
7213 * or aren't presumed granted at this point.
7215 * XXX these can be collapsed for performance
7217 if (eval
.ae_residual
& KAUTH_VNODE_CHANGE_OWNER
) {
7218 KAUTH_DEBUG("%p DENIED - CHANGE_OWNER not permitted", vcp
->vp
);
7221 if (eval
.ae_residual
& KAUTH_VNODE_WRITE_SECURITY
) {
7222 KAUTH_DEBUG("%p DENIED - WRITE_SECURITY not permitted", vcp
->vp
);
7227 if (eval
.ae_residual
& KAUTH_VNODE_DELETE
)
7228 panic("vnode_authorize: can't be checking delete permission here");
7232 * Compute the fallback posix permissions that will satisfy the remaining
7236 if (eval
.ae_residual
& (KAUTH_VNODE_READ_DATA
|
7237 KAUTH_VNODE_LIST_DIRECTORY
|
7238 KAUTH_VNODE_READ_EXTATTRIBUTES
))
7239 posix_action
|= VREAD
;
7240 if (eval
.ae_residual
& (KAUTH_VNODE_WRITE_DATA
|
7241 KAUTH_VNODE_ADD_FILE
|
7242 KAUTH_VNODE_ADD_SUBDIRECTORY
|
7243 KAUTH_VNODE_DELETE_CHILD
|
7244 KAUTH_VNODE_WRITE_ATTRIBUTES
|
7245 KAUTH_VNODE_WRITE_EXTATTRIBUTES
))
7246 posix_action
|= VWRITE
;
7247 if (eval
.ae_residual
& (KAUTH_VNODE_EXECUTE
|
7248 KAUTH_VNODE_SEARCH
))
7249 posix_action
|= VEXEC
;
7251 if (posix_action
!= 0) {
7252 return(vnode_authorize_posix(vcp
, posix_action
, 0 /* !on_dir */));
7254 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",
7256 (eval
.ae_residual
& KAUTH_VNODE_READ_DATA
)
7257 ? vnode_isdir(vcp
->vp
) ? " LIST_DIRECTORY" : " READ_DATA" : "",
7258 (eval
.ae_residual
& KAUTH_VNODE_WRITE_DATA
)
7259 ? vnode_isdir(vcp
->vp
) ? " ADD_FILE" : " WRITE_DATA" : "",
7260 (eval
.ae_residual
& KAUTH_VNODE_EXECUTE
)
7261 ? vnode_isdir(vcp
->vp
) ? " SEARCH" : " EXECUTE" : "",
7262 (eval
.ae_residual
& KAUTH_VNODE_DELETE
)
7264 (eval
.ae_residual
& KAUTH_VNODE_APPEND_DATA
)
7265 ? vnode_isdir(vcp
->vp
) ? " ADD_SUBDIRECTORY" : " APPEND_DATA" : "",
7266 (eval
.ae_residual
& KAUTH_VNODE_DELETE_CHILD
)
7267 ? " DELETE_CHILD" : "",
7268 (eval
.ae_residual
& KAUTH_VNODE_READ_ATTRIBUTES
)
7269 ? " READ_ATTRIBUTES" : "",
7270 (eval
.ae_residual
& KAUTH_VNODE_WRITE_ATTRIBUTES
)
7271 ? " WRITE_ATTRIBUTES" : "",
7272 (eval
.ae_residual
& KAUTH_VNODE_READ_EXTATTRIBUTES
)
7273 ? " READ_EXTATTRIBUTES" : "",
7274 (eval
.ae_residual
& KAUTH_VNODE_WRITE_EXTATTRIBUTES
)
7275 ? " WRITE_EXTATTRIBUTES" : "",
7276 (eval
.ae_residual
& KAUTH_VNODE_READ_SECURITY
)
7277 ? " READ_SECURITY" : "",
7278 (eval
.ae_residual
& KAUTH_VNODE_WRITE_SECURITY
)
7279 ? " WRITE_SECURITY" : "",
7280 (eval
.ae_residual
& KAUTH_VNODE_CHECKIMMUTABLE
)
7281 ? " CHECKIMMUTABLE" : "",
7282 (eval
.ae_residual
& KAUTH_VNODE_CHANGE_OWNER
)
7283 ? " CHANGE_OWNER" : "");
7287 * Lack of required Posix permissions implies no reason to deny access.
7293 * Check for file immutability.
7296 vnode_authorize_checkimmutable(mount_t mp
, struct vnode_attr
*vap
, int rights
, int ignore
)
7302 * Perform immutability checks for operations that change data.
7304 * Sockets, fifos and devices require special handling.
7306 switch(vap
->va_type
) {
7312 * Writing to these nodes does not change the filesystem data,
7313 * so forget that it's being tried.
7315 rights
&= ~KAUTH_VNODE_WRITE_DATA
;
7322 if (rights
& KAUTH_VNODE_WRITE_RIGHTS
) {
7324 /* check per-filesystem options if possible */
7327 /* check for no-EA filesystems */
7328 if ((rights
& KAUTH_VNODE_WRITE_EXTATTRIBUTES
) &&
7329 (vfs_flags(mp
) & MNT_NOUSERXATTR
)) {
7330 KAUTH_DEBUG("%p DENIED - filesystem disallowed extended attributes", vp
);
7331 error
= EACCES
; /* User attributes disabled */
7337 * check for file immutability. first, check if the requested rights are
7338 * allowable for a UF_APPEND file.
7341 if (vap
->va_type
== VDIR
) {
7342 if ((rights
& (KAUTH_VNODE_ADD_FILE
| KAUTH_VNODE_ADD_SUBDIRECTORY
| KAUTH_VNODE_WRITE_EXTATTRIBUTES
)) == rights
)
7345 if ((rights
& (KAUTH_VNODE_APPEND_DATA
| KAUTH_VNODE_WRITE_EXTATTRIBUTES
)) == rights
)
7348 if ((error
= vnode_immutable(vap
, append
, ignore
)) != 0) {
7349 KAUTH_DEBUG("%p DENIED - file is immutable", vp
);
7358 * Handle authorization actions for filesystems that advertise that the
7359 * server will be enforcing.
7361 * Returns: 0 Authorization should be handled locally
7362 * 1 Authorization was handled by the FS
7364 * Note: Imputed returns will only occur if the authorization request
7365 * was handled by the FS.
7367 * Imputed: *resultp, modified Return code from FS when the request is
7368 * handled by the FS.
7373 vnode_authorize_opaque(vnode_t vp
, int *resultp
, kauth_action_t action
, vfs_context_t ctx
)
7378 * If the vp is a device node, socket or FIFO it actually represents a local
7379 * endpoint, so we need to handle it locally.
7381 switch(vp
->v_type
) {
7392 * In the advisory request case, if the filesystem doesn't think it's reliable
7393 * we will attempt to formulate a result ourselves based on VNOP_GETATTR data.
7395 if ((action
& KAUTH_VNODE_ACCESS
) && !vfs_authopaqueaccess(vp
->v_mount
))
7399 * Let the filesystem have a say in the matter. It's OK for it to not implemnent
7400 * VNOP_ACCESS, as most will authorise inline with the actual request.
7402 if ((error
= VNOP_ACCESS(vp
, action
, ctx
)) != ENOTSUP
) {
7404 KAUTH_DEBUG("%p DENIED - opaque filesystem VNOP_ACCESS denied access", vp
);
7409 * Typically opaque filesystems do authorisation in-line, but exec is a special case. In
7410 * order to be reasonably sure that exec will be permitted, we try a bit harder here.
7412 if ((action
& KAUTH_VNODE_EXECUTE
) && (vp
->v_type
== VREG
)) {
7413 /* try a VNOP_OPEN for readonly access */
7414 if ((error
= VNOP_OPEN(vp
, FREAD
, ctx
)) != 0) {
7416 KAUTH_DEBUG("%p DENIED - EXECUTE denied because file could not be opened readonly", vp
);
7419 VNOP_CLOSE(vp
, FREAD
, ctx
);
7423 * We don't have any reason to believe that the request has to be denied at this point,
7424 * so go ahead and allow it.
7427 KAUTH_DEBUG("%p ALLOWED - bypassing access check for non-local filesystem", vp
);
7435 * Returns: KAUTH_RESULT_ALLOW
7438 * Imputed: *arg3, modified Error code in the deny case
7439 * EROFS Read-only file system
7440 * EACCES Permission denied
7441 * EPERM Operation not permitted [no execute]
7442 * vnode_getattr:ENOMEM Not enough space [only if has filesec]
7444 * vnode_authorize_opaque:*arg2 ???
7445 * vnode_authorize_checkimmutable:???
7446 * vnode_authorize_delete:???
7447 * vnode_authorize_simple:???
7452 vnode_authorize_callback(__unused kauth_cred_t cred
, __unused
void *idata
,
7453 kauth_action_t action
, uintptr_t arg0
, uintptr_t arg1
, uintptr_t arg2
,
7457 vnode_t cvp
= NULLVP
;
7459 int result
= KAUTH_RESULT_DENY
;
7460 int parent_iocount
= 0;
7461 int parent_action
; /* In case we need to use namedstream's data fork for cached rights*/
7463 ctx
= (vfs_context_t
)arg0
;
7465 dvp
= (vnode_t
)arg2
;
7468 * if there are 2 vnodes passed in, we don't know at
7469 * this point which rights to look at based on the
7470 * combined action being passed in... defer until later...
7471 * otherwise check the kauth 'rights' cache hung
7472 * off of the vnode we're interested in... if we've already
7473 * been granted the right we're currently interested in,
7474 * we can just return success... otherwise we'll go through
7475 * the process of authorizing the requested right(s)... if that
7476 * succeeds, we'll add the right(s) to the cache.
7477 * VNOP_SETATTR and VNOP_SETXATTR will invalidate this cache
7485 * For named streams on local-authorization volumes, rights are cached on the parent;
7486 * authorization is determined by looking at the parent's properties anyway, so storing
7487 * on the parent means that we don't recompute for the named stream and that if
7488 * we need to flush rights (e.g. on VNOP_SETATTR()) we don't need to track down the
7489 * stream to flush its cache separately. If we miss in the cache, then we authorize
7490 * as if there were no cached rights (passing the named stream vnode and desired rights to
7491 * vnode_authorize_callback_int()).
7493 * On an opaquely authorized volume, we don't know the relationship between the
7494 * data fork's properties and the rights granted on a stream. Thus, named stream vnodes
7495 * on such a volume are authorized directly (rather than using the parent) and have their
7496 * own caches. When a named stream vnode is created, we mark the parent as having a named
7497 * stream. On a VNOP_SETATTR() for the parent that may invalidate cached authorization, we
7498 * find the stream and flush its cache.
7500 if (vnode_isnamedstream(vp
) && (!vfs_authopaque(vp
->v_mount
))) {
7501 cvp
= vnode_getparent(vp
);
7502 if (cvp
!= NULLVP
) {
7506 goto defer
; /* If we can't use the parent, take the slow path */
7509 /* Have to translate some actions */
7510 parent_action
= action
;
7511 if (parent_action
& KAUTH_VNODE_READ_DATA
) {
7512 parent_action
&= ~KAUTH_VNODE_READ_DATA
;
7513 parent_action
|= KAUTH_VNODE_READ_EXTATTRIBUTES
;
7515 if (parent_action
& KAUTH_VNODE_WRITE_DATA
) {
7516 parent_action
&= ~KAUTH_VNODE_WRITE_DATA
;
7517 parent_action
|= KAUTH_VNODE_WRITE_EXTATTRIBUTES
;
7525 if (vnode_cache_is_authorized(cvp
, ctx
, parent_iocount
? parent_action
: action
) == TRUE
) {
7526 result
= KAUTH_RESULT_ALLOW
;
7530 result
= vnode_authorize_callback_int(action
, ctx
, vp
, dvp
, (int *)arg3
);
7532 if (result
== KAUTH_RESULT_ALLOW
&& cvp
!= NULLVP
) {
7533 KAUTH_DEBUG("%p - caching action = %x", cvp
, action
);
7534 vnode_cache_authorized_action(cvp
, ctx
, action
);
7538 if (parent_iocount
) {
7546 vnode_attr_authorize_internal(vauth_ctx vcp
, mount_t mp
,
7547 kauth_ace_rights_t rights
, int is_suser
, boolean_t
*found_deny
,
7548 int noimmutable
, int parent_authorized_for_delete_child
)
7553 * Check for immutability.
7555 * In the deletion case, parent directory immutability vetoes specific
7558 if ((result
= vnode_authorize_checkimmutable(mp
, vcp
->vap
, rights
,
7562 if ((rights
& KAUTH_VNODE_DELETE
) &&
7563 !parent_authorized_for_delete_child
) {
7564 result
= vnode_authorize_checkimmutable(mp
, vcp
->dvap
,
7565 KAUTH_VNODE_DELETE_CHILD
, 0);
7571 * Clear rights that have been authorized by reaching this point, bail if nothing left to
7574 rights
&= ~(KAUTH_VNODE_LINKTARGET
| KAUTH_VNODE_CHECKIMMUTABLE
);
7579 * If we're not the superuser, authorize based on file properties;
7580 * note that even if parent_authorized_for_delete_child is TRUE, we
7581 * need to check on the node itself.
7584 /* process delete rights */
7585 if ((rights
& KAUTH_VNODE_DELETE
) &&
7586 ((result
= vnode_authorize_delete(vcp
, parent_authorized_for_delete_child
)) != 0))
7589 /* process remaining rights */
7590 if ((rights
& ~KAUTH_VNODE_DELETE
) &&
7591 (result
= vnode_authorize_simple(vcp
, rights
, rights
& KAUTH_VNODE_DELETE
, found_deny
)) != 0)
7595 * Execute is only granted to root if one of the x bits is set. This check only
7596 * makes sense if the posix mode bits are actually supported.
7598 if ((rights
& KAUTH_VNODE_EXECUTE
) &&
7599 (vcp
->vap
->va_type
== VREG
) &&
7600 VATTR_IS_SUPPORTED(vcp
->vap
, va_mode
) &&
7601 !(vcp
->vap
->va_mode
& (S_IXUSR
| S_IXGRP
| S_IXOTH
))) {
7603 KAUTH_DEBUG("%p DENIED - root execute requires at least one x bit in 0x%x", vp
, va
.va_mode
);
7607 /* Assume that there were DENYs so we don't wrongly cache KAUTH_VNODE_SEARCHBYANYONE */
7610 KAUTH_DEBUG("%p ALLOWED - caller is superuser", vp
);
7617 vnode_authorize_callback_int(kauth_action_t action
, vfs_context_t ctx
,
7618 vnode_t vp
, vnode_t dvp
, int *errorp
)
7620 struct _vnode_authorize_context auth_context
;
7623 kauth_ace_rights_t rights
;
7624 struct vnode_attr va
, dva
;
7627 boolean_t parent_authorized_for_delete_child
= FALSE
;
7628 boolean_t found_deny
= FALSE
;
7629 boolean_t parent_ref
= FALSE
;
7630 boolean_t is_suser
= FALSE
;
7632 vcp
= &auth_context
;
7637 * Note that we authorize against the context, not the passed cred
7638 * (the same thing anyway)
7640 cred
= ctx
->vc_ucred
;
7647 vcp
->flags
= vcp
->flags_valid
= 0;
7650 if ((ctx
== NULL
) || (vp
== NULL
) || (cred
== NULL
))
7651 panic("vnode_authorize: bad arguments (context %p vp %p cred %p)", ctx
, vp
, cred
);
7654 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)",
7655 vp
, vfs_context_proc(ctx
)->p_comm
,
7656 (action
& KAUTH_VNODE_ACCESS
) ? "access" : "auth",
7657 (action
& KAUTH_VNODE_READ_DATA
) ? vnode_isdir(vp
) ? " LIST_DIRECTORY" : " READ_DATA" : "",
7658 (action
& KAUTH_VNODE_WRITE_DATA
) ? vnode_isdir(vp
) ? " ADD_FILE" : " WRITE_DATA" : "",
7659 (action
& KAUTH_VNODE_EXECUTE
) ? vnode_isdir(vp
) ? " SEARCH" : " EXECUTE" : "",
7660 (action
& KAUTH_VNODE_DELETE
) ? " DELETE" : "",
7661 (action
& KAUTH_VNODE_APPEND_DATA
) ? vnode_isdir(vp
) ? " ADD_SUBDIRECTORY" : " APPEND_DATA" : "",
7662 (action
& KAUTH_VNODE_DELETE_CHILD
) ? " DELETE_CHILD" : "",
7663 (action
& KAUTH_VNODE_READ_ATTRIBUTES
) ? " READ_ATTRIBUTES" : "",
7664 (action
& KAUTH_VNODE_WRITE_ATTRIBUTES
) ? " WRITE_ATTRIBUTES" : "",
7665 (action
& KAUTH_VNODE_READ_EXTATTRIBUTES
) ? " READ_EXTATTRIBUTES" : "",
7666 (action
& KAUTH_VNODE_WRITE_EXTATTRIBUTES
) ? " WRITE_EXTATTRIBUTES" : "",
7667 (action
& KAUTH_VNODE_READ_SECURITY
) ? " READ_SECURITY" : "",
7668 (action
& KAUTH_VNODE_WRITE_SECURITY
) ? " WRITE_SECURITY" : "",
7669 (action
& KAUTH_VNODE_CHANGE_OWNER
) ? " CHANGE_OWNER" : "",
7670 (action
& KAUTH_VNODE_NOIMMUTABLE
) ? " (noimmutable)" : "",
7671 vnode_isdir(vp
) ? "directory" : "file",
7672 vp
->v_name
? vp
->v_name
: "<NULL>", action
, vp
, dvp
);
7675 * Extract the control bits from the action, everything else is
7678 noimmutable
= (action
& KAUTH_VNODE_NOIMMUTABLE
) ? 1 : 0;
7679 rights
= action
& ~(KAUTH_VNODE_ACCESS
| KAUTH_VNODE_NOIMMUTABLE
);
7681 if (rights
& KAUTH_VNODE_DELETE
) {
7684 panic("vnode_authorize: KAUTH_VNODE_DELETE test requires a directory");
7687 * check to see if we've already authorized the parent
7688 * directory for deletion of its children... if so, we
7689 * can skip a whole bunch of work... we will still have to
7690 * authorize that this specific child can be removed
7692 if (vnode_cache_is_authorized(dvp
, ctx
, KAUTH_VNODE_DELETE_CHILD
) == TRUE
)
7693 parent_authorized_for_delete_child
= TRUE
;
7700 * Check for read-only filesystems.
7702 if ((rights
& KAUTH_VNODE_WRITE_RIGHTS
) &&
7703 (vp
->v_mount
->mnt_flag
& MNT_RDONLY
) &&
7704 ((vp
->v_type
== VREG
) || (vp
->v_type
== VDIR
) ||
7705 (vp
->v_type
== VLNK
) || (vp
->v_type
== VCPLX
) ||
7706 (rights
& KAUTH_VNODE_DELETE
) || (rights
& KAUTH_VNODE_DELETE_CHILD
))) {
7712 * Check for noexec filesystems.
7714 if ((rights
& KAUTH_VNODE_EXECUTE
) && (vp
->v_type
== VREG
) && (vp
->v_mount
->mnt_flag
& MNT_NOEXEC
)) {
7720 * Handle cases related to filesystems with non-local enforcement.
7721 * This call can return 0, in which case we will fall through to perform a
7722 * check based on VNOP_GETATTR data. Otherwise it returns 1 and sets
7723 * an appropriate result, at which point we can return immediately.
7725 if ((vp
->v_mount
->mnt_kern_flag
& MNTK_AUTH_OPAQUE
) && vnode_authorize_opaque(vp
, &result
, action
, ctx
))
7729 * If the vnode is a namedstream (extended attribute) data vnode (eg.
7730 * a resource fork), *_DATA becomes *_EXTATTRIBUTES.
7732 if (vnode_isnamedstream(vp
)) {
7733 if (rights
& KAUTH_VNODE_READ_DATA
) {
7734 rights
&= ~KAUTH_VNODE_READ_DATA
;
7735 rights
|= KAUTH_VNODE_READ_EXTATTRIBUTES
;
7737 if (rights
& KAUTH_VNODE_WRITE_DATA
) {
7738 rights
&= ~KAUTH_VNODE_WRITE_DATA
;
7739 rights
|= KAUTH_VNODE_WRITE_EXTATTRIBUTES
;
7743 * Point 'vp' to the namedstream's parent for ACL checking
7745 if ((vp
->v_parent
!= NULL
) &&
7746 (vget_internal(vp
->v_parent
, 0, VNODE_NODEAD
| VNODE_DRAINO
) == 0)) {
7748 vcp
->vp
= vp
= vp
->v_parent
;
7752 if (vfs_context_issuser(ctx
)) {
7754 * if we're not asking for execute permissions or modifications,
7755 * then we're done, this action is authorized.
7757 if (!(rights
& (KAUTH_VNODE_EXECUTE
| KAUTH_VNODE_WRITE_RIGHTS
)))
7764 * Get vnode attributes and extended security information for the vnode
7765 * and directory if required.
7767 * If we're root we only want mode bits and flags for checking
7768 * execute and immutability.
7770 VATTR_WANTED(&va
, va_mode
);
7771 VATTR_WANTED(&va
, va_flags
);
7773 VATTR_WANTED(&va
, va_uid
);
7774 VATTR_WANTED(&va
, va_gid
);
7775 VATTR_WANTED(&va
, va_acl
);
7777 if ((result
= vnode_getattr(vp
, &va
, ctx
)) != 0) {
7778 KAUTH_DEBUG("%p ERROR - failed to get vnode attributes - %d", vp
, result
);
7781 VATTR_WANTED(&va
, va_type
);
7782 VATTR_RETURN(&va
, va_type
, vnode_vtype(vp
));
7785 VATTR_WANTED(&dva
, va_mode
);
7786 VATTR_WANTED(&dva
, va_flags
);
7788 VATTR_WANTED(&dva
, va_uid
);
7789 VATTR_WANTED(&dva
, va_gid
);
7790 VATTR_WANTED(&dva
, va_acl
);
7792 if ((result
= vnode_getattr(vcp
->dvp
, &dva
, ctx
)) != 0) {
7793 KAUTH_DEBUG("%p ERROR - failed to get directory vnode attributes - %d", vp
, result
);
7796 VATTR_WANTED(&dva
, va_type
);
7797 VATTR_RETURN(&dva
, va_type
, vnode_vtype(vcp
->dvp
));
7800 result
= vnode_attr_authorize_internal(vcp
, vp
->v_mount
, rights
, is_suser
,
7801 &found_deny
, noimmutable
, parent_authorized_for_delete_child
);
7803 if (VATTR_IS_SUPPORTED(&va
, va_acl
) && (va
.va_acl
!= NULL
))
7804 kauth_acl_free(va
.va_acl
);
7805 if (VATTR_IS_SUPPORTED(&dva
, va_acl
) && (dva
.va_acl
!= NULL
))
7806 kauth_acl_free(dva
.va_acl
);
7812 KAUTH_DEBUG("%p DENIED - auth denied", vp
);
7813 return(KAUTH_RESULT_DENY
);
7815 if ((rights
& KAUTH_VNODE_SEARCH
) && found_deny
== FALSE
&& vp
->v_type
== VDIR
) {
7817 * if we were successfully granted the right to search this directory
7818 * and there were NO ACL DENYs for search and the posix permissions also don't
7819 * deny execute, we can synthesize a global right that allows anyone to
7820 * traverse this directory during a pathname lookup without having to
7821 * match the credential associated with this cache of rights.
7823 * Note that we can correctly cache KAUTH_VNODE_SEARCHBYANYONE
7824 * only if we actually check ACLs which we don't for root. As
7825 * a workaround, the lookup fast path checks for root.
7827 if (!VATTR_IS_SUPPORTED(&va
, va_mode
) ||
7828 ((va
.va_mode
& (S_IXUSR
| S_IXGRP
| S_IXOTH
)) ==
7829 (S_IXUSR
| S_IXGRP
| S_IXOTH
))) {
7830 vnode_cache_authorized_action(vp
, ctx
, KAUTH_VNODE_SEARCHBYANYONE
);
7838 * Note that this implies that we will allow requests for no rights, as well as
7839 * for rights that we do not recognise. There should be none of these.
7841 KAUTH_DEBUG("%p ALLOWED - auth granted", vp
);
7842 return(KAUTH_RESULT_ALLOW
);
7846 vnode_attr_authorize_init(struct vnode_attr
*vap
, struct vnode_attr
*dvap
,
7847 kauth_action_t action
, vfs_context_t ctx
)
7850 VATTR_WANTED(vap
, va_type
);
7851 VATTR_WANTED(vap
, va_mode
);
7852 VATTR_WANTED(vap
, va_flags
);
7855 if (action
& KAUTH_VNODE_DELETE
) {
7856 VATTR_WANTED(dvap
, va_type
);
7857 VATTR_WANTED(dvap
, va_mode
);
7858 VATTR_WANTED(dvap
, va_flags
);
7860 } else if (action
& KAUTH_VNODE_DELETE
) {
7864 if (!vfs_context_issuser(ctx
)) {
7865 VATTR_WANTED(vap
, va_uid
);
7866 VATTR_WANTED(vap
, va_gid
);
7867 VATTR_WANTED(vap
, va_acl
);
7868 if (dvap
&& (action
& KAUTH_VNODE_DELETE
)) {
7869 VATTR_WANTED(dvap
, va_uid
);
7870 VATTR_WANTED(dvap
, va_gid
);
7871 VATTR_WANTED(dvap
, va_acl
);
7879 vnode_attr_authorize(struct vnode_attr
*vap
, struct vnode_attr
*dvap
, mount_t mp
,
7880 kauth_action_t action
, vfs_context_t ctx
)
7882 struct _vnode_authorize_context auth_context
;
7884 kauth_ace_rights_t rights
;
7886 boolean_t found_deny
;
7887 boolean_t is_suser
= FALSE
;
7890 vcp
= &auth_context
;
7896 vcp
->flags
= vcp
->flags_valid
= 0;
7898 noimmutable
= (action
& KAUTH_VNODE_NOIMMUTABLE
) ? 1 : 0;
7899 rights
= action
& ~(KAUTH_VNODE_ACCESS
| KAUTH_VNODE_NOIMMUTABLE
);
7902 * Check for read-only filesystems.
7904 if ((rights
& KAUTH_VNODE_WRITE_RIGHTS
) &&
7905 mp
&& (mp
->mnt_flag
& MNT_RDONLY
) &&
7906 ((vap
->va_type
== VREG
) || (vap
->va_type
== VDIR
) ||
7907 (vap
->va_type
== VLNK
) || (rights
& KAUTH_VNODE_DELETE
) ||
7908 (rights
& KAUTH_VNODE_DELETE_CHILD
))) {
7914 * Check for noexec filesystems.
7916 if ((rights
& KAUTH_VNODE_EXECUTE
) &&
7917 (vap
->va_type
== VREG
) && mp
&& (mp
->mnt_flag
& MNT_NOEXEC
)) {
7922 if (vfs_context_issuser(ctx
)) {
7924 * if we're not asking for execute permissions or modifications,
7925 * then we're done, this action is authorized.
7927 if (!(rights
& (KAUTH_VNODE_EXECUTE
| KAUTH_VNODE_WRITE_RIGHTS
)))
7931 if (!VATTR_IS_SUPPORTED(vap
, va_uid
) ||
7932 !VATTR_IS_SUPPORTED(vap
, va_gid
) ||
7933 (mp
&& vfs_extendedsecurity(mp
) && !VATTR_IS_SUPPORTED(vap
, va_acl
))) {
7934 panic("vnode attrs not complete for vnode_attr_authorize\n");
7938 result
= vnode_attr_authorize_internal(vcp
, mp
, rights
, is_suser
,
7939 &found_deny
, noimmutable
, FALSE
);
7941 if (result
== EPERM
)
7949 vnode_authattr_new(vnode_t dvp
, struct vnode_attr
*vap
, int noauth
, vfs_context_t ctx
)
7951 return vnode_authattr_new_internal(dvp
, vap
, noauth
, NULL
, ctx
);
7955 * Check that the attribute information in vattr can be legally applied to
7956 * a new file by the context.
7959 vnode_authattr_new_internal(vnode_t dvp
, struct vnode_attr
*vap
, int noauth
, uint32_t *defaulted_fieldsp
, vfs_context_t ctx
)
7962 int has_priv_suser
, ismember
, defaulted_owner
, defaulted_group
, defaulted_mode
, inherit_restricted
;
7966 struct vnode_attr dva
;
7970 if (defaulted_fieldsp
) {
7971 *defaulted_fieldsp
= 0;
7974 defaulted_owner
= defaulted_group
= defaulted_mode
= 0;
7976 inherit_restricted
= 0;
7979 * Require that the filesystem support extended security to apply any.
7981 if (!vfs_extendedsecurity(dvp
->v_mount
) &&
7982 (VATTR_IS_ACTIVE(vap
, va_acl
) || VATTR_IS_ACTIVE(vap
, va_uuuid
) || VATTR_IS_ACTIVE(vap
, va_guuid
))) {
7988 * Default some fields.
7993 * If the filesystem is mounted IGNORE_OWNERSHIP and an explicit owner is set, that
7994 * owner takes ownership of all new files.
7996 if ((dmp
->mnt_flag
& MNT_IGNORE_OWNERSHIP
) && (dmp
->mnt_fsowner
!= KAUTH_UID_NONE
)) {
7997 VATTR_SET(vap
, va_uid
, dmp
->mnt_fsowner
);
7998 defaulted_owner
= 1;
8000 if (!VATTR_IS_ACTIVE(vap
, va_uid
)) {
8001 /* default owner is current user */
8002 VATTR_SET(vap
, va_uid
, kauth_cred_getuid(vfs_context_ucred(ctx
)));
8003 defaulted_owner
= 1;
8008 * We need the dvp's va_flags and *may* need the gid of the directory,
8009 * we ask for both here.
8012 VATTR_WANTED(&dva
, va_gid
);
8013 VATTR_WANTED(&dva
, va_flags
);
8014 if ((error
= vnode_getattr(dvp
, &dva
, ctx
)) != 0)
8018 * If the filesystem is mounted IGNORE_OWNERSHIP and an explicit grouo is set, that
8019 * group takes ownership of all new files.
8021 if ((dmp
->mnt_flag
& MNT_IGNORE_OWNERSHIP
) && (dmp
->mnt_fsgroup
!= KAUTH_GID_NONE
)) {
8022 VATTR_SET(vap
, va_gid
, dmp
->mnt_fsgroup
);
8023 defaulted_group
= 1;
8025 if (!VATTR_IS_ACTIVE(vap
, va_gid
)) {
8026 /* default group comes from parent object, fallback to current user */
8027 if (VATTR_IS_SUPPORTED(&dva
, va_gid
)) {
8028 VATTR_SET(vap
, va_gid
, dva
.va_gid
);
8030 VATTR_SET(vap
, va_gid
, kauth_cred_getgid(vfs_context_ucred(ctx
)));
8032 defaulted_group
= 1;
8036 if (!VATTR_IS_ACTIVE(vap
, va_flags
))
8037 VATTR_SET(vap
, va_flags
, 0);
8039 /* Determine if SF_RESTRICTED should be inherited from the parent
8041 if (VATTR_IS_SUPPORTED(&dva
, va_flags
) &&
8042 (dva
.va_flags
& SF_RESTRICTED
)) {
8043 inherit_restricted
= 1;
8046 /* default mode is everything, masked with current umask */
8047 if (!VATTR_IS_ACTIVE(vap
, va_mode
)) {
8048 VATTR_SET(vap
, va_mode
, ACCESSPERMS
& ~vfs_context_proc(ctx
)->p_fd
->fd_cmask
);
8049 KAUTH_DEBUG("ATTR - defaulting new file mode to %o from umask %o", vap
->va_mode
, vfs_context_proc(ctx
)->p_fd
->fd_cmask
);
8052 /* set timestamps to now */
8053 if (!VATTR_IS_ACTIVE(vap
, va_create_time
)) {
8054 nanotime(&vap
->va_create_time
);
8055 VATTR_SET_ACTIVE(vap
, va_create_time
);
8059 * Check for attempts to set nonsensical fields.
8061 if (vap
->va_active
& ~VNODE_ATTR_NEWOBJ
) {
8063 KAUTH_DEBUG("ATTR - ERROR - attempt to set unsupported new-file attributes %llx",
8064 vap
->va_active
& ~VNODE_ATTR_NEWOBJ
);
8069 * Quickly check for the applicability of any enforcement here.
8070 * Tests below maintain the integrity of the local security model.
8072 if (vfs_authopaque(dvp
->v_mount
))
8076 * We need to know if the caller is the superuser, or if the work is
8077 * otherwise already authorised.
8079 cred
= vfs_context_ucred(ctx
);
8081 /* doing work for the kernel */
8084 has_priv_suser
= vfs_context_issuser(ctx
);
8088 if (VATTR_IS_ACTIVE(vap
, va_flags
)) {
8089 if (has_priv_suser
) {
8090 if ((vap
->va_flags
& (UF_SETTABLE
| SF_SETTABLE
)) != vap
->va_flags
) {
8092 KAUTH_DEBUG(" DENIED - superuser attempt to set illegal flag(s)");
8096 if ((vap
->va_flags
& UF_SETTABLE
) != vap
->va_flags
) {
8098 KAUTH_DEBUG(" DENIED - user attempt to set illegal flag(s)");
8104 /* if not superuser, validate legality of new-item attributes */
8105 if (!has_priv_suser
) {
8106 if (!defaulted_mode
&& VATTR_IS_ACTIVE(vap
, va_mode
)) {
8108 if (vap
->va_mode
& S_ISGID
) {
8109 if ((error
= kauth_cred_ismember_gid(cred
, vap
->va_gid
, &ismember
)) != 0) {
8110 KAUTH_DEBUG("ATTR - ERROR: got %d checking for membership in %d", error
, vap
->va_gid
);
8114 KAUTH_DEBUG(" DENIED - can't set SGID bit, not a member of %d", vap
->va_gid
);
8121 if ((vap
->va_mode
& S_ISUID
) && (vap
->va_uid
!= kauth_cred_getuid(cred
))) {
8122 KAUTH_DEBUG("ATTR - ERROR: illegal attempt to set the setuid bit");
8127 if (!defaulted_owner
&& (vap
->va_uid
!= kauth_cred_getuid(cred
))) {
8128 KAUTH_DEBUG(" DENIED - cannot create new item owned by %d", vap
->va_uid
);
8132 if (!defaulted_group
) {
8133 if ((error
= kauth_cred_ismember_gid(cred
, vap
->va_gid
, &ismember
)) != 0) {
8134 KAUTH_DEBUG(" ERROR - got %d checking for membership in %d", error
, vap
->va_gid
);
8138 KAUTH_DEBUG(" DENIED - cannot create new item with group %d - not a member", vap
->va_gid
);
8144 /* initialising owner/group UUID */
8145 if (VATTR_IS_ACTIVE(vap
, va_uuuid
)) {
8146 if ((error
= kauth_cred_getguid(cred
, &changer
)) != 0) {
8147 KAUTH_DEBUG(" ERROR - got %d trying to get caller UUID", error
);
8148 /* XXX ENOENT here - no GUID - should perhaps become EPERM */
8151 if (!kauth_guid_equal(&vap
->va_uuuid
, &changer
)) {
8152 KAUTH_DEBUG(" ERROR - cannot create item with supplied owner UUID - not us");
8157 if (VATTR_IS_ACTIVE(vap
, va_guuid
)) {
8158 if ((error
= kauth_cred_ismember_guid(cred
, &vap
->va_guuid
, &ismember
)) != 0) {
8159 KAUTH_DEBUG(" ERROR - got %d trying to check group membership", error
);
8163 KAUTH_DEBUG(" ERROR - cannot create item with supplied group UUID - not a member");
8170 if (inherit_restricted
) {
8171 /* Apply SF_RESTRICTED to the file if its parent directory was
8172 * restricted. This is done at the end so that root is not
8173 * required if this flag is only set due to inheritance. */
8174 VATTR_SET(vap
, va_flags
, (vap
->va_flags
| SF_RESTRICTED
));
8176 if (defaulted_fieldsp
) {
8177 if (defaulted_mode
) {
8178 *defaulted_fieldsp
|= VATTR_PREPARE_DEFAULTED_MODE
;
8180 if (defaulted_group
) {
8181 *defaulted_fieldsp
|= VATTR_PREPARE_DEFAULTED_GID
;
8183 if (defaulted_owner
) {
8184 *defaulted_fieldsp
|= VATTR_PREPARE_DEFAULTED_UID
;
8191 * Check that the attribute information in vap can be legally written by the
8194 * Call this when you're not sure about the vnode_attr; either its contents
8195 * have come from an unknown source, or when they are variable.
8197 * Returns errno, or zero and sets *actionp to the KAUTH_VNODE_* actions that
8198 * must be authorized to be permitted to write the vattr.
8201 vnode_authattr(vnode_t vp
, struct vnode_attr
*vap
, kauth_action_t
*actionp
, vfs_context_t ctx
)
8203 struct vnode_attr ova
;
8204 kauth_action_t required_action
;
8205 int error
, has_priv_suser
, ismember
, chowner
, chgroup
, clear_suid
, clear_sgid
;
8214 required_action
= 0;
8218 * Quickly check for enforcement applicability.
8220 if (vfs_authopaque(vp
->v_mount
))
8224 * Check for attempts to set nonsensical fields.
8226 if (vap
->va_active
& VNODE_ATTR_RDONLY
) {
8227 KAUTH_DEBUG("ATTR - ERROR: attempt to set readonly attribute(s)");
8233 * We need to know if the caller is the superuser.
8235 cred
= vfs_context_ucred(ctx
);
8236 has_priv_suser
= kauth_cred_issuser(cred
);
8239 * If any of the following are changing, we need information from the old file:
8246 if (VATTR_IS_ACTIVE(vap
, va_uid
) ||
8247 VATTR_IS_ACTIVE(vap
, va_gid
) ||
8248 VATTR_IS_ACTIVE(vap
, va_mode
) ||
8249 VATTR_IS_ACTIVE(vap
, va_uuuid
) ||
8250 VATTR_IS_ACTIVE(vap
, va_guuid
)) {
8251 VATTR_WANTED(&ova
, va_mode
);
8252 VATTR_WANTED(&ova
, va_uid
);
8253 VATTR_WANTED(&ova
, va_gid
);
8254 VATTR_WANTED(&ova
, va_uuuid
);
8255 VATTR_WANTED(&ova
, va_guuid
);
8256 KAUTH_DEBUG("ATTR - security information changing, fetching existing attributes");
8260 * If timestamps are being changed, we need to know who the file is owned
8263 if (VATTR_IS_ACTIVE(vap
, va_create_time
) ||
8264 VATTR_IS_ACTIVE(vap
, va_change_time
) ||
8265 VATTR_IS_ACTIVE(vap
, va_modify_time
) ||
8266 VATTR_IS_ACTIVE(vap
, va_access_time
) ||
8267 VATTR_IS_ACTIVE(vap
, va_backup_time
)) {
8269 VATTR_WANTED(&ova
, va_uid
);
8270 #if 0 /* enable this when we support UUIDs as official owners */
8271 VATTR_WANTED(&ova
, va_uuuid
);
8273 KAUTH_DEBUG("ATTR - timestamps changing, fetching uid and GUID");
8277 * If flags are being changed, we need the old flags.
8279 if (VATTR_IS_ACTIVE(vap
, va_flags
)) {
8280 KAUTH_DEBUG("ATTR - flags changing, fetching old flags");
8281 VATTR_WANTED(&ova
, va_flags
);
8285 * If ACLs are being changed, we need the old ACLs.
8287 if (VATTR_IS_ACTIVE(vap
, va_acl
)) {
8288 KAUTH_DEBUG("ATTR - acl changing, fetching old flags");
8289 VATTR_WANTED(&ova
, va_acl
);
8293 * If the size is being set, make sure it's not a directory.
8295 if (VATTR_IS_ACTIVE(vap
, va_data_size
)) {
8296 /* size is only meaningful on regular files, don't permit otherwise */
8297 if (!vnode_isreg(vp
)) {
8298 KAUTH_DEBUG("ATTR - ERROR: size change requested on non-file");
8299 error
= vnode_isdir(vp
) ? EISDIR
: EINVAL
;
8307 KAUTH_DEBUG("ATTR - fetching old attributes %016llx", ova
.va_active
);
8308 if ((error
= vnode_getattr(vp
, &ova
, ctx
)) != 0) {
8309 KAUTH_DEBUG(" ERROR - got %d trying to get attributes", error
);
8314 * Size changes require write access to the file data.
8316 if (VATTR_IS_ACTIVE(vap
, va_data_size
)) {
8317 /* if we can't get the size, or it's different, we need write access */
8318 KAUTH_DEBUG("ATTR - size change, requiring WRITE_DATA");
8319 required_action
|= KAUTH_VNODE_WRITE_DATA
;
8323 * Changing timestamps?
8325 * Note that we are only called to authorize user-requested time changes;
8326 * side-effect time changes are not authorized. Authorisation is only
8327 * required for existing files.
8329 * Non-owners are not permitted to change the time on an existing
8330 * file to anything other than the current time.
8332 if (VATTR_IS_ACTIVE(vap
, va_create_time
) ||
8333 VATTR_IS_ACTIVE(vap
, va_change_time
) ||
8334 VATTR_IS_ACTIVE(vap
, va_modify_time
) ||
8335 VATTR_IS_ACTIVE(vap
, va_access_time
) ||
8336 VATTR_IS_ACTIVE(vap
, va_backup_time
)) {
8338 * The owner and root may set any timestamps they like,
8339 * provided that the file is not immutable. The owner still needs
8340 * WRITE_ATTRIBUTES (implied by ownership but still deniable).
8342 if (has_priv_suser
|| vauth_node_owner(&ova
, cred
)) {
8343 KAUTH_DEBUG("ATTR - root or owner changing timestamps");
8344 required_action
|= KAUTH_VNODE_CHECKIMMUTABLE
| KAUTH_VNODE_WRITE_ATTRIBUTES
;
8346 /* just setting the current time? */
8347 if (vap
->va_vaflags
& VA_UTIMES_NULL
) {
8348 KAUTH_DEBUG("ATTR - non-root/owner changing timestamps, requiring WRITE_ATTRIBUTES");
8349 required_action
|= KAUTH_VNODE_WRITE_ATTRIBUTES
;
8351 KAUTH_DEBUG("ATTR - ERROR: illegal timestamp modification attempted");
8359 * Changing file mode?
8361 if (VATTR_IS_ACTIVE(vap
, va_mode
) && VATTR_IS_SUPPORTED(&ova
, va_mode
) && (ova
.va_mode
!= vap
->va_mode
)) {
8362 KAUTH_DEBUG("ATTR - mode change from %06o to %06o", ova
.va_mode
, vap
->va_mode
);
8365 * Mode changes always have the same basic auth requirements.
8367 if (has_priv_suser
) {
8368 KAUTH_DEBUG("ATTR - superuser mode change, requiring immutability check");
8369 required_action
|= KAUTH_VNODE_CHECKIMMUTABLE
;
8371 /* need WRITE_SECURITY */
8372 KAUTH_DEBUG("ATTR - non-superuser mode change, requiring WRITE_SECURITY");
8373 required_action
|= KAUTH_VNODE_WRITE_SECURITY
;
8377 * Can't set the setgid bit if you're not in the group and not root. Have to have
8378 * existing group information in the case we're not setting it right now.
8380 if (vap
->va_mode
& S_ISGID
) {
8381 required_action
|= KAUTH_VNODE_CHECKIMMUTABLE
; /* always required */
8382 if (!has_priv_suser
) {
8383 if (VATTR_IS_ACTIVE(vap
, va_gid
)) {
8384 group
= vap
->va_gid
;
8385 } else if (VATTR_IS_SUPPORTED(&ova
, va_gid
)) {
8388 KAUTH_DEBUG("ATTR - ERROR: setgid but no gid available");
8393 * This might be too restrictive; WRITE_SECURITY might be implied by
8394 * membership in this case, rather than being an additional requirement.
8396 if ((error
= kauth_cred_ismember_gid(cred
, group
, &ismember
)) != 0) {
8397 KAUTH_DEBUG("ATTR - ERROR: got %d checking for membership in %d", error
, vap
->va_gid
);
8401 KAUTH_DEBUG(" DENIED - can't set SGID bit, not a member of %d", group
);
8409 * Can't set the setuid bit unless you're root or the file's owner.
8411 if (vap
->va_mode
& S_ISUID
) {
8412 required_action
|= KAUTH_VNODE_CHECKIMMUTABLE
; /* always required */
8413 if (!has_priv_suser
) {
8414 if (VATTR_IS_ACTIVE(vap
, va_uid
)) {
8415 owner
= vap
->va_uid
;
8416 } else if (VATTR_IS_SUPPORTED(&ova
, va_uid
)) {
8419 KAUTH_DEBUG("ATTR - ERROR: setuid but no uid available");
8423 if (owner
!= kauth_cred_getuid(cred
)) {
8425 * We could allow this if WRITE_SECURITY is permitted, perhaps.
8427 KAUTH_DEBUG("ATTR - ERROR: illegal attempt to set the setuid bit");
8436 * Validate/mask flags changes. This checks that only the flags in
8437 * the UF_SETTABLE mask are being set, and preserves the flags in
8438 * the SF_SETTABLE case.
8440 * Since flags changes may be made in conjunction with other changes,
8441 * we will ask the auth code to ignore immutability in the case that
8442 * the SF_* flags are not set and we are only manipulating the file flags.
8445 if (VATTR_IS_ACTIVE(vap
, va_flags
)) {
8446 /* compute changing flags bits */
8447 if (VATTR_IS_SUPPORTED(&ova
, va_flags
)) {
8448 fdelta
= vap
->va_flags
^ ova
.va_flags
;
8450 fdelta
= vap
->va_flags
;
8454 KAUTH_DEBUG("ATTR - flags changing, requiring WRITE_SECURITY");
8455 required_action
|= KAUTH_VNODE_WRITE_SECURITY
;
8457 /* check that changing bits are legal */
8458 if (has_priv_suser
) {
8460 * The immutability check will prevent us from clearing the SF_*
8461 * flags unless the system securelevel permits it, so just check
8462 * for legal flags here.
8464 if (fdelta
& ~(UF_SETTABLE
| SF_SETTABLE
)) {
8466 KAUTH_DEBUG(" DENIED - superuser attempt to set illegal flag(s)");
8470 if (fdelta
& ~UF_SETTABLE
) {
8472 KAUTH_DEBUG(" DENIED - user attempt to set illegal flag(s)");
8477 * If the caller has the ability to manipulate file flags,
8478 * security is not reduced by ignoring them for this operation.
8480 * A more complete test here would consider the 'after' states of the flags
8481 * to determine whether it would permit the operation, but this becomes
8484 * Ignoring immutability is conditional on securelevel; this does not bypass
8485 * the SF_* flags if securelevel > 0.
8487 required_action
|= KAUTH_VNODE_NOIMMUTABLE
;
8492 * Validate ownership information.
8501 * Note that if the filesystem didn't give us a UID, we expect that it doesn't
8502 * support them in general, and will ignore it if/when we try to set it.
8503 * We might want to clear the uid out of vap completely here.
8505 if (VATTR_IS_ACTIVE(vap
, va_uid
)) {
8506 if (VATTR_IS_SUPPORTED(&ova
, va_uid
) && (vap
->va_uid
!= ova
.va_uid
)) {
8507 if (!has_priv_suser
&& (kauth_cred_getuid(cred
) != vap
->va_uid
)) {
8508 KAUTH_DEBUG(" DENIED - non-superuser cannot change ownershipt to a third party");
8519 * Note that if the filesystem didn't give us a GID, we expect that it doesn't
8520 * support them in general, and will ignore it if/when we try to set it.
8521 * We might want to clear the gid out of vap completely here.
8523 if (VATTR_IS_ACTIVE(vap
, va_gid
)) {
8524 if (VATTR_IS_SUPPORTED(&ova
, va_gid
) && (vap
->va_gid
!= ova
.va_gid
)) {
8525 if (!has_priv_suser
) {
8526 if ((error
= kauth_cred_ismember_gid(cred
, vap
->va_gid
, &ismember
)) != 0) {
8527 KAUTH_DEBUG(" ERROR - got %d checking for membership in %d", error
, vap
->va_gid
);
8531 KAUTH_DEBUG(" DENIED - group change from %d to %d but not a member of target group",
8532 ova
.va_gid
, vap
->va_gid
);
8543 * Owner UUID being set or changed.
8545 if (VATTR_IS_ACTIVE(vap
, va_uuuid
)) {
8546 /* if the owner UUID is not actually changing ... */
8547 if (VATTR_IS_SUPPORTED(&ova
, va_uuuid
)) {
8548 if (kauth_guid_equal(&vap
->va_uuuid
, &ova
.va_uuuid
))
8549 goto no_uuuid_change
;
8552 * If the current owner UUID is a null GUID, check
8553 * it against the UUID corresponding to the owner UID.
8555 if (kauth_guid_equal(&ova
.va_uuuid
, &kauth_null_guid
) &&
8556 VATTR_IS_SUPPORTED(&ova
, va_uid
)) {
8559 if (kauth_cred_uid2guid(ova
.va_uid
, &uid_guid
) == 0 &&
8560 kauth_guid_equal(&vap
->va_uuuid
, &uid_guid
))
8561 goto no_uuuid_change
;
8566 * The owner UUID cannot be set by a non-superuser to anything other than
8567 * their own or a null GUID (to "unset" the owner UUID).
8568 * Note that file systems must be prepared to handle the
8569 * null UUID case in a manner appropriate for that file
8572 if (!has_priv_suser
) {
8573 if ((error
= kauth_cred_getguid(cred
, &changer
)) != 0) {
8574 KAUTH_DEBUG(" ERROR - got %d trying to get caller UUID", error
);
8575 /* XXX ENOENT here - no UUID - should perhaps become EPERM */
8578 if (!kauth_guid_equal(&vap
->va_uuuid
, &changer
) &&
8579 !kauth_guid_equal(&vap
->va_uuuid
, &kauth_null_guid
)) {
8580 KAUTH_DEBUG(" ERROR - cannot set supplied owner UUID - not us / null");
8590 * Group UUID being set or changed.
8592 if (VATTR_IS_ACTIVE(vap
, va_guuid
)) {
8593 /* if the group UUID is not actually changing ... */
8594 if (VATTR_IS_SUPPORTED(&ova
, va_guuid
)) {
8595 if (kauth_guid_equal(&vap
->va_guuid
, &ova
.va_guuid
))
8596 goto no_guuid_change
;
8599 * If the current group UUID is a null UUID, check
8600 * it against the UUID corresponding to the group GID.
8602 if (kauth_guid_equal(&ova
.va_guuid
, &kauth_null_guid
) &&
8603 VATTR_IS_SUPPORTED(&ova
, va_gid
)) {
8606 if (kauth_cred_gid2guid(ova
.va_gid
, &gid_guid
) == 0 &&
8607 kauth_guid_equal(&vap
->va_guuid
, &gid_guid
))
8608 goto no_guuid_change
;
8613 * The group UUID cannot be set by a non-superuser to anything other than
8614 * one of which they are a member or a null GUID (to "unset"
8616 * Note that file systems must be prepared to handle the
8617 * null UUID case in a manner appropriate for that file
8620 if (!has_priv_suser
) {
8621 if (kauth_guid_equal(&vap
->va_guuid
, &kauth_null_guid
))
8623 else if ((error
= kauth_cred_ismember_guid(cred
, &vap
->va_guuid
, &ismember
)) != 0) {
8624 KAUTH_DEBUG(" ERROR - got %d trying to check group membership", error
);
8628 KAUTH_DEBUG(" ERROR - cannot set supplied group UUID - not a member / null");
8638 * Compute authorisation for group/ownership changes.
8640 if (chowner
|| chgroup
|| clear_suid
|| clear_sgid
) {
8641 if (has_priv_suser
) {
8642 KAUTH_DEBUG("ATTR - superuser changing file owner/group, requiring immutability check");
8643 required_action
|= KAUTH_VNODE_CHECKIMMUTABLE
;
8646 KAUTH_DEBUG("ATTR - ownership change, requiring TAKE_OWNERSHIP");
8647 required_action
|= KAUTH_VNODE_TAKE_OWNERSHIP
;
8649 if (chgroup
&& !chowner
) {
8650 KAUTH_DEBUG("ATTR - group change, requiring WRITE_SECURITY");
8651 required_action
|= KAUTH_VNODE_WRITE_SECURITY
;
8657 * clear set-uid and set-gid bits. POSIX only requires this for
8658 * non-privileged processes but we do it even for root.
8660 if (VATTR_IS_ACTIVE(vap
, va_mode
)) {
8661 newmode
= vap
->va_mode
;
8662 } else if (VATTR_IS_SUPPORTED(&ova
, va_mode
)) {
8663 newmode
= ova
.va_mode
;
8665 KAUTH_DEBUG("CHOWN - trying to change owner but cannot get mode from filesystem to mask setugid bits");
8669 /* chown always clears setuid/gid bits. An exception is made for
8670 * setattrlist executed by a root process to set <uid, gid, mode> on a file:
8671 * setattrlist is allowed to set the new mode on the file and change (chown)
8674 if (newmode
& (S_ISUID
| S_ISGID
)) {
8675 if (!VATTR_IS_ACTIVE(vap
, va_mode
) || !has_priv_suser
) {
8676 KAUTH_DEBUG("CHOWN - masking setugid bits from mode %o to %o",
8677 newmode
, newmode
& ~(S_ISUID
| S_ISGID
));
8678 newmode
&= ~(S_ISUID
| S_ISGID
);
8680 VATTR_SET(vap
, va_mode
, newmode
);
8685 * Authorise changes in the ACL.
8687 if (VATTR_IS_ACTIVE(vap
, va_acl
)) {
8689 /* no existing ACL */
8690 if (!VATTR_IS_ACTIVE(&ova
, va_acl
) || (ova
.va_acl
== NULL
)) {
8693 if (vap
->va_acl
!= NULL
) {
8694 required_action
|= KAUTH_VNODE_WRITE_SECURITY
;
8695 KAUTH_DEBUG("CHMOD - adding ACL");
8698 /* removing an existing ACL */
8699 } else if (vap
->va_acl
== NULL
) {
8700 required_action
|= KAUTH_VNODE_WRITE_SECURITY
;
8701 KAUTH_DEBUG("CHMOD - removing ACL");
8703 /* updating an existing ACL */
8705 if (vap
->va_acl
->acl_entrycount
!= ova
.va_acl
->acl_entrycount
) {
8706 /* entry count changed, must be different */
8707 required_action
|= KAUTH_VNODE_WRITE_SECURITY
;
8708 KAUTH_DEBUG("CHMOD - adding/removing ACL entries");
8709 } else if (vap
->va_acl
->acl_entrycount
> 0) {
8710 /* both ACLs have the same ACE count, said count is 1 or more, bitwise compare ACLs */
8711 if (memcmp(&vap
->va_acl
->acl_ace
[0], &ova
.va_acl
->acl_ace
[0],
8712 sizeof(struct kauth_ace
) * vap
->va_acl
->acl_entrycount
)) {
8713 required_action
|= KAUTH_VNODE_WRITE_SECURITY
;
8714 KAUTH_DEBUG("CHMOD - changing ACL entries");
8721 * Other attributes that require authorisation.
8723 if (VATTR_IS_ACTIVE(vap
, va_encoding
))
8724 required_action
|= KAUTH_VNODE_WRITE_ATTRIBUTES
;
8727 if (VATTR_IS_SUPPORTED(&ova
, va_acl
) && (ova
.va_acl
!= NULL
))
8728 kauth_acl_free(ova
.va_acl
);
8730 *actionp
= required_action
;
8735 setlocklocal_callback(struct vnode
*vp
, __unused
void *cargs
)
8737 vnode_lock_spin(vp
);
8738 vp
->v_flag
|= VLOCKLOCAL
;
8741 return (VNODE_RETURNED
);
8745 vfs_setlocklocal(mount_t mp
)
8747 mount_lock_spin(mp
);
8748 mp
->mnt_kern_flag
|= MNTK_LOCK_LOCAL
;
8752 * The number of active vnodes is expected to be
8753 * very small when vfs_setlocklocal is invoked.
8755 vnode_iterate(mp
, 0, setlocklocal_callback
, NULL
);
8759 vfs_setcompoundopen(mount_t mp
)
8761 mount_lock_spin(mp
);
8762 mp
->mnt_compound_ops
|= COMPOUND_VNOP_OPEN
;
8768 vnode_setswapmount(vnode_t vp
)
8770 mount_lock(vp
->v_mount
);
8771 vp
->v_mount
->mnt_kern_flag
|= MNTK_SWAP_MOUNT
;
8772 mount_unlock(vp
->v_mount
);
8777 vnode_getswappin_avail(vnode_t vp
)
8779 int64_t max_swappin_avail
= 0;
8781 mount_lock(vp
->v_mount
);
8782 if (vp
->v_mount
->mnt_ioflags
& MNT_IOFLAGS_SWAPPIN_SUPPORTED
)
8783 max_swappin_avail
= vp
->v_mount
->mnt_max_swappin_available
;
8784 mount_unlock(vp
->v_mount
);
8786 return (max_swappin_avail
);
8791 vn_setunionwait(vnode_t vp
)
8793 vnode_lock_spin(vp
);
8794 vp
->v_flag
|= VISUNION
;
8800 vn_checkunionwait(vnode_t vp
)
8802 vnode_lock_spin(vp
);
8803 while ((vp
->v_flag
& VISUNION
) == VISUNION
)
8804 msleep((caddr_t
)&vp
->v_flag
, &vp
->v_lock
, 0, 0, 0);
8809 vn_clearunionwait(vnode_t vp
, int locked
)
8812 vnode_lock_spin(vp
);
8813 if((vp
->v_flag
& VISUNION
) == VISUNION
) {
8814 vp
->v_flag
&= ~VISUNION
;
8815 wakeup((caddr_t
)&vp
->v_flag
);
8822 * Removes orphaned apple double files during a rmdir
8824 * 1. vnode_suspend().
8825 * 2. Call VNOP_READDIR() till the end of directory is reached.
8826 * 3. Check if the directory entries returned are regular files with name starting with "._". If not, return ENOTEMPTY.
8827 * 4. Continue (2) and (3) till end of directory is reached.
8828 * 5. If all the entries in the directory were files with "._" name, delete all the files.
8830 * 7. If deletion of all files succeeded, call VNOP_RMDIR() again.
8833 errno_t
rmdir_remove_orphaned_appleDouble(vnode_t vp
, vfs_context_t ctx
, int * restart_flag
)
8836 #define UIO_BUFF_SIZE 2048
8838 int eofflag
, siz
= UIO_BUFF_SIZE
, nentries
= 0;
8839 int open_flag
= 0, full_erase_flag
= 0;
8840 char uio_buf
[ UIO_SIZEOF(1) ];
8847 error
= vnode_suspend(vp
);
8850 * restart_flag is set so that the calling rmdir sleeps and resets
8860 MALLOC(rbuf
, caddr_t
, siz
, M_TEMP
, M_WAITOK
);
8862 auio
= uio_createwithbuffer(1, 0, UIO_SYSSPACE
, UIO_READ
,
8863 &uio_buf
[0], sizeof(uio_buf
));
8864 if (!rbuf
|| !auio
) {
8869 uio_setoffset(auio
,0);
8873 if ((error
= VNOP_OPEN(vp
, FREAD
, ctx
)))
8879 * First pass checks if all files are appleDouble files.
8883 siz
= UIO_BUFF_SIZE
;
8884 uio_reset(auio
, uio_offset(auio
), UIO_SYSSPACE
, UIO_READ
);
8885 uio_addiov(auio
, CAST_USER_ADDR_T(rbuf
), UIO_BUFF_SIZE
);
8887 if((error
= VNOP_READDIR(vp
, auio
, 0, &eofflag
, &nentries
, ctx
)))
8890 if (uio_resid(auio
) != 0)
8891 siz
-= uio_resid(auio
);
8894 * Iterate through directory
8896 dir_pos
= (void*) rbuf
;
8897 dir_end
= (void*) (rbuf
+ siz
);
8898 dp
= (struct dirent
*) (dir_pos
);
8900 if (dir_pos
== dir_end
)
8903 while (dir_pos
< dir_end
) {
8905 * Check for . and .. as well as directories
8907 if (dp
->d_ino
!= 0 &&
8908 !((dp
->d_namlen
== 1 && dp
->d_name
[0] == '.') ||
8909 (dp
->d_namlen
== 2 && dp
->d_name
[0] == '.' && dp
->d_name
[1] == '.'))) {
8911 * Check for irregular files and ._ files
8912 * If there is a ._._ file abort the op
8914 if ( dp
->d_namlen
< 2 ||
8915 strncmp(dp
->d_name
,"._",2) ||
8916 (dp
->d_namlen
>= 4 && !strncmp(&(dp
->d_name
[2]), "._",2))) {
8921 dir_pos
= (void*) ((uint8_t*)dir_pos
+ dp
->d_reclen
);
8922 dp
= (struct dirent
*)dir_pos
;
8926 * workaround for HFS/NFS setting eofflag before end of file
8928 if (vp
->v_tag
== VT_HFS
&& nentries
> 2)
8931 if (vp
->v_tag
== VT_NFS
) {
8932 if (eofflag
&& !full_erase_flag
) {
8933 full_erase_flag
= 1;
8935 uio_reset(auio
, 0, UIO_SYSSPACE
, UIO_READ
);
8937 else if (!eofflag
&& full_erase_flag
)
8938 full_erase_flag
= 0;
8943 * If we've made it here all the files in the dir are ._ files.
8944 * We can delete the files even though the node is suspended
8945 * because we are the owner of the file.
8948 uio_reset(auio
, 0, UIO_SYSSPACE
, UIO_READ
);
8950 full_erase_flag
= 0;
8953 siz
= UIO_BUFF_SIZE
;
8954 uio_reset(auio
, uio_offset(auio
), UIO_SYSSPACE
, UIO_READ
);
8955 uio_addiov(auio
, CAST_USER_ADDR_T(rbuf
), UIO_BUFF_SIZE
);
8957 error
= VNOP_READDIR(vp
, auio
, 0, &eofflag
, &nentries
, ctx
);
8962 if (uio_resid(auio
) != 0)
8963 siz
-= uio_resid(auio
);
8966 * Iterate through directory
8968 dir_pos
= (void*) rbuf
;
8969 dir_end
= (void*) (rbuf
+ siz
);
8970 dp
= (struct dirent
*) dir_pos
;
8972 if (dir_pos
== dir_end
)
8975 while (dir_pos
< dir_end
) {
8977 * Check for . and .. as well as directories
8979 if (dp
->d_ino
!= 0 &&
8980 !((dp
->d_namlen
== 1 && dp
->d_name
[0] == '.') ||
8981 (dp
->d_namlen
== 2 && dp
->d_name
[0] == '.' && dp
->d_name
[1] == '.'))
8984 error
= unlink1(ctx
, vp
,
8985 CAST_USER_ADDR_T(dp
->d_name
), UIO_SYSSPACE
,
8986 VNODE_REMOVE_SKIP_NAMESPACE_EVENT
|
8987 VNODE_REMOVE_NO_AUDIT_PATH
);
8989 if (error
&& error
!= ENOENT
) {
8994 dir_pos
= (void*) ((uint8_t*)dir_pos
+ dp
->d_reclen
);
8995 dp
= (struct dirent
*)dir_pos
;
8999 * workaround for HFS/NFS setting eofflag before end of file
9001 if (vp
->v_tag
== VT_HFS
&& nentries
> 2)
9004 if (vp
->v_tag
== VT_NFS
) {
9005 if (eofflag
&& !full_erase_flag
) {
9006 full_erase_flag
= 1;
9008 uio_reset(auio
, 0, UIO_SYSSPACE
, UIO_READ
);
9010 else if (!eofflag
&& full_erase_flag
)
9011 full_erase_flag
= 0;
9021 VNOP_CLOSE(vp
, FREAD
, ctx
);
9036 lock_vnode_and_post(vnode_t vp
, int kevent_num
)
9038 /* Only take the lock if there's something there! */
9039 if (vp
->v_knotes
.slh_first
!= NULL
) {
9041 KNOTE(&vp
->v_knotes
, kevent_num
);
9046 void panic_print_vnodes(void);
9048 /* define PANIC_PRINTS_VNODES only if investigation is required. */
9049 #ifdef PANIC_PRINTS_VNODES
9051 static const char *__vtype(uint16_t vtype
)
9080 * build a path from the bottom up
9081 * NOTE: called from the panic path - no alloc'ing of memory and no locks!
9083 static char *__vpath(vnode_t vp
, char *str
, int len
, int depth
)
9091 /* str + len is the start of the string we created */
9095 /* follow mount vnodes to get the full path */
9096 if ((vp
->v_flag
& VROOT
)) {
9097 if (vp
->v_mount
!= NULL
&& vp
->v_mount
->mnt_vnodecovered
) {
9098 return __vpath(vp
->v_mount
->mnt_vnodecovered
,
9105 vnm_len
= strlen(src
);
9106 if (vnm_len
> len
) {
9107 /* truncate the name to fit in the string */
9108 src
+= (vnm_len
- len
);
9112 /* start from the back and copy just characters (no NULLs) */
9114 /* this will chop off leaf path (file) names */
9116 dst
= str
+ len
- vnm_len
;
9117 memcpy(dst
, src
, vnm_len
);
9123 if (vp
->v_parent
&& len
> 1) {
9124 /* follow parents up the chain */
9127 return __vpath(vp
->v_parent
, str
, len
, depth
+ 1);
9133 extern int kdb_printf(const char *format
, ...) __printflike(1,2);
9135 #define SANE_VNODE_PRINT_LIMIT 5000
9136 void panic_print_vnodes(void)
9145 kdb_printf("\n***** VNODES *****\n"
9146 "TYPE UREF ICNT PATH\n");
9148 /* NULL-terminate the path name */
9149 vname
[sizeof(vname
)-1] = '\0';
9152 * iterate all vnodelist items in all mounts (mntlist) -> mnt_vnodelist
9154 TAILQ_FOREACH(mnt
, &mountlist
, mnt_list
) {
9156 if (!ml_validate_nofault((vm_offset_t
)mnt
, sizeof(mount_t
))) {
9157 kdb_printf("Unable to iterate the mount list %p - encountered an invalid mount pointer %p \n",
9162 TAILQ_FOREACH(vp
, &mnt
->mnt_vnodelist
, v_mntvnodes
) {
9164 if (!ml_validate_nofault((vm_offset_t
)vp
, sizeof(vnode_t
))) {
9165 kdb_printf("Unable to iterate the vnode list %p - encountered an invalid vnode pointer %p \n",
9166 &mnt
->mnt_vnodelist
, vp
);
9170 if (++nvnodes
> SANE_VNODE_PRINT_LIMIT
)
9172 type
= __vtype(vp
->v_type
);
9173 nm
= __vpath(vp
, vname
, sizeof(vname
)-1, 0);
9174 kdb_printf("%s %0d %0d %s\n",
9175 type
, vp
->v_usecount
, vp
->v_iocount
, nm
);
9180 #else /* !PANIC_PRINTS_VNODES */
9181 void panic_print_vnodes(void)
9189 static void record_vp(vnode_t vp
, int count
) {
9196 if ((vp
->v_flag
& VSYSTEM
))
9199 ut
= get_bsdthread_info(current_thread());
9200 ut
->uu_iocount
+= count
;
9203 if (ut
->uu_vpindex
< 32) {
9204 OSBacktrace((void **)&ut
->uu_pcs
[ut
->uu_vpindex
][0], 10);
9206 ut
->uu_vps
[ut
->uu_vpindex
] = vp
;
9216 #define TRIG_DEBUG 0
9219 #define TRIG_LOG(...) do { printf("%s: ", __FUNCTION__); printf(__VA_ARGS__); } while (0)
9221 #define TRIG_LOG(...)
9225 * Resolver result functions
9229 vfs_resolver_result(uint32_t seq
, enum resolver_status stat
, int aux
)
9232 * |<--- 32 --->|<--- 28 --->|<- 4 ->|
9233 * sequence auxiliary status
9235 return (((uint64_t)seq
) << 32) |
9236 (((uint64_t)(aux
& 0x0fffffff)) << 4) |
9237 (uint64_t)(stat
& 0x0000000F);
9240 enum resolver_status
9241 vfs_resolver_status(resolver_result_t result
)
9243 /* lower 4 bits is status */
9244 return (result
& 0x0000000F);
9248 vfs_resolver_sequence(resolver_result_t result
)
9250 /* upper 32 bits is sequence */
9251 return (uint32_t)(result
>> 32);
9255 vfs_resolver_auxiliary(resolver_result_t result
)
9257 /* 28 bits of auxiliary */
9258 return (int)(((uint32_t)(result
& 0xFFFFFFF0)) >> 4);
9263 * Call in for resolvers to update vnode trigger state
9266 vnode_trigger_update(vnode_t vp
, resolver_result_t result
)
9270 enum resolver_status stat
;
9272 if (vp
->v_resolve
== NULL
) {
9276 stat
= vfs_resolver_status(result
);
9277 seq
= vfs_resolver_sequence(result
);
9279 if ((stat
!= RESOLVER_RESOLVED
) && (stat
!= RESOLVER_UNRESOLVED
)) {
9284 lck_mtx_lock(&rp
->vr_lock
);
9286 if (seq
> rp
->vr_lastseq
) {
9287 if (stat
== RESOLVER_RESOLVED
)
9288 rp
->vr_flags
|= VNT_RESOLVED
;
9290 rp
->vr_flags
&= ~VNT_RESOLVED
;
9292 rp
->vr_lastseq
= seq
;
9295 lck_mtx_unlock(&rp
->vr_lock
);
9301 vnode_resolver_attach(vnode_t vp
, vnode_resolve_t rp
, boolean_t ref
)
9305 vnode_lock_spin(vp
);
9306 if (vp
->v_resolve
!= NULL
) {
9315 error
= vnode_ref_ext(vp
, O_EVTONLY
, VNODE_REF_FORCE
);
9317 panic("VNODE_REF_FORCE didn't help...");
9325 * VFS internal interfaces for vnode triggers
9327 * vnode must already have an io count on entry
9328 * v_resolve is stable when io count is non-zero
9331 vnode_resolver_create(mount_t mp
, vnode_t vp
, struct vnode_trigger_param
*tinfo
, boolean_t external
)
9338 /* minimum pointer test (debugging) */
9339 if (tinfo
->vnt_data
)
9340 byte
= *((char *)tinfo
->vnt_data
);
9342 MALLOC(rp
, vnode_resolve_t
, sizeof(*rp
), M_TEMP
, M_WAITOK
);
9346 lck_mtx_init(&rp
->vr_lock
, trigger_vnode_lck_grp
, trigger_vnode_lck_attr
);
9348 rp
->vr_resolve_func
= tinfo
->vnt_resolve_func
;
9349 rp
->vr_unresolve_func
= tinfo
->vnt_unresolve_func
;
9350 rp
->vr_rearm_func
= tinfo
->vnt_rearm_func
;
9351 rp
->vr_reclaim_func
= tinfo
->vnt_reclaim_func
;
9352 rp
->vr_data
= tinfo
->vnt_data
;
9354 rp
->vr_flags
= tinfo
->vnt_flags
& VNT_VALID_MASK
;
9356 rp
->vr_flags
|= VNT_EXTERNAL
;
9359 result
= vnode_resolver_attach(vp
, rp
, external
);
9365 OSAddAtomic(1, &mp
->mnt_numtriggers
);
9376 vnode_resolver_release(vnode_resolve_t rp
)
9379 * Give them a chance to free any private data
9381 if (rp
->vr_data
&& rp
->vr_reclaim_func
) {
9382 rp
->vr_reclaim_func(NULLVP
, rp
->vr_data
);
9385 lck_mtx_destroy(&rp
->vr_lock
, trigger_vnode_lck_grp
);
9390 /* Called after the vnode has been drained */
9392 vnode_resolver_detach(vnode_t vp
)
9397 mp
= vnode_mount(vp
);
9401 vp
->v_resolve
= NULL
;
9404 if ((rp
->vr_flags
& VNT_EXTERNAL
) != 0) {
9405 vnode_rele_ext(vp
, O_EVTONLY
, 1);
9408 vnode_resolver_release(rp
);
9410 /* Keep count of active trigger vnodes per mount */
9411 OSAddAtomic(-1, &mp
->mnt_numtriggers
);
9416 vnode_trigger_rearm(vnode_t vp
, vfs_context_t ctx
)
9419 resolver_result_t result
;
9420 enum resolver_status status
;
9423 if ((vp
->v_resolve
== NULL
) ||
9424 (vp
->v_resolve
->vr_rearm_func
== NULL
) ||
9425 (vp
->v_resolve
->vr_flags
& VNT_AUTO_REARM
) == 0) {
9430 lck_mtx_lock(&rp
->vr_lock
);
9433 * Check if VFS initiated this unmount. If so, we'll catch it after the unresolve completes.
9435 if (rp
->vr_flags
& VNT_VFS_UNMOUNTED
) {
9436 lck_mtx_unlock(&rp
->vr_lock
);
9440 /* Check if this vnode is already armed */
9441 if ((rp
->vr_flags
& VNT_RESOLVED
) == 0) {
9442 lck_mtx_unlock(&rp
->vr_lock
);
9446 lck_mtx_unlock(&rp
->vr_lock
);
9448 result
= rp
->vr_rearm_func(vp
, 0, rp
->vr_data
, ctx
);
9449 status
= vfs_resolver_status(result
);
9450 seq
= vfs_resolver_sequence(result
);
9452 lck_mtx_lock(&rp
->vr_lock
);
9453 if (seq
> rp
->vr_lastseq
) {
9454 if (status
== RESOLVER_UNRESOLVED
)
9455 rp
->vr_flags
&= ~VNT_RESOLVED
;
9456 rp
->vr_lastseq
= seq
;
9458 lck_mtx_unlock(&rp
->vr_lock
);
9463 vnode_trigger_resolve(vnode_t vp
, struct nameidata
*ndp
, vfs_context_t ctx
)
9466 enum path_operation op
;
9467 resolver_result_t result
;
9468 enum resolver_status status
;
9471 /* Only trigger on topmost vnodes */
9472 if ((vp
->v_resolve
== NULL
) ||
9473 (vp
->v_resolve
->vr_resolve_func
== NULL
) ||
9474 (vp
->v_mountedhere
!= NULL
)) {
9479 lck_mtx_lock(&rp
->vr_lock
);
9481 /* Check if this vnode is already resolved */
9482 if (rp
->vr_flags
& VNT_RESOLVED
) {
9483 lck_mtx_unlock(&rp
->vr_lock
);
9487 lck_mtx_unlock(&rp
->vr_lock
);
9491 * assumes that resolver will not access this trigger vnode (otherwise the kernel will deadlock)
9492 * is there anyway to know this???
9493 * there can also be other legitimate lookups in parallel
9495 * XXX - should we call this on a separate thread with a timeout?
9497 * XXX - should we use ISLASTCN to pick the op value??? Perhaps only leafs should
9498 * get the richer set and non-leafs should get generic OP_LOOKUP? TBD
9500 op
= (ndp
->ni_op
< OP_MAXOP
) ? ndp
->ni_op
: OP_LOOKUP
;
9502 result
= rp
->vr_resolve_func(vp
, &ndp
->ni_cnd
, op
, 0, rp
->vr_data
, ctx
);
9503 status
= vfs_resolver_status(result
);
9504 seq
= vfs_resolver_sequence(result
);
9506 lck_mtx_lock(&rp
->vr_lock
);
9507 if (seq
> rp
->vr_lastseq
) {
9508 if (status
== RESOLVER_RESOLVED
)
9509 rp
->vr_flags
|= VNT_RESOLVED
;
9510 rp
->vr_lastseq
= seq
;
9512 lck_mtx_unlock(&rp
->vr_lock
);
9514 /* On resolver errors, propagate the error back up */
9515 return (status
== RESOLVER_ERROR
? vfs_resolver_auxiliary(result
) : 0);
9519 vnode_trigger_unresolve(vnode_t vp
, int flags
, vfs_context_t ctx
)
9522 resolver_result_t result
;
9523 enum resolver_status status
;
9526 if ((vp
->v_resolve
== NULL
) || (vp
->v_resolve
->vr_unresolve_func
== NULL
)) {
9531 lck_mtx_lock(&rp
->vr_lock
);
9533 /* Check if this vnode is already resolved */
9534 if ((rp
->vr_flags
& VNT_RESOLVED
) == 0) {
9535 printf("vnode_trigger_unresolve: not currently resolved\n");
9536 lck_mtx_unlock(&rp
->vr_lock
);
9540 rp
->vr_flags
|= VNT_VFS_UNMOUNTED
;
9542 lck_mtx_unlock(&rp
->vr_lock
);
9546 * assumes that resolver will not access this trigger vnode (otherwise the kernel will deadlock)
9547 * there can also be other legitimate lookups in parallel
9549 * XXX - should we call this on a separate thread with a timeout?
9552 result
= rp
->vr_unresolve_func(vp
, flags
, rp
->vr_data
, ctx
);
9553 status
= vfs_resolver_status(result
);
9554 seq
= vfs_resolver_sequence(result
);
9556 lck_mtx_lock(&rp
->vr_lock
);
9557 if (seq
> rp
->vr_lastseq
) {
9558 if (status
== RESOLVER_UNRESOLVED
)
9559 rp
->vr_flags
&= ~VNT_RESOLVED
;
9560 rp
->vr_lastseq
= seq
;
9562 rp
->vr_flags
&= ~VNT_VFS_UNMOUNTED
;
9563 lck_mtx_unlock(&rp
->vr_lock
);
9565 /* On resolver errors, propagate the error back up */
9566 return (status
== RESOLVER_ERROR
? vfs_resolver_auxiliary(result
) : 0);
9570 triggerisdescendant(mount_t mp
, mount_t rmp
)
9575 * walk up vnode covered chain looking for a match
9577 name_cache_lock_shared();
9582 /* did we encounter "/" ? */
9583 if (mp
->mnt_flag
& MNT_ROOTFS
)
9586 vp
= mp
->mnt_vnodecovered
;
9597 name_cache_unlock();
9602 struct trigger_unmount_info
{
9607 uint32_t trigger_vid
;
9612 trigger_unmount_callback(mount_t mp
, void * arg
)
9614 struct trigger_unmount_info
* infop
= (struct trigger_unmount_info
*)arg
;
9615 boolean_t mountedtrigger
= FALSE
;
9618 * When we encounter the top level mount we're done
9620 if (mp
== infop
->top_mp
)
9621 return (VFS_RETURNED_DONE
);
9623 if ((mp
->mnt_vnodecovered
== NULL
) ||
9624 (vnode_getwithref(mp
->mnt_vnodecovered
) != 0)) {
9625 return (VFS_RETURNED
);
9628 if ((mp
->mnt_vnodecovered
->v_mountedhere
== mp
) &&
9629 (mp
->mnt_vnodecovered
->v_resolve
!= NULL
) &&
9630 (mp
->mnt_vnodecovered
->v_resolve
->vr_flags
& VNT_RESOLVED
)) {
9631 mountedtrigger
= TRUE
;
9633 vnode_put(mp
->mnt_vnodecovered
);
9636 * When we encounter a mounted trigger, check if its under the top level mount
9638 if ( !mountedtrigger
|| !triggerisdescendant(mp
, infop
->top_mp
) )
9639 return (VFS_RETURNED
);
9642 * Process any pending nested mount (now that its not referenced)
9644 if ((infop
->trigger_vp
!= NULLVP
) &&
9645 (vnode_getwithvid(infop
->trigger_vp
, infop
->trigger_vid
) == 0)) {
9646 vnode_t vp
= infop
->trigger_vp
;
9649 infop
->trigger_vp
= NULLVP
;
9651 if (mp
== vp
->v_mountedhere
) {
9653 printf("trigger_unmount_callback: unexpected match '%s'\n",
9654 mp
->mnt_vfsstat
.f_mntonname
);
9655 return (VFS_RETURNED
);
9657 if (infop
->trigger_mp
!= vp
->v_mountedhere
) {
9659 printf("trigger_unmount_callback: trigger mnt changed! (%p != %p)\n",
9660 infop
->trigger_mp
, vp
->v_mountedhere
);
9664 error
= vnode_trigger_unresolve(vp
, infop
->flags
, infop
->ctx
);
9667 printf("unresolving: '%s', err %d\n",
9668 vp
->v_mountedhere
? vp
->v_mountedhere
->mnt_vfsstat
.f_mntonname
:
9670 return (VFS_RETURNED_DONE
); /* stop iteration on errors */
9675 * We can't call resolver here since we hold a mount iter
9676 * ref on mp so save its covered vp for later processing
9678 infop
->trigger_vp
= mp
->mnt_vnodecovered
;
9679 if ((infop
->trigger_vp
!= NULLVP
) &&
9680 (vnode_getwithref(infop
->trigger_vp
) == 0)) {
9681 if (infop
->trigger_vp
->v_mountedhere
== mp
) {
9682 infop
->trigger_vid
= infop
->trigger_vp
->v_id
;
9683 infop
->trigger_mp
= mp
;
9685 vnode_put(infop
->trigger_vp
);
9688 return (VFS_RETURNED
);
9692 * Attempt to unmount any trigger mounts nested underneath a mount.
9693 * This is a best effort attempt and no retries are performed here.
9695 * Note: mp->mnt_rwlock is held exclusively on entry (so be carefull)
9699 vfs_nested_trigger_unmounts(mount_t mp
, int flags
, vfs_context_t ctx
)
9701 struct trigger_unmount_info info
;
9703 /* Must have trigger vnodes */
9704 if (mp
->mnt_numtriggers
== 0) {
9707 /* Avoid recursive requests (by checking covered vnode) */
9708 if ((mp
->mnt_vnodecovered
!= NULL
) &&
9709 (vnode_getwithref(mp
->mnt_vnodecovered
) == 0)) {
9710 boolean_t recursive
= FALSE
;
9712 if ((mp
->mnt_vnodecovered
->v_mountedhere
== mp
) &&
9713 (mp
->mnt_vnodecovered
->v_resolve
!= NULL
) &&
9714 (mp
->mnt_vnodecovered
->v_resolve
->vr_flags
& VNT_VFS_UNMOUNTED
)) {
9717 vnode_put(mp
->mnt_vnodecovered
);
9723 * Attempt to unmount any nested trigger mounts (best effort)
9727 info
.trigger_vp
= NULLVP
;
9728 info
.trigger_vid
= 0;
9729 info
.trigger_mp
= NULL
;
9732 (void) vfs_iterate(VFS_ITERATE_TAIL_FIRST
, trigger_unmount_callback
, &info
);
9735 * Process remaining nested mount (now that its not referenced)
9737 if ((info
.trigger_vp
!= NULLVP
) &&
9738 (vnode_getwithvid(info
.trigger_vp
, info
.trigger_vid
) == 0)) {
9739 vnode_t vp
= info
.trigger_vp
;
9741 if (info
.trigger_mp
== vp
->v_mountedhere
) {
9742 (void) vnode_trigger_unresolve(vp
, flags
, ctx
);
9749 vfs_addtrigger(mount_t mp
, const char *relpath
, struct vnode_trigger_info
*vtip
, vfs_context_t ctx
)
9751 struct nameidata nd
;
9754 struct vnode_trigger_param vtp
;
9757 * Must be called for trigger callback, wherein rwlock is held
9759 lck_rw_assert(&mp
->mnt_rwlock
, LCK_RW_ASSERT_HELD
);
9761 TRIG_LOG("Adding trigger at %s\n", relpath
);
9762 TRIG_LOG("Trying VFS_ROOT\n");
9765 * We do a lookup starting at the root of the mountpoint, unwilling
9766 * to cross into other mountpoints.
9768 res
= VFS_ROOT(mp
, &rvp
, ctx
);
9773 TRIG_LOG("Trying namei\n");
9775 NDINIT(&nd
, LOOKUP
, OP_LOOKUP
, USEDVP
| NOCROSSMOUNT
| FOLLOW
, UIO_SYSSPACE
,
9776 CAST_USER_ADDR_T(relpath
), ctx
);
9788 TRIG_LOG("Trying vnode_resolver_create()\n");
9791 * Set up blob. vnode_create() takes a larger structure
9792 * with creation info, and we needed something different
9793 * for this case. One needs to win, or we need to munge both;
9794 * vnode_create() wins.
9796 bzero(&vtp
, sizeof(vtp
));
9797 vtp
.vnt_resolve_func
= vtip
->vti_resolve_func
;
9798 vtp
.vnt_unresolve_func
= vtip
->vti_unresolve_func
;
9799 vtp
.vnt_rearm_func
= vtip
->vti_rearm_func
;
9800 vtp
.vnt_reclaim_func
= vtip
->vti_reclaim_func
;
9801 vtp
.vnt_reclaim_func
= vtip
->vti_reclaim_func
;
9802 vtp
.vnt_data
= vtip
->vti_data
;
9803 vtp
.vnt_flags
= vtip
->vti_flags
;
9805 res
= vnode_resolver_create(mp
, vp
, &vtp
, TRUE
);
9808 TRIG_LOG("Returning %d\n", res
);
9812 #endif /* CONFIG_TRIGGERS */
9814 vm_offset_t
kdebug_vnode(vnode_t vp
)
9816 return VM_KERNEL_ADDRPERM(vp
);
9819 static int flush_cache_on_write
= 0;
9820 SYSCTL_INT (_kern
, OID_AUTO
, flush_cache_on_write
,
9821 CTLFLAG_RW
| CTLFLAG_LOCKED
, &flush_cache_on_write
, 0,
9822 "always flush the drive cache on writes to uncached files");
9824 int vnode_should_flush_after_write(vnode_t vp
, int ioflag
)
9826 return (flush_cache_on_write
9827 && (ISSET(ioflag
, IO_NOCACHE
) || vnode_isnocache(vp
)));
9831 * sysctl for use by disk I/O tracing tools to get the list of existing
9835 struct vnode_trace_paths_context
{
9837 long path
[MAXPATHLEN
/ sizeof (long) + 1]; /* + 1 in case sizeof (long) does not divide MAXPATHLEN */
9840 static int vnode_trace_path_callback(struct vnode
*vp
, void *arg
) {
9842 struct vnode_trace_paths_context
*ctx
;
9846 len
= sizeof (ctx
->path
);
9847 rv
= vn_getpath(vp
, (char *)ctx
->path
, &len
);
9848 /* vn_getpath() NUL-terminates, and len includes the NUL */
9851 kdebug_lookup_gen_events(ctx
->path
, len
, vp
, TRUE
);
9853 if (++(ctx
->count
) == 1000) {
9854 thread_yield_to_preemption();
9859 return VNODE_RETURNED
;
9862 static int vfs_trace_paths_callback(mount_t mp
, void *arg
) {
9863 if (mp
->mnt_flag
& MNT_LOCAL
)
9864 vnode_iterate(mp
, VNODE_ITERATE_ALL
, vnode_trace_path_callback
, arg
);
9866 return VFS_RETURNED
;
9869 static int sysctl_vfs_trace_paths SYSCTL_HANDLER_ARGS
{
9870 struct vnode_trace_paths_context ctx
;
9877 if (!kauth_cred_issuser(kauth_cred_get()))
9880 if (!kdebug_enable
|| !kdebug_debugid_enabled(VFS_LOOKUP
))
9883 bzero(&ctx
, sizeof (struct vnode_trace_paths_context
));
9885 vfs_iterate(0, vfs_trace_paths_callback
, &ctx
);
9890 SYSCTL_PROC(_vfs_generic
, OID_AUTO
, trace_paths
, CTLFLAG_RD
| CTLFLAG_LOCKED
| CTLFLAG_MASKED
, NULL
, 0, &sysctl_vfs_trace_paths
, "-", "trace_paths");