package mopsa

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

Source file token.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
(****************************************************************************)
(*                                                                          *)
(* 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/>.    *)
(*                                                                          *)
(****************************************************************************)

(** Tokens identifying control flows *)

open Mopsa_utils


type token = ..

type token += T_cur

let debug fmt = Debug.debug ~channel:"framework.core.token" fmt

let token_compare_chain = TypeExt.mk_compare_chain (fun tk1 tk2 ->
    match tk1, tk2 with
    | T_cur, T_cur -> 0
    | _ -> compare tk1 tk2
  )

let compare_token tk1 tk2 = TypeExt.compare token_compare_chain tk1 tk2

let token_print_chain = TypeExt.mk_print_chain (fun fmt tk ->
    match tk with
    | T_cur -> Format.fprintf fmt "cur"
    | _ -> Exceptions.panic ~loc:__LOC__ "unknown token"
  )

let pp_token fmt tk = TypeExt.print token_print_chain fmt tk

let register_token (info:token TypeExt.info) =
  TypeExt.register info token_compare_chain token_print_chain


open Context


module TokenMap =
struct

  open Top
  open Lattice

  module Map = MapExt.Make(
    struct
      type t = token
      let compare = compare_token
      let print = pp_token
    end
    )

  type +'a t = 'a Map.t with_top

  let bottom : 'a t =
    Nt Map.empty

  let top : 'a t =
    TOP

  let singleton (tk:token) (env:'a) : 'a t =
    Nt (Map.singleton tk env)

  let is_bottom (lattice: 'a lattice) (tmap: 'a t) : bool =
    top_dfl1 false (fun m ->
        Map.for_all (fun _ v -> lattice.is_bottom v) m
      ) tmap

  let is_singleton tmap =
    top_dfl1 false Map.is_singleton tmap

  let is_empty (tmap: 'a t) : bool =
    top_dfl1 false Map.is_empty tmap

  let is_top (lattice: 'a lattice) (tmap: 'a t) : bool =
    top_dfl1 true (fun _ -> false) tmap


  let subset (lattice: 'a lattice) ctx (tmap1: 'a t) (tmap2: 'a t) : bool =
    top_included
      (Map.for_all2zo
         (fun tk v1 ->
            lattice.is_bottom v1) (* non-⊥ ⊈ ⊥ *)
         (fun _ v2 -> true)  (* ⊥ ⊆ non-⊥ *)
         (fun _ v1 v2 -> lattice.subset ctx v1 v2)
      )
      tmap1 tmap2

  let join (lattice: 'a lattice) ctx (tmap1: 'a t) (tmap2: 'a t) : 'a t =
    top_lift2
      (Map.map2zo
         (fun _ v1 -> v1)
         (fun _ v2 -> v2)
         (fun _ v1 v2 -> lattice.join ctx v1 v2)
      )
      tmap1 tmap2

  let join_list lattice ctx l =
    match l with
    | [] -> bottom
    | hd :: tl -> List.fold_left (join lattice ctx) hd tl

  let meet (lattice: 'a lattice) ctx (tmap1: 'a t) (tmap2: 'a t) : 'a t =
    top_neutral2
      (fun b1 b2 ->
         Map.map2zo
           (fun _ v1 -> lattice.bottom)
           (fun _ v2 -> lattice.bottom)
           (fun _ v1 v2 -> lattice.meet ctx v1 v2)
           b1 b2
      )
      tmap1 tmap2

  let meet_list lattice ctx l =
    match l with
    | [] -> bottom
    | hd :: tl -> List.fold_left (meet lattice ctx) hd tl

  let widen (lattice: 'a lattice) (ctx: 'a ctx) (tmap1: 'a t) (tmap2: 'a t) : 'a t =
    top_lift2
      (Map.map2zo
         (fun _ v1 -> v1)
         (fun _ v2 -> v2)
         (fun _ v1 v2 -> lattice.widen ctx v1 v2)
      )
      tmap1 tmap2

  let print pp printer (tmap : 'a t) : unit =
    let open Print in
    match tmap with
    | TOP ->
      pp_string printer "⊤"
    | Nt m when Map.is_empty m ->
      pp_string printer "⊥"
    | Nt m ->
      pp_map (unformat pp_token) pp
        printer (Map.bindings m)

  let get (tk: token) (lattice: 'a lattice) (tmap: 'a t) : 'a =
    try
      let m = top_to_exn tmap in
      try Map.find tk m with Not_found -> lattice.bottom
    with Found_TOP -> lattice.top


  let mem (tk: token) (tmap: 'a t) : bool =
    top_dfl1 true (Map.mem tk) tmap

  let find (tk: token) (tmap: 'a t) : 'a =
    Map.find tk (top_to_exn tmap)

  let find_opt (tk: token) (tmap: 'a t) : 'a option =
    top_apply (fun m -> Some (Map.find tk m)) None tmap

  let set (tk: token) (a: 'a) (lattice:'a lattice) (tmap: 'a t) : 'a t =
    top_lift1 (fun m ->
        if lattice.is_bottom a then Map.remove tk m
        else Map.add tk a m
      ) tmap

  let copy (tk1:token) (tk2:token) (lattice:'a lattice) (tmap1:'a t) (tmap2:'a t) : 'a t =
    set tk2 (get tk1 lattice tmap1) lattice tmap2

  let remove (tk: token) (tmap: 'a t) : 'a t =
    top_lift1 (Map.remove tk) tmap

  let filter (f: token -> 'a -> bool) (tmap: 'a t) : 'a t =
    top_lift1 (Map.filter f) tmap

  let partition (f: token -> 'a -> bool) (tmap: 'a t) : 'a t * 'a t =
    match tmap with
    | TOP -> TOP, TOP
    | Nt a ->
      let l, r = Map.partition f a in
      Nt l, Nt r

  let map (f: token -> 'a -> 'b) (tmap: 'a t) : 'b t =
    top_lift1 (Map.mapi f) tmap

  let fold (f: 'b -> token -> 'a -> 'b) (init: 'b) (tmap: 'a t) : 'b =
    let m = top_to_exn tmap in
    Map.fold (fun tk a acc -> f acc tk a) m init

  let iter (f:token -> 'a -> unit) (tmap:'a t) : unit =
    let m = top_to_exn tmap in
    Map.iter f m

  let merge(f: token -> 'a option -> 'a option -> 'a option) (lattice: 'a lattice) (tmap1: 'a t) (tmap2: 'a t) : 'a t =
    top_lift2
      (Map.map2zo
         (fun tk v1 -> OptionExt.default lattice.bottom (f tk (Some v1) None))
         (fun tk v2 -> OptionExt.default lattice.bottom (f tk None (Some v2)))
         (fun tk v1 v2 -> OptionExt.default lattice.bottom (f tk (Some v1) (Some v2)))
      )
      tmap1 tmap2

  let map2zo f1 f2 f (tmap1: 'a t) (tmap2: 'a t) : 'a t =
    top_lift2
      (Map.map2zo f1 f2 f)
      tmap1 tmap2

  let neutral2 (f: token -> 'a -> 'a -> 'a) (tmap1: 'a t) (tmap2: 'a t) : 'a t =
    top_lift2
      (Map.map2zo
         (fun tk v1 -> v1)
         (fun tk v2 -> v2)
         (fun tk v1 v2 -> f tk v1 v2)
      )
      tmap1 tmap2

  let absorb2 (f: token -> 'a -> 'a -> 'a) (tmap1: 'a t) (tmap2: 'a t) : 'a t =
    top_lift2
      (Map.merge
         (fun tk ov1 ov2->
            match ov1, ov2 with
            | None, _ | _, None -> None
            | Some v1, Some v2 -> Some (f tk v1 v2)
         )
      )
      tmap1 tmap2


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