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