SVF::FunExitICFGNode Class Reference

#include <ICFGNode.h>

Inheritance diagram for SVF::FunExitICFGNode:

Public Member Functions
	FunExitICFGNode (NodeID id, const FunObjVar *f)
const FunObjVar *	getFun () const override
	Return function.
const SVFVar *	getFormalRet () const
	Return formal return parameter.
void	addFormalRet (const SVFVar *fr)
	Add formal 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 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< NodeTy, EdgeTy >
	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

Static Public Member Functions
static bool	classof (const FunEntryICFGNode *)
	Methods for support type inquiry through isa, cast, and dyn_cast:
static bool	classof (const ICFGNode *node)
static bool	classof (const InterICFGNode *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< NodeTy, EdgeTy >
static bool	classof (const GenericNode< NodeTy, EdgeTy > *)
static bool	classof (const SVFValue *)

Private Member Functions
	FunExitICFGNode (NodeID id)
	Constructor to create empty FunExitICFGNode (for SVFIRReader/deserialization)

Private Attributes
const SVFVar *	formalRet

Friends
class	SVFIRWriter
class	SVFIRReader

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< NodeTy, EdgeTy >
typedef NodeTy	NodeType
typedef EdgeTy	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 , ConstAggValNode , ConstDataValNode , BlackHoleValNode ,   ConstFPValNode , ConstIntValNode , ConstNullptrValNode , DummyValNode ,   ObjNode , GepObjNode , BaseObjNode , FunObjNode ,   HeapObjNode , StackObjNode , GlobalObjNode , ConstAggObjNode ,   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 ,   DCHNodeKd , 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

Function exit ICFGNode containing (at most one) FormalRetVFGNodes of a function

Definition at line 348 of file ICFGNode.h.

Constructor & Destructor Documentation

FunExitICFGNode() [1/2]

SVF::FunExitICFGNode::FunExitICFGNode ( NodeID  id )

inlineprivate

Constructor to create empty FunExitICFGNode (for SVFIRReader/deserialization)

Definition at line 357 of file ICFGNode.h.

: InterICFGNode(id, FunExitBlock), formalRet{} {}

FunExitICFGNode() [2/2]

FunExitICFGNode::FunExitICFGNode	(	NodeID	id,
		const FunObjVar *	f
	)

Definition at line 49 of file ICFG.cpp.

    : InterICFGNode(id, FunExitBlock), formalRet(nullptr)
{
    fun = f;
    // if function is implemented
    if (f->begin() != f->end())
    {
        bb = f->getExitBB();
    }
}

Member Function Documentation

addFormalRet()

void SVF::FunExitICFGNode::addFormalRet ( const SVFVar *  fr )

inline

Add formal return parameter.

Definition at line 375 of file ICFGNode.h.

    {
        formalRet = fr;
    }

classof() [1/5]

static bool SVF::FunExitICFGNode::classof ( const FunEntryICFGNode *  )

inlinestatic

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

Definition at line 382 of file ICFGNode.h.

    {
        return true;
    }

classof() [2/5]

static bool SVF::FunExitICFGNode::classof ( const GenericICFGNodeTy *  node )

inlinestatic

Definition at line 397 of file ICFGNode.h.

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

classof() [3/5]

static bool SVF::FunExitICFGNode::classof ( const ICFGNode *  node )

inlinestatic

Definition at line 387 of file ICFGNode.h.

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

classof() [4/5]

static bool SVF::FunExitICFGNode::classof ( const InterICFGNode *  node )

inlinestatic

Definition at line 392 of file ICFGNode.h.

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

classof() [5/5]

static bool SVF::FunExitICFGNode::classof ( const SVFValue *  node )

inlinestatic

Definition at line 402 of file ICFGNode.h.

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

getFormalRet()

const SVFVar * SVF::FunExitICFGNode::getFormalRet ( ) const

inline

Return formal return parameter.

Definition at line 369 of file ICFGNode.h.

    {
        return formalRet;
    }

getFun()

const FunObjVar * SVF::FunExitICFGNode::getFun ( ) const

inlineoverridevirtual

Return function.

Reimplemented from SVF::ICFGNode.

Definition at line 363 of file ICFGNode.h.

    {
        return fun;
    }

getSourceLoc()

const std::string FunExitICFGNode::getSourceLoc ( ) const

overridevirtual

Reimplemented from SVF::SVFValue.

Definition at line 134 of file ICFG.cpp.

{
    return "function ret: " + fun->getSourceLoc();
}

toString()

const std::string FunExitICFGNode::toString ( ) const

overridevirtual

Reimplemented from SVF::ICFGNode.

Definition at line 117 of file ICFG.cpp.

{
    const FunObjVar *fun = getFun();
    std::string str;
    std::stringstream rawstr(str);
    rawstr << "FunExitICFGNode" << getId();
    rawstr << " {fun: " << fun->getName();
    // ensure the enclosing function has exit basic block
    if (!isExtCall(fun) && fun->hasReturn())
        if(const IntraICFGNode* intraICFGNode = dyn_cast<IntraICFGNode>(fun->getExitBB()->front()))
            rawstr << intraICFGNode->getSourceLoc();
    rawstr << "}";
    for (const SVFStmt *stmt : getSVFStmts())
        rawstr << "\n" << stmt->toString();
    return rawstr.str();
}

Friends And Related Symbol Documentation

SVFIRReader

friend class SVFIRReader

friend

Definition at line 351 of file ICFGNode.h.

SVFIRWriter

friend class SVFIRWriter

friend

Definition at line 350 of file ICFGNode.h.

Member Data Documentation

formalRet

const SVFVar* SVF::FunExitICFGNode::formalRet

private

Definition at line 354 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