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