Mark Varnode and PcodeOp objects that are carrying or operating on pointers. More...

Inheritance diagram for ghidra::RulePtrFlow:

Public Member Functions
	RulePtrFlow (const string &g, Architecture *conf)
	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...

Private Member Functions
bool	trialSetPtrFlow (PcodeOp *op)

bool	propagateFlowToDef (Varnode *vn)
	Propagate ptrflow property to given Varnode and the defining PcodeOp. More...

bool	propagateFlowToReads (Varnode *vn)
	Propagate ptrflow property to given Varnode and to descendant PcodeOps. More...

Varnode *	truncatePointer (AddrSpace spc, PcodeOp op, Varnode *vn, int4 slot, Funcdata &data)
	Truncate pointer Varnode being read by given PcodeOp. More...

Private Attributes
Architecture *	glb
	The address space manager.

bool	hasTruncations
	true if this architecture needs truncated pointers

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

Mark Varnode and PcodeOp objects that are carrying or operating on pointers.

This is used on architectures where the data-flow for pointer values needs to be truncated. This marks the places where the truncation needs to happen. Then the SubvariableFlow actions do the actual truncation.

Member Function Documentation

◆ applyOp()

int4 ghidra::RulePtrFlow::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_BRANCHIND, ghidra::CPUI_CALLIND, ghidra::CPUI_COPY, ghidra::CPUI_INDIRECT, ghidra::CPUI_INT_ADD, ghidra::CPUI_LOAD, ghidra::CPUI_MULTIEQUAL, ghidra::CPUI_NEW, ghidra::CPUI_PTRADD, ghidra::CPUI_PTRSUB, ghidra::CPUI_STORE, ghidra::AddrSpace::getAddrSize(), ghidra::Funcdata::getArch(), ghidra::AddrSpaceManager::getDefaultCodeSpace(), ghidra::PcodeOp::getIn(), ghidra::PcodeOp::getOut(), ghidra::Varnode::getSize(), ghidra::Varnode::getSpaceFromConst(), ghidra::PcodeOp::isPtrFlow(), ghidra::PcodeOp::numInput(), propagateFlowToDef(), propagateFlowToReads(), and truncatePointer().

◆ clone()

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

◆ getOpList()

void ghidra::RulePtrFlow::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_BRANCHIND, ghidra::CPUI_CALLIND, ghidra::CPUI_COPY, ghidra::CPUI_INDIRECT, ghidra::CPUI_INT_ADD, ghidra::CPUI_LOAD, ghidra::CPUI_MULTIEQUAL, ghidra::CPUI_PTRADD, ghidra::CPUI_PTRSUB, ghidra::CPUI_STORE, and hasTruncations.

◆ propagateFlowToDef()

bool ghidra::RulePtrFlow::propagateFlowToDef ( Varnode * vn )

private

Propagate ptrflow property to given Varnode and the defining PcodeOp.

Parameters

vn	is the given Varnode

Returns: true if a change was made

References ghidra::Varnode::getDef(), ghidra::Varnode::isPtrFlow(), ghidra::Varnode::isWritten(), ghidra::Varnode::setPtrFlow(), and trialSetPtrFlow().

Referenced by applyOp().

◆ propagateFlowToReads()

bool ghidra::RulePtrFlow::propagateFlowToReads ( Varnode * vn )

private

Propagate ptrflow property to given Varnode and to descendant PcodeOps.

Parameters

vn	is the given Varnode

Returns: true if a change was made

References ghidra::Varnode::beginDescend(), ghidra::Varnode::endDescend(), ghidra::Varnode::isPtrFlow(), ghidra::Varnode::setPtrFlow(), and trialSetPtrFlow().

Referenced by applyOp().

◆ trialSetPtrFlow()

bool ghidra::RulePtrFlow::trialSetPtrFlow ( PcodeOp * op )

private

Set ptrflow property on PcodeOp only if it is propagating

Parameters

op	is the PcodeOp

Returns: true if ptrflow property is newly set

References ghidra::PcodeOp::code(), ghidra::CPUI_COPY, ghidra::CPUI_INDIRECT, ghidra::CPUI_INT_ADD, ghidra::CPUI_MULTIEQUAL, ghidra::CPUI_PTRADD, ghidra::CPUI_PTRSUB, ghidra::PcodeOp::isPtrFlow(), and ghidra::PcodeOp::setPtrFlow().

Referenced by propagateFlowToDef(), and propagateFlowToReads().

◆ truncatePointer()

Varnode * ghidra::RulePtrFlow::truncatePointer	(	AddrSpace *	spc,
		PcodeOp *	op,
		Varnode *	vn,
		int4	slot,
		Funcdata &	data
	)

private

Truncate pointer Varnode being read by given PcodeOp.

Insert a SUBPIECE operation truncating the value to the size necessary for a pointer into the given address space. Update the PcodeOp input.

Parameters

spc	is the given address space
op	is the given PcodeOp reading the pointer
vn	is the pointer Varnode
slot	is the input slot reading the pointer
data	is the function being analyzed

Returns: the new truncated Varnode

References ghidra::CPUI_SUBPIECE, ghidra::PcodeOp::getAddr(), ghidra::Varnode::getAddr(), ghidra::AddrSpace::getAddrSize(), ghidra::Varnode::getSize(), ghidra::Varnode::getSpace(), ghidra::AddrSpace::getType(), ghidra::IPTR_INTERNAL, ghidra::Address::isBigEndian(), ghidra::Funcdata::newConstant(), ghidra::Funcdata::newOp(), ghidra::Funcdata::newUniqueOut(), ghidra::Funcdata::newVarnodeOut(), ghidra::Funcdata::opInsertBefore(), ghidra::Funcdata::opSetInput(), ghidra::Funcdata::opSetOpcode(), and ghidra::Address::renormalize().

Referenced by applyOp().

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

ruleaction.hh
ruleaction.cc

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ applyOp()

◆ clone()

◆ getOpList()

◆ propagateFlowToDef()

◆ propagateFlowToReads()

◆ trialSetPtrFlow()

◆ truncatePointer()