Ghidra 11.4.2
Ghidra internal decompiler documentation.
Loading...
Searching...
No Matches
ghidra::ExtraStack Class Reference

Consume stack resources as a side-effect. More...

#include <modelrules.hh>

Inheritance diagram for ghidra::ExtraStack:
[legend]
Collaboration diagram for ghidra::ExtraStack:
[legend]

Public Member Functions

 ExtraStack (const ParamListStandard *res, int4 val)
 Constructor for use with decode.
 
 ExtraStack (const ParamListStandard *res)
 Constructor.
 
virtual AssignActionclone (const ParamListStandard *newResource) const
 Make a copy of this action.
 
virtual uint4 assignAddress (Datatype *dt, const PrototypePieces &proto, int4 pos, TypeFactory &tlist, vector< int4 > &status, ParameterPieces &res) const
 Assign an address and other meta-data for a specific parameter or for return storage in context.
 
virtual void decode (Decoder &decoder)
 Configure any details of how this action should behave from the stream.
 
- Public Member Functions inherited from ghidra::AssignAction
 AssignAction (const ParamListStandard *res)
 Constructor.
 
bool canAffectFillinOutput (void) const
 Return true if fillinOutputMap is active.
 
virtual bool fillinOutputMap (ParamActive *active) const
 Test if this action could produce return value storage matching the given set of trials.
 

Private Member Functions

void initializeEntry (void)
 Find stack entry in resource list.
 

Private Attributes

const ParamEntrystackEntry
 Parameter Entry corresponding to the stack.
 

Additional Inherited Members

- Public Types inherited from ghidra::AssignAction
enum  {
  success , fail , no_assignment , hiddenret_ptrparam ,
  hiddenret_specialreg , hiddenret_specialreg_void
}
 
- Static Public Member Functions inherited from ghidra::AssignAction
static AssignActiondecodeAction (Decoder &decoder, const ParamListStandard *res)
 Read the next model rule action element from the stream.
 
static AssignActiondecodeSideeffect (Decoder &decoder, const ParamListStandard *res)
 Read the next model rule sideeffect element from the stream.
 
- Protected Attributes inherited from ghidra::AssignAction
const ParamListStandardresource
 Resources to which this action applies.
 
bool fillinOutputActive
 If true, fillinOutputMap is active.
 

Detailed Description

Consume stack resources as a side-effect.

This action is a side-effect and doesn't assign an address for the current parameter. If the current parameter has been assigned a address that is not on the stack, this action consumes stack resources as if the parameter were allocated to the stack. If the current parameter was already assigned a stack address, no additional action is taken.

Constructor & Destructor Documentation

◆ ExtraStack()

ghidra::ExtraStack::ExtraStack ( const ParamListStandard res,
int4  val 
)

Constructor for use with decode.

Parameters
resis the new resource set to associate with this action
valis a dummy value

References stackEntry.

Member Function Documentation

◆ assignAddress()

uint4 ghidra::ExtraStack::assignAddress ( Datatype dt,
const PrototypePieces proto,
int4  pos,
TypeFactory tlist,
vector< int4 > &  status,
ParameterPieces res 
) const
virtual

Assign an address and other meta-data for a specific parameter or for return storage in context.

The Address is assigned based on the data-type of the parameter, available register resources, and other details of the function prototype. Consumed resources are marked. This method returns a response code:

  • success - indicating the Address was successfully assigned
  • fail - if the Address could not be assigned
  • hiddenret_ptrparam - if an additional hidden return parameter is required
Parameters
dtis the data-type of the parameter or return value
protois the high-level description of the function prototype
posis the position of the parameter (pos>=0) or return storage (pos=-1)
tlistis a data-type factory for (possibly) transforming the data-type
statusis the resource consumption array
reswill hold the resulting description of the parameter
Returns
the response code

Implements ghidra::AssignAction.

References ghidra::ParameterPieces::addr, ghidra::ParamEntry::getAddrBySlot(), ghidra::Datatype::getAlignment(), ghidra::ParamEntry::getGroup(), ghidra::Datatype::getSize(), ghidra::Address::getSpace(), ghidra::ParamEntry::getSpace(), stackEntry, and ghidra::AssignAction::success.

◆ clone()

virtual AssignAction * ghidra::ExtraStack::clone ( const ParamListStandard newResource) const
inlinevirtual

Make a copy of this action.

Parameters
newResourceis the new resource object that will own the clone
Returns
the newly allocated copy

Implements ghidra::AssignAction.

◆ decode()

void ghidra::ExtraStack::decode ( Decoder decoder)
virtual

Configure any details of how this action should behave from the stream.

Parameters
decoderis the given stream decoder

Implements ghidra::AssignAction.

References ghidra::Decoder::closeElement(), initializeEntry(), and ghidra::Decoder::openElement().


The documentation for this class was generated from the following files: