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