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