lustrec / src / main_lustre_compiler.ml @ 45c13277
History | View | Annotate | Download (13.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 LustreSpec |
16 |
|
17 |
let usage = "Usage: lustrec [options] <source-file>" |
18 |
|
19 |
let extensions = [".ec"; ".lus"; ".lusi"] |
20 |
|
21 |
let check_stateless_decls decls = |
22 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. checking stateless/stateful status@ "); |
23 |
try |
24 |
Stateless.check_prog decls |
25 |
with (Stateless.Error (loc, err)) as exc -> |
26 |
eprintf "Stateless status error %a%a@." |
27 |
Stateless.pp_error err |
28 |
Location.pp_loc loc; |
29 |
raise exc |
30 |
|
31 |
let type_decls env decls = |
32 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. typing@ "); |
33 |
let new_env = |
34 |
begin |
35 |
try |
36 |
Typing.type_prog env decls |
37 |
with (Types.Error (loc,err)) as exc -> |
38 |
eprintf "Typing error %a%a@." |
39 |
Types.pp_error err |
40 |
Location.pp_loc loc; |
41 |
raise exc |
42 |
end |
43 |
in |
44 |
if !Options.print_types then |
45 |
Log.report ~level:1 (fun fmt -> fprintf fmt "@[<v 2> %a@]@ " Corelang.pp_prog_type decls); |
46 |
new_env |
47 |
|
48 |
let clock_decls env decls = |
49 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. clock calculus@ "); |
50 |
let new_env = |
51 |
begin |
52 |
try |
53 |
Clock_calculus.clock_prog env decls |
54 |
with (Clocks.Error (loc,err)) as exc -> |
55 |
eprintf "Clock calculus error %a%a@." Clocks.pp_error err Location.pp_loc loc; |
56 |
raise exc |
57 |
end |
58 |
in |
59 |
if !Options.print_clocks then |
60 |
Log.report ~level:1 (fun fmt -> fprintf fmt "@[<v 2> %a@]@ " Corelang.pp_prog_clock decls); |
61 |
new_env |
62 |
|
63 |
(* Loading Lusi file and filling type tables with parsed |
64 |
functions/nodes *) |
65 |
let load_lusi own filename = |
66 |
Location.input_name := filename; |
67 |
let lexbuf = Lexing.from_channel (open_in filename) in |
68 |
Location.init lexbuf filename; |
69 |
(* Parsing *) |
70 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. parsing header file %s@ " filename); |
71 |
try |
72 |
Parse.header own Parser_lustre.header Lexer_lustre.token lexbuf |
73 |
with |
74 |
| (Lexer_lustre.Error err) | (Parse.Syntax_err err) as exc -> |
75 |
Parse.report_error err; |
76 |
raise exc |
77 |
| Corelang.Error (loc, err) as exc -> ( |
78 |
eprintf "Parsing error %a%a@." |
79 |
Corelang.pp_error err |
80 |
Location.pp_loc loc; |
81 |
raise exc |
82 |
) |
83 |
|
84 |
|
85 |
let check_lusi header = |
86 |
let new_tenv = type_decls Basic_library.type_env header in (* Typing *) |
87 |
let new_cenv = clock_decls Basic_library.clock_env header in (* Clock calculus *) |
88 |
header, new_tenv, new_cenv |
89 |
|
90 |
let load_n_check_lusi source_name lusi_name prog computed_types_env computed_clocks_env= |
91 |
try |
92 |
let _ = open_in lusi_name in |
93 |
let header = load_lusi true lusi_name in |
94 |
let _, declared_types_env, declared_clocks_env = check_lusi header in |
95 |
|
96 |
|
97 |
(* checking type compatibility with computed types*) |
98 |
Typing.check_env_compat header declared_types_env computed_types_env; |
99 |
Typing.uneval_prog_generics prog; |
100 |
|
101 |
(* checking clocks compatibility with computed clocks*) |
102 |
Clock_calculus.check_env_compat header declared_clocks_env computed_clocks_env; |
103 |
Clock_calculus.uneval_prog_generics prog; |
104 |
|
105 |
(* checking stateless status compatibility *) |
106 |
Stateless.check_compat header |
107 |
|
108 |
with Sys_error _ -> ( |
109 |
(* Printing lusi file is necessary *) |
110 |
Log.report ~level:1 |
111 |
(fun fmt -> |
112 |
fprintf fmt |
113 |
".. generating lustre interface file %s@," lusi_name); |
114 |
let lusi_out = open_out lusi_name in |
115 |
let lusi_fmt = formatter_of_out_channel lusi_out in |
116 |
Typing.uneval_prog_generics prog; |
117 |
Clock_calculus.uneval_prog_generics prog; |
118 |
Printers.pp_lusi_header lusi_fmt source_name prog |
119 |
) |
120 |
| (Types.Error (loc,err)) as exc -> |
121 |
eprintf "Type mismatch between computed type and declared type in lustre interface file: %a@." |
122 |
Types.pp_error err; |
123 |
raise exc |
124 |
| Clocks.Error (loc, err) as exc -> |
125 |
eprintf "Clock mismatch between computed clock and declared clock in lustre interface file: %a@." |
126 |
Clocks.pp_error err; |
127 |
raise exc |
128 |
| Stateless.Error (loc, err) as exc -> |
129 |
eprintf "Stateless status mismatch between defined status and declared status in lustre interface file: %a@." |
130 |
Stateless.pp_error err; |
131 |
raise exc |
132 |
|
133 |
let rec compile basename extension = |
134 |
|
135 |
(* Loading the input file *) |
136 |
let source_name = basename^extension in |
137 |
Location.input_name := source_name; |
138 |
let lexbuf = Lexing.from_channel (open_in source_name) in |
139 |
Location.init lexbuf source_name; |
140 |
|
141 |
(* Parsing *) |
142 |
Log.report ~level:1 |
143 |
(fun fmt -> fprintf fmt "@[<v>.. parsing file %s@," source_name); |
144 |
let prog = |
145 |
try |
146 |
Parse.prog Parser_lustre.prog Lexer_lustre.token lexbuf |
147 |
with |
148 |
| (Lexer_lustre.Error err) | (Parse.Syntax_err err) as exc -> |
149 |
Parse.report_error err; |
150 |
raise exc |
151 |
| Corelang.Error (loc, err) as exc -> |
152 |
eprintf "Parsing error %a%a@." |
153 |
Corelang.pp_error err |
154 |
Location.pp_loc loc; |
155 |
raise exc |
156 |
in |
157 |
|
158 |
(* Extracting dependencies *) |
159 |
Log.report ~level:1 (fun fmt -> fprintf fmt "@[<v 2>.. extracting dependencies@,"); |
160 |
let dependencies = |
161 |
List.fold_right |
162 |
(fun d accu -> match d.top_decl_desc with |
163 |
| Open (local, s) -> (s, local)::accu |
164 |
| _ -> accu) |
165 |
prog [] |
166 |
in |
167 |
let dependencies, type_env, clock_env = |
168 |
List.fold_left (fun (compilation_dep, type_env, clock_env) (s, local) -> |
169 |
try |
170 |
let basename = (if local then s else Version.prefix ^ "/include/lustrec/" ^ s ) ^ ".lusi" in |
171 |
Log.report ~level:1 (fun fmt -> fprintf fmt "@[<v 0>Library %s@," basename); |
172 |
let comp_dep, lusi_type_env, lusi_clock_env = check_lusi (load_lusi false basename) in |
173 |
Log.report ~level:1 (fun fmt -> fprintf fmt "@]@ "); |
174 |
|
175 |
(s, local, comp_dep)::compilation_dep, |
176 |
Env.overwrite type_env lusi_type_env, |
177 |
Env.overwrite clock_env lusi_clock_env |
178 |
with Sys_error msg -> ( |
179 |
eprintf "Failure: impossible to load library %s.@.%s@." s msg; |
180 |
exit 1 |
181 |
) |
182 |
) ([], Basic_library.type_env, Basic_library.clock_env) dependencies |
183 |
in |
184 |
Log.report ~level:1 (fun fmt -> fprintf fmt "@]@ "); |
185 |
|
186 |
(* Sorting nodes *) |
187 |
let prog = SortProg.sort prog in |
188 |
|
189 |
(* Typing *) |
190 |
let computed_types_env = type_decls type_env prog in |
191 |
|
192 |
(* Clock calculus *) |
193 |
let computed_clocks_env = clock_decls clock_env prog in |
194 |
|
195 |
(* Checking stateless/stateful status *) |
196 |
check_stateless_decls prog; |
197 |
|
198 |
(* Perform global inlining *) |
199 |
let prog = |
200 |
if !Options.global_inline && |
201 |
(match !Options.main_node with | "" -> false | _ -> true) then |
202 |
Inliner.global_inline basename prog type_env clock_env |
203 |
else |
204 |
prog |
205 |
in |
206 |
|
207 |
(* Delay calculus *) |
208 |
(* |
209 |
if(!Options.delay_calculus) |
210 |
then |
211 |
begin |
212 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. initialisation analysis@?"); |
213 |
try |
214 |
Delay_calculus.delay_prog Basic_library.delay_env prog |
215 |
with (Delay.Error (loc,err)) as exc -> |
216 |
Location.print loc; |
217 |
eprintf "%a" Delay.pp_error err; |
218 |
Utils.track_exception (); |
219 |
raise exc |
220 |
end; |
221 |
*) |
222 |
(* |
223 |
eprintf "Causality analysis@.@?"; |
224 |
(* Causality analysis *) |
225 |
begin |
226 |
try |
227 |
Causality.check_causal_prog prog |
228 |
with (Causality.Cycle v) as exc -> |
229 |
Causality.pp_error err_formatter v; |
230 |
raise exc |
231 |
end; |
232 |
*) |
233 |
|
234 |
(* Compatibility with Lusi *) |
235 |
(* Checking the existence of a lusi (Lustre Interface file) *) |
236 |
let lusi_name = basename ^ ".lusi" in |
237 |
load_n_check_lusi source_name lusi_name prog computed_types_env computed_clocks_env; |
238 |
|
239 |
(* Computes and stores generic calls for each node, |
240 |
only useful for ANSI C90 compliant generic node compilation *) |
241 |
if !Options.ansi then Causality.NodeDep.compute_generic_calls prog; |
242 |
(*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;*) |
243 |
|
244 |
(* Normalization phase *) |
245 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. normalization@,"); |
246 |
(* Special treatment of arrows in lustre backend. We want to keep them *) |
247 |
if !Options.output = "lustre" then |
248 |
Normalization.unfold_arrow_active := false; |
249 |
let prog = Normalization.normalize_prog prog in |
250 |
Log.report ~level:2 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog); |
251 |
|
252 |
(* Checking array accesses *) |
253 |
if !Options.check then |
254 |
begin |
255 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. array access checks@,"); |
256 |
Access.check_prog prog; |
257 |
end; |
258 |
|
259 |
(* Computation of node equation scheduling. It also breaks dependency cycles |
260 |
and warns about unused input or memory variables *) |
261 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. scheduling@,"); |
262 |
let prog, node_schs = Scheduling.schedule_prog prog in |
263 |
Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_warning_unused node_schs); |
264 |
Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_schedule node_schs); |
265 |
Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_fanin_table node_schs); |
266 |
Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog); |
267 |
|
268 |
(* Optimization of prog: |
269 |
- Unfold consts |
270 |
- eliminate trivial expressions |
271 |
*) |
272 |
let prog = |
273 |
if !Options.optimization >= 2 then |
274 |
Optimize_prog.prog_unfold_consts prog |
275 |
else |
276 |
prog |
277 |
in |
278 |
|
279 |
(* DFS with modular code generation *) |
280 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines generation@,"); |
281 |
let machine_code = Machine_code.translate_prog prog node_schs in |
282 |
|
283 |
(* Optimize machine code *) |
284 |
let machine_code = |
285 |
if !Options.optimization >= 3 then |
286 |
begin |
287 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines optimization@,"); |
288 |
Optimize_machine.machines_reuse_variables machine_code node_schs |
289 |
end |
290 |
else |
291 |
machine_code |
292 |
in |
293 |
Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," |
294 |
(Utils.fprintf_list ~sep:"@ " Machine_code.pp_machine) |
295 |
machine_code); |
296 |
|
297 |
(* Creating destination directory if needed *) |
298 |
if not (Sys.file_exists !Options.dest_dir) then ( |
299 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. creating destination directory@,"); |
300 |
Unix.mkdir !Options.dest_dir (Unix.stat ".").Unix.st_perm |
301 |
); |
302 |
if (Unix.stat !Options.dest_dir).Unix.st_kind <> Unix.S_DIR then ( |
303 |
eprintf "Failure: destination %s is not a directory.@.@." !Options.dest_dir; |
304 |
exit 1 |
305 |
); |
306 |
(* Printing code *) |
307 |
let basename = Filename.basename basename in |
308 |
let destname = !Options.dest_dir ^ "/" ^ basename in |
309 |
let _ = match !Options.output with |
310 |
"C" -> |
311 |
begin |
312 |
let header_file = destname ^ ".h" in (* Could be changed *) |
313 |
let source_lib_file = destname ^ ".c" in (* Could be changed *) |
314 |
let source_main_file = destname ^ "_main.c" in (* Could be changed *) |
315 |
let makefile_file = destname ^ ".makefile" in (* Could be changed *) |
316 |
(* let spec_file_opt = if !Options.c_spec then *) |
317 |
(* ( *) |
318 |
(* let spec_file = basename ^ "_spec.c" in *) |
319 |
(* Log.report ~level:1 (fun fmt -> fprintf fmt ".. opening files %s, %s and %s@," header_file source_file spec_file); *) |
320 |
(* Some spec_file *) |
321 |
(* ) else ( *) |
322 |
(* Log.report ~level:1 (fun fmt -> fprintf fmt ".. opening files %s and %s@," header_file source_file); *) |
323 |
(* None *) |
324 |
(* ) *) |
325 |
(* in *) |
326 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. C code generation@,"); |
327 |
C_backend.translate_to_c |
328 |
header_file source_lib_file source_main_file makefile_file |
329 |
basename prog machine_code dependencies |
330 |
end |
331 |
| "java" -> |
332 |
begin |
333 |
failwith "Sorry, but not yet supported !" |
334 |
(*let source_file = basename ^ ".java" in |
335 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. opening file %s@,@?" source_file); |
336 |
let source_out = open_out source_file in |
337 |
let source_fmt = formatter_of_out_channel source_out in |
338 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. java code generation@,@?"); |
339 |
Java_backend.translate_to_java source_fmt basename normalized_prog machine_code;*) |
340 |
end |
341 |
| "horn" -> |
342 |
begin |
343 |
let source_file = destname ^ ".smt2" in (* Could be changed *) |
344 |
let source_out = open_out source_file in |
345 |
let fmt = formatter_of_out_channel source_out in |
346 |
Horn_backend.translate fmt basename prog machine_code; |
347 |
(* Tracability file if option is activated *) |
348 |
if !Options.horntraces then ( |
349 |
let traces_file = destname ^ ".traces" in (* Could be changed *) |
350 |
let traces_out = open_out traces_file in |
351 |
let fmt = formatter_of_out_channel traces_out in |
352 |
Horn_backend.traces_file fmt basename prog machine_code |
353 |
) |
354 |
end |
355 |
| "lustre" -> |
356 |
begin |
357 |
let source_file = destname ^ ".lustrec.lus" in (* Could be changed *) |
358 |
let source_out = open_out source_file in |
359 |
let fmt = formatter_of_out_channel source_out in |
360 |
Printers.pp_prog fmt prog; |
361 |
(* Lustre_backend.translate fmt basename normalized_prog machine_code *) |
362 |
() |
363 |
end |
364 |
|
365 |
| _ -> assert false |
366 |
in |
367 |
Log.report ~level:1 (fun fmt -> fprintf fmt ".. done !@ @]@."); |
368 |
(* We stop the process here *) |
369 |
exit 0 |
370 |
|
371 |
let anonymous filename = |
372 |
let ok_ext, ext = List.fold_left (fun (ok, ext) ext' -> if not ok && Filename.check_suffix filename ext' then true, ext' else ok, ext) (false, "") extensions in |
373 |
if ok_ext then |
374 |
let basename = Filename.chop_suffix filename ext in |
375 |
compile basename ext |
376 |
else |
377 |
raise (Arg.Bad ("Can only compile *.lusi, *.lus or *.ec files")) |
378 |
|
379 |
let _ = |
380 |
Corelang.add_internal_funs (); |
381 |
try |
382 |
Printexc.record_backtrace true; |
383 |
Arg.parse Options.options anonymous usage |
384 |
with |
385 |
| Parse.Syntax_err _ | Lexer_lustre.Error _ |
386 |
| Types.Error (_,_) | Clocks.Error (_,_) |
387 |
| Corelang.Error _ (*| Task_set.Error _*) |
388 |
| Causality.Cycle _ -> exit 1 |
389 |
| exc -> (Utils.track_exception (); raise exc) |
390 |
|
391 |
(* Local Variables: *) |
392 |
(* compile-command:"make -C .." *) |
393 |
(* End: *) |