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

SCM Repository

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

Annotation of /trunk/src/compiler/IL/ssa-sig.sml

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3349 - (view) (download)

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

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