#include <PAGNode.h>

Inheritance diagram for SVF::PAGNode:

Public Types
enum	PNODEK { ValNode, ObjNode, RetNode, VarargNode, GepValNode, GepObjNode, FIObjNode, DummyValNode, DummyObjNode, CloneGepObjNode, CloneFIObjNode, CloneDummyObjNode }

Public Types inherited from SVF::GenericNode< NodeTy, EdgeTy >
typedef NodeTy	NodeType

typedef EdgeTy	EdgeType

typedef s32_t	GNodeK
	Edge kind. More...

typedef OrderedSet< EdgeType *, typename EdgeType::equalGEdge >	GEdgeSetTy

typedef GEdgeSetTy::iterator	iterator

typedef GEdgeSetTy::const_iterator	const_iterator

Public Member Functions
	PAGNode (const Value *val, NodeID i, PNODEK k)
	address-taken pointer More...

virtual	~PAGNode ()
	Destructor. More...


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

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

bool	hasValue () const

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

bool	isTopLevelPtr () const
	Whether it is a top-level pointer. More...

bool	isAddressTakenPtr () const
	Whether it is an address-taken pointer. More...

bool	isConstantData () const

bool	isIsolatedNode () const
	Whether this is an isoloated node on the PAG graph. More...

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

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

PAGEdge::PAGEdgeSetTy &	getIncomingEdges (PAGEdge::PEDGEK kind)
	Get incoming PAG edges. More...

PAGEdge::PAGEdgeSetTy &	getOutgoingEdges (PAGEdge::PEDGEK kind)
	Get outgoing PAG edges. More...

bool	hasIncomingEdges (PAGEdge::PEDGEK kind) const
	Has incoming PAG edges. More...

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

PAGEdge::PAGEdgeSetTy::iterator	getIncomingEdgesBegin (PAGEdge::PEDGEK kind) const
	Get incoming PAGEdge iterator. More...

PAGEdge::PAGEdgeSetTy::iterator	getIncomingEdgesEnd (PAGEdge::PEDGEK kind) const
	Get incoming PAGEdge iterator. More...

bool	hasOutgoingEdges (PAGEdge::PEDGEK kind) const
	Has outgoing PAG edges. More...

PAGEdge::PAGEdgeSetTy::iterator	getOutgoingEdgesBegin (PAGEdge::PEDGEK kind) const
	Get outgoing PAGEdge iterator. More...

PAGEdge::PAGEdgeSetTy::iterator	getOutgoingEdgesEnd (PAGEdge::PEDGEK kind) const
	Get outgoing PAGEdge iterator. More...


void	addInEdge (PAGEdge *inEdge)
	add methods of the components More...

void	addOutEdge (PAGEdge *outEdge)

virtual const std::string	toString () const

virtual const std::string	getNodeAttrForDotDisplay () const
	Get shape and/or color of node for .dot display. More...

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

NodeID	getId () const
	Get ID. More...

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

const GEdgeSetTy &	getOutEdges () const

const GEdgeSetTy &	getInEdges () const

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 necessory. 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)

Size_t	removeIncomingEdge (EdgeType *edge)

Size_t	removeOutgoingEdge (EdgeType *edge)

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

EdgeType *	hasOutgoingEdge (EdgeType *edge) const

Protected Attributes
const Value *	value
	value of this PAG node More...

PAGEdge::PAGKindToEdgeSetMapTy	InEdgeKindToSetMap

PAGEdge::PAGKindToEdgeSetMapTy	OutEdgeKindToSetMap

bool	isTLPointer

bool	isATPointer
	top-level pointer More...

Friends

raw_ostream &	operator<< (raw_ostream &o, const PAGNode &node)
	Overloading operator << for dumping PAGNode value. More...

Detailed Description

Definition at line 45 of file PAGNode.h.

Member Enumeration Documentation

◆ PNODEK

enum SVF::PAGNode::PNODEK

Nine kinds of PAG nodes ValNode: llvm pointer value ObjNode: memory object RetNode: unique return node Vararg: unique node for vararg parameter GepValNode: tempory gep value node for field sensitivity GepValNode: tempory gep obj node for field sensitivity FIObjNode: for field insensitive analysis DummyValNode and DummyObjNode: for non-llvm-value node Clone*Node: objects created by TBHC.

Enumerator
ValNode
ObjNode
RetNode
VarargNode
GepValNode
GepObjNode
FIObjNode
DummyValNode
DummyObjNode
CloneGepObjNode
CloneFIObjNode
CloneDummyObjNode

Definition at line 59 of file PAGNode.h.

     {
         ValNode,
         ObjNode,
         RetNode,
         VarargNode,
         GepValNode,
         GepObjNode,
         FIObjNode,
         DummyValNode,
         DummyObjNode,
         CloneGepObjNode,   // NOTE: only used for TBHC.
         CloneFIObjNode,    // NOTE: only used for TBHC.
         CloneDummyObjNode  // NOTE: only used for TBHC.
     };

Constructor & Destructor Documentation

◆ PAGNode()

PAGNode::PAGNode	(	const Value *	val,
		NodeID	i,
		PNODEK	k
	)

address-taken pointer

Constructor

PAGNode constructor

Definition at line 1018 of file PAG.cpp.

                                                      :
     GenericPAGNodeTy(i,k), value(val)
 {
 
     assert( ValNode <= k && k <= CloneDummyObjNode && "new PAG node kind?");
 
     switch (k)
     {
     case ValNode:
     case GepValNode:
     {
         assert(val != nullptr && "value is nullptr for ValPN or GepValNode");
         isTLPointer = val->getType()->isPointerTy();
         isATPointer = false;
         break;
     }
 
     case RetNode:
     {
         assert(val != nullptr && "value is nullptr for RetNode");
         isTLPointer = SVFUtil::cast<Function>(val)->getReturnType()->isPointerTy();
         isATPointer = false;
         break;
     }
 
     case VarargNode:
     case DummyValNode:
     {
         isTLPointer = true;
         isATPointer = false;
         break;
     }
 
     case ObjNode:
     case GepObjNode:
     case FIObjNode:
     case DummyObjNode:
     case CloneGepObjNode:
     case CloneFIObjNode:
     case CloneDummyObjNode:
     {
         isTLPointer = false;
         isATPointer = true;
         break;
     }
     }
 }

◆ ~PAGNode()

virtual SVF::PAGNode::~PAGNode ( )

inlinevirtual

Destructor.

Definition at line 87 of file PAGNode.h.

88 {

89 }

Member Function Documentation

◆ addInEdge()

void SVF::PAGNode::addInEdge ( PAGEdge * inEdge )

inline

add methods of the components

Definition at line 237 of file PAGNode.h.

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

◆ addOutEdge()

void SVF::PAGNode::addOutEdge ( PAGEdge * outEdge )

inline

Definition at line 244 of file PAGNode.h.

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

◆ dump()

void PAGNode::dump ( ) const

Dump to console for debugging.

Definition at line 92 of file PAG.cpp.

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

◆ getFunction()

virtual const Function* SVF::PAGNode::getFunction ( ) const

inlinevirtual

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

Definition at line 145 of file PAGNode.h.

     {
         if(value)
         {
             if(const Instruction* inst = SVFUtil::dyn_cast<Instruction>(value))
                 return inst->getParent()->getParent();
             else if (const Argument* arg = SVFUtil::dyn_cast<Argument>(value))
                 return arg->getParent();
             else if (const Function* fun = SVFUtil::dyn_cast<Function>(value))
                 return fun;
         }
         return nullptr;
     }

◆ getIncomingEdges()

PAGEdge::PAGEdgeSetTy& SVF::PAGNode::getIncomingEdges ( PAGEdge::PEDGEK kind )

inline

Get incoming PAG edges.

Definition at line 160 of file PAGNode.h.

     {
         return InEdgeKindToSetMap[kind];
     }

◆ getIncomingEdgesBegin()

PAGEdge::PAGEdgeSetTy::iterator SVF::PAGNode::getIncomingEdgesBegin ( PAGEdge::PEDGEK kind ) const

inline

Get incoming PAGEdge iterator.

Definition at line 193 of file PAGNode.h.

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

◆ getIncomingEdgesEnd()

PAGEdge::PAGEdgeSetTy::iterator SVF::PAGNode::getIncomingEdgesEnd ( PAGEdge::PEDGEK kind ) const

inline

Get incoming PAGEdge iterator.

Definition at line 201 of file PAGNode.h.

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

◆ getNodeAttrForDotDisplay()

const std::string PAGNode::getNodeAttrForDotDisplay ( ) const

virtual

Get shape and/or color of node for .dot display.

Definition at line 54 of file PAG.cpp.

                                                         {
     // TODO: Maybe use over-rides instead of these ifs,
     // But this puts them conveniently together.
     if (SVFUtil::isa<ValPN>(this))
     {
         if(SVFUtil::isa<GepValPN>(this))
             return "shape=hexagon";
         else if (SVFUtil::isa<DummyValPN>(this))
             return "shape=diamond";
         else
             return "shape=box";
     }
     else if (SVFUtil::isa<ObjPN>(this))
     {
         if(SVFUtil::isa<GepObjPN>(this))
             return "shape=doubleoctagon";
         else if(SVFUtil::isa<FIObjPN>(this))
             return "shape=box3d";
         else if (SVFUtil::isa<DummyObjPN>(this))
             return "shape=tab";
         else
             return "shape=component";
     }
     else if (SVFUtil::isa<RetPN>(this))
     {
         return "shape=Mrecord";
     }
     else if (SVFUtil::isa<VarArgPN>(this))
     {
         return "shape=octagon";
     }
     else
     {
         assert(0 && "no such kind!!");
     }
     return "";
 }

◆ getOutgoingEdges()

PAGEdge::PAGEdgeSetTy& SVF::PAGNode::getOutgoingEdges ( PAGEdge::PEDGEK kind )

inline

Get outgoing PAG edges.

Definition at line 166 of file PAGNode.h.

     {
         return OutEdgeKindToSetMap[kind];
     }

◆ getOutgoingEdgesBegin()

PAGEdge::PAGEdgeSetTy::iterator SVF::PAGNode::getOutgoingEdgesBegin ( PAGEdge::PEDGEK kind ) const

inline

Get outgoing PAGEdge iterator.

Definition at line 219 of file PAGNode.h.

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

◆ getOutgoingEdgesEnd()

PAGEdge::PAGEdgeSetTy::iterator SVF::PAGNode::getOutgoingEdgesEnd ( PAGEdge::PEDGEK kind ) const

inline

Get outgoing PAGEdge iterator.

Definition at line 227 of file PAGNode.h.

     {
         PAGEdge::PAGKindToEdgeSetMapTy::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 Type* SVF::PAGNode::getType ( ) const

inlinevirtual

Return type of the value.

Reimplemented in SVF::GepObjPN, SVF::GepValPN, and SVF::ObjPN.

Definition at line 102 of file PAGNode.h.

     {
         if (value)
             return value->getType();
         return nullptr;
     }

◆ getValue()

const Value* SVF::PAGNode::getValue ( ) const

inline

Get/has methods of the components.

Definition at line 93 of file PAGNode.h.

     {
         assert((this->getNodeKind() != DummyValNode && this->getNodeKind() != DummyObjNode) && "dummy node do not have value!");
         assert((this->getId()!=SYMTYPE::BlackHole && this->getId() != SYMTYPE::ConstantObj) && "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::PAGNode::getValueName ( ) const

pure virtual

Get name of the LLVM value.

Implemented in SVF::CloneFIObjPN, SVF::CloneGepObjPN, SVF::CloneDummyObjPN, SVF::DummyObjPN, SVF::DummyValPN, SVF::VarArgPN, SVF::RetPN, SVF::FIObjPN, SVF::GepObjPN, SVF::GepValPN, SVF::ObjPN, and SVF::ValPN.

◆ hasIncomingEdges()

bool SVF::PAGNode::hasIncomingEdges ( PAGEdge::PEDGEK kind ) const

inline

Has incoming PAG edges.

Definition at line 172 of file PAGNode.h.

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

◆ hasIncomingVariantGepEdge()

bool SVF::PAGNode::hasIncomingVariantGepEdge ( ) const

inline

Has incoming VariantGepEdges.

Definition at line 182 of file PAGNode.h.

     {
         PAGEdge::PAGKindToEdgeSetMapTy::const_iterator it = InEdgeKindToSetMap.find(PAGEdge::VariantGep);
         if (it != InEdgeKindToSetMap.end())
         {
             return (!it->second.empty());
         }
         return false;
     }

◆ hasOutgoingEdges()

bool SVF::PAGNode::hasOutgoingEdges ( PAGEdge::PEDGEK kind ) const

inline

Has outgoing PAG edges.

Definition at line 209 of file PAGNode.h.

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

◆ hasValue()

bool SVF::PAGNode::hasValue ( ) const

inline

Definition at line 109 of file PAGNode.h.

     {
         return value!=nullptr;
     }

◆ isAddressTakenPtr()

bool SVF::PAGNode::isAddressTakenPtr ( ) const

inline

Whether it is an address-taken pointer.

Definition at line 124 of file PAGNode.h.

     {
         return isATPointer;
     }

◆ isConstantData()

bool SVF::PAGNode::isConstantData ( ) const

inline

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

Definition at line 130 of file PAGNode.h.

     {
         if (hasValue())
             return SVFUtil::isConstantData(value);
         else
             return false;
     }

◆ isIsolatedNode()

bool PAGNode::isIsolatedNode ( ) const

Whether this is an isoloated node on the PAG graph.

Definition at line 1066 of file PAG.cpp.

                                   {
     if (getInEdges().empty() && getOutEdges().empty())
         return true;
     else if (isConstantData())
         return true;
     else if (value && SVFUtil::isa<Function>(value))
         return SVFUtil::isIntrinsicFun(SVFUtil::cast<Function>(value));
     else
         return false;
 }

◆ isPointer()

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

inlinevirtual

Whether it is a pointer.

Definition at line 114 of file PAGNode.h.

     {
         return isTopLevelPtr() || isAddressTakenPtr();
     }

◆ isTopLevelPtr()

bool SVF::PAGNode::isTopLevelPtr ( ) const

inline

Whether it is a top-level pointer.

Definition at line 119 of file PAGNode.h.

     {
         return isTLPointer;
     }

◆ toString()

const std::string PAGNode::toString ( ) const

virtual

Reimplemented in SVF::CloneFIObjPN, SVF::CloneGepObjPN, SVF::CloneDummyObjPN, SVF::DummyObjPN, SVF::DummyValPN, SVF::VarArgPN, SVF::RetPN, SVF::FIObjPN, SVF::GepObjPN, SVF::GepValPN, SVF::ObjPN, and SVF::ValPN.

Definition at line 46 of file PAG.cpp.

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

Friends And Related Function Documentation

◆ operator<<

raw_ostream& operator<<	(	raw_ostream &	o,
		const PAGNode &	node
	)

friend

Overloading operator << for dumping PAGNode value.

Definition at line 262 of file PAGNode.h.

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

Member Data Documentation

◆ InEdgeKindToSetMap

PAGEdge::PAGKindToEdgeSetMapTy SVF::PAGNode::InEdgeKindToSetMap

protected

Definition at line 78 of file PAGNode.h.

◆ isATPointer

bool SVF::PAGNode::isATPointer

protected

top-level pointer

Definition at line 81 of file PAGNode.h.

◆ isTLPointer

bool SVF::PAGNode::isTLPointer

protected

Definition at line 80 of file PAGNode.h.

◆ OutEdgeKindToSetMap

PAGEdge::PAGKindToEdgeSetMapTy SVF::PAGNode::OutEdgeKindToSetMap

protected

Definition at line 79 of file PAGNode.h.

◆ value

const Value* SVF::PAGNode::value

protected

value of this PAG node

Definition at line 77 of file PAGNode.h.

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

/home/runner/work/SVF-1/SVF-1/include/Graphs/PAGNode.h
/home/runner/work/SVF-1/SVF-1/lib/Graphs/PAG.cpp

Public Types

Public Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ PNODEK

Constructor & Destructor Documentation

◆ PAGNode()

◆ ~PAGNode()

Member Function Documentation

◆ addInEdge()

◆ addOutEdge()

◆ dump()

◆ getFunction()

◆ getIncomingEdges()

◆ getIncomingEdgesBegin()

◆ getIncomingEdgesEnd()

◆ getNodeAttrForDotDisplay()

◆ getOutgoingEdges()

◆ getOutgoingEdgesBegin()

◆ getOutgoingEdgesEnd()

◆ getType()

◆ getValue()

◆ getValueName()

◆ hasIncomingEdges()

◆ hasIncomingVariantGepEdge()

◆ hasOutgoingEdges()

◆ hasValue()

◆ isAddressTakenPtr()

◆ isConstantData()

◆ isIsolatedNode()

◆ isPointer()

◆ isTopLevelPtr()

◆ toString()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ InEdgeKindToSetMap

◆ isATPointer

◆ isTLPointer

◆ OutEdgeKindToSetMap

◆ value