Pull SUBPIECE back through MULTIEQUAL. More...

Inheritance diagram for ghidra::RulePullsubMulti:

Collaboration diagram for ghidra::RulePullsubMulti:

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

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

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

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

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

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.

uint4	getBreakPoint (void) const
	Return breakpoint toggles.

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

virtual void	resetStats (void)
	Reset Rule statistics.

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

Static Public Member Functions
static void	minMaxUse (Varnode *vn, int4 &maxByte, int4 &minByte)
	Compute minimum and maximum bytes being used.

static void	replaceDescendants (Varnode origVn, Varnode newVn, int4 maxByte, int4 minByte, Funcdata &data)

static bool	acceptableSize (int4 size)
	Return true if given size is a suitable truncated size.

static Varnode *	buildSubpiece (Varnode *basevn, uint4 outsize, uint4 shift, Funcdata &data)
	Build a SUBPIECE of given base Varnode.

static Varnode *	findSubpiece (Varnode *basevn, uint4 outsize, uint4 shift)
	Find a predefined SUBPIECE of a base Varnode.

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

Pull SUBPIECE back through MULTIEQUAL.

Member Function Documentation

◆ acceptableSize()

bool ghidra::RulePullsubMulti::acceptableSize ( int4 size )

static

Return true if given size is a suitable truncated size.

Parameters

size	is the given size

Returns: true if it is acceptable

Referenced by applyOp(), and ghidra::RulePullsubIndirect::applyOp().

◆ applyOp()

int4 ghidra::RulePullsubMulti::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 acceptableSize(), buildSubpiece(), ghidra::calc_mask(), ghidra::PcodeOp::code(), ghidra::CPUI_INT_SEXT, ghidra::CPUI_INT_ZEXT, ghidra::CPUI_MULTIEQUAL, findSubpiece(), ghidra::PcodeOp::getAddr(), ghidra::Varnode::getAddr(), ghidra::Varnode::getConsume(), ghidra::Varnode::getDef(), ghidra::PcodeOp::getIn(), ghidra::PcodeOp::getOut(), ghidra::PcodeOp::getParent(), ghidra::Varnode::getSize(), ghidra::Varnode::getSpace(), ghidra::FlowBlock::hasLoopIn(), ghidra::AddrSpace::isBigEndian(), ghidra::Varnode::isPrecisHi(), ghidra::Varnode::isPrecisLo(), ghidra::Varnode::isWritten(), minMaxUse(), ghidra::Funcdata::newOp(), ghidra::Funcdata::newVarnodeOut(), ghidra::PcodeOp::numInput(), ghidra::Funcdata::opInsertBegin(), ghidra::Funcdata::opSetAllInput(), ghidra::Funcdata::opSetOpcode(), ghidra::Address::renormalize(), and replaceDescendants().

◆ buildSubpiece()

Varnode * ghidra::RulePullsubMulti::buildSubpiece	(	Varnode *	basevn,
		uint4	outsize,
		uint4	shift,
		Funcdata &	data
	)

static

Build a SUBPIECE of given base Varnode.

The PcodeOp is constructed and inserted near the definition of the base Varnode.

Parameters

basevn	is the given base Varnode
outsize	is the required truncated size in bytes
shift	is the number of least significant bytes to truncate
data	is the function being analyzed

Returns: the output Varnode of the new SUBPIECE

References ghidra::CPUI_SUBPIECE, ghidra::AddrSpaceManager::findJoin(), ghidra::VarnodeData::getAddr(), ghidra::PcodeOp::getAddr(), ghidra::Varnode::getAddr(), ghidra::Funcdata::getArch(), ghidra::Funcdata::getBasicBlocks(), ghidra::BlockGraph::getBlock(), ghidra::Varnode::getDef(), ghidra::Varnode::getOffset(), ghidra::JoinRecord::getPiece(), ghidra::Varnode::getSize(), ghidra::Varnode::getSpace(), ghidra::BlockBasic::getStart(), ghidra::AddrSpace::isBigEndian(), ghidra::Varnode::isInput(), ghidra::Address::isJoin(), ghidra::Varnode::isWritten(), ghidra::Funcdata::newConstant(), ghidra::Funcdata::newOp(), ghidra::Funcdata::newUniqueOut(), ghidra::Funcdata::newVarnodeOut(), ghidra::JoinRecord::numPieces(), ghidra::Funcdata::opInsertAfter(), ghidra::Funcdata::opInsertBegin(), ghidra::Funcdata::opSetInput(), ghidra::Funcdata::opSetOpcode(), ghidra::Address::renormalize(), ghidra::VarnodeData::size, and ghidra::VarnodeData::space.

Referenced by applyOp(), and ghidra::RulePullsubIndirect::applyOp().

◆ clone()

virtual Rule * ghidra::RulePullsubMulti::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::Rule::getGroup().

◆ findSubpiece()

Varnode * ghidra::RulePullsubMulti::findSubpiece	(	Varnode *	basevn,
		uint4	outsize,
		uint4	shift
	)

static

Find a predefined SUBPIECE of a base Varnode.

Given a Varnode and desired dimensions (size and shift), search for a preexisting truncation defined in the same block as the original Varnode or return NULL

Parameters

basevn	is the base Varnode
outsize	is the desired truncation size
shift	if the desired truncation shift

Returns: the truncated Varnode or NULL

References ghidra::Varnode::beginDescend(), ghidra::PcodeOp::code(), ghidra::CPUI_SUBPIECE, ghidra::Varnode::endDescend(), ghidra::Varnode::getDef(), ghidra::PcodeOp::getIn(), ghidra::FlowBlock::getIndex(), ghidra::Varnode::getOffset(), ghidra::PcodeOp::getOut(), ghidra::PcodeOp::getParent(), ghidra::Varnode::getSize(), ghidra::Varnode::isInput(), and ghidra::Varnode::isWritten().

Referenced by applyOp(), and ghidra::RulePullsubIndirect::applyOp().

◆ getOpList()

void ghidra::RulePullsubMulti::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_SUBPIECE.

◆ minMaxUse()

void ghidra::RulePullsubMulti::minMaxUse	(	Varnode *	vn,
		int4 &	maxByte,
		int4 &	minByte
	)

static

Compute minimum and maximum bytes being used.

For bytes in given Varnode pass back the largest and smallest index (lsb=0) consumed by an immediate descendant.

Parameters

vn	is the given Varnode
maxByte	will hold the index of the maximum byte
minByte	will hold the index of the minimum byte

References ghidra::Varnode::beginDescend(), ghidra::PcodeOp::code(), ghidra::CPUI_SUBPIECE, ghidra::Varnode::endDescend(), ghidra::PcodeOp::getIn(), ghidra::Varnode::getOffset(), ghidra::PcodeOp::getOut(), and ghidra::Varnode::getSize().

Referenced by applyOp(), and ghidra::RulePullsubIndirect::applyOp().

◆ replaceDescendants()

void ghidra::RulePullsubMulti::replaceDescendants	(	Varnode *	origVn,
		Varnode *	newVn,
		int4	maxByte,
		int4	minByte,
		Funcdata &	data
	)

static

Replace given Varnode with (smaller) newVn in all descendants

If minMaxUse() indicates not all bytes are used, this should always succeed

Parameters

origVn	is the given Varnode
newVn	is the new Varnode to replace with
maxByte	is the maximum byte immediately used in origVn
minByte	is the minimum byte immediately used in origVn
data	is the function being analyzed

References ghidra::Varnode::beginDescend(), ghidra::PcodeOp::code(), ghidra::CPUI_COPY, ghidra::CPUI_SUBPIECE, ghidra::Varnode::endDescend(), ghidra::PcodeOp::getIn(), ghidra::Varnode::getOffset(), ghidra::PcodeOp::getOut(), ghidra::Varnode::getSize(), ghidra::Funcdata::newConstant(), ghidra::Funcdata::opRemoveInput(), ghidra::Funcdata::opSetInput(), and ghidra::Funcdata::opSetOpcode().

Referenced by applyOp(), and ghidra::RulePullsubIndirect::applyOp().

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

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ acceptableSize()

◆ applyOp()

◆ buildSubpiece()

◆ clone()

◆ findSubpiece()

◆ getOpList()

◆ minMaxUse()

◆ replaceDescendants()