CristalCaveGem » LustreC

open Format

open Utils

open Compiler_common

open Lustre_types

module Mpfr = Lustrec_mpfr

exception StopPhase1 of program_t

let dynamic_checks () =

  match !Options.output, !Options.spec with

  | "C", "C" -> true

  | _ -> false

(* check whether a source file has a compiled header, if not, generate the

   compiled header *)

let compile_source_to_header prog computed_types_env computed_clocks_env dirname basename extension =

  let destname = !Options.dest_dir ^ "/" ^ basename in

  let lusic_ext = ".lusic" in

  let header_name = destname ^ lusic_ext in

  begin

    if (* Generating the lusic file *)

      extension = ".lusi" (* because input is a lusi *)

      || (extension = ".lus" &&

            not (Sys.file_exists header_name))

           (* or because it is a lus but not lusic exists *)

      || (let lusic = Lusic.read_lusic destname lusic_ext in

          not lusic.Lusic.from_lusi)

         (* or the lusic exists but is not generated from a lusi, hence it

            has te be regenerated *)

    then

      begin

	Log.report ~level:1 (fun fmt -> fprintf fmt ".. generating compiled header file %s@," header_name);

	Lusic.write_lusic

          (extension = ".lusi") (* is it a lusi file ? *)

          (if extension = ".lusi" then prog else Lusic.extract_header dirname basename prog)

          destname

          lusic_ext;

        let _ =

          match !Options.output with

          | "C" -> C_backend_lusic.print_lusic_to_h destname lusic_ext

          | _ -> ()

        in

        ()

      end

    else (* Lusic exists and is usable. Checking compatibility *)

      begin

	Log.report ~level:1 (fun fmt -> fprintf fmt ".. loading compiled header file %s@," header_name);

        let lusic = Lusic.read_lusic destname lusic_ext in

        Lusic.check_obsolete lusic destname;

	let header = lusic.Lusic.contents in

	let (declared_types_env, declared_clocks_env) = Modules.get_envs_from_top_decls header in

	check_compatibility

	  (prog, computed_types_env, computed_clocks_env)

	  (header, declared_types_env, declared_clocks_env)

      end

  end

(* From prog to prog *)

let stage1 params prog dirname basename extension =

  (* Updating parent node information for variables *)

  Compiler_common.update_vdecl_parents_prog prog;

  (* Removing automata *)

  let prog = expand_automata prog in

  Log.report ~level:4 (fun fmt -> fprintf fmt ".. after automata expansion:@,  @[<v 2>@,%a@]@ " Printers.pp_prog prog);

  (* Importing source *)

  let prog, dependencies, (typ_env, clk_env) = Modules.load ~is_header:(extension = ".lusi") prog in

  (* Registering types and clocks for future checks *)

  Global.type_env := Env.overwrite !Global.type_env typ_env;

  Global.clock_env := Env.overwrite !Global.clock_env clk_env;

  (* (\* Extracting dependencies (and updating Global.(type_env/clock_env) *\)

   * let dependencies = import_dependencies prog in *)

  (* Sorting nodes *)

  let prog = SortProg.sort prog in

  (* Consolidating contracts *)

  let prog = resolve_contracts prog in

  let prog = SortProg.sort prog in

  Log.report ~level:3 (fun fmt ->

      Format.fprintf fmt "@[<v 0>Contracts resolved:@ %a@ @]@ " Printers.pp_prog prog);

  (* Consolidating main node *)

  let _ =

    match !Options.main_node with

    | "" -> ()

    | main_node -> (

      Global.main_node := main_node;

      try

        ignore (Corelang.node_from_name main_node)

      with Not_found -> (

        Format.eprintf "Code generation error: %a@." Error.pp_error_msg Error.Main_not_found;

        raise (Error.Error (Location.dummy_loc, Error.Main_not_found))

    ))

  in

  (* Perform inlining before any analysis *)

  let orig, prog =

    if !Options.global_inline && !Global.main_node <> "" then

      (if !Options.witnesses then prog else []),

      Inliner.global_inline basename prog

    else (* if !Option.has_local_inline *)

      [],

      Inliner.local_inline prog (* type_env clock_env *)

  in

  (* Checking stateless/stateful status *)

  if Plugins.check_force_stateful () then

    force_stateful_decls prog

  else

    check_stateless_decls prog;

  (* Typing *)

  Global.type_env := type_decls !Global.type_env prog;

  (* Clock calculus *)

  Global.clock_env := clock_decls !Global.clock_env prog;

  (* Registering and checking machine types *)

  if Machine_types.is_active then Machine_types.load prog;

  (* Generating a .lusi header file only *)

  if !Options.lusi || !Options.print_nodes then

    (* We stop here the processing and produce the current prog. It will be

       exported as a lusi *)

    raise (StopPhase1 prog);

  (* Optimization of prog:

     - Unfold consts

     - eliminate trivial expressions

   *)

  let prog =

    if !Options.const_unfold || !Options.optimization >= 5 then

      begin

        Log.report ~level:1 (fun fmt -> fprintf fmt ".. eliminating constants and aliases@,");

        Optimize_prog.prog_unfold_consts prog

      end

    else

      prog

  in

  (* Delay calculus *)

  (* TO BE DONE LATER (Xavier)

     if(!Options.delay_calculus)

     then

     begin

     Log.report ~level:1 (fun fmt -> fprintf fmt ".. initialisation analysis@?");

     try

     Delay_calculus.delay_prog Basic_library.delay_env prog

     with (Delay.Error (loc,err)) as exc ->

     Location.print loc;

     eprintf "%a" Delay.pp_error err;

     Utils.track_exception ();

     raise exc

     end;

   *)

  (* Creating destination directory if needed *)

  create_dest_dir ();

  Typing.uneval_prog_generics prog;

  Clock_calculus.uneval_prog_generics prog;

  (* Disabling witness option. Could but reactivated later

  if !Options.global_inline && !Options.main_node <> "" && !Options.witnesses then

    begin

      let orig = Corelang.copy_prog orig in

      Log.report ~level:1 (fun fmt -> fprintf fmt ".. generating witness file@,");

      check_stateless_decls orig;

      let _ = Typing.type_prog type_env orig in

      let _ = Clock_calculus.clock_prog clock_env orig in

      Typing.uneval_prog_generics orig;

      Clock_calculus.uneval_prog_generics orig;

      Inliner.witness

	basename

	!Options.main_node

	orig prog type_env clock_env

    end;

   *)

  (* Computes and stores generic calls for each node,

     only useful for ANSI C90 compliant generic node compilation *)

  if !Options.ansi then Causality.NodeDep.compute_generic_calls prog;

  (*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;*)

  (* If some backend involving dynamic checks are active, then node annotations become runtime checks *)

  let prog =

    if dynamic_checks () then

      Spec.enforce_spec_prog prog

    else

      prog

  in

  (* (\* Registering and checking machine types *\) *)

  (* Machine_types.load prog; *)

  (* Normalization phase *)

  Log.report ~level:1 (fun fmt -> fprintf fmt ".. normalization@,");

  let prog = Normalization.normalize_prog params prog in

  Log.report ~level:2 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog_short prog);

  Log.report ~level:3  (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog);

  (* Compatibility with Lusi *)

  (* If compiling a lusi, generate the lusic. If this is a lus file, Check the existence of a lusi (Lustre Interface file) *)

  if !Options.compile_header then

    compile_source_to_header

      prog !Global.type_env !Global.clock_env dirname basename extension;

  let prog =

    if !Options.mpfr

    then

      begin

	Log.report ~level:1 (fun fmt -> fprintf fmt ".. targetting MPFR library@,");

	Mpfr.inject_prog prog

      end

    else

      begin

	Log.report ~level:1 (fun fmt -> fprintf fmt ".. keeping floating-point numbers@,");

	prog

      end in

  Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog);

  (* Checking array accesses *)

  if !Options.check then

    begin

      Log.report ~level:1 (fun fmt -> fprintf fmt ".. checking array accesses@,");

      Access.check_prog prog;

    end;

  let prog = SortProg.sort_nodes_locals prog in

  prog, dependencies

    (* from source to machine code, with optimization *)

let stage2 params prog =

  (* Computation of node equation scheduling. It also breaks dependency cycles

     and warns about unused input or memory variables *)

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

  let prog, node_schs =

    try

      Scheduling.schedule_prog prog

    with Causality.Error _ -> (* Error is not kept. It is recomputed in a more

				 systemtic way in AlgebraicLoop module *)

      AlgebraicLoop.analyze prog

  in

  Log.report ~level:1 (fun fmt -> fprintf fmt "%a"              Scheduling.pp_warning_unused node_schs);

  Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_schedule node_schs);

  Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_fanin_table node_schs);

  Log.report ~level:5 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Scheduling.pp_dep_graph node_schs);

  Log.report ~level:3 (fun fmt -> fprintf fmt "@[<v 2>@ %a@]@," Printers.pp_prog prog);

  Log.report ~level:1 (fun fmt -> fprintf fmt "@]@ ");

  (* TODO Salsa optimize prog:

     - emits warning for programs with pre inside expressions

     - make sure each node arguments and memory is bounded by a local annotation

     - introduce fresh local variables for each real pure subexpression

  *)

  (* DFS with modular code generation *)

  Log.report ~level:1 (fun fmt -> fprintf fmt ".. machines generation@,");

  let machine_code = Machine_code.translate_prog prog node_schs in

  Log.report ~level:3 (fun fmt -> fprintf fmt ".. generated machines (unoptimized):@ %a@ " Machine_code_common.pp_machines machine_code);

  (* Optimize machine code *)

  Optimize_machine.optimize params prog node_schs machine_code

(* printing code *)

let stage3 prog machine_code dependencies basename extension =

  let basename    =  Filename.basename basename in

  match !Options.output, extension with

    "C", ".lus" -> 

     begin

       Log.report ~level:1 (fun fmt -> fprintf fmt ".. C code generation@,");

       C_backend.translate_to_c

	 (* alloc_header_file source_lib_file source_main_file makefile_file *)

	 basename prog machine_code dependencies

     end

  |  "C", _ -> 

      begin

      	Log.report ~level:1 (fun fmt -> fprintf fmt ".. no C code generation for lusi@,");

      end

  | "java", _ ->

     begin

       (Format.eprintf "internal error: sorry, but not yet supported !"; assert false)

     (*let source_file = basename ^ ".java" in

       Log.report ~level:1 (fun fmt -> fprintf fmt ".. opening file %s@,@?" source_file);

       let source_out = open_out source_file in

       let source_fmt = formatter_of_out_channel source_out in

       Log.report ~level:1 (fun fmt -> fprintf fmt ".. java code generation@,@?");

       Java_backend.translate_to_java source_fmt basename normalized_prog machine_code;*)

     end

  | "Ada", _ ->

    begin

      Log.report ~level:1 (fun fmt -> fprintf fmt ".. Ada code generation@.");

      Ada_backend.translate_to_ada

      basename prog (Machine_code_common.arrow_machine::machine_code) dependencies

    end

  | "horn", _ ->

     begin

       let destname = !Options.dest_dir ^ "/" ^ basename in

       let source_file = destname ^ ".smt2" in (* Could be changed *)

       let source_out = open_out source_file in

       let fmt = formatter_of_out_channel source_out in

       Log.report ~level:1 (fun fmt -> fprintf fmt ".. hornification@,");

       Horn_backend.translate fmt basename prog (Machine_code_common.arrow_machine::machine_code);

       (* Tracability file if option is activated *)

       if !Options.traces then (

	 let traces_file = destname ^ ".traces.xml" in (* Could be changed *)

	 let traces_out = open_out traces_file in

	 let fmt = formatter_of_out_channel traces_out in

         Log.report ~level:1 (fun fmt -> fprintf fmt ".. tracing info@,");

	 Horn_backend_traces.traces_file fmt basename prog machine_code;

       )

     end

  | "lustre", _ ->

     begin

       let destname = !Options.dest_dir ^ "/" ^ basename in

       let source_file = destname ^ ".lustrec" ^ extension  in (* Could be changed *)

       Log.report ~level:1 (fun fmt -> fprintf fmt ".. exporting processed file as %s@," source_file);

       let source_out = open_out source_file in

       let fmt = formatter_of_out_channel source_out in

       Printers.pp_prog fmt prog;

       Format.fprintf fmt "@.@?";

       (*	Lustre_backend.translate fmt basename normalized_prog machine_code *)

       ()

     end

  | "emf", _ ->

     begin

       let destname = !Options.dest_dir ^ "/" ^ basename in

       let source_file = destname ^ ".json" in (* Could be changed *)

       let source_out = open_out source_file in

       let fmt = formatter_of_out_channel source_out in

       EMF_backend.translate fmt basename prog machine_code;

       ()

     end

  | _ -> assert false