sys/kern/vfs_lookup.c

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