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