Home | History | Annotate | Line # | Download | only in raidframe
rf_stripelocks.c revision 1.6.4.1
      1  1.6.4.1  thorpej /*	$NetBSD: rf_stripelocks.c,v 1.6.4.1 2001/09/13 01:16:06 thorpej Exp $	*/
      2      1.1    oster /*
      3      1.1    oster  * Copyright (c) 1995 Carnegie-Mellon University.
      4      1.1    oster  * All rights reserved.
      5      1.1    oster  *
      6      1.1    oster  * Authors: Mark Holland, Jim Zelenka
      7      1.1    oster  *
      8      1.1    oster  * Permission to use, copy, modify and distribute this software and
      9      1.1    oster  * its documentation is hereby granted, provided that both the copyright
     10      1.1    oster  * notice and this permission notice appear in all copies of the
     11      1.1    oster  * software, derivative works or modified versions, and any portions
     12      1.1    oster  * thereof, and that both notices appear in supporting documentation.
     13      1.1    oster  *
     14      1.1    oster  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
     15      1.1    oster  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
     16      1.1    oster  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
     17      1.1    oster  *
     18      1.1    oster  * Carnegie Mellon requests users of this software to return to
     19      1.1    oster  *
     20      1.1    oster  *  Software Distribution Coordinator  or  Software.Distribution (at) CS.CMU.EDU
     21      1.1    oster  *  School of Computer Science
     22      1.1    oster  *  Carnegie Mellon University
     23      1.1    oster  *  Pittsburgh PA 15213-3890
     24      1.1    oster  *
     25      1.1    oster  * any improvements or extensions that they make and grant Carnegie the
     26      1.1    oster  * rights to redistribute these changes.
     27      1.1    oster  */
     28      1.1    oster 
     29      1.1    oster /*
     30      1.1    oster  * stripelocks.c -- code to lock stripes for read and write access
     31      1.1    oster  *
     32      1.1    oster  * The code distinguishes between read locks and write locks. There can be
     33      1.1    oster  * as many readers to given stripe as desired. When a write request comes
     34      1.1    oster  * in, no further readers are allowed to enter, and all subsequent requests
     35      1.1    oster  * are queued in FIFO order. When a the number of readers goes to zero, the
     36      1.1    oster  * writer is given the lock. When a writer releases the lock, the list of
     37      1.1    oster  * queued requests is scanned, and all readersq up to the next writer are
     38      1.1    oster  * given the lock.
     39      1.1    oster  *
     40      1.1    oster  * The lock table size must be one less than a power of two, but HASH_STRIPEID
     41      1.1    oster  * is the only function that requires this.
     42      1.1    oster  *
     43      1.1    oster  * The code now supports "range locks". When you ask to lock a stripe, you
     44      1.1    oster  * specify a range of addresses in that stripe that you want to lock. When
     45      1.1    oster  * you acquire the lock, you've locked only this range of addresses, and
     46      1.1    oster  * other threads can concurrently read/write any non-overlapping portions
     47      1.1    oster  * of the stripe. The "addresses" that you lock are abstract in that you
     48      1.1    oster  * can pass in anything you like.  The expectation is that you'll pass in
     49      1.1    oster  * the range of physical disk offsets of the parity bits you're planning
     50      1.1    oster  * to update. The idea behind this, of course, is to allow sub-stripe
     51      1.1    oster  * locking. The implementation is perhaps not the best imaginable; in the
     52      1.1    oster  * worst case a lock release is O(n^2) in the total number of outstanding
     53      1.1    oster  * requests to a given stripe.  Note that if you're striping with a
     54      1.1    oster  * stripe unit size equal to an entire disk (i.e. not striping), there will
     55      1.1    oster  * be only one stripe and you may spend some significant number of cycles
     56      1.1    oster  * searching through stripe lock descriptors.
     57      1.1    oster  */
     58      1.1    oster 
     59      1.1    oster #include "rf_types.h"
     60      1.1    oster #include "rf_raid.h"
     61      1.1    oster #include "rf_stripelocks.h"
     62      1.1    oster #include "rf_alloclist.h"
     63      1.1    oster #include "rf_general.h"
     64      1.1    oster #include "rf_freelist.h"
     65      1.1    oster #include "rf_debugprint.h"
     66      1.1    oster #include "rf_driver.h"
     67      1.1    oster #include "rf_shutdown.h"
     68      1.1    oster 
     69      1.1    oster #define Dprintf1(s,a)         rf_debug_printf(s,(void *)((unsigned long)a),NULL,NULL,NULL,NULL,NULL,NULL,NULL)
     70      1.1    oster #define Dprintf2(s,a,b)       rf_debug_printf(s,(void *)((unsigned long)a),(void *)((unsigned long)b),NULL,NULL,NULL,NULL,NULL,NULL)
     71      1.1    oster #define Dprintf3(s,a,b,c)     rf_debug_printf(s,(void *)((unsigned long)a),(void *)((unsigned long)b),(void *)((unsigned long)c),NULL,NULL,NULL,NULL,NULL)
     72      1.1    oster #define Dprintf4(s,a,b,c,d)   rf_debug_printf(s,(void *)((unsigned long)a),(void *)((unsigned long)b),(void *)((unsigned long)c),(void *)((unsigned long)d),NULL,NULL,NULL,NULL)
     73      1.1    oster #define Dprintf5(s,a,b,c,d,e) rf_debug_printf(s,(void *)((unsigned long)a),(void *)((unsigned long)b),(void *)((unsigned long)c),(void *)((unsigned long)d),(void *)((unsigned long)e),NULL,NULL,NULL)
     74      1.1    oster #define Dprintf6(s,a,b,c,d,e,f) rf_debug_printf(s,(void *)((unsigned long)a),(void *)((unsigned long)b),(void *)((unsigned long)c),(void *)((unsigned long)d),(void *)((unsigned long)e),(void *)((unsigned long)f),NULL,NULL)
     75      1.1    oster #define Dprintf7(s,a,b,c,d,e,f,g) rf_debug_printf(s,(void *)((unsigned long)a),(void *)((unsigned long)b),(void *)((unsigned long)c),(void *)((unsigned long)d),(void *)((unsigned long)e),(void *)((unsigned long)f),(void *)((unsigned long)g),NULL)
     76      1.1    oster #define Dprintf8(s,a,b,c,d,e,f,g,h) rf_debug_printf(s,(void *)((unsigned long)a),(void *)((unsigned long)b),(void *)((unsigned long)c),(void *)((unsigned long)d),(void *)((unsigned long)e),(void *)((unsigned long)f),(void *)((unsigned long)g),(void *)((unsigned long)h))
     77      1.1    oster 
     78      1.1    oster #define FLUSH
     79      1.1    oster 
     80      1.1    oster #define HASH_STRIPEID(_sid_)  ( (_sid_) & (rf_lockTableSize-1) )
     81      1.1    oster 
     82      1.3    oster static void AddToWaitersQueue(RF_LockTableEntry_t * lockTable, RF_StripeLockDesc_t * lockDesc, RF_LockReqDesc_t * lockReqDesc);
     83      1.1    oster static RF_StripeLockDesc_t *AllocStripeLockDesc(RF_StripeNum_t stripeID);
     84      1.3    oster static void FreeStripeLockDesc(RF_StripeLockDesc_t * p);
     85      1.3    oster static void PrintLockedStripes(RF_LockTableEntry_t * lockTable);
     86      1.1    oster 
     87      1.1    oster /* determines if two ranges overlap.  always yields false if either start value is negative  */
     88      1.1    oster #define SINGLE_RANGE_OVERLAP(_strt1, _stop1, _strt2, _stop2)                                     \
     89      1.1    oster   ( (_strt1 >= 0) && (_strt2 >= 0) && (RF_MAX(_strt1, _strt2) <= RF_MIN(_stop1, _stop2)) )
     90      1.1    oster 
     91      1.1    oster /* determines if any of the ranges specified in the two lock descriptors overlap each other */
     92      1.1    oster #define RANGE_OVERLAP(_cand, _pred)                                                  \
     93      1.1    oster   ( SINGLE_RANGE_OVERLAP((_cand)->start,  (_cand)->stop,  (_pred)->start,  (_pred)->stop ) ||    \
     94      1.1    oster     SINGLE_RANGE_OVERLAP((_cand)->start2, (_cand)->stop2, (_pred)->start,  (_pred)->stop ) ||    \
     95      1.1    oster     SINGLE_RANGE_OVERLAP((_cand)->start,  (_cand)->stop,  (_pred)->start2, (_pred)->stop2) ||    \
     96      1.1    oster     SINGLE_RANGE_OVERLAP((_cand)->start2, (_cand)->stop2, (_pred)->start2, (_pred)->stop2) )
     97      1.1    oster 
     98      1.1    oster /* Determines if a candidate lock request conflicts with a predecessor lock req.
     99      1.1    oster  * Note that the arguments are not interchangeable.
    100      1.1    oster  * The rules are:
    101      1.1    oster  *      a candidate read conflicts with a predecessor write if any ranges overlap
    102      1.1    oster  *      a candidate write conflicts with a predecessor read if any ranges overlap
    103      1.1    oster  *      a candidate write conflicts with a predecessor write if any ranges overlap
    104      1.1    oster  */
    105      1.1    oster #define STRIPELOCK_CONFLICT(_cand, _pred)                                        \
    106      1.1    oster   RANGE_OVERLAP((_cand), (_pred)) &&                                        \
    107      1.1    oster   ( ( (((_cand)->type == RF_IO_TYPE_READ) && ((_pred)->type == RF_IO_TYPE_WRITE)) ||                      \
    108      1.1    oster       (((_cand)->type == RF_IO_TYPE_WRITE) && ((_pred)->type == RF_IO_TYPE_READ)) ||                      \
    109      1.1    oster       (((_cand)->type == RF_IO_TYPE_WRITE) && ((_pred)->type == RF_IO_TYPE_WRITE))                         \
    110      1.1    oster     )                                                                            \
    111      1.1    oster   )
    112      1.1    oster 
    113      1.1    oster static RF_FreeList_t *rf_stripelock_freelist;
    114      1.1    oster #define RF_MAX_FREE_STRIPELOCK 128
    115      1.1    oster #define RF_STRIPELOCK_INC        8
    116      1.1    oster #define RF_STRIPELOCK_INITIAL   32
    117      1.1    oster 
    118      1.1    oster static void rf_ShutdownStripeLockFreeList(void *);
    119      1.1    oster static void rf_RaidShutdownStripeLocks(void *);
    120      1.1    oster 
    121      1.3    oster static void
    122      1.3    oster rf_ShutdownStripeLockFreeList(ignored)
    123      1.3    oster 	void   *ignored;
    124      1.1    oster {
    125      1.3    oster 	RF_FREELIST_DESTROY(rf_stripelock_freelist, next, (RF_StripeLockDesc_t *));
    126      1.1    oster }
    127      1.1    oster 
    128      1.3    oster int
    129      1.3    oster rf_ConfigureStripeLockFreeList(listp)
    130      1.3    oster 	RF_ShutdownList_t **listp;
    131      1.1    oster {
    132      1.1    oster 	unsigned mask;
    133      1.3    oster 	int     rc;
    134      1.1    oster 
    135      1.1    oster 	RF_FREELIST_CREATE(rf_stripelock_freelist, RF_MAX_FREE_STRIPELOCK,
    136      1.3    oster 	    RF_STRIPELOCK_INITIAL, sizeof(RF_StripeLockDesc_t));
    137      1.1    oster 	rc = rf_ShutdownCreate(listp, rf_ShutdownStripeLockFreeList, NULL);
    138      1.1    oster 	if (rc) {
    139      1.1    oster 		RF_ERRORMSG3("Unable to add to shutdown list file %s line %d rc=%d\n",
    140      1.3    oster 		    __FILE__, __LINE__, rc);
    141      1.1    oster 		rf_ShutdownStripeLockFreeList(NULL);
    142      1.3    oster 		return (rc);
    143      1.1    oster 	}
    144      1.3    oster 	RF_FREELIST_PRIME(rf_stripelock_freelist, RF_STRIPELOCK_INITIAL, next,
    145      1.3    oster 	    (RF_StripeLockDesc_t *));
    146      1.3    oster 	for (mask = 0x1; mask; mask <<= 1)
    147      1.3    oster 		if (rf_lockTableSize == mask)
    148      1.1    oster 			break;
    149      1.1    oster 	if (!mask) {
    150      1.3    oster 		printf("[WARNING:  lock table size must be a power of two.  Setting to %d.]\n", RF_DEFAULT_LOCK_TABLE_SIZE);
    151      1.1    oster 		rf_lockTableSize = RF_DEFAULT_LOCK_TABLE_SIZE;
    152      1.1    oster 	}
    153      1.3    oster 	return (0);
    154      1.1    oster }
    155      1.1    oster 
    156      1.3    oster RF_LockTableEntry_t *
    157      1.3    oster rf_MakeLockTable()
    158      1.1    oster {
    159      1.1    oster 	RF_LockTableEntry_t *lockTable;
    160      1.3    oster 	int     i, rc;
    161      1.1    oster 
    162      1.1    oster 	RF_Calloc(lockTable, ((int) rf_lockTableSize), sizeof(RF_LockTableEntry_t), (RF_LockTableEntry_t *));
    163      1.1    oster 	if (lockTable == NULL)
    164      1.3    oster 		return (NULL);
    165      1.3    oster 	for (i = 0; i < rf_lockTableSize; i++) {
    166      1.1    oster 		rc = rf_mutex_init(&lockTable[i].mutex);
    167      1.1    oster 		if (rc) {
    168      1.3    oster 			RF_ERRORMSG3("Unable to init mutex file %s line %d rc=%d\n", __FILE__,
    169      1.3    oster 			    __LINE__, rc);
    170      1.1    oster 			/* XXX clean up other mutexes */
    171      1.3    oster 			return (NULL);
    172      1.1    oster 		}
    173      1.1    oster 	}
    174      1.3    oster 	return (lockTable);
    175      1.1    oster }
    176      1.1    oster 
    177      1.3    oster void
    178      1.3    oster rf_ShutdownStripeLocks(RF_LockTableEntry_t * lockTable)
    179      1.1    oster {
    180      1.3    oster 	int     i;
    181      1.1    oster 
    182      1.1    oster 	if (rf_stripeLockDebug) {
    183      1.1    oster 		PrintLockedStripes(lockTable);
    184      1.1    oster 	}
    185      1.3    oster 	for (i = 0; i < rf_lockTableSize; i++) {
    186      1.1    oster 		rf_mutex_destroy(&lockTable[i].mutex);
    187      1.1    oster 	}
    188      1.3    oster 	RF_Free(lockTable, rf_lockTableSize * sizeof(RF_LockTableEntry_t));
    189      1.1    oster }
    190      1.1    oster 
    191      1.3    oster static void
    192      1.3    oster rf_RaidShutdownStripeLocks(arg)
    193      1.3    oster 	void   *arg;
    194      1.1    oster {
    195      1.3    oster 	RF_Raid_t *raidPtr = (RF_Raid_t *) arg;
    196      1.1    oster 	rf_ShutdownStripeLocks(raidPtr->lockTable);
    197      1.1    oster }
    198      1.1    oster 
    199      1.3    oster int
    200      1.3    oster rf_ConfigureStripeLocks(
    201      1.3    oster     RF_ShutdownList_t ** listp,
    202      1.3    oster     RF_Raid_t * raidPtr,
    203      1.3    oster     RF_Config_t * cfgPtr)
    204      1.1    oster {
    205      1.3    oster 	int     rc;
    206      1.1    oster 
    207      1.1    oster 	raidPtr->lockTable = rf_MakeLockTable();
    208      1.1    oster 	if (raidPtr->lockTable == NULL)
    209      1.3    oster 		return (ENOMEM);
    210      1.1    oster 	rc = rf_ShutdownCreate(listp, rf_RaidShutdownStripeLocks, raidPtr);
    211      1.1    oster 	if (rc) {
    212      1.1    oster 		RF_ERRORMSG3("Unable to add to shutdown list file %s line %d rc=%d\n",
    213      1.3    oster 		    __FILE__, __LINE__, rc);
    214      1.1    oster 		rf_ShutdownStripeLocks(raidPtr->lockTable);
    215      1.3    oster 		return (rc);
    216      1.1    oster 	}
    217      1.3    oster 	return (0);
    218      1.1    oster }
    219      1.1    oster /* returns 0 if you've got the lock, and non-zero if you have to wait.
    220      1.1    oster  * if and only if you have to wait, we'll cause cbFunc to get invoked
    221      1.1    oster  * with cbArg when you are granted the lock.  We store a tag in *releaseTag
    222      1.1    oster  * that you need to give back to us when you release the lock.
    223      1.1    oster  */
    224      1.3    oster int
    225      1.3    oster rf_AcquireStripeLock(
    226      1.3    oster     RF_LockTableEntry_t * lockTable,
    227      1.3    oster     RF_StripeNum_t stripeID,
    228      1.3    oster     RF_LockReqDesc_t * lockReqDesc)
    229      1.3    oster {
    230      1.3    oster 	RF_StripeLockDesc_t *lockDesc;
    231      1.3    oster 	RF_LockReqDesc_t *p;
    232      1.3    oster 	int     tid = 0, hashval = HASH_STRIPEID(stripeID);
    233      1.3    oster 	int     retcode = 0;
    234      1.3    oster 
    235      1.3    oster 	RF_ASSERT(RF_IO_IS_R_OR_W(lockReqDesc->type));
    236      1.3    oster 
    237      1.1    oster 	if (rf_stripeLockDebug) {
    238      1.3    oster 		if (stripeID == -1)
    239      1.3    oster 			Dprintf1("[%d] Lock acquisition supressed (stripeID == -1)\n", tid);
    240      1.3    oster 		else {
    241      1.3    oster 			Dprintf8("[%d] Trying to acquire stripe lock table 0x%lx SID %ld type %c range %ld-%ld, range2 %ld-%ld hashval %d\n",
    242      1.3    oster 			    tid, (unsigned long) lockTable, stripeID, lockReqDesc->type, lockReqDesc->start,
    243      1.3    oster 			    lockReqDesc->stop, lockReqDesc->start2, lockReqDesc->stop2);
    244      1.3    oster 			Dprintf3("[%d] lock %ld hashval %d\n", tid, stripeID, hashval);
    245      1.3    oster 			FLUSH;
    246      1.3    oster 		}
    247      1.3    oster 	}
    248      1.3    oster 	if (stripeID == -1)
    249      1.3    oster 		return (0);
    250      1.3    oster 	lockReqDesc->next = NULL;	/* just to be sure */
    251      1.3    oster 
    252      1.3    oster 	RF_LOCK_MUTEX(lockTable[hashval].mutex);
    253      1.3    oster 	for (lockDesc = lockTable[hashval].descList; lockDesc; lockDesc = lockDesc->next) {
    254      1.3    oster 		if (lockDesc->stripeID == stripeID)
    255      1.3    oster 			break;
    256      1.3    oster 	}
    257      1.3    oster 
    258      1.3    oster 	if (!lockDesc) {	/* no entry in table => no one reading or
    259      1.3    oster 				 * writing */
    260      1.3    oster 		lockDesc = AllocStripeLockDesc(stripeID);
    261      1.3    oster 		lockDesc->next = lockTable[hashval].descList;
    262      1.3    oster 		lockTable[hashval].descList = lockDesc;
    263      1.3    oster 		if (lockReqDesc->type == RF_IO_TYPE_WRITE)
    264      1.3    oster 			lockDesc->nWriters++;
    265      1.3    oster 		lockDesc->granted = lockReqDesc;
    266      1.3    oster 		if (rf_stripeLockDebug) {
    267      1.3    oster 			Dprintf7("[%d] no one waiting: lock %ld %c %ld-%ld %ld-%ld granted\n",
    268      1.3    oster 			    tid, stripeID, lockReqDesc->type, lockReqDesc->start, lockReqDesc->stop, lockReqDesc->start2, lockReqDesc->stop2);
    269      1.3    oster 			FLUSH;
    270      1.3    oster 		}
    271      1.3    oster 	} else {
    272      1.3    oster 
    273      1.3    oster 		if (lockReqDesc->type == RF_IO_TYPE_WRITE)
    274      1.3    oster 			lockDesc->nWriters++;
    275      1.3    oster 
    276      1.3    oster 		if (lockDesc->nWriters == 0) {	/* no need to search any lists
    277      1.3    oster 						 * if there are no writers
    278      1.3    oster 						 * anywhere */
    279      1.3    oster 			lockReqDesc->next = lockDesc->granted;
    280      1.3    oster 			lockDesc->granted = lockReqDesc;
    281      1.3    oster 			if (rf_stripeLockDebug) {
    282      1.3    oster 				Dprintf7("[%d] no writers: lock %ld %c %ld-%ld %ld-%ld granted\n",
    283      1.3    oster 				    tid, stripeID, lockReqDesc->type, lockReqDesc->start, lockReqDesc->stop, lockReqDesc->start2, lockReqDesc->stop2);
    284      1.3    oster 				FLUSH;
    285      1.3    oster 			}
    286      1.3    oster 		} else {
    287      1.3    oster 
    288      1.3    oster 			/* search the granted & waiting lists for a conflict.
    289      1.3    oster 			 * stop searching as soon as we find one */
    290      1.3    oster 			retcode = 0;
    291      1.3    oster 			for (p = lockDesc->granted; p; p = p->next)
    292      1.3    oster 				if (STRIPELOCK_CONFLICT(lockReqDesc, p)) {
    293      1.3    oster 					retcode = 1;
    294      1.3    oster 					break;
    295      1.3    oster 				}
    296      1.3    oster 			if (!retcode)
    297      1.3    oster 				for (p = lockDesc->waitersH; p; p = p->next)
    298      1.3    oster 					if (STRIPELOCK_CONFLICT(lockReqDesc, p)) {
    299      1.3    oster 						retcode = 2;
    300      1.3    oster 						break;
    301      1.3    oster 					}
    302      1.3    oster 			if (!retcode) {
    303      1.3    oster 				lockReqDesc->next = lockDesc->granted;	/* no conflicts found =>
    304      1.3    oster 									 * grant lock */
    305      1.3    oster 				lockDesc->granted = lockReqDesc;
    306      1.3    oster 				if (rf_stripeLockDebug) {
    307      1.3    oster 					Dprintf7("[%d] no conflicts: lock %ld %c %ld-%ld %ld-%ld granted\n",
    308      1.3    oster 					    tid, stripeID, lockReqDesc->type, lockReqDesc->start, lockReqDesc->stop,
    309      1.3    oster 					    lockReqDesc->start2, lockReqDesc->stop2);
    310      1.3    oster 					FLUSH;
    311      1.3    oster 				}
    312      1.3    oster 			} else {
    313      1.3    oster 				if (rf_stripeLockDebug) {
    314      1.3    oster 					Dprintf6("[%d] conflict: lock %ld %c %ld-%ld hashval=%d not granted\n",
    315      1.3    oster 					    tid, stripeID, lockReqDesc->type, lockReqDesc->start, lockReqDesc->stop,
    316      1.3    oster 					    hashval);
    317      1.3    oster 					Dprintf3("[%d] lock %ld retcode=%d\n", tid, stripeID, retcode);
    318      1.3    oster 					FLUSH;
    319      1.3    oster 				}
    320      1.3    oster 				AddToWaitersQueue(lockTable, lockDesc, lockReqDesc);	/* conflict => the
    321      1.3    oster 											 * current access must
    322      1.3    oster 											 * wait */
    323      1.3    oster 			}
    324      1.3    oster 		}
    325      1.1    oster 	}
    326      1.3    oster 
    327      1.3    oster 	RF_UNLOCK_MUTEX(lockTable[hashval].mutex);
    328      1.3    oster 	return (retcode);
    329      1.3    oster }
    330      1.3    oster 
    331      1.3    oster void
    332      1.3    oster rf_ReleaseStripeLock(
    333      1.3    oster     RF_LockTableEntry_t * lockTable,
    334      1.3    oster     RF_StripeNum_t stripeID,
    335      1.3    oster     RF_LockReqDesc_t * lockReqDesc)
    336      1.3    oster {
    337      1.3    oster 	RF_StripeLockDesc_t *lockDesc, *ld_t;
    338      1.3    oster 	RF_LockReqDesc_t *lr, *lr_t, *callbacklist, *t;
    339      1.3    oster 	int     tid = 0, hashval = HASH_STRIPEID(stripeID);
    340      1.3    oster 	int     release_it, consider_it;
    341      1.3    oster 	RF_LockReqDesc_t *candidate, *candidate_t, *predecessor;
    342      1.3    oster 
    343  1.6.4.1  thorpej 	RF_ASSERT(RF_IO_IS_R_OR_W(lockReqDesc->type));
    344      1.3    oster 
    345      1.1    oster 	if (rf_stripeLockDebug) {
    346      1.3    oster 		if (stripeID == -1)
    347      1.3    oster 			Dprintf1("[%d] Lock release supressed (stripeID == -1)\n", tid);
    348      1.3    oster 		else {
    349      1.3    oster 			Dprintf8("[%d] Releasing stripe lock on stripe ID %ld, type %c range %ld-%ld %ld-%ld table 0x%lx\n",
    350      1.3    oster 			    tid, stripeID, lockReqDesc->type, lockReqDesc->start, lockReqDesc->stop, lockReqDesc->start2, lockReqDesc->stop2, lockTable);
    351      1.3    oster 			FLUSH;
    352      1.3    oster 		}
    353      1.3    oster 	}
    354      1.3    oster 	if (stripeID == -1)
    355      1.3    oster 		return;
    356      1.3    oster 
    357      1.3    oster 	RF_LOCK_MUTEX(lockTable[hashval].mutex);
    358      1.3    oster 
    359      1.3    oster 	/* find the stripe lock descriptor */
    360      1.3    oster 	for (ld_t = NULL, lockDesc = lockTable[hashval].descList; lockDesc; ld_t = lockDesc, lockDesc = lockDesc->next) {
    361      1.3    oster 		if (lockDesc->stripeID == stripeID)
    362      1.3    oster 			break;
    363      1.3    oster 	}
    364      1.3    oster 	RF_ASSERT(lockDesc);	/* major error to release a lock that doesn't
    365      1.3    oster 				 * exist */
    366      1.3    oster 
    367      1.3    oster 	/* find the stripe lock request descriptor & delete it from the list */
    368      1.3    oster 	for (lr_t = NULL, lr = lockDesc->granted; lr; lr_t = lr, lr = lr->next)
    369      1.3    oster 		if (lr == lockReqDesc)
    370      1.3    oster 			break;
    371      1.3    oster 
    372      1.3    oster 	RF_ASSERT(lr && (lr == lockReqDesc));	/* major error to release a
    373      1.3    oster 						 * lock that hasn't been
    374      1.3    oster 						 * granted */
    375      1.3    oster 	if (lr_t)
    376      1.3    oster 		lr_t->next = lr->next;
    377      1.3    oster 	else {
    378      1.3    oster 		RF_ASSERT(lr == lockDesc->granted);
    379      1.3    oster 		lockDesc->granted = lr->next;
    380      1.3    oster 	}
    381      1.3    oster 	lr->next = NULL;
    382      1.3    oster 
    383      1.3    oster 	if (lockReqDesc->type == RF_IO_TYPE_WRITE)
    384      1.3    oster 		lockDesc->nWriters--;
    385      1.3    oster 
    386      1.3    oster 	/* search through the waiters list to see if anyone needs to be woken
    387      1.3    oster 	 * up. for each such descriptor in the wait list, we check it against
    388      1.3    oster 	 * everything granted and against everything _in front_ of it in the
    389      1.3    oster 	 * waiters queue.  If it conflicts with none of these, we release it.
    390      1.3    oster 	 *
    391      1.3    oster 	 * DON'T TOUCH THE TEMPLINK POINTER OF ANYTHING IN THE GRANTED LIST HERE.
    392      1.3    oster 	 * This will roach the case where the callback tries to acquire a new
    393      1.3    oster 	 * lock in the same stripe.  There are some asserts to try and detect
    394      1.3    oster 	 * this.
    395      1.3    oster 	 *
    396      1.3    oster 	 * We apply 2 performance optimizations: (1) if releasing this lock
    397      1.3    oster 	 * results in no more writers to this stripe, we just release
    398      1.3    oster 	 * everybody waiting, since we place no restrictions on the number of
    399      1.3    oster 	 * concurrent reads. (2) we consider as candidates for wakeup only
    400      1.3    oster 	 * those waiters that have a range overlap with either the descriptor
    401      1.3    oster 	 * being woken up or with something in the callbacklist (i.e.
    402      1.3    oster 	 * something we've just now woken up). This allows us to avoid the
    403      1.3    oster 	 * long evaluation for some descriptors. */
    404      1.3    oster 
    405      1.3    oster 	callbacklist = NULL;
    406      1.3    oster 	if (lockDesc->nWriters == 0) {	/* performance tweak (1) */
    407      1.3    oster 		while (lockDesc->waitersH) {
    408      1.3    oster 
    409      1.3    oster 			lr = lockDesc->waitersH;	/* delete from waiters
    410      1.3    oster 							 * list */
    411      1.3    oster 			lockDesc->waitersH = lr->next;
    412      1.3    oster 
    413      1.3    oster 			RF_ASSERT(lr->type == RF_IO_TYPE_READ);
    414      1.3    oster 
    415      1.3    oster 			lr->next = lockDesc->granted;	/* add to granted list */
    416      1.3    oster 			lockDesc->granted = lr;
    417      1.3    oster 
    418      1.3    oster 			RF_ASSERT(!lr->templink);
    419      1.3    oster 			lr->templink = callbacklist;	/* put on callback list
    420      1.3    oster 							 * so that we'll invoke
    421      1.3    oster 							 * callback below */
    422      1.3    oster 			callbacklist = lr;
    423      1.3    oster 			if (rf_stripeLockDebug) {
    424      1.3    oster 				Dprintf8("[%d] No writers: granting lock stripe ID %ld, type %c range %ld-%ld %ld-%ld table 0x%lx\n",
    425      1.3    oster 				    tid, stripeID, lr->type, lr->start, lr->stop, lr->start2, lr->stop2, (unsigned long) lockTable);
    426      1.3    oster 				FLUSH;
    427      1.3    oster 			}
    428      1.3    oster 		}
    429      1.3    oster 		lockDesc->waitersT = NULL;	/* we've purged the whole
    430      1.3    oster 						 * waiters list */
    431      1.3    oster 
    432      1.3    oster 	} else
    433      1.3    oster 		for (candidate_t = NULL, candidate = lockDesc->waitersH; candidate;) {
    434      1.3    oster 
    435      1.3    oster 			/* performance tweak (2) */
    436      1.3    oster 			consider_it = 0;
    437      1.3    oster 			if (RANGE_OVERLAP(lockReqDesc, candidate))
    438      1.3    oster 				consider_it = 1;
    439      1.3    oster 			else
    440      1.3    oster 				for (t = callbacklist; t; t = t->templink)
    441      1.3    oster 					if (RANGE_OVERLAP(t, candidate)) {
    442      1.3    oster 						consider_it = 1;
    443      1.3    oster 						break;
    444      1.3    oster 					}
    445      1.3    oster 			if (!consider_it) {
    446      1.3    oster 				if (rf_stripeLockDebug) {
    447      1.3    oster 					Dprintf8("[%d] No overlap: rejecting candidate stripeID %ld, type %c range %ld-%ld %ld-%ld table 0x%lx\n",
    448      1.3    oster 					    tid, stripeID, candidate->type, candidate->start, candidate->stop, candidate->start2, candidate->stop2,
    449      1.3    oster 					    (unsigned long) lockTable);
    450      1.3    oster 					FLUSH;
    451      1.3    oster 				}
    452      1.3    oster 				candidate_t = candidate;
    453      1.3    oster 				candidate = candidate->next;
    454      1.3    oster 				continue;
    455      1.3    oster 			}
    456      1.3    oster 			/* we have a candidate for release.  check to make
    457      1.3    oster 			 * sure it is not blocked by any granted locks */
    458      1.3    oster 			release_it = 1;
    459      1.3    oster 			for (predecessor = lockDesc->granted; predecessor; predecessor = predecessor->next) {
    460      1.3    oster 				if (STRIPELOCK_CONFLICT(candidate, predecessor)) {
    461      1.3    oster 					if (rf_stripeLockDebug) {
    462      1.3    oster 						Dprintf8("[%d] Conflicts with granted lock: rejecting candidate stripeID %ld, type %c range %ld-%ld %ld-%ld table 0x%lx\n",
    463      1.3    oster 						    tid, stripeID, candidate->type, candidate->start, candidate->stop, candidate->start2, candidate->stop2,
    464      1.3    oster 						    (unsigned long) lockTable);
    465      1.3    oster 						FLUSH;
    466      1.3    oster 					}
    467      1.3    oster 					release_it = 0;
    468      1.3    oster 					break;
    469      1.3    oster 				}
    470      1.3    oster 			}
    471      1.3    oster 
    472      1.3    oster 			/* now check to see if the candidate is blocked by any
    473      1.3    oster 			 * waiters that occur before it it the wait queue */
    474      1.3    oster 			if (release_it)
    475      1.3    oster 				for (predecessor = lockDesc->waitersH; predecessor != candidate; predecessor = predecessor->next) {
    476      1.3    oster 					if (STRIPELOCK_CONFLICT(candidate, predecessor)) {
    477      1.3    oster 						if (rf_stripeLockDebug) {
    478      1.3    oster 							Dprintf8("[%d] Conflicts with waiting lock: rejecting candidate stripeID %ld, type %c range %ld-%ld %ld-%ld table 0x%lx\n",
    479      1.3    oster 							    tid, stripeID, candidate->type, candidate->start, candidate->stop, candidate->start2, candidate->stop2,
    480      1.3    oster 							    (unsigned long) lockTable);
    481      1.3    oster 							FLUSH;
    482      1.3    oster 						}
    483      1.3    oster 						release_it = 0;
    484      1.3    oster 						break;
    485      1.3    oster 					}
    486      1.3    oster 				}
    487      1.3    oster 
    488      1.3    oster 			/* release it if indicated */
    489      1.3    oster 			if (release_it) {
    490      1.3    oster 				if (rf_stripeLockDebug) {
    491      1.3    oster 					Dprintf8("[%d] Granting lock to candidate stripeID %ld, type %c range %ld-%ld %ld-%ld table 0x%lx\n",
    492      1.3    oster 					    tid, stripeID, candidate->type, candidate->start, candidate->stop, candidate->start2, candidate->stop2,
    493      1.3    oster 					    (unsigned long) lockTable);
    494      1.3    oster 					FLUSH;
    495      1.3    oster 				}
    496      1.3    oster 				if (candidate_t) {
    497      1.3    oster 					candidate_t->next = candidate->next;
    498      1.3    oster 					if (lockDesc->waitersT == candidate)
    499      1.3    oster 						lockDesc->waitersT = candidate_t;	/* cannot be waitersH
    500      1.3    oster 											 * since candidate_t is
    501      1.3    oster 											 * not NULL */
    502      1.3    oster 				} else {
    503      1.3    oster 					RF_ASSERT(candidate == lockDesc->waitersH);
    504      1.3    oster 					lockDesc->waitersH = lockDesc->waitersH->next;
    505      1.3    oster 					if (!lockDesc->waitersH)
    506      1.3    oster 						lockDesc->waitersT = NULL;
    507      1.3    oster 				}
    508      1.3    oster 				candidate->next = lockDesc->granted;	/* move it to the
    509      1.3    oster 									 * granted list */
    510      1.3    oster 				lockDesc->granted = candidate;
    511      1.3    oster 
    512      1.3    oster 				RF_ASSERT(!candidate->templink);
    513      1.3    oster 				candidate->templink = callbacklist;	/* put it on the list of
    514      1.3    oster 									 * things to be called
    515      1.3    oster 									 * after we release the
    516      1.3    oster 									 * mutex */
    517      1.3    oster 				callbacklist = candidate;
    518      1.3    oster 
    519      1.3    oster 				if (!candidate_t)
    520      1.3    oster 					candidate = lockDesc->waitersH;
    521      1.3    oster 				else
    522      1.3    oster 					candidate = candidate_t->next;	/* continue with the
    523      1.3    oster 									 * rest of the list */
    524      1.3    oster 			} else {
    525      1.3    oster 				candidate_t = candidate;
    526      1.3    oster 				candidate = candidate->next;	/* continue with the
    527      1.3    oster 								 * rest of the list */
    528      1.3    oster 			}
    529      1.3    oster 		}
    530      1.3    oster 
    531      1.3    oster 	/* delete the descriptor if no one is waiting or active */
    532      1.3    oster 	if (!lockDesc->granted && !lockDesc->waitersH) {
    533      1.3    oster 		RF_ASSERT(lockDesc->nWriters == 0);
    534      1.3    oster 		if (rf_stripeLockDebug) {
    535      1.3    oster 			Dprintf3("[%d] Last lock released (table 0x%lx): deleting desc for stripeID %ld\n", tid, (unsigned long) lockTable, stripeID);
    536      1.3    oster 			FLUSH;
    537      1.3    oster 		}
    538      1.3    oster 		if (ld_t)
    539      1.3    oster 			ld_t->next = lockDesc->next;
    540      1.3    oster 		else {
    541      1.3    oster 			RF_ASSERT(lockDesc == lockTable[hashval].descList);
    542      1.3    oster 			lockTable[hashval].descList = lockDesc->next;
    543      1.3    oster 		}
    544      1.3    oster 		FreeStripeLockDesc(lockDesc);
    545      1.3    oster 		lockDesc = NULL;/* only for the ASSERT below */
    546      1.3    oster 	}
    547      1.3    oster 	RF_UNLOCK_MUTEX(lockTable[hashval].mutex);
    548      1.3    oster 
    549      1.3    oster 	/* now that we've unlocked the mutex, invoke the callback on all the
    550      1.3    oster 	 * descriptors in the list */
    551      1.3    oster 	RF_ASSERT(!((callbacklist) && (!lockDesc)));	/* if we deleted the
    552      1.3    oster 							 * descriptor, we should
    553      1.3    oster 							 * have no callbacks to
    554      1.3    oster 							 * do */
    555      1.3    oster 	for (candidate = callbacklist; candidate;) {
    556      1.3    oster 		t = candidate;
    557      1.3    oster 		candidate = candidate->templink;
    558      1.3    oster 		t->templink = NULL;
    559      1.3    oster 		(t->cbFunc) (t->cbArg);
    560      1.1    oster 	}
    561      1.1    oster }
    562      1.3    oster /* must have the indicated lock table mutex upon entry */
    563      1.3    oster static void
    564      1.3    oster AddToWaitersQueue(
    565      1.3    oster     RF_LockTableEntry_t * lockTable,
    566      1.3    oster     RF_StripeLockDesc_t * lockDesc,
    567      1.3    oster     RF_LockReqDesc_t * lockReqDesc)
    568      1.3    oster {
    569      1.6     fvdl #if 0 /* XXX fvdl -- unitialized use of 'tid' */
    570      1.3    oster 	int     tid;
    571      1.1    oster 
    572      1.3    oster 	if (rf_stripeLockDebug) {
    573      1.3    oster 		Dprintf3("[%d] Waiting on lock for stripe %ld table 0x%lx\n", tid, lockDesc->stripeID, (unsigned long) lockTable);
    574      1.3    oster 		FLUSH;
    575      1.3    oster 	}
    576      1.6     fvdl #endif
    577      1.3    oster 	if (!lockDesc->waitersH) {
    578      1.3    oster 		lockDesc->waitersH = lockDesc->waitersT = lockReqDesc;
    579      1.3    oster 	} else {
    580      1.3    oster 		lockDesc->waitersT->next = lockReqDesc;
    581      1.3    oster 		lockDesc->waitersT = lockReqDesc;
    582      1.3    oster 	}
    583      1.1    oster }
    584      1.1    oster 
    585      1.3    oster static RF_StripeLockDesc_t *
    586      1.3    oster AllocStripeLockDesc(RF_StripeNum_t stripeID)
    587      1.1    oster {
    588      1.1    oster 	RF_StripeLockDesc_t *p;
    589      1.1    oster 
    590      1.3    oster 	RF_FREELIST_GET(rf_stripelock_freelist, p, next, (RF_StripeLockDesc_t *));
    591      1.1    oster 	if (p) {
    592      1.1    oster 		p->stripeID = stripeID;
    593      1.1    oster 	}
    594      1.3    oster 	return (p);
    595      1.1    oster }
    596      1.1    oster 
    597      1.3    oster static void
    598      1.3    oster FreeStripeLockDesc(RF_StripeLockDesc_t * p)
    599      1.1    oster {
    600      1.3    oster 	RF_FREELIST_FREE(rf_stripelock_freelist, p, next);
    601      1.1    oster }
    602      1.1    oster 
    603      1.3    oster static void
    604      1.3    oster PrintLockedStripes(lockTable)
    605      1.3    oster 	RF_LockTableEntry_t *lockTable;
    606      1.3    oster {
    607      1.3    oster 	int     i, j, foundone = 0, did;
    608      1.3    oster 	RF_StripeLockDesc_t *p;
    609      1.3    oster 	RF_LockReqDesc_t *q;
    610      1.3    oster 
    611      1.3    oster 	RF_LOCK_MUTEX(rf_printf_mutex);
    612      1.3    oster 	printf("Locked stripes:\n");
    613      1.3    oster 	for (i = 0; i < rf_lockTableSize; i++)
    614      1.3    oster 		if (lockTable[i].descList) {
    615      1.3    oster 			foundone = 1;
    616      1.3    oster 			for (p = lockTable[i].descList; p; p = p->next) {
    617      1.3    oster 				printf("Stripe ID 0x%lx (%d) nWriters %d\n",
    618      1.3    oster 				    (long) p->stripeID, (int) p->stripeID, p->nWriters);
    619      1.3    oster 
    620      1.3    oster 				if (!(p->granted))
    621      1.3    oster 					printf("Granted: (none)\n");
    622      1.3    oster 				else
    623      1.3    oster 					printf("Granted:\n");
    624      1.3    oster 				for (did = 1, j = 0, q = p->granted; q; j++, q = q->next) {
    625      1.3    oster 					printf("  %c(%ld-%ld", q->type, (long) q->start, (long) q->stop);
    626      1.3    oster 					if (q->start2 != -1)
    627      1.3    oster 						printf(",%ld-%ld) ", (long) q->start2,
    628      1.3    oster 						    (long) q->stop2);
    629      1.3    oster 					else
    630      1.3    oster 						printf(") ");
    631      1.3    oster 					if (j && !(j % 4)) {
    632      1.3    oster 						printf("\n");
    633      1.3    oster 						did = 1;
    634      1.3    oster 					} else
    635      1.3    oster 						did = 0;
    636      1.3    oster 				}
    637      1.3    oster 				if (!did)
    638      1.3    oster 					printf("\n");
    639      1.3    oster 
    640      1.3    oster 				if (!(p->waitersH))
    641      1.3    oster 					printf("Waiting: (none)\n");
    642      1.3    oster 				else
    643      1.3    oster 					printf("Waiting:\n");
    644      1.3    oster 				for (did = 1, j = 0, q = p->waitersH; q; j++, q = q->next) {
    645      1.3    oster 					printf("%c(%ld-%ld", q->type, (long) q->start, (long) q->stop);
    646      1.3    oster 					if (q->start2 != -1)
    647      1.3    oster 						printf(",%ld-%ld) ", (long) q->start2, (long) q->stop2);
    648      1.3    oster 					else
    649      1.3    oster 						printf(") ");
    650      1.3    oster 					if (j && !(j % 4)) {
    651      1.3    oster 						printf("\n         ");
    652      1.3    oster 						did = 1;
    653      1.3    oster 					} else
    654      1.3    oster 						did = 0;
    655      1.3    oster 				}
    656      1.3    oster 				if (!did)
    657      1.3    oster 					printf("\n");
    658      1.3    oster 			}
    659      1.3    oster 		}
    660      1.3    oster 	if (!foundone)
    661      1.3    oster 		printf("(none)\n");
    662      1.3    oster 	else
    663      1.3    oster 		printf("\n");
    664      1.3    oster 	RF_UNLOCK_MUTEX(rf_printf_mutex);
    665      1.1    oster }
    666