Source file `Occurrence.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
(**************************************************************************)
(*                                                                        *)
(*  This file is part of Frama-C.                                         *)
(*                                                                        *)
(*  Copyright (C) 2007-2023                                               *)
(*    CEA (Commissariat à l'énergie atomique et aux énergies              *)
(*         alternatives)                                                  *)
(*                                                                        *)
(*  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, version 2.1.                                              *)
(*                                                                        *)
(*  It 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.                   *)
(*                                                                        *)
(*  See the GNU Lesser General Public License version 2.1                 *)
(*  for more details (enclosed in the file licenses/LGPLv2.1).            *)
(*                                                                        *)
(**************************************************************************)

(** Occurrence plug-in. *)
open Cil_types

(** Interface for the occurrence plugin.
    @see <../occurrence/index.html> internal documentation. *)
module Register: sig
  val self: State.t
  val get_last_result:
    unit -> ((kernel_function option * kinstr * lval) list * varinfo) option
  val get: (varinfo -> (kernel_function option * kinstr * lval) list)
  (** Return the occurrences of the given varinfo.
      An occurrence [ki, lv] is a left-value [lv] which uses the location of
      [vi] at the position [ki]. *)

  val print_all: (unit -> unit)
  (** Print all the occurrence of each variable declarations. *)

  (* {2 Internal Use Only}*)

  type access_type = Read | Write | Both

  val classify_accesses: kernel_function option * kinstr *lval -> access_type
end = Register

(*
Local Variables:
compile-command: "make -C ../../.."
End:
*)