Home | History | Annotate | Line # | Download | only in raidframe
rf_engine.c revision 1.10
      1  1.10  thorpej /*	$NetBSD: rf_engine.c,v 1.10 2000/08/20 16:51:03 thorpej Exp $	*/
      2   1.1    oster /*
      3   1.1    oster  * Copyright (c) 1995 Carnegie-Mellon University.
      4   1.1    oster  * All rights reserved.
      5   1.1    oster  *
      6   1.1    oster  * Author: William V. Courtright II, Mark Holland, Rachad Youssef
      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  *                                                                          *
     31   1.1    oster  * engine.c -- code for DAG execution engine                                *
     32   1.1    oster  *                                                                          *
     33   1.1    oster  * Modified to work as follows (holland):                                   *
     34   1.1    oster  *   A user-thread calls into DispatchDAG, which fires off the nodes that   *
     35   1.1    oster  *   are direct successors to the header node.  DispatchDAG then returns,   *
     36   1.1    oster  *   and the rest of the I/O continues asynchronously.  As each node        *
     37   1.1    oster  *   completes, the node execution function calls FinishNode().  FinishNode *
     38   1.1    oster  *   scans the list of successors to the node and increments the antecedent *
     39   1.1    oster  *   counts.  Each node that becomes enabled is placed on a central node    *
     40   1.1    oster  *   queue.  A dedicated dag-execution thread grabs nodes off of this       *
     41   1.1    oster  *   queue and fires them.                                                  *
     42   1.1    oster  *                                                                          *
     43   1.1    oster  *   NULL nodes are never fired.                                            *
     44   1.1    oster  *                                                                          *
     45   1.1    oster  *   Terminator nodes are never fired, but rather cause the callback        *
     46   1.1    oster  *   associated with the DAG to be invoked.                                 *
     47   1.1    oster  *                                                                          *
     48   1.1    oster  *   If a node fails, the dag either rolls forward to the completion or     *
     49   1.1    oster  *   rolls back, undoing previously-completed nodes and fails atomically.   *
     50   1.1    oster  *   The direction of recovery is determined by the location of the failed  *
     51   1.1    oster  *   node in the graph.  If the failure occured before the commit node in   *
     52   1.1    oster  *   the graph, backward recovery is used.  Otherwise, forward recovery is  *
     53   1.1    oster  *   used.                                                                  *
     54   1.1    oster  *                                                                          *
     55   1.1    oster  ****************************************************************************/
     56   1.1    oster 
     57   1.1    oster #include "rf_threadstuff.h"
     58   1.1    oster 
     59   1.1    oster #include <sys/errno.h>
     60   1.1    oster 
     61   1.1    oster #include "rf_dag.h"
     62   1.1    oster #include "rf_engine.h"
     63   1.1    oster #include "rf_etimer.h"
     64   1.1    oster #include "rf_general.h"
     65   1.1    oster #include "rf_dagutils.h"
     66   1.1    oster #include "rf_shutdown.h"
     67   1.1    oster #include "rf_raid.h"
     68   1.1    oster 
     69   1.1    oster static void DAGExecutionThread(RF_ThreadArg_t arg);
     70   1.1    oster 
     71   1.1    oster #define DO_INIT(_l_,_r_) { \
     72   1.1    oster   int _rc; \
     73   1.1    oster   _rc = rf_create_managed_mutex(_l_,&(_r_)->node_queue_mutex); \
     74   1.1    oster   if (_rc) { \
     75   1.1    oster     return(_rc); \
     76   1.1    oster   } \
     77   1.1    oster   _rc = rf_create_managed_cond(_l_,&(_r_)->node_queue_cond); \
     78   1.1    oster   if (_rc) { \
     79   1.1    oster     return(_rc); \
     80   1.1    oster   } \
     81   1.1    oster }
     82   1.1    oster 
     83   1.1    oster /* synchronization primitives for this file.  DO_WAIT should be enclosed in a while loop. */
     84   1.1    oster 
     85   1.1    oster /*
     86   1.1    oster  * XXX Is this spl-ing really necessary?
     87   1.1    oster  */
     88  1.10  thorpej #define DO_LOCK(_r_) \
     89  1.10  thorpej do { \
     90  1.10  thorpej 	ks = splbio(); \
     91  1.10  thorpej 	RF_LOCK_MUTEX((_r_)->node_queue_mutex); \
     92  1.10  thorpej } while (0)
     93  1.10  thorpej 
     94  1.10  thorpej #define DO_UNLOCK(_r_) \
     95  1.10  thorpej do { \
     96  1.10  thorpej 	RF_UNLOCK_MUTEX((_r_)->node_queue_mutex); \
     97  1.10  thorpej 	splx(ks); \
     98  1.10  thorpej } while (0)
     99  1.10  thorpej 
    100  1.10  thorpej #define	DO_WAIT(_r_) \
    101  1.10  thorpej 	RF_WAIT_COND((_r_)->node_queue, (_r_)->node_queue_mutex)
    102  1.10  thorpej 
    103  1.10  thorpej #define	DO_SIGNAL(_r_) \
    104  1.10  thorpej 	RF_BROADCAST_COND((_r_)->node_queue)	/* XXX RF_SIGNAL_COND? */
    105   1.1    oster 
    106   1.1    oster static void rf_ShutdownEngine(void *);
    107   1.1    oster 
    108   1.4    oster static void
    109   1.4    oster rf_ShutdownEngine(arg)
    110   1.4    oster 	void   *arg;
    111   1.4    oster {
    112   1.4    oster 	RF_Raid_t *raidPtr;
    113   1.4    oster 
    114   1.4    oster 	raidPtr = (RF_Raid_t *) arg;
    115   1.4    oster 	raidPtr->shutdown_engine = 1;
    116   1.4    oster 	DO_SIGNAL(raidPtr);
    117   1.1    oster }
    118   1.1    oster 
    119   1.4    oster int
    120   1.4    oster rf_ConfigureEngine(
    121   1.4    oster     RF_ShutdownList_t ** listp,
    122   1.4    oster     RF_Raid_t * raidPtr,
    123   1.4    oster     RF_Config_t * cfgPtr)
    124   1.4    oster {
    125   1.9    oster 	int     rc;
    126   1.4    oster 
    127   1.4    oster 	DO_INIT(listp, raidPtr);
    128   1.4    oster 
    129   1.4    oster 	raidPtr->node_queue = NULL;
    130   1.4    oster 	raidPtr->dags_in_flight = 0;
    131   1.4    oster 
    132   1.4    oster 	rc = rf_init_managed_threadgroup(listp, &raidPtr->engine_tg);
    133   1.4    oster 	if (rc)
    134   1.4    oster 		return (rc);
    135   1.4    oster 
    136   1.4    oster 	/* we create the execution thread only once per system boot. no need
    137   1.4    oster 	 * to check return code b/c the kernel panics if it can't create the
    138   1.4    oster 	 * thread. */
    139   1.4    oster 	if (rf_engineDebug) {
    140   1.9    oster 		printf("raid%d: Creating engine thread\n", raidPtr->raidid);
    141   1.4    oster 	}
    142   1.6    oster 	if (RF_CREATE_THREAD(raidPtr->engine_thread, DAGExecutionThread, raidPtr,"raid")) {
    143   1.4    oster 		RF_ERRORMSG("RAIDFRAME: Unable to create engine thread\n");
    144   1.4    oster 		return (ENOMEM);
    145   1.4    oster 	}
    146   1.4    oster 	if (rf_engineDebug) {
    147   1.9    oster 		printf("raid%d: Created engine thread\n", raidPtr->raidid);
    148   1.4    oster 	}
    149   1.4    oster 	RF_THREADGROUP_STARTED(&raidPtr->engine_tg);
    150   1.4    oster 	/* XXX something is missing here... */
    151   1.1    oster #ifdef debug
    152   1.4    oster 	printf("Skipping the WAIT_START!!\n");
    153   1.1    oster #endif
    154   1.1    oster #if 0
    155   1.4    oster 	RF_THREADGROUP_WAIT_START(&raidPtr->engine_tg);
    156   1.1    oster #endif
    157   1.4    oster 	/* engine thread is now running and waiting for work */
    158   1.4    oster 	if (rf_engineDebug) {
    159   1.9    oster 		printf("raid%d: Engine thread running and waiting for events\n", raidPtr->raidid);
    160   1.4    oster 	}
    161   1.4    oster 	rc = rf_ShutdownCreate(listp, rf_ShutdownEngine, raidPtr);
    162   1.4    oster 	if (rc) {
    163   1.4    oster 		RF_ERRORMSG3("Unable to add to shutdown list file %s line %d rc=%d\n", __FILE__,
    164   1.4    oster 		    __LINE__, rc);
    165   1.4    oster 		rf_ShutdownEngine(NULL);
    166   1.4    oster 	}
    167   1.4    oster 	return (rc);
    168   1.4    oster }
    169   1.4    oster 
    170   1.4    oster static int
    171   1.4    oster BranchDone(RF_DagNode_t * node)
    172   1.4    oster {
    173   1.4    oster 	int     i;
    174   1.4    oster 
    175   1.4    oster 	/* return true if forward execution is completed for a node and it's
    176   1.4    oster 	 * succedents */
    177   1.4    oster 	switch (node->status) {
    178   1.4    oster 	case rf_wait:
    179   1.4    oster 		/* should never be called in this state */
    180   1.4    oster 		RF_PANIC();
    181   1.4    oster 		break;
    182   1.4    oster 	case rf_fired:
    183   1.4    oster 		/* node is currently executing, so we're not done */
    184   1.4    oster 		return (RF_FALSE);
    185   1.4    oster 	case rf_good:
    186   1.4    oster 		for (i = 0; i < node->numSuccedents; i++)	/* for each succedent */
    187   1.4    oster 			if (!BranchDone(node->succedents[i]))	/* recursively check
    188   1.4    oster 								 * branch */
    189   1.4    oster 				return RF_FALSE;
    190   1.4    oster 		return RF_TRUE;	/* node and all succedent branches aren't in
    191   1.4    oster 				 * fired state */
    192   1.4    oster 		break;
    193   1.4    oster 	case rf_bad:
    194   1.4    oster 		/* succedents can't fire */
    195   1.4    oster 		return (RF_TRUE);
    196   1.4    oster 	case rf_recover:
    197   1.4    oster 		/* should never be called in this state */
    198   1.4    oster 		RF_PANIC();
    199   1.4    oster 		break;
    200   1.4    oster 	case rf_undone:
    201   1.4    oster 	case rf_panic:
    202   1.4    oster 		/* XXX need to fix this case */
    203   1.4    oster 		/* for now, assume that we're done */
    204   1.4    oster 		return (RF_TRUE);
    205   1.4    oster 		break;
    206   1.4    oster 	default:
    207   1.4    oster 		/* illegal node status */
    208   1.4    oster 		RF_PANIC();
    209   1.4    oster 		break;
    210   1.4    oster 	}
    211   1.4    oster }
    212   1.4    oster 
    213   1.4    oster static int
    214   1.4    oster NodeReady(RF_DagNode_t * node)
    215   1.4    oster {
    216   1.4    oster 	int     ready;
    217   1.4    oster 
    218   1.4    oster 	switch (node->dagHdr->status) {
    219   1.4    oster 	case rf_enable:
    220   1.4    oster 	case rf_rollForward:
    221   1.4    oster 		if ((node->status == rf_wait) && (node->numAntecedents == node->numAntDone))
    222   1.4    oster 			ready = RF_TRUE;
    223   1.4    oster 		else
    224   1.4    oster 			ready = RF_FALSE;
    225   1.4    oster 		break;
    226   1.4    oster 	case rf_rollBackward:
    227   1.4    oster 		RF_ASSERT(node->numSuccDone <= node->numSuccedents);
    228   1.4    oster 		RF_ASSERT(node->numSuccFired <= node->numSuccedents);
    229   1.4    oster 		RF_ASSERT(node->numSuccFired <= node->numSuccDone);
    230   1.4    oster 		if ((node->status == rf_good) && (node->numSuccDone == node->numSuccedents))
    231   1.4    oster 			ready = RF_TRUE;
    232   1.4    oster 		else
    233   1.4    oster 			ready = RF_FALSE;
    234   1.4    oster 		break;
    235   1.4    oster 	default:
    236   1.4    oster 		printf("Execution engine found illegal DAG status in NodeReady\n");
    237   1.4    oster 		RF_PANIC();
    238   1.4    oster 		break;
    239   1.4    oster 	}
    240   1.1    oster 
    241   1.4    oster 	return (ready);
    242   1.1    oster }
    243   1.1    oster 
    244   1.1    oster 
    245   1.1    oster 
    246   1.1    oster /* user context and dag-exec-thread context:
    247   1.1    oster  * Fire a node.  The node's status field determines which function, do or undo,
    248   1.1    oster  * to be fired.
    249   1.1    oster  * This routine assumes that the node's status field has alread been set to
    250   1.1    oster  * "fired" or "recover" to indicate the direction of execution.
    251   1.1    oster  */
    252   1.4    oster static void
    253   1.4    oster FireNode(RF_DagNode_t * node)
    254   1.1    oster {
    255   1.4    oster 	switch (node->status) {
    256   1.4    oster 	case rf_fired:
    257   1.4    oster 		/* fire the do function of a node */
    258   1.4    oster 		if (rf_engineDebug) {
    259   1.9    oster 			printf("raid%d: Firing node 0x%lx (%s)\n",
    260   1.9    oster 			       node->dagHdr->raidPtr->raidid,
    261   1.9    oster 			       (unsigned long) node, node->name);
    262   1.4    oster 		}
    263   1.4    oster 		if (node->flags & RF_DAGNODE_FLAG_YIELD) {
    264   1.1    oster #if defined(__NetBSD__) && defined(_KERNEL)
    265   1.4    oster 			/* thread_block(); */
    266   1.4    oster 			/* printf("Need to block the thread here...\n");  */
    267   1.4    oster 			/* XXX thread_block is actually mentioned in
    268   1.4    oster 			 * /usr/include/vm/vm_extern.h */
    269   1.1    oster #else
    270   1.4    oster 			thread_block();
    271   1.1    oster #endif
    272   1.4    oster 		}
    273   1.4    oster 		(*(node->doFunc)) (node);
    274   1.4    oster 		break;
    275   1.4    oster 	case rf_recover:
    276   1.4    oster 		/* fire the undo function of a node */
    277   1.9    oster 		if (rf_engineDebug) {
    278   1.9    oster 			printf("raid%d: Firing (undo) node 0x%lx (%s)\n",
    279   1.9    oster 			       node->dagHdr->raidPtr->raidid,
    280   1.9    oster 			       (unsigned long) node, node->name);
    281   1.4    oster 		}
    282   1.4    oster 		if (node->flags & RF_DAGNODE_FLAG_YIELD)
    283   1.1    oster #if defined(__NetBSD__) && defined(_KERNEL)
    284   1.4    oster 			/* thread_block(); */
    285   1.4    oster 			/* printf("Need to block the thread here...\n"); */
    286   1.4    oster 			/* XXX thread_block is actually mentioned in
    287   1.4    oster 			 * /usr/include/vm/vm_extern.h */
    288   1.1    oster #else
    289   1.4    oster 			thread_block();
    290   1.1    oster #endif
    291   1.4    oster 		(*(node->undoFunc)) (node);
    292   1.4    oster 		break;
    293   1.4    oster 	default:
    294   1.4    oster 		RF_PANIC();
    295   1.4    oster 		break;
    296   1.4    oster 	}
    297   1.1    oster }
    298   1.1    oster 
    299   1.1    oster 
    300   1.1    oster 
    301   1.1    oster /* user context:
    302   1.1    oster  * Attempt to fire each node in a linear array.
    303   1.1    oster  * The entire list is fired atomically.
    304   1.1    oster  */
    305   1.4    oster static void
    306   1.4    oster FireNodeArray(
    307   1.4    oster     int numNodes,
    308   1.4    oster     RF_DagNode_t ** nodeList)
    309   1.4    oster {
    310   1.4    oster 	RF_DagStatus_t dstat;
    311   1.4    oster 	RF_DagNode_t *node;
    312   1.4    oster 	int     i, j;
    313   1.4    oster 
    314   1.4    oster 	/* first, mark all nodes which are ready to be fired */
    315   1.4    oster 	for (i = 0; i < numNodes; i++) {
    316   1.4    oster 		node = nodeList[i];
    317   1.4    oster 		dstat = node->dagHdr->status;
    318   1.4    oster 		RF_ASSERT((node->status == rf_wait) || (node->status == rf_good));
    319   1.4    oster 		if (NodeReady(node)) {
    320   1.4    oster 			if ((dstat == rf_enable) || (dstat == rf_rollForward)) {
    321   1.4    oster 				RF_ASSERT(node->status == rf_wait);
    322   1.4    oster 				if (node->commitNode)
    323   1.4    oster 					node->dagHdr->numCommits++;
    324   1.4    oster 				node->status = rf_fired;
    325   1.4    oster 				for (j = 0; j < node->numAntecedents; j++)
    326   1.4    oster 					node->antecedents[j]->numSuccFired++;
    327   1.4    oster 			} else {
    328   1.4    oster 				RF_ASSERT(dstat == rf_rollBackward);
    329   1.4    oster 				RF_ASSERT(node->status == rf_good);
    330   1.4    oster 				RF_ASSERT(node->commitNode == RF_FALSE);	/* only one commit node
    331   1.4    oster 										 * per graph */
    332   1.4    oster 				node->status = rf_recover;
    333   1.4    oster 			}
    334   1.4    oster 		}
    335   1.4    oster 	}
    336   1.4    oster 	/* now, fire the nodes */
    337   1.4    oster 	for (i = 0; i < numNodes; i++) {
    338   1.4    oster 		if ((nodeList[i]->status == rf_fired) || (nodeList[i]->status == rf_recover))
    339   1.4    oster 			FireNode(nodeList[i]);
    340   1.4    oster 	}
    341   1.1    oster }
    342   1.1    oster 
    343   1.1    oster 
    344   1.1    oster /* user context:
    345   1.1    oster  * Attempt to fire each node in a linked list.
    346   1.1    oster  * The entire list is fired atomically.
    347   1.1    oster  */
    348   1.4    oster static void
    349   1.4    oster FireNodeList(RF_DagNode_t * nodeList)
    350   1.1    oster {
    351   1.4    oster 	RF_DagNode_t *node, *next;
    352   1.4    oster 	RF_DagStatus_t dstat;
    353   1.4    oster 	int     j;
    354   1.4    oster 
    355   1.4    oster 	if (nodeList) {
    356   1.4    oster 		/* first, mark all nodes which are ready to be fired */
    357   1.4    oster 		for (node = nodeList; node; node = next) {
    358   1.4    oster 			next = node->next;
    359   1.4    oster 			dstat = node->dagHdr->status;
    360   1.4    oster 			RF_ASSERT((node->status == rf_wait) || (node->status == rf_good));
    361   1.4    oster 			if (NodeReady(node)) {
    362   1.4    oster 				if ((dstat == rf_enable) || (dstat == rf_rollForward)) {
    363   1.4    oster 					RF_ASSERT(node->status == rf_wait);
    364   1.4    oster 					if (node->commitNode)
    365   1.4    oster 						node->dagHdr->numCommits++;
    366   1.4    oster 					node->status = rf_fired;
    367   1.4    oster 					for (j = 0; j < node->numAntecedents; j++)
    368   1.4    oster 						node->antecedents[j]->numSuccFired++;
    369   1.4    oster 				} else {
    370   1.4    oster 					RF_ASSERT(dstat == rf_rollBackward);
    371   1.4    oster 					RF_ASSERT(node->status == rf_good);
    372   1.4    oster 					RF_ASSERT(node->commitNode == RF_FALSE);	/* only one commit node
    373   1.4    oster 											 * per graph */
    374   1.4    oster 					node->status = rf_recover;
    375   1.4    oster 				}
    376   1.4    oster 			}
    377   1.4    oster 		}
    378   1.4    oster 		/* now, fire the nodes */
    379   1.4    oster 		for (node = nodeList; node; node = next) {
    380   1.4    oster 			next = node->next;
    381   1.4    oster 			if ((node->status == rf_fired) || (node->status == rf_recover))
    382   1.4    oster 				FireNode(node);
    383   1.4    oster 		}
    384   1.4    oster 	}
    385   1.1    oster }
    386   1.1    oster /* interrupt context:
    387   1.1    oster  * for each succedent
    388   1.1    oster  *    propagate required results from node to succedent
    389   1.1    oster  *    increment succedent's numAntDone
    390   1.1    oster  *    place newly-enable nodes on node queue for firing
    391   1.1    oster  *
    392   1.1    oster  * To save context switches, we don't place NIL nodes on the node queue,
    393   1.1    oster  * but rather just process them as if they had fired.  Note that NIL nodes
    394   1.1    oster  * that are the direct successors of the header will actually get fired by
    395   1.1    oster  * DispatchDAG, which is fine because no context switches are involved.
    396   1.1    oster  *
    397   1.1    oster  * Important:  when running at user level, this can be called by any
    398   1.1    oster  * disk thread, and so the increment and check of the antecedent count
    399   1.1    oster  * must be locked.  I used the node queue mutex and locked down the
    400   1.1    oster  * entire function, but this is certainly overkill.
    401   1.1    oster  */
    402   1.4    oster static void
    403   1.4    oster PropagateResults(
    404   1.4    oster     RF_DagNode_t * node,
    405   1.4    oster     int context)
    406   1.4    oster {
    407   1.4    oster 	RF_DagNode_t *s, *a;
    408   1.4    oster 	RF_Raid_t *raidPtr;
    409   1.9    oster 	int     i, ks;
    410   1.4    oster 	RF_DagNode_t *finishlist = NULL;	/* a list of NIL nodes to be
    411   1.4    oster 						 * finished */
    412   1.4    oster 	RF_DagNode_t *skiplist = NULL;	/* list of nodes with failed truedata
    413   1.4    oster 					 * antecedents */
    414   1.4    oster 	RF_DagNode_t *firelist = NULL;	/* a list of nodes to be fired */
    415   1.4    oster 	RF_DagNode_t *q = NULL, *qh = NULL, *next;
    416   1.4    oster 	int     j, skipNode;
    417   1.4    oster 
    418   1.4    oster 	raidPtr = node->dagHdr->raidPtr;
    419   1.4    oster 
    420   1.4    oster 	DO_LOCK(raidPtr);
    421   1.4    oster 
    422   1.4    oster 	/* debug - validate fire counts */
    423   1.4    oster 	for (i = 0; i < node->numAntecedents; i++) {
    424   1.4    oster 		a = *(node->antecedents + i);
    425   1.4    oster 		RF_ASSERT(a->numSuccFired >= a->numSuccDone);
    426   1.4    oster 		RF_ASSERT(a->numSuccFired <= a->numSuccedents);
    427   1.4    oster 		a->numSuccDone++;
    428   1.4    oster 	}
    429   1.4    oster 
    430   1.4    oster 	switch (node->dagHdr->status) {
    431   1.4    oster 	case rf_enable:
    432   1.4    oster 	case rf_rollForward:
    433   1.4    oster 		for (i = 0; i < node->numSuccedents; i++) {
    434   1.4    oster 			s = *(node->succedents + i);
    435   1.4    oster 			RF_ASSERT(s->status == rf_wait);
    436   1.4    oster 			(s->numAntDone)++;
    437   1.4    oster 			if (s->numAntDone == s->numAntecedents) {
    438   1.4    oster 				/* look for NIL nodes */
    439   1.4    oster 				if (s->doFunc == rf_NullNodeFunc) {
    440   1.4    oster 					/* don't fire NIL nodes, just process
    441   1.4    oster 					 * them */
    442   1.4    oster 					s->next = finishlist;
    443   1.4    oster 					finishlist = s;
    444   1.4    oster 				} else {
    445   1.4    oster 					/* look to see if the node is to be
    446   1.4    oster 					 * skipped */
    447   1.4    oster 					skipNode = RF_FALSE;
    448   1.4    oster 					for (j = 0; j < s->numAntecedents; j++)
    449   1.4    oster 						if ((s->antType[j] == rf_trueData) && (s->antecedents[j]->status == rf_bad))
    450   1.4    oster 							skipNode = RF_TRUE;
    451   1.4    oster 					if (skipNode) {
    452   1.4    oster 						/* this node has one or more
    453   1.4    oster 						 * failed true data
    454   1.4    oster 						 * dependencies, so skip it */
    455   1.4    oster 						s->next = skiplist;
    456   1.4    oster 						skiplist = s;
    457   1.4    oster 					} else
    458   1.4    oster 						/* add s to list of nodes (q)
    459   1.4    oster 						 * to execute */
    460   1.4    oster 						if (context != RF_INTR_CONTEXT) {
    461   1.4    oster 							/* we only have to
    462   1.4    oster 							 * enqueue if we're at
    463   1.4    oster 							 * intr context */
    464   1.4    oster 							s->next = firelist;	/* put node on a list to
    465   1.4    oster 										 * be fired after we
    466   1.4    oster 										 * unlock */
    467   1.4    oster 							firelist = s;
    468   1.4    oster 						} else {	/* enqueue the node for
    469   1.4    oster 								 * the dag exec thread
    470   1.4    oster 								 * to fire */
    471   1.4    oster 							RF_ASSERT(NodeReady(s));
    472   1.4    oster 							if (q) {
    473   1.4    oster 								q->next = s;
    474   1.4    oster 								q = s;
    475   1.4    oster 							} else {
    476   1.4    oster 								qh = q = s;
    477   1.4    oster 								qh->next = NULL;
    478   1.4    oster 							}
    479   1.4    oster 						}
    480   1.4    oster 				}
    481   1.4    oster 			}
    482   1.4    oster 		}
    483   1.4    oster 
    484   1.4    oster 		if (q) {
    485   1.4    oster 			/* xfer our local list of nodes to the node queue */
    486   1.4    oster 			q->next = raidPtr->node_queue;
    487   1.4    oster 			raidPtr->node_queue = qh;
    488   1.4    oster 			DO_SIGNAL(raidPtr);
    489   1.4    oster 		}
    490   1.4    oster 		DO_UNLOCK(raidPtr);
    491   1.4    oster 
    492   1.4    oster 		for (; skiplist; skiplist = next) {
    493   1.4    oster 			next = skiplist->next;
    494   1.4    oster 			skiplist->status = rf_skipped;
    495   1.4    oster 			for (i = 0; i < skiplist->numAntecedents; i++) {
    496   1.4    oster 				skiplist->antecedents[i]->numSuccFired++;
    497   1.4    oster 			}
    498   1.4    oster 			if (skiplist->commitNode) {
    499   1.4    oster 				skiplist->dagHdr->numCommits++;
    500   1.4    oster 			}
    501   1.4    oster 			rf_FinishNode(skiplist, context);
    502   1.4    oster 		}
    503   1.4    oster 		for (; finishlist; finishlist = next) {
    504   1.4    oster 			/* NIL nodes: no need to fire them */
    505   1.4    oster 			next = finishlist->next;
    506   1.4    oster 			finishlist->status = rf_good;
    507   1.4    oster 			for (i = 0; i < finishlist->numAntecedents; i++) {
    508   1.4    oster 				finishlist->antecedents[i]->numSuccFired++;
    509   1.4    oster 			}
    510   1.4    oster 			if (finishlist->commitNode)
    511   1.4    oster 				finishlist->dagHdr->numCommits++;
    512   1.4    oster 			/*
    513   1.4    oster 		         * Okay, here we're calling rf_FinishNode() on nodes that
    514   1.4    oster 		         * have the null function as their work proc. Such a node
    515   1.4    oster 		         * could be the terminal node in a DAG. If so, it will
    516   1.4    oster 		         * cause the DAG to complete, which will in turn free
    517   1.4    oster 		         * memory used by the DAG, which includes the node in
    518   1.4    oster 		         * question. Thus, we must avoid referencing the node
    519   1.4    oster 		         * at all after calling rf_FinishNode() on it.
    520   1.4    oster 		         */
    521   1.4    oster 			rf_FinishNode(finishlist, context);	/* recursive call */
    522   1.4    oster 		}
    523   1.4    oster 		/* fire all nodes in firelist */
    524   1.4    oster 		FireNodeList(firelist);
    525   1.4    oster 		break;
    526   1.4    oster 
    527   1.4    oster 	case rf_rollBackward:
    528   1.4    oster 		for (i = 0; i < node->numAntecedents; i++) {
    529   1.4    oster 			a = *(node->antecedents + i);
    530   1.4    oster 			RF_ASSERT(a->status == rf_good);
    531   1.4    oster 			RF_ASSERT(a->numSuccDone <= a->numSuccedents);
    532   1.4    oster 			RF_ASSERT(a->numSuccDone <= a->numSuccFired);
    533   1.4    oster 
    534   1.4    oster 			if (a->numSuccDone == a->numSuccFired) {
    535   1.4    oster 				if (a->undoFunc == rf_NullNodeFunc) {
    536   1.4    oster 					/* don't fire NIL nodes, just process
    537   1.4    oster 					 * them */
    538   1.4    oster 					a->next = finishlist;
    539   1.4    oster 					finishlist = a;
    540   1.4    oster 				} else {
    541   1.4    oster 					if (context != RF_INTR_CONTEXT) {
    542   1.4    oster 						/* we only have to enqueue if
    543   1.4    oster 						 * we're at intr context */
    544   1.4    oster 						a->next = firelist;	/* put node on a list to
    545   1.4    oster 									 * be fired after we
    546   1.4    oster 									 * unlock */
    547   1.4    oster 						firelist = a;
    548   1.4    oster 					} else {	/* enqueue the node for
    549   1.4    oster 							 * the dag exec thread
    550   1.4    oster 							 * to fire */
    551   1.4    oster 						RF_ASSERT(NodeReady(a));
    552   1.4    oster 						if (q) {
    553   1.4    oster 							q->next = a;
    554   1.4    oster 							q = a;
    555   1.4    oster 						} else {
    556   1.4    oster 							qh = q = a;
    557   1.4    oster 							qh->next = NULL;
    558   1.4    oster 						}
    559   1.4    oster 					}
    560   1.4    oster 				}
    561   1.4    oster 			}
    562   1.4    oster 		}
    563   1.4    oster 		if (q) {
    564   1.4    oster 			/* xfer our local list of nodes to the node queue */
    565   1.4    oster 			q->next = raidPtr->node_queue;
    566   1.4    oster 			raidPtr->node_queue = qh;
    567   1.4    oster 			DO_SIGNAL(raidPtr);
    568   1.4    oster 		}
    569   1.4    oster 		DO_UNLOCK(raidPtr);
    570   1.4    oster 		for (; finishlist; finishlist = next) {	/* NIL nodes: no need to
    571   1.4    oster 							 * fire them */
    572   1.4    oster 			next = finishlist->next;
    573   1.4    oster 			finishlist->status = rf_good;
    574   1.4    oster 			/*
    575   1.4    oster 		         * Okay, here we're calling rf_FinishNode() on nodes that
    576   1.4    oster 		         * have the null function as their work proc. Such a node
    577   1.4    oster 		         * could be the first node in a DAG. If so, it will
    578   1.4    oster 		         * cause the DAG to complete, which will in turn free
    579   1.4    oster 		         * memory used by the DAG, which includes the node in
    580   1.4    oster 		         * question. Thus, we must avoid referencing the node
    581   1.4    oster 		         * at all after calling rf_FinishNode() on it.
    582   1.4    oster 		         */
    583   1.4    oster 			rf_FinishNode(finishlist, context);	/* recursive call */
    584   1.4    oster 		}
    585   1.4    oster 		/* fire all nodes in firelist */
    586   1.4    oster 		FireNodeList(firelist);
    587   1.4    oster 
    588   1.4    oster 		break;
    589   1.4    oster 	default:
    590   1.4    oster 		printf("Engine found illegal DAG status in PropagateResults()\n");
    591   1.4    oster 		RF_PANIC();
    592   1.4    oster 		break;
    593   1.4    oster 	}
    594   1.1    oster }
    595   1.1    oster 
    596   1.1    oster 
    597   1.1    oster 
    598   1.1    oster /*
    599   1.1    oster  * Process a fired node which has completed
    600   1.1    oster  */
    601   1.4    oster static void
    602   1.4    oster ProcessNode(
    603   1.4    oster     RF_DagNode_t * node,
    604   1.4    oster     int context)
    605   1.4    oster {
    606   1.4    oster 	RF_Raid_t *raidPtr;
    607   1.4    oster 
    608   1.4    oster 	raidPtr = node->dagHdr->raidPtr;
    609   1.4    oster 
    610   1.4    oster 	switch (node->status) {
    611   1.4    oster 	case rf_good:
    612   1.4    oster 		/* normal case, don't need to do anything */
    613   1.4    oster 		break;
    614   1.4    oster 	case rf_bad:
    615   1.4    oster 		if ((node->dagHdr->numCommits > 0) || (node->dagHdr->numCommitNodes == 0)) {
    616   1.4    oster 			node->dagHdr->status = rf_rollForward;	/* crossed commit
    617   1.4    oster 								 * barrier */
    618   1.4    oster 			if (rf_engineDebug || 1) {
    619   1.9    oster 				printf("raid%d: node (%s) returned fail, rolling forward\n", raidPtr->raidid, node->name);
    620   1.4    oster 			}
    621   1.4    oster 		} else {
    622   1.4    oster 			node->dagHdr->status = rf_rollBackward;	/* never reached commit
    623   1.4    oster 								 * barrier */
    624   1.4    oster 			if (rf_engineDebug || 1) {
    625   1.9    oster 				printf("raid%d: node (%s) returned fail, rolling backward\n", raidPtr->raidid, node->name);
    626   1.4    oster 			}
    627   1.4    oster 		}
    628   1.4    oster 		break;
    629   1.4    oster 	case rf_undone:
    630   1.4    oster 		/* normal rollBackward case, don't need to do anything */
    631   1.4    oster 		break;
    632   1.4    oster 	case rf_panic:
    633   1.4    oster 		/* an undo node failed!!! */
    634   1.4    oster 		printf("UNDO of a node failed!!!/n");
    635   1.4    oster 		break;
    636   1.4    oster 	default:
    637   1.4    oster 		printf("node finished execution with an illegal status!!!\n");
    638   1.4    oster 		RF_PANIC();
    639   1.4    oster 		break;
    640   1.4    oster 	}
    641   1.1    oster 
    642   1.4    oster 	/* enqueue node's succedents (antecedents if rollBackward) for
    643   1.4    oster 	 * execution */
    644   1.4    oster 	PropagateResults(node, context);
    645   1.1    oster }
    646   1.1    oster 
    647   1.1    oster 
    648   1.1    oster 
    649   1.1    oster /* user context or dag-exec-thread context:
    650   1.1    oster  * This is the first step in post-processing a newly-completed node.
    651   1.1    oster  * This routine is called by each node execution function to mark the node
    652   1.1    oster  * as complete and fire off any successors that have been enabled.
    653   1.1    oster  */
    654   1.4    oster int
    655   1.4    oster rf_FinishNode(
    656   1.4    oster     RF_DagNode_t * node,
    657   1.4    oster     int context)
    658   1.4    oster {
    659   1.4    oster 	/* as far as I can tell, retcode is not used -wvcii */
    660   1.4    oster 	int     retcode = RF_FALSE;
    661   1.4    oster 	node->dagHdr->numNodesCompleted++;
    662   1.4    oster 	ProcessNode(node, context);
    663   1.1    oster 
    664   1.4    oster 	return (retcode);
    665   1.1    oster }
    666   1.1    oster 
    667   1.1    oster 
    668   1.1    oster /* user context:
    669   1.1    oster  * submit dag for execution, return non-zero if we have to wait for completion.
    670   1.1    oster  * if and only if we return non-zero, we'll cause cbFunc to get invoked with
    671   1.1    oster  * cbArg when the DAG has completed.
    672   1.1    oster  *
    673   1.1    oster  * for now we always return 1.  If the DAG does not cause any I/O, then the callback
    674   1.1    oster  * may get invoked before DispatchDAG returns.  There's code in state 5 of ContinueRaidAccess
    675   1.1    oster  * to handle this.
    676   1.1    oster  *
    677   1.1    oster  * All we do here is fire the direct successors of the header node.  The
    678   1.1    oster  * DAG execution thread does the rest of the dag processing.
    679   1.1    oster  */
    680   1.4    oster int
    681   1.4    oster rf_DispatchDAG(
    682   1.4    oster     RF_DagHeader_t * dag,
    683   1.4    oster     void (*cbFunc) (void *),
    684   1.4    oster     void *cbArg)
    685   1.4    oster {
    686   1.4    oster 	RF_Raid_t *raidPtr;
    687   1.4    oster 
    688   1.4    oster 	raidPtr = dag->raidPtr;
    689   1.4    oster 	if (dag->tracerec) {
    690   1.4    oster 		RF_ETIMER_START(dag->tracerec->timer);
    691   1.4    oster 	}
    692   1.4    oster 	if (rf_engineDebug || rf_validateDAGDebug) {
    693   1.4    oster 		if (rf_ValidateDAG(dag))
    694   1.4    oster 			RF_PANIC();
    695   1.4    oster 	}
    696   1.4    oster 	if (rf_engineDebug) {
    697   1.9    oster 		printf("raid%d: Entering DispatchDAG\n", raidPtr->raidid);
    698   1.4    oster 	}
    699   1.4    oster 	raidPtr->dags_in_flight++;	/* debug only:  blow off proper
    700   1.4    oster 					 * locking */
    701   1.4    oster 	dag->cbFunc = cbFunc;
    702   1.4    oster 	dag->cbArg = cbArg;
    703   1.4    oster 	dag->numNodesCompleted = 0;
    704   1.4    oster 	dag->status = rf_enable;
    705   1.4    oster 	FireNodeArray(dag->numSuccedents, dag->succedents);
    706   1.4    oster 	return (1);
    707   1.1    oster }
    708   1.1    oster /* dedicated kernel thread:
    709   1.1    oster  * the thread that handles all DAG node firing.
    710   1.1    oster  * To minimize locking and unlocking, we grab a copy of the entire node queue and then set the
    711   1.1    oster  * node queue to NULL before doing any firing of nodes.  This way we only have to release the
    712   1.1    oster  * lock once.  Of course, it's probably rare that there's more than one node in the queue at
    713   1.1    oster  * any one time, but it sometimes happens.
    714   1.1    oster  *
    715   1.1    oster  * In the kernel, this thread runs at spl0 and is not swappable.  I copied these
    716   1.1    oster  * characteristics from the aio_completion_thread.
    717   1.1    oster  */
    718   1.1    oster 
    719   1.4    oster static void
    720   1.4    oster DAGExecutionThread(RF_ThreadArg_t arg)
    721   1.1    oster {
    722   1.4    oster 	RF_DagNode_t *nd, *local_nq, *term_nq, *fire_nq;
    723   1.4    oster 	RF_Raid_t *raidPtr;
    724   1.9    oster 	int     ks;
    725   1.4    oster 	int     s;
    726   1.4    oster 
    727   1.4    oster 	raidPtr = (RF_Raid_t *) arg;
    728   1.4    oster 
    729   1.4    oster 	if (rf_engineDebug) {
    730   1.9    oster 		printf("raid%d: Engine thread is running\n", raidPtr->raidid);
    731   1.4    oster 	}
    732   1.1    oster 
    733   1.4    oster 	s = splbio();
    734   1.1    oster 
    735   1.4    oster 	RF_THREADGROUP_RUNNING(&raidPtr->engine_tg);
    736   1.1    oster 
    737   1.4    oster 	DO_LOCK(raidPtr);
    738   1.4    oster 	while (!raidPtr->shutdown_engine) {
    739   1.1    oster 
    740   1.4    oster 		while (raidPtr->node_queue != NULL) {
    741   1.4    oster 			local_nq = raidPtr->node_queue;
    742   1.4    oster 			fire_nq = NULL;
    743   1.4    oster 			term_nq = NULL;
    744   1.4    oster 			raidPtr->node_queue = NULL;
    745   1.4    oster 			DO_UNLOCK(raidPtr);
    746   1.4    oster 
    747   1.4    oster 			/* first, strip out the terminal nodes */
    748   1.4    oster 			while (local_nq) {
    749   1.4    oster 				nd = local_nq;
    750   1.4    oster 				local_nq = local_nq->next;
    751   1.4    oster 				switch (nd->dagHdr->status) {
    752   1.4    oster 				case rf_enable:
    753   1.4    oster 				case rf_rollForward:
    754   1.4    oster 					if (nd->numSuccedents == 0) {
    755   1.4    oster 						/* end of the dag, add to
    756   1.4    oster 						 * callback list */
    757   1.4    oster 						nd->next = term_nq;
    758   1.4    oster 						term_nq = nd;
    759   1.4    oster 					} else {
    760   1.4    oster 						/* not the end, add to the
    761   1.4    oster 						 * fire queue */
    762   1.4    oster 						nd->next = fire_nq;
    763   1.4    oster 						fire_nq = nd;
    764   1.4    oster 					}
    765   1.4    oster 					break;
    766   1.4    oster 				case rf_rollBackward:
    767   1.4    oster 					if (nd->numAntecedents == 0) {
    768   1.4    oster 						/* end of the dag, add to the
    769   1.4    oster 						 * callback list */
    770   1.4    oster 						nd->next = term_nq;
    771   1.4    oster 						term_nq = nd;
    772   1.4    oster 					} else {
    773   1.4    oster 						/* not the end, add to the
    774   1.4    oster 						 * fire queue */
    775   1.4    oster 						nd->next = fire_nq;
    776   1.4    oster 						fire_nq = nd;
    777   1.4    oster 					}
    778   1.4    oster 					break;
    779   1.4    oster 				default:
    780   1.4    oster 					RF_PANIC();
    781   1.4    oster 					break;
    782   1.4    oster 				}
    783   1.4    oster 			}
    784   1.4    oster 
    785   1.4    oster 			/* execute callback of dags which have reached the
    786   1.4    oster 			 * terminal node */
    787   1.4    oster 			while (term_nq) {
    788   1.4    oster 				nd = term_nq;
    789   1.4    oster 				term_nq = term_nq->next;
    790   1.4    oster 				nd->next = NULL;
    791   1.4    oster 				(nd->dagHdr->cbFunc) (nd->dagHdr->cbArg);
    792   1.4    oster 				raidPtr->dags_in_flight--;	/* debug only */
    793   1.4    oster 			}
    794   1.4    oster 
    795   1.4    oster 			/* fire remaining nodes */
    796   1.4    oster 			FireNodeList(fire_nq);
    797   1.4    oster 
    798   1.4    oster 			DO_LOCK(raidPtr);
    799   1.4    oster 		}
    800   1.4    oster 		while (!raidPtr->shutdown_engine && raidPtr->node_queue == NULL)
    801   1.4    oster 			DO_WAIT(raidPtr);
    802   1.4    oster 	}
    803   1.4    oster 	DO_UNLOCK(raidPtr);
    804   1.1    oster 
    805   1.4    oster 	RF_THREADGROUP_DONE(&raidPtr->engine_tg);
    806   1.8    oster 
    807   1.4    oster 	splx(s);
    808   1.4    oster 	kthread_exit(0);
    809   1.1    oster }
    810