Package ghidra.program.model.listing
Class ParameterImpl
java.lang.Object
ghidra.program.model.listing.ParameterImpl
- All Implemented Interfaces:
Parameter
,Variable
,Comparable<Variable>
- Direct Known Subclasses:
AutoParameterImpl
,ReturnParameterImpl
Generic implementation of Parameter.
-
Field Summary
Fields inherited from interface ghidra.program.model.listing.Parameter
RETURN_NAME, RETURN_ORIDINAL, UNASSIGNED_ORDINAL
-
Constructor Summary
ConstructorDescriptionParameterImpl
(Parameter param, Program program) Construct a parameter from another.ParameterImpl
(String name, int ordinal, DataType dataType, VariableStorage storage, boolean force, Program program, SourceType sourceType) Construct a parameter with one or more associated storage elements.ParameterImpl
(String name, DataType dataType, int stackOffset, Program program) Construct a stack parameter at the specified stack offset.ParameterImpl
(String name, DataType dataType, int stackOffset, Program program, SourceType sourceType) Construct a stack parameter at the specified stack offset.ParameterImpl
(String name, DataType dataType, Address storageAddr, Program program) Construct a parameter with a single storage element at the specified address.ParameterImpl
(String name, DataType dataType, Address storageAddr, Program program, SourceType sourceType) Construct a parameter with a single storage element at the specified address.ParameterImpl
(String name, DataType dataType, Register register, Program program) Construct a register parameter using the specified register.ParameterImpl
(String name, DataType dataType, Register register, Program program, SourceType sourceType) Construct a register parameter using the specified register.ParameterImpl
(String name, DataType dataType, Program program) Construct a parameter which has no specific storage specified.ParameterImpl
(String name, DataType dataType, Program program, SourceType sourceType) Construct a parameter which has no specific storage specified.ParameterImpl
(String name, DataType dataType, VariableStorage storage, Program program) Construct a parameter with one or more associated storage elements.ParameterImpl
(String name, DataType dataType, VariableStorage storage, Program program, SourceType sourceType) Construct a parameter with one or more associated storage elements. -
Method Summary
Modifier and TypeMethodDescriptionfinal int
final boolean
If this is an auto-parameter this method will indicate its type.final String
Get the Comment for this variableGet the Data Type of this variablefinal Varnode
Get the first storage varnode for this variablefinal int
Get the original formal signature data type before a possible forced indirect was possibly imposed by the functions calling convention.Returns the function that contains this Variable.final Varnode
Get the last storage varnode for this variablefinal int
Get the length of this variablefinal Address
final String
getName()
Get the Name of this variable or null if not assigned or not-applicablefinal int
Returns the ordinal (index) of this parameter within the function signature.final Program
Returns the program that contains this variable or is the intended targetfinal Register
final SourceType
Get the source of this variablefinal int
final Symbol
final VariableStorage
Get the variable storage associated with this variable.final boolean
protected final boolean
Determine if current name is a default name.int
hashCode()
final boolean
boolean
final boolean
final boolean
isEquivalent
(Variable otherVar) Determine is another variable is equivalent to this variable.boolean
If this parameter which was forced by the associated calling convention to be passed as a pointer instead of its original formal type.final boolean
final boolean
final boolean
final boolean
final boolean
isValid()
Verify that the variable is valid (i.e., storage is valid and size matches variable data type size)protected boolean
void
setComment
(String comment) Set the comment for this variablefinal void
setDataType
(DataType type, boolean align, boolean force, SourceType source) Set the Data Type of this variable.void
setDataType
(DataType type, VariableStorage storage, boolean force, SourceType source) Set the Data Type of this variable and the associated storage whose size matches the data type length.void
setDataType
(DataType type, SourceType source) Set the Data Type of this variable using the default alignment behavior (implementation specific).void
setName
(String name, SourceType source) Set the name of this variable.toString()
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.lang.Comparable
compareTo
Methods inherited from interface ghidra.program.model.listing.Variable
getComment, getFirstStorageVarnode, getFunction, getLastStorageVarnode, getLength, getMinAddress, getName, getProgram, getRegister, getRegisters, getSource, getStackOffset, getSymbol, getVariableStorage, hasAssignedStorage, hasStackStorage, isCompoundVariable, isEquivalent, isMemoryVariable, isRegisterVariable, isStackVariable, isUniqueVariable, isValid, setComment, setDataType, setDataType, setDataType, setName
-
Field Details
-
ordinal
protected int ordinal
-
-
Constructor Details
-
ParameterImpl
Construct a parameter from another.- Parameters:
param
- parameter to be copiedprogram
- target program- Throws:
InvalidInputException
- if dataType restrictions are violated
-
ParameterImpl
Construct a parameter which has no specific storage specified. Ordinal assignment is not established (UNASSIGNED_ORDINAL).- Parameters:
name
- variable name or null for default namedataType
- a fixed-length datatype. (NOTE: Should be cloned to program datatype manager prior to determining storage elements since their length may change)program
- target program- Throws:
InvalidInputException
- if dataType restrictions are violated
-
ParameterImpl
public ParameterImpl(String name, DataType dataType, Program program, SourceType sourceType) throws InvalidInputException Construct a parameter which has no specific storage specified. Ordinal assignment is not established (UNASSIGNED_ORDINAL).- Parameters:
name
- variable name or null for default namedataType
- a fixed-length datatype. (NOTE: Should be cloned to program datatype manager prior to determining storage elements since their length may change)program
- target programsourceType
- name source type- Throws:
InvalidInputException
- if dataType restrictions are violated
-
ParameterImpl
public ParameterImpl(String name, DataType dataType, int stackOffset, Program program) throws InvalidInputException Construct a stack parameter at the specified stack offset. Ordinal assignment is not established (UNASSIGNED_ORDINAL).- Parameters:
name
- variable name or null for default namedataType
- a fixed-length datatype. (NOTE: Should be cloned to program datatype manager prior to determining storage elements since their length may change)stackOffset
- parameter stack offsetprogram
- target program- Throws:
InvalidInputException
- if dataType restrictions are violated, an invalid storage address is specified, or unable to resolve storage element for specified datatypeAddressOutOfBoundsException
- if invalid stack offset specified
-
ParameterImpl
public ParameterImpl(String name, DataType dataType, int stackOffset, Program program, SourceType sourceType) throws InvalidInputException Construct a stack parameter at the specified stack offset. Ordinal assignment is not established (UNASSIGNED_ORDINAL).- Parameters:
name
- variable name or null for default namedataType
- a fixed-length datatype. (NOTE: Should be cloned to program datatype manager prior to determining storage elements since their length may change)stackOffset
- parameter stack offsetprogram
- target programsourceType
- name source type- Throws:
InvalidInputException
- if dataType restrictions are violated, an invalid storage address is specified, or unable to resolve storage element for specified datatypeAddressOutOfBoundsException
- if invalid stack offset specified
-
ParameterImpl
public ParameterImpl(String name, DataType dataType, Register register, Program program) throws InvalidInputException Construct a register parameter using the specified register. Ordinal assignment is not established (UNASSIGNED_ORDINAL).- Parameters:
name
- variable name or null for default namedataType
- a fixed-length datatype. (NOTE: Should be cloned to program datatype manager prior to determining storage elements since their length may change)register
- parameter register storageprogram
- target program- Throws:
InvalidInputException
- if dataType restrictions are violated, an invalid storage address is specified, or unable to resolve storage element for specified datatype
-
ParameterImpl
public ParameterImpl(String name, DataType dataType, Register register, Program program, SourceType sourceType) throws InvalidInputException Construct a register parameter using the specified register. Ordinal assignment is not established (UNASSIGNED_ORDINAL).- Parameters:
name
- variable name or null for default namedataType
- a fixed-length datatype. (NOTE: Should be cloned to program datatype manager prior to determining storage elements since their length may change)register
- parameter register storageprogram
- target programsourceType
- name source type- Throws:
InvalidInputException
- if dataType restrictions are violated, an invalid storage address is specified, or unable to resolve storage element for specified datatype
-
ParameterImpl
public ParameterImpl(String name, DataType dataType, Address storageAddr, Program program) throws InvalidInputException Construct a parameter with a single storage element at the specified address. If address is contained within a register it may get realigned to the register based upon the resolved datatype length. Variable storage will be aligned to the least-significant portion of the register. Ordinal assignment is not established (UNASSIGNED_ORDINAL).- Parameters:
name
- variable name or null for default namedataType
- a fixed-length datatype. (NOTE: Should be cloned to program datatype manager prior to determining storage elements since their length may change)storageAddr
- storage address or null if no storage has been identifiedprogram
- target program- Throws:
InvalidInputException
- if dataType restrictions are violated, an invalid storage address is specified, or unable to resolve storage element for specified datatype
-
ParameterImpl
public ParameterImpl(String name, DataType dataType, Address storageAddr, Program program, SourceType sourceType) throws InvalidInputException Construct a parameter with a single storage element at the specified address. If address is contained within a register it may get realigned to the register based upon the resolved datatype length. Variable storage will be aligned to the least-significant portion of the register. Ordinal assignment is not established (UNASSIGNED_ORDINAL).- Parameters:
name
- variable name or null for default namedataType
- a fixed-length datatype. (NOTE: Should be cloned to program datatype manager prior to determining storage elements since their length may change)storageAddr
- storage address or null if no storage has been identifiedprogram
- target programsourceType
- name source type- Throws:
InvalidInputException
- if dataType restrictions are violated, an invalid storage address is specified, or unable to resolve storage element for specified datatype
-
ParameterImpl
public ParameterImpl(String name, DataType dataType, VariableStorage storage, Program program) throws InvalidInputException Construct a parameter with one or more associated storage elements. Storage elements may get slightly modified to adjust for the resolved datatype size. Ordinal assignment is not established (UNASSIGNED_ORDINAL).- Parameters:
name
- variable name or null for default namedataType
- a fixed-length datatype. (NOTE: Should be cloned to program datatype manager prior to determining storage elements since their length may change)storage
- variable storage or null for unassigned storageprogram
- target program- Throws:
InvalidInputException
- if dataType restrictions are violated, an invalid storage element is specified, or error while resolving storage element for specified datatype
-
ParameterImpl
public ParameterImpl(String name, DataType dataType, VariableStorage storage, Program program, SourceType sourceType) throws InvalidInputException Construct a parameter with one or more associated storage elements. Storage elements may get slightly modified to adjust for the resolved datatype size. Ordinal assignment is not established (UNASSIGNED_ORDINAL).- Parameters:
name
- variable name or null for default namedataType
- a fixed-length datatype. (NOTE: Should be cloned to program datatype manager prior to determining storage elements since their length may change)storage
- variable storage or null for unassigned storageprogram
- target programsourceType
- name source type- Throws:
InvalidInputException
- if dataType restrictions are violated, an invalid storage element is specified, or error while resolving storage element for specified datatype
-
ParameterImpl
public ParameterImpl(String name, int ordinal, DataType dataType, VariableStorage storage, boolean force, Program program, SourceType sourceType) throws InvalidInputException Construct a parameter with one or more associated storage elements. Storage elements may get slightly modified to adjust for the resolved datatype size.- Parameters:
name
- variable name or null for default nameordinal
- parameter ordinal (-1 for return ordinal)dataType
- a fixed-length datatype. (NOTE: Should be cloned to program datatype manager prior to determining storage elements since their length may change)storage
- variable storage or null for unassigned storageforce
- if true storage will be forced even if incorrect sizeprogram
- target programsourceType
- name source type- Throws:
InvalidInputException
- if dataType restrictions are violated, an invalid storage element is specified, or error while resolving storage element for specified datatype
-
-
Method Details
-
hasDefaultName
protected final boolean hasDefaultName()Determine if current name is a default name. This is more important for parameters so always returning false for locals is OK.- Returns:
- true if name is reserved as a default name
-
getOrdinal
public final int getOrdinal()Description copied from interface:Parameter
Returns the ordinal (index) of this parameter within the function signature.- Specified by:
getOrdinal
in interfaceParameter
-
getFirstUseOffset
public final int getFirstUseOffset()- Specified by:
getFirstUseOffset
in interfaceVariable
- Returns:
- the first use offset relative to the function entry point.
-
getDataType
Description copied from interface:Variable
Get the Data Type of this variable- Specified by:
getDataType
in interfaceVariable
- Returns:
- the data type of the variable
-
getFormalDataType
Description copied from interface:Parameter
Get the original formal signature data type before a possible forced indirect was possibly imposed by the functions calling convention. TheVariable.getDataType()
method will always return the effective data type which corresponds to the allocated variable storage.- Specified by:
getFormalDataType
in interfaceParameter
- Returns:
- Formal data type. This type will only differ from the
Variable.getDataType()
value if this parameter isForcedIndirect.
-
isForcedIndirect
public boolean isForcedIndirect()Description copied from interface:Parameter
If this parameter which was forced by the associated calling convention to be passed as a pointer instead of its original formal type.- Specified by:
isForcedIndirect
in interfaceParameter
- Returns:
- true if this parameter was forced to be passed as a pointer instead of its original formal type
-
isAutoParameter
public boolean isAutoParameter()- Specified by:
isAutoParameter
in interfaceParameter
- Returns:
- true if this parameter is automatically generated based upon the associated function calling convention and function signature. An example of such a parameter include the "__return_storage_ptr__" parameter.
-
getAutoParameterType
Description copied from interface:Parameter
If this is an auto-parameter this method will indicate its type.- Specified by:
getAutoParameterType
in interfaceParameter
- Returns:
- auto-parameter type of null if not applicable.
-
isVoidAllowed
protected boolean isVoidAllowed()- Returns:
- true if a zero-sized void type is permitted
-
isValid
public final boolean isValid()Description copied from interface:Variable
Verify that the variable is valid (i.e., storage is valid and size matches variable data type size) -
getComment
Description copied from interface:Variable
Get the Comment for this variable- Specified by:
getComment
in interfaceVariable
- Returns:
- the comment
-
setDataType
public void setDataType(DataType type, VariableStorage storage, boolean force, SourceType source) throws InvalidInputException Description copied from interface:Variable
Set the Data Type of this variable and the associated storage whose size matches the data type length.NOTE: The storage and source are ignored if the function does not have custom storage enabled.
- Specified by:
setDataType
in interfaceVariable
- Parameters:
type
- the data typestorage
- properly sized storage for the new data typeforce
- overwrite conflicting variablessource
- variable storage source (used only for function parameters and return)- Throws:
InvalidInputException
- if data type is not a fixed length or violates storage constraints.
-
setDataType
public final void setDataType(DataType type, boolean align, boolean force, SourceType source) throws InvalidInputException Description copied from interface:Variable
Set the Data Type of this variable. The given dataType must have a fixed length.- Specified by:
setDataType
in interfaceVariable
- Parameters:
type
- the data typealign
- maintain proper stack alignment/justification if supported by implementation. If false and this is a stack variable, the current stack address/offset will not change. If true, the affect is implementation dependent since alignment can not be performed without access to a compiler specification.force
- overwrite conflicting variablessource
- signature source- Throws:
InvalidInputException
- if data type is not a fixed length or violates storage constraints.
-
setDataType
Description copied from interface:Variable
Set the Data Type of this variable using the default alignment behavior (implementation specific). The given dataType must have a fixed length. If contained within a stack-frame, data-type size will be constrained by existing variables (e.g., equivalent to force=false) Note: stack offset will be maintained for stack variables.- Specified by:
setDataType
in interfaceVariable
- Parameters:
type
- the data typesource
- signature source- Throws:
InvalidInputException
- if data type is not a fixed length or violates storage constraints.- See Also:
-
getFunction
Description copied from interface:Variable
Returns the function that contains this Variable. May be null if the variable is not in a function.- Specified by:
getFunction
in interfaceVariable
- Returns:
- containing function or null
-
getProgram
Description copied from interface:Variable
Returns the program that contains this variable or is the intended target- Specified by:
getProgram
in interfaceVariable
- Returns:
- the program.
-
getLength
public final int getLength()Description copied from interface:Variable
Get the length of this variable -
getName
Description copied from interface:Variable
Get the Name of this variable or null if not assigned or not-applicable -
getSource
Description copied from interface:Variable
Get the source of this variable -
getSymbol
-
setComment
Description copied from interface:Variable
Set the comment for this variable- Specified by:
setComment
in interfaceVariable
- Parameters:
comment
- the comment
-
setName
Description copied from interface:Variable
Set the name of this variable.- Specified by:
setName
in interfaceVariable
- Parameters:
name
- the namesource
- the source of this variable name- Throws:
InvalidInputException
- if name contains blank characters, is zero length, or is null
-
hasAssignedStorage
public final boolean hasAssignedStorage()- Specified by:
hasAssignedStorage
in interfaceVariable
- Returns:
- true if this variable has been assigned storage. This is equivalent to
Variable.getVariableStorage()
!= null
-
getVariableStorage
Description copied from interface:Variable
Get the variable storage associated with this variable.- Specified by:
getVariableStorage
in interfaceVariable
- Returns:
- the variable storage for this variable
-
getFirstStorageVarnode
Description copied from interface:Variable
Get the first storage varnode for this variable- Specified by:
getFirstStorageVarnode
in interfaceVariable
- Returns:
- the first storage varnode associated with this variable
- See Also:
-
getLastStorageVarnode
Description copied from interface:Variable
Get the last storage varnode for this variable- Specified by:
getLastStorageVarnode
in interfaceVariable
- Returns:
- the last storage varnode associated with this variable
- See Also:
-
isStackVariable
public final boolean isStackVariable()- Specified by:
isStackVariable
in interfaceVariable
- Returns:
- true if this is a simple variable consisting of a single stack varnode
which will be returned by either the
Variable.getFirstStorageVarnode()
orVariable.getLastStorageVarnode()
methods. The stack offset can be obtained using:getFirstStorageVarnode().getOffset()
-
hasStackStorage
public final boolean hasStackStorage()- Specified by:
hasStackStorage
in interfaceVariable
- Returns:
- true if this variable uses simple or compound storage which contains a stack element. If true, the last storage varnode will always be the stack element.
- See Also:
-
isRegisterVariable
public final boolean isRegisterVariable()- Specified by:
isRegisterVariable
in interfaceVariable
- Returns:
- true if this is a simple variable consisting of a single register varnode
which will be returned by either the
Variable.getFirstStorageVarnode()
orVariable.getLastStorageVarnode()
methods. The register can be obtained using theVariable.getRegister()
method.
-
getRegister
- Specified by:
getRegister
in interfaceVariable
- Returns:
- first storage register associated with this variable, else null is returned. A variable with compound storage may have more than one register or other storage in addition to the register returned by this method.
- See Also:
-
getRegisters
- Specified by:
getRegisters
in interfaceVariable
- Returns:
- all storage register(s) associated with this variable, else null is returned if no registers are used. A variable with compound storage may have more than one register or other storage in addition to the register(s) returned by this method.
- See Also:
-
getMinAddress
- Specified by:
getMinAddress
in interfaceVariable
- Returns:
- the minimum address corresponding to the first varnode of this storage
or null if this is a special empty storage:
VariableStorage.BAD_STORAGE
,VariableStorage.UNASSIGNED_STORAGE
,VariableStorage.VOID_STORAGE
-
getStackOffset
public final int getStackOffset()- Specified by:
getStackOffset
in interfaceVariable
- Returns:
- the stack offset associated with simple stack variable (i.e.,
Variable.isStackVariable()
returns true).
-
isMemoryVariable
public final boolean isMemoryVariable()- Specified by:
isMemoryVariable
in interfaceVariable
- Returns:
- true if this is a simple variable consisting of a single storage memory element
which will be returned by either the
Variable.getFirstStorageVarnode()
orVariable.getVariableStorage()
methods.
-
isUniqueVariable
public final boolean isUniqueVariable()- Specified by:
isUniqueVariable
in interfaceVariable
- Returns:
- true if this is a simple variable consisting of a single storage unique/hash element
which will be returned by either the
Variable.getFirstStorageVarnode()
orVariable.getVariableStorage()
methods. The unique hash can be obtained from the storage address offset corresponding to the single storage element.
-
isCompoundVariable
public final boolean isCompoundVariable()- Specified by:
isCompoundVariable
in interfaceVariable
- Returns:
- true if this variable uses compound storage consisting of two or more storage elements
which will be returned by the
Variable.getVariableStorage()
method. Compound variables will always use a register(s) optionally followed by other storage (i.e., stack).
-
toString
-
equals
-
hashCode
public int hashCode() -
compareTo
- Specified by:
compareTo
in interfaceComparable<Variable>
-
isEquivalent
Description copied from interface:Variable
Determine is another variable is equivalent to this variable.- Specified by:
isEquivalent
in interfaceVariable
- Parameters:
otherVar
- other variable- Returns:
- true if the specified variable is equivalent to this variable
-