ghidra::RulePushMulti Class Reference

Simplify MULTIEQUAL operations where the branches hold the same value. More...

Inheritance diagram for ghidra::RulePushMulti:

Public Member Functions
	RulePushMulti (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 Private Member Functions
static PcodeOp *	findSubstitute (Varnode *in1, Varnode *in2, BlockBasic *bb, PcodeOp *earliest)
	Find a previously existing MULTIEQUAL taking given inputs. 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

Simplify MULTIEQUAL operations where the branches hold the same value.

Look for a two-branch MULTIEQUAL where both inputs are constructed in functionally equivalent ways. Remove (the reference to) one construction and move the other into the merge block.

Member Function Documentation

applyOp()

int4 ghidra::RulePushMulti::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::PcodeOp::code(), ghidra::CPUI_COPY, ghidra::CPUI_MULTIEQUAL, ghidra::CPUI_SUBPIECE, ghidra::earliestUseInBlock(), ghidra::PcodeOp::getAddr(), ghidra::Varnode::getDef(), ghidra::PcodeOp::getIn(), ghidra::PcodeOp::getOut(), ghidra::PcodeOp::getParent(), ghidra::PcodeOp::getSlot(), ghidra::Varnode::isSpacebase(), ghidra::Varnode::isWritten(), ghidra::Varnode::loneDescend(), ghidra::Funcdata::newOp(), ghidra::Funcdata::newUniqueOut(), ghidra::Funcdata::newVarnodeOut(), ghidra::PcodeOp::numInput(), ghidra::Funcdata::opDestroy(), ghidra::Funcdata::opInsertAfter(), ghidra::Funcdata::opInsertBegin(), ghidra::Funcdata::opSetInput(), ghidra::Funcdata::opSetOpcode(), ghidra::Funcdata::opSetOutput(), ghidra::Funcdata::opUninsert(), and ghidra::Funcdata::totalReplace().

clone()

virtual Rule* ghidra::RulePushMulti::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(), and ghidra::AddTreeState::data.

findSubstitute()

PcodeOp * ghidra::RulePushMulti::findSubstitute ( Varnode *  in1, Varnode *  in2, BlockBasic *  bb, PcodeOp *  earliest  )

staticprivate

Find a previously existing MULTIEQUAL taking given inputs.

The MULTIEQUAL must be in the given block bb. If the MULTIEQUAL does not exist, check if the inputs have level 1 functional equality and if a common sub-expression is present in the block

Parameters

in1	is the first input
in2	is the second input
bb	is the given block to search in
earliest	is the earliest of the inputs

Returns

the discovered MULTIEQUAL or the equivalent sub-expression

References ghidra::Varnode::beginDescend(), ghidra::PcodeOp::code(), ghidra::CPUI_MULTIEQUAL, ghidra::cseFindInBlock(), ghidra::Varnode::endDescend(), ghidra::Varnode::getDef(), ghidra::PcodeOp::getIn(), ghidra::PcodeOp::getParent(), ghidra::Varnode::isConstant(), and ghidra::PcodeOp::numInput().

getOpList()

void ghidra::RulePushMulti::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_MULTIEQUAL.

---

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

• ruleaction.hh
• ruleaction.cc