918dd98a9ef3f24763fdb6be68de4b176fecbcfb
[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_req_t *reqp, 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
870 #ifdef TESTING
871     buf_ValidateBufQueues();
872 #endif /* TESTING */
873
874     while(1) {
875       retry:
876         lock_ObtainRead(&scp->bufCreateLock);
877         lock_ObtainWrite(&buf_globalLock);
878         /* check to see if we lost the race */
879         if (scp) {
880             if (bp = buf_FindLocked(scp, offsetp)) {
881                 /* Do not call buf_ReleaseLocked() because we 
882                  * do not want to allow the buffer to be added
883                  * to the free list.
884                  */
885                 afs_int32 refCount = InterlockedDecrement(&bp->refCount);
886 #ifdef DEBUG_REFCOUNT
887                 osi_Log2(afsd_logp,"buf_GetNewLocked bp 0x%p ref %d", bp, refCount);
888                 afsi_log("%s:%d buf_GetNewLocked bp 0x%p, ref %d", __FILE__, __LINE__, bp, refCount);
889 #endif
890                 lock_ReleaseWrite(&buf_globalLock);
891                 lock_ReleaseRead(&scp->bufCreateLock);
892                 return CM_BUF_EXISTS;
893             }
894         }
895
896         /* does this fix the problem below?  it's a simple solution. */
897         if (!cm_data.buf_freeListEndp)
898         {
899             lock_ReleaseWrite(&buf_globalLock);
900             lock_ReleaseRead(&scp->bufCreateLock);
901             osi_Log0(afsd_logp, "buf_GetNewLocked: Free Buffer List is empty - sleeping 200ms");
902             Sleep(200);
903             goto retry;
904         }
905
906         /* for debugging, assert free list isn't empty, although we
907          * really should try waiting for a running tranasction to finish
908          * instead of this; or better, we should have a transaction
909          * throttler prevent us from entering this situation.
910          */
911         osi_assertx(cm_data.buf_freeListEndp != NULL, "buf_GetNewLocked: no free buffers");
912
913         /* look at all buffers in free list, some of which may temp.
914          * have high refcounts and which then should be skipped,
915          * starting cleaning I/O for those which are dirty.  If we find
916          * a clean buffer, we rehash it, lock it and return it.
917          */
918         for(bp = cm_data.buf_freeListEndp; bp; bp=(cm_buf_t *) osi_QPrev(&bp->q)) {
919             /* check to see if it really has zero ref count.  This
920              * code can bump refcounts, at least, so it may not be
921              * zero.
922              */
923             if (bp->refCount > 0) 
924                 continue;
925                         
926             /* we don't have to lock buffer itself, since the ref
927              * count is 0 and we know it will stay zero as long as
928              * we hold the global lock.
929              */
930
931             /* Don't recycle a buffer held by the redirector. */
932             if (bp->flags & CM_BUF_REDIR)
933                 continue;
934
935             /* don't recycle someone in our own chunk */
936             if (!cm_FidCmp(&bp->fid, &scp->fid)
937                  && (bp->offset.LowPart & (-cm_chunkSize))
938                  == (offsetp->LowPart & (-cm_chunkSize)))
939                 continue;
940
941             /* if this page is being filled (!) or cleaned, see if
942              * the I/O has completed.  If not, skip it, otherwise
943              * do the final processing for the I/O.
944              */
945             if (bp->flags & (CM_BUF_READING | CM_BUF_WRITING)) {
946                 /* probably shouldn't do this much work while
947                  * holding the big lock?  Watch for contention
948                  * here.
949                  */
950                 continue;
951             }
952                         
953             if (bp->flags & CM_BUF_DIRTY) {
954                 /* if the buffer is dirty, start cleaning it and
955                  * move on to the next buffer.  We do this with
956                  * just the lock required to minimize contention
957                  * on the big lock.
958                  */
959                 buf_HoldLocked(bp);
960                 lock_ReleaseWrite(&buf_globalLock);
961                 lock_ReleaseRead(&scp->bufCreateLock);
962
963                 /* grab required lock and clean; this only
964                  * starts the I/O.  By the time we're back,
965                  * it'll still be marked dirty, but it will also
966                  * have the WRITING flag set, so we won't get
967                  * back here.
968                  */
969                 buf_CleanAsync(bp, reqp, NULL);
970
971                 /* now put it back and go around again */
972                 buf_Release(bp);
973                 goto retry;
974             }
975
976             /* if we get here, we know that the buffer still has a 0
977              * ref count, and that it is clean and has no currently
978              * pending I/O.  This is the dude to return.
979              * Remember that as long as the ref count is 0, we know
980              * that we won't have any lock conflicts, so we can grab
981              * the buffer lock out of order in the locking hierarchy.
982              */
983             buf_Recycle(bp);
984
985             /* clean up junk flags */
986             bp->flags &= ~(CM_BUF_EOF | CM_BUF_ERROR);
987             bp->dataVersion = CM_BUF_VERSION_BAD;       /* unknown so far */
988
989             /* now hash in as our new buffer, and give it the
990              * appropriate label, if requested.
991              */
992             if (scp) {
993                 bp->flags |= CM_BUF_INHASH;
994                 bp->fid = scp->fid;
995 #ifdef DEBUG
996                 bp->scp = scp;
997 #endif
998                 bp->offset = *offsetp;
999                 i = BUF_HASH(&scp->fid, offsetp);
1000                 bp->hashp = cm_data.buf_scacheHashTablepp[i];
1001                 cm_data.buf_scacheHashTablepp[i] = bp;
1002                 i = BUF_FILEHASH(&scp->fid);
1003                 nextBp = cm_data.buf_fileHashTablepp[i];
1004                 bp->fileHashp = nextBp;
1005                 bp->fileHashBackp = NULL;
1006                 if (nextBp)
1007                     nextBp->fileHashBackp = bp;
1008                 cm_data.buf_fileHashTablepp[i] = bp;
1009             }
1010
1011             /* we should move it from the lru queue.  It better still be there,
1012              * since we've held the global (big) lock since we found it there.
1013              */
1014             osi_assertx(bp->flags & CM_BUF_INLRU,
1015                          "buf_GetNewLocked: LRU screwup");
1016
1017             if (cm_data.buf_freeListEndp == bp) {
1018                 /* we're the last guy in this queue, so maintain it */
1019                 cm_data.buf_freeListEndp = (cm_buf_t *) osi_QPrev(&bp->q);
1020             }
1021             osi_QRemove((osi_queue_t **) &cm_data.buf_freeListp, &bp->q);
1022             bp->flags &= ~CM_BUF_INLRU;
1023
1024             /* prepare to return it.  Give it a refcount */
1025             bp->refCount = 1;
1026 #ifdef DEBUG_REFCOUNT
1027             osi_Log2(afsd_logp,"buf_GetNewLocked bp 0x%p ref %d", bp, 1);
1028             afsi_log("%s:%d buf_GetNewLocked bp 0x%p, ref %d", __FILE__, __LINE__, bp, 1);
1029 #endif
1030             /* grab the mutex so that people don't use it
1031              * before the caller fills it with data.  Again, no one     
1032              * should have been able to get to this dude to lock it.
1033              */
1034             if (!lock_TryMutex(&bp->mx)) {
1035                 osi_Log2(afsd_logp, "buf_GetNewLocked bp 0x%p cannot be mutex locked.  refCount %d should be 0",
1036                          bp, bp->refCount);
1037                 osi_panic("buf_GetNewLocked: TryMutex failed",__FILE__,__LINE__);
1038             }
1039
1040             lock_ReleaseWrite(&buf_globalLock);
1041             lock_ReleaseRead(&scp->bufCreateLock);
1042
1043             *bufpp = bp;
1044
1045 #ifdef TESTING
1046             buf_ValidateBufQueues();
1047 #endif /* TESTING */
1048             return 0;
1049         } /* for all buffers in lru queue */
1050         lock_ReleaseWrite(&buf_globalLock);
1051         lock_ReleaseRead(&scp->bufCreateLock);
1052         osi_Log0(afsd_logp, "buf_GetNewLocked: Free Buffer List has no buffers with a zero refcount - sleeping 100ms");
1053         Sleep(100);             /* give some time for a buffer to be freed */
1054     }   /* while loop over everything */
1055     /* not reached */
1056 } /* the proc */
1057
1058 /* get a page, returning it held but unlocked.  Doesn't fill in the page
1059  * with I/O, since we're going to write the whole thing new.
1060  */
1061 long buf_GetNew(struct cm_scache *scp, osi_hyper_t *offsetp, cm_req_t *reqp, cm_buf_t **bufpp)
1062 {
1063     cm_buf_t *bp;
1064     long code;
1065     osi_hyper_t pageOffset;
1066     int created;
1067
1068     created = 0;
1069     pageOffset.HighPart = offsetp->HighPart;
1070     pageOffset.LowPart = offsetp->LowPart & ~(cm_data.buf_blockSize-1);
1071     while (1) {
1072         bp = buf_Find(scp, &pageOffset);
1073         if (bp) {
1074             /* lock it and break out */
1075             lock_ObtainMutex(&bp->mx);
1076             break;
1077         }
1078
1079         /* otherwise, we have to create a page */
1080         code = buf_GetNewLocked(scp, &pageOffset, reqp, &bp);
1081
1082         /* check if the buffer was created in a race condition branch.
1083          * If so, go around so we can hold a reference to it. 
1084          */
1085         if (code == CM_BUF_EXISTS) 
1086             continue;
1087
1088         /* something else went wrong */
1089         if (code != 0) 
1090             return code;
1091
1092         /* otherwise, we have a locked buffer that we just created */
1093         created = 1;
1094         break;
1095     } /* big while loop */
1096
1097     /* wait for reads */
1098     if (bp->flags & CM_BUF_READING)
1099         buf_WaitIO(scp, bp);
1100
1101     /* once it has been read once, we can unlock it and return it, still
1102      * with its refcount held.
1103      */
1104     lock_ReleaseMutex(&bp->mx);
1105     *bufpp = bp;
1106     osi_Log4(buf_logp, "buf_GetNew returning bp 0x%p for scp 0x%p, offset 0x%x:%08x",
1107               bp, scp, offsetp->HighPart, offsetp->LowPart);
1108     return 0;
1109 }
1110
1111 /* get a page, returning it held but unlocked.  Make sure it is complete */
1112 /* The scp must be unlocked when passed to this function */
1113 long buf_Get(struct cm_scache *scp, osi_hyper_t *offsetp, cm_req_t *reqp, cm_buf_t **bufpp)
1114 {
1115     cm_buf_t *bp;
1116     long code;
1117     osi_hyper_t pageOffset;
1118     unsigned long tcount;
1119     int created;
1120     long lcount = 0;
1121 #ifdef DISKCACHE95
1122     cm_diskcache_t *dcp;
1123 #endif /* DISKCACHE95 */
1124
1125     created = 0;
1126     pageOffset.HighPart = offsetp->HighPart;
1127     pageOffset.LowPart = offsetp->LowPart & ~(cm_data.buf_blockSize-1);
1128     while (1) {
1129         lcount++;
1130 #ifdef TESTING
1131         buf_ValidateBufQueues();
1132 #endif /* TESTING */
1133
1134         bp = buf_Find(scp, &pageOffset);
1135         if (bp) {
1136             /* lock it and break out */
1137             lock_ObtainMutex(&bp->mx);
1138
1139 #ifdef DISKCACHE95
1140             /* touch disk chunk to update LRU info */
1141             diskcache_Touch(bp->dcp);
1142 #endif /* DISKCACHE95 */
1143             break;
1144         }
1145
1146         /* otherwise, we have to create a page */
1147         code = buf_GetNewLocked(scp, &pageOffset, reqp, &bp);
1148         /* bp->mx is now held */
1149
1150         /* check if the buffer was created in a race condition branch.
1151          * If so, go around so we can hold a reference to it. 
1152          */
1153         if (code == CM_BUF_EXISTS) 
1154             continue;
1155
1156         /* something else went wrong */
1157         if (code != 0) { 
1158 #ifdef TESTING
1159             buf_ValidateBufQueues();
1160 #endif /* TESTING */
1161             return code;
1162         }
1163                 
1164         /* otherwise, we have a locked buffer that we just created */
1165         created = 1;
1166         break;
1167     } /* big while loop */
1168
1169     /* if we get here, we have a locked buffer that may have just been
1170      * created, in which case it needs to be filled with data.
1171      */
1172     if (created) {
1173         /* load the page; freshly created pages should be idle */
1174         osi_assertx(!(bp->flags & (CM_BUF_READING | CM_BUF_WRITING)), "incorrect cm_buf_t flags");
1175
1176         /* start the I/O; may drop lock */
1177         bp->flags |= CM_BUF_READING;
1178         code = (*cm_buf_opsp->Readp)(bp, cm_data.buf_blockSize, &tcount, NULL);
1179
1180 #ifdef DISKCACHE95
1181         code = diskcache_Get(&bp->fid, &bp->offset, bp->datap, cm_data.buf_blockSize, &bp->dataVersion, &tcount, &dcp);
1182         bp->dcp = dcp;    /* pointer to disk cache struct. */
1183 #endif /* DISKCACHE95 */
1184
1185         if (code != 0) {
1186             /* failure or queued */
1187             if (code != ERROR_IO_PENDING) {
1188                 bp->error = code;
1189                 bp->flags |= CM_BUF_ERROR;
1190                 bp->flags &= ~CM_BUF_READING;
1191                 if (bp->flags & CM_BUF_WAITING) {
1192                     osi_Log1(buf_logp, "buf_Get Waking bp 0x%p", bp);
1193                     osi_Wakeup((LONG_PTR) bp);
1194                 }
1195                 lock_ReleaseMutex(&bp->mx);
1196                 buf_Release(bp);
1197 #ifdef TESTING
1198                 buf_ValidateBufQueues();
1199 #endif /* TESTING */
1200                 return code;
1201             }
1202         } else {
1203             /* otherwise, I/O completed instantly and we're done, except
1204              * for padding the xfr out with 0s and checking for EOF
1205              */
1206             if (tcount < (unsigned long) cm_data.buf_blockSize) {
1207                 memset(bp->datap+tcount, 0, cm_data.buf_blockSize - tcount);
1208                 if (tcount == 0)
1209                     bp->flags |= CM_BUF_EOF;
1210             }
1211             bp->flags &= ~CM_BUF_READING;
1212             if (bp->flags & CM_BUF_WAITING) {
1213                 osi_Log1(buf_logp, "buf_Get Waking bp 0x%p", bp);
1214                 osi_Wakeup((LONG_PTR) bp);
1215             }
1216         }
1217
1218     } /* if created */
1219
1220     /* wait for reads, either that which we started above, or that someone
1221      * else started.  We don't care if we return a buffer being cleaned.
1222      */
1223     if (bp->flags & CM_BUF_READING)
1224         buf_WaitIO(scp, bp);
1225
1226     /* once it has been read once, we can unlock it and return it, still
1227      * with its refcount held.
1228      */
1229     lock_ReleaseMutex(&bp->mx);
1230     *bufpp = bp;
1231
1232     /* now remove from queue; will be put in at the head (farthest from
1233      * being recycled) when we're done in buf_Release.
1234      */
1235     lock_ObtainWrite(&buf_globalLock);
1236     if (bp->flags & CM_BUF_INLRU) {
1237         if (cm_data.buf_freeListEndp == bp)
1238             cm_data.buf_freeListEndp = (cm_buf_t *) osi_QPrev(&bp->q);
1239         osi_QRemove((osi_queue_t **) &cm_data.buf_freeListp, &bp->q);
1240         bp->flags &= ~CM_BUF_INLRU;
1241     }
1242     lock_ReleaseWrite(&buf_globalLock);
1243
1244     osi_Log4(buf_logp, "buf_Get returning bp 0x%p for scp 0x%p, offset 0x%x:%08x",
1245               bp, scp, offsetp->HighPart, offsetp->LowPart);
1246 #ifdef TESTING
1247     buf_ValidateBufQueues();
1248 #endif /* TESTING */
1249     return 0;
1250 }
1251
1252 /* count # of elements in the free list;
1253  * we don't bother doing the proper locking for accessing dataVersion or flags
1254  * since it is a pain, and this is really just an advisory call.  If you need
1255  * to do better at some point, rewrite this function.
1256  */
1257 long buf_CountFreeList(void)
1258 {
1259     long count;
1260     cm_buf_t *bufp;
1261
1262     count = 0;
1263     lock_ObtainRead(&buf_globalLock);
1264     for(bufp = cm_data.buf_freeListp; bufp; bufp = (cm_buf_t *) osi_QNext(&bufp->q)) {
1265         /* if the buffer doesn't have an identity, or if the buffer
1266          * has been invalidate (by having its DV stomped upon), then
1267          * count it as free, since it isn't really being utilized.
1268          */
1269         if (!(bufp->flags & CM_BUF_INHASH) || bufp->dataVersion == CM_BUF_VERSION_BAD)
1270             count++;
1271     }       
1272     lock_ReleaseRead(&buf_globalLock);
1273     return count;
1274 }
1275
1276 /* clean a buffer synchronously */
1277 afs_uint32 buf_CleanAsync(cm_buf_t *bp, cm_req_t *reqp, afs_uint32 *pisdirty)
1278 {
1279     long code;
1280     osi_assertx(bp->magic == CM_BUF_MAGIC, "invalid cm_buf_t magic");
1281
1282     lock_ObtainMutex(&bp->mx);
1283     code = buf_CleanAsyncLocked(bp, reqp, pisdirty);
1284     lock_ReleaseMutex(&bp->mx);
1285
1286     return code;
1287 }       
1288
1289 /* wait for a buffer's cleaning to finish */
1290 void buf_CleanWait(cm_scache_t * scp, cm_buf_t *bp, afs_uint32 locked)
1291 {
1292     osi_assertx(bp->magic == CM_BUF_MAGIC, "invalid cm_buf_t magic");
1293
1294     if (!locked)
1295         lock_ObtainMutex(&bp->mx);
1296     if (bp->flags & CM_BUF_WRITING) {
1297         buf_WaitIO(scp, bp);
1298     }
1299     if (!locked)
1300         lock_ReleaseMutex(&bp->mx);
1301 }       
1302
1303 /* set the dirty flag on a buffer, and set associated write-ahead log,
1304  * if there is one.  Allow one to be added to a buffer, but not changed.
1305  *
1306  * The buffer must be locked before calling this routine.
1307  */
1308 void buf_SetDirty(cm_buf_t *bp, afs_uint32 offset, afs_uint32 length, cm_user_t *userp)
1309 {
1310     osi_assertx(bp->magic == CM_BUF_MAGIC, "invalid cm_buf_t magic");
1311     osi_assertx(bp->refCount > 0, "cm_buf_t refcount 0");
1312
1313     if (bp->flags & CM_BUF_DIRTY) {
1314
1315         osi_Log1(buf_logp, "buf_SetDirty 0x%p already dirty", bp);
1316
1317         if (bp->dirty_offset <= offset) {
1318             if (bp->dirty_offset + bp->dirty_length >= offset + length) {
1319                 /* dirty_length remains the same */
1320             } else {
1321                 bp->dirty_length = offset + length - bp->dirty_offset;
1322             }
1323         } else /* bp->dirty_offset > offset */ {
1324             if (bp->dirty_offset + bp->dirty_length >= offset + length) {
1325                 bp->dirty_length = bp->dirty_offset + bp->dirty_length - offset;
1326             } else {
1327                 bp->dirty_length = length;
1328             }
1329             bp->dirty_offset = offset;
1330         }
1331     } else {
1332         osi_Log1(buf_logp, "buf_SetDirty 0x%p", bp);
1333
1334         /* set dirty bit */
1335         bp->flags |= CM_BUF_DIRTY;
1336
1337         /* and turn off EOF flag, since it has associated data now */
1338         bp->flags &= ~CM_BUF_EOF;
1339
1340         bp->dirty_offset = offset;
1341         bp->dirty_length = length;
1342
1343         /* and add to the dirty list.  
1344          * we obtain a hold on the buffer for as long as it remains 
1345          * in the list.  buffers are only removed from the list by 
1346          * the buf_IncrSyncer function regardless of when else the
1347          * dirty flag might be cleared.
1348          *
1349          * This should never happen but just in case there is a bug
1350          * elsewhere, never add to the dirty list if the buffer is 
1351          * already there.
1352          */
1353         lock_ObtainWrite(&buf_globalLock);
1354         if (!(bp->flags & CM_BUF_INDL)) {
1355             buf_HoldLocked(bp);
1356             if (!cm_data.buf_dirtyListp) {
1357                 cm_data.buf_dirtyListp = cm_data.buf_dirtyListEndp = bp;
1358             } else {
1359                 cm_data.buf_dirtyListEndp->dirtyp = bp;
1360                 cm_data.buf_dirtyListEndp = bp;
1361             }
1362             bp->dirtyp = NULL;
1363             bp->flags |= CM_BUF_INDL;
1364         }
1365         lock_ReleaseWrite(&buf_globalLock);
1366     }
1367
1368     /* and record the last writer */
1369     if (bp->userp != userp) {
1370         cm_HoldUser(userp);
1371         if (bp->userp) 
1372             cm_ReleaseUser(bp->userp);
1373         bp->userp = userp;
1374     }
1375 }
1376
1377 /* clean all buffers, reset log pointers and invalidate all buffers.
1378  * Called with no locks held, and returns with same.
1379  *
1380  * This function is guaranteed to clean and remove the log ptr of all the
1381  * buffers that were dirty or had non-zero log ptrs before the call was
1382  * made.  That's sufficient to clean up any garbage left around by recovery,
1383  * which is all we're counting on this for; there may be newly created buffers
1384  * added while we're running, but that should be OK.
1385  *
1386  * In an environment where there are no transactions (artificially imposed, for
1387  * example, when switching the database to raw mode), this function is used to
1388  * make sure that all updates have been written to the disk.  In that case, we don't
1389  * really require that we forget the log association between pages and logs, but
1390  * it also doesn't hurt.  Since raw mode I/O goes through this buffer package, we don't
1391  * have to worry about invalidating data in the buffers.
1392  *
1393  * This function is used at the end of recovery as paranoia to get the recovered
1394  * database out to disk.  It removes all references to the recovery log and cleans
1395  * all buffers.
1396  */
1397 long buf_CleanAndReset(void)
1398 {
1399     afs_uint32 i;
1400     cm_buf_t *bp;
1401     cm_req_t req;
1402
1403     lock_ObtainRead(&buf_globalLock);
1404     for(i=0; i<cm_data.buf_hashSize; i++) {
1405         for(bp = cm_data.buf_scacheHashTablepp[i]; bp; bp = bp->hashp) {
1406             if ((bp->flags & CM_BUF_DIRTY) == CM_BUF_DIRTY) {
1407                 buf_HoldLocked(bp);
1408                 lock_ReleaseRead(&buf_globalLock);
1409
1410                 /* now no locks are held; clean buffer and go on */
1411                 cm_InitReq(&req);
1412                 req.flags |= CM_REQ_NORETRY;
1413
1414                 buf_CleanAsync(bp, &req, NULL);
1415                 buf_CleanWait(NULL, bp, FALSE);
1416
1417                 /* relock and release buffer */
1418                 lock_ObtainRead(&buf_globalLock);
1419                 buf_ReleaseLocked(bp, FALSE);
1420             } /* dirty */
1421         } /* over one bucket */
1422     }   /* for loop over all hash buckets */
1423
1424     /* release locks */
1425     lock_ReleaseRead(&buf_globalLock);
1426
1427 #ifdef TESTING
1428     buf_ValidateBufQueues();
1429 #endif /* TESTING */
1430     
1431     /* and we're done */
1432     return 0;
1433 }       
1434
1435 /* called without global lock being held, reserves buffers for callers
1436  * that need more than one held (not locked) at once.
1437  */
1438 void buf_ReserveBuffers(afs_uint64 nbuffers)
1439 {
1440     lock_ObtainWrite(&buf_globalLock);
1441     while (1) {
1442         if (cm_data.buf_reservedBufs + nbuffers > cm_data.buf_maxReservedBufs) {
1443             cm_data.buf_reserveWaiting = 1;
1444             osi_Log1(buf_logp, "buf_ReserveBuffers waiting for %d bufs", nbuffers);
1445             osi_SleepW((LONG_PTR) &cm_data.buf_reservedBufs, &buf_globalLock);
1446             lock_ObtainWrite(&buf_globalLock);
1447         }
1448         else {
1449             cm_data.buf_reservedBufs += nbuffers;
1450             break;
1451         }
1452     }
1453     lock_ReleaseWrite(&buf_globalLock);
1454 }
1455
1456 int buf_TryReserveBuffers(afs_uint64 nbuffers)
1457 {
1458     int code;
1459
1460     lock_ObtainWrite(&buf_globalLock);
1461     if (cm_data.buf_reservedBufs + nbuffers > cm_data.buf_maxReservedBufs) {
1462         code = 0;
1463     }
1464     else {
1465         cm_data.buf_reservedBufs += nbuffers;
1466         code = 1;
1467     }
1468     lock_ReleaseWrite(&buf_globalLock);
1469     return code;
1470 }       
1471
1472 /* called without global lock held, releases reservation held by
1473  * buf_ReserveBuffers.
1474  */
1475 void buf_UnreserveBuffers(afs_uint64 nbuffers)
1476 {
1477     lock_ObtainWrite(&buf_globalLock);
1478     cm_data.buf_reservedBufs -= nbuffers;
1479     if (cm_data.buf_reserveWaiting) {
1480         cm_data.buf_reserveWaiting = 0;
1481         osi_Wakeup((LONG_PTR) &cm_data.buf_reservedBufs);
1482     }
1483     lock_ReleaseWrite(&buf_globalLock);
1484 }       
1485
1486 /* truncate the buffers past sizep, zeroing out the page, if we don't
1487  * end on a page boundary.
1488  *
1489  * Requires cm_bufCreateLock to be write locked.
1490  */
1491 long buf_Truncate(cm_scache_t *scp, cm_user_t *userp, cm_req_t *reqp,
1492                    osi_hyper_t *sizep)
1493 {
1494     cm_buf_t *bufp;
1495     cm_buf_t *nbufp;                    /* next buffer, if didRelease */
1496     osi_hyper_t bufEnd;
1497     long code;
1498     long bufferPos;
1499     afs_uint32 i;
1500
1501     /* assert that cm_bufCreateLock is held in write mode */
1502     lock_AssertWrite(&scp->bufCreateLock);
1503
1504     i = BUF_FILEHASH(&scp->fid);
1505
1506     lock_ObtainRead(&buf_globalLock);
1507     bufp = cm_data.buf_fileHashTablepp[i];
1508     if (bufp == NULL) {
1509         lock_ReleaseRead(&buf_globalLock);
1510         return 0;
1511     }
1512
1513     buf_HoldLocked(bufp);
1514     lock_ReleaseRead(&buf_globalLock);
1515     while (bufp) {
1516         lock_ObtainMutex(&bufp->mx);
1517
1518         bufEnd.HighPart = 0;
1519         bufEnd.LowPart = cm_data.buf_blockSize;
1520         bufEnd = LargeIntegerAdd(bufEnd, bufp->offset);
1521
1522         if (cm_FidCmp(&bufp->fid, &scp->fid) == 0 &&
1523              LargeIntegerLessThan(*sizep, bufEnd)) {
1524             buf_WaitIO(scp, bufp);
1525         }
1526         lock_ObtainWrite(&scp->rw);
1527         
1528         /* make sure we have a callback (so we have the right value for
1529          * the length), and wait for it to be safe to do a truncate.
1530          */
1531         code = cm_SyncOp(scp, bufp, userp, reqp, 0,
1532                           CM_SCACHESYNC_NEEDCALLBACK
1533                           | CM_SCACHESYNC_GETSTATUS
1534                           | CM_SCACHESYNC_SETSIZE
1535                           | CM_SCACHESYNC_BUFLOCKED);
1536
1537         
1538         /* if we succeeded in our locking, and this applies to the right
1539          * file, and the truncate request overlaps the buffer either
1540          * totally or partially, then do something.
1541          */
1542         if (code == 0 && cm_FidCmp(&bufp->fid, &scp->fid) == 0
1543              && LargeIntegerLessThan(*sizep, bufEnd)) {
1544
1545
1546             /* destroy the buffer, turning off its dirty bit, if
1547              * we're truncating the whole buffer.  Otherwise, set
1548              * the dirty bit, and clear out the tail of the buffer
1549              * if we just overlap some.
1550              */
1551             if (LargeIntegerLessThanOrEqualTo(*sizep, bufp->offset)) {
1552                 /* truncating the entire page */
1553                 bufp->flags &= ~CM_BUF_DIRTY;
1554                 bufp->dirty_offset = 0;
1555                 bufp->dirty_length = 0;
1556                 bufp->dataVersion = CM_BUF_VERSION_BAD; /* known bad */
1557                 bufp->dirtyCounter++;
1558             }
1559             else {
1560                 /* don't set dirty, since dirty implies
1561                  * currently up-to-date.  Don't need to do this,
1562                  * since we'll update the length anyway.
1563                  *
1564                  * Zero out remainder of the page, in case we
1565                  * seek and write past EOF, and make this data
1566                  * visible again.
1567                  */
1568                 bufferPos = sizep->LowPart & (cm_data.buf_blockSize - 1);
1569                 osi_assertx(bufferPos != 0, "non-zero bufferPos");
1570                 memset(bufp->datap + bufferPos, 0,
1571                         cm_data.buf_blockSize - bufferPos);
1572             }
1573         }
1574                 
1575         cm_SyncOpDone( scp, bufp, 
1576                        CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS
1577                        | CM_SCACHESYNC_SETSIZE | CM_SCACHESYNC_BUFLOCKED);
1578
1579         lock_ReleaseWrite(&scp->rw);
1580         lock_ReleaseMutex(&bufp->mx);
1581     
1582         if (!code) {
1583             nbufp = bufp->fileHashp;
1584             if (nbufp) 
1585                 buf_Hold(nbufp);
1586         } else {
1587             /* This forces the loop to end and the error code
1588              * to be returned. */
1589             nbufp = NULL;
1590         }
1591         buf_Release(bufp);
1592         bufp = nbufp;
1593     }
1594
1595 #ifdef TESTING
1596     buf_ValidateBufQueues();
1597 #endif /* TESTING */
1598
1599     /* done */
1600     return code;
1601 }
1602
1603 long buf_FlushCleanPages(cm_scache_t *scp, cm_user_t *userp, cm_req_t *reqp)
1604 {
1605     long code;
1606     cm_buf_t *bp;               /* buffer we're hacking on */
1607     cm_buf_t *nbp;
1608     int didRelease;
1609     afs_uint32 i;
1610
1611     i = BUF_FILEHASH(&scp->fid);
1612
1613     code = 0;
1614     lock_ObtainRead(&buf_globalLock);
1615     bp = cm_data.buf_fileHashTablepp[i];
1616     if (bp) 
1617         buf_HoldLocked(bp);
1618     lock_ReleaseRead(&buf_globalLock);
1619     
1620     for (; bp; bp = nbp) {
1621         didRelease = 0; /* haven't released this buffer yet */
1622
1623         /* clean buffer synchronously */
1624         if (cm_FidCmp(&bp->fid, &scp->fid) == 0) {
1625             lock_ObtainMutex(&bp->mx);
1626
1627             /* start cleaning the buffer, and wait for it to finish */
1628             buf_CleanAsyncLocked(bp, reqp, NULL);
1629             buf_WaitIO(scp, bp);
1630             lock_ReleaseMutex(&bp->mx);
1631
1632             /* 
1633              * if the error for the previous buffer was BADFD
1634              * then all buffers for the FID are bad.  Do not
1635              * attempt to stabalize.
1636              */
1637             if (code != CM_ERROR_BADFD) {
1638                 code = (*cm_buf_opsp->Stabilizep)(scp, userp, reqp);
1639                 if (code && code != CM_ERROR_BADFD) 
1640                     goto skip;
1641             }
1642             if (code == CM_ERROR_BADFD) {
1643                 /* if the scp's FID is bad its because we received VNOVNODE 
1644                  * when attempting to FetchStatus before the write.  This
1645                  * page therefore contains data that can no longer be stored.
1646                  */
1647                 lock_ObtainMutex(&bp->mx);
1648                 bp->flags &= ~CM_BUF_DIRTY;
1649                 bp->flags |= CM_BUF_ERROR;
1650                 bp->error = CM_ERROR_BADFD;
1651                 bp->dirty_offset = 0;
1652                 bp->dirty_length = 0;
1653                 bp->dataVersion = CM_BUF_VERSION_BAD;   /* known bad */
1654                 bp->dirtyCounter++;
1655                 lock_ReleaseMutex(&bp->mx);
1656             }
1657
1658             /* actually, we only know that buffer is clean if ref
1659              * count is 1, since we don't have buffer itself locked.
1660              */
1661             if (!(bp->flags & CM_BUF_DIRTY)) {
1662                 lock_ObtainWrite(&buf_globalLock);
1663                 if (bp->refCount == 1) {        /* bp is held above */
1664                     nbp = bp->fileHashp;
1665                     if (nbp) 
1666                         buf_HoldLocked(nbp);
1667                     buf_ReleaseLocked(bp, TRUE);
1668                     didRelease = 1;
1669                     buf_Recycle(bp);
1670                 }
1671                 lock_ReleaseWrite(&buf_globalLock);
1672             }
1673
1674             if (code == 0)
1675                 (*cm_buf_opsp->Unstabilizep)(scp, userp);
1676         }
1677
1678       skip:
1679         if (!didRelease) {
1680             lock_ObtainRead(&buf_globalLock);
1681             nbp = bp->fileHashp;
1682             if (nbp)
1683                 buf_HoldLocked(nbp);
1684             buf_ReleaseLocked(bp, FALSE);
1685             lock_ReleaseRead(&buf_globalLock);
1686         }
1687     }   /* for loop over a bunch of buffers */
1688
1689 #ifdef TESTING
1690     buf_ValidateBufQueues();
1691 #endif /* TESTING */
1692
1693     /* done */
1694     return code;
1695 }       
1696
1697 /* Must be called with scp->rw held */
1698 long buf_ForceDataVersion(cm_scache_t * scp, afs_uint64 fromVersion, afs_uint64 toVersion)
1699 {
1700     cm_buf_t * bp;
1701     afs_uint32 i;
1702     int found = 0;
1703
1704     lock_AssertAny(&scp->rw);
1705
1706     i = BUF_FILEHASH(&scp->fid);
1707
1708     lock_ObtainRead(&buf_globalLock);
1709
1710     for (bp = cm_data.buf_fileHashTablepp[i]; bp; bp = bp->fileHashp) {
1711         if (cm_FidCmp(&bp->fid, &scp->fid) == 0) {
1712             if (bp->dataVersion == fromVersion) {
1713                 bp->dataVersion = toVersion;
1714                 found = 1;
1715             }
1716         }
1717     }
1718     lock_ReleaseRead(&buf_globalLock);
1719
1720     if (found)
1721         return 0;
1722     else
1723         return ENOENT;
1724 }
1725
1726 long buf_CleanVnode(struct cm_scache *scp, cm_user_t *userp, cm_req_t *reqp)
1727 {
1728     long code = 0;
1729     long wasDirty = 0;
1730     cm_buf_t *bp;               /* buffer we're hacking on */
1731     cm_buf_t *nbp;              /* next one */
1732     afs_uint32 i;
1733
1734     i = BUF_FILEHASH(&scp->fid);
1735
1736     lock_ObtainRead(&buf_globalLock);
1737     bp = cm_data.buf_fileHashTablepp[i];
1738     if (bp) 
1739         buf_HoldLocked(bp);
1740     lock_ReleaseRead(&buf_globalLock);
1741     for (; bp; bp = nbp) {
1742         /* clean buffer synchronously */
1743         if (cm_FidCmp(&bp->fid, &scp->fid) == 0) {
1744             lock_ObtainMutex(&bp->mx);
1745             if (bp->flags & CM_BUF_DIRTY) {
1746                 if (userp && userp != bp->userp) {
1747                     cm_HoldUser(userp);
1748                     if (bp->userp) 
1749                         cm_ReleaseUser(bp->userp);
1750                     bp->userp = userp;
1751                 }   
1752
1753                 switch (code) {
1754                 case CM_ERROR_NOSUCHFILE:
1755                 case CM_ERROR_BADFD:
1756                 case CM_ERROR_NOACCESS:
1757                 case CM_ERROR_QUOTA:
1758                 case CM_ERROR_SPACE:
1759                 case CM_ERROR_TOOBIG:
1760                 case CM_ERROR_READONLY:
1761                 case CM_ERROR_NOSUCHPATH:
1762                     /* 
1763                      * Apply the previous fatal error to this buffer.
1764                      * Do not waste the time attempting to store to
1765                      * the file server when we know it will fail.
1766                      */
1767                     bp->flags &= ~CM_BUF_DIRTY;
1768                     bp->flags |= CM_BUF_ERROR;
1769                     bp->dirty_offset = 0;
1770                     bp->dirty_length = 0;
1771                     bp->error = code;
1772                     bp->dataVersion = CM_BUF_VERSION_BAD;
1773                     bp->dirtyCounter++;
1774                     break;
1775                 case CM_ERROR_TIMEDOUT:
1776                 case CM_ERROR_ALLDOWN:
1777                 case CM_ERROR_ALLBUSY:
1778                 case CM_ERROR_ALLOFFLINE:
1779                 case CM_ERROR_CLOCKSKEW:
1780                     /* do not mark the buffer in error state but do
1781                      * not attempt to complete the rest either.
1782                      */
1783                     break;
1784                 default:
1785                     code = buf_CleanAsyncLocked(bp, reqp, &wasDirty);
1786                     if (bp->flags & CM_BUF_ERROR) {
1787                         code = bp->error;
1788                         if (code == 0)
1789                             code = -1;
1790                     }
1791                 }
1792                 buf_CleanWait(scp, bp, TRUE);
1793             }
1794             lock_ReleaseMutex(&bp->mx);
1795         }
1796
1797         lock_ObtainRead(&buf_globalLock);
1798         nbp = bp->fileHashp;
1799         if (nbp) 
1800             buf_HoldLocked(nbp);
1801         buf_ReleaseLocked(bp, FALSE);
1802         lock_ReleaseRead(&buf_globalLock);
1803     }   /* for loop over a bunch of buffers */
1804
1805 #ifdef TESTING
1806     buf_ValidateBufQueues();
1807 #endif /* TESTING */
1808
1809     /* done */
1810     return code;
1811 }
1812
1813 #ifdef TESTING
1814 void
1815 buf_ValidateBufQueues(void)
1816 {
1817     cm_buf_t * bp, *bpb, *bpf, *bpa;
1818     afs_uint32 countf=0, countb=0, counta=0;
1819
1820     lock_ObtainRead(&buf_globalLock);
1821     for (bp = cm_data.buf_freeListEndp; bp; bp=(cm_buf_t *) osi_QPrev(&bp->q)) {
1822         if (bp->magic != CM_BUF_MAGIC)
1823             osi_panic("buf magic error",__FILE__,__LINE__);
1824         countb++;
1825         bpb = bp;
1826     }
1827
1828     for (bp = cm_data.buf_freeListp; bp; bp=(cm_buf_t *) osi_QNext(&bp->q)) {
1829         if (bp->magic != CM_BUF_MAGIC)
1830             osi_panic("buf magic error",__FILE__,__LINE__);
1831         countf++;
1832         bpf = bp;
1833     }
1834
1835     for (bp = cm_data.buf_allp; bp; bp=bp->allp) {
1836         if (bp->magic != CM_BUF_MAGIC)
1837             osi_panic("buf magic error",__FILE__,__LINE__);
1838         counta++;
1839         bpa = bp;
1840     }
1841     lock_ReleaseRead(&buf_globalLock);
1842
1843     if (countb != countf)
1844         osi_panic("buf magic error",__FILE__,__LINE__);
1845
1846     if (counta != cm_data.buf_nbuffers)
1847         osi_panic("buf magic error",__FILE__,__LINE__);
1848 }
1849 #endif /* TESTING */
1850
1851 /* dump the contents of the buf_scacheHashTablepp. */
1852 int cm_DumpBufHashTable(FILE *outputFile, char *cookie, int lock)
1853 {
1854     int zilch;
1855     cm_buf_t *bp;
1856     char output[1024];
1857     afs_uint32 i;
1858   
1859     if (cm_data.buf_scacheHashTablepp == NULL)
1860         return -1;
1861
1862     if (lock)
1863         lock_ObtainRead(&buf_globalLock);
1864   
1865     StringCbPrintfA(output, sizeof(output), "%s - dumping buf_HashTable - buf_hashSize=%d\r\n", 
1866                     cookie, cm_data.buf_hashSize);
1867     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
1868   
1869     for (i = 0; i < cm_data.buf_hashSize; i++)
1870     {
1871         for (bp = cm_data.buf_scacheHashTablepp[i]; bp; bp=bp->hashp) 
1872         {
1873             StringCbPrintfA(output, sizeof(output), 
1874                             "%s bp=0x%08X, hash=%d, fid (cell=%d, volume=%d, "
1875                             "vnode=%d, unique=%d), offset=%x:%08x, dv=%I64d, "
1876                             "flags=0x%x, cmFlags=0x%x, error=0x%x, refCount=%d\r\n",
1877                              cookie, (void *)bp, i, bp->fid.cell, bp->fid.volume, 
1878                              bp->fid.vnode, bp->fid.unique, bp->offset.HighPart, 
1879                              bp->offset.LowPart, bp->dataVersion, bp->flags, 
1880                              bp->cmFlags, bp->error, bp->refCount);
1881             WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
1882         }
1883     }
1884   
1885     StringCbPrintfA(output, sizeof(output), "%s - Done dumping buf_HashTable.\r\n", cookie);
1886     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
1887
1888     StringCbPrintfA(output, sizeof(output), "%s - dumping buf_freeListEndp\r\n", cookie);
1889     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
1890     for(bp = cm_data.buf_freeListEndp; bp; bp=(cm_buf_t *) osi_QPrev(&bp->q)) {
1891         StringCbPrintfA(output, sizeof(output), 
1892                          "%s bp=0x%08X, fid (cell=%d, volume=%d, "
1893                          "vnode=%d, unique=%d), offset=%x:%08x, dv=%I64d, "
1894                          "flags=0x%x, cmFlags=0x%x, error=0x%x, refCount=%d\r\n",
1895                          cookie, (void *)bp, bp->fid.cell, bp->fid.volume, 
1896                          bp->fid.vnode, bp->fid.unique, bp->offset.HighPart, 
1897                          bp->offset.LowPart, bp->dataVersion, bp->flags, 
1898                          bp->cmFlags, bp->error, bp->refCount);
1899         WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
1900     }
1901     StringCbPrintfA(output, sizeof(output), "%s - Done dumping buf_FreeListEndp.\r\n", cookie);
1902     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
1903
1904     StringCbPrintfA(output, sizeof(output), "%s - dumping buf_dirtyListp\r\n", cookie);
1905     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
1906     for(bp = cm_data.buf_dirtyListp; bp; bp=bp->dirtyp) {
1907         StringCbPrintfA(output, sizeof(output), 
1908                          "%s bp=0x%08X, fid (cell=%d, volume=%d, "
1909                          "vnode=%d, unique=%d), offset=%x:%08x, dv=%I64d, "
1910                          "flags=0x%x, cmFlags=0x%x, error=0x%x, refCount=%d\r\n",
1911                          cookie, (void *)bp, bp->fid.cell, bp->fid.volume, 
1912                          bp->fid.vnode, bp->fid.unique, bp->offset.HighPart, 
1913                          bp->offset.LowPart, bp->dataVersion, bp->flags, 
1914                          bp->cmFlags, bp->error, bp->refCount);
1915         WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
1916     }
1917     StringCbPrintfA(output, sizeof(output), "%s - Done dumping buf_dirtyListp.\r\n", cookie);
1918     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
1919
1920     if (lock)
1921         lock_ReleaseRead(&buf_globalLock);
1922     return 0;
1923 }
1924
1925 void buf_ForceTrace(BOOL flush)
1926 {
1927     HANDLE handle;
1928     int len;
1929     char buf[256];
1930
1931     if (!buf_logp) 
1932         return;
1933
1934     len = GetTempPath(sizeof(buf)-10, buf);
1935     StringCbCopyA(&buf[len], sizeof(buf)-len, "/afs-buffer.log");
1936     handle = CreateFile(buf, GENERIC_WRITE, FILE_SHARE_READ,
1937                             NULL, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
1938     if (handle == INVALID_HANDLE_VALUE) {
1939         osi_panic("Cannot create log file", __FILE__, __LINE__);
1940     }
1941     osi_LogPrint(buf_logp, handle);
1942     if (flush)
1943         FlushFileBuffers(handle);
1944     CloseHandle(handle);
1945 }
1946
1947 long buf_DirtyBuffersExist(cm_fid_t *fidp)
1948 {
1949     cm_buf_t *bp;
1950     afs_uint32 bcount = 0;
1951     afs_uint32 i;
1952
1953     i = BUF_FILEHASH(fidp);
1954
1955     for (bp = cm_data.buf_fileHashTablepp[i]; bp; bp=bp->allp, bcount++) {
1956         if (!cm_FidCmp(fidp, &bp->fid) && (bp->flags & CM_BUF_DIRTY))
1957             return 1;
1958     }
1959     return 0;
1960 }
1961
1962 #if 0
1963 long buf_CleanDirtyBuffers(cm_scache_t *scp)
1964 {
1965     cm_buf_t *bp;
1966     afs_uint32 bcount = 0;
1967     cm_fid_t * fidp = &scp->fid;
1968
1969     for (bp = cm_data.buf_allp; bp; bp=bp->allp, bcount++) {
1970         if (!cm_FidCmp(fidp, &bp->fid) && (bp->flags & CM_BUF_DIRTY)) {
1971             buf_Hold(bp);
1972             lock_ObtainMutex(&bp->mx);
1973             bp->cmFlags &= ~CM_BUF_CMSTORING;
1974             bp->flags &= ~CM_BUF_DIRTY;
1975             bp->dirty_offset = 0;
1976             bp->dirty_length = 0;
1977             bp->flags |= CM_BUF_ERROR;
1978             bp->error = VNOVNODE;
1979             bp->dataVersion = CM_BUF_VERSION_BAD; /* bad */
1980             bp->dirtyCounter++;
1981             if (bp->flags & CM_BUF_WAITING) {
1982                 osi_Log2(buf_logp, "BUF CleanDirtyBuffers Waking [scp 0x%x] bp 0x%x", scp, bp);
1983                 osi_Wakeup((long) &bp);
1984             }
1985             lock_ReleaseMutex(&bp->mx);
1986             buf_Release(bp);
1987         }
1988     }
1989     return 0;
1990 }
1991 #endif