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 <afs/param.h>
  13 #include <afs/stds.h>
  14
  15 #include <windows.h>
  16 #include <osi.h>
  17 #include <stdio.h>
  18 #include <assert.h>
  19 #include <strsafe.h>
  20 #include <math.h>
  21
  22 #include "afsd.h"
  23 #include "cm_memmap.h"
  24
  25 #ifdef DEBUG
  26 #define TRACE_BUFFER 1
  27 #endif
  28
  29 extern void afsi_log(char *pattern, ...);
  30
  31 /* This module implements the buffer package used by the local transaction
  32  * system (cm).  It is initialized by calling cm_Init, which calls buf_Init;
  33  * it must be initalized before any of its main routines are called.
  34  *
  35  * Each buffer is hashed into a hash table by file ID and offset, and if its
  36  * reference count is zero, it is also in a free list.
  37  *
  38  * There are two locks involved in buffer processing.  The global lock
  39  * buf_globalLock protects all of the global variables defined in this module,
  40  * the reference counts and hash pointers in the actual cm_buf_t structures,
  41  * and the LRU queue pointers in the buffer structures.
  42  *
  43  * The mutexes in the buffer structures protect the remaining fields in the
  44  * buffers, as well the data itself.
  45  *
  46  * The locking hierarchy here is this:
  47  *
  48  * - resv multiple simul. buffers reservation
  49  * - lock buffer I/O flags
  50  * - lock buffer's mutex
  51  * - lock buf_globalLock
  52  *
  53  */
  54
  55 /* global debugging log */
  56 osi_log_t *buf_logp = NULL;
  57
  58 /* Global lock protecting hash tables and free lists */
  59 osi_rwlock_t buf_globalLock;
  60
  61 /* ptr to head of the free list (most recently used) and the
  62  * tail (the guy to remove first).  We use osi_Q* functions
  63  * to put stuff in buf_freeListp, and maintain the end
  64  * pointer manually
  65  */
  66
  67 /* a pointer to a list of all buffers, just so that we can find them
  68  * easily for debugging, and for the incr syncer.  Locked under
  69  * the global lock.
  70  */
  71
  72 /* defaults setup; these variables may be manually assigned into
  73  * before calling cm_Init, as a way of changing these defaults.
  74  */
  75
  76 /* callouts for reading and writing data, etc */
  77 cm_buf_ops_t *cm_buf_opsp;
  78
  79 #ifdef DISKCACHE95
  80 /* for experimental disk caching support in Win95 client */
  81 cm_buf_t *buf_diskFreeListp;
  82 cm_buf_t *buf_diskFreeListEndp;
  83 cm_buf_t *buf_diskAllp;
  84 extern int cm_diskCacheEnabled;
  85 #endif /* DISKCACHE95 */
  86
  87 /* set this to 1 when we are terminating to prevent access attempts */
  88 static int buf_ShutdownFlag = 0;
  89
  90 #ifdef DEBUG_REFCOUNT
  91 void buf_HoldLockedDbg(cm_buf_t *bp, char *file, long line)
  92 #else
  93 void buf_HoldLocked(cm_buf_t *bp)
  94 #endif
  95 {
  96     afs_int32 refCount;
  97
  98     osi_assertx(bp->magic == CM_BUF_MAGIC,"incorrect cm_buf_t magic");
  99     refCount = InterlockedIncrement(&bp->refCount);
 100 #ifdef DEBUG_REFCOUNT
 101     osi_Log2(afsd_logp,"buf_HoldLocked bp 0x%p ref %d",bp, refCount);
 102     afsi_log("%s:%d buf_HoldLocked bp 0x%p, ref %d", file, line, bp, refCount);
 103 #endif
 104 }
 105
 106 /* hold a reference to an already held buffer */
 107 #ifdef DEBUG_REFCOUNT
 108 void buf_HoldDbg(cm_buf_t *bp, char *file, long line)
 109 #else
 110 void buf_Hold(cm_buf_t *bp)
 111 #endif
 112 {
 113     afs_int32 refCount;
 114
 115     lock_ObtainRead(&buf_globalLock);
 116     osi_assertx(bp->magic == CM_BUF_MAGIC,"incorrect cm_buf_t magic");
 117     refCount = InterlockedIncrement(&bp->refCount);
 118 #ifdef DEBUG_REFCOUNT
 119     osi_Log2(afsd_logp,"buf_Hold bp 0x%p ref %d",bp, refCount);
 120     afsi_log("%s:%d buf_Hold bp 0x%p, ref %d", file, line, bp, refCount);
 121 #endif
 122     lock_ReleaseRead(&buf_globalLock);
 123 }
 124
 125 /* code to drop reference count while holding buf_globalLock */
 126 #ifdef DEBUG_REFCOUNT
 127 void buf_ReleaseLockedDbg(cm_buf_t *bp, afs_uint32 writeLocked, char *file, long line)
 128 #else
 129 void buf_ReleaseLocked(cm_buf_t *bp, afs_uint32 writeLocked)
 130 #endif
 131 {
 132     afs_int32 refCount;
 133
 134     if (writeLocked)
 135         lock_AssertWrite(&buf_globalLock);
 136     else
 137         lock_AssertRead(&buf_globalLock);
 138
 139     /* ensure that we're in the LRU queue if our ref count is 0 */
 140     osi_assertx(bp->magic == CM_BUF_MAGIC,"incorrect cm_buf_t magic");
 141
 142     refCount = InterlockedDecrement(&bp->refCount);
 143 #ifdef DEBUG_REFCOUNT
 144     osi_Log3(afsd_logp,"buf_ReleaseLocked %s bp 0x%p ref %d",writeLocked?"write":"read", bp, refCount);
 145     afsi_log("%s:%d buf_ReleaseLocked %s bp 0x%p, ref %d", file, line, writeLocked?"write":"read", bp, refCount);
 146 #endif
 147 #ifdef DEBUG
 148     if (refCount < 0)
 149         osi_panic("buf refcount 0",__FILE__,__LINE__);;
 150 #else
 151     osi_assertx(refCount >= 0, "cm_buf_t refCount == 0");
 152 #endif
 153     if (refCount == 0) {
 154         /*
 155          * If we are read locked there could be a race condition
 156          * with buf_Find() so we must obtain a write lock and
 157          * double check that the refCount is actually zero
 158          * before we remove the buffer from the LRU queue.
 159          */
 160         if (!writeLocked)
 161             lock_ConvertRToW(&buf_globalLock);
 162
 163         if (bp->refCount == 0 &&
 164             !(bp->flags & CM_BUF_INLRU)) {
 165             osi_QAdd((osi_queue_t **) &cm_data.buf_freeListp, &bp->q);
 166
 167             /* watch for transition from empty to one element */
 168             if (!cm_data.buf_freeListEndp)
 169                 cm_data.buf_freeListEndp = cm_data.buf_freeListp;
 170             bp->flags |= CM_BUF_INLRU;
 171         }
 172
 173         if (!writeLocked)
 174             lock_ConvertWToR(&buf_globalLock);
 175     }
 176 }
 177
 178 /* release a buffer.  Buffer must be referenced, but unlocked. */
 179 #ifdef DEBUG_REFCOUNT
 180 void buf_ReleaseDbg(cm_buf_t *bp, char *file, long line)
 181 #else
 182 void buf_Release(cm_buf_t *bp)
 183 #endif
 184 {
 185     afs_int32 refCount;
 186
 187     /* ensure that we're in the LRU queue if our ref count is 0 */
 188     osi_assertx(bp->magic == CM_BUF_MAGIC,"incorrect cm_buf_t magic");
 189
 190     refCount = InterlockedDecrement(&bp->refCount);
 191 #ifdef DEBUG_REFCOUNT
 192     osi_Log2(afsd_logp,"buf_Release bp 0x%p ref %d", bp, refCount);
 193     afsi_log("%s:%d buf_ReleaseLocked bp 0x%p, ref %d", file, line, bp, refCount);
 194 #endif
 195 #ifdef DEBUG
 196     if (refCount < 0)
 197         osi_panic("buf refcount 0",__FILE__,__LINE__);;
 198 #else
 199     osi_assertx(refCount >= 0, "cm_buf_t refCount == 0");
 200 #endif
 201     if (refCount == 0) {
 202         lock_ObtainWrite(&buf_globalLock);
 203         if (bp->refCount == 0 &&
 204             !(bp->flags & CM_BUF_INLRU)) {
 205             osi_QAdd((osi_queue_t **) &cm_data.buf_freeListp, &bp->q);
 206
 207             /* watch for transition from empty to one element */
 208             if (!cm_data.buf_freeListEndp)
 209                 cm_data.buf_freeListEndp = cm_data.buf_freeListp;
 210             bp->flags |= CM_BUF_INLRU;
 211         }
 212         lock_ReleaseWrite(&buf_globalLock);
 213     }
 214 }
 215
 216 /* incremental sync daemon.  Writes all dirty buffers every 5000 ms */
 217 void buf_IncrSyncer(long parm)
 218 {
 219     cm_buf_t **bpp, *bp, *prevbp;
 220     long i;                             /* counter */
 221     long wasDirty = 0;
 222     cm_req_t req;
 223
 224     while (buf_ShutdownFlag == 0) {
 225         if (!wasDirty) {
 226             i = SleepEx(5000, 1);
 227             if (i != 0) continue;
 228         }
 229
 230         wasDirty = 0;
 231
 232         /* go through all of the dirty buffers */
 233         lock_ObtainRead(&buf_globalLock);
 234         for (bpp = &cm_data.buf_dirtyListp, prevbp = NULL; bp = *bpp; ) {
 235             lock_ReleaseRead(&buf_globalLock);
 236             /* all dirty buffers are held when they are added to the
 237              * dirty list.  No need for an additional hold.
 238              */
 239             lock_ObtainMutex(&bp->mx);
 240
 241             if (bp->flags & CM_BUF_DIRTY) {
 242                 /* start cleaning the buffer; don't touch log pages since
 243                  * the log code counts on knowing exactly who is writing
 244                  * a log page at any given instant.
 245                  */
 246                 cm_InitReq(&req);
 247                 req.flags |= CM_REQ_NORETRY;
 248                 wasDirty |= buf_CleanAsyncLocked(bp, &req);
 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_IncrSyncer bp 0x%p list corruption",bp);
 261                     afsi_log("buf_IncrSyncer bp 0x%p list corruption", bp);
 262                 }
 263 #endif
 264                 *bpp = bp->dirtyp;
 265                 bp->dirtyp = NULL;
 266                 bp->flags &= ~CM_BUF_INDL;
 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                 /* advance the pointer so we don't loop forever */
 275                 lock_ObtainRead(&buf_globalLock);
 276                 bpp = &bp->dirtyp;
 277                 prevbp = bp;
 278             }
 279             lock_ReleaseMutex(&bp->mx);
 280         }       /* for loop over a bunch of buffers */
 281         lock_ReleaseRead(&buf_globalLock);
 282     }           /* whole daemon's while loop */
 283 }
 284
 285 long
 286 buf_ValidateBuffers(void)
 287 {
 288     cm_buf_t * bp, *bpf, *bpa, *bpb;
 289     afs_uint64 countb = 0, countf = 0, counta = 0;
 290
 291     if (cm_data.buf_freeListp == NULL && cm_data.buf_freeListEndp != NULL ||
 292          cm_data.buf_freeListp != NULL && cm_data.buf_freeListEndp == NULL) {
 293         afsi_log("cm_ValidateBuffers failure: inconsistent free list pointers");
 294         fprintf(stderr, "cm_ValidateBuffers failure: inconsistent free list pointers\n");
 295         return -9;
 296     }
 297
 298     for (bp = cm_data.buf_freeListEndp; bp; bp=(cm_buf_t *) osi_QPrev(&bp->q)) {
 299         if (bp->magic != CM_BUF_MAGIC) {
 300             afsi_log("cm_ValidateBuffers failure: bp->magic != CM_BUF_MAGIC");
 301             fprintf(stderr, "cm_ValidateBuffers failure: bp->magic != CM_BUF_MAGIC\n");
 302             return -1;
 303         }
 304         countb++;
 305         bpb = bp;
 306
 307         if (countb > cm_data.buf_nbuffers) {
 308             afsi_log("cm_ValidateBuffers failure: countb > cm_data.buf_nbuffers");
 309             fprintf(stderr, "cm_ValidateBuffers failure: countb > cm_data.buf_nbuffers\n");
 310             return -6;
 311         }
 312     }
 313
 314     for (bp = cm_data.buf_freeListp; bp; bp=(cm_buf_t *) osi_QNext(&bp->q)) {
 315         if (bp->magic != CM_BUF_MAGIC) {
 316             afsi_log("cm_ValidateBuffers failure: bp->magic != CM_BUF_MAGIC");
 317             fprintf(stderr, "cm_ValidateBuffers failure: bp->magic != CM_BUF_MAGIC\n");
 318             return -2;
 319         }
 320         countf++;
 321         bpf = bp;
 322
 323         if (countf > cm_data.buf_nbuffers) {
 324             afsi_log("cm_ValidateBuffers failure: countf > cm_data.buf_nbuffers");
 325             fprintf(stderr, "cm_ValidateBuffers failure: countf > cm_data.buf_nbuffers\n");
 326             return -7;
 327         }
 328     }
 329
 330     for (bp = cm_data.buf_allp; bp; bp=bp->allp) {
 331         if (bp->magic != CM_BUF_MAGIC) {
 332             afsi_log("cm_ValidateBuffers failure: bp->magic != CM_BUF_MAGIC");
 333             fprintf(stderr, "cm_ValidateBuffers failure: bp->magic != CM_BUF_MAGIC\n");
 334             return -3;
 335         }
 336         counta++;
 337         bpa = bp;
 338
 339         if (counta > cm_data.buf_nbuffers) {
 340             afsi_log("cm_ValidateBuffers failure: counta > cm_data.buf_nbuffers");
 341             fprintf(stderr, "cm_ValidateBuffers failure: counta > cm_data.buf_nbuffers\n");
 342             return -8;
 343         }
 344     }
 345
 346     if (countb != countf) {
 347         afsi_log("cm_ValidateBuffers failure: countb != countf");
 348         fprintf(stderr, "cm_ValidateBuffers failure: countb != countf\n");
 349         return -4;
 350     }
 351
 352     if (counta != cm_data.buf_nbuffers) {
 353         afsi_log("cm_ValidateBuffers failure: counta != cm_data.buf_nbuffers");
 354         fprintf(stderr, "cm_ValidateBuffers failure: counta != cm_data.buf_nbuffers\n");
 355         return -5;
 356     }
 357
 358     return 0;
 359 }
 360
 361 void buf_Shutdown(void)
 362 {
 363     buf_ShutdownFlag = 1;
 364 }
 365
 366 /* initialize the buffer package; called with no locks
 367  * held during the initialization phase.
 368  */
 369 long buf_Init(int newFile, cm_buf_ops_t *opsp, afs_uint64 nbuffers)
 370 {
 371     static osi_once_t once;
 372     cm_buf_t *bp;
 373     thread_t phandle;
 374     long i;
 375     unsigned long pid;
 376     char *data;
 377
 378     if ( newFile ) {
 379         if (nbuffers)
 380             cm_data.buf_nbuffers = nbuffers;
 381
 382         /* Have to be able to reserve a whole chunk */
 383         if (((cm_data.buf_nbuffers - 3) * cm_data.buf_blockSize) < cm_chunkSize)
 384             return CM_ERROR_TOOFEWBUFS;
 385     }
 386
 387     /* recall for callouts */
 388     cm_buf_opsp = opsp;
 389
 390     if (osi_Once(&once)) {
 391         /* initialize global locks */
 392         lock_InitializeRWLock(&buf_globalLock, "Global buffer lock");
 393
 394         if ( newFile ) {
 395             /* remember this for those who want to reset it */
 396             cm_data.buf_nOrigBuffers = cm_data.buf_nbuffers;
 397
 398             /* lower hash size to a prime number */
 399             cm_data.buf_hashSize = osi_PrimeLessThan((afs_uint32)(cm_data.buf_nbuffers/7 + 1));
 400
 401             /* create hash table */
 402             memset((void *)cm_data.buf_scacheHashTablepp, 0, cm_data.buf_hashSize * sizeof(cm_buf_t *));
 403
 404             /* another hash table */
 405             memset((void *)cm_data.buf_fileHashTablepp, 0, cm_data.buf_hashSize * sizeof(cm_buf_t *));
 406
 407             /* create buffer headers and put in free list */
 408             bp = cm_data.bufHeaderBaseAddress;
 409             data = cm_data.bufDataBaseAddress;
 410             cm_data.buf_allp = NULL;
 411
 412             for (i=0; i<cm_data.buf_nbuffers; i++) {
 413                 osi_assertx(bp >= cm_data.bufHeaderBaseAddress && bp < (cm_buf_t *)cm_data.bufDataBaseAddress,
 414                             "invalid cm_buf_t address");
 415                 osi_assertx(data >= cm_data.bufDataBaseAddress && data < cm_data.bufEndOfData,
 416                             "invalid cm_buf_t data address");
 417
 418                 /* allocate and zero some storage */
 419                 memset(bp, 0, sizeof(cm_buf_t));
 420                 bp->magic = CM_BUF_MAGIC;
 421                 /* thread on list of all buffers */
 422                 bp->allp = cm_data.buf_allp;
 423                 cm_data.buf_allp = bp;
 424
 425                 osi_QAdd((osi_queue_t **)&cm_data.buf_freeListp, &bp->q);
 426                 bp->flags |= CM_BUF_INLRU;
 427                 lock_InitializeMutex(&bp->mx, "Buffer mutex");
 428
 429                 /* grab appropriate number of bytes from aligned zone */
 430                 bp->datap = data;
 431
 432                 /* setup last buffer pointer */
 433                 if (i == 0)
 434                     cm_data.buf_freeListEndp = bp;
 435
 436                 /* next */
 437                 bp++;
 438                 data += cm_data.buf_blockSize;
 439             }
 440
 441             /* none reserved at first */
 442             cm_data.buf_reservedBufs = 0;
 443
 444             /* just for safety's sake */
 445             cm_data.buf_maxReservedBufs = cm_data.buf_nbuffers - 3;
 446         } else {
 447             bp = cm_data.bufHeaderBaseAddress;
 448             data = cm_data.bufDataBaseAddress;
 449
 450             for (i=0; i<cm_data.buf_nbuffers; i++) {
 451                 lock_InitializeMutex(&bp->mx, "Buffer mutex");
 452                 bp->userp = NULL;
 453                 bp->waitCount = 0;
 454                 bp->waitRequests = 0;
 455                 bp->flags &= ~CM_BUF_WAITING;
 456                 bp++;
 457             }
 458         }
 459
 460 #ifdef TESTING
 461         buf_ValidateBufQueues();
 462 #endif /* TESTING */
 463
 464 #ifdef TRACE_BUFFER
 465         /* init the buffer trace log */
 466         buf_logp = osi_LogCreate("buffer", 1000);
 467         osi_LogEnable(buf_logp);
 468 #endif
 469
 470         osi_EndOnce(&once);
 471
 472         /* and create the incr-syncer */
 473         phandle = thrd_Create(0, 0,
 474                                (ThreadFunc) buf_IncrSyncer, 0, 0, &pid,
 475                                "buf_IncrSyncer");
 476
 477         osi_assertx(phandle != NULL, "buf: can't create incremental sync proc");
 478         CloseHandle(phandle);
 479     }
 480
 481 #ifdef TESTING
 482     buf_ValidateBufQueues();
 483 #endif /* TESTING */
 484     return 0;
 485 }
 486
 487 /* add nbuffers to the buffer pool, if possible.
 488  * Called with no locks held.
 489  */
 490 long buf_AddBuffers(afs_uint64 nbuffers)
 491 {
 492     /* The size of a virtual cache cannot be changed after it has
 493      * been created.  Subsequent calls to MapViewofFile() with
 494      * an existing mapping object name would not allow the
 495      * object to be resized.  Return failure immediately.
 496      *
 497      * A similar problem now occurs with the persistent cache
 498      * given that the memory mapped file now contains a complex
 499      * data structure.
 500      */
 501     afsi_log("request to add %d buffers to the existing cache of size %d denied",
 502               nbuffers, cm_data.buf_nbuffers);
 503
 504     return CM_ERROR_INVAL;
 505 }
 506
 507 /* interface to set the number of buffers to an exact figure.
 508  * Called with no locks held.
 509  */
 510 long buf_SetNBuffers(afs_uint64 nbuffers)
 511 {
 512     if (nbuffers < 10)
 513         return CM_ERROR_INVAL;
 514     if (nbuffers == cm_data.buf_nbuffers)
 515         return 0;
 516     else if (nbuffers > cm_data.buf_nbuffers)
 517         return buf_AddBuffers(nbuffers - cm_data.buf_nbuffers);
 518     else
 519         return CM_ERROR_INVAL;
 520 }
 521
 522 /* wait for reading or writing to clear; called with write-locked
 523  * buffer and unlocked scp and returns with locked buffer.
 524  */
 525 void buf_WaitIO(cm_scache_t * scp, cm_buf_t *bp)
 526 {
 527     int release = 0;
 528
 529     if (scp)
 530         osi_assertx(scp->magic == CM_SCACHE_MAGIC, "invalid cm_scache_t magic");
 531     osi_assertx(bp->magic == CM_BUF_MAGIC, "invalid cm_buf_t magic");
 532
 533     while (1) {
 534         /* if no IO is happening, we're done */
 535         if (!(bp->flags & (CM_BUF_READING | CM_BUF_WRITING)))
 536             break;
 537
 538         /* otherwise I/O is happening, but some other thread is waiting for
 539          * the I/O already.  Wait for that guy to figure out what happened,
 540          * and then check again.
 541          */
 542         if ( bp->flags & CM_BUF_WAITING ) {
 543             bp->waitCount++;
 544             bp->waitRequests++;
 545             osi_Log1(buf_logp, "buf_WaitIO CM_BUF_WAITING already set for 0x%p", bp);
 546         } else {
 547             osi_Log1(buf_logp, "buf_WaitIO CM_BUF_WAITING set for 0x%p", bp);
 548             bp->flags |= CM_BUF_WAITING;
 549             bp->waitCount = bp->waitRequests = 1;
 550         }
 551         osi_SleepM((LONG_PTR)bp, &bp->mx);
 552
 553         smb_UpdateServerPriority();
 554
 555         lock_ObtainMutex(&bp->mx);
 556         osi_Log1(buf_logp, "buf_WaitIO conflict wait done for 0x%p", bp);
 557         bp->waitCount--;
 558         if (bp->waitCount == 0) {
 559             osi_Log1(buf_logp, "buf_WaitIO CM_BUF_WAITING reset for 0x%p", bp);
 560             bp->flags &= ~CM_BUF_WAITING;
 561             bp->waitRequests = 0;
 562         }
 563
 564         if ( !scp ) {
 565             if (scp = cm_FindSCache(&bp->fid))
 566                  release = 1;
 567         }
 568         if ( scp ) {
 569             lock_ObtainRead(&scp->rw);
 570             if (scp->flags & CM_SCACHEFLAG_WAITING) {
 571                 osi_Log1(buf_logp, "buf_WaitIO waking scp 0x%p", scp);
 572                 osi_Wakeup((LONG_PTR)&scp->flags);
 573             }
 574             lock_ReleaseRead(&scp->rw);
 575         }
 576     }
 577
 578     /* if we get here, the IO is done, but we may have to wakeup people waiting for
 579      * the I/O to complete.  Do so.
 580      */
 581     if (bp->flags & CM_BUF_WAITING) {
 582         osi_Log1(buf_logp, "buf_WaitIO Waking bp 0x%p", bp);
 583         osi_Wakeup((LONG_PTR) bp);
 584     }
 585     osi_Log1(buf_logp, "WaitIO finished wait for bp 0x%p", bp);
 586
 587     if (scp && release)
 588         cm_ReleaseSCache(scp);
 589 }
 590
 591 /* find a buffer, if any, for a particular file ID and offset.  Assumes
 592  * that buf_globalLock is write locked when called.
 593  */
 594 cm_buf_t *buf_FindLocked(struct cm_scache *scp, osi_hyper_t *offsetp)
 595 {
 596     afs_uint32 i;
 597     cm_buf_t *bp;
 598
 599     i = BUF_HASH(&scp->fid, offsetp);
 600     for(bp = cm_data.buf_scacheHashTablepp[i]; bp; bp=bp->hashp) {
 601         if (cm_FidCmp(&scp->fid, &bp->fid) == 0
 602              && offsetp->LowPart == bp->offset.LowPart
 603              && offsetp->HighPart == bp->offset.HighPart) {
 604             buf_HoldLocked(bp);
 605             break;
 606         }
 607     }
 608
 609     /* return whatever we found, if anything */
 610     return bp;
 611 }
 612
 613 /* find a buffer with offset *offsetp for vnode *scp.  Called
 614  * with no locks held.
 615  */
 616 cm_buf_t *buf_Find(struct cm_scache *scp, osi_hyper_t *offsetp)
 617 {
 618     cm_buf_t *bp;
 619
 620     lock_ObtainRead(&buf_globalLock);
 621     bp = buf_FindLocked(scp, offsetp);
 622     lock_ReleaseRead(&buf_globalLock);
 623
 624     return bp;
 625 }
 626
 627 /* start cleaning I/O on this buffer.  Buffer must be write locked, and is returned
 628  * write-locked.
 629  *
 630  * Makes sure that there's only one person writing this block
 631  * at any given time, and also ensures that the log is forced sufficiently far,
 632  * if this buffer contains logged data.
 633  *
 634  * Returns non-zero if the buffer was dirty.
 635  */
 636 long buf_CleanAsyncLocked(cm_buf_t *bp, cm_req_t *reqp)
 637 {
 638     long code = 0;
 639     long isdirty = 0;
 640     cm_scache_t * scp = NULL;
 641     osi_hyper_t offset;
 642
 643     osi_assertx(bp->magic == CM_BUF_MAGIC, "invalid cm_buf_t magic");
 644
 645     while ((bp->flags & CM_BUF_DIRTY) == CM_BUF_DIRTY) {
 646         isdirty = 1;
 647         lock_ReleaseMutex(&bp->mx);
 648
 649         scp = cm_FindSCache(&bp->fid);
 650         if (scp) {
 651             osi_Log2(buf_logp, "buf_CleanAsyncLocked starts I/O on scp 0x%p buf 0x%p", scp, bp);
 652
 653             offset = bp->offset;
 654             LargeIntegerAdd(offset, ConvertLongToLargeInteger(bp->dirty_offset));
 655             code = (*cm_buf_opsp->Writep)(scp, &offset,
 656 #if 1
 657                                            /* we might as well try to write all of the contiguous
 658                                             * dirty buffers in one RPC
 659                                             */
 660                                            cm_chunkSize,
 661 #else
 662                                           bp->dirty_length,
 663 #endif
 664                                           0, bp->userp, reqp);
 665             osi_Log3(buf_logp, "buf_CleanAsyncLocked I/O on scp 0x%p buf 0x%p, done=%d", scp, bp, code);
 666
 667             cm_ReleaseSCache(scp);
 668             scp = NULL;
 669         } else {
 670             osi_Log1(buf_logp, "buf_CleanAsyncLocked unable to start I/O - scp not found buf 0x%p", bp);
 671             code = CM_ERROR_NOSUCHFILE;
 672         }
 673
 674         lock_ObtainMutex(&bp->mx);
 675         /* if the Write routine returns No Such File, clear the dirty flag
 676          * because we aren't going to be able to write this data to the file
 677          * server.
 678          */
 679         if (code == CM_ERROR_NOSUCHFILE || code == CM_ERROR_BADFD){
 680             bp->flags &= ~CM_BUF_DIRTY;
 681             bp->flags |= CM_BUF_ERROR;
 682             bp->dirty_offset = 0;
 683             bp->dirty_length = 0;
 684             bp->error = code;
 685             bp->dataVersion = CM_BUF_VERSION_BAD; /* bad */
 686             bp->dirtyCounter++;
 687         }
 688
 689 #ifdef DISKCACHE95
 690         /* Disk cache support */
 691         /* write buffer to disk cache (synchronous for now) */
 692         diskcache_Update(bp->dcp, bp->datap, cm_data.buf_blockSize, bp->dataVersion);
 693 #endif /* DISKCACHE95 */
 694
 695         /* if we get here and retries are not permitted
 696          * then we need to exit this loop regardless of
 697          * whether or not we were able to clear the dirty bit
 698          */
 699         if (reqp->flags & CM_REQ_NORETRY)
 700             break;
 701     };
 702
 703     if (!(bp->flags & CM_BUF_DIRTY)) {
 704         /* remove buffer from dirty buffer queue */
 705
 706     }
 707
 708     /* do logging after call to GetLastError, or else */
 709
 710     /* if someone was waiting for the I/O that just completed or failed,
 711      * wake them up.
 712      */
 713     if (bp->flags & CM_BUF_WAITING) {
 714         /* turn off flags and wakeup users */
 715         osi_Log1(buf_logp, "buf_WaitIO Waking bp 0x%p", bp);
 716         osi_Wakeup((LONG_PTR) bp);
 717     }
 718     return isdirty;
 719 }
 720
 721 /* Called with a zero-ref count buffer and with the buf_globalLock write locked.
 722  * recycles the buffer, and leaves it ready for reuse with a ref count of 1.
 723  * The buffer must already be clean, and no I/O should be happening to it.
 724  */
 725 void buf_Recycle(cm_buf_t *bp)
 726 {
 727     afs_uint32 i;
 728     cm_buf_t **lbpp;
 729     cm_buf_t *tbp;
 730     cm_buf_t *prevBp, *nextBp;
 731
 732     osi_assertx(bp->magic == CM_BUF_MAGIC, "invalid cm_buf_t magic");
 733
 734     /* if we get here, we know that the buffer still has a 0 ref count,
 735      * and that it is clean and has no currently pending I/O.  This is
 736      * the dude to return.
 737      * Remember that as long as the ref count is 0, we know that we won't
 738      * have any lock conflicts, so we can grab the buffer lock out of
 739      * order in the locking hierarchy.
 740      */
 741     osi_Log3( buf_logp, "buf_Recycle recycles 0x%p, off 0x%x:%08x",
 742               bp, bp->offset.HighPart, bp->offset.LowPart);
 743
 744     osi_assertx(bp->refCount == 0, "cm_buf_t refcount != 0");
 745     osi_assertx(!(bp->flags & (CM_BUF_READING | CM_BUF_WRITING | CM_BUF_DIRTY)),
 746                 "incorrect cm_buf_t flags");
 747     lock_AssertWrite(&buf_globalLock);
 748
 749     if (bp->flags & CM_BUF_INHASH) {
 750         /* Remove from hash */
 751
 752         i = BUF_HASH(&bp->fid, &bp->offset);
 753         lbpp = &(cm_data.buf_scacheHashTablepp[i]);
 754         for(tbp = *lbpp; tbp; lbpp = &tbp->hashp, tbp = *lbpp) {
 755             if (tbp == bp)
 756                 break;
 757         }
 758
 759         /* we better find it */
 760         osi_assertx(tbp != NULL, "buf_Recycle: hash table screwup");
 761
 762         *lbpp = bp->hashp;      /* hash out */
 763         bp->hashp = NULL;
 764
 765         /* Remove from file hash */
 766
 767         i = BUF_FILEHASH(&bp->fid);
 768         prevBp = bp->fileHashBackp;
 769         bp->fileHashBackp = NULL;
 770         nextBp = bp->fileHashp;
 771         bp->fileHashp = NULL;
 772         if (prevBp)
 773             prevBp->fileHashp = nextBp;
 774         else
 775             cm_data.buf_fileHashTablepp[i] = nextBp;
 776         if (nextBp)
 777             nextBp->fileHashBackp = prevBp;
 778
 779         bp->flags &= ~CM_BUF_INHASH;
 780     }
 781
 782     /* make the fid unrecognizable */
 783     memset(&bp->fid, 0, sizeof(cm_fid_t));
 784 }
 785
 786 /* recycle a buffer, removing it from the free list, hashing in its new identity
 787  * and returning it write-locked so that no one can use it.  Called without
 788  * any locks held, and can return an error if it loses the race condition and
 789  * finds that someone else created the desired buffer.
 790  *
 791  * If success is returned, the buffer is returned write-locked.
 792  *
 793  * May be called with null scp and offsetp, if we're just trying to reclaim some
 794  * space from the buffer pool.  In that case, the buffer will be returned
 795  * without being hashed into the hash table.
 796  */
 797 long buf_GetNewLocked(struct cm_scache *scp, osi_hyper_t *offsetp, cm_buf_t **bufpp)
 798 {
 799     cm_buf_t *bp;       /* buffer we're dealing with */
 800     cm_buf_t *nextBp;   /* next buffer in file hash chain */
 801     afs_uint32 i;       /* temp */
 802     cm_req_t req;
 803
 804     cm_InitReq(&req);   /* just in case */
 805
 806 #ifdef TESTING
 807     buf_ValidateBufQueues();
 808 #endif /* TESTING */
 809
 810     while(1) {
 811       retry:
 812         lock_ObtainRead(&scp->bufCreateLock);
 813         lock_ObtainWrite(&buf_globalLock);
 814         /* check to see if we lost the race */
 815         if (scp) {
 816             if (bp = buf_FindLocked(scp, offsetp)) {
 817                 /* Do not call buf_ReleaseLocked() because we
 818                  * do not want to allow the buffer to be added
 819                  * to the free list.
 820                  */
 821                 afs_int32 refCount = InterlockedDecrement(&bp->refCount);
 822 #ifdef DEBUG_REFCOUNT
 823                 osi_Log2(afsd_logp,"buf_GetNewLocked bp 0x%p ref %d", bp, refCount);
 824                 afsi_log("%s:%d buf_GetNewLocked bp 0x%p, ref %d", __FILE__, __LINE__, bp, refCount);
 825 #endif
 826                 lock_ReleaseWrite(&buf_globalLock);
 827                 lock_ReleaseRead(&scp->bufCreateLock);
 828                 return CM_BUF_EXISTS;
 829             }
 830         }
 831
 832         /* does this fix the problem below?  it's a simple solution. */
 833         if (!cm_data.buf_freeListEndp)
 834         {
 835             lock_ReleaseWrite(&buf_globalLock);
 836             lock_ReleaseRead(&scp->bufCreateLock);
 837             osi_Log0(afsd_logp, "buf_GetNewLocked: Free Buffer List is empty - sleeping 200ms");
 838             Sleep(200);
 839             goto retry;
 840         }
 841
 842         /* for debugging, assert free list isn't empty, although we
 843          * really should try waiting for a running tranasction to finish
 844          * instead of this; or better, we should have a transaction
 845          * throttler prevent us from entering this situation.
 846          */
 847         osi_assertx(cm_data.buf_freeListEndp != NULL, "buf_GetNewLocked: no free buffers");
 848
 849         /* look at all buffers in free list, some of which may temp.
 850          * have high refcounts and which then should be skipped,
 851          * starting cleaning I/O for those which are dirty.  If we find
 852          * a clean buffer, we rehash it, lock it and return it.
 853          */
 854         for(bp = cm_data.buf_freeListEndp; bp; bp=(cm_buf_t *) osi_QPrev(&bp->q)) {
 855             /* check to see if it really has zero ref count.  This
 856              * code can bump refcounts, at least, so it may not be
 857              * zero.
 858              */
 859             if (bp->refCount > 0)
 860                 continue;
 861
 862             /* we don't have to lock buffer itself, since the ref
 863              * count is 0 and we know it will stay zero as long as
 864              * we hold the global lock.
 865              */
 866
 867             /* Don't recycle a buffer held by the redirector. */
 868             if (bp->flags & CM_BUF_REDIR)
 869                 continue;
 870
 871             /* don't recycle someone in our own chunk */
 872             if (!cm_FidCmp(&bp->fid, &scp->fid)
 873                  && (bp->offset.LowPart & (-cm_chunkSize))
 874                  == (offsetp->LowPart & (-cm_chunkSize)))
 875                 continue;
 876
 877             /* if this page is being filled (!) or cleaned, see if
 878              * the I/O has completed.  If not, skip it, otherwise
 879              * do the final processing for the I/O.
 880              */
 881             if (bp->flags & (CM_BUF_READING | CM_BUF_WRITING)) {
 882                 /* probably shouldn't do this much work while
 883                  * holding the big lock?  Watch for contention
 884                  * here.
 885                  */
 886                 continue;
 887             }
 888
 889             if (bp->flags & CM_BUF_DIRTY) {
 890                 /* if the buffer is dirty, start cleaning it and
 891                  * move on to the next buffer.  We do this with
 892                  * just the lock required to minimize contention
 893                  * on the big lock.
 894                  */
 895                 buf_HoldLocked(bp);
 896                 lock_ReleaseWrite(&buf_globalLock);
 897                 lock_ReleaseRead(&scp->bufCreateLock);
 898
 899                 /* grab required lock and clean; this only
 900                  * starts the I/O.  By the time we're back,
 901                  * it'll still be marked dirty, but it will also
 902                  * have the WRITING flag set, so we won't get
 903                  * back here.
 904                  */
 905                 buf_CleanAsync(bp, &req);
 906
 907                 /* now put it back and go around again */
 908                 buf_Release(bp);
 909                 goto retry;
 910             }
 911
 912             /* if we get here, we know that the buffer still has a 0
 913              * ref count, and that it is clean and has no currently
 914              * pending I/O.  This is the dude to return.
 915              * Remember that as long as the ref count is 0, we know
 916              * that we won't have any lock conflicts, so we can grab
 917              * the buffer lock out of order in the locking hierarchy.
 918              */
 919             buf_Recycle(bp);
 920
 921             /* clean up junk flags */
 922             bp->flags &= ~(CM_BUF_EOF | CM_BUF_ERROR);
 923             bp->dataVersion = CM_BUF_VERSION_BAD;       /* unknown so far */
 924
 925             /* now hash in as our new buffer, and give it the
 926              * appropriate label, if requested.
 927              */
 928             if (scp) {
 929                 bp->flags |= CM_BUF_INHASH;
 930                 bp->fid = scp->fid;
 931 #ifdef DEBUG
 932                 bp->scp = scp;
 933 #endif
 934                 bp->offset = *offsetp;
 935                 i = BUF_HASH(&scp->fid, offsetp);
 936                 bp->hashp = cm_data.buf_scacheHashTablepp[i];
 937                 cm_data.buf_scacheHashTablepp[i] = bp;
 938                 i = BUF_FILEHASH(&scp->fid);
 939                 nextBp = cm_data.buf_fileHashTablepp[i];
 940                 bp->fileHashp = nextBp;
 941                 bp->fileHashBackp = NULL;
 942                 if (nextBp)
 943                     nextBp->fileHashBackp = bp;
 944                 cm_data.buf_fileHashTablepp[i] = bp;
 945             }
 946
 947             /* we should move it from the lru queue.  It better still be there,
 948              * since we've held the global (big) lock since we found it there.
 949              */
 950             osi_assertx(bp->flags & CM_BUF_INLRU,
 951                          "buf_GetNewLocked: LRU screwup");
 952
 953             if (cm_data.buf_freeListEndp == bp) {
 954                 /* we're the last guy in this queue, so maintain it */
 955                 cm_data.buf_freeListEndp = (cm_buf_t *) osi_QPrev(&bp->q);
 956             }
 957             osi_QRemove((osi_queue_t **) &cm_data.buf_freeListp, &bp->q);
 958             bp->flags &= ~CM_BUF_INLRU;
 959
 960             /* grab the mutex so that people don't use it
 961              * before the caller fills it with data.  Again, no one
 962              * should have been able to get to this dude to lock it.
 963              */
 964             if (!lock_TryMutex(&bp->mx)) {
 965                 osi_Log2(afsd_logp, "buf_GetNewLocked bp 0x%p cannot be mutex locked.  refCount %d should be 0",
 966                          bp, bp->refCount);
 967                 osi_panic("buf_GetNewLocked: TryMutex failed",__FILE__,__LINE__);
 968             }
 969
 970             /* prepare to return it.  Give it a refcount */
 971             bp->refCount = 1;
 972 #ifdef DEBUG_REFCOUNT
 973             osi_Log2(afsd_logp,"buf_GetNewLocked bp 0x%p ref %d", bp, 1);
 974             afsi_log("%s:%d buf_GetNewLocked bp 0x%p, ref %d", __FILE__, __LINE__, bp, 1);
 975 #endif
 976             lock_ReleaseWrite(&buf_globalLock);
 977             lock_ReleaseRead(&scp->bufCreateLock);
 978             *bufpp = bp;
 979
 980 #ifdef TESTING
 981             buf_ValidateBufQueues();
 982 #endif /* TESTING */
 983             return 0;
 984         } /* for all buffers in lru queue */
 985         lock_ReleaseWrite(&buf_globalLock);
 986         lock_ReleaseRead(&scp->bufCreateLock);
 987         osi_Log0(afsd_logp, "buf_GetNewLocked: Free Buffer List has no buffers with a zero refcount - sleeping 100ms");
 988         Sleep(100);             /* give some time for a buffer to be freed */
 989     }   /* while loop over everything */
 990     /* not reached */
 991 } /* the proc */
 992
 993 /* get a page, returning it held but unlocked.  Doesn't fill in the page
 994  * with I/O, since we're going to write the whole thing new.
 995  */
 996 long buf_GetNew(struct cm_scache *scp, osi_hyper_t *offsetp, cm_buf_t **bufpp)
 997 {
 998     cm_buf_t *bp;
 999     long code;
1000     osi_hyper_t pageOffset;
1001     int created;
1002
1003     created = 0;
1004     pageOffset.HighPart = offsetp->HighPart;
1005     pageOffset.LowPart = offsetp->LowPart & ~(cm_data.buf_blockSize-1);
1006     while (1) {
1007         bp = buf_Find(scp, &pageOffset);
1008         if (bp) {
1009             /* lock it and break out */
1010             lock_ObtainMutex(&bp->mx);
1011             break;
1012         }
1013
1014         /* otherwise, we have to create a page */
1015         code = buf_GetNewLocked(scp, &pageOffset, &bp);
1016
1017         /* check if the buffer was created in a race condition branch.
1018          * If so, go around so we can hold a reference to it.
1019          */
1020         if (code == CM_BUF_EXISTS)
1021             continue;
1022
1023         /* something else went wrong */
1024         if (code != 0)
1025             return code;
1026
1027         /* otherwise, we have a locked buffer that we just created */
1028         created = 1;
1029         break;
1030     } /* big while loop */
1031
1032     /* wait for reads */
1033     if (bp->flags & CM_BUF_READING)
1034         buf_WaitIO(scp, bp);
1035
1036     /* once it has been read once, we can unlock it and return it, still
1037      * with its refcount held.
1038      */
1039     lock_ReleaseMutex(&bp->mx);
1040     *bufpp = bp;
1041     osi_Log4(buf_logp, "buf_GetNew returning bp 0x%p for scp 0x%p, offset 0x%x:%08x",
1042               bp, scp, offsetp->HighPart, offsetp->LowPart);
1043     return 0;
1044 }
1045
1046 /* get a page, returning it held but unlocked.  Make sure it is complete */
1047 /* The scp must be unlocked when passed to this function */
1048 long buf_Get(struct cm_scache *scp, osi_hyper_t *offsetp, cm_buf_t **bufpp)
1049 {
1050     cm_buf_t *bp;
1051     long code;
1052     osi_hyper_t pageOffset;
1053     unsigned long tcount;
1054     int created;
1055     long lcount = 0;
1056 #ifdef DISKCACHE95
1057     cm_diskcache_t *dcp;
1058 #endif /* DISKCACHE95 */
1059
1060     created = 0;
1061     pageOffset.HighPart = offsetp->HighPart;
1062     pageOffset.LowPart = offsetp->LowPart & ~(cm_data.buf_blockSize-1);
1063     while (1) {
1064         lcount++;
1065 #ifdef TESTING
1066         buf_ValidateBufQueues();
1067 #endif /* TESTING */
1068
1069         bp = buf_Find(scp, &pageOffset);
1070         if (bp) {
1071             /* lock it and break out */
1072             lock_ObtainMutex(&bp->mx);
1073
1074 #ifdef DISKCACHE95
1075             /* touch disk chunk to update LRU info */
1076             diskcache_Touch(bp->dcp);
1077 #endif /* DISKCACHE95 */
1078             break;
1079         }
1080
1081         /* otherwise, we have to create a page */
1082         code = buf_GetNewLocked(scp, &pageOffset, &bp);
1083         /* bp->mx is now held */
1084
1085         /* check if the buffer was created in a race condition branch.
1086          * If so, go around so we can hold a reference to it.
1087          */
1088         if (code == CM_BUF_EXISTS)
1089             continue;
1090
1091         /* something else went wrong */
1092         if (code != 0) {
1093 #ifdef TESTING
1094             buf_ValidateBufQueues();
1095 #endif /* TESTING */
1096             return code;
1097         }
1098
1099         /* otherwise, we have a locked buffer that we just created */
1100         created = 1;
1101         break;
1102     } /* big while loop */
1103
1104     /* if we get here, we have a locked buffer that may have just been
1105      * created, in which case it needs to be filled with data.
1106      */
1107     if (created) {
1108         /* load the page; freshly created pages should be idle */
1109         osi_assertx(!(bp->flags & (CM_BUF_READING | CM_BUF_WRITING)), "incorrect cm_buf_t flags");
1110
1111         /* start the I/O; may drop lock */
1112         bp->flags |= CM_BUF_READING;
1113         code = (*cm_buf_opsp->Readp)(bp, cm_data.buf_blockSize, &tcount, NULL);
1114
1115 #ifdef DISKCACHE95
1116         code = diskcache_Get(&bp->fid, &bp->offset, bp->datap, cm_data.buf_blockSize, &bp->dataVersion, &tcount, &dcp);
1117         bp->dcp = dcp;    /* pointer to disk cache struct. */
1118 #endif /* DISKCACHE95 */
1119
1120         if (code != 0) {
1121             /* failure or queued */
1122             if (code != ERROR_IO_PENDING) {
1123                 bp->error = code;
1124                 bp->flags |= CM_BUF_ERROR;
1125                 bp->flags &= ~CM_BUF_READING;
1126                 if (bp->flags & CM_BUF_WAITING) {
1127                     osi_Log1(buf_logp, "buf_Get Waking bp 0x%p", bp);
1128                     osi_Wakeup((LONG_PTR) bp);
1129                 }
1130                 lock_ReleaseMutex(&bp->mx);
1131                 buf_Release(bp);
1132 #ifdef TESTING
1133                 buf_ValidateBufQueues();
1134 #endif /* TESTING */
1135                 return code;
1136             }
1137         } else {
1138             /* otherwise, I/O completed instantly and we're done, except
1139              * for padding the xfr out with 0s and checking for EOF
1140              */
1141             if (tcount < (unsigned long) cm_data.buf_blockSize) {
1142                 memset(bp->datap+tcount, 0, cm_data.buf_blockSize - tcount);
1143                 if (tcount == 0)
1144                     bp->flags |= CM_BUF_EOF;
1145             }
1146             bp->flags &= ~CM_BUF_READING;
1147             if (bp->flags & CM_BUF_WAITING) {
1148                 osi_Log1(buf_logp, "buf_Get Waking bp 0x%p", bp);
1149                 osi_Wakeup((LONG_PTR) bp);
1150             }
1151         }
1152
1153     } /* if created */
1154
1155     /* wait for reads, either that which we started above, or that someone
1156      * else started.  We don't care if we return a buffer being cleaned.
1157      */
1158     if (bp->flags & CM_BUF_READING)
1159         buf_WaitIO(scp, bp);
1160
1161     /* once it has been read once, we can unlock it and return it, still
1162      * with its refcount held.
1163      */
1164     lock_ReleaseMutex(&bp->mx);
1165     *bufpp = bp;
1166
1167     /* now remove from queue; will be put in at the head (farthest from
1168      * being recycled) when we're done in buf_Release.
1169      */
1170     lock_ObtainWrite(&buf_globalLock);
1171     if (bp->flags & CM_BUF_INLRU) {
1172         if (cm_data.buf_freeListEndp == bp)
1173             cm_data.buf_freeListEndp = (cm_buf_t *) osi_QPrev(&bp->q);
1174         osi_QRemove((osi_queue_t **) &cm_data.buf_freeListp, &bp->q);
1175         bp->flags &= ~CM_BUF_INLRU;
1176     }
1177     lock_ReleaseWrite(&buf_globalLock);
1178
1179     osi_Log4(buf_logp, "buf_Get returning bp 0x%p for scp 0x%p, offset 0x%x:%08x",
1180               bp, scp, offsetp->HighPart, offsetp->LowPart);
1181 #ifdef TESTING
1182     buf_ValidateBufQueues();
1183 #endif /* TESTING */
1184     return 0;
1185 }
1186
1187 /* count # of elements in the free list;
1188  * we don't bother doing the proper locking for accessing dataVersion or flags
1189  * since it is a pain, and this is really just an advisory call.  If you need
1190  * to do better at some point, rewrite this function.
1191  */
1192 long buf_CountFreeList(void)
1193 {
1194     long count;
1195     cm_buf_t *bufp;
1196
1197     count = 0;
1198     lock_ObtainRead(&buf_globalLock);
1199     for(bufp = cm_data.buf_freeListp; bufp; bufp = (cm_buf_t *) osi_QNext(&bufp->q)) {
1200         /* if the buffer doesn't have an identity, or if the buffer
1201          * has been invalidate (by having its DV stomped upon), then
1202          * count it as free, since it isn't really being utilized.
1203          */
1204         if (!(bufp->flags & CM_BUF_INHASH) || bufp->dataVersion == CM_BUF_VERSION_BAD)
1205             count++;
1206     }
1207     lock_ReleaseRead(&buf_globalLock);
1208     return count;
1209 }
1210
1211 /* clean a buffer synchronously */
1212 long buf_CleanAsync(cm_buf_t *bp, cm_req_t *reqp)
1213 {
1214     long code;
1215     osi_assertx(bp->magic == CM_BUF_MAGIC, "invalid cm_buf_t magic");
1216
1217     lock_ObtainMutex(&bp->mx);
1218     code = buf_CleanAsyncLocked(bp, reqp);
1219     lock_ReleaseMutex(&bp->mx);
1220
1221     return code;
1222 }
1223
1224 /* wait for a buffer's cleaning to finish */
1225 void buf_CleanWait(cm_scache_t * scp, cm_buf_t *bp, afs_uint32 locked)
1226 {
1227     osi_assertx(bp->magic == CM_BUF_MAGIC, "invalid cm_buf_t magic");
1228
1229     if (!locked)
1230         lock_ObtainMutex(&bp->mx);
1231     if (bp->flags & CM_BUF_WRITING) {
1232         buf_WaitIO(scp, bp);
1233     }
1234     if (!locked)
1235         lock_ReleaseMutex(&bp->mx);
1236 }
1237
1238 /* set the dirty flag on a buffer, and set associated write-ahead log,
1239  * if there is one.  Allow one to be added to a buffer, but not changed.
1240  *
1241  * The buffer must be locked before calling this routine.
1242  */
1243 void buf_SetDirty(cm_buf_t *bp, afs_uint32 offset, afs_uint32 length)
1244 {
1245     osi_assertx(bp->magic == CM_BUF_MAGIC, "invalid cm_buf_t magic");
1246     osi_assertx(bp->refCount > 0, "cm_buf_t refcount 0");
1247
1248     if (bp->flags & CM_BUF_DIRTY) {
1249
1250         osi_Log1(buf_logp, "buf_SetDirty 0x%p already dirty", bp);
1251
1252         if (bp->dirty_offset <= offset) {
1253             if (bp->dirty_offset + bp->dirty_length >= offset + length) {
1254                 /* dirty_length remains the same */
1255             } else {
1256                 bp->dirty_length = offset + length - bp->dirty_offset;
1257             }
1258         } else /* bp->dirty_offset > offset */ {
1259             if (bp->dirty_offset + bp->dirty_length >= offset + length) {
1260                 bp->dirty_length = bp->dirty_offset + bp->dirty_length - offset;
1261             } else {
1262                 bp->dirty_length = length;
1263             }
1264             bp->dirty_offset = offset;
1265         }
1266     } else {
1267         osi_Log1(buf_logp, "buf_SetDirty 0x%p", bp);
1268
1269         /* set dirty bit */
1270         bp->flags |= CM_BUF_DIRTY;
1271
1272         /* and turn off EOF flag, since it has associated data now */
1273         bp->flags &= ~CM_BUF_EOF;
1274
1275         bp->dirty_offset = offset;
1276         bp->dirty_length = length;
1277
1278         /* and add to the dirty list.
1279          * we obtain a hold on the buffer for as long as it remains
1280          * in the list.  buffers are only removed from the list by
1281          * the buf_IncrSyncer function regardless of when else the
1282          * dirty flag might be cleared.
1283          *
1284          * This should never happen but just in case there is a bug
1285          * elsewhere, never add to the dirty list if the buffer is
1286          * already there.
1287          */
1288         lock_ObtainWrite(&buf_globalLock);
1289         if (!(bp->flags & CM_BUF_INDL)) {
1290             buf_HoldLocked(bp);
1291             if (!cm_data.buf_dirtyListp) {
1292                 cm_data.buf_dirtyListp = cm_data.buf_dirtyListEndp = bp;
1293             } else {
1294                 cm_data.buf_dirtyListEndp->dirtyp = bp;
1295                 cm_data.buf_dirtyListEndp = bp;
1296             }
1297             bp->dirtyp = NULL;
1298             bp->flags |= CM_BUF_INDL;
1299         }
1300         lock_ReleaseWrite(&buf_globalLock);
1301     }
1302 }
1303
1304 /* clean all buffers, reset log pointers and invalidate all buffers.
1305  * Called with no locks held, and returns with same.
1306  *
1307  * This function is guaranteed to clean and remove the log ptr of all the
1308  * buffers that were dirty or had non-zero log ptrs before the call was
1309  * made.  That's sufficient to clean up any garbage left around by recovery,
1310  * which is all we're counting on this for; there may be newly created buffers
1311  * added while we're running, but that should be OK.
1312  *
1313  * In an environment where there are no transactions (artificially imposed, for
1314  * example, when switching the database to raw mode), this function is used to
1315  * make sure that all updates have been written to the disk.  In that case, we don't
1316  * really require that we forget the log association between pages and logs, but
1317  * it also doesn't hurt.  Since raw mode I/O goes through this buffer package, we don't
1318  * have to worry about invalidating data in the buffers.
1319  *
1320  * This function is used at the end of recovery as paranoia to get the recovered
1321  * database out to disk.  It removes all references to the recovery log and cleans
1322  * all buffers.
1323  */
1324 long buf_CleanAndReset(void)
1325 {
1326     afs_uint32 i;
1327     cm_buf_t *bp;
1328     cm_req_t req;
1329
1330     lock_ObtainRead(&buf_globalLock);
1331     for(i=0; i<cm_data.buf_hashSize; i++) {
1332         for(bp = cm_data.buf_scacheHashTablepp[i]; bp; bp = bp->hashp) {
1333             if ((bp->flags & CM_BUF_DIRTY) == CM_BUF_DIRTY) {
1334                 buf_HoldLocked(bp);
1335                 lock_ReleaseRead(&buf_globalLock);
1336
1337                 /* now no locks are held; clean buffer and go on */
1338                 cm_InitReq(&req);
1339                 req.flags |= CM_REQ_NORETRY;
1340
1341                 buf_CleanAsync(bp, &req);
1342                 buf_CleanWait(NULL, bp, FALSE);
1343
1344                 /* relock and release buffer */
1345                 lock_ObtainRead(&buf_globalLock);
1346                 buf_ReleaseLocked(bp, FALSE);
1347             } /* dirty */
1348         } /* over one bucket */
1349     }   /* for loop over all hash buckets */
1350
1351     /* release locks */
1352     lock_ReleaseRead(&buf_globalLock);
1353
1354 #ifdef TESTING
1355     buf_ValidateBufQueues();
1356 #endif /* TESTING */
1357
1358     /* and we're done */
1359     return 0;
1360 }
1361
1362 /* called without global lock being held, reserves buffers for callers
1363  * that need more than one held (not locked) at once.
1364  */
1365 void buf_ReserveBuffers(afs_uint64 nbuffers)
1366 {
1367     lock_ObtainWrite(&buf_globalLock);
1368     while (1) {
1369         if (cm_data.buf_reservedBufs + nbuffers > cm_data.buf_maxReservedBufs) {
1370             cm_data.buf_reserveWaiting = 1;
1371             osi_Log1(buf_logp, "buf_ReserveBuffers waiting for %d bufs", nbuffers);
1372             osi_SleepW((LONG_PTR) &cm_data.buf_reservedBufs, &buf_globalLock);
1373             lock_ObtainWrite(&buf_globalLock);
1374         }
1375         else {
1376             cm_data.buf_reservedBufs += nbuffers;
1377             break;
1378         }
1379     }
1380     lock_ReleaseWrite(&buf_globalLock);
1381 }
1382
1383 int buf_TryReserveBuffers(afs_uint64 nbuffers)
1384 {
1385     int code;
1386
1387     lock_ObtainWrite(&buf_globalLock);
1388     if (cm_data.buf_reservedBufs + nbuffers > cm_data.buf_maxReservedBufs) {
1389         code = 0;
1390     }
1391     else {
1392         cm_data.buf_reservedBufs += nbuffers;
1393         code = 1;
1394     }
1395     lock_ReleaseWrite(&buf_globalLock);
1396     return code;
1397 }
1398
1399 /* called without global lock held, releases reservation held by
1400  * buf_ReserveBuffers.
1401  */
1402 void buf_UnreserveBuffers(afs_uint64 nbuffers)
1403 {
1404     lock_ObtainWrite(&buf_globalLock);
1405     cm_data.buf_reservedBufs -= nbuffers;
1406     if (cm_data.buf_reserveWaiting) {
1407         cm_data.buf_reserveWaiting = 0;
1408         osi_Wakeup((LONG_PTR) &cm_data.buf_reservedBufs);
1409     }
1410     lock_ReleaseWrite(&buf_globalLock);
1411 }
1412
1413 /* truncate the buffers past sizep, zeroing out the page, if we don't
1414  * end on a page boundary.
1415  *
1416  * Requires cm_bufCreateLock to be write locked.
1417  */
1418 long buf_Truncate(cm_scache_t *scp, cm_user_t *userp, cm_req_t *reqp,
1419                    osi_hyper_t *sizep)
1420 {
1421     cm_buf_t *bufp;
1422     cm_buf_t *nbufp;                    /* next buffer, if didRelease */
1423     osi_hyper_t bufEnd;
1424     long code;
1425     long bufferPos;
1426     afs_uint32 i;
1427
1428     /* assert that cm_bufCreateLock is held in write mode */
1429     lock_AssertWrite(&scp->bufCreateLock);
1430
1431     i = BUF_FILEHASH(&scp->fid);
1432
1433     lock_ObtainRead(&buf_globalLock);
1434     bufp = cm_data.buf_fileHashTablepp[i];
1435     if (bufp == NULL) {
1436         lock_ReleaseRead(&buf_globalLock);
1437         return 0;
1438     }
1439
1440     buf_HoldLocked(bufp);
1441     lock_ReleaseRead(&buf_globalLock);
1442     while (bufp) {
1443         lock_ObtainMutex(&bufp->mx);
1444
1445         bufEnd.HighPart = 0;
1446         bufEnd.LowPart = cm_data.buf_blockSize;
1447         bufEnd = LargeIntegerAdd(bufEnd, bufp->offset);
1448
1449         if (cm_FidCmp(&bufp->fid, &scp->fid) == 0 &&
1450              LargeIntegerLessThan(*sizep, bufEnd)) {
1451             buf_WaitIO(scp, bufp);
1452         }
1453         lock_ObtainWrite(&scp->rw);
1454
1455         /* make sure we have a callback (so we have the right value for
1456          * the length), and wait for it to be safe to do a truncate.
1457          */
1458         code = cm_SyncOp(scp, bufp, userp, reqp, 0,
1459                           CM_SCACHESYNC_NEEDCALLBACK
1460                           | CM_SCACHESYNC_GETSTATUS
1461                           | CM_SCACHESYNC_SETSIZE
1462                           | CM_SCACHESYNC_BUFLOCKED);
1463
1464
1465         /* if we succeeded in our locking, and this applies to the right
1466          * file, and the truncate request overlaps the buffer either
1467          * totally or partially, then do something.
1468          */
1469         if (code == 0 && cm_FidCmp(&bufp->fid, &scp->fid) == 0
1470              && LargeIntegerLessThan(*sizep, bufEnd)) {
1471
1472
1473             /* destroy the buffer, turning off its dirty bit, if
1474              * we're truncating the whole buffer.  Otherwise, set
1475              * the dirty bit, and clear out the tail of the buffer
1476              * if we just overlap some.
1477              */
1478             if (LargeIntegerLessThanOrEqualTo(*sizep, bufp->offset)) {
1479                 /* truncating the entire page */
1480                 bufp->flags &= ~CM_BUF_DIRTY;
1481                 bufp->dirty_offset = 0;
1482                 bufp->dirty_length = 0;
1483                 bufp->dataVersion = CM_BUF_VERSION_BAD; /* known bad */
1484                 bufp->dirtyCounter++;
1485             }
1486             else {
1487                 /* don't set dirty, since dirty implies
1488                  * currently up-to-date.  Don't need to do this,
1489                  * since we'll update the length anyway.
1490                  *
1491                  * Zero out remainder of the page, in case we
1492                  * seek and write past EOF, and make this data
1493                  * visible again.
1494                  */
1495                 bufferPos = sizep->LowPart & (cm_data.buf_blockSize - 1);
1496                 osi_assertx(bufferPos != 0, "non-zero bufferPos");
1497                 memset(bufp->datap + bufferPos, 0,
1498                         cm_data.buf_blockSize - bufferPos);
1499             }
1500         }
1501
1502         cm_SyncOpDone( scp, bufp,
1503                        CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS
1504                        | CM_SCACHESYNC_SETSIZE | CM_SCACHESYNC_BUFLOCKED);
1505
1506         lock_ReleaseWrite(&scp->rw);
1507         lock_ReleaseMutex(&bufp->mx);
1508
1509         if (!code) {
1510             nbufp = bufp->fileHashp;
1511             if (nbufp)
1512                 buf_Hold(nbufp);
1513         } else {
1514             /* This forces the loop to end and the error code
1515              * to be returned. */
1516             nbufp = NULL;
1517         }
1518         buf_Release(bufp);
1519         bufp = nbufp;
1520     }
1521
1522 #ifdef TESTING
1523     buf_ValidateBufQueues();
1524 #endif /* TESTING */
1525
1526     /* done */
1527     return code;
1528 }
1529
1530 long buf_FlushCleanPages(cm_scache_t *scp, cm_user_t *userp, cm_req_t *reqp)
1531 {
1532     long code;
1533     cm_buf_t *bp;               /* buffer we're hacking on */
1534     cm_buf_t *nbp;
1535     int didRelease;
1536     afs_uint32 i;
1537
1538     i = BUF_FILEHASH(&scp->fid);
1539
1540     code = 0;
1541     lock_ObtainRead(&buf_globalLock);
1542     bp = cm_data.buf_fileHashTablepp[i];
1543     if (bp)
1544         buf_HoldLocked(bp);
1545     lock_ReleaseRead(&buf_globalLock);
1546
1547     for (; bp; bp = nbp) {
1548         didRelease = 0; /* haven't released this buffer yet */
1549
1550         /* clean buffer synchronously */
1551         if (cm_FidCmp(&bp->fid, &scp->fid) == 0) {
1552             lock_ObtainMutex(&bp->mx);
1553
1554             /* start cleaning the buffer, and wait for it to finish */
1555             buf_CleanAsyncLocked(bp, reqp);
1556             buf_WaitIO(scp, bp);
1557             lock_ReleaseMutex(&bp->mx);
1558
1559             /*
1560              * if the error for the previous buffer was BADFD
1561              * then all buffers for the FID are bad.  Do not
1562              * attempt to stabalize.
1563              */
1564             if (code != CM_ERROR_BADFD) {
1565                 code = (*cm_buf_opsp->Stabilizep)(scp, userp, reqp);
1566                 if (code && code != CM_ERROR_BADFD)
1567                     goto skip;
1568             }
1569             if (code == CM_ERROR_BADFD) {
1570                 /* if the scp's FID is bad its because we received VNOVNODE
1571                  * when attempting to FetchStatus before the write.  This
1572                  * page therefore contains data that can no longer be stored.
1573                  */
1574                 lock_ObtainMutex(&bp->mx);
1575                 bp->flags &= ~CM_BUF_DIRTY;
1576                 bp->flags |= CM_BUF_ERROR;
1577                 bp->error = CM_ERROR_BADFD;
1578                 bp->dirty_offset = 0;
1579                 bp->dirty_length = 0;
1580                 bp->dataVersion = CM_BUF_VERSION_BAD;   /* known bad */
1581                 bp->dirtyCounter++;
1582                 lock_ReleaseMutex(&bp->mx);
1583             }
1584
1585             /* actually, we only know that buffer is clean if ref
1586              * count is 1, since we don't have buffer itself locked.
1587              */
1588             if (!(bp->flags & CM_BUF_DIRTY)) {
1589                 lock_ObtainWrite(&buf_globalLock);
1590                 if (bp->refCount == 1) {        /* bp is held above */
1591                     nbp = bp->fileHashp;
1592                     if (nbp)
1593                         buf_HoldLocked(nbp);
1594                     buf_ReleaseLocked(bp, TRUE);
1595                     didRelease = 1;
1596                     buf_Recycle(bp);
1597                 }
1598                 lock_ReleaseWrite(&buf_globalLock);
1599             }
1600
1601             if (code == 0)
1602                 (*cm_buf_opsp->Unstabilizep)(scp, userp);
1603         }
1604
1605       skip:
1606         if (!didRelease) {
1607             lock_ObtainRead(&buf_globalLock);
1608             nbp = bp->fileHashp;
1609             if (nbp)
1610                 buf_HoldLocked(nbp);
1611             buf_ReleaseLocked(bp, FALSE);
1612             lock_ReleaseRead(&buf_globalLock);
1613         }
1614     }   /* for loop over a bunch of buffers */
1615
1616 #ifdef TESTING
1617     buf_ValidateBufQueues();
1618 #endif /* TESTING */
1619
1620     /* done */
1621     return code;
1622 }
1623
1624 /* Must be called with scp->rw held */
1625 long buf_ForceDataVersion(cm_scache_t * scp, afs_uint64 fromVersion, afs_uint64 toVersion)
1626 {
1627     cm_buf_t * bp;
1628     afs_uint32 i;
1629     int found = 0;
1630
1631     lock_AssertAny(&scp->rw);
1632
1633     i = BUF_FILEHASH(&scp->fid);
1634
1635     lock_ObtainRead(&buf_globalLock);
1636
1637     for (bp = cm_data.buf_fileHashTablepp[i]; bp; bp = bp->fileHashp) {
1638         if (cm_FidCmp(&bp->fid, &scp->fid) == 0) {
1639             if (bp->dataVersion == fromVersion) {
1640                 bp->dataVersion = toVersion;
1641                 found = 1;
1642             }
1643         }
1644     }
1645     lock_ReleaseRead(&buf_globalLock);
1646
1647     if (found)
1648         return 0;
1649     else
1650         return ENOENT;
1651 }
1652
1653 long buf_CleanVnode(struct cm_scache *scp, cm_user_t *userp, cm_req_t *reqp)
1654 {
1655     long code = 0;
1656     long wasDirty = 0;
1657     cm_buf_t *bp;               /* buffer we're hacking on */
1658     cm_buf_t *nbp;              /* next one */
1659     afs_uint32 i;
1660
1661     i = BUF_FILEHASH(&scp->fid);
1662
1663     lock_ObtainRead(&buf_globalLock);
1664     bp = cm_data.buf_fileHashTablepp[i];
1665     if (bp)
1666         buf_HoldLocked(bp);
1667     lock_ReleaseRead(&buf_globalLock);
1668     for (; bp; bp = nbp) {
1669         /* clean buffer synchronously */
1670         if (cm_FidCmp(&bp->fid, &scp->fid) == 0) {
1671             lock_ObtainMutex(&bp->mx);
1672             if (bp->flags & CM_BUF_DIRTY) {
1673                 if (userp) {
1674                     cm_HoldUser(userp);
1675                     if (bp->userp)
1676                         cm_ReleaseUser(bp->userp);
1677                     bp->userp = userp;
1678                 }
1679                 wasDirty = buf_CleanAsyncLocked(bp, reqp);
1680                 buf_CleanWait(scp, bp, TRUE);
1681                 if (bp->flags & CM_BUF_ERROR) {
1682                     code = bp->error;
1683                     if (code == 0)
1684                         code = -1;
1685                 }
1686             }
1687             lock_ReleaseMutex(&bp->mx);
1688         }
1689
1690         lock_ObtainRead(&buf_globalLock);
1691         nbp = bp->fileHashp;
1692         if (nbp)
1693             buf_HoldLocked(nbp);
1694         buf_ReleaseLocked(bp, FALSE);
1695         lock_ReleaseRead(&buf_globalLock);
1696     }   /* for loop over a bunch of buffers */
1697
1698 #ifdef TESTING
1699     buf_ValidateBufQueues();
1700 #endif /* TESTING */
1701
1702     /* done */
1703     return code;
1704 }
1705
1706 #ifdef TESTING
1707 void
1708 buf_ValidateBufQueues(void)
1709 {
1710     cm_buf_t * bp, *bpb, *bpf, *bpa;
1711     afs_uint32 countf=0, countb=0, counta=0;
1712
1713     lock_ObtainRead(&buf_globalLock);
1714     for (bp = cm_data.buf_freeListEndp; bp; bp=(cm_buf_t *) osi_QPrev(&bp->q)) {
1715         if (bp->magic != CM_BUF_MAGIC)
1716             osi_panic("buf magic error",__FILE__,__LINE__);
1717         countb++;
1718         bpb = bp;
1719     }
1720
1721     for (bp = cm_data.buf_freeListp; bp; bp=(cm_buf_t *) osi_QNext(&bp->q)) {
1722         if (bp->magic != CM_BUF_MAGIC)
1723             osi_panic("buf magic error",__FILE__,__LINE__);
1724         countf++;
1725         bpf = bp;
1726     }
1727
1728     for (bp = cm_data.buf_allp; bp; bp=bp->allp) {
1729         if (bp->magic != CM_BUF_MAGIC)
1730             osi_panic("buf magic error",__FILE__,__LINE__);
1731         counta++;
1732         bpa = bp;
1733     }
1734     lock_ReleaseRead(&buf_globalLock);
1735
1736     if (countb != countf)
1737         osi_panic("buf magic error",__FILE__,__LINE__);
1738
1739     if (counta != cm_data.buf_nbuffers)
1740         osi_panic("buf magic error",__FILE__,__LINE__);
1741 }
1742 #endif /* TESTING */
1743
1744 /* dump the contents of the buf_scacheHashTablepp. */
1745 int cm_DumpBufHashTable(FILE *outputFile, char *cookie, int lock)
1746 {
1747     int zilch;
1748     cm_buf_t *bp;
1749     char output[1024];
1750     afs_uint32 i;
1751
1752     if (cm_data.buf_scacheHashTablepp == NULL)
1753         return -1;
1754
1755     if (lock)
1756         lock_ObtainRead(&buf_globalLock);
1757
1758     StringCbPrintfA(output, sizeof(output), "%s - dumping buf_HashTable - buf_hashSize=%d\r\n",
1759                     cookie, cm_data.buf_hashSize);
1760     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
1761
1762     for (i = 0; i < cm_data.buf_hashSize; i++)
1763     {
1764         for (bp = cm_data.buf_scacheHashTablepp[i]; bp; bp=bp->hashp)
1765         {
1766             StringCbPrintfA(output, sizeof(output),
1767                             "%s bp=0x%08X, hash=%d, fid (cell=%d, volume=%d, "
1768                             "vnode=%d, unique=%d), offset=%x:%08x, dv=%I64d, "
1769                             "flags=0x%x, cmFlags=0x%x, refCount=%d\r\n",
1770                              cookie, (void *)bp, i, bp->fid.cell, bp->fid.volume,
1771                              bp->fid.vnode, bp->fid.unique, bp->offset.HighPart,
1772                              bp->offset.LowPart, bp->dataVersion, bp->flags,
1773                              bp->cmFlags, bp->refCount);
1774             WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
1775         }
1776     }
1777
1778     StringCbPrintfA(output, sizeof(output), "%s - Done dumping buf_HashTable.\r\n", cookie);
1779     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
1780
1781     StringCbPrintfA(output, sizeof(output), "%s - dumping buf_freeListEndp\r\n", cookie);
1782     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
1783     for(bp = cm_data.buf_freeListEndp; bp; bp=(cm_buf_t *) osi_QPrev(&bp->q)) {
1784         StringCbPrintfA(output, sizeof(output),
1785                          "%s bp=0x%08X, fid (cell=%d, volume=%d, "
1786                          "vnode=%d, unique=%d), offset=%x:%08x, dv=%I64d, "
1787                          "flags=0x%x, cmFlags=0x%x, refCount=%d\r\n",
1788                          cookie, (void *)bp, bp->fid.cell, bp->fid.volume,
1789                          bp->fid.vnode, bp->fid.unique, bp->offset.HighPart,
1790                          bp->offset.LowPart, bp->dataVersion, bp->flags,
1791                          bp->cmFlags, bp->refCount);
1792         WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
1793     }
1794     StringCbPrintfA(output, sizeof(output), "%s - Done dumping buf_FreeListEndp.\r\n", cookie);
1795     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
1796
1797     StringCbPrintfA(output, sizeof(output), "%s - dumping buf_dirtyListp\r\n", cookie);
1798     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
1799     for(bp = cm_data.buf_dirtyListp; bp; bp=bp->dirtyp) {
1800         StringCbPrintfA(output, sizeof(output),
1801                          "%s bp=0x%08X, fid (cell=%d, volume=%d, "
1802                          "vnode=%d, unique=%d), offset=%x:%08x, dv=%I64d, "
1803                          "flags=0x%x, cmFlags=0x%x, refCount=%d\r\n",
1804                          cookie, (void *)bp, bp->fid.cell, bp->fid.volume,
1805                          bp->fid.vnode, bp->fid.unique, bp->offset.HighPart,
1806                          bp->offset.LowPart, bp->dataVersion, bp->flags,
1807                          bp->cmFlags, bp->refCount);
1808         WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
1809     }
1810     StringCbPrintfA(output, sizeof(output), "%s - Done dumping buf_dirtyListp.\r\n", cookie);
1811     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
1812
1813     if (lock)
1814         lock_ReleaseRead(&buf_globalLock);
1815     return 0;
1816 }
1817
1818 void buf_ForceTrace(BOOL flush)
1819 {
1820     HANDLE handle;
1821     int len;
1822     char buf[256];
1823
1824     if (!buf_logp)
1825         return;
1826
1827     len = GetTempPath(sizeof(buf)-10, buf);
1828     StringCbCopyA(&buf[len], sizeof(buf)-len, "/afs-buffer.log");
1829     handle = CreateFile(buf, GENERIC_WRITE, FILE_SHARE_READ,
1830                             NULL, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
1831     if (handle == INVALID_HANDLE_VALUE) {
1832         osi_panic("Cannot create log file", __FILE__, __LINE__);
1833     }
1834     osi_LogPrint(buf_logp, handle);
1835     if (flush)
1836         FlushFileBuffers(handle);
1837     CloseHandle(handle);
1838 }
1839
1840 long buf_DirtyBuffersExist(cm_fid_t *fidp)
1841 {
1842     cm_buf_t *bp;
1843     afs_uint32 bcount = 0;
1844     afs_uint32 i;
1845
1846     i = BUF_FILEHASH(fidp);
1847
1848     for (bp = cm_data.buf_fileHashTablepp[i]; bp; bp=bp->allp, bcount++) {
1849         if (!cm_FidCmp(fidp, &bp->fid) && (bp->flags & CM_BUF_DIRTY))
1850             return 1;
1851     }
1852     return 0;
1853 }
1854
1855 #if 0
1856 long buf_CleanDirtyBuffers(cm_scache_t *scp)
1857 {
1858     cm_buf_t *bp;
1859     afs_uint32 bcount = 0;
1860     cm_fid_t * fidp = &scp->fid;
1861
1862     for (bp = cm_data.buf_allp; bp; bp=bp->allp, bcount++) {
1863         if (!cm_FidCmp(fidp, &bp->fid) && (bp->flags & CM_BUF_DIRTY)) {
1864             buf_Hold(bp);
1865             lock_ObtainMutex(&bp->mx);
1866             bp->cmFlags &= ~CM_BUF_CMSTORING;
1867             bp->flags &= ~CM_BUF_DIRTY;
1868             bp->dirty_offset = 0;
1869             bp->dirty_length = 0;
1870             bp->flags |= CM_BUF_ERROR;
1871             bp->error = VNOVNODE;
1872             bp->dataVersion = CM_BUF_VERSION_BAD; /* bad */
1873             bp->dirtyCounter++;
1874             if (bp->flags & CM_BUF_WAITING) {
1875                 osi_Log2(buf_logp, "BUF CleanDirtyBuffers Waking [scp 0x%x] bp 0x%x", scp, bp);
1876                 osi_Wakeup((long) &bp);
1877             }
1878             lock_ReleaseMutex(&bp->mx);
1879             buf_Release(bp);
1880         }
1881     }
1882     return 0;
1883 }
1884 #endif