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