Addresses are represented with a 64-bit integer in B2R2.

AddrRange is a tuple (min, max) that represents a range of address values that are greater or equal to the min value (inclusive) and are less than or equal to the max value (inclusive). To access the min and the max value of a range, use either getMin or getMax function.

Architecture types.

A helper module for ArchOperationMode.

Some ISA, such as ARM, have their own operation mode, which can vary at runtime. For example, ARM architecture can switch between Thumb and ARM mode. ArchOperationMode decides which mode to consider at the time of parsing/lifting machine instructions.

This is a helper class for manipulating an ARMap (AddressRangeMap), a non-overlapping interval map. We provide both F#- and C#-style APIs.

This is a non-overlapping interval map that we call "Address Range Map" (ARMap). This map internally forms a red-black tree, which follows the implementation of the paper written by Kimball Germane and Matthew Might: "Deletion: The Curse of the Red-Black Tree", Journal of Functional Programming, vol. 24, no. 4, 2014.

Extended Array.

B2R2 project attribution.

Extended BigInteger.

BinReader abstracts away the process of reading byte sequences. This is the base class for BinReader, which has two kinds of implementations: little-endian and big-endian BinReader.

BitVector is the fundamental data type for binary code, which is essentially a bit vector. We want the size of a bit vector to be less than or equal to 64 bits because bigint operation is slow, and most arithmetics on modern architectures are in 64 bits any ways. For example, SIMD operations can also be divided into a set of 64-bit operations. N.B. Num becomes zero when the Length becomes greater than 64. We intentionally do not sync Num and BigNum.

This is a BitVector with its length less than or equal to 64. This is preferred because all the operations will be much faster than BitVectorBig.

This is a BitVector with its length less than or equal to 64. This is preferred because all the operations will be much faster than BitVectorBig.

It is sometimes convenient to consider a binary chunk as a byte array. This module provides several useful functions to deal with byte arrays.

Represents a byte pattern.

ConsoleCachedPrinter prints out non-colored strings only when the Flush method is called. All the colored strings will be normalized to plain strings. It will simply stack up all the output candidates before Flush is called. This is useful for performance-critical applications.

ConsoleCachedPrinter does not print anything. This is the same as redirecting outputs to /dev/null.

ConsolePrinter simply prints out strings to console whenever a print method is called. This printer does not perform any caching, so it immediately flushes out all the strings to console.

Empty BinReader, representing a null type.

Empty register set.

A helper module for Endian type.

Endianness.

Error cases and corresponding numbers for B2R2.

A helper module for FileFormat type.

Types of binary file format.

Log to a file.

This is a cacheable operation, which will be executed when there's no already cached item.

Basic logging facility.

Extended Int64.

Helper module for IntervalMap.

Interval-tree-based map, which maps an interval of type (AddrRange) to an IntervalMapElement ('a).

An element for our interval map.

Helper module for IntervalSet.

Interval tree-based set, which stores intervals (AddrRange) that can overlap unlike ARMap.

An element for our interval set.

Raised when an AddrRange has the same Min and Max value, i.e., for invalid interval.

Raised when an invalid Endian value is used.

Raised when an invalid ISA is given as a parameter.

This exception is raised when an invalid RegType is encountered.

Raised when an invalid ArchOperationMode is given.

This exception is raised when an invalid WordSize is encountered.

Instruction Set Architecture (ISA).

Raised when LEB128 decoding failed, e.g., when the given input bytes has incorrect encoding.

Linux syscall type.

Helper module for LogLevel

How verbose do we want to log messages?

Least Recently Used Cache supporting concurrency. The capacity decides how many entries to store.

Non-empty register set.

Extended Option.

A helper module for OS type.

Specify OS type.

OutString represents an output string generated from rear-end applications.

Persistent queue using two lists.

Any B2R2's layers should *not* use System.Console or `printfn` to directly output strings. Instead, they should resort to the Printer to "indirectly" print out strings.

A program point (ProgramPoint) is a fine-grained location in a program, which can point to a specific IR statement. We represent it as a tuple: (Address of the instruction, Index of the IR stmt for the instruction).

A helper module for RandomAccessQueue<'a>.

Interval tree-based map: an interval of type (Addr) -> an RandomAccessQueueElement ('a).

An element for our random access queue.

Raised when there is an overlapping intervals from the interval tree.

This class stores an identifier for a register. Each register in B2R2 has its own ID, which is essentially an integer value. However, one needs to go through this class to use a RegisterID.

RegisterID is a platform-independent representation of a register.

A helper module for RegisterSet.

RegisterSet is an efficient set data structure using arrays for managing a set of registers.

A tag used in RegisterSet for identifying distinct set of registers for different ISAs.

Raised when two RegisterSets with two distinct tags operate.

A helper for RegType.

Types that a register can have. This essentially means how many bits are in the register.

Extended Result.

A unit for RegType.

Extended String.

Define a column of a table with a specified width in bytes (# of chars).

Define a output configuration of a table.

Raised when unhandled syscall is encountered.

Raised when unknown OS type is detected.

A set of convenient misc. functions.

A helper module for the WordSize type.

B2R2 represents the word size of a CPU with WordSize, which can be either 32- or 64-bit.