rf_dag.h revision 1.11 1 /* $NetBSD: rf_dag.h,v 1.11 2004/03/04 00:56:13 oster Exp $ */
2 /*
3 * Copyright (c) 1995 Carnegie-Mellon University.
4 * All rights reserved.
5 *
6 * Author: William V. Courtright II, Mark Holland
7 *
8 * Permission to use, copy, modify and distribute this software and
9 * its documentation is hereby granted, provided that both the copyright
10 * notice and this permission notice appear in all copies of the
11 * software, derivative works or modified versions, and any portions
12 * thereof, and that both notices appear in supporting documentation.
13 *
14 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
15 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
16 * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
17 *
18 * Carnegie Mellon requests users of this software to return to
19 *
20 * Software Distribution Coordinator or Software.Distribution (at) CS.CMU.EDU
21 * School of Computer Science
22 * Carnegie Mellon University
23 * Pittsburgh PA 15213-3890
24 *
25 * any improvements or extensions that they make and grant Carnegie the
26 * rights to redistribute these changes.
27 */
28
29 /****************************************************************************
30 * *
31 * dag.h -- header file for DAG-related data structures *
32 * *
33 ****************************************************************************/
34
35 #ifndef _RF__RF_DAG_H_
36 #define _RF__RF_DAG_H_
37
38 #include <dev/raidframe/raidframevar.h>
39
40 #include "rf_threadstuff.h"
41 #include "rf_alloclist.h"
42 #include "rf_stripelocks.h"
43 #include "rf_layout.h"
44 #include "rf_dagflags.h"
45 #include "rf_acctrace.h"
46
47 #define RF_THREAD_CONTEXT 0 /* we were invoked from thread context */
48 #define RF_INTR_CONTEXT 1 /* we were invoked from interrupt context */
49 #define RF_MAX_ANTECEDENTS 20 /* max num of antecedents a node may posses */
50
51 #include <sys/buf.h>
52
53 struct RF_PropHeader_s { /* structure for propagation of results */
54 int paramNum; /* to parameter # paramNum */
55 RF_PropHeader_t *next; /* linked list for multiple results/params */
56 };
57
58 typedef enum RF_NodeStatus_e {
59 rf_wait, /* node is waiting to be executed */
60 rf_fired, /* node is currently executing its do function */
61 rf_good, /* node successfully completed execution of
62 * its do function */
63 rf_bad, /* node failed to successfully execute its do
64 * function */
65 rf_skipped, /* not used anymore, used to imply a node was
66 * not executed */
67 rf_recover, /* node is currently executing its undo
68 * function */
69 rf_panic, /* node failed to successfully execute its
70 * undo function */
71 rf_undone /* node successfully executed its undo
72 * function */
73 } RF_NodeStatus_t;
74 /*
75 * These were used to control skipping a node.
76 * Now, these are only used as comments.
77 */
78 typedef enum RF_AntecedentType_e {
79 rf_trueData,
80 rf_antiData,
81 rf_outputData,
82 rf_control
83 } RF_AntecedentType_t;
84 #define RF_DAG_PTRCACHESIZE 40
85 #define RF_DAG_PARAMCACHESIZE 12
86
87 typedef RF_uint8 RF_DagNodeFlags_t;
88
89 struct RF_DagNode_s {
90 RF_NodeStatus_t status; /* current status of this node */
91 int (*doFunc) (RF_DagNode_t *); /* normal function */
92 int (*undoFunc) (RF_DagNode_t *); /* func to remove effect of
93 * doFunc */
94 int (*wakeFunc) (RF_DagNode_t *, int status); /* func called when the
95 * node completes an I/O */
96 int numParams; /* number of parameters required by *funcPtr */
97 int numResults; /* number of results produced by *funcPtr */
98 int numAntecedents; /* number of antecedents */
99 int numAntDone; /* number of antecedents which have finished */
100 int numSuccedents; /* number of succedents */
101 int numSuccFired; /* incremented when a succedent is fired
102 * during forward execution */
103 int numSuccDone; /* incremented when a succedent finishes
104 * during rollBackward */
105 int commitNode; /* boolean flag - if true, this is a commit
106 * node */
107 RF_DagNode_t **succedents; /* succedents, array size
108 * numSuccedents */
109 RF_DagNode_t **antecedents; /* antecedents, array size
110 * numAntecedents */
111 RF_AntecedentType_t antType[RF_MAX_ANTECEDENTS]; /* type of each
112 * antecedent */
113 void **results; /* array of results produced by *funcPtr */
114 RF_DagParam_t *params; /* array of parameters required by *funcPtr */
115 RF_PropHeader_t **propList; /* propagation list, size
116 * numSuccedents */
117 RF_DagHeader_t *dagHdr; /* ptr to head of dag containing this node */
118 void *dagFuncData; /* dag execution func uses this for whatever
119 * it wants */
120 RF_DagNode_t *next;
121 int nodeNum; /* used by PrintDAG for debug only */
122 int visited; /* used to avoid re-visiting nodes on DAG
123 * walks */
124 /* ANY CODE THAT USES THIS FIELD MUST MAINTAIN THE PROPERTY THAT AFTER
125 * IT FINISHES, ALL VISITED FLAGS IN THE DAG ARE IDENTICAL */
126 char *name; /* debug only */
127 RF_DagNodeFlags_t flags;/* see below */
128 RF_DagNode_t *dag_ptrs[RF_DAG_PTRCACHESIZE]; /* cache for performance */
129 RF_DagParam_t dag_params[RF_DAG_PARAMCACHESIZE]; /* cache for performance */
130 };
131 /*
132 * Bit values for flags field of RF_DagNode_t
133 */
134 #define RF_DAGNODE_FLAG_NONE 0x00
135 #define RF_DAGNODE_FLAG_YIELD 0x01 /* in the kernel, yield the processor
136 * before firing this node */
137
138 /* enable - DAG ready for normal execution, no errors encountered
139 * rollForward - DAG encountered an error after commit point, rolling forward
140 * rollBackward - DAG encountered an error prior to commit point, rolling backward
141 */
142 typedef enum RF_DagStatus_e {
143 rf_enable,
144 rf_rollForward,
145 rf_rollBackward
146 } RF_DagStatus_t;
147 #define RF_MAX_HDR_SUCC 1
148
149 struct RF_DagHeader_s {
150 RF_DagStatus_t status; /* status of this DAG */
151 int numSuccedents; /* DAG may be a tree, i.e. may have > 1 root */
152 int numCommitNodes; /* number of commit nodes in graph */
153 int numCommits; /* number of commit nodes which have been
154 * fired */
155 RF_DagNode_t *succedents[RF_MAX_HDR_SUCC]; /* array of succedents,
156 * size numSuccedents */
157 RF_DagHeader_t *next; /* ptr to allow a list of dags */
158 RF_AllocListElem_t *allocList; /* ptr to list of ptrs to be freed
159 * prior to freeing DAG */
160 RF_AccessStripeMapHeader_t *asmList; /* list of access stripe maps
161 * to be freed */
162 int nodeNum; /* used by PrintDAG for debug only */
163 int numNodesCompleted;
164 #if RF_ACC_TRACE > 0
165 RF_AccTraceEntry_t *tracerec; /* perf mon only */
166 #endif
167 void (*cbFunc) (void *); /* function to call when the dag
168 * completes */
169 void *cbArg; /* argument for cbFunc */
170 char *creator; /* name of function used to create this dag */
171
172 RF_Raid_t *raidPtr; /* the descriptor for the RAID device this DAG
173 * is for */
174 void *bp; /* the bp for this I/O passed down from the
175 * file system. ignored outside kernel */
176 };
177
178 struct RF_DagList_s {
179 /* common info for a list of dags which will be fired sequentially */
180 int numDags; /* number of dags in the list */
181 int numDagsFired; /* number of dags in list which have initiated
182 * execution */
183 int numDagsDone; /* number of dags in list which have completed
184 * execution */
185 RF_DagHeader_t *dags; /* list of dags */
186 RF_RaidAccessDesc_t *desc; /* ptr to descriptor for this access */
187 RF_AccTraceEntry_t tracerec; /* perf mon info for dags (not user
188 * info) */
189 struct RF_DagList_s *next; /* next DagList, if any */
190 };
191
192 /* convience macro for declaring a create dag function */
193
194 #define RF_CREATE_DAG_FUNC_DECL(_name_) \
195 void _name_ ( \
196 RF_Raid_t *raidPtr, \
197 RF_AccessStripeMap_t *asmap, \
198 RF_DagHeader_t *dag_h, \
199 void *bp, \
200 RF_RaidAccessFlags_t flags, \
201 RF_AllocListElem_t *allocList)
202
203 #endif /* !_RF__RF_DAG_H_ */
204