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