2 * Copyright (c) 2004 The DragonFly Project. All rights reserved.
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@backplane.com>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * 3. Neither the name of The DragonFly Project nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific, prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 * nlookup() is the 'new' namei interface. Rather then return directory and
36 * leaf vnodes (in various lock states) the new interface instead deals in
37 * namecache records. Namecache records may represent both a positive or
38 * a negative hit. The namespace is locked via the namecache record instead
39 * of via the vnode, and only the leaf namecache record (representing the
40 * filename) needs to be locked.
42 * This greatly improves filesystem parallelism and is a huge simplification
43 * of the API verses the old vnode locking / namei scheme.
45 * Filesystems must actively control the caching aspects of the namecache,
46 * and since namecache pointers are used as handles they are non-optional
47 * even for filesystems which do not generally wish to cache things. It is
48 * intended that a separate cache coherency API will be constructed to handle
52 #include "opt_ktrace.h"
54 #include <sys/param.h>
55 #include <sys/systm.h>
56 #include <sys/kernel.h>
57 #include <sys/vnode.h>
58 #include <sys/mount.h>
59 #include <sys/filedesc.h>
61 #include <sys/namei.h>
62 #include <sys/nlookup.h>
63 #include <sys/malloc.h>
65 #include <sys/objcache.h>
67 #include <sys/kcollect.h>
70 #include <sys/ktrace.h>
73 static int naccess(struct nchandle
*nch
, int vmode
, struct ucred
*cred
,
77 * Initialize a nlookup() structure, early error return for copyin faults
78 * or a degenerate empty string (which is not allowed).
80 * The first process proc0's credentials are used if the calling thread
81 * is not associated with a process context.
86 nlookup_init(struct nlookupdata
*nd
,
87 const char *path
, enum uio_seg seg
, int flags
)
98 * note: the pathlen set by copy*str() includes the terminating \0.
100 bzero(nd
, sizeof(struct nlookupdata
));
101 nd
->nl_path
= objcache_get(namei_oc
, M_WAITOK
);
102 nd
->nl_flags
|= NLC_HASBUF
;
103 if (seg
== UIO_SYSSPACE
)
104 error
= copystr(path
, nd
->nl_path
, MAXPATHLEN
, &pathlen
);
106 error
= copyinstr(path
, nd
->nl_path
, MAXPATHLEN
, &pathlen
);
109 * Don't allow empty pathnames.
110 * POSIX.1 requirement: "" is not a vaild file name.
112 if (error
== 0 && pathlen
<= 1)
117 cache_copy_ncdir(p
, &nd
->nl_nch
);
118 cache_copy(&p
->p_fd
->fd_nrdir
, &nd
->nl_rootnch
);
119 if (p
->p_fd
->fd_njdir
.ncp
)
120 cache_copy(&p
->p_fd
->fd_njdir
, &nd
->nl_jailnch
);
121 nd
->nl_cred
= td
->td_ucred
;
122 nd
->nl_flags
|= NLC_BORROWCRED
| NLC_NCDIR
;
124 cache_copy(&rootnch
, &nd
->nl_nch
);
125 cache_copy(&nd
->nl_nch
, &nd
->nl_rootnch
);
126 cache_copy(&nd
->nl_nch
, &nd
->nl_jailnch
);
127 nd
->nl_cred
= proc0
.p_ucred
;
128 nd
->nl_flags
|= NLC_BORROWCRED
;
131 nd
->nl_flags
|= flags
;
140 * nlookup_init() for "at" family of syscalls.
142 * Works similarly to nlookup_init() but if path is relative and fd is not
143 * AT_FDCWD, path is interpreted relative to the directory pointed to by fd.
144 * In this case, the file entry pointed to by fd is ref'ed and returned in
147 * If the call succeeds, nlookup_done_at() must be called to clean-up the nd
148 * and release the ref to the file entry.
151 nlookup_init_at(struct nlookupdata
*nd
, struct file
**fpp
, int fd
,
152 const char *path
, enum uio_seg seg
, int flags
)
154 struct thread
*td
= curthread
;
161 if ((error
= nlookup_init(nd
, path
, seg
, flags
)) != 0) {
165 if (nd
->nl_path
[0] != '/' && fd
!= AT_FDCWD
) {
166 if ((error
= holdvnode(td
, fd
, &fp
)) != 0)
168 vp
= (struct vnode
*)fp
->f_data
;
169 if (vp
->v_type
!= VDIR
|| fp
->f_nchandle
.ncp
== NULL
) {
175 if (nd
->nl_flags
& NLC_NCDIR
) {
176 cache_drop_ncdir(&nd
->nl_nch
);
177 nd
->nl_flags
&= ~NLC_NCDIR
;
179 cache_drop(&nd
->nl_nch
);
181 cache_copy(&fp
->f_nchandle
, &nd
->nl_nch
);
194 * This works similarly to nlookup_init() but does not assume a process
195 * context. rootnch is always chosen for the root directory and the cred
196 * and starting directory are supplied in arguments.
199 nlookup_init_raw(struct nlookupdata
*nd
,
200 const char *path
, enum uio_seg seg
, int flags
,
201 struct ucred
*cred
, struct nchandle
*ncstart
)
209 bzero(nd
, sizeof(struct nlookupdata
));
210 nd
->nl_path
= objcache_get(namei_oc
, M_WAITOK
);
211 nd
->nl_flags
|= NLC_HASBUF
;
212 if (seg
== UIO_SYSSPACE
)
213 error
= copystr(path
, nd
->nl_path
, MAXPATHLEN
, &pathlen
);
215 error
= copyinstr(path
, nd
->nl_path
, MAXPATHLEN
, &pathlen
);
218 * Don't allow empty pathnames.
219 * POSIX.1 requirement: "" is not a vaild file name.
221 if (error
== 0 && pathlen
<= 1)
225 cache_copy(ncstart
, &nd
->nl_nch
);
226 cache_copy(&rootnch
, &nd
->nl_rootnch
);
227 cache_copy(&rootnch
, &nd
->nl_jailnch
);
228 nd
->nl_cred
= crhold(cred
);
230 nd
->nl_flags
|= flags
;
238 * This works similarly to nlookup_init_raw() but does not rely
239 * on rootnch being initialized yet.
242 nlookup_init_root(struct nlookupdata
*nd
,
243 const char *path
, enum uio_seg seg
, int flags
,
244 struct ucred
*cred
, struct nchandle
*ncstart
,
245 struct nchandle
*ncroot
)
253 bzero(nd
, sizeof(struct nlookupdata
));
254 nd
->nl_path
= objcache_get(namei_oc
, M_WAITOK
);
255 nd
->nl_flags
|= NLC_HASBUF
;
256 if (seg
== UIO_SYSSPACE
)
257 error
= copystr(path
, nd
->nl_path
, MAXPATHLEN
, &pathlen
);
259 error
= copyinstr(path
, nd
->nl_path
, MAXPATHLEN
, &pathlen
);
262 * Don't allow empty pathnames.
263 * POSIX.1 requirement: "" is not a vaild file name.
265 if (error
== 0 && pathlen
<= 1)
269 cache_copy(ncstart
, &nd
->nl_nch
);
270 cache_copy(ncroot
, &nd
->nl_rootnch
);
271 cache_copy(ncroot
, &nd
->nl_jailnch
);
272 nd
->nl_cred
= crhold(cred
);
274 nd
->nl_flags
|= flags
;
283 * Set a different credential; this credential will be used by future
284 * operations performed on nd.nl_open_vp and nlookupdata structure.
287 nlookup_set_cred(struct nlookupdata
*nd
, struct ucred
*cred
)
289 KKASSERT(nd
->nl_cred
!= NULL
);
291 if (nd
->nl_cred
!= cred
) {
293 if ((nd
->nl_flags
& NLC_BORROWCRED
) == 0)
295 nd
->nl_flags
&= ~NLC_BORROWCRED
;
302 * Cleanup a nlookupdata structure after we are through with it. This may
303 * be called on any nlookupdata structure initialized with nlookup_init().
304 * Calling nlookup_done() is mandatory in all cases except where nlookup_init()
305 * returns an error, even if as a consumer you believe you have taken all
306 * dynamic elements out of the nlookupdata structure.
309 nlookup_done(struct nlookupdata
*nd
)
311 if (nd
->nl_nch
.ncp
) {
312 if (nd
->nl_flags
& NLC_NCPISLOCKED
) {
313 nd
->nl_flags
&= ~NLC_NCPISLOCKED
;
314 cache_unlock(&nd
->nl_nch
);
316 if (nd
->nl_flags
& NLC_NCDIR
) {
317 cache_drop_ncdir(&nd
->nl_nch
);
318 nd
->nl_flags
&= ~NLC_NCDIR
;
320 cache_drop(&nd
->nl_nch
); /* NULL's out the nch */
323 if (nd
->nl_rootnch
.ncp
)
324 cache_drop_and_cache(&nd
->nl_rootnch
);
325 if (nd
->nl_jailnch
.ncp
)
326 cache_drop_and_cache(&nd
->nl_jailnch
);
327 if ((nd
->nl_flags
& NLC_HASBUF
) && nd
->nl_path
) {
328 objcache_put(namei_oc
, nd
->nl_path
);
332 if ((nd
->nl_flags
& NLC_BORROWCRED
) == 0)
335 nd
->nl_flags
&= ~NLC_BORROWCRED
;
337 if (nd
->nl_open_vp
) {
338 if (nd
->nl_flags
& NLC_LOCKVP
) {
339 vn_unlock(nd
->nl_open_vp
);
340 nd
->nl_flags
&= ~NLC_LOCKVP
;
342 vn_close(nd
->nl_open_vp
, nd
->nl_vp_fmode
, NULL
);
343 nd
->nl_open_vp
= NULL
;
349 nd
->nl_flags
= 0; /* clear remaining flags (just clear everything) */
353 * Works similarly to nlookup_done() when nd initialized with
357 nlookup_done_at(struct nlookupdata
*nd
, struct file
*fp
)
365 nlookup_zero(struct nlookupdata
*nd
)
367 bzero(nd
, sizeof(struct nlookupdata
));
371 * Simple all-in-one nlookup. Returns a locked namecache structure or NULL
372 * if an error occured.
374 * Note that the returned ncp is not checked for permissions, though VEXEC
375 * is checked on the directory path leading up to the result. The caller
376 * must call naccess() to check the permissions of the returned leaf.
379 nlookup_simple(const char *str
, enum uio_seg seg
,
380 int niflags
, int *error
)
382 struct nlookupdata nd
;
385 *error
= nlookup_init(&nd
, str
, seg
, niflags
);
387 if ((*error
= nlookup(&nd
)) == 0) {
388 nch
= nd
.nl_nch
; /* keep hold ref from structure */
389 cache_zero(&nd
.nl_nch
); /* and NULL out */
401 * Returns non-zero if the path element is the last element
405 islastelement(const char *ptr
)
413 * Returns non-zero if we need to lock the namecache element
414 * exclusively. Unless otherwise requested by NLC_SHAREDLOCK,
415 * the last element of the namecache lookup will be locked
418 * NOTE: Even if we return on-zero, an unresolved namecache record
419 * will always be locked exclusively.
423 wantsexcllock(struct nlookupdata
*nd
, const char *ptr
)
425 if ((nd
->nl_flags
& NLC_SHAREDLOCK
) == 0)
426 return(islastelement(ptr
));
432 * Do a generic nlookup. Note that the passed nd is not nlookup_done()'d
433 * on return, even if an error occurs. If no error occurs or NLC_CREATE
434 * is flagged and ENOENT is returned, then the returned nl_nch is always
435 * referenced and locked exclusively.
437 * WARNING: For any general error other than ENOENT w/NLC_CREATE, the
438 * the resulting nl_nch may or may not be locked and if locked
439 * might be locked either shared or exclusive.
441 * Intermediate directory elements, including the current directory, require
442 * execute (search) permission. nlookup does not examine the access
443 * permissions on the returned element.
445 * If NLC_CREATE is set the last directory must allow node creation,
446 * and an error code of 0 will be returned for a non-existant
447 * target (not ENOENT).
449 * If NLC_RENAME_DST is set the last directory mut allow node deletion,
450 * plus the sticky check is made, and an error code of 0 will be returned
451 * for a non-existant target (not ENOENT).
453 * If NLC_DELETE is set the last directory mut allow node deletion,
454 * plus the sticky check is made.
456 * If NLC_REFDVP is set nd->nl_dvp will be set to the directory vnode
457 * of the returned entry. The vnode will be referenced, but not locked,
458 * and will be released by nlookup_done() along with everything else.
460 * NOTE: As an optimization we attempt to obtain a shared namecache lock
461 * on any intermediate elements. On success, the returned element
462 * is ALWAYS locked exclusively.
465 nlookup(struct nlookupdata
*nd
)
467 globaldata_t gd
= mycpu
;
468 struct nlcomponent nlc
;
471 struct nchandle nctmp
;
473 struct vnode
*hvp
; /* hold to prevent recyclement */
481 int saveflag
= nd
->nl_flags
& ~NLC_NCDIR
;
482 boolean_t doretry
= FALSE
;
483 boolean_t inretry
= FALSE
;
487 if (KTRPOINT(nd
->nl_td
, KTR_NAMEI
))
488 ktrnamei(nd
->nl_td
->td_lwp
, nd
->nl_path
);
490 bzero(&nlc
, sizeof(nlc
));
493 * Setup for the loop. The current working namecache element is
494 * always at least referenced. We lock it as required, but always
495 * return a locked, resolved namecache entry.
505 * Loop on the path components. At the top of the loop nd->nl_nch
506 * is ref'd and unlocked and represents our current position.
510 * Make sure nl_nch is locked so we can access the vnode, resolution
513 if ((nd
->nl_flags
& NLC_NCPISLOCKED
) == 0) {
514 nd
->nl_flags
|= NLC_NCPISLOCKED
;
515 cache_lock_maybe_shared(&nd
->nl_nch
, wantsexcllock(nd
, ptr
));
519 * Check if the root directory should replace the current
520 * directory. This is done at the start of a translation
521 * or after a symbolic link has been found. In other cases
522 * ptr will never be pointing at a '/'.
527 } while (*ptr
== '/');
528 cache_unlock(&nd
->nl_nch
);
529 cache_get_maybe_shared(&nd
->nl_rootnch
, &nch
,
530 wantsexcllock(nd
, ptr
));
531 if (nd
->nl_flags
& NLC_NCDIR
) {
532 cache_drop_ncdir(&nd
->nl_nch
);
533 nd
->nl_flags
&= ~NLC_NCDIR
;
535 cache_drop(&nd
->nl_nch
);
537 nd
->nl_nch
= nch
; /* remains locked */
540 * Fast-track termination. There is no parent directory of
541 * the root in the same mount from the point of view of
542 * the caller so return EACCES if NLC_REFDVP is specified,
543 * and EEXIST if NLC_CREATE is also specified.
544 * e.g. 'rmdir /' or 'mkdir /' are not allowed.
547 if (nd
->nl_flags
& NLC_REFDVP
)
548 error
= (nd
->nl_flags
& NLC_CREATE
) ? EEXIST
: EACCES
;
557 * Pre-calculate next path component so we can check whether the
558 * current component directory is the last directory in the path
561 for (nptr
= ptr
; *nptr
&& *nptr
!= '/'; ++nptr
)
565 * Check directory search permissions (nd->nl_nch is locked & refd).
566 * This will load dflags to obtain directory-special permissions to
567 * be checked along with the last component.
569 * We only need to pass-in &dflags for the second-to-last component.
570 * Optimize by passing-in NULL for any prior components, which may
571 * allow the code to bypass the naccess() call.
575 error
= naccess(&nd
->nl_nch
, NLC_EXEC
, nd
->nl_cred
, NULL
);
577 error
= naccess(&nd
->nl_nch
, NLC_EXEC
, nd
->nl_cred
, &dflags
);
582 * Extract the next (or last) path component. Path components are
583 * limited to 255 characters.
585 nlc
.nlc_nameptr
= ptr
;
586 nlc
.nlc_namelen
= nptr
- ptr
;
588 if (nlc
.nlc_namelen
>= 256) {
589 error
= ENAMETOOLONG
;
594 * Lookup the path component in the cache, creating an unresolved
595 * entry if necessary. We have to handle "." and ".." as special
598 * When handling ".." we have to detect a traversal back through a
599 * mount point. If we are at the root, ".." just returns the root.
601 * When handling "." or ".." we also have to recalculate dflags
602 * since our dflags will be for some sub-directory instead of the
605 * This subsection returns a locked, refd 'nch' unless it errors out,
606 * and an unlocked but still ref'd nd->nl_nch.
608 * The namecache topology is not allowed to be disconnected, so
609 * encountering a NULL parent will generate EINVAL. This typically
610 * occurs when a directory is removed out from under a process.
612 * WARNING! The unlocking of nd->nl_nch is sensitive code.
614 KKASSERT(nd
->nl_flags
& NLC_NCPISLOCKED
);
616 if (nlc
.nlc_namelen
== 1 && nlc
.nlc_nameptr
[0] == '.') {
617 cache_unlock(&nd
->nl_nch
);
618 nd
->nl_flags
&= ~NLC_NCPISLOCKED
;
619 cache_get_maybe_shared(&nd
->nl_nch
, &nch
, wantsexcllock(nd
, ptr
));
621 } else if (nlc
.nlc_namelen
== 2 &&
622 nlc
.nlc_nameptr
[0] == '.' && nlc
.nlc_nameptr
[1] == '.') {
623 if (nd
->nl_nch
.mount
== nd
->nl_rootnch
.mount
&&
624 nd
->nl_nch
.ncp
== nd
->nl_rootnch
.ncp
627 * ".." at the root returns the root
629 cache_unlock(&nd
->nl_nch
);
630 nd
->nl_flags
&= ~NLC_NCPISLOCKED
;
631 cache_get_maybe_shared(&nd
->nl_nch
, &nch
,
632 wantsexcllock(nd
, ptr
));
635 * Locate the parent ncp. If we are at the root of a
636 * filesystem mount we have to skip to the mounted-on
637 * point in the underlying filesystem.
639 * Expect the parent to always be good since the
640 * mountpoint doesn't go away. XXX hack. cache_get()
641 * requires the ncp to already have a ref as a safety.
643 * However, a process which has been broken out of a chroot
644 * will wind up with a NULL parent if it tries to '..' above
645 * the real root, deal with the case. Note that this does
646 * not protect us from a jail breakout, it just stops a panic
647 * if the jail-broken process tries to '..' past the real
651 while (nctmp
.ncp
== nctmp
.mount
->mnt_ncmountpt
.ncp
) {
652 nctmp
= nctmp
.mount
->mnt_ncmounton
;
653 if (nctmp
.ncp
== NULL
)
656 if (nctmp
.ncp
== NULL
) {
657 if (curthread
->td_proc
) {
658 kprintf("vfs_nlookup: '..' traverse broke "
659 "jail: pid %d (%s)\n",
660 curthread
->td_proc
->p_pid
,
663 nctmp
= nd
->nl_rootnch
;
665 nctmp
.ncp
= nctmp
.ncp
->nc_parent
;
668 cache_unlock(&nd
->nl_nch
);
669 nd
->nl_flags
&= ~NLC_NCPISLOCKED
;
670 cache_get_maybe_shared(&nctmp
, &nch
, wantsexcllock(nd
, ptr
));
671 cache_drop(&nctmp
); /* NOTE: zero's nctmp */
676 * Must unlock nl_nch when traversing down the path. However,
677 * the child ncp has not yet been found/created and the parent's
678 * child list might be empty. Thus releasing the lock can
679 * allow a race whereby the parent ncp's vnode is recycled.
680 * This case can occur especially when maxvnodes is set very low.
682 * We need the parent's ncp to remain resolved for all normal
683 * filesystem activities, so we vhold() the vp during the lookup
684 * to prevent recyclement due to vnlru / maxvnodes.
686 * If we race an unlink or rename the ncp might be marked
687 * DESTROYED after resolution, requiring a retry.
689 if ((hvp
= nd
->nl_nch
.ncp
->nc_vp
) != NULL
)
691 cache_unlock(&nd
->nl_nch
);
692 nd
->nl_flags
&= ~NLC_NCPISLOCKED
;
693 error
= cache_nlookup_maybe_shared(&nd
->nl_nch
, &nlc
,
694 wantsexcllock(nd
, ptr
), &nch
);
695 if (error
== EWOULDBLOCK
) {
696 nch
= cache_nlookup(&nd
->nl_nch
, &nlc
);
697 if (nch
.ncp
->nc_flag
& NCF_UNRESOLVED
)
700 error
= cache_resolve(&nch
, nd
->nl_cred
);
701 if (error
!= EAGAIN
&&
702 (nch
.ncp
->nc_flag
& NCF_DESTROYED
) == 0) {
703 if (error
== ESTALE
) {
710 kprintf("[diagnostic] nlookup: relookup %*.*s\n",
711 nch
.ncp
->nc_nlen
, nch
.ncp
->nc_nlen
,
714 nch
= cache_nlookup(&nd
->nl_nch
, &nlc
);
723 * If the last component was "." or ".." our dflags no longer
724 * represents the parent directory and we have to explicitly
727 * Expect the parent to be good since nch is locked.
729 if (wasdotordotdot
&& error
== 0) {
731 if ((par
.ncp
= nch
.ncp
->nc_parent
) != NULL
) {
732 par
.mount
= nch
.mount
;
734 cache_lock_maybe_shared(&par
, wantsexcllock(nd
, ptr
));
735 error
= naccess(&par
, 0, nd
->nl_cred
, &dflags
);
741 * [end of subsection]
743 * nch is locked and referenced.
744 * nd->nl_nch is unlocked and referenced.
746 * nl_nch must be unlocked or we could chain lock to the root
747 * if a resolve gets stuck (e.g. in NFS).
749 KKASSERT((nd
->nl_flags
& NLC_NCPISLOCKED
) == 0);
752 * Resolve the namespace if necessary. The ncp returned by
753 * cache_nlookup() is referenced and locked.
755 * XXX neither '.' nor '..' should return EAGAIN since they were
756 * previously resolved and thus cannot be newly created ncp's.
758 if (nch
.ncp
->nc_flag
& NCF_UNRESOLVED
) {
760 error
= cache_resolve(&nch
, nd
->nl_cred
);
761 if (error
== ESTALE
) {
766 KKASSERT(error
!= EAGAIN
);
768 error
= nch
.ncp
->nc_error
;
772 * Early completion. ENOENT is not an error if this is the last
773 * component and NLC_CREATE or NLC_RENAME (rename target) was
774 * requested. Note that ncp->nc_error is left as ENOENT in that
775 * case, which we check later on.
777 * Also handle invalid '.' or '..' components terminating a path
778 * for a create/rename/delete. The standard requires this and pax
779 * pretty stupidly depends on it.
781 if (islastelement(ptr
)) {
782 if (error
== ENOENT
&&
783 (nd
->nl_flags
& (NLC_CREATE
| NLC_RENAME_DST
))
785 if (nd
->nl_flags
& NLC_NFS_RDONLY
) {
788 error
= naccess(&nch
, nd
->nl_flags
| dflags
,
792 if (error
== 0 && wasdotordotdot
&&
793 (nd
->nl_flags
& (NLC_CREATE
| NLC_DELETE
|
794 NLC_RENAME_SRC
| NLC_RENAME_DST
))) {
798 if (nd
->nl_flags
& NLC_CREATE
)
800 else if (nd
->nl_flags
& NLC_DELETE
)
801 error
= (wasdotordotdot
== 1) ? EINVAL
: ENOTEMPTY
;
808 * Early completion on error.
816 * If the element is a symlink and it is either not the last
817 * element or it is the last element and we are allowed to
818 * follow symlinks, resolve the symlink.
820 if ((nch
.ncp
->nc_flag
& NCF_ISSYMLINK
) &&
821 (*ptr
|| (nd
->nl_flags
& NLC_FOLLOW
))
823 if (nd
->nl_loopcnt
++ >= MAXSYMLINKS
) {
828 error
= nreadsymlink(nd
, &nch
, &nlc
);
834 * Concatenate trailing path elements onto the returned symlink.
835 * Note that if the path component (ptr) is not exhausted, it
836 * will being with a '/', so we do not have to add another one.
838 * The symlink may not be empty.
841 if (nlc
.nlc_namelen
== 0 || nlc
.nlc_namelen
+ len
>= MAXPATHLEN
) {
842 error
= nlc
.nlc_namelen
? ENAMETOOLONG
: ENOENT
;
843 objcache_put(namei_oc
, nlc
.nlc_nameptr
);
846 bcopy(ptr
, nlc
.nlc_nameptr
+ nlc
.nlc_namelen
, len
+ 1);
847 if (nd
->nl_flags
& NLC_HASBUF
)
848 objcache_put(namei_oc
, nd
->nl_path
);
849 nd
->nl_path
= nlc
.nlc_nameptr
;
850 nd
->nl_flags
|= NLC_HASBUF
;
854 * Go back up to the top to resolve any initial '/'s in the
861 * If the element is a directory and we are crossing a mount point,
864 while ((nch
.ncp
->nc_flag
& NCF_ISMOUNTPT
) &&
865 (nd
->nl_flags
& NLC_NOCROSSMOUNT
) == 0 &&
866 (mp
= cache_findmount(&nch
)) != NULL
872 * VFS must be busied before the namecache entry is locked,
873 * but we don't want to waste time calling vfs_busy() if the
874 * mount point is already resolved.
879 while (vfs_busy(mp
, 0)) {
880 if (mp
->mnt_kern_flag
& MNTK_UNMOUNT
) {
881 kprintf("nlookup: warning umount race avoided\n");
889 cache_get_maybe_shared(&mp
->mnt_ncmountpt
, &nch
,
890 wantsexcllock(nd
, ptr
));
892 if (nch
.ncp
->nc_flag
& NCF_UNRESOLVED
) {
893 if (vfs_do_busy
== 0) {
897 error
= VFS_ROOT(mp
, &tdp
);
904 cache_setvp(&nch
, tdp
);
919 * Skip any slashes to get to the next element. If there
920 * are any slashes at all the current element must be a
921 * directory or, in the create case, intended to become a directory.
922 * If it isn't we break without incrementing ptr and fall through
923 * to the failure case below.
925 while (*ptr
== '/') {
926 if ((nch
.ncp
->nc_flag
& NCF_ISDIR
) == 0 &&
927 !(nd
->nl_flags
& NLC_WILLBEDIR
)
935 * Continuation case: additional elements and the current
936 * element is a directory.
938 if (*ptr
&& (nch
.ncp
->nc_flag
& NCF_ISDIR
)) {
939 if (nd
->nl_flags
& NLC_NCDIR
) {
940 cache_drop_ncdir(&nd
->nl_nch
);
941 nd
->nl_flags
&= ~NLC_NCDIR
;
943 cache_drop(&nd
->nl_nch
);
946 KKASSERT((nd
->nl_flags
& NLC_NCPISLOCKED
) == 0);
952 * Failure case: additional elements and the current element
962 * Successful lookup of last element.
964 * Check permissions if the target exists. If the target does not
965 * exist directory permissions were already tested in the early
966 * completion code above.
968 * nd->nl_flags will be adjusted on return with NLC_APPENDONLY
969 * if the file is marked append-only, and NLC_STICKY if the directory
970 * containing the file is sticky.
972 if (nch
.ncp
->nc_vp
&& (nd
->nl_flags
& NLC_ALLCHKS
)) {
973 error
= naccess(&nch
, nd
->nl_flags
| dflags
,
982 * Termination: no more elements.
984 * If NLC_REFDVP is set acquire a referenced parent dvp.
986 if (nd
->nl_flags
& NLC_REFDVP
) {
987 cache_lock(&nd
->nl_nch
);
988 error
= cache_vref(&nd
->nl_nch
, nd
->nl_cred
, &nd
->nl_dvp
);
989 cache_unlock(&nd
->nl_nch
);
991 kprintf("NLC_REFDVP: Cannot ref dvp of %p\n", nch
.ncp
);
996 if (nd
->nl_flags
& NLC_NCDIR
) {
997 cache_drop_ncdir(&nd
->nl_nch
);
998 nd
->nl_flags
&= ~NLC_NCDIR
;
1000 cache_drop(&nd
->nl_nch
);
1003 nd
->nl_flags
|= NLC_NCPISLOCKED
;
1009 ++gd
->gd_nchstats
->ncs_longhits
;
1011 ++gd
->gd_nchstats
->ncs_longmiss
;
1013 if (nd
->nl_flags
& NLC_NCPISLOCKED
)
1014 KKASSERT(cache_lockstatus(&nd
->nl_nch
) > 0);
1017 * Retry the whole thing if doretry flag is set, but only once.
1018 * autofs(5) may mount another filesystem under its root directory
1019 * while resolving a path.
1021 if (doretry
&& !inretry
) {
1023 nd
->nl_flags
&= NLC_NCDIR
;
1024 nd
->nl_flags
|= saveflag
;
1029 * NOTE: If NLC_CREATE was set the ncp may represent a negative hit
1030 * (ncp->nc_error will be ENOENT), but we will still return an error
1037 * Resolve a mount point's glue ncp. This ncp connects creates the illusion
1038 * of continuity in the namecache tree by connecting the ncp related to the
1039 * vnode under the mount to the ncp related to the mount's root vnode.
1041 * If no error occured a locked, ref'd ncp is stored in *ncpp.
1044 nlookup_mp(struct mount
*mp
, struct nchandle
*nch
)
1050 cache_get(&mp
->mnt_ncmountpt
, nch
);
1051 if (nch
->ncp
->nc_flag
& NCF_UNRESOLVED
) {
1052 while (vfs_busy(mp
, 0))
1054 error
= VFS_ROOT(mp
, &vp
);
1059 cache_setvp(nch
, vp
);
1067 * Read the contents of a symlink, allocate a path buffer out of the
1068 * namei_oc and initialize the supplied nlcomponent with the result.
1070 * If an error occurs no buffer will be allocated or returned in the nlc.
1073 nreadsymlink(struct nlookupdata
*nd
, struct nchandle
*nch
,
1074 struct nlcomponent
*nlc
)
1083 nlc
->nlc_nameptr
= NULL
;
1084 nlc
->nlc_namelen
= 0;
1085 if (nch
->ncp
->nc_vp
== NULL
)
1087 if ((error
= cache_vget(nch
, nd
->nl_cred
, LK_SHARED
, &vp
)) != 0)
1089 cp
= objcache_get(namei_oc
, M_WAITOK
);
1091 aiov
.iov_len
= MAXPATHLEN
;
1092 auio
.uio_iov
= &aiov
;
1093 auio
.uio_iovcnt
= 1;
1094 auio
.uio_offset
= 0;
1095 auio
.uio_rw
= UIO_READ
;
1096 auio
.uio_segflg
= UIO_SYSSPACE
;
1097 auio
.uio_td
= nd
->nl_td
;
1098 auio
.uio_resid
= MAXPATHLEN
- 1;
1099 error
= VOP_READLINK(vp
, &auio
, nd
->nl_cred
);
1102 linklen
= MAXPATHLEN
- 1 - auio
.uio_resid
;
1103 if (varsym_enable
) {
1104 linklen
= varsymreplace(cp
, linklen
, MAXPATHLEN
- 1);
1106 error
= ENAMETOOLONG
;
1111 nlc
->nlc_nameptr
= cp
;
1112 nlc
->nlc_namelen
= linklen
;
1116 objcache_put(namei_oc
, cp
);
1122 * Check access [XXX cache vattr!] [XXX quota]
1124 * Generally check the NLC_* access bits. All specified bits must pass
1125 * for this function to return 0.
1127 * The file does not have to exist when checking NLC_CREATE or NLC_RENAME_DST
1128 * access, otherwise it must exist. No error is returned in this case.
1130 * The file must not exist if NLC_EXCL is specified.
1132 * Directory permissions in general are tested for NLC_CREATE if the file
1133 * does not exist, NLC_DELETE if the file does exist, and NLC_RENAME_DST
1134 * whether the file exists or not.
1136 * The directory sticky bit is tested for NLC_DELETE and NLC_RENAME_DST,
1137 * the latter is only tested if the target exists.
1139 * The passed ncp must be referenced and locked. If it is already resolved
1140 * it may be locked shared but otherwise should be locked exclusively.
1143 #define S_WXOK_MASK (S_IRUSR|S_IXUSR|S_IRGRP|S_IXGRP|S_IROTH|S_IXOTH)
1146 naccess(struct nchandle
*nch
, int nflags
, struct ucred
*cred
, int *nflagsp
)
1150 struct namecache
*ncp
;
1154 KKASSERT(cache_lockstatus(nch
) > 0);
1157 if (ncp
->nc_flag
& NCF_UNRESOLVED
) {
1158 cache_resolve(nch
, cred
);
1161 error
= ncp
->nc_error
;
1164 * Directory permissions checks. Silently ignore ENOENT if these
1165 * tests pass. It isn't an error.
1167 * We can safely resolve ncp->nc_parent because ncp is currently
1170 if (nflags
& (NLC_CREATE
| NLC_DELETE
| NLC_RENAME_SRC
| NLC_RENAME_DST
)) {
1171 if (((nflags
& NLC_CREATE
) && ncp
->nc_vp
== NULL
) ||
1172 ((nflags
& NLC_DELETE
) && ncp
->nc_vp
!= NULL
) ||
1173 ((nflags
& NLC_RENAME_SRC
) && ncp
->nc_vp
!= NULL
) ||
1174 (nflags
& NLC_RENAME_DST
)
1176 struct nchandle par
;
1178 if ((par
.ncp
= ncp
->nc_parent
) == NULL
) {
1179 if (error
!= EAGAIN
)
1181 } else if (error
== 0 || error
== ENOENT
) {
1182 par
.mount
= nch
->mount
;
1184 cache_lock_maybe_shared(&par
, 0);
1185 error
= naccess(&par
, NLC_WRITE
, cred
, NULL
);
1192 * NLC_EXCL check. Target file must not exist.
1194 if (error
== 0 && (nflags
& NLC_EXCL
) && ncp
->nc_vp
!= NULL
)
1198 * Try to short-cut the vnode operation for intermediate directory
1199 * components. This is a major SMP win because it avoids having
1200 * to execute a lot of code for intermediate directory components,
1201 * including shared refs and locks on intermediate directory vnodes.
1203 * We can only do this if the caller does not need nflagsp.
1205 if (error
== 0 && nflagsp
== NULL
&&
1206 nflags
== NLC_EXEC
&& (ncp
->nc_flag
& NCF_WXOK
)) {
1211 * Get the vnode attributes so we can do the rest of our checks.
1213 * NOTE: We only call naccess_va() if the target exists.
1216 error
= cache_vget(nch
, cred
, LK_SHARED
, &vp
);
1217 if (error
== ENOENT
) {
1219 * Silently zero-out ENOENT if creating or renaming
1220 * (rename target). It isn't an error.
1222 if (nflags
& (NLC_CREATE
| NLC_RENAME_DST
))
1224 } else if (error
== 0) {
1226 * Get the vnode attributes and check for illegal O_TRUNC
1227 * requests and read-only mounts.
1229 * NOTE: You can still open devices on read-only mounts for
1232 * NOTE: creates/deletes/renames are handled by the NLC_WRITE
1233 * check on the parent directory above.
1235 * XXX cache the va in the namecache or in the vnode
1237 error
= VOP_GETATTR(vp
, &va
);
1238 if (error
== 0 && (nflags
& NLC_TRUNCATE
)) {
1239 switch(va
.va_type
) {
1254 if (error
== 0 && (nflags
& NLC_WRITE
) && vp
->v_mount
&&
1255 (vp
->v_mount
->mnt_flag
& MNT_RDONLY
)
1257 switch(va
.va_type
) {
1271 * Check permissions based on file attributes. The passed
1272 * flags (*nflagsp) are modified with feedback based on
1273 * special attributes and requirements.
1277 * Adjust the returned (*nflagsp) if non-NULL.
1280 if ((va
.va_mode
& VSVTX
) && va
.va_uid
!= cred
->cr_uid
)
1281 *nflagsp
|= NLC_STICKY
;
1282 if (va
.va_flags
& APPEND
)
1283 *nflagsp
|= NLC_APPENDONLY
;
1284 if (va
.va_flags
& IMMUTABLE
)
1285 *nflagsp
|= NLC_IMMUTABLE
;
1289 * NCF_WXOK can be set for world-searchable directories.
1291 * XXX When we implement capabilities this code would also
1292 * need a cap check, or only set the flag if there are no
1296 if (va
.va_type
== VDIR
&&
1297 (va
.va_mode
& S_WXOK_MASK
) == S_WXOK_MASK
) {
1302 * Track swapcache management flags in the namecache.
1304 * Calculate the flags based on the current vattr info
1305 * and recalculate the inherited flags from the parent
1306 * (the original cache linkage may have occurred without
1307 * getattrs and thus have stale flags).
1309 if (va
.va_flags
& SF_NOCACHE
)
1310 cflags
|= NCF_SF_NOCACHE
;
1311 if (va
.va_flags
& UF_CACHE
)
1312 cflags
|= NCF_UF_CACHE
;
1313 if (ncp
->nc_parent
) {
1314 if (ncp
->nc_parent
->nc_flag
&
1315 (NCF_SF_NOCACHE
| NCF_SF_PNOCACHE
)) {
1316 cflags
|= NCF_SF_PNOCACHE
;
1318 if (ncp
->nc_parent
->nc_flag
&
1319 (NCF_UF_CACHE
| NCF_UF_PCACHE
)) {
1320 cflags
|= NCF_UF_PCACHE
;
1325 * We're not supposed to update nc_flag when holding a shared
1326 * lock, but we allow the case for certain flags. Note that
1327 * holding an exclusive lock allows updating nc_flag without
1328 * atomics. nc_flag is not allowe to be updated at all unless
1329 * a shared or exclusive lock is held.
1331 atomic_clear_short(&ncp
->nc_flag
,
1332 (NCF_SF_NOCACHE
| NCF_UF_CACHE
|
1333 NCF_SF_PNOCACHE
| NCF_UF_PCACHE
|
1334 NCF_WXOK
) & ~cflags
);
1335 atomic_set_short(&ncp
->nc_flag
, cflags
);
1338 * Process general access.
1340 error
= naccess_va(&va
, nflags
, cred
);
1348 * Check the requested access against the given vattr using cred.
1351 naccess_va(struct vattr
*va
, int nflags
, struct ucred
*cred
)
1357 * Test the immutable bit. Creations, deletions, renames (source
1358 * or destination) are not allowed. chown/chmod/other is also not
1359 * allowed but is handled by SETATTR. Hardlinks to the immutable
1362 * If the directory is set to immutable then creations, deletions,
1363 * renames (source or dest) and hardlinks to files within the directory
1364 * are not allowed, and regular files opened through the directory may
1365 * not be written to or truncated (unless a special device).
1367 * NOTE! New hardlinks to immutable files work but new hardlinks to
1368 * files, immutable or not, sitting inside an immutable directory are
1369 * not allowed. As always if the file is hardlinked via some other
1370 * path additional hardlinks may be possible even if the file is marked
1371 * immutable. The sysop needs to create a closure by checking the hard
1372 * link count. Once closure is achieved you are good, and security
1373 * scripts should check link counts anyway.
1375 * Writes and truncations are only allowed on special devices.
1377 if ((va
->va_flags
& IMMUTABLE
) || (nflags
& NLC_IMMUTABLE
)) {
1378 if ((nflags
& NLC_IMMUTABLE
) && (nflags
& NLC_HLINK
))
1380 if (nflags
& (NLC_CREATE
| NLC_DELETE
|
1381 NLC_RENAME_SRC
| NLC_RENAME_DST
)) {
1384 if (nflags
& (NLC_WRITE
| NLC_TRUNCATE
)) {
1385 switch(va
->va_type
) {
1399 * Test the no-unlink and append-only bits for opens, rename targets,
1400 * and deletions. These bits are not tested for creations or
1403 * Unlike FreeBSD we allow a file with APPEND set to be renamed.
1404 * If you do not wish this you must also set NOUNLINK.
1406 * If the governing directory is marked APPEND-only it implies
1407 * NOUNLINK for all entries in the directory.
1409 if (((va
->va_flags
& NOUNLINK
) || (nflags
& NLC_APPENDONLY
)) &&
1410 (nflags
& (NLC_DELETE
| NLC_RENAME_SRC
| NLC_RENAME_DST
))
1416 * A file marked append-only may not be deleted but can be renamed.
1418 if ((va
->va_flags
& APPEND
) &&
1419 (nflags
& (NLC_DELETE
| NLC_RENAME_DST
))
1425 * A file marked append-only which is opened for writing must also
1426 * be opened O_APPEND.
1428 if ((va
->va_flags
& APPEND
) && (nflags
& (NLC_OPEN
| NLC_TRUNCATE
))) {
1429 if (nflags
& NLC_TRUNCATE
)
1431 if ((nflags
& (NLC_OPEN
| NLC_WRITE
)) == (NLC_OPEN
| NLC_WRITE
)) {
1432 if ((nflags
& NLC_APPEND
) == 0)
1438 * root gets universal access
1440 if (cred
->cr_uid
== 0)
1444 * Check owner perms.
1446 * If NLC_OWN is set the owner of the file is allowed no matter when
1447 * the owner-mode bits say (utimes).
1450 if (nflags
& NLC_READ
)
1452 if (nflags
& NLC_WRITE
)
1454 if (nflags
& NLC_EXEC
)
1457 if (cred
->cr_uid
== va
->va_uid
) {
1458 if ((nflags
& NLC_OWN
) == 0) {
1459 if ((vmode
& va
->va_mode
) != vmode
)
1466 * If NLC_STICKY is set only the owner may delete or rename a file.
1467 * This bit is typically set on /tmp.
1469 * Note that the NLC_READ/WRITE/EXEC bits are not typically set in
1470 * the specific delete or rename case. For deletions and renames we
1471 * usually just care about directory permissions, not file permissions.
1473 if ((nflags
& NLC_STICKY
) &&
1474 (nflags
& (NLC_RENAME_SRC
| NLC_RENAME_DST
| NLC_DELETE
))) {
1482 for (i
= 0; i
< cred
->cr_ngroups
; ++i
) {
1483 if (va
->va_gid
== cred
->cr_groups
[i
]) {
1484 if ((vmode
& va
->va_mode
) != vmode
)
1494 if ((vmode
& va
->va_mode
) != vmode
)
1500 * Long-term (10-second interval) statistics collection
1504 collect_nlookup_callback(int n
)
1506 static uint64_t last_total
;
1511 for (n
= 0; n
< ncpus
; ++n
) {
1512 globaldata_t gd
= globaldata_find(n
);
1513 struct nchstats
*sp
;
1515 if ((sp
= gd
->gd_nchstats
) != NULL
)
1516 total
+= sp
->ncs_longhits
+ sp
->ncs_longmiss
;
1519 total
= total
- last_total
;
1527 nlookup_collect_init(void *dummy __unused
)
1529 kcollect_register(KCOLLECT_NLOOKUP
, "nlookup", collect_nlookup_callback
,
1530 KCOLLECT_SCALE(KCOLLECT_NLOOKUP_FORMAT
, 0));
1532 SYSINIT(collect_nlookup
, SI_SUB_PROP
, SI_ORDER_ANY
, nlookup_collect_init
, 0);