#include <SVFVariables.h>

Inheritance diagram for SVF::RetPN:

Public Member Functions
	RetPN (NodeID i, const CallGraphNode *node)
	Constructor.

const CallGraphNode *	getCallGraphNode () const

virtual const SVFFunction *	getFunction () const

const std::string	getValueName () const
	Return name of a LLVM value.

virtual const std::string	toString () const

Public Member Functions inherited from SVF::ValVar
	ValVar (const SVFValue val, NodeID i, PNODEK ty=ValNode, const ICFGNode node=nullptr)
	Constructor.

const std::string	getValueName () const
	Return name of a LLVM value.

const ICFGNode *	getICFGNode () const

Public Member Functions inherited from SVF::SVFVar
	SVFVar (const SVFValue *val, NodeID i, PNODEK k)
	Constructor.

virtual	~SVFVar ()
	Destructor.

const SVFValue *	getValue () const
	Get/has methods of the components.

virtual const SVFType *	getType () const
	Return type of the value.

bool	hasValue () const

virtual bool	isPointer () const
	Whether it is a pointer.

virtual bool	isConstDataOrAggDataButNotNullPtr () const

virtual bool	isIsolatedNode () const
	Whether this is an isolated node on the SVFIR graph.

SVFStmt::SVFStmtSetTy &	getIncomingEdges (SVFStmt::PEDGEK kind)
	Get incoming SVFIR statements (edges)

SVFStmt::SVFStmtSetTy &	getOutgoingEdges (SVFStmt::PEDGEK kind)
	Get outgoing SVFIR statements (edges)

bool	hasIncomingEdges (SVFStmt::PEDGEK kind) const
	Has incoming SVFIR statements (edges)

bool	hasOutgoingEdges (SVFStmt::PEDGEK kind) const
	Has outgoing SVFIR statements (edges)

SVFStmt::SVFStmtSetTy::iterator	getIncomingEdgesBegin (SVFStmt::PEDGEK kind) const
	Get incoming SVFStmt iterator.

SVFStmt::SVFStmtSetTy::iterator	getIncomingEdgesEnd (SVFStmt::PEDGEK kind) const
	Get incoming SVFStmt iterator.

SVFStmt::SVFStmtSetTy::iterator	getOutgoingEdgesBegin (SVFStmt::PEDGEK kind) const
	Get outgoing SVFStmt iterator.

SVFStmt::SVFStmtSetTy::iterator	getOutgoingEdgesEnd (SVFStmt::PEDGEK kind) const
	Get outgoing SVFStmt iterator.

virtual bool	ptrInUncalledFunction () const

virtual bool	isConstDataOrAggData () const

void	dump () const
	Dump to console for debugging.

Public Member Functions inherited from SVF::GenericNode< NodeTy, EdgeTy >
	GenericNode (NodeID i, GNodeK k)
	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::SVFBaseNode
	SVFBaseNode (NodeID i, GNodeK k, SVFType *ty=nullptr)

NodeID	getId () const
	Get ID.

GNodeK	getNodeKind () const
	Get node kind.

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 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:

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)

Private Attributes
const CallGraphNode *	callGraphNode

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.

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 , ArgNode , FunValNode , GepValNode , RetNode , VarargNode , GlobalValNode , ConstantAggValNode , ConstantDataValNode , BlackHoleNode , ConstantFPValNode , ConstantIntValNode , ConstantNullptrValNode , DummyValNode , ObjNode , GepObjNode , BaseObjNode , FunObjNode , HeapObjNode , StackObjNode , GlobalObjNode , ConstantAggObjNode , ConstantDataObjNode , ConstantFPObjNode , ConstantIntObjNode , ConstantNullptrObjNode , 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)

Protected Member Functions inherited from SVF::SVFVar
	SVFVar (NodeID i, PNODEK k)
	function containing this variable

Static Protected Member Functions inherited from SVF::SVFBaseNode
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::SVFVar
const SVFValue *	value
	value of this SVFIR node

SVFStmt::KindToSVFStmtMapTy	InEdgeKindToSetMap

SVFStmt::KindToSVFStmtMapTy	OutEdgeKindToSetMap

bool	isPtr

const SVFFunction *	func
	whether it is a pointer (top-level or address-taken)

Protected Attributes inherited from SVF::SVFBaseNode
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 1820 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 1829 of file SVFVariables.h.

1829: ValVar(i, RetNode) {}

SVF::SVFBaseNode::RetNode

@ RetNode

Definition GenericGraph.h:160

SVF::ValVar::ValVar

ValVar(NodeID i, PNODEK ty=ValNode)

Constructor to create an empty ValVar (for SVFIRReader/deserialization)

Definition SVFVariables.h:305

SVF::IRBuilder

llvm::IRBuilder IRBuilder

Definition BasicTypes.h:74

◆ RetPN() [2/2]

RetPN::RetPN	(	NodeID	i,
		const CallGraphNode *	node
	)

Constructor.

Definition at line 205 of file SVFVariables.cpp.

                                                : ValVar(i, RetNode), callGraphNode(node)
{
    isPtr = node->getFunction()->getReturnType()->isPointerTy();
}

Member Function Documentation

◆ classof() [1/5]

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

inlinestatic

Definition at line 1845 of file SVFVariables.h.

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

◆ classof() [2/5]

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

inlinestatic

Definition at line 1833 of file SVFVariables.h.

    {
        return true;
    }

◆ classof() [3/5]

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

inlinestatic

Definition at line 1849 of file SVFVariables.h.

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

◆ classof() [4/5]

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

inlinestatic

Definition at line 1837 of file SVFVariables.h.

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

◆ classof() [5/5]

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

inlinestatic

Definition at line 1841 of file SVFVariables.h.

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

◆ getCallGraphNode()

const CallGraphNode * SVF::RetPN::getCallGraphNode ( ) const

inline

Definition at line 1859 of file SVFVariables.h.

    {
        return callGraphNode;
    }

◆ getFunction()

const SVFFunction * RetPN::getFunction ( ) const

virtual

Return the function containing this SVFVar

Returns: The SVFFunction containing this variable, or nullptr if it's a global/constant expression

Reimplemented from SVF::SVFVar.

Definition at line 210 of file SVFVariables.cpp.

{
    return callGraphNode->getFunction();
}

◆ getValueName()

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

virtual

Return name of a LLVM value.

Implements SVF::SVFVar.

Definition at line 215 of file SVFVariables.cpp.

{
    return callGraphNode->getName() + "_ret";
}

◆ toString()

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

virtual

Reimplemented from SVF::ValVar.

Definition at line 477 of file SVFVariables.cpp.

{
    std::string str;
    std::stringstream rawstr(str);
    rawstr << "RetPN ID: " << getId() << " unique return node for function " << callGraphNode->getName();
    return rawstr.str();
}

Friends And Related Symbol Documentation

◆ SVFIRReader

friend class SVFIRReader

friend

Definition at line 1823 of file SVFVariables.h.

◆ SVFIRWriter

friend class SVFIRWriter

friend

Definition at line 1822 of file SVFVariables.h.

Member Data Documentation

◆ callGraphNode

const CallGraphNode* SVF::RetPN::callGraphNode

private

Definition at line 1826 of file SVFVariables.h.

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

/home/runner/work/SVF/SVF/svf/include/SVFIR/SVFVariables.h
/home/runner/work/SVF/SVF/svf/lib/SVFIR/SVFVariables.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RetPN() [1/2]

◆ RetPN() [2/2]

Member Function Documentation

◆ classof() [1/5]

◆ classof() [2/5]

◆ classof() [3/5]

◆ classof() [4/5]

◆ classof() [5/5]

◆ getCallGraphNode()

◆ getFunction()

◆ getValueName()

◆ toString()

Friends And Related Symbol Documentation

◆ SVFIRReader

◆ SVFIRWriter

Member Data Documentation

◆ callGraphNode