#include <VFGNode.h>

Inheritance diagram for SVF::FormalRetVFGNode:

Public Member Functions
	FormalRetVFGNode (NodeID id, const PAGNode n, const FunObjVar f)
	Constructor.

const PAGNode *	getRet () const
	Return value at callee.

const FunObjVar *	getFun () const override
	Function.

void	addRetPE (const RetPE *retPE)
	RetPE.

RetPESet::const_iterator	retPEBegin () const
	RetPE iterators.

RetPESet::const_iterator	retPEEnd () const

const NodeBS	getDefSVFVars () const override
	Return the left hand side SVF Vars.

const std::string	toString () const override

Public Member Functions inherited from SVF::ArgumentVFGNode
	ArgumentVFGNode (NodeID id, const PAGNode *p, VFGNodeK k)
	Constructor.

bool	isPTANode () const
	Whether this argument node is of pointer type (used for pointer analysis).

const SVFVar *	getValue () const override
	Return the corresponding LLVM value, if possible, nullptr otherwise.

Public Member Functions inherited from SVF::VFGNode
	VFGNode (NodeID i, VFGNodeK k)
	Constructor.

virtual const ICFGNode *	getICFGNode () const
	Return corresponding ICFG node.

virtual void	setICFGNode (const ICFGNode *node)
	Set corresponding ICFG node.

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)

virtual const std::string	getSourceLoc () const

const std::string	valueOnlyToString () const

Static Public Member Functions
static bool	classof (const FormalRetVFGNode)
	Methods for support type inquiry through isa, cast, and dyn_cast:

static bool	classof (const VFGNode *node)

static bool	classof (const ArgumentVFGNode *node)

static bool	classof (const GenericVFGNodeTy *node)

static bool	classof (const SVFValue *node)

Static Public Member Functions inherited from SVF::ArgumentVFGNode
static bool	classof (const ArgumentVFGNode *)
	Methods for support type inquiry through isa, cast, and dyn_cast:

static bool	classof (const VFGNode *node)

static bool	classof (const GenericVFGNodeTy *node)

static bool	classof (const SVFValue *node)

Static Public Member Functions inherited from SVF::VFGNode
static bool	classof (const VFGNode *)

static bool	classof (const GenericVFGNodeTy *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
	FormalRetVFGNode ()
	place holder

	FormalRetVFGNode (const FormalRetVFGNode &)
	place holder

void	operator= (const FormalRetVFGNode &)
	place holder

Private Attributes
const FunObjVar *	fun

RetPESet	retPEs

Additional Inherited Members
Public Types inherited from SVF::VFGNode
typedef GNodeK	VFGNodeK

typedef VFGEdge::VFGEdgeSetTy::iterator	iterator

typedef VFGEdge::VFGEdgeSetTy::const_iterator	const_iterator

typedef Set< const CallPE * >	CallPESet

typedef Set< const RetPE * >	RetPESet

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::ArgumentVFGNode
const PAGNode *	param

Protected Attributes inherited from SVF::VFGNode
const ICFGNode *	icfgNode

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

Callee return ICFG node

Definition at line 1082 of file VFGNode.h.

Constructor & Destructor Documentation

◆ FormalRetVFGNode() [1/3]

SVF::FormalRetVFGNode::FormalRetVFGNode ( )

private

place holder

◆ FormalRetVFGNode() [2/3]

SVF::FormalRetVFGNode::FormalRetVFGNode ( const FormalRetVFGNode & )

private

place holder

◆ FormalRetVFGNode() [3/3]

FormalRetVFGNode::FormalRetVFGNode	(	NodeID	id,
		const PAGNode *	n,
		const FunObjVar *	f
	)

Constructor.

Definition at line 407 of file VFG.cpp.

                                                                                  :
    ArgumentVFGNode(id, n, FRet), fun(f)
{
}

Member Function Documentation

◆ addRetPE()

void SVF::FormalRetVFGNode::addRetPE ( const RetPE * retPE )

inline

RetPE.

Definition at line 1107 of file VFGNode.h.

    {
        retPEs.insert(retPE);
    }

◆ classof() [1/5]

static bool SVF::FormalRetVFGNode::classof ( const ArgumentVFGNode * node )

inlinestatic

Definition at line 1130 of file VFGNode.h.

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

◆ classof() [2/5]

static bool SVF::FormalRetVFGNode::classof ( const FormalRetVFGNode )

inlinestatic

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

Definition at line 1122 of file VFGNode.h.

    {
        return true;
    }

◆ classof() [3/5]

static bool SVF::FormalRetVFGNode::classof ( const GenericVFGNodeTy * node )

inlinestatic

Definition at line 1134 of file VFGNode.h.

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

◆ classof() [4/5]

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

inlinestatic

Definition at line 1138 of file VFGNode.h.

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

◆ classof() [5/5]

static bool SVF::FormalRetVFGNode::classof ( const VFGNode * node )

inlinestatic

Definition at line 1126 of file VFGNode.h.

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

◆ getDefSVFVars()

const NodeBS FormalRetVFGNode::getDefSVFVars ( ) const

overridevirtual

Return the left hand side SVF Vars.

Implements SVF::VFGNode.

Definition at line 317 of file VFG.cpp.

{
    NodeBS nb;
    nb.set(getRet()->getId());
    return nb;
}

◆ getFun()

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

inlineoverridevirtual

Function.

Reimplemented from SVF::VFGNode.

Definition at line 1102 of file VFGNode.h.

    {
        return fun;
    }

◆ getRet()

const PAGNode * SVF::FormalRetVFGNode::getRet ( ) const

inline

Return value at callee.

Definition at line 1097 of file VFGNode.h.

    {
        return param;
    }

◆ operator=()

void SVF::FormalRetVFGNode::operator= ( const FormalRetVFGNode & )

private

place holder

◆ retPEBegin()

RetPESet::const_iterator SVF::FormalRetVFGNode::retPEBegin ( ) const

inline

RetPE iterators.

Definition at line 1112 of file VFGNode.h.

    {
        return retPEs.begin();
    }

◆ retPEEnd()

RetPESet::const_iterator SVF::FormalRetVFGNode::retPEEnd ( ) const

inline

Definition at line 1116 of file VFGNode.h.

    {
        return retPEs.end();
    }

◆ toString()

const std::string FormalRetVFGNode::toString ( ) const

overridevirtual

Reimplemented from SVF::ArgumentVFGNode.

Definition at line 324 of file VFG.cpp.

{
    std::string str;
    std::stringstream rawstr(str);
    rawstr << "FormalRetVFGNode ID: " << getId() << " ";
    rawstr << "Fun[" << getFun()->getName() << "]";
    rawstr << param->toString();
    return rawstr.str();
}

Member Data Documentation

◆ fun

const FunObjVar* SVF::FormalRetVFGNode::fun

private

Definition at line 1085 of file VFGNode.h.

◆ retPEs

RetPESet SVF::FormalRetVFGNode::retPEs

private

Definition at line 1086 of file VFGNode.h.

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

/home/runner/work/SVF/SVF/svf/include/Graphs/VFGNode.h
/home/runner/work/SVF/SVF/svf/lib/Graphs/VFG.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FormalRetVFGNode() [1/3]

◆ FormalRetVFGNode() [2/3]

◆ FormalRetVFGNode() [3/3]

Member Function Documentation

◆ addRetPE()

◆ classof() [1/5]

◆ classof() [2/5]

◆ classof() [3/5]

◆ classof() [4/5]

◆ classof() [5/5]

◆ getDefSVFVars()

◆ getFun()

◆ getRet()

◆ operator=()

◆ retPEBegin()

◆ retPEEnd()

◆ toString()

Member Data Documentation

◆ fun

◆ retPEs