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
|
let functional_backend () =
|
92
|
match !Options.output with
|
93
|
| "horn" | "lustre" | "acsl" -> true
|
94
|
| _ -> false
|
95
|
|
96
|
(* From prog to prog *)
|
97
|
let stage1 prog dirname basename =
|
98
|
(* Removing automata *)
|
99
|
let prog = expand_automata prog in
|
100
|
|
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 Scopes.Plugin.is_active () 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
|
(* Normalization phase *)
|
205
|
Log.report ~level:1 (fun fmt -> fprintf fmt ".. normalization@,");
|
206
|
(* Special treatment of arrows in lustre backend. We want to keep them *)
|
207
|
if !Options.output = "lustre" then
|
208
|
Normalization.unfold_arrow_active := false;
|
209
|
let prog = Normalization.normalize_prog prog in
|
210
|
Log.report ~level:2 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog);
|
211
|
|
212
|
let prog =
|
213
|
if !Options.mpfr
|
214
|
then
|
215
|
begin
|
216
|
Log.report ~level:1 (fun fmt -> fprintf fmt ".. targetting MPFR library@,");
|
217
|
Mpfr.inject_prog prog
|
218
|
end
|
219
|
else
|
220
|
begin
|
221
|
Log.report ~level:1 (fun fmt -> fprintf fmt ".. keeping floating-point numbers@,");
|
222
|
prog
|
223
|
end in
|
224
|
Log.report ~level:2 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog);
|
225
|
|
226
|
(* Checking array accesses *)
|
227
|
if !Options.check then
|
228
|
begin
|
229
|
Log.report ~level:1 (fun fmt -> fprintf fmt ".. checking array accesses@,");
|
230
|
Access.check_prog prog;
|
231
|
end;
|
232
|
|
233
|
prog, dependencies
|
234
|
|
235
|
(* from source to machine code, with optimization *)
|
236
|
let stage2 prog =
|
237
|
(* Computation of node equation scheduling. It also breaks dependency cycles
|
238
|
and warns about unused input or memory variables *)
|
239
|
Log.report ~level:1 (fun fmt -> fprintf fmt ".. scheduling@,");
|
240
|
let prog, node_schs = Scheduling.schedule_prog prog in
|
241
|
Log.report ~level:1 (fun fmt -> fprintf fmt "%a" Scheduling.pp_warning_unused node_schs);
|
242
|
Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_schedule node_schs);
|
243
|
Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_fanin_table node_schs);
|
244
|
Log.report ~level:5 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_dep_graph node_schs);
|
245
|
Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog);
|
246
|
|
247
|
|
248
|
(* TODO Salsa optimize prog:
|
249
|
- emits warning for programs with pre inside expressions
|
250
|
- make sure each node arguments and memory is bounded by a local annotation
|
251
|
- introduce fresh local variables for each real pure subexpression
|
252
|
*)
|
253
|
(* DFS with modular code generation *)
|
254
|
Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines generation@ ");
|
255
|
let machine_code = Machine_code.translate_prog prog node_schs in
|
256
|
|
257
|
Log.report ~level:4 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@,"
|
258
|
(Utils.fprintf_list ~sep:"@ " Machine_code.pp_machine)
|
259
|
machine_code);
|
260
|
|
261
|
(* Optimize machine code *)
|
262
|
let machine_code =
|
263
|
if !Options.optimization >= 4 && !Options.output <> "horn" then
|
264
|
begin
|
265
|
Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines optimization: common sub-expression elimination@,");
|
266
|
Optimize_machine.machines_cse machine_code
|
267
|
end
|
268
|
else
|
269
|
machine_code
|
270
|
in
|
271
|
(* Optimize machine code *)
|
272
|
let machine_code, removed_table =
|
273
|
if !Options.optimization >= 2 && !Options.output <> "horn" then
|
274
|
begin
|
275
|
Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines optimization: constants inlining@,");
|
276
|
Optimize_machine.machines_unfold (Corelang.get_consts prog) node_schs machine_code
|
277
|
end
|
278
|
else
|
279
|
machine_code, IMap.empty
|
280
|
in
|
281
|
(* Optimize machine code *)
|
282
|
let machine_code =
|
283
|
if !Options.optimization >= 3 && !Options.output <> "horn" then
|
284
|
begin
|
285
|
Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines optimization: minimize stack usage by reusing variables@,");
|
286
|
let node_schs = Scheduling.remove_prog_inlined_locals removed_table node_schs in
|
287
|
let reuse_tables = Scheduling.compute_prog_reuse_table node_schs in
|
288
|
Optimize_machine.machines_fusion (Optimize_machine.machines_reuse_variables machine_code reuse_tables)
|
289
|
end
|
290
|
else
|
291
|
machine_code
|
292
|
in
|
293
|
|
294
|
(* Salsa optimize machine code *)
|
295
|
(*
|
296
|
let machine_code =
|
297
|
if !Options.salsa_enabled then
|
298
|
begin
|
299
|
check_main ();
|
300
|
Log.report ~level:1 (fun fmt -> fprintf fmt ".. salsa machines optimization: optimizing floating-point accuracy with Salsa@,");
|
301
|
(* Selecting float constants for Salsa *)
|
302
|
let constEnv = List.fold_left (
|
303
|
fun accu c_topdecl ->
|
304
|
match c_topdecl.top_decl_desc with
|
305
|
| Const c when Types.is_real_type c.const_type ->
|
306
|
(c.const_id, c.const_value) :: accu
|
307
|
| _ -> accu
|
308
|
) [] (Corelang.get_consts prog)
|
309
|
in
|
310
|
List.map
|
311
|
(Machine_salsa_opt.machine_t2machine_t_optimized_by_salsa constEnv)
|
312
|
machine_code
|
313
|
end
|
314
|
else
|
315
|
machine_code
|
316
|
in
|
317
|
Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@ "
|
318
|
(Utils.fprintf_list ~sep:"@ " Machine_code.pp_machine)
|
319
|
machine_code);
|
320
|
*)
|
321
|
machine_code
|
322
|
|
323
|
|
324
|
(* printing code *)
|
325
|
let stage3 prog machine_code dependencies basename =
|
326
|
let basename = Filename.basename basename in
|
327
|
match !Options.output with
|
328
|
"C" ->
|
329
|
begin
|
330
|
Log.report ~level:1 (fun fmt -> fprintf fmt ".. C code generation@,");
|
331
|
C_backend.translate_to_c
|
332
|
(* alloc_header_file source_lib_file source_main_file makefile_file *)
|
333
|
basename prog machine_code dependencies
|
334
|
end
|
335
|
| "java" ->
|
336
|
begin
|
337
|
(Format.eprintf "internal error: sorry, but not yet supported !"; assert false)
|
338
|
(*let source_file = basename ^ ".java" in
|
339
|
Log.report ~level:1 (fun fmt -> fprintf fmt ".. opening file %s@,@?" source_file);
|
340
|
let source_out = open_out source_file in
|
341
|
let source_fmt = formatter_of_out_channel source_out in
|
342
|
Log.report ~level:1 (fun fmt -> fprintf fmt ".. java code generation@,@?");
|
343
|
Java_backend.translate_to_java source_fmt basename normalized_prog machine_code;*)
|
344
|
end
|
345
|
| "horn" ->
|
346
|
begin
|
347
|
let destname = !Options.dest_dir ^ "/" ^ basename in
|
348
|
let source_file = destname ^ ".smt2" in (* Could be changed *)
|
349
|
let source_out = open_out source_file in
|
350
|
let fmt = formatter_of_out_channel source_out in
|
351
|
Log.report ~level:1 (fun fmt -> fprintf fmt ".. hornification@,");
|
352
|
Horn_backend.translate fmt basename prog (Machine_code.arrow_machine::machine_code);
|
353
|
(* Tracability file if option is activated *)
|
354
|
if !Options.traces then (
|
355
|
let traces_file = destname ^ ".traces.xml" in (* Could be changed *)
|
356
|
let traces_out = open_out traces_file in
|
357
|
let fmt = formatter_of_out_channel traces_out in
|
358
|
Log.report ~level:1 (fun fmt -> fprintf fmt ".. tracing info@,");
|
359
|
Horn_backend_traces.traces_file fmt basename prog machine_code;
|
360
|
)
|
361
|
end
|
362
|
| "lustre" ->
|
363
|
begin
|
364
|
let destname = !Options.dest_dir ^ "/" ^ basename in
|
365
|
let source_file = destname ^ ".lustrec.lus" in (* Could be changed *)
|
366
|
let source_out = open_out source_file in
|
367
|
let fmt = formatter_of_out_channel source_out in
|
368
|
Printers.pp_prog fmt prog;
|
369
|
(* Lustre_backend.translate fmt basename normalized_prog machine_code *)
|
370
|
()
|
371
|
end
|
372
|
|
373
|
| _ -> assert false
|
374
|
|
375
|
(* compile a .lus source file *)
|
376
|
let rec compile_source dirname basename extension =
|
377
|
let source_name = dirname ^ "/" ^ basename ^ extension in
|
378
|
|
379
|
Log.report ~level:1 (fun fmt -> fprintf fmt "@[<v>");
|
380
|
|
381
|
(* Parsing source *)
|
382
|
let prog = parse_source source_name in
|
383
|
|
384
|
let prog =
|
385
|
if !Options.mpfr then
|
386
|
Mpfr.mpfr_module::prog
|
387
|
else
|
388
|
prog
|
389
|
in
|
390
|
let prog, dependencies =
|
391
|
try
|
392
|
stage1 prog dirname basename
|
393
|
with StopPhase1 prog -> (
|
394
|
if !Options.lusi then
|
395
|
begin
|
396
|
let lusi_ext = extension ^ "i" in
|
397
|
Log.report ~level:1 (fun fmt -> fprintf fmt ".. generating interface file %s@," (basename ^ lusi_ext));
|
398
|
print_lusi prog dirname basename lusi_ext;
|
399
|
Log.report ~level:1 (fun fmt -> fprintf fmt ".. done !@ @]@.");
|
400
|
exit 0
|
401
|
end
|
402
|
else
|
403
|
assert false
|
404
|
)
|
405
|
in
|
406
|
|
407
|
let machine_code =
|
408
|
stage2 prog
|
409
|
in
|
410
|
if Scopes.Plugin.show_scopes () then
|
411
|
begin
|
412
|
let all_scopes = Scopes.compute_scopes prog !Options.main_node in
|
413
|
(* Printing scopes *)
|
414
|
if !Options.verbose_level >= 1 then
|
415
|
Format.printf "Possible scopes are:@ ";
|
416
|
Format.printf "@[<v>%a@ @]@.@?" Scopes.print_scopes all_scopes;
|
417
|
exit 0
|
418
|
|
419
|
end;
|
420
|
|
421
|
let machine_code =
|
422
|
if Scopes.Plugin.is_active () then
|
423
|
Scopes.Plugin.process_scopes !Options.main_node prog machine_code
|
424
|
else
|
425
|
machine_code
|
426
|
in
|
427
|
|
428
|
stage3 prog machine_code dependencies basename;
|
429
|
Log.report ~level:1 (fun fmt -> fprintf fmt ".. done @ @]@.");
|
430
|
(* We stop the process here *)
|
431
|
exit 0
|
432
|
|
433
|
let compile dirname basename extension =
|
434
|
match extension with
|
435
|
| ".lusi" -> compile_header dirname basename extension
|
436
|
| ".lus" -> compile_source dirname basename extension
|
437
|
| _ -> assert false
|
438
|
|
439
|
let anonymous filename =
|
440
|
let ok_ext, ext = List.fold_left
|
441
|
(fun (ok, ext) ext' ->
|
442
|
if not ok && Filename.check_suffix filename ext' then
|
443
|
true, ext'
|
444
|
else
|
445
|
ok, ext)
|
446
|
(false, "") extensions in
|
447
|
if ok_ext then
|
448
|
let dirname = Filename.dirname filename in
|
449
|
let basename = Filename.chop_suffix (Filename.basename filename) ext in
|
450
|
compile dirname basename ext
|
451
|
else
|
452
|
raise (Arg.Bad ("Can only compile *.lusi, *.lus or *.ec files"))
|
453
|
|
454
|
let _ =
|
455
|
Global.initialize ();
|
456
|
Corelang.add_internal_funs ();
|
457
|
try
|
458
|
Printexc.record_backtrace true;
|
459
|
|
460
|
let options = Options.options @
|
461
|
List.flatten (
|
462
|
List.map Options.plugin_opt [
|
463
|
Scopes.Plugin.name, Scopes.Plugin.activate, Scopes.Plugin.options
|
464
|
]
|
465
|
)
|
466
|
in
|
467
|
|
468
|
Arg.parse options anonymous usage
|
469
|
with
|
470
|
| Parse.Error _
|
471
|
| Types.Error (_,_) | Clocks.Error (_,_)
|
472
|
| Corelang.Error _ (*| Task_set.Error _*)
|
473
|
| Causality.Error _ -> exit 1
|
474
|
| Sys_error msg -> (eprintf "Failure: %s@." msg)
|
475
|
| exc -> (Utils.track_exception (); raise exc)
|
476
|
|
477
|
(* Local Variables: *)
|
478
|
(* compile-command:"make -C .." *)
|
479
|
(* End: *)
|