package bap-std

  1. Overview
  2. Docs
package bap-std
Legend:
Library
Module
Module type
Parameter
Class
Class type

Memory maps. Memory map is an assosiative data structure that maps memory regions to values. Unlike in the Table, memory regions in the Memmap can intersect in an arbitrary ways. This data structure is also known as an Interval Tree.

Memmap is an instance of the Interval_tree with the Memory serving as an interval.

type 'a t = 'a memmap

memory map, aka interval trees

val sexp_of_t : ('a -> Sexplib0.Sexp.t) -> 'a t -> Sexplib0.Sexp.t
val empty : 'a t

empty map

val singleton : mem -> 'a -> 'a t

singleton a memory map containing only one memory region

val min_addr : 'a t -> addr option

min_addr map is a minimum addr mapped in map

val max_addr : 'a t -> addr option

max_addr map is a maximum addr mapped in map

val min_binding : 'a t -> (mem * 'a) option

min_binding map is a minimum binding mapped in map

val max_binding : 'a t -> (mem * 'a) option

max_binding map is a maximum binding mapped in map

val add : 'a t -> mem -> 'a -> 'a t

add map mem tag adds a new memory region mem tagged with tag. If the same region was already in the map it will be tagged with the tag again, even if it has had the same tag.

val dominators : 'a t -> mem -> (mem * 'a) seq

dominators map mem an ordered sequence of all memory regions, containing mem. A memory region (x,y) contains region (p,q), iff p >= x && q <= y, where memory regions are depicted using closed intervals.

val intersections : 'a t -> mem -> (mem * 'a) seq

intersections map mem an ordered sequence of all memory regions, that intersects with mem. Memory region (x,y) intersects with region (p,q) iff there exists such z that

z >= p || z <= q && z >= x && z <= y.

In other words if there exists such byte that belongs to both memory regions.

val intersects : 'a t -> mem -> bool

intersects map mem is true if intersections map mem is not empty

val dominates : 'a t -> mem -> bool

dominates map mem if there is a non empty set of dominators

val contains : 'a t -> addr -> bool

contains map addr true if there exists such memory region mem, that Memory.contains mem addr

val lookup : 'a t -> addr -> (mem * 'a) seq

lookup map addr returns an ordered sequence of all memory containing the addr

val map : 'a t -> f:('a -> 'b) -> 'b t

map m f returns a new map with each tag mapped with function f

val mapi : 'a t -> f:(mem -> 'a -> 'b) -> 'b t

mapi m f the same as map, but f is called with two arguments: mem and tag, where mem is a memory region, and tag is a tag associated with that region.

val filter : 'a t -> f:('a -> bool) -> 'a t

filter map f returns a map that contains only those elements for which f evaluated to true

val filter_map : 'a t -> f:('a -> 'b option) -> 'b t

filter_map m f creates a new map by applying a function f to each tag. If f returns Some x then this region will be mapped to x in a new map, otherwise it will be dropped.

val filter_mapi : 'a t -> f:(mem -> 'a -> 'b option) -> 'b t

filter_mapi is like filter_map but use function also accepts would associated memory region

val remove : 'a t -> mem -> 'a t

remove map mem removes all bindings to mem

val remove_intersections : 'a t -> mem -> 'a t

remove_intersections map mem removes all bindings that that intersects with mem

val remove_dominators : 'a t -> mem -> 'a t

remove_dominators map mem removes all bindings that are dominators to mem

val to_sequence : 'a t -> (mem * 'a) seq

to_sequence map converts the memmap 'a t to a sequence of key-value pairs

include Core_kernel.Container.S1 with type 'a t := 'a t
val mem : 'a t -> 'a -> equal:('a -> 'a -> bool) -> bool

Checks whether the provided element is there, using equal.

val length : 'a t -> int
val is_empty : 'a t -> bool
val iter : 'a t -> f:('a -> unit) -> unit
val fold : 'a t -> init:'accum -> f:('accum -> 'a -> 'accum) -> 'accum

fold t ~init ~f returns f (... f (f (f init e1) e2) e3 ...) en, where e1..en are the elements of t

val fold_result : 'a t -> init:'accum -> f:('accum -> 'a -> ('accum, 'e) Base.Result.t) -> ('accum, 'e) Base.Result.t

fold_result t ~init ~f is a short-circuiting version of fold that runs in the Result monad. If f returns an Error _, that value is returned without any additional invocations of f.

val fold_until : 'a t -> init:'accum -> f:('accum -> 'a -> ('accum, 'final) Base.Container.Continue_or_stop.t) -> finish:('accum -> 'final) -> 'final

fold_until t ~init ~f ~finish is a short-circuiting version of fold. If f returns Stop _ the computation ceases and results in that value. If f returns Continue _, the fold will proceed. If f never returns Stop _, the final result is computed by finish.

Example:

type maybe_negative =
  | Found_negative of int
  | All_nonnegative of { sum : int }

(** [first_neg_or_sum list] returns the first negative number in [list], if any,
    otherwise returns the sum of the list. *)
let first_neg_or_sum =
  List.fold_until ~init:0
    ~f:(fun sum x ->
      if x < 0
      then Stop (Found_negative x)
      else Continue (sum + x))
    ~finish:(fun sum -> All_nonnegative { sum })
;;

let x = first_neg_or_sum [1; 2; 3; 4; 5]
val x : maybe_negative = All_nonnegative {sum = 15}

let y = first_neg_or_sum [1; 2; -3; 4; 5]
val y : maybe_negative = Found_negative -3
val exists : 'a t -> f:('a -> bool) -> bool

Returns true if and only if there exists an element for which the provided function evaluates to true. This is a short-circuiting operation.

val for_all : 'a t -> f:('a -> bool) -> bool

Returns true if and only if the provided function evaluates to true for all elements. This is a short-circuiting operation.

val count : 'a t -> f:('a -> bool) -> int

Returns the number of elements for which the provided function evaluates to true.

val sum : (module Base.Container.Summable with type t = 'sum) -> 'a t -> f:('a -> 'sum) -> 'sum

Returns the sum of f i for all i in the container.

val find : 'a t -> f:('a -> bool) -> 'a option

Returns as an option the first element for which f evaluates to true.

val find_map : 'a t -> f:('a -> 'b option) -> 'b option

Returns the first evaluation of f that returns Some, and returns None if there is no such element.

val to_list : 'a t -> 'a list
val to_array : 'a t -> 'a array
val min_elt : 'a t -> compare:('a -> 'a -> int) -> 'a option

Returns a minimum (resp maximum) element from the collection using the provided compare function, or None if the collection is empty. In case of a tie, the first element encountered while traversing the collection is returned. The implementation uses fold so it has the same complexity as fold.

val max_elt : 'a t -> compare:('a -> 'a -> int) -> 'a option
val pp : (Format.formatter -> 'a -> unit) -> Format.formatter -> 'a t -> unit

pp pp_elem constracts a printer for a memmap to the given element.

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