Get rid of the weird FSMID update path in the vnode and namecache code.
[dragonfly.git] / sys / kern / vfs_cache.c
1 /*
2  * Copyright (c) 2003,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  * Copyright (c) 1989, 1993, 1995
35  *      The Regents of the University of California.  All rights reserved.
36  *
37  * This code is derived from software contributed to Berkeley by
38  * Poul-Henning Kamp of the FreeBSD Project.
39  *
40  * Redistribution and use in source and binary forms, with or without
41  * modification, are permitted provided that the following conditions
42  * are met:
43  * 1. Redistributions of source code must retain the above copyright
44  *    notice, this list of conditions and the following disclaimer.
45  * 2. Redistributions in binary form must reproduce the above copyright
46  *    notice, this list of conditions and the following disclaimer in the
47  *    documentation and/or other materials provided with the distribution.
48  * 3. All advertising materials mentioning features or use of this software
49  *    must display the following acknowledgement:
50  *      This product includes software developed by the University of
51  *      California, Berkeley and its contributors.
52  * 4. Neither the name of the University nor the names of its contributors
53  *    may be used to endorse or promote products derived from this software
54  *    without specific prior written permission.
55  *
56  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
57  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
58  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
59  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
60  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
61  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
62  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
63  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
64  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
65  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
66  * SUCH DAMAGE.
67  *
68  *      @(#)vfs_cache.c 8.5 (Berkeley) 3/22/95
69  * $FreeBSD: src/sys/kern/vfs_cache.c,v 1.42.2.6 2001/10/05 20:07:03 dillon Exp $
70  * $DragonFly: src/sys/kern/vfs_cache.c,v 1.64 2006/04/25 22:11:28 dillon Exp $
71  */
72
73 #include <sys/param.h>
74 #include <sys/systm.h>
75 #include <sys/kernel.h>
76 #include <sys/sysctl.h>
77 #include <sys/mount.h>
78 #include <sys/vnode.h>
79 #include <sys/malloc.h>
80 #include <sys/sysproto.h>
81 #include <sys/proc.h>
82 #include <sys/namei.h>
83 #include <sys/nlookup.h>
84 #include <sys/filedesc.h>
85 #include <sys/fnv_hash.h>
86 #include <sys/globaldata.h>
87 #include <sys/kern_syscall.h>
88 #include <sys/dirent.h>
89 #include <ddb/ddb.h>
90
91 /*
92  * Random lookups in the cache are accomplished with a hash table using
93  * a hash key of (nc_src_vp, name).
94  *
95  * Negative entries may exist and correspond to structures where nc_vp
96  * is NULL.  In a negative entry, NCF_WHITEOUT will be set if the entry
97  * corresponds to a whited-out directory entry (verses simply not finding the
98  * entry at all).
99  *
100  * Upon reaching the last segment of a path, if the reference is for DELETE,
101  * or NOCACHE is set (rewrite), and the name is located in the cache, it
102  * will be dropped.
103  */
104
105 /*
106  * Structures associated with name cacheing.
107  */
108 #define NCHHASH(hash)   (&nchashtbl[(hash) & nchash])
109 #define MINNEG          1024
110
111 MALLOC_DEFINE(M_VFSCACHE, "vfscache", "VFS name cache entries");
112
113 static LIST_HEAD(nchashhead, namecache) *nchashtbl;     /* Hash Table */
114 static struct namecache_list    ncneglist;              /* instead of vnode */
115
116 /*
117  * ncvp_debug - debug cache_fromvp().  This is used by the NFS server
118  * to create the namecache infrastructure leading to a dangling vnode.
119  *
120  * 0    Only errors are reported
121  * 1    Successes are reported
122  * 2    Successes + the whole directory scan is reported
123  * 3    Force the directory scan code run as if the parent vnode did not
124  *      have a namecache record, even if it does have one.
125  */
126 static int      ncvp_debug;
127 SYSCTL_INT(_debug, OID_AUTO, ncvp_debug, CTLFLAG_RW, &ncvp_debug, 0, "");
128
129 static u_long   nchash;                 /* size of hash table */
130 SYSCTL_ULONG(_debug, OID_AUTO, nchash, CTLFLAG_RD, &nchash, 0, "");
131
132 static u_long   ncnegfactor = 16;       /* ratio of negative entries */
133 SYSCTL_ULONG(_debug, OID_AUTO, ncnegfactor, CTLFLAG_RW, &ncnegfactor, 0, "");
134
135 static int      nclockwarn;             /* warn on locked entries in ticks */
136 SYSCTL_INT(_debug, OID_AUTO, nclockwarn, CTLFLAG_RW, &nclockwarn, 0, "");
137
138 static u_long   numneg;         /* number of cache entries allocated */
139 SYSCTL_ULONG(_debug, OID_AUTO, numneg, CTLFLAG_RD, &numneg, 0, "");
140
141 static u_long   numcache;               /* number of cache entries allocated */
142 SYSCTL_ULONG(_debug, OID_AUTO, numcache, CTLFLAG_RD, &numcache, 0, "");
143
144 static u_long   numunres;               /* number of unresolved entries */
145 SYSCTL_ULONG(_debug, OID_AUTO, numunres, CTLFLAG_RD, &numunres, 0, "");
146
147 SYSCTL_INT(_debug, OID_AUTO, vnsize, CTLFLAG_RD, 0, sizeof(struct vnode), "");
148 SYSCTL_INT(_debug, OID_AUTO, ncsize, CTLFLAG_RD, 0, sizeof(struct namecache), "");
149
150 static int cache_resolve_mp(struct namecache *ncp);
151 static void cache_rehash(struct namecache *ncp);
152
153 /*
154  * The new name cache statistics
155  */
156 SYSCTL_NODE(_vfs, OID_AUTO, cache, CTLFLAG_RW, 0, "Name cache statistics");
157 #define STATNODE(mode, name, var) \
158         SYSCTL_ULONG(_vfs_cache, OID_AUTO, name, mode, var, 0, "");
159 STATNODE(CTLFLAG_RD, numneg, &numneg);
160 STATNODE(CTLFLAG_RD, numcache, &numcache);
161 static u_long numcalls; STATNODE(CTLFLAG_RD, numcalls, &numcalls);
162 static u_long dothits; STATNODE(CTLFLAG_RD, dothits, &dothits);
163 static u_long dotdothits; STATNODE(CTLFLAG_RD, dotdothits, &dotdothits);
164 static u_long numchecks; STATNODE(CTLFLAG_RD, numchecks, &numchecks);
165 static u_long nummiss; STATNODE(CTLFLAG_RD, nummiss, &nummiss);
166 static u_long nummisszap; STATNODE(CTLFLAG_RD, nummisszap, &nummisszap);
167 static u_long numposzaps; STATNODE(CTLFLAG_RD, numposzaps, &numposzaps);
168 static u_long numposhits; STATNODE(CTLFLAG_RD, numposhits, &numposhits);
169 static u_long numnegzaps; STATNODE(CTLFLAG_RD, numnegzaps, &numnegzaps);
170 static u_long numneghits; STATNODE(CTLFLAG_RD, numneghits, &numneghits);
171
172 struct nchstats nchstats[SMP_MAXCPU];
173 /*
174  * Export VFS cache effectiveness statistics to user-land.
175  *
176  * The statistics are left for aggregation to user-land so
177  * neat things can be achieved, like observing per-CPU cache
178  * distribution.
179  */
180 static int
181 sysctl_nchstats(SYSCTL_HANDLER_ARGS)
182 {
183         struct globaldata *gd;
184         int i, error;
185
186         error = 0;
187         for (i = 0; i < ncpus; ++i) {
188                 gd = globaldata_find(i);
189                 if ((error = SYSCTL_OUT(req, (void *)&(*gd->gd_nchstats),
190                         sizeof(struct nchstats))))
191                         break;
192         }
193
194         return (error);
195 }
196 SYSCTL_PROC(_vfs_cache, OID_AUTO, nchstats, CTLTYPE_OPAQUE|CTLFLAG_RD,
197   0, 0, sysctl_nchstats, "S,nchstats", "VFS cache effectiveness statistics");
198
199 static void cache_zap(struct namecache *ncp);
200
201 /*
202  * cache_hold() and cache_drop() prevent the premature deletion of a
203  * namecache entry but do not prevent operations (such as zapping) on
204  * that namecache entry.
205  */
206 static __inline
207 struct namecache *
208 _cache_hold(struct namecache *ncp)
209 {
210         ++ncp->nc_refs;
211         return(ncp);
212 }
213
214 /*
215  * When dropping an entry, if only one ref remains and the entry has not
216  * been resolved, zap it.  Since the one reference is being dropped the
217  * entry had better not be locked.
218  */
219 static __inline
220 void
221 _cache_drop(struct namecache *ncp)
222 {
223         KKASSERT(ncp->nc_refs > 0);
224         if (ncp->nc_refs == 1 && 
225             (ncp->nc_flag & NCF_UNRESOLVED) && 
226             TAILQ_EMPTY(&ncp->nc_list)
227         ) {
228                 KKASSERT(ncp->nc_exlocks == 0);
229                 cache_lock(ncp);
230                 cache_zap(ncp);
231         } else {
232                 --ncp->nc_refs;
233         }
234 }
235
236 /*
237  * Link a new namecache entry to its parent.  Be careful to avoid races
238  * if vhold() blocks in the future.
239  *
240  * If we are creating a child under an oldapi parent we must mark the
241  * child as being an oldapi entry as well.
242  */
243 static void
244 cache_link_parent(struct namecache *ncp, struct namecache *par)
245 {
246         KKASSERT(ncp->nc_parent == NULL);
247         ncp->nc_parent = par;
248         if (TAILQ_EMPTY(&par->nc_list)) {
249                 TAILQ_INSERT_HEAD(&par->nc_list, ncp, nc_entry);
250                 /*
251                  * Any vp associated with an ncp which has children must
252                  * be held to prevent it from being recycled.
253                  */
254                 if (par->nc_vp)
255                         vhold(par->nc_vp);
256         } else {
257                 TAILQ_INSERT_HEAD(&par->nc_list, ncp, nc_entry);
258         }
259 }
260
261 /*
262  * Remove the parent association from a namecache structure.  If this is
263  * the last child of the parent the cache_drop(par) will attempt to
264  * recursively zap the parent.
265  */
266 static void
267 cache_unlink_parent(struct namecache *ncp)
268 {
269         struct namecache *par;
270
271         if ((par = ncp->nc_parent) != NULL) {
272                 ncp->nc_parent = NULL;
273                 par = cache_hold(par);
274                 TAILQ_REMOVE(&par->nc_list, ncp, nc_entry);
275                 if (par->nc_vp && TAILQ_EMPTY(&par->nc_list))
276                         vdrop(par->nc_vp);
277                 cache_drop(par);
278         }
279 }
280
281 /*
282  * Allocate a new namecache structure.  Most of the code does not require
283  * zero-termination of the string but it makes vop_compat_ncreate() easier.
284  */
285 static struct namecache *
286 cache_alloc(int nlen)
287 {
288         struct namecache *ncp;
289
290         ncp = malloc(sizeof(*ncp), M_VFSCACHE, M_WAITOK|M_ZERO);
291         if (nlen)
292                 ncp->nc_name = malloc(nlen + 1, M_VFSCACHE, M_WAITOK);
293         ncp->nc_nlen = nlen;
294         ncp->nc_flag = NCF_UNRESOLVED;
295         ncp->nc_error = ENOTCONN;       /* needs to be resolved */
296         ncp->nc_refs = 1;
297
298         /*
299          * Construct a fake FSMID based on the time of day and a 32 bit
300          * roller for uniqueness.  This is used to generate a useful
301          * FSMID for filesystems which do not support it.
302          */
303         ncp->nc_fsmid = cache_getnewfsmid();
304         TAILQ_INIT(&ncp->nc_list);
305         cache_lock(ncp);
306         return(ncp);
307 }
308
309 static void
310 cache_free(struct namecache *ncp)
311 {
312         KKASSERT(ncp->nc_refs == 1 && ncp->nc_exlocks == 1);
313         if (ncp->nc_name)
314                 free(ncp->nc_name, M_VFSCACHE);
315         free(ncp, M_VFSCACHE);
316 }
317
318 /*
319  * Ref and deref a namecache structure.
320  */
321 struct namecache *
322 cache_hold(struct namecache *ncp)
323 {
324         return(_cache_hold(ncp));
325 }
326
327 void
328 cache_drop(struct namecache *ncp)
329 {
330         _cache_drop(ncp);
331 }
332
333 /*
334  * Namespace locking.  The caller must already hold a reference to the
335  * namecache structure in order to lock/unlock it.  This function prevents
336  * the namespace from being created or destroyed by accessors other then
337  * the lock holder.
338  *
339  * Note that holding a locked namecache structure prevents other threads
340  * from making namespace changes (e.g. deleting or creating), prevents
341  * vnode association state changes by other threads, and prevents the
342  * namecache entry from being resolved or unresolved by other threads.
343  *
344  * The lock owner has full authority to associate/disassociate vnodes
345  * and resolve/unresolve the locked ncp.
346  *
347  * WARNING!  Holding a locked ncp will prevent a vnode from being destroyed
348  * or recycled, but it does NOT help you if the vnode had already initiated
349  * a recyclement.  If this is important, use cache_get() rather then 
350  * cache_lock() (and deal with the differences in the way the refs counter
351  * is handled).  Or, alternatively, make an unconditional call to 
352  * cache_validate() or cache_resolve() after cache_lock() returns.
353  */
354 void
355 cache_lock(struct namecache *ncp)
356 {
357         thread_t td;
358         int didwarn;
359
360         KKASSERT(ncp->nc_refs != 0);
361         didwarn = 0;
362         td = curthread;
363
364         for (;;) {
365                 if (ncp->nc_exlocks == 0) {
366                         ncp->nc_exlocks = 1;
367                         ncp->nc_locktd = td;
368                         /* 
369                          * The vp associated with a locked ncp must be held
370                          * to prevent it from being recycled (which would
371                          * cause the ncp to become unresolved).
372                          *
373                          * WARNING!  If VRECLAIMED is set the vnode could
374                          * already be in the middle of a recycle.  Callers
375                          * should not assume that nc_vp is usable when
376                          * not NULL.  cache_vref() or cache_vget() must be
377                          * called.
378                          *
379                          * XXX loop on race for later MPSAFE work.
380                          */
381                         if (ncp->nc_vp)
382                                 vhold(ncp->nc_vp);
383                         break;
384                 }
385                 if (ncp->nc_locktd == td) {
386                         ++ncp->nc_exlocks;
387                         break;
388                 }
389                 ncp->nc_flag |= NCF_LOCKREQ;
390                 if (tsleep(ncp, 0, "clock", nclockwarn) == EWOULDBLOCK) {
391                         if (didwarn)
392                                 continue;
393                         didwarn = 1;
394                         printf("[diagnostic] cache_lock: blocked on %p", ncp);
395                         if ((ncp->nc_flag & NCF_MOUNTPT) && ncp->nc_mount)
396                             printf(" [MOUNTFROM %s]\n", ncp->nc_mount->mnt_stat.f_mntfromname);
397                         else
398                             printf(" \"%*.*s\"\n",
399                                 ncp->nc_nlen, ncp->nc_nlen,
400                                 ncp->nc_name);
401                 }
402         }
403
404         if (didwarn == 1) {
405                 printf("[diagnostic] cache_lock: unblocked %*.*s\n",
406                         ncp->nc_nlen, ncp->nc_nlen, ncp->nc_name);
407         }
408 }
409
410 int
411 cache_lock_nonblock(struct namecache *ncp)
412 {
413         thread_t td;
414
415         KKASSERT(ncp->nc_refs != 0);
416         td = curthread;
417         if (ncp->nc_exlocks == 0) {
418                 ncp->nc_exlocks = 1;
419                 ncp->nc_locktd = td;
420                 /* 
421                  * The vp associated with a locked ncp must be held
422                  * to prevent it from being recycled (which would
423                  * cause the ncp to become unresolved).
424                  *
425                  * WARNING!  If VRECLAIMED is set the vnode could
426                  * already be in the middle of a recycle.  Callers
427                  * should not assume that nc_vp is usable when
428                  * not NULL.  cache_vref() or cache_vget() must be
429                  * called.
430                  *
431                  * XXX loop on race for later MPSAFE work.
432                  */
433                 if (ncp->nc_vp)
434                         vhold(ncp->nc_vp);
435                 return(0);
436         } else {
437                 return(EWOULDBLOCK);
438         }
439 }
440
441 void
442 cache_unlock(struct namecache *ncp)
443 {
444         thread_t td = curthread;
445
446         KKASSERT(ncp->nc_refs > 0);
447         KKASSERT(ncp->nc_exlocks > 0);
448         KKASSERT(ncp->nc_locktd == td);
449         if (--ncp->nc_exlocks == 0) {
450                 if (ncp->nc_vp)
451                         vdrop(ncp->nc_vp);
452                 ncp->nc_locktd = NULL;
453                 if (ncp->nc_flag & NCF_LOCKREQ) {
454                         ncp->nc_flag &= ~NCF_LOCKREQ;
455                         wakeup(ncp);
456                 }
457         }
458 }
459
460 /*
461  * ref-and-lock, unlock-and-deref functions.
462  *
463  * This function is primarily used by nlookup.  Even though cache_lock
464  * holds the vnode, it is possible that the vnode may have already
465  * initiated a recyclement.  We want cache_get() to return a definitively
466  * usable vnode or a definitively unresolved ncp.
467  */
468 struct namecache *
469 cache_get(struct namecache *ncp)
470 {
471         _cache_hold(ncp);
472         cache_lock(ncp);
473         if (ncp->nc_vp && (ncp->nc_vp->v_flag & VRECLAIMED))
474                 cache_setunresolved(ncp);
475         return(ncp);
476 }
477
478 int
479 cache_get_nonblock(struct namecache *ncp)
480 {
481         /* XXX MP */
482         if (ncp->nc_exlocks == 0 || ncp->nc_locktd == curthread) {
483                 _cache_hold(ncp);
484                 cache_lock(ncp);
485                 if (ncp->nc_vp && (ncp->nc_vp->v_flag & VRECLAIMED))
486                         cache_setunresolved(ncp);
487                 return(0);
488         }
489         return(EWOULDBLOCK);
490 }
491
492 void
493 cache_put(struct namecache *ncp)
494 {
495         cache_unlock(ncp);
496         _cache_drop(ncp);
497 }
498
499 /*
500  * Resolve an unresolved ncp by associating a vnode with it.  If the
501  * vnode is NULL, a negative cache entry is created.
502  *
503  * The ncp should be locked on entry and will remain locked on return.
504  */
505 void
506 cache_setvp(struct namecache *ncp, struct vnode *vp)
507 {
508         KKASSERT(ncp->nc_flag & NCF_UNRESOLVED);
509         ncp->nc_vp = vp;
510         if (vp != NULL) {
511                 /*
512                  * Any vp associated with an ncp which has children must
513                  * be held.  Any vp associated with a locked ncp must be held.
514                  */
515                 if (!TAILQ_EMPTY(&ncp->nc_list))
516                         vhold(vp);
517                 TAILQ_INSERT_HEAD(&vp->v_namecache, ncp, nc_vnode);
518                 if (ncp->nc_exlocks)
519                         vhold(vp);
520
521                 /*
522                  * Set auxillary flags
523                  */
524                 switch(vp->v_type) {
525                 case VDIR:
526                         ncp->nc_flag |= NCF_ISDIR;
527                         break;
528                 case VLNK:
529                         ncp->nc_flag |= NCF_ISSYMLINK;
530                         /* XXX cache the contents of the symlink */
531                         break;
532                 default:
533                         break;
534                 }
535                 ++numcache;
536                 ncp->nc_error = 0;
537         } else {
538                 TAILQ_INSERT_TAIL(&ncneglist, ncp, nc_vnode);
539                 ++numneg;
540                 ncp->nc_error = ENOENT;
541         }
542         ncp->nc_flag &= ~NCF_UNRESOLVED;
543 }
544
545 void
546 cache_settimeout(struct namecache *ncp, int nticks)
547 {
548         if ((ncp->nc_timeout = ticks + nticks) == 0)
549                 ncp->nc_timeout = 1;
550 }
551
552 /*
553  * Disassociate the vnode or negative-cache association and mark a
554  * namecache entry as unresolved again.  Note that the ncp is still
555  * left in the hash table and still linked to its parent.
556  *
557  * The ncp should be locked and refd on entry and will remain locked and refd
558  * on return.
559  *
560  * This routine is normally never called on a directory containing children.
561  * However, NFS often does just that in its rename() code as a cop-out to
562  * avoid complex namespace operations.  This disconnects a directory vnode
563  * from its namecache and can cause the OLDAPI and NEWAPI to get out of
564  * sync.
565  *
566  * NOTE: NCF_FSMID must be cleared so a refurbishment of the ncp, such as
567  * in a create, properly propogates flag up the chain.
568  */
569 void
570 cache_setunresolved(struct namecache *ncp)
571 {
572         struct vnode *vp;
573
574         if ((ncp->nc_flag & NCF_UNRESOLVED) == 0) {
575                 ncp->nc_flag |= NCF_UNRESOLVED;
576                 ncp->nc_timeout = 0;
577                 ncp->nc_error = ENOTCONN;
578                 ++numunres;
579                 if ((vp = ncp->nc_vp) != NULL) {
580                         --numcache;
581                         ncp->nc_vp = NULL;
582                         TAILQ_REMOVE(&vp->v_namecache, ncp, nc_vnode);
583
584                         /*
585                          * Any vp associated with an ncp with children is
586                          * held by that ncp.  Any vp associated with a locked
587                          * ncp is held by that ncp.  These conditions must be
588                          * undone when the vp is cleared out from the ncp.
589                          */
590                         if (ncp->nc_flag & NCF_FSMID)
591                                 vupdatefsmid(vp);
592                         if (!TAILQ_EMPTY(&ncp->nc_list))
593                                 vdrop(vp);
594                         if (ncp->nc_exlocks)
595                                 vdrop(vp);
596                 } else {
597                         TAILQ_REMOVE(&ncneglist, ncp, nc_vnode);
598                         --numneg;
599                 }
600                 ncp->nc_flag &= ~(NCF_WHITEOUT|NCF_ISDIR|NCF_ISSYMLINK|
601                                   NCF_FSMID);
602         }
603 }
604
605 /*
606  * Invalidate portions of the namecache topology given a starting entry.
607  * The passed ncp is set to an unresolved state and:
608  *
609  * The passed ncp must be locked.
610  *
611  * CINV_DESTROY         - Set a flag in the passed ncp entry indicating
612  *                        that the physical underlying nodes have been 
613  *                        destroyed... as in deleted.  For example, when
614  *                        a directory is removed.  This will cause record
615  *                        lookups on the name to no longer be able to find
616  *                        the record and tells the resolver to return failure
617  *                        rather then trying to resolve through the parent.
618  *
619  *                        The topology itself, including ncp->nc_name,
620  *                        remains intact.
621  *
622  *                        This only applies to the passed ncp, if CINV_CHILDREN
623  *                        is specified the children are not flagged.
624  *
625  * CINV_CHILDREN        - Set all children (recursively) to an unresolved
626  *                        state as well.
627  *
628  *                        Note that this will also have the side effect of
629  *                        cleaning out any unreferenced nodes in the topology
630  *                        from the leaves up as the recursion backs out.
631  *
632  * Note that the topology for any referenced nodes remains intact.
633  *
634  * It is possible for cache_inval() to race a cache_resolve(), meaning that
635  * the namecache entry may not actually be invalidated on return if it was
636  * revalidated while recursing down into its children.  This code guarentees
637  * that the node(s) will go through an invalidation cycle, but does not 
638  * guarentee that they will remain in an invalidated state. 
639  *
640  * Returns non-zero if a revalidation was detected during the invalidation
641  * recursion, zero otherwise.  Note that since only the original ncp is
642  * locked the revalidation ultimately can only indicate that the original ncp
643  * *MIGHT* no have been reresolved.
644  */
645 int
646 cache_inval(struct namecache *ncp, int flags)
647 {
648         struct namecache *kid;
649         struct namecache *nextkid;
650         int rcnt = 0;
651
652         KKASSERT(ncp->nc_exlocks);
653
654         cache_setunresolved(ncp);
655         if (flags & CINV_DESTROY)
656                 ncp->nc_flag |= NCF_DESTROYED;
657
658         if ((flags & CINV_CHILDREN) && 
659             (kid = TAILQ_FIRST(&ncp->nc_list)) != NULL
660         ) {
661                 cache_hold(kid);
662                 cache_unlock(ncp);
663                 while (kid) {
664                         if ((nextkid = TAILQ_NEXT(kid, nc_entry)) != NULL)
665                                 cache_hold(nextkid);
666                         if ((kid->nc_flag & NCF_UNRESOLVED) == 0 ||
667                             TAILQ_FIRST(&kid->nc_list)
668                         ) {
669                                 cache_lock(kid);
670                                 rcnt += cache_inval(kid, flags & ~CINV_DESTROY);
671                                 cache_unlock(kid);
672                         }
673                         cache_drop(kid);
674                         kid = nextkid;
675                 }
676                 cache_lock(ncp);
677         }
678
679         /*
680          * Someone could have gotten in there while ncp was unlocked,
681          * retry if so.
682          */
683         if ((ncp->nc_flag & NCF_UNRESOLVED) == 0)
684                 ++rcnt;
685         return (rcnt);
686 }
687
688 /*
689  * Invalidate a vnode's namecache associations.  To avoid races against
690  * the resolver we do not invalidate a node which we previously invalidated
691  * but which was then re-resolved while we were in the invalidation loop.
692  *
693  * Returns non-zero if any namecache entries remain after the invalidation
694  * loop completed.
695  *
696  * NOTE: unlike the namecache topology which guarentees that ncp's will not
697  * be ripped out of the topology while held, the vnode's v_namecache list
698  * has no such restriction.  NCP's can be ripped out of the list at virtually
699  * any time if not locked, even if held.
700  */
701 int
702 cache_inval_vp(struct vnode *vp, int flags)
703 {
704         struct namecache *ncp;
705         struct namecache *next;
706
707 restart:
708         ncp = TAILQ_FIRST(&vp->v_namecache);
709         if (ncp)
710                 cache_hold(ncp);
711         while (ncp) {
712                 /* loop entered with ncp held */
713                 if ((next = TAILQ_NEXT(ncp, nc_vnode)) != NULL)
714                         cache_hold(next);
715                 cache_lock(ncp);
716                 if (ncp->nc_vp != vp) {
717                         printf("Warning: cache_inval_vp: race-A detected on "
718                                 "%s\n", ncp->nc_name);
719                         cache_put(ncp);
720                         if (next)
721                                 cache_drop(next);
722                         goto restart;
723                 }
724                 cache_inval(ncp, flags);
725                 cache_put(ncp);         /* also releases reference */
726                 ncp = next;
727                 if (ncp && ncp->nc_vp != vp) {
728                         printf("Warning: cache_inval_vp: race-B detected on "
729                                 "%s\n", ncp->nc_name);
730                         cache_drop(ncp);
731                         goto restart;
732                 }
733         }
734         return(TAILQ_FIRST(&vp->v_namecache) != NULL);
735 }
736
737 /*
738  * The source ncp has been renamed to the target ncp.  Both fncp and tncp
739  * must be locked.  Both will be set to unresolved, any children of tncp
740  * will be disconnected (the prior contents of the target is assumed to be
741  * destroyed by the rename operation, e.g. renaming over an empty directory),
742  * and all children of fncp will be moved to tncp.
743  *
744  * XXX the disconnection could pose a problem, check code paths to make
745  * sure any code that blocks can handle the parent being changed out from
746  * under it.  Maybe we should lock the children (watch out for deadlocks) ?
747  *
748  * After we return the caller has the option of calling cache_setvp() if
749  * the vnode of the new target ncp is known.
750  *
751  * Any process CD'd into any of the children will no longer be able to ".."
752  * back out.  An rm -rf can cause this situation to occur.
753  */
754 void
755 cache_rename(struct namecache *fncp, struct namecache *tncp)
756 {
757         struct namecache *scan;
758         int didwarn = 0;
759
760         cache_setunresolved(fncp);
761         cache_setunresolved(tncp);
762         while (cache_inval(tncp, CINV_CHILDREN) != 0) {
763                 if (didwarn++ % 10 == 0) {
764                         printf("Warning: cache_rename: race during "
765                                 "rename %s->%s\n",
766                                 fncp->nc_name, tncp->nc_name);
767                 }
768                 tsleep(tncp, 0, "mvrace", hz / 10);
769                 cache_setunresolved(tncp);
770         }
771         while ((scan = TAILQ_FIRST(&fncp->nc_list)) != NULL) {
772                 cache_hold(scan);
773                 cache_unlink_parent(scan);
774                 cache_link_parent(scan, tncp);
775                 if (scan->nc_flag & NCF_HASHED)
776                         cache_rehash(scan);
777                 cache_drop(scan);
778         }
779 }
780
781 /*
782  * vget the vnode associated with the namecache entry.  Resolve the namecache
783  * entry if necessary and deal with namecache/vp races.  The passed ncp must
784  * be referenced and may be locked.  The ncp's ref/locking state is not 
785  * effected by this call.
786  *
787  * lk_type may be LK_SHARED, LK_EXCLUSIVE.  A ref'd, possibly locked
788  * (depending on the passed lk_type) will be returned in *vpp with an error
789  * of 0, or NULL will be returned in *vpp with a non-0 error code.  The
790  * most typical error is ENOENT, meaning that the ncp represents a negative
791  * cache hit and there is no vnode to retrieve, but other errors can occur
792  * too.
793  *
794  * The main race we have to deal with are namecache zaps.  The ncp itself
795  * will not disappear since it is referenced, and it turns out that the
796  * validity of the vp pointer can be checked simply by rechecking the
797  * contents of ncp->nc_vp.
798  */
799 int
800 cache_vget(struct namecache *ncp, struct ucred *cred,
801            int lk_type, struct vnode **vpp)
802 {
803         struct vnode *vp;
804         int error;
805
806 again:
807         vp = NULL;
808         if (ncp->nc_flag & NCF_UNRESOLVED) {
809                 cache_lock(ncp);
810                 error = cache_resolve(ncp, cred);
811                 cache_unlock(ncp);
812         } else {
813                 error = 0;
814         }
815         if (error == 0 && (vp = ncp->nc_vp) != NULL) {
816                 /*
817                  * Accessing the vnode from the namecache is a bit 
818                  * dangerous.  Because there are no refs on the vnode, it
819                  * could be in the middle of a reclaim.
820                  */
821                 if (vp->v_flag & VRECLAIMED) {
822                         printf("Warning: vnode reclaim race detected in cache_vget on %p (%s)\n", vp, ncp->nc_name);
823                         cache_lock(ncp);
824                         cache_setunresolved(ncp);
825                         cache_unlock(ncp);
826                         goto again;
827                 }
828                 error = vget(vp, lk_type, curthread);
829                 if (error) {
830                         if (vp != ncp->nc_vp)
831                                 goto again;
832                         vp = NULL;
833                 } else if (vp != ncp->nc_vp) {
834                         vput(vp);
835                         goto again;
836                 } else if (vp->v_flag & VRECLAIMED) {
837                         panic("vget succeeded on a VRECLAIMED node! vp %p", vp);
838                 }
839         }
840         if (error == 0 && vp == NULL)
841                 error = ENOENT;
842         *vpp = vp;
843         return(error);
844 }
845
846 int
847 cache_vref(struct namecache *ncp, struct ucred *cred, struct vnode **vpp)
848 {
849         struct vnode *vp;
850         int error;
851
852 again:
853         vp = NULL;
854         if (ncp->nc_flag & NCF_UNRESOLVED) {
855                 cache_lock(ncp);
856                 error = cache_resolve(ncp, cred);
857                 cache_unlock(ncp);
858         } else {
859                 error = 0;
860         }
861         if (error == 0 && (vp = ncp->nc_vp) != NULL) {
862                 /*
863                  * Since we did not obtain any locks, a cache zap 
864                  * race can occur here if the vnode is in the middle
865                  * of being reclaimed and has not yet been able to
866                  * clean out its cache node.  If that case occurs,
867                  * we must lock and unresolve the cache, then loop
868                  * to retry.
869                  */
870                 if (vp->v_flag & VRECLAIMED) {
871                         printf("Warning: vnode reclaim race detected on cache_vref %p (%s)\n", vp, ncp->nc_name);
872                         cache_lock(ncp);
873                         cache_setunresolved(ncp);
874                         cache_unlock(ncp);
875                         goto again;
876                 }
877                 vref(vp);
878         }
879         if (error == 0 && vp == NULL)
880                 error = ENOENT;
881         *vpp = vp;
882         return(error);
883 }
884
885 /*
886  * Recursively set the FSMID update flag for namecache nodes leading
887  * to root.  This will cause the next getattr or reclaim to increment the
888  * fsmid and mark the inode for lazy updating.
889  *
890  * Stop recursing when we hit a node whos NCF_FSMID flag is already set.
891  * This makes FSMIDs work in an Einsteinian fashion - where the observation
892  * effects the result.  In this case a program monitoring a higher level
893  * node will have detected some prior change and started its scan (clearing
894  * NCF_FSMID in higher level nodes), but since it has not yet observed the
895  * node where we find NCF_FSMID still set, we can safely make the related
896  * modification without interfering with the theorized program.
897  *
898  * This also means that FSMIDs cannot represent time-domain quantities
899  * in a hierarchical sense.  But the main reason for doing it this way
900  * is to reduce the amount of recursion that occurs in the critical path
901  * when e.g. a program is writing to a file that sits deep in a directory
902  * hierarchy.
903  */
904 void
905 cache_update_fsmid(struct namecache *ncp)
906 {
907         struct vnode *vp;
908         struct namecache *scan;
909
910         /*
911          * Warning: even if we get a non-NULL vp it could still be in the
912          * middle of a recyclement.  Don't do anything fancy, just set
913          * NCF_FSMID.
914          */
915         if ((vp = ncp->nc_vp) != NULL) {
916                 TAILQ_FOREACH(ncp, &vp->v_namecache, nc_vnode) {
917                         for (scan = ncp; scan; scan = scan->nc_parent) {
918                                 if (scan->nc_flag & NCF_FSMID)
919                                         break;
920                                 scan->nc_flag |= NCF_FSMID;
921                         }
922                 }
923         } else {
924                 while (ncp && (ncp->nc_flag & NCF_FSMID) == 0) {
925                         ncp->nc_flag |= NCF_FSMID;
926                         ncp = ncp->nc_parent;
927                 }
928         }
929 }
930
931 void
932 cache_update_fsmid_vp(struct vnode *vp)
933 {
934         struct namecache *ncp;
935         struct namecache *scan;
936
937         TAILQ_FOREACH(ncp, &vp->v_namecache, nc_vnode) {
938                 for (scan = ncp; scan; scan = scan->nc_parent) {
939                         if (scan->nc_flag & NCF_FSMID)
940                                 break;
941                         scan->nc_flag |= NCF_FSMID;
942                 }
943         }
944 }
945
946 /*
947  * If getattr is called on a vnode (e.g. a stat call), the filesystem
948  * may call this routine to determine if the namecache has the hierarchical
949  * change flag set, requiring the fsmid to be updated.
950  *
951  * Since 0 indicates no support, make sure the filesystem fsmid is at least
952  * 1.
953  */
954 int
955 cache_check_fsmid_vp(struct vnode *vp, int64_t *fsmid)
956 {
957         struct namecache *ncp;
958         int changed = 0;
959
960         TAILQ_FOREACH(ncp, &vp->v_namecache, nc_vnode) {
961                 if (ncp->nc_flag & NCF_FSMID) {
962                         ncp->nc_flag &= ~NCF_FSMID;
963                         changed = 1;
964                 }
965         }
966         if (*fsmid == 0)
967                 ++*fsmid;
968         if (changed)
969                 ++*fsmid;
970         return(changed);
971 }
972
973 /*
974  * Convert a directory vnode to a namecache record without any other 
975  * knowledge of the topology.  This ONLY works with directory vnodes and
976  * is ONLY used by the NFS server.  dvp must be refd but unlocked, and the
977  * returned ncp (if not NULL) will be held and unlocked.
978  *
979  * If 'makeit' is 0 and dvp has no existing namecache record, NULL is returned.
980  * If 'makeit' is 1 we attempt to track-down and create the namecache topology
981  * for dvp.  This will fail only if the directory has been deleted out from
982  * under the caller.  
983  *
984  * Callers must always check for a NULL return no matter the value of 'makeit'.
985  *
986  * To avoid underflowing the kernel stack each recursive call increments
987  * the makeit variable.
988  */
989
990 static int cache_inefficient_scan(struct namecache *ncp, struct ucred *cred,
991                                   struct vnode *dvp);
992 static int cache_fromdvp_try(struct vnode *dvp, struct ucred *cred, 
993                                   struct vnode **saved_dvp);
994
995 struct namecache *
996 cache_fromdvp(struct vnode *dvp, struct ucred *cred, int makeit)
997 {
998         struct namecache *ncp;
999         struct vnode *saved_dvp;
1000         struct vnode *pvp;
1001         int error;
1002
1003         ncp = NULL;
1004         saved_dvp = NULL;
1005
1006         /*
1007          * Temporary debugging code to force the directory scanning code
1008          * to be exercised.
1009          */
1010         if (ncvp_debug >= 3 && makeit && TAILQ_FIRST(&dvp->v_namecache)) {
1011                 ncp = TAILQ_FIRST(&dvp->v_namecache);
1012                 printf("cache_fromdvp: forcing %s\n", ncp->nc_name);
1013                 goto force;
1014         }
1015
1016         /*
1017          * Loop until resolution, inside code will break out on error.
1018          */
1019         while ((ncp = TAILQ_FIRST(&dvp->v_namecache)) == NULL && makeit) {
1020 force:
1021                 /*
1022                  * If dvp is the root of its filesystem it should already
1023                  * have a namecache pointer associated with it as a side 
1024                  * effect of the mount, but it may have been disassociated.
1025                  */
1026                 if (dvp->v_flag & VROOT) {
1027                         ncp = cache_get(dvp->v_mount->mnt_ncp);
1028                         error = cache_resolve_mp(ncp);
1029                         cache_put(ncp);
1030                         if (ncvp_debug) {
1031                                 printf("cache_fromdvp: resolve root of mount %p error %d", 
1032                                         dvp->v_mount, error);
1033                         }
1034                         if (error) {
1035                                 if (ncvp_debug)
1036                                         printf(" failed\n");
1037                                 ncp = NULL;
1038                                 break;
1039                         }
1040                         if (ncvp_debug)
1041                                 printf(" succeeded\n");
1042                         continue;
1043                 }
1044
1045                 /*
1046                  * If we are recursed too deeply resort to an O(n^2)
1047                  * algorithm to resolve the namecache topology.  The
1048                  * resolved pvp is left referenced in saved_dvp to
1049                  * prevent the tree from being destroyed while we loop.
1050                  */
1051                 if (makeit > 20) {
1052                         error = cache_fromdvp_try(dvp, cred, &saved_dvp);
1053                         if (error) {
1054                                 printf("lookupdotdot(longpath) failed %d "
1055                                        "dvp %p\n", error, dvp);
1056                                 break;
1057                         }
1058                         continue;
1059                 }
1060
1061                 /*
1062                  * Get the parent directory and resolve its ncp.
1063                  */
1064                 error = vop_nlookupdotdot(*dvp->v_ops, dvp, &pvp, cred);
1065                 if (error) {
1066                         printf("lookupdotdot failed %d dvp %p\n", error, dvp);
1067                         break;
1068                 }
1069                 VOP_UNLOCK(pvp, 0, curthread);
1070
1071                 /*
1072                  * Reuse makeit as a recursion depth counter.
1073                  */
1074                 ncp = cache_fromdvp(pvp, cred, makeit + 1);
1075                 vrele(pvp);
1076                 if (ncp == NULL)
1077                         break;
1078
1079                 /*
1080                  * Do an inefficient scan of pvp (embodied by ncp) to look
1081                  * for dvp.  This will create a namecache record for dvp on
1082                  * success.  We loop up to recheck on success.
1083                  *
1084                  * ncp and dvp are both held but not locked.
1085                  */
1086                 error = cache_inefficient_scan(ncp, cred, dvp);
1087                 cache_drop(ncp);
1088                 if (error) {
1089                         printf("cache_fromdvp: scan %p (%s) failed on dvp=%p\n",
1090                                 pvp, ncp->nc_name, dvp);
1091                         ncp = NULL;
1092                         break;
1093                 }
1094                 if (ncvp_debug) {
1095                         printf("cache_fromdvp: scan %p (%s) succeeded\n",
1096                                 pvp, ncp->nc_name);
1097                 }
1098         }
1099         if (ncp)
1100                 cache_hold(ncp);
1101         if (saved_dvp)
1102                 vrele(saved_dvp);
1103         return (ncp);
1104 }
1105
1106 /*
1107  * Go up the chain of parent directories until we find something
1108  * we can resolve into the namecache.  This is very inefficient.
1109  */
1110 static
1111 int
1112 cache_fromdvp_try(struct vnode *dvp, struct ucred *cred,
1113                   struct vnode **saved_dvp)
1114 {
1115         struct namecache *ncp;
1116         struct vnode *pvp;
1117         int error;
1118         static time_t last_fromdvp_report;
1119
1120         /*
1121          * Loop getting the parent directory vnode until we get something we
1122          * can resolve in the namecache.
1123          */
1124         vref(dvp);
1125         for (;;) {
1126                 error = vop_nlookupdotdot(*dvp->v_ops, dvp, &pvp, cred);
1127                 if (error) {
1128                         vrele(dvp);
1129                         return (error);
1130                 }
1131                 VOP_UNLOCK(pvp, 0, curthread);
1132                 if ((ncp = TAILQ_FIRST(&pvp->v_namecache)) != NULL) {
1133                         cache_hold(ncp);
1134                         vrele(pvp);
1135                         break;
1136                 }
1137                 if (pvp->v_flag & VROOT) {
1138                         ncp = cache_get(pvp->v_mount->mnt_ncp);
1139                         error = cache_resolve_mp(ncp);
1140                         cache_unlock(ncp);
1141                         vrele(pvp);
1142                         if (error) {
1143                                 cache_drop(ncp);
1144                                 vrele(dvp);
1145                                 return (error);
1146                         }
1147                         break;
1148                 }
1149                 vrele(dvp);
1150                 dvp = pvp;
1151         }
1152         if (last_fromdvp_report != time_second) {
1153                 last_fromdvp_report = time_second;
1154                 printf("Warning: extremely inefficient path resolution on %s\n",
1155                         ncp->nc_name);
1156         }
1157         error = cache_inefficient_scan(ncp, cred, dvp);
1158
1159         /*
1160          * Hopefully dvp now has a namecache record associated with it.
1161          * Leave it referenced to prevent the kernel from recycling the
1162          * vnode.  Otherwise extremely long directory paths could result
1163          * in endless recycling.
1164          */
1165         if (*saved_dvp)
1166             vrele(*saved_dvp);
1167         *saved_dvp = dvp;
1168         return (error);
1169 }
1170
1171
1172 /*
1173  * Do an inefficient scan of the directory represented by ncp looking for
1174  * the directory vnode dvp.  ncp must be held but not locked on entry and
1175  * will be held on return.  dvp must be refd but not locked on entry and
1176  * will remain refd on return.
1177  *
1178  * Why do this at all?  Well, due to its stateless nature the NFS server
1179  * converts file handles directly to vnodes without necessarily going through
1180  * the namecache ops that would otherwise create the namecache topology
1181  * leading to the vnode.  We could either (1) Change the namecache algorithms
1182  * to allow disconnect namecache records that are re-merged opportunistically,
1183  * or (2) Make the NFS server backtrack and scan to recover a connected
1184  * namecache topology in order to then be able to issue new API lookups.
1185  *
1186  * It turns out that (1) is a huge mess.  It takes a nice clean set of 
1187  * namecache algorithms and introduces a lot of complication in every subsystem
1188  * that calls into the namecache to deal with the re-merge case, especially
1189  * since we are using the namecache to placehold negative lookups and the
1190  * vnode might not be immediately assigned. (2) is certainly far less
1191  * efficient then (1), but since we are only talking about directories here
1192  * (which are likely to remain cached), the case does not actually run all
1193  * that often and has the supreme advantage of not polluting the namecache
1194  * algorithms.
1195  */
1196 static int
1197 cache_inefficient_scan(struct namecache *ncp, struct ucred *cred, 
1198                        struct vnode *dvp)
1199 {
1200         struct nlcomponent nlc;
1201         struct namecache *rncp;
1202         struct dirent *den;
1203         struct vnode *pvp;
1204         struct vattr vat;
1205         struct iovec iov;
1206         struct uio uio;
1207         int blksize;
1208         int eofflag;
1209         int bytes;
1210         char *rbuf;
1211         int error;
1212
1213         vat.va_blocksize = 0;
1214         if ((error = VOP_GETATTR(dvp, &vat, curthread)) != 0)
1215                 return (error);
1216         if ((error = cache_vget(ncp, cred, LK_SHARED, &pvp)) != 0)
1217                 return (error);
1218         if (ncvp_debug)
1219                 printf("inefficient_scan: directory iosize %ld vattr fileid = %ld\n", vat.va_blocksize, (long)vat.va_fileid);
1220         if ((blksize = vat.va_blocksize) == 0)
1221                 blksize = DEV_BSIZE;
1222         rbuf = malloc(blksize, M_TEMP, M_WAITOK);
1223         rncp = NULL;
1224
1225         eofflag = 0;
1226         uio.uio_offset = 0;
1227 again:
1228         iov.iov_base = rbuf;
1229         iov.iov_len = blksize;
1230         uio.uio_iov = &iov;
1231         uio.uio_iovcnt = 1;
1232         uio.uio_resid = blksize;
1233         uio.uio_segflg = UIO_SYSSPACE;
1234         uio.uio_rw = UIO_READ;
1235         uio.uio_td = curthread;
1236
1237         if (ncvp_debug >= 2)
1238                 printf("cache_inefficient_scan: readdir @ %08x\n", (int)uio.uio_offset);
1239         error = VOP_READDIR(pvp, &uio, cred, &eofflag, NULL, NULL);
1240         if (error == 0) {
1241                 den = (struct dirent *)rbuf;
1242                 bytes = blksize - uio.uio_resid;
1243
1244                 while (bytes > 0) {
1245                         if (ncvp_debug >= 2) {
1246                                 printf("cache_inefficient_scan: %*.*s\n",
1247                                         den->d_namlen, den->d_namlen, 
1248                                         den->d_name);
1249                         }
1250                         if (den->d_type != DT_WHT &&
1251                             den->d_ino == vat.va_fileid) {
1252                                 if (ncvp_debug) {
1253                                         printf("cache_inefficient_scan: "
1254                                                "MATCHED inode %ld path %s/%*.*s\n",
1255                                                vat.va_fileid, ncp->nc_name,
1256                                                den->d_namlen, den->d_namlen,
1257                                                den->d_name);
1258                                 }
1259                                 nlc.nlc_nameptr = den->d_name;
1260                                 nlc.nlc_namelen = den->d_namlen;
1261                                 VOP_UNLOCK(pvp, 0, curthread);
1262                                 rncp = cache_nlookup(ncp, &nlc);
1263                                 KKASSERT(rncp != NULL);
1264                                 break;
1265                         }
1266                         bytes -= _DIRENT_DIRSIZ(den);
1267                         den = _DIRENT_NEXT(den);
1268                 }
1269                 if (rncp == NULL && eofflag == 0 && uio.uio_resid != blksize)
1270                         goto again;
1271         }
1272         if (rncp) {
1273                 vrele(pvp);
1274                 if (rncp->nc_flag & NCF_UNRESOLVED) {
1275                         cache_setvp(rncp, dvp);
1276                         if (ncvp_debug >= 2) {
1277                                 printf("cache_inefficient_scan: setvp %s/%s = %p\n",
1278                                         ncp->nc_name, rncp->nc_name, dvp);
1279                         }
1280                 } else {
1281                         if (ncvp_debug >= 2) {
1282                                 printf("cache_inefficient_scan: setvp %s/%s already set %p/%p\n", 
1283                                         ncp->nc_name, rncp->nc_name, dvp,
1284                                         rncp->nc_vp);
1285                         }
1286                 }
1287                 if (rncp->nc_vp == NULL)
1288                         error = rncp->nc_error;
1289                 cache_put(rncp);
1290         } else {
1291                 printf("cache_inefficient_scan: dvp %p NOT FOUND in %s\n",
1292                         dvp, ncp->nc_name);
1293                 vput(pvp);
1294                 error = ENOENT;
1295         }
1296         free(rbuf, M_TEMP);
1297         return (error);
1298 }
1299
1300 /*
1301  * Zap a namecache entry.  The ncp is unconditionally set to an unresolved
1302  * state, which disassociates it from its vnode or ncneglist.
1303  *
1304  * Then, if there are no additional references to the ncp and no children,
1305  * the ncp is removed from the topology and destroyed.  This function will
1306  * also run through the nc_parent chain and destroy parent ncps if possible.
1307  * As a side benefit, it turns out the only conditions that allow running
1308  * up the chain are also the conditions to ensure no deadlock will occur.
1309  *
1310  * References and/or children may exist if the ncp is in the middle of the
1311  * topology, preventing the ncp from being destroyed.
1312  *
1313  * This function must be called with the ncp held and locked and will unlock
1314  * and drop it during zapping.
1315  */
1316 static void
1317 cache_zap(struct namecache *ncp)
1318 {
1319         struct namecache *par;
1320
1321         /*
1322          * Disassociate the vnode or negative cache ref and set NCF_UNRESOLVED.
1323          */
1324         cache_setunresolved(ncp);
1325
1326         /*
1327          * Try to scrap the entry and possibly tail-recurse on its parent.
1328          * We only scrap unref'd (other then our ref) unresolved entries,
1329          * we do not scrap 'live' entries.
1330          */
1331         while (ncp->nc_flag & NCF_UNRESOLVED) {
1332                 /*
1333                  * Someone other then us has a ref, stop.
1334                  */
1335                 if (ncp->nc_refs > 1)
1336                         goto done;
1337
1338                 /*
1339                  * We have children, stop.
1340                  */
1341                 if (!TAILQ_EMPTY(&ncp->nc_list))
1342                         goto done;
1343
1344                 /*
1345                  * Remove ncp from the topology: hash table and parent linkage.
1346                  */
1347                 if (ncp->nc_flag & NCF_HASHED) {
1348                         ncp->nc_flag &= ~NCF_HASHED;
1349                         LIST_REMOVE(ncp, nc_hash);
1350                 }
1351                 if ((par = ncp->nc_parent) != NULL) {
1352                         par = cache_hold(par);
1353                         TAILQ_REMOVE(&par->nc_list, ncp, nc_entry);
1354                         ncp->nc_parent = NULL;
1355                         if (par->nc_vp && TAILQ_EMPTY(&par->nc_list))
1356                                 vdrop(par->nc_vp);
1357                 }
1358
1359                 /*
1360                  * ncp should not have picked up any refs.  Physically
1361                  * destroy the ncp.
1362                  */
1363                 KKASSERT(ncp->nc_refs == 1);
1364                 --numunres;
1365                 /* cache_unlock(ncp) not required */
1366                 ncp->nc_refs = -1;      /* safety */
1367                 if (ncp->nc_name)
1368                         free(ncp->nc_name, M_VFSCACHE);
1369                 free(ncp, M_VFSCACHE);
1370
1371                 /*
1372                  * Loop on the parent (it may be NULL).  Only bother looping
1373                  * if the parent has a single ref (ours), which also means
1374                  * we can lock it trivially.
1375                  */
1376                 ncp = par;
1377                 if (ncp == NULL)
1378                         return;
1379                 if (ncp->nc_refs != 1) {
1380                         cache_drop(ncp);
1381                         return;
1382                 }
1383                 KKASSERT(par->nc_exlocks == 0);
1384                 cache_lock(ncp);
1385         }
1386 done:
1387         cache_unlock(ncp);
1388         --ncp->nc_refs;
1389 }
1390
1391 static enum { CHI_LOW, CHI_HIGH } cache_hysteresis_state = CHI_LOW;
1392
1393 static __inline
1394 void
1395 cache_hysteresis(void)
1396 {
1397         /*
1398          * Don't cache too many negative hits.  We use hysteresis to reduce
1399          * the impact on the critical path.
1400          */
1401         switch(cache_hysteresis_state) {
1402         case CHI_LOW:
1403                 if (numneg > MINNEG && numneg * ncnegfactor > numcache) {
1404                         cache_cleanneg(10);
1405                         cache_hysteresis_state = CHI_HIGH;
1406                 }
1407                 break;
1408         case CHI_HIGH:
1409                 if (numneg > MINNEG * 9 / 10 && 
1410                     numneg * ncnegfactor * 9 / 10 > numcache
1411                 ) {
1412                         cache_cleanneg(10);
1413                 } else {
1414                         cache_hysteresis_state = CHI_LOW;
1415                 }
1416                 break;
1417         }
1418 }
1419
1420 /*
1421  * NEW NAMECACHE LOOKUP API
1422  *
1423  * Lookup an entry in the cache.  A locked, referenced, non-NULL 
1424  * entry is *always* returned, even if the supplied component is illegal.
1425  * The resulting namecache entry should be returned to the system with
1426  * cache_put() or cache_unlock() + cache_drop().
1427  *
1428  * namecache locks are recursive but care must be taken to avoid lock order
1429  * reversals.
1430  *
1431  * Nobody else will be able to manipulate the associated namespace (e.g.
1432  * create, delete, rename, rename-target) until the caller unlocks the
1433  * entry.
1434  *
1435  * The returned entry will be in one of three states:  positive hit (non-null
1436  * vnode), negative hit (null vnode), or unresolved (NCF_UNRESOLVED is set).
1437  * Unresolved entries must be resolved through the filesystem to associate the
1438  * vnode and/or determine whether a positive or negative hit has occured.
1439  *
1440  * It is not necessary to lock a directory in order to lock namespace under
1441  * that directory.  In fact, it is explicitly not allowed to do that.  A
1442  * directory is typically only locked when being created, renamed, or
1443  * destroyed.
1444  *
1445  * The directory (par) may be unresolved, in which case any returned child
1446  * will likely also be marked unresolved.  Likely but not guarenteed.  Since
1447  * the filesystem lookup requires a resolved directory vnode the caller is
1448  * responsible for resolving the namecache chain top-down.  This API 
1449  * specifically allows whole chains to be created in an unresolved state.
1450  */
1451 struct namecache *
1452 cache_nlookup(struct namecache *par, struct nlcomponent *nlc)
1453 {
1454         struct namecache *ncp;
1455         struct namecache *new_ncp;
1456         struct nchashhead *nchpp;
1457         u_int32_t hash;
1458         globaldata_t gd;
1459
1460         numcalls++;
1461         gd = mycpu;
1462
1463         /*
1464          * Try to locate an existing entry
1465          */
1466         hash = fnv_32_buf(nlc->nlc_nameptr, nlc->nlc_namelen, FNV1_32_INIT);
1467         hash = fnv_32_buf(&par, sizeof(par), hash);
1468         new_ncp = NULL;
1469 restart:
1470         LIST_FOREACH(ncp, (NCHHASH(hash)), nc_hash) {
1471                 numchecks++;
1472
1473                 /*
1474                  * Zap entries that have timed out.
1475                  */
1476                 if (ncp->nc_timeout && 
1477                     (int)(ncp->nc_timeout - ticks) < 0 &&
1478                     (ncp->nc_flag & NCF_UNRESOLVED) == 0 &&
1479                     ncp->nc_exlocks == 0
1480                 ) {
1481                         cache_zap(cache_get(ncp));
1482                         goto restart;
1483                 }
1484
1485                 /*
1486                  * Break out if we find a matching entry.  Note that
1487                  * UNRESOLVED entries may match, but DESTROYED entries
1488                  * do not.
1489                  */
1490                 if (ncp->nc_parent == par &&
1491                     ncp->nc_nlen == nlc->nlc_namelen &&
1492                     bcmp(ncp->nc_name, nlc->nlc_nameptr, ncp->nc_nlen) == 0 &&
1493                     (ncp->nc_flag & NCF_DESTROYED) == 0
1494                 ) {
1495                         if (cache_get_nonblock(ncp) == 0) {
1496                                 if (new_ncp)
1497                                         cache_free(new_ncp);
1498                                 goto found;
1499                         }
1500                         cache_get(ncp);
1501                         cache_put(ncp);
1502                         goto restart;
1503                 }
1504         }
1505
1506         /*
1507          * We failed to locate an entry, create a new entry and add it to
1508          * the cache.  We have to relookup after possibly blocking in
1509          * malloc.
1510          */
1511         if (new_ncp == NULL) {
1512                 new_ncp = cache_alloc(nlc->nlc_namelen);
1513                 goto restart;
1514         }
1515
1516         ncp = new_ncp;
1517
1518         /*
1519          * Initialize as a new UNRESOLVED entry, lock (non-blocking),
1520          * and link to the parent.  The mount point is usually inherited
1521          * from the parent unless this is a special case such as a mount
1522          * point where nlc_namelen is 0.  The caller is responsible for
1523          * setting nc_mount in that case.  If nlc_namelen is 0 nc_name will
1524          * be NULL.
1525          */
1526         if (nlc->nlc_namelen) {
1527                 bcopy(nlc->nlc_nameptr, ncp->nc_name, nlc->nlc_namelen);
1528                 ncp->nc_name[nlc->nlc_namelen] = 0;
1529                 ncp->nc_mount = par->nc_mount;
1530         }
1531         nchpp = NCHHASH(hash);
1532         LIST_INSERT_HEAD(nchpp, ncp, nc_hash);
1533         ncp->nc_flag |= NCF_HASHED;
1534         cache_link_parent(ncp, par);
1535 found:
1536         /*
1537          * stats and namecache size management
1538          */
1539         if (ncp->nc_flag & NCF_UNRESOLVED)
1540                 ++gd->gd_nchstats->ncs_miss;
1541         else if (ncp->nc_vp)
1542                 ++gd->gd_nchstats->ncs_goodhits;
1543         else
1544                 ++gd->gd_nchstats->ncs_neghits;
1545         cache_hysteresis();
1546         return(ncp);
1547 }
1548
1549 /*
1550  * Given a locked ncp, validate that the vnode, if present, is actually
1551  * usable.  If it is not usable set the ncp to an unresolved state.
1552  */
1553 void
1554 cache_validate(struct namecache *ncp)
1555 {
1556         if ((ncp->nc_flag & NCF_UNRESOLVED) == 0) {
1557                 if (ncp->nc_vp && (ncp->nc_vp->v_flag & VRECLAIMED))
1558                         cache_setunresolved(ncp);
1559         }
1560 }
1561
1562 /*
1563  * Resolve an unresolved namecache entry, generally by looking it up.
1564  * The passed ncp must be locked and refd. 
1565  *
1566  * Theoretically since a vnode cannot be recycled while held, and since
1567  * the nc_parent chain holds its vnode as long as children exist, the
1568  * direct parent of the cache entry we are trying to resolve should
1569  * have a valid vnode.  If not then generate an error that we can 
1570  * determine is related to a resolver bug.
1571  *
1572  * However, if a vnode was in the middle of a recyclement when the NCP
1573  * got locked, ncp->nc_vp might point to a vnode that is about to become
1574  * invalid.  cache_resolve() handles this case by unresolving the entry
1575  * and then re-resolving it.
1576  *
1577  * Note that successful resolution does not necessarily return an error
1578  * code of 0.  If the ncp resolves to a negative cache hit then ENOENT
1579  * will be returned.
1580  */
1581 int
1582 cache_resolve(struct namecache *ncp, struct ucred *cred)
1583 {
1584         struct namecache *par;
1585         int error;
1586
1587 restart:
1588         /*
1589          * If the ncp is already resolved we have nothing to do.  However,
1590          * we do want to guarentee that a usable vnode is returned when
1591          * a vnode is present, so make sure it hasn't been reclaimed.
1592          */
1593         if ((ncp->nc_flag & NCF_UNRESOLVED) == 0) {
1594                 if (ncp->nc_vp && (ncp->nc_vp->v_flag & VRECLAIMED))
1595                         cache_setunresolved(ncp);
1596                 if ((ncp->nc_flag & NCF_UNRESOLVED) == 0)
1597                         return (ncp->nc_error);
1598         }
1599
1600         /*
1601          * Mount points need special handling because the parent does not
1602          * belong to the same filesystem as the ncp.
1603          */
1604         if (ncp->nc_flag & NCF_MOUNTPT)
1605                 return (cache_resolve_mp(ncp));
1606
1607         /*
1608          * We expect an unbroken chain of ncps to at least the mount point,
1609          * and even all the way to root (but this code doesn't have to go
1610          * past the mount point).
1611          */
1612         if (ncp->nc_parent == NULL) {
1613                 printf("EXDEV case 1 %p %*.*s\n", ncp,
1614                         ncp->nc_nlen, ncp->nc_nlen, ncp->nc_name);
1615                 ncp->nc_error = EXDEV;
1616                 return(ncp->nc_error);
1617         }
1618
1619         /*
1620          * The vp's of the parent directories in the chain are held via vhold()
1621          * due to the existance of the child, and should not disappear. 
1622          * However, there are cases where they can disappear:
1623          *
1624          *      - due to filesystem I/O errors.
1625          *      - due to NFS being stupid about tracking the namespace and
1626          *        destroys the namespace for entire directories quite often.
1627          *      - due to forced unmounts.
1628          *      - due to an rmdir (parent will be marked DESTROYED)
1629          *
1630          * When this occurs we have to track the chain backwards and resolve
1631          * it, looping until the resolver catches up to the current node.  We
1632          * could recurse here but we might run ourselves out of kernel stack
1633          * so we do it in a more painful manner.  This situation really should
1634          * not occur all that often, or if it does not have to go back too
1635          * many nodes to resolve the ncp.
1636          */
1637         while (ncp->nc_parent->nc_vp == NULL) {
1638                 /*
1639                  * This case can occur if a process is CD'd into a
1640                  * directory which is then rmdir'd.  If the parent is marked
1641                  * destroyed there is no point trying to resolve it.
1642                  */
1643                 if (ncp->nc_parent->nc_flag & NCF_DESTROYED)
1644                         return(ENOENT);
1645
1646                 par = ncp->nc_parent;
1647                 while (par->nc_parent && par->nc_parent->nc_vp == NULL)
1648                         par = par->nc_parent;
1649                 if (par->nc_parent == NULL) {
1650                         printf("EXDEV case 2 %*.*s\n",
1651                                 par->nc_nlen, par->nc_nlen, par->nc_name);
1652                         return (EXDEV);
1653                 }
1654                 printf("[diagnostic] cache_resolve: had to recurse on %*.*s\n",
1655                         par->nc_nlen, par->nc_nlen, par->nc_name);
1656                 /*
1657                  * The parent is not set in stone, ref and lock it to prevent
1658                  * it from disappearing.  Also note that due to renames it
1659                  * is possible for our ncp to move and for par to no longer
1660                  * be one of its parents.  We resolve it anyway, the loop 
1661                  * will handle any moves.
1662                  */
1663                 cache_get(par);
1664                 if (par->nc_flag & NCF_MOUNTPT) {
1665                         cache_resolve_mp(par);
1666                 } else if (par->nc_parent->nc_vp == NULL) {
1667                         printf("[diagnostic] cache_resolve: raced on %*.*s\n", par->nc_nlen, par->nc_nlen, par->nc_name);
1668                         cache_put(par);
1669                         continue;
1670                 } else if (par->nc_flag & NCF_UNRESOLVED) {
1671                         par->nc_error = VOP_NRESOLVE(par, cred);
1672                 }
1673                 if ((error = par->nc_error) != 0) {
1674                         if (par->nc_error != EAGAIN) {
1675                                 printf("EXDEV case 3 %*.*s error %d\n",
1676                                     par->nc_nlen, par->nc_nlen, par->nc_name,
1677                                     par->nc_error);
1678                                 cache_put(par);
1679                                 return(error);
1680                         }
1681                         printf("[diagnostic] cache_resolve: EAGAIN par %p %*.*s\n",
1682                                 par, par->nc_nlen, par->nc_nlen, par->nc_name);
1683                 }
1684                 cache_put(par);
1685                 /* loop */
1686         }
1687
1688         /*
1689          * Call VOP_NRESOLVE() to get the vp, then scan for any disconnected
1690          * ncp's and reattach them.  If this occurs the original ncp is marked
1691          * EAGAIN to force a relookup.
1692          *
1693          * NOTE: in order to call VOP_NRESOLVE(), the parent of the passed
1694          * ncp must already be resolved.
1695          */
1696         KKASSERT((ncp->nc_flag & NCF_MOUNTPT) == 0);
1697         ncp->nc_error = VOP_NRESOLVE(ncp, cred);
1698         /*vop_nresolve(*ncp->nc_parent->nc_vp->v_ops, ncp, cred);*/
1699         if (ncp->nc_error == EAGAIN) {
1700                 printf("[diagnostic] cache_resolve: EAGAIN ncp %p %*.*s\n",
1701                         ncp, ncp->nc_nlen, ncp->nc_nlen, ncp->nc_name);
1702                 goto restart;
1703         }
1704         return(ncp->nc_error);
1705 }
1706
1707 /*
1708  * Resolve the ncp associated with a mount point.  Such ncp's almost always
1709  * remain resolved and this routine is rarely called.  NFS MPs tends to force
1710  * re-resolution more often due to its mac-truck-smash-the-namecache
1711  * method of tracking namespace changes.
1712  *
1713  * The semantics for this call is that the passed ncp must be locked on
1714  * entry and will be locked on return.  However, if we actually have to
1715  * resolve the mount point we temporarily unlock the entry in order to
1716  * avoid race-to-root deadlocks due to e.g. dead NFS mounts.  Because of
1717  * the unlock we have to recheck the flags after we relock.
1718  */
1719 static int
1720 cache_resolve_mp(struct namecache *ncp)
1721 {
1722         struct vnode *vp;
1723         struct mount *mp = ncp->nc_mount;
1724         int error;
1725
1726         KKASSERT(mp != NULL);
1727
1728         /*
1729          * If the ncp is already resolved we have nothing to do.  However,
1730          * we do want to guarentee that a usable vnode is returned when
1731          * a vnode is present, so make sure it hasn't been reclaimed.
1732          */
1733         if ((ncp->nc_flag & NCF_UNRESOLVED) == 0) {
1734                 if (ncp->nc_vp && (ncp->nc_vp->v_flag & VRECLAIMED))
1735                         cache_setunresolved(ncp);
1736         }
1737
1738         if (ncp->nc_flag & NCF_UNRESOLVED) {
1739                 cache_unlock(ncp);
1740                 while (vfs_busy(mp, 0, curthread))
1741                         ;
1742                 error = VFS_ROOT(mp, &vp);
1743                 cache_lock(ncp);
1744
1745                 /*
1746                  * recheck the ncp state after relocking.
1747                  */
1748                 if (ncp->nc_flag & NCF_UNRESOLVED) {
1749                         ncp->nc_error = error;
1750                         if (error == 0) {
1751                                 cache_setvp(ncp, vp);
1752                                 vput(vp);
1753                         } else {
1754                                 printf("[diagnostic] cache_resolve_mp: failed to resolve mount %p\n", mp);
1755                                 cache_setvp(ncp, NULL);
1756                         }
1757                 } else if (error == 0) {
1758                         vput(vp);
1759                 }
1760                 vfs_unbusy(mp, curthread);
1761         }
1762         return(ncp->nc_error);
1763 }
1764
1765 void
1766 cache_cleanneg(int count)
1767 {
1768         struct namecache *ncp;
1769
1770         /*
1771          * Automode from the vnlru proc - clean out 10% of the negative cache
1772          * entries.
1773          */
1774         if (count == 0)
1775                 count = numneg / 10 + 1;
1776
1777         /*
1778          * Attempt to clean out the specified number of negative cache
1779          * entries.
1780          */
1781         while (count) {
1782                 ncp = TAILQ_FIRST(&ncneglist);
1783                 if (ncp == NULL) {
1784                         KKASSERT(numneg == 0);
1785                         break;
1786                 }
1787                 TAILQ_REMOVE(&ncneglist, ncp, nc_vnode);
1788                 TAILQ_INSERT_TAIL(&ncneglist, ncp, nc_vnode);
1789                 if (cache_get_nonblock(ncp) == 0)
1790                         cache_zap(ncp);
1791                 --count;
1792         }
1793 }
1794
1795 /*
1796  * Rehash a ncp.  Rehashing is typically required if the name changes (should
1797  * not generally occur) or the parent link changes.  This function will
1798  * unhash the ncp if the ncp is no longer hashable.
1799  */
1800 static void
1801 cache_rehash(struct namecache *ncp)
1802 {
1803         struct nchashhead *nchpp;
1804         u_int32_t hash;
1805
1806         if (ncp->nc_flag & NCF_HASHED) {
1807                 ncp->nc_flag &= ~NCF_HASHED;
1808                 LIST_REMOVE(ncp, nc_hash);
1809         }
1810         if (ncp->nc_nlen && ncp->nc_parent) {
1811                 hash = fnv_32_buf(ncp->nc_name, ncp->nc_nlen, FNV1_32_INIT);
1812                 hash = fnv_32_buf(&ncp->nc_parent, 
1813                                         sizeof(ncp->nc_parent), hash);
1814                 nchpp = NCHHASH(hash);
1815                 LIST_INSERT_HEAD(nchpp, ncp, nc_hash);
1816                 ncp->nc_flag |= NCF_HASHED;
1817         }
1818 }
1819
1820 /*
1821  * Name cache initialization, from vfsinit() when we are booting
1822  */
1823 void
1824 nchinit(void)
1825 {
1826         int i;
1827         globaldata_t gd;
1828
1829         /* initialise per-cpu namecache effectiveness statistics. */
1830         for (i = 0; i < ncpus; ++i) {
1831                 gd = globaldata_find(i);
1832                 gd->gd_nchstats = &nchstats[i];
1833         }
1834         TAILQ_INIT(&ncneglist);
1835         nchashtbl = hashinit(desiredvnodes*2, M_VFSCACHE, &nchash);
1836         nclockwarn = 1 * hz;
1837 }
1838
1839 /*
1840  * Called from start_init() to bootstrap the root filesystem.  Returns
1841  * a referenced, unlocked namecache record.
1842  */
1843 struct namecache *
1844 cache_allocroot(struct mount *mp, struct vnode *vp)
1845 {
1846         struct namecache *ncp = cache_alloc(0);
1847
1848         ncp->nc_flag |= NCF_MOUNTPT | NCF_ROOT;
1849         ncp->nc_mount = mp;
1850         cache_setvp(ncp, vp);
1851         return(ncp);
1852 }
1853
1854 /*
1855  * vfs_cache_setroot()
1856  *
1857  *      Create an association between the root of our namecache and
1858  *      the root vnode.  This routine may be called several times during
1859  *      booting.
1860  *
1861  *      If the caller intends to save the returned namecache pointer somewhere
1862  *      it must cache_hold() it.
1863  */
1864 void
1865 vfs_cache_setroot(struct vnode *nvp, struct namecache *ncp)
1866 {
1867         struct vnode *ovp;
1868         struct namecache *oncp;
1869
1870         ovp = rootvnode;
1871         oncp = rootncp;
1872         rootvnode = nvp;
1873         rootncp = ncp;
1874
1875         if (ovp)
1876                 vrele(ovp);
1877         if (oncp)
1878                 cache_drop(oncp);
1879 }
1880
1881 /*
1882  * XXX OLD API COMPAT FUNCTION.  This really messes up the new namecache
1883  * topology and is being removed as quickly as possible.  The new VOP_N*()
1884  * API calls are required to make specific adjustments using the supplied
1885  * ncp pointers rather then just bogusly purging random vnodes.
1886  *
1887  * Invalidate all namecache entries to a particular vnode as well as 
1888  * any direct children of that vnode in the namecache.  This is a 
1889  * 'catch all' purge used by filesystems that do not know any better.
1890  *
1891  * A new vnode v_id is generated.  Note that no vnode will ever have a
1892  * v_id of 0.
1893  *
1894  * Note that the linkage between the vnode and its namecache entries will
1895  * be removed, but the namecache entries themselves might stay put due to
1896  * active references from elsewhere in the system or due to the existance of
1897  * the children.   The namecache topology is left intact even if we do not
1898  * know what the vnode association is.  Such entries will be marked
1899  * NCF_UNRESOLVED.
1900  *
1901  * XXX: Only time and the size of v_id prevents this from failing:
1902  * XXX: In theory we should hunt down all (struct vnode*, v_id)
1903  * XXX: soft references and nuke them, at least on the global
1904  * XXX: v_id wraparound.  The period of resistance can be extended
1905  * XXX: by incrementing each vnodes v_id individually instead of
1906  * XXX: using the global v_id.
1907  */
1908 void
1909 cache_purge(struct vnode *vp)
1910 {
1911         static u_long nextid;
1912
1913         cache_inval_vp(vp, CINV_DESTROY | CINV_CHILDREN);
1914
1915         /*
1916          * Calculate a new unique id for ".." handling
1917          */
1918         do {
1919                 nextid++;
1920         } while (nextid == vp->v_id || nextid == 0);
1921         vp->v_id = nextid;
1922 }
1923
1924 /*
1925  * Flush all entries referencing a particular filesystem.
1926  *
1927  * Since we need to check it anyway, we will flush all the invalid
1928  * entries at the same time.
1929  */
1930 void
1931 cache_purgevfs(struct mount *mp)
1932 {
1933         struct nchashhead *nchpp;
1934         struct namecache *ncp, *nnp;
1935
1936         /*
1937          * Scan hash tables for applicable entries.
1938          */
1939         for (nchpp = &nchashtbl[nchash]; nchpp >= nchashtbl; nchpp--) {
1940                 ncp = LIST_FIRST(nchpp);
1941                 if (ncp)
1942                         cache_hold(ncp);
1943                 while (ncp) {
1944                         nnp = LIST_NEXT(ncp, nc_hash);
1945                         if (nnp)
1946                                 cache_hold(nnp);
1947                         if (ncp->nc_mount == mp) {
1948                                 cache_lock(ncp);
1949                                 cache_zap(ncp);
1950                         } else {
1951                                 cache_drop(ncp);
1952                         }
1953                         ncp = nnp;
1954                 }
1955         }
1956 }
1957
1958 /*
1959  * Create a new (theoretically) unique fsmid
1960  */
1961 int64_t
1962 cache_getnewfsmid(void)
1963 {
1964         static int fsmid_roller;
1965         int64_t fsmid;
1966
1967         ++fsmid_roller;
1968         fsmid = ((int64_t)time_second << 32) |
1969                         (fsmid_roller & 0x7FFFFFFF);
1970         return (fsmid);
1971 }
1972
1973
1974 static int disablecwd;
1975 SYSCTL_INT(_debug, OID_AUTO, disablecwd, CTLFLAG_RW, &disablecwd, 0, "");
1976
1977 static u_long numcwdcalls; STATNODE(CTLFLAG_RD, numcwdcalls, &numcwdcalls);
1978 static u_long numcwdfail1; STATNODE(CTLFLAG_RD, numcwdfail1, &numcwdfail1);
1979 static u_long numcwdfail2; STATNODE(CTLFLAG_RD, numcwdfail2, &numcwdfail2);
1980 static u_long numcwdfail3; STATNODE(CTLFLAG_RD, numcwdfail3, &numcwdfail3);
1981 static u_long numcwdfail4; STATNODE(CTLFLAG_RD, numcwdfail4, &numcwdfail4);
1982 static u_long numcwdfound; STATNODE(CTLFLAG_RD, numcwdfound, &numcwdfound);
1983
1984 int
1985 __getcwd(struct __getcwd_args *uap)
1986 {
1987         int buflen;
1988         int error;
1989         char *buf;
1990         char *bp;
1991
1992         if (disablecwd)
1993                 return (ENODEV);
1994
1995         buflen = uap->buflen;
1996         if (buflen < 2)
1997                 return (EINVAL);
1998         if (buflen > MAXPATHLEN)
1999                 buflen = MAXPATHLEN;
2000
2001         buf = malloc(buflen, M_TEMP, M_WAITOK);
2002         bp = kern_getcwd(buf, buflen, &error);
2003         if (error == 0)
2004                 error = copyout(bp, uap->buf, strlen(bp) + 1);
2005         free(buf, M_TEMP);
2006         return (error);
2007 }
2008
2009 char *
2010 kern_getcwd(char *buf, size_t buflen, int *error)
2011 {
2012         struct proc *p = curproc;
2013         char *bp;
2014         int i, slash_prefixed;
2015         struct filedesc *fdp;
2016         struct namecache *ncp;
2017
2018         numcwdcalls++;
2019         bp = buf;
2020         bp += buflen - 1;
2021         *bp = '\0';
2022         fdp = p->p_fd;
2023         slash_prefixed = 0;
2024
2025         ncp = fdp->fd_ncdir;
2026         while (ncp && ncp != fdp->fd_nrdir && (ncp->nc_flag & NCF_ROOT) == 0) {
2027                 if (ncp->nc_flag & NCF_MOUNTPT) {
2028                         if (ncp->nc_mount == NULL) {
2029                                 *error = EBADF;         /* forced unmount? */
2030                                 return(NULL);
2031                         }
2032                         ncp = ncp->nc_parent;
2033                         continue;
2034                 }
2035                 for (i = ncp->nc_nlen - 1; i >= 0; i--) {
2036                         if (bp == buf) {
2037                                 numcwdfail4++;
2038                                 *error = ENOMEM;
2039                                 return(NULL);
2040                         }
2041                         *--bp = ncp->nc_name[i];
2042                 }
2043                 if (bp == buf) {
2044                         numcwdfail4++;
2045                         *error = ENOMEM;
2046                         return(NULL);
2047                 }
2048                 *--bp = '/';
2049                 slash_prefixed = 1;
2050                 ncp = ncp->nc_parent;
2051         }
2052         if (ncp == NULL) {
2053                 numcwdfail2++;
2054                 *error = ENOENT;
2055                 return(NULL);
2056         }
2057         if (!slash_prefixed) {
2058                 if (bp == buf) {
2059                         numcwdfail4++;
2060                         *error = ENOMEM;
2061                         return(NULL);
2062                 }
2063                 *--bp = '/';
2064         }
2065         numcwdfound++;
2066         *error = 0;
2067         return (bp);
2068 }
2069
2070 /*
2071  * Thus begins the fullpath magic.
2072  */
2073
2074 #undef STATNODE
2075 #define STATNODE(name)                                                  \
2076         static u_int name;                                              \
2077         SYSCTL_UINT(_vfs_cache, OID_AUTO, name, CTLFLAG_RD, &name, 0, "")
2078
2079 static int disablefullpath;
2080 SYSCTL_INT(_debug, OID_AUTO, disablefullpath, CTLFLAG_RW,
2081     &disablefullpath, 0, "");
2082
2083 STATNODE(numfullpathcalls);
2084 STATNODE(numfullpathfail1);
2085 STATNODE(numfullpathfail2);
2086 STATNODE(numfullpathfail3);
2087 STATNODE(numfullpathfail4);
2088 STATNODE(numfullpathfound);
2089
2090 int
2091 cache_fullpath(struct proc *p, struct namecache *ncp, char **retbuf, char **freebuf)
2092 {
2093         char *bp, *buf;
2094         int i, slash_prefixed;
2095         struct namecache *fd_nrdir;
2096
2097         numfullpathcalls--;
2098
2099         buf = malloc(MAXPATHLEN, M_TEMP, M_WAITOK);
2100         bp = buf + MAXPATHLEN - 1;
2101         *bp = '\0';
2102         if (p != NULL)
2103                 fd_nrdir = p->p_fd->fd_nrdir;
2104         else
2105                 fd_nrdir = NULL;
2106         slash_prefixed = 0;
2107         while (ncp && ncp != fd_nrdir && (ncp->nc_flag & NCF_ROOT) == 0) {
2108                 if (ncp->nc_flag & NCF_MOUNTPT) {
2109                         if (ncp->nc_mount == NULL) {
2110                                 free(buf, M_TEMP);
2111                                 return(EBADF);
2112                         }
2113                         ncp = ncp->nc_parent;
2114                         continue;
2115                 }
2116                 for (i = ncp->nc_nlen - 1; i >= 0; i--) {
2117                         if (bp == buf) {
2118                                 numfullpathfail4++;
2119                                 free(buf, M_TEMP);
2120                                 return(ENOMEM);
2121                         }
2122                         *--bp = ncp->nc_name[i];
2123                 }
2124                 if (bp == buf) {
2125                         numfullpathfail4++;
2126                         free(buf, M_TEMP);
2127                         return(ENOMEM);
2128                 }
2129                 *--bp = '/';
2130                 slash_prefixed = 1;
2131                 ncp = ncp->nc_parent;
2132         }
2133         if (ncp == NULL) {
2134                 numfullpathfail2++;
2135                 free(buf, M_TEMP);
2136                 return(ENOENT);
2137         }
2138         if (p != NULL && (ncp->nc_flag & NCF_ROOT) && ncp != fd_nrdir) {
2139                 bp = buf + MAXPATHLEN - 1;
2140                 *bp = '\0';
2141                 slash_prefixed = 0;
2142         }
2143         if (!slash_prefixed) {
2144                 if (bp == buf) {
2145                         numfullpathfail4++;
2146                         free(buf, M_TEMP);
2147                         return(ENOMEM);
2148                 }
2149                 *--bp = '/';
2150         }
2151         numfullpathfound++;
2152         *retbuf = bp; 
2153         *freebuf = buf;
2154
2155         return(0);
2156 }
2157
2158 int
2159 vn_fullpath(struct proc *p, struct vnode *vn, char **retbuf, char **freebuf) 
2160 {
2161         struct namecache *ncp;
2162
2163         numfullpathcalls++;
2164         if (disablefullpath)
2165                 return (ENODEV);
2166
2167         if (p == NULL)
2168                 return (EINVAL);
2169
2170         /* vn is NULL, client wants us to use p->p_textvp */
2171         if (vn == NULL) {
2172                 if ((vn = p->p_textvp) == NULL)
2173                         return (EINVAL);
2174         }
2175         TAILQ_FOREACH(ncp, &vn->v_namecache, nc_vnode) {
2176                 if (ncp->nc_nlen)
2177                         break;
2178         }
2179         if (ncp == NULL)
2180                 return (EINVAL);
2181
2182         numfullpathcalls--;
2183         return(cache_fullpath(p, ncp, retbuf, freebuf));
2184 }