IContentAddressable (B2R2)

IContentAddressable Type

Namespace: B2R2.FrontEnd.BinFile
Assembly: B2R2.FrontEnd.BinFile.dll
Base Type: obj
All Interfaces: IContentAddressable

Can be used to access the binary content of a file via a virtual address or a file offset.

Instance members

Instance member Description


                
                  
                    
                      this.GetNotInFileIntervals

Full Usage: this.GetNotInFileIntervals

Parameters:

arg0 : AddrRange

Returns: AddrRange[] Returns an empty list when the given range r is valid, i.e., `IsInFileRange r = true`.
Modifiers: abstract

Given a range r, return a list of address ranges (intervals) that are within r and not in-file.

arg0 : AddrRange

Returns: AddrRange[]: Returns an empty list when the given range r is valid, i.e., `IsInFileRange r = true`.


                
                  
                    
                      this.GetOffset

Full Usage: this.GetOffset

Parameters:

addr : Addr - Virtual address.

Returns: int Returns an offset to the binary for a given virtual address.
Modifiers: abstract

Translate a virtual address into a relative offset to the binary file.

addr : Addr: Virtual address.

Returns: int: Returns an offset to the binary for a given virtual address.

InvalidAddrReadException

Thrown when the given address is out of a valid address range.


                
                  
                    
                      this.IsExecutableAddr

Full Usage: this.IsExecutableAddr

Parameters:

arg0 : Addr

Returns: bool Returns true if the address is executable, false otherwise.
Modifiers: abstract

Check if the given address is executable address for this binary. We say a given address is executable if the address is within an executable segment. Note we consider the addresses of known read-only sections (such as .rodata) as non-executable, even though those sections are within an executable segment. For object files, we simply consider a .text section's address range as executable.

arg0 : Addr

Returns: bool: Returns true if the address is executable, false otherwise.


                
                  
                    
                      this.IsInFileAddr

Full Usage: this.IsInFileAddr

Parameters:

arg0 : Addr

Returns: bool Returns true if the address is within a mapped address range, false otherwise.
Modifiers: abstract

Check if the given address is valid and there is an actual mapping from the associated binary file to the corresponding memory. Unlike IsValidAddr, this function checks if we can decide the actual value of the given address from the binary. For example, a program header of an ELF file may contain 100 bytes in size, but when it is mapped to a segment in memory, the size of the segment can be larger than the size of the program header. This function checks if the given address is in the range of the segment that has a direct mapping to the file's program header.

arg0 : Addr

Returns: bool: Returns true if the address is within a mapped address range, false otherwise.


                
                  
                    
                      this.IsInFileRange

Full Usage: this.IsInFileRange

Parameters:

arg0 : AddrRange

Returns: bool Returns true if the whole range of addresses is within a valid range, false otherwise.
Modifiers: abstract

Check if the given address range is valid and there exists a corresponding region in the actual binary file. This function returns true only if the whole range of the addressess are valid (for every address in the range, IsInFileAddr should return true).

arg0 : AddrRange

Returns: bool: Returns true if the whole range of addresses is within a valid range, false otherwise.


                
                  
                    
                      this.IsValidAddr

Full Usage: this.IsValidAddr

Parameters:

arg0 : Addr

Returns: bool Returns true if the address is within a valid range, false otherwise.
Modifiers: abstract

Check if the given address is valid for the associated binary. We say a given address is valid for the binary if the address is within the range of statically computable segment ranges.

arg0 : Addr

Returns: bool: Returns true if the address is within a valid range, false otherwise.


                
                  
                    
                      this.IsValidRange

Full Usage: this.IsValidRange

Parameters:

arg0 : AddrRange

Returns: bool Returns true if the whole range of addresses is within a valid range, false otherwise.
Modifiers: abstract

Check if the given address range is valid. This function returns true only if the whole range of the addressess are valid (for every address in the range, IsValidAddr should return true).

arg0 : AddrRange

Returns: bool: Returns true if the whole range of addresses is within a valid range, false otherwise.


                
                  
                    
                      this.ReadByte

Full Usage: this.ReadByte

Parameters:

ptr : BinFilePointer

Returns: byte
Modifiers: abstract

Read a byte pointed to by the given binary file pointer.

ptr : BinFilePointer

Returns: byte


                
                  
                    
                      this.ReadByte

Full Usage: this.ReadByte

Parameters:

offset : int

Returns: byte
Modifiers: abstract

Read a byte pointed to by the given file `offset`.

offset : int

Returns: byte


                
                  
                    
                      this.ReadByte

Full Usage: this.ReadByte

Parameters:

addr : Addr

Returns: byte
Modifiers: abstract

Read a byte at the given virtual address.

addr : Addr

Returns: byte

Full Usage: this.Slice

Parameters:

ptr : BinFilePointer

Returns: ByteSpan
Modifiers: abstract

Slice a maximum possible portion of the associated binary file based on the given virtual `addr`.

ptr : BinFilePointer

Returns: ByteSpan

Full Usage: this.Slice

Parameters:

ptr : BinFilePointer

size : int

Returns: ByteSpan
Modifiers: abstract

Slice a portion of the associated binary file based on the given pointer `ptr` and its `size`.

ptr : BinFilePointer
size : int

Returns: ByteSpan

Full Usage: this.Slice

Parameters:

offset : int

Returns: ByteSpan
Modifiers: abstract

Slice a maximum possible portion of the associated binary file based on the given file `offset`.

offset : int

Returns: ByteSpan

Full Usage: this.Slice

Parameters:

offset : int

size : int

Returns: ByteSpan
Modifiers: abstract

Slice a portion of the associated binary file based on the given file `offset` and its `size`.

offset : int
size : int

Returns: ByteSpan

Full Usage: this.Slice

Parameters:

addr : Addr

Returns: ByteSpan
Modifiers: abstract

Slice a maximum possible portion of the associated binary file based on the given virtual `addr`.

addr : Addr

Returns: ByteSpan

Full Usage: this.Slice

Parameters:

addr : Addr

size : int

Returns: ByteSpan
Modifiers: abstract

Slice a portion of the associated binary file based on the given virtual `addr` and its `size`.

addr : Addr
size : int

Returns: ByteSpan


                
                  
                    
                      this.ToBinFilePointer

Full Usage: this.ToBinFilePointer

Parameters:

arg0 : string

Returns: BinFilePointer
Modifiers: abstract

Convert the section of the name (string) into a binary pointer, which can exclusively point to binary contents of the section.

arg0 : string

Returns: BinFilePointer


                
                  
                    
                      this.ToBinFilePointer

Full Usage: this.ToBinFilePointer

Parameters:

arg0 : Addr

Returns: BinFilePointer
Modifiers: abstract

Convert the section at the address (Addr) into a binary pointer, which can exclusively point to binary contents of the section.

arg0 : Addr

Returns: BinFilePointer