2 * Copyright 2000, International Business Machines Corporation and others.
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
10 /* Copyright (C) 1994 Cazamar Systems, Inc. */
12 #include <afsconfig.h>
13 #include <afs/param.h>
23 #include <hcrypto\md5.h>
26 #include "cm_memmap.h"
29 #define TRACE_BUFFER 1
32 extern void afsi_log(char *pattern, ...);
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.
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.
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.
46 * The mutexes in the buffer structures protect the remaining fields in the
47 * buffers, as well the data itself.
49 * The locking hierarchy here is this:
51 * - resv multiple simul. buffers reservation
52 * - lock buffer I/O flags
53 * - lock buffer's mutex
54 * - lock buf_globalLock
58 /* global debugging log */
59 osi_log_t *buf_logp = NULL;
61 /* Global lock protecting hash tables and free lists */
62 osi_rwlock_t buf_globalLock;
64 /* Global lock used to limit the number of RDR Release
65 * Extents requests to one. */
66 osi_mutex_t buf_rdrReleaseExtentsLock;
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
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
79 /* defaults setup; these variables may be manually assigned into
80 * before calling cm_Init, as a way of changing these defaults.
83 /* callouts for reading and writing data, etc */
84 cm_buf_ops_t *cm_buf_opsp;
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 */
94 /* set this to 1 when we are terminating to prevent access attempts */
95 static int buf_ShutdownFlag = 0;
98 void buf_HoldLockedDbg(cm_buf_t *bp, char *file, long line)
100 void buf_HoldLocked(cm_buf_t *bp)
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);
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)
117 void buf_Hold(cm_buf_t *bp)
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);
129 lock_ReleaseRead(&buf_globalLock);
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)
136 void buf_ReleaseLocked(cm_buf_t *bp, afs_uint32 writeLocked)
142 lock_AssertWrite(&buf_globalLock);
144 lock_AssertRead(&buf_globalLock);
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");
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);
156 osi_panic("buf refcount 0",__FILE__,__LINE__);;
158 osi_assertx(refCount >= 0, "cm_buf_t refCount == 0");
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.
168 lock_ConvertRToW(&buf_globalLock);
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,
175 _InterlockedOr(&bp->qFlags, CM_BUF_QINLRU);
176 buf_IncrementFreeCount();
180 lock_ConvertWToR(&buf_globalLock);
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)
188 void buf_Release(cm_buf_t *bp)
191 lock_ObtainRead(&buf_globalLock);
192 buf_ReleaseLocked(bp, FALSE);
193 lock_ReleaseRead(&buf_globalLock);
197 buf_Sync(int quitOnShutdown)
199 cm_buf_t **bpp, *bp, *prevbp;
200 afs_uint32 wasDirty = 0;
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)
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
214 if (bp->qFlags & CM_BUF_QREDIR) {
215 osi_Log1(buf_logp,"buf_Sync buffer held by redirector bp 0x%p", bp);
217 /* Request single buffer from the redirector */
218 buf_RDRShakeAnExtentFree(bp, &req);
221 lock_ReleaseRead(&buf_globalLock);
223 * all dirty buffers are held when they are added to the
224 * dirty list. No need for an additional hold.
226 lock_ObtainMutex(&bp->mx);
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.
233 * only attempt to write the buffer if the volume might
239 volp = cm_GetVolumeByFID(&bp->fid);
240 switch (cm_GetVolumeStatus(volp, bp->fid.volume)) {
244 req.flags |= CM_REQ_NORETRY;
245 buf_CleanLocked(NULL, bp, &req, 0, &dirty);
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.
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);
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);
274 if (buf_ShutdownFlag) {
277 char volstr[VL_MAXNAMELEN+12]="";
280 volp = cm_GetVolumeByFID(&bp->fid);
283 if (bp->fid.volume == volp->vol[RWVOL].ID)
285 else if (bp->fid.volume == volp->vol[ROVOL].ID)
287 else if (bp->fid.volume == volp->vol[BACKVOL].ID)
291 snprintf(volstr, sizeof(volstr), "%s%s", volp->namep, ext);
293 cellp = cm_FindCellByID(bp->fid.cell, CM_FLAG_NOPROBE);
294 snprintf(volstr, sizeof(volstr), "%u", bp->fid.volume);
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);
302 /* advance the pointer so we don't loop forever */
303 lock_ObtainRead(&buf_globalLock);
307 lock_ReleaseMutex(&bp->mx);
308 } /* for loop over a bunch of buffers */
309 lock_ReleaseRead(&buf_globalLock);
314 /* incremental sync daemon. Writes all dirty buffers every 5000 ms */
316 buf_IncrSyncer(void * parm)
321 while (buf_ShutdownFlag == 0) {
323 i = SleepEx(5000, 1);
330 wasDirty = buf_Sync(1);
331 } /* whole daemon's while loop */
338 buf_ValidateBuffers(void)
340 cm_buf_t * bp, *bpf, *bpa, *bpb;
341 afs_uint64 countb = 0, countf = 0, counta = 0, countr = 0;
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");
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");
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");
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");
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");
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");
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");
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");
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");
412 if (countb != countf) {
413 afsi_log("cm_ValidateBuffers failure: countb != countf");
414 fprintf(stderr, "cm_ValidateBuffers failure: countb != countf\n");
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");
427 void buf_Shutdown(void)
429 /* disable the buf_IncrSyncer() threads */
430 buf_ShutdownFlag = 1;
432 /* then force all dirty buffers to the file servers */
436 /* initialize the buffer package; called with no locks
437 * held during the initialization phase.
439 long buf_Init(int newFile, cm_buf_ops_t *opsp, afs_uint64 nbuffers)
441 static osi_once_t once;
444 pthread_attr_t tattr;
451 cm_data.buf_nbuffers = nbuffers;
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;
458 /* recall for callouts */
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);
467 /* remember this for those who want to reset it */
468 cm_data.buf_nOrigBuffers = cm_data.buf_nbuffers;
470 /* lower hash size to a prime number */
471 cm_data.buf_hashSize = cm_NextHighestPowerOf2((afs_uint32)(cm_data.buf_nbuffers/7));
473 /* create hash table */
474 memset((void *)cm_data.buf_scacheHashTablepp, 0, cm_data.buf_hashSize * sizeof(cm_buf_t *));
476 /* another hash table */
477 memset((void *)cm_data.buf_fileHashTablepp, 0, cm_data.buf_hashSize * sizeof(cm_buf_t *));
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;
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");
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;
497 osi_QAddH( (osi_queue_t **) &cm_data.buf_freeListp,
498 (osi_queue_t **) &cm_data.buf_freeListEndp,
500 _InterlockedOr(&bp->qFlags, CM_BUF_QINLRU);
501 buf_IncrementFreeCount();
502 lock_InitializeMutex(&bp->mx, "Buffer mutex", LOCK_HIERARCHY_BUFFER);
504 /* grab appropriate number of bytes from aligned zone */
509 data += cm_data.buf_blockSize;
512 /* none reserved at first */
513 cm_data.buf_reservedBufs = 0;
515 /* just for safety's sake */
516 cm_data.buf_maxReservedBufs = cm_data.buf_nbuffers - 3;
518 bp = cm_data.bufHeaderBaseAddress;
519 data = cm_data.bufDataBaseAddress;
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);
526 bp->waitRequests = 0;
527 _InterlockedAnd(&bp->flags, ~CM_BUF_WAITING);
529 if (bp->qFlags & CM_BUF_QREDIR) {
531 * extent was not returned by the file system driver.
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);
545 * There should be nothing left in cm_data.buf_redirListp
546 * but double check just to be sure.
548 for ( bp = cm_data.buf_redirListp;
550 bp = cm_data.buf_redirListp)
553 * extent was not returned by the file system driver.
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);
563 lock_ReleaseWrite(&buf_globalLock);
567 buf_ValidateBufQueues();
571 /* init the buffer trace log */
572 buf_logp = osi_LogCreate("buffer", 1000);
573 osi_LogEnable(buf_logp);
578 /* and create the incr-syncer */
579 pthread_attr_init(&tattr);
580 pthread_attr_setdetachstate(&tattr, PTHREAD_CREATE_DETACHED);
582 pstatus = pthread_create(&phandle, &tattr, buf_IncrSyncer, 0);
583 osi_assertx(pstatus == 0, "buf: can't create incremental sync proc");
585 pthread_attr_destroy(&tattr);
589 buf_ValidateBufQueues();
594 /* add nbuffers to the buffer pool, if possible.
595 * Called with no locks held.
597 long buf_AddBuffers(afs_uint64 nbuffers)
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.
604 * A similar problem now occurs with the persistent cache
605 * given that the memory mapped file now contains a complex
608 afsi_log("request to add %d buffers to the existing cache of size %d denied",
609 nbuffers, cm_data.buf_nbuffers);
611 return CM_ERROR_INVAL;
614 /* interface to set the number of buffers to an exact figure.
615 * Called with no locks held.
617 long buf_SetNBuffers(afs_uint64 nbuffers)
620 return CM_ERROR_INVAL;
621 if (nbuffers == cm_data.buf_nbuffers)
623 else if (nbuffers > cm_data.buf_nbuffers)
624 return buf_AddBuffers(nbuffers - cm_data.buf_nbuffers);
626 return CM_ERROR_INVAL;
629 /* wait for reading or writing to clear; called with write-locked
630 * buffer and unlocked scp and returns with locked buffer.
632 void buf_WaitIO(cm_scache_t * scp, cm_buf_t *bp)
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");
641 /* if no IO is happening, we're done */
642 if (!(bp->flags & (CM_BUF_READING | CM_BUF_WRITING)))
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.
649 if ( bp->flags & CM_BUF_WAITING ) {
652 osi_Log1(buf_logp, "buf_WaitIO CM_BUF_WAITING already set for 0x%p", bp);
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;
658 osi_SleepM((LONG_PTR)bp, &bp->mx);
660 cm_UpdateServerPriority();
662 lock_ObtainMutex(&bp->mx);
663 osi_Log1(buf_logp, "buf_WaitIO conflict wait done for 0x%p", bp);
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;
672 if (scp = cm_FindSCache(&bp->fid))
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);
681 lock_ReleaseRead(&scp->rw);
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.
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);
692 osi_Log1(buf_logp, "WaitIO finished wait for bp 0x%p", bp);
695 cm_ReleaseSCache(scp);
698 /* find a buffer, if any, for a particular file ID and offset. Assumes
699 * that buf_globalLock is write locked when called.
701 cm_buf_t *buf_FindLocked(struct cm_fid *fidp, osi_hyper_t *offsetp)
706 lock_AssertAny(&buf_globalLock);
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) {
718 /* return whatever we found, if anything */
722 /* find a buffer with offset *offsetp for vnode *scp. Called
723 * with no locks held.
725 cm_buf_t *buf_Find(struct cm_fid *fidp, osi_hyper_t *offsetp)
729 lock_ObtainRead(&buf_globalLock);
730 bp = buf_FindLocked(fidp, offsetp);
731 lock_ReleaseRead(&buf_globalLock);
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
740 cm_buf_t *buf_FindAllLocked(struct cm_fid *fidp, osi_hyper_t *offsetp, afs_uint32 flags)
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) {
754 for(bp = cm_data.buf_allp; bp; bp=bp->allp) {
755 if (cm_FidCmp(fidp, &bp->fid) == 0) {
758 fileOffset = offsetp->QuadPart + cm_data.baseAddress;
759 if (fileOffset == bp->datap) {
766 /* return whatever we found, if anything */
770 /* find a buffer with offset *offsetp for vnode *scp. Called
771 * with no locks held. Use the all buffer list.
773 cm_buf_t *buf_FindAll(struct cm_fid *fidp, osi_hyper_t *offsetp, afs_uint32 flags)
777 lock_ObtainRead(&buf_globalLock);
778 bp = buf_FindAllLocked(fidp, offsetp, flags);
779 lock_ReleaseRead(&buf_globalLock);
784 /* start cleaning I/O on this buffer. Buffer must be write locked, and is returned
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.
791 * Returns non-zero if the buffer was dirty.
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.
796 afs_uint32 buf_CleanLocked(cm_scache_t *scp, cm_buf_t *bp, cm_req_t *reqp,
797 afs_uint32 flags, afs_uint32 *pisdirty)
800 afs_uint32 isdirty = 0;
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");
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.
814 cm_GetSCache(&bp->fid, NULL, &scp,
815 bp->userp ? bp->userp : cm_rootUserp,
821 while ((bp->flags & CM_BUF_DIRTY) == CM_BUF_DIRTY) {
823 lock_ReleaseMutex(&bp->mx);
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.
833 osi_Log1(buf_logp, "buf_CleanLocked unable to start I/O - scp not found buf 0x%p", bp);
834 code = CM_ERROR_NOSUCHFILE;
836 osi_Log2(buf_logp, "buf_CleanLocked starts I/O on scp 0x%p buf 0x%p", scp, bp);
839 LargeIntegerAdd(offset, ConvertLongToLargeInteger(bp->dirty_offset));
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.
846 code = (*cm_buf_opsp->Writep)(scp, &offset,
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);
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
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;
864 bp->dataVersion = CM_BUF_VERSION_BAD;
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 */
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
879 if (reqp->flags & CM_REQ_NORETRY)
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) {
891 cm_ReleaseSCache(scp);
893 /* if someone was waiting for the I/O that just completed or failed,
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);
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.
912 void buf_Recycle(cm_buf_t *bp)
917 cm_buf_t *prevBp, *nextBp;
919 osi_assertx(bp->magic == CM_BUF_MAGIC, "invalid cm_buf_t magic");
921 osi_assertx(!(bp->qFlags & CM_BUF_QREDIR), "can't recycle redir held buffers");
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.
930 osi_Log3( buf_logp, "buf_Recycle recycles 0x%p, off 0x%x:%08x",
931 bp, bp->offset.HighPart, bp->offset.LowPart);
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);
938 if (bp->qFlags & CM_BUF_QINHASH) {
939 /* Remove from hash */
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) {
948 /* we better find it */
949 osi_assertx(tbp != NULL, "buf_Recycle: hash table screwup");
951 *lbpp = bp->hashp; /* hash out */
954 /* Remove from file hash */
956 i = BUF_FILEHASH(&bp->fid);
957 prevBp = bp->fileHashBackp;
958 bp->fileHashBackp = NULL;
959 nextBp = bp->fileHashp;
960 bp->fileHashp = NULL;
962 prevBp->fileHashp = nextBp;
964 cm_data.buf_fileHashTablepp[i] = nextBp;
966 nextBp->fileHashBackp = prevBp;
968 _InterlockedAnd(&bp->qFlags, ~CM_BUF_QINHASH);
971 /* make the fid unrecognizable */
972 memset(&bp->fid, 0, sizeof(cm_fid_t));
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 */
981 * buf_RDRShakeAnExtentFree
982 * called with buf_globalLock read locked
985 buf_RDRShakeAnExtentFree(cm_buf_t *rbp, cm_req_t *reqp)
988 LARGE_INTEGER heldExtents = {0,0};
989 AFSFileExtentCB extentList[1];
990 DWORD extentCount = 0;
993 if (!(rbp->qFlags & CM_BUF_QREDIR))
996 lock_ReleaseRead(&buf_globalLock);
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;
1005 lock_ObtainMutex(&buf_rdrReleaseExtentsLock);
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;
1014 code = RDR_RequestExtentRelease(&rbp->fid, heldExtents, extentCount, extentList);
1016 lock_ReleaseMutex(&buf_rdrReleaseExtentsLock);
1019 lock_ObtainRead(&buf_globalLock);
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
1030 buf_RDRShakeFileExtentsFree(cm_scache_t *rscp, cm_req_t *reqp)
1032 afs_uint32 code = 0;
1033 afs_uint64 n_redir = 0;
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;
1040 lock_ObtainMutex(&buf_rdrReleaseExtentsLock);
1043 for ( code = CM_ERROR_RETRY; code == CM_ERROR_RETRY; ) {
1044 LARGE_INTEGER heldExtents = {0,0};
1045 AFSFileExtentCB extentList[1024];
1046 DWORD extentCount = 0;
1050 /* only retry if a call to RDR_RequestExtentRelease says to */
1052 lock_ObtainWrite(&buf_globalLock);
1054 if (rscp->redirBufCount == 0)
1056 lock_ReleaseWrite(&buf_globalLock);
1061 for ( srbp = redirq_to_cm_buf_t(rscp->redirQueueT);
1063 srbp = ((code == 0 && extentCount == 0) ? redirq_to_cm_buf_t(rscp->redirQueueT) :
1064 redirq_to_cm_buf_t(osi_QPrev(&srbp->redirq))))
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;
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);
1078 if (code == CM_ERROR_RETRY) {
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.
1087 lock_ObtainWrite(&buf_globalLock);
1090 lock_ReleaseWrite(&buf_globalLock);
1092 if (code == 0 && extentCount > 0) {
1093 heldExtents.QuadPart = cm_data.buf_redirCount;
1094 code = RDR_RequestExtentRelease(&rscp->fid, heldExtents, extentCount, extentList);
1097 if ((code == CM_ERROR_RETRY) && (reqp->flags & CM_REQ_NORETRY)) {
1098 code = CM_ERROR_WOULDBLOCK;
1102 lock_ReleaseMutex(&buf_rdrReleaseExtentsLock);
1107 buf_RDRShakeSomeExtentsFree(cm_req_t *reqp, afs_uint32 oneFid, afs_uint32 minage)
1109 afs_uint32 code = 0;
1111 if (!lock_TryMutex(&buf_rdrReleaseExtentsLock)) {
1112 if (reqp->flags & CM_REQ_NORETRY)
1113 return CM_ERROR_WOULDBLOCK;
1115 osi_Log0(afsd_logp, "Waiting for prior RDR_RequestExtentRelease request to complete");
1116 lock_ObtainMutex(&buf_rdrReleaseExtentsLock);
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;
1126 BOOL locked = FALSE;
1128 /* only retry if a call to RDR_RequestExtentRelease says to */
1130 lock_ObtainWrite(&buf_globalLock);
1133 for ( rbp = cm_data.buf_redirListEndp;
1134 code == 0 && rbp && (!oneFid || extentCount == 0);
1135 rbp = (cm_buf_t *) osi_QPrev(&rbp->q))
1140 if (rbp->redirLastAccess >= rbp->redirReleaseRequested) {
1141 rscp = cm_FindSCache(&rbp->fid);
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)))
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.
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;
1165 cm_ReleaseSCache(rscp);
1168 if ( !oneFid && extentCount > 0) {
1170 lock_ReleaseWrite(&buf_globalLock);
1173 heldExtents.QuadPart = cm_data.buf_redirCount;
1174 code = RDR_RequestExtentRelease(&rbp->fid, heldExtents, extentCount, extentList);
1177 lock_ObtainWrite(&buf_globalLock);
1182 lock_ReleaseWrite(&buf_globalLock);
1185 heldExtents.QuadPart = cm_data.buf_redirCount;
1186 if (rbp && extentCount)
1187 code = RDR_RequestExtentRelease(&rbp->fid, heldExtents, extentCount, extentList);
1189 code = RDR_RequestExtentRelease(NULL, heldExtents, 1024, NULL);
1195 if ((code == CM_ERROR_RETRY) && (reqp->flags & CM_REQ_NORETRY)) {
1196 code = CM_ERROR_WOULDBLOCK;
1200 lock_ReleaseMutex(&buf_rdrReleaseExtentsLock);
1204 /* returns 0 if the buffer does not exist, and non-0 if it does */
1206 buf_ExistsLocked(struct cm_scache *scp, osi_hyper_t *offsetp)
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
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);
1220 return CM_BUF_EXISTS;
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.
1231 * If success is returned, the buffer is returned write-locked.
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.
1237 long buf_GetNewLocked(struct cm_scache *scp, osi_hyper_t *offsetp, cm_req_t *reqp, cm_buf_t **bufpp)
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;
1245 buf_ValidateBufQueues();
1246 #endif /* TESTING */
1256 lock_ObtainRead(&scp->bufCreateLock);
1257 lock_ObtainWrite(&buf_globalLock);
1258 /* check to see if we lost the race */
1259 if (buf_ExistsLocked(scp, offsetp)) {
1260 lock_ReleaseWrite(&buf_globalLock);
1261 lock_ReleaseRead(&scp->bufCreateLock);
1262 return CM_BUF_EXISTS;
1265 /* does this fix the problem below? it's a simple solution. */
1266 if (!cm_data.buf_freeListEndp)
1268 lock_ReleaseWrite(&buf_globalLock);
1269 lock_ReleaseRead(&scp->bufCreateLock);
1271 if ( RDR_Initialized )
1274 osi_Log0(afsd_logp, "buf_GetNewLocked: Free Buffer List is empty - sleeping 200ms");
1279 /* for debugging, assert free list isn't empty, although we
1280 * really should try waiting for a running tranasction to finish
1281 * instead of this; or better, we should have a transaction
1282 * throttler prevent us from entering this situation.
1284 osi_assertx(cm_data.buf_freeListEndp != NULL, "buf_GetNewLocked: no free buffers");
1286 /* look at all buffers in free list, some of which may temp.
1287 * have high refcounts and which then should be skipped,
1288 * starting cleaning I/O for those which are dirty. If we find
1289 * a clean buffer, we rehash it, lock it and return it.
1291 for (bp = cm_data.buf_freeListEndp; bp; bp=(cm_buf_t *) osi_QPrev(&bp->q)) {
1297 /* check to see if it really has zero ref count. This
1298 * code can bump refcounts, at least, so it may not be
1301 if (bp->refCount > 0) {
1306 /* we don't have to lock buffer itself, since the ref
1307 * count is 0 and we know it will stay zero as long as
1308 * we hold the global lock.
1311 /* don't recycle someone in our own chunk */
1312 if (!cm_FidCmp(&bp->fid, &scp->fid) &&
1313 bp->dataVersion >= scp->bufDataVersionLow &&
1314 bp->dataVersion <= scp->dataVersion &&
1315 (bp->offset.LowPart & (-cm_chunkSize)) == (offsetp->LowPart & (-cm_chunkSize))) {
1320 /* if this page is being filled (!) or cleaned, see if
1321 * the I/O has completed. If not, skip it, otherwise
1322 * do the final processing for the I/O.
1324 if (bp->flags & (CM_BUF_READING | CM_BUF_WRITING)) {
1325 /* probably shouldn't do this much work while
1326 * holding the big lock? Watch for contention
1333 if (bp->flags & CM_BUF_DIRTY) {
1336 /* leave the buffer alone if held by the redirector */
1337 if (bp->qFlags & CM_BUF_QREDIR)
1340 /* protect against cleaning the same buffer more than once. */
1344 /* if the buffer is dirty, start cleaning it and
1345 * move on to the next buffer. We do this with
1346 * just the lock required to minimize contention
1350 lock_ReleaseWrite(&buf_globalLock);
1351 lock_ReleaseRead(&scp->bufCreateLock);
1354 * grab required lock and clean.
1355 * previously the claim was that the cleaning
1356 * operation was async which it is not. It would
1357 * be a good idea to use an async mechanism here
1358 * but there is none at the moment other than
1359 * the buf_IncrSyncer() thread.
1361 if (cm_FidCmp(&scp->fid, &bp->fid) == 0)
1362 buf_Clean(scp, bp, reqp, 0, NULL);
1364 buf_Clean(NULL, bp, reqp, 0, NULL);
1366 /* now put it back and go around again */
1369 /* but first obtain the locks we gave up
1370 * before the buf_CleanAsync() call */
1371 lock_ObtainRead(&scp->bufCreateLock);
1372 lock_ObtainWrite(&buf_globalLock);
1375 * Since we dropped the locks we need to verify that
1376 * another thread has not allocated the buffer for us.
1378 if (buf_ExistsLocked(scp, offsetp)) {
1379 lock_ReleaseWrite(&buf_globalLock);
1380 lock_ReleaseRead(&scp->bufCreateLock);
1381 return CM_BUF_EXISTS;
1385 * We just cleaned this buffer so we need to
1386 * restart the loop with this buffer so it
1387 * can be retested. Set 'cleaned' so we
1388 * do not attempt another call to buf_Clean()
1389 * if the prior attempt failed.
1395 osi_Log3(afsd_logp, "buf_GetNewLocked: scp 0x%p examined %u buffers before recycling bufp 0x%p",
1397 osi_Log4(afsd_logp, "... nonzero %u; own %u; busy %u; dirty %u", n_nonzero, n_own, n_busy, n_dirty);
1399 /* if we get here, we know that the buffer still has a 0
1400 * ref count, and that it is clean and has no currently
1401 * pending I/O. This is the dude to return.
1402 * Remember that as long as the ref count is 0, we know
1403 * that we won't have any lock conflicts, so we can grab
1404 * the buffer lock out of order in the locking hierarchy.
1408 /* now hash in as our new buffer, and give it the
1409 * appropriate label, if requested.
1412 lock_AssertWrite(&buf_globalLock);
1414 _InterlockedOr(&bp->qFlags, CM_BUF_QINHASH);
1419 bp->offset = *offsetp;
1420 i = BUF_HASH(&scp->fid, offsetp);
1421 bp->hashp = cm_data.buf_scacheHashTablepp[i];
1422 cm_data.buf_scacheHashTablepp[i] = bp;
1423 i = BUF_FILEHASH(&scp->fid);
1424 nextBp = cm_data.buf_fileHashTablepp[i];
1425 bp->fileHashp = nextBp;
1426 bp->fileHashBackp = NULL;
1428 nextBp->fileHashBackp = bp;
1429 cm_data.buf_fileHashTablepp[i] = bp;
1432 /* we should remove it from the lru queue. It better still be there,
1433 * since we've held the global (big) lock since we found it there.
1435 osi_assertx(bp->qFlags & CM_BUF_QINLRU,
1436 "buf_GetNewLocked: LRU screwup");
1438 osi_QRemoveHT( (osi_queue_t **) &cm_data.buf_freeListp,
1439 (osi_queue_t **) &cm_data.buf_freeListEndp,
1441 _InterlockedAnd(&bp->qFlags, ~CM_BUF_QINLRU);
1442 buf_DecrementFreeCount();
1444 /* prepare to return it. Give it a refcount */
1445 InterlockedIncrement(&bp->refCount);
1446 #ifdef DEBUG_REFCOUNT
1447 osi_Log2(afsd_logp,"buf_GetNewLocked bp 0x%p ref %d", bp, 1);
1448 afsi_log("%s:%d buf_GetNewLocked bp 0x%p, ref %d", __FILE__, __LINE__, bp, 1);
1450 /* grab the mutex so that people don't use it
1451 * before the caller fills it with data. Again, no one
1452 * should have been able to get to this dude to lock it.
1454 if (!lock_TryMutex(&bp->mx)) {
1455 osi_Log2(afsd_logp, "buf_GetNewLocked bp 0x%p cannot be mutex locked. refCount %d should be 0",
1457 osi_panic("buf_GetNewLocked: TryMutex failed",__FILE__,__LINE__);
1460 lock_ReleaseWrite(&buf_globalLock);
1461 lock_ReleaseRead(&scp->bufCreateLock);
1466 buf_ValidateBufQueues();
1467 #endif /* TESTING */
1469 } /* for all buffers in lru queue */
1470 lock_ReleaseWrite(&buf_globalLock);
1471 lock_ReleaseRead(&scp->bufCreateLock);
1473 osi_Log1(afsd_logp, "buf_GetNewLocked: Free Buffer List has %u buffers none free", n_bufs);
1474 osi_Log4(afsd_logp, "... nonzero %u; own %u; busy %u; dirty %u", n_nonzero, n_own, n_busy, n_dirty);
1476 if (RDR_Initialized) {
1479 code = buf_RDRShakeSomeExtentsFree(reqp, TRUE, 2 /* seconds */);
1481 case CM_ERROR_RETRY:
1484 case CM_ERROR_WOULDBLOCK:
1485 return CM_ERROR_WOULDBLOCK;
1489 Sleep(100); /* give some time for a buffer to be freed */
1490 } /* while loop over everything */
1495 * get a page, returning it held but unlocked. the page may or may not
1496 * contain valid data.
1498 * The scp must be unlocked when passed in unlocked.
1500 long buf_Get(struct cm_scache *scp, osi_hyper_t *offsetp, cm_req_t *reqp, cm_buf_t **bufpp)
1504 osi_hyper_t pageOffset;
1505 unsigned long tcount;
1509 cm_diskcache_t *dcp;
1510 #endif /* DISKCACHE95 */
1513 pageOffset.HighPart = offsetp->HighPart;
1514 pageOffset.LowPart = offsetp->LowPart & ~(cm_data.buf_blockSize-1);
1518 buf_ValidateBufQueues();
1519 #endif /* TESTING */
1521 bp = buf_Find(&scp->fid, &pageOffset);
1523 /* lock it and break out */
1524 lock_ObtainMutex(&bp->mx);
1527 /* touch disk chunk to update LRU info */
1528 diskcache_Touch(bp->dcp);
1529 #endif /* DISKCACHE95 */
1533 /* otherwise, we have to create a page */
1534 code = buf_GetNewLocked(scp, &pageOffset, reqp, &bp);
1537 /* the requested buffer was created */
1542 * the requested buffer existed by the time the
1543 * scp->bufCreateLock and buf_globalLock could be obtained.
1544 * loop again and permit buf_Find() to obtain a reference.
1549 * the requested buffer could not be created.
1550 * return the error to the caller.
1553 buf_ValidateBufQueues();
1554 #endif /* TESTING */
1557 } /* big while loop */
1559 /* if we get here, we have a locked buffer that may have just been
1560 * created, in which case it needs to be filled with data.
1563 /* load the page; freshly created pages should be idle */
1564 osi_assertx(!(bp->flags & (CM_BUF_READING | CM_BUF_WRITING)), "incorrect cm_buf_t flags");
1567 * start the I/O; may drop lock. as of this writing, the only
1568 * implementation of Readp is cm_BufRead() which simply sets
1569 * tcount to 0 and returns success.
1571 _InterlockedOr(&bp->flags, CM_BUF_READING);
1572 code = (*cm_buf_opsp->Readp)(bp, cm_data.buf_blockSize, &tcount, NULL);
1575 code = diskcache_Get(&bp->fid, &bp->offset, bp->datap, cm_data.buf_blockSize, &bp->dataVersion, &tcount, &dcp);
1576 bp->dcp = dcp; /* pointer to disk cache struct. */
1577 #endif /* DISKCACHE95 */
1580 /* failure or queued */
1582 /* unless cm_BufRead() is altered, this path cannot be hit */
1583 if (code != ERROR_IO_PENDING) {
1585 _InterlockedOr(&bp->flags, CM_BUF_ERROR);
1586 _InterlockedAnd(&bp->flags, ~CM_BUF_READING);
1587 if (bp->flags & CM_BUF_WAITING) {
1588 osi_Log1(buf_logp, "buf_Get Waking bp 0x%p", bp);
1589 osi_Wakeup((LONG_PTR) bp);
1591 lock_ReleaseMutex(&bp->mx);
1594 buf_ValidateBufQueues();
1595 #endif /* TESTING */
1600 * otherwise, I/O completed instantly and we're done, except
1601 * for padding the xfr out with 0s and checking for EOF
1603 if (tcount < (unsigned long) cm_data.buf_blockSize) {
1604 memset(bp->datap+tcount, 0, cm_data.buf_blockSize - tcount);
1606 _InterlockedOr(&bp->flags, CM_BUF_EOF);
1608 _InterlockedAnd(&bp->flags, ~CM_BUF_READING);
1609 if (bp->flags & CM_BUF_WAITING) {
1610 osi_Log1(buf_logp, "buf_Get Waking bp 0x%p", bp);
1611 osi_Wakeup((LONG_PTR) bp);
1616 /* wait for reads, either that which we started above, or that someone
1617 * else started. We don't care if we return a buffer being cleaned.
1619 if (bp->flags & CM_BUF_READING)
1620 buf_WaitIO(scp, bp);
1622 /* once it has been read once, we can unlock it and return it, still
1623 * with its refcount held.
1625 lock_ReleaseMutex(&bp->mx);
1628 /* now remove from queue; will be put in at the head (farthest from
1629 * being recycled) when we're done in buf_Release.
1631 lock_ObtainWrite(&buf_globalLock);
1632 if (bp->qFlags & CM_BUF_QINLRU) {
1633 osi_QRemoveHT( (osi_queue_t **) &cm_data.buf_freeListp,
1634 (osi_queue_t **) &cm_data.buf_freeListEndp,
1636 _InterlockedAnd(&bp->qFlags, ~CM_BUF_QINLRU);
1637 buf_DecrementFreeCount();
1639 lock_ReleaseWrite(&buf_globalLock);
1641 osi_Log4(buf_logp, "buf_Get returning bp 0x%p for scp 0x%p, offset 0x%x:%08x",
1642 bp, scp, offsetp->HighPart, offsetp->LowPart);
1644 buf_ValidateBufQueues();
1645 #endif /* TESTING */
1649 /* clean a buffer synchronously */
1650 afs_uint32 buf_Clean(cm_scache_t *scp, cm_buf_t *bp, cm_req_t *reqp, afs_uint32 flags, afs_uint32 *pisdirty)
1653 osi_assertx(bp->magic == CM_BUF_MAGIC, "invalid cm_buf_t magic");
1654 osi_assertx(!(flags & CM_BUF_WRITE_SCP_LOCKED), "scp->rw must not be held when calling buf_CleanAsync");
1656 lock_ObtainMutex(&bp->mx);
1657 code = buf_CleanLocked(scp, bp, reqp, flags, pisdirty);
1658 lock_ReleaseMutex(&bp->mx);
1663 /* wait for a buffer's cleaning to finish */
1664 void buf_CleanWait(cm_scache_t * scp, cm_buf_t *bp, afs_uint32 locked)
1666 osi_assertx(bp->magic == CM_BUF_MAGIC, "invalid cm_buf_t magic");
1669 lock_ObtainMutex(&bp->mx);
1670 if (bp->flags & CM_BUF_WRITING) {
1671 buf_WaitIO(scp, bp);
1674 lock_ReleaseMutex(&bp->mx);
1677 /* set the dirty flag on a buffer, and set associated write-ahead log,
1678 * if there is one. Allow one to be added to a buffer, but not changed.
1680 * The buffer must be locked before calling this routine.
1682 void buf_SetDirty(cm_buf_t *bp, cm_req_t *reqp, afs_uint32 offset, afs_uint32 length, cm_user_t *userp)
1684 osi_assertx(bp->magic == CM_BUF_MAGIC, "invalid cm_buf_t magic");
1685 osi_assertx(bp->refCount > 0, "cm_buf_t refcount 0");
1690 if (bp->flags & CM_BUF_DIRTY) {
1692 osi_Log1(buf_logp, "buf_SetDirty 0x%p already dirty", bp);
1694 if (bp->dirty_offset <= offset) {
1695 if (bp->dirty_offset + bp->dirty_length >= offset + length) {
1696 /* dirty_length remains the same */
1698 bp->dirty_length = offset + length - bp->dirty_offset;
1700 } else /* bp->dirty_offset > offset */ {
1701 if (bp->dirty_offset + bp->dirty_length >= offset + length) {
1702 bp->dirty_length = bp->dirty_offset + bp->dirty_length - offset;
1704 bp->dirty_length = length;
1706 bp->dirty_offset = offset;
1709 osi_Log1(buf_logp, "buf_SetDirty 0x%p", bp);
1712 _InterlockedOr(&bp->flags, CM_BUF_DIRTY);
1714 /* and turn off EOF flag, since it has associated data now */
1715 _InterlockedAnd(&bp->flags, ~CM_BUF_EOF);
1717 bp->dirty_offset = offset;
1718 bp->dirty_length = length;
1721 * if the request is not from the afs redirector,
1722 * add to the dirty list. The redirector interface ensures
1723 * that a background store operation is queued for each and
1724 * every dirty extent that is released. Therefore, the
1725 * buf_IncrSyncer thread is not required to ensure that
1726 * dirty buffers are written to the file server.
1728 * we obtain a hold on the buffer for as long as it remains
1729 * in the list. buffers are only removed from the list by
1730 * the buf_IncrSyncer function regardless of when else the
1731 * dirty flag might be cleared.
1733 * This should never happen but just in case there is a bug
1734 * elsewhere, never add to the dirty list if the buffer is
1737 if (!(reqp->flags & CM_REQ_SOURCE_REDIR)) {
1738 lock_ObtainWrite(&buf_globalLock);
1739 if (!(bp->qFlags & CM_BUF_QINDL)) {
1741 if (!cm_data.buf_dirtyListp) {
1742 cm_data.buf_dirtyListp = cm_data.buf_dirtyListEndp = bp;
1744 cm_data.buf_dirtyListEndp->dirtyp = bp;
1745 cm_data.buf_dirtyListEndp = bp;
1748 _InterlockedOr(&bp->qFlags, CM_BUF_QINDL);
1750 lock_ReleaseWrite(&buf_globalLock);
1754 /* and record the last writer */
1755 if (bp->userp != userp) {
1758 cm_ReleaseUser(bp->userp);
1763 /* clean all buffers, reset log pointers and invalidate all buffers.
1764 * Called with no locks held, and returns with same.
1766 * This function is guaranteed to clean and remove the log ptr of all the
1767 * buffers that were dirty or had non-zero log ptrs before the call was
1768 * made. That's sufficient to clean up any garbage left around by recovery,
1769 * which is all we're counting on this for; there may be newly created buffers
1770 * added while we're running, but that should be OK.
1772 * In an environment where there are no transactions (artificially imposed, for
1773 * example, when switching the database to raw mode), this function is used to
1774 * make sure that all updates have been written to the disk. In that case, we don't
1775 * really require that we forget the log association between pages and logs, but
1776 * it also doesn't hurt. Since raw mode I/O goes through this buffer package, we don't
1777 * have to worry about invalidating data in the buffers.
1779 * This function is used at the end of recovery as paranoia to get the recovered
1780 * database out to disk. It removes all references to the recovery log and cleans
1783 long buf_CleanAndReset(void)
1789 lock_ObtainRead(&buf_globalLock);
1790 for(i=0; i<cm_data.buf_hashSize; i++) {
1791 for(bp = cm_data.buf_scacheHashTablepp[i]; bp; bp = bp->hashp) {
1792 if (bp->qFlags & CM_BUF_QREDIR) {
1793 osi_Log1(buf_logp,"buf_CleanAndReset buffer held by redirector bp 0x%p", bp);
1795 /* Request single extent from the redirector */
1796 buf_RDRShakeAnExtentFree(bp, &req);
1799 if ((bp->flags & CM_BUF_DIRTY) == CM_BUF_DIRTY) {
1801 lock_ReleaseRead(&buf_globalLock);
1803 /* now no locks are held; clean buffer and go on */
1805 req.flags |= CM_REQ_NORETRY;
1807 buf_Clean(NULL, bp, &req, 0, NULL);
1808 buf_CleanWait(NULL, bp, FALSE);
1810 /* relock and release buffer */
1811 lock_ObtainRead(&buf_globalLock);
1812 buf_ReleaseLocked(bp, FALSE);
1814 } /* over one bucket */
1815 } /* for loop over all hash buckets */
1818 lock_ReleaseRead(&buf_globalLock);
1821 buf_ValidateBufQueues();
1822 #endif /* TESTING */
1824 /* and we're done */
1828 /* called without global lock being held, reserves buffers for callers
1829 * that need more than one held (not locked) at once.
1831 void buf_ReserveBuffers(afs_uint64 nbuffers)
1833 lock_ObtainWrite(&buf_globalLock);
1835 if (cm_data.buf_reservedBufs + nbuffers > cm_data.buf_maxReservedBufs) {
1836 cm_data.buf_reserveWaiting = 1;
1837 osi_Log1(buf_logp, "buf_ReserveBuffers waiting for %d bufs", nbuffers);
1838 osi_SleepW((LONG_PTR) &cm_data.buf_reservedBufs, &buf_globalLock);
1839 lock_ObtainWrite(&buf_globalLock);
1842 cm_data.buf_reservedBufs += nbuffers;
1846 lock_ReleaseWrite(&buf_globalLock);
1849 int buf_TryReserveBuffers(afs_uint64 nbuffers)
1853 lock_ObtainWrite(&buf_globalLock);
1854 if (cm_data.buf_reservedBufs + nbuffers > cm_data.buf_maxReservedBufs) {
1858 cm_data.buf_reservedBufs += nbuffers;
1861 lock_ReleaseWrite(&buf_globalLock);
1865 /* called without global lock held, releases reservation held by
1866 * buf_ReserveBuffers.
1868 void buf_UnreserveBuffers(afs_uint64 nbuffers)
1870 lock_ObtainWrite(&buf_globalLock);
1871 cm_data.buf_reservedBufs -= nbuffers;
1872 if (cm_data.buf_reserveWaiting) {
1873 cm_data.buf_reserveWaiting = 0;
1874 osi_Wakeup((LONG_PTR) &cm_data.buf_reservedBufs);
1876 lock_ReleaseWrite(&buf_globalLock);
1879 /* truncate the buffers past sizep, zeroing out the page, if we don't
1880 * end on a page boundary.
1882 * Requires cm_bufCreateLock to be write locked.
1884 long buf_Truncate(cm_scache_t *scp, cm_user_t *userp, cm_req_t *reqp,
1888 cm_buf_t *nbufp; /* next buffer, if didRelease */
1893 afs_uint32 invalidate = 0;
1895 /* assert that cm_bufCreateLock is held in write mode */
1896 lock_AssertWrite(&scp->bufCreateLock);
1898 i = BUF_FILEHASH(&scp->fid);
1900 lock_ObtainRead(&buf_globalLock);
1901 bufp = cm_data.buf_fileHashTablepp[i];
1903 lock_ReleaseRead(&buf_globalLock);
1907 buf_HoldLocked(bufp);
1908 lock_ReleaseRead(&buf_globalLock);
1911 lock_ObtainMutex(&bufp->mx);
1913 bufEnd.HighPart = 0;
1914 bufEnd.LowPart = cm_data.buf_blockSize;
1915 bufEnd = LargeIntegerAdd(bufEnd, bufp->offset);
1917 if (cm_FidCmp(&bufp->fid, &scp->fid) == 0 &&
1918 LargeIntegerLessThan(*sizep, bufEnd)) {
1919 buf_WaitIO(scp, bufp);
1921 lock_ObtainWrite(&scp->rw);
1923 /* make sure we have a callback (so we have the right value for
1924 * the length), and wait for it to be safe to do a truncate.
1926 code = cm_SyncOp(scp, bufp, userp, reqp, 0,
1927 CM_SCACHESYNC_NEEDCALLBACK
1928 | CM_SCACHESYNC_GETSTATUS
1929 | CM_SCACHESYNC_SETSIZE
1930 | CM_SCACHESYNC_BUFLOCKED);
1933 /* if we succeeded in our locking, and this applies to the right
1934 * file, and the truncate request overlaps the buffer either
1935 * totally or partially, then do something.
1937 if (code == 0 && cm_FidCmp(&bufp->fid, &scp->fid) == 0
1938 && LargeIntegerLessThan(*sizep, bufEnd)) {
1941 /* destroy the buffer, turning off its dirty bit, if
1942 * we're truncating the whole buffer. Otherwise, set
1943 * the dirty bit, and clear out the tail of the buffer
1944 * if we just overlap some.
1946 if (LargeIntegerLessThanOrEqualTo(*sizep, bufp->offset)) {
1947 /* truncating the entire page */
1948 if (reqp->flags & CM_REQ_SOURCE_REDIR) {
1950 * Implicitly clear the redirector flag
1951 * and release the matching hold.
1953 if (bufp->qFlags & CM_BUF_QREDIR) {
1954 osi_Log4(buf_logp,"buf_Truncate taking from file system bufp 0x%p vno 0x%x foffset 0x%x:%x",
1955 bufp, bufp->fid.vnode, bufp->offset.HighPart, bufp->offset.LowPart);
1956 lock_ObtainWrite(&buf_globalLock);
1957 if (bufp->qFlags & CM_BUF_QREDIR) {
1958 buf_RemoveFromRedirQueue(scp, bufp);
1959 buf_ReleaseLocked(bufp, TRUE);
1961 lock_ReleaseWrite(&buf_globalLock);
1966 _InterlockedAnd(&bufp->flags, ~CM_BUF_DIRTY);
1968 bufp->dirty_offset = 0;
1969 bufp->dirty_length = 0;
1970 bufp->dataVersion = CM_BUF_VERSION_BAD; /* known bad */
1971 bufp->dirtyCounter++;
1974 /* don't set dirty, since dirty implies
1975 * currently up-to-date. Don't need to do this,
1976 * since we'll update the length anyway.
1978 * Zero out remainder of the page, in case we
1979 * seek and write past EOF, and make this data
1982 bufferPos = sizep->LowPart & (cm_data.buf_blockSize - 1);
1983 osi_assertx(bufferPos != 0, "non-zero bufferPos");
1984 memset(bufp->datap + bufferPos, 0,
1985 cm_data.buf_blockSize - bufferPos);
1989 cm_SyncOpDone( scp, bufp,
1990 CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS
1991 | CM_SCACHESYNC_SETSIZE | CM_SCACHESYNC_BUFLOCKED);
1993 lock_ReleaseWrite(&scp->rw);
1994 lock_ReleaseMutex(&bufp->mx);
1997 nbufp = bufp->fileHashp;
2001 /* This forces the loop to end and the error code
2002 * to be returned. */
2010 buf_ValidateBufQueues();
2011 #endif /* TESTING */
2013 if (invalidate && RDR_Initialized)
2014 RDR_InvalidateObject(scp->fid.cell, scp->fid.volume, scp->fid.vnode,
2015 scp->fid.unique, scp->fid.hash,
2016 scp->fileType, AFS_INVALIDATE_SMB);
2022 long buf_FlushCleanPages(cm_scache_t *scp, cm_user_t *userp, cm_req_t *reqp)
2025 cm_buf_t *bp; /* buffer we're hacking on */
2029 afs_uint32 stable = 0;
2031 i = BUF_FILEHASH(&scp->fid);
2034 lock_ObtainRead(&buf_globalLock);
2035 bp = cm_data.buf_fileHashTablepp[i];
2038 lock_ReleaseRead(&buf_globalLock);
2040 for (; bp; bp = nbp) {
2041 didRelease = 0; /* haven't released this buffer yet */
2043 /* clean buffer synchronously */
2044 if (cm_FidCmp(&bp->fid, &scp->fid) == 0) {
2046 if (code == 0 && !stable && (bp->flags & CM_BUF_DIRTY)) {
2048 * we must stabilize the object to ensure that buffer
2049 * changes cannot occur while the flush is performed.
2050 * However, we do not want to Stabilize if we do not
2051 * need to because Stabilize obtains a callback.
2053 code = (*cm_buf_opsp->Stabilizep)(scp, userp, reqp);
2054 stable = (code == 0);
2057 if (code == CM_ERROR_BADFD) {
2058 /* if the scp's FID is bad its because we received VNOVNODE
2059 * when attempting to FetchStatus before the write. This
2060 * page therefore contains data that can no longer be stored.
2062 lock_ObtainMutex(&bp->mx);
2063 _InterlockedAnd(&bp->flags, ~CM_BUF_DIRTY);
2064 _InterlockedOr(&bp->flags, CM_BUF_ERROR);
2065 bp->error = CM_ERROR_BADFD;
2066 bp->dirty_offset = 0;
2067 bp->dirty_length = 0;
2068 bp->dataVersion = CM_BUF_VERSION_BAD; /* known bad */
2070 lock_ReleaseMutex(&bp->mx);
2071 } else if (!(scp->flags & CM_SCACHEFLAG_RO)) {
2076 lock_ObtainMutex(&bp->mx);
2078 /* start cleaning the buffer, and wait for it to finish */
2079 buf_CleanLocked(scp, bp, reqp, 0, NULL);
2080 buf_WaitIO(scp, bp);
2082 lock_ReleaseMutex(&bp->mx);
2085 /* actually, we only know that buffer is clean if ref
2086 * count is 1, since we don't have buffer itself locked.
2088 if (!(bp->flags & CM_BUF_DIRTY) && !(bp->qFlags & CM_BUF_QREDIR)) {
2089 lock_ObtainWrite(&buf_globalLock);
2090 if (!(bp->flags & CM_BUF_DIRTY) && !(bp->qFlags & CM_BUF_QREDIR)) {
2091 if (bp->refCount == 1) { /* bp is held above */
2092 nbp = bp->fileHashp;
2094 buf_HoldLocked(nbp);
2095 buf_ReleaseLocked(bp, TRUE);
2100 lock_ReleaseWrite(&buf_globalLock);
2106 lock_ObtainRead(&buf_globalLock);
2107 nbp = bp->fileHashp;
2109 buf_HoldLocked(nbp);
2110 buf_ReleaseLocked(bp, FALSE);
2111 lock_ReleaseRead(&buf_globalLock);
2113 } /* for loop over a bunch of buffers */
2116 (*cm_buf_opsp->Unstabilizep)(scp, userp);
2119 buf_ValidateBufQueues();
2120 #endif /* TESTING */
2126 /* Must be called with scp->rw held */
2127 long buf_InvalidateBuffers(cm_scache_t * scp)
2133 lock_AssertAny(&scp->rw);
2135 i = BUF_FILEHASH(&scp->fid);
2137 lock_ObtainRead(&buf_globalLock);
2139 for (bp = cm_data.buf_fileHashTablepp[i]; bp; bp = bp->fileHashp) {
2140 if (cm_FidCmp(&bp->fid, &scp->fid) == 0) {
2141 bp->dataVersion = CM_BUF_VERSION_BAD;
2145 lock_ReleaseRead(&buf_globalLock);
2153 /* Must be called with scp->rw held */
2154 long buf_ForceDataVersion(cm_scache_t * scp, afs_uint64 fromVersion, afs_uint64 toVersion)
2160 lock_AssertAny(&scp->rw);
2162 i = BUF_FILEHASH(&scp->fid);
2164 lock_ObtainRead(&buf_globalLock);
2166 for (bp = cm_data.buf_fileHashTablepp[i]; bp; bp = bp->fileHashp) {
2167 if (cm_FidCmp(&bp->fid, &scp->fid) == 0) {
2168 if (bp->dataVersion == fromVersion) {
2169 bp->dataVersion = toVersion;
2174 lock_ReleaseRead(&buf_globalLock);
2182 long buf_CleanVnode(struct cm_scache *scp, cm_user_t *userp, cm_req_t *reqp)
2186 cm_buf_t *bp; /* buffer we're hacking on */
2187 cm_buf_t *nbp; /* next one */
2190 if (RDR_Initialized && scp->redirBufCount > 0) {
2191 /* Retrieve all extents for this file from the redirector */
2192 buf_RDRShakeFileExtentsFree(scp, reqp);
2195 i = BUF_FILEHASH(&scp->fid);
2197 lock_ObtainRead(&buf_globalLock);
2198 bp = cm_data.buf_fileHashTablepp[i];
2201 lock_ReleaseRead(&buf_globalLock);
2202 for (; bp; bp = nbp) {
2203 /* clean buffer synchronously */
2204 if (cm_FidCmp(&bp->fid, &scp->fid) == 0) {
2206 * If the buffer is held by the redirector we must fetch
2207 * it back in order to determine whether or not it is in
2210 lock_ObtainRead(&buf_globalLock);
2211 if (bp->qFlags & CM_BUF_QREDIR) {
2212 osi_Log1(buf_logp,"buf_CleanVnode buffer held by redirector bp 0x%p", bp);
2214 /* Retrieve single extent from the redirector */
2215 buf_RDRShakeAnExtentFree(bp, reqp);
2217 lock_ReleaseRead(&buf_globalLock);
2219 lock_ObtainMutex(&bp->mx);
2220 if ((bp->flags & CM_BUF_DIRTY)) {
2221 if (userp && userp != bp->userp) {
2224 cm_ReleaseUser(bp->userp);
2229 case CM_ERROR_NOSUCHFILE:
2230 case CM_ERROR_BADFD:
2231 case CM_ERROR_NOACCESS:
2232 case CM_ERROR_QUOTA:
2233 case CM_ERROR_SPACE:
2234 case CM_ERROR_TOOBIG:
2235 case CM_ERROR_READONLY:
2236 case CM_ERROR_NOSUCHPATH:
2238 * Apply the previous fatal error to this buffer.
2239 * Do not waste the time attempting to store to
2240 * the file server when we know it will fail.
2242 _InterlockedAnd(&bp->flags, ~CM_BUF_DIRTY);
2243 _InterlockedOr(&bp->flags, CM_BUF_ERROR);
2244 bp->dirty_offset = 0;
2245 bp->dirty_length = 0;
2247 bp->dataVersion = CM_BUF_VERSION_BAD;
2250 case CM_ERROR_TIMEDOUT:
2251 case CM_ERROR_ALLDOWN:
2252 case CM_ERROR_ALLBUSY:
2253 case CM_ERROR_ALLOFFLINE:
2254 case CM_ERROR_CLOCKSKEW:
2255 /* do not mark the buffer in error state but do
2256 * not attempt to complete the rest either.
2260 code = buf_CleanLocked(scp, bp, reqp, 0, &wasDirty);
2261 if (bp->flags & CM_BUF_ERROR) {
2267 buf_CleanWait(scp, bp, TRUE);
2269 lock_ReleaseMutex(&bp->mx);
2272 lock_ObtainRead(&buf_globalLock);
2273 nbp = bp->fileHashp;
2275 buf_HoldLocked(nbp);
2276 buf_ReleaseLocked(bp, FALSE);
2277 lock_ReleaseRead(&buf_globalLock);
2278 } /* for loop over a bunch of buffers */
2281 buf_ValidateBufQueues();
2282 #endif /* TESTING */
2290 buf_ValidateBufQueues(void)
2292 cm_buf_t * bp, *bpb, *bpf, *bpa;
2293 afs_uint32 countf=0, countb=0, counta=0;
2295 lock_ObtainRead(&buf_globalLock);
2296 for (bp = cm_data.buf_freeListEndp; bp; bp=(cm_buf_t *) osi_QPrev(&bp->q)) {
2297 if (bp->magic != CM_BUF_MAGIC)
2298 osi_panic("buf magic error",__FILE__,__LINE__);
2303 for (bp = cm_data.buf_freeListp; bp; bp=(cm_buf_t *) osi_QNext(&bp->q)) {
2304 if (bp->magic != CM_BUF_MAGIC)
2305 osi_panic("buf magic error",__FILE__,__LINE__);
2310 for (bp = cm_data.buf_allp; bp; bp=bp->allp) {
2311 if (bp->magic != CM_BUF_MAGIC)
2312 osi_panic("buf magic error",__FILE__,__LINE__);
2316 lock_ReleaseRead(&buf_globalLock);
2318 if (countb != countf)
2319 osi_panic("buf magic error",__FILE__,__LINE__);
2321 if (counta != cm_data.buf_nbuffers)
2322 osi_panic("buf magic error",__FILE__,__LINE__);
2324 #endif /* TESTING */
2326 /* dump the contents of the buf_scacheHashTablepp. */
2327 int cm_DumpBufHashTable(FILE *outputFile, char *cookie, int lock)
2334 if (cm_data.buf_scacheHashTablepp == NULL)
2338 lock_ObtainRead(&buf_globalLock);
2340 StringCbPrintfA(output, sizeof(output), "%s - dumping buf_HashTable - buf_hashSize=%d\r\n",
2341 cookie, cm_data.buf_hashSize);
2342 WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2344 for (i = 0; i < cm_data.buf_hashSize; i++)
2346 for (bp = cm_data.buf_scacheHashTablepp[i]; bp; bp=bp->hashp)
2348 StringCbPrintfA(output, sizeof(output),
2349 "%s bp=0x%08X, hash=%d, fid (cell=%d, volume=%d, "
2350 "vnode=%d, unique=%d), offset=%x:%08x, dv=%I64d, "
2351 "flags=0x%x, qFlags=0x%x cmFlags=0x%x, error=0x%x, refCount=%d\r\n",
2352 cookie, (void *)bp, i, bp->fid.cell, bp->fid.volume,
2353 bp->fid.vnode, bp->fid.unique, bp->offset.HighPart,
2354 bp->offset.LowPart, bp->dataVersion, bp->flags, bp->qFlags,
2355 bp->cmFlags, bp->error, bp->refCount);
2356 WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2360 StringCbPrintfA(output, sizeof(output), "%s - Done dumping buf_HashTable.\r\n", cookie);
2361 WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2363 StringCbPrintfA(output, sizeof(output), "%s - dumping buf_freeListEndp\r\n", cookie);
2364 WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2365 for(bp = cm_data.buf_freeListEndp; bp; bp=(cm_buf_t *) osi_QPrev(&bp->q)) {
2366 StringCbPrintfA(output, sizeof(output),
2367 "%s bp=0x%08X, fid (cell=%d, volume=%d, "
2368 "vnode=%d, unique=%d), offset=%x:%08x, dv=%I64d, "
2369 "flags=0x%x, qFlags=0x%x, cmFlags=0x%x, error=0x%x, refCount=%d\r\n",
2370 cookie, (void *)bp, bp->fid.cell, bp->fid.volume,
2371 bp->fid.vnode, bp->fid.unique, bp->offset.HighPart,
2372 bp->offset.LowPart, bp->dataVersion, bp->flags, bp->qFlags,
2373 bp->cmFlags, bp->error, bp->refCount);
2374 WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2376 StringCbPrintfA(output, sizeof(output), "%s - Done dumping buf_FreeListEndp.\r\n", cookie);
2377 WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2379 StringCbPrintfA(output, sizeof(output), "%s - dumping buf_dirtyListp\r\n", cookie);
2380 WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2381 for(bp = cm_data.buf_dirtyListp; bp; bp=bp->dirtyp) {
2382 StringCbPrintfA(output, sizeof(output),
2383 "%s bp=0x%08X, fid (cell=%d, volume=%d, "
2384 "vnode=%d, unique=%d), offset=%x:%08x, dv=%I64d, "
2385 "flags=0x%x, qFlags=0x%x, cmFlags=0x%x, error=0x%x, refCount=%d\r\n",
2386 cookie, (void *)bp, bp->fid.cell, bp->fid.volume,
2387 bp->fid.vnode, bp->fid.unique, bp->offset.HighPart,
2388 bp->offset.LowPart, bp->dataVersion, bp->flags, bp->qFlags,
2389 bp->cmFlags, bp->error, bp->refCount);
2390 WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2392 StringCbPrintfA(output, sizeof(output), "%s - Done dumping buf_dirtyListp.\r\n", cookie);
2393 WriteFile(outputFile, output, (DWORD)strlen(output), &zilch, NULL);
2396 lock_ReleaseRead(&buf_globalLock);
2400 void buf_ForceTrace(BOOL flush)
2409 len = GetTempPath(sizeof(buf)-10, buf);
2410 StringCbCopyA(&buf[len], sizeof(buf)-len, "/afs-buffer.log");
2411 handle = CreateFile(buf, GENERIC_WRITE, FILE_SHARE_READ,
2412 NULL, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
2413 if (handle == INVALID_HANDLE_VALUE) {
2414 osi_panic("Cannot create log file", __FILE__, __LINE__);
2416 osi_LogPrint(buf_logp, handle);
2418 FlushFileBuffers(handle);
2419 CloseHandle(handle);
2422 long buf_DirtyBuffersExist(cm_fid_t *fidp)
2425 afs_uint32 bcount = 0;
2429 i = BUF_FILEHASH(fidp);
2431 lock_ObtainRead(&buf_globalLock);
2432 for (bp = cm_data.buf_fileHashTablepp[i]; bp; bp=bp->fileHashp, bcount++) {
2433 if (!cm_FidCmp(fidp, &bp->fid) && (bp->flags & CM_BUF_DIRTY)) {
2438 lock_ReleaseRead(&buf_globalLock);
2442 long buf_RDRBuffersExist(cm_fid_t *fidp)
2445 afs_uint32 bcount = 0;
2449 if (!RDR_Initialized)
2452 i = BUF_FILEHASH(fidp);
2454 lock_ObtainRead(&buf_globalLock);
2455 for (bp = cm_data.buf_fileHashTablepp[i]; bp; bp=bp->fileHashp, bcount++) {
2456 if (!cm_FidCmp(fidp, &bp->fid) && (bp->qFlags & CM_BUF_QREDIR)) {
2461 lock_ReleaseRead(&buf_globalLock);
2465 long buf_ClearRDRFlag(cm_scache_t *scp, char *reason)
2467 cm_fid_t *fidp = &scp->fid;
2469 afs_uint32 bcount = 0;
2472 i = BUF_FILEHASH(fidp);
2474 lock_ObtainWrite(&scp->rw);
2475 lock_ObtainRead(&buf_globalLock);
2476 for (bp = cm_data.buf_fileHashTablepp[i]; bp; bp=bp->fileHashp, bcount++) {
2477 if (!cm_FidCmp(fidp, &bp->fid) && (bp->qFlags & CM_BUF_QREDIR)) {
2478 lock_ConvertRToW(&buf_globalLock);
2479 if (bp->qFlags & CM_BUF_QREDIR) {
2480 osi_Log4(buf_logp,"buf_ClearRDRFlag taking from file system bp 0x%p vno 0x%x foffset 0x%x:%x",
2481 bp, bp->fid.vnode, bp->offset.HighPart, bp->offset.LowPart);
2482 buf_RemoveFromRedirQueue(scp, bp);
2483 buf_ReleaseLocked(bp, TRUE);
2485 lock_ConvertWToR(&buf_globalLock);
2489 /* Confirm that there are none left */
2490 lock_ConvertRToW(&buf_globalLock);
2491 for ( bp = redirq_to_cm_buf_t(scp->redirQueueT);
2493 bp = redirq_to_cm_buf_t(scp->redirQueueT))
2495 if (bp->qFlags & CM_BUF_QREDIR) {
2496 osi_Log4(buf_logp,"buf_ClearRDRFlag taking from file system bufp 0x%p vno 0x%x foffset 0x%x:%x",
2497 bp, bp->fid.vnode, bp->offset.HighPart, bp->offset.LowPart);
2498 buf_RemoveFromRedirQueue(scp, bp);
2499 buf_ReleaseLocked(bp, TRUE);
2503 lock_ReleaseWrite(&buf_globalLock);
2504 lock_ReleaseWrite(&scp->rw);
2509 long buf_CleanDirtyBuffers(cm_scache_t *scp)
2512 afs_uint32 bcount = 0;
2513 cm_fid_t * fidp = &scp->fid;
2515 for (bp = cm_data.buf_allp; bp; bp=bp->allp, bcount++) {
2516 if (!cm_FidCmp(fidp, &bp->fid) && (bp->flags & CM_BUF_DIRTY)) {
2518 lock_ObtainMutex(&bp->mx);
2519 _InterlockedAnd(&bp->cmFlags, ~CM_BUF_CMSTORING);
2520 _InterlockedAnd(&bp->flags, ~CM_BUF_DIRTY);
2521 bp->dirty_offset = 0;
2522 bp->dirty_length = 0;
2523 _InterlockedOr(&bp->flags, CM_BUF_ERROR);
2524 bp->error = VNOVNODE;
2525 bp->dataVersion = CM_BUF_VERSION_BAD; /* bad */
2527 if (bp->flags & CM_BUF_WAITING) {
2528 osi_Log2(buf_logp, "BUF CleanDirtyBuffers Waking [scp 0x%x] bp 0x%x", scp, bp);
2529 osi_Wakeup((long) &bp);
2531 lock_ReleaseMutex(&bp->mx);
2540 * The following routines will not be used on a
2541 * regular basis but are very useful in a variety
2542 * of scenarios when debugging data corruption.
2545 buf_HexCheckSum(cm_buf_t * bp)
2548 static char buf[33];
2549 static char tr[16] = {'0','1','2','3','4','5','6','7','8','9','A','B','C','D','E','F'};
2551 for (i=0;i<16;i++) {
2552 k = bp->md5cksum[i];
2554 buf[i*2] = tr[k / 16];
2555 buf[i*2+1] = tr[k % 16];
2563 buf_ComputeCheckSum(cm_buf_t * bp)
2568 MD5_Update(&md5, bp->datap, cm_data.blockSize);
2569 MD5_Final(bp->md5cksum, &md5);
2571 osi_Log4(buf_logp, "CheckSum bp 0x%p md5 %s, dirty: offset %u length %u",
2572 bp, osi_LogSaveString(buf_logp, buf_HexCheckSum(bp)),
2573 bp->dirty_offset, bp->dirty_length);
2577 buf_ValidateCheckSum(cm_buf_t * bp)
2580 unsigned char tmp[16];
2583 MD5_Update(&md5, bp->datap, cm_data.blockSize);
2584 MD5_Final(tmp, &md5);
2586 if (memcmp(tmp, bp->md5cksum, 16) == 0)
2592 buf_InsertToRedirQueue(cm_scache_t *scp, cm_buf_t *bufp)
2594 lock_AssertWrite(&buf_globalLock);
2596 lock_ObtainMutex(&scp->redirMx);
2598 if (bufp->qFlags & CM_BUF_QINLRU) {
2599 _InterlockedAnd(&bufp->qFlags, ~CM_BUF_QINLRU);
2600 osi_QRemoveHT( (osi_queue_t **) &cm_data.buf_freeListp,
2601 (osi_queue_t **) &cm_data.buf_freeListEndp,
2603 buf_DecrementFreeCount();
2605 _InterlockedOr(&bufp->qFlags, CM_BUF_QREDIR);
2606 osi_QAddH( (osi_queue_t **) &cm_data.buf_redirListp,
2607 (osi_queue_t **) &cm_data.buf_redirListEndp,
2609 buf_IncrementRedirCount();
2610 bufp->redirLastAccess = time(NULL);
2612 osi_QAddH( (osi_queue_t **) &scp->redirQueueH,
2613 (osi_queue_t **) &scp->redirQueueT,
2615 scp->redirLastAccess = bufp->redirLastAccess;
2616 InterlockedIncrement(&scp->redirBufCount);
2619 lock_ReleaseMutex(&scp->redirMx);
2623 buf_RemoveFromRedirQueue(cm_scache_t *scp, cm_buf_t *bufp)
2625 lock_AssertWrite(&buf_globalLock);
2627 if (!(bufp->qFlags & CM_BUF_QREDIR))
2630 lock_ObtainMutex(&scp->redirMx);
2632 _InterlockedAnd(&bufp->qFlags, ~CM_BUF_QREDIR);
2633 osi_QRemoveHT( (osi_queue_t **) &cm_data.buf_redirListp,
2634 (osi_queue_t **) &cm_data.buf_redirListEndp,
2636 buf_DecrementRedirCount();
2638 osi_QRemoveHT( (osi_queue_t **) &scp->redirQueueH,
2639 (osi_queue_t **) &scp->redirQueueT,
2641 InterlockedDecrement(&scp->redirBufCount);
2644 lock_ReleaseMutex(&scp->redirMx);
2648 buf_MoveToHeadOfRedirQueue(cm_scache_t *scp, cm_buf_t *bufp)
2650 lock_AssertWrite(&buf_globalLock);
2651 if (!(bufp->qFlags & CM_BUF_QREDIR))
2654 lock_ObtainMutex(&scp->redirMx);
2656 osi_QRemoveHT( (osi_queue_t **) &cm_data.buf_redirListp,
2657 (osi_queue_t **) &cm_data.buf_redirListEndp,
2659 osi_QAddH( (osi_queue_t **) &cm_data.buf_redirListp,
2660 (osi_queue_t **) &cm_data.buf_redirListEndp,
2662 bufp->redirLastAccess = time(NULL);
2664 osi_QRemoveHT( (osi_queue_t **) &scp->redirQueueH,
2665 (osi_queue_t **) &scp->redirQueueT,
2667 osi_QAddH( (osi_queue_t **) &scp->redirQueueH,
2668 (osi_queue_t **) &scp->redirQueueT,
2670 scp->redirLastAccess = bufp->redirLastAccess;
2673 lock_ReleaseMutex(&scp->redirMx);