xref: /netbsd-src/sys/dev/raidframe/rf_driver.c (revision 37b34d511dea595d3ba03a661cf3b775038ea5f8)
1 /*	$NetBSD: rf_driver.c,v 1.65 2002/10/18 02:46:36 oster Exp $	*/
2 /*-
3  * Copyright (c) 1999 The NetBSD Foundation, Inc.
4  * All rights reserved.
5  *
6  * This code is derived from software contributed to The NetBSD Foundation
7  * by Greg Oster
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. All advertising materials mentioning features or use of this software
18  *    must display the following acknowledgement:
19  *        This product includes software developed by the NetBSD
20  *        Foundation, Inc. and its contributors.
21  * 4. Neither the name of The NetBSD Foundation nor the names of its
22  *    contributors may be used to endorse or promote products derived
23  *    from this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35  * POSSIBILITY OF SUCH DAMAGE.
36  */
37 
38 /*
39  * Copyright (c) 1995 Carnegie-Mellon University.
40  * All rights reserved.
41  *
42  * Author: Mark Holland, Khalil Amiri, Claudson Bornstein, William V. Courtright II,
43  *         Robby Findler, Daniel Stodolsky, Rachad Youssef, Jim Zelenka
44  *
45  * Permission to use, copy, modify and distribute this software and
46  * its documentation is hereby granted, provided that both the copyright
47  * notice and this permission notice appear in all copies of the
48  * software, derivative works or modified versions, and any portions
49  * thereof, and that both notices appear in supporting documentation.
50  *
51  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
52  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
53  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
54  *
55  * Carnegie Mellon requests users of this software to return to
56  *
57  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
58  *  School of Computer Science
59  *  Carnegie Mellon University
60  *  Pittsburgh PA 15213-3890
61  *
62  * any improvements or extensions that they make and grant Carnegie the
63  * rights to redistribute these changes.
64  */
65 
66 /******************************************************************************
67  *
68  * rf_driver.c -- main setup, teardown, and access routines for the RAID driver
69  *
70  * all routines are prefixed with rf_ (raidframe), to avoid conficts.
71  *
72  ******************************************************************************/
73 
74 
75 #include <sys/cdefs.h>
76 __KERNEL_RCSID(0, "$NetBSD: rf_driver.c,v 1.65 2002/10/18 02:46:36 oster Exp $");
77 
78 #include <sys/param.h>
79 #include <sys/systm.h>
80 #include <sys/ioctl.h>
81 #include <sys/fcntl.h>
82 #include <sys/vnode.h>
83 
84 
85 #include "rf_archs.h"
86 #include "rf_threadstuff.h"
87 
88 #include <sys/errno.h>
89 
90 #include "rf_raid.h"
91 #include "rf_dag.h"
92 #include "rf_aselect.h"
93 #include "rf_diskqueue.h"
94 #include "rf_parityscan.h"
95 #include "rf_alloclist.h"
96 #include "rf_dagutils.h"
97 #include "rf_utils.h"
98 #include "rf_etimer.h"
99 #include "rf_acctrace.h"
100 #include "rf_general.h"
101 #include "rf_desc.h"
102 #include "rf_states.h"
103 #include "rf_freelist.h"
104 #include "rf_decluster.h"
105 #include "rf_map.h"
106 #include "rf_revent.h"
107 #include "rf_callback.h"
108 #include "rf_engine.h"
109 #include "rf_mcpair.h"
110 #include "rf_nwayxor.h"
111 #include "rf_copyback.h"
112 #include "rf_driver.h"
113 #include "rf_options.h"
114 #include "rf_shutdown.h"
115 #include "rf_kintf.h"
116 
117 #include <sys/buf.h>
118 
119 #ifndef RF_ACCESS_DEBUG
120 #define RF_ACCESS_DEBUG 0
121 #endif
122 
123 /* rad == RF_RaidAccessDesc_t */
124 static RF_FreeList_t *rf_rad_freelist;
125 #define RF_MAX_FREE_RAD 128
126 #define RF_RAD_INC       16
127 #define RF_RAD_INITIAL   32
128 
129 /* debug variables */
130 char    rf_panicbuf[2048];	/* a buffer to hold an error msg when we panic */
131 
132 /* main configuration routines */
133 static int raidframe_booted = 0;
134 
135 static void rf_ConfigureDebug(RF_Config_t * cfgPtr);
136 static void set_debug_option(char *name, long val);
137 static void rf_UnconfigureArray(void);
138 static int init_rad(RF_RaidAccessDesc_t *);
139 static void clean_rad(RF_RaidAccessDesc_t *);
140 static void rf_ShutdownRDFreeList(void *);
141 static int rf_ConfigureRDFreeList(RF_ShutdownList_t **);
142 
143 RF_DECLARE_MUTEX(rf_printf_mutex)	/* debug only:  avoids interleaved
144 					 * printfs by different stripes */
145 
146 #define SIGNAL_QUIESCENT_COND(_raid_)  wakeup(&((_raid_)->accesses_suspended))
147 #define WAIT_FOR_QUIESCENCE(_raid_) \
148 	ltsleep(&((_raid_)->accesses_suspended), PRIBIO, \
149 		"raidframe quiesce", 0, &((_raid_)->access_suspend_mutex))
150 
151 #define IO_BUF_ERR(bp, err) { \
152 	bp->b_flags |= B_ERROR; \
153 	bp->b_resid = bp->b_bcount; \
154 	bp->b_error = err; \
155 	biodone(bp); \
156 }
157 
158 static int configureCount = 0;	/* number of active configurations */
159 static int isconfigged = 0;	/* is basic raidframe (non per-array)
160 				 * stuff configged */
161 RF_DECLARE_LKMGR_STATIC_MUTEX(configureMutex)	/* used to lock the configuration
162 					 * stuff */
163 static RF_ShutdownList_t *globalShutdown;	/* non array-specific
164 						 * stuff */
165 
166 static int rf_ConfigureRDFreeList(RF_ShutdownList_t ** listp);
167 
168 /* called at system boot time */
169 int
170 rf_BootRaidframe()
171 {
172 	int     rc;
173 
174 	if (raidframe_booted)
175 		return (EBUSY);
176 	raidframe_booted = 1;
177 
178 	rc = rf_lkmgr_mutex_init(&configureMutex);
179 	if (rc) {
180 		rf_print_unable_to_init_mutex( __FILE__, __LINE__, rc);
181 		RF_PANIC();
182 	}
183 	configureCount = 0;
184 	isconfigged = 0;
185 	globalShutdown = NULL;
186 	return (0);
187 }
188 
189 /*
190  * Called whenever an array is shutdown
191  */
192 static void
193 rf_UnconfigureArray()
194 {
195 	int     rc;
196 
197 	RF_LOCK_LKMGR_MUTEX(configureMutex);
198 	if (--configureCount == 0) {	/* if no active configurations, shut
199 					 * everything down */
200 		isconfigged = 0;
201 
202 		rc = rf_ShutdownList(&globalShutdown);
203 		if (rc) {
204 			RF_ERRORMSG1("RAIDFRAME: unable to do global shutdown, rc=%d\n", rc);
205 		}
206 
207 		/*
208 	         * We must wait until now, because the AllocList module
209 	         * uses the DebugMem module.
210 	         */
211 #if RF_DEBUG_MEM
212 		if (rf_memDebug)
213 			rf_print_unfreed();
214 #endif
215 	}
216 	RF_UNLOCK_LKMGR_MUTEX(configureMutex);
217 }
218 
219 /*
220  * Called to shut down an array.
221  */
222 int
223 rf_Shutdown(raidPtr)
224 	RF_Raid_t *raidPtr;
225 {
226 
227 	if (!raidPtr->valid) {
228 		RF_ERRORMSG("Attempt to shut down unconfigured RAIDframe driver.  Aborting shutdown\n");
229 		return (EINVAL);
230 	}
231 	/*
232          * wait for outstanding IOs to land
233          * As described in rf_raid.h, we use the rad_freelist lock
234          * to protect the per-array info about outstanding descs
235          * since we need to do freelist locking anyway, and this
236          * cuts down on the amount of serialization we've got going
237          * on.
238          */
239 	RF_FREELIST_DO_LOCK(rf_rad_freelist);
240 	if (raidPtr->waitShutdown) {
241 		RF_FREELIST_DO_UNLOCK(rf_rad_freelist);
242 		return (EBUSY);
243 	}
244 	raidPtr->waitShutdown = 1;
245 	while (raidPtr->nAccOutstanding) {
246 		RF_WAIT_COND(raidPtr->outstandingCond, RF_FREELIST_MUTEX_OF(rf_rad_freelist));
247 	}
248 	RF_FREELIST_DO_UNLOCK(rf_rad_freelist);
249 
250 	/* Wait for any parity re-writes to stop... */
251 	while (raidPtr->parity_rewrite_in_progress) {
252 		printf("Waiting for parity re-write to exit...\n");
253 		tsleep(&raidPtr->parity_rewrite_in_progress, PRIBIO,
254 		       "rfprwshutdown", 0);
255 	}
256 
257 	raidPtr->valid = 0;
258 
259 	rf_update_component_labels(raidPtr, RF_FINAL_COMPONENT_UPDATE);
260 
261 	rf_UnconfigureVnodes(raidPtr);
262 
263 	rf_ShutdownList(&raidPtr->shutdownList);
264 
265 	rf_UnconfigureArray();
266 
267 	return (0);
268 }
269 
270 
271 #define DO_INIT_CONFIGURE(f) { \
272 	rc = f (&globalShutdown); \
273 	if (rc) { \
274 		RF_ERRORMSG2("RAIDFRAME: failed %s with %d\n", RF_STRING(f), rc); \
275 		rf_ShutdownList(&globalShutdown); \
276 		configureCount--; \
277 		RF_UNLOCK_LKMGR_MUTEX(configureMutex); \
278 		return(rc); \
279 	} \
280 }
281 
282 #define DO_RAID_FAIL() { \
283 	rf_UnconfigureVnodes(raidPtr); \
284 	rf_ShutdownList(&raidPtr->shutdownList); \
285 	rf_UnconfigureArray(); \
286 }
287 
288 #define DO_RAID_INIT_CONFIGURE(f) { \
289 	rc = f (&raidPtr->shutdownList, raidPtr, cfgPtr); \
290 	if (rc) { \
291 		RF_ERRORMSG2("RAIDFRAME: failed %s with %d\n", RF_STRING(f), rc); \
292 		DO_RAID_FAIL(); \
293 		return(rc); \
294 	} \
295 }
296 
297 #define DO_RAID_MUTEX(_m_) { \
298 	rc = rf_create_managed_mutex(&raidPtr->shutdownList, (_m_)); \
299 	if (rc) { \
300 		rf_print_unable_to_init_mutex(__FILE__, __LINE__, rc); \
301 		DO_RAID_FAIL(); \
302 		return(rc); \
303 	} \
304 }
305 
306 #define DO_RAID_COND(_c_) { \
307 	rc = rf_create_managed_cond(&raidPtr->shutdownList, (_c_)); \
308 	if (rc) { \
309 		rf_print_unable_to_init_cond(__FILE__, __LINE__, rc); \
310 		DO_RAID_FAIL(); \
311 		return(rc); \
312 	} \
313 }
314 
315 int
316 rf_Configure(raidPtr, cfgPtr, ac)
317 	RF_Raid_t *raidPtr;
318 	RF_Config_t *cfgPtr;
319 	RF_AutoConfig_t *ac;
320 {
321 	RF_RowCol_t row, col;
322 	int     i, rc;
323 
324 	RF_LOCK_LKMGR_MUTEX(configureMutex);
325 	configureCount++;
326 	if (isconfigged == 0) {
327 		rc = rf_create_managed_mutex(&globalShutdown, &rf_printf_mutex);
328 		if (rc) {
329 			rf_print_unable_to_init_mutex(__FILE__, __LINE__, rc);
330 			rf_ShutdownList(&globalShutdown);
331 			return (rc);
332 		}
333 		/* initialize globals */
334 
335 		DO_INIT_CONFIGURE(rf_ConfigureAllocList);
336 
337 		/*
338 	         * Yes, this does make debugging general to the whole
339 	         * system instead of being array specific. Bummer, drag.
340 		 */
341 		rf_ConfigureDebug(cfgPtr);
342 		DO_INIT_CONFIGURE(rf_ConfigureDebugMem);
343 		DO_INIT_CONFIGURE(rf_ConfigureAccessTrace);
344 		DO_INIT_CONFIGURE(rf_ConfigureMapModule);
345 		DO_INIT_CONFIGURE(rf_ConfigureReconEvent);
346 		DO_INIT_CONFIGURE(rf_ConfigureCallback);
347 		DO_INIT_CONFIGURE(rf_ConfigureRDFreeList);
348 		DO_INIT_CONFIGURE(rf_ConfigureNWayXor);
349 		DO_INIT_CONFIGURE(rf_ConfigureStripeLockFreeList);
350 		DO_INIT_CONFIGURE(rf_ConfigureMCPair);
351 		DO_INIT_CONFIGURE(rf_ConfigureDAGs);
352 		DO_INIT_CONFIGURE(rf_ConfigureDAGFuncs);
353 		DO_INIT_CONFIGURE(rf_ConfigureReconstruction);
354 		DO_INIT_CONFIGURE(rf_ConfigureCopyback);
355 		DO_INIT_CONFIGURE(rf_ConfigureDiskQueueSystem);
356 		isconfigged = 1;
357 	}
358 	RF_UNLOCK_LKMGR_MUTEX(configureMutex);
359 
360 	DO_RAID_MUTEX(&raidPtr->mutex);
361 	/* set up the cleanup list.  Do this after ConfigureDebug so that
362 	 * value of memDebug will be set */
363 
364 	rf_MakeAllocList(raidPtr->cleanupList);
365 	if (raidPtr->cleanupList == NULL) {
366 		DO_RAID_FAIL();
367 		return (ENOMEM);
368 	}
369 	rc = rf_ShutdownCreate(&raidPtr->shutdownList,
370 	    (void (*) (void *)) rf_FreeAllocList,
371 	    raidPtr->cleanupList);
372 	if (rc) {
373 		rf_print_unable_to_add_shutdown(__FILE__, __LINE__, rc);
374 		DO_RAID_FAIL();
375 		return (rc);
376 	}
377 	raidPtr->numRow = cfgPtr->numRow;
378 	raidPtr->numCol = cfgPtr->numCol;
379 	raidPtr->numSpare = cfgPtr->numSpare;
380 
381 	/* XXX we don't even pretend to support more than one row in the
382 	 * kernel... */
383 	if (raidPtr->numRow != 1) {
384 		RF_ERRORMSG("Only one row supported in kernel.\n");
385 		DO_RAID_FAIL();
386 		return (EINVAL);
387 	}
388 	RF_CallocAndAdd(raidPtr->status, raidPtr->numRow, sizeof(RF_RowStatus_t),
389 	    (RF_RowStatus_t *), raidPtr->cleanupList);
390 	if (raidPtr->status == NULL) {
391 		DO_RAID_FAIL();
392 		return (ENOMEM);
393 	}
394 	RF_CallocAndAdd(raidPtr->reconControl, raidPtr->numRow,
395 	    sizeof(RF_ReconCtrl_t *), (RF_ReconCtrl_t **), raidPtr->cleanupList);
396 	if (raidPtr->reconControl == NULL) {
397 		DO_RAID_FAIL();
398 		return (ENOMEM);
399 	}
400 	for (i = 0; i < raidPtr->numRow; i++) {
401 		raidPtr->status[i] = rf_rs_optimal;
402 		raidPtr->reconControl[i] = NULL;
403 	}
404 
405 	TAILQ_INIT(&(raidPtr->iodone));
406 	simple_lock_init(&(raidPtr->iodone_lock));
407 
408 	DO_RAID_INIT_CONFIGURE(rf_ConfigureEngine);
409 	DO_RAID_INIT_CONFIGURE(rf_ConfigureStripeLocks);
410 
411 	DO_RAID_COND(&raidPtr->outstandingCond);
412 
413 	raidPtr->nAccOutstanding = 0;
414 	raidPtr->waitShutdown = 0;
415 
416 	DO_RAID_MUTEX(&raidPtr->access_suspend_mutex);
417 	DO_RAID_COND(&raidPtr->quiescent_cond);
418 
419 	DO_RAID_COND(&raidPtr->waitForReconCond);
420 
421 	DO_RAID_MUTEX(&raidPtr->recon_done_proc_mutex);
422 
423 	if (ac!=NULL) {
424 		/* We have an AutoConfig structure..  Don't do the
425 		   normal disk configuration... call the auto config
426 		   stuff */
427 		rf_AutoConfigureDisks(raidPtr, cfgPtr, ac);
428 	} else {
429 		DO_RAID_INIT_CONFIGURE(rf_ConfigureDisks);
430 		DO_RAID_INIT_CONFIGURE(rf_ConfigureSpareDisks);
431 	}
432 	/* do this after ConfigureDisks & ConfigureSpareDisks to be sure dev
433 	 * no. is set */
434 	DO_RAID_INIT_CONFIGURE(rf_ConfigureDiskQueues);
435 
436 	DO_RAID_INIT_CONFIGURE(rf_ConfigureLayout);
437 
438 	DO_RAID_INIT_CONFIGURE(rf_ConfigurePSStatus);
439 
440 	for (row = 0; row < raidPtr->numRow; row++) {
441 		for (col = 0; col < raidPtr->numCol; col++) {
442 			/*
443 		         * XXX better distribution
444 		         */
445 			raidPtr->hist_diskreq[row][col] = 0;
446 		}
447 	}
448 
449 	raidPtr->numNewFailures = 0;
450 	raidPtr->copyback_in_progress = 0;
451 	raidPtr->parity_rewrite_in_progress = 0;
452 	raidPtr->recon_in_progress = 0;
453 	raidPtr->maxOutstanding = cfgPtr->maxOutstandingDiskReqs;
454 
455 	/* autoconfigure and root_partition will actually get filled in
456 	   after the config is done */
457 	raidPtr->autoconfigure = 0;
458 	raidPtr->root_partition = 0;
459 	raidPtr->last_unit = raidPtr->raidid;
460 	raidPtr->config_order = 0;
461 
462 	if (rf_keepAccTotals) {
463 		raidPtr->keep_acc_totals = 1;
464 	}
465 	rf_StartUserStats(raidPtr);
466 
467 	raidPtr->valid = 1;
468 
469 	printf("raid%d: %s\n", raidPtr->raidid,
470 	       raidPtr->Layout.map->configName);
471 	printf("raid%d: Components:", raidPtr->raidid);
472 	for (row = 0; row < raidPtr->numRow; row++) {
473 		for (col = 0; col < raidPtr->numCol; col++) {
474 			printf(" %s", raidPtr->Disks[row][col].devname);
475 			if (RF_DEAD_DISK(raidPtr->Disks[row][col].status)) {
476 				printf("[**FAILED**]");
477 			}
478 		}
479 	}
480 	printf("\n");
481 	printf("raid%d: Total Sectors: %lu (%lu MB)\n",
482 	       raidPtr->raidid,
483 	       (unsigned long) raidPtr->totalSectors,
484 	       (unsigned long) (raidPtr->totalSectors / 1024 *
485 				(1 << raidPtr->logBytesPerSector) / 1024));
486 
487 	return (0);
488 }
489 
490 static int
491 init_rad(desc)
492 	RF_RaidAccessDesc_t *desc;
493 {
494 	int     rc;
495 
496 	rc = rf_mutex_init(&desc->mutex);
497 	if (rc) {
498 		rf_print_unable_to_init_mutex(__FILE__, __LINE__, rc);
499 		return (rc);
500 	}
501 	rc = rf_cond_init(&desc->cond);
502 	if (rc) {
503 		rf_print_unable_to_init_cond(__FILE__, __LINE__, rc);
504 		rf_mutex_destroy(&desc->mutex);
505 		return (rc);
506 	}
507 	return (0);
508 }
509 
510 static void
511 clean_rad(desc)
512 	RF_RaidAccessDesc_t *desc;
513 {
514 	rf_mutex_destroy(&desc->mutex);
515 	rf_cond_destroy(&desc->cond);
516 }
517 
518 static void
519 rf_ShutdownRDFreeList(ignored)
520 	void   *ignored;
521 {
522 	RF_FREELIST_DESTROY_CLEAN(rf_rad_freelist, next, (RF_RaidAccessDesc_t *), clean_rad);
523 }
524 
525 static int
526 rf_ConfigureRDFreeList(listp)
527 	RF_ShutdownList_t **listp;
528 {
529 	int     rc;
530 
531 	RF_FREELIST_CREATE(rf_rad_freelist, RF_MAX_FREE_RAD,
532 	    RF_RAD_INC, sizeof(RF_RaidAccessDesc_t));
533 	if (rf_rad_freelist == NULL) {
534 		return (ENOMEM);
535 	}
536 	rc = rf_ShutdownCreate(listp, rf_ShutdownRDFreeList, NULL);
537 	if (rc) {
538 		rf_print_unable_to_add_shutdown(__FILE__, __LINE__, rc);
539 		rf_ShutdownRDFreeList(NULL);
540 		return (rc);
541 	}
542 	RF_FREELIST_PRIME_INIT(rf_rad_freelist, RF_RAD_INITIAL, next,
543 	    (RF_RaidAccessDesc_t *), init_rad);
544 	return (0);
545 }
546 
547 RF_RaidAccessDesc_t *
548 rf_AllocRaidAccDesc(
549     RF_Raid_t * raidPtr,
550     RF_IoType_t type,
551     RF_RaidAddr_t raidAddress,
552     RF_SectorCount_t numBlocks,
553     caddr_t bufPtr,
554     void *bp,
555     RF_RaidAccessFlags_t flags,
556     RF_AccessState_t * states)
557 {
558 	RF_RaidAccessDesc_t *desc;
559 
560 	RF_FREELIST_GET_INIT_NOUNLOCK(rf_rad_freelist, desc, next, (RF_RaidAccessDesc_t *), init_rad);
561 	if (raidPtr->waitShutdown) {
562 		/*
563 	         * Actually, we're shutting the array down. Free the desc
564 	         * and return NULL.
565 	         */
566 		RF_FREELIST_DO_UNLOCK(rf_rad_freelist);
567 		RF_FREELIST_FREE_CLEAN(rf_rad_freelist, desc, next, clean_rad);
568 		return (NULL);
569 	}
570 	raidPtr->nAccOutstanding++;
571 	RF_FREELIST_DO_UNLOCK(rf_rad_freelist);
572 
573 	desc->raidPtr = (void *) raidPtr;
574 	desc->type = type;
575 	desc->raidAddress = raidAddress;
576 	desc->numBlocks = numBlocks;
577 	desc->bufPtr = bufPtr;
578 	desc->bp = bp;
579 	desc->paramDAG = NULL;
580 	desc->paramASM = NULL;
581 	desc->flags = flags;
582 	desc->states = states;
583 	desc->state = 0;
584 
585 	desc->status = 0;
586 	memset((char *) &desc->tracerec, 0, sizeof(RF_AccTraceEntry_t));
587 	desc->callbackFunc = NULL;
588 	desc->callbackArg = NULL;
589 	desc->next = NULL;
590 	desc->head = desc;
591 	desc->cleanupList = NULL;
592 	rf_MakeAllocList(desc->cleanupList);
593 	return (desc);
594 }
595 
596 void
597 rf_FreeRaidAccDesc(RF_RaidAccessDesc_t * desc)
598 {
599 	RF_Raid_t *raidPtr = desc->raidPtr;
600 
601 	RF_ASSERT(desc);
602 
603 	rf_FreeAllocList(desc->cleanupList);
604 	RF_FREELIST_FREE_CLEAN_NOUNLOCK(rf_rad_freelist, desc, next, clean_rad);
605 	raidPtr->nAccOutstanding--;
606 	if (raidPtr->waitShutdown) {
607 		RF_SIGNAL_COND(raidPtr->outstandingCond);
608 	}
609 	RF_FREELIST_DO_UNLOCK(rf_rad_freelist);
610 }
611 /*********************************************************************
612  * Main routine for performing an access.
613  * Accesses are retried until a DAG can not be selected.  This occurs
614  * when either the DAG library is incomplete or there are too many
615  * failures in a parity group.
616  ********************************************************************/
617 int
618 rf_DoAccess(
619     RF_Raid_t * raidPtr,
620     RF_IoType_t type,
621     int async_flag,
622     RF_RaidAddr_t raidAddress,
623     RF_SectorCount_t numBlocks,
624     caddr_t bufPtr,
625     void *bp_in,
626     RF_RaidAccessFlags_t flags)
627 /*
628 type should be read or write
629 async_flag should be RF_TRUE or RF_FALSE
630 bp_in is a buf pointer.  void * to facilitate ignoring it outside the kernel
631 */
632 {
633 	RF_RaidAccessDesc_t *desc;
634 	caddr_t lbufPtr = bufPtr;
635 	struct buf *bp = (struct buf *) bp_in;
636 
637 	raidAddress += rf_raidSectorOffset;
638 
639 #if RF_ACCESS_DEBUG
640 	if (rf_accessDebug) {
641 
642 		printf("logBytes is: %d %d %d\n", raidPtr->raidid,
643 		    raidPtr->logBytesPerSector,
644 		    (int) rf_RaidAddressToByte(raidPtr, numBlocks));
645 		printf("raid%d: %s raidAddr %d (stripeid %d-%d) numBlocks %d (%d bytes) buf 0x%lx\n", raidPtr->raidid,
646 		    (type == RF_IO_TYPE_READ) ? "READ" : "WRITE", (int) raidAddress,
647 		    (int) rf_RaidAddressToStripeID(&raidPtr->Layout, raidAddress),
648 		    (int) rf_RaidAddressToStripeID(&raidPtr->Layout, raidAddress + numBlocks - 1),
649 		    (int) numBlocks,
650 		    (int) rf_RaidAddressToByte(raidPtr, numBlocks),
651 		    (long) bufPtr);
652 	}
653 #endif
654 	if (raidAddress + numBlocks > raidPtr->totalSectors) {
655 
656 		printf("DoAccess: raid addr %lu too large to access %lu sectors.  Max legal addr is %lu\n",
657 		    (u_long) raidAddress, (u_long) numBlocks, (u_long) raidPtr->totalSectors);
658 
659 		IO_BUF_ERR(bp, ENOSPC);
660 		return (ENOSPC);
661 	}
662 	desc = rf_AllocRaidAccDesc(raidPtr, type, raidAddress,
663 	    numBlocks, lbufPtr, bp, flags, raidPtr->Layout.map->states);
664 
665 	if (desc == NULL) {
666 		return (ENOMEM);
667 	}
668 	RF_ETIMER_START(desc->tracerec.tot_timer);
669 
670 	desc->async_flag = async_flag;
671 
672 	rf_ContinueRaidAccess(desc);
673 
674 	return (0);
675 }
676 #if 0
677 /* force the array into reconfigured mode without doing reconstruction */
678 int
679 rf_SetReconfiguredMode(raidPtr, row, col)
680 	RF_Raid_t *raidPtr;
681 	int     row;
682 	int     col;
683 {
684 	if (!(raidPtr->Layout.map->flags & RF_DISTRIBUTE_SPARE)) {
685 		printf("Can't set reconfigured mode in dedicated-spare array\n");
686 		RF_PANIC();
687 	}
688 	RF_LOCK_MUTEX(raidPtr->mutex);
689 	raidPtr->numFailures++;
690 	raidPtr->Disks[row][col].status = rf_ds_dist_spared;
691 	raidPtr->status[row] = rf_rs_reconfigured;
692 	rf_update_component_labels(raidPtr, RF_NORMAL_COMPONENT_UPDATE);
693 	/* install spare table only if declustering + distributed sparing
694 	 * architecture. */
695 	if (raidPtr->Layout.map->flags & RF_BD_DECLUSTERED)
696 		rf_InstallSpareTable(raidPtr, row, col);
697 	RF_UNLOCK_MUTEX(raidPtr->mutex);
698 	return (0);
699 }
700 #endif
701 
702 int
703 rf_FailDisk(
704     RF_Raid_t * raidPtr,
705     int frow,
706     int fcol,
707     int initRecon)
708 {
709 	printf("raid%d: Failing disk r%d c%d\n", raidPtr->raidid, frow, fcol);
710 	RF_LOCK_MUTEX(raidPtr->mutex);
711 	raidPtr->numFailures++;
712 	raidPtr->Disks[frow][fcol].status = rf_ds_failed;
713 	raidPtr->status[frow] = rf_rs_degraded;
714 	RF_UNLOCK_MUTEX(raidPtr->mutex);
715 	rf_update_component_labels(raidPtr, RF_NORMAL_COMPONENT_UPDATE);
716 
717 	/* Close the component, so that it's not "locked" if someone
718 	   else want's to use it! */
719 
720 	rf_close_component(raidPtr, raidPtr->raid_cinfo[frow][fcol].ci_vp,
721 			   raidPtr->Disks[frow][fcol].auto_configured);
722 
723 	RF_LOCK_MUTEX(raidPtr->mutex);
724 	raidPtr->raid_cinfo[frow][fcol].ci_vp = NULL;
725 
726 	/* Need to mark the component as not being auto_configured
727 	   (in case it was previously). */
728 
729 	raidPtr->Disks[frow][fcol].auto_configured = 0;
730 	RF_UNLOCK_MUTEX(raidPtr->mutex);
731 
732 	if (initRecon)
733 		rf_ReconstructFailedDisk(raidPtr, frow, fcol);
734 	return (0);
735 }
736 /* releases a thread that is waiting for the array to become quiesced.
737  * access_suspend_mutex should be locked upon calling this
738  */
739 void
740 rf_SignalQuiescenceLock(raidPtr)
741 	RF_Raid_t *raidPtr;
742 {
743 #if RF_DEBUG_QUIESCE
744 	if (rf_quiesceDebug) {
745 		printf("raid%d: Signalling quiescence lock\n",
746 		       raidPtr->raidid);
747 	}
748 #endif
749 	raidPtr->access_suspend_release = 1;
750 
751 	if (raidPtr->waiting_for_quiescence) {
752 		SIGNAL_QUIESCENT_COND(raidPtr);
753 	}
754 }
755 /* suspends all new requests to the array.  No effect on accesses that are in flight.  */
756 int
757 rf_SuspendNewRequestsAndWait(raidPtr)
758 	RF_Raid_t *raidPtr;
759 {
760 #if RF_DEBUG_QUIESCE
761 	if (rf_quiesceDebug)
762 		printf("raid%d: Suspending new reqs\n", raidPtr->raidid);
763 #endif
764 	RF_LOCK_MUTEX(raidPtr->access_suspend_mutex);
765 	raidPtr->accesses_suspended++;
766 	raidPtr->waiting_for_quiescence = (raidPtr->accs_in_flight == 0) ? 0 : 1;
767 
768 	if (raidPtr->waiting_for_quiescence) {
769 		raidPtr->access_suspend_release = 0;
770 		while (!raidPtr->access_suspend_release) {
771 			printf("raid%d: Suspending: Waiting for Quiescence\n",
772 			       raidPtr->raidid);
773 			WAIT_FOR_QUIESCENCE(raidPtr);
774 			raidPtr->waiting_for_quiescence = 0;
775 		}
776 	}
777 	printf("raid%d: Quiescence reached..\n", raidPtr->raidid);
778 
779 	RF_UNLOCK_MUTEX(raidPtr->access_suspend_mutex);
780 	return (raidPtr->waiting_for_quiescence);
781 }
782 /* wake up everyone waiting for quiescence to be released */
783 void
784 rf_ResumeNewRequests(raidPtr)
785 	RF_Raid_t *raidPtr;
786 {
787 	RF_CallbackDesc_t *t, *cb;
788 
789 #if RF_DEBUG_QUIESCE
790 	if (rf_quiesceDebug)
791 		printf("Resuming new reqs\n");
792 #endif
793 
794 	RF_LOCK_MUTEX(raidPtr->access_suspend_mutex);
795 	raidPtr->accesses_suspended--;
796 	if (raidPtr->accesses_suspended == 0)
797 		cb = raidPtr->quiesce_wait_list;
798 	else
799 		cb = NULL;
800 	raidPtr->quiesce_wait_list = NULL;
801 	RF_UNLOCK_MUTEX(raidPtr->access_suspend_mutex);
802 
803 	while (cb) {
804 		t = cb;
805 		cb = cb->next;
806 		(t->callbackFunc) (t->callbackArg);
807 		rf_FreeCallbackDesc(t);
808 	}
809 }
810 /*****************************************************************************************
811  *
812  * debug routines
813  *
814  ****************************************************************************************/
815 
816 static void
817 set_debug_option(name, val)
818 	char   *name;
819 	long    val;
820 {
821 	RF_DebugName_t *p;
822 
823 	for (p = rf_debugNames; p->name; p++) {
824 		if (!strcmp(p->name, name)) {
825 			*(p->ptr) = val;
826 			printf("[Set debug variable %s to %ld]\n", name, val);
827 			return;
828 		}
829 	}
830 	RF_ERRORMSG1("Unknown debug string \"%s\"\n", name);
831 }
832 
833 
834 /* would like to use sscanf here, but apparently not available in kernel */
835 /*ARGSUSED*/
836 static void
837 rf_ConfigureDebug(cfgPtr)
838 	RF_Config_t *cfgPtr;
839 {
840 	char   *val_p, *name_p, *white_p;
841 	long    val;
842 	int     i;
843 
844 	rf_ResetDebugOptions();
845 	for (i = 0; cfgPtr->debugVars[i][0] && i < RF_MAXDBGV; i++) {
846 		name_p = rf_find_non_white(&cfgPtr->debugVars[i][0]);
847 		white_p = rf_find_white(name_p);	/* skip to start of 2nd
848 							 * word */
849 		val_p = rf_find_non_white(white_p);
850 		if (*val_p == '0' && *(val_p + 1) == 'x')
851 			val = rf_htoi(val_p + 2);
852 		else
853 			val = rf_atoi(val_p);
854 		*white_p = '\0';
855 		set_debug_option(name_p, val);
856 	}
857 }
858 /* performance monitoring stuff */
859 
860 #define TIMEVAL_TO_US(t) (((long) t.tv_sec) * 1000000L + (long) t.tv_usec)
861 
862 #if !defined(_KERNEL) && !defined(SIMULATE)
863 
864 /*
865  * Throughput stats currently only used in user-level RAIDframe
866  */
867 
868 static int
869 rf_InitThroughputStats(
870     RF_ShutdownList_t ** listp,
871     RF_Raid_t * raidPtr,
872     RF_Config_t * cfgPtr)
873 {
874 	int     rc;
875 
876 	/* these used by user-level raidframe only */
877 	rc = rf_create_managed_mutex(listp, &raidPtr->throughputstats.mutex);
878 	if (rc) {
879 		rf_print_unable_to_init_mutex(__FILE__, __LINE__, rc);
880 		return (rc);
881 	}
882 	raidPtr->throughputstats.sum_io_us = 0;
883 	raidPtr->throughputstats.num_ios = 0;
884 	raidPtr->throughputstats.num_out_ios = 0;
885 	return (0);
886 }
887 
888 void
889 rf_StartThroughputStats(RF_Raid_t * raidPtr)
890 {
891 	RF_LOCK_MUTEX(raidPtr->throughputstats.mutex);
892 	raidPtr->throughputstats.num_ios++;
893 	raidPtr->throughputstats.num_out_ios++;
894 	if (raidPtr->throughputstats.num_out_ios == 1)
895 		RF_GETTIME(raidPtr->throughputstats.start);
896 	RF_UNLOCK_MUTEX(raidPtr->throughputstats.mutex);
897 }
898 
899 static void
900 rf_StopThroughputStats(RF_Raid_t * raidPtr)
901 {
902 	struct timeval diff;
903 
904 	RF_LOCK_MUTEX(raidPtr->throughputstats.mutex);
905 	raidPtr->throughputstats.num_out_ios--;
906 	if (raidPtr->throughputstats.num_out_ios == 0) {
907 		RF_GETTIME(raidPtr->throughputstats.stop);
908 		RF_TIMEVAL_DIFF(&raidPtr->throughputstats.start, &raidPtr->throughputstats.stop, &diff);
909 		raidPtr->throughputstats.sum_io_us += TIMEVAL_TO_US(diff);
910 	}
911 	RF_UNLOCK_MUTEX(raidPtr->throughputstats.mutex);
912 }
913 
914 static void
915 rf_PrintThroughputStats(RF_Raid_t * raidPtr)
916 {
917 	RF_ASSERT(raidPtr->throughputstats.num_out_ios == 0);
918 	if (raidPtr->throughputstats.sum_io_us != 0) {
919 		printf("[Througphut: %8.2f IOs/second]\n", raidPtr->throughputstats.num_ios
920 		    / (raidPtr->throughputstats.sum_io_us / 1000000.0));
921 	}
922 }
923 #endif				/* !KERNEL && !SIMULATE */
924 
925 void
926 rf_StartUserStats(RF_Raid_t * raidPtr)
927 {
928 	RF_GETTIME(raidPtr->userstats.start);
929 	raidPtr->userstats.sum_io_us = 0;
930 	raidPtr->userstats.num_ios = 0;
931 	raidPtr->userstats.num_sect_moved = 0;
932 }
933 
934 void
935 rf_StopUserStats(RF_Raid_t * raidPtr)
936 {
937 	RF_GETTIME(raidPtr->userstats.stop);
938 }
939 
940 void
941 rf_UpdateUserStats(raidPtr, rt, numsect)
942 	RF_Raid_t *raidPtr;
943 	int     rt;		/* resp time in us */
944 	int     numsect;	/* number of sectors for this access */
945 {
946 	raidPtr->userstats.sum_io_us += rt;
947 	raidPtr->userstats.num_ios++;
948 	raidPtr->userstats.num_sect_moved += numsect;
949 }
950 
951 void
952 rf_PrintUserStats(RF_Raid_t * raidPtr)
953 {
954 	long    elapsed_us, mbs, mbs_frac;
955 	struct timeval diff;
956 
957 	RF_TIMEVAL_DIFF(&raidPtr->userstats.start, &raidPtr->userstats.stop, &diff);
958 	elapsed_us = TIMEVAL_TO_US(diff);
959 
960 	/* 2000 sectors per megabyte, 10000000 microseconds per second */
961 	if (elapsed_us)
962 		mbs = (raidPtr->userstats.num_sect_moved / 2000) / (elapsed_us / 1000000);
963 	else
964 		mbs = 0;
965 
966 	/* this computes only the first digit of the fractional mb/s moved */
967 	if (elapsed_us) {
968 		mbs_frac = ((raidPtr->userstats.num_sect_moved / 200) / (elapsed_us / 1000000))
969 		    - (mbs * 10);
970 	} else {
971 		mbs_frac = 0;
972 	}
973 
974 	printf("Number of I/Os:             %ld\n", raidPtr->userstats.num_ios);
975 	printf("Elapsed time (us):          %ld\n", elapsed_us);
976 	printf("User I/Os per second:       %ld\n", RF_DB0_CHECK(raidPtr->userstats.num_ios, (elapsed_us / 1000000)));
977 	printf("Average user response time: %ld us\n", RF_DB0_CHECK(raidPtr->userstats.sum_io_us, raidPtr->userstats.num_ios));
978 	printf("Total sectors moved:        %ld\n", raidPtr->userstats.num_sect_moved);
979 	printf("Average access size (sect): %ld\n", RF_DB0_CHECK(raidPtr->userstats.num_sect_moved, raidPtr->userstats.num_ios));
980 	printf("Achieved data rate:         %ld.%ld MB/sec\n", mbs, mbs_frac);
981 }
982 
983 
984 void
985 rf_print_panic_message(line,file)
986 	int line;
987 	char *file;
988 {
989 	sprintf(rf_panicbuf,"raidframe error at line %d file %s",
990 		line, file);
991 }
992 
993 #ifdef RAID_DIAGNOSTIC
994 void
995 rf_print_assert_panic_message(line,file,condition)
996 	int line;
997 	char *file;
998 	char *condition;
999 {
1000 	sprintf(rf_panicbuf,
1001 		"raidframe error at line %d file %s (failed asserting %s)\n",
1002 		line, file, condition);
1003 }
1004 #endif
1005 
1006 void
1007 rf_print_unable_to_init_mutex(file,line,rc)
1008 	char *file;
1009 	int line;
1010 	int rc;
1011 {
1012 	RF_ERRORMSG3("Unable to init mutex file %s line %d rc=%d\n",
1013 		     file, line, rc);
1014 }
1015 
1016 void
1017 rf_print_unable_to_init_cond(file,line,rc)
1018 	char *file;
1019 	int line;
1020 	int rc;
1021 {
1022 	RF_ERRORMSG3("Unable to init cond file %s line %d rc=%d\n",
1023 		     file, line, rc);
1024 }
1025 
1026 void
1027 rf_print_unable_to_add_shutdown(file,line,rc)
1028 	char *file;
1029 	int line;
1030 	int rc;
1031 {
1032 	RF_ERRORMSG3("Unable to add to shutdown list file %s line %d rc=%d\n",
1033 		     file, line, rc);
1034 }
1035