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