Namespace

Gum – 1.0

Cross-platform instrumentation and introspection library written in C.

Version1.0
AuthorsFrida Development Team
LicensewxWindows
Websitehttps://frida.re/
Sourcehttps://github.com/frida/frida-gum/

Build

C headersgum/gum.h
pkg-config filesgum

Dependencies

Additional documentation

Classes

CallbackEventSink
CallbackStalkerTransformer
DarwinGrafter
DarwinModule
DefaultEventSink
DefaultStalkerTransformer
ElfModule
Exceptor
Interceptor
MemoryAccessMonitor
MemoryMap
ModuleApiResolver
ModuleMap
ModuleRegistry
Stalker
SwiftApiResolver
ThreadRegistry
UnwindBroker

Interfaces

ApiResolver
Backtracer
EventSink
InvocationListener
Module
StalkerObserver
StalkerTransformer
UnwindPcTranslator
UnwindSectionsProvider

Structs

AddressSpec
AnyEvent
ApiDetails
Argument
Arm64CpuContext
ArmCpuContext
AttachOptions
Backpatch
BackpatchInstruction
BlockEvent
CallDetails
CallEvent
ChainedFixupsHeader
ChainedImport
ChainedImportAddend
ChainedImportAddend64
ChainedPtr64Bind
ChainedPtr64Rebase
ChainedPtrArm64eAuthBind
ChainedPtrArm64eAuthBind24
ChainedPtrArm64eAuthRebase
ChainedPtrArm64eBind
ChainedPtrArm64eBind24
ChainedPtrArm64eRebase
ChainedStartsInImage
ChainedStartsInSegment
Cloak
CodeAllocator
CodeDeflector
CodeSlice
CompileEvent
ControlFlowGraph
DarwinBindDetails
DarwinChainedFixupsDetails
DarwinExportDetails
DarwinFunctionStartsDetails
DarwinInitOffsetsDetails
DarwinInitPointersDetails
DarwinModuleImage
DarwinModuleImageSegment
DarwinRebaseDetails
DarwinSectionDetails
DarwinSegment
DarwinSymbolDetails
DarwinTermPointersDetails
DarwinThreadedItem
DarwinTlvDescriptorDetails
DarwinTlvParameters
DebugSymbolDetails
DependencyDetails
DyldInfoCommand
DysymtabCommand
ElfDynamicEntryDetails
ElfNoteHeader
ElfRelocationDetails
ElfSectionDetails
ElfSegmentDetails
ElfSymbolDetails
ExceptionDetails
ExceptionMemoryDetails
ExceptorScope
ExecEvent
ExportDetails
FileMapping
FunctionDetails
HeapApi
IA32CpuContext
ImportDetails
InterceptorOptions
InvocationBackend
InvocationContext
KernelModuleDetails
KernelModuleRangeDetails
MallocRangeDetails
MatchPattern
MemoryAccessDetails
MemoryRange
MetalArray
MetalHashTableIter
MipsCpuContext
PointerMatch
RangeDetails
RedirectWriteDetails
ReplaceOptions
RetEvent
ReturnAddressArray
ReturnAddressDetails
SectionDetails
Spinlock
StalkerIterator
StalkerOutput
SymbolDetails
SymbolSection
SymtabCommand
ThreadDetails
ThreadEntrypoint
X64CpuContext

Unions

Arm64VectorReg
ArmVectorReg
Event
StalkerWriter

Aliases

AbiType
Address
ArgType
BranchHint
CallingConvention
ChainedImportFormat
ChainedPtrFormat
ChainedSymbolFormat
CpuContext
CpuFeatures
DarwinBindOrdinal
DarwinBindSymbolFlags
DarwinBindType
DarwinCpuSubtype
DarwinCpuType
DarwinExportSymbolFlags
DarwinExportSymbolKind
DarwinModuleFiletype
DarwinPageProtection
DarwinPort
DarwinRebaseType
DarwinThreadedItemType
EventType
ExceptionType
ExceptorNativeJmpBuf
InstructionEncoding
InvocationStack
InvocationState
MemoryOperation
OS
PageProtection
PointCut
ProbeId
ProcessId
PtrauthSupport
RelocationScenario
ReturnAddress
RwxSupport
ThreadId
TlsKey

Enumerations

AttachReturn
CodeSigningPolicy
CpuType
DependencyType
ElfArm64Relocation
ElfArmRelocation
ElfDynamicTag
ElfIA32Relocation
ElfMachine
ElfMipsRelocation
ElfOSABI
ElfSectionType
ElfShdrIndex
ElfSourceMode
ElfSymbolBind
ElfSymbolType
ElfType
ElfX64Relocation
ExceptorMode
ExportType
ImportType
InterceptorScenario
InvocationIgnorability
MemoryAccess
RedirectWriteResult
RelocationPolicy
ReplaceReturn
SymbolType
TeardownRequirement
ThreadState

Bitfields

DarwinGrafterFlags
DarwinModuleFlags
ElfSectionFlags
ModifyThreadFlags
ThreadFlags
WatchConditions

Error Domains

Error

Callbacks

CallocDbgFunc
CallocFunc
CallProbeCallback
CloakFoundFDFunc
CloakFoundRangeFunc
CloakFoundThreadFunc
CloakLockedFunc
ControlFlowGraphFindRangeFunc
CrtReportBlockTypeFunc
EventSinkCallback
ExceptionHandler
FoundApiFunc
FoundDarwinBindFunc
FoundDarwinChainedFixupsFunc
FoundDarwinExportFunc
FoundDarwinFunctionStartsFunc
FoundDarwinInitOffsetsFunc
FoundDarwinInitPointersFunc
FoundDarwinRebaseFunc
FoundDarwinSectionFunc
FoundDarwinSymbolFunc
FoundDarwinTermPointersFunc
FoundDarwinTlvDescriptorFunc
FoundDependencyFunc
FoundDominatingSiteFunc
FoundElfDynamicEntryFunc
FoundElfRelocationFunc
FoundElfSectionFunc
FoundElfSegmentFunc
FoundElfSymbolFunc
FoundExportFunc
FoundImportFunc
FoundKernelModuleFunc
FoundKernelModuleRangeFunc
FoundMallocRangeFunc
FoundModuleFunc
FoundRangeFunc
FoundSectionFunc
FoundSymbolFunc
FoundThreadFunc
FreeDbgFunc
FreeFunc
InterceptorLockedFunc
InvocationCallback
MallocDbgFunc
MallocFunc
MemoryAccessNotify
MemoryIsNearFunc
MemoryPatchApplyFunc
MemoryPatchPagesApplyFunc
MemoryScanMatchFunc
ModifyThreadFunc
ModuleMapFilterFunc
ReallocDbgFunc
ReallocFunc
ResolveExportFunc
StalkerCallout
StalkerIncrementFunc
StalkerNotifyBackpatchFunc
StalkerRunOnThreadFunc
StalkerSwitchCallbackFunc
StalkerTransformerCallback
WriteRedirectFunc

Functions

address_get_type
alloc_n_pages
alloc_n_pages_near
calloc
clear_cache
code_segment_is_supported
code_segment_mark
cpu_context_get_nth_argument
cpu_context_get_return_value
cpu_context_replace_nth_argument
cpu_context_replace_return_value
deinit
deinit_embedded
ensure_code_readable
find_function
find_functions_matching
find_functions_named
free
free_pages
init
init_embedded
internal_heap_ref
internal_heap_unref
invocation_stack_translate
kernel_alloc_n_pages
kernel_api_is_available
kernel_enumerate_module_ranges
kernel_enumerate_modules
kernel_enumerate_ranges
kernel_find_base_address
kernel_free_pages
kernel_query_page_size
kernel_read
kernel_scan
kernel_set_base_address
kernel_try_mprotect
kernel_write
load_symbols
make_call_listener
make_probe_listener
malloc
malloc0
malloc_usable_size
memalign
memcpy
memdup
memmove
memory_allocate
memory_allocate_near
memory_can_remap_writable
memory_decommit
memory_discard
memory_dispose_writable_pages
memory_find_pointers
memory_free
memory_is_readable
memory_mark_code
memory_patch_code
memory_query_protection
memory_read
memory_recommit
memory_release
memory_scan
memory_try_remap_writable_pages
memory_write
memset
mprotect
peek_private_memory_usage
prepare_to_fork
process_enumerate_malloc_ranges
process_enumerate_modules
process_enumerate_ranges
process_enumerate_threads
process_find_function_range
process_find_module_by_address
process_find_module_by_name
process_get_code_signing_policy
process_get_current_thread_id
process_get_id
process_get_libc_module
process_get_main_module
process_get_native_os
process_get_teardown_requirement
process_has_thread
process_is_debugger_attached
process_modify_thread
process_set_code_signing_policy
process_set_teardown_requirement
query_cpu_features
query_is_rwx_supported
query_page_allocation_range
query_page_size
query_ptrauth_support
query_rwx_support
realloc
recover_from_fork_in_child
recover_from_fork_in_parent
shutdown
sign_code_address
sign_code_pointer
strip_code_address
strip_code_pointer
symbol_name_from_address
thread_get_system_error
thread_resume
thread_set_hardware_breakpoint
thread_set_hardware_watchpoint
thread_set_system_error
thread_suspend
thread_try_get_ranges
thread_unset_hardware_breakpoint
thread_unset_hardware_watchpoint
tls_key_free
tls_key_get_value
tls_key_new
tls_key_set_value
try_alloc_n_pages
try_alloc_n_pages_near
try_mprotect

Constants

API_SIZE_NONE
DARWIN_EXPORT_KIND_MASK
DARWIN_PORT_NULL
ELF_SECTION_MASK_OS
ELF_SECTION_MASK_PROCESSOR
INT10_MASK
INT11_MASK
INT12_MASK
INT14_MASK
INT16_MASK
INT18_MASK
INT19_MASK
INT24_MASK
INT26_MASK
INT28_MASK
INT2_MASK
INT32_MASK
INT3_MASK
INT4_MASK
INT5_MASK
INT6_MASK
INT8_MASK
MAX_BACKTRACE_DEPTH
MAX_CALL_DEPTH
MAX_LISTENER_DATA
MAX_LISTENERS_PER_FUNCTION
MAX_PATH
MAX_SYMBOL_NAME
MAX_THREAD_RANGES
MAX_THREADS
MAX_TYPE_NAME
MAX_WORST_CASE_INFO_SIZE
NATIVE_ABI_IS_UNIX
NATIVE_ABI_IS_WINDOWS
PAGE_RW
PAGE_RWX
PAGE_RX
PSR_T_BIT
RED_ZONE_SIZE
TEB_OFFSET_SELF
TEB_OFFSET_TID
THREAD_ID_INVALID