API Documentation#
- Loader Interface
LoaderLoader.__init__()Loader.main_objectLoader.memoryLoader.tlsLoader.close()Loader.max_addrLoader.min_addrLoader.initializersLoader.finalizersLoader.linux_loader_objectLoader.elfcore_objectLoader.extern_objectLoader.kernel_objectLoader.all_elf_objectsLoader.all_pe_objectsLoader.missing_dependenciesLoader.auto_load_libsLoader.describe_addr()Loader.find_object()Loader.find_object_containing()Loader.find_segment_containing()Loader.find_section_containing()Loader.find_loadable_containing()Loader.find_section_next_to()Loader.find_symbol()Loader.symbolsLoader.find_all_symbols()Loader.find_plt_stub_name()Loader.find_relevant_relocations()Loader.perform_irelative_relocs()Loader.dynamic_load()Loader.get_loader_symbolic_constraints()Loader.fast_memory_load_pointer()
- Backend Interface
FunctionHintSourceFunctionHintExceptionHandlingBackendBackend.is_defaultBackend.__init__()Backend.archBackend.loaderBackend.close()Backend.set_arch()Backend.image_base_deltaBackend.entryBackend.segmentsBackend.sectionsBackend.symbols_by_addrBackend.rebase()Backend.relocate()Backend.contains_addr()Backend.find_loadable_containing()Backend.find_segment_containing()Backend.find_section_containing()Backend.addr_to_offset()Backend.offset_to_addr()Backend.min_addrBackend.max_addrBackend.initializersBackend.finalizersBackend.threadsBackend.thread_registers()Backend.initial_register_values()Backend.get_symbol()Backend.extract_soname()Backend.is_compatible()Backend.check_compatibility()Backend.check_magic_compatibility()
register_backend()SymbolTypeSymbolSubTypeSymbolRegionsRegionSegmentEmptySegmentSectionNamedRegionNamedRegion.is_defaultNamedRegion.__init__()NamedRegion.has_memoryNamedRegion.is_compatible()NamedRegion.min_addrNamedRegion.max_addrNamedRegion.function_name()NamedRegion.contains_addr()NamedRegion.check_compatibility()NamedRegion.importsNamedRegion.relocsNamedRegion.child_objectsNamedRegion.exception_handlingsNamedRegion.function_hintsNamedRegion.memory
ExternSegmentTOCRelocationExternObjectExternObject.__init__()ExternObject.rebase()ExternObject.make_extern()ExternObject.get_pseudo_addr()ExternObject.allocate()ExternObject.max_addrExternObject.make_import()ExternObject.importsExternObject.relocsExternObject.child_objectsExternObject.exception_handlingsExternObject.function_hintsExternObject.memory
KernelObjectPointToPreciseSimDatalookup()register()SimDataregister()lookup()StaticDataStaticWordPointToSimDataSimpleRelocation
- Backends
- ELF
ELFELF.is_defaultELF.__init__()ELF.importsELF.relocsELF.close()ELF.check_compatibility()ELF.check_magic_compatibility()ELF.is_compatible()ELF.extract_arch()ELF.initializersELF.finalizersELF.symbols_by_nameELF.get_symbol()ELF.rebase()ELF.child_objectsELF.exception_handlingsELF.function_hintsELF.memory
ELFCoreMetaELFRelroELFSymbolELFSymbolTypeELFSymbolType.STT_NOTYPEELFSymbolType.STT_OBJECTELFSymbolType.STT_FUNCELFSymbolType.STT_SECTIONELFSymbolType.STT_FILEELFSymbolType.STT_COMMONELFSymbolType.STT_TLSELFSymbolType.STT_LOOSELFSymbolType.STT_HIOSELFSymbolType.STT_LOPROCELFSymbolType.STT_HIPROCELFSymbolType.STT_GNU_IFUNCELFSymbolType.__init__()ELFSymbolType.elf_valueELFSymbolType.os_procELFSymbolType.is_custom_os_proc
ELFSegmentELFSectionELFSection.SHF_WRITEELFSection.SHF_ALLOCELFSection.SHF_EXECINSTRELFSection.SHF_STRINGSELFSection.SHT_NULLELFSection.__init__()ELFSection.is_readableELFSection.is_activeELFSection.is_writableELFSection.occupies_memoryELFSection.is_executableELFSection.is_stringsELFSection.only_contains_uninitialized_dataELFSection.vaddrELFSection.memsizeELFSection.filesize
VariableMemoryVariableStackVariableRegisterVariableVariableTypePointerTypeBaseTypeStructTypeUnionTypeStructMemberArrayTypeTypedefTypeExceptionTableHeaderCallSiteEntryLSDAExceptionTableELFHashTableGNUHashTableLexicalBlockSubprogramCompilationUnit
- PE
- Mach-O
MachOMachO.is_defaultMachO.MH_MAGIC_64MachO.MH_CIGAM_64MachO.MH_MAGICMachO.MH_CIGAMMachO.__init__()MachO.ncmdsMachO.sizeofcmdsMachO.min_addrMachO.check_compatibility()MachO.is_compatible()MachO.is_thumb_interworking()MachO.decode_thumb_interworking()MachO.find_segment_by_name()MachO.do_binding()MachO.get_string()MachO.parse_lc_str()MachO.SMachO.get_symbol_by_address_fuzzy()MachO.get_symbol()MachO.get_symbol_by_insertion_order()MachO.get_segment_by_name()
SymbolListAbstractMachOSymbolSymbolTableSymbolSymbolTableSymbol.__init__()SymbolTableSymbol.library_nameSymbolTableSymbol.segment_nameSymbolTableSymbol.section_nameSymbolTableSymbol.valueSymbolTableSymbol.referenced_symbol_indexSymbolTableSymbol.is_weak()SymbolTableSymbol.is_functionSymbolTableSymbol.is_stabSymbolTableSymbol.is_private_externalSymbolTableSymbol.is_externalSymbolTableSymbol.sym_typeSymbolTableSymbol.is_commonSymbolTableSymbol.common_alignSymbolTableSymbol.reference_typeSymbolTableSymbol.library_ordinalSymbolTableSymbol.is_no_dead_stripSymbolTableSymbol.is_desc_discardedSymbolTableSymbol.is_weak_referencedSymbolTableSymbol.is_weak_definedSymbolTableSymbol.is_reference_to_weakSymbolTableSymbol.is_thumb_definitionSymbolTableSymbol.is_symbol_resolverSymbolTableSymbol.is_alt_entrySymbolTableSymbol.owner
DyldBoundSymbolBindingSymbolMachOSectionMachOSegmentchh()read_uleb()read_sleb()BindingStateBindingHelpern_opcode_done()n_opcode_set_dylib_ordinal_imm()n_opcode_set_dylib_ordinal_uleb()n_opcode_set_dylib_special_imm()n_opcode_set_trailing_flags_imm()n_opcode_set_type_imm()n_opcode_set_addend_sleb()n_opcode_set_segment_and_offset_uleb()l_opcode_set_segment_and_offset_uleb()n_opcode_add_addr_uleb()n_opcode_do_bind()l_opcode_do_bind()n_opcode_do_bind_add_addr_uleb()n_opcode_do_bind_add_addr_imm_scaled()n_opcode_do_bind_uleb_times_skipping_uleb()MachORelocationMachOChainedFixupdefault_binding_handler()HelperStructDyldImportFormatsDyldChainedPtrFormatsDyldChainedPtrFormats.DYLD_CHAINED_PTR_ARM64EDyldChainedPtrFormats.DYLD_CHAINED_PTR_64DyldChainedPtrFormats.DYLD_CHAINED_PTR_32DyldChainedPtrFormats.DYLD_CHAINED_PTR_32_CACHEDyldChainedPtrFormats.DYLD_CHAINED_PTR_32_FIRMWAREDyldChainedPtrFormats.DYLD_CHAINED_PTR_64_OFFSETDyldChainedPtrFormats.DYLD_CHAINED_PTR_ARM64E_KERNELDyldChainedPtrFormats.DYLD_CHAINED_PTR_64_KERNEL_CACHEDyldChainedPtrFormats.DYLD_CHAINED_PTR_ARM64E_USERLANDDyldChainedPtrFormats.DYLD_CHAINED_PTR_ARM64E_FIRMWAREDyldChainedPtrFormats.DYLD_CHAINED_PTR_X86_64_KERNEL_CACHEDyldChainedPtrFormats.DYLD_CHAINED_PTR_ARM64E_USERLAND24
dyld_chained_ptr_arm64e_auth_rebasedyld_chained_ptr_arm64e_auth_binddyld_chained_ptr_arm64e_rebasedyld_chained_ptr_arm64e_binddyld_chained_ptr_arm64e_bind24dyld_chained_ptr_arm64e_auth_bind24Arm64edyld_chained_ptr_64_rebasedyld_chained_ptr_64_bindGeneric64ChainedFixupPointerOnDiskDyldImportStructdyld_chained_importdyld_chained_import_addenddyld_chained_import_addend64dyld_chained_fixups_headerdyld_chained_starts_in_imagedyld_chained_starts_in_segment
- Binary Ninja
BinjaSymbolBinjaRelocBinjaBinBinjaBin.is_defaultBinjaBin.BINJA_ARCH_MAPBinjaBin.__init__()BinjaBin.is_compatible()BinjaBin.in_which_segment()BinjaBin.get_symbol_addr()BinjaBin.function_name()BinjaBin.min_addrBinjaBin.max_addrBinjaBin.entryBinjaBin.get_strings()BinjaBin.set_got_entry()BinjaBin.close()BinjaBin.importsBinjaBin.relocsBinjaBin.child_objectsBinjaBin.exception_handlingsBinjaBin.function_hintsBinjaBin.memory
- Blob
- COFF
IMAGE_FILE_MACHINECoffFileHeaderIMAGE_SCNCoffSectionTableEntryCoffSectionTableEntry.CharacteristicsCoffSectionTableEntry.NameCoffSectionTableEntry.NumberOfLinenumbersCoffSectionTableEntry.NumberOfRelocationsCoffSectionTableEntry.PointerToLinenumbersCoffSectionTableEntry.PointerToRawDataCoffSectionTableEntry.PointerToRelocationsCoffSectionTableEntry.SizeOfRawDataCoffSectionTableEntry.VirtualAddressCoffSectionTableEntry.VirtualSize
IMAGE_SYM_CLASSCoffSymbolTableEntryIMAGE_REL_I386IMAGE_REL_AMD64CoffRelocationTableEntryCoffParserCoffSectionCoffRelocationCoffRelocationREL32CoffRelocationDIR32CoffRelocationDIR32NBCoffRelocationADDR32NBCoffRelocationADDR64CoffRelocationSECTIONCoffRelocationSECRELCoff
- CGC
CGCBackedCGCBackedCGC.is_defaultBackedCGC.__init__()BackedCGC.is_compatible()BackedCGC.threadsBackedCGC.thread_registers()BackedCGC.importsBackedCGC.relocsBackedCGC.child_objectsBackedCGC.exception_handlingsBackedCGC.function_hintsBackedCGC.memoryBackedCGC.addr_to_lineBackedCGC.variablesBackedCGC.compilation_units
CGCFakeSegmentBackedCGCBackedCGC.is_defaultBackedCGC.__init__()BackedCGC.is_compatible()BackedCGC.threadsBackedCGC.thread_registers()BackedCGC.importsBackedCGC.relocsBackedCGC.child_objectsBackedCGC.exception_handlingsBackedCGC.function_hintsBackedCGC.memoryBackedCGC.addr_to_lineBackedCGC.variablesBackedCGC.compilation_units
- Intel Hex
- Java
- Minidump
- Static Archive
- UEFI
UefiDriverLoadErrorUefiFirmwareUefiModulePendingUefiModuleMixinUefiPEUefiTEHeaderTypeHeaderType.__new__()HeaderType.address_of_entry_pointHeaderType.base_of_codeHeaderType.data_directory_0_sizeHeaderType.data_directory_0_virtual_addressHeaderType.data_directory_1_sizeHeaderType.data_directory_1_virtual_addressHeaderType.image_baseHeaderType.machineHeaderType.number_of_sectionsHeaderType.signatureHeaderType.stripped_sizeHeaderType.subsystem
SectionHeaderTypeSectionHeaderType.__new__()SectionHeaderType.characteristicsSectionHeaderType.number_of_line_numbersSectionHeaderType.number_of_relocationsSectionHeaderType.physical_address_virtual_sizeSectionHeaderType.pointer_to_line_numbersSectionHeaderType.pointer_to_raw_dataSectionHeaderType.pointer_to_relocationsSectionHeaderType.section_nameSectionHeaderType.size_of_raw_dataSectionHeaderType.virtual_address
TE
- XBox Executable
- ELF
- Relocations
Relocationload_relocations()get_relocation()ELFRelocR_MIPS_64R_MIPS_REL32R_MIPS_COPYR_MIPS_TLS_DTPMOD64R_MIPS_TLS_DTPREL64R_MIPS_TLS_TPREL64GenericTLSDoffsetRelocGenericTLSOffsetRelocGenericTLSDescriptorRelocGenericTLSModIdRelocGenericIRelativeRelocGenericAbsoluteAddendRelocGenericPCRelativeAddendRelocGenericJumpslotRelocGenericRelativeRelocGenericAbsoluteRelocGenericCopyRelocMipsGlobalRelocMipsLocalRelocRelocTruncate32MixinRelocGOTMixinR_PPC_ADDR32R_PPC_ADDR24R_PPC_ADDR16R_PPC_ADDR16_LOR_PPC_ADDR16_HIR_PPC_ADDR16_HAR_PPC_ADDR14R_PPC_ADDR14_BRTAKENR_PPC_ADDR14_BRNTAKENR_PPC_REL24R_PPC_REL14R_PPC_REL14_BRTAKENR_PPC_REL14_BRNTAKENR_PPC_COPYR_PPC_GLOB_DATR_PPC_JMP_SLOTR_PPC_RELATIVER_PPC_UADDR32R_PPC_UADDR16R_PPC_REL32R_PPC_SECTOFFR_PPC_SECTOFF_LOR_PPC_SECTOFF_HIR_PPC_SECTOFF_HAR_PPC_ADDR30R_PPC_DTPMOD32R_PPC_DTPREL32R_PPC_TPREL32R_ARM_CALLR_ARM_PREL31R_ARM_REL32R_ARM_ABS32R_ARM_MOVW_ABS_NCR_ARM_MOVT_ABSR_ARM_THM_CALLR_ARM_COPYR_ARM_GLOB_DATR_ARM_GOT_PRELR_ARM_JUMP_SLOTR_ARM_RELATIVER_ARM_ABS32_NOIR_ARM_REL32_NOIR_ARM_TLS_DTPMOD32R_ARM_TLS_DTPOFF32R_ARM_TLS_TPOFF32R_ARM_JUMP24R_ARM_PC24R_ARM_THM_JUMP24R_ARM_THM_JUMP19R_ARM_THM_JUMP6R_ARM_THM_MOVW_ABS_NCR_ARM_THM_MOVT_ABSR_PPC64_JMP_SLOTR_PPC64_RELATIVER_PPC64_IRELATIVER_PPC64_ADDR64R_PPC64_GLOB_DATR_PPC64_DTPMOD64R_PPC64_DTPREL64R_PPC64_TPREL64R_PPC64_REL24R_PPC64_TOC16_LOR_PPC64_TOC16_HIR_PPC64_TOC16_HAR_PPC64_TOCR_386_32R_386_PC32R_386_COPYR_386_GLOB_DATR_386_JMP_SLOTR_386_RELATIVER_386_IRELATIVER_386_TLS_DTPMOD32R_386_TLS_TPOFFR_386_TLS_DTPOFF32R_X86_64_64R_X86_64_COPYR_X86_64_RELATIVER_X86_64_IRELATIVER_X86_64_GLOB_DATR_X86_64_JUMP_SLOTR_X86_64_DTPMOD64R_X86_64_DTPOFF64R_X86_64_TPOFF64R_X86_64_PC32R_X86_64_32R_X86_64_32SR_X86_64_PLT32R_X86_64_GOTPCRELR_X86_64_GOTPCRELXR_X86_64_REX_GOTPCRELXR_MIPS_32R_MIPS_REL32R_MIPS_JUMP_SLOTR_MIPS_GLOB_DATR_MIPS_TLS_DTPMOD32R_MIPS_TLS_TPREL32R_MIPS_TLS_DTPREL32R_MIPS_HI16R_MIPS_LO16R_ARM_CALLR_ARM_PREL31R_ARM_REL32R_ARM_ABS32R_ARM_MOVW_ABS_NCR_ARM_MOVT_ABSR_ARM_THM_CALLR_ARM_COPYR_ARM_GLOB_DATR_ARM_JUMP_SLOTR_ARM_RELATIVER_ARM_ABS32_NOIR_ARM_REL32_NOIR_ARM_TLS_DTPMOD32R_ARM_TLS_DTPOFF32R_ARM_TLS_TPOFF32R_ARM_JUMP24R_ARM_PC24R_ARM_THM_JUMP24R_ARM_THM_JUMP19R_ARM_THM_JUMP6R_ARM_THM_MOVW_ABS_NCR_ARM_THM_MOVT_ABSR_ARM_GOT_PRELR_ARM_CALLR_ARM_PREL31R_ARM_REL32R_ARM_ABS32R_ARM_MOVW_ABS_NCR_ARM_MOVT_ABSR_ARM_THM_CALLR_ARM_COPYR_ARM_GLOB_DATR_ARM_JUMP_SLOTR_ARM_RELATIVER_ARM_ABS32_NOIR_ARM_REL32_NOIR_ARM_TLS_DTPOFF32R_ARM_TLS_TPOFF32R_ARM_JUMP24R_ARM_PC24R_ARM_THM_JUMP24R_ARM_THM_JUMP19R_ARM_THM_JUMP6R_ARM_THM_MOVW_ABS_NCR_ARM_THM_MOVT_ABSR_AARCH64_ABS64R_AARCH64_COPYR_AARCH64_GLOB_DATR_AARCH64_JUMP_SLOTR_AARCH64_RELATIVER_AARCH64_IRELATIVER_AARCH64_TLS_DTPRELR_AARCH64_TLS_DTPMODR_AARCH64_TLS_TPRELR_AARCH64_TLSDESCR_AARCH64_CALL26R_AARCH64_ADR_PREL_PG_HI21R_AARCH64_ADD_ABS_LO12_NCR_390_GLOB_DATR_390_JMP_SLOTR_390_RELATIVER_390_64R_390_TLS_TPOFFR_390_IRELATIVER_390_COPYload_relocations()get_relocation()PERelocDllImportIMAGE_REL_BASED_ABSOLUTEIMAGE_REL_BASED_HIGHADJIMAGE_REL_BASED_HIGHLOWIMAGE_REL_BASED_DIR64IMAGE_REL_BASED_HIGHIMAGE_REL_BASED_LOWIMAGE_REL_BASED_HIGHADJIMAGE_REL_BASED_DIR64IMAGE_REL_BASED_HIGHLOWIMAGE_REL_BASED_HIGHIMAGE_REL_BASED_LOWIMAGE_REL_BASED_HIGHADJIMAGE_REL_BASED_DIR64IMAGE_REL_BASED_HIGHLOWIMAGE_REL_BASED_HIGHIMAGE_REL_BASED_LOWIMAGE_REL_BASED_HIGHADJIMAGE_REL_BASED_DIR64IMAGE_REL_BASED_HIGHLOWIMAGE_REL_BASED_HIGHIMAGE_REL_BASED_LOWIMAGE_REL_BASED_MIPS_JMPADDRIMAGE_REL_BASED_MIPS_JMPADDR16IMAGE_REL_BASED_HIGHADJIMAGE_REL_BASED_DIR64IMAGE_REL_BASED_HIGHLOWIMAGE_REL_BASED_HIGHIMAGE_REL_BASED_LOWIMAGE_REL_BASED_ARM_MOV32IMAGE_REL_BASED_THUMB_MOV32IMAGE_REL_BASED_HIGHADJIMAGE_REL_BASED_DIR64IMAGE_REL_BASED_HIGHLOWIMAGE_REL_BASED_HIGHIMAGE_REL_BASED_LOWIMAGE_REL_BASED_RISCV_HIGH20IMAGE_REL_BASED_RISCV_LOW12IIMAGE_REL_BASED_RISCV_LOW12S
- Thread Local Storage
ThreadManagerInternalTLSRelocationTLSObjectELFThreadManagerELFCoreThreadManagerPEThreadManagerMinidumpThreadManagerThreadManagerInternalTLSRelocationTLSObjectroundup()ELFThreadManagerELFTLSObjectELFTLSObjectV1ELFTLSObjectV2PEThreadManagerPETLSObjectELFCoreThreadManagerELFCoreThreadMinidumpThreadManagerMinidumpThread
- Errors
- Utilities
convert_info_sharedlibrary()convert_info_proc_maps()ClemoryBaseClemoryClemoryViewClemoryTranslatorUninitializedClemoryUninitializedClemory.__init__()UninitializedClemory.max_addrUninitializedClemory.add_backer()UninitializedClemory.split_backer()UninitializedClemory.update_backer()UninitializedClemory.remove_backer()UninitializedClemory.backers()UninitializedClemory.load()UninitializedClemory.store()UninitializedClemory.find()UninitializedClemory.consecutiveUninitializedClemory.min_addr
PatchedStreamAddressTranslatorAddressTranslator.__init__()AddressTranslator.from_lva()AddressTranslator.from_mva()AddressTranslator.from_rva()AddressTranslator.from_raw()AddressTranslator.from_linked_va()AddressTranslator.from_va()AddressTranslator.from_mapped_va()AddressTranslator.from_relative_va()AddressTranslator.to_lva()AddressTranslator.to_mva()AddressTranslator.to_rva()AddressTranslator.to_raw()AddressTranslator.to_linked_va()AddressTranslator.to_va()AddressTranslator.to_mapped_va()AddressTranslator.to_relative_va()
ATALIGN_DOWN()ALIGN_UP()get_mmaped_data()stream_or_path()key_bisect_floor_key()key_bisect_find()key_bisect_insort_left()key_bisect_insort_right()get_text_offset()