Find explicit Varnodes: Varnodes that have an explicit token representing them in the output. More...

#include <coreaction.hh>

Inheritance diagram for ghidra::ActionMarkExplicit:

Classes
struct	OpStackElement
	This class holds a single entry in a stack used to traverse Varnode expressions. More...

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

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	reset (Funcdata &data)
	Reset the Action for a new function. More...

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 int4	baseExplicit (Varnode *vn, int4 maxref)
	Make initial determination if a Varnode should be explicit. More...

static int4	multipleInteraction (vector< Varnode *> &multlist)
	Find multiple descendant chains. More...

static void	processMultiplier (Varnode *vn, int4 max)
	For a given multi-descendant Varnode, decide if it should be explicit. More...

static void	checkNewToConstructor (Funcdata &data, Varnode *vn)
	Set special properties on output of CPUI_NEW. More...

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

Find explicit Varnodes: Varnodes that have an explicit token representing them in the output.

In the final output of the syntax tree as source code, all variables are characterized as either

explicit, having a specific identifier in the source code, or
implied, an intermediate result of an expression with no specific identifier

This Action does preliminary scanning of Varnodes to determine which should be explicit in the final output. Basically, if there is symbol information associated, the possibility of aliasing, or if there are too many reads of a Varnode, it should be considered explicit.

Member Function Documentation

◆ apply()

int4 ghidra::ActionMarkExplicit::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.

References ghidra::Funcdata::beginDef(), ghidra::Funcdata::getArch(), ghidra::Varnode::isMark(), ghidra::Architecture::max_implied_ref, ghidra::Architecture::max_term_duplication, ghidra::Varnode::setExplicit(), and ghidra::Varnode::setMark().

◆ baseExplicit()

int4 ghidra::ActionMarkExplicit::baseExplicit	(	Varnode *	vn,
		int4	maxref
	)

staticprivate

Make initial determination if a Varnode should be explicit.

If the given Varnode is defined by CPUI_NEW, return -2 indicating it should be explicit and that it needs special printing.

Parameters

vn	is the given Varnode
maxref	is the maximum number of references to consider before forcing explicitness

Returns: -1 or -2 if given Varnode should be marked explicit, the number of descendants otherwise

◆ checkNewToConstructor()

void ghidra::ActionMarkExplicit::checkNewToConstructor	(	Funcdata &	data,
		Varnode *	vn
	)

staticprivate

Set special properties on output of CPUI_NEW.

Assume vn is produced via a CPUI_NEW operation. If it is immediately fed to a constructor, set special printing flags on the Varnode.

Parameters

data	is the function being analyzed
vn	is the given Varnode

References ghidra::Varnode::beginDescend(), ghidra::PcodeOp::code(), ghidra::CPUI_CALLIND, ghidra::Varnode::endDescend(), ghidra::Varnode::getDef(), ghidra::PcodeOp::getIn(), ghidra::SeqNum::getOrder(), ghidra::PcodeOp::getOut(), ghidra::PcodeOp::getParent(), ghidra::PcodeOp::getSeqNum(), ghidra::PcodeOp::isCall(), ghidra::Varnode::isWritten(), ghidra::PcodeOp::numInput(), ghidra::Funcdata::opMarkNonPrinting(), and ghidra::Funcdata::opMarkSpecialPrint().

◆ clone()

virtual Action* ghidra::ActionMarkExplicit::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().

◆ multipleInteraction()

int4 ghidra::ActionMarkExplicit::multipleInteraction ( vector< Varnode *> & multlist )

staticprivate

Find multiple descendant chains.

Look for certain situations where one Varnode with multiple descendants has one descendant who also has multiple descendants. This routine is handed the list of Varnodes with multiple descendants; These all must already have their mark set. For the situations we can find with one flowing into another, mark the top Varnode as explicit.

Parameters

multlist is the list Varnodes with multiple descendants

Returns: the number Varnodes that were marked as explicit

References ghidra::Varnode::clearImplied(), ghidra::Varnode::clearMark(), ghidra::PcodeOp::code(), ghidra::CPUI_COPY, ghidra::CPUI_INT_SEXT, ghidra::CPUI_INT_ZEXT, ghidra::CPUI_PTRADD, ghidra::Varnode::getDef(), ghidra::PcodeOp::getIn(), ghidra::PcodeOp::isBoolOutput(), ghidra::Varnode::isMark(), ghidra::Varnode::isWritten(), ghidra::PcodeOp::numInput(), and ghidra::Varnode::setExplicit().

◆ processMultiplier()

void ghidra::ActionMarkExplicit::processMultiplier	(	Varnode *	vn,
		int4	max
	)

staticprivate

For a given multi-descendant Varnode, decide if it should be explicit.

Count the number of terms in the expression making up vn. If there are more than max terms, mark vn as explicit. The given Varnode is already assumed to have multiple descendants. We do a depth first traversal along op inputs, to recursively calculate the number of explicit terms in an expression.

Parameters

vn	is the given Varnode
max	is the maximum number of terms to allow

References ghidra::Varnode::clearImplied(), ghidra::Varnode::getDef(), ghidra::PcodeOp::getIn(), ghidra::Varnode::isExplicit(), ghidra::Varnode::isMark(), ghidra::Varnode::isSpacebase(), ghidra::Varnode::isWritten(), and ghidra::Varnode::setExplicit().

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

coreaction.hh
coreaction.cc

Classes

Public Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ apply()

◆ baseExplicit()

◆ checkNewToConstructor()

◆ clone()

◆ multipleInteraction()

◆ processMultiplier()