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