Static Value-Flow Analysis
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
SVF::PhiStmt Class Reference

#include <SVFStatements.h>

Inheritance diagram for SVF::PhiStmt:
SVF::MultiOpndStmt SVF::SVFStmt SVF::GenericEdge< NodeTy >

Public Types

typedef std::vector< const ICFGNode * > OpICFGNodeVec
 
- Public Types inherited from SVF::MultiOpndStmt
typedef std::vector< SVFVar * > OPVars
 
- Public Types inherited from SVF::SVFStmt
enum  PEDGEK {
  Addr , Copy , Store , Load ,
  Call , Ret , Gep , Phi ,
  Select , Cmp , BinaryOp , UnaryOp ,
  Branch , ThreadFork , ThreadJoin
}
 
typedef GenericNode< SVFVar, SVFStmt >::GEdgeSetTy SVFStmtSetTy
 
typedef Map< EdgeID, SVFStmtSetTyPAGEdgeToSetMapTy
 
typedef PAGEdgeToSetMapTy KindToSVFStmtMapTy
 
typedef SVFStmtSetTy PAGEdgeSetTy
 
- Public Types inherited from SVF::GenericEdge< NodeTy >
typedef NodeTy NodeType
 Node type. More...
 
typedef u64_t GEdgeFlag
 
typedef s64_t GEdgeKind
 
typedef struct SVF::GenericEdge::equalGEdge equalGEdge
 Add the hash function for std::set (we also can overload operator< to implement this) More...
 

Public Member Functions

 PhiStmt (SVFVar *s, const OPVars &opnds, const OpICFGNodeVec &icfgNodes)
 constructor More...
 
void addOpVar (SVFVar *op, const ICFGNode *inode)
 
const ICFGNodegetOpICFGNode (u32_t op_idx) const
 Return the corresponding ICFGNode of this operand. More...
 
bool isFunctionRetPhi () const
 
virtual const std::string toString () const override
 
- Public Member Functions inherited from SVF::MultiOpndStmt
const SVFVargetOpVar (u32_t pos) const
 Operand SVFVars. More...
 
const SVFVargetRes () const
 Result SVFVar. More...
 
NodeID getOpVarID (u32_t pos) const
 
NodeID getResID () const
 
u32_t getOpVarNum () const
 
const OPVarsgetOpndVars () const
 
OPVars::const_iterator opVarBegin () const
 
OPVars::const_iterator opVerEnd () const
 
- Public Member Functions inherited from SVF::SVFStmt
 SVFStmt (SVFVar *s, SVFVar *d, GEdgeFlag k, bool real=true)
 Constructor. More...
 
 ~SVFStmt ()
 Destructor. More...
 
EdgeID getEdgeID () const
 Return Edge ID. More...
 
bool isPTAEdge () const
 Whether src and dst nodes are both of pointer type. More...
 
const SVFInstructiongetInst () const
 Get/set methods for llvm instruction. More...
 
void setValue (const SVFValue *val)
 
const SVFValuegetValue () const
 
void setBB (const SVFBasicBlock *bb)
 
const SVFBasicBlockgetBB () const
 
void setICFGNode (ICFGNode *node)
 
ICFGNodegetICFGNode () const
 
- Public Member Functions inherited from SVF::GenericEdge< NodeTy >
 GenericEdge (NodeTy *s, NodeTy *d, GEdgeFlag k)
 Constructor. More...
 
virtual ~GenericEdge ()
 Destructor. More...
 
NodeID getSrcID () const
 get methods of the components More...
 
NodeID getDstID () const
 
GEdgeKind getEdgeKind () const
 
GEdgeKind getEdgeKindWithoutMask () const
 
NodeTypegetSrcNode () const
 
NodeTypegetDstNode () const
 
virtual bool operator== (const GenericEdge< NodeType > *rhs) const
 

Static Public Member Functions

static bool classof (const PhiStmt *)
 Methods for support type inquiry through isa, cast, and dyn_cast: More...
 
static bool classof (const SVFStmt *edge)
 
static bool classof (const MultiOpndStmt *edge)
 
static bool classof (const GenericPAGEdgeTy *edge)
 
- Static Public Member Functions inherited from SVF::MultiOpndStmt
static bool classof (const MultiOpndStmt *)
 Methods for support type inquiry through isa, cast, and dyn_cast: More...
 
static bool classof (const SVFStmt *node)
 
static bool classof (const GenericPAGEdgeTy *node)
 
- Static Public Member Functions inherited from SVF::SVFStmt
static bool classof (const SVFStmt *)
 ClassOf. More...
 
static bool classof (const GenericPAGEdgeTy *edge)
 
static GEdgeFlag makeEdgeFlagWithAddionalOpnd (GEdgeKind k, const SVFVar *var)
 
static GEdgeFlag makeEdgeFlagWithCallInst (GEdgeKind k, const ICFGNode *cs)
 
static GEdgeFlag makeEdgeFlagWithStoreInst (GEdgeKind k, const ICFGNode *store)
 

Private Member Functions

 PhiStmt ()
 Constructs empty PhiStmt (for SVFIRReader/serialization) More...
 
 PhiStmt (const PhiStmt &)
 place holder More...
 
void operator= (const PhiStmt &)
 place holder More...
 

Private Attributes

OpICFGNodeVec opICFGNodes
 

Friends

class SVFIRWriter
 
class SVFIRReader
 

Additional Inherited Members

- Static Public Attributes inherited from SVF::SVFStmt
static u32_t totalEdgeNum
 Total edge number. More...
 
- Protected Member Functions inherited from SVF::MultiOpndStmt
 MultiOpndStmt (SVFVar *r, const OPVars &opnds, GEdgeFlag k)
 Constructor, only used by subclasses but not external users. More...
 
 MultiOpndStmt (GEdgeFlag k)
 Constructs empty MultiOpndStmt (for SVFIRReader/serialization) More...
 
- Protected Member Functions inherited from SVF::SVFStmt
 SVFStmt (GEdgeFlag k)
 Private constructor for reading SVFIR from file without side-effect. More...
 
- Protected Attributes inherited from SVF::MultiOpndStmt
OPVars opVars
 
- Static Protected Attributes inherited from SVF::GenericEdge< NodeTy >
static constexpr unsigned char EdgeKindMaskBits = 8
 We use the lower 8 bits to denote edge kind. More...
 
static constexpr u64_t EdgeKindMask = (~0ULL) >> (64 - EdgeKindMaskBits)
 

Detailed Description

Phi statement (e.g., p = phi(q,r) which receives values from variables q and r from different paths) it is typically at a joint point of the control-flow graph

Definition at line 814 of file SVFStatements.h.

Member Typedef Documentation

◆ OpICFGNodeVec

typedef std::vector<const ICFGNode*> SVF::PhiStmt::OpICFGNodeVec

Definition at line 820 of file SVFStatements.h.

Constructor & Destructor Documentation

◆ PhiStmt() [1/3]

SVF::PhiStmt::PhiStmt ( )
inlineprivate

Constructs empty PhiStmt (for SVFIRReader/serialization)

Definition at line 824 of file SVFStatements.h.

◆ PhiStmt() [2/3]

SVF::PhiStmt::PhiStmt ( const PhiStmt )
private

place holder

◆ PhiStmt() [3/3]

SVF::PhiStmt::PhiStmt ( SVFVar s,
const OPVars opnds,
const OpICFGNodeVec icfgNodes 
)
inline

constructor

Definition at line 852 of file SVFStatements.h.

853  : MultiOpndStmt(s, opnds, SVFStmt::Phi), opICFGNodes(icfgNodes)
854  {
855  assert(opnds.size() == icfgNodes.size() &&
856  "Numbers of operands and their ICFGNodes are not consistent?");
857  }
OpICFGNodeVec opICFGNodes

Member Function Documentation

◆ addOpVar()

void SVF::PhiStmt::addOpVar ( SVFVar op,
const ICFGNode inode 
)
inline

Definition at line 858 of file SVFStatements.h.

859  {
860  opVars.push_back(op);
861  opICFGNodes.push_back(inode);
862  assert(opVars.size() == opICFGNodes.size() &&
863  "Numbers of operands and their ICFGNodes are not consistent?");
864  }

◆ classof() [1/4]

static bool SVF::PhiStmt::classof ( const GenericPAGEdgeTy edge)
inlinestatic

Definition at line 845 of file SVFStatements.h.

846  {
847  return edge->getEdgeKind() == SVFStmt::Phi;
848  }

◆ classof() [2/4]

static bool SVF::PhiStmt::classof ( const MultiOpndStmt edge)
inlinestatic

Definition at line 841 of file SVFStatements.h.

842  {
843  return edge->getEdgeKind() == SVFStmt::Phi;
844  }

◆ classof() [3/4]

static bool SVF::PhiStmt::classof ( const PhiStmt )
inlinestatic

Methods for support type inquiry through isa, cast, and dyn_cast:

Definition at line 833 of file SVFStatements.h.

834  {
835  return true;
836  }

◆ classof() [4/4]

static bool SVF::PhiStmt::classof ( const SVFStmt edge)
inlinestatic

Definition at line 837 of file SVFStatements.h.

838  {
839  return edge->getEdgeKind() == SVFStmt::Phi;
840  }

◆ getOpICFGNode()

const ICFGNode* SVF::PhiStmt::getOpICFGNode ( u32_t  op_idx) const
inline

Return the corresponding ICFGNode of this operand.

Definition at line 867 of file SVFStatements.h.

868  {
869  return opICFGNodes.at(op_idx);
870  }

◆ isFunctionRetPhi()

bool PhiStmt::isFunctionRetPhi ( ) const

Return true if this is a phi at the function exit to receive one or multiple return values of this function

Definition at line 305 of file SVFStatements.cpp.

306 {
307  return SVFUtil::isa<RetPN>(getRes());
308 }
const SVFVar * getRes() const
Result SVFVar.

◆ operator=()

void SVF::PhiStmt::operator= ( const PhiStmt )
private

place holder

◆ toString()

const std::string PhiStmt::toString ( ) const
overridevirtual

Reimplemented from SVF::SVFStmt.

Definition at line 100 of file SVFStatements.cpp.

101 {
102  std::string str;
103  std::stringstream rawstr(str);
104  rawstr << "PhiStmt: [Var" << getResID() << " <-- (";
105  for(u32_t i = 0; i < getOpVarNum(); i++)
106  rawstr << "[Var" << getOpVar(i)->getId() << ", ICFGNode" << getOpICFGNode(i)->getId() << "],";
107  rawstr << ")]\t";
109  {
110  rawstr << "\n";
111  rawstr << getValue()->toString();
112  }
113  return rawstr.str();
114 }
unsigned u32_t
Definition: CommandLine.h:18
const char *const string
Definition: cJSON.h:172
const SVFVar * getOpVar(u32_t pos) const
Operand SVFVars.
NodeID getResID() const
u32_t getOpVarNum() const
static const Option< bool > ShowSVFIRValue
Definition: Options.h:122
const ICFGNode * getOpICFGNode(u32_t op_idx) const
Return the corresponding ICFGNode of this operand.
NodeID getId() const
Get ID.
Definition: GenericGraph.h:260
const SVFValue * getValue() const
std::string toString() const
Needs to be implemented by a SVF front end.
Definition: LLVMUtil.cpp:663

Friends And Related Function Documentation

◆ SVFIRReader

friend class SVFIRReader
friend

Definition at line 817 of file SVFStatements.h.

◆ SVFIRWriter

friend class SVFIRWriter
friend

Definition at line 816 of file SVFStatements.h.

Member Data Documentation

◆ opICFGNodes

OpICFGNodeVec SVF::PhiStmt::opICFGNodes
private

Definition at line 828 of file SVFStatements.h.


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