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 #ifdef INVARIANTS 65 #include <machine/_inttypes.h> 66 #endif 67 68 #include <security/audit/audit.h> 69 #include <security/mac/mac_framework.h> 70 71 #include <vm/uma.h> 72 73 #define NAMEI_DIAGNOSTIC 1 74 #undef NAMEI_DIAGNOSTIC 75 76 SDT_PROVIDER_DEFINE(vfs); 77 SDT_PROBE_DEFINE4(vfs, namei, lookup, entry, "struct vnode *", "char *", 78 "unsigned long", "bool"); 79 SDT_PROBE_DEFINE3(vfs, namei, lookup, return, "int", "struct vnode *", "bool"); 80 81 /* Allocation zone for namei. */ 82 uma_zone_t namei_zone; 83 84 /* Placeholder vnode for mp traversal. */ 85 static struct vnode *vp_crossmp; 86 87 static int 88 crossmp_vop_islocked(struct vop_islocked_args *ap) 89 { 90 91 return (LK_SHARED); 92 } 93 94 static int 95 crossmp_vop_lock1(struct vop_lock1_args *ap) 96 { 97 struct vnode *vp; 98 struct lock *lk __unused; 99 const char *file __unused; 100 int flags, line __unused; 101 102 vp = ap->a_vp; 103 lk = vp->v_vnlock; 104 flags = ap->a_flags; 105 file = ap->a_file; 106 line = ap->a_line; 107 108 if ((flags & LK_SHARED) == 0) 109 panic("invalid lock request for crossmp"); 110 111 WITNESS_CHECKORDER(&lk->lock_object, LOP_NEWORDER, file, line, 112 flags & LK_INTERLOCK ? &VI_MTX(vp)->lock_object : NULL); 113 WITNESS_LOCK(&lk->lock_object, 0, file, line); 114 if ((flags & LK_INTERLOCK) != 0) 115 VI_UNLOCK(vp); 116 LOCK_LOG_LOCK("SLOCK", &lk->lock_object, 0, 0, ap->a_file, line); 117 return (0); 118 } 119 120 static int 121 crossmp_vop_unlock(struct vop_unlock_args *ap) 122 { 123 struct vnode *vp; 124 struct lock *lk __unused; 125 126 vp = ap->a_vp; 127 lk = vp->v_vnlock; 128 129 WITNESS_UNLOCK(&lk->lock_object, 0, LOCK_FILE, LOCK_LINE); 130 LOCK_LOG_LOCK("SUNLOCK", &lk->lock_object, 0, 0, LOCK_FILE, 131 LOCK_LINE); 132 return (0); 133 } 134 135 static struct vop_vector crossmp_vnodeops = { 136 .vop_default = &default_vnodeops, 137 .vop_islocked = crossmp_vop_islocked, 138 .vop_lock1 = crossmp_vop_lock1, 139 .vop_unlock = crossmp_vop_unlock, 140 }; 141 /* 142 * VFS_VOP_VECTOR_REGISTER(crossmp_vnodeops) is not used here since the vnode 143 * gets allocated early. See nameiinit for the direct call below. 144 */ 145 146 struct nameicap_tracker { 147 struct vnode *dp; 148 TAILQ_ENTRY(nameicap_tracker) nm_link; 149 }; 150 151 /* Zone for cap mode tracker elements used for dotdot capability checks. */ 152 static uma_zone_t nt_zone; 153 154 static void 155 nameiinit(void *dummy __unused) 156 { 157 158 namei_zone = uma_zcreate("NAMEI", MAXPATHLEN, NULL, NULL, NULL, NULL, 159 UMA_ALIGN_PTR, 0); 160 nt_zone = uma_zcreate("rentr", sizeof(struct nameicap_tracker), 161 NULL, NULL, NULL, NULL, UMA_ALIGN_PTR, 0); 162 vfs_vector_op_register(&crossmp_vnodeops); 163 getnewvnode("crossmp", NULL, &crossmp_vnodeops, &vp_crossmp); 164 } 165 SYSINIT(vfs, SI_SUB_VFS, SI_ORDER_SECOND, nameiinit, NULL); 166 167 static int lookup_cap_dotdot = 1; 168 SYSCTL_INT(_vfs, OID_AUTO, lookup_cap_dotdot, CTLFLAG_RWTUN, 169 &lookup_cap_dotdot, 0, 170 "enables \"..\" components in path lookup in capability mode"); 171 static int lookup_cap_dotdot_nonlocal = 1; 172 SYSCTL_INT(_vfs, OID_AUTO, lookup_cap_dotdot_nonlocal, CTLFLAG_RWTUN, 173 &lookup_cap_dotdot_nonlocal, 0, 174 "enables \"..\" components in path lookup in capability mode " 175 "on non-local mount"); 176 177 static void 178 nameicap_tracker_add(struct nameidata *ndp, struct vnode *dp) 179 { 180 struct nameicap_tracker *nt; 181 struct componentname *cnp; 182 183 if ((ndp->ni_lcf & NI_LCF_CAP_DOTDOT) == 0 || dp->v_type != VDIR) 184 return; 185 cnp = &ndp->ni_cnd; 186 if ((cnp->cn_flags & BENEATH) != 0 && 187 (ndp->ni_lcf & NI_LCF_BENEATH_LATCHED) == 0) { 188 MPASS((ndp->ni_lcf & NI_LCF_LATCH) != 0); 189 if (dp != ndp->ni_beneath_latch) 190 return; 191 ndp->ni_lcf |= NI_LCF_BENEATH_LATCHED; 192 } 193 nt = uma_zalloc(nt_zone, M_WAITOK); 194 vhold(dp); 195 nt->dp = dp; 196 TAILQ_INSERT_TAIL(&ndp->ni_cap_tracker, nt, nm_link); 197 } 198 199 static void 200 nameicap_cleanup(struct nameidata *ndp, bool clean_latch) 201 { 202 struct nameicap_tracker *nt, *nt1; 203 204 KASSERT(TAILQ_EMPTY(&ndp->ni_cap_tracker) || 205 (ndp->ni_lcf & NI_LCF_CAP_DOTDOT) != 0, ("not strictrelative")); 206 TAILQ_FOREACH_SAFE(nt, &ndp->ni_cap_tracker, nm_link, nt1) { 207 TAILQ_REMOVE(&ndp->ni_cap_tracker, nt, nm_link); 208 vdrop(nt->dp); 209 uma_zfree(nt_zone, nt); 210 } 211 if (clean_latch && (ndp->ni_lcf & NI_LCF_LATCH) != 0) { 212 ndp->ni_lcf &= ~NI_LCF_LATCH; 213 vrele(ndp->ni_beneath_latch); 214 } 215 } 216 217 /* 218 * For dotdot lookups in capability mode, only allow the component 219 * lookup to succeed if the resulting directory was already traversed 220 * during the operation. This catches situations where already 221 * traversed directory is moved to different parent, and then we walk 222 * over it with dotdots. 223 * 224 * Also allow to force failure of dotdot lookups for non-local 225 * filesystems, where external agents might assist local lookups to 226 * escape the compartment. 227 */ 228 static int 229 nameicap_check_dotdot(struct nameidata *ndp, struct vnode *dp) 230 { 231 struct nameicap_tracker *nt; 232 struct mount *mp; 233 234 if ((ndp->ni_lcf & NI_LCF_CAP_DOTDOT) == 0 || dp == NULL || 235 dp->v_type != VDIR) 236 return (0); 237 mp = dp->v_mount; 238 if (lookup_cap_dotdot_nonlocal == 0 && mp != NULL && 239 (mp->mnt_flag & MNT_LOCAL) == 0) 240 return (ENOTCAPABLE); 241 TAILQ_FOREACH_REVERSE(nt, &ndp->ni_cap_tracker, nameicap_tracker_head, 242 nm_link) { 243 if ((ndp->ni_lcf & NI_LCF_LATCH) != 0 && 244 ndp->ni_beneath_latch == nt->dp) { 245 ndp->ni_lcf &= ~NI_LCF_BENEATH_LATCHED; 246 nameicap_cleanup(ndp, false); 247 return (0); 248 } 249 if (dp == nt->dp) 250 return (0); 251 } 252 return (ENOTCAPABLE); 253 } 254 255 static void 256 namei_cleanup_cnp(struct componentname *cnp) 257 { 258 259 uma_zfree(namei_zone, cnp->cn_pnbuf); 260 #ifdef DIAGNOSTIC 261 cnp->cn_pnbuf = NULL; 262 cnp->cn_nameptr = NULL; 263 #endif 264 } 265 266 static int 267 namei_handle_root(struct nameidata *ndp, struct vnode **dpp) 268 { 269 struct componentname *cnp; 270 271 cnp = &ndp->ni_cnd; 272 if ((ndp->ni_lcf & NI_LCF_STRICTRELATIVE) != 0) { 273 #ifdef KTRACE 274 if (KTRPOINT(curthread, KTR_CAPFAIL)) 275 ktrcapfail(CAPFAIL_LOOKUP, NULL, NULL); 276 #endif 277 return (ENOTCAPABLE); 278 } 279 if ((cnp->cn_flags & BENEATH) != 0) { 280 ndp->ni_lcf |= NI_LCF_BENEATH_ABS; 281 ndp->ni_lcf &= ~NI_LCF_BENEATH_LATCHED; 282 nameicap_cleanup(ndp, false); 283 } 284 while (*(cnp->cn_nameptr) == '/') { 285 cnp->cn_nameptr++; 286 ndp->ni_pathlen--; 287 } 288 *dpp = ndp->ni_rootdir; 289 vrefact(*dpp); 290 return (0); 291 } 292 293 static int 294 namei_setup(struct nameidata *ndp, struct vnode **dpp, struct pwd **pwdp) 295 { 296 struct componentname *cnp; 297 struct file *dfp; 298 struct thread *td; 299 struct pwd *pwd; 300 cap_rights_t rights; 301 struct filecaps dirfd_caps; 302 int error; 303 bool startdir_used; 304 305 cnp = &ndp->ni_cnd; 306 td = cnp->cn_thread; 307 308 startdir_used = false; 309 *pwdp = NULL; 310 *dpp = NULL; 311 312 #ifdef CAPABILITY_MODE 313 /* 314 * In capability mode, lookups must be restricted to happen in 315 * the subtree with the root specified by the file descriptor: 316 * - The root must be real file descriptor, not the pseudo-descriptor 317 * AT_FDCWD. 318 * - The passed path must be relative and not absolute. 319 * - If lookup_cap_dotdot is disabled, path must not contain the 320 * '..' components. 321 * - If lookup_cap_dotdot is enabled, we verify that all '..' 322 * components lookups result in the directories which were 323 * previously walked by us, which prevents an escape from 324 * the relative root. 325 */ 326 if (IN_CAPABILITY_MODE(td) && (cnp->cn_flags & NOCAPCHECK) == 0) { 327 ndp->ni_lcf |= NI_LCF_STRICTRELATIVE; 328 ndp->ni_resflags |= NIRES_STRICTREL; 329 if (ndp->ni_dirfd == AT_FDCWD) { 330 #ifdef KTRACE 331 if (KTRPOINT(td, KTR_CAPFAIL)) 332 ktrcapfail(CAPFAIL_LOOKUP, NULL, NULL); 333 #endif 334 return (ECAPMODE); 335 } 336 } 337 #endif 338 error = 0; 339 340 /* 341 * Get starting point for the translation. 342 */ 343 pwd = pwd_hold(td); 344 /* 345 * The reference on ni_rootdir is acquired in the block below to avoid 346 * back-to-back atomics for absolute lookups. 347 */ 348 ndp->ni_rootdir = pwd->pwd_rdir; 349 ndp->ni_topdir = pwd->pwd_jdir; 350 351 if (cnp->cn_pnbuf[0] == '/') { 352 ndp->ni_resflags |= NIRES_ABS; 353 error = namei_handle_root(ndp, dpp); 354 } else { 355 if (ndp->ni_startdir != NULL) { 356 *dpp = ndp->ni_startdir; 357 startdir_used = true; 358 } else if (ndp->ni_dirfd == AT_FDCWD) { 359 *dpp = pwd->pwd_cdir; 360 vrefact(*dpp); 361 } else { 362 rights = *ndp->ni_rightsneeded; 363 cap_rights_set_one(&rights, CAP_LOOKUP); 364 365 if (cnp->cn_flags & AUDITVNODE1) 366 AUDIT_ARG_ATFD1(ndp->ni_dirfd); 367 if (cnp->cn_flags & AUDITVNODE2) 368 AUDIT_ARG_ATFD2(ndp->ni_dirfd); 369 /* 370 * Effectively inlined fgetvp_rights, because we need to 371 * inspect the file as well as grabbing the vnode. 372 */ 373 error = fget_cap(td, ndp->ni_dirfd, &rights, 374 &dfp, &ndp->ni_filecaps); 375 if (error != 0) { 376 /* 377 * Preserve the error; it should either be EBADF 378 * or capability-related, both of which can be 379 * safely returned to the caller. 380 */ 381 } else { 382 if (dfp->f_ops == &badfileops) { 383 error = EBADF; 384 } else if (dfp->f_vnode == NULL) { 385 error = ENOTDIR; 386 } else { 387 *dpp = dfp->f_vnode; 388 vrefact(*dpp); 389 390 if ((dfp->f_flag & FSEARCH) != 0) 391 cnp->cn_flags |= NOEXECCHECK; 392 } 393 fdrop(dfp, td); 394 } 395 #ifdef CAPABILITIES 396 /* 397 * If file descriptor doesn't have all rights, 398 * all lookups relative to it must also be 399 * strictly relative. 400 */ 401 CAP_ALL(&rights); 402 if (!cap_rights_contains(&ndp->ni_filecaps.fc_rights, 403 &rights) || 404 ndp->ni_filecaps.fc_fcntls != CAP_FCNTL_ALL || 405 ndp->ni_filecaps.fc_nioctls != -1) { 406 ndp->ni_lcf |= NI_LCF_STRICTRELATIVE; 407 ndp->ni_resflags |= NIRES_STRICTREL; 408 } 409 #endif 410 } 411 if (error == 0 && (*dpp)->v_type != VDIR) 412 error = ENOTDIR; 413 } 414 if (error == 0 && (cnp->cn_flags & BENEATH) != 0) { 415 if (ndp->ni_dirfd == AT_FDCWD) { 416 ndp->ni_beneath_latch = pwd->pwd_cdir; 417 vrefact(ndp->ni_beneath_latch); 418 } else { 419 rights = *ndp->ni_rightsneeded; 420 cap_rights_set_one(&rights, CAP_LOOKUP); 421 error = fgetvp_rights(td, ndp->ni_dirfd, &rights, 422 &dirfd_caps, &ndp->ni_beneath_latch); 423 if (error == 0 && (*dpp)->v_type != VDIR) { 424 vrele(ndp->ni_beneath_latch); 425 error = ENOTDIR; 426 } 427 } 428 if (error == 0) 429 ndp->ni_lcf |= NI_LCF_LATCH; 430 } 431 if (error == 0 && (cnp->cn_flags & RBENEATH) != 0) { 432 if (cnp->cn_pnbuf[0] == '/' || 433 (ndp->ni_lcf & NI_LCF_BENEATH_ABS) != 0) { 434 error = EINVAL; 435 } else if ((ndp->ni_lcf & NI_LCF_STRICTRELATIVE) == 0) { 436 ndp->ni_lcf |= NI_LCF_STRICTRELATIVE | 437 NI_LCF_CAP_DOTDOT; 438 } 439 } 440 441 /* 442 * If we are auditing the kernel pathname, save the user pathname. 443 */ 444 if (cnp->cn_flags & AUDITVNODE1) 445 AUDIT_ARG_UPATH1_VP(td, ndp->ni_rootdir, *dpp, cnp->cn_pnbuf); 446 if (cnp->cn_flags & AUDITVNODE2) 447 AUDIT_ARG_UPATH2_VP(td, ndp->ni_rootdir, *dpp, cnp->cn_pnbuf); 448 if (ndp->ni_startdir != NULL && !startdir_used) 449 vrele(ndp->ni_startdir); 450 if (error != 0) { 451 if (*dpp != NULL) 452 vrele(*dpp); 453 pwd_drop(pwd); 454 return (error); 455 } 456 MPASS((ndp->ni_lcf & (NI_LCF_BENEATH_ABS | NI_LCF_LATCH)) != 457 NI_LCF_BENEATH_ABS); 458 if (((ndp->ni_lcf & NI_LCF_STRICTRELATIVE) != 0 && 459 lookup_cap_dotdot != 0) || 460 ((ndp->ni_lcf & NI_LCF_STRICTRELATIVE) == 0 && 461 (cnp->cn_flags & BENEATH) != 0)) 462 ndp->ni_lcf |= NI_LCF_CAP_DOTDOT; 463 SDT_PROBE4(vfs, namei, lookup, entry, *dpp, cnp->cn_pnbuf, 464 cnp->cn_flags, false); 465 *pwdp = pwd; 466 return (0); 467 } 468 469 /* 470 * Convert a pathname into a pointer to a locked vnode. 471 * 472 * The FOLLOW flag is set when symbolic links are to be followed 473 * when they occur at the end of the name translation process. 474 * Symbolic links are always followed for all other pathname 475 * components other than the last. 476 * 477 * The segflg defines whether the name is to be copied from user 478 * space or kernel space. 479 * 480 * Overall outline of namei: 481 * 482 * copy in name 483 * get starting directory 484 * while (!done && !error) { 485 * call lookup to search path. 486 * if symbolic link, massage name in buffer and continue 487 * } 488 */ 489 int 490 namei(struct nameidata *ndp) 491 { 492 char *cp; /* pointer into pathname argument */ 493 struct vnode *dp; /* the directory we are searching */ 494 struct iovec aiov; /* uio for reading symbolic links */ 495 struct componentname *cnp; 496 struct thread *td; 497 struct pwd *pwd; 498 struct uio auio; 499 int error, linklen; 500 enum cache_fpl_status status; 501 502 cnp = &ndp->ni_cnd; 503 td = cnp->cn_thread; 504 #ifdef INVARIANTS 505 /* 506 * For NDVALIDATE. 507 * 508 * While NDINIT may seem like a more natural place to do it, there are 509 * callers which directly modify flags past invoking init. 510 */ 511 cnp->cn_origflags = cnp->cn_flags; 512 #endif 513 ndp->ni_cnd.cn_cred = ndp->ni_cnd.cn_thread->td_ucred; 514 KASSERT(cnp->cn_cred && td->td_proc, ("namei: bad cred/proc")); 515 KASSERT((cnp->cn_flags & NAMEI_INTERNAL_FLAGS) == 0, 516 ("namei: unexpected flags: %" PRIx64 "\n", 517 cnp->cn_flags & NAMEI_INTERNAL_FLAGS)); 518 if (cnp->cn_flags & NOCACHE) 519 KASSERT(cnp->cn_nameiop != LOOKUP, 520 ("%s: NOCACHE passed with LOOKUP", __func__)); 521 MPASS(ndp->ni_startdir == NULL || ndp->ni_startdir->v_type == VDIR || 522 ndp->ni_startdir->v_type == VBAD); 523 524 ndp->ni_lcf = 0; 525 ndp->ni_vp = NULL; 526 527 /* 528 * Get a buffer for the name to be translated, and copy the 529 * name into the buffer. 530 */ 531 cnp->cn_pnbuf = uma_zalloc(namei_zone, M_WAITOK); 532 if (ndp->ni_segflg == UIO_SYSSPACE) 533 error = copystr(ndp->ni_dirp, cnp->cn_pnbuf, MAXPATHLEN, 534 &ndp->ni_pathlen); 535 else 536 error = copyinstr(ndp->ni_dirp, cnp->cn_pnbuf, MAXPATHLEN, 537 &ndp->ni_pathlen); 538 539 if (__predict_false(error != 0)) { 540 namei_cleanup_cnp(cnp); 541 return (error); 542 } 543 544 /* 545 * Don't allow empty pathnames. 546 */ 547 if (__predict_false(*cnp->cn_pnbuf == '\0')) { 548 namei_cleanup_cnp(cnp); 549 return (ENOENT); 550 } 551 552 #ifdef KTRACE 553 if (KTRPOINT(td, KTR_NAMEI)) { 554 KASSERT(cnp->cn_thread == curthread, 555 ("namei not using curthread")); 556 ktrnamei(cnp->cn_pnbuf); 557 } 558 #endif 559 560 cnp->cn_nameptr = cnp->cn_pnbuf; 561 562 /* 563 * First try looking up the target without locking any vnodes. 564 * 565 * We may need to start from scratch or pick up where it left off. 566 */ 567 error = cache_fplookup(ndp, &status, &pwd); 568 switch (status) { 569 case CACHE_FPL_STATUS_UNSET: 570 __assert_unreachable(); 571 break; 572 case CACHE_FPL_STATUS_HANDLED: 573 if (error == 0) 574 NDVALIDATE(ndp); 575 return (error); 576 case CACHE_FPL_STATUS_PARTIAL: 577 TAILQ_INIT(&ndp->ni_cap_tracker); 578 dp = ndp->ni_startdir; 579 break; 580 case CACHE_FPL_STATUS_ABORTED: 581 TAILQ_INIT(&ndp->ni_cap_tracker); 582 error = namei_setup(ndp, &dp, &pwd); 583 if (error != 0) { 584 namei_cleanup_cnp(cnp); 585 return (error); 586 } 587 break; 588 } 589 590 ndp->ni_loopcnt = 0; 591 592 /* 593 * Locked lookup. 594 */ 595 for (;;) { 596 ndp->ni_startdir = dp; 597 error = lookup(ndp); 598 if (error != 0) 599 goto out; 600 /* 601 * If not a symbolic link, we're done. 602 */ 603 if ((cnp->cn_flags & ISSYMLINK) == 0) { 604 if ((cnp->cn_flags & (SAVENAME | SAVESTART)) == 0) { 605 namei_cleanup_cnp(cnp); 606 } else 607 cnp->cn_flags |= HASBUF; 608 if ((ndp->ni_lcf & (NI_LCF_LATCH | 609 NI_LCF_BENEATH_LATCHED)) == NI_LCF_LATCH) { 610 NDFREE(ndp, 0); 611 error = ENOTCAPABLE; 612 } 613 nameicap_cleanup(ndp, true); 614 SDT_PROBE3(vfs, namei, lookup, return, error, 615 (error == 0 ? ndp->ni_vp : NULL), false); 616 pwd_drop(pwd); 617 if (error == 0) 618 NDVALIDATE(ndp); 619 return (error); 620 } 621 if (ndp->ni_loopcnt++ >= MAXSYMLINKS) { 622 error = ELOOP; 623 break; 624 } 625 #ifdef MAC 626 if ((cnp->cn_flags & NOMACCHECK) == 0) { 627 error = mac_vnode_check_readlink(td->td_ucred, 628 ndp->ni_vp); 629 if (error != 0) 630 break; 631 } 632 #endif 633 if (ndp->ni_pathlen > 1) 634 cp = uma_zalloc(namei_zone, M_WAITOK); 635 else 636 cp = cnp->cn_pnbuf; 637 aiov.iov_base = cp; 638 aiov.iov_len = MAXPATHLEN; 639 auio.uio_iov = &aiov; 640 auio.uio_iovcnt = 1; 641 auio.uio_offset = 0; 642 auio.uio_rw = UIO_READ; 643 auio.uio_segflg = UIO_SYSSPACE; 644 auio.uio_td = td; 645 auio.uio_resid = MAXPATHLEN; 646 error = VOP_READLINK(ndp->ni_vp, &auio, cnp->cn_cred); 647 if (error != 0) { 648 if (ndp->ni_pathlen > 1) 649 uma_zfree(namei_zone, cp); 650 break; 651 } 652 linklen = MAXPATHLEN - auio.uio_resid; 653 if (linklen == 0) { 654 if (ndp->ni_pathlen > 1) 655 uma_zfree(namei_zone, cp); 656 error = ENOENT; 657 break; 658 } 659 if (linklen + ndp->ni_pathlen > MAXPATHLEN) { 660 if (ndp->ni_pathlen > 1) 661 uma_zfree(namei_zone, cp); 662 error = ENAMETOOLONG; 663 break; 664 } 665 if (ndp->ni_pathlen > 1) { 666 bcopy(ndp->ni_next, cp + linklen, ndp->ni_pathlen); 667 uma_zfree(namei_zone, cnp->cn_pnbuf); 668 cnp->cn_pnbuf = cp; 669 } else 670 cnp->cn_pnbuf[linklen] = '\0'; 671 ndp->ni_pathlen += linklen; 672 vput(ndp->ni_vp); 673 dp = ndp->ni_dvp; 674 /* 675 * Check if root directory should replace current directory. 676 */ 677 cnp->cn_nameptr = cnp->cn_pnbuf; 678 if (*(cnp->cn_nameptr) == '/') { 679 vrele(dp); 680 error = namei_handle_root(ndp, &dp); 681 if (error != 0) 682 goto out; 683 } 684 } 685 vput(ndp->ni_vp); 686 ndp->ni_vp = NULL; 687 vrele(ndp->ni_dvp); 688 out: 689 MPASS(error != 0); 690 namei_cleanup_cnp(cnp); 691 nameicap_cleanup(ndp, true); 692 SDT_PROBE3(vfs, namei, lookup, return, error, NULL, false); 693 pwd_drop(pwd); 694 return (error); 695 } 696 697 static int 698 compute_cn_lkflags(struct mount *mp, int lkflags, int cnflags) 699 { 700 701 if (mp == NULL || ((lkflags & LK_SHARED) && 702 (!(mp->mnt_kern_flag & MNTK_LOOKUP_SHARED) || 703 ((cnflags & ISDOTDOT) && 704 (mp->mnt_kern_flag & MNTK_LOOKUP_EXCL_DOTDOT))))) { 705 lkflags &= ~LK_SHARED; 706 lkflags |= LK_EXCLUSIVE; 707 } 708 lkflags |= LK_NODDLKTREAT; 709 return (lkflags); 710 } 711 712 static __inline int 713 needs_exclusive_leaf(struct mount *mp, int flags) 714 { 715 716 /* 717 * Intermediate nodes can use shared locks, we only need to 718 * force an exclusive lock for leaf nodes. 719 */ 720 if ((flags & (ISLASTCN | LOCKLEAF)) != (ISLASTCN | LOCKLEAF)) 721 return (0); 722 723 /* Always use exclusive locks if LOCKSHARED isn't set. */ 724 if (!(flags & LOCKSHARED)) 725 return (1); 726 727 /* 728 * For lookups during open(), if the mount point supports 729 * extended shared operations, then use a shared lock for the 730 * leaf node, otherwise use an exclusive lock. 731 */ 732 if ((flags & ISOPEN) != 0) 733 return (!MNT_EXTENDED_SHARED(mp)); 734 735 /* 736 * Lookup requests outside of open() that specify LOCKSHARED 737 * only need a shared lock on the leaf vnode. 738 */ 739 return (0); 740 } 741 742 /* 743 * Search a pathname. 744 * This is a very central and rather complicated routine. 745 * 746 * The pathname is pointed to by ni_ptr and is of length ni_pathlen. 747 * The starting directory is taken from ni_startdir. The pathname is 748 * descended until done, or a symbolic link is encountered. The variable 749 * ni_more is clear if the path is completed; it is set to one if a 750 * symbolic link needing interpretation is encountered. 751 * 752 * The flag argument is LOOKUP, CREATE, RENAME, or DELETE depending on 753 * whether the name is to be looked up, created, renamed, or deleted. 754 * When CREATE, RENAME, or DELETE is specified, information usable in 755 * creating, renaming, or deleting a directory entry may be calculated. 756 * If flag has LOCKPARENT or'ed into it, the parent directory is returned 757 * locked. If flag has WANTPARENT or'ed into it, the parent directory is 758 * returned unlocked. Otherwise the parent directory is not returned. If 759 * the target of the pathname exists and LOCKLEAF is or'ed into the flag 760 * the target is returned locked, otherwise it is returned unlocked. 761 * When creating or renaming and LOCKPARENT is specified, the target may not 762 * be ".". When deleting and LOCKPARENT is specified, the target may be ".". 763 * 764 * Overall outline of lookup: 765 * 766 * dirloop: 767 * identify next component of name at ndp->ni_ptr 768 * handle degenerate case where name is null string 769 * if .. and crossing mount points and on mounted filesys, find parent 770 * call VOP_LOOKUP routine for next component name 771 * directory vnode returned in ni_dvp, unlocked unless LOCKPARENT set 772 * component vnode returned in ni_vp (if it exists), locked. 773 * if result vnode is mounted on and crossing mount points, 774 * find mounted on vnode 775 * if more components of name, do next level at dirloop 776 * return the answer in ni_vp, locked if LOCKLEAF set 777 * if LOCKPARENT set, return locked parent in ni_dvp 778 * if WANTPARENT set, return unlocked parent in ni_dvp 779 */ 780 int 781 lookup(struct nameidata *ndp) 782 { 783 char *cp; /* pointer into pathname argument */ 784 char *prev_ni_next; /* saved ndp->ni_next */ 785 struct vnode *dp = NULL; /* the directory we are searching */ 786 struct vnode *tdp; /* saved dp */ 787 struct mount *mp; /* mount table entry */ 788 struct prison *pr; 789 size_t prev_ni_pathlen; /* saved ndp->ni_pathlen */ 790 int docache; /* == 0 do not cache last component */ 791 int wantparent; /* 1 => wantparent or lockparent flag */ 792 int rdonly; /* lookup read-only flag bit */ 793 int error = 0; 794 int dpunlocked = 0; /* dp has already been unlocked */ 795 int relookup = 0; /* do not consume the path component */ 796 struct componentname *cnp = &ndp->ni_cnd; 797 int lkflags_save; 798 int ni_dvp_unlocked; 799 800 /* 801 * Setup: break out flag bits into variables. 802 */ 803 ni_dvp_unlocked = 0; 804 wantparent = cnp->cn_flags & (LOCKPARENT | WANTPARENT); 805 KASSERT(cnp->cn_nameiop == LOOKUP || wantparent, 806 ("CREATE, DELETE, RENAME require LOCKPARENT or WANTPARENT.")); 807 /* 808 * When set to zero, docache causes the last component of the 809 * pathname to be deleted from the cache and the full lookup 810 * of the name to be done (via VOP_CACHEDLOOKUP()). Often 811 * filesystems need some pre-computed values that are made 812 * during the full lookup, for instance UFS sets dp->i_offset. 813 * 814 * The docache variable is set to zero when requested by the 815 * NOCACHE flag and for all modifying operations except CREATE. 816 */ 817 docache = (cnp->cn_flags & NOCACHE) ^ NOCACHE; 818 if (cnp->cn_nameiop == DELETE || 819 (wantparent && cnp->cn_nameiop != CREATE && 820 cnp->cn_nameiop != LOOKUP)) 821 docache = 0; 822 rdonly = cnp->cn_flags & RDONLY; 823 cnp->cn_flags &= ~ISSYMLINK; 824 ndp->ni_dvp = NULL; 825 /* 826 * We use shared locks until we hit the parent of the last cn then 827 * we adjust based on the requesting flags. 828 */ 829 cnp->cn_lkflags = LK_SHARED; 830 dp = ndp->ni_startdir; 831 ndp->ni_startdir = NULLVP; 832 vn_lock(dp, 833 compute_cn_lkflags(dp->v_mount, cnp->cn_lkflags | LK_RETRY, 834 cnp->cn_flags)); 835 836 dirloop: 837 /* 838 * Search a new directory. 839 * 840 * The last component of the filename is left accessible via 841 * cnp->cn_nameptr for callers that need the name. Callers needing 842 * the name set the SAVENAME flag. When done, they assume 843 * responsibility for freeing the pathname buffer. 844 */ 845 for (cp = cnp->cn_nameptr; *cp != 0 && *cp != '/'; cp++) 846 continue; 847 cnp->cn_namelen = cp - cnp->cn_nameptr; 848 if (cnp->cn_namelen > NAME_MAX) { 849 error = ENAMETOOLONG; 850 goto bad; 851 } 852 #ifdef NAMEI_DIAGNOSTIC 853 { char c = *cp; 854 *cp = '\0'; 855 printf("{%s}: ", cnp->cn_nameptr); 856 *cp = c; } 857 #endif 858 prev_ni_pathlen = ndp->ni_pathlen; 859 ndp->ni_pathlen -= cnp->cn_namelen; 860 KASSERT(ndp->ni_pathlen <= PATH_MAX, 861 ("%s: ni_pathlen underflow to %zd\n", __func__, ndp->ni_pathlen)); 862 prev_ni_next = ndp->ni_next; 863 ndp->ni_next = cp; 864 865 /* 866 * Replace multiple slashes by a single slash and trailing slashes 867 * by a null. This must be done before VOP_LOOKUP() because some 868 * fs's don't know about trailing slashes. Remember if there were 869 * trailing slashes to handle symlinks, existing non-directories 870 * and non-existing files that won't be directories specially later. 871 */ 872 while (*cp == '/' && (cp[1] == '/' || cp[1] == '\0')) { 873 cp++; 874 ndp->ni_pathlen--; 875 if (*cp == '\0') { 876 *ndp->ni_next = '\0'; 877 cnp->cn_flags |= TRAILINGSLASH; 878 } 879 } 880 ndp->ni_next = cp; 881 882 cnp->cn_flags |= MAKEENTRY; 883 if (*cp == '\0' && docache == 0) 884 cnp->cn_flags &= ~MAKEENTRY; 885 if (cnp->cn_namelen == 2 && 886 cnp->cn_nameptr[1] == '.' && cnp->cn_nameptr[0] == '.') 887 cnp->cn_flags |= ISDOTDOT; 888 else 889 cnp->cn_flags &= ~ISDOTDOT; 890 if (*ndp->ni_next == 0) 891 cnp->cn_flags |= ISLASTCN; 892 else 893 cnp->cn_flags &= ~ISLASTCN; 894 895 if ((cnp->cn_flags & ISLASTCN) != 0 && 896 cnp->cn_namelen == 1 && cnp->cn_nameptr[0] == '.' && 897 (cnp->cn_nameiop == DELETE || cnp->cn_nameiop == RENAME)) { 898 error = EINVAL; 899 goto bad; 900 } 901 902 nameicap_tracker_add(ndp, dp); 903 904 /* 905 * Check for degenerate name (e.g. / or "") 906 * which is a way of talking about a directory, 907 * e.g. like "/." or ".". 908 */ 909 if (cnp->cn_nameptr[0] == '\0') { 910 if (dp->v_type != VDIR) { 911 error = ENOTDIR; 912 goto bad; 913 } 914 if (cnp->cn_nameiop != LOOKUP) { 915 error = EISDIR; 916 goto bad; 917 } 918 if (wantparent) { 919 ndp->ni_dvp = dp; 920 VREF(dp); 921 } 922 ndp->ni_vp = dp; 923 924 if (cnp->cn_flags & AUDITVNODE1) 925 AUDIT_ARG_VNODE1(dp); 926 else if (cnp->cn_flags & AUDITVNODE2) 927 AUDIT_ARG_VNODE2(dp); 928 929 if (!(cnp->cn_flags & (LOCKPARENT | LOCKLEAF))) 930 VOP_UNLOCK(dp); 931 /* XXX This should probably move to the top of function. */ 932 if (cnp->cn_flags & SAVESTART) 933 panic("lookup: SAVESTART"); 934 goto success; 935 } 936 937 /* 938 * Handle "..": five special cases. 939 * 0. If doing a capability lookup and lookup_cap_dotdot is 940 * disabled, return ENOTCAPABLE. 941 * 1. Return an error if this is the last component of 942 * the name and the operation is DELETE or RENAME. 943 * 2. If at root directory (e.g. after chroot) 944 * or at absolute root directory 945 * then ignore it so can't get out. 946 * 3. If this vnode is the root of a mounted 947 * filesystem, then replace it with the 948 * vnode which was mounted on so we take the 949 * .. in the other filesystem. 950 * 4. If the vnode is the top directory of 951 * the jail or chroot, don't let them out. 952 * 5. If doing a capability lookup and lookup_cap_dotdot is 953 * enabled, return ENOTCAPABLE if the lookup would escape 954 * from the initial file descriptor directory. Checks are 955 * done by ensuring that namei() already traversed the 956 * result of dotdot lookup. 957 */ 958 if (cnp->cn_flags & ISDOTDOT) { 959 if ((ndp->ni_lcf & (NI_LCF_STRICTRELATIVE | NI_LCF_CAP_DOTDOT)) 960 == NI_LCF_STRICTRELATIVE) { 961 #ifdef KTRACE 962 if (KTRPOINT(curthread, KTR_CAPFAIL)) 963 ktrcapfail(CAPFAIL_LOOKUP, NULL, NULL); 964 #endif 965 error = ENOTCAPABLE; 966 goto bad; 967 } 968 if ((cnp->cn_flags & ISLASTCN) != 0 && 969 (cnp->cn_nameiop == DELETE || cnp->cn_nameiop == RENAME)) { 970 error = EINVAL; 971 goto bad; 972 } 973 for (;;) { 974 for (pr = cnp->cn_cred->cr_prison; pr != NULL; 975 pr = pr->pr_parent) 976 if (dp == pr->pr_root) 977 break; 978 if (dp == ndp->ni_rootdir || 979 dp == ndp->ni_topdir || 980 dp == rootvnode || 981 pr != NULL || 982 ((dp->v_vflag & VV_ROOT) != 0 && 983 (cnp->cn_flags & NOCROSSMOUNT) != 0)) { 984 ndp->ni_dvp = dp; 985 ndp->ni_vp = dp; 986 VREF(dp); 987 goto nextname; 988 } 989 if ((dp->v_vflag & VV_ROOT) == 0) 990 break; 991 if (VN_IS_DOOMED(dp)) { /* forced unmount */ 992 error = ENOENT; 993 goto bad; 994 } 995 tdp = dp; 996 dp = dp->v_mount->mnt_vnodecovered; 997 VREF(dp); 998 vput(tdp); 999 vn_lock(dp, 1000 compute_cn_lkflags(dp->v_mount, cnp->cn_lkflags | 1001 LK_RETRY, ISDOTDOT)); 1002 error = nameicap_check_dotdot(ndp, dp); 1003 if (error != 0) { 1004 #ifdef KTRACE 1005 if (KTRPOINT(curthread, KTR_CAPFAIL)) 1006 ktrcapfail(CAPFAIL_LOOKUP, NULL, NULL); 1007 #endif 1008 goto bad; 1009 } 1010 } 1011 } 1012 1013 /* 1014 * We now have a segment name to search for, and a directory to search. 1015 */ 1016 unionlookup: 1017 #ifdef MAC 1018 error = mac_vnode_check_lookup(cnp->cn_thread->td_ucred, dp, cnp); 1019 if (error) 1020 goto bad; 1021 #endif 1022 ndp->ni_dvp = dp; 1023 ndp->ni_vp = NULL; 1024 ASSERT_VOP_LOCKED(dp, "lookup"); 1025 /* 1026 * If we have a shared lock we may need to upgrade the lock for the 1027 * last operation. 1028 */ 1029 if ((cnp->cn_flags & LOCKPARENT) && (cnp->cn_flags & ISLASTCN) && 1030 dp != vp_crossmp && VOP_ISLOCKED(dp) == LK_SHARED) 1031 vn_lock(dp, LK_UPGRADE|LK_RETRY); 1032 if (VN_IS_DOOMED(dp)) { 1033 error = ENOENT; 1034 goto bad; 1035 } 1036 /* 1037 * If we're looking up the last component and we need an exclusive 1038 * lock, adjust our lkflags. 1039 */ 1040 if (needs_exclusive_leaf(dp->v_mount, cnp->cn_flags)) 1041 cnp->cn_lkflags = LK_EXCLUSIVE; 1042 #ifdef NAMEI_DIAGNOSTIC 1043 vn_printf(dp, "lookup in "); 1044 #endif 1045 lkflags_save = cnp->cn_lkflags; 1046 cnp->cn_lkflags = compute_cn_lkflags(dp->v_mount, cnp->cn_lkflags, 1047 cnp->cn_flags); 1048 error = VOP_LOOKUP(dp, &ndp->ni_vp, cnp); 1049 cnp->cn_lkflags = lkflags_save; 1050 if (error != 0) { 1051 KASSERT(ndp->ni_vp == NULL, ("leaf should be empty")); 1052 #ifdef NAMEI_DIAGNOSTIC 1053 printf("not found\n"); 1054 #endif 1055 if ((error == ENOENT) && 1056 (dp->v_vflag & VV_ROOT) && (dp->v_mount != NULL) && 1057 (dp->v_mount->mnt_flag & MNT_UNION)) { 1058 tdp = dp; 1059 dp = dp->v_mount->mnt_vnodecovered; 1060 VREF(dp); 1061 vput(tdp); 1062 vn_lock(dp, 1063 compute_cn_lkflags(dp->v_mount, cnp->cn_lkflags | 1064 LK_RETRY, cnp->cn_flags)); 1065 nameicap_tracker_add(ndp, dp); 1066 goto unionlookup; 1067 } 1068 1069 if (error == ERELOOKUP) { 1070 vref(dp); 1071 ndp->ni_vp = dp; 1072 error = 0; 1073 relookup = 1; 1074 goto good; 1075 } 1076 1077 if (error != EJUSTRETURN) 1078 goto bad; 1079 /* 1080 * At this point, we know we're at the end of the 1081 * pathname. If creating / renaming, we can consider 1082 * allowing the file or directory to be created / renamed, 1083 * provided we're not on a read-only filesystem. 1084 */ 1085 if (rdonly) { 1086 error = EROFS; 1087 goto bad; 1088 } 1089 /* trailing slash only allowed for directories */ 1090 if ((cnp->cn_flags & TRAILINGSLASH) && 1091 !(cnp->cn_flags & WILLBEDIR)) { 1092 error = ENOENT; 1093 goto bad; 1094 } 1095 if ((cnp->cn_flags & LOCKPARENT) == 0) 1096 VOP_UNLOCK(dp); 1097 /* 1098 * We return with ni_vp NULL to indicate that the entry 1099 * doesn't currently exist, leaving a pointer to the 1100 * (possibly locked) directory vnode in ndp->ni_dvp. 1101 */ 1102 if (cnp->cn_flags & SAVESTART) { 1103 ndp->ni_startdir = ndp->ni_dvp; 1104 VREF(ndp->ni_startdir); 1105 } 1106 goto success; 1107 } 1108 1109 good: 1110 #ifdef NAMEI_DIAGNOSTIC 1111 printf("found\n"); 1112 #endif 1113 dp = ndp->ni_vp; 1114 1115 /* 1116 * Check to see if the vnode has been mounted on; 1117 * if so find the root of the mounted filesystem. 1118 */ 1119 while (dp->v_type == VDIR && (mp = dp->v_mountedhere) && 1120 (cnp->cn_flags & NOCROSSMOUNT) == 0) { 1121 if (vfs_busy(mp, 0)) 1122 continue; 1123 vput(dp); 1124 if (dp != ndp->ni_dvp) 1125 vput(ndp->ni_dvp); 1126 else 1127 vrele(ndp->ni_dvp); 1128 vrefact(vp_crossmp); 1129 ndp->ni_dvp = vp_crossmp; 1130 error = VFS_ROOT(mp, compute_cn_lkflags(mp, cnp->cn_lkflags, 1131 cnp->cn_flags), &tdp); 1132 vfs_unbusy(mp); 1133 if (vn_lock(vp_crossmp, LK_SHARED | LK_NOWAIT)) 1134 panic("vp_crossmp exclusively locked or reclaimed"); 1135 if (error) { 1136 dpunlocked = 1; 1137 goto bad2; 1138 } 1139 ndp->ni_vp = dp = tdp; 1140 } 1141 1142 /* 1143 * Check for symbolic link 1144 */ 1145 if ((dp->v_type == VLNK) && 1146 ((cnp->cn_flags & FOLLOW) || (cnp->cn_flags & TRAILINGSLASH) || 1147 *ndp->ni_next == '/')) { 1148 cnp->cn_flags |= ISSYMLINK; 1149 if (VN_IS_DOOMED(dp)) { 1150 /* 1151 * We can't know whether the directory was mounted with 1152 * NOSYMFOLLOW, so we can't follow safely. 1153 */ 1154 error = ENOENT; 1155 goto bad2; 1156 } 1157 if (dp->v_mount->mnt_flag & MNT_NOSYMFOLLOW) { 1158 error = EACCES; 1159 goto bad2; 1160 } 1161 /* 1162 * Symlink code always expects an unlocked dvp. 1163 */ 1164 if (ndp->ni_dvp != ndp->ni_vp) { 1165 VOP_UNLOCK(ndp->ni_dvp); 1166 ni_dvp_unlocked = 1; 1167 } 1168 goto success; 1169 } 1170 1171 nextname: 1172 /* 1173 * Not a symbolic link that we will follow. Continue with the 1174 * next component if there is any; otherwise, we're done. 1175 */ 1176 KASSERT((cnp->cn_flags & ISLASTCN) || *ndp->ni_next == '/', 1177 ("lookup: invalid path state.")); 1178 if (relookup) { 1179 relookup = 0; 1180 ndp->ni_pathlen = prev_ni_pathlen; 1181 ndp->ni_next = prev_ni_next; 1182 if (ndp->ni_dvp != dp) 1183 vput(ndp->ni_dvp); 1184 else 1185 vrele(ndp->ni_dvp); 1186 goto dirloop; 1187 } 1188 if (cnp->cn_flags & ISDOTDOT) { 1189 error = nameicap_check_dotdot(ndp, ndp->ni_vp); 1190 if (error != 0) { 1191 #ifdef KTRACE 1192 if (KTRPOINT(curthread, KTR_CAPFAIL)) 1193 ktrcapfail(CAPFAIL_LOOKUP, NULL, NULL); 1194 #endif 1195 goto bad2; 1196 } 1197 } 1198 if (*ndp->ni_next == '/') { 1199 cnp->cn_nameptr = ndp->ni_next; 1200 while (*cnp->cn_nameptr == '/') { 1201 cnp->cn_nameptr++; 1202 ndp->ni_pathlen--; 1203 } 1204 if (ndp->ni_dvp != dp) 1205 vput(ndp->ni_dvp); 1206 else 1207 vrele(ndp->ni_dvp); 1208 goto dirloop; 1209 } 1210 /* 1211 * If we're processing a path with a trailing slash, 1212 * check that the end result is a directory. 1213 */ 1214 if ((cnp->cn_flags & TRAILINGSLASH) && dp->v_type != VDIR) { 1215 error = ENOTDIR; 1216 goto bad2; 1217 } 1218 /* 1219 * Disallow directory write attempts on read-only filesystems. 1220 */ 1221 if (rdonly && 1222 (cnp->cn_nameiop == DELETE || cnp->cn_nameiop == RENAME)) { 1223 error = EROFS; 1224 goto bad2; 1225 } 1226 if (cnp->cn_flags & SAVESTART) { 1227 ndp->ni_startdir = ndp->ni_dvp; 1228 VREF(ndp->ni_startdir); 1229 } 1230 if (!wantparent) { 1231 ni_dvp_unlocked = 2; 1232 if (ndp->ni_dvp != dp) 1233 vput(ndp->ni_dvp); 1234 else 1235 vrele(ndp->ni_dvp); 1236 } else if ((cnp->cn_flags & LOCKPARENT) == 0 && ndp->ni_dvp != dp) { 1237 VOP_UNLOCK(ndp->ni_dvp); 1238 ni_dvp_unlocked = 1; 1239 } 1240 1241 if (cnp->cn_flags & AUDITVNODE1) 1242 AUDIT_ARG_VNODE1(dp); 1243 else if (cnp->cn_flags & AUDITVNODE2) 1244 AUDIT_ARG_VNODE2(dp); 1245 1246 if ((cnp->cn_flags & LOCKLEAF) == 0) 1247 VOP_UNLOCK(dp); 1248 success: 1249 /* 1250 * FIXME: for lookups which only cross a mount point to fetch the 1251 * root vnode, ni_dvp will be set to vp_crossmp. This can be a problem 1252 * if either WANTPARENT or LOCKPARENT is set. 1253 */ 1254 /* 1255 * Because of shared lookup we may have the vnode shared locked, but 1256 * the caller may want it to be exclusively locked. 1257 */ 1258 if (needs_exclusive_leaf(dp->v_mount, cnp->cn_flags) && 1259 VOP_ISLOCKED(dp) != LK_EXCLUSIVE) { 1260 vn_lock(dp, LK_UPGRADE | LK_RETRY); 1261 if (VN_IS_DOOMED(dp)) { 1262 error = ENOENT; 1263 goto bad2; 1264 } 1265 } 1266 if (ndp->ni_vp != NULL && ndp->ni_vp->v_type == VDIR) 1267 nameicap_tracker_add(ndp, ndp->ni_vp); 1268 return (0); 1269 1270 bad2: 1271 if (ni_dvp_unlocked != 2) { 1272 if (dp != ndp->ni_dvp && !ni_dvp_unlocked) 1273 vput(ndp->ni_dvp); 1274 else 1275 vrele(ndp->ni_dvp); 1276 } 1277 bad: 1278 if (!dpunlocked) 1279 vput(dp); 1280 ndp->ni_vp = NULL; 1281 return (error); 1282 } 1283 1284 /* 1285 * relookup - lookup a path name component 1286 * Used by lookup to re-acquire things. 1287 */ 1288 int 1289 relookup(struct vnode *dvp, struct vnode **vpp, struct componentname *cnp) 1290 { 1291 struct vnode *dp = NULL; /* the directory we are searching */ 1292 int wantparent; /* 1 => wantparent or lockparent flag */ 1293 int rdonly; /* lookup read-only flag bit */ 1294 int error = 0; 1295 1296 KASSERT(cnp->cn_flags & ISLASTCN, 1297 ("relookup: Not given last component.")); 1298 /* 1299 * Setup: break out flag bits into variables. 1300 */ 1301 wantparent = cnp->cn_flags & (LOCKPARENT|WANTPARENT); 1302 KASSERT(wantparent, ("relookup: parent not wanted.")); 1303 rdonly = cnp->cn_flags & RDONLY; 1304 cnp->cn_flags &= ~ISSYMLINK; 1305 dp = dvp; 1306 cnp->cn_lkflags = LK_EXCLUSIVE; 1307 vn_lock(dp, LK_EXCLUSIVE | LK_RETRY); 1308 1309 /* 1310 * Search a new directory. 1311 * 1312 * The last component of the filename is left accessible via 1313 * cnp->cn_nameptr for callers that need the name. Callers needing 1314 * the name set the SAVENAME flag. When done, they assume 1315 * responsibility for freeing the pathname buffer. 1316 */ 1317 #ifdef NAMEI_DIAGNOSTIC 1318 printf("{%s}: ", cnp->cn_nameptr); 1319 #endif 1320 1321 /* 1322 * Check for "" which represents the root directory after slash 1323 * removal. 1324 */ 1325 if (cnp->cn_nameptr[0] == '\0') { 1326 /* 1327 * Support only LOOKUP for "/" because lookup() 1328 * can't succeed for CREATE, DELETE and RENAME. 1329 */ 1330 KASSERT(cnp->cn_nameiop == LOOKUP, ("nameiop must be LOOKUP")); 1331 KASSERT(dp->v_type == VDIR, ("dp is not a directory")); 1332 1333 if (!(cnp->cn_flags & LOCKLEAF)) 1334 VOP_UNLOCK(dp); 1335 *vpp = dp; 1336 /* XXX This should probably move to the top of function. */ 1337 if (cnp->cn_flags & SAVESTART) 1338 panic("lookup: SAVESTART"); 1339 return (0); 1340 } 1341 1342 if (cnp->cn_flags & ISDOTDOT) 1343 panic ("relookup: lookup on dot-dot"); 1344 1345 /* 1346 * We now have a segment name to search for, and a directory to search. 1347 */ 1348 #ifdef NAMEI_DIAGNOSTIC 1349 vn_printf(dp, "search in "); 1350 #endif 1351 if ((error = VOP_LOOKUP(dp, vpp, cnp)) != 0) { 1352 KASSERT(*vpp == NULL, ("leaf should be empty")); 1353 if (error != EJUSTRETURN) 1354 goto bad; 1355 /* 1356 * If creating and at end of pathname, then can consider 1357 * allowing file to be created. 1358 */ 1359 if (rdonly) { 1360 error = EROFS; 1361 goto bad; 1362 } 1363 /* ASSERT(dvp == ndp->ni_startdir) */ 1364 if (cnp->cn_flags & SAVESTART) 1365 VREF(dvp); 1366 if ((cnp->cn_flags & LOCKPARENT) == 0) 1367 VOP_UNLOCK(dp); 1368 /* 1369 * We return with ni_vp NULL to indicate that the entry 1370 * doesn't currently exist, leaving a pointer to the 1371 * (possibly locked) directory vnode in ndp->ni_dvp. 1372 */ 1373 return (0); 1374 } 1375 1376 dp = *vpp; 1377 1378 /* 1379 * Disallow directory write attempts on read-only filesystems. 1380 */ 1381 if (rdonly && 1382 (cnp->cn_nameiop == DELETE || cnp->cn_nameiop == RENAME)) { 1383 if (dvp == dp) 1384 vrele(dvp); 1385 else 1386 vput(dvp); 1387 error = EROFS; 1388 goto bad; 1389 } 1390 /* 1391 * Set the parent lock/ref state to the requested state. 1392 */ 1393 if ((cnp->cn_flags & LOCKPARENT) == 0 && dvp != dp) { 1394 if (wantparent) 1395 VOP_UNLOCK(dvp); 1396 else 1397 vput(dvp); 1398 } else if (!wantparent) 1399 vrele(dvp); 1400 /* 1401 * Check for symbolic link 1402 */ 1403 KASSERT(dp->v_type != VLNK || !(cnp->cn_flags & FOLLOW), 1404 ("relookup: symlink found.\n")); 1405 1406 /* ASSERT(dvp == ndp->ni_startdir) */ 1407 if (cnp->cn_flags & SAVESTART) 1408 VREF(dvp); 1409 1410 if ((cnp->cn_flags & LOCKLEAF) == 0) 1411 VOP_UNLOCK(dp); 1412 return (0); 1413 bad: 1414 vput(dp); 1415 *vpp = NULL; 1416 return (error); 1417 } 1418 1419 /* 1420 * Free data allocated by namei(); see namei(9) for details. 1421 */ 1422 void 1423 NDFREE_PNBUF(struct nameidata *ndp) 1424 { 1425 1426 if ((ndp->ni_cnd.cn_flags & HASBUF) != 0) { 1427 MPASS((ndp->ni_cnd.cn_flags & (SAVENAME | SAVESTART)) != 0); 1428 uma_zfree(namei_zone, ndp->ni_cnd.cn_pnbuf); 1429 ndp->ni_cnd.cn_flags &= ~HASBUF; 1430 } 1431 } 1432 1433 void 1434 (NDFREE)(struct nameidata *ndp, const u_int flags) 1435 { 1436 int unlock_dvp; 1437 int unlock_vp; 1438 1439 unlock_dvp = 0; 1440 unlock_vp = 0; 1441 1442 if (!(flags & NDF_NO_FREE_PNBUF)) { 1443 NDFREE_PNBUF(ndp); 1444 } 1445 if (!(flags & NDF_NO_VP_UNLOCK) && 1446 (ndp->ni_cnd.cn_flags & LOCKLEAF) && ndp->ni_vp) 1447 unlock_vp = 1; 1448 if (!(flags & NDF_NO_DVP_UNLOCK) && 1449 (ndp->ni_cnd.cn_flags & LOCKPARENT) && 1450 ndp->ni_dvp != ndp->ni_vp) 1451 unlock_dvp = 1; 1452 if (!(flags & NDF_NO_VP_RELE) && ndp->ni_vp) { 1453 if (unlock_vp) { 1454 vput(ndp->ni_vp); 1455 unlock_vp = 0; 1456 } else 1457 vrele(ndp->ni_vp); 1458 ndp->ni_vp = NULL; 1459 } 1460 if (unlock_vp) 1461 VOP_UNLOCK(ndp->ni_vp); 1462 if (!(flags & NDF_NO_DVP_RELE) && 1463 (ndp->ni_cnd.cn_flags & (LOCKPARENT|WANTPARENT))) { 1464 if (unlock_dvp) { 1465 vput(ndp->ni_dvp); 1466 unlock_dvp = 0; 1467 } else 1468 vrele(ndp->ni_dvp); 1469 ndp->ni_dvp = NULL; 1470 } 1471 if (unlock_dvp) 1472 VOP_UNLOCK(ndp->ni_dvp); 1473 if (!(flags & NDF_NO_STARTDIR_RELE) && 1474 (ndp->ni_cnd.cn_flags & SAVESTART)) { 1475 vrele(ndp->ni_startdir); 1476 ndp->ni_startdir = NULL; 1477 } 1478 } 1479 1480 #ifdef INVARIANTS 1481 /* 1482 * Validate the final state of ndp after the lookup. 1483 * 1484 * Historically filesystems were allowed to modify cn_flags. Most notably they 1485 * can add SAVENAME to the request, resulting in HASBUF and pushing subsequent 1486 * clean up to the consumer. In practice this seems to only concern != LOOKUP 1487 * operations. 1488 * 1489 * As a step towards stricter API contract this routine validates the state to 1490 * clean up. Note validation is a work in progress with the intent of becoming 1491 * stricter over time. 1492 */ 1493 #define NDMODIFYINGFLAGS (LOCKLEAF | LOCKPARENT | WANTPARENT | SAVENAME | SAVESTART | HASBUF) 1494 void 1495 NDVALIDATE(struct nameidata *ndp) 1496 { 1497 struct componentname *cnp; 1498 u_int64_t used, orig; 1499 1500 cnp = &ndp->ni_cnd; 1501 orig = cnp->cn_origflags; 1502 used = cnp->cn_flags; 1503 switch (cnp->cn_nameiop) { 1504 case LOOKUP: 1505 /* 1506 * For plain lookup we require strict conformance -- nothing 1507 * to clean up if it was not requested by the caller. 1508 */ 1509 orig &= NDMODIFYINGFLAGS; 1510 used &= NDMODIFYINGFLAGS; 1511 if ((orig & (SAVENAME | SAVESTART)) != 0) 1512 orig |= HASBUF; 1513 if (orig != used) { 1514 goto out_mismatch; 1515 } 1516 break; 1517 case CREATE: 1518 case DELETE: 1519 case RENAME: 1520 /* 1521 * Some filesystems set SAVENAME to provoke HASBUF, accomodate 1522 * for it until it gets fixed. 1523 */ 1524 orig &= NDMODIFYINGFLAGS; 1525 orig |= (SAVENAME | HASBUF); 1526 used &= NDMODIFYINGFLAGS; 1527 used |= (SAVENAME | HASBUF); 1528 if (orig != used) { 1529 goto out_mismatch; 1530 } 1531 break; 1532 } 1533 return; 1534 out_mismatch: 1535 panic("%s: mismatched flags for op %d: added %" PRIx64 ", " 1536 "removed %" PRIx64" (%" PRIx64" != %" PRIx64"; stored %" PRIx64" != %" PRIx64")", 1537 __func__, cnp->cn_nameiop, used & ~orig, orig &~ used, 1538 orig, used, cnp->cn_origflags, cnp->cn_flags); 1539 } 1540 #endif 1541 1542 /* 1543 * Determine if there is a suitable alternate filename under the specified 1544 * prefix for the specified path. If the create flag is set, then the 1545 * alternate prefix will be used so long as the parent directory exists. 1546 * This is used by the various compatibility ABIs so that Linux binaries prefer 1547 * files under /compat/linux for example. The chosen path (whether under 1548 * the prefix or under /) is returned in a kernel malloc'd buffer pointed 1549 * to by pathbuf. The caller is responsible for free'ing the buffer from 1550 * the M_TEMP bucket if one is returned. 1551 */ 1552 int 1553 kern_alternate_path(struct thread *td, const char *prefix, const char *path, 1554 enum uio_seg pathseg, char **pathbuf, int create, int dirfd) 1555 { 1556 struct nameidata nd, ndroot; 1557 char *ptr, *buf, *cp; 1558 size_t len, sz; 1559 int error; 1560 1561 buf = (char *) malloc(MAXPATHLEN, M_TEMP, M_WAITOK); 1562 *pathbuf = buf; 1563 1564 /* Copy the prefix into the new pathname as a starting point. */ 1565 len = strlcpy(buf, prefix, MAXPATHLEN); 1566 if (len >= MAXPATHLEN) { 1567 *pathbuf = NULL; 1568 free(buf, M_TEMP); 1569 return (EINVAL); 1570 } 1571 sz = MAXPATHLEN - len; 1572 ptr = buf + len; 1573 1574 /* Append the filename to the prefix. */ 1575 if (pathseg == UIO_SYSSPACE) 1576 error = copystr(path, ptr, sz, &len); 1577 else 1578 error = copyinstr(path, ptr, sz, &len); 1579 1580 if (error) { 1581 *pathbuf = NULL; 1582 free(buf, M_TEMP); 1583 return (error); 1584 } 1585 1586 /* Only use a prefix with absolute pathnames. */ 1587 if (*ptr != '/') { 1588 error = EINVAL; 1589 goto keeporig; 1590 } 1591 1592 if (dirfd != AT_FDCWD) { 1593 /* 1594 * We want the original because the "prefix" is 1595 * included in the already opened dirfd. 1596 */ 1597 bcopy(ptr, buf, len); 1598 return (0); 1599 } 1600 1601 /* 1602 * We know that there is a / somewhere in this pathname. 1603 * Search backwards for it, to find the file's parent dir 1604 * to see if it exists in the alternate tree. If it does, 1605 * and we want to create a file (cflag is set). We don't 1606 * need to worry about the root comparison in this case. 1607 */ 1608 1609 if (create) { 1610 for (cp = &ptr[len] - 1; *cp != '/'; cp--); 1611 *cp = '\0'; 1612 1613 NDINIT(&nd, LOOKUP, NOFOLLOW, UIO_SYSSPACE, buf, td); 1614 error = namei(&nd); 1615 *cp = '/'; 1616 if (error != 0) 1617 goto keeporig; 1618 } else { 1619 NDINIT(&nd, LOOKUP, NOFOLLOW, UIO_SYSSPACE, buf, td); 1620 1621 error = namei(&nd); 1622 if (error != 0) 1623 goto keeporig; 1624 1625 /* 1626 * We now compare the vnode of the prefix to the one 1627 * vnode asked. If they resolve to be the same, then we 1628 * ignore the match so that the real root gets used. 1629 * This avoids the problem of traversing "../.." to find the 1630 * root directory and never finding it, because "/" resolves 1631 * to the emulation root directory. This is expensive :-( 1632 */ 1633 NDINIT(&ndroot, LOOKUP, FOLLOW, UIO_SYSSPACE, prefix, 1634 td); 1635 1636 /* We shouldn't ever get an error from this namei(). */ 1637 error = namei(&ndroot); 1638 if (error == 0) { 1639 if (nd.ni_vp == ndroot.ni_vp) 1640 error = ENOENT; 1641 1642 NDFREE(&ndroot, NDF_ONLY_PNBUF); 1643 vrele(ndroot.ni_vp); 1644 } 1645 } 1646 1647 NDFREE(&nd, NDF_ONLY_PNBUF); 1648 vrele(nd.ni_vp); 1649 1650 keeporig: 1651 /* If there was an error, use the original path name. */ 1652 if (error) 1653 bcopy(ptr, buf, len); 1654 return (error); 1655 } 1656