SVF::CallGraphNode Class Reference

#include <CallGraph.h>

Inheritance diagram for SVF::CallGraphNode:

Public Member Functions
	CallGraphNode (NodeID i, const FunObjVar *f)
	Constructor.
const std::string &	getName () const
const FunObjVar *	getFunction () const
	Get function of this call node.
bool	isReachableFromProgEntry (Map< NodeID, bool > &reachableFromEntry, NodeBS &visitedNodes) const
	Return TRUE if this function can be reached from main.
virtual const std::string	toString () const
Public Member Functions inherited from SVF::GenericNode< CallGraphNode, CallGraphEdge >
	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 void	setSourceLoc (const std::string &sourceCodeInfo)
virtual const std::string	getSourceLoc () const
const std::string	valueOnlyToString () const
const bool	hasLLVMValue () const

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

Private Attributes
const FunObjVar *	fun

Friends
OutStream &	operator<< (OutStream &o, const CallGraphNode &node)
	Overloading operator << for dumping ICFG node ID.

Additional Inherited Members
Public Types inherited from SVF::GenericNode< CallGraphNode, CallGraphEdge >
typedef CallGraphNode	NodeType
typedef CallGraphEdge	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::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

Definition at line 176 of file CallGraph.h.

Constructor & Destructor Documentation

CallGraphNode()

SVF::CallGraphNode::CallGraphNode ( NodeID i, const FunObjVar * f )

inline

Constructor.

Definition at line 183 of file CallGraph.h.

                                                : GenericPTACallGraphNodeTy(i,CallNodeKd), fun(f)
    {
 
    }

Member Function Documentation

classof() [1/3]

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

inlinestatic

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

Definition at line 213 of file CallGraph.h.

    {
        return true;
    }

classof() [2/3]

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

inlinestatic

Definition at line 218 of file CallGraph.h.

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

classof() [3/3]

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

inlinestatic

Definition at line 223 of file CallGraph.h.

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

getFunction()

const FunObjVar * SVF::CallGraphNode::getFunction ( ) const

inline

Get function of this call node.

Definition at line 191 of file CallGraph.h.

    {
        return fun;
    }

getName()

const std::string & CallGraphNode::getName ( ) const

virtual

Reimplemented from SVF::SVFValue.

Definition at line 47 of file CallGraph.cpp.

{
    return fun->getName();
}

isReachableFromProgEntry()

bool CallGraphNode::isReachableFromProgEntry	(	Map< NodeID, bool > &	reachableFromEntry,
		NodeBS &	visitedNodes ) const

Return TRUE if this function can be reached from main.

Definition at line 95 of file CallGraph.cpp.

{
    std::function<bool(const CallGraphNode*)> dfs =
        [&reachableFromEntry, &visitedNodes, &dfs](const CallGraphNode *v)
    {
        NodeID id = v->getId();
        if (!visitedNodes.test_and_set(id))
            return reachableFromEntry[id];
 
        if (SVFUtil::isProgEntryFunction(v->getFunction()))
            return reachableFromEntry[id] = true;
 
        bool result = false;
        for (const_iterator it = v->InEdgeBegin(), eit = v->InEdgeEnd(); it != eit; ++it)
        {
            CallGraphEdge* edge = *it;
            result |= dfs(edge->getSrcNode());
            if (result)
                break;
        }
        return reachableFromEntry[id] = result;
    };
 
    return dfs(this);
}

toString()

const std::string CallGraphNode::toString ( ) const

virtual

Definition at line 82 of file CallGraph.cpp.

{
    std::string str;
    std::stringstream  rawstr(str);
    rawstr << "CallGraphNode ID: " << getId() << " {fun: " << fun->getName() << "}";
    return rawstr.str();
}

Friends And Related Symbol Documentation

operator<<

OutStream & operator<< ( OutStream & o, const CallGraphNode & node )

friend

Overloading operator << for dumping ICFG node ID.

Definition at line 202 of file CallGraph.h.

    {
        o << node.toString();
        return o;
    }

Member Data Documentation

fun

const FunObjVar* SVF::CallGraphNode::fun

private

Definition at line 179 of file CallGraph.h.

---

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

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