BinFileOps (B2R2)

BinFileOps Module

Namespace: B2R2.FrontEnd.BinFile
Assembly: B2R2.FrontEnd.BinFile.dll

Provides convenience operations over optional capabilities of IBinFile.

Functions and values

Function or value	Description
`BinFileOps.getCodeModeMarkers file` Full Usage: `BinFileOps.getCodeModeMarkers file` Parameters: file : `IBinFile` Returns: `BinCodeModeMarker[]`	Returns the instruction-set mode markers of the given binary file. file : `IBinFile` Returns: `BinCodeModeMarker[]`
`BinFileOps.getCodeSectionPointer file` Full Usage: `BinFileOps.getCodeSectionPointer file` Parameters: file : `IBinFile` Returns: `BinFilePointer`	Returns a pointer to the code section of the given binary file. file : `IBinFile` Returns: `BinFilePointer`
`BinFileOps.getDefaultCodePointer file` Full Usage: `BinFileOps.getDefaultCodePointer file` Parameters: file : `IBinFile` Returns: `BinFilePointer`	Returns the default code pointer for disassembling the given binary file. file : `IBinFile` Returns: `BinFilePointer`
`BinFileOps.getExceptionFrames file` Full Usage: `BinFileOps.getExceptionFrames file` Parameters: file : `IBinFile` Returns: `BinExceptionFrame[]`	Returns all per-function exception frames of the given binary file. file : `IBinFile` Returns: `BinExceptionFrame[]`
`BinFileOps.getFileKind file` Full Usage: `BinFileOps.getFileKind file` Parameters: file : `IBinFile` Returns: `BinFileKind`	Returns the high-level kind of the given binary file. file : `IBinFile` Returns: `BinFileKind`
`BinFileOps.getFunctionAddresses file` Full Usage: `BinFileOps.getFunctionAddresses file` Parameters: file : `IBinFile` Returns: `Addr[]`	Returns known function entry addresses from the given binary file. file : `IBinFile` Returns: `Addr[]`
`BinFileOps.getImports file` Full Usage: `BinFileOps.getImports file` Parameters: file : `IBinFile` Returns: `BinImport[]`	Returns all imported symbols from the given binary file. file : `IBinFile` Returns: `BinImport[]`
`BinFileOps.getInterpreterPath file` Full Usage: `BinFileOps.getInterpreterPath file` Parameters: file : `IBinFile` Returns: `string option`	Returns the path to the dynamic loader/interpreter requested by the given binary file, if any. file : `IBinFile` Returns: `string option`
`BinFileOps.getMemoryMappedRegions file` Full Usage: `BinFileOps.getMemoryMappedRegions file` Parameters: file : `IBinFile` Returns: `AddrRange array`	Returns all memory-mapped regions of the given binary file. file : `IBinFile` Returns: `AddrRange array`
`BinFileOps.getMemoryMappedRegionsByPermission file perm` Full Usage: `BinFileOps.getMemoryMappedRegionsByPermission file perm` Parameters: file : `IBinFile` perm : `Enum` Returns: `AddrRange array`	Returns the memory-mapped regions that carry the given permission. file : `IBinFile` perm : `Enum` Returns: `AddrRange array`
`BinFileOps.getRelocations file` Full Usage: `BinFileOps.getRelocations file` Parameters: file : `IBinFile` Returns: `BinRelocation[]`	Returns all relocations in the given binary file. file : `IBinFile` Returns: `BinRelocation[]`
`BinFileOps.getSectionPointer file name` Full Usage: `BinFileOps.getSectionPointer file name` Parameters: file : `IBinFile` name : `string` Returns: `BinFilePointer`	Returns a pointer to the section with the given name. file : `IBinFile` name : `string` Returns: `BinFilePointer`
`BinFileOps.getSections file` Full Usage: `BinFileOps.getSections file` Parameters: file : `IBinFile` Returns: `BinSection[]`	Returns all binary sections in the given binary file. file : `IBinFile` Returns: `BinSection[]`
`BinFileOps.getSegments file` Full Usage: `BinFileOps.getSegments file` Parameters: file : `IBinFile` Returns: `BinSegment[]`	Returns all memory-mapped segments of the given binary file. file : `IBinFile` Returns: `BinSegment[]`
`BinFileOps.getSymbols file` Full Usage: `BinFileOps.getSymbols file` Parameters: file : `IBinFile` Returns: `BinSymbol[]`	Returns all symbols in the given binary file. file : `IBinFile` Returns: `BinSymbol[]`
`BinFileOps.isCoreDump file` Full Usage: `BinFileOps.isCoreDump file` Parameters: file : `IBinFile` Returns: `bool`	Checks whether the given binary file is a core dump. file : `IBinFile` Returns: `bool`
`BinFileOps.isExecutable file` Full Usage: `BinFileOps.isExecutable file` Parameters: file : `IBinFile` Returns: `bool`	Checks whether the given binary file is an executable program. file : `IBinFile` Returns: `bool`
`BinFileOps.isInImportTable file addr` Full Usage: `BinFileOps.isInImportTable file addr` Parameters: file : `IBinFile` addr : `Addr` Returns: `bool`	Checks if the given address falls within the import table. file : `IBinFile` addr : `Addr` Returns: `bool`
`BinFileOps.isObjectFile file` Full Usage: `BinFileOps.isObjectFile file` Parameters: file : `IBinFile` Returns: `bool`	Checks whether the given binary file is a relocatable object file. file : `IBinFile` Returns: `bool`
`BinFileOps.isRelocationAddr file addr` Full Usage: `BinFileOps.isRelocationAddr file addr` Parameters: file : `IBinFile` addr : `Addr` Returns: `bool`	Checks if the given address has relocation information. file : `IBinFile` addr : `Addr` Returns: `bool`
`BinFileOps.isSharedLibrary file` Full Usage: `BinFileOps.isSharedLibrary file` Parameters: file : `IBinFile` Returns: `bool`	Checks whether the given binary file is a shared library. file : `IBinFile` Returns: `bool`
`BinFileOps.isStripped file` Full Usage: `BinFileOps.isStripped file` Parameters: file : `IBinFile` Returns: `bool`	Checks whether the given binary lacks its non-essential symbol table. file : `IBinFile` Returns: `bool`
`BinFileOps.sliceByOffset file offset len` Full Usage: `BinFileOps.sliceByOffset file offset len` Parameters: file : `IBinFile` offset : `int` len : `int` Returns: `ReadOnlySpan<byte>`	Slices the given binary file into a span of bytes of the specified length starting from the specified file offset. Raises InvalidAddrReadException when the requested region falls outside the file content. file : `IBinFile` offset : `int` len : `int` Returns: `ReadOnlySpan<byte>`
`BinFileOps.tryFindSectionByAddr file addr` Full Usage: `BinFileOps.tryFindSectionByAddr file addr` Parameters: file : `IBinFile` addr : `Addr` Returns: `Result<BinSection, ErrorCase>`	Tries to find the section containing the given address. file : `IBinFile` addr : `Addr` Returns: `Result<BinSection, ErrorCase>`
`BinFileOps.tryFindSectionByName file name` Full Usage: `BinFileOps.tryFindSectionByName file name` Parameters: file : `IBinFile` name : `string` Returns: `Result<BinSection, ErrorCase>`	Tries to find the section whose name matches the given name. file : `IBinFile` name : `string` Returns: `Result<BinSection, ErrorCase>`
`BinFileOps.tryFindSectionByOffset file offset` Full Usage: `BinFileOps.tryFindSectionByOffset file offset` Parameters: file : `IBinFile` offset : `uint32` Returns: `Result<BinSection, ErrorCase>`	Tries to find the section containing the given file offset. file : `IBinFile` offset : `uint32` Returns: `Result<BinSection, ErrorCase>`
`BinFileOps.tryFindSectionNameByAddr file addr` Full Usage: `BinFileOps.tryFindSectionNameByAddr file addr` Parameters: file : `IBinFile` addr : `Addr` Returns: `Result<string, ErrorCase>`	Tries to find the section name containing the given address. file : `IBinFile` addr : `Addr` Returns: `Result<string, ErrorCase>`
`BinFileOps.tryFindSectionNameByOffset file offset` Full Usage: `BinFileOps.tryFindSectionNameByOffset file offset` Parameters: file : `IBinFile` offset : `uint32` Returns: `Result<string, ErrorCase>`	Tries to find the section name containing the given file offset. file : `IBinFile` offset : `uint32` Returns: `Result<string, ErrorCase>`
`BinFileOps.tryFindSymbolByAddr file addr` Full Usage: `BinFileOps.tryFindSymbolByAddr file addr` Parameters: file : `IBinFile` addr : `Addr` Returns: `Result<BinSymbol, ErrorCase>`	Tries to find the symbol located at the given address. file : `IBinFile` addr : `Addr` Returns: `Result<BinSymbol, ErrorCase>`
`BinFileOps.tryGetInternalFunctionAddr file relocAddr` Full Usage: `BinFileOps.tryGetInternalFunctionAddr file relocAddr` Parameters: file : `IBinFile` relocAddr : `Addr` Returns: `Result<Addr, ErrorCase>`	Tries to resolve the relocation at the given address to an internal function defined within the given binary file itself. file : `IBinFile` relocAddr : `Addr` Returns: `Result<Addr, ErrorCase>`
`BinFileOps.tryGetRelocatedAddr file relocAddr` Full Usage: `BinFileOps.tryGetRelocatedAddr file relocAddr` Parameters: file : `IBinFile` relocAddr : `Addr` Returns: `Result<Addr, ErrorCase>`	Tries to find the relocated target address of the given address. file : `IBinFile` relocAddr : `Addr` Returns: `Result<Addr, ErrorCase>`
`BinFileOps.tryResolveName file addr` Full Usage: `BinFileOps.tryResolveName file addr` Parameters: file : `IBinFile` addr : `Addr` Returns: `Result<string, ErrorCase>`	Tries to resolve the symbolic name associated with the given address. file : `IBinFile` addr : `Addr` Returns: `Result<string, ErrorCase>`