Project

General

Profile

Statistics
| Branch: | Tag: | Revision:

lustrec / src / main_lustre_compiler.ml @ f7caf067

History | View | Annotate | Download (17.5 KB)

1
(********************************************************************)
2
(*                                                                  *)
3
(*  The LustreC compiler toolset   /  The LustreC Development Team  *)
4
(*  Copyright 2012 -    --   ONERA - CNRS - INPT                    *)
5
(*                                                                  *)
6
(*  LustreC is free software, distributed WITHOUT ANY WARRANTY      *)
7
(*  under the terms of the GNU Lesser General Public License        *)
8
(*  version 2.1.                                                    *)
9
(*                                                                  *)
10
(********************************************************************)
11

    
12
open Format
13
open Log
14

    
15
open Utils
16
open LustreSpec
17
open Compiler_common
18
 
19
exception StopPhase1 of program
20

    
21
let usage = "Usage: lustrec [options] \x1b[4msource file\x1b[0m"
22

    
23
let extensions = [".ec"; ".lus"; ".lusi"]
24

    
25
(* print a .lusi header file from a source prog *)
26
let print_lusi prog dirname basename extension =
27
  let header = Lusic.extract_header dirname basename prog in
28
  let header_name = dirname ^ "/" ^ basename ^ extension in
29
  let h_out = open_out header_name in
30
  let h_fmt = formatter_of_out_channel h_out in
31
  begin
32
    Typing.uneval_prog_generics header;
33
    Clock_calculus.uneval_prog_generics header;
34
    Printers.pp_lusi_header h_fmt basename header;
35
    close_out h_out
36
  end
37

    
38
(* compile a .lusi header file *)
39
let compile_header dirname  basename extension =
40
  let destname = !Options.dest_dir ^ "/" ^ basename in
41
  let header_name = basename ^ extension in
42
  let lusic_ext = extension ^ "c" in
43
  begin
44
    Log.report ~level:1 (fun fmt -> fprintf fmt "@[<v>");
45
    let header = parse_header true (dirname ^ "/" ^ header_name) in
46
    ignore (Modules.load_header ISet.empty header);
47
    ignore (check_top_decls header);
48
    create_dest_dir ();
49
    Log.report ~level:1
50
      (fun fmt -> fprintf fmt ".. generating compiled header file %sc@," (destname ^ extension));
51
    Lusic.write_lusic true header destname lusic_ext;
52
    Lusic.print_lusic_to_h destname lusic_ext;
53
    Log.report ~level:1 (fun fmt -> fprintf fmt ".. done !@ @]@ ")
54
  end
55

    
56
(* check whether a source file has a compiled header,
57
   if not, generate the compiled header *)
58
let compile_source_to_header prog computed_types_env computed_clocks_env dirname basename extension =
59
  let destname = !Options.dest_dir ^ "/" ^ basename in
60
  let lusic_ext = extension ^ "c" in
61
  let header_name = destname ^ lusic_ext in
62
  begin
63
    if not (Sys.file_exists header_name) then
64
      begin
65
	Log.report ~level:1 (fun fmt -> fprintf fmt ".. generating compiled header file %s@," header_name);
66
	Lusic.write_lusic false (Lusic.extract_header dirname basename prog) destname lusic_ext;
67
	Lusic.print_lusic_to_h destname lusic_ext
68
      end
69
    else
70
      let lusic = Lusic.read_lusic destname lusic_ext in
71
      if not lusic.Lusic.from_lusi then
72
	begin
73
	  Log.report ~level:1 (fun fmt -> fprintf fmt ".. generating compiled header file %s@," header_name);
74
       	  Lusic.write_lusic false (Lusic.extract_header dirname basename prog) destname lusic_ext;
75
	  (*List.iter (fun top_decl -> Format.eprintf "lusic: %a@." Printers.pp_decl top_decl) lusic.Lusic.contents;*)
76
	  Lusic.print_lusic_to_h destname lusic_ext
77
	end
78
      else
79
	begin
80
	  Log.report ~level:1 (fun fmt -> fprintf fmt ".. loading compiled header file %s@," header_name);
81
	  Modules.check_dependency lusic destname;
82
	  let header = lusic.Lusic.contents in
83
	  let (declared_types_env, declared_clocks_env) = get_envs_from_top_decls header in
84
	  check_compatibility
85
	    (prog, computed_types_env, computed_clocks_env)
86
	    (header, declared_types_env, declared_clocks_env)
87
	end
88
  end
89

    
90

    
91

    
92
(* From prog to prog *)
93
let stage1 prog dirname basename =
94
  (* Removing automata *)
95
  let prog = expand_automata prog in
96
  Log.report ~level:4 (fun fmt -> fprintf fmt ".. after automata expansion:@,  @[<v 2>@,%a@]@ " Printers.pp_prog prog);
97

    
98
  (* Importing source *)
99
  let _ = Modules.load_program ISet.empty prog in
100

    
101
  (* Extracting dependencies *)
102
  let dependencies, type_env, clock_env = import_dependencies prog in
103

    
104
  (* Sorting nodes *)
105
  let prog = SortProg.sort prog in
106

    
107
  (* Perform inlining before any analysis *)
108
  let orig, prog =
109
    if !Options.global_inline && !Options.main_node <> "" then
110
      (if !Options.witnesses then prog else []),
111
      Inliner.global_inline basename prog type_env clock_env
112
    else (* if !Option.has_local_inline *)
113
      [],
114
      Inliner.local_inline basename prog type_env clock_env
115
  in
116

    
117
  (* Checking stateless/stateful status *)
118
  if Plugins.check_force_stateful () then
119
    force_stateful_decls prog
120
  else
121
    check_stateless_decls prog;
122

    
123
  (* Typing *)
124
  let computed_types_env = type_decls type_env prog in
125

    
126
  (* Clock calculus *)
127
  let computed_clocks_env = clock_decls clock_env prog in
128

    
129
  (* Generating a .lusi header file only *)
130
  if !Options.lusi then
131
    (* We stop here the processing and produce the current prog. It will be
132
       exported as a lusi *)
133
    raise (StopPhase1 prog);
134

    
135
 (* Optimization of prog: 
136
     - Unfold consts 
137
     - eliminate trivial expressions
138
 *)
139
  (*
140
  let prog = 
141
    if !Options.const_unfold || !Options.optimization >= 5 then
142
      begin
143
	Log.report ~level:1 (fun fmt -> fprintf fmt ".. eliminating constants and aliases@,");
144
	Optimize_prog.prog_unfold_consts prog
145
      end
146
    else
147
      prog
148
  in
149
  *)
150
  (* Delay calculus *)
151
  (* TO BE DONE LATER (Xavier)
152
    if(!Options.delay_calculus)
153
    then
154
    begin
155
    Log.report ~level:1 (fun fmt -> fprintf fmt ".. initialisation analysis@?");
156
    try
157
    Delay_calculus.delay_prog Basic_library.delay_env prog
158
    with (Delay.Error (loc,err)) as exc ->
159
    Location.print loc;
160
    eprintf "%a" Delay.pp_error err;
161
    Utils.track_exception ();
162
    raise exc
163
    end;
164
  *)
165

    
166
  (* Creating destination directory if needed *)
167
  create_dest_dir ();
168

    
169
  (* Compatibility with Lusi *)
170
  (* Checking the existence of a lusi (Lustre Interface file) *)
171
  let extension = ".lusi" in
172
  compile_source_to_header prog computed_types_env computed_clocks_env dirname basename extension;
173

    
174
  Typing.uneval_prog_generics prog;
175
  Clock_calculus.uneval_prog_generics prog;
176

    
177
  if !Options.global_inline && !Options.main_node <> "" && !Options.witnesses then
178
    begin
179
      let orig = Corelang.copy_prog orig in
180
      Log.report ~level:1 (fun fmt -> fprintf fmt ".. generating witness file@,");
181
      check_stateless_decls orig;
182
      let _ = Typing.type_prog type_env orig in
183
      let _ = Clock_calculus.clock_prog clock_env orig in
184
      Typing.uneval_prog_generics orig;
185
      Clock_calculus.uneval_prog_generics orig;
186
      Inliner.witness
187
	basename
188
	!Options.main_node
189
	orig prog type_env clock_env
190
    end;
191
  
192
  (* Computes and stores generic calls for each node,
193
     only useful for ANSI C90 compliant generic node compilation *)
194
  if !Options.ansi then Causality.NodeDep.compute_generic_calls prog;
195
  (*Hashtbl.iter (fun id td -> match td.Corelang.top_decl_desc with
196
    Corelang.Node nd -> Format.eprintf "%s calls %a" id
197
    Causality.NodeDep.pp_generic_calls nd | _ -> ()) Corelang.node_table;*)
198

    
199
  (* Normalization phase *)
200
  Log.report ~level:1 (fun fmt -> fprintf fmt ".. normalization@,");
201
  (* Special treatment of arrows in lustre backend. We want to keep them *)
202
  if !Options.output = "lustre" then
203
    Normalization.unfold_arrow_active := false;
204
  let prog = Normalization.normalize_prog prog in
205
  Log.report ~level:2 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog);
206

    
207
  let prog =
208
    if !Options.mpfr
209
    then
210
      begin
211
	Log.report ~level:1 (fun fmt -> fprintf fmt ".. targetting MPFR library@,");
212
	Mpfr.inject_prog prog
213
      end
214
    else
215
      begin
216
	Log.report ~level:1 (fun fmt -> fprintf fmt ".. keeping floating-point numbers@,");
217
	prog
218
      end in
219
  Log.report ~level:2 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog);
220

    
221
  (* Checking array accesses *)
222
  if !Options.check then
223
    begin
224
      Log.report ~level:1 (fun fmt -> fprintf fmt ".. checking array accesses@,");
225
      Access.check_prog prog;
226
    end;
227

    
228
  prog, dependencies
229

    
230
(* from source to machine code, with optimization *)
231
let stage2 prog =    
232
  (* Computation of node equation scheduling. It also breaks dependency cycles
233
     and warns about unused input or memory variables *)
234
  Log.report ~level:1 (fun fmt -> fprintf fmt ".. scheduling@,");
235
  let prog, node_schs = Scheduling.schedule_prog prog in
236
  Log.report ~level:1 (fun fmt -> fprintf fmt "%a"              Scheduling.pp_warning_unused node_schs);
237
  Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_schedule node_schs);
238
  Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_fanin_table node_schs);
239
  Log.report ~level:5 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_dep_graph node_schs);
240
  Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog);
241

    
242

    
243
  (* TODO Salsa optimize prog: 
244
     - emits warning for programs with pre inside expressions
245
     - make sure each node arguments and memory is bounded by a local annotation
246
     - introduce fresh local variables for each real pure subexpression
247
  *)
248
  (* DFS with modular code generation *)
249
  Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines generation@,");
250
  let machine_code = Machine_code.translate_prog prog node_schs in
251

    
252
  Log.report ~level:3 (fun fmt -> fprintf fmt ".. generated machines (unoptimized):@ %a@ "Machine_code.pp_machines machine_code);
253

    
254
  (* Optimize machine code *)
255
  let machine_code =
256
    if !Options.optimization >= 4 (* && !Options.output <> "horn" *) then
257
      begin
258
	Log.report ~level:1 
259
	  (fun fmt -> fprintf fmt ".. machines optimization: sub-expression elimination@,");
260
	let machine_code = Optimize_machine.machines_cse machine_code in
261
	Log.report ~level:3 (fun fmt -> fprintf fmt ".. generated machines (sub-expr elim):@ %a@ "Machine_code.pp_machines machine_code);
262
	machine_code
263
      end
264
    else
265
      machine_code
266
  in
267
  (* Optimize machine code *)
268
  let machine_code, removed_table = 
269
    if !Options.optimization >= 2 (*&& !Options.output <> "horn"*) then
270
      begin
271
	Log.report ~level:1 (fun fmt -> fprintf fmt 
272
	  ".. machines optimization: const. inlining (partial eval. with const)@,");
273
	let machine_code, removed_table = Optimize_machine.machines_unfold (Corelang.get_consts prog) node_schs machine_code in
274
	Log.report ~level:3 (fun fmt -> fprintf fmt "\t@[Eliminated constants: @[%a@]@]@ "
275
	  (pp_imap Optimize_machine.pp_elim) removed_table);
276
	Log.report ~level:3 (fun fmt -> fprintf fmt ".. generated machines (const inlining):@ %a@ "Machine_code.pp_machines machine_code);	
277
	machine_code, removed_table
278
      end
279
    else
280
      machine_code, IMap.empty
281
  in  
282
  (* Optimize machine code *)
283
  let machine_code =
284
    if !Options.optimization >= 3 && not (Corelang.functional_backend ()) then
285
      begin
286
	Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines optimization: minimize stack usage by reusing variables@,");
287
	let node_schs    = Scheduling.remove_prog_inlined_locals removed_table node_schs in
288
	let reuse_tables = Scheduling.compute_prog_reuse_table node_schs in
289
	Optimize_machine.machines_fusion (Optimize_machine.machines_reuse_variables machine_code reuse_tables)
290
      end
291
    else
292
      machine_code
293
  in
294
  
295
  (* Salsa optimize machine code *)
296
  (*
297
  let machine_code = 
298
    if !Options.salsa_enabled then
299
      begin
300
	check_main ();
301
	Log.report ~level:1 (fun fmt -> fprintf fmt ".. salsa machines optimization: optimizing floating-point accuracy with Salsa@,");
302
	(* Selecting float constants for Salsa *)
303
	let constEnv = List.fold_left (
304
	  fun accu c_topdecl ->
305
	    match c_topdecl.top_decl_desc with
306
	    | Const c when Types.is_real_type c.const_type  ->
307
	      (c.const_id, c.const_value) :: accu
308
	    | _ -> accu
309
	) [] (Corelang.get_consts prog) 
310
	in
311
	List.map 
312
	  (Machine_salsa_opt.machine_t2machine_t_optimized_by_salsa constEnv) 
313
	  machine_code 
314
      end
315
    else
316
      machine_code
317
  in
318
  Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@ "
319
    (Utils.fprintf_list ~sep:"@ " Machine_code.pp_machine)
320
    machine_code);
321
  *)
322
  machine_code
323

    
324

    
325
(* printing code *)
326
let stage3 prog machine_code dependencies basename =
327
  let basename    =  Filename.basename basename in
328
  match !Options.output with
329
    "C" -> 
330
      begin
331
	Log.report ~level:1 (fun fmt -> fprintf fmt ".. C code generation@,");
332
	C_backend.translate_to_c
333
	  (* alloc_header_file source_lib_file source_main_file makefile_file *)
334
	  basename prog machine_code dependencies
335
      end
336
  | "java" ->
337
     begin
338
       (Format.eprintf "internal error: sorry, but not yet supported !"; assert false)
339
     (*let source_file = basename ^ ".java" in
340
       Log.report ~level:1 (fun fmt -> fprintf fmt ".. opening file %s@,@?" source_file);
341
       let source_out = open_out source_file in
342
       let source_fmt = formatter_of_out_channel source_out in
343
       Log.report ~level:1 (fun fmt -> fprintf fmt ".. java code generation@,@?");
344
       Java_backend.translate_to_java source_fmt basename normalized_prog machine_code;*)
345
     end
346
  | "horn" ->
347
     begin
348
       let destname = !Options.dest_dir ^ "/" ^ basename in
349
       let source_file = destname ^ ".smt2" in (* Could be changed *)
350
       let source_out = open_out source_file in
351
       let fmt = formatter_of_out_channel source_out in
352
       Log.report ~level:1 (fun fmt -> fprintf fmt ".. hornification@,");
353
       Horn_backend.translate fmt basename prog (Machine_code.arrow_machine::machine_code);
354
       (* Tracability file if option is activated *)
355
       if !Options.traces then (
356
	 let traces_file = destname ^ ".traces.xml" in (* Could be changed *)
357
	 let traces_out = open_out traces_file in
358
	 let fmt = formatter_of_out_channel traces_out in
359
         Log.report ~level:1 (fun fmt -> fprintf fmt ".. tracing info@,");
360
	 Horn_backend_traces.traces_file fmt basename prog machine_code;
361
       )
362
     end
363
  | "lustre" ->
364
     begin
365
       let destname = !Options.dest_dir ^ "/" ^ basename in
366
       let source_file = destname ^ ".lustrec.lus" in (* Could be changed *)
367
       let source_out = open_out source_file in
368
       let fmt = formatter_of_out_channel source_out in
369
       Printers.pp_prog fmt prog;
370
       (*	Lustre_backend.translate fmt basename normalized_prog machine_code *)
371
       ()
372
     end
373
  | "emf" ->
374
     begin
375
       let destname = !Options.dest_dir ^ "/" ^ basename in
376
       let source_file = destname ^ ".emf" in (* Could be changed *)
377
       let source_out = open_out source_file in
378
       let fmt = formatter_of_out_channel source_out in
379
       EMF_backend.translate fmt prog machine_code;
380
       ()
381
     end
382

    
383
  | _ -> assert false
384

    
385
(* compile a .lus source file *)
386
let rec compile_source dirname basename extension =
387
  let source_name = dirname ^ "/" ^ basename ^ extension in
388

    
389
  Log.report ~level:1 (fun fmt -> fprintf fmt "@[<v 0>");
390

    
391
  (* Parsing source *)
392
  let prog = parse_source source_name in
393

    
394
  let prog =
395
    if !Options.mpfr then
396
      Mpfr.mpfr_module::prog
397
    else
398
      prog
399
  in
400
  let prog, dependencies = 
401
    Log.report ~level:1 (fun fmt -> fprintf fmt "@[<v 2>.. Phase 1 : Normalisation@,");
402
    try 
403
      stage1 prog dirname basename
404
    with StopPhase1 prog -> (
405
      if !Options.lusi then
406
	begin
407
	  let lusi_ext = extension ^ "i" in
408
	  Log.report ~level:1 (fun fmt -> fprintf fmt ".. generating interface file %s@ " (basename ^ lusi_ext));
409
	  print_lusi prog dirname basename lusi_ext;
410
	  Log.report ~level:1 (fun fmt -> fprintf fmt ".. done !@ @]@.");
411
	  exit 0
412
	end
413
      else
414
        assert false
415
    )
416
  in
417
  Log.report ~level:1 (fun fmt -> fprintf fmt "@]@,");
418
  Log.report ~level:3 (fun fmt -> fprintf fmt ".. Normalized program:@ %a@ "Printers.pp_prog prog);
419

    
420
  Log.report ~level:1 (fun fmt -> fprintf fmt "@[<v 2>.. Phase 2 : Machines generation@,");
421

    
422
  let machine_code = 
423
    stage2 prog 
424
  in
425

    
426
  Log.report ~level:1 (fun fmt -> fprintf fmt "@]@ ");
427
  Log.report ~level:3 (fun fmt -> fprintf fmt ".. Generated machines:@ %a@ "Machine_code.pp_machines machine_code);
428

    
429
  if Scopes.Plugin.show_scopes () then
430
    begin
431
      let all_scopes = Scopes.compute_scopes prog !Options.main_node in
432
      (* Printing scopes *)
433
      if !Options.verbose_level >= 1 then
434
	Format.printf "Possible scopes are:@   ";
435
      Format.printf "@[<v>%a@ @]@ @?" Scopes.print_scopes all_scopes;
436
      exit 0
437
	
438
    end;
439

    
440
  let machine_code = Plugins.refine_machine_code prog machine_code in
441
  
442
  stage3 prog machine_code dependencies basename;
443
  begin
444
    Log.report ~level:1 (fun fmt -> fprintf fmt ".. done !@ @]@.");
445
    (* We stop the process here *)
446
    exit 0
447
  end
448

    
449
let compile dirname basename extension =
450
  match extension with
451
  | ".lusi"  -> compile_header dirname basename extension
452
  | ".lus"   -> compile_source dirname basename extension
453
  | _        -> assert false
454

    
455
let anonymous filename =
456
  let ok_ext, ext = List.fold_left
457
    (fun (ok, ext) ext' ->
458
      if not ok && Filename.check_suffix filename ext' then
459
	true, ext'
460
      else
461
	ok, ext)
462
    (false, "") extensions in
463
  if ok_ext then
464
    let dirname = Filename.dirname filename in
465
    let basename = Filename.chop_suffix (Filename.basename filename) ext in
466
    compile dirname basename ext
467
  else
468
    raise (Arg.Bad ("Can only compile *.lusi, *.lus or *.ec files"))
469

    
470
let _ =
471
  Global.initialize ();
472
  Corelang.add_internal_funs ();
473
  try
474
    Printexc.record_backtrace true;
475

    
476
    let options = Options.lustrec_options @ (Plugins.options ()) in
477
    
478
    Arg.parse options anonymous usage
479
  with
480
  | Parse.Error _
481
  | Types.Error (_,_) | Clocks.Error (_,_)
482
  | Corelang.Error _ (*| Task_set.Error _*)
483
  | Causality.Error _ -> exit 1
484
  | Sys_error msg -> (eprintf "Failure: %s@." msg)
485
  | exc -> (track_exception (); raise exc)
486

    
487
(* Local Variables: *)
488
(* compile-command:"make -C .." *)
489
(* End: *)