decompiler  1.0.0
Public Member Functions | Private Member Functions | Static Private Member Functions | List of all members
ActionMultiCse Class Reference

Perform Common Sub-expression Elimination on CPUI_MULTIEQUAL ops. More...

#include <coreaction.hh>

Inheritance diagram for ActionMultiCse:
Action

Public Member Functions

 ActionMultiCse (const string &g)
 Constructor.
 
virtual Actionclone (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...
 
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 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 ActiongetSubAction (const string &specify)
 Retrieve a specific sub-action by name. More...
 
virtual RulegetSubRule (const string &specify)
 Retrieve a specific sub-rule by name. More...
 

Private Member Functions

bool processBlock (Funcdata &data, BlockBasic *bl)
 Search a block for equivalent CPUI_MULTIEQUAL. More...
 

Static Private Member Functions

static bool preferredOutput (Varnode *out1, Varnode *out2)
 Which of two outputs is preferred. More...
 
static PcodeOpfindMatch (BlockBasic *bl, PcodeOp *target, Varnode *in)
 Find match to CPUI_MULTIEQUAL. 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

Perform Common Sub-expression Elimination on CPUI_MULTIEQUAL ops.

Member Function Documentation

int4 ActionMultiCse::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
datais the function to inspect/modify
Returns
0 for a complete application, -1 for a partial completion (due to breakpoint)

Implements Action.

References Funcdata::getBasicBlocks(), and BlockGraph::getSize().

virtual Action* ActionMultiCse::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
grouplistis the list of groups being cloned
Returns
the cloned Action or NULL

Implements Action.

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

PcodeOp * ActionMultiCse::findMatch ( BlockBasic bl,
PcodeOp target,
Varnode in 
)
staticprivate

Find match to CPUI_MULTIEQUAL.

Find any matching CPUI_MULTIEQUAL that occurs before target that has in as an input. Then test to see if the target and the recovered op are functionally equivalent.

Parameters
blis the parent block
targetis the given target CPUI_MULTIEQUAL
inis the specific input Varnode

References BlockBasic::beginOp(), PcodeOp::code(), CPUI_COPY, functionalEqualityLevel(), Varnode::getDef(), PcodeOp::getIn(), Varnode::isWritten(), and PcodeOp::numInput().

bool ActionMultiCse::preferredOutput ( Varnode out1,
Varnode out2 
)
staticprivate

Which of two outputs is preferred.

We are substituting either -out1- for -out2- OR -out2- for -out1- Return true if we prefer substituting -out2- for -out1-

Parameters
out1is one output
out2is the other output
Returns
preference

References Varnode::beginDescend(), PcodeOp::code(), CPUI_RETURN, Varnode::endDescend(), Varnode::getSpace(), AddrSpace::getType(), IPTR_INTERNAL, and Varnode::isAddrTied().

bool ActionMultiCse::processBlock ( Funcdata data,
BlockBasic bl 
)
private

Search a block for equivalent CPUI_MULTIEQUAL.

Search for pairs of CPUI_MULTIEQUAL ops in bl that share an input. If the pairs found are functionally equivalent, delete one of the two.

Parameters
datais the function owning the block
blis the specific basic block return true if a CPUI_MULTIEQUAL was (successfully) deleted

References BlockBasic::beginOp(), PcodeOp::code(), CPUI_COPY, CPUI_MULTIEQUAL, BlockBasic::endOp(), Varnode::getDef(), PcodeOp::getIn(), PcodeOp::getOut(), Varnode::isMark(), Varnode::isWritten(), PcodeOp::numInput(), Funcdata::opDestroy(), and Funcdata::totalReplace().


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