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>
69 #include <sys/ktrace.h>
72 static int naccess(struct nchandle *nch, int vmode, struct ucred *cred,
76 * Initialize a nlookup() structure, early error return for copyin faults
77 * or a degenerate empty string (which is not allowed).
79 * The first process proc0's credentials are used if the calling thread
80 * is not associated with a process context.
85 nlookup_init(struct nlookupdata *nd,
86 const char *path, enum uio_seg seg, int flags)
97 * note: the pathlen set by copy*str() includes the terminating \0.
99 bzero(nd, sizeof(struct nlookupdata));
100 nd->nl_path = objcache_get(namei_oc, M_WAITOK);
101 nd->nl_flags |= NLC_HASBUF;
102 if (seg == UIO_SYSSPACE)
103 error = copystr(path, nd->nl_path, MAXPATHLEN, &pathlen);
105 error = copyinstr(path, nd->nl_path, MAXPATHLEN, &pathlen);
108 * Don't allow empty pathnames.
109 * POSIX.1 requirement: "" is not a vaild file name.
111 if (error == 0 && pathlen <= 1)
116 cache_copy(&p->p_fd->fd_ncdir, &nd->nl_nch);
117 cache_copy(&p->p_fd->fd_nrdir, &nd->nl_rootnch);
118 if (p->p_fd->fd_njdir.ncp)
119 cache_copy(&p->p_fd->fd_njdir, &nd->nl_jailnch);
120 nd->nl_cred = crhold(p->p_ucred);
122 cache_copy(&rootnch, &nd->nl_nch);
123 cache_copy(&nd->nl_nch, &nd->nl_rootnch);
124 cache_copy(&nd->nl_nch, &nd->nl_jailnch);
125 nd->nl_cred = crhold(proc0.p_ucred);
128 nd->nl_flags |= flags;
137 * nlookup_init() for "at" family of syscalls.
139 * Works similarly to nlookup_init() but if path is relative and fd is not
140 * AT_FDCWD, path is interpreted relative to the directory pointed to by fd.
141 * In this case, the file entry pointed to by fd is ref'ed and returned in
144 * If the call succeeds, nlookup_done_at() must be called to clean-up the nd
145 * and release the ref to the file entry.
148 nlookup_init_at(struct nlookupdata *nd, struct file **fpp, int fd,
149 const char *path, enum uio_seg seg, int flags)
151 struct thread *td = curthread;
152 struct proc *p = td->td_proc;
159 if ((error = nlookup_init(nd, path, seg, flags)) != 0) {
163 if (nd->nl_path[0] != '/' && fd != AT_FDCWD) {
164 if ((error = holdvnode(p->p_fd, fd, &fp)) != 0)
166 vp = (struct vnode*)fp->f_data;
167 if (vp->v_type != VDIR || fp->f_nchandle.ncp == NULL) {
173 cache_drop(&nd->nl_nch);
174 cache_copy(&fp->f_nchandle, &nd->nl_nch);
187 * This works similarly to nlookup_init() but does not assume a process
188 * context. rootnch is always chosen for the root directory and the cred
189 * and starting directory are supplied in arguments.
192 nlookup_init_raw(struct nlookupdata *nd,
193 const char *path, enum uio_seg seg, int flags,
194 struct ucred *cred, struct nchandle *ncstart)
202 bzero(nd, sizeof(struct nlookupdata));
203 nd->nl_path = objcache_get(namei_oc, M_WAITOK);
204 nd->nl_flags |= NLC_HASBUF;
205 if (seg == UIO_SYSSPACE)
206 error = copystr(path, nd->nl_path, MAXPATHLEN, &pathlen);
208 error = copyinstr(path, nd->nl_path, MAXPATHLEN, &pathlen);
211 * Don't allow empty pathnames.
212 * POSIX.1 requirement: "" is not a vaild file name.
214 if (error == 0 && pathlen <= 1)
218 cache_copy(ncstart, &nd->nl_nch);
219 cache_copy(&rootnch, &nd->nl_rootnch);
220 cache_copy(&rootnch, &nd->nl_jailnch);
221 nd->nl_cred = crhold(cred);
223 nd->nl_flags |= flags;
231 * This works similarly to nlookup_init_raw() but does not rely
232 * on rootnch being initialized yet.
235 nlookup_init_root(struct nlookupdata *nd,
236 const char *path, enum uio_seg seg, int flags,
237 struct ucred *cred, struct nchandle *ncstart,
238 struct nchandle *ncroot)
246 bzero(nd, sizeof(struct nlookupdata));
247 nd->nl_path = objcache_get(namei_oc, M_WAITOK);
248 nd->nl_flags |= NLC_HASBUF;
249 if (seg == UIO_SYSSPACE)
250 error = copystr(path, nd->nl_path, MAXPATHLEN, &pathlen);
252 error = copyinstr(path, nd->nl_path, MAXPATHLEN, &pathlen);
255 * Don't allow empty pathnames.
256 * POSIX.1 requirement: "" is not a vaild file name.
258 if (error == 0 && pathlen <= 1)
262 cache_copy(ncstart, &nd->nl_nch);
263 cache_copy(ncroot, &nd->nl_rootnch);
264 cache_copy(ncroot, &nd->nl_jailnch);
265 nd->nl_cred = crhold(cred);
267 nd->nl_flags |= flags;
275 * Set a different credential; this credential will be used by future
276 * operations performed on nd.nl_open_vp and nlookupdata structure.
279 nlookup_set_cred(struct nlookupdata *nd, struct ucred *cred)
281 KKASSERT(nd->nl_cred != NULL);
283 if (nd->nl_cred != cred) {
291 * Cleanup a nlookupdata structure after we are through with it. This may
292 * be called on any nlookupdata structure initialized with nlookup_init().
293 * Calling nlookup_done() is mandatory in all cases except where nlookup_init()
294 * returns an error, even if as a consumer you believe you have taken all
295 * dynamic elements out of the nlookupdata structure.
298 nlookup_done(struct nlookupdata *nd)
300 if (nd->nl_nch.ncp) {
301 if (nd->nl_flags & NLC_NCPISLOCKED) {
302 nd->nl_flags &= ~NLC_NCPISLOCKED;
303 cache_unlock(&nd->nl_nch);
305 cache_drop(&nd->nl_nch); /* NULL's out the nch */
307 if (nd->nl_rootnch.ncp)
308 cache_drop(&nd->nl_rootnch);
309 if (nd->nl_jailnch.ncp)
310 cache_drop(&nd->nl_jailnch);
311 if ((nd->nl_flags & NLC_HASBUF) && nd->nl_path) {
312 objcache_put(namei_oc, nd->nl_path);
319 if (nd->nl_open_vp) {
320 if (nd->nl_flags & NLC_LOCKVP) {
321 vn_unlock(nd->nl_open_vp);
322 nd->nl_flags &= ~NLC_LOCKVP;
324 vn_close(nd->nl_open_vp, nd->nl_vp_fmode);
325 nd->nl_open_vp = NULL;
331 nd->nl_flags = 0; /* clear remaining flags (just clear everything) */
335 * Works similarly to nlookup_done() when nd initialized with
339 nlookup_done_at(struct nlookupdata *nd, struct file *fp)
347 nlookup_zero(struct nlookupdata *nd)
349 bzero(nd, sizeof(struct nlookupdata));
353 * Simple all-in-one nlookup. Returns a locked namecache structure or NULL
354 * if an error occured.
356 * Note that the returned ncp is not checked for permissions, though VEXEC
357 * is checked on the directory path leading up to the result. The caller
358 * must call naccess() to check the permissions of the returned leaf.
361 nlookup_simple(const char *str, enum uio_seg seg,
362 int niflags, int *error)
364 struct nlookupdata nd;
367 *error = nlookup_init(&nd, str, seg, niflags);
369 if ((*error = nlookup(&nd)) == 0) {
370 nch = nd.nl_nch; /* keep hold ref from structure */
371 cache_zero(&nd.nl_nch); /* and NULL out */
383 * Do a generic nlookup. Note that the passed nd is not nlookup_done()'d
384 * on return, even if an error occurs. If no error occurs the returned
385 * nl_nch is always referenced and locked, otherwise it may or may not be.
387 * Intermediate directory elements, including the current directory, require
388 * execute (search) permission. nlookup does not examine the access
389 * permissions on the returned element.
391 * If NLC_CREATE is set the last directory must allow node creation,
392 * and an error code of 0 will be returned for a non-existant
393 * target (not ENOENT).
395 * If NLC_RENAME_DST is set the last directory mut allow node deletion,
396 * plus the sticky check is made, and an error code of 0 will be returned
397 * for a non-existant target (not ENOENT).
399 * If NLC_DELETE is set the last directory mut allow node deletion,
400 * plus the sticky check is made.
402 * If NLC_REFDVP is set nd->nl_dvp will be set to the directory vnode
403 * of the returned entry. The vnode will be referenced, but not locked,
404 * and will be released by nlookup_done() along with everything else.
407 nlookup(struct nlookupdata *nd)
409 globaldata_t gd = mycpu;
410 struct nlcomponent nlc;
413 struct nchandle nctmp;
424 if (KTRPOINT(nd->nl_td, KTR_NAMEI))
425 ktrnamei(nd->nl_td->td_lwp, nd->nl_path);
427 bzero(&nlc, sizeof(nlc));
430 * Setup for the loop. The current working namecache element is
431 * always at least referenced. We lock it as required, but always
432 * return a locked, resolved namecache entry.
442 * Loop on the path components. At the top of the loop nd->nl_nch
443 * is ref'd and unlocked and represents our current position.
447 * Make sure nl_nch is locked so we can access the vnode, resolution
450 if ((nd->nl_flags & NLC_NCPISLOCKED) == 0) {
451 nd->nl_flags |= NLC_NCPISLOCKED;
452 cache_lock(&nd->nl_nch);
456 * Check if the root directory should replace the current
457 * directory. This is done at the start of a translation
458 * or after a symbolic link has been found. In other cases
459 * ptr will never be pointing at a '/'.
464 } while (*ptr == '/');
465 cache_get(&nd->nl_rootnch, &nch);
466 cache_put(&nd->nl_nch);
467 nd->nl_nch = nch; /* remains locked */
470 * Fast-track termination. There is no parent directory of
471 * the root in the same mount from the point of view of
472 * the caller so return EACCES if NLC_REFDVP is specified,
473 * and EEXIST if NLC_CREATE is also specified.
474 * e.g. 'rmdir /' or 'mkdir /' are not allowed.
477 if (nd->nl_flags & NLC_REFDVP)
478 error = (nd->nl_flags & NLC_CREATE) ? EEXIST : EACCES;
487 * Check directory search permissions.
490 error = naccess(&nd->nl_nch, NLC_EXEC, nd->nl_cred, &dflags);
495 * Extract the path component. Path components are limited to
498 nlc.nlc_nameptr = ptr;
499 while (*ptr && *ptr != '/')
501 nlc.nlc_namelen = ptr - nlc.nlc_nameptr;
502 if (nlc.nlc_namelen >= 256) {
503 error = ENAMETOOLONG;
508 * Lookup the path component in the cache, creating an unresolved
509 * entry if necessary. We have to handle "." and ".." as special
512 * When handling ".." we have to detect a traversal back through a
513 * mount point. If we are at the root, ".." just returns the root.
515 * When handling "." or ".." we also have to recalculate dflags
516 * since our dflags will be for some sub-directory instead of the
519 * This subsection returns a locked, refd 'nch' unless it errors out.
520 * The namecache topology is not allowed to be disconnected, so
521 * encountering a NULL parent will generate EINVAL. This typically
522 * occurs when a directory is removed out from under a process.
524 if (nlc.nlc_namelen == 1 && nlc.nlc_nameptr[0] == '.') {
525 cache_get(&nd->nl_nch, &nch);
527 } else if (nlc.nlc_namelen == 2 &&
528 nlc.nlc_nameptr[0] == '.' && nlc.nlc_nameptr[1] == '.') {
529 if (nd->nl_nch.mount == nd->nl_rootnch.mount &&
530 nd->nl_nch.ncp == nd->nl_rootnch.ncp
533 * ".." at the root returns the root
535 cache_get(&nd->nl_nch, &nch);
538 * Locate the parent ncp. If we are at the root of a
539 * filesystem mount we have to skip to the mounted-on
540 * point in the underlying filesystem.
542 * Expect the parent to always be good since the
543 * mountpoint doesn't go away. XXX hack. cache_get()
544 * requires the ncp to already have a ref as a safety.
547 while (nctmp.ncp == nctmp.mount->mnt_ncmountpt.ncp)
548 nctmp = nctmp.mount->mnt_ncmounton;
549 nctmp.ncp = nctmp.ncp->nc_parent;
550 KKASSERT(nctmp.ncp != NULL);
552 cache_get(&nctmp, &nch);
553 cache_drop(&nctmp); /* NOTE: zero's nctmp */
558 * Must unlock nl_nch when traversing down the path.
560 cache_unlock(&nd->nl_nch);
561 nd->nl_flags &= ~NLC_NCPISLOCKED;
562 nch = cache_nlookup(&nd->nl_nch, &nlc);
563 if (nch.ncp->nc_flag & NCF_UNRESOLVED)
565 while ((error = cache_resolve(&nch, nd->nl_cred)) == EAGAIN) {
566 kprintf("[diagnostic] nlookup: relookup %*.*s\n",
567 nch.ncp->nc_nlen, nch.ncp->nc_nlen, nch.ncp->nc_name);
569 nch = cache_nlookup(&nd->nl_nch, &nlc);
575 * If the last component was "." or ".." our dflags no longer
576 * represents the parent directory and we have to explicitly
579 * Expect the parent to be good since nch is locked.
581 if (wasdotordotdot && error == 0) {
583 if ((par.ncp = nch.ncp->nc_parent) != NULL) {
584 par.mount = nch.mount;
587 error = naccess(&par, 0, nd->nl_cred, &dflags);
591 if (nd->nl_flags & NLC_NCPISLOCKED) {
592 cache_unlock(&nd->nl_nch);
593 nd->nl_flags &= ~NLC_NCPISLOCKED;
597 * [end of subsection]
599 * nch is locked and referenced.
600 * nd->nl_nch is unlocked and referenced.
602 * nl_nch must be unlocked or we could chain lock to the root
603 * if a resolve gets stuck (e.g. in NFS).
607 * Resolve the namespace if necessary. The ncp returned by
608 * cache_nlookup() is referenced and locked.
610 * XXX neither '.' nor '..' should return EAGAIN since they were
611 * previously resolved and thus cannot be newly created ncp's.
613 if (nch.ncp->nc_flag & NCF_UNRESOLVED) {
615 error = cache_resolve(&nch, nd->nl_cred);
616 KKASSERT(error != EAGAIN);
618 error = nch.ncp->nc_error;
622 * Early completion. ENOENT is not an error if this is the last
623 * component and NLC_CREATE or NLC_RENAME (rename target) was
624 * requested. Note that ncp->nc_error is left as ENOENT in that
625 * case, which we check later on.
627 * Also handle invalid '.' or '..' components terminating a path
628 * for a create/rename/delete. The standard requires this and pax
629 * pretty stupidly depends on it.
631 for (xptr = ptr; *xptr == '/'; ++xptr)
634 if (error == ENOENT &&
635 (nd->nl_flags & (NLC_CREATE | NLC_RENAME_DST))
637 if (nd->nl_flags & NLC_NFS_RDONLY) {
640 error = naccess(&nch, nd->nl_flags | dflags,
644 if (error == 0 && wasdotordotdot &&
645 (nd->nl_flags & (NLC_CREATE | NLC_DELETE |
646 NLC_RENAME_SRC | NLC_RENAME_DST))) {
650 if (nd->nl_flags & NLC_CREATE)
652 else if (nd->nl_flags & NLC_DELETE)
653 error = (wasdotordotdot == 1) ? EINVAL : ENOTEMPTY;
660 * Early completion on error.
668 * If the element is a symlink and it is either not the last
669 * element or it is the last element and we are allowed to
670 * follow symlinks, resolve the symlink.
672 if ((nch.ncp->nc_flag & NCF_ISSYMLINK) &&
673 (*ptr || (nd->nl_flags & NLC_FOLLOW))
675 if (nd->nl_loopcnt++ >= MAXSYMLINKS) {
680 error = nreadsymlink(nd, &nch, &nlc);
686 * Concatenate trailing path elements onto the returned symlink.
687 * Note that if the path component (ptr) is not exhausted, it
688 * will being with a '/', so we do not have to add another one.
690 * The symlink may not be empty.
693 if (nlc.nlc_namelen == 0 || nlc.nlc_namelen + len >= MAXPATHLEN) {
694 error = nlc.nlc_namelen ? ENAMETOOLONG : ENOENT;
695 objcache_put(namei_oc, nlc.nlc_nameptr);
698 bcopy(ptr, nlc.nlc_nameptr + nlc.nlc_namelen, len + 1);
699 if (nd->nl_flags & NLC_HASBUF)
700 objcache_put(namei_oc, nd->nl_path);
701 nd->nl_path = nlc.nlc_nameptr;
702 nd->nl_flags |= NLC_HASBUF;
706 * Go back up to the top to resolve any initial '/'s in the
713 * If the element is a directory and we are crossing a mount point,
716 while ((nch.ncp->nc_flag & NCF_ISMOUNTPT) &&
717 (nd->nl_flags & NLC_NOCROSSMOUNT) == 0 &&
718 (mp = cache_findmount(&nch)) != NULL
723 cache_get(&mp->mnt_ncmountpt, &nch);
725 if (nch.ncp->nc_flag & NCF_UNRESOLVED) {
726 while (vfs_busy(mp, 0))
728 error = VFS_ROOT(mp, &tdp);
732 cache_setvp(&nch, tdp);
742 * Skip any slashes to get to the next element. If there
743 * are any slashes at all the current element must be a
744 * directory or, in the create case, intended to become a directory.
745 * If it isn't we break without incrementing ptr and fall through
746 * to the failure case below.
748 while (*ptr == '/') {
749 if ((nch.ncp->nc_flag & NCF_ISDIR) == 0 &&
750 !(nd->nl_flags & NLC_WILLBEDIR)
758 * Continuation case: additional elements and the current
759 * element is a directory.
761 if (*ptr && (nch.ncp->nc_flag & NCF_ISDIR)) {
762 cache_drop(&nd->nl_nch);
764 KKASSERT((nd->nl_flags & NLC_NCPISLOCKED) == 0);
770 * Failure case: additional elements and the current element
780 * Successful lookup of last element.
782 * Check permissions if the target exists. If the target does not
783 * exist directory permissions were already tested in the early
784 * completion code above.
786 * nd->nl_flags will be adjusted on return with NLC_APPENDONLY
787 * if the file is marked append-only, and NLC_STICKY if the directory
788 * containing the file is sticky.
790 if (nch.ncp->nc_vp && (nd->nl_flags & NLC_ALLCHKS)) {
791 error = naccess(&nch, nd->nl_flags | dflags,
800 * Termination: no more elements.
802 * If NLC_REFDVP is set acquire a referenced parent dvp.
804 if (nd->nl_flags & NLC_REFDVP) {
805 cache_lock(&nd->nl_nch);
806 error = cache_vref(&nd->nl_nch, nd->nl_cred, &nd->nl_dvp);
807 cache_unlock(&nd->nl_nch);
809 kprintf("NLC_REFDVP: Cannot ref dvp of %p\n", nch.ncp);
814 cache_drop(&nd->nl_nch);
816 nd->nl_flags |= NLC_NCPISLOCKED;
822 ++gd->gd_nchstats->ncs_longhits;
824 ++gd->gd_nchstats->ncs_longmiss;
827 * NOTE: If NLC_CREATE was set the ncp may represent a negative hit
828 * (ncp->nc_error will be ENOENT), but we will still return an error
835 * Resolve a mount point's glue ncp. This ncp connects creates the illusion
836 * of continuity in the namecache tree by connecting the ncp related to the
837 * vnode under the mount to the ncp related to the mount's root vnode.
839 * If no error occured a locked, ref'd ncp is stored in *ncpp.
842 nlookup_mp(struct mount *mp, struct nchandle *nch)
848 cache_get(&mp->mnt_ncmountpt, nch);
849 if (nch->ncp->nc_flag & NCF_UNRESOLVED) {
850 while (vfs_busy(mp, 0))
852 error = VFS_ROOT(mp, &vp);
857 cache_setvp(nch, vp);
865 * Read the contents of a symlink, allocate a path buffer out of the
866 * namei_oc and initialize the supplied nlcomponent with the result.
868 * If an error occurs no buffer will be allocated or returned in the nlc.
871 nreadsymlink(struct nlookupdata *nd, struct nchandle *nch,
872 struct nlcomponent *nlc)
881 nlc->nlc_nameptr = NULL;
882 nlc->nlc_namelen = 0;
883 if (nch->ncp->nc_vp == NULL)
885 if ((error = cache_vget(nch, nd->nl_cred, LK_SHARED, &vp)) != 0)
887 cp = objcache_get(namei_oc, M_WAITOK);
889 aiov.iov_len = MAXPATHLEN;
890 auio.uio_iov = &aiov;
893 auio.uio_rw = UIO_READ;
894 auio.uio_segflg = UIO_SYSSPACE;
895 auio.uio_td = nd->nl_td;
896 auio.uio_resid = MAXPATHLEN - 1;
897 error = VOP_READLINK(vp, &auio, nd->nl_cred);
900 linklen = MAXPATHLEN - 1 - auio.uio_resid;
902 linklen = varsymreplace(cp, linklen, MAXPATHLEN - 1);
904 error = ENAMETOOLONG;
909 nlc->nlc_nameptr = cp;
910 nlc->nlc_namelen = linklen;
914 objcache_put(namei_oc, cp);
920 * Check access [XXX cache vattr!] [XXX quota]
922 * Generally check the NLC_* access bits. All specified bits must pass
923 * for this function to return 0.
925 * The file does not have to exist when checking NLC_CREATE or NLC_RENAME_DST
926 * access, otherwise it must exist. No error is returned in this case.
928 * The file must not exist if NLC_EXCL is specified.
930 * Directory permissions in general are tested for NLC_CREATE if the file
931 * does not exist, NLC_DELETE if the file does exist, and NLC_RENAME_DST
932 * whether the file exists or not.
934 * The directory sticky bit is tested for NLC_DELETE and NLC_RENAME_DST,
935 * the latter is only tested if the target exists.
937 * The passed ncp must be referenced and locked.
940 naccess(struct nchandle *nch, int nflags, struct ucred *cred, int *nflagsp)
944 struct namecache *ncp;
948 ASSERT_NCH_LOCKED(nch);
950 if (ncp->nc_flag & NCF_UNRESOLVED) {
951 cache_resolve(nch, cred);
954 error = ncp->nc_error;
957 * Directory permissions checks. Silently ignore ENOENT if these
958 * tests pass. It isn't an error.
960 * We can safely resolve ncp->nc_parent because ncp is currently
963 if (nflags & (NLC_CREATE | NLC_DELETE | NLC_RENAME_SRC | NLC_RENAME_DST)) {
964 if (((nflags & NLC_CREATE) && ncp->nc_vp == NULL) ||
965 ((nflags & NLC_DELETE) && ncp->nc_vp != NULL) ||
966 ((nflags & NLC_RENAME_SRC) && ncp->nc_vp != NULL) ||
967 (nflags & NLC_RENAME_DST)
971 if ((par.ncp = ncp->nc_parent) == NULL) {
974 } else if (error == 0 || error == ENOENT) {
975 par.mount = nch->mount;
978 error = naccess(&par, NLC_WRITE, cred, NULL);
985 * NLC_EXCL check. Target file must not exist.
987 if (error == 0 && (nflags & NLC_EXCL) && ncp->nc_vp != NULL)
991 * Get the vnode attributes so we can do the rest of our checks.
993 * NOTE: We only call naccess_va() if the target exists.
996 error = cache_vget(nch, cred, LK_SHARED, &vp);
997 if (error == ENOENT) {
999 * Silently zero-out ENOENT if creating or renaming
1000 * (rename target). It isn't an error.
1002 if (nflags & (NLC_CREATE | NLC_RENAME_DST))
1004 } else if (error == 0) {
1006 * Get the vnode attributes and check for illegal O_TRUNC
1007 * requests and read-only mounts.
1009 * NOTE: You can still open devices on read-only mounts for
1012 * NOTE: creates/deletes/renames are handled by the NLC_WRITE
1013 * check on the parent directory above.
1015 * XXX cache the va in the namecache or in the vnode
1017 error = VOP_GETATTR(vp, &va);
1018 if (error == 0 && (nflags & NLC_TRUNCATE)) {
1019 switch(va.va_type) {
1034 if (error == 0 && (nflags & NLC_WRITE) && vp->v_mount &&
1035 (vp->v_mount->mnt_flag & MNT_RDONLY)
1037 switch(va.va_type) {
1051 * Check permissions based on file attributes. The passed
1052 * flags (*nflagsp) are modified with feedback based on
1053 * special attributes and requirements.
1057 * Adjust the returned (*nflagsp) if non-NULL.
1060 if ((va.va_mode & VSVTX) && va.va_uid != cred->cr_uid)
1061 *nflagsp |= NLC_STICKY;
1062 if (va.va_flags & APPEND)
1063 *nflagsp |= NLC_APPENDONLY;
1064 if (va.va_flags & IMMUTABLE)
1065 *nflagsp |= NLC_IMMUTABLE;
1069 * Track swapcache management flags in the namecache.
1071 * Calculate the flags based on the current vattr info
1072 * and recalculate the inherited flags from the parent
1073 * (the original cache linkage may have occurred without
1074 * getattrs and thus have stale flags).
1077 if (va.va_flags & SF_NOCACHE)
1078 cflags |= NCF_SF_NOCACHE;
1079 if (va.va_flags & UF_CACHE)
1080 cflags |= NCF_UF_CACHE;
1081 if (ncp->nc_parent) {
1082 if (ncp->nc_parent->nc_flag &
1083 (NCF_SF_NOCACHE | NCF_SF_PNOCACHE)) {
1084 cflags |= NCF_SF_PNOCACHE;
1086 if (ncp->nc_parent->nc_flag &
1087 (NCF_UF_CACHE | NCF_UF_PCACHE)) {
1088 cflags |= NCF_UF_PCACHE;
1091 ncp->nc_flag &= ~(NCF_SF_NOCACHE | NCF_UF_CACHE |
1092 NCF_SF_PNOCACHE | NCF_UF_PCACHE);
1093 ncp->nc_flag |= cflags;
1096 * Process general access.
1098 error = naccess_va(&va, nflags, cred);
1106 * Check the requested access against the given vattr using cred.
1109 naccess_va(struct vattr *va, int nflags, struct ucred *cred)
1115 * Test the immutable bit. Creations, deletions, renames (source
1116 * or destination) are not allowed. chown/chmod/other is also not
1117 * allowed but is handled by SETATTR. Hardlinks to the immutable
1120 * If the directory is set to immutable then creations, deletions,
1121 * renames (source or dest) and hardlinks to files within the directory
1122 * are not allowed, and regular files opened through the directory may
1123 * not be written to or truncated (unless a special device).
1125 * NOTE! New hardlinks to immutable files work but new hardlinks to
1126 * files, immutable or not, sitting inside an immutable directory are
1127 * not allowed. As always if the file is hardlinked via some other
1128 * path additional hardlinks may be possible even if the file is marked
1129 * immutable. The sysop needs to create a closure by checking the hard
1130 * link count. Once closure is achieved you are good, and security
1131 * scripts should check link counts anyway.
1133 * Writes and truncations are only allowed on special devices.
1135 if ((va->va_flags & IMMUTABLE) || (nflags & NLC_IMMUTABLE)) {
1136 if ((nflags & NLC_IMMUTABLE) && (nflags & NLC_HLINK))
1138 if (nflags & (NLC_CREATE | NLC_DELETE |
1139 NLC_RENAME_SRC | NLC_RENAME_DST)) {
1142 if (nflags & (NLC_WRITE | NLC_TRUNCATE)) {
1143 switch(va->va_type) {
1157 * Test the no-unlink and append-only bits for opens, rename targets,
1158 * and deletions. These bits are not tested for creations or
1161 * Unlike FreeBSD we allow a file with APPEND set to be renamed.
1162 * If you do not wish this you must also set NOUNLINK.
1164 * If the governing directory is marked APPEND-only it implies
1165 * NOUNLINK for all entries in the directory.
1167 if (((va->va_flags & NOUNLINK) || (nflags & NLC_APPENDONLY)) &&
1168 (nflags & (NLC_DELETE | NLC_RENAME_SRC | NLC_RENAME_DST))
1174 * A file marked append-only may not be deleted but can be renamed.
1176 if ((va->va_flags & APPEND) &&
1177 (nflags & (NLC_DELETE | NLC_RENAME_DST))
1183 * A file marked append-only which is opened for writing must also
1184 * be opened O_APPEND.
1186 if ((va->va_flags & APPEND) && (nflags & (NLC_OPEN | NLC_TRUNCATE))) {
1187 if (nflags & NLC_TRUNCATE)
1189 if ((nflags & (NLC_OPEN | NLC_WRITE)) == (NLC_OPEN | NLC_WRITE)) {
1190 if ((nflags & NLC_APPEND) == 0)
1196 * root gets universal access
1198 if (cred->cr_uid == 0)
1202 * Check owner perms.
1204 * If NLC_OWN is set the owner of the file is allowed no matter when
1205 * the owner-mode bits say (utimes).
1208 if (nflags & NLC_READ)
1210 if (nflags & NLC_WRITE)
1212 if (nflags & NLC_EXEC)
1215 if (cred->cr_uid == va->va_uid) {
1216 if ((nflags & NLC_OWN) == 0) {
1217 if ((vmode & va->va_mode) != vmode)
1224 * If NLC_STICKY is set only the owner may delete or rename a file.
1225 * This bit is typically set on /tmp.
1227 * Note that the NLC_READ/WRITE/EXEC bits are not typically set in
1228 * the specific delete or rename case. For deletions and renames we
1229 * usually just care about directory permissions, not file permissions.
1231 if ((nflags & NLC_STICKY) &&
1232 (nflags & (NLC_RENAME_SRC | NLC_RENAME_DST | NLC_DELETE))) {
1240 for (i = 0; i < cred->cr_ngroups; ++i) {
1241 if (va->va_gid == cred->cr_groups[i]) {
1242 if ((vmode & va->va_mode) != vmode)
1252 if ((vmode & va->va_mode) != vmode)