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