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