Project

General

Profile

Statistics
| Branch: | Tag: | Revision:

lustrec / src / machine_code.ml @ d3e4c22f

History | View | Annotate | Download (17.2 KB)

1

    
2
(* ----------------------------------------------------------------------------
3
 * SchedMCore - A MultiCore Scheduling Framework
4
 * Copyright (C) 2009-2013, ONERA, Toulouse, FRANCE - LIFL, Lille, FRANCE
5
 * Copyright (C) 2012-2013, INPT, Toulouse, FRANCE
6
 *
7
 * This file is part of Prelude
8
 *
9
 * Prelude is free software; you can redistribute it and/or
10
 * modify it under the terms of the GNU Lesser General Public License
11
 * as published by the Free Software Foundation ; either version 2 of
12
 * the License, or (at your option) any later version.
13
 *
14
 * Prelude is distributed in the hope that it will be useful, but
15
 * WITHOUT ANY WARRANTY ; without even the implied warranty of
16
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17
 * Lesser General Public License for more details.
18
 *
19
 * You should have received a copy of the GNU Lesser General Public
20
 * License along with this program ; if not, write to the Free Software
21
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
22
 * USA
23
 *---------------------------------------------------------------------------- *)
24

    
25
(* This module is used for the lustre to C compiler *)
26

    
27
open LustreSpec
28
open Corelang
29
open Clocks
30
open Causality
31

    
32
exception NormalizationError
33

    
34
module OrdVarDecl:Map.OrderedType with type t=var_decl =
35
  struct type t = var_decl;; let compare = compare end
36

    
37
module ISet = Set.Make(OrdVarDecl)
38

    
39
type value_t = 
40
  | Cst of constant
41
  | LocalVar of var_decl
42
  | StateVar of var_decl
43
  | Fun of ident * value_t list 
44
  | Array of value_t list
45
  | Access of value_t * value_t
46
  | Power of value_t * value_t
47

    
48
type instr_t =
49
  | MLocalAssign of var_decl * value_t
50
  | MStateAssign of var_decl * value_t
51
  | MReset of ident
52
  | MStep of var_decl list * ident * value_t list
53
  | MBranch of value_t * (label * instr_t list) list
54
 
55
let rec pp_val fmt v =
56
  match v with
57
    | Cst c         -> Printers.pp_const fmt c 
58
    | LocalVar v    -> Format.pp_print_string fmt v.var_id
59
    | StateVar v    -> Format.pp_print_string fmt v.var_id
60
    | Array vl      -> Format.fprintf fmt "[%a]" (Utils.fprintf_list ~sep:", " pp_val)  vl
61
    | Access (t, i) -> Format.fprintf fmt "%a[%a]" pp_val t pp_val i
62
    | Power (v, n)  -> Format.fprintf fmt "(%a^%a)" pp_val v pp_val n
63
    | Fun (n, vl)   -> Format.fprintf fmt "%s (%a)" n (Utils.fprintf_list ~sep:", " pp_val)  vl
64

    
65
let rec pp_instr fmt i =
66
  match i with 
67
    | MLocalAssign (i,v) -> Format.fprintf fmt "%s<-l- %a" i.var_id pp_val v
68
    | MStateAssign (i,v) -> Format.fprintf fmt "%s<-s- %a" i.var_id pp_val v
69
    | MReset i           -> Format.fprintf fmt "reset %s" i
70
    | MStep (il, i, vl)  ->
71
      Format.fprintf fmt "%a = %s (%a)"
72
	(Utils.fprintf_list ~sep:", " (fun fmt v -> Format.pp_print_string fmt v.var_id)) il
73
	i      
74
	(Utils.fprintf_list ~sep:", " pp_val) vl
75
    | MBranch (g,hl)     ->
76
      Format.fprintf fmt "@[<v 2>case(%a) {@,%a@,}@]"
77
	pp_val g
78
	(Utils.fprintf_list ~sep:"@," pp_branch) hl
79

    
80
and pp_branch fmt (t, h) =
81
  Format.fprintf fmt "@[<v 2>%s:@,%a@]" t (Utils.fprintf_list ~sep:"@," pp_instr) h
82

    
83
type step_t = {
84
  step_checks: (Location.t * value_t) list;
85
  step_inputs: var_decl list;
86
  step_outputs: var_decl list;
87
  step_locals: var_decl list;
88
  step_instrs: instr_t list;
89
}
90

    
91
type static_call = top_decl * (Dimension.dim_expr list)
92

    
93
type machine_t = {
94
  mname: node_desc;
95
  mmemory: var_decl list;
96
  mcalls: (ident * static_call) list; (* map from stateful/stateless instance to node, no internals *)
97
  minstances: (ident * static_call) list; (* sub-map of mcalls, from stateful instance to node *)
98
  minit: instr_t list;
99
  mstatic: var_decl list; (* static inputs only *)
100
  mstep: step_t;
101
  mspec: node_annot option;
102
  mannot: expr_annot option;
103
}
104

    
105
let pp_step fmt s =
106
  Format.fprintf fmt "@[<v>inputs : %a@ outputs: %a@ locals : %a@ checks : %a@ instrs : @[%a@]@]@ "
107
    (Utils.fprintf_list ~sep:", " Printers.pp_var) s.step_inputs
108
    (Utils.fprintf_list ~sep:", " Printers.pp_var) s.step_outputs
109
    (Utils.fprintf_list ~sep:", " Printers.pp_var) s.step_locals
110
    (Utils.fprintf_list ~sep:", " (fun fmt (_, c) -> pp_val fmt c)) s.step_checks
111
    (Utils.fprintf_list ~sep:"@ " pp_instr) s.step_instrs
112

    
113
let pp_static_call fmt (node, args) =
114
 Format.fprintf fmt "%s<%a>"
115
   (node_name node)
116
   (Utils.fprintf_list ~sep:", " Dimension.pp_dimension) args
117

    
118
let pp_machine fmt m =
119
  Format.fprintf fmt 
120
    "@[<v 2>machine %s@ mem      : %a@ instances: %a@ init     : %a@ step     :@   @[<v 2>%a@]@ @]@ "
121
    m.mname.node_id
122
    (Utils.fprintf_list ~sep:", " Printers.pp_var) m.mmemory
123
    (Utils.fprintf_list ~sep:", " (fun fmt (o1, o2) -> Format.fprintf fmt "(%s, %a)" o1 pp_static_call o2)) m.minstances
124
    (Utils.fprintf_list ~sep:"@ " pp_instr) m.minit
125
    pp_step m.mstep
126

    
127
let is_output m id =
128
  List.exists (fun o -> o.var_id = id.var_id) m.mstep.step_outputs
129

    
130
let conditional c t e =
131
  MBranch(c, [ (tag_true, t); (tag_false, e) ])
132

    
133
let dummy_var_decl name typ =
134
  {
135
    var_id = name;
136
    var_dec_type = dummy_type_dec;
137
    var_dec_clock = dummy_clock_dec;
138
    var_dec_const = false;
139
    var_type =  typ;
140
    var_clock = Clocks.new_ck (Clocks.Cvar Clocks.CSet_all) true;
141
    var_loc = Location.dummy_loc
142
  }
143

    
144
let arrow_id = "_arrow"
145

    
146
let arrow_typ = Types.new_ty Types.Tunivar
147

    
148
let arrow_desc =
149
  {
150
    node_id = arrow_id;
151
    node_type = Type_predef.type_bin_poly_op;
152
    node_clock = Clock_predef.ck_bin_univ;
153
    node_inputs= [dummy_var_decl "_in1" arrow_typ; dummy_var_decl "_in2" arrow_typ];
154
    node_outputs= [dummy_var_decl "_out" arrow_typ];
155
    node_locals= [];
156
    node_gencalls = [];
157
    node_checks = [];
158
    node_asserts = [];
159
    node_eqs= [];
160
    node_dec_stateless = false;
161
    node_stateless = Some false;
162
    node_spec = None;
163
    node_annot = None;  }
164

    
165
let arrow_top_decl =
166
  {
167
    top_decl_desc = Node arrow_desc;
168
    top_decl_loc = Location.dummy_loc
169
  }
170

    
171
let arrow_machine =
172
  let state = "_first" in
173
  let var_state = dummy_var_decl state (Types.new_ty Types.Tbool) in
174
  let var_input1 = List.nth arrow_desc.node_inputs 0 in
175
  let var_input2 = List.nth arrow_desc.node_inputs 1 in
176
  let var_output = List.nth arrow_desc.node_outputs 0 in
177
  {
178
    mname = arrow_desc;
179
    mmemory = [var_state];
180
    mcalls = [];
181
    minstances = [];
182
    minit = [MStateAssign(var_state, Cst (const_of_bool true))];
183
    mstatic = [];
184
    mstep = {
185
      step_inputs = arrow_desc.node_inputs;
186
      step_outputs = arrow_desc.node_outputs;
187
      step_locals = [];
188
      step_checks = [];
189
      step_instrs = [conditional (StateVar var_state)
190
			         [MStateAssign(var_state, Cst (const_of_bool false));
191
                                  MLocalAssign(var_output, LocalVar var_input1)]
192
                                 [MLocalAssign(var_output, LocalVar var_input2)] ]
193
    };
194
    mspec = None;
195
    mannot = None;
196
  }
197

    
198
let new_instance =
199
  let cpt = ref (-1) in
200
  fun caller callee tag ->
201
    begin
202
      let o =
203
	if Corelang.check_stateless_node callee then
204
	  node_name callee
205
	else
206
	  Printf.sprintf "ni_%d" (incr cpt; !cpt) in
207
      let o =
208
	if !Options.ansi && is_generic_node callee
209
	then Printf.sprintf "%s_inst_%d" o (Utils.position (fun e -> e.expr_tag = tag) caller.node_gencalls)
210
	else o in
211
      o
212
    end
213

    
214
let const_of_carrier cr =
215
 match (carrier_repr cr).carrier_desc with
216
 | Carry_const id -> id
217
 | Carry_name
218
 | Carry_var
219
 | Carry_link _ -> (Format.eprintf "internal error: const_of_carrier %a@." print_carrier cr; assert false) (* TODO check this Xavier *)
220

    
221
(* translate_<foo> : node -> context -> <foo> -> machine code/expression *)
222
(* the context contains  m : state aka memory variables  *)
223
(*                      si : initialization instructions *)
224
(*                       j : node aka machine instances  *)
225
(*                       d : local variables             *)
226
(*                       s : step instructions           *)
227
let translate_ident node (m, si, j, d, s) id =
228
  try (* id is a node var *)
229
    let var_id = node_var id node in
230
    if ISet.exists (fun v -> v.var_id = id) m
231
    then StateVar var_id
232
    else LocalVar var_id
233
  with Not_found -> (* id is a constant *)
234
    LocalVar (Corelang.var_decl_of_const (Hashtbl.find Corelang.consts_table id))
235

    
236
let rec control_on_clock node ((m, si, j, d, s) as args) ck inst =
237
 match (Clocks.repr ck).cdesc with
238
 | Con    (ck1, cr, l) ->
239
   let id  = const_of_carrier cr in
240
   control_on_clock node args ck1 (MBranch (translate_ident node args id,
241
					    [l, [inst]] ))
242
 | _                   -> inst
243

    
244
let rec join_branches hl1 hl2 =
245
 match hl1, hl2 with
246
 | []          , _            -> hl2
247
 | _           , []           -> hl1
248
 | (t1, h1)::q1, (t2, h2)::q2 ->
249
   if t1 < t2 then (t1, h1) :: join_branches q1 hl2 else
250
   if t1 > t2 then (t2, h2) :: join_branches hl1 q2
251
   else (t1, List.fold_right join_guards h1 h2) :: join_branches q1 q2
252

    
253
and join_guards inst1 insts2 =
254
 match inst1, insts2 with
255
 | _                   , []                               ->
256
   [inst1]
257
 | MBranch (x1, hl1), MBranch (x2, hl2) :: q when x1 = x2 ->
258
   MBranch (x1, join_branches (sort_handlers hl1) (sort_handlers hl2))
259
   :: q
260
 | _ -> inst1 :: insts2
261

    
262
let join_guards_list insts =
263
 List.fold_right join_guards insts []
264

    
265
let find_eq x eqs =
266
  let rec aux accu eqs =
267
      match eqs with
268
	| [] ->
269
	  begin
270
	    Format.eprintf "Looking for variable %a in the following equations@.%a@."
271
	      Format.pp_print_string x
272
	      Printers.pp_node_eqs eqs;
273
	    assert false
274
	  end
275
	| hd::tl -> 
276
	  if List.mem x hd.eq_lhs then hd, accu@tl else aux (hd::accu) tl
277
    in
278
    aux [] eqs
279

    
280
let rec translate_expr node ((m, si, j, d, s) as args) expr =
281
 match expr.expr_desc with
282
 | Expr_const v                     -> Cst v
283
 | Expr_ident x                     -> translate_ident node args x
284
 | Expr_array el                    -> Array (List.map (translate_expr node args) el)
285
 | Expr_access (t, i)               -> Access (translate_expr node args t, translate_expr node args (expr_of_dimension i))
286
 | Expr_power  (e, n)               -> Power  (translate_expr node args e, translate_expr node args (expr_of_dimension n))
287
 | Expr_tuple _
288
 | Expr_arrow _ 
289
 | Expr_fby _
290
 | Expr_pre _                       -> (Printers.pp_expr Format.err_formatter expr; Format.pp_print_flush Format.err_formatter (); raise NormalizationError)
291
 | Expr_when    (e1, _, _)          -> translate_expr node args e1
292
 | Expr_merge   (x, _)              -> raise NormalizationError
293
 | Expr_appl (id, e, _) when Basic_library.is_internal_fun id ->
294
   let nd = node_from_name id in
295
   (match e.expr_desc with
296
   | Expr_tuple el -> Fun (node_name nd, List.map (translate_expr node args) el)
297
   | _             -> Fun (node_name nd, [translate_expr node args e]))
298
 | Expr_ite (g,t,e) -> (
299
   (* special treatment depending on the active backend. For horn backend, ite
300
      are preserved in expression. While they are removed for C or Java
301
      backends. *)
302
   match !Options.output with | "horn" -> 
303
     Fun ("ite", [translate_expr node args g; translate_expr node args t; translate_expr node args e])
304
   | "C" | "java" | _ -> 
305
     (Printers.pp_expr Format.err_formatter expr; Format.pp_print_flush Format.err_formatter (); raise NormalizationError)
306
 )
307
 | _                   -> raise NormalizationError
308

    
309
let translate_guard node args expr =
310
  match expr.expr_desc with
311
  | Expr_ident x  -> translate_ident node args x
312
  | _ -> assert false
313

    
314
let rec translate_act node ((m, si, j, d, s) as args) (y, expr) =
315
  match expr.expr_desc with
316
  | Expr_ite   (c, t, e) -> let g = translate_guard node args c in
317
			    conditional g [translate_act node args (y, t)]
318
                              [translate_act node args (y, e)]
319
  | Expr_merge (x, hl)   -> MBranch (translate_ident node args x, List.map (fun (t,  h) -> t, [translate_act node args (y, h)]) hl)
320
  | _                    -> MLocalAssign (y, translate_expr node args expr)
321

    
322
let reset_instance node args i r c =
323
  match r with
324
  | None        -> []
325
  | Some (x, l) -> [control_on_clock node args c (MBranch (translate_ident node args x, [l, [MReset i]]))]
326

    
327
let translate_eq node ((m, si, j, d, s) as args) eq =
328
  (*Format.eprintf "translate_eq %a with clock %a@." Printers.pp_node_eq eq Clocks.print_ck eq.eq_rhs.expr_clock;*)
329
  match eq.eq_lhs, eq.eq_rhs.expr_desc with
330
  | [x], Expr_arrow (e1, e2)                     ->
331
    let var_x = node_var x node in
332
    let o = new_instance node arrow_top_decl eq.eq_rhs.expr_tag in
333
    let c1 = translate_expr node args e1 in
334
    let c2 = translate_expr node args e2 in
335
    (m,
336
     MReset o :: si,
337
     Utils.IMap.add o (arrow_top_decl, []) j,
338
     d,
339
     (control_on_clock node args eq.eq_rhs.expr_clock (MStep ([var_x], o, [c1;c2]))) :: s)
340
  | [x], Expr_pre e1 when ISet.mem (node_var x node) d     ->
341
    let var_x = node_var x node in
342
    (ISet.add var_x m,
343
     si,
344
     j,
345
     d,
346
     control_on_clock node args eq.eq_rhs.expr_clock (MStateAssign (var_x, translate_expr node args e1)) :: s)
347
  | [x], Expr_fby (e1, e2) when ISet.mem (node_var x node) d ->
348
    let var_x = node_var x node in
349
    (ISet.add var_x m,
350
     MStateAssign (var_x, translate_expr node args e1) :: si,
351
     j,
352
     d,
353
     control_on_clock node args eq.eq_rhs.expr_clock (MStateAssign (var_x, translate_expr node args e2)) :: s)
354
  | p  , Expr_appl (f, arg, r)                  ->
355
    let var_p = List.map (fun v -> node_var v node) p in
356
    let el =
357
      match arg.expr_desc with
358
      | Expr_tuple el -> el
359
      | _             -> [arg] in
360
    let vl = List.map (translate_expr node args) el in
361
    let node_f = node_from_name f in
362
    let call_f =
363
      node_f,
364
      NodeDep.filter_static_inputs (node_inputs node_f) el in 
365
    let o = new_instance node node_f eq.eq_rhs.expr_tag in
366
    (m,
367
     (if check_stateless_node node_f then si else MReset o :: si),
368
     (if Basic_library.is_internal_fun f then j else Utils.IMap.add o call_f j),
369
     d,
370
     reset_instance node args o r eq.eq_rhs.expr_clock @
371
       (control_on_clock node args eq.eq_rhs.expr_clock (MStep (var_p, o, vl))) :: s)
372

    
373
   (* special treatment depending on the active backend. For horn backend, x = ite (g,t,e)
374
      are preserved. While they are replaced as if g then x = t else x = e in  C or Java
375
      backends. *)
376
  | [x], Expr_ite   (c, t, e) 
377
    when (match !Options.output with | "horn" -> true | "C" | "java" | _ -> false)
378
      -> 
379
    let var_x = node_var x node in
380
    (m, 
381
     si, 
382
     j, 
383
     d, 
384
     (control_on_clock node args eq.eq_rhs.expr_clock 
385
	(MLocalAssign (var_x, translate_expr node args eq.eq_rhs))::s)
386
    )
387
      
388
  | [x], _                                       -> (
389
    let var_x = node_var x node in
390
    (m, si, j, d, 
391
     control_on_clock node args eq.eq_rhs.expr_clock (translate_act node args (var_x, eq.eq_rhs)) :: s)
392
  )
393
  | _                                            ->
394
    begin
395
      Format.eprintf "unsupported equation: %a@?" Printers.pp_node_eq eq;
396
      assert false
397
    end
398

    
399
let translate_eqs node args eqs =
400
  List.fold_right (fun eq args -> translate_eq node args eq) eqs args;;
401

    
402
let translate_decl nd =
403
  (*Log.report ~level:1 (fun fmt -> Printers.pp_node fmt nd);*)
404
  let nd, sch = Scheduling.schedule_node nd in
405
  let split_eqs = Splitting.tuple_split_eq_list nd.node_eqs in
406
  let eqs_rev, remainder = 
407
    List.fold_left 
408
      (fun (accu, node_eqs_remainder) v -> 
409
	  if List.exists (fun eq -> List.mem v eq.eq_lhs) accu
410
	  then
411
	    (accu, node_eqs_remainder)
412
	  else
413
	    if   List.exists (fun vdecl -> vdecl.var_id = v) nd.node_locals
414
	      || List.exists (fun vdecl -> vdecl.var_id = v) nd.node_outputs
415
	    then
416
	      let eq_v, remainder = find_eq v node_eqs_remainder in
417
	      eq_v::accu, remainder
418
	    (* else it is a constant value, checked during typing phase *)
419
	    else	 
420
	      accu, node_eqs_remainder
421
      ) 
422
      ([], split_eqs) 
423
      sch 
424
  in
425
  if List.length remainder > 0 then (
426
    Format.eprintf "Equations not used are@.%a@.Full equation set is:@.%a@.@?"
427
	    Printers.pp_node_eqs remainder
428
      	    Printers.pp_node_eqs nd.node_eqs;
429
    assert false )
430
  ;
431

    
432
  let init_args = ISet.empty, [], Utils.IMap.empty, List.fold_right (fun l -> ISet.add l) nd.node_locals ISet.empty, [] in
433
  let m, init, j, locals, s = translate_eqs nd init_args (List.rev eqs_rev) in
434
  let mmap = Utils.IMap.fold (fun i n res -> (i, n)::res) j [] in
435
  {
436
    mname = nd;
437
    mmemory = ISet.elements m;
438
    mcalls = mmap;
439
    minstances = List.filter (fun (_, (n,_)) -> not (check_stateless_node n)) mmap;
440
    minit = init;
441
    mstatic = List.filter (fun v -> v.var_dec_const) nd.node_inputs;
442
    mstep = {
443
      step_inputs = nd.node_inputs;
444
      step_outputs = nd.node_outputs;
445
      step_locals = ISet.elements (ISet.diff locals m);
446
      step_checks = List.map (fun d -> d.Dimension.dim_loc, translate_expr nd init_args (expr_of_dimension d)) nd.node_checks;
447
      step_instrs = (
448
	(* special treatment depending on the active backend. For horn backend,
449
	   common branches are not merged while they are in C or Java
450
	   backends. *)
451
	match !Options.output with
452
	| "horn" -> s
453
	| "C" | "java" | _ -> join_guards_list s
454
      );
455
    };
456
    mspec = nd.node_spec;
457
    mannot = nd.node_annot;
458
  }
459

    
460

    
461
let translate_prog decls = 
462
  let nodes = get_nodes decls in 
463
   (* What to do with Imported/Sensor/Actuators ? *)
464
   arrow_machine ::  List.map translate_decl nodes
465

    
466
let get_machine_opt name machines =  
467
  List.fold_left 
468
    (fun res m -> 
469
      match res with 
470
      | Some _ -> res 
471
      | None -> if m.mname.node_id = name then Some m else None)
472
    None machines
473
    
474

    
475
(* Local Variables: *)
476
(* compile-command:"make -C .." *)
477
(* End: *)