dexpr.ml 53.4 KB
Newer Older
1 2 3
(********************************************************************)
(*                                                                  *)
(*  The Why3 Verification Platform   /   The Why3 Development Team  *)
MARCHE Claude's avatar
MARCHE Claude committed
4
(*  Copyright 2010-2017   --   INRIA - CNRS - Paris-Sud University  *)
5 6 7 8
(*                                                                  *)
(*  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.                           *)
9
(*                                                                  *)
10 11 12 13 14 15 16 17 18 19 20 21
(********************************************************************)

open Stdlib
open Ident
open Ty
open Term
open Ity
open Expr

(** Program types *)

type dity =
Andrei Paskevich's avatar
Andrei Paskevich committed
22
  | Dvar of dvar ref          (* destructible "fresh" type variable *)
23 24
  | Dutv of tvsymbol          (* undestructible "user" type variable *)
  | Durg of dity * region     (* undestructible "user" region *)
25 26 27
  | Dapp of itysymbol * dity list * dity list

and dvar =
28 29 30 31 32
  | Dval of dity              (* i am equal to dity *)
  | Dpur of dity              (* i am equal to the purified dity *)
  | Dsim of dity * tvsymbol   (* our purified types are equal *)
  | Dreg of dity * tvsymbol   (* unassigned region *)
  | Dtvs of        tvsymbol   (* unassigned variable *)
Andrei Paskevich's avatar
Andrei Paskevich committed
33

34
(* In Dreg and Durg, the dity field is a Dapp of the region's type. *)
35 36 37

type dvty = dity list * dity (* A -> B -> C == ([A;B],C) *)

Andrei Paskevich's avatar
Andrei Paskevich committed
38
let dity_of_dvty (argl,res) =
39
  List.fold_right (fun a d -> Dapp (its_func, [a;d], [])) argl res
Andrei Paskevich's avatar
Andrei Paskevich committed
40

41 42 43 44 45 46 47 48 49 50
let dity_fresh () =
  Dvar (ref (Dtvs (create_tvsymbol (id_fresh "mu"))))

let dity_reg d =
  Dvar (ref (Dreg (d, create_tvsymbol (id_fresh "rho"))))

let rec dity_sim = function
  | Dvar {contents = (Dval d|Dpur d|Dsim (d,_)|Dreg (d,_))}
  | Durg (d,_) -> dity_sim d
  | d -> Dvar (ref (Dsim (d, create_tvsymbol (id_fresh "eta"))))
51

52 53 54 55 56 57
let rec dity_pur = function
  | Dvar {contents = (Dval d|Dpur d|Dsim (d,_)|Dreg (d,_))}
  | Durg (d,_) -> dity_pur d
  | d -> Dvar (ref (Dpur d))

let app_map fn s tl rl = Dapp (s, List.map fn tl, List.map fn rl)
58 59 60 61

let dity_of_ity ity =
  let hr = Hreg.create 3 in
  let rec dity ity = match ity.ity_node with
62 63 64 65 66 67 68
    | Ityvar (v,false) -> Dutv v
    | Ityvar (v,true)  -> dity_pur (Dutv v)
    | Ityapp (s,tl,rl) -> app_map dity s tl rl
    | Ityreg ({reg_its = s; reg_args = tl; reg_regs = rl} as r) ->
        try Hreg.find hr r with Not_found ->
        let d = dity_reg (app_map dity s tl rl) in
        Hreg.add hr r d; d in
69 70 71
  dity ity

let rec ity_of_dity = function
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
  | Dutv v -> ity_var v
  | Durg (_,r) -> ity_reg r
  | Dvar {contents = Dval d} -> ity_of_dity d
  | Dvar {contents = Dpur d} -> ity_purify (ity_of_dity d)
  | Dvar ({contents = Dsim (d,_)} as r) ->
      let rec refresh ity = match ity.ity_node with
        | Ityreg {reg_its = s; reg_args = tl} | Ityapp (s,tl,_) ->
            ity_app s (List.map refresh tl) []
        | Ityvar (v,_) -> ity_var v in
      let rec dity ity = match ity.ity_node with
        | Ityreg r ->
            Durg (app_map dity r.reg_its r.reg_args r.reg_regs, r)
        | Ityapp (s,tl,rl) -> app_map dity s tl rl
        | Ityvar (v,true)  -> dity_pur (Dutv v)
        | Ityvar (v,false) -> Dutv v in
      let t = refresh (ity_of_dity d) in
      r := Dval (dity t); t
  | Dvar ({contents = Dreg (Dapp (s,tl,rl) as d,_)} as r) ->
      let reg = create_region (id_fresh "rho") s
        (List.map ity_of_dity tl) (List.map ity_of_dity rl) in
      r := Dval (Durg (d, reg)); ity_reg reg
93 94 95 96
  | Dvar r ->
      let v = create_tvsymbol (id_fresh "xi") in
      r := Dval (Dutv v); ity_var v
  | Dapp (s,tl,rl) ->
97
      ity_app_pure s (List.map ity_of_dity tl) (List.map ity_of_dity rl)
98 99 100 101

(** Destructive type unification *)

let rec occur_check v = function
102 103 104 105 106 107 108 109 110 111 112 113 114 115
  | Dvar {contents = (Dval d|Dpur d)} | Durg (d,_) ->
      occur_check v d
  | Dvar {contents = (Dsim (d,u)|Dreg (d,u))} ->
      if tv_equal u v then raise Exit else occur_check v d
  | Dvar {contents = Dtvs u} | Dutv u ->
      if tv_equal u v then raise Exit
  | Dapp (_,dl,_) ->
      List.iter (occur_check v) dl

let rec dity_unify_weak d1 d2 = match d1,d2 with
  | Dvar {contents = (Dval d1|Dpur d1|Dsim (d1,_)|Dreg (d1,_))}, d2
  | d1, Dvar {contents = (Dval d2|Dpur d2|Dsim (d2,_)|Dreg (d2,_))}
  | Durg (d1,_), d2 | d1, Durg (d2,_) ->
      dity_unify_weak d1 d2
116 117 118 119 120 121
  | Dvar {contents = Dtvs u},
    Dvar {contents = Dtvs v} when tv_equal u v ->
      ()
  | Dvar ({contents = Dtvs v} as r), d
  | d, Dvar ({contents = Dtvs v} as r) ->
      occur_check v d;
122
      r := Dsim (d,v)
123 124
  | Dutv u, Dutv v when tv_equal u v ->
      ()
125
  | Dapp (s1,dl1,_), Dapp (s2,dl2,_) when its_equal s1 s2 ->
126
      List.iter2 dity_unify_weak dl1 dl2
127 128
  | _ -> raise Exit

129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
let rec dity_refresh = function
  | Dvar {contents = (Dval d|Dpur d|Dsim (d,_)|Dreg (d,_))}
  | Durg (d,_) -> dity_refresh d
  | Dutv _ as d -> d
  | Dvar {contents = Dtvs _} -> dity_fresh ()
  | Dapp (s,dl,_) ->
      let dl = List.map dity_refresh dl in
      let mv = List.fold_right2 Mtv.add s.its_ts.ts_args dl Mtv.empty in
      let hr = Hreg.create 3 in
      let rec ity_inst ity = match ity.ity_node with
        | Ityreg r -> reg_inst r
        | Ityvar (v, false) -> Mtv.find v mv
        | Ityvar (v, true) -> dity_pur (Mtv.find v mv)
        | Ityapp (s,tl,rl) -> app_map ity_inst s tl rl
      and reg_inst ({reg_its = s; reg_args = tl; reg_regs = rl} as r) =
        try Hreg.find hr r with Not_found ->
        let d = dity_reg (app_map ity_inst s tl rl) in
        Hreg.replace hr r d; d in
      let d = Dapp (s, dl, List.map reg_inst s.its_regions) in
      if its_immutable s then d else dity_reg d

let rec dity_unify_asym d1 d2 = match d1,d2 with
  | Durg _, _ | Dutv _, _ -> raise Exit (* we cannot be pure then *)
  | d1, Dvar {contents = (Dval d2|Dpur d2|Dsim (d2,_)|Dreg (d2,_))}
  | d1, Durg (d2,_)
  | Dvar {contents = Dval d1}, d2 ->
      dity_unify_asym d1 d2
  | Dvar {contents = Dpur d1}, d2 ->
      dity_unify_weak d1 d2
  | Dvar ({contents = Dsim (d1,_)} as r), d2 ->
      dity_unify_weak d1 d2;
      r := Dpur d1
  | Dvar ({contents = Dreg (d1,_)} as r), d2 ->
      dity_unify_asym d1 d2;
      r := Dval d1
  | Dvar ({contents = Dtvs u} as r),
    Dvar {contents = Dtvs v} when tv_equal u v ->
      r := Dpur (dity_fresh ())
  | Dvar ({contents = Dtvs v} as r), d ->
      occur_check v d;
      r := Dpur d
  | d (* not a Dvar! *), Dvar ({contents = Dtvs v} as r) ->
      occur_check v d;
      let d2 = dity_refresh d in
      dity_unify_asym d d2;
      r := Dval d2
  | Dapp (s1,dl1,rl1), Dapp (s2,dl2,rl2) when its_equal s1 s2 ->
      List.iter2 dity_unify_asym dl1 dl2;
      List.iter2 dity_unify_asym rl1 rl2
  | _ -> raise Exit
179

180 181 182 183 184 185 186 187
let rec dity_unify d1 d2 = match d1,d2 with
  | Dvar {contents = Dval d1}, d2 | d1, Dvar {contents = Dval d2} ->
      dity_unify d1 d2
  | Dvar ({contents = Dpur d2}), d1 (* yes, it's d2 on the left *)
  | d1, Dvar ({contents = Dpur d2}) ->
      dity_unify_asym d1 d2
  | Dvar ({contents = Dsim (_,u)}),
    Dvar ({contents = Dsim (_,v)}) when tv_equal u v ->
188
      ()
189 190 191 192 193 194 195
  | Dvar ({contents = Dsim (d1,v)} as r), d
  | d, Dvar ({contents = Dsim (d1,v)} as r) ->
      occur_check v d; (* not necessary? *)
      dity_unify_weak d1 d;
      r := Dval d
  | Dvar {contents = Dreg (_,u)},
    Dvar {contents = Dreg (_,v)} when tv_equal u v ->
196
      ()
197 198 199 200 201 202
  | Dvar ({contents = Dreg (d1,v)} as r),
    ((Dapp _ as d2 | Durg (d2,_) | Dvar {contents = Dreg (d2,_)}) as d)
  | ((Dapp _ as d1 | Durg (d1,_)) as d),
    Dvar ({contents = Dreg (d2,v)} as r) ->
      occur_check v d; (* not necessary! *)
      dity_unify d1 d2;
203
      r := Dval d
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
  | Dvar ({contents = Dtvs u}),
    Dvar ({contents = Dtvs v}) when tv_equal u v ->
      ()
  | Dvar ({contents = Dtvs v} as r), d
  | d, Dvar ({contents = Dtvs v} as r) ->
      occur_check v d;
      r := Dval d
  | Dutv u, Dutv v when tv_equal u v ->
      ()
  | Durg (_,r1), Durg (_,r2) when reg_equal r1 r2 ->
      ()
  | Dapp (s1,dl1,rl1), Dapp (s2,dl2,rl2) when its_equal s1 s2 ->
      List.iter2 dity_unify dl1 dl2;
      List.iter2 dity_unify rl1 rl2
  | _ -> raise Exit
219 220 221

(** Built-in types *)

222 223 224 225
let dity_int  = Dapp (its_int,  [], [])
let dity_real = Dapp (its_real, [], [])
let dity_bool = Dapp (its_bool, [], [])
let dity_unit = Dapp (its_unit, [], [])
226

227
(*
228 229
let dvty_int  = [], dity_int
let dvty_real = [], dity_real
230
*)
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
let dvty_bool = [], dity_bool
let dvty_unit = [], dity_unit

(** Pretty-printing *)

let rprinter =
  let sanitizer = Ident.sanitizer Ident.char_to_lalpha Ident.char_to_alnumus in
  Ident.create_ident_printer [] ~sanitizer

let print_args pr fmt tl = if tl <> [] then
  Format.fprintf fmt "@ %a" (Pp.print_list Pp.space pr) tl

let print_regs pr fmt rl = if rl <> [] then
  Format.fprintf fmt "@ <%a>" (Pp.print_list Pp.comma pr) rl

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

248 249 250 251 252 253 254
let rec print_dity pur pri fmt = function
  | Dvar {contents = Dval d} ->
      print_dity pur pri fmt d
  | Dvar {contents = (Dpur d|Dsim (d,_)|Dreg (d,_))}
  | Durg (d,_) when pur ->
      print_dity pur pri fmt d
  | Dvar {contents = Dtvs v} | Dutv v ->
255
      Pretty.print_tv fmt v
256 257 258 259 260
  | Dvar {contents = Dpur d} ->
      Format.fprintf fmt "{%a}" (print_dity true 0) d
  | Dvar {contents = Dsim (d,_)} ->
      Format.fprintf fmt "[%a]" (print_dity true 0) d
  | Dvar {contents = Dreg (Dapp (s,tl,rl),{tv_name = id})}
261
  | Durg (Dapp (s,tl,rl),{reg_name = id}) ->
262 263 264 265 266
      Format.fprintf fmt
        (protect_on (pri > 1 && (tl <> [] || rl <> [])) "%a%a%a@ @@%s")
        Pretty.print_ts s.its_ts (print_args (print_dity pur 2)) tl
          (print_regs (print_dity pur 0)) rl (Ident.id_unique rprinter id)
  | Dvar {contents = Dreg _} | Durg _ -> assert false
267
  | Dapp (s,[t1;t2],[]) when its_equal s its_func ->
268
      Format.fprintf fmt (protect_on (pri > 0) "%a@ ->@ %a")
269
        (print_dity pur 1) t1 (print_dity pur 0) t2
270
  | Dapp (s,tl,[]) when is_ts_tuple s.its_ts ->
271 272 273 274 275 276 277 278 279
      Format.fprintf fmt "(%a)" (Pp.print_list Pp.comma (print_dity pur 0)) tl
  | Dapp (s,tl,_) when pur ->
      Format.fprintf fmt (protect_on (pri > 1 && tl <> []) "%a%a")
        Pretty.print_ts s.its_ts (print_args (print_dity pur 2)) tl
  | Dapp (s,tl,rl) when its_immutable s ->
      Format.fprintf fmt
        (protect_on (pri > 1 && (tl <> [] || rl <> [])) "%a%a%a")
        Pretty.print_ts s.its_ts (print_args (print_dity pur 2)) tl
          (print_regs (print_dity pur 0)) rl
280
  | Dapp (s,tl,rl) ->
281 282 283 284
      Format.fprintf fmt
        (protect_on (pri > 1 && (tl <> [] || rl <> [])) "{%a}%a%a")
        Pretty.print_ts s.its_ts (print_args (print_dity pur 2)) tl
          (print_regs (print_dity pur 0)) rl
285

286
let print_dity fmt d = print_dity false 0 fmt d
287 288 289 290

(* Specialization of symbols *)

let specialize_scheme tvs (argl,res) =
291
  let hv = Htv.create 3 in
292
  let rec spec_dity = function
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
    | Dvar {contents = Dval d} -> spec_dity d
    | Dvar {contents = Dpur d} -> dity_pur (spec_dity d)
    | Dvar {contents = Dsim (d,v)} ->
        (try Htv.find hv v with Not_found ->
        let nd = dity_sim (spec_dity d) in
        Htv.add hv v nd; nd)
    | Dvar {contents = Dreg (d,v)} ->
        (try Htv.find hv v with Not_found ->
        let nd = dity_reg (spec_dity d) in
        Htv.add hv v nd; nd)
    | Dvar {contents = Dtvs v} | Dutv v as d ->
        (try Htv.find hv v with Not_found ->
        (* even if v is frozen, it is polymorphic in its regions *)
        let nd = if Stv.mem v tvs then dity_fresh () else dity_sim d in
        Htv.add hv v nd; nd)
    | Dapp (s,dl,rl) -> app_map spec_dity s dl rl
    | Durg _ as d -> d in
310 311 312 313
  List.map spec_dity argl, spec_dity res

let spec_ity hv hr frz ity =
  let rec dity ity = match ity.ity_node with
314 315 316 317 318 319 320 321 322 323 324 325 326 327
    | Ityreg r ->
        (try Hreg.find hr r with Not_found ->
        let d = app_map dity r.reg_its r.reg_args r.reg_regs in
        let nd = if Mreg.mem r frz.isb_reg then Durg (d,r) else dity_reg d in
        Hreg.add hr r nd; nd)
    | Ityvar (v,pure) ->
        let nd = try Htv.find hv v with Not_found ->
          let nd =
            if Mtv.mem v frz.isb_var then Dutv v else
            if Mtv.mem v frz.isb_pur then dity_sim (Dutv v) else
            dity_fresh () in
          Htv.add hv v nd; nd in
        if pure then dity_pur nd else nd
    | Ityapp (s,tl,rl) -> app_map dity s tl rl in
328 329
  dity ity

Andrei Paskevich's avatar
Andrei Paskevich committed
330
let specialize_pv {pv_ity = ity} =
331 332
  spec_ity (Htv.create 3) (Hreg.create 3) (ity_freeze isb_empty ity) ity

Andrei Paskevich's avatar
Andrei Paskevich committed
333
let specialize_xs {xs_ity = ity} =
334 335
  spec_ity (Htv.create 3) (Hreg.create 3) (ity_freeze isb_empty ity) ity

336
let specialize_rs {rs_cty = cty} =
337 338 339 340
  let hv = Htv.create 3 and hr = Hreg.create 3 in
  let spec ity = spec_ity hv hr cty.cty_freeze ity in
  List.map (fun v -> spec v.pv_ity) cty.cty_args, spec cty.cty_result

341 342
let specialize_ls {ls_args = args; ls_value = res} =
  let hv = Htv.create 3 and hr = Hreg.create 3 in
343 344 345
  let spec_val _ ty = spec_ity hv hr isb_empty (ity_of_ty_pure ty) in
  let spec_arg ty = dity_sim (spec_val () ty) in
  List.map spec_arg args, Opt.fold spec_val dity_bool res
346

347 348 349
(** Patterns *)

type dpattern = {
Andrei Paskevich's avatar
Andrei Paskevich committed
350
  dp_pat  : pre_pattern;
351 352 353 354 355 356 357
  dp_dity : dity;
  dp_vars : dity Mstr.t;
  dp_loc  : Loc.position option;
}

type dpattern_node =
  | DPwild
358
  | DPvar  of preid * bool
359
  | DPapp  of rsymbol * dpattern list
360
  | DPas   of dpattern * preid * bool
361 362 363 364 365 366 367
  | DPor   of dpattern * dpattern
  | DPcast of dpattern * ity

(** Specifications *)

type ghost = bool

Andrei Paskevich's avatar
Andrei Paskevich committed
368
type dbinder = preid option * ghost * dity
369

370 371 372
type register_old = pvsymbol -> string -> pvsymbol

type 'a later = pvsymbol Mstr.t -> register_old -> 'a
373 374 375 376 377 378
  (* specification terms are parsed and typechecked after the program
     expressions, when the types of locally bound program variables are
     already established. *)

type dspec_final = {
  ds_pre     : term list;
379
  ds_post    : (pvsymbol * term) list;
380
  ds_xpost   : (pvsymbol * term) list Mxs.t;
381
  ds_reads   : pvsymbol list;
382 383
  ds_writes  : term list;
  ds_diverge : bool;
384
  ds_checkrw : bool;
385 386
}

387
type dspec = ity -> dspec_final
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
  (* Computation specification is also parametrized by the result type.
     All vsymbols in the postcondition clauses in the [ds_post] field
     must have this type. All vsymbols in the exceptional postcondition
     clauses must have the type of the corresponding exception. *)

(** Expressions *)

type dinvariant = term list

type dexpr = {
  de_node : dexpr_node;
  de_dvty : dvty;
  de_loc  : Loc.position option;
}

and dexpr_node =
  | DEvar of string * dvty
405 406
  | DEpv of pvsymbol
  | DErs of rsymbol
407
  | DEls of lsymbol
408
  | DEconst of Number.constant * dity
409
  | DEapp of dexpr * dexpr
410 411
  | DEfun of dbinder list * mask * dspec later * dexpr
  | DEany of dbinder list * mask * dspec later * dity
412 413
  | DElet of dlet_defn * dexpr
  | DErec of drec_defn * dexpr
Andrei Paskevich's avatar
Andrei Paskevich committed
414
  | DEnot of dexpr
415 416
  | DEand of dexpr * dexpr
  | DEor of dexpr * dexpr
417 418
  | DEif of dexpr * dexpr * dexpr
  | DEcase of dexpr * (dpattern * dexpr) list
419
  | DEassign of (dexpr * rsymbol * dexpr) list
420
  | DEwhile of dexpr * dinvariant later * variant list later * dexpr
421
  | DEfor of preid * dexpr * for_direction * dexpr * dinvariant later * dexpr
Andrei Paskevich's avatar
Andrei Paskevich committed
422 423 424
  | DEtry of dexpr * (xsymbol * dpattern * dexpr) list
  | DEraise of xsymbol * dexpr
  | DEghost of dexpr
425
  | DEassert of assertion_kind * term later
Andrei Paskevich's avatar
Andrei Paskevich committed
426 427 428 429
  | DEpure of term later
  | DEabsurd
  | DEtrue
  | DEfalse
430 431 432 433 434
  | DEmark of preid * dexpr
  | DEcast of dexpr * ity
  | DEuloc of dexpr * Loc.position
  | DElabel of dexpr * Slab.t

435
and dlet_defn = preid * ghost * rs_kind * dexpr
436 437 438

and drec_defn = { fds : dfun_defn list }

439
and dfun_defn = preid * ghost * rs_kind *
440
  dbinder list * mask * dspec later * variant list later * dexpr
Andrei Paskevich's avatar
Andrei Paskevich committed
441

442 443 444 445 446 447 448
(** Environment *)

type denv = {
  frozen : dity list;
  locals : (Stv.t option * dvty) Mstr.t;
}

449 450
let denv_contents d = d.locals

451 452
let denv_empty = { frozen = []; locals = Mstr.empty }

Andrei Paskevich's avatar
Andrei Paskevich committed
453 454
let is_frozen frozen v =
  try List.iter (occur_check v) frozen; false with Exit -> true
455 456 457

let freeze_dvty frozen (argl,res) =
  let rec add l = function
458 459 460
    | Dvar {contents = (Dval d|Dpur d|Dsim (d,_)|Dreg (d,_))}
    | Durg (d,_) -> add l d
    | Dvar {contents = Dtvs _}
461
    | Dutv _ as d -> d :: l
462
    | Dapp (_,tl,_) -> List.fold_left add l tl in
463 464 465 466
  List.fold_left add (add frozen res) argl

let free_vars frozen (argl,res) =
  let rec add s = function
467 468 469 470
    | Dvar {contents = (Dval d|Dpur d|Dsim (d,_)|Dreg (d,_))}
    | Durg (d,_) -> add s d
    | Dvar {contents = Dtvs v} | Dutv v ->
        if is_frozen frozen v then s else Stv.add v s
471
    | Dapp (_,tl,_) -> List.fold_left add s tl in
472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
  List.fold_left add (add Stv.empty res) argl

let denv_add_mono { frozen = frozen; locals = locals } id dvty =
  let locals = Mstr.add id.pre_name (None, dvty) locals in
  { frozen = freeze_dvty frozen dvty; locals = locals }

let denv_add_poly { frozen = frozen; locals = locals } id dvty =
  let ftvs = free_vars frozen dvty in
  let locals = Mstr.add id.pre_name (Some ftvs, dvty) locals in
  { frozen = frozen; locals = locals }

let denv_add_rec_mono { frozen = frozen; locals = locals } id dvty =
  let locals = Mstr.add id.pre_name (Some Stv.empty, dvty) locals in
  { frozen = freeze_dvty frozen dvty; locals = locals }

let denv_add_rec_poly { frozen = frozen; locals = locals } frozen0 id dvty =
  let ftvs = free_vars frozen0 dvty in
  let locals = Mstr.add id.pre_name (Some ftvs, dvty) locals in
  { frozen = frozen; locals = locals }

let denv_add_rec denv frozen0 id ((argl,res) as dvty) =
  let rec is_explicit = function
494 495 496
    | Dvar {contents = (Dval d|Dpur d|Dsim (d,_)|Dreg (d,_))}
    | Durg (d,_) -> is_explicit d
    | Dvar {contents = Dtvs _} -> false
Andrei Paskevich's avatar
Andrei Paskevich committed
497
    | Dutv _ -> true
498
    | Dapp (_,tl,_) -> List.for_all is_explicit tl in
499 500 501 502 503 504
  if List.for_all is_explicit argl && is_explicit res
  then denv_add_rec_poly denv frozen0 id dvty
  else denv_add_rec_mono denv id dvty

let denv_add_var denv id dity = denv_add_mono denv id ([], dity)

Andrei Paskevich's avatar
Andrei Paskevich committed
505
let denv_add_let denv (id,_,_,({de_dvty = dvty} as de)) =
506 507 508
  if fst dvty = [] then denv_add_mono denv id dvty else
  let rec is_value de = match de.de_node with
    | DEghost de | DEuloc (de,_) | DElabel (de,_) -> is_value de
509
    | DEvar _ | DErs _ | DEls _ | DEfun _ | DEany _ -> true
510 511 512 513 514 515
    | _ -> false in
  if is_value de
  then denv_add_poly denv id dvty
  else denv_add_mono denv id dvty

let denv_add_args { frozen = frozen; locals = locals } bl =
Andrei Paskevich's avatar
Andrei Paskevich committed
516 517
  let l = List.fold_left (fun l (_,_,t) -> t::l) frozen bl in
  let add s (id,_,t) = match id with
518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549
    | Some {pre_name = n} ->
        Mstr.add_new (Dterm.DuplicateVar n) n (None, ([],t)) s
    | None -> s in
  let s = List.fold_left add Mstr.empty bl in
  { frozen = l; locals = Mstr.set_union s locals }

let denv_add_pat { frozen = frozen; locals = locals } dp =
  let l = Mstr.fold (fun _ t l -> t::l) dp.dp_vars frozen in
  let s = Mstr.map (fun t -> None, ([], t)) dp.dp_vars in
  { frozen = l; locals = Mstr.set_union s locals }

let mk_node n = function
  | Some tvs, dvty -> DEvar (n, specialize_scheme tvs dvty)
  | None,     dvty -> DEvar (n, dvty)

let denv_get denv n =
  mk_node n (Mstr.find_exn (Dterm.UnboundVar n) n denv.locals)

let denv_get_opt denv n =
  Opt.map (mk_node n) (Mstr.find_opt n denv.locals)

(** Unification tools *)

let dity_unify_app ls fn (l1: 'a list) (l2: dity list) =
  try List.iter2 fn l1 l2 with Invalid_argument _ ->
    raise (BadArity (ls, List.length l1))

let dpat_expected_type {dp_dity = dp_dity; dp_loc = loc} dity =
  try dity_unify dp_dity dity with Exit -> Loc.errorm ?loc
    "This pattern has type %a,@ but is expected to have type %a"
    print_dity dp_dity print_dity dity

Andrei Paskevich's avatar
Andrei Paskevich committed
550 551
let dexpr_expected_type {de_dvty = dvty; de_loc = loc} dity =
  let res = dity_of_dvty dvty in
552 553 554 555
  try dity_unify res dity with Exit -> Loc.errorm ?loc
    "This expression has type %a,@ but is expected to have type %a"
    print_dity res print_dity dity

Andrei Paskevich's avatar
Andrei Paskevich committed
556 557
let dexpr_expected_type_weak {de_dvty = dvty; de_loc = loc} dity =
  let res = dity_of_dvty dvty in
558 559 560 561 562 563
  try dity_unify_weak res dity with Exit -> Loc.errorm ?loc
    "This expression has type %a,@ but is expected to have type %a"
    print_dity res print_dity dity

(** Generation of letrec blocks *)

564
type pre_fun_defn = preid * ghost * rs_kind * dbinder list *
565
  dity * mask * (denv -> dspec later * variant list later * dexpr)
566 567 568 569

exception DupId of preid

let drec_defn denv0 prel =
Andrei Paskevich's avatar
Andrei Paskevich committed
570
  if prel = [] then invalid_arg "Dexpr.drec_defn: empty function list";
571
  let add s (id,_,_,_,_,_,_) = Sstr.add_new (DupId id) id.pre_name s in
572 573
  let _ = try List.fold_left add Sstr.empty prel with DupId id ->
    Loc.errorm ?loc:id.pre_loc "duplicate function name %s" id.pre_name in
574
  let add denv (id,_,_,bl,res,_,_) =
Andrei Paskevich's avatar
Andrei Paskevich committed
575 576
    if bl = [] then invalid_arg "Dexpr.drec_defn: empty argument list";
    let argl = List.map (fun (_,_,t) -> t) bl in
577 578
    denv_add_rec denv denv0.frozen id (argl,res) in
  let denv1 = List.fold_left add denv0 prel in
579
  let parse (id,gh,pk,bl,res,msk,pre) =
580
    let dsp, dvl, de = pre (denv_add_args denv1 bl) in
581
    dexpr_expected_type de res;
582
    (id,gh,pk,bl,msk,dsp,dvl,de) in
583
  let fdl = List.map parse prel in
584
  let add denv (id,_,_,bl,_,_,_,{de_dvty = dvty}) =
Andrei Paskevich's avatar
Andrei Paskevich committed
585
    (* just in case we linked some polymorphic type var to the outer context *)
586 587 588 589 590 591 592
    let check tv = if is_frozen denv0.frozen tv then Loc.errorm ?loc:id.pre_loc
      "This function is expected to be polymorphic in type variable %a"
      Pretty.print_tv tv in
    begin match Mstr.find_opt id.pre_name denv1.locals with
    | Some (Some tvs, _) -> Stv.iter check tvs
    | Some (None, _) | None -> assert false
    end;
Andrei Paskevich's avatar
Andrei Paskevich committed
593 594
    let argl = List.map (fun (_,_,t) -> t) bl in
    denv_add_poly denv id (argl, dity_of_dvty dvty) in
595 596 597 598 599 600 601 602 603 604
  List.fold_left add denv0 fdl, { fds = fdl }

(** Constructors *)

let dpattern ?loc node =
  let mk_dpat pre dity vars =
    { dp_pat = pre; dp_dity = dity; dp_vars = vars; dp_loc = loc } in
  let dpat = function
    | DPwild ->
        mk_dpat PPwild (dity_fresh ()) Mstr.empty
605
    | DPvar (id,gh) ->
606
        let dity = dity_fresh () in
607
        mk_dpat (PPvar (id,gh)) dity (Mstr.singleton id.pre_name dity)
608 609
    | DPapp ({rs_logic = RLls ls} as rs, dpl) when ls.ls_constr > 0 ->
        let argl, res = specialize_rs rs in
610 611 612 613 614
        dity_unify_app ls dpat_expected_type dpl argl;
        let join n _ _ = raise (Dterm.DuplicateVar n) in
        let add acc dp = Mstr.union join acc dp.dp_vars in
        let vars = List.fold_left add Mstr.empty dpl in
        let ppl = List.map (fun dp -> dp.dp_pat) dpl in
615 616 617
        mk_dpat (PPapp (rs, ppl)) res vars
    | DPapp (rs,_) ->
        raise (ConstructorExpected rs);
618 619 620 621 622 623 624 625
    | DPor (dp1,dp2) ->
        dpat_expected_type dp2 dp1.dp_dity;
        let join n dity1 dity2 = try dity_unify dity1 dity2; Some dity1
          with Exit -> Loc.errorm ?loc
            "Variable %s has type %a,@ but is expected to have type %a"
            n print_dity dity1 print_dity dity2 in
        let vars = Mstr.union join dp1.dp_vars dp2.dp_vars in
        mk_dpat (PPor (dp1.dp_pat, dp2.dp_pat)) dp1.dp_dity vars
626
    | DPas (dp, ({pre_name = n} as id), gh) ->
627 628
        let { dp_pat = pat; dp_dity = dity; dp_vars = vars } = dp in
        let vars = Mstr.add_new (Dterm.DuplicateVar n) n dity vars in
629
        mk_dpat (PPas (pat, id, gh)) dity vars
630
    | DPcast (dp, ity) ->
631
        dpat_expected_type dp (dity_of_ity ity);
632 633 634 635 636 637 638
        dp
  in
  Loc.try1 ?loc dpat node

let dexpr ?loc node =
  let get_dvty = function
    | DEvar (_,dvty) ->
639
        dvty
640
    | DEpv pv ->
641
        [], specialize_pv pv
642
    | DErs rs ->
643
        specialize_rs rs
644 645
    | DEls ls ->
        specialize_ls ls
646
    | DEconst (_, ity) -> [],ity
647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
    | DEapp ({de_dvty = (arg::argl, res)}, de2) ->
        dexpr_expected_type de2 arg;
        argl, res
    | DEapp ({de_dvty = ([],res)} as de1, de2) ->
        let f,a,r = match specialize_rs rs_func_app with
          | [f;a],r -> f,a,r | _ -> assert false in
        begin try dity_unify res f with Exit ->
          let rec down n de = match de.de_node with
            | DEapp (de,_) -> down (succ n) de
            | _ when n = 0 -> Loc.errorm ?loc:de.de_loc
                "This expression has type %a,@ it cannot be applied"
                print_dity (dity_of_dvty de.de_dvty)
            | _ -> Loc.errorm ?loc:de.de_loc
                "This expression has type %a,@ but is applied to %d arguments"
                print_dity (dity_of_dvty de.de_dvty) (succ n) in
          down 0 de1
        end;
        dexpr_expected_type de2 a;
        [], r
666
    | DEfun (bl,_,_,de) ->
667
        List.map (fun (_,_,t) -> t) bl, dity_of_dvty de.de_dvty
668
    | DEany (bl,_,_,res) ->
669
        List.map (fun (_,_,t) -> t) bl, res
670 671
    | DElet (_,de)
    | DErec (_,de) ->
672
        de.de_dvty
673 674
    | DEnot de ->
        dexpr_expected_type de dity_bool;
675 676 677
        dvty_bool
    | DEand (de1,de2)
    | DEor (de1,de2) ->
678 679
        dexpr_expected_type de1 dity_bool;
        dexpr_expected_type de2 dity_bool;
680
        dvty_bool
681 682 683 684 685
    | DEif (de1,de2,de3) ->
        let res = dity_fresh () in
        dexpr_expected_type de1 dity_bool;
        dexpr_expected_type de2 res;
        dexpr_expected_type de3 res;
686
        [], res
687
    | DEcase (_,[]) ->
Andrei Paskevich's avatar
Andrei Paskevich committed
688
        invalid_arg "Dexpr.dexpr: empty branch list in DEcase"
689 690 691 692
    | DEcase (de,bl) ->
        let ety = dity_fresh () in
        let res = dity_fresh () in
        dexpr_expected_type de ety;
693
        List.iter (fun (dp,de) ->
694
          dpat_expected_type dp ety;
695
          dexpr_expected_type de res) bl;
696
        [], res
697
    | DEassign al ->
698 699 700
        List.iter (fun (de1,rs,de2) ->
          let argl, res = specialize_rs rs in
          let ls = match rs.rs_logic with RLls ls -> ls
701 702 703
            | _ -> invalid_arg "Dexpr.dexpr: not a field" in
          dity_unify_app ls dexpr_expected_type [de1] argl;
          dexpr_expected_type_weak de2 res) al;
704 705
        dvty_unit
    | DEwhile (de1,_,_,de2) ->
706
        dexpr_expected_type de1 dity_bool;
707
        dexpr_expected_type de2 dity_unit;
708
        dvty_unit
709 710 711 712
    | DEfor (_,de_from,_,de_to,_,de) ->
        dexpr_expected_type de_from dity_int;
        dexpr_expected_type de_to dity_int;
        dexpr_expected_type de dity_unit;
713
        dvty_unit
714
    | DEtry (_,[]) ->
Andrei Paskevich's avatar
Andrei Paskevich committed
715
        invalid_arg "Dexpr.dexpr: empty branch list in DEtry"
716 717 718
    | DEtry (de,bl) ->
        let res = dity_fresh () in
        dexpr_expected_type de res;
719 720 721
        List.iter (fun (xs,dp,de) ->
          dpat_expected_type dp (specialize_xs xs);
          dexpr_expected_type de res) bl;
722
        [], res
723 724
    | DEraise (xs,de) ->
        dexpr_expected_type de (specialize_xs xs);
725
        [], dity_fresh ()
726
    | DEghost de ->
727
        de.de_dvty
728
    | DEassert _ ->
729
        dvty_unit
730 731
    | DEpure _
    | DEabsurd ->
732
        [], dity_fresh ()
733 734
    | DEtrue
    | DEfalse ->
735
        dvty_bool
736
    | DEcast (de,ity) ->
737
        dexpr_expected_type de (dity_of_ity ity);
738
        de.de_dvty
739
    | DEmark (_,de)
740 741
    | DEuloc (de,_)
    | DElabel (de,_) ->
742 743 744
        de.de_dvty in
  let dvty = Loc.try1 ?loc get_dvty node in
  { de_node = node; de_dvty = dvty; de_loc = loc }
745 746 747 748 749

(** Final stage *)

(** Binders *)

750
let binders ghost bl =
751
  let sn = ref Sstr.empty in
752
  let binder (id, gh, dity) =
753 754 755 756 757 758 759
    let id = match id with
      | Some ({pre_name = n} as id) ->
          let exn = match id.pre_loc with
            | Some loc -> Loc.Located (loc, Dterm.DuplicateVar n)
            | None -> Dterm.DuplicateVar n in
          sn := Sstr.add_new exn n !sn; id
      | None -> id_fresh "_" in
760
    create_pvsymbol id ~ghost:(ghost || gh) (ity_of_dity dity) in
761 762 763 764 765 766 767 768 769
  List.map binder bl

(** Specifications *)

let to_fmla f = match f.t_ty with
  | None -> f
  | Some ty when ty_equal ty ty_bool -> t_equ f t_bool_true
  | _ -> Loc.error ?loc:f.t_loc Dterm.FmlaExpected

770 771 772 773
let create_assert = to_fmla

let create_invariant pl = List.map to_fmla pl

774 775
let create_post ity ql = List.map (fun (v,f) ->
  ity_equal_check ity v.pv_ity; Ity.create_post v.pv_vs (to_fmla f)) ql
776

777
let create_xpost xql = Mxs.mapi (fun xs ql -> create_post xs.xs_ity ql) xql
778 779 780

(** User effects *)

781 782 783 784 785 786
let rec effect_of_term t =
  let quit () = Loc.errorm ?loc:t.t_loc "unsupported effect expression" in
  match t.t_node with
  | Tapp (fs, [ta]) ->
      let v, ity, fa = effect_of_term ta in
      let ity = match fa with
787
        | Some {rs_cty = {cty_args = [arg]; cty_result = res}} ->
788 789 790
            ity_full_inst (ity_match isb_empty arg.pv_ity ity) res
        | Some _ -> assert false
        | None -> ity in
791
      begin try match ity.ity_node, restore_rs fs with
Andrei Paskevich's avatar
Andrei Paskevich committed
792 793
        | Ityreg {reg_its = ts}, ({rs_field = Some f} as rs)
          when List.exists (pv_equal f) ts.its_mfields -> v, ity, Some rs
794
        | _, {rs_cty={cty_args=[arg]; cty_result=res; cty_freeze=frz}} ->
795 796 797 798 799 800
            v, ity_full_inst (ity_match frz arg.pv_ity ity) res, None
        | _ -> quit () with Not_found -> quit () end
  | Tvar v ->
      let v = try restore_pv v with Not_found -> quit () in
      v, v.pv_ity, None
  | _ -> quit ()
801 802

let effect_of_dspec dsp =
803
  let pvs = Spv.of_list dsp.ds_reads in
804
  let add_write (l,eff) t = match effect_of_term t with
805 806
    | v, {ity_node = Ityreg reg}, fd ->
        let fs = match fd with
807
          | Some fd -> Spv.singleton (Opt.get fd.rs_field)
808
          | None -> Spv.of_list reg.reg_its.its_mfields in
809 810
        if not reg.reg_its.its_private && Spv.is_empty fs then
          Loc.errorm ?loc:t.t_loc "mutable expression expected";
811 812 813
        let rd = Spv.singleton v and wr = Mreg.singleton reg fs in
        let e = Loc.try2 ?loc:t.t_loc eff_write rd wr in
        (e,t)::l, eff_union_par eff e
814
    | _ ->
815
        Loc.errorm ?loc:t.t_loc "mutable expression expected" in
816
  let wl, eff = List.fold_left add_write ([], eff_read pvs) dsp.ds_writes in
817
  let eff = Mxs.fold (fun xs _ eff -> eff_raise eff xs) dsp.ds_xpost eff in
818 819
  let eff = if dsp.ds_diverge then eff_diverge eff else eff in
  wl, eff
820

821 822
(* TODO: add warnings for empty postconditions (anywhere)
    and empty exceptional postconditions (toplevel). *)
823
let check_spec inr dsp ecty ({e_loc = loc} as e) =
Andrei Paskevich's avatar
Andrei Paskevich committed
824
  let bad_read  reff eff = not (Spv.subset reff.eff_reads  eff.eff_reads) in
825
  let bad_write weff eff = not (Mreg.submap (fun _ s1 s2 -> Spv.subset s1 s2)
826 827
                                           weff.eff_writes eff.eff_writes) in
  let bad_raise xeff eff = not (Sxs.subset xeff.eff_raises eff.eff_raises) in
828
  (* computed effect vs user effect *)
829
  let uwrl, ue = effect_of_dspec dsp in
830 831
  let ucty = create_cty ecty.cty_args ecty.cty_pre ecty.cty_post
    ecty.cty_xpost ecty.cty_oldies ue ecty.cty_result in
832
  let ueff = ucty.cty_effect and eeff = ecty.cty_effect in
833 834 835 836 837 838 839 840 841
  let check_ue = not inr and check_rw = dsp.ds_checkrw in
  (* check that every user effect actually happens. We omit this
     for local functions inside recursive functions because if
     they call the parent function, they may have more effects
     than we know at this point: those will only be known after
     we finish constructing the parent function. TODO: make an
     effort to only disable the check for local functions that
     actually call their parent. *)
  if check_ue && bad_read ueff eeff then Loc.errorm ?loc
842
    "variable@ %a@ does@ not@ occur@ in@ this@ expression"
843 844
    Pretty.print_vs (Spv.choose (Spv.diff ueff.eff_reads eeff.eff_reads)).pv_vs;
  if check_ue && bad_write ueff eeff then List.iter (fun (weff,t) ->
845 846
    if bad_write weff eeff then Loc.errorm ?loc:t.t_loc
      "this@ write@ effect@ does@ not@ happen@ in@ the@ expression") uwrl;
847
  if check_ue && bad_raise ueff eeff then Loc.errorm ?loc
848
    "this@ expression@ does@ not@ raise@ exception@ %a"
849
    print_xs (Sxs.choose (Sxs.diff ueff.eff_raises eeff.eff_raises));
850 851
  if check_ue && ueff.eff_oneway && not eeff.eff_oneway then Loc.errorm ?loc
      "this@ expression@ does@ not@ diverge";
852
  (* check that every computed effect is listed *)
853 854 855 856
  if check_rw && bad_read eeff ueff then Loc.errorm ?loc
    "this@ expression@ depends@ on@ variable@ %a,@ \
      which@ is@ left@ out@ in@ the@ specification"
    Pretty.print_vs (Spv.choose (Spv.diff eeff.eff_reads ueff.eff_reads)).pv_vs;
857
  if check_rw && bad_write eeff ueff then
858
    Loc.errorm ?loc:(e_locate_effect (fun eff -> bad_write eff ueff) e)
859
      "this@ expression@ produces@ an@ unlisted@ write@ effect";
860 861
  if ecty.cty_args <> [] && bad_raise eeff ueff then Sxs.iter (fun xs ->
    Loc.errorm ?loc:(e_locate_effect (fun eff -> Sxs.mem xs eff.eff_raises) e)
862
      "this@ expression@ raises@ unlisted@ exception@ %a"
863
      print_xs xs) (Sxs.diff eeff.eff_raises ueff.eff_raises);
864
  if eeff.eff_oneway && not ueff.eff_oneway then
865
    Loc.errorm ?loc:(e_locate_effect (fun eff -> eff.eff_oneway) e)
866 867
      "this@ expression@ may@ diverge,@ but@ this@ is@ not@ \
        stated@ in@ the@ specification"
868

Andrei Paskevich's avatar
Andrei Paskevich committed
869
let check_aliases recu c =
870 871 872
  let rds_regs = c.cty_freeze.isb_reg in
  let report r _ _ =
    if Mreg.mem r rds_regs then let spv = Spv.filter
873
        (fun v -> ity_r_occurs r v.pv_ity) (cty_reads c) in
874
      Loc.errorm "The type of this function contains an alias with \
875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891
        external variable %a" print_pv (Spv.choose spv)
    else Loc.errorm "The type of this function contains an alias" in
  (* we allow the value in a non-recursive function to contain
     regions coming the function's arguments, but not from the
     context. It is sometimes useful to write a function around
     a constructor or a projection. For recursive functions, we
     impose the full non-alias discipline, to ensure the safety
     of region polymorphism (see add_rec_mono). We do not track
     aliases inside the type of an argument or a result, which
     may break the type inference, but we have a safety net
     type checking in Expr. *)
  let add_ity regs ity =
    let frz = ity_freeze isb_empty ity in
    Mreg.union report regs frz.isb_reg in
  let add_arg regs v = add_ity regs v.pv_ity in
  let regs = List.fold_left add_arg rds_regs c.cty_args in
  ignore (add_ity (if recu then regs else rds_regs) c.cty_result)
892

893
let check_fun inr rsym dsp e =
Andrei Paskevich's avatar
Andrei Paskevich committed
894
  let c,e = match e with
895
    | { c_node = Cfun e; c_cty = c } -> c,e
Andrei Paskevich's avatar
Andrei Paskevich committed
896 897 898 899
    | _ -> invalid_arg "Dexpr.check_fun" in
  let c = match rsym with
    | Some s -> s.rs_cty
    | None -> c in
900
  check_spec inr dsp c e;
Andrei Paskevich's avatar
Andrei Paskevich committed
901 902
  check_aliases (rsym <> None) c

903 904
(** Environment *)

Andrei Paskevich's avatar
Andrei Paskevich committed
905
type env = {
906
  rsm : rsymbol Mstr.t;
907
  pvm : pvsymbol Mstr.t;
908
  old : (pvsymbol Mstr.t * (let_defn * pvsymbol) Hpv.t) Mstr.t;
909
  ghs : bool; (* we are under DEghost or in a ghost function *)
910
  lgh : bool; (* we are under let ghost c = <cexp> *)
911
  cgh : bool; (* we are under DEghost in a cexp *)
912
  inr : bool; (* we are inside a recursive function *)
913 914
}

915
let env_empty = {
916
  rsm = Mstr.empty;
917
  pvm = Mstr.empty;
918
  old = Mstr.empty;
919 920 921
  ghs = false;
  lgh = false;
  cgh = false;
922
  inr = false;
923 924
}

925 926