Project

General

Profile

Statistics
| Branch: | Tag: | Revision:

lustrec / src / main_lustre_compiler.ml @ ef34b4ae

History | View | Annotate | Download (11.5 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 LustreSpec
16
open Compiler_common
17

    
18
let usage = "Usage: lustrec [options] <source-file>"
19

    
20
let extensions = [".ec"; ".lus"; ".lusi"]
21

    
22
(* print a .lusi header file from a source prog *)
23
let print_lusi prog basename extension =
24
  let header = Lusic.extract_header basename prog in
25
  let header_name = basename ^ extension in
26
  let h_out = open_out header_name in
27
  let h_fmt = formatter_of_out_channel h_out in
28
  begin
29
    Printers.pp_lusi_header h_fmt basename header;
30
    close_out h_out
31
  end
32

    
33
(* compile a .lusi header file *)
34
let compile_header basename extension =
35
   let header_name = basename ^ extension in
36
   let lusic_ext = extension ^ "c" in
37
   begin
38
     Log.report ~level:1 (fun fmt -> fprintf fmt "@[<v>");
39
     let header = parse_header true header_name in
40
     ignore (check_top_decls header);
41
     create_dest_dir ();
42
     Log.report ~level:1 (fun fmt -> fprintf fmt ".. generating compiled header file %sc@," header_name);
43
     Lusic.write_lusic true header basename lusic_ext;
44
     Lusic.print_lusic_to_h basename lusic_ext;
45
     Log.report ~level:1 (fun fmt -> fprintf fmt ".. done !@ @]@.")
46
   end
47

    
48
(* check whether a source file has a compiled header,
49
   if not, generate the compiled header *)
50
let compile_source_to_header prog computed_types_env computed_clocks_env basename extension =
51
  let basename' = !Options.dest_dir ^ "/" ^ basename in
52
  let lusic_ext = extension ^ "c" in
53
  let header_name = basename' ^ lusic_ext in
54
  begin
55
    if not (Sys.file_exists header_name) then
56
      begin
57
	Log.report ~level:1 (fun fmt -> fprintf fmt ".. generating compiled header file %s@," header_name);
58
	Lusic.write_lusic false (Lusic.extract_header basename prog) basename lusic_ext;
59
	Lusic.print_lusic_to_h basename lusic_ext
60
      end
61
    else
62
      let lusic = Lusic.read_lusic basename lusic_ext in
63
      if not lusic.Lusic.from_lusi 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 basename prog) basename lusic_ext;
67
(*List.iter (fun top_decl -> Format.eprintf "lusic: %a@." Printers.pp_decl top_decl) lusic.Lusic.contents;*)
68
	  Lusic.print_lusic_to_h basename lusic_ext
69
	end
70
      else
71
	begin
72
	  Log.report ~level:1 (fun fmt -> fprintf fmt ".. loading compiled header file %s@," header_name);
73
	  let header = lusic.Lusic.contents in
74
	  let (declared_types_env, declared_clocks_env) = get_envs_from_top_decls header in
75
	  check_compatibility
76
	    (prog, computed_types_env, computed_clocks_env)
77
	    (header, declared_types_env, declared_clocks_env)
78
	end
79
  end
80

    
81
(* compile a .lus source file *)
82
let rec compile_source basename extension =
83
  let source_name = basename ^ extension in
84

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

    
87
  let prog = parse_source source_name in
88

    
89
  (* Extracting dependencies *)
90
  let dependencies, type_env, clock_env = import_dependencies prog in
91
 
92
  (* Sorting nodes *)
93
  let prog = SortProg.sort prog in
94

    
95
  (* Typing *)
96
  let computed_types_env = type_decls type_env prog in
97
  
98
  (* Clock calculus *)
99
  let computed_clocks_env = clock_decls clock_env prog in
100

    
101
  (* Checking stateless/stateful status *)
102
  check_stateless_decls prog;
103

    
104
  (* Generating a .lusi header file only *)
105
  if !Options.lusi then
106
    begin
107
      let lusi_ext = extension ^ "i" in
108
      Log.report ~level:1 (fun fmt -> fprintf fmt ".. generating interface file %s@," (basename ^ lusi_ext));
109
      print_lusi prog basename lusi_ext;
110
      Log.report ~level:1 (fun fmt -> fprintf fmt ".. done !@ @]@.");
111
      exit 0
112
    end;
113

    
114
  (* Perform global inlining *)
115
  let prog =
116
    if !Options.global_inline && 
117
      (match !Options.main_node with | "" -> false | _ -> true) then
118
      Inliner.global_inline basename prog type_env clock_env
119
    else
120
      prog
121
  in
122

    
123
  (* Delay calculus *)
124
  (*
125
    if(!Options.delay_calculus)
126
    then
127
    begin
128
    Log.report ~level:1 (fun fmt -> fprintf fmt ".. initialisation analysis@?");
129
    try
130
    Delay_calculus.delay_prog Basic_library.delay_env prog
131
    with (Delay.Error (loc,err)) as exc ->
132
    Location.print loc;
133
    eprintf "%a" Delay.pp_error err;
134
    Utils.track_exception ();
135
    raise exc
136
    end;
137
  *)
138
  (*
139
    eprintf "Causality analysis@.@?";
140
    (* Causality analysis *)
141
    begin
142
    try
143
    Causality.check_causal_prog prog
144
    with (Causality.Cycle v) as exc ->
145
    Causality.pp_error err_formatter v;
146
    raise exc
147
    end;
148
  *)
149

    
150
  (* Creating destination directory if needed *)
151
  create_dest_dir ();
152

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

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

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

    
166
  (* Normalization phase *)
167
  Log.report ~level:1 (fun fmt -> fprintf fmt ".. normalization@,");
168
  (* Special treatment of arrows in lustre backend. We want to keep them *)
169
  if !Options.output = "lustre" then
170
    Normalization.unfold_arrow_active := false;
171
  let prog = Normalization.normalize_prog prog in
172
  Log.report ~level:2 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog);
173

    
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:3 (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 >= 2 then 
196
      Optimize_prog.prog_unfold_consts prog 
197
    else
198
      prog
199
  in
200

    
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 >= 3 && !Options.output <> "horn" then
208
      begin
209
	Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines optimization@,");
210
	Optimize_machine.machines_reuse_variables machine_code node_schs
211
      end
212
    else
213
      machine_code
214
 in  
215
  let machine_code = 
216
    if !Options.optimization >= 3 && !Options.output <> "horn" then
217
      begin
218
	Optimize_machine.machines_fusion machine_code
219
      end
220
    else
221
      machine_code
222
 in
223
  Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@,"
224
  (Utils.fprintf_list ~sep:"@ " Machine_code.pp_machine)
225
  machine_code);
226

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

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

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

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

    
298
let _ =
299
  Corelang.add_internal_funs ();
300
  try
301
    Printexc.record_backtrace true;
302
    Arg.parse Options.options anonymous usage
303
  with
304
  | Parse.Syntax_err _ | Lexer_lustre.Error _ 
305
  | Types.Error (_,_) | Clocks.Error (_,_)
306
  | Corelang.Error _ (*| Task_set.Error _*) 
307
  | Causality.Cycle _ -> exit 1
308
  | Sys_error msg -> (eprintf "Failure: %s@." msg)
309
  | exc -> (Utils.track_exception (); raise exc)
310

    
311
(* Local Variables: *)
312
(* compile-command:"make -C .." *)
313
(* End: *)