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