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