decompiler  1.0.0
Public Member Functions | Static Public Member Functions | List of all members
ghidra::RulePullsubMulti Class Reference

Pull SUBPIECE back through MULTIEQUAL. More...

Inheritance diagram for ghidra::RulePullsubMulti:
ghidra::Rule

Public Member Functions

 RulePullsubMulti (const string &g)
 Constructor.
 
virtual Ruleclone (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...
 

Static Public Member Functions

static void minMaxUse (Varnode *vn, int4 &maxByte, int4 &minByte)
 Compute minimum and maximum bytes being used. More...
 
static void replaceDescendants (Varnode *origVn, Varnode *newVn, int4 maxByte, int4 minByte, Funcdata &data)
 
static bool acceptableSize (int4 size)
 Return true if given size is a suitable truncated size. More...
 
static VarnodebuildSubpiece (Varnode *basevn, uint4 outsize, uint4 shift, Funcdata &data)
 Build a SUBPIECE of given base Varnode. More...
 
static VarnodefindSubpiece (Varnode *basevn, uint4 outsize, uint4 shift)
 Find a predefined SUBPIECE of a base Varnode. More...
 

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

Pull SUBPIECE back through MULTIEQUAL.

Member Function Documentation

◆ acceptableSize()

bool ghidra::RulePullsubMulti::acceptableSize ( int4  size)
static

Return true if given size is a suitable truncated size.

Parameters
sizeis the given size
Returns
true if it is acceptable

Referenced by ghidra::RulePullsubIndirect::applyOp().

◆ applyOp()

int4 ghidra::RulePullsubMulti::applyOp ( PcodeOp op,
Funcdata data 
)
virtual

◆ buildSubpiece()

Varnode * ghidra::RulePullsubMulti::buildSubpiece ( Varnode basevn,
uint4  outsize,
uint4  shift,
Funcdata data 
)
static

◆ clone()

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

Implements ghidra::Rule.

References ghidra::ActionGroupList::contains(), ghidra::AddTreeState::data, and ghidra::AddTreeState::size.

◆ findSubpiece()

Varnode * ghidra::RulePullsubMulti::findSubpiece ( Varnode basevn,
uint4  outsize,
uint4  shift 
)
static

Find a predefined SUBPIECE of a base Varnode.

Given a Varnode and desired dimensions (size and shift), search for a preexisting truncation defined in the same block as the original Varnode or return NULL

Parameters
basevnis the base Varnode
outsizeis the desired truncation size
shiftif the desired truncation shift
Returns
the truncated Varnode or NULL

References ghidra::Varnode::beginDescend(), ghidra::PcodeOp::code(), ghidra::CPUI_SUBPIECE, ghidra::Varnode::endDescend(), ghidra::Varnode::getDef(), ghidra::PcodeOp::getIn(), ghidra::FlowBlock::getIndex(), ghidra::Varnode::getOffset(), ghidra::PcodeOp::getOut(), ghidra::PcodeOp::getParent(), ghidra::Varnode::getSize(), ghidra::Varnode::isInput(), and ghidra::Varnode::isWritten().

Referenced by ghidra::RulePullsubIndirect::applyOp().

◆ getOpList()

void ghidra::RulePullsubMulti::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
oplistis the array to populate

Reimplemented from ghidra::Rule.

References ghidra::CPUI_SUBPIECE.

◆ minMaxUse()

void ghidra::RulePullsubMulti::minMaxUse ( Varnode vn,
int4 &  maxByte,
int4 &  minByte 
)
static

Compute minimum and maximum bytes being used.

For bytes in given Varnode pass back the largest and smallest index (lsb=0) consumed by an immediate descendant.

Parameters
vnis the given Varnode
maxBytewill hold the index of the maximum byte
minBytewill hold the index of the minimum byte

References ghidra::Varnode::beginDescend(), ghidra::PcodeOp::code(), ghidra::CPUI_SUBPIECE, ghidra::Varnode::endDescend(), ghidra::PcodeOp::getIn(), ghidra::Varnode::getOffset(), ghidra::PcodeOp::getOut(), and ghidra::Varnode::getSize().

Referenced by ghidra::RulePullsubIndirect::applyOp().

◆ replaceDescendants()

void ghidra::RulePullsubMulti::replaceDescendants ( Varnode origVn,
Varnode newVn,
int4  maxByte,
int4  minByte,
Funcdata data 
)
static

Replace given Varnode with (smaller) newVn in all descendants

If minMaxUse() indicates not all bytes are used, this should always succeed

Parameters
origVnis the given Varnode
newVnis the new Varnode to replace with
maxByteis the maximum byte immediately used in origVn
minByteis the minimum byte immediately used in origVn
datais the function being analyzed

References ghidra::Varnode::beginDescend(), ghidra::PcodeOp::code(), ghidra::CPUI_COPY, ghidra::CPUI_SUBPIECE, ghidra::Varnode::endDescend(), ghidra::PcodeOp::getIn(), ghidra::Varnode::getOffset(), ghidra::PcodeOp::getOut(), ghidra::Varnode::getSize(), ghidra::Funcdata::newConstant(), ghidra::Funcdata::opRemoveInput(), ghidra::Funcdata::opSetInput(), and ghidra::Funcdata::opSetOpcode().

Referenced by ghidra::RulePullsubIndirect::applyOp().


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