Analyze change to the stack pointer across sub-function calls. More...

#include <coreaction.hh>

Inheritance diagram for ghidra::ActionStackPtrFlow:

Public Member Functions
	ActionStackPtrFlow (const string &g, AddrSpace *ss)
	Constructor.

virtual void	reset (Funcdata &data)
	Reset the Action for a new function. More...

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

virtual int4	apply (Funcdata &data)
	Make a single attempt to apply this Action. More...

Public Member Functions inherited from ghidra::Action
	Action (uint4 f, const string &nm, const string &g)
	Base constructor for an Action. More...

virtual	~Action (void)
	Destructor.

virtual void	printStatistics (ostream &s) const
	Dump statistics to stream. More...

int4	perform (Funcdata &data)
	Perform this action (if necessary) More...

bool	setBreakPoint (uint4 tp, const string &specify)
	Set a breakpoint on this action. More...

virtual void	clearBreakPoints (void)
	Clear all breakpoints set on this Action.

bool	setWarning (bool val, const string &specify)
	Set a warning on this action. More...

bool	disableRule (const string &specify)
	Disable a specific Rule within this. More...

bool	enableRule (const string &specify)
	Enable a specific Rule within this. More...

const string &	getName (void) const
	Get the Action's name.

const string &	getGroup (void) const
	Get the Action's group.

uint4	getStatus (void) const
	Get the current status of this Action.

uint4	getNumTests (void)
	Get the number of times apply() was invoked.

uint4	getNumApply (void)

virtual void	resetStats (void)
	Reset all the counts to zero. More...

virtual int4	print (ostream &s, int4 num, int4 depth) const
	Print a description of this Action to stream. More...

virtual void	printState (ostream &s) const
	Print status to stream. More...

virtual Action *	getSubAction (const string &specify)
	Retrieve a specific sub-action by name. More...

virtual Rule *	getSubRule (const string &specify)
	Retrieve a specific sub-rule by name. More...

Static Private Member Functions
static void	analyzeExtraPop (Funcdata &data, AddrSpace *stackspace, int4 spcbase)
	Calculate stack-pointer change across undetermined sub-functions. More...

static bool	isStackRelative (Varnode spcbasein, Varnode vn, uintb &constval)
	Is the given Varnode defined as a pointer relative to the stack-pointer? More...

static bool	adjustLoad (Funcdata &data, PcodeOp loadop, PcodeOp storeop)
	Adjust the LOAD where the stack-pointer alias has been recovered. More...

static int4	repair (Funcdata &data, AddrSpace id, Varnode spcbasein, PcodeOp *loadop, uintb constz)
	Link LOAD to matching STORE of a constant. More...

static int4	checkClog (Funcdata &data, AddrSpace *id, int4 spcbase)
	Find any stack pointer clogs and pass it on to the repair routines. More...

Private Attributes
AddrSpace *	stackspace
	Stack space associated with stack-pointer register.

bool	analysis_finished
	True if analysis already performed.

Additional Inherited Members
Public Types inherited from ghidra::Action
enum	ruleflags { rule_repeatapply = 4, rule_onceperfunc = 8, rule_oneactperfunc = 16, rule_debug = 32, rule_warnings_on = 64, rule_warnings_given = 128 }
	Boolean behavior properties governing this particular Action. More...

enum	statusflags { status_start =1, status_breakstarthit =2, status_repeat =4, status_mid =8, status_end =16, status_actionbreak =32 }
	Boolean properties describing the status of an action. More...

enum	breakflags { break_start = 1, tmpbreak_start = 2, break_action = 4, tmpbreak_action = 8 }
	Break points associated with an Action. More...

Protected Member Functions inherited from ghidra::Action
void	issueWarning (Architecture *glb)
	Warn that this Action has applied. More...

bool	checkStartBreak (void)
	Check start breakpoint. More...

bool	checkActionBreak (void)
	Check action breakpoint. More...

void	turnOnWarnings (void)
	Enable warnings for this Action.

void	turnOffWarnings (void)
	Disable warnings for this Action.

Protected Attributes inherited from ghidra::Action
int4	lcount
	Changes not including last call to apply()

int4	count
	Number of changes made by this action so far.

uint4	status
	Current status.

uint4	breakpoint
	Breakpoint properties.

uint4	flags
	Behavior properties.

uint4	count_tests
	Number of times apply() has been called.

uint4	count_apply
	Number of times apply() made changes.

string	name
	Name of the action.

string	basegroup
	Base group this action belongs to.

Detailed Description

Analyze change to the stack pointer across sub-function calls.

Member Function Documentation

◆ adjustLoad()

bool ghidra::ActionStackPtrFlow::adjustLoad	(	Funcdata &	data,
		PcodeOp *	loadop,
		PcodeOp *	storeop
	)

staticprivate

Adjust the LOAD where the stack-pointer alias has been recovered.

We've matched a LOAD with its matching store, now convert the LOAD op to a COPY of what was stored.

Parameters

data	is the function being analyzed
loadop	is the LOAD op to adjust
storeop	is the matching STORE op

Returns: true if the adjustment is successful

References ghidra::CPUI_COPY, ghidra::PcodeOp::getIn(), ghidra::Varnode::getOffset(), ghidra::Varnode::getSize(), ghidra::Varnode::isConstant(), ghidra::Varnode::isFree(), ghidra::Funcdata::newConstant(), ghidra::Funcdata::opRemoveInput(), ghidra::Funcdata::opSetInput(), and ghidra::Funcdata::opSetOpcode().

◆ analyzeExtraPop()

void ghidra::ActionStackPtrFlow::analyzeExtraPop	(	Funcdata &	data,
		AddrSpace *	stackspace,
		int4	spcbase
	)

staticprivate

Calculate stack-pointer change across undetermined sub-functions.

If there are sub-functions for which extra pop is not explicit, do full linear analysis to (attempt to) recover the values.

Parameters

data	is the function to analyze
stackspace	is the space associated with the stack-pointer
spcbase	is the index (relative to the stackspace) of the stack-pointer

References ghidra::StackSolver::build(), ghidra::calc_mask(), ghidra::PcodeOp::code(), ghidra::CPUI_INDIRECT, ghidra::CPUI_INT_ADD, ghidra::Architecture::defaultfp, ghidra::Architecture::evalfp_called, ghidra::LowlevelError::explain, ghidra::ProtoModel::extrapop_unknown, ghidra::Varnode::getAddr(), ghidra::Funcdata::getArch(), ghidra::Funcdata::getCallSpecs(), ghidra::StackSolver::getCompanion(), ghidra::Varnode::getDef(), ghidra::ProtoModel::getExtraPop(), ghidra::PcodeOp::getIn(), ghidra::AddrSpace::getName(), ghidra::StackSolver::getNumVariables(), ghidra::PcodeOp::getOpFromConst(), ghidra::Varnode::getSize(), ghidra::StackSolver::getSolution(), ghidra::Varnode::getSpace(), ghidra::AddrSpace::getType(), ghidra::StackSolver::getVariable(), ghidra::IPTR_IOP, ghidra::Funcdata::newConstant(), ghidra::Funcdata::opSetAllInput(), ghidra::Funcdata::opSetOpcode(), ghidra::StackSolver::solve(), and ghidra::Funcdata::warningHeader().

◆ apply()

int4 ghidra::ActionStackPtrFlow::apply ( Funcdata & data )

virtual

Make a single attempt to apply this Action.

This is the main entry point for applying changes to a function that are specific to this Action. The method can inspect whatever it wants to decide if the Action does or does not apply. Changes are indicated by incrementing the count field.

Parameters

data	is the function to inspect/modify

Returns: 0 for a complete application, -1 for a partial completion (due to breakpoint)

Implements ghidra::Action.

◆ checkClog()

int4 ghidra::ActionStackPtrFlow::checkClog	(	Funcdata &	data,
		AddrSpace *	id,
		int4	spcbase
	)

staticprivate

Find any stack pointer clogs and pass it on to the repair routines.

A stack pointer clog is a constant addition to the stack-pointer, but where the constant comes from the stack.

Parameters

data	is the function to analyze
id	is the stack space
spcbase	is the index of the stack-pointer relative to the stack space

Returns: the number of clogs that were repaired

References ghidra::Funcdata::beginLoc(), ghidra::calc_mask(), ghidra::PcodeOp::code(), ghidra::CPUI_INT_ADD, ghidra::CPUI_INT_MULT, ghidra::CPUI_LOAD, ghidra::Funcdata::endLoc(), ghidra::Varnode::getDef(), ghidra::PcodeOp::getIn(), ghidra::Varnode::getOffset(), ghidra::Varnode::getSize(), ghidra::AddrSpace::getSpacebase(), ghidra::Varnode::isConstant(), ghidra::Varnode::isInput(), and ghidra::Varnode::isWritten().

◆ clone()

virtual Action* ghidra::ActionStackPtrFlow::clone ( const ActionGroupList & grouplist ) const

inlinevirtual

Clone the Action.

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

Parameters

grouplist is the list of groups being cloned

Returns: the cloned Action or NULL

Implements ghidra::Action.

References ghidra::ActionStart::apply(), ghidra::ActionGroupList::contains(), and ghidra::Action::getGroup().

◆ isStackRelative()

bool ghidra::ActionStackPtrFlow::isStackRelative	(	Varnode *	spcbasein,
		Varnode *	vn,
		uintb &	constval
	)

staticprivate

Is the given Varnode defined as a pointer relative to the stack-pointer?

Return true if -vn- is defined as the stackpointer input plus a constant (or zero) This works through the general case and the special case when the constant is zero. The constant value is passed-back to the caller.

Parameters

spcbasein	is the Varnode holding the input value of the stack-pointer
vn	is the Varnode to check for relativeness
constval	is a reference for passing back the constant offset

Returns: true if vn is stack relative

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

◆ repair()

int4 ghidra::ActionStackPtrFlow::repair	(	Funcdata &	data,
		AddrSpace *	id,
		Varnode *	spcbasein,
		PcodeOp *	loadop,
		uintb	constz
	)

staticprivate

Link LOAD to matching STORE of a constant.

Try to find STORE op using same stack relative pointer as a given LOAD op. If we find it and the STORE stores a constant, change the LOAD to a COPY.

Parameters

data	is the function owning the LOAD
id	is the stackspace
spcbasein	is the stack-pointer
loadop	is the given LOAD op
constz	is the stack relative offset of the LOAD pointer

Returns: 1 if we successfully change LOAD to COPY, 0 otherwise

References ghidra::BlockBasic::beginOp(), ghidra::PcodeOp::code(), ghidra::CPUI_STORE, ghidra::BlockBasic::endOp(), ghidra::PcodeOp::getBasicIter(), ghidra::PcodeOp::getIn(), ghidra::FlowBlock::getIn(), ghidra::PcodeOp::getOut(), ghidra::PcodeOp::getParent(), ghidra::Varnode::getSize(), ghidra::Varnode::getSpace(), ghidra::PcodeOp::isCall(), and ghidra::FlowBlock::sizeIn().

◆ reset()

virtual void ghidra::ActionStackPtrFlow::reset ( Funcdata & data )

inlinevirtual

Reset the Action for a new function.

Parameters

data	is the new function this Action may affect

Reimplemented from ghidra::Action.

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

coreaction.hh
coreaction.cc

Public Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ adjustLoad()

◆ analyzeExtraPop()

◆ apply()

◆ checkClog()

◆ clone()

◆ isStackRelative()

◆ repair()

◆ reset()