2 * Copyright (c) 1982, 1986, 1989, 1993
3 * The Regents of the University of California. All rights reserved.
4 * (c) UNIX System Laboratories, Inc.
5 * All or some portions of this file are derived from material licensed
6 * to the University of California by American Telephone and Telegraph
7 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8 * the permission of UNIX System Laboratories, Inc.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 4. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * @(#)vfs_lookup.c 8.4 (Berkeley) 2/16/94
37 #include <sys/cdefs.h>
38 __FBSDID("$FreeBSD$");
40 #include "opt_capsicum.h"
41 #include "opt_kdtrace.h"
42 #include "opt_ktrace.h"
44 #include <sys/param.h>
45 #include <sys/systm.h>
46 #include <sys/kernel.h>
47 #include <sys/capability.h>
48 #include <sys/fcntl.h>
51 #include <sys/mutex.h>
52 #include <sys/namei.h>
53 #include <sys/vnode.h>
54 #include <sys/mount.h>
55 #include <sys/filedesc.h>
58 #include <sys/syscallsubr.h>
59 #include <sys/sysctl.h>
61 #include <sys/ktrace.h>
64 #include <security/audit/audit.h>
65 #include <security/mac/mac_framework.h>
69 #define NAMEI_DIAGNOSTIC 1
70 #undef NAMEI_DIAGNOSTIC
72 SDT_PROVIDER_DECLARE(vfs);
73 SDT_PROBE_DEFINE3(vfs, namei, lookup, entry, entry, "struct vnode *", "char *",
75 SDT_PROBE_DEFINE2(vfs, namei, lookup, return, return, "int", "struct vnode *");
78 * Allocation zone for namei
80 uma_zone_t namei_zone;
82 * Placeholder vnode for mp traversal
84 static struct vnode *vp_crossmp;
87 nameiinit(void *dummy __unused)
90 namei_zone = uma_zcreate("NAMEI", MAXPATHLEN, NULL, NULL, NULL, NULL,
92 getnewvnode("crossmp", NULL, &dead_vnodeops, &vp_crossmp);
93 vn_lock(vp_crossmp, LK_EXCLUSIVE);
94 VN_LOCK_ASHARE(vp_crossmp);
95 VOP_UNLOCK(vp_crossmp, 0);
97 SYSINIT(vfs, SI_SUB_VFS, SI_ORDER_SECOND, nameiinit, NULL);
99 static int lookup_shared = 1;
100 SYSCTL_INT(_vfs, OID_AUTO, lookup_shared, CTLFLAG_RW, &lookup_shared, 0,
101 "Enables/Disables shared locks for path name translation");
102 TUNABLE_INT("vfs.lookup_shared", &lookup_shared);
105 * Convert a pathname into a pointer to a locked vnode.
107 * The FOLLOW flag is set when symbolic links are to be followed
108 * when they occur at the end of the name translation process.
109 * Symbolic links are always followed for all other pathname
110 * components other than the last.
112 * The segflg defines whether the name is to be copied from user
113 * space or kernel space.
115 * Overall outline of namei:
118 * get starting directory
119 * while (!done && !error) {
120 * call lookup to search path.
121 * if symbolic link, massage name in buffer and continue
125 namei_cleanup_cnp(struct componentname *cnp)
127 uma_zfree(namei_zone, cnp->cn_pnbuf);
129 cnp->cn_pnbuf = NULL;
130 cnp->cn_nameptr = NULL;
135 namei(struct nameidata *ndp)
137 struct filedesc *fdp; /* pointer to file descriptor state */
138 char *cp; /* pointer into pathname argument */
139 struct vnode *dp; /* the directory we are searching */
140 struct iovec aiov; /* uio for reading symbolic links */
143 struct componentname *cnp = &ndp->ni_cnd;
144 struct thread *td = cnp->cn_thread;
145 struct proc *p = td->td_proc;
148 KASSERT((cnp->cn_flags & MPSAFE) != 0 || mtx_owned(&Giant) != 0,
149 ("NOT MPSAFE and Giant not held"));
150 ndp->ni_cnd.cn_cred = ndp->ni_cnd.cn_thread->td_ucred;
151 KASSERT(cnp->cn_cred && p, ("namei: bad cred/proc"));
152 KASSERT((cnp->cn_nameiop & (~OPMASK)) == 0,
153 ("namei: nameiop contaminated with flags"));
154 KASSERT((cnp->cn_flags & OPMASK) == 0,
155 ("namei: flags contaminated with nameiops"));
157 cnp->cn_flags &= ~LOCKSHARED;
160 /* We will set this ourselves if we need it. */
161 cnp->cn_flags &= ~TRAILINGSLASH;
164 * Get a buffer for the name to be translated, and copy the
165 * name into the buffer.
167 if ((cnp->cn_flags & HASBUF) == 0)
168 cnp->cn_pnbuf = uma_zalloc(namei_zone, M_WAITOK);
169 if (ndp->ni_segflg == UIO_SYSSPACE)
170 error = copystr(ndp->ni_dirp, cnp->cn_pnbuf,
171 MAXPATHLEN, (size_t *)&ndp->ni_pathlen);
173 error = copyinstr(ndp->ni_dirp, cnp->cn_pnbuf,
174 MAXPATHLEN, (size_t *)&ndp->ni_pathlen);
178 * If we are auditing the kernel pathname, save the user
181 if (cnp->cn_flags & AUDITVNODE1)
182 AUDIT_ARG_UPATH1(td, cnp->cn_pnbuf);
183 if (cnp->cn_flags & AUDITVNODE2)
184 AUDIT_ARG_UPATH2(td, cnp->cn_pnbuf);
188 * Don't allow empty pathnames.
190 if (!error && *cnp->cn_pnbuf == '\0')
193 #ifdef CAPABILITY_MODE
195 * In capability mode, lookups must be "strictly relative" (i.e.
196 * not an absolute path, and not containing '..' components) to
197 * a real file descriptor, not the pseudo-descriptor AT_FDCWD.
199 if (IN_CAPABILITY_MODE(td)) {
200 ndp->ni_strictrelative = 1;
201 if (ndp->ni_dirfd == AT_FDCWD)
206 namei_cleanup_cnp(cnp);
212 if (KTRPOINT(td, KTR_NAMEI)) {
213 KASSERT(cnp->cn_thread == curthread,
214 ("namei not using curthread"));
215 ktrnamei(cnp->cn_pnbuf);
219 * Get starting point for the translation.
222 ndp->ni_rootdir = fdp->fd_rdir;
223 ndp->ni_topdir = fdp->fd_jdir;
226 if (cnp->cn_pnbuf[0] != '/') {
227 if (ndp->ni_startdir != NULL) {
228 dp = ndp->ni_startdir;
230 } else if (ndp->ni_dirfd != AT_FDCWD) {
231 if (cnp->cn_flags & AUDITVNODE1)
232 AUDIT_ARG_ATFD1(ndp->ni_dirfd);
233 if (cnp->cn_flags & AUDITVNODE2)
234 AUDIT_ARG_ATFD2(ndp->ni_dirfd);
235 error = fgetvp_rights(td, ndp->ni_dirfd,
236 ndp->ni_rightsneeded | CAP_LOOKUP,
237 &(ndp->ni_baserights), &dp);
240 * Lookups relative to a capability must also be
243 * Note that a capability with rights CAP_MASK_VALID
244 * is treated exactly like a regular file descriptor.
246 if (ndp->ni_baserights != CAP_MASK_VALID)
247 ndp->ni_strictrelative = 1;
250 if (error != 0 || dp != NULL) {
251 FILEDESC_SUNLOCK(fdp);
252 if (error == 0 && dp->v_type != VDIR) {
253 vfslocked = VFS_LOCK_GIANT(dp->v_mount);
255 VFS_UNLOCK_GIANT(vfslocked);
260 namei_cleanup_cnp(cnp);
267 FILEDESC_SUNLOCK(fdp);
268 if (ndp->ni_startdir != NULL) {
269 vfslocked = VFS_LOCK_GIANT(ndp->ni_startdir->v_mount);
270 vrele(ndp->ni_startdir);
271 VFS_UNLOCK_GIANT(vfslocked);
274 SDT_PROBE(vfs, namei, lookup, entry, dp, cnp->cn_pnbuf,
275 cnp->cn_flags, 0, 0);
276 vfslocked = VFS_LOCK_GIANT(dp->v_mount);
279 * Check if root directory should replace current directory.
280 * Done at start of translation and after symbolic link.
282 cnp->cn_nameptr = cnp->cn_pnbuf;
283 if (*(cnp->cn_nameptr) == '/') {
285 VFS_UNLOCK_GIANT(vfslocked);
286 if (ndp->ni_strictrelative != 0) {
287 namei_cleanup_cnp(cnp);
288 return (ENOTCAPABLE);
290 while (*(cnp->cn_nameptr) == '/') {
294 dp = ndp->ni_rootdir;
295 vfslocked = VFS_LOCK_GIANT(dp->v_mount);
299 ndp->ni_cnd.cn_flags |= GIANTHELD;
300 ndp->ni_startdir = dp;
303 namei_cleanup_cnp(cnp);
304 SDT_PROBE(vfs, namei, lookup, return, error, NULL, 0,
308 vfslocked = (ndp->ni_cnd.cn_flags & GIANTHELD) != 0;
309 ndp->ni_cnd.cn_flags &= ~GIANTHELD;
311 * If not a symbolic link, we're done.
313 if ((cnp->cn_flags & ISSYMLINK) == 0) {
314 if ((cnp->cn_flags & (SAVENAME | SAVESTART)) == 0) {
315 namei_cleanup_cnp(cnp);
317 cnp->cn_flags |= HASBUF;
319 if ((cnp->cn_flags & MPSAFE) == 0) {
320 VFS_UNLOCK_GIANT(vfslocked);
321 } else if (vfslocked)
322 ndp->ni_cnd.cn_flags |= GIANTHELD;
323 SDT_PROBE(vfs, namei, lookup, return, 0, ndp->ni_vp,
327 if (ndp->ni_loopcnt++ >= MAXSYMLINKS) {
332 if ((cnp->cn_flags & NOMACCHECK) == 0) {
333 error = mac_vnode_check_readlink(td->td_ucred,
339 if (ndp->ni_pathlen > 1)
340 cp = uma_zalloc(namei_zone, M_WAITOK);
344 aiov.iov_len = MAXPATHLEN;
345 auio.uio_iov = &aiov;
348 auio.uio_rw = UIO_READ;
349 auio.uio_segflg = UIO_SYSSPACE;
350 auio.uio_td = (struct thread *)0;
351 auio.uio_resid = MAXPATHLEN;
352 error = VOP_READLINK(ndp->ni_vp, &auio, cnp->cn_cred);
354 if (ndp->ni_pathlen > 1)
355 uma_zfree(namei_zone, cp);
358 linklen = MAXPATHLEN - auio.uio_resid;
360 if (ndp->ni_pathlen > 1)
361 uma_zfree(namei_zone, cp);
365 if (linklen + ndp->ni_pathlen >= MAXPATHLEN) {
366 if (ndp->ni_pathlen > 1)
367 uma_zfree(namei_zone, cp);
368 error = ENAMETOOLONG;
371 if (ndp->ni_pathlen > 1) {
372 bcopy(ndp->ni_next, cp + linklen, ndp->ni_pathlen);
373 uma_zfree(namei_zone, cnp->cn_pnbuf);
376 cnp->cn_pnbuf[linklen] = '\0';
377 ndp->ni_pathlen += linklen;
381 namei_cleanup_cnp(cnp);
385 VFS_UNLOCK_GIANT(vfslocked);
386 SDT_PROBE(vfs, namei, lookup, return, error, NULL, 0, 0, 0);
391 compute_cn_lkflags(struct mount *mp, int lkflags)
395 ((lkflags & LK_SHARED) && !(mp->mnt_kern_flag & MNTK_LOOKUP_SHARED))) {
396 lkflags &= ~LK_SHARED;
397 lkflags |= LK_EXCLUSIVE;
403 needs_exclusive_leaf(struct mount *mp, int flags)
407 * Intermediate nodes can use shared locks, we only need to
408 * force an exclusive lock for leaf nodes.
410 if ((flags & (ISLASTCN | LOCKLEAF)) != (ISLASTCN | LOCKLEAF))
413 /* Always use exclusive locks if LOCKSHARED isn't set. */
414 if (!(flags & LOCKSHARED))
418 * For lookups during open(), if the mount point supports
419 * extended shared operations, then use a shared lock for the
420 * leaf node, otherwise use an exclusive lock.
422 if (flags & ISOPEN) {
424 (mp->mnt_kern_flag & MNTK_EXTENDED_SHARED))
431 * Lookup requests outside of open() that specify LOCKSHARED
432 * only need a shared lock on the leaf vnode.
439 * This is a very central and rather complicated routine.
441 * The pathname is pointed to by ni_ptr and is of length ni_pathlen.
442 * The starting directory is taken from ni_startdir. The pathname is
443 * descended until done, or a symbolic link is encountered. The variable
444 * ni_more is clear if the path is completed; it is set to one if a
445 * symbolic link needing interpretation is encountered.
447 * The flag argument is LOOKUP, CREATE, RENAME, or DELETE depending on
448 * whether the name is to be looked up, created, renamed, or deleted.
449 * When CREATE, RENAME, or DELETE is specified, information usable in
450 * creating, renaming, or deleting a directory entry may be calculated.
451 * If flag has LOCKPARENT or'ed into it, the parent directory is returned
452 * locked. If flag has WANTPARENT or'ed into it, the parent directory is
453 * returned unlocked. Otherwise the parent directory is not returned. If
454 * the target of the pathname exists and LOCKLEAF is or'ed into the flag
455 * the target is returned locked, otherwise it is returned unlocked.
456 * When creating or renaming and LOCKPARENT is specified, the target may not
457 * be ".". When deleting and LOCKPARENT is specified, the target may be ".".
459 * Overall outline of lookup:
462 * identify next component of name at ndp->ni_ptr
463 * handle degenerate case where name is null string
464 * if .. and crossing mount points and on mounted filesys, find parent
465 * call VOP_LOOKUP routine for next component name
466 * directory vnode returned in ni_dvp, unlocked unless LOCKPARENT set
467 * component vnode returned in ni_vp (if it exists), locked.
468 * if result vnode is mounted on and crossing mount points,
469 * find mounted on vnode
470 * if more components of name, do next level at dirloop
471 * return the answer in ni_vp, locked if LOCKLEAF set
472 * if LOCKPARENT set, return locked parent in ni_dvp
473 * if WANTPARENT set, return unlocked parent in ni_dvp
476 lookup(struct nameidata *ndp)
478 char *cp; /* pointer into pathname argument */
479 struct vnode *dp = 0; /* the directory we are searching */
480 struct vnode *tdp; /* saved dp */
481 struct mount *mp; /* mount table entry */
483 int docache; /* == 0 do not cache last component */
484 int wantparent; /* 1 => wantparent or lockparent flag */
485 int rdonly; /* lookup read-only flag bit */
487 int dpunlocked = 0; /* dp has already been unlocked */
488 struct componentname *cnp = &ndp->ni_cnd;
489 int vfslocked; /* VFS Giant state for child */
490 int dvfslocked; /* VFS Giant state for parent */
496 * Setup: break out flag bits into variables.
498 dvfslocked = (ndp->ni_cnd.cn_flags & GIANTHELD) != 0;
501 ndp->ni_cnd.cn_flags &= ~GIANTHELD;
502 wantparent = cnp->cn_flags & (LOCKPARENT | WANTPARENT);
503 KASSERT(cnp->cn_nameiop == LOOKUP || wantparent,
504 ("CREATE, DELETE, RENAME require LOCKPARENT or WANTPARENT."));
505 docache = (cnp->cn_flags & NOCACHE) ^ NOCACHE;
506 if (cnp->cn_nameiop == DELETE ||
507 (wantparent && cnp->cn_nameiop != CREATE &&
508 cnp->cn_nameiop != LOOKUP))
510 rdonly = cnp->cn_flags & RDONLY;
511 cnp->cn_flags &= ~ISSYMLINK;
514 * We use shared locks until we hit the parent of the last cn then
515 * we adjust based on the requesting flags.
518 cnp->cn_lkflags = LK_SHARED;
520 cnp->cn_lkflags = LK_EXCLUSIVE;
521 dp = ndp->ni_startdir;
522 ndp->ni_startdir = NULLVP;
524 compute_cn_lkflags(dp->v_mount, cnp->cn_lkflags | LK_RETRY));
528 * Search a new directory.
530 * The last component of the filename is left accessible via
531 * cnp->cn_nameptr for callers that need the name. Callers needing
532 * the name set the SAVENAME flag. When done, they assume
533 * responsibility for freeing the pathname buffer.
536 for (cp = cnp->cn_nameptr; *cp != 0 && *cp != '/'; cp++)
538 cnp->cn_namelen = cp - cnp->cn_nameptr;
539 if (cnp->cn_namelen > NAME_MAX) {
540 error = ENAMETOOLONG;
543 #ifdef NAMEI_DIAGNOSTIC
546 printf("{%s}: ", cnp->cn_nameptr);
549 ndp->ni_pathlen -= cnp->cn_namelen;
553 * Replace multiple slashes by a single slash and trailing slashes
554 * by a null. This must be done before VOP_LOOKUP() because some
555 * fs's don't know about trailing slashes. Remember if there were
556 * trailing slashes to handle symlinks, existing non-directories
557 * and non-existing files that won't be directories specially later.
559 while (*cp == '/' && (cp[1] == '/' || cp[1] == '\0')) {
563 *ndp->ni_next = '\0';
564 cnp->cn_flags |= TRAILINGSLASH;
569 cnp->cn_flags |= MAKEENTRY;
570 if (*cp == '\0' && docache == 0)
571 cnp->cn_flags &= ~MAKEENTRY;
572 if (cnp->cn_namelen == 2 &&
573 cnp->cn_nameptr[1] == '.' && cnp->cn_nameptr[0] == '.')
574 cnp->cn_flags |= ISDOTDOT;
576 cnp->cn_flags &= ~ISDOTDOT;
577 if (*ndp->ni_next == 0)
578 cnp->cn_flags |= ISLASTCN;
580 cnp->cn_flags &= ~ISLASTCN;
582 if ((cnp->cn_flags & ISLASTCN) != 0 &&
583 cnp->cn_namelen == 1 && cnp->cn_nameptr[0] == '.' &&
584 (cnp->cn_nameiop == DELETE || cnp->cn_nameiop == RENAME)) {
590 * Check for degenerate name (e.g. / or "")
591 * which is a way of talking about a directory,
592 * e.g. like "/." or ".".
594 if (cnp->cn_nameptr[0] == '\0') {
595 if (dp->v_type != VDIR) {
599 if (cnp->cn_nameiop != LOOKUP) {
609 if (cnp->cn_flags & AUDITVNODE1)
610 AUDIT_ARG_VNODE1(dp);
611 else if (cnp->cn_flags & AUDITVNODE2)
612 AUDIT_ARG_VNODE2(dp);
614 if (!(cnp->cn_flags & (LOCKPARENT | LOCKLEAF)))
616 /* XXX This should probably move to the top of function. */
617 if (cnp->cn_flags & SAVESTART)
618 panic("lookup: SAVESTART");
623 * Handle "..": five special cases.
624 * 0. If doing a capability lookup, return ENOTCAPABLE (this is a
625 * fairly conservative design choice, but it's the only one that we
626 * are satisfied guarantees the property we're looking for).
627 * 1. Return an error if this is the last component of
628 * the name and the operation is DELETE or RENAME.
629 * 2. If at root directory (e.g. after chroot)
630 * or at absolute root directory
631 * then ignore it so can't get out.
632 * 3. If this vnode is the root of a mounted
633 * filesystem, then replace it with the
634 * vnode which was mounted on so we take the
635 * .. in the other filesystem.
636 * 4. If the vnode is the top directory of
637 * the jail or chroot, don't let them out.
639 if (cnp->cn_flags & ISDOTDOT) {
640 if (ndp->ni_strictrelative != 0) {
644 if ((cnp->cn_flags & ISLASTCN) != 0 &&
645 (cnp->cn_nameiop == DELETE || cnp->cn_nameiop == RENAME)) {
650 for (pr = cnp->cn_cred->cr_prison; pr != NULL;
652 if (dp == pr->pr_root)
654 if (dp == ndp->ni_rootdir ||
655 dp == ndp->ni_topdir ||
658 ((dp->v_vflag & VV_ROOT) != 0 &&
659 (cnp->cn_flags & NOCROSSMOUNT) != 0)) {
662 vfslocked = VFS_LOCK_GIANT(dp->v_mount);
666 if ((dp->v_vflag & VV_ROOT) == 0)
668 if (dp->v_iflag & VI_DOOMED) { /* forced unmount */
673 dp = dp->v_mount->mnt_vnodecovered;
674 tvfslocked = dvfslocked;
675 dvfslocked = VFS_LOCK_GIANT(dp->v_mount);
678 VFS_UNLOCK_GIANT(tvfslocked);
680 compute_cn_lkflags(dp->v_mount, cnp->cn_lkflags |
686 * We now have a segment name to search for, and a directory to search.
690 if ((cnp->cn_flags & NOMACCHECK) == 0) {
691 error = mac_vnode_check_lookup(cnp->cn_thread->td_ucred, dp,
699 ASSERT_VOP_LOCKED(dp, "lookup");
700 VNASSERT(vfslocked == 0, dp, ("lookup: vfslocked %d", vfslocked));
702 * If we have a shared lock we may need to upgrade the lock for the
705 if (dp != vp_crossmp &&
706 VOP_ISLOCKED(dp) == LK_SHARED &&
707 (cnp->cn_flags & ISLASTCN) && (cnp->cn_flags & LOCKPARENT))
708 vn_lock(dp, LK_UPGRADE|LK_RETRY);
710 * If we're looking up the last component and we need an exclusive
711 * lock, adjust our lkflags.
713 if (needs_exclusive_leaf(dp->v_mount, cnp->cn_flags))
714 cnp->cn_lkflags = LK_EXCLUSIVE;
715 #ifdef NAMEI_DIAGNOSTIC
716 vprint("lookup in", dp);
718 lkflags_save = cnp->cn_lkflags;
719 cnp->cn_lkflags = compute_cn_lkflags(dp->v_mount, cnp->cn_lkflags);
720 if ((error = VOP_LOOKUP(dp, &ndp->ni_vp, cnp)) != 0) {
721 cnp->cn_lkflags = lkflags_save;
722 KASSERT(ndp->ni_vp == NULL, ("leaf should be empty"));
723 #ifdef NAMEI_DIAGNOSTIC
724 printf("not found\n");
726 if ((error == ENOENT) &&
727 (dp->v_vflag & VV_ROOT) && (dp->v_mount != NULL) &&
728 (dp->v_mount->mnt_flag & MNT_UNION)) {
730 dp = dp->v_mount->mnt_vnodecovered;
731 tvfslocked = dvfslocked;
732 dvfslocked = VFS_LOCK_GIANT(dp->v_mount);
735 VFS_UNLOCK_GIANT(tvfslocked);
737 compute_cn_lkflags(dp->v_mount, cnp->cn_lkflags |
742 if (error != EJUSTRETURN)
745 * At this point, we know we're at the end of the
746 * pathname. If creating / renaming, we can consider
747 * allowing the file or directory to be created / renamed,
748 * provided we're not on a read-only filesystem.
754 /* trailing slash only allowed for directories */
755 if ((cnp->cn_flags & TRAILINGSLASH) &&
756 !(cnp->cn_flags & WILLBEDIR)) {
760 if ((cnp->cn_flags & LOCKPARENT) == 0)
763 * We return with ni_vp NULL to indicate that the entry
764 * doesn't currently exist, leaving a pointer to the
765 * (possibly locked) directory vnode in ndp->ni_dvp.
767 if (cnp->cn_flags & SAVESTART) {
768 ndp->ni_startdir = ndp->ni_dvp;
769 VREF(ndp->ni_startdir);
773 cnp->cn_lkflags = lkflags_save;
774 #ifdef NAMEI_DIAGNOSTIC
778 * Take into account any additional components consumed by
779 * the underlying filesystem.
781 if (cnp->cn_consume > 0) {
782 cnp->cn_nameptr += cnp->cn_consume;
783 ndp->ni_next += cnp->cn_consume;
784 ndp->ni_pathlen -= cnp->cn_consume;
789 vfslocked = VFS_LOCK_GIANT(dp->v_mount);
792 * Check to see if the vnode has been mounted on;
793 * if so find the root of the mounted filesystem.
795 while (dp->v_type == VDIR && (mp = dp->v_mountedhere) &&
796 (cnp->cn_flags & NOCROSSMOUNT) == 0) {
800 VFS_UNLOCK_GIANT(vfslocked);
801 vfslocked = VFS_LOCK_GIANT(mp);
802 if (dp != ndp->ni_dvp)
806 VFS_UNLOCK_GIANT(dvfslocked);
809 ndp->ni_dvp = vp_crossmp;
810 error = VFS_ROOT(mp, compute_cn_lkflags(mp, cnp->cn_lkflags),
813 if (vn_lock(vp_crossmp, LK_SHARED | LK_NOWAIT))
814 panic("vp_crossmp exclusively locked or reclaimed");
819 ndp->ni_vp = dp = tdp;
823 * Check for symbolic link
825 if ((dp->v_type == VLNK) &&
826 ((cnp->cn_flags & FOLLOW) || (cnp->cn_flags & TRAILINGSLASH) ||
827 *ndp->ni_next == '/')) {
828 cnp->cn_flags |= ISSYMLINK;
829 if (dp->v_iflag & VI_DOOMED) {
831 * We can't know whether the directory was mounted with
832 * NOSYMFOLLOW, so we can't follow safely.
837 if (dp->v_mount->mnt_flag & MNT_NOSYMFOLLOW) {
842 * Symlink code always expects an unlocked dvp.
844 if (ndp->ni_dvp != ndp->ni_vp) {
845 VOP_UNLOCK(ndp->ni_dvp, 0);
853 * Not a symbolic link that we will follow. Continue with the
854 * next component if there is any; otherwise, we're done.
856 KASSERT((cnp->cn_flags & ISLASTCN) || *ndp->ni_next == '/',
857 ("lookup: invalid path state."));
858 if (*ndp->ni_next == '/') {
859 cnp->cn_nameptr = ndp->ni_next;
860 while (*cnp->cn_nameptr == '/') {
864 if (ndp->ni_dvp != dp)
868 VFS_UNLOCK_GIANT(dvfslocked);
869 dvfslocked = vfslocked; /* dp becomes dvp in dirloop */
874 * If we're processing a path with a trailing slash,
875 * check that the end result is a directory.
877 if ((cnp->cn_flags & TRAILINGSLASH) && dp->v_type != VDIR) {
882 * Disallow directory write attempts on read-only filesystems.
885 (cnp->cn_nameiop == DELETE || cnp->cn_nameiop == RENAME)) {
889 if (cnp->cn_flags & SAVESTART) {
890 ndp->ni_startdir = ndp->ni_dvp;
891 VREF(ndp->ni_startdir);
895 if (ndp->ni_dvp != dp)
899 VFS_UNLOCK_GIANT(dvfslocked);
901 } else if ((cnp->cn_flags & LOCKPARENT) == 0 && ndp->ni_dvp != dp) {
902 VOP_UNLOCK(ndp->ni_dvp, 0);
906 if (cnp->cn_flags & AUDITVNODE1)
907 AUDIT_ARG_VNODE1(dp);
908 else if (cnp->cn_flags & AUDITVNODE2)
909 AUDIT_ARG_VNODE2(dp);
911 if ((cnp->cn_flags & LOCKLEAF) == 0)
915 * Because of lookup_shared we may have the vnode shared locked, but
916 * the caller may want it to be exclusively locked.
918 if (needs_exclusive_leaf(dp->v_mount, cnp->cn_flags) &&
919 VOP_ISLOCKED(dp) != LK_EXCLUSIVE) {
920 vn_lock(dp, LK_UPGRADE | LK_RETRY);
921 if (dp->v_iflag & VI_DOOMED) {
926 if (vfslocked && dvfslocked)
927 VFS_UNLOCK_GIANT(dvfslocked); /* Only need one */
928 if (vfslocked || dvfslocked)
929 ndp->ni_cnd.cn_flags |= GIANTHELD;
933 if (ni_dvp_unlocked != 2) {
934 if (dp != ndp->ni_dvp && !ni_dvp_unlocked)
942 VFS_UNLOCK_GIANT(vfslocked);
943 VFS_UNLOCK_GIANT(dvfslocked);
944 ndp->ni_cnd.cn_flags &= ~GIANTHELD;
950 * relookup - lookup a path name component
951 * Used by lookup to re-acquire things.
954 relookup(struct vnode *dvp, struct vnode **vpp, struct componentname *cnp)
956 struct vnode *dp = 0; /* the directory we are searching */
957 int wantparent; /* 1 => wantparent or lockparent flag */
958 int rdonly; /* lookup read-only flag bit */
961 KASSERT(cnp->cn_flags & ISLASTCN,
962 ("relookup: Not given last component."));
964 * Setup: break out flag bits into variables.
966 wantparent = cnp->cn_flags & (LOCKPARENT|WANTPARENT);
967 KASSERT(wantparent, ("relookup: parent not wanted."));
968 rdonly = cnp->cn_flags & RDONLY;
969 cnp->cn_flags &= ~ISSYMLINK;
971 cnp->cn_lkflags = LK_EXCLUSIVE;
972 vn_lock(dp, LK_EXCLUSIVE | LK_RETRY);
975 * Search a new directory.
977 * The last component of the filename is left accessible via
978 * cnp->cn_nameptr for callers that need the name. Callers needing
979 * the name set the SAVENAME flag. When done, they assume
980 * responsibility for freeing the pathname buffer.
982 #ifdef NAMEI_DIAGNOSTIC
983 printf("{%s}: ", cnp->cn_nameptr);
987 * Check for "" which represents the root directory after slash
990 if (cnp->cn_nameptr[0] == '\0') {
992 * Support only LOOKUP for "/" because lookup()
993 * can't succeed for CREATE, DELETE and RENAME.
995 KASSERT(cnp->cn_nameiop == LOOKUP, ("nameiop must be LOOKUP"));
996 KASSERT(dp->v_type == VDIR, ("dp is not a directory"));
998 if (!(cnp->cn_flags & LOCKLEAF))
1001 /* XXX This should probably move to the top of function. */
1002 if (cnp->cn_flags & SAVESTART)
1003 panic("lookup: SAVESTART");
1007 if (cnp->cn_flags & ISDOTDOT)
1008 panic ("relookup: lookup on dot-dot");
1011 * We now have a segment name to search for, and a directory to search.
1013 #ifdef NAMEI_DIAGNOSTIC
1014 vprint("search in:", dp);
1016 if ((error = VOP_LOOKUP(dp, vpp, cnp)) != 0) {
1017 KASSERT(*vpp == NULL, ("leaf should be empty"));
1018 if (error != EJUSTRETURN)
1021 * If creating and at end of pathname, then can consider
1022 * allowing file to be created.
1028 /* ASSERT(dvp == ndp->ni_startdir) */
1029 if (cnp->cn_flags & SAVESTART)
1031 if ((cnp->cn_flags & LOCKPARENT) == 0)
1034 * We return with ni_vp NULL to indicate that the entry
1035 * doesn't currently exist, leaving a pointer to the
1036 * (possibly locked) directory vnode in ndp->ni_dvp.
1044 * Disallow directory write attempts on read-only filesystems.
1047 (cnp->cn_nameiop == DELETE || cnp->cn_nameiop == RENAME)) {
1056 * Set the parent lock/ref state to the requested state.
1058 if ((cnp->cn_flags & LOCKPARENT) == 0 && dvp != dp) {
1063 } else if (!wantparent)
1066 * Check for symbolic link
1068 KASSERT(dp->v_type != VLNK || !(cnp->cn_flags & FOLLOW),
1069 ("relookup: symlink found.\n"));
1071 /* ASSERT(dvp == ndp->ni_startdir) */
1072 if (cnp->cn_flags & SAVESTART)
1075 if ((cnp->cn_flags & LOCKLEAF) == 0)
1085 * Free data allocated by namei(); see namei(9) for details.
1088 NDFREE(struct nameidata *ndp, const u_int flags)
1096 if (!(flags & NDF_NO_FREE_PNBUF) &&
1097 (ndp->ni_cnd.cn_flags & HASBUF)) {
1098 uma_zfree(namei_zone, ndp->ni_cnd.cn_pnbuf);
1099 ndp->ni_cnd.cn_flags &= ~HASBUF;
1101 if (!(flags & NDF_NO_VP_UNLOCK) &&
1102 (ndp->ni_cnd.cn_flags & LOCKLEAF) && ndp->ni_vp)
1104 if (!(flags & NDF_NO_VP_RELE) && ndp->ni_vp) {
1113 VOP_UNLOCK(ndp->ni_vp, 0);
1114 if (!(flags & NDF_NO_DVP_UNLOCK) &&
1115 (ndp->ni_cnd.cn_flags & LOCKPARENT) &&
1116 ndp->ni_dvp != ndp->ni_vp)
1118 if (!(flags & NDF_NO_DVP_RELE) &&
1119 (ndp->ni_cnd.cn_flags & (LOCKPARENT|WANTPARENT))) {
1128 VOP_UNLOCK(ndp->ni_dvp, 0);
1129 if (!(flags & NDF_NO_STARTDIR_RELE) &&
1130 (ndp->ni_cnd.cn_flags & SAVESTART)) {
1131 vrele(ndp->ni_startdir);
1132 ndp->ni_startdir = NULL;
1137 * Determine if there is a suitable alternate filename under the specified
1138 * prefix for the specified path. If the create flag is set, then the
1139 * alternate prefix will be used so long as the parent directory exists.
1140 * This is used by the various compatiblity ABIs so that Linux binaries prefer
1141 * files under /compat/linux for example. The chosen path (whether under
1142 * the prefix or under /) is returned in a kernel malloc'd buffer pointed
1143 * to by pathbuf. The caller is responsible for free'ing the buffer from
1144 * the M_TEMP bucket if one is returned.
1147 kern_alternate_path(struct thread *td, const char *prefix, const char *path,
1148 enum uio_seg pathseg, char **pathbuf, int create, int dirfd)
1150 struct nameidata nd, ndroot;
1151 char *ptr, *buf, *cp;
1155 buf = (char *) malloc(MAXPATHLEN, M_TEMP, M_WAITOK);
1158 /* Copy the prefix into the new pathname as a starting point. */
1159 len = strlcpy(buf, prefix, MAXPATHLEN);
1160 if (len >= MAXPATHLEN) {
1165 sz = MAXPATHLEN - len;
1168 /* Append the filename to the prefix. */
1169 if (pathseg == UIO_SYSSPACE)
1170 error = copystr(path, ptr, sz, &len);
1172 error = copyinstr(path, ptr, sz, &len);
1180 /* Only use a prefix with absolute pathnames. */
1186 if (dirfd != AT_FDCWD) {
1188 * We want the original because the "prefix" is
1189 * included in the already opened dirfd.
1191 bcopy(ptr, buf, len);
1196 * We know that there is a / somewhere in this pathname.
1197 * Search backwards for it, to find the file's parent dir
1198 * to see if it exists in the alternate tree. If it does,
1199 * and we want to create a file (cflag is set). We don't
1200 * need to worry about the root comparison in this case.
1204 for (cp = &ptr[len] - 1; *cp != '/'; cp--);
1207 NDINIT(&nd, LOOKUP, FOLLOW | MPSAFE, UIO_SYSSPACE, buf, td);
1213 NDINIT(&nd, LOOKUP, FOLLOW | MPSAFE, UIO_SYSSPACE, buf, td);
1220 * We now compare the vnode of the prefix to the one
1221 * vnode asked. If they resolve to be the same, then we
1222 * ignore the match so that the real root gets used.
1223 * This avoids the problem of traversing "../.." to find the
1224 * root directory and never finding it, because "/" resolves
1225 * to the emulation root directory. This is expensive :-(
1227 NDINIT(&ndroot, LOOKUP, FOLLOW | MPSAFE, UIO_SYSSPACE, prefix,
1230 /* We shouldn't ever get an error from this namei(). */
1231 error = namei(&ndroot);
1233 if (nd.ni_vp == ndroot.ni_vp)
1236 NDFREE(&ndroot, NDF_ONLY_PNBUF);
1237 vrele(ndroot.ni_vp);
1238 VFS_UNLOCK_GIANT(NDHASGIANT(&ndroot));
1242 NDFREE(&nd, NDF_ONLY_PNBUF);
1244 VFS_UNLOCK_GIANT(NDHASGIANT(&nd));
1247 /* If there was an error, use the original path name. */
1249 bcopy(ptr, buf, len);