Class DWARFDataTypeManager
- java.lang.Object
-
- ghidra.app.util.bin.format.dwarf4.next.DWARFDataTypeManager
-
public class DWARFDataTypeManager extends java.lang.Object
Manages mappings between DWARF DIEs and Ghidra DataTypes.
-
-
Constructor Summary
Constructors Constructor Description DWARFDataTypeManager(DWARFProgram prog, DataTypeManager dataTypeManager, DataTypeManager builtInDTM, DWARFImportSummary importSummary)
Creates a newDWARFDataTypeManager
instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addDataType(long offset, DataType dataType, DWARFSourceInfo dsi)
DataType
doGetDataType(DIEAggregate diea)
java.lang.Iterable<DataType>
forAllConflicts(DataTypePath dtp)
Iterate allDataType
s that match the CategoryPath / name given in theDataTypePath
parameter, including "conflict" datatypes that have a ".CONFLICTxx" suffix.DataType
getBaseType(java.lang.String name)
Returns a DWARF base data type based on its name, or null if it does not exist.DataType
getBaseType(java.lang.String name, int dwarfSize, int dwarfEncoding, boolean isBigEndian)
Returns a Ghidradatatype
that corresponds to the DWARF named type.DataType
getDataType(long dieOffset, DataType defaultValue)
Returns a GhidraDataType
corresponding to the specified DIE (based on its offset), or the specified defaultValue if the DIE does not map to a defined datatype (registered with#addType(long, DataType, DWARFImportSummary)
).DataType
getDataType(DIEAggregate diea, DataType defaultValue)
Returns a GhidraDataType
corresponding to the specifiedDIEAggregate
, or the specified defaultValue if the DIEA param is null or does not map to an already defined datatype (registered with#addType(long, DataType, DWARFImportSummary)
).FunctionDefinition
getFunctionSignature(DIEAggregate diea)
Construct a temporary 'impl'FunctionDefinition
DataType using the information found in the specifiedDIEAggregate
.java.util.List<DataTypePath>
getImportedTypes()
DataType
getOffsetType(int size)
Returns a Ghidradatatype
that corresponds to a type that can be used to represent an offset.DataType
getPtrTo(DataType dt)
Returns a pointer to the specified data type.DWARFSourceInfo
getSourceInfo(DataType dataType)
<T extends DataType>
TgetSpecificDataType(DIEAggregate diea, java.lang.Class<T> dataTypeClazz)
DataType
getUndefined1Type()
Returns datatype to hold a 1 byte undefined value.DataType
getVoidType()
Returns the void type.void
importAllDataTypes(TaskMonitor monitor)
Does the actual import work.
-
-
-
Constructor Detail
-
DWARFDataTypeManager
public DWARFDataTypeManager(DWARFProgram prog, DataTypeManager dataTypeManager, DataTypeManager builtInDTM, DWARFImportSummary importSummary)
Creates a newDWARFDataTypeManager
instance.- Parameters:
prog
-DWARFProgram
that holds the GhidraProgram
being imported.dataTypeManager
-DataTypeManager
of the Ghidra Program.builtInDTM
-DataTypeManager
with built-in data types.importSummary
-DWARFImportSummary
where summary information will be stored during the import session.
-
-
Method Detail
-
doGetDataType
public DataType doGetDataType(DIEAggregate diea) throws java.io.IOException, DWARFExpressionException
Creates aDataType
from the DWARFDIEA
, or returns a pre-existingDataType
created by the specified DIEA previously.Creating a new DataType happens in two stages, where the DataType is created as an 'impl' DataType first (possibly representing a large graph of referred-to datatypes), and then it is submitted to the
DataTypeManager
to be added to the database and converted to a 'db' object.Mapping from the DIEA's offset to the resultant 'db' DataType object is a two step process.
A
DataTypeGraphComparator
is used to walk the 'impl' DataType object graph in lock-step with the resultant 'db' DataType object graph, and the mapping between the 'impl' object and its creator DIEA (held in#currentImplDataTypeToDIE
) is used to create a mapping to the resultant 'db' DataType's path.- Parameters:
diea
- DWARFDIEAggregate
with datatype information that needs to be converted to a Ghidra DataType.- Returns:
DataType
that is ready to use.- Throws:
java.io.IOException
- if problemDWARFExpressionException
- if problem
-
addDataType
public void addDataType(long offset, DataType dataType, DWARFSourceInfo dsi)
-
getImportedTypes
public java.util.List<DataTypePath> getImportedTypes()
-
getSourceInfo
public DWARFSourceInfo getSourceInfo(DataType dataType)
-
getDataType
public DataType getDataType(DIEAggregate diea, DataType defaultValue)
Returns a GhidraDataType
corresponding to the specifiedDIEAggregate
, or the specified defaultValue if the DIEA param is null or does not map to an already defined datatype (registered with#addType(long, DataType, DWARFImportSummary)
).- Parameters:
diea
-DIEAggregate
that defines a data typedefaultValue
- GhidraDataType
to return if the specified DIEA is null or not already defined.- Returns:
- Ghidra
DataType
- Throws:
DWARFExpressionException
java.io.IOException
-
getDataType
public DataType getDataType(long dieOffset, DataType defaultValue)
Returns a GhidraDataType
corresponding to the specified DIE (based on its offset), or the specified defaultValue if the DIE does not map to a defined datatype (registered with#addType(long, DataType, DWARFImportSummary)
).
-
getSpecificDataType
public <T extends DataType> T getSpecificDataType(DIEAggregate diea, java.lang.Class<T> dataTypeClazz)
-
forAllConflicts
public java.lang.Iterable<DataType> forAllConflicts(DataTypePath dtp)
Iterate allDataType
s that match the CategoryPath / name given in theDataTypePath
parameter, including "conflict" datatypes that have a ".CONFLICTxx" suffix.- Parameters:
dtp
-- Returns:
-
getOffsetType
public DataType getOffsetType(int size)
Returns a Ghidradatatype
that corresponds to a type that can be used to represent an offset.- Parameters:
size
-- Returns:
-
getUndefined1Type
public DataType getUndefined1Type()
Returns datatype to hold a 1 byte undefined value.- Returns:
- undefined 1 byte
DataType
.
-
getBaseType
public DataType getBaseType(java.lang.String name)
Returns a DWARF base data type based on its name, or null if it does not exist.- Parameters:
name
- base type name- Returns:
DataType
or null if base type does not exist
-
getBaseType
public DataType getBaseType(java.lang.String name, int dwarfSize, int dwarfEncoding, boolean isBigEndian)
Returns a Ghidradatatype
that corresponds to the DWARF named type.If there is no direct matching named Ghidra type, generic types of matching size will be returned for integer and floating numeric dwarf encoding types, boolean, and character types. Failing that, generic storage types of matching size (word, dword, etc) will be returned, and failing that, an array of the correct size will be returned.
If the returned data type is not a direct named match, the returned data type will be wrapped in a Ghdira typedef using the dwarf type's name.
Any newly created Ghidra data types will be cached and the same instance will be returned if the same DWARF named base type is requested again.
- Parameters:
name
-dwarfSize
-dwarfEncoding
-isBigEndian
-- Returns:
-
importAllDataTypes
public void importAllDataTypes(TaskMonitor monitor) throws java.io.IOException, DWARFException, CancelledException
Does the actual import work. Updates thesummary
object with information about the types imported and errors encountered.- Parameters:
TaskMonitor
- monitor to watch for cancel- Throws:
java.io.IOException
- if errors are encountered reading dataDWARFException
- if errors are encountered processingCancelledException
- if theTaskMonitor
is canceled by the user.
-
getFunctionSignature
public FunctionDefinition getFunctionSignature(DIEAggregate diea)
Construct a temporary 'impl'FunctionDefinition
DataType using the information found in the specifiedDIEAggregate
.- Parameters:
diea
-DIEAggregate
of a subprogram, callsite, etc.- Returns:
FunctionDefinition
impl (not saved to the DB) or null if not a valid DIEA.
-
-