package goblint

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

Source file sLR.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
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
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
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
550
551
(** Various SLR solvers.

    @see <http://www2.in.tum.de/bib/files/apinis14diss.pdf> Apinis, K. Frameworks for analyzing multi-threaded C. *)

open Batteries
open ConstrSys
open Messages

let narrow f = if GobConfig.get_bool "exp.no-narrow" then (fun a b -> a) else f

(** the SLR3 box solver *)
module SLR3 =
  functor (S:EqConstrSys) ->
  functor (HM:Hashtbl.S with type key = S.v) ->
  struct
    open SolverBox.Warrow (S.Dom)

    include Generic.SolverStats (S) (HM)
    module VS = Set.Make (S.Var)

    module P =
    struct
      type t = S.Var.t * S.Var.t [@@deriving eq, hash]
    end

    module HPM = Hashtbl.Make (P)

    let solve st vs =
      let key    = HM.create 10 in
      let count  = ref 0 in
      let get_key x = try HM.find key x with Not_found -> (let c = !count in HM.replace key  x c; decr count; (* print_endline ("Variable " ^ S.Var.var_id x ^ " to " ^ string_of_int c); *) c) in
      let module H = Heap.Make (struct
          type t = S.Var.t
          let compare x y = compare (get_key x) (get_key y)
        end)
      in
      let extract_min q =
        let x = H.find_min !q in
        q := H.del_min !q; x
      in
      let min_key q =
        let x = H.find_min !q in
        get_key x
      in
      let wpoint = HM.create  10 in
      let globals = HM.create  10 in
      let stable = HM.create  10 in
      let infl   = HM.create  10 in
      let set    = HM.create  10 in
      let rho    = HM.create  10 in
      let rho'   = HPM.create 10 in
      let q      = ref H.empty in

      let add_infl y x = HM.replace infl y (VS.add x (try HM.find infl y with Not_found -> VS.empty)) in
      let add_set x y d = HM.replace set y (VS.add x (try HM.find set y with Not_found -> VS.empty)); HPM.add rho' (x,y) d in
      let make_wpoint x = HM.replace wpoint x () in
      let rec solve x =
        if not (HM.mem stable x) then begin
          let wpx = HM.mem wpoint x in
          HM.remove wpoint x;
          HM.replace stable x ();
          let old = HM.find rho x in
          let tmp = eq x (eval x) (side x) in
          let tmp = S.Dom.join tmp (sides x) in
          if tracing then trace "sol" "Var: %a" S.Var.pretty_trace x ;
          if tracing then trace "sol" "Contrib:%a" S.Dom.pretty tmp;
          let tmp =
            if wpx then
              if HM.mem globals x then S.Dom.widen old tmp
              else box old tmp
            else tmp
          in
          if not (S.Dom.equal old tmp) then begin
            update_var_event x old tmp;
            if tracing then trace "sol" "New Value:%a" S.Dom.pretty tmp;
            HM.replace rho x tmp;
            let w = try HM.find infl x with Not_found -> VS.empty in
            let w = if wpx then VS.add x w else w in
            q := Enum.fold (fun x y -> H.add y x) !q (VS.enum w);
            HM.replace infl x VS.empty;
            Enum.iter (HM.remove stable) (VS.enum w)
          end;
          while (H.size !q <> 0) && (min_key q <= get_key x) do
            solve (extract_min q)
          done;
        end;
        assert (HM.mem stable x)
      and eq x get set =
        eval_rhs_event x;
        match S.system x with
        | None -> S.Dom.bot ()
        | Some f ->
          let effects = ref Set.empty in
          let sidef y d =
            if not (Set.mem y !effects) then (
              HPM.replace rho' (x,y) (S.Dom.bot ());
              effects := Set.add y !effects
            );
            set y d
          in
          f get sidef
      and eval x y =
        get_var_event y;
        if not (HM.mem rho y) then init y;
        if get_key x <= get_key y then make_wpoint y else solve y;
        add_infl y x;
        HM.find rho y
      and sides x =
        let w = try HM.find set x with Not_found -> VS.empty in
        Enum.fold (fun d z -> try S.Dom.join d (HPM.find rho' (z,x)) with Not_found -> d) (S.Dom.bot ()) (VS.enum w)
      and side x y d =
        HM.add globals y ();
        if not (HM.mem rho y) then begin
          init y;
          add_set x y d;
          solve y
        end else begin
          let old = HPM.find rho' (x,y) in
          if not (S.Dom.equal old d) then begin
            add_set x y (S.Dom.join old d);
            HM.remove stable y;
            make_wpoint y;
            q := H.add y !q
          end
        end
      and init x =
        if not (HM.mem rho x) then begin
          new_var_event x;
          let _ = get_key x in
          HM.replace rho  x (S.Dom.bot ());
          HM.replace infl x (VS.add x VS.empty)
        end
      in

      let set_start (x,d) =
        init x;
        (* HM.replace rho x d; *)
        (* HM.replace set x (VS.add x VS.empty); *)
        (* HPM.add rho' (x,x) d *)
        add_set x x d;
        solve x
      in

      start_event ();
      List.iter set_start st;
      List.iter init vs;
      q := List.fold_left (fun q v -> H.add v q) H.empty vs;

      (* List.iter solve vs; *)
      while (H.size !q <> 0) do
        solve (extract_min q)
      done;
      stop_event ();

      if GobConfig.get_bool "dbg.print_wpoints" then (
        Logs.newline ();
        Logs.debug "Widening points:";
        HM.iter (fun k () -> Logs.debug "%a" S.Var.pretty_trace k) wpoint;
        Logs.newline ();
      );

      HM.clear key   ;
      HM.clear wpoint;
      HM.clear stable;
      HM.clear infl  ;
      HM.clear set   ;
      HPM.clear rho'  ;

      rho

  end

module type Version = sig val ver : int end

(** the box solver *)
module Make0 =
  functor (V:Version) ->
  functor (Box: SolverBox.S) ->
  functor (S:EqConstrSys) ->
  functor (HM:Hashtbl.S with type key = S.v) ->
  struct
    open Box (S.Dom)

    let h_find_option h x =
      try Some (HM.find h x)
      with Not_found -> None

    let h_find_default h x d =
      try HM.find h x
      with Not_found -> d

    (** Helper module for values and priorities. *)
    module X =
    struct
      let keys = HM.create 1024
      let vals = HM.create 1024
      let val0 = HM.create 1024
      let last_key = ref 0

      let get_value x = h_find_default vals x (S.Dom.bot ())
      let set_value x d =
        if (V.ver >= 5) && not (HM.mem val0 x) then HM.replace val0 x d;
        HM.replace vals x d

      let get_key x =
        try
          HM.find keys x
        with Not_found ->
          incr SolverStats.vars;
          decr last_key;
          HM.add keys x !last_key;
          !last_key

      let get_index c =
        try (HM.find keys c, true)
        with Not_found ->
          incr SolverStats.vars;
          decr last_key;
          HM.add keys c !last_key;
          (!last_key, false)

      let to_list () = vals
    end

    (** Helper module for values of global contributions. *)
    module XY =
    struct
      module P =
      struct
        type t = S.Var.t * S.Var.t [@@deriving eq, hash]
      end
      module HPM = Hashtbl.Make (P)
      let hpm_find_default h x d =
        try HPM.find h x
        with Not_found -> d

      let xy = HPM.create 1024

      let get_value x = hpm_find_default xy x (S.Dom.bot ())
      let set_value = HPM.replace xy
    end

    (** Helper module for priority queues. *)
    module H =
    struct
      module HeapCompare =
      struct
        type t = S.Var.t
        let compare x y = Int.compare (X.get_key x) (X.get_key y)
      end

      include Heap.Make (HeapCompare)
      let from_list xs = List.enum xs |> of_enum
      let is_empty x = size x = 0
      let get_root_key x = find_min x |> X.get_key
      let extract_min h = (find_min h, del_min h)
      let insert h k =
        (* ignore @@ Printf.printf "add %d\n" (X.get_key k); *)
        insert h k
      let extract_min h =
        let (k,h) = extract_min h in
        (* ignore @@ Printf.printf "removing %d\n" (X.get_key k); *)
        (k,h)
    end

    (** Helper module for influence lists. *)
    module L =
    struct
      let add h k v = HM.replace h k (v::h_find_default h k [])
      let sub h k = h_find_default h k []
      let rem_item = HM.remove
    end

    (** Helper module for the stable set and global variable setting deps. *)
    module P =
    struct
      let single x = tap (fun s -> HM.add s x ()) (HM.create 10)
      let to_list s = HM.fold (fun x y z -> x :: z ) s []
      let has_item = HM.mem
      let rem_item = HM.remove
      let insert m = flip (HM.replace m) ()
    end

    (** Helper module for variable setting deps. *)
    module T =
    struct
      let sub = h_find_option
      let update = HM.replace
      let set    = HM.create 1024
    end

    (** Helper module for the domain. *)
    module D =
    struct
      include S.Dom
      let eq = equal
      let cup = join
    end

    let infl   = HM.create 1024
    let wpoint = HM.create 1024
    let restart_mode = HM.create 1024

    let solve st list =
      let stable = HM.create 1024 in
      let work   = ref H.empty    in

      let _ = List.iter (fun (x,v) -> XY.set_value (x,x) v; T.update T.set x (P.single x)) st in
      let _ = work := H.merge (H.from_list list) !work in

      let eq x get set =
        match S.system x with
        | None -> S.Dom.bot ()
        | Some f ->
          let sides = HM.create 10 in
          let collect_set x v =
            let _ = X.get_key x in (* set priority immediately! *)
            h_find_default sides x (S.Dom.bot ()) |> S.Dom.join v |> HM.replace sides x
          in
          let d = f get collect_set in
          HM.iter set sides;
          d
      in

      let restart x =
        let sk = X.get_key x in
        let rec handle_one x =
          let k = X.get_key x in
          let _ = work := H.insert !work x in
          let _ = P.rem_item stable x in
          if k < sk then
            let _ = X.set_value x (D.bot ()) in
            (* Logs.debug " also restarting %d: %a" k S.Var.pretty_trace x; *)
            (* flush_all (); *)
            let w = L.sub infl x in
            let _ = L.rem_item infl x in
            List.iter handle_one w
        in
        (* Logs.debug "restarting %d: %a" sk S.Var.pretty_trace x; *)
        (* flush_all (); *)
        let w = L.sub infl x in
        let _ = L.rem_item infl x in
        List.iter handle_one w
      in

      let rec eval x =
        let (xi,_) = X.get_index x in
        fun y ->
          let (i,nonfresh) = X.get_index y in
          let _ = if xi <= i then HM.replace wpoint y () in
          let _ = if (V.ver>2) && xi <= i then work := H.insert (!work) y in
          let _ = if not nonfresh then solve y in
          let _ = L.add infl y x in
          X.get_value y

      and side x y d =
        let yk, ynonfresh = X.get_index y in
        if X.get_key x > yk then begin
          (* Logs.warn "wrong order: %d > %d"  (X.get_key x) yk; *)
          ()
        end;

        if (V.ver>1) then HM.replace wpoint y ();

        let _ =
          match T.sub T.set y with
          | None -> T.update T.set y (P.single x)
          | Some p -> P.insert p x
        in

        let old = XY.get_value (x,y) in
        (* Logs.debug "key: %a -> %a\nold: %a\n\nd: %a" S.Var.pretty_trace x S.Var.pretty_trace y S.Dom.pretty old S.Dom.pretty d; *)
        let tmp = d in
        (* Logs.debug "tmp: %a"  S.Dom.pretty tmp; *)

        if not (D.eq tmp old) then begin
          let _ = XY.set_value (x,y) tmp in

          if ynonfresh then
            let _ = P.rem_item stable y in
            work := H.insert (!work) y
          else
            solve y
        end

      and do_side x a =
        match T.sub T.set x with
        | None -> a
        | Some p ->
          let xs = P.to_list p in
          (* Logs.debug "%d var %a" (List.length list) S.Var.pretty_trace x); *)
          List.fold_left (fun a z -> D.cup a (XY.get_value (z,x))) a xs

      and solve x =
        if not (P.has_item stable x) then begin
          incr SolverStats.evals;
          let _ = P.insert stable x in
          let old = X.get_value x in

          let tmp = do_side x (eq x (eval x) (side x)) in
          let use_box = (not (V.ver>1)) || HM.mem wpoint x in
          let restart_mode_x = h_find_default restart_mode x (2*GobConfig.get_int "solvers.slr4.restart_count") in
          let rstrt = use_box && (V.ver>3) && D.leq tmp old && restart_mode_x <> 0 in
          if tracing then trace "sol" "Var: %a" S.Var.pretty_trace x ;
          if tracing then trace "sol" "Contrib:%a" S.Dom.pretty tmp;
          let tmp = if use_box then box old tmp else tmp in
          if not (D.eq tmp old) then begin
            if tracing then trace "sol" "New Value:%a" S.Dom.pretty tmp;
            let _ = X.set_value x tmp in
            if V.ver>3 && restart_mode_x mod 2 = 1 && not (D.leq tmp old) then
              HM.replace restart_mode x (restart_mode_x - 1);

            if rstrt then begin
              if restart_mode_x mod 2 = 0 then
                HM.replace restart_mode x (restart_mode_x - 1);
              restart x
            end else
              let w = L.sub infl x in
              let w = if use_box then x::w else w in
              let _ = L.rem_item infl x in
              let _ = if (V.ver>2) then HM.remove wpoint x in
              let _ = work := List.fold_left H.insert (!work) w in
              List.iter (P.rem_item stable) w;
              loop (X.get_key x)
          end
        end;
        if (V.ver>2) then HM.remove wpoint x

      and loop a =
        if not (H.is_empty (!work)) then begin
          if H.get_root_key (!work) <= a
          then let (x,h) = H.extract_min (!work) in
            let _ = work := h in
            let _ = solve x in
            loop a
        end
      in

      let rec loop () =
        if not (H.is_empty (!work)) then begin
          let (x,h) = H.extract_min (!work) in
          let _ = work := h in
          let _ = solve x in
          loop ()
        end
      in

      let _ = loop () in

      if GobConfig.get_bool "dbg.print_wpoints" then (
        Logs.newline ();
        Logs.debug "Widening points:";
        HM.iter (fun k () -> Logs.debug "%a" S.Var.pretty_trace k) wpoint;
        Logs.newline ();
      );

      X.to_list ()

  end

module Make (V: Version) = Make0 (V) (SolverBox.Warrow)


module type MyGenericEqSolver =
  functor (S:EqConstrSys) ->
  functor (H:Hashtbl.S with type key = S.v) ->
  sig
    val solve : (S.v*S.d) list -> S.v list -> S.d H.t
    val wpoint : unit H.t
    val infl :  S.v list H.t
    module X :
    sig
      val keys : int H.t
    end
  end

module PrintInfluence =
  functor (Sol:MyGenericEqSolver) ->
  functor (S:EqConstrSys) ->
  functor (HM:Hashtbl.S with type key = S.v) ->
  struct
    module S1 = Sol (S) (HM)
    let solve x y =
      let ch = Legacy.open_out "test.dot" in
      let r = S1.solve x y in
      let f k _ =
        let q = if HM.mem S1.wpoint k then " shape=box style=rounded" else "" in
        let s = GobPretty.sprintf "%a %d" S.Var.pretty_trace k (try HM.find S1.X.keys k with Not_found -> 0) in
        ignore (Pretty.fprintf ch "%d [label=\"%s\"%s];\n" (S.Var.hash k) (XmlUtil.escape s) q);
        let f y =
          if try HM.find S1.X.keys k > HM.find S1.X.keys y with Not_found -> false then
            ignore (Pretty.fprintf ch "%d -> %d [arrowhead=box style=dashed];\n" (S.Var.hash k) (S.Var.hash y))
          else
            ignore (Pretty.fprintf ch "%d -> %d ;\n" (S.Var.hash k) (S.Var.hash y))
        in
        List.iter f (try HM.find S1.infl k with Not_found -> [])
      in
      ignore (Pretty.fprintf ch "digraph G {\nedge [arrowhead=vee];\n");
      HM.iter f r;
      ignore (Pretty.fprintf ch "}\n");
      Legacy.close_out_noerr ch;
      r
  end


module TwoPhased =
  functor (V:Version) ->
  functor (S:EqConstrSys) ->
  functor (HM:Hashtbl.S with type key = S.v) ->
  struct
    module N = Make0 (V) (SolverBox.NarrowOption) (S) (HM)
    module W = Make0 (V) (SolverBox.Widen) (S) (HM)

    let solve is iv =
      let sd = W.solve is iv in
      let iv' = HM.fold (fun k _ b -> k::b) sd [] in
      N.solve [] iv'
  end

module JustWiden (V:Version) = Make0 (V) (SolverBox.Widen)

let _ =
  let module W1 = JustWiden (struct let ver = 1 end) in
  let module W2 = JustWiden (struct let ver = 2 end) in
  let module W3 = JustWiden (struct let ver = 3 end) in
  Selector.add_solver ("widen1",  (module PostSolver.EqIncrSolverFromEqSolver (W1)));
  Selector.add_solver ("widen2",  (module PostSolver.EqIncrSolverFromEqSolver (W2)));
  Selector.add_solver ("widen3",  (module PostSolver.EqIncrSolverFromEqSolver (W3)));
  let module S2 = TwoPhased (struct let ver = 1 end) in
  Selector.add_solver ("two",  (module PostSolver.EqIncrSolverFromEqSolver (S2)));
  let module S1 = Make (struct let ver = 1 end) in
  Selector.add_solver ("new",  (module PostSolver.EqIncrSolverFromEqSolver (S1)));
  Selector.add_solver ("slr+", (module PostSolver.EqIncrSolverFromEqSolver (S1)))

let _ =
  let module S1 = Make (struct let ver = 1 end) in
  let module S2 = Make (struct let ver = 2 end) in
  let module S3 = SLR3 in
  let module S4 = Make (struct let ver = 4 end) in
  Selector.add_solver ("slr1", (module PostSolver.EqIncrSolverFromEqSolver (S1))); (* W&N at every program point *)
  Selector.add_solver ("slr2", (module PostSolver.EqIncrSolverFromEqSolver (S2))); (* W&N dynamic at certain points, growing number of W-points *)
  Selector.add_solver ("slr3", (module PostSolver.EqIncrSolverFromEqSolver (S3))); (* same as S2 but number of W-points may also shrink *)
  Selector.add_solver ("slr4", (module PostSolver.EqIncrSolverFromEqSolver (S4))); (* restarting: set influenced variables to bot and start up-iteration instead of narrowing *)
  let module S1p = PrintInfluence (Make (struct let ver = 1 end)) in
  let module S2p = PrintInfluence (Make (struct let ver = 2 end)) in
  let module S3p = PrintInfluence (Make (struct let ver = 3 end)) in
  let module S4p = PrintInfluence (Make (struct let ver = 4 end)) in
  Selector.add_solver ("slr1p", (module PostSolver.EqIncrSolverFromEqSolver (S1p))); (* same as S1-4 above but with side-effects *)
  Selector.add_solver ("slr2p", (module PostSolver.EqIncrSolverFromEqSolver (S2p)));
  Selector.add_solver ("slr3p", (module PostSolver.EqIncrSolverFromEqSolver (S3p)));
  Selector.add_solver ("slr4p", (module PostSolver.EqIncrSolverFromEqSolver (S4p)));
OCaml

Innovation. Community. Security.