package bap-std
Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=63ada71fa4f602bd679174dc6bf780d54aeded40ad4ec20d256df15886e3d2d5
md5=b8b1aff8c6846f2213eafc54de07b304
doc/bap/Bap/Std/Arch/index.html
Module Std.Arch
Architecture
val bin_size_x86 : x86 Core_kernel.Bin_prot.Size.sizerval bin_write_x86 : x86 Core_kernel.Bin_prot.Write.writerval bin_writer_x86 : x86 Core_kernel.Bin_prot.Type_class.writerval bin_read_x86 : x86 Core_kernel.Bin_prot.Read.readerval __bin_read_x86__ : (int -> x86) Core_kernel.Bin_prot.Read.readerval bin_reader_x86 : x86 Core_kernel.Bin_prot.Type_class.readerval bin_x86 : x86 Core_kernel.Bin_prot.Type_class.tval all_of_x86 : x86 listval sexp_of_x86 : x86 -> Ppx_sexp_conv_lib.Sexp.tval x86_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> x86val __x86_of_sexp__ : Ppx_sexp_conv_lib.Sexp.t -> x86val bin_size_arm : arm Core_kernel.Bin_prot.Size.sizerval bin_write_arm : arm Core_kernel.Bin_prot.Write.writerval bin_writer_arm : arm Core_kernel.Bin_prot.Type_class.writerval bin_read_arm : arm Core_kernel.Bin_prot.Read.readerval __bin_read_arm__ : (int -> arm) Core_kernel.Bin_prot.Read.readerval bin_reader_arm : arm Core_kernel.Bin_prot.Type_class.readerval bin_arm : arm Core_kernel.Bin_prot.Type_class.tval all_of_arm : arm listval sexp_of_arm : arm -> Ppx_sexp_conv_lib.Sexp.tval arm_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> armval __arm_of_sexp__ : Ppx_sexp_conv_lib.Sexp.t -> armval bin_size_armeb : armeb Core_kernel.Bin_prot.Size.sizerval bin_write_armeb : armeb Core_kernel.Bin_prot.Write.writerval bin_writer_armeb : armeb Core_kernel.Bin_prot.Type_class.writerval bin_read_armeb : armeb Core_kernel.Bin_prot.Read.readerval __bin_read_armeb__ : (int -> armeb) Core_kernel.Bin_prot.Read.readerval bin_reader_armeb : armeb Core_kernel.Bin_prot.Type_class.readerval bin_armeb : armeb Core_kernel.Bin_prot.Type_class.tval all_of_armeb : armeb listval sexp_of_armeb : armeb -> Ppx_sexp_conv_lib.Sexp.tval armeb_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> armebval __armeb_of_sexp__ : Ppx_sexp_conv_lib.Sexp.t -> armebval bin_size_thumb : thumb Core_kernel.Bin_prot.Size.sizerval bin_write_thumb : thumb Core_kernel.Bin_prot.Write.writerval bin_writer_thumb : thumb Core_kernel.Bin_prot.Type_class.writerval bin_read_thumb : thumb Core_kernel.Bin_prot.Read.readerval __bin_read_thumb__ : (int -> thumb) Core_kernel.Bin_prot.Read.readerval bin_reader_thumb : thumb Core_kernel.Bin_prot.Type_class.readerval bin_thumb : thumb Core_kernel.Bin_prot.Type_class.tval all_of_thumb : thumb listval sexp_of_thumb : thumb -> Ppx_sexp_conv_lib.Sexp.tval thumb_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> thumbval __thumb_of_sexp__ : Ppx_sexp_conv_lib.Sexp.t -> thumbval bin_size_thumbeb : thumbeb Core_kernel.Bin_prot.Size.sizerval bin_write_thumbeb : thumbeb Core_kernel.Bin_prot.Write.writerval bin_writer_thumbeb : thumbeb Core_kernel.Bin_prot.Type_class.writerval bin_read_thumbeb : thumbeb Core_kernel.Bin_prot.Read.readerval __bin_read_thumbeb__ : (int -> thumbeb) Core_kernel.Bin_prot.Read.readerval bin_reader_thumbeb : thumbeb Core_kernel.Bin_prot.Type_class.readerval bin_thumbeb : thumbeb Core_kernel.Bin_prot.Type_class.tval all_of_thumbeb : thumbeb listval sexp_of_thumbeb : thumbeb -> Ppx_sexp_conv_lib.Sexp.tval thumbeb_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> thumbebval __thumbeb_of_sexp__ : Ppx_sexp_conv_lib.Sexp.t -> thumbebval bin_size_aarch64 : aarch64 Core_kernel.Bin_prot.Size.sizerval bin_write_aarch64 : aarch64 Core_kernel.Bin_prot.Write.writerval bin_writer_aarch64 : aarch64 Core_kernel.Bin_prot.Type_class.writerval bin_read_aarch64 : aarch64 Core_kernel.Bin_prot.Read.readerval __bin_read_aarch64__ : (int -> aarch64) Core_kernel.Bin_prot.Read.readerval bin_reader_aarch64 : aarch64 Core_kernel.Bin_prot.Type_class.readerval bin_aarch64 : aarch64 Core_kernel.Bin_prot.Type_class.tval all_of_aarch64 : aarch64 listval sexp_of_aarch64 : aarch64 -> Ppx_sexp_conv_lib.Sexp.tval aarch64_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> aarch64val __aarch64_of_sexp__ : Ppx_sexp_conv_lib.Sexp.t -> aarch64val bin_size_ppc : ppc Core_kernel.Bin_prot.Size.sizerval bin_write_ppc : ppc Core_kernel.Bin_prot.Write.writerval bin_writer_ppc : ppc Core_kernel.Bin_prot.Type_class.writerval bin_read_ppc : ppc Core_kernel.Bin_prot.Read.readerval __bin_read_ppc__ : (int -> ppc) Core_kernel.Bin_prot.Read.readerval bin_reader_ppc : ppc Core_kernel.Bin_prot.Type_class.readerval bin_ppc : ppc Core_kernel.Bin_prot.Type_class.tval all_of_ppc : ppc listval sexp_of_ppc : ppc -> Ppx_sexp_conv_lib.Sexp.tval ppc_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> ppcval __ppc_of_sexp__ : Ppx_sexp_conv_lib.Sexp.t -> ppcval bin_size_mips : mips Core_kernel.Bin_prot.Size.sizerval bin_write_mips : mips Core_kernel.Bin_prot.Write.writerval bin_writer_mips : mips Core_kernel.Bin_prot.Type_class.writerval bin_read_mips : mips Core_kernel.Bin_prot.Read.readerval __bin_read_mips__ : (int -> mips) Core_kernel.Bin_prot.Read.readerval bin_reader_mips : mips Core_kernel.Bin_prot.Type_class.readerval bin_mips : mips Core_kernel.Bin_prot.Type_class.tval all_of_mips : mips listval sexp_of_mips : mips -> Ppx_sexp_conv_lib.Sexp.tval mips_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> mipsval __mips_of_sexp__ : Ppx_sexp_conv_lib.Sexp.t -> mipsval bin_size_sparc : sparc Core_kernel.Bin_prot.Size.sizerval bin_write_sparc : sparc Core_kernel.Bin_prot.Write.writerval bin_writer_sparc : sparc Core_kernel.Bin_prot.Type_class.writerval bin_read_sparc : sparc Core_kernel.Bin_prot.Read.readerval __bin_read_sparc__ : (int -> sparc) Core_kernel.Bin_prot.Read.readerval bin_reader_sparc : sparc Core_kernel.Bin_prot.Type_class.readerval bin_sparc : sparc Core_kernel.Bin_prot.Type_class.tval all_of_sparc : sparc listval sexp_of_sparc : sparc -> Ppx_sexp_conv_lib.Sexp.tval sparc_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> sparcval __sparc_of_sexp__ : Ppx_sexp_conv_lib.Sexp.t -> sparcval bin_size_nvptx : nvptx Core_kernel.Bin_prot.Size.sizerval bin_write_nvptx : nvptx Core_kernel.Bin_prot.Write.writerval bin_writer_nvptx : nvptx Core_kernel.Bin_prot.Type_class.writerval bin_read_nvptx : nvptx Core_kernel.Bin_prot.Read.readerval __bin_read_nvptx__ : (int -> nvptx) Core_kernel.Bin_prot.Read.readerval bin_reader_nvptx : nvptx Core_kernel.Bin_prot.Type_class.readerval bin_nvptx : nvptx Core_kernel.Bin_prot.Type_class.tval all_of_nvptx : nvptx listval sexp_of_nvptx : nvptx -> Ppx_sexp_conv_lib.Sexp.tval nvptx_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> nvptxval __nvptx_of_sexp__ : Ppx_sexp_conv_lib.Sexp.t -> nvptxval bin_size_hexagon : hexagon Core_kernel.Bin_prot.Size.sizerval bin_write_hexagon : hexagon Core_kernel.Bin_prot.Write.writerval bin_writer_hexagon : hexagon Core_kernel.Bin_prot.Type_class.writerval bin_read_hexagon : hexagon Core_kernel.Bin_prot.Read.readerval __bin_read_hexagon__ : (int -> hexagon) Core_kernel.Bin_prot.Read.readerval bin_reader_hexagon : hexagon Core_kernel.Bin_prot.Type_class.readerval bin_hexagon : hexagon Core_kernel.Bin_prot.Type_class.tval all_of_hexagon : hexagon listval sexp_of_hexagon : hexagon -> Ppx_sexp_conv_lib.Sexp.tval hexagon_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> hexagonval __hexagon_of_sexp__ : Ppx_sexp_conv_lib.Sexp.t -> hexagonval bin_size_r600 : r600 Core_kernel.Bin_prot.Size.sizerval bin_write_r600 : r600 Core_kernel.Bin_prot.Write.writerval bin_writer_r600 : r600 Core_kernel.Bin_prot.Type_class.writerval bin_read_r600 : r600 Core_kernel.Bin_prot.Read.readerval __bin_read_r600__ : (int -> r600) Core_kernel.Bin_prot.Read.readerval bin_reader_r600 : r600 Core_kernel.Bin_prot.Type_class.readerval bin_r600 : r600 Core_kernel.Bin_prot.Type_class.tval all_of_r600 : r600 listval sexp_of_r600 : r600 -> Ppx_sexp_conv_lib.Sexp.tval r600_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> r600val __r600_of_sexp__ : Ppx_sexp_conv_lib.Sexp.t -> r600val bin_size_systemz : systemz Core_kernel.Bin_prot.Size.sizerval bin_write_systemz : systemz Core_kernel.Bin_prot.Write.writerval bin_writer_systemz : systemz Core_kernel.Bin_prot.Type_class.writerval bin_read_systemz : systemz Core_kernel.Bin_prot.Read.readerval __bin_read_systemz__ : (int -> systemz) Core_kernel.Bin_prot.Read.readerval bin_reader_systemz : systemz Core_kernel.Bin_prot.Type_class.readerval bin_systemz : systemz Core_kernel.Bin_prot.Type_class.tval all_of_systemz : systemz listval sexp_of_systemz : systemz -> Ppx_sexp_conv_lib.Sexp.tval systemz_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> systemzval __systemz_of_sexp__ : Ppx_sexp_conv_lib.Sexp.t -> systemzval bin_size_xcore : xcore Core_kernel.Bin_prot.Size.sizerval bin_write_xcore : xcore Core_kernel.Bin_prot.Write.writerval bin_writer_xcore : xcore Core_kernel.Bin_prot.Type_class.writerval bin_read_xcore : xcore Core_kernel.Bin_prot.Read.readerval __bin_read_xcore__ : (int -> xcore) Core_kernel.Bin_prot.Read.readerval bin_reader_xcore : xcore Core_kernel.Bin_prot.Type_class.readerval bin_xcore : xcore Core_kernel.Bin_prot.Type_class.tval all_of_xcore : xcore listval sexp_of_xcore : xcore -> Ppx_sexp_conv_lib.Sexp.tval xcore_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> xcoreval __xcore_of_sexp__ : Ppx_sexp_conv_lib.Sexp.t -> xcoreval bin_size_unknown : unknown Core_kernel.Bin_prot.Size.sizerval bin_write_unknown : unknown Core_kernel.Bin_prot.Write.writerval bin_writer_unknown : unknown Core_kernel.Bin_prot.Type_class.writerval bin_read_unknown : unknown Core_kernel.Bin_prot.Read.readerval __bin_read_unknown__ : (int -> unknown) Core_kernel.Bin_prot.Read.readerval bin_reader_unknown : unknown Core_kernel.Bin_prot.Type_class.readerval bin_unknown : unknown Core_kernel.Bin_prot.Type_class.tval all_of_unknown : unknown listval sexp_of_unknown : unknown -> Ppx_sexp_conv_lib.Sexp.tval unknown_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> unknownval __unknown_of_sexp__ : Ppx_sexp_conv_lib.Sexp.t -> unknowninclude Core_kernel.Bin_prot.Binable.S with type t := t
val all : t listval __t_of_sexp__ : Ppx_sexp_conv_lib.Sexp.t -> tval of_string : string -> t optionof_string s will try to be clever and to capture all commonly known synonyms, e.g., of_string "i686" will work
val slot : (Bap_core_theory.Theory.program, t) Bap_knowledge.Knowledge.slotthe architecture (ISA) of a program.
val unit_slot :
(Bap_core_theory.Theory.Unit.cls, t) Bap_knowledge.Knowledge.slotunit_slot the arch property of the unit.
Use this slot to enable backward compatibility of the Arch.t type with the Theory.Target.t by registering a promise that translates Theory.Target.t to Arch.t.
Example,
let target = Theory.Target.declare ~package:"foo" "r600"
let () = KB.promise Arch.unit_slot @@ fun unit ->
KB.collect Theory.Unit.target >>| fun t ->
if Theory.Target.equal t target then `r600
else `unknownarch type implements Regular interface
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.sizerval bin_write_t : t Bin_prot.Write.writerval bin_read_t : t Bin_prot.Read.readerval __bin_read_t__ : (int -> t) Bin_prot.Read.readerval bin_writer_t : t Bin_prot.Type_class.writerval bin_reader_t : t Bin_prot.Type_class.readerval bin_t : t Bin_prot.Type_class.tinclude Regular.Std.Printable.S with type t := t
val to_string : t -> stringto_string x returns a human-readable representation of x
val str : unit -> t -> stringstr () 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 expval pps : unit -> t -> stringsynonym for str
val ppo : Core_kernel.Out_channel.t -> t -> unitwill print to a standard output_channel, useful for using in printf, fprintf, etc.
val pp_seq : Format.formatter -> t Core_kernel.Sequence.t -> unitprints 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 -> unitinclude Core_kernel.Comparable.S_binable with type t := t
include Base.Comparable.S with type t := t
compare t1 t2 returns 0 if t1 is equal to t2, a negative integer if t1 is less than t2, and a positive integer if t1 is greater than t2.
ascending is identical to compare. descending x y = ascending y x. These are intended to be mnemonic when used like List.sort ~compare:ascending and List.sort ~cmp:descending, since they cause the list to be sorted in ascending or descending order, respectively.
clamp_exn t ~min ~max returns t', the closest value to t such that between t' ~low:min ~high:max is true.
Raises if not (min <= max).
module Replace_polymorphic_compare :
Base.Comparable.Polymorphic_compare with type t := tval comparator : (t, comparator_witness) Base__.Comparator.comparatormodule Map :
Core_kernel.Map.S_binable
with type Key.t = t
with type Key.comparator_witness = comparator_witnessmodule Set :
Core_kernel.Set.S_binable
with type Elt.t = t
with type Elt.comparator_witness = comparator_witnessinclude 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.stateval hash : t -> Ppx_hash_lib.Std.Hash.hash_valueval hashable : t Core_kernel.Hashtbl.Hashable.tmodule Table : Core_kernel.Hashtbl.S_binable with type key = tmodule Hash_set : Core_kernel.Hash_set.S_binable with type elt = tmodule Hash_queue : Core_kernel.Hash_queue.S with type key = tinclude 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 -> intsize_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 -> tof_bytes ?ver ?fmt bytes deserializes a value from bytes.
val to_bytes : ?ver:string -> ?fmt:string -> t -> Regular.Std.bytesto_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 ->
unitblit_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 -> tof_bigstring ?ver ?fmt buf deserializes a datum from bigstring
val to_bigstring : ?ver:string -> ?fmt:string -> t -> Core_kernel.bigstringof_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 ->
unitblit_to_bigstring ?ver ?fmt buffer datum offset copies a serialized representation of datum into a buffer, starting from offset.
module Io : sig ... endInput/Output functions for the given datum.
module Cache : sig ... endData cache.
val add_reader :
?desc:string ->
ver:string ->
string ->
t Regular.Std.reader ->
unitadd_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 ->
unitadd_writer ?desc ~ver name writer registers a new writer with a provided name, version ver and optional description desc
val available_readers : unit -> info listavailable_reader () lists available readers for the data type
val default_reader : unit -> infodefault_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 listavailable_writer () lists available writers for the data type
val default_writer : unit -> infodefault_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 optiondefault_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.
Low level access to serializers
val find_reader : ?ver:string -> string -> t Regular.Std.reader optionfind_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 optionfind_writer ?ver name lookups a writer with a given name. If version is not specified, then a writer with maximum version is returned.