Project

General

Profile

Statistics
| Branch: | Tag: | Revision:

lustrec / src / backends / C / c_backend_common.ml @ 2d179f5b

History | View | Annotate | Download (14 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 LustreSpec
14
open Corelang
15
open Machine_code
16

    
17

    
18
let print_version fmt =
19
  Format.fprintf fmt 
20
    "/* @[<v>C code generated by %s@,SVN version number %s@,Code is %s compliant */@,@]@."
21
    (Filename.basename Sys.executable_name) 
22
    Version.number 
23
    (if !Options.ansi then "ANSI C90" else "C99")
24
 
25
(* Generation of a non-clashing name for the self memory variable (for step and reset functions) *)
26
let mk_self m =
27
  let used name =
28
       (List.exists (fun v -> v.var_id = name) m.mstep.step_inputs)
29
    || (List.exists (fun v -> v.var_id = name) m.mstep.step_outputs)
30
    || (List.exists (fun v -> v.var_id = name) m.mstep.step_locals)
31
    || (List.exists (fun v -> v.var_id = name) m.mmemory) in
32
  mk_new_name used "self"
33

    
34
(* Generation of a non-clashing name for the instance variable of static allocation macro *)
35
let mk_instance m =
36
  let used name =
37
       (List.exists (fun v -> v.var_id = name) m.mstep.step_inputs)
38
    || (List.exists (fun v -> v.var_id = name) m.mmemory) in
39
  mk_new_name used "inst"
40

    
41
(* Generation of a non-clashing name for the attribute variable of static allocation macro *)
42
let mk_attribute m =
43
  let used name =
44
       (List.exists (fun v -> v.var_id = name) m.mstep.step_inputs)
45
    || (List.exists (fun v -> v.var_id = name) m.mmemory) in
46
  mk_new_name used "attr"
47

    
48
let mk_call_var_decl loc id =
49
  { var_id = id;
50
    var_orig = false;
51
    var_dec_type = mktyp Location.dummy_loc Tydec_any;
52
    var_dec_clock = mkclock Location.dummy_loc Ckdec_any;
53
    var_dec_const = false;
54
    var_dec_value = None;
55
    var_type = Type_predef.type_arrow (Types.new_var ()) (Types.new_var ());
56
    var_clock = Clocks.new_var true;
57
    var_loc = loc }
58

    
59
(* counter for loop variable creation *)
60
let loop_cpt = ref (-1)
61

    
62
let reset_loop_counter () =
63
 loop_cpt := -1
64

    
65
let mk_loop_var m () =
66
  let vars = m.mstep.step_inputs@m.mstep.step_outputs@m.mstep.step_locals@m.mmemory in
67
  let rec aux () =
68
    incr loop_cpt;
69
    let s = Printf.sprintf "__%s_%d" "i" !loop_cpt in
70
    if List.exists (fun v -> v.var_id = s) vars then aux () else s
71
  in aux ()
72
(*
73
let addr_cpt = ref (-1)
74

    
75
let reset_addr_counter () =
76
 addr_cpt := -1
77

    
78
let mk_addr_var m var =
79
  let vars = m.mmemory in
80
  let rec aux () =
81
    incr addr_cpt;
82
    let s = Printf.sprintf "%s_%s_%d" var "addr" !addr_cpt in
83
    if List.exists (fun v -> v.var_id = s) vars then aux () else s
84
  in aux ()
85
*)
86
let pp_machine_memtype_name fmt id = fprintf fmt "struct %s_mem" id
87
let pp_machine_regtype_name fmt id = fprintf fmt "struct %s_reg" id
88
let pp_machine_alloc_name fmt id = fprintf fmt "%s_alloc" id
89
let pp_machine_static_declare_name fmt id = fprintf fmt "%s_DECLARE" id
90
let pp_machine_static_link_name fmt id = fprintf fmt "%s_LINK" id
91
let pp_machine_static_alloc_name fmt id = fprintf fmt "%s_ALLOC" id
92
let pp_machine_reset_name fmt id = fprintf fmt "%s_reset" id
93
let pp_machine_step_name fmt id = fprintf fmt "%s_step" id
94

    
95
let rec pp_c_dimension fmt dim =
96
  match dim.Dimension.dim_desc with
97
  | Dident id       ->
98
    fprintf fmt "%s" id
99
  | Dint i          ->
100
    fprintf fmt "%d" i
101
  | Dbool b         ->
102
    fprintf fmt "%B" b
103
  | Dite (i, t, e)  ->
104
    fprintf fmt "((%a)?%a:%a)"
105
       pp_c_dimension i pp_c_dimension t pp_c_dimension e
106
 | Dappl (f, args) ->
107
     fprintf fmt "%a" (Basic_library.pp_c f pp_c_dimension) args
108
 | Dlink dim' -> fprintf fmt "%a" pp_c_dimension dim'
109
 | Dvar       -> fprintf fmt "_%s" (Utils.name_of_dimension dim.dim_id)
110
 | Dunivar    -> fprintf fmt "'%s" (Utils.name_of_dimension dim.dim_id)
111

    
112
let is_basic_c_type t =
113
  match (Types.repr t).Types.tdesc with
114
  | Types.Tbool | Types.Treal | Types.Tint  -> true
115
  | _                                       -> false
116

    
117
let pp_basic_c_type fmt t =
118
  match (Types.repr t).Types.tdesc with
119
  | Types.Tbool           -> fprintf fmt "_Bool"
120
  | Types.Treal           -> fprintf fmt "double"
121
  | Types.Tint            -> fprintf fmt "int"
122
  | _ -> assert false (* Not a basic C type. Do not handle arrays or pointers *)
123

    
124
let pp_c_type var fmt t =
125
  let rec aux t pp_suffix =
126
    match (Types.repr t).Types.tdesc with
127
    | Types.Tclock t'       -> aux t' pp_suffix
128
    | Types.Tbool | Types.Treal | Types.Tint 
129
                            -> fprintf fmt "%a %s%a" pp_basic_c_type t var pp_suffix ()
130
    | Types.Tarray (d, t')  ->
131
      let pp_suffix' fmt () = fprintf fmt "%a[%a]" pp_suffix () pp_c_dimension d in
132
      aux t' pp_suffix'
133
    | Types.Tstatic (_, t') -> fprintf fmt "const "; aux t' pp_suffix
134
    | Types.Tconst ty       -> fprintf fmt "%s %s" ty var
135
    | Types.Tarrow (_, _)   -> fprintf fmt "void (*%s)()" var
136
    | _                     -> eprintf "internal error: C_backend_common.pp_c_type %a@." Types.print_ty t; assert false
137
  in aux t (fun fmt () -> ())
138

    
139
let rec pp_c_initialize fmt t = 
140
  match (Types.repr t).Types.tdesc with
141
  | Types.Tint -> pp_print_string fmt "0"
142
  | Types.Tclock t' -> pp_c_initialize fmt t'
143
  | Types.Tbool -> pp_print_string fmt "0" 
144
  | Types.Treal -> pp_print_string fmt "0."
145
  | Types.Tarray (d, t') when Dimension.is_dimension_const d ->
146
    fprintf fmt "{%a}"
147
      (Utils.fprintf_list ~sep:"," (fun fmt _ -> pp_c_initialize fmt t'))
148
      (Utils.duplicate 0 (Dimension.size_const_dimension d))
149
  | _ -> assert false
150

    
151

    
152
let pp_c_tag fmt t =
153
 pp_print_string fmt (if t = tag_true then "1" else if t = tag_false then "0" else t)
154

    
155
(* Prints a constant value *)
156
let rec pp_c_const fmt c =
157
  match c with
158
    | Const_int i     -> pp_print_int fmt i
159
    | Const_real r    -> pp_print_string fmt r
160
    | Const_float r   -> pp_print_float fmt r
161
    | Const_tag t     -> pp_c_tag fmt t
162
    | Const_array ca  -> fprintf fmt "{%a }" (Utils.fprintf_list ~sep:", " pp_c_const) ca
163
    | Const_struct fl -> fprintf fmt "{%a }" (Utils.fprintf_list ~sep:", " (fun fmt (f, c) -> pp_c_const fmt c)) fl
164
    | Const_string _ -> assert false (* string occurs in annotations not in C *)
165

    
166
(* Prints a value expression [v], with internal function calls only.
167
   [pp_var] is a printer for variables (typically [pp_c_var_read]),
168
   but an offset suffix may be added for array variables
169
*)
170
let rec pp_c_val self pp_var fmt v =
171
  match v with
172
  | Cst c         -> pp_c_const fmt c
173
  | Array vl      -> fprintf fmt "{%a}" (Utils.fprintf_list ~sep:", " (pp_c_val self pp_var)) vl
174
  | Access (t, i) -> fprintf fmt "%a[%a]" (pp_c_val self pp_var) t (pp_c_val self pp_var) i
175
  | Power (v, n)  -> assert false
176
  | LocalVar v    -> pp_var fmt v
177
  | StateVar v    ->
178
    (* array memory vars are represented by an indirection to a local var with the right type,
179
       in order to avoid casting everywhere. *)
180
    if Types.is_array_type v.var_type
181
    then fprintf fmt "%a" pp_var v
182
    else fprintf fmt "%s->_reg.%a" self pp_var v
183
  | Fun (n, vl)   -> Basic_library.pp_c n (pp_c_val self pp_var) fmt vl
184

    
185
(* Access to the value of a variable:
186
   - if it's not a scalar output, then its name is enough
187
   - otherwise, dereference it (it has been declared as a pointer,
188
     despite its scalar Lustre type)
189
   - moreover, dereference memory array variables.
190
*)
191
let pp_c_var_read m fmt id =
192
  if Types.is_address_type id.var_type
193
  then
194
    if is_memory m id
195
    then fprintf fmt "(*%s)" id.var_id
196
    else fprintf fmt "%s" id.var_id
197
  else
198
    if is_output m id
199
    then fprintf fmt "*%s" id.var_id
200
    else fprintf fmt "%s" id.var_id
201

    
202
(* Addressable value of a variable, the one that is passed around in calls:
203
   - if it's not a scalar non-output, then its name is enough
204
   - otherwise, reference it (it must be passed as a pointer,
205
     despite its scalar Lustre type)
206
*)
207
let pp_c_var_write m fmt id =
208
  if Types.is_address_type id.var_type
209
  then
210
    fprintf fmt "%s" id.var_id
211
  else
212
    if is_output m id
213
    then
214
      fprintf fmt "%s" id.var_id
215
    else
216
      fprintf fmt "&%s" id.var_id
217

    
218
(* Declaration of an input variable:
219
   - if its type is array/matrix/etc, then declare it as a mere pointer,
220
     in order to cope with unknown/parametric array dimensions, 
221
     as it is the case for generics
222
*)
223
let pp_c_decl_input_var fmt id =
224
  if !Options.ansi && Types.is_address_type id.var_type
225
  then pp_c_type (sprintf "(*%s)" id.var_id) fmt (Types.array_base_type id.var_type)
226
  else pp_c_type id.var_id fmt id.var_type
227

    
228
(* Declaration of an output variable:
229
   - if its type is scalar, then pass its address
230
   - if its type is array/matrix/struct/etc, then declare it as a mere pointer,
231
     in order to cope with unknown/parametric array dimensions, 
232
     as it is the case for generics
233
*)
234
let pp_c_decl_output_var fmt id =
235
  if (not !Options.ansi) && Types.is_address_type id.var_type
236
  then pp_c_type                  id.var_id  fmt id.var_type
237
  else pp_c_type (sprintf "(*%s)" id.var_id) fmt (Types.array_base_type id.var_type)
238

    
239
(* Declaration of a local/mem variable:
240
   - if it's an array/matrix/etc, its size(s) should be
241
     known in order to statically allocate memory, 
242
     so we print the full type
243
*)
244
let pp_c_decl_local_var m fmt id =
245
  if id.var_dec_const
246
  then
247
    Format.fprintf fmt "%a = %a"
248
      (pp_c_type id.var_id) id.var_type
249
      (pp_c_val "" (pp_c_var_read m)) (get_const_assign m id)
250
  else
251
    Format.fprintf fmt "%a"
252
      (pp_c_type id.var_id) id.var_type
253

    
254
let pp_c_decl_array_mem self fmt id =
255
  fprintf fmt "%a = (%a) (%s->_reg.%s)"
256
    (pp_c_type (sprintf "(*%s)" id.var_id)) id.var_type
257
    (pp_c_type "(*)") id.var_type
258
    self
259
    id.var_id
260

    
261
(* Declaration of a struct variable:
262
   - if it's an array/matrix/etc, we declare it as a pointer
263
*)
264
let pp_c_decl_struct_var fmt id =
265
  if Types.is_array_type id.var_type
266
  then pp_c_type (sprintf "(*%s)" id.var_id) fmt (Types.array_base_type id.var_type)
267
  else pp_c_type                  id.var_id  fmt id.var_type
268

    
269
let pp_c_decl_instance_var fmt (name, (node, static)) = 
270
  fprintf fmt "%a *%s" pp_machine_memtype_name (node_name node) name
271

    
272
let pp_c_checks self fmt m =
273
  Utils.fprintf_list ~sep:"" 
274
    (fun fmt (loc, check) -> 
275
      fprintf fmt 
276
	"@[<v>%a@,assert (%a);@]@," 
277
	Location.pp_c_loc loc
278
	(pp_c_val self (pp_c_var_read m)) check
279
    ) 
280
    fmt 
281
    m.mstep.step_checks
282

    
283
(********************************************************************************************)
284
(*                       Struct Printing functions                                          *)
285
(********************************************************************************************)
286

    
287
let pp_registers_struct fmt m =
288
  if m.mmemory <> []
289
  then
290
    fprintf fmt "@[%a {@[%a; @]}@] _reg; "
291
      pp_machine_regtype_name m.mname.node_id
292
      (Utils.fprintf_list ~sep:"; " pp_c_decl_struct_var) m.mmemory
293
  else
294
    ()
295

    
296
let print_machine_struct fmt m =
297
  if fst (get_stateless_status m) then
298
    begin
299
    end
300
  else
301
    begin
302
      (* Define struct *)
303
      fprintf fmt "@[%a {@[%a%a%t@]};@]@."
304
	pp_machine_memtype_name m.mname.node_id
305
	pp_registers_struct m
306
	(Utils.fprintf_list ~sep:"; " pp_c_decl_instance_var) m.minstances
307
	(Utils.pp_final_char_if_non_empty "; " m.minstances)
308
    end
309

    
310
let print_machine_struct_from_header fmt inode =
311
  if inode.nodei_stateless then
312
    begin
313
    end
314
  else
315
    begin
316
      (* Declare struct *)
317
      fprintf fmt "@[%a;@]@."
318
	pp_machine_memtype_name inode.nodei_id
319
    end
320

    
321
(********************************************************************************************)
322
(*                      Prototype Printing functions                                        *)
323
(********************************************************************************************)
324

    
325
let print_alloc_prototype fmt (name, static) =
326
  fprintf fmt "%a * %a (%a)"
327
    pp_machine_memtype_name name
328
    pp_machine_alloc_name name
329
    (Utils.fprintf_list ~sep:",@ " pp_c_decl_input_var) static
330

    
331
let print_reset_prototype self fmt (name, static) =
332
  fprintf fmt "void %a (@[<v>%a%t%a *%s@])"
333
    pp_machine_reset_name name
334
    (Utils.fprintf_list ~sep:",@ " pp_c_decl_input_var) static
335
    (Utils.pp_final_char_if_non_empty ",@," static) 
336
    pp_machine_memtype_name name
337
    self
338

    
339
let print_stateless_prototype fmt (name, inputs, outputs) =
340
  fprintf fmt "void %a (@[<v>@[%a%t@]@,@[%a@]@,@])"
341
    pp_machine_step_name name
342
    (Utils.fprintf_list ~sep:",@ " pp_c_decl_input_var) inputs
343
    (Utils.pp_final_char_if_non_empty ",@ " inputs) 
344
    (Utils.fprintf_list ~sep:",@ " pp_c_decl_output_var) outputs
345

    
346
let print_step_prototype self fmt (name, inputs, outputs) =
347
  fprintf fmt "void %a (@[<v>@[%a%t@]@,@[%a@]%t@[%a *%s@]@])"
348
    pp_machine_step_name name
349
    (Utils.fprintf_list ~sep:",@ " pp_c_decl_input_var) inputs
350
    (Utils.pp_final_char_if_non_empty ",@ " inputs) 
351
    (Utils.fprintf_list ~sep:",@ " pp_c_decl_output_var) outputs
352
    (Utils.pp_final_char_if_non_empty ",@," outputs) 
353
    pp_machine_memtype_name name
354
    self
355

    
356
let print_stateless_C_prototype fmt (name, inputs, outputs) =
357
  let output = 
358
    match outputs with
359
    | [hd] -> hd
360
    | _ -> assert false
361
  in
362
  fprintf fmt "%a %s (@[<v>@[%a@]@,@])"
363
    pp_basic_c_type output.var_type
364
    name
365
    (Utils.fprintf_list ~sep:",@ " pp_c_decl_input_var) inputs
366
    
367
    
368

    
369
let print_import_prototype fmt (Dep (_, s, _, _)) =
370
  fprintf fmt "#include \"%s.h\"@," s
371

    
372
let print_import_alloc_prototype fmt (Dep (_, s, _, stateful)) =
373
  if stateful then
374
    fprintf fmt "#include \"%s_alloc.h\"@," s
375

    
376
let print_extern_alloc_prototypes fmt (Dep (_,_, header,_)) =
377
  List.iter (fun decl -> match decl.top_decl_desc with
378
  | ImportedNode ind when not ind.nodei_stateless ->
379
    let static = List.filter (fun v -> v.var_dec_const) ind.nodei_inputs
380
    in fprintf fmt "extern %a;@." print_alloc_prototype (ind.nodei_id, static)
381
  | _                -> ()
382
  ) header
383

    
384
(* Local Variables: *)
385
(* compile-command:"make -C ../../.." *)
386
(* End: *)