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