Convert LOAD operations using a constant offset to COPY. More...

Inheritance diagram for ghidra::RuleLoadVarnode:

Public Member Functions
	RuleLoadVarnode (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 AddrSpace *	correctSpacebase (Architecture glb, Varnode vn, AddrSpace *spc)
	Return associated space if given Varnode is an active spacebase. More...

static AddrSpace *	vnSpacebase (Architecture glb, Varnode vn, uintb &val, AddrSpace *spc)
	Check if given Varnode is spacebase + a constant. More...

static AddrSpace *	checkSpacebase (Architecture glb, PcodeOp op, uintb &offoff)
	Check if STORE or LOAD is off of a spacebase + constant. More...

Friends
class	RuleStoreVarnode

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

Convert LOAD operations using a constant offset to COPY.

The pointer can either be a constant offset into the LOAD's specified address space, or it can be a spacebase register plus an offset, in which case it points into the spacebase register's address space.

Member Function Documentation

◆ applyOp()

int4 ghidra::RuleLoadVarnode::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::AddrSpace::addressToByte(), ghidra::Varnode::clearSpacebasePlaceholder(), ghidra::CPUI_COPY, ghidra::Funcdata::getArch(), ghidra::Funcdata::getCallSpecs(), ghidra::PcodeOp::getOut(), ghidra::Varnode::getSize(), ghidra::AddrSpace::getWordSize(), ghidra::Varnode::isSpacebasePlaceholder(), ghidra::Varnode::loneDescend(), ghidra::Funcdata::newVarnode(), ghidra::Funcdata::opRemoveInput(), ghidra::Funcdata::opSetInput(), ghidra::Funcdata::opSetOpcode(), and ghidra::FuncCallSpecs::resolveSpacebaseRelative().

◆ checkSpacebase()

AddrSpace * ghidra::RuleLoadVarnode::checkSpacebase	(	Architecture *	glb,
		PcodeOp *	op,
		uintb &	offoff
	)

staticprivate

Check if STORE or LOAD is off of a spacebase + constant.

If so return the associated space and pass back the offset

Parameters

glb	is the address space manager
op	is the STORE or LOAD PcodeOp
offoff	is a reference to where the offset should get passed back

Returns: the associated space or NULL

References ghidra::PcodeOp::code(), ghidra::CPUI_SEGMENTOP, ghidra::Varnode::getDef(), ghidra::PcodeOp::getIn(), ghidra::Varnode::getOffset(), ghidra::Varnode::getSpaceFromConst(), ghidra::Varnode::isConstant(), and ghidra::Varnode::isWritten().

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

◆ clone()

virtual Rule* ghidra::RuleLoadVarnode::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.

◆ correctSpacebase()

AddrSpace * ghidra::RuleLoadVarnode::correctSpacebase	(	Architecture *	glb,
		Varnode *	vn,
		AddrSpace *	spc
	)

staticprivate

Return associated space if given Varnode is an active spacebase.

The Varnode should be a spacebase register input to the function or a constant, and it should get loaded from the correct space.

Parameters

glb	is the address space manager
vn	is the given Varnode
spc	is the address space being loaded from

Returns: the associated space or NULL if the Varnode is not of the correct form

References ghidra::Varnode::getAddr(), ghidra::AddrSpace::getContain(), ghidra::Varnode::getSize(), ghidra::Architecture::getSpaceBySpacebase(), ghidra::Varnode::isConstant(), ghidra::Varnode::isInput(), and ghidra::Varnode::isSpacebase().

◆ getOpList()

void ghidra::RuleLoadVarnode::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_LOAD.

◆ vnSpacebase()

AddrSpace * ghidra::RuleLoadVarnode::vnSpacebase	(	Architecture *	glb,
		Varnode *	vn,
		uintb &	val,
		AddrSpace *	spc
	)

staticprivate

Check if given Varnode is spacebase + a constant.

If it is, pass back the constant and return the associated space

Parameters

glb	is the address space manager
vn	is the given Varnode
val	is the reference for passing back the constant
spc	is the space being loaded from

Returns: the associated space or NULL

References ghidra::PcodeOp::code(), ghidra::CPUI_INT_ADD, ghidra::Varnode::getDef(), ghidra::PcodeOp::getIn(), ghidra::Varnode::getOffset(), ghidra::Varnode::isConstant(), and ghidra::Varnode::isWritten().

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

ruleaction.hh
ruleaction.cc

Public Member Functions

Static Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ applyOp()

◆ checkSpacebase()

◆ clone()

◆ correctSpacebase()

◆ getOpList()

◆ vnSpacebase()