SVF::RetICFGNode Class Reference

#include <ICFGNode.h>

Inheritance diagram for SVF::RetICFGNode:

Public Member Functions
	RetICFGNode (NodeID id, CallICFGNode *cb)
const CallICFGNode *	getCallICFGNode () const
const SVFVar *	getActualRet () const
	Return actual return parameter.
void	addActualRet (const SVFVar *ar)
	Add actual return parameter.
const std::string	toString () const override
const std::string	getSourceLoc () const override
Public Member Functions inherited from SVF::InterICFGNode
	InterICFGNode (NodeID id, ICFGNodeK k)
	Constructor.
Public Member Functions inherited from SVF::ICFGNode
	ICFGNode (NodeID i, GNodeK k)
	Constructor.
virtual const FunObjVar *	getFun () const
	Return the function of this ICFGNode.
virtual const SVFBasicBlock *	getBB () const
	Return the basic block of this ICFGNode.
void	dump () const
void	addVFGNode (const VFGNode *vfgNode)
const VFGNodeList &	getVFGNodes () const
void	addSVFStmt (const SVFStmt *edge)
const SVFStmtList &	getSVFStmts () const
Public Member Functions inherited from SVF::GenericNode< ICFGNode, ICFGEdge >
	GenericNode (NodeID i, GNodeK k, const SVFType *svfType=nullptr)
	Constructor.
virtual	~GenericNode ()
	Destructor.
bool	hasIncomingEdge () const
	Has incoming/outgoing edge set.
bool	hasOutgoingEdge () const
iterator	OutEdgeBegin ()
	iterators
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.
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.
bool	addOutgoingEdge (EdgeType *outEdge)
EdgeType *	hasIncomingEdge (EdgeType *edge) const
	Find incoming and outgoing edges.
EdgeType *	hasOutgoingEdge (EdgeType *edge) const
const GEdgeSetTy &	getOutEdges () const
const GEdgeSetTy &	getInEdges () const
u32_t	removeIncomingEdge (EdgeType *edge)
u32_t	removeOutgoingEdge (EdgeType *edge)
Public Member Functions inherited from SVF::SVFValue
	SVFValue (NodeID i, GNodeK k, const SVFType *ty=nullptr)
NodeID	getId () const
	Get ID.
GNodeK	getNodeKind () const
	Get node kind.
virtual const SVFType *	getType () const
virtual void	setName (const std::string &nameInfo)
virtual void	setName (std::string &&nameInfo)
virtual const std::string &	getName () const
virtual void	setSourceLoc (const std::string &sourceCodeInfo)
const std::string	valueOnlyToString () const
const bool	hasLLVMValue () const

Static Public Member Functions
static bool	classof (const RetICFGNode *)
	Methods for support type inquiry through isa, cast, and dyn_cast:
static bool	classof (const InterICFGNode *node)
static bool	classof (const ICFGNode *node)
static bool	classof (const GenericICFGNodeTy *node)
static bool	classof (const SVFValue *node)
Static Public Member Functions inherited from SVF::InterICFGNode
static bool	classof (const InterICFGNode *)
	Methods for support type inquiry through isa, cast, and dyn_cast:
static bool	classof (const ICFGNode *node)
static bool	classof (const GenericICFGNodeTy *node)
static bool	classof (const SVFValue *node)
Static Public Member Functions inherited from SVF::ICFGNode
static bool	classof (const ICFGNode *)
static bool	classof (const GenericICFGNodeTy *node)
static bool	classof (const SVFValue *node)
Static Public Member Functions inherited from SVF::GenericNode< ICFGNode, ICFGEdge >
static bool	classof (const GenericNode< ICFGNode, ICFGEdge > *)
static bool	classof (const SVFValue *)

Protected Member Functions
void	setCallBlockNode (const CallICFGNode *cb)
	Add call block node from database for the new RetICFGNode [only used this function when loading from db results].

Private Attributes
const SVFVar *	actualRet
const CallICFGNode *	callBlockNode

Friends
class	GraphDBClient

Additional Inherited Members
Public Types inherited from SVF::ICFGNode
typedef ICFGEdge::ICFGEdgeSetTy::iterator	iterator
typedef ICFGEdge::ICFGEdgeSetTy::const_iterator	const_iterator
typedef Set< const CallPE * >	CallPESet
typedef Set< const RetPE * >	RetPESet
typedef std::list< const VFGNode * >	VFGNodeList
typedef std::list< const SVFStmt * >	SVFStmtList
typedef GNodeK	ICFGNodeK
Public Types inherited from SVF::GenericNode< ICFGNode, ICFGEdge >
typedef ICFGNode	NodeType
typedef ICFGEdge	EdgeType
typedef OrderedSet< EdgeType *, typename EdgeType::equalGEdge >	GEdgeSetTy
	Edge kind.
typedef GEdgeSetTy::iterator	iterator
typedef GEdgeSetTy::const_iterator	const_iterator
Public Types inherited from SVF::SVFValue
enum	GNodeK {   IntraBlock , GlobalBlock , FunEntryBlock , FunExitBlock ,   FunCallBlock , FunRetBlock , ValNode , ArgValNode ,   FunValNode , GepValNode , RetValNode , VarargValNode ,   GlobalValNode , ConstDataValNode , BlackHoleValNode , ConstFPValNode ,   ConstIntValNode , ConstNullptrValNode , DummyValNode , IntrinsicValNode ,   AsmPCValNode , ObjNode , GepObjNode , BaseObjNode ,   FunObjNode , HeapObjNode , StackObjNode , GlobalObjNode ,   ConstDataObjNode , ConstFPObjNode , ConstIntObjNode , ConstNullptrObjNode ,   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 ,   BasicBlockKd , OtherKd }
Static Protected Member Functions inherited from SVF::SVFValue
static bool	isICFGNodeKinds (GNodeK n)
	Helper functions to check node kinds.
static bool	isInterICFGNodeKind (GNodeK n)
static bool	isSVFVarKind (GNodeK n)
static bool	isValVarKinds (GNodeK n)
static bool	isConstantDataValVar (GNodeK n)
static bool	isObjVarKinds (GNodeK n)
static bool	isBaseObjVarKinds (GNodeK n)
static bool	isConstantDataObjVarKinds (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::ICFGNode
const FunObjVar *	fun
const SVFBasicBlock *	bb
VFGNodeList	VFGNodes
SVFStmtList	pagEdges
Protected Attributes inherited from SVF::SVFValue
NodeID	id
	Node ID.
GNodeK	nodeKind
	Node kind.
const SVFType *	type
	SVF type.
std::string	name
std::string	sourceLoc
	Source code information of this value.

Detailed Description

Return ICFGNode containing (at most one) ActualRetVFGNode at a callsite

Definition at line 593 of file ICFGNode.h.

Constructor & Destructor Documentation

RetICFGNode()

SVF::RetICFGNode::RetICFGNode ( NodeID id, CallICFGNode * cb )

inline

Definition at line 609 of file ICFGNode.h.

                                             :
        InterICFGNode(id, FunRetBlock), actualRet(nullptr), callBlockNode(cb)
    {
        if (nullptr != cb)
        {
            fun = cb->getFun();
            bb = cb->getBB();
            type = cb->getType();
        }
    }

Member Function Documentation

addActualRet()

void SVF::RetICFGNode::addActualRet ( const SVFVar * ar )

inline

Add actual return parameter.

Definition at line 631 of file ICFGNode.h.

    {
        actualRet = ar;
    }

classof() [1/5]

bool SVF::RetICFGNode::classof ( const GenericICFGNodeTy * node )

inlinestatic

Definition at line 653 of file ICFGNode.h.

    {
        return node->getNodeKind() == FunRetBlock;
    }

classof() [2/5]

bool SVF::RetICFGNode::classof ( const ICFGNode * node )

inlinestatic

Definition at line 648 of file ICFGNode.h.

    {
        return node->getNodeKind() == FunRetBlock;
    }

classof() [3/5]

bool SVF::RetICFGNode::classof ( const InterICFGNode * node )

inlinestatic

Definition at line 643 of file ICFGNode.h.

    {
        return node->getNodeKind() == FunRetBlock;
    }

classof() [4/5]

bool SVF::RetICFGNode::classof ( const RetICFGNode * )

inlinestatic

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

Definition at line 638 of file ICFGNode.h.

    {
        return true;
    }

classof() [5/5]

bool SVF::RetICFGNode::classof ( const SVFValue * node )

inlinestatic

Definition at line 657 of file ICFGNode.h.

    {
        return node->getNodeKind() == FunRetBlock;
    }

getActualRet()

const SVFVar * SVF::RetICFGNode::getActualRet ( ) const

inline

Return actual return parameter.

Definition at line 625 of file ICFGNode.h.

    {
        return actualRet;
    }

getCallICFGNode()

const CallICFGNode * SVF::RetICFGNode::getCallICFGNode ( ) const

inline

Definition at line 620 of file ICFGNode.h.

    {
        return callBlockNode;
    }

getSourceLoc()

const std::string SVF::RetICFGNode::getSourceLoc ( ) const

inlineoverridevirtual

Reimplemented from SVF::SVFValue.

Definition at line 665 of file ICFGNode.h.

    {
        return "RetICFGNode: " + ICFGNode::getSourceLoc();
    }

setCallBlockNode()

void SVF::RetICFGNode::setCallBlockNode ( const CallICFGNode * cb )

inlineprotected

Add call block node from database for the new RetICFGNode [only used this function when loading from db results].

Definition at line 599 of file ICFGNode.h.

    {
        callBlockNode = cb;
    }

toString()

const std::string RetICFGNode::toString ( ) const

overridevirtual

Reimplemented from SVF::ICFGNode.

Definition at line 142 of file ICFG.cpp.

{
    std::string str;
    std::stringstream rawstr(str);
    rawstr << "RetICFGNode" << getId();
    rawstr << " {fun: " << getFun()->getName() << ICFGNode::getSourceLoc() << "}";
    for (const SVFStmt *stmt : getSVFStmts())
        rawstr << "\n" << stmt->toString();
    if(getSVFStmts().empty())
        rawstr << "\n" << valueOnlyToString();
    return rawstr.str();
}

Friends And Related Symbol Documentation

GraphDBClient

friend class GraphDBClient

friend

Definition at line 595 of file ICFGNode.h.

Member Data Documentation

actualRet

const SVFVar* SVF::RetICFGNode::actualRet

private

Definition at line 605 of file ICFGNode.h.

callBlockNode

const CallICFGNode* SVF::RetICFGNode::callBlockNode

private

Definition at line 606 of file ICFGNode.h.

---

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

• /home/runner/work/SVF/SVF/svf/include/Graphs/ICFGNode.h
• /home/runner/work/SVF/SVF/svf/lib/Graphs/ICFG.cpp