Class GoRttiMapper
- All Implemented Interfaces:
DataTypeMapperContext
,AutoCloseable
DataTypeMapper
for golang binaries.
When bootstrapping golang binaries, the following steps are used:
- Find the GoBuildInfo struct. This struct is the easiest to locate, even when the binary is stripped. This gives us the go pointerSize (probably same as ghidra pointer size) and the goVersion. This struct does not rely on StructureMapping, allowing its use before a DataTypeMapper is created.
- Create DataTypeMapper
- Find the runtime.firstmoduledata structure.
-
- If there are symbols, just use the symbol or named memory block.
- If stripped:
-
- Find the pclntab. This has a magic signature, a pointerSize, and references to a couple of tables that are also referenced in the moduledata structure.
- Search memory for a pointer to the pclntab struct. This should be the first field of the moduledata structure. The values that are duplicated between the two structures can be compared to ensure validity.
- Different binary formats (Elf vs PE) will determine which memory blocks to search.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
static final record
static interface
-
Field Summary
FieldsFields inherited from class ghidra.app.util.bin.format.golang.structmapping.DataTypeMapper
archiveDTM, archiveSearchCPs, mappingInfo, program, programDTM, programSearchCPs
-
Constructor Summary
ConstructorsConstructorDescriptionGoRttiMapper
(Program program, GoBuildInfo buildInfo, int ptrSize, GoVer goVer, ResourceFile archiveGDT, GoApiSnapshot apiSnapshot) Creates a GoRttiMapper using the specified bootstrap information. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addModule
(GoModuledata module) Adds a module data instance to the contextvoid
close()
createFuncDef
(List<ParameterDefinition> params, DataType returnDT, GoSymbolName symbolName, boolean noReturn) createFuncDef
(List<ParameterDefinition> params, List<ParameterDefinition> returnParams, GoSymbolName symbolName, boolean noReturn) createMarkupSession
(TaskMonitor monitor) Creates aMarkupSession
that is controlled by the specifiedTaskMonitor
.protected BinaryReader
Creates a new BinaryReader that reads bytes from the current program's memory image.void
exportTypesToGDT
(File gdtFile, boolean runtimeFuncSnapshot, TaskMonitor monitor) Export the currently registered struct mapping types to a gdt file, producing a bootstrap GDT archive.findContainingModule
(long offset) Finds theGoModuledata
that contains the specified offset.findContainingModuleByFuncData
(long offset) Finds theGoModuledata
that contains the specified func data offset.static ResourceFile
findGolangBootstrapGDT
(GoVer goVer, int ptrSize, String osName) Searches for a golang bootstrap gdt file that matches the specified Go version/size/OS.Return a list of all functionsgetBootstrapFunctionDefintion
(String funcName) Returns aFunctionDefinition
for a built-in golang runtime function.CategoryPath location (in the program) where new data types will be created to represent variable length structures.static MemoryBlock
getFirstGoSection
(Program program, String... blockNames) Returns the first module data instancegetFuncDefFor
(GoFuncData funcData) Returns function definition information for a func.getFunctionByName
(String funcName) Returns a function based on its namegetFunctionData
(Address funcAddr) Returns metadata about a functiongetFunctionsByNamePattern
(Pattern pattern) static String
getGDTFilename
(GoVer goVer, int pointerSizeInBytes, String osName) Returns the name of the golang bootstrap gdt data type archive, using the specified version, pointer size and OS name.static GoRttiMapper
getGoBinary
(Program program, TaskMonitor monitor) Creates aGoRttiMapper
representing the specified program.getGoName
(long offset) Returns theGoName
instance at the specified offset.static MemoryBlock
getGoSection
(Program program, String sectionName) getGoSection
(String sectionName) static Symbol
getGoSymbol
(Program program, String symbolName) Returns a matching symbol from the specified program, using golang specific logic.getGoSymbol
(String symbolName) getGoVer()
Returns the golang versiongetMethodInfoForFunction
(Address funcAddr) Returns method info about the specified function.byte
getMinLC()
Returns the minLC (pcquantum) value found in the pcln header structureint
Returns the size of pointers in this binary.Returns a sharedGoRegisterInfo
instance<T> GoName
getSafeName
(GoRttiMapper.GoNameSupplier supplier, T structInstance, String defaultValue) An exception handling wrapper around a "getName()" call that could throw an IOException.static GoRttiMapper
getSharedGoBinary
(Program program, TaskMonitor monitor) Returns a sharedGoRttiMapper
for the specified program, or null if the binary is not a supported golang binary.Returns the address range that is valid for string char[] data to be found in.Returns the address range that is valid for string structs to be found in.<T extends DataType>
Tstatic Address
getZerobaseAddress
(Program prog) Return the address of the golang zerobase symbol, or an artificial substitute.boolean
hasCallingConvention
(String ccName) Returns true if the specified calling convention is defined for the program.static boolean
hasGolangSections
(List<String> sectionNames) void
init
(TaskMonitor monitor) Finishes making this instance ready to be used.void
Initializes golang function / method lookup infostatic boolean
isAbi0Func
(Address funcEntry, Program program) boolean
isFieldPresent
(String presentWhen) Tests if a field should be included when creating bindings between a structure and a class.boolean
isGolangAbi0Func
(Function func) Returns true if the specified function uses the abi0 calling convention.static boolean
isGolangProgram
(Program program) Returns true if the specified Program is marked as "golang".Returns a new param storage allocator instance.resolveNameOff
(long ptrInModule, long off) Returns theGoName
corresponding to an offset that is relative to the controlling GoModuledata's typesOffset.resolveTextOff
(long ptrInModule, long off) Returns theAddress
to an offset that is relative to the controlling GoModuledata's text value.Methods inherited from class ghidra.app.util.bin.format.golang.structmapping.DataTypeMapper
addArchiveSearchCategoryPath, addProgramSearchCategoryPath, createArtificialStructureContext, findType, getAddressOfStructure, getCodeAddress, getDataAddress, getDataConverter, getDTM, getMaxAddressOfStructure, getProgram, getReader, getStructureContextOfInstance, getStructureDataType, getStructureDataTypeName, getStructureMappingInfo, getStructureMappingInfo, getType, getTypeOrDefault, readStructure, readStructure, readStructure, readStructure, registerStructure, registerStructures, toString
-
Field Details
-
SUPPORTED_VERSIONS
-
ARTIFICIAL_RUNTIME_ZEROBASE_SYMBOLNAME
- See Also:
-
-
Constructor Details
-
GoRttiMapper
public GoRttiMapper(Program program, GoBuildInfo buildInfo, int ptrSize, GoVer goVer, ResourceFile archiveGDT, GoApiSnapshot apiSnapshot) throws IOException, BootstrapInfoException Creates a GoRttiMapper using the specified bootstrap information.- Parameters:
program
-Program
containing the go binarybuildInfo
-GoBuildInfo
ptrSize
- size of pointersgoVer
- version of goarchiveGDT
- path to the matching golang bootstrap gdt data type file, or null if not present and types recovered via DWARF should be used insteadapiSnapshot
- json func signatures and data types- Throws:
IOException
- if error linking a structure mapped structure to its matching ghidra structure, which is a programming error or a corrupted bootstrap gdtBootstrapInfoException
- if there is no matching bootstrap gdt for this specific type of golang binary
-
-
Method Details
-
getGoBinary
public static GoRttiMapper getGoBinary(Program program, TaskMonitor monitor) throws BootstrapInfoException, IOException Creates aGoRttiMapper
representing the specified program.- Parameters:
program
-Program
monitor
-TaskMonitor
- Returns:
- new
GoRttiMapper
, or null if basic golang information is not found in the binary - Throws:
BootstrapInfoException
- if it is a golang binary and has an unsupported or unparseable version number or if there was a missing golang bootstrap .gdt fileIOException
- if there was an error in the Ghidra golang rtti reading logic
-
getGDTFilename
Returns the name of the golang bootstrap gdt data type archive, using the specified version, pointer size and OS name.- Parameters:
goVer
-GoVer
pointerSizeInBytes
- pointer size for this binary, or -1 to use wildcard "any"osName
- name of the operating system, or "any"- Returns:
- String, "golang_1.18_64bit_any.gdt"
-
findGolangBootstrapGDT
Searches for a golang bootstrap gdt file that matches the specified Go version/size/OS.First looks for a gdt with an exact match, then for a gdt with version/size match and "any" OS, and finally, a gdt that matches the version and "any" size and "any" OS.
- Parameters:
goVer
- version of GoptrSize
- size of pointersosName
- name of OS- Returns:
- ResourceFile of matching bootstrap gdt, or null if nothing matches
-
isGolangProgram
Returns true if the specified Program is marked as "golang".- Parameters:
program
-Program
- Returns:
- boolean true if program is marked as golang
-
hasGolangSections
-
getGoSymbol
Returns a matching symbol from the specified program, using golang specific logic. -
getGoSection
-
getFirstGoSection
-
getZerobaseAddress
Return the address of the golang zerobase symbol, or an artificial substitute.The zerobase symbol is used as the location of parameters that are zero-length.
-
getAllSupportedVersions
-
close
public void close()- Specified by:
close
in interfaceAutoCloseable
- Overrides:
close
in classDataTypeMapper
-
getType
Description copied from class:DataTypeMapper
Returns a namedDataType
, searching the registeredprogram
andarchive
category paths.DataTypes that were found in the attached archive gdt manager will be copied into the program's data type manager before being returned.
- Overrides:
getType
in classDataTypeMapper
- Type Parameters:
T
- DataType or derived type- Parameters:
name
-DataType
nameclazz
- expected DataType class- Returns:
- DataType or null if not found
-
isFieldPresent
Description copied from interface:DataTypeMapperContext
Tests if a field should be included when creating bindings between a structure and a class.- Specified by:
isFieldPresent
in interfaceDataTypeMapperContext
- Parameters:
presentWhen
- free-form string that is interpreted by eachDataTypeMapper
- Returns:
- boolean true if field should be bound, false if field should not be bound
-
getGoVer
Returns the golang version- Returns:
GoVer
-
getRegInfo
Returns a sharedGoRegisterInfo
instance- Returns:
GoRegisterInfo
-
getBuildInfo
-
init
Finishes making this instance ready to be used.- Parameters:
monitor
-TaskMonitor
- Throws:
IOException
- if error reading data
-
initMethodInfoIfNeeded
Initializes golang function / method lookup info- Throws:
IOException
- if error reading data
-
getGoTypes
-
getMinLC
Returns the minLC (pcquantum) value found in the pcln header structure- Returns:
- minLC value
- Throws:
IOException
- if value has not been initialized yet
-
getFirstModule
Returns the first module data instance- Returns:
GoModuledata
-
getModules
-
addModule
Adds a module data instance to the context- Parameters:
module
-GoModuledata
to add
-
newStorageAllocator
Returns a new param storage allocator instance.- Returns:
- new
GoParamStorageAllocator
instance
-
isGolangAbi0Func
Returns true if the specified function uses the abi0 calling convention.- Parameters:
func
-Function
to test- Returns:
- boolean true if function uses abi0 calling convention
-
isAbi0Func
-
getCallingConventionFor
-
hasCallingConvention
Returns true if the specified calling convention is defined for the program.- Parameters:
ccName
- calling convention name- Returns:
- true if the specified calling convention is defined for the program
-
getDefaultCallingConventionName
-
createMarkupSession
Description copied from class:DataTypeMapper
Creates aMarkupSession
that is controlled by the specifiedTaskMonitor
.- Overrides:
createMarkupSession
in classDataTypeMapper
- Parameters:
monitor
-TaskMonitor
- Returns:
- new
MarkupSession
-
findContainingModule
Finds theGoModuledata
that contains the specified offset.Useful for finding the
GoModuledata
to resolve a relative offset of the text, types or other area.- Parameters:
offset
- absolute offset of a structure that aGoModuledata
contains- Returns:
GoModuledata
instance that contains the structure, or null if not found
-
findContainingModuleByFuncData
Finds theGoModuledata
that contains the specified func data offset.- Parameters:
offset
- absolute offset of a func data structure- Returns:
GoModuledata
instance that contains the specified func data, or null if not found
-
getDefaultVariableLengthStructCategoryPath
Description copied from class:DataTypeMapper
CategoryPath location (in the program) where new data types will be created to represent variable length structures.- Overrides:
getDefaultVariableLengthStructCategoryPath
in classDataTypeMapper
- Returns:
CategoryPath
, default is ROOT
-
createProgramReader
Description copied from class:DataTypeMapper
Creates a new BinaryReader that reads bytes from the current program's memory image.Address offsets and index offsets in the BinaryReader should be synonymous.
- Overrides:
createProgramReader
in classDataTypeMapper
- Returns:
- new BinaryReader
-
getPtrSize
public int getPtrSize()Returns the size of pointers in this binary.- Returns:
- pointer size (ex. 4, or 8)
-
exportTypesToGDT
public void exportTypesToGDT(File gdtFile, boolean runtimeFuncSnapshot, TaskMonitor monitor) throws IOException, CancelledException Export the currently registered struct mapping types to a gdt file, producing a bootstrap GDT archive.The struct data types will either be from the current program's DWARF data, or from an earlier golang.gdt (if this binary doesn't have DWARF)
- Parameters:
gdtFile
- destinationFile
to write the bootstrap types toruntimeFuncSnapshot
- boolean flag, if true include function definitionsmonitor
-TaskMonitor
- Throws:
IOException
- if errorCancelledException
- if cancelled
-
getFuncDefFor
Returns function definition information for a func.- Parameters:
funcData
-GoFuncData
representing a go func- Returns:
GoRttiMapper.FuncDefResult
record, or null if no information could be found or generated- Throws:
IOException
- if error reading type info
-
createFuncDef
public FunctionDefinitionDataType createFuncDef(List<ParameterDefinition> params, List<ParameterDefinition> returnParams, GoSymbolName symbolName, boolean noReturn) -
createFuncDef
public FunctionDefinitionDataType createFuncDef(List<ParameterDefinition> params, DataType returnDT, GoSymbolName symbolName, boolean noReturn) -
getMethodInfoForFunction
Returns method info about the specified function.- Parameters:
funcAddr
- function address- Returns:
GoMethod.GoMethodInfo
, or null
-
getSafeName
public <T> GoName getSafeName(GoRttiMapper.GoNameSupplier supplier, T structInstance, String defaultValue) An exception handling wrapper around a "getName()" call that could throw an IOException.When there is an error fetching the GoName instance via the specified callback, a limited usage GoName instance will be created and returned that will provide a replacement name that is built using the calling structure's offset as the identifier.
- Type Parameters:
T
- struct mapped instance type- Parameters:
supplier
- Supplier callbackstructInstance
- reference to the caller's struct-mapped instancedefaultValue
- string value to return (wrapped in a GoName) if the GoName is simply missing- Returns:
- GoName, either from the callback, or a limited-functionality instance created to hold a fallback name string
-
resolveTextOff
Returns theAddress
to an offset that is relative to the controlling GoModuledata's text value.- Parameters:
ptrInModule
- the address of the structure that contains the offset that needs to be calculated. The containing-structure's address is important because it indicates which GoModuledata is the 'parent'off
- offset- Returns:
Address
, or null if offset was special value -1
-
resolveNameOff
Returns theGoName
corresponding to an offset that is relative to the controlling GoModuledata's typesOffset.- Parameters:
ptrInModule
- the address of the structure that contains the offset that needs to be calculated. The containing-structure's address is important because it indicates which GoModuledata is the 'parent'off
- offset- Returns:
GoName
, or null if offset was special value 0- Throws:
IOException
- if error reading name or unable to find containing module
-
getGoName
Returns theGoName
instance at the specified offset.- Parameters:
offset
- location to read- Returns:
GoName
instance, or null if offset was special value 0- Throws:
IOException
- if error reading
-
getFunctionData
Returns metadata about a function- Parameters:
funcAddr
- entry point of a function- Returns:
GoFuncData
, or null if function not found in lookup tables
-
getFunctionByName
Returns a function based on its name- Parameters:
funcName
- name of function- Returns:
GoFuncData
, or null if not found
-
getFunctionsByNamePattern
-
getAllFunctions
Return a list of all functions- Returns:
- list of all functions contained in the golang func metadata table
-
getBootstrapFunctionDefintion
Returns aFunctionDefinition
for a built-in golang runtime function.- Parameters:
funcName
- name of function- Returns:
FunctionDefinition
, or null if not found in bootstrap gdt
-
getStringStructRange
Returns the address range that is valid for string structs to be found in.- Returns:
AddressSetView
of range that is valid to find string structs in
-
getStringDataRange
Returns the address range that is valid for string char[] data to be found in.- Returns:
AddressSetView
of range that is valid for string char[] data
-
getTextAddresses
-
getUninitializedNoPtrDataRange
-
getGoSymbol
-
getGoSection