Project

General

Profile

Statistics
| Branch: | Tag: | Revision:

lustrec / src / main_lustre_compiler.ml @ 3d04f75e

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 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

    
90
(* compile a .lus source file *)
91
let rec compile_source dirname basename extension =
92

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

    
95
  (* Parsing source *)
96
  let prog = parse_source (dirname ^ "/" ^ basename ^ extension) in
97

    
98
  (* Removing automata *)
99
  let prog = Automata.expand_decls prog in
100

    
101
  (* Importing source *)
102
  let _ = Modules.load_program ISet.empty prog in
103

    
104
  (* Extracting dependencies *)
105
  let dependencies, type_env, clock_env = import_dependencies prog in
106

    
107
  (* Sorting nodes *)
108
  let prog = SortProg.sort prog in
109

    
110
  (* Perform inlining before any analysis *)
111
  let orig, prog =
112
    if !Options.global_inline && !Options.main_node <> "" then
113
      (if !Options.witnesses then prog else []),
114
      Inliner.global_inline basename prog type_env clock_env
115
    else (* if !Option.has_local_inline *)
116
      [],
117
      Inliner.local_inline basename prog type_env clock_env
118
  in
119

    
120
  (* Checking stateless/stateful status *)
121
  check_stateless_decls prog;
122

    
123
  (* Typing *)
124
  let computed_types_env = type_decls type_env prog in
125

    
126
  (* Clock calculus *)
127
  let computed_clocks_env = clock_decls clock_env prog in
128

    
129
  (* Generating a .lusi header file only *)
130
  if !Options.lusi then
131
    begin
132
      let lusi_ext = extension ^ "i" in
133
      Log.report ~level:1 (fun fmt -> fprintf fmt ".. generating interface file %s@," (dirname ^ "/" ^ basename ^ lusi_ext));
134
      print_lusi prog dirname basename lusi_ext;
135
      Log.report ~level:1 (fun fmt -> fprintf fmt ".. done !@ @]@.");
136
      exit 0
137
    end;
138

    
139
  (* Delay calculus *)
140
  (* TO BE DONE LATER (Xavier)
141
    if(!Options.delay_calculus)
142
    then
143
    begin
144
    Log.report ~level:1 (fun fmt -> fprintf fmt ".. initialisation analysis@?");
145
    try
146
    Delay_calculus.delay_prog Basic_library.delay_env prog
147
    with (Delay.Error (loc,err)) as exc ->
148
    Location.print loc;
149
    eprintf "%a" Delay.pp_error err;
150
    Utils.track_exception ();
151
    raise exc
152
    end;
153
  *)
154

    
155
  (* Creating destination directory if needed *)
156
  create_dest_dir ();
157

    
158
  (* Compatibility with Lusi *)
159
  (* Checking the existence of a lusi (Lustre Interface file) *)
160
  (match !Options.output with
161
    "C" ->
162
      begin
163
        let extension = ".lusi" in
164
        compile_source_to_header prog computed_types_env computed_clocks_env dirname basename extension;
165
      end
166
   |_ -> ());
167

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

    
171
  if !Options.global_inline && !Options.main_node <> "" && !Options.witnesses then
172
    begin
173
      let orig = Corelang.copy_prog orig in
174
      Log.report ~level:1 (fun fmt -> fprintf fmt ".. generating witness file@,");
175
      check_stateless_decls orig;
176
      let _ = Typing.type_prog type_env orig in
177
      let _ = Clock_calculus.clock_prog clock_env orig in
178
      Typing.uneval_prog_generics orig;
179
      Clock_calculus.uneval_prog_generics orig;
180
      Inliner.witness
181
	basename
182
	!Options.main_node
183
	orig prog type_env clock_env
184
    end;
185

    
186
(*Format.eprintf "Inliner.global_inline<<@.%a@.>>@." Printers.pp_prog prog;*)
187
  (* Computes and stores generic calls for each node,
188
     only useful for ANSI C90 compliant generic node compilation *)
189
  if !Options.ansi then Causality.NodeDep.compute_generic_calls prog;
190
  (*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;*)
191

    
192
  (* Normalization phase *)
193
  Log.report ~level:1 (fun fmt -> fprintf fmt ".. normalization@,");
194
  (* Special treatment of arrows in lustre backend. We want to keep them *)
195
  if !Options.output = "lustre" then
196
    Normalization.unfold_arrow_active := false;
197
  let prog = Normalization.normalize_prog prog in
198

    
199
  Log.report ~level:2 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog);
200
  (* Checking array accesses *)
201
  if !Options.check then
202
    begin
203
      Log.report ~level:1 (fun fmt -> fprintf fmt ".. array access checks@,");
204
      Access.check_prog prog;
205
    end;
206

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

    
216
 (* Optimization of prog:
217
    - Unfold consts
218
    - eliminate trivial expressions
219
 *)
220
  let prog =
221
    if !Options.optimization >= 5 then
222
      begin
223
	Log.report ~level:1 (fun fmt -> fprintf fmt ".. constants elimination@,");
224
	Optimize_prog.prog_unfold_consts prog
225
      end
226
    else
227
      prog
228
  in
229

    
230
  (* Post-treatment of normaized code specific to backend *)
231
  let prog = 
232
    match !Options.output with
233
    | "riny" -> prog (* TODO: eliminate through inlining bool variables and remove them *)
234
    | _ -> prog
235
  in
236

    
237
  (* DFS with modular code generation *)
238
  Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines generation@,");
239
  let machine_code = Machine_code.translate_prog prog node_schs in
240

    
241
  (* Optimize machine code *)
242
  let machine_code =
243
    if !Options.optimization >= 4 && !Options.output <> "horn" then
244
      begin
245
	Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines optimization (phase 3)@,");
246
	Optimize_machine.machines_cse machine_code
247
      end
248
    else
249
      machine_code
250
  in
251

    
252
  Log.report ~level:2 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@,"
253
  (Utils.fprintf_list ~sep:"@ " Machine_code.pp_machine)
254
  machine_code);
255

    
256
  (* Optimize machine code *)
257
  let machine_code =
258
    if !Options.optimization >= 2 && !Options.output <> "horn" then
259
      begin
260
	Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines optimization (phase 1)@,");
261
	Optimize_machine.machines_unfold (Corelang.get_consts prog) node_schs machine_code
262
      end
263
    else
264
      machine_code
265
  in
266
  (* Optimize machine code *)
267
  let machine_code =
268
    if !Options.optimization >= 3 && !Options.output <> "horn" then
269
      begin
270
	Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines optimization (phase 2)@,");
271
	Optimize_machine.machines_fusion (Optimize_machine.machines_reuse_variables machine_code node_schs)
272
      end
273
    else
274
      machine_code
275
  in
276

    
277

    
278
  Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@,"
279
  (Utils.fprintf_list ~sep:"@ " Machine_code.pp_machine)
280
  machine_code);
281

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

    
332
      end
333
    | "riny"  ->       
334
      begin
335
	let source_file = destname ^ ".riny" in (* Could be changed *)
336
	let source_out = open_out source_file in
337
	let fmt = formatter_of_out_channel source_out in
338
	(* Printers.pp_prog fmt prog; *)
339
	Riny_backend.translate fmt basename prog machine_code;
340
	()
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
  let ok_ext, ext = List.fold_left
360
    (fun (ok, ext) ext' ->
361
      if not ok && Filename.check_suffix filename ext' then
362
	true, ext'
363
      else
364
	ok, ext)
365
    (false, "") extensions in
366
  if ok_ext then
367
    let dirname = Filename.dirname filename in
368
    let basename = Filename.chop_suffix (Filename.basename filename) ext in
369
    compile dirname basename ext
370
  else
371
    raise (Arg.Bad ("Can only compile *.lusi, *.lus or *.ec files"))
372

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

    
386
(* Local Variables: *)
387
(* compile-command:"make -C .." *)
388
(* End: *)