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