lustrec / src / main_lustre_compiler.ml @ 88486aaf
History | View | Annotate | Download (12.7 KB)
1 |
(* ---------------------------------------------------------------------------- |
---|---|
2 |
* SchedMCore - A MultiCore Scheduling Framework |
3 |
* Copyright (C) 2009-2013, ONERA, Toulouse, FRANCE - LIFL, Lille, FRANCE |
4 |
* Copyright (C) 2012-2013, INPT, Toulouse, FRANCE |
5 |
* |
6 |
* This file is part of Prelude |
7 |
* |
8 |
* Prelude is free software; you can redistribute it and/or |
9 |
* modify it under the terms of the GNU Lesser General Public License |
10 |
* as published by the Free Software Foundation ; either version 2 of |
11 |
* the License, or (at your option) any later version. |
12 |
* |
13 |
* Prelude is distributed in the hope that it will be useful, but |
14 |
* WITHOUT ANY WARRANTY ; without even the implied warranty of |
15 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
16 |
* Lesser General Public License for more details. |
17 |
* |
18 |
* You should have received a copy of the GNU Lesser General Public |
19 |
* License along with this program ; if not, write to the Free Software |
20 |
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 |
21 |
* USA |
22 |
*---------------------------------------------------------------------------- *) |
23 |
|
24 |
(* This module is used for the lustre to C compiler *) |
25 |
|
26 |
open Format |
27 |
open Log |
28 |
|
29 |
let usage = "Usage: lustrec [options] <source-file>" |
30 |
|
31 |
let extensions = [".ec"; ".lus"; ".lusi"] |
32 |
|
33 |
let check_stateless_decls decls = |
34 |
report ~level:1 (fun fmt -> fprintf fmt ".. checking stateless/stateful status@ "); |
35 |
try |
36 |
Stateless.check_prog decls |
37 |
with (Stateless.Error (loc, err)) as exc -> |
38 |
eprintf "Stateless status error %a%a@." |
39 |
Stateless.pp_error err |
40 |
Location.pp_loc loc; |
41 |
raise exc |
42 |
|
43 |
let type_decls env decls = |
44 |
report ~level:1 (fun fmt -> fprintf fmt ".. typing@ "); |
45 |
let new_env = |
46 |
begin |
47 |
try |
48 |
Typing.type_prog env decls |
49 |
with (Types.Error (loc,err)) as exc -> |
50 |
eprintf "Typing error %a%a@." |
51 |
Types.pp_error err |
52 |
Location.pp_loc loc; |
53 |
raise exc |
54 |
end |
55 |
in |
56 |
if !Options.print_types then |
57 |
report ~level:1 (fun fmt -> fprintf fmt "@[<v 2> %a@]@ " Corelang.pp_prog_type decls); |
58 |
new_env |
59 |
|
60 |
let clock_decls env decls = |
61 |
report ~level:1 (fun fmt -> fprintf fmt ".. clock calculus@ "); |
62 |
let new_env = |
63 |
begin |
64 |
try |
65 |
Clock_calculus.clock_prog env decls |
66 |
with (Clocks.Error (loc,err)) as exc -> |
67 |
eprintf "Clock calculus error %a%a@." Clocks.pp_error err Location.pp_loc loc; |
68 |
raise exc |
69 |
end |
70 |
in |
71 |
if !Options.print_clocks then |
72 |
report ~level:1 (fun fmt -> fprintf fmt "@[<v 2> %a@]@ " Corelang.pp_prog_clock decls); |
73 |
new_env |
74 |
|
75 |
(* Loading Lusi file and filling type tables with parsed |
76 |
functions/nodes *) |
77 |
let load_lusi own filename = |
78 |
Location.input_name := filename; |
79 |
let lexbuf = Lexing.from_channel (open_in filename) in |
80 |
Location.init lexbuf filename; |
81 |
(* Parsing *) |
82 |
report ~level:1 (fun fmt -> fprintf fmt ".. parsing header file %s@ " filename); |
83 |
try |
84 |
Parse.header own Parser_lustre.header Lexer_lustre.token lexbuf |
85 |
with |
86 |
| (Lexer_lustre.Error err) | (Parse.Syntax_err err) as exc -> |
87 |
Parse.report_error err; |
88 |
raise exc |
89 |
| Corelang.Error (loc, err) as exc -> ( |
90 |
eprintf "Parsing error %a%a@." |
91 |
Corelang.pp_error err |
92 |
Location.pp_loc loc; |
93 |
raise exc |
94 |
) |
95 |
|
96 |
|
97 |
let check_lusi header = |
98 |
let new_tenv = type_decls Basic_library.type_env header in (* Typing *) |
99 |
let new_cenv = clock_decls Basic_library.clock_env header in (* Clock calculus *) |
100 |
header, new_tenv, new_cenv |
101 |
|
102 |
|
103 |
let rec compile basename extension = |
104 |
(* Loading the input file *) |
105 |
let source_name = basename^extension in |
106 |
Location.input_name := source_name; |
107 |
let lexbuf = Lexing.from_channel (open_in source_name) in |
108 |
Location.init lexbuf source_name; |
109 |
(* Parsing *) |
110 |
report ~level:1 |
111 |
(fun fmt -> fprintf fmt "@[<v>.. parsing file %s@," source_name); |
112 |
let prog = |
113 |
try |
114 |
Parse.prog Parser_lustre.prog Lexer_lustre.token lexbuf |
115 |
with |
116 |
| (Lexer_lustre.Error err) | (Parse.Syntax_err err) as exc -> |
117 |
Parse.report_error err; |
118 |
raise exc |
119 |
| Corelang.Error (loc, err) as exc -> |
120 |
eprintf "Parsing error %a%a@." |
121 |
Corelang.pp_error err |
122 |
Location.pp_loc loc; |
123 |
raise exc |
124 |
in |
125 |
(* Extracting dependencies *) |
126 |
report ~level:1 (fun fmt -> fprintf fmt "@[<v 2>.. extracting dependencies@,"); |
127 |
let dependencies = |
128 |
List.fold_right |
129 |
(fun d accu -> match d.Corelang.top_decl_desc with |
130 |
| Corelang.Open (local, s) -> (s, local)::accu |
131 |
| _ -> accu) |
132 |
prog [] |
133 |
in |
134 |
let dependencies, type_env, clock_env = |
135 |
List.fold_left (fun (compilation_dep, type_env, clock_env) (s, local) -> |
136 |
try |
137 |
let basename = (if local then s else Version.prefix ^ "/include/lustrec/" ^ s ) ^ ".lusi" in |
138 |
report ~level:1 (fun fmt -> fprintf fmt "@[<v 0>Library %s@," basename); |
139 |
let comp_dep, lusi_type_env, lusi_clock_env = check_lusi (load_lusi false basename) in |
140 |
report ~level:1 (fun fmt -> fprintf fmt "@]@ "); |
141 |
|
142 |
(s, local, comp_dep)::compilation_dep, |
143 |
Env.overwrite type_env lusi_type_env, |
144 |
Env.overwrite clock_env lusi_clock_env |
145 |
with Sys_error msg -> ( |
146 |
eprintf "Failure: impossible to load library %s.@.%s@." s msg; |
147 |
exit 1 |
148 |
) |
149 |
) ([], Basic_library.type_env, Basic_library.clock_env) dependencies |
150 |
in |
151 |
report ~level:1 (fun fmt -> fprintf fmt "@]@ "); |
152 |
|
153 |
(* Unfold consts *) |
154 |
(*let prog = Corelang.prog_unfold_consts prog in*) |
155 |
|
156 |
(* Sorting nodes *) |
157 |
let prog = SortProg.sort prog in |
158 |
|
159 |
(* Typing *) |
160 |
let computed_types_env = type_decls type_env prog in |
161 |
|
162 |
(* Clock calculus *) |
163 |
let computed_clocks_env = clock_decls clock_env prog in |
164 |
|
165 |
(* Checking stateless/stateful status *) |
166 |
check_stateless_decls prog; |
167 |
|
168 |
(* Perform global inlining *) |
169 |
let prog = |
170 |
if !Options.global_inline && |
171 |
(match !Options.main_node with | "" -> false | _ -> true) then |
172 |
Inliner.global_inline basename prog type_env clock_env |
173 |
else |
174 |
prog |
175 |
in |
176 |
|
177 |
(* Delay calculus *) |
178 |
(* |
179 |
if(!Options.delay_calculus) |
180 |
then |
181 |
begin |
182 |
report ~level:1 (fun fmt -> fprintf fmt ".. initialisation analysis@?"); |
183 |
try |
184 |
Delay_calculus.delay_prog Basic_library.delay_env prog |
185 |
with (Delay.Error (loc,err)) as exc -> |
186 |
Location.print loc; |
187 |
eprintf "%a" Delay.pp_error err; |
188 |
Utils.track_exception (); |
189 |
raise exc |
190 |
end; |
191 |
*) |
192 |
(* |
193 |
eprintf "Causality analysis@.@?"; |
194 |
(* Causality analysis *) |
195 |
begin |
196 |
try |
197 |
Causality.check_causal_prog prog |
198 |
with (Causality.Cycle v) as exc -> |
199 |
Causality.pp_error err_formatter v; |
200 |
raise exc |
201 |
end; |
202 |
*) |
203 |
|
204 |
(* Checking the existence of a lusi (Lustre Interface file) *) |
205 |
let lusi_name = basename ^ ".lusi" in |
206 |
let _ = |
207 |
try |
208 |
let _ = open_in lusi_name in |
209 |
let header = load_lusi true lusi_name in |
210 |
let _, declared_types_env, declared_clocks_env = check_lusi header in |
211 |
|
212 |
(* checking type compatibility with computed types*) |
213 |
Typing.check_env_compat header declared_types_env computed_types_env; |
214 |
Typing.uneval_prog_generics prog; |
215 |
|
216 |
(* checking clocks compatibility with computed clocks*) |
217 |
Clock_calculus.check_env_compat header declared_clocks_env computed_clocks_env; |
218 |
Clock_calculus.uneval_prog_generics prog; |
219 |
|
220 |
(* checking stateless status compatibility *) |
221 |
Stateless.check_compat header |
222 |
with Sys_error _ -> ( |
223 |
(* Printing lusi file is necessary *) |
224 |
report ~level:1 |
225 |
(fun fmt -> |
226 |
fprintf fmt |
227 |
".. generating lustre interface file %s@," lusi_name); |
228 |
let lusi_out = open_out lusi_name in |
229 |
let lusi_fmt = formatter_of_out_channel lusi_out in |
230 |
Typing.uneval_prog_generics prog; |
231 |
Clock_calculus.uneval_prog_generics prog; |
232 |
Printers.pp_lusi_header lusi_fmt source_name prog |
233 |
) |
234 |
| (Types.Error (loc,err)) as exc -> |
235 |
eprintf "Type mismatch between computed type and declared type in lustre interface file: %a@." |
236 |
Types.pp_error err; |
237 |
raise exc |
238 |
| Clocks.Error (loc, err) as exc -> |
239 |
eprintf "Clock mismatch between computed clock and declared clock in lustre interface file: %a@." |
240 |
Clocks.pp_error err; |
241 |
raise exc |
242 |
| Stateless.Error (loc, err) as exc -> |
243 |
eprintf "Stateless status mismatch between defined status and declared status in lustre interface file: %a@." |
244 |
Stateless.pp_error err; |
245 |
raise exc |
246 |
in |
247 |
|
248 |
(* Computes and stores generic calls for each node, |
249 |
only useful for ANSI C90 compliant generic node compilation *) |
250 |
if !Options.ansi then Causality.NodeDep.compute_generic_calls prog; |
251 |
(*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;*) |
252 |
|
253 |
(* Normalization phase *) |
254 |
report ~level:1 (fun fmt -> fprintf fmt ".. normalization@,"); |
255 |
let normalized_prog = Normalization.normalize_prog prog in |
256 |
report ~level:2 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog normalized_prog); |
257 |
(* Checking array accesses *) |
258 |
if !Options.check then |
259 |
begin |
260 |
report ~level:1 (fun fmt -> fprintf fmt ".. array access checks@,"); |
261 |
Access.check_prog normalized_prog; |
262 |
end; |
263 |
|
264 |
(* Computation of node equation scheduling. It also break dependency cycles. *) |
265 |
let cycle_free_prog, node_schs = Scheduling.schedule_prog normalized_prog in |
266 |
|
267 |
(* DFS with modular code generation *) |
268 |
report ~level:1 (fun fmt -> fprintf fmt ".. machines generation@,"); |
269 |
let machine_code = Machine_code.translate_prog cycle_free_prog node_schs in |
270 |
report ~level:2 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," |
271 |
(Utils.fprintf_list ~sep:"@ " Machine_code.pp_machine) |
272 |
machine_code); |
273 |
|
274 |
(* Creating destination directory if needed *) |
275 |
if not (Sys.file_exists !Options.dest_dir) then ( |
276 |
report ~level:1 (fun fmt -> fprintf fmt ".. creating destination directory@,"); |
277 |
Unix.mkdir !Options.dest_dir (Unix.stat ".").Unix.st_perm |
278 |
); |
279 |
if (Unix.stat !Options.dest_dir).Unix.st_kind <> Unix.S_DIR then ( |
280 |
eprintf "Failure: destination %s is not a directory.@.@." !Options.dest_dir; |
281 |
exit 1 |
282 |
); |
283 |
(* Printing code *) |
284 |
let basename = Filename.basename basename in |
285 |
let destname = !Options.dest_dir ^ "/" ^ basename in |
286 |
let _ = match !Options.output with |
287 |
"C" -> |
288 |
begin |
289 |
let header_file = destname ^ ".h" in (* Could be changed *) |
290 |
let source_file = destname ^ ".c" in (* Could be changed *) |
291 |
let makefile_file = destname ^ ".makefile" in (* Could be changed *) |
292 |
let spec_file_opt = if !Options.c_spec then |
293 |
( |
294 |
let spec_file = basename ^ "_spec.c" in |
295 |
report ~level:1 (fun fmt -> fprintf fmt ".. opening files %s, %s and %s@," header_file source_file spec_file); |
296 |
Some spec_file |
297 |
) else ( |
298 |
report ~level:1 (fun fmt -> fprintf fmt ".. opening files %s and %s@," header_file source_file); |
299 |
None |
300 |
) |
301 |
in |
302 |
let header_out = open_out header_file in |
303 |
let header_fmt = formatter_of_out_channel header_out in |
304 |
let source_out = open_out source_file in |
305 |
let source_fmt = formatter_of_out_channel source_out in |
306 |
let makefile_out = open_out makefile_file in |
307 |
let makefile_fmt = formatter_of_out_channel makefile_out in |
308 |
let spec_fmt_opt = match spec_file_opt with |
309 |
None -> None |
310 |
| Some f -> Some (formatter_of_out_channel (open_out f)) |
311 |
in |
312 |
report ~level:1 (fun fmt -> fprintf fmt ".. C code generation@,"); |
313 |
C_backend.translate_to_c header_fmt source_fmt makefile_fmt spec_fmt_opt basename normalized_prog machine_code dependencies |
314 |
end |
315 |
| "java" -> |
316 |
begin |
317 |
failwith "Sorry, but not yet supported !" |
318 |
(*let source_file = basename ^ ".java" in |
319 |
report ~level:1 (fun fmt -> fprintf fmt ".. opening file %s@,@?" source_file); |
320 |
let source_out = open_out source_file in |
321 |
let source_fmt = formatter_of_out_channel source_out in |
322 |
report ~level:1 (fun fmt -> fprintf fmt ".. java code generation@,@?"); |
323 |
Java_backend.translate_to_java source_fmt basename normalized_prog machine_code;*) |
324 |
end |
325 |
| "horn" -> |
326 |
begin |
327 |
let source_file = destname ^ ".smt2" in (* Could be changed *) |
328 |
let source_out = open_out source_file in |
329 |
let fmt = formatter_of_out_channel source_out in |
330 |
Horn_backend.translate fmt basename normalized_prog machine_code |
331 |
end |
332 |
| _ -> assert false |
333 |
in |
334 |
report ~level:1 (fun fmt -> fprintf fmt ".. done !@ @]@."); |
335 |
(* We stop the process here *) |
336 |
exit 0 |
337 |
|
338 |
let anonymous filename = |
339 |
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 |
340 |
if ok_ext then |
341 |
let basename = Filename.chop_suffix filename ext in |
342 |
compile basename ext |
343 |
else |
344 |
raise (Arg.Bad ("Can only compile *.lusi, *.lus or *.ec files")) |
345 |
|
346 |
let _ = |
347 |
Corelang.add_internal_funs (); |
348 |
try |
349 |
Printexc.record_backtrace true; |
350 |
Arg.parse Options.options anonymous usage |
351 |
with |
352 |
| Parse.Syntax_err _ | Lexer_lustre.Error _ |
353 |
| Types.Error (_,_) | Clocks.Error (_,_) |
354 |
| Corelang.Error _ (*| Task_set.Error _*) |
355 |
| Causality.Cycle _ -> exit 1 |
356 |
| exc -> (Utils.track_exception (); raise exc) |
357 |
|
358 |
(* Local Variables: *) |
359 |
(* compile-command:"make -C .." *) |
360 |
(* End: *) |