#include <PAGEdge.h>

Inheritance diagram for SVF::PAGEdge:

Public Types
enum	PEDGEK { Addr, Copy, Store, Load, Call, Ret, NormalGep, VariantGep, ThreadFork, ThreadJoin, Cmp, BinaryOp, UnaryOp }

typedef GenericNode< PAGNode, PAGEdge >::GEdgeSetTy	PAGEdgeSetTy

typedef Map< EdgeID, PAGEdgeSetTy >	PAGEdgeToSetMapTy

typedef PAGEdgeToSetMapTy	PAGKindToEdgeSetMapTy

Public Types inherited from SVF::GenericEdge< NodeTy >
typedef NodeTy	NodeType
	Node type. More...

typedef u64_t	GEdgeFlag

typedef s32_t	GEdgeKind

typedef struct SVF::GenericEdge::equalGEdge	equalGEdge
	Add the hash function for std::set (we also can overload operator< to implement this) More...

Public Member Functions
	PAGEdge (PAGNode s, PAGNode d, GEdgeFlag k)
	Constructor. More...

	~PAGEdge ()
	Destructor. More...

EdgeID	getEdgeID () const
	Return Edge ID. More...

bool	isPTAEdge () const
	Whether src and dst nodes are both of pointer type. More...

virtual const std::string	toString () const


const Instruction *	getInst () const
	Get/set methods for llvm instruction. More...

void	setValue (const Value *val)

const Value *	getValue () const

void	setBB (const BasicBlock *bb)

const BasicBlock *	getBB () const

void	setICFGNode (ICFGNode *node)

ICFGNode *	getICFGNode () const

Public Member Functions inherited from SVF::GenericEdge< NodeTy >
	GenericEdge (NodeTy s, NodeTy d, GEdgeFlag k)
	Constructor. More...

virtual	~GenericEdge ()
	Destructor. More...

NodeID	getSrcID () const
	get methods of the components More...

NodeID	getDstID () const

GEdgeKind	getEdgeKind () const

NodeType *	getSrcNode () const

NodeType *	getDstNode () const

bool	operator== (const GenericEdge< NodeType > *rhs) const

Static Public Member Functions
static GEdgeFlag	makeEdgeFlagWithCallInst (GEdgeKind k, const ICFGNode *cs)
	Compute the unique edgeFlag value from edge kind and call site Instruction. More...

static GEdgeFlag	makeEdgeFlagWithStoreInst (GEdgeKind k, const ICFGNode *store)


static bool	classof (const PAGEdge *)
	ClassOf. More...

static bool	classof (const GenericPAGEdgeTy *edge)

Static Public Attributes
static Size_t	totalEdgeNum
	Total edge number. More...

Private Types
typedef Map< const ICFGNode *, u32_t >	Inst2LabelMap

Private Attributes
const Value *	value
	LLVM value. More...

const BasicBlock *	basicBlock
	LLVM BasicBlock. More...

ICFGNode *	icfgNode
	ICFGNode. More...

EdgeID	edgeId
	Edge ID. More...

Static Private Attributes
static Inst2LabelMap	inst2LabelMap
	Call site Instruction to label map. More...

static u64_t	callEdgeLabelCounter = 0
	Call site Instruction counter. More...

static u64_t	storeEdgeLabelCounter = 0
	Store Instruction counter. More...

Friends

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

Additional Inherited Members
Static Protected Attributes inherited from SVF::GenericEdge< NodeTy >
static constexpr unsigned char	EdgeKindMaskBits = 8
	We use the lower 8 bits to denote edge kind. More...

static constexpr u64_t	EdgeKindMask = (~0ULL) >> (64 - EdgeKindMaskBits)

Detailed Description

Definition at line 47 of file PAGEdge.h.

Member Typedef Documentation

◆ Inst2LabelMap

typedef Map<const ICFGNode*, u32_t> SVF::PAGEdge::Inst2LabelMap

private

Definition at line 174 of file PAGEdge.h.

◆ PAGEdgeSetTy

typedef GenericNode<PAGNode,PAGEdge>::GEdgeSetTy SVF::PAGEdge::PAGEdgeSetTy

Definition at line 169 of file PAGEdge.h.

◆ PAGEdgeToSetMapTy

typedef Map<EdgeID, PAGEdgeSetTy> SVF::PAGEdge::PAGEdgeToSetMapTy

Definition at line 170 of file PAGEdge.h.

◆ PAGKindToEdgeSetMapTy

typedef PAGEdgeToSetMapTy SVF::PAGEdge::PAGKindToEdgeSetMapTy

Definition at line 171 of file PAGEdge.h.

Member Enumeration Documentation

◆ PEDGEK

enum SVF::PAGEdge::PEDGEK

Thirteen kinds of PAG edges Gep represents offset edge for field sensitivity ThreadFork/ThreadJoin is to model parameter passings between thread spawners and spawnees.

Enumerator
Addr
Copy
Store
Load
Call
Ret
NormalGep
VariantGep
ThreadFork
ThreadJoin
Cmp
BinaryOp
UnaryOp

Definition at line 54 of file PAGEdge.h.

     {
         Addr, Copy, Store, Load, Call, Ret, NormalGep, VariantGep, ThreadFork, ThreadJoin, Cmp, BinaryOp, UnaryOp
     };

Constructor & Destructor Documentation

◆ PAGEdge()

PAGEdge::PAGEdge	(	PAGNode *	s,
		PAGNode *	d,
		GEdgeFlag	k
	)

Constructor.

PAGEdge constructor

Definition at line 1000 of file PAG.cpp.

                                                     :
     GenericPAGEdgeTy(s,d,k),value(nullptr),basicBlock(nullptr),icfgNode(nullptr)
 {
     edgeId = PAG::getPAG()->getTotalEdgeNum();
     PAG::getPAG()->incEdgeNum();
 }

◆ ~PAGEdge()

SVF::PAGEdge::~PAGEdge ( )

inline

Destructor.

Definition at line 70 of file PAGEdge.h.

71 {

72 }

Member Function Documentation

◆ classof() [1/2]

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

inlinestatic

ClassOf.

Definition at line 76 of file PAGEdge.h.

     {
         return true;
     }

◆ classof() [2/2]

static bool SVF::PAGEdge::classof ( const GenericPAGEdgeTy * edge )

inlinestatic

Definition at line 80 of file PAGEdge.h.

     {
         return edge->getEdgeKind() == PAGEdge::Addr ||
                edge->getEdgeKind() == PAGEdge::Copy ||
                edge->getEdgeKind() == PAGEdge::Store ||
                edge->getEdgeKind() == PAGEdge::Load ||
                edge->getEdgeKind() == PAGEdge::Call ||
                edge->getEdgeKind() == PAGEdge::Ret ||
                edge->getEdgeKind() == PAGEdge::NormalGep ||
                edge->getEdgeKind() == PAGEdge::VariantGep ||
                edge->getEdgeKind() == PAGEdge::ThreadFork ||
                edge->getEdgeKind() == PAGEdge::ThreadJoin ||
                edge->getEdgeKind() == PAGEdge::Cmp ||
                edge->getEdgeKind() == PAGEdge::BinaryOp ||
                edge->getEdgeKind() == PAGEdge::UnaryOp;
     }

◆ getBB()

const BasicBlock* SVF::PAGEdge::getBB ( ) const

inline

Definition at line 124 of file PAGEdge.h.

     {
         return basicBlock;
     }

◆ getEdgeID()

EdgeID SVF::PAGEdge::getEdgeID ( ) const

inline

Return Edge ID.

Definition at line 99 of file PAGEdge.h.

     {
         return edgeId;
     }

◆ getICFGNode()

ICFGNode* SVF::PAGEdge::getICFGNode ( ) const

inline

Definition at line 132 of file PAGEdge.h.

     {
         return icfgNode;
     }

◆ getInst()

const Instruction* SVF::PAGEdge::getInst ( ) const

inline

Get/set methods for llvm instruction.

Definition at line 108 of file PAGEdge.h.

     {
         return SVFUtil::dyn_cast<Instruction>(value);
     }

◆ getValue()

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

inline

Definition at line 116 of file PAGEdge.h.

     {
         return value;
     }

◆ isPTAEdge()

bool PAGEdge::isPTAEdge ( ) const

Whether src and dst nodes are both of pointer type.

Whether src and dst nodes are both pointer type

Definition at line 1010 of file PAG.cpp.

 {
     return getSrcNode()->isPointer() && getDstNode()->isPointer();
 }

◆ makeEdgeFlagWithCallInst()

static GEdgeFlag SVF::PAGEdge::makeEdgeFlagWithCallInst	(	GEdgeKind	k,
		const ICFGNode *	cs
	)

inlinestatic

Compute the unique edgeFlag value from edge kind and call site Instruction.

Definition at line 139 of file PAGEdge.h.

     {
         Inst2LabelMap::const_iterator iter = inst2LabelMap.find(cs);
         u64_t label = (iter != inst2LabelMap.end()) ?
                       iter->second : callEdgeLabelCounter++;
         return (label << EdgeKindMaskBits) | k;
     }

◆ makeEdgeFlagWithStoreInst()

static GEdgeFlag SVF::PAGEdge::makeEdgeFlagWithStoreInst	(	GEdgeKind	k,
		const ICFGNode *	store
	)

inlinestatic

Compute the unique edgeFlag value from edge kind and store Instruction. Two store instructions may share the same StorePAGEdge

Definition at line 149 of file PAGEdge.h.

     {
         Inst2LabelMap::const_iterator iter = inst2LabelMap.find(store);
         u64_t label = (iter != inst2LabelMap.end()) ?
                       iter->second : storeEdgeLabelCounter++;
         return (label << EdgeKindMaskBits) | k;
     }

◆ setBB()

void SVF::PAGEdge::setBB ( const BasicBlock * bb )

inline

Definition at line 120 of file PAGEdge.h.

     {
         basicBlock = bb;
     }

◆ setICFGNode()

void SVF::PAGEdge::setICFGNode ( ICFGNode * node )

inline

Definition at line 128 of file PAGEdge.h.

     {
         icfgNode = node;
     }

◆ setValue()

void SVF::PAGEdge::setValue ( const Value * val )

inline

Definition at line 112 of file PAGEdge.h.

     {
         value = val;
     }

◆ toString()

const std::string PAGEdge::toString ( ) const

virtual

Reimplemented in SVF::TDJoinPE, SVF::TDForkPE, SVF::RetPE, SVF::CallPE, SVF::VariantGepPE, SVF::NormalGepPE, SVF::GepPE, SVF::LoadPE, SVF::StorePE, SVF::UnaryOPPE, SVF::BinaryOPPE, SVF::CmpPE, SVF::CopyPE, and SVF::AddrPE.

Definition at line 200 of file PAG.cpp.

                                         {
     std::string str;
     raw_string_ostream rawstr(str);
     rawstr << "PAGEdge: [" << getDstID() << "<--" << getSrcID() << "]\t";
     return rawstr.str();
 }

Friends And Related Function Documentation

◆ operator<<

raw_ostream& operator<<	(	raw_ostream &	o,
		const PAGEdge &	edge
	)

friend

Overloading operator << for dumping PAGNode value.

Definition at line 162 of file PAGEdge.h.

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

Member Data Documentation

◆ basicBlock

const BasicBlock* SVF::PAGEdge::basicBlock

private

LLVM BasicBlock.

Definition at line 61 of file PAGEdge.h.

◆ callEdgeLabelCounter

u64_t PAGEdge::callEdgeLabelCounter = 0

staticprivate

Call site Instruction counter.

Definition at line 176 of file PAGEdge.h.

◆ edgeId

EdgeID SVF::PAGEdge::edgeId

private

Edge ID.

Definition at line 63 of file PAGEdge.h.

◆ icfgNode

ICFGNode* SVF::PAGEdge::icfgNode

private

ICFGNode.

Definition at line 62 of file PAGEdge.h.

◆ inst2LabelMap

PAGEdge::Inst2LabelMap PAGEdge::inst2LabelMap

staticprivate

Call site Instruction to label map.

Definition at line 175 of file PAGEdge.h.

◆ storeEdgeLabelCounter

u64_t PAGEdge::storeEdgeLabelCounter = 0

staticprivate

Store Instruction counter.

Definition at line 177 of file PAGEdge.h.

◆ totalEdgeNum

Size_t SVF::PAGEdge::totalEdgeNum

static

Total edge number.

Definition at line 65 of file PAGEdge.h.

◆ value

const Value* SVF::PAGEdge::value

private

LLVM value.

Definition at line 60 of file PAGEdge.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Types

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Inst2LabelMap

◆ PAGEdgeSetTy

◆ PAGEdgeToSetMapTy

◆ PAGKindToEdgeSetMapTy

Member Enumeration Documentation

◆ PEDGEK

Constructor & Destructor Documentation

◆ PAGEdge()

◆ ~PAGEdge()

Member Function Documentation

◆ classof() [1/2]

◆ classof() [2/2]

◆ getBB()

◆ getEdgeID()

◆ getICFGNode()

◆ getInst()

◆ getValue()

◆ isPTAEdge()

◆ makeEdgeFlagWithCallInst()

◆ makeEdgeFlagWithStoreInst()

◆ setBB()

◆ setICFGNode()

◆ setValue()

◆ toString()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ basicBlock

◆ callEdgeLabelCounter

◆ edgeId

◆ icfgNode

◆ inst2LabelMap

◆ storeEdgeLabelCounter

◆ totalEdgeNum

◆ value