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