coda_namecache.c revision 1.4 1 1.4 rvb /* $NetBSD: coda_namecache.c,v 1.4 1998/09/15 02:02:58 rvb Exp $ */
2 1.2 rvb
3 1.1 rvb /*
4 1.2 rvb *
5 1.2 rvb * Coda: an Experimental Distributed File System
6 1.2 rvb * Release 3.1
7 1.2 rvb *
8 1.2 rvb * Copyright (c) 1987-1998 Carnegie Mellon University
9 1.2 rvb * All Rights Reserved
10 1.2 rvb *
11 1.2 rvb * Permission to use, copy, modify and distribute this software and its
12 1.2 rvb * documentation is hereby granted, provided that both the copyright
13 1.2 rvb * notice and this permission notice appear in all copies of the
14 1.2 rvb * software, derivative works or modified versions, and any portions
15 1.2 rvb * thereof, and that both notices appear in supporting documentation, and
16 1.2 rvb * that credit is given to Carnegie Mellon University in all documents
17 1.2 rvb * and publicity pertaining to direct or indirect use of this code or its
18 1.2 rvb * derivatives.
19 1.2 rvb *
20 1.2 rvb * CODA IS AN EXPERIMENTAL SOFTWARE SYSTEM AND IS KNOWN TO HAVE BUGS,
21 1.2 rvb * SOME OF WHICH MAY HAVE SERIOUS CONSEQUENCES. CARNEGIE MELLON ALLOWS
22 1.2 rvb * FREE USE OF THIS SOFTWARE IN ITS "AS IS" CONDITION. CARNEGIE MELLON
23 1.2 rvb * DISCLAIMS ANY LIABILITY OF ANY KIND FOR ANY DAMAGES WHATSOEVER
24 1.2 rvb * RESULTING DIRECTLY OR INDIRECTLY FROM THE USE OF THIS SOFTWARE OR OF
25 1.2 rvb * ANY DERIVATIVE WORK.
26 1.2 rvb *
27 1.2 rvb * Carnegie Mellon encourages users of this software to return any
28 1.2 rvb * improvements or extensions that they make, and to grant Carnegie
29 1.2 rvb * Mellon the rights to redistribute these changes without encumbrance.
30 1.2 rvb *
31 1.4 rvb * @(#) coda/coda_namecache.c,v 1.1.1.1 1998/08/29 21:26:45 rvb Exp $
32 1.2 rvb */
33 1.1 rvb
34 1.1 rvb /*
35 1.1 rvb * Mach Operating System
36 1.1 rvb * Copyright (c) 1990 Carnegie-Mellon University
37 1.1 rvb * Copyright (c) 1989 Carnegie-Mellon University
38 1.1 rvb * All rights reserved. The CMU software License Agreement specifies
39 1.1 rvb * the terms and conditions for use and redistribution.
40 1.1 rvb */
41 1.1 rvb
42 1.1 rvb /*
43 1.1 rvb * This code was written for the Coda file system at Carnegie Mellon University.
44 1.1 rvb * Contributers include David Steere, James Kistler, and M. Satyanarayanan.
45 1.1 rvb */
46 1.1 rvb
47 1.1 rvb /*
48 1.1 rvb * HISTORY
49 1.4 rvb * $Log: coda_namecache.c,v $
50 1.4 rvb * Revision 1.4 1998/09/15 02:02:58 rvb
51 1.4 rvb * Final piece of rename cfs->coda
52 1.4 rvb *
53 1.4 rvb * Revision 1.3 1998/09/12 15:05:48 rvb
54 1.3 rvb * Change cfs/CFS in symbols, strings and constants to coda/CODA
55 1.3 rvb * to avoid fs conflicts.
56 1.3 rvb *
57 1.2 rvb * Revision 1.2 1998/09/08 17:12:46 rvb
58 1.2 rvb * Pass2 complete
59 1.2 rvb *
60 1.1 rvb * Revision 1.1.1.1 1998/08/29 21:26:45 rvb
61 1.1 rvb * Very Preliminary Coda
62 1.1 rvb *
63 1.1 rvb * Revision 1.11 1998/08/28 18:12:16 rvb
64 1.1 rvb * Now it also works on FreeBSD -current. This code will be
65 1.1 rvb * committed to the FreeBSD -current and NetBSD -current
66 1.1 rvb * trees. It will then be tailored to the particular platform
67 1.1 rvb * by flushing conditional code.
68 1.1 rvb *
69 1.1 rvb * Revision 1.10 1998/08/18 17:05:14 rvb
70 1.1 rvb * Don't use __RCSID now
71 1.1 rvb *
72 1.1 rvb * Revision 1.9 1998/08/18 16:31:39 rvb
73 1.1 rvb * Sync the code for NetBSD -current; test on 1.3 later
74 1.1 rvb *
75 1.1 rvb * Revision 1.8 98/01/31 20:53:10 rvb
76 1.3 rvb * First version that works on FreeBSD 2.2.5
77 1.1 rvb *
78 1.1 rvb * Revision 1.7 98/01/23 11:53:39 rvb
79 1.1 rvb * Bring RVB_CODA1_1 to HEAD
80 1.1 rvb *
81 1.1 rvb * Revision 1.6.2.4 98/01/23 11:21:02 rvb
82 1.1 rvb * Sync with 2.2.5
83 1.1 rvb *
84 1.1 rvb * Revision 1.6.2.3 97/12/16 12:40:03 rvb
85 1.1 rvb * Sync with 1.3
86 1.1 rvb *
87 1.1 rvb * Revision 1.6.2.2 97/12/09 16:07:10 rvb
88 1.1 rvb * Sync with vfs/include/coda.h
89 1.1 rvb *
90 1.1 rvb * Revision 1.6.2.1 97/12/06 17:41:18 rvb
91 1.1 rvb * Sync with peters coda.h
92 1.1 rvb *
93 1.1 rvb * Revision 1.6 97/12/05 10:39:13 rvb
94 1.1 rvb * Read CHANGES
95 1.1 rvb *
96 1.1 rvb * Revision 1.5.4.7 97/11/25 08:08:43 rvb
97 1.1 rvb * cfs_venus ... done; until cred/vattr change
98 1.1 rvb *
99 1.1 rvb * Revision 1.5.4.6 97/11/24 15:44:43 rvb
100 1.1 rvb * Final cfs_venus.c w/o macros, but one locking bug
101 1.1 rvb *
102 1.1 rvb * Revision 1.5.4.5 97/11/20 11:46:38 rvb
103 1.1 rvb * Capture current cfs_venus
104 1.1 rvb *
105 1.1 rvb * Revision 1.5.4.4 97/11/18 10:27:13 rvb
106 1.1 rvb * cfs_nbsd.c is DEAD!!!; integrated into cfs_vf/vnops.c
107 1.1 rvb * cfs_nb_foo and cfs_foo are joined
108 1.1 rvb *
109 1.1 rvb * Revision 1.5.4.3 97/11/13 22:02:57 rvb
110 1.1 rvb * pass2 cfs_NetBSD.h mt
111 1.1 rvb *
112 1.1 rvb * Revision 1.5.4.2 97/11/12 12:09:35 rvb
113 1.1 rvb * reorg pass1
114 1.1 rvb *
115 1.1 rvb * Revision 1.5.4.1 97/10/28 23:10:12 rvb
116 1.3 rvb * >64Meg; venus can be killed!
117 1.1 rvb *
118 1.1 rvb * Revision 1.5 97/08/05 11:08:01 lily
119 1.1 rvb * Removed cfsnc_replace, replaced it with a coda_find, unhash, and
120 1.1 rvb * rehash. This fixes a cnode leak and a bug in which the fid is
121 1.1 rvb * not actually replaced. (cfs_namecache.c, cfsnc.h, cfs_subr.c)
122 1.1 rvb *
123 1.1 rvb * Revision 1.4 96/12/12 22:10:57 bnoble
124 1.1 rvb * Fixed the "downcall invokes venus operation" deadlock in all known cases.
125 1.1 rvb * There may be more
126 1.1 rvb *
127 1.1 rvb * Revision 1.3 1996/11/08 18:06:09 bnoble
128 1.1 rvb * Minor changes in vnode operation signature, VOP_UPDATE signature, and
129 1.1 rvb * some newly defined bits in the include files.
130 1.1 rvb *
131 1.1 rvb * Revision 1.2 1996/01/02 16:56:50 bnoble
132 1.3 rvb * Added support for Coda MiniCache and raw inode calls (final commit)
133 1.1 rvb *
134 1.1 rvb * Revision 1.1.2.1 1995/12/20 01:57:15 bnoble
135 1.1 rvb * Added CODA-specific files
136 1.1 rvb *
137 1.1 rvb * Revision 3.1.1.1 1995/03/04 19:07:57 bnoble
138 1.1 rvb * Branch for NetBSD port revisions
139 1.1 rvb *
140 1.1 rvb * Revision 3.1 1995/03/04 19:07:56 bnoble
141 1.1 rvb * Bump to major revision 3 to prepare for NetBSD port
142 1.1 rvb *
143 1.1 rvb * Revision 2.3 1994/10/14 09:57:54 dcs
144 1.3 rvb * Made changes 'cause sun4s have braindead compilers
145 1.1 rvb *
146 1.1 rvb * Revision 2.2 94/08/28 19:37:35 luqi
147 1.1 rvb * Add a new CODA_REPLACE call to allow venus to replace a ViceFid in the
148 1.3 rvb * mini-cache.
149 1.1 rvb *
150 1.1 rvb * In "cfs.h":
151 1.1 rvb * Add CODA_REPLACE decl.
152 1.1 rvb *
153 1.1 rvb * In "cfs_namecache.c":
154 1.3 rvb * Add routine cfsnc_replace.
155 1.1 rvb *
156 1.1 rvb * In "cfs_subr.c":
157 1.3 rvb * Add case-statement to process CODA_REPLACE.
158 1.1 rvb *
159 1.1 rvb * In "cfsnc.h":
160 1.1 rvb * Add decl for CODA_NC_REPLACE.
161 1.1 rvb *
162 1.1 rvb *
163 1.1 rvb * Revision 2.1 94/07/21 16:25:15 satya
164 1.1 rvb * Conversion to C++ 3.0; start of Coda Release 2.0
165 1.1 rvb *
166 1.1 rvb * Revision 1.2 92/10/27 17:58:21 lily
167 1.3 rvb * merge kernel/latest and alpha/src/cfs
168 1.1 rvb *
169 1.1 rvb * Revision 2.3 92/09/30 14:16:20 mja
170 1.1 rvb * call coda_flush instead of calling inode_uncache_try directly
171 1.1 rvb * (from dcs). Also...
172 1.1 rvb *
173 1.1 rvb * Substituted rvb's history blurb so that we agree with Mach 2.5 sources.
174 1.1 rvb * [91/02/09 jjk]
175 1.1 rvb *
176 1.1 rvb * Added contributors blurb.
177 1.1 rvb * [90/12/13 jjk]
178 1.1 rvb *
179 1.1 rvb * Revision 2.2 90/07/05 11:26:30 mrt
180 1.1 rvb * Created for the Coda File System.
181 1.1 rvb * [90/05/23 dcs]
182 1.1 rvb *
183 1.1 rvb * Revision 1.3 90/05/31 17:01:24 dcs
184 1.1 rvb * Prepare for merge with facilities kernel.
185 1.1 rvb *
186 1.1 rvb *
187 1.3 rvb */
188 1.1 rvb
189 1.1 rvb /*
190 1.1 rvb * This module contains the routines to implement the CODA name cache. The
191 1.1 rvb * purpose of this cache is to reduce the cost of translating pathnames
192 1.1 rvb * into Vice FIDs. Each entry in the cache contains the name of the file,
193 1.1 rvb * the vnode (FID) of the parent directory, and the cred structure of the
194 1.1 rvb * user accessing the file.
195 1.1 rvb *
196 1.1 rvb * The first time a file is accessed, it is looked up by the local Venus
197 1.1 rvb * which first insures that the user has access to the file. In addition
198 1.1 rvb * we are guaranteed that Venus will invalidate any name cache entries in
199 1.1 rvb * case the user no longer should be able to access the file. For these
200 1.1 rvb * reasons we do not need to keep access list information as well as a
201 1.1 rvb * cred structure for each entry.
202 1.1 rvb *
203 1.1 rvb * The table can be accessed through the routines cnc_init(), cnc_enter(),
204 1.1 rvb * cnc_lookup(), cnc_rmfidcred(), cnc_rmfid(), cnc_rmcred(), and cnc_purge().
205 1.1 rvb * There are several other routines which aid in the implementation of the
206 1.1 rvb * hash table.
207 1.1 rvb */
208 1.1 rvb
209 1.1 rvb /*
210 1.3 rvb * NOTES: rvb@cs
211 1.3 rvb * 1. The name cache holds a reference to every vnode in it. Hence files can not be
212 1.1 rvb * closed or made inactive until they are released.
213 1.1 rvb * 2. coda_nc_name(cp) was added to get a name for a cnode pointer for debugging.
214 1.1 rvb * 3. coda_nc_find() has debug code to detect when entries are stored with different
215 1.1 rvb * credentials. We don't understand yet, if/how entries are NOT EQ but still
216 1.1 rvb * EQUAL
217 1.1 rvb * 4. I wonder if this name cache could be replace by the vnode name cache.
218 1.1 rvb * The latter has no zapping functions, so probably not.
219 1.1 rvb */
220 1.1 rvb
221 1.1 rvb #include <sys/param.h>
222 1.1 rvb #include <sys/errno.h>
223 1.4 rvb #include <sys/malloc.h>
224 1.4 rvb #include <sys/select.h>
225 1.4 rvb
226 1.1 rvb #include <coda/coda.h>
227 1.1 rvb #include <coda/cnode.h>
228 1.1 rvb #include <coda/coda_namecache.h>
229 1.1 rvb
230 1.1 rvb #ifndef insque
231 1.1 rvb #include <sys/systm.h>
232 1.1 rvb #endif /* insque */
233 1.1 rvb
234 1.1 rvb /*
235 1.3 rvb * Declaration of the name cache data structure.
236 1.1 rvb */
237 1.3 rvb
238 1.3 rvb int coda_nc_use = 1; /* Indicate use of CODA Name Cache */
239 1.1 rvb
240 1.3 rvb int coda_nc_size = CODA_NC_CACHESIZE; /* size of the cache */
241 1.3 rvb int coda_nc_hashsize = CODA_NC_HASHSIZE; /* size of the primary hash */
242 1.3 rvb
243 1.1 rvb struct coda_cache *coda_nc_heap; /* pointer to the cache entries */
244 1.3 rvb struct coda_hash *coda_nc_hash; /* hash table of cfscache pointers */
245 1.1 rvb struct coda_lru coda_nc_lru; /* head of lru chain */
246 1.1 rvb
247 1.1 rvb struct coda_nc_statistics coda_nc_stat; /* Keep various stats */
248 1.1 rvb
249 1.3 rvb /*
250 1.1 rvb * for testing purposes
251 1.1 rvb */
252 1.3 rvb int coda_nc_debug = 0;
253 1.1 rvb
254 1.3 rvb /*
255 1.3 rvb * Entry points for the CODA Name Cache
256 1.1 rvb */
257 1.1 rvb static struct coda_cache *
258 1.3 rvb coda_nc_find(struct cnode *dcp, const char *name, int namelen,
259 1.1 rvb struct ucred *cred, int hash);
260 1.1 rvb static void
261 1.1 rvb coda_nc_remove(struct coda_cache *cncp, enum dc_status dcstat);
262 1.1 rvb
263 1.1 rvb /*
264 1.3 rvb * Initialize the cache, the LRU structure and the Hash structure(s)
265 1.3 rvb */
266 1.1 rvb
267 1.3 rvb #define TOTAL_CACHE_SIZE (sizeof(struct coda_cache) * coda_nc_size)
268 1.1 rvb #define TOTAL_HASH_SIZE (sizeof(struct coda_hash) * coda_nc_hashsize)
269 1.1 rvb
270 1.3 rvb int coda_nc_initialized = 0; /* Initially the cache has not been initialized */
271 1.1 rvb
272 1.1 rvb void
273 1.1 rvb coda_nc_init(void)
274 1.1 rvb {
275 1.1 rvb int i;
276 1.3 rvb
277 1.1 rvb /* zero the statistics structure */
278 1.3 rvb
279 1.3 rvb bzero(&coda_nc_stat, (sizeof(struct coda_nc_statistics)));
280 1.3 rvb
281 1.1 rvb printf("CODA NAME CACHE: CACHE %d, HASH TBL %d\n", CODA_NC_CACHESIZE, CODA_NC_HASHSIZE);
282 1.3 rvb CODA_ALLOC(coda_nc_heap, struct coda_cache *, TOTAL_CACHE_SIZE);
283 1.3 rvb CODA_ALLOC(coda_nc_hash, struct coda_hash *, TOTAL_HASH_SIZE);
284 1.1 rvb
285 1.1 rvb coda_nc_lru.lru_next =
286 1.3 rvb coda_nc_lru.lru_prev = (struct coda_cache *)LRU_PART(&coda_nc_lru);
287 1.3 rvb
288 1.3 rvb
289 1.3 rvb for (i=0; i < coda_nc_size; i++) { /* initialize the heap */
290 1.1 rvb CODA_NC_LRUINS(&coda_nc_heap[i], &coda_nc_lru);
291 1.1 rvb CODA_NC_HSHNUL(&coda_nc_heap[i]);
292 1.3 rvb coda_nc_heap[i].cp = coda_nc_heap[i].dcp = (struct cnode *)0;
293 1.3 rvb }
294 1.1 rvb
295 1.1 rvb for (i=0; i < coda_nc_hashsize; i++) { /* initialize the hashtable */
296 1.3 rvb CODA_NC_HSHNUL((struct coda_cache *)&coda_nc_hash[i]);
297 1.1 rvb }
298 1.1 rvb
299 1.1 rvb coda_nc_initialized++;
300 1.1 rvb }
301 1.1 rvb
302 1.1 rvb /*
303 1.3 rvb * Auxillary routines -- shouldn't be entry points
304 1.3 rvb */
305 1.1 rvb
306 1.1 rvb static struct coda_cache *
307 1.1 rvb coda_nc_find(dcp, name, namelen, cred, hash)
308 1.1 rvb struct cnode *dcp;
309 1.1 rvb const char *name;
310 1.1 rvb int namelen;
311 1.1 rvb struct ucred *cred;
312 1.1 rvb int hash;
313 1.1 rvb {
314 1.1 rvb /*
315 1.3 rvb * hash to find the appropriate bucket, look through the chain
316 1.1 rvb * for the right entry (especially right cred, unless cred == 0)
317 1.1 rvb */
318 1.3 rvb struct coda_cache *cncp;
319 1.3 rvb int count = 1;
320 1.1 rvb
321 1.1 rvb CODA_NC_DEBUG(CODA_NC_FIND,
322 1.3 rvb myprintf(("coda_nc_find(dcp %p, name %s, len %d, cred %p, hash %d\n",
323 1.3 rvb dcp, name, namelen, cred, hash));)
324 1.1 rvb
325 1.1 rvb for (cncp = coda_nc_hash[hash].hash_next;
326 1.1 rvb cncp != (struct coda_cache *)&coda_nc_hash[hash];
327 1.3 rvb cncp = cncp->hash_next, count++)
328 1.1 rvb {
329 1.1 rvb
330 1.1 rvb if ((CODA_NAMEMATCH(cncp, name, namelen, dcp)) &&
331 1.3 rvb ((cred == 0) || (cncp->cred == cred)))
332 1.1 rvb {
333 1.1 rvb /* compare cr_uid instead */
334 1.1 rvb coda_nc_stat.Search_len += count;
335 1.3 rvb return(cncp);
336 1.3 rvb }
337 1.1 rvb #ifdef DEBUG
338 1.1 rvb else if (CODA_NAMEMATCH(cncp, name, namelen, dcp)) {
339 1.1 rvb printf("coda_nc_find: name %s, new cred = %p, cred = %p\n",
340 1.1 rvb name, cred, cncp->cred);
341 1.1 rvb printf("nref %d, nuid %d, ngid %d // oref %d, ocred %d, ogid %d\n",
342 1.1 rvb cred->cr_ref, cred->cr_uid, cred->cr_gid,
343 1.1 rvb cncp->cred->cr_ref, cncp->cred->cr_uid, cncp->cred->cr_gid);
344 1.1 rvb print_cred(cred);
345 1.1 rvb print_cred(cncp->cred);
346 1.1 rvb }
347 1.3 rvb #endif
348 1.1 rvb }
349 1.1 rvb
350 1.1 rvb return((struct coda_cache *)0);
351 1.1 rvb }
352 1.1 rvb
353 1.1 rvb /*
354 1.1 rvb * Enter a new (dir cnode, name) pair into the cache, updating the
355 1.3 rvb * LRU and Hash as needed.
356 1.1 rvb */
357 1.1 rvb void
358 1.1 rvb coda_nc_enter(dcp, name, namelen, cred, cp)
359 1.1 rvb struct cnode *dcp;
360 1.1 rvb const char *name;
361 1.1 rvb int namelen;
362 1.3 rvb struct ucred *cred;
363 1.1 rvb struct cnode *cp;
364 1.1 rvb {
365 1.3 rvb struct coda_cache *cncp;
366 1.1 rvb int hash;
367 1.1 rvb
368 1.3 rvb if (coda_nc_use == 0) /* Cache is off */
369 1.1 rvb return;
370 1.1 rvb
371 1.1 rvb CODA_NC_DEBUG(CODA_NC_ENTER,
372 1.3 rvb myprintf(("Enter: dcp %p cp %p name %s cred %p \n",
373 1.3 rvb dcp, cp, name, cred)); )
374 1.1 rvb
375 1.3 rvb if (namelen > CODA_NC_NAMELEN) {
376 1.1 rvb CODA_NC_DEBUG(CODA_NC_ENTER,
377 1.1 rvb myprintf(("long name enter %s\n",name));)
378 1.1 rvb coda_nc_stat.long_name_enters++; /* record stats */
379 1.3 rvb return;
380 1.3 rvb }
381 1.3 rvb
382 1.3 rvb hash = CODA_NC_HASH(name, namelen, dcp);
383 1.1 rvb cncp = coda_nc_find(dcp, name, namelen, cred, hash);
384 1.1 rvb if (cncp != (struct coda_cache *) 0) {
385 1.1 rvb coda_nc_stat.dbl_enters++; /* duplicate entry */
386 1.3 rvb return;
387 1.1 rvb }
388 1.1 rvb
389 1.3 rvb coda_nc_stat.enters++; /* record the enters statistic */
390 1.1 rvb
391 1.3 rvb /* Grab the next element in the lru chain */
392 1.1 rvb cncp = CODA_NC_LRUGET(coda_nc_lru);
393 1.3 rvb
394 1.1 rvb CODA_NC_LRUREM(cncp); /* remove it from the lists */
395 1.1 rvb
396 1.1 rvb if (CODA_NC_VALID(cncp)) {
397 1.3 rvb /* Seems really ugly, but we have to decrement the appropriate
398 1.1 rvb hash bucket length here, so we have to find the hash bucket
399 1.3 rvb */
400 1.3 rvb coda_nc_hash[CODA_NC_HASH(cncp->name, cncp->namelen, cncp->dcp)].length--;
401 1.1 rvb
402 1.1 rvb coda_nc_stat.lru_rm++; /* zapped a valid entry */
403 1.1 rvb CODA_NC_HSHREM(cncp);
404 1.1 rvb vrele(CTOV(cncp->dcp));
405 1.1 rvb vrele(CTOV(cncp->cp));
406 1.1 rvb crfree(cncp->cred);
407 1.1 rvb }
408 1.1 rvb
409 1.1 rvb /*
410 1.1 rvb * Put a hold on the current vnodes and fill in the cache entry.
411 1.1 rvb */
412 1.1 rvb vref(CTOV(cp));
413 1.1 rvb vref(CTOV(dcp));
414 1.1 rvb crhold(cred);
415 1.1 rvb cncp->dcp = dcp;
416 1.1 rvb cncp->cp = cp;
417 1.1 rvb cncp->namelen = namelen;
418 1.1 rvb cncp->cred = cred;
419 1.1 rvb
420 1.1 rvb bcopy(name, cncp->name, (unsigned)namelen);
421 1.3 rvb
422 1.3 rvb /* Insert into the lru and hash chains. */
423 1.3 rvb
424 1.1 rvb CODA_NC_LRUINS(cncp, &coda_nc_lru);
425 1.3 rvb CODA_NC_HSHINS(cncp, &coda_nc_hash[hash]);
426 1.1 rvb coda_nc_hash[hash].length++; /* Used for tuning */
427 1.1 rvb
428 1.1 rvb CODA_NC_DEBUG(CODA_NC_PRINTCODA_NC, print_coda_nc(); )
429 1.1 rvb }
430 1.1 rvb
431 1.1 rvb /*
432 1.1 rvb * Find the (dir cnode, name) pair in the cache, if it's cred
433 1.3 rvb * matches the input, return it, otherwise return 0
434 1.1 rvb */
435 1.1 rvb struct cnode *
436 1.1 rvb coda_nc_lookup(dcp, name, namelen, cred)
437 1.1 rvb struct cnode *dcp;
438 1.1 rvb const char *name;
439 1.1 rvb int namelen;
440 1.3 rvb struct ucred *cred;
441 1.1 rvb {
442 1.3 rvb int hash;
443 1.1 rvb struct coda_cache *cncp;
444 1.1 rvb
445 1.3 rvb if (coda_nc_use == 0) /* Cache is off */
446 1.3 rvb return((struct cnode *) 0);
447 1.1 rvb
448 1.3 rvb if (namelen > CODA_NC_NAMELEN) {
449 1.1 rvb CODA_NC_DEBUG(CODA_NC_LOOKUP,
450 1.1 rvb myprintf(("long name lookup %s\n",name));)
451 1.1 rvb coda_nc_stat.long_name_lookups++; /* record stats */
452 1.1 rvb return((struct cnode *) 0);
453 1.1 rvb }
454 1.1 rvb
455 1.1 rvb /* Use the hash function to locate the starting point,
456 1.1 rvb then the search routine to go down the list looking for
457 1.3 rvb the correct cred.
458 1.3 rvb */
459 1.3 rvb
460 1.3 rvb hash = CODA_NC_HASH(name, namelen, dcp);
461 1.1 rvb cncp = coda_nc_find(dcp, name, namelen, cred, hash);
462 1.1 rvb if (cncp == (struct coda_cache *) 0) {
463 1.1 rvb coda_nc_stat.misses++; /* record miss */
464 1.3 rvb return((struct cnode *) 0);
465 1.1 rvb }
466 1.1 rvb
467 1.3 rvb coda_nc_stat.hits++;
468 1.3 rvb
469 1.1 rvb /* put this entry at the end of the LRU */
470 1.1 rvb CODA_NC_LRUREM(cncp);
471 1.1 rvb CODA_NC_LRUINS(cncp, &coda_nc_lru);
472 1.3 rvb
473 1.3 rvb /* move it to the front of the hash chain */
474 1.1 rvb /* don't need to change the hash bucket length */
475 1.3 rvb CODA_NC_HSHREM(cncp);
476 1.1 rvb CODA_NC_HSHINS(cncp, &coda_nc_hash[hash]);
477 1.1 rvb
478 1.1 rvb CODA_NC_DEBUG(CODA_NC_LOOKUP,
479 1.1 rvb printf("lookup: dcp %p, name %s, cred %p = cp %p\n",
480 1.1 rvb dcp, name, cred, cncp->cp); )
481 1.1 rvb
482 1.1 rvb return(cncp->cp);
483 1.3 rvb }
484 1.3 rvb
485 1.1 rvb static void
486 1.1 rvb coda_nc_remove(cncp, dcstat)
487 1.1 rvb struct coda_cache *cncp;
488 1.1 rvb enum dc_status dcstat;
489 1.1 rvb {
490 1.1 rvb /*
491 1.1 rvb * remove an entry -- vrele(cncp->dcp, cp), crfree(cred),
492 1.3 rvb * remove it from it's hash chain, and
493 1.3 rvb * place it at the head of the lru list.
494 1.1 rvb */
495 1.1 rvb CODA_NC_DEBUG(CODA_NC_REMOVE,
496 1.1 rvb myprintf(("coda_nc_remove %s from parent %lx.%lx.%lx\n",
497 1.3 rvb cncp->name, (cncp->dcp)->c_fid.Volume,
498 1.1 rvb (cncp->dcp)->c_fid.Vnode, (cncp->dcp)->c_fid.Unique));)
499 1.3 rvb
500 1.1 rvb CODA_NC_HSHREM(cncp);
501 1.1 rvb
502 1.1 rvb CODA_NC_HSHNUL(cncp); /* have it be a null chain */
503 1.1 rvb if ((dcstat == IS_DOWNCALL) && (CTOV(cncp->dcp)->v_usecount == 1)) {
504 1.1 rvb cncp->dcp->c_flags |= C_PURGING;
505 1.1 rvb }
506 1.1 rvb vrele(CTOV(cncp->dcp));
507 1.1 rvb
508 1.1 rvb if ((dcstat == IS_DOWNCALL) && (CTOV(cncp->cp)->v_usecount == 1)) {
509 1.1 rvb cncp->cp->c_flags |= C_PURGING;
510 1.1 rvb }
511 1.1 rvb vrele(CTOV(cncp->cp));
512 1.1 rvb
513 1.1 rvb crfree(cncp->cred);
514 1.1 rvb bzero(DATA_PART(cncp),DATA_SIZE);
515 1.3 rvb
516 1.3 rvb /* Put the null entry just after the least-recently-used entry */
517 1.1 rvb /* LRU_TOP adjusts the pointer to point to the top of the structure. */
518 1.1 rvb CODA_NC_LRUREM(cncp);
519 1.1 rvb CODA_NC_LRUINS(cncp, LRU_TOP(coda_nc_lru.lru_prev));
520 1.1 rvb }
521 1.1 rvb
522 1.1 rvb /*
523 1.3 rvb * Remove all entries with a parent which has the input fid.
524 1.1 rvb */
525 1.1 rvb void
526 1.1 rvb coda_nc_zapParentfid(fid, dcstat)
527 1.1 rvb ViceFid *fid;
528 1.1 rvb enum dc_status dcstat;
529 1.1 rvb {
530 1.1 rvb /* To get to a specific fid, we might either have another hashing
531 1.1 rvb function or do a sequential search through the cache for the
532 1.3 rvb appropriate entries. The later may be acceptable since I don't
533 1.1 rvb think callbacks or whatever Case 1 covers are frequent occurences.
534 1.1 rvb */
535 1.3 rvb struct coda_cache *cncp, *ncncp;
536 1.1 rvb int i;
537 1.1 rvb
538 1.3 rvb if (coda_nc_use == 0) /* Cache is off */
539 1.1 rvb return;
540 1.1 rvb
541 1.1 rvb CODA_NC_DEBUG(CODA_NC_ZAPPFID,
542 1.3 rvb myprintf(("ZapParent: fid 0x%lx, 0x%lx, 0x%lx \n",
543 1.1 rvb fid->Volume, fid->Vnode, fid->Unique)); )
544 1.3 rvb
545 1.1 rvb coda_nc_stat.zapPfids++;
546 1.1 rvb
547 1.1 rvb for (i = 0; i < coda_nc_hashsize; i++) {
548 1.1 rvb
549 1.1 rvb /*
550 1.1 rvb * Need to save the hash_next pointer in case we remove the
551 1.3 rvb * entry. remove causes hash_next to point to itself.
552 1.3 rvb */
553 1.1 rvb
554 1.1 rvb for (cncp = coda_nc_hash[i].hash_next;
555 1.1 rvb cncp != (struct coda_cache *)&coda_nc_hash[i];
556 1.1 rvb cncp = ncncp) {
557 1.1 rvb ncncp = cncp->hash_next;
558 1.3 rvb if ((cncp->dcp->c_fid.Volume == fid->Volume) &&
559 1.3 rvb (cncp->dcp->c_fid.Vnode == fid->Vnode) &&
560 1.1 rvb (cncp->dcp->c_fid.Unique == fid->Unique)) {
561 1.1 rvb coda_nc_hash[i].length--; /* Used for tuning */
562 1.1 rvb coda_nc_remove(cncp, dcstat);
563 1.1 rvb }
564 1.1 rvb }
565 1.1 rvb }
566 1.1 rvb }
567 1.1 rvb
568 1.1 rvb /*
569 1.3 rvb * Remove all entries which have the same fid as the input
570 1.1 rvb */
571 1.1 rvb void
572 1.1 rvb coda_nc_zapfid(fid, dcstat)
573 1.1 rvb ViceFid *fid;
574 1.1 rvb enum dc_status dcstat;
575 1.1 rvb {
576 1.3 rvb /* See comment for zapParentfid. This routine will be used
577 1.1 rvb if attributes are being cached.
578 1.1 rvb */
579 1.3 rvb struct coda_cache *cncp, *ncncp;
580 1.1 rvb int i;
581 1.1 rvb
582 1.3 rvb if (coda_nc_use == 0) /* Cache is off */
583 1.1 rvb return;
584 1.1 rvb
585 1.1 rvb CODA_NC_DEBUG(CODA_NC_ZAPFID,
586 1.3 rvb myprintf(("Zapfid: fid 0x%lx, 0x%lx, 0x%lx \n",
587 1.1 rvb fid->Volume, fid->Vnode, fid->Unique)); )
588 1.3 rvb
589 1.3 rvb coda_nc_stat.zapFids++;
590 1.3 rvb
591 1.1 rvb for (i = 0; i < coda_nc_hashsize; i++) {
592 1.1 rvb for (cncp = coda_nc_hash[i].hash_next;
593 1.1 rvb cncp != (struct coda_cache *)&coda_nc_hash[i];
594 1.1 rvb cncp = ncncp) {
595 1.1 rvb ncncp = cncp->hash_next;
596 1.3 rvb if ((cncp->cp->c_fid.Volume == fid->Volume) &&
597 1.3 rvb (cncp->cp->c_fid.Vnode == fid->Vnode) &&
598 1.1 rvb (cncp->cp->c_fid.Unique == fid->Unique)) {
599 1.1 rvb coda_nc_hash[i].length--; /* Used for tuning */
600 1.1 rvb coda_nc_remove(cncp, dcstat);
601 1.1 rvb }
602 1.1 rvb }
603 1.1 rvb }
604 1.1 rvb }
605 1.1 rvb
606 1.1 rvb /*
607 1.3 rvb * Remove all entries which match the fid and the cred
608 1.1 rvb */
609 1.1 rvb void
610 1.1 rvb coda_nc_zapvnode(fid, cred, dcstat)
611 1.1 rvb ViceFid *fid;
612 1.1 rvb struct ucred *cred;
613 1.1 rvb enum dc_status dcstat;
614 1.1 rvb {
615 1.1 rvb /* See comment for zapfid. I don't think that one would ever
616 1.3 rvb want to zap a file with a specific cred from the kernel.
617 1.1 rvb We'll leave this one unimplemented.
618 1.1 rvb */
619 1.3 rvb if (coda_nc_use == 0) /* Cache is off */
620 1.1 rvb return;
621 1.1 rvb
622 1.1 rvb CODA_NC_DEBUG(CODA_NC_ZAPVNODE,
623 1.1 rvb myprintf(("Zapvnode: fid 0x%lx, 0x%lx, 0x%lx cred %p\n",
624 1.1 rvb fid->Volume, fid->Vnode, fid->Unique, cred)); )
625 1.1 rvb
626 1.1 rvb }
627 1.1 rvb
628 1.1 rvb /*
629 1.3 rvb * Remove all entries which have the (dir vnode, name) pair
630 1.1 rvb */
631 1.1 rvb void
632 1.1 rvb coda_nc_zapfile(dcp, name, namelen)
633 1.1 rvb struct cnode *dcp;
634 1.1 rvb const char *name;
635 1.1 rvb int namelen;
636 1.1 rvb {
637 1.3 rvb /* use the hash function to locate the file, then zap all
638 1.1 rvb entries of it regardless of the cred.
639 1.1 rvb */
640 1.3 rvb struct coda_cache *cncp;
641 1.1 rvb int hash;
642 1.1 rvb
643 1.3 rvb if (coda_nc_use == 0) /* Cache is off */
644 1.1 rvb return;
645 1.1 rvb
646 1.1 rvb CODA_NC_DEBUG(CODA_NC_ZAPFILE,
647 1.3 rvb myprintf(("Zapfile: dcp %p name %s \n",
648 1.3 rvb dcp, name)); )
649 1.1 rvb
650 1.1 rvb if (namelen > CODA_NC_NAMELEN) {
651 1.1 rvb coda_nc_stat.long_remove++; /* record stats */
652 1.3 rvb return;
653 1.1 rvb }
654 1.3 rvb
655 1.3 rvb coda_nc_stat.zapFile++;
656 1.1 rvb
657 1.1 rvb hash = CODA_NC_HASH(name, namelen, dcp);
658 1.3 rvb cncp = coda_nc_find(dcp, name, namelen, 0, hash);
659 1.1 rvb
660 1.3 rvb while (cncp) {
661 1.3 rvb coda_nc_hash[hash].length--; /* Used for tuning */
662 1.1 rvb /* 1.3 */
663 1.1 rvb coda_nc_remove(cncp, NOT_DOWNCALL);
664 1.1 rvb cncp = coda_nc_find(dcp, name, namelen, 0, hash);
665 1.1 rvb }
666 1.1 rvb }
667 1.1 rvb
668 1.1 rvb /*
669 1.1 rvb * Remove all the entries for a particular user. Used when tokens expire.
670 1.3 rvb * A user is determined by his/her effective user id (id_uid).
671 1.1 rvb */
672 1.1 rvb void
673 1.1 rvb coda_nc_purge_user(uid, dcstat)
674 1.1 rvb vuid_t uid;
675 1.1 rvb enum dc_status dcstat;
676 1.1 rvb {
677 1.1 rvb /*
678 1.1 rvb * I think the best approach is to go through the entire cache
679 1.1 rvb * via HASH or whatever and zap all entries which match the
680 1.1 rvb * input cred. Or just flush the whole cache. It might be
681 1.1 rvb * best to go through on basis of LRU since cache will almost
682 1.3 rvb * always be full and LRU is more straightforward.
683 1.1 rvb */
684 1.1 rvb
685 1.3 rvb struct coda_cache *cncp, *ncncp;
686 1.1 rvb int hash;
687 1.1 rvb
688 1.3 rvb if (coda_nc_use == 0) /* Cache is off */
689 1.1 rvb return;
690 1.3 rvb
691 1.1 rvb CODA_NC_DEBUG(CODA_NC_PURGEUSER,
692 1.3 rvb myprintf(("ZapDude: uid %lx\n", uid)); )
693 1.3 rvb coda_nc_stat.zapUsers++;
694 1.1 rvb
695 1.3 rvb for (cncp = CODA_NC_LRUGET(coda_nc_lru);
696 1.1 rvb cncp != (struct coda_cache *)(&coda_nc_lru);
697 1.3 rvb cncp = ncncp) {
698 1.1 rvb ncncp = CODA_NC_LRUGET(*cncp);
699 1.1 rvb
700 1.1 rvb if ((CODA_NC_VALID(cncp)) &&
701 1.1 rvb ((cncp->cred)->cr_uid == uid)) {
702 1.3 rvb /* Seems really ugly, but we have to decrement the appropriate
703 1.3 rvb hash bucket length here, so we have to find the hash bucket
704 1.1 rvb */
705 1.3 rvb hash = CODA_NC_HASH(cncp->name, cncp->namelen, cncp->dcp);
706 1.1 rvb coda_nc_hash[hash].length--; /* For performance tuning */
707 1.1 rvb
708 1.1 rvb coda_nc_remove(cncp, dcstat);
709 1.1 rvb }
710 1.1 rvb }
711 1.1 rvb }
712 1.1 rvb
713 1.1 rvb /*
714 1.3 rvb * Flush the entire name cache. In response to a flush of the Venus cache.
715 1.1 rvb */
716 1.1 rvb void
717 1.1 rvb coda_nc_flush(dcstat)
718 1.1 rvb enum dc_status dcstat;
719 1.1 rvb {
720 1.1 rvb /* One option is to deallocate the current name cache and
721 1.1 rvb call init to start again. Or just deallocate, then rebuild.
722 1.1 rvb Or again, we could just go through the array and zero the
723 1.1 rvb appropriate fields.
724 1.1 rvb */
725 1.1 rvb
726 1.1 rvb /*
727 1.1 rvb * Go through the whole lru chain and kill everything as we go.
728 1.3 rvb * I don't use remove since that would rebuild the lru chain
729 1.1 rvb * as it went and that seemed unneccesary.
730 1.1 rvb */
731 1.3 rvb struct coda_cache *cncp;
732 1.1 rvb int i;
733 1.1 rvb
734 1.3 rvb if (coda_nc_use == 0) /* Cache is off */
735 1.1 rvb return;
736 1.3 rvb
737 1.3 rvb coda_nc_stat.Flushes++;
738 1.3 rvb
739 1.3 rvb for (cncp = CODA_NC_LRUGET(coda_nc_lru);
740 1.1 rvb cncp != (struct coda_cache *)&coda_nc_lru;
741 1.3 rvb cncp = CODA_NC_LRUGET(*cncp)) {
742 1.3 rvb if (CODA_NC_VALID(cncp)) {
743 1.1 rvb
744 1.1 rvb CODA_NC_HSHREM(cncp); /* only zero valid nodes */
745 1.1 rvb CODA_NC_HSHNUL(cncp);
746 1.1 rvb if ((dcstat == IS_DOWNCALL)
747 1.1 rvb && (CTOV(cncp->dcp)->v_usecount == 1))
748 1.1 rvb {
749 1.1 rvb cncp->dcp->c_flags |= C_PURGING;
750 1.1 rvb }
751 1.3 rvb vrele(CTOV(cncp->dcp));
752 1.3 rvb
753 1.3 rvb if (CTOV(cncp->cp)->v_flag & VTEXT) {
754 1.1 rvb if (coda_vmflush(cncp->cp))
755 1.1 rvb CODADEBUG(CODA_FLUSH,
756 1.1 rvb myprintf(("coda_nc_flush: (%lx.%lx.%lx) busy\n", cncp->cp->c_fid.Volume, cncp->cp->c_fid.Vnode, cncp->cp->c_fid.Unique)); )
757 1.1 rvb }
758 1.1 rvb
759 1.1 rvb if ((dcstat == IS_DOWNCALL)
760 1.1 rvb && (CTOV(cncp->cp)->v_usecount == 1))
761 1.1 rvb {
762 1.1 rvb cncp->cp->c_flags |= C_PURGING;
763 1.1 rvb }
764 1.1 rvb vrele(CTOV(cncp->cp));
765 1.1 rvb
766 1.1 rvb crfree(cncp->cred);
767 1.1 rvb bzero(DATA_PART(cncp),DATA_SIZE);
768 1.3 rvb }
769 1.3 rvb }
770 1.1 rvb
771 1.1 rvb for (i = 0; i < coda_nc_hashsize; i++)
772 1.1 rvb coda_nc_hash[i].length = 0;
773 1.1 rvb }
774 1.1 rvb
775 1.1 rvb /*
776 1.1 rvb * Debugging routines
777 1.1 rvb */
778 1.1 rvb
779 1.1 rvb /*
780 1.3 rvb * This routine should print out all the hash chains to the console.
781 1.1 rvb */
782 1.1 rvb void
783 1.3 rvb print_coda_nc(void)
784 1.1 rvb {
785 1.3 rvb int hash;
786 1.1 rvb struct coda_cache *cncp;
787 1.1 rvb
788 1.3 rvb for (hash = 0; hash < coda_nc_hashsize; hash++) {
789 1.3 rvb myprintf(("\nhash %d\n",hash));
790 1.1 rvb
791 1.1 rvb for (cncp = coda_nc_hash[hash].hash_next;
792 1.1 rvb cncp != (struct coda_cache *)&coda_nc_hash[hash];
793 1.1 rvb cncp = cncp->hash_next) {
794 1.1 rvb myprintf(("cp %p dcp %p cred %p name %s\n",
795 1.1 rvb cncp->cp, cncp->dcp,
796 1.1 rvb cncp->cred, cncp->name));
797 1.1 rvb }
798 1.1 rvb }
799 1.3 rvb }
800 1.1 rvb
801 1.1 rvb void
802 1.1 rvb coda_nc_gather_stats(void)
803 1.3 rvb {
804 1.3 rvb int i, max = 0, sum = 0, temp, zeros = 0, ave, n;
805 1.3 rvb
806 1.1 rvb for (i = 0; i < coda_nc_hashsize; i++) {
807 1.1 rvb if (coda_nc_hash[i].length) {
808 1.1 rvb sum += coda_nc_hash[i].length;
809 1.1 rvb } else {
810 1.3 rvb zeros++;
811 1.3 rvb }
812 1.1 rvb
813 1.1 rvb if (coda_nc_hash[i].length > max)
814 1.1 rvb max = coda_nc_hash[i].length;
815 1.1 rvb }
816 1.1 rvb
817 1.1 rvb /*
818 1.3 rvb * When computing the Arithmetic mean, only count slots which
819 1.3 rvb * are not empty in the distribution.
820 1.3 rvb */
821 1.1 rvb coda_nc_stat.Sum_bucket_len = sum;
822 1.3 rvb coda_nc_stat.Num_zero_len = zeros;
823 1.1 rvb coda_nc_stat.Max_bucket_len = max;
824 1.1 rvb
825 1.1 rvb if ((n = coda_nc_hashsize - zeros) > 0)
826 1.1 rvb ave = sum / n;
827 1.1 rvb else
828 1.3 rvb ave = 0;
829 1.3 rvb
830 1.3 rvb sum = 0;
831 1.1 rvb for (i = 0; i < coda_nc_hashsize; i++) {
832 1.1 rvb if (coda_nc_hash[i].length) {
833 1.1 rvb temp = coda_nc_hash[i].length - ave;
834 1.3 rvb sum += temp * temp;
835 1.1 rvb }
836 1.1 rvb }
837 1.1 rvb coda_nc_stat.Sum2_bucket_len = sum;
838 1.1 rvb }
839 1.1 rvb
840 1.1 rvb /*
841 1.1 rvb * The purpose of this routine is to allow the hash and cache sizes to be
842 1.1 rvb * changed dynamically. This should only be used in controlled environments,
843 1.1 rvb * it makes no effort to lock other users from accessing the cache while it
844 1.3 rvb * is in an improper state (except by turning the cache off).
845 1.1 rvb */
846 1.1 rvb int
847 1.1 rvb coda_nc_resize(hashsize, heapsize, dcstat)
848 1.1 rvb int hashsize, heapsize;
849 1.1 rvb enum dc_status dcstat;
850 1.1 rvb {
851 1.1 rvb if ((hashsize % 2) || (heapsize % 2)) { /* Illegal hash or cache sizes */
852 1.3 rvb return(EINVAL);
853 1.1 rvb }
854 1.3 rvb
855 1.1 rvb coda_nc_use = 0; /* Turn the cache off */
856 1.1 rvb
857 1.3 rvb coda_nc_flush(dcstat); /* free any cnodes in the cache */
858 1.3 rvb
859 1.1 rvb /* WARNING: free must happen *before* size is reset */
860 1.3 rvb CODA_FREE(coda_nc_heap,TOTAL_CACHE_SIZE);
861 1.3 rvb CODA_FREE(coda_nc_hash,TOTAL_HASH_SIZE);
862 1.1 rvb
863 1.3 rvb coda_nc_hashsize = hashsize;
864 1.1 rvb coda_nc_size = heapsize;
865 1.3 rvb
866 1.1 rvb coda_nc_init(); /* Set up a cache with the new size */
867 1.1 rvb
868 1.1 rvb coda_nc_use = 1; /* Turn the cache back on */
869 1.3 rvb return(0);
870 1.1 rvb }
871 1.1 rvb
872 1.3 rvb char coda_nc_name_buf[CODA_MAXNAMLEN+1];
873 1.1 rvb
874 1.3 rvb void
875 1.1 rvb coda_nc_name(struct cnode *cp)
876 1.1 rvb {
877 1.3 rvb struct coda_cache *cncp, *ncncp;
878 1.1 rvb int i;
879 1.1 rvb
880 1.3 rvb if (coda_nc_use == 0) /* Cache is off */
881 1.3 rvb return;
882 1.3 rvb
883 1.1 rvb for (i = 0; i < coda_nc_hashsize; i++) {
884 1.1 rvb for (cncp = coda_nc_hash[i].hash_next;
885 1.1 rvb cncp != (struct coda_cache *)&coda_nc_hash[i];
886 1.3 rvb cncp = ncncp) {
887 1.3 rvb ncncp = cncp->hash_next;
888 1.1 rvb if (cncp->cp == cp) {
889 1.3 rvb bcopy(cncp->name, coda_nc_name_buf, cncp->namelen);
890 1.1 rvb coda_nc_name_buf[cncp->namelen] = 0;
891 1.1 rvb printf(" is %s (%p,%p)@%p",
892 1.1 rvb coda_nc_name_buf, cncp->cp, cncp->dcp, cncp);
893 1.1 rvb }
894 1.1 rvb
895 }
896 }
897 }
898