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