Project

General

Profile

Statistics
| Branch: | Tag: | Revision:

lustrec / src / main_lustre_compiler.ml @ a5193ff5

History | View | Annotate | Download (12 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

    
88
  let source_name = (* dirname ^ "/" ^*) basename ^ extension in
89

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

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

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

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

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

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

    
107
  (* Typing *)
108
  let computed_types_env = type_decls type_env prog in
109

    
110
  (* Clock calculus *)
111
  let computed_clocks_env = clock_decls clock_env prog in
112

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

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

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

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

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

    
159
  Typing.uneval_prog_generics prog;
160
  Clock_calculus.uneval_prog_generics prog;
161

    
162
  (* Computes and stores generic calls for each node,
163
     only useful for ANSI C90 compliant generic node compilation *)
164
  if !Options.ansi then Causality.NodeDep.compute_generic_calls prog;
165
  (*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;*)
166

    
167
  (* Normalization phase *)
168
  Log.report ~level:1 (fun fmt -> fprintf fmt ".. normalization@,");
169
  (* Special treatment of arrows in lustre backend. We want to keep them *)
170
  if !Options.output = "lustre" then
171
    Normalization.unfold_arrow_active := false;
172
  let prog = Normalization.normalize_prog prog in
173
  Log.report ~level:2 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog);
174
  (* Checking array accesses *)
175
  if !Options.check then
176
    begin
177
      Log.report ~level:1 (fun fmt -> fprintf fmt ".. array access checks@,");
178
      Access.check_prog prog;
179
    end;
180

    
181
  (* Computation of node equation scheduling. It also breaks dependency cycles
182
     and warns about unused input or memory variables *)
183
  Log.report ~level:1 (fun fmt -> fprintf fmt ".. scheduling@,@?");
184
  let prog, node_schs = Scheduling.schedule_prog prog in
185
  Log.report ~level:1 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_warning_unused node_schs);
186
  Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_schedule node_schs);
187
  Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_fanin_table node_schs);
188
  Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog);
189

    
190
 (* Optimization of prog:
191
    - Unfold consts
192
    - eliminate trivial expressions
193
 *)
194
  let prog =
195
    if !Options.optimization >= 4 then
196
      Optimize_prog.prog_unfold_consts prog
197
    else
198
      prog
199
  in
200
  (* DFS with modular code generation *)
201
  Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines generation@,");
202
  let machine_code = Machine_code.translate_prog prog node_schs in
203

    
204
  (* Optimize machine code *)
205
  let machine_code =
206
    if !Options.optimization >= 2 && !Options.output <> "horn" then
207
      begin
208
	Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines optimization (phase 1)@,");
209
	Optimize_machine.machines_unfold (Corelang.get_consts prog) node_schs machine_code
210
      end
211
    else
212
      machine_code
213
 in
214
  (* Optimize machine code *)
215
  let machine_code =
216
    if !Options.optimization >= 3 && !Options.output <> "horn" then
217
      begin
218
	Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines optimization (phase 2)@,");
219
	Optimize_machine.machines_fusion (Optimize_machine.machines_reuse_variables machine_code node_schs)
220
      end
221
    else
222
      machine_code
223
 in
224
  Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@,"
225
  (Utils.fprintf_list ~sep:"@ " Machine_code.pp_machine)
226
  machine_code);
227

    
228
  (* Printing code *)
229
  let basename    =  Filename.basename basename in
230
  let destname = !Options.dest_dir ^ "/" ^ basename in
231
  let _ = match !Options.output with
232
      "C" ->
233
	begin
234
	  let alloc_header_file = destname ^ "_alloc.h" in (* Could be changed *)
235
	  let source_lib_file = destname ^ ".c" in (* Could be changed *)
236
	  let source_main_file = destname ^ "_main.c" in (* Could be changed *)
237
	  let makefile_file = destname ^ ".makefile" in (* Could be changed *)
238
	  Log.report ~level:1 (fun fmt -> fprintf fmt ".. C code generation@,");
239
	  C_backend.translate_to_c
240
	    alloc_header_file source_lib_file source_main_file makefile_file
241
	    basename prog machine_code dependencies
242
	end
243
    | "java" ->
244
      begin
245
	failwith "Sorry, but not yet supported !"
246
    (*let source_file = basename ^ ".java" in
247
      Log.report ~level:1 (fun fmt -> fprintf fmt ".. opening file %s@,@?" source_file);
248
      let source_out = open_out source_file in
249
      let source_fmt = formatter_of_out_channel source_out in
250
      Log.report ~level:1 (fun fmt -> fprintf fmt ".. java code generation@,@?");
251
      Java_backend.translate_to_java source_fmt basename normalized_prog machine_code;*)
252
      end
253
    | "horn" ->
254
      begin
255
	let source_file = destname ^ ".smt2" in (* Could be changed *)
256
	let source_out = open_out source_file in
257
	let fmt = formatter_of_out_channel source_out in
258
	Horn_backend.translate fmt basename prog machine_code;
259
	(* Tracability file if option is activated *)
260
	if !Options.traces then (
261
	let traces_file = destname ^ ".traces.xml" in (* Could be changed *)
262
	let traces_out = open_out traces_file in
263
	let fmt = formatter_of_out_channel traces_out in
264
	Horn_backend.traces_file fmt basename prog machine_code;
265

    
266

    
267
	)
268
      end
269
    | "lustre" ->
270
      begin
271
	let source_file = destname ^ ".lustrec.lus" in (* Could be changed *)
272
	let source_out = open_out source_file in
273
	let fmt = formatter_of_out_channel source_out in
274
	Printers.pp_prog fmt prog;
275
(*	Lustre_backend.translate fmt basename normalized_prog machine_code *)
276
	()
277
      end
278

    
279
    | _ -> assert false
280
  in
281
  begin
282
    Log.report ~level:1 (fun fmt -> fprintf fmt ".. done !@ @]@.");
283
  (* We stop the process here *)
284
    exit 0
285
  end
286

    
287
let compile dirname basename extension =
288
  match extension with
289
  | ".lusi"  -> compile_header dirname basename extension
290
  | ".lus"   -> compile_source dirname basename extension
291
  | _        -> assert false
292

    
293
let anonymous filename =
294
  let ok_ext, ext = List.fold_left
295
    (fun (ok, ext) ext' ->
296
      if not ok && Filename.check_suffix filename ext' then
297
	true, ext'
298
      else
299
	ok, ext)
300
    (false, "") extensions in
301
  if ok_ext then
302
    let dirname = Filename.dirname filename in
303
    let basename = Filename.chop_suffix (Filename.basename filename) ext in
304
    compile dirname basename ext
305
  else
306
    raise (Arg.Bad ("Can only compile *.lusi, *.lus or *.ec files"))
307

    
308
let _ =
309
  Corelang.add_internal_funs ();
310
  try
311
    Printexc.record_backtrace true;
312
    Arg.parse Options.options anonymous usage
313
  with
314
  | Parse.Syntax_err _ | Lexer_lustre.Error _
315
  | Types.Error (_,_) | Clocks.Error (_,_)
316
  | Corelang.Error _ (*| Task_set.Error _*)
317
  | Causality.Cycle _ -> exit 1
318
  | Sys_error msg -> (eprintf "Failure: %s@." msg)
319
  | exc -> (Utils.track_exception (); raise exc)
320

    
321
(* Local Variables: *)
322
(* compile-command:"make -C .." *)
323
(* End: *)