Class FunctionDefinitionDataType
- All Implemented Interfaces:
DataType
,FunctionDefinition
,FunctionSignature
- Direct Known Subclasses:
FunctionSignatureImpl
-
Field Summary
Fields inherited from class ghidra.program.model.data.DataTypeImpl
defaultSettings
Fields inherited from class ghidra.program.model.data.AbstractDataType
categoryPath, dataMgr, name
Fields inherited from interface ghidra.program.model.data.DataType
CONFLICT_SUFFIX, DEFAULT, NO_LAST_CHANGE_TIME, NO_SOURCE_SYNC_TIME, TYPEDEF_ATTRIBUTE_PREFIX, TYPEDEF_ATTRIBUTE_SUFFIX, VOID
Fields inherited from interface ghidra.program.model.listing.FunctionSignature
NORETURN_DISPLAY_STRING, VAR_ARGS_DISPLAY_STRING, VOID_PARAM_DISPLAY_STRING
-
Constructor Summary
ConstructorDescriptionFunctionDefinitionDataType
(CategoryPath path, String name) FunctionDefinitionDataType
(CategoryPath path, String name, DataTypeManager dtm) FunctionDefinitionDataType
(CategoryPath path, String name, FunctionSignature sig) FunctionDefinitionDataType
(CategoryPath path, String name, FunctionSignature sig, DataTypeManager dtm) FunctionDefinitionDataType
(CategoryPath path, String name, FunctionSignature sig, UniversalID universalID, SourceArchive sourceArchive, long lastChangeTime, long lastChangeTimeInSourceArchive, DataTypeManager dtm) FunctionDefinitionDataType
(Function function, boolean formalSignature) Create a Function Definition based on a FunctionFunctionDefinitionDataType
(String name, DataTypeManager dtm) -
Method Summary
Modifier and TypeMethodDescriptionclone
(DataTypeManager dtm) Returns an instance of this DataType using the specifiedDataTypeManager
to allow its use of the correspondingDataOrganization
while retaining its unique identity (seeDataType.getUniversalID()
and archive association (seeDataType.getSourceArchive()
) if applicable.copy
(DataTypeManager dtm) Returns a new instance (shallow copy) of this DataType with a new identity and no source archive association.void
Informs this datatype that the given datatype has been deleted.void
dataTypeNameChanged
(DataType dt, String oldName) Informs this datatype that its name has changed from the indicated old name.void
dataTypeReplaced
(DataType oldDt, DataType newDt) Informs this datatype that the given oldDT has been replaced with newDTvoid
Notification that the given datatype's size has changed.boolean
Check if this datatype depends on the existence of the given datatype.Get function signature parameter argumentsGets the calling convention prototype model for this function if associated with a compiler specificfation.Returns the calling convention name associated with this function definition.Get descriptive comment for signatureGet a String briefly describing this DataType.int
Get the length of this DataType as a number of 8-bit bytes.getMnemonic
(Settings settings) Get the mnemonic for this DataType.Get string representation of the function signature without the calling convention specified.getPrototypeString
(boolean includeCallingConvention) Get string representation of the function signaturegetRepresentation
(MemBuffer buf, Settings settings, int length) Get bytes from memory in a printable format for this type.Get function signature return typeReturns the interpreted data value as an instance of theadvertised value class
.boolean
boolean
boolean
isEquivalent
(DataType dt) Check if the given datatype is equivalent to this datatype.boolean
isEquivalentSignature
(FunctionSignature signature) Returns true if the given signature is equivalent to this signature.void
replaceArgument
(int ordinal, String newName, DataType dt, String newComment, SourceType source) Replace the given argument with another data typevoid
setArguments
(ParameterDefinition[] args) Set the arguments to this function.void
setCallingConvention
(String conventionName) Set the calling convention associated with this function definition.void
setComment
(String comment) Set the function commentvoid
setGenericCallingConvention
(GenericCallingConvention genericCallingConvention) Set the generic calling convention associated with this function definition.void
setNoReturn
(boolean hasNoReturn) Set whether or not this function has a return.void
setReturnType
(DataType type) Set the return data type for this functionvoid
setVarArgs
(boolean hasVarArgs) Set whether parameters can be passed as a VarArg (variable argument list).toString()
Methods inherited from class ghidra.program.model.data.GenericDataType
setCategoryPath, setName, setNameAndCategory
Methods inherited from class ghidra.program.model.data.DataTypeImpl
addParent, equals, getAlignedLength, getAlignment, getDefaultSettings, getLastChangeTime, getLastChangeTimeInSourceArchive, getParents, getPathName, getSettingsDefinitions, getSourceArchive, getUniversalID, getValueClass, hashCode, notifyAlignmentChanged, notifyDeleted, notifyNameChanged, notifyParents, notifyReplaced, notifySizeChanged, removeParent, replaceWith, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setSourceArchive
Methods inherited from class ghidra.program.model.data.AbstractDataType
dataTypeAlignmentChanged, encodeRepresentation, encodeValue, getCategoryPath, getDataOrganization, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDisplayName, getDocs, getName, getTypeDefSettingsDefinitions, hasLanguageDependantLength, isDeleted, isEncodable, isNotYetDefined, isZeroLength
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface ghidra.program.model.data.DataType
addParent, dataTypeAlignmentChanged, encodeRepresentation, encodeValue, getAlignedLength, getAlignment, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDefaultSettings, getDisplayName, getDocs, getLastChangeTime, getLastChangeTimeInSourceArchive, getName, getParents, getPathName, getSettingsDefinitions, getSourceArchive, getTypeDefSettingsDefinitions, getUniversalID, getValueClass, hasLanguageDependantLength, isDeleted, isEncodable, isNotYetDefined, isZeroLength, removeParent, replaceWith, setCategoryPath, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setName, setNameAndCategory, setSourceArchive
Methods inherited from interface ghidra.program.model.listing.FunctionSignature
getName, hasUnknownCallingConventionName
-
Constructor Details
-
FunctionDefinitionDataType
-
FunctionDefinitionDataType
-
FunctionDefinitionDataType
-
FunctionDefinitionDataType
-
FunctionDefinitionDataType
-
FunctionDefinitionDataType
-
FunctionDefinitionDataType
-
FunctionDefinitionDataType
public FunctionDefinitionDataType(CategoryPath path, String name, FunctionSignature sig, DataTypeManager dtm) -
FunctionDefinitionDataType
public FunctionDefinitionDataType(CategoryPath path, String name, FunctionSignature sig, UniversalID universalID, SourceArchive sourceArchive, long lastChangeTime, long lastChangeTimeInSourceArchive, DataTypeManager dtm) -
FunctionDefinitionDataType
Create a Function Definition based on a Function- Parameters:
function
- the function to use to create a Function Signature.formalSignature
- if true only original formal types will be retained and auto-params discarded (e.g., this, __return_storage_ptr__, etc.). If false, the effective signature will be used where forced indirect and auto-params are reflected in the signature. This option has no affect if the specified function has custom storage enabled.
-
-
Method Details
-
setArguments
Description copied from interface:FunctionDefinition
Set the arguments to this function.- Specified by:
setArguments
in interfaceFunctionDefinition
- Parameters:
args
- array of parameter definitions to be used as arguments to this function
-
setReturnType
Description copied from interface:FunctionDefinition
Set the return data type for this function- Specified by:
setReturnType
in interfaceFunctionDefinition
- Parameters:
type
- the return datatype to be set.
-
setComment
Description copied from interface:FunctionDefinition
Set the function comment- Specified by:
setComment
in interfaceFunctionDefinition
- Parameters:
comment
- the comment to set.
-
setVarArgs
public void setVarArgs(boolean hasVarArgs) Description copied from interface:FunctionDefinition
Set whether parameters can be passed as a VarArg (variable argument list).- Specified by:
setVarArgs
in interfaceFunctionDefinition
- Parameters:
hasVarArgs
- true if this function has a variable argument list (ie printf(fmt, ...)).
-
setNoReturn
public void setNoReturn(boolean hasNoReturn) Description copied from interface:FunctionDefinition
Set whether or not this function has a return.- Specified by:
setNoReturn
in interfaceFunctionDefinition
- Parameters:
hasNoReturn
- true if this function does not return.
-
setGenericCallingConvention
Description copied from interface:FunctionDefinition
Set the generic calling convention associated with this function definition.
The total number of unique calling convention names used within a givenProgram
orDataTypeManager
may be limited (e.g., 127). When this limit is exceeded an error will be logged and this setting ignored.- Specified by:
setGenericCallingConvention
in interfaceFunctionDefinition
- Parameters:
genericCallingConvention
- generic calling convention
-
setCallingConvention
Description copied from interface:FunctionDefinition
Set the calling convention associated with this function definition.
The total number of unique calling convention names used within a givenProgram
orDataTypeManager
may be limited (e.g., 127). When this limit is exceeded an error will be logged and this setting ignored.- Specified by:
setCallingConvention
in interfaceFunctionDefinition
- Parameters:
conventionName
- calling convention name or null. This name is restricted to those defined byGenericCallingConvention
, the associated compiler specification. The prototype model declaration name form (e.g., "__stdcall") should be specified as it appears in a compiler specification (*.cspec). The special "unknown" and "default" names are also allowed.- Throws:
InvalidInputException
- if specified conventionName is not defined byGenericCallingConvention
or the associated compiler specification if datatype manager has an associated program architecture.
-
getCallingConvention
Description copied from interface:FunctionSignature
Gets the calling convention prototype model for this function if associated with a compiler specificfation. This method will always return null if signature is not associated with a specific program architecture.- Specified by:
getCallingConvention
in interfaceFunctionSignature
- Returns:
- the prototype model of the function's current calling convention or null.
-
getCallingConventionName
Description copied from interface:FunctionSignature
Returns the calling convention name associated with this function definition. Reserved names may also be returned:Function.UNKNOWN_CALLING_CONVENTION_STRING
,Function.DEFAULT_CALLING_CONVENTION_STRING
. The "unknown" convention must be returned instead of null.- Specified by:
getCallingConventionName
in interfaceFunctionSignature
- Returns:
- calling convention name
-
copy
Description copied from interface:DataType
Returns a new instance (shallow copy) of this DataType with a new identity and no source archive association.Any reference to other datatypes will use
DataType.clone(DataTypeManager)
. -
clone
Description copied from interface:DataType
Returns an instance of this DataType using the specifiedDataTypeManager
to allow its use of the correspondingDataOrganization
while retaining its unique identity (seeDataType.getUniversalID()
and archive association (seeDataType.getSourceArchive()
) if applicable.This instance will be returned if this datatype's DataTypeManager matches the specified dtm. The recursion depth of a clone will stop on any datatype whose
DataTypeManager
matches the specified dtm and simply use the existing datatype instance.NOTE: In general, this method should not be used to obtain an instance to be modified. In most cases changes may be made directly to this instance if supported or to a
DataType.copy(DataTypeManager)
of this type. -
getMnemonic
Description copied from interface:DataType
Get the mnemonic for this DataType.- Specified by:
getMnemonic
in interfaceDataType
- Overrides:
getMnemonic
in classAbstractDataType
- Parameters:
settings
- settings which may influence the result or null- Returns:
- the mnemonic for this DataType.
-
getLength
public int getLength()Description copied from interface:DataType
Get the length of this DataType as a number of 8-bit bytes.For primitive datatypes this reflects the smallest varnode which can be used to contain its value (i.e., raw data length).
Example: For x86 32-bit gcc an 80-bit
long double
raw data length
of 10-bytes will fit within a floating point register while itsaligned-length
of 12-bytes is used by the gcc compiler for data/array/component allocations to maintain alignment (i.e.,sizeof(long double)
).NOTE: Other than the
VoidDataType
, no datatype should ever return 0, even ifDataType.isZeroLength()
, and onlyDynamic
/FactoryDataType
datatypes should return -1. IfDataType.isZeroLength()
is true a length of 1 should be returned. Where a zero-length datatype can be handled (e.g.,Composite
) theDataType.isZeroLength()
method should be used. -
getDescription
Description copied from interface:DataType
Get a String briefly describing this DataType.- Specified by:
getDescription
in interfaceDataType
- Returns:
- a one-liner describing this DataType.
-
getValue
Description copied from interface:DataType
Returns the interpreted data value as an instance of theadvertised value class
.For instance,
Pointer
data types should return an Address object (or null), or integer data types should return aScalar
object.- Specified by:
getValue
in interfaceDataType
- Parameters:
buf
- the data buffersettings
- the settings to use.length
- indicates the maximum number of bytes that may be consumed by aDynamic
datatype, otherwise this value is ignored. A value of -1 may be specified to allow a Dynamic datatype to determine the length based upon the actual data bytes- Returns:
- the data object, or null if data is invalid
-
getRepresentation
Description copied from interface:DataType
Get bytes from memory in a printable format for this type.- Specified by:
getRepresentation
in interfaceDataType
- Parameters:
buf
- the data.settings
- the settings to use for the representation.length
- the number of bytes to represent.- Returns:
- the representation of the data in this format, never null.
-
getPrototypeString
Description copied from interface:FunctionSignature
Get string representation of the function signature without the calling convention specified.- Specified by:
getPrototypeString
in interfaceFunctionSignature
- Returns:
- function signature string
-
getPrototypeString
Description copied from interface:FunctionSignature
Get string representation of the function signature- Specified by:
getPrototypeString
in interfaceFunctionSignature
- Parameters:
includeCallingConvention
- if true prototype will include call convention declaration if known as well asnoreturn
indicator if applicable.- Returns:
- function signature string
-
getArguments
Description copied from interface:FunctionSignature
Get function signature parameter arguments- Specified by:
getArguments
in interfaceFunctionSignature
- Returns:
- an array of parameters for the function
-
getReturnType
Description copied from interface:FunctionSignature
Get function signature return type- Specified by:
getReturnType
in interfaceFunctionSignature
- Returns:
- the return data type
-
getComment
Description copied from interface:FunctionSignature
Get descriptive comment for signature- Specified by:
getComment
in interfaceFunctionSignature
- Returns:
- the comment string
-
hasVarArgs
public boolean hasVarArgs()- Specified by:
hasVarArgs
in interfaceFunctionSignature
- Returns:
- true if this function signature has a variable argument list (VarArgs).
-
hasNoReturn
public boolean hasNoReturn()- Specified by:
hasNoReturn
in interfaceFunctionSignature
- Returns:
- true if this function signature corresponds to a non-returning function.
-
isEquivalent
Description copied from interface:DataType
Check if the given datatype is equivalent to this datatype.The precise meaning of "equivalent" is datatype dependent.
NOTE: if invoked by a DB object or manager it should be invoked on the DataTypeDB object passing the other datatype as the argument.- Specified by:
isEquivalent
in interfaceDataType
- Parameters:
dt
- the datatype being tested for equivalence.- Returns:
- true if the if the given datatype is equivalent to this datatype.
-
isEquivalentSignature
Description copied from interface:FunctionSignature
Returns true if the given signature is equivalent to this signature. The precise meaning of "equivalent" is dependent upon return/parameter dataTypes.- Specified by:
isEquivalentSignature
in interfaceFunctionSignature
- Parameters:
signature
- the function signature being tested for equivalence.- Returns:
- true if the if the given signature is equivalent to this signature.
-
dataTypeReplaced
Description copied from interface:DataType
Informs this datatype that the given oldDT has been replaced with newDTTODO: This method is reserved for internal DB use.
- Specified by:
dataTypeReplaced
in interfaceDataType
- Overrides:
dataTypeReplaced
in classAbstractDataType
- Parameters:
oldDt
- old datatypenewDt
- new datatype
-
replaceArgument
public void replaceArgument(int ordinal, String newName, DataType dt, String newComment, SourceType source) Description copied from interface:FunctionDefinition
Replace the given argument with another data type- Specified by:
replaceArgument
in interfaceFunctionDefinition
- Parameters:
ordinal
- the index of the argument to be replaced, starting from '0'newName
- name of the new argumentdt
- data type of the new argumentnewComment
- comment for the argumentsource
- the source of this function definition argument: Symbol.DEFAULT, Symbol.ANALYSIS, Symbol.IMPORTED, or Symbol.USER_DEFINED
-
dataTypeSizeChanged
Description copied from interface:DataType
Notification that the given datatype's size has changed.DataTypes may need to make internal changes in response.
TODO: This method is reserved for internal DB use.- Specified by:
dataTypeSizeChanged
in interfaceDataType
- Overrides:
dataTypeSizeChanged
in classAbstractDataType
- Parameters:
dt
- the datatype that has changed.
-
dataTypeDeleted
Description copied from interface:DataType
Informs this datatype that the given datatype has been deleted.TODO: This method is reserved for internal DB use.
- Specified by:
dataTypeDeleted
in interfaceDataType
- Overrides:
dataTypeDeleted
in classAbstractDataType
- Parameters:
dt
- the datatype that has been deleted.
-
dataTypeNameChanged
Description copied from interface:DataType
Informs this datatype that its name has changed from the indicated old name.TODO: This method is reserved for internal DB use.
- Specified by:
dataTypeNameChanged
in interfaceDataType
- Overrides:
dataTypeNameChanged
in classAbstractDataType
- Parameters:
dt
- the datatype whose name changedoldName
- the datatype's old name
-
dependsOn
Description copied from interface:DataType
Check if this datatype depends on the existence of the given datatype.For example byte[] depends on byte. If byte were deleted, then byte[] would also be deleted.
- Specified by:
dependsOn
in interfaceDataType
- Overrides:
dependsOn
in classAbstractDataType
- Parameters:
dt
- the datatype to test that this datatype depends on.- Returns:
- true if the existence of this datatype relies on the existence of the specified datatype dt.
-
toString
- Overrides:
toString
in classAbstractDataType
-