1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
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
179
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
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
280
281
282
283
284
285
286
287
288
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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
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
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
|
open Identifiers
open Types
(** TODO: do we put the type variable/variable/region names everywhere
(to not have to perform lookups by using the ids?)
No: it is good not to duplicate and to use ids. This allows to split/
make very explicit the role of variables/identifiers/binders/etc.
*)
module VarId = IdGen ()
module BorrowId = IdGen ()
module SymbolicValueId = IdGen ()
module AbstractionId = IdGen ()
module RegionId = IdGen ()
(** A variable *)
type big_int = Z.t
let big_int_of_yojson (json : Yojson.Safe.t) : (big_int, string) result =
match json with
| `Int i -> Ok (Z.of_int i)
| `Intlit is -> Ok (Z.of_string is)
| _ -> Error "not an integer or an integer literal"
let big_int_to_yojson (i : big_int) = `Intlit (Z.to_string i)
let pp_big_int (fmt : Format.formatter) (bi : big_int) : unit =
Format.pp_print_string fmt (Z.to_string bi)
let show_big_int (bi : big_int) : string = Z.to_string bi
type scalar_value = { value : big_int; int_ty : integer_type } [@@deriving show]
(** A scalar value
Note that we use unbounded integers everywhere.
We then harcode the boundaries for the different types.
*)
(** A constant value *)
type constant_value =
| Scalar of scalar_value
| Bool of bool
| Char of char
| String of string
[@@deriving show]
type symbolic_value = { sv_id : SymbolicValueId.id; sv_ty : rty }
[@@deriving show]
(** Symbolic value *)
type symbolic_proj_comp = {
svalue : symbolic_value; (** The symbolic value itself *)
rset_ended : RegionId.set_t;
(** The regions used in the symbolic value which have already ended *)
}
[@@deriving show]
(** A complementary projector over a symbolic value.
"Complementary" stands for the fact that it is a projector over all the
regions *but* the ones which are listed in the projector.
*)
(** Polymorphic iter visitor *)
class virtual ['self] iter_'r_ty_base =
object (self : 'self)
method visit_ty : 'env 'r. ('env -> 'r -> unit) -> 'env -> 'r ty -> unit =
fun _visit_'r _env _ty -> ()
end
(** Polymorphic map visitor *)
class virtual ['self] map_'r_ty_base =
object (self : 'self)
method visit_ty
: 'env 'r_0 'r_1. ('env -> 'r_0 -> 'r_1) -> 'env -> 'r_0 ty -> 'r_1 ty =
fun _visit_'r _env ty ->
(* We should use a ty visitor, but in practice we don't need to
* visit types, and for the non-generic visit methods (which will
* preserve 'r_0) we will override this method with identity *)
raise Errors.Unimplemented
end
(** A generic, untyped value, used in the environments.
Parameterized by:
- 'ty: type
- 'sv: symbolic value
- 'bc: borrow content
- 'lc: loan content
Can be specialized for "regular" values or values in abstractions *)
type ('r, 'sv, 'bc, 'lc) g_value =
| Concrete of (constant_value[@opaque]) (** Concrete (non-symbolic) value *)
| Adt of ('r, 'sv, 'bc, 'lc) g_adt_value
(** Enumerations, structures, tuples, assumed types. Note that units
are encoded as 0-tuples *)
| Bottom (** No value (uninitialized or moved value) *)
| Borrow of 'bc (** A borrowed value *)
| Loan of 'lc (** A loaned value *)
| Symbolic of 'sv (** Unknown value *)
and ('r, 'sv, 'bc, 'lc) g_adt_value = {
variant_id : VariantId.id option; [@opaque]
field_values : ('r, 'sv, 'bc, 'lc) g_typed_value list;
}
(** "Generic" ADT value (not "GADT" value) *)
and ('r, 'sv, 'bc, 'lc) g_typed_value = {
value : ('r, 'sv, 'bc, 'lc) g_value;
ty : 'r ty;
}
[@@deriving
show,
visitors
{
name = "iter_g_typed_value";
variety = "iter";
ancestors = [ "iter_'r_ty_base" ];
polymorphic = true;
(* Heirs expect a polymorphic class *)
concrete = true;
},
visitors
{
name = "map_g_typed_value";
variety = "map";
ancestors = [ "map_'r_ty_base" ];
polymorphic = true;
(* Heirs expect a polymorphic class *)
concrete = true;
}]
(*class ['self] map_g_typed_value =
object (self : 'self)
inherit [_] VisitorsRuntime.map
inherit [_] map_'r_ty_base
method visit_Concrete
: 'env 'r_0 'r_1 'sv_0 'sv_1 'bc_0 'bc_1 'lc_0 'lc_1.
('env -> 'r_0 -> 'r_1) ->
('env -> 'sv_0 -> 'sv_1) ->
('env -> 'bc_0 -> 'bc_1) ->
('env -> 'lc_0 -> 'lc_1) ->
'env ->
_ ->
('r_1, 'sv_1, 'bc_1, 'lc_1) g_value =
fun visit_'r visit_'sv visit_'bc visit_'lc env _visitors_c0 ->
let _visitors_r0 =
(fun _visitors_this -> _visitors_this) _visitors_c0
in
Concrete _visitors_r0
method visit_Adt
: 'env 'r_0 'r_1 'sv_0 'sv_1 'bc_0 'bc_1 'lc_0 'lc_1.
('env -> 'r_0 -> 'r_1) ->
('env -> 'sv_0 -> 'sv_1) ->
('env -> 'bc_0 -> 'bc_1) ->
('env -> 'lc_0 -> 'lc_1) ->
'env ->
('r_0, 'sv_0, 'bc_0, 'lc_0) g_adt_value ->
('r_1, 'sv_1, 'bc_1, 'lc_1) g_value =
fun visit_'r visit_'sv visit_'bc visit_'lc env _visitors_c0 ->
let _visitors_r0 =
self#visit_g_adt_value visit_'r visit_'sv visit_'bc visit_'lc env
_visitors_c0
in
Adt _visitors_r0
method visit_Bottom
: 'env 'r_0 'r_1 'sv_0 'sv_1 'bc_0 'bc_1 'lc_0 'lc_1.
('env -> 'r_0 -> 'r_1) ->
('env -> 'sv_0 -> 'sv_1) ->
('env -> 'bc_0 -> 'bc_1) ->
('env -> 'lc_0 -> 'lc_1) ->
'env ->
('r_1, 'sv_1, 'bc_1, 'lc_1) g_value =
fun visit_'r visit_'sv visit_'bc visit_'lc env -> Bottom
method visit_Borrow
: 'env 'r_0 'r_1 'sv_0 'sv_1 'bc_0 'bc_1 'lc_0 'lc_1.
('env -> 'r_0 -> 'r_1) ->
('env -> 'sv_0 -> 'sv_1) ->
('env -> 'bc_0 -> 'bc_1) ->
('env -> 'lc_0 -> 'lc_1) ->
'env ->
'bc_0 ->
('r_1, 'sv_1, 'bc_1, 'lc_1) g_value =
fun visit_'r visit_'sv visit_'bc visit_'lc env _visitors_c0 ->
let _visitors_r0 = visit_'bc env _visitors_c0 in
Borrow _visitors_r0
method visit_Loan
: 'env 'r_0 'r_1 'sv_0 'sv_1 'bc_0 'bc_1 'lc_0 'lc_1.
('env -> 'r_0 -> 'r_1) ->
('env -> 'sv_0 -> 'sv_1) ->
('env -> 'bc_0 -> 'bc_1) ->
('env -> 'lc_0 -> 'lc_1) ->
'env ->
'lc_0 ->
('r_1, 'sv_1, 'bc_1, 'lc_1) g_value =
fun visit_'r visit_'sv visit_'bc visit_'lc env _visitors_c0 ->
let _visitors_r0 = visit_'lc env _visitors_c0 in
Loan _visitors_r0
method visit_Symbolic
: 'env 'r_0 'r_1 'sv_0 'sv_1 'bc_0 'bc_1 'lc_0 'lc_1.
('env -> 'r_0 -> 'r_1) ->
('env -> 'sv_0 -> 'sv_1) ->
('env -> 'bc_0 -> 'bc_1) ->
('env -> 'lc_0 -> 'lc_1) ->
'env ->
'sv_0 ->
('r_1, 'sv_1, 'bc_1, 'lc_1) g_value =
fun visit_'r visit_'sv visit_'bc visit_'lc env _visitors_c0 ->
let _visitors_r0 = visit_'sv env _visitors_c0 in
Symbolic _visitors_r0
method visit_g_value
: 'env 'r_0 'r_1 'sv_0 'sv_1 'bc_0 'bc_1 'lc_0 'lc_1.
('env -> 'r_0 -> 'r_1) ->
('env -> 'sv_0 -> 'sv_1) ->
('env -> 'bc_0 -> 'bc_1) ->
('env -> 'lc_0 -> 'lc_1) ->
'env ->
('r_0, 'sv_0, 'bc_0, 'lc_0) g_value ->
('r_1, 'sv_1, 'bc_1, 'lc_1) g_value =
fun visit_'r visit_'sv visit_'bc visit_'lc env _visitors_this ->
match _visitors_this with
| Concrete _visitors_c0 ->
self#visit_Concrete visit_'r visit_'sv visit_'bc visit_'lc env
_visitors_c0
| Adt _visitors_c0 ->
self#visit_Adt visit_'r visit_'sv visit_'bc visit_'lc env
_visitors_c0
| Bottom -> self#visit_Bottom visit_'r visit_'sv visit_'bc visit_'lc env
| Borrow _visitors_c0 ->
self#visit_Borrow visit_'r visit_'sv visit_'bc visit_'lc env
_visitors_c0
| Loan _visitors_c0 ->
self#visit_Loan visit_'r visit_'sv visit_'bc visit_'lc env
_visitors_c0
| Symbolic _visitors_c0 ->
self#visit_Symbolic visit_'r visit_'sv visit_'bc visit_'lc env
_visitors_c0
method visit_g_adt_value
: 'env 'r_0 'r_1 'sv_0 'sv_1 'bc_0 'bc_1 'lc_0 'lc_1.
('env -> 'r_0 -> 'r_1) ->
('env -> 'sv_0 -> 'sv_1) ->
('env -> 'bc_0 -> 'bc_1) ->
('env -> 'lc_0 -> 'lc_1) ->
'env ->
('r_0, 'sv_0, 'bc_0, 'lc_0) g_adt_value ->
('r_1, 'sv_1, 'bc_1, 'lc_1) g_adt_value =
fun visit_'r visit_'sv visit_'bc visit_'lc env _visitors_this ->
let _visitors_r0 =
(fun _visitors_this -> _visitors_this) _visitors_this.variant_id
in
let _visitors_r1 =
self#visit_list
(self#visit_g_typed_value visit_'r visit_'sv visit_'bc visit_'lc)
env _visitors_this.field_values
in
{ variant_id = _visitors_r0; field_values = _visitors_r1 }
method visit_g_typed_value
: 'env 'r_0 'r_1 'sv_0 'sv_1 'bc_0 'bc_1 'lc_0 'lc_1.
('env -> 'r_0 -> 'r_1) ->
('env -> 'sv_0 -> 'sv_1) ->
('env -> 'bc_0 -> 'bc_1) ->
('env -> 'lc_0 -> 'lc_1) ->
'env ->
('r_0, 'sv_0, 'bc_0, 'lc_0) g_typed_value ->
('r_1, 'sv_1, 'bc_1, 'lc_1) g_typed_value =
fun visit_'r visit_'sv visit_'bc visit_'lc env _visitors_this ->
let _visitors_r0 =
self#visit_g_value visit_'r visit_'sv visit_'bc visit_'lc env
_visitors_this.value
in
let _visitors_r1 = self#visit_ty visit_'r env _visitors_this.ty in
{ value = _visitors_r0; ty = _visitors_r1 }
end*)
class ['self] iter_typed_value_base =
object (self : 'self)
inherit [_] iter_g_typed_value
method visit_erased_region : 'env. 'env -> erased_region -> unit =
fun _env _ -> ()
method visit_symbolic_proj_comp : 'env. 'env -> symbolic_proj_comp -> unit =
fun _env _ -> ()
end
class ['self] map_typed_value_base =
object (self : 'self)
inherit [_] map_g_typed_value
method visit_erased_region : 'env. 'env -> erased_region -> erased_region =
fun _env r -> r
method visit_symbolic_proj_comp
: 'env. 'env -> symbolic_proj_comp -> symbolic_proj_comp =
fun _env pc -> pc
end
type value =
(erased_region, symbolic_proj_comp, borrow_content, loan_content) g_value
(** "Regular" value *)
and adt_value =
(erased_region, symbolic_proj_comp, borrow_content, loan_content) g_adt_value
and borrow_content =
| SharedBorrow of (BorrowId.id[@opaque]) (** A shared value *)
| MutBorrow of (BorrowId.id[@opaque]) * typed_value
(** A mutably borrowed value *)
| InactivatedMutBorrow of (BorrowId.id[@opaque])
(** An inactivated mut borrow.
This is used to model two-phase borrows. When evaluating a two-phase
mutable borrow, we first introduce an inactivated borrow which behaves
like a shared borrow, until the moment we actually *use* the borrow:
at this point, we end all the other shared borrows (or inactivated borrows
- though there shouldn't be any other inactivated borrows if the program
is well typed) of this value and replace the inactivated borrow with a
mutable borrow.
*)
and loan_content =
| SharedLoan of (BorrowId.set_t[@opaque]) * typed_value
| MutLoan of (BorrowId.id[@opaque])
and typed_value =
( erased_region,
symbolic_proj_comp,
borrow_content,
loan_content )
g_typed_value
[@@deriving
show,
visitors
{
name = "iter_typed_value";
variety = "iter";
ancestors = [ "iter_typed_value_base" ];
nude = true (* Don't inherit [VisitorsRuntime.iter] *);
concrete = true;
},
visitors
{
name = "map_typed_value_incomplete";
variety = "map";
ancestors = [ "map_typed_value_base" ];
nude = true (* Don't inherit [VisitorsRuntime.iter] *);
concrete = true;
}]
(** "Regular" typed value (we map variables to typed values) *)
(** Override some undefined functions *)
class ['self] map_typed_value =
object (self : 'self)
inherit [_] map_typed_value_incomplete as super
method! visit_typed_value (env : 'env) (tv : typed_value) : typed_value =
let value = super#visit_value env tv.value in
(* Ignore the type *)
let ty = tv.ty in
{ value; ty }
end
type abstract_shared_borrows =
| AsbSet of BorrowId.set_t
| AsbProjReborrows of symbolic_value * rty
| AsbUnion of abstract_shared_borrows * abstract_shared_borrows
(** TODO: explanations *)
[@@deriving show]
type aproj =
| AProjLoans of symbolic_value
| AProjBorrows of symbolic_value * rty
[@@deriving show]
type region = RegionVarId.id Types.region [@@deriving show]
class ['self] iter_typed_avalue_base =
object (self : 'self)
inherit [_] iter_g_typed_value
method visit_region : 'env. 'env -> region -> unit = fun _env _r -> ()
method visit_aproj : 'env. 'env -> aproj -> unit = fun env _ -> ()
method visit_typed_value : 'env. 'env -> typed_value -> unit =
fun _env _v -> ()
method visit_abstract_shared_borrows
: 'env. 'env -> abstract_shared_borrows -> unit =
fun _env _asb -> ()
end
class ['self] map_typed_avalue_base =
object (self : 'self)
inherit [_] map_g_typed_value
method visit_region : 'env. 'env -> region -> region = fun _env r -> r
method visit_aproj : 'env. 'env -> aproj -> aproj = fun env p -> p
method visit_typed_value : 'env. 'env -> typed_value -> typed_value =
fun _env v -> v
method visit_abstract_shared_borrows
: 'env. 'env -> abstract_shared_borrows -> abstract_shared_borrows =
fun _env asb -> asb
end
type avalue = (region, aproj, aborrow_content, aloan_content) g_value
(** Abstraction values are used inside of abstractions to properly model
borrowing relations introduced by function calls.
When calling a function, we lose information about the borrow graph:
part of it is thus "abstracted" away.
*)
and aadt_value = (region, aproj, aborrow_content, aloan_content) g_adt_value
and aloan_content =
| AMutLoan of (BorrowId.id[@opaque]) * typed_avalue
| ASharedLoan of (BorrowId.set_t[@opaque]) * typed_value * typed_avalue
| AEndedMutLoan of { given_back : typed_value; child : typed_avalue }
| AEndedSharedLoan of typed_value * typed_avalue
| AIgnoredMutLoan of (BorrowId.id[@opaque]) * typed_avalue
| AIgnoredSharedLoan of abstract_shared_borrows
(** Note that when a borrow content is ended, it is replaced by Bottom (while
we need to track ended loans more precisely, especially because of their
children values) *)
and aborrow_content =
| AMutBorrow of (BorrowId.id[@opaque]) * typed_avalue
| ASharedBorrow of (BorrowId.id[@opaque])
| AIgnoredMutBorrow of typed_avalue
| AEndedIgnoredMutLoan of { given_back : typed_avalue; child : typed_avalue }
| AIgnoredSharedBorrow of abstract_shared_borrows
and typed_avalue = (region, aproj, aborrow_content, aloan_content) g_typed_value
[@@deriving
show,
visitors
{
name = "iter_typed_avalue";
variety = "iter";
ancestors = [ "iter_typed_avalue_base" ];
nude = true (* Don't inherit [VisitorsRuntime.iter] *);
concrete = true;
},
visitors
{
name = "map_typed_avalue_incomplete";
variety = "map";
ancestors = [ "map_typed_avalue_base" ];
nude = true (* Don't inherit [VisitorsRuntime.iter] *);
concrete = true;
}]
(** Override some undefined functions *)
class ['self] map_typed_avalue =
object (self : 'self)
inherit [_] map_typed_avalue_incomplete as super
method! visit_typed_avalue (env : 'env) (tv : typed_avalue) : typed_avalue =
let value = super#visit_avalue env tv.value in
(* Ignore the type *)
let ty = tv.ty in
{ value; ty }
end
type abs = {
abs_id : AbstractionId.id;
parents : AbstractionId.set_t; (** The parent abstractions *)
acc_regions : RegionId.set_t;
(** Union of the regions owned by the (transitive) parent abstractions and
by the current abstraction *)
regions : RegionId.set_t; (** Regions owned by this abstraction *)
avalues : typed_avalue list; (** The values in this abstraction *)
}
[@@deriving show]
(** Abstractions model the parts in the borrow graph where the borrowing relations
have been abstracted because of a function call.
In order to model the relations between the borrows, we use "abstraction values",
which are a special kind of value.
*)
|