Project

General

Profile

Statistics
| Branch: | Tag: | Revision:

lustrec / src / main_lustre_compiler.ml @ 36454535

History | View | Annotate | Download (14.3 KB)

1
(* ----------------------------------------------------------------------------
2
 * SchedMCore - A MultiCore Scheduling Framework
3
 * Copyright (C) 2009-2013, ONERA, Toulouse, FRANCE - LIFL, Lille, FRANCE
4
 * Copyright (C) 2012-2013, INPT, Toulouse, FRANCE
5
 *
6
 * This file is part of Prelude
7
 *
8
 * Prelude is free software; you can redistribute it and/or
9
 * modify it under the terms of the GNU Lesser General Public License
10
 * as published by the Free Software Foundation ; either version 2 of
11
 * the License, or (at your option) any later version.
12
 *
13
 * Prelude is distributed in the hope that it will be useful, but
14
 * WITHOUT ANY WARRANTY ; without even the implied warranty of
15
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16
 * Lesser General Public License for more details.
17
 *
18
 * You should have received a copy of the GNU Lesser General Public
19
 * License along with this program ; if not, write to the Free Software
20
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
21
 * USA
22
 *---------------------------------------------------------------------------- *)
23

    
24
(* This module is used for the lustre to C compiler *)
25

    
26
open Format
27
open Log
28

    
29
open LustreSpec
30

    
31
let usage = "Usage: lustrec [options] <source-file>"
32

    
33
let extensions = [".ec"; ".lus"; ".lusi"]
34

    
35
let check_stateless_decls decls =
36
  Log.report ~level:1 (fun fmt -> fprintf fmt ".. checking stateless/stateful status@ ");
37
  try
38
    Stateless.check_prog decls
39
  with (Stateless.Error (loc, err)) as exc ->
40
    eprintf "Stateless status error %a%a@."
41
      Stateless.pp_error err
42
      Location.pp_loc loc;
43
    raise exc
44

    
45
let type_decls env decls =  
46
  Log.report ~level:1 (fun fmt -> fprintf fmt ".. typing@ ");
47
  let new_env = 
48
    begin
49
      try
50
	Typing.type_prog env decls
51
      with (Types.Error (loc,err)) as exc ->
52
	eprintf "Typing error %a%a@."
53
	  Types.pp_error err
54
	  Location.pp_loc loc;
55
	raise exc
56
    end 
57
  in
58
  if !Options.print_types then
59
    Log.report ~level:1 (fun fmt -> fprintf fmt "@[<v 2>  %a@]@ " Corelang.pp_prog_type decls);
60
  new_env
61
      
62
let clock_decls env decls = 
63
  Log.report ~level:1 (fun fmt -> fprintf fmt ".. clock calculus@ ");
64
  let new_env =
65
    begin
66
      try
67
	Clock_calculus.clock_prog env decls
68
      with (Clocks.Error (loc,err)) as exc ->
69
	eprintf "Clock calculus error %a%a@." Clocks.pp_error err Location.pp_loc loc;
70
	raise exc
71
    end
72
  in
73
  if !Options.print_clocks then
74
    Log.report ~level:1 (fun fmt -> fprintf fmt "@[<v 2>  %a@]@ " Corelang.pp_prog_clock decls);
75
  new_env
76

    
77
(* Loading Lusi file and filling type tables with parsed
78
   functions/nodes *)
79
let load_lusi own filename =
80
  Location.input_name := filename;
81
  let lexbuf = Lexing.from_channel (open_in filename) in
82
  Location.init lexbuf filename;
83
  (* Parsing *)
84
  Log.report ~level:1 (fun fmt -> fprintf fmt ".. parsing header file %s@ " filename);
85
    try
86
      Parse.header own Parser_lustre.header Lexer_lustre.token lexbuf
87
    with
88
    | (Lexer_lustre.Error err) | (Parse.Syntax_err err) as exc -> 
89
      Parse.report_error err;
90
      raise exc
91
    | Corelang.Error (loc, err) as exc -> (
92
      eprintf "Parsing error %a%a@."
93
	Corelang.pp_error err
94
	Location.pp_loc loc;
95
      raise exc
96
    )
97

    
98

    
99
let check_lusi header =
100
  let new_tenv = type_decls Basic_library.type_env header in   (* Typing *)
101
  let new_cenv = clock_decls Basic_library.clock_env header in   (* Clock calculus *)
102
  header, new_tenv, new_cenv
103

    
104
let load_n_check_lusi source_name lusi_name prog computed_types_env computed_clocks_env= 
105
  try 
106
    let _ = open_in lusi_name in
107
    let header = load_lusi true lusi_name in
108
    let _, declared_types_env, declared_clocks_env = check_lusi header in
109
        
110
    (* checking stateless status compatibility *)
111
    Stateless.check_compat header;
112

    
113
    (* checking type compatibility with computed types*)
114
    Typing.check_env_compat header declared_types_env computed_types_env;
115
    Typing.uneval_prog_generics prog;
116
    
117
    (* checking clocks compatibility with computed clocks*)
118
    Clock_calculus.check_env_compat header declared_clocks_env computed_clocks_env;
119
    Clock_calculus.uneval_prog_generics prog
120

    
121
    with Sys_error _ -> ( 
122
      (* Printing lusi file is necessary *)
123
      Log.report ~level:1 
124
	(fun fmt -> 
125
	  fprintf fmt 
126
	    ".. generating lustre interface file %s@," lusi_name);
127
      let lusi_out = open_out lusi_name in
128
      let lusi_fmt = formatter_of_out_channel lusi_out in
129
      Typing.uneval_prog_generics prog;
130
      Clock_calculus.uneval_prog_generics prog;
131
      Printers.pp_lusi_header lusi_fmt source_name prog
132
    )
133
    | (Types.Error (loc,err)) as exc ->
134
      eprintf "Type mismatch between computed type and declared type in lustre interface file: %a@."
135
	Types.pp_error err;
136
      raise exc
137
    | Clocks.Error (loc, err) as exc ->
138
      eprintf "Clock mismatch between computed clock and declared clock in lustre interface file: %a@."
139
	Clocks.pp_error err;
140
      raise exc
141
    | Stateless.Error (loc, err) as exc ->
142
      eprintf "Stateless status mismatch between defined status and declared status in lustre interface file: %a@."
143
	Stateless.pp_error err;
144
      raise exc
145
    
146
let rec compile basename extension =
147

    
148
  (* Loading the input file *)
149
  let source_name = basename^extension in
150
  Location.input_name := source_name;
151
  let lexbuf = Lexing.from_channel (open_in source_name) in
152
  Location.init lexbuf source_name;
153

    
154
  (* Parsing *)
155
  Log.report ~level:1 
156
    (fun fmt -> fprintf fmt "@[<v>.. parsing file %s@," source_name);
157
  let prog =
158
    try
159
      Parse.prog Parser_lustre.prog Lexer_lustre.token lexbuf
160
    with
161
    | (Lexer_lustre.Error err) | (Parse.Syntax_err err) as exc -> 
162
      Parse.report_error err;
163
      raise exc
164
    | Corelang.Error (loc, err) as exc ->
165
      eprintf "Parsing error %a%a@."
166
	Corelang.pp_error err
167
	Location.pp_loc loc;
168
      raise exc
169
  in
170

    
171
  (* Extracting dependencies *)
172
  Log.report ~level:1 (fun fmt -> fprintf fmt "@[<v 2>.. extracting dependencies@,");
173
  let dependencies = 
174
    List.fold_right 
175
      (fun d accu -> match d.top_decl_desc with 
176
      | Open (local, s) -> (s, local)::accu 
177
      | _ -> accu) 
178
      prog [] 
179
  in
180
  let dependencies, type_env, clock_env =
181
    List.fold_left (fun (compilation_dep, type_env, clock_env) (s, local) -> 
182
      try
183
	let basename = (if local then s else Version.prefix ^ "/include/lustrec/" ^ s ) ^ ".lusi" in 
184
	Log.report ~level:1 (fun fmt -> fprintf fmt "@[<v 0>Library %s@," basename);
185
	let comp_dep, lusi_type_env, lusi_clock_env = check_lusi (load_lusi false basename) in 
186
	Log.report ~level:1 (fun fmt -> fprintf fmt "@]@ ");
187
	
188
	(s, local, comp_dep)::compilation_dep,
189
	Env.overwrite type_env lusi_type_env,
190
	Env.overwrite clock_env lusi_clock_env      
191
      with Sys_error msg -> (
192
	eprintf "Failure: impossible to load library %s.@.%s@." s msg;
193
	exit 1
194
      )
195
    )  ([], Basic_library.type_env, Basic_library.clock_env) dependencies
196
  in
197
  Log.report ~level:1 (fun fmt -> fprintf fmt "@]@ ");
198
  
199
  (* Sorting nodes *)
200
  let prog = SortProg.sort prog in
201

    
202
  (* Checking stateless/stateful status *)
203
  check_stateless_decls prog;
204

    
205
  (* Typing *)
206
  let computed_types_env = type_decls type_env prog in
207
  
208
  (* Clock calculus *)
209
  let computed_clocks_env = clock_decls clock_env prog in
210

    
211
  (* Perform global inlining *)
212
  let prog =
213
    if !Options.global_inline && 
214
      (match !Options.main_node with | "" -> false | _ -> true) then
215
      Inliner.global_inline basename prog type_env clock_env
216
    else
217
      prog
218
  in
219

    
220
  (* Delay calculus *)
221
  (*
222
    if(!Options.delay_calculus)
223
    then
224
    begin
225
    Log.report ~level:1 (fun fmt -> fprintf fmt ".. initialisation analysis@?");
226
    try
227
    Delay_calculus.delay_prog Basic_library.delay_env prog
228
    with (Delay.Error (loc,err)) as exc ->
229
    Location.print loc;
230
    eprintf "%a" Delay.pp_error err;
231
    Utils.track_exception ();
232
    raise exc
233
    end;
234
  *)
235
  (*
236
    eprintf "Causality analysis@.@?";
237
    (* Causality analysis *)
238
    begin
239
    try
240
    Causality.check_causal_prog prog
241
    with (Causality.Cycle v) as exc ->
242
    Causality.pp_error err_formatter v;
243
    raise exc
244
    end;
245
  *)
246

    
247
  (* Compatibility with Lusi *)
248
  (* Checking the existence of a lusi (Lustre Interface file) *)
249
  let lusi_name = basename ^ ".lusi" in
250
  load_n_check_lusi source_name lusi_name prog computed_types_env computed_clocks_env;
251

    
252
  (* Computes and stores generic calls for each node,
253
     only useful for ANSI C90 compliant generic node compilation *)
254
  if !Options.ansi then Causality.NodeDep.compute_generic_calls prog;
255
  (*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;*)
256

    
257
  (* Normalization phase *)
258
  Log.report ~level:1 (fun fmt -> fprintf fmt ".. normalization@,");
259
  (* Special treatment of arrows in lustre backend. We want to keep them *)
260
  if !Options.output = "lustre" then
261
    Normalization.unfold_arrow_active := false;
262
  let prog = Normalization.normalize_prog prog in
263
  Log.report ~level:2 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog);
264

    
265
  (* Checking array accesses *)
266
  if !Options.check then
267
    begin
268
      Log.report ~level:1 (fun fmt -> fprintf fmt ".. array access checks@,");
269
      Access.check_prog prog;
270
    end;
271

    
272
  (* Computation of node equation scheduling. It also breaks dependency cycles
273
     and warns about unused input or memory variables *)
274
  Log.report ~level:1 (fun fmt -> fprintf fmt ".. scheduling@,");
275
  let prog, node_schs = Scheduling.schedule_prog prog in
276
  Log.report ~level:1 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_warning_unused node_schs);
277
  Log.report ~level:2 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_schedule node_schs);
278
  Log.report ~level:2 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_fanin_table node_schs);
279
  Log.report ~level:2 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog);
280

    
281
 (* Optimization of prog: 
282
    - Unfold consts 
283
    - eliminate trivial expressions
284
 *)
285
  let prog = 
286
    if !Options.optimization >= 2 then 
287
      Optimize_prog.prog_unfold_consts prog 
288
    else
289
      prog
290
  in
291

    
292
  (* DFS with modular code generation *)
293
  Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines generation@,");
294
  let machine_code = Machine_code.translate_prog prog node_schs in
295
  Log.report ~level:2 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@,"
296
    (Utils.fprintf_list ~sep:"@ " Machine_code.pp_machine)
297
    machine_code);
298

    
299
  (* experimental
300
  let machine_code = Machine_code.prog_reuse_var machine_code node_schs in
301
  *)
302
  (* Optimize machine code *)
303
  let machine_code = 
304
    if !Options.optimization >= 2 then
305
      Optimize_machine.optimize_machines machine_code
306
    else
307
      machine_code
308
  in
309
  
310
  (* Creating destination directory if needed *)
311
  if not (Sys.file_exists !Options.dest_dir) then (
312
    Log.report ~level:1 (fun fmt -> fprintf fmt ".. creating destination directory@,");
313
    Unix.mkdir !Options.dest_dir (Unix.stat ".").Unix.st_perm
314
  );
315
  if (Unix.stat !Options.dest_dir).Unix.st_kind <> Unix.S_DIR then (
316
    eprintf "Failure: destination %s is not a directory.@.@." !Options.dest_dir;
317
    exit 1
318
  );
319
  (* Printing code *)
320
  let basename    =  Filename.basename basename in
321
  let destname = !Options.dest_dir ^ "/" ^ basename in
322
  let _ = match !Options.output with
323
      "C" -> 
324
	begin
325
	  let header_file = destname ^ ".h" in (* Could be changed *)
326
	  let source_lib_file = destname ^ ".c" in (* Could be changed *)
327
	  let source_main_file = destname ^ "_main.c" in (* Could be changed *)
328
	  let makefile_file = destname ^ ".makefile" in (* Could be changed *)
329
	  (* let spec_file_opt = if !Options.c_spec then  *)
330
	  (*     ( *)
331
	  (* 	let spec_file = basename ^ "_spec.c" in *)
332
	  (* 	Log.report ~level:1 (fun fmt -> fprintf fmt ".. opening files %s, %s and %s@," header_file source_file spec_file); *)
333
	  (* 	Some spec_file  *)
334
	  (*     ) else ( *)
335
	  (* 	Log.report ~level:1 (fun fmt -> fprintf fmt ".. opening files %s and %s@," header_file source_file); *)
336
	  (* 	None  *)
337
	  (*      ) *)
338
	  (* in  *)
339
	  Log.report ~level:1 (fun fmt -> fprintf fmt ".. C code generation@,");
340
	  C_backend.translate_to_c 
341
	    header_file source_lib_file source_main_file makefile_file
342
	    basename prog machine_code dependencies
343
	end
344
    | "java" ->
345
      begin
346
	failwith "Sorry, but not yet supported !"
347
    (*let source_file = basename ^ ".java" in
348
      Log.report ~level:1 (fun fmt -> fprintf fmt ".. opening file %s@,@?" source_file);
349
      let source_out = open_out source_file in
350
      let source_fmt = formatter_of_out_channel source_out in
351
      Log.report ~level:1 (fun fmt -> fprintf fmt ".. java code generation@,@?");
352
      Java_backend.translate_to_java source_fmt basename normalized_prog machine_code;*)
353
      end
354
    | "horn" ->
355
      begin
356
	let source_file = destname ^ ".smt2" in (* Could be changed *)
357
	let source_out = open_out source_file in
358
	let fmt = formatter_of_out_channel source_out in
359
	Horn_backend.translate fmt basename prog machine_code;
360
	(* Tracability file if option is activated *)
361
	if !Options.horntraces then (
362
	let traces_file = destname ^ ".traces" in (* Could be changed *)
363
	let traces_out = open_out traces_file in
364
	let fmt = formatter_of_out_channel traces_out in
365
	Horn_backend.traces_file fmt basename prog machine_code	  
366
	)
367
      end
368
    | "lustre" -> 
369
      begin
370
	let source_file = destname ^ ".lustrec.lus" in (* Could be changed *)
371
	let source_out = open_out source_file in
372
	let fmt = formatter_of_out_channel source_out in
373
	Printers.pp_prog fmt prog;
374
(*	Lustre_backend.translate fmt basename normalized_prog machine_code *)
375
	()
376
      end
377

    
378
    | _ -> assert false
379
  in
380
  Log.report ~level:1 (fun fmt -> fprintf fmt ".. done !@ @]@.");
381
  (* We stop the process here *)
382
  exit 0
383
  
384
let anonymous filename =
385
  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
386
  if ok_ext then
387
    let basename = Filename.chop_suffix filename ext in
388
    compile basename ext
389
  else
390
    raise (Arg.Bad ("Can only compile *.lusi, *.lus or *.ec files"))
391

    
392
let _ =
393
  Corelang.add_internal_funs ();
394
  try
395
    Printexc.record_backtrace true;
396
    Arg.parse Options.options anonymous usage
397
  with
398
  | Parse.Syntax_err _ | Lexer_lustre.Error _ 
399
  | Types.Error (_,_) | Clocks.Error (_,_)
400
  | Corelang.Error _ (*| Task_set.Error _*) 
401
  | Causality.Cycle _ -> exit 1
402
  | exc -> (Utils.track_exception (); raise exc)
403

    
404
(* Local Variables: *)
405
(* compile-command:"make -C .." *)
406
(* End: *)