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