afs: use jenkins hash for dcache, vcache tables
[openafs.git] / src / afs / afs_dcache.c
1 /*
2  * Copyright 2000, International Business Machines Corporation and others.
3  * All Rights Reserved.
4  *
5  * This software has been released under the terms of the IBM Public
6  * License.  For details, see the LICENSE file in the top-level source
7  * directory or online at http://www.openafs.org/dl/license10.html
8  */
9
10 /*
11  * Implements:
12  */
13 #include <afsconfig.h>
14 #include "afs/param.h"
15
16
17 #include "afs/sysincludes.h"    /*Standard vendor system headers */
18 #include "afsincludes.h"        /*AFS-based standard headers */
19 #include "afs/afs_stats.h"      /* statistics */
20 #include "afs/afs_cbqueue.h"
21 #include "afs/afs_osidnlc.h"
22
23 /* Forward declarations. */
24 static void afs_GetDownD(int anumber, int *aneedSpace, afs_int32 buckethint);
25 static int afs_FreeDiscardedDCache(void);
26 static void afs_DiscardDCache(struct dcache *);
27 static void afs_FreeDCache(struct dcache *);
28 /* For split cache */
29 static afs_int32 afs_DCGetBucket(struct vcache *);
30 static void afs_DCAdjustSize(struct dcache *, afs_int32, afs_int32);
31 static void afs_DCMoveBucket(struct dcache *, afs_int32, afs_int32);
32 static void afs_DCSizeInit(void);
33 static afs_int32 afs_DCWhichBucket(afs_int32, afs_int32);
34
35 /*
36  * --------------------- Exported definitions ---------------------
37  */
38 /* For split cache */
39 afs_int32 afs_blocksUsed_0;    /*!< 1K blocks in cache - in theory is zero */
40 afs_int32 afs_blocksUsed_1;    /*!< 1K blocks in cache */
41 afs_int32 afs_blocksUsed_2;    /*!< 1K blocks in cache */
42 afs_int32 afs_pct1 = -1;
43 afs_int32 afs_pct2 = -1;
44 afs_uint32 afs_tpct1 = 0;
45 afs_uint32 afs_tpct2 = 0;
46 afs_uint32 splitdcache = 0;
47
48 afs_lock_t afs_xdcache;         /*!< Lock: alloc new disk cache entries */
49 afs_int32 afs_freeDCList;       /*!< Free list for disk cache entries */
50 afs_int32 afs_freeDCCount;      /*!< Count of elts in freeDCList */
51 afs_int32 afs_discardDCList;    /*!< Discarded disk cache entries */
52 afs_int32 afs_discardDCCount;   /*!< Count of elts in discardDCList */
53 struct dcache *afs_freeDSList;  /*!< Free list for disk slots */
54 struct dcache *afs_Initial_freeDSList;  /*!< Initial list for above */
55 afs_dcache_id_t cacheInode;               /*!< Inode for CacheItems file */
56 struct osi_file *afs_cacheInodep = 0;   /*!< file for CacheItems inode */
57 struct afs_q afs_DLRU;          /*!< dcache LRU */
58 afs_int32 afs_dhashsize = 1024;
59 afs_int32 *afs_dvhashTbl;       /*!< Data cache hash table: hashed by FID + chunk number. */
60 afs_int32 *afs_dchashTbl;       /*!< Data cache hash table: hashed by FID. */
61 afs_int32 *afs_dvnextTbl;       /*!< Dcache hash table links */
62 afs_int32 *afs_dcnextTbl;       /*!< Dcache hash table links */
63 struct dcache **afs_indexTable; /*!< Pointers to dcache entries */
64 afs_hyper_t *afs_indexTimes;    /*!< Dcache entry Access times */
65 afs_int32 *afs_indexUnique;     /*!< dcache entry Fid.Unique */
66 unsigned char *afs_indexFlags;  /*!< (only one) Is there data there? */
67 afs_hyper_t afs_indexCounter;   /*!< Fake time for marking index
68                                  * entries */
69 afs_int32 afs_cacheFiles = 0;   /*!< Size of afs_indexTable */
70 afs_int32 afs_cacheBlocks;      /*!< 1K blocks in cache */
71 afs_int32 afs_cacheStats;       /*!< Stat entries in cache */
72 afs_int32 afs_blocksUsed;       /*!< Number of blocks in use */
73 afs_int32 afs_blocksDiscarded;  /*!<Blocks freed but not truncated */
74 afs_int32 afs_fsfragsize = AFS_MIN_FRAGSIZE;    /*!< Underlying Filesystem minimum unit
75                                          *of disk allocation usually 1K
76                                          *this value is (truefrag -1 ) to
77                                          *save a bunch of subtracts... */
78 #ifdef AFS_64BIT_CLIENT
79 #ifdef AFS_VM_RDWR_ENV
80 afs_size_t afs_vmMappingEnd;    /* !< For large files (>= 2GB) the VM
81                                  * mapping an 32bit addressing machines
82                                  * can only be used below the 2 GB
83                                  * line. From this point upwards we
84                                  * must do direct I/O into the cache
85                                  * files. The value should be on a
86                                  * chunk boundary. */
87 #endif /* AFS_VM_RDWR_ENV */
88 #endif /* AFS_64BIT_CLIENT */
89
90 /* The following is used to ensure that new dcache's aren't obtained when
91  * the cache is nearly full.
92  */
93 int afs_WaitForCacheDrain = 0;
94 int afs_TruncateDaemonRunning = 0;
95 int afs_CacheTooFull = 0;
96
97 afs_int32 afs_dcentries;        /*!< In-memory dcache entries */
98
99
100 int dcacheDisabled = 0;
101
102 struct afs_cacheOps afs_UfsCacheOps = {
103 #ifndef HAVE_STRUCT_LABEL_SUPPORT
104     osi_UFSOpen,
105     osi_UFSTruncate,
106     afs_osi_Read,
107     afs_osi_Write,
108     osi_UFSClose,
109     afs_UFSReadUIO,
110     afs_UFSWriteUIO,
111     afs_UFSGetDSlot,
112     afs_UFSGetVolSlot,
113     afs_UFSHandleLink,
114 #else
115     .open       = osi_UFSOpen,
116     .truncate   = osi_UFSTruncate,
117     .fread      = afs_osi_Read,
118     .fwrite     = afs_osi_Write,
119     .close      = osi_UFSClose,
120     .vreadUIO   = afs_UFSReadUIO,
121     .vwriteUIO  = afs_UFSWriteUIO,
122     .GetDSlot   = afs_UFSGetDSlot,
123     .GetVolSlot = afs_UFSGetVolSlot,
124     .HandleLink = afs_UFSHandleLink,
125 #endif
126 };
127
128 struct afs_cacheOps afs_MemCacheOps = {
129 #ifndef HAVE_STRUCT_LABEL_SUPPORT
130     afs_MemCacheOpen,
131     afs_MemCacheTruncate,
132     afs_MemReadBlk,
133     afs_MemWriteBlk,
134     afs_MemCacheClose,
135     afs_MemReadUIO,
136     afs_MemWriteUIO,
137     afs_MemGetDSlot,
138     afs_MemGetVolSlot,
139     afs_MemHandleLink,
140 #else
141     .open       = afs_MemCacheOpen,
142     .truncate   = afs_MemCacheTruncate,
143     .fread      = afs_MemReadBlk,
144     .fwrite     = afs_MemWriteBlk,
145     .close      = afs_MemCacheClose,
146     .vreadUIO   = afs_MemReadUIO,
147     .vwriteUIO  = afs_MemWriteUIO,
148     .GetDSlot   = afs_MemGetDSlot,
149     .GetVolSlot = afs_MemGetVolSlot,
150     .HandleLink = afs_MemHandleLink,
151 #endif
152 };
153
154 int cacheDiskType;              /*Type of backing disk for cache */
155 struct afs_cacheOps *afs_cacheType;
156
157
158 /*
159  * The PFlush algorithm makes use of the fact that Fid.Unique is not used in
160  * below hash algorithms.  Change it if need be so that flushing algorithm
161  * doesn't move things from one hash chain to another.
162  */
163 /*Vnode, Chunk -> Hash table index */
164 int DCHash(struct VenusFid *fid, afs_int32 chunk)
165 {
166     afs_uint32 buf[3];
167
168     buf[0] = fid->Fid.Volume;
169     buf[1] = fid->Fid.Vnode;
170     buf[2] = chunk;
171     return opr_jhash(buf, 3, 0) & (afs_dhashsize - 1);
172 }
173 /*Vnode -> Other hash table index */
174 int DVHash(struct VenusFid *fid)
175 {
176     return opr_jhash_int2(fid->Fid.Volume, fid->Fid.Vnode, 0) &
177         (afs_dhashsize - 1);
178 }
179
180 /*!
181  * Where is this vcache's entry associated dcache located/
182  * \param avc The vcache entry.
183  * \return Bucket index:
184  *      1 : main
185  *      2 : RO
186  */
187 static afs_int32
188 afs_DCGetBucket(struct vcache *avc)
189 {
190     if (!splitdcache)
191         return 1;
192
193     /* This should be replaced with some sort of user configurable function */
194     if (avc->f.states & CRO) {
195         return 2;
196     } else if (avc->f.states & CBackup) {
197         return 1;
198     } else {
199         /* RW */
200     }
201     /* main bucket */
202     return 1;
203 }
204
205 /*!
206  * Readjust a dcache's size.
207  *
208  * \param adc The dcache to be adjusted.
209  * \param oldSize Old size for the dcache.
210  * \param newSize The new size to be adjusted to.
211  *
212  */
213 static void
214 afs_DCAdjustSize(struct dcache *adc, afs_int32 oldSize, afs_int32 newSize)
215 {
216     afs_int32 adjustSize = newSize - oldSize;
217
218     if (!splitdcache)
219         return;
220
221     switch (adc->bucket)
222     {
223     case 0:
224         afs_blocksUsed_0 += adjustSize;
225         afs_stats_cmperf.cacheBucket0_Discarded += oldSize;
226         break;
227     case 1:
228         afs_blocksUsed_1 += adjustSize;
229         afs_stats_cmperf.cacheBucket1_Discarded += oldSize;
230         break;
231     case 2:
232         afs_blocksUsed_2 += adjustSize;
233         afs_stats_cmperf.cacheBucket2_Discarded += oldSize;
234         break;
235     }
236
237     return;
238 }
239
240 /*!
241  * Move a dcache from one bucket to another.
242  *
243  * \param adc Operate on this dcache.
244  * \param size Size in bucket (?).
245  * \param newBucket Destination bucket.
246  *
247  */
248 static void
249 afs_DCMoveBucket(struct dcache *adc, afs_int32 size, afs_int32 newBucket)
250 {
251     if (!splitdcache)
252         return;
253
254     /* Substract size from old bucket. */
255     switch (adc->bucket)
256     {
257     case 0:
258         afs_blocksUsed_0 -= size;
259         break;
260     case 1:
261         afs_blocksUsed_1 -= size;
262         break;
263     case 2:
264         afs_blocksUsed_2 -= size;
265         break;
266     }
267
268     /* Set new bucket and increase destination bucket size. */
269     adc->bucket = newBucket;
270
271     switch (adc->bucket)
272     {
273     case 0:
274         afs_blocksUsed_0 += size;
275         break;
276     case 1:
277         afs_blocksUsed_1 += size;
278         break;
279     case 2:
280         afs_blocksUsed_2 += size;
281         break;
282     }
283
284     return;
285 }
286
287 /*!
288  * Init split caches size.
289  */
290 static void
291 afs_DCSizeInit(void)
292 {
293     afs_blocksUsed_0 = afs_blocksUsed_1 = afs_blocksUsed_2 = 0;
294 }
295
296
297 /*!
298  * \param phase
299  * \param bucket
300  */
301 static afs_int32
302 afs_DCWhichBucket(afs_int32 phase, afs_int32 bucket)
303 {
304     if (!splitdcache)
305         return 0;
306
307     afs_pct1 = afs_blocksUsed_1 / (afs_cacheBlocks / 100);
308     afs_pct2 = afs_blocksUsed_2 / (afs_cacheBlocks / 100);
309
310     /* Short cut: if we don't know about it, try to kill it */
311     if (phase < 2 && afs_blocksUsed_0)
312         return 0;
313
314     if (afs_pct1 > afs_tpct1)
315         return 1;
316     if (afs_pct2 > afs_tpct2)
317         return 2;
318     return 0; /* unlikely */
319 }
320
321
322 /*!
323  * Warn about failing to store a file.
324  *
325  * \param acode Associated error code.
326  * \param avolume Volume involved.
327  * \param aflags How to handle the output:
328  *      aflags & 1: Print out on console
329  *      aflags & 2: Print out on controlling tty
330  *
331  * \note Environment: Call this from close call when vnodeops is RCS unlocked.
332  */
333
334 void
335 afs_StoreWarn(afs_int32 acode, afs_int32 avolume,
336               afs_int32 aflags)
337 {
338     static char problem_fmt[] =
339         "afs: failed to store file in volume %d (%s)\n";
340     static char problem_fmt_w_error[] =
341         "afs: failed to store file in volume %d (error %d)\n";
342     static char netproblems[] = "network problems";
343     static char partfull[] = "partition full";
344     static char overquota[] = "over quota";
345
346     AFS_STATCNT(afs_StoreWarn);
347     if (acode < 0) {
348         /*
349          * Network problems
350          */
351         if (aflags & 1)
352             afs_warn(problem_fmt, avolume, netproblems);
353         if (aflags & 2)
354             afs_warnuser(problem_fmt, avolume, netproblems);
355     } else if (acode == ENOSPC) {
356         /*
357          * Partition full
358          */
359         if (aflags & 1)
360             afs_warn(problem_fmt, avolume, partfull);
361         if (aflags & 2)
362             afs_warnuser(problem_fmt, avolume, partfull);
363     } else
364 #ifdef  EDQUOT
365         /* EDQUOT doesn't exist on solaris and won't be sent by the server.
366          * Instead ENOSPC will be sent...
367          */
368     if (acode == EDQUOT) {
369         /*
370          * Quota exceeded
371          */
372         if (aflags & 1)
373             afs_warn(problem_fmt, avolume, overquota);
374         if (aflags & 2)
375             afs_warnuser(problem_fmt, avolume, overquota);
376     } else
377 #endif
378     {
379         /*
380          * Unknown error
381          */
382         if (aflags & 1)
383             afs_warn(problem_fmt_w_error, avolume, acode);
384         if (aflags & 2)
385             afs_warnuser(problem_fmt_w_error, avolume, acode);
386     }
387 }                               /*afs_StoreWarn */
388
389 /*!
390  * Try waking up truncation daemon, if it's worth it.
391  */
392 void
393 afs_MaybeWakeupTruncateDaemon(void)
394 {
395     if (!afs_CacheTooFull && afs_CacheIsTooFull()) {
396         afs_CacheTooFull = 1;
397         if (!afs_TruncateDaemonRunning)
398             afs_osi_Wakeup((int *)afs_CacheTruncateDaemon);
399     } else if (!afs_TruncateDaemonRunning
400                && afs_blocksDiscarded > CM_MAXDISCARDEDCHUNKS) {
401         afs_osi_Wakeup((int *)afs_CacheTruncateDaemon);
402     }
403 }
404
405 /*!
406  * /struct CTD_stats
407  *
408  * Keep statistics on run time for afs_CacheTruncateDaemon. This is a
409  * struct so we need only export one symbol for AIX.
410  */
411 static struct CTD_stats {
412     osi_timeval_t CTD_beforeSleep;
413     osi_timeval_t CTD_afterSleep;
414     osi_timeval_t CTD_sleepTime;
415     osi_timeval_t CTD_runTime;
416     int CTD_nSleeps;
417 } CTD_stats;
418
419 u_int afs_min_cache = 0;
420
421 /*!
422  * If there are waiters for the cache to drain, wake them if
423  * the number of free or discarded cache blocks reaches the
424  * CM_CACHESIZEDDRAINEDPCT limit.
425  *
426  * \note Environment:
427  *      This routine must be called with the afs_xdcache lock held
428  *      (in write mode).
429  */
430 static void
431 afs_WakeCacheWaitersIfDrained(void)
432 {
433     if (afs_WaitForCacheDrain) {
434         if ((afs_blocksUsed - afs_blocksDiscarded) <=
435             PERCENT(CM_CACHESIZEDRAINEDPCT, afs_cacheBlocks)) {
436             afs_WaitForCacheDrain = 0;
437             afs_osi_Wakeup(&afs_WaitForCacheDrain);
438         }
439     }
440 }
441
442 /*!
443  * Keeps the cache clean and free by truncating uneeded files, when used.
444  * \param
445  * \return
446  */
447 void
448 afs_CacheTruncateDaemon(void)
449 {
450     osi_timeval_t CTD_tmpTime;
451     u_int counter;
452     u_int cb_lowat;
453     u_int dc_hiwat =
454         PERCENT((100 - CM_DCACHECOUNTFREEPCT + CM_DCACHEEXTRAPCT), afs_cacheFiles);
455     afs_min_cache =
456         (((10 * AFS_CHUNKSIZE(0)) + afs_fsfragsize) & ~afs_fsfragsize) >> 10;
457
458     osi_GetuTime(&CTD_stats.CTD_afterSleep);
459     afs_TruncateDaemonRunning = 1;
460     while (1) {
461         cb_lowat = PERCENT((CM_DCACHESPACEFREEPCT - CM_DCACHEEXTRAPCT), afs_cacheBlocks);
462         ObtainWriteLock(&afs_xdcache, 266);
463         if (afs_CacheTooFull || afs_WaitForCacheDrain) {
464             int space_needed, slots_needed;
465             /* if we get woken up, we should try to clean something out */
466             for (counter = 0; counter < 10; counter++) {
467                 space_needed =
468                     afs_blocksUsed - afs_blocksDiscarded - cb_lowat;
469                 if (space_needed < 0)
470                     space_needed = 0;
471                 slots_needed =
472                     dc_hiwat - afs_freeDCCount - afs_discardDCCount;
473                 if (slots_needed < 0)
474                     slots_needed = 0;
475                 if (slots_needed || space_needed)
476                     afs_GetDownD(slots_needed, &space_needed, 0);
477                 if ((space_needed <= 0) && (slots_needed <= 0)) {
478                     break;
479                 }
480                 if (afs_termState == AFSOP_STOP_TRUNCDAEMON)
481                     break;
482             }
483             if (!afs_CacheIsTooFull()) {
484                 afs_CacheTooFull = 0;
485                 afs_WakeCacheWaitersIfDrained();
486             }
487         }       /* end of cache cleanup */
488         ReleaseWriteLock(&afs_xdcache);
489
490         /*
491          * This is a defensive check to try to avoid starving threads
492          * that may need the global lock so thay can help free some
493          * cache space. If this thread won't be sleeping or truncating
494          * any cache files then give up the global lock so other
495          * threads get a chance to run.
496          */
497         if ((afs_termState != AFSOP_STOP_TRUNCDAEMON) && afs_CacheTooFull
498             && (!afs_blocksDiscarded || afs_WaitForCacheDrain)) {
499             afs_osi_Wait(100, 0, 0);    /* 100 milliseconds */
500         }
501
502         /*
503          * This is where we free the discarded cache elements.
504          */
505         while (afs_blocksDiscarded && !afs_WaitForCacheDrain
506                && (afs_termState != AFSOP_STOP_TRUNCDAEMON)) {
507             int code = afs_FreeDiscardedDCache();
508             if (code) {
509                 /* If we can't free any discarded dcache entries, that's okay.
510                  * We're just doing this in the background; if someone needs
511                  * discarded entries freed, they will try it themselves and/or
512                  * signal us that the cache is too full. In any case, we'll
513                  * try doing this again the next time we run through the loop.
514                  */
515                 break;
516             }
517         }
518
519         /* See if we need to continue to run. Someone may have
520          * signalled us while we were executing.
521          */
522         if (!afs_WaitForCacheDrain && !afs_CacheTooFull
523             && (afs_termState != AFSOP_STOP_TRUNCDAEMON)) {
524             /* Collect statistics on truncate daemon. */
525             CTD_stats.CTD_nSleeps++;
526             osi_GetuTime(&CTD_stats.CTD_beforeSleep);
527             afs_stats_GetDiff(CTD_tmpTime, CTD_stats.CTD_afterSleep,
528                               CTD_stats.CTD_beforeSleep);
529             afs_stats_AddTo(CTD_stats.CTD_runTime, CTD_tmpTime);
530
531             afs_TruncateDaemonRunning = 0;
532             afs_osi_Sleep((int *)afs_CacheTruncateDaemon);
533             afs_TruncateDaemonRunning = 1;
534
535             osi_GetuTime(&CTD_stats.CTD_afterSleep);
536             afs_stats_GetDiff(CTD_tmpTime, CTD_stats.CTD_beforeSleep,
537                               CTD_stats.CTD_afterSleep);
538             afs_stats_AddTo(CTD_stats.CTD_sleepTime, CTD_tmpTime);
539         }
540         if (afs_termState == AFSOP_STOP_TRUNCDAEMON) {
541             afs_termState = AFSOP_STOP_AFSDB;
542             afs_osi_Wakeup(&afs_termState);
543             break;
544         }
545     }
546 }
547
548
549 /*!
550  * Make adjustment for the new size in the disk cache entry
551  *
552  * \note Major Assumptions Here:
553  *      Assumes that frag size is an integral power of two, less one,
554  *      and that this is a two's complement machine.  I don't
555  *      know of any filesystems which violate this assumption...
556  *
557  * \param adc Ptr to dcache entry.
558  * \param anewsize New size desired.
559  *
560  */
561
562 void
563 afs_AdjustSize(struct dcache *adc, afs_int32 newSize)
564 {
565     afs_int32 oldSize;
566
567     AFS_STATCNT(afs_AdjustSize);
568
569     adc->dflags |= DFEntryMod;
570     oldSize = ((adc->f.chunkBytes + afs_fsfragsize) ^ afs_fsfragsize) >> 10;    /* round up */
571     adc->f.chunkBytes = newSize;
572     if (!newSize)
573         adc->validPos = 0;
574     newSize = ((newSize + afs_fsfragsize) ^ afs_fsfragsize) >> 10;      /* round up */
575     afs_DCAdjustSize(adc, oldSize, newSize);
576     if ((newSize > oldSize) && !AFS_IS_DISCONNECTED) {
577
578         /* We're growing the file, wakeup the daemon */
579         afs_MaybeWakeupTruncateDaemon();
580     }
581     afs_blocksUsed += (newSize - oldSize);
582     afs_stats_cmperf.cacheBlocksInUse = afs_blocksUsed; /* XXX */
583 }
584
585
586 /*!
587  * This routine is responsible for moving at least one entry (but up
588  * to some number of them) from the LRU queue to the free queue.
589  *
590  * \param anumber Number of entries that should ideally be moved.
591  * \param aneedSpace How much space we need (1K blocks);
592  *
593  * \note Environment:
594  *      The anumber parameter is just a hint; at least one entry MUST be
595  *      moved, or we'll panic.  We must be called with afs_xdcache
596  *      write-locked.  We should try to satisfy both anumber and aneedspace,
597  *      whichever is more demanding - need to do several things:
598  *      1.  only grab up to anumber victims if aneedSpace <= 0, not
599  *          the whole set of MAXATONCE.
600  *      2.  dynamically choose MAXATONCE to reflect severity of
601  *          demand: something like (*aneedSpace >> (logChunk - 9))
602  *
603  *  \note N.B. if we're called with aneedSpace <= 0 and anumber > 0, that
604  *  indicates that the cache is not properly configured/tuned or
605  *  something. We should be able to automatically correct that problem.
606  */
607
608 #define MAXATONCE   16          /* max we can obtain at once */
609 static void
610 afs_GetDownD(int anumber, int *aneedSpace, afs_int32 buckethint)
611 {
612
613     struct dcache *tdc;
614     struct VenusFid *afid;
615     afs_int32 i, j;
616     afs_hyper_t vtime;
617     int skip, phase;
618     struct vcache *tvc;
619     afs_uint32 victims[MAXATONCE];
620     struct dcache *victimDCs[MAXATONCE];
621     afs_hyper_t victimTimes[MAXATONCE]; /* youngest (largest LRU time) first */
622     afs_uint32 victimPtr;       /* next free item in victim arrays */
623     afs_hyper_t maxVictimTime;  /* youngest (largest LRU time) victim */
624     afs_uint32 maxVictimPtr;    /* where it is */
625     int discard;
626     int curbucket;
627
628     AFS_STATCNT(afs_GetDownD);
629
630     if (CheckLock(&afs_xdcache) != -1)
631         osi_Panic("getdownd nolock");
632     /* decrement anumber first for all dudes in free list */
633     /* SHOULD always decrement anumber first, even if aneedSpace >0,
634      * because we should try to free space even if anumber <=0 */
635     if (!aneedSpace || *aneedSpace <= 0) {
636         anumber -= afs_freeDCCount;
637         if (anumber <= 0) {
638             return;             /* enough already free */
639         }
640     }
641
642     /* bounds check parameter */
643     if (anumber > MAXATONCE)
644         anumber = MAXATONCE;    /* all we can do */
645
646     /* rewrite so phases include a better eligiblity for gc test*/
647     /*
648      * The phase variable manages reclaims.  Set to 0, the first pass,
649      * we don't reclaim active entries, or other than target bucket.
650      * Set to 1, we reclaim even active ones in target bucket.
651      * Set to 2, we reclaim any inactive one.
652      * Set to 3, we reclaim even active ones. On Solaris, we also reclaim
653      * entries whose corresponding vcache has a nonempty multiPage list, when
654      * possible.
655      */
656     if (splitdcache) {
657         phase = 0;
658     } else {
659         phase = 4;
660     }
661
662     for (i = 0; i < afs_cacheFiles; i++)
663         /* turn off all flags */
664         afs_indexFlags[i] &= ~IFFlag;
665
666     while (anumber > 0 || (aneedSpace && *aneedSpace > 0)) {
667         /* find oldest entries for reclamation */
668         maxVictimPtr = victimPtr = 0;
669         hzero(maxVictimTime);
670         curbucket = afs_DCWhichBucket(phase, buckethint);
671         /* select victims from access time array */
672         for (i = 0; i < afs_cacheFiles; i++) {
673             if (afs_indexFlags[i] & (IFDataMod | IFFree | IFDiscarded)) {
674                 /* skip if dirty or already free */
675                 continue;
676             }
677             tdc = afs_indexTable[i];
678             if (tdc && (curbucket != tdc->bucket) && (phase < 4))
679             {
680                 /* Wrong bucket; can't use it! */
681                 continue;
682             }
683             if (tdc && (tdc->refCount != 0)) {
684                 /* Referenced; can't use it! */
685                 continue;
686             }
687             hset(vtime, afs_indexTimes[i]);
688
689             /* if we've already looked at this one, skip it */
690             if (afs_indexFlags[i] & IFFlag)
691                 continue;
692
693             if (victimPtr < MAXATONCE) {
694                 /* if there's at least one free victim slot left */
695                 victims[victimPtr] = i;
696                 hset(victimTimes[victimPtr], vtime);
697                 if (hcmp(vtime, maxVictimTime) > 0) {
698                     hset(maxVictimTime, vtime);
699                     maxVictimPtr = victimPtr;
700                 }
701                 victimPtr++;
702             } else if (hcmp(vtime, maxVictimTime) < 0) {
703                 /*
704                  * We're older than youngest victim, so we replace at
705                  * least one victim
706                  */
707                 /* find youngest (largest LRU) victim */
708                 j = maxVictimPtr;
709                 if (j == victimPtr)
710                     osi_Panic("getdownd local");
711                 victims[j] = i;
712                 hset(victimTimes[j], vtime);
713                 /* recompute maxVictimTime */
714                 hset(maxVictimTime, vtime);
715                 for (j = 0; j < victimPtr; j++)
716                     if (hcmp(maxVictimTime, victimTimes[j]) < 0) {
717                         hset(maxVictimTime, victimTimes[j]);
718                         maxVictimPtr = j;
719                     }
720             }
721         }                       /* big for loop */
722
723         /* now really reclaim the victims */
724         j = 0;                  /* flag to track if we actually got any of the victims */
725         /* first, hold all the victims, since we're going to release the lock
726          * during the truncate operation.
727          */
728         for (i = 0; i < victimPtr; i++) {
729             tdc = afs_GetValidDSlot(victims[i]);
730             /* We got tdc->tlock(R) here */
731             if (tdc && tdc->refCount == 1)
732                 victimDCs[i] = tdc;
733             else
734                 victimDCs[i] = 0;
735             if (tdc) {
736                 ReleaseReadLock(&tdc->tlock);
737                 if (!victimDCs[i])
738                     afs_PutDCache(tdc);
739             }
740         }
741         for (i = 0; i < victimPtr; i++) {
742             /* q is first elt in dcache entry */
743             tdc = victimDCs[i];
744             /* now, since we're dropping the afs_xdcache lock below, we
745              * have to verify, before proceeding, that there are no other
746              * references to this dcache entry, even now.  Note that we
747              * compare with 1, since we bumped it above when we called
748              * afs_GetValidDSlot to preserve the entry's identity.
749              */
750             if (tdc && tdc->refCount == 1) {
751                 unsigned char chunkFlags;
752                 afs_size_t tchunkoffset = 0;
753                 afid = &tdc->f.fid;
754                 /* xdcache is lower than the xvcache lock */
755                 ReleaseWriteLock(&afs_xdcache);
756                 ObtainReadLock(&afs_xvcache);
757                 tvc = afs_FindVCache(afid, 0, 0 /* no stats, no vlru */ );
758                 ReleaseReadLock(&afs_xvcache);
759                 ObtainWriteLock(&afs_xdcache, 527);
760                 skip = 0;
761                 if (tdc->refCount > 1)
762                     skip = 1;
763                 if (tvc) {
764                     tchunkoffset = AFS_CHUNKTOBASE(tdc->f.chunk);
765                     chunkFlags = afs_indexFlags[tdc->index];
766                     if (((phase & 1) == 0) && osi_Active(tvc))
767                         skip = 1;
768                     if (((phase & 1) == 1) && osi_Active(tvc)
769                         && (tvc->f.states & CDCLock)
770                         && (chunkFlags & IFAnyPages))
771                         skip = 1;
772                     if (chunkFlags & IFDataMod)
773                         skip = 1;
774                     afs_Trace4(afs_iclSetp, CM_TRACE_GETDOWND,
775                                ICL_TYPE_POINTER, tvc, ICL_TYPE_INT32, skip,
776                                ICL_TYPE_INT32, tdc->index, ICL_TYPE_OFFSET,
777                                ICL_HANDLE_OFFSET(tchunkoffset));
778
779 #if     defined(AFS_SUN5_ENV)
780                     /*
781                      * Now we try to invalidate pages.  We do this only for
782                      * Solaris.  For other platforms, it's OK to recycle a
783                      * dcache entry out from under a page, because the strategy
784                      * function can call afs_GetDCache().
785                      */
786                     if (!skip && (chunkFlags & IFAnyPages)) {
787                         int code;
788
789                         ReleaseWriteLock(&afs_xdcache);
790                         ObtainWriteLock(&tvc->vlock, 543);
791                         if (!QEmpty(&tvc->multiPage)) {
792                             if (phase < 3 || osi_VM_MultiPageConflict(tvc, tdc)) {
793                                 skip = 1;
794                                 goto endmultipage;
795                             }
796                         }
797                         /* block locking pages */
798                         tvc->vstates |= VPageCleaning;
799                         /* block getting new pages */
800                         tvc->activeV++;
801                         ReleaseWriteLock(&tvc->vlock);
802                         /* One last recheck */
803                         ObtainWriteLock(&afs_xdcache, 333);
804                         chunkFlags = afs_indexFlags[tdc->index];
805                         if (tdc->refCount > 1 || (chunkFlags & IFDataMod)
806                             || (osi_Active(tvc) && (tvc->f.states & CDCLock)
807                                 && (chunkFlags & IFAnyPages))) {
808                             skip = 1;
809                             ReleaseWriteLock(&afs_xdcache);
810                             goto endputpage;
811                         }
812                         ReleaseWriteLock(&afs_xdcache);
813
814                         code = osi_VM_GetDownD(tvc, tdc);
815
816                         ObtainWriteLock(&afs_xdcache, 269);
817                         /* we actually removed all pages, clean and dirty */
818                         if (code == 0) {
819                             afs_indexFlags[tdc->index] &=
820                                 ~(IFDirtyPages | IFAnyPages);
821                         } else
822                             skip = 1;
823                         ReleaseWriteLock(&afs_xdcache);
824                       endputpage:
825                         ObtainWriteLock(&tvc->vlock, 544);
826                         if (--tvc->activeV == 0
827                             && (tvc->vstates & VRevokeWait)) {
828                             tvc->vstates &= ~VRevokeWait;
829                             afs_osi_Wakeup((char *)&tvc->vstates);
830
831                         }
832                         if (tvc->vstates & VPageCleaning) {
833                             tvc->vstates &= ~VPageCleaning;
834                             afs_osi_Wakeup((char *)&tvc->vstates);
835                         }
836                       endmultipage:
837                         ReleaseWriteLock(&tvc->vlock);
838                     } else
839 #endif /* AFS_SUN5_ENV */
840                     {
841                         ReleaseWriteLock(&afs_xdcache);
842                     }
843
844                     afs_PutVCache(tvc); /*XXX was AFS_FAST_RELE?*/
845                     ObtainWriteLock(&afs_xdcache, 528);
846                     if (afs_indexFlags[tdc->index] &
847                         (IFDataMod | IFDirtyPages | IFAnyPages))
848                         skip = 1;
849                     if (tdc->refCount > 1)
850                         skip = 1;
851                 }
852 #if     defined(AFS_SUN5_ENV)
853                 else {
854                     /* no vnode, so IFDirtyPages is spurious (we don't
855                      * sweep dcaches on vnode recycling, so we can have
856                      * DIRTYPAGES set even when all pages are gone).  Just
857                      * clear the flag.
858                      * Hold vcache lock to prevent vnode from being
859                      * created while we're clearing IFDirtyPages.
860                      */
861                     afs_indexFlags[tdc->index] &=
862                         ~(IFDirtyPages | IFAnyPages);
863                 }
864 #endif
865                 if (skip) {
866                     /* skip this guy and mark him as recently used */
867                     afs_indexFlags[tdc->index] |= IFFlag;
868                     afs_Trace4(afs_iclSetp, CM_TRACE_GETDOWND,
869                                ICL_TYPE_POINTER, tvc, ICL_TYPE_INT32, 2,
870                                ICL_TYPE_INT32, tdc->index, ICL_TYPE_OFFSET,
871                                ICL_HANDLE_OFFSET(tchunkoffset));
872                 } else {
873                     /* flush this dude from the data cache and reclaim;
874                      * first, make sure no one will care that we damage
875                      * it, by removing it from all hash tables.  Then,
876                      * melt it down for parts.  Note that any concurrent
877                      * (new possibility!) calls to GetDownD won't touch
878                      * this guy because his reference count is > 0. */
879                     afs_Trace4(afs_iclSetp, CM_TRACE_GETDOWND,
880                                ICL_TYPE_POINTER, tvc, ICL_TYPE_INT32, 3,
881                                ICL_TYPE_INT32, tdc->index, ICL_TYPE_OFFSET,
882                                ICL_HANDLE_OFFSET(tchunkoffset));
883                     AFS_STATCNT(afs_gget);
884                     afs_HashOutDCache(tdc, 1);
885                     if (tdc->f.chunkBytes != 0) {
886                         discard = 1;
887                         if (aneedSpace)
888                             *aneedSpace -=
889                                 (tdc->f.chunkBytes + afs_fsfragsize) >> 10;
890                     } else {
891                         discard = 0;
892                     }
893                     if (discard) {
894                         afs_DiscardDCache(tdc);
895                     } else {
896                         afs_FreeDCache(tdc);
897                     }
898                     anumber--;
899                     j = 1;      /* we reclaimed at least one victim */
900                 }
901             }
902             if (tdc)
903                 afs_PutDCache(tdc);
904         }                       /* end of for victims loop */
905
906         if (phase < 5) {
907             /* Phase is 0 and no one was found, so try phase 1 (ignore
908              * osi_Active flag) */
909             if (j == 0) {
910                 phase++;
911                 for (i = 0; i < afs_cacheFiles; i++)
912                     /* turn off all flags */
913                     afs_indexFlags[i] &= ~IFFlag;
914             }
915         } else {
916             /* found no one in phases 0-5, we're hosed */
917             if (victimPtr == 0)
918                 break;
919         }
920     }                           /* big while loop */
921
922     return;
923
924 }                               /*afs_GetDownD */
925
926
927 /*!
928  * Remove adc from any hash tables that would allow it to be located
929  * again by afs_FindDCache or afs_GetDCache.
930  *
931  * \param adc Pointer to dcache entry to remove from hash tables.
932  *
933  * \note Locks: Must have the afs_xdcache lock write-locked to call this function.
934  *
935  */
936 int
937 afs_HashOutDCache(struct dcache *adc, int zap)
938 {
939     int i, us;
940
941     AFS_STATCNT(afs_glink);
942     if (zap)
943         /* we know this guy's in the LRUQ.  We'll move dude into DCQ below */
944         DZap(adc);
945     /* if this guy is in the hash table, pull him out */
946     if (adc->f.fid.Fid.Volume != 0) {
947         /* remove entry from first hash chains */
948         i = DCHash(&adc->f.fid, adc->f.chunk);
949         us = afs_dchashTbl[i];
950         if (us == adc->index) {
951             /* first dude in the list */
952             afs_dchashTbl[i] = afs_dcnextTbl[adc->index];
953         } else {
954             /* somewhere on the chain */
955             while (us != NULLIDX) {
956                 if (afs_dcnextTbl[us] == adc->index) {
957                     /* found item pointing at the one to delete */
958                     afs_dcnextTbl[us] = afs_dcnextTbl[adc->index];
959                     break;
960                 }
961                 us = afs_dcnextTbl[us];
962             }
963             if (us == NULLIDX)
964                 osi_Panic("dcache hc");
965         }
966         /* remove entry from *other* hash chain */
967         i = DVHash(&adc->f.fid);
968         us = afs_dvhashTbl[i];
969         if (us == adc->index) {
970             /* first dude in the list */
971             afs_dvhashTbl[i] = afs_dvnextTbl[adc->index];
972         } else {
973             /* somewhere on the chain */
974             while (us != NULLIDX) {
975                 if (afs_dvnextTbl[us] == adc->index) {
976                     /* found item pointing at the one to delete */
977                     afs_dvnextTbl[us] = afs_dvnextTbl[adc->index];
978                     break;
979                 }
980                 us = afs_dvnextTbl[us];
981             }
982             if (us == NULLIDX)
983                 osi_Panic("dcache hv");
984         }
985     }
986
987     if (zap) {
988         /* prevent entry from being found on a reboot (it is already out of
989          * the hash table, but after a crash, we just look at fid fields of
990          * stable (old) entries).
991          */
992          adc->f.fid.Fid.Volume = 0;     /* invalid */
993
994         /* mark entry as modified */
995         adc->dflags |= DFEntryMod;
996     }
997
998     /* all done */
999     return 0;
1000 }                               /*afs_HashOutDCache */
1001
1002 /*!
1003  * Flush the given dcache entry, pulling it from hash chains
1004  * and truncating the associated cache file.
1005  *
1006  * \param adc Ptr to dcache entry to flush.
1007  *
1008  * \note Environment:
1009  *      This routine must be called with the afs_xdcache lock held
1010  *      (in write mode).
1011  */
1012 void
1013 afs_FlushDCache(struct dcache *adc)
1014 {
1015     AFS_STATCNT(afs_FlushDCache);
1016     /*
1017      * Bump the number of cache files flushed.
1018      */
1019     afs_stats_cmperf.cacheFlushes++;
1020
1021     /* remove from all hash tables */
1022     afs_HashOutDCache(adc, 1);
1023
1024     /* Free its space; special case null operation, since truncate operation
1025      * in UFS is slow even in this case, and this allows us to pre-truncate
1026      * these files at more convenient times with fewer locks set
1027      * (see afs_GetDownD).
1028      */
1029     if (adc->f.chunkBytes != 0) {
1030         afs_DiscardDCache(adc);
1031         afs_MaybeWakeupTruncateDaemon();
1032     } else {
1033         afs_FreeDCache(adc);
1034     }
1035 }                               /*afs_FlushDCache */
1036
1037
1038 /*!
1039  * Put a dcache entry on the free dcache entry list.
1040  *
1041  * \param adc dcache entry to free.
1042  *
1043  * \note Environment: called with afs_xdcache lock write-locked.
1044  */
1045 static void
1046 afs_FreeDCache(struct dcache *adc)
1047 {
1048     /* Thread on free list, update free list count and mark entry as
1049      * freed in its indexFlags element.  Also, ensure DCache entry gets
1050      * written out (set DFEntryMod).
1051      */
1052
1053     afs_dvnextTbl[adc->index] = afs_freeDCList;
1054     afs_freeDCList = adc->index;
1055     afs_freeDCCount++;
1056     afs_indexFlags[adc->index] |= IFFree;
1057     adc->dflags |= DFEntryMod;
1058
1059     afs_WakeCacheWaitersIfDrained();
1060 }                               /* afs_FreeDCache */
1061
1062 /*!
1063  * Discard the cache element by moving it to the discardDCList.
1064  * This puts the cache element into a quasi-freed state, where
1065  * the space may be reused, but the file has not been truncated.
1066  *
1067  * \note Major Assumptions Here:
1068  *      Assumes that frag size is an integral power of two, less one,
1069  *      and that this is a two's complement machine.  I don't
1070  *      know of any filesystems which violate this assumption...
1071  *
1072  * \param adr Ptr to dcache entry.
1073  *
1074  * \note Environment:
1075  *      Must be called with afs_xdcache write-locked.
1076  */
1077
1078 static void
1079 afs_DiscardDCache(struct dcache *adc)
1080 {
1081     afs_int32 size;
1082
1083     AFS_STATCNT(afs_DiscardDCache);
1084
1085     osi_Assert(adc->refCount == 1);
1086
1087     size = ((adc->f.chunkBytes + afs_fsfragsize) ^ afs_fsfragsize) >> 10;       /* round up */
1088     afs_blocksDiscarded += size;
1089     afs_stats_cmperf.cacheBlocksDiscarded = afs_blocksDiscarded;
1090
1091     afs_dvnextTbl[adc->index] = afs_discardDCList;
1092     afs_discardDCList = adc->index;
1093     afs_discardDCCount++;
1094
1095     adc->f.fid.Fid.Volume = 0;
1096     adc->dflags |= DFEntryMod;
1097     afs_indexFlags[adc->index] |= IFDiscarded;
1098
1099     afs_WakeCacheWaitersIfDrained();
1100 }                               /*afs_DiscardDCache */
1101
1102 /**
1103  * Get a dcache entry from the discard or free list
1104  *
1105  * @param[in] indexp  A pointer to the head of the dcache free list or discard
1106  *                    list (afs_freeDCList, or afs_discardDCList)
1107  *
1108  * @return A dcache from that list, or NULL if none could be retrieved.
1109  *
1110  * @pre afs_xdcache is write-locked
1111  */
1112 static struct dcache *
1113 afs_GetDSlotFromList(afs_int32 *indexp)
1114 {
1115     struct dcache *tdc;
1116
1117     for ( ; *indexp != NULLIDX; indexp = &afs_dvnextTbl[*indexp]) {
1118         tdc = afs_GetUnusedDSlot(*indexp);
1119         if (tdc) {
1120             osi_Assert(tdc->refCount == 1);
1121             ReleaseReadLock(&tdc->tlock);
1122             *indexp = afs_dvnextTbl[tdc->index];
1123             afs_dvnextTbl[tdc->index] = NULLIDX;
1124             return tdc;
1125         }
1126     }
1127     return NULL;
1128 }
1129
1130 /*!
1131  * Free the next element on the list of discarded cache elements.
1132  *
1133  * Returns -1 if we encountered an error preventing us from freeing a
1134  * discarded dcache, or 0 on success.
1135  */
1136 static int
1137 afs_FreeDiscardedDCache(void)
1138 {
1139     struct dcache *tdc;
1140     struct osi_file *tfile;
1141     afs_int32 size;
1142
1143     AFS_STATCNT(afs_FreeDiscardedDCache);
1144
1145     ObtainWriteLock(&afs_xdcache, 510);
1146     if (!afs_blocksDiscarded) {
1147         ReleaseWriteLock(&afs_xdcache);
1148         return 0;
1149     }
1150
1151     /*
1152      * Get an entry from the list of discarded cache elements
1153      */
1154     tdc = afs_GetDSlotFromList(&afs_discardDCList);
1155     if (!tdc) {
1156         ReleaseWriteLock(&afs_xdcache);
1157         return -1;
1158     }
1159
1160     afs_discardDCCount--;
1161     size = ((tdc->f.chunkBytes + afs_fsfragsize) ^ afs_fsfragsize) >> 10;       /* round up */
1162     afs_blocksDiscarded -= size;
1163     afs_stats_cmperf.cacheBlocksDiscarded = afs_blocksDiscarded;
1164     /* We can lock because we just took it off the free list */
1165     ObtainWriteLock(&tdc->lock, 626);
1166     ReleaseWriteLock(&afs_xdcache);
1167
1168     /*
1169      * Truncate the element to reclaim its space
1170      */
1171     tfile = afs_CFileOpen(&tdc->f.inode);
1172     afs_CFileTruncate(tfile, 0);
1173     afs_CFileClose(tfile);
1174     afs_AdjustSize(tdc, 0);
1175     afs_DCMoveBucket(tdc, 0, 0);
1176
1177     /*
1178      * Free the element we just truncated
1179      */
1180     ObtainWriteLock(&afs_xdcache, 511);
1181     afs_indexFlags[tdc->index] &= ~IFDiscarded;
1182     afs_FreeDCache(tdc);
1183     tdc->f.states &= ~(DRO|DBackup|DRW);
1184     ReleaseWriteLock(&tdc->lock);
1185     afs_PutDCache(tdc);
1186     ReleaseWriteLock(&afs_xdcache);
1187
1188     return 0;
1189 }
1190
1191 /*!
1192  * Free as many entries from the list of discarded cache elements
1193  * as we need to get the free space down below CM_WAITFORDRAINPCT (98%).
1194  *
1195  * \return 0
1196  */
1197 int
1198 afs_MaybeFreeDiscardedDCache(void)
1199 {
1200
1201     AFS_STATCNT(afs_MaybeFreeDiscardedDCache);
1202
1203     while (afs_blocksDiscarded
1204            && (afs_blocksUsed >
1205                PERCENT(CM_WAITFORDRAINPCT, afs_cacheBlocks))) {
1206         int code = afs_FreeDiscardedDCache();
1207         if (code) {
1208             /* Callers depend on us to get the afs_blocksDiscarded count down.
1209              * If we cannot do that, the callers can spin by calling us over
1210              * and over. Panic for now until we can figure out something
1211              * better. */
1212             osi_Panic("Error freeing discarded dcache");
1213         }
1214     }
1215     return 0;
1216 }
1217
1218 /*!
1219  * Try to free up a certain number of disk slots.
1220  *
1221  * \param anumber Targeted number of disk slots to free up.
1222  *
1223  * \note Environment:
1224  *      Must be called with afs_xdcache write-locked.
1225  *
1226  */
1227 static void
1228 afs_GetDownDSlot(int anumber)
1229 {
1230     struct afs_q *tq, *nq;
1231     struct dcache *tdc;
1232     int ix;
1233     unsigned int cnt;
1234
1235     AFS_STATCNT(afs_GetDownDSlot);
1236     if (cacheDiskType == AFS_FCACHE_TYPE_MEM)
1237         osi_Panic("diskless getdowndslot");
1238
1239     if (CheckLock(&afs_xdcache) != -1)
1240         osi_Panic("getdowndslot nolock");
1241
1242     /* decrement anumber first for all dudes in free list */
1243     for (tdc = afs_freeDSList; tdc; tdc = (struct dcache *)tdc->lruq.next)
1244         anumber--;
1245     if (anumber <= 0)
1246         return;                 /* enough already free */
1247
1248     for (cnt = 0, tq = afs_DLRU.prev; tq != &afs_DLRU && anumber > 0;
1249          tq = nq, cnt++) {
1250         tdc = (struct dcache *)tq;      /* q is first elt in dcache entry */
1251         nq = QPrev(tq);         /* in case we remove it */
1252         if (tdc->refCount == 0) {
1253             if ((ix = tdc->index) == NULLIDX)
1254                 osi_Panic("getdowndslot");
1255             /* pull the entry out of the lruq and put it on the free list */
1256             QRemove(&tdc->lruq);
1257
1258             /* write-through if modified */
1259             if (tdc->dflags & DFEntryMod) {
1260 #if defined(AFS_SGI_ENV) && defined(AFS_SGI_SHORTSTACK)
1261                 /*
1262                  * ask proxy to do this for us - we don't have the stack space
1263                  */
1264                 while (tdc->dflags & DFEntryMod) {
1265                     int s;
1266                     AFS_GUNLOCK();
1267                     s = SPLOCK(afs_sgibklock);
1268                     if (afs_sgibklist == NULL) {
1269                         /* if slot is free, grab it. */
1270                         afs_sgibklist = tdc;
1271                         SV_SIGNAL(&afs_sgibksync);
1272                     }
1273                     /* wait for daemon to (start, then) finish. */
1274                     SP_WAIT(afs_sgibklock, s, &afs_sgibkwait, PINOD);
1275                     AFS_GLOCK();
1276                 }
1277 #else
1278                 tdc->dflags &= ~DFEntryMod;
1279                 osi_Assert(afs_WriteDCache(tdc, 1) == 0);
1280 #endif
1281             }
1282
1283             /* finally put the entry in the free list */
1284             afs_indexTable[ix] = NULL;
1285             afs_indexFlags[ix] &= ~IFEverUsed;
1286             tdc->index = NULLIDX;
1287             tdc->lruq.next = (struct afs_q *)afs_freeDSList;
1288             afs_freeDSList = tdc;
1289             anumber--;
1290         }
1291     }
1292 }                               /*afs_GetDownDSlot */
1293
1294
1295 /*
1296  * afs_RefDCache
1297  *
1298  * Description:
1299  *      Increment the reference count on a disk cache entry,
1300  *      which already has a non-zero refcount.  In order to
1301  *      increment the refcount of a zero-reference entry, you
1302  *      have to hold afs_xdcache.
1303  *
1304  * Parameters:
1305  *      adc : Pointer to the dcache entry to increment.
1306  *
1307  * Environment:
1308  *      Nothing interesting.
1309  */
1310 int
1311 afs_RefDCache(struct dcache *adc)
1312 {
1313     ObtainWriteLock(&adc->tlock, 627);
1314     if (adc->refCount < 0)
1315         osi_Panic("RefDCache: negative refcount");
1316     adc->refCount++;
1317     ReleaseWriteLock(&adc->tlock);
1318     return 0;
1319 }
1320
1321
1322 /*
1323  * afs_PutDCache
1324  *
1325  * Description:
1326  *      Decrement the reference count on a disk cache entry.
1327  *
1328  * Parameters:
1329  *      ad : Ptr to the dcache entry to decrement.
1330  *
1331  * Environment:
1332  *      Nothing interesting.
1333  */
1334 int
1335 afs_PutDCache(struct dcache *adc)
1336 {
1337     AFS_STATCNT(afs_PutDCache);
1338     ObtainWriteLock(&adc->tlock, 276);
1339     if (adc->refCount <= 0)
1340         osi_Panic("putdcache");
1341     --adc->refCount;
1342     ReleaseWriteLock(&adc->tlock);
1343     return 0;
1344 }
1345
1346
1347 /*
1348  * afs_TryToSmush
1349  *
1350  * Description:
1351  *      Try to discard all data associated with this file from the
1352  *      cache.
1353  *
1354  * Parameters:
1355  *      avc : Pointer to the cache info for the file.
1356  *
1357  * Environment:
1358  *      Both pvnLock and lock are write held.
1359  */
1360 void
1361 afs_TryToSmush(struct vcache *avc, afs_ucred_t *acred, int sync)
1362 {
1363     struct dcache *tdc;
1364     int index;
1365     int i;
1366     AFS_STATCNT(afs_TryToSmush);
1367     afs_Trace2(afs_iclSetp, CM_TRACE_TRYTOSMUSH, ICL_TYPE_POINTER, avc,
1368                ICL_TYPE_OFFSET, ICL_HANDLE_OFFSET(avc->f.m.Length));
1369     sync = 1;                   /* XX Temp testing XX */
1370
1371 #if     defined(AFS_SUN5_ENV)
1372     ObtainWriteLock(&avc->vlock, 573);
1373     avc->activeV++;             /* block new getpages */
1374     ReleaseWriteLock(&avc->vlock);
1375 #endif
1376
1377     /* Flush VM pages */
1378     osi_VM_TryToSmush(avc, acred, sync);
1379
1380     /*
1381      * Get the hash chain containing all dce's for this fid
1382      */
1383     i = DVHash(&avc->f.fid);
1384     ObtainWriteLock(&afs_xdcache, 277);
1385     for (index = afs_dvhashTbl[i]; index != NULLIDX; index = i) {
1386         i = afs_dvnextTbl[index];       /* next pointer this hash table */
1387         if (afs_indexUnique[index] == avc->f.fid.Fid.Unique) {
1388             int releaseTlock = 1;
1389             tdc = afs_GetValidDSlot(index);
1390             if (!tdc) {
1391                 /* afs_TryToSmush is best-effort; we may not actually discard
1392                  * everything, so failure to discard a dcache due to an i/o
1393                  * error is okay. */
1394                 continue;
1395             }
1396             if (!FidCmp(&tdc->f.fid, &avc->f.fid)) {
1397                 if (sync) {
1398                     if ((afs_indexFlags[index] & IFDataMod) == 0
1399                         && tdc->refCount == 1) {
1400                         ReleaseReadLock(&tdc->tlock);
1401                         releaseTlock = 0;
1402                         afs_FlushDCache(tdc);
1403                     }
1404                 } else
1405                     afs_indexTable[index] = 0;
1406             }
1407             if (releaseTlock)
1408                 ReleaseReadLock(&tdc->tlock);
1409             afs_PutDCache(tdc);
1410         }
1411     }
1412 #if     defined(AFS_SUN5_ENV)
1413     ObtainWriteLock(&avc->vlock, 545);
1414     if (--avc->activeV == 0 && (avc->vstates & VRevokeWait)) {
1415         avc->vstates &= ~VRevokeWait;
1416         afs_osi_Wakeup((char *)&avc->vstates);
1417     }
1418     ReleaseWriteLock(&avc->vlock);
1419 #endif
1420     ReleaseWriteLock(&afs_xdcache);
1421     /*
1422      * It's treated like a callback so that when we do lookups we'll
1423      * invalidate the unique bit if any
1424      * trytoSmush occured during the lookup call
1425      */
1426     afs_allCBs++;
1427 }
1428
1429 /*
1430  * afs_DCacheMissingChunks
1431  *
1432  * Description
1433  *      Given the cached info for a file, return the number of chunks that
1434  *      are not available from the dcache.
1435  *
1436  * Parameters:
1437  *      avc:    Pointer to the (held) vcache entry to look in.
1438  *
1439  * Returns:
1440  *      The number of chunks which are not currently cached.
1441  *
1442  * Environment:
1443  *      The vcache entry is held upon entry.
1444  */
1445
1446 int
1447 afs_DCacheMissingChunks(struct vcache *avc)
1448 {
1449     int i, index;
1450     afs_size_t totalLength = 0;
1451     afs_uint32 totalChunks = 0;
1452     struct dcache *tdc;
1453
1454     totalLength = avc->f.m.Length;
1455     if (avc->f.truncPos < totalLength)
1456         totalLength = avc->f.truncPos;
1457
1458     /* Length is 0, no chunk missing. */
1459     if (totalLength == 0)
1460         return 0;
1461
1462     /* If totalLength is a multiple of chunksize, the last byte appears
1463      * as being part of the next chunk, which does not exist.
1464      * Decrementing totalLength by one fixes that.
1465      */
1466     totalLength--;
1467     totalChunks = (AFS_CHUNK(totalLength) + 1);
1468
1469     /* If we're a directory, we only ever have one chunk, regardless of
1470      * the size of the dir.
1471      */
1472     if (avc->f.fid.Fid.Vnode & 1 || vType(avc) == VDIR)
1473         totalChunks = 1;
1474
1475     /*
1476      printf("Should have %d chunks for %u bytes\n",
1477                 totalChunks, (totalLength + 1));
1478     */
1479     i = DVHash(&avc->f.fid);
1480     ObtainWriteLock(&afs_xdcache, 1001);
1481     for (index = afs_dvhashTbl[i]; index != NULLIDX; index = i) {
1482         i = afs_dvnextTbl[index];
1483         if (afs_indexUnique[index] == avc->f.fid.Fid.Unique) {
1484             tdc = afs_GetValidDSlot(index);
1485             if (tdc) {
1486                 if (!FidCmp(&tdc->f.fid, &avc->f.fid)) {
1487                     totalChunks--;
1488                 }
1489                 ReleaseReadLock(&tdc->tlock);
1490                 afs_PutDCache(tdc);
1491             }
1492         }
1493     }
1494     ReleaseWriteLock(&afs_xdcache);
1495
1496     /*printf("Missing %d chunks\n", totalChunks);*/
1497
1498     return (totalChunks);
1499 }
1500
1501 /*
1502  * afs_FindDCache
1503  *
1504  * Description:
1505  *      Given the cached info for a file and a byte offset into the
1506  *      file, make sure the dcache entry for that file and containing
1507  *      the given byte is available, returning it to our caller.
1508  *
1509  * Parameters:
1510  *      avc   : Pointer to the (held) vcache entry to look in.
1511  *      abyte : Which byte we want to get to.
1512  *
1513  * Returns:
1514  *      Pointer to the dcache entry covering the file & desired byte,
1515  *      or NULL if not found.
1516  *
1517  * Environment:
1518  *      The vcache entry is held upon entry.
1519  */
1520
1521 struct dcache *
1522 afs_FindDCache(struct vcache *avc, afs_size_t abyte)
1523 {
1524     afs_int32 chunk;
1525     afs_int32 i, index;
1526     struct dcache *tdc = NULL;
1527
1528     AFS_STATCNT(afs_FindDCache);
1529     chunk = AFS_CHUNK(abyte);
1530
1531     /*
1532      * Hash on the [fid, chunk] and get the corresponding dcache index
1533      * after write-locking the dcache.
1534      */
1535     i = DCHash(&avc->f.fid, chunk);
1536     ObtainWriteLock(&afs_xdcache, 278);
1537     for (index = afs_dchashTbl[i]; index != NULLIDX; index = afs_dcnextTbl[index]) {
1538         if (afs_indexUnique[index] == avc->f.fid.Fid.Unique) {
1539             tdc = afs_GetValidDSlot(index);
1540             if (!tdc) {
1541                 /* afs_FindDCache is best-effort; we may not find the given
1542                  * file/offset, so if we cannot find the given dcache due to
1543                  * i/o errors, that is okay. */
1544                 continue;
1545             }
1546             ReleaseReadLock(&tdc->tlock);
1547             if (!FidCmp(&tdc->f.fid, &avc->f.fid) && chunk == tdc->f.chunk) {
1548                 break;          /* leaving refCount high for caller */
1549             }
1550             afs_PutDCache(tdc);
1551         }
1552     }
1553     if (index != NULLIDX) {
1554         hset(afs_indexTimes[tdc->index], afs_indexCounter);
1555         hadd32(afs_indexCounter, 1);
1556         ReleaseWriteLock(&afs_xdcache);
1557         return tdc;
1558     }
1559     ReleaseWriteLock(&afs_xdcache);
1560     return NULL;
1561 }                               /*afs_FindDCache */
1562
1563 /* only call these from afs_AllocDCache() */
1564 static struct dcache *
1565 afs_AllocFreeDSlot(void)
1566 {
1567     struct dcache *tdc;
1568
1569     tdc = afs_GetDSlotFromList(&afs_freeDCList);
1570     if (!tdc) {
1571         return NULL;
1572     }
1573     afs_indexFlags[tdc->index] &= ~IFFree;
1574     ObtainWriteLock(&tdc->lock, 604);
1575     afs_freeDCCount--;
1576
1577     return tdc;
1578 }
1579 static struct dcache *
1580 afs_AllocDiscardDSlot(afs_int32 lock)
1581 {
1582     struct dcache *tdc;
1583     afs_uint32 size = 0;
1584     struct osi_file *file;
1585
1586     tdc = afs_GetDSlotFromList(&afs_discardDCList);
1587     if (!tdc) {
1588         return NULL;
1589     }
1590     afs_indexFlags[tdc->index] &= ~IFDiscarded;
1591     ObtainWriteLock(&tdc->lock, 605);
1592     afs_discardDCCount--;
1593     size =
1594         ((tdc->f.chunkBytes +
1595           afs_fsfragsize) ^ afs_fsfragsize) >> 10;
1596     tdc->f.states &= ~(DRO|DBackup|DRW);
1597     afs_DCMoveBucket(tdc, size, 0);
1598     afs_blocksDiscarded -= size;
1599     afs_stats_cmperf.cacheBlocksDiscarded = afs_blocksDiscarded;
1600     if ((lock & 2)) {
1601         /* Truncate the chunk so zeroes get filled properly */
1602         file = afs_CFileOpen(&tdc->f.inode);
1603         afs_CFileTruncate(file, 0);
1604         afs_CFileClose(file);
1605         afs_AdjustSize(tdc, 0);
1606     }
1607
1608     return tdc;
1609 }
1610
1611 /*!
1612  * Get a fresh dcache from the free or discarded list.
1613  *
1614  * \param avc Who's dcache is this going to be?
1615  * \param chunk The position where it will be placed in.
1616  * \param lock How are locks held.
1617  * \param ashFid If this dcache going to be used for a shadow dir,
1618  *              this is it's fid.
1619  *
1620  * \note Required locks:
1621  *      - afs_xdcache (W)
1622  *      - avc (R if (lock & 1) set and W otherwise)
1623  * \note It write locks the new dcache. The caller must unlock it.
1624  *
1625  * \return The new dcache.
1626  */
1627 struct dcache *
1628 afs_AllocDCache(struct vcache *avc, afs_int32 chunk, afs_int32 lock,
1629                 struct VenusFid *ashFid)
1630 {
1631     struct dcache *tdc = NULL;
1632
1633     /* if (lock & 2), prefer 'free' dcaches; otherwise, prefer 'discard'
1634      * dcaches. In either case, try both if our first choice doesn't work. */
1635     if ((lock & 2)) {
1636         tdc = afs_AllocFreeDSlot();
1637         if (!tdc) {
1638             tdc = afs_AllocDiscardDSlot(lock);
1639         }
1640     } else {
1641         tdc = afs_AllocDiscardDSlot(lock);
1642         if (!tdc) {
1643             tdc = afs_AllocFreeDSlot();
1644         }
1645     }
1646     if (!tdc) {
1647         return NULL;
1648     }
1649
1650     /*
1651      * Locks held:
1652      * avc->lock(R) if setLocks
1653      * avc->lock(W) if !setLocks
1654      * tdc->lock(W)
1655      * afs_xdcache(W)
1656      */
1657
1658     /*
1659      * Fill in the newly-allocated dcache record.
1660      */
1661     afs_indexFlags[tdc->index] &= ~(IFDirtyPages | IFAnyPages);
1662     if (ashFid)
1663         /* Use shadow fid if provided. */
1664         tdc->f.fid = *ashFid;
1665     else
1666         /* Use normal vcache's fid otherwise. */
1667         tdc->f.fid = avc->f.fid;
1668     if (avc->f.states & CRO)
1669         tdc->f.states = DRO;
1670     else if (avc->f.states & CBackup)
1671         tdc->f.states = DBackup;
1672     else
1673         tdc->f.states = DRW;
1674     afs_DCMoveBucket(tdc, 0, afs_DCGetBucket(avc));
1675     afs_indexUnique[tdc->index] = tdc->f.fid.Fid.Unique;
1676     if (!ashFid)
1677         hones(tdc->f.versionNo);        /* invalid value */
1678     tdc->f.chunk = chunk;
1679     tdc->validPos = AFS_CHUNKTOBASE(chunk);
1680     /* XXX */
1681     if (tdc->lruq.prev == &tdc->lruq)
1682         osi_Panic("lruq 1");
1683
1684     return tdc;
1685 }
1686
1687 /*
1688  * afs_GetDCache
1689  *
1690  * Description:
1691  *      This function is called to obtain a reference to data stored in
1692  *      the disk cache, locating a chunk of data containing the desired
1693  *      byte and returning a reference to the disk cache entry, with its
1694  *      reference count incremented.
1695  *
1696  * Parameters:
1697  * IN:
1698  *      avc     : Ptr to a vcache entry (unlocked)
1699  *      abyte   : Byte position in the file desired
1700  *      areq    : Request structure identifying the requesting user.
1701  *      aflags  : Settings as follows:
1702  *                      1 : Set locks
1703  *                      2 : Return after creating entry.
1704  *                      4 : called from afs_vnop_write.c
1705  *                          *alen contains length of data to be written.
1706  * OUT:
1707  *      aoffset : Set to the offset within the chunk where the resident
1708  *                byte is located.
1709  *      alen    : Set to the number of bytes of data after the desired
1710  *                byte (including the byte itself) which can be read
1711  *                from this chunk.
1712  *
1713  * Environment:
1714  *      The vcache entry pointed to by avc is unlocked upon entry.
1715  */
1716
1717 /*
1718  * Update the vnode-to-dcache hint if we can get the vnode lock
1719  * right away.  Assumes dcache entry is at least read-locked.
1720  */
1721 void
1722 updateV2DC(int lockVc, struct vcache *v, struct dcache *d, int src)
1723 {
1724     if (!lockVc || 0 == NBObtainWriteLock(&v->lock, src)) {
1725         if (hsame(v->f.m.DataVersion, d->f.versionNo) && v->callback)
1726             v->dchint = d;
1727         if (lockVc)
1728             ReleaseWriteLock(&v->lock);
1729     }
1730 }
1731
1732 /* avc - Write-locked unless aflags & 1 */
1733 struct dcache *
1734 afs_GetDCache(struct vcache *avc, afs_size_t abyte,
1735               struct vrequest *areq, afs_size_t * aoffset,
1736               afs_size_t * alen, int aflags)
1737 {
1738     afs_int32 i, code, shortcut;
1739 #if     defined(AFS_AIX32_ENV) || defined(AFS_SGI_ENV)
1740     afs_int32 adjustsize = 0;
1741 #endif
1742     int setLocks;
1743     afs_int32 index;
1744     afs_int32 us;
1745     afs_int32 chunk;
1746     afs_size_t Position = 0;
1747     afs_int32 size, tlen;       /* size of segment to transfer */
1748     struct afs_FetchOutput *tsmall = 0;
1749     struct dcache *tdc;
1750     struct osi_file *file;
1751     struct afs_conn *tc;
1752     int downDCount = 0;
1753     struct server *newCallback = NULL;
1754     char setNewCallback;
1755     char setVcacheStatus;
1756     char doVcacheUpdate;
1757     char slowPass = 0;
1758     int doAdjustSize = 0;
1759     int doReallyAdjustSize = 0;
1760     int overWriteWholeChunk = 0;
1761     struct rx_connection *rxconn;
1762
1763 #ifndef AFS_NOSTATS
1764     struct afs_stats_AccessInfo *accP;  /*Ptr to access record in stats */
1765     int fromReplica;            /*Are we reading from a replica? */
1766     int numFetchLoops;          /*# times around the fetch/analyze loop */
1767 #endif /* AFS_NOSTATS */
1768
1769     AFS_STATCNT(afs_GetDCache);
1770     if (dcacheDisabled)
1771         return NULL;
1772
1773     setLocks = aflags & 1;
1774
1775     /*
1776      * Determine the chunk number and offset within the chunk corresponding
1777      * to the desired byte.
1778      */
1779     if (avc->f.fid.Fid.Vnode & 1) {     /* if (vType(avc) == VDIR) */
1780         chunk = 0;
1781     } else {
1782         chunk = AFS_CHUNK(abyte);
1783     }
1784
1785     /* come back to here if we waited for the cache to drain. */
1786   RetryGetDCache:
1787
1788     setNewCallback = setVcacheStatus = 0;
1789
1790     if (setLocks) {
1791         if (slowPass)
1792             ObtainWriteLock(&avc->lock, 616);
1793         else
1794             ObtainReadLock(&avc->lock);
1795     }
1796
1797     /*
1798      * Locks held:
1799      * avc->lock(R) if setLocks && !slowPass
1800      * avc->lock(W) if !setLocks || slowPass
1801      */
1802
1803     shortcut = 0;
1804
1805     /* check hints first! (might could use bcmp or some such...) */
1806     if ((tdc = avc->dchint)) {
1807         int dcLocked;
1808
1809         /*
1810          * The locking order between afs_xdcache and dcache lock matters.
1811          * The hint dcache entry could be anywhere, even on the free list.
1812          * Locking afs_xdcache ensures that noone is trying to pull dcache
1813          * entries from the free list, and thereby assuming them to be not
1814          * referenced and not locked.
1815          */
1816         ObtainReadLock(&afs_xdcache);
1817         dcLocked = (0 == NBObtainSharedLock(&tdc->lock, 601));
1818
1819         if (dcLocked && (tdc->index != NULLIDX)
1820             && !FidCmp(&tdc->f.fid, &avc->f.fid) && chunk == tdc->f.chunk
1821             && !(afs_indexFlags[tdc->index] & (IFFree | IFDiscarded))) {
1822             /* got the right one.  It might not be the right version, and it
1823              * might be fetching, but it's the right dcache entry.
1824              */
1825             /* All this code should be integrated better with what follows:
1826              * I can save a good bit more time under a write lock if I do..
1827              */
1828             ObtainWriteLock(&tdc->tlock, 603);
1829             tdc->refCount++;
1830             ReleaseWriteLock(&tdc->tlock);
1831
1832             ReleaseReadLock(&afs_xdcache);
1833             shortcut = 1;
1834
1835             if (hsame(tdc->f.versionNo, avc->f.m.DataVersion)
1836                 && !(tdc->dflags & DFFetching)) {
1837
1838                 afs_stats_cmperf.dcacheHits++;
1839                 ObtainWriteLock(&afs_xdcache, 559);
1840                 QRemove(&tdc->lruq);
1841                 QAdd(&afs_DLRU, &tdc->lruq);
1842                 ReleaseWriteLock(&afs_xdcache);
1843
1844                 /* Locks held:
1845                  * avc->lock(R) if setLocks && !slowPass
1846                  * avc->lock(W) if !setLocks || slowPass
1847                  * tdc->lock(S)
1848                  */
1849                 goto done;
1850             }
1851         } else {
1852             if (dcLocked)
1853                 ReleaseSharedLock(&tdc->lock);
1854             ReleaseReadLock(&afs_xdcache);
1855         }
1856
1857         if (!shortcut)
1858             tdc = 0;
1859     }
1860
1861     /* Locks held:
1862      * avc->lock(R) if setLocks && !slowPass
1863      * avc->lock(W) if !setLocks || slowPass
1864      * tdc->lock(S) if tdc
1865      */
1866
1867     if (!tdc) {                 /* If the hint wasn't the right dcache entry */
1868         int dslot_error = 0;
1869         /*
1870          * Hash on the [fid, chunk] and get the corresponding dcache index
1871          * after write-locking the dcache.
1872          */
1873       RetryLookup:
1874
1875         /* Locks held:
1876          * avc->lock(R) if setLocks && !slowPass
1877          * avc->lock(W) if !setLocks || slowPass
1878          */
1879
1880         i = DCHash(&avc->f.fid, chunk);
1881         /* check to make sure our space is fine */
1882         afs_MaybeWakeupTruncateDaemon();
1883
1884         ObtainWriteLock(&afs_xdcache, 280);
1885         us = NULLIDX;
1886         for (index = afs_dchashTbl[i]; index != NULLIDX; us = index, index = afs_dcnextTbl[index]) {
1887             if (afs_indexUnique[index] == avc->f.fid.Fid.Unique) {
1888                 tdc = afs_GetValidDSlot(index);
1889                 if (!tdc) {
1890                     /* we got an i/o error when trying to get the given dslot,
1891                      * but do not bail out just yet; it is possible the dcache
1892                      * we're looking for is elsewhere, so it doesn't matter if
1893                      * we can't load this one. */
1894                     dslot_error = 1;
1895                     continue;
1896                 }
1897                 ReleaseReadLock(&tdc->tlock);
1898                 /*
1899                  * Locks held:
1900                  * avc->lock(R) if setLocks && !slowPass
1901                  * avc->lock(W) if !setLocks || slowPass
1902                  * afs_xdcache(W)
1903                  */
1904                 if (!FidCmp(&tdc->f.fid, &avc->f.fid) && chunk == tdc->f.chunk) {
1905                     /* Move it up in the beginning of the list */
1906                     if (afs_dchashTbl[i] != index) {
1907                         afs_dcnextTbl[us] = afs_dcnextTbl[index];
1908                         afs_dcnextTbl[index] = afs_dchashTbl[i];
1909                         afs_dchashTbl[i] = index;
1910                     }
1911                     ReleaseWriteLock(&afs_xdcache);
1912                     ObtainSharedLock(&tdc->lock, 606);
1913                     break;      /* leaving refCount high for caller */
1914                 }
1915                 afs_PutDCache(tdc);
1916                 tdc = 0;
1917             }
1918         }
1919
1920         /*
1921          * If we didn't find the entry, we'll create one.
1922          */
1923         if (index == NULLIDX) {
1924             /*
1925              * Locks held:
1926              * avc->lock(R) if setLocks
1927              * avc->lock(W) if !setLocks
1928              * afs_xdcache(W)
1929              */
1930             afs_Trace2(afs_iclSetp, CM_TRACE_GETDCACHE1, ICL_TYPE_POINTER,
1931                        avc, ICL_TYPE_INT32, chunk);
1932
1933             if (dslot_error) {
1934                 /* We couldn't find the dcache we want, but we hit some i/o
1935                  * errors when trying to find it, so we're not sure if the
1936                  * dcache we want is in the cache or not. Error out, so we
1937                  * don't try to possibly create 2 separate dcaches for the
1938                  * same exact data. */
1939                 ReleaseWriteLock(&afs_xdcache);
1940                 goto done;
1941             }
1942
1943             if (afs_discardDCList == NULLIDX && afs_freeDCList == NULLIDX) {
1944                 if (!setLocks)
1945                     avc->f.states |= CDCLock;
1946                 /* just need slots */
1947                 afs_GetDownD(5, (int *)0, afs_DCGetBucket(avc));
1948                 if (!setLocks)
1949                     avc->f.states &= ~CDCLock;
1950             }
1951             tdc = afs_AllocDCache(avc, chunk, aflags, NULL);
1952             if (!tdc) {
1953                 /* If we can't get space for 5 mins we give up and panic */
1954                 if (++downDCount > 300)
1955                     osi_Panic("getdcache");
1956                 ReleaseWriteLock(&afs_xdcache);
1957                 /*
1958                  * Locks held:
1959                  * avc->lock(R) if setLocks
1960                  * avc->lock(W) if !setLocks
1961                  */
1962                 afs_osi_Wait(1000, 0, 0);
1963                 goto RetryLookup;
1964             }
1965
1966             /*
1967              * Locks held:
1968              * avc->lock(R) if setLocks
1969              * avc->lock(W) if !setLocks
1970              * tdc->lock(W)
1971              * afs_xdcache(W)
1972              */
1973
1974             /*
1975              * Now add to the two hash chains - note that i is still set
1976              * from the above DCHash call.
1977              */
1978             afs_dcnextTbl[tdc->index] = afs_dchashTbl[i];
1979             afs_dchashTbl[i] = tdc->index;
1980             i = DVHash(&avc->f.fid);
1981             afs_dvnextTbl[tdc->index] = afs_dvhashTbl[i];
1982             afs_dvhashTbl[i] = tdc->index;
1983             tdc->dflags = DFEntryMod;
1984             tdc->mflags = 0;
1985             afs_MaybeWakeupTruncateDaemon();
1986             ReleaseWriteLock(&afs_xdcache);
1987             ConvertWToSLock(&tdc->lock);
1988         }
1989     }
1990
1991
1992     /* vcache->dcache hint failed */
1993     /*
1994      * Locks held:
1995      * avc->lock(R) if setLocks && !slowPass
1996      * avc->lock(W) if !setLocks || slowPass
1997      * tdc->lock(S)
1998      */
1999     afs_Trace4(afs_iclSetp, CM_TRACE_GETDCACHE2, ICL_TYPE_POINTER, avc,
2000                ICL_TYPE_POINTER, tdc, ICL_TYPE_INT32,
2001                hgetlo(tdc->f.versionNo), ICL_TYPE_INT32,
2002                hgetlo(avc->f.m.DataVersion));
2003     /*
2004      * Here we have the entry in tdc, with its refCount incremented.
2005      * Note: we don't use the S-lock on avc; it costs concurrency when
2006      * storing a file back to the server.
2007      */
2008
2009     /*
2010      * Not a newly created file so we need to check the file's length and
2011      * compare data versions since someone could have changed the data or we're
2012      * reading a file written elsewhere. We only want to bypass doing no-op
2013      * read rpcs on newly created files (dv of 0) since only then we guarantee
2014      * that this chunk's data hasn't been filled by another client.
2015      */
2016     size = AFS_CHUNKSIZE(abyte);
2017     if (aflags & 4)             /* called from write */
2018         tlen = *alen;
2019     else                        /* called from read */
2020         tlen = tdc->validPos - abyte;
2021     Position = AFS_CHUNKTOBASE(chunk);
2022     afs_Trace4(afs_iclSetp, CM_TRACE_GETDCACHE3, ICL_TYPE_INT32, tlen,
2023                ICL_TYPE_INT32, aflags, ICL_TYPE_OFFSET,
2024                ICL_HANDLE_OFFSET(abyte), ICL_TYPE_OFFSET,
2025                ICL_HANDLE_OFFSET(Position));
2026     if ((aflags & 4) && (hiszero(avc->f.m.DataVersion)))
2027         doAdjustSize = 1;
2028     if ((AFS_CHUNKTOBASE(chunk) >= avc->f.m.Length) ||
2029          ((aflags & 4) && (abyte == Position) && (tlen >= size)))
2030         overWriteWholeChunk = 1;
2031     if (doAdjustSize || overWriteWholeChunk) {
2032 #if     defined(AFS_AIX32_ENV) || defined(AFS_SGI_ENV)
2033 #ifdef  AFS_SGI_ENV
2034 #ifdef AFS_SGI64_ENV
2035         if (doAdjustSize)
2036             adjustsize = NBPP;
2037 #else /* AFS_SGI64_ENV */
2038         if (doAdjustSize)
2039             adjustsize = 8192;
2040 #endif /* AFS_SGI64_ENV */
2041 #else /* AFS_SGI_ENV */
2042         if (doAdjustSize)
2043             adjustsize = 4096;
2044 #endif /* AFS_SGI_ENV */
2045         if (AFS_CHUNKTOBASE(chunk) + adjustsize >= avc->f.m.Length &&
2046 #else /* defined(AFS_AIX32_ENV) || defined(AFS_SGI_ENV) */
2047 #if     defined(AFS_SUN5_ENV)
2048         if ((doAdjustSize || (AFS_CHUNKTOBASE(chunk) >= avc->f.m.Length)) &&
2049 #else
2050         if (AFS_CHUNKTOBASE(chunk) >= avc->f.m.Length &&
2051 #endif
2052 #endif /* defined(AFS_AIX32_ENV) || defined(AFS_SGI_ENV) */
2053             !hsame(avc->f.m.DataVersion, tdc->f.versionNo))
2054             doReallyAdjustSize = 1;
2055
2056         if (doReallyAdjustSize || overWriteWholeChunk) {
2057             /* no data in file to read at this position */
2058             UpgradeSToWLock(&tdc->lock, 607);
2059             file = afs_CFileOpen(&tdc->f.inode);
2060             afs_CFileTruncate(file, 0);
2061             afs_CFileClose(file);
2062             afs_AdjustSize(tdc, 0);
2063             hset(tdc->f.versionNo, avc->f.m.DataVersion);
2064             tdc->dflags |= DFEntryMod;
2065
2066             ConvertWToSLock(&tdc->lock);
2067         }
2068     }
2069
2070     /*
2071      * We must read in the whole chunk if the version number doesn't
2072      * match.
2073      */
2074     if (aflags & 2) {
2075         /* don't need data, just a unique dcache entry */
2076         ObtainWriteLock(&afs_xdcache, 608);
2077         hset(afs_indexTimes[tdc->index], afs_indexCounter);
2078         hadd32(afs_indexCounter, 1);
2079         ReleaseWriteLock(&afs_xdcache);
2080
2081         updateV2DC(setLocks, avc, tdc, 553);
2082         if (vType(avc) == VDIR)
2083             *aoffset = abyte;
2084         else
2085             *aoffset = AFS_CHUNKOFFSET(abyte);
2086         if (tdc->validPos < abyte)
2087             *alen = (afs_size_t) 0;
2088         else
2089             *alen = tdc->validPos - abyte;
2090         ReleaseSharedLock(&tdc->lock);
2091         if (setLocks) {
2092             if (slowPass)
2093                 ReleaseWriteLock(&avc->lock);
2094             else
2095                 ReleaseReadLock(&avc->lock);
2096         }
2097         return tdc;             /* check if we're done */
2098     }
2099
2100     /*
2101      * Locks held:
2102      * avc->lock(R) if setLocks && !slowPass
2103      * avc->lock(W) if !setLocks || slowPass
2104      * tdc->lock(S)
2105      */
2106     osi_Assert((setLocks && !slowPass) || WriteLocked(&avc->lock));
2107
2108     setNewCallback = setVcacheStatus = 0;
2109
2110     /*
2111      * Locks held:
2112      * avc->lock(R) if setLocks && !slowPass
2113      * avc->lock(W) if !setLocks || slowPass
2114      * tdc->lock(S)
2115      */
2116     if (!hsame(avc->f.m.DataVersion, tdc->f.versionNo) && !overWriteWholeChunk) {
2117         /*
2118          * Version number mismatch.
2119          */
2120         /*
2121          * If we are disconnected, then we can't do much of anything
2122          * because the data doesn't match the file.
2123          */
2124         if (AFS_IS_DISCONNECTED) {
2125             ReleaseSharedLock(&tdc->lock);
2126             if (setLocks) {
2127                 if (slowPass)
2128                     ReleaseWriteLock(&avc->lock);
2129                 else
2130                     ReleaseReadLock(&avc->lock);
2131             }
2132             /* Flush the Dcache */
2133             afs_PutDCache(tdc);
2134
2135             return NULL;
2136         }
2137         UpgradeSToWLock(&tdc->lock, 609);
2138
2139         /*
2140          * If data ever existed for this vnode, and this is a text object,
2141          * do some clearing.  Now, you'd think you need only do the flush
2142          * when VTEXT is on, but VTEXT is turned off when the text object
2143          * is freed, while pages are left lying around in memory marked
2144          * with this vnode.  If we would reactivate (create a new text
2145          * object from) this vnode, we could easily stumble upon some of
2146          * these old pages in pagein.  So, we always flush these guys.
2147          * Sun has a wonderful lack of useful invariants in this system.
2148          *
2149          * avc->flushDV is the data version # of the file at the last text
2150          * flush.  Clearly, at least, we don't have to flush the file more
2151          * often than it changes
2152          */
2153         if (hcmp(avc->flushDV, avc->f.m.DataVersion) < 0) {
2154             /*
2155              * By here, the cache entry is always write-locked.  We can
2156              * deadlock if we call osi_Flush with the cache entry locked...
2157              * Unlock the dcache too.
2158              */
2159             ReleaseWriteLock(&tdc->lock);
2160             if (setLocks && !slowPass)
2161                 ReleaseReadLock(&avc->lock);
2162             else
2163                 ReleaseWriteLock(&avc->lock);
2164
2165             osi_FlushText(avc);
2166             /*
2167              * Call osi_FlushPages in open, read/write, and map, since it
2168              * is too hard here to figure out if we should lock the
2169              * pvnLock.
2170              */
2171             if (setLocks && !slowPass)
2172                 ObtainReadLock(&avc->lock);
2173             else
2174                 ObtainWriteLock(&avc->lock, 66);
2175             ObtainWriteLock(&tdc->lock, 610);
2176         }
2177
2178         /*
2179          * Locks held:
2180          * avc->lock(R) if setLocks && !slowPass
2181          * avc->lock(W) if !setLocks || slowPass
2182          * tdc->lock(W)
2183          */
2184
2185         /* Watch for standard race condition around osi_FlushText */
2186         if (hsame(avc->f.m.DataVersion, tdc->f.versionNo)) {
2187             updateV2DC(setLocks, avc, tdc, 569);        /* set hint */
2188             afs_stats_cmperf.dcacheHits++;
2189             ConvertWToSLock(&tdc->lock);
2190             goto done;
2191         }
2192
2193         /* Sleep here when cache needs to be drained. */
2194         if (setLocks && !slowPass
2195             && (afs_blocksUsed >
2196                 PERCENT(CM_WAITFORDRAINPCT, afs_cacheBlocks))) {
2197             /* Make sure truncate daemon is running */
2198             afs_MaybeWakeupTruncateDaemon();
2199             ObtainWriteLock(&tdc->tlock, 614);
2200             tdc->refCount--;    /* we'll re-obtain the dcache when we re-try. */
2201             ReleaseWriteLock(&tdc->tlock);
2202             ReleaseWriteLock(&tdc->lock);
2203             ReleaseReadLock(&avc->lock);
2204             while ((afs_blocksUsed - afs_blocksDiscarded) >
2205                    PERCENT(CM_WAITFORDRAINPCT, afs_cacheBlocks)) {
2206                 afs_WaitForCacheDrain = 1;
2207                 afs_osi_Sleep(&afs_WaitForCacheDrain);
2208             }
2209             afs_MaybeFreeDiscardedDCache();
2210             /* need to check if someone else got the chunk first. */
2211             goto RetryGetDCache;
2212         }
2213
2214         Position = AFS_CHUNKBASE(abyte);
2215         if (vType(avc) == VDIR) {
2216             size = avc->f.m.Length;
2217             if (size > tdc->f.chunkBytes) {
2218                 /* pre-reserve space for file */
2219                 afs_AdjustSize(tdc, size);
2220             }
2221             size = 999999999;   /* max size for transfer */
2222         } else {
2223             afs_size_t maxGoodLength;
2224
2225             /* estimate how much data we're expecting back from the server,
2226              * and reserve space in the dcache entry for it */
2227
2228             maxGoodLength = avc->f.m.Length;
2229             if (avc->f.truncPos < maxGoodLength)
2230                 maxGoodLength = avc->f.truncPos;
2231
2232             size = AFS_CHUNKSIZE(abyte);        /* expected max size */
2233             if (Position + size > maxGoodLength)
2234                 size = maxGoodLength - Position;
2235             if (size < 0)
2236                 size = 0;       /* Handle random races */
2237             if (size > tdc->f.chunkBytes) {
2238                 /* pre-reserve estimated space for file */
2239                 afs_AdjustSize(tdc, size);      /* changes chunkBytes */
2240             }
2241
2242             if (size) {
2243                 /* For the actual fetch, do not limit the request to the
2244                  * length of the file. If this results in a read past EOF on
2245                  * the server, the server will just reply with less data than
2246                  * requested. If we limit ourselves to only requesting data up
2247                  * to the avc file length, we open ourselves up to races if the
2248                  * file is extended on the server at about the same time.
2249                  *
2250                  * However, we must restrict ourselves to the avc->f.truncPos
2251                  * length, since this represents an outstanding local
2252                  * truncation of the file that will be committed to the
2253                  * fileserver when we actually write the fileserver contents.
2254                  * If we do not restrict the fetch length based on
2255                  * avc->f.truncPos, a different truncate operation extending
2256                  * the file length could cause the old data after
2257                  * avc->f.truncPos to reappear, instead of extending the file
2258                  * with NUL bytes. */
2259                 size = AFS_CHUNKSIZE(abyte);
2260                 if (Position + size > avc->f.truncPos) {
2261                     size = avc->f.truncPos - Position;
2262                 }
2263                 if (size < 0) {
2264                     size = 0;
2265                 }
2266             }
2267         }
2268         if (afs_mariner && !tdc->f.chunk)
2269             afs_MarinerLog("fetch$Fetching", avc);      /* , Position, size, afs_indexCounter ); */
2270         /*
2271          * Right now, we only have one tool, and it's a hammer.  So, we
2272          * fetch the whole file.
2273          */
2274         DZap(tdc);      /* pages in cache may be old */
2275         file = afs_CFileOpen(&tdc->f.inode);
2276         afs_RemoveVCB(&avc->f.fid);
2277         tdc->f.states |= DWriting;
2278         tdc->dflags |= DFFetching;
2279         tdc->validPos = Position;       /*  which is AFS_CHUNKBASE(abyte) */
2280         if (tdc->mflags & DFFetchReq) {
2281             tdc->mflags &= ~DFFetchReq;
2282             if (afs_osi_Wakeup(&tdc->validPos) == 0)
2283                 afs_Trace4(afs_iclSetp, CM_TRACE_DCACHEWAKE, ICL_TYPE_STRING,
2284                            __FILE__, ICL_TYPE_INT32, __LINE__,
2285                            ICL_TYPE_POINTER, tdc, ICL_TYPE_INT32,
2286                            tdc->dflags);
2287         }
2288         tsmall = osi_AllocLargeSpace(sizeof(struct afs_FetchOutput));
2289         setVcacheStatus = 0;
2290 #ifndef AFS_NOSTATS
2291         /*
2292          * Remember if we are doing the reading from a replicated volume,
2293          * and how many times we've zipped around the fetch/analyze loop.
2294          */
2295         fromReplica = (avc->f.states & CRO) ? 1 : 0;
2296         numFetchLoops = 0;
2297         accP = &(afs_stats_cmfullperf.accessinf);
2298         if (fromReplica)
2299             (accP->replicatedRefs)++;
2300         else
2301             (accP->unreplicatedRefs)++;
2302 #endif /* AFS_NOSTATS */
2303         /* this is a cache miss */
2304         afs_Trace4(afs_iclSetp, CM_TRACE_FETCHPROC, ICL_TYPE_POINTER, avc,
2305                    ICL_TYPE_FID, &(avc->f.fid), ICL_TYPE_OFFSET,
2306                    ICL_HANDLE_OFFSET(Position), ICL_TYPE_INT32, size);
2307
2308         if (size)
2309             afs_stats_cmperf.dcacheMisses++;
2310         code = 0;
2311         /*
2312          * Dynamic root support:  fetch data from local memory.
2313          */
2314         if (afs_IsDynroot(avc)) {
2315             char *dynrootDir;
2316             int dynrootLen;
2317
2318             afs_GetDynroot(&dynrootDir, &dynrootLen, &tsmall->OutStatus);
2319
2320             dynrootDir += Position;
2321             dynrootLen -= Position;
2322             if (size > dynrootLen)
2323                 size = dynrootLen;
2324             if (size < 0)
2325                 size = 0;
2326             code = afs_CFileWrite(file, 0, dynrootDir, size);
2327             afs_PutDynroot();
2328
2329             if (code == size)
2330                 code = 0;
2331             else
2332                 code = -1;
2333
2334             tdc->validPos = Position + size;
2335             afs_CFileTruncate(file, size);      /* prune it */
2336         } else if (afs_IsDynrootMount(avc)) {
2337             char *dynrootDir;
2338             int dynrootLen;
2339
2340             afs_GetDynrootMount(&dynrootDir, &dynrootLen, &tsmall->OutStatus);
2341
2342             dynrootDir += Position;
2343             dynrootLen -= Position;
2344             if (size > dynrootLen)
2345                 size = dynrootLen;
2346             if (size < 0)
2347                 size = 0;
2348             code = afs_CFileWrite(file, 0, dynrootDir, size);
2349             afs_PutDynroot();
2350
2351             if (code == size)
2352                 code = 0;
2353             else
2354                 code = -1;
2355
2356             tdc->validPos = Position + size;
2357             afs_CFileTruncate(file, size);      /* prune it */
2358         } else
2359             /*
2360              * Not a dynamic vnode:  do the real fetch.
2361              */
2362             do {
2363                 /*
2364                  * Locks held:
2365                  * avc->lock(R) if setLocks && !slowPass
2366                  * avc->lock(W) if !setLocks || slowPass
2367                  * tdc->lock(W)
2368                  */
2369
2370                 tc = afs_Conn(&avc->f.fid, areq, SHARED_LOCK, &rxconn);
2371                 if (tc) {
2372 #ifndef AFS_NOSTATS
2373                     numFetchLoops++;
2374                     if (fromReplica)
2375                         (accP->numReplicasAccessed)++;
2376
2377 #endif /* AFS_NOSTATS */
2378                     if (!setLocks || slowPass) {
2379                         avc->callback = tc->parent->srvr->server;
2380                     } else {
2381                         newCallback = tc->parent->srvr->server;
2382                         setNewCallback = 1;
2383                     }
2384                     i = osi_Time();
2385                     code = afs_CacheFetchProc(tc, rxconn, file, Position, tdc,
2386                                                avc, size, tsmall);
2387                 } else
2388                    code = -1;
2389
2390                 if (code == 0) {
2391                     /* callback could have been broken (or expired) in a race here,
2392                      * but we return the data anyway.  It's as good as we knew about
2393                      * when we started. */
2394                     /*
2395                      * validPos is updated by CacheFetchProc, and can only be
2396                      * modifed under a dcache write lock, which we've blocked out
2397                      */
2398                     size = tdc->validPos - Position;    /* actual segment size */
2399                     if (size < 0)
2400                         size = 0;
2401                     afs_CFileTruncate(file, size);      /* prune it */
2402                 } else {
2403                     if (!setLocks || slowPass) {
2404                         ObtainWriteLock(&afs_xcbhash, 453);
2405                         afs_DequeueCallback(avc);
2406                         avc->f.states &= ~(CStatd | CUnique);
2407                         avc->callback = NULL;
2408                         ReleaseWriteLock(&afs_xcbhash);
2409                         if (avc->f.fid.Fid.Vnode & 1 || (vType(avc) == VDIR))
2410                             osi_dnlc_purgedp(avc);
2411                     } else {
2412                         /* Something lost.  Forget about performance, and go
2413                          * back with a vcache write lock.
2414                          */
2415                         afs_CFileTruncate(file, 0);
2416                         afs_AdjustSize(tdc, 0);
2417                         afs_CFileClose(file);
2418                         osi_FreeLargeSpace(tsmall);
2419                         tsmall = 0;
2420                         ReleaseWriteLock(&tdc->lock);
2421                         afs_PutDCache(tdc);
2422                         tdc = 0;
2423                         ReleaseReadLock(&avc->lock);
2424
2425                         if (tc) {
2426                             /* If we have a connection, we must put it back,
2427                              * since afs_Analyze will not be called here. */
2428                             afs_PutConn(tc, rxconn, SHARED_LOCK);
2429                         }
2430
2431                         slowPass = 1;
2432                         goto RetryGetDCache;
2433                     }
2434                 }
2435
2436             } while (afs_Analyze
2437                      (tc, rxconn, code, &avc->f.fid, areq,
2438                       AFS_STATS_FS_RPCIDX_FETCHDATA, SHARED_LOCK, NULL));
2439
2440         /*
2441          * Locks held:
2442          * avc->lock(R) if setLocks && !slowPass
2443          * avc->lock(W) if !setLocks || slowPass
2444          * tdc->lock(W)
2445          */
2446
2447 #ifndef AFS_NOSTATS
2448         /*
2449          * In the case of replicated access, jot down info on the number of
2450          * attempts it took before we got through or gave up.
2451          */
2452         if (fromReplica) {
2453             if (numFetchLoops <= 1)
2454                 (accP->refFirstReplicaOK)++;
2455             if (numFetchLoops > accP->maxReplicasPerRef)
2456                 accP->maxReplicasPerRef = numFetchLoops;
2457         }
2458 #endif /* AFS_NOSTATS */
2459
2460         tdc->dflags &= ~DFFetching;
2461         if (afs_osi_Wakeup(&tdc->validPos) == 0)
2462             afs_Trace4(afs_iclSetp, CM_TRACE_DCACHEWAKE, ICL_TYPE_STRING,
2463                        __FILE__, ICL_TYPE_INT32, __LINE__, ICL_TYPE_POINTER,
2464                        tdc, ICL_TYPE_INT32, tdc->dflags);
2465         if (avc->execsOrWriters == 0)
2466             tdc->f.states &= ~DWriting;
2467
2468         /* now, if code != 0, we have an error and should punt.
2469          * note that we have the vcache write lock, either because
2470          * !setLocks or slowPass.
2471          */
2472         if (code) {
2473             afs_CFileTruncate(file, 0);
2474             afs_AdjustSize(tdc, 0);
2475             afs_CFileClose(file);
2476             ZapDCE(tdc);        /* sets DFEntryMod */
2477             if (vType(avc) == VDIR) {
2478                 DZap(tdc);
2479             }
2480             tdc->f.states &= ~(DRO|DBackup|DRW);
2481             afs_DCMoveBucket(tdc, 0, 0);
2482             ReleaseWriteLock(&tdc->lock);
2483             afs_PutDCache(tdc);
2484             if (!afs_IsDynroot(avc)) {
2485                 ObtainWriteLock(&afs_xcbhash, 454);
2486                 afs_DequeueCallback(avc);
2487                 avc->f.states &= ~(CStatd | CUnique);
2488                 ReleaseWriteLock(&afs_xcbhash);
2489                 if (avc->f.fid.Fid.Vnode & 1 || (vType(avc) == VDIR))
2490                     osi_dnlc_purgedp(avc);
2491                 /*
2492                  * Locks held:
2493                  * avc->lock(W); assert(!setLocks || slowPass)
2494                  */
2495                 osi_Assert(!setLocks || slowPass);
2496             }
2497             tdc = NULL;
2498             goto done;
2499         }
2500
2501         /* otherwise we copy in the just-fetched info */
2502         afs_CFileClose(file);
2503         afs_AdjustSize(tdc, size);      /* new size */
2504         /*
2505          * Copy appropriate fields into vcache.  Status is
2506          * copied later where we selectively acquire the
2507          * vcache write lock.
2508          */
2509         if (slowPass)
2510             afs_ProcessFS(avc, &tsmall->OutStatus, areq);
2511         else
2512             setVcacheStatus = 1;
2513         hset64(tdc->f.versionNo, tsmall->OutStatus.dataVersionHigh,
2514                tsmall->OutStatus.DataVersion);
2515         tdc->dflags |= DFEntryMod;
2516         afs_indexFlags[tdc->index] |= IFEverUsed;
2517         ConvertWToSLock(&tdc->lock);
2518     } /*Data version numbers don't match */
2519     else {
2520         /*
2521          * Data version numbers match.
2522          */
2523         afs_stats_cmperf.dcacheHits++;
2524     }                           /*Data version numbers match */
2525
2526     updateV2DC(setLocks, avc, tdc, 335);        /* set hint */
2527   done:
2528     /*
2529      * Locks held:
2530      * avc->lock(R) if setLocks && !slowPass
2531      * avc->lock(W) if !setLocks || slowPass
2532      * tdc->lock(S) if tdc
2533      */
2534
2535     /*
2536      * See if this was a reference to a file in the local cell.
2537      */
2538     if (afs_IsPrimaryCellNum(avc->f.fid.Cell))
2539         afs_stats_cmperf.dlocalAccesses++;
2540     else
2541         afs_stats_cmperf.dremoteAccesses++;
2542
2543     /* Fix up LRU info */
2544
2545     if (tdc) {
2546         ObtainWriteLock(&afs_xdcache, 602);
2547         hset(afs_indexTimes[tdc->index], afs_indexCounter);
2548         hadd32(afs_indexCounter, 1);
2549         ReleaseWriteLock(&afs_xdcache);
2550
2551         /* return the data */
2552         if (vType(avc) == VDIR)
2553             *aoffset = abyte;
2554         else
2555             *aoffset = AFS_CHUNKOFFSET(abyte);
2556         *alen = (tdc->f.chunkBytes - *aoffset);
2557         ReleaseSharedLock(&tdc->lock);
2558     }
2559
2560     /*
2561      * Locks held:
2562      * avc->lock(R) if setLocks && !slowPass
2563      * avc->lock(W) if !setLocks || slowPass
2564      */
2565
2566     /* Fix up the callback and status values in the vcache */
2567     doVcacheUpdate = 0;
2568     if (setLocks && !slowPass) {
2569         /* DCLOCKXXX
2570          *
2571          * This is our dirty little secret to parallel fetches.
2572          * We don't write-lock the vcache while doing the fetch,
2573          * but potentially we'll need to update the vcache after
2574          * the fetch is done.
2575          *
2576          * Drop the read lock and try to re-obtain the write
2577          * lock.  If the vcache still has the same DV, it's
2578          * ok to go ahead and install the new data.
2579          */
2580         afs_hyper_t currentDV, statusDV;
2581
2582         hset(currentDV, avc->f.m.DataVersion);
2583
2584         if (setNewCallback && avc->callback != newCallback)
2585             doVcacheUpdate = 1;
2586
2587         if (tsmall) {
2588             hset64(statusDV, tsmall->OutStatus.dataVersionHigh,
2589                    tsmall->OutStatus.DataVersion);
2590
2591             if (setVcacheStatus && avc->f.m.Length != tsmall->OutStatus.Length)
2592                 doVcacheUpdate = 1;
2593             if (setVcacheStatus && !hsame(currentDV, statusDV))
2594                 doVcacheUpdate = 1;
2595         }
2596
2597         ReleaseReadLock(&avc->lock);
2598
2599         if (doVcacheUpdate) {
2600             ObtainWriteLock(&avc->lock, 615);
2601             if (!hsame(avc->f.m.DataVersion, currentDV)) {
2602                 /* We lose.  Someone will beat us to it. */
2603                 doVcacheUpdate = 0;
2604                 ReleaseWriteLock(&avc->lock);
2605             }
2606         }
2607     }
2608
2609     /* With slow pass, we've already done all the updates */
2610     if (slowPass) {
2611         ReleaseWriteLock(&avc->lock);
2612     }
2613
2614     /* Check if we need to perform any last-minute fixes with a write-lock */
2615     if (!setLocks || doVcacheUpdate) {
2616         if (setNewCallback)
2617             avc->callback = newCallback;
2618         if (tsmall && setVcacheStatus)
2619             afs_ProcessFS(avc, &tsmall->OutStatus, areq);
2620         if (setLocks)
2621             ReleaseWriteLock(&avc->lock);
2622     }
2623
2624     if (tsmall)
2625         osi_FreeLargeSpace(tsmall);
2626
2627     return tdc;
2628 }                               /*afs_GetDCache */
2629
2630
2631 /*
2632  * afs_WriteThroughDSlots
2633  *
2634  * Description:
2635  *      Sweep through the dcache slots and write out any modified
2636  *      in-memory data back on to our caching store.
2637  *
2638  * Parameters:
2639  *      None.
2640  *
2641  * Environment:
2642  *      The afs_xdcache is write-locked through this whole affair.
2643  */
2644 void
2645 afs_WriteThroughDSlots(void)
2646 {
2647     struct dcache *tdc;
2648     afs_int32 i, touchedit = 0;
2649
2650     struct afs_q DirtyQ, *tq;
2651
2652     AFS_STATCNT(afs_WriteThroughDSlots);
2653
2654     /*
2655      * Because of lock ordering, we can't grab dcache locks while
2656      * holding afs_xdcache.  So we enter xdcache, get a reference
2657      * for every dcache entry, and exit xdcache.
2658      */
2659     ObtainWriteLock(&afs_xdcache, 283);
2660     QInit(&DirtyQ);
2661     for (i = 0; i < afs_cacheFiles; i++) {
2662         tdc = afs_indexTable[i];
2663
2664         /* Grab tlock in case the existing refcount isn't zero */
2665         if (tdc && !(afs_indexFlags[i] & (IFFree | IFDiscarded))) {
2666             ObtainWriteLock(&tdc->tlock, 623);
2667             tdc->refCount++;
2668             ReleaseWriteLock(&tdc->tlock);
2669
2670             QAdd(&DirtyQ, &tdc->dirty);
2671         }
2672     }
2673     ReleaseWriteLock(&afs_xdcache);
2674
2675     /*
2676      * Now, for each dcache entry we found, check if it's dirty.
2677      * If so, get write-lock, get afs_xdcache, which protects
2678      * afs_cacheInodep, and flush it.  Don't forget to put back
2679      * the refcounts.
2680      */
2681
2682 #define DQTODC(q)       ((struct dcache *)(((char *) (q)) - sizeof(struct afs_q)))
2683
2684     for (tq = DirtyQ.prev; tq != &DirtyQ; tq = QPrev(tq)) {
2685         tdc = DQTODC(tq);
2686         if (tdc->dflags & DFEntryMod) {
2687             int wrLock;
2688
2689             wrLock = (0 == NBObtainWriteLock(&tdc->lock, 619));
2690
2691             /* Now that we have the write lock, double-check */
2692             if (wrLock && (tdc->dflags & DFEntryMod)) {
2693                 tdc->dflags &= ~DFEntryMod;
2694                 ObtainWriteLock(&afs_xdcache, 620);
2695                 osi_Assert(afs_WriteDCache(tdc, 1) == 0);
2696                 ReleaseWriteLock(&afs_xdcache);
2697                 touchedit = 1;
2698             }
2699             if (wrLock)
2700                 ReleaseWriteLock(&tdc->lock);
2701         }
2702
2703         afs_PutDCache(tdc);
2704     }
2705
2706     ObtainWriteLock(&afs_xdcache, 617);
2707     if (!touchedit && (cacheDiskType != AFS_FCACHE_TYPE_MEM)) {
2708         /* Touch the file to make sure that the mtime on the file is kept
2709          * up-to-date to avoid losing cached files on cold starts because
2710          * their mtime seems old...
2711          */
2712         struct afs_fheader theader;
2713
2714         afs_InitFHeader(&theader);
2715         afs_osi_Write(afs_cacheInodep, 0, &theader, sizeof(theader));
2716     }
2717     ReleaseWriteLock(&afs_xdcache);
2718 }
2719
2720 /*
2721  * afs_MemGetDSlot
2722  *
2723  * Description:
2724  *      Return a pointer to an freshly initialized dcache entry using
2725  *      a memory-based cache.  The tlock will be read-locked.
2726  *
2727  * Parameters:
2728  *      aslot : Dcache slot to look at.
2729  *      type : What 'type' of dslot to get; see the dslot_state enum
2730  *
2731  * Environment:
2732  *      Must be called with afs_xdcache write-locked.
2733  */
2734
2735 struct dcache *
2736 afs_MemGetDSlot(afs_int32 aslot, dslot_state type)
2737 {
2738     struct dcache *tdc;
2739     int existing = 0;
2740
2741     AFS_STATCNT(afs_MemGetDSlot);
2742     if (CheckLock(&afs_xdcache) != -1)
2743         osi_Panic("getdslot nolock");
2744     if (aslot < 0 || aslot >= afs_cacheFiles)
2745         osi_Panic("getdslot slot %d (of %d)", aslot, afs_cacheFiles);
2746     tdc = afs_indexTable[aslot];
2747     if (tdc) {
2748         QRemove(&tdc->lruq);    /* move to queue head */
2749         QAdd(&afs_DLRU, &tdc->lruq);
2750         /* We're holding afs_xdcache, but get tlock in case refCount != 0 */
2751         ObtainWriteLock(&tdc->tlock, 624);
2752         tdc->refCount++;
2753         ConvertWToRLock(&tdc->tlock);
2754         return tdc;
2755     }
2756
2757     /* if we got here, the given slot is not in memory in our list of known
2758      * slots. for memcache, the only place a dslot can exist is in memory, so
2759      * if the caller is expecting to get back a known dslot, and we've reached
2760      * here, something is very wrong. DSLOT_NEW is the only type of dslot that
2761      * may not exist; for all others, the caller assumes the given dslot
2762      * already exists. so, 'type' had better be DSLOT_NEW here, or something is
2763      * very wrong. */
2764     osi_Assert(type == DSLOT_NEW);
2765
2766     if (!afs_freeDSList)
2767         afs_GetDownDSlot(4);
2768     if (!afs_freeDSList) {
2769         /* none free, making one is better than a panic */
2770         afs_stats_cmperf.dcacheXAllocs++;       /* count in case we have a leak */
2771         tdc = afs_osi_Alloc(sizeof(struct dcache));
2772         osi_Assert(tdc != NULL);
2773 #ifdef  KERNEL_HAVE_PIN
2774         pin((char *)tdc, sizeof(struct dcache));        /* XXX */
2775 #endif
2776     } else {
2777         tdc = afs_freeDSList;
2778         afs_freeDSList = (struct dcache *)tdc->lruq.next;
2779         existing = 1;
2780     }
2781     tdc->dflags = 0;    /* up-to-date, not in free q */
2782     tdc->mflags = 0;
2783     QAdd(&afs_DLRU, &tdc->lruq);
2784     if (tdc->lruq.prev == &tdc->lruq)
2785         osi_Panic("lruq 3");
2786
2787     /* initialize entry */
2788     tdc->f.fid.Cell = 0;
2789     tdc->f.fid.Fid.Volume = 0;
2790     tdc->f.chunk = -1;
2791     hones(tdc->f.versionNo);
2792     tdc->f.inode.mem = aslot;
2793     tdc->dflags |= DFEntryMod;
2794     tdc->refCount = 1;
2795     tdc->index = aslot;
2796     afs_indexUnique[aslot] = tdc->f.fid.Fid.Unique;
2797
2798     if (existing) {
2799         osi_Assert(0 == NBObtainWriteLock(&tdc->lock, 674));
2800         osi_Assert(0 == NBObtainWriteLock(&tdc->mflock, 675));
2801         osi_Assert(0 == NBObtainWriteLock(&tdc->tlock, 676));
2802     }
2803
2804     AFS_RWLOCK_INIT(&tdc->lock, "dcache lock");
2805     AFS_RWLOCK_INIT(&tdc->tlock, "dcache tlock");
2806     AFS_RWLOCK_INIT(&tdc->mflock, "dcache flock");
2807     ObtainReadLock(&tdc->tlock);
2808
2809     afs_indexTable[aslot] = tdc;
2810     return tdc;
2811
2812 }                               /*afs_MemGetDSlot */
2813
2814 unsigned int last_error = 0, lasterrtime = 0;
2815
2816 /*
2817  * afs_UFSGetDSlot
2818  *
2819  * Description:
2820  *      Return a pointer to an freshly initialized dcache entry using
2821  *      a UFS-based disk cache.  The dcache tlock will be read-locked.
2822  *
2823  * Parameters:
2824  *      aslot : Dcache slot to look at.
2825  *      type : What 'type' of dslot to get; see the dslot_state enum
2826  *
2827  * Environment:
2828  *      afs_xdcache lock write-locked.
2829  */
2830 struct dcache *
2831 afs_UFSGetDSlot(afs_int32 aslot, dslot_state type)
2832 {
2833     afs_int32 code;
2834     struct dcache *tdc;
2835     int existing = 0;
2836     int entryok;
2837     int off;
2838
2839     AFS_STATCNT(afs_UFSGetDSlot);
2840     if (CheckLock(&afs_xdcache) != -1)
2841         osi_Panic("getdslot nolock");
2842     if (aslot < 0 || aslot >= afs_cacheFiles)
2843         osi_Panic("getdslot slot %d (of %d)", aslot, afs_cacheFiles);
2844     tdc = afs_indexTable[aslot];
2845     if (tdc) {
2846         QRemove(&tdc->lruq);    /* move to queue head */
2847         QAdd(&afs_DLRU, &tdc->lruq);
2848         /* Grab tlock in case refCount != 0 */
2849         ObtainWriteLock(&tdc->tlock, 625);
2850         tdc->refCount++;
2851         ConvertWToRLock(&tdc->tlock);
2852         return tdc;
2853     }
2854
2855     /* otherwise we should read it in from the cache file */
2856     if (!afs_freeDSList)
2857         afs_GetDownDSlot(4);
2858     if (!afs_freeDSList) {
2859         /* none free, making one is better than a panic */
2860         afs_stats_cmperf.dcacheXAllocs++;       /* count in case we have a leak */
2861         tdc = afs_osi_Alloc(sizeof(struct dcache));
2862         osi_Assert(tdc != NULL);
2863 #ifdef  KERNEL_HAVE_PIN
2864         pin((char *)tdc, sizeof(struct dcache));        /* XXX */
2865 #endif
2866     } else {
2867         tdc = afs_freeDSList;
2868         afs_freeDSList = (struct dcache *)tdc->lruq.next;
2869         existing = 1;
2870     }
2871     tdc->dflags = 0;    /* up-to-date, not in free q */
2872     tdc->mflags = 0;
2873     QAdd(&afs_DLRU, &tdc->lruq);
2874     if (tdc->lruq.prev == &tdc->lruq)
2875         osi_Panic("lruq 3");
2876
2877     /*
2878      * Seek to the aslot'th entry and read it in.
2879      */
2880     off = sizeof(struct fcache)*aslot + sizeof(struct afs_fheader);
2881     code =
2882         afs_osi_Read(afs_cacheInodep,
2883                      off, (char *)(&tdc->f),
2884                      sizeof(struct fcache));
2885     entryok = 1;
2886     if (code != sizeof(struct fcache)) {
2887         entryok = 0;
2888 #if defined(KERNEL_HAVE_UERROR)
2889         last_error = getuerror();
2890 #else
2891         last_error = code;
2892 #endif
2893         lasterrtime = osi_Time();
2894         if (type != DSLOT_NEW) {
2895             /* If we are requesting a non-DSLOT_NEW slot, this is an error.
2896              * non-DSLOT_NEW slots are supposed to already exist, so if we
2897              * failed to read in the slot, something is wrong. */
2898             struct osi_stat tstat;
2899             if (afs_osi_Stat(afs_cacheInodep, &tstat)) {
2900                 tstat.size = -1;
2901             }
2902             afs_warn("afs: disk cache read error in CacheItems slot %d "
2903                      "off %d/%d code %d/%d\n",
2904                      (int)aslot,
2905                      off, (int)tstat.size,
2906                      (int)code, (int)sizeof(struct fcache));
2907             /* put tdc back on the free dslot list */
2908             QRemove(&tdc->lruq);
2909             tdc->index = NULLIDX;
2910             tdc->lruq.next = (struct afs_q *)afs_freeDSList;
2911             afs_freeDSList = tdc;
2912             return NULL;
2913         }
2914     }
2915     if (!afs_CellNumValid(tdc->f.fid.Cell)) {
2916         entryok = 0;
2917         if (type == DSLOT_VALID) {
2918             osi_Panic("afs: needed valid dcache but index %d off %d has "
2919                       "invalid cell num %d\n",
2920                       (int)aslot, off, (int)tdc->f.fid.Cell);
2921         }
2922     }
2923
2924     if (type == DSLOT_VALID && tdc->f.fid.Fid.Volume == 0) {
2925         osi_Panic("afs: invalid zero-volume dcache entry at slot %d off %d",
2926                   (int)aslot, off);
2927     }
2928
2929     if (type == DSLOT_UNUSED) {
2930         /* the requested dslot is known to exist, but contain invalid data
2931          * (this happens when we're using a dslot from the free or discard
2932          * list). be sure not to re-use the data in it, so force invalidation.
2933          */
2934         entryok = 0;
2935     }
2936
2937     if (!entryok) {
2938         tdc->f.fid.Cell = 0;
2939         tdc->f.fid.Fid.Volume = 0;
2940         tdc->f.chunk = -1;
2941         hones(tdc->f.versionNo);
2942         tdc->dflags |= DFEntryMod;
2943         afs_indexUnique[aslot] = tdc->f.fid.Fid.Unique;
2944         tdc->f.states &= ~(DRO|DBackup|DRW);
2945         afs_DCMoveBucket(tdc, 0, 0);
2946     } else {
2947         if (tdc->f.states & DRO) {
2948             afs_DCMoveBucket(tdc, 0, 2);
2949         } else if (tdc->f.states & DBackup) {
2950             afs_DCMoveBucket(tdc, 0, 1);
2951         } else {
2952             afs_DCMoveBucket(tdc, 0, 1);
2953         }
2954     }
2955     tdc->refCount = 1;
2956     tdc->index = aslot;
2957     if (tdc->f.chunk >= 0)
2958         tdc->validPos = AFS_CHUNKTOBASE(tdc->f.chunk) + tdc->f.chunkBytes;
2959     else
2960         tdc->validPos = 0;
2961
2962     if (existing) {
2963         osi_Assert(0 == NBObtainWriteLock(&tdc->lock, 674));
2964         osi_Assert(0 == NBObtainWriteLock(&tdc->mflock, 675));
2965         osi_Assert(0 == NBObtainWriteLock(&tdc->tlock, 676));
2966     }
2967
2968     AFS_RWLOCK_INIT(&tdc->lock, "dcache lock");
2969     AFS_RWLOCK_INIT(&tdc->tlock, "dcache tlock");
2970     AFS_RWLOCK_INIT(&tdc->mflock, "dcache flock");
2971     ObtainReadLock(&tdc->tlock);
2972
2973     /*
2974      * If we didn't read into a temporary dcache region, update the
2975      * slot pointer table.
2976      */
2977     afs_indexTable[aslot] = tdc;
2978     return tdc;
2979
2980 }                               /*afs_UFSGetDSlot */
2981
2982
2983
2984 /*!
2985  * Write a particular dcache entry back to its home in the
2986  * CacheInfo file.
2987  *
2988  * \param adc Pointer to the dcache entry to write.
2989  * \param atime If true, set the modtime on the file to the current time.
2990  *
2991  * \note Environment:
2992  *      Must be called with the afs_xdcache lock at least read-locked,
2993  *      and dcache entry at least read-locked.
2994  *      The reference count is not changed.
2995  */
2996
2997 int
2998 afs_WriteDCache(struct dcache *adc, int atime)
2999 {
3000     afs_int32 code;
3001
3002     if (cacheDiskType == AFS_FCACHE_TYPE_MEM)
3003         return 0;
3004     AFS_STATCNT(afs_WriteDCache);
3005     osi_Assert(WriteLocked(&afs_xdcache));
3006     if (atime)
3007         adc->f.modTime = osi_Time();
3008
3009     if ((afs_indexFlags[adc->index] & (IFFree | IFDiscarded)) == 0 &&
3010         adc->f.fid.Fid.Volume == 0) {
3011         /* If a dcache slot is not on the free or discard list, it must be
3012          * in the hash table. Thus, the volume must be non-zero, since that
3013          * is how we determine whether or not to unhash the entry when kicking
3014          * it out of the cache. Do this check now, since otherwise this can
3015          * cause hash table corruption and a panic later on after we read the
3016          * entry back in. */
3017         osi_Panic("afs_WriteDCache zero volume index %d flags 0x%x\n",
3018                   adc->index, (unsigned)afs_indexFlags[adc->index]);
3019     }
3020
3021     /*
3022      * Seek to the right dcache slot and write the in-memory image out to disk.
3023      */
3024     afs_cellname_write();
3025     code =
3026         afs_osi_Write(afs_cacheInodep,
3027                       sizeof(struct fcache) * adc->index +
3028                       sizeof(struct afs_fheader), (char *)(&adc->f),
3029                       sizeof(struct fcache));
3030     if (code != sizeof(struct fcache)) {
3031         afs_warn("afs: failed to write to CacheItems off %ld code %d/%d\n",
3032                  (long)(sizeof(struct fcache) * adc->index + sizeof(struct afs_fheader)),
3033                  (int)code, (int)sizeof(struct fcache));
3034         return EIO;
3035     }
3036     return 0;
3037 }
3038
3039
3040
3041 /*!
3042  * Wake up users of a particular file waiting for stores to take
3043  * place.
3044  *
3045  * \param avc Ptr to related vcache entry.
3046  *
3047  * \note Environment:
3048  *      Nothing interesting.
3049  */
3050 int
3051 afs_wakeup(struct vcache *avc)
3052 {
3053     int i;
3054     struct brequest *tb;
3055     tb = afs_brs;
3056     AFS_STATCNT(afs_wakeup);
3057     for (i = 0; i < NBRS; i++, tb++) {
3058         /* if request is valid and for this file, we've found it */
3059         if (tb->refCount > 0 && avc == tb->vc) {
3060
3061             /*
3062              * If CSafeStore is on, then we don't awaken the guy
3063              * waiting for the store until the whole store has finished.
3064              * Otherwise, we do it now.  Note that if CSafeStore is on,
3065              * the BStore routine actually wakes up the user, instead
3066              * of us.
3067              * I think this is redundant now because this sort of thing
3068              * is already being handled by the higher-level code.
3069              */
3070             if ((avc->f.states & CSafeStore) == 0) {
3071                 tb->code_raw = tb->code_checkcode = 0;
3072                 tb->flags |= BUVALID;
3073                 if (tb->flags & BUWAIT) {
3074                     tb->flags &= ~BUWAIT;
3075                     afs_osi_Wakeup(tb);
3076                 }
3077             }
3078             break;
3079         }
3080     }
3081     return 0;
3082 }
3083
3084 /*!
3085  * Given a file name and inode, set up that file to be an
3086  * active member in the AFS cache.  This also involves checking
3087  * the usability of its data.
3088  *
3089  * \param afile Name of the cache file to initialize.
3090  * \param ainode Inode of the file.
3091  *
3092  * \note Environment:
3093  *      This function is called only during initialization.
3094  */
3095 int
3096 afs_InitCacheFile(char *afile, ino_t ainode)
3097 {
3098     afs_int32 code;
3099     afs_int32 index;
3100     int fileIsBad;
3101     struct osi_file *tfile;
3102     struct osi_stat tstat;
3103     struct dcache *tdc;
3104
3105     AFS_STATCNT(afs_InitCacheFile);
3106     index = afs_stats_cmperf.cacheNumEntries;
3107     if (index >= afs_cacheFiles)
3108         return EINVAL;
3109
3110     ObtainWriteLock(&afs_xdcache, 282);
3111     tdc = afs_GetNewDSlot(index);
3112     ReleaseReadLock(&tdc->tlock);
3113     ReleaseWriteLock(&afs_xdcache);
3114
3115     ObtainWriteLock(&tdc->lock, 621);
3116     ObtainWriteLock(&afs_xdcache, 622);
3117     if (!afile && !ainode) {
3118         tfile = NULL;
3119         fileIsBad = 1;
3120     } else {
3121         if (afile) {
3122             code = afs_LookupInodeByPath(afile, &tdc->f.inode.ufs, NULL);
3123             if (code) {
3124                 ReleaseWriteLock(&afs_xdcache);
3125                 ReleaseWriteLock(&tdc->lock);
3126                 afs_PutDCache(tdc);
3127                 return code;
3128             }
3129         } else {
3130             /* Add any other 'complex' inode types here ... */
3131 #if !defined(AFS_LINUX26_ENV) && !defined(AFS_CACHE_VNODE_PATH)
3132             tdc->f.inode.ufs = ainode;
3133 #else
3134             osi_Panic("Can't init cache with inode numbers when complex inodes are "
3135                       "in use\n");
3136 #endif
3137         }
3138         fileIsBad = 0;
3139         if ((tdc->f.states & DWriting) || tdc->f.fid.Fid.Volume == 0)
3140             fileIsBad = 1;
3141         tfile = osi_UFSOpen(&tdc->f.inode);
3142         if (!tfile) {
3143             ReleaseWriteLock(&afs_xdcache);
3144             ReleaseWriteLock(&tdc->lock);
3145             afs_PutDCache(tdc);
3146             return ENOENT;
3147         }
3148
3149         code = afs_osi_Stat(tfile, &tstat);
3150         if (code)
3151             osi_Panic("initcachefile stat");
3152
3153         /*
3154          * If file size doesn't match the cache info file, it's probably bad.
3155          */
3156         if (tdc->f.chunkBytes != tstat.size)
3157             fileIsBad = 1;
3158         /*
3159          * If file changed within T (120?) seconds of cache info file, it's
3160          * probably bad.  In addition, if slot changed within last T seconds,
3161          * the cache info file may be incorrectly identified, and so slot
3162          * may be bad.
3163          */
3164         if (cacheInfoModTime < tstat.mtime + 120)
3165             fileIsBad = 1;
3166         if (cacheInfoModTime < tdc->f.modTime + 120)
3167             fileIsBad = 1;
3168         /* In case write through is behind, make sure cache items entry is
3169          * at least as new as the chunk.
3170          */
3171         if (tdc->f.modTime < tstat.mtime)
3172             fileIsBad = 1;
3173     }
3174     tdc->f.chunkBytes = 0;
3175
3176     if (fileIsBad) {
3177         tdc->f.fid.Fid.Volume = 0;      /* not in the hash table */
3178         if (tfile && tstat.size != 0)
3179             osi_UFSTruncate(tfile, 0);
3180         tdc->f.states &= ~(DRO|DBackup|DRW);
3181         afs_DCMoveBucket(tdc, 0, 0);
3182         /* put entry in free cache slot list */
3183         afs_dvnextTbl[tdc->index] = afs_freeDCList;
3184         afs_freeDCList = index;
3185         afs_freeDCCount++;
3186         afs_indexFlags[index] |= IFFree;
3187         afs_indexUnique[index] = 0;
3188     } else {
3189         /*
3190          * We must put this entry in the appropriate hash tables.
3191          * Note that i is still set from the above DCHash call
3192          */
3193         code = DCHash(&tdc->f.fid, tdc->f.chunk);
3194         afs_dcnextTbl[tdc->index] = afs_dchashTbl[code];
3195         afs_dchashTbl[code] = tdc->index;
3196         code = DVHash(&tdc->f.fid);
3197         afs_dvnextTbl[tdc->index] = afs_dvhashTbl[code];
3198         afs_dvhashTbl[code] = tdc->index;
3199         afs_AdjustSize(tdc, tstat.size);        /* adjust to new size */
3200         if (tstat.size > 0)
3201             /* has nontrivial amt of data */
3202             afs_indexFlags[index] |= IFEverUsed;
3203         afs_stats_cmperf.cacheFilesReused++;
3204         /*
3205          * Initialize index times to file's mod times; init indexCounter
3206          * to max thereof
3207          */
3208         hset32(afs_indexTimes[index], tstat.atime);
3209         if (hgetlo(afs_indexCounter) < tstat.atime) {
3210             hset32(afs_indexCounter, tstat.atime);
3211         }
3212         afs_indexUnique[index] = tdc->f.fid.Fid.Unique;
3213     }                           /*File is not bad */
3214
3215     if (tfile)
3216         osi_UFSClose(tfile);
3217     tdc->f.states &= ~DWriting;
3218     tdc->dflags &= ~DFEntryMod;
3219     /* don't set f.modTime; we're just cleaning up */
3220     osi_Assert(afs_WriteDCache(tdc, 0) == 0);
3221     ReleaseWriteLock(&afs_xdcache);
3222     ReleaseWriteLock(&tdc->lock);
3223     afs_PutDCache(tdc);
3224     afs_stats_cmperf.cacheNumEntries++;
3225     return 0;
3226 }
3227
3228
3229 /*Max # of struct dcache's resident at any time*/
3230 /*
3231  * If 'dchint' is enabled then in-memory dcache min is increased because of
3232  * crashes...
3233  */
3234 #define DDSIZE 200
3235
3236 /*!
3237  * Initialize dcache related variables.
3238  *
3239  * \param afiles
3240  * \param ablocks
3241  * \param aDentries
3242  * \param achunk
3243  * \param aflags
3244  *
3245  */
3246 void
3247 afs_dcacheInit(int afiles, int ablocks, int aDentries, int achunk, int aflags)
3248 {
3249     struct dcache *tdp;
3250     int i;
3251     int code;
3252
3253     afs_freeDCList = NULLIDX;
3254     afs_discardDCList = NULLIDX;
3255     afs_freeDCCount = 0;
3256     afs_freeDSList = NULL;
3257     hzero(afs_indexCounter);
3258
3259     LOCK_INIT(&afs_xdcache, "afs_xdcache");
3260
3261     /*
3262      * Set chunk size
3263      */
3264     if (achunk) {
3265         if (achunk < 0 || achunk > 30)
3266             achunk = 13;        /* Use default */
3267         AFS_SETCHUNKSIZE(achunk);
3268     }
3269
3270     if (!aDentries)
3271         aDentries = DDSIZE;
3272
3273     if (aDentries > 512)
3274         afs_dhashsize = 2048;
3275     /* initialize hash tables */
3276     afs_dvhashTbl = afs_osi_Alloc(afs_dhashsize * sizeof(afs_int32));
3277     osi_Assert(afs_dvhashTbl != NULL);
3278     afs_dchashTbl = afs_osi_Alloc(afs_dhashsize * sizeof(afs_int32));
3279     osi_Assert(afs_dchashTbl != NULL);
3280     for (i = 0; i < afs_dhashsize; i++) {
3281         afs_dvhashTbl[i] = NULLIDX;
3282         afs_dchashTbl[i] = NULLIDX;
3283     }
3284     afs_dvnextTbl = afs_osi_Alloc(afiles * sizeof(afs_int32));
3285     osi_Assert(afs_dvnextTbl != NULL);
3286     afs_dcnextTbl = afs_osi_Alloc(afiles * sizeof(afs_int32));
3287     osi_Assert(afs_dcnextTbl != NULL);
3288     for (i = 0; i < afiles; i++) {
3289         afs_dvnextTbl[i] = NULLIDX;
3290         afs_dcnextTbl[i] = NULLIDX;
3291     }
3292
3293     /* Allocate and zero the pointer array to the dcache entries */
3294     afs_indexTable = afs_osi_Alloc(sizeof(struct dcache *) * afiles);
3295     osi_Assert(afs_indexTable != NULL);
3296     memset(afs_indexTable, 0, sizeof(struct dcache *) * afiles);
3297     afs_indexTimes = afs_osi_Alloc(afiles * sizeof(afs_hyper_t));
3298     osi_Assert(afs_indexTimes != NULL);
3299     memset(afs_indexTimes, 0, afiles * sizeof(afs_hyper_t));
3300     afs_indexUnique = afs_osi_Alloc(afiles * sizeof(afs_uint32));
3301     osi_Assert(afs_indexUnique != NULL);
3302     memset(afs_indexUnique, 0, afiles * sizeof(afs_uint32));
3303     afs_indexFlags = afs_osi_Alloc(afiles * sizeof(u_char));
3304     osi_Assert(afs_indexFlags != NULL);
3305     memset(afs_indexFlags, 0, afiles * sizeof(char));
3306
3307     /* Allocate and thread the struct dcache entries themselves */
3308     tdp = afs_Initial_freeDSList =
3309         afs_osi_Alloc(aDentries * sizeof(struct dcache));
3310     osi_Assert(tdp != NULL);
3311     memset(tdp, 0, aDentries * sizeof(struct dcache));
3312 #ifdef  KERNEL_HAVE_PIN
3313     pin((char *)afs_indexTable, sizeof(struct dcache *) * afiles);      /* XXX */
3314     pin((char *)afs_indexTimes, sizeof(afs_hyper_t) * afiles);  /* XXX */
3315     pin((char *)afs_indexFlags, sizeof(char) * afiles); /* XXX */
3316     pin((char *)afs_indexUnique, sizeof(afs_int32) * afiles);   /* XXX */
3317     pin((char *)tdp, aDentries * sizeof(struct dcache));        /* XXX */
3318     pin((char *)afs_dvhashTbl, sizeof(afs_int32) * afs_dhashsize);      /* XXX */
3319     pin((char *)afs_dchashTbl, sizeof(afs_int32) * afs_dhashsize);      /* XXX */
3320     pin((char *)afs_dcnextTbl, sizeof(afs_int32) * afiles);     /* XXX */
3321     pin((char *)afs_dvnextTbl, sizeof(afs_int32) * afiles);     /* XXX */
3322 #endif
3323
3324     afs_freeDSList = &tdp[0];
3325     for (i = 0; i < aDentries - 1; i++) {
3326         tdp[i].lruq.next = (struct afs_q *)(&tdp[i + 1]);
3327         AFS_RWLOCK_INIT(&tdp[i].lock, "dcache lock");
3328         AFS_RWLOCK_INIT(&tdp[i].tlock, "dcache tlock");
3329         AFS_RWLOCK_INIT(&tdp[i].mflock, "dcache flock");
3330     }
3331     tdp[aDentries - 1].lruq.next = (struct afs_q *)0;
3332     AFS_RWLOCK_INIT(&tdp[aDentries - 1].lock, "dcache lock");
3333     AFS_RWLOCK_INIT(&tdp[aDentries - 1].tlock, "dcache tlock");
3334     AFS_RWLOCK_INIT(&tdp[aDentries - 1].mflock, "dcache flock");
3335
3336     afs_stats_cmperf.cacheBlocksOrig = afs_stats_cmperf.cacheBlocksTotal =
3337         afs_cacheBlocks = ablocks;
3338     afs_ComputeCacheParms();    /* compute parms based on cache size */
3339
3340     afs_dcentries = aDentries;
3341     afs_blocksUsed = 0;
3342     afs_stats_cmperf.cacheBucket0_Discarded =
3343         afs_stats_cmperf.cacheBucket1_Discarded =
3344         afs_stats_cmperf.cacheBucket2_Discarded = 0;
3345     afs_DCSizeInit();
3346     QInit(&afs_DLRU);
3347
3348     if (aflags & AFSCALL_INIT_MEMCACHE) {
3349         /*
3350          * Use a memory cache instead of a disk cache
3351          */
3352         cacheDiskType = AFS_FCACHE_TYPE_MEM;
3353         afs_cacheType = &afs_MemCacheOps;
3354         afiles = (afiles < aDentries) ? afiles : aDentries;     /* min */
3355         ablocks = afiles * (AFS_FIRSTCSIZE / 1024);
3356         /* ablocks is reported in 1K blocks */
3357         code = afs_InitMemCache(afiles, AFS_FIRSTCSIZE, aflags);
3358         if (code != 0) {
3359             afs_warn("afsd: memory cache too large for available memory.\n");
3360             afs_warn("afsd: AFS files cannot be accessed.\n\n");
3361             dcacheDisabled = 1;
3362         } else
3363             afs_warn("Memory cache: Allocating %d dcache entries...",
3364                    aDentries);
3365     } else {
3366         cacheDiskType = AFS_FCACHE_TYPE_UFS;
3367         afs_cacheType = &afs_UfsCacheOps;
3368     }
3369 }
3370
3371 /*!
3372  * Shuts down the cache.
3373  *
3374  */
3375 void
3376 shutdown_dcache(void)
3377 {
3378     int i;
3379
3380 #ifdef AFS_CACHE_VNODE_PATH
3381     if (cacheDiskType != AFS_FCACHE_TYPE_MEM) {
3382         struct dcache *tdc;
3383         for (i = 0; i < afs_cacheFiles; i++) {
3384             tdc = afs_indexTable[i];
3385             if (tdc) {
3386                 afs_osi_FreeStr(tdc->f.inode.ufs);
3387             }
3388         }
3389     }
3390 #endif
3391
3392     afs_osi_Free(afs_dvnextTbl, afs_cacheFiles * sizeof(afs_int32));
3393     afs_osi_Free(afs_dcnextTbl, afs_cacheFiles * sizeof(afs_int32));
3394     afs_osi_Free(afs_indexTable, afs_cacheFiles * sizeof(struct dcache *));
3395     afs_osi_Free(afs_indexTimes, afs_cacheFiles * sizeof(afs_hyper_t));
3396     afs_osi_Free(afs_indexUnique, afs_cacheFiles * sizeof(afs_uint32));
3397     afs_osi_Free(afs_indexFlags, afs_cacheFiles * sizeof(u_char));
3398     afs_osi_Free(afs_Initial_freeDSList,
3399                  afs_dcentries * sizeof(struct dcache));
3400 #ifdef  KERNEL_HAVE_PIN
3401     unpin((char *)afs_dcnextTbl, afs_cacheFiles * sizeof(afs_int32));
3402     unpin((char *)afs_dvnextTbl, afs_cacheFiles * sizeof(afs_int32));
3403     unpin((char *)afs_indexTable, afs_cacheFiles * sizeof(struct dcache *));
3404     unpin((char *)afs_indexTimes, afs_cacheFiles * sizeof(afs_hyper_t));
3405     unpin((char *)afs_indexUnique, afs_cacheFiles * sizeof(afs_uint32));
3406     unpin((u_char *) afs_indexFlags, afs_cacheFiles * sizeof(u_char));
3407     unpin(afs_Initial_freeDSList, afs_dcentries * sizeof(struct dcache));
3408 #endif
3409
3410
3411     for (i = 0; i < afs_dhashsize; i++) {
3412         afs_dvhashTbl[i] = NULLIDX;
3413         afs_dchashTbl[i] = NULLIDX;
3414     }
3415
3416     afs_osi_Free(afs_dvhashTbl, afs_dhashsize * sizeof(afs_int32));
3417     afs_osi_Free(afs_dchashTbl, afs_dhashsize * sizeof(afs_int32));
3418
3419     afs_blocksUsed = afs_dcentries = 0;
3420     afs_stats_cmperf.cacheBucket0_Discarded =
3421         afs_stats_cmperf.cacheBucket1_Discarded =
3422         afs_stats_cmperf.cacheBucket2_Discarded = 0;
3423     hzero(afs_indexCounter);
3424
3425     afs_freeDCCount = 0;
3426     afs_freeDCList = NULLIDX;
3427     afs_discardDCList = NULLIDX;
3428     afs_freeDSList = afs_Initial_freeDSList = 0;
3429
3430     LOCK_INIT(&afs_xdcache, "afs_xdcache");
3431     QInit(&afs_DLRU);
3432
3433 }
3434
3435 /*!
3436  * Get a dcache ready for writing, respecting the current cache size limits
3437  *
3438  * len is required because afs_GetDCache with flag == 4 expects the length
3439  * field to be filled. It decides from this whether it's necessary to fetch
3440  * data into the chunk before writing or not (when the whole chunk is
3441  * overwritten!).
3442  *
3443  * \param avc           The vcache to fetch a dcache for
3444  * \param filePos       The start of the section to be written
3445  * \param len           The length of the section to be written
3446  * \param areq
3447  * \param noLock
3448  *
3449  * \return If successful, a reference counted dcache with tdc->lock held. Lock
3450  *         must be released and afs_PutDCache() called to free dcache.
3451  *         NULL on  failure
3452  *
3453  * \note avc->lock must be held on entry. Function may release and reobtain
3454  *       avc->lock and GLOCK.
3455  */
3456
3457 struct dcache *
3458 afs_ObtainDCacheForWriting(struct vcache *avc, afs_size_t filePos,
3459                            afs_size_t len, struct vrequest *areq,
3460                            int noLock)
3461 {
3462     struct dcache *tdc = NULL;
3463     afs_size_t offset;
3464
3465     /* read the cached info */
3466     if (noLock) {
3467         tdc = afs_FindDCache(avc, filePos);
3468         if (tdc)
3469             ObtainWriteLock(&tdc->lock, 657);
3470     } else if (afs_blocksUsed >
3471                PERCENT(CM_WAITFORDRAINPCT, afs_cacheBlocks)) {
3472         tdc = afs_FindDCache(avc, filePos);
3473         if (tdc) {
3474             ObtainWriteLock(&tdc->lock, 658);
3475             if (!hsame(tdc->f.versionNo, avc->f.m.DataVersion)
3476                 || (tdc->dflags & DFFetching)) {
3477                 ReleaseWriteLock(&tdc->lock);
3478                 afs_PutDCache(tdc);
3479                 tdc = NULL;
3480             }
3481         }
3482         if (!tdc) {
3483             afs_MaybeWakeupTruncateDaemon();
3484             while (afs_blocksUsed >
3485                    PERCENT(CM_WAITFORDRAINPCT, afs_cacheBlocks)) {
3486                 ReleaseWriteLock(&avc->lock);
3487                 if (afs_blocksUsed - afs_blocksDiscarded >
3488                     PERCENT(CM_WAITFORDRAINPCT, afs_cacheBlocks)) {
3489                     afs_WaitForCacheDrain = 1;
3490                     afs_osi_Sleep(&afs_WaitForCacheDrain);
3491                 }
3492                 afs_MaybeFreeDiscardedDCache();
3493                 afs_MaybeWakeupTruncateDaemon();
3494                 ObtainWriteLock(&avc->lock, 509);
3495             }
3496             avc->f.states |= CDirty;
3497             tdc = afs_GetDCache(avc, filePos, areq, &offset, &len, 4);
3498             if (tdc)
3499                 ObtainWriteLock(&tdc->lock, 659);
3500         }
3501     } else {
3502         tdc = afs_GetDCache(avc, filePos, areq, &offset, &len, 4);
3503         if (tdc)
3504             ObtainWriteLock(&tdc->lock, 660);
3505     }
3506     if (tdc) {
3507         if (!(afs_indexFlags[tdc->index] & IFDataMod)) {
3508             afs_stats_cmperf.cacheCurrDirtyChunks++;
3509             afs_indexFlags[tdc->index] |= IFDataMod;    /* so it doesn't disappear */
3510         }
3511         if (!(tdc->f.states & DWriting)) {
3512             /* don't mark entry as mod if we don't have to */
3513             tdc->f.states |= DWriting;
3514             tdc->dflags |= DFEntryMod;
3515         }
3516     }
3517     return tdc;
3518 }
3519
3520 /*!
3521  * Make a shadow copy of a dir's dcache. It's used for disconnected
3522  * operations like remove/create/rename to keep the original directory data.
3523  * On reconnection, we can diff the original data with the server and get the
3524  * server changes and with the local data to get the local changes.
3525  *
3526  * \param avc The dir vnode.
3527  * \param adc The dir dcache.
3528  *
3529  * \return 0 for success.
3530  *
3531  * \note The vcache entry must be write locked.
3532  * \note The dcache entry must be read locked.
3533  */
3534 int
3535 afs_MakeShadowDir(struct vcache *avc, struct dcache *adc)
3536 {
3537     int i, code, ret_code = 0, written, trans_size;
3538     struct dcache *new_dc = NULL;
3539     struct osi_file *tfile_src, *tfile_dst;
3540     struct VenusFid shadow_fid;
3541     char *data;
3542
3543     /* Is this a dir? */
3544     if (vType(avc) != VDIR)
3545         return ENOTDIR;
3546
3547     if (avc->f.shadow.vnode || avc->f.shadow.unique)
3548         return EEXIST;
3549
3550     /* Generate a fid for the shadow dir. */
3551     shadow_fid.Cell = avc->f.fid.Cell;
3552     shadow_fid.Fid.Volume = avc->f.fid.Fid.Volume;
3553     afs_GenShadowFid(&shadow_fid);
3554
3555     ObtainWriteLock(&afs_xdcache, 716);
3556
3557     /* Get a fresh dcache. */
3558     new_dc = afs_AllocDCache(avc, 0, 0, &shadow_fid);
3559     osi_Assert(new_dc);