Project

General

Profile

Statistics
| Branch: | Tag: | Revision:

lustrec / src / main_lustre_compiler.ml @ 59294251

History | View | Annotate | Download (13.4 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
let usage = "Usage: lustrec [options] <source-file>"
30

    
31
let extensions = [".ec"; ".lus"; ".lusi"]
32

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

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

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

    
96

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

    
102
let load_n_check_lusi source_name lusi_name prog computed_types_env computed_clocks_env= 
103
  try 
104
    let _ = open_in lusi_name in
105
    let header = load_lusi true lusi_name in
106
    let _, declared_types_env, declared_clocks_env = check_lusi header in
107
    
108
      (* checking type compatibility with computed types*)
109
    Typing.check_env_compat header declared_types_env computed_types_env;
110
    Typing.uneval_prog_generics prog;
111
    
112
      (* checking clocks compatibility with computed clocks*)
113
      Clock_calculus.check_env_compat header declared_clocks_env computed_clocks_env;
114
      Clock_calculus.uneval_prog_generics prog;
115

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

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

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

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

    
205
  (* Checking stateless/stateful status *)
206
  check_stateless_decls prog;
207

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

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

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

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

    
254
  (* Normalization phase *)
255
  report ~level:1 (fun fmt -> fprintf fmt ".. normalization@,");
256
  let prog = Normalization.normalize_prog prog in
257
  report ~level:2 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog);
258

    
259
  (* Checking array accesses *)
260
  if !Options.check then
261
    begin
262
      report ~level:1 (fun fmt -> fprintf fmt ".. array access checks@,");
263
      Access.check_prog prog;
264
    end;
265

    
266
  (* Computation of node equation scheduling. It also break dependency cycles. *)
267
  let prog, node_schs = Scheduling.schedule_prog prog in
268

    
269
 (* Optimization of prog: 
270
    - Unfold consts 
271
    - eliminate trivial expressions
272
 *)
273
  let prog = 
274
    if !Options.optimization >= 2 then 
275
      Optimize_prog.prog_unfold_consts prog 
276
    else
277
      prog
278
  in
279

    
280
  (* DFS with modular code generation *)
281
  report ~level:1 (fun fmt -> fprintf fmt ".. machines generation@,");
282
  let machine_code = Machine_code.translate_prog prog node_schs in
283
  report ~level:2 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@,"
284
    (Utils.fprintf_list ~sep:"@ " Machine_code.pp_machine)
285
    machine_code);
286

    
287
  (* Optimize machine code *)
288
  let machine_code = 
289
    if !Options.optimization >= 2 then
290
      Optimize_machine.optimize_machines machine_code
291
    else
292
      machine_code
293
  in
294
  
295
  (* Creating destination directory if needed *)
296
  if not (Sys.file_exists !Options.dest_dir) then (
297
    report ~level:1 (fun fmt -> fprintf fmt ".. creating destination directory@,");
298
    Unix.mkdir !Options.dest_dir (Unix.stat ".").Unix.st_perm
299
  );
300
  if (Unix.stat !Options.dest_dir).Unix.st_kind <> Unix.S_DIR then (
301
    eprintf "Failure: destination %s is not a directory.@.@." !Options.dest_dir;
302
    exit 1
303
  );
304
  (* Printing code *)
305
  let basename    =  Filename.basename basename in
306
  let destname = !Options.dest_dir ^ "/" ^ basename in
307
  let _ = match !Options.output with
308
      "C" -> 
309
	begin
310
	  let header_file = destname ^ ".h" in (* Could be changed *)
311
	  let source_file = destname ^ ".c" in (* Could be changed *)
312
	  let makefile_file = destname ^ ".makefile" in (* Could be changed *)
313
	  let spec_file_opt = if !Options.c_spec then 
314
	      (
315
		let spec_file = basename ^ "_spec.c" in
316
		report ~level:1 (fun fmt -> fprintf fmt ".. opening files %s, %s and %s@," header_file source_file spec_file);
317
		Some spec_file 
318
	      ) else (
319
		report ~level:1 (fun fmt -> fprintf fmt ".. opening files %s and %s@," header_file source_file);
320
		None 
321
	       )
322
	  in 
323
	  let header_out = open_out header_file in
324
	  let header_fmt = formatter_of_out_channel header_out in
325
	  let source_out = open_out source_file in
326
	  let source_fmt = formatter_of_out_channel source_out in
327
	  let makefile_out = open_out makefile_file in
328
	  let makefile_fmt = formatter_of_out_channel makefile_out in
329
	  let spec_fmt_opt = match spec_file_opt with
330
	      None -> None
331
	    | Some f -> Some (formatter_of_out_channel (open_out f))
332
	  in
333
	  report ~level:1 (fun fmt -> fprintf fmt ".. C code generation@,");
334
	  C_backend.translate_to_c header_fmt source_fmt makefile_fmt spec_fmt_opt basename prog machine_code dependencies
335
	end
336
    | "java" ->
337
      begin
338
	failwith "Sorry, but not yet supported !"
339
    (*let source_file = basename ^ ".java" in
340
      report ~level:1 (fun fmt -> fprintf fmt ".. opening file %s@,@?" source_file);
341
      let source_out = open_out source_file in
342
      let source_fmt = formatter_of_out_channel source_out in
343
      report ~level:1 (fun fmt -> fprintf fmt ".. java code generation@,@?");
344
      Java_backend.translate_to_java source_fmt basename normalized_prog machine_code;*)
345
      end
346
    | "horn" ->
347
      begin
348
	let source_file = destname ^ ".smt2" in (* Could be changed *)
349
	let source_out = open_out source_file in
350
	let fmt = formatter_of_out_channel source_out in
351
	Horn_backend.translate fmt basename prog machine_code
352
      end
353
    | "lustre" -> assert false (*
354
      begin
355
	let source_file = destname ^ ".lustrec.lus" in (* Could be changed *)
356
	let source_out = open_out source_file in
357
	let fmt = formatter_of_out_channel source_out in
358
(*	Lustre_backend.translate fmt basename normalized_prog machine_code *)
359
	()
360
      end*)
361

    
362
    | _ -> assert false
363
  in
364
  report ~level:1 (fun fmt -> fprintf fmt ".. done !@ @]@.");
365
  (* We stop the process here *)
366
  exit 0
367
  
368
let anonymous filename =
369
  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
370
  if ok_ext then
371
    let basename = Filename.chop_suffix filename ext in
372
    compile basename ext
373
  else
374
    raise (Arg.Bad ("Can only compile *.lusi, *.lus or *.ec files"))
375

    
376
let _ =
377
  Corelang.add_internal_funs ();
378
  try
379
    Printexc.record_backtrace true;
380
    Arg.parse Options.options anonymous usage
381
  with
382
  | Parse.Syntax_err _ | Lexer_lustre.Error _ 
383
  | Types.Error (_,_) | Clocks.Error (_,_)
384
  | Corelang.Error _ (*| Task_set.Error _*) 
385
  | Causality.Cycle _ -> exit 1
386
  | exc -> (Utils.track_exception (); raise exc)
387

    
388
(* Local Variables: *)
389
(* compile-command:"make -C .." *)
390
(* End: *)