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

#include <SVFVariables.h>

Inheritance diagram for SVF::RetPN:
SVF::ValVar SVF::SVFVar SVF::GenericNode< NodeTy, EdgeTy > SVF::SVFBaseNode

Public Member Functions

 RetPN (const SVFFunction *val, NodeID i)
 Constructor. More...
 
const std::string getValueName () const
 Return name of a LLVM value. More...
 
virtual const std::string toString () const
 
- Public Member Functions inherited from SVF::ValVar
 ValVar (const SVFValue *val, NodeID i, PNODEK ty=ValNode, const SVFBaseNode *node=nullptr)
 Constructor. More...
 
const SVFBaseNodegetGNode () const
 
- Public Member Functions inherited from SVF::SVFVar
 SVFVar (const SVFValue *val, NodeID i, PNODEK k)
 Constructor. More...
 
virtual ~SVFVar ()
 Destructor. More...
 
const SVFValuegetValue () const
 Get/has methods of the components. More...
 
virtual const SVFTypegetType () const
 Return type of the value. More...
 
bool hasValue () const
 
virtual bool isPointer () const
 Whether it is a pointer. More...
 
bool isConstDataOrAggDataButNotNullPtr () const
 
bool isIsolatedNode () const
 Whether this is an isolated node on the SVFIR graph. More...
 
virtual const SVFFunctiongetFunction () const
 Return the function that this SVFVar resides in. Return nullptr if it is a global or constantexpr node. More...
 
SVFStmt::SVFStmtSetTygetIncomingEdges (SVFStmt::PEDGEK kind)
 Get incoming SVFIR statements (edges) More...
 
SVFStmt::SVFStmtSetTygetOutgoingEdges (SVFStmt::PEDGEK kind)
 Get outgoing SVFIR statements (edges) More...
 
bool hasIncomingEdges (SVFStmt::PEDGEK kind) const
 Has incoming SVFIR statements (edges) More...
 
bool hasOutgoingEdges (SVFStmt::PEDGEK kind) const
 Has outgoing SVFIR statements (edges) More...
 
SVFStmt::SVFStmtSetTy::iterator getIncomingEdgesBegin (SVFStmt::PEDGEK kind) const
 Get incoming SVFStmt iterator. More...
 
SVFStmt::SVFStmtSetTy::iterator getIncomingEdgesEnd (SVFStmt::PEDGEK kind) const
 Get incoming SVFStmt iterator. More...
 
SVFStmt::SVFStmtSetTy::iterator getOutgoingEdgesBegin (SVFStmt::PEDGEK kind) const
 Get outgoing SVFStmt iterator. More...
 
SVFStmt::SVFStmtSetTy::iterator getOutgoingEdgesEnd (SVFStmt::PEDGEK kind) const
 Get outgoing SVFStmt iterator. More...
 
void dump () const
 Dump to console for debugging. More...
 
- Public Member Functions inherited from SVF::GenericNode< NodeTy, EdgeTy >
 GenericNode (NodeID i, GNodeK k)
 Constructor. More...
 
virtual ~GenericNode ()
 Destructor. More...
 
bool hasIncomingEdge () const
 Has incoming/outgoing edge set. More...
 
bool hasOutgoingEdge () const
 
iterator OutEdgeBegin ()
 iterators More...
 
iterator OutEdgeEnd ()
 
iterator InEdgeBegin ()
 
iterator InEdgeEnd ()
 
const_iterator OutEdgeBegin () const
 
const_iterator OutEdgeEnd () const
 
const_iterator InEdgeBegin () const
 
const_iterator InEdgeEnd () const
 
virtual iterator directOutEdgeBegin ()
 Iterators used for SCC detection, overwrite it in child class if necessary. More...
 
virtual iterator directOutEdgeEnd ()
 
virtual iterator directInEdgeBegin ()
 
virtual iterator directInEdgeEnd ()
 
virtual const_iterator directOutEdgeBegin () const
 
virtual const_iterator directOutEdgeEnd () const
 
virtual const_iterator directInEdgeBegin () const
 
virtual const_iterator directInEdgeEnd () const
 
bool addIncomingEdge (EdgeType *inEdge)
 Add incoming and outgoing edges. More...
 
bool addOutgoingEdge (EdgeType *outEdge)
 
EdgeTypehasIncomingEdge (EdgeType *edge) const
 Find incoming and outgoing edges. More...
 
EdgeTypehasOutgoingEdge (EdgeType *edge) const
 
const GEdgeSetTygetOutEdges () const
 
const GEdgeSetTygetInEdges () const
 
u32_t removeIncomingEdge (EdgeType *edge)
 
u32_t removeOutgoingEdge (EdgeType *edge)
 
- Public Member Functions inherited from SVF::SVFBaseNode
 SVFBaseNode (NodeID i, GNodeK k, SVFType *ty=nullptr)
 
NodeID getId () const
 Get ID. More...
 
GNodeK getNodeKind () const
 Get node kind. More...
 
virtual void setSourceLoc (const std::string &sourceCodeInfo)
 
virtual const std::string getSourceLoc () const
 
const std::string valueOnlyToString () const
 

Static Public Member Functions

static bool classof (const RetPN *)
 
static bool classof (const SVFVar *node)
 
static bool classof (const ValVar *node)
 
static bool classof (const GenericPAGNodeTy *node)
 
static bool classof (const SVFBaseNode *node)
 
- Static Public Member Functions inherited from SVF::ValVar
static bool classof (const ValVar *)
 Methods for support type inquiry through isa, cast, and dyn_cast: More...
 
static bool classof (const SVFVar *node)
 
static bool classof (const GenericPAGNodeTy *node)
 
static bool classof (const SVFBaseNode *node)
 
- Static Public Member Functions inherited from SVF::SVFVar
static bool classof (const SVFVar *)
 
static bool classof (const GenericPAGNodeTy *node)
 
static bool classof (const SVFBaseNode *node)
 
- Static Public Member Functions inherited from SVF::GenericNode< NodeTy, EdgeTy >
static bool classof (const GenericNode< NodeTy, EdgeTy > *)
 
static bool classof (const SVFBaseNode *)
 

Private Member Functions

 RetPN (NodeID i)
 Constructor to create empty RetPN (for SVFIRReader/deserialization) More...
 

Friends

class SVFIRWriter
 
class SVFIRReader
 

Additional Inherited Members

- Public Types inherited from SVF::SVFVar
typedef GNodeK PNODEK
 
typedef s64_t GEdgeKind
 
- Public Types inherited from SVF::GenericNode< NodeTy, EdgeTy >
typedef NodeTy NodeType
 
typedef EdgeTy EdgeType
 
typedef OrderedSet< EdgeType *, typename EdgeType::equalGEdge > GEdgeSetTy
 Edge kind. More...
 
typedef GEdgeSetTy::iterator iterator
 
typedef GEdgeSetTy::const_iterator const_iterator
 
- Public Types inherited from SVF::SVFBaseNode
enum  GNodeK {
  IntraBlock , GlobalBlock , FunEntryBlock , FunExitBlock ,
  FunCallBlock , FunRetBlock , ValNode , GepValNode ,
  RetNode , VarargNode , DummyValNode , ObjNode ,
  GepObjNode , FIObjNode , DummyObjNode , Cmp ,
  BinaryOp , UnaryOp , Branch , DummyVProp ,
  NPtr , FRet , ARet , AParm ,
  FParm , Addr , Copy , Gep ,
  Store , Load , TPhi , TIntraPhi ,
  TInterPhi , FPIN , FPOUT , APIN ,
  APOUT , MPhi , MIntraPhi , MInterPhi ,
  CallNodeKd , CDNodeKd , CFLNodeKd , CHNodeKd ,
  ConstraintNodeKd , TCTNodeKd , DCHNodeKd , OtherKd
}
 
- Protected Member Functions inherited from SVF::ValVar
 ValVar (NodeID i, PNODEK ty=ValNode)
 Constructor to create an empty ValVar (for SVFIRReader/deserialization) More...
 
- Protected Member Functions inherited from SVF::SVFVar
 SVFVar (NodeID i, PNODEK k)
 whether it is a pointer (top-level or address-taken) More...
 
- Static Protected Member Functions inherited from SVF::SVFBaseNode
static bool isICFGNodeKinds (GNodeK n)
 Helper functions to check node kinds. More...
 
static bool isInterICFGNodeKind (GNodeK n)
 
static bool isSVFVarKind (GNodeK n)
 
static bool isValVarKinds (GNodeK n)
 
static bool isObjVarKinds (GNodeK n)
 
static bool isVFGNodeKinds (GNodeK n)
 
static bool isArgumentVFGNodeKinds (GNodeK n)
 
static bool isStmtVFGNodeKinds (GNodeK n)
 
static bool isPHIVFGNodeKinds (GNodeK n)
 
static bool isMRSVFGNodeKinds (GNodeK n)
 
static bool isMSSAPHISVFGNodeKinds (GNodeK n)
 
- Protected Attributes inherited from SVF::SVFVar
const SVFValuevalue
 value of this SVFIR node More...
 
SVFStmt::KindToSVFStmtMapTy InEdgeKindToSetMap
 
SVFStmt::KindToSVFStmtMapTy OutEdgeKindToSetMap
 
bool isPtr
 
- Protected Attributes inherited from SVF::SVFBaseNode
NodeID id
 Node ID. More...
 
GNodeK nodeKind
 Node kind. More...
 
const SVFTypetype
 SVF type. More...
 
std::string sourceLoc
 Source code information of this value. More...
 

Detailed Description

Definition at line 593 of file SVFVariables.h.

Constructor & Destructor Documentation

◆ RetPN() [1/2]

SVF::RetPN::RetPN ( NodeID  i)
inlineprivate

Constructor to create empty RetPN (for SVFIRReader/deserialization)

Definition at line 600 of file SVFVariables.h.

600 : ValVar(i, RetNode) {}
ValVar(NodeID i, PNODEK ty=ValNode)
Constructor to create an empty ValVar (for SVFIRReader/deserialization)
Definition: SVFVariables.h:275

◆ RetPN() [2/2]

SVF::RetPN::RetPN ( const SVFFunction val,
NodeID  i 
)
inline

Constructor.

Definition at line 627 of file SVFVariables.h.

627 : ValVar(val, i, RetNode) {}

Member Function Documentation

◆ classof() [1/5]

static bool SVF::RetPN::classof ( const GenericPAGNodeTy node)
inlinestatic

Definition at line 616 of file SVFVariables.h.

617  {
618  return node->getNodeKind() == SVFVar::RetNode;
619  }

◆ classof() [2/5]

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

Definition at line 604 of file SVFVariables.h.

605  {
606  return true;
607  }

◆ classof() [3/5]

static bool SVF::RetPN::classof ( const SVFBaseNode node)
inlinestatic

Definition at line 620 of file SVFVariables.h.

621  {
622  return node->getNodeKind() == SVFVar::RetNode;
623  }

◆ classof() [4/5]

static bool SVF::RetPN::classof ( const SVFVar node)
inlinestatic

Definition at line 608 of file SVFVariables.h.

609  {
610  return node->getNodeKind() == SVFVar::RetNode;
611  }

◆ classof() [5/5]

static bool SVF::RetPN::classof ( const ValVar node)
inlinestatic

Definition at line 612 of file SVFVariables.h.

613  {
614  return node->getNodeKind() == SVFVar::RetNode;
615  }

◆ getValueName()

const std::string SVF::RetPN::getValueName ( ) const
inlinevirtual

Return name of a LLVM value.

Reimplemented from SVF::ValVar.

Definition at line 630 of file SVFVariables.h.

631  {
632  return value->getName() + "_ret";
633  }
const std::string & getName() const
Definition: SVFValue.h:243
const SVFValue * value
value of this SVFIR node
Definition: SVFVariables.h:67

◆ toString()

const std::string RetPN::toString ( ) const
virtual

Reimplemented from SVF::ValVar.

Definition at line 173 of file SVFVariables.cpp.

174 {
175  std::string str;
176  std::stringstream rawstr(str);
177  rawstr << "RetPN ID: " << getId() << " unique return node for function " << SVFUtil::cast<SVFFunction>(value)->getName();
178  return rawstr.str();
179 }
const char *const string
Definition: cJSON.h:172
NodeID getId() const
Get ID.
Definition: GenericGraph.h:260

Friends And Related Function Documentation

◆ SVFIRReader

friend class SVFIRReader
friend

Definition at line 596 of file SVFVariables.h.

◆ SVFIRWriter

friend class SVFIRWriter
friend

Definition at line 595 of file SVFVariables.h.


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