Project

General

Profile

Statistics
| Branch: | Tag: | Revision:

lustrec / src / main_lustre_compiler.ml @ 29f59e36

History | View | Annotate | Download (12.6 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 basename extension =
25
  let header = Lusic.extract_header basename prog in
26
  let header_name = 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
    Printers.pp_lusi_header h_fmt basename header;
31
    close_out h_out
32
  end
33

    
34
(* compile a .lusi header file *)
35
let compile_header dirname  basename extension =
36
  let destname = !Options.dest_dir ^ "/" ^ basename in
37
  let header_name = basename ^ extension in
38
  let lusic_ext = extension ^ "c" in
39
  begin
40
    Log.report ~level:1 (fun fmt -> fprintf fmt "@[<v>");
41
    let header = parse_header true (dirname ^ "/" ^ header_name) in
42
    ignore (Modules.load_header ISet.empty header);
43
    ignore (check_top_decls header);
44
    create_dest_dir ();
45
    Log.report ~level:1 
46
      (fun fmt -> fprintf fmt ".. generating compiled header file %sc@," (destname ^ extension));
47
    Lusic.write_lusic true header destname lusic_ext;
48
    Lusic.print_lusic_to_h destname lusic_ext;
49
    Log.report ~level:1 (fun fmt -> fprintf fmt ".. done !@ @]@.")
50
  end
51

    
52
(* check whether a source file has a compiled header,
53
   if not, generate the compiled header *)
54
let compile_source_to_header prog computed_types_env computed_clocks_env basename extension =
55
  let destname = !Options.dest_dir ^ "/" ^ basename in
56
  let lusic_ext = extension ^ "c" in
57
  let header_name = destname ^ lusic_ext in
58
  begin
59
    if not (Sys.file_exists header_name) then
60
      begin
61
	Log.report ~level:1 (fun fmt -> fprintf fmt ".. generating compiled header file %s@," header_name);
62
	Lusic.write_lusic false (Lusic.extract_header basename prog) destname lusic_ext;
63
	Lusic.print_lusic_to_h destname lusic_ext
64
      end
65
    else
66
      let lusic = Lusic.read_lusic destname lusic_ext in
67
      if not lusic.Lusic.from_lusi then
68
	begin
69
	  Log.report ~level:1 (fun fmt -> fprintf fmt ".. generating compiled header file %s@," header_name);
70
       	  Lusic.write_lusic false (Lusic.extract_header basename prog) destname lusic_ext;
71
(*List.iter (fun top_decl -> Format.eprintf "lusic: %a@." Printers.pp_decl top_decl) lusic.Lusic.contents;*)
72
	  Lusic.print_lusic_to_h destname lusic_ext
73
	end
74
      else
75
	begin
76
	  Log.report ~level:1 (fun fmt -> fprintf fmt ".. loading compiled header file %s@," header_name);
77
	  let header = lusic.Lusic.contents in
78
	  let (declared_types_env, declared_clocks_env) = get_envs_from_top_decls header in
79
	  check_compatibility
80
	    (prog, computed_types_env, computed_clocks_env)
81
	    (header, declared_types_env, declared_clocks_env)
82
	end
83
  end
84

    
85
(* compile a .lus source file *)
86
let rec compile_source dirname basename extension =
87
  let source_name = (*dirname ^ "/" ^ *) basename ^ extension in
88

    
89
  Log.report ~level:1 (fun fmt -> fprintf fmt "@[<v>");
90

    
91
  (* Parsing source *)
92
  let prog = parse_source source_name in
93

    
94
  (* Removing automata *) 
95
  let prog = Automata.expand_decls prog in
96

    
97
  (* Importing source *)
98
  let _ = Modules.load_program ISet.empty prog in
99

    
100
  (* Extracting dependencies *)
101
  let dependencies, type_env, clock_env = import_dependencies prog in
102

    
103
  (* Sorting nodes *)
104
  let prog = SortProg.sort prog in
105

    
106
  (* Typing *)
107
  let computed_types_env = type_decls type_env prog in
108
  
109
  (* Clock calculus *)
110
  let computed_clocks_env = clock_decls clock_env prog in
111

    
112
  (* Checking stateless/stateful status *)
113
  check_stateless_decls prog;
114

    
115
  (* Generating a .lusi header file only *)
116
  if !Options.lusi then
117
    begin
118
      let lusi_ext = extension ^ "i" in
119
      Log.report ~level:1 (fun fmt -> fprintf fmt ".. generating interface file %s@," (basename ^ lusi_ext));
120
      print_lusi prog basename lusi_ext;
121
      Log.report ~level:1 (fun fmt -> fprintf fmt ".. done !@ @]@.");
122
      exit 0
123
    end;
124

    
125
  (* Perform global inlining *)
126
  let prog =
127
    if !Options.global_inline && 
128
      (match !Options.main_node with | "" -> false | _ -> true) then
129
      Inliner.global_inline basename prog type_env clock_env
130
    else
131
      prog
132
  in
133

    
134
  (* Delay calculus *)
135
  (*
136
    if(!Options.delay_calculus)
137
    then
138
    begin
139
    Log.report ~level:1 (fun fmt -> fprintf fmt ".. initialisation analysis@?");
140
    try
141
    Delay_calculus.delay_prog Basic_library.delay_env prog
142
    with (Delay.Error (loc,err)) as exc ->
143
    Location.print loc;
144
    eprintf "%a" Delay.pp_error err;
145
    Utils.track_exception ();
146
    raise exc
147
    end;
148
  *)
149
  (*
150
    eprintf "Causality analysis@.@?";
151
    (* Causality analysis *)
152
    begin
153
    try
154
    Causality.check_causal_prog prog
155
    with (Causality.Cycle v) as exc ->
156
    Causality.pp_error err_formatter v;
157
    raise exc
158
    end;
159
  *)
160

    
161
  (* Creating destination directory if needed *)
162
  create_dest_dir ();
163

    
164
  (* Compatibility with Lusi *)
165
  (* Checking the existence of a lusi (Lustre Interface file) *)
166
  let extension = ".lusi" in
167
  compile_source_to_header prog computed_types_env computed_clocks_env basename extension;
168

    
169
  Typing.uneval_prog_generics prog;
170
  Clock_calculus.uneval_prog_generics prog;
171

    
172
  (* Computes and stores generic calls for each node,
173
     only useful for ANSI C90 compliant generic node compilation *)
174
  if !Options.ansi then Causality.NodeDep.compute_generic_calls prog;
175
  (*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;*)
176

    
177
  if !Options.scopes_mode then (
178
    if !Options.main_node = "" then failwith "Main node is required for scopes option";
179
    Scopes.compute_all_scopes prog;
180
    (* Printing scopes *)
181
    if !Options.show_scopes then (
182
      Format.printf "Possible scopes are:@.%a@."
183
	Scopes.print_all_scopes ();
184
      exit 0;
185
    );
186
  );
187

    
188
  (* Normalization phase *)
189
  Log.report ~level:1 (fun fmt -> fprintf fmt ".. normalization@,");
190
  (* Special treatment of arrows in lustre backend. We want to keep them *)
191
  if !Options.output = "lustre" then
192
    Normalization.unfold_arrow_active := false;
193
  let prog = Normalization.normalize_prog prog in
194
  Log.report ~level:2 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog);
195
  (* Checking array accesses *)
196
  if !Options.check then
197
    begin
198
      Log.report ~level:1 (fun fmt -> fprintf fmt ".. array access checks@,");
199
      Access.check_prog prog;
200
    end;
201

    
202
  (* Computation of node equation scheduling. It also breaks dependency cycles
203
     and warns about unused input or memory variables *)
204
  Log.report ~level:1 (fun fmt -> fprintf fmt ".. scheduling@,@?");
205
  let prog, node_schs = Scheduling.schedule_prog prog in
206
  Log.report ~level:1 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_warning_unused node_schs);
207
  Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_schedule node_schs);
208
  Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_fanin_table node_schs);
209
  Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog);
210

    
211
 (* Optimization of prog: 
212
    - Unfold consts 
213
    - eliminate trivial expressions
214
 *)
215
  let prog = 
216
    if !Options.optimization >= 4 then 
217
      Optimize_prog.prog_unfold_consts prog 
218
    else
219
      prog
220
  in
221
  (* DFS with modular code generation *)
222
  Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines generation@,");
223
  let machine_code = Machine_code.translate_prog prog node_schs in
224

    
225
  (* Optimize machine code *)
226
  let machine_code = 
227
    if !Options.optimization >= 2 && !Options.output <> "horn" then
228
      begin
229
	Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines optimization (phase 1)@,");
230
	Optimize_machine.machines_unfold (Corelang.get_consts prog) node_schs machine_code
231
      end
232
    else
233
      machine_code
234
 in  
235
  (* Optimize machine code *)
236
  let machine_code = 
237
    if !Options.optimization >= 3 && !Options.output <> "horn" then
238
      begin
239
	Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines optimization (phase 2)@,");
240
	Optimize_machine.machines_fusion (Optimize_machine.machines_reuse_variables machine_code node_schs)
241
      end
242
    else
243
      machine_code
244
 in
245
  Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@,"
246
  (Utils.fprintf_list ~sep:"@ " Machine_code.pp_machine)
247
  machine_code);
248

    
249
  if !Options.scopes_mode then (
250
    Scopes.check_scopes prog machine_code  
251
  );
252

    
253
  (* Printing code *)
254
  let basename    =  Filename.basename basename in
255
  let destname = !Options.dest_dir ^ "/" ^ basename in
256
  let _ = match !Options.output with
257
      "C" -> 
258
	begin
259
	  let alloc_header_file = destname ^ "_alloc.h" in (* Could be changed *)
260
	  let source_lib_file = destname ^ ".c" in (* Could be changed *)
261
	  let source_main_file = destname ^ "_main.c" in (* Could be changed *)
262
	  let makefile_file = destname ^ ".makefile" in (* Could be changed *)
263
	  Log.report ~level:1 (fun fmt -> fprintf fmt ".. C code generation@,");
264
	  C_backend.translate_to_c 
265
	    alloc_header_file source_lib_file source_main_file makefile_file
266
	    basename prog machine_code dependencies
267
	end
268
    | "java" ->
269
      begin
270
	failwith "Sorry, but not yet supported !"
271
    (*let source_file = basename ^ ".java" in
272
      Log.report ~level:1 (fun fmt -> fprintf fmt ".. opening file %s@,@?" source_file);
273
      let source_out = open_out source_file in
274
      let source_fmt = formatter_of_out_channel source_out in
275
      Log.report ~level:1 (fun fmt -> fprintf fmt ".. java code generation@,@?");
276
      Java_backend.translate_to_java source_fmt basename normalized_prog machine_code;*)
277
      end
278
    | "horn" ->
279
      begin
280
	let source_file = destname ^ ".smt2" in (* Could be changed *)
281
	let source_out = open_out source_file in
282
	let fmt = formatter_of_out_channel source_out in
283
	Horn_backend.translate fmt basename prog machine_code;
284
	(* Tracability file if option is activated *)
285
	if !Options.horntraces then (
286
	let traces_file = destname ^ ".traces" in (* Could be changed *)
287
	let traces_out = open_out traces_file in
288
	let fmt = formatter_of_out_channel traces_out in
289
	Horn_backend.traces_file fmt basename prog machine_code	  
290
	)
291
      end
292
    | "lustre" -> 
293
      begin
294
	let source_file = destname ^ ".lustrec.lus" in (* Could be changed *)
295
	let source_out = open_out source_file in
296
	let fmt = formatter_of_out_channel source_out in
297
	Printers.pp_prog fmt prog;
298
(*	Lustre_backend.translate fmt basename normalized_prog machine_code *)
299
	()
300
      end
301

    
302
    | _ -> assert false
303
  in
304
  begin
305
    Log.report ~level:1 (fun fmt -> fprintf fmt ".. done !@ @]@.");
306
  (* We stop the process here *)
307
    exit 0
308
  end
309

    
310
let compile dirname basename extension =
311
  match extension with
312
  | ".lusi"  -> compile_header dirname basename extension
313
  | ".lus"   -> compile_source dirname basename extension
314
  | _        -> assert false
315

    
316
let anonymous filename =
317
  let ok_ext, ext = List.fold_left 
318
    (fun (ok, ext) ext' -> 
319
      if not ok && Filename.check_suffix filename ext' then 
320
	true, ext' 
321
      else
322
	ok, ext) 
323
    (false, "") extensions in
324
  if ok_ext then
325
    let dirname = Filename.dirname filename in
326
    let basename = Filename.chop_suffix (Filename.basename filename) ext in
327
    compile dirname basename ext
328
  else
329
    raise (Arg.Bad ("Can only compile *.lusi, *.lus or *.ec files"))
330

    
331
let _ =
332
  Corelang.add_internal_funs ();
333
  try
334
    Printexc.record_backtrace true;
335
    Arg.parse Options.options anonymous usage
336
  with
337
  | Parse.Syntax_err _ | Lexer_lustre.Error _ 
338
  | Types.Error (_,_) | Clocks.Error (_,_)
339
  | Corelang.Error _ (*| Task_set.Error _*) 
340
  | Causality.Cycle _ -> exit 1
341
  | Sys_error msg -> (eprintf "Failure: %s@." msg)
342
  | exc -> (Utils.track_exception (); raise exc)
343

    
344
(* Local Variables: *)
345
(* compile-command:"make -C .." *)
346
(* End: *)