retdec
Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
retdec::llvmir2hll::VarUseCFGTraversal Class Referencefinal

A CFG traversal that checks whether a variable is defined/modified prior to every read access to it in a function. More...

#include <var_use_cfg_traversal.h>

Inheritance diagram for retdec::llvmir2hll::VarUseCFGTraversal:
Inheritance graph
[legend]
Collaboration diagram for retdec::llvmir2hll::VarUseCFGTraversal:
Collaboration graph
[legend]

Static Public Member Functions

static bool isDefinedPriorToEveryAccess (ShPtr< Variable > var, ShPtr< CFG > cfg, ShPtr< ValueAnalysis > va)
 Returns true if the given variable var is defined/modified prior to every read access to it in cfg. More...
 

Private Member Functions

 VarUseCFGTraversal (ShPtr< Variable > var, ShPtr< CFG > cfg, ShPtr< ValueAnalysis > va)
 Constructs a new traverser. More...
 
virtual bool visitStmt (ShPtr< Statement > stmt) override
 Visits the given statement stmt. More...
 
virtual bool getEndRetVal () const override
 Returns the value that should be returned when an end of the traversal is reached. More...
 
virtual bool combineRetVals (bool origRetVal, bool newRetVal) const override
 Computes a new return value from the original return value (origRetVal) and the new return value (newRetVal). More...
 

Private Attributes

ShPtr< Variablevar
 Variable whose definition/modification is looked for. More...
 
ShPtr< ValueAnalysisva
 Analysis of values. More...
 

Additional Inherited Members

- Protected Member Functions inherited from retdec::llvmir2hll::CFGTraversal
 CFGTraversal (ShPtr< CFG > cfg, bool defaultCurrRetVal)
 Constructs a new traverser. More...
 
 ~CFGTraversal ()=default
 
bool getCurrRetVal () const
 Returns the value that should be returned as the result of visiting a statement. More...
 
bool performTraversal (ShPtr< Statement > startStmt)
 Performs a traversal of the current CFG, starting at startStmt. More...
 
bool performTraversalFromSuccessors (ShPtr< Statement > stmt)
 Performs a traversal of the current CFG, starting at the successor(s) of stmt. More...
 
bool performReverseTraversal (ShPtr< Statement > startStmt)
 Performs a reverse traversal of the current CFG, starting at startStmt. More...
 
bool performReverseTraversalFromPredecessors (ShPtr< Statement > stmt)
 Performs a reverse traversal of the current CFG, starting at the predecessor(s) of stmt. More...
 
- Protected Attributes inherited from retdec::llvmir2hll::CFGTraversal
ShPtr< CFGcfg
 CFG that is being traversed. More...
 
StmtUSet checkedStmts
 Statements that have been checked (to prevent looping). More...
 
bool currRetVal
 Current return value of visitStmt(). More...
 
bool stopTraversal
 Should the traversal be stopped? More...
 

Detailed Description

A CFG traversal that checks whether a variable is defined/modified prior to every read access to it in a function.

Instances of this class have reference object semantics. This is a concrete traverser which should not be subclassed.

Constructor & Destructor Documentation

◆ VarUseCFGTraversal()

retdec::llvmir2hll::VarUseCFGTraversal::VarUseCFGTraversal ( ShPtr< Variable var,
ShPtr< CFG cfg,
ShPtr< ValueAnalysis va 
)
private

Constructs a new traverser.

See the description of isDefinedPriorToEveryAccess() for information on the parameters.

Member Function Documentation

◆ combineRetVals()

bool retdec::llvmir2hll::VarUseCFGTraversal::combineRetVals ( bool  origRetVal,
bool  newRetVal 
) const
overrideprivatevirtual

Computes a new return value from the original return value (origRetVal) and the new return value (newRetVal).

Implements retdec::llvmir2hll::CFGTraversal.

◆ getEndRetVal()

bool retdec::llvmir2hll::VarUseCFGTraversal::getEndRetVal ( ) const
overrideprivatevirtual

Returns the value that should be returned when an end of the traversal is reached.

For example, the end may mean the end node of the CFG or a statement that has already been traversed.

Implements retdec::llvmir2hll::CFGTraversal.

◆ isDefinedPriorToEveryAccess()

bool retdec::llvmir2hll::VarUseCFGTraversal::isDefinedPriorToEveryAccess ( ShPtr< Variable var,
ShPtr< CFG cfg,
ShPtr< ValueAnalysis va 
)
static

Returns true if the given variable var is defined/modified prior to every read access to it in cfg.

Parameters
[in]varVariable whose definition/modification is looked for.
[in]cfgCFG that should be traversed.
[in]vaAnalysis of values.
Preconditions
  • var, cfg, and va are non-null
  • va is in a valid state

This function leaves va in a valid state.

◆ visitStmt()

bool retdec::llvmir2hll::VarUseCFGTraversal::visitStmt ( ShPtr< Statement stmt)
overrideprivatevirtual

Visits the given statement stmt.

return true if the traversing should continue, false otherwise.

Note: checkedStmts is modified in CFGTraversal, so it is not necessary for the implementation of this function to add stmt to checkedStmts.

If you want the traversal to end prematurely, set the stopTraversal variable to true. Otherwise, if you just return false, the traversal may still continue from other branches because of recursion.

Implements retdec::llvmir2hll::CFGTraversal.

Member Data Documentation

◆ va

ShPtr<ValueAnalysis> retdec::llvmir2hll::VarUseCFGTraversal::va
private

Analysis of values.

◆ var

ShPtr<Variable> retdec::llvmir2hll::VarUseCFGTraversal::var
private

Variable whose definition/modification is looked for.


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