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     struct nlcomponent nlc;
 412     struct nchandle nch;
 413     struct nchandle par;
 414     struct nchandle nctmp;
 415     struct mount *mp;
 416     int wasdotordotdot;
 417     char *ptr;
 418     char *xptr;
 419     int error;
 420     int len;
 421     int dflags;
 422
 423 #ifdef KTRACE
 424     if (KTRPOINT(nd->nl_td, KTR_NAMEI))
 425         ktrnamei(nd->nl_td->td_lwp, nd->nl_path);
 426 #endif
 427     bzero(&nlc, sizeof(nlc));
 428
 429     /*
 430      * Setup for the loop.  The current working namecache element is
 431      * always at least referenced.  We lock it as required, but always
 432      * return a locked, resolved namecache entry.
 433      */
 434     nd->nl_loopcnt = 0;
 435     if (nd->nl_dvp) {
 436         vrele(nd->nl_dvp);
 437         nd->nl_dvp = NULL;
 438     }
 439     ptr = nd->nl_path;
 440
 441     /*
 442      * Loop on the path components.  At the top of the loop nd->nl_nch
 443      * is ref'd and unlocked and represents our current position.
 444      */
 445     for (;;) {
 446         /*
 447          * Make sure nl_nch is locked so we can access the vnode, resolution
 448          * state, etc.
 449          */
 450         if ((nd->nl_flags & NLC_NCPISLOCKED) == 0) {
 451                 nd->nl_flags |= NLC_NCPISLOCKED;
 452                 cache_lock(&nd->nl_nch);
 453         }
 454
 455         /*
 456          * Check if the root directory should replace the current
 457          * directory.  This is done at the start of a translation
 458          * or after a symbolic link has been found.  In other cases
 459          * ptr will never be pointing at a '/'.
 460          */
 461         if (*ptr == '/') {
 462             do {
 463                 ++ptr;
 464             } while (*ptr == '/');
 465             cache_get(&nd->nl_rootnch, &nch);
 466             cache_put(&nd->nl_nch);
 467             nd->nl_nch = nch;           /* remains locked */
 468
 469             /*
 470              * Fast-track termination.  There is no parent directory of
 471              * the root in the same mount from the point of view of
 472              * the caller so return EPERM if NLC_REFDVP is specified.
 473              * e.g. 'rmdir /' is not allowed.
 474              */
 475             if (*ptr == 0) {
 476                 if (nd->nl_flags & NLC_REFDVP)
 477                         error = EPERM;
 478                 else
 479                         error = 0;
 480                 break;
 481             }
 482             continue;
 483         }
 484
 485         /*
 486          * Check directory search permissions.
 487          */
 488         dflags = 0;
 489         error = naccess(&nd->nl_nch, NLC_EXEC, nd->nl_cred, &dflags);
 490         if (error)
 491             break;
 492
 493         /*
 494          * Extract the path component.  Path components are limited to
 495          * 255 characters.
 496          */
 497         nlc.nlc_nameptr = ptr;
 498         while (*ptr && *ptr != '/')
 499             ++ptr;
 500         nlc.nlc_namelen = ptr - nlc.nlc_nameptr;
 501         if (nlc.nlc_namelen >= 256) {
 502             error = ENAMETOOLONG;
 503             break;
 504         }
 505
 506         /*
 507          * Lookup the path component in the cache, creating an unresolved
 508          * entry if necessary.  We have to handle "." and ".." as special
 509          * cases.
 510          *
 511          * When handling ".." we have to detect a traversal back through a
 512          * mount point.   If we are at the root, ".." just returns the root.
 513          *
 514          * When handling "." or ".." we also have to recalculate dflags
 515          * since our dflags will be for some sub-directory instead of the
 516          * parent dir.
 517          *
 518          * This subsection returns a locked, refd 'nch' unless it errors out.
 519          * The namecache topology is not allowed to be disconnected, so
 520          * encountering a NULL parent will generate EINVAL.  This typically
 521          * occurs when a directory is removed out from under a process.
 522          */
 523         if (nlc.nlc_namelen == 1 && nlc.nlc_nameptr[0] == '.') {
 524             cache_get(&nd->nl_nch, &nch);
 525             wasdotordotdot = 1;
 526         } else if (nlc.nlc_namelen == 2 &&
 527                    nlc.nlc_nameptr[0] == '.' && nlc.nlc_nameptr[1] == '.') {
 528             if (nd->nl_nch.mount == nd->nl_rootnch.mount &&
 529                 nd->nl_nch.ncp == nd->nl_rootnch.ncp
 530             ) {
 531                 /*
 532                  * ".." at the root returns the root
 533                  */
 534                 cache_get(&nd->nl_nch, &nch);
 535             } else {
 536                 /*
 537                  * Locate the parent ncp.  If we are at the root of a
 538                  * filesystem mount we have to skip to the mounted-on
 539                  * point in the underlying filesystem.
 540                  *
 541                  * Expect the parent to always be good since the
 542                  * mountpoint doesn't go away.  XXX hack.  cache_get()
 543                  * requires the ncp to already have a ref as a safety.
 544                  */
 545                 nctmp = nd->nl_nch;
 546                 while (nctmp.ncp == nctmp.mount->mnt_ncmountpt.ncp)
 547                         nctmp = nctmp.mount->mnt_ncmounton;
 548                 nctmp.ncp = nctmp.ncp->nc_parent;
 549                 KKASSERT(nctmp.ncp != NULL);
 550                 cache_hold(&nctmp);
 551                 cache_get(&nctmp, &nch);
 552                 cache_drop(&nctmp);             /* NOTE: zero's nctmp */
 553             }
 554             wasdotordotdot = 2;
 555         } else {
 556             /*
 557              * Must unlock nl_nch when traversing down the path.
 558              */
 559             cache_unlock(&nd->nl_nch);
 560             nd->nl_flags &= ~NLC_NCPISLOCKED;
 561             nch = cache_nlookup(&nd->nl_nch, &nlc);
 562             while ((error = cache_resolve(&nch, nd->nl_cred)) == EAGAIN) {
 563                 kprintf("[diagnostic] nlookup: relookup %*.*s\n",
 564                         nch.ncp->nc_nlen, nch.ncp->nc_nlen, nch.ncp->nc_name);
 565                 cache_put(&nch);
 566                 nch = cache_nlookup(&nd->nl_nch, &nlc);
 567             }
 568             wasdotordotdot = 0;
 569         }
 570
 571         /*
 572          * If the last component was "." or ".." our dflags no longer
 573          * represents the parent directory and we have to explicitly
 574          * look it up.
 575          *
 576          * Expect the parent to be good since nch is locked.
 577          */
 578         if (wasdotordotdot && error == 0) {
 579             dflags = 0;
 580             if ((par.ncp = nch.ncp->nc_parent) != NULL) {
 581                 par.mount = nch.mount;
 582                 cache_hold(&par);
 583                 cache_lock(&par);
 584                 error = naccess(&par, 0, nd->nl_cred, &dflags);
 585                 cache_put(&par);
 586             }
 587         }
 588         if (nd->nl_flags & NLC_NCPISLOCKED) {
 589             cache_unlock(&nd->nl_nch);
 590             nd->nl_flags &= ~NLC_NCPISLOCKED;
 591         }
 592
 593         /*
 594          * [end of subsection]
 595          *
 596          * nch is locked and referenced.
 597          * nd->nl_nch is unlocked and referenced.
 598          *
 599          * nl_nch must be unlocked or we could chain lock to the root
 600          * if a resolve gets stuck (e.g. in NFS).
 601          */
 602
 603         /*
 604          * Resolve the namespace if necessary.  The ncp returned by
 605          * cache_nlookup() is referenced and locked.
 606          *
 607          * XXX neither '.' nor '..' should return EAGAIN since they were
 608          * previously resolved and thus cannot be newly created ncp's.
 609          */
 610         if (nch.ncp->nc_flag & NCF_UNRESOLVED) {
 611             error = cache_resolve(&nch, nd->nl_cred);
 612             KKASSERT(error != EAGAIN);
 613         } else {
 614             error = nch.ncp->nc_error;
 615         }
 616
 617         /*
 618          * Early completion.  ENOENT is not an error if this is the last
 619          * component and NLC_CREATE or NLC_RENAME (rename target) was
 620          * requested.  Note that ncp->nc_error is left as ENOENT in that
 621          * case, which we check later on.
 622          *
 623          * Also handle invalid '.' or '..' components terminating a path
 624          * for a create/rename/delete.  The standard requires this and pax
 625          * pretty stupidly depends on it.
 626          */
 627         for (xptr = ptr; *xptr == '/'; ++xptr)
 628                 ;
 629         if (*xptr == 0) {
 630             if (error == ENOENT &&
 631                 (nd->nl_flags & (NLC_CREATE | NLC_RENAME_DST))
 632             ) {
 633                 if (nd->nl_flags & NLC_NFS_RDONLY) {
 634                         error = EROFS;
 635                 } else {
 636                         error = naccess(&nch, nd->nl_flags | dflags,
 637                                         nd->nl_cred, NULL);
 638                 }
 639             }
 640             if (error == 0 && wasdotordotdot &&
 641                 (nd->nl_flags & (NLC_CREATE | NLC_DELETE |
 642                                  NLC_RENAME_SRC | NLC_RENAME_DST))) {
 643                 /*
 644                  * POSIX junk
 645                  */
 646                 if (nd->nl_flags & NLC_CREATE)
 647                         error = EEXIST;
 648                 else if (nd->nl_flags & NLC_DELETE)
 649                         error = (wasdotordotdot == 1) ? EINVAL : ENOTEMPTY;
 650                 else
 651                         error = EINVAL;
 652             }
 653         }
 654
 655         /*
 656          * Early completion on error.
 657          */
 658         if (error) {
 659             cache_put(&nch);
 660             break;
 661         }
 662
 663         /*
 664          * If the element is a symlink and it is either not the last
 665          * element or it is the last element and we are allowed to
 666          * follow symlinks, resolve the symlink.
 667          */
 668         if ((nch.ncp->nc_flag & NCF_ISSYMLINK) &&
 669             (*ptr || (nd->nl_flags & NLC_FOLLOW))
 670         ) {
 671             if (nd->nl_loopcnt++ >= MAXSYMLINKS) {
 672                 error = ELOOP;
 673                 cache_put(&nch);
 674                 break;
 675             }
 676             error = nreadsymlink(nd, &nch, &nlc);
 677             cache_put(&nch);
 678             if (error)
 679                 break;
 680
 681             /*
 682              * Concatenate trailing path elements onto the returned symlink.
 683              * Note that if the path component (ptr) is not exhausted, it
 684              * will being with a '/', so we do not have to add another one.
 685              *
 686              * The symlink may not be empty.
 687              */
 688             len = strlen(ptr);
 689             if (nlc.nlc_namelen == 0 || nlc.nlc_namelen + len >= MAXPATHLEN) {
 690                 error = nlc.nlc_namelen ? ENAMETOOLONG : ENOENT;
 691                 objcache_put(namei_oc, nlc.nlc_nameptr);
 692                 break;
 693             }
 694             bcopy(ptr, nlc.nlc_nameptr + nlc.nlc_namelen, len + 1);
 695             if (nd->nl_flags & NLC_HASBUF)
 696                 objcache_put(namei_oc, nd->nl_path);
 697             nd->nl_path = nlc.nlc_nameptr;
 698             nd->nl_flags |= NLC_HASBUF;
 699             ptr = nd->nl_path;
 700
 701             /*
 702              * Go back up to the top to resolve any initial '/'s in the
 703              * symlink.
 704              */
 705             continue;
 706         }
 707
 708         /*
 709          * If the element is a directory and we are crossing a mount point,
 710          * Locate the mount.
 711          */
 712         while ((nch.ncp->nc_flag & NCF_ISMOUNTPT) &&
 713             (nd->nl_flags & NLC_NOCROSSMOUNT) == 0 &&
 714             (mp = cache_findmount(&nch)) != NULL
 715         ) {
 716             struct vnode *tdp;
 717
 718             cache_put(&nch);
 719             cache_get(&mp->mnt_ncmountpt, &nch);
 720
 721             if (nch.ncp->nc_flag & NCF_UNRESOLVED) {
 722                 while (vfs_busy(mp, 0))
 723                     ;
 724                 error = VFS_ROOT(mp, &tdp);
 725                 vfs_unbusy(mp);
 726                 if (error)
 727                     break;
 728                 cache_setvp(&nch, tdp);
 729                 vput(tdp);
 730             }
 731         }
 732         if (error) {
 733             cache_put(&nch);
 734             break;
 735         }
 736
 737         /*
 738          * Skip any slashes to get to the next element.  If there
 739          * are any slashes at all the current element must be a
 740          * directory or, in the create case, intended to become a directory.
 741          * If it isn't we break without incrementing ptr and fall through
 742          * to the failure case below.
 743          */
 744         while (*ptr == '/') {
 745             if ((nch.ncp->nc_flag & NCF_ISDIR) == 0 &&
 746                 !(nd->nl_flags & NLC_WILLBEDIR)
 747             ) {
 748                 break;
 749             }
 750             ++ptr;
 751         }
 752
 753         /*
 754          * Continuation case: additional elements and the current
 755          * element is a directory.
 756          */
 757         if (*ptr && (nch.ncp->nc_flag & NCF_ISDIR)) {
 758             cache_drop(&nd->nl_nch);
 759             cache_unlock(&nch);
 760             KKASSERT((nd->nl_flags & NLC_NCPISLOCKED) == 0);
 761             nd->nl_nch = nch;
 762             continue;
 763         }
 764
 765         /*
 766          * Failure case: additional elements and the current element
 767          * is not a directory
 768          */
 769         if (*ptr) {
 770             cache_put(&nch);
 771             error = ENOTDIR;
 772             break;
 773         }
 774
 775         /*
 776          * Successful lookup of last element.
 777          *
 778          * Check permissions if the target exists.  If the target does not
 779          * exist directory permissions were already tested in the early
 780          * completion code above.
 781          *
 782          * nd->nl_flags will be adjusted on return with NLC_APPENDONLY
 783          * if the file is marked append-only, and NLC_STICKY if the directory
 784          * containing the file is sticky.
 785          */
 786         if (nch.ncp->nc_vp && (nd->nl_flags & NLC_ALLCHKS)) {
 787             error = naccess(&nch, nd->nl_flags | dflags,
 788                             nd->nl_cred, NULL);
 789             if (error) {
 790                 cache_put(&nch);
 791                 break;
 792             }
 793         }
 794
 795         /*
 796          * Termination: no more elements.
 797          *
 798          * If NLC_REFDVP is set acquire a referenced parent dvp.
 799          */
 800         if (nd->nl_flags & NLC_REFDVP) {
 801                 cache_lock(&nd->nl_nch);
 802                 error = cache_vref(&nd->nl_nch, nd->nl_cred, &nd->nl_dvp);
 803                 cache_unlock(&nd->nl_nch);
 804                 if (error) {
 805                         kprintf("NLC_REFDVP: Cannot ref dvp of %p\n", nch.ncp);
 806                         cache_put(&nch);
 807                         break;
 808                 }
 809         }
 810         cache_drop(&nd->nl_nch);
 811         nd->nl_nch = nch;
 812         nd->nl_flags |= NLC_NCPISLOCKED;
 813         error = 0;
 814         break;
 815     }
 816
 817     /*
 818      * NOTE: If NLC_CREATE was set the ncp may represent a negative hit
 819      * (ncp->nc_error will be ENOENT), but we will still return an error
 820      * code of 0.
 821      */
 822     return(error);
 823 }
 824
 825 /*
 826  * Resolve a mount point's glue ncp.  This ncp connects creates the illusion
 827  * of continuity in the namecache tree by connecting the ncp related to the
 828  * vnode under the mount to the ncp related to the mount's root vnode.
 829  *
 830  * If no error occured a locked, ref'd ncp is stored in *ncpp.
 831  */
 832 int
 833 nlookup_mp(struct mount *mp, struct nchandle *nch)
 834 {
 835     struct vnode *vp;
 836     int error;
 837
 838     error = 0;
 839     cache_get(&mp->mnt_ncmountpt, nch);
 840     if (nch->ncp->nc_flag & NCF_UNRESOLVED) {
 841         while (vfs_busy(mp, 0))
 842             ;
 843         error = VFS_ROOT(mp, &vp);
 844         vfs_unbusy(mp);
 845         if (error) {
 846             cache_put(nch);
 847         } else {
 848             cache_setvp(nch, vp);
 849             vput(vp);
 850         }
 851     }
 852     return(error);
 853 }
 854
 855 /*
 856  * Read the contents of a symlink, allocate a path buffer out of the
 857  * namei_oc and initialize the supplied nlcomponent with the result.
 858  *
 859  * If an error occurs no buffer will be allocated or returned in the nlc.
 860  */
 861 int
 862 nreadsymlink(struct nlookupdata *nd, struct nchandle *nch,
 863                 struct nlcomponent *nlc)
 864 {
 865     struct vnode *vp;
 866     struct iovec aiov;
 867     struct uio auio;
 868     int linklen;
 869     int error;
 870     char *cp;
 871
 872     nlc->nlc_nameptr = NULL;
 873     nlc->nlc_namelen = 0;
 874     if (nch->ncp->nc_vp == NULL)
 875         return(ENOENT);
 876     if ((error = cache_vget(nch, nd->nl_cred, LK_SHARED, &vp)) != 0)
 877         return(error);
 878     cp = objcache_get(namei_oc, M_WAITOK);
 879     aiov.iov_base = cp;
 880     aiov.iov_len = MAXPATHLEN;
 881     auio.uio_iov = &aiov;
 882     auio.uio_iovcnt = 1;
 883     auio.uio_offset = 0;
 884     auio.uio_rw = UIO_READ;
 885     auio.uio_segflg = UIO_SYSSPACE;
 886     auio.uio_td = nd->nl_td;
 887     auio.uio_resid = MAXPATHLEN - 1;
 888     error = VOP_READLINK(vp, &auio, nd->nl_cred);
 889     if (error)
 890         goto fail;
 891     linklen = MAXPATHLEN - 1 - auio.uio_resid;
 892     if (varsym_enable) {
 893         linklen = varsymreplace(cp, linklen, MAXPATHLEN - 1);
 894         if (linklen < 0) {
 895             error = ENAMETOOLONG;
 896             goto fail;
 897         }
 898     }
 899     cp[linklen] = 0;
 900     nlc->nlc_nameptr = cp;
 901     nlc->nlc_namelen = linklen;
 902     vput(vp);
 903     return(0);
 904 fail:
 905     objcache_put(namei_oc, cp);
 906     vput(vp);
 907     return(error);
 908 }
 909
 910 /*
 911  * Check access [XXX cache vattr!] [XXX quota]
 912  *
 913  * Generally check the NLC_* access bits.   All specified bits must pass
 914  * for this function to return 0.
 915  *
 916  * The file does not have to exist when checking NLC_CREATE or NLC_RENAME_DST
 917  * access, otherwise it must exist.  No error is returned in this case.
 918  *
 919  * The file must not exist if NLC_EXCL is specified.
 920  *
 921  * Directory permissions in general are tested for NLC_CREATE if the file
 922  * does not exist, NLC_DELETE if the file does exist, and NLC_RENAME_DST
 923  * whether the file exists or not.
 924  *
 925  * The directory sticky bit is tested for NLC_DELETE and NLC_RENAME_DST,
 926  * the latter is only tested if the target exists.
 927  *
 928  * The passed ncp must be referenced and locked.
 929  */
 930 int
 931 naccess(struct nchandle *nch, int nflags, struct ucred *cred, int *nflagsp)
 932 {
 933     struct vnode *vp;
 934     struct vattr va;
 935     struct namecache *ncp;
 936     int error;
 937     int cflags;
 938
 939     ASSERT_NCH_LOCKED(nch);
 940     ncp = nch->ncp;
 941     if (ncp->nc_flag & NCF_UNRESOLVED) {
 942         cache_resolve(nch, cred);
 943         ncp = nch->ncp;
 944     }
 945     error = ncp->nc_error;
 946
 947     /*
 948      * Directory permissions checks.  Silently ignore ENOENT if these
 949      * tests pass.  It isn't an error.
 950      *
 951      * We can safely resolve ncp->nc_parent because ncp is currently
 952      * locked.
 953      */
 954     if (nflags & (NLC_CREATE | NLC_DELETE | NLC_RENAME_SRC | NLC_RENAME_DST)) {
 955         if (((nflags & NLC_CREATE) && ncp->nc_vp == NULL) ||
 956             ((nflags & NLC_DELETE) && ncp->nc_vp != NULL) ||
 957             ((nflags & NLC_RENAME_SRC) && ncp->nc_vp != NULL) ||
 958             (nflags & NLC_RENAME_DST)
 959         ) {
 960             struct nchandle par;
 961
 962             if ((par.ncp = ncp->nc_parent) == NULL) {
 963                 if (error != EAGAIN)
 964                         error = EINVAL;
 965             } else if (error == 0 || error == ENOENT) {
 966                 par.mount = nch->mount;
 967                 cache_hold(&par);
 968                 cache_lock(&par);
 969                 error = naccess(&par, NLC_WRITE, cred, NULL);
 970                 cache_put(&par);
 971             }
 972         }
 973     }
 974
 975     /*
 976      * NLC_EXCL check.  Target file must not exist.
 977      */
 978     if (error == 0 && (nflags & NLC_EXCL) && ncp->nc_vp != NULL)
 979         error = EEXIST;
 980
 981     /*
 982      * Get the vnode attributes so we can do the rest of our checks.
 983      *
 984      * NOTE: We only call naccess_va() if the target exists.
 985      */
 986     if (error == 0) {
 987         error = cache_vget(nch, cred, LK_SHARED, &vp);
 988         if (error == ENOENT) {
 989             /*
 990              * Silently zero-out ENOENT if creating or renaming
 991              * (rename target).  It isn't an error.
 992              */
 993             if (nflags & (NLC_CREATE | NLC_RENAME_DST))
 994                 error = 0;
 995         } else if (error == 0) {
 996             /*
 997              * Get the vnode attributes and check for illegal O_TRUNC
 998              * requests and read-only mounts.
 999              *
1000              * NOTE: You can still open devices on read-only mounts for
1001              *       writing.
1002              *
1003              * NOTE: creates/deletes/renames are handled by the NLC_WRITE
1004              *       check on the parent directory above.
1005              *
1006              * XXX cache the va in the namecache or in the vnode
1007              */
1008             error = VOP_GETATTR(vp, &va);
1009             if (error == 0 && (nflags & NLC_TRUNCATE)) {
1010                 switch(va.va_type) {
1011                 case VREG:
1012                 case VDATABASE:
1013                 case VCHR:
1014                 case VBLK:
1015                 case VFIFO:
1016                     break;
1017                 case VDIR:
1018                     error = EISDIR;
1019                     break;
1020                 default:
1021                     error = EINVAL;
1022                     break;
1023                 }
1024             }
1025             if (error == 0 && (nflags & NLC_WRITE) && vp->v_mount &&
1026                 (vp->v_mount->mnt_flag & MNT_RDONLY)
1027             ) {
1028                 switch(va.va_type) {
1029                 case VDIR:
1030                 case VLNK:
1031                 case VREG:
1032                 case VDATABASE:
1033                     error = EROFS;
1034                     break;
1035                 default:
1036                     break;
1037                 }
1038             }
1039             vput(vp);
1040
1041             /*
1042              * Check permissions based on file attributes.  The passed
1043              * flags (*nflagsp) are modified with feedback based on
1044              * special attributes and requirements.
1045              */
1046             if (error == 0) {
1047                 /*
1048                  * Adjust the returned (*nflagsp) if non-NULL.
1049                  */
1050                 if (nflagsp) {
1051                     if ((va.va_mode & VSVTX) && va.va_uid != cred->cr_uid)
1052                         *nflagsp |= NLC_STICKY;
1053                     if (va.va_flags & APPEND)
1054                         *nflagsp |= NLC_APPENDONLY;
1055                     if (va.va_flags & IMMUTABLE)
1056                         *nflagsp |= NLC_IMMUTABLE;
1057                 }
1058
1059                 /*
1060                  * Track swapcache management flags in the namecache.
1061                  *
1062                  * Calculate the flags based on the current vattr info
1063                  * and recalculate the inherited flags from the parent
1064                  * (the original cache linkage may have occurred without
1065                  * getattrs and thus have stale flags).
1066                  */
1067                 cflags = 0;
1068                 if (va.va_flags & SF_NOCACHE)
1069                         cflags |= NCF_SF_NOCACHE;
1070                 if (va.va_flags & UF_CACHE)
1071                         cflags |= NCF_UF_CACHE;
1072                 if (ncp->nc_parent) {
1073                         if (ncp->nc_parent->nc_flag &
1074                             (NCF_SF_NOCACHE | NCF_SF_PNOCACHE)) {
1075                                 cflags |= NCF_SF_PNOCACHE;
1076                         }
1077                         if (ncp->nc_parent->nc_flag &
1078                             (NCF_UF_CACHE | NCF_UF_PCACHE)) {
1079                                 cflags |= NCF_UF_PCACHE;
1080                         }
1081                 }
1082                 ncp->nc_flag &= ~(NCF_SF_NOCACHE | NCF_UF_CACHE |
1083                                   NCF_SF_PNOCACHE | NCF_UF_PCACHE);
1084                 ncp->nc_flag |= cflags;
1085
1086                 /*
1087                  * Process general access.
1088                  */
1089                 error = naccess_va(&va, nflags, cred);
1090             }
1091         }
1092     }
1093     return(error);
1094 }
1095
1096 /*
1097  * Check the requested access against the given vattr using cred.
1098  */
1099 int
1100 naccess_va(struct vattr *va, int nflags, struct ucred *cred)
1101 {
1102     int i;
1103     int vmode;
1104
1105     /*
1106      * Test the immutable bit.  Creations, deletions, renames (source
1107      * or destination) are not allowed.  chown/chmod/other is also not
1108      * allowed but is handled by SETATTR.  Hardlinks to the immutable
1109      * file are allowed.
1110      *
1111      * If the directory is set to immutable then creations, deletions,
1112      * renames (source or dest) and hardlinks to files within the directory
1113      * are not allowed, and regular files opened through the directory may
1114      * not be written to or truncated (unless a special device).
1115      *
1116      * NOTE!  New hardlinks to immutable files work but new hardlinks to
1117      * files, immutable or not, sitting inside an immutable directory are
1118      * not allowed.  As always if the file is hardlinked via some other
1119      * path additional hardlinks may be possible even if the file is marked
1120      * immutable.  The sysop needs to create a closure by checking the hard
1121      * link count.  Once closure is achieved you are good, and security
1122      * scripts should check link counts anyway.
1123      *
1124      * Writes and truncations are only allowed on special devices.
1125      */
1126     if ((va->va_flags & IMMUTABLE) || (nflags & NLC_IMMUTABLE)) {
1127         if ((nflags & NLC_IMMUTABLE) && (nflags & NLC_HLINK))
1128             return (EPERM);
1129         if (nflags & (NLC_CREATE | NLC_DELETE |
1130                       NLC_RENAME_SRC | NLC_RENAME_DST)) {
1131             return (EPERM);
1132         }
1133         if (nflags & (NLC_WRITE | NLC_TRUNCATE)) {
1134             switch(va->va_type) {
1135             case VDIR:
1136                 return (EISDIR);
1137             case VLNK:
1138             case VREG:
1139             case VDATABASE:
1140                 return (EPERM);
1141             default:
1142                 break;
1143             }
1144         }
1145     }
1146
1147     /*
1148      * Test the no-unlink and append-only bits for opens, rename targets,
1149      * and deletions.  These bits are not tested for creations or
1150      * rename sources.
1151      *
1152      * Unlike FreeBSD we allow a file with APPEND set to be renamed.
1153      * If you do not wish this you must also set NOUNLINK.
1154      *
1155      * If the governing directory is marked APPEND-only it implies
1156      * NOUNLINK for all entries in the directory.
1157      */
1158     if (((va->va_flags & NOUNLINK) || (nflags & NLC_APPENDONLY)) &&
1159         (nflags & (NLC_DELETE | NLC_RENAME_SRC | NLC_RENAME_DST))
1160     ) {
1161         return (EPERM);
1162     }
1163
1164     /*
1165      * A file marked append-only may not be deleted but can be renamed.
1166      */
1167     if ((va->va_flags & APPEND) &&
1168         (nflags & (NLC_DELETE | NLC_RENAME_DST))
1169     ) {
1170         return (EPERM);
1171     }
1172
1173     /*
1174      * A file marked append-only which is opened for writing must also
1175      * be opened O_APPEND.
1176      */
1177     if ((va->va_flags & APPEND) && (nflags & (NLC_OPEN | NLC_TRUNCATE))) {
1178         if (nflags & NLC_TRUNCATE)
1179             return (EPERM);
1180         if ((nflags & (NLC_OPEN | NLC_WRITE)) == (NLC_OPEN | NLC_WRITE)) {
1181             if ((nflags & NLC_APPEND) == 0)
1182                 return (EPERM);
1183         }
1184     }
1185
1186     /*
1187      * root gets universal access
1188      */
1189     if (cred->cr_uid == 0)
1190         return(0);
1191
1192     /*
1193      * Check owner perms.
1194      *
1195      * If NLC_OWN is set the owner of the file is allowed no matter when
1196      * the owner-mode bits say (utimes).
1197      */
1198     vmode = 0;
1199     if (nflags & NLC_READ)
1200         vmode |= S_IRUSR;
1201     if (nflags & NLC_WRITE)
1202         vmode |= S_IWUSR;
1203     if (nflags & NLC_EXEC)
1204         vmode |= S_IXUSR;
1205
1206     if (cred->cr_uid == va->va_uid) {
1207         if ((nflags & NLC_OWN) == 0) {
1208             if ((vmode & va->va_mode) != vmode)
1209                 return(EACCES);
1210         }
1211         return(0);
1212     }
1213
1214     /*
1215      * If NLC_STICKY is set only the owner may delete or rename a file.
1216      * This bit is typically set on /tmp.
1217      *
1218      * Note that the NLC_READ/WRITE/EXEC bits are not typically set in
1219      * the specific delete or rename case.  For deletions and renames we
1220      * usually just care about directory permissions, not file permissions.
1221      */
1222     if ((nflags & NLC_STICKY) &&
1223         (nflags & (NLC_RENAME_SRC | NLC_RENAME_DST | NLC_DELETE))) {
1224         return(EACCES);
1225     }
1226
1227     /*
1228      * Check group perms
1229      */
1230     vmode >>= 3;
1231     for (i = 0; i < cred->cr_ngroups; ++i) {
1232         if (va->va_gid == cred->cr_groups[i]) {
1233             if ((vmode & va->va_mode) != vmode)
1234                 return(EACCES);
1235             return(0);
1236         }
1237     }
1238
1239     /*
1240      * Check world perms
1241      */
1242     vmode >>= 3;
1243     if ((vmode & va->va_mode) != vmode)
1244         return(EACCES);
1245     return(0);
1246 }
1247