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