Home | History | Annotate | Line # | Download | only in kern
vfs_lookup.c revision 1.186
      1 /*	$NetBSD: vfs_lookup.c,v 1.186 2011/08/09 23:16:17 dholland Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 1982, 1986, 1989, 1993
      5  *	The Regents of the University of California.  All rights reserved.
      6  * (c) UNIX System Laboratories, Inc.
      7  * All or some portions of this file are derived from material licensed
      8  * to the University of California by American Telephone and Telegraph
      9  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
     10  * the permission of UNIX System Laboratories, Inc.
     11  *
     12  * Redistribution and use in source and binary forms, with or without
     13  * modification, are permitted provided that the following conditions
     14  * are met:
     15  * 1. Redistributions of source code must retain the above copyright
     16  *    notice, this list of conditions and the following disclaimer.
     17  * 2. Redistributions in binary form must reproduce the above copyright
     18  *    notice, this list of conditions and the following disclaimer in the
     19  *    documentation and/or other materials provided with the distribution.
     20  * 3. Neither the name of the University nor the names of its contributors
     21  *    may be used to endorse or promote products derived from this software
     22  *    without specific prior written permission.
     23  *
     24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     34  * SUCH DAMAGE.
     35  *
     36  *	@(#)vfs_lookup.c	8.10 (Berkeley) 5/27/95
     37  */
     38 
     39 #include <sys/cdefs.h>
     40 __KERNEL_RCSID(0, "$NetBSD: vfs_lookup.c,v 1.186 2011/08/09 23:16:17 dholland Exp $");
     41 
     42 #include "opt_magiclinks.h"
     43 
     44 #include <sys/param.h>
     45 #include <sys/systm.h>
     46 #include <sys/kernel.h>
     47 #include <sys/syslimits.h>
     48 #include <sys/time.h>
     49 #include <sys/namei.h>
     50 #include <sys/vnode.h>
     51 #include <sys/mount.h>
     52 #include <sys/errno.h>
     53 #include <sys/filedesc.h>
     54 #include <sys/hash.h>
     55 #include <sys/proc.h>
     56 #include <sys/syslog.h>
     57 #include <sys/kauth.h>
     58 #include <sys/ktrace.h>
     59 
     60 #ifndef MAGICLINKS
     61 #define MAGICLINKS 0
     62 #endif
     63 
     64 int vfs_magiclinks = MAGICLINKS;
     65 
     66 /*
     67  * Substitute replacement text for 'magic' strings in symlinks.
     68  * Returns 0 if successful, and returns non-zero if an error
     69  * occurs.  (Currently, the only possible error is running out
     70  * of temporary pathname space.)
     71  *
     72  * Looks for "@<string>" and "@<string>/", where <string> is a
     73  * recognized 'magic' string.  Replaces the "@<string>" with the
     74  * appropriate replacement text.  (Note that in some cases the
     75  * replacement text may have zero length.)
     76  *
     77  * This would have been table driven, but the variance in
     78  * replacement strings (and replacement string lengths) made
     79  * that impractical.
     80  */
     81 #define	VNL(x)							\
     82 	(sizeof(x) - 1)
     83 
     84 #define	VO	'{'
     85 #define	VC	'}'
     86 
     87 #define	MATCH(str)						\
     88 	((termchar == '/' && i + VNL(str) == *len) ||		\
     89 	 (i + VNL(str) < *len &&				\
     90 	  cp[i + VNL(str)] == termchar)) &&			\
     91 	!strncmp((str), &cp[i], VNL(str))
     92 
     93 #define	SUBSTITUTE(m, s, sl)					\
     94 	if ((newlen + (sl)) >= MAXPATHLEN)			\
     95 		return 1;					\
     96 	i += VNL(m);						\
     97 	if (termchar != '/')					\
     98 		i++;						\
     99 	(void)memcpy(&tmp[newlen], (s), (sl));			\
    100 	newlen += (sl);						\
    101 	change = 1;						\
    102 	termchar = '/';
    103 
    104 static int
    105 symlink_magic(struct proc *p, char *cp, size_t *len)
    106 {
    107 	char *tmp;
    108 	size_t change, i, newlen, slen;
    109 	char termchar = '/';
    110 	char idtmp[11]; /* enough for 32 bit *unsigned* integer */
    111 
    112 
    113 	tmp = PNBUF_GET();
    114 	for (change = i = newlen = 0; i < *len; ) {
    115 		if (cp[i] != '@') {
    116 			tmp[newlen++] = cp[i++];
    117 			continue;
    118 		}
    119 
    120 		i++;
    121 
    122 		/* Check for @{var} syntax. */
    123 		if (cp[i] == VO) {
    124 			termchar = VC;
    125 			i++;
    126 		}
    127 
    128 		/*
    129 		 * The following checks should be ordered according
    130 		 * to frequency of use.
    131 		 */
    132 		if (MATCH("machine_arch")) {
    133 			slen = VNL(MACHINE_ARCH);
    134 			SUBSTITUTE("machine_arch", MACHINE_ARCH, slen);
    135 		} else if (MATCH("machine")) {
    136 			slen = VNL(MACHINE);
    137 			SUBSTITUTE("machine", MACHINE, slen);
    138 		} else if (MATCH("hostname")) {
    139 			SUBSTITUTE("hostname", hostname, hostnamelen);
    140 		} else if (MATCH("osrelease")) {
    141 			slen = strlen(osrelease);
    142 			SUBSTITUTE("osrelease", osrelease, slen);
    143 		} else if (MATCH("emul")) {
    144 			slen = strlen(p->p_emul->e_name);
    145 			SUBSTITUTE("emul", p->p_emul->e_name, slen);
    146 		} else if (MATCH("kernel_ident")) {
    147 			slen = strlen(kernel_ident);
    148 			SUBSTITUTE("kernel_ident", kernel_ident, slen);
    149 		} else if (MATCH("domainname")) {
    150 			SUBSTITUTE("domainname", domainname, domainnamelen);
    151 		} else if (MATCH("ostype")) {
    152 			slen = strlen(ostype);
    153 			SUBSTITUTE("ostype", ostype, slen);
    154 		} else if (MATCH("uid")) {
    155 			slen = snprintf(idtmp, sizeof(idtmp), "%u",
    156 			    kauth_cred_geteuid(kauth_cred_get()));
    157 			SUBSTITUTE("uid", idtmp, slen);
    158 		} else if (MATCH("ruid")) {
    159 			slen = snprintf(idtmp, sizeof(idtmp), "%u",
    160 			    kauth_cred_getuid(kauth_cred_get()));
    161 			SUBSTITUTE("ruid", idtmp, slen);
    162 		} else if (MATCH("gid")) {
    163 			slen = snprintf(idtmp, sizeof(idtmp), "%u",
    164 			    kauth_cred_getegid(kauth_cred_get()));
    165 			SUBSTITUTE("gid", idtmp, slen);
    166 		} else if (MATCH("rgid")) {
    167 			slen = snprintf(idtmp, sizeof(idtmp), "%u",
    168 			    kauth_cred_getgid(kauth_cred_get()));
    169 			SUBSTITUTE("rgid", idtmp, slen);
    170 		} else {
    171 			tmp[newlen++] = '@';
    172 			if (termchar == VC)
    173 				tmp[newlen++] = VO;
    174 		}
    175 	}
    176 
    177 	if (change) {
    178 		(void)memcpy(cp, tmp, newlen);
    179 		*len = newlen;
    180 	}
    181 	PNBUF_PUT(tmp);
    182 
    183 	return 0;
    184 }
    185 
    186 #undef VNL
    187 #undef VO
    188 #undef VC
    189 #undef MATCH
    190 #undef SUBSTITUTE
    191 
    192 ////////////////////////////////////////////////////////////
    193 
    194 /*
    195  * Determine the namei hash (for cn_hash) for name.
    196  * If *ep != NULL, hash from name to ep-1.
    197  * If *ep == NULL, hash from name until the first NUL or '/', and
    198  * return the location of this termination character in *ep.
    199  *
    200  * This function returns an equivalent hash to the MI hash32_strn().
    201  * The latter isn't used because in the *ep == NULL case, determining
    202  * the length of the string to the first NUL or `/' and then calling
    203  * hash32_strn() involves unnecessary double-handling of the data.
    204  */
    205 uint32_t
    206 namei_hash(const char *name, const char **ep)
    207 {
    208 	uint32_t	hash;
    209 
    210 	hash = HASH32_STR_INIT;
    211 	if (*ep != NULL) {
    212 		for (; name < *ep; name++)
    213 			hash = hash * 33 + *(const uint8_t *)name;
    214 	} else {
    215 		for (; *name != '\0' && *name != '/'; name++)
    216 			hash = hash * 33 + *(const uint8_t *)name;
    217 		*ep = name;
    218 	}
    219 	return (hash + (hash >> 5));
    220 }
    221 
    222 ////////////////////////////////////////////////////////////
    223 
    224 /*
    225  * Sealed abstraction for pathnames.
    226  *
    227  * System-call-layer level code that is going to call namei should
    228  * first create a pathbuf and adjust all the bells and whistles on it
    229  * as needed by context.
    230  */
    231 
    232 struct pathbuf {
    233 	char *pb_path;
    234 	char *pb_pathcopy;
    235 	unsigned pb_pathcopyuses;
    236 };
    237 
    238 static struct pathbuf *
    239 pathbuf_create_raw(void)
    240 {
    241 	struct pathbuf *pb;
    242 
    243 	pb = kmem_alloc(sizeof(*pb), KM_SLEEP);
    244 	if (pb == NULL) {
    245 		return NULL;
    246 	}
    247 	pb->pb_path = PNBUF_GET();
    248 	if (pb->pb_path == NULL) {
    249 		kmem_free(pb, sizeof(*pb));
    250 		return NULL;
    251 	}
    252 	pb->pb_pathcopy = NULL;
    253 	pb->pb_pathcopyuses = 0;
    254 	return pb;
    255 }
    256 
    257 void
    258 pathbuf_destroy(struct pathbuf *pb)
    259 {
    260 	KASSERT(pb->pb_pathcopyuses == 0);
    261 	KASSERT(pb->pb_pathcopy == NULL);
    262 	PNBUF_PUT(pb->pb_path);
    263 	kmem_free(pb, sizeof(*pb));
    264 }
    265 
    266 struct pathbuf *
    267 pathbuf_assimilate(char *pnbuf)
    268 {
    269 	struct pathbuf *pb;
    270 
    271 	pb = kmem_alloc(sizeof(*pb), KM_SLEEP);
    272 	if (pb == NULL) {
    273 		return NULL;
    274 	}
    275 	pb->pb_path = pnbuf;
    276 	pb->pb_pathcopy = NULL;
    277 	pb->pb_pathcopyuses = 0;
    278 	return pb;
    279 }
    280 
    281 struct pathbuf *
    282 pathbuf_create(const char *path)
    283 {
    284 	struct pathbuf *pb;
    285 	int error;
    286 
    287 	pb = pathbuf_create_raw();
    288 	if (pb == NULL) {
    289 		return NULL;
    290 	}
    291 	error = copystr(path, pb->pb_path, PATH_MAX, NULL);
    292 	if (error != 0) {
    293 		KASSERT(!"kernel path too long in pathbuf_create");
    294 		/* make sure it's null-terminated, just in case */
    295 		pb->pb_path[PATH_MAX-1] = '\0';
    296 	}
    297 	return pb;
    298 }
    299 
    300 int
    301 pathbuf_copyin(const char *userpath, struct pathbuf **ret)
    302 {
    303 	struct pathbuf *pb;
    304 	int error;
    305 
    306 	pb = pathbuf_create_raw();
    307 	if (pb == NULL) {
    308 		return ENOMEM;
    309 	}
    310 	error = copyinstr(userpath, pb->pb_path, PATH_MAX, NULL);
    311 	if (error) {
    312 		pathbuf_destroy(pb);
    313 		return error;
    314 	}
    315 	*ret = pb;
    316 	return 0;
    317 }
    318 
    319 /*
    320  * XXX should not exist:
    321  *   1. whether a pointer is kernel or user should be statically checkable.
    322  *   2. copyin should be handled by the upper part of the syscall layer,
    323  *      not in here.
    324  */
    325 int
    326 pathbuf_maybe_copyin(const char *path, enum uio_seg seg, struct pathbuf **ret)
    327 {
    328 	if (seg == UIO_USERSPACE) {
    329 		return pathbuf_copyin(path, ret);
    330 	} else {
    331 		*ret = pathbuf_create(path);
    332 		if (*ret == NULL) {
    333 			return ENOMEM;
    334 		}
    335 		return 0;
    336 	}
    337 }
    338 
    339 /*
    340  * Get a copy of the path buffer as it currently exists. If this is
    341  * called after namei starts the results may be arbitrary.
    342  */
    343 void
    344 pathbuf_copystring(const struct pathbuf *pb, char *buf, size_t maxlen)
    345 {
    346 	strlcpy(buf, pb->pb_path, maxlen);
    347 }
    348 
    349 /*
    350  * These two functions allow access to a saved copy of the original
    351  * path string. The first copy should be gotten before namei is
    352  * called. Each copy that is gotten should be put back.
    353  */
    354 
    355 const char *
    356 pathbuf_stringcopy_get(struct pathbuf *pb)
    357 {
    358 	if (pb->pb_pathcopyuses == 0) {
    359 		pb->pb_pathcopy = PNBUF_GET();
    360 		strcpy(pb->pb_pathcopy, pb->pb_path);
    361 	}
    362 	pb->pb_pathcopyuses++;
    363 	return pb->pb_pathcopy;
    364 }
    365 
    366 void
    367 pathbuf_stringcopy_put(struct pathbuf *pb, const char *str)
    368 {
    369 	KASSERT(str == pb->pb_pathcopy);
    370 	KASSERT(pb->pb_pathcopyuses > 0);
    371 	pb->pb_pathcopyuses--;
    372 	if (pb->pb_pathcopyuses == 0) {
    373 		PNBUF_PUT(pb->pb_pathcopy);
    374 		pb->pb_pathcopy = NULL;
    375 	}
    376 }
    377 
    378 
    379 ////////////////////////////////////////////////////////////
    380 
    381 /*
    382  * namei: convert a pathname into a pointer to a (maybe-locked) vnode,
    383  * and maybe also its parent directory vnode, and assorted other guff.
    384  * See namei(9) for the interface documentation.
    385  *
    386  *
    387  * The FOLLOW flag is set when symbolic links are to be followed
    388  * when they occur at the end of the name translation process.
    389  * Symbolic links are always followed for all other pathname
    390  * components other than the last.
    391  *
    392  * The segflg defines whether the name is to be copied from user
    393  * space or kernel space.
    394  *
    395  * Overall outline of namei:
    396  *
    397  *	copy in name
    398  *	get starting directory
    399  *	while (!done && !error) {
    400  *		call lookup to search path.
    401  *		if symbolic link, massage name in buffer and continue
    402  *	}
    403  */
    404 
    405 /*
    406  * Search a pathname.
    407  * This is a very central and rather complicated routine.
    408  *
    409  * The pathname is pointed to by ni_ptr and is of length ni_pathlen.
    410  * The starting directory is passed in. The pathname is descended
    411  * until done, or a symbolic link is encountered. The variable ni_more
    412  * is clear if the path is completed; it is set to one if a symbolic
    413  * link needing interpretation is encountered.
    414  *
    415  * The flag argument is LOOKUP, CREATE, RENAME, or DELETE depending on
    416  * whether the name is to be looked up, created, renamed, or deleted.
    417  * When CREATE, RENAME, or DELETE is specified, information usable in
    418  * creating, renaming, or deleting a directory entry may be calculated.
    419  * If flag has LOCKPARENT or'ed into it, the parent directory is returned
    420  * locked.  Otherwise the parent directory is not returned. If the target
    421  * of the pathname exists and LOCKLEAF is or'ed into the flag the target
    422  * is returned locked, otherwise it is returned unlocked.  When creating
    423  * or renaming and LOCKPARENT is specified, the target may not be ".".
    424  * When deleting and LOCKPARENT is specified, the target may be ".".
    425  *
    426  * Overall outline of lookup:
    427  *
    428  * dirloop:
    429  *	identify next component of name at ndp->ni_ptr
    430  *	handle degenerate case where name is null string
    431  *	if .. and crossing mount points and on mounted filesys, find parent
    432  *	call VOP_LOOKUP routine for next component name
    433  *	    directory vnode returned in ni_dvp, locked.
    434  *	    component vnode returned in ni_vp (if it exists), locked.
    435  *	if result vnode is mounted on and crossing mount points,
    436  *	    find mounted on vnode
    437  *	if more components of name, do next level at dirloop
    438  *	return the answer in ni_vp, locked if LOCKLEAF set
    439  *	    if LOCKPARENT set, return locked parent in ni_dvp
    440  */
    441 
    442 
    443 /*
    444  * Internal state for a namei operation.
    445  *
    446  * cnp is always equal to &ndp->ni_cnp.
    447  */
    448 struct namei_state {
    449 	struct nameidata *ndp;
    450 	struct componentname *cnp;
    451 
    452 	int docache;			/* == 0 do not cache last component */
    453 	int rdonly;			/* lookup read-only flag bit */
    454 	int slashes;
    455 
    456 	unsigned attempt_retry:1;	/* true if error allows emul retry */
    457 };
    458 
    459 
    460 /*
    461  * Initialize the namei working state.
    462  */
    463 static void
    464 namei_init(struct namei_state *state, struct nameidata *ndp)
    465 {
    466 	state->ndp = ndp;
    467 	state->cnp = &ndp->ni_cnd;
    468 	KASSERT((state->cnp->cn_flags & INRELOOKUP) == 0);
    469 
    470 	state->docache = 0;
    471 	state->rdonly = 0;
    472 	state->slashes = 0;
    473 
    474 #ifdef DIAGNOSTIC
    475 	if (!state->cnp->cn_cred)
    476 		panic("namei: bad cred/proc");
    477 	if (state->cnp->cn_nameiop & (~OPMASK))
    478 		panic("namei: nameiop contaminated with flags");
    479 	if (state->cnp->cn_flags & OPMASK)
    480 		panic("namei: flags contaminated with nameiops");
    481 #endif
    482 
    483 	/*
    484 	 * The buffer for name translation shall be the one inside the
    485 	 * pathbuf.
    486 	 */
    487 	state->ndp->ni_pnbuf = state->ndp->ni_pathbuf->pb_path;
    488 }
    489 
    490 /*
    491  * Clean up the working namei state, leaving things ready for return
    492  * from namei.
    493  */
    494 static void
    495 namei_cleanup(struct namei_state *state)
    496 {
    497 	KASSERT(state->cnp == &state->ndp->ni_cnd);
    498 
    499 	/* nothing for now */
    500 	(void)state;
    501 }
    502 
    503 //////////////////////////////
    504 
    505 /*
    506  * Get the directory context.
    507  * Initializes the rootdir and erootdir state and returns a reference
    508  * to the starting dir.
    509  */
    510 static struct vnode *
    511 namei_getstartdir(struct namei_state *state)
    512 {
    513 	struct nameidata *ndp = state->ndp;
    514 	struct componentname *cnp = state->cnp;
    515 	struct cwdinfo *cwdi;		/* pointer to cwd state */
    516 	struct lwp *self = curlwp;	/* thread doing namei() */
    517 	struct vnode *rootdir, *erootdir, *curdir, *startdir;
    518 
    519 	cwdi = self->l_proc->p_cwdi;
    520 	rw_enter(&cwdi->cwdi_lock, RW_READER);
    521 
    522 	/* root dir */
    523 	if (cwdi->cwdi_rdir == NULL || (cnp->cn_flags & NOCHROOT)) {
    524 		rootdir = rootvnode;
    525 	} else {
    526 		rootdir = cwdi->cwdi_rdir;
    527 	}
    528 
    529 	/* emulation root dir, if any */
    530 	if ((cnp->cn_flags & TRYEMULROOT) == 0) {
    531 		/* if we don't want it, don't fetch it */
    532 		erootdir = NULL;
    533 	} else if (cnp->cn_flags & EMULROOTSET) {
    534 		/* explicitly set emulroot; "/../" doesn't override this */
    535 		erootdir = ndp->ni_erootdir;
    536 	} else if (!strncmp(ndp->ni_pnbuf, "/../", 4)) {
    537 		/* explicit reference to real rootdir */
    538 		erootdir = NULL;
    539 	} else {
    540 		/* may be null */
    541 		erootdir = cwdi->cwdi_edir;
    542 	}
    543 
    544 	/* current dir */
    545 	curdir = cwdi->cwdi_cdir;
    546 
    547 	if (ndp->ni_pnbuf[0] != '/') {
    548 		startdir = curdir;
    549 		erootdir = NULL;
    550 	} else if (cnp->cn_flags & TRYEMULROOT && erootdir != NULL) {
    551 		startdir = erootdir;
    552 	} else {
    553 		startdir = rootdir;
    554 		erootdir = NULL;
    555 	}
    556 
    557 	state->ndp->ni_rootdir = rootdir;
    558 	state->ndp->ni_erootdir = erootdir;
    559 
    560 	/*
    561 	 * Get a reference to the start dir so we can safely unlock cwdi.
    562 	 *
    563 	 * XXX: should we hold references to rootdir and erootdir while
    564 	 * we're running? What happens if a multithreaded process chroots
    565 	 * during namei?
    566 	 */
    567 	vref(startdir);
    568 
    569 	rw_exit(&cwdi->cwdi_lock);
    570 	return startdir;
    571 }
    572 
    573 /*
    574  * Get the directory context for the nfsd case, in parallel to
    575  * getstartdir. Initializes the rootdir and erootdir state and
    576  * returns a reference to the passed-in starting dir.
    577  */
    578 static struct vnode *
    579 namei_getstartdir_for_nfsd(struct namei_state *state, struct vnode *startdir)
    580 {
    581 	/* always use the real root, and never set an emulation root */
    582 	state->ndp->ni_rootdir = rootvnode;
    583 	state->ndp->ni_erootdir = NULL;
    584 
    585 	vref(startdir);
    586 	return startdir;
    587 }
    588 
    589 
    590 /*
    591  * Ktrace the namei operation.
    592  */
    593 static void
    594 namei_ktrace(struct namei_state *state)
    595 {
    596 	struct nameidata *ndp = state->ndp;
    597 	struct componentname *cnp = state->cnp;
    598 	struct lwp *self = curlwp;	/* thread doing namei() */
    599 	const char *emul_path;
    600 
    601 	if (ktrpoint(KTR_NAMEI)) {
    602 		if (ndp->ni_erootdir != NULL) {
    603 			/*
    604 			 * To make any sense, the trace entry need to have the
    605 			 * text of the emulation path prepended.
    606 			 * Usually we can get this from the current process,
    607 			 * but when called from emul_find_interp() it is only
    608 			 * in the exec_package - so we get it passed in ni_next
    609 			 * (this is a hack).
    610 			 */
    611 			if (cnp->cn_flags & EMULROOTSET)
    612 				emul_path = ndp->ni_next;
    613 			else
    614 				emul_path = self->l_proc->p_emul->e_path;
    615 			ktrnamei2(emul_path, strlen(emul_path),
    616 			    ndp->ni_pnbuf, ndp->ni_pathlen);
    617 		} else
    618 			ktrnamei(ndp->ni_pnbuf, ndp->ni_pathlen);
    619 	}
    620 }
    621 
    622 /*
    623  * Start up namei. Find the root dir and cwd, establish the starting
    624  * directory for lookup, and lock it. Also calls ktrace when
    625  * appropriate.
    626  */
    627 static int
    628 namei_start(struct namei_state *state, struct vnode *forcecwd,
    629 	    struct vnode **startdir_ret)
    630 {
    631 	struct nameidata *ndp = state->ndp;
    632 	struct vnode *startdir;
    633 
    634 	/* length includes null terminator (was originally from copyinstr) */
    635 	ndp->ni_pathlen = strlen(ndp->ni_pnbuf) + 1;
    636 
    637 	/*
    638 	 * POSIX.1 requirement: "" is not a valid file name.
    639 	 */
    640 	if (ndp->ni_pathlen == 1) {
    641 		return ENOENT;
    642 	}
    643 
    644 	ndp->ni_loopcnt = 0;
    645 
    646 	/* Get starting directory, set up root, and ktrace. */
    647 	if (forcecwd != NULL) {
    648 		startdir = namei_getstartdir_for_nfsd(state, forcecwd);
    649 		/* no ktrace */
    650 	} else {
    651 		startdir = namei_getstartdir(state);
    652 		namei_ktrace(state);
    653 	}
    654 
    655 	vn_lock(startdir, LK_EXCLUSIVE | LK_RETRY);
    656 
    657 	*startdir_ret = startdir;
    658 	return 0;
    659 }
    660 
    661 /*
    662  * Check for being at a symlink that we're going to follow.
    663  */
    664 static inline int
    665 namei_atsymlink(struct namei_state *state, struct vnode *foundobj)
    666 {
    667 	return (foundobj->v_type == VLNK) &&
    668 		(state->cnp->cn_flags & (FOLLOW|REQUIREDIR));
    669 }
    670 
    671 /*
    672  * Follow a symlink.
    673  *
    674  * Updates searchdir. inhibitmagic causes magic symlinks to not be
    675  * interpreted; this is used by nfsd.
    676  *
    677  * Unlocks foundobj on success (ugh)
    678  */
    679 static inline int
    680 namei_follow(struct namei_state *state, int inhibitmagic,
    681 	     struct vnode *searchdir, struct vnode *foundobj,
    682 	     struct vnode **newsearchdir_ret)
    683 {
    684 	struct nameidata *ndp = state->ndp;
    685 	struct componentname *cnp = state->cnp;
    686 
    687 	struct lwp *self = curlwp;	/* thread doing namei() */
    688 	struct iovec aiov;		/* uio for reading symbolic links */
    689 	struct uio auio;
    690 	char *cp;			/* pointer into pathname argument */
    691 	size_t linklen;
    692 	int error;
    693 
    694 	KASSERT(VOP_ISLOCKED(searchdir) == LK_EXCLUSIVE);
    695 	KASSERT(VOP_ISLOCKED(foundobj) == LK_EXCLUSIVE);
    696 	if (ndp->ni_loopcnt++ >= MAXSYMLINKS) {
    697 		return ELOOP;
    698 	}
    699 	if (foundobj->v_mount->mnt_flag & MNT_SYMPERM) {
    700 		error = VOP_ACCESS(foundobj, VEXEC, cnp->cn_cred);
    701 		if (error != 0)
    702 			return error;
    703 	}
    704 
    705 	/* FUTURE: fix this to not use a second buffer */
    706 	cp = PNBUF_GET();
    707 	aiov.iov_base = cp;
    708 	aiov.iov_len = MAXPATHLEN;
    709 	auio.uio_iov = &aiov;
    710 	auio.uio_iovcnt = 1;
    711 	auio.uio_offset = 0;
    712 	auio.uio_rw = UIO_READ;
    713 	auio.uio_resid = MAXPATHLEN;
    714 	UIO_SETUP_SYSSPACE(&auio);
    715 	error = VOP_READLINK(foundobj, &auio, cnp->cn_cred);
    716 	if (error) {
    717 		PNBUF_PUT(cp);
    718 		return error;
    719 	}
    720 	linklen = MAXPATHLEN - auio.uio_resid;
    721 	if (linklen == 0) {
    722 		PNBUF_PUT(cp);
    723 		return ENOENT;
    724 	}
    725 
    726 	/*
    727 	 * Do symlink substitution, if appropriate, and
    728 	 * check length for potential overflow.
    729 	 *
    730 	 * Inhibit symlink substitution for nfsd.
    731 	 * XXX: This is how it was before; is that a bug or a feature?
    732 	 */
    733 	if ((!inhibitmagic && vfs_magiclinks &&
    734 	     symlink_magic(self->l_proc, cp, &linklen)) ||
    735 	    (linklen + ndp->ni_pathlen >= MAXPATHLEN)) {
    736 		PNBUF_PUT(cp);
    737 		return ENAMETOOLONG;
    738 	}
    739 	if (ndp->ni_pathlen > 1) {
    740 		/* includes a null-terminator */
    741 		memcpy(cp + linklen, ndp->ni_next, ndp->ni_pathlen);
    742 	} else {
    743 		cp[linklen] = '\0';
    744 	}
    745 	ndp->ni_pathlen += linklen;
    746 	memcpy(ndp->ni_pnbuf, cp, ndp->ni_pathlen);
    747 	PNBUF_PUT(cp);
    748 
    749 	/* we're now starting from the beginning of the buffer again */
    750 	cnp->cn_nameptr = ndp->ni_pnbuf;
    751 
    752 	/* must unlock this before relocking searchdir */
    753 	VOP_UNLOCK(foundobj);
    754 
    755 	/*
    756 	 * Check if root directory should replace current directory.
    757 	 */
    758 	if (ndp->ni_pnbuf[0] == '/') {
    759 		vput(searchdir);
    760 		/* Keep absolute symbolic links inside emulation root */
    761 		searchdir = ndp->ni_erootdir;
    762 		if (searchdir == NULL ||
    763 		    (ndp->ni_pnbuf[1] == '.'
    764 		     && ndp->ni_pnbuf[2] == '.'
    765 		     && ndp->ni_pnbuf[3] == '/')) {
    766 			ndp->ni_erootdir = NULL;
    767 			searchdir = ndp->ni_rootdir;
    768 		}
    769 		vref(searchdir);
    770 		vn_lock(searchdir, LK_EXCLUSIVE | LK_RETRY);
    771 		while (cnp->cn_nameptr[0] == '/') {
    772 			cnp->cn_nameptr++;
    773 			ndp->ni_pathlen--;
    774 		}
    775 	}
    776 
    777 	*newsearchdir_ret = searchdir;
    778 	KASSERT(VOP_ISLOCKED(searchdir) == LK_EXCLUSIVE);
    779 	return 0;
    780 }
    781 
    782 //////////////////////////////
    783 
    784 /*
    785  * Inspect the leading path component and update the state accordingly.
    786  */
    787 static int
    788 lookup_parsepath(struct namei_state *state)
    789 {
    790 	const char *cp;			/* pointer into pathname argument */
    791 
    792 	struct componentname *cnp = state->cnp;
    793 	struct nameidata *ndp = state->ndp;
    794 
    795 	KASSERT(cnp == &ndp->ni_cnd);
    796 
    797 	/*
    798 	 * Search a new directory.
    799 	 *
    800 	 * The cn_hash value is for use by vfs_cache.
    801 	 * The last component of the filename is left accessible via
    802 	 * cnp->cn_nameptr for callers that need the name. Callers needing
    803 	 * the name set the SAVENAME flag. When done, they assume
    804 	 * responsibility for freeing the pathname buffer.
    805 	 *
    806 	 * At this point, our only vnode state is that the search dir
    807 	 * is held and locked.
    808 	 */
    809 	cnp->cn_consume = 0;
    810 	cp = NULL;
    811 	cnp->cn_hash = namei_hash(cnp->cn_nameptr, &cp);
    812 	cnp->cn_namelen = cp - cnp->cn_nameptr;
    813 	if (cnp->cn_namelen > NAME_MAX) {
    814 		return ENAMETOOLONG;
    815 	}
    816 #ifdef NAMEI_DIAGNOSTIC
    817 	{ char c = *cp;
    818 	*(char *)cp = '\0';
    819 	printf("{%s}: ", cnp->cn_nameptr);
    820 	*(char *)cp = c; }
    821 #endif /* NAMEI_DIAGNOSTIC */
    822 	ndp->ni_pathlen -= cnp->cn_namelen;
    823 	ndp->ni_next = cp;
    824 	/*
    825 	 * If this component is followed by a slash, then move the pointer to
    826 	 * the next component forward, and remember that this component must be
    827 	 * a directory.
    828 	 */
    829 	if (*cp == '/') {
    830 		do {
    831 			cp++;
    832 		} while (*cp == '/');
    833 		state->slashes = cp - ndp->ni_next;
    834 		ndp->ni_pathlen -= state->slashes;
    835 		ndp->ni_next = cp;
    836 		cnp->cn_flags |= REQUIREDIR;
    837 	} else {
    838 		state->slashes = 0;
    839 		cnp->cn_flags &= ~REQUIREDIR;
    840 	}
    841 	/*
    842 	 * We do special processing on the last component, whether or not it's
    843 	 * a directory.  Cache all intervening lookups, but not the final one.
    844 	 */
    845 	if (*cp == '\0') {
    846 		if (state->docache)
    847 			cnp->cn_flags |= MAKEENTRY;
    848 		else
    849 			cnp->cn_flags &= ~MAKEENTRY;
    850 		cnp->cn_flags |= ISLASTCN;
    851 	} else {
    852 		cnp->cn_flags |= MAKEENTRY;
    853 		cnp->cn_flags &= ~ISLASTCN;
    854 	}
    855 	if (cnp->cn_namelen == 2 &&
    856 	    cnp->cn_nameptr[1] == '.' && cnp->cn_nameptr[0] == '.')
    857 		cnp->cn_flags |= ISDOTDOT;
    858 	else
    859 		cnp->cn_flags &= ~ISDOTDOT;
    860 
    861 	return 0;
    862 }
    863 
    864 /*
    865  * Call VOP_LOOKUP for a single lookup; return a new search directory
    866  * (used when crossing mountpoints up or searching union mounts down) and
    867  * the found object, which for create operations may be NULL on success.
    868  */
    869 static int
    870 lookup_once(struct namei_state *state,
    871 	    struct vnode *searchdir,
    872 	    struct vnode **newsearchdir_ret,
    873 	    struct vnode **foundobj_ret)
    874 {
    875 	struct vnode *tmpvn;		/* scratch vnode */
    876 	struct vnode *foundobj;		/* result */
    877 	struct mount *mp;		/* mount table entry */
    878 	struct lwp *l = curlwp;
    879 	int error;
    880 
    881 	struct componentname *cnp = state->cnp;
    882 	struct nameidata *ndp = state->ndp;
    883 
    884 	KASSERT(cnp == &ndp->ni_cnd);
    885 	KASSERT(VOP_ISLOCKED(searchdir) == LK_EXCLUSIVE);
    886 	*newsearchdir_ret = searchdir;
    887 
    888 	/*
    889 	 * Handle "..": two special cases.
    890 	 * 1. If at root directory (e.g. after chroot)
    891 	 *    or at absolute root directory
    892 	 *    then ignore it so can't get out.
    893 	 * 1a. If at the root of the emulation filesystem go to the real
    894 	 *    root. So "/../<path>" is always absolute.
    895 	 * 1b. If we have somehow gotten out of a jail, warn
    896 	 *    and also ignore it so we can't get farther out.
    897 	 * 2. If this vnode is the root of a mounted
    898 	 *    filesystem, then replace it with the
    899 	 *    vnode which was mounted on so we take the
    900 	 *    .. in the other file system.
    901 	 */
    902 	if (cnp->cn_flags & ISDOTDOT) {
    903 		struct proc *p = l->l_proc;
    904 
    905 		for (;;) {
    906 			if (searchdir == ndp->ni_rootdir ||
    907 			    searchdir == rootvnode) {
    908 				foundobj = searchdir;
    909 				vref(foundobj);
    910 				*foundobj_ret = foundobj;
    911 				error = 0;
    912 				goto done;
    913 			}
    914 			if (ndp->ni_rootdir != rootvnode) {
    915 				int retval;
    916 
    917 				VOP_UNLOCK(searchdir);
    918 				retval = vn_isunder(searchdir, ndp->ni_rootdir, l);
    919 				vn_lock(searchdir, LK_EXCLUSIVE | LK_RETRY);
    920 				if (!retval) {
    921 				    /* Oops! We got out of jail! */
    922 				    log(LOG_WARNING,
    923 					"chrooted pid %d uid %d (%s) "
    924 					"detected outside of its chroot\n",
    925 					p->p_pid, kauth_cred_geteuid(l->l_cred),
    926 					p->p_comm);
    927 				    /* Put us at the jail root. */
    928 				    vput(searchdir);
    929 				    searchdir = NULL;
    930 				    foundobj = ndp->ni_rootdir;
    931 				    vref(foundobj);
    932 				    vref(foundobj);
    933 				    vn_lock(foundobj, LK_EXCLUSIVE | LK_RETRY);
    934 				    *newsearchdir_ret = foundobj;
    935 				    *foundobj_ret = foundobj;
    936 				    error = 0;
    937 				    goto done;
    938 				}
    939 			}
    940 			if ((searchdir->v_vflag & VV_ROOT) == 0 ||
    941 			    (cnp->cn_flags & NOCROSSMOUNT))
    942 				break;
    943 			tmpvn = searchdir;
    944 			searchdir = searchdir->v_mount->mnt_vnodecovered;
    945 			vref(searchdir);
    946 			vput(tmpvn);
    947 			vn_lock(searchdir, LK_EXCLUSIVE | LK_RETRY);
    948 			*newsearchdir_ret = searchdir;
    949 		}
    950 	}
    951 
    952 	/*
    953 	 * We now have a segment name to search for, and a directory to search.
    954 	 * Our vnode state here is that "searchdir" is held and locked.
    955 	 */
    956 unionlookup:
    957 	foundobj = NULL;
    958 	error = VOP_LOOKUP(searchdir, &foundobj, cnp);
    959 
    960 	if (error != 0) {
    961 #ifdef DIAGNOSTIC
    962 		if (foundobj != NULL)
    963 			panic("leaf `%s' should be empty", cnp->cn_nameptr);
    964 #endif /* DIAGNOSTIC */
    965 #ifdef NAMEI_DIAGNOSTIC
    966 		printf("not found\n");
    967 #endif /* NAMEI_DIAGNOSTIC */
    968 		if ((error == ENOENT) &&
    969 		    (searchdir->v_vflag & VV_ROOT) &&
    970 		    (searchdir->v_mount->mnt_flag & MNT_UNION)) {
    971 			tmpvn = searchdir;
    972 			searchdir = searchdir->v_mount->mnt_vnodecovered;
    973 			vref(searchdir);
    974 			vput(tmpvn);
    975 			vn_lock(searchdir, LK_EXCLUSIVE | LK_RETRY);
    976 			*newsearchdir_ret = searchdir;
    977 			goto unionlookup;
    978 		}
    979 
    980 		if (error != EJUSTRETURN)
    981 			goto done;
    982 
    983 		/*
    984 		 * If this was not the last component, or there were trailing
    985 		 * slashes, and we are not going to create a directory,
    986 		 * then the name must exist.
    987 		 */
    988 		if ((cnp->cn_flags & (REQUIREDIR | CREATEDIR)) == REQUIREDIR) {
    989 			error = ENOENT;
    990 			goto done;
    991 		}
    992 
    993 		/*
    994 		 * If creating and at end of pathname, then can consider
    995 		 * allowing file to be created.
    996 		 */
    997 		if (state->rdonly) {
    998 			error = EROFS;
    999 			goto done;
   1000 		}
   1001 
   1002 		/*
   1003 		 * We return success and a NULL foundobj to indicate
   1004 		 * that the entry doesn't currently exist, leaving a
   1005 		 * pointer to the (normally, locked) directory vnode
   1006 		 * as searchdir.
   1007 		 */
   1008 		*foundobj_ret = NULL;
   1009 		error = 0;
   1010 		goto done;
   1011 	}
   1012 #ifdef NAMEI_DIAGNOSTIC
   1013 	printf("found\n");
   1014 #endif /* NAMEI_DIAGNOSTIC */
   1015 
   1016 	/*
   1017 	 * Take into account any additional components consumed by the
   1018 	 * underlying filesystem.  This will include any trailing slashes after
   1019 	 * the last component consumed.
   1020 	 */
   1021 	if (cnp->cn_consume > 0) {
   1022 		ndp->ni_pathlen -= cnp->cn_consume - state->slashes;
   1023 		ndp->ni_next += cnp->cn_consume - state->slashes;
   1024 		cnp->cn_consume = 0;
   1025 		if (ndp->ni_next[0] == '\0')
   1026 			cnp->cn_flags |= ISLASTCN;
   1027 	}
   1028 
   1029 	/*
   1030 	 * "foundobj" and "searchdir" are both locked and held,
   1031 	 * and may be the same vnode.
   1032 	 */
   1033 
   1034 	/*
   1035 	 * Check to see if the vnode has been mounted on;
   1036 	 * if so find the root of the mounted file system.
   1037 	 */
   1038 	while (foundobj->v_type == VDIR &&
   1039 	       (mp = foundobj->v_mountedhere) != NULL &&
   1040 	       (cnp->cn_flags & NOCROSSMOUNT) == 0) {
   1041 		error = vfs_busy(mp, NULL);
   1042 		if (error != 0) {
   1043 			vput(foundobj);
   1044 			goto done;
   1045 		}
   1046 		KASSERT(searchdir != foundobj);
   1047 		VOP_UNLOCK(searchdir);
   1048 		vput(foundobj);
   1049 		error = VFS_ROOT(mp, &foundobj);
   1050 		vfs_unbusy(mp, false, NULL);
   1051 		if (error) {
   1052 			vn_lock(searchdir, LK_EXCLUSIVE | LK_RETRY);
   1053 			goto done;
   1054 		}
   1055 		VOP_UNLOCK(foundobj);
   1056 		vn_lock(searchdir, LK_EXCLUSIVE | LK_RETRY);
   1057 		vn_lock(foundobj, LK_EXCLUSIVE | LK_RETRY);
   1058 	}
   1059 
   1060 	*foundobj_ret = foundobj;
   1061 	error = 0;
   1062 done:
   1063 	KASSERT(VOP_ISLOCKED(*newsearchdir_ret) == LK_EXCLUSIVE);
   1064 	/*
   1065 	 * *foundobj_ret is valid only if error == 0.
   1066 	 */
   1067 	KASSERT(error != 0 || *foundobj_ret == NULL ||
   1068 	    VOP_ISLOCKED(*foundobj_ret) == LK_EXCLUSIVE);
   1069 	return error;
   1070 }
   1071 
   1072 //////////////////////////////
   1073 
   1074 /*
   1075  * Do a complete path search from a single root directory.
   1076  * (This is called up to twice if TRYEMULROOT is in effect.)
   1077  */
   1078 static int
   1079 namei_oneroot(struct namei_state *state, struct vnode *forcecwd,
   1080 	 int neverfollow, int inhibitmagic)
   1081 {
   1082 	struct nameidata *ndp = state->ndp;
   1083 	struct componentname *cnp = state->cnp;
   1084 	struct vnode *searchdir, *foundobj;
   1085 	int error;
   1086 
   1087 	error = namei_start(state, forcecwd, &searchdir);
   1088 	if (error) {
   1089 		ndp->ni_dvp = NULL;
   1090 		ndp->ni_vp = NULL;
   1091 		return error;
   1092 	}
   1093 	KASSERT(searchdir->v_type == VDIR);
   1094 
   1095 	/*
   1096 	 * Setup: break out flag bits into variables.
   1097 	 */
   1098 	state->docache = (cnp->cn_flags & NOCACHE) ^ NOCACHE;
   1099 	if (cnp->cn_nameiop == DELETE)
   1100 		state->docache = 0;
   1101 	state->rdonly = cnp->cn_flags & RDONLY;
   1102 
   1103 	/*
   1104 	 * Keep going until we run out of path components.
   1105 	 */
   1106 	cnp->cn_nameptr = ndp->ni_pnbuf;
   1107 
   1108 	/* drop leading slashes (already used them to choose startdir) */
   1109 	while (cnp->cn_nameptr[0] == '/') {
   1110 		cnp->cn_nameptr++;
   1111 		ndp->ni_pathlen--;
   1112 	}
   1113 	/* was it just "/"? */
   1114 	if (cnp->cn_nameptr[0] == '\0') {
   1115 		foundobj = searchdir;
   1116 		searchdir = NULL;
   1117 		cnp->cn_flags |= ISLASTCN;
   1118 
   1119 		/* bleh */
   1120 		goto skiploop;
   1121 	}
   1122 
   1123 	for (;;) {
   1124 
   1125 		/*
   1126 		 * If the directory we're on is unmounted, bail out.
   1127 		 * XXX: should this also check if it's unlinked?
   1128 		 * XXX: yes it should... but how?
   1129 		 */
   1130 		if (searchdir->v_mount == NULL) {
   1131 			vput(searchdir);
   1132 			ndp->ni_dvp = NULL;
   1133 			ndp->ni_vp = NULL;
   1134 			return (ENOENT);
   1135 		}
   1136 
   1137 		/*
   1138 		 * Look up the next path component.
   1139 		 * (currently, this may consume more than one)
   1140 		 */
   1141 
   1142 		/* There should be no slashes here. */
   1143 		KASSERT(cnp->cn_nameptr[0] != '/');
   1144 
   1145 		/* and we shouldn't have looped around if we were done */
   1146 		KASSERT(cnp->cn_nameptr[0] != '\0');
   1147 
   1148 		error = lookup_parsepath(state);
   1149 		if (error) {
   1150 			vput(searchdir);
   1151 			ndp->ni_dvp = NULL;
   1152 			ndp->ni_vp = NULL;
   1153 			state->attempt_retry = 1;
   1154 			return (error);
   1155 		}
   1156 
   1157 		error = lookup_once(state, searchdir, &searchdir, &foundobj);
   1158 		if (error) {
   1159 			vput(searchdir);
   1160 			ndp->ni_dvp = NULL;
   1161 			ndp->ni_vp = NULL;
   1162 			/*
   1163 			 * Note that if we're doing TRYEMULROOT we can
   1164 			 * retry with the normal root. Where this is
   1165 			 * currently set matches previous practice,
   1166 			 * but the previous practice didn't make much
   1167 			 * sense and somebody should sit down and
   1168 			 * figure out which cases should cause retry
   1169 			 * and which shouldn't. XXX.
   1170 			 */
   1171 			state->attempt_retry = 1;
   1172 			return (error);
   1173 		}
   1174 
   1175 		if (foundobj == NULL) {
   1176 			/*
   1177 			 * Success with no object returned means we're
   1178 			 * creating something and it isn't already
   1179 			 * there. Break out of the main loop now so
   1180 			 * the code below doesn't have to test for
   1181 			 * foundobj == NULL.
   1182 			 */
   1183 			break;
   1184 		}
   1185 
   1186 		/*
   1187 		 * Check for symbolic link. If we've reached one,
   1188 		 * follow it, unless we aren't supposed to. Back up
   1189 		 * over any slashes that we skipped, as we will need
   1190 		 * them again.
   1191 		 */
   1192 		if (namei_atsymlink(state, foundobj)) {
   1193 			ndp->ni_pathlen += state->slashes;
   1194 			ndp->ni_next -= state->slashes;
   1195 			if (neverfollow) {
   1196 				error = EINVAL;
   1197 			} else {
   1198 				/*
   1199 				 * dholland 20110410: if we're at a
   1200 				 * union mount it might make sense to
   1201 				 * use the top of the union stack here
   1202 				 * rather than the layer we found the
   1203 				 * symlink in. (FUTURE)
   1204 				 */
   1205 				error = namei_follow(state, inhibitmagic,
   1206 						     searchdir, foundobj,
   1207 						     &searchdir);
   1208 			}
   1209 			if (error) {
   1210 				KASSERT(searchdir != foundobj);
   1211 				vput(searchdir);
   1212 				vput(foundobj);
   1213 				ndp->ni_dvp = NULL;
   1214 				ndp->ni_vp = NULL;
   1215 				return error;
   1216 			}
   1217 			/* namei_follow unlocks it (ugh) so rele, not put */
   1218 			vrele(foundobj);
   1219 			foundobj = NULL;
   1220 			continue;
   1221 		}
   1222 
   1223 		/*
   1224 		 * Not a symbolic link.
   1225 		 *
   1226 		 * Check for directory, if the component was
   1227 		 * followed by a series of slashes.
   1228 		 */
   1229 		if ((foundobj->v_type != VDIR) && (cnp->cn_flags & REQUIREDIR)) {
   1230 			KASSERT(foundobj != searchdir);
   1231 			if (searchdir) {
   1232 				vput(searchdir);
   1233 			}
   1234 			vput(foundobj);
   1235 			ndp->ni_dvp = NULL;
   1236 			ndp->ni_vp = NULL;
   1237 			state->attempt_retry = 1;
   1238 			return ENOTDIR;
   1239 		}
   1240 
   1241 		/*
   1242 		 * Stop if we've reached the last component.
   1243 		 */
   1244 		if (cnp->cn_flags & ISLASTCN) {
   1245 			break;
   1246 		}
   1247 
   1248 		/*
   1249 		 * Continue with the next component.
   1250 		 */
   1251 		cnp->cn_nameptr = ndp->ni_next;
   1252 		if (searchdir == foundobj) {
   1253 			vrele(searchdir);
   1254 		} else {
   1255 			vput(searchdir);
   1256 		}
   1257 		searchdir = foundobj;
   1258 		foundobj = NULL;
   1259 	}
   1260 
   1261  skiploop:
   1262 
   1263 	if (foundobj != NULL) {
   1264 		if (foundobj == ndp->ni_erootdir) {
   1265 			/*
   1266 			 * We are about to return the emulation root.
   1267 			 * This isn't a good idea because code might
   1268 			 * repeatedly lookup ".." until the file
   1269 			 * matches that returned for "/" and loop
   1270 			 * forever.  So convert it to the real root.
   1271 			 */
   1272 			if (searchdir != NULL) {
   1273 				if (searchdir == foundobj)
   1274 					vrele(searchdir);
   1275 				else
   1276 					vput(searchdir);
   1277 				searchdir = NULL;
   1278 			}
   1279 			vput(foundobj);
   1280 			foundobj = ndp->ni_rootdir;
   1281 			vref(foundobj);
   1282 			vn_lock(foundobj, LK_EXCLUSIVE | LK_RETRY);
   1283 		}
   1284 
   1285 		/*
   1286 		 * If the caller requested the parent node (i.e. it's
   1287 		 * a CREATE, DELETE, or RENAME), and we don't have one
   1288 		 * (because this is the root directory, or we crossed
   1289 		 * a mount point), then we must fail.
   1290 		 */
   1291 		if (cnp->cn_nameiop != LOOKUP &&
   1292 		    (searchdir == NULL ||
   1293 		     searchdir->v_mount != foundobj->v_mount)) {
   1294 			if (searchdir) {
   1295 				vput(searchdir);
   1296 			}
   1297 			vput(foundobj);
   1298 			foundobj = NULL;
   1299 			ndp->ni_dvp = NULL;
   1300 			ndp->ni_vp = NULL;
   1301 			state->attempt_retry = 1;
   1302 
   1303 			switch (cnp->cn_nameiop) {
   1304 			    case CREATE:
   1305 				return EEXIST;
   1306 			    case DELETE:
   1307 			    case RENAME:
   1308 				return EBUSY;
   1309 			    default:
   1310 				break;
   1311 			}
   1312 			panic("Invalid nameiop\n");
   1313 		}
   1314 
   1315 		/*
   1316 		 * Disallow directory write attempts on read-only lookups.
   1317 		 * Prefers EEXIST over EROFS for the CREATE case.
   1318 		 */
   1319 		if (state->rdonly &&
   1320 		    (cnp->cn_nameiop == DELETE || cnp->cn_nameiop == RENAME)) {
   1321 			if (searchdir) {
   1322 				if (foundobj != searchdir) {
   1323 					vput(searchdir);
   1324 				} else {
   1325 					vrele(searchdir);
   1326 				}
   1327 				searchdir = NULL;
   1328 			}
   1329 			vput(foundobj);
   1330 			foundobj = NULL;
   1331 			ndp->ni_dvp = NULL;
   1332 			ndp->ni_vp = NULL;
   1333 			state->attempt_retry = 1;
   1334 			return EROFS;
   1335 		}
   1336 		if ((cnp->cn_flags & LOCKLEAF) == 0) {
   1337 			/*
   1338 			 * Note: if LOCKPARENT but not LOCKLEAF is
   1339 			 * set, and searchdir == foundobj, this code
   1340 			 * necessarily unlocks the parent as well as
   1341 			 * the leaf. That is, just because you specify
   1342 			 * LOCKPARENT doesn't mean you necessarily get
   1343 			 * a locked parent vnode. The code in
   1344 			 * vfs_syscalls.c, and possibly elsewhere,
   1345 			 * that uses this combination "knows" this, so
   1346 			 * it can't be safely changed. Feh. XXX
   1347 			 */
   1348 			VOP_UNLOCK(foundobj);
   1349 		}
   1350 	}
   1351 
   1352 	/*
   1353 	 * Done.
   1354 	 */
   1355 
   1356 	/*
   1357 	 * If LOCKPARENT is not set, the parent directory isn't returned.
   1358 	 */
   1359 	if ((cnp->cn_flags & LOCKPARENT) == 0 && searchdir != NULL) {
   1360 		if (searchdir == foundobj) {
   1361 			vrele(searchdir);
   1362 		} else {
   1363 			vput(searchdir);
   1364 		}
   1365 		searchdir = NULL;
   1366 	}
   1367 
   1368 	ndp->ni_dvp = searchdir;
   1369 	ndp->ni_vp = foundobj;
   1370 	return 0;
   1371 }
   1372 
   1373 /*
   1374  * Do namei; wrapper layer that handles TRYEMULROOT.
   1375  */
   1376 static int
   1377 namei_tryemulroot(struct namei_state *state, struct vnode *forcecwd,
   1378 	 int neverfollow, int inhibitmagic)
   1379 {
   1380 	int error;
   1381 
   1382 	struct nameidata *ndp = state->ndp;
   1383 	struct componentname *cnp = state->cnp;
   1384 	const char *savepath = NULL;
   1385 
   1386 	KASSERT(cnp == &ndp->ni_cnd);
   1387 
   1388 	if (cnp->cn_flags & TRYEMULROOT) {
   1389 		savepath = pathbuf_stringcopy_get(ndp->ni_pathbuf);
   1390 	}
   1391 
   1392     emul_retry:
   1393 	state->attempt_retry = 0;
   1394 
   1395 	error = namei_oneroot(state, forcecwd, neverfollow, inhibitmagic);
   1396 	if (error) {
   1397 		/*
   1398 		 * Once namei has started up, the existence of ni_erootdir
   1399 		 * tells us whether we're working from an emulation root.
   1400 		 * The TRYEMULROOT flag isn't necessarily authoritative.
   1401 		 */
   1402 		if (ndp->ni_erootdir != NULL && state->attempt_retry) {
   1403 			/* Retry the whole thing using the normal root */
   1404 			cnp->cn_flags &= ~TRYEMULROOT;
   1405 			state->attempt_retry = 0;
   1406 
   1407 			/* kinda gross */
   1408 			strcpy(ndp->ni_pathbuf->pb_path, savepath);
   1409 			pathbuf_stringcopy_put(ndp->ni_pathbuf, savepath);
   1410 			savepath = NULL;
   1411 
   1412 			goto emul_retry;
   1413 		}
   1414 	}
   1415 	if (savepath != NULL) {
   1416 		pathbuf_stringcopy_put(ndp->ni_pathbuf, savepath);
   1417 	}
   1418 	return error;
   1419 }
   1420 
   1421 /*
   1422  * External interface.
   1423  */
   1424 int
   1425 namei(struct nameidata *ndp)
   1426 {
   1427 	struct namei_state state;
   1428 	int error;
   1429 
   1430 	namei_init(&state, ndp);
   1431 	error = namei_tryemulroot(&state, NULL,
   1432 				  0/*!neverfollow*/, 0/*!inhibitmagic*/);
   1433 	namei_cleanup(&state);
   1434 
   1435 	if (error) {
   1436 		/* make sure no stray refs leak out */
   1437 		KASSERT(ndp->ni_dvp == NULL);
   1438 		KASSERT(ndp->ni_vp == NULL);
   1439 	}
   1440 
   1441 	return error;
   1442 }
   1443 
   1444 ////////////////////////////////////////////////////////////
   1445 
   1446 /*
   1447  * External interface used by nfsd. This is basically different from
   1448  * namei only in that it has the ability to pass in the "current
   1449  * directory", and uses an extra flag "neverfollow" for which there's
   1450  * no physical flag defined in namei.h. (There used to be a cut&paste
   1451  * copy of about half of namei in nfsd to allow these minor
   1452  * adjustments to exist.)
   1453  *
   1454  * XXX: the namei interface should be adjusted so nfsd can just use
   1455  * ordinary namei().
   1456  */
   1457 int
   1458 lookup_for_nfsd(struct nameidata *ndp, struct vnode *forcecwd, int neverfollow)
   1459 {
   1460 	struct namei_state state;
   1461 	int error;
   1462 
   1463 	namei_init(&state, ndp);
   1464 	error = namei_tryemulroot(&state, forcecwd,
   1465 				  neverfollow, 1/*inhibitmagic*/);
   1466 	namei_cleanup(&state);
   1467 
   1468 	if (error) {
   1469 		/* make sure no stray refs leak out */
   1470 		KASSERT(ndp->ni_dvp == NULL);
   1471 		KASSERT(ndp->ni_vp == NULL);
   1472 	}
   1473 
   1474 	return error;
   1475 }
   1476 
   1477 /*
   1478  * A second external interface used by nfsd. This turns out to be a
   1479  * single lookup used by the WebNFS code (ha!) to get "index.html" or
   1480  * equivalent when asked for a directory. It should eventually evolve
   1481  * into some kind of namei_once() call; for the time being it's kind
   1482  * of a mess. XXX.
   1483  *
   1484  * dholland 20110109: I don't think it works, and I don't think it
   1485  * worked before I started hacking and slashing either, and I doubt
   1486  * anyone will ever notice.
   1487  */
   1488 
   1489 /*
   1490  * Internals. This calls lookup_once() after setting up the assorted
   1491  * pieces of state the way they ought to be.
   1492  */
   1493 static int
   1494 do_lookup_for_nfsd_index(struct namei_state *state, struct vnode *startdir)
   1495 {
   1496 	int error = 0;
   1497 
   1498 	struct componentname *cnp = state->cnp;
   1499 	struct nameidata *ndp = state->ndp;
   1500 	struct vnode *foundobj;
   1501 	const char *cp;			/* pointer into pathname argument */
   1502 
   1503 	KASSERT(cnp == &ndp->ni_cnd);
   1504 
   1505 	cnp->cn_nameptr = ndp->ni_pnbuf;
   1506 	state->docache = 1;
   1507 	state->rdonly = cnp->cn_flags & RDONLY;
   1508 	ndp->ni_dvp = NULL;
   1509 
   1510 	cnp->cn_consume = 0;
   1511 	cp = NULL;
   1512 	cnp->cn_hash = namei_hash(cnp->cn_nameptr, &cp);
   1513 	cnp->cn_namelen = cp - cnp->cn_nameptr;
   1514 	KASSERT(cnp->cn_namelen <= NAME_MAX);
   1515 	ndp->ni_pathlen -= cnp->cn_namelen;
   1516 	ndp->ni_next = cp;
   1517 	state->slashes = 0;
   1518 	cnp->cn_flags &= ~REQUIREDIR;
   1519 	cnp->cn_flags |= MAKEENTRY|ISLASTCN;
   1520 
   1521 	if (cnp->cn_namelen == 2 &&
   1522 	    cnp->cn_nameptr[1] == '.' && cnp->cn_nameptr[0] == '.')
   1523 		cnp->cn_flags |= ISDOTDOT;
   1524 	else
   1525 		cnp->cn_flags &= ~ISDOTDOT;
   1526 
   1527 	/*
   1528 	 * Because lookup_once can change the startdir, we need our
   1529 	 * own reference to it to avoid consuming the caller's.
   1530 	 */
   1531 	vref(startdir);
   1532 	vn_lock(startdir, LK_EXCLUSIVE | LK_RETRY);
   1533 	error = lookup_once(state, startdir, &startdir, &foundobj);
   1534 	vput(startdir);
   1535 	if (error) {
   1536 		goto bad;
   1537 	}
   1538 	ndp->ni_vp = foundobj;
   1539 
   1540 	if (foundobj == NULL) {
   1541 		return 0;
   1542 	}
   1543 
   1544 	KASSERT((cnp->cn_flags & LOCKPARENT) == 0);
   1545 	if ((cnp->cn_flags & LOCKLEAF) == 0) {
   1546 		VOP_UNLOCK(foundobj);
   1547 	}
   1548 	return (0);
   1549 
   1550 bad:
   1551 	ndp->ni_vp = NULL;
   1552 	return (error);
   1553 }
   1554 
   1555 /*
   1556  * External interface. The partitioning between this function and the
   1557  * above isn't very clear - the above function exists mostly so code
   1558  * that uses "state->" can be shuffled around without having to change
   1559  * it to "state.".
   1560  */
   1561 int
   1562 lookup_for_nfsd_index(struct nameidata *ndp, struct vnode *startdir)
   1563 {
   1564 	struct namei_state state;
   1565 	int error;
   1566 
   1567 	/*
   1568 	 * Note: the name sent in here (is not|should not be) allowed
   1569 	 * to contain a slash.
   1570 	 */
   1571 	if (strlen(ndp->ni_pathbuf->pb_path) > NAME_MAX) {
   1572 		return ENAMETOOLONG;
   1573 	}
   1574 	if (strchr(ndp->ni_pathbuf->pb_path, '/')) {
   1575 		return EINVAL;
   1576 	}
   1577 
   1578 	ndp->ni_pathlen = strlen(ndp->ni_pathbuf->pb_path) + 1;
   1579 	ndp->ni_pnbuf = NULL;
   1580 	ndp->ni_cnd.cn_nameptr = NULL;
   1581 
   1582 	namei_init(&state, ndp);
   1583 	error = do_lookup_for_nfsd_index(&state, startdir);
   1584 	namei_cleanup(&state);
   1585 
   1586 	return error;
   1587 }
   1588 
   1589 ////////////////////////////////////////////////////////////
   1590 
   1591 /*
   1592  * Reacquire a path name component.
   1593  * dvp is locked on entry and exit.
   1594  * *vpp is locked on exit unless it's NULL.
   1595  */
   1596 int
   1597 relookup(struct vnode *dvp, struct vnode **vpp, struct componentname *cnp, int dummy)
   1598 {
   1599 	int rdonly;			/* lookup read-only flag bit */
   1600 	int error = 0;
   1601 #ifdef DEBUG
   1602 	uint32_t newhash;		/* DEBUG: check name hash */
   1603 	const char *cp;			/* DEBUG: check name ptr/len */
   1604 #endif /* DEBUG */
   1605 
   1606 	(void)dummy;
   1607 
   1608 	/*
   1609 	 * Setup: break out flag bits into variables.
   1610 	 */
   1611 	rdonly = cnp->cn_flags & RDONLY;
   1612 
   1613 	/*
   1614 	 * Search a new directory.
   1615 	 *
   1616 	 * The cn_hash value is for use by vfs_cache.
   1617 	 * The last component of the filename is left accessible via
   1618 	 * cnp->cn_nameptr for callers that need the name. Callers needing
   1619 	 * the name set the SAVENAME flag. When done, they assume
   1620 	 * responsibility for freeing the pathname buffer.
   1621 	 */
   1622 #ifdef DEBUG
   1623 	cp = NULL;
   1624 	newhash = namei_hash(cnp->cn_nameptr, &cp);
   1625 	if ((uint32_t)newhash != (uint32_t)cnp->cn_hash)
   1626 		panic("relookup: bad hash");
   1627 	if (cnp->cn_namelen != cp - cnp->cn_nameptr)
   1628 		panic("relookup: bad len");
   1629 	while (*cp == '/')
   1630 		cp++;
   1631 	if (*cp != 0)
   1632 		panic("relookup: not last component");
   1633 #endif /* DEBUG */
   1634 
   1635 	/*
   1636 	 * Check for degenerate name (e.g. / or "")
   1637 	 * which is a way of talking about a directory,
   1638 	 * e.g. like "/." or ".".
   1639 	 */
   1640 	if (cnp->cn_nameptr[0] == '\0')
   1641 		panic("relookup: null name");
   1642 
   1643 	if (cnp->cn_flags & ISDOTDOT)
   1644 		panic("relookup: lookup on dot-dot");
   1645 
   1646 	/*
   1647 	 * We now have a segment name to search for, and a directory to search.
   1648 	 */
   1649 	cnp->cn_flags |= INRELOOKUP;
   1650 	error = VOP_LOOKUP(dvp, vpp, cnp);
   1651 	cnp->cn_flags &= ~INRELOOKUP;
   1652 	if ((error) != 0) {
   1653 #ifdef DIAGNOSTIC
   1654 		if (*vpp != NULL)
   1655 			panic("leaf `%s' should be empty", cnp->cn_nameptr);
   1656 #endif
   1657 		if (error != EJUSTRETURN)
   1658 			goto bad;
   1659 	}
   1660 
   1661 #ifdef DIAGNOSTIC
   1662 	/*
   1663 	 * Check for symbolic link
   1664 	 */
   1665 	if (*vpp && (*vpp)->v_type == VLNK && (cnp->cn_flags & FOLLOW))
   1666 		panic("relookup: symlink found");
   1667 #endif
   1668 
   1669 	/*
   1670 	 * Check for read-only lookups.
   1671 	 */
   1672 	if (rdonly && cnp->cn_nameiop != LOOKUP) {
   1673 		error = EROFS;
   1674 		if (*vpp) {
   1675 			vput(*vpp);
   1676 		}
   1677 		goto bad;
   1678 	}
   1679 	return (0);
   1680 
   1681 bad:
   1682 	*vpp = NULL;
   1683 	return (error);
   1684 }
   1685 
   1686 /*
   1687  * namei_simple - simple forms of namei.
   1688  *
   1689  * These are wrappers to allow the simple case callers of namei to be
   1690  * left alone while everything else changes under them.
   1691  */
   1692 
   1693 /* Flags */
   1694 struct namei_simple_flags_type {
   1695 	int dummy;
   1696 };
   1697 static const struct namei_simple_flags_type ns_nn, ns_nt, ns_fn, ns_ft;
   1698 const namei_simple_flags_t NSM_NOFOLLOW_NOEMULROOT = &ns_nn;
   1699 const namei_simple_flags_t NSM_NOFOLLOW_TRYEMULROOT = &ns_nt;
   1700 const namei_simple_flags_t NSM_FOLLOW_NOEMULROOT = &ns_fn;
   1701 const namei_simple_flags_t NSM_FOLLOW_TRYEMULROOT = &ns_ft;
   1702 
   1703 static
   1704 int
   1705 namei_simple_convert_flags(namei_simple_flags_t sflags)
   1706 {
   1707 	if (sflags == NSM_NOFOLLOW_NOEMULROOT)
   1708 		return NOFOLLOW | 0;
   1709 	if (sflags == NSM_NOFOLLOW_TRYEMULROOT)
   1710 		return NOFOLLOW | TRYEMULROOT;
   1711 	if (sflags == NSM_FOLLOW_NOEMULROOT)
   1712 		return FOLLOW | 0;
   1713 	if (sflags == NSM_FOLLOW_TRYEMULROOT)
   1714 		return FOLLOW | TRYEMULROOT;
   1715 	panic("namei_simple_convert_flags: bogus sflags\n");
   1716 	return 0;
   1717 }
   1718 
   1719 int
   1720 namei_simple_kernel(const char *path, namei_simple_flags_t sflags,
   1721 			struct vnode **vp_ret)
   1722 {
   1723 	struct nameidata nd;
   1724 	struct pathbuf *pb;
   1725 	int err;
   1726 
   1727 	pb = pathbuf_create(path);
   1728 	if (pb == NULL) {
   1729 		return ENOMEM;
   1730 	}
   1731 
   1732 	NDINIT(&nd,
   1733 		LOOKUP,
   1734 		namei_simple_convert_flags(sflags),
   1735 		pb);
   1736 	err = namei(&nd);
   1737 	if (err != 0) {
   1738 		pathbuf_destroy(pb);
   1739 		return err;
   1740 	}
   1741 	*vp_ret = nd.ni_vp;
   1742 	pathbuf_destroy(pb);
   1743 	return 0;
   1744 }
   1745 
   1746 int
   1747 namei_simple_user(const char *path, namei_simple_flags_t sflags,
   1748 			struct vnode **vp_ret)
   1749 {
   1750 	struct pathbuf *pb;
   1751 	struct nameidata nd;
   1752 	int err;
   1753 
   1754 	err = pathbuf_copyin(path, &pb);
   1755 	if (err) {
   1756 		return err;
   1757 	}
   1758 
   1759 	NDINIT(&nd,
   1760 		LOOKUP,
   1761 		namei_simple_convert_flags(sflags),
   1762 		pb);
   1763 	err = namei(&nd);
   1764 	if (err != 0) {
   1765 		pathbuf_destroy(pb);
   1766 		return err;
   1767 	}
   1768 	*vp_ret = nd.ni_vp;
   1769 	pathbuf_destroy(pb);
   1770 	return 0;
   1771 }
   1772