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