Push a Varnode with known pointer data-type to the bottom of its additive expression. More...

Inheritance diagram for ghidra::RulePushPtr:

Public Member Functions
	RulePushPtr (const string &g)
	Constructor.

virtual Rule *	clone (const ActionGroupList &grouplist) const
	Clone the Rule. More...

virtual void	getOpList (vector< uint4 > &oplist) const
	List of op codes this rule operates on. More...

virtual int4	applyOp (PcodeOp *op, Funcdata &data)
	Attempt to apply this Rule. More...

Public Member Functions inherited from ghidra::Rule
	Rule (const string &g, uint4 fl, const string &nm)
	Construct given group, properties name. More...

virtual	~Rule (void)
	Destructor.

const string &	getName (void) const
	Return the name of this Rule.

const string &	getGroup (void) const
	Return the group this Rule belongs to.

uint4	getNumTests (void)
	Get number of attempted applications.

uint4	getNumApply (void)
	Get number of successful applications.

void	setBreak (uint4 tp)
	Set a breakpoint on this Rule.

void	clearBreak (uint4 tp)
	Clear a breakpoint on this Rule.

void	clearBreakPoints (void)
	Clear all breakpoints on this Rule.

void	turnOnWarnings (void)
	Enable warnings for this Rule.

void	turnOffWarnings (void)
	Disable warnings for this Rule.

bool	isDisabled (void) const
	Return true if this Rule is disabled.

void	setDisable (void)
	Disable this Rule (within its pool)

void	clearDisable (void)
	Enable this Rule (within its pool)

bool	checkActionBreak (void)
	Check if an action breakpoint is turned on. More...

uint4	getBreakPoint (void) const
	Return breakpoint toggles.

virtual void	reset (Funcdata &data)
	Reset this Rule. More...

virtual void	resetStats (void)
	Reset Rule statistics. More...

virtual void	printStatistics (ostream &s) const
	Print statistics for this Rule. More...

Static Public Member Functions
static void	duplicateNeed (PcodeOp *op, Funcdata &data)
	Duplicate the given PcodeOp so that the outputs have only 1 descendant. More...

Static Private Member Functions
static Varnode *	buildVarnodeOut (Varnode vn, PcodeOp op, Funcdata &data)
	Build a duplicate of the given Varnode as an output of a PcodeOp, preserving the storage address if possible. More...

static void	collectDuplicateNeeds (vector< PcodeOp > &reslist, Varnode vn)
	Generate list of PcodeOps that need to be duplicated as part of pushing the pointer. More...

Additional Inherited Members
Public Types inherited from ghidra::Rule
enum	typeflags { type_disable = 1, rule_debug = 2, warnings_on = 4, warnings_given = 8 }
	Properties associated with a Rule. More...

Detailed Description

Push a Varnode with known pointer data-type to the bottom of its additive expression.

This is part of the normalizing process for pointer expressions. The pointer should be added last onto the expression calculating the offset into its data-type.

Member Function Documentation

◆ applyOp()

int4 ghidra::RulePushPtr::applyOp	(	PcodeOp *	op,
		Funcdata &	data
	)

virtual

Attempt to apply this Rule.

This method contains the main logic for applying the Rule. It must use a given PcodeOp as the point at which the Rule applies. If it does apply, changes are made directly to the function and 1 (non-zero) is returned, otherwise 0 is returned.

Parameters

op	is the given PcodeOp where the Rule may apply
data	is the function to which to apply

Reimplemented from ghidra::Rule.

References ghidra::Varnode::beginDescend(), ghidra::CPUI_INT_ADD, ghidra::Varnode::endDescend(), ghidra::RulePtrArith::evaluatePointerExpression(), ghidra::PcodeOp::getAddr(), ghidra::PcodeOp::getIn(), ghidra::Datatype::getMetatype(), ghidra::PcodeOp::getOut(), ghidra::Varnode::getSize(), ghidra::PcodeOp::getSlot(), ghidra::Varnode::getTypeReadFacing(), ghidra::Funcdata::hasTypeRecoveryStarted(), ghidra::Varnode::isAutoLive(), ghidra::Varnode::loneDescend(), ghidra::Funcdata::newOp(), ghidra::Funcdata::newUniqueOut(), ghidra::PcodeOp::numInput(), ghidra::Funcdata::opDestroy(), ghidra::Funcdata::opInsertBefore(), ghidra::Funcdata::opSetInput(), ghidra::Funcdata::opSetOpcode(), and ghidra::TYPE_PTR.

◆ buildVarnodeOut()

Varnode * ghidra::RulePushPtr::buildVarnodeOut	(	Varnode *	vn,
		PcodeOp *	op,
		Funcdata &	data
	)

staticprivate

Build a duplicate of the given Varnode as an output of a PcodeOp, preserving the storage address if possible.

If the Varnode is already a unique or is addrtied

Parameters

vn	is the given Varnode
op	is the PcodeOp to which the duplicate should be an output
data	is the function to add the duplicate to

Returns: the duplicate Varnode

References ghidra::Varnode::getAddr(), ghidra::Varnode::getSize(), ghidra::Varnode::getSpace(), ghidra::AddrSpace::getType(), ghidra::IPTR_INTERNAL, ghidra::Varnode::isAddrTied(), ghidra::Funcdata::newUniqueOut(), and ghidra::Funcdata::newVarnodeOut().

◆ clone()

virtual Rule* ghidra::RulePushPtr::clone ( const ActionGroupList & grouplist ) const

inlinevirtual

Clone the Rule.

If this Rule is a member of one of the groups in the grouplist, this returns a clone of the Rule, otherwise NULL is returned.

Parameters

grouplist is the list of groups being cloned

Returns: the cloned Rule or NULL

Implements ghidra::Rule.

References ghidra::ActionGroupList::contains().

◆ collectDuplicateNeeds()

void ghidra::RulePushPtr::collectDuplicateNeeds	(	vector< PcodeOp *> &	reslist,
		Varnode *	vn
	)

staticprivate

Generate list of PcodeOps that need to be duplicated as part of pushing the pointer.

If the pointer INT_ADD is duplicated as part of the push, some of the operations building the offset to the pointer may also need to be duplicated. Identify these and add them to the result list.

Parameters

reslist	is the result list to be populated
vn	is the offset Varnode being added to the pointer

References ghidra::PcodeOp::code(), ghidra::CPUI_INT_2COMP, ghidra::CPUI_INT_MULT, ghidra::CPUI_INT_SEXT, ghidra::CPUI_INT_ZEXT, ghidra::Varnode::getDef(), ghidra::PcodeOp::getIn(), ghidra::Varnode::isAutoLive(), ghidra::Varnode::isConstant(), ghidra::Varnode::isWritten(), and ghidra::Varnode::loneDescend().

◆ duplicateNeed()

void ghidra::RulePushPtr::duplicateNeed	(	PcodeOp *	op,
		Funcdata &	data
	)

static

Duplicate the given PcodeOp so that the outputs have only 1 descendant.

Run through the descendants of the PcodeOp output and create a duplicate of the PcodeOp right before the descendant. We assume the PcodeOp either has a single input, or has 2 inputs where the second is a constant. The (original) PcodeOp is destroyed.

Parameters

op	is the given PcodeOp to duplicate
data	is function to build duplicates in

References ghidra::Varnode::beginDescend(), ghidra::PcodeOp::code(), ghidra::Varnode::endDescend(), ghidra::PcodeOp::getAddr(), ghidra::PcodeOp::getIn(), ghidra::PcodeOp::getOut(), ghidra::PcodeOp::getSlot(), ghidra::Varnode::getType(), ghidra::Funcdata::newOp(), ghidra::PcodeOp::numInput(), ghidra::Funcdata::opDestroy(), ghidra::Funcdata::opInsertBefore(), ghidra::Funcdata::opSetInput(), ghidra::Funcdata::opSetOpcode(), and ghidra::Varnode::updateType().

Referenced by ghidra::RuleExtensionPush::applyOp().

◆ getOpList()

void ghidra::RulePushPtr::getOpList ( vector< uint4 > & oplist ) const

virtual

List of op codes this rule operates on.

Populate the given array with all possible OpCodes this Rule might apply to. By default, this method returns all possible OpCodes

Parameters

oplist is the array to populate

Reimplemented from ghidra::Rule.

References ghidra::CPUI_INT_ADD.

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

ruleaction.hh
ruleaction.cc

Public Member Functions

Static Public Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ applyOp()

◆ buildVarnodeOut()

◆ clone()

◆ collectDuplicateNeeds()

◆ duplicateNeed()

◆ getOpList()