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