sys/kern/vfs_nlookup.c

   1 /*
   2  * Copyright (c) 2004 The DragonFly Project.  All rights reserved.
   3  *
   4  * This code is derived from software contributed to The DragonFly Project
   5  * by Matthew Dillon <dillon@backplane.com>
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in
  15  *    the documentation and/or other materials provided with the
  16  *    distribution.
  17  * 3. Neither the name of The DragonFly Project nor the names of its
  18  *    contributors may be used to endorse or promote products derived
  19  *    from this software without specific, prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  * $DragonFly: src/sys/kern/vfs_nlookup.c,v 1.25 2008/07/19 04:43:33 dillon Exp $
  35  */
  36 /*
  37  * nlookup() is the 'new' namei interface.  Rather then return directory and
  38  * leaf vnodes (in various lock states) the new interface instead deals in
  39  * namecache records.  Namecache records may represent both a positive or
  40  * a negative hit.  The namespace is locked via the namecache record instead
  41  * of via the vnode, and only the leaf namecache record (representing the
  42  * filename) needs to be locked.
  43  *
  44  * This greatly improves filesystem parallelism and is a huge simplification
  45  * of the API verses the old vnode locking / namei scheme.
  46  *
  47  * Filesystems must actively control the caching aspects of the namecache,
  48  * and since namecache pointers are used as handles they are non-optional
  49  * even for filesystems which do not generally wish to cache things.  It is
  50  * intended that a separate cache coherency API will be constructed to handle
  51  * these issues.
  52  */
  53
  54 #include "opt_ktrace.h"
  55
  56 #include <sys/param.h>
  57 #include <sys/systm.h>
  58 #include <sys/kernel.h>
  59 #include <sys/vnode.h>
  60 #include <sys/mount.h>
  61 #include <sys/filedesc.h>
  62 #include <sys/proc.h>
  63 #include <sys/namei.h>
  64 #include <sys/nlookup.h>
  65 #include <sys/malloc.h>
  66 #include <sys/stat.h>
  67 #include <sys/objcache.h>
  68 #include <sys/file.h>
  69
  70 #ifdef KTRACE
  71 #include <sys/ktrace.h>
  72 #endif
  73
  74 static int naccess(struct nchandle *nch, int vmode, struct ucred *cred,
  75                 int *stickyp);
  76
  77 /*
  78  * Initialize a nlookup() structure, early error return for copyin faults
  79  * or a degenerate empty string (which is not allowed).
  80  *
  81  * The first process proc0's credentials are used if the calling thread
  82  * is not associated with a process context.
  83  *
  84  * MPSAFE
  85  */
  86 int
  87 nlookup_init(struct nlookupdata *nd,
  88              const char *path, enum uio_seg seg, int flags)
  89 {
  90     size_t pathlen;
  91     struct proc *p;
  92     thread_t td;
  93     int error;
  94
  95     td = curthread;
  96     p = td->td_proc;
  97
  98     /*
  99      * note: the pathlen set by copy*str() includes the terminating \0.
 100      */
 101     bzero(nd, sizeof(struct nlookupdata));
 102     nd->nl_path = objcache_get(namei_oc, M_WAITOK);
 103     nd->nl_flags |= NLC_HASBUF;
 104     if (seg == UIO_SYSSPACE)
 105         error = copystr(path, nd->nl_path, MAXPATHLEN, &pathlen);
 106     else
 107         error = copyinstr(path, nd->nl_path, MAXPATHLEN, &pathlen);
 108
 109     /*
 110      * Don't allow empty pathnames.
 111      * POSIX.1 requirement: "" is not a vaild file name.
 112      */
 113     if (error == 0 && pathlen <= 1)
 114         error = ENOENT;
 115
 116     if (error == 0) {
 117         if (p && p->p_fd) {
 118             cache_copy(&p->p_fd->fd_ncdir, &nd->nl_nch);
 119             cache_copy(&p->p_fd->fd_nrdir, &nd->nl_rootnch);
 120             if (p->p_fd->fd_njdir.ncp)
 121                 cache_copy(&p->p_fd->fd_njdir, &nd->nl_jailnch);
 122             nd->nl_cred = crhold(p->p_ucred);
 123         } else {
 124             cache_copy(&rootnch, &nd->nl_nch);
 125             cache_copy(&nd->nl_nch, &nd->nl_rootnch);
 126             cache_copy(&nd->nl_nch, &nd->nl_jailnch);
 127             nd->nl_cred = crhold(proc0.p_ucred);
 128         }
 129         nd->nl_td = td;
 130         nd->nl_flags |= flags;
 131     } else {
 132         nlookup_done(nd);
 133     }
 134     return(error);
 135 }
 136
 137
 138 /*
 139  * nlookup_init() for "at" family of syscalls.
 140  *
 141  * Works similarly to nlookup_init() but if path is relative and fd is not
 142  * AT_FDCWD, path is interpreted relative to the directory pointed to by fd.
 143  * In this case, the file entry pointed to by fd is ref'ed and returned in
 144  * *fpp.
 145  *
 146  * If the call succeeds, nlookup_done_at() must be called to clean-up the nd
 147  * and release the ref to the file entry.
 148  */
 149 int
 150 nlookup_init_at(struct nlookupdata *nd, struct file **fpp, int fd,
 151                 const char *path, enum uio_seg seg, int flags)
 152 {
 153         struct thread *td = curthread;
 154         struct proc *p = td->td_proc;
 155         struct file* fp;
 156         struct vnode *vp;
 157         int error;
 158
 159         *fpp = NULL;
 160
 161         if  ((error = nlookup_init(nd, path, seg, flags)) != 0) {
 162                 return (error);
 163         }
 164
 165         if (nd->nl_path[0] != '/' && fd != AT_FDCWD) {
 166                 if ((error = holdvnode(p->p_fd, fd, &fp)) != 0)
 167                         goto done;
 168                 vp = (struct vnode*)fp->f_data;
 169                 if (vp->v_type != VDIR || fp->f_nchandle.ncp == NULL) {
 170                         fdrop(fp);
 171                         fp = NULL;
 172                         error = ENOTDIR;
 173                         goto done;
 174                 }
 175                 cache_drop(&nd->nl_nch);
 176                 cache_copy(&fp->f_nchandle, &nd->nl_nch);
 177                 *fpp = fp;
 178         }
 179
 180
 181 done:
 182         if (error)
 183                 nlookup_done(nd);
 184         return (error);
 185
 186 }
 187
 188 /*
 189  * This works similarly to nlookup_init() but does not assume a process
 190  * context.  rootnch is always chosen for the root directory and the cred
 191  * and starting directory are supplied in arguments.
 192  */
 193 int
 194 nlookup_init_raw(struct nlookupdata *nd,
 195              const char *path, enum uio_seg seg, int flags,
 196              struct ucred *cred, struct nchandle *ncstart)
 197 {
 198     size_t pathlen;
 199     thread_t td;
 200     int error;
 201
 202     td = curthread;
 203
 204     bzero(nd, sizeof(struct nlookupdata));
 205     nd->nl_path = objcache_get(namei_oc, M_WAITOK);
 206     nd->nl_flags |= NLC_HASBUF;
 207     if (seg == UIO_SYSSPACE)
 208         error = copystr(path, nd->nl_path, MAXPATHLEN, &pathlen);
 209     else
 210         error = copyinstr(path, nd->nl_path, MAXPATHLEN, &pathlen);
 211
 212     /*
 213      * Don't allow empty pathnames.
 214      * POSIX.1 requirement: "" is not a vaild file name.
 215      */
 216     if (error == 0 && pathlen <= 1)
 217         error = ENOENT;
 218
 219     if (error == 0) {
 220         cache_copy(ncstart, &nd->nl_nch);
 221         cache_copy(&rootnch, &nd->nl_rootnch);
 222         cache_copy(&rootnch, &nd->nl_jailnch);
 223         nd->nl_cred = crhold(cred);
 224         nd->nl_td = td;
 225         nd->nl_flags |= flags;
 226     } else {
 227         nlookup_done(nd);
 228     }
 229     return(error);
 230 }
 231
 232 /*
 233  * This works similarly to nlookup_init_raw() but does not rely
 234  * on rootnch being initialized yet.
 235  */
 236 int
 237 nlookup_init_root(struct nlookupdata *nd,
 238              const char *path, enum uio_seg seg, int flags,
 239              struct ucred *cred, struct nchandle *ncstart,
 240              struct nchandle *ncroot)
 241 {
 242     size_t pathlen;
 243     thread_t td;
 244     int error;
 245
 246     td = curthread;
 247
 248     bzero(nd, sizeof(struct nlookupdata));
 249     nd->nl_path = objcache_get(namei_oc, M_WAITOK);
 250     nd->nl_flags |= NLC_HASBUF;
 251     if (seg == UIO_SYSSPACE)
 252         error = copystr(path, nd->nl_path, MAXPATHLEN, &pathlen);
 253     else
 254         error = copyinstr(path, nd->nl_path, MAXPATHLEN, &pathlen);
 255
 256     /*
 257      * Don't allow empty pathnames.
 258      * POSIX.1 requirement: "" is not a vaild file name.
 259      */
 260     if (error == 0 && pathlen <= 1)
 261         error = ENOENT;
 262
 263     if (error == 0) {
 264         cache_copy(ncstart, &nd->nl_nch);
 265         cache_copy(ncroot, &nd->nl_rootnch);
 266         cache_copy(ncroot, &nd->nl_jailnch);
 267         nd->nl_cred = crhold(cred);
 268         nd->nl_td = td;
 269         nd->nl_flags |= flags;
 270     } else {
 271         nlookup_done(nd);
 272     }
 273     return(error);
 274 }
 275
 276 /*
 277  * Set a different credential; this credential will be used by future
 278  * operations performed on nd.nl_open_vp and nlookupdata structure.
 279  */
 280 void
 281 nlookup_set_cred(struct nlookupdata *nd, struct ucred *cred)
 282 {
 283         KKASSERT(nd->nl_cred != NULL);
 284
 285         if (nd->nl_cred != cred) {
 286                 cred = crhold(cred);
 287                 crfree(nd->nl_cred);
 288                 nd->nl_cred = cred;
 289         }
 290 }
 291
 292 /*
 293  * Cleanup a nlookupdata structure after we are through with it.  This may
 294  * be called on any nlookupdata structure initialized with nlookup_init().
 295  * Calling nlookup_done() is mandatory in all cases except where nlookup_init()
 296  * returns an error, even if as a consumer you believe you have taken all
 297  * dynamic elements out of the nlookupdata structure.
 298  */
 299 void
 300 nlookup_done(struct nlookupdata *nd)
 301 {
 302     if (nd->nl_nch.ncp) {
 303         if (nd->nl_flags & NLC_NCPISLOCKED) {
 304             nd->nl_flags &= ~NLC_NCPISLOCKED;
 305             cache_unlock(&nd->nl_nch);
 306         }
 307         cache_drop(&nd->nl_nch);        /* NULL's out the nch */
 308     }
 309     if (nd->nl_rootnch.ncp)
 310         cache_drop(&nd->nl_rootnch);
 311     if (nd->nl_jailnch.ncp)
 312         cache_drop(&nd->nl_jailnch);
 313     if ((nd->nl_flags & NLC_HASBUF) && nd->nl_path) {
 314         objcache_put(namei_oc, nd->nl_path);
 315         nd->nl_path = NULL;
 316     }
 317     if (nd->nl_cred) {
 318         crfree(nd->nl_cred);
 319         nd->nl_cred = NULL;
 320     }
 321     if (nd->nl_open_vp) {
 322         if (nd->nl_flags & NLC_LOCKVP) {
 323                 vn_unlock(nd->nl_open_vp);
 324                 nd->nl_flags &= ~NLC_LOCKVP;
 325         }
 326         vn_close(nd->nl_open_vp, nd->nl_vp_fmode);
 327         nd->nl_open_vp = NULL;
 328     }
 329     if (nd->nl_dvp) {
 330         vrele(nd->nl_dvp);
 331         nd->nl_dvp = NULL;
 332     }
 333     nd->nl_flags = 0;   /* clear remaining flags (just clear everything) */
 334 }
 335
 336 /*
 337  * Works similarly to nlookup_done() when nd initialized with
 338  * nlookup_init_at().
 339  */
 340 void
 341 nlookup_done_at(struct nlookupdata *nd, struct file *fp)
 342 {
 343         nlookup_done(nd);
 344         if (fp != NULL)
 345                 fdrop(fp);
 346 }
 347
 348 void
 349 nlookup_zero(struct nlookupdata *nd)
 350 {
 351         bzero(nd, sizeof(struct nlookupdata));
 352 }
 353
 354 /*
 355  * Simple all-in-one nlookup.  Returns a locked namecache structure or NULL
 356  * if an error occured.
 357  *
 358  * Note that the returned ncp is not checked for permissions, though VEXEC
 359  * is checked on the directory path leading up to the result.  The caller
 360  * must call naccess() to check the permissions of the returned leaf.
 361  */
 362 struct nchandle
 363 nlookup_simple(const char *str, enum uio_seg seg,
 364                int niflags, int *error)
 365 {
 366     struct nlookupdata nd;
 367     struct nchandle nch;
 368
 369     *error = nlookup_init(&nd, str, seg, niflags);
 370     if (*error == 0) {
 371             if ((*error = nlookup(&nd)) == 0) {
 372                     nch = nd.nl_nch;    /* keep hold ref from structure */
 373                     cache_zero(&nd.nl_nch); /* and NULL out */
 374             } else {
 375                     cache_zero(&nch);
 376             }
 377             nlookup_done(&nd);
 378     } else {
 379             cache_zero(&nch);
 380     }
 381     return(nch);
 382 }
 383
 384 /*
 385  * Do a generic nlookup.  Note that the passed nd is not nlookup_done()'d
 386  * on return, even if an error occurs.  If no error occurs the returned
 387  * nl_nch is always referenced and locked, otherwise it may or may not be.
 388  *
 389  * Intermediate directory elements, including the current directory, require
 390  * execute (search) permission.  nlookup does not examine the access
 391  * permissions on the returned element.
 392  *
 393  * If NLC_CREATE is set the last directory must allow node creation,
 394  * and an error code of 0 will be returned for a non-existant
 395  * target (not ENOENT).
 396  *
 397  * If NLC_RENAME_DST is set the last directory mut allow node deletion,
 398  * plus the sticky check is made, and an error code of 0 will be returned
 399  * for a non-existant target (not ENOENT).
 400  *
 401  * If NLC_DELETE is set the last directory mut allow node deletion,
 402  * plus the sticky check is made.
 403  *
 404  * If NLC_REFDVP is set nd->nl_dvp will be set to the directory vnode
 405  * of the returned entry.  The vnode will be referenced, but not locked,
 406  * and will be released by nlookup_done() along with everything else.
 407  */
 408 int
 409 nlookup(struct nlookupdata *nd)
 410 {
 411     globaldata_t gd = mycpu;
 412     struct nlcomponent nlc;
 413     struct nchandle nch;
 414     struct nchandle par;
 415     struct nchandle nctmp;
 416     struct mount *mp;
 417     int wasdotordotdot;
 418     char *ptr;
 419     char *xptr;
 420     int error;
 421     int len;
 422     int dflags;
 423     int hit = 1;
 424
 425 #ifdef KTRACE
 426     if (KTRPOINT(nd->nl_td, KTR_NAMEI))
 427         ktrnamei(nd->nl_td->td_lwp, nd->nl_path);
 428 #endif
 429     bzero(&nlc, sizeof(nlc));
 430
 431     /*
 432      * Setup for the loop.  The current working namecache element is
 433      * always at least referenced.  We lock it as required, but always
 434      * return a locked, resolved namecache entry.
 435      */
 436     nd->nl_loopcnt = 0;
 437     if (nd->nl_dvp) {
 438         vrele(nd->nl_dvp);
 439         nd->nl_dvp = NULL;
 440     }
 441     ptr = nd->nl_path;
 442
 443     /*
 444      * Loop on the path components.  At the top of the loop nd->nl_nch
 445      * is ref'd and unlocked and represents our current position.
 446      */
 447     for (;;) {
 448         /*
 449          * Make sure nl_nch is locked so we can access the vnode, resolution
 450          * state, etc.
 451          */
 452         if ((nd->nl_flags & NLC_NCPISLOCKED) == 0) {
 453                 nd->nl_flags |= NLC_NCPISLOCKED;
 454                 cache_lock(&nd->nl_nch);
 455         }
 456
 457         /*
 458          * Check if the root directory should replace the current
 459          * directory.  This is done at the start of a translation
 460          * or after a symbolic link has been found.  In other cases
 461          * ptr will never be pointing at a '/'.
 462          */
 463         if (*ptr == '/') {
 464             do {
 465                 ++ptr;
 466             } while (*ptr == '/');
 467             cache_get(&nd->nl_rootnch, &nch);
 468             cache_put(&nd->nl_nch);
 469             nd->nl_nch = nch;           /* remains locked */
 470
 471             /*
 472              * Fast-track termination.  There is no parent directory of
 473              * the root in the same mount from the point of view of
 474              * the caller so return EPERM if NLC_REFDVP is specified.
 475              * e.g. 'rmdir /' is not allowed.
 476              */
 477             if (*ptr == 0) {
 478                 if (nd->nl_flags & NLC_REFDVP)
 479                         error = EPERM;
 480                 else
 481                         error = 0;
 482                 break;
 483             }
 484             continue;
 485         }
 486
 487         /*
 488          * Check directory search permissions.
 489          */
 490         dflags = 0;
 491         error = naccess(&nd->nl_nch, NLC_EXEC, nd->nl_cred, &dflags);
 492         if (error)
 493             break;
 494
 495         /*
 496          * Extract the path component.  Path components are limited to
 497          * 255 characters.
 498          */
 499         nlc.nlc_nameptr = ptr;
 500         while (*ptr && *ptr != '/')
 501             ++ptr;
 502         nlc.nlc_namelen = ptr - nlc.nlc_nameptr;
 503         if (nlc.nlc_namelen >= 256) {
 504             error = ENAMETOOLONG;
 505             break;
 506         }
 507
 508         /*
 509          * Lookup the path component in the cache, creating an unresolved
 510          * entry if necessary.  We have to handle "." and ".." as special
 511          * cases.
 512          *
 513          * When handling ".." we have to detect a traversal back through a
 514          * mount point.   If we are at the root, ".." just returns the root.
 515          *
 516          * When handling "." or ".." we also have to recalculate dflags
 517          * since our dflags will be for some sub-directory instead of the
 518          * parent dir.
 519          *
 520          * This subsection returns a locked, refd 'nch' unless it errors out.
 521          * The namecache topology is not allowed to be disconnected, so
 522          * encountering a NULL parent will generate EINVAL.  This typically
 523          * occurs when a directory is removed out from under a process.
 524          */
 525         if (nlc.nlc_namelen == 1 && nlc.nlc_nameptr[0] == '.') {
 526             cache_get(&nd->nl_nch, &nch);
 527             wasdotordotdot = 1;
 528         } else if (nlc.nlc_namelen == 2 &&
 529                    nlc.nlc_nameptr[0] == '.' && nlc.nlc_nameptr[1] == '.') {
 530             if (nd->nl_nch.mount == nd->nl_rootnch.mount &&
 531                 nd->nl_nch.ncp == nd->nl_rootnch.ncp
 532             ) {
 533                 /*
 534                  * ".." at the root returns the root
 535                  */
 536                 cache_get(&nd->nl_nch, &nch);
 537             } else {
 538                 /*
 539                  * Locate the parent ncp.  If we are at the root of a
 540                  * filesystem mount we have to skip to the mounted-on
 541                  * point in the underlying filesystem.
 542                  *
 543                  * Expect the parent to always be good since the
 544                  * mountpoint doesn't go away.  XXX hack.  cache_get()
 545                  * requires the ncp to already have a ref as a safety.
 546                  */
 547                 nctmp = nd->nl_nch;
 548                 while (nctmp.ncp == nctmp.mount->mnt_ncmountpt.ncp)
 549                         nctmp = nctmp.mount->mnt_ncmounton;
 550                 nctmp.ncp = nctmp.ncp->nc_parent;
 551                 KKASSERT(nctmp.ncp != NULL);
 552                 cache_hold(&nctmp);
 553                 cache_get(&nctmp, &nch);
 554                 cache_drop(&nctmp);             /* NOTE: zero's nctmp */
 555             }
 556             wasdotordotdot = 2;
 557         } else {
 558             /*
 559              * Must unlock nl_nch when traversing down the path.
 560              */
 561             cache_unlock(&nd->nl_nch);
 562             nd->nl_flags &= ~NLC_NCPISLOCKED;
 563             nch = cache_nlookup(&nd->nl_nch, &nlc);
 564             if (nch.ncp->nc_flag & NCF_UNRESOLVED)
 565                 hit = 0;
 566             while ((error = cache_resolve(&nch, nd->nl_cred)) == EAGAIN) {
 567                 kprintf("[diagnostic] nlookup: relookup %*.*s\n",
 568                         nch.ncp->nc_nlen, nch.ncp->nc_nlen, nch.ncp->nc_name);
 569                 cache_put(&nch);
 570                 nch = cache_nlookup(&nd->nl_nch, &nlc);
 571             }
 572             wasdotordotdot = 0;
 573         }
 574
 575         /*
 576          * If the last component was "." or ".." our dflags no longer
 577          * represents the parent directory and we have to explicitly
 578          * look it up.
 579          *
 580          * Expect the parent to be good since nch is locked.
 581          */
 582         if (wasdotordotdot && error == 0) {
 583             dflags = 0;
 584             if ((par.ncp = nch.ncp->nc_parent) != NULL) {
 585                 par.mount = nch.mount;
 586                 cache_hold(&par);
 587                 cache_lock(&par);
 588                 error = naccess(&par, 0, nd->nl_cred, &dflags);
 589                 cache_put(&par);
 590             }
 591         }
 592         if (nd->nl_flags & NLC_NCPISLOCKED) {
 593             cache_unlock(&nd->nl_nch);
 594             nd->nl_flags &= ~NLC_NCPISLOCKED;
 595         }
 596
 597         /*
 598          * [end of subsection]
 599          *
 600          * nch is locked and referenced.
 601          * nd->nl_nch is unlocked and referenced.
 602          *
 603          * nl_nch must be unlocked or we could chain lock to the root
 604          * if a resolve gets stuck (e.g. in NFS).
 605          */
 606
 607         /*
 608          * Resolve the namespace if necessary.  The ncp returned by
 609          * cache_nlookup() is referenced and locked.
 610          *
 611          * XXX neither '.' nor '..' should return EAGAIN since they were
 612          * previously resolved and thus cannot be newly created ncp's.
 613          */
 614         if (nch.ncp->nc_flag & NCF_UNRESOLVED) {
 615             hit = 0;
 616             error = cache_resolve(&nch, nd->nl_cred);
 617             KKASSERT(error != EAGAIN);
 618         } else {
 619             error = nch.ncp->nc_error;
 620         }
 621
 622         /*
 623          * Early completion.  ENOENT is not an error if this is the last
 624          * component and NLC_CREATE or NLC_RENAME (rename target) was
 625          * requested.  Note that ncp->nc_error is left as ENOENT in that
 626          * case, which we check later on.
 627          *
 628          * Also handle invalid '.' or '..' components terminating a path
 629          * for a create/rename/delete.  The standard requires this and pax
 630          * pretty stupidly depends on it.
 631          */
 632         for (xptr = ptr; *xptr == '/'; ++xptr)
 633                 ;
 634         if (*xptr == 0) {
 635             if (error == ENOENT &&
 636                 (nd->nl_flags & (NLC_CREATE | NLC_RENAME_DST))
 637             ) {
 638                 if (nd->nl_flags & NLC_NFS_RDONLY) {
 639                         error = EROFS;
 640                 } else {
 641                         error = naccess(&nch, nd->nl_flags | dflags,
 642                                         nd->nl_cred, NULL);
 643                 }
 644             }
 645             if (error == 0 && wasdotordotdot &&
 646                 (nd->nl_flags & (NLC_CREATE | NLC_DELETE |
 647                                  NLC_RENAME_SRC | NLC_RENAME_DST))) {
 648                 /*
 649                  * POSIX junk
 650                  */
 651                 if (nd->nl_flags & NLC_CREATE)
 652                         error = EEXIST;
 653                 else if (nd->nl_flags & NLC_DELETE)
 654                         error = (wasdotordotdot == 1) ? EINVAL : ENOTEMPTY;
 655                 else
 656                         error = EINVAL;
 657             }
 658         }
 659
 660         /*
 661          * Early completion on error.
 662          */
 663         if (error) {
 664             cache_put(&nch);
 665             break;
 666         }
 667
 668         /*
 669          * If the element is a symlink and it is either not the last
 670          * element or it is the last element and we are allowed to
 671          * follow symlinks, resolve the symlink.
 672          */
 673         if ((nch.ncp->nc_flag & NCF_ISSYMLINK) &&
 674             (*ptr || (nd->nl_flags & NLC_FOLLOW))
 675         ) {
 676             if (nd->nl_loopcnt++ >= MAXSYMLINKS) {
 677                 error = ELOOP;
 678                 cache_put(&nch);
 679                 break;
 680             }
 681             error = nreadsymlink(nd, &nch, &nlc);
 682             cache_put(&nch);
 683             if (error)
 684                 break;
 685
 686             /*
 687              * Concatenate trailing path elements onto the returned symlink.
 688              * Note that if the path component (ptr) is not exhausted, it
 689              * will being with a '/', so we do not have to add another one.
 690              *
 691              * The symlink may not be empty.
 692              */
 693             len = strlen(ptr);
 694             if (nlc.nlc_namelen == 0 || nlc.nlc_namelen + len >= MAXPATHLEN) {
 695                 error = nlc.nlc_namelen ? ENAMETOOLONG : ENOENT;
 696                 objcache_put(namei_oc, nlc.nlc_nameptr);
 697                 break;
 698             }
 699             bcopy(ptr, nlc.nlc_nameptr + nlc.nlc_namelen, len + 1);
 700             if (nd->nl_flags & NLC_HASBUF)
 701                 objcache_put(namei_oc, nd->nl_path);
 702             nd->nl_path = nlc.nlc_nameptr;
 703             nd->nl_flags |= NLC_HASBUF;
 704             ptr = nd->nl_path;
 705
 706             /*
 707              * Go back up to the top to resolve any initial '/'s in the
 708              * symlink.
 709              */
 710             continue;
 711         }
 712
 713         /*
 714          * If the element is a directory and we are crossing a mount point,
 715          * Locate the mount.
 716          */
 717         while ((nch.ncp->nc_flag & NCF_ISMOUNTPT) &&
 718             (nd->nl_flags & NLC_NOCROSSMOUNT) == 0 &&
 719             (mp = cache_findmount(&nch)) != NULL
 720         ) {
 721             struct vnode *tdp;
 722
 723             cache_put(&nch);
 724             cache_get(&mp->mnt_ncmountpt, &nch);
 725
 726             if (nch.ncp->nc_flag & NCF_UNRESOLVED) {
 727                 while (vfs_busy(mp, 0))
 728                     ;
 729                 error = VFS_ROOT(mp, &tdp);
 730                 vfs_unbusy(mp);
 731                 if (error)
 732                     break;
 733                 cache_setvp(&nch, tdp);
 734                 vput(tdp);
 735             }
 736         }
 737         if (error) {
 738             cache_put(&nch);
 739             break;
 740         }
 741
 742         /*
 743          * Skip any slashes to get to the next element.  If there
 744          * are any slashes at all the current element must be a
 745          * directory or, in the create case, intended to become a directory.
 746          * If it isn't we break without incrementing ptr and fall through
 747          * to the failure case below.
 748          */
 749         while (*ptr == '/') {
 750             if ((nch.ncp->nc_flag & NCF_ISDIR) == 0 &&
 751                 !(nd->nl_flags & NLC_WILLBEDIR)
 752             ) {
 753                 break;
 754             }
 755             ++ptr;
 756         }
 757
 758         /*
 759          * Continuation case: additional elements and the current
 760          * element is a directory.
 761          */
 762         if (*ptr && (nch.ncp->nc_flag & NCF_ISDIR)) {
 763             cache_drop(&nd->nl_nch);
 764             cache_unlock(&nch);
 765             KKASSERT((nd->nl_flags & NLC_NCPISLOCKED) == 0);
 766             nd->nl_nch = nch;
 767             continue;
 768         }
 769
 770         /*
 771          * Failure case: additional elements and the current element
 772          * is not a directory
 773          */
 774         if (*ptr) {
 775             cache_put(&nch);
 776             error = ENOTDIR;
 777             break;
 778         }
 779
 780         /*
 781          * Successful lookup of last element.
 782          *
 783          * Check permissions if the target exists.  If the target does not
 784          * exist directory permissions were already tested in the early
 785          * completion code above.
 786          *
 787          * nd->nl_flags will be adjusted on return with NLC_APPENDONLY
 788          * if the file is marked append-only, and NLC_STICKY if the directory
 789          * containing the file is sticky.
 790          */
 791         if (nch.ncp->nc_vp && (nd->nl_flags & NLC_ALLCHKS)) {
 792             error = naccess(&nch, nd->nl_flags | dflags,
 793                             nd->nl_cred, NULL);
 794             if (error) {
 795                 cache_put(&nch);
 796                 break;
 797             }
 798         }
 799
 800         /*
 801          * Termination: no more elements.
 802          *
 803          * If NLC_REFDVP is set acquire a referenced parent dvp.
 804          */
 805         if (nd->nl_flags & NLC_REFDVP) {
 806                 cache_lock(&nd->nl_nch);
 807                 error = cache_vref(&nd->nl_nch, nd->nl_cred, &nd->nl_dvp);
 808                 cache_unlock(&nd->nl_nch);
 809                 if (error) {
 810                         kprintf("NLC_REFDVP: Cannot ref dvp of %p\n", nch.ncp);
 811                         cache_put(&nch);
 812                         break;
 813                 }
 814         }
 815         cache_drop(&nd->nl_nch);
 816         nd->nl_nch = nch;
 817         nd->nl_flags |= NLC_NCPISLOCKED;
 818         error = 0;
 819         break;
 820     }
 821
 822     if (hit)
 823             ++gd->gd_nchstats->ncs_longhits;
 824     else
 825             ++gd->gd_nchstats->ncs_longmiss;
 826
 827     /*
 828      * NOTE: If NLC_CREATE was set the ncp may represent a negative hit
 829      * (ncp->nc_error will be ENOENT), but we will still return an error
 830      * code of 0.
 831      */
 832     return(error);
 833 }
 834
 835 /*
 836  * Resolve a mount point's glue ncp.  This ncp connects creates the illusion
 837  * of continuity in the namecache tree by connecting the ncp related to the
 838  * vnode under the mount to the ncp related to the mount's root vnode.
 839  *
 840  * If no error occured a locked, ref'd ncp is stored in *ncpp.
 841  */
 842 int
 843 nlookup_mp(struct mount *mp, struct nchandle *nch)
 844 {
 845     struct vnode *vp;
 846     int error;
 847
 848     error = 0;
 849     cache_get(&mp->mnt_ncmountpt, nch);
 850     if (nch->ncp->nc_flag & NCF_UNRESOLVED) {
 851         while (vfs_busy(mp, 0))
 852             ;
 853         error = VFS_ROOT(mp, &vp);
 854         vfs_unbusy(mp);
 855         if (error) {
 856             cache_put(nch);
 857         } else {
 858             cache_setvp(nch, vp);
 859             vput(vp);
 860         }
 861     }
 862     return(error);
 863 }
 864
 865 /*
 866  * Read the contents of a symlink, allocate a path buffer out of the
 867  * namei_oc and initialize the supplied nlcomponent with the result.
 868  *
 869  * If an error occurs no buffer will be allocated or returned in the nlc.
 870  */
 871 int
 872 nreadsymlink(struct nlookupdata *nd, struct nchandle *nch,
 873                 struct nlcomponent *nlc)
 874 {
 875     struct vnode *vp;
 876     struct iovec aiov;
 877     struct uio auio;
 878     int linklen;
 879     int error;
 880     char *cp;
 881
 882     nlc->nlc_nameptr = NULL;
 883     nlc->nlc_namelen = 0;
 884     if (nch->ncp->nc_vp == NULL)
 885         return(ENOENT);
 886     if ((error = cache_vget(nch, nd->nl_cred, LK_SHARED, &vp)) != 0)
 887         return(error);
 888     cp = objcache_get(namei_oc, M_WAITOK);
 889     aiov.iov_base = cp;
 890     aiov.iov_len = MAXPATHLEN;
 891     auio.uio_iov = &aiov;
 892     auio.uio_iovcnt = 1;
 893     auio.uio_offset = 0;
 894     auio.uio_rw = UIO_READ;
 895     auio.uio_segflg = UIO_SYSSPACE;
 896     auio.uio_td = nd->nl_td;
 897     auio.uio_resid = MAXPATHLEN - 1;
 898     error = VOP_READLINK(vp, &auio, nd->nl_cred);
 899     if (error)
 900         goto fail;
 901     linklen = MAXPATHLEN - 1 - auio.uio_resid;
 902     if (varsym_enable) {
 903         linklen = varsymreplace(cp, linklen, MAXPATHLEN - 1);
 904         if (linklen < 0) {
 905             error = ENAMETOOLONG;
 906             goto fail;
 907         }
 908     }
 909     cp[linklen] = 0;
 910     nlc->nlc_nameptr = cp;
 911     nlc->nlc_namelen = linklen;
 912     vput(vp);
 913     return(0);
 914 fail:
 915     objcache_put(namei_oc, cp);
 916     vput(vp);
 917     return(error);
 918 }
 919
 920 /*
 921  * Check access [XXX cache vattr!] [XXX quota]
 922  *
 923  * Generally check the NLC_* access bits.   All specified bits must pass
 924  * for this function to return 0.
 925  *
 926  * The file does not have to exist when checking NLC_CREATE or NLC_RENAME_DST
 927  * access, otherwise it must exist.  No error is returned in this case.
 928  *
 929  * The file must not exist if NLC_EXCL is specified.
 930  *
 931  * Directory permissions in general are tested for NLC_CREATE if the file
 932  * does not exist, NLC_DELETE if the file does exist, and NLC_RENAME_DST
 933  * whether the file exists or not.
 934  *
 935  * The directory sticky bit is tested for NLC_DELETE and NLC_RENAME_DST,
 936  * the latter is only tested if the target exists.
 937  *
 938  * The passed ncp must be referenced and locked.
 939  */
 940 int
 941 naccess(struct nchandle *nch, int nflags, struct ucred *cred, int *nflagsp)
 942 {
 943     struct vnode *vp;
 944     struct vattr va;
 945     struct namecache *ncp;
 946     int error;
 947     int cflags;
 948
 949     ASSERT_NCH_LOCKED(nch);
 950     ncp = nch->ncp;
 951     if (ncp->nc_flag & NCF_UNRESOLVED) {
 952         cache_resolve(nch, cred);
 953         ncp = nch->ncp;
 954     }
 955     error = ncp->nc_error;
 956
 957     /*
 958      * Directory permissions checks.  Silently ignore ENOENT if these
 959      * tests pass.  It isn't an error.
 960      *
 961      * We can safely resolve ncp->nc_parent because ncp is currently
 962      * locked.
 963      */
 964     if (nflags & (NLC_CREATE | NLC_DELETE | NLC_RENAME_SRC | NLC_RENAME_DST)) {
 965         if (((nflags & NLC_CREATE) && ncp->nc_vp == NULL) ||
 966             ((nflags & NLC_DELETE) && ncp->nc_vp != NULL) ||
 967             ((nflags & NLC_RENAME_SRC) && ncp->nc_vp != NULL) ||
 968             (nflags & NLC_RENAME_DST)
 969         ) {
 970             struct nchandle par;
 971
 972             if ((par.ncp = ncp->nc_parent) == NULL) {
 973                 if (error != EAGAIN)
 974                         error = EINVAL;
 975             } else if (error == 0 || error == ENOENT) {
 976                 par.mount = nch->mount;
 977                 cache_hold(&par);
 978                 cache_lock(&par);
 979                 error = naccess(&par, NLC_WRITE, cred, NULL);
 980                 cache_put(&par);
 981             }
 982         }
 983     }
 984
 985     /*
 986      * NLC_EXCL check.  Target file must not exist.
 987      */
 988     if (error == 0 && (nflags & NLC_EXCL) && ncp->nc_vp != NULL)
 989         error = EEXIST;
 990
 991     /*
 992      * Get the vnode attributes so we can do the rest of our checks.
 993      *
 994      * NOTE: We only call naccess_va() if the target exists.
 995      */
 996     if (error == 0) {
 997         error = cache_vget(nch, cred, LK_SHARED, &vp);
 998         if (error == ENOENT) {
 999             /*
1000              * Silently zero-out ENOENT if creating or renaming
1001              * (rename target).  It isn't an error.
1002              */
1003             if (nflags & (NLC_CREATE | NLC_RENAME_DST))
1004                 error = 0;
1005         } else if (error == 0) {
1006             /*
1007              * Get the vnode attributes and check for illegal O_TRUNC
1008              * requests and read-only mounts.
1009              *
1010              * NOTE: You can still open devices on read-only mounts for
1011              *       writing.
1012              *
1013              * NOTE: creates/deletes/renames are handled by the NLC_WRITE
1014              *       check on the parent directory above.
1015              *
1016              * XXX cache the va in the namecache or in the vnode
1017              */
1018             error = VOP_GETATTR(vp, &va);
1019             if (error == 0 && (nflags & NLC_TRUNCATE)) {
1020                 switch(va.va_type) {
1021                 case VREG:
1022                 case VDATABASE:
1023                 case VCHR:
1024                 case VBLK:
1025                 case VFIFO:
1026                     break;
1027                 case VDIR:
1028                     error = EISDIR;
1029                     break;
1030                 default:
1031                     error = EINVAL;
1032                     break;
1033                 }
1034             }
1035             if (error == 0 && (nflags & NLC_WRITE) && vp->v_mount &&
1036                 (vp->v_mount->mnt_flag & MNT_RDONLY)
1037             ) {
1038                 switch(va.va_type) {
1039                 case VDIR:
1040                 case VLNK:
1041                 case VREG:
1042                 case VDATABASE:
1043                     error = EROFS;
1044                     break;
1045                 default:
1046                     break;
1047                 }
1048             }
1049             vput(vp);
1050
1051             /*
1052              * Check permissions based on file attributes.  The passed
1053              * flags (*nflagsp) are modified with feedback based on
1054              * special attributes and requirements.
1055              */
1056             if (error == 0) {
1057                 /*
1058                  * Adjust the returned (*nflagsp) if non-NULL.
1059                  */
1060                 if (nflagsp) {
1061                     if ((va.va_mode & VSVTX) && va.va_uid != cred->cr_uid)
1062                         *nflagsp |= NLC_STICKY;
1063                     if (va.va_flags & APPEND)
1064                         *nflagsp |= NLC_APPENDONLY;
1065                     if (va.va_flags & IMMUTABLE)
1066                         *nflagsp |= NLC_IMMUTABLE;
1067                 }
1068
1069                 /*
1070                  * Track swapcache management flags in the namecache.
1071                  *
1072                  * Calculate the flags based on the current vattr info
1073                  * and recalculate the inherited flags from the parent
1074                  * (the original cache linkage may have occurred without
1075                  * getattrs and thus have stale flags).
1076                  */
1077                 cflags = 0;
1078                 if (va.va_flags & SF_NOCACHE)
1079                         cflags |= NCF_SF_NOCACHE;
1080                 if (va.va_flags & UF_CACHE)
1081                         cflags |= NCF_UF_CACHE;
1082                 if (ncp->nc_parent) {
1083                         if (ncp->nc_parent->nc_flag &
1084                             (NCF_SF_NOCACHE | NCF_SF_PNOCACHE)) {
1085                                 cflags |= NCF_SF_PNOCACHE;
1086                         }
1087                         if (ncp->nc_parent->nc_flag &
1088                             (NCF_UF_CACHE | NCF_UF_PCACHE)) {
1089                                 cflags |= NCF_UF_PCACHE;
1090                         }
1091                 }
1092                 ncp->nc_flag &= ~(NCF_SF_NOCACHE | NCF_UF_CACHE |
1093                                   NCF_SF_PNOCACHE | NCF_UF_PCACHE);
1094                 ncp->nc_flag |= cflags;
1095
1096                 /*
1097                  * Process general access.
1098                  */
1099                 error = naccess_va(&va, nflags, cred);
1100             }
1101         }
1102     }
1103     return(error);
1104 }
1105
1106 /*
1107  * Check the requested access against the given vattr using cred.
1108  */
1109 int
1110 naccess_va(struct vattr *va, int nflags, struct ucred *cred)
1111 {
1112     int i;
1113     int vmode;
1114
1115     /*
1116      * Test the immutable bit.  Creations, deletions, renames (source
1117      * or destination) are not allowed.  chown/chmod/other is also not
1118      * allowed but is handled by SETATTR.  Hardlinks to the immutable
1119      * file are allowed.
1120      *
1121      * If the directory is set to immutable then creations, deletions,
1122      * renames (source or dest) and hardlinks to files within the directory
1123      * are not allowed, and regular files opened through the directory may
1124      * not be written to or truncated (unless a special device).
1125      *
1126      * NOTE!  New hardlinks to immutable files work but new hardlinks to
1127      * files, immutable or not, sitting inside an immutable directory are
1128      * not allowed.  As always if the file is hardlinked via some other
1129      * path additional hardlinks may be possible even if the file is marked
1130      * immutable.  The sysop needs to create a closure by checking the hard
1131      * link count.  Once closure is achieved you are good, and security
1132      * scripts should check link counts anyway.
1133      *
1134      * Writes and truncations are only allowed on special devices.
1135      */
1136     if ((va->va_flags & IMMUTABLE) || (nflags & NLC_IMMUTABLE)) {
1137         if ((nflags & NLC_IMMUTABLE) && (nflags & NLC_HLINK))
1138             return (EPERM);
1139         if (nflags & (NLC_CREATE | NLC_DELETE |
1140                       NLC_RENAME_SRC | NLC_RENAME_DST)) {
1141             return (EPERM);
1142         }
1143         if (nflags & (NLC_WRITE | NLC_TRUNCATE)) {
1144             switch(va->va_type) {
1145             case VDIR:
1146                 return (EISDIR);
1147             case VLNK:
1148             case VREG:
1149             case VDATABASE:
1150                 return (EPERM);
1151             default:
1152                 break;
1153             }
1154         }
1155     }
1156
1157     /*
1158      * Test the no-unlink and append-only bits for opens, rename targets,
1159      * and deletions.  These bits are not tested for creations or
1160      * rename sources.
1161      *
1162      * Unlike FreeBSD we allow a file with APPEND set to be renamed.
1163      * If you do not wish this you must also set NOUNLINK.
1164      *
1165      * If the governing directory is marked APPEND-only it implies
1166      * NOUNLINK for all entries in the directory.
1167      */
1168     if (((va->va_flags & NOUNLINK) || (nflags & NLC_APPENDONLY)) &&
1169         (nflags & (NLC_DELETE | NLC_RENAME_SRC | NLC_RENAME_DST))
1170     ) {
1171         return (EPERM);
1172     }
1173
1174     /*
1175      * A file marked append-only may not be deleted but can be renamed.
1176      */
1177     if ((va->va_flags & APPEND) &&
1178         (nflags & (NLC_DELETE | NLC_RENAME_DST))
1179     ) {
1180         return (EPERM);
1181     }
1182
1183     /*
1184      * A file marked append-only which is opened for writing must also
1185      * be opened O_APPEND.
1186      */
1187     if ((va->va_flags & APPEND) && (nflags & (NLC_OPEN | NLC_TRUNCATE))) {
1188         if (nflags & NLC_TRUNCATE)
1189             return (EPERM);
1190         if ((nflags & (NLC_OPEN | NLC_WRITE)) == (NLC_OPEN | NLC_WRITE)) {
1191             if ((nflags & NLC_APPEND) == 0)
1192                 return (EPERM);
1193         }
1194     }
1195
1196     /*
1197      * root gets universal access
1198      */
1199     if (cred->cr_uid == 0)
1200         return(0);
1201
1202     /*
1203      * Check owner perms.
1204      *
1205      * If NLC_OWN is set the owner of the file is allowed no matter when
1206      * the owner-mode bits say (utimes).
1207      */
1208     vmode = 0;
1209     if (nflags & NLC_READ)
1210         vmode |= S_IRUSR;
1211     if (nflags & NLC_WRITE)
1212         vmode |= S_IWUSR;
1213     if (nflags & NLC_EXEC)
1214         vmode |= S_IXUSR;
1215
1216     if (cred->cr_uid == va->va_uid) {
1217         if ((nflags & NLC_OWN) == 0) {
1218             if ((vmode & va->va_mode) != vmode)
1219                 return(EACCES);
1220         }
1221         return(0);
1222     }
1223
1224     /*
1225      * If NLC_STICKY is set only the owner may delete or rename a file.
1226      * This bit is typically set on /tmp.
1227      *
1228      * Note that the NLC_READ/WRITE/EXEC bits are not typically set in
1229      * the specific delete or rename case.  For deletions and renames we
1230      * usually just care about directory permissions, not file permissions.
1231      */
1232     if ((nflags & NLC_STICKY) &&
1233         (nflags & (NLC_RENAME_SRC | NLC_RENAME_DST | NLC_DELETE))) {
1234         return(EACCES);
1235     }
1236
1237     /*
1238      * Check group perms
1239      */
1240     vmode >>= 3;
1241     for (i = 0; i < cred->cr_ngroups; ++i) {
1242         if (va->va_gid == cred->cr_groups[i]) {
1243             if ((vmode & va->va_mode) != vmode)
1244                 return(EACCES);
1245             return(0);
1246         }
1247     }
1248
1249     /*
1250      * Check world perms
1251      */
1252     vmode >>= 3;
1253     if ((vmode & va->va_mode) != vmode)
1254         return(EACCES);
1255     return(0);
1256 }
1257