vfs_lookup.c revision 205682
1/*-
2 * Copyright (c) 1982, 1986, 1989, 1993
3 *	The Regents of the University of California.  All rights reserved.
4 * (c) UNIX System Laboratories, Inc.
5 * All or some portions of this file are derived from material licensed
6 * to the University of California by American Telephone and Telegraph
7 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8 * the permission of UNIX System Laboratories, Inc.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 * 4. Neither the name of the University nor the names of its contributors
19 *    may be used to endorse or promote products derived from this software
20 *    without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 *
34 *	@(#)vfs_lookup.c	8.4 (Berkeley) 2/16/94
35 */
36
37#include <sys/cdefs.h>
38__FBSDID("$FreeBSD: head/sys/kern/vfs_lookup.c 205682 2010-03-26 11:33:12Z jh $");
39
40#include "opt_kdtrace.h"
41#include "opt_ktrace.h"
42
43#include <sys/param.h>
44#include <sys/systm.h>
45#include <sys/kernel.h>
46#include <sys/fcntl.h>
47#include <sys/jail.h>
48#include <sys/lock.h>
49#include <sys/mutex.h>
50#include <sys/namei.h>
51#include <sys/vnode.h>
52#include <sys/mount.h>
53#include <sys/filedesc.h>
54#include <sys/proc.h>
55#include <sys/sdt.h>
56#include <sys/syscallsubr.h>
57#include <sys/sysctl.h>
58#ifdef KTRACE
59#include <sys/ktrace.h>
60#endif
61
62#include <security/audit/audit.h>
63#include <security/mac/mac_framework.h>
64
65#include <vm/uma.h>
66
67#define	NAMEI_DIAGNOSTIC 1
68#undef NAMEI_DIAGNOSTIC
69
70SDT_PROVIDER_DECLARE(vfs);
71SDT_PROBE_DEFINE3(vfs, namei, lookup, entry, "struct vnode *", "char *",
72    "unsigned long");
73SDT_PROBE_DEFINE2(vfs, namei, lookup, return, "int", "struct vnode *");
74
75/*
76 * Allocation zone for namei
77 */
78uma_zone_t namei_zone;
79/*
80 * Placeholder vnode for mp traversal
81 */
82static struct vnode *vp_crossmp;
83
84static void
85nameiinit(void *dummy __unused)
86{
87	int error;
88
89	namei_zone = uma_zcreate("NAMEI", MAXPATHLEN, NULL, NULL, NULL, NULL,
90	    UMA_ALIGN_PTR, 0);
91	error = getnewvnode("crossmp", NULL, &dead_vnodeops, &vp_crossmp);
92	if (error != 0)
93		panic("nameiinit: getnewvnode");
94	VN_LOCK_ASHARE(vp_crossmp);
95}
96SYSINIT(vfs, SI_SUB_VFS, SI_ORDER_SECOND, nameiinit, NULL);
97
98static int lookup_shared = 1;
99SYSCTL_INT(_vfs, OID_AUTO, lookup_shared, CTLFLAG_RW, &lookup_shared, 0,
100    "Enables/Disables shared locks for path name translation");
101TUNABLE_INT("vfs.lookup_shared", &lookup_shared);
102
103/*
104 * Convert a pathname into a pointer to a locked vnode.
105 *
106 * The FOLLOW flag is set when symbolic links are to be followed
107 * when they occur at the end of the name translation process.
108 * Symbolic links are always followed for all other pathname
109 * components other than the last.
110 *
111 * The segflg defines whether the name is to be copied from user
112 * space or kernel space.
113 *
114 * Overall outline of namei:
115 *
116 *	copy in name
117 *	get starting directory
118 *	while (!done && !error) {
119 *		call lookup to search path.
120 *		if symbolic link, massage name in buffer and continue
121 *	}
122 */
123int
124namei(struct nameidata *ndp)
125{
126	struct filedesc *fdp;	/* pointer to file descriptor state */
127	char *cp;		/* pointer into pathname argument */
128	struct vnode *dp;	/* the directory we are searching */
129	struct iovec aiov;		/* uio for reading symbolic links */
130	struct uio auio;
131	int error, linklen;
132	struct componentname *cnp = &ndp->ni_cnd;
133	struct thread *td = cnp->cn_thread;
134	struct proc *p = td->td_proc;
135	int vfslocked;
136
137	KASSERT((cnp->cn_flags & MPSAFE) != 0 || mtx_owned(&Giant) != 0,
138	    ("NOT MPSAFE and Giant not held"));
139	ndp->ni_cnd.cn_cred = ndp->ni_cnd.cn_thread->td_ucred;
140	KASSERT(cnp->cn_cred && p, ("namei: bad cred/proc"));
141	KASSERT((cnp->cn_nameiop & (~OPMASK)) == 0,
142	    ("namei: nameiop contaminated with flags"));
143	KASSERT((cnp->cn_flags & OPMASK) == 0,
144	    ("namei: flags contaminated with nameiops"));
145	if (!lookup_shared)
146		cnp->cn_flags &= ~LOCKSHARED;
147	fdp = p->p_fd;
148
149	/* We will set this ourselves if we need it. */
150	cnp->cn_flags &= ~TRAILINGSLASH;
151
152	/*
153	 * Get a buffer for the name to be translated, and copy the
154	 * name into the buffer.
155	 */
156	if ((cnp->cn_flags & HASBUF) == 0)
157		cnp->cn_pnbuf = uma_zalloc(namei_zone, M_WAITOK);
158	if (ndp->ni_segflg == UIO_SYSSPACE)
159		error = copystr(ndp->ni_dirp, cnp->cn_pnbuf,
160			    MAXPATHLEN, (size_t *)&ndp->ni_pathlen);
161	else
162		error = copyinstr(ndp->ni_dirp, cnp->cn_pnbuf,
163			    MAXPATHLEN, (size_t *)&ndp->ni_pathlen);
164
165	if (error == 0) {
166		/*
167		 * If we are auditing the kernel pathname, save the user
168		 * pathname.
169		 */
170		if (cnp->cn_flags & AUDITVNODE1)
171			AUDIT_ARG_UPATH1(td, cnp->cn_pnbuf);
172		if (cnp->cn_flags & AUDITVNODE2)
173			AUDIT_ARG_UPATH2(td, cnp->cn_pnbuf);
174	}
175
176	/*
177	 * Don't allow empty pathnames.
178	 */
179	if (!error && *cnp->cn_pnbuf == '\0')
180		error = ENOENT;
181
182	if (error) {
183		uma_zfree(namei_zone, cnp->cn_pnbuf);
184#ifdef DIAGNOSTIC
185		cnp->cn_pnbuf = NULL;
186		cnp->cn_nameptr = NULL;
187#endif
188		ndp->ni_vp = NULL;
189		return (error);
190	}
191	ndp->ni_loopcnt = 0;
192#ifdef KTRACE
193	if (KTRPOINT(td, KTR_NAMEI)) {
194		KASSERT(cnp->cn_thread == curthread,
195		    ("namei not using curthread"));
196		ktrnamei(cnp->cn_pnbuf);
197	}
198#endif
199	/*
200	 * Get starting point for the translation.
201	 */
202	FILEDESC_SLOCK(fdp);
203	ndp->ni_rootdir = fdp->fd_rdir;
204	ndp->ni_topdir = fdp->fd_jdir;
205
206	dp = NULL;
207	if (cnp->cn_pnbuf[0] != '/') {
208		if (ndp->ni_startdir != NULL) {
209			dp = ndp->ni_startdir;
210			error = 0;
211		} else if (ndp->ni_dirfd != AT_FDCWD) {
212			if (cnp->cn_flags & AUDITVNODE1)
213				AUDIT_ARG_ATFD1(ndp->ni_dirfd);
214			if (cnp->cn_flags & AUDITVNODE2)
215				AUDIT_ARG_ATFD2(ndp->ni_dirfd);
216			error = fgetvp(td, ndp->ni_dirfd, &dp);
217		}
218		if (error != 0 || dp != NULL) {
219			FILEDESC_SUNLOCK(fdp);
220			if (error == 0 && dp->v_type != VDIR) {
221				vfslocked = VFS_LOCK_GIANT(dp->v_mount);
222				vrele(dp);
223				VFS_UNLOCK_GIANT(vfslocked);
224				error = ENOTDIR;
225			}
226		}
227		if (error) {
228			uma_zfree(namei_zone, cnp->cn_pnbuf);
229#ifdef DIAGNOSTIC
230			cnp->cn_pnbuf = NULL;
231			cnp->cn_nameptr = NULL;
232#endif
233			return (error);
234		}
235	}
236	if (dp == NULL) {
237		dp = fdp->fd_cdir;
238		VREF(dp);
239		FILEDESC_SUNLOCK(fdp);
240		if (ndp->ni_startdir != NULL) {
241			vfslocked = VFS_LOCK_GIANT(ndp->ni_startdir->v_mount);
242			vrele(ndp->ni_startdir);
243			VFS_UNLOCK_GIANT(vfslocked);
244		}
245	}
246	SDT_PROBE(vfs, namei, lookup, entry, dp, cnp->cn_pnbuf,
247	    cnp->cn_flags, 0, 0);
248	vfslocked = VFS_LOCK_GIANT(dp->v_mount);
249	for (;;) {
250		/*
251		 * Check if root directory should replace current directory.
252		 * Done at start of translation and after symbolic link.
253		 */
254		cnp->cn_nameptr = cnp->cn_pnbuf;
255		if (*(cnp->cn_nameptr) == '/') {
256			vrele(dp);
257			VFS_UNLOCK_GIANT(vfslocked);
258			while (*(cnp->cn_nameptr) == '/') {
259				cnp->cn_nameptr++;
260				ndp->ni_pathlen--;
261			}
262			dp = ndp->ni_rootdir;
263			vfslocked = VFS_LOCK_GIANT(dp->v_mount);
264			VREF(dp);
265		}
266		if (vfslocked)
267			ndp->ni_cnd.cn_flags |= GIANTHELD;
268		ndp->ni_startdir = dp;
269		error = lookup(ndp);
270		if (error) {
271			uma_zfree(namei_zone, cnp->cn_pnbuf);
272#ifdef DIAGNOSTIC
273			cnp->cn_pnbuf = NULL;
274			cnp->cn_nameptr = NULL;
275#endif
276			SDT_PROBE(vfs, namei, lookup, return, error, NULL, 0,
277			    0, 0);
278			return (error);
279		}
280		vfslocked = (ndp->ni_cnd.cn_flags & GIANTHELD) != 0;
281		ndp->ni_cnd.cn_flags &= ~GIANTHELD;
282		/*
283		 * If not a symbolic link, we're done.
284		 */
285		if ((cnp->cn_flags & ISSYMLINK) == 0) {
286			if ((cnp->cn_flags & (SAVENAME | SAVESTART)) == 0) {
287				uma_zfree(namei_zone, cnp->cn_pnbuf);
288#ifdef DIAGNOSTIC
289				cnp->cn_pnbuf = NULL;
290				cnp->cn_nameptr = NULL;
291#endif
292			} else
293				cnp->cn_flags |= HASBUF;
294
295			if ((cnp->cn_flags & MPSAFE) == 0) {
296				VFS_UNLOCK_GIANT(vfslocked);
297			} else if (vfslocked)
298				ndp->ni_cnd.cn_flags |= GIANTHELD;
299			SDT_PROBE(vfs, namei, lookup, return, 0, ndp->ni_vp,
300			    0, 0, 0);
301			return (0);
302		}
303		if (ndp->ni_loopcnt++ >= MAXSYMLINKS) {
304			error = ELOOP;
305			break;
306		}
307#ifdef MAC
308		if ((cnp->cn_flags & NOMACCHECK) == 0) {
309			error = mac_vnode_check_readlink(td->td_ucred,
310			    ndp->ni_vp);
311			if (error)
312				break;
313		}
314#endif
315		if (ndp->ni_pathlen > 1)
316			cp = uma_zalloc(namei_zone, M_WAITOK);
317		else
318			cp = cnp->cn_pnbuf;
319		aiov.iov_base = cp;
320		aiov.iov_len = MAXPATHLEN;
321		auio.uio_iov = &aiov;
322		auio.uio_iovcnt = 1;
323		auio.uio_offset = 0;
324		auio.uio_rw = UIO_READ;
325		auio.uio_segflg = UIO_SYSSPACE;
326		auio.uio_td = (struct thread *)0;
327		auio.uio_resid = MAXPATHLEN;
328		error = VOP_READLINK(ndp->ni_vp, &auio, cnp->cn_cred);
329		if (error) {
330			if (ndp->ni_pathlen > 1)
331				uma_zfree(namei_zone, cp);
332			break;
333		}
334		linklen = MAXPATHLEN - auio.uio_resid;
335		if (linklen == 0) {
336			if (ndp->ni_pathlen > 1)
337				uma_zfree(namei_zone, cp);
338			error = ENOENT;
339			break;
340		}
341		if (linklen + ndp->ni_pathlen >= MAXPATHLEN) {
342			if (ndp->ni_pathlen > 1)
343				uma_zfree(namei_zone, cp);
344			error = ENAMETOOLONG;
345			break;
346		}
347		if (ndp->ni_pathlen > 1) {
348			bcopy(ndp->ni_next, cp + linklen, ndp->ni_pathlen);
349			uma_zfree(namei_zone, cnp->cn_pnbuf);
350			cnp->cn_pnbuf = cp;
351		} else
352			cnp->cn_pnbuf[linklen] = '\0';
353		ndp->ni_pathlen += linklen;
354		vput(ndp->ni_vp);
355		dp = ndp->ni_dvp;
356	}
357	uma_zfree(namei_zone, cnp->cn_pnbuf);
358#ifdef DIAGNOSTIC
359	cnp->cn_pnbuf = NULL;
360	cnp->cn_nameptr = NULL;
361#endif
362	vput(ndp->ni_vp);
363	ndp->ni_vp = NULL;
364	vrele(ndp->ni_dvp);
365	VFS_UNLOCK_GIANT(vfslocked);
366	SDT_PROBE(vfs, namei, lookup, return, error, NULL, 0, 0, 0);
367	return (error);
368}
369
370static int
371compute_cn_lkflags(struct mount *mp, int lkflags)
372{
373
374	if (mp == NULL ||
375	    ((lkflags & LK_SHARED) && !(mp->mnt_kern_flag & MNTK_LOOKUP_SHARED))) {
376		lkflags &= ~LK_SHARED;
377		lkflags |= LK_EXCLUSIVE;
378	}
379	return (lkflags);
380}
381
382static __inline int
383needs_exclusive_leaf(struct mount *mp, int flags)
384{
385
386	/*
387	 * Intermediate nodes can use shared locks, we only need to
388	 * force an exclusive lock for leaf nodes.
389	 */
390	if ((flags & (ISLASTCN | LOCKLEAF)) != (ISLASTCN | LOCKLEAF))
391		return (0);
392
393	/* Always use exclusive locks if LOCKSHARED isn't set. */
394	if (!(flags & LOCKSHARED))
395		return (1);
396
397	/*
398	 * For lookups during open(), if the mount point supports
399	 * extended shared operations, then use a shared lock for the
400	 * leaf node, otherwise use an exclusive lock.
401	 */
402	if (flags & ISOPEN) {
403		if (mp != NULL &&
404		    (mp->mnt_kern_flag & MNTK_EXTENDED_SHARED))
405			return (0);
406		else
407			return (1);
408	}
409
410	/*
411	 * Lookup requests outside of open() that specify LOCKSHARED
412	 * only need a shared lock on the leaf vnode.
413	 */
414	return (0);
415}
416
417/*
418 * Search a pathname.
419 * This is a very central and rather complicated routine.
420 *
421 * The pathname is pointed to by ni_ptr and is of length ni_pathlen.
422 * The starting directory is taken from ni_startdir. The pathname is
423 * descended until done, or a symbolic link is encountered. The variable
424 * ni_more is clear if the path is completed; it is set to one if a
425 * symbolic link needing interpretation is encountered.
426 *
427 * The flag argument is LOOKUP, CREATE, RENAME, or DELETE depending on
428 * whether the name is to be looked up, created, renamed, or deleted.
429 * When CREATE, RENAME, or DELETE is specified, information usable in
430 * creating, renaming, or deleting a directory entry may be calculated.
431 * If flag has LOCKPARENT or'ed into it, the parent directory is returned
432 * locked. If flag has WANTPARENT or'ed into it, the parent directory is
433 * returned unlocked. Otherwise the parent directory is not returned. If
434 * the target of the pathname exists and LOCKLEAF is or'ed into the flag
435 * the target is returned locked, otherwise it is returned unlocked.
436 * When creating or renaming and LOCKPARENT is specified, the target may not
437 * be ".".  When deleting and LOCKPARENT is specified, the target may be ".".
438 *
439 * Overall outline of lookup:
440 *
441 * dirloop:
442 *	identify next component of name at ndp->ni_ptr
443 *	handle degenerate case where name is null string
444 *	if .. and crossing mount points and on mounted filesys, find parent
445 *	call VOP_LOOKUP routine for next component name
446 *	    directory vnode returned in ni_dvp, unlocked unless LOCKPARENT set
447 *	    component vnode returned in ni_vp (if it exists), locked.
448 *	if result vnode is mounted on and crossing mount points,
449 *	    find mounted on vnode
450 *	if more components of name, do next level at dirloop
451 *	return the answer in ni_vp, locked if LOCKLEAF set
452 *	    if LOCKPARENT set, return locked parent in ni_dvp
453 *	    if WANTPARENT set, return unlocked parent in ni_dvp
454 */
455int
456lookup(struct nameidata *ndp)
457{
458	char *cp;		/* pointer into pathname argument */
459	struct vnode *dp = 0;	/* the directory we are searching */
460	struct vnode *tdp;		/* saved dp */
461	struct mount *mp;		/* mount table entry */
462	struct prison *pr;
463	int docache;			/* == 0 do not cache last component */
464	int wantparent;			/* 1 => wantparent or lockparent flag */
465	int rdonly;			/* lookup read-only flag bit */
466	int error = 0;
467	int dpunlocked = 0;		/* dp has already been unlocked */
468	struct componentname *cnp = &ndp->ni_cnd;
469	int vfslocked;			/* VFS Giant state for child */
470	int dvfslocked;			/* VFS Giant state for parent */
471	int tvfslocked;
472	int lkflags_save;
473
474	/*
475	 * Setup: break out flag bits into variables.
476	 */
477	dvfslocked = (ndp->ni_cnd.cn_flags & GIANTHELD) != 0;
478	vfslocked = 0;
479	ndp->ni_cnd.cn_flags &= ~GIANTHELD;
480	wantparent = cnp->cn_flags & (LOCKPARENT | WANTPARENT);
481	KASSERT(cnp->cn_nameiop == LOOKUP || wantparent,
482	    ("CREATE, DELETE, RENAME require LOCKPARENT or WANTPARENT."));
483	docache = (cnp->cn_flags & NOCACHE) ^ NOCACHE;
484	if (cnp->cn_nameiop == DELETE ||
485	    (wantparent && cnp->cn_nameiop != CREATE &&
486	     cnp->cn_nameiop != LOOKUP))
487		docache = 0;
488	rdonly = cnp->cn_flags & RDONLY;
489	cnp->cn_flags &= ~ISSYMLINK;
490	ndp->ni_dvp = NULL;
491	/*
492	 * We use shared locks until we hit the parent of the last cn then
493	 * we adjust based on the requesting flags.
494	 */
495	if (lookup_shared)
496		cnp->cn_lkflags = LK_SHARED;
497	else
498		cnp->cn_lkflags = LK_EXCLUSIVE;
499	dp = ndp->ni_startdir;
500	ndp->ni_startdir = NULLVP;
501	vn_lock(dp,
502	    compute_cn_lkflags(dp->v_mount, cnp->cn_lkflags | LK_RETRY));
503
504dirloop:
505	/*
506	 * Search a new directory.
507	 *
508	 * The last component of the filename is left accessible via
509	 * cnp->cn_nameptr for callers that need the name. Callers needing
510	 * the name set the SAVENAME flag. When done, they assume
511	 * responsibility for freeing the pathname buffer.
512	 */
513	cnp->cn_consume = 0;
514	for (cp = cnp->cn_nameptr; *cp != 0 && *cp != '/'; cp++)
515		continue;
516	cnp->cn_namelen = cp - cnp->cn_nameptr;
517	if (cnp->cn_namelen > NAME_MAX) {
518		error = ENAMETOOLONG;
519		goto bad;
520	}
521#ifdef NAMEI_DIAGNOSTIC
522	{ char c = *cp;
523	*cp = '\0';
524	printf("{%s}: ", cnp->cn_nameptr);
525	*cp = c; }
526#endif
527	ndp->ni_pathlen -= cnp->cn_namelen;
528	ndp->ni_next = cp;
529
530	/*
531	 * Replace multiple slashes by a single slash and trailing slashes
532	 * by a null.  This must be done before VOP_LOOKUP() because some
533	 * fs's don't know about trailing slashes.  Remember if there were
534	 * trailing slashes to handle symlinks, existing non-directories
535	 * and non-existing files that won't be directories specially later.
536	 */
537	while (*cp == '/' && (cp[1] == '/' || cp[1] == '\0')) {
538		cp++;
539		ndp->ni_pathlen--;
540		if (*cp == '\0') {
541			*ndp->ni_next = '\0';
542			cnp->cn_flags |= TRAILINGSLASH;
543		}
544	}
545	ndp->ni_next = cp;
546
547	cnp->cn_flags |= MAKEENTRY;
548	if (*cp == '\0' && docache == 0)
549		cnp->cn_flags &= ~MAKEENTRY;
550	if (cnp->cn_namelen == 2 &&
551	    cnp->cn_nameptr[1] == '.' && cnp->cn_nameptr[0] == '.')
552		cnp->cn_flags |= ISDOTDOT;
553	else
554		cnp->cn_flags &= ~ISDOTDOT;
555	if (*ndp->ni_next == 0)
556		cnp->cn_flags |= ISLASTCN;
557	else
558		cnp->cn_flags &= ~ISLASTCN;
559
560	if ((cnp->cn_flags & ISLASTCN) != 0 &&
561	    cnp->cn_namelen == 1 && cnp->cn_nameptr[0] == '.' &&
562	    (cnp->cn_nameiop == DELETE || cnp->cn_nameiop == RENAME)) {
563		error = EINVAL;
564		goto bad;
565	}
566
567	/*
568	 * Check for degenerate name (e.g. / or "")
569	 * which is a way of talking about a directory,
570	 * e.g. like "/." or ".".
571	 */
572	if (cnp->cn_nameptr[0] == '\0') {
573		if (dp->v_type != VDIR) {
574			error = ENOTDIR;
575			goto bad;
576		}
577		if (cnp->cn_nameiop != LOOKUP) {
578			error = EISDIR;
579			goto bad;
580		}
581		if (wantparent) {
582			ndp->ni_dvp = dp;
583			VREF(dp);
584		}
585		ndp->ni_vp = dp;
586
587		if (cnp->cn_flags & AUDITVNODE1)
588			AUDIT_ARG_VNODE1(dp);
589		else if (cnp->cn_flags & AUDITVNODE2)
590			AUDIT_ARG_VNODE2(dp);
591
592		if (!(cnp->cn_flags & (LOCKPARENT | LOCKLEAF)))
593			VOP_UNLOCK(dp, 0);
594		/* XXX This should probably move to the top of function. */
595		if (cnp->cn_flags & SAVESTART)
596			panic("lookup: SAVESTART");
597		goto success;
598	}
599
600	/*
601	 * Handle "..": four special cases.
602	 * 1. Return an error if this is the last component of
603	 *    the name and the operation is DELETE or RENAME.
604	 * 2. If at root directory (e.g. after chroot)
605	 *    or at absolute root directory
606	 *    then ignore it so can't get out.
607	 * 3. If this vnode is the root of a mounted
608	 *    filesystem, then replace it with the
609	 *    vnode which was mounted on so we take the
610	 *    .. in the other filesystem.
611	 * 4. If the vnode is the top directory of
612	 *    the jail or chroot, don't let them out.
613	 */
614	if (cnp->cn_flags & ISDOTDOT) {
615		if ((cnp->cn_flags & ISLASTCN) != 0 &&
616		    (cnp->cn_nameiop == DELETE || cnp->cn_nameiop == RENAME)) {
617			error = EINVAL;
618			goto bad;
619		}
620		for (;;) {
621			for (pr = cnp->cn_cred->cr_prison; pr != NULL;
622			     pr = pr->pr_parent)
623				if (dp == pr->pr_root)
624					break;
625			if (dp == ndp->ni_rootdir ||
626			    dp == ndp->ni_topdir ||
627			    dp == rootvnode ||
628			    pr != NULL ||
629			    ((dp->v_vflag & VV_ROOT) != 0 &&
630			     (cnp->cn_flags & NOCROSSMOUNT) != 0)) {
631				ndp->ni_dvp = dp;
632				ndp->ni_vp = dp;
633				vfslocked = VFS_LOCK_GIANT(dp->v_mount);
634				VREF(dp);
635				goto nextname;
636			}
637			if ((dp->v_vflag & VV_ROOT) == 0)
638				break;
639			if (dp->v_iflag & VI_DOOMED) {	/* forced unmount */
640				error = ENOENT;
641				goto bad;
642			}
643			tdp = dp;
644			dp = dp->v_mount->mnt_vnodecovered;
645			tvfslocked = dvfslocked;
646			dvfslocked = VFS_LOCK_GIANT(dp->v_mount);
647			VREF(dp);
648			vput(tdp);
649			VFS_UNLOCK_GIANT(tvfslocked);
650			vn_lock(dp,
651			    compute_cn_lkflags(dp->v_mount, cnp->cn_lkflags |
652			    LK_RETRY));
653		}
654	}
655
656	/*
657	 * We now have a segment name to search for, and a directory to search.
658	 */
659unionlookup:
660#ifdef MAC
661	if ((cnp->cn_flags & NOMACCHECK) == 0) {
662		error = mac_vnode_check_lookup(cnp->cn_thread->td_ucred, dp,
663		    cnp);
664		if (error)
665			goto bad;
666	}
667#endif
668	ndp->ni_dvp = dp;
669	ndp->ni_vp = NULL;
670	ASSERT_VOP_LOCKED(dp, "lookup");
671	VNASSERT(vfslocked == 0, dp, ("lookup: vfslocked %d", vfslocked));
672	/*
673	 * If we have a shared lock we may need to upgrade the lock for the
674	 * last operation.
675	 */
676	if (dp != vp_crossmp &&
677	    VOP_ISLOCKED(dp) == LK_SHARED &&
678	    (cnp->cn_flags & ISLASTCN) && (cnp->cn_flags & LOCKPARENT))
679		vn_lock(dp, LK_UPGRADE|LK_RETRY);
680	/*
681	 * If we're looking up the last component and we need an exclusive
682	 * lock, adjust our lkflags.
683	 */
684	if (needs_exclusive_leaf(dp->v_mount, cnp->cn_flags))
685		cnp->cn_lkflags = LK_EXCLUSIVE;
686#ifdef NAMEI_DIAGNOSTIC
687	vprint("lookup in", dp);
688#endif
689	lkflags_save = cnp->cn_lkflags;
690	cnp->cn_lkflags = compute_cn_lkflags(dp->v_mount, cnp->cn_lkflags);
691	if ((error = VOP_LOOKUP(dp, &ndp->ni_vp, cnp)) != 0) {
692		cnp->cn_lkflags = lkflags_save;
693		KASSERT(ndp->ni_vp == NULL, ("leaf should be empty"));
694#ifdef NAMEI_DIAGNOSTIC
695		printf("not found\n");
696#endif
697		if ((error == ENOENT) &&
698		    (dp->v_vflag & VV_ROOT) && (dp->v_mount != NULL) &&
699		    (dp->v_mount->mnt_flag & MNT_UNION)) {
700			tdp = dp;
701			dp = dp->v_mount->mnt_vnodecovered;
702			tvfslocked = dvfslocked;
703			dvfslocked = VFS_LOCK_GIANT(dp->v_mount);
704			VREF(dp);
705			vput(tdp);
706			VFS_UNLOCK_GIANT(tvfslocked);
707			vn_lock(dp,
708			    compute_cn_lkflags(dp->v_mount, cnp->cn_lkflags |
709			    LK_RETRY));
710			goto unionlookup;
711		}
712
713		if (error != EJUSTRETURN)
714			goto bad;
715		/*
716		 * At this point, we know we're at the end of the
717		 * pathname.  If creating / renaming, we can consider
718		 * allowing the file or directory to be created / renamed,
719		 * provided we're not on a read-only filesystem.
720		 */
721		if (rdonly) {
722			error = EROFS;
723			goto bad;
724		}
725		/* trailing slash only allowed for directories */
726		if ((cnp->cn_flags & TRAILINGSLASH) &&
727		    !(cnp->cn_flags & WILLBEDIR)) {
728			error = ENOENT;
729			goto bad;
730		}
731		if ((cnp->cn_flags & LOCKPARENT) == 0)
732			VOP_UNLOCK(dp, 0);
733		/*
734		 * We return with ni_vp NULL to indicate that the entry
735		 * doesn't currently exist, leaving a pointer to the
736		 * (possibly locked) directory vnode in ndp->ni_dvp.
737		 */
738		if (cnp->cn_flags & SAVESTART) {
739			ndp->ni_startdir = ndp->ni_dvp;
740			VREF(ndp->ni_startdir);
741		}
742		goto success;
743	} else
744		cnp->cn_lkflags = lkflags_save;
745#ifdef NAMEI_DIAGNOSTIC
746	printf("found\n");
747#endif
748	/*
749	 * Take into account any additional components consumed by
750	 * the underlying filesystem.
751	 */
752	if (cnp->cn_consume > 0) {
753		cnp->cn_nameptr += cnp->cn_consume;
754		ndp->ni_next += cnp->cn_consume;
755		ndp->ni_pathlen -= cnp->cn_consume;
756		cnp->cn_consume = 0;
757	}
758
759	dp = ndp->ni_vp;
760	vfslocked = VFS_LOCK_GIANT(dp->v_mount);
761
762	/*
763	 * Check to see if the vnode has been mounted on;
764	 * if so find the root of the mounted filesystem.
765	 */
766	while (dp->v_type == VDIR && (mp = dp->v_mountedhere) &&
767	       (cnp->cn_flags & NOCROSSMOUNT) == 0) {
768		if (vfs_busy(mp, 0))
769			continue;
770		vput(dp);
771		VFS_UNLOCK_GIANT(vfslocked);
772		vfslocked = VFS_LOCK_GIANT(mp);
773		if (dp != ndp->ni_dvp)
774			vput(ndp->ni_dvp);
775		else
776			vrele(ndp->ni_dvp);
777		VFS_UNLOCK_GIANT(dvfslocked);
778		dvfslocked = 0;
779		vref(vp_crossmp);
780		ndp->ni_dvp = vp_crossmp;
781		error = VFS_ROOT(mp, compute_cn_lkflags(mp, cnp->cn_lkflags),
782		    &tdp);
783		vfs_unbusy(mp);
784		if (vn_lock(vp_crossmp, LK_SHARED | LK_NOWAIT))
785			panic("vp_crossmp exclusively locked or reclaimed");
786		if (error) {
787			dpunlocked = 1;
788			goto bad2;
789		}
790		ndp->ni_vp = dp = tdp;
791	}
792
793	/*
794	 * Check for symbolic link
795	 */
796	if ((dp->v_type == VLNK) &&
797	    ((cnp->cn_flags & FOLLOW) || (cnp->cn_flags & TRAILINGSLASH) ||
798	     *ndp->ni_next == '/')) {
799		cnp->cn_flags |= ISSYMLINK;
800		if (dp->v_iflag & VI_DOOMED) {
801			/*
802			 * We can't know whether the directory was mounted with
803			 * NOSYMFOLLOW, so we can't follow safely.
804			 */
805			error = ENOENT;
806			goto bad2;
807		}
808		if (dp->v_mount->mnt_flag & MNT_NOSYMFOLLOW) {
809			error = EACCES;
810			goto bad2;
811		}
812		/*
813		 * Symlink code always expects an unlocked dvp.
814		 */
815		if (ndp->ni_dvp != ndp->ni_vp)
816			VOP_UNLOCK(ndp->ni_dvp, 0);
817		goto success;
818	}
819
820nextname:
821	/*
822	 * Not a symbolic link that we will follow.  Continue with the
823	 * next component if there is any; otherwise, we're done.
824	 */
825	KASSERT((cnp->cn_flags & ISLASTCN) || *ndp->ni_next == '/',
826	    ("lookup: invalid path state."));
827	if (*ndp->ni_next == '/') {
828		cnp->cn_nameptr = ndp->ni_next;
829		while (*cnp->cn_nameptr == '/') {
830			cnp->cn_nameptr++;
831			ndp->ni_pathlen--;
832		}
833		if (ndp->ni_dvp != dp)
834			vput(ndp->ni_dvp);
835		else
836			vrele(ndp->ni_dvp);
837		VFS_UNLOCK_GIANT(dvfslocked);
838		dvfslocked = vfslocked;	/* dp becomes dvp in dirloop */
839		vfslocked = 0;
840		goto dirloop;
841	}
842	/*
843	 * If we're processing a path with a trailing slash,
844	 * check that the end result is a directory.
845	 */
846	if ((cnp->cn_flags & TRAILINGSLASH) && dp->v_type != VDIR) {
847		error = ENOTDIR;
848		goto bad2;
849	}
850	/*
851	 * Disallow directory write attempts on read-only filesystems.
852	 */
853	if (rdonly &&
854	    (cnp->cn_nameiop == DELETE || cnp->cn_nameiop == RENAME)) {
855		error = EROFS;
856		goto bad2;
857	}
858	if (cnp->cn_flags & SAVESTART) {
859		ndp->ni_startdir = ndp->ni_dvp;
860		VREF(ndp->ni_startdir);
861	}
862	if (!wantparent) {
863		if (ndp->ni_dvp != dp)
864			vput(ndp->ni_dvp);
865		else
866			vrele(ndp->ni_dvp);
867		VFS_UNLOCK_GIANT(dvfslocked);
868		dvfslocked = 0;
869	} else if ((cnp->cn_flags & LOCKPARENT) == 0 && ndp->ni_dvp != dp)
870		VOP_UNLOCK(ndp->ni_dvp, 0);
871
872	if (cnp->cn_flags & AUDITVNODE1)
873		AUDIT_ARG_VNODE1(dp);
874	else if (cnp->cn_flags & AUDITVNODE2)
875		AUDIT_ARG_VNODE2(dp);
876
877	if ((cnp->cn_flags & LOCKLEAF) == 0)
878		VOP_UNLOCK(dp, 0);
879success:
880	/*
881	 * Because of lookup_shared we may have the vnode shared locked, but
882	 * the caller may want it to be exclusively locked.
883	 */
884	if (needs_exclusive_leaf(dp->v_mount, cnp->cn_flags) &&
885	    VOP_ISLOCKED(dp) != LK_EXCLUSIVE) {
886		vn_lock(dp, LK_UPGRADE | LK_RETRY);
887		if (dp->v_iflag & VI_DOOMED) {
888			error = ENOENT;
889			goto bad2;
890		}
891	}
892	if (vfslocked && dvfslocked)
893		VFS_UNLOCK_GIANT(dvfslocked);	/* Only need one */
894	if (vfslocked || dvfslocked)
895		ndp->ni_cnd.cn_flags |= GIANTHELD;
896	return (0);
897
898bad2:
899	if (dp != ndp->ni_dvp)
900		vput(ndp->ni_dvp);
901	else
902		vrele(ndp->ni_dvp);
903bad:
904	if (!dpunlocked)
905		vput(dp);
906	VFS_UNLOCK_GIANT(vfslocked);
907	VFS_UNLOCK_GIANT(dvfslocked);
908	ndp->ni_cnd.cn_flags &= ~GIANTHELD;
909	ndp->ni_vp = NULL;
910	return (error);
911}
912
913/*
914 * relookup - lookup a path name component
915 *    Used by lookup to re-acquire things.
916 */
917int
918relookup(struct vnode *dvp, struct vnode **vpp, struct componentname *cnp)
919{
920	struct vnode *dp = 0;		/* the directory we are searching */
921	int wantparent;			/* 1 => wantparent or lockparent flag */
922	int rdonly;			/* lookup read-only flag bit */
923	int error = 0;
924
925	KASSERT(cnp->cn_flags & ISLASTCN,
926	    ("relookup: Not given last component."));
927	/*
928	 * Setup: break out flag bits into variables.
929	 */
930	wantparent = cnp->cn_flags & (LOCKPARENT|WANTPARENT);
931	KASSERT(wantparent, ("relookup: parent not wanted."));
932	rdonly = cnp->cn_flags & RDONLY;
933	cnp->cn_flags &= ~ISSYMLINK;
934	dp = dvp;
935	cnp->cn_lkflags = LK_EXCLUSIVE;
936	vn_lock(dp, LK_EXCLUSIVE | LK_RETRY);
937
938	/*
939	 * Search a new directory.
940	 *
941	 * The last component of the filename is left accessible via
942	 * cnp->cn_nameptr for callers that need the name. Callers needing
943	 * the name set the SAVENAME flag. When done, they assume
944	 * responsibility for freeing the pathname buffer.
945	 */
946#ifdef NAMEI_DIAGNOSTIC
947	printf("{%s}: ", cnp->cn_nameptr);
948#endif
949
950	/*
951	 * Check for "" which represents the root directory after slash
952	 * removal.
953	 */
954	if (cnp->cn_nameptr[0] == '\0') {
955		/*
956		 * Support only LOOKUP for "/" because lookup()
957		 * can't succeed for CREATE, DELETE and RENAME.
958		 */
959		KASSERT(cnp->cn_nameiop == LOOKUP, ("nameiop must be LOOKUP"));
960		KASSERT(dp->v_type == VDIR, ("dp is not a directory"));
961
962		if (!(cnp->cn_flags & LOCKLEAF))
963			VOP_UNLOCK(dp, 0);
964		*vpp = dp;
965		/* XXX This should probably move to the top of function. */
966		if (cnp->cn_flags & SAVESTART)
967			panic("lookup: SAVESTART");
968		return (0);
969	}
970
971	if (cnp->cn_flags & ISDOTDOT)
972		panic ("relookup: lookup on dot-dot");
973
974	/*
975	 * We now have a segment name to search for, and a directory to search.
976	 */
977#ifdef NAMEI_DIAGNOSTIC
978	vprint("search in:", dp);
979#endif
980	if ((error = VOP_LOOKUP(dp, vpp, cnp)) != 0) {
981		KASSERT(*vpp == NULL, ("leaf should be empty"));
982		if (error != EJUSTRETURN)
983			goto bad;
984		/*
985		 * If creating and at end of pathname, then can consider
986		 * allowing file to be created.
987		 */
988		if (rdonly) {
989			error = EROFS;
990			goto bad;
991		}
992		/* ASSERT(dvp == ndp->ni_startdir) */
993		if (cnp->cn_flags & SAVESTART)
994			VREF(dvp);
995		if ((cnp->cn_flags & LOCKPARENT) == 0)
996			VOP_UNLOCK(dp, 0);
997		/*
998		 * We return with ni_vp NULL to indicate that the entry
999		 * doesn't currently exist, leaving a pointer to the
1000		 * (possibly locked) directory vnode in ndp->ni_dvp.
1001		 */
1002		return (0);
1003	}
1004
1005	dp = *vpp;
1006
1007	/*
1008	 * Disallow directory write attempts on read-only filesystems.
1009	 */
1010	if (rdonly &&
1011	    (cnp->cn_nameiop == DELETE || cnp->cn_nameiop == RENAME)) {
1012		if (dvp == dp)
1013			vrele(dvp);
1014		else
1015			vput(dvp);
1016		error = EROFS;
1017		goto bad;
1018	}
1019	/*
1020	 * Set the parent lock/ref state to the requested state.
1021	 */
1022	if ((cnp->cn_flags & LOCKPARENT) == 0 && dvp != dp) {
1023		if (wantparent)
1024			VOP_UNLOCK(dvp, 0);
1025		else
1026			vput(dvp);
1027	} else if (!wantparent)
1028		vrele(dvp);
1029	/*
1030	 * Check for symbolic link
1031	 */
1032	KASSERT(dp->v_type != VLNK || !(cnp->cn_flags & FOLLOW),
1033	    ("relookup: symlink found.\n"));
1034
1035	/* ASSERT(dvp == ndp->ni_startdir) */
1036	if (cnp->cn_flags & SAVESTART)
1037		VREF(dvp);
1038
1039	if ((cnp->cn_flags & LOCKLEAF) == 0)
1040		VOP_UNLOCK(dp, 0);
1041	return (0);
1042bad:
1043	vput(dp);
1044	*vpp = NULL;
1045	return (error);
1046}
1047
1048/*
1049 * Free data allocated by namei(); see namei(9) for details.
1050 */
1051void
1052NDFREE(struct nameidata *ndp, const u_int flags)
1053{
1054	int unlock_dvp;
1055	int unlock_vp;
1056
1057	unlock_dvp = 0;
1058	unlock_vp = 0;
1059
1060	if (!(flags & NDF_NO_FREE_PNBUF) &&
1061	    (ndp->ni_cnd.cn_flags & HASBUF)) {
1062		uma_zfree(namei_zone, ndp->ni_cnd.cn_pnbuf);
1063		ndp->ni_cnd.cn_flags &= ~HASBUF;
1064	}
1065	if (!(flags & NDF_NO_VP_UNLOCK) &&
1066	    (ndp->ni_cnd.cn_flags & LOCKLEAF) && ndp->ni_vp)
1067		unlock_vp = 1;
1068	if (!(flags & NDF_NO_VP_RELE) && ndp->ni_vp) {
1069		if (unlock_vp) {
1070			vput(ndp->ni_vp);
1071			unlock_vp = 0;
1072		} else
1073			vrele(ndp->ni_vp);
1074		ndp->ni_vp = NULL;
1075	}
1076	if (unlock_vp)
1077		VOP_UNLOCK(ndp->ni_vp, 0);
1078	if (!(flags & NDF_NO_DVP_UNLOCK) &&
1079	    (ndp->ni_cnd.cn_flags & LOCKPARENT) &&
1080	    ndp->ni_dvp != ndp->ni_vp)
1081		unlock_dvp = 1;
1082	if (!(flags & NDF_NO_DVP_RELE) &&
1083	    (ndp->ni_cnd.cn_flags & (LOCKPARENT|WANTPARENT))) {
1084		if (unlock_dvp) {
1085			vput(ndp->ni_dvp);
1086			unlock_dvp = 0;
1087		} else
1088			vrele(ndp->ni_dvp);
1089		ndp->ni_dvp = NULL;
1090	}
1091	if (unlock_dvp)
1092		VOP_UNLOCK(ndp->ni_dvp, 0);
1093	if (!(flags & NDF_NO_STARTDIR_RELE) &&
1094	    (ndp->ni_cnd.cn_flags & SAVESTART)) {
1095		vrele(ndp->ni_startdir);
1096		ndp->ni_startdir = NULL;
1097	}
1098}
1099
1100/*
1101 * Determine if there is a suitable alternate filename under the specified
1102 * prefix for the specified path.  If the create flag is set, then the
1103 * alternate prefix will be used so long as the parent directory exists.
1104 * This is used by the various compatiblity ABIs so that Linux binaries prefer
1105 * files under /compat/linux for example.  The chosen path (whether under
1106 * the prefix or under /) is returned in a kernel malloc'd buffer pointed
1107 * to by pathbuf.  The caller is responsible for free'ing the buffer from
1108 * the M_TEMP bucket if one is returned.
1109 */
1110int
1111kern_alternate_path(struct thread *td, const char *prefix, const char *path,
1112    enum uio_seg pathseg, char **pathbuf, int create, int dirfd)
1113{
1114	struct nameidata nd, ndroot;
1115	char *ptr, *buf, *cp;
1116	size_t len, sz;
1117	int error;
1118
1119	buf = (char *) malloc(MAXPATHLEN, M_TEMP, M_WAITOK);
1120	*pathbuf = buf;
1121
1122	/* Copy the prefix into the new pathname as a starting point. */
1123	len = strlcpy(buf, prefix, MAXPATHLEN);
1124	if (len >= MAXPATHLEN) {
1125		*pathbuf = NULL;
1126		free(buf, M_TEMP);
1127		return (EINVAL);
1128	}
1129	sz = MAXPATHLEN - len;
1130	ptr = buf + len;
1131
1132	/* Append the filename to the prefix. */
1133	if (pathseg == UIO_SYSSPACE)
1134		error = copystr(path, ptr, sz, &len);
1135	else
1136		error = copyinstr(path, ptr, sz, &len);
1137
1138	if (error) {
1139		*pathbuf = NULL;
1140		free(buf, M_TEMP);
1141		return (error);
1142	}
1143
1144	/* Only use a prefix with absolute pathnames. */
1145	if (*ptr != '/') {
1146		error = EINVAL;
1147		goto keeporig;
1148	}
1149
1150	if (dirfd != AT_FDCWD) {
1151		/*
1152		 * We want the original because the "prefix" is
1153		 * included in the already opened dirfd.
1154		 */
1155		bcopy(ptr, buf, len);
1156		return (0);
1157	}
1158
1159	/*
1160	 * We know that there is a / somewhere in this pathname.
1161	 * Search backwards for it, to find the file's parent dir
1162	 * to see if it exists in the alternate tree. If it does,
1163	 * and we want to create a file (cflag is set). We don't
1164	 * need to worry about the root comparison in this case.
1165	 */
1166
1167	if (create) {
1168		for (cp = &ptr[len] - 1; *cp != '/'; cp--);
1169		*cp = '\0';
1170
1171		NDINIT(&nd, LOOKUP, FOLLOW | MPSAFE, UIO_SYSSPACE, buf, td);
1172		error = namei(&nd);
1173		*cp = '/';
1174		if (error != 0)
1175			goto keeporig;
1176	} else {
1177		NDINIT(&nd, LOOKUP, FOLLOW | MPSAFE, UIO_SYSSPACE, buf, td);
1178
1179		error = namei(&nd);
1180		if (error != 0)
1181			goto keeporig;
1182
1183		/*
1184		 * We now compare the vnode of the prefix to the one
1185		 * vnode asked. If they resolve to be the same, then we
1186		 * ignore the match so that the real root gets used.
1187		 * This avoids the problem of traversing "../.." to find the
1188		 * root directory and never finding it, because "/" resolves
1189		 * to the emulation root directory. This is expensive :-(
1190		 */
1191		NDINIT(&ndroot, LOOKUP, FOLLOW | MPSAFE, UIO_SYSSPACE, prefix,
1192		    td);
1193
1194		/* We shouldn't ever get an error from this namei(). */
1195		error = namei(&ndroot);
1196		if (error == 0) {
1197			if (nd.ni_vp == ndroot.ni_vp)
1198				error = ENOENT;
1199
1200			NDFREE(&ndroot, NDF_ONLY_PNBUF);
1201			vrele(ndroot.ni_vp);
1202			VFS_UNLOCK_GIANT(NDHASGIANT(&ndroot));
1203		}
1204	}
1205
1206	NDFREE(&nd, NDF_ONLY_PNBUF);
1207	vrele(nd.ni_vp);
1208	VFS_UNLOCK_GIANT(NDHASGIANT(&nd));
1209
1210keeporig:
1211	/* If there was an error, use the original path name. */
1212	if (error)
1213		bcopy(ptr, buf, len);
1214	return (error);
1215}
1216