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

#include <SVFStatements.h>

Inheritance diagram for SVF::RetPE:
SVF::AssignStmt SVF::SVFStmt SVF::GenericEdge< NodeTy > SVF::TDJoinPE

Public Member Functions

 RetPE (SVFVar *s, SVFVar *d, const CallICFGNode *i, const FunExitICFGNode *e, GEdgeKind k=SVFStmt::Ret)
 constructor More...
 
const CallICFGNodegetCallInst () const
 Get method for call instruction at caller. More...
 
const CallICFGNodegetCallSite () const
 
const FunExitICFGNodegetFunExitICFGNode () const
 
virtual const std::string toString () const override
 
- Public Member Functions inherited from SVF::AssignStmt
SVFVargetRHSVar () const
 
SVFVargetLHSVar () const
 
NodeID getRHSVarID () const
 
NodeID getLHSVarID () 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 RetPE *)
 Methods for support type inquiry through isa, cast, and dyn_cast: More...
 
static bool classof (const SVFStmt *edge)
 
static bool classof (const GenericPAGEdgeTy *edge)
 
- Static Public Member Functions inherited from SVF::AssignStmt
static bool classof (const AssignStmt *)
 Methods for support type inquiry through isa, cast, and dyn_cast: More...
 
static bool classof (const SVFStmt *edge)
 
static bool classof (const GenericPAGEdgeTy *edge)
 
- 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)
 

Protected Member Functions

 RetPE (GEdgeFlag k=SVFStmt::Ret)
 the function exit statement returned from More...
 
- Protected Member Functions inherited from SVF::AssignStmt
 AssignStmt (SVFVar *s, SVFVar *d, GEdgeFlag k)
 constructor More...
 
 AssignStmt (GEdgeFlag k)
 Constructor to create empty AssignStmt (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...
 

Private Member Functions

 RetPE (const RetPE &)
 place holder More...
 
void operator= (const RetPE &)
 place holder More...
 

Private Attributes

const CallICFGNodecall
 
const FunExitICFGNodeexit
 the callsite statement returning to More...
 

Friends

class SVFIRWriter
 
class SVFIRReader
 

Additional Inherited Members

- 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...
 
- Static Public Attributes inherited from SVF::SVFStmt
static u32_t totalEdgeNum
 Total edge number. More...
 
- 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

Return

Definition at line 671 of file SVFStatements.h.

Constructor & Destructor Documentation

◆ RetPE() [1/3]

SVF::RetPE::RetPE ( const RetPE )
private

place holder

◆ RetPE() [2/3]

SVF::RetPE::RetPE ( GEdgeFlag  k = SVFStmt::Ret)
inlineprotected

the function exit statement returned from

Constructs empty RetPE (for SVFIRReader/serialization)

Definition at line 685 of file SVFStatements.h.

685 : AssignStmt(k), call{}, exit{} {}
AssignStmt()
place holder
const FunExitICFGNode * exit
the callsite statement returning to
const CallICFGNode * call

◆ RetPE() [3/3]

RetPE::RetPE ( SVFVar s,
SVFVar d,
const CallICFGNode i,
const FunExitICFGNode e,
GEdgeKind  k = SVFStmt::Ret 
)

constructor

Definition at line 339 of file SVFStatements.cpp.

341  : AssignStmt(s, d, makeEdgeFlagWithCallInst(k, i)), call(i), exit(e)
342 {
343 }
static GEdgeFlag makeEdgeFlagWithCallInst(GEdgeKind k, const ICFGNode *cs)

Member Function Documentation

◆ classof() [1/3]

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

Definition at line 699 of file SVFStatements.h.

700  {
701  return edge->getEdgeKind() == SVFStmt::Ret ||
702  edge->getEdgeKind() == SVFStmt::ThreadJoin;
703  }

◆ classof() [2/3]

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

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

Definition at line 690 of file SVFStatements.h.

691  {
692  return true;
693  }

◆ classof() [3/3]

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

Definition at line 694 of file SVFStatements.h.

695  {
696  return edge->getEdgeKind() == SVFStmt::Ret ||
697  edge->getEdgeKind() == SVFStmt::ThreadJoin;
698  }

◆ getCallInst()

const CallICFGNode* SVF::RetPE::getCallInst ( ) const
inline

Get method for call instruction at caller.

Definition at line 712 of file SVFStatements.h.

713  {
714  return call;
715  }

◆ getCallSite()

const CallICFGNode* SVF::RetPE::getCallSite ( ) const
inline

Definition at line 716 of file SVFStatements.h.

717  {
718  return call;
719  }

◆ getFunExitICFGNode()

const FunExitICFGNode* SVF::RetPE::getFunExitICFGNode ( ) const
inline

Definition at line 720 of file SVFStatements.h.

721  {
722  return exit;
723  }

◆ operator=()

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

place holder

◆ toString()

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

Implements SVF::AssignStmt.

Reimplemented in SVF::TDJoinPE.

Definition at line 244 of file SVFStatements.cpp.

245 {
246  std::string str;
247  std::stringstream rawstr(str);
248  rawstr << "RetPE: [Var" << getLHSVarID() << " <-- Var" << getRHSVarID() << "]\t";
250  {
251  rawstr << "\n";
252  rawstr << getValue()->toString();
253  }
254  return rawstr.str();
255 }
const char *const string
Definition: cJSON.h:172
NodeID getRHSVarID() const
NodeID getLHSVarID() const
static const Option< bool > ShowSVFIRValue
Definition: Options.h:122
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 674 of file SVFStatements.h.

◆ SVFIRWriter

friend class SVFIRWriter
friend

Definition at line 673 of file SVFStatements.h.

Member Data Documentation

◆ call

const CallICFGNode* SVF::RetPE::call
private

Definition at line 680 of file SVFStatements.h.

◆ exit

const FunExitICFGNode* SVF::RetPE::exit
private

the callsite statement returning to

Definition at line 681 of file SVFStatements.h.


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