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