Windows: buf_CleanLocked protect against NULL bp->userp
[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 <afsconfig.h>
13 #include <afs/param.h>
14 #include <roken.h>
15
16 #include <afs/stds.h>
17
18 #include <windows.h>
19 #include <osi.h>
20 #include <stdio.h>
21 #include <strsafe.h>
22 #include <math.h>
23 #include <hcrypto\md5.h>
24
25 #include "afsd.h"
26 #include "cm_memmap.h"
27
28 #ifdef DEBUG
29 #define TRACE_BUFFER 1
30 #endif
31
32 extern void afsi_log(char *pattern, ...);
33
34 /* This module implements the buffer package used by the local transaction
35  * system (cm).  It is initialized by calling cm_Init, which calls buf_Init;
36  * it must be initalized before any of its main routines are called.
37  *
38  * Each buffer is hashed into a hash table by file ID and offset, and if its
39  * reference count is zero, it is also in a free list.
40  *
41  * There are two locks involved in buffer processing.  The global lock
42  * buf_globalLock protects all of the global variables defined in this module,
43  * the reference counts and hash pointers in the actual cm_buf_t structures,
44  * and the LRU queue pointers in the buffer structures.
45  *
46  * The mutexes in the buffer structures protect the remaining fields in the
47  * buffers, as well the data itself.
48  *
49  * The locking hierarchy here is this:
50  *
51  * - resv multiple simul. buffers reservation
52  * - lock buffer I/O flags
53  * - lock buffer's mutex
54  * - lock buf_globalLock
55  *
56  */
57
58 /* global debugging log */
59 osi_log_t *buf_logp = NULL;
60
61 /* Global lock protecting hash tables and free lists */
62 osi_rwlock_t buf_globalLock;
63
64 /* Global lock used to limit the number of RDR Release
65  * Extents requests to one. */
66 osi_mutex_t buf_rdrReleaseExtentsLock;
67
68 /* ptr to head of the free list (most recently used) and the
69  * tail (the guy to remove first).  We use osi_Q* functions
70  * to put stuff in buf_freeListp, and maintain the end
71  * pointer manually
72  */
73
74 /* a pointer to a list of all buffers, just so that we can find them
75  * easily for debugging, and for the incr syncer.  Locked under
76  * the global lock.
77  */
78
79 /* defaults setup; these variables may be manually assigned into
80  * before calling cm_Init, as a way of changing these defaults.
81  */
82
83 /* callouts for reading and writing data, etc */
84 cm_buf_ops_t *cm_buf_opsp;
85
86 #ifdef DISKCACHE95
87 /* for experimental disk caching support in Win95 client */
88 cm_buf_t *buf_diskFreeListp;
89 cm_buf_t *buf_diskFreeListEndp;
90 cm_buf_t *buf_diskAllp;
91 extern int cm_diskCacheEnabled;
92 #endif /* DISKCACHE95 */
93
94 /* set this to 1 when we are terminating to prevent access attempts */
95 static int buf_ShutdownFlag = 0;
96
97 #ifdef DEBUG_REFCOUNT
98 void buf_HoldLockedDbg(cm_buf_t *bp, char *file, long line)
99 #else
100 void buf_HoldLocked(cm_buf_t *bp)
101 #endif
102 {
103     afs_int32 refCount;
104
105     osi_assertx(bp->magic == CM_BUF_MAGIC,"incorrect cm_buf_t magic");
106     refCount = InterlockedIncrement(&bp->refCount);
107 #ifdef DEBUG_REFCOUNT
108     osi_Log2(afsd_logp,"buf_HoldLocked bp 0x%p ref %d",bp, refCount);
109     afsi_log("%s:%d buf_HoldLocked bp 0x%p, ref %d", file, line, bp, refCount);
110 #endif
111 }
112
113 /* hold a reference to an already held buffer */
114 #ifdef DEBUG_REFCOUNT
115 void buf_HoldDbg(cm_buf_t *bp, char *file, long line)
116 #else
117 void buf_Hold(cm_buf_t *bp)
118 #endif
119 {
120     afs_int32 refCount;
121
122     lock_ObtainRead(&buf_globalLock);
123     osi_assertx(bp->magic == CM_BUF_MAGIC,"incorrect cm_buf_t magic");
124     refCount = InterlockedIncrement(&bp->refCount);
125 #ifdef DEBUG_REFCOUNT
126     osi_Log2(afsd_logp,"buf_Hold bp 0x%p ref %d",bp, refCount);
127     afsi_log("%s:%d buf_Hold bp 0x%p, ref %d", file, line, bp, refCount);
128 #endif
129     lock_ReleaseRead(&buf_globalLock);
130 }
131
132 /* code to drop reference count while holding buf_globalLock */
133 #ifdef DEBUG_REFCOUNT
134 void buf_ReleaseLockedDbg(cm_buf_t *bp, afs_uint32 writeLocked, char *file, long line)
135 #else
136 void buf_ReleaseLocked(cm_buf_t *bp, afs_uint32 writeLocked)
137 #endif
138 {
139     afs_int32 refCount;
140
141     if (writeLocked)
142         lock_AssertWrite(&buf_globalLock);
143     else
144         lock_AssertRead(&buf_globalLock);
145
146     /* ensure that we're in the LRU queue if our ref count is 0 */
147     osi_assertx(bp->magic == CM_BUF_MAGIC,"incorrect cm_buf_t magic");
148
149     refCount = InterlockedDecrement(&bp->refCount);
150 #ifdef DEBUG_REFCOUNT
151     osi_Log3(afsd_logp,"buf_ReleaseLocked %s bp 0x%p ref %d",writeLocked?"write":"read", bp, refCount);
152     afsi_log("%s:%d buf_ReleaseLocked %s bp 0x%p, ref %d", file, line, writeLocked?"write":"read", bp, refCount);
153 #endif
154 #ifdef DEBUG
155     if (refCount < 0)
156         osi_panic("buf refcount 0",__FILE__,__LINE__);;
157 #else
158     osi_assertx(refCount >= 0, "cm_buf_t refCount == 0");
159 #endif
160     if (refCount == 0) {
161         /*
162          * If we are read locked there could be a race condition
163          * with buf_Find() so we must obtain a write lock and
164          * double check that the refCount is actually zero
165          * before we remove the buffer from the LRU queue.
166          */
167         if (!writeLocked)
168             lock_ConvertRToW(&buf_globalLock);
169
170         if (bp->refCount == 0 &&
171             !(bp->qFlags & (CM_BUF_QINLRU|CM_BUF_QREDIR))) {
172             osi_QAddH( (osi_queue_t **) &cm_data.buf_freeListp,
173                        (osi_queue_t **) &cm_data.buf_freeListEndp,
174                        &bp->q);
175             _InterlockedOr(&bp->qFlags, CM_BUF_QINLRU);
176             buf_IncrementFreeCount();
177         }
178
179         if (!writeLocked)
180             lock_ConvertWToR(&buf_globalLock);
181     }
182 }
183
184 /* release a buffer.  Buffer must be referenced, but unlocked. */
185 #ifdef DEBUG_REFCOUNT
186 void buf_ReleaseDbg(cm_buf_t *bp, char *file, long line)
187 #else
188 void buf_Release(cm_buf_t *bp)
189 #endif
190 {
191     lock_ObtainRead(&buf_globalLock);
192     buf_ReleaseLocked(bp, FALSE);
193     lock_ReleaseRead(&buf_globalLock);
194 }
195
196 long
197 buf_Sync(int quitOnShutdown)
198 {
199     cm_buf_t **bpp, *bp, *prevbp;
200     afs_uint32 wasDirty = 0;
201     cm_req_t req;
202
203     /* go through all of the dirty buffers */
204     lock_ObtainRead(&buf_globalLock);
205     for (bpp = &cm_data.buf_dirtyListp, prevbp = NULL; bp = *bpp; ) {
206         if (quitOnShutdown && buf_ShutdownFlag)
207             break;
208
209         /*
210          * If the buffer is held be the redirector we must fetch
211          * it back in order to determine whether or not it is in
212          * fact dirty.
213          */
214         if (bp->qFlags & CM_BUF_QREDIR) {
215             osi_Log1(buf_logp,"buf_Sync buffer held by redirector bp 0x%p", bp);
216
217             /* Request single buffer from the redirector */
218             buf_RDRShakeAnExtentFree(bp, &req);
219         }
220
221         lock_ReleaseRead(&buf_globalLock);
222         /*
223          * all dirty buffers are held when they are added to the
224          * dirty list.  No need for an additional hold.
225          */
226         lock_ObtainMutex(&bp->mx);
227
228         if ((bp->flags & CM_BUF_DIRTY)) {
229             /* start cleaning the buffer; don't touch log pages since
230              * the log code counts on knowing exactly who is writing
231              * a log page at any given instant.
232              *
233              * only attempt to write the buffer if the volume might
234              * be online.
235              */
236             afs_uint32 dirty;
237             cm_volume_t * volp;
238
239             volp = cm_GetVolumeByFID(&bp->fid);
240             switch (cm_GetVolumeStatus(volp, bp->fid.volume)) {
241             case vl_online:
242             case vl_unknown:
243                 cm_InitReq(&req);
244                 req.flags |= CM_REQ_NORETRY;
245                 buf_CleanLocked(NULL, bp, &req, 0, &dirty);
246                 wasDirty |= dirty;
247             }
248             cm_PutVolume(volp);
249         }
250
251         /* the buffer may or may not have been dirty
252         * and if dirty may or may not have been cleaned
253         * successfully.  check the dirty flag again.
254         */
255         if (!(bp->flags & CM_BUF_DIRTY)) {
256             /* remove the buffer from the dirty list */
257             lock_ObtainWrite(&buf_globalLock);
258 #ifdef DEBUG_REFCOUNT
259             if (bp->dirtyp == NULL && bp != cm_data.buf_dirtyListEndp) {
260                 osi_Log1(afsd_logp,"buf_Sync bp 0x%p list corruption",bp);
261                 afsi_log("buf_Sync bp 0x%p list corruption", bp);
262             }
263 #endif
264             *bpp = bp->dirtyp;
265             bp->dirtyp = NULL;
266             _InterlockedAnd(&bp->qFlags, ~CM_BUF_QINDL);
267             if (cm_data.buf_dirtyListp == NULL)
268                 cm_data.buf_dirtyListEndp = NULL;
269             else if (cm_data.buf_dirtyListEndp == bp)
270                 cm_data.buf_dirtyListEndp = prevbp;
271             buf_ReleaseLocked(bp, TRUE);
272             lock_ConvertWToR(&buf_globalLock);
273         } else {
274             if (buf_ShutdownFlag) {
275                 cm_cell_t *cellp;
276                 cm_volume_t *volp;
277                 char volstr[VL_MAXNAMELEN+12]="";
278                 char *ext = "";
279
280                 volp = cm_GetVolumeByFID(&bp->fid);
281                 if (volp) {
282                     cellp = volp->cellp;
283                     if (bp->fid.volume == volp->vol[RWVOL].ID)
284                         ext = "";
285                     else if (bp->fid.volume == volp->vol[ROVOL].ID)
286                         ext = ".readonly";
287                     else if (bp->fid.volume == volp->vol[BACKVOL].ID)
288                         ext = ".backup";
289                     else
290                         ext = ".nomatch";
291                     snprintf(volstr, sizeof(volstr), "%s%s", volp->namep, ext);
292                 } else {
293                     cellp = cm_FindCellByID(bp->fid.cell, CM_FLAG_NOPROBE);
294                     snprintf(volstr, sizeof(volstr), "%u", bp->fid.volume);
295                 }
296
297                 LogEvent(EVENTLOG_INFORMATION_TYPE, MSG_DIRTY_BUFFER_AT_SHUTDOWN,
298                          cellp->name, volstr, bp->fid.vnode, bp->fid.unique,
299                          bp->offset.QuadPart+bp->dirty_offset, bp->dirty_length);
300             }
301
302             /* advance the pointer so we don't loop forever */
303             lock_ObtainRead(&buf_globalLock);
304             bpp = &bp->dirtyp;
305             prevbp = bp;
306         }
307         lock_ReleaseMutex(&bp->mx);
308     }   /* for loop over a bunch of buffers */
309     lock_ReleaseRead(&buf_globalLock);
310
311     return wasDirty;
312 }
313
314 /* incremental sync daemon.  Writes all dirty buffers every 5000 ms */
315 static void *
316 buf_IncrSyncer(void * parm)
317 {
318     long wasDirty = 0;
319     long i;
320
321     while (buf_ShutdownFlag == 0) {
322         if (!wasDirty) {
323             i = SleepEx(5000, 1);
324             if (i != 0)
325                 continue;
326         } else {
327             Sleep(50);
328         }
329
330         wasDirty = buf_Sync(1);
331     } /* whole daemon's while loop */
332
333     pthread_exit(NULL);
334     return NULL;
335 }
336
337 long
338 buf_ValidateBuffers(void)
339 {
340     cm_buf_t * bp, *bpf, *bpa, *bpb;
341     afs_uint64 countb = 0, countf = 0, counta = 0, countr = 0;
342
343     if (cm_data.buf_freeListp == NULL && cm_data.buf_freeListEndp != NULL ||
344          cm_data.buf_freeListp != NULL && cm_data.buf_freeListEndp == NULL) {
345         afsi_log("cm_ValidateBuffers failure: inconsistent free list pointers");
346         fprintf(stderr, "cm_ValidateBuffers failure: inconsistent free list pointers\n");
347         return -9;
348     }
349
350     for (bp = cm_data.buf_freeListEndp; bp; bp=(cm_buf_t *) osi_QPrev(&bp->q)) {
351         if (bp->magic != CM_BUF_MAGIC) {
352             afsi_log("cm_ValidateBuffers failure: bp->magic != CM_BUF_MAGIC");
353             fprintf(stderr, "cm_ValidateBuffers failure: bp->magic != CM_BUF_MAGIC\n");
354             return -1;
355         }
356         countb++;
357         bpb = bp;
358
359         if (countb > cm_data.buf_nbuffers) {
360             afsi_log("cm_ValidateBuffers failure: countb > cm_data.buf_nbuffers");
361             fprintf(stderr, "cm_ValidateBuffers failure: countb > cm_data.buf_nbuffers\n");
362             return -6;
363         }
364     }
365
366     for (bp = cm_data.buf_freeListp; bp; bp=(cm_buf_t *) osi_QNext(&bp->q)) {
367         if (bp->magic != CM_BUF_MAGIC) {
368             afsi_log("cm_ValidateBuffers failure: bp->magic != CM_BUF_MAGIC");
369             fprintf(stderr, "cm_ValidateBuffers failure: bp->magic != CM_BUF_MAGIC\n");
370             return -2;
371         }
372         countf++;
373         bpf = bp;
374
375         if (countf > cm_data.buf_nbuffers) {
376             afsi_log("cm_ValidateBuffers failure: countf > cm_data.buf_nbuffers");
377             fprintf(stderr, "cm_ValidateBuffers failure: countf > cm_data.buf_nbuffers\n");
378             return -7;
379         }
380     }
381
382     for ( bp = cm_data.buf_redirListp; bp; bp = (cm_buf_t *) osi_QNext(&bp->q)) {
383         if (!(bp->qFlags & CM_BUF_QREDIR)) {
384             afsi_log("CM_BUF_QREDIR not set on cm_buf_t in buf_redirListp");
385             fprintf(stderr, "CM_BUF_QREDIR not set on cm_buf_t in buf_redirListp");
386             return -9;
387         }
388         countr++;
389         if (countr > cm_data.buf_nbuffers) {
390             afsi_log("cm_ValidateBuffers failure: countr > cm_data.buf_nbuffers");
391             fprintf(stderr, "cm_ValidateBuffers failure: countr > cm_data.buf_nbuffers\n");
392             return -10;
393         }
394     }
395
396     for (bp = cm_data.buf_allp; bp; bp=bp->allp) {
397         if (bp->magic != CM_BUF_MAGIC) {
398             afsi_log("cm_ValidateBuffers failure: bp->magic != CM_BUF_MAGIC");
399             fprintf(stderr, "cm_ValidateBuffers failure: bp->magic != CM_BUF_MAGIC\n");
400             return -3;
401         }
402         counta++;
403         bpa = bp;
404
405         if (counta > cm_data.buf_nbuffers) {
406             afsi_log("cm_ValidateBuffers failure: counta > cm_data.buf_nbuffers");
407             fprintf(stderr, "cm_ValidateBuffers failure: counta > cm_data.buf_nbuffers\n");
408             return -8;
409         }
410     }
411
412     if (countb != countf) {
413         afsi_log("cm_ValidateBuffers failure: countb != countf");
414         fprintf(stderr, "cm_ValidateBuffers failure: countb != countf\n");
415         return -4;
416     }
417
418     if (counta != cm_data.buf_nbuffers) {
419         afsi_log("cm_ValidateBuffers failure: counta != cm_data.buf_nbuffers");
420         fprintf(stderr, "cm_ValidateBuffers failure: counta != cm_data.buf_nbuffers\n");
421         return -5;
422     }
423
424     return 0;
425 }
426
427 void buf_Shutdown(void)
428 {
429     /* disable the buf_IncrSyncer() threads */
430     buf_ShutdownFlag = 1;
431
432     /* then force all dirty buffers to the file servers */
433     buf_Sync(0);
434 }
435
436 /* initialize the buffer package; called with no locks
437  * held during the initialization phase.
438  */
439 long buf_Init(int newFile, cm_buf_ops_t *opsp, afs_uint64 nbuffers)
440 {
441     static osi_once_t once;
442     cm_buf_t *bp;
443     pthread_t phandle;
444     pthread_attr_t tattr;
445     int pstatus;
446     long i;
447     char *data;
448
449     if ( newFile ) {
450         if (nbuffers)
451             cm_data.buf_nbuffers = nbuffers;
452
453         /* Have to be able to reserve a whole chunk */
454         if (((cm_data.buf_nbuffers - 3) * cm_data.buf_blockSize) < cm_chunkSize)
455             return CM_ERROR_TOOFEWBUFS;
456     }
457
458     /* recall for callouts */
459     cm_buf_opsp = opsp;
460
461     if (osi_Once(&once)) {
462         /* initialize global locks */
463         lock_InitializeRWLock(&buf_globalLock, "Global buffer lock", LOCK_HIERARCHY_BUF_GLOBAL);
464         lock_InitializeMutex(&buf_rdrReleaseExtentsLock, "RDR Release Extents lock", LOCK_HIERARCHY_RDR_EXTENTS);
465
466         if ( newFile ) {
467             /* remember this for those who want to reset it */
468             cm_data.buf_nOrigBuffers = cm_data.buf_nbuffers;
469
470             /* lower hash size to a prime number */
471             cm_data.buf_hashSize = cm_NextHighestPowerOf2((afs_uint32)(cm_data.buf_nbuffers/7));
472
473             /* create hash table */
474             memset((void *)cm_data.buf_scacheHashTablepp, 0, cm_data.buf_hashSize * sizeof(cm_buf_t *));
475
476             /* another hash table */
477             memset((void *)cm_data.buf_fileHashTablepp, 0, cm_data.buf_hashSize * sizeof(cm_buf_t *));
478
479             /* create buffer headers and put in free list */
480             bp = cm_data.bufHeaderBaseAddress;
481             data = cm_data.bufDataBaseAddress;
482             cm_data.buf_allp = NULL;
483
484             for (i=0; i<cm_data.buf_nbuffers; i++) {
485                 osi_assertx(bp >= cm_data.bufHeaderBaseAddress && bp < (cm_buf_t *)cm_data.bufDataBaseAddress,
486                             "invalid cm_buf_t address");
487                 osi_assertx(data >= cm_data.bufDataBaseAddress && data < cm_data.bufEndOfData,
488                             "invalid cm_buf_t data address");
489
490                 /* allocate and zero some storage */
491                 memset(bp, 0, sizeof(cm_buf_t));
492                 bp->magic = CM_BUF_MAGIC;
493                 /* thread on list of all buffers */
494                 bp->allp = cm_data.buf_allp;
495                 cm_data.buf_allp = bp;
496
497                 osi_QAddH( (osi_queue_t **) &cm_data.buf_freeListp,
498                            (osi_queue_t **) &cm_data.buf_freeListEndp,
499                            &bp->q);
500                 _InterlockedOr(&bp->qFlags, CM_BUF_QINLRU);
501                 buf_IncrementFreeCount();
502                 lock_InitializeMutex(&bp->mx, "Buffer mutex", LOCK_HIERARCHY_BUFFER);
503
504                 /* grab appropriate number of bytes from aligned zone */
505                 bp->datap = data;
506
507                 /* next */
508                 bp++;
509                 data += cm_data.buf_blockSize;
510             }
511
512             /* none reserved at first */
513             cm_data.buf_reservedBufs = 0;
514
515             /* just for safety's sake */
516             cm_data.buf_maxReservedBufs = cm_data.buf_nbuffers - 3;
517         } else {
518             bp = cm_data.bufHeaderBaseAddress;
519             data = cm_data.bufDataBaseAddress;
520
521             lock_ObtainWrite(&buf_globalLock);
522             for (i=0; i<cm_data.buf_nbuffers; i++) {
523                 lock_InitializeMutex(&bp->mx, "Buffer mutex", LOCK_HIERARCHY_BUFFER);
524                 bp->userp = NULL;
525                 bp->waitCount = 0;
526                 bp->waitRequests = 0;
527                 _InterlockedAnd(&bp->flags, ~CM_BUF_WAITING);
528                 bp->error = 0;
529                 if (bp->qFlags & CM_BUF_QREDIR) {
530                     /*
531                      * extent was not returned by the file system driver.
532                      * clean up the mess.
533                      */
534                     buf_RemoveFromRedirQueue(NULL, bp);
535                     bp->dataVersion = CM_BUF_VERSION_BAD;
536                     bp->redirq.nextp = bp->redirq.prevp = NULL;
537                     bp->redirLastAccess = 0;
538                     bp->redirReleaseRequested = 0;
539                     buf_ReleaseLocked(bp, TRUE);
540                 }
541                 bp++;
542             }
543
544             /*
545              * There should be nothing left in cm_data.buf_redirListp
546              * but double check just to be sure.
547              */
548             for ( bp = cm_data.buf_redirListp;
549                   bp;
550                   bp = cm_data.buf_redirListp)
551             {
552                 /*
553                  * extent was not returned by the file system driver.
554                  * clean up the mess.
555                  */
556                 buf_RemoveFromRedirQueue(NULL, bp);
557                 bp->dataVersion = CM_BUF_VERSION_BAD;
558                 bp->redirq.nextp = bp->redirq.prevp = NULL;
559                 bp->redirLastAccess = 0;
560                 bp->redirReleaseRequested = 0;
561                 buf_ReleaseLocked(bp, TRUE);
562             }
563             lock_ReleaseWrite(&buf_globalLock);
564         }
565
566 #ifdef TESTING
567         buf_ValidateBufQueues();
568 #endif /* TESTING */
569
570 #ifdef TRACE_BUFFER
571         /* init the buffer trace log */
572         buf_logp = osi_LogCreate("buffer", 1000);
573         osi_LogEnable(buf_logp);
574 #endif
575
576         osi_EndOnce(&once);
577
578         /* and create the incr-syncer */
579         pthread_attr_init(&tattr);
580         pthread_attr_setdetachstate(&tattr, PTHREAD_CREATE_DETACHED);
581
582         pstatus = pthread_create(&phandle, &tattr, buf_IncrSyncer, 0);
583         osi_assertx(pstatus == 0, "buf: can't create incremental sync proc");
584
585         pthread_attr_destroy(&tattr);
586     }
587
588 #ifdef TESTING
589     buf_ValidateBufQueues();
590 #endif /* TESTING */
591     return 0;
592 }
593
594 /* add nbuffers to the buffer pool, if possible.
595  * Called with no locks held.
596  */
597 long buf_AddBuffers(afs_uint64 nbuffers)
598 {
599     /* The size of a virtual cache cannot be changed after it has
600      * been created.  Subsequent calls to MapViewofFile() with
601      * an existing mapping object name would not allow the
602      * object to be resized.  Return failure immediately.
603      *
604      * A similar problem now occurs with the persistent cache
605      * given that the memory mapped file now contains a complex
606      * data structure.
607      */
608     afsi_log("request to add %d buffers to the existing cache of size %d denied",
609               nbuffers, cm_data.buf_nbuffers);
610
611     return CM_ERROR_INVAL;
612 }
613
614 /* interface to set the number of buffers to an exact figure.
615  * Called with no locks held.
616  */
617 long buf_SetNBuffers(afs_uint64 nbuffers)
618 {
619     if (nbuffers < 10)
620         return CM_ERROR_INVAL;
621     if (nbuffers == cm_data.buf_nbuffers)
622         return 0;
623     else if (nbuffers > cm_data.buf_nbuffers)
624         return buf_AddBuffers(nbuffers - cm_data.buf_nbuffers);
625     else
626         return CM_ERROR_INVAL;
627 }
628
629 /* wait for reading or writing to clear; called with write-locked
630  * buffer and unlocked scp and returns with locked buffer.
631  */
632 void buf_WaitIO(cm_scache_t * scp, cm_buf_t *bp)
633 {
634     int release = 0;
635
636     if (scp)
637         osi_assertx(scp->magic == CM_SCACHE_MAGIC, "invalid cm_scache_t magic");
638     osi_assertx(bp->magic == CM_BUF_MAGIC, "invalid cm_buf_t magic");
639
640     while (1) {
641         /* if no IO is happening, we're done */
642         if (!(bp->flags & (CM_BUF_READING | CM_BUF_WRITING)))
643             break;
644
645         /* otherwise I/O is happening, but some other thread is waiting for
646          * the I/O already.  Wait for that guy to figure out what happened,
647          * and then check again.
648          */
649         if ( bp->flags & CM_BUF_WAITING ) {
650             bp->waitCount++;
651             bp->waitRequests++;
652             osi_Log1(buf_logp, "buf_WaitIO CM_BUF_WAITING already set for 0x%p", bp);
653         } else {
654             osi_Log1(buf_logp, "buf_WaitIO CM_BUF_WAITING set for 0x%p", bp);
655             _InterlockedOr(&bp->flags, CM_BUF_WAITING);
656             bp->waitCount = bp->waitRequests = 1;
657         }
658         osi_SleepM((LONG_PTR)bp, &bp->mx);
659
660         cm_UpdateServerPriority();
661
662         lock_ObtainMutex(&bp->mx);
663         osi_Log1(buf_logp, "buf_WaitIO conflict wait done for 0x%p", bp);
664         bp->waitCount--;
665         if (bp->waitCount == 0) {
666             osi_Log1(buf_logp, "buf_WaitIO CM_BUF_WAITING reset for 0x%p", bp);
667             _InterlockedAnd(&bp->flags, ~CM_BUF_WAITING);
668             bp->waitRequests = 0;
669         }
670
671         if ( !scp ) {
672             if (scp = cm_FindSCache(&bp->fid))
673                  release = 1;
674         }
675         if ( scp ) {
676             lock_ObtainRead(&scp->rw);
677             if (!osi_QIsEmpty(&scp->waitQueueH)) {
678                 osi_Log1(buf_logp, "buf_WaitIO waking scp 0x%p", scp);
679                 osi_Wakeup((LONG_PTR)&scp->flags);
680             }
681             lock_ReleaseRead(&scp->rw);
682         }
683     }
684
685     /* if we get here, the IO is done, but we may have to wakeup people waiting for
686      * the I/O to complete.  Do so.
687      */
688     if (bp->flags & CM_BUF_WAITING) {
689         osi_Log1(buf_logp, "buf_WaitIO Waking bp 0x%p", bp);
690         osi_Wakeup((LONG_PTR) bp);
691     }
692     osi_Log1(buf_logp, "WaitIO finished wait for bp 0x%p", bp);
693
694     if (scp && release)
695         cm_ReleaseSCache(scp);
696 }
697
698 /* find a buffer, if any, for a particular file ID and offset.  Assumes
699  * that buf_globalLock is write locked when called.
700  */
701 cm_buf_t *buf_FindLocked(struct cm_fid *fidp, osi_hyper_t *offsetp)
702 {
703     afs_uint32 i;
704     cm_buf_t *bp;
705
706     lock_AssertAny(&buf_globalLock);
707
708     i = BUF_HASH(fidp, offsetp);
709     for(bp = cm_data.buf_scacheHashTablepp[i]; bp; bp=bp->hashp) {
710         if (cm_FidCmp(fidp, &bp->fid) == 0
711              && offsetp->LowPart == bp->offset.LowPart
712              && offsetp->HighPart == bp->offset.HighPart) {
713             buf_HoldLocked(bp);
714             break;
715         }
716     }
717
718     /* return whatever we found, if anything */
719     return bp;
720 }
721
722 /* find a buffer with offset *offsetp for vnode *scp.  Called
723  * with no locks held.
724  */
725 cm_buf_t *buf_Find(struct cm_fid *fidp, osi_hyper_t *offsetp)
726 {
727     cm_buf_t *bp;
728
729     lock_ObtainRead(&buf_globalLock);
730     bp = buf_FindLocked(fidp, offsetp);
731     lock_ReleaseRead(&buf_globalLock);
732
733     return bp;
734 }
735
736 /* find a buffer, if any, for a particular file ID and offset.  Assumes
737  * that buf_globalLock is write locked when called.  Uses the all buffer
738  * list.
739  */
740 cm_buf_t *buf_FindAllLocked(struct cm_fid *fidp, osi_hyper_t *offsetp, afs_uint32 flags)
741 {
742     cm_buf_t *bp;
743
744     if (flags == 0) {
745         for(bp = cm_data.buf_allp; bp; bp=bp->allp) {
746             if (cm_FidCmp(fidp, &bp->fid) == 0
747                  && offsetp->LowPart == bp->offset.LowPart
748                  && offsetp->HighPart == bp->offset.HighPart) {
749                 buf_HoldLocked(bp);
750                 break;
751             }
752         }
753     } else {
754         for(bp = cm_data.buf_allp; bp; bp=bp->allp) {
755             if (cm_FidCmp(fidp, &bp->fid) == 0) {
756                 char * fileOffset;
757
758                 fileOffset = offsetp->QuadPart + cm_data.baseAddress;
759                 if (fileOffset == bp->datap) {
760                     buf_HoldLocked(bp);
761                     break;
762                 }
763             }
764         }
765     }
766     /* return whatever we found, if anything */
767     return bp;
768 }
769
770 /* find a buffer with offset *offsetp for vnode *scp.  Called
771  * with no locks held.  Use the all buffer list.
772  */
773 cm_buf_t *buf_FindAll(struct cm_fid *fidp, osi_hyper_t *offsetp, afs_uint32 flags)
774 {
775     cm_buf_t *bp;
776
777     lock_ObtainRead(&buf_globalLock);
778     bp = buf_FindAllLocked(fidp, offsetp, flags);
779     lock_ReleaseRead(&buf_globalLock);
780
781     return bp;
782 }
783
784 /* start cleaning I/O on this buffer.  Buffer must be write locked, and is returned
785  * write-locked.
786  *
787  * Makes sure that there's only one person writing this block
788  * at any given time, and also ensures that the log is forced sufficiently far,
789  * if this buffer contains logged data.
790  *
791  * Returns non-zero if the buffer was dirty.
792  *
793  * 'scp' may or may not be NULL.  If it is not NULL, the FID for both cm_scache_t
794  * and cm_buf_t must match.
795  */
796 afs_uint32 buf_CleanLocked(cm_scache_t *scp, cm_buf_t *bp, cm_req_t *reqp,
797                                 afs_uint32 flags, afs_uint32 *pisdirty)
798 {
799     afs_uint32 code = 0;
800     afs_uint32 isdirty = 0;
801     osi_hyper_t offset;
802     int release_scp = 0;
803
804     osi_assertx(bp->magic == CM_BUF_MAGIC, "invalid cm_buf_t magic");
805     osi_assertx(scp == NULL || cm_FidCmp(&scp->fid, &bp->fid) == 0, "scp fid != bp fid");
806
807     /*
808      * If the matching cm_scache_t was not provided as a parameter
809      * we must either find one or allocate a new one.  It is possible
810      * that the cm_scache_t was recycled out of the cache even though
811      * a cm_buf_t with the same FID is in the cache.
812      */
813     if (scp == NULL &&
814         cm_GetSCache(&bp->fid, NULL, &scp,
815                      bp->userp ? bp->userp : cm_rootUserp,
816                      reqp) == 0)
817     {
818         release_scp = 1;
819
820         lock_ObtainWrite(&scp->rw);
821         code = cm_SyncOp(scp, NULL, bp->userp ? bp->userp : cm_rootUserp, reqp, 0,
822                          CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS);
823         if (code == 0) {
824             cm_SyncOpDone(scp, NULL, CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS);
825         }
826         lock_ReleaseWrite(&scp->rw);
827     }
828
829     if (scp && (scp->flags & CM_SCACHEFLAG_DELETED)) {
830         _InterlockedAnd(&bp->flags, ~CM_BUF_DIRTY);
831         _InterlockedOr(&bp->flags, CM_BUF_ERROR);
832         bp->dirty_length = 0;
833         bp->error = code;
834         bp->dataVersion = CM_BUF_VERSION_BAD;
835         bp->dirtyCounter++;
836     }
837
838     while ((bp->flags & CM_BUF_DIRTY) == CM_BUF_DIRTY) {
839         isdirty = 1;
840         lock_ReleaseMutex(&bp->mx);
841
842         if (!scp) {
843             /*
844              * If we didn't find a cm_scache_t object for bp->fid it means
845              * that we no longer have that FID in the cache.  It does not
846              * mean that the object does not exist in the cell.  That may
847              * in fact be the case but we don't know that until we attempt
848              * a FetchStatus on the FID.
849              */
850             osi_Log1(buf_logp, "buf_CleanLocked unable to start I/O - scp not found buf 0x%p", bp);
851             code = CM_ERROR_NOSUCHFILE;
852         } else {
853             osi_Log2(buf_logp, "buf_CleanLocked starts I/O on scp 0x%p buf 0x%p", scp, bp);
854
855             offset = bp->offset;
856             LargeIntegerAdd(offset, ConvertLongToLargeInteger(bp->dirty_offset));
857             /*
858              * Only specify the dirty length of the current buffer in the call
859              * to cm_BufWrite().  It is the responsibility of cm_BufWrite()
860              * to determine if it is appropriate to fill a full chunk of data
861              * when storing to the file server.
862              */
863             code = (*cm_buf_opsp->Writep)(scp, &offset, bp->dirty_length, flags,
864                                           bp->userp ? bp->userp : cm_rootUserp, reqp);
865             osi_Log3(buf_logp, "buf_CleanLocked I/O on scp 0x%p buf 0x%p, done=%d", scp, bp, code);
866         }
867         lock_ObtainMutex(&bp->mx);
868         /* if the Write routine returns No Such File, clear the dirty flag
869          * because we aren't going to be able to write this data to the file
870          * server.
871          */
872         if (code == CM_ERROR_NOSUCHFILE || code == CM_ERROR_BADFD || code == CM_ERROR_NOACCESS ||
873             code == CM_ERROR_QUOTA || code == CM_ERROR_SPACE || code == CM_ERROR_TOOBIG ||
874             code == CM_ERROR_READONLY || code == CM_ERROR_NOSUCHPATH || code == EIO){
875             _InterlockedAnd(&bp->flags, ~CM_BUF_DIRTY);
876             _InterlockedOr(&bp->flags, CM_BUF_ERROR);
877             bp->dirty_length = 0;
878             bp->error = code;
879             bp->dataVersion = CM_BUF_VERSION_BAD;
880             bp->dirtyCounter++;
881             break;
882         }
883
884 #ifdef DISKCACHE95
885         /* Disk cache support */
886         /* write buffer to disk cache (synchronous for now) */
887         diskcache_Update(bp->dcp, bp->datap, cm_data.buf_blockSize, bp->dataVersion);
888 #endif /* DISKCACHE95 */
889
890         /* if we get here and retries are not permitted
891          * then we need to exit this loop regardless of
892          * whether or not we were able to clear the dirty bit
893          */
894         if (reqp->flags & CM_REQ_NORETRY)
895             break;
896
897         /* Ditto if the hardDeadTimeout or idleTimeout was reached */
898         if (code == CM_ERROR_TIMEDOUT || code == CM_ERROR_ALLDOWN ||
899             code == CM_ERROR_ALLBUSY || code == CM_ERROR_ALLOFFLINE ||
900             code == CM_ERROR_CLOCKSKEW) {
901             break;
902         }
903     }
904
905     if (release_scp)
906         cm_ReleaseSCache(scp);
907
908     /* if someone was waiting for the I/O that just completed or failed,
909      * wake them up.
910      */
911     if (bp->flags & CM_BUF_WAITING) {
912         /* turn off flags and wakeup users */
913         osi_Log1(buf_logp, "buf_WaitIO Waking bp 0x%p", bp);
914         osi_Wakeup((LONG_PTR) bp);
915     }
916
917     if (pisdirty)
918         *pisdirty = isdirty;
919
920     return code;
921 }
922
923 /* Called with a zero-ref count buffer and with the buf_globalLock write locked.
924  * recycles the buffer, and leaves it ready for reuse with a ref count of 0.
925  * The buffer must already be clean, and no I/O should be happening to it.
926  */
927 void buf_Recycle(cm_buf_t *bp)
928 {
929     afs_uint32 i;
930     cm_buf_t **lbpp;
931     cm_buf_t *tbp;
932     cm_buf_t *prevBp, *nextBp;
933
934     osi_assertx(bp->magic == CM_BUF_MAGIC, "invalid cm_buf_t magic");
935
936     osi_assertx(!(bp->qFlags & CM_BUF_QREDIR), "can't recycle redir held buffers");
937
938     /* if we get here, we know that the buffer still has a 0 ref count,
939      * and that it is clean and has no currently pending I/O.  This is
940      * the dude to return.
941      * Remember that as long as the ref count is 0, we know that we won't
942      * have any lock conflicts, so we can grab the buffer lock out of
943      * order in the locking hierarchy.
944      */
945     osi_Log3( buf_logp, "buf_Recycle recycles 0x%p, off 0x%x:%08x",
946               bp, bp->offset.HighPart, bp->offset.LowPart);
947
948     osi_assertx(bp->refCount == 0, "cm_buf_t refcount != 0");
949     osi_assertx(!(bp->flags & (CM_BUF_READING | CM_BUF_WRITING | CM_BUF_DIRTY)),
950                 "incorrect cm_buf_t flags");
951     lock_AssertWrite(&buf_globalLock);
952
953     if (bp->qFlags & CM_BUF_QINHASH) {
954         /* Remove from hash */
955
956         i = BUF_HASH(&bp->fid, &bp->offset);
957         lbpp = &(cm_data.buf_scacheHashTablepp[i]);
958         for(tbp = *lbpp; tbp; lbpp = &tbp->hashp, tbp = tbp->hashp) {
959             if (tbp == bp)
960                 break;
961         }
962
963         /* we better find it */
964         osi_assertx(tbp != NULL, "buf_Recycle: hash table screwup");
965
966         *lbpp = bp->hashp;      /* hash out */
967         bp->hashp = NULL;
968
969         /* Remove from file hash */
970
971         i = BUF_FILEHASH(&bp->fid);
972         prevBp = bp->fileHashBackp;
973         bp->fileHashBackp = NULL;
974         nextBp = bp->fileHashp;
975         bp->fileHashp = NULL;
976         if (prevBp)
977             prevBp->fileHashp = nextBp;
978         else
979             cm_data.buf_fileHashTablepp[i] = nextBp;
980         if (nextBp)
981             nextBp->fileHashBackp = prevBp;
982
983         _InterlockedAnd(&bp->qFlags, ~CM_BUF_QINHASH);
984     }
985
986     /* make the fid unrecognizable */
987     memset(&bp->fid, 0, sizeof(cm_fid_t));
988
989     /* clean up junk flags */
990     _InterlockedAnd(&bp->flags, ~(CM_BUF_EOF | CM_BUF_ERROR));
991     bp->dataVersion = CM_BUF_VERSION_BAD;       /* unknown so far */
992 }
993
994
995 /*
996  * buf_RDRShakeAnExtentFree
997  * called with buf_globalLock read locked
998  */
999 afs_uint32
1000 buf_RDRShakeAnExtentFree(cm_buf_t *rbp, cm_req_t *reqp)
1001 {
1002     afs_uint32 code = 0;
1003     LARGE_INTEGER heldExtents = {0,0};
1004     AFSFileExtentCB extentList[1];
1005     DWORD extentCount = 0;
1006     BOOL locked = FALSE;
1007
1008     if (!(rbp->qFlags & CM_BUF_QREDIR))
1009         return 0;
1010
1011     lock_ReleaseRead(&buf_globalLock);
1012
1013     if (!lock_TryMutex(&buf_rdrReleaseExtentsLock)) {
1014         osi_Log0(afsd_logp, "Waiting for prior RDR_RequestExtentRelease request to complete");
1015         if (reqp->flags & CM_REQ_NORETRY) {
1016             code = CM_ERROR_WOULDBLOCK;
1017             goto done;
1018         }
1019
1020         lock_ObtainMutex(&buf_rdrReleaseExtentsLock);
1021     }
1022
1023     extentList[0].Flags = 0;
1024     extentList[0].Length = cm_data.blockSize;
1025     extentList[0].FileOffset.QuadPart = rbp->offset.QuadPart;
1026     extentList[0].CacheOffset.QuadPart = rbp->datap - cm_data.baseAddress;
1027     extentCount = 1;
1028
1029     code = RDR_RequestExtentRelease(&rbp->fid, heldExtents, extentCount, extentList);
1030
1031     lock_ReleaseMutex(&buf_rdrReleaseExtentsLock);
1032
1033   done:
1034     lock_ObtainRead(&buf_globalLock);
1035     return code;
1036 }
1037
1038 /*
1039  * buf_RDRShakeFileExtentsFree
1040  * requests all extents held by the redirector to be returned for
1041  * the specified cm_scache_t.  This function is called with no
1042  * locks held.
1043  */
1044 afs_uint32
1045 buf_RDRShakeFileExtentsFree(cm_scache_t *rscp, cm_req_t *reqp)
1046 {
1047     afs_uint32 code = 0;
1048     afs_uint64 n_redir = 0;
1049
1050     if (!lock_TryMutex(&buf_rdrReleaseExtentsLock)) {
1051         osi_Log0(afsd_logp, "Waiting for prior RDR_RequestExtentRelease request to complete");
1052         if (reqp->flags & CM_REQ_NORETRY)
1053             return CM_ERROR_WOULDBLOCK;
1054
1055         lock_ObtainMutex(&buf_rdrReleaseExtentsLock);
1056     }
1057
1058     for ( code = CM_ERROR_RETRY; code == CM_ERROR_RETRY; ) {
1059         LARGE_INTEGER heldExtents = {0,0};
1060         AFSFileExtentCB extentList[1024];
1061         DWORD extentCount = 0;
1062         cm_buf_t *srbp;
1063         time_t now;
1064
1065         /* only retry if a call to RDR_RequestExtentRelease says to */
1066         code = 0;
1067         lock_ObtainWrite(&buf_globalLock);
1068
1069         if (rscp->redirBufCount == 0)
1070         {
1071             lock_ReleaseWrite(&buf_globalLock);
1072             break;
1073         }
1074
1075         time(&now);
1076         for ( srbp = redirq_to_cm_buf_t(rscp->redirQueueT);
1077               srbp;
1078               srbp = ((code == 0 && extentCount == 0) ? redirq_to_cm_buf_t(rscp->redirQueueT) :
1079                        redirq_to_cm_buf_t(osi_QPrev(&srbp->redirq))))
1080         {
1081             extentList[extentCount].Flags = 0;
1082             extentList[extentCount].Length = cm_data.blockSize;
1083             extentList[extentCount].FileOffset.QuadPart = srbp->offset.QuadPart;
1084             extentList[extentCount].CacheOffset.QuadPart = srbp->datap - cm_data.baseAddress;
1085             srbp->redirReleaseRequested = now;
1086             extentCount++;
1087
1088             if (extentCount == 1024) {
1089                 lock_ReleaseWrite(&buf_globalLock);
1090                 heldExtents.QuadPart = cm_data.buf_redirCount;
1091                 code = RDR_RequestExtentRelease(&rscp->fid, heldExtents, extentCount, extentList);
1092                 if (code) {
1093                     if (code == CM_ERROR_RETRY) {
1094                         /*
1095                          * The redirector either is not holding the extents or cannot let them
1096                          * go because they are otherwise in use.  At the moment, do nothing.
1097                          */
1098                     } else
1099                         break;
1100                 }
1101                 extentCount = 0;
1102                 lock_ObtainWrite(&buf_globalLock);
1103             }
1104         }
1105         lock_ReleaseWrite(&buf_globalLock);
1106
1107         if (code == 0 && extentCount > 0) {
1108             heldExtents.QuadPart = cm_data.buf_redirCount;
1109             code = RDR_RequestExtentRelease(&rscp->fid, heldExtents, extentCount, extentList);
1110         }
1111
1112         if ((code == CM_ERROR_RETRY) && (reqp->flags & CM_REQ_NORETRY)) {
1113             code = CM_ERROR_WOULDBLOCK;
1114             break;
1115         }
1116     }
1117     lock_ReleaseMutex(&buf_rdrReleaseExtentsLock);
1118     return code;
1119 }
1120
1121 afs_uint32
1122 buf_RDRShakeSomeExtentsFree(cm_req_t *reqp, afs_uint32 oneFid, afs_uint32 minage)
1123 {
1124     afs_uint32 code = 0;
1125
1126     if (!lock_TryMutex(&buf_rdrReleaseExtentsLock)) {
1127         if (reqp->flags & CM_REQ_NORETRY)
1128             return CM_ERROR_WOULDBLOCK;
1129
1130         osi_Log0(afsd_logp, "Waiting for prior RDR_RequestExtentRelease request to complete");
1131         lock_ObtainMutex(&buf_rdrReleaseExtentsLock);
1132     }
1133
1134     for ( code = CM_ERROR_RETRY; code == CM_ERROR_RETRY; ) {
1135         LARGE_INTEGER heldExtents;
1136         AFSFileExtentCB extentList[1024];
1137         DWORD extentCount = 0;
1138         cm_buf_t *rbp, *srbp;
1139         cm_scache_t *rscp;
1140         time_t now;
1141         BOOL locked = FALSE;
1142
1143         /* only retry if a call to RDR_RequestExtentRelease says to */
1144         code = 0;
1145         lock_ObtainWrite(&buf_globalLock);
1146         locked = TRUE;
1147
1148         for ( rbp = cm_data.buf_redirListEndp;
1149               code == 0 && rbp && (!oneFid || extentCount == 0);
1150               rbp = (cm_buf_t *) osi_QPrev(&rbp->q))
1151         {
1152             if (!oneFid)
1153                 extentCount = 0;
1154
1155             if (rbp->redirLastAccess >= rbp->redirReleaseRequested) {
1156                 rscp = cm_FindSCache(&rbp->fid);
1157                 if (!rscp)
1158                     continue;
1159
1160                 time(&now);
1161                 for ( srbp = redirq_to_cm_buf_t(rscp->redirQueueT);
1162                       srbp && extentCount < 1024;
1163                       srbp = redirq_to_cm_buf_t(osi_QPrev(&srbp->redirq)))
1164                 {
1165                     /*
1166                      * Do not request a release if we have already done so
1167                      * or if the extent was delivered to windows less than
1168                      * 'minage' seconds ago.
1169                      */
1170                     if (srbp->redirLastAccess >= srbp->redirReleaseRequested &&
1171                          srbp->redirLastAccess < now - minage) {
1172                         extentList[extentCount].Flags = 0;
1173                         extentList[extentCount].Length = cm_data.blockSize;
1174                         extentList[extentCount].FileOffset.QuadPart = srbp->offset.QuadPart;
1175                         extentList[extentCount].CacheOffset.QuadPart = srbp->datap - cm_data.baseAddress;
1176                         srbp->redirReleaseRequested = now;
1177                         extentCount++;
1178                     }
1179                 }
1180                 cm_ReleaseSCache(rscp);
1181             }
1182
1183             if ( !oneFid && extentCount > 0) {
1184                 if (locked) {
1185                     lock_ReleaseWrite(&buf_globalLock);
1186                     locked = FALSE;
1187                 }
1188                 heldExtents.QuadPart = cm_data.buf_redirCount;
1189                 code = RDR_RequestExtentRelease(&rbp->fid, heldExtents, extentCount, extentList);
1190             }
1191             if (!locked) {
1192                 lock_ObtainWrite(&buf_globalLock);
1193                 locked = TRUE;
1194             }
1195         }
1196         if (locked)
1197             lock_ReleaseWrite(&buf_globalLock);
1198         if (code == 0) {
1199             if (oneFid) {
1200                 heldExtents.QuadPart = cm_data.buf_redirCount;
1201                 if (rbp && extentCount)
1202                     code = RDR_RequestExtentRelease(&rbp->fid, heldExtents, extentCount, extentList);
1203                 else
1204                     code = RDR_RequestExtentRelease(NULL, heldExtents, 1024, NULL);
1205             } else {
1206                 code = 0;
1207             }
1208         }
1209
1210         if ((code == CM_ERROR_RETRY) && (reqp->flags & CM_REQ_NORETRY)) {
1211             code = CM_ERROR_WOULDBLOCK;
1212             break;
1213         }
1214     }
1215     lock_ReleaseMutex(&buf_rdrReleaseExtentsLock);
1216     return code;
1217 }
1218
1219 /* returns 0 if the buffer does not exist, and non-0 if it does */
1220 static long
1221 buf_ExistsLocked(struct cm_scache *scp, osi_hyper_t *offsetp)
1222 {
1223     cm_buf_t *bp;
1224
1225     if (bp = buf_FindLocked(&scp->fid, offsetp)) {
1226         /* Do not call buf_ReleaseLocked() because we
1227          * do not want to allow the buffer to be added
1228          * to the free list.
1229          */
1230         afs_int32 refCount = InterlockedDecrement(&bp->refCount);
1231 #ifdef DEBUG_REFCOUNT
1232         osi_Log2(afsd_logp,"buf_ExistsLocked bp 0x%p ref %d", bp, refCount);
1233         afsi_log("%s:%d buf_ExistsLocked bp 0x%p, ref %d", __FILE__, __LINE__, bp, refCount);
1234 #endif
1235         return CM_BUF_EXISTS;
1236     }
1237
1238     return 0;
1239 }
1240
1241 /* recycle a buffer, removing it from the free list, hashing in its new identity
1242  * and returning it write-locked so that no one can use it.  Called without
1243  * any locks held, and can return an error if it loses the race condition and
1244  * finds that someone else created the desired buffer.
1245  *
1246  * If success is returned, the buffer is returned write-locked.
1247  *
1248  * May be called with null scp and offsetp, if we're just trying to reclaim some
1249  * space from the buffer pool.  In that case, the buffer will be returned
1250  * without being hashed into the hash table.
1251  */
1252 long buf_GetNewLocked(struct cm_scache *scp, osi_hyper_t *offsetp, cm_req_t *reqp, cm_buf_t **bufpp)
1253 {
1254     cm_buf_t *bp;       /* buffer we're dealing with */
1255     cm_buf_t *nextBp;   /* next buffer in file hash chain */
1256     afs_uint32 i;       /* temp */
1257     afs_uint64 n_bufs, n_nonzero, n_busy, n_dirty, n_own, n_redir;
1258
1259 #ifdef TESTING
1260     buf_ValidateBufQueues();
1261 #endif /* TESTING */
1262
1263     while(1) {
1264       retry:
1265         n_bufs = 0;
1266         n_nonzero = 0;
1267         n_own = 0;
1268         n_busy = 0;
1269         n_dirty = 0;
1270         n_redir = 0;
1271
1272         lock_ObtainRead(&scp->bufCreateLock);
1273         lock_ObtainWrite(&buf_globalLock);
1274         /* check to see if we lost the race */
1275         if (buf_ExistsLocked(scp, offsetp)) {
1276             lock_ReleaseWrite(&buf_globalLock);
1277             lock_ReleaseRead(&scp->bufCreateLock);
1278             return CM_BUF_EXISTS;
1279         }
1280
1281         /* does this fix the problem below?  it's a simple solution. */
1282         if (!cm_data.buf_freeListEndp)
1283         {
1284             lock_ReleaseWrite(&buf_globalLock);
1285             lock_ReleaseRead(&scp->bufCreateLock);
1286
1287             if ( RDR_Initialized )
1288                 goto rdr_release;
1289
1290             osi_Log0(afsd_logp, "buf_GetNewLocked: Free Buffer List is empty - sleeping 200ms");
1291             Sleep(200);
1292             goto retry;
1293         }
1294
1295         /* for debugging, assert free list isn't empty, although we
1296          * really should try waiting for a running tranasction to finish
1297          * instead of this; or better, we should have a transaction
1298          * throttler prevent us from entering this situation.
1299          */
1300         osi_assertx(cm_data.buf_freeListEndp != NULL, "buf_GetNewLocked: no free buffers");
1301
1302         /* look at all buffers in free list, some of which may temp.
1303          * have high refcounts and which then should be skipped,
1304          * starting cleaning I/O for those which are dirty.  If we find
1305          * a clean buffer, we rehash it, lock it and return it.
1306          */
1307         for (bp = cm_data.buf_freeListEndp; bp; bp=(cm_buf_t *) osi_QPrev(&bp->q)) {
1308             int cleaned = 0;
1309
1310             n_bufs++;
1311
1312           retry_2:
1313             /* check to see if it really has zero ref count.  This
1314              * code can bump refcounts, at least, so it may not be
1315              * zero.
1316              */
1317             if (bp->refCount > 0) {
1318                 n_nonzero++;
1319                 continue;
1320             }
1321
1322             /* we don't have to lock buffer itself, since the ref
1323              * count is 0 and we know it will stay zero as long as
1324              * we hold the global lock.
1325              */
1326
1327             /* don't recycle someone in our own chunk */
1328             if (!cm_FidCmp(&bp->fid, &scp->fid) &&
1329                 bp->dataVersion >= scp->bufDataVersionLow &&
1330                 bp->dataVersion <= scp->dataVersion &&
1331                 (bp->offset.LowPart & (-cm_chunkSize)) == (offsetp->LowPart & (-cm_chunkSize))) {
1332                 n_own++;
1333                 continue;
1334             }
1335
1336             /* if this page is being filled (!) or cleaned, see if
1337              * the I/O has completed.  If not, skip it, otherwise
1338              * do the final processing for the I/O.
1339              */
1340             if (bp->flags & (CM_BUF_READING | CM_BUF_WRITING)) {
1341                 /* probably shouldn't do this much work while
1342                  * holding the big lock?  Watch for contention
1343                  * here.
1344                  */
1345                 n_busy++;
1346                 continue;
1347             }
1348
1349             /* leave the buffer alone if held by the redirector */
1350             if (bp->qFlags & CM_BUF_QREDIR) {
1351                 n_redir++;
1352                 continue;
1353             }
1354
1355             if (bp->flags & CM_BUF_DIRTY) {
1356                 n_dirty++;
1357
1358                 /* protect against cleaning the same buffer more than once. */
1359                 if (cleaned)
1360                     continue;
1361
1362                 /* if the buffer is dirty, start cleaning it and
1363                  * move on to the next buffer.  We do this with
1364                  * just the lock required to minimize contention
1365                  * on the big lock.
1366                  */
1367                 buf_HoldLocked(bp);
1368                 lock_ReleaseWrite(&buf_globalLock);
1369                 lock_ReleaseRead(&scp->bufCreateLock);
1370
1371                 /*
1372                  * grab required lock and clean.
1373                  * previously the claim was that the cleaning
1374                  * operation was async which it is not.  It would
1375                  * be a good idea to use an async mechanism here
1376                  * but there is none at the moment other than
1377                  * the buf_IncrSyncer() thread.
1378                  */
1379                 if (cm_FidCmp(&scp->fid, &bp->fid) == 0)
1380                     buf_Clean(scp, bp, reqp, 0, NULL);
1381                 else
1382                     buf_Clean(NULL, bp, reqp, 0, NULL);
1383
1384                 /* now put it back and go around again */
1385                 buf_Release(bp);
1386
1387                 /* but first obtain the locks we gave up
1388                  * before the buf_CleanAsync() call */
1389                 lock_ObtainRead(&scp->bufCreateLock);
1390                 lock_ObtainWrite(&buf_globalLock);
1391
1392                 /*
1393                  * Since we dropped the locks we need to verify that
1394                  * another thread has not allocated the buffer for us.
1395                  */
1396                 if (buf_ExistsLocked(scp, offsetp)) {
1397                     lock_ReleaseWrite(&buf_globalLock);
1398                     lock_ReleaseRead(&scp->bufCreateLock);
1399                     return CM_BUF_EXISTS;
1400                 }
1401
1402                 /*
1403                  * We just cleaned this buffer so we need to
1404                  * restart the loop with this buffer so it
1405                  * can be retested.  Set 'cleaned' so we
1406                  * do not attempt another call to buf_Clean()
1407                  * if the prior attempt failed.
1408                  */
1409                 cleaned = 1;
1410                 goto retry_2;
1411             }
1412
1413             osi_Log3(afsd_logp, "buf_GetNewLocked: scp 0x%p examined %u buffers before recycling bufp 0x%p",
1414                      scp, n_bufs, bp);
1415             osi_Log4(afsd_logp, "... nonzero %u; own %u; busy %u; dirty %u", n_nonzero, n_own, n_busy, n_dirty);
1416
1417             /* if we get here, we know that the buffer still has a 0
1418              * ref count, and that it is clean and has no currently
1419              * pending I/O.  This is the dude to return.
1420              * Remember that as long as the ref count is 0, we know
1421              * that we won't have any lock conflicts, so we can grab
1422              * the buffer lock out of order in the locking hierarchy.
1423              */
1424             buf_Recycle(bp);
1425
1426             /* now hash in as our new buffer, and give it the
1427              * appropriate label, if requested.
1428              */
1429             if (scp) {
1430                 lock_AssertWrite(&buf_globalLock);
1431
1432                 _InterlockedOr(&bp->qFlags, CM_BUF_QINHASH);
1433                 bp->fid = scp->fid;
1434 #ifdef DEBUG
1435                 bp->scp = scp;
1436 #endif
1437                 bp->offset = *offsetp;
1438                 i = BUF_HASH(&scp->fid, offsetp);
1439                 bp->hashp = cm_data.buf_scacheHashTablepp[i];
1440                 cm_data.buf_scacheHashTablepp[i] = bp;
1441                 i = BUF_FILEHASH(&scp->fid);
1442                 nextBp = cm_data.buf_fileHashTablepp[i];
1443                 bp->fileHashp = nextBp;
1444                 bp->fileHashBackp = NULL;
1445                 if (nextBp)
1446                     nextBp->fileHashBackp = bp;
1447                 cm_data.buf_fileHashTablepp[i] = bp;
1448             }
1449
1450             /* we should remove it from the lru queue.  It better still be there,
1451              * since we've held the global (big) lock since we found it there.
1452              */
1453             osi_assertx(bp->qFlags & CM_BUF_QINLRU,
1454                          "buf_GetNewLocked: LRU screwup");
1455
1456             osi_QRemoveHT( (osi_queue_t **) &cm_data.buf_freeListp,
1457                            (osi_queue_t **) &cm_data.buf_freeListEndp,
1458                            &bp->q);
1459             _InterlockedAnd(&bp->qFlags, ~CM_BUF_QINLRU);
1460             buf_DecrementFreeCount();
1461
1462             /* prepare to return it.  Give it a refcount */
1463             InterlockedIncrement(&bp->refCount);
1464 #ifdef DEBUG_REFCOUNT
1465             osi_Log2(afsd_logp,"buf_GetNewLocked bp 0x%p ref %d", bp, 1);
1466             afsi_log("%s:%d buf_GetNewLocked bp 0x%p, ref %d", __FILE__, __LINE__, bp, 1);
1467 #endif
1468             /* grab the mutex so that people don't use it
1469              * before the caller fills it with data.  Again, no one
1470              * should have been able to get to this dude to lock it.
1471              */
1472             if (!lock_TryMutex(&bp->mx)) {
1473                 osi_Log2(afsd_logp, "buf_GetNewLocked bp 0x%p cannot be mutex locked.  refCount %d should be 0",
1474                          bp, bp->refCount);
1475                 osi_panic("buf_GetNewLocked: TryMutex failed",__FILE__,__LINE__);
1476             }
1477
1478             lock_ReleaseWrite(&buf_globalLock);
1479             lock_ReleaseRead(&scp->bufCreateLock);
1480
1481             *bufpp = bp;
1482
1483 #ifdef TESTING
1484             buf_ValidateBufQueues();
1485 #endif /* TESTING */
1486             return 0;
1487         } /* for all buffers in lru queue */
1488         lock_ReleaseWrite(&buf_globalLock);
1489         lock_ReleaseRead(&scp->bufCreateLock);
1490
1491         osi_Log2(afsd_logp, "buf_GetNewLocked: Free Buffer List has %u buffers none free; redir %u", n_bufs, n_redir);
1492         osi_Log4(afsd_logp, "... nonzero %u; own %u; busy %u; dirty %u", n_nonzero, n_own, n_busy, n_dirty);
1493
1494         if (RDR_Initialized) {
1495             afs_uint32 code;
1496           rdr_release:
1497             code = buf_RDRShakeSomeExtentsFree(reqp, TRUE, 2 /* seconds */);
1498             switch (code) {
1499             case CM_ERROR_RETRY:
1500             case 0:
1501                 goto retry;
1502             case CM_ERROR_WOULDBLOCK:
1503                 return CM_ERROR_WOULDBLOCK;
1504             }
1505         }
1506
1507         Sleep(100);             /* give some time for a buffer to be freed */
1508     }   /* while loop over everything */
1509     /* not reached */
1510 } /* the proc */
1511
1512 /*
1513  * get a page, returning it held but unlocked.  the page may or may not
1514  * contain valid data.
1515  *
1516  * The scp must be unlocked when passed in unlocked.
1517  */
1518 long buf_Get(struct cm_scache *scp, osi_hyper_t *offsetp, cm_req_t *reqp, cm_buf_t **bufpp)
1519 {
1520     cm_buf_t *bp;
1521     long code;
1522     osi_hyper_t pageOffset;
1523     unsigned long tcount;
1524     int created;
1525     long lcount = 0;
1526 #ifdef DISKCACHE95
1527     cm_diskcache_t *dcp;
1528 #endif /* DISKCACHE95 */
1529
1530     created = 0;
1531     pageOffset.HighPart = offsetp->HighPart;
1532     pageOffset.LowPart = offsetp->LowPart & ~(cm_data.buf_blockSize-1);
1533     while (!created) {
1534         lcount++;
1535 #ifdef TESTING
1536         buf_ValidateBufQueues();
1537 #endif /* TESTING */
1538
1539         bp = buf_Find(&scp->fid, &pageOffset);
1540         if (bp) {
1541             /* lock it and break out */
1542             lock_ObtainMutex(&bp->mx);
1543
1544 #ifdef DISKCACHE95
1545             /* touch disk chunk to update LRU info */
1546             diskcache_Touch(bp->dcp);
1547 #endif /* DISKCACHE95 */
1548             break;
1549         }
1550
1551         /* otherwise, we have to create a page */
1552         code = buf_GetNewLocked(scp, &pageOffset, reqp, &bp);
1553         switch (code) {
1554         case 0:
1555             /* the requested buffer was created */
1556             created = 1;
1557             break;
1558         case CM_BUF_EXISTS:
1559             /*
1560              * the requested buffer existed by the time the
1561              * scp->bufCreateLock and buf_globalLock could be obtained.
1562              * loop again and permit buf_Find() to obtain a reference.
1563              */
1564             break;
1565         default:
1566             /*
1567              * the requested buffer could not be created.
1568              * return the error to the caller.
1569              */
1570 #ifdef TESTING
1571             buf_ValidateBufQueues();
1572 #endif /* TESTING */
1573             return code;
1574         }
1575     } /* big while loop */
1576
1577     /* if we get here, we have a locked buffer that may have just been
1578      * created, in which case it needs to be filled with data.
1579      */
1580     if (created) {
1581         /* load the page; freshly created pages should be idle */
1582         osi_assertx(!(bp->flags & (CM_BUF_READING | CM_BUF_WRITING)), "incorrect cm_buf_t flags");
1583
1584         /*
1585          * start the I/O; may drop lock.  as of this writing, the only
1586          * implementation of Readp is cm_BufRead() which simply sets
1587          * tcount to 0 and returns success.
1588          */
1589         _InterlockedOr(&bp->flags, CM_BUF_READING);
1590         code = (*cm_buf_opsp->Readp)(bp, cm_data.buf_blockSize, &tcount, NULL);
1591
1592 #ifdef DISKCACHE95
1593         code = diskcache_Get(&bp->fid, &bp->offset, bp->datap, cm_data.buf_blockSize, &bp->dataVersion, &tcount, &dcp);
1594         bp->dcp = dcp;    /* pointer to disk cache struct. */
1595 #endif /* DISKCACHE95 */
1596
1597         if (code != 0) {
1598             /* failure or queued */
1599
1600             /* unless cm_BufRead() is altered, this path cannot be hit */
1601             if (code != ERROR_IO_PENDING) {
1602                 bp->error = code;
1603                 _InterlockedOr(&bp->flags, CM_BUF_ERROR);
1604                 _InterlockedAnd(&bp->flags, ~CM_BUF_READING);
1605                 if (bp->flags & CM_BUF_WAITING) {
1606                     osi_Log1(buf_logp, "buf_Get Waking bp 0x%p", bp);
1607                     osi_Wakeup((LONG_PTR) bp);
1608                 }
1609                 lock_ReleaseMutex(&bp->mx);
1610                 buf_Release(bp);
1611 #ifdef TESTING
1612                 buf_ValidateBufQueues();
1613 #endif /* TESTING */
1614                 return code;
1615             }
1616         } else {
1617             /*
1618              * otherwise, I/O completed instantly and we're done, except
1619              * for padding the xfr out with 0s and checking for EOF
1620              */
1621             if (tcount < (unsigned long) cm_data.buf_blockSize) {
1622                 memset(bp->datap+tcount, 0, cm_data.buf_blockSize - tcount);
1623                 if (tcount == 0)
1624                     _InterlockedOr(&bp->flags, CM_BUF_EOF);
1625             }
1626             _InterlockedAnd(&bp->flags, ~CM_BUF_READING);
1627             if (bp->flags & CM_BUF_WAITING) {
1628                 osi_Log1(buf_logp, "buf_Get Waking bp 0x%p", bp);
1629                 osi_Wakeup((LONG_PTR) bp);
1630             }
1631         }
1632     } /* if created */
1633
1634     /* wait for reads, either that which we started above, or that someone
1635      * else started.  We don't care if we return a buffer being cleaned.
1636      */
1637     if (bp->flags & CM_BUF_READING)
1638         buf_WaitIO(scp, bp);
1639
1640     /* once it has been read once, we can unlock it and return it, still
1641      * with its refcount held.
1642      */
1643     lock_ReleaseMutex(&bp->mx);
1644     *bufpp = bp;
1645
1646     /* now remove from queue; will be put in at the head (farthest from
1647      * being recycled) when we're done in buf_Release.
1648      */
1649     lock_ObtainWrite(&buf_globalLock);
1650     if (bp->qFlags & CM_BUF_QINLRU) {
1651         osi_QRemoveHT( (osi_queue_t **) &cm_data.buf_freeListp,
1652                        (osi_queue_t **) &cm_data.buf_freeListEndp,
1653                        &bp->q);
1654         _InterlockedAnd(&bp->qFlags, ~CM_BUF_QINLRU);
1655         buf_DecrementFreeCount();
1656     }
1657     lock_ReleaseWrite(&buf_globalLock);
1658
1659     osi_Log4(buf_logp, "buf_Get returning bp 0x%p for scp 0x%p, offset 0x%x:%08x",
1660               bp, scp, offsetp->HighPart, offsetp->LowPart);
1661 #ifdef TESTING
1662     buf_ValidateBufQueues();
1663 #endif /* TESTING */
1664     return 0;
1665 }
1666
1667 /* clean a buffer synchronously */
1668 afs_uint32 buf_Clean(cm_scache_t *scp, cm_buf_t *bp, cm_req_t *reqp, afs_uint32 flags, afs_uint32 *pisdirty)
1669 {
1670     long code;
1671     osi_assertx(bp->magic == CM_BUF_MAGIC, "invalid cm_buf_t magic");
1672     osi_assertx(!(flags & CM_BUF_WRITE_SCP_LOCKED), "scp->rw must not be held when calling buf_CleanAsync");
1673
1674     lock_ObtainMutex(&bp->mx);
1675     code = buf_CleanLocked(scp, bp, reqp, flags, pisdirty);
1676     lock_ReleaseMutex(&bp->mx);
1677
1678     return code;
1679 }
1680
1681 /* wait for a buffer's cleaning to finish */
1682 void buf_CleanWait(cm_scache_t * scp, cm_buf_t *bp, afs_uint32 locked)
1683 {
1684     osi_assertx(bp->magic == CM_BUF_MAGIC, "invalid cm_buf_t magic");
1685
1686     if (!locked)
1687         lock_ObtainMutex(&bp->mx);
1688     if (bp->flags & CM_BUF_WRITING) {
1689         buf_WaitIO(scp, bp);
1690     }
1691     if (!locked)
1692         lock_ReleaseMutex(&bp->mx);
1693 }
1694
1695 /* set the dirty flag on a buffer, and set associated write-ahead log,
1696  * if there is one.  Allow one to be added to a buffer, but not changed.
1697  *
1698  * The buffer must be locked before calling this routine.
1699  */
1700 void buf_SetDirty(cm_buf_t *bp, cm_req_t *reqp, afs_uint32 offset, afs_uint32 length, cm_user_t *userp)
1701 {
1702     osi_assertx(bp->magic == CM_BUF_MAGIC, "invalid cm_buf_t magic");
1703     osi_assertx(bp->refCount > 0, "cm_buf_t refcount 0");
1704     osi_assertx(userp != NULL, "userp is NULL");
1705
1706     if (length == 0)
1707         return;
1708
1709     if (bp->flags & CM_BUF_DIRTY) {
1710
1711         osi_Log1(buf_logp, "buf_SetDirty 0x%p already dirty", bp);
1712
1713         if (bp->dirty_offset <= offset) {
1714             if (bp->dirty_offset + bp->dirty_length >= offset + length) {
1715                 /* dirty_length remains the same */
1716             } else {
1717                 bp->dirty_length = offset + length - bp->dirty_offset;
1718             }
1719         } else /* bp->dirty_offset > offset */ {
1720             if (bp->dirty_offset + bp->dirty_length >= offset + length) {
1721                 bp->dirty_length = bp->dirty_offset + bp->dirty_length - offset;
1722             } else {
1723                 bp->dirty_length = length;
1724             }
1725             bp->dirty_offset = offset;
1726         }
1727     } else {
1728         osi_Log1(buf_logp, "buf_SetDirty 0x%p", bp);
1729
1730         /* set dirty bit */
1731         _InterlockedOr(&bp->flags, CM_BUF_DIRTY);
1732
1733         /* and turn off EOF flag, since it has associated data now */
1734         _InterlockedAnd(&bp->flags, ~CM_BUF_EOF);
1735
1736         bp->dirty_offset = offset;
1737         bp->dirty_length = length;
1738
1739         /*
1740          * if the request is not from the afs redirector,
1741          * add to the dirty list.  The redirector interface ensures
1742          * that a background store operation is queued for each and
1743          * every dirty extent that is released.  Therefore, the
1744          * buf_IncrSyncer thread is not required to ensure that
1745          * dirty buffers are written to the file server.
1746          *
1747          * we obtain a hold on the buffer for as long as it remains
1748          * in the list.  buffers are only removed from the list by
1749          * the buf_IncrSyncer function regardless of when else the
1750          * dirty flag might be cleared.
1751          *
1752          * This should never happen but just in case there is a bug
1753          * elsewhere, never add to the dirty list if the buffer is
1754          * already there.
1755          */
1756         if (!(reqp->flags & CM_REQ_SOURCE_REDIR)) {
1757             lock_ObtainWrite(&buf_globalLock);
1758             if (!(bp->qFlags & CM_BUF_QINDL)) {
1759                 buf_HoldLocked(bp);
1760                 if (!cm_data.buf_dirtyListp) {
1761                     cm_data.buf_dirtyListp = cm_data.buf_dirtyListEndp = bp;
1762                 } else {
1763                     cm_data.buf_dirtyListEndp->dirtyp = bp;
1764                     cm_data.buf_dirtyListEndp = bp;
1765                 }
1766                 bp->dirtyp = NULL;
1767                 _InterlockedOr(&bp->qFlags, CM_BUF_QINDL);
1768             }
1769             lock_ReleaseWrite(&buf_globalLock);
1770         }
1771     }
1772
1773     /* and record the last writer */
1774     if (bp->userp != userp) {
1775         cm_HoldUser(userp);
1776         if (bp->userp)
1777             cm_ReleaseUser(bp->userp);
1778         bp->userp = userp;
1779     }
1780 }
1781
1782 /* clean all buffers, reset log pointers and invalidate all buffers.
1783  * Called with no locks held, and returns with same.
1784  *
1785  * This function is guaranteed to clean and remove the log ptr of all the
1786  * buffers that were dirty or had non-zero log ptrs before the call was
1787  * made.  That's sufficient to clean up any garbage left around by recovery,
1788  * which is all we're counting on this for; there may be newly created buffers
1789  * added while we're running, but that should be OK.
1790  *
1791  * In an environment where there are no transactions (artificially imposed, for
1792  * example, when switching the database to raw mode), this function is used to
1793  * make sure that all updates have been written to the disk.  In that case, we don't
1794  * really require that we forget the log association between pages and logs, but
1795  * it also doesn't hurt.  Since raw mode I/O goes through this buffer package, we don't
1796  * have to worry about invalidating data in the buffers.
1797  *
1798  * This function is used at the end of recovery as paranoia to get the recovered
1799  * database out to disk.  It removes all references to the recovery log and cleans
1800  * all buffers.
1801  */
1802 long buf_CleanAndReset(void)
1803 {
1804     afs_uint32 i;
1805     cm_buf_t *bp;
1806     cm_req_t req;
1807
1808     lock_ObtainRead(&buf_globalLock);
1809     for(i=0; i<cm_data.buf_hashSize; i++) {
1810         for(bp = cm_data.buf_scacheHashTablepp[i]; bp; bp = bp->hashp) {
1811             if (bp->qFlags & CM_BUF_QREDIR) {
1812                 osi_Log1(buf_logp,"buf_CleanAndReset buffer held by redirector bp 0x%p", bp);
1813
1814                 /* Request single extent from the redirector */
1815                 buf_RDRShakeAnExtentFree(bp, &req);
1816             }
1817
1818             if ((bp->flags & CM_BUF_DIRTY) == CM_BUF_DIRTY) {
1819                 buf_HoldLocked(bp);
1820                 lock_ReleaseRead(&buf_globalLock);
1821
1822                 /* now no locks are held; clean buffer and go on */
1823                 cm_InitReq(&req);
1824                 req.flags |= CM_REQ_NORETRY;
1825
1826                 buf_Clean(NULL, bp, &req, 0, NULL);
1827                 buf_CleanWait(NULL, bp, FALSE);
1828
1829                 /* relock and release buffer */
1830                 lock_ObtainRead(&buf_globalLock);
1831                 buf_ReleaseLocked(bp, FALSE);
1832             } /* dirty */
1833         } /* over one bucket */
1834     }   /* for loop over all hash buckets */
1835
1836     /* release locks */
1837     lock_ReleaseRead(&buf_globalLock);
1838
1839 #ifdef TESTING
1840     buf_ValidateBufQueues();
1841 #endif /* TESTING */
1842
1843     /* and we're done */
1844     return 0;
1845 }
1846
1847 /* called without global lock being held, reserves buffers for callers
1848  * that need more than one held (not locked) at once.
1849  */
1850 void buf_ReserveBuffers(afs_uint64 nbuffers)
1851 {
1852     lock_ObtainWrite(&buf_globalLock);
1853     while (1) {
1854         if (cm_data.buf_reservedBufs + nbuffers > cm_data.buf_maxReservedBufs) {
1855             cm_data.buf_reserveWaiting = 1;
1856             osi_Log1(buf_logp, "buf_ReserveBuffers waiting for %d bufs", nbuffers);
1857             osi_SleepW((LONG_PTR) &cm_data.buf_reservedBufs, &buf_globalLock);
1858             lock_ObtainWrite(&buf_globalLock);
1859         }
1860         else {
1861             cm_data.buf_reservedBufs += nbuffers;
1862             break;
1863         }
1864     }
1865     lock_ReleaseWrite(&buf_globalLock);
1866 }
1867
1868 int buf_TryReserveBuffers(afs_uint64 nbuffers)
1869 {
1870     int code;
1871
1872     lock_ObtainWrite(&buf_globalLock);
1873     if (cm_data.buf_reservedBufs + nbuffers > cm_data.buf_maxReservedBufs) {
1874         code = 0;
1875     }
1876     else {
1877         cm_data.buf_reservedBufs += nbuffers;
1878         code = 1;
1879     }
1880     lock_ReleaseWrite(&buf_globalLock);
1881     return code;
1882 }
1883
1884 /* called without global lock held, releases reservation held by
1885  * buf_ReserveBuffers.
1886  */
1887 void buf_UnreserveBuffers(afs_uint64 nbuffers)
1888 {
1889     lock_ObtainWrite(&buf_globalLock);
1890     cm_data.buf_reservedBufs -= nbuffers;
1891     if (cm_data.buf_reserveWaiting) {
1892         cm_data.buf_reserveWaiting = 0;
1893         osi_Wakeup((LONG_PTR) &cm_data.buf_reservedBufs);
1894     }
1895     lock_ReleaseWrite(&buf_globalLock);
1896 }
1897
1898 /* truncate the buffers past sizep, zeroing out the page, if we don't
1899  * end on a page boundary.
1900  *
1901  * Requires cm_bufCreateLock to be write locked.
1902  */
1903 long buf_Truncate(cm_scache_t *scp, cm_user_t *userp, cm_req_t *reqp,
1904                    osi_hyper_t *sizep)
1905 {
1906     cm_buf_t *bufp;
1907     cm_buf_t *nbufp;                    /* next buffer, if didRelease */
1908     osi_hyper_t bufEnd;
1909     long code;
1910     long bufferPos;
1911     afs_uint32 i;
1912     afs_uint32 invalidate = 0;
1913
1914     /* assert that cm_bufCreateLock is held in write mode */
1915     lock_AssertWrite(&scp->bufCreateLock);
1916
1917     i = BUF_FILEHASH(&scp->fid);
1918
1919     lock_ObtainRead(&buf_globalLock);
1920     bufp = cm_data.buf_fileHashTablepp[i];
1921     if (bufp == NULL) {
1922         lock_ReleaseRead(&buf_globalLock);
1923         return 0;
1924     }
1925
1926     buf_HoldLocked(bufp);
1927     lock_ReleaseRead(&buf_globalLock);
1928
1929     while (bufp) {
1930         lock_ObtainMutex(&bufp->mx);
1931
1932         bufEnd.HighPart = 0;
1933         bufEnd.LowPart = cm_data.buf_blockSize;
1934         bufEnd = LargeIntegerAdd(bufEnd, bufp->offset);
1935
1936         if (cm_FidCmp(&bufp->fid, &scp->fid) == 0 &&
1937              LargeIntegerLessThan(*sizep, bufEnd)) {
1938             buf_WaitIO(scp, bufp);
1939         }
1940         lock_ObtainWrite(&scp->rw);
1941
1942         /* make sure we have a callback (so we have the right value for
1943          * the length), and wait for it to be safe to do a truncate.
1944          */
1945         code = cm_SyncOp(scp, bufp, userp, reqp, 0,
1946                           CM_SCACHESYNC_NEEDCALLBACK
1947                           | CM_SCACHESYNC_GETSTATUS
1948                           | CM_SCACHESYNC_SETSIZE
1949                           | CM_SCACHESYNC_BUFLOCKED);
1950
1951
1952         /* if we succeeded in our locking, and this applies to the right
1953          * file, and the truncate request overlaps the buffer either
1954          * totally or partially, then do something.
1955          */
1956         if (code == 0 && cm_FidCmp(&bufp->fid, &scp->fid) == 0
1957              && LargeIntegerLessThan(*sizep, bufEnd)) {
1958
1959
1960             /* destroy the buffer, turning off its dirty bit, if
1961              * we're truncating the whole buffer.  Otherwise, set
1962              * the dirty bit, and clear out the tail of the buffer
1963              * if we just overlap some.
1964              */
1965             if (LargeIntegerLessThanOrEqualTo(*sizep, bufp->offset)) {
1966                 /* truncating the entire page */
1967                 if (reqp->flags & CM_REQ_SOURCE_REDIR) {
1968                     /*
1969                      * Implicitly clear the redirector flag
1970                      * and release the matching hold.
1971                      */
1972                     if (bufp->qFlags & CM_BUF_QREDIR) {
1973                         osi_Log4(buf_logp,"buf_Truncate taking from file system bufp 0x%p vno 0x%x foffset 0x%x:%x",
1974                                  bufp, bufp->fid.vnode, bufp->offset.HighPart, bufp->offset.LowPart);
1975                         lock_ObtainWrite(&buf_globalLock);
1976                         if (bufp->qFlags & CM_BUF_QREDIR) {
1977                             buf_RemoveFromRedirQueue(scp, bufp);
1978                             buf_ReleaseLocked(bufp, TRUE);
1979                         }
1980                         lock_ReleaseWrite(&buf_globalLock);
1981                     }
1982                 } else {
1983                     invalidate = 1;
1984                 }
1985                 _InterlockedAnd(&bufp->flags, ~CM_BUF_DIRTY);
1986                 bufp->error = 0;
1987                 bufp->dirty_length = 0;
1988                 bufp->dataVersion = CM_BUF_VERSION_BAD; /* known bad */
1989                 bufp->dirtyCounter++;
1990             }
1991             else {
1992                 /* don't set dirty, since dirty implies
1993                  * currently up-to-date.  Don't need to do this,
1994                  * since we'll update the length anyway.
1995                  *
1996                  * Zero out remainder of the page, in case we
1997                  * seek and write past EOF, and make this data
1998                  * visible again.
1999                  */
2000                 bufferPos = sizep->LowPart & (cm_data.buf_blockSize - 1);
2001                 osi_assertx(bufferPos != 0, "non-zero bufferPos");
2002                 memset(bufp->datap + bufferPos, 0,
2003                         cm_data.buf_blockSize - bufferPos);
2004             }
2005         }
2006
2007         cm_SyncOpDone( scp, bufp,
2008                        CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS
2009                        | CM_SCACHESYNC_SETSIZE | CM_SCACHESYNC_BUFLOCKED);
2010
2011         lock_ReleaseWrite(&scp->rw);
2012         lock_ReleaseMutex(&bufp->mx);
2013
2014         if (!code) {
2015             nbufp = bufp->fileHashp;
2016             if (nbufp)
2017                 buf_Hold(nbufp);
2018         } else {
2019             /* This forces the loop to end and the error code
2020              * to be returned. */
2021             nbufp = NULL;
2022         }
2023         buf_Release(bufp);
2024         bufp = nbufp;
2025     }
2026
2027 #ifdef TESTING
2028     buf_ValidateBufQueues();
2029 #endif /* TESTING */
2030
2031     if (invalidate && RDR_Initialized)
2032         RDR_InvalidateObject(scp->fid.cell, scp->fid.volume, scp->fid.vnode,
2033                              scp->fid.unique, scp->fid.hash,
2034                              scp->fileType, AFS_INVALIDATE_SMB);
2035
2036     /* done */
2037     return code;
2038 }
2039
2040 long buf_FlushCleanPages(cm_scache_t *scp, cm_user_t *userp, cm_req_t *reqp)
2041 {
2042     long code;
2043     cm_buf_t *bp;               /* buffer we're hacking on */
2044     cm_buf_t *nbp;
2045     int didRelease;
2046     afs_uint32 i;
2047     afs_uint32 stable = 0;
2048
2049     i = BUF_FILEHASH(&scp->fid);
2050
2051     code = 0;
2052     lock_ObtainRead(&buf_globalLock);
2053     bp = cm_data.buf_fileHashTablepp[i];
2054     if (bp)
2055         buf_HoldLocked(bp);
2056     lock_ReleaseRead(&buf_globalLock);
2057
2058     for (; bp; bp = nbp) {
2059         didRelease = 0; /* haven't released this buffer yet */
2060
2061         /* clean buffer synchronously */
2062         if (cm_FidCmp(&bp->fid, &scp->fid) == 0) {
2063
2064             if (code == 0 && !stable && (bp->flags & CM_BUF_DIRTY)) {
2065                 /*
2066                  * we must stabilize the object to ensure that buffer
2067                  * changes cannot occur while the flush is performed.
2068                  * However, we do not want to Stabilize if we do not
2069                  * need to because Stabilize obtains a callback.
2070                  */
2071                 code = (*cm_buf_opsp->Stabilizep)(scp, userp, reqp);
2072                 stable = (code == 0);
2073             }
2074
2075             if (code == CM_ERROR_BADFD) {
2076                 /* if the scp's FID is bad its because we received VNOVNODE
2077                  * when attempting to FetchStatus before the write.  This
2078                  * page therefore contains data that can no longer be stored.
2079                  */
2080                 lock_ObtainMutex(&bp->mx);
2081                 _InterlockedAnd(&bp->flags, ~CM_BUF_DIRTY);
2082                 _InterlockedOr(&bp->flags, CM_BUF_ERROR);
2083                 bp->error = CM_ERROR_BADFD;
2084                 bp->dirty_length = 0;
2085                 bp->dataVersion = CM_BUF_VERSION_BAD;   /* known bad */
2086                 bp->dirtyCounter++;
2087                 lock_ReleaseMutex(&bp->mx);
2088             } else if (!(scp->flags & CM_SCACHEFLAG_RO)) {
2089                 if (code) {
2090                     goto skip;
2091                 }
2092
2093                 lock_ObtainMutex(&bp->mx);
2094
2095                 /* start cleaning the buffer, and wait for it to finish */
2096                 buf_CleanLocked(scp, bp, reqp, 0, NULL);
2097                 buf_WaitIO(scp, bp);
2098
2099                 lock_ReleaseMutex(&bp->mx);
2100             }
2101
2102             /* actually, we only know that buffer is clean if ref
2103              * count is 1, since we don't have buffer itself locked.
2104              */
2105             if (!(bp->flags & CM_BUF_DIRTY) && !(bp->qFlags & CM_BUF_QREDIR)) {
2106                 lock_ObtainWrite(&buf_globalLock);
2107                 if (!(bp->flags & CM_BUF_DIRTY) && !(bp->qFlags & CM_BUF_QREDIR)) {
2108                     if (bp->refCount == 1) {    /* bp is held above */
2109                         nbp = bp->fileHashp;
2110                         if (nbp)
2111                             buf_HoldLocked(nbp);
2112                         buf_ReleaseLocked(bp, TRUE);
2113                         didRelease = 1;
2114                         buf_Recycle(bp);
2115                     }
2116                 }
2117                 lock_ReleaseWrite(&buf_globalLock);
2118             }
2119         }
2120
2121       skip:
2122         if (!didRelease) {
2123             lock_ObtainRead(&buf_globalLock);
2124             nbp = bp->fileHashp;
2125             if (nbp)
2126                 buf_HoldLocked(nbp);
2127             buf_ReleaseLocked(bp, FALSE);
2128             lock_ReleaseRead(&buf_globalLock);
2129         }
2130     }   /* for loop over a bunch of buffers */
2131
2132     if (stable)
2133         (*cm_buf_opsp->Unstabilizep)(scp, userp);
2134
2135 #ifdef TESTING
2136     buf_ValidateBufQueues();
2137 #endif /* TESTING */
2138
2139     /* done */
2140     return code;
2141 }
2142
2143 /* Must be called with scp->rw held */
2144 long buf_InvalidateBuffers(cm_scache_t * scp)
2145 {
2146     cm_buf_t * bp;
2147     afs_uint32 i;
2148     int found = 0;
2149
2150     lock_AssertAny(&scp->rw);
2151
2152     i = BUF_FILEHASH(&scp->fid);
2153
2154     lock_ObtainRead(&buf_globalLock);
2155
2156     for (bp = cm_data.buf_fileHashTablepp[i]; bp; bp = bp->fileHashp) {
2157         if (cm_FidCmp(&bp->fid, &scp->fid) == 0) {
2158             bp->dataVersion = CM_BUF_VERSION_BAD;
2159             found = 1;
2160         }
2161     }
2162     lock_ReleaseRead(&buf_globalLock);
2163
2164     if (found)
2165         return 0;
2166     else
2167         return ENOENT;
2168 }
2169
2170 /* Must be called with scp->rw held */
2171 long buf_ForceDataVersion(cm_scache_t * scp, afs_uint64 fromVersion, afs_uint64 toVersion)
2172 {
2173     cm_buf_t * bp;
2174     afs_uint32 i;
2175     int found = 0;
2176
2177     lock_AssertAny(&scp->rw);
2178
2179     i = BUF_FILEHASH(&scp->fid);
2180
2181     lock_ObtainRead(&buf_globalLock);
2182
2183     for (bp = cm_data.buf_fileHashTablepp[i]; bp; bp = bp->fileHashp) {
2184         if (cm_FidCmp(&bp->fid, &scp->fid) == 0) {
2185             if (bp->dataVersion == fromVersion) {
2186                 bp->dataVersion = toVersion;
2187                 found = 1;
2188             }
2189         }
2190     }
2191     lock_ReleaseRead(&buf_globalLock);
2192
2193     if (found)
2194         return 0;
2195     else
2196         return ENOENT;
2197 }
2198
2199 long buf_CleanVnode(struct cm_scache *scp, cm_user_t *userp, cm_req_t *reqp)
2200 {
2201     long code = 0;
2202     long wasDirty = 0;
2203     cm_buf_t *bp;               /* buffer we're hacking on */
2204     cm_buf_t *nbp;              /* next one */
2205     afs_uint32 i;
2206
2207     if (RDR_Initialized && scp->redirBufCount > 0) {
2208         /* Retrieve all extents for this file from the redirector */
2209         buf_RDRShakeFileExtentsFree(scp, reqp);
2210     }
2211
2212     i = BUF_FILEHASH(&scp->fid);
2213
2214     lock_ObtainRead(&buf_globalLock);
2215     bp = cm_data.buf_fileHashTablepp[i];
2216     if (bp)
2217         buf_HoldLocked(bp);
2218     lock_ReleaseRead(&buf_globalLock);
2219     for (; bp; bp = nbp) {
2220         /* clean buffer synchronously */
2221         if (cm_FidCmp(&bp->fid, &scp->fid) == 0) {
2222             /*
2223              * If the buffer is held by the redirector we must fetch
2224              * it back in order to determine whether or not it is in
2225              * fact dirty.
2226              */
2227             lock_ObtainRead(&buf_globalLock);
2228             if (bp->qFlags & CM_BUF_QREDIR) {
2229                 osi_Log1(buf_logp,"buf_CleanVnode buffer held by redirector bp 0x%p", bp);
2230
2231                 /* Retrieve single extent from the redirector */
2232                 buf_RDRShakeAnExtentFree(bp, reqp);
2233             }
2234             lock_ReleaseRead(&buf_globalLock);
2235
2236             lock_ObtainMutex(&bp->mx);
2237             if ((bp->flags & CM_BUF_DIRTY)) {
2238                 if (userp && userp != bp->userp) {
2239                     cm_HoldUser(userp);
2240                     if (bp->userp)
2241                         cm_ReleaseUser(bp->userp);
2242                     bp->userp = userp;
2243                 }
2244
2245                 switch (code) {
2246                 case CM_ERROR_NOSUCHFILE:
2247                 case CM_ERROR_BADFD:
2248                 case CM_ERROR_NOACCESS:
2249                 case CM_ERROR_QUOTA:
2250                 case CM_ERROR_SPACE:
2251                 case CM_ERROR_TOOBIG:
2252                 case CM_ERROR_READONLY:
2253                 case CM_ERROR_NOSUCHPATH:
2254                 case EIO:
2255                     /*
2256                      * Apply the previous fatal error to this buffer.
2257                      * Do not waste the time attempting to store to
2258                      * the file server when we know it will fail.
2259                      */
2260                     _InterlockedAnd(&bp->flags, ~CM_BUF_DIRTY);
2261                     _InterlockedOr(&bp->flags, CM_BUF_ERROR);
2262                     bp->dirty_length = 0;
2263                     bp->error = code;
2264                     bp->dataVersion = CM_BUF_VERSION_BAD;
2265                     bp->dirtyCounter++;
2266                     break;
2267                 case CM_ERROR_TIMEDOUT:
2268                 case CM_ERROR_ALLDOWN:
2269                 case CM_ERROR_ALLBUSY:
2270                 case CM_ERROR_ALLOFFLINE:
2271                 case CM_ERROR_CLOCKSKEW:
2272                     /* do not mark the buffer in error state but do
2273                      * not attempt to complete the rest either.
2274                      */
2275                     break;
2276                 default:
2277                     code = buf_CleanLocked(scp, bp, reqp, 0, &wasDirty);
2278                     if (bp->flags & CM_BUF_ERROR) {
2279                         code = bp->error;
2280                         if (code == 0)
2281                             code = -1;
2282                     }
2283                 }
2284                 buf_CleanWait(scp, bp, TRUE);
2285             }
2286             lock_ReleaseMutex(&bp->mx);
2287         }
2288
2289         lock_ObtainRead(&buf_globalLock);
2290         nbp = bp->fileHashp;
2291         if (nbp)
2292             buf_HoldLocked(nbp);
2293         buf_ReleaseLocked(bp, FALSE);
2294         lock_ReleaseRead(&buf_globalLock);
2295     }   /* for loop over a bunch of buffers */
2296
2297 #ifdef TESTING
2298     buf_ValidateBufQueues();
2299 #endif /* TESTING */
2300
2301     /* done */
2302     return code;
2303 }
2304
2305 #ifdef TESTING
2306 void
2307 buf_ValidateBufQueues(void)
2308 {
2309     cm_buf_t * bp, *bpb, *bpf, *bpa;
2310     afs_uint32 countf=0, countb=0, counta=0;
2311
2312     lock_ObtainRead(&buf_globalLock);
2313     for (bp = cm_data.buf_freeListEndp; bp; bp=(cm_buf_t *) osi_QPrev(&bp->q)) {
2314         if (bp->magic != CM_BUF_MAGIC)
2315             osi_panic("buf magic error",__FILE__,__LINE__);
2316         countb++;
2317         bpb = bp;
2318     }
2319
2320     for (bp = cm_data.buf_freeListp; bp; bp=(cm_buf_t *) osi_QNext(&bp->q)) {
2321         if (bp->magic != CM_BUF_MAGIC)
2322             osi_panic("buf magic error",__FILE__,__LINE__);
2323         countf++;
2324         bpf = bp;
2325     }
2326
2327     for (bp = cm_data.buf_allp; bp; bp=bp->allp) {
2328         if (bp->magic != CM_BUF_MAGIC)
2329             osi_panic("buf magic error",__FILE__,__LINE__);
2330         counta++;
2331         bpa = bp;
2332     }
2333     lock_ReleaseRead(&buf_globalLock);
2334
2335     if (countb != countf)
2336         osi_panic("buf magic error",__FILE__,__LINE__);
2337
2338     if (counta != cm_data.buf_nbuffers)
2339         osi_panic("buf magic error",__FILE__,__LINE__);
2340 }
2341 #endif /* TESTING */
2342
2343 /* dump the contents of the buf_scacheHashTablepp. */
2344 int cm_DumpBufHashTable(FILE *outputFile, char *cookie, int lock)
2345 {
2346     int zilch;
2347     cm_buf_t *bp;
2348     char output[1024];
2349     afs_uint32 i;
2350
2351     if (cm_data.buf_scacheHashTablepp == NULL)
2352         return -1;
2353
2354     if (lock)
2355         lock_ObtainRead(&buf_globalLock);
2356
2357     StringCbPrintfA(output, sizeof(output), "%s - dumping buf_HashTable - buf_hashSize=%d\r\n",
2358                     cookie, cm_data.buf_hashSize);
2359     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2360
2361     for (i = 0; i < cm_data.buf_hashSize; i++)
2362     {
2363         for (bp = cm_data.buf_scacheHashTablepp[i]; bp; bp=bp->hashp)
2364         {
2365             StringCbPrintfA(output, sizeof(output),
2366                             "%s bp=0x%08X, hash=%d, fid (cell=%d, volume=%d, "
2367                             "vnode=%d, unique=%d), offset=%x:%08x, dv=%I64d, "
2368                             "flags=0x%x, qFlags=0x%x cmFlags=0x%x, error=0x%x, refCount=%d\r\n",
2369                              cookie, (void *)bp, i, bp->fid.cell, bp->fid.volume,
2370                              bp->fid.vnode, bp->fid.unique, bp->offset.HighPart,
2371                              bp->offset.LowPart, bp->dataVersion, bp->flags, bp->qFlags,
2372                              bp->cmFlags, bp->error, bp->refCount);
2373             WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2374         }
2375     }
2376
2377     StringCbPrintfA(output, sizeof(output), "%s - Done dumping buf_HashTable.\r\n", cookie);
2378     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2379
2380     StringCbPrintfA(output, sizeof(output), "%s - dumping buf_freeListEndp\r\n", cookie);
2381     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2382     for(bp = cm_data.buf_freeListEndp; bp; bp=(cm_buf_t *) osi_QPrev(&bp->q)) {
2383         StringCbPrintfA(output, sizeof(output),
2384                          "%s bp=0x%08X, fid (cell=%d, volume=%d, "
2385                          "vnode=%d, unique=%d), offset=%x:%08x, dv=%I64d, "
2386                          "flags=0x%x, qFlags=0x%x, cmFlags=0x%x, error=0x%x, refCount=%d\r\n",
2387                          cookie, (void *)bp, bp->fid.cell, bp->fid.volume,
2388                          bp->fid.vnode, bp->fid.unique, bp->offset.HighPart,
2389                          bp->offset.LowPart, bp->dataVersion, bp->flags, bp->qFlags,
2390                          bp->cmFlags, bp->error, bp->refCount);
2391         WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2392     }
2393     StringCbPrintfA(output, sizeof(output), "%s - Done dumping buf_FreeListEndp.\r\n", cookie);
2394     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2395
2396     StringCbPrintfA(output, sizeof(output), "%s - dumping buf_dirtyListp\r\n", cookie);
2397     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2398     for(bp = cm_data.buf_dirtyListp; bp; bp=bp->dirtyp) {
2399         StringCbPrintfA(output, sizeof(output),
2400                          "%s bp=0x%08X, fid (cell=%d, volume=%d, "
2401                          "vnode=%d, unique=%d), offset=%x:%08x, dv=%I64d, "
2402                          "flags=0x%x, qFlags=0x%x, cmFlags=0x%x, error=0x%x, refCount=%d\r\n",
2403                          cookie, (void *)bp, bp->fid.cell, bp->fid.volume,
2404                          bp->fid.vnode, bp->fid.unique, bp->offset.HighPart,
2405                          bp->offset.LowPart, bp->dataVersion, bp->flags, bp->qFlags,
2406                          bp->cmFlags, bp->error, bp->refCount);
2407         WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2408     }
2409     StringCbPrintfA(output, sizeof(output), "%s - Done dumping buf_dirtyListp.\r\n", cookie);
2410     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2411
2412     if (lock)
2413         lock_ReleaseRead(&buf_globalLock);
2414     return 0;
2415 }
2416
2417 void buf_ForceTrace(BOOL flush)
2418 {
2419     HANDLE handle;
2420     int len;
2421     char buf[256];
2422
2423     if (!buf_logp)
2424         return;
2425
2426     len = GetTempPath(sizeof(buf)-10, buf);
2427     StringCbCopyA(&buf[len], sizeof(buf)-len, "/afs-buffer.log");
2428     handle = CreateFile(buf, GENERIC_WRITE, FILE_SHARE_READ,
2429                             NULL, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
2430     if (handle == INVALID_HANDLE_VALUE) {
2431         osi_panic("Cannot create log file", __FILE__, __LINE__);
2432     }
2433     osi_LogPrint(buf_logp, handle);
2434     if (flush)
2435         FlushFileBuffers(handle);
2436     CloseHandle(handle);
2437 }
2438
2439 long buf_DirtyBuffersExist(cm_fid_t *fidp)
2440 {
2441     cm_buf_t *bp;
2442     afs_uint32 bcount = 0;
2443     afs_uint32 i;
2444     long found = 0;
2445
2446     i = BUF_FILEHASH(fidp);
2447
2448     lock_ObtainRead(&buf_globalLock);
2449     for (bp = cm_data.buf_fileHashTablepp[i]; bp; bp=bp->fileHashp, bcount++) {
2450         if (!cm_FidCmp(fidp, &bp->fid) && (bp->flags & CM_BUF_DIRTY)) {
2451             found = 1;
2452             break;
2453         }
2454     }
2455     lock_ReleaseRead(&buf_globalLock);
2456     return found;
2457 }
2458
2459 long buf_RDRBuffersExist(cm_fid_t *fidp)
2460 {
2461     cm_buf_t *bp;
2462     afs_uint32 bcount = 0;
2463     afs_uint32 i;
2464     long found = 0;
2465
2466     if (!RDR_Initialized)
2467         return 0;
2468
2469     i = BUF_FILEHASH(fidp);
2470
2471     lock_ObtainRead(&buf_globalLock);
2472     for (bp = cm_data.buf_fileHashTablepp[i]; bp; bp=bp->fileHashp, bcount++) {
2473         if (!cm_FidCmp(fidp, &bp->fid) && (bp->qFlags & CM_BUF_QREDIR)) {
2474             found = 1;
2475             break;
2476         }
2477     }
2478     lock_ReleaseRead(&buf_globalLock);
2479     return 0;
2480 }
2481
2482 long buf_ClearRDRFlag(cm_scache_t *scp, char *reason)
2483 {
2484     cm_fid_t *fidp = &scp->fid;
2485     cm_buf_t *bp;
2486     afs_uint32 bcount = 0;
2487     afs_uint32 i;
2488
2489     i = BUF_FILEHASH(fidp);
2490
2491     lock_ObtainWrite(&scp->rw);
2492     lock_ObtainRead(&buf_globalLock);
2493     for (bp = cm_data.buf_fileHashTablepp[i]; bp; bp=bp->fileHashp, bcount++) {
2494         if (!cm_FidCmp(fidp, &bp->fid) && (bp->qFlags & CM_BUF_QREDIR)) {
2495             lock_ConvertRToW(&buf_globalLock);
2496             if (bp->qFlags & CM_BUF_QREDIR) {
2497                 osi_Log4(buf_logp,"buf_ClearRDRFlag taking from file system bp 0x%p vno 0x%x foffset 0x%x:%x",
2498                           bp, bp->fid.vnode, bp->offset.HighPart, bp->offset.LowPart);
2499                 buf_RemoveFromRedirQueue(scp, bp);
2500                 buf_ReleaseLocked(bp, TRUE);
2501             }
2502             lock_ConvertWToR(&buf_globalLock);
2503         }
2504     }
2505
2506     /* Confirm that there are none left */
2507     lock_ConvertRToW(&buf_globalLock);
2508     for ( bp = redirq_to_cm_buf_t(scp->redirQueueT);
2509           bp;
2510           bp = redirq_to_cm_buf_t(scp->redirQueueT))
2511     {
2512         if (bp->qFlags & CM_BUF_QREDIR) {
2513             osi_Log4(buf_logp,"buf_ClearRDRFlag taking from file system bufp 0x%p vno 0x%x foffset 0x%x:%x",
2514                       bp, bp->fid.vnode, bp->offset.HighPart, bp->offset.LowPart);
2515             buf_RemoveFromRedirQueue(scp, bp);
2516             buf_ReleaseLocked(bp, TRUE);
2517         }
2518
2519     }
2520     lock_ReleaseWrite(&buf_globalLock);
2521     lock_ReleaseWrite(&scp->rw);
2522     return 0;
2523 }
2524
2525 #if 0
2526 long buf_CleanDirtyBuffers(cm_scache_t *scp)
2527 {
2528     cm_buf_t *bp;
2529     afs_uint32 bcount = 0;
2530     cm_fid_t * fidp = &scp->fid;
2531
2532     for (bp = cm_data.buf_allp; bp; bp=bp->allp, bcount++) {
2533         if (!cm_FidCmp(fidp, &bp->fid) && (bp->flags & CM_BUF_DIRTY)) {
2534             buf_Hold(bp);
2535             lock_ObtainMutex(&bp->mx);
2536             _InterlockedAnd(&bp->cmFlags, ~CM_BUF_CMSTORING);
2537             _InterlockedAnd(&bp->flags, ~CM_BUF_DIRTY);
2538             bp->dirty_length = 0;
2539             _InterlockedOr(&bp->flags, CM_BUF_ERROR);
2540             bp->error = VNOVNODE;
2541             bp->dataVersion = CM_BUF_VERSION_BAD; /* bad */
2542             bp->dirtyCounter++;
2543             if (bp->flags & CM_BUF_WAITING) {
2544                 osi_Log2(buf_logp, "BUF CleanDirtyBuffers Waking [scp 0x%x] bp 0x%x", scp, bp);
2545                 osi_Wakeup((long) &bp);
2546             }
2547             lock_ReleaseMutex(&bp->mx);
2548             buf_Release(bp);
2549         }
2550     }
2551     return 0;
2552 }
2553 #endif
2554
2555 /*
2556  * The following routines will not be used on a
2557  * regular basis but are very useful in a variety
2558  * of scenarios when debugging data corruption.
2559  */
2560 const char *
2561 buf_HexCheckSum(cm_buf_t * bp)
2562 {
2563     int i, k;
2564     static char buf[33];
2565     static char tr[16] = {'0','1','2','3','4','5','6','7','8','9','A','B','C','D','E','F'};
2566
2567     for (i=0;i<16;i++) {
2568         k = bp->md5cksum[i];
2569
2570         buf[i*2] = tr[k / 16];
2571         buf[i*2+1] = tr[k % 16];
2572     }
2573     buf[32] = '\0';
2574
2575     return buf;
2576 }
2577
2578 void
2579 buf_ComputeCheckSum(cm_buf_t * bp)
2580 {
2581     MD5_CTX md5;
2582
2583     MD5_Init(&md5);
2584     MD5_Update(&md5, bp->datap, cm_data.blockSize);
2585     MD5_Final(bp->md5cksum, &md5);
2586
2587     osi_Log4(buf_logp, "CheckSum bp 0x%p md5 %s, dirty: offset %u length %u",
2588              bp, osi_LogSaveString(buf_logp, buf_HexCheckSum(bp)),
2589              bp->dirty_offset, bp->dirty_length);
2590 }
2591
2592 int
2593 buf_ValidateCheckSum(cm_buf_t * bp)
2594 {
2595     MD5_CTX md5;
2596     unsigned char tmp[16];
2597
2598     MD5_Init(&md5);
2599     MD5_Update(&md5, bp->datap, cm_data.blockSize);
2600     MD5_Final(tmp, &md5);
2601
2602     if (memcmp(tmp, bp->md5cksum, 16) == 0)
2603         return 1;
2604     return 0;
2605 }
2606
2607 void
2608 buf_InsertToRedirQueue(cm_scache_t *scp, cm_buf_t *bufp)
2609 {
2610     lock_AssertWrite(&buf_globalLock);
2611
2612     if (scp) {
2613         lock_ObtainMutex(&scp->redirMx);
2614     }
2615
2616     if (bufp->qFlags & CM_BUF_QINLRU) {
2617         _InterlockedAnd(&bufp->qFlags, ~CM_BUF_QINLRU);
2618         osi_QRemoveHT( (osi_queue_t **) &cm_data.buf_freeListp,
2619                        (osi_queue_t **) &cm_data.buf_freeListEndp,
2620                        &bufp->q);
2621         buf_DecrementFreeCount();
2622     }
2623     _InterlockedOr(&bufp->qFlags, CM_BUF_QREDIR);
2624     osi_QAddH( (osi_queue_t **) &cm_data.buf_redirListp,
2625                (osi_queue_t **) &cm_data.buf_redirListEndp,
2626                &bufp->q);
2627     buf_IncrementRedirCount();
2628     bufp->redirLastAccess = time(NULL);
2629     if (scp) {
2630         osi_QAddH( (osi_queue_t **) &scp->redirQueueH,
2631                    (osi_queue_t **) &scp->redirQueueT,
2632                    &bufp->redirq);
2633         scp->redirLastAccess = bufp->redirLastAccess;
2634         InterlockedIncrement(&scp->redirBufCount);
2635
2636         lock_ReleaseMutex(&scp->redirMx);
2637     }
2638 }
2639
2640 void
2641 buf_RemoveFromRedirQueue(cm_scache_t *scp, cm_buf_t *bufp)
2642 {
2643     lock_AssertWrite(&buf_globalLock);
2644
2645     if (!(bufp->qFlags & CM_BUF_QREDIR))
2646         return;
2647
2648     if (scp) {
2649         lock_ObtainMutex(&scp->redirMx);
2650     }
2651
2652     _InterlockedAnd(&bufp->qFlags, ~CM_BUF_QREDIR);
2653     osi_QRemoveHT( (osi_queue_t **) &cm_data.buf_redirListp,
2654                    (osi_queue_t **) &cm_data.buf_redirListEndp,
2655                    &bufp->q);
2656     buf_DecrementRedirCount();
2657
2658     if (scp) {
2659         osi_QRemoveHT( (osi_queue_t **) &scp->redirQueueH,
2660                        (osi_queue_t **) &scp->redirQueueT,
2661                        &bufp->redirq);
2662
2663         InterlockedDecrement(&scp->redirBufCount);
2664         lock_ReleaseMutex(&scp->redirMx);
2665     }
2666 }
2667
2668 void
2669 buf_MoveToHeadOfRedirQueue(cm_scache_t *scp, cm_buf_t *bufp)
2670 {
2671     lock_AssertWrite(&buf_globalLock);
2672     if (!(bufp->qFlags & CM_BUF_QREDIR))
2673         return;
2674
2675     if (scp) {
2676         lock_ObtainMutex(&scp->redirMx);
2677     }
2678
2679     osi_QRemoveHT( (osi_queue_t **) &cm_data.buf_redirListp,
2680                    (osi_queue_t **) &cm_data.buf_redirListEndp,
2681                    &bufp->q);
2682     osi_QAddH( (osi_queue_t **) &cm_data.buf_redirListp,
2683                (osi_queue_t **) &cm_data.buf_redirListEndp,
2684                &bufp->q);
2685     bufp->redirLastAccess = time(NULL);
2686     if (scp) {
2687         osi_QRemoveHT( (osi_queue_t **) &scp->redirQueueH,
2688                        (osi_queue_t **) &scp->redirQueueT,
2689                        &bufp->redirq);
2690         osi_QAddH( (osi_queue_t **) &scp->redirQueueH,
2691                    (osi_queue_t **) &scp->redirQueueT,
2692                    &bufp->redirq);
2693         scp->redirLastAccess = bufp->redirLastAccess;
2694
2695         lock_ReleaseMutex(&scp->redirMx);
2696     }
2697 }