package mopsa

  1. Overview
  2. Docs
package mopsa
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Source file partial_map.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
(****************************************************************************)
(*                                                                          *)
(* This file is part of MOPSA, a Modular Open Platform for Static Analysis. *)
(*                                                                          *)
(* Copyright (C) 2017-2019 The MOPSA Project.                               *)
(*                                                                          *)
(* This program is free software: you can redistribute it and/or modify     *)
(* it under the terms of the GNU Lesser General Public License as published *)
(* by the Free Software Foundation, either version 3 of the License, or     *)
(* (at your option) any later version.                                      *)
(*                                                                          *)
(* This program is distributed in the hope that it will be useful,          *)
(* but WITHOUT ANY WARRANTY; without even the implied warranty of           *)
(* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the            *)
(* GNU Lesser General Public License for more details.                      *)
(*                                                                          *)
(* You should have received a copy of the GNU Lesser General Public License *)
(* along with this program.  If not, see <http://www.gnu.org/licenses/>.    *)
(*                                                                          *)
(****************************************************************************)

(** Lattice of partial maps.

    Sets of partial maps M ∈ ℘(𝕂 ⇀ 𝕍) from concrete keys set 𝕂 to
    concrete values set 𝕍 are abstracted as a partial map ℳ ∈ (𝕂⇀𝒱)
    that binds concrete keys to abstract values.
*)

open Mopsa_utils
open Bot_top
open Core.All


let debug fmt = Debug.debug ~channel:"framework.lattices.partial_map" fmt

module PMap = MapExtPoly


type ('k,'v) map = ('k,'v) PMap.t with_bot_top


module type KEY =
sig
  type t
  val compare: t -> t -> int
  val print : Print.printer -> t -> unit
end


module Make
    (Key   : KEY)
    (Value : LATTICE)
=
struct


  (** Abstraction of a set of partial maps from [Key.t] to ['a].*)
  type t = (Key.t, Value.t) map

  let bottom : t = BOT

  let top : t = TOP

  let is_bottom (a:t) : bool =
    match a with
    | BOT -> true
    | TOP -> false
    | Nbt m -> false

  let empty : t = Nbt (PMap.empty ~compare:Key.compare)

  let subset (a1:t) (a2:t) : bool =
    if a1 == a2 then true else
    match a1, a2 with
    | BOT, _ -> true
    | _, BOT -> false
    | _, TOP -> true
    | TOP, _ -> false
    | Nbt m1, Nbt m2 ->
      PMap.for_all2zo
         (fun _ v1 -> false)
         (fun _ v2 -> true)
         (fun _ v1 v2 -> Value.subset v1 v2)
         m1 m2
  (** Inclusion test. *)

  let join (a1:t) (a2:t) : t =
    if a1 == a2 then a1 else
    match a1, a2 with
    | BOT, x | x, BOT -> x
    | TOP, _ | _, TOP -> TOP
    | Nbt m1, Nbt m2 ->
      Nbt (
        PMap.map2zo
          (fun _ v1 -> v1)
          (fun _ v2 -> v2)
          (fun _ v1 v2 -> Value.join v1 v2)
          m1 m2
      )
  (** Join two sets of partial maps. *)

  let widen ctx (a1:t) (a2:t) : t =
    if a1 == a2 then a1 else
    match a1, a2 with
    | BOT, x | x, BOT -> x
    | TOP, x | x, TOP -> TOP
    | Nbt m1, Nbt m2 ->
      Nbt (
        PMap.map2zo
          (fun _ v1 -> v1)
          (fun _ v2 -> v2)
          (fun _ v1 v2 -> Value.widen ctx v1 v2)
          m1 m2
      )
  (** Widening (naive). *)

  let meet (a1:t) (a2:t) : t =
    if a1 == a2 then a1 else
    match a1, a2 with
    | BOT, x | x, BOT -> BOT
    | TOP, x | x, TOP -> x
    | Nbt m1, Nbt m2 ->
      try
        Nbt (
          PMap.fold2zo
            (fun k _ acc -> PMap.remove k acc)
            (fun k _ acc -> PMap.remove k acc)
            (fun k v1 v2 acc ->
               let v = Value.meet v1 v2 in
               if Value.is_bottom v then raise Bot.Found_BOT
               else PMap.add k v acc
            ) m1 m2 m1
        )
      with Bot.Found_BOT -> bottom
  (** Meet. *)


  let print printer (a:t) : unit =
    match a with
    | BOT -> pp_string printer "⊥"
    | TOP -> pp_string printer "⊤"
    | Nbt m when PMap.is_empty m -> pp_string printer "∅"
    | Nbt m ->
      pp_map Key.print Value.print printer (PMap.bindings m) ~mopen:"" ~mbind:"⇀" ~msep:"," ~mclose:""
  (** Printing. *)

  let find (k: Key.t) (a:t) : 'a =
    match a with
    | BOT -> Value.bottom
    | TOP -> Value.top
    | Nbt m -> PMap.find k m


  let find_opt (k: Key.t) (a:t) : 'a option =
    match a with
    | BOT -> Some Value.bottom
    | TOP -> Some Value.top
    | Nbt m -> PMap.find_opt k m

  let remove (k: Key.t) (a:t) : t =
    match a with
    | BOT -> BOT
    | TOP -> TOP
    | Nbt m -> Nbt (PMap.remove k m)

  let add (k: Key.t) (v:'a) (a:t) : t =
    if Value.is_bottom v then BOT
    else
      match a with
      | BOT -> BOT
      | TOP -> TOP
      | Nbt m -> Nbt (PMap.add k v m)

  let rename (k: Key.t) (k': Key.t) (a:t) : t =
    let v = find k a in
    let a = remove k a in
    add k' v a

  let singleton (k:Key.t) (v:'a) : t =
    add k v empty

  let filter (f : Key.t -> 'a -> bool) (a :t) : t =
    match a with
    | BOT -> BOT
    | TOP -> TOP
    | Nbt m -> Nbt (PMap.filter f m)

  let partition (f : Key.t -> 'a -> bool) (a :t) : t * t=
    match a with
    | BOT -> BOT, BOT
    | TOP -> TOP, TOP
    | Nbt m ->
       let a, b = PMap.partition f m in
       Nbt a, Nbt b

  let iter (f:Key.t -> 'a -> unit) (a:t) : unit =
    match a with
    | BOT -> ()
    | TOP -> raise Top.Found_TOP
    | Nbt m -> PMap.iter f m

  let fold (f:Key.t -> 'a -> 'b -> 'b) (a:t) (x:'b) : 'b =
    match a with
    | BOT -> x
    | TOP -> raise Top.Found_TOP
    | Nbt m -> PMap.fold f m x

  let fold2o f1 f2 f a b acc =
    match a, b with
    | BOT, _ | _, BOT -> acc
    | TOP, _ | _, TOP -> raise Top.Found_TOP
    | Nbt m1, Nbt m2 -> PMap.fold2o f1 f2 f m1 m2 acc

  let fold2zo f1 f2 f a b acc =
    match a, b with
    | BOT, _ | _, BOT -> acc
    | TOP, _ | _, TOP -> raise Top.Found_TOP
    | Nbt m1, Nbt m2 -> PMap.fold2zo f1 f2 f m1 m2 acc

  let mem (x:Key.t) (a:t) : bool =
    match a with
    | BOT -> false
    | TOP -> true
    | Nbt m -> PMap.mem x m

  let canonize (a:t) : t =
    if is_bottom a then BOT else a

  let map (f:Value.t -> Value.t) (a:t) : t =
    match a with
    | BOT -> BOT
    | TOP -> TOP
    | Nbt m ->
      Nbt (PMap.map f m) |>
      canonize

  let mapi (f:Key.t -> Value.t -> Value.t) (a:t) : t =
    match a with
    | BOT -> BOT
    | TOP -> TOP
    | Nbt m ->
      Nbt (PMap.mapi f m) |>
      canonize

  let map_p (f:Key.t * Value.t -> Key.t * 'a) (a:t) : (Key.t, 'a) map =
    match a with
    | BOT -> BOT
    | TOP -> TOP
    | Nbt m ->
      Nbt (PMap.fold (fun k v acc ->
          let k',v' = f (k,v) in
          PMap.add k' v' acc
        ) m (PMap.empty ~compare:Key.compare))
      |>
      canonize


  let bindings (a:t) : (Key.t * 'a) list =
    match a with
    | BOT -> []
    | TOP -> raise Top.Found_TOP
    | Nbt m -> PMap.bindings m

  let for_all (f:Key.t -> 'a -> bool) (a:t) : bool =
    match a with
    | BOT -> true
    | TOP -> raise Top.Found_TOP
    | Nbt m -> PMap.for_all f m

  let exists (f:Key.t -> 'a -> bool) (a:t) : bool =
    match a with
    | BOT -> false
    | TOP -> raise Top.Found_TOP
    | Nbt m -> PMap.exists f m

  let max_binding (a:t) : (Key.t * 'a) option =
    match a with
    | BOT -> None
    | TOP -> None
    | Nbt m -> Some (PMap.max_binding m)

  let cardinal (a:t) : int =
    match a with
    | BOT -> 0
    | TOP -> raise Top.Found_TOP
    | Nbt m -> PMap.cardinal m

  let map2zo f1 f2 f (a1:t) (a2:t) : t =
    if a1 == a2 then a1
    else match a1, a2 with
      | BOT, x | x, BOT -> x
      | TOP, x | x, TOP -> TOP
      | Nbt m1, Nbt m2 -> Nbt (PMap.map2zo f1 f2 f m1 m2)


end
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct