#include <SVFVariables.h>

Inheritance diagram for SVF::SVFVar:

Public Types
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. More...

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 , GepValNode , RetNode , VarargNode , DummyValNode , ObjNode , GepObjNode , FIObjNode , 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 }

Public Member Functions
	SVFVar (const SVFValue *val, NodeID i, PNODEK k)
	Constructor. More...

virtual	~SVFVar ()
	Destructor. More...

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

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

bool	hasValue () const

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

bool	isConstDataOrAggDataButNotNullPtr () const

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

virtual const std::string	getValueName () const =0
	Get name of the LLVM value. More...

virtual const SVFFunction *	getFunction () const
	Return the function that this SVFVar resides in. Return nullptr if it is a global or constantexpr node. More...

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

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

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

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

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

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

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

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

virtual const std::string	toString () const

void	dump () const
	Dump to console for debugging. More...

Public Member Functions inherited from SVF::GenericNode< NodeTy, EdgeTy >
	GenericNode (NodeID i, GNodeK k)
	Constructor. More...

virtual	~GenericNode ()
	Destructor. More...

bool	hasIncomingEdge () const
	Has incoming/outgoing edge set. More...

bool	hasOutgoingEdge () const

iterator	OutEdgeBegin ()
	iterators More...

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. More...

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. More...

bool	addOutgoingEdge (EdgeType *outEdge)

EdgeType *	hasIncomingEdge (EdgeType *edge) const
	Find incoming and outgoing edges. More...

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. More...

GNodeK	getNodeKind () const
	Get node kind. More...

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 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 *)

Protected Member Functions
	SVFVar (NodeID i, PNODEK k)
	whether it is a pointer (top-level or address-taken) More...

Protected Attributes
const SVFValue *	value
	value of this SVFIR node More...

SVFStmt::KindToSVFStmtMapTy	InEdgeKindToSetMap

SVFStmt::KindToSVFStmtMapTy	OutEdgeKindToSetMap

bool	isPtr

Protected Attributes inherited from SVF::SVFBaseNode
NodeID	id
	Node ID. More...

GNodeK	nodeKind
	Node kind. More...

const SVFType *	type
	SVF type. More...

std::string	sourceLoc
	Source code information of this value. More...

Private Member Functions
void	addInEdge (SVFStmt *inEdge)
	add methods of the components More...

void	addOutEdge (SVFStmt *outEdge)

bool	hasIncomingVariantGepEdge () const
	Has incoming VariantGepEdges. More...

Friends
class	SVFIRWriter

class	SVFIRReader

class	IRGraph

class	SVFIR

class	VFG

OutStream &	operator<< (OutStream &o, const SVFVar &node)
	Overloading operator << for dumping SVFVar value. More...

Additional Inherited Members
Static Protected Member Functions inherited from SVF::SVFBaseNode
static bool	isICFGNodeKinds (GNodeK n)
	Helper functions to check node kinds. More...

static bool	isInterICFGNodeKind (GNodeK n)

static bool	isSVFVarKind (GNodeK n)

static bool	isValVarKinds (GNodeK n)

static bool	isObjVarKinds (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)

Detailed Description

Definition at line 45 of file SVFVariables.h.

Member Typedef Documentation

◆ GEdgeKind

typedef s64_t SVF::SVFVar::GEdgeKind

Definition at line 64 of file SVFVariables.h.

◆ PNODEK

typedef GNodeK SVF::SVFVar::PNODEK

Nine kinds of SVFIR variables ValNode: llvm pointer value ObjNode: memory object RetNode: unique return node Vararg: unique node for vararg parameter GepValNode: temporary gep value node for field sensitivity GepValNode: temporary gep obj node for field sensitivity FIObjNode: for field insensitive analysis DummyValNode and DummyObjNode: for non-llvm-value node

Definition at line 63 of file SVFVariables.h.

Constructor & Destructor Documentation

◆ SVFVar() [1/2]

SVF::SVFVar::SVFVar	(	NodeID	i,
		PNODEK	k
	)

inlineprotected

whether it is a pointer (top-level or address-taken)

Constructor to create an empty object (for deserialization)

Definition at line 73 of file SVFVariables.h.

73 : GenericPAGNodeTy(i, k), value{} {}

SVF::SVFVar::value

const SVFValue * value

value of this SVFIR node

Definition: SVFVariables.h:67

SVF::GenericPAGNodeTy

GenericNode< SVFVar, SVFStmt > GenericPAGNodeTy

Definition: SVFVariables.h:40

◆ SVFVar() [2/2]

SVFVar::SVFVar	(	const SVFValue *	val,
		NodeID	i,
		PNODEK	k
	)

Constructor.

SVFVar constructor

Definition at line 41 of file SVFVariables.cpp.

                                                       :
     GenericPAGNodeTy(i,k), value(val)
 {
     assert( ValNode <= k && k <= DummyObjNode && "new SVFIR node kind?");
     switch (k)
     {
     case ValNode:
     case GepValNode:
     {
         assert(val != nullptr && "value is nullptr for ValVar or GepValNode");
         isPtr = val->getType()->isPointerTy();
         break;
     }
     case RetNode:
     {
         assert(val != nullptr && "value is nullptr for RetNode");
         isPtr = SVFUtil::cast<SVFFunction>(val)->getReturnType()->isPointerTy();
         break;
     }
     case VarargNode:
     case DummyValNode:
     {
         isPtr = true;
         break;
     }
     case ObjNode:
     case GepObjNode:
     case FIObjNode:
     case DummyObjNode:
     {
         isPtr = true;
         if(val)
             isPtr = val->getType()->isPointerTy();
         break;
     }
     default:
         assert(false && "var not handled");
         break;
     }
 }

◆ ~SVFVar()

virtual SVF::SVFVar::~SVFVar ( )

inlinevirtual

Destructor.

Definition at line 79 of file SVFVariables.h.

79 {}

Member Function Documentation

◆ addInEdge()

void SVF::SVFVar::addInEdge ( SVFStmt * inEdge )

inlineprivate

add methods of the components

Definition at line 216 of file SVFVariables.h.

     {
         GEdgeKind kind = inEdge->getEdgeKind();
         InEdgeKindToSetMap[kind].insert(inEdge);
         addIncomingEdge(inEdge);
     }

◆ addOutEdge()

void SVF::SVFVar::addOutEdge ( SVFStmt * outEdge )

inlineprivate

Definition at line 223 of file SVFVariables.h.

     {
         GEdgeKind kind = outEdge->getEdgeKind();
         OutEdgeKindToSetMap[kind].insert(outEdge);
         addOutgoingEdge(outEdge);
     }

◆ classof() [1/3]

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

inlinestatic

Definition at line 203 of file SVFVariables.h.

     {
         return isSVFVarKind(node->getNodeKind());
     }

◆ classof() [2/3]

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

inlinestatic

Definition at line 208 of file SVFVariables.h.

     {
         return isSVFVarKind(node->getNodeKind());
     }

◆ classof() [3/3]

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

inlinestatic

Definition at line 198 of file SVFVariables.h.

     {
         return true;
     }

◆ dump()

void SVFVar::dump ( ) const

Dump to console for debugging.

Definition at line 103 of file SVFVariables.cpp.

 {
     outs() << this->toString() << "\n";
 }

◆ getFunction()

virtual const SVFFunction* SVF::SVFVar::getFunction ( ) const

inlinevirtual

Return the function that this SVFVar resides in. Return nullptr if it is a global or constantexpr node.

Definition at line 122 of file SVFVariables.h.

     {
         if (value)
         {
             if (auto inst = SVFUtil::dyn_cast<SVFInstruction>(value))
                 return inst->getParent()->getParent();
             else if (auto arg = SVFUtil::dyn_cast<SVFArgument>(value))
                 return arg->getParent();
             else if (auto fun = SVFUtil::dyn_cast<SVFFunction>(value))
                 return fun;
         }
         return nullptr;
     }

◆ getIncomingEdges()

SVFStmt::SVFStmtSetTy& SVF::SVFVar::getIncomingEdges ( SVFStmt::PEDGEK kind )

inline

Get incoming SVFIR statements (edges)

Definition at line 137 of file SVFVariables.h.

     {
         return InEdgeKindToSetMap[kind];
     }

◆ getIncomingEdgesBegin()

SVFStmt::SVFStmtSetTy::iterator SVF::SVFVar::getIncomingEdgesBegin ( SVFStmt::PEDGEK kind ) const

inline

Get incoming SVFStmt iterator.

Definition at line 166 of file SVFVariables.h.

     {
         SVFStmt::KindToSVFStmtMapTy::const_iterator it = InEdgeKindToSetMap.find(kind);
         assert(it!=InEdgeKindToSetMap.end() && "The node does not have such kind of edge");
         return it->second.begin();
     }

◆ getIncomingEdgesEnd()

SVFStmt::SVFStmtSetTy::iterator SVF::SVFVar::getIncomingEdgesEnd ( SVFStmt::PEDGEK kind ) const

inline

Get incoming SVFStmt iterator.

Definition at line 174 of file SVFVariables.h.

     {
         SVFStmt::KindToSVFStmtMapTy::const_iterator it = InEdgeKindToSetMap.find(kind);
         assert(it!=InEdgeKindToSetMap.end() && "The node does not have such kind of edge");
         return it->second.end();
     }

◆ getOutgoingEdges()

SVFStmt::SVFStmtSetTy& SVF::SVFVar::getOutgoingEdges ( SVFStmt::PEDGEK kind )

inline

Get outgoing SVFIR statements (edges)

Definition at line 142 of file SVFVariables.h.

     {
         return OutEdgeKindToSetMap[kind];
     }

◆ getOutgoingEdgesBegin()

SVFStmt::SVFStmtSetTy::iterator SVF::SVFVar::getOutgoingEdgesBegin ( SVFStmt::PEDGEK kind ) const

inline

Get outgoing SVFStmt iterator.

Definition at line 182 of file SVFVariables.h.

     {
         SVFStmt::KindToSVFStmtMapTy::const_iterator it = OutEdgeKindToSetMap.find(kind);
         assert(it!=OutEdgeKindToSetMap.end() && "The node does not have such kind of edge");
         return it->second.begin();
     }

◆ getOutgoingEdgesEnd()

SVFStmt::SVFStmtSetTy::iterator SVF::SVFVar::getOutgoingEdgesEnd ( SVFStmt::PEDGEK kind ) const

inline

Get outgoing SVFStmt iterator.

Definition at line 190 of file SVFVariables.h.

     {
         SVFStmt::KindToSVFStmtMapTy::const_iterator it = OutEdgeKindToSetMap.find(kind);
         assert(it!=OutEdgeKindToSetMap.end() && "The node does not have such kind of edge");
         return it->second.end();
     }

◆ getType()

virtual const SVFType* SVF::SVFVar::getType ( ) const

inlinevirtual

Return type of the value.

Reimplemented from SVF::SVFBaseNode.

Reimplemented in SVF::GepObjVar, SVF::GepValVar, and SVF::ObjVar.

Definition at line 96 of file SVFVariables.h.

     {
         return value ? value->getType() : nullptr;
     }

◆ getValue()

const SVFValue* SVF::SVFVar::getValue ( ) const

inline

Get/has methods of the components.

Definition at line 83 of file SVFVariables.h.

     {
         assert(this->getNodeKind() != DummyValNode &&
                this->getNodeKind() != DummyObjNode &&
                "dummy node do not have value!");
         assert(!SymbolTableInfo::isBlkObjOrConstantObj(this->getId()) &&
                "blackhole and constant obj do not have value");
         assert(value &&
                "value is null (GepObjNode whose basenode is a DummyObj?)");
         return value;
     }

◆ getValueName()

virtual const std::string SVF::SVFVar::getValueName ( ) const

pure virtual

Get name of the LLVM value.

Implemented in SVF::DummyObjVar, SVF::DummyValVar, SVF::VarArgPN, SVF::RetPN, SVF::FIObjVar, SVF::GepObjVar, SVF::GepValVar, SVF::ObjVar, and SVF::ValVar.

◆ hasIncomingEdges()

bool SVF::SVFVar::hasIncomingEdges ( SVFStmt::PEDGEK kind ) const

inline

Has incoming SVFIR statements (edges)

Definition at line 147 of file SVFVariables.h.

     {
         SVFStmt::KindToSVFStmtMapTy::const_iterator it = InEdgeKindToSetMap.find(kind);
         if (it != InEdgeKindToSetMap.end())
             return (!it->second.empty());
         else
             return false;
     }

◆ hasIncomingVariantGepEdge()

bool SVF::SVFVar::hasIncomingVariantGepEdge ( ) const

inlineprivate

Has incoming VariantGepEdges.

Definition at line 230 of file SVFVariables.h.

     {
         SVFStmt::KindToSVFStmtMapTy::const_iterator it = InEdgeKindToSetMap.find(SVFStmt::Gep);
         if (it != InEdgeKindToSetMap.end())
         {
             for(auto gep : it->second)
             {
                 if(SVFUtil::cast<GepStmt>(gep)->isVariantFieldGep())
                     return true;
             }
         }
         return false;
     }

◆ hasOutgoingEdges()

bool SVF::SVFVar::hasOutgoingEdges ( SVFStmt::PEDGEK kind ) const

inline

Has outgoing SVFIR statements (edges)

Definition at line 156 of file SVFVariables.h.

     {
         SVFStmt::KindToSVFStmtMapTy::const_iterator it = OutEdgeKindToSetMap.find(kind);
         if (it != OutEdgeKindToSetMap.end())
             return (!it->second.empty());
         else
             return false;
     }

◆ hasValue()

bool SVF::SVFVar::hasValue ( ) const

inline

Definition at line 101 of file SVFVariables.h.

     {
         return value != nullptr;
     }

◆ isConstDataOrAggDataButNotNullPtr()

bool SVFVar::isConstDataOrAggDataButNotNullPtr ( ) const

Whether it is constant data, i.e., "0", "1.001", "str" or llvm's metadata, i.e., metadata !4087

Definition at line 207 of file SVFVariables.cpp.

 {
     if (hasValue())
         return value->isConstDataOrAggData() && (!SVFUtil::isa<SVFConstantNullPtr>(value)) && (!SVFUtil::isa<SVFBlackHoleValue>(value));
     else
         return false;
 }

◆ isIsolatedNode()

bool SVFVar::isIsolatedNode ( ) const

Whether this is an isolated node on the SVFIR graph.

Definition at line 82 of file SVFVariables.cpp.

 {
     if (getInEdges().empty() && getOutEdges().empty())
         return true;
     else if (isConstDataOrAggDataButNotNullPtr())
         return true;
     else if (value && SVFUtil::isa<SVFFunction>(value))
         return SVFUtil::cast<SVFFunction>(value)->isIntrinsic();
     else
         return false;
 }

◆ isPointer()

virtual bool SVF::SVFVar::isPointer ( ) const

inlinevirtual

Whether it is a pointer.

Definition at line 106 of file SVFVariables.h.

     {
         return isPtr;
     }

◆ toString()

const std::string SVFVar::toString ( ) const

virtual

Reimplemented in SVF::DummyObjVar, SVF::DummyValVar, SVF::VarArgPN, SVF::RetPN, SVF::FIObjVar, SVF::GepObjVar, SVF::GepValVar, SVF::ObjVar, and SVF::ValVar.

Definition at line 95 of file SVFVariables.cpp.

 {
     std::string str;
     std::stringstream rawstr(str);
     rawstr << "SVFVar ID: " << getId();
     return rawstr.str();
 }

Friends And Related Function Documentation

◆ IRGraph

friend class IRGraph

friend

Definition at line 49 of file SVFVariables.h.

◆ operator<<

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

friend

Overloading operator << for dumping SVFVar value.

Definition at line 253 of file SVFVariables.h.

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

◆ SVFIR

friend class SVFIR

friend

Definition at line 50 of file SVFVariables.h.

◆ SVFIRReader

friend class SVFIRReader

friend

Definition at line 48 of file SVFVariables.h.

◆ SVFIRWriter

friend class SVFIRWriter

friend

Definition at line 47 of file SVFVariables.h.

◆ VFG

friend class VFG

friend

Definition at line 51 of file SVFVariables.h.

Member Data Documentation

◆ InEdgeKindToSetMap

SVFStmt::KindToSVFStmtMapTy SVF::SVFVar::InEdgeKindToSetMap

protected

Definition at line 68 of file SVFVariables.h.

◆ isPtr

bool SVF::SVFVar::isPtr

protected

Definition at line 70 of file SVFVariables.h.

◆ OutEdgeKindToSetMap

SVFStmt::KindToSVFStmtMapTy SVF::SVFVar::OutEdgeKindToSetMap

protected

Definition at line 69 of file SVFVariables.h.

◆ value

const SVFValue* SVF::SVFVar::value

protected

value of this SVFIR node

Definition at line 67 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 Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ GEdgeKind

◆ PNODEK

Constructor & Destructor Documentation

◆ SVFVar() [1/2]

◆ SVFVar() [2/2]

◆ ~SVFVar()

Member Function Documentation

◆ addInEdge()

◆ addOutEdge()

◆ classof() [1/3]

◆ classof() [2/3]

◆ classof() [3/3]

◆ dump()

◆ getFunction()

◆ getIncomingEdges()

◆ getIncomingEdgesBegin()

◆ getIncomingEdgesEnd()

◆ getOutgoingEdges()

◆ getOutgoingEdgesBegin()

◆ getOutgoingEdgesEnd()

◆ getType()

◆ getValue()

◆ getValueName()

◆ hasIncomingEdges()

◆ hasIncomingVariantGepEdge()

◆ hasOutgoingEdges()

◆ hasValue()

◆ isConstDataOrAggDataButNotNullPtr()

◆ isIsolatedNode()

◆ isPointer()

◆ toString()

Friends And Related Function Documentation

◆ IRGraph

◆ operator<<

◆ SVFIR

◆ SVFIRReader

◆ SVFIRWriter

◆ VFG

Member Data Documentation

◆ InEdgeKindToSetMap

◆ isPtr

◆ OutEdgeKindToSetMap

◆ value