Project

General

Profile

Statistics
| Branch: | Tag: | Revision:

lustrec / src / main_lustre_compiler.ml @ 1bff14ac

History | View | Annotate | Download (17.8 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
    generate_lusic_header 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
let dynamic_checks () =
93
  match !Options.output, !Options.spec with
94
  | "C", "C" -> true
95
  | _ -> false
96
     
97
(* From prog to prog *)
98
let stage1 prog dirname basename =
99
  (* Removing automata *)
100
  let prog = expand_automata prog in
101
  Log.report ~level:4 (fun fmt -> fprintf fmt ".. after automata expansion:@,  @[<v 2>@,%a@]@ " Printers.pp_prog prog);
102

    
103
  (* Importing source *)
104
  let _ = Modules.load_program ISet.empty prog in
105

    
106
  (* Extracting dependencies *)
107
  let dependencies, type_env, clock_env = import_dependencies prog in
108

    
109
  (* Sorting nodes *)
110
  let prog = SortProg.sort prog in
111

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

    
122
  (* Checking stateless/stateful status *)
123
  if Plugins.check_force_stateful () then
124
    force_stateful_decls prog
125
  else
126
    check_stateless_decls prog;
127

    
128
  (* Typing *)
129
  let computed_types_env = type_decls type_env prog in
130

    
131
  (* Clock calculus *)
132
  let computed_clocks_env = clock_decls clock_env prog in
133

    
134
  (* Generating a .lusi header file only *)
135
  if !Options.lusi then
136
    (* We stop here the processing and produce the current prog. It will be
137
       exported as a lusi *)
138
    raise (StopPhase1 prog);
139

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

    
171
  (* Creating destination directory if needed *)
172
  create_dest_dir ();
173

    
174
  (* Compatibility with Lusi *)
175
  (* Checking the existence of a lusi (Lustre Interface file) *)
176
  let extension = ".lusi" in
177
  compile_source_to_header prog computed_types_env computed_clocks_env dirname basename extension;
178

    
179
  Typing.uneval_prog_generics prog;
180
  Clock_calculus.uneval_prog_generics prog;
181

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

    
204
  (* If some backend involving dynamic checks are active, then node annotations become runtime checks *)
205
  let prog =
206
    if dynamic_checks () then
207
      Spec.enforce_spec_prog prog
208
    else
209
      prog
210
  in
211
  
212
  (* Normalization phase *)
213
  Log.report ~level:1 (fun fmt -> fprintf fmt ".. normalization@,");
214
  (* Special treatment of arrows in lustre backend. We want to keep them *)
215
  if !Options.output = "lustre" then
216
    Normalization.unfold_arrow_active := false;
217
  let prog = Normalization.normalize_prog prog in
218
  Log.report ~level:2 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog);
219

    
220
  let prog =
221
    if !Options.mpfr
222
    then
223
      begin
224
	Log.report ~level:1 (fun fmt -> fprintf fmt ".. targetting MPFR library@,");
225
	Mpfr.inject_prog prog
226
      end
227
    else
228
      begin
229
	Log.report ~level:1 (fun fmt -> fprintf fmt ".. keeping floating-point numbers@,");
230
	prog
231
      end in
232
  Log.report ~level:2 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog);
233

    
234
  (* Checking array accesses *)
235
  if !Options.check then
236
    begin
237
      Log.report ~level:1 (fun fmt -> fprintf fmt ".. checking array accesses@,");
238
      Access.check_prog prog;
239
    end;
240

    
241
  prog, dependencies
242

    
243
(* from source to machine code, with optimization *)
244
let stage2 prog =    
245
  (* Computation of node equation scheduling. It also breaks dependency cycles
246
     and warns about unused input or memory variables *)
247
  Log.report ~level:1 (fun fmt -> fprintf fmt ".. scheduling@,");
248
  let prog, node_schs = Scheduling.schedule_prog prog in
249
  Log.report ~level:1 (fun fmt -> fprintf fmt "%a"              Scheduling.pp_warning_unused node_schs);
250
  Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_schedule node_schs);
251
  Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_fanin_table node_schs);
252
  Log.report ~level:5 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_dep_graph node_schs);
253
  Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog);
254

    
255

    
256
  (* TODO Salsa optimize prog: 
257
     - emits warning for programs with pre inside expressions
258
     - make sure each node arguments and memory is bounded by a local annotation
259
     - introduce fresh local variables for each real pure subexpression
260
  *)
261
  (* DFS with modular code generation *)
262
  Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines generation@,");
263
  let machine_code = Machine_code.translate_prog prog node_schs in
264

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

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

    
337

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

    
396
  | _ -> assert false
397

    
398
(* compile a .lus source file *)
399
let rec compile_source dirname basename extension =
400
  let source_name = dirname ^ "/" ^ basename ^ extension in
401

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

    
404
  (* Parsing source *)
405
  let prog = parse_source source_name in
406

    
407
  let prog =
408
    if !Options.mpfr then
409
      Mpfr.mpfr_module::prog
410
    else
411
      prog
412
  in
413
  let prog, dependencies = 
414
    Log.report ~level:1 (fun fmt -> fprintf fmt "@[<v 2>.. Phase 1 : Normalisation@,");
415
    try 
416
      stage1 prog dirname basename
417
    with StopPhase1 prog -> (
418
      if !Options.lusi then
419
	begin
420
	  let lusi_ext = extension ^ "i" in
421
	  Log.report ~level:1 (fun fmt -> fprintf fmt ".. generating interface file %s@ " (basename ^ lusi_ext));
422
	  print_lusi prog dirname basename lusi_ext;
423
	  Log.report ~level:1 (fun fmt -> fprintf fmt ".. done !@ @]@.");
424
	  exit 0
425
	end
426
      else
427
        assert false
428
    )
429
  in
430
  Log.report ~level:1 (fun fmt -> fprintf fmt "@]@,");
431
  Log.report ~level:3 (fun fmt -> fprintf fmt ".. Normalized program:@ %a@ "Printers.pp_prog prog);
432

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

    
435
  let machine_code = 
436
    stage2 prog 
437
  in
438

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

    
442
  if Scopes.Plugin.show_scopes () then
443
    begin
444
      let all_scopes = Scopes.compute_scopes prog !Options.main_node in
445
      (* Printing scopes *)
446
      if !Options.verbose_level >= 1 then
447
	Format.printf "Possible scopes are:@   ";
448
      Format.printf "@[<v>%a@ @]@ @?" Scopes.print_scopes all_scopes;
449
      exit 0
450
	
451
    end;
452

    
453
  let machine_code = Plugins.refine_machine_code prog machine_code in
454
  
455
  stage3 prog machine_code dependencies basename;
456
  begin
457
    Log.report ~level:1 (fun fmt -> fprintf fmt ".. done !@ @]@.");
458
    (* We stop the process here *)
459
    exit 0
460
  end
461

    
462
let compile dirname basename extension =
463
  match extension with
464
  | ".lusi"  -> compile_header dirname basename extension
465
  | ".lus"   -> compile_source dirname basename extension
466
  | _        -> assert false
467

    
468
let anonymous filename =
469
  let ok_ext, ext = List.fold_left
470
    (fun (ok, ext) ext' ->
471
      if not ok && Filename.check_suffix filename ext' then
472
	true, ext'
473
      else
474
	ok, ext)
475
    (false, "") extensions in
476
  if ok_ext then
477
    let dirname = Filename.dirname filename in
478
    let basename = Filename.chop_suffix (Filename.basename filename) ext in
479
    compile dirname basename ext
480
  else
481
    raise (Arg.Bad ("Can only compile *.lusi, *.lus or *.ec files"))
482

    
483
let _ =
484
  Global.initialize ();
485
  Corelang.add_internal_funs ();
486
  try
487
    Printexc.record_backtrace true;
488

    
489
    let options = Options_management.lustrec_options @ (Plugins.options ()) in
490
    
491
    Arg.parse options anonymous usage
492
  with
493
  | Parse.Error _
494
  | Types.Error (_,_) | Clocks.Error (_,_)
495
  | Corelang.Error _ (*| Task_set.Error _*)
496
  | Causality.Error _ -> exit 1
497
  | Sys_error msg -> (eprintf "Failure: %s@." msg)
498
  | exc -> (track_exception (); raise exc)
499

    
500
(* Local Variables: *)
501
(* compile-command:"make -C .." *)
502
(* End: *)