src/afs/afs_dcache.c

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