CristalCaveGem » LustreC

(********************************************************************)

(*                                                                  *)

(*  The LustreC compiler toolset   /  The LustreC Development Team  *)

(*  Copyright 2012 -    --   ONERA - CNRS - INPT                    *)

(*                                                                  *)

(*  LustreC is free software, distributed WITHOUT ANY WARRANTY      *)

(*  under the terms of the GNU Lesser General Public License        *)

(*  version 2.1.                                                    *)

(*                                                                  *)

(********************************************************************)

open Format 

open LustreSpec

open Corelang

open Machine_code

open C_backend_common

(********************************************************************************************)

(*                         Header Printing functions                                        *)

(********************************************************************************************)

module type MODIFIERS_HDR =

sig

  val print_machine_decl_prefix: Format.formatter -> Machine_code.machine_t -> unit

end

module EmptyMod =

struct

  let print_machine_decl_prefix = fun fmt x -> ()

end

module Main = functor (Mod: MODIFIERS_HDR) -> 

struct

let print_import_standard fmt =

  begin

    if !Options.mpfr then

      begin

	fprintf fmt "#include <mpfr.h>@."

      end;

    fprintf fmt "#include \"%s/arrow.h\"@.@." Version.include_path

  end

let rec print_static_val pp_var fmt v =

  match v.value_desc with

  | Cst c         -> pp_c_const fmt c

  | LocalVar v    -> pp_var fmt v

  | Fun (n, vl)   -> Basic_library.pp_c n (print_static_val pp_var) fmt vl

  | _             -> (Format.eprintf "Internal error: C_backend_header.print_static_val"; assert false)

let print_constant_decl (m, attr, inst) pp_var fmt v =

  Format.fprintf fmt "%s %a = %a"

    attr

    (pp_c_type (Format.sprintf "%s ## %s" inst v.var_id)) v.var_type

    (print_static_val pp_var) (Machine_code.get_const_assign m v)

let print_static_constant_decl (m, attr, inst) fmt const_locals =

  let pp_var fmt v =

    if List.mem v const_locals

    then

      Format.fprintf fmt "%s ## %s" inst v.var_id

    else 

      Format.fprintf fmt "%s" v.var_id in

  Format.fprintf fmt "%a%t"

    (Utils.fprintf_list ~sep:";\\@," (print_constant_decl (m, attr, inst) pp_var)) const_locals

    (Utils.pp_final_char_if_non_empty ";\\@," const_locals)

let print_static_declare_instance (m, attr, inst) const_locals fmt (i, (n, static)) =

  let pp_var fmt v =

    if List.mem v const_locals

    then

      Format.fprintf fmt "%s ## %s" inst v.var_id

    else 

      Format.fprintf fmt "%s" v.var_id in

  let values = List.map (Machine_code.value_of_dimension m) static in

  fprintf fmt "%a(%s, %a%t%s)"

    pp_machine_static_declare_name (node_name n)

    attr

    (Utils.fprintf_list ~sep:", " (print_static_val pp_var)) values

    (Utils.pp_final_char_if_non_empty ", " static)

    i

let print_static_declare_macro fmt (m, attr, inst) =

  let const_locals = List.filter (fun vdecl -> vdecl.var_dec_const) m.mstep.step_locals in

  let array_mem = List.filter (fun v -> Types.is_array_type v.var_type) m.mmemory in

  fprintf fmt "@[<v 2>#define %a(%s, %a%t%s)\\@,%a%s %a %s;\\@,%a%t%a;@,@]"

    pp_machine_static_declare_name m.mname.node_id

    attr

    (Utils.fprintf_list ~sep:", " (pp_c_var_read m)) m.mstatic

    (Utils.pp_final_char_if_non_empty ", " m.mstatic)

    inst

    (* constants *)

    (print_static_constant_decl (m, attr, inst)) const_locals

    attr

    pp_machine_memtype_name m.mname.node_id

    inst

    (Utils.fprintf_list ~sep:";\\@," (pp_c_decl_local_var m)) array_mem

    (Utils.pp_final_char_if_non_empty ";\\@," array_mem)

    (Utils.fprintf_list ~sep:";\\@,"

       (fun fmt (i',m') ->

	 let path = sprintf "%s ## _%s" inst i' in

	 fprintf fmt "%a"

	   (print_static_declare_instance (m, attr, inst) const_locals) (path, m')

       )) m.minstances

let print_static_link_instance fmt (i, (m, _)) =

 fprintf fmt "%a(%s)" pp_machine_static_link_name (node_name m) i

(* Allocation of a node struct:

   - if node memory is an array/matrix/etc, we cast it to a pointer (see pp_registers_struct)

*)

let print_static_link_macro fmt (m, attr, inst) =

  let array_mem = List.filter (fun v -> Types.is_array_type v.var_type) m.mmemory in

  fprintf fmt "@[<v>@[<v 2>#define %a(%s) do {\\@,%a%t%a;\\@]@,} while (0)@.@]"

    pp_machine_static_link_name m.mname.node_id

    inst

    (Utils.fprintf_list ~sep:";\\@,"

       (fun fmt v ->

	 fprintf fmt "%s._reg.%s = (%a*) &%s"

	   inst

	   v.var_id

           (fun fmt v -> pp_c_type "" fmt (Types.array_base_type v.var_type)) v

	   v.var_id

       )) array_mem

    (Utils.pp_final_char_if_non_empty ";\\@," array_mem)

    (Utils.fprintf_list ~sep:";\\@,"

       (fun fmt (i',m') ->

	 let path = sprintf "%s ## _%s" inst i' in

	 fprintf fmt "%a;\\@,%s.%s = &%s"

	   print_static_link_instance (path,m')

	   inst

	   i'

	   path

       )) m.minstances

let print_static_alloc_macro fmt (m, attr, inst) =

  fprintf fmt "@[<v>@[<v 2>#define %a(%s, %a%t%s)\\@,%a(%s, %a%t%s);\\@,%a(%s);@]@,@]@."

    pp_machine_static_alloc_name m.mname.node_id

    attr

    (Utils.fprintf_list ~sep:", " (pp_c_var_read m)) m.mstatic

    (Utils.pp_final_char_if_non_empty ", " m.mstatic)

    inst

    pp_machine_static_declare_name m.mname.node_id

    attr

    (Utils.fprintf_list ~sep:", " (pp_c_var_read m)) m.mstatic

    (Utils.pp_final_char_if_non_empty ", " m.mstatic)

    inst

    pp_machine_static_link_name m.mname.node_id

    inst

let print_machine_decl fmt m =

  Mod.print_machine_decl_prefix fmt m;

  if fst (get_stateless_status m) then

    begin

      fprintf fmt "extern %a;@.@."

	print_stateless_prototype

	(m.mname.node_id, m.mstep.step_inputs, m.mstep.step_outputs)

    end

  else

    begin

      (* Static allocation *)

      if !Options.static_mem

      then

	begin

	  let inst = mk_instance m in

	  let attr = mk_attribute m in

	  fprintf fmt "%a@.%a@.%a@."

	    print_static_declare_macro (m, attr, inst)

	    print_static_link_macro (m, attr, inst)

	    print_static_alloc_macro (m, attr, inst)

	end

      else

	begin 

        (* Dynamic allocation *)

	  fprintf fmt "extern %a;@.@."

	    print_alloc_prototype (m.mname.node_id, m.mstatic)

	end;

      let self = mk_self m in

      fprintf fmt "extern %a;@.@."

	(print_reset_prototype self) (m.mname.node_id, m.mstatic);

     fprintf fmt "extern %a;@.@."

	(print_init_prototype self) (m.mname.node_id, m.mstatic);

     fprintf fmt "extern %a;@.@."

	(print_clear_prototype self) (m.mname.node_id, m.mstatic);

      fprintf fmt "extern %a;@.@."

	(print_step_prototype self)

	(m.mname.node_id, m.mstep.step_inputs, m.mstep.step_outputs)

    end

let print_machine_alloc_decl fmt m =

  Mod.print_machine_decl_prefix fmt m;

  if fst (get_stateless_status m) then

    begin

    end

  else

    begin

      if !Options.static_mem

      then

	begin

	  (* Static allocation *)

	  let inst = mk_instance m in

	  let attr = mk_attribute m in

	  fprintf fmt "%a@.%a@.%a@."

		  print_static_declare_macro (m, attr, inst)

		  print_static_link_macro (m, attr, inst)

		  print_static_alloc_macro (m, attr, inst)

	end

      else

	begin 

          (* Dynamic allocation *)

	  fprintf fmt "extern %a;@."

		  print_alloc_prototype (m.mname.node_id, m.mstatic)

	end

    end

let print_machine_decl_from_header fmt inode =

  (*Mod.print_machine_decl_prefix fmt m;*)

  if inode.nodei_prototype = Some "C" then

    if inode.nodei_stateless then

      begin

	fprintf fmt "extern %a;@.@."

	  print_stateless_C_prototype

	  (inode.nodei_id, inode.nodei_inputs, inode.nodei_outputs)

      end

    else (

      raise (Invalid_argument ("A node with declared prototype C cannot be stateful, it has to be a function")))

  else

    if inode.nodei_stateless then

    begin

      fprintf fmt "extern %a;@.@."

	print_stateless_prototype 

	(inode.nodei_id, inode.nodei_inputs, inode.nodei_outputs)

    end

    else 

      begin

	let static_inputs = List.filter (fun v -> v.var_dec_const) inode.nodei_inputs in

	let used name =

	  (List.exists (fun v -> v.var_id = name) inode.nodei_inputs)

	  || (List.exists (fun v -> v.var_id = name) inode.nodei_outputs) in

	let self = mk_new_name used "self" in

	fprintf fmt "extern %a;@.@."

	  (print_reset_prototype self) (inode.nodei_id, static_inputs);

	fprintf fmt "extern %a;@.@."

	  (print_init_prototype self) (inode.nodei_id, static_inputs);

	fprintf fmt "extern %a;@.@."

	  (print_clear_prototype self) (inode.nodei_id, static_inputs);

	fprintf fmt "extern %a;@.@."

	  (print_step_prototype self)

	  (inode.nodei_id, inode.nodei_inputs, inode.nodei_outputs)

      end

let print_const_decl fmt cdecl =

  fprintf fmt "extern %a;@." 

    (pp_c_type cdecl.const_id) cdecl.const_type

let rec pp_c_struct_type_field filename cpt fmt (label, tdesc) =

  fprintf fmt "%a;" (pp_c_type_decl filename cpt label) tdesc

and pp_c_type_decl filename cpt var fmt tdecl =

  match tdecl with

  | Tydec_any           -> assert false

  | Tydec_int           -> fprintf fmt "int %s" var

  | Tydec_real when !Options.mpfr

                        -> fprintf fmt "%s %s" Mpfr.mpfr_t var

  | Tydec_real          -> fprintf fmt "double %s" var

  (* | Tydec_float         -> fprintf fmt "float %s" var *)

  | Tydec_bool          -> fprintf fmt "_Bool %s" var

  | Tydec_clock ty      -> pp_c_type_decl filename cpt var fmt ty

  | Tydec_const c       -> fprintf fmt "%s %s" c var

  | Tydec_array (d, ty) -> fprintf fmt "%a[%a]" (pp_c_type_decl filename cpt var) ty pp_c_dimension d

  | Tydec_enum tl ->

    begin

      incr cpt;

      fprintf fmt "enum _enum_%s_%d { %a } %s" filename !cpt (Utils.fprintf_list ~sep:", " pp_print_string) tl var

    end

  | Tydec_struct fl ->

    begin

      incr cpt;

      fprintf fmt "struct _struct_%s_%d { %a } %s" filename !cpt (Utils.fprintf_list ~sep:" " (pp_c_struct_type_field filename cpt)) fl var

    end

let print_type_definitions fmt filename =

  let cpt_type = ref 0 in

  Hashtbl.iter (fun typ decl ->

		match typ with

		| Tydec_const var ->

		   (match decl.top_decl_desc with

		    | TypeDef tdef ->

		       fprintf fmt "typedef %a;@.@."

			       (pp_c_type_decl filename cpt_type var) tdef.tydef_desc

		    | _ -> assert false)

		| _        -> ()) type_table

let reset_type_definitions, print_type_definition_from_header =

  let cpt_type =ref 0 in

  ((fun () -> cpt_type := 0),

   (fun fmt typ filename ->

    fprintf fmt "typedef %a;@.@."

	(pp_c_type_decl filename cpt_type typ.tydef_id) typ.tydef_desc))

(********************************************************************************************)

(*                         MAIN Header Printing functions                                   *)

(********************************************************************************************)

let print_header header_fmt basename prog machines dependencies =

  (* Include once: start *)

  let baseNAME = String.uppercase basename in

  let baseNAME = Str.global_replace (Str.regexp "\\.\\|\\ ") "_" baseNAME in

  begin

    (* Print the svn version number and the supported C standard (C90 or C99) *)

    print_version header_fmt;

    fprintf header_fmt "#ifndef _%s@.#define _%s@." baseNAME baseNAME;

    pp_print_newline header_fmt ();

    fprintf header_fmt "/* Imports standard library */@.";

    (* imports standard library definitions (arrow) *)

    print_import_standard header_fmt;

    pp_print_newline header_fmt ();

    (* imports dependencies *)

    fprintf header_fmt "/* Import Dependencies */@.";

    fprintf header_fmt "@[<v>";

    List.iter (print_import_prototype header_fmt) dependencies;

    fprintf header_fmt "@]@.";

    fprintf header_fmt "/* Types definitions */@.";

    (* Print the type definitions from the type table *)

    print_type_definitions header_fmt basename;

    pp_print_newline header_fmt ();

    (* Print the global constant declarations. *)

    fprintf header_fmt "/* Global constant (declarations, definitions are in C file) */@.";

    List.iter (fun c -> print_const_decl header_fmt (const_of_top c)) (get_consts prog);

    pp_print_newline header_fmt ();

    (* Print the struct declarations of all machines. *)

    fprintf header_fmt "/* Struct declarations */@.";

    List.iter (print_machine_struct header_fmt) machines;

    pp_print_newline header_fmt ();

    (* Print the prototypes of all machines *)

    fprintf header_fmt "/* Nodes declarations */@.";

    List.iter (print_machine_decl header_fmt) machines;

    pp_print_newline header_fmt ();

    (* Include once: end *)

    fprintf header_fmt "#endif@.";

    pp_print_newline header_fmt ()

  end

let print_alloc_header header_fmt basename prog machines dependencies =

  (* Include once: start *)

  let baseNAME = String.uppercase basename in

  let baseNAME = Str.global_replace (Str.regexp "\\.\\|\\ ") "_" baseNAME in

  begin

    (* Print the svn version number and the supported C standard (C90 or C99) *)

    print_version header_fmt;

    fprintf header_fmt "#ifndef _%s_alloc@.#define _%s_alloc@." baseNAME baseNAME;

    pp_print_newline header_fmt ();

    (* Import the header *)

    fprintf header_fmt "/* Import header from %s */@." basename;

    fprintf header_fmt "@[<v>";

    print_import_prototype header_fmt (Dep (true, basename, [], true (* assuming it is staful *) ));

    fprintf header_fmt "@]@.";

    fprintf header_fmt "/* Import dependencies */@.";

    fprintf header_fmt "@[<v>";

    List.iter (print_import_alloc_prototype header_fmt) dependencies;

    fprintf header_fmt "@]@.";

    (* Print the struct definitions of all machines. *)

    fprintf header_fmt "/* Struct definitions */@.";

    List.iter (print_machine_struct header_fmt) machines;

    pp_print_newline header_fmt ();

    (* Print the prototypes of all machines *)

    fprintf header_fmt "/* Node allocation function/macro prototypes */@.";

    List.iter (print_machine_alloc_decl header_fmt) machines;

    pp_print_newline header_fmt ();

    (* Include once: end *)

    fprintf header_fmt "#endif@.";

    pp_print_newline header_fmt ()

  end

(* Function called when compiling a lusi file and generating the associated C

   header. *)

let print_header_from_header header_fmt basename header =

  (* Include once: start *)

  let baseNAME = String.uppercase basename in

  let baseNAME = Str.global_replace (Str.regexp "\\.\\|\\ ") "_" baseNAME in

  let types = get_typedefs header in

  let consts = get_consts header in

  let nodes = get_imported_nodes header in

  let dependencies = get_dependencies header in

  begin

    (* Print the svn version number and the supported C standard (C90 or C99) *)

    print_version header_fmt;

    fprintf header_fmt "#ifndef _%s@.#define _%s@." baseNAME baseNAME;

    pp_print_newline header_fmt ();

    fprintf header_fmt "/* Imports standard library */@.";

    (* imports standard library definitions (arrow) *)

    print_import_standard header_fmt;

    pp_print_newline header_fmt ();

    (* imports dependencies *)

    fprintf header_fmt "/* Import dependencies */@.";

    fprintf header_fmt "@[<v>";

    List.iter

      (fun dep -> 

	let (local, s) = dependency_of_top dep in 

	print_import_prototype header_fmt (Dep (local, s, [], true (* assuming it is stateful *))))

      dependencies;

    fprintf header_fmt "@]@.";

    fprintf header_fmt "/* Types definitions */@.";

    (* Print the type definitions from the type table *)

    reset_type_definitions ();

    List.iter (fun typ -> print_type_definition_from_header header_fmt (typedef_of_top typ) basename) types;

    pp_print_newline header_fmt ();

    (* Print the global constant declarations. *)

    fprintf header_fmt "/* Global constant (declarations, definitions are in C file) */@.";

    List.iter (fun c -> print_const_decl header_fmt (const_of_top c)) consts;

    pp_print_newline header_fmt ();

    (* Print the struct declarations of all machines. *)

    fprintf header_fmt "/* Struct declarations */@.";

    List.iter (fun node -> print_machine_struct_from_header header_fmt (imported_node_of_top node)) nodes;

    pp_print_newline header_fmt ();

    (* Print the prototypes of all machines *)

    fprintf header_fmt "/* Nodes declarations */@.";

    List.iter (fun node -> print_machine_decl_from_header header_fmt (imported_node_of_top node)) nodes;

    pp_print_newline header_fmt ();

    (* Include once: end *)

    fprintf header_fmt "#endif@.";

    pp_print_newline header_fmt ()

  end

end

(* Local Variables: *)

(* compile-command:"make -C ../../.." *)

(* End: *)