src/afs/afs_dcache.c

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