lustrec / src / main_lustre_compiler.ml @ 79614a15
History | View | Annotate | Download (13.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 |
let usage = "Usage: lustrec [options] <source-file>" |
20 |
|
21 |
let extensions = [".ec"; ".lus"; ".lusi"] |
22 |
|
23 |
(* print a .lusi header file from a source prog *) |
24 |
let print_lusi prog dirname basename extension = |
25 |
let header = Lusic.extract_header dirname basename prog in |
26 |
let header_name = dirname ^ "/" ^ basename ^ extension in |
27 |
let h_out = open_out header_name in |
28 |
let h_fmt = formatter_of_out_channel h_out in |
29 |
begin |
30 |
Typing.uneval_prog_generics header; |
31 |
Clock_calculus.uneval_prog_generics header; |
32 |
Printers.pp_lusi_header h_fmt basename header; |
33 |
close_out h_out |
34 |
end |
35 |
|
36 |
(* compile a .lusi header file *) |
37 |
let compile_header dirname basename extension = |
38 |
let destname = !Options.dest_dir ^ "/" ^ basename in |
39 |
let header_name = basename ^ extension in |
40 |
let lusic_ext = extension ^ "c" in |
41 |
begin |
42 |
Log.report ~level:1 (fun fmt -> fprintf fmt "@[<v>"); |
43 |
let header = parse_header true (dirname ^ "/" ^ header_name) in |
44 |
ignore (Modules.load_header ISet.empty header); |
45 |
ignore (check_top_decls header); |
46 |
create_dest_dir (); |
47 |
Log.report ~level:1 |
48 |
(fun fmt -> fprintf fmt ".. generating compiled header file %sc@," (destname ^ extension)); |
49 |
Lusic.write_lusic true header destname lusic_ext; |
50 |
Lusic.print_lusic_to_h destname lusic_ext; |
51 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. done !@ @]@.") |
52 |
end |
53 |
|
54 |
(* check whether a source file has a compiled header, |
55 |
if not, generate the compiled header *) |
56 |
let compile_source_to_header prog computed_types_env computed_clocks_env dirname basename extension = |
57 |
let destname = !Options.dest_dir ^ "/" ^ basename in |
58 |
let lusic_ext = extension ^ "c" in |
59 |
let header_name = destname ^ lusic_ext in |
60 |
begin |
61 |
if not (Sys.file_exists header_name) then |
62 |
begin |
63 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. generating compiled header file %s@," header_name); |
64 |
Lusic.write_lusic false (Lusic.extract_header dirname basename prog) destname lusic_ext; |
65 |
Lusic.print_lusic_to_h destname lusic_ext |
66 |
end |
67 |
else |
68 |
let lusic = Lusic.read_lusic destname lusic_ext in |
69 |
if not lusic.Lusic.from_lusi then |
70 |
begin |
71 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. generating compiled header file %s@," header_name); |
72 |
Lusic.write_lusic false (Lusic.extract_header dirname basename prog) destname lusic_ext; |
73 |
(*List.iter (fun top_decl -> Format.eprintf "lusic: %a@." Printers.pp_decl top_decl) lusic.Lusic.contents;*) |
74 |
Lusic.print_lusic_to_h destname lusic_ext |
75 |
end |
76 |
else |
77 |
begin |
78 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. loading compiled header file %s@," header_name); |
79 |
Modules.check_dependency lusic destname; |
80 |
let header = lusic.Lusic.contents in |
81 |
let (declared_types_env, declared_clocks_env) = get_envs_from_top_decls header in |
82 |
check_compatibility |
83 |
(prog, computed_types_env, computed_clocks_env) |
84 |
(header, declared_types_env, declared_clocks_env) |
85 |
end |
86 |
end |
87 |
|
88 |
|
89 |
|
90 |
(* compile a .lus source file *) |
91 |
let rec compile_source dirname basename extension = |
92 |
|
93 |
Log.report ~level:1 (fun fmt -> fprintf fmt "@[<v>"); |
94 |
|
95 |
(* Parsing source *) |
96 |
let prog = parse_source (dirname ^ "/" ^ basename ^ extension) in |
97 |
|
98 |
(* Removing automata *) |
99 |
let prog = Automata.expand_decls prog in |
100 |
|
101 |
(* Importing source *) |
102 |
let _ = Modules.load_program ISet.empty prog in |
103 |
|
104 |
(* Extracting dependencies *) |
105 |
let dependencies, type_env, clock_env = import_dependencies prog in |
106 |
|
107 |
(* Sorting nodes *) |
108 |
let prog = SortProg.sort prog in |
109 |
|
110 |
(* Perform inlining before any analysis *) |
111 |
let orig, prog = |
112 |
if !Options.global_inline && !Options.main_node <> "" then |
113 |
(if !Options.witnesses then prog else []), |
114 |
Inliner.global_inline basename prog type_env clock_env |
115 |
else (* if !Option.has_local_inline *) |
116 |
[], |
117 |
Inliner.local_inline basename prog type_env clock_env |
118 |
in |
119 |
|
120 |
(* Checking stateless/stateful status *) |
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 |
begin |
132 |
let lusi_ext = extension ^ "i" in |
133 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. generating interface file %s@," (dirname ^ "/" ^ basename ^ lusi_ext)); |
134 |
print_lusi prog dirname basename lusi_ext; |
135 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. done !@ @]@."); |
136 |
exit 0 |
137 |
end; |
138 |
|
139 |
(* Delay calculus *) |
140 |
(* TO BE DONE LATER (Xavier) |
141 |
if(!Options.delay_calculus) |
142 |
then |
143 |
begin |
144 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. initialisation analysis@?"); |
145 |
try |
146 |
Delay_calculus.delay_prog Basic_library.delay_env prog |
147 |
with (Delay.Error (loc,err)) as exc -> |
148 |
Location.print loc; |
149 |
eprintf "%a" Delay.pp_error err; |
150 |
Utils.track_exception (); |
151 |
raise exc |
152 |
end; |
153 |
*) |
154 |
|
155 |
(* Creating destination directory if needed *) |
156 |
create_dest_dir (); |
157 |
|
158 |
(* Compatibility with Lusi *) |
159 |
(* Checking the existence of a lusi (Lustre Interface file) *) |
160 |
(match !Options.output with |
161 |
"C" -> |
162 |
begin |
163 |
let extension = ".lusi" in |
164 |
compile_source_to_header prog computed_types_env computed_clocks_env dirname basename extension; |
165 |
end |
166 |
|_ -> ()); |
167 |
|
168 |
Typing.uneval_prog_generics prog; |
169 |
Clock_calculus.uneval_prog_generics prog; |
170 |
|
171 |
if !Options.global_inline && !Options.main_node <> "" && !Options.witnesses then |
172 |
begin |
173 |
let orig = Corelang.copy_prog orig in |
174 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. generating witness file@,"); |
175 |
check_stateless_decls orig; |
176 |
let _ = Typing.type_prog type_env orig in |
177 |
let _ = Clock_calculus.clock_prog clock_env orig in |
178 |
Typing.uneval_prog_generics orig; |
179 |
Clock_calculus.uneval_prog_generics orig; |
180 |
Inliner.witness |
181 |
basename |
182 |
!Options.main_node |
183 |
orig prog type_env clock_env |
184 |
end; |
185 |
|
186 |
(*Format.eprintf "Inliner.global_inline<<@.%a@.>>@." Printers.pp_prog prog;*) |
187 |
(* Computes and stores generic calls for each node, |
188 |
only useful for ANSI C90 compliant generic node compilation *) |
189 |
if !Options.ansi then Causality.NodeDep.compute_generic_calls prog; |
190 |
(*Hashtbl.iter (fun id td -> match td.Corelang.top_decl_desc with Corelang.Node nd -> Format.eprintf "%s calls %a" id Causality.NodeDep.pp_generic_calls nd | _ -> ()) Corelang.node_table;*) |
191 |
|
192 |
(* Normalization phase *) |
193 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. normalization@,"); |
194 |
(* Special treatment of arrows in lustre backend. We want to keep them *) |
195 |
if !Options.output = "lustre" then |
196 |
Normalization.unfold_arrow_active := false; |
197 |
let prog = Normalization.normalize_prog prog in |
198 |
|
199 |
Log.report ~level:2 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog); |
200 |
(* Checking array accesses *) |
201 |
if !Options.check then |
202 |
begin |
203 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. array access checks@,"); |
204 |
Access.check_prog prog; |
205 |
end; |
206 |
|
207 |
(* Computation of node equation scheduling. It also breaks dependency cycles |
208 |
and warns about unused input or memory variables *) |
209 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. scheduling@,"); |
210 |
let prog, node_schs = Scheduling.schedule_prog prog in |
211 |
Log.report ~level:1 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_warning_unused node_schs); |
212 |
Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_schedule node_schs); |
213 |
Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_fanin_table node_schs); |
214 |
Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog); |
215 |
|
216 |
(* Optimization of prog: |
217 |
- Unfold consts |
218 |
- eliminate trivial expressions |
219 |
*) |
220 |
let prog = |
221 |
if !Options.optimization >= 5 then |
222 |
begin |
223 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. constants elimination@,"); |
224 |
Optimize_prog.prog_unfold_consts prog |
225 |
end |
226 |
else |
227 |
prog |
228 |
in |
229 |
(* DFS with modular code generation *) |
230 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines generation@,"); |
231 |
let machine_code = Machine_code.translate_prog prog node_schs in |
232 |
|
233 |
Log.report ~level:2 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," |
234 |
(Utils.fprintf_list ~sep:"@ " Machine_code.pp_machine) |
235 |
machine_code); |
236 |
|
237 |
(* Optimize machine code *) |
238 |
let machine_code = |
239 |
if !Options.optimization >= 4 && !Options.output <> "horn" then |
240 |
begin |
241 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines optimization (phase 3)@,"); |
242 |
Optimize_machine.machines_cse machine_code |
243 |
end |
244 |
else |
245 |
machine_code |
246 |
in |
247 |
|
248 |
(* Optimize machine code *) |
249 |
let machine_code = |
250 |
if !Options.optimization >= 2 && !Options.output <> "horn" then |
251 |
begin |
252 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines optimization (phase 1)@,"); |
253 |
Optimize_machine.machines_unfold (Corelang.get_consts prog) node_schs machine_code |
254 |
end |
255 |
else |
256 |
machine_code |
257 |
in |
258 |
(* Optimize machine code *) |
259 |
let machine_code = |
260 |
if !Options.optimization >= 3 && !Options.output <> "horn" then |
261 |
begin |
262 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines optimization (phase 2)@,"); |
263 |
Optimize_machine.machines_fusion (Optimize_machine.machines_reuse_variables machine_code node_schs) |
264 |
end |
265 |
else |
266 |
machine_code |
267 |
in |
268 |
|
269 |
if !Options.optimization >= 2 then |
270 |
begin |
271 |
Log.report ~level:2 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," |
272 |
(Utils.fprintf_list ~sep:"@ " Machine_code.pp_machine) |
273 |
machine_code); |
274 |
end; |
275 |
|
276 |
Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," |
277 |
(Utils.fprintf_list ~sep:"@ " Machine_code.pp_machine) |
278 |
machine_code); |
279 |
|
280 |
(* Printing code *) |
281 |
let basename = Filename.basename basename in |
282 |
let destname = !Options.dest_dir ^ "/" ^ basename in |
283 |
let _ = match !Options.output with |
284 |
| "C" -> |
285 |
begin |
286 |
let alloc_header_file = destname ^ "_alloc.h" in (* Could be changed *) |
287 |
let source_lib_file = destname ^ ".c" in (* Could be changed *) |
288 |
let source_main_file = destname ^ "_main.c" in (* Could be changed *) |
289 |
let makefile_file = destname ^ ".makefile" in (* Could be changed *) |
290 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. C code generation@,"); |
291 |
C_backend.translate_to_c |
292 |
alloc_header_file source_lib_file source_main_file makefile_file |
293 |
basename prog machine_code dependencies |
294 |
end |
295 |
| "java" -> |
296 |
begin |
297 |
failwith "Sorry, but not yet supported !" |
298 |
(*let source_file = basename ^ ".java" in |
299 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. opening file %s@,@?" source_file); |
300 |
let source_out = open_out source_file in |
301 |
let source_fmt = formatter_of_out_channel source_out in |
302 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. java code generation@,@?"); |
303 |
Java_backend.translate_to_java source_fmt basename normalized_prog machine_code;*) |
304 |
end |
305 |
| "horn" -> |
306 |
begin |
307 |
let source_file = destname ^ ".smt2" in (* Could be changed *) |
308 |
let source_out = open_out source_file in |
309 |
let fmt = formatter_of_out_channel source_out in |
310 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. hornification@,"); |
311 |
Horn_backend.translate fmt basename prog machine_code; |
312 |
(* Tracability file if option is activated *) |
313 |
if !Options.traces then ( |
314 |
let traces_file = destname ^ ".traces.xml" in (* Could be changed *) |
315 |
let traces_out = open_out traces_file in |
316 |
let fmt = formatter_of_out_channel traces_out in |
317 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. tracing info@,"); |
318 |
Horn_backend.traces_file fmt basename prog machine_code; |
319 |
) |
320 |
end |
321 |
| "lustre" -> |
322 |
begin |
323 |
let source_file = destname ^ ".lustrec.lus" in (* Could be changed *) |
324 |
let source_out = open_out source_file in |
325 |
let fmt = formatter_of_out_channel source_out in |
326 |
Printers.pp_prog fmt prog; |
327 |
(* Lustre_backend.translate fmt basename normalized_prog machine_code *) |
328 |
() |
329 |
end |
330 |
|
331 |
| _ -> assert false |
332 |
in |
333 |
begin |
334 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. done @ @]@."); |
335 |
(* We stop the process here *) |
336 |
exit 0 |
337 |
end |
338 |
|
339 |
let compile dirname basename extension = |
340 |
match extension with |
341 |
| ".lusi" -> compile_header dirname basename extension |
342 |
| ".lus" -> compile_source dirname basename extension |
343 |
| _ -> assert false |
344 |
|
345 |
let anonymous filename = |
346 |
let ok_ext, ext = List.fold_left |
347 |
(fun (ok, ext) ext' -> |
348 |
if not ok && Filename.check_suffix filename ext' then |
349 |
true, ext' |
350 |
else |
351 |
ok, ext) |
352 |
(false, "") extensions in |
353 |
if ok_ext then |
354 |
let dirname = Filename.dirname filename in |
355 |
let basename = Filename.chop_suffix (Filename.basename filename) ext in |
356 |
compile dirname basename ext |
357 |
else |
358 |
raise (Arg.Bad ("Can only compile *.lusi, *.lus or *.ec files")) |
359 |
|
360 |
let _ = |
361 |
Corelang.add_internal_funs (); |
362 |
try |
363 |
Printexc.record_backtrace true; |
364 |
Arg.parse Options.options anonymous usage |
365 |
with |
366 |
| Parse.Syntax_err _ | Lexer_lustre.Error _ |
367 |
| Types.Error (_,_) | Clocks.Error (_,_) |
368 |
| Corelang.Error _ (*| Task_set.Error _*) |
369 |
| Causality.Cycle _ -> exit 1 |
370 |
| Sys_error msg -> (eprintf "Failure: %s@." msg) |
371 |
| exc -> (Utils.track_exception (); raise exc) |
372 |
|
373 |
(* Local Variables: *) |
374 |
(* compile-command:"make -C .." *) |
375 |
(* End: *) |