src/WINNT/afsd/cm_buf.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 /* Copyright (C) 1994 Cazamar Systems, Inc. */
  11
  12 #include <afsconfig.h>
  13 #include <afs/param.h>
  14 #include <roken.h>
  15
  16 #include <afs/stds.h>
  17
  18 #include <windows.h>
  19 #include <osi.h>
  20 #include <stdio.h>
  21 #include <strsafe.h>
  22 #include <math.h>
  23 #include <hcrypto\md5.h>
  24
  25 #include "afsd.h"
  26 #include "cm_memmap.h"
  27
  28 #ifdef DEBUG
  29 #define TRACE_BUFFER 1
  30 #endif
  31
  32 extern void afsi_log(char *pattern, ...);
  33
  34 /* This module implements the buffer package used by the local transaction
  35  * system (cm).  It is initialized by calling cm_Init, which calls buf_Init;
  36  * it must be initalized before any of its main routines are called.
  37  *
  38  * Each buffer is hashed into a hash table by file ID and offset, and if its
  39  * reference count is zero, it is also in a free list.
  40  *
  41  * There are two locks involved in buffer processing.  The global lock
  42  * buf_globalLock protects all of the global variables defined in this module,
  43  * the reference counts and hash pointers in the actual cm_buf_t structures,
  44  * and the LRU queue pointers in the buffer structures.
  45  *
  46  * The mutexes in the buffer structures protect the remaining fields in the
  47  * buffers, as well the data itself.
  48  *
  49  * The locking hierarchy here is this:
  50  *
  51  * - resv multiple simul. buffers reservation
  52  * - lock buffer I/O flags
  53  * - lock buffer's mutex
  54  * - lock buf_globalLock
  55  *
  56  */
  57
  58 /* global debugging log */
  59 osi_log_t *buf_logp = NULL;
  60
  61 /* Global lock protecting hash tables and free lists */
  62 osi_rwlock_t buf_globalLock;
  63
  64 /* Global lock used to limit the number of RDR Release
  65  * Extents requests to one. */
  66 osi_mutex_t buf_rdrReleaseExtentsLock;
  67
  68 /* ptr to head of the free list (most recently used) and the
  69  * tail (the guy to remove first).  We use osi_Q* functions
  70  * to put stuff in buf_freeListp, and maintain the end
  71  * pointer manually
  72  */
  73
  74 /* a pointer to a list of all buffers, just so that we can find them
  75  * easily for debugging, and for the incr syncer.  Locked under
  76  * the global lock.
  77  */
  78
  79 /* defaults setup; these variables may be manually assigned into
  80  * before calling cm_Init, as a way of changing these defaults.
  81  */
  82
  83 /* callouts for reading and writing data, etc */
  84 cm_buf_ops_t *cm_buf_opsp;
  85
  86 #ifdef DISKCACHE95
  87 /* for experimental disk caching support in Win95 client */
  88 cm_buf_t *buf_diskFreeListp;
  89 cm_buf_t *buf_diskFreeListEndp;
  90 cm_buf_t *buf_diskAllp;
  91 extern int cm_diskCacheEnabled;
  92 #endif /* DISKCACHE95 */
  93
  94 /* set this to 1 when we are terminating to prevent access attempts */
  95 static int buf_ShutdownFlag = 0;
  96
  97 #ifdef DEBUG_REFCOUNT
  98 void buf_HoldLockedDbg(cm_buf_t *bp, char *file, long line)
  99 #else
 100 void buf_HoldLocked(cm_buf_t *bp)
 101 #endif
 102 {
 103     afs_int32 refCount;
 104
 105     osi_assertx(bp->magic == CM_BUF_MAGIC,"incorrect cm_buf_t magic");
 106     refCount = InterlockedIncrement(&bp->refCount);
 107 #ifdef DEBUG_REFCOUNT
 108     osi_Log2(afsd_logp,"buf_HoldLocked bp 0x%p ref %d",bp, refCount);
 109     afsi_log("%s:%d buf_HoldLocked bp 0x%p, ref %d", file, line, bp, refCount);
 110 #endif
 111 }
 112
 113 /* hold a reference to an already held buffer */
 114 #ifdef DEBUG_REFCOUNT
 115 void buf_HoldDbg(cm_buf_t *bp, char *file, long line)
 116 #else
 117 void buf_Hold(cm_buf_t *bp)
 118 #endif
 119 {
 120     afs_int32 refCount;
 121
 122     lock_ObtainRead(&buf_globalLock);
 123     osi_assertx(bp->magic == CM_BUF_MAGIC,"incorrect cm_buf_t magic");
 124     refCount = InterlockedIncrement(&bp->refCount);
 125 #ifdef DEBUG_REFCOUNT
 126     osi_Log2(afsd_logp,"buf_Hold bp 0x%p ref %d",bp, refCount);
 127     afsi_log("%s:%d buf_Hold bp 0x%p, ref %d", file, line, bp, refCount);
 128 #endif
 129     lock_ReleaseRead(&buf_globalLock);
 130 }
 131
 132 /* code to drop reference count while holding buf_globalLock */
 133 #ifdef DEBUG_REFCOUNT
 134 void buf_ReleaseLockedDbg(cm_buf_t *bp, afs_uint32 writeLocked, char *file, long line)
 135 #else
 136 void buf_ReleaseLocked(cm_buf_t *bp, afs_uint32 writeLocked)
 137 #endif
 138 {
 139     afs_int32 refCount;
 140
 141     if (writeLocked)
 142         lock_AssertWrite(&buf_globalLock);
 143     else
 144         lock_AssertRead(&buf_globalLock);
 145
 146     /* ensure that we're in the LRU queue if our ref count is 0 */
 147     osi_assertx(bp->magic == CM_BUF_MAGIC,"incorrect cm_buf_t magic");
 148
 149     refCount = InterlockedDecrement(&bp->refCount);
 150 #ifdef DEBUG_REFCOUNT
 151     osi_Log3(afsd_logp,"buf_ReleaseLocked %s bp 0x%p ref %d",writeLocked?"write":"read", bp, refCount);
 152     afsi_log("%s:%d buf_ReleaseLocked %s bp 0x%p, ref %d", file, line, writeLocked?"write":"read", bp, refCount);
 153 #endif
 154 #ifdef DEBUG
 155     if (refCount < 0)
 156         osi_panic("buf refcount 0",__FILE__,__LINE__);;
 157 #else
 158     osi_assertx(refCount >= 0, "cm_buf_t refCount == 0");
 159 #endif
 160     if (refCount == 0) {
 161         /*
 162          * If we are read locked there could be a race condition
 163          * with buf_Find() so we must obtain a write lock and
 164          * double check that the refCount is actually zero
 165          * before we remove the buffer from the LRU queue.
 166          */
 167         if (!writeLocked)
 168             lock_ConvertRToW(&buf_globalLock);
 169
 170         if (bp->refCount == 0 &&
 171             !(bp->qFlags & (CM_BUF_QINLRU|CM_BUF_QREDIR))) {
 172             osi_QAddH( (osi_queue_t **) &cm_data.buf_freeListp,
 173                        (osi_queue_t **) &cm_data.buf_freeListEndp,
 174                        &bp->q);
 175             _InterlockedOr(&bp->qFlags, CM_BUF_QINLRU);
 176             buf_IncrementFreeCount();
 177         }
 178
 179         if (!writeLocked)
 180             lock_ConvertWToR(&buf_globalLock);
 181     }
 182 }
 183
 184 /* release a buffer.  Buffer must be referenced, but unlocked. */
 185 #ifdef DEBUG_REFCOUNT
 186 void buf_ReleaseDbg(cm_buf_t *bp, char *file, long line)
 187 #else
 188 void buf_Release(cm_buf_t *bp)
 189 #endif
 190 {
 191     afs_int32 refCount;
 192
 193     /* ensure that we're in the LRU queue if our ref count is 0 */
 194     osi_assertx(bp->magic == CM_BUF_MAGIC,"incorrect cm_buf_t magic");
 195
 196     refCount = InterlockedDecrement(&bp->refCount);
 197 #ifdef DEBUG_REFCOUNT
 198     osi_Log2(afsd_logp,"buf_Release bp 0x%p ref %d", bp, refCount);
 199     afsi_log("%s:%d buf_ReleaseLocked bp 0x%p, ref %d", file, line, bp, refCount);
 200 #endif
 201 #ifdef DEBUG
 202     if (refCount < 0)
 203         osi_panic("buf refcount 0",__FILE__,__LINE__);;
 204 #else
 205     osi_assertx(refCount >= 0, "cm_buf_t refCount == 0");
 206 #endif
 207     if (refCount == 0) {
 208         lock_ObtainWrite(&buf_globalLock);
 209         if (bp->refCount == 0 &&
 210             !(bp->qFlags & (CM_BUF_QINLRU|CM_BUF_QREDIR))) {
 211             osi_QAddH( (osi_queue_t **) &cm_data.buf_freeListp,
 212                        (osi_queue_t **) &cm_data.buf_freeListEndp,
 213                        &bp->q);
 214             _InterlockedOr(&bp->qFlags, CM_BUF_QINLRU);
 215             buf_IncrementFreeCount();
 216         }
 217         lock_ReleaseWrite(&buf_globalLock);
 218     }
 219 }
 220
 221 long
 222 buf_Sync(int quitOnShutdown)
 223 {
 224     cm_buf_t **bpp, *bp, *prevbp;
 225     afs_uint32 wasDirty = 0;
 226     cm_req_t req;
 227
 228     /* go through all of the dirty buffers */
 229     lock_ObtainRead(&buf_globalLock);
 230     for (bpp = &cm_data.buf_dirtyListp, prevbp = NULL; bp = *bpp; ) {
 231         if (quitOnShutdown && buf_ShutdownFlag)
 232             break;
 233
 234         /*
 235          * If the buffer is held be the redirector we must fetch
 236          * it back in order to determine whether or not it is in
 237          * fact dirty.
 238          */
 239         if (bp->qFlags & CM_BUF_QREDIR) {
 240             osi_Log1(buf_logp,"buf_Sync buffer held by redirector bp 0x%p", bp);
 241
 242             /* Request single buffer from the redirector */
 243             buf_RDRShakeAnExtentFree(bp, &req);
 244         }
 245
 246         lock_ReleaseRead(&buf_globalLock);
 247         /*
 248          * all dirty buffers are held when they are added to the
 249          * dirty list.  No need for an additional hold.
 250          */
 251         lock_ObtainMutex(&bp->mx);
 252
 253         if ((bp->flags & CM_BUF_DIRTY)) {
 254             /* start cleaning the buffer; don't touch log pages since
 255              * the log code counts on knowing exactly who is writing
 256              * a log page at any given instant.
 257              *
 258              * only attempt to write the buffer if the volume might
 259              * be online.
 260              */
 261             afs_uint32 dirty;
 262             cm_volume_t * volp;
 263
 264             volp = cm_GetVolumeByFID(&bp->fid);
 265             switch (cm_GetVolumeStatus(volp, bp->fid.volume)) {
 266             case vl_online:
 267             case vl_unknown:
 268                 cm_InitReq(&req);
 269                 req.flags |= CM_REQ_NORETRY;
 270                 buf_CleanAsyncLocked(NULL, bp, &req, 0, &dirty);
 271                 wasDirty |= dirty;
 272             }
 273             cm_PutVolume(volp);
 274         }
 275
 276         /* the buffer may or may not have been dirty
 277         * and if dirty may or may not have been cleaned
 278         * successfully.  check the dirty flag again.
 279         */
 280         if (!(bp->flags & CM_BUF_DIRTY)) {
 281             /* remove the buffer from the dirty list */
 282             lock_ObtainWrite(&buf_globalLock);
 283 #ifdef DEBUG_REFCOUNT
 284             if (bp->dirtyp == NULL && bp != cm_data.buf_dirtyListEndp) {
 285                 osi_Log1(afsd_logp,"buf_Sync bp 0x%p list corruption",bp);
 286                 afsi_log("buf_Sync bp 0x%p list corruption", bp);
 287             }
 288 #endif
 289             *bpp = bp->dirtyp;
 290             bp->dirtyp = NULL;
 291             _InterlockedAnd(&bp->qFlags, ~CM_BUF_QINDL);
 292             if (cm_data.buf_dirtyListp == NULL)
 293                 cm_data.buf_dirtyListEndp = NULL;
 294             else if (cm_data.buf_dirtyListEndp == bp)
 295                 cm_data.buf_dirtyListEndp = prevbp;
 296             buf_ReleaseLocked(bp, TRUE);
 297             lock_ConvertWToR(&buf_globalLock);
 298         } else {
 299             if (buf_ShutdownFlag) {
 300                 cm_cell_t *cellp;
 301                 cm_volume_t *volp;
 302                 char volstr[VL_MAXNAMELEN+12]="";
 303                 char *ext = "";
 304
 305                 volp = cm_GetVolumeByFID(&bp->fid);
 306                 if (volp) {
 307                     cellp = volp->cellp;
 308                     if (bp->fid.volume == volp->vol[RWVOL].ID)
 309                         ext = "";
 310                     else if (bp->fid.volume == volp->vol[ROVOL].ID)
 311                         ext = ".readonly";
 312                     else if (bp->fid.volume == volp->vol[BACKVOL].ID)
 313                         ext = ".backup";
 314                     else
 315                         ext = ".nomatch";
 316                     snprintf(volstr, sizeof(volstr), "%s%s", volp->namep, ext);
 317                 } else {
 318                     cellp = cm_FindCellByID(bp->fid.cell, CM_FLAG_NOPROBE);
 319                     snprintf(volstr, sizeof(volstr), "%u", bp->fid.volume);
 320                 }
 321
 322                 LogEvent(EVENTLOG_INFORMATION_TYPE, MSG_DIRTY_BUFFER_AT_SHUTDOWN,
 323                          cellp->name, volstr, bp->fid.vnode, bp->fid.unique,
 324                          bp->offset.QuadPart+bp->dirty_offset, bp->dirty_length);
 325             }
 326
 327             /* advance the pointer so we don't loop forever */
 328             lock_ObtainRead(&buf_globalLock);
 329             bpp = &bp->dirtyp;
 330             prevbp = bp;
 331         }
 332         lock_ReleaseMutex(&bp->mx);
 333     }   /* for loop over a bunch of buffers */
 334     lock_ReleaseRead(&buf_globalLock);
 335
 336     return wasDirty;
 337 }
 338
 339 /* incremental sync daemon.  Writes all dirty buffers every 5000 ms */
 340 void buf_IncrSyncer(long parm)
 341 {
 342     long wasDirty = 0;
 343     long i;
 344
 345     while (buf_ShutdownFlag == 0) {
 346         if (!wasDirty) {
 347             i = SleepEx(5000, 1);
 348             if (i != 0)
 349                 continue;
 350         } else {
 351             Sleep(50);
 352         }
 353
 354         wasDirty = buf_Sync(1);
 355     } /* whole daemon's while loop */
 356 }
 357
 358 long
 359 buf_ValidateBuffers(void)
 360 {
 361     cm_buf_t * bp, *bpf, *bpa, *bpb;
 362     afs_uint64 countb = 0, countf = 0, counta = 0, countr = 0;
 363
 364     if (cm_data.buf_freeListp == NULL && cm_data.buf_freeListEndp != NULL ||
 365          cm_data.buf_freeListp != NULL && cm_data.buf_freeListEndp == NULL) {
 366         afsi_log("cm_ValidateBuffers failure: inconsistent free list pointers");
 367         fprintf(stderr, "cm_ValidateBuffers failure: inconsistent free list pointers\n");
 368         return -9;
 369     }
 370
 371     for (bp = cm_data.buf_freeListEndp; bp; bp=(cm_buf_t *) osi_QPrev(&bp->q)) {
 372         if (bp->magic != CM_BUF_MAGIC) {
 373             afsi_log("cm_ValidateBuffers failure: bp->magic != CM_BUF_MAGIC");
 374             fprintf(stderr, "cm_ValidateBuffers failure: bp->magic != CM_BUF_MAGIC\n");
 375             return -1;
 376         }
 377         countb++;
 378         bpb = bp;
 379
 380         if (countb > cm_data.buf_nbuffers) {
 381             afsi_log("cm_ValidateBuffers failure: countb > cm_data.buf_nbuffers");
 382             fprintf(stderr, "cm_ValidateBuffers failure: countb > cm_data.buf_nbuffers\n");
 383             return -6;
 384         }
 385     }
 386
 387     for (bp = cm_data.buf_freeListp; bp; bp=(cm_buf_t *) osi_QNext(&bp->q)) {
 388         if (bp->magic != CM_BUF_MAGIC) {
 389             afsi_log("cm_ValidateBuffers failure: bp->magic != CM_BUF_MAGIC");
 390             fprintf(stderr, "cm_ValidateBuffers failure: bp->magic != CM_BUF_MAGIC\n");
 391             return -2;
 392         }
 393         countf++;
 394         bpf = bp;
 395
 396         if (countf > cm_data.buf_nbuffers) {
 397             afsi_log("cm_ValidateBuffers failure: countf > cm_data.buf_nbuffers");
 398             fprintf(stderr, "cm_ValidateBuffers failure: countf > cm_data.buf_nbuffers\n");
 399             return -7;
 400         }
 401     }
 402
 403     for ( bp = cm_data.buf_redirListp; bp; bp = (cm_buf_t *) osi_QNext(&bp->q)) {
 404         if (!(bp->qFlags & CM_BUF_QREDIR)) {
 405             afsi_log("CM_BUF_QREDIR not set on cm_buf_t in buf_redirListp");
 406             fprintf(stderr, "CM_BUF_QREDIR not set on cm_buf_t in buf_redirListp");
 407             return -9;
 408         }
 409         countr++;
 410         if (countr > cm_data.buf_nbuffers) {
 411             afsi_log("cm_ValidateBuffers failure: countr > cm_data.buf_nbuffers");
 412             fprintf(stderr, "cm_ValidateBuffers failure: countr > cm_data.buf_nbuffers\n");
 413             return -10;
 414         }
 415     }
 416
 417     for (bp = cm_data.buf_allp; bp; bp=bp->allp) {
 418         if (bp->magic != CM_BUF_MAGIC) {
 419             afsi_log("cm_ValidateBuffers failure: bp->magic != CM_BUF_MAGIC");
 420             fprintf(stderr, "cm_ValidateBuffers failure: bp->magic != CM_BUF_MAGIC\n");
 421             return -3;
 422         }
 423         counta++;
 424         bpa = bp;
 425
 426         if (counta > cm_data.buf_nbuffers) {
 427             afsi_log("cm_ValidateBuffers failure: counta > cm_data.buf_nbuffers");
 428             fprintf(stderr, "cm_ValidateBuffers failure: counta > cm_data.buf_nbuffers\n");
 429             return -8;
 430         }
 431     }
 432
 433     if (countb != countf) {
 434         afsi_log("cm_ValidateBuffers failure: countb != countf");
 435         fprintf(stderr, "cm_ValidateBuffers failure: countb != countf\n");
 436         return -4;
 437     }
 438
 439     if (counta != cm_data.buf_nbuffers) {
 440         afsi_log("cm_ValidateBuffers failure: counta != cm_data.buf_nbuffers");
 441         fprintf(stderr, "cm_ValidateBuffers failure: counta != cm_data.buf_nbuffers\n");
 442         return -5;
 443     }
 444
 445     return 0;
 446 }
 447
 448 void buf_Shutdown(void)
 449 {
 450     /* disable the buf_IncrSyncer() threads */
 451     buf_ShutdownFlag = 1;
 452
 453     /* then force all dirty buffers to the file servers */
 454     buf_Sync(0);
 455 }
 456
 457 /* initialize the buffer package; called with no locks
 458  * held during the initialization phase.
 459  */
 460 long buf_Init(int newFile, cm_buf_ops_t *opsp, afs_uint64 nbuffers)
 461 {
 462     static osi_once_t once;
 463     cm_buf_t *bp;
 464     thread_t phandle;
 465     long i;
 466     unsigned long pid;
 467     char *data;
 468
 469     if ( newFile ) {
 470         if (nbuffers)
 471             cm_data.buf_nbuffers = nbuffers;
 472
 473         /* Have to be able to reserve a whole chunk */
 474         if (((cm_data.buf_nbuffers - 3) * cm_data.buf_blockSize) < cm_chunkSize)
 475             return CM_ERROR_TOOFEWBUFS;
 476     }
 477
 478     /* recall for callouts */
 479     cm_buf_opsp = opsp;
 480
 481     if (osi_Once(&once)) {
 482         /* initialize global locks */
 483         lock_InitializeRWLock(&buf_globalLock, "Global buffer lock", LOCK_HIERARCHY_BUF_GLOBAL);
 484         lock_InitializeMutex(&buf_rdrReleaseExtentsLock, "RDR Release Extents lock", LOCK_HIERARCHY_RDR_EXTENTS);
 485
 486         if ( newFile ) {
 487             /* remember this for those who want to reset it */
 488             cm_data.buf_nOrigBuffers = cm_data.buf_nbuffers;
 489
 490             /* lower hash size to a prime number */
 491             cm_data.buf_hashSize = osi_PrimeLessThan((afs_uint32)(cm_data.buf_nbuffers/7 + 1));
 492
 493             /* create hash table */
 494             memset((void *)cm_data.buf_scacheHashTablepp, 0, cm_data.buf_hashSize * sizeof(cm_buf_t *));
 495
 496             /* another hash table */
 497             memset((void *)cm_data.buf_fileHashTablepp, 0, cm_data.buf_hashSize * sizeof(cm_buf_t *));
 498
 499             /* create buffer headers and put in free list */
 500             bp = cm_data.bufHeaderBaseAddress;
 501             data = cm_data.bufDataBaseAddress;
 502             cm_data.buf_allp = NULL;
 503
 504             for (i=0; i<cm_data.buf_nbuffers; i++) {
 505                 osi_assertx(bp >= cm_data.bufHeaderBaseAddress && bp < (cm_buf_t *)cm_data.bufDataBaseAddress,
 506                             "invalid cm_buf_t address");
 507                 osi_assertx(data >= cm_data.bufDataBaseAddress && data < cm_data.bufEndOfData,
 508                             "invalid cm_buf_t data address");
 509
 510                 /* allocate and zero some storage */
 511                 memset(bp, 0, sizeof(cm_buf_t));
 512                 bp->magic = CM_BUF_MAGIC;
 513                 /* thread on list of all buffers */
 514                 bp->allp = cm_data.buf_allp;
 515                 cm_data.buf_allp = bp;
 516
 517                 osi_QAddH( (osi_queue_t **) &cm_data.buf_freeListp,
 518                            (osi_queue_t **) &cm_data.buf_freeListEndp,
 519                            &bp->q);
 520                 _InterlockedOr(&bp->qFlags, CM_BUF_QINLRU);
 521                 buf_IncrementFreeCount();
 522                 lock_InitializeMutex(&bp->mx, "Buffer mutex", LOCK_HIERARCHY_BUFFER);
 523
 524                 /* grab appropriate number of bytes from aligned zone */
 525                 bp->datap = data;
 526
 527                 /* next */
 528                 bp++;
 529                 data += cm_data.buf_blockSize;
 530             }
 531
 532             /* none reserved at first */
 533             cm_data.buf_reservedBufs = 0;
 534
 535             /* just for safety's sake */
 536             cm_data.buf_maxReservedBufs = cm_data.buf_nbuffers - 3;
 537         } else {
 538             bp = cm_data.bufHeaderBaseAddress;
 539             data = cm_data.bufDataBaseAddress;
 540
 541             for (i=0; i<cm_data.buf_nbuffers; i++) {
 542                 lock_InitializeMutex(&bp->mx, "Buffer mutex", LOCK_HIERARCHY_BUFFER);
 543                 bp->userp = NULL;
 544                 bp->waitCount = 0;
 545                 bp->waitRequests = 0;
 546                 _InterlockedAnd(&bp->flags, ~CM_BUF_WAITING);
 547                 bp->error = 0;
 548                 if (bp->qFlags & CM_BUF_QREDIR) {
 549                     /*
 550                      * extent was not returned by the file system driver.
 551                      * clean up the mess.
 552                      */
 553                     bp->dataVersion = CM_BUF_VERSION_BAD;
 554                     _InterlockedAnd(&bp->qFlags, ~CM_BUF_QREDIR);
 555                     osi_QRemoveHT( (osi_queue_t **) &cm_data.buf_redirListp,
 556                                    (osi_queue_t **) &cm_data.buf_redirListEndp,
 557                                    &bp->q);
 558                     buf_DecrementRedirCount();
 559                     bp->redirq.nextp = bp->redirq.prevp = NULL;
 560                     bp->redirLastAccess = 0;
 561                     bp->redirReleaseRequested = 0;
 562                     buf_Release(bp);
 563                 }
 564                 bp++;
 565             }
 566
 567             /*
 568              * There should be nothing left in cm_data.buf_redirListp
 569              * but double check just to be sure.
 570              */
 571             for ( bp = cm_data.buf_redirListp;
 572                   bp;
 573                   bp = cm_data.buf_redirListp)
 574             {
 575                 /*
 576                  * extent was not returned by the file system driver.
 577                  * clean up the mess.
 578                  */
 579                 bp->dataVersion = CM_BUF_VERSION_BAD;
 580                 _InterlockedAnd(&bp->qFlags, ~CM_BUF_QREDIR);
 581                 osi_QRemoveHT( (osi_queue_t **) &cm_data.buf_redirListp,
 582                                (osi_queue_t **) &cm_data.buf_redirListEndp,
 583                                &bp->q);
 584                 buf_DecrementRedirCount();
 585                 bp->redirq.nextp = bp->redirq.prevp = NULL;
 586                 bp->redirLastAccess = 0;
 587                 bp->redirReleaseRequested = 0;
 588                 buf_Release(bp);
 589             }
 590         }
 591
 592 #ifdef TESTING
 593         buf_ValidateBufQueues();
 594 #endif /* TESTING */
 595
 596 #ifdef TRACE_BUFFER
 597         /* init the buffer trace log */
 598         buf_logp = osi_LogCreate("buffer", 1000);
 599         osi_LogEnable(buf_logp);
 600 #endif
 601
 602         osi_EndOnce(&once);
 603
 604         /* and create the incr-syncer */
 605         phandle = thrd_Create(0, 0,
 606                                (ThreadFunc) buf_IncrSyncer, 0, 0, &pid,
 607                                "buf_IncrSyncer");
 608
 609         osi_assertx(phandle != NULL, "buf: can't create incremental sync proc");
 610         CloseHandle(phandle);
 611     }
 612
 613 #ifdef TESTING
 614     buf_ValidateBufQueues();
 615 #endif /* TESTING */
 616     return 0;
 617 }
 618
 619 /* add nbuffers to the buffer pool, if possible.
 620  * Called with no locks held.
 621  */
 622 long buf_AddBuffers(afs_uint64 nbuffers)
 623 {
 624     /* The size of a virtual cache cannot be changed after it has
 625      * been created.  Subsequent calls to MapViewofFile() with
 626      * an existing mapping object name would not allow the
 627      * object to be resized.  Return failure immediately.
 628      *
 629      * A similar problem now occurs with the persistent cache
 630      * given that the memory mapped file now contains a complex
 631      * data structure.
 632      */
 633     afsi_log("request to add %d buffers to the existing cache of size %d denied",
 634               nbuffers, cm_data.buf_nbuffers);
 635
 636     return CM_ERROR_INVAL;
 637 }
 638
 639 /* interface to set the number of buffers to an exact figure.
 640  * Called with no locks held.
 641  */
 642 long buf_SetNBuffers(afs_uint64 nbuffers)
 643 {
 644     if (nbuffers < 10)
 645         return CM_ERROR_INVAL;
 646     if (nbuffers == cm_data.buf_nbuffers)
 647         return 0;
 648     else if (nbuffers > cm_data.buf_nbuffers)
 649         return buf_AddBuffers(nbuffers - cm_data.buf_nbuffers);
 650     else
 651         return CM_ERROR_INVAL;
 652 }
 653
 654 /* wait for reading or writing to clear; called with write-locked
 655  * buffer and unlocked scp and returns with locked buffer.
 656  */
 657 void buf_WaitIO(cm_scache_t * scp, cm_buf_t *bp)
 658 {
 659     int release = 0;
 660
 661     if (scp)
 662         osi_assertx(scp->magic == CM_SCACHE_MAGIC, "invalid cm_scache_t magic");
 663     osi_assertx(bp->magic == CM_BUF_MAGIC, "invalid cm_buf_t magic");
 664
 665     while (1) {
 666         /* if no IO is happening, we're done */
 667         if (!(bp->flags & (CM_BUF_READING | CM_BUF_WRITING)))
 668             break;
 669
 670         /* otherwise I/O is happening, but some other thread is waiting for
 671          * the I/O already.  Wait for that guy to figure out what happened,
 672          * and then check again.
 673          */
 674         if ( bp->flags & CM_BUF_WAITING ) {
 675             bp->waitCount++;
 676             bp->waitRequests++;
 677             osi_Log1(buf_logp, "buf_WaitIO CM_BUF_WAITING already set for 0x%p", bp);
 678         } else {
 679             osi_Log1(buf_logp, "buf_WaitIO CM_BUF_WAITING set for 0x%p", bp);
 680             _InterlockedOr(&bp->flags, CM_BUF_WAITING);
 681             bp->waitCount = bp->waitRequests = 1;
 682         }
 683         osi_SleepM((LONG_PTR)bp, &bp->mx);
 684
 685         cm_UpdateServerPriority();
 686
 687         lock_ObtainMutex(&bp->mx);
 688         osi_Log1(buf_logp, "buf_WaitIO conflict wait done for 0x%p", bp);
 689         bp->waitCount--;
 690         if (bp->waitCount == 0) {
 691             osi_Log1(buf_logp, "buf_WaitIO CM_BUF_WAITING reset for 0x%p", bp);
 692             _InterlockedAnd(&bp->flags, ~CM_BUF_WAITING);
 693             bp->waitRequests = 0;
 694         }
 695
 696         if ( !scp ) {
 697             if (scp = cm_FindSCache(&bp->fid))
 698                  release = 1;
 699         }
 700         if ( scp ) {
 701             lock_ObtainRead(&scp->rw);
 702             if (scp->flags & CM_SCACHEFLAG_WAITING) {
 703                 osi_Log1(buf_logp, "buf_WaitIO waking scp 0x%p", scp);
 704                 osi_Wakeup((LONG_PTR)&scp->flags);
 705             }
 706             lock_ReleaseRead(&scp->rw);
 707         }
 708     }
 709
 710     /* if we get here, the IO is done, but we may have to wakeup people waiting for
 711      * the I/O to complete.  Do so.
 712      */
 713     if (bp->flags & CM_BUF_WAITING) {
 714         osi_Log1(buf_logp, "buf_WaitIO Waking bp 0x%p", bp);
 715         osi_Wakeup((LONG_PTR) bp);
 716     }
 717     osi_Log1(buf_logp, "WaitIO finished wait for bp 0x%p", bp);
 718
 719     if (scp && release)
 720         cm_ReleaseSCache(scp);
 721 }
 722
 723 /* find a buffer, if any, for a particular file ID and offset.  Assumes
 724  * that buf_globalLock is write locked when called.
 725  */
 726 cm_buf_t *buf_FindLocked(struct cm_fid *fidp, osi_hyper_t *offsetp)
 727 {
 728     afs_uint32 i;
 729     cm_buf_t *bp;
 730
 731     lock_AssertAny(&buf_globalLock);
 732
 733     i = BUF_HASH(fidp, offsetp);
 734     for(bp = cm_data.buf_scacheHashTablepp[i]; bp; bp=bp->hashp) {
 735         if (cm_FidCmp(fidp, &bp->fid) == 0
 736              && offsetp->LowPart == bp->offset.LowPart
 737              && offsetp->HighPart == bp->offset.HighPart) {
 738             buf_HoldLocked(bp);
 739             break;
 740         }
 741     }
 742
 743     /* return whatever we found, if anything */
 744     return bp;
 745 }
 746
 747 /* find a buffer with offset *offsetp for vnode *scp.  Called
 748  * with no locks held.
 749  */
 750 cm_buf_t *buf_Find(struct cm_fid *fidp, osi_hyper_t *offsetp)
 751 {
 752     cm_buf_t *bp;
 753
 754     lock_ObtainRead(&buf_globalLock);
 755     bp = buf_FindLocked(fidp, offsetp);
 756     lock_ReleaseRead(&buf_globalLock);
 757
 758     return bp;
 759 }
 760
 761 /* find a buffer, if any, for a particular file ID and offset.  Assumes
 762  * that buf_globalLock is write locked when called.  Uses the all buffer
 763  * list.
 764  */
 765 cm_buf_t *buf_FindAllLocked(struct cm_fid *fidp, osi_hyper_t *offsetp, afs_uint32 flags)
 766 {
 767     cm_buf_t *bp;
 768
 769     if (flags == 0) {
 770         for(bp = cm_data.buf_allp; bp; bp=bp->allp) {
 771             if (cm_FidCmp(fidp, &bp->fid) == 0
 772                  && offsetp->LowPart == bp->offset.LowPart
 773                  && offsetp->HighPart == bp->offset.HighPart) {
 774                 buf_HoldLocked(bp);
 775                 break;
 776             }
 777         }
 778     } else {
 779         for(bp = cm_data.buf_allp; bp; bp=bp->allp) {
 780             if (cm_FidCmp(fidp, &bp->fid) == 0) {
 781                 char * fileOffset;
 782
 783                 fileOffset = offsetp->QuadPart + cm_data.baseAddress;
 784                 if (fileOffset == bp->datap) {
 785                     buf_HoldLocked(bp);
 786                     break;
 787                 }
 788             }
 789         }
 790     }
 791     /* return whatever we found, if anything */
 792     return bp;
 793 }
 794
 795 /* find a buffer with offset *offsetp for vnode *scp.  Called
 796  * with no locks held.  Use the all buffer list.
 797  */
 798 cm_buf_t *buf_FindAll(struct cm_fid *fidp, osi_hyper_t *offsetp, afs_uint32 flags)
 799 {
 800     cm_buf_t *bp;
 801
 802     lock_ObtainRead(&buf_globalLock);
 803     bp = buf_FindAllLocked(fidp, offsetp, flags);
 804     lock_ReleaseRead(&buf_globalLock);
 805
 806     return bp;
 807 }
 808
 809 /* start cleaning I/O on this buffer.  Buffer must be write locked, and is returned
 810  * write-locked.
 811  *
 812  * Makes sure that there's only one person writing this block
 813  * at any given time, and also ensures that the log is forced sufficiently far,
 814  * if this buffer contains logged data.
 815  *
 816  * Returns non-zero if the buffer was dirty.
 817  *
 818  * 'scp' may or may not be NULL.  If it is not NULL, the FID for both cm_scache_t
 819  * and cm_buf_t must match.
 820  */
 821 afs_uint32 buf_CleanAsyncLocked(cm_scache_t *scp, cm_buf_t *bp, cm_req_t *reqp,
 822                                 afs_uint32 flags, afs_uint32 *pisdirty)
 823 {
 824     afs_uint32 code = 0;
 825     afs_uint32 isdirty = 0;
 826     osi_hyper_t offset;
 827     int release_scp = 0;
 828
 829     osi_assertx(bp->magic == CM_BUF_MAGIC, "invalid cm_buf_t magic");
 830     osi_assertx(scp == NULL || cm_FidCmp(&scp->fid, &bp->fid) == 0, "scp fid != bp fid");
 831
 832     /*
 833      * If the matching cm_scache_t was not provided as a parameter
 834      * we must either find one or allocate a new one.  It is possible
 835      * that the cm_scache_t was recycled out of the cache even though
 836      * a cm_buf_t with the same FID is in the cache.
 837      */
 838     if (scp == NULL) {
 839         if ((scp = cm_FindSCache(&bp->fid)) ||
 840             (cm_GetSCache(&bp->fid, &scp,
 841                           bp->userp ? bp->userp : cm_rootUserp,
 842                           reqp) == 0)) {
 843             release_scp = 1;
 844         }
 845     }
 846
 847     while ((bp->flags & CM_BUF_DIRTY) == CM_BUF_DIRTY) {
 848         isdirty = 1;
 849         lock_ReleaseMutex(&bp->mx);
 850
 851         if (!scp) {
 852             /*
 853              * If we didn't find a cm_scache_t object for bp->fid it means
 854              * that we no longer have that FID in the cache.  It does not
 855              * mean that the object does not exist in the cell.  That may
 856              * in fact be the case but we don't know that until we attempt
 857              * a FetchStatus on the FID.
 858              */
 859             osi_Log1(buf_logp, "buf_CleanAsyncLocked unable to start I/O - scp not found buf 0x%p", bp);
 860             code = CM_ERROR_NOSUCHFILE;
 861         } else {
 862             osi_Log2(buf_logp, "buf_CleanAsyncLocked starts I/O on scp 0x%p buf 0x%p", scp, bp);
 863
 864             offset = bp->offset;
 865             LargeIntegerAdd(offset, ConvertLongToLargeInteger(bp->dirty_offset));
 866             code = (*cm_buf_opsp->Writep)(scp, &offset,
 867 #if 1
 868                                           /* we might as well try to write all of the contiguous
 869                                            * dirty buffers in one RPC
 870                                            */
 871                                           cm_chunkSize,
 872 #else
 873                                           bp->dirty_length,
 874 #endif
 875                                           flags, bp->userp, reqp);
 876             osi_Log3(buf_logp, "buf_CleanAsyncLocked I/O on scp 0x%p buf 0x%p, done=%d", scp, bp, code);
 877         }
 878         lock_ObtainMutex(&bp->mx);
 879         /* if the Write routine returns No Such File, clear the dirty flag
 880          * because we aren't going to be able to write this data to the file
 881          * server.
 882          */
 883         if (code == CM_ERROR_NOSUCHFILE || code == CM_ERROR_BADFD || code == CM_ERROR_NOACCESS ||
 884             code == CM_ERROR_QUOTA || code == CM_ERROR_SPACE || code == CM_ERROR_TOOBIG ||
 885             code == CM_ERROR_READONLY || code == CM_ERROR_NOSUCHPATH){
 886             _InterlockedAnd(&bp->flags, ~CM_BUF_DIRTY);
 887             _InterlockedOr(&bp->flags, CM_BUF_ERROR);
 888             bp->dirty_offset = 0;
 889             bp->dirty_length = 0;
 890             bp->error = code;
 891             bp->dataVersion = CM_BUF_VERSION_BAD;
 892             bp->dirtyCounter++;
 893             break;
 894         }
 895
 896 #ifdef DISKCACHE95
 897         /* Disk cache support */
 898         /* write buffer to disk cache (synchronous for now) */
 899         diskcache_Update(bp->dcp, bp->datap, cm_data.buf_blockSize, bp->dataVersion);
 900 #endif /* DISKCACHE95 */
 901
 902         /* if we get here and retries are not permitted
 903          * then we need to exit this loop regardless of
 904          * whether or not we were able to clear the dirty bit
 905          */
 906         if (reqp->flags & CM_REQ_NORETRY)
 907             break;
 908
 909         /* Ditto if the hardDeadTimeout or idleTimeout was reached */
 910         if (code == CM_ERROR_TIMEDOUT || code == CM_ERROR_ALLDOWN ||
 911             code == CM_ERROR_ALLBUSY || code == CM_ERROR_ALLOFFLINE ||
 912             code == CM_ERROR_CLOCKSKEW) {
 913             break;
 914         }
 915     }
 916
 917     if (release_scp)
 918         cm_ReleaseSCache(scp);
 919
 920     /* if someone was waiting for the I/O that just completed or failed,
 921      * wake them up.
 922      */
 923     if (bp->flags & CM_BUF_WAITING) {
 924         /* turn off flags and wakeup users */
 925         osi_Log1(buf_logp, "buf_WaitIO Waking bp 0x%p", bp);
 926         osi_Wakeup((LONG_PTR) bp);
 927     }
 928
 929     if (pisdirty)
 930         *pisdirty = isdirty;
 931
 932     return code;
 933 }
 934
 935 /* Called with a zero-ref count buffer and with the buf_globalLock write locked.
 936  * recycles the buffer, and leaves it ready for reuse with a ref count of 1.
 937  * The buffer must already be clean, and no I/O should be happening to it.
 938  */
 939 void buf_Recycle(cm_buf_t *bp)
 940 {
 941     afs_uint32 i;
 942     cm_buf_t **lbpp;
 943     cm_buf_t *tbp;
 944     cm_buf_t *prevBp, *nextBp;
 945
 946     osi_assertx(bp->magic == CM_BUF_MAGIC, "invalid cm_buf_t magic");
 947
 948     osi_assertx(!(bp->qFlags & CM_BUF_QREDIR), "can't recycle redir held buffers");
 949
 950     /* if we get here, we know that the buffer still has a 0 ref count,
 951      * and that it is clean and has no currently pending I/O.  This is
 952      * the dude to return.
 953      * Remember that as long as the ref count is 0, we know that we won't
 954      * have any lock conflicts, so we can grab the buffer lock out of
 955      * order in the locking hierarchy.
 956      */
 957     osi_Log3( buf_logp, "buf_Recycle recycles 0x%p, off 0x%x:%08x",
 958               bp, bp->offset.HighPart, bp->offset.LowPart);
 959
 960     osi_assertx(bp->refCount == 0, "cm_buf_t refcount != 0");
 961     osi_assertx(!(bp->flags & (CM_BUF_READING | CM_BUF_WRITING | CM_BUF_DIRTY)),
 962                 "incorrect cm_buf_t flags");
 963     lock_AssertWrite(&buf_globalLock);
 964
 965     if (bp->qFlags & CM_BUF_QINHASH) {
 966         /* Remove from hash */
 967
 968         i = BUF_HASH(&bp->fid, &bp->offset);
 969         lbpp = &(cm_data.buf_scacheHashTablepp[i]);
 970         for(tbp = *lbpp; tbp; lbpp = &tbp->hashp, tbp = tbp->hashp) {
 971             if (tbp == bp)
 972                 break;
 973         }
 974
 975         /* we better find it */
 976         osi_assertx(tbp != NULL, "buf_Recycle: hash table screwup");
 977
 978         *lbpp = bp->hashp;      /* hash out */
 979         bp->hashp = NULL;
 980
 981         /* Remove from file hash */
 982
 983         i = BUF_FILEHASH(&bp->fid);
 984         prevBp = bp->fileHashBackp;
 985         bp->fileHashBackp = NULL;
 986         nextBp = bp->fileHashp;
 987         bp->fileHashp = NULL;
 988         if (prevBp)
 989             prevBp->fileHashp = nextBp;
 990         else
 991             cm_data.buf_fileHashTablepp[i] = nextBp;
 992         if (nextBp)
 993             nextBp->fileHashBackp = prevBp;
 994
 995         _InterlockedAnd(&bp->qFlags, ~CM_BUF_QINHASH);
 996     }
 997
 998     /* make the fid unrecognizable */
 999     memset(&bp->fid, 0, sizeof(cm_fid_t));
1000
1001     /* clean up junk flags */
1002     _InterlockedAnd(&bp->flags, ~(CM_BUF_EOF | CM_BUF_ERROR));
1003     bp->dataVersion = CM_BUF_VERSION_BAD;       /* unknown so far */
1004 }
1005
1006
1007 /*
1008  * buf_RDRShakeAnExtentFree
1009  * called with buf_globalLock read locked
1010  */
1011 afs_uint32
1012 buf_RDRShakeAnExtentFree(cm_buf_t *rbp, cm_req_t *reqp)
1013 {
1014     afs_uint32 code = 0;
1015     LARGE_INTEGER heldExtents = {0,0};
1016     AFSFileExtentCB extentList[1];
1017     DWORD extentCount = 0;
1018     BOOL locked = FALSE;
1019
1020     if (!(rbp->qFlags & CM_BUF_QREDIR))
1021         return 0;
1022
1023     lock_ReleaseRead(&buf_globalLock);
1024
1025     if (!lock_TryMutex(&buf_rdrReleaseExtentsLock)) {
1026         osi_Log0(afsd_logp, "Waiting for prior RDR_RequestExtentRelease request to complete");
1027         if (reqp->flags & CM_REQ_NORETRY) {
1028             code = CM_ERROR_WOULDBLOCK;
1029             goto done;
1030         }
1031
1032         lock_ObtainMutex(&buf_rdrReleaseExtentsLock);
1033     }
1034
1035     extentList[0].Flags = 0;
1036     extentList[0].Length = cm_data.blockSize;
1037     extentList[0].FileOffset.QuadPart = rbp->offset.QuadPart;
1038     extentList[0].CacheOffset.QuadPart = rbp->datap - cm_data.baseAddress;
1039     extentCount = 1;
1040
1041     code = RDR_RequestExtentRelease(&rbp->fid, heldExtents, extentCount, extentList);
1042
1043     lock_ReleaseMutex(&buf_rdrReleaseExtentsLock);
1044
1045   done:
1046     lock_ObtainRead(&buf_globalLock);
1047     return code;
1048 }
1049
1050 /*
1051  * buf_RDRShakeFileExtentsFree
1052  * requests all extents held by the redirector to be returned for
1053  * the specified cm_scache_t.  This function is called with no
1054  * locks held.
1055  */
1056 afs_uint32
1057 buf_RDRShakeFileExtentsFree(cm_scache_t *rscp, cm_req_t *reqp)
1058 {
1059     afs_uint32 code = 0;
1060     afs_uint64 n_redir = 0;
1061
1062     if (!lock_TryMutex(&buf_rdrReleaseExtentsLock)) {
1063         osi_Log0(afsd_logp, "Waiting for prior RDR_RequestExtentRelease request to complete");
1064         if (reqp->flags & CM_REQ_NORETRY)
1065             return CM_ERROR_WOULDBLOCK;
1066
1067         lock_ObtainMutex(&buf_rdrReleaseExtentsLock);
1068     }
1069
1070     for ( code = CM_ERROR_RETRY; code == CM_ERROR_RETRY; ) {
1071         LARGE_INTEGER heldExtents = {0,0};
1072         AFSFileExtentCB extentList[1024];
1073         DWORD extentCount = 0;
1074         cm_buf_t *srbp;
1075         time_t now;
1076
1077         /* only retry if a call to RDR_RequestExtentRelease says to */
1078         code = 0;
1079         lock_ObtainWrite(&buf_globalLock);
1080
1081         if (rscp->redirBufCount == 0)
1082         {
1083             lock_ReleaseWrite(&buf_globalLock);
1084             break;
1085         }
1086
1087         time(&now);
1088         for ( srbp = redirq_to_cm_buf_t(rscp->redirQueueT);
1089               srbp;
1090               srbp = ((code == 0 && extentCount == 0) ? redirq_to_cm_buf_t(rscp->redirQueueT) :
1091                        redirq_to_cm_buf_t(osi_QPrev(&srbp->redirq))))
1092         {
1093             extentList[extentCount].Flags = 0;
1094             extentList[extentCount].Length = cm_data.blockSize;
1095             extentList[extentCount].FileOffset.QuadPart = srbp->offset.QuadPart;
1096             extentList[extentCount].CacheOffset.QuadPart = srbp->datap - cm_data.baseAddress;
1097             srbp->redirReleaseRequested = now;
1098             extentCount++;
1099
1100             if (extentCount == 1024) {
1101                 lock_ReleaseWrite(&buf_globalLock);
1102                 heldExtents.QuadPart = cm_data.buf_redirCount;
1103                 code = RDR_RequestExtentRelease(&rscp->fid, heldExtents, extentCount, extentList);
1104                 if (code) {
1105                     if (code == CM_ERROR_RETRY) {
1106                         /*
1107                          * The redirector either is not holding the extents or cannot let them
1108                          * go because they are otherwise in use.  At the moment, do nothing.
1109                          */
1110                     } else
1111                         break;
1112                 }
1113                 extentCount = 0;
1114                 lock_ObtainWrite(&buf_globalLock);
1115             }
1116         }
1117         lock_ReleaseWrite(&buf_globalLock);
1118
1119         if (code == 0 && extentCount > 0) {
1120             heldExtents.QuadPart = cm_data.buf_redirCount;
1121             code = RDR_RequestExtentRelease(&rscp->fid, heldExtents, extentCount, extentList);
1122         }
1123
1124         if ((code == CM_ERROR_RETRY) && (reqp->flags & CM_REQ_NORETRY)) {
1125             code = CM_ERROR_WOULDBLOCK;
1126             break;
1127         }
1128     }
1129     lock_ReleaseMutex(&buf_rdrReleaseExtentsLock);
1130     return code;
1131 }
1132
1133 afs_uint32
1134 buf_RDRShakeSomeExtentsFree(cm_req_t *reqp, afs_uint32 oneFid, afs_uint32 minage)
1135 {
1136     afs_uint32 code = 0;
1137
1138     if (!lock_TryMutex(&buf_rdrReleaseExtentsLock)) {
1139         if (reqp->flags & CM_REQ_NORETRY)
1140             return CM_ERROR_WOULDBLOCK;
1141
1142         osi_Log0(afsd_logp, "Waiting for prior RDR_RequestExtentRelease request to complete");
1143         lock_ObtainMutex(&buf_rdrReleaseExtentsLock);
1144     }
1145
1146     for ( code = CM_ERROR_RETRY; code == CM_ERROR_RETRY; ) {
1147         LARGE_INTEGER heldExtents;
1148         AFSFileExtentCB extentList[1024];
1149         DWORD extentCount = 0;
1150         cm_buf_t *rbp, *srbp;
1151         cm_scache_t *rscp;
1152         time_t now;
1153         BOOL locked = FALSE;
1154
1155         /* only retry if a call to RDR_RequestExtentRelease says to */
1156         code = 0;
1157         lock_ObtainWrite(&buf_globalLock);
1158         locked = TRUE;
1159
1160         for ( rbp = cm_data.buf_redirListEndp;
1161               code == 0 && rbp && (!oneFid || extentCount == 0);
1162               rbp = (cm_buf_t *) osi_QPrev(&rbp->q))
1163         {
1164             if (!oneFid)
1165                 extentCount = 0;
1166
1167             if (rbp->redirLastAccess >= rbp->redirReleaseRequested) {
1168                 rscp = cm_FindSCache(&rbp->fid);
1169                 if (!rscp)
1170                     continue;
1171
1172                 time(&now);
1173                 for ( srbp = redirq_to_cm_buf_t(rscp->redirQueueT);
1174                       srbp && extentCount < 1024;
1175                       srbp = redirq_to_cm_buf_t(osi_QPrev(&srbp->redirq)))
1176                 {
1177                     /*
1178                      * Do not request a release if we have already done so
1179                      * or if the extent was delivered to windows less than
1180                      * 'minage' seconds ago.
1181                      */
1182                     if (srbp->redirLastAccess >= srbp->redirReleaseRequested &&
1183                          srbp->redirLastAccess < now - minage) {
1184                         extentList[extentCount].Flags = 0;
1185                         extentList[extentCount].Length = cm_data.blockSize;
1186                         extentList[extentCount].FileOffset.QuadPart = srbp->offset.QuadPart;
1187                         extentList[extentCount].CacheOffset.QuadPart = srbp->datap - cm_data.baseAddress;
1188                         srbp->redirReleaseRequested = now;
1189                         extentCount++;
1190                     }
1191                 }
1192                 cm_ReleaseSCache(rscp);
1193             }
1194
1195             if ( !oneFid && extentCount > 0) {
1196                 if (locked) {
1197                     lock_ReleaseWrite(&buf_globalLock);
1198                     locked = FALSE;
1199                 }
1200                 heldExtents.QuadPart = cm_data.buf_redirCount;
1201                 code = RDR_RequestExtentRelease(&rbp->fid, heldExtents, extentCount, extentList);
1202             }
1203             if (!locked) {
1204                 lock_ObtainWrite(&buf_globalLock);
1205                 locked = TRUE;
1206             }
1207         }
1208         if (locked)
1209             lock_ReleaseWrite(&buf_globalLock);
1210         if (code == 0) {
1211             if (oneFid) {
1212                 heldExtents.QuadPart = cm_data.buf_redirCount;
1213                 if (rbp && extentCount)
1214                     code = RDR_RequestExtentRelease(&rbp->fid, heldExtents, extentCount, extentList);
1215                 else
1216                     code = RDR_RequestExtentRelease(NULL, heldExtents, 1024, NULL);
1217             } else {
1218                 code = 0;
1219             }
1220         }
1221
1222         if ((code == CM_ERROR_RETRY) && (reqp->flags & CM_REQ_NORETRY)) {
1223             code = CM_ERROR_WOULDBLOCK;
1224             break;
1225         }
1226     }
1227     lock_ReleaseMutex(&buf_rdrReleaseExtentsLock);
1228     return code;
1229 }
1230
1231 /* returns 0 if the buffer does not exist, and non-0 if it does */
1232 static long
1233 buf_ExistsLocked(struct cm_scache *scp, osi_hyper_t *offsetp)
1234 {
1235     cm_buf_t *bp;
1236
1237     if (bp = buf_FindLocked(&scp->fid, offsetp)) {
1238         /* Do not call buf_ReleaseLocked() because we
1239          * do not want to allow the buffer to be added
1240          * to the free list.
1241          */
1242         afs_int32 refCount = InterlockedDecrement(&bp->refCount);
1243 #ifdef DEBUG_REFCOUNT
1244         osi_Log2(afsd_logp,"buf_ExistsLocked bp 0x%p ref %d", bp, refCount);
1245         afsi_log("%s:%d buf_ExistsLocked bp 0x%p, ref %d", __FILE__, __LINE__, bp, refCount);
1246 #endif
1247         return CM_BUF_EXISTS;
1248     }
1249
1250     return 0;
1251 }
1252
1253 /* recycle a buffer, removing it from the free list, hashing in its new identity
1254  * and returning it write-locked so that no one can use it.  Called without
1255  * any locks held, and can return an error if it loses the race condition and
1256  * finds that someone else created the desired buffer.
1257  *
1258  * If success is returned, the buffer is returned write-locked.
1259  *
1260  * May be called with null scp and offsetp, if we're just trying to reclaim some
1261  * space from the buffer pool.  In that case, the buffer will be returned
1262  * without being hashed into the hash table.
1263  */
1264 long buf_GetNewLocked(struct cm_scache *scp, osi_hyper_t *offsetp, cm_req_t *reqp, cm_buf_t **bufpp)
1265 {
1266     cm_buf_t *bp;       /* buffer we're dealing with */
1267     cm_buf_t *nextBp;   /* next buffer in file hash chain */
1268     afs_uint32 i;       /* temp */
1269     afs_uint64 n_bufs, n_nonzero, n_busy, n_dirty, n_own;
1270
1271 #ifdef TESTING
1272     buf_ValidateBufQueues();
1273 #endif /* TESTING */
1274
1275     while(1) {
1276       retry:
1277         n_bufs = 0;
1278         n_nonzero = 0;
1279         n_own = 0;
1280         n_busy = 0;
1281         n_dirty = 0;
1282
1283         lock_ObtainRead(&scp->bufCreateLock);
1284         lock_ObtainWrite(&buf_globalLock);
1285         /* check to see if we lost the race */
1286         if (buf_ExistsLocked(scp, offsetp)) {
1287             lock_ReleaseWrite(&buf_globalLock);
1288             lock_ReleaseRead(&scp->bufCreateLock);
1289             return CM_BUF_EXISTS;
1290         }
1291
1292         /* does this fix the problem below?  it's a simple solution. */
1293         if (!cm_data.buf_freeListEndp)
1294         {
1295             lock_ReleaseWrite(&buf_globalLock);
1296             lock_ReleaseRead(&scp->bufCreateLock);
1297
1298             if ( RDR_Initialized )
1299                 goto rdr_release;
1300
1301             osi_Log0(afsd_logp, "buf_GetNewLocked: Free Buffer List is empty - sleeping 200ms");
1302             Sleep(200);
1303             goto retry;
1304         }
1305
1306         /* for debugging, assert free list isn't empty, although we
1307          * really should try waiting for a running tranasction to finish
1308          * instead of this; or better, we should have a transaction
1309          * throttler prevent us from entering this situation.
1310          */
1311         osi_assertx(cm_data.buf_freeListEndp != NULL, "buf_GetNewLocked: no free buffers");
1312
1313         /* look at all buffers in free list, some of which may temp.
1314          * have high refcounts and which then should be skipped,
1315          * starting cleaning I/O for those which are dirty.  If we find
1316          * a clean buffer, we rehash it, lock it and return it.
1317          */
1318         for (bp = cm_data.buf_freeListEndp; bp; bp=(cm_buf_t *) osi_QPrev(&bp->q)) {
1319             n_bufs++;
1320
1321             /* check to see if it really has zero ref count.  This
1322              * code can bump refcounts, at least, so it may not be
1323              * zero.
1324              */
1325             if (bp->refCount > 0) {
1326                 n_nonzero++;
1327                 continue;
1328             }
1329
1330             /* we don't have to lock buffer itself, since the ref
1331              * count is 0 and we know it will stay zero as long as
1332              * we hold the global lock.
1333              */
1334
1335             /* don't recycle someone in our own chunk */
1336             if (!cm_FidCmp(&bp->fid, &scp->fid) &&
1337                 bp->dataVersion >= scp->bufDataVersionLow &&
1338                 bp->dataVersion <= scp->dataVersion &&
1339                 (bp->offset.LowPart & (-cm_chunkSize)) == (offsetp->LowPart & (-cm_chunkSize))) {
1340                 n_own++;
1341                 continue;
1342             }
1343
1344             /* if this page is being filled (!) or cleaned, see if
1345              * the I/O has completed.  If not, skip it, otherwise
1346              * do the final processing for the I/O.
1347              */
1348             if (bp->flags & (CM_BUF_READING | CM_BUF_WRITING)) {
1349                 /* probably shouldn't do this much work while
1350                  * holding the big lock?  Watch for contention
1351                  * here.
1352                  */
1353                 n_busy++;
1354                 continue;
1355             }
1356
1357             if (bp->flags & CM_BUF_DIRTY) {
1358                 n_dirty++;
1359
1360                 /* leave the buffer alone if held by the redirector */
1361                 if (bp->qFlags & CM_BUF_QREDIR)
1362                     continue;
1363
1364                 /* if the buffer is dirty, start cleaning it and
1365                  * move on to the next buffer.  We do this with
1366                  * just the lock required to minimize contention
1367                  * on the big lock.
1368                  */
1369                 buf_HoldLocked(bp);
1370                 lock_ReleaseWrite(&buf_globalLock);
1371                 lock_ReleaseRead(&scp->bufCreateLock);
1372
1373                 /* grab required lock and clean; this only
1374                  * starts the I/O.  By the time we're back,
1375                  * it'll still be marked dirty, but it will also
1376                  * have the WRITING flag set, so we won't get
1377                  * back here.
1378                  */
1379                 if (cm_FidCmp(&scp->fid, &bp->fid) == 0)
1380                     buf_CleanAsync(scp, bp, reqp, 0, NULL);
1381                 else
1382                     buf_CleanAsync(NULL, bp, reqp, 0, NULL);
1383
1384                 /* now put it back and go around again */
1385                 buf_Release(bp);
1386
1387                 /* but first obtain the locks we gave up
1388                  * before the buf_CleanAsync() call */
1389                 lock_ObtainRead(&scp->bufCreateLock);
1390                 lock_ObtainWrite(&buf_globalLock);
1391
1392                 /*
1393                  * Since we dropped the locks we need to verify that
1394                  * another thread has not allocated the buffer for us.
1395                  */
1396                 if (buf_ExistsLocked(scp, offsetp)) {
1397                     lock_ReleaseWrite(&buf_globalLock);
1398                     lock_ReleaseRead(&scp->bufCreateLock);
1399                     return CM_BUF_EXISTS;
1400                 }
1401                 continue;
1402             }
1403
1404             osi_Log3(afsd_logp, "buf_GetNewLocked: scp 0x%p examined %u buffers before recycling bufp 0x%p",
1405                      scp, n_bufs, bp);
1406             osi_Log4(afsd_logp, "... nonzero %u; own %u; busy %u; dirty %u", n_nonzero, n_own, n_busy, n_dirty);
1407
1408             /* if we get here, we know that the buffer still has a 0
1409              * ref count, and that it is clean and has no currently
1410              * pending I/O.  This is the dude to return.
1411              * Remember that as long as the ref count is 0, we know
1412              * that we won't have any lock conflicts, so we can grab
1413              * the buffer lock out of order in the locking hierarchy.
1414              */
1415             buf_Recycle(bp);
1416
1417             /* now hash in as our new buffer, and give it the
1418              * appropriate label, if requested.
1419              */
1420             if (scp) {
1421                 lock_AssertWrite(&buf_globalLock);
1422
1423                 _InterlockedOr(&bp->qFlags, CM_BUF_QINHASH);
1424                 bp->fid = scp->fid;
1425 #ifdef DEBUG
1426                 bp->scp = scp;
1427 #endif
1428                 bp->offset = *offsetp;
1429                 i = BUF_HASH(&scp->fid, offsetp);
1430                 bp->hashp = cm_data.buf_scacheHashTablepp[i];
1431                 cm_data.buf_scacheHashTablepp[i] = bp;
1432                 i = BUF_FILEHASH(&scp->fid);
1433                 nextBp = cm_data.buf_fileHashTablepp[i];
1434                 bp->fileHashp = nextBp;
1435                 bp->fileHashBackp = NULL;
1436                 if (nextBp)
1437                     nextBp->fileHashBackp = bp;
1438                 cm_data.buf_fileHashTablepp[i] = bp;
1439             }
1440
1441             /* we should remove it from the lru queue.  It better still be there,
1442              * since we've held the global (big) lock since we found it there.
1443              */
1444             osi_assertx(bp->qFlags & CM_BUF_QINLRU,
1445                          "buf_GetNewLocked: LRU screwup");
1446
1447             osi_QRemoveHT( (osi_queue_t **) &cm_data.buf_freeListp,
1448                            (osi_queue_t **) &cm_data.buf_freeListEndp,
1449                            &bp->q);
1450             _InterlockedAnd(&bp->qFlags, ~CM_BUF_QINLRU);
1451             buf_DecrementFreeCount();
1452
1453             /* prepare to return it.  Give it a refcount */
1454             bp->refCount = 1;
1455 #ifdef DEBUG_REFCOUNT
1456             osi_Log2(afsd_logp,"buf_GetNewLocked bp 0x%p ref %d", bp, 1);
1457             afsi_log("%s:%d buf_GetNewLocked bp 0x%p, ref %d", __FILE__, __LINE__, bp, 1);
1458 #endif
1459             /* grab the mutex so that people don't use it
1460              * before the caller fills it with data.  Again, no one
1461              * should have been able to get to this dude to lock it.
1462              */
1463             if (!lock_TryMutex(&bp->mx)) {
1464                 osi_Log2(afsd_logp, "buf_GetNewLocked bp 0x%p cannot be mutex locked.  refCount %d should be 0",
1465                          bp, bp->refCount);
1466                 osi_panic("buf_GetNewLocked: TryMutex failed",__FILE__,__LINE__);
1467             }
1468
1469             lock_ReleaseWrite(&buf_globalLock);
1470             lock_ReleaseRead(&scp->bufCreateLock);
1471
1472             *bufpp = bp;
1473
1474 #ifdef TESTING
1475             buf_ValidateBufQueues();
1476 #endif /* TESTING */
1477             return 0;
1478         } /* for all buffers in lru queue */
1479         lock_ReleaseWrite(&buf_globalLock);
1480         lock_ReleaseRead(&scp->bufCreateLock);
1481
1482         osi_Log1(afsd_logp, "buf_GetNewLocked: Free Buffer List has %u buffers none free", n_bufs);
1483         osi_Log4(afsd_logp, "... nonzero %u; own %u; busy %u; dirty %u", n_nonzero, n_own, n_busy, n_dirty);
1484
1485         if (RDR_Initialized) {
1486             afs_uint32 code;
1487           rdr_release:
1488             code = buf_RDRShakeSomeExtentsFree(reqp, TRUE, 2 /* seconds */);
1489             switch (code) {
1490             case CM_ERROR_RETRY:
1491             case 0:
1492                 goto retry;
1493             case CM_ERROR_WOULDBLOCK:
1494                 return CM_ERROR_WOULDBLOCK;
1495             }
1496         }
1497
1498         Sleep(100);             /* give some time for a buffer to be freed */
1499     }   /* while loop over everything */
1500     /* not reached */
1501 } /* the proc */
1502
1503 /*
1504  * get a page, returning it held but unlocked.  the page may or may not
1505  * contain valid data.
1506  *
1507  * The scp must be unlocked when passed in unlocked.
1508  */
1509 long buf_Get(struct cm_scache *scp, osi_hyper_t *offsetp, cm_req_t *reqp, cm_buf_t **bufpp)
1510 {
1511     cm_buf_t *bp;
1512     long code;
1513     osi_hyper_t pageOffset;
1514     unsigned long tcount;
1515     int created;
1516     long lcount = 0;
1517 #ifdef DISKCACHE95
1518     cm_diskcache_t *dcp;
1519 #endif /* DISKCACHE95 */
1520
1521     created = 0;
1522     pageOffset.HighPart = offsetp->HighPart;
1523     pageOffset.LowPart = offsetp->LowPart & ~(cm_data.buf_blockSize-1);
1524     while (!created) {
1525         lcount++;
1526 #ifdef TESTING
1527         buf_ValidateBufQueues();
1528 #endif /* TESTING */
1529
1530         bp = buf_Find(&scp->fid, &pageOffset);
1531         if (bp) {
1532             /* lock it and break out */
1533             lock_ObtainMutex(&bp->mx);
1534
1535 #ifdef DISKCACHE95
1536             /* touch disk chunk to update LRU info */
1537             diskcache_Touch(bp->dcp);
1538 #endif /* DISKCACHE95 */
1539             break;
1540         }
1541
1542         /* otherwise, we have to create a page */
1543         code = buf_GetNewLocked(scp, &pageOffset, reqp, &bp);
1544         switch (code) {
1545         case 0:
1546             /* the requested buffer was created */
1547             created = 1;
1548             break;
1549         case CM_BUF_EXISTS:
1550             /*
1551              * the requested buffer existed by the time the
1552              * scp->bufCreateLock and buf_globalLock could be obtained.
1553              * loop again and permit buf_Find() to obtain a reference.
1554              */
1555             break;
1556         default:
1557             /*
1558              * the requested buffer could not be created.
1559              * return the error to the caller.
1560              */
1561 #ifdef TESTING
1562             buf_ValidateBufQueues();
1563 #endif /* TESTING */
1564             return code;
1565         }
1566     } /* big while loop */
1567
1568     /* if we get here, we have a locked buffer that may have just been
1569      * created, in which case it needs to be filled with data.
1570      */
1571     if (created) {
1572         /* load the page; freshly created pages should be idle */
1573         osi_assertx(!(bp->flags & (CM_BUF_READING | CM_BUF_WRITING)), "incorrect cm_buf_t flags");
1574
1575         /*
1576          * start the I/O; may drop lock.  as of this writing, the only
1577          * implementation of Readp is cm_BufRead() which simply sets
1578          * tcount to 0 and returns success.
1579          */
1580         _InterlockedOr(&bp->flags, CM_BUF_READING);
1581         code = (*cm_buf_opsp->Readp)(bp, cm_data.buf_blockSize, &tcount, NULL);
1582
1583 #ifdef DISKCACHE95
1584         code = diskcache_Get(&bp->fid, &bp->offset, bp->datap, cm_data.buf_blockSize, &bp->dataVersion, &tcount, &dcp);
1585         bp->dcp = dcp;    /* pointer to disk cache struct. */
1586 #endif /* DISKCACHE95 */
1587
1588         if (code != 0) {
1589             /* failure or queued */
1590
1591             /* unless cm_BufRead() is altered, this path cannot be hit */
1592             if (code != ERROR_IO_PENDING) {
1593                 bp->error = code;
1594                 _InterlockedOr(&bp->flags, CM_BUF_ERROR);
1595                 _InterlockedAnd(&bp->flags, ~CM_BUF_READING);
1596                 if (bp->flags & CM_BUF_WAITING) {
1597                     osi_Log1(buf_logp, "buf_Get Waking bp 0x%p", bp);
1598                     osi_Wakeup((LONG_PTR) bp);
1599                 }
1600                 lock_ReleaseMutex(&bp->mx);
1601                 buf_Release(bp);
1602 #ifdef TESTING
1603                 buf_ValidateBufQueues();
1604 #endif /* TESTING */
1605                 return code;
1606             }
1607         } else {
1608             /*
1609              * otherwise, I/O completed instantly and we're done, except
1610              * for padding the xfr out with 0s and checking for EOF
1611              */
1612             if (tcount < (unsigned long) cm_data.buf_blockSize) {
1613                 memset(bp->datap+tcount, 0, cm_data.buf_blockSize - tcount);
1614                 if (tcount == 0)
1615                     _InterlockedOr(&bp->flags, CM_BUF_EOF);
1616             }
1617             _InterlockedAnd(&bp->flags, ~CM_BUF_READING);
1618             if (bp->flags & CM_BUF_WAITING) {
1619                 osi_Log1(buf_logp, "buf_Get Waking bp 0x%p", bp);
1620                 osi_Wakeup((LONG_PTR) bp);
1621             }
1622         }
1623     } /* if created */
1624
1625     /* wait for reads, either that which we started above, or that someone
1626      * else started.  We don't care if we return a buffer being cleaned.
1627      */
1628     if (bp->flags & CM_BUF_READING)
1629         buf_WaitIO(scp, bp);
1630
1631     /* once it has been read once, we can unlock it and return it, still
1632      * with its refcount held.
1633      */
1634     lock_ReleaseMutex(&bp->mx);
1635     *bufpp = bp;
1636
1637     /* now remove from queue; will be put in at the head (farthest from
1638      * being recycled) when we're done in buf_Release.
1639      */
1640     lock_ObtainWrite(&buf_globalLock);
1641     if (bp->qFlags & CM_BUF_QINLRU) {
1642         osi_QRemoveHT( (osi_queue_t **) &cm_data.buf_freeListp,
1643                        (osi_queue_t **) &cm_data.buf_freeListEndp,
1644                        &bp->q);
1645         _InterlockedAnd(&bp->qFlags, ~CM_BUF_QINLRU);
1646         buf_DecrementFreeCount();
1647     }
1648     lock_ReleaseWrite(&buf_globalLock);
1649
1650     osi_Log4(buf_logp, "buf_Get returning bp 0x%p for scp 0x%p, offset 0x%x:%08x",
1651               bp, scp, offsetp->HighPart, offsetp->LowPart);
1652 #ifdef TESTING
1653     buf_ValidateBufQueues();
1654 #endif /* TESTING */
1655     return 0;
1656 }
1657
1658 /* clean a buffer synchronously */
1659 afs_uint32 buf_CleanAsync(cm_scache_t *scp, cm_buf_t *bp, cm_req_t *reqp, afs_uint32 flags, afs_uint32 *pisdirty)
1660 {
1661     long code;
1662     osi_assertx(bp->magic == CM_BUF_MAGIC, "invalid cm_buf_t magic");
1663     osi_assertx(!(flags & CM_BUF_WRITE_SCP_LOCKED), "scp->rw must not be held when calling buf_CleanAsync");
1664
1665     lock_ObtainMutex(&bp->mx);
1666     code = buf_CleanAsyncLocked(scp, bp, reqp, flags, pisdirty);
1667     lock_ReleaseMutex(&bp->mx);
1668
1669     return code;
1670 }
1671
1672 /* wait for a buffer's cleaning to finish */
1673 void buf_CleanWait(cm_scache_t * scp, cm_buf_t *bp, afs_uint32 locked)
1674 {
1675     osi_assertx(bp->magic == CM_BUF_MAGIC, "invalid cm_buf_t magic");
1676
1677     if (!locked)
1678         lock_ObtainMutex(&bp->mx);
1679     if (bp->flags & CM_BUF_WRITING) {
1680         buf_WaitIO(scp, bp);
1681     }
1682     if (!locked)
1683         lock_ReleaseMutex(&bp->mx);
1684 }
1685
1686 /* set the dirty flag on a buffer, and set associated write-ahead log,
1687  * if there is one.  Allow one to be added to a buffer, but not changed.
1688  *
1689  * The buffer must be locked before calling this routine.
1690  */
1691 void buf_SetDirty(cm_buf_t *bp, cm_req_t *reqp, afs_uint32 offset, afs_uint32 length, cm_user_t *userp)
1692 {
1693     osi_assertx(bp->magic == CM_BUF_MAGIC, "invalid cm_buf_t magic");
1694     osi_assertx(bp->refCount > 0, "cm_buf_t refcount 0");
1695
1696     if (length == 0)
1697         return;
1698
1699     if (bp->flags & CM_BUF_DIRTY) {
1700
1701         osi_Log1(buf_logp, "buf_SetDirty 0x%p already dirty", bp);
1702
1703         if (bp->dirty_offset <= offset) {
1704             if (bp->dirty_offset + bp->dirty_length >= offset + length) {
1705                 /* dirty_length remains the same */
1706             } else {
1707                 bp->dirty_length = offset + length - bp->dirty_offset;
1708             }
1709         } else /* bp->dirty_offset > offset */ {
1710             if (bp->dirty_offset + bp->dirty_length >= offset + length) {
1711                 bp->dirty_length = bp->dirty_offset + bp->dirty_length - offset;
1712             } else {
1713                 bp->dirty_length = length;
1714             }
1715             bp->dirty_offset = offset;
1716         }
1717     } else {
1718         osi_Log1(buf_logp, "buf_SetDirty 0x%p", bp);
1719
1720         /* set dirty bit */
1721         _InterlockedOr(&bp->flags, CM_BUF_DIRTY);
1722
1723         /* and turn off EOF flag, since it has associated data now */
1724         _InterlockedAnd(&bp->flags, ~CM_BUF_EOF);
1725
1726         bp->dirty_offset = offset;
1727         bp->dirty_length = length;
1728
1729         /*
1730          * if the request is not from the afs redirector,
1731          * add to the dirty list.  The redirector interface ensures
1732          * that a background store operation is queued for each and
1733          * every dirty extent that is released.  Therefore, the
1734          * buf_IncrSyncer thread is not required to ensure that
1735          * dirty buffers are written to the file server.
1736          *
1737          * we obtain a hold on the buffer for as long as it remains
1738          * in the list.  buffers are only removed from the list by
1739          * the buf_IncrSyncer function regardless of when else the
1740          * dirty flag might be cleared.
1741          *
1742          * This should never happen but just in case there is a bug
1743          * elsewhere, never add to the dirty list if the buffer is
1744          * already there.
1745          */
1746         if (!(reqp->flags & CM_REQ_SOURCE_REDIR)) {
1747             lock_ObtainWrite(&buf_globalLock);
1748             if (!(bp->qFlags & CM_BUF_QINDL)) {
1749                 buf_HoldLocked(bp);
1750                 if (!cm_data.buf_dirtyListp) {
1751                     cm_data.buf_dirtyListp = cm_data.buf_dirtyListEndp = bp;
1752                 } else {
1753                     cm_data.buf_dirtyListEndp->dirtyp = bp;
1754                     cm_data.buf_dirtyListEndp = bp;
1755                 }
1756                 bp->dirtyp = NULL;
1757                 _InterlockedOr(&bp->qFlags, CM_BUF_QINDL);
1758             }
1759             lock_ReleaseWrite(&buf_globalLock);
1760         }
1761     }
1762
1763     /* and record the last writer */
1764     if (bp->userp != userp) {
1765         cm_HoldUser(userp);
1766         if (bp->userp)
1767             cm_ReleaseUser(bp->userp);
1768         bp->userp = userp;
1769     }
1770 }
1771
1772 /* clean all buffers, reset log pointers and invalidate all buffers.
1773  * Called with no locks held, and returns with same.
1774  *
1775  * This function is guaranteed to clean and remove the log ptr of all the
1776  * buffers that were dirty or had non-zero log ptrs before the call was
1777  * made.  That's sufficient to clean up any garbage left around by recovery,
1778  * which is all we're counting on this for; there may be newly created buffers
1779  * added while we're running, but that should be OK.
1780  *
1781  * In an environment where there are no transactions (artificially imposed, for
1782  * example, when switching the database to raw mode), this function is used to
1783  * make sure that all updates have been written to the disk.  In that case, we don't
1784  * really require that we forget the log association between pages and logs, but
1785  * it also doesn't hurt.  Since raw mode I/O goes through this buffer package, we don't
1786  * have to worry about invalidating data in the buffers.
1787  *
1788  * This function is used at the end of recovery as paranoia to get the recovered
1789  * database out to disk.  It removes all references to the recovery log and cleans
1790  * all buffers.
1791  */
1792 long buf_CleanAndReset(void)
1793 {
1794     afs_uint32 i;
1795     cm_buf_t *bp;
1796     cm_req_t req;
1797
1798     lock_ObtainRead(&buf_globalLock);
1799     for(i=0; i<cm_data.buf_hashSize; i++) {
1800         for(bp = cm_data.buf_scacheHashTablepp[i]; bp; bp = bp->hashp) {
1801             if (bp->qFlags & CM_BUF_QREDIR) {
1802                 osi_Log1(buf_logp,"buf_CleanAndReset buffer held by redirector bp 0x%p", bp);
1803
1804                 /* Request single extent from the redirector */
1805                 buf_RDRShakeAnExtentFree(bp, &req);
1806             }
1807
1808             if ((bp->flags & CM_BUF_DIRTY) == CM_BUF_DIRTY) {
1809                 buf_HoldLocked(bp);
1810                 lock_ReleaseRead(&buf_globalLock);
1811
1812                 /* now no locks are held; clean buffer and go on */
1813                 cm_InitReq(&req);
1814                 req.flags |= CM_REQ_NORETRY;
1815
1816                 buf_CleanAsync(NULL, bp, &req, 0, NULL);
1817                 buf_CleanWait(NULL, bp, FALSE);
1818
1819                 /* relock and release buffer */
1820                 lock_ObtainRead(&buf_globalLock);
1821                 buf_ReleaseLocked(bp, FALSE);
1822             } /* dirty */
1823         } /* over one bucket */
1824     }   /* for loop over all hash buckets */
1825
1826     /* release locks */
1827     lock_ReleaseRead(&buf_globalLock);
1828
1829 #ifdef TESTING
1830     buf_ValidateBufQueues();
1831 #endif /* TESTING */
1832
1833     /* and we're done */
1834     return 0;
1835 }
1836
1837 /* called without global lock being held, reserves buffers for callers
1838  * that need more than one held (not locked) at once.
1839  */
1840 void buf_ReserveBuffers(afs_uint64 nbuffers)
1841 {
1842     lock_ObtainWrite(&buf_globalLock);
1843     while (1) {
1844         if (cm_data.buf_reservedBufs + nbuffers > cm_data.buf_maxReservedBufs) {
1845             cm_data.buf_reserveWaiting = 1;
1846             osi_Log1(buf_logp, "buf_ReserveBuffers waiting for %d bufs", nbuffers);
1847             osi_SleepW((LONG_PTR) &cm_data.buf_reservedBufs, &buf_globalLock);
1848             lock_ObtainWrite(&buf_globalLock);
1849         }
1850         else {
1851             cm_data.buf_reservedBufs += nbuffers;
1852             break;
1853         }
1854     }
1855     lock_ReleaseWrite(&buf_globalLock);
1856 }
1857
1858 int buf_TryReserveBuffers(afs_uint64 nbuffers)
1859 {
1860     int code;
1861
1862     lock_ObtainWrite(&buf_globalLock);
1863     if (cm_data.buf_reservedBufs + nbuffers > cm_data.buf_maxReservedBufs) {
1864         code = 0;
1865     }
1866     else {
1867         cm_data.buf_reservedBufs += nbuffers;
1868         code = 1;
1869     }
1870     lock_ReleaseWrite(&buf_globalLock);
1871     return code;
1872 }
1873
1874 /* called without global lock held, releases reservation held by
1875  * buf_ReserveBuffers.
1876  */
1877 void buf_UnreserveBuffers(afs_uint64 nbuffers)
1878 {
1879     lock_ObtainWrite(&buf_globalLock);
1880     cm_data.buf_reservedBufs -= nbuffers;
1881     if (cm_data.buf_reserveWaiting) {
1882         cm_data.buf_reserveWaiting = 0;
1883         osi_Wakeup((LONG_PTR) &cm_data.buf_reservedBufs);
1884     }
1885     lock_ReleaseWrite(&buf_globalLock);
1886 }
1887
1888 /* truncate the buffers past sizep, zeroing out the page, if we don't
1889  * end on a page boundary.
1890  *
1891  * Requires cm_bufCreateLock to be write locked.
1892  */
1893 long buf_Truncate(cm_scache_t *scp, cm_user_t *userp, cm_req_t *reqp,
1894                    osi_hyper_t *sizep)
1895 {
1896     cm_buf_t *bufp;
1897     cm_buf_t *nbufp;                    /* next buffer, if didRelease */
1898     osi_hyper_t bufEnd;
1899     long code;
1900     long bufferPos;
1901     afs_uint32 i;
1902
1903     /* assert that cm_bufCreateLock is held in write mode */
1904     lock_AssertWrite(&scp->bufCreateLock);
1905
1906     i = BUF_FILEHASH(&scp->fid);
1907
1908     lock_ObtainRead(&buf_globalLock);
1909     bufp = cm_data.buf_fileHashTablepp[i];
1910     if (bufp == NULL) {
1911         lock_ReleaseRead(&buf_globalLock);
1912         return 0;
1913     }
1914
1915     buf_HoldLocked(bufp);
1916     lock_ReleaseRead(&buf_globalLock);
1917
1918     while (bufp) {
1919         lock_ObtainMutex(&bufp->mx);
1920
1921         bufEnd.HighPart = 0;
1922         bufEnd.LowPart = cm_data.buf_blockSize;
1923         bufEnd = LargeIntegerAdd(bufEnd, bufp->offset);
1924
1925         if (cm_FidCmp(&bufp->fid, &scp->fid) == 0 &&
1926              LargeIntegerLessThan(*sizep, bufEnd)) {
1927             buf_WaitIO(scp, bufp);
1928         }
1929         lock_ObtainWrite(&scp->rw);
1930
1931         /* make sure we have a callback (so we have the right value for
1932          * the length), and wait for it to be safe to do a truncate.
1933          */
1934         code = cm_SyncOp(scp, bufp, userp, reqp, 0,
1935                           CM_SCACHESYNC_NEEDCALLBACK
1936                           | CM_SCACHESYNC_GETSTATUS
1937                           | CM_SCACHESYNC_SETSIZE
1938                           | CM_SCACHESYNC_BUFLOCKED);
1939
1940
1941         /* if we succeeded in our locking, and this applies to the right
1942          * file, and the truncate request overlaps the buffer either
1943          * totally or partially, then do something.
1944          */
1945         if (code == 0 && cm_FidCmp(&bufp->fid, &scp->fid) == 0
1946              && LargeIntegerLessThan(*sizep, bufEnd)) {
1947
1948
1949             /* destroy the buffer, turning off its dirty bit, if
1950              * we're truncating the whole buffer.  Otherwise, set
1951              * the dirty bit, and clear out the tail of the buffer
1952              * if we just overlap some.
1953              */
1954             if (LargeIntegerLessThanOrEqualTo(*sizep, bufp->offset)) {
1955                 /* truncating the entire page */
1956                 if (reqp->flags & CM_REQ_SOURCE_REDIR) {
1957                     /*
1958                      * Implicitly clear the redirector flag
1959                      * and release the matching hold.
1960                      */
1961                     if (bufp->qFlags & CM_BUF_QREDIR) {
1962                         osi_Log4(buf_logp,"buf_Truncate taking from file system bufp 0x%p vno 0x%x foffset 0x%x:%x",
1963                                  bufp, bufp->fid.vnode, bufp->offset.HighPart, bufp->offset.LowPart);
1964                         lock_ObtainWrite(&buf_globalLock);
1965                         if (bufp->qFlags & CM_BUF_QREDIR) {
1966                             buf_RemoveFromRedirQueue(scp, bufp);
1967                             buf_ReleaseLocked(bufp, TRUE);
1968                         }
1969                         lock_ReleaseWrite(&buf_globalLock);
1970                     }
1971                 } else {
1972                     if (RDR_Initialized)
1973                         RDR_InvalidateObject(scp->fid.cell, scp->fid.volume, scp->fid.vnode,
1974                                              scp->fid.unique, scp->fid.hash,
1975                                              scp->fileType, AFS_INVALIDATE_SMB);
1976                 }
1977                 _InterlockedAnd(&bufp->flags, ~CM_BUF_DIRTY);
1978                 bufp->error = 0;
1979                 bufp->dirty_offset = 0;
1980                 bufp->dirty_length = 0;
1981                 bufp->dataVersion = CM_BUF_VERSION_BAD; /* known bad */
1982                 bufp->dirtyCounter++;
1983             }
1984             else {
1985                 /* don't set dirty, since dirty implies
1986                  * currently up-to-date.  Don't need to do this,
1987                  * since we'll update the length anyway.
1988                  *
1989                  * Zero out remainder of the page, in case we
1990                  * seek and write past EOF, and make this data
1991                  * visible again.
1992                  */
1993                 bufferPos = sizep->LowPart & (cm_data.buf_blockSize - 1);
1994                 osi_assertx(bufferPos != 0, "non-zero bufferPos");
1995                 memset(bufp->datap + bufferPos, 0,
1996                         cm_data.buf_blockSize - bufferPos);
1997             }
1998         }
1999
2000         cm_SyncOpDone( scp, bufp,
2001                        CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS
2002                        | CM_SCACHESYNC_SETSIZE | CM_SCACHESYNC_BUFLOCKED);
2003
2004         lock_ReleaseWrite(&scp->rw);
2005         lock_ReleaseMutex(&bufp->mx);
2006
2007         if (!code) {
2008             nbufp = bufp->fileHashp;
2009             if (nbufp)
2010                 buf_Hold(nbufp);
2011         } else {
2012             /* This forces the loop to end and the error code
2013              * to be returned. */
2014             nbufp = NULL;
2015         }
2016         buf_Release(bufp);
2017         bufp = nbufp;
2018     }
2019
2020 #ifdef TESTING
2021     buf_ValidateBufQueues();
2022 #endif /* TESTING */
2023
2024     /* done */
2025     return code;
2026 }
2027
2028 long buf_FlushCleanPages(cm_scache_t *scp, cm_user_t *userp, cm_req_t *reqp)
2029 {
2030     long code;
2031     cm_buf_t *bp;               /* buffer we're hacking on */
2032     cm_buf_t *nbp;
2033     int didRelease;
2034     afs_uint32 i;
2035     afs_uint32 stable = 0;
2036
2037     i = BUF_FILEHASH(&scp->fid);
2038
2039     code = 0;
2040     lock_ObtainRead(&buf_globalLock);
2041     bp = cm_data.buf_fileHashTablepp[i];
2042     if (bp)
2043         buf_HoldLocked(bp);
2044     lock_ReleaseRead(&buf_globalLock);
2045
2046     for (; bp; bp = nbp) {
2047         didRelease = 0; /* haven't released this buffer yet */
2048
2049         /* clean buffer synchronously */
2050         if (cm_FidCmp(&bp->fid, &scp->fid) == 0) {
2051
2052             if (code == 0 && !stable && (bp->flags & CM_BUF_DIRTY)) {
2053                 /*
2054                  * we must stabilize the object to ensure that buffer
2055                  * changes cannot occur while the flush is performed.
2056                  * However, we do not want to Stabilize if we do not
2057                  * need to because Stabilize obtains a callback.
2058                  */
2059                 code = (*cm_buf_opsp->Stabilizep)(scp, userp, reqp);
2060                 stable = (code == 0);
2061             }
2062
2063             if (code == CM_ERROR_BADFD) {
2064                 /* if the scp's FID is bad its because we received VNOVNODE
2065                  * when attempting to FetchStatus before the write.  This
2066                  * page therefore contains data that can no longer be stored.
2067                  */
2068                 lock_ObtainMutex(&bp->mx);
2069                 _InterlockedAnd(&bp->flags, ~CM_BUF_DIRTY);
2070                 _InterlockedOr(&bp->flags, CM_BUF_ERROR);
2071                 bp->error = CM_ERROR_BADFD;
2072                 bp->dirty_offset = 0;
2073                 bp->dirty_length = 0;
2074                 bp->dataVersion = CM_BUF_VERSION_BAD;   /* known bad */
2075                 bp->dirtyCounter++;
2076                 lock_ReleaseMutex(&bp->mx);
2077             } else if (!(scp->flags & CM_SCACHEFLAG_RO)) {
2078                 if (code) {
2079                     goto skip;
2080                 }
2081
2082                 lock_ObtainMutex(&bp->mx);
2083
2084                 /* start cleaning the buffer, and wait for it to finish */
2085                 buf_CleanAsyncLocked(scp, bp, reqp, 0, NULL);
2086                 buf_WaitIO(scp, bp);
2087
2088                 lock_ReleaseMutex(&bp->mx);
2089             }
2090
2091             /* actually, we only know that buffer is clean if ref
2092              * count is 1, since we don't have buffer itself locked.
2093              */
2094             if (!(bp->flags & CM_BUF_DIRTY) && !(bp->qFlags & CM_BUF_QREDIR)) {
2095                 lock_ObtainWrite(&buf_globalLock);
2096                 if (!(bp->flags & CM_BUF_DIRTY) && !(bp->qFlags & CM_BUF_QREDIR)) {
2097                     if (bp->refCount == 1) {    /* bp is held above */
2098                         nbp = bp->fileHashp;
2099                         if (nbp)
2100                             buf_HoldLocked(nbp);
2101                         buf_ReleaseLocked(bp, TRUE);
2102                         didRelease = 1;
2103                         buf_Recycle(bp);
2104                     }
2105                 }
2106                 lock_ReleaseWrite(&buf_globalLock);
2107             }
2108         }
2109
2110       skip:
2111         if (!didRelease) {
2112             lock_ObtainRead(&buf_globalLock);
2113             nbp = bp->fileHashp;
2114             if (nbp)
2115                 buf_HoldLocked(nbp);
2116             buf_ReleaseLocked(bp, FALSE);
2117             lock_ReleaseRead(&buf_globalLock);
2118         }
2119     }   /* for loop over a bunch of buffers */
2120
2121     if (stable)
2122         (*cm_buf_opsp->Unstabilizep)(scp, userp);
2123
2124 #ifdef TESTING
2125     buf_ValidateBufQueues();
2126 #endif /* TESTING */
2127
2128     /* done */
2129     return code;
2130 }
2131
2132 /* Must be called with scp->rw held */
2133 long buf_ForceDataVersion(cm_scache_t * scp, afs_uint64 fromVersion, afs_uint64 toVersion)
2134 {
2135     cm_buf_t * bp;
2136     afs_uint32 i;
2137     int found = 0;
2138
2139     lock_AssertAny(&scp->rw);
2140
2141     i = BUF_FILEHASH(&scp->fid);
2142
2143     lock_ObtainRead(&buf_globalLock);
2144
2145     for (bp = cm_data.buf_fileHashTablepp[i]; bp; bp = bp->fileHashp) {
2146         if (cm_FidCmp(&bp->fid, &scp->fid) == 0) {
2147             if (bp->dataVersion == fromVersion) {
2148                 bp->dataVersion = toVersion;
2149                 found = 1;
2150             }
2151         }
2152     }
2153     lock_ReleaseRead(&buf_globalLock);
2154
2155     if (found)
2156         return 0;
2157     else
2158         return ENOENT;
2159 }
2160
2161 long buf_CleanVnode(struct cm_scache *scp, cm_user_t *userp, cm_req_t *reqp)
2162 {
2163     long code = 0;
2164     long wasDirty = 0;
2165     cm_buf_t *bp;               /* buffer we're hacking on */
2166     cm_buf_t *nbp;              /* next one */
2167     afs_uint32 i;
2168
2169     if (RDR_Initialized && scp->redirBufCount > 0) {
2170         /* Retrieve all extents for this file from the redirector */
2171         buf_RDRShakeFileExtentsFree(scp, reqp);
2172     }
2173
2174     i = BUF_FILEHASH(&scp->fid);
2175
2176     lock_ObtainRead(&buf_globalLock);
2177     bp = cm_data.buf_fileHashTablepp[i];
2178     if (bp)
2179         buf_HoldLocked(bp);
2180     lock_ReleaseRead(&buf_globalLock);
2181     for (; bp; bp = nbp) {
2182         /* clean buffer synchronously */
2183         if (cm_FidCmp(&bp->fid, &scp->fid) == 0) {
2184             /*
2185              * If the buffer is held by the redirector we must fetch
2186              * it back in order to determine whether or not it is in
2187              * fact dirty.
2188              */
2189             lock_ObtainRead(&buf_globalLock);
2190             if (bp->qFlags & CM_BUF_QREDIR) {
2191                 osi_Log1(buf_logp,"buf_CleanVnode buffer held by redirector bp 0x%p", bp);
2192
2193                 /* Retrieve single extent from the redirector */
2194                 buf_RDRShakeAnExtentFree(bp, reqp);
2195             }
2196             lock_ReleaseRead(&buf_globalLock);
2197
2198             lock_ObtainMutex(&bp->mx);
2199             if ((bp->flags & CM_BUF_DIRTY)) {
2200                 if (userp && userp != bp->userp) {
2201                     cm_HoldUser(userp);
2202                     if (bp->userp)
2203                         cm_ReleaseUser(bp->userp);
2204                     bp->userp = userp;
2205                 }
2206
2207                 switch (code) {
2208                 case CM_ERROR_NOSUCHFILE:
2209                 case CM_ERROR_BADFD:
2210                 case CM_ERROR_NOACCESS:
2211                 case CM_ERROR_QUOTA:
2212                 case CM_ERROR_SPACE:
2213                 case CM_ERROR_TOOBIG:
2214                 case CM_ERROR_READONLY:
2215                 case CM_ERROR_NOSUCHPATH:
2216                     /*
2217                      * Apply the previous fatal error to this buffer.
2218                      * Do not waste the time attempting to store to
2219                      * the file server when we know it will fail.
2220                      */
2221                     _InterlockedAnd(&bp->flags, ~CM_BUF_DIRTY);
2222                     _InterlockedOr(&bp->flags, CM_BUF_ERROR);
2223                     bp->dirty_offset = 0;
2224                     bp->dirty_length = 0;
2225                     bp->error = code;
2226                     bp->dataVersion = CM_BUF_VERSION_BAD;
2227                     bp->dirtyCounter++;
2228                     break;
2229                 case CM_ERROR_TIMEDOUT:
2230                 case CM_ERROR_ALLDOWN:
2231                 case CM_ERROR_ALLBUSY:
2232                 case CM_ERROR_ALLOFFLINE:
2233                 case CM_ERROR_CLOCKSKEW:
2234                     /* do not mark the buffer in error state but do
2235                      * not attempt to complete the rest either.
2236                      */
2237                     break;
2238                 default:
2239                     code = buf_CleanAsyncLocked(scp, bp, reqp, 0, &wasDirty);
2240                     if (bp->flags & CM_BUF_ERROR) {
2241                         code = bp->error;
2242                         if (code == 0)
2243                             code = -1;
2244                     }
2245                 }
2246                 buf_CleanWait(scp, bp, TRUE);
2247             }
2248             lock_ReleaseMutex(&bp->mx);
2249         }
2250
2251         lock_ObtainRead(&buf_globalLock);
2252         nbp = bp->fileHashp;
2253         if (nbp)
2254             buf_HoldLocked(nbp);
2255         buf_ReleaseLocked(bp, FALSE);
2256         lock_ReleaseRead(&buf_globalLock);
2257     }   /* for loop over a bunch of buffers */
2258
2259 #ifdef TESTING
2260     buf_ValidateBufQueues();
2261 #endif /* TESTING */
2262
2263     /* done */
2264     return code;
2265 }
2266
2267 #ifdef TESTING
2268 void
2269 buf_ValidateBufQueues(void)
2270 {
2271     cm_buf_t * bp, *bpb, *bpf, *bpa;
2272     afs_uint32 countf=0, countb=0, counta=0;
2273
2274     lock_ObtainRead(&buf_globalLock);
2275     for (bp = cm_data.buf_freeListEndp; bp; bp=(cm_buf_t *) osi_QPrev(&bp->q)) {
2276         if (bp->magic != CM_BUF_MAGIC)
2277             osi_panic("buf magic error",__FILE__,__LINE__);
2278         countb++;
2279         bpb = bp;
2280     }
2281
2282     for (bp = cm_data.buf_freeListp; bp; bp=(cm_buf_t *) osi_QNext(&bp->q)) {
2283         if (bp->magic != CM_BUF_MAGIC)
2284             osi_panic("buf magic error",__FILE__,__LINE__);
2285         countf++;
2286         bpf = bp;
2287     }
2288
2289     for (bp = cm_data.buf_allp; bp; bp=bp->allp) {
2290         if (bp->magic != CM_BUF_MAGIC)
2291             osi_panic("buf magic error",__FILE__,__LINE__);
2292         counta++;
2293         bpa = bp;
2294     }
2295     lock_ReleaseRead(&buf_globalLock);
2296
2297     if (countb != countf)
2298         osi_panic("buf magic error",__FILE__,__LINE__);
2299
2300     if (counta != cm_data.buf_nbuffers)
2301         osi_panic("buf magic error",__FILE__,__LINE__);
2302 }
2303 #endif /* TESTING */
2304
2305 /* dump the contents of the buf_scacheHashTablepp. */
2306 int cm_DumpBufHashTable(FILE *outputFile, char *cookie, int lock)
2307 {
2308     int zilch;
2309     cm_buf_t *bp;
2310     char output[1024];
2311     afs_uint32 i;
2312
2313     if (cm_data.buf_scacheHashTablepp == NULL)
2314         return -1;
2315
2316     if (lock)
2317         lock_ObtainRead(&buf_globalLock);
2318
2319     StringCbPrintfA(output, sizeof(output), "%s - dumping buf_HashTable - buf_hashSize=%d\r\n",
2320                     cookie, cm_data.buf_hashSize);
2321     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2322
2323     for (i = 0; i < cm_data.buf_hashSize; i++)
2324     {
2325         for (bp = cm_data.buf_scacheHashTablepp[i]; bp; bp=bp->hashp)
2326         {
2327             StringCbPrintfA(output, sizeof(output),
2328                             "%s bp=0x%08X, hash=%d, fid (cell=%d, volume=%d, "
2329                             "vnode=%d, unique=%d), offset=%x:%08x, dv=%I64d, "
2330                             "flags=0x%x, qFlags=0x%x cmFlags=0x%x, error=0x%x, refCount=%d\r\n",
2331                              cookie, (void *)bp, i, bp->fid.cell, bp->fid.volume,
2332                              bp->fid.vnode, bp->fid.unique, bp->offset.HighPart,
2333                              bp->offset.LowPart, bp->dataVersion, bp->flags, bp->qFlags,
2334                              bp->cmFlags, bp->error, bp->refCount);
2335             WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2336         }
2337     }
2338
2339     StringCbPrintfA(output, sizeof(output), "%s - Done dumping buf_HashTable.\r\n", cookie);
2340     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2341
2342     StringCbPrintfA(output, sizeof(output), "%s - dumping buf_freeListEndp\r\n", cookie);
2343     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2344     for(bp = cm_data.buf_freeListEndp; bp; bp=(cm_buf_t *) osi_QPrev(&bp->q)) {
2345         StringCbPrintfA(output, sizeof(output),
2346                          "%s bp=0x%08X, fid (cell=%d, volume=%d, "
2347                          "vnode=%d, unique=%d), offset=%x:%08x, dv=%I64d, "
2348                          "flags=0x%x, qFlags=0x%x, cmFlags=0x%x, error=0x%x, refCount=%d\r\n",
2349                          cookie, (void *)bp, bp->fid.cell, bp->fid.volume,
2350                          bp->fid.vnode, bp->fid.unique, bp->offset.HighPart,
2351                          bp->offset.LowPart, bp->dataVersion, bp->flags, bp->qFlags,
2352                          bp->cmFlags, bp->error, bp->refCount);
2353         WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2354     }
2355     StringCbPrintfA(output, sizeof(output), "%s - Done dumping buf_FreeListEndp.\r\n", cookie);
2356     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2357
2358     StringCbPrintfA(output, sizeof(output), "%s - dumping buf_dirtyListp\r\n", cookie);
2359     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2360     for(bp = cm_data.buf_dirtyListp; bp; bp=bp->dirtyp) {
2361         StringCbPrintfA(output, sizeof(output),
2362                          "%s bp=0x%08X, fid (cell=%d, volume=%d, "
2363                          "vnode=%d, unique=%d), offset=%x:%08x, dv=%I64d, "
2364                          "flags=0x%x, qFlags=0x%x, cmFlags=0x%x, error=0x%x, refCount=%d\r\n",
2365                          cookie, (void *)bp, bp->fid.cell, bp->fid.volume,
2366                          bp->fid.vnode, bp->fid.unique, bp->offset.HighPart,
2367                          bp->offset.LowPart, bp->dataVersion, bp->flags, bp->qFlags,
2368                          bp->cmFlags, bp->error, bp->refCount);
2369         WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2370     }
2371     StringCbPrintfA(output, sizeof(output), "%s - Done dumping buf_dirtyListp.\r\n", cookie);
2372     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2373
2374     if (lock)
2375         lock_ReleaseRead(&buf_globalLock);
2376     return 0;
2377 }
2378
2379 void buf_ForceTrace(BOOL flush)
2380 {
2381     HANDLE handle;
2382     int len;
2383     char buf[256];
2384
2385     if (!buf_logp)
2386         return;
2387
2388     len = GetTempPath(sizeof(buf)-10, buf);
2389     StringCbCopyA(&buf[len], sizeof(buf)-len, "/afs-buffer.log");
2390     handle = CreateFile(buf, GENERIC_WRITE, FILE_SHARE_READ,
2391                             NULL, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
2392     if (handle == INVALID_HANDLE_VALUE) {
2393         osi_panic("Cannot create log file", __FILE__, __LINE__);
2394     }
2395     osi_LogPrint(buf_logp, handle);
2396     if (flush)
2397         FlushFileBuffers(handle);
2398     CloseHandle(handle);
2399 }
2400
2401 long buf_DirtyBuffersExist(cm_fid_t *fidp)
2402 {
2403     cm_buf_t *bp;
2404     afs_uint32 bcount = 0;
2405     afs_uint32 i;
2406     long found = 0;
2407
2408     i = BUF_FILEHASH(fidp);
2409
2410     lock_ObtainRead(&buf_globalLock);
2411     for (bp = cm_data.buf_fileHashTablepp[i]; bp; bp=bp->fileHashp, bcount++) {
2412         if (!cm_FidCmp(fidp, &bp->fid) && (bp->flags & CM_BUF_DIRTY)) {
2413             found = 1;
2414             break;
2415         }
2416     }
2417     lock_ReleaseRead(&buf_globalLock);
2418     return 0;
2419 }
2420
2421 long buf_RDRBuffersExist(cm_fid_t *fidp)
2422 {
2423     cm_buf_t *bp;
2424     afs_uint32 bcount = 0;
2425     afs_uint32 i;
2426     long found = 0;
2427
2428     if (!RDR_Initialized)
2429         return 0;
2430
2431     i = BUF_FILEHASH(fidp);
2432
2433     lock_ObtainRead(&buf_globalLock);
2434     for (bp = cm_data.buf_fileHashTablepp[i]; bp; bp=bp->fileHashp, bcount++) {
2435         if (!cm_FidCmp(fidp, &bp->fid) && (bp->qFlags & CM_BUF_QREDIR)) {
2436             found = 1;
2437             break;
2438         }
2439     }
2440     lock_ReleaseRead(&buf_globalLock);
2441     return 0;
2442 }
2443
2444 long buf_ClearRDRFlag(cm_scache_t *scp, char *reason)
2445 {
2446     cm_fid_t *fidp = &scp->fid;
2447     cm_buf_t *bp;
2448     afs_uint32 bcount = 0;
2449     afs_uint32 i;
2450
2451     i = BUF_FILEHASH(fidp);
2452
2453     lock_ObtainWrite(&scp->rw);
2454     lock_ObtainRead(&buf_globalLock);
2455     for (bp = cm_data.buf_fileHashTablepp[i]; bp; bp=bp->fileHashp, bcount++) {
2456         if (!cm_FidCmp(fidp, &bp->fid) && (bp->qFlags & CM_BUF_QREDIR)) {
2457             lock_ConvertRToW(&buf_globalLock);
2458             if (bp->qFlags & CM_BUF_QREDIR) {
2459                 osi_Log4(buf_logp,"buf_ClearRDRFlag taking from file system bp 0x%p vno 0x%x foffset 0x%x:%x",
2460                           bp, bp->fid.vnode, bp->offset.HighPart, bp->offset.LowPart);
2461                 buf_RemoveFromRedirQueue(scp, bp);
2462                 buf_ReleaseLocked(bp, TRUE);
2463             }
2464             lock_ConvertWToR(&buf_globalLock);
2465         }
2466     }
2467
2468     /* Confirm that there are none left */
2469     lock_ConvertRToW(&buf_globalLock);
2470     for ( bp = redirq_to_cm_buf_t(scp->redirQueueT);
2471           bp;
2472           bp = redirq_to_cm_buf_t(scp->redirQueueT))
2473     {
2474         if (bp->qFlags & CM_BUF_QREDIR) {
2475             osi_Log4(buf_logp,"buf_ClearRDRFlag taking from file system bufp 0x%p vno 0x%x foffset 0x%x:%x",
2476                       bp, bp->fid.vnode, bp->offset.HighPart, bp->offset.LowPart);
2477             buf_RemoveFromRedirQueue(scp, bp);
2478             buf_ReleaseLocked(bp, TRUE);
2479         }
2480
2481     }
2482     lock_ReleaseWrite(&buf_globalLock);
2483     lock_ReleaseWrite(&scp->rw);
2484     return 0;
2485 }
2486
2487 #if 0
2488 long buf_CleanDirtyBuffers(cm_scache_t *scp)
2489 {
2490     cm_buf_t *bp;
2491     afs_uint32 bcount = 0;
2492     cm_fid_t * fidp = &scp->fid;
2493
2494     for (bp = cm_data.buf_allp; bp; bp=bp->allp, bcount++) {
2495         if (!cm_FidCmp(fidp, &bp->fid) && (bp->flags & CM_BUF_DIRTY)) {
2496             buf_Hold(bp);
2497             lock_ObtainMutex(&bp->mx);
2498             _InterlockedAnd(&bp->cmFlags, ~CM_BUF_CMSTORING);
2499             _InterlockedAnd(&bp->flags, ~CM_BUF_DIRTY);
2500             bp->dirty_offset = 0;
2501             bp->dirty_length = 0;
2502             _InterlockedOr(&bp->flags, CM_BUF_ERROR);
2503             bp->error = VNOVNODE;
2504             bp->dataVersion = CM_BUF_VERSION_BAD; /* bad */
2505             bp->dirtyCounter++;
2506             if (bp->flags & CM_BUF_WAITING) {
2507                 osi_Log2(buf_logp, "BUF CleanDirtyBuffers Waking [scp 0x%x] bp 0x%x", scp, bp);
2508                 osi_Wakeup((long) &bp);
2509             }
2510             lock_ReleaseMutex(&bp->mx);
2511             buf_Release(bp);
2512         }
2513     }
2514     return 0;
2515 }
2516 #endif
2517
2518 /*
2519  * The following routines will not be used on a
2520  * regular basis but are very useful in a variety
2521  * of scenarios when debugging data corruption.
2522  */
2523 const char *
2524 buf_HexCheckSum(cm_buf_t * bp)
2525 {
2526     int i, k;
2527     static char buf[33];
2528     static char tr[16] = {'0','1','2','3','4','5','6','7','8','9','A','B','C','D','E','F'};
2529
2530     for (i=0;i<16;i++) {
2531         k = bp->md5cksum[i];
2532
2533         buf[i*2] = tr[k / 16];
2534         buf[i*2+1] = tr[k % 16];
2535     }
2536     buf[32] = '\0';
2537
2538     return buf;
2539 }
2540
2541 void
2542 buf_ComputeCheckSum(cm_buf_t * bp)
2543 {
2544     MD5_CTX md5;
2545
2546     MD5_Init(&md5);
2547     MD5_Update(&md5, bp->datap, cm_data.blockSize);
2548     MD5_Final(bp->md5cksum, &md5);
2549
2550     osi_Log4(buf_logp, "CheckSum bp 0x%p md5 %s, dirty: offset %u length %u",
2551              bp, osi_LogSaveString(buf_logp, buf_HexCheckSum(bp)),
2552              bp->dirty_offset, bp->dirty_length);
2553 }
2554
2555 int
2556 buf_ValidateCheckSum(cm_buf_t * bp)
2557 {
2558     MD5_CTX md5;
2559     unsigned char tmp[16];
2560
2561     MD5_Init(&md5);
2562     MD5_Update(&md5, bp->datap, cm_data.blockSize);
2563     MD5_Final(tmp, &md5);
2564
2565     if (memcmp(tmp, bp->md5cksum, 16) == 0)
2566         return 1;
2567     return 0;
2568 }
2569
2570 void
2571 buf_InsertToRedirQueue(cm_scache_t *scp, cm_buf_t *bufp)
2572 {
2573     lock_AssertWrite(&buf_globalLock);
2574     if (scp)
2575         lock_AssertWrite(&scp->rw);
2576
2577     if (bufp->qFlags & CM_BUF_QINLRU) {
2578         _InterlockedAnd(&bufp->qFlags, ~CM_BUF_QINLRU);
2579         osi_QRemoveHT( (osi_queue_t **) &cm_data.buf_freeListp,
2580                        (osi_queue_t **) &cm_data.buf_freeListEndp,
2581                        &bufp->q);
2582         buf_DecrementFreeCount();
2583     }
2584     _InterlockedOr(&bufp->qFlags, CM_BUF_QREDIR);
2585     osi_QAddH( (osi_queue_t **) &cm_data.buf_redirListp,
2586                (osi_queue_t **) &cm_data.buf_redirListEndp,
2587                &bufp->q);
2588     buf_IncrementRedirCount();
2589     bufp->redirLastAccess = time(NULL);
2590     if (scp) {
2591         osi_QAddH( (osi_queue_t **) &scp->redirQueueH,
2592                    (osi_queue_t **) &scp->redirQueueT,
2593                    &bufp->redirq);
2594         scp->redirLastAccess = bufp->redirLastAccess;
2595         InterlockedIncrement(&scp->redirBufCount);
2596     }
2597 }
2598
2599 void
2600 buf_RemoveFromRedirQueue(cm_scache_t *scp, cm_buf_t *bufp)
2601 {
2602     lock_AssertWrite(&buf_globalLock);
2603     if (scp)
2604         lock_AssertWrite(&scp->rw);
2605
2606     _InterlockedAnd(&bufp->qFlags, ~CM_BUF_QREDIR);
2607     osi_QRemoveHT( (osi_queue_t **) &cm_data.buf_redirListp,
2608                    (osi_queue_t **) &cm_data.buf_redirListEndp,
2609                    &bufp->q);
2610     buf_DecrementRedirCount();
2611     if (scp) {
2612         osi_QRemoveHT( (osi_queue_t **) &scp->redirQueueH,
2613                        (osi_queue_t **) &scp->redirQueueT,
2614                        &bufp->redirq);
2615         InterlockedDecrement(&scp->redirBufCount);
2616     }
2617 }
2618
2619 void
2620 buf_MoveToHeadOfRedirQueue(cm_scache_t *scp, cm_buf_t *bufp)
2621 {
2622     lock_AssertWrite(&buf_globalLock);
2623     osi_assertx(bufp->qFlags & CM_BUF_QREDIR,
2624                  "buf_MoveToHeadOfRedirQueue buffer not held by redirector");
2625
2626     if (scp)
2627         lock_AssertWrite(&scp->rw);
2628
2629     osi_QRemoveHT( (osi_queue_t **) &cm_data.buf_redirListp,
2630                    (osi_queue_t **) &cm_data.buf_redirListEndp,
2631                    &bufp->q);
2632     osi_QAddH( (osi_queue_t **) &cm_data.buf_redirListp,
2633                (osi_queue_t **) &cm_data.buf_redirListEndp,
2634                &bufp->q);
2635     bufp->redirLastAccess = time(NULL);
2636     if (scp) {
2637         osi_QRemoveHT( (osi_queue_t **) &scp->redirQueueH,
2638                        (osi_queue_t **) &scp->redirQueueT,
2639                        &bufp->redirq);
2640         osi_QAddH( (osi_queue_t **) &scp->redirQueueH,
2641                    (osi_queue_t **) &scp->redirQueueT,
2642                    &bufp->redirq);
2643         scp->redirLastAccess = bufp->redirLastAccess;
2644     }
2645 }