Home | History | Annotate | Line # | Download | only in kern
vfs_lookup.c revision 1.49
      1  1.49       agc /*	$NetBSD: vfs_lookup.c,v 1.49 2003/08/07 16:32:02 agc 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.49       agc __KERNEL_RCSID(0, "$NetBSD: vfs_lookup.c,v 1.49 2003/08/07 16:32:02 agc Exp $");
     41  1.27   thorpej 
     42  1.27   thorpej #include "opt_ktrace.h"
     43  1.10       cgd 
     44  1.10       cgd #include <sys/param.h>
     45  1.15       cgd #include <sys/systm.h>
     46  1.10       cgd #include <sys/syslimits.h>
     47  1.10       cgd #include <sys/time.h>
     48  1.10       cgd #include <sys/namei.h>
     49  1.10       cgd #include <sys/vnode.h>
     50  1.10       cgd #include <sys/mount.h>
     51  1.10       cgd #include <sys/errno.h>
     52  1.39     lukem #include <sys/filedesc.h>
     53  1.39     lukem #include <sys/hash.h>
     54  1.10       cgd #include <sys/malloc.h>
     55  1.10       cgd #include <sys/proc.h>
     56  1.40  wrstuden #include <sys/syslog.h>
     57  1.12   mycroft 
     58  1.10       cgd #ifdef KTRACE
     59  1.10       cgd #include <sys/ktrace.h>
     60  1.10       cgd #endif
     61  1.16  christos 
     62  1.35   thorpej struct pool pnbuf_pool;		/* pathname buffer pool */
     63  1.37   thorpej struct pool_cache pnbuf_cache;	/* pathname buffer cache */
     64  1.44   thorpej 
     65  1.44   thorpej MALLOC_DEFINE(M_NAMEI, "namei", "namei path buffer");
     66  1.35   thorpej 
     67  1.10       cgd /*
     68  1.10       cgd  * Convert a pathname into a pointer to a locked inode.
     69  1.10       cgd  *
     70  1.10       cgd  * The FOLLOW flag is set when symbolic links are to be followed
     71  1.10       cgd  * when they occur at the end of the name translation process.
     72  1.10       cgd  * Symbolic links are always followed for all other pathname
     73  1.10       cgd  * components other than the last.
     74  1.10       cgd  *
     75  1.10       cgd  * The segflg defines whether the name is to be copied from user
     76  1.10       cgd  * space or kernel space.
     77  1.10       cgd  *
     78  1.10       cgd  * Overall outline of namei:
     79  1.10       cgd  *
     80  1.10       cgd  *	copy in name
     81  1.10       cgd  *	get starting directory
     82  1.10       cgd  *	while (!done && !error) {
     83  1.10       cgd  *		call lookup to search path.
     84  1.10       cgd  *		if symbolic link, massage name in buffer and continue
     85  1.10       cgd  *	}
     86  1.10       cgd  */
     87  1.12   mycroft int
     88  1.12   mycroft namei(ndp)
     89  1.33  augustss 	struct nameidata *ndp;
     90  1.10       cgd {
     91  1.30   thorpej 	struct cwdinfo *cwdi;		/* pointer to cwd state */
     92  1.33  augustss 	char *cp;			/* pointer into pathname argument */
     93  1.33  augustss 	struct vnode *dp;		/* the directory we are searching */
     94  1.10       cgd 	struct iovec aiov;		/* uio for reading symbolic links */
     95  1.10       cgd 	struct uio auio;
     96  1.23   mycroft 	int error, linklen;
     97  1.12   mycroft 	struct componentname *cnp = &ndp->ni_cnd;
     98  1.10       cgd 
     99  1.12   mycroft #ifdef DIAGNOSTIC
    100  1.48      fvdl 	if (!cnp->cn_cred || !cnp->cn_proc)
    101  1.12   mycroft 		panic ("namei: bad cred/proc");
    102  1.12   mycroft 	if (cnp->cn_nameiop & (~OPMASK))
    103  1.12   mycroft 		panic ("namei: nameiop contaminated with flags");
    104  1.12   mycroft 	if (cnp->cn_flags & OPMASK)
    105  1.12   mycroft 		panic ("namei: flags contaminated with nameiops");
    106  1.12   mycroft #endif
    107  1.48      fvdl 	cwdi = cnp->cn_proc->p_cwdi;
    108  1.10       cgd 
    109  1.10       cgd 	/*
    110  1.10       cgd 	 * Get a buffer for the name to be translated, and copy the
    111  1.10       cgd 	 * name into the buffer.
    112  1.10       cgd 	 */
    113  1.12   mycroft 	if ((cnp->cn_flags & HASBUF) == 0)
    114  1.35   thorpej 		cnp->cn_pnbuf = PNBUF_GET();
    115  1.10       cgd 	if (ndp->ni_segflg == UIO_SYSSPACE)
    116  1.12   mycroft 		error = copystr(ndp->ni_dirp, cnp->cn_pnbuf,
    117  1.10       cgd 			    MAXPATHLEN, &ndp->ni_pathlen);
    118  1.10       cgd 	else
    119  1.12   mycroft 		error = copyinstr(ndp->ni_dirp, cnp->cn_pnbuf,
    120  1.10       cgd 			    MAXPATHLEN, &ndp->ni_pathlen);
    121  1.21    kleink 
    122  1.21    kleink 	/*
    123  1.21    kleink 	 * POSIX.1 requirement: "" is not a valid file name.
    124  1.21    kleink 	 */
    125  1.21    kleink 	if (!error && ndp->ni_pathlen == 1)
    126  1.21    kleink 		error = ENOENT;
    127  1.21    kleink 
    128  1.10       cgd 	if (error) {
    129  1.35   thorpej 		PNBUF_PUT(cnp->cn_pnbuf);
    130  1.10       cgd 		ndp->ni_vp = NULL;
    131  1.10       cgd 		return (error);
    132  1.10       cgd 	}
    133  1.10       cgd 	ndp->ni_loopcnt = 0;
    134  1.21    kleink 
    135  1.10       cgd #ifdef KTRACE
    136  1.48      fvdl 	if (KTRPOINT(cnp->cn_proc, KTR_NAMEI))
    137  1.48      fvdl 		ktrnamei(cnp->cn_proc, cnp->cn_pnbuf);
    138  1.10       cgd #endif
    139  1.10       cgd 
    140  1.10       cgd 	/*
    141  1.10       cgd 	 * Get starting point for the translation.
    142  1.10       cgd 	 */
    143  1.30   thorpej 	if ((ndp->ni_rootdir = cwdi->cwdi_rdir) == NULL)
    144  1.11       cgd 		ndp->ni_rootdir = rootvnode;
    145  1.23   mycroft 	/*
    146  1.23   mycroft 	 * Check if starting from root directory or current directory.
    147  1.23   mycroft 	 */
    148  1.23   mycroft 	if (cnp->cn_pnbuf[0] == '/') {
    149  1.23   mycroft 		dp = ndp->ni_rootdir;
    150  1.23   mycroft 		VREF(dp);
    151  1.23   mycroft 	} else {
    152  1.30   thorpej 		dp = cwdi->cwdi_cdir;
    153  1.23   mycroft 		VREF(dp);
    154  1.23   mycroft 	}
    155  1.10       cgd 	for (;;) {
    156  1.45       erh 		if (!dp->v_mount)
    157  1.45       erh 		{
    158  1.45       erh 			/* Give up if the directory is no longer mounted */
    159  1.45       erh 			PNBUF_PUT(cnp->cn_pnbuf);
    160  1.45       erh 			return (ENOENT);
    161  1.45       erh 		}
    162  1.12   mycroft 		cnp->cn_nameptr = cnp->cn_pnbuf;
    163  1.10       cgd 		ndp->ni_startdir = dp;
    164  1.16  christos 		if ((error = lookup(ndp)) != 0) {
    165  1.35   thorpej 			PNBUF_PUT(cnp->cn_pnbuf);
    166  1.10       cgd 			return (error);
    167  1.10       cgd 		}
    168  1.10       cgd 		/*
    169  1.10       cgd 		 * Check for symbolic link
    170  1.10       cgd 		 */
    171  1.12   mycroft 		if ((cnp->cn_flags & ISSYMLINK) == 0) {
    172  1.12   mycroft 			if ((cnp->cn_flags & (SAVENAME | SAVESTART)) == 0)
    173  1.35   thorpej 				PNBUF_PUT(cnp->cn_pnbuf);
    174  1.10       cgd 			else
    175  1.12   mycroft 				cnp->cn_flags |= HASBUF;
    176  1.10       cgd 			return (0);
    177  1.10       cgd 		}
    178  1.29  wrstuden 		if ((cnp->cn_flags & LOCKPARENT) && (cnp->cn_flags & ISLASTCN))
    179  1.26      fvdl 			VOP_UNLOCK(ndp->ni_dvp, 0);
    180  1.10       cgd 		if (ndp->ni_loopcnt++ >= MAXSYMLINKS) {
    181  1.10       cgd 			error = ELOOP;
    182  1.10       cgd 			break;
    183  1.10       cgd 		}
    184  1.25     enami 		if (ndp->ni_vp->v_mount->mnt_flag & MNT_SYMPERM) {
    185  1.25     enami 			error = VOP_ACCESS(ndp->ni_vp, VEXEC, cnp->cn_cred,
    186  1.48      fvdl 			    cnp->cn_proc);
    187  1.25     enami 			if (error != 0)
    188  1.25     enami 				break;
    189  1.25     enami 		}
    190  1.10       cgd 		if (ndp->ni_pathlen > 1)
    191  1.35   thorpej 			cp = PNBUF_GET();
    192  1.10       cgd 		else
    193  1.12   mycroft 			cp = cnp->cn_pnbuf;
    194  1.10       cgd 		aiov.iov_base = cp;
    195  1.10       cgd 		aiov.iov_len = MAXPATHLEN;
    196  1.10       cgd 		auio.uio_iov = &aiov;
    197  1.10       cgd 		auio.uio_iovcnt = 1;
    198  1.10       cgd 		auio.uio_offset = 0;
    199  1.10       cgd 		auio.uio_rw = UIO_READ;
    200  1.10       cgd 		auio.uio_segflg = UIO_SYSSPACE;
    201  1.48      fvdl 		auio.uio_procp = (struct proc *)0;
    202  1.10       cgd 		auio.uio_resid = MAXPATHLEN;
    203  1.16  christos 		error = VOP_READLINK(ndp->ni_vp, &auio, cnp->cn_cred);
    204  1.16  christos 		if (error) {
    205  1.23   mycroft 		badlink:
    206  1.10       cgd 			if (ndp->ni_pathlen > 1)
    207  1.35   thorpej 				PNBUF_PUT(cp);
    208  1.10       cgd 			break;
    209  1.10       cgd 		}
    210  1.10       cgd 		linklen = MAXPATHLEN - auio.uio_resid;
    211  1.23   mycroft 		if (linklen == 0) {
    212  1.23   mycroft 			error = ENOENT;
    213  1.23   mycroft 			goto badlink;
    214  1.23   mycroft 		}
    215  1.10       cgd 		if (linklen + ndp->ni_pathlen >= MAXPATHLEN) {
    216  1.10       cgd 			error = ENAMETOOLONG;
    217  1.23   mycroft 			goto badlink;
    218  1.10       cgd 		}
    219  1.10       cgd 		if (ndp->ni_pathlen > 1) {
    220  1.28     perry 			memcpy(cp + linklen, ndp->ni_next, ndp->ni_pathlen);
    221  1.35   thorpej 			PNBUF_PUT(cnp->cn_pnbuf);
    222  1.12   mycroft 			cnp->cn_pnbuf = cp;
    223  1.10       cgd 		} else
    224  1.12   mycroft 			cnp->cn_pnbuf[linklen] = '\0';
    225  1.10       cgd 		ndp->ni_pathlen += linklen;
    226  1.10       cgd 		vput(ndp->ni_vp);
    227  1.10       cgd 		dp = ndp->ni_dvp;
    228  1.23   mycroft 		/*
    229  1.23   mycroft 		 * Check if root directory should replace current directory.
    230  1.23   mycroft 		 */
    231  1.23   mycroft 		if (cnp->cn_pnbuf[0] == '/') {
    232  1.23   mycroft 			vrele(dp);
    233  1.23   mycroft 			dp = ndp->ni_rootdir;
    234  1.23   mycroft 			VREF(dp);
    235  1.23   mycroft 		}
    236  1.10       cgd 	}
    237  1.35   thorpej 	PNBUF_PUT(cnp->cn_pnbuf);
    238  1.10       cgd 	vrele(ndp->ni_dvp);
    239  1.10       cgd 	vput(ndp->ni_vp);
    240  1.10       cgd 	ndp->ni_vp = NULL;
    241  1.10       cgd 	return (error);
    242  1.10       cgd }
    243  1.10       cgd 
    244  1.10       cgd /*
    245  1.39     lukem  * Determine the namei hash (for cn_hash) for name.
    246  1.39     lukem  * If *ep != NULL, hash from name to ep-1.
    247  1.39     lukem  * If *ep == NULL, hash from name until the first NUL or '/', and
    248  1.39     lukem  * return the location of this termination character in *ep.
    249  1.39     lukem  *
    250  1.39     lukem  * This function returns an equivalent hash to the MI hash32_strn().
    251  1.39     lukem  * The latter isn't used because in the *ep == NULL case, determining
    252  1.39     lukem  * the length of the string to the first NUL or `/' and then calling
    253  1.39     lukem  * hash32_strn() involves unnecessary double-handling of the data.
    254  1.39     lukem  */
    255  1.39     lukem uint32_t
    256  1.39     lukem namei_hash(const char *name, const char **ep)
    257  1.39     lukem {
    258  1.39     lukem 	uint32_t	hash;
    259  1.39     lukem 
    260  1.39     lukem 	hash = HASH32_STR_INIT;
    261  1.39     lukem 	if (*ep != NULL) {
    262  1.39     lukem 		for (; name < *ep; name++)
    263  1.39     lukem 			hash = hash * 33 + *(uint8_t *)name;
    264  1.39     lukem 	} else {
    265  1.39     lukem 		for (; *name != '\0' && *name != '/'; name++)
    266  1.39     lukem 			hash = hash * 33 + *(uint8_t *)name;
    267  1.39     lukem 		*ep = name;
    268  1.39     lukem 	}
    269  1.39     lukem 	return (hash + (hash >> 5));
    270  1.39     lukem }
    271  1.39     lukem 
    272  1.39     lukem /*
    273  1.10       cgd  * Search a pathname.
    274  1.10       cgd  * This is a very central and rather complicated routine.
    275  1.10       cgd  *
    276  1.10       cgd  * The pathname is pointed to by ni_ptr and is of length ni_pathlen.
    277  1.10       cgd  * The starting directory is taken from ni_startdir. The pathname is
    278  1.10       cgd  * descended until done, or a symbolic link is encountered. The variable
    279  1.10       cgd  * ni_more is clear if the path is completed; it is set to one if a
    280  1.10       cgd  * symbolic link needing interpretation is encountered.
    281  1.10       cgd  *
    282  1.10       cgd  * The flag argument is LOOKUP, CREATE, RENAME, or DELETE depending on
    283  1.10       cgd  * whether the name is to be looked up, created, renamed, or deleted.
    284  1.10       cgd  * When CREATE, RENAME, or DELETE is specified, information usable in
    285  1.10       cgd  * creating, renaming, or deleting a directory entry may be calculated.
    286  1.10       cgd  * If flag has LOCKPARENT or'ed into it, the parent directory is returned
    287  1.10       cgd  * locked. If flag has WANTPARENT or'ed into it, the parent directory is
    288  1.10       cgd  * returned unlocked. Otherwise the parent directory is not returned. If
    289  1.10       cgd  * the target of the pathname exists and LOCKLEAF is or'ed into the flag
    290  1.10       cgd  * the target is returned locked, otherwise it is returned unlocked.
    291  1.10       cgd  * When creating or renaming and LOCKPARENT is specified, the target may not
    292  1.10       cgd  * be ".".  When deleting and LOCKPARENT is specified, the target may be ".".
    293  1.10       cgd  *
    294  1.10       cgd  * Overall outline of lookup:
    295  1.10       cgd  *
    296  1.10       cgd  * dirloop:
    297  1.10       cgd  *	identify next component of name at ndp->ni_ptr
    298  1.10       cgd  *	handle degenerate case where name is null string
    299  1.10       cgd  *	if .. and crossing mount points and on mounted filesys, find parent
    300  1.10       cgd  *	call VOP_LOOKUP routine for next component name
    301  1.10       cgd  *	    directory vnode returned in ni_dvp, unlocked unless LOCKPARENT set
    302  1.10       cgd  *	    component vnode returned in ni_vp (if it exists), locked.
    303  1.10       cgd  *	if result vnode is mounted on and crossing mount points,
    304  1.10       cgd  *	    find mounted on vnode
    305  1.10       cgd  *	if more components of name, do next level at dirloop
    306  1.10       cgd  *	return the answer in ni_vp, locked if LOCKLEAF set
    307  1.10       cgd  *	    if LOCKPARENT set, return locked parent in ni_dvp
    308  1.10       cgd  *	    if WANTPARENT set, return unlocked parent in ni_dvp
    309  1.10       cgd  */
    310  1.12   mycroft int
    311  1.12   mycroft lookup(ndp)
    312  1.33  augustss 	struct nameidata *ndp;
    313  1.10       cgd {
    314  1.33  augustss 	const char *cp;			/* pointer into pathname argument */
    315  1.33  augustss 	struct vnode *dp = 0;		/* the directory we are searching */
    316  1.10       cgd 	struct vnode *tdp;		/* saved dp */
    317  1.10       cgd 	struct mount *mp;		/* mount table entry */
    318  1.10       cgd 	int docache;			/* == 0 do not cache last component */
    319  1.10       cgd 	int wantparent;			/* 1 => wantparent or lockparent flag */
    320  1.12   mycroft 	int rdonly;			/* lookup read-only flag bit */
    321  1.10       cgd 	int error = 0;
    322  1.23   mycroft 	int slashes;
    323  1.32  wrstuden 	int dpunlocked = 0;		/* dp has already been unlocked */
    324  1.12   mycroft 	struct componentname *cnp = &ndp->ni_cnd;
    325  1.10       cgd 
    326  1.10       cgd 	/*
    327  1.10       cgd 	 * Setup: break out flag bits into variables.
    328  1.10       cgd 	 */
    329  1.12   mycroft 	wantparent = cnp->cn_flags & (LOCKPARENT | WANTPARENT);
    330  1.12   mycroft 	docache = (cnp->cn_flags & NOCACHE) ^ NOCACHE;
    331  1.12   mycroft 	if (cnp->cn_nameiop == DELETE ||
    332  1.12   mycroft 	    (wantparent && cnp->cn_nameiop != CREATE))
    333  1.10       cgd 		docache = 0;
    334  1.12   mycroft 	rdonly = cnp->cn_flags & RDONLY;
    335  1.10       cgd 	ndp->ni_dvp = NULL;
    336  1.12   mycroft 	cnp->cn_flags &= ~ISSYMLINK;
    337  1.10       cgd 	dp = ndp->ni_startdir;
    338  1.10       cgd 	ndp->ni_startdir = NULLVP;
    339  1.26      fvdl 	vn_lock(dp, LK_EXCLUSIVE | LK_RETRY);
    340  1.10       cgd 
    341  1.23   mycroft 	/*
    342  1.23   mycroft 	 * If we have a leading string of slashes, remove them, and just make
    343  1.23   mycroft 	 * sure the current node is a directory.
    344  1.23   mycroft 	 */
    345  1.23   mycroft 	cp = cnp->cn_nameptr;
    346  1.23   mycroft 	if (*cp == '/') {
    347  1.23   mycroft 		do {
    348  1.23   mycroft 			cp++;
    349  1.23   mycroft 		} while (*cp == '/');
    350  1.23   mycroft 		ndp->ni_pathlen -= cp - cnp->cn_nameptr;
    351  1.23   mycroft 		cnp->cn_nameptr = cp;
    352  1.23   mycroft 
    353  1.23   mycroft 		if (dp->v_type != VDIR) {
    354  1.23   mycroft 			error = ENOTDIR;
    355  1.23   mycroft 			goto bad;
    356  1.23   mycroft 		}
    357  1.23   mycroft 
    358  1.23   mycroft 		/*
    359  1.23   mycroft 		 * If we've exhausted the path name, then just return the
    360  1.23   mycroft 		 * current node.  If the caller requested the parent node (i.e.
    361  1.23   mycroft 		 * it's a CREATE, DELETE, or RENAME), and we don't have one
    362  1.23   mycroft 		 * (because this is the root directory), then we must fail.
    363  1.23   mycroft 		 */
    364  1.23   mycroft 		if (cnp->cn_nameptr[0] == '\0') {
    365  1.23   mycroft 			if (ndp->ni_dvp == NULL && wantparent) {
    366  1.23   mycroft 				error = EISDIR;
    367  1.23   mycroft 				goto bad;
    368  1.23   mycroft 			}
    369  1.23   mycroft 			ndp->ni_vp = dp;
    370  1.23   mycroft 			cnp->cn_flags |= ISLASTCN;
    371  1.23   mycroft 			goto terminal;
    372  1.23   mycroft 		}
    373  1.23   mycroft 	}
    374  1.23   mycroft 
    375  1.10       cgd dirloop:
    376  1.10       cgd 	/*
    377  1.10       cgd 	 * Search a new directory.
    378  1.10       cgd 	 *
    379  1.12   mycroft 	 * The cn_hash value is for use by vfs_cache.
    380  1.10       cgd 	 * The last component of the filename is left accessible via
    381  1.12   mycroft 	 * cnp->cn_nameptr for callers that need the name. Callers needing
    382  1.10       cgd 	 * the name set the SAVENAME flag. When done, they assume
    383  1.10       cgd 	 * responsibility for freeing the pathname buffer.
    384  1.10       cgd 	 */
    385  1.12   mycroft 	cnp->cn_consume = 0;
    386  1.39     lukem 	cp = NULL;
    387  1.39     lukem 	cnp->cn_hash = namei_hash(cnp->cn_nameptr, &cp);
    388  1.12   mycroft 	cnp->cn_namelen = cp - cnp->cn_nameptr;
    389  1.12   mycroft 	if (cnp->cn_namelen > NAME_MAX) {
    390  1.10       cgd 		error = ENAMETOOLONG;
    391  1.10       cgd 		goto bad;
    392  1.10       cgd 	}
    393  1.10       cgd #ifdef NAMEI_DIAGNOSTIC
    394  1.10       cgd 	{ char c = *cp;
    395  1.41     soren 	*(char *)cp = '\0';
    396  1.19  christos 	printf("{%s}: ", cnp->cn_nameptr);
    397  1.41     soren 	*(char *)cp = c; }
    398  1.10       cgd #endif
    399  1.12   mycroft 	ndp->ni_pathlen -= cnp->cn_namelen;
    400  1.10       cgd 	ndp->ni_next = cp;
    401  1.23   mycroft 	/*
    402  1.23   mycroft 	 * If this component is followed by a slash, then move the pointer to
    403  1.23   mycroft 	 * the next component forward, and remember that this component must be
    404  1.23   mycroft 	 * a directory.
    405  1.23   mycroft 	 */
    406  1.23   mycroft 	if (*cp == '/') {
    407  1.23   mycroft 		do {
    408  1.23   mycroft 			cp++;
    409  1.23   mycroft 		} while (*cp == '/');
    410  1.23   mycroft 		slashes = cp - ndp->ni_next;
    411  1.23   mycroft 		ndp->ni_pathlen -= slashes;
    412  1.23   mycroft 		ndp->ni_next = cp;
    413  1.23   mycroft 		cnp->cn_flags |= REQUIREDIR;
    414  1.23   mycroft 	} else {
    415  1.23   mycroft 		slashes = 0;
    416  1.23   mycroft 		cnp->cn_flags &= ~REQUIREDIR;
    417  1.23   mycroft 	}
    418  1.23   mycroft 	/*
    419  1.23   mycroft 	 * We do special processing on the last component, whether or not it's
    420  1.23   mycroft 	 * a directory.  Cache all intervening lookups, but not the final one.
    421  1.23   mycroft 	 */
    422  1.23   mycroft 	if (*cp == '\0') {
    423  1.23   mycroft 		if (docache)
    424  1.23   mycroft 			cnp->cn_flags |= MAKEENTRY;
    425  1.23   mycroft 		else
    426  1.23   mycroft 			cnp->cn_flags &= ~MAKEENTRY;
    427  1.23   mycroft 		cnp->cn_flags |= ISLASTCN;
    428  1.23   mycroft 	} else {
    429  1.23   mycroft 		cnp->cn_flags |= MAKEENTRY;
    430  1.23   mycroft 		cnp->cn_flags &= ~ISLASTCN;
    431  1.23   mycroft 	}
    432  1.12   mycroft 	if (cnp->cn_namelen == 2 &&
    433  1.12   mycroft 	    cnp->cn_nameptr[1] == '.' && cnp->cn_nameptr[0] == '.')
    434  1.12   mycroft 		cnp->cn_flags |= ISDOTDOT;
    435  1.12   mycroft 	else
    436  1.12   mycroft 		cnp->cn_flags &= ~ISDOTDOT;
    437  1.10       cgd 
    438  1.10       cgd 	/*
    439  1.10       cgd 	 * Handle "..": two special cases.
    440  1.10       cgd 	 * 1. If at root directory (e.g. after chroot)
    441  1.12   mycroft 	 *    or at absolute root directory
    442  1.10       cgd 	 *    then ignore it so can't get out.
    443  1.40  wrstuden 	 * 1a. If we have somehow gotten out of a jail, warn
    444  1.40  wrstuden 	 *    and also ignore it so we can't get farther out.
    445  1.10       cgd 	 * 2. If this vnode is the root of a mounted
    446  1.10       cgd 	 *    filesystem, then replace it with the
    447  1.10       cgd 	 *    vnode which was mounted on so we take the
    448  1.10       cgd 	 *    .. in the other file system.
    449  1.10       cgd 	 */
    450  1.12   mycroft 	if (cnp->cn_flags & ISDOTDOT) {
    451  1.10       cgd 		for (;;) {
    452  1.12   mycroft 			if (dp == ndp->ni_rootdir || dp == rootvnode) {
    453  1.10       cgd 				ndp->ni_dvp = dp;
    454  1.10       cgd 				ndp->ni_vp = dp;
    455  1.10       cgd 				VREF(dp);
    456  1.10       cgd 				goto nextname;
    457  1.40  wrstuden 			}
    458  1.40  wrstuden 			if (ndp->ni_rootdir != rootvnode) {
    459  1.40  wrstuden 				int retval;
    460  1.40  wrstuden 				VOP_UNLOCK(dp, 0);
    461  1.48      fvdl 				retval = vn_isunder(dp, ndp->ni_rootdir,
    462  1.48      fvdl 				    cnp->cn_proc);
    463  1.40  wrstuden 				vn_lock(dp, LK_EXCLUSIVE | LK_RETRY);
    464  1.40  wrstuden 				if (!retval) {
    465  1.40  wrstuden 				    /* Oops! We got out of jail! */
    466  1.40  wrstuden 				    log(LOG_WARNING,
    467  1.40  wrstuden 					"chrooted pid %d uid %d (%s) "
    468  1.40  wrstuden 					"detected outside of its chroot\n",
    469  1.48      fvdl 					cnp->cn_proc->p_pid,
    470  1.48      fvdl 					cnp->cn_proc->p_ucred->cr_uid,
    471  1.48      fvdl 					cnp->cn_proc->p_comm);
    472  1.40  wrstuden 				    /* Put us at the jail root. */
    473  1.40  wrstuden 				    vput(dp);
    474  1.40  wrstuden 				    dp = ndp->ni_rootdir;
    475  1.40  wrstuden 				    ndp->ni_dvp = dp;
    476  1.40  wrstuden 				    ndp->ni_vp = dp;
    477  1.40  wrstuden 				    VREF(dp);
    478  1.40  wrstuden 				    VREF(dp);
    479  1.40  wrstuden 				    vn_lock(dp, LK_EXCLUSIVE | LK_RETRY);
    480  1.40  wrstuden 				    goto nextname;
    481  1.40  wrstuden 				}
    482  1.10       cgd 			}
    483  1.10       cgd 			if ((dp->v_flag & VROOT) == 0 ||
    484  1.12   mycroft 			    (cnp->cn_flags & NOCROSSMOUNT))
    485  1.10       cgd 				break;
    486  1.10       cgd 			tdp = dp;
    487  1.10       cgd 			dp = dp->v_mount->mnt_vnodecovered;
    488  1.10       cgd 			vput(tdp);
    489  1.10       cgd 			VREF(dp);
    490  1.26      fvdl 			vn_lock(dp, LK_EXCLUSIVE | LK_RETRY);
    491  1.10       cgd 		}
    492  1.10       cgd 	}
    493  1.10       cgd 
    494  1.10       cgd 	/*
    495  1.10       cgd 	 * We now have a segment name to search for, and a directory to search.
    496  1.10       cgd 	 */
    497  1.12   mycroft unionlookup:
    498  1.12   mycroft 	ndp->ni_dvp = dp;
    499  1.26      fvdl 	ndp->ni_vp = NULL;
    500  1.31  wrstuden 	cnp->cn_flags &= ~PDIRUNLOCK;
    501  1.16  christos 	if ((error = VOP_LOOKUP(dp, &ndp->ni_vp, cnp)) != 0) {
    502  1.10       cgd #ifdef DIAGNOSTIC
    503  1.10       cgd 		if (ndp->ni_vp != NULL)
    504  1.43  christos 			panic("leaf `%s' should be empty", cnp->cn_nameptr);
    505  1.10       cgd #endif
    506  1.10       cgd #ifdef NAMEI_DIAGNOSTIC
    507  1.19  christos 		printf("not found\n");
    508  1.10       cgd #endif
    509  1.12   mycroft 		if ((error == ENOENT) &&
    510  1.10       cgd 		    (dp->v_flag & VROOT) &&
    511  1.10       cgd 		    (dp->v_mount->mnt_flag & MNT_UNION)) {
    512  1.10       cgd 			tdp = dp;
    513  1.10       cgd 			dp = dp->v_mount->mnt_vnodecovered;
    514  1.31  wrstuden 			if (cnp->cn_flags & PDIRUNLOCK)
    515  1.31  wrstuden 				vrele(tdp);
    516  1.31  wrstuden 			else
    517  1.31  wrstuden 				vput(tdp);
    518  1.10       cgd 			VREF(dp);
    519  1.26      fvdl 			vn_lock(dp, LK_EXCLUSIVE | LK_RETRY);
    520  1.12   mycroft 			goto unionlookup;
    521  1.10       cgd 		}
    522  1.12   mycroft 
    523  1.10       cgd 		if (error != EJUSTRETURN)
    524  1.10       cgd 			goto bad;
    525  1.10       cgd 		/*
    526  1.23   mycroft 		 * If this was not the last component, or there were trailing
    527  1.23   mycroft 		 * slashes, then the name must exist.
    528  1.23   mycroft 		 */
    529  1.23   mycroft 		if (cnp->cn_flags & REQUIREDIR) {
    530  1.23   mycroft 			error = ENOENT;
    531  1.23   mycroft 			goto bad;
    532  1.23   mycroft 		}
    533  1.23   mycroft 		/*
    534  1.10       cgd 		 * If creating and at end of pathname, then can consider
    535  1.10       cgd 		 * allowing file to be created.
    536  1.10       cgd 		 */
    537  1.26      fvdl 		if (rdonly) {
    538  1.10       cgd 			error = EROFS;
    539  1.10       cgd 			goto bad;
    540  1.10       cgd 		}
    541  1.10       cgd 		/*
    542  1.10       cgd 		 * We return with ni_vp NULL to indicate that the entry
    543  1.10       cgd 		 * doesn't currently exist, leaving a pointer to the
    544  1.10       cgd 		 * (possibly locked) directory inode in ndp->ni_dvp.
    545  1.10       cgd 		 */
    546  1.12   mycroft 		if (cnp->cn_flags & SAVESTART) {
    547  1.10       cgd 			ndp->ni_startdir = ndp->ni_dvp;
    548  1.10       cgd 			VREF(ndp->ni_startdir);
    549  1.10       cgd 		}
    550  1.10       cgd 		return (0);
    551  1.10       cgd 	}
    552  1.10       cgd #ifdef NAMEI_DIAGNOSTIC
    553  1.19  christos 	printf("found\n");
    554  1.10       cgd #endif
    555  1.10       cgd 
    556  1.12   mycroft 	/*
    557  1.23   mycroft 	 * Take into account any additional components consumed by the
    558  1.23   mycroft 	 * underlying filesystem.  This will include any trailing slashes after
    559  1.23   mycroft 	 * the last component consumed.
    560  1.12   mycroft 	 */
    561  1.12   mycroft 	if (cnp->cn_consume > 0) {
    562  1.23   mycroft 		ndp->ni_pathlen -= cnp->cn_consume - slashes;
    563  1.23   mycroft 		ndp->ni_next += cnp->cn_consume - slashes;
    564  1.12   mycroft 		cnp->cn_consume = 0;
    565  1.23   mycroft 		if (ndp->ni_next[0] == '\0')
    566  1.23   mycroft 			cnp->cn_flags |= ISLASTCN;
    567  1.12   mycroft 	}
    568  1.12   mycroft 
    569  1.10       cgd 	dp = ndp->ni_vp;
    570  1.10       cgd 	/*
    571  1.10       cgd 	 * Check to see if the vnode has been mounted on;
    572  1.10       cgd 	 * if so find the root of the mounted file system.
    573  1.10       cgd 	 */
    574  1.10       cgd 	while (dp->v_type == VDIR && (mp = dp->v_mountedhere) &&
    575  1.12   mycroft 	       (cnp->cn_flags & NOCROSSMOUNT) == 0) {
    576  1.26      fvdl 		if (vfs_busy(mp, 0, 0))
    577  1.12   mycroft 			continue;
    578  1.32  wrstuden 		VOP_UNLOCK(dp, 0);
    579  1.47   thorpej 		error = VFS_ROOT(mp, &tdp);
    580  1.26      fvdl 		vfs_unbusy(mp);
    581  1.32  wrstuden 		if (error) {
    582  1.32  wrstuden 			dpunlocked = 1;
    583  1.10       cgd 			goto bad2;
    584  1.32  wrstuden 		}
    585  1.32  wrstuden 		vrele(dp);
    586  1.10       cgd 		ndp->ni_vp = dp = tdp;
    587  1.14   mycroft 	}
    588  1.14   mycroft 
    589  1.14   mycroft 	/*
    590  1.23   mycroft 	 * Check for symbolic link.  Back up over any slashes that we skipped,
    591  1.23   mycroft 	 * as we will need them again.
    592  1.14   mycroft 	 */
    593  1.23   mycroft 	if ((dp->v_type == VLNK) && (cnp->cn_flags & (FOLLOW|REQUIREDIR))) {
    594  1.23   mycroft 		ndp->ni_pathlen += slashes;
    595  1.23   mycroft 		ndp->ni_next -= slashes;
    596  1.14   mycroft 		cnp->cn_flags |= ISSYMLINK;
    597  1.14   mycroft 		return (0);
    598  1.10       cgd 	}
    599  1.10       cgd 
    600  1.23   mycroft 	/*
    601  1.23   mycroft 	 * Check for directory, if the component was followed by a series of
    602  1.23   mycroft 	 * slashes.
    603  1.23   mycroft 	 */
    604  1.23   mycroft 	if ((dp->v_type != VDIR) && (cnp->cn_flags & REQUIREDIR)) {
    605  1.23   mycroft 		error = ENOTDIR;
    606  1.23   mycroft 		goto bad2;
    607  1.23   mycroft 	}
    608  1.23   mycroft 
    609  1.10       cgd nextname:
    610  1.10       cgd 	/*
    611  1.23   mycroft 	 * Not a symbolic link.  If this was not the last component, then
    612  1.23   mycroft 	 * continue at the next component, else return.
    613  1.10       cgd 	 */
    614  1.23   mycroft 	if (!(cnp->cn_flags & ISLASTCN)) {
    615  1.12   mycroft 		cnp->cn_nameptr = ndp->ni_next;
    616  1.10       cgd 		vrele(ndp->ni_dvp);
    617  1.10       cgd 		goto dirloop;
    618  1.10       cgd 	}
    619  1.23   mycroft 
    620  1.23   mycroft terminal:
    621  1.10       cgd 	/*
    622  1.26      fvdl 	 * Disallow directory write attempts on read-only file systems.
    623  1.10       cgd 	 */
    624  1.26      fvdl 	if (rdonly &&
    625  1.26      fvdl 	    (cnp->cn_nameiop == DELETE || cnp->cn_nameiop == RENAME)) {
    626  1.10       cgd 		/*
    627  1.10       cgd 		 * Disallow directory write attempts on read-only
    628  1.10       cgd 		 * file systems.
    629  1.10       cgd 		 */
    630  1.26      fvdl 		error = EROFS;
    631  1.26      fvdl 		goto bad2;
    632  1.10       cgd 	}
    633  1.23   mycroft 	if (ndp->ni_dvp != NULL) {
    634  1.23   mycroft 		if (cnp->cn_flags & SAVESTART) {
    635  1.23   mycroft 			ndp->ni_startdir = ndp->ni_dvp;
    636  1.23   mycroft 			VREF(ndp->ni_startdir);
    637  1.23   mycroft 		}
    638  1.23   mycroft 		if (!wantparent)
    639  1.23   mycroft 			vrele(ndp->ni_dvp);
    640  1.10       cgd 	}
    641  1.12   mycroft 	if ((cnp->cn_flags & LOCKLEAF) == 0)
    642  1.26      fvdl 		VOP_UNLOCK(dp, 0);
    643  1.10       cgd 	return (0);
    644  1.10       cgd 
    645  1.10       cgd bad2:
    646  1.31  wrstuden 	if ((cnp->cn_flags & LOCKPARENT) && (cnp->cn_flags & ISLASTCN) &&
    647  1.31  wrstuden 			((cnp->cn_flags & PDIRUNLOCK) == 0))
    648  1.26      fvdl 		VOP_UNLOCK(ndp->ni_dvp, 0);
    649  1.10       cgd 	vrele(ndp->ni_dvp);
    650  1.10       cgd bad:
    651  1.32  wrstuden 	if (dpunlocked)
    652  1.32  wrstuden 		vrele(dp);
    653  1.32  wrstuden 	else
    654  1.32  wrstuden 		vput(dp);
    655  1.10       cgd 	ndp->ni_vp = NULL;
    656  1.12   mycroft 	return (error);
    657  1.12   mycroft }
    658  1.12   mycroft 
    659  1.12   mycroft /*
    660  1.12   mycroft  * Reacquire a path name component.
    661  1.12   mycroft  */
    662  1.12   mycroft int
    663  1.12   mycroft relookup(dvp, vpp, cnp)
    664  1.12   mycroft 	struct vnode *dvp, **vpp;
    665  1.12   mycroft 	struct componentname *cnp;
    666  1.12   mycroft {
    667  1.26      fvdl 	struct vnode *dp = 0;		/* the directory we are searching */
    668  1.12   mycroft 	int wantparent;			/* 1 => wantparent or lockparent flag */
    669  1.12   mycroft 	int rdonly;			/* lookup read-only flag bit */
    670  1.12   mycroft 	int error = 0;
    671  1.12   mycroft #ifdef NAMEI_DIAGNOSTIC
    672  1.12   mycroft 	int newhash;			/* DEBUG: check name hash */
    673  1.41     soren 	const char *cp;			/* DEBUG: check name ptr/len */
    674  1.12   mycroft #endif
    675  1.12   mycroft 
    676  1.12   mycroft 	/*
    677  1.12   mycroft 	 * Setup: break out flag bits into variables.
    678  1.12   mycroft 	 */
    679  1.12   mycroft 	wantparent = cnp->cn_flags & (LOCKPARENT|WANTPARENT);
    680  1.12   mycroft 	rdonly = cnp->cn_flags & RDONLY;
    681  1.12   mycroft 	cnp->cn_flags &= ~ISSYMLINK;
    682  1.12   mycroft 	dp = dvp;
    683  1.26      fvdl 	vn_lock(dp, LK_EXCLUSIVE | LK_RETRY);
    684  1.12   mycroft 
    685  1.12   mycroft /* dirloop: */
    686  1.12   mycroft 	/*
    687  1.12   mycroft 	 * Search a new directory.
    688  1.12   mycroft 	 *
    689  1.12   mycroft 	 * The cn_hash value is for use by vfs_cache.
    690  1.12   mycroft 	 * The last component of the filename is left accessible via
    691  1.12   mycroft 	 * cnp->cn_nameptr for callers that need the name. Callers needing
    692  1.12   mycroft 	 * the name set the SAVENAME flag. When done, they assume
    693  1.12   mycroft 	 * responsibility for freeing the pathname buffer.
    694  1.12   mycroft 	 */
    695  1.12   mycroft #ifdef NAMEI_DIAGNOSTIC
    696  1.39     lukem 	cp = NULL;
    697  1.39     lukem 	newhash = namei_hash(cnp->cn_nameptr, &cp);
    698  1.12   mycroft 	if (newhash != cnp->cn_hash)
    699  1.12   mycroft 		panic("relookup: bad hash");
    700  1.12   mycroft 	if (cnp->cn_namelen != cp - cnp->cn_nameptr)
    701  1.12   mycroft 		panic ("relookup: bad len");
    702  1.12   mycroft 	if (*cp != 0)
    703  1.12   mycroft 		panic("relookup: not last component");
    704  1.19  christos 	printf("{%s}: ", cnp->cn_nameptr);
    705  1.12   mycroft #endif
    706  1.12   mycroft 
    707  1.12   mycroft 	/*
    708  1.12   mycroft 	 * Check for degenerate name (e.g. / or "")
    709  1.12   mycroft 	 * which is a way of talking about a directory,
    710  1.12   mycroft 	 * e.g. like "/." or ".".
    711  1.12   mycroft 	 */
    712  1.23   mycroft 	if (cnp->cn_nameptr[0] == '\0')
    713  1.23   mycroft 		panic("relookup: null name");
    714  1.12   mycroft 
    715  1.12   mycroft 	if (cnp->cn_flags & ISDOTDOT)
    716  1.12   mycroft 		panic ("relookup: lookup on dot-dot");
    717  1.12   mycroft 
    718  1.12   mycroft 	/*
    719  1.12   mycroft 	 * We now have a segment name to search for, and a directory to search.
    720  1.12   mycroft 	 */
    721  1.16  christos 	if ((error = VOP_LOOKUP(dp, vpp, cnp)) != 0) {
    722  1.12   mycroft #ifdef DIAGNOSTIC
    723  1.12   mycroft 		if (*vpp != NULL)
    724  1.43  christos 			panic("leaf `%s' should be empty", cnp->cn_nameptr);
    725  1.12   mycroft #endif
    726  1.12   mycroft 		if (error != EJUSTRETURN)
    727  1.12   mycroft 			goto bad;
    728  1.12   mycroft 		/*
    729  1.12   mycroft 		 * If creating and at end of pathname, then can consider
    730  1.12   mycroft 		 * allowing file to be created.
    731  1.12   mycroft 		 */
    732  1.26      fvdl 		if (rdonly) {
    733  1.12   mycroft 			error = EROFS;
    734  1.12   mycroft 			goto bad;
    735  1.12   mycroft 		}
    736  1.12   mycroft 		/* ASSERT(dvp == ndp->ni_startdir) */
    737  1.12   mycroft 		if (cnp->cn_flags & SAVESTART)
    738  1.12   mycroft 			VREF(dvp);
    739  1.12   mycroft 		/*
    740  1.12   mycroft 		 * We return with ni_vp NULL to indicate that the entry
    741  1.12   mycroft 		 * doesn't currently exist, leaving a pointer to the
    742  1.12   mycroft 		 * (possibly locked) directory inode in ndp->ni_dvp.
    743  1.12   mycroft 		 */
    744  1.12   mycroft 		return (0);
    745  1.12   mycroft 	}
    746  1.12   mycroft 	dp = *vpp;
    747  1.12   mycroft 
    748  1.12   mycroft #ifdef DIAGNOSTIC
    749  1.12   mycroft 	/*
    750  1.12   mycroft 	 * Check for symbolic link
    751  1.12   mycroft 	 */
    752  1.12   mycroft 	if (dp->v_type == VLNK && (cnp->cn_flags & FOLLOW))
    753  1.12   mycroft 		panic ("relookup: symlink found.\n");
    754  1.12   mycroft #endif
    755  1.12   mycroft 
    756  1.12   mycroft 	/*
    757  1.12   mycroft 	 * Check for read-only file systems.
    758  1.12   mycroft 	 */
    759  1.26      fvdl 	if (rdonly &&
    760  1.26      fvdl 	    (cnp->cn_nameiop == DELETE || cnp->cn_nameiop == RENAME)) {
    761  1.26      fvdl 		error = EROFS;
    762  1.26      fvdl 		goto bad2;
    763  1.12   mycroft 	}
    764  1.12   mycroft 	/* ASSERT(dvp == ndp->ni_startdir) */
    765  1.12   mycroft 	if (cnp->cn_flags & SAVESTART)
    766  1.12   mycroft 		VREF(dvp);
    767  1.12   mycroft 	if (!wantparent)
    768  1.12   mycroft 		vrele(dvp);
    769  1.12   mycroft 	if ((cnp->cn_flags & LOCKLEAF) == 0)
    770  1.26      fvdl 		VOP_UNLOCK(dp, 0);
    771  1.12   mycroft 	return (0);
    772  1.12   mycroft 
    773  1.12   mycroft bad2:
    774  1.12   mycroft 	if ((cnp->cn_flags & LOCKPARENT) && (cnp->cn_flags & ISLASTCN))
    775  1.26      fvdl 		VOP_UNLOCK(dvp, 0);
    776  1.12   mycroft 	vrele(dvp);
    777  1.12   mycroft bad:
    778  1.12   mycroft 	vput(dp);
    779  1.12   mycroft 	*vpp = NULL;
    780  1.10       cgd 	return (error);
    781  1.10       cgd }
    782