package dolmen_type

  1. Overview
  2. Docs

Source file bitv.ml

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

module Id = Dolmen.Std.Id

(* Ae Bitvector *)
(* ************************************************************************ *)

module Ae = struct

  module Tff
      (Type : Tff_intf.S)
      (Ty : Dolmen.Intf.Ty.Ae_Bitv with type t := Type.Ty.t)
      (T : Dolmen.Intf.Term.Ae_Bitv with type t := Type.T.t) = struct

    type _ Type.err +=
      | Invalid_bin_char : char -> Dolmen.Std.Term.t Type.err
      | Expected_nat_lit : Dolmen.Std.Term.t -> Dolmen.Std.Term.t Type.err

    let parse_binary env s ast =
      match String.iter Misc.Bitv.check_bin s with
      | () -> T.mk s
      | exception Misc.Bitv.Invalid_char c ->
        Type._error env (Ast ast) (Invalid_bin_char c)

    let int_of_term env ast a =
      match a.Dolmen_std.Term.term with
      | Symbol { ns = Value Integer; name = Simple name; } ->
        (* the namespace guarantees that the `name` is an integer literal
           therefore `int_of_string` should not raise an exception *)
        let i = int_of_string name in
        if i >= 0 then i else
          Type._error env (Ast ast) (Expected_nat_lit a)
      | _ ->
        Type._error env (Ast ast) (Expected_nat_lit a)

    let app_int_term env symbol mk =
      Base.make_op2 (module Type) env symbol
        (fun ast (a, b) ->
           mk (int_of_term env ast a) (Type.parse_term env b))

    let parse env s =
      match s with

      (* Bitvector sort *)
      | Type.Builtin (Bitv n) ->
        Type.builtin_ty (Base.app0 (module Type) env s (Ty.bitv n))

      (* Bitvector litterals *)
      | Type.Id { ns = Value Bitvector; name = Simple name; } ->
        Type.builtin_term (Base.app0_ast (module Type) env s (parse_binary env name))

      (* Bitvector operators *)
      | Type.Builtin Bitv_concat ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.concat)
      | Type.Builtin (Bitv_extract (l, r)) ->
        Type.builtin_term (Base.term_app1 (module Type) env s (T.extract r l))

      (* terms *)
      | Type.Id { ns = Term; name = Simple "repeat"; } ->
        Type.builtin_term (app_int_term env s T.repeat)
      | Type.Id { ns = Term; name = Simple "zero_extend"; } ->
        Type.builtin_term (app_int_term env s T.zero_extend)
      | Type.Id { ns = Term; name = Simple "sign_extend"; } ->
        Type.builtin_term (app_int_term env s T.sign_extend)
      | Type.Id { ns = Term; name = Simple "rotate_right"; } ->
        Type.builtin_term (app_int_term env s T.rotate_right)
      | Type.Id { ns = Term; name = Simple "rotate_left"; } ->
        Type.builtin_term (app_int_term env s T.rotate_left)

      | Type.Id { ns = Term; name = Simple "bvnot"; } ->
        Type.builtin_term (Base.term_app1 (module Type) env s T.not)
      | Type.Id { ns = Term; name = Simple "bvand"; } ->
        Type.builtin_term (Base.term_app_left (module Type) env s T.and_)
      | Type.Id { ns = Term; name = Simple "bvor"; } ->
        Type.builtin_term (Base.term_app_left (module Type) env s T.or_)
      | Type.Id { ns = Term; name = Simple "bvnand"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.nand)
      | Type.Id { ns = Term; name = Simple "bvnor"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.nor)
      | Type.Id { ns = Term; name = Simple "bvxor"; } ->
        Type.builtin_term (Base.term_app_left (module Type) env s T.xor)
      | Type.Id { ns = Term; name = Simple "bvxnor"; } ->
        Type.builtin_term (Base.term_app_left (module Type) env s T.xnor)

      | Type.Id { ns = Term; name = Simple "bvcomp"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.comp)

      | Type.Id { ns = Term; name = Simple "bvneg"; } ->
        Type.builtin_term (Base.term_app1 (module Type) env s T.neg)
      | Type.Id { ns = Term; name = Simple "bvadd"; } ->
        Type.builtin_term (Base.term_app_left (module Type) env s T.add)
      | Type.Id { ns = Term; name = Simple "bvsub"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.sub)
      | Type.Id { ns = Term; name = Simple "bvmul"; } ->
        Type.builtin_term (Base.term_app_left (module Type) env s T.mul)

      | Type.Id { ns = Term; name = Simple "bvudiv"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.udiv)
      | Type.Id { ns = Term; name = Simple "bvurem"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.urem)

      | Type.Id { ns = Term; name = Simple "bvsdiv"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.sdiv)
      | Type.Id { ns = Term; name = Simple "bvsrem"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.srem)
      | Type.Id { ns = Term; name = Simple "bvsmod"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.smod)

      | Type.Id { ns = Term; name = Simple "bvshl"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.shl)
      | Type.Id { ns = Term; name = Simple "bvlshr"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.lshr)
      | Type.Id { ns = Term; name = Simple "bvashr"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.ashr)

      | Type.Id { ns = Term; name = Simple "bvult"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.ult)
      | Type.Id { ns = Term; name = Simple "bvule"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.ule)
      | Type.Id { ns = Term; name = Simple "bvugt"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.ugt)
      | Type.Id { ns = Term; name = Simple "bvuge"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.uge)

      | Type.Id { ns = Term; name = Simple "bvslt"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.slt)
      | Type.Id { ns = Term; name = Simple "bvsle"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.sle)
      | Type.Id { ns = Term; name = Simple "bvsgt"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.sgt)
      | Type.Id { ns = Term; name = Simple "bvsge"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.sge)

      | _ -> `Not_found

  end
end

(* Smtlib Bitvector *)
(* ************************************************************************ *)

module Smtlib2 = struct

  module Tff
      (Type : Tff_intf.S)
      (Ty : Dolmen.Intf.Ty.Smtlib_Bitv with type t := Type.Ty.t)
      (T : Dolmen.Intf.Term.Smtlib_Bitv with type t := Type.T.t) = struct

    type _ Type.err +=
      | Non_positive_bitvector_size : int -> Dolmen.Std.Term.t Type.err
      | Invalid_extract : int * int * int -> Dolmen.Std.Term.t Type.err
      | Invalid_bin_char : char -> Dolmen.Std.Term.t Type.err
      | Invalid_hex_char : char -> Dolmen.Std.Term.t Type.err
      | Invalid_dec_char : char -> Dolmen.Std.Term.t Type.err

    let parse_int env ast s =
      try int_of_string s
      with Failure _ ->
        Type._error env (Ast ast)
          (Type.Expected ("an index that is an integer", None))

    let parse_positive_int env ast s =
      let i = parse_int env ast s in
      if i > 0 then i
      else Type._error env (Ast ast)
          (Type.Expected ("an index that is a positive integer", None))

    let parse_nonnegative_int env ast s =
      let i = parse_int env ast s in
      if i >= 0 then i
      else Type._error env (Ast ast)
          (Type.Expected ("an index that is a non-negative integer", None))

    let parse_bitv_size env ast s =
      let i = parse_int env ast s in
      if i > 0 then i
      else Type._error env (Ast ast) (Non_positive_bitvector_size i)

    let parse_binary env s ast =
      match Misc.Bitv.parse_binary s with
      | s ->
        if String.length s > 0 then T.mk s
        else begin
          Type._error env (Ast ast)
            (Type.Expected ("a non-empty bitvector (in binary form)", None))
        end
      | exception Misc.Bitv.Invalid_char c ->
        Type._error env (Ast ast) (Invalid_bin_char c)

    let parse_hexa env s ast =
      match Misc.Bitv.parse_hexa s with
      | s ->
        if String.length s > 0 then T.mk s
        else begin
          Type._error env (Ast ast)
            (Type.Expected ("a non-empty bitvector (in hexadecimal form)", None))
        end
      | exception Misc.Bitv.Invalid_char c ->
        Type._error env (Ast ast) (Invalid_hex_char c)

    let parse_extended_lit env symbol s n =
      Base.make_op0 (module Type) env symbol (fun ast () ->
          assert (String.length s >= 2);
          let n = parse_bitv_size env ast n in
          match Misc.Bitv.parse_decimal s n with
          | s ->
            if String.length s > 0 then T.mk s
            else begin
              Type._error env (Ast ast)
                (Type.Expected ("a non-empty bitvector (in decimal form)", None))
            end
          | exception Misc.Bitv.Invalid_char c ->
            Type._error env (Ast ast) (Invalid_dec_char c)
        )

    let indexed_positive env mk i_s ast =
      let i = parse_positive_int env ast i_s in
      mk i

    let indexed_nonnegative env mk i_s ast =
      let i = parse_nonnegative_int env ast i_s in
      mk i

    let indexed_extract env i_s j_s ast bitv =
      let i = parse_nonnegative_int env ast i_s in
      let j = parse_nonnegative_int env ast j_s in
      match Ty.view (Type.T.ty bitv) with
      | `Bitv m ->
        if j <= i && i < m then
          T.extract i j bitv
        else
          Type._error env (Ast ast) (Invalid_extract (i, j, m))
      | _ -> T.extract i j bitv

    let parse _version env s =
      match s with

      (* Bitvector sort *)
      | Type.Id { Id.ns = Sort; name = Indexed { basename; indexes; }; } as symbol ->
        Base.parse_indexed basename indexes (function
            | "BitVec" -> `Unary (function n_s ->
                Type.builtin_ty (Base.app0_ast (module Type) env symbol (fun ast ->
                    Ty.bitv (parse_bitv_size env ast n_s))))
            | _ -> `Not_indexed
          ) ~k:(fun _ -> `Not_found)
          ~err:(Base.bad_ty_index_arity (module Type) env)

      (* Bitvector litterals *)
      | Type.Id { ns = Value Binary; name = Simple name; } ->
        Type.builtin_term (Base.app0_ast (module Type) env s (parse_binary env name))
      | Type.Id { ns = Value Hexadecimal; name = Simple name; } ->
        Type.builtin_term (Base.app0_ast (module Type) env s (parse_hexa env name))

      (* terms *)
      | Type.Id { ns = Term; name = Simple "bvnot"; } ->
        Type.builtin_term (Base.term_app1 (module Type) env s T.not)
      | Type.Id { ns = Term; name = Simple "bvand"; } ->
        Type.builtin_term (Base.term_app_left (module Type) env s T.and_)
      | Type.Id { ns = Term; name = Simple "bvor"; } ->
        Type.builtin_term (Base.term_app_left (module Type) env s T.or_)
      | Type.Id { ns = Term; name = Simple "bvnand"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.nand)
      | Type.Id { ns = Term; name = Simple "bvnor"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.nor)
      | Type.Id { ns = Term; name = Simple "bvxor"; } ->
        Type.builtin_term (Base.term_app_left (module Type) env s T.xor)
      | Type.Id { ns = Term; name = Simple "bvxnor"; } ->
        Type.builtin_term (Base.term_app_left (module Type) env s T.xnor)

      | Type.Id { ns = Term; name = Simple "bvcomp"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.comp)

      | Type.Id { ns = Term; name = Simple "bvneg"; } ->
        Type.builtin_term (Base.term_app1 (module Type) env s T.neg)
      | Type.Id { ns = Term; name = Simple "bvadd"; } ->
        Type.builtin_term (Base.term_app_left (module Type) env s T.add)
      | Type.Id { ns = Term; name = Simple "bvsub"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.sub)
      | Type.Id { ns = Term; name = Simple "bvmul"; } ->
        Type.builtin_term (Base.term_app_left (module Type) env s T.mul)

      | Type.Id { ns = Term; name = Simple "bvudiv"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.udiv)
      | Type.Id { ns = Term; name = Simple "bvurem"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.urem)

      | Type.Id { ns = Term; name = Simple "bvsdiv"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.sdiv)
      | Type.Id { ns = Term; name = Simple "bvsrem"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.srem)
      | Type.Id { ns = Term; name = Simple "bvsmod"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.smod)

      | Type.Id { ns = Term; name = Simple "bvshl"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.shl)
      | Type.Id { ns = Term; name = Simple "bvlshr"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.lshr)
      | Type.Id { ns = Term; name = Simple "bvashr"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.ashr)

      | Type.Id { ns = Term; name = Simple "bvult"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.ult)
      | Type.Id { ns = Term; name = Simple "bvule"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.ule)
      | Type.Id { ns = Term; name = Simple "bvugt"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.ugt)
      | Type.Id { ns = Term; name = Simple "bvuge"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.uge)

      | Type.Id { ns = Term; name = Simple "bvslt"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.slt)
      | Type.Id { ns = Term; name = Simple "bvsle"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.sle)
      | Type.Id { ns = Term; name = Simple "bvsgt"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.sgt)
      | Type.Id { ns = Term; name = Simple "bvsge"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.sge)

      | Type.Id { ns = Term; name = Simple "concat"; } ->
        Type.builtin_term (Base.term_app2 (module Type) env s T.concat)

      (* indexed terms *)
      | Type.Id { ns = Term; name = Indexed { basename; indexes; } } as symbol ->
        Base.parse_indexed basename indexes (function
            | s when (String.length s >= 2 && s.[0] = 'b' && s.[1] = 'v') ->
              `Unary (fun n -> Type.builtin_term (parse_extended_lit env symbol s n))
            | "repeat" -> `Unary (function i_s ->
                Type.builtin_term (Base.term_app1_ast (module Type) env symbol
                         (indexed_positive env T.repeat i_s)))
            | "zero_extend" -> `Unary (function i_s ->
                Type.builtin_term (Base.term_app1_ast (module Type) env symbol
                         (indexed_nonnegative env T.zero_extend i_s)))
            | "sign_extend" -> `Unary (function i_s ->
                Type.builtin_term (Base.term_app1_ast (module Type) env symbol
                         (indexed_nonnegative env T.sign_extend i_s)))
            | "rotate_right" -> `Unary (function i_s ->
                Type.builtin_term (Base.term_app1_ast (module Type) env symbol
                         (indexed_nonnegative env T.rotate_right i_s)))
            | "rotate_left" -> `Unary (function i_s ->
                Type.builtin_term (Base.term_app1_ast (module Type) env symbol
                         (indexed_nonnegative env T.rotate_left i_s)))
            | "extract" -> `Binary (fun i_s j_s ->
                Type.builtin_term (Base.term_app1_ast (module Type) env symbol
                         (indexed_extract env i_s j_s)))
            | _ -> `Not_indexed)
          ~err:(Base.bad_term_index_arity (module Type) env)
          ~k:(function () -> `Not_found)

      | _ -> `Not_found

  end

  module Bvconv
      (Type : Tff_intf.S)
      (Ty : Dolmen_intf.Ty.Smtlib_Bitv with type t := Type.Ty.t)
      (T : Dolmen.Intf.Term.Smtlib_Bvconv with type t := Type.T.t) = struct

    (* TODO: factorize these definitions with those from the Tff functor *)
    let parse_int env ast s =
      try int_of_string s
      with Failure _ ->
        Type._error env (Ast ast)
          (Type.Expected ("an index that is an integer", None))

    let parse_positive_int env ast s =
      let i = parse_int env ast s in
      if i > 0 then i
      else Type._error env (Ast ast)
          (Type.Expected ("an index that is a positive integer", None))

    let indexed_positive env mk i_s ast =
      let i = parse_positive_int env ast i_s in
      mk i

    let parse _version env s =
      match s with
      | Type.Id { ns = Term; name = Simple "bv2nat"; } ->
        Type.builtin_term (Base.term_app1 (module Type) env s T.to_nat)
      | Type.Id { ns = Term; name = Indexed { basename; indexes; } } as symbol ->
        Base.parse_indexed basename indexes (function
            | "int2bv" -> `Unary (fun i_s ->
                Type.builtin_term (Base.term_app1_ast (module Type) env symbol
                                     (indexed_positive env T.of_int i_s)))
            | _ -> `Not_indexed)
          ~err:(Base.bad_term_index_arity (module Type) env)
          ~k:(function () -> `Not_found)
      | _ -> `Not_found

  end

end