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 1922 - (view) (download)
Original Path: branches/vis12/src/compiler/IL/ssa-sig.sml

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 :     | COM of { (* comment *)
83 :     pred : node ref,
84 :     text : string list,
85 :     succ : node ref
86 :     }
87 :     | ASSIGN of { (* assignment *)
88 :     pred : node ref,
89 :     stm : assign,
90 :     succ : node ref
91 :     }
92 : jhr 1640 | MASSIGN of { (* multi-assignment *)
93 :     pred : node ref,
94 :     stm : massign,
95 :     succ : node ref
96 :     }
97 : jhr 1232 | NEW of { (* create new strand instance *)
98 :     pred : node ref,
99 :     strand : Atom.atom,
100 :     args : var list,
101 :     succ : node ref
102 :     }
103 : jhr 1640 | SAVE of { (* save state variable *)
104 :     pred: node ref,
105 :     lhs : state_var,
106 :     rhs : var,
107 :     succ : node ref
108 :     }
109 : jhr 1232 | EXIT of { (* includes die and stabilize *)
110 :     pred : node ref,
111 :     kind : ExitKind.kind, (* kind of exit node *)
112 :     live : var list (* live variables *)
113 :     }
114 :    
115 :     and rhs
116 : jhr 1640 = STATE of state_var (* read strand state variable *)
117 :     | VAR of var
118 : jhr 1232 | LIT of Literal.literal
119 :     | OP of Op.rator * var list
120 : jhr 1922 | APPLY of MathFuns.name * var list (* basis function application *)
121 : jhr 1232 | CONS of Ty.ty * var list (* tensor/sequence-value construction *)
122 :    
123 :     and var = V of {
124 :     name : string, (* name *)
125 :     id : Stamp.stamp, (* unique ID *)
126 :     ty : Ty.ty, (* type *)
127 :     bind : var_bind ref, (* binding *)
128 :     useCnt : int ref, (* count of uses *)
129 :     props : PropList.holder
130 :     }
131 :    
132 :     and var_bind
133 :     = VB_NONE
134 :     | VB_RHS of rhs (* defined by an assignment (includes globals and state variables) *)
135 : jhr 1640 | VB_MULTIOP of int * Op.rator * var list
136 :     (* n'th result of operator in multi-assignment *)
137 : jhr 1232 | VB_PHI of var list (* defined by a phi node *)
138 :     | VB_PARAM (* parameter to a strand *)
139 :    
140 :     withtype assign = (var * rhs)
141 : jhr 1640 and massign = (var list * Op.rator * var list)
142 : jhr 1232 and phi = (var * var list)
143 :    
144 : jhr 1640 datatype assignment = ASSGN of assign | MASSGN of massign
145 : jhr 1232
146 : jhr 1640
147 : jhr 1232 (***** Program representation *****)
148 :    
149 :     datatype program = Program of {
150 : jhr 1640 props : StrandUtil.program_prop list,
151 : jhr 1232 globalInit : cfg,
152 :     initially : initially,
153 :     strands : strand list
154 :     }
155 :    
156 :     and initially = Initially of {
157 :     isArray : bool, (* true for initially array, false for collection *)
158 :     rangeInit : cfg, (* code to compute bounds of iteration *)
159 :     iters : (var * var * var) list, (* "for" i = min .. max *)
160 :     create : (cfg * Atom.atom * var list)
161 :     }
162 :    
163 :     and strand = Strand of {
164 :     name : Atom.atom,
165 :     params : var list,
166 : jhr 1640 state : state_var list,
167 : jhr 1232 stateInit : cfg,
168 :     methods : method list
169 :     }
170 :    
171 :     and method = Method of {
172 : jhr 1640 name : StrandUtil.method_name,
173 : jhr 1232 body : cfg (* method body *)
174 :     }
175 :    
176 : jhr 1640 (* operations on strand-state variables *)
177 :     structure StateVar : sig
178 :     val new : bool * string * Ty.ty -> state_var
179 :     val name : state_var -> string
180 :     val ty : state_var -> Ty.ty
181 :     val isOutput : state_var -> bool
182 :     val same : state_var * state_var -> bool
183 :     val compare : state_var * state_var -> order
184 :     val hash : state_var -> word
185 :     val toString : state_var -> string
186 :     (* properties *)
187 :     val newProp : (state_var -> 'a) -> {
188 :     getFn : state_var -> 'a,
189 :     peekFn : state_var -> 'a option,
190 :     setFn : state_var * 'a -> unit,
191 :     clrFn : state_var -> unit
192 :     }
193 :     val newFlag : unit -> {
194 :     getFn : state_var -> bool,
195 :     setFn : state_var * bool -> unit
196 :     }
197 :     (* collections *)
198 :     structure Map : ORD_MAP where type Key.ord_key = state_var
199 :     structure Set : ORD_SET where type Key.ord_key = state_var
200 :     structure Tbl : MONO_HASH_TABLE where type Key.hash_key = state_var
201 :     end
202 :    
203 : jhr 1232 (* operations on CFGs *)
204 :     structure CFG : sig
205 :     (* the empty CFG *)
206 :     val empty : cfg
207 :     (* is a CFG empty? *)
208 :     val isEmpty : cfg -> bool
209 :     (* create a basic block from a list of assignments *)
210 : jhr 1640 val mkBlock : assignment list -> cfg
211 : jhr 1232 (* entry/exit nodes of a CFG *)
212 :     val entry : cfg -> node
213 :     val exit : cfg -> node
214 :     (* return the list of variables that are live at exit from a CFG *)
215 :     val liveAtExit : cfg -> var list
216 :     (* DFS sorting of the graph rooted at the entry to a statement; the resulting list will
217 :     * be in preorder with parents before children.
218 :     *)
219 :     val sort : cfg -> node list
220 :     (* apply a function to all of the nodes in the graph rooted at the entry to the statement *)
221 :     val apply : (node -> unit) -> cfg -> unit
222 :     (*
223 :     (* rewrite a CFG by applying a partial function to the nodes in the graph. If NONE is returned,
224 :     * then no change to the node, if SOME(cfg) is returned, then the node is replaced by the
225 :     * subgraph, which may be empty. This function returns true if any nodes were rewritten.
226 :     *)
227 :     val rewrite : (node -> cfg option) -> cfg -> bool
228 :     *)
229 :     (* delete a simple node from a CFG *)
230 :     val deleteNode : node -> unit
231 :     (* replace a simple node in a cfg with a different simple node *)
232 :     val replaceNode : (node * node) -> unit
233 :     (* replace a simple node in a cfg with a subgraph *)
234 :     val replaceNodeWithCFG : (node * cfg) -> unit
235 :     (* concatenate two CFGs *)
236 :     val concat : cfg * cfg -> cfg
237 : jhr 1640 (* prepend a node to a CFG *)
238 :     val prependNode : node * cfg -> cfg
239 : jhr 1232 (* append a node to a CFG *)
240 :     val appendNode : cfg * node -> cfg
241 :     (* update the exit of a CFG by modifying the live variable list *)
242 :     val updateExit : cfg * (var list -> var list) -> cfg
243 :     end
244 :    
245 :     (* operations on CFG nodes *)
246 :     structure Node : sig
247 :     val id : node -> Stamp.stamp
248 :     val kind : node -> node_kind
249 :     val same : node * node -> bool
250 :     val compare : node * node -> order
251 :     val hash : node -> word
252 :     val toString : node -> string
253 :     val isNULL : node -> bool
254 :     (* variable defs and uses; may include duplicates *)
255 :     val uses : node -> var list
256 :     val defs : node -> var list
257 : jhr 1301 (* dummy node with NULL kind *)
258 : jhr 1232 val dummy : node
259 :     (* CFG edges *)
260 :     val hasPred : node -> bool
261 :     val preds : node -> node list
262 :     val setPred : node * node -> unit
263 :     val hasSucc : node -> bool
264 :     val succs : node -> node list
265 :     val setSucc : node * node -> unit
266 :     val setTrueBranch : node * node -> unit (* set trueBranch successor for COND node *)
267 :     val setFalseBranch : node * node -> unit (* set falseBranch successor for COND node *)
268 :     val addEdge : node * node -> unit
269 :     (* replace the edge src-->oldDst by the edge src-->dst *)
270 :     val replaceInEdge : {src : node, oldDst : node, dst : node} -> unit
271 :     (* replace the edge oldSrc-->dst by the edge src-->dst *)
272 :     val replaceOutEdge : {oldSrc : node, src : node, dst : node} -> unit
273 :     (* constructors *)
274 :     val mkENTRY : unit -> node
275 :     val mkJOIN : (var * var list) list -> node
276 :     val mkCOND : {cond : var, trueBranch : node, falseBranch : node} -> node
277 :     val mkCOM : string list -> node
278 :     val mkASSIGN : assign -> node
279 : jhr 1640 val mkMASSIGN : massign -> node
280 : jhr 1232 val mkNEW : {strand : Atom.atom, args : var list} -> node
281 : jhr 1640 val mkSAVE : (state_var * var) -> node
282 : jhr 1232 val mkEXIT : ExitKind.kind * var list -> node
283 :     val mkFRAGMENT : var list -> node
284 : jhr 1640 val mkSINIT : unit -> node
285 : jhr 1232 val mkRETURN : var list -> node
286 : jhr 1640 val mkACTIVE : unit -> node
287 :     val mkSTABILIZE : unit -> node
288 : jhr 1232 val mkDIE : unit -> node
289 :     (* properties *)
290 :     val newProp : (node -> 'a) -> {
291 :     getFn : node -> 'a,
292 :     peekFn : node -> 'a option,
293 :     setFn : node * 'a -> unit,
294 :     clrFn : node -> unit
295 :     }
296 :     val newFlag : unit -> {
297 :     getFn : node -> bool,
298 :     setFn : node * bool -> unit
299 :     }
300 :     end
301 :    
302 :     (* operations on variables *)
303 :     structure Var : sig
304 :     val new : string * Ty.ty -> var
305 :     val copy : var -> var
306 :     val name : var -> string
307 :     val ty : var -> Ty.ty
308 :     val binding : var -> var_bind
309 :     val setBinding : var * var_bind -> unit
310 :     val useCount : var -> int
311 :     val same : var * var -> bool
312 :     val compare : var * var -> order
313 :     val hash : var -> word
314 :     val toString : var -> string
315 :     (* properties *)
316 :     val newProp : (var -> 'a) -> {
317 :     getFn : var -> 'a,
318 :     peekFn : var -> 'a option,
319 :     setFn : var * 'a -> unit,
320 :     clrFn : var -> unit
321 :     }
322 :     val newFlag : unit -> {
323 :     getFn : var -> bool,
324 :     setFn : var * bool -> unit
325 :     }
326 :     (* collections *)
327 :     structure Map : ORD_MAP where type Key.ord_key = var
328 :     structure Set : ORD_SET where type Key.ord_key = var
329 :     structure Tbl : MONO_HASH_TABLE where type Key.hash_key = var
330 :     end
331 :    
332 :     (* operations on RHS expressions *)
333 :     structure RHS : sig
334 :     val toString : rhs -> string
335 :     val vars : rhs -> var list
336 :     val map : (var -> var) -> rhs -> rhs
337 :     val app : (var -> unit) -> rhs -> unit
338 :     end
339 :    
340 :     (* return a string representation of a variable binding *)
341 :     val vbToString : var_bind -> string
342 :    
343 :     (* return a string representation of a PHI node *)
344 :     val phiToString : phi -> string
345 :    
346 :     (* return a string representation of an assignment *)
347 :     val assignToString : assign -> string
348 : jhr 1640 val massignToString : massign -> string
349 : jhr 1232
350 :     end

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