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 3754 - (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 3526 | IR.FOREACH{var, phis, ...} => let
74 :     (* add the lhs of the phi node. We do not remove the rhs variables, since
75 :     * after value numbering, they may have further uses.
76 :     *)
77 :     fun doPhi ((y, _), vs) = VSet.add(vs, y)
78 :     val output = List.foldl doPhi input (!phis)
79 :     in
80 :     VSet.add (output, var)
81 :     end
82 : jhr 3475 | IR.ASSIGN{stm=(y, _), ...} => VSet.add(input, y)
83 :     | IR.MASSIGN{stm=(ys, _, _), ...} => VSet.addList(input, ys)
84 : jhr 3470 | _ => input
85 :     (* end case *))
86 :    
87 :     val same = VSet.equal
88 :    
89 :     fun toString vs = let
90 : jhr 3475 fun f (v, []) = [IR.Var.toString v, "}"]
91 :     | f (v, l) = IR.Var.toString v :: "," :: l
92 : jhr 3470 in
93 :     if VSet.isEmpty vs then "{}" else String.concat("{" :: VSet.foldl f [] vs)
94 :     end
95 :    
96 :     end)
97 :    
98 :     datatype token
99 : jhr 3475 = NL | S of string | A of Atom.atom | V of IR.var | VTYS of IR.var list
100 : jhr 3470 | TY of Ty.ty | TYS of Ty.ty list
101 : jhr 3475 | ND of IR.node
102 : jhr 3470
103 :     fun error errBuf toks = let
104 :     fun tok2str NL = "\n ** "
105 :     | tok2str (S s) = s
106 :     | tok2str (A s) = Atom.toString s
107 :     | tok2str (V x) = V.toString x
108 :     | tok2str (VTYS xs) = tok2str(TYS(List.map V.ty xs))
109 :     | tok2str (TY ty) = Ty.toString ty
110 :     | tok2str (TYS []) = "()"
111 :     | tok2str (TYS[ty]) = Ty.toString ty
112 :     | tok2str (TYS tys) = String.concat[
113 :     "(", String.concatWith " * " (List.map Ty.toString tys), ")"
114 :     ]
115 : jhr 3475 | tok2str (ND nd) = IR.Node.toString nd
116 : jhr 3470 in
117 :     errBuf := concat ("**** Error: " :: List.map tok2str toks)
118 :     :: !errBuf
119 :     end
120 :    
121 :     fun checkAssign errFn ((y, rhs), bvs) = let
122 :     (* check a variable use *)
123 :     fun checkVar x = if VSet.member(bvs, x)
124 :     then ()
125 :     else errFn [
126 :     S "variable ", V x, S " is not bound in", NL,
127 : jhr 3475 S(IR.assignToString(y, rhs))
128 : jhr 3470 ]
129 :     fun tyError (ty1, ty2) = errFn [
130 : jhr 3475 S "type mismatch in \"", S(IR.assignToString (y, rhs)), S "\"",
131 : jhr 3470 NL, S "lhs: ", TY ty1, NL, S "rhs: ", TY ty2
132 :     ]
133 :     fun checkTys (ty1, ty2) = if Ty.same(ty1, ty2)
134 :     then ()
135 :     else tyError (ty1, ty2)
136 :     in
137 :     (* check that y is not bound twice *)
138 : jhr 3526 (* FIXME: with loops, this check no longer works (false positives)
139 : jhr 3470 if VSet.member(bvs, y)
140 :     then errFn [
141 :     S "variable ", V y, S " is bound twice in", NL,
142 : jhr 3475 S(IR.assignToString (y, rhs))
143 : jhr 3470 ]
144 :     else ();
145 : jhr 3526 *)
146 : jhr 3470 case rhs
147 : jhr 3475 of IR.GLOBAL x => checkTys(V.ty y, IR.GlobalVar.ty x)
148 :     | IR.STATE x => checkTys(V.ty y, IR.StateVar.ty x)
149 :     | IR.VAR x => (
150 : jhr 3470 checkVar x;
151 :     checkTys (V.ty y, V.ty x))
152 : jhr 3475 | IR.LIT lit => let
153 : jhr 3470 val ty = (case lit
154 :     of Literal.Int _ => Ty.intTy
155 :     | Literal.Real _ => Ty.realTy
156 :     | Literal.String _ => Ty.StringTy
157 :     | Literal.Bool _ => Ty.BoolTy
158 :     (* end case *))
159 :     in
160 :     checkTys (V.ty y, ty)
161 :     end
162 : jhr 3475 | IR.OP(rator, xs) => let
163 : jhr 3470 val (resTy, argTys) = OpTy.sigOf rator
164 :     in
165 :     List.app checkVar xs;
166 :     checkTys (V.ty y, resTy);
167 :     if ListPair.allEq (fn (x, ty) => Ty.same(V.ty x, ty)) (xs, argTys)
168 :     then ()
169 :     else errFn [
170 : jhr 3475 S "argument type mismatch in \"", S(IR.assignToString (y, rhs)), S "\"",
171 : jhr 3470 NL, S "expected: ", TYS argTys,
172 :     NL, S "found: ", VTYS xs
173 :     ]
174 :     end
175 : jhr 3475 | IR.CONS(xs, ty) => (
176 : jhr 3470 List.app checkVar xs;
177 :     if OpTy.typeOfCons (ty, List.map V.ty xs)
178 :     then checkTys (V.ty y, ty)
179 : jhr 3475 else errFn [S "invalid ", S(IR.assignToString(y, rhs))])
180 :     | IR.SEQ(xs, ty) => (
181 : jhr 3470 List.app checkVar xs;
182 :     (* FIXME: check types of sequence elements *)())
183 : jhr 3475 | IR.EINAPP(ein, xs) => (
184 : jhr 3470 List.app checkVar xs;
185 :     (* FIXME: check ein *)())
186 :     (* end case *);
187 :     VSet.add(bvs, y)
188 :     end
189 :    
190 :     fun checkMAssign errFn (stm as (ys, rator, xs), bvs) = let
191 :     (* check that a lhs variable is not bound twice *)
192 :     fun checkBind y = if VSet.member(bvs, y)
193 :     then errFn [
194 :     S "variable ", V y, S " is bound twice in", NL,
195 : jhr 3475 S(IR.massignToString stm)
196 : jhr 3470 ]
197 :     else ()
198 :     (* check a variable use *)
199 :     fun checkVar x = if VSet.member(bvs, x)
200 :     then ()
201 :     else errFn [
202 :     S "variable ", V x, S " is not bound in", NL,
203 : jhr 3475 S(IR.massignToString stm)
204 : jhr 3470 ]
205 :     fun tyError (ty1, ty2) = errFn [
206 : jhr 3475 S "type mismatch in \"", S(IR.massignToString stm), S "\"",
207 : jhr 3470 NL, S "lhs: ", TY ty1, NL, S "rhs: ", TY ty2
208 :     ]
209 :     in
210 :     (* check that the lhs variables are not bound twice *)
211 :     List.app checkBind ys;
212 :     (* FIXME:
213 :     (* check the types *)
214 :     val (resTys, argTys) = OpTy.sigOf rator
215 :     in
216 :     List.app checkVar xs;
217 :     if ListPair.allEq (fn (y, ty) => Ty.same(V.ty y, ty)) (ys, resTys)
218 :     then ()
219 :     else tyError (V.ty y, resTy);
220 :     if ListPair.allEq (fn (x, ty) => Ty.same(V.ty x, ty)) (xs, argTys)
221 :     then ()
222 :     else errFn [
223 : jhr 3475 S "argument type mismatch in \"", S(IR.massignToString stm), S "\"",
224 : jhr 3470 NL, S "expected: ", TYS argTys,
225 :     NL, S "found: ", VTYS xs
226 :     ]
227 :     end
228 :     *)
229 :     VSet.addList(bvs, ys)
230 :     end
231 :    
232 :     fun checkPhi errFn (nd, bvs, mask) (y, xs) = let
233 :     val ty = V.ty y
234 :     fun chkTy x = if Ty.same(V.ty x, ty)
235 :     then ()
236 :     else errFn [
237 : jhr 3475 S "type mismatch in \"", S(IR.phiToString (y, xs)), S "\"", NL,
238 : jhr 3470 S "typeof(", V y, S "): ", TY ty, NL,
239 :     S "typeof(", V x, S "): ", TY(V.ty x)
240 :     ]
241 :     fun chkRHS ([], []) = ()
242 :     | chkRHS (true::ms, NONE::xs) = chkRHS (ms, xs)
243 :     | chkRHS (false::ms, (SOME x)::xs) = (chkTy x; chkRHS (ms, xs))
244 :     | chkRHS _ = errFn [S "phi/mask mismatch in ", ND nd]
245 :     in
246 :     (* check that y is not bound twice *)
247 :     if VSet.member(bvs, y)
248 :     then errFn [
249 :     S "variable ", V y, S " is bound twice in", NL,
250 : jhr 3475 S(IR.phiToString (y, xs))
251 : jhr 3470 ]
252 :     else ();
253 :     (* check that rhs vars have the correct type *)
254 :     chkRHS (mask, xs)
255 :     end
256 :    
257 : jhr 3485 fun check (phase, prog) = let
258 :     val IR.Program{
259 :     props, consts, inputs, globals,
260 :     constInit, globalInit, strand, create, update
261 :     } = prog
262 : jhr 3470 val errBuf = ref []
263 :     val errFn = error errBuf
264 :     fun final () = (case !errBuf
265 :     of [] => false
266 :     | errs => (
267 : jhr 3676 Log.msg ["********** IR Errors detected after ", phase, " **********\n"];
268 :     List.app (fn msg => Log.msg [msg, "\n"]) (List.rev errs);
269 : jhr 3470 true)
270 :     (* end case *))
271 :     val checkPhi = checkPhi errFn
272 :     val checkAssign = checkAssign errFn
273 :     val checkMAssign = checkMAssign errFn
274 :     fun checkCFG (vs, cfg) = let
275 :     val bvs = VSet.fromList vs
276 :     (* compute the variables available on entry to each block *)
277 :     val nodes = Avail.analyse (bvs, cfg)
278 :     (* check the edges of a node. For each predecessor, the node should appear in the
279 :     * successor list and for each successor, the node should appear in the predecessor
280 :     * list.
281 :     *)
282 :     fun checkEdges nd = let
283 : jhr 3475 fun eqNd nd' = IR.Node.same(nd, nd')
284 :     fun chkPred src = if List.exists eqNd (IR.Node.succs src)
285 : jhr 3470 then ()
286 :     else errFn [
287 :     S "predecessor edge from ", ND nd, S " -> ", ND src,
288 :     S " not matched by successor edge"
289 :     ]
290 : jhr 3475 fun chkSucc dst = if List.exists eqNd (IR.Node.preds dst)
291 : jhr 3470 then ()
292 :     else errFn [
293 :     S "successor edge from ", ND nd, S " -> ", ND dst,
294 :     S " not matched by predecessor edge"
295 :     ]
296 :     in
297 : jhr 3475 List.app chkPred (IR.Node.preds nd);
298 :     List.app chkSucc (IR.Node.succs nd)
299 : jhr 3470 end
300 : jhr 3475 fun checkNd (nd as IR.ND{kind, ...}) = (case kind
301 :     of IR.NULL => errFn [S "unexpected ", ND nd]
302 :     | IR.JOIN{mask, phis, ...} =>
303 : jhr 3470 List.app
304 :     (checkPhi (nd, VSet.union(Avail.inValue nd, bvs), !mask))
305 :     (!phis)
306 : jhr 3475 | IR.COND{cond, ...} =>
307 : jhr 3536 if VSet.member(Avail.inValue nd, !cond)
308 :     orelse VSet.member(bvs, !cond)
309 : jhr 3470 then ()
310 : jhr 3536 else errFn [S "unbound variable ", V(!cond), S " in conditional"]
311 : jhr 3754 | IR.FOREACH{phis, mask, var, src, bodyExit, ...} => (
312 : jhr 3536 if VSet.member(Avail.inValue nd, !src)
313 :     orelse VSet.member(bvs, !src)
314 : jhr 3473 then ()
315 : jhr 3536 else errFn [S "unbound variable ", V(!src), S " in foreach"];
316 : jhr 3473 List.app
317 :     (checkPhi (nd, VSet.union(Avail.inValue nd, bvs), !mask))
318 : jhr 3754 (!phis);
319 :     case IR.Node.kind(!bodyExit)
320 :     of IR.NEXT{succ, ...} =>
321 :     if IR.Node.same(nd, !succ)
322 :     then ()
323 :     else errFn [
324 :     S "loop's body exit node ", ND(!bodyExit),
325 :     S " does not point back to loop header"
326 :     ]
327 :     | _ => errFn [
328 :     S "bad bodyExit ", ND(!bodyExit), S " for loop ", ND nd
329 :     ]
330 :     (* end case *))
331 :     | IR.NEXT{succ, ...} => (case IR.Node.kind(!succ)
332 :     of IR.FOREACH{bodyExit, ...} =>
333 :     if IR.Node.same(nd, !bodyExit)
334 :     then ()
335 :     else errFn [
336 :     S "next node ", ND nd, S " and loop ", ND(!succ),
337 :     S " do not agree"
338 :     ]
339 :     | _ => errFn [
340 :     S "bad successor ", ND(!succ), S " for loop exit ", ND nd
341 :     ]
342 :     (* end case *))
343 : jhr 3475 | IR.ASSIGN{stm, ...} =>
344 : jhr 3470 ignore (checkAssign (stm, VSet.union(Avail.inValue nd, bvs)))
345 : jhr 3475 | IR.MASSIGN{stm, ...} =>
346 : jhr 3470 ignore (checkMAssign (stm, VSet.union(Avail.inValue nd, bvs)))
347 : jhr 3475 | IR.GASSIGN{lhs, rhs, ...} => let
348 : jhr 3470 val bvs = VSet.union(Avail.inValue nd, bvs)
349 :     in
350 :     if VSet.member(bvs, rhs)
351 :     then ()
352 :     else errFn [
353 :     S "variable ", V rhs, S " is not bound in global assignment ",
354 : jhr 3475 S(IR.GlobalVar.toString lhs)
355 : jhr 3470 ];
356 : jhr 3475 if Ty.same(IR.GlobalVar.ty lhs, V.ty rhs)
357 : jhr 3470 then ()
358 :     else errFn [
359 : jhr 3475 S "type mismatch in \"", S(IR.GlobalVar.toString lhs),
360 : jhr 3470 S " = ", S(V.toString rhs), S "\"",
361 : jhr 3475 NL, S "lhs: ", TY(IR.GlobalVar.ty lhs),
362 : jhr 3470 NL, S "rhs: ", TY(V.ty rhs)
363 :     ]
364 :     end
365 : jhr 3475 | IR.NEW{strand, args, ...} => let
366 : jhr 3470 val bvs = VSet.union(Avail.inValue nd, bvs)
367 :     (* check a variable use *)
368 :     fun checkVar x = if VSet.member(bvs, x)
369 :     then ()
370 :     else errFn [
371 :     S "variable ", V x, S " is not bound in new ",
372 :     S(Atom.toString strand)
373 :     ]
374 :     in
375 :     List.app checkVar args
376 :     end
377 : jhr 3475 | IR.SAVE{lhs, rhs, ...} => let
378 : jhr 3470 val bvs = VSet.union(Avail.inValue nd, bvs)
379 :     in
380 :     if VSet.member(bvs, rhs)
381 :     then ()
382 :     else errFn [
383 :     S "variable ", V rhs, S " is not bound in save ",
384 : jhr 3475 S(IR.StateVar.toString lhs)
385 : jhr 3470 ];
386 : jhr 3475 if Ty.same(IR.StateVar.ty lhs, V.ty rhs)
387 : jhr 3470 then ()
388 :     else errFn [
389 : jhr 3475 S "type mismatch in \"", S(IR.StateVar.toString lhs),
390 : jhr 3470 S " = ", S(V.toString rhs), S "\"",
391 : jhr 3475 NL, S "lhs: ", TY(IR.StateVar.ty lhs),
392 : jhr 3470 NL, S "rhs: ", TY(V.ty rhs)
393 :     ]
394 :     end
395 :     | _ => ()
396 :     (* end case *))
397 :     in
398 :     List.app checkEdges nodes;
399 :     List.app checkNd nodes;
400 :     (* cleanup *)
401 :     Avail.scrub nodes
402 :     end
403 :     (* check a strand definition *)
404 : jhr 3485 fun checkStrand (IR.Strand{name, params, state, stateInit, initM, updateM, stabilizeM}) =
405 :     let
406 : jhr 3470 val nStateVars = List.length state
407 :     val extraVars = params
408 : jhr 3485 fun checkMethod body = checkCFG (extraVars, body)
409 : jhr 3470 (*DEBUG*)handle ex => raise ex
410 :     in
411 :     checkCFG (extraVars, stateInit)
412 :     (*DEBUG*)handle ex => raise ex;
413 : jhr 3485 Option.app checkMethod initM;
414 :     checkMethod updateM;
415 :     Option.app checkMethod stabilizeM
416 : jhr 3470 end
417 :     (* handle exceptions *)
418 :     fun onExn exn =
419 :     errFn (S "uncaught exception: " :: S(exnMessage exn) ::
420 :     List.foldr (fn (s, msg) => NL :: S " raised at " :: S s :: msg)
421 :     [] (SMLofNJ.exnHistory exn))
422 : jhr 3485 fun checkCFG' cfg = (checkCFG ([], cfg) handle ex => onExn ex)
423 : jhr 3470 in
424 :     (* check the input part *)
425 : jhr 3485 checkCFG' constInit;
426 : jhr 3470 (* check the global part *)
427 : jhr 3485 checkCFG' globalInit;
428 :     (* check initial strand creation *)
429 :     case create of IR.Create{dim, code} => checkCFG' code;
430 : jhr 3470 (* check the strands *)
431 : jhr 3485 (checkStrand strand) handle ex => onExn ex;
432 :     (* check the optional global update *)
433 :     Option.app checkCFG' update;
434 : jhr 3470 (* check for errors *)
435 :     final()
436 :     end
437 :    
438 :     end

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