Allocate the return value as special input register. More...

#include <modelrules.hh>

Inheritance diagram for ghidra::HiddenReturnAssign:

Public Member Functions
	HiddenReturnAssign (const ParamListStandard *res, bool voidLock)
	Constructor.

virtual AssignAction *	clone (const ParamListStandard *newResource) const
	Make a copy of this action. More...

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. More...

virtual void	decode (Decoder &decoder)
	Configure any details of how this action should behave from the stream. More...

Public Member Functions inherited from ghidra::AssignAction
	AssignAction (const ParamListStandard *res)
	Constructor.

virtual AssignAction *	clone (const ParamListStandard *newResource) const =0
	Make a copy of this action. More...

virtual uint4	assignAddress (Datatype *dt, const PrototypePieces &proto, int4 pos, TypeFactory &tlist, vector< int4 > &status, ParameterPieces &res) const =0
	Assign an address and other meta-data for a specific parameter or for return storage in context. More...

virtual void	decode (Decoder &decoder)=0
	Configure any details of how this action should behave from the stream. More...

Private Attributes
uint4	retCode
	The specific signal to pass back.

Additional Inherited Members
Public Types inherited from ghidra::AssignAction
enum	{ success , fail , hiddenret_ptrparam , hiddenret_specialreg , hiddenret_specialreg_void }

Static Public Member Functions inherited from ghidra::AssignAction
static AssignAction *	decodeAction (Decoder &decoder, const ParamListStandard *res)
	Read the next model rule action element from the stream. More...

static AssignAction *	decodeSideeffect (Decoder &decoder, const ParamListStandard *res)
	Read the next model rule sideeffect element from the stream. More...

Protected Attributes inherited from ghidra::AssignAction
const ParamListStandard *	resource
	Resources to which this action applies.

Detailed Description

Allocate the return value as special input register.

The assignAddress() method signals with hiddenret_specialreg, indicating that the input register assignMap() method should use storage class TYPECLASS_HIDDENRET to assign an additional input register to hold a pointer to the return value. This is different than the default hiddenret action that assigns a location based TYPECLASS_PTR and generally consumes a general purpose input register.

Member Function Documentation

◆ assignAddress()

uint4 ghidra::HiddenReturnAssign::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

dt	is the data-type of the parameter or return value
proto	is the high-level description of the function prototype
pos	is the position of the parameter (pos>=0) or return storage (pos=-1)
tlist	is a data-type factory for (possibly) transforming the data-type
status	is the resource consumption array
res	will hold the resulting description of the parameter