Project

General

Profile

Download (14.2 KB) Statistics
| Branch: | Tag: | Revision:
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
let functional_backend () = 
90
  match !Options.output with
91
  | "horn" | "lustre" | "acsl" -> true
92
  | _ -> false
93

    
94
(* compile a .lus source file *)
95
let rec compile_source dirname basename extension =
96

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

    
99
  (* Parsing source *)
100
  let prog = parse_source (dirname ^ "/" ^ basename ^ extension) in
101

    
102
  (* Removing automata *)
103
  let prog = Automata.expand_decls prog in
104

    
105
  Log.report ~level:4 (fun fmt -> fprintf fmt "After automata expansion:@.@[<v 2>@ %a@]@," Printers.pp_prog prog);
106

    
107
  (* Importing source *)
108
  let _ = Modules.load_program ISet.empty prog in
109

    
110
  (* Extracting dependencies *)
111
  let dependencies, type_env, clock_env = import_dependencies prog in
112

    
113
  (* Sorting nodes *)
114
  let prog = SortProg.sort prog in
115

    
116
  (* Perform inlining before any analysis *)
117
  let orig, prog =
118
    if !Options.global_inline && !Options.main_node <> "" then (
119
      let inlined_prog = Inliner.global_inline basename prog type_env clock_env in
120
      Log.report ~level:4 (fun fmt -> fprintf fmt "After global inlining:@.@[<v 2>@ %a@]@," Printers.pp_prog inlined_prog);
121

    
122
      (if !Options.witnesses then prog else []),
123
      inlined_prog
124

    
125
    )
126
    else (* if !Option.has_local_inline *)
127
      [],
128
      Inliner.local_inline basename prog type_env clock_env
129
  in
130

    
131
  (* Checking stateless/stateful status *)
132
  check_stateless_decls prog;
133

    
134
  (* Typing *)
135
  let computed_types_env = type_decls type_env prog in
136

    
137
  (* Clock calculus *)
138
  let computed_clocks_env = clock_decls clock_env prog in
139

    
140
  (* Generating a .lusi header file only *)
141
  if !Options.lusi then
142
    begin
143
      let lusi_ext = extension ^ "i" in
144
      Log.report ~level:1 (fun fmt -> fprintf fmt ".. generating interface file %s@," (dirname ^ "/" ^ basename ^ lusi_ext));
145
      print_lusi prog dirname basename lusi_ext;
146
      Log.report ~level:1 (fun fmt -> fprintf fmt ".. done !@ @]@.");
147
      exit 0
148
    end;
149

    
150
  (* Delay calculus *)
151
  (* TO BE DONE LATER (Xavier)
152
    if(!Options.delay_calculus)
153
    then
154
    begin
155
    Log.report ~level:1 (fun fmt -> fprintf fmt ".. initialisation analysis@?");
156
    try
157
    Delay_calculus.delay_prog Basic_library.delay_env prog
158
    with (Delay.Error (loc,err)) as exc ->
159
    Location.print loc;
160
    eprintf "%a" Delay.pp_error err;
161
    Utils.track_exception ();
162
    raise exc
163
    end;
164
  *)
165

    
166
  (* Creating destination directory if needed *)
167
  create_dest_dir ();
168

    
169
  (* Compatibility with Lusi *)
170
  (* Checking the existence of a lusi (Lustre Interface file) *)
171
  (match !Options.output with
172
    "C" ->
173
      begin
174
        let extension = ".lusi" in
175
        compile_source_to_header prog computed_types_env computed_clocks_env dirname basename extension;
176
      end
177
   |_ -> ());
178

    
179
  Typing.uneval_prog_generics prog;
180
  Clock_calculus.uneval_prog_generics prog;
181

    
182
  if !Options.global_inline && !Options.main_node <> "" && !Options.witnesses then
183
    begin
184
      let orig = Corelang.copy_prog orig in
185
      Log.report ~level:1 (fun fmt -> fprintf fmt ".. generating witness file@,");
186
      check_stateless_decls orig;
187
      let _ = Typing.type_prog type_env orig in
188
      let _ = Clock_calculus.clock_prog clock_env orig in
189
      Typing.uneval_prog_generics orig;
190
      Clock_calculus.uneval_prog_generics orig;
191
      Inliner.witness
192
	basename
193
	!Options.main_node
194
	orig prog type_env clock_env
195
    end;
196

    
197
(*Format.eprintf "Inliner.global_inline<<@.%a@.>>@." Printers.pp_prog prog;*)
198
  (* Computes and stores generic calls for each node,
199
     only useful for ANSI C90 compliant generic node compilation *)
200
  if !Options.ansi then Causality.NodeDep.compute_generic_calls prog;
201
  (*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;*)
202

    
203
  (* Normalization phase *)
204
  Log.report ~level:1 (fun fmt -> fprintf fmt ".. normalization@,");
205
  (* Special treatment of arrows in lustre backend. We want to keep them *)
206
  if !Options.output = "lustre" then
207
    Normalization.unfold_arrow_active := false;
208
  let prog = Normalization.normalize_prog prog in
209

    
210
  Log.report ~level:2 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog);
211
  (* Checking array accesses *)
212
  if !Options.check then
213
    begin
214
      Log.report ~level:1 (fun fmt -> fprintf fmt ".. array access checks@,");
215
      Access.check_prog prog;
216
    end;
217

    
218
  (* Computation of node equation scheduling. It also breaks dependency cycles
219
     and warns about unused input or memory variables *)
220
  Log.report ~level:1 (fun fmt -> fprintf fmt ".. scheduling@,");
221
  let prog, node_schs = Scheduling.schedule_prog prog in
222
  Log.report ~level:1 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_warning_unused node_schs);
223
  Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_schedule node_schs);
224
  Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_fanin_table node_schs);
225
  Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog);
226

    
227
 (* Optimization of prog:
228
    - Unfold consts
229
    - eliminate trivial expressions
230
 *)
231
  let prog =
232
    if !Options.optimization >= 5 then
233
      begin
234
	Log.report ~level:1 (fun fmt -> fprintf fmt ".. constants elimination@,");
235
	Optimize_prog.prog_unfold_consts prog
236
      end
237
    else
238
      prog
239
  in
240
  (* DFS with modular code generation *)
241
  Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines generation@,");
242
  let machine_code = Machine_code.translate_prog prog node_schs in
243

    
244
  Log.report ~level:2 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@,"
245
  (Utils.fprintf_list ~sep:"@ " Machine_code.pp_machine)
246
  machine_code);
247

    
248
  (* Optimize machine code *)
249
  let machine_code =
250
    if !Options.optimization >= 4 (* && !Options.output <> "horn" *) then
251
      begin
252
	Log.report ~level:1 
253
	  (fun fmt -> fprintf fmt ".. machines optimization: sub-expression elimination@,");
254
	Optimize_machine.machines_cse machine_code
255
      end
256
    else
257
      machine_code
258
  in
259

    
260
  (* Optimize machine code *)
261
  let machine_code =
262
    if !Options.optimization >= 2 (* && !Options.output <> "horn" *) then
263
      begin
264
	Log.report ~level:1 
265
	  (fun fmt -> fprintf fmt 
266
	    ".. machines optimization: const. inlining (partial eval. with const)@,");
267
	Optimize_machine.machines_unfold (Corelang.get_consts prog) node_schs machine_code
268
      end
269
    else
270
      machine_code
271
  in
272
  (* Optimize machine code *)
273
  let machine_code = (* TODO reactivate. I disabled it because output variables were removed *)
274
    if false && !Options.optimization >= 3 && not (functional_backend ()) then
275
      begin
276
	Log.report ~level:1 
277
	  (fun fmt -> fprintf fmt ".. machines optimization: minimize heap alloc by reusing vars@,");
278
	Optimize_machine.machines_fusion 
279
	  (Optimize_machine.machines_reuse_variables machine_code node_schs)
280
      end
281
    else
282
      machine_code
283
  in
284

    
285
  if !Options.optimization >= 2 then
286
    begin
287
      Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@,"
288
	(Utils.fprintf_list ~sep:"@ " Machine_code.pp_machine)
289
	machine_code);
290
    end;
291

    
292
  (* Printing code *)
293
  let basename    =  Filename.basename basename in
294
  let destname = !Options.dest_dir ^ "/" ^ basename in
295
  let _ = match !Options.output with
296
    | "C" ->
297
      begin
298
	  let alloc_header_file = destname ^ "_alloc.h" in (* Could be changed *)
299
	  let source_lib_file = destname ^ ".c" in (* Could be changed *)
300
	  let source_main_file = destname ^ "_main.c" in (* Could be changed *)
301
	  let makefile_file = destname ^ ".makefile" in (* Could be changed *)
302
	  Log.report ~level:1 (fun fmt -> fprintf fmt ".. C code generation@,");
303
	  C_backend.translate_to_c
304
	    alloc_header_file source_lib_file source_main_file makefile_file
305
	    basename prog machine_code dependencies
306
	end
307
    | "java" ->
308
      begin
309
	failwith "Sorry, but not yet supported !"
310
    (*let source_file = basename ^ ".java" in
311
      Log.report ~level:1 (fun fmt -> fprintf fmt ".. opening file %s@,@?" source_file);
312
      let source_out = open_out source_file in
313
      let source_fmt = formatter_of_out_channel source_out in
314
      Log.report ~level:1 (fun fmt -> fprintf fmt ".. java code generation@,@?");
315
      Java_backend.translate_to_java source_fmt basename normalized_prog machine_code;*)
316
      end
317
    | "horn" ->
318
      begin
319
	let source_file = if !Options.dest_file ="" then destname ^ ".smt2" else !Options.dest_file in (* Could be changed *)
320
        Printf.eprintf "\n\nOut = %s\n\nOption is : %s\n\n" source_file !Options.dest_file;
321
	let source_out = open_out source_file in
322
	let fmt = formatter_of_out_channel source_out in
323
	Log.report ~level:1 (fun fmt -> fprintf fmt ".. hornification@,");
324
        Horn_backend.translate fmt basename prog (Machine_code.arrow_machine::machine_code);
325
	(* Tracability file if option is activated *)
326
	if !Options.traces then (
327
	let traces_file = destname ^ ".traces.xml" in (* Could be changed *)
328
	let traces_out = open_out traces_file in
329
	let fmt = formatter_of_out_channel traces_out in
330
        Log.report ~level:1 (fun fmt -> fprintf fmt ".. tracing info@,");
331
	Horn_backend_traces.traces_file fmt basename prog machine_code;
332
	)
333
      end
334
    | "lustre" ->
335
      begin
336
	let source_file = destname ^ ".lustrec.lus" in (* Could be changed *)
337
	let source_out = open_out source_file in
338
	let fmt = formatter_of_out_channel source_out in
339
	Printers.pp_prog fmt prog;
340
(*	Lustre_backend.translate fmt basename normalized_prog machine_code *)
341
	()
342
      end
343

    
344
    | _ -> assert false
345
  in
346
  begin
347
    Log.report ~level:1 (fun fmt -> fprintf fmt ".. done @ @]@.");
348
  (* We stop the process here *)
349
    exit 0
350
  end
351

    
352
let compile dirname basename extension =
353
  match extension with
354
  | ".lusi"  -> compile_header dirname basename extension
355
  | ".lus"   -> compile_source dirname basename extension
356
  | _        -> assert false
357

    
358
let anonymous filename =
359
  Printf.eprintf "\n\nAnonymous called with : %s\n" filename;
360
  let ok_ext, ext = List.fold_left
361
    (fun (ok, ext) ext' ->
362
      if not ok && Filename.check_suffix filename ext' then
363
	true, ext'
364
      else
365
	ok, ext)
366
    (false, "") extensions in
367
  if ok_ext then
368
    let dirname = Filename.dirname filename in
369
    let basename = Filename.chop_suffix (Filename.basename filename) ext in
370
    compile dirname basename ext
371
  else
372
    raise (Arg.Bad ("Can only compile *.lusi, *.lus or *.ec files"))
373

    
374
let _ =
375
  Corelang.add_internal_funs ();
376
  try
377
    Printexc.record_backtrace true;
378
    Printf.eprintf "\nParsing\n";
379
    Arg.parse Options.options anonymous usage;
380
    Printf.eprintf "\nDest=%s\n" !Options.dest_file
381
  with
382
  | Parse.Syntax_err _ | Lexer_lustre.Error _
383
  | Types.Error (_,_) | Clocks.Error (_,_)
384
  | Corelang.Error _ (*| Task_set.Error _*)
385
  | Causality.Cycle _ -> exit 1
386
  | Sys_error msg -> (eprintf "Failure: %s@." msg)
387
  | exc -> (Utils.track_exception (); raise exc)
388

    
389
(* Local Variables: *)
390
(* compile-command:"make -C .." *)
391
(* End: *)
(32-32/51)