Home | History | Annotate | Line # | Download | only in kern
vfs_lookup.c revision 1.225.4.2
      1  1.225.4.2   thorpej /*	$NetBSD: vfs_lookup.c,v 1.225.4.2 2021/08/01 22:42:39 thorpej Exp $	*/
      2       1.13       cgd 
      3       1.10       cgd /*
      4       1.12   mycroft  * Copyright (c) 1982, 1986, 1989, 1993
      5       1.12   mycroft  *	The Regents of the University of California.  All rights reserved.
      6       1.10       cgd  * (c) UNIX System Laboratories, Inc.
      7       1.10       cgd  * All or some portions of this file are derived from material licensed
      8       1.10       cgd  * to the University of California by American Telephone and Telegraph
      9       1.10       cgd  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
     10       1.10       cgd  * the permission of UNIX System Laboratories, Inc.
     11       1.10       cgd  *
     12       1.10       cgd  * Redistribution and use in source and binary forms, with or without
     13       1.10       cgd  * modification, are permitted provided that the following conditions
     14       1.10       cgd  * are met:
     15       1.10       cgd  * 1. Redistributions of source code must retain the above copyright
     16       1.10       cgd  *    notice, this list of conditions and the following disclaimer.
     17       1.10       cgd  * 2. Redistributions in binary form must reproduce the above copyright
     18       1.10       cgd  *    notice, this list of conditions and the following disclaimer in the
     19       1.10       cgd  *    documentation and/or other materials provided with the distribution.
     20       1.49       agc  * 3. Neither the name of the University nor the names of its contributors
     21       1.10       cgd  *    may be used to endorse or promote products derived from this software
     22       1.10       cgd  *    without specific prior written permission.
     23       1.10       cgd  *
     24       1.10       cgd  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     25       1.10       cgd  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     26       1.10       cgd  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     27       1.10       cgd  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     28       1.10       cgd  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     29       1.10       cgd  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     30       1.10       cgd  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     31       1.10       cgd  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     32       1.10       cgd  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     33       1.10       cgd  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     34       1.10       cgd  * SUCH DAMAGE.
     35       1.10       cgd  *
     36       1.26      fvdl  *	@(#)vfs_lookup.c	8.10 (Berkeley) 5/27/95
     37       1.10       cgd  */
     38       1.38     lukem 
     39       1.38     lukem #include <sys/cdefs.h>
     40  1.225.4.2   thorpej __KERNEL_RCSID(0, "$NetBSD: vfs_lookup.c,v 1.225.4.2 2021/08/01 22:42:39 thorpej Exp $");
     41       1.27   thorpej 
     42      1.203     pooka #ifdef _KERNEL_OPT
     43       1.67       chs #include "opt_magiclinks.h"
     44      1.203     pooka #endif
     45       1.10       cgd 
     46       1.10       cgd #include <sys/param.h>
     47       1.15       cgd #include <sys/systm.h>
     48       1.61   thorpej #include <sys/kernel.h>
     49       1.10       cgd #include <sys/syslimits.h>
     50       1.10       cgd #include <sys/time.h>
     51       1.10       cgd #include <sys/namei.h>
     52       1.10       cgd #include <sys/vnode.h>
     53      1.215        ad #include <sys/vnode_impl.h>
     54       1.10       cgd #include <sys/mount.h>
     55       1.10       cgd #include <sys/errno.h>
     56       1.39     lukem #include <sys/filedesc.h>
     57       1.39     lukem #include <sys/hash.h>
     58       1.10       cgd #include <sys/proc.h>
     59       1.40  wrstuden #include <sys/syslog.h>
     60       1.70      elad #include <sys/kauth.h>
     61       1.97        ad #include <sys/ktrace.h>
     62      1.192  christos #include <sys/dirent.h>
     63       1.12   mycroft 
     64       1.67       chs #ifndef MAGICLINKS
     65       1.67       chs #define MAGICLINKS 0
     66       1.67       chs #endif
     67       1.67       chs 
     68       1.67       chs int vfs_magiclinks = MAGICLINKS;
     69       1.67       chs 
     70      1.191  christos __CTASSERT(MAXNAMLEN == NAME_MAX);
     71      1.191  christos 
     72       1.10       cgd /*
     73       1.61   thorpej  * Substitute replacement text for 'magic' strings in symlinks.
     74       1.61   thorpej  * Returns 0 if successful, and returns non-zero if an error
     75       1.61   thorpej  * occurs.  (Currently, the only possible error is running out
     76       1.61   thorpej  * of temporary pathname space.)
     77       1.61   thorpej  *
     78       1.61   thorpej  * Looks for "@<string>" and "@<string>/", where <string> is a
     79       1.61   thorpej  * recognized 'magic' string.  Replaces the "@<string>" with the
     80       1.61   thorpej  * appropriate replacement text.  (Note that in some cases the
     81       1.61   thorpej  * replacement text may have zero length.)
     82       1.61   thorpej  *
     83       1.61   thorpej  * This would have been table driven, but the variance in
     84       1.61   thorpej  * replacement strings (and replacement string lengths) made
     85       1.61   thorpej  * that impractical.
     86       1.61   thorpej  */
     87       1.63   thorpej #define	VNL(x)							\
     88       1.63   thorpej 	(sizeof(x) - 1)
     89       1.63   thorpej 
     90       1.63   thorpej #define	VO	'{'
     91       1.63   thorpej #define	VC	'}'
     92       1.63   thorpej 
     93       1.61   thorpej #define	MATCH(str)						\
     94       1.63   thorpej 	((termchar == '/' && i + VNL(str) == *len) ||		\
     95       1.63   thorpej 	 (i + VNL(str) < *len &&				\
     96       1.63   thorpej 	  cp[i + VNL(str)] == termchar)) &&			\
     97       1.63   thorpej 	!strncmp((str), &cp[i], VNL(str))
     98       1.61   thorpej 
     99       1.61   thorpej #define	SUBSTITUTE(m, s, sl)					\
    100      1.115  christos 	if ((newlen + (sl)) >= MAXPATHLEN)			\
    101      1.115  christos 		return 1;					\
    102       1.63   thorpej 	i += VNL(m);						\
    103       1.63   thorpej 	if (termchar != '/')					\
    104       1.63   thorpej 		i++;						\
    105      1.115  christos 	(void)memcpy(&tmp[newlen], (s), (sl));			\
    106       1.63   thorpej 	newlen += (sl);						\
    107       1.63   thorpej 	change = 1;						\
    108       1.63   thorpej 	termchar = '/';
    109       1.61   thorpej 
    110       1.61   thorpej static int
    111      1.115  christos symlink_magic(struct proc *p, char *cp, size_t *len)
    112       1.61   thorpej {
    113       1.66      yamt 	char *tmp;
    114      1.115  christos 	size_t change, i, newlen, slen;
    115      1.115  christos 	char termchar = '/';
    116      1.115  christos 	char idtmp[11]; /* enough for 32 bit *unsigned* integer */
    117      1.101       mjf 
    118       1.61   thorpej 
    119       1.66      yamt 	tmp = PNBUF_GET();
    120       1.61   thorpej 	for (change = i = newlen = 0; i < *len; ) {
    121       1.63   thorpej 		if (cp[i] != '@') {
    122       1.61   thorpej 			tmp[newlen++] = cp[i++];
    123       1.63   thorpej 			continue;
    124       1.63   thorpej 		}
    125       1.63   thorpej 
    126       1.63   thorpej 		i++;
    127       1.63   thorpej 
    128       1.63   thorpej 		/* Check for @{var} syntax. */
    129       1.63   thorpej 		if (cp[i] == VO) {
    130       1.63   thorpej 			termchar = VC;
    131       1.61   thorpej 			i++;
    132       1.63   thorpej 		}
    133       1.63   thorpej 
    134       1.63   thorpej 		/*
    135       1.63   thorpej 		 * The following checks should be ordered according
    136       1.63   thorpej 		 * to frequency of use.
    137       1.63   thorpej 		 */
    138       1.63   thorpej 		if (MATCH("machine_arch")) {
    139      1.115  christos 			slen = VNL(MACHINE_ARCH);
    140      1.115  christos 			SUBSTITUTE("machine_arch", MACHINE_ARCH, slen);
    141       1.63   thorpej 		} else if (MATCH("machine")) {
    142      1.115  christos 			slen = VNL(MACHINE);
    143      1.115  christos 			SUBSTITUTE("machine", MACHINE, slen);
    144       1.63   thorpej 		} else if (MATCH("hostname")) {
    145      1.115  christos 			SUBSTITUTE("hostname", hostname, hostnamelen);
    146       1.63   thorpej 		} else if (MATCH("osrelease")) {
    147      1.115  christos 			slen = strlen(osrelease);
    148      1.115  christos 			SUBSTITUTE("osrelease", osrelease, slen);
    149       1.63   thorpej 		} else if (MATCH("emul")) {
    150      1.115  christos 			slen = strlen(p->p_emul->e_name);
    151      1.115  christos 			SUBSTITUTE("emul", p->p_emul->e_name, slen);
    152       1.63   thorpej 		} else if (MATCH("kernel_ident")) {
    153      1.115  christos 			slen = strlen(kernel_ident);
    154      1.115  christos 			SUBSTITUTE("kernel_ident", kernel_ident, slen);
    155       1.63   thorpej 		} else if (MATCH("domainname")) {
    156      1.115  christos 			SUBSTITUTE("domainname", domainname, domainnamelen);
    157       1.63   thorpej 		} else if (MATCH("ostype")) {
    158      1.115  christos 			slen = strlen(ostype);
    159      1.115  christos 			SUBSTITUTE("ostype", ostype, slen);
    160       1.72      elad 		} else if (MATCH("uid")) {
    161      1.115  christos 			slen = snprintf(idtmp, sizeof(idtmp), "%u",
    162       1.72      elad 			    kauth_cred_geteuid(kauth_cred_get()));
    163      1.115  christos 			SUBSTITUTE("uid", idtmp, slen);
    164      1.101       mjf 		} else if (MATCH("ruid")) {
    165      1.115  christos 			slen = snprintf(idtmp, sizeof(idtmp), "%u",
    166      1.101       mjf 			    kauth_cred_getuid(kauth_cred_get()));
    167      1.115  christos 			SUBSTITUTE("ruid", idtmp, slen);
    168      1.115  christos 		} else if (MATCH("gid")) {
    169      1.115  christos 			slen = snprintf(idtmp, sizeof(idtmp), "%u",
    170      1.115  christos 			    kauth_cred_getegid(kauth_cred_get()));
    171      1.115  christos 			SUBSTITUTE("gid", idtmp, slen);
    172      1.115  christos 		} else if (MATCH("rgid")) {
    173      1.115  christos 			slen = snprintf(idtmp, sizeof(idtmp), "%u",
    174      1.115  christos 			    kauth_cred_getgid(kauth_cred_get()));
    175      1.115  christos 			SUBSTITUTE("rgid", idtmp, slen);
    176       1.63   thorpej 		} else {
    177       1.63   thorpej 			tmp[newlen++] = '@';
    178       1.63   thorpej 			if (termchar == VC)
    179       1.63   thorpej 				tmp[newlen++] = VO;
    180       1.61   thorpej 		}
    181       1.61   thorpej 	}
    182       1.61   thorpej 
    183       1.66      yamt 	if (change) {
    184      1.115  christos 		(void)memcpy(cp, tmp, newlen);
    185       1.66      yamt 		*len = newlen;
    186       1.66      yamt 	}
    187       1.66      yamt 	PNBUF_PUT(tmp);
    188       1.61   thorpej 
    189      1.115  christos 	return 0;
    190       1.61   thorpej }
    191       1.61   thorpej 
    192       1.63   thorpej #undef VNL
    193       1.63   thorpej #undef VO
    194       1.63   thorpej #undef VC
    195       1.63   thorpej #undef MATCH
    196       1.63   thorpej #undef SUBSTITUTE
    197       1.63   thorpej 
    198      1.123  dholland ////////////////////////////////////////////////////////////
    199      1.123  dholland 
    200      1.123  dholland /*
    201      1.197  dholland  * Determine the namei hash (for the namecache) for name.
    202      1.131  dholland  * If *ep != NULL, hash from name to ep-1.
    203      1.131  dholland  * If *ep == NULL, hash from name until the first NUL or '/', and
    204      1.131  dholland  * return the location of this termination character in *ep.
    205      1.131  dholland  *
    206      1.131  dholland  * This function returns an equivalent hash to the MI hash32_strn().
    207      1.131  dholland  * The latter isn't used because in the *ep == NULL case, determining
    208      1.131  dholland  * the length of the string to the first NUL or `/' and then calling
    209      1.131  dholland  * hash32_strn() involves unnecessary double-handling of the data.
    210      1.131  dholland  */
    211      1.131  dholland uint32_t
    212      1.131  dholland namei_hash(const char *name, const char **ep)
    213      1.131  dholland {
    214      1.131  dholland 	uint32_t	hash;
    215      1.131  dholland 
    216      1.131  dholland 	hash = HASH32_STR_INIT;
    217      1.131  dholland 	if (*ep != NULL) {
    218      1.131  dholland 		for (; name < *ep; name++)
    219      1.131  dholland 			hash = hash * 33 + *(const uint8_t *)name;
    220      1.131  dholland 	} else {
    221      1.131  dholland 		for (; *name != '\0' && *name != '/'; name++)
    222      1.131  dholland 			hash = hash * 33 + *(const uint8_t *)name;
    223      1.131  dholland 		*ep = name;
    224      1.131  dholland 	}
    225      1.131  dholland 	return (hash + (hash >> 5));
    226      1.131  dholland }
    227      1.131  dholland 
    228      1.131  dholland ////////////////////////////////////////////////////////////
    229      1.131  dholland 
    230      1.131  dholland /*
    231      1.123  dholland  * Sealed abstraction for pathnames.
    232      1.123  dholland  *
    233      1.123  dholland  * System-call-layer level code that is going to call namei should
    234      1.123  dholland  * first create a pathbuf and adjust all the bells and whistles on it
    235      1.176  dholland  * as needed by context.
    236      1.123  dholland  */
    237      1.123  dholland 
    238      1.123  dholland struct pathbuf {
    239      1.123  dholland 	char *pb_path;
    240      1.123  dholland 	char *pb_pathcopy;
    241      1.123  dholland 	unsigned pb_pathcopyuses;
    242      1.123  dholland };
    243      1.123  dholland 
    244      1.123  dholland static struct pathbuf *
    245      1.123  dholland pathbuf_create_raw(void)
    246      1.123  dholland {
    247      1.123  dholland 	struct pathbuf *pb;
    248      1.123  dholland 
    249      1.123  dholland 	pb = kmem_alloc(sizeof(*pb), KM_SLEEP);
    250      1.123  dholland 	pb->pb_path = PNBUF_GET();
    251      1.123  dholland 	if (pb->pb_path == NULL) {
    252      1.123  dholland 		kmem_free(pb, sizeof(*pb));
    253      1.123  dholland 		return NULL;
    254      1.123  dholland 	}
    255      1.123  dholland 	pb->pb_pathcopy = NULL;
    256      1.123  dholland 	pb->pb_pathcopyuses = 0;
    257      1.123  dholland 	return pb;
    258      1.123  dholland }
    259      1.123  dholland 
    260      1.123  dholland void
    261      1.123  dholland pathbuf_destroy(struct pathbuf *pb)
    262      1.123  dholland {
    263      1.123  dholland 	KASSERT(pb->pb_pathcopyuses == 0);
    264      1.123  dholland 	KASSERT(pb->pb_pathcopy == NULL);
    265      1.123  dholland 	PNBUF_PUT(pb->pb_path);
    266      1.123  dholland 	kmem_free(pb, sizeof(*pb));
    267      1.123  dholland }
    268      1.123  dholland 
    269      1.123  dholland struct pathbuf *
    270      1.124  dholland pathbuf_assimilate(char *pnbuf)
    271      1.124  dholland {
    272      1.124  dholland 	struct pathbuf *pb;
    273      1.124  dholland 
    274      1.124  dholland 	pb = kmem_alloc(sizeof(*pb), KM_SLEEP);
    275      1.124  dholland 	pb->pb_path = pnbuf;
    276      1.124  dholland 	pb->pb_pathcopy = NULL;
    277      1.124  dholland 	pb->pb_pathcopyuses = 0;
    278      1.124  dholland 	return pb;
    279      1.124  dholland }
    280      1.124  dholland 
    281      1.124  dholland struct pathbuf *
    282      1.123  dholland pathbuf_create(const char *path)
    283      1.123  dholland {
    284      1.123  dholland 	struct pathbuf *pb;
    285      1.123  dholland 	int error;
    286      1.123  dholland 
    287      1.123  dholland 	pb = pathbuf_create_raw();
    288      1.123  dholland 	if (pb == NULL) {
    289      1.123  dholland 		return NULL;
    290      1.123  dholland 	}
    291      1.123  dholland 	error = copystr(path, pb->pb_path, PATH_MAX, NULL);
    292      1.123  dholland 	if (error != 0) {
    293      1.123  dholland 		KASSERT(!"kernel path too long in pathbuf_create");
    294      1.123  dholland 		/* make sure it's null-terminated, just in case */
    295      1.123  dholland 		pb->pb_path[PATH_MAX-1] = '\0';
    296      1.123  dholland 	}
    297      1.123  dholland 	return pb;
    298      1.123  dholland }
    299      1.123  dholland 
    300      1.123  dholland int
    301      1.123  dholland pathbuf_copyin(const char *userpath, struct pathbuf **ret)
    302      1.123  dholland {
    303      1.123  dholland 	struct pathbuf *pb;
    304      1.123  dholland 	int error;
    305      1.123  dholland 
    306      1.123  dholland 	pb = pathbuf_create_raw();
    307      1.123  dholland 	if (pb == NULL) {
    308      1.123  dholland 		return ENOMEM;
    309      1.123  dholland 	}
    310      1.123  dholland 	error = copyinstr(userpath, pb->pb_path, PATH_MAX, NULL);
    311      1.123  dholland 	if (error) {
    312      1.123  dholland 		pathbuf_destroy(pb);
    313      1.123  dholland 		return error;
    314      1.123  dholland 	}
    315      1.123  dholland 	*ret = pb;
    316      1.123  dholland 	return 0;
    317      1.123  dholland }
    318      1.123  dholland 
    319      1.123  dholland /*
    320      1.173  dholland  * XXX should not exist:
    321      1.176  dholland  *   1. whether a pointer is kernel or user should be statically checkable.
    322      1.173  dholland  *   2. copyin should be handled by the upper part of the syscall layer,
    323      1.173  dholland  *      not in here.
    324      1.123  dholland  */
    325      1.123  dholland int
    326      1.123  dholland pathbuf_maybe_copyin(const char *path, enum uio_seg seg, struct pathbuf **ret)
    327      1.123  dholland {
    328      1.123  dholland 	if (seg == UIO_USERSPACE) {
    329      1.123  dholland 		return pathbuf_copyin(path, ret);
    330      1.123  dholland 	} else {
    331      1.123  dholland 		*ret = pathbuf_create(path);
    332      1.123  dholland 		if (*ret == NULL) {
    333      1.123  dholland 			return ENOMEM;
    334      1.123  dholland 		}
    335      1.123  dholland 		return 0;
    336      1.123  dholland 	}
    337      1.123  dholland }
    338      1.123  dholland 
    339      1.123  dholland /*
    340      1.123  dholland  * Get a copy of the path buffer as it currently exists. If this is
    341      1.123  dholland  * called after namei starts the results may be arbitrary.
    342      1.123  dholland  */
    343      1.123  dholland void
    344      1.123  dholland pathbuf_copystring(const struct pathbuf *pb, char *buf, size_t maxlen)
    345      1.123  dholland {
    346      1.123  dholland 	strlcpy(buf, pb->pb_path, maxlen);
    347      1.123  dholland }
    348      1.123  dholland 
    349      1.123  dholland /*
    350      1.123  dholland  * These two functions allow access to a saved copy of the original
    351      1.123  dholland  * path string. The first copy should be gotten before namei is
    352      1.123  dholland  * called. Each copy that is gotten should be put back.
    353      1.123  dholland  */
    354      1.123  dholland 
    355      1.123  dholland const char *
    356      1.123  dholland pathbuf_stringcopy_get(struct pathbuf *pb)
    357      1.123  dholland {
    358      1.123  dholland 	if (pb->pb_pathcopyuses == 0) {
    359      1.123  dholland 		pb->pb_pathcopy = PNBUF_GET();
    360      1.123  dholland 		strcpy(pb->pb_pathcopy, pb->pb_path);
    361      1.123  dholland 	}
    362      1.123  dholland 	pb->pb_pathcopyuses++;
    363      1.123  dholland 	return pb->pb_pathcopy;
    364      1.123  dholland }
    365      1.123  dholland 
    366      1.123  dholland void
    367      1.123  dholland pathbuf_stringcopy_put(struct pathbuf *pb, const char *str)
    368      1.123  dholland {
    369      1.123  dholland 	KASSERT(str == pb->pb_pathcopy);
    370      1.123  dholland 	KASSERT(pb->pb_pathcopyuses > 0);
    371      1.123  dholland 	pb->pb_pathcopyuses--;
    372      1.123  dholland 	if (pb->pb_pathcopyuses == 0) {
    373      1.123  dholland 		PNBUF_PUT(pb->pb_pathcopy);
    374      1.123  dholland 		pb->pb_pathcopy = NULL;
    375      1.123  dholland 	}
    376      1.123  dholland }
    377      1.123  dholland 
    378      1.123  dholland 
    379      1.123  dholland ////////////////////////////////////////////////////////////
    380      1.123  dholland 
    381       1.61   thorpej /*
    382      1.173  dholland  * namei: convert a pathname into a pointer to a (maybe-locked) vnode,
    383      1.173  dholland  * and maybe also its parent directory vnode, and assorted other guff.
    384      1.173  dholland  * See namei(9) for the interface documentation.
    385      1.173  dholland  *
    386       1.10       cgd  *
    387       1.10       cgd  * The FOLLOW flag is set when symbolic links are to be followed
    388       1.10       cgd  * when they occur at the end of the name translation process.
    389       1.10       cgd  * Symbolic links are always followed for all other pathname
    390       1.10       cgd  * components other than the last.
    391       1.10       cgd  *
    392       1.10       cgd  * The segflg defines whether the name is to be copied from user
    393       1.10       cgd  * space or kernel space.
    394       1.10       cgd  *
    395       1.10       cgd  * Overall outline of namei:
    396       1.10       cgd  *
    397       1.10       cgd  *	copy in name
    398       1.10       cgd  *	get starting directory
    399       1.10       cgd  *	while (!done && !error) {
    400       1.10       cgd  *		call lookup to search path.
    401       1.10       cgd  *		if symbolic link, massage name in buffer and continue
    402       1.10       cgd  *	}
    403       1.10       cgd  */
    404      1.117  dholland 
    405      1.117  dholland /*
    406      1.173  dholland  * Search a pathname.
    407      1.173  dholland  * This is a very central and rather complicated routine.
    408      1.173  dholland  *
    409      1.173  dholland  * The pathname is pointed to by ni_ptr and is of length ni_pathlen.
    410      1.173  dholland  * The starting directory is passed in. The pathname is descended
    411      1.173  dholland  * until done, or a symbolic link is encountered. The variable ni_more
    412      1.173  dholland  * is clear if the path is completed; it is set to one if a symbolic
    413      1.173  dholland  * link needing interpretation is encountered.
    414      1.173  dholland  *
    415      1.173  dholland  * The flag argument is LOOKUP, CREATE, RENAME, or DELETE depending on
    416      1.173  dholland  * whether the name is to be looked up, created, renamed, or deleted.
    417      1.173  dholland  * When CREATE, RENAME, or DELETE is specified, information usable in
    418      1.173  dholland  * creating, renaming, or deleting a directory entry may be calculated.
    419      1.173  dholland  * If flag has LOCKPARENT or'ed into it, the parent directory is returned
    420      1.173  dholland  * locked.  Otherwise the parent directory is not returned. If the target
    421      1.173  dholland  * of the pathname exists and LOCKLEAF is or'ed into the flag the target
    422      1.173  dholland  * is returned locked, otherwise it is returned unlocked.  When creating
    423      1.173  dholland  * or renaming and LOCKPARENT is specified, the target may not be ".".
    424      1.173  dholland  * When deleting and LOCKPARENT is specified, the target may be ".".
    425      1.173  dholland  *
    426      1.173  dholland  * Overall outline of lookup:
    427      1.173  dholland  *
    428      1.173  dholland  * dirloop:
    429      1.173  dholland  *	identify next component of name at ndp->ni_ptr
    430      1.173  dholland  *	handle degenerate case where name is null string
    431      1.173  dholland  *	if .. and crossing mount points and on mounted filesys, find parent
    432      1.173  dholland  *	call VOP_LOOKUP routine for next component name
    433      1.173  dholland  *	    directory vnode returned in ni_dvp, locked.
    434      1.173  dholland  *	    component vnode returned in ni_vp (if it exists), locked.
    435      1.173  dholland  *	if result vnode is mounted on and crossing mount points,
    436      1.173  dholland  *	    find mounted on vnode
    437      1.173  dholland  *	if more components of name, do next level at dirloop
    438      1.173  dholland  *	return the answer in ni_vp, locked if LOCKLEAF set
    439      1.173  dholland  *	    if LOCKPARENT set, return locked parent in ni_dvp
    440      1.173  dholland  */
    441      1.173  dholland 
    442      1.173  dholland 
    443      1.173  dholland /*
    444      1.117  dholland  * Internal state for a namei operation.
    445      1.173  dholland  *
    446      1.173  dholland  * cnp is always equal to &ndp->ni_cnp.
    447      1.117  dholland  */
    448      1.117  dholland struct namei_state {
    449      1.117  dholland 	struct nameidata *ndp;
    450      1.117  dholland 	struct componentname *cnp;
    451      1.117  dholland 
    452      1.118  dholland 	int docache;			/* == 0 do not cache last component */
    453      1.118  dholland 	int rdonly;			/* lookup read-only flag bit */
    454      1.118  dholland 	int slashes;
    455      1.137  dholland 
    456      1.137  dholland 	unsigned attempt_retry:1;	/* true if error allows emul retry */
    457      1.209   hannken 	unsigned root_referenced:1;	/* true if ndp->ni_rootdir and
    458      1.209   hannken 					     ndp->ni_erootdir were referenced */
    459      1.117  dholland };
    460      1.117  dholland 
    461      1.118  dholland 
    462      1.117  dholland /*
    463      1.117  dholland  * Initialize the namei working state.
    464      1.117  dholland  */
    465      1.117  dholland static void
    466      1.117  dholland namei_init(struct namei_state *state, struct nameidata *ndp)
    467      1.117  dholland {
    468      1.202  riastrad 
    469      1.117  dholland 	state->ndp = ndp;
    470      1.117  dholland 	state->cnp = &ndp->ni_cnd;
    471      1.117  dholland 
    472      1.118  dholland 	state->docache = 0;
    473      1.118  dholland 	state->rdonly = 0;
    474      1.118  dholland 	state->slashes = 0;
    475      1.133  dholland 
    476      1.209   hannken 	state->root_referenced = 0;
    477      1.209   hannken 
    478      1.205  riastrad 	KASSERTMSG((state->cnp->cn_cred != NULL), "namei: bad cred/proc");
    479      1.205  riastrad 	KASSERTMSG(((state->cnp->cn_nameiop & (~OPMASK)) == 0),
    480      1.205  riastrad 	    "namei: nameiop contaminated with flags: %08"PRIx32,
    481      1.205  riastrad 	    state->cnp->cn_nameiop);
    482      1.205  riastrad 	KASSERTMSG(((state->cnp->cn_flags & OPMASK) == 0),
    483      1.205  riastrad 	    "name: flags contaminated with nameiops: %08"PRIx32,
    484      1.205  riastrad 	    state->cnp->cn_flags);
    485      1.133  dholland 
    486      1.133  dholland 	/*
    487      1.133  dholland 	 * The buffer for name translation shall be the one inside the
    488      1.133  dholland 	 * pathbuf.
    489      1.133  dholland 	 */
    490      1.133  dholland 	state->ndp->ni_pnbuf = state->ndp->ni_pathbuf->pb_path;
    491      1.117  dholland }
    492      1.117  dholland 
    493      1.117  dholland /*
    494      1.117  dholland  * Clean up the working namei state, leaving things ready for return
    495      1.117  dholland  * from namei.
    496      1.117  dholland  */
    497      1.117  dholland static void
    498      1.117  dholland namei_cleanup(struct namei_state *state)
    499      1.117  dholland {
    500      1.117  dholland 	KASSERT(state->cnp == &state->ndp->ni_cnd);
    501      1.117  dholland 
    502      1.209   hannken 	if (state->root_referenced) {
    503      1.212   hannken 		if (state->ndp->ni_rootdir != NULL)
    504      1.212   hannken 			vrele(state->ndp->ni_rootdir);
    505      1.209   hannken 		if (state->ndp->ni_erootdir != NULL)
    506      1.209   hannken 			vrele(state->ndp->ni_erootdir);
    507      1.209   hannken 	}
    508      1.117  dholland }
    509      1.117  dholland 
    510      1.117  dholland //////////////////////////////
    511      1.117  dholland 
    512      1.117  dholland /*
    513      1.133  dholland  * Get the directory context.
    514      1.133  dholland  * Initializes the rootdir and erootdir state and returns a reference
    515      1.133  dholland  * to the starting dir.
    516      1.117  dholland  */
    517      1.133  dholland static struct vnode *
    518      1.196  dholland namei_getstartdir(struct namei_state *state)
    519      1.117  dholland {
    520      1.117  dholland 	struct nameidata *ndp = state->ndp;
    521      1.117  dholland 	struct componentname *cnp = state->cnp;
    522      1.117  dholland 	struct cwdinfo *cwdi;		/* pointer to cwd state */
    523      1.218        ad 	struct lwp *self = curlwp;	/* thread doing namei() */
    524      1.133  dholland 	struct vnode *rootdir, *erootdir, *curdir, *startdir;
    525      1.117  dholland 
    526      1.210   hannken 	if (state->root_referenced) {
    527      1.212   hannken 		if (state->ndp->ni_rootdir != NULL)
    528      1.212   hannken 			vrele(state->ndp->ni_rootdir);
    529      1.210   hannken 		if (state->ndp->ni_erootdir != NULL)
    530      1.210   hannken 			vrele(state->ndp->ni_erootdir);
    531      1.210   hannken 		state->root_referenced = 0;
    532      1.210   hannken 	}
    533      1.210   hannken 
    534      1.218        ad 	cwdi = self->l_proc->p_cwdi;
    535      1.218        ad 	rw_enter(&cwdi->cwdi_lock, RW_READER);
    536       1.21    kleink 
    537      1.133  dholland 	/* root dir */
    538      1.133  dholland 	if (cwdi->cwdi_rdir == NULL || (cnp->cn_flags & NOCHROOT)) {
    539      1.133  dholland 		rootdir = rootvnode;
    540      1.133  dholland 	} else {
    541      1.133  dholland 		rootdir = cwdi->cwdi_rdir;
    542       1.10       cgd 	}
    543      1.123  dholland 
    544      1.133  dholland 	/* emulation root dir, if any */
    545      1.133  dholland 	if ((cnp->cn_flags & TRYEMULROOT) == 0) {
    546      1.133  dholland 		/* if we don't want it, don't fetch it */
    547      1.133  dholland 		erootdir = NULL;
    548      1.133  dholland 	} else if (cnp->cn_flags & EMULROOTSET) {
    549      1.133  dholland 		/* explicitly set emulroot; "/../" doesn't override this */
    550      1.133  dholland 		erootdir = ndp->ni_erootdir;
    551      1.133  dholland 	} else if (!strncmp(ndp->ni_pnbuf, "/../", 4)) {
    552      1.133  dholland 		/* explicit reference to real rootdir */
    553      1.133  dholland 		erootdir = NULL;
    554      1.133  dholland 	} else {
    555      1.133  dholland 		/* may be null */
    556      1.133  dholland 		erootdir = cwdi->cwdi_edir;
    557      1.133  dholland 	}
    558       1.21    kleink 
    559      1.133  dholland 	/* current dir */
    560      1.196  dholland 	curdir = cwdi->cwdi_cdir;
    561       1.85       dsl 
    562      1.133  dholland 	if (ndp->ni_pnbuf[0] != '/') {
    563      1.198  dholland 		if (ndp->ni_atdir != NULL) {
    564      1.198  dholland 			startdir = ndp->ni_atdir;
    565      1.196  dholland 		} else {
    566      1.196  dholland 			startdir = curdir;
    567      1.196  dholland 		}
    568      1.133  dholland 		erootdir = NULL;
    569      1.133  dholland 	} else if (cnp->cn_flags & TRYEMULROOT && erootdir != NULL) {
    570      1.133  dholland 		startdir = erootdir;
    571       1.23   mycroft 	} else {
    572      1.133  dholland 		startdir = rootdir;
    573      1.133  dholland 		erootdir = NULL;
    574       1.23   mycroft 	}
    575      1.133  dholland 
    576      1.133  dholland 	state->ndp->ni_rootdir = rootdir;
    577      1.133  dholland 	state->ndp->ni_erootdir = erootdir;
    578      1.117  dholland 
    579      1.117  dholland 	/*
    580      1.133  dholland 	 * Get a reference to the start dir so we can safely unlock cwdi.
    581      1.133  dholland 	 *
    582      1.209   hannken 	 * Must hold references to rootdir and erootdir while we're running.
    583      1.209   hannken 	 * A multithreaded process may chroot during namei.
    584      1.117  dholland 	 */
    585      1.212   hannken 	if (startdir != NULL)
    586      1.212   hannken 		vref(startdir);
    587      1.212   hannken 	if (state->ndp->ni_rootdir != NULL)
    588      1.212   hannken 		vref(state->ndp->ni_rootdir);
    589      1.209   hannken 	if (state->ndp->ni_erootdir != NULL)
    590      1.209   hannken 		vref(state->ndp->ni_erootdir);
    591      1.209   hannken 	state->root_referenced = 1;
    592      1.133  dholland 
    593      1.218        ad 	rw_exit(&cwdi->cwdi_lock);
    594      1.133  dholland 	return startdir;
    595      1.133  dholland }
    596      1.133  dholland 
    597      1.133  dholland /*
    598      1.133  dholland  * Get the directory context for the nfsd case, in parallel to
    599      1.133  dholland  * getstartdir. Initializes the rootdir and erootdir state and
    600      1.173  dholland  * returns a reference to the passed-in starting dir.
    601      1.133  dholland  */
    602      1.133  dholland static struct vnode *
    603      1.196  dholland namei_getstartdir_for_nfsd(struct namei_state *state)
    604      1.133  dholland {
    605      1.198  dholland 	KASSERT(state->ndp->ni_atdir != NULL);
    606      1.193  dholland 
    607      1.133  dholland 	/* always use the real root, and never set an emulation root */
    608      1.212   hannken 	if (rootvnode == NULL) {
    609      1.212   hannken 		return NULL;
    610      1.212   hannken 	}
    611      1.133  dholland 	state->ndp->ni_rootdir = rootvnode;
    612      1.133  dholland 	state->ndp->ni_erootdir = NULL;
    613      1.133  dholland 
    614      1.198  dholland 	vref(state->ndp->ni_atdir);
    615      1.209   hannken 	KASSERT(! state->root_referenced);
    616      1.209   hannken 	vref(state->ndp->ni_rootdir);
    617      1.209   hannken 	state->root_referenced = 1;
    618      1.198  dholland 	return state->ndp->ni_atdir;
    619      1.133  dholland }
    620      1.133  dholland 
    621      1.133  dholland 
    622      1.133  dholland /*
    623      1.133  dholland  * Ktrace the namei operation.
    624      1.133  dholland  */
    625      1.133  dholland static void
    626      1.133  dholland namei_ktrace(struct namei_state *state)
    627      1.133  dholland {
    628      1.133  dholland 	struct nameidata *ndp = state->ndp;
    629      1.133  dholland 	struct componentname *cnp = state->cnp;
    630      1.133  dholland 	struct lwp *self = curlwp;	/* thread doing namei() */
    631      1.133  dholland 	const char *emul_path;
    632      1.133  dholland 
    633       1.97        ad 	if (ktrpoint(KTR_NAMEI)) {
    634       1.90       dsl 		if (ndp->ni_erootdir != NULL) {
    635       1.89       dsl 			/*
    636       1.89       dsl 			 * To make any sense, the trace entry need to have the
    637       1.89       dsl 			 * text of the emulation path prepended.
    638       1.89       dsl 			 * Usually we can get this from the current process,
    639       1.89       dsl 			 * but when called from emul_find_interp() it is only
    640       1.89       dsl 			 * in the exec_package - so we get it passed in ni_next
    641       1.89       dsl 			 * (this is a hack).
    642       1.89       dsl 			 */
    643       1.88       dsl 			if (cnp->cn_flags & EMULROOTSET)
    644       1.89       dsl 				emul_path = ndp->ni_next;
    645       1.88       dsl 			else
    646      1.117  dholland 				emul_path = self->l_proc->p_emul->e_path;
    647       1.97        ad 			ktrnamei2(emul_path, strlen(emul_path),
    648      1.124  dholland 			    ndp->ni_pnbuf, ndp->ni_pathlen);
    649       1.88       dsl 		} else
    650      1.124  dholland 			ktrnamei(ndp->ni_pnbuf, ndp->ni_pathlen);
    651       1.88       dsl 	}
    652      1.133  dholland }
    653      1.133  dholland 
    654      1.133  dholland /*
    655      1.166  dholland  * Start up namei. Find the root dir and cwd, establish the starting
    656      1.166  dholland  * directory for lookup, and lock it. Also calls ktrace when
    657      1.133  dholland  * appropriate.
    658      1.133  dholland  */
    659      1.133  dholland static int
    660      1.196  dholland namei_start(struct namei_state *state, int isnfsd,
    661      1.140  dholland 	    struct vnode **startdir_ret)
    662      1.133  dholland {
    663      1.133  dholland 	struct nameidata *ndp = state->ndp;
    664      1.140  dholland 	struct vnode *startdir;
    665      1.133  dholland 
    666      1.133  dholland 	/* length includes null terminator (was originally from copyinstr) */
    667      1.133  dholland 	ndp->ni_pathlen = strlen(ndp->ni_pnbuf) + 1;
    668      1.133  dholland 
    669      1.133  dholland 	/*
    670      1.133  dholland 	 * POSIX.1 requirement: "" is not a valid file name.
    671      1.133  dholland 	 */
    672      1.133  dholland 	if (ndp->ni_pathlen == 1) {
    673      1.211      maxv 		ndp->ni_erootdir = NULL;
    674      1.133  dholland 		return ENOENT;
    675      1.133  dholland 	}
    676      1.133  dholland 
    677      1.133  dholland 	ndp->ni_loopcnt = 0;
    678      1.133  dholland 
    679      1.133  dholland 	/* Get starting directory, set up root, and ktrace. */
    680      1.193  dholland 	if (isnfsd) {
    681      1.196  dholland 		startdir = namei_getstartdir_for_nfsd(state);
    682      1.133  dholland 		/* no ktrace */
    683      1.133  dholland 	} else {
    684      1.196  dholland 		startdir = namei_getstartdir(state);
    685      1.133  dholland 		namei_ktrace(state);
    686      1.133  dholland 	}
    687       1.97        ad 
    688      1.212   hannken 	if (startdir == NULL) {
    689      1.212   hannken 		return ENOENT;
    690      1.212   hannken 	}
    691      1.212   hannken 
    692      1.200      manu 	/* NDAT may feed us with a non directory namei_getstartdir */
    693      1.208  dholland 	if (startdir->v_type != VDIR) {
    694      1.208  dholland 		vrele(startdir);
    695      1.200      manu 		return ENOTDIR;
    696      1.208  dholland 	}
    697      1.200      manu 
    698      1.140  dholland 	*startdir_ret = startdir;
    699      1.117  dholland 	return 0;
    700      1.117  dholland }
    701      1.117  dholland 
    702      1.117  dholland /*
    703      1.173  dholland  * Check for being at a symlink that we're going to follow.
    704      1.117  dholland  */
    705      1.117  dholland static inline int
    706      1.144  dholland namei_atsymlink(struct namei_state *state, struct vnode *foundobj)
    707      1.117  dholland {
    708      1.144  dholland 	return (foundobj->v_type == VLNK) &&
    709      1.139  dholland 		(state->cnp->cn_flags & (FOLLOW|REQUIREDIR));
    710      1.117  dholland }
    711      1.117  dholland 
    712      1.117  dholland /*
    713      1.117  dholland  * Follow a symlink.
    714      1.173  dholland  *
    715      1.173  dholland  * Updates searchdir. inhibitmagic causes magic symlinks to not be
    716      1.173  dholland  * interpreted; this is used by nfsd.
    717      1.174  jakllsch  *
    718      1.174  jakllsch  * Unlocks foundobj on success (ugh)
    719      1.117  dholland  */
    720      1.117  dholland static inline int
    721      1.141  dholland namei_follow(struct namei_state *state, int inhibitmagic,
    722      1.161  dholland 	     struct vnode *searchdir, struct vnode *foundobj,
    723      1.141  dholland 	     struct vnode **newsearchdir_ret)
    724      1.117  dholland {
    725      1.117  dholland 	struct nameidata *ndp = state->ndp;
    726      1.117  dholland 	struct componentname *cnp = state->cnp;
    727      1.117  dholland 
    728      1.117  dholland 	struct lwp *self = curlwp;	/* thread doing namei() */
    729      1.117  dholland 	struct iovec aiov;		/* uio for reading symbolic links */
    730      1.117  dholland 	struct uio auio;
    731      1.117  dholland 	char *cp;			/* pointer into pathname argument */
    732      1.117  dholland 	size_t linklen;
    733      1.117  dholland 	int error;
    734      1.117  dholland 
    735      1.117  dholland 	if (ndp->ni_loopcnt++ >= MAXSYMLINKS) {
    736      1.117  dholland 		return ELOOP;
    737      1.117  dholland 	}
    738      1.215        ad 
    739      1.215        ad 	vn_lock(foundobj, LK_EXCLUSIVE | LK_RETRY);
    740      1.161  dholland 	if (foundobj->v_mount->mnt_flag & MNT_SYMPERM) {
    741      1.161  dholland 		error = VOP_ACCESS(foundobj, VEXEC, cnp->cn_cred);
    742      1.215        ad 		if (error != 0) {
    743      1.215        ad 			VOP_UNLOCK(foundobj);
    744      1.117  dholland 			return error;
    745      1.215        ad 		}
    746      1.117  dholland 	}
    747      1.124  dholland 
    748      1.124  dholland 	/* FUTURE: fix this to not use a second buffer */
    749      1.124  dholland 	cp = PNBUF_GET();
    750      1.117  dholland 	aiov.iov_base = cp;
    751      1.117  dholland 	aiov.iov_len = MAXPATHLEN;
    752      1.117  dholland 	auio.uio_iov = &aiov;
    753      1.117  dholland 	auio.uio_iovcnt = 1;
    754      1.117  dholland 	auio.uio_offset = 0;
    755      1.117  dholland 	auio.uio_rw = UIO_READ;
    756      1.117  dholland 	auio.uio_resid = MAXPATHLEN;
    757      1.117  dholland 	UIO_SETUP_SYSSPACE(&auio);
    758      1.161  dholland 	error = VOP_READLINK(foundobj, &auio, cnp->cn_cred);
    759      1.215        ad 	VOP_UNLOCK(foundobj);
    760      1.117  dholland 	if (error) {
    761      1.124  dholland 		PNBUF_PUT(cp);
    762      1.117  dholland 		return error;
    763      1.117  dholland 	}
    764      1.117  dholland 	linklen = MAXPATHLEN - auio.uio_resid;
    765      1.117  dholland 	if (linklen == 0) {
    766      1.124  dholland 		PNBUF_PUT(cp);
    767      1.124  dholland 		return ENOENT;
    768      1.117  dholland 	}
    769      1.117  dholland 
    770      1.117  dholland 	/*
    771      1.117  dholland 	 * Do symlink substitution, if appropriate, and
    772      1.117  dholland 	 * check length for potential overflow.
    773      1.134  dholland 	 *
    774      1.134  dholland 	 * Inhibit symlink substitution for nfsd.
    775      1.134  dholland 	 * XXX: This is how it was before; is that a bug or a feature?
    776      1.117  dholland 	 */
    777      1.134  dholland 	if ((!inhibitmagic && vfs_magiclinks &&
    778      1.117  dholland 	     symlink_magic(self->l_proc, cp, &linklen)) ||
    779      1.117  dholland 	    (linklen + ndp->ni_pathlen >= MAXPATHLEN)) {
    780      1.124  dholland 		PNBUF_PUT(cp);
    781      1.124  dholland 		return ENAMETOOLONG;
    782      1.117  dholland 	}
    783      1.117  dholland 	if (ndp->ni_pathlen > 1) {
    784      1.124  dholland 		/* includes a null-terminator */
    785      1.117  dholland 		memcpy(cp + linklen, ndp->ni_next, ndp->ni_pathlen);
    786      1.124  dholland 	} else {
    787      1.124  dholland 		cp[linklen] = '\0';
    788      1.124  dholland 	}
    789      1.117  dholland 	ndp->ni_pathlen += linklen;
    790      1.124  dholland 	memcpy(ndp->ni_pnbuf, cp, ndp->ni_pathlen);
    791      1.124  dholland 	PNBUF_PUT(cp);
    792      1.167  dholland 
    793      1.167  dholland 	/* we're now starting from the beginning of the buffer again */
    794      1.167  dholland 	cnp->cn_nameptr = ndp->ni_pnbuf;
    795      1.117  dholland 
    796      1.117  dholland 	/*
    797      1.117  dholland 	 * Check if root directory should replace current directory.
    798      1.117  dholland 	 */
    799      1.124  dholland 	if (ndp->ni_pnbuf[0] == '/') {
    800      1.215        ad 		vrele(searchdir);
    801      1.117  dholland 		/* Keep absolute symbolic links inside emulation root */
    802      1.141  dholland 		searchdir = ndp->ni_erootdir;
    803      1.141  dholland 		if (searchdir == NULL ||
    804      1.223  riastrad 		    (ndp->ni_pnbuf[1] == '.'
    805      1.124  dholland 		     && ndp->ni_pnbuf[2] == '.'
    806      1.124  dholland 		     && ndp->ni_pnbuf[3] == '/')) {
    807      1.117  dholland 			ndp->ni_erootdir = NULL;
    808      1.141  dholland 			searchdir = ndp->ni_rootdir;
    809      1.117  dholland 		}
    810      1.141  dholland 		vref(searchdir);
    811      1.186  dholland 		while (cnp->cn_nameptr[0] == '/') {
    812      1.186  dholland 			cnp->cn_nameptr++;
    813      1.186  dholland 			ndp->ni_pathlen--;
    814      1.186  dholland 		}
    815      1.117  dholland 	}
    816      1.117  dholland 
    817      1.141  dholland 	*newsearchdir_ret = searchdir;
    818      1.117  dholland 	return 0;
    819      1.117  dholland }
    820      1.117  dholland 
    821      1.117  dholland //////////////////////////////
    822      1.117  dholland 
    823       1.39     lukem /*
    824      1.173  dholland  * Inspect the leading path component and update the state accordingly.
    825       1.10       cgd  */
    826      1.118  dholland static int
    827  1.225.4.2   thorpej lookup_parsepath(struct namei_state *state, struct vnode *searchdir)
    828      1.118  dholland {
    829      1.118  dholland 	const char *cp;			/* pointer into pathname argument */
    830  1.225.4.2   thorpej 	int error;
    831      1.118  dholland 
    832      1.118  dholland 	struct componentname *cnp = state->cnp;
    833      1.118  dholland 	struct nameidata *ndp = state->ndp;
    834      1.118  dholland 
    835      1.118  dholland 	KASSERT(cnp == &ndp->ni_cnd);
    836      1.118  dholland 
    837       1.10       cgd 	/*
    838       1.10       cgd 	 * Search a new directory.
    839       1.10       cgd 	 *
    840       1.10       cgd 	 * The last component of the filename is left accessible via
    841       1.12   mycroft 	 * cnp->cn_nameptr for callers that need the name. Callers needing
    842       1.10       cgd 	 * the name set the SAVENAME flag. When done, they assume
    843       1.10       cgd 	 * responsibility for freeing the pathname buffer.
    844      1.127      yamt 	 *
    845      1.147  dholland 	 * At this point, our only vnode state is that the search dir
    846      1.215        ad 	 * is held.
    847       1.10       cgd 	 */
    848  1.225.4.2   thorpej 	error = VOP_PARSEPATH(searchdir, cnp->cn_nameptr, &cnp->cn_namelen);
    849  1.225.4.2   thorpej 	if (error) {
    850  1.225.4.2   thorpej 		return error;
    851  1.225.4.2   thorpej 	}
    852      1.197  dholland 	cp = cnp->cn_nameptr + cnp->cn_namelen;
    853      1.191  christos 	if (cnp->cn_namelen > KERNEL_NAME_MAX) {
    854      1.118  dholland 		return ENAMETOOLONG;
    855       1.10       cgd 	}
    856       1.10       cgd #ifdef NAMEI_DIAGNOSTIC
    857       1.10       cgd 	{ char c = *cp;
    858       1.41     soren 	*(char *)cp = '\0';
    859       1.19  christos 	printf("{%s}: ", cnp->cn_nameptr);
    860       1.41     soren 	*(char *)cp = c; }
    861       1.52      yamt #endif /* NAMEI_DIAGNOSTIC */
    862       1.12   mycroft 	ndp->ni_pathlen -= cnp->cn_namelen;
    863       1.10       cgd 	ndp->ni_next = cp;
    864       1.23   mycroft 	/*
    865       1.23   mycroft 	 * If this component is followed by a slash, then move the pointer to
    866       1.23   mycroft 	 * the next component forward, and remember that this component must be
    867       1.23   mycroft 	 * a directory.
    868       1.23   mycroft 	 */
    869       1.23   mycroft 	if (*cp == '/') {
    870       1.23   mycroft 		do {
    871       1.23   mycroft 			cp++;
    872       1.23   mycroft 		} while (*cp == '/');
    873      1.118  dholland 		state->slashes = cp - ndp->ni_next;
    874      1.118  dholland 		ndp->ni_pathlen -= state->slashes;
    875       1.23   mycroft 		ndp->ni_next = cp;
    876       1.23   mycroft 		cnp->cn_flags |= REQUIREDIR;
    877       1.23   mycroft 	} else {
    878      1.118  dholland 		state->slashes = 0;
    879       1.23   mycroft 		cnp->cn_flags &= ~REQUIREDIR;
    880       1.23   mycroft 	}
    881       1.23   mycroft 	/*
    882       1.23   mycroft 	 * We do special processing on the last component, whether or not it's
    883       1.23   mycroft 	 * a directory.  Cache all intervening lookups, but not the final one.
    884       1.23   mycroft 	 */
    885       1.23   mycroft 	if (*cp == '\0') {
    886      1.118  dholland 		if (state->docache)
    887       1.23   mycroft 			cnp->cn_flags |= MAKEENTRY;
    888       1.23   mycroft 		else
    889       1.23   mycroft 			cnp->cn_flags &= ~MAKEENTRY;
    890       1.23   mycroft 		cnp->cn_flags |= ISLASTCN;
    891       1.23   mycroft 	} else {
    892       1.23   mycroft 		cnp->cn_flags |= MAKEENTRY;
    893       1.23   mycroft 		cnp->cn_flags &= ~ISLASTCN;
    894       1.23   mycroft 	}
    895       1.12   mycroft 	if (cnp->cn_namelen == 2 &&
    896       1.12   mycroft 	    cnp->cn_nameptr[1] == '.' && cnp->cn_nameptr[0] == '.')
    897       1.12   mycroft 		cnp->cn_flags |= ISDOTDOT;
    898       1.12   mycroft 	else
    899       1.12   mycroft 		cnp->cn_flags &= ~ISDOTDOT;
    900       1.10       cgd 
    901      1.118  dholland 	return 0;
    902      1.118  dholland }
    903      1.118  dholland 
    904      1.173  dholland /*
    905      1.215        ad  * Take care of crossing a mounted-on vnode.  On error, foundobj_ret will be
    906      1.215        ad  * vrele'd, but searchdir is left alone.
    907      1.215        ad  */
    908      1.215        ad static int
    909      1.215        ad lookup_crossmount(struct namei_state *state,
    910      1.215        ad 		  struct vnode **searchdir_ret,
    911      1.215        ad 		  struct vnode **foundobj_ret,
    912      1.215        ad 		  bool *searchdir_locked)
    913      1.215        ad {
    914      1.215        ad 	struct componentname *cnp = state->cnp;
    915      1.221        ad 	struct vnode *foundobj, *vp;
    916      1.215        ad 	struct vnode *searchdir;
    917      1.215        ad 	struct mount *mp;
    918      1.215        ad 	int error, lktype;
    919      1.215        ad 
    920      1.215        ad 	searchdir = *searchdir_ret;
    921      1.215        ad 	foundobj = *foundobj_ret;
    922      1.215        ad 	error = 0;
    923      1.215        ad 
    924      1.215        ad 	KASSERT((cnp->cn_flags & NOCROSSMOUNT) == 0);
    925      1.215        ad 
    926      1.215        ad 	/* First, unlock searchdir (oof). */
    927      1.215        ad 	if (*searchdir_locked) {
    928      1.222        ad 		KASSERT(searchdir != NULL);
    929      1.215        ad 		lktype = VOP_ISLOCKED(searchdir);
    930      1.215        ad 		VOP_UNLOCK(searchdir);
    931      1.215        ad 		*searchdir_locked = false;
    932      1.215        ad 	} else {
    933      1.215        ad 		lktype = LK_NONE;
    934      1.215        ad 	}
    935      1.215        ad 
    936      1.215        ad 	/*
    937      1.215        ad 	 * Do an unlocked check to see if the vnode has been mounted on; if
    938      1.215        ad 	 * so find the root of the mounted file system.
    939      1.215        ad 	 */
    940      1.215        ad 	while (foundobj->v_type == VDIR &&
    941      1.215        ad 	    (mp = foundobj->v_mountedhere) != NULL &&
    942      1.215        ad 	    (cnp->cn_flags & NOCROSSMOUNT) == 0) {
    943      1.215        ad 		KASSERTMSG(searchdir != foundobj, "same vn %p", searchdir);
    944      1.221        ad 
    945      1.215        ad 		/*
    946      1.221        ad 		 * Try the namecache first.  If that doesn't work, do
    947      1.221        ad 		 * it the hard way.
    948      1.215        ad 		 */
    949      1.221        ad 		if (cache_lookup_mount(foundobj, &vp)) {
    950      1.215        ad 			vrele(foundobj);
    951      1.221        ad 			foundobj = vp;
    952      1.221        ad 		} else {
    953      1.221        ad 			/* First get the vnode stable. */
    954      1.221        ad 			error = vn_lock(foundobj, LK_SHARED);
    955      1.221        ad 			if (error != 0) {
    956      1.221        ad 				vrele(foundobj);
    957      1.221        ad 				foundobj = NULL;
    958      1.221        ad 				break;
    959      1.221        ad 			}
    960      1.221        ad 
    961      1.223  riastrad 			/*
    962      1.221        ad 			 * Check to see if something is still mounted on it.
    963      1.221        ad 			 */
    964      1.221        ad 			if ((mp = foundobj->v_mountedhere) == NULL) {
    965      1.221        ad 				VOP_UNLOCK(foundobj);
    966      1.221        ad 				break;
    967      1.221        ad 			}
    968      1.215        ad 
    969      1.221        ad 			/*
    970      1.221        ad 			 * Get a reference to the mountpoint, and unlock
    971      1.221        ad 			 * foundobj.
    972      1.221        ad 			 */
    973      1.221        ad 			error = vfs_busy(mp);
    974      1.215        ad 			VOP_UNLOCK(foundobj);
    975      1.221        ad 			if (error != 0) {
    976      1.221        ad 				vrele(foundobj);
    977      1.221        ad 				foundobj = NULL;
    978      1.221        ad 				break;
    979      1.221        ad 			}
    980      1.221        ad 
    981      1.221        ad 			/*
    982      1.221        ad 			 * Now get a reference on the root vnode.
    983      1.221        ad 			 * XXX Future - maybe allow only VDIR here.
    984      1.221        ad 			 */
    985      1.221        ad 			error = VFS_ROOT(mp, LK_NONE, &vp);
    986      1.215        ad 
    987      1.221        ad 			/*
    988      1.221        ad 			 * If successful, enter it into the cache while
    989      1.221        ad 			 * holding the mount busy (competing with unmount).
    990      1.221        ad 			 */
    991      1.221        ad 			if (error == 0) {
    992      1.221        ad 				cache_enter_mount(foundobj, vp);
    993      1.221        ad 			}
    994      1.215        ad 
    995      1.221        ad 			/* Finally, drop references to foundobj & mountpoint. */
    996      1.221        ad 			vrele(foundobj);
    997      1.221        ad 			vfs_unbusy(mp);
    998      1.221        ad 			if (error) {
    999      1.221        ad 				foundobj = NULL;
   1000      1.221        ad 				break;
   1001      1.221        ad 			}
   1002      1.221        ad 			foundobj = vp;
   1003      1.215        ad 		}
   1004      1.215        ad 
   1005      1.215        ad 		/*
   1006      1.215        ad 		 * Avoid locking vnodes from two filesystems because
   1007      1.215        ad 		 * it's prone to deadlock, e.g. when using puffs.
   1008      1.215        ad 		 * Also, it isn't a good idea to propagate slowness of
   1009      1.215        ad 		 * a filesystem up to the root directory. For now,
   1010      1.215        ad 		 * only handle the common case, where foundobj is
   1011      1.215        ad 		 * VDIR.
   1012      1.215        ad 		 *
   1013      1.215        ad 		 * In this case set searchdir to null to avoid using
   1014      1.215        ad 		 * it again. It is not correct to set searchdir ==
   1015      1.215        ad 		 * foundobj here as that will confuse the caller.
   1016      1.215        ad 		 * (See PR 40740.)
   1017      1.215        ad 		 */
   1018      1.215        ad 		if (searchdir == NULL) {
   1019      1.215        ad 			/* already been here once; do nothing further */
   1020      1.215        ad 		} else if (foundobj->v_type == VDIR) {
   1021      1.215        ad 			vrele(searchdir);
   1022      1.215        ad 			*searchdir_ret = searchdir = NULL;
   1023      1.215        ad 			lktype = LK_NONE;
   1024      1.215        ad 		}
   1025      1.215        ad 	}
   1026      1.215        ad 
   1027      1.215        ad 	/* If searchdir is still around, re-lock it. */
   1028      1.215        ad  	if (error == 0 && lktype != LK_NONE) {
   1029      1.215        ad 		vn_lock(searchdir, lktype | LK_RETRY);
   1030      1.215        ad 		*searchdir_locked = true;
   1031      1.215        ad 	}
   1032      1.216        ad 	*foundobj_ret = foundobj;
   1033      1.215        ad 	return error;
   1034      1.215        ad }
   1035      1.215        ad 
   1036      1.215        ad /*
   1037      1.225       chs  * Determine the desired locking mode for the directory of a lookup.
   1038      1.225       chs  */
   1039      1.225       chs static int
   1040      1.225       chs lookup_lktype(struct vnode *searchdir, struct componentname *cnp)
   1041      1.225       chs {
   1042      1.225       chs 
   1043      1.225       chs 	/*
   1044      1.225       chs 	 * If the file system supports VOP_LOOKUP() with a shared lock, and
   1045      1.225       chs 	 * we are not making any modifications (nameiop LOOKUP) or this is
   1046      1.225       chs 	 * not the last component then get a shared lock.  Where we can't do
   1047      1.225       chs 	 * fast-forwarded lookups (for example with layered file systems)
   1048      1.225       chs 	 * then this is the fallback for reducing lock contention.
   1049      1.225       chs 	 */
   1050      1.225       chs 	if ((searchdir->v_mount->mnt_iflag & IMNT_SHRLOOKUP) != 0 &&
   1051      1.225       chs 	    (cnp->cn_nameiop == LOOKUP || (cnp->cn_flags & ISLASTCN) == 0)) {
   1052      1.225       chs 		return LK_SHARED;
   1053      1.225       chs 	} else {
   1054      1.225       chs 		return LK_EXCLUSIVE;
   1055      1.225       chs 	}
   1056      1.225       chs }
   1057      1.225       chs 
   1058      1.225       chs /*
   1059      1.173  dholland  * Call VOP_LOOKUP for a single lookup; return a new search directory
   1060      1.223  riastrad  * (used when crossing mountpoints up or searching union mounts down) and
   1061      1.173  dholland  * the found object, which for create operations may be NULL on success.
   1062      1.204  dholland  *
   1063      1.204  dholland  * Note that the new search directory may be null, which means the
   1064      1.204  dholland  * searchdir was unlocked and released. This happens in the common case
   1065      1.204  dholland  * when crossing a mount point downwards, in order to avoid coupling
   1066      1.204  dholland  * locks between different file system volumes. Importantly, this can
   1067      1.204  dholland  * happen even if the call fails. (XXX: this is gross and should be
   1068      1.204  dholland  * tidied somehow.)
   1069      1.173  dholland  */
   1070      1.118  dholland static int
   1071      1.147  dholland lookup_once(struct namei_state *state,
   1072      1.147  dholland 	    struct vnode *searchdir,
   1073      1.150  dholland 	    struct vnode **newsearchdir_ret,
   1074      1.215        ad 	    struct vnode **foundobj_ret,
   1075      1.215        ad 	    bool *newsearchdir_locked_ret)
   1076      1.118  dholland {
   1077      1.163  dholland 	struct vnode *tmpvn;		/* scratch vnode */
   1078      1.163  dholland 	struct vnode *foundobj;		/* result */
   1079      1.118  dholland 	struct lwp *l = curlwp;
   1080      1.215        ad 	bool searchdir_locked = false;
   1081      1.215        ad 	int error, lktype;
   1082      1.118  dholland 
   1083      1.118  dholland 	struct componentname *cnp = state->cnp;
   1084      1.118  dholland 	struct nameidata *ndp = state->ndp;
   1085      1.118  dholland 
   1086      1.118  dholland 	KASSERT(cnp == &ndp->ni_cnd);
   1087      1.154  dholland 	*newsearchdir_ret = searchdir;
   1088      1.118  dholland 
   1089       1.10       cgd 	/*
   1090       1.10       cgd 	 * Handle "..": two special cases.
   1091       1.10       cgd 	 * 1. If at root directory (e.g. after chroot)
   1092       1.12   mycroft 	 *    or at absolute root directory
   1093       1.10       cgd 	 *    then ignore it so can't get out.
   1094       1.85       dsl 	 * 1a. If at the root of the emulation filesystem go to the real
   1095       1.85       dsl 	 *    root. So "/../<path>" is always absolute.
   1096       1.85       dsl 	 * 1b. If we have somehow gotten out of a jail, warn
   1097       1.40  wrstuden 	 *    and also ignore it so we can't get farther out.
   1098       1.10       cgd 	 * 2. If this vnode is the root of a mounted
   1099       1.10       cgd 	 *    filesystem, then replace it with the
   1100       1.10       cgd 	 *    vnode which was mounted on so we take the
   1101       1.10       cgd 	 *    .. in the other file system.
   1102       1.10       cgd 	 */
   1103       1.12   mycroft 	if (cnp->cn_flags & ISDOTDOT) {
   1104       1.64  christos 		struct proc *p = l->l_proc;
   1105       1.64  christos 
   1106       1.10       cgd 		for (;;) {
   1107      1.154  dholland 			if (searchdir == ndp->ni_rootdir ||
   1108      1.154  dholland 			    searchdir == rootvnode) {
   1109      1.147  dholland 				foundobj = searchdir;
   1110      1.147  dholland 				vref(foundobj);
   1111      1.147  dholland 				*foundobj_ret = foundobj;
   1112      1.225       chs 				if (cnp->cn_flags & LOCKPARENT) {
   1113      1.225       chs 					lktype = lookup_lktype(searchdir, cnp);
   1114      1.225       chs 					vn_lock(searchdir, lktype | LK_RETRY);
   1115      1.225       chs 					searchdir_locked = true;
   1116      1.225       chs 				}
   1117      1.175      yamt 				error = 0;
   1118      1.175      yamt 				goto done;
   1119       1.40  wrstuden 			}
   1120       1.40  wrstuden 			if (ndp->ni_rootdir != rootvnode) {
   1121       1.40  wrstuden 				int retval;
   1122       1.73       chs 
   1123      1.147  dholland 				retval = vn_isunder(searchdir, ndp->ni_rootdir, l);
   1124       1.40  wrstuden 				if (!retval) {
   1125       1.40  wrstuden 				    /* Oops! We got out of jail! */
   1126       1.40  wrstuden 				    log(LOG_WARNING,
   1127       1.40  wrstuden 					"chrooted pid %d uid %d (%s) "
   1128       1.40  wrstuden 					"detected outside of its chroot\n",
   1129       1.71        ad 					p->p_pid, kauth_cred_geteuid(l->l_cred),
   1130       1.64  christos 					p->p_comm);
   1131       1.40  wrstuden 				    /* Put us at the jail root. */
   1132      1.215        ad 				    vrele(searchdir);
   1133      1.147  dholland 				    searchdir = NULL;
   1134      1.147  dholland 				    foundobj = ndp->ni_rootdir;
   1135      1.147  dholland 				    vref(foundobj);
   1136      1.147  dholland 				    vref(foundobj);
   1137      1.150  dholland 				    *newsearchdir_ret = foundobj;
   1138      1.147  dholland 				    *foundobj_ret = foundobj;
   1139      1.175      yamt 				    error = 0;
   1140      1.175      yamt 				    goto done;
   1141       1.40  wrstuden 				}
   1142       1.10       cgd 			}
   1143      1.147  dholland 			if ((searchdir->v_vflag & VV_ROOT) == 0 ||
   1144       1.12   mycroft 			    (cnp->cn_flags & NOCROSSMOUNT))
   1145       1.10       cgd 				break;
   1146      1.163  dholland 			tmpvn = searchdir;
   1147      1.147  dholland 			searchdir = searchdir->v_mount->mnt_vnodecovered;
   1148      1.153  dholland 			vref(searchdir);
   1149      1.215        ad 			vrele(tmpvn);
   1150      1.154  dholland 			*newsearchdir_ret = searchdir;
   1151       1.10       cgd 		}
   1152       1.10       cgd 	}
   1153       1.10       cgd 
   1154      1.225       chs 	lktype = lookup_lktype(searchdir, cnp);
   1155      1.215        ad 
   1156      1.215        ad 	/*
   1157       1.10       cgd 	 * We now have a segment name to search for, and a directory to search.
   1158      1.215        ad 	 * Our vnode state here is that "searchdir" is held.
   1159       1.10       cgd 	 */
   1160       1.12   mycroft unionlookup:
   1161      1.148  dholland 	foundobj = NULL;
   1162      1.215        ad 	if (!searchdir_locked) {
   1163      1.215        ad 		vn_lock(searchdir, lktype | LK_RETRY);
   1164      1.215        ad 		searchdir_locked = true;
   1165      1.215        ad 	}
   1166      1.148  dholland 	error = VOP_LOOKUP(searchdir, &foundobj, cnp);
   1167      1.154  dholland 
   1168       1.73       chs 	if (error != 0) {
   1169      1.205  riastrad 		KASSERTMSG((foundobj == NULL),
   1170      1.205  riastrad 		    "leaf `%s' should be empty but is %p",
   1171      1.205  riastrad 		    cnp->cn_nameptr, foundobj);
   1172       1.10       cgd #ifdef NAMEI_DIAGNOSTIC
   1173       1.19  christos 		printf("not found\n");
   1174       1.52      yamt #endif /* NAMEI_DIAGNOSTIC */
   1175      1.215        ad 
   1176      1.215        ad 		/*
   1177      1.215        ad 		 * If ENOLCK, the file system needs us to retry the lookup
   1178      1.215        ad 		 * with an exclusive lock.  It's likely nothing was found in
   1179      1.215        ad 		 * cache and/or modifications need to be made.
   1180      1.215        ad 		 */
   1181      1.215        ad 		if (error == ENOLCK) {
   1182      1.215        ad 			KASSERT(VOP_ISLOCKED(searchdir) == LK_SHARED);
   1183      1.215        ad 			KASSERT(searchdir_locked);
   1184      1.215        ad 			if (vn_lock(searchdir, LK_UPGRADE | LK_NOWAIT)) {
   1185      1.215        ad 				VOP_UNLOCK(searchdir);
   1186      1.215        ad 				searchdir_locked = false;
   1187      1.215        ad 			}
   1188      1.215        ad 			lktype = LK_EXCLUSIVE;
   1189      1.215        ad 			goto unionlookup;
   1190      1.215        ad 		}
   1191      1.215        ad 
   1192       1.12   mycroft 		if ((error == ENOENT) &&
   1193      1.147  dholland 		    (searchdir->v_vflag & VV_ROOT) &&
   1194      1.147  dholland 		    (searchdir->v_mount->mnt_flag & MNT_UNION)) {
   1195      1.163  dholland 			tmpvn = searchdir;
   1196      1.147  dholland 			searchdir = searchdir->v_mount->mnt_vnodecovered;
   1197      1.153  dholland 			vref(searchdir);
   1198      1.163  dholland 			vput(tmpvn);
   1199      1.215        ad 			searchdir_locked = false;
   1200      1.154  dholland 			*newsearchdir_ret = searchdir;
   1201       1.12   mycroft 			goto unionlookup;
   1202       1.10       cgd 		}
   1203       1.12   mycroft 
   1204       1.10       cgd 		if (error != EJUSTRETURN)
   1205      1.175      yamt 			goto done;
   1206       1.73       chs 
   1207       1.10       cgd 		/*
   1208       1.23   mycroft 		 * If this was not the last component, or there were trailing
   1209       1.51  christos 		 * slashes, and we are not going to create a directory,
   1210       1.51  christos 		 * then the name must exist.
   1211       1.23   mycroft 		 */
   1212       1.51  christos 		if ((cnp->cn_flags & (REQUIREDIR | CREATEDIR)) == REQUIREDIR) {
   1213      1.175      yamt 			error = ENOENT;
   1214      1.175      yamt 			goto done;
   1215       1.23   mycroft 		}
   1216       1.73       chs 
   1217       1.23   mycroft 		/*
   1218       1.10       cgd 		 * If creating and at end of pathname, then can consider
   1219       1.10       cgd 		 * allowing file to be created.
   1220       1.10       cgd 		 */
   1221      1.118  dholland 		if (state->rdonly) {
   1222      1.175      yamt 			error = EROFS;
   1223      1.175      yamt 			goto done;
   1224       1.10       cgd 		}
   1225       1.73       chs 
   1226       1.10       cgd 		/*
   1227      1.166  dholland 		 * We return success and a NULL foundobj to indicate
   1228      1.166  dholland 		 * that the entry doesn't currently exist, leaving a
   1229      1.173  dholland 		 * pointer to the (normally, locked) directory vnode
   1230      1.173  dholland 		 * as searchdir.
   1231       1.10       cgd 		 */
   1232      1.147  dholland 		*foundobj_ret = NULL;
   1233      1.175      yamt 		error = 0;
   1234      1.175      yamt 		goto done;
   1235       1.10       cgd 	}
   1236       1.10       cgd #ifdef NAMEI_DIAGNOSTIC
   1237       1.19  christos 	printf("found\n");
   1238       1.52      yamt #endif /* NAMEI_DIAGNOSTIC */
   1239       1.10       cgd 
   1240      1.215        ad 	/* Unlock, unless the caller needs the parent locked. */
   1241      1.215        ad 	if (searchdir != NULL) {
   1242      1.215        ad 		KASSERT(searchdir_locked);
   1243      1.215        ad 		if ((cnp->cn_flags & (ISLASTCN | LOCKPARENT)) !=
   1244      1.215        ad 		    (ISLASTCN | LOCKPARENT)) {
   1245      1.215        ad 		    	VOP_UNLOCK(searchdir);
   1246      1.215        ad 		    	searchdir_locked = false;
   1247      1.201   hannken 		}
   1248      1.215        ad 	} else {
   1249      1.215        ad 		KASSERT(!searchdir_locked);
   1250      1.201   hannken 	}
   1251       1.73       chs 
   1252      1.215        ad 	*foundobj_ret = foundobj;
   1253      1.215        ad 	error = 0;
   1254      1.215        ad done:
   1255      1.215        ad 	*newsearchdir_locked_ret = searchdir_locked;
   1256      1.215        ad 	return error;
   1257      1.215        ad }
   1258      1.215        ad 
   1259      1.215        ad /*
   1260      1.223  riastrad  * Parse out the first path name component that we need to to consider.
   1261      1.215        ad  *
   1262      1.215        ad  * While doing this, attempt to use the name cache to fast-forward through
   1263      1.215        ad  * as many "easy" to find components of the path as possible.
   1264      1.215        ad  *
   1265      1.215        ad  * We use the namecache's node locks to form a chain, and avoid as many
   1266      1.215        ad  * vnode references and locks as possible.  In the ideal case, only the
   1267      1.215        ad  * final vnode will have its reference count adjusted and lock taken.
   1268      1.215        ad  */
   1269      1.215        ad static int
   1270      1.215        ad lookup_fastforward(struct namei_state *state, struct vnode **searchdir_ret,
   1271      1.215        ad 		   struct vnode **foundobj_ret)
   1272      1.215        ad {
   1273      1.215        ad 	struct componentname *cnp = state->cnp;
   1274      1.215        ad 	struct nameidata *ndp = state->ndp;
   1275      1.215        ad 	krwlock_t *plock;
   1276      1.215        ad 	struct vnode *foundobj, *searchdir;
   1277      1.215        ad 	int error, error2;
   1278      1.215        ad 	size_t oldpathlen;
   1279      1.215        ad 	const char *oldnameptr;
   1280      1.221        ad 	bool terminal;
   1281      1.215        ad 
   1282       1.10       cgd 	/*
   1283      1.215        ad 	 * Eat as many path name components as possible before giving up and
   1284      1.215        ad 	 * letting lookup_once() handle it.  Remember the starting point in
   1285      1.215        ad 	 * case we can't get vnode references and need to roll back.
   1286      1.215        ad 	 */
   1287      1.215        ad 	plock = NULL;
   1288      1.215        ad 	searchdir = *searchdir_ret;
   1289      1.215        ad 	oldnameptr = cnp->cn_nameptr;
   1290      1.215        ad 	oldpathlen = ndp->ni_pathlen;
   1291      1.221        ad 	terminal = false;
   1292      1.215        ad 	for (;;) {
   1293      1.215        ad 		foundobj = NULL;
   1294      1.215        ad 
   1295      1.215        ad 		/*
   1296      1.215        ad 		 * Get the next component name.  There should be no slashes
   1297      1.215        ad 		 * here, and we shouldn't have looped around if we were
   1298      1.215        ad 		 * done.
   1299      1.215        ad 		 */
   1300      1.215        ad 		KASSERT(cnp->cn_nameptr[0] != '/');
   1301      1.215        ad 		KASSERT(cnp->cn_nameptr[0] != '\0');
   1302  1.225.4.2   thorpej 		if ((error = lookup_parsepath(state, searchdir)) != 0) {
   1303      1.215        ad 			break;
   1304      1.215        ad 		}
   1305      1.215        ad 
   1306      1.215        ad 		/*
   1307      1.219        ad 		 * Can't deal with DOTDOT lookups if NOCROSSMOUNT or the
   1308      1.219        ad 		 * lookup is chrooted.
   1309      1.215        ad 		 */
   1310      1.219        ad 		if ((cnp->cn_flags & ISDOTDOT) != 0) {
   1311      1.219        ad 			if ((searchdir->v_vflag & VV_ROOT) != 0 &&
   1312      1.219        ad 			    (cnp->cn_flags & NOCROSSMOUNT)) {
   1313      1.219        ad 			    	error = EOPNOTSUPP;
   1314      1.219        ad 				break;
   1315      1.219        ad 			}
   1316      1.219        ad 			if (ndp->ni_rootdir != rootvnode) {
   1317      1.219        ad 			    	error = EOPNOTSUPP;
   1318      1.219        ad 				break;
   1319      1.219        ad 			}
   1320      1.215        ad 		}
   1321      1.215        ad 
   1322      1.215        ad 		/*
   1323      1.215        ad 		 * Can't deal with last component when modifying; this needs
   1324      1.215        ad 		 * searchdir locked and VOP_LOOKUP() called (which can and
   1325      1.221        ad 		 * does modify state, despite the name).  NB: this case means
   1326      1.221        ad 		 * terminal is never set true when LOCKPARENT.
   1327      1.215        ad 		 */
   1328      1.215        ad 		if ((cnp->cn_flags & ISLASTCN) != 0) {
   1329      1.215        ad 			if (cnp->cn_nameiop != LOOKUP ||
   1330      1.215        ad 			    (cnp->cn_flags & LOCKPARENT) != 0) {
   1331      1.215        ad 				error = EOPNOTSUPP;
   1332      1.215        ad 				break;
   1333      1.215        ad 			}
   1334      1.215        ad 		}
   1335      1.204  dholland 
   1336      1.215        ad 		/*
   1337      1.215        ad 		 * Good, now look for it in cache.  cache_lookup_linked()
   1338      1.215        ad 		 * will fail if there's nothing there, or if there's no
   1339      1.215        ad 		 * ownership info for the directory, or if the user doesn't
   1340      1.215        ad 		 * have permission to look up files in this directory.
   1341      1.215        ad 		 */
   1342      1.215        ad 		if (!cache_lookup_linked(searchdir, cnp->cn_nameptr,
   1343      1.215        ad 		    cnp->cn_namelen, &foundobj, &plock, cnp->cn_cred)) {
   1344      1.215        ad 			error = EOPNOTSUPP;
   1345      1.215        ad 			break;
   1346      1.107        ad 		}
   1347      1.215        ad 		KASSERT(plock != NULL && rw_lock_held(plock));
   1348      1.215        ad 
   1349      1.219        ad 		/*
   1350      1.219        ad 		 * Scored a hit.  Negative is good too (ENOENT).  If there's
   1351      1.219        ad 		 * a '-o union' mount here, punt and let lookup_once() deal
   1352      1.219        ad 		 * with it.
   1353      1.219        ad 		 */
   1354      1.215        ad 		if (foundobj == NULL) {
   1355      1.219        ad 			if ((searchdir->v_vflag & VV_ROOT) != 0 &&
   1356      1.219        ad 			    (searchdir->v_mount->mnt_flag & MNT_UNION) != 0) {
   1357      1.219        ad 			    	error = EOPNOTSUPP;
   1358      1.219        ad 			} else {
   1359      1.219        ad 				error = ENOENT;
   1360      1.221        ad 				terminal = ((cnp->cn_flags & ISLASTCN) != 0);
   1361      1.221        ad 			}
   1362      1.221        ad 			break;
   1363      1.221        ad 		}
   1364      1.221        ad 
   1365      1.221        ad 		/*
   1366      1.221        ad 		 * Stop and get a hold on the vnode if we've encountered
   1367      1.221        ad 		 * something other than a dirctory.
   1368      1.221        ad 		 */
   1369      1.221        ad 		if (foundobj->v_type != VDIR) {
   1370      1.221        ad 			error = vcache_tryvget(foundobj);
   1371      1.221        ad 			if (error != 0) {
   1372      1.221        ad 				foundobj = NULL;
   1373      1.221        ad 				error = EOPNOTSUPP;
   1374      1.224        ad 			} else {
   1375      1.224        ad 				terminal = (foundobj->v_type != VLNK &&
   1376      1.224        ad 				    (cnp->cn_flags & ISLASTCN) != 0);
   1377      1.219        ad 			}
   1378      1.215        ad 			break;
   1379      1.190      yamt 		}
   1380      1.215        ad 
   1381      1.215        ad 		/*
   1382      1.221        ad 		 * Try to cross mountpoints, bearing in mind that they can
   1383      1.221        ad 		 * be stacked.  If at any point we can't go further, stop
   1384      1.221        ad 		 * and try to get a reference on the vnode.  If we are able
   1385      1.221        ad 		 * to get a ref then lookup_crossmount() will take care of
   1386      1.221        ad 		 * it, otherwise we'll fall through to lookup_once().
   1387      1.221        ad 		 */
   1388      1.221        ad 		if (foundobj->v_mountedhere != NULL) {
   1389      1.221        ad 			while (foundobj->v_mountedhere != NULL &&
   1390      1.221        ad 			    (cnp->cn_flags & NOCROSSMOUNT) == 0 &&
   1391      1.221        ad 			    cache_cross_mount(&foundobj, &plock)) {
   1392      1.221        ad 				KASSERT(foundobj != NULL);
   1393      1.221        ad 				KASSERT(foundobj->v_type == VDIR);
   1394      1.221        ad 			}
   1395      1.221        ad 			if (foundobj->v_mountedhere != NULL) {
   1396      1.221        ad 				error = vcache_tryvget(foundobj);
   1397      1.221        ad 				if (error != 0) {
   1398      1.221        ad 					foundobj = NULL;
   1399      1.221        ad 					error = EOPNOTSUPP;
   1400      1.221        ad 				}
   1401      1.221        ad 				break;
   1402      1.221        ad 			} else {
   1403      1.221        ad 				searchdir = NULL;
   1404      1.221        ad 			}
   1405      1.221        ad 		}
   1406      1.221        ad 
   1407      1.221        ad 		/*
   1408      1.221        ad 		 * Time to stop if we found the last component & traversed
   1409      1.221        ad 		 * all mounts.
   1410      1.221        ad 		 */
   1411      1.221        ad 		if ((cnp->cn_flags & ISLASTCN) != 0) {
   1412      1.215        ad 			error = vcache_tryvget(foundobj);
   1413      1.215        ad 			if (error != 0) {
   1414      1.215        ad 				foundobj = NULL;
   1415      1.217        ad 				error = EOPNOTSUPP;
   1416      1.221        ad 			} else {
   1417      1.221        ad 				terminal = (foundobj->v_type != VLNK);
   1418      1.204  dholland 			}
   1419      1.215        ad 			break;
   1420       1.32  wrstuden 		}
   1421      1.215        ad 
   1422      1.190      yamt 		/*
   1423      1.215        ad 		 * Otherwise, we're still in business.  Set the found VDIR
   1424      1.215        ad 		 * vnode as the search dir for the next component and
   1425      1.215        ad 		 * continue on to it.
   1426      1.190      yamt 		 */
   1427      1.215        ad 		cnp->cn_nameptr = ndp->ni_next;
   1428      1.215        ad 		searchdir = foundobj;
   1429      1.215        ad 	}
   1430      1.215        ad 
   1431      1.221        ad 	if (terminal) {
   1432      1.221        ad 		/*
   1433      1.221        ad 		 * If we exited the loop above having successfully located
   1434      1.221        ad 		 * the last component with a zero error code, and it's not a
   1435      1.223  riastrad 		 * symbolic link, then the parent directory is not needed.
   1436      1.221        ad 		 * Release reference to the starting parent and make the
   1437      1.221        ad 		 * terminal parent disappear into thin air.
   1438      1.221        ad 		 */
   1439      1.221        ad 		KASSERT(plock != NULL);
   1440      1.221        ad 		rw_exit(plock);
   1441      1.221        ad 		vrele(*searchdir_ret);
   1442      1.221        ad 		*searchdir_ret = NULL;
   1443      1.221        ad 	} else if (searchdir != *searchdir_ret) {
   1444      1.221        ad 		/*
   1445      1.221        ad 		 * Otherwise we need to return the parent.  If we ended up
   1446      1.221        ad 		 * with a new search dir, ref it before dropping the
   1447      1.221        ad 		 * namecache's lock.  The lock prevents both searchdir and
   1448      1.221        ad 		 * foundobj from disappearing.  If we can't ref the new
   1449      1.221        ad 		 * searchdir, we have a bit of a problem.  Roll back the
   1450      1.221        ad 		 * fastforward to the beginning and let lookup_once() take
   1451      1.221        ad 		 * care of it.
   1452      1.221        ad 		 */
   1453      1.224        ad 		if (searchdir == NULL) {
   1454      1.224        ad 			/*
   1455      1.224        ad 			 * It's possible for searchdir to be NULL in the
   1456      1.224        ad 			 * case of a root vnode being reclaimed while
   1457      1.224        ad 			 * trying to cross a mount.
   1458      1.224        ad 			 */
   1459      1.224        ad 			error2 = EOPNOTSUPP;
   1460      1.224        ad 		} else {
   1461      1.224        ad 			error2 = vcache_tryvget(searchdir);
   1462      1.224        ad 		}
   1463      1.215        ad 		KASSERT(plock != NULL);
   1464      1.215        ad 		rw_exit(plock);
   1465      1.215        ad 		if (__predict_true(error2 == 0)) {
   1466      1.215        ad 			/* Returning new searchdir, and maybe new foundobj. */
   1467      1.215        ad 			vrele(*searchdir_ret);
   1468      1.215        ad 			*searchdir_ret = searchdir;
   1469      1.190      yamt 		} else {
   1470      1.215        ad 			/* Returning nothing. */
   1471      1.215        ad 			if (foundobj != NULL) {
   1472      1.215        ad 				vrele(foundobj);
   1473      1.215        ad 				foundobj = NULL;
   1474      1.215        ad 			}
   1475      1.215        ad 			cnp->cn_nameptr = oldnameptr;
   1476      1.215        ad 			ndp->ni_pathlen = oldpathlen;
   1477  1.225.4.2   thorpej 			if (searchdir == NULL) {
   1478      1.215        ad 				error = EOPNOTSUPP;
   1479  1.225.4.2   thorpej 			} else {
   1480  1.225.4.2   thorpej 				error = lookup_parsepath(state, searchdir);
   1481  1.225.4.2   thorpej 				if (error == 0) {
   1482  1.225.4.2   thorpej 					error = EOPNOTSUPP;
   1483  1.225.4.2   thorpej 				}
   1484      1.215        ad 			}
   1485      1.190      yamt 		}
   1486      1.215        ad 	} else if (plock != NULL) {
   1487      1.215        ad 		/* Drop any namecache lock still held. */
   1488      1.215        ad 		rw_exit(plock);
   1489       1.14   mycroft 	}
   1490       1.14   mycroft 
   1491      1.215        ad 	KASSERT(error == 0 ? foundobj != NULL : foundobj == NULL);
   1492      1.147  dholland 	*foundobj_ret = foundobj;
   1493      1.175      yamt 	return error;
   1494      1.118  dholland }
   1495      1.118  dholland 
   1496      1.131  dholland //////////////////////////////
   1497      1.131  dholland 
   1498      1.173  dholland /*
   1499      1.173  dholland  * Do a complete path search from a single root directory.
   1500      1.173  dholland  * (This is called up to twice if TRYEMULROOT is in effect.)
   1501      1.173  dholland  */
   1502      1.131  dholland static int
   1503      1.196  dholland namei_oneroot(struct namei_state *state,
   1504      1.193  dholland 	 int neverfollow, int inhibitmagic, int isnfsd)
   1505      1.131  dholland {
   1506      1.131  dholland 	struct nameidata *ndp = state->ndp;
   1507      1.131  dholland 	struct componentname *cnp = state->cnp;
   1508      1.146  dholland 	struct vnode *searchdir, *foundobj;
   1509      1.215        ad 	bool searchdir_locked = false;
   1510      1.137  dholland 	int error;
   1511      1.131  dholland 
   1512      1.196  dholland 	error = namei_start(state, isnfsd, &searchdir);
   1513      1.131  dholland 	if (error) {
   1514      1.164  dholland 		ndp->ni_dvp = NULL;
   1515      1.164  dholland 		ndp->ni_vp = NULL;
   1516      1.131  dholland 		return error;
   1517      1.131  dholland 	}
   1518      1.185  dholland 	KASSERT(searchdir->v_type == VDIR);
   1519      1.131  dholland 
   1520      1.133  dholland 	/*
   1521      1.139  dholland 	 * Setup: break out flag bits into variables.
   1522      1.139  dholland 	 */
   1523      1.139  dholland 	state->docache = (cnp->cn_flags & NOCACHE) ^ NOCACHE;
   1524      1.139  dholland 	if (cnp->cn_nameiop == DELETE)
   1525      1.139  dholland 		state->docache = 0;
   1526      1.139  dholland 	state->rdonly = cnp->cn_flags & RDONLY;
   1527      1.139  dholland 
   1528      1.139  dholland 	/*
   1529      1.133  dholland 	 * Keep going until we run out of path components.
   1530      1.133  dholland 	 */
   1531      1.139  dholland 	cnp->cn_nameptr = ndp->ni_pnbuf;
   1532      1.185  dholland 
   1533      1.185  dholland 	/* drop leading slashes (already used them to choose startdir) */
   1534      1.185  dholland 	while (cnp->cn_nameptr[0] == '/') {
   1535      1.185  dholland 		cnp->cn_nameptr++;
   1536      1.185  dholland 		ndp->ni_pathlen--;
   1537      1.185  dholland 	}
   1538      1.185  dholland 	/* was it just "/"? */
   1539      1.185  dholland 	if (cnp->cn_nameptr[0] == '\0') {
   1540      1.185  dholland 		foundobj = searchdir;
   1541      1.185  dholland 		searchdir = NULL;
   1542      1.185  dholland 		cnp->cn_flags |= ISLASTCN;
   1543      1.185  dholland 
   1544      1.185  dholland 		/* bleh */
   1545      1.185  dholland 		goto skiploop;
   1546      1.185  dholland 	}
   1547      1.185  dholland 
   1548      1.131  dholland 	for (;;) {
   1549      1.204  dholland 		KASSERT(searchdir != NULL);
   1550      1.215        ad 		KASSERT(!searchdir_locked);
   1551      1.215        ad 
   1552      1.215        ad 		/*
   1553      1.215        ad 		 * Parse out the first path name component that we need to
   1554      1.215        ad 		 * to consider.  While doing this, attempt to use the name
   1555      1.215        ad 		 * cache to fast-forward through as many "easy" to find
   1556      1.215        ad 		 * components of the path as possible.
   1557      1.215        ad 		 */
   1558      1.215        ad 		error = lookup_fastforward(state, &searchdir, &foundobj);
   1559      1.133  dholland 
   1560      1.133  dholland 		/*
   1561      1.215        ad 		 * If we didn't get a good answer from the namecache, then
   1562      1.215        ad 		 * go directly to the file system.
   1563      1.133  dholland 		 */
   1564      1.216        ad 		if (error == EOPNOTSUPP) {
   1565      1.215        ad 			error = lookup_once(state, searchdir, &searchdir,
   1566      1.215        ad 			    &foundobj, &searchdir_locked);
   1567      1.131  dholland 		}
   1568      1.133  dholland 
   1569      1.133  dholland 		/*
   1570      1.215        ad 		 * If the vnode we found is mounted on, then cross the mount
   1571      1.215        ad 		 * and get the root vnode in foundobj.  If this encounters
   1572      1.215        ad 		 * an error, it will dispose of foundobj, but searchdir is
   1573      1.215        ad 		 * untouched.
   1574      1.133  dholland 		 */
   1575      1.215        ad 		if (error == 0 && foundobj != NULL &&
   1576      1.215        ad 		    foundobj->v_type == VDIR &&
   1577      1.215        ad 		    foundobj->v_mountedhere != NULL &&
   1578      1.215        ad 		    (cnp->cn_flags & NOCROSSMOUNT) == 0) {
   1579      1.215        ad 		    	error = lookup_crossmount(state, &searchdir,
   1580      1.215        ad 		    	    &foundobj, &searchdir_locked);
   1581      1.131  dholland 		}
   1582      1.138  dholland 
   1583      1.139  dholland 		if (error) {
   1584      1.204  dholland 			if (searchdir != NULL) {
   1585      1.215        ad 				if (searchdir_locked) {
   1586      1.215        ad 					searchdir_locked = false;
   1587      1.215        ad 					vput(searchdir);
   1588      1.215        ad 				} else {
   1589      1.215        ad 					vrele(searchdir);
   1590      1.215        ad 				}
   1591      1.204  dholland 			}
   1592      1.168  dholland 			ndp->ni_dvp = NULL;
   1593      1.139  dholland 			ndp->ni_vp = NULL;
   1594      1.138  dholland 			/*
   1595      1.139  dholland 			 * Note that if we're doing TRYEMULROOT we can
   1596      1.139  dholland 			 * retry with the normal root. Where this is
   1597      1.139  dholland 			 * currently set matches previous practice,
   1598      1.139  dholland 			 * but the previous practice didn't make much
   1599      1.139  dholland 			 * sense and somebody should sit down and
   1600      1.139  dholland 			 * figure out which cases should cause retry
   1601      1.139  dholland 			 * and which shouldn't. XXX.
   1602      1.138  dholland 			 */
   1603      1.139  dholland 			state->attempt_retry = 1;
   1604      1.139  dholland 			return (error);
   1605      1.139  dholland 		}
   1606      1.157  dholland 
   1607      1.162  dholland 		if (foundobj == NULL) {
   1608      1.162  dholland 			/*
   1609      1.162  dholland 			 * Success with no object returned means we're
   1610      1.162  dholland 			 * creating something and it isn't already
   1611      1.181  dholland 			 * there. Break out of the main loop now so
   1612      1.162  dholland 			 * the code below doesn't have to test for
   1613      1.162  dholland 			 * foundobj == NULL.
   1614      1.162  dholland 			 */
   1615      1.204  dholland 			/* lookup_once can't have dropped the searchdir */
   1616      1.222        ad 			KASSERT(searchdir != NULL ||
   1617      1.222        ad 			    (cnp->cn_flags & ISLASTCN) != 0);
   1618      1.181  dholland 			break;
   1619      1.138  dholland 		}
   1620      1.131  dholland 
   1621      1.131  dholland 		/*
   1622      1.139  dholland 		 * Check for symbolic link. If we've reached one,
   1623      1.139  dholland 		 * follow it, unless we aren't supposed to. Back up
   1624      1.139  dholland 		 * over any slashes that we skipped, as we will need
   1625      1.139  dholland 		 * them again.
   1626      1.131  dholland 		 */
   1627      1.146  dholland 		if (namei_atsymlink(state, foundobj)) {
   1628      1.215        ad 			/* Don't need searchdir locked any more. */
   1629      1.215        ad 			if (searchdir_locked) {
   1630      1.215        ad 				searchdir_locked = false;
   1631      1.215        ad 				VOP_UNLOCK(searchdir);
   1632      1.215        ad 			}
   1633      1.139  dholland 			ndp->ni_pathlen += state->slashes;
   1634      1.139  dholland 			ndp->ni_next -= state->slashes;
   1635      1.134  dholland 			if (neverfollow) {
   1636      1.134  dholland 				error = EINVAL;
   1637      1.204  dholland 			} else if (searchdir == NULL) {
   1638      1.204  dholland 				/*
   1639      1.204  dholland 				 * dholland 20160410: lookup_once only
   1640      1.204  dholland 				 * drops searchdir if it crossed a
   1641      1.204  dholland 				 * mount point. Therefore, if we get
   1642      1.204  dholland 				 * here it means we crossed a mount
   1643      1.204  dholland 				 * point to a mounted filesystem whose
   1644      1.204  dholland 				 * root vnode is a symlink. In theory
   1645      1.204  dholland 				 * we could continue at this point by
   1646      1.204  dholland 				 * using the pre-crossing searchdir
   1647      1.204  dholland 				 * (e.g. just take out an extra
   1648      1.204  dholland 				 * reference on it before calling
   1649      1.204  dholland 				 * lookup_once so we still have it),
   1650      1.204  dholland 				 * but this will make an ugly mess and
   1651      1.204  dholland 				 * it should never happen in practice
   1652      1.204  dholland 				 * as only badly broken filesystems
   1653      1.204  dholland 				 * have non-directory root vnodes. (I
   1654      1.204  dholland 				 * have seen this sort of thing with
   1655      1.204  dholland 				 * NFS occasionally but even then it
   1656      1.204  dholland 				 * means something's badly wrong.)
   1657      1.204  dholland 				 */
   1658      1.204  dholland 				error = ENOTDIR;
   1659      1.134  dholland 			} else {
   1660      1.152  dholland 				/*
   1661      1.152  dholland 				 * dholland 20110410: if we're at a
   1662      1.152  dholland 				 * union mount it might make sense to
   1663      1.152  dholland 				 * use the top of the union stack here
   1664      1.152  dholland 				 * rather than the layer we found the
   1665      1.152  dholland 				 * symlink in. (FUTURE)
   1666      1.152  dholland 				 */
   1667      1.141  dholland 				error = namei_follow(state, inhibitmagic,
   1668      1.165  dholland 						     searchdir, foundobj,
   1669      1.152  dholland 						     &searchdir);
   1670      1.134  dholland 			}
   1671      1.131  dholland 			if (error) {
   1672      1.165  dholland 				KASSERT(searchdir != foundobj);
   1673      1.204  dholland 				if (searchdir != NULL) {
   1674      1.215        ad 					vrele(searchdir);
   1675      1.204  dholland 				}
   1676      1.215        ad 				vrele(foundobj);
   1677      1.168  dholland 				ndp->ni_dvp = NULL;
   1678      1.131  dholland 				ndp->ni_vp = NULL;
   1679      1.131  dholland 				return error;
   1680      1.131  dholland 			}
   1681      1.174  jakllsch 			vrele(foundobj);
   1682      1.167  dholland 			foundobj = NULL;
   1683      1.189  riastrad 
   1684      1.189  riastrad 			/*
   1685      1.189  riastrad 			 * If we followed a symlink to `/' and there
   1686      1.189  riastrad 			 * are no more components after the symlink,
   1687      1.189  riastrad 			 * we're done with the loop and what we found
   1688      1.189  riastrad 			 * is the searchdir.
   1689      1.189  riastrad 			 */
   1690      1.189  riastrad 			if (cnp->cn_nameptr[0] == '\0') {
   1691      1.204  dholland 				KASSERT(searchdir != NULL);
   1692      1.189  riastrad 				foundobj = searchdir;
   1693      1.189  riastrad 				searchdir = NULL;
   1694      1.189  riastrad 				cnp->cn_flags |= ISLASTCN;
   1695      1.189  riastrad 				break;
   1696      1.189  riastrad 			}
   1697      1.189  riastrad 
   1698      1.139  dholland 			continue;
   1699      1.139  dholland 		}
   1700      1.139  dholland 
   1701      1.139  dholland 		/*
   1702      1.183  dholland 		 * Not a symbolic link.
   1703      1.183  dholland 		 *
   1704      1.139  dholland 		 * Check for directory, if the component was
   1705      1.139  dholland 		 * followed by a series of slashes.
   1706      1.139  dholland 		 */
   1707      1.190      yamt 		if ((foundobj->v_type != VDIR) &&
   1708      1.190      yamt 		    (cnp->cn_flags & REQUIREDIR)) {
   1709      1.204  dholland 			KASSERT(foundobj != searchdir);
   1710      1.204  dholland 			if (searchdir) {
   1711      1.215        ad 				if (searchdir_locked) {
   1712      1.215        ad 					searchdir_locked = false;
   1713      1.215        ad 					vput(searchdir);
   1714      1.215        ad 				} else {
   1715      1.215        ad 					vrele(searchdir);
   1716      1.215        ad 				}
   1717      1.215        ad 			} else {
   1718      1.215        ad 				KASSERT(!searchdir_locked);
   1719      1.139  dholland 			}
   1720      1.215        ad 			vrele(foundobj);
   1721      1.168  dholland 			ndp->ni_dvp = NULL;
   1722      1.168  dholland 			ndp->ni_vp = NULL;
   1723      1.139  dholland 			state->attempt_retry = 1;
   1724      1.139  dholland 			return ENOTDIR;
   1725      1.139  dholland 		}
   1726      1.139  dholland 
   1727      1.139  dholland 		/*
   1728      1.183  dholland 		 * Stop if we've reached the last component.
   1729      1.139  dholland 		 */
   1730      1.183  dholland 		if (cnp->cn_flags & ISLASTCN) {
   1731      1.183  dholland 			break;
   1732      1.139  dholland 		}
   1733      1.139  dholland 
   1734      1.183  dholland 		/*
   1735      1.183  dholland 		 * Continue with the next component.
   1736      1.183  dholland 		 */
   1737      1.183  dholland 		cnp->cn_nameptr = ndp->ni_next;
   1738      1.215        ad 		if (searchdir != NULL) {
   1739      1.215        ad 			if (searchdir_locked) {
   1740      1.215        ad 				searchdir_locked = false;
   1741      1.215        ad 				vput(searchdir);
   1742      1.215        ad 			} else {
   1743      1.215        ad 				vrele(searchdir);
   1744      1.215        ad 			}
   1745      1.183  dholland 		}
   1746      1.183  dholland 		searchdir = foundobj;
   1747      1.183  dholland 		foundobj = NULL;
   1748      1.179  dholland 	}
   1749      1.179  dholland 
   1750      1.215        ad 	KASSERT((cnp->cn_flags & LOCKPARENT) == 0 || searchdir == NULL ||
   1751      1.215        ad 	    VOP_ISLOCKED(searchdir) == LK_EXCLUSIVE);
   1752      1.215        ad 
   1753      1.185  dholland  skiploop:
   1754      1.185  dholland 
   1755      1.182  dholland 	if (foundobj != NULL) {
   1756      1.146  dholland 		if (foundobj == ndp->ni_erootdir) {
   1757      1.139  dholland 			/*
   1758      1.139  dholland 			 * We are about to return the emulation root.
   1759      1.139  dholland 			 * This isn't a good idea because code might
   1760      1.139  dholland 			 * repeatedly lookup ".." until the file
   1761      1.139  dholland 			 * matches that returned for "/" and loop
   1762      1.139  dholland 			 * forever.  So convert it to the real root.
   1763      1.139  dholland 			 */
   1764      1.170  dholland 			if (searchdir != NULL) {
   1765      1.215        ad 				if (searchdir_locked) {
   1766      1.215        ad 					vput(searchdir);
   1767      1.215        ad 					searchdir_locked = false;
   1768      1.215        ad 				} else {
   1769      1.170  dholland 					vrele(searchdir);
   1770      1.215        ad 				}
   1771      1.170  dholland 				searchdir = NULL;
   1772      1.170  dholland 			}
   1773      1.215        ad 			vrele(foundobj);
   1774      1.146  dholland 			foundobj = ndp->ni_rootdir;
   1775      1.146  dholland 			vref(foundobj);
   1776      1.131  dholland 		}
   1777      1.139  dholland 
   1778      1.139  dholland 		/*
   1779      1.158  dholland 		 * If the caller requested the parent node (i.e. it's
   1780      1.158  dholland 		 * a CREATE, DELETE, or RENAME), and we don't have one
   1781      1.158  dholland 		 * (because this is the root directory, or we crossed
   1782      1.158  dholland 		 * a mount point), then we must fail.
   1783  1.225.4.1   thorpej 		 *
   1784  1.225.4.1   thorpej 		 * 20210604 dholland when NONEXCLHACK is set (open
   1785  1.225.4.1   thorpej 		 * with O_CREAT but not O_EXCL) skip this logic. Since
   1786  1.225.4.1   thorpej 		 * we have a foundobj, open will not be creating, so
   1787  1.225.4.1   thorpej 		 * it doesn't actually need or use the searchdir, so
   1788  1.225.4.1   thorpej 		 * it's ok to return it even if it's on a different
   1789  1.225.4.1   thorpej 		 * volume, and it's also ok to return NULL; by setting
   1790  1.225.4.1   thorpej 		 * NONEXCLHACK the open code promises to cope with
   1791  1.225.4.1   thorpej 		 * those cases correctly. (That is, it should do what
   1792  1.225.4.1   thorpej 		 * it would do anyway, that is, just release the
   1793  1.225.4.1   thorpej 		 * searchdir, except not crash if it's null.) This is
   1794  1.225.4.1   thorpej 		 * needed because otherwise opening mountpoints with
   1795  1.225.4.1   thorpej 		 * O_CREAT but not O_EXCL fails... which is a silly
   1796  1.225.4.1   thorpej 		 * thing to do but ought to work. (This whole issue
   1797  1.225.4.1   thorpej 		 * came to light because 3rd party code wanted to open
   1798  1.225.4.1   thorpej 		 * certain procfs nodes with O_CREAT for some 3rd
   1799  1.225.4.1   thorpej 		 * party reason, and it failed.)
   1800  1.225.4.1   thorpej 		 *
   1801  1.225.4.1   thorpej 		 * Note that NONEXCLHACK is properly a different
   1802  1.225.4.1   thorpej 		 * nameiop (it is partway between LOOKUP and CREATE)
   1803  1.225.4.1   thorpej 		 * but it was stuffed in as a flag instead to make the
   1804  1.225.4.1   thorpej 		 * resulting patch less invasive for pullup. Blah.
   1805      1.139  dholland 		 */
   1806      1.158  dholland 		if (cnp->cn_nameiop != LOOKUP &&
   1807      1.158  dholland 		    (searchdir == NULL ||
   1808  1.225.4.1   thorpej 		     searchdir->v_mount != foundobj->v_mount) &&
   1809  1.225.4.1   thorpej 		    (cnp->cn_flags & NONEXCLHACK) == 0) {
   1810      1.170  dholland 			if (searchdir) {
   1811      1.215        ad 				if (searchdir_locked) {
   1812      1.215        ad 					vput(searchdir);
   1813      1.215        ad 					searchdir_locked = false;
   1814      1.215        ad 				} else {
   1815      1.215        ad 					vrele(searchdir);
   1816      1.215        ad 				}
   1817      1.215        ad 				searchdir = NULL;
   1818      1.170  dholland 			}
   1819      1.215        ad 			vrele(foundobj);
   1820      1.170  dholland 			foundobj = NULL;
   1821      1.170  dholland 			ndp->ni_dvp = NULL;
   1822      1.170  dholland 			ndp->ni_vp = NULL;
   1823      1.170  dholland 			state->attempt_retry = 1;
   1824      1.170  dholland 
   1825      1.139  dholland 			switch (cnp->cn_nameiop) {
   1826      1.139  dholland 			    case CREATE:
   1827      1.171  dholland 				return EEXIST;
   1828      1.139  dholland 			    case DELETE:
   1829      1.139  dholland 			    case RENAME:
   1830      1.171  dholland 				return EBUSY;
   1831      1.171  dholland 			    default:
   1832      1.139  dholland 				break;
   1833      1.139  dholland 			}
   1834      1.171  dholland 			panic("Invalid nameiop\n");
   1835      1.139  dholland 		}
   1836      1.139  dholland 
   1837      1.139  dholland 		/*
   1838      1.139  dholland 		 * Disallow directory write attempts on read-only lookups.
   1839      1.139  dholland 		 * Prefers EEXIST over EROFS for the CREATE case.
   1840      1.139  dholland 		 */
   1841      1.139  dholland 		if (state->rdonly &&
   1842      1.139  dholland 		    (cnp->cn_nameiop == DELETE || cnp->cn_nameiop == RENAME)) {
   1843      1.157  dholland 			if (searchdir) {
   1844      1.215        ad 				if (searchdir_locked) {
   1845      1.170  dholland 					vput(searchdir);
   1846      1.215        ad 					searchdir_locked = false;
   1847      1.170  dholland 				} else {
   1848      1.170  dholland 					vrele(searchdir);
   1849      1.170  dholland 				}
   1850      1.170  dholland 				searchdir = NULL;
   1851      1.157  dholland 			}
   1852      1.215        ad 			vrele(foundobj);
   1853      1.170  dholland 			foundobj = NULL;
   1854      1.168  dholland 			ndp->ni_dvp = NULL;
   1855      1.139  dholland 			ndp->ni_vp = NULL;
   1856      1.139  dholland 			state->attempt_retry = 1;
   1857      1.171  dholland 			return EROFS;
   1858      1.139  dholland 		}
   1859      1.215        ad 
   1860      1.215        ad 		/* Lock the leaf node if requested. */
   1861      1.215        ad 		if ((cnp->cn_flags & (LOCKLEAF | LOCKPARENT)) == LOCKPARENT &&
   1862      1.215        ad 		    searchdir == foundobj) {
   1863      1.172  dholland 			/*
   1864      1.172  dholland 			 * Note: if LOCKPARENT but not LOCKLEAF is
   1865      1.172  dholland 			 * set, and searchdir == foundobj, this code
   1866      1.172  dholland 			 * necessarily unlocks the parent as well as
   1867      1.172  dholland 			 * the leaf. That is, just because you specify
   1868      1.172  dholland 			 * LOCKPARENT doesn't mean you necessarily get
   1869      1.172  dholland 			 * a locked parent vnode. The code in
   1870      1.172  dholland 			 * vfs_syscalls.c, and possibly elsewhere,
   1871      1.172  dholland 			 * that uses this combination "knows" this, so
   1872      1.172  dholland 			 * it can't be safely changed. Feh. XXX
   1873      1.172  dholland 			 */
   1874      1.215        ad 			KASSERT(searchdir_locked);
   1875      1.215        ad 		    	VOP_UNLOCK(searchdir);
   1876      1.215        ad 		    	searchdir_locked = false;
   1877      1.215        ad 		} else if ((cnp->cn_flags & LOCKLEAF) != 0 &&
   1878      1.215        ad 		    (searchdir != foundobj ||
   1879      1.215        ad 		    (cnp->cn_flags & LOCKPARENT) == 0)) {
   1880      1.215        ad 			const int lktype = (cnp->cn_flags & LOCKSHARED) != 0 ?
   1881      1.215        ad 			    LK_SHARED : LK_EXCLUSIVE;
   1882      1.215        ad 			vn_lock(foundobj, lktype | LK_RETRY);
   1883      1.131  dholland 		}
   1884      1.179  dholland 	}
   1885      1.139  dholland 
   1886      1.131  dholland 	/*
   1887      1.133  dholland 	 * Done.
   1888      1.131  dholland 	 */
   1889      1.131  dholland 
   1890      1.133  dholland 	/*
   1891      1.133  dholland 	 * If LOCKPARENT is not set, the parent directory isn't returned.
   1892      1.133  dholland 	 */
   1893      1.157  dholland 	if ((cnp->cn_flags & LOCKPARENT) == 0 && searchdir != NULL) {
   1894      1.215        ad 		vrele(searchdir);
   1895      1.157  dholland 		searchdir = NULL;
   1896      1.131  dholland 	}
   1897      1.131  dholland 
   1898      1.157  dholland 	ndp->ni_dvp = searchdir;
   1899      1.165  dholland 	ndp->ni_vp = foundobj;
   1900      1.137  dholland 	return 0;
   1901      1.137  dholland }
   1902      1.137  dholland 
   1903      1.173  dholland /*
   1904      1.173  dholland  * Do namei; wrapper layer that handles TRYEMULROOT.
   1905      1.173  dholland  */
   1906      1.137  dholland static int
   1907      1.196  dholland namei_tryemulroot(struct namei_state *state,
   1908      1.193  dholland 	 int neverfollow, int inhibitmagic, int isnfsd)
   1909      1.137  dholland {
   1910      1.137  dholland 	int error;
   1911      1.137  dholland 
   1912      1.137  dholland 	struct nameidata *ndp = state->ndp;
   1913      1.137  dholland 	struct componentname *cnp = state->cnp;
   1914      1.137  dholland 	const char *savepath = NULL;
   1915      1.137  dholland 
   1916      1.137  dholland 	KASSERT(cnp == &ndp->ni_cnd);
   1917      1.137  dholland 
   1918      1.137  dholland 	if (cnp->cn_flags & TRYEMULROOT) {
   1919      1.137  dholland 		savepath = pathbuf_stringcopy_get(ndp->ni_pathbuf);
   1920      1.137  dholland 	}
   1921      1.137  dholland 
   1922      1.137  dholland     emul_retry:
   1923      1.137  dholland 	state->attempt_retry = 0;
   1924      1.137  dholland 
   1925      1.196  dholland 	error = namei_oneroot(state, neverfollow, inhibitmagic, isnfsd);
   1926      1.137  dholland 	if (error) {
   1927      1.137  dholland 		/*
   1928      1.137  dholland 		 * Once namei has started up, the existence of ni_erootdir
   1929      1.137  dholland 		 * tells us whether we're working from an emulation root.
   1930      1.137  dholland 		 * The TRYEMULROOT flag isn't necessarily authoritative.
   1931      1.137  dholland 		 */
   1932      1.137  dholland 		if (ndp->ni_erootdir != NULL && state->attempt_retry) {
   1933      1.137  dholland 			/* Retry the whole thing using the normal root */
   1934      1.137  dholland 			cnp->cn_flags &= ~TRYEMULROOT;
   1935      1.137  dholland 			state->attempt_retry = 0;
   1936      1.137  dholland 
   1937      1.137  dholland 			/* kinda gross */
   1938      1.137  dholland 			strcpy(ndp->ni_pathbuf->pb_path, savepath);
   1939      1.137  dholland 			pathbuf_stringcopy_put(ndp->ni_pathbuf, savepath);
   1940      1.137  dholland 			savepath = NULL;
   1941      1.137  dholland 
   1942      1.137  dholland 			goto emul_retry;
   1943      1.137  dholland 		}
   1944      1.137  dholland 	}
   1945      1.131  dholland 	if (savepath != NULL) {
   1946      1.131  dholland 		pathbuf_stringcopy_put(ndp->ni_pathbuf, savepath);
   1947      1.131  dholland 	}
   1948      1.137  dholland 	return error;
   1949      1.131  dholland }
   1950      1.131  dholland 
   1951      1.173  dholland /*
   1952      1.173  dholland  * External interface.
   1953      1.173  dholland  */
   1954      1.131  dholland int
   1955      1.131  dholland namei(struct nameidata *ndp)
   1956      1.131  dholland {
   1957      1.131  dholland 	struct namei_state state;
   1958      1.131  dholland 	int error;
   1959      1.131  dholland 
   1960      1.131  dholland 	namei_init(&state, ndp);
   1961      1.196  dholland 	error = namei_tryemulroot(&state,
   1962      1.193  dholland 				  0/*!neverfollow*/, 0/*!inhibitmagic*/,
   1963      1.193  dholland 				  0/*isnfsd*/);
   1964      1.131  dholland 	namei_cleanup(&state);
   1965      1.131  dholland 
   1966      1.159  dholland 	if (error) {
   1967      1.159  dholland 		/* make sure no stray refs leak out */
   1968      1.164  dholland 		KASSERT(ndp->ni_dvp == NULL);
   1969      1.164  dholland 		KASSERT(ndp->ni_vp == NULL);
   1970      1.159  dholland 	}
   1971      1.159  dholland 
   1972      1.131  dholland 	return error;
   1973      1.131  dholland }
   1974      1.131  dholland 
   1975      1.131  dholland ////////////////////////////////////////////////////////////
   1976      1.131  dholland 
   1977       1.12   mycroft /*
   1978      1.173  dholland  * External interface used by nfsd. This is basically different from
   1979      1.173  dholland  * namei only in that it has the ability to pass in the "current
   1980      1.173  dholland  * directory", and uses an extra flag "neverfollow" for which there's
   1981      1.173  dholland  * no physical flag defined in namei.h. (There used to be a cut&paste
   1982      1.173  dholland  * copy of about half of namei in nfsd to allow these minor
   1983      1.173  dholland  * adjustments to exist.)
   1984      1.119  dholland  *
   1985      1.173  dholland  * XXX: the namei interface should be adjusted so nfsd can just use
   1986      1.173  dholland  * ordinary namei().
   1987      1.118  dholland  */
   1988      1.134  dholland int
   1989      1.135  dholland lookup_for_nfsd(struct nameidata *ndp, struct vnode *forcecwd, int neverfollow)
   1990      1.134  dholland {
   1991      1.134  dholland 	struct namei_state state;
   1992      1.134  dholland 	int error;
   1993      1.120  dholland 
   1994      1.198  dholland 	KASSERT(ndp->ni_atdir == NULL);
   1995      1.198  dholland 	ndp->ni_atdir = forcecwd;
   1996      1.194  dholland 
   1997      1.134  dholland 	namei_init(&state, ndp);
   1998      1.196  dholland 	error = namei_tryemulroot(&state,
   1999      1.193  dholland 				  neverfollow, 1/*inhibitmagic*/, 1/*isnfsd*/);
   2000      1.119  dholland 	namei_cleanup(&state);
   2001      1.119  dholland 
   2002      1.159  dholland 	if (error) {
   2003      1.159  dholland 		/* make sure no stray refs leak out */
   2004      1.164  dholland 		KASSERT(ndp->ni_dvp == NULL);
   2005      1.164  dholland 		KASSERT(ndp->ni_vp == NULL);
   2006      1.159  dholland 	}
   2007      1.159  dholland 
   2008      1.119  dholland 	return error;
   2009      1.119  dholland }
   2010      1.119  dholland 
   2011      1.173  dholland /*
   2012      1.173  dholland  * A second external interface used by nfsd. This turns out to be a
   2013      1.173  dholland  * single lookup used by the WebNFS code (ha!) to get "index.html" or
   2014      1.173  dholland  * equivalent when asked for a directory. It should eventually evolve
   2015      1.173  dholland  * into some kind of namei_once() call; for the time being it's kind
   2016      1.173  dholland  * of a mess. XXX.
   2017      1.173  dholland  *
   2018      1.173  dholland  * dholland 20110109: I don't think it works, and I don't think it
   2019      1.173  dholland  * worked before I started hacking and slashing either, and I doubt
   2020      1.173  dholland  * anyone will ever notice.
   2021      1.173  dholland  */
   2022      1.173  dholland 
   2023      1.173  dholland /*
   2024      1.173  dholland  * Internals. This calls lookup_once() after setting up the assorted
   2025      1.173  dholland  * pieces of state the way they ought to be.
   2026      1.173  dholland  */
   2027      1.136  dholland static int
   2028      1.196  dholland do_lookup_for_nfsd_index(struct namei_state *state)
   2029      1.136  dholland {
   2030  1.225.4.2   thorpej 	int error;
   2031      1.136  dholland 
   2032      1.136  dholland 	struct componentname *cnp = state->cnp;
   2033      1.136  dholland 	struct nameidata *ndp = state->ndp;
   2034      1.196  dholland 	struct vnode *startdir;
   2035      1.147  dholland 	struct vnode *foundobj;
   2036      1.215        ad 	bool startdir_locked;
   2037      1.136  dholland 	const char *cp;			/* pointer into pathname argument */
   2038      1.136  dholland 
   2039      1.136  dholland 	KASSERT(cnp == &ndp->ni_cnd);
   2040      1.136  dholland 
   2041      1.198  dholland 	startdir = state->ndp->ni_atdir;
   2042      1.196  dholland 
   2043      1.136  dholland 	cnp->cn_nameptr = ndp->ni_pnbuf;
   2044      1.136  dholland 	state->docache = 1;
   2045      1.136  dholland 	state->rdonly = cnp->cn_flags & RDONLY;
   2046      1.136  dholland 	ndp->ni_dvp = NULL;
   2047      1.136  dholland 
   2048  1.225.4.2   thorpej 	error = VOP_PARSEPATH(startdir, cnp->cn_nameptr, &cnp->cn_namelen);
   2049  1.225.4.2   thorpej 	if (error) {
   2050  1.225.4.2   thorpej 		return error;
   2051  1.225.4.2   thorpej 	}
   2052  1.225.4.2   thorpej 
   2053      1.197  dholland 	cp = cnp->cn_nameptr + cnp->cn_namelen;
   2054      1.191  christos 	KASSERT(cnp->cn_namelen <= KERNEL_NAME_MAX);
   2055      1.136  dholland 	ndp->ni_pathlen -= cnp->cn_namelen;
   2056      1.136  dholland 	ndp->ni_next = cp;
   2057      1.136  dholland 	state->slashes = 0;
   2058      1.136  dholland 	cnp->cn_flags &= ~REQUIREDIR;
   2059      1.136  dholland 	cnp->cn_flags |= MAKEENTRY|ISLASTCN;
   2060      1.136  dholland 
   2061      1.136  dholland 	if (cnp->cn_namelen == 2 &&
   2062      1.136  dholland 	    cnp->cn_nameptr[1] == '.' && cnp->cn_nameptr[0] == '.')
   2063      1.136  dholland 		cnp->cn_flags |= ISDOTDOT;
   2064      1.136  dholland 	else
   2065      1.136  dholland 		cnp->cn_flags &= ~ISDOTDOT;
   2066      1.136  dholland 
   2067      1.160  dholland 	/*
   2068      1.160  dholland 	 * Because lookup_once can change the startdir, we need our
   2069      1.160  dholland 	 * own reference to it to avoid consuming the caller's.
   2070      1.160  dholland 	 */
   2071      1.160  dholland 	vref(startdir);
   2072      1.215        ad 	error = lookup_once(state, startdir, &startdir, &foundobj,
   2073      1.215        ad 	    &startdir_locked);
   2074      1.215        ad 
   2075      1.215        ad 	KASSERT((cnp->cn_flags & LOCKPARENT) == 0);
   2076      1.215        ad 	if (startdir_locked) {
   2077      1.215        ad 		VOP_UNLOCK(startdir);
   2078      1.215        ad 		startdir_locked = false;
   2079      1.190      yamt 	}
   2080      1.162  dholland 
   2081      1.215        ad 	/*
   2082      1.215        ad 	 * If the vnode we found is mounted on, then cross the mount and get
   2083      1.215        ad 	 * the root vnode in foundobj.  If this encounters an error, it will
   2084      1.215        ad 	 * dispose of foundobj, but searchdir is untouched.
   2085      1.215        ad 	 */
   2086      1.215        ad 	if (error == 0 && foundobj != NULL &&
   2087      1.215        ad 	    foundobj->v_type == VDIR &&
   2088      1.215        ad 	    foundobj->v_mountedhere != NULL &&
   2089      1.215        ad 	    (cnp->cn_flags & NOCROSSMOUNT) == 0) {
   2090      1.215        ad 		error = lookup_crossmount(state, &startdir, &foundobj,
   2091      1.215        ad 		    &startdir_locked);
   2092      1.136  dholland 	}
   2093      1.136  dholland 
   2094      1.215        ad 	/* Now toss startdir and see if we have an error. */
   2095      1.215        ad 	if (startdir != NULL)
   2096      1.215        ad 		vrele(startdir);
   2097      1.215        ad 	if (error)
   2098      1.215        ad 		foundobj = NULL;
   2099      1.215        ad 	else if (foundobj != NULL && (cnp->cn_flags & LOCKLEAF) != 0)
   2100      1.215        ad 		vn_lock(foundobj, LK_EXCLUSIVE | LK_RETRY);
   2101      1.136  dholland 
   2102      1.215        ad 	ndp->ni_vp = foundobj;
   2103      1.136  dholland 	return (error);
   2104      1.136  dholland }
   2105      1.136  dholland 
   2106      1.173  dholland /*
   2107      1.173  dholland  * External interface. The partitioning between this function and the
   2108      1.173  dholland  * above isn't very clear - the above function exists mostly so code
   2109      1.173  dholland  * that uses "state->" can be shuffled around without having to change
   2110      1.173  dholland  * it to "state.".
   2111      1.173  dholland  */
   2112      1.118  dholland int
   2113      1.128  dholland lookup_for_nfsd_index(struct nameidata *ndp, struct vnode *startdir)
   2114      1.118  dholland {
   2115      1.118  dholland 	struct namei_state state;
   2116      1.118  dholland 	int error;
   2117      1.118  dholland 
   2118      1.198  dholland 	KASSERT(ndp->ni_atdir == NULL);
   2119      1.198  dholland 	ndp->ni_atdir = startdir;
   2120      1.194  dholland 
   2121      1.133  dholland 	/*
   2122      1.135  dholland 	 * Note: the name sent in here (is not|should not be) allowed
   2123      1.135  dholland 	 * to contain a slash.
   2124      1.133  dholland 	 */
   2125      1.191  christos 	if (strlen(ndp->ni_pathbuf->pb_path) > KERNEL_NAME_MAX) {
   2126      1.136  dholland 		return ENAMETOOLONG;
   2127      1.136  dholland 	}
   2128      1.136  dholland 	if (strchr(ndp->ni_pathbuf->pb_path, '/')) {
   2129      1.136  dholland 		return EINVAL;
   2130      1.136  dholland 	}
   2131      1.133  dholland 
   2132      1.133  dholland 	ndp->ni_pathlen = strlen(ndp->ni_pathbuf->pb_path) + 1;
   2133      1.133  dholland 	ndp->ni_pnbuf = NULL;
   2134      1.133  dholland 	ndp->ni_cnd.cn_nameptr = NULL;
   2135      1.133  dholland 
   2136      1.118  dholland 	namei_init(&state, ndp);
   2137      1.196  dholland 	error = do_lookup_for_nfsd_index(&state);
   2138      1.118  dholland 	namei_cleanup(&state);
   2139      1.118  dholland 
   2140      1.118  dholland 	return error;
   2141      1.118  dholland }
   2142      1.118  dholland 
   2143      1.131  dholland ////////////////////////////////////////////////////////////
   2144      1.131  dholland 
   2145      1.118  dholland /*
   2146       1.12   mycroft  * Reacquire a path name component.
   2147       1.73       chs  * dvp is locked on entry and exit.
   2148       1.73       chs  * *vpp is locked on exit unless it's NULL.
   2149       1.12   mycroft  */
   2150       1.12   mycroft int
   2151      1.130  dholland relookup(struct vnode *dvp, struct vnode **vpp, struct componentname *cnp, int dummy)
   2152       1.12   mycroft {
   2153       1.12   mycroft 	int rdonly;			/* lookup read-only flag bit */
   2154       1.12   mycroft 	int error = 0;
   2155       1.52      yamt #ifdef DEBUG
   2156      1.197  dholland 	size_t newlen;			/* DEBUG: check name len */
   2157      1.197  dholland 	const char *cp;			/* DEBUG: check name ptr */
   2158       1.52      yamt #endif /* DEBUG */
   2159       1.12   mycroft 
   2160      1.130  dholland 	(void)dummy;
   2161      1.130  dholland 
   2162       1.12   mycroft 	/*
   2163       1.12   mycroft 	 * Setup: break out flag bits into variables.
   2164       1.12   mycroft 	 */
   2165       1.12   mycroft 	rdonly = cnp->cn_flags & RDONLY;
   2166       1.12   mycroft 
   2167       1.12   mycroft 	/*
   2168       1.12   mycroft 	 * Search a new directory.
   2169       1.12   mycroft 	 *
   2170       1.12   mycroft 	 * The cn_hash value is for use by vfs_cache.
   2171       1.12   mycroft 	 * The last component of the filename is left accessible via
   2172       1.12   mycroft 	 * cnp->cn_nameptr for callers that need the name. Callers needing
   2173       1.12   mycroft 	 * the name set the SAVENAME flag. When done, they assume
   2174       1.12   mycroft 	 * responsibility for freeing the pathname buffer.
   2175       1.12   mycroft 	 */
   2176       1.52      yamt #ifdef DEBUG
   2177      1.197  dholland #if 0
   2178       1.39     lukem 	cp = NULL;
   2179       1.39     lukem 	newhash = namei_hash(cnp->cn_nameptr, &cp);
   2180       1.81       chs 	if ((uint32_t)newhash != (uint32_t)cnp->cn_hash)
   2181       1.12   mycroft 		panic("relookup: bad hash");
   2182      1.197  dholland #endif
   2183  1.225.4.2   thorpej 	error = VOP_PARSEPATH(dvp, cnp->cn_nameptr, &newlen);
   2184  1.225.4.2   thorpej 	if (error) {
   2185  1.225.4.2   thorpej 		panic("relookup: parsepath failed with error %d", error);
   2186  1.225.4.2   thorpej 	}
   2187      1.197  dholland 	if (cnp->cn_namelen != newlen)
   2188       1.58  christos 		panic("relookup: bad len");
   2189      1.197  dholland 	cp = cnp->cn_nameptr + cnp->cn_namelen;
   2190       1.53      yamt 	while (*cp == '/')
   2191       1.53      yamt 		cp++;
   2192       1.12   mycroft 	if (*cp != 0)
   2193       1.12   mycroft 		panic("relookup: not last component");
   2194       1.52      yamt #endif /* DEBUG */
   2195       1.12   mycroft 
   2196       1.12   mycroft 	/*
   2197       1.12   mycroft 	 * Check for degenerate name (e.g. / or "")
   2198       1.12   mycroft 	 * which is a way of talking about a directory,
   2199       1.12   mycroft 	 * e.g. like "/." or ".".
   2200       1.12   mycroft 	 */
   2201       1.23   mycroft 	if (cnp->cn_nameptr[0] == '\0')
   2202       1.23   mycroft 		panic("relookup: null name");
   2203       1.12   mycroft 
   2204       1.12   mycroft 	if (cnp->cn_flags & ISDOTDOT)
   2205       1.58  christos 		panic("relookup: lookup on dot-dot");
   2206       1.12   mycroft 
   2207       1.12   mycroft 	/*
   2208       1.12   mycroft 	 * We now have a segment name to search for, and a directory to search.
   2209       1.12   mycroft 	 */
   2210      1.195  dholland 	*vpp = NULL;
   2211      1.129  dholland 	error = VOP_LOOKUP(dvp, vpp, cnp);
   2212      1.129  dholland 	if ((error) != 0) {
   2213      1.205  riastrad 		KASSERTMSG((*vpp == NULL),
   2214      1.205  riastrad 		    "leaf `%s' should be empty but is %p",
   2215      1.205  riastrad 		    cnp->cn_nameptr, *vpp);
   2216       1.12   mycroft 		if (error != EJUSTRETURN)
   2217       1.12   mycroft 			goto bad;
   2218       1.12   mycroft 	}
   2219       1.12   mycroft 
   2220       1.12   mycroft 	/*
   2221       1.12   mycroft 	 * Check for symbolic link
   2222       1.12   mycroft 	 */
   2223      1.205  riastrad 	KASSERTMSG((*vpp == NULL || (*vpp)->v_type != VLNK ||
   2224      1.205  riastrad 		(cnp->cn_flags & FOLLOW) == 0),
   2225      1.205  riastrad 	    "relookup: symlink found");
   2226       1.12   mycroft 
   2227       1.12   mycroft 	/*
   2228       1.94     pooka 	 * Check for read-only lookups.
   2229       1.12   mycroft 	 */
   2230       1.81       chs 	if (rdonly && cnp->cn_nameiop != LOOKUP) {
   2231       1.26      fvdl 		error = EROFS;
   2232       1.81       chs 		if (*vpp) {
   2233      1.201   hannken 			vrele(*vpp);
   2234       1.81       chs 		}
   2235       1.73       chs 		goto bad;
   2236       1.12   mycroft 	}
   2237      1.201   hannken 	/*
   2238      1.201   hannken 	 * Lock result.
   2239      1.201   hannken 	 */
   2240      1.201   hannken 	if (*vpp && *vpp != dvp) {
   2241      1.201   hannken 		error = vn_lock(*vpp, LK_EXCLUSIVE);
   2242      1.201   hannken 		if (error != 0) {
   2243      1.201   hannken 			vrele(*vpp);
   2244      1.201   hannken 			goto bad;
   2245      1.201   hannken 		}
   2246      1.201   hannken 	}
   2247       1.12   mycroft 	return (0);
   2248       1.12   mycroft 
   2249       1.12   mycroft bad:
   2250       1.12   mycroft 	*vpp = NULL;
   2251       1.10       cgd 	return (error);
   2252       1.10       cgd }
   2253      1.116  dholland 
   2254      1.116  dholland /*
   2255      1.116  dholland  * namei_simple - simple forms of namei.
   2256      1.116  dholland  *
   2257      1.116  dholland  * These are wrappers to allow the simple case callers of namei to be
   2258      1.116  dholland  * left alone while everything else changes under them.
   2259      1.116  dholland  */
   2260      1.116  dholland 
   2261      1.116  dholland /* Flags */
   2262      1.116  dholland struct namei_simple_flags_type {
   2263      1.116  dholland 	int dummy;
   2264      1.116  dholland };
   2265      1.116  dholland static const struct namei_simple_flags_type ns_nn, ns_nt, ns_fn, ns_ft;
   2266      1.116  dholland const namei_simple_flags_t NSM_NOFOLLOW_NOEMULROOT = &ns_nn;
   2267      1.116  dholland const namei_simple_flags_t NSM_NOFOLLOW_TRYEMULROOT = &ns_nt;
   2268      1.116  dholland const namei_simple_flags_t NSM_FOLLOW_NOEMULROOT = &ns_fn;
   2269      1.116  dholland const namei_simple_flags_t NSM_FOLLOW_TRYEMULROOT = &ns_ft;
   2270      1.116  dholland 
   2271      1.116  dholland static
   2272      1.116  dholland int
   2273      1.116  dholland namei_simple_convert_flags(namei_simple_flags_t sflags)
   2274      1.116  dholland {
   2275      1.116  dholland 	if (sflags == NSM_NOFOLLOW_NOEMULROOT)
   2276      1.116  dholland 		return NOFOLLOW | 0;
   2277      1.116  dholland 	if (sflags == NSM_NOFOLLOW_TRYEMULROOT)
   2278      1.116  dholland 		return NOFOLLOW | TRYEMULROOT;
   2279      1.116  dholland 	if (sflags == NSM_FOLLOW_NOEMULROOT)
   2280      1.116  dholland 		return FOLLOW | 0;
   2281      1.116  dholland 	if (sflags == NSM_FOLLOW_TRYEMULROOT)
   2282      1.116  dholland 		return FOLLOW | TRYEMULROOT;
   2283      1.116  dholland 	panic("namei_simple_convert_flags: bogus sflags\n");
   2284      1.116  dholland 	return 0;
   2285      1.116  dholland }
   2286      1.116  dholland 
   2287      1.116  dholland int
   2288      1.116  dholland namei_simple_kernel(const char *path, namei_simple_flags_t sflags,
   2289      1.200      manu 	struct vnode **vp_ret)
   2290      1.200      manu {
   2291      1.200      manu 	return nameiat_simple_kernel(NULL, path, sflags, vp_ret);
   2292      1.200      manu }
   2293      1.200      manu 
   2294      1.200      manu int
   2295      1.223  riastrad nameiat_simple_kernel(struct vnode *dvp, const char *path,
   2296      1.200      manu 	namei_simple_flags_t sflags, struct vnode **vp_ret)
   2297      1.116  dholland {
   2298      1.116  dholland 	struct nameidata nd;
   2299      1.123  dholland 	struct pathbuf *pb;
   2300      1.116  dholland 	int err;
   2301      1.116  dholland 
   2302      1.123  dholland 	pb = pathbuf_create(path);
   2303      1.123  dholland 	if (pb == NULL) {
   2304      1.123  dholland 		return ENOMEM;
   2305      1.123  dholland 	}
   2306      1.123  dholland 
   2307      1.116  dholland 	NDINIT(&nd,
   2308      1.116  dholland 		LOOKUP,
   2309      1.116  dholland 		namei_simple_convert_flags(sflags),
   2310      1.123  dholland 		pb);
   2311      1.200      manu 
   2312      1.200      manu 	if (dvp != NULL)
   2313      1.200      manu 		NDAT(&nd, dvp);
   2314      1.200      manu 
   2315      1.116  dholland 	err = namei(&nd);
   2316      1.116  dholland 	if (err != 0) {
   2317      1.123  dholland 		pathbuf_destroy(pb);
   2318      1.116  dholland 		return err;
   2319      1.116  dholland 	}
   2320      1.116  dholland 	*vp_ret = nd.ni_vp;
   2321      1.123  dholland 	pathbuf_destroy(pb);
   2322      1.116  dholland 	return 0;
   2323      1.116  dholland }
   2324      1.116  dholland 
   2325      1.116  dholland int
   2326      1.116  dholland namei_simple_user(const char *path, namei_simple_flags_t sflags,
   2327      1.200      manu 	struct vnode **vp_ret)
   2328      1.200      manu {
   2329      1.200      manu 	return nameiat_simple_user(NULL, path, sflags, vp_ret);
   2330      1.200      manu }
   2331      1.200      manu 
   2332      1.200      manu int
   2333      1.200      manu nameiat_simple_user(struct vnode *dvp, const char *path,
   2334      1.200      manu 	namei_simple_flags_t sflags, struct vnode **vp_ret)
   2335      1.116  dholland {
   2336      1.123  dholland 	struct pathbuf *pb;
   2337      1.116  dholland 	struct nameidata nd;
   2338      1.116  dholland 	int err;
   2339      1.116  dholland 
   2340      1.123  dholland 	err = pathbuf_copyin(path, &pb);
   2341      1.123  dholland 	if (err) {
   2342      1.123  dholland 		return err;
   2343      1.123  dholland 	}
   2344      1.123  dholland 
   2345      1.116  dholland 	NDINIT(&nd,
   2346      1.116  dholland 		LOOKUP,
   2347      1.116  dholland 		namei_simple_convert_flags(sflags),
   2348      1.123  dholland 		pb);
   2349      1.200      manu 
   2350      1.200      manu 	if (dvp != NULL)
   2351      1.200      manu 		NDAT(&nd, dvp);
   2352      1.200      manu 
   2353      1.116  dholland 	err = namei(&nd);
   2354      1.116  dholland 	if (err != 0) {
   2355      1.123  dholland 		pathbuf_destroy(pb);
   2356      1.116  dholland 		return err;
   2357      1.116  dholland 	}
   2358      1.116  dholland 	*vp_ret = nd.ni_vp;
   2359      1.123  dholland 	pathbuf_destroy(pb);
   2360      1.116  dholland 	return 0;
   2361      1.116  dholland }
   2362