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