package binsec

  1. Overview
  2. Docs
package binsec
Legend:
Library
Module
Module type
Parameter
Class
Class type
type t = private
  1. | Var of Var.t
  2. | Restrict of Var.t * int Interval.t
  3. | Store of size * Machine.endianness * Expr.t * string option
include Sigs.Eq with type t := t
val equal : t -> t -> bool
val size_of : t -> int

size_of lv yields the size of lv in bits *

val var : ?tag:Var.Tag.t -> bitsize:Size.Bit.t -> string -> t

var tag name ~size creates a DBA lvalue for a variable

val v : Var.t -> t
val flag : ?bitsize:Size.Bit.t -> string -> t

flag ~size fname creates a flag variable.

  • size defaults to 1
val temporary : string -> Size.Bit.t -> t
val _restrict : string -> Size.Bit.t -> int -> int -> t
val _bit_restrict : string -> Size.Bit.t -> int -> t

_restrict and _bit_restrict are deprecated. Use the other forms ** below.

val restrict : Var.t -> int -> int -> t
val bit_restrict : Var.t -> int -> t
val store : ?array:string -> Size.Byte.t -> Machine.endianness -> Expr.t -> t
val temp : Size.Bit.t -> t

temp n creates a lvalue representing a temporary of size n with name Format.sprintf "temp%d" n.

val is_expr_translatable : Expr.t -> bool

is_expr_translatable e returns true is the expression can have a valid lvalue translation

val of_expr : Expr.t -> t

of_expr e translates an expression to its lvalue equivalent if possible.

Use is_expr_translatable e to check the feasability of this translation.

  • raises Failure

    "LValue.of_expr ..." if it is not possible.

val to_expr : t -> Expr.t

to_expr e translates an lvalue to its equivalent rvalue.

val bitsize : t -> Size.Bit.t

bitsize lv returns the size in bits of lv.

val resize : Size.Bit.t -> t -> t

resize bitsize lv patches the lvalue lv and gives it a size of bitsize.

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