Std.Stmt
Regular
interface for BIL statements
type t = Bil.stmt
class state : object ... end
All visitors provide some information about the current position of the visitor
class 'a visitor : object ... end
Visitor. Visits AST providing lots of hooks.
class 'a finder : object ... end
A visitor with a shortcut. Finder is a specialization of a visitor, that uses return
as its folding argument. At any time you can stop the traversing by calling return
function of the provided argument (which is by itself is a record with one field - a function accepting argument of type 'a option
).
class mapper : object ... end
AST transformation. mapper allows one to map AST, performing some limited amount of transformations on it. Mapper provides extra flexibility by mapping stmt
to stmt list
, thus allowing to remove statements from the output (by mapping to empty list) or to map one statement to several. This is particularly useful when you map if
or while
statements.
class constant_folder : mapper
constant_folder
is a class that implements the fold_consts
fold ~init visitor stmt
folds a stmt
with a visitor. See Bil
.fold and Exp.fold
for more details.
iter visitor stmt
iters over a stmt
with a visitor. See Bil
.iter and Exp.iter
for more details.
find finder stmt
performs a lookup into the Bil statement. See Bil
.find and Exp.find
for more details.
exists finder stmt
is true
iff find finder stmt <> None
. See Bil
.exists and Exp.exists
for more details.
is_referenced x stmt
is true is x
is used in the stmt
in any place other then right hand side of the assignment. E.g., is_referenced x Bil.(x := var x)
is true
, but is_referenced x Bil.(x := var y)
is false
. see Bil.is_referenced
for more details.
normalize ?normalize_exp xs
produces a normalized BIL program with the same^1
semantics but in the BIL normalized form (BNF). There are two normalized forms, both described below. The first form (BNF1) is more readable, the second form (BNF2) is more strict, but sometimes yields a code, that is hard for a human to comprehend. The BNF1
is the default, to request BNF2
pass normalize_exp:true
.
Precondition: xs
is well-typed.
The BIL First Normalized Form (BNF1) is a subset of the BIL language, where expressions have the following properties:
Load
constructor to have type (Load (var,exp,endian,size)
).The BIL Second Normalized Form (BNF2) is a subset of the BNF1 (in a sense that all BNF2 programs are also in BNF1). This form puts the following restrictions:
All memory operations have sizes equal to one byte. Thus the size and endianness can be ignored in analysis. During the normalization, the following rewrites are performed
let x = <expr> in ... x ... => ... <expr> ... x[a,el]:n => x[a+n-1] @ ... @ x[a] x[a,be]:n => x[a] @ ... @ x[a+n-1] m[a,el]:n <- x => (...((m[a] <- x<0>)[a+1] <- x<1>)...)[a+n-1] <- x<n-1> m[a,be]:n <- x => (...((m[a] <- x<n-1>)[a+1] <- x<n>)...)[a+n-1] <- x<0> (x[a] <- b)[c] => m := x[a] <- b; m[c]
^1
: The normalization procedure may duplicate expressions that might be considered non-generative. For example,
let x = m[a] in x + x
is rewritten to m[a] + m[a]
. Given a concrete semantics of a memory (for example, if memory is mapped to a device register that changes every times it is read) this expression may have different value. It will also have different effect (such as two memory accesses, page faults etc).
However, in the formal semantics of BAP we do not consider effects, and treat all expressions as side-effect free, thus the above transformation, are preserving the semantics.
simpl ?ignore xs
recursively applies Exp.simpl
and also simplifies if
and while
expressions with statically known conditionals, e.g., if (true) xs ys
is simplified to xs
, while (false) xs
is simplified to xs
.
fixpoint f x
applies transformation f
until it reaches fixpoint. See Bil.fixpoint
and Exp.fixpoint
.
free_vars stmt
returns a set of all unbound variables, that occurs in stmt
.
val eval : t list -> Bili.context as 'a -> 'a
eval prog
eval BIL program under given context. Returns the context which contains all effects of computations.
include Regular.Std.Regular.S with type t := t
include Core_kernel.Bin_prot.Binable.S with type t := t
val bin_size_t : t Bin_prot.Size.sizer
val bin_write_t : t Bin_prot.Write.writer
val bin_read_t : t Bin_prot.Read.reader
val __bin_read_t__ : (int -> t) Bin_prot.Read.reader
val bin_writer_t : t Bin_prot.Type_class.writer
val bin_reader_t : t Bin_prot.Type_class.reader
val bin_t : t Bin_prot.Type_class.t
include Regular.Std.Printable.S with type t := t
val to_string : t -> string
to_string x
returns a human-readable representation of x
val str : unit -> t -> string
str () t
is formatted output function that matches "%a" conversion format specifier in functions, that prints to string, e.g., sprintf
, failwithf
, errorf
and, surprisingly all Lwt
printing function, including Lwt_io.printf
and logging (or any other function with type ('a,unit,string,...) formatN`. Example:
Or_error.errorf "type %a is not valid for %a"
Type.str ty Exp.str exp
val pps : unit -> t -> string
synonym for str
val ppo : Core_kernel.Out_channel.t -> t -> unit
will print to a standard output_channel
, useful for using in printf
, fprintf
, etc.
val pp_seq : Stdlib.Format.formatter -> t Core_kernel.Sequence.t -> unit
prints a sequence of values of type t
this will include pp
function from Core
that has type t printer
, and can be used in Format.printf
family of functions
include Core_kernel.Pretty_printer.S with type t := t
val pp : Base__.Formatter.t -> t -> unit
include Core_kernel.Comparable.S_binable with type t := t
module Replace_polymorphic_compare : sig ... end
val comparator : (t, comparator_witness) Core_kernel__.Comparator.comparator
module Map : sig ... end
module Set : sig ... end
include Core_kernel.Hashable.S_binable with type t := t
val hash_fold_t :
Ppx_hash_lib.Std.Hash.state ->
t ->
Ppx_hash_lib.Std.Hash.state
val hash : t -> Ppx_hash_lib.Std.Hash.hash_value
val hashable : t Core_kernel__.Hashtbl.Hashable.t
module Table : sig ... end
module Hash_set : sig ... end
module Hash_queue : sig ... end
include Regular.Std.Data.S with type t := t
name,Ver v,desc
information attached to a particular reader or writer.
Data representation version. After any change in data representation the version should be increased.
Serializers that are derived from a data representation must have the same version as a version of the data structure, from which it is derived. This kind of serializers can only read and write data of the same version.
Other serializers can actually read and write data independent on its representation version. A serializer, that can't store data of current version simply shouldn't be added to a set of serializers.
It is assumed, that if a reader and a writer has the same name and version, then whatever was written by the writer should be readable by the reader. The round-trip equality is not required, thus it is acceptable if some information is lost.
It is also possible, that a reader and a writer that has the same name are compatible. In that case it is recommended to use semantic versioning.
val size_in_bytes : ?ver:string -> ?fmt:string -> t -> int
size_in_bytes ?ver ?fmt datum
returns the amount of bytes that is needed to represent datum
in the given format and version
val of_bytes : ?ver:string -> ?fmt:string -> Regular.Std.bytes -> t
of_bytes ?ver ?fmt bytes
deserializes a value from bytes.
val to_bytes : ?ver:string -> ?fmt:string -> t -> Regular.Std.bytes
to_bytes ?ver ?fmt datum
serializes a datum
to a sequence of bytes.
val blit_to_bytes :
?ver:string ->
?fmt:string ->
Regular.Std.bytes ->
t ->
int ->
unit
blit_to_bytes ?ver ?fmt buffer datum offset
copies a serialized representation of datum into a buffer
, starting from the offset
.
val of_bigstring : ?ver:string -> ?fmt:string -> Core_kernel.bigstring -> t
of_bigstring ?ver ?fmt buf
deserializes a datum from bigstring
val to_bigstring : ?ver:string -> ?fmt:string -> t -> Core_kernel.bigstring
of_bigstring ?ver ?fmt datum
serializes a datum to a sequence of bytes represented as bigstring
val blit_to_bigstring :
?ver:string ->
?fmt:string ->
Core_kernel.bigstring ->
t ->
int ->
unit
blit_to_bigstring ?ver ?fmt buffer datum offset
copies a serialized representation of datum into a buffer
, starting from offset
.
module Io : sig ... end
Input/Output functions for the given datum.
module Cache : sig ... end
Data cache.
val add_reader :
?desc:string ->
ver:string ->
string ->
t Regular.Std.reader ->
unit
add_reader ?desc ~ver name reader
registers a new reader
with a provided name
, version ver
and optional description desc
val add_writer :
?desc:string ->
ver:string ->
string ->
t Regular.Std.writer ->
unit
add_writer ?desc ~ver name writer
registers a new writer
with a provided name
, version ver
and optional description desc
val available_readers : unit -> info list
available_reader ()
lists available readers for the data type
val default_reader : unit -> info
default_reader
returns information about default reader
set_default_reader ?ver name
sets new default reader. If version is not specified then the latest available version is used. Raises an exception if a reader with a given name doesn't exist.
with_reader ?ver name operation
temporary sets a default reader to a reader with a specified name and version. The default reader is restored after operation
is finished.
val available_writers : unit -> info list
available_writer ()
lists available writers for the data type
val default_writer : unit -> info
default_writer
returns information about the default writer
set_default_writer ?ver name
sets new default writer. If version is not specified then the latest available version is used. Raises an exception if a writer with a given name doesn't exist.
with_writer ?ver name operation
temporary sets a default writer to a writer with a specified name and version. The default writer is restored after operation
is finished.
val default_printer : unit -> info option
default_writer
optionally returns an information about default printer
set_default_printer ?ver name
sets new default printer. If version is not specified then the latest available version is used. Raises an exception if a printer with a given name doesn't exist.
with_printer ?ver name operation
temporary sets a default printer to a printer with a specified name and version. The default printer is restored after operation
is finished.
val find_reader : ?ver:string -> string -> t Regular.Std.reader option
find_reader ?ver name
lookups a reader with a given name. If version is not specified, then a reader with maximum version is returned.
val find_writer : ?ver:string -> string -> t Regular.Std.writer option
find_writer ?ver name
lookups a writer with a given name. If version is not specified, then a writer with maximum version is returned.
val pp_adt : Stdlib.Format.formatter -> t -> unit