Home My Page Projects Code Snippets Project Openings diderot
Summary Activity Tracker Tasks SCM

SCM Repository

[diderot] Annotation of /branches/lamont/src/compiler/IL/ssa-sig.sml
ViewVC logotype

Annotation of /branches/lamont/src/compiler/IL/ssa-sig.sml

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2298 - (view) (download)

1 : jhr 1232 (* ssa-sig.sml
2 :     *
3 :     * COPYRIGHT (c) 2011 The Diderot Project (http://diderot-language.cs.uchicago.edu)
4 :     * All rights reserved.
5 :     *
6 :     * The SSA signature is the signature of the HighIL, MidIL, and LowIL modules, which implement
7 :     * the core intermediate languages of the Diderot compiler. These ILs have the same program
8 :     * and control-flow structure, but differ in their types and operators.
9 :     *
10 :     * Some properties:
11 :     *
12 :     * 1) The exit of the globalInit CFG has kind RETURN and the scope of the live variables
13 :     * is the whole program.
14 :     *
15 :     * 2) The scope of the parameters of a strand is the stateInit CFG and the methods of the
16 :     * strand.
17 :     *
18 :     * 3) Each strand has a list of strand-state variables (the "state" field). These variables
19 :     * are not defined or used in the code, but serve as the "master template" for the
20 :     * strand's state.
21 :     *
22 :     * 4) The exit of the stateInit CFG in a strand has kind SINIT and the number of live
23 :     * variables should be the same as the number of variables in the strand's state-variable
24 :     * list.
25 :     *
26 :     * 5) Each method has a list of variables, called stateIn, which corresponds to the
27 :     * variables in the strand's state-variable list.
28 :     *
29 :     * 6) The exit node(s) of the update method should have kind ACTIVE, STABILIZE, or DIE.
30 :     * The live variables at a ACTIVE or STABILIZE exit correspond to the variables in
31 :     * the strand's state-variable list. (Note that this property is modified after the
32 :     * variable-analysis phase).
33 :     *)
34 :    
35 :     signature SSA =
36 :     sig
37 :    
38 :     val ilName : string
39 :    
40 :     structure Ty : SSA_TYPES
41 :     structure Op : OPERATORS where type ty = Ty.ty
42 :    
43 : jhr 1640 (***** strand state variables *****)
44 :    
45 :     datatype state_var = SV of {
46 :     id : Stamp.stamp, (* variable's unique ID *)
47 :     name : string, (* variable's name *)
48 :     ty : Ty.ty, (* variable's type *)
49 :     output : bool, (* true for output variables *)
50 :     props : PropList.holder
51 :     }
52 :    
53 : jhr 1232 (***** CFG *****)
54 :    
55 :     datatype cfg = CFG of {
56 :     entry : node, (* the entry node of a graph; not necessarily an ENTRY node *)
57 :     exit : node (* the exit node of a graph; not necessarily an EXIT node. *)
58 :     }
59 :    
60 :     and node = ND of {
61 :     id : Stamp.stamp,
62 :     props : PropList.holder,
63 :     kind : node_kind
64 :     }
65 :    
66 :     and node_kind
67 :     = NULL
68 :     | ENTRY of {
69 :     succ : node ref
70 :     }
71 :     | JOIN of {
72 :     preds : node list ref,
73 :     phis : phi list ref,
74 :     succ : node ref
75 :     }
76 :     | COND of {
77 :     pred : node ref,
78 :     cond : var,
79 :     trueBranch : node ref,
80 :     falseBranch : node ref
81 :     }
82 : lamonts 2083 | FOREACH of {
83 : jhr 2298 pred : node ref,
84 :     cond : var,
85 :     phis : phi list ref,
86 :     stmBranch : node ref,
87 :     varStrandName : string ref,
88 :     shouldReplace : bool ref,
89 :     stmBranchDone : bool ref,
90 :     succ : node ref
91 :     }
92 : jhr 1232 | COM of { (* comment *)
93 :     pred : node ref,
94 :     text : string list,
95 :     succ : node ref
96 :     }
97 :     | ASSIGN of { (* assignment *)
98 :     pred : node ref,
99 :     stm : assign,
100 :     succ : node ref
101 :     }
102 : jhr 1640 | MASSIGN of { (* multi-assignment *)
103 :     pred : node ref,
104 :     stm : massign,
105 :     succ : node ref
106 :     }
107 : jhr 1232 | NEW of { (* create new strand instance *)
108 :     pred : node ref,
109 :     strand : Atom.atom,
110 :     args : var list,
111 :     succ : node ref
112 :     }
113 : jhr 1640 | SAVE of { (* save state variable *)
114 :     pred: node ref,
115 :     lhs : state_var,
116 :     rhs : var,
117 :     succ : node ref
118 :     }
119 : jhr 1232 | EXIT of { (* includes die and stabilize *)
120 :     pred : node ref,
121 :     kind : ExitKind.kind, (* kind of exit node *)
122 :     live : var list (* live variables *)
123 :     }
124 :    
125 : lamonts 2098 and strand_set
126 : lamonts 2203 = SS_All
127 : lamonts 2098 | SS_Stable
128 : lamonts 2203 | SS_Active
129 : lamonts 2098
130 : jhr 1232 and rhs
131 : jhr 1640 = STATE of state_var (* read strand state variable *)
132 :     | VAR of var
133 : jhr 1232 | LIT of Literal.literal
134 : lamonts 2083 | SELECTOR of var * Atom.atom
135 : lamonts 2101 | STRAND_SET of strand_set list
136 : jhr 1232 | OP of Op.rator * var list
137 : jhr 1922 | APPLY of MathFuns.name * var list (* basis function application *)
138 : jhr 1232 | CONS of Ty.ty * var list (* tensor/sequence-value construction *)
139 :    
140 :     and var = V of {
141 :     name : string, (* name *)
142 :     id : Stamp.stamp, (* unique ID *)
143 :     ty : Ty.ty, (* type *)
144 :     bind : var_bind ref, (* binding *)
145 :     useCnt : int ref, (* count of uses *)
146 :     props : PropList.holder
147 :     }
148 :    
149 :     and var_bind
150 :     = VB_NONE
151 :     | VB_RHS of rhs (* defined by an assignment (includes globals and state variables) *)
152 : jhr 1640 | VB_MULTIOP of int * Op.rator * var list
153 :     (* n'th result of operator in multi-assignment *)
154 : jhr 1232 | VB_PHI of var list (* defined by a phi node *)
155 :     | VB_PARAM (* parameter to a strand *)
156 :    
157 :     withtype assign = (var * rhs)
158 : jhr 1640 and massign = (var list * Op.rator * var list)
159 : jhr 1232 and phi = (var * var list)
160 :    
161 : jhr 1640 datatype assignment = ASSGN of assign | MASSGN of massign
162 : jhr 1232
163 : jhr 1640
164 : jhr 1232 (***** Program representation *****)
165 :    
166 :     datatype program = Program of {
167 : jhr 1640 props : StrandUtil.program_prop list,
168 : jhr 1232 globalInit : cfg,
169 : jhr 2298 globalBlock : cfg,
170 : jhr 1232 initially : initially,
171 :     strands : strand list
172 :     }
173 :    
174 :     and initially = Initially of {
175 :     isArray : bool, (* true for initially array, false for collection *)
176 :     rangeInit : cfg, (* code to compute bounds of iteration *)
177 :     iters : (var * var * var) list, (* "for" i = min .. max *)
178 :     create : (cfg * Atom.atom * var list)
179 :     }
180 :    
181 :     and strand = Strand of {
182 :     name : Atom.atom,
183 :     params : var list,
184 : jhr 1640 state : state_var list,
185 : jhr 1232 stateInit : cfg,
186 :     methods : method list
187 :     }
188 :    
189 :     and method = Method of {
190 : jhr 1640 name : StrandUtil.method_name,
191 : jhr 1232 body : cfg (* method body *)
192 :     }
193 :    
194 : jhr 1640 (* operations on strand-state variables *)
195 :     structure StateVar : sig
196 :     val new : bool * string * Ty.ty -> state_var
197 :     val name : state_var -> string
198 :     val ty : state_var -> Ty.ty
199 :     val isOutput : state_var -> bool
200 :     val same : state_var * state_var -> bool
201 :     val compare : state_var * state_var -> order
202 :     val hash : state_var -> word
203 :     val toString : state_var -> string
204 :     (* properties *)
205 :     val newProp : (state_var -> 'a) -> {
206 :     getFn : state_var -> 'a,
207 :     peekFn : state_var -> 'a option,
208 :     setFn : state_var * 'a -> unit,
209 :     clrFn : state_var -> unit
210 :     }
211 :     val newFlag : unit -> {
212 :     getFn : state_var -> bool,
213 :     setFn : state_var * bool -> unit
214 :     }
215 :     (* collections *)
216 :     structure Map : ORD_MAP where type Key.ord_key = state_var
217 :     structure Set : ORD_SET where type Key.ord_key = state_var
218 :     structure Tbl : MONO_HASH_TABLE where type Key.hash_key = state_var
219 :     end
220 :    
221 : jhr 1232 (* operations on CFGs *)
222 :     structure CFG : sig
223 :     (* the empty CFG *)
224 :     val empty : cfg
225 :     (* is a CFG empty? *)
226 :     val isEmpty : cfg -> bool
227 :     (* create a basic block from a list of assignments *)
228 : jhr 1640 val mkBlock : assignment list -> cfg
229 : jhr 1232 (* entry/exit nodes of a CFG *)
230 :     val entry : cfg -> node
231 :     val exit : cfg -> node
232 :     (* return the list of variables that are live at exit from a CFG *)
233 :     val liveAtExit : cfg -> var list
234 :     (* DFS sorting of the graph rooted at the entry to a statement; the resulting list will
235 :     * be in preorder with parents before children.
236 :     *)
237 :     val sort : cfg -> node list
238 :     (* apply a function to all of the nodes in the graph rooted at the entry to the statement *)
239 :     val apply : (node -> unit) -> cfg -> unit
240 :     (*
241 :     (* rewrite a CFG by applying a partial function to the nodes in the graph. If NONE is returned,
242 :     * then no change to the node, if SOME(cfg) is returned, then the node is replaced by the
243 :     * subgraph, which may be empty. This function returns true if any nodes were rewritten.
244 :     *)
245 :     val rewrite : (node -> cfg option) -> cfg -> bool
246 :     *)
247 :     (* delete a simple node from a CFG *)
248 :     val deleteNode : node -> unit
249 :     (* replace a simple node in a cfg with a different simple node *)
250 :     val replaceNode : (node * node) -> unit
251 :     (* replace a simple node in a cfg with a subgraph *)
252 :     val replaceNodeWithCFG : (node * cfg) -> unit
253 :     (* concatenate two CFGs *)
254 :     val concat : cfg * cfg -> cfg
255 : jhr 1640 (* prepend a node to a CFG *)
256 :     val prependNode : node * cfg -> cfg
257 : jhr 1232 (* append a node to a CFG *)
258 :     val appendNode : cfg * node -> cfg
259 :     (* update the exit of a CFG by modifying the live variable list *)
260 :     val updateExit : cfg * (var list -> var list) -> cfg
261 :     end
262 :    
263 :     (* operations on CFG nodes *)
264 :     structure Node : sig
265 :     val id : node -> Stamp.stamp
266 :     val kind : node -> node_kind
267 :     val same : node * node -> bool
268 :     val compare : node * node -> order
269 :     val hash : node -> word
270 :     val toString : node -> string
271 :     val isNULL : node -> bool
272 :     (* variable defs and uses; may include duplicates *)
273 :     val uses : node -> var list
274 :     val defs : node -> var list
275 : jhr 1301 (* dummy node with NULL kind *)
276 : jhr 1232 val dummy : node
277 :     (* CFG edges *)
278 :     val hasPred : node -> bool
279 :     val preds : node -> node list
280 :     val setPred : node * node -> unit
281 :     val hasSucc : node -> bool
282 :     val succs : node -> node list
283 :     val setSucc : node * node -> unit
284 : jhr 2298 val setStmBranch : node * node -> unit (* set statement branch succesor for FOREACH node *)
285 : jhr 1232 val setTrueBranch : node * node -> unit (* set trueBranch successor for COND node *)
286 :     val setFalseBranch : node * node -> unit (* set falseBranch successor for COND node *)
287 :     val addEdge : node * node -> unit
288 :     (* replace the edge src-->oldDst by the edge src-->dst *)
289 :     val replaceInEdge : {src : node, oldDst : node, dst : node} -> unit
290 :     (* replace the edge oldSrc-->dst by the edge src-->dst *)
291 :     val replaceOutEdge : {oldSrc : node, src : node, dst : node} -> unit
292 :     (* constructors *)
293 :     val mkENTRY : unit -> node
294 :     val mkJOIN : (var * var list) list -> node
295 :     val mkCOND : {cond : var, trueBranch : node, falseBranch : node} -> node
296 : jhr 2298 val mkFOREACH : {cond: var, stmBranch: node, sName : string, phis:(var * var list) list} -> node
297 : jhr 1232 val mkCOM : string list -> node
298 :     val mkASSIGN : assign -> node
299 : jhr 1640 val mkMASSIGN : massign -> node
300 : jhr 1232 val mkNEW : {strand : Atom.atom, args : var list} -> node
301 : jhr 1640 val mkSAVE : (state_var * var) -> node
302 : jhr 1232 val mkEXIT : ExitKind.kind * var list -> node
303 :     val mkFRAGMENT : var list -> node
304 : jhr 1640 val mkSINIT : unit -> node
305 : jhr 1232 val mkRETURN : var list -> node
306 : jhr 1640 val mkACTIVE : unit -> node
307 :     val mkSTABILIZE : unit -> node
308 : jhr 1232 val mkDIE : unit -> node
309 :     (* properties *)
310 :     val newProp : (node -> 'a) -> {
311 :     getFn : node -> 'a,
312 :     peekFn : node -> 'a option,
313 :     setFn : node * 'a -> unit,
314 :     clrFn : node -> unit
315 :     }
316 :     val newFlag : unit -> {
317 :     getFn : node -> bool,
318 :     setFn : node * bool -> unit
319 :     }
320 :     end
321 :    
322 :     (* operations on variables *)
323 :     structure Var : sig
324 :     val new : string * Ty.ty -> var
325 :     val copy : var -> var
326 :     val name : var -> string
327 :     val ty : var -> Ty.ty
328 :     val binding : var -> var_bind
329 :     val setBinding : var * var_bind -> unit
330 :     val useCount : var -> int
331 :     val same : var * var -> bool
332 :     val compare : var * var -> order
333 :     val hash : var -> word
334 :     val toString : var -> string
335 :     (* properties *)
336 :     val newProp : (var -> 'a) -> {
337 :     getFn : var -> 'a,
338 :     peekFn : var -> 'a option,
339 :     setFn : var * 'a -> unit,
340 :     clrFn : var -> unit
341 :     }
342 :     val newFlag : unit -> {
343 :     getFn : var -> bool,
344 :     setFn : var * bool -> unit
345 :     }
346 :     (* collections *)
347 :     structure Map : ORD_MAP where type Key.ord_key = var
348 :     structure Set : ORD_SET where type Key.ord_key = var
349 :     structure Tbl : MONO_HASH_TABLE where type Key.hash_key = var
350 :     end
351 :    
352 :     (* operations on RHS expressions *)
353 :     structure RHS : sig
354 : jhr 2298 (* val reductionSame : reduction * reduction -> bool *)
355 :     (* FIXME: why are these strand_set functions defined here? *)
356 :     val strandSetSame : strand_set list * strand_set list -> bool
357 :     (* val reductionToString: reduction -> string *)
358 :     val toStringSets : strand_set list -> string list
359 : jhr 1232 val toString : rhs -> string
360 :     val vars : rhs -> var list
361 :     val map : (var -> var) -> rhs -> rhs
362 :     val app : (var -> unit) -> rhs -> unit
363 :     end
364 :    
365 :     (* return a string representation of a variable binding *)
366 :     val vbToString : var_bind -> string
367 :    
368 :     (* return a string representation of a PHI node *)
369 :     val phiToString : phi -> string
370 :    
371 :     (* return a string representation of an assignment *)
372 :     val assignToString : assign -> string
373 : jhr 1640 val massignToString : massign -> string
374 : jhr 1232
375 :     end

root@smlnj-gforge.cs.uchicago.edu
ViewVC Help
Powered by ViewVC 1.0.0