Fix a final bug in the vfs cache cleaning code. An incorrect assertion was
[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.40 2004/10/22 17:59:59 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 <ddb/ddb.h>
89
90 /*
91  * Random lookups in the cache are accomplished with a hash table using
92  * a hash key of (nc_src_vp, name).
93  *
94  * Negative entries may exist and correspond to structures where nc_vp
95  * is NULL.  In a negative entry, NCF_WHITEOUT will be set if the entry
96  * corresponds to a whited-out directory entry (verses simply not finding the
97  * entry at all).
98  *
99  * Upon reaching the last segment of a path, if the reference is for DELETE,
100  * or NOCACHE is set (rewrite), and the name is located in the cache, it
101  * will be dropped.
102  */
103
104 /*
105  * Structures associated with name cacheing.
106  */
107 #define NCHHASH(hash)   (&nchashtbl[(hash) & nchash])
108 #define MINNEG          1024
109
110 MALLOC_DEFINE(M_VFSCACHE, "vfscache", "VFS name cache entries");
111
112 static LIST_HEAD(nchashhead, namecache) *nchashtbl;     /* Hash Table */
113 static struct namecache_list    ncneglist;              /* instead of vnode */
114
115 static u_long   nchash;                 /* size of hash table */
116 SYSCTL_ULONG(_debug, OID_AUTO, nchash, CTLFLAG_RD, &nchash, 0, "");
117
118 static u_long   ncnegfactor = 16;       /* ratio of negative entries */
119 SYSCTL_ULONG(_debug, OID_AUTO, ncnegfactor, CTLFLAG_RW, &ncnegfactor, 0, "");
120
121 static u_long   numneg;         /* number of cache entries allocated */
122 SYSCTL_ULONG(_debug, OID_AUTO, numneg, CTLFLAG_RD, &numneg, 0, "");
123
124 static u_long   numcache;               /* number of cache entries allocated */
125 SYSCTL_ULONG(_debug, OID_AUTO, numcache, CTLFLAG_RD, &numcache, 0, "");
126
127 static u_long   numunres;               /* number of unresolved entries */
128 SYSCTL_ULONG(_debug, OID_AUTO, numunres, CTLFLAG_RD, &numunres, 0, "");
129
130 SYSCTL_INT(_debug, OID_AUTO, vnsize, CTLFLAG_RD, 0, sizeof(struct vnode), "");
131 SYSCTL_INT(_debug, OID_AUTO, ncsize, CTLFLAG_RD, 0, sizeof(struct namecache), "");
132
133 static int cache_resolve_mp(struct namecache *ncp);
134 static void cache_rehash(struct namecache *ncp);
135
136 /*
137  * The new name cache statistics
138  */
139 SYSCTL_NODE(_vfs, OID_AUTO, cache, CTLFLAG_RW, 0, "Name cache statistics");
140 #define STATNODE(mode, name, var) \
141         SYSCTL_ULONG(_vfs_cache, OID_AUTO, name, mode, var, 0, "");
142 STATNODE(CTLFLAG_RD, numneg, &numneg);
143 STATNODE(CTLFLAG_RD, numcache, &numcache);
144 static u_long numcalls; STATNODE(CTLFLAG_RD, numcalls, &numcalls);
145 static u_long dothits; STATNODE(CTLFLAG_RD, dothits, &dothits);
146 static u_long dotdothits; STATNODE(CTLFLAG_RD, dotdothits, &dotdothits);
147 static u_long numchecks; STATNODE(CTLFLAG_RD, numchecks, &numchecks);
148 static u_long nummiss; STATNODE(CTLFLAG_RD, nummiss, &nummiss);
149 static u_long nummisszap; STATNODE(CTLFLAG_RD, nummisszap, &nummisszap);
150 static u_long numposzaps; STATNODE(CTLFLAG_RD, numposzaps, &numposzaps);
151 static u_long numposhits; STATNODE(CTLFLAG_RD, numposhits, &numposhits);
152 static u_long numnegzaps; STATNODE(CTLFLAG_RD, numnegzaps, &numnegzaps);
153 static u_long numneghits; STATNODE(CTLFLAG_RD, numneghits, &numneghits);
154
155 struct nchstats nchstats[SMP_MAXCPU];
156 /*
157  * Export VFS cache effectiveness statistics to user-land.
158  *
159  * The statistics are left for aggregation to user-land so
160  * neat things can be achieved, like observing per-CPU cache
161  * distribution.
162  */
163 static int
164 sysctl_nchstats(SYSCTL_HANDLER_ARGS)
165 {
166         struct globaldata *gd;
167         int i, error;
168
169         error = 0;
170         for (i = 0; i < ncpus; ++i) {
171                 gd = globaldata_find(i);
172                 if ((error = SYSCTL_OUT(req, (void *)&(*gd->gd_nchstats),
173                         sizeof(struct nchstats))))
174                         break;
175         }
176
177         return (error);
178 }
179 SYSCTL_PROC(_vfs_cache, OID_AUTO, nchstats, CTLTYPE_OPAQUE|CTLFLAG_RD,
180   0, 0, sysctl_nchstats, "S,nchstats", "VFS cache effectiveness statistics");
181
182 static void cache_zap(struct namecache *ncp);
183
184 /*
185  * cache_hold() and cache_drop() prevent the premature deletion of a
186  * namecache entry but do not prevent operations (such as zapping) on
187  * that namecache entry.
188  */
189 static __inline
190 struct namecache *
191 _cache_hold(struct namecache *ncp)
192 {
193         ++ncp->nc_refs;
194         return(ncp);
195 }
196
197 /*
198  * When dropping an entry, if only one ref remains and the entry has not
199  * been resolved, zap it.  Since the one reference is being dropped the
200  * entry had better not be locked.
201  */
202 static __inline
203 void
204 _cache_drop(struct namecache *ncp)
205 {
206         KKASSERT(ncp->nc_refs > 0);
207         if (ncp->nc_refs == 1 && 
208             (ncp->nc_flag & NCF_UNRESOLVED) && 
209             TAILQ_EMPTY(&ncp->nc_list)
210         ) {
211                 KKASSERT(ncp->nc_exlocks == 0);
212                 cache_lock(ncp);
213                 cache_zap(ncp);
214         } else {
215                 --ncp->nc_refs;
216         }
217 }
218
219 /*
220  * Link a new namecache entry to its parent.  Be careful to avoid races
221  * if vhold() blocks in the future.
222  *
223  * If we are creating a child under an oldapi parent we must mark the
224  * child as being an oldapi entry as well.
225  */
226 static void
227 cache_link_parent(struct namecache *ncp, struct namecache *par)
228 {
229         KKASSERT(ncp->nc_parent == NULL);
230         ncp->nc_parent = par;
231         if (TAILQ_EMPTY(&par->nc_list)) {
232                 TAILQ_INSERT_HEAD(&par->nc_list, ncp, nc_entry);
233                 /*
234                  * Any vp associated with an ncp which has children must
235                  * be held to prevent it from being recycled.
236                  */
237                 if (par->nc_vp)
238                         vhold(par->nc_vp);
239         } else {
240                 TAILQ_INSERT_HEAD(&par->nc_list, ncp, nc_entry);
241         }
242 }
243
244 /*
245  * Remove the parent association from a namecache structure.  If this is
246  * the last child of the parent the cache_drop(par) will attempt to
247  * recursively zap the parent.
248  */
249 static void
250 cache_unlink_parent(struct namecache *ncp)
251 {
252         struct namecache *par;
253
254         if ((par = ncp->nc_parent) != NULL) {
255                 ncp->nc_parent = NULL;
256                 par = cache_hold(par);
257                 TAILQ_REMOVE(&par->nc_list, ncp, nc_entry);
258                 if (par->nc_vp && TAILQ_EMPTY(&par->nc_list))
259                         vdrop(par->nc_vp);
260                 cache_drop(par);
261         }
262 }
263
264 /*
265  * Allocate a new namecache structure.
266  */
267 static struct namecache *
268 cache_alloc(int nlen)
269 {
270         struct namecache *ncp;
271
272         ncp = malloc(sizeof(*ncp), M_VFSCACHE, M_WAITOK|M_ZERO);
273         if (nlen)
274                 ncp->nc_name = malloc(nlen, M_VFSCACHE, M_WAITOK);
275         ncp->nc_nlen = nlen;
276         ncp->nc_flag = NCF_UNRESOLVED;
277         ncp->nc_error = ENOTCONN;       /* needs to be resolved */
278         ncp->nc_refs = 1;
279         TAILQ_INIT(&ncp->nc_list);
280         cache_lock(ncp);
281         return(ncp);
282 }
283
284 static void
285 cache_free(struct namecache *ncp)
286 {
287         KKASSERT(ncp->nc_refs == 1 && ncp->nc_exlocks == 1);
288         if (ncp->nc_name)
289                 free(ncp->nc_name, M_VFSCACHE);
290         free(ncp, M_VFSCACHE);
291 }
292
293 /*
294  * Ref and deref a namecache structure.
295  */
296 struct namecache *
297 cache_hold(struct namecache *ncp)
298 {
299         return(_cache_hold(ncp));
300 }
301
302 void
303 cache_drop(struct namecache *ncp)
304 {
305         _cache_drop(ncp);
306 }
307
308 /*
309  * Namespace locking.  The caller must already hold a reference to the
310  * namecache structure in order to lock/unlock it.  This function prevents
311  * the namespace from being created or destroyed by accessors other then
312  * the lock holder.
313  *
314  * Note that holding a locked namecache structure prevents other threads
315  * from making namespace changes (e.g. deleting or creating), prevents
316  * vnode association state changes by other threads, and prevents the
317  * namecache entry from being resolved or unresolved by other threads.
318  *
319  * The lock owner has full authority to associate/disassociate vnodes
320  * and resolve/unresolve the locked ncp.
321  *
322  * In particular, if a vnode is associated with a locked cache entry
323  * that vnode will *NOT* be recycled.  We accomplish this by vhold()ing the
324  * vnode.  XXX we should find a more efficient way to prevent the vnode
325  * from being recycled, but remember that any given vnode may have multiple
326  * namecache associations (think hardlinks).
327  */
328 void
329 cache_lock(struct namecache *ncp)
330 {
331         thread_t td;
332         int didwarn;
333
334         KKASSERT(ncp->nc_refs != 0);
335         didwarn = 0;
336         td = curthread;
337
338         for (;;) {
339                 if (ncp->nc_exlocks == 0) {
340                         ncp->nc_exlocks = 1;
341                         ncp->nc_locktd = td;
342                         /* 
343                          * The vp associated with a locked ncp must be held
344                          * to prevent it from being recycled (which would
345                          * cause the ncp to become unresolved).
346                          *
347                          * XXX loop on race for later MPSAFE work.
348                          */
349                         if (ncp->nc_vp)
350                                 vhold(ncp->nc_vp);
351                         break;
352                 }
353                 if (ncp->nc_locktd == td) {
354                         ++ncp->nc_exlocks;
355                         break;
356                 }
357                 ncp->nc_flag |= NCF_LOCKREQ;
358                 if (tsleep(ncp, 0, "clock", hz) == EWOULDBLOCK) {
359                         if (didwarn)
360                                 continue;
361                         didwarn = 1;
362                         printf("[diagnostic] cache_lock: blocked on %p", ncp);
363                         if ((ncp->nc_flag & NCF_MOUNTPT) && ncp->nc_mount)
364                             printf(" [MOUNTPT %s]\n", ncp->nc_mount->mnt_stat.f_mntonname);
365                         else
366                             printf(" \"%*.*s\"\n",
367                                 ncp->nc_nlen, ncp->nc_nlen,
368                                 ncp->nc_name);
369                 }
370         }
371
372         if (didwarn == 1) {
373                 printf("[diagnostic] cache_lock: unblocked %*.*s\n",
374                         ncp->nc_nlen, ncp->nc_nlen, ncp->nc_name);
375         }
376 }
377
378 void
379 cache_unlock(struct namecache *ncp)
380 {
381         thread_t td = curthread;
382
383         KKASSERT(ncp->nc_refs > 0);
384         KKASSERT(ncp->nc_exlocks > 0);
385         KKASSERT(ncp->nc_locktd == td);
386         if (--ncp->nc_exlocks == 0) {
387                 if (ncp->nc_vp)
388                         vdrop(ncp->nc_vp);
389                 ncp->nc_locktd = NULL;
390                 if (ncp->nc_flag & NCF_LOCKREQ) {
391                         ncp->nc_flag &= ~NCF_LOCKREQ;
392                         wakeup_one(ncp);
393                 }
394         }
395 }
396
397 /*
398  * ref-and-lock, unlock-and-deref functions.
399  */
400 struct namecache *
401 cache_get(struct namecache *ncp)
402 {
403         _cache_hold(ncp);
404         cache_lock(ncp);
405         return(ncp);
406 }
407
408 int
409 cache_get_nonblock(struct namecache *ncp)
410 {
411         /* XXX MP */
412         if (ncp->nc_exlocks == 0 || ncp->nc_locktd == curthread) {
413                 _cache_hold(ncp);
414                 cache_lock(ncp);
415                 return(0);
416         }
417         return(EWOULDBLOCK);
418 }
419
420 void
421 cache_put(struct namecache *ncp)
422 {
423         cache_unlock(ncp);
424         _cache_drop(ncp);
425 }
426
427 /*
428  * Resolve an unresolved ncp by associating a vnode with it.  If the
429  * vnode is NULL, a negative cache entry is created.
430  *
431  * The ncp should be locked on entry and will remain locked on return.
432  */
433 void
434 cache_setvp(struct namecache *ncp, struct vnode *vp)
435 {
436         KKASSERT(ncp->nc_flag & NCF_UNRESOLVED);
437         ncp->nc_vp = vp;
438         if (vp != NULL) {
439                 /*
440                  * Any vp associated with an ncp which has children must
441                  * be held.  Any vp associated with a locked ncp must be held.
442                  */
443                 if (!TAILQ_EMPTY(&ncp->nc_list))
444                         vhold(vp);
445                 TAILQ_INSERT_HEAD(&vp->v_namecache, ncp, nc_vnode);
446                 if (ncp->nc_exlocks)
447                         vhold(vp);
448
449                 /*
450                  * Set auxillary flags
451                  */
452                 switch(vp->v_type) {
453                 case VDIR:
454                         ncp->nc_flag |= NCF_ISDIR;
455                         break;
456                 case VLNK:
457                         ncp->nc_flag |= NCF_ISSYMLINK;
458                         /* XXX cache the contents of the symlink */
459                         break;
460                 default:
461                         break;
462                 }
463                 ++numcache;
464                 ncp->nc_error = 0;
465         } else {
466                 TAILQ_INSERT_TAIL(&ncneglist, ncp, nc_vnode);
467                 ++numneg;
468                 ncp->nc_error = ENOENT;
469         }
470         ncp->nc_flag &= ~NCF_UNRESOLVED;
471 }
472
473 /*
474  * Disassociate the vnode or negative-cache association and mark a
475  * namecache entry as unresolved again.  Note that the ncp is still
476  * left in the hash table and still linked to its parent.
477  *
478  * The ncp should be locked and refd on entry and will remain locked and refd
479  * on return.
480  *
481  * This routine is normally never called on a directory containing children.
482  * However, NFS often does just that in its rename() code as a cop-out to
483  * avoid complex namespace operations.  This disconnects a directory vnode
484  * from its namecache and can cause the OLDAPI and NEWAPI to get out of
485  * sync.
486  */
487 void
488 cache_setunresolved(struct namecache *ncp)
489 {
490         struct vnode *vp;
491
492         if ((ncp->nc_flag & NCF_UNRESOLVED) == 0) {
493                 ncp->nc_flag |= NCF_UNRESOLVED;
494                 ncp->nc_flag &= ~(NCF_WHITEOUT|NCF_ISDIR|NCF_ISSYMLINK);
495                 ncp->nc_error = ENOTCONN;
496                 ++numunres;
497                 if ((vp = ncp->nc_vp) != NULL) {
498                         --numcache;
499                         ncp->nc_vp = NULL;      /* safety */
500                         TAILQ_REMOVE(&vp->v_namecache, ncp, nc_vnode);
501
502                         /*
503                          * Any vp associated with an ncp with children is
504                          * held by that ncp.  Any vp associated with a locked
505                          * ncp is held by that ncp.  These conditions must be
506                          * undone when the vp is cleared out from the ncp.
507                          */
508                         if (!TAILQ_EMPTY(&ncp->nc_list))
509                                 vdrop(vp);
510                         if (ncp->nc_exlocks)
511                                 vdrop(vp);
512                 } else {
513                         TAILQ_REMOVE(&ncneglist, ncp, nc_vnode);
514                         --numneg;
515                 }
516
517 #if 0
518                 if (TAILQ_FIRST(&ncp->nc_list)) {
519                         db_print_backtrace();
520                         printf("[diagnostic] cache_setunresolved() called on directory with children: %p %*.*s\n", ncp, ncp->nc_nlen, ncp->nc_nlen, ncp->nc_name);
521                 }
522 #endif
523         }
524 }
525
526 /*
527  * Invalidate portions of a namecache entry.  The passed ncp should be
528  * referenced and locked but we might not adhere to that rule during the
529  * old api -> new api transition period.
530  *
531  * CINV_PARENT          - disconnect the ncp from its parent
532  * CINV_SELF            - same as cache_setunresolved(ncp)
533  * CINV_CHILDREN        - disconnect children of the ncp from the ncp
534  */
535 void
536 cache_inval(struct namecache *ncp, int flags)
537 {
538         struct namecache *kid;
539         struct namecache *nextkid;
540
541         if (flags & CINV_SELF)
542                 cache_setunresolved(ncp);
543         if (flags & CINV_PARENT) {
544                 ncp->nc_flag |= NCF_REVALPARENT;
545                 cache_unlink_parent(ncp);
546         }
547
548         /*
549          * TEMPORARY XX old-api / rename handling.  Any unresolved or
550          * negative cache-hit children with a ref count of 0 must be
551          * recursively destroyed or this disconnection from our parent,
552          * or the childrens disconnection from us, may leave them dangling
553          * forever.
554          *
555          * In the new API it won't be possible to unlink in the middle of
556          * the topology and we will have a cache_rename() to physically
557          * move a subtree from one place to another.
558          */
559         if (flags & (CINV_PARENT|CINV_CHILDREN)) {
560                 if ((kid = TAILQ_FIRST(&ncp->nc_list)) != NULL)
561                         cache_hold(kid);
562                 while (kid) {
563                         if ((nextkid = TAILQ_NEXT(kid, nc_entry)) != NULL)
564                                 cache_hold(nextkid);
565                         if (kid->nc_refs == 0 &&
566                             ((kid->nc_flag & NCF_UNRESOLVED) || 
567                              kid->nc_vp == NULL)
568                         ) {
569                                 cache_inval(kid, CINV_PARENT);
570                         }
571                         cache_drop(kid);
572                         kid = nextkid;
573                 }
574         }
575
576         /*
577          * TEMPORARY XXX old-api / rename handling.
578          */
579         if (flags & CINV_CHILDREN) {
580                 while ((kid = TAILQ_FIRST(&ncp->nc_list)) != NULL) {
581                         kid->nc_flag |= NCF_REVALPARENT;
582                         cache_hold(kid);
583                         cache_unlink_parent(kid);
584                         cache_drop(kid);
585                 }
586         }
587 }
588
589 void
590 cache_inval_vp(struct vnode *vp, int flags)
591 {
592         struct namecache *ncp;
593
594         if (flags & CINV_SELF) {
595                 while ((ncp = TAILQ_FIRST(&vp->v_namecache)) != NULL) {
596                         cache_hold(ncp);
597                         KKASSERT((ncp->nc_flag & NCF_UNRESOLVED) == 0);
598                         cache_inval(ncp, flags);
599                         cache_drop(ncp);
600                 }
601         } else {
602                 TAILQ_FOREACH(ncp, &vp->v_namecache, nc_vnode) {
603                         cache_hold(ncp);
604                         cache_inval(ncp, flags);
605                         cache_drop(ncp);
606                 }
607         }
608 }
609
610 /*
611  * vget the vnode associated with the namecache entry.  Resolve the namecache
612  * entry if necessary and deal with namecache/vp races.  The passed ncp must
613  * be referenced and may be locked.  The ncp's ref/locking state is not 
614  * effected by this call.
615  *
616  * lk_type may be LK_SHARED, LK_EXCLUSIVE.  A ref'd, possibly locked
617  * (depending on the passed lk_type) will be returned in *vpp with an error
618  * of 0, or NULL will be returned in *vpp with a non-0 error code.  The
619  * most typical error is ENOENT, meaning that the ncp represents a negative
620  * cache hit and there is no vnode to retrieve, but other errors can occur
621  * too.
622  *
623  * The main race we have to deal with are namecache zaps.  The ncp itself
624  * will not disappear since it is referenced, and it turns out that the
625  * validity of the vp pointer can be checked simply by rechecking the
626  * contents of ncp->nc_vp.
627  */
628 int
629 cache_vget(struct namecache *ncp, struct ucred *cred,
630            int lk_type, struct vnode **vpp)
631 {
632         struct vnode *vp;
633         int error;
634
635 again:
636         vp = NULL;
637         if (ncp->nc_flag & NCF_UNRESOLVED) {
638                 cache_lock(ncp);
639                 error = cache_resolve(ncp, cred);
640                 cache_unlock(ncp);
641         } else {
642                 error = 0;
643         }
644         if (error == 0 && (vp = ncp->nc_vp) != NULL) {
645                 error = vget(vp, lk_type, curthread);
646                 if (error) {
647                         if (vp != ncp->nc_vp)   /* handle cache_zap race */
648                                 goto again;
649                         vp = NULL;
650                 } else if (vp != ncp->nc_vp) {  /* handle cache_zap race */
651                         vput(vp);
652                         goto again;
653                 }
654         }
655         if (error == 0 && vp == NULL)
656                 error = ENOENT;
657         *vpp = vp;
658         return(error);
659 }
660
661 int
662 cache_vref(struct namecache *ncp, struct ucred *cred, struct vnode **vpp)
663 {
664         struct vnode *vp;
665         int error;
666
667 again:
668         vp = NULL;
669         if (ncp->nc_flag & NCF_UNRESOLVED) {
670                 cache_lock(ncp);
671                 error = cache_resolve(ncp, cred);
672                 cache_unlock(ncp);
673         } else {
674                 error = 0;
675         }
676         if (error == 0 && (vp = ncp->nc_vp) != NULL) {
677                 vref(vp);
678                 if (vp != ncp->nc_vp) {         /* handle cache_zap race */
679                         vrele(vp);
680                         goto again;
681                 }
682         }
683         if (error == 0 && vp == NULL)
684                 error = ENOENT;
685         *vpp = vp;
686         return(error);
687 }
688
689 /*
690  * Zap a namecache entry.  The ncp is unconditionally set to an unresolved
691  * state, which disassociates it from its vnode or ncneglist.
692  *
693  * Then, if there are no additional references to the ncp and no children,
694  * the ncp is removed from the topology and destroyed.  This function will
695  * also run through the nc_parent chain and destroy parent ncps if possible.
696  * As a side benefit, it turns out the only conditions that allow running
697  * up the chain are also the conditions to ensure no deadlock will occur.
698  *
699  * References and/or children may exist if the ncp is in the middle of the
700  * topology, preventing the ncp from being destroyed.
701  *
702  * This function must be called with the ncp held and locked and will unlock
703  * and drop it during zapping.
704  */
705 static void
706 cache_zap(struct namecache *ncp)
707 {
708         struct namecache *par;
709
710         /*
711          * Disassociate the vnode or negative cache ref and set NCF_UNRESOLVED.
712          */
713         cache_setunresolved(ncp);
714
715         /*
716          * Try to scrap the entry and possibly tail-recurse on its parent.
717          * We only scrap unref'd (other then our ref) unresolved entries,
718          * we do not scrap 'live' entries.
719          */
720         while (ncp->nc_flag & NCF_UNRESOLVED) {
721                 /*
722                  * Someone other then us has a ref, stop.
723                  */
724                 if (ncp->nc_refs > 1)
725                         goto done;
726
727                 /*
728                  * We have children, stop.
729                  */
730                 if (!TAILQ_EMPTY(&ncp->nc_list))
731                         goto done;
732
733                 /*
734                  * Remove ncp from the topology: hash table and parent linkage.
735                  */
736                 if (ncp->nc_flag & NCF_HASHED) {
737                         ncp->nc_flag &= ~NCF_HASHED;
738                         LIST_REMOVE(ncp, nc_hash);
739                 }
740                 if ((par = ncp->nc_parent) != NULL) {
741                         par = cache_hold(par);
742                         TAILQ_REMOVE(&par->nc_list, ncp, nc_entry);
743                         ncp->nc_parent = NULL;
744                         if (par->nc_vp && TAILQ_EMPTY(&par->nc_list))
745                                 vdrop(par->nc_vp);
746                 }
747
748                 /*
749                  * ncp should not have picked up any refs.  Physically
750                  * destroy the ncp.
751                  */
752                 KKASSERT(ncp->nc_refs == 1);
753                 --numunres;
754                 /* cache_unlock(ncp) not required */
755                 ncp->nc_refs = -1;      /* safety */
756                 if (ncp->nc_name)
757                         free(ncp->nc_name, M_VFSCACHE);
758                 free(ncp, M_VFSCACHE);
759
760                 /*
761                  * Loop on the parent (it may be NULL).  Only bother looping
762                  * if the parent has a single ref (ours), which also means
763                  * we can lock it trivially.
764                  */
765                 ncp = par;
766                 if (ncp == NULL)
767                         return;
768                 if (ncp->nc_refs != 1) {
769                         cache_drop(ncp);
770                         return;
771                 }
772                 KKASSERT(par->nc_exlocks == 0);
773                 cache_lock(ncp);
774         }
775 done:
776         cache_unlock(ncp);
777         --ncp->nc_refs;
778 }
779
780 static enum { CHI_LOW, CHI_HIGH } cache_hysteresis_state = CHI_LOW;
781
782 static __inline
783 void
784 cache_hysteresis(void)
785 {
786         /*
787          * Don't cache too many negative hits.  We use hysteresis to reduce
788          * the impact on the critical path.
789          */
790         switch(cache_hysteresis_state) {
791         case CHI_LOW:
792                 if (numneg > MINNEG && numneg * ncnegfactor > numcache) {
793                         cache_cleanneg(10);
794                         cache_hysteresis_state = CHI_HIGH;
795                 }
796                 break;
797         case CHI_HIGH:
798                 if (numneg > MINNEG * 9 / 10 && 
799                     numneg * ncnegfactor * 9 / 10 > numcache
800                 ) {
801                         cache_cleanneg(10);
802                 } else {
803                         cache_hysteresis_state = CHI_LOW;
804                 }
805                 break;
806         }
807 }
808
809 /*
810  * NEW NAMECACHE LOOKUP API
811  *
812  * Lookup an entry in the cache.  A locked, referenced, non-NULL 
813  * entry is *always* returned, even if the supplied component is illegal.
814  * The returned namecache entry should be returned to the system with
815  * cache_put() or cache_unlock() + cache_drop().
816  *
817  * namecache locks are recursive but care must be taken to avoid lock order
818  * reversals.
819  *
820  * Nobody else will be able to manipulate the associated namespace (e.g.
821  * create, delete, rename, rename-target) until the caller unlocks the
822  * entry.
823  *
824  * The returned entry will be in one of three states:  positive hit (non-null
825  * vnode), negative hit (null vnode), or unresolved (NCF_UNRESOLVED is set).
826  * Unresolved entries must be resolved through the filesystem to associate the
827  * vnode and/or determine whether a positive or negative hit has occured.
828  *
829  * It is not necessary to lock a directory in order to lock namespace under
830  * that directory.  In fact, it is explicitly not allowed to do that.  A
831  * directory is typically only locked when being created, renamed, or
832  * destroyed.
833  *
834  * The directory (par) may be unresolved, in which case any returned child
835  * will likely also be marked unresolved.  Likely but not guarenteed.  Since
836  * the filesystem VOP_NEWLOOKUP() requires a resolved directory vnode the
837  * caller is responsible for resolving the namecache chain top-down.  This API 
838  * specifically allows whole chains to be created in an unresolved state.
839  */
840 struct namecache *
841 cache_nlookup(struct namecache *par, struct nlcomponent *nlc)
842 {
843         struct namecache *ncp;
844         struct namecache *new_ncp;
845         struct nchashhead *nchpp;
846         u_int32_t hash;
847         globaldata_t gd;
848
849         numcalls++;
850         gd = mycpu;
851
852         /*
853          * Try to locate an existing entry
854          */
855         hash = fnv_32_buf(nlc->nlc_nameptr, nlc->nlc_namelen, FNV1_32_INIT);
856         hash = fnv_32_buf(&par, sizeof(par), hash);
857         new_ncp = NULL;
858 restart:
859         LIST_FOREACH(ncp, (NCHHASH(hash)), nc_hash) {
860                 numchecks++;
861
862                 /*
863                  * Zap entries that have timed out.
864                  */
865                 if (ncp->nc_timeout && 
866                     (int)(ncp->nc_timeout - ticks) < 0 &&
867                     (ncp->nc_flag & NCF_UNRESOLVED) == 0 &&
868                     ncp->nc_exlocks == 0
869                 ) {
870                         cache_zap(cache_get(ncp));
871                         goto restart;
872                 }
873
874                 /*
875                  * Break out if we find a matching entry.  Note that
876                  * UNRESOLVED entries may match.
877                  */
878                 if (ncp->nc_parent == par &&
879                     ncp->nc_nlen == nlc->nlc_namelen &&
880                     bcmp(ncp->nc_name, nlc->nlc_nameptr, ncp->nc_nlen) == 0
881                 ) {
882                         if (cache_get_nonblock(ncp) == 0) {
883                                 if (new_ncp)
884                                         cache_free(new_ncp);
885                                 goto found;
886                         }
887                         cache_get(ncp);
888                         cache_put(ncp);
889                         goto restart;
890                 }
891         }
892
893         /*
894          * We failed to locate an entry, create a new entry and add it to
895          * the cache.  We have to relookup after possibly blocking in
896          * malloc.
897          */
898         if (new_ncp == NULL) {
899                 new_ncp = cache_alloc(nlc->nlc_namelen);
900                 goto restart;
901         }
902
903         ncp = new_ncp;
904
905         /*
906          * Initialize as a new UNRESOLVED entry, lock (non-blocking),
907          * and link to the parent.
908          */
909         bcopy(nlc->nlc_nameptr, ncp->nc_name, nlc->nlc_namelen);
910         nchpp = NCHHASH(hash);
911         LIST_INSERT_HEAD(nchpp, ncp, nc_hash);
912         ncp->nc_flag |= NCF_HASHED;
913         cache_link_parent(ncp, par);
914 found:
915         cache_hysteresis();
916         return(ncp);
917 }
918
919 /*
920  * Resolve an unresolved namecache entry, generally by looking it up.
921  * The passed ncp must be locked and refd. 
922  *
923  * Theoretically since a vnode cannot be recycled while held, and since
924  * the nc_parent chain holds its vnode as long as children exist, the
925  * direct parent of the cache entry we are trying to resolve should
926  * have a valid vnode.  If not then generate an error that we can 
927  * determine is related to a resolver bug.
928  */
929 int
930 cache_resolve(struct namecache *ncp, struct ucred *cred)
931 {
932         struct namecache *par;
933         struct namecache *scan;
934         int error;
935
936 restart:
937         /*
938          * If the ncp is already resolved we have nothing to do.
939          */
940         if ((ncp->nc_flag & NCF_UNRESOLVED) == 0)
941                 return (ncp->nc_error);
942
943         /*
944          * Mount points need special handling because the parent does not
945          * belong to the same filesystem as the ncp.
946          */
947         if (ncp->nc_flag & NCF_MOUNTPT)
948                 return (cache_resolve_mp(ncp));
949
950         /*
951          * We expect an unbroken chain of ncps to at least the mount point,
952          * and even all the way to root (but this code doesn't have to go
953          * past the mount point).
954          */
955         if (ncp->nc_parent == NULL) {
956                 printf("EXDEV case 1 %p %*.*s\n", ncp,
957                         ncp->nc_nlen, ncp->nc_nlen, ncp->nc_name);
958                 ncp->nc_error = EXDEV;
959                 return(ncp->nc_error);
960         }
961
962         /*
963          * The vp's of the parent directories in the chain are held via vhold()
964          * due to the existance of the child, and should not disappear. 
965          * However, there are cases where they can disappear:
966          *
967          *      - due to filesystem I/O errors.
968          *      - due to NFS being stupid about tracking the namespace and
969          *        destroys the namespace for entire directories quite often.
970          *      - due to forced unmounts.
971          *
972          * When this occurs we have to track the chain backwards and resolve
973          * it, looping until the resolver catches up to the current node.  We
974          * could recurse here but we might run ourselves out of kernel stack
975          * so we do it in a more painful manner.  This situation really should
976          * not occur all that often, or if it does not have to go back too
977          * many nodes to resolve the ncp.
978          */
979         while (ncp->nc_parent->nc_vp == NULL) {
980                 par = ncp->nc_parent;
981                 while (par->nc_parent && par->nc_parent->nc_vp == NULL)
982                         par = par->nc_parent;
983                 if (par->nc_parent == NULL) {
984                         printf("EXDEV case 2 %*.*s\n",
985                                 par->nc_nlen, par->nc_nlen, par->nc_name);
986                         return (EXDEV);
987                 }
988                 printf("[diagnostic] cache_resolve: had to recurse on %*.*s\n",
989                         par->nc_nlen, par->nc_nlen, par->nc_name);
990                 /*
991                  * The parent is not set in stone, ref and lock it to prevent
992                  * it from disappearing.  Also note that due to renames it
993                  * is possible for our ncp to move and for par to no longer
994                  * be one of its parents.  We resolve it anyway, the loop 
995                  * will handle any moves.
996                  */
997                 cache_get(par);
998                 if (par->nc_flag & NCF_MOUNTPT) {
999                         cache_resolve_mp(par);
1000                 } else if (par->nc_parent->nc_vp == NULL) {
1001                         printf("[diagnostic] cache_resolve: raced on %*.*s\n", par->nc_nlen, par->nc_nlen, par->nc_name);
1002                         cache_put(par);
1003                         continue;
1004                 } else {
1005                         par->nc_error = 
1006                             vop_resolve(par->nc_parent->nc_vp->v_ops, par, cred);
1007                 }
1008                 if ((error = par->nc_error) != 0) {
1009                         if (par->nc_error != EAGAIN) {
1010                                 printf("EXDEV case 3 %*.*s error %d\n",
1011                                     par->nc_nlen, par->nc_nlen, par->nc_name,
1012                                     par->nc_error);
1013                                 cache_put(par);
1014                                 return(error);
1015                         }
1016                         printf("[diagnostic] cache_resolve: EAGAIN par %p %*.*s\n",
1017                                 par, par->nc_nlen, par->nc_nlen, par->nc_name);
1018                 }
1019                 cache_put(par);
1020                 /* loop */
1021         }
1022
1023         /*
1024          * Call vop_resolve() to get the vp, then scan for any disconnected
1025          * ncp's and reattach them.  If this occurs the original ncp is marked
1026          * EAGAIN to force a relookup.
1027          */
1028         KKASSERT((ncp->nc_flag & NCF_MOUNTPT) == 0);
1029         ncp->nc_error = vop_resolve(ncp->nc_parent->nc_vp->v_ops, ncp, cred);
1030         if (ncp->nc_error == EAGAIN) {
1031                 printf("[diagnostic] cache_resolve: EAGAIN ncp %p %*.*s\n",
1032                         ncp, ncp->nc_nlen, ncp->nc_nlen, ncp->nc_name);
1033                 goto restart;
1034         }
1035         if (ncp->nc_error == 0) {
1036                 TAILQ_FOREACH(scan, &ncp->nc_vp->v_namecache, nc_vnode) {
1037                         if (scan != ncp && (scan->nc_flag & NCF_REVALPARENT)) {
1038                                 cache_hold(scan);
1039                                 cache_link_parent(scan, ncp->nc_parent);
1040                                 cache_unlink_parent(ncp);
1041                                 scan->nc_flag &= ~NCF_REVALPARENT;
1042                                 ncp->nc_error = EAGAIN;
1043                                 if (scan->nc_flag & NCF_HASHED)
1044                                         cache_rehash(scan);
1045                                 printf("[diagnostic] cache_resolve: relinked %*.*s\n", scan->nc_nlen, scan->nc_nlen, scan->nc_name);
1046                                 cache_drop(scan);
1047                                 break;
1048                         }
1049                 }
1050         }
1051         return(ncp->nc_error);
1052 }
1053
1054 /*
1055  * Resolve the ncp associated with a mount point.  Such ncp's almost always
1056  * remain resolved and this routine is rarely called.  NFS MPs tends to force
1057  * re-resolution more often due to its mac-truck-smash-the-namecache
1058  * method of tracking namespace changes.
1059  *
1060  * The passed ncp must be locked.
1061  */
1062 static int
1063 cache_resolve_mp(struct namecache *ncp)
1064 {
1065         struct vnode *vp;
1066         struct mount *mp = ncp->nc_mount;
1067
1068         KKASSERT(mp != NULL);
1069         if (ncp->nc_flag & NCF_UNRESOLVED) {
1070                 while (vfs_busy(mp, 0, NULL, curthread))
1071                         ;
1072                 ncp->nc_error = VFS_ROOT(mp, &vp);
1073                 if (ncp->nc_error == 0) {
1074                         cache_setvp(ncp, vp);
1075                         vput(vp);
1076                 } else {
1077                         printf("[diagnostic] cache_resolve_mp: failed to resolve mount %p\n", mp);
1078                         cache_setvp(ncp, NULL);
1079                 }
1080                 vfs_unbusy(mp, curthread);
1081         }
1082         return(ncp->nc_error);
1083 }
1084
1085 /*
1086  * Lookup an entry in the cache.
1087  *
1088  * XXX OLD API ROUTINE!  WHEN ALL VFSs HAVE BEEN CLEANED UP THIS PROCEDURE
1089  * WILL BE REMOVED.  NOTE: even though this is an old api function it had
1090  * to be modified to vref() the returned vnode (whereas in 4.x an unreferenced
1091  * vnode was returned).  This is necessary because our namecache structure
1092  * manipulation can cause the vnode to be recycled if it isn't refd.
1093  *
1094  * Lookup is called with dvp pointing to the directory to search,
1095  * cnp pointing to the name of the entry being sought. 
1096  *
1097  * If the lookup succeeds, a REFd but unlocked vnode is returned in *vpp,
1098  * and a status of -1 is returned.
1099  *
1100  * If the lookup determines that the name does not exist (negative cacheing),
1101  * a status of ENOENT is returned. 
1102  *
1103  * If the lookup fails, a status of zero is returned.
1104  *
1105  * Matching UNRESOLVED entries are resolved.
1106  *
1107  * HACKS: we create dummy nodes for parents
1108  */
1109 int
1110 cache_lookup(struct vnode *dvp, struct vnode **vpp, struct componentname *cnp)
1111 {
1112         struct namecache *ncp;
1113         struct namecache *par;
1114         struct namecache *bpar;
1115         u_int32_t hash;
1116         globaldata_t gd = mycpu;
1117
1118         numcalls++;
1119         *vpp = NULL;
1120
1121         /*
1122          * Obtain the namecache entry associated with dvp.  If there is no
1123          * entry then assume a miss.
1124          */
1125         if ((par = TAILQ_FIRST(&dvp->v_namecache)) == NULL) {
1126                 if ((cnp->cn_flags & CNP_MAKEENTRY) == 0) {
1127                         nummisszap++;
1128                 } else {
1129                         nummiss++;
1130                 }
1131                 gd->gd_nchstats->ncs_miss++;
1132                 return (0);
1133         }
1134
1135         /*
1136          * Deal with "." and "..".   Note that if the namecache is disjoint,
1137          * we won't find a vnode for ".." and we return a miss.
1138          */
1139         if (cnp->cn_nameptr[0] == '.') {
1140                 if (cnp->cn_namelen == 1) {
1141                         *vpp = dvp;
1142                         vref(*vpp);
1143                         dothits++;
1144                         numposhits++;   /* include in total statistics */
1145                         return (-1);
1146                 }
1147                 if (cnp->cn_namelen == 2 && cnp->cn_nameptr[1] == '.') {
1148                         if ((cnp->cn_flags & CNP_MAKEENTRY) == 0) {
1149                                 dotdothits++;
1150                                 numposhits++;
1151                                 return (0);
1152                         }
1153                         if (par->nc_parent == NULL ||
1154                             par->nc_parent->nc_vp == NULL) {
1155                                 nummiss++;
1156                                 gd->gd_nchstats->ncs_miss++;
1157                                 return (0);
1158                         }
1159                         *vpp = par->nc_parent->nc_vp;
1160                         vref(*vpp);
1161                         dotdothits++;
1162                         numposhits++;   /* include in total statistics */
1163                         return (-1);
1164                 }
1165         }
1166
1167         /*
1168          * Try to locate an existing entry
1169          */
1170         cache_hold(par);
1171         hash = fnv_32_buf(cnp->cn_nameptr, cnp->cn_namelen, FNV1_32_INIT);
1172         bpar = par;
1173         hash = fnv_32_buf(&bpar, sizeof(bpar), hash);
1174 restart:
1175         LIST_FOREACH(ncp, (NCHHASH(hash)), nc_hash) {
1176                 numchecks++;
1177
1178                 /*
1179                  * Zap entries that have timed out.  Don't do anything if
1180                  * the entry is in an unresolved state or is held locked.
1181                  */
1182                 if (ncp->nc_timeout && 
1183                     (int)(ncp->nc_timeout - ticks) < 0 &&
1184                     (ncp->nc_flag & NCF_UNRESOLVED) == 0 &&
1185                     ncp->nc_exlocks == 0
1186                 ) {
1187                         cache_zap(cache_get(ncp));
1188                         goto restart;
1189                 }
1190
1191                 /*
1192                  * Break out if we find a matching entry.
1193                  */
1194                 if (ncp->nc_parent == par &&
1195                     ncp->nc_nlen == cnp->cn_namelen &&
1196                     bcmp(ncp->nc_name, cnp->cn_nameptr, ncp->nc_nlen) == 0
1197                 ) {
1198                         if (cache_get_nonblock(ncp) == 0)
1199                                 break;
1200                         cache_get(ncp);
1201                         cache_put(ncp);
1202                         goto restart;
1203                 }
1204         }
1205         cache_drop(par);
1206
1207         /*
1208          * We found an entry but it is unresolved, act the same as if we
1209          * failed to locate the entry.  cache_enter() will do the right
1210          * thing.
1211          */
1212         if (ncp && (ncp->nc_flag & NCF_UNRESOLVED)) {
1213                 cache_put(ncp);
1214                 ncp = NULL;
1215         }
1216
1217         /*
1218          * If we failed to locate an entry, return 0 (indicates failure).
1219          */
1220         if (ncp == NULL) {
1221                 if ((cnp->cn_flags & CNP_MAKEENTRY) == 0) {
1222                         nummisszap++;
1223                 } else {
1224                         nummiss++;
1225                 }
1226                 gd->gd_nchstats->ncs_miss++;
1227                 return (0);
1228         }
1229
1230         /*
1231          * If we found an entry, but we don't want to have one, we just
1232          * return.  The old API tried to zap the entry in the vfs_lookup()
1233          * phase but this is too early to know whether the operation
1234          * will have succeeded or not.  The new API zaps it after the
1235          * operation has succeeded, not here.
1236          *
1237          * At the same time, the old api's rename() function uses the
1238          * old api lookup to clear out any negative cache hit on the
1239          * target name.  We still have to do that.
1240          */
1241         if ((cnp->cn_flags & CNP_MAKEENTRY) == 0) {
1242                 if (cnp->cn_nameiop == NAMEI_RENAME && ncp->nc_vp == NULL)
1243                         cache_zap(ncp);
1244                 else
1245                         cache_put(ncp);
1246                 return (0);
1247         }
1248
1249         /*
1250          * If the vnode is not NULL then return the positive match.
1251          */
1252         if (ncp->nc_vp) {
1253                 numposhits++;
1254                 gd->gd_nchstats->ncs_goodhits++;
1255                 *vpp = ncp->nc_vp;
1256                 vref(*vpp);
1257                 cache_put(ncp);
1258                 return (-1);
1259         }
1260
1261         /*
1262          * If the vnode is NULL we found a negative match.  If we want to
1263          * create it, purge the negative match and return failure (as if
1264          * we hadn't found a match in the first place).
1265          */
1266         if (cnp->cn_nameiop == NAMEI_CREATE) {
1267                 numnegzaps++;
1268                 gd->gd_nchstats->ncs_badhits++;
1269                 cache_zap(ncp);
1270                 return (0);
1271         }
1272
1273         numneghits++;
1274
1275         /*
1276          * We found a "negative" match, ENOENT notifies client of this match.
1277          * The nc_flag field records whether this is a whiteout.  Since there
1278          * is no vnode we can use the vnode tailq link field with ncneglist.
1279          */
1280         TAILQ_REMOVE(&ncneglist, ncp, nc_vnode);
1281         TAILQ_INSERT_TAIL(&ncneglist, ncp, nc_vnode);
1282         gd->gd_nchstats->ncs_neghits++;
1283         if (ncp->nc_flag & NCF_WHITEOUT)
1284                 cnp->cn_flags |= CNP_ISWHITEOUT;
1285         cache_put(ncp);
1286         return (ENOENT);
1287 }
1288
1289 /*
1290  * Add an entry to the cache.  (OLD API)
1291  *
1292  * XXX OLD API ROUTINE!  WHEN ALL VFSs HAVE BEEN CLEANED UP THIS PROCEDURE
1293  * WILL BE REMOVED.
1294  *
1295  * Generally speaking this is 'optional'.  It's ok to do nothing at all.
1296  * The only reason I don't just return is to try to set nc_timeout if
1297  * requested.
1298  */
1299 void
1300 cache_enter(struct vnode *dvp, struct vnode *vp, struct componentname *cnp)
1301 {
1302         struct namecache *par;
1303         struct namecache *ncp;
1304         struct namecache *new_ncp;
1305         struct namecache *bpar;
1306         struct nchashhead *nchpp;
1307         u_int32_t hash;
1308
1309         /*
1310          * If the directory has no namecache entry we bail.  This will result
1311          * in a lot of misses but frankly we don't have much of a choice if
1312          * we want to be compatible with the new api's storage scheme.
1313          */
1314         if ((ncp = TAILQ_FIRST(&dvp->v_namecache)) == NULL)
1315                 return;
1316         cache_hold(ncp);
1317
1318         /*
1319          * This may be a bit confusing.  "." and ".." are 'virtual' entries.
1320          * We do not actually create a namecache entry representing either.
1321          * However, the ".." case is used to linkup a potentially disjoint
1322          * directory with its parent, to disconnect a directory from its
1323          * parent, or to change an existing linkage that may no longer be
1324          * correct (as might occur when a subdirectory is renamed).
1325          */
1326
1327         if (cnp->cn_namelen == 1 && cnp->cn_nameptr[0] == '.') {
1328                 cache_drop(ncp);
1329                 return;
1330         }
1331         if (cnp->cn_namelen == 2 && cnp->cn_nameptr[0] == '.' &&
1332             cnp->cn_nameptr[1] == '.'
1333         ) {
1334                 cache_drop(ncp);
1335                 return;
1336         }
1337
1338         /*
1339          * Ok, no special cases, ncp is actually the parent directory so
1340          * assign it to par.  Note that it is held.
1341          */
1342         par = ncp;
1343
1344         /*
1345          * Try to find a match in the hash table, allocate a new entry if
1346          * we can't.  We have to retry the loop after any potential blocking
1347          * situation.
1348          */
1349         bpar = par;
1350         hash = fnv_32_buf(cnp->cn_nameptr, cnp->cn_namelen, FNV1_32_INIT);
1351         hash = fnv_32_buf(&bpar, sizeof(bpar), hash);
1352
1353         new_ncp = NULL;
1354 againagain:
1355         LIST_FOREACH(ncp, (NCHHASH(hash)), nc_hash) {
1356                 numchecks++;
1357
1358                 /*
1359                  * Break out if we find a matching entry.  Because cache_enter
1360                  * is called with one or more vnodes potentially locked, we
1361                  * cannot block trying to get the ncp lock (or we might 
1362                  * deadlock).
1363                  */
1364                 if (ncp->nc_parent == par &&
1365                     ncp->nc_nlen == cnp->cn_namelen &&
1366                     bcmp(ncp->nc_name, cnp->cn_nameptr, ncp->nc_nlen) == 0
1367                 ) {
1368                         if (cache_get_nonblock(ncp) != 0) {
1369                                 printf("[diagnostic] cache_enter: avoided race on %p %*.*s\n", ncp, ncp->nc_nlen, ncp->nc_nlen, ncp->nc_name);
1370                                 cache_drop(par);
1371                                 return;
1372                         }
1373                         break;
1374                 }
1375         }
1376         if (ncp == NULL) {
1377                 if (new_ncp == NULL) {
1378                         new_ncp = cache_alloc(cnp->cn_namelen);
1379                         goto againagain;
1380                 }
1381                 ncp = new_ncp;
1382                 bcopy(cnp->cn_nameptr, ncp->nc_name, cnp->cn_namelen);
1383                 nchpp = NCHHASH(hash);
1384                 LIST_INSERT_HEAD(nchpp, ncp, nc_hash);
1385                 ncp->nc_flag |= NCF_HASHED;
1386                 cache_link_parent(ncp, par);
1387         } else if (new_ncp) {
1388                 cache_free(new_ncp);
1389         }
1390         cache_drop(par);
1391
1392         /*
1393          * Avoid side effects if we are simply re-entering the same
1394          * information.
1395          */
1396         if ((ncp->nc_flag & NCF_UNRESOLVED) == 0 && ncp->nc_vp == vp) {
1397                 ncp->nc_error = vp ? 0 : ENOENT;
1398         } else {
1399                 cache_setunresolved(ncp);
1400                 cache_setvp(ncp, vp);
1401         }
1402
1403         /*
1404          * Set a timeout
1405          */
1406         if (cnp->cn_flags & CNP_CACHETIMEOUT) {
1407                 if ((ncp->nc_timeout = ticks + cnp->cn_timeout) == 0)
1408                         ncp->nc_timeout = 1;
1409         }
1410
1411         /*
1412          * If the target vnode is NULL if this is to be a negative cache
1413          * entry.
1414          */
1415         if (vp == NULL) {
1416                 ncp->nc_flag &= ~NCF_WHITEOUT;
1417                 if (cnp->cn_flags & CNP_ISWHITEOUT)
1418                         ncp->nc_flag |= NCF_WHITEOUT;
1419         }
1420         cache_put(ncp);
1421         cache_hysteresis();
1422 }
1423
1424 void
1425 cache_cleanneg(int count)
1426 {
1427         struct namecache *ncp;
1428
1429         /*
1430          * Automode from the vnlru proc - clean out 10% of the negative cache
1431          * entries.
1432          */
1433         if (count == 0)
1434                 count = numneg / 10 + 1;
1435
1436         /*
1437          * Attempt to clean out the specified number of negative cache
1438          * entries.
1439          */
1440         while (count) {
1441                 ncp = TAILQ_FIRST(&ncneglist);
1442                 if (ncp == NULL) {
1443                         KKASSERT(numneg == 0);
1444                         break;
1445                 }
1446                 TAILQ_REMOVE(&ncneglist, ncp, nc_vnode);
1447                 TAILQ_INSERT_TAIL(&ncneglist, ncp, nc_vnode);
1448                 if (cache_get_nonblock(ncp) == 0)
1449                         cache_zap(ncp);
1450                 --count;
1451         }
1452 }
1453
1454 static void
1455 cache_rehash(struct namecache *ncp)
1456 {
1457         struct nchashhead *nchpp;
1458         u_int32_t hash;
1459
1460         if (ncp->nc_flag & NCF_HASHED) {
1461                 ncp->nc_flag &= ~NCF_HASHED;
1462                 LIST_REMOVE(ncp, nc_hash);
1463         }
1464         hash = fnv_32_buf(ncp->nc_name, ncp->nc_nlen, FNV1_32_INIT);
1465         hash = fnv_32_buf(&ncp->nc_parent, sizeof(ncp->nc_parent), hash);
1466         nchpp = NCHHASH(hash);
1467         LIST_INSERT_HEAD(nchpp, ncp, nc_hash);
1468         ncp->nc_flag |= NCF_HASHED;
1469 }
1470
1471
1472 /*
1473  * Name cache initialization, from vfsinit() when we are booting
1474  */
1475 void
1476 nchinit(void)
1477 {
1478         int i;
1479         globaldata_t gd;
1480
1481         /* initialise per-cpu namecache effectiveness statistics. */
1482         for (i = 0; i < ncpus; ++i) {
1483                 gd = globaldata_find(i);
1484                 gd->gd_nchstats = &nchstats[i];
1485         }
1486         
1487         TAILQ_INIT(&ncneglist);
1488         nchashtbl = hashinit(desiredvnodes*2, M_VFSCACHE, &nchash);
1489 }
1490
1491 /*
1492  * Called from start_init() to bootstrap the root filesystem.  Returns
1493  * a referenced, unlocked namecache record.
1494  */
1495 struct namecache *
1496 cache_allocroot(struct mount *mp, struct vnode *vp)
1497 {
1498         struct namecache *ncp = cache_alloc(0);
1499
1500         ncp->nc_flag |= NCF_MOUNTPT | NCF_ROOT;
1501         ncp->nc_mount = mp;
1502         cache_setvp(ncp, vp);
1503         return(ncp);
1504 }
1505
1506 /*
1507  * vfs_cache_setroot()
1508  *
1509  *      Create an association between the root of our namecache and
1510  *      the root vnode.  This routine may be called several times during
1511  *      booting.
1512  *
1513  *      If the caller intends to save the returned namecache pointer somewhere
1514  *      it must cache_hold() it.
1515  */
1516 void
1517 vfs_cache_setroot(struct vnode *nvp, struct namecache *ncp)
1518 {
1519         struct vnode *ovp;
1520         struct namecache *oncp;
1521
1522         ovp = rootvnode;
1523         oncp = rootncp;
1524         rootvnode = nvp;
1525         rootncp = ncp;
1526
1527         if (ovp)
1528                 vrele(ovp);
1529         if (oncp)
1530                 cache_drop(oncp);
1531 }
1532
1533 /*
1534  * Invalidate all namecache entries to a particular vnode as well as 
1535  * any direct children of that vnode in the namecache.  This is a 
1536  * 'catch all' purge used by filesystems that do not know any better.
1537  *
1538  * A new vnode v_id is generated.  Note that no vnode will ever have a
1539  * v_id of 0.
1540  *
1541  * Note that the linkage between the vnode and its namecache entries will
1542  * be removed, but the namecache entries themselves might stay put due to
1543  * active references from elsewhere in the system or due to the existance of
1544  * the children.   The namecache topology is left intact even if we do not
1545  * know what the vnode association is.  Such entries will be marked
1546  * NCF_UNRESOLVED.
1547  *
1548  * XXX: Only time and the size of v_id prevents this from failing:
1549  * XXX: In theory we should hunt down all (struct vnode*, v_id)
1550  * XXX: soft references and nuke them, at least on the global
1551  * XXX: v_id wraparound.  The period of resistance can be extended
1552  * XXX: by incrementing each vnodes v_id individually instead of
1553  * XXX: using the global v_id.
1554  */
1555 void
1556 cache_purge(struct vnode *vp)
1557 {
1558         static u_long nextid;
1559
1560         cache_inval_vp(vp, CINV_PARENT | CINV_SELF | CINV_CHILDREN);
1561
1562         /*
1563          * Calculate a new unique id for ".." handling
1564          */
1565         do {
1566                 nextid++;
1567         } while (nextid == vp->v_id || nextid == 0);
1568         vp->v_id = nextid;
1569 }
1570
1571 /*
1572  * Flush all entries referencing a particular filesystem.
1573  *
1574  * Since we need to check it anyway, we will flush all the invalid
1575  * entries at the same time.
1576  */
1577 void
1578 cache_purgevfs(struct mount *mp)
1579 {
1580         struct nchashhead *nchpp;
1581         struct namecache *ncp, *nnp;
1582
1583         /*
1584          * Scan hash tables for applicable entries.
1585          */
1586         for (nchpp = &nchashtbl[nchash]; nchpp >= nchashtbl; nchpp--) {
1587                 ncp = LIST_FIRST(nchpp);
1588                 if (ncp)
1589                         cache_hold(ncp);
1590                 while (ncp) {
1591                         nnp = LIST_NEXT(ncp, nc_hash);
1592                         if (nnp)
1593                                 cache_hold(nnp);
1594                         if (ncp->nc_vp && ncp->nc_vp->v_mount == mp) {
1595                                 cache_lock(ncp);
1596                                 cache_zap(ncp);
1597                         } else {
1598                                 cache_drop(ncp);
1599                         }
1600                         ncp = nnp;
1601                 }
1602         }
1603 }
1604
1605 /*
1606  * Perform canonical checks and cache lookup and pass on to filesystem
1607  * through the vop_cachedlookup only if needed.
1608  *
1609  * vop_lookup_args {
1610  *      struct vnode a_dvp;
1611  *      struct vnode **a_vpp;
1612  *      struct componentname *a_cnp;
1613  * }
1614  */
1615 int
1616 vfs_cache_lookup(struct vop_lookup_args *ap)
1617 {
1618         struct vnode *dvp, *vp;
1619         int lockparent;
1620         int error;
1621         struct vnode **vpp = ap->a_vpp;
1622         struct componentname *cnp = ap->a_cnp;
1623         struct ucred *cred = cnp->cn_cred;
1624         int flags = cnp->cn_flags;
1625         struct thread *td = cnp->cn_td;
1626         u_long vpid;    /* capability number of vnode */
1627
1628         *vpp = NULL;
1629         dvp = ap->a_dvp;
1630         lockparent = flags & CNP_LOCKPARENT;
1631
1632         if (dvp->v_type != VDIR)
1633                 return (ENOTDIR);
1634
1635         if ((flags & CNP_ISLASTCN) && (dvp->v_mount->mnt_flag & MNT_RDONLY) &&
1636             (cnp->cn_nameiop == NAMEI_DELETE || cnp->cn_nameiop == NAMEI_RENAME)) {
1637                 return (EROFS);
1638         }
1639
1640         error = VOP_ACCESS(dvp, VEXEC, cred, td);
1641
1642         if (error)
1643                 return (error);
1644
1645         error = cache_lookup(dvp, vpp, cnp);
1646
1647         /*
1648          * failure if error == 0, do a physical lookup
1649          */
1650         if (!error) 
1651                 return (VOP_CACHEDLOOKUP(dvp, vpp, cnp));
1652
1653         if (error == ENOENT)
1654                 return (error);
1655
1656         vp = *vpp;
1657         vpid = vp->v_id;
1658         cnp->cn_flags &= ~CNP_PDIRUNLOCK;
1659         if (dvp == vp) {   /* lookup on "." */
1660                 /* already ref'd from cache_lookup() */
1661                 error = 0;
1662         } else if (flags & CNP_ISDOTDOT) {
1663                 VOP_UNLOCK(dvp, 0, td);
1664                 cnp->cn_flags |= CNP_PDIRUNLOCK;
1665                 error = vget(vp, LK_EXCLUSIVE, td);
1666                 vrele(vp);
1667                 if (!error && lockparent && (flags & CNP_ISLASTCN)) {
1668                         if ((error = vn_lock(dvp, LK_EXCLUSIVE, td)) == 0)
1669                                 cnp->cn_flags &= ~CNP_PDIRUNLOCK;
1670                 }
1671         } else {
1672                 error = vget(vp, LK_EXCLUSIVE, td);
1673                 vrele(vp);
1674                 if (!lockparent || error || !(flags & CNP_ISLASTCN)) {
1675                         VOP_UNLOCK(dvp, 0, td);
1676                         cnp->cn_flags |= CNP_PDIRUNLOCK;
1677                 }
1678         }
1679         /*
1680          * Check that the capability number did not change
1681          * while we were waiting for the lock.
1682          */
1683         if (!error) {
1684                 if (vpid == vp->v_id)
1685                         return (0);
1686                 vput(vp);
1687                 if (lockparent && dvp != vp && (flags & CNP_ISLASTCN)) {
1688                         VOP_UNLOCK(dvp, 0, td);
1689                         cnp->cn_flags |= CNP_PDIRUNLOCK;
1690                 }
1691         }
1692         if (cnp->cn_flags & CNP_PDIRUNLOCK) {
1693                 error = vn_lock(dvp, LK_EXCLUSIVE, td);
1694                 if (error)
1695                         return (error);
1696                 cnp->cn_flags &= ~CNP_PDIRUNLOCK;
1697         }
1698         return (VOP_CACHEDLOOKUP(dvp, vpp, cnp));
1699 }
1700
1701 static int disablecwd;
1702 SYSCTL_INT(_debug, OID_AUTO, disablecwd, CTLFLAG_RW, &disablecwd, 0, "");
1703
1704 static u_long numcwdcalls; STATNODE(CTLFLAG_RD, numcwdcalls, &numcwdcalls);
1705 static u_long numcwdfail1; STATNODE(CTLFLAG_RD, numcwdfail1, &numcwdfail1);
1706 static u_long numcwdfail2; STATNODE(CTLFLAG_RD, numcwdfail2, &numcwdfail2);
1707 static u_long numcwdfail3; STATNODE(CTLFLAG_RD, numcwdfail3, &numcwdfail3);
1708 static u_long numcwdfail4; STATNODE(CTLFLAG_RD, numcwdfail4, &numcwdfail4);
1709 static u_long numcwdfound; STATNODE(CTLFLAG_RD, numcwdfound, &numcwdfound);
1710
1711 int
1712 __getcwd(struct __getcwd_args *uap)
1713 {
1714         int buflen;
1715         int error;
1716         char *buf;
1717         char *bp;
1718
1719         if (disablecwd)
1720                 return (ENODEV);
1721
1722         buflen = uap->buflen;
1723         if (buflen < 2)
1724                 return (EINVAL);
1725         if (buflen > MAXPATHLEN)
1726                 buflen = MAXPATHLEN;
1727
1728         buf = malloc(buflen, M_TEMP, M_WAITOK);
1729         bp = kern_getcwd(buf, buflen, &error);
1730         if (error == 0)
1731                 error = copyout(bp, uap->buf, strlen(bp) + 1);
1732         free(buf, M_TEMP);
1733         return (error);
1734 }
1735
1736 char *
1737 kern_getcwd(char *buf, size_t buflen, int *error)
1738 {
1739         struct proc *p = curproc;
1740         char *bp;
1741         int i, slash_prefixed;
1742         struct filedesc *fdp;
1743         struct namecache *ncp;
1744
1745         numcwdcalls++;
1746         bp = buf;
1747         bp += buflen - 1;
1748         *bp = '\0';
1749         fdp = p->p_fd;
1750         slash_prefixed = 0;
1751
1752         ncp = fdp->fd_ncdir;
1753         while (ncp && ncp != fdp->fd_nrdir && (ncp->nc_flag & NCF_ROOT) == 0) {
1754                 if (ncp->nc_flag & NCF_MOUNTPT) {
1755                         if (ncp->nc_mount == NULL) {
1756                                 *error = EBADF;         /* forced unmount? */
1757                                 return(NULL);
1758                         }
1759                         ncp = ncp->nc_parent;
1760                         continue;
1761                 }
1762                 for (i = ncp->nc_nlen - 1; i >= 0; i--) {
1763                         if (bp == buf) {
1764                                 numcwdfail4++;
1765                                 *error = ENOMEM;
1766                                 return(NULL);
1767                         }
1768                         *--bp = ncp->nc_name[i];
1769                 }
1770                 if (bp == buf) {
1771                         numcwdfail4++;
1772                         *error = ENOMEM;
1773                         return(NULL);
1774                 }
1775                 *--bp = '/';
1776                 slash_prefixed = 1;
1777                 ncp = ncp->nc_parent;
1778         }
1779         if (ncp == NULL) {
1780                 numcwdfail2++;
1781                 *error = ENOENT;
1782                 return(NULL);
1783         }
1784         if (!slash_prefixed) {
1785                 if (bp == buf) {
1786                         numcwdfail4++;
1787                         *error = ENOMEM;
1788                         return(NULL);
1789                 }
1790                 *--bp = '/';
1791         }
1792         numcwdfound++;
1793         *error = 0;
1794         return (bp);
1795 }
1796
1797 /*
1798  * Thus begins the fullpath magic.
1799  */
1800
1801 #undef STATNODE
1802 #define STATNODE(name)                                                  \
1803         static u_int name;                                              \
1804         SYSCTL_UINT(_vfs_cache, OID_AUTO, name, CTLFLAG_RD, &name, 0, "")
1805
1806 static int disablefullpath;
1807 SYSCTL_INT(_debug, OID_AUTO, disablefullpath, CTLFLAG_RW,
1808     &disablefullpath, 0, "");
1809
1810 STATNODE(numfullpathcalls);
1811 STATNODE(numfullpathfail1);
1812 STATNODE(numfullpathfail2);
1813 STATNODE(numfullpathfail3);
1814 STATNODE(numfullpathfail4);
1815 STATNODE(numfullpathfound);
1816
1817 int
1818 vn_fullpath(struct proc *p, struct vnode *vn, char **retbuf, char **freebuf) 
1819 {
1820         char *bp, *buf;
1821         int i, slash_prefixed;
1822         struct filedesc *fdp;
1823         struct namecache *ncp;
1824
1825         numfullpathcalls++;
1826         if (disablefullpath)
1827                 return (ENODEV);
1828
1829         if (p == NULL)
1830                 return (EINVAL);
1831
1832         /* vn is NULL, client wants us to use p->p_textvp */
1833         if (vn == NULL) {
1834                 if ((vn = p->p_textvp) == NULL)
1835                         return (EINVAL);
1836         }
1837         ncp = TAILQ_FIRST(&vn->v_namecache);
1838         if (ncp == NULL)
1839                 return (EINVAL);
1840
1841         buf = malloc(MAXPATHLEN, M_TEMP, M_WAITOK);
1842         bp = buf + MAXPATHLEN - 1;
1843         *bp = '\0';
1844         fdp = p->p_fd;
1845         slash_prefixed = 0;
1846         while (ncp && ncp != fdp->fd_nrdir && (ncp->nc_flag & NCF_ROOT) == 0) {
1847                 if (ncp->nc_flag & NCF_MOUNTPT) {
1848                         if (ncp->nc_mount == NULL) {
1849                                 free(buf, M_TEMP);
1850                                 return(EBADF);
1851                         }
1852                         ncp = ncp->nc_parent;
1853                         continue;
1854                 }
1855                 for (i = ncp->nc_nlen - 1; i >= 0; i--) {
1856                         if (bp == buf) {
1857                                 numfullpathfail4++;
1858                                 free(buf, M_TEMP);
1859                                 return (ENOMEM);
1860                         }
1861                         *--bp = ncp->nc_name[i];
1862                 }
1863                 if (bp == buf) {
1864                         numfullpathfail4++;
1865                         free(buf, M_TEMP);
1866                         return (ENOMEM);
1867                 }
1868                 *--bp = '/';
1869                 slash_prefixed = 1;
1870                 ncp = ncp->nc_parent;
1871         }
1872         if (ncp == NULL) {
1873                 numfullpathfail2++;
1874                 free(buf, M_TEMP);
1875                 return (ENOENT);
1876         }
1877         if (!slash_prefixed) {
1878                 if (bp == buf) {
1879                         numfullpathfail4++;
1880                         free(buf, M_TEMP);
1881                         return (ENOMEM);
1882                 }
1883                 *--bp = '/';
1884         }
1885         numfullpathfound++;
1886         *retbuf = bp; 
1887         *freebuf = buf;
1888         return (0);
1889 }
1890