Project

General

Profile

Statistics
| Branch: | Tag: | Revision:

lustrec / src / main_lustre_compiler.ml @ 49d92bf8

History | View | Annotate | Download (15 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
exception StopPhase1 of program
20

    
21
let usage = "Usage: lustrec [options] \x1b[4msource-file\x1b[0m"
22

    
23
let extensions = [".ec"; ".lus"; ".lusi"]
24

    
25
(* print a .lusi header file from a source prog *)
26
let print_lusi prog dirname basename extension =
27
  let header = Lusic.extract_header dirname basename prog in
28
  let header_name = dirname ^ "/" ^ basename ^ extension in
29
  let h_out = open_out header_name in
30
  let h_fmt = formatter_of_out_channel h_out in
31
  begin
32
    Typing.uneval_prog_generics header;
33
    Clock_calculus.uneval_prog_generics header;
34
    Printers.pp_lusi_header h_fmt basename header;
35
    close_out h_out
36
  end
37

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

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

    
90
(* From prog to prog *)
91
let stage1 prog dirname basename =
92
  (* Removing automata *) 
93
  let prog = Automata.expand_decls prog in
94

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

    
98
  (* Extracting dependencies *)
99
  let dependencies, type_env, clock_env = import_dependencies prog in
100

    
101
  (* Sorting nodes *)
102
  let prog = SortProg.sort prog in
103

    
104
  (* Perform inlining before any analysis *)
105
  let orig, prog =
106
    if !Options.global_inline && !Options.main_node <> "" then
107
      (if !Options.witnesses then prog else []),
108
      Inliner.global_inline basename prog type_env clock_env
109
    else (* if !Option.has_local_inline *)
110
      [],
111
      Inliner.local_inline basename prog type_env clock_env
112
  in
113

    
114
  (* Checking stateless/stateful status *)
115
  if Plugins.check_force_stateful () then
116
    force_stateful_decls prog
117
  else
118
    check_stateless_decls prog;
119

    
120
  (* Typing *)
121
  let computed_types_env = type_decls type_env prog in
122

    
123
  (* Clock calculus *)
124
  let computed_clocks_env = clock_decls clock_env prog in
125

    
126
  (* Generating a .lusi header file only *)
127
  if !Options.lusi then
128
    (* We stop here the processing and produce the current prog. It will be
129
       exported as a lusi *)
130
    raise (StopPhase1 prog);
131

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

    
148
  (* Creating destination directory if needed *)
149
  create_dest_dir ();
150

    
151
  (* Compatibility with Lusi *)
152
  (* Checking the existence of a lusi (Lustre Interface file) *)
153
  let extension = ".lusi" in
154
  compile_source_to_header prog computed_types_env computed_clocks_env dirname basename extension;
155

    
156
  Typing.uneval_prog_generics prog;
157
  Clock_calculus.uneval_prog_generics prog;
158

    
159
  if !Options.global_inline && !Options.main_node <> "" && !Options.witnesses then
160
    begin
161
      let orig = Corelang.copy_prog orig in
162
      Log.report ~level:1 (fun fmt -> fprintf fmt ".. generating witness file@,");
163
      check_stateless_decls orig;
164
      let _ = Typing.type_prog type_env orig in
165
      let _ = Clock_calculus.clock_prog clock_env orig in
166
      Typing.uneval_prog_generics orig;
167
      Clock_calculus.uneval_prog_generics orig;
168
      Inliner.witness
169
	basename
170
	!Options.main_node
171
	orig prog type_env clock_env
172
    end;
173

    
174
  (* Computes and stores generic calls for each node,
175
     only useful for ANSI C90 compliant generic node compilation *)
176
  if !Options.ansi then Causality.NodeDep.compute_generic_calls prog;
177
  (*Hashtbl.iter (fun id td -> match td.Corelang.top_decl_desc with
178
    Corelang.Node nd -> Format.eprintf "%s calls %a" id
179
    Causality.NodeDep.pp_generic_calls nd | _ -> ()) Corelang.node_table;*)
180

    
181
  (* Optimization of prog: 
182
     - Unfold consts 
183
     - eliminate trivial expressions
184
  *)
185
  let prog = 
186
    if !Options.const_unfold || !Options.optimization >= 4 then 
187
      Optimize_prog.prog_unfold_consts prog 
188
    else
189
      prog
190
  in
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
  Log.report ~level:2 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog);
199

    
200
  let prog =
201
    if !Options.mpfr
202
    then
203
      begin
204
	Log.report ~level:1 (fun fmt -> fprintf fmt ".. targetting MPFR library@,");
205
	Mpfr.inject_prog prog
206
      end
207
    else
208
      begin
209
	Log.report ~level:1 (fun fmt -> fprintf fmt ".. keeping FP numbers@,");
210
	prog
211
      end in
212
  Log.report ~level:2 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog);
213

    
214
  (* Checking array accesses *)
215
  if !Options.check then
216
    begin
217
      Log.report ~level:1 (fun fmt -> fprintf fmt ".. array access checks@,");
218
      Access.check_prog prog;
219
    end;
220

    
221
  prog, dependencies
222

    
223
(* prog -> machine *)
224

    
225
let stage2 prog =    
226

    
227
  (* Computation of node equation scheduling. It also breaks dependency cycles
228
     and warns about unused input or memory variables *)
229
  Log.report ~level:1 (fun fmt -> fprintf fmt ".. scheduling@,");
230
  let prog, node_schs = Scheduling.schedule_prog prog in
231
  Log.report ~level:1 (fun fmt -> fprintf fmt "%a"              Scheduling.pp_warning_unused node_schs);
232
  Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_schedule node_schs);
233
  Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_fanin_table node_schs);
234
  Log.report ~level:5 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_dep_graph node_schs);
235
  Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog);
236

    
237

    
238
  (* TODO Salsa optimize prog: 
239
     - emits warning for programs with pre inside expressions
240
     - make sure each node arguments and memory is bounded by a local annotation
241
     - introduce fresh local variables for each real pure subexpression
242
  *)
243
 (*  let prog =  *)
244
 (*    if true then *)
245
 (*      Salsa.Prog.normalize prog *)
246
 (*    else *)
247
 (*      prog *)
248
 (* in *)
249

    
250
  (* DFS with modular code generation *)
251
  Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines generation@ ");
252
  let machine_code = Machine_code.translate_prog prog node_schs in
253

    
254
  (* Optimize machine code *)
255
  let machine_code, removed_table = 
256
    if !Options.optimization >= 2 && !Options.output <> "horn" then
257
      begin
258
	Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines optimization (phase 1)@ ");
259
	Optimize_machine.machines_unfold (Corelang.get_consts prog) node_schs machine_code
260
      end
261
    else
262
      machine_code, IMap.empty
263
  in  
264
  (* Optimize machine code *)
265
  let machine_code = 
266
    if !Options.optimization >= 3 && !Options.output <> "horn" then
267
      begin
268
	Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines optimization (phase 2)@ ");
269
	let node_schs    = Scheduling.remove_prog_inlined_locals removed_table node_schs in
270
	let reuse_tables = Scheduling.compute_prog_reuse_table node_schs in
271
	Optimize_machine.machines_fusion (Optimize_machine.machines_reuse_variables machine_code reuse_tables)
272
      end
273
    else
274
      machine_code
275
  in
276
  
277
  (* Salsa optimize machine code *)
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
  machine_code
283

    
284

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

    
337
    | _ -> assert false
338

    
339
(* compile a .lus source file *)
340
let compile_source dirname basename extension =
341

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

    
344
  (* Parsing source *)
345
  let prog = parse_source (dirname ^ "/" ^ basename ^ extension) in
346

    
347
  let prog =
348
    if !Options.mpfr then
349
      Mpfr.mpfr_module::prog
350
    else
351
      prog
352
  in
353
  let prog, dependencies = 
354
    try 
355
      stage1 prog dirname basename
356
    with StopPhase1 prog -> (
357
      if !Options.lusi then
358
	begin
359
	  let lusi_ext = ".lusi" (* extension ^ "i" *) in
360
	  Log.report ~level:1 (fun fmt -> fprintf fmt ".. generating interface file %s@," (dirname ^ "/" ^ basename ^ lusi_ext));
361
	  print_lusi prog dirname basename lusi_ext;
362
	  Log.report ~level:1 (fun fmt -> fprintf fmt ".. done !@ @]@.");
363
	  exit 0
364
	end
365
      else
366
        assert false
367
    )
368
  in
369

    
370
  let machine_code = 
371
    stage2 prog 
372
  in
373

    
374
  let machine_code = Plugins.refine_machine_code prog machine_code in
375
  
376
  stage3 prog machine_code dependencies basename;
377
  begin
378
    Log.report ~level:1 (fun fmt -> fprintf fmt ".. done !@ @]@.");
379
    (* We stop the process here *)
380
    exit 0
381
  end
382

    
383
let compile dirname basename extension =
384
  match extension with
385
  | ".lusi"  -> compile_header dirname basename extension
386
  | ".lus"   -> compile_source dirname basename extension
387
  | _        -> assert false
388

    
389
let anonymous filename =
390
  let ok_ext, ext = List.fold_left
391
    (fun (ok, ext) ext' ->
392
      if not ok && Filename.check_suffix filename ext' then
393
	true, ext'
394
      else
395
	ok, ext)
396
    (false, "") extensions in
397
  if ok_ext then
398
    let dirname = Filename.dirname filename in
399
    let basename = Filename.chop_suffix (Filename.basename filename) ext in
400
    compile dirname basename ext
401
  else
402
    raise (Arg.Bad ("Can only compile *.lusi, *.lus or *.ec files"))
403

    
404
let _ =
405
  Global.initialize ();
406
  Corelang.add_internal_funs ();
407
  try
408
    Printexc.record_backtrace true;
409

    
410
    let options = Options.options @ (Plugins.options ()) in
411
    
412
    Arg.parse options anonymous usage
413
  with
414
  | Parse.Syntax_err _ | Lexer_lustre.Error _
415
  | Types.Error (_,_) | Clocks.Error (_,_)
416
  | Corelang.Error _ (*| Task_set.Error _*)
417
  | Causality.Cycle _ -> exit 1
418
  | Sys_error msg -> (eprintf "Failure: %s@." msg)
419
  | exc -> (Utils.track_exception (); raise exc)
420

    
421
(* Local Variables: *)
422
(* compile-command:"make -C .." *)
423
(* End: *)