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
  69 #ifdef KTRACE
  70 #include <sys/ktrace.h>
  71 #endif
  72
  73 static int naccess_va(struct vattr *va, int vmode, struct ucred *cred);
  74
  75 /*
  76  * Initialize a nlookup() structure, early error return for copyin faults
  77  * or a degenerate empty string (which is not allowed).
  78  *
  79  * The first process proc0's credentials are used if the calling thread
  80  * is not associated with a process context.
  81  */
  82 int
  83 nlookup_init(struct nlookupdata *nd,
  84              const char *path, enum uio_seg seg, int flags)
  85 {
  86     size_t pathlen;
  87     struct proc *p;
  88     thread_t td;
  89     int error;
  90
  91     td = curthread;
  92     p = td->td_proc;
  93
  94     /*
  95      * note: the pathlen set by copy*str() includes the terminating \0.
  96      */
  97     bzero(nd, sizeof(struct nlookupdata));
  98     nd->nl_path = objcache_get(namei_oc, M_WAITOK);
  99     nd->nl_flags |= NLC_HASBUF;
 100     if (seg == UIO_SYSSPACE)
 101         error = copystr(path, nd->nl_path, MAXPATHLEN, &pathlen);
 102     else
 103         error = copyinstr(path, nd->nl_path, MAXPATHLEN, &pathlen);
 104
 105     /*
 106      * Don't allow empty pathnames.
 107      * POSIX.1 requirement: "" is not a vaild file name.
 108      */
 109     if (error == 0 && pathlen <= 1)
 110         error = ENOENT;
 111
 112     if (error == 0) {
 113         if (p && p->p_fd) {
 114             cache_copy(&p->p_fd->fd_ncdir, &nd->nl_nch);
 115             cache_copy(&p->p_fd->fd_nrdir, &nd->nl_rootnch);
 116             if (p->p_fd->fd_njdir.ncp)
 117                 cache_copy(&p->p_fd->fd_njdir, &nd->nl_jailnch);
 118             nd->nl_cred = crhold(p->p_ucred);
 119         } else {
 120             cache_copy(&rootnch, &nd->nl_nch);
 121             cache_copy(&nd->nl_nch, &nd->nl_rootnch);
 122             cache_copy(&nd->nl_nch, &nd->nl_jailnch);
 123             nd->nl_cred = crhold(proc0.p_ucred);
 124         }
 125         nd->nl_td = td;
 126         nd->nl_flags |= flags;
 127     } else {
 128         nlookup_done(nd);
 129     }
 130     return(error);
 131 }
 132
 133 /*
 134  * This works similarly to nlookup_init() but does not assume a process
 135  * context.  rootnch is always chosen for the root directory and the cred
 136  * and starting directory are supplied in arguments.
 137  */
 138 int
 139 nlookup_init_raw(struct nlookupdata *nd,
 140              const char *path, enum uio_seg seg, int flags,
 141              struct ucred *cred, struct nchandle *ncstart)
 142 {
 143     size_t pathlen;
 144     thread_t td;
 145     int error;
 146
 147     td = curthread;
 148
 149     bzero(nd, sizeof(struct nlookupdata));
 150     nd->nl_path = objcache_get(namei_oc, M_WAITOK);
 151     nd->nl_flags |= NLC_HASBUF;
 152     if (seg == UIO_SYSSPACE)
 153         error = copystr(path, nd->nl_path, MAXPATHLEN, &pathlen);
 154     else
 155         error = copyinstr(path, nd->nl_path, MAXPATHLEN, &pathlen);
 156
 157     /*
 158      * Don't allow empty pathnames.
 159      * POSIX.1 requirement: "" is not a vaild file name.
 160      */
 161     if (error == 0 && pathlen <= 1)
 162         error = ENOENT;
 163
 164     if (error == 0) {
 165         cache_copy(ncstart, &nd->nl_nch);
 166         cache_copy(&rootnch, &nd->nl_rootnch);
 167         cache_copy(&rootnch, &nd->nl_jailnch);
 168         nd->nl_cred = crhold(cred);
 169         nd->nl_td = td;
 170         nd->nl_flags |= flags;
 171     } else {
 172         nlookup_done(nd);
 173     }
 174     return(error);
 175 }
 176
 177 /*
 178  * Set a different credential; this credential will be used by future
 179  * operations performed on nd.nl_open_vp and nlookupdata structure.
 180  */
 181 void
 182 nlookup_set_cred(struct nlookupdata *nd, struct ucred *cred)
 183 {
 184         KKASSERT(nd->nl_cred != NULL);
 185
 186         if (nd->nl_cred != cred) {
 187                 cred = crhold(cred);
 188                 crfree(nd->nl_cred);
 189                 nd->nl_cred = cred;
 190         }
 191 }
 192
 193 /*
 194  * Cleanup a nlookupdata structure after we are through with it.  This may
 195  * be called on any nlookupdata structure initialized with nlookup_init().
 196  * Calling nlookup_done() is mandatory in all cases except where nlookup_init()
 197  * returns an error, even if as a consumer you believe you have taken all
 198  * dynamic elements out of the nlookupdata structure.
 199  */
 200 void
 201 nlookup_done(struct nlookupdata *nd)
 202 {
 203     if (nd->nl_nch.ncp) {
 204         if (nd->nl_flags & NLC_NCPISLOCKED) {
 205             nd->nl_flags &= ~NLC_NCPISLOCKED;
 206             cache_unlock(&nd->nl_nch);
 207         }
 208         cache_drop(&nd->nl_nch);
 209     }
 210     if (nd->nl_rootnch.ncp)
 211         cache_drop(&nd->nl_rootnch);
 212     if (nd->nl_jailnch.ncp)
 213         cache_drop(&nd->nl_jailnch);
 214     if ((nd->nl_flags & NLC_HASBUF) && nd->nl_path) {
 215         objcache_put(namei_oc, nd->nl_path);
 216         nd->nl_path = NULL;
 217     }
 218     if (nd->nl_cred) {
 219         crfree(nd->nl_cred);
 220         nd->nl_cred = NULL;
 221     }
 222     if (nd->nl_open_vp) {
 223         if (nd->nl_flags & NLC_LOCKVP) {
 224                 vn_unlock(nd->nl_open_vp);
 225                 nd->nl_flags &= ~NLC_LOCKVP;
 226         }
 227         vn_close(nd->nl_open_vp, nd->nl_vp_fmode);
 228         nd->nl_open_vp = NULL;
 229     }
 230     if (nd->nl_dvp) {
 231         vrele(nd->nl_dvp);
 232         nd->nl_dvp = NULL;
 233     }
 234     nd->nl_flags = 0;   /* clear remaining flags (just clear everything) */
 235 }
 236
 237 void
 238 nlookup_zero(struct nlookupdata *nd)
 239 {
 240     bzero(nd, sizeof(struct nlookupdata));
 241 }
 242
 243 /*
 244  * Simple all-in-one nlookup.  Returns a locked namecache structure or NULL
 245  * if an error occured.
 246  *
 247  * Note that the returned ncp is not checked for permissions, though VEXEC
 248  * is checked on the directory path leading up to the result.  The caller
 249  * must call naccess() to check the permissions of the returned leaf.
 250  */
 251 struct nchandle
 252 nlookup_simple(const char *str, enum uio_seg seg,
 253                int niflags, int *error)
 254 {
 255     struct nlookupdata nd;
 256     struct nchandle nch;
 257
 258     *error = nlookup_init(&nd, str, seg, niflags);
 259     if (*error == 0) {
 260             if ((*error = nlookup(&nd)) == 0) {
 261                     nch = nd.nl_nch;    /* keep hold ref from structure */
 262                     cache_zero(&nd.nl_nch); /* and NULL out */
 263             } else {
 264                     cache_zero(&nch);
 265             }
 266             nlookup_done(&nd);
 267     } else {
 268             cache_zero(&nch);
 269     }
 270     return(nch);
 271 }
 272
 273 /*
 274  * Do a generic nlookup.  Note that the passed nd is not nlookup_done()'d
 275  * on return, even if an error occurs.  If no error occurs the returned
 276  * nl_nch is always referenced and locked, otherwise it may or may not be.
 277  *
 278  * Intermediate directory elements, including the current directory, require
 279  * execute (search) permission.  nlookup does not examine the access
 280  * permissions on the returned element.
 281  *
 282  * If NLC_CREATE or NLC_DELETE is set the last directory must allow node
 283  * creation (VCREATE/VDELETE), and an error code of 0 will be returned for
 284  * a non-existant target.  Otherwise a non-existant target will cause
 285  * ENOENT to be returned.
 286  *
 287  * If NLC_REFDVP is set nd->nl_dvp will be set to the directory vnode
 288  * of the returned entry.  The vnode will be referenced, but not locked,
 289  * and will be released by nlookup_done() along with everything else.
 290  */
 291 int
 292 nlookup(struct nlookupdata *nd)
 293 {
 294     struct nlcomponent nlc;
 295     struct nchandle nch;
 296     struct mount *mp;
 297     int wasdotordotdot;
 298     char *ptr;
 299     char *xptr;
 300     int error;
 301     int len;
 302
 303 #ifdef KTRACE
 304     if (KTRPOINT(nd->nl_td, KTR_NAMEI))
 305         ktrnamei(nd->nl_td->td_lwp, nd->nl_path);
 306 #endif
 307     bzero(&nlc, sizeof(nlc));
 308
 309     /*
 310      * Setup for the loop.  The current working namecache element must
 311      * be in a refd + unlocked state.  This typically the case on entry except
 312      * when stringing nlookup()'s along in a chain, since nlookup() always
 313      * returns nl_nch in a locked state.
 314      */
 315     nd->nl_loopcnt = 0;
 316     if (nd->nl_flags & NLC_NCPISLOCKED) {
 317         nd->nl_flags &= ~NLC_NCPISLOCKED;
 318         cache_unlock(&nd->nl_nch);
 319     }
 320     if (nd->nl_dvp ) {
 321         vrele(nd->nl_dvp);
 322         nd->nl_dvp = NULL;
 323     }
 324     ptr = nd->nl_path;
 325
 326     /*
 327      * Loop on the path components.  At the top of the loop nd->nl_nch
 328      * is ref'd and unlocked and represents our current position.
 329      */
 330     for (;;) {
 331         /*
 332          * Check if the root directory should replace the current
 333          * directory.  This is done at the start of a translation
 334          * or after a symbolic link has been found.  In other cases
 335          * ptr will never be pointing at a '/'.
 336          */
 337         if (*ptr == '/') {
 338             do {
 339                 ++ptr;
 340             } while (*ptr == '/');
 341             cache_copy(&nd->nl_rootnch, &nch);
 342             cache_drop(&nd->nl_nch);
 343             nd->nl_nch = nch;
 344
 345             /*
 346              * Fast-track termination.  There is no parent directory of
 347              * the root in the same mount from the point of view of
 348              * the caller so return EPERM if NLC_REFDVP is specified.
 349              * e.g. 'rmdir /' is not allowed.
 350              */
 351             if (*ptr == 0) {
 352                 if (nd->nl_flags & NLC_REFDVP) {
 353                         error = EPERM;
 354                 } else {
 355                         cache_lock(&nd->nl_nch);
 356                         nd->nl_flags |= NLC_NCPISLOCKED;
 357                         error = 0;
 358                 }
 359                 break;
 360             }
 361             continue;
 362         }
 363
 364         /*
 365          * Check directory search permissions.
 366          */
 367         if ((error = naccess(&nd->nl_nch, VEXEC, nd->nl_cred, NULL)) != 0)
 368             break;
 369
 370         /*
 371          * Extract the path component
 372          */
 373         nlc.nlc_nameptr = ptr;
 374         while (*ptr && *ptr != '/')
 375             ++ptr;
 376         nlc.nlc_namelen = ptr - nlc.nlc_nameptr;
 377
 378         /*
 379          * Lookup the path component in the cache, creating an unresolved
 380          * entry if necessary.  We have to handle "." and ".." as special
 381          * cases.
 382          *
 383          * When handling ".." we have to detect a traversal back through a
 384          * mount point.   If we are at the root, ".." just returns the root.
 385          *
 386          * This subsection returns a locked, refd 'nch' unless it errors out.
 387          * The namecache topology is not allowed to be disconnected, so
 388          * encountering a NULL parent will generate EINVAL.  This typically
 389          * occurs when a directory is removed out from under a process.
 390          *
 391          * If NLC_DELETE is set neither '.' or '..' can be the last component
 392          * of a path.
 393          */
 394         if (nlc.nlc_namelen == 1 && nlc.nlc_nameptr[0] == '.') {
 395             cache_get(&nd->nl_nch, &nch);
 396             wasdotordotdot = 1;
 397         } else if (nlc.nlc_namelen == 2 &&
 398                    nlc.nlc_nameptr[0] == '.' && nlc.nlc_nameptr[1] == '.') {
 399             if (nd->nl_nch.mount == nd->nl_rootnch.mount &&
 400                 nd->nl_nch.ncp == nd->nl_rootnch.ncp
 401             ) {
 402                 /*
 403                  * ".." at the root returns the root
 404                  */
 405                 cache_get(&nd->nl_nch, &nch);
 406             } else {
 407                 /*
 408                  * Locate the parent ncp.  If we are at the root of a
 409                  * filesystem mount we have to skip to the mounted-on
 410                  * point in the underlying filesystem.
 411                  */
 412                 nch = nd->nl_nch;
 413                 while (nch.ncp == nch.mount->mnt_ncmountpt.ncp)
 414                         nch = nch.mount->mnt_ncmounton;
 415                 nch.ncp = nch.ncp->nc_parent;
 416                 KKASSERT(nch.ncp != NULL);
 417                 cache_get(&nch, &nch);
 418             }
 419             wasdotordotdot = 1;
 420         } else {
 421             nch = cache_nlookup(&nd->nl_nch, &nlc);
 422             while ((error = cache_resolve(&nch, nd->nl_cred)) == EAGAIN) {
 423                 kprintf("[diagnostic] nlookup: relookup %*.*s\n",
 424                         nch.ncp->nc_nlen, nch.ncp->nc_nlen, nch.ncp->nc_name);
 425                 cache_put(&nch);
 426                 nch = cache_nlookup(&nd->nl_nch, &nlc);
 427             }
 428             wasdotordotdot = 0;
 429         }
 430         /*
 431          * [end of subsection] ncp is locked and ref'd.  nd->nl_nch is ref'd
 432          */
 433
 434         /*
 435          * Resolve the namespace if necessary.  The ncp returned by
 436          * cache_nlookup() is referenced and locked.
 437          *
 438          * XXX neither '.' nor '..' should return EAGAIN since they were
 439          * previously resolved and thus cannot be newly created ncp's.
 440          */
 441         if (nch.ncp->nc_flag & NCF_UNRESOLVED) {
 442             error = cache_resolve(&nch, nd->nl_cred);
 443             KKASSERT(error != EAGAIN);
 444         } else {
 445             error = nch.ncp->nc_error;
 446         }
 447
 448         /*
 449          * Early completion.  ENOENT is not an error if this is the last
 450          * component and NLC_CREATE was requested.  Note that ncp->nc_error
 451          * is left as ENOENT in that case, which we check later on.
 452          *
 453          * Also handle invalid '.' or '..' components terminating a path
 454          * during removal.  The standard requires this and pax pretty
 455          * stupidly depends on it.
 456          */
 457         for (xptr = ptr; *xptr == '/'; ++xptr)
 458                 ;
 459         if (*xptr == 0) {
 460             if (error == ENOENT && (nd->nl_flags & NLC_CREATE)) {
 461                 if (nd->nl_flags & NLC_NFS_RDONLY)
 462                         error = EROFS;
 463                 else
 464                         error = naccess(&nch, VCREATE, nd->nl_cred, NULL);
 465             }
 466             if (error == 0 && wasdotordotdot && (nd->nl_flags & NLC_DELETE))
 467                 error = EINVAL;
 468         }
 469
 470         /*
 471          * Early completion on error.
 472          */
 473         if (error) {
 474             cache_put(&nch);
 475             break;
 476         }
 477
 478         /*
 479          * If the element is a symlink and it is either not the last
 480          * element or it is the last element and we are allowed to
 481          * follow symlinks, resolve the symlink.
 482          */
 483         if ((nch.ncp->nc_flag & NCF_ISSYMLINK) &&
 484             (*ptr || (nd->nl_flags & NLC_FOLLOW))
 485         ) {
 486             if (nd->nl_loopcnt++ >= MAXSYMLINKS) {
 487                 error = ELOOP;
 488                 cache_put(&nch);
 489                 break;
 490             }
 491             error = nreadsymlink(nd, &nch, &nlc);
 492             cache_put(&nch);
 493             if (error)
 494                 break;
 495
 496             /*
 497              * Concatenate trailing path elements onto the returned symlink.
 498              * Note that if the path component (ptr) is not exhausted, it
 499              * will being with a '/', so we do not have to add another one.
 500              *
 501              * The symlink may not be empty.
 502              */
 503             len = strlen(ptr);
 504             if (nlc.nlc_namelen == 0 || nlc.nlc_namelen + len >= MAXPATHLEN) {
 505                 error = nlc.nlc_namelen ? ENAMETOOLONG : ENOENT;
 506                 objcache_put(namei_oc, nlc.nlc_nameptr);
 507                 break;
 508             }
 509             bcopy(ptr, nlc.nlc_nameptr + nlc.nlc_namelen, len + 1);
 510             if (nd->nl_flags & NLC_HASBUF)
 511                 objcache_put(namei_oc, nd->nl_path);
 512             nd->nl_path = nlc.nlc_nameptr;
 513             nd->nl_flags |= NLC_HASBUF;
 514             ptr = nd->nl_path;
 515
 516             /*
 517              * Go back up to the top to resolve any initial '/'s in the
 518              * symlink.
 519              */
 520             continue;
 521         }
 522
 523         /*
 524          * If the element is a directory and we are crossing a mount point,
 525          * Locate the mount.
 526          */
 527         while ((nch.ncp->nc_flag & NCF_ISMOUNTPT) &&
 528             (nd->nl_flags & NLC_NOCROSSMOUNT) == 0 &&
 529             (mp = cache_findmount(&nch)) != NULL
 530         ) {
 531             struct vnode *tdp;
 532
 533             cache_put(&nch);
 534             cache_get(&mp->mnt_ncmountpt, &nch);
 535
 536             if (nch.ncp->nc_flag & NCF_UNRESOLVED) {
 537                 while (vfs_busy(mp, 0))
 538                     ;
 539                 error = VFS_ROOT(mp, &tdp);
 540                 vfs_unbusy(mp);
 541                 if (error)
 542                     break;
 543                 cache_setvp(&nch, tdp);
 544                 vput(tdp);
 545             }
 546         }
 547         if (error) {
 548             cache_put(&nch);
 549             break;
 550         }
 551
 552         /*
 553          * Skip any slashes to get to the next element.  If there
 554          * are any slashes at all the current element must be a
 555          * directory or, in the create case, intended to become a directory.
 556          * If it isn't we break without incrementing ptr and fall through
 557          * to the failure case below.
 558          */
 559         while (*ptr == '/') {
 560             if ((nch.ncp->nc_flag & NCF_ISDIR) == 0 &&
 561                 !(nd->nl_flags & NLC_WILLBEDIR)
 562             ) {
 563                 break;
 564             }
 565             ++ptr;
 566         }
 567
 568         /*
 569          * Continuation case: additional elements and the current
 570          * element is a directory.
 571          */
 572         if (*ptr && (nch.ncp->nc_flag & NCF_ISDIR)) {
 573             cache_drop(&nd->nl_nch);
 574             cache_unlock(&nch);
 575             nd->nl_nch = nch;
 576             continue;
 577         }
 578
 579         /*
 580          * Failure case: additional elements and the current element
 581          * is not a directory
 582          */
 583         if (*ptr) {
 584             cache_put(&nch);
 585             error = ENOTDIR;
 586             break;
 587         }
 588
 589         /*
 590          * Successful lookup of last element.
 591          *
 592          * Check directory permissions if a deletion is specified.
 593          */
 594         if (*ptr == 0 && (nd->nl_flags & NLC_DELETE)) {
 595             if ((error = naccess(&nch, VDELETE, nd->nl_cred, NULL)) != 0) {
 596                 cache_put(&nch);
 597                 break;
 598             }
 599         }
 600
 601         /*
 602          * Termination: no more elements.  If NLC_CREATE was set the
 603          * ncp may represent a negative hit (ncp->nc_error will be ENOENT),
 604          * but we still return an error code of 0.
 605          *
 606          * If NLC_REFDVP is set acquire a referenced parent dvp.
 607          */
 608         if (nd->nl_flags & NLC_REFDVP) {
 609                 error = cache_vref(&nd->nl_nch, nd->nl_cred, &nd->nl_dvp);
 610                 if (error) {
 611                         kprintf("NLC_REFDVP: Cannot ref dvp of %p\n", nch.ncp);
 612                         cache_put(&nch);
 613                         break;
 614                 }
 615         }
 616         cache_drop(&nd->nl_nch);
 617         nd->nl_nch = nch;
 618         nd->nl_flags |= NLC_NCPISLOCKED;
 619         error = 0;
 620         break;
 621     }
 622     return(error);
 623 }
 624
 625 /*
 626  * Resolve a mount point's glue ncp.  This ncp connects creates the illusion
 627  * of continuity in the namecache tree by connecting the ncp related to the
 628  * vnode under the mount to the ncp related to the mount's root vnode.
 629  *
 630  * If no error occured a locked, ref'd ncp is stored in *ncpp.
 631  */
 632 int
 633 nlookup_mp(struct mount *mp, struct nchandle *nch)
 634 {
 635     struct vnode *vp;
 636     int error;
 637
 638     error = 0;
 639     cache_get(&mp->mnt_ncmountpt, nch);
 640     if (nch->ncp->nc_flag & NCF_UNRESOLVED) {
 641         while (vfs_busy(mp, 0))
 642             ;
 643         error = VFS_ROOT(mp, &vp);
 644         vfs_unbusy(mp);
 645         if (error) {
 646             cache_put(nch);
 647         } else {
 648             cache_setvp(nch, vp);
 649             vput(vp);
 650         }
 651     }
 652     return(error);
 653 }
 654
 655 /*
 656  * Read the contents of a symlink, allocate a path buffer out of the
 657  * namei_oc and initialize the supplied nlcomponent with the result.
 658  *
 659  * If an error occurs no buffer will be allocated or returned in the nlc.
 660  */
 661 int
 662 nreadsymlink(struct nlookupdata *nd, struct nchandle *nch,
 663                 struct nlcomponent *nlc)
 664 {
 665     struct vnode *vp;
 666     struct iovec aiov;
 667     struct uio auio;
 668     int linklen;
 669     int error;
 670     char *cp;
 671
 672     nlc->nlc_nameptr = NULL;
 673     nlc->nlc_namelen = 0;
 674     if (nch->ncp->nc_vp == NULL)
 675         return(ENOENT);
 676     if ((error = cache_vget(nch, nd->nl_cred, LK_SHARED, &vp)) != 0)
 677         return(error);
 678     cp = objcache_get(namei_oc, M_WAITOK);
 679     aiov.iov_base = cp;
 680     aiov.iov_len = MAXPATHLEN;
 681     auio.uio_iov = &aiov;
 682     auio.uio_iovcnt = 1;
 683     auio.uio_offset = 0;
 684     auio.uio_rw = UIO_READ;
 685     auio.uio_segflg = UIO_SYSSPACE;
 686     auio.uio_td = nd->nl_td;
 687     auio.uio_resid = MAXPATHLEN - 1;
 688     error = VOP_READLINK(vp, &auio, nd->nl_cred);
 689     if (error)
 690         goto fail;
 691     linklen = MAXPATHLEN - 1 - auio.uio_resid;
 692     if (varsym_enable) {
 693         linklen = varsymreplace(cp, linklen, MAXPATHLEN - 1);
 694         if (linklen < 0) {
 695             error = ENAMETOOLONG;
 696             goto fail;
 697         }
 698     }
 699     cp[linklen] = 0;
 700     nlc->nlc_nameptr = cp;
 701     nlc->nlc_namelen = linklen;
 702     vput(vp);
 703     return(0);
 704 fail:
 705     objcache_put(namei_oc, cp);
 706     vput(vp);
 707     return(error);
 708 }
 709
 710 /*
 711  * Check access [XXX cache vattr!] [XXX quota]
 712  *
 713  * Generally check the V* access bits from sys/vnode.h.  All specified bits
 714  * must pass for this function to return 0.
 715  *
 716  * If VCREATE is specified and the target ncp represents a non-existant
 717  * file or dir, or if VDELETE is specified and the target exists, the parent
 718  * directory is checked for VWRITE.  If VEXCL is specified and the target
 719  * ncp represents a positive hit, an error is returned.
 720  *
 721  * If VCREATE is not specified and the target does not exist (negative hit),
 722  * ENOENT is returned.  Note that nlookup() does not (and should not) return
 723  * ENOENT for non-existant leafs.
 724  *
 725  * If VDELETE is specified we also do sticky-bit tests on the parent
 726  * directory.
 727  *
 728  * The passed ncp may or may not be locked.  The caller should use a
 729  * locked ncp on leaf lookups, especially for VCREATE, VDELETE, and VEXCL
 730  * checks.
 731  */
 732 int
 733 naccess(struct nchandle *nch, int vmode, struct ucred *cred, int *stickyp)
 734 {
 735     struct nchandle par;
 736     struct vnode *vp;
 737     struct vattr va;
 738     int error;
 739     int sticky;
 740
 741     if (nch->ncp->nc_flag & NCF_UNRESOLVED) {
 742         cache_lock(nch);
 743         cache_resolve(nch, cred);
 744         cache_unlock(nch);
 745     }
 746     error = nch->ncp->nc_error;
 747     sticky = 0;
 748
 749     if (vmode & (VDELETE|VCREATE|VEXCL)) {
 750         if (((vmode & VCREATE) && nch->ncp->nc_vp == NULL) ||
 751             ((vmode & VDELETE) && nch->ncp->nc_vp != NULL)
 752         ) {
 753             if ((par.ncp = nch->ncp->nc_parent) == NULL) {
 754                 if (error != EAGAIN)
 755                         error = EINVAL;
 756             } else {
 757                 par.mount = nch->mount;
 758                 cache_hold(&par);
 759                 error = naccess(&par, VWRITE, cred, &sticky);
 760                 if ((vmode & VDELETE) && sticky)
 761                     vmode |= VSVTX;
 762                 cache_drop(&par);
 763             }
 764         }
 765         if ((vmode & VEXCL) && nch->ncp->nc_vp != NULL)
 766             error = EEXIST;
 767     }
 768     if (error == 0) {
 769         error = cache_vget(nch, cred, LK_SHARED, &vp);
 770         if (error == ENOENT) {
 771             if (vmode & VCREATE)
 772                 error = 0;
 773         } else if (error == 0) {
 774             /* XXX cache the va in the namecache or in the vnode */
 775             if ((error = VOP_GETATTR(vp, &va)) == 0) {
 776                 if ((vmode & VWRITE) && vp->v_mount) {
 777                     if (vp->v_mount->mnt_flag & MNT_RDONLY)
 778                         error = EROFS;
 779                 }
 780             }
 781             vput(vp);
 782
 783             if (error == 0) {
 784                 /*
 785                  * Set the returned (*stickyp) if VSVTX is set and the uid
 786                  * is not the owner of the directory.  The caller uses this
 787                  * disallow deletions of files not owned by the user if the
 788                  * user also does not own the directory and the sticky bit
 789                  * is set on the directory.  Weird, I know.
 790                  */
 791                 if (stickyp && va.va_uid != cred->cr_uid)
 792                     *stickyp = (va.va_mode & VSVTX);
 793
 794                 /*
 795                  * Process general access.
 796                  */
 797                 error = naccess_va(&va, vmode, cred);
 798             }
 799         }
 800     }
 801     return(error);
 802 }
 803
 804 /*
 805  * Check the requested access against the given vattr using cred.
 806  */
 807 static
 808 int
 809 naccess_va(struct vattr *va, int vmode, struct ucred *cred)
 810 {
 811     int i;
 812
 813     /*
 814      * Test the immutable bit for files, directories, and softlinks.
 815      */
 816     if (vmode & (VWRITE|VDELETE)) {
 817         if (va->va_type == VDIR || va->va_type == VLNK || va->va_type == VREG) {
 818             if (va->va_flags & IMMUTABLE)
 819                 return (EPERM);
 820         }
 821     }
 822
 823     /*
 824      * root gets universal access
 825      */
 826     if (cred->cr_uid == 0)
 827         return(0);
 828
 829     /*
 830      * Check owner perms.
 831      *
 832      * If VOWN is set the owner of the file is allowed no matter when
 833      * the owner-mode bits say (utimes).
 834      */
 835     if (cred->cr_uid == va->va_uid) {
 836         if ((vmode & VOWN) == 0) {
 837             vmode &= S_IRWXU;
 838             if ((vmode & va->va_mode) != vmode)
 839                 return(EACCES);
 840         }
 841         return(0);
 842     }
 843
 844     /*
 845      * If VSVTX is set only the owner may access the file.  This bit is
 846      * typically set for VDELETE checks on files in sticky directories
 847      * when the user does not own the directory.  Note that other V bits
 848      * are not typically set (for deletions we usually just care about
 849      * the directory permissions, not the file permissions).
 850      *
 851      * The effect on VDELETE checks is thus to not allow the deletion
 852      * of the file, and otherwise allow it.
 853      */
 854     if (vmode & VSVTX)
 855         return(EACCES);
 856
 857     /*
 858      * Check group perms
 859      */
 860     vmode &= S_IRWXU;
 861     vmode >>= 3;
 862     for (i = 0; i < cred->cr_ngroups; ++i) {
 863         if (va->va_gid == cred->cr_groups[i]) {
 864             if ((vmode & va->va_mode) != vmode)
 865                 return(EACCES);
 866             return(0);
 867         }
 868     }
 869
 870     /*
 871      * Check world perms
 872      */
 873     vmode >>= 3;
 874     if ((vmode & va->va_mode) != vmode)
 875         return(EACCES);
 876     return(0);
 877 }
 878