windows-virtual-memory-20041224
[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 #ifndef DJGPP
16 #include <windows.h>
17 #endif
18 #include <osi.h>
19 #include <malloc.h>
20 #include <stdio.h>
21 #include <assert.h>
22 #include <strsafe.h>
23
24 #include "afsd.h"
25
26 #ifdef DEBUG
27 #define TRACE_BUFFER 1
28 #endif
29
30 extern void afsi_log(char *pattern, ...);
31
32 /* This module implements the buffer package used by the local transaction
33  * system (cm).  It is initialized by calling cm_Init, which calls buf_Init;
34  * it must be initalized before any of its main routines are called.
35  *
36  * Each buffer is hashed into a hash table by file ID and offset, and if its
37  * reference count is zero, it is also in a free list.
38  *
39  * There are two locks involved in buffer processing.  The global lock
40  * buf_globalLock protects all of the global variables defined in this module,
41  * the reference counts and hash pointers in the actual cm_buf_t structures,
42  * and the LRU queue pointers in the buffer structures.
43  *
44  * The mutexes in the buffer structures protect the remaining fields in the
45  * buffers, as well the data itself.
46  * 
47  * The locking hierarchy here is this:
48  * 
49  * - resv multiple simul. buffers reservation
50  * - lock buffer I/O flags
51  * - lock buffer's mutex
52  * - lock buf_globalLock
53  *
54  */
55
56 /* global debugging log */
57 osi_log_t *buf_logp = NULL;
58
59 /* Global lock protecting hash tables and free lists */
60 osi_rwlock_t buf_globalLock;
61
62 /* ptr to head of the free list (most recently used) and the
63  * tail (the guy to remove first).  We use osi_Q* functions
64  * to put stuff in buf_freeListp, and maintain the end
65  * pointer manually
66  */
67 cm_buf_t *buf_freeListp;
68 cm_buf_t *buf_freeListEndp;
69
70 /* a pointer to a list of all buffers, just so that we can find them
71  * easily for debugging, and for the incr syncer.  Locked under
72  * the global lock.
73  */
74 cm_buf_t *buf_allp;
75
76 /* defaults setup; these variables may be manually assigned into
77  * before calling cm_Init, as a way of changing these defaults.
78  */
79 long buf_nbuffers = CM_BUF_BUFFERS;
80 long buf_nOrigBuffers;
81 long buf_bufferSize = CM_BUF_SIZE;
82 long buf_hashSize = CM_BUF_HASHSIZE;
83 int buf_cacheType = CM_BUF_CACHETYPE_FILE;
84
85 #ifndef DJGPP
86 static
87 HANDLE CacheHandle;
88
89 static 
90 VOID * ViewOfFile;
91
92 static
93 SYSTEM_INFO sysInfo;
94 #endif /* !DJGPP */
95
96 /* buffer reservation variables */
97 long buf_reservedBufs;
98 long buf_maxReservedBufs;
99 int buf_reserveWaiting;
100
101 /* callouts for reading and writing data, etc */
102 cm_buf_ops_t *cm_buf_opsp;
103
104 /* pointer to hash table; size computed dynamically */
105 cm_buf_t **buf_hashTablepp;
106
107 /* another hash table */
108 cm_buf_t **buf_fileHashTablepp;
109
110 #ifdef DISKCACHE95
111 /* for experimental disk caching support in Win95 client */
112 cm_buf_t *buf_diskFreeListp;
113 cm_buf_t *buf_diskFreeListEndp;
114 cm_buf_t *buf_diskAllp;
115 extern int cm_diskCacheEnabled;
116 #endif /* DISKCACHE95 */
117
118 /* hold a reference to an already held buffer */
119 void buf_Hold(cm_buf_t *bp)
120 {
121     lock_ObtainWrite(&buf_globalLock);
122     bp->refCount++;
123     lock_ReleaseWrite(&buf_globalLock);
124 }
125
126 /* incremental sync daemon.  Writes 1/10th of all the buffers every 5000 ms */
127 void buf_IncrSyncer(long parm)
128 {
129     cm_buf_t *bp;                       /* buffer we're hacking on; held */
130     long i;                             /* counter */
131     long nAtOnce;                       /* how many to do at once */
132     cm_req_t req;
133
134     lock_ObtainWrite(&buf_globalLock);
135     bp = buf_allp;
136     bp->refCount++;
137     lock_ReleaseWrite(&buf_globalLock);
138     nAtOnce = buf_nbuffers / 10;
139     while (1) {
140 #ifndef DJGPP
141         i = SleepEx(5000, 1);
142         if (i != 0) continue;
143 #else
144         thrd_Sleep(5000);
145 #endif /* DJGPP */
146                 
147         /* now go through our percentage of the buffers */
148         for(i=0; i<nAtOnce; i++) {
149             /* don't want its identity changing while we're
150              * messing with it, so must do all of this with
151              * bp held.
152              */
153
154             /* start cleaning the buffer; don't touch log pages since
155              * the log code counts on knowing exactly who is writing
156              * a log page at any given instant.
157              */
158             cm_InitReq(&req);
159             req.flags |= CM_REQ_NORETRY;
160             buf_CleanAsync(bp, &req);
161
162             /* now advance to the next buffer; the allp chain never changes,
163              * and so can be followed even when holding no locks.
164              */
165             lock_ObtainWrite(&buf_globalLock);
166             buf_LockedRelease(bp);
167             bp = bp->allp;
168             if (!bp) bp = buf_allp;
169             bp->refCount++;
170             lock_ReleaseWrite(&buf_globalLock);
171         }       /* for loop over a bunch of buffers */
172     }           /* whole daemon's while loop */
173 }
174
175 #ifndef DJGPP
176 /* Create a security attribute structure suitable for use when the cache file
177  * is created.  What we mainly want is that only the administrator should be
178  * able to do anything with the file.  We create an ACL with only one entry,
179  * an entry that grants all rights to the administrator.
180  */
181 PSECURITY_ATTRIBUTES CreateCacheFileSA()
182 {
183     PSECURITY_ATTRIBUTES psa;
184     PSECURITY_DESCRIPTOR psd;
185     SID_IDENTIFIER_AUTHORITY authority = SECURITY_NT_AUTHORITY;
186     PSID AdminSID;
187     DWORD AdminSIDlength;
188     PACL AdminOnlyACL;
189     DWORD ACLlength;
190
191     /* Get Administrator SID */
192     AllocateAndInitializeSid(&authority, 2,
193                               SECURITY_BUILTIN_DOMAIN_RID,
194                               DOMAIN_ALIAS_RID_ADMINS,
195                               0, 0, 0, 0, 0, 0,
196                               &AdminSID);
197
198     /* Create Administrator-only ACL */
199     AdminSIDlength = GetLengthSid(AdminSID);
200     ACLlength = sizeof(ACL) + sizeof(ACCESS_ALLOWED_ACE)
201         + AdminSIDlength - sizeof(DWORD);
202     AdminOnlyACL = GlobalAlloc(GMEM_FIXED, ACLlength);
203     InitializeAcl(AdminOnlyACL, ACLlength, ACL_REVISION);
204     AddAccessAllowedAce(AdminOnlyACL, ACL_REVISION,
205                          STANDARD_RIGHTS_ALL | SPECIFIC_RIGHTS_ALL,
206                          AdminSID);
207
208     /* Create security descriptor */
209     psd = GlobalAlloc(GMEM_FIXED, sizeof(SECURITY_DESCRIPTOR));
210     InitializeSecurityDescriptor(psd, SECURITY_DESCRIPTOR_REVISION);
211     SetSecurityDescriptorDacl(psd, TRUE, AdminOnlyACL, FALSE);
212
213     /* Create security attributes structure */
214     psa = GlobalAlloc(GMEM_FIXED, sizeof(SECURITY_ATTRIBUTES));
215     psa->nLength = sizeof(SECURITY_ATTRIBUTES);
216     psa->lpSecurityDescriptor = psd;
217     psa->bInheritHandle = TRUE;
218
219     return psa;
220 }       
221 #endif /* !DJGPP */
222
223 #ifndef DJGPP
224 /* Free a security attribute structure created by CreateCacheFileSA() */
225 VOID FreeCacheFileSA(PSECURITY_ATTRIBUTES psa)
226 {
227     BOOL b1, b2;
228     PACL pAcl;
229
230     GetSecurityDescriptorDacl(psa->lpSecurityDescriptor, &b1, &pAcl, &b2);
231     GlobalFree(pAcl);
232     GlobalFree(psa->lpSecurityDescriptor);
233     GlobalFree(psa);
234 }       
235 #endif /* !DJGPP */
236         
237 /* initialize the buffer package; called with no locks
238  * held during the initialization phase.
239  */
240 long buf_Init(cm_buf_ops_t *opsp)
241 {
242     static osi_once_t once;
243     cm_buf_t *bp;
244     long sectorSize;
245     thread_t phandle;
246 #ifndef DJGPP
247     HANDLE hf, hm;
248     PSECURITY_ATTRIBUTES psa;
249 #endif /* !DJGPP */
250     long i;
251     unsigned long pid;
252     char *data;
253     long cs;
254
255 #ifndef DJGPP
256     /* Get system info; all we really want is the allocation granularity */ 
257     GetSystemInfo(&sysInfo);
258 #endif /* !DJGPP */
259
260     /* Have to be able to reserve a whole chunk */
261     if (((buf_nbuffers - 3) * buf_bufferSize) < cm_chunkSize)
262         return CM_ERROR_TOOFEWBUFS;
263
264     /* recall for callouts */
265     cm_buf_opsp = opsp;
266
267     if (osi_Once(&once)) {
268         /* initialize global locks */
269         lock_InitializeRWLock(&buf_globalLock, "Global buffer lock");
270
271 #ifndef DJGPP
272         /*
273         * Cache file mapping constrained by
274          * system allocation granularity;
275          * round up, assuming granularity is a power of two
276          */
277         cs = buf_nbuffers * buf_bufferSize;
278         cs = (cs + (sysInfo.dwAllocationGranularity - 1))
279             & ~(sysInfo.dwAllocationGranularity - 1);
280         if (cs != buf_nbuffers * buf_bufferSize) {
281             buf_nbuffers = cs / buf_bufferSize;
282             afsi_log("Cache size rounded up to %d buffers",
283                       buf_nbuffers);
284         }
285 #endif /* !DJGPP */
286
287         /* remember this for those who want to reset it */
288         buf_nOrigBuffers = buf_nbuffers;
289
290         /* lower hash size to a prime number */
291         buf_hashSize = osi_PrimeLessThan(buf_hashSize);
292
293         /* create hash table */
294         buf_hashTablepp = malloc(buf_hashSize * sizeof(cm_buf_t *));
295         memset((void *)buf_hashTablepp, 0,
296                 buf_hashSize * sizeof(cm_buf_t *));
297
298         /* another hash table */
299         buf_fileHashTablepp = malloc(buf_hashSize * sizeof(cm_buf_t *));
300         memset((void *)buf_fileHashTablepp, 0,
301                 buf_hashSize * sizeof(cm_buf_t *));
302                 
303         /* min value for which this works */
304         sectorSize = 1;
305
306 #ifndef DJGPP
307         if (buf_cacheType == CM_BUF_CACHETYPE_FILE) {
308             /* Reserve buffer space by mapping cache file */
309             psa = CreateCacheFileSA();
310             hf = CreateFile(cm_CachePath,
311                              GENERIC_READ | GENERIC_WRITE,
312                              FILE_SHARE_READ | FILE_SHARE_WRITE,
313                              psa,
314                              OPEN_ALWAYS,
315                              FILE_ATTRIBUTE_NORMAL,
316                              NULL);
317             FreeCacheFileSA(psa);
318             if (hf == INVALID_HANDLE_VALUE) {
319                 afsi_log("Error creating cache file \"%s\" error %d", 
320                           cm_CachePath, GetLastError());
321                 return CM_ERROR_INVAL;
322             }
323         } else { /* buf_cacheType == CM_BUF_CACHETYPE_VIRTUAL */
324             hf = INVALID_HANDLE_VALUE;
325         }
326         CacheHandle = hf;
327         hm = CreateFileMapping(hf,
328                                 NULL,
329                                 PAGE_READWRITE,
330                                 0, buf_nbuffers * buf_bufferSize,
331                                 NULL);
332         if (hm == NULL) {
333             if (GetLastError() == ERROR_DISK_FULL) {
334                 afsi_log("Error creating cache file \"%s\" mapping: disk full",
335                           cm_CachePath);
336                 return CM_ERROR_TOOMANYBUFS;
337             }
338             return CM_ERROR_INVAL;
339         }
340         ViewOfFile = MapViewOfFile(hm,
341                                    FILE_MAP_ALL_ACCESS,
342                                    0, 0,   
343                                    buf_nbuffers * buf_bufferSize);
344         if (ViewOfFile == NULL) {
345             afsi_log("Error mapping view of file: 0x%X", GetLastError());
346             if (hf != INVALID_HANDLE_VALUE)
347                 CloseHandle(hf);
348             CloseHandle(hm);
349             return CM_ERROR_INVAL;
350         }
351         CloseHandle(hm);
352
353         data = ViewOfFile;
354 #else   
355         /* djgpp doesn't support memory mapped files */
356         data = malloc(buf_nbuffers * buf_bufferSize);
357 #endif /* !DJGPP */
358
359         /* create buffer headers and put in free list */
360         bp = malloc(buf_nbuffers * sizeof(cm_buf_t));
361         buf_allp = NULL;
362         for(i=0; i<buf_nbuffers; i++) {
363             /* allocate and zero some storage */
364             memset(bp, 0, sizeof(cm_buf_t));
365
366             /* thread on list of all buffers */
367             bp->allp = buf_allp;
368             buf_allp = bp;
369
370             osi_QAdd((osi_queue_t **)&buf_freeListp, &bp->q);
371             bp->flags |= CM_BUF_INLRU;
372             lock_InitializeMutex(&bp->mx, "Buffer mutex");
373
374             /* grab appropriate number of bytes from aligned zone */
375             bp->datap = data;
376
377             /* setup last buffer pointer */
378             if (i == 0)
379                 buf_freeListEndp = bp;
380
381             /* next */
382             bp++;
383             data += buf_bufferSize;
384         }
385
386         /* none reserved at first */
387         buf_reservedBufs = 0;
388
389         /* just for safety's sake */
390         buf_maxReservedBufs = buf_nbuffers - 3;
391
392 #ifdef TRACE_BUFFER
393         /* init the buffer trace log */
394         buf_logp = osi_LogCreate("buffer", 1000);
395         osi_LogEnable(buf_logp);
396 #endif
397
398         osi_EndOnce(&once);
399
400         /* and create the incr-syncer */
401         phandle = thrd_Create(0, 0,
402                                (ThreadFunc) buf_IncrSyncer, 0, 0, &pid,
403                                "buf_IncrSyncer");
404
405         osi_assertx(phandle != NULL, "buf: can't create incremental sync proc");
406 #ifndef DJGPP
407         CloseHandle(phandle);
408 #endif /* !DJGPP */
409     }
410
411     return 0;
412 }
413
414 void
415 buf_Shutdown(void)
416 {
417     UnmapViewOfFile(ViewOfFile);
418     CloseHandle(CacheHandle);
419 }
420
421 /* add nbuffers to the buffer pool, if possible.
422  * Called with no locks held.
423  */
424 long buf_AddBuffers(long nbuffers)
425 {
426     cm_buf_t *bp;
427     int i;
428     char *data;
429 #ifndef DJGPP
430     HANDLE hm;
431     long cs;
432
433     afsi_log("%d buffers being added to the existing cache of size %d",
434               nbuffers, buf_nbuffers);
435
436     if (buf_cacheType == CM_BUF_CACHETYPE_VIRTUAL) {
437         /* The size of a virtual cache cannot be changed after it has
438          * been created.  Subsequent calls to MapViewofFile() with
439          * an existing mapping object name would not allow the 
440          * object to be resized.  Return failure immediately.
441          */
442         return CM_ERROR_INVAL;
443     }
444
445     /*
446      * Cache file mapping constrained by
447      * system allocation granularity;
448      * round up, assuming granularity is a power of two;
449      * assume existing cache size is already rounded
450      */
451     cs = nbuffers * buf_bufferSize;
452     cs = (cs + (sysInfo.dwAllocationGranularity - 1))
453         & ~(sysInfo.dwAllocationGranularity - 1);
454     if (cs != nbuffers * buf_bufferSize) {
455         nbuffers = cs / buf_bufferSize;
456     }
457
458     /* Reserve additional buffer space by remapping cache file */
459     hm = CreateFileMapping(CacheHandle,
460                             NULL,
461                             PAGE_READWRITE,
462                             0, (buf_nbuffers + nbuffers) * buf_bufferSize,
463                             NULL);
464     if (hm == NULL) {
465         if (GetLastError() == ERROR_DISK_FULL)
466             return CM_ERROR_TOOMANYBUFS;
467         else
468             return CM_ERROR_INVAL;
469     }
470     data = MapViewOfFile(hm,
471                           FILE_MAP_ALL_ACCESS,
472                           0, buf_nbuffers * buf_bufferSize,
473                           nbuffers * buf_bufferSize);
474     if (data == NULL) {
475         CloseHandle(hm);
476         return CM_ERROR_INVAL;
477     }
478     CloseHandle(hm);
479 #else
480     data = malloc(buf_nbuffers * buf_bufferSize);
481 #endif /* DJGPP */
482
483     /* Create buffer headers and put in free list */
484     bp = malloc(nbuffers * sizeof(*bp));
485
486     for(i=0; i<nbuffers; i++) {
487         memset(bp, 0, sizeof(*bp));
488         
489         lock_InitializeMutex(&bp->mx, "cm_buf_t");
490
491         /* grab appropriate number of bytes from aligned zone */
492         bp->datap = data;
493
494         bp->flags |= CM_BUF_INLRU;
495
496         lock_ObtainWrite(&buf_globalLock);
497         /* note that buf_allp chain is covered by buf_globalLock now */
498         bp->allp = buf_allp;
499         buf_allp = bp;
500         osi_QAdd((osi_queue_t **) &buf_freeListp, &bp->q);
501         if (!buf_freeListEndp) buf_freeListEndp = bp;
502         buf_nbuffers++;
503         lock_ReleaseWrite(&buf_globalLock);
504
505         bp++;
506         data += buf_bufferSize;
507         
508     }    /* for loop over all buffers */
509
510     return 0;
511 }       
512
513 /* interface to set the number of buffers to an exact figure.
514  * Called with no locks held.
515  */
516 long buf_SetNBuffers(long nbuffers)
517 {
518     if (nbuffers < 10) 
519         return CM_ERROR_INVAL;
520     if (nbuffers == buf_nbuffers) 
521         return 0;
522     else if (nbuffers > buf_nbuffers)
523         return buf_AddBuffers(nbuffers - buf_nbuffers);
524     else 
525         return CM_ERROR_INVAL;
526 }
527
528 /* release a buffer.  Buffer must be referenced, but unlocked. */
529 void buf_Release(cm_buf_t *bp)
530 {
531     lock_ObtainWrite(&buf_globalLock);
532     buf_LockedRelease(bp);
533     lock_ReleaseWrite(&buf_globalLock);
534 }
535
536 /* wait for reading or writing to clear; called with write-locked
537  * buffer, and returns with locked buffer.
538  */
539 void buf_WaitIO(cm_buf_t *bp)
540 {
541     while (1) {
542         /* if no IO is happening, we're done */
543         if (!(bp->flags & (CM_BUF_READING | CM_BUF_WRITING)))
544             break;
545                 
546         /* otherwise I/O is happening, but some other thread is waiting for
547          * the I/O already.  Wait for that guy to figure out what happened,
548          * and then check again.
549          */
550         if ( bp->flags & CM_BUF_WAITING ) 
551             osi_Log1(buf_logp, "buf_WaitIO CM_BUF_WAITING already set for 0x%x", bp);
552
553         bp->flags |= CM_BUF_WAITING;
554         osi_SleepM((long) bp, &bp->mx);
555         lock_ObtainMutex(&bp->mx);
556         osi_Log1(buf_logp, "buf_WaitIO conflict wait done for 0x%x", bp);
557     }
558         
559     /* if we get here, the IO is done, but we may have to wakeup people waiting for
560      * the I/O to complete.  Do so.
561      */
562     if (bp->flags & CM_BUF_WAITING) {
563         bp->flags &= ~CM_BUF_WAITING;
564         osi_Wakeup((long) bp);
565     }
566     osi_Log1(buf_logp, "WaitIO finished wait for bp 0x%x", (long) bp);
567 }
568
569 /* code to drop reference count while holding buf_globalLock */
570 void buf_LockedRelease(cm_buf_t *bp)
571 {
572     /* ensure that we're in the LRU queue if our ref count is 0 */
573     osi_assert(bp->refCount > 0);
574     if (--bp->refCount == 0) {
575         if (!(bp->flags & CM_BUF_INLRU)) {
576             osi_QAdd((osi_queue_t **) &buf_freeListp, &bp->q);
577
578             /* watch for transition from empty to one element */
579             if (!buf_freeListEndp)
580                 buf_freeListEndp = buf_freeListp;
581             bp->flags |= CM_BUF_INLRU;
582         }
583     }
584 }       
585
586 /* find a buffer, if any, for a particular file ID and offset.  Assumes
587  * that buf_globalLock is write locked when called.
588  */
589 cm_buf_t *buf_LockedFind(struct cm_scache *scp, osi_hyper_t *offsetp)
590 {
591     long i;
592     cm_buf_t *bp;
593
594     i = BUF_HASH(&scp->fid, offsetp);
595     for(bp = buf_hashTablepp[i]; bp; bp=bp->hashp) {
596         if (cm_FidCmp(&scp->fid, &bp->fid) == 0
597              && offsetp->LowPart == bp->offset.LowPart
598              && offsetp->HighPart == bp->offset.HighPart) {
599             bp->refCount++;
600             break;
601         }
602     }
603         
604     /* return whatever we found, if anything */
605     return bp;
606 }
607
608 /* find a buffer with offset *offsetp for vnode *scp.  Called
609  * with no locks held.
610  */
611 cm_buf_t *buf_Find(struct cm_scache *scp, osi_hyper_t *offsetp)
612 {
613     cm_buf_t *bp;
614
615     lock_ObtainWrite(&buf_globalLock);
616     bp = buf_LockedFind(scp, offsetp);
617     lock_ReleaseWrite(&buf_globalLock);
618
619     return bp;
620 }       
621
622 /* start cleaning I/O on this buffer.  Buffer must be write locked, and is returned
623  * write-locked.
624  *
625  * Makes sure that there's only one person writing this block
626  * at any given time, and also ensures that the log is forced sufficiently far,
627  * if this buffer contains logged data.
628  */
629 void buf_LockedCleanAsync(cm_buf_t *bp, cm_req_t *reqp)
630 {
631     long code;
632
633     code = 0;
634     while ((bp->flags & (CM_BUF_WRITING | CM_BUF_DIRTY)) == CM_BUF_DIRTY) {
635         lock_ReleaseMutex(&bp->mx);
636
637         code = (*cm_buf_opsp->Writep)(&bp->fid, &bp->offset,
638                                        buf_bufferSize, 0, bp->userp,
639                                        reqp);
640                 
641         lock_ObtainMutex(&bp->mx);
642         if (code) 
643             break;
644
645 #ifdef DISKCACHE95
646         /* Disk cache support */
647         /* write buffer to disk cache (synchronous for now) */
648         diskcache_Update(bp->dcp, bp->datap, buf_bufferSize, bp->dataVersion);
649 #endif /* DISKCACHE95 */
650     };
651
652     /* do logging after call to GetLastError, or else */
653     osi_Log2(buf_logp, "buf_CleanAsync starts I/O on 0x%x, done=%d", bp, code);
654         
655     /* if someone was waiting for the I/O that just completed or failed,
656      * wake them up.
657      */
658     if (bp->flags & CM_BUF_WAITING) {
659         /* turn off flags and wakeup users */
660         bp->flags &= ~CM_BUF_WAITING;
661         osi_Wakeup((long) bp);
662     }
663 }
664
665 /* Called with a zero-ref count buffer and with the buf_globalLock write locked.
666  * recycles the buffer, and leaves it ready for reuse with a ref count of 1.
667  * The buffer must already be clean, and no I/O should be happening to it.
668  */
669 void buf_Recycle(cm_buf_t *bp)
670 {
671     int i;
672     cm_buf_t **lbpp;
673     cm_buf_t *tbp;
674     cm_buf_t *prevBp, *nextBp;
675
676     /* if we get here, we know that the buffer still has a 0 ref count,
677      * and that it is clean and has no currently pending I/O.  This is
678      * the dude to return.
679      * Remember that as long as the ref count is 0, we know that we won't
680      * have any lock conflicts, so we can grab the buffer lock out of
681      * order in the locking hierarchy.
682      */
683     osi_Log2( buf_logp, "buf_Recycle recycles 0x%x, off 0x%x",
684               bp, bp->offset.LowPart);
685
686     osi_assert(bp->refCount == 0);
687     osi_assert(!(bp->flags & (CM_BUF_READING | CM_BUF_WRITING | CM_BUF_DIRTY)));
688     lock_AssertWrite(&buf_globalLock);
689
690     if (bp->flags & CM_BUF_INHASH) {
691         /* Remove from hash */
692
693         i = BUF_HASH(&bp->fid, &bp->offset);
694         lbpp = &(buf_hashTablepp[i]);
695         for(tbp = *lbpp; tbp; lbpp = &tbp->hashp, tbp = *lbpp) {
696             if (tbp == bp) break;
697         }
698
699         /* we better find it */
700         osi_assertx(tbp != NULL, "buf_GetNewLocked: hash table screwup");
701
702         *lbpp = bp->hashp;      /* hash out */
703
704         /* Remove from file hash */
705
706         i = BUF_FILEHASH(&bp->fid);
707         prevBp = bp->fileHashBackp;
708         nextBp = bp->fileHashp;
709         if (prevBp)
710             prevBp->fileHashp = nextBp;
711         else
712             buf_fileHashTablepp[i] = nextBp;
713         if (nextBp)
714             nextBp->fileHashBackp = prevBp;
715
716         bp->flags &= ~CM_BUF_INHASH;
717     }
718
719     /* bump the soft reference counter now, to invalidate softRefs; no
720      * wakeup is required since people don't sleep waiting for this
721      * counter to change.
722      */
723     bp->idCounter++;
724
725     /* make the fid unrecognizable */
726     memset(&bp->fid, 0, sizeof(bp->fid));
727 }       
728
729 /* recycle a buffer, removing it from the free list, hashing in its new identity
730  * and returning it write-locked so that no one can use it.  Called without
731  * any locks held, and can return an error if it loses the race condition and 
732  * finds that someone else created the desired buffer.
733  *
734  * If success is returned, the buffer is returned write-locked.
735  *
736  * May be called with null scp and offsetp, if we're just trying to reclaim some
737  * space from the buffer pool.  In that case, the buffer will be returned
738  * without being hashed into the hash table.
739  */
740 long buf_GetNewLocked(struct cm_scache *scp, osi_hyper_t *offsetp, cm_buf_t **bufpp)
741 {
742     cm_buf_t *bp;               /* buffer we're dealing with */
743     cm_buf_t *nextBp;   /* next buffer in file hash chain */
744     long i;                     /* temp */
745     cm_req_t req;
746
747     cm_InitReq(&req);   /* just in case */
748
749     while(1) {
750       retry:
751         lock_ObtainWrite(&buf_globalLock);
752         /* check to see if we lost the race */
753         if (scp) {
754             if (bp = buf_LockedFind(scp, offsetp)) {
755                 bp->refCount--;
756                 lock_ReleaseWrite(&buf_globalLock);
757                 return CM_BUF_EXISTS;
758             }
759         }
760
761         /* for debugging, assert free list isn't empty, although we
762          * really should try waiting for a running tranasction to finish
763          * instead of this; or better, we should have a transaction
764          * throttler prevent us from entering this situation.
765          */
766         osi_assertx(buf_freeListEndp != NULL, "buf_GetNewLocked: no free buffers");
767
768         /* look at all buffers in free list, some of which may temp.
769          * have high refcounts and which then should be skipped,
770          * starting cleaning I/O for those which are dirty.  If we find
771          * a clean buffer, we rehash it, lock it and return it.
772          */
773         for(bp = buf_freeListEndp; bp; bp=(cm_buf_t *) osi_QPrev(&bp->q)) {
774             /* check to see if it really has zero ref count.  This
775              * code can bump refcounts, at least, so it may not be
776              * zero.
777              */
778             if (bp->refCount > 0) 
779                 continue;
780                         
781             /* we don't have to lock buffer itself, since the ref
782              * count is 0 and we know it will stay zero as long as
783              * we hold the global lock.
784              */
785
786             /* don't recycle someone in our own chunk */
787             if (!cm_FidCmp(&bp->fid, &scp->fid)
788                  && (bp->offset.LowPart & (-cm_chunkSize))
789                  == (offsetp->LowPart & (-cm_chunkSize)))
790                 continue;
791
792             /* if this page is being filled (!) or cleaned, see if
793              * the I/O has completed.  If not, skip it, otherwise
794              * do the final processing for the I/O.
795              */
796             if (bp->flags & (CM_BUF_READING | CM_BUF_WRITING)) {
797                 /* probably shouldn't do this much work while
798                  * holding the big lock?  Watch for contention
799                  * here.
800                  */
801                 continue;
802             }
803                         
804             if (bp->flags & CM_BUF_DIRTY) {
805                 /* if the buffer is dirty, start cleaning it and
806                  * move on to the next buffer.  We do this with
807                  * just the lock required to minimize contention
808                  * on the big lock.
809                  */
810                 bp->refCount++;
811                 lock_ReleaseWrite(&buf_globalLock);
812
813                 /* grab required lock and clean; this only
814                  * starts the I/O.  By the time we're back,
815                  * it'll still be marked dirty, but it will also
816                  * have the WRITING flag set, so we won't get
817                  * back here.
818                  */
819                 buf_CleanAsync(bp, &req);
820
821                 /* now put it back and go around again */
822                 buf_Release(bp);
823                 goto retry;
824             }
825
826             /* if we get here, we know that the buffer still has a 0
827              * ref count, and that it is clean and has no currently
828              * pending I/O.  This is the dude to return.
829              * Remember that as long as the ref count is 0, we know
830              * that we won't have any lock conflicts, so we can grab
831              * the buffer lock out of order in the locking hierarchy.
832              */
833             buf_Recycle(bp);
834
835             /* clean up junk flags */
836             bp->flags &= ~(CM_BUF_EOF | CM_BUF_ERROR);
837             bp->dataVersion = -1;       /* unknown so far */
838
839             /* now hash in as our new buffer, and give it the
840              * appropriate label, if requested.
841              */
842             if (scp) {
843                 bp->flags |= CM_BUF_INHASH;
844                 bp->fid = scp->fid;
845                 bp->offset = *offsetp;
846                 i = BUF_HASH(&scp->fid, offsetp);
847                 bp->hashp = buf_hashTablepp[i];
848                 buf_hashTablepp[i] = bp;
849                 i = BUF_FILEHASH(&scp->fid);
850                 nextBp = buf_fileHashTablepp[i];
851                 bp->fileHashp = nextBp;
852                 bp->fileHashBackp = NULL;
853                 if (nextBp)
854                     nextBp->fileHashBackp = bp;
855                 buf_fileHashTablepp[i] = bp;
856             }
857
858             /* prepare to return it.  Start by giving it a good
859              * refcount */
860             bp->refCount = 1;
861                         
862             /* and since it has a non-zero ref count, we should move
863              * it from the lru queue.  It better be still there,
864              * since we've held the global (big) lock since we found
865              * it there.
866              */
867             osi_assertx(bp->flags & CM_BUF_INLRU,
868                          "buf_GetNewLocked: LRU screwup");
869             if (buf_freeListEndp == bp) {
870                 /* we're the last guy in this queue, so maintain it */
871                 buf_freeListEndp = (cm_buf_t *) osi_QPrev(&bp->q);
872             }
873             osi_QRemove((osi_queue_t **) &buf_freeListp, &bp->q);
874             bp->flags &= ~CM_BUF_INLRU;
875
876             /* finally, grab the mutex so that people don't use it
877              * before the caller fills it with data.  Again, no one     
878              * should have been able to get to this dude to lock it.
879              */
880             osi_assertx(lock_TryMutex(&bp->mx),
881                          "buf_GetNewLocked: TryMutex failed");
882
883             lock_ReleaseWrite(&buf_globalLock);
884             *bufpp = bp;
885             return 0;
886         } /* for all buffers in lru queue */
887         lock_ReleaseWrite(&buf_globalLock);
888     }   /* while loop over everything */
889     /* not reached */
890 } /* the proc */
891
892 /* get a page, returning it held but unlocked.  Doesn't fill in the page
893  * with I/O, since we're going to write the whole thing new.
894  */
895 long buf_GetNew(struct cm_scache *scp, osi_hyper_t *offsetp, cm_buf_t **bufpp)
896 {
897     cm_buf_t *bp;
898     long code;
899     osi_hyper_t pageOffset;
900     int created;
901
902     created = 0;
903     pageOffset.HighPart = offsetp->HighPart;
904     pageOffset.LowPart = offsetp->LowPart & ~(buf_bufferSize-1);
905     while (1) {
906         lock_ObtainWrite(&buf_globalLock);
907         bp = buf_LockedFind(scp, &pageOffset);
908         lock_ReleaseWrite(&buf_globalLock);
909         if (bp) {
910             /* lock it and break out */
911             lock_ObtainMutex(&bp->mx);
912             break;
913         }
914
915         /* otherwise, we have to create a page */
916         code = buf_GetNewLocked(scp, &pageOffset, &bp);
917
918         /* check if the buffer was created in a race condition branch.
919          * If so, go around so we can hold a reference to it. 
920          */
921         if (code == CM_BUF_EXISTS) 
922             continue;
923
924         /* something else went wrong */
925         if (code != 0) 
926             return code;
927
928         /* otherwise, we have a locked buffer that we just created */
929         created = 1;
930         break;
931     } /* big while loop */
932
933     /* wait for reads */
934     if (bp->flags & CM_BUF_READING)
935         buf_WaitIO(bp);
936
937     /* once it has been read once, we can unlock it and return it, still
938      * with its refcount held.
939      */
940     lock_ReleaseMutex(&bp->mx);
941     *bufpp = bp;
942     osi_Log3(buf_logp, "buf_GetNew returning bp 0x%x for file 0x%x, offset 0x%x",
943               bp, (long) scp, offsetp->LowPart);
944     return 0;
945 }
946
947 /* get a page, returning it held but unlocked.  Make sure it is complete */
948 long buf_Get(struct cm_scache *scp, osi_hyper_t *offsetp, cm_buf_t **bufpp)
949 {
950     cm_buf_t *bp;
951     long code;
952     osi_hyper_t pageOffset;
953     unsigned long tcount;
954     int created;
955 #ifdef DISKCACHE95
956     cm_diskcache_t *dcp;
957 #endif /* DISKCACHE95 */
958
959     created = 0;
960     pageOffset.HighPart = offsetp->HighPart;
961     pageOffset.LowPart = offsetp->LowPart & ~(buf_bufferSize-1);
962     while (1) {
963         lock_ObtainWrite(&buf_globalLock);
964         bp = buf_LockedFind(scp, &pageOffset);
965         lock_ReleaseWrite(&buf_globalLock);
966         if (bp) {
967             /* lock it and break out */
968             lock_ObtainMutex(&bp->mx);
969             break;
970
971 #ifdef DISKCACHE95
972             /* touch disk chunk to update LRU info */
973             diskcache_Touch(bp->dcp);
974 #endif /* DISKCACHE95 */
975         }
976
977         /* otherwise, we have to create a page */
978         code = buf_GetNewLocked(scp, &pageOffset, &bp);
979
980         /* check if the buffer was created in a race condition branch.
981          * If so, go around so we can hold a reference to it. 
982          */
983         if (code == CM_BUF_EXISTS) 
984             continue;
985
986         /* something else went wrong */
987         if (code != 0) 
988             return code;
989                 
990         /* otherwise, we have a locked buffer that we just created */
991         created = 1;
992         break;
993     } /* big while loop */
994
995     /* if we get here, we have a locked buffer that may have just been
996      * created, in which case it needs to be filled with data.
997      */
998     if (created) {
999         /* load the page; freshly created pages should be idle */
1000         osi_assert(!(bp->flags & (CM_BUF_READING | CM_BUF_WRITING)));
1001
1002         /* setup offset, event */
1003 #ifndef DJGPP  /* doesn't seem to be used */
1004         bp->over.Offset = bp->offset.LowPart;
1005         bp->over.OffsetHigh = bp->offset.HighPart;
1006 #endif /* !DJGPP */
1007
1008         /* start the I/O; may drop lock */
1009         bp->flags |= CM_BUF_READING;
1010         code = (*cm_buf_opsp->Readp)(bp, buf_bufferSize, &tcount, NULL);
1011
1012 #ifdef DISKCACHE95
1013         code = diskcache_Get(&bp->fid, &bp->offset, bp->datap, buf_bufferSize, &bp->dataVersion, &tcount, &dcp);
1014         bp->dcp = dcp;    /* pointer to disk cache struct. */
1015 #endif /* DISKCACHE95 */
1016
1017         if (code != 0) {
1018             /* failure or queued */
1019 #ifndef DJGPP   /* cm_bufRead always returns 0 */
1020             if (code != ERROR_IO_PENDING) {
1021 #endif
1022                 bp->error = code;
1023                 bp->flags |= CM_BUF_ERROR;
1024                 bp->flags &= ~CM_BUF_READING;
1025                 if (bp->flags & CM_BUF_WAITING) {
1026                     bp->flags &= ~CM_BUF_WAITING;
1027                     osi_Wakeup((long) bp);
1028                 }
1029                 lock_ReleaseMutex(&bp->mx);
1030                 buf_Release(bp);
1031                 return code;
1032 #ifndef DJGPP
1033             }
1034 #endif
1035         } else {
1036             /* otherwise, I/O completed instantly and we're done, except
1037              * for padding the xfr out with 0s and checking for EOF
1038              */
1039             if (tcount < (unsigned long) buf_bufferSize) {
1040                 memset(bp->datap+tcount, 0, buf_bufferSize - tcount);
1041                 if (tcount == 0)
1042                     bp->flags |= CM_BUF_EOF;
1043             }
1044             bp->flags &= ~CM_BUF_READING;
1045             if (bp->flags & CM_BUF_WAITING) {
1046                 bp->flags &= ~CM_BUF_WAITING;
1047                 osi_Wakeup((long) bp);
1048             }
1049         }
1050
1051     } /* if created */
1052
1053     /* wait for reads, either that which we started above, or that someone
1054      * else started.  We don't care if we return a buffer being cleaned.
1055      */
1056     if (bp->flags & CM_BUF_READING)
1057         buf_WaitIO(bp);
1058
1059     /* once it has been read once, we can unlock it and return it, still
1060      * with its refcount held.
1061      */
1062     lock_ReleaseMutex(&bp->mx);
1063     *bufpp = bp;
1064
1065     /* now remove from queue; will be put in at the head (farthest from
1066      * being recycled) when we're done in buf_Release.
1067      */
1068     lock_ObtainWrite(&buf_globalLock);
1069     if (bp->flags & CM_BUF_INLRU) {
1070         if (buf_freeListEndp == bp)
1071             buf_freeListEndp = (cm_buf_t *) osi_QPrev(&bp->q);
1072         osi_QRemove((osi_queue_t **) &buf_freeListp, &bp->q);
1073         bp->flags &= ~CM_BUF_INLRU;
1074     }
1075     lock_ReleaseWrite(&buf_globalLock);
1076
1077     osi_Log3(buf_logp, "buf_Get returning bp 0x%x for file 0x%x, offset 0x%x",
1078               bp, (long) scp, offsetp->LowPart);
1079     return 0;
1080 }
1081
1082 /* count # of elements in the free list;
1083  * we don't bother doing the proper locking for accessing dataVersion or flags
1084  * since it is a pain, and this is really just an advisory call.  If you need
1085  * to do better at some point, rewrite this function.
1086  */
1087 long buf_CountFreeList(void)
1088 {
1089     long count;
1090     cm_buf_t *bufp;
1091
1092     count = 0;
1093     lock_ObtainRead(&buf_globalLock);
1094     for(bufp = buf_freeListp; bufp; bufp = (cm_buf_t *) osi_QNext(&bufp->q)) {
1095         /* if the buffer doesn't have an identity, or if the buffer
1096          * has been invalidate (by having its DV stomped upon), then
1097          * count it as free, since it isn't really being utilized.
1098          */
1099         if (!(bufp->flags & CM_BUF_INHASH) || bufp->dataVersion <= 0)
1100             count++;
1101     }       
1102     lock_ReleaseRead(&buf_globalLock);
1103     return count;
1104 }
1105
1106 /* clean a buffer synchronously */
1107 void buf_CleanAsync(cm_buf_t *bp, cm_req_t *reqp)
1108 {
1109     lock_ObtainMutex(&bp->mx);
1110     buf_LockedCleanAsync(bp, reqp);
1111     lock_ReleaseMutex(&bp->mx);
1112 }       
1113
1114 /* wait for a buffer's cleaning to finish */
1115 void buf_CleanWait(cm_buf_t *bp)
1116 {
1117     lock_ObtainMutex(&bp->mx);
1118     if (bp->flags & CM_BUF_WRITING) {
1119         buf_WaitIO(bp);
1120     }
1121     lock_ReleaseMutex(&bp->mx);
1122 }       
1123
1124 /* set the dirty flag on a buffer, and set associated write-ahead log,
1125  * if there is one.  Allow one to be added to a buffer, but not changed.
1126  *
1127  * The buffer must be locked before calling this routine.
1128  */
1129 void buf_SetDirty(cm_buf_t *bp)
1130 {
1131     osi_assert(bp->refCount > 0);
1132         
1133     osi_Log1(buf_logp, "buf_SetDirty 0x%x", bp);
1134
1135     /* set dirty bit */
1136     bp->flags |= CM_BUF_DIRTY;
1137
1138     /* and turn off EOF flag, since it has associated data now */
1139     bp->flags &= ~CM_BUF_EOF;
1140 }
1141
1142 /* clean all buffers, reset log pointers and invalidate all buffers.
1143  * Called with no locks held, and returns with same.
1144  *
1145  * This function is guaranteed to clean and remove the log ptr of all the
1146  * buffers that were dirty or had non-zero log ptrs before the call was
1147  * made.  That's sufficient to clean up any garbage left around by recovery,
1148  * which is all we're counting on this for; there may be newly created buffers
1149  * added while we're running, but that should be OK.
1150  *
1151  * In an environment where there are no transactions (artificially imposed, for
1152  * example, when switching the database to raw mode), this function is used to
1153  * make sure that all updates have been written to the disk.  In that case, we don't
1154  * really require that we forget the log association between pages and logs, but
1155  * it also doesn't hurt.  Since raw mode I/O goes through this buffer package, we don't
1156  * have to worry about invalidating data in the buffers.
1157  *
1158  * This function is used at the end of recovery as paranoia to get the recovered
1159  * database out to disk.  It removes all references to the recovery log and cleans
1160  * all buffers.
1161  */
1162 long buf_CleanAndReset(void)
1163 {
1164     long i;
1165     cm_buf_t *bp;
1166     cm_req_t req;
1167
1168     lock_ObtainWrite(&buf_globalLock);
1169     for(i=0; i<buf_hashSize; i++) {
1170         for(bp = buf_hashTablepp[i]; bp; bp = bp->hashp) {
1171             bp->refCount++;
1172             lock_ReleaseWrite(&buf_globalLock);
1173
1174             /* now no locks are held; clean buffer and go on */
1175             cm_InitReq(&req);
1176             buf_CleanAsync(bp, &req);
1177             buf_CleanWait(bp);
1178
1179             /* relock and release buffer */
1180             lock_ObtainWrite(&buf_globalLock);
1181             buf_LockedRelease(bp);
1182         } /* over one bucket */
1183     }   /* for loop over all hash buckets */
1184
1185     /* release locks */
1186     lock_ReleaseWrite(&buf_globalLock);
1187
1188     /* and we're done */
1189     return 0;
1190 }       
1191
1192 /* called without global lock being held, reserves buffers for callers
1193  * that need more than one held (not locked) at once.
1194  */
1195 void buf_ReserveBuffers(long nbuffers)
1196 {
1197     lock_ObtainWrite(&buf_globalLock);
1198     while (1) {
1199         if (buf_reservedBufs + nbuffers > buf_maxReservedBufs) {
1200             buf_reserveWaiting = 1;
1201             osi_Log1(buf_logp, "buf_ReserveBuffers waiting for %d bufs", nbuffers);
1202             osi_SleepW((long) &buf_reservedBufs, &buf_globalLock);
1203             lock_ObtainWrite(&buf_globalLock);
1204         }
1205         else {
1206             buf_reservedBufs += nbuffers;
1207             break;
1208         }
1209     }
1210     lock_ReleaseWrite(&buf_globalLock);
1211 }
1212
1213 int buf_TryReserveBuffers(long nbuffers)
1214 {
1215     int code;
1216
1217     lock_ObtainWrite(&buf_globalLock);
1218     if (buf_reservedBufs + nbuffers > buf_maxReservedBufs) {
1219         code = 0;
1220     }
1221     else {
1222         buf_reservedBufs += nbuffers;
1223         code = 1;
1224     }
1225     lock_ReleaseWrite(&buf_globalLock);
1226     return code;
1227 }       
1228
1229 /* called without global lock held, releases reservation held by
1230  * buf_ReserveBuffers.
1231  */
1232 void buf_UnreserveBuffers(long nbuffers)
1233 {
1234     lock_ObtainWrite(&buf_globalLock);
1235     buf_reservedBufs -= nbuffers;
1236     if (buf_reserveWaiting) {
1237         buf_reserveWaiting = 0;
1238         osi_Wakeup((long) &buf_reservedBufs);
1239     }
1240     lock_ReleaseWrite(&buf_globalLock);
1241 }       
1242
1243 /* truncate the buffers past sizep, zeroing out the page, if we don't
1244  * end on a page boundary.
1245  *
1246  * Requires cm_bufCreateLock to be write locked.
1247  */
1248 long buf_Truncate(cm_scache_t *scp, cm_user_t *userp, cm_req_t *reqp,
1249                    osi_hyper_t *sizep)
1250 {
1251     cm_buf_t *bufp;
1252     cm_buf_t *nbufp;                    /* next buffer, if didRelease */
1253     osi_hyper_t bufEnd;
1254     long code;
1255     long bufferPos;
1256     int didRelease;
1257     long i;
1258
1259     /* assert that cm_bufCreateLock is held in write mode */
1260     lock_AssertWrite(&scp->bufCreateLock);
1261
1262     i = BUF_FILEHASH(&scp->fid);
1263
1264     lock_ObtainWrite(&buf_globalLock);
1265     bufp = buf_fileHashTablepp[i];
1266     if (bufp == NULL) {
1267         lock_ReleaseWrite(&buf_globalLock);
1268         return 0;
1269     }
1270
1271     bufp->refCount++;
1272     lock_ReleaseWrite(&buf_globalLock);
1273     for(; bufp; bufp = nbufp) {
1274         didRelease = 0;
1275         lock_ObtainMutex(&bufp->mx);
1276
1277         bufEnd.HighPart = 0;
1278         bufEnd.LowPart = buf_bufferSize;
1279         bufEnd = LargeIntegerAdd(bufEnd, bufp->offset);
1280
1281         if (cm_FidCmp(&bufp->fid, &scp->fid) == 0 &&
1282              LargeIntegerLessThan(*sizep, bufEnd)) {
1283             buf_WaitIO(bufp);
1284         }
1285         lock_ObtainMutex(&scp->mx);
1286         
1287         /* make sure we have a callback (so we have the right value for
1288          * the length), and wait for it to be safe to do a truncate.
1289          */
1290         code = cm_SyncOp(scp, bufp, userp, reqp, 0,
1291                           CM_SCACHESYNC_NEEDCALLBACK
1292                           | CM_SCACHESYNC_GETSTATUS
1293                           | CM_SCACHESYNC_SETSIZE
1294                           | CM_SCACHESYNC_BUFLOCKED);
1295         /* if we succeeded in our locking, and this applies to the right
1296          * file, and the truncate request overlaps the buffer either
1297          * totally or partially, then do something.
1298          */
1299         if (code == 0 && cm_FidCmp(&bufp->fid, &scp->fid) == 0
1300              && LargeIntegerLessThan(*sizep, bufEnd)) {
1301
1302             lock_ObtainWrite(&buf_globalLock);
1303
1304             /* destroy the buffer, turning off its dirty bit, if
1305              * we're truncating the whole buffer.  Otherwise, set
1306              * the dirty bit, and clear out the tail of the buffer
1307              * if we just overlap some.
1308              */
1309             if (LargeIntegerLessThanOrEqualTo(*sizep, bufp->offset)) {
1310                 /* truncating the entire page */
1311                 bufp->flags &= ~CM_BUF_DIRTY;
1312                 bufp->dataVersion = -1; /* known bad */
1313                 bufp->dirtyCounter++;
1314             }
1315             else {
1316                 /* don't set dirty, since dirty implies
1317                  * currently up-to-date.  Don't need to do this,
1318                  * since we'll update the length anyway.
1319                  *
1320                  * Zero out remainder of the page, in case we
1321                  * seek and write past EOF, and make this data
1322                  * visible again.
1323                  */
1324                 bufferPos = sizep->LowPart & (buf_bufferSize - 1);
1325                 osi_assert(bufferPos != 0);
1326                 memset(bufp->datap + bufferPos, 0,
1327                         buf_bufferSize - bufferPos);
1328             }
1329
1330             lock_ReleaseWrite(&buf_globalLock);
1331         }
1332                 
1333         lock_ReleaseMutex(&scp->mx);
1334         lock_ReleaseMutex(&bufp->mx);
1335         if (!didRelease) {
1336             lock_ObtainWrite(&buf_globalLock);
1337             nbufp = bufp->fileHashp;
1338             if (nbufp) nbufp->refCount++;
1339             buf_LockedRelease(bufp);
1340             lock_ReleaseWrite(&buf_globalLock);
1341         }
1342
1343         /* bail out early if we fail */
1344         if (code) {
1345             /* at this point, nbufp is held; bufp has already been
1346              * released.
1347              */
1348             if (nbufp) 
1349                 buf_Release(nbufp);
1350             return code;
1351         }
1352     }
1353
1354     /* success */
1355     return 0;
1356 }
1357
1358 long buf_FlushCleanPages(cm_scache_t *scp, cm_user_t *userp, cm_req_t *reqp)
1359 {
1360     long code;
1361     cm_buf_t *bp;               /* buffer we're hacking on */
1362     cm_buf_t *nbp;
1363     int didRelease;
1364     long i;
1365
1366     i = BUF_FILEHASH(&scp->fid);
1367
1368     code = 0;
1369     lock_ObtainWrite(&buf_globalLock);
1370     bp = buf_fileHashTablepp[i];
1371     if (bp) bp->refCount++;
1372     lock_ReleaseWrite(&buf_globalLock);
1373     for(; bp; bp = nbp) {
1374         didRelease = 0; /* haven't released this buffer yet */
1375
1376         /* clean buffer synchronously */
1377         if (cm_FidCmp(&bp->fid, &scp->fid) == 0) {
1378             lock_ObtainMutex(&bp->mx);
1379
1380             /* start cleaning the buffer, and wait for it to finish */
1381             buf_LockedCleanAsync(bp, reqp);
1382             buf_WaitIO(bp);
1383             lock_ReleaseMutex(&bp->mx);
1384
1385             code = (*cm_buf_opsp->Stabilizep)(scp, userp, reqp);
1386             if (code) goto skip;
1387
1388             lock_ObtainWrite(&buf_globalLock);
1389             /* actually, we only know that buffer is clean if ref
1390              * count is 1, since we don't have buffer itself locked.
1391              */
1392             if (!(bp->flags & CM_BUF_DIRTY)) {
1393                 if (bp->refCount == 1) {        /* bp is held above */
1394                     buf_LockedRelease(bp);
1395                     nbp = bp->fileHashp;
1396                     if (nbp) nbp->refCount++;
1397                     didRelease = 1;
1398                     buf_Recycle(bp);
1399                 }
1400             }
1401             lock_ReleaseWrite(&buf_globalLock);
1402
1403             (*cm_buf_opsp->Unstabilizep)(scp, userp);
1404         }
1405
1406       skip:
1407         if (!didRelease) {
1408             lock_ObtainWrite(&buf_globalLock);
1409             if (nbp = bp->fileHashp) nbp->refCount++;
1410             buf_LockedRelease(bp);
1411             lock_ReleaseWrite(&buf_globalLock);
1412         }
1413     }   /* for loop over a bunch of buffers */
1414
1415     /* done */
1416     return code;
1417 }       
1418
1419 long buf_CleanVnode(struct cm_scache *scp, cm_user_t *userp, cm_req_t *reqp)
1420 {
1421     long code;
1422     cm_buf_t *bp;               /* buffer we're hacking on */
1423     cm_buf_t *nbp;              /* next one */
1424     long i;
1425
1426     i = BUF_FILEHASH(&scp->fid);
1427
1428     code = 0;
1429     lock_ObtainWrite(&buf_globalLock);
1430     bp = buf_fileHashTablepp[i];
1431     if (bp) bp->refCount++;
1432     lock_ReleaseWrite(&buf_globalLock);
1433     for(; bp; bp = nbp) {
1434         /* clean buffer synchronously */
1435         if (cm_FidCmp(&bp->fid, &scp->fid) == 0) {
1436             if (userp) {
1437                 cm_HoldUser(userp);
1438                 lock_ObtainMutex(&bp->mx);
1439                 if (bp->userp) 
1440                     cm_ReleaseUser(bp->userp);
1441                 bp->userp = userp;
1442                 lock_ReleaseMutex(&bp->mx);
1443             }   
1444             buf_CleanAsync(bp, reqp);
1445             buf_CleanWait(bp);
1446             lock_ObtainMutex(&bp->mx);
1447             if (bp->flags & CM_BUF_ERROR) {
1448                 if (code == 0 || code == -1) 
1449                     code = bp->error;
1450                 if (code == 0) 
1451                     code = -1;
1452             }
1453             lock_ReleaseMutex(&bp->mx);
1454         }
1455
1456         lock_ObtainWrite(&buf_globalLock);
1457         buf_LockedRelease(bp);
1458         nbp = bp->fileHashp;
1459         if (nbp) nbp->refCount++;
1460         lock_ReleaseWrite(&buf_globalLock);
1461     }   /* for loop over a bunch of buffers */
1462
1463     /* done */
1464     return code;
1465 }
1466
1467 /* dump the contents of the buf_hashTablepp. */
1468 int cm_DumpBufHashTable(FILE *outputFile, char *cookie)
1469 {
1470     int zilch;
1471     cm_buf_t *bp;
1472     char output[1024];
1473     int i;
1474   
1475     if (buf_hashTablepp == NULL)
1476         return -1;
1477
1478     lock_ObtainRead(&buf_globalLock);
1479   
1480     StringCbPrintfA(output, sizeof(output), "%s - dumping buf_HashTable - buf_hashSize=%d\n", cookie, buf_hashSize);
1481     WriteFile(outputFile, output, strlen(output), &zilch, NULL);
1482   
1483     for (i = 0; i < buf_hashSize; i++)
1484     {
1485         for (bp = buf_hashTablepp[i]; bp; bp=bp->hashp) 
1486         {
1487             if (bp->refCount)
1488             {
1489                 StringCbPrintfA(output, sizeof(output), "vnode=%d, unique=%d), size=%d refCount=%d\n", 
1490                         cookie, (void *)bp, i, bp->fid.cell, bp->fid.volume, 
1491                         bp->fid.vnode, bp->fid.unique, bp->size, bp->refCount);
1492                 WriteFile(outputFile, output, strlen(output), &zilch, NULL);
1493             }
1494         }
1495     }
1496   
1497     StringCbPrintfA(output, sizeof(output), "%s - Done dumping buf_HashTable.\n", cookie);
1498     WriteFile(outputFile, output, strlen(output), &zilch, NULL);
1499
1500     lock_ReleaseRead(&buf_globalLock);
1501     return 0;
1502 }
1503
1504 void buf_ForceTrace(BOOL flush)
1505 {
1506     HANDLE handle;
1507     int len;
1508     char buf[256];
1509
1510     if (!buf_logp) 
1511         return;
1512
1513     len = GetTempPath(sizeof(buf)-10, buf);
1514     StringCbCopyA(&buf[len], sizeof(buf)-len, "/afs-buffer.log");
1515     handle = CreateFile(buf, GENERIC_WRITE, FILE_SHARE_READ,
1516                             NULL, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
1517     if (handle == INVALID_HANDLE_VALUE) {
1518         osi_panic("Cannot create log file", __FILE__, __LINE__);
1519     }
1520     osi_LogPrint(buf_logp, handle);
1521     if (flush)
1522         FlushFileBuffers(handle);
1523     CloseHandle(handle);
1524 }