cprinter.ml 43.4 KB
Newer Older
Andrei Paskevich's avatar
headers  
Andrei Paskevich committed
1 2 3
(********************************************************************)
(*                                                                  *)
(*  The Why3 Verification Platform   /   The Why3 Development Team  *)
Guillaume Melquiond's avatar
Guillaume Melquiond committed
4
(*  Copyright 2010-2018   --   Inria - CNRS - Paris-Sud University  *)
Andrei Paskevich's avatar
headers  
Andrei Paskevich committed
5 6 7 8 9 10 11
(*                                                                  *)
(*  This software is distributed under the terms of the GNU Lesser  *)
(*  General Public License version 2.1, with the special exception  *)
(*  on linking described in file LICENSE.                           *)
(*                                                                  *)
(********************************************************************)

Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
12
open Ident
13

14 15
exception Unsupported of string

Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
16
module C = struct
17

18 19 20
  type struct_def = string * (string * ty) list

  and ty =
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
21
    | Tvoid
22
    | Tsyntax of string * ty list
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
23 24
    | Tptr of ty
    | Tarray of ty * expr
25
    | Tstruct of struct_def
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
26 27
    | Tunion of ident * (ident * ty) list
    | Tnamed of ident (* alias from typedef *)
28
    | Tnosyntax (* types that do not have a syntax, can't be printed *)
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
29 30 31 32 33 34 35 36 37 38 39
    (* enum, const could be added *)

  (* int x=2, *y ... *)
  and names = ty * (ident * expr) list

  (* names with a single declaration *)
  and name = ty * ident * expr

  (* return type, parameter list. Variadic functions not handled. *)
  and proto = ty * (ty * ident) list

40 41
  and binop = Band | Bor | Beq | Bne | Bassign | Blt | Ble | Bgt | Bge
  (* += and co. maybe to add *)
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
42

43
  and unop = Unot | Ustar | Uaddr | Upreincr | Upostincr | Upredecr | Upostdecr
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
44 45 46 47 48

  and expr =
    | Enothing
    | Eunop of unop * expr
    | Ebinop of binop * expr * expr
49
    | Equestion of expr * expr * expr (* c ? t : e *)
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
50 51 52
    | Ecast of ty * expr
    | Ecall of expr * expr list
    | Econst of constant
53
    | Evar of ident
54 55
    | Elikely of expr (* __builtin_expect(e,1) *)
    | Eunlikely of expr (* __builtin_expect(e,0) *)
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
56 57 58
    | Esize_expr of expr
    | Esize_type of ty
    | Eindex of expr * expr (* Array access *)
59 60
    | Edot of expr * string (* Field access with dot *)
    | Earrow of expr * string (* Pointer access with arrow *)
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
61 62 63
    | Esyntax of string * ty * (ty array) * (expr*ty) list * bool
  (* template, type and type arguments of result, typed arguments,
     is/is not converter*)
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81

  and constant =
    | Cint of string
    | Cfloat of string
    | Cchar of string
    | Cstring of string

  type stmt =
    | Snop
    | Sexpr of expr
    | Sblock of body
    | Sseq of stmt * stmt
    | Sif of expr * stmt * stmt
    | Swhile of expr * stmt
    | Sfor of expr * expr * expr * stmt
    | Sbreak
    | Sreturn of expr

82
  and include_kind = Sys | Proj (* include <...> vs. include "..." *)
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
83
  and definition =
84
    | Dfun of ident * proto * body
85
    | Dinclude of ident * include_kind
86
    | Dproto of ident * proto
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
87
    | Ddecl of names
88
    | Dstruct of struct_def
89
    | Dstruct_decl of string
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
90 91 92 93 94 95
    | Dtypedef of ty * ident

  and body = definition list * stmt

  type file = definition list

96 97
  exception NotAValue

98 99 100 101 102 103
  let rec is_nop = function
    | Snop -> true
    | Sblock ([], s) -> is_nop s
    | Sseq (s1,s2) -> is_nop s1 && is_nop s2
    | _ -> false

104 105 106 107 108 109 110 111
  let is_true = function
    | Sexpr(Econst(Cint "1")) -> true
    | _ -> false

  let is_false = function
    | Sexpr(Econst(Cint "0")) -> true
    | _ -> false

112 113 114 115 116 117
  let rec one_stmt = function
    | Snop -> true
    | Sexpr _ -> true
    | Sblock (d,s) -> d = [] && one_stmt s
    | _ -> false

Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
118 119 120
  (** [assignify v] transforms a statement that computes a value into
     a statement that assigns that value to v *)
  let rec assignify v = function
121
    | Snop -> raise NotAValue
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
122 123 124 125 126 127 128
    | Sexpr e -> Sexpr (Ebinop (Bassign, v, e))
    | Sblock (ds, s) -> Sblock (ds, assignify v s)
    | Sseq (s1, s2) when not (is_nop s2) -> Sseq (s1, assignify v s2)
    | Sseq (s1,_) -> assignify v s1
    | Sif (c,t,e) -> Sif (c, assignify v t, assignify v e)
    | Swhile (c,s) -> Swhile (c, assignify v s) (* can this be a value ?*)
    | Sfor (e0,e1,e2,s) -> Sfor (e0,e1,e2, assignify v s)
129 130 131
    | Sbreak -> raise NotAValue
    | Sreturn _ -> raise NotAValue

132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155

  (** [get_last_expr] extracts the expression computed by the given statement.
     This is needed when loop conditions are more complex than a simple expression. *)
  let rec get_last_expr = function
    | Snop -> raise NotAValue
    | Sexpr e -> Snop, e
    | Sblock (ds,s) ->
      let s',e = get_last_expr s in
      Sblock(ds,s'), e
    | Sseq (s1,s2) when not (is_nop s2) ->
      let s', e = get_last_expr s2 in
      Sseq(s1,s'), e
    | Sseq (s1,_) -> get_last_expr s1
    | Sif (c,Sexpr t,Sexpr e) -> Snop, Equestion(c,t,e)
    | Sif _ -> raise (Unsupported "while (complex if)")
    | Swhile (_c,_s) -> raise (Unsupported "while (while) {}")
    | Sfor _ -> raise (Unsupported "while (for)")
    | Sbreak -> raise NotAValue
    | Sreturn _ -> raise NotAValue

  (** [propagate_in_expr id v] and the associated functions replace
      all instances of [id] by [v] in an
      expression/statement/definition/block. It is used for constant
      propagation to reduce the number of variables. *)
156 157 158 159 160 161 162
  let rec propagate_in_expr id (v:expr) = function
    | Evar i when Ident.id_equal i id -> v
    | Evar i -> Evar i
    | Eunop (u,e) -> Eunop (u, propagate_in_expr id v e)
    | Ebinop (b,e1,e2) -> Ebinop (b,
                                  propagate_in_expr id v e1,
                                  propagate_in_expr id v e2)
163 164 165
    | Equestion (c,t,e) -> Equestion(propagate_in_expr id v c,
                                     propagate_in_expr id v t,
                                     propagate_in_expr id v e)
166 167 168 169 170 171 172 173
    | Ecast (ty,e) -> Ecast (ty, propagate_in_expr id v e)
    | Ecall (e, l) -> Ecall (propagate_in_expr id v e,
                             List.map (propagate_in_expr id v) l)
    | Esize_expr e -> Esize_expr (propagate_in_expr id v e)
    | Eindex (e1,e2) -> Eindex (propagate_in_expr id v e1,
                                propagate_in_expr id v e2)
    | Edot (e,i) -> Edot (propagate_in_expr id v e, i)
    | Earrow (e,i) -> Earrow (propagate_in_expr id v e, i)
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
174 175
    | Esyntax (s,t,ta,l,b) ->
      Esyntax (s,t,ta,List.map (fun (e,t) -> (propagate_in_expr id v e),t) l,b)
176 177
    | Enothing -> Enothing
    | Econst c -> Econst c
178 179
    | Elikely e -> Elikely (propagate_in_expr id v e)
    | Eunlikely e -> Eunlikely (propagate_in_expr id v e)
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
    | Esize_type ty -> Esize_type ty

  let rec propagate_in_stmt id v = function
    | Sexpr e -> Sexpr (propagate_in_expr id v e)
    | Sblock b -> Sblock(propagate_in_block id v b)
    | Sseq (s1,s2) -> Sseq (propagate_in_stmt id v s1,
                            propagate_in_stmt id v s2)
    | Sif (e,s1,s2) -> Sif (propagate_in_expr id v e,
                            propagate_in_stmt id v s1,
                            propagate_in_stmt id v s2)
    | Swhile (e, s) -> Swhile (propagate_in_expr id v e,
                               propagate_in_stmt id v s)
    | Sfor (e1,e2,e3,s) -> Sfor (propagate_in_expr id v e1,
                                 propagate_in_expr id v e2,
                                 propagate_in_expr id v e3,
                                 propagate_in_stmt id v s)
    | Sreturn e -> Sreturn (propagate_in_expr id v e)
    | Snop -> Snop
    | Sbreak -> Sbreak

  and propagate_in_def id v d =
    let rec aux = function
      | [] -> [], true
      | (i,e)::t ->
        if Ident.id_equal i id then (i,e)::t, false
        else let t,b = aux t in ((i,propagate_in_expr id v e)::t), b
    in
    match d with
    | Ddecl (ty,l) ->
      let l,b = aux l in
      Ddecl (ty, l), b
211
    | Dinclude (i,k) -> Dinclude (i,k), true
212
    | Dstruct _ -> raise (Unsupported "struct declaration inside function")
213
    | Dfun _ -> raise (Unsupported "nested function")
214
    | Dtypedef _ | Dproto _ | Dstruct_decl _ -> assert false
215 216 217 218 219 220 221 222 223 224 225 226

  and propagate_in_block id v (dl, s) =
    let dl, b = List.fold_left
      (fun (dl, acc) d ->
        if acc
        then
          let d, b = propagate_in_def id v d in
          (d::dl, b)
        else (d::dl, false))
      ([],true) dl in
    (List.rev dl, if b then propagate_in_stmt id v s else s)

227 228
  let is_empty_block s = s = Sblock([], Snop)
  let block_of_expr e = [], Sexpr e
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
229

230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
(** [flatten_defs d s] appends all definitions in the statement [s] to d. *)
  (* TODO check ident unicity ? *)
  let rec flatten_defs d = function
    | Sseq (s1,s2) ->
      let d, s1' = flatten_defs d s1 in
      let d, s2' = flatten_defs d s2 in
      d, Sseq(s1',s2')
    | Sblock (d',s) ->
      let d',s' = flatten_defs d' s in
      d@d', s'
    | Sif (c,t,e) ->
      let d, t' = flatten_defs d t in
      let d, e' = flatten_defs d e in
      d,Sif(c,t',e')
    | Swhile (c,s) ->
      let d, s' = flatten_defs d s in
      d, Swhile (c, s')
    | Sfor (e1,e2,e3,s) ->
      let d, s' = flatten_defs d s in
      d, Sfor(e1,e2,e3,s')
    | s -> d,s

252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279

  let rec group_defs_by_type l =
    (* heuristic to reduce the number of lines of defs*)
    let rec group_types t1 t2 =
      match t1, t2 with
      | Tsyntax (s1, l1), Tsyntax (s2, l2) ->
        List.length l1 = List.length l2
        && List.for_all2 group_types l1 l2
        && (s1 = s2)
        && (not (String.contains s1 '*'))
      | Tsyntax _, _ | _, Tsyntax _ -> false
      | t1, t2 -> t1 = t2
    in
    match l with
    | [] | [_] -> l
    | Ddecl (ty1, el1) :: Ddecl (ty2, el2) :: l'
        when group_types ty1 ty2
          -> group_defs_by_type (Ddecl(ty1, el1@el2)::l')
    | Ddecl (ty1, el1) :: Ddecl (ty2, el2) :: Ddecl (ty3, el3) :: l'
        when group_types ty1 ty3
          -> group_defs_by_type (Ddecl (ty1, el1@el3) :: Ddecl (ty2, el2) :: l')
    | Ddecl (ty1, el1) :: Ddecl (ty2, el2) :: Ddecl (ty3, el3) :: l'
        when group_types ty2 ty3
          -> group_defs_by_type (Ddecl (ty1, el1) :: Ddecl (ty2, el2@el3) :: l')
    | Ddecl (ty1, el1) :: l' ->
      Ddecl (ty1, el1) :: group_defs_by_type l'
    | _ -> l

280 281 282 283 284 285 286 287 288
  let rec elim_empty_blocks = function
    | Sblock ([], s) -> elim_empty_blocks s
    | Sblock (d,s) -> Sblock (d, elim_empty_blocks s)
    | Sseq (s1,s2) -> Sseq (elim_empty_blocks s1, elim_empty_blocks s2)
    | Sif (c,t,e) -> Sif(c, elim_empty_blocks t, elim_empty_blocks e)
    | Swhile (c,s) -> Swhile(c, elim_empty_blocks s)
    | Sfor(e1,e2,e3,s) -> Sfor(e1,e2,e3,elim_empty_blocks s)
    | s -> s

289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
  let rec elim_nop = function
    | Sseq (s1,s2) ->
      let s1 = elim_nop s1 in
      let s2 = elim_nop s2 in
      begin match s1,s2 with
      | Snop, Snop -> Snop
      | Snop, s | s, Snop -> s
      | _ -> Sseq(s1,s2)
      end
    | Sblock (d,s) ->
      let s = elim_nop s in
      begin match d, s with
      | [], Snop -> Snop
      | _ -> Sblock(d,s)
      end
    | Sif (c,t,e) -> Sif(c, elim_nop t, elim_nop e)
    | Swhile (c,s) -> Swhile (c, elim_nop s)
    | Sfor(e1,e2,e3,s) -> Sfor(e1,e2,e3,elim_nop s)
    | s -> s

  let rec add_to_last_call params = function
    | Sblock (d,s) -> Sblock (d, add_to_last_call params s)
    | Sseq (s1,s2) when not (is_nop s2) ->
      Sseq (s1, add_to_last_call params s2)
    | Sseq (s1,_) -> add_to_last_call params s1
    | Sexpr (Ecall(fname, args)) ->
      Sexpr (Ecall(fname, params@args)) (*change name to ensure no renaming ?*)
    | Sreturn (Ecall (fname, args)) ->
      Sreturn (Ecall(fname, params@args))
    | _ -> raise (Unsupported "tuple pattern matching with too complex def")
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
319

Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
320 321 322 323 324 325
  let rec stmt_of_list (l: stmt list) : stmt =
    match l with
    | [] -> Snop
    | [s] -> s
    | h::t -> Sseq (h, stmt_of_list t)

326 327 328 329
  let is_expr = function
    | Sexpr _ -> true
    | _ -> false

330
  let rec simplify_expr (d,s) : expr =
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
331
    match (d,s) with
332
    | [], Sblock([],s) -> simplify_expr ([],s)
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
333
    | [], Sexpr e -> e
334 335
    | [], Sif(c,t,e) ->
       Equestion (c, simplify_expr([],t), simplify_expr([],e))
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
    | _ -> raise (Invalid_argument "simplify_expr")

  let rec simplify_cond (cd, cs) =
    match cd,elim_empty_blocks(elim_nop cs) with
    | [], Sexpr c -> ([], Sexpr c)
    | ([], Sif (c', t', e') as b) ->
       let _,t' = simplify_cond ([], t') in
       let _,e' = simplify_cond ([], e') in
       if is_false e' && is_expr t'(* c' && t' *)
       then
         let t' = simplify_expr ([],t') in
         [], Sexpr(Ebinop(Band, c', t'))
       else if is_true e' && is_expr t' (* !c' || t' *)
       then
         let t' = simplify_expr ([],t') in
         [], Sexpr(Ebinop(Bor,Eunop(Unot,c'),t'))
       else if is_true t' && is_expr e' (* c' || e' *)
       then
         let e' = simplify_expr ([],e') in
         [], Sexpr(Ebinop(Bor,c',e'))
       else if is_false t' && is_expr e' (* !c' && e' *)
       then
         let e' = simplify_expr ([],e') in
         [], Sexpr(Ebinop(Band,Eunop(Unot,c'),e'))
       else b
    | d,s -> d, s

Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
363
end
364

365 366 367 368
type info = Pdriver.printer_args = private {
  env         : Env.env;
  prelude     : Printer.prelude;
  thprelude   : Printer.prelude_map;
369
  thinterface : Printer.interface_map;
370 371 372
  blacklist   : Printer.blacklist;
  syntax      : Printer.syntax_map;
  converter   : Printer.syntax_map;
373
  literal     : Printer.syntax_map; (*TODO handle literals*)
374 375
}

376 377 378
let debug_c_extraction = Debug.register_info_flag
                           ~desc:"C extraction"
                           "c_extraction"
379

Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
380 381 382 383 384 385 386 387 388 389 390 391 392 393
module Print = struct

  open C
  open Format
  open Printer
  open Pp

  exception Unprinted of string

  let c_keywords = ["auto"; "break"; "case"; "char"; "const"; "continue"; "default"; "do"; "double"; "else"; "enum"; "extern"; "float"; "for"; "goto"; "if"; "int"; "long"; "register"; "return"; "short"; "signed"; "sizeof"; "static"; "struct"; "switch"; "typedef"; "union"; "unsigned"; "void"; "volatile"; "while" ]

  let () = assert (List.length c_keywords = 32)

  let sanitizer = sanitizer char_to_lalpha char_to_alnumus
394
  let sanitizer s = Strings.lowercase (sanitizer s)
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
395 396 397 398 399 400
  let printer = create_ident_printer c_keywords ~sanitizer

  let print_ident fmt id = fprintf fmt "%s" (id_unique printer id)

  let protect_on x s = if x then "(" ^^ s ^^ ")" else s

401 402 403 404 405 406 407
  let extract_stars ty =
    let rec aux acc = function
      | Tptr t -> aux (acc+1) t
      | t -> (acc, t)
    in
  aux 0 ty

Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
408 409 410 411
  let rec print_ty ?(paren=false) fmt = function
    | Tvoid -> fprintf fmt "void"
    | Tsyntax (s, tl) ->
      syntax_arguments
412
	s
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
413
        (print_ty ~paren:false) fmt tl
414
    | Tptr ty -> fprintf fmt "%a *" (print_ty ~paren:true) ty
415
    (* should be handled in extract_stars *)
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
416 417 418
    | Tarray (ty, expr) ->
      fprintf fmt (protect_on paren "%a[%a]")
        (print_ty ~paren:true) ty (print_expr ~paren:false) expr
419
    | Tstruct (s,_) -> fprintf fmt "struct %s" s
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
420 421 422 423 424 425 426 427
    | Tunion _ -> raise (Unprinted "unions")
    | Tnamed id -> print_ident fmt id
    | Tnosyntax -> raise (Unprinted "type without syntax")

  and print_unop fmt = function
    | Unot -> fprintf fmt "!"
    | Ustar -> fprintf fmt "*"
    | Uaddr -> fprintf fmt "&"
428 429 430 431 432 433
    | Upreincr | Upostincr -> fprintf fmt "++"
    | Upredecr | Upostdecr -> fprintf fmt "--"

  and unop_postfix = function
    | Upostincr | Upostdecr -> true
    | _ -> false
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
434 435 436 437 438 439 440

  and print_binop fmt = function
    | Band -> fprintf fmt "&&"
    | Bor -> fprintf fmt "||"
    | Beq -> fprintf fmt "=="
    | Bne -> fprintf fmt "!="
    | Bassign -> fprintf fmt "="
441 442 443 444
    | Blt -> fprintf fmt "<"
    | Ble -> fprintf fmt "<="
    | Bgt -> fprintf fmt ">"
    | Bge -> fprintf fmt ">="
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
445 446

  and print_expr ~paren fmt = function
447
    | Enothing -> Debug.dprintf debug_c_extraction "enothing"; ()
448 449 450 451 452 453
    | Eunop(u,e) ->
       if unop_postfix u
       then fprintf fmt (protect_on paren "%a%a")
              (print_expr ~paren:true) e print_unop u
       else fprintf fmt (protect_on paren "%a%a")
              print_unop u (print_expr ~paren:true) e
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
454 455 456
    | Ebinop(b,e1,e2) ->
      fprintf fmt (protect_on paren "%a %a %a")
        (print_expr ~paren:true) e1 print_binop b (print_expr ~paren:true) e2
457 458 459 460 461
    | Equestion(c,t,e) ->
      fprintf fmt (protect_on paren "%a ? %a : %a")
        (print_expr ~paren:true) c
        (print_expr ~paren:true) t
        (print_expr ~paren:true) e
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
462 463 464
    | Ecast(ty, e) ->
      fprintf fmt (protect_on paren "(%a)%a")
        (print_ty ~paren:false) ty (print_expr ~paren:true) e
465 466 467
    | Ecall (Esyntax (s, _, _, [], _), l) -> (* function defined in the prelude *)
       fprintf fmt (protect_on paren "%s(%a)")
         s (print_list comma (print_expr ~paren:false)) l
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
468 469 470 471
    | Ecall (e,l) -> fprintf fmt (protect_on paren "%a(%a)")
      (print_expr ~paren:true) e (print_list comma (print_expr ~paren:false)) l
    | Econst c -> print_const fmt c
    | Evar id -> print_ident fmt id
472 473 474 475
    | Elikely e -> fprintf fmt (protect_on paren "__builtin_expect(%a,1)")
                           (print_expr ~paren:true) e
    | Eunlikely e -> fprintf fmt (protect_on paren "__builtin_expect(%a,0)")
                           (print_expr ~paren:true) e
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
476 477 478
    | Esize_expr e ->
      fprintf fmt (protect_on paren "sizeof(%a)") (print_expr ~paren:false) e
    | Esize_type ty ->
479 480 481
       fprintf fmt (protect_on paren "sizeof(%a)") (print_ty ~paren:false) ty
    | Edot (e,s) -> fprintf fmt "%a.%s" (print_expr ~paren:true) e s
    | Eindex _  | Earrow _ -> raise (Unprinted "struct/array access")
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
482 483 484 485 486 487 488 489 490
    | Esyntax (s, t, args, lte,_) ->
      gen_syntax_arguments_typed snd (fun _ -> args)
        (if paren then ("("^s^")") else s)
        (fun fmt (e,_t) -> print_expr ~paren:false fmt e)
        (print_ty ~paren:false) (C.Enothing,t) fmt lte

  and print_const  fmt = function
    | Cint s | Cfloat s | Cchar s | Cstring s -> fprintf fmt "%s" s

491 492 493 494 495
  let print_id_init ~stars fmt ie =
    (if stars > 0
    then fprintf fmt "%s " (String.make stars '*')
    else ());
    match ie with
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
496 497 498 499
    | id, Enothing -> print_ident fmt id
    | id,e -> fprintf fmt "%a = %a" print_ident id (print_expr ~paren:false) e

  let rec print_stmt ~braces fmt = function
500
    | Snop -> Debug.dprintf debug_c_extraction "snop"; ()
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
501
    | Sexpr e -> fprintf fmt "%a;" (print_expr ~paren:false) e;
502
    | Sblock ([] ,s) when not braces ->
503
      (print_stmt ~braces:false) fmt s
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
504 505 506 507
    | Sblock b -> fprintf fmt "@[<hov>{@\n  @[<hov>%a@]@\n}@]" print_body b
    | Sseq (s1,s2) -> fprintf fmt "%a@\n%a"
      (print_stmt ~braces:false) s1
      (print_stmt ~braces:false) s2
508
    | Sif(c,t,e) when is_nop e ->
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
509
       fprintf fmt "if(%a)@\n%a" (print_expr ~paren:false) c
510
         (print_stmt ~braces:true) (Sblock([],t))
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
511 512
    | Sif (c,t,e) -> fprintf fmt "if(%a)@\n%a@\nelse@\n%a"
      (print_expr ~paren:false) c
513 514 515 516
      (print_stmt ~braces:true) (Sblock([],t))
      (print_stmt ~braces:true) (Sblock([],e))
    | Swhile (e,b) -> fprintf fmt "while (%a)@;<1 2>%a"
      (print_expr ~paren:false) e (print_stmt ~braces:true) (Sblock([],b))
517 518 519 520 521 522
    | Sfor (einit, etest, eincr, s) ->
       fprintf fmt "for (%a; %a; %a)@;<1 2>%a"
         (print_expr ~paren:false) einit
         (print_expr ~paren:false) etest
         (print_expr ~paren:false) eincr
         (print_stmt ~braces:true) (Sblock([],s))
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
523
    | Sbreak -> fprintf fmt "break;"
524
    | Sreturn Enothing -> fprintf fmt "return;"
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
525 526
    | Sreturn e -> fprintf fmt "return %a;" (print_expr ~paren:true) e

527 528
  and print_def fmt def =
    try match def with
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573
      | Dfun (id,(rt,args),body) ->
         let s = sprintf "%a %a(@[%a@])@ @[<hov>{@;<1 2>@[<hov>%a@]@\n}@\n@]"
                   (print_ty ~paren:false) rt
                   print_ident id
                   (print_list comma
		      (print_pair_delim nothing space nothing
			 (print_ty ~paren:false) print_ident))
	           args
                   print_body body in
         (* print into string first to print nothing in case of exception *)
         fprintf fmt "%s" s
      | Dproto (id, (rt, args)) ->
         let s = sprintf "%a %a(@[%a@]);@;"
                   (print_ty ~paren:false) rt
                   print_ident id
                   (print_list comma
                      (print_pair_delim nothing space nothing
		         (print_ty ~paren:false) print_ident))
	           args in
         fprintf fmt "%s" s
      | Ddecl (ty, lie) ->
         let nb, ty = extract_stars ty in
         assert (nb=0);
         let s = sprintf "%a @[<hov>%a@];"
	           (print_ty ~paren:false) ty
	           (print_list comma (print_id_init ~stars:nb)) lie in
         fprintf fmt "%s" s
      | Dstruct (s, lf) ->
         let s = sprintf "struct %s@ @[<hov>{@;<1 2>@[<hov>%a@]@\n};@\n@]"
                   s
                   (print_list newline
                      (fun fmt (s,ty) -> fprintf fmt "%a %s;"
                                           (print_ty ~paren:false) ty s))
                   lf in
         fprintf fmt "%s" s
      | Dstruct_decl s ->
         fprintf fmt "struct %s;@;" s
      | Dinclude (id, Sys) ->
         fprintf fmt "#include <%s.h>@;"  (sanitizer id.id_string)
      | Dinclude (id, Proj) ->
         fprintf fmt "#include \"%s.h\"@;" (sanitizer id.id_string)
      | Dtypedef (ty,id) ->
         let s = sprintf "@[<hov>typedef@ %a@;%a;@]"
	           (print_ty ~paren:false) ty print_ident id in
         fprintf fmt "%s" s
574 575
    with Unprinted s ->
      Debug.dprintf debug_c_extraction "Missed a def because : %s@." s
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
576

577 578 579
  and print_body fmt (def, s) =
    if def = []
    then print_stmt ~braces:true fmt s
580 581 582 583
    else
      print_pair_delim nothing newline nothing
        (print_list newline print_def)
        (print_stmt ~braces:true)
584
        fmt (def,s)
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
585 586 587 588 589 590 591

  let print_file fmt info ast =
    Mid.iter (fun _ sl -> List.iter (fprintf fmt "%s\n") sl) info.thprelude;
    newline fmt ();
    fprintf fmt "@[<v>%a@]@." (print_list newline print_def) ast

end
592

Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
593 594 595 596 597 598 599
module MLToC = struct

  open Ity
  open Ty
  open Expr
  open Term
  open Printer
600
  open Mltree
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615
  open C

  let rec ty_of_mlty info = function
    | Tvar tv ->
      begin match query_syntax info.syntax tv.tv_name
        with
        | Some s -> C.Tsyntax (s, [])
        | None -> C.Tnamed (tv.tv_name)
      end
    | Tapp (id, tl) ->
       begin match query_syntax info.syntax id
        with
        | Some s -> C.Tsyntax (s, List.map (ty_of_mlty info) tl)
        | None -> C.Tnosyntax
       end
616
    | Ttuple [] -> C.Tvoid
617
    | Ttuple _ -> raise (Unsupported "tuple parameters")
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
618 619 620 621 622 623 624 625 626 627 628 629 630

  let rec ty_of_ty info ty = (*FIXME try to use only ML tys*)
    match ty.ty_node with
    | Tyvar v ->
      begin match query_syntax info.syntax v.tv_name
        with
        | Some s -> C.Tsyntax (s, [])
        | None -> C.Tnamed (v.tv_name)
      end
    | Tyapp (ts, tl) ->
       begin match query_syntax info.syntax ts.ts_name
        with
        | Some s -> C.Tsyntax (s, List.map (ty_of_ty info) tl)
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
631 632 633
        | None -> if is_ts_tuple ts && tl = []
                  then C.Tvoid
                  else C.Tnosyntax
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
634 635 636 637 638 639 640 641 642 643
       end

  let ity_of_expr e = match e.e_ity with
    | I i -> i
    | _ -> assert false

  let pv_name pv = pv.pv_vs.vs_name

  type syntax_env = { in_unguarded_loop : bool;
                      computes_return_value : bool;
644 645
                      current_function : rsymbol;
		      breaks : Sid.t;
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
                      returns : Sid.t; }


  let is_true e = match e.e_node with
    | Eapp (s, []) -> rs_equal s rs_true
    | _ -> false

  let is_false e = match e.e_node with
    | Eapp (s, []) -> rs_equal s rs_false
    | _ -> false

  let is_unit = function
    | I i -> ity_equal i Ity.ity_unit
    | C _ -> false

  let return_or_expr env (e:C.expr) =
    if env.computes_return_value
    then Sreturn e
    else Sexpr e

666

Andrei Paskevich's avatar
Andrei Paskevich committed
667 668
  let likely = create_attribute "ex:likely"
  let unlikely = create_attribute "ex:unlikely"
669

Andrei Paskevich's avatar
Andrei Paskevich committed
670 671 672
  let handle_likely attrs (e:C.expr) =
    let lkl = Sattr.mem likely attrs in
    let ulk = Sattr.mem unlikely attrs in
673 674 675 676 677 678 679 680 681
    if lkl
    then (if ulk then e else Elikely e)
    else (if ulk then Eunlikely e else e)

  let reverse_likely = function
    | Elikely e -> Eunlikely e
    | Eunlikely e -> Elikely e
    | e -> e

682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702
  let field i = "__field_"^(string_of_int i)

  let struct_of_rs info rs =
    let rty = ty_of_ity rs.rs_cty.cty_result in
    match rty.ty_node with
    | Tyapp (ts, lt) ->
       assert (is_ts_tuple ts);
       let rec fields fr tys =
         match tys with
         | [] -> []
         | ty::l -> (field fr, ty_of_ty info ty)::(fields (fr+1) l) in
       let fields = fields 0 lt in
       let s = match query_syntax info.syntax rs.rs_name with
         | Some s -> s
         | None -> rs.rs_name.id_string in
       let name = Pp.sprintf "__%s_result" s in
       (name, fields)
    | _ -> assert false

  let struct_of_rs info = Wrs.memoize 17 (fun rs -> struct_of_rs info rs)

703
  let rec expr info env (e:Mltree.expr) : C.body =
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
704 705 706 707 708 709 710 711
    assert (not e.e_effect.eff_ghost);
    match e.e_node with
    | Eblock [] ->
       if env.computes_return_value
       then C.([], Sreturn(Enothing))
       else C.([], Snop)
    | Eblock [_] -> assert false
    | Eblock l ->
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
712
       let env_f = { env with computes_return_value = false } in
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
713 714 715 716 717
       let rec aux = function
         | [] ->
            if env.computes_return_value
            then C.([], Sreturn(Enothing))
            else C.([], Snop)
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
718 719
         | [s] -> ([], C.Sblock (expr info env s))
         | h::t -> ([], C.Sseq (C.Sblock (expr info env_f h),
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
720 721 722 723 724 725 726
                                C.Sblock (aux t)))
       in
       aux l
    | Eapp (rs, []) when rs_equal rs rs_true ->
       ([],return_or_expr env (C.Econst (Cint "1")))
    | Eapp (rs, []) when rs_equal rs rs_false ->
       ([],return_or_expr env (C.Econst (Cint "0")))
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
727
    | Mltree.Evar pv ->
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
728 729
       let e = C.Evar (pv_name pv) in
       ([], return_or_expr env e)
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
730
    | Mltree.Econst ic ->
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
731
      let n = Number.compute_int_constant ic in
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
732 733 734
      let e = C.(Econst (Cint (BigInt.to_string n))) in
      ([], return_or_expr env e)
    | Eapp (rs, el) ->
735
       Debug.dprintf debug_c_extraction "call to %s@." rs.rs_name.id_string;
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
736
       if is_rs_tuple rs && env.computes_return_value
737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762
       then begin
	 let args =
           List.filter
             (fun e ->
               assert (not e.e_effect.eff_ghost);
               match e.e_ity with
               | I i when ity_equal i Ity.ity_unit -> false
               | _ -> true)
	     el
         in (*FIXME still needed with masks? *)
         let env_f = { env with computes_return_value = false } in
         let id_struct = id_register (id_fresh "result") in
         let e_struct = C.Evar id_struct in
         let d_struct = C.(Ddecl(Tstruct
                                   (struct_of_rs info env.current_function),
                                 [id_struct, Enothing])) in
         let assign i (d,s) =
           C.Sblock (d,assignify C.(Edot (e_struct, field i)) s) in
         let rec assigns args i =
           match args with
           | [] -> Snop
           | e::t ->
              let b = expr info env_f e in
              C.Sseq(assign i b, assigns t (i+1)) in
	 C.([d_struct], Sseq(assigns args 0, Sreturn(e_struct)))
	 end
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
763
       else
764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794
	 let e' =
           match
             (query_syntax info.syntax rs.rs_name,
              query_syntax info.converter rs.rs_name) with
           | _, Some s
             | Some s, _ ->
              begin
                try
                  let _ =
                    Str.search_forward
                      (Str.regexp "[%]\\([tv]?\\)[0-9]+") s 0 in
                  let env_f =
                    { env with computes_return_value = false } in
                  let params =
		    List.map
                      (fun e ->
                        (simplify_expr (expr info env_f e),
                         ty_of_ty info (ty_of_ity (ity_of_expr e))))
		      el in
		  let rty = ty_of_ity (match e.e_ity with
                                       | C _ -> assert false
                                       | I i -> i) in
		  let rtyargs = match rty.ty_node with
		    | Tyvar _ -> [||]
		    | Tyapp (_,args) ->
                       Array.of_list (List.map (ty_of_ty info) args)
		  in
		  C.Esyntax(s,ty_of_ty info rty, rtyargs, params,
                            Mid.mem rs.rs_name info.converter)
                with Not_found ->
		  let args =
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
795 796 797 798 799 800
                    List.filter
                      (fun e ->
                        assert (not e.e_effect.eff_ghost);
                        match e.e_ity with
                        | I i when ity_equal i Ity.ity_unit -> false
                        | _ -> true)
801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829
		      el
                  in
                  if args=[]
                  then C.(Esyntax(s, Tnosyntax, [||], [], true)) (*constant*)
                  else
                    (*function defined in the prelude *)
                    let env_f =
                      { env with computes_return_value = false } in
		    C.(Ecall(Esyntax(s, Tnosyntax, [||], [], true),
			     List.map
                               (fun e ->
                                 simplify_expr (expr info env_f e))
                               el))
              end
           | _ ->
              let args =
                List.filter
                  (fun e ->
                    assert (not e.e_effect.eff_ghost);
                    match e.e_ity with
                    | I i when ity_equal i Ity.ity_unit -> false
                    | _ -> true)
		  el in
              let env_f =
                { env with computes_return_value = false } in
	      C.(Ecall(Evar(rs.rs_name), List.map
                                           (fun e ->
                                             simplify_expr (expr info env_f e))
                                           args))
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
830
         in
831 832 833 834 835 836 837 838 839 840
	 C.([],
            if env.computes_return_value
	    then
              begin match e.e_ity with
              | I ity when ity_equal ity Ity.ity_unit ->
                 Sseq(Sexpr e', Sreturn Enothing)
              | I _ -> Sreturn e'
              | _ -> assert false
              end
            else Sexpr e')
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
841 842 843 844 845
    | Elet (ld,e) ->
       begin match ld with
       | Lvar (pv,le) -> (* not a block *)
          begin
          match le.e_node with
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
846
          | Mltree.Econst ic ->
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
847
            let n = Number.compute_int_constant ic in
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
848
            let ce = C.(Econst (Cint (BigInt.to_string n))) in
849
	    Debug.dprintf debug_c_extraction "propagate constant %s for var %s@."
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
850 851 852 853 854 855 856 857 858 859 860 861 862 863
			  (BigInt.to_string n) (pv_name pv).id_string;
            C.propagate_in_block (pv_name pv) ce (expr info env e)
          | Eapp (rs,_) when Mid.mem rs.rs_name info.converter ->
            begin match expr info {env with computes_return_value = false} le
              with
            | [], C.Sexpr(se) ->
              C.propagate_in_block (pv_name pv) se (expr info env e)
            | _ -> assert false
            end
          | _->
            let t = ty_of_ty info (ty_of_ity pv.pv_ity) in
            match expr info {env with computes_return_value = false} le with
            | [], C.Sexpr((C.Esyntax(_,_,_,_,b) as se))
                when b (* converter *) ->
864
              Debug.dprintf debug_c_extraction "propagate converter for var %s@."
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
865 866 867 868 869 870 871 872 873
                (pv_name pv).id_string;
              C.propagate_in_block (pv_name pv) se (expr info env e)
            | d,s ->
              let initblock = d, C.assignify (Evar (pv_name pv)) s in
              [ C.Ddecl (t, [pv_name pv, C.Enothing]) ],
              C.Sseq (C.Sblock initblock, C.Sblock (expr info env e))
          end
      | Lsym _ -> raise (Unsupported "LDsym")
      | Lrec _ -> raise (Unsupported "LDrec") (* TODO for rec at least*)
874
      | Lany _ -> raise (Unsupported "Lany")
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
875 876
       end
    | Eif (cond, th, el) ->
877
       let cd,cs = expr info {env with computes_return_value = false} cond in
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
878 879
       let t = expr info env th in
       let e = expr info env el in
880
       begin match simplify_cond (cd, cs) with
881
       | [], C.Sexpr c ->
Andrei Paskevich's avatar
Andrei Paskevich committed
882
          let c = handle_likely cond.e_attrs c in
883 884 885 886 887 888 889
          if is_false th && is_true el
	  then C.([], Sexpr(Eunop(Unot, c)))
	  else [], C.Sif(c,C.Sblock t, C.Sblock e)
       | cdef, cs ->
	  let cid = id_register (id_fresh "cond") in (* ? *)
	  C.Ddecl (C.Tsyntax ("int",[]), [cid, C.Enothing])::cdef,
	  C.Sseq (C.assignify (Evar cid) cs,
Andrei Paskevich's avatar
Andrei Paskevich committed
890
                  C.Sif ((handle_likely cond.e_attrs (C.Evar cid)),
891
                         C.Sblock t, C.Sblock e))
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
892 893
       end
    | Ewhile (c,b) ->
894
       Debug.dprintf debug_c_extraction "while@.";
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
895 896 897 898 899 900 901
      let cd, cs = expr info {env with computes_return_value = false} c in
      (* this is needed so that the extracted expression has all
         needed variables in its scope *)
      let cd, cs = C.flatten_defs cd cs in
      let cd = C.group_defs_by_type cd in
      let env' = { computes_return_value = false;
                   in_unguarded_loop = true;
902 903
		   returns = env.returns;
                   current_function = env.current_function;
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
904 905 906 907
                   breaks =
                     if env.in_unguarded_loop
                     then Sid.empty else env.breaks } in
      let b = expr info  env' b in
908
      begin match (C.simplify_cond (cd,cs)) with
Andrei Paskevich's avatar
Andrei Paskevich committed
909
      | cd, C.Sexpr ce -> cd, C.Swhile (handle_likely c.e_attrs ce, C.Sblock b)
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
910 911
      | _ ->
        begin match C.get_last_expr cs with
Andrei Paskevich's avatar
Andrei Paskevich committed
912
        | C.Snop, e -> cd, C.(Swhile(handle_likely c.e_attrs e, C.Sblock b))
913
        | s,e ->
Andrei Paskevich's avatar
Andrei Paskevich committed
914
           let brc = reverse_likely (handle_likely c.e_attrs (Eunop(Unot,e))) in
915 916 917 918
           cd, C.(Swhile(Econst (Cint "1"),
                         Sseq(s,
                              Sseq(Sif(brc, Sbreak, Snop),
                                   C.Sblock b))))
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
919 920
        end
      end
921
    | Ematch (b, [], (_::_ as xl)) ->
922
      Debug.dprintf debug_c_extraction "TRY@.";
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
923 924 925 926 927
      let is_while = match b.e_node with Ewhile _ -> true | _-> false in
      let breaks, returns = List.fold_left
        (fun (bs,rs) (xs, pvsl, r) ->
          let id = xs.xs_name in
          match pvsl, r.e_node with
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
928
          | [pv], Mltree.Evar pv'
Raphaël Rieu-Helft's avatar
Raphaël Rieu-Helft committed
929
            when pv_equal pv pv' && env.computes_return_value ->
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
930 931 932 933 934 935 936 937
            (bs, Sid.add id rs)
          | [], (Eblock []) when is_unit r.e_ity && is_while ->
            (Sid.add id bs, rs)
          |_ -> raise (Unsupported "non break/return exception in try"))
        (Sid.empty, env.returns) xl
      in
      let env' = { computes_return_value = env.computes_return_value;
                   in_unguarded_loop = false;
938 939
                   current_function = env.current_function;
		   breaks = breaks;
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
940 941 942 943
                   returns = returns;
                 } in
      expr info env' b
    | Eraise (xs,_) when Sid.mem xs.xs_name env.breaks ->
944
      Debug.dprintf debug_c_extraction "BREAK@.";
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
945 946
      ([], C.Sbreak)
    | Eraise (xs, Some r) when Sid.mem xs.xs_name env.returns ->
947
      Debug.dprintf debug_c_extraction "RETURN@.";
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
948
      expr info {env with computes_return_value = true} r
949 950
    | Eraise (xs, None) when Sid.mem xs.xs_name env.returns ->
       assert false (* nothing to pass to return *)
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
951
    | Eraise _ -> raise (Unsupported "non break/return exception raised")
952 953 954 955 956 957 958 959 960
    | Efor (i, sb, dir, eb, body) ->
       begin match i.pv_vs.vs_ty.ty_node with
       | Tyapp ({ ts_def = Range _ },_) ->
          let ty = ty_of_ty info i.pv_vs.vs_ty in
          let di = C.Ddecl(ty, [i.pv_vs.vs_name, Enothing]) in
          let ei = C.Evar (i.pv_vs.vs_name) in
          let init_e = C.Ebinop (Bassign, ei, C.Evar (sb.pv_vs.vs_name)) in
          let incr_op = match dir with To -> C.Upostincr | DownTo -> C.Upostdecr in
          let incr_e = C.Eunop (incr_op, ei) in
961 962 963 964 965 966 967
          let init_test_op = match dir with | To -> C.Blt | DownTo -> C.Bgt in
          let init_test = C.Sif (C.Ebinop(init_test_op,
                                          C.Evar (eb.pv_vs.vs_name),
                                          C.Evar (sb.pv_vs.vs_name)),
                                 Sbreak, Snop) in
          let end_test = C.Sif (C.Ebinop (C.Beq, ei, C.Evar eb.pv_vs.vs_name),
                                Sbreak, Snop) in
968 969 970 971 972 973
          let env' = { env with computes_return_value = false;
                                in_unguarded_loop = true;
                                breaks =
                                  if env.in_unguarded_loop
                                  then Sid.empty else env.breaks } in
          let bd, bs = expr info env' body in
974 975
          let bs = C.Sseq(init_test, C.Sseq (bs, end_test)) in
          [di], C.Sfor(init_e, Enothing, incr_e, C.Sblock (bd,bs))
976 977
       |  _ -> raise (Unsupported "for loops")
       end
978
    | Ematch (({e_node = Eapp(rs,_)} as e1), [Ptuple rets,e2], [])
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
979
         when List.for_all
980
                (function | Pwild (*ghost*) | Pvar _ -> true |_-> false)
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
981 982
                rets
      ->
983 984 985 986 987 988 989 990 991 992
       let id_struct = id_register (id_fresh "struct_res") in
       let e_struct = C.Evar id_struct in
       let d_struct = C.Ddecl(C.Tstruct (struct_of_rs info rs),
                              [id_struct, C.Enothing]) in
       let defs =
         List.fold_right
           (fun p acc ->
             match p with
             | Pvar vs -> C.Ddecl(ty_of_ty info vs.vs_ty,
                                  [vs.vs_name, C.Enothing])::acc
993
             | Pwild -> acc
994 995 996 997 998 999 1000 1001 1002 1003
             | _ -> assert false )
        rets [d_struct] in
       let d,s = expr info {env with computes_return_value = false} e1 in
       let s = assignify e_struct s in
       let assign vs i =
         assignify (C.Evar vs) C.(Sexpr (Edot (e_struct, field i))) in
       let rec assigns rets i =
         match rets with
         | [] -> C.Snop
         | Pvar vs :: t -> C.Sseq ((assign vs.vs_name i), (assigns t (i+1)))
1004
         | Pwild :: t -> assigns t (i+1) (* ghost variable, skip *)
1005 1006 1007 1008
         | _ -> assert false in
       let assigns = assigns rets 0 in
       let b = expr info env e2 in
       d@defs, C.(Sseq(Sseq(s,assigns), Sblock b))
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
1009 1010
    | Ematch _ -> raise (Unsupported "pattern matching")
    | Eabsurd -> assert false
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
    | Eassign ([pv, ({rs_field = Some _} as rs), v]) ->
       let t =
         match (query_syntax info.syntax rs.rs_name,
                      query_syntax info.converter rs.rs_name) with
         | _, Some s | Some s, _ ->
            let _ =
              try
                Str.search_forward
                  (Str.regexp "[%]\\([tv]?\\)[0-9]+") s 0
              with Not_found -> raise (Unsupported "assign field format")  in
            let params = [ C.Evar pv.pv_vs.vs_name,
                           ty_of_ty info (ty_of_ity pv.pv_ity) ] in
            let rty = ty_of_ity rs.rs_cty.cty_result in
            let rtyargs = match rty.ty_node with
	      | Tyvar _ -> [||]
	      | Tyapp (_,args) ->
                 Array.of_list (List.map (ty_of_ty info) args)
	    in
            C.Esyntax(s,ty_of_ty info rty, rtyargs, params,
                      Mid.mem rs.rs_name info.converter)
         | None, None -> raise (Unsupported ("assign not in driver")) in
       [], C.(Sexpr(Ebinop(Bassign, t, C.Evar v.pv_vs.vs_name)))
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
1033
    | Eassign _ -> raise (Unsupported "assign")
1034
    | Ehole | Eany _ -> assert false
1035
    | Eexn (_,_,e) -> expr info env e
1036 1037 1038 1039 1040
    | Eignore e ->
       [], C.Sseq(C.Sblock(expr info {env with computes_return_value = false} e),
              if env.computes_return_value
              then C.Sreturn(Enothing)
              else C.Snop)
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
1041 1042
    | Efun _ -> raise (Unsupported "higher order")

1043
  let translate_decl (info:info) (d:decl) ~header : C.definition list =
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
    let translate_fun rs vl e =
      Debug.dprintf debug_c_extraction "print %s@." rs.rs_name.id_string;
      if rs_ghost rs
      then begin Debug.dprintf debug_c_extraction "is ghost@."; [] end
      else
        let params =
          List.map (fun (id, ty, _gh) -> (ty_of_mlty info ty, id))
            (List.filter (fun (_,_, gh) -> not gh) vl) in
        let params = List.filter (fun (ty, _) -> ty <> C.Tvoid) params in
	let env = { computes_return_value = true;
		    in_unguarded_loop = false;
                    current_function = rs;
		    returns = Sid.empty;
		    breaks = Sid.empty; } in
	let rity = rs.rs_cty.cty_result in
	let is_simple_tuple ity =
	  let arity_zero = function
	    | Ityapp(_,a,r) -> a = [] && r = []
	    | Ityreg { reg_args = a; reg_regs = r } ->
               a = [] && r = []
	    | Ityvar _ -> true
	  in
	  (match ity.ity_node with
	   | Ityapp ({its_ts = s},_,_)
             | Ityreg { reg_its = {its_ts = s}; }
	     -> is_ts_tuple s
	   | _ -> false)
	  && (ity_fold
                (fun acc ity ->
                  acc && arity_zero ity.ity_node) true ity)
	in
	(* FIXME is it necessary to have arity 0 in regions ?*)
	let rtype = ty_of_ty info (ty_of_ity rity) in
        let rtype,sdecls =
          if rtype=C.Tnosyntax && is_simple_tuple rity
          then
            let st = struct_of_rs info rs in
            C.Tstruct st, [C.Dstruct st]
          else rtype, [] in
1083 1084 1085 1086 1087 1088 1089 1090 1091
        if header
        then sdecls@[C.Dproto (rs.rs_name, (rtype, params))]
        else
	  let d,s = expr info env e in
	  let d,s = C.flatten_defs d s in
          let d = C.group_defs_by_type d in
	  let s = C.elim_nop s in
	  let s = C.elim_empty_blocks s in
	  sdecls@[C.Dfun (rs.rs_name, (rtype,params), (d,s))] in
1092 1093
    try
      begin match d with
1094
      | Dlet (Lsym(rs, _, vl, e)) -> translate_fun rs vl e
1095 1096 1097 1098
      | Dtype [{its_name=id; its_def=idef}] ->
         Debug.dprintf debug_c_extraction "PDtype %s@." id.id_string;
         begin
           match idef with
1099
           | Some (Dalias _ty) -> [] (*[C.Dtypedef (ty_of_mlty info ty, id)] *)
1100 1101 1102 1103 1104
           | Some _ -> raise (Unsupported "Ddata/Drecord@.")
           | None ->
              begin match query_syntax info.syntax id with
              | Some _ -> []
              | None ->
1105 1106 1107
                 raise (Unsupported
                          ("type declaration without syntax or alias: "
                           ^id.id_string))
1108
              end
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
1109
         end
1110 1111 1112 1113
      | Dlet (Lrec rl) ->
         let translate_rdef rd =
           translate_fun rd.rec_sym rd.rec_args rd.rec_exp in
         let defs = List.flatten (List.map translate_rdef rl) in
1114 1115 1116 1117 1118 1119 1120
         if header then defs
         else
           let proto_of_fun = function
             | C.Dfun (id, pr, _) -> [C.Dproto (id, pr)]
             | _ -> [] in
           let protos = List.flatten (List.map proto_of_fun defs) in
           protos@defs
1121 1122
      | _ -> [] (*TODO exn ? *) end
    with Unsupported s ->
1123
      Debug.dprintf debug_c_extraction "Unsupported : %s@." s; []
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
1124

1125
  let translate_decl (info:info) (d:Mltree.decl) ~header : C.definition list =
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
1126
    let decide_print id = query_syntax info.syntax id = None in
1127 1128
    let names = Mltree.get_decl_name d in
    match List.filter decide_print names with
1129
    | [] -> []
1130
    | _ -> translate_decl info d ~header
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
1131 1132 1133 1134

end


1135
let name_gen suffix ?fname m =
1136
  let n = m.Pmodule.mod_theory.Theory.th_name.Ident.id_string in
1137
  let n = Print.sanitizer n in
1138 1139 1140
  let r = match fname with
    | None -> n ^ suffix
    | Some f -> f ^ "__" ^ n ^ suffix in
1141
  Strings.lowercase r
1142 1143 1144 1145

let file_gen = name_gen ".c"
let header_gen = name_gen ".h"

1146 1147 1148 1149 1150 1151 1152
let print_header_decl args fmt d =
  let cds = MLToC.translate_decl args d ~header:true in
  List.iter (Format.fprintf fmt "%a@." Print.print_def) cds

let print_header_decl =
  let memo = Hashtbl.create 16 in
  fun args ?old ?fname ~flat m fmt d ->
1153 1154 1155 1156
  ignore old;
  ignore fname;
  ignore flat;
  ignore m;
1157 1158 1159 1160
  if not (Hashtbl.mem memo d)
  then begin
    Hashtbl.add memo d ();
    print_header_decl args fmt d end
1161

1162
let print_prelude args ?old ?fname ~flat deps fmt pm =
1163 1164 1165
  ignore old;
  ignore fname;
  ignore flat;
1166
  ignore pm;
1167
  ignore args;
1168 1169 1170 1171 1172 1173 1174
  let add_include id =
    Format.fprintf fmt "%a@." Print.print_def C.(Dinclude (id,Proj)) in
  List.iter
    (fun m ->
      let id = m.Pmodule.mod_theory.Theory.th_name in
      add_include id)
    (List.rev deps)
1175

1176 1177 1178 1179 1180 1181 1182 1183 1184
let print_decl args fmt d =
  let cds = MLToC.translate_decl args d ~header:false in
  let print_def d =
    Format.fprintf fmt "%a@." Print.print_def d in
  List.iter print_def cds

let print_decl =
  let memo = Hashtbl.create 16 in
  fun args ?old ?fname ~flat m fmt d ->
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
1185 1186
  ignore old;
  ignore fname;
1187
  ignore flat;
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
1188
  ignore m;
1189 1190 1191 1192
  if not (Hashtbl.mem memo d)
  then begin
    Hashtbl.add memo d ();
    print_decl args fmt d end
Raphael Rieu-Helft's avatar
Raphael Rieu-Helft committed
1193