Project

General

Profile

Statistics
| Branch: | Tag: | Revision:

lustrec / src / main_lustre_compiler.ml @ b3f91fdb

History | View | Annotate | Download (11.9 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
	  let header = lusic.Lusic.contents in
80
	  let (declared_types_env, declared_clocks_env) = get_envs_from_top_decls header in
81
	  check_compatibility
82
	    (prog, computed_types_env, computed_clocks_env)
83
	    (header, declared_types_env, declared_clocks_env)
84
	end
85
  end
86

    
87
(* compile a .lus source file *)
88
let rec compile_source dirname basename extension =
89

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

    
92
  (* Parsing source *)
93
  let prog = parse_source (dirname ^ "/" ^ basename ^ extension) 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@," (dirname ^ "/" ^ basename ^ lusi_ext));
121
      print_lusi prog dirname basename lusi_ext;
122
      Log.report ~level:1 (fun fmt -> fprintf fmt ".. done !@ @]@.");
123
      exit 0
124
    end;
125

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

    
145
  (* Compatibility with Lusi *)
146
  (* Checking the existence of a lusi (Lustre Interface file) *)
147
  let extension = ".lusi" in
148
  compile_source_to_header prog computed_types_env computed_clocks_env dirname basename extension;
149

    
150
  Typing.uneval_prog_generics prog;
151
  Clock_calculus.uneval_prog_generics prog;
152

    
153
  (* Perform global inlining *)
154
  let prog =
155
    if !Options.global_inline &&
156
      (match !Options.main_node with | "" -> false | _ -> true) then
157
      Inliner.global_inline basename prog type_env clock_env
158
    else (* if !Option.has_local_inline *)
159
      Inliner.local_inline basename prog type_env clock_env
160
  in
161
(*Format.eprintf "Inliner.global_inline<<@.%a@.>>@." Printers.pp_prog prog;*)
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

    
174
  Log.report ~level:2 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog);
175
  (* Checking array accesses *)
176
  if !Options.check then
177
    begin
178
      Log.report ~level:1 (fun fmt -> fprintf fmt ".. array access checks@,");
179
      Access.check_prog prog;
180
    end;
181

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

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

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

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

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

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

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

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

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