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

SCM Repository

[diderot] Annotation of /branches/vis15/src/compiler/cfg-ir/check-ir-fn.sml
ViewVC logotype

Annotation of /branches/vis15/src/compiler/cfg-ir/check-ir-fn.sml

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3475 - (view) (download)

1 : jhr 3475 (* check-ir-fn.sml
2 : jhr 3470 *
3 :     * This code is part of the Diderot Project (http://diderot-language.cs.uchicago.edu)
4 :     *
5 :     * COPYRIGHT (c) 2015 The University of Chicago
6 :     * All rights reserved.
7 :     *
8 : jhr 3475 * Correctness checker for SSA-based IRs.
9 : jhr 3470 *
10 :     * TODO:
11 :     * check that the state variables and method stateOut variables are all defined.
12 :     *)
13 :    
14 :     signature OPERATOR_TY =
15 :     sig
16 :     type rator
17 :     type ty
18 :    
19 :     (* returns the signature of an operator as (rng, dom). *)
20 :     val sigOf : rator -> ty * ty list
21 :    
22 :     (* return the type of a CONS, where the first argument is the annotated type
23 :     * and the second argument is the list of argument types. Returns false if
24 :     * there is a type error.
25 :     *)
26 :     val typeOfCons : ty * ty list -> bool
27 :    
28 :     end
29 :    
30 : jhr 3475 functor CheckIRFn (
31 : jhr 3470
32 : jhr 3475 structure IR : SSA
33 : jhr 3470 structure OpTy : OPERATOR_TY
34 : jhr 3475 where type rator = IR.Op.rator
35 :     where type ty = IR.Ty.ty
36 : jhr 3470
37 :     ) : sig
38 :    
39 :     (* check the program for type errors, etc. The first argument will be used to
40 :     * identify the phase that the check follows and the return result will be true
41 :     * if any errors were detected.
42 :     *)
43 : jhr 3475 val check : string * IR.program -> bool
44 : jhr 3470
45 :     end = struct
46 :    
47 : jhr 3475 structure IR = IR
48 :     structure Ty = IR.Ty
49 :     structure V = IR.Var
50 : jhr 3470 structure VSet = V.Set
51 :    
52 :     (* forward analysis to determine the variables that are available in blocks *)
53 :     structure Avail = ForwardDFAFn (
54 :     struct
55 :    
56 : jhr 3475 structure IR = IR
57 : jhr 3470 type t = VSet.set
58 :    
59 :     val bottom = VSet.empty
60 :    
61 :     fun join inputs = List.foldl VSet.union bottom inputs
62 :    
63 : jhr 3475 fun transfer (input, nd as IR.ND{kind, ...}) = (case kind
64 :     of IR.JOIN{phis, ...} => let
65 : jhr 3470 (* add the lhs of the phi node. We do not remove the rhs variables, since
66 :     * after value numbering, they may have further uses.
67 :     *)
68 :     fun doPhi ((y, _), vs) = VSet.add(vs, y)
69 :     val output = List.foldl doPhi input (!phis)
70 :     in
71 :     output
72 :     end
73 : jhr 3475 | IR.ASSIGN{stm=(y, _), ...} => VSet.add(input, y)
74 :     | IR.MASSIGN{stm=(ys, _, _), ...} => VSet.addList(input, ys)
75 : jhr 3470 | _ => input
76 :     (* end case *))
77 :    
78 :     val same = VSet.equal
79 :    
80 :     fun toString vs = let
81 : jhr 3475 fun f (v, []) = [IR.Var.toString v, "}"]
82 :     | f (v, l) = IR.Var.toString v :: "," :: l
83 : jhr 3470 in
84 :     if VSet.isEmpty vs then "{}" else String.concat("{" :: VSet.foldl f [] vs)
85 :     end
86 :    
87 :     end)
88 :    
89 :     datatype token
90 : jhr 3475 = NL | S of string | A of Atom.atom | V of IR.var | VTYS of IR.var list
91 : jhr 3470 | TY of Ty.ty | TYS of Ty.ty list
92 : jhr 3475 | ND of IR.node
93 : jhr 3470
94 :     fun error errBuf toks = let
95 :     fun tok2str NL = "\n ** "
96 :     | tok2str (S s) = s
97 :     | tok2str (A s) = Atom.toString s
98 :     | tok2str (V x) = V.toString x
99 :     | tok2str (VTYS xs) = tok2str(TYS(List.map V.ty xs))
100 :     | tok2str (TY ty) = Ty.toString ty
101 :     | tok2str (TYS []) = "()"
102 :     | tok2str (TYS[ty]) = Ty.toString ty
103 :     | tok2str (TYS tys) = String.concat[
104 :     "(", String.concatWith " * " (List.map Ty.toString tys), ")"
105 :     ]
106 : jhr 3475 | tok2str (ND nd) = IR.Node.toString nd
107 : jhr 3470 in
108 :     errBuf := concat ("**** Error: " :: List.map tok2str toks)
109 :     :: !errBuf
110 :     end
111 :    
112 :     fun checkAssign errFn ((y, rhs), bvs) = let
113 :     (* check a variable use *)
114 :     fun checkVar x = if VSet.member(bvs, x)
115 :     then ()
116 :     else errFn [
117 :     S "variable ", V x, S " is not bound in", NL,
118 : jhr 3475 S(IR.assignToString(y, rhs))
119 : jhr 3470 ]
120 :     fun tyError (ty1, ty2) = errFn [
121 : jhr 3475 S "type mismatch in \"", S(IR.assignToString (y, rhs)), S "\"",
122 : jhr 3470 NL, S "lhs: ", TY ty1, NL, S "rhs: ", TY ty2
123 :     ]
124 :     fun checkTys (ty1, ty2) = if Ty.same(ty1, ty2)
125 :     then ()
126 :     else tyError (ty1, ty2)
127 :     in
128 :     (* check that y is not bound twice *)
129 :     if VSet.member(bvs, y)
130 :     then errFn [
131 :     S "variable ", V y, S " is bound twice in", NL,
132 : jhr 3475 S(IR.assignToString (y, rhs))
133 : jhr 3470 ]
134 :     else ();
135 :     case rhs
136 : jhr 3475 of IR.GLOBAL x => checkTys(V.ty y, IR.GlobalVar.ty x)
137 :     | IR.STATE x => checkTys(V.ty y, IR.StateVar.ty x)
138 :     | IR.VAR x => (
139 : jhr 3470 checkVar x;
140 :     checkTys (V.ty y, V.ty x))
141 : jhr 3475 | IR.LIT lit => let
142 : jhr 3470 val ty = (case lit
143 :     of Literal.Int _ => Ty.intTy
144 :     | Literal.Real _ => Ty.realTy
145 :     | Literal.String _ => Ty.StringTy
146 :     | Literal.Bool _ => Ty.BoolTy
147 :     (* end case *))
148 :     in
149 :     checkTys (V.ty y, ty)
150 :     end
151 : jhr 3475 | IR.OP(rator, xs) => let
152 : jhr 3470 val (resTy, argTys) = OpTy.sigOf rator
153 :     in
154 :     List.app checkVar xs;
155 :     checkTys (V.ty y, resTy);
156 :     if ListPair.allEq (fn (x, ty) => Ty.same(V.ty x, ty)) (xs, argTys)
157 :     then ()
158 :     else errFn [
159 : jhr 3475 S "argument type mismatch in \"", S(IR.assignToString (y, rhs)), S "\"",
160 : jhr 3470 NL, S "expected: ", TYS argTys,
161 :     NL, S "found: ", VTYS xs
162 :     ]
163 :     end
164 : jhr 3475 | IR.CONS(xs, ty) => (
165 : jhr 3470 List.app checkVar xs;
166 :     if OpTy.typeOfCons (ty, List.map V.ty xs)
167 :     then checkTys (V.ty y, ty)
168 : jhr 3475 else errFn [S "invalid ", S(IR.assignToString(y, rhs))])
169 :     | IR.SEQ(xs, ty) => (
170 : jhr 3470 List.app checkVar xs;
171 :     (* FIXME: check types of sequence elements *)())
172 : jhr 3475 | IR.EINAPP(ein, xs) => (
173 : jhr 3470 List.app checkVar xs;
174 :     (* FIXME: check ein *)())
175 :     (* end case *);
176 :     VSet.add(bvs, y)
177 :     end
178 :    
179 :     fun checkMAssign errFn (stm as (ys, rator, xs), bvs) = let
180 :     (* check that a lhs variable is not bound twice *)
181 :     fun checkBind y = if VSet.member(bvs, y)
182 :     then errFn [
183 :     S "variable ", V y, S " is bound twice in", NL,
184 : jhr 3475 S(IR.massignToString stm)
185 : jhr 3470 ]
186 :     else ()
187 :     (* check a variable use *)
188 :     fun checkVar x = if VSet.member(bvs, x)
189 :     then ()
190 :     else errFn [
191 :     S "variable ", V x, S " is not bound in", NL,
192 : jhr 3475 S(IR.massignToString stm)
193 : jhr 3470 ]
194 :     fun tyError (ty1, ty2) = errFn [
195 : jhr 3475 S "type mismatch in \"", S(IR.massignToString stm), S "\"",
196 : jhr 3470 NL, S "lhs: ", TY ty1, NL, S "rhs: ", TY ty2
197 :     ]
198 :     in
199 :     (* check that the lhs variables are not bound twice *)
200 :     List.app checkBind ys;
201 :     (* FIXME:
202 :     (* check the types *)
203 :     val (resTys, argTys) = OpTy.sigOf rator
204 :     in
205 :     List.app checkVar xs;
206 :     if ListPair.allEq (fn (y, ty) => Ty.same(V.ty y, ty)) (ys, resTys)
207 :     then ()
208 :     else tyError (V.ty y, resTy);
209 :     if ListPair.allEq (fn (x, ty) => Ty.same(V.ty x, ty)) (xs, argTys)
210 :     then ()
211 :     else errFn [
212 : jhr 3475 S "argument type mismatch in \"", S(IR.massignToString stm), S "\"",
213 : jhr 3470 NL, S "expected: ", TYS argTys,
214 :     NL, S "found: ", VTYS xs
215 :     ]
216 :     end
217 :     *)
218 :     VSet.addList(bvs, ys)
219 :     end
220 :    
221 :     fun checkPhi errFn (nd, bvs, mask) (y, xs) = let
222 :     val ty = V.ty y
223 :     fun chkTy x = if Ty.same(V.ty x, ty)
224 :     then ()
225 :     else errFn [
226 : jhr 3475 S "type mismatch in \"", S(IR.phiToString (y, xs)), S "\"", NL,
227 : jhr 3470 S "typeof(", V y, S "): ", TY ty, NL,
228 :     S "typeof(", V x, S "): ", TY(V.ty x)
229 :     ]
230 :     fun chkRHS ([], []) = ()
231 :     | chkRHS (true::ms, NONE::xs) = chkRHS (ms, xs)
232 :     | chkRHS (false::ms, (SOME x)::xs) = (chkTy x; chkRHS (ms, xs))
233 :     | chkRHS _ = errFn [S "phi/mask mismatch in ", ND nd]
234 :     in
235 :     (* check that y is not bound twice *)
236 :     if VSet.member(bvs, y)
237 :     then errFn [
238 :     S "variable ", V y, S " is bound twice in", NL,
239 : jhr 3475 S(IR.phiToString (y, xs))
240 : jhr 3470 ]
241 :     else ();
242 :     (* check that rhs vars have the correct type *)
243 :     chkRHS (mask, xs)
244 :     end
245 :    
246 : jhr 3475 fun check (phase, IR.Program{globals, props, inputInit, globalInit, initially, strands}) = let
247 : jhr 3470 val errBuf = ref []
248 :     val errFn = error errBuf
249 :     fun final () = (case !errBuf
250 :     of [] => false
251 :     | errs => (
252 : jhr 3475 Log.msg(concat["********** IR Errors detected after ", phase, " **********\n"]);
253 : jhr 3470 List.app (fn msg => Log.msg(msg ^ "\n")) (List.rev errs);
254 :     true)
255 :     (* end case *))
256 :     val checkPhi = checkPhi errFn
257 :     val checkAssign = checkAssign errFn
258 :     val checkMAssign = checkMAssign errFn
259 :     fun checkCFG (vs, cfg) = let
260 :     val bvs = VSet.fromList vs
261 :     (* compute the variables available on entry to each block *)
262 :     val nodes = Avail.analyse (bvs, cfg)
263 :     (* check the edges of a node. For each predecessor, the node should appear in the
264 :     * successor list and for each successor, the node should appear in the predecessor
265 :     * list.
266 :     *)
267 :     fun checkEdges nd = let
268 : jhr 3475 fun eqNd nd' = IR.Node.same(nd, nd')
269 :     fun chkPred src = if List.exists eqNd (IR.Node.succs src)
270 : jhr 3470 then ()
271 :     else errFn [
272 :     S "predecessor edge from ", ND nd, S " -> ", ND src,
273 :     S " not matched by successor edge"
274 :     ]
275 : jhr 3475 fun chkSucc dst = if List.exists eqNd (IR.Node.preds dst)
276 : jhr 3470 then ()
277 :     else errFn [
278 :     S "successor edge from ", ND nd, S " -> ", ND dst,
279 :     S " not matched by predecessor edge"
280 :     ]
281 :     in
282 : jhr 3475 List.app chkPred (IR.Node.preds nd);
283 :     List.app chkSucc (IR.Node.succs nd)
284 : jhr 3470 end
285 : jhr 3475 fun checkNd (nd as IR.ND{kind, ...}) = (case kind
286 :     of IR.NULL => errFn [S "unexpected ", ND nd]
287 :     | IR.JOIN{mask, phis, ...} =>
288 : jhr 3470 List.app
289 :     (checkPhi (nd, VSet.union(Avail.inValue nd, bvs), !mask))
290 :     (!phis)
291 : jhr 3475 | IR.COND{cond, ...} =>
292 : jhr 3470 if VSet.member(Avail.inValue nd, cond)
293 :     orelse VSet.member(bvs, cond)
294 :     then ()
295 :     else errFn [S "unbound variable ", V cond, S " in conditional"]
296 : jhr 3475 | IR.FOREACH{phis, mask, var, src, ...} => (
297 : jhr 3473 if VSet.member(Avail.inValue nd, src)
298 :     orelse VSet.member(bvs, src)
299 :     then ()
300 :     else errFn [S "unbound variable ", V src, S " in foreach"];
301 :     List.app
302 :     (checkPhi (nd, VSet.union(Avail.inValue nd, bvs), !mask))
303 :     (!phis))
304 : jhr 3475 | IR.ASSIGN{stm, ...} =>
305 : jhr 3470 ignore (checkAssign (stm, VSet.union(Avail.inValue nd, bvs)))
306 : jhr 3475 | IR.MASSIGN{stm, ...} =>
307 : jhr 3470 ignore (checkMAssign (stm, VSet.union(Avail.inValue nd, bvs)))
308 : jhr 3475 | IR.GASSIGN{lhs, rhs, ...} => let
309 : jhr 3470 val bvs = VSet.union(Avail.inValue nd, bvs)
310 :     in
311 :     if VSet.member(bvs, rhs)
312 :     then ()
313 :     else errFn [
314 :     S "variable ", V rhs, S " is not bound in global assignment ",
315 : jhr 3475 S(IR.GlobalVar.toString lhs)
316 : jhr 3470 ];
317 : jhr 3475 if Ty.same(IR.GlobalVar.ty lhs, V.ty rhs)
318 : jhr 3470 then ()
319 :     else errFn [
320 : jhr 3475 S "type mismatch in \"", S(IR.GlobalVar.toString lhs),
321 : jhr 3470 S " = ", S(V.toString rhs), S "\"",
322 : jhr 3475 NL, S "lhs: ", TY(IR.GlobalVar.ty lhs),
323 : jhr 3470 NL, S "rhs: ", TY(V.ty rhs)
324 :     ]
325 :     end
326 : jhr 3475 | IR.NEW{strand, args, ...} => let
327 : jhr 3470 val bvs = VSet.union(Avail.inValue nd, bvs)
328 :     (* check a variable use *)
329 :     fun checkVar x = if VSet.member(bvs, x)
330 :     then ()
331 :     else errFn [
332 :     S "variable ", V x, S " is not bound in new ",
333 :     S(Atom.toString strand)
334 :     ]
335 :     in
336 :     List.app checkVar args
337 :     end
338 : jhr 3475 | IR.SAVE{lhs, rhs, ...} => let
339 : jhr 3470 val bvs = VSet.union(Avail.inValue nd, bvs)
340 :     in
341 :     if VSet.member(bvs, rhs)
342 :     then ()
343 :     else errFn [
344 :     S "variable ", V rhs, S " is not bound in save ",
345 : jhr 3475 S(IR.StateVar.toString lhs)
346 : jhr 3470 ];
347 : jhr 3475 if Ty.same(IR.StateVar.ty lhs, V.ty rhs)
348 : jhr 3470 then ()
349 :     else errFn [
350 : jhr 3475 S "type mismatch in \"", S(IR.StateVar.toString lhs),
351 : jhr 3470 S " = ", S(V.toString rhs), S "\"",
352 : jhr 3475 NL, S "lhs: ", TY(IR.StateVar.ty lhs),
353 : jhr 3470 NL, S "rhs: ", TY(V.ty rhs)
354 :     ]
355 :     end
356 :     | _ => ()
357 :     (* end case *))
358 :     in
359 :     List.app checkEdges nodes;
360 :     List.app checkNd nodes;
361 :     (* cleanup *)
362 :     Avail.scrub nodes
363 :     end
364 :     (* check a strand definition *)
365 : jhr 3475 fun checkStrand (IR.Strand{name, params, state, stateInit, methods}) = let
366 : jhr 3470 val nStateVars = List.length state
367 :     val extraVars = params
368 : jhr 3475 fun checkMethod (IR.Method{name, body, ...}) = checkCFG (extraVars, body)
369 : jhr 3470 (*DEBUG*)handle ex => raise ex
370 :     in
371 :     checkCFG (extraVars, stateInit)
372 :     (*DEBUG*)handle ex => raise ex;
373 :     List.app checkMethod methods
374 :     end
375 :     (* handle exceptions *)
376 :     fun onExn exn =
377 :     errFn (S "uncaught exception: " :: S(exnMessage exn) ::
378 :     List.foldr (fn (s, msg) => NL :: S " raised at " :: S s :: msg)
379 :     [] (SMLofNJ.exnHistory exn))
380 :     in
381 :     (* check the input part *)
382 :     checkCFG ([], inputInit) handle ex => onExn ex;
383 :     (* check the global part *)
384 :     checkCFG ([], globalInit) handle ex => onExn ex;
385 :     (* FIXME: need to check initially *)
386 :     (* check the strands *)
387 :     (List.app checkStrand strands) handle ex => onExn ex;
388 :     (* check for errors *)
389 :     final()
390 :     end
391 :    
392 :     end

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