Split the epilog code of the function. More...

#include <blockaction.hh>

Inheritance diagram for ActionReturnSplit:

Public Member Functions
	ActionReturnSplit (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 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...

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 void	saveXml (ostream &s) const
	Save specifics of this action to stream.

virtual void	restoreXml (const Element el, Funcdata fd)
	Load specifics of action from XML.

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	gatherReturnGotos (FlowBlock parent, vector< FlowBlock > &vec)
	Gather all blocks that have goto edge to a RETURN. More...

static bool	isSplittable (BlockBasic *b)
	Determine if a RETURN block can be split. More...

Additional Inherited Members
Public Types inherited from 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 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 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

Split the epilog code of the function.

Introduce RETURN operations corresponding to individual branches flowing to the epilog.

Member Function Documentation

◆ apply()

int4 ActionReturnSplit::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 Action.

References Funcdata::beginOp(), CPUI_RETURN, ConditionalJoin::data, Funcdata::endOp(), Funcdata::getArch(), Funcdata::getBasicBlocks(), FlowBlock::getCopyMap(), FlowBlock::getIn(), PcodeOp::getParent(), FlowBlock::getParent(), BlockGraph::getSize(), Funcdata::getStructure(), PcodeOp::isDead(), FlowBlock::isMark(), Funcdata::nodeSplit(), Architecture::printMessage(), and FlowBlock::sizeIn().

◆ clone()

virtual Action* ActionReturnSplit::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 Action.

References ActionReturnSplit(), ActionGroupList::contains(), and Action::getGroup().

◆ gatherReturnGotos()

void ActionReturnSplit::gatherReturnGotos	(	FlowBlock *	parent,
		vector< FlowBlock * > &	vec
	)

staticprivate

Gather all blocks that have goto edge to a RETURN.

Collect all BlockGoto or BlockIf nodes, where there is a goto edge to a RETURN block.

Parameters

parent	is a FlowBlock that ends in a RETURN operation
vec	will hold the goto blocks

References FlowBlock::getCopyMap(), FlowBlock::getIn(), FlowBlock::getParent(), FlowBlock::getType(), FlowBlock::isMark(), FlowBlock::setMark(), FlowBlock::sizeIn(), and FlowBlock::subBlock().

◆ isSplittable()

bool ActionReturnSplit::isSplittable ( BlockBasic * b )

staticprivate

Determine if a RETURN block can be split.

Given a BasicBlock ending in a RETURN operation, determine if there is any other substantive operation going on in the block. If there is, the block is deemed too complicated to split.

Parameters

b	is the given BasicBlock

Returns: true if the block can be split

References BlockBasic::beginOp(), PcodeOp::code(), CPUI_COPY, CPUI_MULTIEQUAL, CPUI_RETURN, BlockBasic::endOp(), PcodeOp::getIn(), Varnode::isAnnotation(), Varnode::isConstant(), Varnode::isFree(), and PcodeOp::numInput().

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

blockaction.hh
blockaction.cc

Public Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ apply()

◆ clone()

◆ gatherReturnGotos()

◆ isSplittable()