lustrec / src / main_lustre_compiler.ml @ 01d48bb0
History | View | Annotate | Download (12.7 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 |
Lusic.check_lusic 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 |
(* compile a .lus source file *) |
89 |
let rec compile_source dirname basename extension = |
90 |
|
91 |
Log.report ~level:1 (fun fmt -> fprintf fmt "@[<v>"); |
92 |
|
93 |
(* Parsing source *) |
94 |
let prog = parse_source (dirname ^ "/" ^ basename ^ extension) in |
95 |
|
96 |
(* Removing automata *) |
97 |
let prog = Automata.expand_decls prog in |
98 |
|
99 |
(* Importing source *) |
100 |
let _ = Modules.load_program ISet.empty prog in |
101 |
|
102 |
(* Extracting dependencies *) |
103 |
let dependencies, type_env, clock_env = import_dependencies prog in |
104 |
|
105 |
(* Sorting nodes *) |
106 |
let prog = SortProg.sort prog in |
107 |
|
108 |
(* Perform inlining before any analysis *) |
109 |
let orig, prog = |
110 |
if !Options.global_inline && !Options.main_node <> "" then |
111 |
(if !Options.witnesses then prog else []), |
112 |
Inliner.global_inline basename prog type_env clock_env |
113 |
else (* if !Option.has_local_inline *) |
114 |
[], |
115 |
Inliner.local_inline basename prog type_env clock_env |
116 |
in |
117 |
|
118 |
(* Checking stateless/stateful status *) |
119 |
check_stateless_decls prog; |
120 |
|
121 |
(* Typing *) |
122 |
let computed_types_env = type_decls type_env prog in |
123 |
|
124 |
(* Clock calculus *) |
125 |
let computed_clocks_env = clock_decls clock_env prog in |
126 |
|
127 |
(* Generating a .lusi header file only *) |
128 |
if !Options.lusi then |
129 |
begin |
130 |
let lusi_ext = extension ^ "i" in |
131 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. generating interface file %s@," (dirname ^ "/" ^ basename ^ lusi_ext)); |
132 |
print_lusi prog dirname basename lusi_ext; |
133 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. done !@ @]@."); |
134 |
exit 0 |
135 |
end; |
136 |
|
137 |
(* Delay calculus *) |
138 |
(* TO BE DONE LATER (Xavier) |
139 |
if(!Options.delay_calculus) |
140 |
then |
141 |
begin |
142 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. initialisation analysis@?"); |
143 |
try |
144 |
Delay_calculus.delay_prog Basic_library.delay_env prog |
145 |
with (Delay.Error (loc,err)) as exc -> |
146 |
Location.print loc; |
147 |
eprintf "%a" Delay.pp_error err; |
148 |
Utils.track_exception (); |
149 |
raise exc |
150 |
end; |
151 |
*) |
152 |
|
153 |
(* Creating destination directory if needed *) |
154 |
create_dest_dir (); |
155 |
|
156 |
(* Compatibility with Lusi *) |
157 |
(* Checking the existence of a lusi (Lustre Interface file) *) |
158 |
let extension = ".lusi" in |
159 |
compile_source_to_header prog computed_types_env computed_clocks_env dirname basename extension; |
160 |
|
161 |
Typing.uneval_prog_generics prog; |
162 |
Clock_calculus.uneval_prog_generics prog; |
163 |
|
164 |
if !Options.global_inline && !Options.main_node <> "" && !Options.witnesses then |
165 |
begin |
166 |
let orig = Corelang.copy_prog orig in |
167 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. generating witness file !@,"); |
168 |
check_stateless_decls orig; |
169 |
let _ = Typing.type_prog type_env orig in |
170 |
let _ = Clock_calculus.clock_prog clock_env orig in |
171 |
Typing.uneval_prog_generics orig; |
172 |
Clock_calculus.uneval_prog_generics orig; |
173 |
Inliner.witness |
174 |
basename |
175 |
!Options.main_node |
176 |
orig prog type_env clock_env; |
177 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. done !@,"); |
178 |
end; |
179 |
|
180 |
(*Format.eprintf "Inliner.global_inline<<@.%a@.>>@." Printers.pp_prog prog;*) |
181 |
(* Computes and stores generic calls for each node, |
182 |
only useful for ANSI C90 compliant generic node compilation *) |
183 |
if !Options.ansi then Causality.NodeDep.compute_generic_calls prog; |
184 |
(*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;*) |
185 |
|
186 |
(* Normalization phase *) |
187 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. normalization@,"); |
188 |
(* Special treatment of arrows in lustre backend. We want to keep them *) |
189 |
if !Options.output = "lustre" then |
190 |
Normalization.unfold_arrow_active := false; |
191 |
let prog = Normalization.normalize_prog prog in |
192 |
|
193 |
Log.report ~level:2 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog); |
194 |
(* Checking array accesses *) |
195 |
if !Options.check then |
196 |
begin |
197 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. array access checks@,"); |
198 |
Access.check_prog prog; |
199 |
end; |
200 |
|
201 |
(* Computation of node equation scheduling. It also breaks dependency cycles |
202 |
and warns about unused input or memory variables *) |
203 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. scheduling@,"); |
204 |
let prog, node_schs = Scheduling.schedule_prog prog in |
205 |
Log.report ~level:1 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_warning_unused node_schs); |
206 |
Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_schedule node_schs); |
207 |
Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_fanin_table node_schs); |
208 |
Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog); |
209 |
|
210 |
(* Optimization of prog: |
211 |
- Unfold consts |
212 |
- eliminate trivial expressions |
213 |
*) |
214 |
let prog = |
215 |
if !Options.optimization >= 4 then |
216 |
begin |
217 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. constants elimination@,"); |
218 |
Optimize_prog.prog_unfold_consts prog |
219 |
end |
220 |
else |
221 |
prog |
222 |
in |
223 |
(* DFS with modular code generation *) |
224 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines generation@,"); |
225 |
let machine_code = Machine_code.translate_prog prog node_schs in |
226 |
|
227 |
(* Optimize machine code *) |
228 |
let machine_code = |
229 |
if !Options.optimization >= 2 && !Options.output <> "horn" then |
230 |
begin |
231 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines optimization (phase 1)@,"); |
232 |
Optimize_machine.machines_unfold (Corelang.get_consts prog) node_schs machine_code |
233 |
end |
234 |
else |
235 |
machine_code |
236 |
in |
237 |
(* Optimize machine code *) |
238 |
let machine_code = |
239 |
if !Options.optimization >= 3 && !Options.output <> "horn" then |
240 |
begin |
241 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines optimization (phase 2)@,"); |
242 |
Optimize_machine.machines_fusion (Optimize_machine.machines_reuse_variables machine_code node_schs) |
243 |
end |
244 |
else |
245 |
machine_code |
246 |
in |
247 |
Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," |
248 |
(Utils.fprintf_list ~sep:"@ " Machine_code.pp_machine) |
249 |
machine_code); |
250 |
|
251 |
(* Printing code *) |
252 |
let basename = Filename.basename basename in |
253 |
let destname = !Options.dest_dir ^ "/" ^ basename in |
254 |
let _ = match !Options.output with |
255 |
| "C" -> |
256 |
begin |
257 |
let alloc_header_file = destname ^ "_alloc.h" in (* Could be changed *) |
258 |
let source_lib_file = destname ^ ".c" in (* Could be changed *) |
259 |
let source_main_file = destname ^ "_main.c" in (* Could be changed *) |
260 |
let makefile_file = destname ^ ".makefile" in (* Could be changed *) |
261 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. C code generation@,"); |
262 |
C_backend.translate_to_c |
263 |
alloc_header_file source_lib_file source_main_file makefile_file |
264 |
basename prog machine_code dependencies |
265 |
end |
266 |
| "java" -> |
267 |
begin |
268 |
failwith "Sorry, but not yet supported !" |
269 |
(*let source_file = basename ^ ".java" in |
270 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. opening file %s@,@?" source_file); |
271 |
let source_out = open_out source_file in |
272 |
let source_fmt = formatter_of_out_channel source_out in |
273 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. java code generation@,@?"); |
274 |
Java_backend.translate_to_java source_fmt basename normalized_prog machine_code;*) |
275 |
end |
276 |
| "horn" -> |
277 |
begin |
278 |
let source_file = destname ^ ".smt2" in (* Could be changed *) |
279 |
let source_out = open_out source_file in |
280 |
let fmt = formatter_of_out_channel source_out in |
281 |
Horn_backend.translate fmt basename prog machine_code; |
282 |
(* Tracability file if option is activated *) |
283 |
if !Options.traces then ( |
284 |
let traces_file = destname ^ ".traces.xml" in (* Could be changed *) |
285 |
let traces_out = open_out traces_file in |
286 |
let fmt = formatter_of_out_channel traces_out in |
287 |
Horn_backend.traces_file fmt basename prog machine_code; |
288 |
) |
289 |
end |
290 |
| "lustre" -> |
291 |
begin |
292 |
let source_file = destname ^ ".lustrec.lus" in (* Could be changed *) |
293 |
let source_out = open_out source_file in |
294 |
let fmt = formatter_of_out_channel source_out in |
295 |
Printers.pp_prog fmt prog; |
296 |
(* Lustre_backend.translate fmt basename normalized_prog machine_code *) |
297 |
() |
298 |
end |
299 |
|
300 |
| _ -> assert false |
301 |
in |
302 |
begin |
303 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. done !@ @]@."); |
304 |
(* We stop the process here *) |
305 |
exit 0 |
306 |
end |
307 |
|
308 |
let compile dirname basename extension = |
309 |
match extension with |
310 |
| ".lusi" -> compile_header dirname basename extension |
311 |
| ".lus" -> compile_source dirname basename extension |
312 |
| _ -> assert false |
313 |
|
314 |
let anonymous filename = |
315 |
let ok_ext, ext = List.fold_left |
316 |
(fun (ok, ext) ext' -> |
317 |
if not ok && Filename.check_suffix filename ext' then |
318 |
true, ext' |
319 |
else |
320 |
ok, ext) |
321 |
(false, "") extensions in |
322 |
if ok_ext then |
323 |
let dirname = Filename.dirname filename in |
324 |
let basename = Filename.chop_suffix (Filename.basename filename) ext in |
325 |
compile dirname basename ext |
326 |
else |
327 |
raise (Arg.Bad ("Can only compile *.lusi, *.lus or *.ec files")) |
328 |
|
329 |
let _ = |
330 |
Corelang.add_internal_funs (); |
331 |
try |
332 |
Printexc.record_backtrace true; |
333 |
Arg.parse Options.options anonymous usage |
334 |
with |
335 |
| Parse.Syntax_err _ | Lexer_lustre.Error _ |
336 |
| Types.Error (_,_) | Clocks.Error (_,_) |
337 |
| Corelang.Error _ (*| Task_set.Error _*) |
338 |
| Causality.Cycle _ -> exit 1 |
339 |
| Sys_error msg -> (eprintf "Failure: %s@." msg) |
340 |
| exc -> (Utils.track_exception (); raise exc) |
341 |
|
342 |
(* Local Variables: *) |
343 |
(* compile-command:"make -C .." *) |
344 |
(* End: *) |