Package ghidra.program.model.data

Class FunctionDefinitionDataType

java.lang.Object

ghidra.program.model.data.AbstractDataType

ghidra.program.model.data.DataTypeImpl

ghidra.program.model.data.GenericDataType

ghidra.program.model.data.FunctionDefinitionDataType

All Implemented Interfaces:

DataType, FunctionDefinition, FunctionSignature

Direct Known Subclasses:

FunctionSignatureImpl

public class FunctionDefinitionDataType
extends GenericDataType
implements FunctionDefinition

Definition of a function for things like function pointers.

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, VOID

Fields inherited from interface ghidra.program.model.listing.FunctionSignature

VAR_ARGS_DISPLAY_STRING, VOID_PARAM_DISPLAY_STRING

Constructor Summary

Constructors

Constructor	Description
FunctionDefinitionDataType(CategoryPath path, java.lang.String name)
FunctionDefinitionDataType(CategoryPath path, java.lang.String name, DataTypeManager dtm)
FunctionDefinitionDataType(CategoryPath path, java.lang.String name, FunctionSignature sig)
FunctionDefinitionDataType(CategoryPath path, java.lang.String name, FunctionSignature sig, DataTypeManager dtm)
FunctionDefinitionDataType(CategoryPath path, java.lang.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 Function
FunctionDefinitionDataType(FunctionSignature sig)
FunctionDefinitionDataType(FunctionSignature sig, DataTypeManager dtm)
FunctionDefinitionDataType(java.lang.String name)
FunctionDefinitionDataType(java.lang.String name, DataTypeManager dtm)

Method Summary

Modifier and Type	Method	Description
DataType	clone(DataTypeManager dtm)	Returns an instance of this DataType with its universalID and SourceArchive identity retained.
DataType	copy(DataTypeManager dtm)	Returns a new instance (shallow copy) of this DataType with a new identity.
void	dataTypeDeleted(DataType dt)	Informs this datatype that the given datatype has been deleted.
void	dataTypeNameChanged(DataType dt, java.lang.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 newDT
void	dataTypeSizeChanged(DataType dt)	Notification that the given datatype's size has changed.
boolean	dependsOn(DataType dt)	Check if this datatype depends on the existence of the given datatype.
ParameterDefinition[]	getArguments()	Return an array of parameters for the function
java.lang.String	getComment()	Return the comment string
java.lang.String	getDescription()	Get a String briefly describing this DataType.
GenericCallingConvention	getGenericCallingConvention()	Returns the generic calling convention associated with this function definition.
int	getLength()	Get the length (number of 8-bit bytes) of this DataType.
java.lang.String	getMnemonic(Settings settings)	Get the mnemonic for this DataType.
java.lang.String	getPrototypeString()	Return a string representation of the function signature without the calling convention specified.
java.lang.String	getPrototypeString(boolean includeCallingConvention)	Return a string representation of the function signature
java.lang.String	getRepresentation(MemBuffer buf, Settings settings, int length)	Get bytes from memory in a printable format for this type.
DataType	getReturnType()	Return the return data type
java.lang.Object	getValue(MemBuffer buf, Settings settings, int length)	Get the data in the form of the appropriate Object for this DataType.
boolean	hasVarArgs()	Returns true if this function signature has a variable argument list (VarArgs).
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, java.lang.String newName, DataType dt, java.lang.String newComment, SourceType source)	Replace the given argument with another data type
void	setArguments(ParameterDefinition[] args)	Set the arguments to this function.
void	setComment(java.lang.String comment)	Set the function comment
void	setGenericCallingConvention(GenericCallingConvention genericCallingConvention)	Set the generic calling convention associated with this function definition.
void	setReturnType(DataType type)	Set the return data type for this function
void	setVarArgs(boolean hasVarArgs)	Set whether parameters can be passed as a VarArg (variable argument list).
java.lang.String	toString()

Methods inherited from class ghidra.program.model.data.GenericDataType

setCategoryPath, setName, setNameAndCategory

Methods inherited from class ghidra.program.model.data.DataTypeImpl

addParent, equals, getAlignment, getDefaultSettings, getLastChangeTime, getLastChangeTimeInSourceArchive, getParents, getPathName, getSettingsDefinitions, getSourceArchive, getUniversalID, getValueClass, hashCode, notifyAlignmentChanged, notifyDeleted, notifyNameChanged, notifyParents, notifyReplaced, notifySizeChanged, removeParent, replaceWith, setDefaultSettings, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setSourceArchive

Methods inherited from class ghidra.program.model.data.AbstractDataType

dataTypeAlignmentChanged, encodeRepresentation, encodeValue, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDisplayName, getDocs, getName, 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, getAlignment, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDefaultSettings, getDisplayName, getDocs, getLastChangeTime, getLastChangeTimeInSourceArchive, getName, getParents, getPathName, getSettingsDefinitions, getSourceArchive, getUniversalID, getValueClass, hasLanguageDependantLength, isDeleted, isEncodable, isNotYetDefined, isZeroLength, removeParent, replaceWith, setCategoryPath, setDefaultSettings, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setName, setNameAndCategory, setSourceArchive

Methods inherited from interface ghidra.program.model.listing.FunctionSignature

getName

Constructor Detail

FunctionDefinitionDataType

public FunctionDefinitionDataType(java.lang.String name)

FunctionDefinitionDataType

public FunctionDefinitionDataType(java.lang.String name,
                                  DataTypeManager dtm)

FunctionDefinitionDataType

public FunctionDefinitionDataType(CategoryPath path,
                                  java.lang.String name)

FunctionDefinitionDataType

public FunctionDefinitionDataType(CategoryPath path,
                                  java.lang.String name,
                                  DataTypeManager dtm)

FunctionDefinitionDataType

public FunctionDefinitionDataType(FunctionSignature sig)

FunctionDefinitionDataType

public FunctionDefinitionDataType(FunctionSignature sig,
                                  DataTypeManager dtm)

FunctionDefinitionDataType

public FunctionDefinitionDataType(CategoryPath path,
                                  java.lang.String name,
                                  FunctionSignature sig)

FunctionDefinitionDataType

public FunctionDefinitionDataType(CategoryPath path,
                                  java.lang.String name,
                                  FunctionSignature sig,
                                  DataTypeManager dtm)

FunctionDefinitionDataType

public FunctionDefinitionDataType(CategoryPath path,
                                  java.lang.String name,
                                  FunctionSignature sig,
                                  UniversalID universalID,
                                  SourceArchive sourceArchive,
                                  long lastChangeTime,
                                  long lastChangeTimeInSourceArchive,
                                  DataTypeManager dtm)

FunctionDefinitionDataType

public FunctionDefinitionDataType(Function function,
                                  boolean formalSignature)

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 Detail

setArguments

public void setArguments(ParameterDefinition[] args)

Description copied from interface: FunctionDefinition

Set the arguments to this function.

Specified by:

setArguments in interface FunctionDefinition

Parameters:

args - array of parameter definitions to be used as arguments to this function

setReturnType

public void setReturnType(DataType type)

Description copied from interface: FunctionDefinition

Set the return data type for this function

Specified by:

setReturnType in interface FunctionDefinition

Parameters:

type - the return datatype to be set.

setComment

public void setComment(java.lang.String comment)

Description copied from interface: FunctionDefinition

Set the function comment

Specified by:

setComment in interface FunctionDefinition

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 interface FunctionDefinition

Parameters:

hasVarArgs - true if this function has a variable argument list (ie printf(fmt, ...)).

setGenericCallingConvention

public void setGenericCallingConvention(GenericCallingConvention genericCallingConvention)

Description copied from interface: FunctionDefinition

Set the generic calling convention associated with this function definition.

Specified by:

setGenericCallingConvention in interface FunctionDefinition

Parameters:

genericCallingConvention - generic calling convention

getGenericCallingConvention

public GenericCallingConvention getGenericCallingConvention()

Description copied from interface: FunctionSignature

Returns the generic calling convention associated with this function definition. The "unknown" convention should be returned instead of null.

Specified by:

getGenericCallingConvention in interface FunctionSignature

copy

public DataType copy(DataTypeManager dtm)

Description copied from interface: DataType

Returns a new instance (shallow copy) of this DataType with a new identity.

Any reference to other datatypes will use DataType.clone(DataTypeManager).

Specified by:

copy in interface DataType

Parameters:

dtm - the data-type manager instance whose data-organization should apply.

Returns:

new instanceof of this datatype

clone

public DataType clone(DataTypeManager dtm)

Description copied from interface: DataType

Returns an instance of this DataType with its universalID and SourceArchive identity retained.

The current instanceof 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.

Specified by:

clone in interface DataType

Parameters:

dtm - the data-type manager instance whose data-organization should apply.

Returns:

cloned instance which may be the same as this instance

getMnemonic

public java.lang.String getMnemonic(Settings settings)

Description copied from interface: DataType

Get the mnemonic for this DataType.

Specified by:

getMnemonic in interface DataType

Overrides:

getMnemonic in class AbstractDataType

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 (number of 8-bit bytes) of this DataType.

NOTE: No datatype should ever return 0, even if DataType.isZeroLength(), and only Dynamic datatypes should return -1. If DataType.isZeroLength() is true a length of 1 should be returned. Where a zero-length datatype can be handled (e.g., Composite) the DataType.isZeroLength() method should be used.

Specified by:

getLength in interface DataType

Returns:

the length of this DataType

getDescription

public java.lang.String getDescription()

Description copied from interface: DataType

Get a String briefly describing this DataType.

Specified by:

getDescription in interface DataType

Returns:

a one-liner describing this DataType.

getValue

public java.lang.Object getValue(MemBuffer buf,
                                 Settings settings,
                                 int length)

Description copied from interface: DataType

Get the data in the form of the appropriate Object for this DataType.

For instance if the datatype is an AddressDT, return an Address object. a Byte, return a Scalar* (maybe this should be a Byte) a Float, return a Float

Specified by:

getValue in interface DataType

Parameters:

buf - the data buffer.

settings - the settings to use.

length - the number of bytes to get the value from.

Returns:

the data Object.

getRepresentation

public java.lang.String getRepresentation(MemBuffer buf,
                                          Settings settings,
                                          int length)

Description copied from interface: DataType

Get bytes from memory in a printable format for this type.

Specified by:

getRepresentation in interface DataType

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

public java.lang.String getPrototypeString()

Description copied from interface: FunctionSignature

Return a string representation of the function signature without the calling convention specified.

Specified by:

getPrototypeString in interface FunctionSignature

getPrototypeString

public java.lang.String getPrototypeString(boolean includeCallingConvention)

Description copied from interface: FunctionSignature

Return a string representation of the function signature

Specified by:

getPrototypeString in interface FunctionSignature

Parameters:

includeCallingConvention - if true prototype will include call convention declaration if known.

getArguments

public ParameterDefinition[] getArguments()

Description copied from interface: FunctionSignature

Return an array of parameters for the function

Specified by:

getArguments in interface FunctionSignature

getReturnType

public DataType getReturnType()

Description copied from interface: FunctionSignature

Return the return data type

Specified by:

getReturnType in interface FunctionSignature

getComment

public java.lang.String getComment()

Description copied from interface: FunctionSignature

Return the comment string

Specified by:

getComment in interface FunctionSignature

hasVarArgs

public boolean hasVarArgs()

Description copied from interface: FunctionSignature

Returns true if this function signature has a variable argument list (VarArgs).

Specified by:

hasVarArgs in interface FunctionSignature

isEquivalent

public boolean isEquivalent(DataType dt)

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 interface DataType

Parameters:

dt - the datatype being tested for equivalence.

Returns:

true if the if the given datatype is equivalent to this datatype.

isEquivalentSignature

public boolean isEquivalentSignature(FunctionSignature signature)

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 interface FunctionSignature

Parameters:

signature - the function signature being tested for equivalence.

Returns:

true if the if the given signature is equivalent to this signature.

dataTypeReplaced

public void dataTypeReplaced(DataType oldDt,
                             DataType newDt)

Description copied from interface: DataType

Informs this datatype that the given oldDT has been replaced with newDT

TODO: This method is reserved for internal DB use.

Specified by:

dataTypeReplaced in interface DataType

Overrides:

dataTypeReplaced in class AbstractDataType

Parameters:

oldDt - old datatype

newDt - new datatype

replaceArgument

public void replaceArgument(int ordinal,
                            java.lang.String newName,
                            DataType dt,
                            java.lang.String newComment,
                            SourceType source)

Description copied from interface: FunctionDefinition

Replace the given argument with another data type

Specified by:

replaceArgument in interface FunctionDefinition

Parameters:

ordinal - the index of the argument to be replaced, starting from '0'

newName - name of the new argument

dt - data type of the new argument

newComment - comment for the argument

source - the source of this function definition argument: Symbol.DEFAULT, Symbol.ANALYSIS, Symbol.IMPORTED, or Symbol.USER_DEFINED

dataTypeSizeChanged

public void dataTypeSizeChanged(DataType dt)

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 interface DataType

Overrides:

dataTypeSizeChanged in class AbstractDataType

Parameters:

dt - the datatype that has changed.

dataTypeDeleted

public void dataTypeDeleted(DataType dt)

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 interface DataType

Overrides:

dataTypeDeleted in class AbstractDataType

Parameters:

dt - the datatype that has been deleted.

dataTypeNameChanged

public void dataTypeNameChanged(DataType dt,
                                java.lang.String oldName)

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 interface DataType

Overrides:

dataTypeNameChanged in class AbstractDataType

Parameters:

dt - the datatype whose name changed

oldName - the datatype's old name

dependsOn

public boolean dependsOn(DataType dt)

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 interface DataType

Overrides:

dependsOn in class AbstractDataType

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

public java.lang.String toString()

Overrides:

toString in class AbstractDataType