Windows: buf redir queue mgmt scp can be null
[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 (scp->flags & CM_SCACHEFLAG_WAITING) {
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
821     while ((bp->flags & CM_BUF_DIRTY) == CM_BUF_DIRTY) {
822         isdirty = 1;
823         lock_ReleaseMutex(&bp->mx);
824
825         if (!scp) {
826             /*
827              * If we didn't find a cm_scache_t object for bp->fid it means
828              * that we no longer have that FID in the cache.  It does not
829              * mean that the object does not exist in the cell.  That may
830              * in fact be the case but we don't know that until we attempt
831              * a FetchStatus on the FID.
832              */
833             osi_Log1(buf_logp, "buf_CleanLocked unable to start I/O - scp not found buf 0x%p", bp);
834             code = CM_ERROR_NOSUCHFILE;
835         } else {
836             osi_Log2(buf_logp, "buf_CleanLocked starts I/O on scp 0x%p buf 0x%p", scp, bp);
837
838             offset = bp->offset;
839             LargeIntegerAdd(offset, ConvertLongToLargeInteger(bp->dirty_offset));
840             /*
841              * Only specify the dirty length of the current buffer in the call
842              * to cm_BufWrite().  It is the responsibility of cm_BufWrite()
843              * to determine if it is appropriate to fill a full chunk of data
844              * when storing to the file server.
845              */
846             code = (*cm_buf_opsp->Writep)(scp, &offset,
847                                           bp->dirty_length,
848                                           flags, bp->userp, reqp);
849             osi_Log3(buf_logp, "buf_CleanLocked I/O on scp 0x%p buf 0x%p, done=%d", scp, bp, code);
850         }
851         lock_ObtainMutex(&bp->mx);
852         /* if the Write routine returns No Such File, clear the dirty flag
853          * because we aren't going to be able to write this data to the file
854          * server.
855          */
856         if (code == CM_ERROR_NOSUCHFILE || code == CM_ERROR_BADFD || code == CM_ERROR_NOACCESS ||
857             code == CM_ERROR_QUOTA || code == CM_ERROR_SPACE || code == CM_ERROR_TOOBIG ||
858             code == CM_ERROR_READONLY || code == CM_ERROR_NOSUCHPATH){
859             _InterlockedAnd(&bp->flags, ~CM_BUF_DIRTY);
860             _InterlockedOr(&bp->flags, CM_BUF_ERROR);
861             bp->dirty_offset = 0;
862             bp->dirty_length = 0;
863             bp->error = code;
864             bp->dataVersion = CM_BUF_VERSION_BAD;
865             bp->dirtyCounter++;
866             break;
867         }
868
869 #ifdef DISKCACHE95
870         /* Disk cache support */
871         /* write buffer to disk cache (synchronous for now) */
872         diskcache_Update(bp->dcp, bp->datap, cm_data.buf_blockSize, bp->dataVersion);
873 #endif /* DISKCACHE95 */
874
875         /* if we get here and retries are not permitted
876          * then we need to exit this loop regardless of
877          * whether or not we were able to clear the dirty bit
878          */
879         if (reqp->flags & CM_REQ_NORETRY)
880             break;
881
882         /* Ditto if the hardDeadTimeout or idleTimeout was reached */
883         if (code == CM_ERROR_TIMEDOUT || code == CM_ERROR_ALLDOWN ||
884             code == CM_ERROR_ALLBUSY || code == CM_ERROR_ALLOFFLINE ||
885             code == CM_ERROR_CLOCKSKEW) {
886             break;
887         }
888     }
889
890     if (release_scp)
891         cm_ReleaseSCache(scp);
892
893     /* if someone was waiting for the I/O that just completed or failed,
894      * wake them up.
895      */
896     if (bp->flags & CM_BUF_WAITING) {
897         /* turn off flags and wakeup users */
898         osi_Log1(buf_logp, "buf_WaitIO Waking bp 0x%p", bp);
899         osi_Wakeup((LONG_PTR) bp);
900     }
901
902     if (pisdirty)
903         *pisdirty = isdirty;
904
905     return code;
906 }
907
908 /* Called with a zero-ref count buffer and with the buf_globalLock write locked.
909  * recycles the buffer, and leaves it ready for reuse with a ref count of 0.
910  * The buffer must already be clean, and no I/O should be happening to it.
911  */
912 void buf_Recycle(cm_buf_t *bp)
913 {
914     afs_uint32 i;
915     cm_buf_t **lbpp;
916     cm_buf_t *tbp;
917     cm_buf_t *prevBp, *nextBp;
918
919     osi_assertx(bp->magic == CM_BUF_MAGIC, "invalid cm_buf_t magic");
920
921     osi_assertx(!(bp->qFlags & CM_BUF_QREDIR), "can't recycle redir held buffers");
922
923     /* if we get here, we know that the buffer still has a 0 ref count,
924      * and that it is clean and has no currently pending I/O.  This is
925      * the dude to return.
926      * Remember that as long as the ref count is 0, we know that we won't
927      * have any lock conflicts, so we can grab the buffer lock out of
928      * order in the locking hierarchy.
929      */
930     osi_Log3( buf_logp, "buf_Recycle recycles 0x%p, off 0x%x:%08x",
931               bp, bp->offset.HighPart, bp->offset.LowPart);
932
933     osi_assertx(bp->refCount == 0, "cm_buf_t refcount != 0");
934     osi_assertx(!(bp->flags & (CM_BUF_READING | CM_BUF_WRITING | CM_BUF_DIRTY)),
935                 "incorrect cm_buf_t flags");
936     lock_AssertWrite(&buf_globalLock);
937
938     if (bp->qFlags & CM_BUF_QINHASH) {
939         /* Remove from hash */
940
941         i = BUF_HASH(&bp->fid, &bp->offset);
942         lbpp = &(cm_data.buf_scacheHashTablepp[i]);
943         for(tbp = *lbpp; tbp; lbpp = &tbp->hashp, tbp = tbp->hashp) {
944             if (tbp == bp)
945                 break;
946         }
947
948         /* we better find it */
949         osi_assertx(tbp != NULL, "buf_Recycle: hash table screwup");
950
951         *lbpp = bp->hashp;      /* hash out */
952         bp->hashp = NULL;
953
954         /* Remove from file hash */
955
956         i = BUF_FILEHASH(&bp->fid);
957         prevBp = bp->fileHashBackp;
958         bp->fileHashBackp = NULL;
959         nextBp = bp->fileHashp;
960         bp->fileHashp = NULL;
961         if (prevBp)
962             prevBp->fileHashp = nextBp;
963         else
964             cm_data.buf_fileHashTablepp[i] = nextBp;
965         if (nextBp)
966             nextBp->fileHashBackp = prevBp;
967
968         _InterlockedAnd(&bp->qFlags, ~CM_BUF_QINHASH);
969     }
970
971     /* make the fid unrecognizable */
972     memset(&bp->fid, 0, sizeof(cm_fid_t));
973
974     /* clean up junk flags */
975     _InterlockedAnd(&bp->flags, ~(CM_BUF_EOF | CM_BUF_ERROR));
976     bp->dataVersion = CM_BUF_VERSION_BAD;       /* unknown so far */
977 }
978
979
980 /*
981  * buf_RDRShakeAnExtentFree
982  * called with buf_globalLock read locked
983  */
984 afs_uint32
985 buf_RDRShakeAnExtentFree(cm_buf_t *rbp, cm_req_t *reqp)
986 {
987     afs_uint32 code = 0;
988     LARGE_INTEGER heldExtents = {0,0};
989     AFSFileExtentCB extentList[1];
990     DWORD extentCount = 0;
991     BOOL locked = FALSE;
992
993     if (!(rbp->qFlags & CM_BUF_QREDIR))
994         return 0;
995
996     lock_ReleaseRead(&buf_globalLock);
997
998     if (!lock_TryMutex(&buf_rdrReleaseExtentsLock)) {
999         osi_Log0(afsd_logp, "Waiting for prior RDR_RequestExtentRelease request to complete");
1000         if (reqp->flags & CM_REQ_NORETRY) {
1001             code = CM_ERROR_WOULDBLOCK;
1002             goto done;
1003         }
1004
1005         lock_ObtainMutex(&buf_rdrReleaseExtentsLock);
1006     }
1007
1008     extentList[0].Flags = 0;
1009     extentList[0].Length = cm_data.blockSize;
1010     extentList[0].FileOffset.QuadPart = rbp->offset.QuadPart;
1011     extentList[0].CacheOffset.QuadPart = rbp->datap - cm_data.baseAddress;
1012     extentCount = 1;
1013
1014     code = RDR_RequestExtentRelease(&rbp->fid, heldExtents, extentCount, extentList);
1015
1016     lock_ReleaseMutex(&buf_rdrReleaseExtentsLock);
1017
1018   done:
1019     lock_ObtainRead(&buf_globalLock);
1020     return code;
1021 }
1022
1023 /*
1024  * buf_RDRShakeFileExtentsFree
1025  * requests all extents held by the redirector to be returned for
1026  * the specified cm_scache_t.  This function is called with no
1027  * locks held.
1028  */
1029 afs_uint32
1030 buf_RDRShakeFileExtentsFree(cm_scache_t *rscp, cm_req_t *reqp)
1031 {
1032     afs_uint32 code = 0;
1033     afs_uint64 n_redir = 0;
1034
1035     if (!lock_TryMutex(&buf_rdrReleaseExtentsLock)) {
1036         osi_Log0(afsd_logp, "Waiting for prior RDR_RequestExtentRelease request to complete");
1037         if (reqp->flags & CM_REQ_NORETRY)
1038             return CM_ERROR_WOULDBLOCK;
1039
1040         lock_ObtainMutex(&buf_rdrReleaseExtentsLock);
1041     }
1042
1043     for ( code = CM_ERROR_RETRY; code == CM_ERROR_RETRY; ) {
1044         LARGE_INTEGER heldExtents = {0,0};
1045         AFSFileExtentCB extentList[1024];
1046         DWORD extentCount = 0;
1047         cm_buf_t *srbp;
1048         time_t now;
1049
1050         /* only retry if a call to RDR_RequestExtentRelease says to */
1051         code = 0;
1052         lock_ObtainWrite(&buf_globalLock);
1053
1054         if (rscp->redirBufCount == 0)
1055         {
1056             lock_ReleaseWrite(&buf_globalLock);
1057             break;
1058         }
1059
1060         time(&now);
1061         for ( srbp = redirq_to_cm_buf_t(rscp->redirQueueT);
1062               srbp;
1063               srbp = ((code == 0 && extentCount == 0) ? redirq_to_cm_buf_t(rscp->redirQueueT) :
1064                        redirq_to_cm_buf_t(osi_QPrev(&srbp->redirq))))
1065         {
1066             extentList[extentCount].Flags = 0;
1067             extentList[extentCount].Length = cm_data.blockSize;
1068             extentList[extentCount].FileOffset.QuadPart = srbp->offset.QuadPart;
1069             extentList[extentCount].CacheOffset.QuadPart = srbp->datap - cm_data.baseAddress;
1070             srbp->redirReleaseRequested = now;
1071             extentCount++;
1072
1073             if (extentCount == 1024) {
1074                 lock_ReleaseWrite(&buf_globalLock);
1075                 heldExtents.QuadPart = cm_data.buf_redirCount;
1076                 code = RDR_RequestExtentRelease(&rscp->fid, heldExtents, extentCount, extentList);
1077                 if (code) {
1078                     if (code == CM_ERROR_RETRY) {
1079                         /*
1080                          * The redirector either is not holding the extents or cannot let them
1081                          * go because they are otherwise in use.  At the moment, do nothing.
1082                          */
1083                     } else
1084                         break;
1085                 }
1086                 extentCount = 0;
1087                 lock_ObtainWrite(&buf_globalLock);
1088             }
1089         }
1090         lock_ReleaseWrite(&buf_globalLock);
1091
1092         if (code == 0 && extentCount > 0) {
1093             heldExtents.QuadPart = cm_data.buf_redirCount;
1094             code = RDR_RequestExtentRelease(&rscp->fid, heldExtents, extentCount, extentList);
1095         }
1096
1097         if ((code == CM_ERROR_RETRY) && (reqp->flags & CM_REQ_NORETRY)) {
1098             code = CM_ERROR_WOULDBLOCK;
1099             break;
1100         }
1101     }
1102     lock_ReleaseMutex(&buf_rdrReleaseExtentsLock);
1103     return code;
1104 }
1105
1106 afs_uint32
1107 buf_RDRShakeSomeExtentsFree(cm_req_t *reqp, afs_uint32 oneFid, afs_uint32 minage)
1108 {
1109     afs_uint32 code = 0;
1110
1111     if (!lock_TryMutex(&buf_rdrReleaseExtentsLock)) {
1112         if (reqp->flags & CM_REQ_NORETRY)
1113             return CM_ERROR_WOULDBLOCK;
1114
1115         osi_Log0(afsd_logp, "Waiting for prior RDR_RequestExtentRelease request to complete");
1116         lock_ObtainMutex(&buf_rdrReleaseExtentsLock);
1117     }
1118
1119     for ( code = CM_ERROR_RETRY; code == CM_ERROR_RETRY; ) {
1120         LARGE_INTEGER heldExtents;
1121         AFSFileExtentCB extentList[1024];
1122         DWORD extentCount = 0;
1123         cm_buf_t *rbp, *srbp;
1124         cm_scache_t *rscp;
1125         time_t now;
1126         BOOL locked = FALSE;
1127
1128         /* only retry if a call to RDR_RequestExtentRelease says to */
1129         code = 0;
1130         lock_ObtainWrite(&buf_globalLock);
1131         locked = TRUE;
1132
1133         for ( rbp = cm_data.buf_redirListEndp;
1134               code == 0 && rbp && (!oneFid || extentCount == 0);
1135               rbp = (cm_buf_t *) osi_QPrev(&rbp->q))
1136         {
1137             if (!oneFid)
1138                 extentCount = 0;
1139
1140             if (rbp->redirLastAccess >= rbp->redirReleaseRequested) {
1141                 rscp = cm_FindSCache(&rbp->fid);
1142                 if (!rscp)
1143                     continue;
1144
1145                 time(&now);
1146                 for ( srbp = redirq_to_cm_buf_t(rscp->redirQueueT);
1147                       srbp && extentCount < 1024;
1148                       srbp = redirq_to_cm_buf_t(osi_QPrev(&srbp->redirq)))
1149                 {
1150                     /*
1151                      * Do not request a release if we have already done so
1152                      * or if the extent was delivered to windows less than
1153                      * 'minage' seconds ago.
1154                      */
1155                     if (srbp->redirLastAccess >= srbp->redirReleaseRequested &&
1156                          srbp->redirLastAccess < now - minage) {
1157                         extentList[extentCount].Flags = 0;
1158                         extentList[extentCount].Length = cm_data.blockSize;
1159                         extentList[extentCount].FileOffset.QuadPart = srbp->offset.QuadPart;
1160                         extentList[extentCount].CacheOffset.QuadPart = srbp->datap - cm_data.baseAddress;
1161                         srbp->redirReleaseRequested = now;
1162                         extentCount++;
1163                     }
1164                 }
1165                 cm_ReleaseSCache(rscp);
1166             }
1167
1168             if ( !oneFid && extentCount > 0) {
1169                 if (locked) {
1170                     lock_ReleaseWrite(&buf_globalLock);
1171                     locked = FALSE;
1172                 }
1173                 heldExtents.QuadPart = cm_data.buf_redirCount;
1174                 code = RDR_RequestExtentRelease(&rbp->fid, heldExtents, extentCount, extentList);
1175             }
1176             if (!locked) {
1177                 lock_ObtainWrite(&buf_globalLock);
1178                 locked = TRUE;
1179             }
1180         }
1181         if (locked)
1182             lock_ReleaseWrite(&buf_globalLock);
1183         if (code == 0) {
1184             if (oneFid) {
1185                 heldExtents.QuadPart = cm_data.buf_redirCount;
1186                 if (rbp && extentCount)
1187                     code = RDR_RequestExtentRelease(&rbp->fid, heldExtents, extentCount, extentList);
1188                 else
1189                     code = RDR_RequestExtentRelease(NULL, heldExtents, 1024, NULL);
1190             } else {
1191                 code = 0;
1192             }
1193         }
1194
1195         if ((code == CM_ERROR_RETRY) && (reqp->flags & CM_REQ_NORETRY)) {
1196             code = CM_ERROR_WOULDBLOCK;
1197             break;
1198         }
1199     }
1200     lock_ReleaseMutex(&buf_rdrReleaseExtentsLock);
1201     return code;
1202 }
1203
1204 /* returns 0 if the buffer does not exist, and non-0 if it does */
1205 static long
1206 buf_ExistsLocked(struct cm_scache *scp, osi_hyper_t *offsetp)
1207 {
1208     cm_buf_t *bp;
1209
1210     if (bp = buf_FindLocked(&scp->fid, offsetp)) {
1211         /* Do not call buf_ReleaseLocked() because we
1212          * do not want to allow the buffer to be added
1213          * to the free list.
1214          */
1215         afs_int32 refCount = InterlockedDecrement(&bp->refCount);
1216 #ifdef DEBUG_REFCOUNT
1217         osi_Log2(afsd_logp,"buf_ExistsLocked bp 0x%p ref %d", bp, refCount);
1218         afsi_log("%s:%d buf_ExistsLocked bp 0x%p, ref %d", __FILE__, __LINE__, bp, refCount);
1219 #endif
1220         return CM_BUF_EXISTS;
1221     }
1222
1223     return 0;
1224 }
1225
1226 /* recycle a buffer, removing it from the free list, hashing in its new identity
1227  * and returning it write-locked so that no one can use it.  Called without
1228  * any locks held, and can return an error if it loses the race condition and
1229  * finds that someone else created the desired buffer.
1230  *
1231  * If success is returned, the buffer is returned write-locked.
1232  *
1233  * May be called with null scp and offsetp, if we're just trying to reclaim some
1234  * space from the buffer pool.  In that case, the buffer will be returned
1235  * without being hashed into the hash table.
1236  */
1237 long buf_GetNewLocked(struct cm_scache *scp, osi_hyper_t *offsetp, cm_req_t *reqp, cm_buf_t **bufpp)
1238 {
1239     cm_buf_t *bp;       /* buffer we're dealing with */
1240     cm_buf_t *nextBp;   /* next buffer in file hash chain */
1241     afs_uint32 i;       /* temp */
1242     afs_uint64 n_bufs, n_nonzero, n_busy, n_dirty, n_own, n_redir;
1243
1244 #ifdef TESTING
1245     buf_ValidateBufQueues();
1246 #endif /* TESTING */
1247
1248     while(1) {
1249       retry:
1250         n_bufs = 0;
1251         n_nonzero = 0;
1252         n_own = 0;
1253         n_busy = 0;
1254         n_dirty = 0;
1255         n_redir = 0;
1256
1257         lock_ObtainRead(&scp->bufCreateLock);
1258         lock_ObtainWrite(&buf_globalLock);
1259         /* check to see if we lost the race */
1260         if (buf_ExistsLocked(scp, offsetp)) {
1261             lock_ReleaseWrite(&buf_globalLock);
1262             lock_ReleaseRead(&scp->bufCreateLock);
1263             return CM_BUF_EXISTS;
1264         }
1265
1266         /* does this fix the problem below?  it's a simple solution. */
1267         if (!cm_data.buf_freeListEndp)
1268         {
1269             lock_ReleaseWrite(&buf_globalLock);
1270             lock_ReleaseRead(&scp->bufCreateLock);
1271
1272             if ( RDR_Initialized )
1273                 goto rdr_release;
1274
1275             osi_Log0(afsd_logp, "buf_GetNewLocked: Free Buffer List is empty - sleeping 200ms");
1276             Sleep(200);
1277             goto retry;
1278         }
1279
1280         /* for debugging, assert free list isn't empty, although we
1281          * really should try waiting for a running tranasction to finish
1282          * instead of this; or better, we should have a transaction
1283          * throttler prevent us from entering this situation.
1284          */
1285         osi_assertx(cm_data.buf_freeListEndp != NULL, "buf_GetNewLocked: no free buffers");
1286
1287         /* look at all buffers in free list, some of which may temp.
1288          * have high refcounts and which then should be skipped,
1289          * starting cleaning I/O for those which are dirty.  If we find
1290          * a clean buffer, we rehash it, lock it and return it.
1291          */
1292         for (bp = cm_data.buf_freeListEndp; bp; bp=(cm_buf_t *) osi_QPrev(&bp->q)) {
1293             int cleaned = 0;
1294
1295             n_bufs++;
1296
1297           retry_2:
1298             /* check to see if it really has zero ref count.  This
1299              * code can bump refcounts, at least, so it may not be
1300              * zero.
1301              */
1302             if (bp->refCount > 0) {
1303                 n_nonzero++;
1304                 continue;
1305             }
1306
1307             /* we don't have to lock buffer itself, since the ref
1308              * count is 0 and we know it will stay zero as long as
1309              * we hold the global lock.
1310              */
1311
1312             /* don't recycle someone in our own chunk */
1313             if (!cm_FidCmp(&bp->fid, &scp->fid) &&
1314                 bp->dataVersion >= scp->bufDataVersionLow &&
1315                 bp->dataVersion <= scp->dataVersion &&
1316                 (bp->offset.LowPart & (-cm_chunkSize)) == (offsetp->LowPart & (-cm_chunkSize))) {
1317                 n_own++;
1318                 continue;
1319             }
1320
1321             /* if this page is being filled (!) or cleaned, see if
1322              * the I/O has completed.  If not, skip it, otherwise
1323              * do the final processing for the I/O.
1324              */
1325             if (bp->flags & (CM_BUF_READING | CM_BUF_WRITING)) {
1326                 /* probably shouldn't do this much work while
1327                  * holding the big lock?  Watch for contention
1328                  * here.
1329                  */
1330                 n_busy++;
1331                 continue;
1332             }
1333
1334             /* leave the buffer alone if held by the redirector */
1335             if (bp->qFlags & CM_BUF_QREDIR) {
1336                 n_redir++;
1337                 continue;
1338             }
1339
1340             if (bp->flags & CM_BUF_DIRTY) {
1341                 n_dirty++;
1342
1343                 /* protect against cleaning the same buffer more than once. */
1344                 if (cleaned)
1345                     continue;
1346
1347                 /* if the buffer is dirty, start cleaning it and
1348                  * move on to the next buffer.  We do this with
1349                  * just the lock required to minimize contention
1350                  * on the big lock.
1351                  */
1352                 buf_HoldLocked(bp);
1353                 lock_ReleaseWrite(&buf_globalLock);
1354                 lock_ReleaseRead(&scp->bufCreateLock);
1355
1356                 /*
1357                  * grab required lock and clean.
1358                  * previously the claim was that the cleaning
1359                  * operation was async which it is not.  It would
1360                  * be a good idea to use an async mechanism here
1361                  * but there is none at the moment other than
1362                  * the buf_IncrSyncer() thread.
1363                  */
1364                 if (cm_FidCmp(&scp->fid, &bp->fid) == 0)
1365                     buf_Clean(scp, bp, reqp, 0, NULL);
1366                 else
1367                     buf_Clean(NULL, bp, reqp, 0, NULL);
1368
1369                 /* now put it back and go around again */
1370                 buf_Release(bp);
1371
1372                 /* but first obtain the locks we gave up
1373                  * before the buf_CleanAsync() call */
1374                 lock_ObtainRead(&scp->bufCreateLock);
1375                 lock_ObtainWrite(&buf_globalLock);
1376
1377                 /*
1378                  * Since we dropped the locks we need to verify that
1379                  * another thread has not allocated the buffer for us.
1380                  */
1381                 if (buf_ExistsLocked(scp, offsetp)) {
1382                     lock_ReleaseWrite(&buf_globalLock);
1383                     lock_ReleaseRead(&scp->bufCreateLock);
1384                     return CM_BUF_EXISTS;
1385                 }
1386
1387                 /*
1388                  * We just cleaned this buffer so we need to
1389                  * restart the loop with this buffer so it
1390                  * can be retested.  Set 'cleaned' so we
1391                  * do not attempt another call to buf_Clean()
1392                  * if the prior attempt failed.
1393                  */
1394                 cleaned = 1;
1395                 goto retry_2;
1396             }
1397
1398             osi_Log3(afsd_logp, "buf_GetNewLocked: scp 0x%p examined %u buffers before recycling bufp 0x%p",
1399                      scp, n_bufs, bp);
1400             osi_Log4(afsd_logp, "... nonzero %u; own %u; busy %u; dirty %u", n_nonzero, n_own, n_busy, n_dirty);
1401
1402             /* if we get here, we know that the buffer still has a 0
1403              * ref count, and that it is clean and has no currently
1404              * pending I/O.  This is the dude to return.
1405              * Remember that as long as the ref count is 0, we know
1406              * that we won't have any lock conflicts, so we can grab
1407              * the buffer lock out of order in the locking hierarchy.
1408              */
1409             buf_Recycle(bp);
1410
1411             /* now hash in as our new buffer, and give it the
1412              * appropriate label, if requested.
1413              */
1414             if (scp) {
1415                 lock_AssertWrite(&buf_globalLock);
1416
1417                 _InterlockedOr(&bp->qFlags, CM_BUF_QINHASH);
1418                 bp->fid = scp->fid;
1419 #ifdef DEBUG
1420                 bp->scp = scp;
1421 #endif
1422                 bp->offset = *offsetp;
1423                 i = BUF_HASH(&scp->fid, offsetp);
1424                 bp->hashp = cm_data.buf_scacheHashTablepp[i];
1425                 cm_data.buf_scacheHashTablepp[i] = bp;
1426                 i = BUF_FILEHASH(&scp->fid);
1427                 nextBp = cm_data.buf_fileHashTablepp[i];
1428                 bp->fileHashp = nextBp;
1429                 bp->fileHashBackp = NULL;
1430                 if (nextBp)
1431                     nextBp->fileHashBackp = bp;
1432                 cm_data.buf_fileHashTablepp[i] = bp;
1433             }
1434
1435             /* we should remove it from the lru queue.  It better still be there,
1436              * since we've held the global (big) lock since we found it there.
1437              */
1438             osi_assertx(bp->qFlags & CM_BUF_QINLRU,
1439                          "buf_GetNewLocked: LRU screwup");
1440
1441             osi_QRemoveHT( (osi_queue_t **) &cm_data.buf_freeListp,
1442                            (osi_queue_t **) &cm_data.buf_freeListEndp,
1443                            &bp->q);
1444             _InterlockedAnd(&bp->qFlags, ~CM_BUF_QINLRU);
1445             buf_DecrementFreeCount();
1446
1447             /* prepare to return it.  Give it a refcount */
1448             InterlockedIncrement(&bp->refCount);
1449 #ifdef DEBUG_REFCOUNT
1450             osi_Log2(afsd_logp,"buf_GetNewLocked bp 0x%p ref %d", bp, 1);
1451             afsi_log("%s:%d buf_GetNewLocked bp 0x%p, ref %d", __FILE__, __LINE__, bp, 1);
1452 #endif
1453             /* grab the mutex so that people don't use it
1454              * before the caller fills it with data.  Again, no one
1455              * should have been able to get to this dude to lock it.
1456              */
1457             if (!lock_TryMutex(&bp->mx)) {
1458                 osi_Log2(afsd_logp, "buf_GetNewLocked bp 0x%p cannot be mutex locked.  refCount %d should be 0",
1459                          bp, bp->refCount);
1460                 osi_panic("buf_GetNewLocked: TryMutex failed",__FILE__,__LINE__);
1461             }
1462
1463             lock_ReleaseWrite(&buf_globalLock);
1464             lock_ReleaseRead(&scp->bufCreateLock);
1465
1466             *bufpp = bp;
1467
1468 #ifdef TESTING
1469             buf_ValidateBufQueues();
1470 #endif /* TESTING */
1471             return 0;
1472         } /* for all buffers in lru queue */
1473         lock_ReleaseWrite(&buf_globalLock);
1474         lock_ReleaseRead(&scp->bufCreateLock);
1475
1476         osi_Log2(afsd_logp, "buf_GetNewLocked: Free Buffer List has %u buffers none free; redir %u", n_bufs, n_redir);
1477         osi_Log4(afsd_logp, "... nonzero %u; own %u; busy %u; dirty %u", n_nonzero, n_own, n_busy, n_dirty);
1478
1479         if (RDR_Initialized) {
1480             afs_uint32 code;
1481           rdr_release:
1482             code = buf_RDRShakeSomeExtentsFree(reqp, TRUE, 2 /* seconds */);
1483             switch (code) {
1484             case CM_ERROR_RETRY:
1485             case 0:
1486                 goto retry;
1487             case CM_ERROR_WOULDBLOCK:
1488                 return CM_ERROR_WOULDBLOCK;
1489             }
1490         }
1491
1492         Sleep(100);             /* give some time for a buffer to be freed */
1493     }   /* while loop over everything */
1494     /* not reached */
1495 } /* the proc */
1496
1497 /*
1498  * get a page, returning it held but unlocked.  the page may or may not
1499  * contain valid data.
1500  *
1501  * The scp must be unlocked when passed in unlocked.
1502  */
1503 long buf_Get(struct cm_scache *scp, osi_hyper_t *offsetp, cm_req_t *reqp, cm_buf_t **bufpp)
1504 {
1505     cm_buf_t *bp;
1506     long code;
1507     osi_hyper_t pageOffset;
1508     unsigned long tcount;
1509     int created;
1510     long lcount = 0;
1511 #ifdef DISKCACHE95
1512     cm_diskcache_t *dcp;
1513 #endif /* DISKCACHE95 */
1514
1515     created = 0;
1516     pageOffset.HighPart = offsetp->HighPart;
1517     pageOffset.LowPart = offsetp->LowPart & ~(cm_data.buf_blockSize-1);
1518     while (!created) {
1519         lcount++;
1520 #ifdef TESTING
1521         buf_ValidateBufQueues();
1522 #endif /* TESTING */
1523
1524         bp = buf_Find(&scp->fid, &pageOffset);
1525         if (bp) {
1526             /* lock it and break out */
1527             lock_ObtainMutex(&bp->mx);
1528
1529 #ifdef DISKCACHE95
1530             /* touch disk chunk to update LRU info */
1531             diskcache_Touch(bp->dcp);
1532 #endif /* DISKCACHE95 */
1533             break;
1534         }
1535
1536         /* otherwise, we have to create a page */
1537         code = buf_GetNewLocked(scp, &pageOffset, reqp, &bp);
1538         switch (code) {
1539         case 0:
1540             /* the requested buffer was created */
1541             created = 1;
1542             break;
1543         case CM_BUF_EXISTS:
1544             /*
1545              * the requested buffer existed by the time the
1546              * scp->bufCreateLock and buf_globalLock could be obtained.
1547              * loop again and permit buf_Find() to obtain a reference.
1548              */
1549             break;
1550         default:
1551             /*
1552              * the requested buffer could not be created.
1553              * return the error to the caller.
1554              */
1555 #ifdef TESTING
1556             buf_ValidateBufQueues();
1557 #endif /* TESTING */
1558             return code;
1559         }
1560     } /* big while loop */
1561
1562     /* if we get here, we have a locked buffer that may have just been
1563      * created, in which case it needs to be filled with data.
1564      */
1565     if (created) {
1566         /* load the page; freshly created pages should be idle */
1567         osi_assertx(!(bp->flags & (CM_BUF_READING | CM_BUF_WRITING)), "incorrect cm_buf_t flags");
1568
1569         /*
1570          * start the I/O; may drop lock.  as of this writing, the only
1571          * implementation of Readp is cm_BufRead() which simply sets
1572          * tcount to 0 and returns success.
1573          */
1574         _InterlockedOr(&bp->flags, CM_BUF_READING);
1575         code = (*cm_buf_opsp->Readp)(bp, cm_data.buf_blockSize, &tcount, NULL);
1576
1577 #ifdef DISKCACHE95
1578         code = diskcache_Get(&bp->fid, &bp->offset, bp->datap, cm_data.buf_blockSize, &bp->dataVersion, &tcount, &dcp);
1579         bp->dcp = dcp;    /* pointer to disk cache struct. */
1580 #endif /* DISKCACHE95 */
1581
1582         if (code != 0) {
1583             /* failure or queued */
1584
1585             /* unless cm_BufRead() is altered, this path cannot be hit */
1586             if (code != ERROR_IO_PENDING) {
1587                 bp->error = code;
1588                 _InterlockedOr(&bp->flags, CM_BUF_ERROR);
1589                 _InterlockedAnd(&bp->flags, ~CM_BUF_READING);
1590                 if (bp->flags & CM_BUF_WAITING) {
1591                     osi_Log1(buf_logp, "buf_Get Waking bp 0x%p", bp);
1592                     osi_Wakeup((LONG_PTR) bp);
1593                 }
1594                 lock_ReleaseMutex(&bp->mx);
1595                 buf_Release(bp);
1596 #ifdef TESTING
1597                 buf_ValidateBufQueues();
1598 #endif /* TESTING */
1599                 return code;
1600             }
1601         } else {
1602             /*
1603              * otherwise, I/O completed instantly and we're done, except
1604              * for padding the xfr out with 0s and checking for EOF
1605              */
1606             if (tcount < (unsigned long) cm_data.buf_blockSize) {
1607                 memset(bp->datap+tcount, 0, cm_data.buf_blockSize - tcount);
1608                 if (tcount == 0)
1609                     _InterlockedOr(&bp->flags, CM_BUF_EOF);
1610             }
1611             _InterlockedAnd(&bp->flags, ~CM_BUF_READING);
1612             if (bp->flags & CM_BUF_WAITING) {
1613                 osi_Log1(buf_logp, "buf_Get Waking bp 0x%p", bp);
1614                 osi_Wakeup((LONG_PTR) bp);
1615             }
1616         }
1617     } /* if created */
1618
1619     /* wait for reads, either that which we started above, or that someone
1620      * else started.  We don't care if we return a buffer being cleaned.
1621      */
1622     if (bp->flags & CM_BUF_READING)
1623         buf_WaitIO(scp, bp);
1624
1625     /* once it has been read once, we can unlock it and return it, still
1626      * with its refcount held.
1627      */
1628     lock_ReleaseMutex(&bp->mx);
1629     *bufpp = bp;
1630
1631     /* now remove from queue; will be put in at the head (farthest from
1632      * being recycled) when we're done in buf_Release.
1633      */
1634     lock_ObtainWrite(&buf_globalLock);
1635     if (bp->qFlags & CM_BUF_QINLRU) {
1636         osi_QRemoveHT( (osi_queue_t **) &cm_data.buf_freeListp,
1637                        (osi_queue_t **) &cm_data.buf_freeListEndp,
1638                        &bp->q);
1639         _InterlockedAnd(&bp->qFlags, ~CM_BUF_QINLRU);
1640         buf_DecrementFreeCount();
1641     }
1642     lock_ReleaseWrite(&buf_globalLock);
1643
1644     osi_Log4(buf_logp, "buf_Get returning bp 0x%p for scp 0x%p, offset 0x%x:%08x",
1645               bp, scp, offsetp->HighPart, offsetp->LowPart);
1646 #ifdef TESTING
1647     buf_ValidateBufQueues();
1648 #endif /* TESTING */
1649     return 0;
1650 }
1651
1652 /* clean a buffer synchronously */
1653 afs_uint32 buf_Clean(cm_scache_t *scp, cm_buf_t *bp, cm_req_t *reqp, afs_uint32 flags, afs_uint32 *pisdirty)
1654 {
1655     long code;
1656     osi_assertx(bp->magic == CM_BUF_MAGIC, "invalid cm_buf_t magic");
1657     osi_assertx(!(flags & CM_BUF_WRITE_SCP_LOCKED), "scp->rw must not be held when calling buf_CleanAsync");
1658
1659     lock_ObtainMutex(&bp->mx);
1660     code = buf_CleanLocked(scp, bp, reqp, flags, pisdirty);
1661     lock_ReleaseMutex(&bp->mx);
1662
1663     return code;
1664 }
1665
1666 /* wait for a buffer's cleaning to finish */
1667 void buf_CleanWait(cm_scache_t * scp, cm_buf_t *bp, afs_uint32 locked)
1668 {
1669     osi_assertx(bp->magic == CM_BUF_MAGIC, "invalid cm_buf_t magic");
1670
1671     if (!locked)
1672         lock_ObtainMutex(&bp->mx);
1673     if (bp->flags & CM_BUF_WRITING) {
1674         buf_WaitIO(scp, bp);
1675     }
1676     if (!locked)
1677         lock_ReleaseMutex(&bp->mx);
1678 }
1679
1680 /* set the dirty flag on a buffer, and set associated write-ahead log,
1681  * if there is one.  Allow one to be added to a buffer, but not changed.
1682  *
1683  * The buffer must be locked before calling this routine.
1684  */
1685 void buf_SetDirty(cm_buf_t *bp, cm_req_t *reqp, afs_uint32 offset, afs_uint32 length, cm_user_t *userp)
1686 {
1687     osi_assertx(bp->magic == CM_BUF_MAGIC, "invalid cm_buf_t magic");
1688     osi_assertx(bp->refCount > 0, "cm_buf_t refcount 0");
1689
1690     if (length == 0)
1691         return;
1692
1693     if (bp->flags & CM_BUF_DIRTY) {
1694
1695         osi_Log1(buf_logp, "buf_SetDirty 0x%p already dirty", bp);
1696
1697         if (bp->dirty_offset <= offset) {
1698             if (bp->dirty_offset + bp->dirty_length >= offset + length) {
1699                 /* dirty_length remains the same */
1700             } else {
1701                 bp->dirty_length = offset + length - bp->dirty_offset;
1702             }
1703         } else /* bp->dirty_offset > offset */ {
1704             if (bp->dirty_offset + bp->dirty_length >= offset + length) {
1705                 bp->dirty_length = bp->dirty_offset + bp->dirty_length - offset;
1706             } else {
1707                 bp->dirty_length = length;
1708             }
1709             bp->dirty_offset = offset;
1710         }
1711     } else {
1712         osi_Log1(buf_logp, "buf_SetDirty 0x%p", bp);
1713
1714         /* set dirty bit */
1715         _InterlockedOr(&bp->flags, CM_BUF_DIRTY);
1716
1717         /* and turn off EOF flag, since it has associated data now */
1718         _InterlockedAnd(&bp->flags, ~CM_BUF_EOF);
1719
1720         bp->dirty_offset = offset;
1721         bp->dirty_length = length;
1722
1723         /*
1724          * if the request is not from the afs redirector,
1725          * add to the dirty list.  The redirector interface ensures
1726          * that a background store operation is queued for each and
1727          * every dirty extent that is released.  Therefore, the
1728          * buf_IncrSyncer thread is not required to ensure that
1729          * dirty buffers are written to the file server.
1730          *
1731          * we obtain a hold on the buffer for as long as it remains
1732          * in the list.  buffers are only removed from the list by
1733          * the buf_IncrSyncer function regardless of when else the
1734          * dirty flag might be cleared.
1735          *
1736          * This should never happen but just in case there is a bug
1737          * elsewhere, never add to the dirty list if the buffer is
1738          * already there.
1739          */
1740         if (!(reqp->flags & CM_REQ_SOURCE_REDIR)) {
1741             lock_ObtainWrite(&buf_globalLock);
1742             if (!(bp->qFlags & CM_BUF_QINDL)) {
1743                 buf_HoldLocked(bp);
1744                 if (!cm_data.buf_dirtyListp) {
1745                     cm_data.buf_dirtyListp = cm_data.buf_dirtyListEndp = bp;
1746                 } else {
1747                     cm_data.buf_dirtyListEndp->dirtyp = bp;
1748                     cm_data.buf_dirtyListEndp = bp;
1749                 }
1750                 bp->dirtyp = NULL;
1751                 _InterlockedOr(&bp->qFlags, CM_BUF_QINDL);
1752             }
1753             lock_ReleaseWrite(&buf_globalLock);
1754         }
1755     }
1756
1757     /* and record the last writer */
1758     if (bp->userp != userp) {
1759         cm_HoldUser(userp);
1760         if (bp->userp)
1761             cm_ReleaseUser(bp->userp);
1762         bp->userp = userp;
1763     }
1764 }
1765
1766 /* clean all buffers, reset log pointers and invalidate all buffers.
1767  * Called with no locks held, and returns with same.
1768  *
1769  * This function is guaranteed to clean and remove the log ptr of all the
1770  * buffers that were dirty or had non-zero log ptrs before the call was
1771  * made.  That's sufficient to clean up any garbage left around by recovery,
1772  * which is all we're counting on this for; there may be newly created buffers
1773  * added while we're running, but that should be OK.
1774  *
1775  * In an environment where there are no transactions (artificially imposed, for
1776  * example, when switching the database to raw mode), this function is used to
1777  * make sure that all updates have been written to the disk.  In that case, we don't
1778  * really require that we forget the log association between pages and logs, but
1779  * it also doesn't hurt.  Since raw mode I/O goes through this buffer package, we don't
1780  * have to worry about invalidating data in the buffers.
1781  *
1782  * This function is used at the end of recovery as paranoia to get the recovered
1783  * database out to disk.  It removes all references to the recovery log and cleans
1784  * all buffers.
1785  */
1786 long buf_CleanAndReset(void)
1787 {
1788     afs_uint32 i;
1789     cm_buf_t *bp;
1790     cm_req_t req;
1791
1792     lock_ObtainRead(&buf_globalLock);
1793     for(i=0; i<cm_data.buf_hashSize; i++) {
1794         for(bp = cm_data.buf_scacheHashTablepp[i]; bp; bp = bp->hashp) {
1795             if (bp->qFlags & CM_BUF_QREDIR) {
1796                 osi_Log1(buf_logp,"buf_CleanAndReset buffer held by redirector bp 0x%p", bp);
1797
1798                 /* Request single extent from the redirector */
1799                 buf_RDRShakeAnExtentFree(bp, &req);
1800             }
1801
1802             if ((bp->flags & CM_BUF_DIRTY) == CM_BUF_DIRTY) {
1803                 buf_HoldLocked(bp);
1804                 lock_ReleaseRead(&buf_globalLock);
1805
1806                 /* now no locks are held; clean buffer and go on */
1807                 cm_InitReq(&req);
1808                 req.flags |= CM_REQ_NORETRY;
1809
1810                 buf_Clean(NULL, bp, &req, 0, NULL);
1811                 buf_CleanWait(NULL, bp, FALSE);
1812
1813                 /* relock and release buffer */
1814                 lock_ObtainRead(&buf_globalLock);
1815                 buf_ReleaseLocked(bp, FALSE);
1816             } /* dirty */
1817         } /* over one bucket */
1818     }   /* for loop over all hash buckets */
1819
1820     /* release locks */
1821     lock_ReleaseRead(&buf_globalLock);
1822
1823 #ifdef TESTING
1824     buf_ValidateBufQueues();
1825 #endif /* TESTING */
1826
1827     /* and we're done */
1828     return 0;
1829 }
1830
1831 /* called without global lock being held, reserves buffers for callers
1832  * that need more than one held (not locked) at once.
1833  */
1834 void buf_ReserveBuffers(afs_uint64 nbuffers)
1835 {
1836     lock_ObtainWrite(&buf_globalLock);
1837     while (1) {
1838         if (cm_data.buf_reservedBufs + nbuffers > cm_data.buf_maxReservedBufs) {
1839             cm_data.buf_reserveWaiting = 1;
1840             osi_Log1(buf_logp, "buf_ReserveBuffers waiting for %d bufs", nbuffers);
1841             osi_SleepW((LONG_PTR) &cm_data.buf_reservedBufs, &buf_globalLock);
1842             lock_ObtainWrite(&buf_globalLock);
1843         }
1844         else {
1845             cm_data.buf_reservedBufs += nbuffers;
1846             break;
1847         }
1848     }
1849     lock_ReleaseWrite(&buf_globalLock);
1850 }
1851
1852 int buf_TryReserveBuffers(afs_uint64 nbuffers)
1853 {
1854     int code;
1855
1856     lock_ObtainWrite(&buf_globalLock);
1857     if (cm_data.buf_reservedBufs + nbuffers > cm_data.buf_maxReservedBufs) {
1858         code = 0;
1859     }
1860     else {
1861         cm_data.buf_reservedBufs += nbuffers;
1862         code = 1;
1863     }
1864     lock_ReleaseWrite(&buf_globalLock);
1865     return code;
1866 }
1867
1868 /* called without global lock held, releases reservation held by
1869  * buf_ReserveBuffers.
1870  */
1871 void buf_UnreserveBuffers(afs_uint64 nbuffers)
1872 {
1873     lock_ObtainWrite(&buf_globalLock);
1874     cm_data.buf_reservedBufs -= nbuffers;
1875     if (cm_data.buf_reserveWaiting) {
1876         cm_data.buf_reserveWaiting = 0;
1877         osi_Wakeup((LONG_PTR) &cm_data.buf_reservedBufs);
1878     }
1879     lock_ReleaseWrite(&buf_globalLock);
1880 }
1881
1882 /* truncate the buffers past sizep, zeroing out the page, if we don't
1883  * end on a page boundary.
1884  *
1885  * Requires cm_bufCreateLock to be write locked.
1886  */
1887 long buf_Truncate(cm_scache_t *scp, cm_user_t *userp, cm_req_t *reqp,
1888                    osi_hyper_t *sizep)
1889 {
1890     cm_buf_t *bufp;
1891     cm_buf_t *nbufp;                    /* next buffer, if didRelease */
1892     osi_hyper_t bufEnd;
1893     long code;
1894     long bufferPos;
1895     afs_uint32 i;
1896     afs_uint32 invalidate = 0;
1897
1898     /* assert that cm_bufCreateLock is held in write mode */
1899     lock_AssertWrite(&scp->bufCreateLock);
1900
1901     i = BUF_FILEHASH(&scp->fid);
1902
1903     lock_ObtainRead(&buf_globalLock);
1904     bufp = cm_data.buf_fileHashTablepp[i];
1905     if (bufp == NULL) {
1906         lock_ReleaseRead(&buf_globalLock);
1907         return 0;
1908     }
1909
1910     buf_HoldLocked(bufp);
1911     lock_ReleaseRead(&buf_globalLock);
1912
1913     while (bufp) {
1914         lock_ObtainMutex(&bufp->mx);
1915
1916         bufEnd.HighPart = 0;
1917         bufEnd.LowPart = cm_data.buf_blockSize;
1918         bufEnd = LargeIntegerAdd(bufEnd, bufp->offset);
1919
1920         if (cm_FidCmp(&bufp->fid, &scp->fid) == 0 &&
1921              LargeIntegerLessThan(*sizep, bufEnd)) {
1922             buf_WaitIO(scp, bufp);
1923         }
1924         lock_ObtainWrite(&scp->rw);
1925
1926         /* make sure we have a callback (so we have the right value for
1927          * the length), and wait for it to be safe to do a truncate.
1928          */
1929         code = cm_SyncOp(scp, bufp, userp, reqp, 0,
1930                           CM_SCACHESYNC_NEEDCALLBACK
1931                           | CM_SCACHESYNC_GETSTATUS
1932                           | CM_SCACHESYNC_SETSIZE
1933                           | CM_SCACHESYNC_BUFLOCKED);
1934
1935
1936         /* if we succeeded in our locking, and this applies to the right
1937          * file, and the truncate request overlaps the buffer either
1938          * totally or partially, then do something.
1939          */
1940         if (code == 0 && cm_FidCmp(&bufp->fid, &scp->fid) == 0
1941              && LargeIntegerLessThan(*sizep, bufEnd)) {
1942
1943
1944             /* destroy the buffer, turning off its dirty bit, if
1945              * we're truncating the whole buffer.  Otherwise, set
1946              * the dirty bit, and clear out the tail of the buffer
1947              * if we just overlap some.
1948              */
1949             if (LargeIntegerLessThanOrEqualTo(*sizep, bufp->offset)) {
1950                 /* truncating the entire page */
1951                 if (reqp->flags & CM_REQ_SOURCE_REDIR) {
1952                     /*
1953                      * Implicitly clear the redirector flag
1954                      * and release the matching hold.
1955                      */
1956                     if (bufp->qFlags & CM_BUF_QREDIR) {
1957                         osi_Log4(buf_logp,"buf_Truncate taking from file system bufp 0x%p vno 0x%x foffset 0x%x:%x",
1958                                  bufp, bufp->fid.vnode, bufp->offset.HighPart, bufp->offset.LowPart);
1959                         lock_ObtainWrite(&buf_globalLock);
1960                         if (bufp->qFlags & CM_BUF_QREDIR) {
1961                             buf_RemoveFromRedirQueue(scp, bufp);
1962                             buf_ReleaseLocked(bufp, TRUE);
1963                         }
1964                         lock_ReleaseWrite(&buf_globalLock);
1965                     }
1966                 } else {
1967                     invalidate = 1;
1968                 }
1969                 _InterlockedAnd(&bufp->flags, ~CM_BUF_DIRTY);
1970                 bufp->error = 0;
1971                 bufp->dirty_offset = 0;
1972                 bufp->dirty_length = 0;
1973                 bufp->dataVersion = CM_BUF_VERSION_BAD; /* known bad */
1974                 bufp->dirtyCounter++;
1975             }
1976             else {
1977                 /* don't set dirty, since dirty implies
1978                  * currently up-to-date.  Don't need to do this,
1979                  * since we'll update the length anyway.
1980                  *
1981                  * Zero out remainder of the page, in case we
1982                  * seek and write past EOF, and make this data
1983                  * visible again.
1984                  */
1985                 bufferPos = sizep->LowPart & (cm_data.buf_blockSize - 1);
1986                 osi_assertx(bufferPos != 0, "non-zero bufferPos");
1987                 memset(bufp->datap + bufferPos, 0,
1988                         cm_data.buf_blockSize - bufferPos);
1989             }
1990         }
1991
1992         cm_SyncOpDone( scp, bufp,
1993                        CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS
1994                        | CM_SCACHESYNC_SETSIZE | CM_SCACHESYNC_BUFLOCKED);
1995
1996         lock_ReleaseWrite(&scp->rw);
1997         lock_ReleaseMutex(&bufp->mx);
1998
1999         if (!code) {
2000             nbufp = bufp->fileHashp;
2001             if (nbufp)
2002                 buf_Hold(nbufp);
2003         } else {
2004             /* This forces the loop to end and the error code
2005              * to be returned. */
2006             nbufp = NULL;
2007         }
2008         buf_Release(bufp);
2009         bufp = nbufp;
2010     }
2011
2012 #ifdef TESTING
2013     buf_ValidateBufQueues();
2014 #endif /* TESTING */
2015
2016     if (invalidate && RDR_Initialized)
2017         RDR_InvalidateObject(scp->fid.cell, scp->fid.volume, scp->fid.vnode,
2018                              scp->fid.unique, scp->fid.hash,
2019                              scp->fileType, AFS_INVALIDATE_SMB);
2020
2021     /* done */
2022     return code;
2023 }
2024
2025 long buf_FlushCleanPages(cm_scache_t *scp, cm_user_t *userp, cm_req_t *reqp)
2026 {
2027     long code;
2028     cm_buf_t *bp;               /* buffer we're hacking on */
2029     cm_buf_t *nbp;
2030     int didRelease;
2031     afs_uint32 i;
2032     afs_uint32 stable = 0;
2033
2034     i = BUF_FILEHASH(&scp->fid);
2035
2036     code = 0;
2037     lock_ObtainRead(&buf_globalLock);
2038     bp = cm_data.buf_fileHashTablepp[i];
2039     if (bp)
2040         buf_HoldLocked(bp);
2041     lock_ReleaseRead(&buf_globalLock);
2042
2043     for (; bp; bp = nbp) {
2044         didRelease = 0; /* haven't released this buffer yet */
2045
2046         /* clean buffer synchronously */
2047         if (cm_FidCmp(&bp->fid, &scp->fid) == 0) {
2048
2049             if (code == 0 && !stable && (bp->flags & CM_BUF_DIRTY)) {
2050                 /*
2051                  * we must stabilize the object to ensure that buffer
2052                  * changes cannot occur while the flush is performed.
2053                  * However, we do not want to Stabilize if we do not
2054                  * need to because Stabilize obtains a callback.
2055                  */
2056                 code = (*cm_buf_opsp->Stabilizep)(scp, userp, reqp);
2057                 stable = (code == 0);
2058             }
2059
2060             if (code == CM_ERROR_BADFD) {
2061                 /* if the scp's FID is bad its because we received VNOVNODE
2062                  * when attempting to FetchStatus before the write.  This
2063                  * page therefore contains data that can no longer be stored.
2064                  */
2065                 lock_ObtainMutex(&bp->mx);
2066                 _InterlockedAnd(&bp->flags, ~CM_BUF_DIRTY);
2067                 _InterlockedOr(&bp->flags, CM_BUF_ERROR);
2068                 bp->error = CM_ERROR_BADFD;
2069                 bp->dirty_offset = 0;
2070                 bp->dirty_length = 0;
2071                 bp->dataVersion = CM_BUF_VERSION_BAD;   /* known bad */
2072                 bp->dirtyCounter++;
2073                 lock_ReleaseMutex(&bp->mx);
2074             } else if (!(scp->flags & CM_SCACHEFLAG_RO)) {
2075                 if (code) {
2076                     goto skip;
2077                 }
2078
2079                 lock_ObtainMutex(&bp->mx);
2080
2081                 /* start cleaning the buffer, and wait for it to finish */
2082                 buf_CleanLocked(scp, bp, reqp, 0, NULL);
2083                 buf_WaitIO(scp, bp);
2084
2085                 lock_ReleaseMutex(&bp->mx);
2086             }
2087
2088             /* actually, we only know that buffer is clean if ref
2089              * count is 1, since we don't have buffer itself locked.
2090              */
2091             if (!(bp->flags & CM_BUF_DIRTY) && !(bp->qFlags & CM_BUF_QREDIR)) {
2092                 lock_ObtainWrite(&buf_globalLock);
2093                 if (!(bp->flags & CM_BUF_DIRTY) && !(bp->qFlags & CM_BUF_QREDIR)) {
2094                     if (bp->refCount == 1) {    /* bp is held above */
2095                         nbp = bp->fileHashp;
2096                         if (nbp)
2097                             buf_HoldLocked(nbp);
2098                         buf_ReleaseLocked(bp, TRUE);
2099                         didRelease = 1;
2100                         buf_Recycle(bp);
2101                     }
2102                 }
2103                 lock_ReleaseWrite(&buf_globalLock);
2104             }
2105         }
2106
2107       skip:
2108         if (!didRelease) {
2109             lock_ObtainRead(&buf_globalLock);
2110             nbp = bp->fileHashp;
2111             if (nbp)
2112                 buf_HoldLocked(nbp);
2113             buf_ReleaseLocked(bp, FALSE);
2114             lock_ReleaseRead(&buf_globalLock);
2115         }
2116     }   /* for loop over a bunch of buffers */
2117
2118     if (stable)
2119         (*cm_buf_opsp->Unstabilizep)(scp, userp);
2120
2121 #ifdef TESTING
2122     buf_ValidateBufQueues();
2123 #endif /* TESTING */
2124
2125     /* done */
2126     return code;
2127 }
2128
2129 /* Must be called with scp->rw held */
2130 long buf_InvalidateBuffers(cm_scache_t * scp)
2131 {
2132     cm_buf_t * bp;
2133     afs_uint32 i;
2134     int found = 0;
2135
2136     lock_AssertAny(&scp->rw);
2137
2138     i = BUF_FILEHASH(&scp->fid);
2139
2140     lock_ObtainRead(&buf_globalLock);
2141
2142     for (bp = cm_data.buf_fileHashTablepp[i]; bp; bp = bp->fileHashp) {
2143         if (cm_FidCmp(&bp->fid, &scp->fid) == 0) {
2144             bp->dataVersion = CM_BUF_VERSION_BAD;
2145             found = 1;
2146         }
2147     }
2148     lock_ReleaseRead(&buf_globalLock);
2149
2150     if (found)
2151         return 0;
2152     else
2153         return ENOENT;
2154 }
2155
2156 /* Must be called with scp->rw held */
2157 long buf_ForceDataVersion(cm_scache_t * scp, afs_uint64 fromVersion, afs_uint64 toVersion)
2158 {
2159     cm_buf_t * bp;
2160     afs_uint32 i;
2161     int found = 0;
2162
2163     lock_AssertAny(&scp->rw);
2164
2165     i = BUF_FILEHASH(&scp->fid);
2166
2167     lock_ObtainRead(&buf_globalLock);
2168
2169     for (bp = cm_data.buf_fileHashTablepp[i]; bp; bp = bp->fileHashp) {
2170         if (cm_FidCmp(&bp->fid, &scp->fid) == 0) {
2171             if (bp->dataVersion == fromVersion) {
2172                 bp->dataVersion = toVersion;
2173                 found = 1;
2174             }
2175         }
2176     }
2177     lock_ReleaseRead(&buf_globalLock);
2178
2179     if (found)
2180         return 0;
2181     else
2182         return ENOENT;
2183 }
2184
2185 long buf_CleanVnode(struct cm_scache *scp, cm_user_t *userp, cm_req_t *reqp)
2186 {
2187     long code = 0;
2188     long wasDirty = 0;
2189     cm_buf_t *bp;               /* buffer we're hacking on */
2190     cm_buf_t *nbp;              /* next one */
2191     afs_uint32 i;
2192
2193     if (RDR_Initialized && scp->redirBufCount > 0) {
2194         /* Retrieve all extents for this file from the redirector */
2195         buf_RDRShakeFileExtentsFree(scp, reqp);
2196     }
2197
2198     i = BUF_FILEHASH(&scp->fid);
2199
2200     lock_ObtainRead(&buf_globalLock);
2201     bp = cm_data.buf_fileHashTablepp[i];
2202     if (bp)
2203         buf_HoldLocked(bp);
2204     lock_ReleaseRead(&buf_globalLock);
2205     for (; bp; bp = nbp) {
2206         /* clean buffer synchronously */
2207         if (cm_FidCmp(&bp->fid, &scp->fid) == 0) {
2208             /*
2209              * If the buffer is held by the redirector we must fetch
2210              * it back in order to determine whether or not it is in
2211              * fact dirty.
2212              */
2213             lock_ObtainRead(&buf_globalLock);
2214             if (bp->qFlags & CM_BUF_QREDIR) {
2215                 osi_Log1(buf_logp,"buf_CleanVnode buffer held by redirector bp 0x%p", bp);
2216
2217                 /* Retrieve single extent from the redirector */
2218                 buf_RDRShakeAnExtentFree(bp, reqp);
2219             }
2220             lock_ReleaseRead(&buf_globalLock);
2221
2222             lock_ObtainMutex(&bp->mx);
2223             if ((bp->flags & CM_BUF_DIRTY)) {
2224                 if (userp && userp != bp->userp) {
2225                     cm_HoldUser(userp);
2226                     if (bp->userp)
2227                         cm_ReleaseUser(bp->userp);
2228                     bp->userp = userp;
2229                 }
2230
2231                 switch (code) {
2232                 case CM_ERROR_NOSUCHFILE:
2233                 case CM_ERROR_BADFD:
2234                 case CM_ERROR_NOACCESS:
2235                 case CM_ERROR_QUOTA:
2236                 case CM_ERROR_SPACE:
2237                 case CM_ERROR_TOOBIG:
2238                 case CM_ERROR_READONLY:
2239                 case CM_ERROR_NOSUCHPATH:
2240                     /*
2241                      * Apply the previous fatal error to this buffer.
2242                      * Do not waste the time attempting to store to
2243                      * the file server when we know it will fail.
2244                      */
2245                     _InterlockedAnd(&bp->flags, ~CM_BUF_DIRTY);
2246                     _InterlockedOr(&bp->flags, CM_BUF_ERROR);
2247                     bp->dirty_offset = 0;
2248                     bp->dirty_length = 0;
2249                     bp->error = code;
2250                     bp->dataVersion = CM_BUF_VERSION_BAD;
2251                     bp->dirtyCounter++;
2252                     break;
2253                 case CM_ERROR_TIMEDOUT:
2254                 case CM_ERROR_ALLDOWN:
2255                 case CM_ERROR_ALLBUSY:
2256                 case CM_ERROR_ALLOFFLINE:
2257                 case CM_ERROR_CLOCKSKEW:
2258                     /* do not mark the buffer in error state but do
2259                      * not attempt to complete the rest either.
2260                      */
2261                     break;
2262                 default:
2263                     code = buf_CleanLocked(scp, bp, reqp, 0, &wasDirty);
2264                     if (bp->flags & CM_BUF_ERROR) {
2265                         code = bp->error;
2266                         if (code == 0)
2267                             code = -1;
2268                     }
2269                 }
2270                 buf_CleanWait(scp, bp, TRUE);
2271             }
2272             lock_ReleaseMutex(&bp->mx);
2273         }
2274
2275         lock_ObtainRead(&buf_globalLock);
2276         nbp = bp->fileHashp;
2277         if (nbp)
2278             buf_HoldLocked(nbp);
2279         buf_ReleaseLocked(bp, FALSE);
2280         lock_ReleaseRead(&buf_globalLock);
2281     }   /* for loop over a bunch of buffers */
2282
2283 #ifdef TESTING
2284     buf_ValidateBufQueues();
2285 #endif /* TESTING */
2286
2287     /* done */
2288     return code;
2289 }
2290
2291 #ifdef TESTING
2292 void
2293 buf_ValidateBufQueues(void)
2294 {
2295     cm_buf_t * bp, *bpb, *bpf, *bpa;
2296     afs_uint32 countf=0, countb=0, counta=0;
2297
2298     lock_ObtainRead(&buf_globalLock);
2299     for (bp = cm_data.buf_freeListEndp; bp; bp=(cm_buf_t *) osi_QPrev(&bp->q)) {
2300         if (bp->magic != CM_BUF_MAGIC)
2301             osi_panic("buf magic error",__FILE__,__LINE__);
2302         countb++;
2303         bpb = bp;
2304     }
2305
2306     for (bp = cm_data.buf_freeListp; bp; bp=(cm_buf_t *) osi_QNext(&bp->q)) {
2307         if (bp->magic != CM_BUF_MAGIC)
2308             osi_panic("buf magic error",__FILE__,__LINE__);
2309         countf++;
2310         bpf = bp;
2311     }
2312
2313     for (bp = cm_data.buf_allp; bp; bp=bp->allp) {
2314         if (bp->magic != CM_BUF_MAGIC)
2315             osi_panic("buf magic error",__FILE__,__LINE__);
2316         counta++;
2317         bpa = bp;
2318     }
2319     lock_ReleaseRead(&buf_globalLock);
2320
2321     if (countb != countf)
2322         osi_panic("buf magic error",__FILE__,__LINE__);
2323
2324     if (counta != cm_data.buf_nbuffers)
2325         osi_panic("buf magic error",__FILE__,__LINE__);
2326 }
2327 #endif /* TESTING */
2328
2329 /* dump the contents of the buf_scacheHashTablepp. */
2330 int cm_DumpBufHashTable(FILE *outputFile, char *cookie, int lock)
2331 {
2332     int zilch;
2333     cm_buf_t *bp;
2334     char output[1024];
2335     afs_uint32 i;
2336
2337     if (cm_data.buf_scacheHashTablepp == NULL)
2338         return -1;
2339
2340     if (lock)
2341         lock_ObtainRead(&buf_globalLock);
2342
2343     StringCbPrintfA(output, sizeof(output), "%s - dumping buf_HashTable - buf_hashSize=%d\r\n",
2344                     cookie, cm_data.buf_hashSize);
2345     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2346
2347     for (i = 0; i < cm_data.buf_hashSize; i++)
2348     {
2349         for (bp = cm_data.buf_scacheHashTablepp[i]; bp; bp=bp->hashp)
2350         {
2351             StringCbPrintfA(output, sizeof(output),
2352                             "%s bp=0x%08X, hash=%d, fid (cell=%d, volume=%d, "
2353                             "vnode=%d, unique=%d), offset=%x:%08x, dv=%I64d, "
2354                             "flags=0x%x, qFlags=0x%x cmFlags=0x%x, error=0x%x, refCount=%d\r\n",
2355                              cookie, (void *)bp, i, bp->fid.cell, bp->fid.volume,
2356                              bp->fid.vnode, bp->fid.unique, bp->offset.HighPart,
2357                              bp->offset.LowPart, bp->dataVersion, bp->flags, bp->qFlags,
2358                              bp->cmFlags, bp->error, bp->refCount);
2359             WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2360         }
2361     }
2362
2363     StringCbPrintfA(output, sizeof(output), "%s - Done dumping buf_HashTable.\r\n", cookie);
2364     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2365
2366     StringCbPrintfA(output, sizeof(output), "%s - dumping buf_freeListEndp\r\n", cookie);
2367     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2368     for(bp = cm_data.buf_freeListEndp; bp; bp=(cm_buf_t *) osi_QPrev(&bp->q)) {
2369         StringCbPrintfA(output, sizeof(output),
2370                          "%s bp=0x%08X, fid (cell=%d, volume=%d, "
2371                          "vnode=%d, unique=%d), offset=%x:%08x, dv=%I64d, "
2372                          "flags=0x%x, qFlags=0x%x, cmFlags=0x%x, error=0x%x, refCount=%d\r\n",
2373                          cookie, (void *)bp, bp->fid.cell, bp->fid.volume,
2374                          bp->fid.vnode, bp->fid.unique, bp->offset.HighPart,
2375                          bp->offset.LowPart, bp->dataVersion, bp->flags, bp->qFlags,
2376                          bp->cmFlags, bp->error, bp->refCount);
2377         WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2378     }
2379     StringCbPrintfA(output, sizeof(output), "%s - Done dumping buf_FreeListEndp.\r\n", cookie);
2380     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2381
2382     StringCbPrintfA(output, sizeof(output), "%s - dumping buf_dirtyListp\r\n", cookie);
2383     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2384     for(bp = cm_data.buf_dirtyListp; bp; bp=bp->dirtyp) {
2385         StringCbPrintfA(output, sizeof(output),
2386                          "%s bp=0x%08X, fid (cell=%d, volume=%d, "
2387                          "vnode=%d, unique=%d), offset=%x:%08x, dv=%I64d, "
2388                          "flags=0x%x, qFlags=0x%x, cmFlags=0x%x, error=0x%x, refCount=%d\r\n",
2389                          cookie, (void *)bp, bp->fid.cell, bp->fid.volume,
2390                          bp->fid.vnode, bp->fid.unique, bp->offset.HighPart,
2391                          bp->offset.LowPart, bp->dataVersion, bp->flags, bp->qFlags,
2392                          bp->cmFlags, bp->error, bp->refCount);
2393         WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2394     }
2395     StringCbPrintfA(output, sizeof(output), "%s - Done dumping buf_dirtyListp.\r\n", cookie);
2396     WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2397
2398     if (lock)
2399         lock_ReleaseRead(&buf_globalLock);
2400     return 0;
2401 }
2402
2403 void buf_ForceTrace(BOOL flush)
2404 {
2405     HANDLE handle;
2406     int len;
2407     char buf[256];
2408
2409     if (!buf_logp)
2410         return;
2411
2412     len = GetTempPath(sizeof(buf)-10, buf);
2413     StringCbCopyA(&buf[len], sizeof(buf)-len, "/afs-buffer.log");
2414     handle = CreateFile(buf, GENERIC_WRITE, FILE_SHARE_READ,
2415                             NULL, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
2416     if (handle == INVALID_HANDLE_VALUE) {
2417         osi_panic("Cannot create log file", __FILE__, __LINE__);
2418     }
2419     osi_LogPrint(buf_logp, handle);
2420     if (flush)
2421         FlushFileBuffers(handle);
2422     CloseHandle(handle);
2423 }
2424
2425 long buf_DirtyBuffersExist(cm_fid_t *fidp)
2426 {
2427     cm_buf_t *bp;
2428     afs_uint32 bcount = 0;
2429     afs_uint32 i;
2430     long found = 0;
2431
2432     i = BUF_FILEHASH(fidp);
2433
2434     lock_ObtainRead(&buf_globalLock);
2435     for (bp = cm_data.buf_fileHashTablepp[i]; bp; bp=bp->fileHashp, bcount++) {
2436         if (!cm_FidCmp(fidp, &bp->fid) && (bp->flags & CM_BUF_DIRTY)) {
2437             found = 1;
2438             break;
2439         }
2440     }
2441     lock_ReleaseRead(&buf_globalLock);
2442     return 0;
2443 }
2444
2445 long buf_RDRBuffersExist(cm_fid_t *fidp)
2446 {
2447     cm_buf_t *bp;
2448     afs_uint32 bcount = 0;
2449     afs_uint32 i;
2450     long found = 0;
2451
2452     if (!RDR_Initialized)
2453         return 0;
2454
2455     i = BUF_FILEHASH(fidp);
2456
2457     lock_ObtainRead(&buf_globalLock);
2458     for (bp = cm_data.buf_fileHashTablepp[i]; bp; bp=bp->fileHashp, bcount++) {
2459         if (!cm_FidCmp(fidp, &bp->fid) && (bp->qFlags & CM_BUF_QREDIR)) {
2460             found = 1;
2461             break;
2462         }
2463     }
2464     lock_ReleaseRead(&buf_globalLock);
2465     return 0;
2466 }
2467
2468 long buf_ClearRDRFlag(cm_scache_t *scp, char *reason)
2469 {
2470     cm_fid_t *fidp = &scp->fid;
2471     cm_buf_t *bp;
2472     afs_uint32 bcount = 0;
2473     afs_uint32 i;
2474
2475     i = BUF_FILEHASH(fidp);
2476
2477     lock_ObtainWrite(&scp->rw);
2478     lock_ObtainRead(&buf_globalLock);
2479     for (bp = cm_data.buf_fileHashTablepp[i]; bp; bp=bp->fileHashp, bcount++) {
2480         if (!cm_FidCmp(fidp, &bp->fid) && (bp->qFlags & CM_BUF_QREDIR)) {
2481             lock_ConvertRToW(&buf_globalLock);
2482             if (bp->qFlags & CM_BUF_QREDIR) {
2483                 osi_Log4(buf_logp,"buf_ClearRDRFlag taking from file system bp 0x%p vno 0x%x foffset 0x%x:%x",
2484                           bp, bp->fid.vnode, bp->offset.HighPart, bp->offset.LowPart);
2485                 buf_RemoveFromRedirQueue(scp, bp);
2486                 buf_ReleaseLocked(bp, TRUE);
2487             }
2488             lock_ConvertWToR(&buf_globalLock);
2489         }
2490     }
2491
2492     /* Confirm that there are none left */
2493     lock_ConvertRToW(&buf_globalLock);
2494     for ( bp = redirq_to_cm_buf_t(scp->redirQueueT);
2495           bp;
2496           bp = redirq_to_cm_buf_t(scp->redirQueueT))
2497     {
2498         if (bp->qFlags & CM_BUF_QREDIR) {
2499             osi_Log4(buf_logp,"buf_ClearRDRFlag taking from file system bufp 0x%p vno 0x%x foffset 0x%x:%x",
2500                       bp, bp->fid.vnode, bp->offset.HighPart, bp->offset.LowPart);
2501             buf_RemoveFromRedirQueue(scp, bp);
2502             buf_ReleaseLocked(bp, TRUE);
2503         }
2504
2505     }
2506     lock_ReleaseWrite(&buf_globalLock);
2507     lock_ReleaseWrite(&scp->rw);
2508     return 0;
2509 }
2510
2511 #if 0
2512 long buf_CleanDirtyBuffers(cm_scache_t *scp)
2513 {
2514     cm_buf_t *bp;
2515     afs_uint32 bcount = 0;
2516     cm_fid_t * fidp = &scp->fid;
2517
2518     for (bp = cm_data.buf_allp; bp; bp=bp->allp, bcount++) {
2519         if (!cm_FidCmp(fidp, &bp->fid) && (bp->flags & CM_BUF_DIRTY)) {
2520             buf_Hold(bp);
2521             lock_ObtainMutex(&bp->mx);
2522             _InterlockedAnd(&bp->cmFlags, ~CM_BUF_CMSTORING);
2523             _InterlockedAnd(&bp->flags, ~CM_BUF_DIRTY);
2524             bp->dirty_offset = 0;
2525             bp->dirty_length = 0;
2526             _InterlockedOr(&bp->flags, CM_BUF_ERROR);
2527             bp->error = VNOVNODE;
2528             bp->dataVersion = CM_BUF_VERSION_BAD; /* bad */
2529             bp->dirtyCounter++;
2530             if (bp->flags & CM_BUF_WAITING) {
2531                 osi_Log2(buf_logp, "BUF CleanDirtyBuffers Waking [scp 0x%x] bp 0x%x", scp, bp);
2532                 osi_Wakeup((long) &bp);
2533             }
2534             lock_ReleaseMutex(&bp->mx);
2535             buf_Release(bp);
2536         }
2537     }
2538     return 0;
2539 }
2540 #endif
2541
2542 /*
2543  * The following routines will not be used on a
2544  * regular basis but are very useful in a variety
2545  * of scenarios when debugging data corruption.
2546  */
2547 const char *
2548 buf_HexCheckSum(cm_buf_t * bp)
2549 {
2550     int i, k;
2551     static char buf[33];
2552     static char tr[16] = {'0','1','2','3','4','5','6','7','8','9','A','B','C','D','E','F'};
2553
2554     for (i=0;i<16;i++) {
2555         k = bp->md5cksum[i];
2556
2557         buf[i*2] = tr[k / 16];
2558         buf[i*2+1] = tr[k % 16];
2559     }
2560     buf[32] = '\0';
2561
2562     return buf;
2563 }
2564
2565 void
2566 buf_ComputeCheckSum(cm_buf_t * bp)
2567 {
2568     MD5_CTX md5;
2569
2570     MD5_Init(&md5);
2571     MD5_Update(&md5, bp->datap, cm_data.blockSize);
2572     MD5_Final(bp->md5cksum, &md5);
2573
2574     osi_Log4(buf_logp, "CheckSum bp 0x%p md5 %s, dirty: offset %u length %u",
2575              bp, osi_LogSaveString(buf_logp, buf_HexCheckSum(bp)),
2576              bp->dirty_offset, bp->dirty_length);
2577 }
2578
2579 int
2580 buf_ValidateCheckSum(cm_buf_t * bp)
2581 {
2582     MD5_CTX md5;
2583     unsigned char tmp[16];
2584
2585     MD5_Init(&md5);
2586     MD5_Update(&md5, bp->datap, cm_data.blockSize);
2587     MD5_Final(tmp, &md5);
2588
2589     if (memcmp(tmp, bp->md5cksum, 16) == 0)
2590         return 1;
2591     return 0;
2592 }
2593
2594 void
2595 buf_InsertToRedirQueue(cm_scache_t *scp, cm_buf_t *bufp)
2596 {
2597     lock_AssertWrite(&buf_globalLock);
2598
2599     if (scp) {
2600         lock_ObtainMutex(&scp->redirMx);
2601     }
2602
2603     if (bufp->qFlags & CM_BUF_QINLRU) {
2604         _InterlockedAnd(&bufp->qFlags, ~CM_BUF_QINLRU);
2605         osi_QRemoveHT( (osi_queue_t **) &cm_data.buf_freeListp,
2606                        (osi_queue_t **) &cm_data.buf_freeListEndp,
2607                        &bufp->q);
2608         buf_DecrementFreeCount();
2609     }
2610     _InterlockedOr(&bufp->qFlags, CM_BUF_QREDIR);
2611     osi_QAddH( (osi_queue_t **) &cm_data.buf_redirListp,
2612                (osi_queue_t **) &cm_data.buf_redirListEndp,
2613                &bufp->q);
2614     buf_IncrementRedirCount();
2615     bufp->redirLastAccess = time(NULL);
2616     if (scp) {
2617         osi_QAddH( (osi_queue_t **) &scp->redirQueueH,
2618                    (osi_queue_t **) &scp->redirQueueT,
2619                    &bufp->redirq);
2620         scp->redirLastAccess = bufp->redirLastAccess;
2621         InterlockedIncrement(&scp->redirBufCount);
2622
2623         lock_ReleaseMutex(&scp->redirMx);
2624     }
2625 }
2626
2627 void
2628 buf_RemoveFromRedirQueue(cm_scache_t *scp, cm_buf_t *bufp)
2629 {
2630     lock_AssertWrite(&buf_globalLock);
2631
2632     if (!(bufp->qFlags & CM_BUF_QREDIR))
2633         return;
2634
2635     if (scp) {
2636         lock_ObtainMutex(&scp->redirMx);
2637     }
2638
2639     _InterlockedAnd(&bufp->qFlags, ~CM_BUF_QREDIR);
2640     osi_QRemoveHT( (osi_queue_t **) &cm_data.buf_redirListp,
2641                    (osi_queue_t **) &cm_data.buf_redirListEndp,
2642                    &bufp->q);
2643     buf_DecrementRedirCount();
2644
2645     if (scp) {
2646         osi_QRemoveHT( (osi_queue_t **) &scp->redirQueueH,
2647                        (osi_queue_t **) &scp->redirQueueT,
2648                        &bufp->redirq);
2649
2650         InterlockedDecrement(&scp->redirBufCount);
2651         lock_ReleaseMutex(&scp->redirMx);
2652     }
2653 }
2654
2655 void
2656 buf_MoveToHeadOfRedirQueue(cm_scache_t *scp, cm_buf_t *bufp)
2657 {
2658     lock_AssertWrite(&buf_globalLock);
2659     if (!(bufp->qFlags & CM_BUF_QREDIR))
2660         return;
2661
2662     if (scp) {
2663         lock_ObtainMutex(&scp->redirMx);
2664     }
2665
2666     osi_QRemoveHT( (osi_queue_t **) &cm_data.buf_redirListp,
2667                    (osi_queue_t **) &cm_data.buf_redirListEndp,
2668                    &bufp->q);
2669     osi_QAddH( (osi_queue_t **) &cm_data.buf_redirListp,
2670                (osi_queue_t **) &cm_data.buf_redirListEndp,
2671                &bufp->q);
2672     bufp->redirLastAccess = time(NULL);
2673     if (scp) {
2674         osi_QRemoveHT( (osi_queue_t **) &scp->redirQueueH,
2675                        (osi_queue_t **) &scp->redirQueueT,
2676                        &bufp->redirq);
2677         osi_QAddH( (osi_queue_t **) &scp->redirQueueH,
2678                    (osi_queue_t **) &scp->redirQueueT,
2679                    &bufp->redirq);
2680         scp->redirLastAccess = bufp->redirLastAccess;
2681
2682         lock_ReleaseMutex(&scp->redirMx);
2683     }
2684 }