afs_AllocDCache: return NULL instead of panic
[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  * Get a dcache entry from the discard or free list
1071  *
1072  * @param[in] indexp  A pointer to the head of the dcache free list or discard
1073  *                    list (afs_freeDCList, or afs_discardDCList)
1074  *
1075  * @return A dcache from that list, or NULL if none could be retrieved.
1076  *
1077  * @pre afs_xdcache is write-locked
1078  */
1079 static struct dcache *
1080 afs_GetDSlotFromList(afs_int32 *indexp)
1081 {
1082     struct dcache *tdc;
1083
1084     for ( ; *indexp != NULLIDX; indexp = &afs_dvnextTbl[*indexp]) {
1085         tdc = afs_GetUnusedDSlot(*indexp);
1086         if (tdc) {
1087             osi_Assert(tdc->refCount == 1);
1088             ReleaseReadLock(&tdc->tlock);
1089             *indexp = afs_dvnextTbl[tdc->index];
1090             afs_dvnextTbl[tdc->index] = NULLIDX;
1091             return tdc;
1092         }
1093     }
1094     return NULL;
1095 }
1096
1097 /*!
1098  * Free the next element on the list of discarded cache elements.
1099  */
1100 static void
1101 afs_FreeDiscardedDCache(void)
1102 {
1103     struct dcache *tdc;
1104     struct osi_file *tfile;
1105     afs_int32 size;
1106
1107     AFS_STATCNT(afs_FreeDiscardedDCache);
1108
1109     ObtainWriteLock(&afs_xdcache, 510);
1110     if (!afs_blocksDiscarded) {
1111         ReleaseWriteLock(&afs_xdcache);
1112         return;
1113     }
1114
1115     /*
1116      * Get an entry from the list of discarded cache elements
1117      */
1118     tdc = afs_GetDSlotFromList(&afs_discardDCList);
1119     osi_Assert(tdc);
1120
1121     afs_discardDCCount--;
1122     size = ((tdc->f.chunkBytes + afs_fsfragsize) ^ afs_fsfragsize) >> 10;       /* round up */
1123     afs_blocksDiscarded -= size;
1124     afs_stats_cmperf.cacheBlocksDiscarded = afs_blocksDiscarded;
1125     /* We can lock because we just took it off the free list */
1126     ObtainWriteLock(&tdc->lock, 626);
1127     ReleaseWriteLock(&afs_xdcache);
1128
1129     /*
1130      * Truncate the element to reclaim its space
1131      */
1132     tfile = afs_CFileOpen(&tdc->f.inode);
1133     afs_CFileTruncate(tfile, 0);
1134     afs_CFileClose(tfile);
1135     afs_AdjustSize(tdc, 0);
1136     afs_DCMoveBucket(tdc, 0, 0);
1137
1138     /*
1139      * Free the element we just truncated
1140      */
1141     ObtainWriteLock(&afs_xdcache, 511);
1142     afs_indexFlags[tdc->index] &= ~IFDiscarded;
1143     afs_FreeDCache(tdc);
1144     tdc->f.states &= ~(DRO|DBackup|DRW);
1145     ReleaseWriteLock(&tdc->lock);
1146     afs_PutDCache(tdc);
1147     ReleaseWriteLock(&afs_xdcache);
1148 }
1149
1150 /*!
1151  * Free as many entries from the list of discarded cache elements
1152  * as we need to get the free space down below CM_WAITFORDRAINPCT (98%).
1153  *
1154  * \return 0
1155  */
1156 int
1157 afs_MaybeFreeDiscardedDCache(void)
1158 {
1159
1160     AFS_STATCNT(afs_MaybeFreeDiscardedDCache);
1161
1162     while (afs_blocksDiscarded
1163            && (afs_blocksUsed >
1164                PERCENT(CM_WAITFORDRAINPCT, afs_cacheBlocks))) {
1165         afs_FreeDiscardedDCache();
1166     }
1167     return 0;
1168 }
1169
1170 /*!
1171  * Try to free up a certain number of disk slots.
1172  *
1173  * \param anumber Targeted number of disk slots to free up.
1174  *
1175  * \note Environment:
1176  *      Must be called with afs_xdcache write-locked.
1177  *
1178  */
1179 static void
1180 afs_GetDownDSlot(int anumber)
1181 {
1182     struct afs_q *tq, *nq;
1183     struct dcache *tdc;
1184     int ix;
1185     unsigned int cnt;
1186
1187     AFS_STATCNT(afs_GetDownDSlot);
1188     if (cacheDiskType == AFS_FCACHE_TYPE_MEM)
1189         osi_Panic("diskless getdowndslot");
1190
1191     if (CheckLock(&afs_xdcache) != -1)
1192         osi_Panic("getdowndslot nolock");
1193
1194     /* decrement anumber first for all dudes in free list */
1195     for (tdc = afs_freeDSList; tdc; tdc = (struct dcache *)tdc->lruq.next)
1196         anumber--;
1197     if (anumber <= 0)
1198         return;                 /* enough already free */
1199
1200     for (cnt = 0, tq = afs_DLRU.prev; tq != &afs_DLRU && anumber > 0;
1201          tq = nq, cnt++) {
1202         tdc = (struct dcache *)tq;      /* q is first elt in dcache entry */
1203         nq = QPrev(tq);         /* in case we remove it */
1204         if (tdc->refCount == 0) {
1205             if ((ix = tdc->index) == NULLIDX)
1206                 osi_Panic("getdowndslot");
1207             /* pull the entry out of the lruq and put it on the free list */
1208             QRemove(&tdc->lruq);
1209
1210             /* write-through if modified */
1211             if (tdc->dflags & DFEntryMod) {
1212 #if defined(AFS_SGI_ENV) && defined(AFS_SGI_SHORTSTACK)
1213                 /*
1214                  * ask proxy to do this for us - we don't have the stack space
1215                  */
1216                 while (tdc->dflags & DFEntryMod) {
1217                     int s;
1218                     AFS_GUNLOCK();
1219                     s = SPLOCK(afs_sgibklock);
1220                     if (afs_sgibklist == NULL) {
1221                         /* if slot is free, grab it. */
1222                         afs_sgibklist = tdc;
1223                         SV_SIGNAL(&afs_sgibksync);
1224                     }
1225                     /* wait for daemon to (start, then) finish. */
1226                     SP_WAIT(afs_sgibklock, s, &afs_sgibkwait, PINOD);
1227                     AFS_GLOCK();
1228                 }
1229 #else
1230                 tdc->dflags &= ~DFEntryMod;
1231                 osi_Assert(afs_WriteDCache(tdc, 1) == 0);
1232 #endif
1233             }
1234
1235             /* finally put the entry in the free list */
1236             afs_indexTable[ix] = NULL;
1237             afs_indexFlags[ix] &= ~IFEverUsed;
1238             tdc->index = NULLIDX;
1239             tdc->lruq.next = (struct afs_q *)afs_freeDSList;
1240             afs_freeDSList = tdc;
1241             anumber--;
1242         }
1243     }
1244 }                               /*afs_GetDownDSlot */
1245
1246
1247 /*
1248  * afs_RefDCache
1249  *
1250  * Description:
1251  *      Increment the reference count on a disk cache entry,
1252  *      which already has a non-zero refcount.  In order to
1253  *      increment the refcount of a zero-reference entry, you
1254  *      have to hold afs_xdcache.
1255  *
1256  * Parameters:
1257  *      adc : Pointer to the dcache entry to increment.
1258  *
1259  * Environment:
1260  *      Nothing interesting.
1261  */
1262 int
1263 afs_RefDCache(struct dcache *adc)
1264 {
1265     ObtainWriteLock(&adc->tlock, 627);
1266     if (adc->refCount < 0)
1267         osi_Panic("RefDCache: negative refcount");
1268     adc->refCount++;
1269     ReleaseWriteLock(&adc->tlock);
1270     return 0;
1271 }
1272
1273
1274 /*
1275  * afs_PutDCache
1276  *
1277  * Description:
1278  *      Decrement the reference count on a disk cache entry.
1279  *
1280  * Parameters:
1281  *      ad : Ptr to the dcache entry to decrement.
1282  *
1283  * Environment:
1284  *      Nothing interesting.
1285  */
1286 int
1287 afs_PutDCache(struct dcache *adc)
1288 {
1289     AFS_STATCNT(afs_PutDCache);
1290     ObtainWriteLock(&adc->tlock, 276);
1291     if (adc->refCount <= 0)
1292         osi_Panic("putdcache");
1293     --adc->refCount;
1294     ReleaseWriteLock(&adc->tlock);
1295     return 0;
1296 }
1297
1298
1299 /*
1300  * afs_TryToSmush
1301  *
1302  * Description:
1303  *      Try to discard all data associated with this file from the
1304  *      cache.
1305  *
1306  * Parameters:
1307  *      avc : Pointer to the cache info for the file.
1308  *
1309  * Environment:
1310  *      Both pvnLock and lock are write held.
1311  */
1312 void
1313 afs_TryToSmush(struct vcache *avc, afs_ucred_t *acred, int sync)
1314 {
1315     struct dcache *tdc;
1316     int index;
1317     int i;
1318     AFS_STATCNT(afs_TryToSmush);
1319     afs_Trace2(afs_iclSetp, CM_TRACE_TRYTOSMUSH, ICL_TYPE_POINTER, avc,
1320                ICL_TYPE_OFFSET, ICL_HANDLE_OFFSET(avc->f.m.Length));
1321     sync = 1;                   /* XX Temp testing XX */
1322
1323 #if     defined(AFS_SUN5_ENV)
1324     ObtainWriteLock(&avc->vlock, 573);
1325     avc->activeV++;             /* block new getpages */
1326     ReleaseWriteLock(&avc->vlock);
1327 #endif
1328
1329     /* Flush VM pages */
1330     osi_VM_TryToSmush(avc, acred, sync);
1331
1332     /*
1333      * Get the hash chain containing all dce's for this fid
1334      */
1335     i = DVHash(&avc->f.fid);
1336     ObtainWriteLock(&afs_xdcache, 277);
1337     for (index = afs_dvhashTbl[i]; index != NULLIDX; index = i) {
1338         i = afs_dvnextTbl[index];       /* next pointer this hash table */
1339         if (afs_indexUnique[index] == avc->f.fid.Fid.Unique) {
1340             int releaseTlock = 1;
1341             tdc = afs_GetValidDSlot(index);
1342             if (!tdc) {
1343                 /* afs_TryToSmush is best-effort; we may not actually discard
1344                  * everything, so failure to discard a dcache due to an i/o
1345                  * error is okay. */
1346                 continue;
1347             }
1348             if (!FidCmp(&tdc->f.fid, &avc->f.fid)) {
1349                 if (sync) {
1350                     if ((afs_indexFlags[index] & IFDataMod) == 0
1351                         && tdc->refCount == 1) {
1352                         ReleaseReadLock(&tdc->tlock);
1353                         releaseTlock = 0;
1354                         afs_FlushDCache(tdc);
1355                     }
1356                 } else
1357                     afs_indexTable[index] = 0;
1358             }
1359             if (releaseTlock)
1360                 ReleaseReadLock(&tdc->tlock);
1361             afs_PutDCache(tdc);
1362         }
1363     }
1364 #if     defined(AFS_SUN5_ENV)
1365     ObtainWriteLock(&avc->vlock, 545);
1366     if (--avc->activeV == 0 && (avc->vstates & VRevokeWait)) {
1367         avc->vstates &= ~VRevokeWait;
1368         afs_osi_Wakeup((char *)&avc->vstates);
1369     }
1370     ReleaseWriteLock(&avc->vlock);
1371 #endif
1372     ReleaseWriteLock(&afs_xdcache);
1373     /*
1374      * It's treated like a callback so that when we do lookups we'll
1375      * invalidate the unique bit if any
1376      * trytoSmush occured during the lookup call
1377      */
1378     afs_allCBs++;
1379 }
1380
1381 /*
1382  * afs_DCacheMissingChunks
1383  *
1384  * Description
1385  *      Given the cached info for a file, return the number of chunks that
1386  *      are not available from the dcache.
1387  *
1388  * Parameters:
1389  *      avc:    Pointer to the (held) vcache entry to look in.
1390  *
1391  * Returns:
1392  *      The number of chunks which are not currently cached.
1393  *
1394  * Environment:
1395  *      The vcache entry is held upon entry.
1396  */
1397
1398 int
1399 afs_DCacheMissingChunks(struct vcache *avc)
1400 {
1401     int i, index;
1402     afs_size_t totalLength = 0;
1403     afs_uint32 totalChunks = 0;
1404     struct dcache *tdc;
1405
1406     totalLength = avc->f.m.Length;
1407     if (avc->f.truncPos < totalLength)
1408         totalLength = avc->f.truncPos;
1409
1410     /* Length is 0, no chunk missing. */
1411     if (totalLength == 0)
1412         return 0;
1413
1414     /* If totalLength is a multiple of chunksize, the last byte appears
1415      * as being part of the next chunk, which does not exist.
1416      * Decrementing totalLength by one fixes that.
1417      */
1418     totalLength--;
1419     totalChunks = (AFS_CHUNK(totalLength) + 1);
1420
1421     /* If we're a directory, we only ever have one chunk, regardless of
1422      * the size of the dir.
1423      */
1424     if (avc->f.fid.Fid.Vnode & 1 || vType(avc) == VDIR)
1425         totalChunks = 1;
1426
1427     /*
1428      printf("Should have %d chunks for %u bytes\n",
1429                 totalChunks, (totalLength + 1));
1430     */
1431     i = DVHash(&avc->f.fid);
1432     ObtainWriteLock(&afs_xdcache, 1001);
1433     for (index = afs_dvhashTbl[i]; index != NULLIDX; index = i) {
1434         i = afs_dvnextTbl[index];
1435         if (afs_indexUnique[index] == avc->f.fid.Fid.Unique) {
1436             tdc = afs_GetValidDSlot(index);
1437             if (tdc) {
1438                 if (!FidCmp(&tdc->f.fid, &avc->f.fid)) {
1439                     totalChunks--;
1440                 }
1441                 ReleaseReadLock(&tdc->tlock);
1442                 afs_PutDCache(tdc);
1443             }
1444         }
1445     }
1446     ReleaseWriteLock(&afs_xdcache);
1447
1448     /*printf("Missing %d chunks\n", totalChunks);*/
1449
1450     return (totalChunks);
1451 }
1452
1453 /*
1454  * afs_FindDCache
1455  *
1456  * Description:
1457  *      Given the cached info for a file and a byte offset into the
1458  *      file, make sure the dcache entry for that file and containing
1459  *      the given byte is available, returning it to our caller.
1460  *
1461  * Parameters:
1462  *      avc   : Pointer to the (held) vcache entry to look in.
1463  *      abyte : Which byte we want to get to.
1464  *
1465  * Returns:
1466  *      Pointer to the dcache entry covering the file & desired byte,
1467  *      or NULL if not found.
1468  *
1469  * Environment:
1470  *      The vcache entry is held upon entry.
1471  */
1472
1473 struct dcache *
1474 afs_FindDCache(struct vcache *avc, afs_size_t abyte)
1475 {
1476     afs_int32 chunk;
1477     afs_int32 i, index;
1478     struct dcache *tdc = NULL;
1479
1480     AFS_STATCNT(afs_FindDCache);
1481     chunk = AFS_CHUNK(abyte);
1482
1483     /*
1484      * Hash on the [fid, chunk] and get the corresponding dcache index
1485      * after write-locking the dcache.
1486      */
1487     i = DCHash(&avc->f.fid, chunk);
1488     ObtainWriteLock(&afs_xdcache, 278);
1489     for (index = afs_dchashTbl[i]; index != NULLIDX; index = afs_dcnextTbl[index]) {
1490         if (afs_indexUnique[index] == avc->f.fid.Fid.Unique) {
1491             tdc = afs_GetValidDSlot(index);
1492             if (!tdc) {
1493                 /* afs_FindDCache is best-effort; we may not find the given
1494                  * file/offset, so if we cannot find the given dcache due to
1495                  * i/o errors, that is okay. */
1496                 continue;
1497             }
1498             ReleaseReadLock(&tdc->tlock);
1499             if (!FidCmp(&tdc->f.fid, &avc->f.fid) && chunk == tdc->f.chunk) {
1500                 break;          /* leaving refCount high for caller */
1501             }
1502             afs_PutDCache(tdc);
1503         }
1504     }
1505     if (index != NULLIDX) {
1506         hset(afs_indexTimes[tdc->index], afs_indexCounter);
1507         hadd32(afs_indexCounter, 1);
1508         ReleaseWriteLock(&afs_xdcache);
1509         return tdc;
1510     }
1511     ReleaseWriteLock(&afs_xdcache);
1512     return NULL;
1513 }                               /*afs_FindDCache */
1514
1515 /* only call these from afs_AllocDCache() */
1516 static struct dcache *
1517 afs_AllocFreeDSlot(void)
1518 {
1519     struct dcache *tdc;
1520
1521     tdc = afs_GetDSlotFromList(&afs_freeDCList);
1522     if (!tdc) {
1523         return NULL;
1524     }
1525     afs_indexFlags[tdc->index] &= ~IFFree;
1526     ObtainWriteLock(&tdc->lock, 604);
1527     afs_freeDCCount--;
1528
1529     return tdc;
1530 }
1531 static struct dcache *
1532 afs_AllocDiscardDSlot(afs_int32 lock)
1533 {
1534     struct dcache *tdc;
1535     afs_uint32 size = 0;
1536     struct osi_file *file;
1537
1538     tdc = afs_GetDSlotFromList(&afs_discardDCList);
1539     if (!tdc) {
1540         return NULL;
1541     }
1542     afs_indexFlags[tdc->index] &= ~IFDiscarded;
1543     ObtainWriteLock(&tdc->lock, 605);
1544     afs_discardDCCount--;
1545     size =
1546         ((tdc->f.chunkBytes +
1547           afs_fsfragsize) ^ afs_fsfragsize) >> 10;
1548     tdc->f.states &= ~(DRO|DBackup|DRW);
1549     afs_DCMoveBucket(tdc, size, 0);
1550     afs_blocksDiscarded -= size;
1551     afs_stats_cmperf.cacheBlocksDiscarded = afs_blocksDiscarded;
1552     if ((lock & 2)) {
1553         /* Truncate the chunk so zeroes get filled properly */
1554         file = afs_CFileOpen(&tdc->f.inode);
1555         afs_CFileTruncate(file, 0);
1556         afs_CFileClose(file);
1557         afs_AdjustSize(tdc, 0);
1558     }
1559
1560     return tdc;
1561 }
1562
1563 /*!
1564  * Get a fresh dcache from the free or discarded list.
1565  *
1566  * \param avc Who's dcache is this going to be?
1567  * \param chunk The position where it will be placed in.
1568  * \param lock How are locks held.
1569  * \param ashFid If this dcache going to be used for a shadow dir,
1570  *              this is it's fid.
1571  *
1572  * \note Required locks:
1573  *      - afs_xdcache (W)
1574  *      - avc (R if (lock & 1) set and W otherwise)
1575  * \note It write locks the new dcache. The caller must unlock it.
1576  *
1577  * \return The new dcache.
1578  */
1579 struct dcache *
1580 afs_AllocDCache(struct vcache *avc, afs_int32 chunk, afs_int32 lock,
1581                 struct VenusFid *ashFid)
1582 {
1583     struct dcache *tdc = NULL;
1584
1585     /* if (lock & 2), prefer 'free' dcaches; otherwise, prefer 'discard'
1586      * dcaches. In either case, try both if our first choice doesn't work. */
1587     if ((lock & 2)) {
1588         tdc = afs_AllocFreeDSlot();
1589         if (!tdc) {
1590             tdc = afs_AllocDiscardDSlot(lock);
1591         }
1592     } else {
1593         tdc = afs_AllocDiscardDSlot(lock);
1594         if (!tdc) {
1595             tdc = afs_AllocFreeDSlot();
1596         }
1597     }
1598     if (!tdc) {
1599         return NULL;
1600     }
1601
1602     /*
1603      * Locks held:
1604      * avc->lock(R) if setLocks
1605      * avc->lock(W) if !setLocks
1606      * tdc->lock(W)
1607      * afs_xdcache(W)
1608      */
1609
1610     /*
1611      * Fill in the newly-allocated dcache record.
1612      */
1613     afs_indexFlags[tdc->index] &= ~(IFDirtyPages | IFAnyPages);
1614     if (ashFid)
1615         /* Use shadow fid if provided. */
1616         tdc->f.fid = *ashFid;
1617     else
1618         /* Use normal vcache's fid otherwise. */
1619         tdc->f.fid = avc->f.fid;
1620     if (avc->f.states & CRO)
1621         tdc->f.states = DRO;
1622     else if (avc->f.states & CBackup)
1623         tdc->f.states = DBackup;
1624     else
1625         tdc->f.states = DRW;
1626     afs_DCMoveBucket(tdc, 0, afs_DCGetBucket(avc));
1627     afs_indexUnique[tdc->index] = tdc->f.fid.Fid.Unique;
1628     if (!ashFid)
1629         hones(tdc->f.versionNo);        /* invalid value */
1630     tdc->f.chunk = chunk;
1631     tdc->validPos = AFS_CHUNKTOBASE(chunk);
1632     /* XXX */
1633     if (tdc->lruq.prev == &tdc->lruq)
1634         osi_Panic("lruq 1");
1635
1636     return tdc;
1637 }
1638
1639 /*
1640  * afs_GetDCache
1641  *
1642  * Description:
1643  *      This function is called to obtain a reference to data stored in
1644  *      the disk cache, locating a chunk of data containing the desired
1645  *      byte and returning a reference to the disk cache entry, with its
1646  *      reference count incremented.
1647  *
1648  * Parameters:
1649  * IN:
1650  *      avc     : Ptr to a vcache entry (unlocked)
1651  *      abyte   : Byte position in the file desired
1652  *      areq    : Request structure identifying the requesting user.
1653  *      aflags  : Settings as follows:
1654  *                      1 : Set locks
1655  *                      2 : Return after creating entry.
1656  *                      4 : called from afs_vnop_write.c
1657  *                          *alen contains length of data to be written.
1658  * OUT:
1659  *      aoffset : Set to the offset within the chunk where the resident
1660  *                byte is located.
1661  *      alen    : Set to the number of bytes of data after the desired
1662  *                byte (including the byte itself) which can be read
1663  *                from this chunk.
1664  *
1665  * Environment:
1666  *      The vcache entry pointed to by avc is unlocked upon entry.
1667  */
1668
1669 /*
1670  * Update the vnode-to-dcache hint if we can get the vnode lock
1671  * right away.  Assumes dcache entry is at least read-locked.
1672  */
1673 void
1674 updateV2DC(int lockVc, struct vcache *v, struct dcache *d, int src)
1675 {
1676     if (!lockVc || 0 == NBObtainWriteLock(&v->lock, src)) {
1677         if (hsame(v->f.m.DataVersion, d->f.versionNo) && v->callback)
1678             v->dchint = d;
1679         if (lockVc)
1680             ReleaseWriteLock(&v->lock);
1681     }
1682 }
1683
1684 /* avc - Write-locked unless aflags & 1 */
1685 struct dcache *
1686 afs_GetDCache(struct vcache *avc, afs_size_t abyte,
1687               struct vrequest *areq, afs_size_t * aoffset,
1688               afs_size_t * alen, int aflags)
1689 {
1690     afs_int32 i, code, shortcut;
1691 #if     defined(AFS_AIX32_ENV) || defined(AFS_SGI_ENV)
1692     afs_int32 adjustsize = 0;
1693 #endif
1694     int setLocks;
1695     afs_int32 index;
1696     afs_int32 us;
1697     afs_int32 chunk;
1698     afs_size_t Position = 0;
1699     afs_int32 size, tlen;       /* size of segment to transfer */
1700     struct afs_FetchOutput *tsmall = 0;
1701     struct dcache *tdc;
1702     struct osi_file *file;
1703     struct afs_conn *tc;
1704     int downDCount = 0;
1705     struct server *newCallback = NULL;
1706     char setNewCallback;
1707     char setVcacheStatus;
1708     char doVcacheUpdate;
1709     char slowPass = 0;
1710     int doAdjustSize = 0;
1711     int doReallyAdjustSize = 0;
1712     int overWriteWholeChunk = 0;
1713     struct rx_connection *rxconn;
1714
1715 #ifndef AFS_NOSTATS
1716     struct afs_stats_AccessInfo *accP;  /*Ptr to access record in stats */
1717     int fromReplica;            /*Are we reading from a replica? */
1718     int numFetchLoops;          /*# times around the fetch/analyze loop */
1719 #endif /* AFS_NOSTATS */
1720
1721     AFS_STATCNT(afs_GetDCache);
1722     if (dcacheDisabled)
1723         return NULL;
1724
1725     setLocks = aflags & 1;
1726
1727     /*
1728      * Determine the chunk number and offset within the chunk corresponding
1729      * to the desired byte.
1730      */
1731     if (avc->f.fid.Fid.Vnode & 1) {     /* if (vType(avc) == VDIR) */
1732         chunk = 0;
1733     } else {
1734         chunk = AFS_CHUNK(abyte);
1735     }
1736
1737     /* come back to here if we waited for the cache to drain. */
1738   RetryGetDCache:
1739
1740     setNewCallback = setVcacheStatus = 0;
1741
1742     if (setLocks) {
1743         if (slowPass)
1744             ObtainWriteLock(&avc->lock, 616);
1745         else
1746             ObtainReadLock(&avc->lock);
1747     }
1748
1749     /*
1750      * Locks held:
1751      * avc->lock(R) if setLocks && !slowPass
1752      * avc->lock(W) if !setLocks || slowPass
1753      */
1754
1755     shortcut = 0;
1756
1757     /* check hints first! (might could use bcmp or some such...) */
1758     if ((tdc = avc->dchint)) {
1759         int dcLocked;
1760
1761         /*
1762          * The locking order between afs_xdcache and dcache lock matters.
1763          * The hint dcache entry could be anywhere, even on the free list.
1764          * Locking afs_xdcache ensures that noone is trying to pull dcache
1765          * entries from the free list, and thereby assuming them to be not
1766          * referenced and not locked.
1767          */
1768         ObtainReadLock(&afs_xdcache);
1769         dcLocked = (0 == NBObtainSharedLock(&tdc->lock, 601));
1770
1771         if (dcLocked && (tdc->index != NULLIDX)
1772             && !FidCmp(&tdc->f.fid, &avc->f.fid) && chunk == tdc->f.chunk
1773             && !(afs_indexFlags[tdc->index] & (IFFree | IFDiscarded))) {
1774             /* got the right one.  It might not be the right version, and it
1775              * might be fetching, but it's the right dcache entry.
1776              */
1777             /* All this code should be integrated better with what follows:
1778              * I can save a good bit more time under a write lock if I do..
1779              */
1780             ObtainWriteLock(&tdc->tlock, 603);
1781             tdc->refCount++;
1782             ReleaseWriteLock(&tdc->tlock);
1783
1784             ReleaseReadLock(&afs_xdcache);
1785             shortcut = 1;
1786
1787             if (hsame(tdc->f.versionNo, avc->f.m.DataVersion)
1788                 && !(tdc->dflags & DFFetching)) {
1789
1790                 afs_stats_cmperf.dcacheHits++;
1791                 ObtainWriteLock(&afs_xdcache, 559);
1792                 QRemove(&tdc->lruq);
1793                 QAdd(&afs_DLRU, &tdc->lruq);
1794                 ReleaseWriteLock(&afs_xdcache);
1795
1796                 /* Locks held:
1797                  * avc->lock(R) if setLocks && !slowPass
1798                  * avc->lock(W) if !setLocks || slowPass
1799                  * tdc->lock(S)
1800                  */
1801                 goto done;
1802             }
1803         } else {
1804             if (dcLocked)
1805                 ReleaseSharedLock(&tdc->lock);
1806             ReleaseReadLock(&afs_xdcache);
1807         }
1808
1809         if (!shortcut)
1810             tdc = 0;
1811     }
1812
1813     /* Locks held:
1814      * avc->lock(R) if setLocks && !slowPass
1815      * avc->lock(W) if !setLocks || slowPass
1816      * tdc->lock(S) if tdc
1817      */
1818
1819     if (!tdc) {                 /* If the hint wasn't the right dcache entry */
1820         int dslot_error = 0;
1821         /*
1822          * Hash on the [fid, chunk] and get the corresponding dcache index
1823          * after write-locking the dcache.
1824          */
1825       RetryLookup:
1826
1827         /* Locks held:
1828          * avc->lock(R) if setLocks && !slowPass
1829          * avc->lock(W) if !setLocks || slowPass
1830          */
1831
1832         i = DCHash(&avc->f.fid, chunk);
1833         /* check to make sure our space is fine */
1834         afs_MaybeWakeupTruncateDaemon();
1835
1836         ObtainWriteLock(&afs_xdcache, 280);
1837         us = NULLIDX;
1838         for (index = afs_dchashTbl[i]; index != NULLIDX; us = index, index = afs_dcnextTbl[index]) {
1839             if (afs_indexUnique[index] == avc->f.fid.Fid.Unique) {
1840                 tdc = afs_GetValidDSlot(index);
1841                 if (!tdc) {
1842                     /* we got an i/o error when trying to get the given dslot,
1843                      * but do not bail out just yet; it is possible the dcache
1844                      * we're looking for is elsewhere, so it doesn't matter if
1845                      * we can't load this one. */
1846                     dslot_error = 1;
1847                     continue;
1848                 }
1849                 ReleaseReadLock(&tdc->tlock);
1850                 /*
1851                  * Locks held:
1852                  * avc->lock(R) if setLocks && !slowPass
1853                  * avc->lock(W) if !setLocks || slowPass
1854                  * afs_xdcache(W)
1855                  */
1856                 if (!FidCmp(&tdc->f.fid, &avc->f.fid) && chunk == tdc->f.chunk) {
1857                     /* Move it up in the beginning of the list */
1858                     if (afs_dchashTbl[i] != index) {
1859                         afs_dcnextTbl[us] = afs_dcnextTbl[index];
1860                         afs_dcnextTbl[index] = afs_dchashTbl[i];
1861                         afs_dchashTbl[i] = index;
1862                     }
1863                     ReleaseWriteLock(&afs_xdcache);
1864                     ObtainSharedLock(&tdc->lock, 606);
1865                     break;      /* leaving refCount high for caller */
1866                 }
1867                 afs_PutDCache(tdc);
1868                 tdc = 0;
1869             }
1870         }
1871
1872         /*
1873          * If we didn't find the entry, we'll create one.
1874          */
1875         if (index == NULLIDX) {
1876             /*
1877              * Locks held:
1878              * avc->lock(R) if setLocks
1879              * avc->lock(W) if !setLocks
1880              * afs_xdcache(W)
1881              */
1882             afs_Trace2(afs_iclSetp, CM_TRACE_GETDCACHE1, ICL_TYPE_POINTER,
1883                        avc, ICL_TYPE_INT32, chunk);
1884
1885             if (dslot_error) {
1886                 /* We couldn't find the dcache we want, but we hit some i/o
1887                  * errors when trying to find it, so we're not sure if the
1888                  * dcache we want is in the cache or not. Error out, so we
1889                  * don't try to possibly create 2 separate dcaches for the
1890                  * same exact data. */
1891                 ReleaseWriteLock(&afs_xdcache);
1892                 goto done;
1893             }
1894
1895             /* Make sure there is a free dcache entry for us to use */
1896             if (afs_discardDCList == NULLIDX && afs_freeDCList == NULLIDX) {
1897                 while (1) {
1898                     if (!setLocks)
1899                         avc->f.states |= CDCLock;
1900                     /* just need slots */
1901                     afs_GetDownD(5, (int *)0, afs_DCGetBucket(avc));
1902                     if (!setLocks)
1903                         avc->f.states &= ~CDCLock;
1904                     if (afs_discardDCList != NULLIDX
1905                         || afs_freeDCList != NULLIDX)
1906                         break;
1907                     /* If we can't get space for 5 mins we give up and panic */
1908                     if (++downDCount > 300) {
1909                         osi_Panic("getdcache");
1910                     }
1911                     ReleaseWriteLock(&afs_xdcache);
1912                     /*
1913                      * Locks held:
1914                      * avc->lock(R) if setLocks
1915                      * avc->lock(W) if !setLocks
1916                      */
1917                     afs_osi_Wait(1000, 0, 0);
1918                     goto RetryLookup;
1919                 }
1920             }
1921
1922             tdc = afs_AllocDCache(avc, chunk, aflags, NULL);
1923             osi_Assert(tdc);
1924
1925             /*
1926              * Now add to the two hash chains - note that i is still set
1927              * from the above DCHash call.
1928              */
1929             afs_dcnextTbl[tdc->index] = afs_dchashTbl[i];
1930             afs_dchashTbl[i] = tdc->index;
1931             i = DVHash(&avc->f.fid);
1932             afs_dvnextTbl[tdc->index] = afs_dvhashTbl[i];
1933             afs_dvhashTbl[i] = tdc->index;
1934             tdc->dflags = DFEntryMod;
1935             tdc->mflags = 0;
1936             afs_MaybeWakeupTruncateDaemon();
1937             ReleaseWriteLock(&afs_xdcache);
1938             ConvertWToSLock(&tdc->lock);
1939         }
1940     }
1941
1942
1943     /* vcache->dcache hint failed */
1944     /*
1945      * Locks held:
1946      * avc->lock(R) if setLocks && !slowPass
1947      * avc->lock(W) if !setLocks || slowPass
1948      * tdc->lock(S)
1949      */
1950     afs_Trace4(afs_iclSetp, CM_TRACE_GETDCACHE2, ICL_TYPE_POINTER, avc,
1951                ICL_TYPE_POINTER, tdc, ICL_TYPE_INT32,
1952                hgetlo(tdc->f.versionNo), ICL_TYPE_INT32,
1953                hgetlo(avc->f.m.DataVersion));
1954     /*
1955      * Here we have the entry in tdc, with its refCount incremented.
1956      * Note: we don't use the S-lock on avc; it costs concurrency when
1957      * storing a file back to the server.
1958      */
1959
1960     /*
1961      * Not a newly created file so we need to check the file's length and
1962      * compare data versions since someone could have changed the data or we're
1963      * reading a file written elsewhere. We only want to bypass doing no-op
1964      * read rpcs on newly created files (dv of 0) since only then we guarantee
1965      * that this chunk's data hasn't been filled by another client.
1966      */
1967     size = AFS_CHUNKSIZE(abyte);
1968     if (aflags & 4)             /* called from write */
1969         tlen = *alen;
1970     else                        /* called from read */
1971         tlen = tdc->validPos - abyte;
1972     Position = AFS_CHUNKTOBASE(chunk);
1973     afs_Trace4(afs_iclSetp, CM_TRACE_GETDCACHE3, ICL_TYPE_INT32, tlen,
1974                ICL_TYPE_INT32, aflags, ICL_TYPE_OFFSET,
1975                ICL_HANDLE_OFFSET(abyte), ICL_TYPE_OFFSET,
1976                ICL_HANDLE_OFFSET(Position));
1977     if ((aflags & 4) && (hiszero(avc->f.m.DataVersion)))
1978         doAdjustSize = 1;
1979     if ((AFS_CHUNKTOBASE(chunk) >= avc->f.m.Length) ||
1980          ((aflags & 4) && (abyte == Position) && (tlen >= size)))
1981         overWriteWholeChunk = 1;
1982     if (doAdjustSize || overWriteWholeChunk) {
1983 #if     defined(AFS_AIX32_ENV) || defined(AFS_SGI_ENV)
1984 #ifdef  AFS_SGI_ENV
1985 #ifdef AFS_SGI64_ENV
1986         if (doAdjustSize)
1987             adjustsize = NBPP;
1988 #else /* AFS_SGI64_ENV */
1989         if (doAdjustSize)
1990             adjustsize = 8192;
1991 #endif /* AFS_SGI64_ENV */
1992 #else /* AFS_SGI_ENV */
1993         if (doAdjustSize)
1994             adjustsize = 4096;
1995 #endif /* AFS_SGI_ENV */
1996         if (AFS_CHUNKTOBASE(chunk) + adjustsize >= avc->f.m.Length &&
1997 #else /* defined(AFS_AIX32_ENV) || defined(AFS_SGI_ENV) */
1998 #if     defined(AFS_SUN5_ENV)
1999         if ((doAdjustSize || (AFS_CHUNKTOBASE(chunk) >= avc->f.m.Length)) &&
2000 #else
2001         if (AFS_CHUNKTOBASE(chunk) >= avc->f.m.Length &&
2002 #endif
2003 #endif /* defined(AFS_AIX32_ENV) || defined(AFS_SGI_ENV) */
2004             !hsame(avc->f.m.DataVersion, tdc->f.versionNo))
2005             doReallyAdjustSize = 1;
2006
2007         if (doReallyAdjustSize || overWriteWholeChunk) {
2008             /* no data in file to read at this position */
2009             UpgradeSToWLock(&tdc->lock, 607);
2010             file = afs_CFileOpen(&tdc->f.inode);
2011             afs_CFileTruncate(file, 0);
2012             afs_CFileClose(file);
2013             afs_AdjustSize(tdc, 0);
2014             hset(tdc->f.versionNo, avc->f.m.DataVersion);
2015             tdc->dflags |= DFEntryMod;
2016
2017             ConvertWToSLock(&tdc->lock);
2018         }
2019     }
2020
2021     /*
2022      * We must read in the whole chunk if the version number doesn't
2023      * match.
2024      */
2025     if (aflags & 2) {
2026         /* don't need data, just a unique dcache entry */
2027         ObtainWriteLock(&afs_xdcache, 608);
2028         hset(afs_indexTimes[tdc->index], afs_indexCounter);
2029         hadd32(afs_indexCounter, 1);
2030         ReleaseWriteLock(&afs_xdcache);
2031
2032         updateV2DC(setLocks, avc, tdc, 553);
2033         if (vType(avc) == VDIR)
2034             *aoffset = abyte;
2035         else
2036             *aoffset = AFS_CHUNKOFFSET(abyte);
2037         if (tdc->validPos < abyte)
2038             *alen = (afs_size_t) 0;
2039         else
2040             *alen = tdc->validPos - abyte;
2041         ReleaseSharedLock(&tdc->lock);
2042         if (setLocks) {
2043             if (slowPass)
2044                 ReleaseWriteLock(&avc->lock);
2045             else
2046                 ReleaseReadLock(&avc->lock);
2047         }
2048         return tdc;             /* check if we're done */
2049     }
2050
2051     /*
2052      * Locks held:
2053      * avc->lock(R) if setLocks && !slowPass
2054      * avc->lock(W) if !setLocks || slowPass
2055      * tdc->lock(S)
2056      */
2057     osi_Assert((setLocks && !slowPass) || WriteLocked(&avc->lock));
2058
2059     setNewCallback = setVcacheStatus = 0;
2060
2061     /*
2062      * Locks held:
2063      * avc->lock(R) if setLocks && !slowPass
2064      * avc->lock(W) if !setLocks || slowPass
2065      * tdc->lock(S)
2066      */
2067     if (!hsame(avc->f.m.DataVersion, tdc->f.versionNo) && !overWriteWholeChunk) {
2068         /*
2069          * Version number mismatch.
2070          */
2071         /*
2072          * If we are disconnected, then we can't do much of anything
2073          * because the data doesn't match the file.
2074          */
2075         if (AFS_IS_DISCONNECTED) {
2076             ReleaseSharedLock(&tdc->lock);
2077             if (setLocks) {
2078                 if (slowPass)
2079                     ReleaseWriteLock(&avc->lock);
2080                 else
2081                     ReleaseReadLock(&avc->lock);
2082             }
2083             /* Flush the Dcache */
2084             afs_PutDCache(tdc);
2085
2086             return NULL;
2087         }
2088         UpgradeSToWLock(&tdc->lock, 609);
2089
2090         /*
2091          * If data ever existed for this vnode, and this is a text object,
2092          * do some clearing.  Now, you'd think you need only do the flush
2093          * when VTEXT is on, but VTEXT is turned off when the text object
2094          * is freed, while pages are left lying around in memory marked
2095          * with this vnode.  If we would reactivate (create a new text
2096          * object from) this vnode, we could easily stumble upon some of
2097          * these old pages in pagein.  So, we always flush these guys.
2098          * Sun has a wonderful lack of useful invariants in this system.
2099          *
2100          * avc->flushDV is the data version # of the file at the last text
2101          * flush.  Clearly, at least, we don't have to flush the file more
2102          * often than it changes
2103          */
2104         if (hcmp(avc->flushDV, avc->f.m.DataVersion) < 0) {
2105             /*
2106              * By here, the cache entry is always write-locked.  We can
2107              * deadlock if we call osi_Flush with the cache entry locked...
2108              * Unlock the dcache too.
2109              */
2110             ReleaseWriteLock(&tdc->lock);
2111             if (setLocks && !slowPass)
2112                 ReleaseReadLock(&avc->lock);
2113             else
2114                 ReleaseWriteLock(&avc->lock);
2115
2116             osi_FlushText(avc);
2117             /*
2118              * Call osi_FlushPages in open, read/write, and map, since it
2119              * is too hard here to figure out if we should lock the
2120              * pvnLock.
2121              */
2122             if (setLocks && !slowPass)
2123                 ObtainReadLock(&avc->lock);
2124             else
2125                 ObtainWriteLock(&avc->lock, 66);
2126             ObtainWriteLock(&tdc->lock, 610);
2127         }
2128
2129         /*
2130          * Locks held:
2131          * avc->lock(R) if setLocks && !slowPass
2132          * avc->lock(W) if !setLocks || slowPass
2133          * tdc->lock(W)
2134          */
2135
2136         /* Watch for standard race condition around osi_FlushText */
2137         if (hsame(avc->f.m.DataVersion, tdc->f.versionNo)) {
2138             updateV2DC(setLocks, avc, tdc, 569);        /* set hint */
2139             afs_stats_cmperf.dcacheHits++;
2140             ConvertWToSLock(&tdc->lock);
2141             goto done;
2142         }
2143
2144         /* Sleep here when cache needs to be drained. */
2145         if (setLocks && !slowPass
2146             && (afs_blocksUsed >
2147                 PERCENT(CM_WAITFORDRAINPCT, afs_cacheBlocks))) {
2148             /* Make sure truncate daemon is running */
2149             afs_MaybeWakeupTruncateDaemon();
2150             ObtainWriteLock(&tdc->tlock, 614);
2151             tdc->refCount--;    /* we'll re-obtain the dcache when we re-try. */
2152             ReleaseWriteLock(&tdc->tlock);
2153             ReleaseWriteLock(&tdc->lock);
2154             ReleaseReadLock(&avc->lock);
2155             while ((afs_blocksUsed - afs_blocksDiscarded) >
2156                    PERCENT(CM_WAITFORDRAINPCT, afs_cacheBlocks)) {
2157                 afs_WaitForCacheDrain = 1;
2158                 afs_osi_Sleep(&afs_WaitForCacheDrain);
2159             }
2160             afs_MaybeFreeDiscardedDCache();
2161             /* need to check if someone else got the chunk first. */
2162             goto RetryGetDCache;
2163         }
2164
2165         Position = AFS_CHUNKBASE(abyte);
2166         if (vType(avc) == VDIR) {
2167             size = avc->f.m.Length;
2168             if (size > tdc->f.chunkBytes) {
2169                 /* pre-reserve space for file */
2170                 afs_AdjustSize(tdc, size);
2171             }
2172             size = 999999999;   /* max size for transfer */
2173         } else {
2174             afs_size_t maxGoodLength;
2175
2176             /* estimate how much data we're expecting back from the server,
2177              * and reserve space in the dcache entry for it */
2178
2179             maxGoodLength = avc->f.m.Length;
2180             if (avc->f.truncPos < maxGoodLength)
2181                 maxGoodLength = avc->f.truncPos;
2182
2183             size = AFS_CHUNKSIZE(abyte);        /* expected max size */
2184             if (Position + size > maxGoodLength)
2185                 size = maxGoodLength - Position;
2186             if (size < 0)
2187                 size = 0;       /* Handle random races */
2188             if (size > tdc->f.chunkBytes) {
2189                 /* pre-reserve estimated space for file */
2190                 afs_AdjustSize(tdc, size);      /* changes chunkBytes */
2191             }
2192
2193             if (size) {
2194                 /* For the actual fetch, do not limit the request to the
2195                  * length of the file. If this results in a read past EOF on
2196                  * the server, the server will just reply with less data than
2197                  * requested. If we limit ourselves to only requesting data up
2198                  * to the avc file length, we open ourselves up to races if the
2199                  * file is extended on the server at about the same time.
2200                  *
2201                  * However, we must restrict ourselves to the avc->f.truncPos
2202                  * length, since this represents an outstanding local
2203                  * truncation of the file that will be committed to the
2204                  * fileserver when we actually write the fileserver contents.
2205                  * If we do not restrict the fetch length based on
2206                  * avc->f.truncPos, a different truncate operation extending
2207                  * the file length could cause the old data after
2208                  * avc->f.truncPos to reappear, instead of extending the file
2209                  * with NUL bytes. */
2210                 size = AFS_CHUNKSIZE(abyte);
2211                 if (Position + size > avc->f.truncPos) {
2212                     size = avc->f.truncPos - Position;
2213                 }
2214                 if (size < 0) {
2215                     size = 0;
2216                 }
2217             }
2218         }
2219         if (afs_mariner && !tdc->f.chunk)
2220             afs_MarinerLog("fetch$Fetching", avc);      /* , Position, size, afs_indexCounter ); */
2221         /*
2222          * Right now, we only have one tool, and it's a hammer.  So, we
2223          * fetch the whole file.
2224          */
2225         DZap(tdc);      /* pages in cache may be old */
2226         file = afs_CFileOpen(&tdc->f.inode);
2227         afs_RemoveVCB(&avc->f.fid);
2228         tdc->f.states |= DWriting;
2229         tdc->dflags |= DFFetching;
2230         tdc->validPos = Position;       /*  which is AFS_CHUNKBASE(abyte) */
2231         if (tdc->mflags & DFFetchReq) {
2232             tdc->mflags &= ~DFFetchReq;
2233             if (afs_osi_Wakeup(&tdc->validPos) == 0)
2234                 afs_Trace4(afs_iclSetp, CM_TRACE_DCACHEWAKE, ICL_TYPE_STRING,
2235                            __FILE__, ICL_TYPE_INT32, __LINE__,
2236                            ICL_TYPE_POINTER, tdc, ICL_TYPE_INT32,
2237                            tdc->dflags);
2238         }
2239         tsmall = osi_AllocLargeSpace(sizeof(struct afs_FetchOutput));
2240         setVcacheStatus = 0;
2241 #ifndef AFS_NOSTATS
2242         /*
2243          * Remember if we are doing the reading from a replicated volume,
2244          * and how many times we've zipped around the fetch/analyze loop.
2245          */
2246         fromReplica = (avc->f.states & CRO) ? 1 : 0;
2247         numFetchLoops = 0;
2248         accP = &(afs_stats_cmfullperf.accessinf);
2249         if (fromReplica)
2250             (accP->replicatedRefs)++;
2251         else
2252             (accP->unreplicatedRefs)++;
2253 #endif /* AFS_NOSTATS */
2254         /* this is a cache miss */
2255         afs_Trace4(afs_iclSetp, CM_TRACE_FETCHPROC, ICL_TYPE_POINTER, avc,
2256                    ICL_TYPE_FID, &(avc->f.fid), ICL_TYPE_OFFSET,
2257                    ICL_HANDLE_OFFSET(Position), ICL_TYPE_INT32, size);
2258
2259         if (size)
2260             afs_stats_cmperf.dcacheMisses++;
2261         code = 0;
2262         /*
2263          * Dynamic root support:  fetch data from local memory.
2264          */
2265         if (afs_IsDynroot(avc)) {
2266             char *dynrootDir;
2267             int dynrootLen;
2268
2269             afs_GetDynroot(&dynrootDir, &dynrootLen, &tsmall->OutStatus);
2270
2271             dynrootDir += Position;
2272             dynrootLen -= Position;
2273             if (size > dynrootLen)
2274                 size = dynrootLen;
2275             if (size < 0)
2276                 size = 0;
2277             code = afs_CFileWrite(file, 0, dynrootDir, size);
2278             afs_PutDynroot();
2279
2280             if (code == size)
2281                 code = 0;
2282             else
2283                 code = -1;
2284
2285             tdc->validPos = Position + size;
2286             afs_CFileTruncate(file, size);      /* prune it */
2287         } else if (afs_IsDynrootMount(avc)) {
2288             char *dynrootDir;
2289             int dynrootLen;
2290
2291             afs_GetDynrootMount(&dynrootDir, &dynrootLen, &tsmall->OutStatus);
2292
2293             dynrootDir += Position;
2294             dynrootLen -= Position;
2295             if (size > dynrootLen)
2296                 size = dynrootLen;
2297             if (size < 0)
2298                 size = 0;
2299             code = afs_CFileWrite(file, 0, dynrootDir, size);
2300             afs_PutDynroot();
2301
2302             if (code == size)
2303                 code = 0;
2304             else
2305                 code = -1;
2306
2307             tdc->validPos = Position + size;
2308             afs_CFileTruncate(file, size);      /* prune it */
2309         } else
2310             /*
2311              * Not a dynamic vnode:  do the real fetch.
2312              */
2313             do {
2314                 /*
2315                  * Locks held:
2316                  * avc->lock(R) if setLocks && !slowPass
2317                  * avc->lock(W) if !setLocks || slowPass
2318                  * tdc->lock(W)
2319                  */
2320
2321                 tc = afs_Conn(&avc->f.fid, areq, SHARED_LOCK, &rxconn);
2322                 if (tc) {
2323 #ifndef AFS_NOSTATS
2324                     numFetchLoops++;
2325                     if (fromReplica)
2326                         (accP->numReplicasAccessed)++;
2327
2328 #endif /* AFS_NOSTATS */
2329                     if (!setLocks || slowPass) {
2330                         avc->callback = tc->parent->srvr->server;
2331                     } else {
2332                         newCallback = tc->parent->srvr->server;
2333                         setNewCallback = 1;
2334                     }
2335                     i = osi_Time();
2336                     code = afs_CacheFetchProc(tc, rxconn, file, Position, tdc,
2337                                                avc, size, tsmall);
2338                 } else
2339                    code = -1;
2340
2341                 if (code == 0) {
2342                     /* callback could have been broken (or expired) in a race here,
2343                      * but we return the data anyway.  It's as good as we knew about
2344                      * when we started. */
2345                     /*
2346                      * validPos is updated by CacheFetchProc, and can only be
2347                      * modifed under a dcache write lock, which we've blocked out
2348                      */
2349                     size = tdc->validPos - Position;    /* actual segment size */
2350                     if (size < 0)
2351                         size = 0;
2352                     afs_CFileTruncate(file, size);      /* prune it */
2353                 } else {
2354                     if (!setLocks || slowPass) {
2355                         ObtainWriteLock(&afs_xcbhash, 453);
2356                         afs_DequeueCallback(avc);
2357                         avc->f.states &= ~(CStatd | CUnique);
2358                         avc->callback = NULL;
2359                         ReleaseWriteLock(&afs_xcbhash);
2360                         if (avc->f.fid.Fid.Vnode & 1 || (vType(avc) == VDIR))
2361                             osi_dnlc_purgedp(avc);
2362                     } else {
2363                         /* Something lost.  Forget about performance, and go
2364                          * back with a vcache write lock.
2365                          */
2366                         afs_CFileTruncate(file, 0);
2367                         afs_AdjustSize(tdc, 0);
2368                         afs_CFileClose(file);
2369                         osi_FreeLargeSpace(tsmall);
2370                         tsmall = 0;
2371                         ReleaseWriteLock(&tdc->lock);
2372                         afs_PutDCache(tdc);
2373                         tdc = 0;
2374                         ReleaseReadLock(&avc->lock);
2375                         slowPass = 1;
2376                         goto RetryGetDCache;
2377                     }
2378                 }
2379
2380             } while (afs_Analyze
2381                      (tc, rxconn, code, &avc->f.fid, areq,
2382                       AFS_STATS_FS_RPCIDX_FETCHDATA, SHARED_LOCK, NULL));
2383
2384         /*
2385          * Locks held:
2386          * avc->lock(R) if setLocks && !slowPass
2387          * avc->lock(W) if !setLocks || slowPass
2388          * tdc->lock(W)
2389          */
2390
2391 #ifndef AFS_NOSTATS
2392         /*
2393          * In the case of replicated access, jot down info on the number of
2394          * attempts it took before we got through or gave up.
2395          */
2396         if (fromReplica) {
2397             if (numFetchLoops <= 1)
2398                 (accP->refFirstReplicaOK)++;
2399             if (numFetchLoops > accP->maxReplicasPerRef)
2400                 accP->maxReplicasPerRef = numFetchLoops;
2401         }
2402 #endif /* AFS_NOSTATS */
2403
2404         tdc->dflags &= ~DFFetching;
2405         if (afs_osi_Wakeup(&tdc->validPos) == 0)
2406             afs_Trace4(afs_iclSetp, CM_TRACE_DCACHEWAKE, ICL_TYPE_STRING,
2407                        __FILE__, ICL_TYPE_INT32, __LINE__, ICL_TYPE_POINTER,
2408                        tdc, ICL_TYPE_INT32, tdc->dflags);
2409         if (avc->execsOrWriters == 0)
2410             tdc->f.states &= ~DWriting;
2411
2412         /* now, if code != 0, we have an error and should punt.
2413          * note that we have the vcache write lock, either because
2414          * !setLocks or slowPass.
2415          */
2416         if (code) {
2417             afs_CFileTruncate(file, 0);
2418             afs_AdjustSize(tdc, 0);
2419             afs_CFileClose(file);
2420             ZapDCE(tdc);        /* sets DFEntryMod */
2421             if (vType(avc) == VDIR) {
2422                 DZap(tdc);
2423             }
2424             tdc->f.states &= ~(DRO|DBackup|DRW);
2425             afs_DCMoveBucket(tdc, 0, 0);
2426             ReleaseWriteLock(&tdc->lock);
2427             afs_PutDCache(tdc);
2428             if (!afs_IsDynroot(avc)) {
2429                 ObtainWriteLock(&afs_xcbhash, 454);
2430                 afs_DequeueCallback(avc);
2431                 avc->f.states &= ~(CStatd | CUnique);
2432                 ReleaseWriteLock(&afs_xcbhash);
2433                 if (avc->f.fid.Fid.Vnode & 1 || (vType(avc) == VDIR))
2434                     osi_dnlc_purgedp(avc);
2435                 /*
2436                  * Locks held:
2437                  * avc->lock(W); assert(!setLocks || slowPass)
2438                  */
2439                 osi_Assert(!setLocks || slowPass);
2440             }
2441             tdc = NULL;
2442             goto done;
2443         }
2444
2445         /* otherwise we copy in the just-fetched info */
2446         afs_CFileClose(file);
2447         afs_AdjustSize(tdc, size);      /* new size */
2448         /*
2449          * Copy appropriate fields into vcache.  Status is
2450          * copied later where we selectively acquire the
2451          * vcache write lock.
2452          */
2453         if (slowPass)
2454             afs_ProcessFS(avc, &tsmall->OutStatus, areq);
2455         else
2456             setVcacheStatus = 1;
2457         hset64(tdc->f.versionNo, tsmall->OutStatus.dataVersionHigh,
2458                tsmall->OutStatus.DataVersion);
2459         tdc->dflags |= DFEntryMod;
2460         afs_indexFlags[tdc->index] |= IFEverUsed;
2461         ConvertWToSLock(&tdc->lock);
2462     } /*Data version numbers don't match */
2463     else {
2464         /*
2465          * Data version numbers match.
2466          */
2467         afs_stats_cmperf.dcacheHits++;
2468     }                           /*Data version numbers match */
2469
2470     updateV2DC(setLocks, avc, tdc, 335);        /* set hint */
2471   done:
2472     /*
2473      * Locks held:
2474      * avc->lock(R) if setLocks && !slowPass
2475      * avc->lock(W) if !setLocks || slowPass
2476      * tdc->lock(S) if tdc
2477      */
2478
2479     /*
2480      * See if this was a reference to a file in the local cell.
2481      */
2482     if (afs_IsPrimaryCellNum(avc->f.fid.Cell))
2483         afs_stats_cmperf.dlocalAccesses++;
2484     else
2485         afs_stats_cmperf.dremoteAccesses++;
2486
2487     /* Fix up LRU info */
2488
2489     if (tdc) {
2490         ObtainWriteLock(&afs_xdcache, 602);
2491         hset(afs_indexTimes[tdc->index], afs_indexCounter);
2492         hadd32(afs_indexCounter, 1);
2493         ReleaseWriteLock(&afs_xdcache);
2494
2495         /* return the data */
2496         if (vType(avc) == VDIR)
2497             *aoffset = abyte;
2498         else
2499             *aoffset = AFS_CHUNKOFFSET(abyte);
2500         *alen = (tdc->f.chunkBytes - *aoffset);
2501         ReleaseSharedLock(&tdc->lock);
2502     }
2503
2504     /*
2505      * Locks held:
2506      * avc->lock(R) if setLocks && !slowPass
2507      * avc->lock(W) if !setLocks || slowPass
2508      */
2509
2510     /* Fix up the callback and status values in the vcache */
2511     doVcacheUpdate = 0;
2512     if (setLocks && !slowPass) {
2513         /* DCLOCKXXX
2514          *
2515          * This is our dirty little secret to parallel fetches.
2516          * We don't write-lock the vcache while doing the fetch,
2517          * but potentially we'll need to update the vcache after
2518          * the fetch is done.
2519          *
2520          * Drop the read lock and try to re-obtain the write
2521          * lock.  If the vcache still has the same DV, it's
2522          * ok to go ahead and install the new data.
2523          */
2524         afs_hyper_t currentDV, statusDV;
2525
2526         hset(currentDV, avc->f.m.DataVersion);
2527
2528         if (setNewCallback && avc->callback != newCallback)
2529             doVcacheUpdate = 1;
2530
2531         if (tsmall) {
2532             hset64(statusDV, tsmall->OutStatus.dataVersionHigh,
2533                    tsmall->OutStatus.DataVersion);
2534
2535             if (setVcacheStatus && avc->f.m.Length != tsmall->OutStatus.Length)
2536                 doVcacheUpdate = 1;
2537             if (setVcacheStatus && !hsame(currentDV, statusDV))
2538                 doVcacheUpdate = 1;
2539         }
2540
2541         ReleaseReadLock(&avc->lock);
2542
2543         if (doVcacheUpdate) {
2544             ObtainWriteLock(&avc->lock, 615);
2545             if (!hsame(avc->f.m.DataVersion, currentDV)) {
2546                 /* We lose.  Someone will beat us to it. */
2547                 doVcacheUpdate = 0;
2548                 ReleaseWriteLock(&avc->lock);
2549             }
2550         }
2551     }
2552
2553     /* With slow pass, we've already done all the updates */
2554     if (slowPass) {
2555         ReleaseWriteLock(&avc->lock);
2556     }
2557
2558     /* Check if we need to perform any last-minute fixes with a write-lock */
2559     if (!setLocks || doVcacheUpdate) {
2560         if (setNewCallback)
2561             avc->callback = newCallback;
2562         if (tsmall && setVcacheStatus)
2563             afs_ProcessFS(avc, &tsmall->OutStatus, areq);
2564         if (setLocks)
2565             ReleaseWriteLock(&avc->lock);
2566     }
2567
2568     if (tsmall)
2569         osi_FreeLargeSpace(tsmall);
2570
2571     return tdc;
2572 }                               /*afs_GetDCache */
2573
2574
2575 /*
2576  * afs_WriteThroughDSlots
2577  *
2578  * Description:
2579  *      Sweep through the dcache slots and write out any modified
2580  *      in-memory data back on to our caching store.
2581  *
2582  * Parameters:
2583  *      None.
2584  *
2585  * Environment:
2586  *      The afs_xdcache is write-locked through this whole affair.
2587  */
2588 void
2589 afs_WriteThroughDSlots(void)
2590 {
2591     struct dcache *tdc;
2592     afs_int32 i, touchedit = 0;
2593
2594     struct afs_q DirtyQ, *tq;
2595
2596     AFS_STATCNT(afs_WriteThroughDSlots);
2597
2598     /*
2599      * Because of lock ordering, we can't grab dcache locks while
2600      * holding afs_xdcache.  So we enter xdcache, get a reference
2601      * for every dcache entry, and exit xdcache.
2602      */
2603     ObtainWriteLock(&afs_xdcache, 283);
2604     QInit(&DirtyQ);
2605     for (i = 0; i < afs_cacheFiles; i++) {
2606         tdc = afs_indexTable[i];
2607
2608         /* Grab tlock in case the existing refcount isn't zero */
2609         if (tdc && !(afs_indexFlags[i] & (IFFree | IFDiscarded))) {
2610             ObtainWriteLock(&tdc->tlock, 623);
2611             tdc->refCount++;
2612             ReleaseWriteLock(&tdc->tlock);
2613
2614             QAdd(&DirtyQ, &tdc->dirty);
2615         }
2616     }
2617     ReleaseWriteLock(&afs_xdcache);
2618
2619     /*
2620      * Now, for each dcache entry we found, check if it's dirty.
2621      * If so, get write-lock, get afs_xdcache, which protects
2622      * afs_cacheInodep, and flush it.  Don't forget to put back
2623      * the refcounts.
2624      */
2625
2626 #define DQTODC(q)       ((struct dcache *)(((char *) (q)) - sizeof(struct afs_q)))
2627
2628     for (tq = DirtyQ.prev; tq != &DirtyQ; tq = QPrev(tq)) {
2629         tdc = DQTODC(tq);
2630         if (tdc->dflags & DFEntryMod) {
2631             int wrLock;
2632
2633             wrLock = (0 == NBObtainWriteLock(&tdc->lock, 619));
2634
2635             /* Now that we have the write lock, double-check */
2636             if (wrLock && (tdc->dflags & DFEntryMod)) {
2637                 tdc->dflags &= ~DFEntryMod;
2638                 ObtainWriteLock(&afs_xdcache, 620);
2639                 osi_Assert(afs_WriteDCache(tdc, 1) == 0);
2640                 ReleaseWriteLock(&afs_xdcache);
2641                 touchedit = 1;
2642             }
2643             if (wrLock)
2644                 ReleaseWriteLock(&tdc->lock);
2645         }
2646
2647         afs_PutDCache(tdc);
2648     }
2649
2650     ObtainWriteLock(&afs_xdcache, 617);
2651     if (!touchedit && (cacheDiskType != AFS_FCACHE_TYPE_MEM)) {
2652         /* Touch the file to make sure that the mtime on the file is kept
2653          * up-to-date to avoid losing cached files on cold starts because
2654          * their mtime seems old...
2655          */
2656         struct afs_fheader theader;
2657
2658         theader.magic = AFS_FHMAGIC;
2659         theader.firstCSize = AFS_FIRSTCSIZE;
2660         theader.otherCSize = AFS_OTHERCSIZE;
2661         theader.version = AFS_CI_VERSION;
2662         theader.dataSize = sizeof(struct fcache);
2663         afs_osi_Write(afs_cacheInodep, 0, &theader, sizeof(theader));
2664     }
2665     ReleaseWriteLock(&afs_xdcache);
2666 }
2667
2668 /*
2669  * afs_MemGetDSlot
2670  *
2671  * Description:
2672  *      Return a pointer to an freshly initialized dcache entry using
2673  *      a memory-based cache.  The tlock will be read-locked.
2674  *
2675  * Parameters:
2676  *      aslot : Dcache slot to look at.
2677  *      needvalid : Whether the specified slot should already exist
2678  *
2679  * Environment:
2680  *      Must be called with afs_xdcache write-locked.
2681  */
2682
2683 struct dcache *
2684 afs_MemGetDSlot(afs_int32 aslot, int indexvalid, int datavalid)
2685 {
2686     struct dcache *tdc;
2687     int existing = 0;
2688
2689     AFS_STATCNT(afs_MemGetDSlot);
2690     if (CheckLock(&afs_xdcache) != -1)
2691         osi_Panic("getdslot nolock");
2692     if (aslot < 0 || aslot >= afs_cacheFiles)
2693         osi_Panic("getdslot slot %d (of %d)", aslot, afs_cacheFiles);
2694     tdc = afs_indexTable[aslot];
2695     if (tdc) {
2696         QRemove(&tdc->lruq);    /* move to queue head */
2697         QAdd(&afs_DLRU, &tdc->lruq);
2698         /* We're holding afs_xdcache, but get tlock in case refCount != 0 */
2699         ObtainWriteLock(&tdc->tlock, 624);
2700         tdc->refCount++;
2701         ConvertWToRLock(&tdc->tlock);
2702         return tdc;
2703     }
2704
2705     /* if 'indexvalid' is true, the slot must already exist and be populated
2706      * somewhere. for memcache, the only place that dcache entries exist is
2707      * in memory, so if we did not find it above, something is very wrong. */
2708     osi_Assert(!indexvalid);
2709
2710     if (!afs_freeDSList)
2711         afs_GetDownDSlot(4);
2712     if (!afs_freeDSList) {
2713         /* none free, making one is better than a panic */
2714         afs_stats_cmperf.dcacheXAllocs++;       /* count in case we have a leak */
2715         tdc = afs_osi_Alloc(sizeof(struct dcache));
2716         osi_Assert(tdc != NULL);
2717 #ifdef  KERNEL_HAVE_PIN
2718         pin((char *)tdc, sizeof(struct dcache));        /* XXX */
2719 #endif
2720     } else {
2721         tdc = afs_freeDSList;
2722         afs_freeDSList = (struct dcache *)tdc->lruq.next;
2723         existing = 1;
2724     }
2725     tdc->dflags = 0;    /* up-to-date, not in free q */
2726     tdc->mflags = 0;
2727     QAdd(&afs_DLRU, &tdc->lruq);
2728     if (tdc->lruq.prev == &tdc->lruq)
2729         osi_Panic("lruq 3");
2730
2731     /* initialize entry */
2732     tdc->f.fid.Cell = 0;
2733     tdc->f.fid.Fid.Volume = 0;
2734     tdc->f.chunk = -1;
2735     hones(tdc->f.versionNo);
2736     tdc->f.inode.mem = aslot;
2737     tdc->dflags |= DFEntryMod;
2738     tdc->refCount = 1;
2739     tdc->index = aslot;
2740     afs_indexUnique[aslot] = tdc->f.fid.Fid.Unique;
2741
2742     if (existing) {
2743         osi_Assert(0 == NBObtainWriteLock(&tdc->lock, 674));
2744         osi_Assert(0 == NBObtainWriteLock(&tdc->mflock, 675));
2745         osi_Assert(0 == NBObtainWriteLock(&tdc->tlock, 676));
2746     }
2747
2748     AFS_RWLOCK_INIT(&tdc->lock, "dcache lock");
2749     AFS_RWLOCK_INIT(&tdc->tlock, "dcache tlock");
2750     AFS_RWLOCK_INIT(&tdc->mflock, "dcache flock");
2751     ObtainReadLock(&tdc->tlock);
2752
2753     afs_indexTable[aslot] = tdc;
2754     return tdc;
2755
2756 }                               /*afs_MemGetDSlot */
2757
2758 unsigned int last_error = 0, lasterrtime = 0;
2759
2760 /*
2761  * afs_UFSGetDSlot
2762  *
2763  * Description:
2764  *      Return a pointer to an freshly initialized dcache entry using
2765  *      a UFS-based disk cache.  The dcache tlock will be read-locked.
2766  *
2767  * Parameters:
2768  *      aslot : Dcache slot to look at.
2769  *      indexvalid : 1 if we know the slot we're giving is valid, and thus
2770  *                   reading the dcache from the disk index should succeed. 0
2771  *                   if we are initializing a new dcache, and so reading from
2772  *                   the disk index may fail.
2773  *      datavalid : 0 if we are loading a dcache entry from the free or
2774  *                  discard list, so we know the data in the given dcache is
2775  *                  not valid. 1 if we are loading a known used dcache, so the
2776  *                  data in the dcache must be valid.
2777  *
2778  * Environment:
2779  *      afs_xdcache lock write-locked.
2780  */
2781 struct dcache *
2782 afs_UFSGetDSlot(afs_int32 aslot, int indexvalid, int datavalid)
2783 {
2784     afs_int32 code;
2785     struct dcache *tdc;
2786     int existing = 0;
2787     int entryok;
2788     int off;
2789
2790     AFS_STATCNT(afs_UFSGetDSlot);
2791     if (CheckLock(&afs_xdcache) != -1)
2792         osi_Panic("getdslot nolock");
2793     if (aslot < 0 || aslot >= afs_cacheFiles)
2794         osi_Panic("getdslot slot %d (of %d)", aslot, afs_cacheFiles);
2795     tdc = afs_indexTable[aslot];
2796     if (tdc) {
2797         QRemove(&tdc->lruq);    /* move to queue head */
2798         QAdd(&afs_DLRU, &tdc->lruq);
2799         /* Grab tlock in case refCount != 0 */
2800         ObtainWriteLock(&tdc->tlock, 625);
2801         tdc->refCount++;
2802         ConvertWToRLock(&tdc->tlock);
2803         return tdc;
2804     }
2805
2806     /* otherwise we should read it in from the cache file */
2807     if (!afs_freeDSList)
2808         afs_GetDownDSlot(4);
2809     if (!afs_freeDSList) {
2810         /* none free, making one is better than a panic */
2811         afs_stats_cmperf.dcacheXAllocs++;       /* count in case we have a leak */
2812         tdc = afs_osi_Alloc(sizeof(struct dcache));
2813         osi_Assert(tdc != NULL);
2814 #ifdef  KERNEL_HAVE_PIN
2815         pin((char *)tdc, sizeof(struct dcache));        /* XXX */
2816 #endif
2817     } else {
2818         tdc = afs_freeDSList;
2819         afs_freeDSList = (struct dcache *)tdc->lruq.next;
2820         existing = 1;
2821     }
2822     tdc->dflags = 0;    /* up-to-date, not in free q */
2823     tdc->mflags = 0;
2824     QAdd(&afs_DLRU, &tdc->lruq);
2825     if (tdc->lruq.prev == &tdc->lruq)
2826         osi_Panic("lruq 3");
2827
2828     /*
2829      * Seek to the aslot'th entry and read it in.
2830      */
2831     off = sizeof(struct fcache)*aslot + sizeof(struct afs_fheader);
2832     code =
2833         afs_osi_Read(afs_cacheInodep,
2834                      off, (char *)(&tdc->f),
2835                      sizeof(struct fcache));
2836     entryok = 1;
2837     if (code != sizeof(struct fcache)) {
2838         entryok = 0;
2839 #if defined(KERNEL_HAVE_UERROR)
2840         last_error = getuerror();
2841 #else
2842         last_error = code;
2843 #endif
2844         lasterrtime = osi_Time();
2845         if (indexvalid) {
2846             struct osi_stat tstat;
2847             if (afs_osi_Stat(afs_cacheInodep, &tstat)) {
2848                 tstat.size = -1;
2849             }
2850             afs_warn("afs: disk cache read error in CacheItems slot %d "
2851                      "off %d/%d code %d/%d\n",
2852                      (int)aslot,
2853                      off, (int)tstat.size,
2854                      (int)code, (int)sizeof(struct fcache));
2855             /* put tdc back on the free dslot list */
2856             QRemove(&tdc->lruq);
2857             tdc->index = NULLIDX;
2858             tdc->lruq.next = (struct afs_q *)afs_freeDSList;
2859             afs_freeDSList = tdc;
2860             return NULL;
2861         }
2862     }
2863     if (!afs_CellNumValid(tdc->f.fid.Cell)) {
2864         entryok = 0;
2865         if (datavalid) {
2866             osi_Panic("afs: needed valid dcache but index %d off %d has "
2867                       "invalid cell num %d\n",
2868                       (int)aslot, off, (int)tdc->f.fid.Cell);
2869         }
2870     }
2871
2872     if (datavalid && tdc->f.fid.Fid.Volume == 0) {
2873         osi_Panic("afs: invalid zero-volume dcache entry at slot %d off %d",
2874                   (int)aslot, off);
2875     }
2876
2877     if (!entryok || !datavalid) {
2878         tdc->f.fid.Cell = 0;
2879         tdc->f.fid.Fid.Volume = 0;
2880         tdc->f.chunk = -1;
2881         hones(tdc->f.versionNo);
2882         tdc->dflags |= DFEntryMod;
2883         afs_indexUnique[aslot] = tdc->f.fid.Fid.Unique;
2884         tdc->f.states &= ~(DRO|DBackup|DRW);
2885         afs_DCMoveBucket(tdc, 0, 0);
2886     } else {
2887         if (&tdc->f != 0) {
2888             if (tdc->f.states & DRO) {
2889                 afs_DCMoveBucket(tdc, 0, 2);
2890             } else if (tdc->f.states & DBackup) {
2891                 afs_DCMoveBucket(tdc, 0, 1);
2892             } else {
2893                 afs_DCMoveBucket(tdc, 0, 1);
2894             }
2895         }
2896     }
2897     tdc->refCount = 1;
2898     tdc->index = aslot;
2899     if (tdc->f.chunk >= 0)
2900         tdc->validPos = AFS_CHUNKTOBASE(tdc->f.chunk) + tdc->f.chunkBytes;
2901     else
2902         tdc->validPos = 0;
2903
2904     if (existing) {
2905         osi_Assert(0 == NBObtainWriteLock(&tdc->lock, 674));
2906         osi_Assert(0 == NBObtainWriteLock(&tdc->mflock, 675));
2907         osi_Assert(0 == NBObtainWriteLock(&tdc->tlock, 676));
2908     }
2909
2910     AFS_RWLOCK_INIT(&tdc->lock, "dcache lock");
2911     AFS_RWLOCK_INIT(&tdc->tlock, "dcache tlock");
2912     AFS_RWLOCK_INIT(&tdc->mflock, "dcache flock");
2913     ObtainReadLock(&tdc->tlock);
2914
2915     /*
2916      * If we didn't read into a temporary dcache region, update the
2917      * slot pointer table.
2918      */
2919     afs_indexTable[aslot] = tdc;
2920     return tdc;
2921
2922 }                               /*afs_UFSGetDSlot */
2923
2924
2925
2926 /*!
2927  * Write a particular dcache entry back to its home in the
2928  * CacheInfo file.
2929  *
2930  * \param adc Pointer to the dcache entry to write.
2931  * \param atime If true, set the modtime on the file to the current time.
2932  *
2933  * \note Environment:
2934  *      Must be called with the afs_xdcache lock at least read-locked,
2935  *      and dcache entry at least read-locked.
2936  *      The reference count is not changed.
2937  */
2938
2939 int
2940 afs_WriteDCache(struct dcache *adc, int atime)
2941 {
2942     afs_int32 code;
2943
2944     if (cacheDiskType == AFS_FCACHE_TYPE_MEM)
2945         return 0;
2946     AFS_STATCNT(afs_WriteDCache);
2947     osi_Assert(WriteLocked(&afs_xdcache));
2948     if (atime)
2949         adc->f.modTime = osi_Time();
2950
2951     if ((afs_indexFlags[adc->index] & (IFFree | IFDiscarded)) == 0 &&
2952         adc->f.fid.Fid.Volume == 0) {
2953         /* If a dcache slot is not on the free or discard list, it must be
2954          * in the hash table. Thus, the volume must be non-zero, since that
2955          * is how we determine whether or not to unhash the entry when kicking
2956          * it out of the cache. Do this check now, since otherwise this can
2957          * cause hash table corruption and a panic later on after we read the
2958          * entry back in. */
2959         osi_Panic("afs_WriteDCache zero volume index %d flags 0x%x\n",
2960                   adc->index, (unsigned)afs_indexFlags[adc->index]);
2961     }
2962
2963     /*
2964      * Seek to the right dcache slot and write the in-memory image out to disk.
2965      */
2966     afs_cellname_write();
2967     code =
2968         afs_osi_Write(afs_cacheInodep,
2969                       sizeof(struct fcache) * adc->index +
2970                       sizeof(struct afs_fheader), (char *)(&adc->f),
2971                       sizeof(struct fcache));
2972     if (code != sizeof(struct fcache)) {
2973         afs_warn("afs: failed to write to CacheItems off %ld code %d/%d\n",
2974                  (long)(sizeof(struct fcache) * adc->index + sizeof(struct afs_fheader)),
2975                  (int)code, (int)sizeof(struct fcache));
2976         return EIO;
2977     }
2978     return 0;
2979 }
2980
2981
2982
2983 /*!
2984  * Wake up users of a particular file waiting for stores to take
2985  * place.
2986  *
2987  * \param avc Ptr to related vcache entry.
2988  *
2989  * \note Environment:
2990  *      Nothing interesting.
2991  */
2992 int
2993 afs_wakeup(struct vcache *avc)
2994 {
2995     int i;
2996     struct brequest *tb;
2997     tb = afs_brs;
2998     AFS_STATCNT(afs_wakeup);
2999     for (i = 0; i < NBRS; i++, tb++) {
3000         /* if request is valid and for this file, we've found it */
3001         if (tb->refCount > 0 && avc == tb->vc) {
3002
3003             /*
3004              * If CSafeStore is on, then we don't awaken the guy
3005              * waiting for the store until the whole store has finished.
3006              * Otherwise, we do it now.  Note that if CSafeStore is on,
3007              * the BStore routine actually wakes up the user, instead
3008              * of us.
3009              * I think this is redundant now because this sort of thing
3010              * is already being handled by the higher-level code.
3011              */
3012             if ((avc->f.states & CSafeStore) == 0) {
3013                 tb->code = 0;
3014                 tb->flags |= BUVALID;
3015                 if (tb->flags & BUWAIT) {
3016                     tb->flags &= ~BUWAIT;
3017                     afs_osi_Wakeup(tb);
3018                 }
3019             }
3020             break;
3021         }
3022     }
3023     return 0;
3024 }
3025
3026 /*!
3027  * Given a file name and inode, set up that file to be an
3028  * active member in the AFS cache.  This also involves checking
3029  * the usability of its data.
3030  *
3031  * \param afile Name of the cache file to initialize.
3032  * \param ainode Inode of the file.
3033  *
3034  * \note Environment:
3035  *      This function is called only during initialization.
3036  */
3037 int
3038 afs_InitCacheFile(char *afile, ino_t ainode)
3039 {
3040     afs_int32 code;
3041     afs_int32 index;
3042     int fileIsBad;
3043     struct osi_file *tfile;
3044     struct osi_stat tstat;
3045     struct dcache *tdc;
3046
3047     AFS_STATCNT(afs_InitCacheFile);
3048     index = afs_stats_cmperf.cacheNumEntries;
3049     if (index >= afs_cacheFiles)
3050         return EINVAL;
3051
3052     ObtainWriteLock(&afs_xdcache, 282);
3053     tdc = afs_GetNewDSlot(index);
3054     ReleaseReadLock(&tdc->tlock);
3055     ReleaseWriteLock(&afs_xdcache);
3056
3057     ObtainWriteLock(&tdc->lock, 621);
3058     ObtainWriteLock(&afs_xdcache, 622);
3059     if (!afile && !ainode) {
3060         tfile = NULL;
3061         fileIsBad = 1;
3062     } else {
3063         if (afile) {
3064             code = afs_LookupInodeByPath(afile, &tdc->f.inode.ufs, NULL);
3065             if (code) {
3066                 ReleaseWriteLock(&afs_xdcache);
3067                 ReleaseWriteLock(&tdc->lock);
3068                 afs_PutDCache(tdc);
3069                 return code;
3070             }
3071         } else {
3072             /* Add any other 'complex' inode types here ... */
3073 #if !defined(AFS_LINUX26_ENV) && !defined(AFS_CACHE_VNODE_PATH)
3074             tdc->f.inode.ufs = ainode;
3075 #else
3076             osi_Panic("Can't init cache with inode numbers when complex inodes are "
3077                       "in use\n");
3078 #endif
3079         }
3080         fileIsBad = 0;
3081         if ((tdc->f.states & DWriting) || tdc->f.fid.Fid.Volume == 0)
3082             fileIsBad = 1;
3083         tfile = osi_UFSOpen(&tdc->f.inode);
3084         code = afs_osi_Stat(tfile, &tstat);
3085         if (code)
3086             osi_Panic("initcachefile stat");
3087
3088         /*
3089          * If file size doesn't match the cache info file, it's probably bad.
3090          */
3091         if (tdc->f.chunkBytes != tstat.size)
3092             fileIsBad = 1;
3093         /*
3094          * If file changed within T (120?) seconds of cache info file, it's
3095          * probably bad.  In addition, if slot changed within last T seconds,
3096          * the cache info file may be incorrectly identified, and so slot
3097          * may be bad.
3098          */
3099         if (cacheInfoModTime < tstat.mtime + 120)
3100             fileIsBad = 1;
3101         if (cacheInfoModTime < tdc->f.modTime + 120)
3102             fileIsBad = 1;
3103         /* In case write through is behind, make sure cache items entry is
3104          * at least as new as the chunk.
3105          */
3106         if (tdc->f.modTime < tstat.mtime)
3107             fileIsBad = 1;
3108     }
3109     tdc->f.chunkBytes = 0;
3110
3111     if (fileIsBad) {
3112         tdc->f.fid.Fid.Volume = 0;      /* not in the hash table */
3113         if (tfile && tstat.size != 0)
3114             osi_UFSTruncate(tfile, 0);
3115         tdc->f.states &= ~(DRO|DBackup|DRW);
3116         afs_DCMoveBucket(tdc, 0, 0);
3117         /* put entry in free cache slot list */
3118         afs_dvnextTbl[tdc->index] = afs_freeDCList;
3119         afs_freeDCList = index;
3120         afs_freeDCCount++;
3121         afs_indexFlags[index] |= IFFree;
3122         afs_indexUnique[index] = 0;
3123     } else {
3124         /*
3125          * We must put this entry in the appropriate hash tables.
3126          * Note that i is still set from the above DCHash call
3127          */
3128         code = DCHash(&tdc->f.fid, tdc->f.chunk);
3129         afs_dcnextTbl[tdc->index] = afs_dchashTbl[code];
3130         afs_dchashTbl[code] = tdc->index;
3131         code = DVHash(&tdc->f.fid);
3132         afs_dvnextTbl[tdc->index] = afs_dvhashTbl[code];
3133         afs_dvhashTbl[code] = tdc->index;
3134         afs_AdjustSize(tdc, tstat.size);        /* adjust to new size */
3135         if (tstat.size > 0)
3136             /* has nontrivial amt of data */
3137             afs_indexFlags[index] |= IFEverUsed;
3138         afs_stats_cmperf.cacheFilesReused++;
3139         /*
3140          * Initialize index times to file's mod times; init indexCounter
3141          * to max thereof
3142          */
3143         hset32(afs_indexTimes[index], tstat.atime);
3144         if (hgetlo(afs_indexCounter) < tstat.atime) {
3145             hset32(afs_indexCounter, tstat.atime);
3146         }
3147         afs_indexUnique[index] = tdc->f.fid.Fid.Unique;
3148     }                           /*File is not bad */
3149
3150     if (tfile)
3151         osi_UFSClose(tfile);
3152     tdc->f.states &= ~DWriting;
3153     tdc->dflags &= ~DFEntryMod;
3154     /* don't set f.modTime; we're just cleaning up */
3155     osi_Assert(afs_WriteDCache(tdc, 0) == 0);
3156     ReleaseWriteLock(&afs_xdcache);
3157     ReleaseWriteLock(&tdc->lock);
3158     afs_PutDCache(tdc);
3159     afs_stats_cmperf.cacheNumEntries++;
3160     return 0;
3161 }
3162
3163
3164 /*Max # of struct dcache's resident at any time*/
3165 /*
3166  * If 'dchint' is enabled then in-memory dcache min is increased because of
3167  * crashes...
3168  */
3169 #define DDSIZE 200
3170
3171 /*!
3172  * Initialize dcache related variables.
3173  *
3174  * \param afiles
3175  * \param ablocks
3176  * \param aDentries
3177  * \param achunk
3178  * \param aflags
3179  *
3180  */
3181 void
3182 afs_dcacheInit(int afiles, int ablocks, int aDentries, int achunk, int aflags)
3183 {
3184     struct dcache *tdp;
3185     int i;
3186     int code;
3187
3188     afs_freeDCList = NULLIDX;
3189     afs_discardDCList = NULLIDX;
3190     afs_freeDCCount = 0;
3191     afs_freeDSList = NULL;
3192     hzero(afs_indexCounter);
3193
3194     LOCK_INIT(&afs_xdcache, "afs_xdcache");
3195
3196     /*
3197      * Set chunk size
3198      */
3199     if (achunk) {
3200         if (achunk < 0 || achunk > 30)
3201             achunk = 13;        /* Use default */
3202         AFS_SETCHUNKSIZE(achunk);
3203     }
3204
3205     if (!aDentries)
3206         aDentries = DDSIZE;
3207
3208     if (aDentries > 512)
3209         afs_dhashsize = 2048;
3210     /* initialize hash tables */
3211     afs_dvhashTbl = afs_osi_Alloc(afs_dhashsize * sizeof(afs_int32));
3212     osi_Assert(afs_dvhashTbl != NULL);
3213     afs_dchashTbl = afs_osi_Alloc(afs_dhashsize * sizeof(afs_int32));
3214     osi_Assert(afs_dchashTbl != NULL);
3215     for (i = 0; i < afs_dhashsize; i++) {
3216         afs_dvhashTbl[i] = NULLIDX;
3217         afs_dchashTbl[i] = NULLIDX;
3218     }
3219     afs_dvnextTbl = afs_osi_Alloc(afiles * sizeof(afs_int32));
3220     osi_Assert(afs_dvnextTbl != NULL);
3221     afs_dcnextTbl = afs_osi_Alloc(afiles * sizeof(afs_int32));
3222     osi_Assert(afs_dcnextTbl != NULL);
3223     for (i = 0; i < afiles; i++) {
3224         afs_dvnextTbl[i] = NULLIDX;
3225         afs_dcnextTbl[i] = NULLIDX;
3226     }
3227
3228     /* Allocate and zero the pointer array to the dcache entries */
3229     afs_indexTable = afs_osi_Alloc(sizeof(struct dcache *) * afiles);
3230     osi_Assert(afs_indexTable != NULL);
3231     memset(afs_indexTable, 0, sizeof(struct dcache *) * afiles);
3232     afs_indexTimes = afs_osi_Alloc(afiles * sizeof(afs_hyper_t));
3233     osi_Assert(afs_indexTimes != NULL);
3234     memset(afs_indexTimes, 0, afiles * sizeof(afs_hyper_t));
3235     afs_indexUnique = afs_osi_Alloc(afiles * sizeof(afs_uint32));
3236     osi_Assert(afs_indexUnique != NULL);
3237     memset(afs_indexUnique, 0, afiles * sizeof(afs_uint32));
3238     afs_indexFlags = afs_osi_Alloc(afiles * sizeof(u_char));
3239     osi_Assert(afs_indexFlags != NULL);
3240     memset(afs_indexFlags, 0, afiles * sizeof(char));
3241
3242     /* Allocate and thread the struct dcache entries themselves */
3243     tdp = afs_Initial_freeDSList =
3244         afs_osi_Alloc(aDentries * sizeof(struct dcache));
3245     osi_Assert(tdp != NULL);
3246     memset(tdp, 0, aDentries * sizeof(struct dcache));
3247 #ifdef  KERNEL_HAVE_PIN
3248     pin((char *)afs_indexTable, sizeof(struct dcache *) * afiles);      /* XXX */
3249     pin((char *)afs_indexTimes, sizeof(afs_hyper_t) * afiles);  /* XXX */
3250     pin((char *)afs_indexFlags, sizeof(char) * afiles); /* XXX */
3251     pin((char *)afs_indexUnique, sizeof(afs_int32) * afiles);   /* XXX */
3252     pin((char *)tdp, aDentries * sizeof(struct dcache));        /* XXX */
3253     pin((char *)afs_dvhashTbl, sizeof(afs_int32) * afs_dhashsize);      /* XXX */
3254     pin((char *)afs_dchashTbl, sizeof(afs_int32) * afs_dhashsize);      /* XXX */
3255     pin((char *)afs_dcnextTbl, sizeof(afs_int32) * afiles);     /* XXX */
3256     pin((char *)afs_dvnextTbl, sizeof(afs_int32) * afiles);     /* XXX */
3257 #endif
3258
3259     afs_freeDSList = &tdp[0];
3260     for (i = 0; i < aDentries - 1; i++) {
3261         tdp[i].lruq.next = (struct afs_q *)(&tdp[i + 1]);
3262         AFS_RWLOCK_INIT(&tdp[i].lock, "dcache lock");
3263         AFS_RWLOCK_INIT(&tdp[i].tlock, "dcache tlock");
3264         AFS_RWLOCK_INIT(&tdp[i].mflock, "dcache flock");
3265     }
3266     tdp[aDentries - 1].lruq.next = (struct afs_q *)0;
3267     AFS_RWLOCK_INIT(&tdp[aDentries - 1].lock, "dcache lock");
3268     AFS_RWLOCK_INIT(&tdp[aDentries - 1].tlock, "dcache tlock");
3269     AFS_RWLOCK_INIT(&tdp[aDentries - 1].mflock, "dcache flock");
3270
3271     afs_stats_cmperf.cacheBlocksOrig = afs_stats_cmperf.cacheBlocksTotal =
3272         afs_cacheBlocks = ablocks;
3273     afs_ComputeCacheParms();    /* compute parms based on cache size */
3274
3275     afs_dcentries = aDentries;
3276     afs_blocksUsed = 0;
3277     afs_stats_cmperf.cacheBucket0_Discarded =
3278         afs_stats_cmperf.cacheBucket1_Discarded =
3279         afs_stats_cmperf.cacheBucket2_Discarded = 0;
3280     afs_DCSizeInit();
3281     QInit(&afs_DLRU);
3282
3283     if (aflags & AFSCALL_INIT_MEMCACHE) {
3284         /*
3285          * Use a memory cache instead of a disk cache
3286          */
3287         cacheDiskType = AFS_FCACHE_TYPE_MEM;
3288         afs_cacheType = &afs_MemCacheOps;
3289         afiles = (afiles < aDentries) ? afiles : aDentries;     /* min */
3290         ablocks = afiles * (AFS_FIRSTCSIZE / 1024);
3291         /* ablocks is reported in 1K blocks */
3292         code = afs_InitMemCache(afiles, AFS_FIRSTCSIZE, aflags);
3293         if (code != 0) {
3294             afs_warn("afsd: memory cache too large for available memory.\n");
3295             afs_warn("afsd: AFS files cannot be accessed.\n\n");
3296             dcacheDisabled = 1;
3297             afiles = ablocks = 0;
3298         } else
3299             afs_warn("Memory cache: Allocating %d dcache entries...",
3300                    aDentries);
3301     } else {
3302         cacheDiskType = AFS_FCACHE_TYPE_UFS;
3303         afs_cacheType = &afs_UfsCacheOps;
3304     }
3305 }
3306
3307 /*!
3308  * Shuts down the cache.
3309  *
3310  */
3311 void
3312 shutdown_dcache(void)
3313 {
3314     int i;
3315
3316 #ifdef AFS_CACHE_VNODE_PATH
3317     if (cacheDiskType != AFS_FCACHE_TYPE_MEM) {
3318         struct dcache *tdc;
3319         for (i = 0; i < afs_cacheFiles; i++) {
3320             tdc = afs_indexTable[i];
3321             if (tdc) {
3322                 afs_osi_FreeStr(tdc->f.inode.ufs);
3323             }
3324         }
3325     }
3326 #endif
3327
3328     afs_osi_Free(afs_dvnextTbl, afs_cacheFiles * sizeof(afs_int32));
3329     afs_osi_Free(afs_dcnextTbl, afs_cacheFiles * sizeof(afs_int32));
3330     afs_osi_Free(afs_indexTable, afs_cacheFiles * sizeof(struct dcache *));
3331     afs_osi_Free(afs_indexTimes, afs_cacheFiles * sizeof(afs_hyper_t));
3332     afs_osi_Free(afs_indexUnique, afs_cacheFiles * sizeof(afs_uint32));
3333     afs_osi_Free(afs_indexFlags, afs_cacheFiles * sizeof(u_char));
3334     afs_osi_Free(afs_Initial_freeDSList,
3335                  afs_dcentries * sizeof(struct dcache));
3336 #ifdef  KERNEL_HAVE_PIN
3337     unpin((char *)afs_dcnextTbl, afs_cacheFiles * sizeof(afs_int32));
3338     unpin((char *)afs_dvnextTbl, afs_cacheFiles * sizeof(afs_int32));
3339     unpin((char *)afs_indexTable, afs_cacheFiles * sizeof(struct dcache *));
3340     unpin((char *)afs_indexTimes, afs_cacheFiles * sizeof(afs_hyper_t));
3341     unpin((char *)afs_indexUnique, afs_cacheFiles * sizeof(afs_uint32));
3342     unpin((u_char *) afs_indexFlags, afs_cacheFiles * sizeof(u_char));
3343     unpin(afs_Initial_freeDSList, afs_dcentries * sizeof(struct dcache));
3344 #endif
3345
3346
3347     for (i = 0; i < afs_dhashsize; i++) {
3348         afs_dvhashTbl[i] = NULLIDX;
3349         afs_dchashTbl[i] = NULLIDX;
3350     }
3351
3352     afs_osi_Free(afs_dvhashTbl, afs_dhashsize * sizeof(afs_int32));
3353     afs_osi_Free(afs_dchashTbl, afs_dhashsize * sizeof(afs_int32));
3354
3355     afs_blocksUsed = afs_dcentries = 0;
3356     afs_stats_cmperf.cacheBucket0_Discarded =
3357         afs_stats_cmperf.cacheBucket1_Discarded =
3358         afs_stats_cmperf.cacheBucket2_Discarded = 0;
3359     hzero(afs_indexCounter);
3360
3361     afs_freeDCCount = 0;
3362     afs_freeDCList = NULLIDX;
3363     afs_discardDCList = NULLIDX;
3364     afs_freeDSList = afs_Initial_freeDSList = 0;
3365
3366     LOCK_INIT(&afs_xdcache, "afs_xdcache");
3367     QInit(&afs_DLRU);
3368
3369 }
3370
3371 /*!
3372  * Get a dcache ready for writing, respecting the current cache size limits
3373  *
3374  * len is required because afs_GetDCache with flag == 4 expects the length
3375  * field to be filled. It decides from this whether it's necessary to fetch
3376  * data into the chunk before writing or not (when the whole chunk is
3377  * overwritten!).
3378  *
3379  * \param avc           The vcache to fetch a dcache for
3380  * \param filePos       The start of the section to be written
3381  * \param len           The length of the section to be written
3382  * \param areq
3383  * \param noLock
3384  *
3385  * \return If successful, a reference counted dcache with tdc->lock held. Lock
3386  *         must be released and afs_PutDCache() called to free dcache.
3387  *         NULL on  failure
3388  *
3389  * \note avc->lock must be held on entry. Function may release and reobtain
3390  *       avc->lock and GLOCK.
3391  */
3392
3393 struct dcache *
3394 afs_ObtainDCacheForWriting(struct vcache *avc, afs_size_t filePos,
3395                            afs_size_t len, struct vrequest *areq,
3396                            int noLock)
3397 {
3398     struct dcache *tdc = NULL;
3399     afs_size_t offset;
3400
3401     /* read the cached info */
3402     if (noLock) {
3403         tdc = afs_FindDCache(avc, filePos);
3404         if (tdc)
3405             ObtainWriteLock(&tdc->lock, 657);
3406     } else if (afs_blocksUsed >
3407                PERCENT(CM_WAITFORDRAINPCT, afs_cacheBlocks)) {
3408         tdc = afs_FindDCache(avc, filePos);
3409         if (tdc) {
3410             ObtainWriteLock(&tdc->lock, 658);
3411             if (!hsame(tdc->f.versionNo, avc->f.m.DataVersion)
3412                 || (tdc->dflags & DFFetching)) {
3413                 ReleaseWriteLock(&tdc->lock);
3414                 afs_PutDCache(tdc);
3415                 tdc = NULL;
3416             }
3417         }
3418         if (!tdc) {
3419             afs_MaybeWakeupTruncateDaemon();
3420             while (afs_blocksUsed >
3421                    PERCENT(CM_WAITFORDRAINPCT, afs_cacheBlocks)) {
3422                 ReleaseWriteLock(&avc->lock);
3423                 if (afs_blocksUsed - afs_blocksDiscarded >
3424                     PERCENT(CM_WAITFORDRAINPCT, afs_cacheBlocks)) {
3425                     afs_WaitForCacheDrain = 1;
3426                     afs_osi_Sleep(&afs_WaitForCacheDrain);
3427                 }
3428                 afs_MaybeFreeDiscardedDCache();
3429                 afs_MaybeWakeupTruncateDaemon();
3430                 ObtainWriteLock(&avc->lock, 509);
3431             }
3432             avc->f.states |= CDirty;
3433             tdc = afs_GetDCache(avc, filePos, areq, &offset, &len, 4);
3434             if (tdc)
3435                 ObtainWriteLock(&tdc->lock, 659);
3436         }
3437     } else {
3438         tdc = afs_GetDCache(avc, filePos, areq, &offset, &len, 4);
3439         if (tdc)
3440             ObtainWriteLock(&tdc->lock, 660);
3441     }
3442     if (tdc) {
3443         if (!(afs_indexFlags[tdc->index] & IFDataMod)) {
3444             afs_stats_cmperf.cacheCurrDirtyChunks++;
3445             afs_indexFlags[tdc->index] |= IFDataMod;    /* so it doesn't disappear */
3446         }
3447         if (!(tdc->f.states & DWriting)) {
3448             /* don't mark entry as mod if we don't have to */
3449             tdc->f.states |= DWriting;
3450             tdc->dflags |= DFEntryMod;
3451         }
3452     }
3453     return tdc;
3454 }
3455
3456 /*!
3457  * Make a shadow copy of a dir's dcache. It's used for disconnected
3458  * operations like remove/create/rename to keep the original directory data.
3459  * On reconnection, we can diff the original data with the server and get the
3460  * server changes and with the local data to get the local changes.
3461  *
3462  * \param avc The dir vnode.
3463  * \param adc The dir dcache.
3464  *
3465  * \return 0 for success.
3466  *
3467  * \note The vcache entry must be write locked.
3468  * \note The dcache entry must be read locked.
3469  */
3470 int
3471 afs_MakeShadowDir(struct vcache *avc, struct dcache *adc)
3472 {
3473     int i, code, ret_code = 0, written, trans_size;
3474     struct dcache *new_dc = NULL;
3475     struct osi_file *tfile_src, *tfile_dst;
3476     struct VenusFid shadow_fid;
3477     char *data;
3478
3479     /* Is this a dir? */
3480     if (vType(avc) != VDIR)
3481         return ENOTDIR;
3482
3483     if (avc->f.shadow.vnode || avc->f.shadow.unique)
3484         return EEXIST;
3485
3486     /* Generate a fid for the shadow dir. */
3487     shadow_fid.Cell = avc->f.fid.Cell;
3488     shadow_fid.Fid.Volume = avc->f.fid.Fid.Volume;
3489     afs_GenShadowFid(&shadow_fid);
3490
3491     ObtainWriteLock(&afs_xdcache, 716);
3492
3493     /* Get a fresh dcache. */
3494     new_dc = afs_AllocDCache(avc, 0, 0, &shadow_fid);
3495     osi_Assert(new_dc);
3496
3497     ObtainReadLock(&adc->mflock);
3498
3499     /* Set up the new fid. */
3500     /* Copy interesting data from original dir dcache. */
3501     new_dc->mflags = adc->mflags;
3502     new_dc->dflags = adc->dflags;
3503     new_dc->f.modTime = adc->f.modTime;
3504     new_dc->f.versionNo = adc->f.versionNo;
3505     new_dc->f.states = adc->f.states;
3506     new_dc->f.chunk= adc->f.chunk;
3507     new_dc->f.chunkBytes = adc->f.chunkBytes;
3508
3509     ReleaseReadLock(&adc->mflock);
3510
3511     /* Now add to the two hash chains */
3512     i = DCHash(&shadow_fid, 0);
3513     afs_dcnextTbl[new_dc->index] = afs_dchashTbl[i];
3514     afs_dchashTbl[i] = new_dc->index;
3515
3516     i = DVHash(&shadow_fid);
3517     afs_dvnextTbl[new_dc->index] = afs_dvhashTbl[i];
3518     afs_dvhashTbl[i] = new_dc->index;
3519
3520     ReleaseWriteLock(&afs_xdcache);
3521
3522     /* Alloc a 4k block. */
3523     data = afs_osi_Alloc(4096);
3524     if (!data) {
3525         afs_warn("afs_MakeShadowDir: could not alloc data\n");
3526         ret_code = ENOMEM;
3527         goto done;
3528     }
3529
3530     /* Open the files. */
3531     tfile_src = afs_CFileOpen(&adc->f.inode);
3532     tfile_dst = afs_CFileOpen(&new_dc->f.inode);
3533
3534     /* And now copy dir dcache data into this dcache,
3535      * 4k at a time.
3536      */
3537     written = 0;
3538     while (written < adc->f.chunkBytes) {
3539         trans_size = adc->f.chunkBytes - written;
3540         if (trans_size > 4096)
3541             trans_size = 4096;
3542
3543         /* Read a chunk from the dcache. */
3544         code = afs_CFileRead(tfile_src, written, data, trans_size);
3545         if (code < trans_size) {
3546             ret_code = EIO;
3547             break;
3548         }
3549
3550         /* Write it to the new dcache. */
3551         code = afs_CFileWrite(tfile_dst, written, data, trans_size);
3552         if (code < trans_size) {
3553             ret_code = EIO;
3554             break;
3555         }
3556
3557         written+=trans_size;
3558     }
3559
3560     afs_CFileClose(tfile_dst);