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