Consume multiple registers to pass a data-type. More...

#include <modelrules.hh>

Inheritance diagram for ghidra::MultiSlotAssign:

Collaboration diagram for ghidra::MultiSlotAssign:

Public Member Functions
	MultiSlotAssign (const ParamListStandard *res)
	Constructor for use with decode.

	MultiSlotAssign (type_class store, bool stack, bool mostSig, bool align, bool justRight, const ParamListStandard *res)
	Constructor.

virtual AssignAction *	clone (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 bool	fillinOutputMap (ParamActive *active) const
	Test if this action could produce return value storage matching the given set of trials.

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.

Private Member Functions
void	initializeEntries (void)
	Cache specific ParamEntry needed by the action.

Private Attributes
type_class	resourceType
	Resource list from which to consume.

bool	consumeFromStack
	True if resources should be consumed from the stack.

bool	consumeMostSig
	True if resources are consumed starting with most significant bytes.

bool	enforceAlignment
	True if register resources are discarded to match alignment.

bool	justifyRight
	True if initial bytes are padding for odd data-type sizes.

const ParamEntry *	stackEntry
	The stack resource.

list< ParamEntry >::const_iterator	firstIter
	Iterator to first element in the resource list.

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 AssignAction *	decodeAction (Decoder &decoder, const ParamListStandard *res)
	Read the next model rule action element from the stream.

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

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

bool	fillinOutputActive
	If true, fillinOutputMap is active.

Detailed Description

Consume multiple registers to pass a data-type.

Available registers are consumed until the data-type is covered, and an appropriate join space address is assigned. Registers can be consumed from a specific resource list. Consumption can spill over onto the stack if desired.

Constructor & Destructor Documentation

◆ MultiSlotAssign()

ghidra::MultiSlotAssign::MultiSlotAssign ( const ParamListStandard * res )

Constructor for use with decode.

Set default configuration

Parameters

res	is the new resource set to associate with this action

References consumeFromStack, consumeMostSig, enforceAlignment, ghidra::AssignAction::fillinOutputActive, ghidra::ParamListStandard::getSpacebase(), ghidra::ParamListStandard::getType(), ghidra::AddrSpace::isBigEndian(), justifyRight, ghidra::ParamList::p_register_out, ghidra::ParamList::p_standard_out, resourceType, stackEntry, and ghidra::TYPECLASS_GENERAL.

Member Function Documentation

◆ assignAddress()

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

Returns: the response code

Implements ghidra::AssignAction.

References ghidra::ParameterPieces::addr, ghidra::AddrSpaceManager::constructFloatExtensionAddress(), consumeFromStack, consumeMostSig, enforceAlignment, ghidra::AssignAction::fail, ghidra::AddrSpaceManager::findAddJoin(), firstIter, ghidra::ParameterPieces::flags, ghidra::VarnodeData::getAddr(), ghidra::ParamEntry::getAddrBySlot(), ghidra::Datatype::getAlignment(), ghidra::ParamEntry::getAllGroups(), ghidra::TypeFactory::getArch(), ghidra::ParamListStandard::getEntry(), ghidra::ParamEntry::getGroup(), ghidra::Address::getOffset(), ghidra::ParamEntry::getSize(), ghidra::Datatype::getSize(), ghidra::Address::getSpace(), ghidra::ParamEntry::getType(), ghidra::JoinRecord::getUnified(), ghidra::ParamEntry::isExclusion(), ghidra::Address::isInvalid(), justifyRight, ghidra::VarnodeData::offset, ghidra::AssignAction::resource, resourceType, ghidra::VarnodeData::size, ghidra::VarnodeData::space, stackEntry, ghidra::AssignAction::success, ghidra::ParameterPieces::type, and ghidra::TYPECLASS_FLOAT.

◆ clone()

virtual AssignAction * ghidra::MultiSlotAssign::clone ( const ParamListStandard * newResource ) const

inlinevirtual

Make a copy of this action.

Parameters

newResource is the new resource object that will own the clone

Returns: the newly allocated copy

Implements ghidra::AssignAction.

References consumeFromStack, consumeMostSig, enforceAlignment, justifyRight, and resourceType.

◆ decode()

void ghidra::MultiSlotAssign::decode ( Decoder & decoder )

virtual

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

Parameters

decoder is the given stream decoder

Implements ghidra::AssignAction.

References ghidra::Decoder::closeElement(), consumeFromStack, enforceAlignment, ghidra::Decoder::getNextAttributeId(), initializeEntries(), justifyRight, ghidra::Decoder::openElement(), ghidra::Decoder::readBool(), ghidra::Decoder::readString(), and resourceType.

◆ fillinOutputMap()

bool ghidra::MultiSlotAssign::fillinOutputMap ( ParamActive * active ) const

virtual

Test if this action could produce return value storage matching the given set of trials.

If there is a return value data-type that could be assigned storage matching the trials by this action, return true. The trials have their matching ParamEntry and offset already set and are already sorted.

Parameters

active is the given set of trials

Returns: true if the trials could form a valid return value

Reimplemented from ghidra::AssignAction.

References consumeMostSig, ghidra::ParamTrial::getEntry(), ghidra::ParamEntry::getGroup(), ghidra::ParamActive::getNumTrials(), ghidra::ParamTrial::getOffset(), ghidra::ParamEntry::getSize(), ghidra::ParamTrial::getSize(), ghidra::ParamActive::getTrial(), ghidra::ParamEntry::getType(), ghidra::ParamEntry::isFirstInClass(), justifyRight, and resourceType.

◆ initializeEntries()

void ghidra::MultiSlotAssign::initializeEntries ( void )

private

Cache specific ParamEntry needed by the action.

Find the first ParamEntry matching the resourceType, and the ParamEntry corresponding to the stack if consumeFromStack is set.

References consumeFromStack, firstIter, ghidra::ParamListStandard::getEntry(), ghidra::ParamListStandard::getFirstIter(), ghidra::ParamListStandard::getStackEntry(), ghidra::AssignAction::resource, resourceType, and stackEntry.

Referenced by decode(), and MultiSlotAssign().

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

/builds/appsec/reveng-binrw/ghidraplusplus/src/dec/modelrules.hh
/builds/appsec/reveng-binrw/ghidraplusplus/src/dec/modelrules.cc

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MultiSlotAssign()

Member Function Documentation

◆ assignAddress()

◆ clone()

◆ decode()

◆ fillinOutputMap()

◆ initializeEntries()