package frama-c

  1. Overview
  2. Docs
package frama-c
Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module V : sig ... end
module Default_offsetmap : sig ... end

Signature

type v = V.t

type of the values associated to a location

type offsetmap = Offsetmap.t

type of the maps associated to a base

type widen_hint_base = V.numerical_widen_hint

widening hints for each base

type map

Maps from Base.t to offsetmap

type lmap = private
  1. | Bottom
  2. | Top
  3. | Map of map
include Datatype.S_with_collections with type t = lmap
include Datatype.S with type t = lmap
include Datatype.S_no_copy with type t = lmap
include Datatype.Ty with type t = lmap
type t = lmap
val ty : t Type.t
val name : string

Unique name of the datatype.

val descr : t Descr.t

Datatype descriptor.

val packed_descr : Structural_descr.pack

Packed version of the descriptor.

val reprs : t list

List of representants of the descriptor.

val equal : t -> t -> bool

Equality: same spec than Stdlib.(=).

val compare : t -> t -> int

Comparison: same spec than Stdlib.compare.

val hash : t -> int

Hash function: same spec than Hashtbl.hash.

val mem_project : (Project_skeleton.t -> bool) -> t -> bool

mem_project f x must return true iff there is a value p of type Project.t in x such that f p returns true.

val copy : t -> t

Deep copy: no possible sharing between x and copy x.

module Set : Datatype.Set with type elt = t
module Map : Datatype.Map with type key = t
module Hashtbl : Datatype.Hashtbl with type key = t
val pretty : Format.formatter -> t -> unit
val pretty_debug : Format.formatter -> t -> unit
val pretty_filter : Format.formatter -> t -> Locations.Zone.t -> unit

pretty_filter m z pretties only the part of m that correspond to the bases present in z

val pretty_diff : Format.formatter -> t -> t -> unit

General shape

val top : t
val is_top : t -> bool
val empty_map : t

Empty map. Casual users do not need this except to create a custom initial state.

val is_empty_map : t -> bool
val bottom : t

Every location is associated to the value bottom of type v in this state. This state can be reached only in dead code.

val is_reachable : t -> bool

Join and inclusion

val join : t -> t -> t
val is_included : t -> t -> bool
module Make_Narrow (X : sig ... end) : sig ... end
type widen_hint = Base.Set.t * (Base.t -> widen_hint_base)

Bases that must be widening in priority, plus widening hints for each base.

val widen : widen_hint -> t -> t -> t
val merge : into:t -> t -> t

merge ~into t adds all binding from t into into.

Finding values

val find : ?conflate_bottom:bool -> t -> Locations.location -> v
  • raises Error_Top

    when the location or the state are Top, and there is no Top value in the type v.

copy_offsetmap alarms loc size m returns the superposition of the ranges of size bits starting at loc within m. size must be strictly greater than zero. Return None if all pointed addresses are invalid in m.

  • raises Error_Top

    when the location or the state are Top, and there is no Top value in the type v.

  • raises Not_found

    if the varid is not present in the map.

val find_base_or_default : Base.t -> t -> offsetmap Lattice_bounds.or_top_bottom

Same as find_base, but return the default values for bases that are not currently present in the map. Prefer the use of this function to find_base, unless you explicitly want to see if the base is bound.

Binding variables

val add_binding : exact:bool -> t -> Locations.location -> v -> t

add_binding ~exact initial_mem loc v simulates the effect of writing v at location loc, in the initial memory state given by initial_mem. If loc is not writable, bottom is returned. If exact is true, and loc is a precise location, a strong update is performed. Only locations that may be valid are written. Returns the resulting memory after the write.

val paste_offsetmap : from:offsetmap -> dst_loc:Locations.Location_Bits.t -> size:Integer.t -> exact:bool -> t -> t

paste_offsetmap ~from ~dst_loc ~size ~exact m copies from, which is supposed to be exactly size bits, and pastes them at dst_loc in m. The copy is exact if and only if dst_loc is exact, and exact is true. Only the locations that may be valid are written.

val add_base : Base.t -> offsetmap -> t -> t

add_base b o m adds base b bound to o, replacing any previous bindings of b. No effect on Top or Bottom.

val add_base_value : Base.t -> size:Integer.t -> v -> size_v:Integer.t -> t -> t

Creates the offsetmap described by size, v and size_v, and binds it to the base. No effect on Top or Bottom.

Filters

val filter_base : (Base.t -> bool) -> t -> t

Remove from the map all the bases that do not satisfy the predicate.

val filter_by_shape : 'a Hptmap.Shape(Base.Base).t -> t -> t

Remove from the map all the bases that are not also present in the given Base.t-indexed tree.

val remove_base : Base.t -> t -> t

Removes the base if it is present. Does nothing otherwise.

val replace_base : Base.substitution -> t -> t

replace_bases substitition map replaces some bases in map according to substitution. If substitution conflates different bases, the offsetmaps bound to these bases are joined.

Iterators

Notice that some iterators require an argument of type map: the cases Top and Bottom must be handled separately. All the iterators below only present bases that are bound to non-default values, according to the function is_default_offsetmap of the function Lmap.Make_Loffset.

val iter : (Base.base -> offsetmap -> unit) -> map -> unit
val fold : (Base.t -> offsetmap -> 'a -> 'a) -> map -> 'a -> 'a

Cached iterators

These functions are meant to be partially applied to all their arguments but the final one (the map). They must be called at the toplevel of OCaml modules, as they create persistent caches.

val cached_fold : f:(Base.t -> offsetmap -> 'a) -> cache_name:string -> temporary:bool -> joiner:('a -> 'a -> 'a) -> empty:'a -> map -> 'a
val cached_map : f:(Base.t -> offsetmap -> offsetmap) -> cache:(string * int) -> temporary:bool -> t -> t

Misc

val remove_variables : Cil_types.varinfo list -> t -> t

Shape of the map. This can be used for simultaneous iterations on other maps indexed by type Base.Base.t.

val clear_caches : unit -> unit

Clear the caches local to this module. Beware that they are not project-aware, and that you must call them at every project switch.

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