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