#include <PAG.h>

Inheritance diagram for SVF::PAG:

Public Types
typedef Set< const CallBlockNode * >	CallSiteSet

typedef OrderedMap< const CallBlockNode *, NodeID >	CallSiteToFunPtrMap

typedef Map< NodeID, CallSiteSet >	FunPtrToCallSitesMap

typedef Map< NodeID, NodeBS >	MemObjToFieldsMap

typedef Set< const PAGEdge * >	PAGEdgeSet

typedef std::vector< const PAGEdge * >	PAGEdgeList

typedef std::vector< const PAGNode * >	PAGNodeList

typedef std::vector< const CopyPE * >	CopyPEList

typedef std::vector< const BinaryOPPE * >	BinaryOPList

typedef std::vector< const UnaryOPPE * >	UnaryOPList

typedef std::vector< const CmpPE * >	CmpPEList

typedef Map< const PAGNode *, CopyPEList >	PHINodeMap

typedef Map< const PAGNode *, BinaryOPList >	BinaryNodeMap

typedef Map< const PAGNode *, UnaryOPList >	UnaryNodeMap

typedef Map< const PAGNode *, CmpPEList >	CmpNodeMap

typedef Map< const SVFFunction *, PAGNodeList >	FunToArgsListMap

typedef Map< const CallBlockNode *, PAGNodeList >	CSToArgsListMap

typedef Map< const RetBlockNode , const PAGNode >	CSToRetMap

typedef Map< const SVFFunction , const PAGNode >	FunToRetMap

typedef Map< const SVFFunction *, PAGEdgeSet >	FunToPAGEdgeSetMap

typedef Map< const ICFGNode *, PAGEdgeList >	Inst2PAGEdgesMap

typedef Map< NodeID, NodeID >	NodeToNodeMap

typedef std::pair< NodeID, Size_t >	NodeOffset

typedef std::pair< NodeID, LocationSet >	NodeLocationSet

typedef Map< NodeOffset, NodeID >	NodeOffsetMap

typedef Map< NodeLocationSet, NodeID >	NodeLocationSetMap

typedef Map< const Value *, NodeLocationSetMap >	GepValPNMap

typedef Map< NodePair, NodeID >	NodePairSetMap

Public Types inherited from SVF::GenericGraph< PAGNode, PAGEdge >
typedef PAGNode	NodeType

typedef PAGEdge	EdgeType

typedef Map< NodeID, NodeType *>	IDToNodeMapTy
	NodeID to GenericNode map. More...

typedef IDToNodeMapTy::iterator	iterator
	Node Iterators. More...

typedef IDToNodeMapTy::const_iterator	const_iterator

Public Member Functions
MemObjToFieldsMap &	getMemToFieldsMap ()
	Return memToFieldsMap. More...

NodeLocationSetMap &	getGepObjNodeMap ()
	Return GepObjNodeMap. More...

ICFG *	getICFG ()
	Return ICFG. More...

OrderedNodeSet &	getAllValidPtrs ()
	Return valid pointers. More...

void	initialiseCandidatePointers ()
	Initialize candidate pointers. More...

virtual	~PAG ()
	Destructor. More...

bool	isBuiltFromFile ()
	Whether this PAG built from a txt file. More...

SVFModule *	getModule ()
	Get LLVM Module. More...

void	addCallSite (const CallBlockNode *call)

const CallSiteSet &	getCallSiteSet () const

NodeID	getGepValNode (const Value *curInst, NodeID base, const LocationSet &ls) const
	Due to constaint expression, curInst is used to distinguish different instructions (e.g., memorycpy) when creating GepValPN. More...

bool	findPAGNode (NodeID id) const
	Get a pag node according to its ID. More...

PAGNode *	getPAGNode (NodeID id) const
	Get PAGNode ID. More...

NodeID	getReturnNode (const SVFFunction *func) const
	GetReturnNode - Return the unique node representing the return value of a function. More...

NodeID	getVarargNode (const SVFFunction *func) const
	getVarargNode - Return the unique node representing the variadic argument of a variadic function. More...

NodeID	getGepObjNode (const MemObj *obj, const LocationSet &ls)
	Get a field PAG Object node according to base mem obj and offset. More...

NodeID	getGepObjNode (NodeID id, const LocationSet &ls)
	Get a field obj PAG node according to a mem obj and a given offset. More...

u32_t	getNodeNumAfterPAGBuild () const

void	setNodeNumAfterPAGBuild (u32_t num)

NodeID	addValNode (const Value , PAGNode node, NodeID i)
	Add a value (pointer) node. More...

NodeID	addObjNode (const Value , PAGNode node, NodeID i)
	Add a memory obj node. More...

NodeID	addRetNode (const SVFFunction , PAGNode node, NodeID i)
	Add a unique return node for a procedure. More...

NodeID	addVarargNode (const SVFFunction , PAGNode node, NodeID i)
	Add a unique vararg node for a procedure. More...

PAGEdge *	addBlackHoleAddrPE (NodeID node)
	Set a pointer points-to black hole (e.g. int2ptr) More...

std::string	getGraphName () const
	Return graph name. More...

void	print ()
	Print PAG. More...

void	dump (std::string name)
	Dump PAG. More...

void	view ()
	View graph from the debugger. More...


PAGEdge::PAGEdgeSetTy &	getEdgeSet (PAGEdge::PEDGEK kind)
	Get/set methods to get control flow information of a PAGEdge. More...

PAGEdge::PAGEdgeSetTy &	getPTAEdgeSet (PAGEdge::PEDGEK kind)
	Get PTA edges set according to its kind. More...

bool	hasPAGEdgeList (const ICFGNode *inst) const
	Whether this instruction has PAG Edge. More...

bool	hasPTAPAGEdgeList (const ICFGNode *inst) const

PAGEdgeList &	getInstPAGEdgeList (const ICFGNode *inst)
	Given an instruction, get all its PAGEdges. More...

PAGEdgeList &	getInstPTAPAGEdgeList (const ICFGNode *inst)
	Given an instruction, get all its PTA PAGEdges. More...

void	addToInstPAGEdgeList (ICFGNode inst, PAGEdge edge)
	Add a PAGEdge into instruction map. More...

void	addGlobalPAGEdge (const PAGEdge *edge)
	Get global PAGEdges (not in a procedure) More...

PAGEdgeSet &	getGlobalPAGEdgeSet ()
	Get global PAGEdges (not in a procedure) More...

void	addPhiNode (const PAGNode res, const CopyPE edge)
	Add phi node information. More...

bool	isPhiNode (const PAGNode *node) const
	Whether this PAGNode is a result operand a of phi node. More...

PHINodeMap &	getPhiNodeMap ()
	Get all phi copy edges. More...

void	addBinaryNode (const PAGNode res, const BinaryOPPE edge)
	Add phi node information. More...

bool	isBinaryNode (const PAGNode *node) const
	Whether this PAGNode is a result operand a of phi node. More...

BinaryNodeMap &	getBinaryNodeMap ()
	Get all phi copy edges. More...

void	addUnaryNode (const PAGNode res, const UnaryOPPE edge)
	Add unary node information. More...

bool	isUnaryNode (const PAGNode *node) const
	Whether this PAGNode is an unary node. More...

UnaryNodeMap &	getUnaryNodeMap ()
	Get all unary edges. More...

void	addCmpNode (const PAGNode res, const CmpPE edge)
	Add phi node information. More...

bool	isCmpNode (const PAGNode *node) const
	Whether this PAGNode is a result operand a of phi node. More...

CmpNodeMap &	getCmpNodeMap ()
	Get all phi copy edges. More...


void	addFunArgs (const SVFFunction fun, const PAGNode arg)
	Get/set method for function/callsite arguments and returns. More...

void	addFunRet (const SVFFunction fun, const PAGNode ret)
	Add function returns. More...

void	addCallSiteArgs (CallBlockNode callBlockNode, const PAGNode arg)
	Add callsite arguments. More...

void	addCallSiteRets (RetBlockNode retBlockNode, const PAGNode arg)
	Add callsite returns. More...

bool	hasFunArgsList (const SVFFunction *func) const
	Function has arguments list. More...

FunToArgsListMap &	getFunArgsMap ()
	Get function arguments list. More...

const PAGNodeList &	getFunArgsList (const SVFFunction *func) const
	Get function arguments list. More...

bool	hasCallSiteArgsMap (const CallBlockNode *cs) const
	Callsite has argument list. More...

CSToArgsListMap &	getCallSiteArgsMap ()
	Get callsite argument list. More...

const PAGNodeList &	getCallSiteArgsList (const CallBlockNode *cs) const
	Get callsite argument list. More...

CSToRetMap &	getCallSiteRets ()
	Get callsite return. More...

const PAGNode *	getCallSiteRet (const RetBlockNode *cs) const
	Get callsite return. More...

bool	callsiteHasRet (const RetBlockNode *cs) const

FunToRetMap &	getFunRets ()
	Get function return list. More...

const PAGNode *	getFunRet (const SVFFunction *func) const
	Get function return list. More...

bool	funHasRet (const SVFFunction *func) const


Size_t	getPAGNodeNum () const
	Node and edge statistics. More...

Size_t	getPAGEdgeNum () const

Size_t	getValueNodeNum () const

Size_t	getObjectNodeNum () const

Size_t	getFieldValNodeNum () const

Size_t	getFieldObjNodeNum () const


const CallSiteToFunPtrMap &	getIndirectCallsites () const
	Add/get indirect callsites. More...

void	addIndirectCallsites (const CallBlockNode *cs, NodeID funPtr)

NodeID	getFunPtr (const CallBlockNode *cs) const

const CallSiteSet &	getIndCallSites (NodeID funPtr) const

bool	isIndirectCallSites (const CallBlockNode *cs) const

bool	isFunPtr (NodeID id) const


PAGEdge *	getIntraPAGEdge (NodeID src, NodeID dst, PAGEdge::PEDGEK kind)
	Get an edge according to src, dst and kind. More...

PAGEdge *	getIntraPAGEdge (PAGNode src, PAGNode dst, PAGEdge::PEDGEK kind)


NodeID	getValueNode (const Value *V)
	Get PAG Node according to LLVM value. More...

bool	hasValueNode (const Value *V)

NodeID	getObjectNode (const Value *V)

NodeID	getObjectNode (const MemObj *mem)
	getObject - return mem object id More...

const MemObj *	getObject (NodeID id) const

const MemObj *	getObject (const ObjPN *node) const


NodeID	getFIObjNode (const MemObj *obj) const
	Get a field-insensitive obj PAG node according to a mem obj. More...

NodeID	getFIObjNode (NodeID id) const


NodeID	getBlackHoleNode () const
	Get black hole and constant id. More...

NodeID	getConstantNode () const

NodeID	getBlkPtr () const

NodeID	getNullPtr () const

bool	isBlkPtr (NodeID id) const

bool	isNullPtr (NodeID id) const

bool	isBlkObjOrConstantObj (NodeID id) const

bool	isBlkObj (NodeID id) const

bool	isConstantObj (NodeID id) const

bool	isNonPointerObj (NodeID id) const

const MemObj *	getBlackHoleObj () const

const MemObj *	getConstantObj () const


NodeID	getBaseValNode (NodeID nodeId)
	Base and Offset methods for Value and Object node. More...

LocationSet	getLocationSetFromBaseNode (NodeID nodeId)

NodeID	getBaseObjNode (NodeID id) const

const MemObj *	getBaseObj (NodeID id) const


NodeBS &	getAllFieldsObjNode (const MemObj *obj)
	Get all fields of an object. More...

NodeBS &	getAllFieldsObjNode (NodeID id)

NodeBS	getFieldsAfterCollapse (NodeID id)


NodeID	addNode (PAGNode *node, NodeID i)
	add node into PAG More...

NodeID	addValNode (const Value *val, NodeID i)
	Add a value (pointer) node. More...

NodeID	addObjNode (const Value *val, NodeID i)
	Add a memory obj node. More...

NodeID	addRetNode (const SVFFunction *val, NodeID i)
	Add a unique return node for a procedure. More...

NodeID	addVarargNode (const SVFFunction *val, NodeID i)
	Add a unique vararg node for a procedure. More...

NodeID	addGepValNode (const Value curInst, const Value val, const LocationSet &ls, NodeID i, const Type *type, u32_t fieldidx)
	Add a temp field value node, this method can only invoked by getGepValNode. More...

NodeID	addGepObjNode (const MemObj *obj, const LocationSet &ls)
	Add a field obj node, this method can only invoked by getGepObjNode. More...

NodeID	addFIObjNode (const MemObj *obj)
	Add a field-insensitive node, this method can only invoked by getFIGepObjNode. More...


NodeID	addDummyValNode ()
	Add a dummy value/object node according to node ID (llvm value is null) More...

NodeID	addDummyValNode (NodeID i)

NodeID	addDummyObjNode (const Type *type=nullptr)

NodeID	addDummyObjNode (NodeID i, const Type *type)

const MemObj *	addDummyMemObj (NodeID i, const Type *type)

NodeID	addBlackholeObjNode ()

NodeID	addConstantObjNode ()

NodeID	addBlackholePtrNode ()


bool	addEdge (PAGNode src, PAGNode dst, PAGEdge *edge)
	Add an edge into PAG. More...

PAGEdge *	hasNonlabeledEdge (PAGNode src, PAGNode dst, PAGEdge::PEDGEK kind)

PAGEdge *	hasLabeledEdge (PAGNode src, PAGNode dst, PAGEdge::PEDGEK kind, const ICFGNode *cs)

AddrPE *	addAddrPE (NodeID src, NodeID dst)
	Add Address edge. More...

CopyPE *	addCopyPE (NodeID src, NodeID dst)
	Add Copy edge. More...

CmpPE *	addCmpPE (NodeID src, NodeID dst)
	Add Copy edge. More...

BinaryOPPE *	addBinaryOPPE (NodeID src, NodeID dst)
	Add Copy edge. More...

UnaryOPPE *	addUnaryOPPE (NodeID src, NodeID dst)
	Add Unary edge. More...

LoadPE *	addLoadPE (NodeID src, NodeID dst)
	Add Load edge. More...

StorePE *	addStorePE (NodeID src, NodeID dst, const IntraBlockNode *val)
	Add Store edge. More...

CallPE *	addCallPE (NodeID src, NodeID dst, const CallBlockNode *cs)
	Add Call edge. More...

RetPE *	addRetPE (NodeID src, NodeID dst, const CallBlockNode *cs)
	Add Return edge. More...

GepPE *	addGepPE (NodeID src, NodeID dst, const LocationSet &ls, bool constGep)
	Add Gep edge. More...

NormalGepPE *	addNormalGepPE (NodeID src, NodeID dst, const LocationSet &ls)
	Add Offset(Gep) edge. More...

VariantGepPE *	addVariantGepPE (NodeID src, NodeID dst)
	Add Variant(Gep) edge. More...

TDForkPE *	addThreadForkPE (NodeID src, NodeID dst, const CallBlockNode *cs)
	Add Thread fork edge for parameter passing. More...

TDJoinPE *	addThreadJoinPE (NodeID src, NodeID dst, const CallBlockNode *cs)
	Add Thread join edge for parameter passing. More...


bool	isValidPointer (NodeID nodeId) const
	Whether a node is a valid pointer. More...

bool	isValidTopLevelPtr (const PAGNode *node)

Public Member Functions inherited from SVF::GenericGraph< PAGNode, PAGEdge >
	GenericGraph ()
	Constructor. More...

virtual	~GenericGraph ()
	Destructor. More...

void	destroy ()
	Release memory. More...

iterator	begin ()
	Iterators. More...

const_iterator	begin () const

iterator	end ()

const_iterator	end () const

void	addGNode (NodeID id, NodeType *node)
	Add a Node. More...

NodeType *	getGNode (NodeID id) const
	Get a node. More...

bool	hasGNode (NodeID id) const
	Has a node. More...

void	removeGNode (NodeType *node)
	Delete a node. More...

u32_t	getTotalNodeNum () const
	Get total number of node/edge. More...

u32_t	getTotalEdgeNum () const

void	incNodeNum ()
	Increase number of node/edge. More...

void	incEdgeNum ()

Static Public Member Functions

static PAG *	getPAG (bool buildFromFile=false)
	Singleton design here to make sure we only have one instance during any analysis. More...

static void	releasePAG ()


static void	handleBlackHole (bool b)
	PAG build configurations. More...

Public Attributes
u32_t	totalPTAPAGEdge

Public Attributes inherited from SVF::GenericGraph< PAGNode, PAGEdge >
u32_t	edgeNum
	total num of node More...

u32_t	nodeNum
	total num of edge More...

Private Member Functions
	PAG (bool buildFromFile)
	all the callsites of a program More...

void	destroy ()
	Clean up memory. More...

Private Attributes
SymbolTableInfo *	symInfo

PAGEdge::PAGKindToEdgeSetMapTy	PAGEdgeKindToSetMap

PAGEdge::PAGKindToEdgeSetMapTy	PTAPAGEdgeKindToSetMap

Inst2PAGEdgesMap	inst2PAGEdgesMap
	Map a instruction to its PAGEdges. More...

Inst2PAGEdgesMap	inst2PTAPAGEdgesMap
	Map a instruction to its PointerAnalysis related PAGEdges. More...

GepValPNMap	GepValNodeMap
	Map a pair<base,off> to a gep value node id. More...

NodeLocationSetMap	GepObjNodeMap
	Map a pair<base,off> to a gep obj node id. More...

MemObjToFieldsMap	memToFieldsMap
	Map a mem object id to all its fields. More...

PAGEdgeSet	globPAGEdgesSet
	Global PAGEdges without control flow information. More...

PHINodeMap	phiNodeMap
	A set of phi copy edges. More...

BinaryNodeMap	binaryNodeMap
	A set of binary edges. More...

UnaryNodeMap	unaryNodeMap
	A set of unary edges. More...

CmpNodeMap	cmpNodeMap
	A set of comparision edges. More...

FunToArgsListMap	funArgsListMap
	Map a function to a list of all its formal parameters. More...

CSToArgsListMap	callSiteArgsListMap
	Map a callsite to a list of all its actual parameters. More...

CSToRetMap	callSiteRetMap
	Map a callsite to its callsite returns PAGNodes. More...

FunToRetMap	funRetMap
	Map a function to its unique function return PAGNodes. More...

CallSiteToFunPtrMap	indCallSiteToFunPtrMap
	Map an indirect callsite to its function pointer. More...

FunPtrToCallSitesMap	funPtrToCallSitesMap
	Map a function pointer to the callsites where it is used. More...

bool	fromFile

OrderedNodeSet	candidatePointers

NodeID	nodeNumAfterPAGBuild

ICFG *	icfg

CallSiteSet	callSiteSet

Static Private Attributes
static PAG *	pag = nullptr
	Singleton pattern here to enable instance of PAG can only be created once. More...

Additional Inherited Members
Protected Attributes inherited from SVF::GenericGraph< PAGNode, PAGEdge >
IDToNodeMapTy	IDToNodeMap
	node map More...

Detailed Description

Program Assignment Graph for pointer analysis SymID and NodeID are equal here (same numbering).

Definition at line 47 of file PAG.h.

Member Typedef Documentation

◆ BinaryNodeMap

typedef Map<const PAGNode*,BinaryOPList> SVF::PAG::BinaryNodeMap

Definition at line 63 of file PAG.h.

◆ BinaryOPList

typedef std::vector<const BinaryOPPE*> SVF::PAG::BinaryOPList

Definition at line 59 of file PAG.h.

◆ CallSiteSet

typedef Set<const CallBlockNode*> SVF::PAG::CallSiteSet

Definition at line 51 of file PAG.h.

◆ CallSiteToFunPtrMap

typedef OrderedMap<const CallBlockNode*,NodeID> SVF::PAG::CallSiteToFunPtrMap

Definition at line 52 of file PAG.h.

◆ CmpNodeMap

typedef Map<const PAGNode*,CmpPEList> SVF::PAG::CmpNodeMap

Definition at line 65 of file PAG.h.

◆ CmpPEList

typedef std::vector<const CmpPE*> SVF::PAG::CmpPEList

Definition at line 61 of file PAG.h.

◆ CopyPEList

typedef std::vector<const CopyPE*> SVF::PAG::CopyPEList

Definition at line 58 of file PAG.h.

◆ CSToArgsListMap

typedef Map<const CallBlockNode*,PAGNodeList> SVF::PAG::CSToArgsListMap

Definition at line 67 of file PAG.h.

◆ CSToRetMap

typedef Map<const RetBlockNode*,const PAGNode*> SVF::PAG::CSToRetMap

Definition at line 68 of file PAG.h.

◆ FunPtrToCallSitesMap

typedef Map<NodeID,CallSiteSet> SVF::PAG::FunPtrToCallSitesMap

Definition at line 53 of file PAG.h.

◆ FunToArgsListMap

typedef Map<const SVFFunction*,PAGNodeList> SVF::PAG::FunToArgsListMap

Definition at line 66 of file PAG.h.

◆ FunToPAGEdgeSetMap

typedef Map<const SVFFunction*,PAGEdgeSet> SVF::PAG::FunToPAGEdgeSetMap

Definition at line 70 of file PAG.h.

◆ FunToRetMap

typedef Map<const SVFFunction*,const PAGNode*> SVF::PAG::FunToRetMap

Definition at line 69 of file PAG.h.

◆ GepValPNMap

typedef Map<const Value*, NodeLocationSetMap> SVF::PAG::GepValPNMap

Definition at line 77 of file PAG.h.

◆ Inst2PAGEdgesMap

typedef Map<const ICFGNode*,PAGEdgeList> SVF::PAG::Inst2PAGEdgesMap

Definition at line 71 of file PAG.h.

◆ MemObjToFieldsMap

typedef Map<NodeID,NodeBS> SVF::PAG::MemObjToFieldsMap

Definition at line 54 of file PAG.h.

◆ NodeLocationSet

typedef std::pair<NodeID, LocationSet> SVF::PAG::NodeLocationSet

Definition at line 74 of file PAG.h.

◆ NodeLocationSetMap

typedef Map<NodeLocationSet,NodeID> SVF::PAG::NodeLocationSetMap

Definition at line 76 of file PAG.h.

◆ NodeOffset

typedef std::pair<NodeID, Size_t> SVF::PAG::NodeOffset

Definition at line 73 of file PAG.h.

◆ NodeOffsetMap

typedef Map<NodeOffset,NodeID> SVF::PAG::NodeOffsetMap

Definition at line 75 of file PAG.h.

◆ NodePairSetMap

typedef Map<NodePair,NodeID> SVF::PAG::NodePairSetMap

Definition at line 78 of file PAG.h.

◆ NodeToNodeMap

typedef Map<NodeID, NodeID> SVF::PAG::NodeToNodeMap

Definition at line 72 of file PAG.h.

◆ PAGEdgeList

typedef std::vector<const PAGEdge*> SVF::PAG::PAGEdgeList

Definition at line 56 of file PAG.h.

◆ PAGEdgeSet

typedef Set<const PAGEdge*> SVF::PAG::PAGEdgeSet

Definition at line 55 of file PAG.h.

◆ PAGNodeList

typedef std::vector<const PAGNode*> SVF::PAG::PAGNodeList

Definition at line 57 of file PAG.h.

◆ PHINodeMap

typedef Map<const PAGNode*,CopyPEList> SVF::PAG::PHINodeMap

Definition at line 62 of file PAG.h.

◆ UnaryNodeMap

typedef Map<const PAGNode*,UnaryOPList> SVF::PAG::UnaryNodeMap

Definition at line 64 of file PAG.h.

◆ UnaryOPList

typedef std::vector<const UnaryOPPE*> SVF::PAG::UnaryOPList

Definition at line 60 of file PAG.h.

Constructor & Destructor Documentation

◆ PAG()

PAG::PAG ( bool buildFromFile )

private

all the callsites of a program

Constructor

Definition at line 362 of file PAG.cpp.

                            : fromFile(buildFromFile), nodeNumAfterPAGBuild(0), totalPTAPAGEdge(0)
 {
     symInfo = SymbolTableInfo::SymbolInfo();
     icfg = new ICFG();
     ICFGBuilder builder(icfg);
     builder.build(getModule());
 }

◆ ~PAG()

virtual SVF::PAG::~PAG ( )

inlinevirtual

Destructor.

Definition at line 177 of file PAG.h.

     {
         destroy();
     }

Member Function Documentation

◆ addAddrPE()

AddrPE * PAG::addAddrPE	(	NodeID	src,
		NodeID	dst
	)

Add Address edge.

Add Address edge

Definition at line 373 of file PAG.cpp.

 {
     PAGNode* srcNode = getPAGNode(src);
     PAGNode* dstNode = getPAGNode(dst);
     if(PAGEdge* edge = hasNonlabeledEdge(srcNode,dstNode, PAGEdge::Addr))
         return SVFUtil::cast<AddrPE>(edge);
     else
     {
         AddrPE* addrPE = new AddrPE(srcNode, dstNode);
         addEdge(srcNode,dstNode, addrPE);
         return addrPE;
     }
 }

◆ addBinaryNode()

void SVF::PAG::addBinaryNode	(	const PAGNode *	res,
		const BinaryOPPE *	edge
	)

inline

Add phi node information.

Definition at line 270 of file PAG.h.

     {
         binaryNodeMap[res].push_back(edge);
     }

◆ addBinaryOPPE()

BinaryOPPE * PAG::addBinaryOPPE	(	NodeID	src,
		NodeID	dst
	)

Add Copy edge.

Add Compare edge

Definition at line 425 of file PAG.cpp.

 {
     PAGNode* srcNode = getPAGNode(src);
     PAGNode* dstNode = getPAGNode(dst);
     if(PAGEdge* edge = hasNonlabeledEdge(srcNode,dstNode, PAGEdge::BinaryOp))
         return SVFUtil::cast<BinaryOPPE>(edge);
     else
     {
         BinaryOPPE* binaryOP = new BinaryOPPE(srcNode, dstNode);
         addEdge(srcNode,dstNode, binaryOP);
         return binaryOP;
     }
 }

◆ addBlackHoleAddrPE()

PAGEdge * PAG::addBlackHoleAddrPE ( NodeID node )

Set a pointer points-to black hole (e.g. int2ptr)

Add blackhole/constant edge

Definition at line 528 of file PAG.cpp.

 {
     if(Options::HandBlackHole)
         return pag->addAddrPE(pag->getBlackHoleNode(), node);
     else
         return pag->addCopyPE(pag->getNullPtr(), node);
 }

◆ addBlackholeObjNode()

NodeID SVF::PAG::addBlackholeObjNode ( )

inline

Definition at line 757 of file PAG.h.

     {
         return addObjNode(nullptr, new DummyObjPN(getBlackHoleNode(),getBlackHoleObj()), getBlackHoleNode());
     }

◆ addBlackholePtrNode()

NodeID SVF::PAG::addBlackholePtrNode ( )

inline

Definition at line 765 of file PAG.h.

     {
         return addDummyValNode(getBlkPtr());
     }

◆ addCallPE()

CallPE * PAG::addCallPE	(	NodeID	src,
		NodeID	dst,
		const CallBlockNode *	cs
	)

Add Call edge.

Add Call edge

Definition at line 494 of file PAG.cpp.

 {
     PAGNode* srcNode = getPAGNode(src);
     PAGNode* dstNode = getPAGNode(dst);
     if(PAGEdge* edge = hasLabeledEdge(srcNode,dstNode, PAGEdge::Call, cs))
         return SVFUtil::cast<CallPE>(edge);
     else
     {
         CallPE* callPE = new CallPE(srcNode, dstNode, cs);
         addEdge(srcNode,dstNode, callPE);
         return callPE;
     }
 }

◆ addCallSite()

void SVF::PAG::addCallSite ( const CallBlockNode * call )

inline

Definition at line 197 of file PAG.h.

     {
         callSiteSet.insert(call);
     }

◆ addCallSiteArgs()

void SVF::PAG::addCallSiteArgs	(	CallBlockNode *	callBlockNode,
		const PAGNode *	arg
	)

inline

Add callsite arguments.

Definition at line 333 of file PAG.h.

     {
         callBlockNode->addActualParms(arg);
         callSiteArgsListMap[callBlockNode].push_back(arg);
     }

◆ addCallSiteRets()

void SVF::PAG::addCallSiteRets	(	RetBlockNode *	retBlockNode,
		const PAGNode *	arg
	)

inline

Add callsite returns.

Definition at line 339 of file PAG.h.

     {
         retBlockNode->addActualRet(arg);
         callSiteRetMap[retBlockNode]= arg;
     }

◆ addCmpNode()

void SVF::PAG::addCmpNode	(	const PAGNode *	res,
		const CmpPE *	edge
	)

inline

Add phi node information.

Definition at line 300 of file PAG.h.

     {
         cmpNodeMap[res].push_back(edge);
     }

◆ addCmpPE()

CmpPE * PAG::addCmpPE	(	NodeID	src,
		NodeID	dst
	)

Add Copy edge.

Add Compare edge

Definition at line 407 of file PAG.cpp.

 {
     PAGNode* srcNode = getPAGNode(src);
     PAGNode* dstNode = getPAGNode(dst);
     if(PAGEdge* edge = hasNonlabeledEdge(srcNode,dstNode, PAGEdge::Cmp))
         return SVFUtil::cast<CmpPE>(edge);
     else
     {
         CmpPE* cmp = new CmpPE(srcNode, dstNode);
         addEdge(srcNode,dstNode, cmp);
         return cmp;
     }
 }

◆ addConstantObjNode()

NodeID SVF::PAG::addConstantObjNode ( )

inline

Definition at line 761 of file PAG.h.

     {
         return addObjNode(nullptr, new DummyObjPN(getConstantNode(),getConstantObj()), getConstantNode());
     }

◆ addCopyPE()

CopyPE * PAG::addCopyPE	(	NodeID	src,
		NodeID	dst
	)

Add Copy edge.

Add Copy edge

Definition at line 390 of file PAG.cpp.

 {
     PAGNode* srcNode = getPAGNode(src);
     PAGNode* dstNode = getPAGNode(dst);
     if(PAGEdge* edge = hasNonlabeledEdge(srcNode,dstNode, PAGEdge::Copy))
         return SVFUtil::cast<CopyPE>(edge);
     else
     {
         CopyPE* copyPE = new CopyPE(srcNode, dstNode);
         addEdge(srcNode,dstNode, copyPE);
         return copyPE;
     }
 }

◆ addDummyMemObj()

const MemObj* SVF::PAG::addDummyMemObj	(	NodeID	i,
		const Type *	type
	)

inline

Definition at line 753 of file PAG.h.

     {
         return SymbolTableInfo::SymbolInfo()->createDummyObj(i,type);
     }

◆ addDummyObjNode() [1/2]

NodeID SVF::PAG::addDummyObjNode ( const Type * type = nullptr )

inline

Definition at line 744 of file PAG.h.

     {
         return addDummyObjNode(NodeIDAllocator::get()->allocateObjectId(), type);
     }

◆ addDummyObjNode() [2/2]

NodeID SVF::PAG::addDummyObjNode	(	NodeID	i,
		const Type *	type
	)

inline

Definition at line 748 of file PAG.h.

     {
         const MemObj* mem = addDummyMemObj(i, type);
         return addObjNode(nullptr, new DummyObjPN(i,mem), i);
     }

◆ addDummyValNode() [1/2]

NodeID SVF::PAG::addDummyValNode ( )

inline

Add a dummy value/object node according to node ID (llvm value is null)

Definition at line 736 of file PAG.h.

     {
         return addDummyValNode(NodeIDAllocator::get()->allocateValueId());
     }

◆ addDummyValNode() [2/2]

NodeID SVF::PAG::addDummyValNode ( NodeID i )

inline

Definition at line 740 of file PAG.h.

     {
         return addValNode(nullptr, new DummyValPN(i), i);
     }

◆ addEdge()

bool PAG::addEdge	(	PAGNode *	src,
		PAGNode *	dst,
		PAGEdge *	edge
	)

Add an edge into PAG.

Add a PAG edge

Add a PAG edge into edge map

Definition at line 754 of file PAG.cpp.

 {
 
     DBOUT(DPAGBuild,
           outs() << "add edge from " << src->getId() << " kind :"
           << src->getNodeKind() << " to " << dst->getId()
           << " kind :" << dst->getNodeKind() << "\n");
     src->addOutEdge(edge);
     dst->addInEdge(edge);
     bool added = PAGEdgeKindToSetMap[edge->getEdgeKind()].insert(edge).second;
     assert(added && "duplicated edge, not added!!!");
     if (edge->isPTAEdge())
     {
         totalPTAPAGEdge++;
         PTAPAGEdgeKindToSetMap[edge->getEdgeKind()].insert(edge);
     }
     return true;
 }

◆ addFIObjNode()

NodeID PAG::addFIObjNode ( const MemObj * obj )

Add a field-insensitive node, this method can only invoked by getFIGepObjNode.

Add a field-insensitive node, this method can only invoked by getFIGepObjNode

Definition at line 712 of file PAG.cpp.

 {
     //assert(findPAGNode(i) == false && "this node should not be created before");
     NodeID base = getObjectNode(obj);
     memToFieldsMap[base].set(obj->getSymId());
     FIObjPN *node = new FIObjPN(obj->getRefVal(), obj->getSymId(), obj);
     return addObjNode(obj->getRefVal(), node, obj->getSymId());
 }

◆ addFunArgs()

void SVF::PAG::addFunArgs	(	const SVFFunction *	fun,
		const PAGNode *	arg
	)

inline

Get/set method for function/callsite arguments and returns.

Add function arguments

Definition at line 319 of file PAG.h.

     {
         FunEntryBlockNode* funEntryBlockNode = icfg->getFunEntryBlockNode(fun);
         funEntryBlockNode->addFormalParms(arg);
         funArgsListMap[fun].push_back(arg);
     }

◆ addFunRet()

void SVF::PAG::addFunRet	(	const SVFFunction *	fun,
		const PAGNode *	ret
	)

inline

Add function returns.

Definition at line 326 of file PAG.h.

     {
         FunExitBlockNode* funExitBlockNode = icfg->getFunExitBlockNode(fun);
         funExitBlockNode->addFormalRet(ret);
         funRetMap[fun] = ret;
     }

◆ addGepObjNode()

NodeID PAG::addGepObjNode	(	const MemObj *	obj,
		const LocationSet &	ls
	)

Add a field obj node, this method can only invoked by getGepObjNode.

Add a field obj node, this method can only invoked by getGepObjNode

Definition at line 695 of file PAG.cpp.

 {
     //assert(findPAGNode(i) == false && "this node should not be created before");
     NodeID base = getObjectNode(obj);
     assert(0==GepObjNodeMap.count(std::make_pair(base, ls))
            && "this node should not be created before");
 
     NodeID gepId = NodeIDAllocator::get()->allocateGepObjectId(base, ls.getOffset(), StInfo::getMaxFieldLimit());
     GepObjNodeMap[std::make_pair(base, ls)] = gepId;
     GepObjPN *node = new GepObjPN(obj, gepId, ls);
     memToFieldsMap[base].set(gepId);
     return addObjNode(obj->getRefVal(), node, gepId);
 }

◆ addGepPE()

GepPE * PAG::addGepPE	(	NodeID	src,
		NodeID	dst,
		const LocationSet &	ls,
		bool	constGep
	)

Add Gep edge.

Add Offset(Gep) edge Find the base node id of src and connect base node to dst node Create gep offset: (offset + baseOff <nested struct="" gep="" size>="">)

Since the offset from base to src is variant, the new gep edge being created is also a VariantGepPE edge.

Definition at line 576 of file PAG.cpp.

 {
 
     PAGNode* node = getPAGNode(src);
     if (!constGep || node->hasIncomingVariantGepEdge())
     {
         return addVariantGepPE(src, dst);
     }
     else
     {
         return addNormalGepPE(src, dst, ls);
     }
 }

◆ addGepValNode()

NodeID PAG::addGepValNode	(	const Value *	curInst,
		const Value *	gepVal,
		const LocationSet &	ls,
		NodeID	i,
		const Type *	type,
		u32_t	fieldidx
	)

Add a temp field value node, this method can only invoked by getGepValNode.

Add a temp field value node, this method can only invoked by getGepValNode due to constaint expression, curInst is used to distinguish different instructions (e.g., memorycpy) when creating GepValPN.

Definition at line 635 of file PAG.cpp.

 {
     NodeID base = getBaseValNode(getValueNode(gepVal));
     //assert(findPAGNode(i) == false && "this node should not be created before");
     assert(0==GepValNodeMap[curInst].count(std::make_pair(base, ls))
            && "this node should not be created before");
     GepValNodeMap[curInst][std::make_pair(base, ls)] = i;
     GepValPN *node = new GepValPN(gepVal, i, ls, type, fieldidx);
     return addValNode(gepVal, node, i);
 }

◆ addGlobalPAGEdge()

void SVF::PAG::addGlobalPAGEdge ( const PAGEdge * edge )

inline

Get global PAGEdges (not in a procedure)

Definition at line 245 of file PAG.h.

     {
         globPAGEdgesSet.insert(edge);
     }

◆ addIndirectCallsites()

void SVF::PAG::addIndirectCallsites	(	const CallBlockNode *	cs,
		NodeID	funPtr
	)

inline

Definition at line 462 of file PAG.h.

     {
         bool added = indCallSiteToFunPtrMap.insert(std::make_pair(cs,funPtr)).second;
         funPtrToCallSitesMap[funPtr].insert(cs);
         assert(added && "adding the same indirect callsite twice?");
     }

◆ addLoadPE()

LoadPE * PAG::addLoadPE	(	NodeID	src,
		NodeID	dst
	)

Add Load edge.

Add Load edge

Definition at line 459 of file PAG.cpp.

 {
     PAGNode* srcNode = getPAGNode(src);
     PAGNode* dstNode = getPAGNode(dst);
     if(PAGEdge* edge = hasNonlabeledEdge(srcNode,dstNode, PAGEdge::Load))
         return SVFUtil::cast<LoadPE>(edge);
     else
     {
         LoadPE* loadPE = new LoadPE(srcNode, dstNode);
         addEdge(srcNode,dstNode, loadPE);
         return loadPE;
     }
 }

◆ addNode()

NodeID SVF::PAG::addNode	(	PAGNode *	node,
		NodeID	i
	)

inline

add node into PAG

Add a PAG node into Node map

Definition at line 695 of file PAG.h.

     {
         addGNode(i,node);
         return i;
     }

◆ addNormalGepPE()

NormalGepPE * PAG::addNormalGepPE	(	NodeID	src,
		NodeID	dst,
		const LocationSet &	ls
	)

Add Offset(Gep) edge.

Add normal (Gep) edge

Definition at line 595 of file PAG.cpp.

 {
     const LocationSet& baseLS = getLocationSetFromBaseNode(src);
     PAGNode* baseNode = getPAGNode(getBaseValNode(src));
     PAGNode* dstNode = getPAGNode(dst);
     if(PAGEdge* edge = hasNonlabeledEdge(baseNode, dstNode, PAGEdge::NormalGep))
         return SVFUtil::cast<NormalGepPE>(edge);
     else
     {
         NormalGepPE* gepPE = new NormalGepPE(baseNode, dstNode, ls+baseLS);
         addEdge(baseNode, dstNode, gepPE);
         return gepPE;
     }
 }

◆ addObjNode() [1/2]

NodeID SVF::PAG::addObjNode	(	const Value *	val,
		NodeID	i
	)

inline

Add a memory obj node.

Definition at line 707 of file PAG.h.

     {
         MemObj* mem = symInfo->getObj(symInfo->getObjSym(val));
         assert(((mem->getSymId() == i) || (symInfo->getGlobalRep(val)!=val)) && "not same object id?");
         return addFIObjNode(mem);
     }

◆ addObjNode() [2/2]

NodeID SVF::PAG::addObjNode	(	const Value *	,
		PAGNode *	node,
		NodeID	i
	)

inline

Add a memory obj node.

Definition at line 778 of file PAG.h.

     {
         assert(hasGNode(i) == false && "This NodeID clashes here. Please check NodeIDAllocator. Switch Strategy::DEBUG to SEQ or DENSE");
         return addNode(node,i);
     }

◆ addPhiNode()

void SVF::PAG::addPhiNode	(	const PAGNode *	res,
		const CopyPE *	edge
	)

inline

Add phi node information.

Definition at line 255 of file PAG.h.

     {
         phiNodeMap[res].push_back(edge);
     }

◆ addRetNode() [1/2]

NodeID SVF::PAG::addRetNode	(	const SVFFunction *	val,
		NodeID	i
	)

inline

Add a unique return node for a procedure.

Definition at line 714 of file PAG.h.

     {
         PAGNode *node = new RetPN(val,i);
         return addRetNode(val, node, i);
     }

◆ addRetNode() [2/2]

NodeID SVF::PAG::addRetNode	(	const SVFFunction *	,
		PAGNode *	node,
		NodeID	i
	)

inline

Add a unique return node for a procedure.

Definition at line 784 of file PAG.h.

     {
         return addNode(node,i);
     }

◆ addRetPE()

RetPE * PAG::addRetPE	(	NodeID	src,
		NodeID	dst,
		const CallBlockNode *	cs
	)

Add Return edge.

Add Return edge

Definition at line 511 of file PAG.cpp.

 {
     PAGNode* srcNode = getPAGNode(src);
     PAGNode* dstNode = getPAGNode(dst);
     if(PAGEdge* edge = hasLabeledEdge(srcNode,dstNode, PAGEdge::Ret, cs))
         return SVFUtil::cast<RetPE>(edge);
     else
     {
         RetPE* retPE = new RetPE(srcNode, dstNode, cs);
         addEdge(srcNode,dstNode, retPE);
         return retPE;
     }
 }

◆ addStorePE()

StorePE * PAG::addStorePE	(	NodeID	src,
		NodeID	dst,
		const IntraBlockNode *	curVal
	)

Add Store edge.

Add Store edge Note that two store instructions may share the same Store PAGEdge

Definition at line 477 of file PAG.cpp.

 {
     PAGNode* srcNode = getPAGNode(src);
     PAGNode* dstNode = getPAGNode(dst);
     if(PAGEdge* edge = hasLabeledEdge(srcNode,dstNode, PAGEdge::Store, curVal))
         return SVFUtil::cast<StorePE>(edge);
     else
     {
         StorePE* storePE = new StorePE(srcNode, dstNode, curVal);
         addEdge(srcNode,dstNode, storePE);
         return storePE;
     }
 }

◆ addThreadForkPE()

TDForkPE * PAG::addThreadForkPE	(	NodeID	src,
		NodeID	dst,
		const CallBlockNode *	cs
	)

Add Thread fork edge for parameter passing.

Add Thread fork edge for parameter passing from a spawner to its spawnees

Definition at line 539 of file PAG.cpp.

 {
     PAGNode* srcNode = getPAGNode(src);
     PAGNode* dstNode = getPAGNode(dst);
     if(PAGEdge* edge = hasLabeledEdge(srcNode,dstNode, PAGEdge::ThreadFork, cs))
         return SVFUtil::cast<TDForkPE>(edge);
     else
     {
         TDForkPE* forkPE = new TDForkPE(srcNode, dstNode, cs);
         addEdge(srcNode,dstNode, forkPE);
         return forkPE;
     }
 }

◆ addThreadJoinPE()

TDJoinPE * PAG::addThreadJoinPE	(	NodeID	src,
		NodeID	dst,
		const CallBlockNode *	cs
	)

Add Thread join edge for parameter passing.

Add Thread fork edge for parameter passing from a spawnee back to its spawners

Definition at line 556 of file PAG.cpp.

 {
     PAGNode* srcNode = getPAGNode(src);
     PAGNode* dstNode = getPAGNode(dst);
     if(PAGEdge* edge = hasLabeledEdge(srcNode,dstNode, PAGEdge::ThreadJoin, cs))
         return SVFUtil::cast<TDJoinPE>(edge);
     else
     {
         TDJoinPE* joinPE = new TDJoinPE(srcNode, dstNode, cs);
         addEdge(srcNode,dstNode, joinPE);
         return joinPE;
     }
 }

◆ addToInstPAGEdgeList()

void SVF::PAG::addToInstPAGEdgeList	(	ICFGNode *	inst,
		PAGEdge *	edge
	)

inline

Add a PAGEdge into instruction map.

Definition at line 237 of file PAG.h.

     {
         edge->setICFGNode(inst);
         inst2PAGEdgesMap[inst].push_back(edge);
         if (edge->isPTAEdge())
             inst2PTAPAGEdgesMap[inst].push_back(edge);
     }

◆ addUnaryNode()

void SVF::PAG::addUnaryNode	(	const PAGNode *	res,
		const UnaryOPPE *	edge
	)

inline

Add unary node information.

Definition at line 285 of file PAG.h.

     {
         unaryNodeMap[res].push_back(edge);
     }

◆ addUnaryOPPE()

UnaryOPPE * PAG::addUnaryOPPE	(	NodeID	src,
		NodeID	dst
	)

Add Unary edge.

Add Unary edge

Definition at line 442 of file PAG.cpp.

 {
     PAGNode* srcNode = getPAGNode(src);
     PAGNode* dstNode = getPAGNode(dst);
     if(PAGEdge* edge = hasNonlabeledEdge(srcNode,dstNode, PAGEdge::UnaryOp))
         return SVFUtil::cast<UnaryOPPE>(edge);
     else
     {
         UnaryOPPE* unaryOP = new UnaryOPPE(srcNode, dstNode);
         addEdge(srcNode,dstNode, unaryOP);
         return unaryOP;
     }
 }

◆ addValNode() [1/2]

NodeID SVF::PAG::addValNode	(	const Value *	val,
		NodeID	i
	)

inline

Add a value (pointer) node.

Definition at line 701 of file PAG.h.

     {
         PAGNode *node = new ValPN(val,i);
         return addValNode(val, node, i);
     }

◆ addValNode() [2/2]

NodeID SVF::PAG::addValNode	(	const Value *	,
		PAGNode *	node,
		NodeID	i
	)

inline

Add a value (pointer) node.

Definition at line 772 of file PAG.h.

     {
         assert(hasGNode(i) == false && "This NodeID clashes here. Please check NodeIDAllocator. Switch Strategy::DEBUG to SEQ or DENSE");
         return addNode(node,i);
     }

◆ addVarargNode() [1/2]

NodeID SVF::PAG::addVarargNode	(	const SVFFunction *	val,
		NodeID	i
	)

inline

Add a unique vararg node for a procedure.

Definition at line 720 of file PAG.h.

     {
         PAGNode *node = new VarArgPN(val,i);
         return addNode(node,i);
     }

◆ addVarargNode() [2/2]

NodeID SVF::PAG::addVarargNode	(	const SVFFunction *	,
		PAGNode *	node,
		NodeID	i
	)

inline

Add a unique vararg node for a procedure.

Definition at line 789 of file PAG.h.

     {
         return addNode(node,i);
     }

◆ addVariantGepPE()

VariantGepPE * PAG::addVariantGepPE	(	NodeID	src,
		NodeID	dst
	)

Add Variant(Gep) edge.

Add variant(Gep) edge Find the base node id of src and connect base node to dst node

Definition at line 614 of file PAG.cpp.

 {
 
     PAGNode* baseNode = getPAGNode(getBaseValNode(src));
     PAGNode* dstNode = getPAGNode(dst);
     if(PAGEdge* edge = hasNonlabeledEdge(baseNode, dstNode, PAGEdge::VariantGep))
         return SVFUtil::cast<VariantGepPE>(edge);
     else
     {
         VariantGepPE* gepPE = new VariantGepPE(baseNode, dstNode);
         addEdge(baseNode, dstNode, gepPE);
         return gepPE;
     }
 }

◆ callsiteHasRet()

bool SVF::PAG::callsiteHasRet ( const RetBlockNode * cs ) const

inline

Definition at line 390 of file PAG.h.

     {
         return callSiteRetMap.find(cs) != callSiteRetMap.end();
     }

◆ destroy()

void PAG::destroy ( )

private

Clean up memory.

Clean up memory

Definition at line 866 of file PAG.cpp.

 {
     for (PAGEdge::PAGKindToEdgeSetMapTy::iterator I =
                 PAGEdgeKindToSetMap.begin(), E = PAGEdgeKindToSetMap.end(); I != E;
             ++I)
     {
         for (PAGEdge::PAGEdgeSetTy::iterator edgeIt = I->second.begin(),
                 endEdgeIt = I->second.end(); edgeIt != endEdgeIt; ++edgeIt)
         {
             delete *edgeIt;
         }
     }
     SymbolTableInfo::releaseSymbolInfo();
     symInfo = nullptr;
 }

◆ dump()

void PAG::dump ( std::string name )

Dump PAG.

Dump this PAG

Definition at line 1081 of file PAG.cpp.

 {
     GraphPrinter::WriteGraphToFile(outs(), name, this);
 }

◆ findPAGNode()

bool SVF::PAG::findPAGNode ( NodeID id ) const

inline

Get a pag node according to its ID.

Definition at line 491 of file PAG.h.

     {
         return hasGNode(id);
     }

◆ funHasRet()

bool SVF::PAG::funHasRet ( const SVFFunction * func ) const

inline

Definition at line 406 of file PAG.h.

     {
         return funRetMap.find(func) != funRetMap.end();
     }

◆ getAllFieldsObjNode() [1/2]

NodeBS & PAG::getAllFieldsObjNode ( const MemObj * obj )

Get all fields of an object.

Get all fields object nodes of an object

Definition at line 776 of file PAG.cpp.

 {
     NodeID base = getObjectNode(obj);
     return memToFieldsMap[base];
 }

◆ getAllFieldsObjNode() [2/2]

NodeBS & PAG::getAllFieldsObjNode ( NodeID id )

Get all fields object nodes of an object

Definition at line 785 of file PAG.cpp.

 {
     const PAGNode* node = pag->getPAGNode(id);
     assert(SVFUtil::isa<ObjPN>(node) && "need an object node");
     const ObjPN* obj = SVFUtil::cast<ObjPN>(node);
     return getAllFieldsObjNode(obj->getMemObj());
 }

◆ getAllValidPtrs()

OrderedNodeSet& SVF::PAG::getAllValidPtrs ( )

inline

Return valid pointers.

Definition at line 139 of file PAG.h.

     {
         return candidatePointers;
     }

◆ getBaseObj()

const MemObj* SVF::PAG::getBaseObj ( NodeID id ) const

inline

Definition at line 676 of file PAG.h.

     {
         const PAGNode* node = pag->getPAGNode(id);
         assert(SVFUtil::isa<ObjPN>(node) && "need an object node");
         const ObjPN* obj = SVFUtil::cast<ObjPN>(node);
         return obj->getMemObj();
     }

◆ getBaseObjNode()

NodeID SVF::PAG::getBaseObjNode ( NodeID id ) const

inline

Definition at line 672 of file PAG.h.

     {
         return getBaseObj(id)->getSymId();
     }

◆ getBaseValNode()

NodeID PAG::getBaseValNode ( NodeID nodeId )

Base and Offset methods for Value and Object node.

Get a base pointer node given a field pointer

Get a base pointer given a pointer Return the source node of its connected gep edge if this pointer has Otherwise return the node id itself

Definition at line 818 of file PAG.cpp.

 {
     PAGNode* node  = getPAGNode(nodeId);
     if (node->hasIncomingEdges(PAGEdge::NormalGep) ||  node->hasIncomingEdges(PAGEdge::VariantGep))
     {
         PAGEdge::PAGEdgeSetTy& ngeps = node->getIncomingEdges(PAGEdge::NormalGep);
         PAGEdge::PAGEdgeSetTy& vgeps = node->getIncomingEdges(PAGEdge::VariantGep);
 
         assert(((ngeps.size()+vgeps.size())==1) && "one node can only be connected by at most one gep edge!");
 
         PAGNode::iterator it;
         if(!ngeps.empty())
             it = ngeps.begin();
         else
             it = vgeps.begin();
 
         assert(SVFUtil::isa<GepPE>(*it) && "not a gep edge??");
         return (*it)->getSrcID();
     }
     else
         return nodeId;
 }

◆ getBinaryNodeMap()

BinaryNodeMap& SVF::PAG::getBinaryNodeMap ( )

inline

Get all phi copy edges.

Definition at line 280 of file PAG.h.

     {
         return binaryNodeMap;
     }

◆ getBlackHoleNode()

NodeID SVF::PAG::getBlackHoleNode ( ) const

inline

Get black hole and constant id.

Definition at line 589 of file PAG.h.

     {
         return symInfo->blackholeSymID();
     }

◆ getBlackHoleObj()

const MemObj* SVF::PAG::getBlackHoleObj ( ) const

inline

Definition at line 648 of file PAG.h.

     {
         return symInfo->getBlkObj();
     }

◆ getBlkPtr()

NodeID SVF::PAG::getBlkPtr ( ) const

inline

Definition at line 597 of file PAG.h.

     {
         return symInfo->blkPtrSymID();
     }

◆ getCallSiteArgsList()

const PAGNodeList& SVF::PAG::getCallSiteArgsList ( const CallBlockNode * cs ) const

inline

Get callsite argument list.

Definition at line 372 of file PAG.h.

     {
         CSToArgsListMap::const_iterator it = callSiteArgsListMap.find(cs);
         assert(it != callSiteArgsListMap.end() && "this call site doesn't have arguments");
         return it->second;
     }

◆ getCallSiteArgsMap()

CSToArgsListMap& SVF::PAG::getCallSiteArgsMap ( )

inline

Get callsite argument list.

Definition at line 367 of file PAG.h.

     {
         return callSiteArgsListMap;
     }

◆ getCallSiteRet()

const PAGNode* SVF::PAG::getCallSiteRet ( const RetBlockNode * cs ) const

inline

Get callsite return.

Definition at line 384 of file PAG.h.

     {
         CSToRetMap::const_iterator it = callSiteRetMap.find(cs);
         assert(it != callSiteRetMap.end() && "this call site doesn't have return");
         return it->second;
     }

◆ getCallSiteRets()

CSToRetMap& SVF::PAG::getCallSiteRets ( )

inline

Get callsite return.

Definition at line 379 of file PAG.h.

     {
         return callSiteRetMap;
     }

◆ getCallSiteSet()

const CallSiteSet& SVF::PAG::getCallSiteSet ( ) const

inline

Definition at line 201 of file PAG.h.

     {
         return callSiteSet;
     }

◆ getCmpNodeMap()

CmpNodeMap& SVF::PAG::getCmpNodeMap ( )

inline

Get all phi copy edges.

Definition at line 310 of file PAG.h.

     {
         return cmpNodeMap;
     }

◆ getConstantNode()

NodeID SVF::PAG::getConstantNode ( ) const

inline

Definition at line 593 of file PAG.h.

     {
         return symInfo->constantSymID();
     }

◆ getConstantObj()

const MemObj* SVF::PAG::getConstantObj ( ) const

inline

Definition at line 652 of file PAG.h.

     {
         return symInfo->getConstantObj();
     }

◆ getEdgeSet()

PAGEdge::PAGEdgeSetTy& SVF::PAG::getEdgeSet ( PAGEdge::PEDGEK kind )

inline

Get/set methods to get control flow information of a PAGEdge.

Get edges set according to its kind

Definition at line 208 of file PAG.h.

     {
         return PAGEdgeKindToSetMap[kind];
     }

◆ getFieldObjNodeNum()

Size_t SVF::PAG::getFieldObjNodeNum ( ) const

inline

Definition at line 434 of file PAG.h.

     {
         return GepObjNodeMap.size();
     }

◆ getFieldsAfterCollapse()

NodeBS PAG::getFieldsAfterCollapse ( NodeID id )

Get all fields object nodes of an object If this object is collapsed into one field insensitive object Then only return this field insensitive object

Definition at line 798 of file PAG.cpp.

 {
     const PAGNode* node = pag->getPAGNode(id);
     assert(SVFUtil::isa<ObjPN>(node) && "need an object node");
     const MemObj* mem = SVFUtil::cast<ObjPN>(node)->getMemObj();
     if(mem->isFieldInsensitive())
     {
         NodeBS bs;
         bs.set(getFIObjNode(mem));
         return bs;
     }
     else
         return getAllFieldsObjNode(mem);
 }

◆ getFieldValNodeNum()

Size_t SVF::PAG::getFieldValNodeNum ( ) const

inline

Definition at line 430 of file PAG.h.

     {
         return GepValNodeMap.size();
     }

◆ getFIObjNode() [1/2]

NodeID SVF::PAG::getFIObjNode ( const MemObj * obj ) const

inline

Get a field-insensitive obj PAG node according to a mem obj.

Definition at line 574 of file PAG.h.

     {
         return obj->getSymId();
     }

◆ getFIObjNode() [2/2]

NodeID SVF::PAG::getFIObjNode ( NodeID id ) const

inline

Definition at line 578 of file PAG.h.

     {
         PAGNode* node = pag->getPAGNode(id);
         assert(SVFUtil::isa<ObjPN>(node) && "need an object node");
         ObjPN* obj = SVFUtil::cast<ObjPN>(node);
         return getFIObjNode(obj->getMemObj());
     }

◆ getFunArgsList()

const PAGNodeList& SVF::PAG::getFunArgsList ( const SVFFunction * func ) const

inline

Get function arguments list.

Definition at line 355 of file PAG.h.

     {
         FunToArgsListMap::const_iterator it = funArgsListMap.find(func);
         assert(it != funArgsListMap.end() && "this function doesn't have arguments");
         return it->second;
     }

◆ getFunArgsMap()

FunToArgsListMap& SVF::PAG::getFunArgsMap ( )

inline

Get function arguments list.

Definition at line 350 of file PAG.h.

     {
         return funArgsListMap;
     }

◆ getFunPtr()

NodeID SVF::PAG::getFunPtr ( const CallBlockNode * cs ) const

inline

Definition at line 468 of file PAG.h.

     {
         CallSiteToFunPtrMap::const_iterator it = indCallSiteToFunPtrMap.find(cs);
         assert(it!=indCallSiteToFunPtrMap.end() && "indirect callsite not have a function pointer?");
         return it->second;
     }

◆ getFunRet()

const PAGNode* SVF::PAG::getFunRet ( const SVFFunction * func ) const

inline

Get function return list.

Definition at line 400 of file PAG.h.

     {
         FunToRetMap::const_iterator it = funRetMap.find(func);
         assert(it != funRetMap.end() && "this function doesn't have return");
         return it->second;
     }

◆ getFunRets()

FunToRetMap& SVF::PAG::getFunRets ( )

inline

Get function return list.

Definition at line 395 of file PAG.h.

     {
         return funRetMap;
     }

◆ getGepObjNode() [1/2]

NodeID PAG::getGepObjNode	(	const MemObj *	obj,
		const LocationSet &	ls
	)

Get a field PAG Object node according to base mem obj and offset.

Get a field obj PAG node according to base mem obj and offset To support flexible field sensitive analysis with regard to MaxFieldOffset offset = offset % obj->getMaxFieldOffsetLimit() to create limited number of mem objects maximum number of field object creation is obj->getMaxFieldOffsetLimit()

if this obj is field-insensitive, just return the field-insensitive node.

Definition at line 671 of file PAG.cpp.

 {
     NodeID base = getObjectNode(obj);
 
     if (obj->isFieldInsensitive())
         return getFIObjNode(obj);
 
     LocationSet newLS = SymbolTableInfo::SymbolInfo()->getModulusOffset(obj,ls);
 
     // Base and first field are the same memory location.
     if (Options::FirstFieldEqBase && newLS.getOffset() == 0) return base;
 
     NodeLocationSetMap::iterator iter = GepObjNodeMap.find(std::make_pair(base, newLS));
     if (iter == GepObjNodeMap.end())
         return addGepObjNode(obj, newLS);
     else
         return iter->second;
 
 }

◆ getGepObjNode() [2/2]

NodeID PAG::getGepObjNode	(	NodeID	id,
		const LocationSet &	ls
	)

Get a field obj PAG node according to a mem obj and a given offset.

Given an object node, find its field object node

Definition at line 649 of file PAG.cpp.

 {
     PAGNode* node = pag->getPAGNode(id);
     if (GepObjPN* gepNode = SVFUtil::dyn_cast<GepObjPN>(node))
         return getGepObjNode(gepNode->getMemObj(), gepNode->getLocationSet() + ls);
     else if (FIObjPN* baseNode = SVFUtil::dyn_cast<FIObjPN>(node))
         return getGepObjNode(baseNode->getMemObj(), ls);
     else if (DummyObjPN* baseNode = SVFUtil::dyn_cast<DummyObjPN>(node))
         return getGepObjNode(baseNode->getMemObj(), ls);
     else
     {
         assert(false && "new gep obj node kind?");
         return id;
     }
 }

◆ getGepObjNodeMap()

NodeLocationSetMap& SVF::PAG::getGepObjNodeMap ( )

inline

Return GepObjNodeMap.

Definition at line 127 of file PAG.h.

     {
         return GepObjNodeMap;
     }

◆ getGepValNode()

NodeID SVF::PAG::getGepValNode	(	const Value *	curInst,
		NodeID	base,
		const LocationSet &	ls
	)		const

inline

Due to constaint expression, curInst is used to distinguish different instructions (e.g., memorycpy) when creating GepValPN.

Definition at line 441 of file PAG.h.

     {
         GepValPNMap::const_iterator iter = GepValNodeMap.find(curInst);
         if(iter==GepValNodeMap.end()){
             return UINT_MAX;
         }
         else{
             NodeLocationSetMap::const_iterator lit = iter->second.find(std::make_pair(base, ls));
             if(lit==iter->second.end())
                 return UINT_MAX;
             else
                 return lit->second;
         }
     }

◆ getGlobalPAGEdgeSet()

PAGEdgeSet& SVF::PAG::getGlobalPAGEdgeSet ( )

inline

Get global PAGEdges (not in a procedure)

Definition at line 250 of file PAG.h.

     {
         return globPAGEdgesSet;
     }

◆ getGraphName()

std::string SVF::PAG::getGraphName ( ) const

inline

Return graph name.

Definition at line 846 of file PAG.h.

     {
         return "PAG";
     }

◆ getICFG()

ICFG* SVF::PAG::getICFG ( )

inline

Return ICFG.

Definition at line 133 of file PAG.h.

     {
         return icfg;
     }

◆ getIndCallSites()

const CallSiteSet& SVF::PAG::getIndCallSites ( NodeID funPtr ) const

inline

Definition at line 474 of file PAG.h.

     {
         FunPtrToCallSitesMap::const_iterator it = funPtrToCallSitesMap.find(funPtr);
         assert(it!=funPtrToCallSitesMap.end() && "function pointer not used at any indirect callsite?");
         return it->second;
     }

◆ getIndirectCallsites()

const CallSiteToFunPtrMap& SVF::PAG::getIndirectCallsites ( ) const

inline

Add/get indirect callsites.

Definition at line 458 of file PAG.h.

     {
         return indCallSiteToFunPtrMap;
     }

◆ getInstPAGEdgeList()

PAGEdgeList& SVF::PAG::getInstPAGEdgeList ( const ICFGNode * inst )

inline

Given an instruction, get all its PAGEdges.

Definition at line 227 of file PAG.h.

     {
         return inst2PAGEdgesMap[inst];
     }

◆ getInstPTAPAGEdgeList()

PAGEdgeList& SVF::PAG::getInstPTAPAGEdgeList ( const ICFGNode * inst )

inline

Given an instruction, get all its PTA PAGEdges.

Definition at line 232 of file PAG.h.

     {
         return inst2PTAPAGEdgesMap[inst];
     }

◆ getIntraPAGEdge() [1/2]

PAGEdge* SVF::PAG::getIntraPAGEdge	(	NodeID	src,
		NodeID	dst,
		PAGEdge::PEDGEK	kind
	)

inline

Get an edge according to src, dst and kind.

Definition at line 498 of file PAG.h.

     {
         return getIntraPAGEdge(getPAGNode(src), getPAGNode(dst), kind);
     }

◆ getIntraPAGEdge() [2/2]

PAGEdge* SVF::PAG::getIntraPAGEdge	(	PAGNode *	src,
		PAGNode *	dst,
		PAGEdge::PEDGEK	kind
	)

inline

Definition at line 502 of file PAG.h.

     {
         PAGEdge edge(src,dst,kind);
         const PAGEdge::PAGEdgeSetTy& edgeSet = getEdgeSet(kind);
         PAGEdge::PAGEdgeSetTy::const_iterator it = edgeSet.find(&edge);
         assert(it != edgeSet.end() && "can not find pag edge");
         return (*it);
     }

◆ getLocationSetFromBaseNode()

LocationSet PAG::getLocationSetFromBaseNode ( NodeID nodeId )

Get a base PAGNode given a pointer Return the source node of its connected normal gep edge Otherwise return the node id itself Size_t offset : gep offset

if this node is already a base node

Definition at line 847 of file PAG.cpp.

 {
     PAGNode* node  = getPAGNode(nodeId);
     PAGEdge::PAGEdgeSetTy& geps = node->getIncomingEdges(PAGEdge::NormalGep);
     if(geps.empty())
         return LocationSet(0);
 
     assert(geps.size()==1 && "one node can only be connected by at most one gep edge!");
     PAGNode::iterator it = geps.begin();
     const PAGEdge* edge = *it;
     assert(SVFUtil::isa<NormalGepPE>(edge) && "not a get edge??");
     const NormalGepPE* gepEdge = SVFUtil::cast<NormalGepPE>(edge);
     return gepEdge->getLocationSet();
 }

◆ getMemToFieldsMap()

MemObjToFieldsMap& SVF::PAG::getMemToFieldsMap ( )

inline

Return memToFieldsMap.

Definition at line 121 of file PAG.h.

     {
         return memToFieldsMap;
     }

◆ getModule()

SVFModule* SVF::PAG::getModule ( )

inline

Get LLVM Module.

Definition at line 193 of file PAG.h.

     {
         return SymbolTableInfo::SymbolInfo()->getModule();
     }

◆ getNodeNumAfterPAGBuild()

u32_t SVF::PAG::getNodeNumAfterPAGBuild ( ) const

inline

Definition at line 658 of file PAG.h.

     {
         return nodeNumAfterPAGBuild;
     }

◆ getNullPtr()

NodeID SVF::PAG::getNullPtr ( ) const

inline

Definition at line 601 of file PAG.h.

     {
         return symInfo->nullPtrSymID();
     }

◆ getObject() [1/2]

const MemObj* SVF::PAG::getObject ( NodeID id ) const

inline

Get memory object - Return memory object according to pag node id return whole allocated memory object if this node is a gep obj node return nullptr is this node is not a ObjPN type

Definition at line 544 of file PAG.h.

     {
         const PAGNode* node = getPAGNode(id);
         if(const ObjPN* objPN = SVFUtil::dyn_cast<ObjPN>(node))
             return getObject(objPN);
         else
             return nullptr;
     }

◆ getObject() [2/2]

const MemObj* SVF::PAG::getObject ( const ObjPN * node ) const

inline

Definition at line 552 of file PAG.h.

     {
         return node->getMemObj();
     }

◆ getObjectNode() [1/2]

NodeID SVF::PAG::getObjectNode ( const Value * V )

inline

getObject - Return the obj node id refer to the memory object for the specified global, heap or alloca instruction according to llvm value.

Definition at line 531 of file PAG.h.

     {
         return symInfo->getObjSym(V);
     }

◆ getObjectNode() [2/2]

NodeID SVF::PAG::getObjectNode ( const MemObj * mem )

inline

getObject - return mem object id

Definition at line 536 of file PAG.h.

     {
         return mem->getSymId();
     }

◆ getObjectNodeNum()

Size_t SVF::PAG::getObjectNodeNum ( ) const

inline

Definition at line 426 of file PAG.h.

     {
         return symInfo->idToObjMap().size();
     }

◆ getPAG()

static PAG* SVF::PAG::getPAG ( bool buildFromFile = false )

inlinestatic

Singleton design here to make sure we only have one instance during any analysis.

Definition at line 160 of file PAG.h.

     {
         if (pag == nullptr)
         {
             pag = new PAG(buildFromFile);
         }
         return pag;
     }

◆ getPAGEdgeNum()

Size_t SVF::PAG::getPAGEdgeNum ( ) const

inline

Definition at line 418 of file PAG.h.

     {
         return edgeNum;
     }

◆ getPAGNode()

PAGNode* SVF::PAG::getPAGNode ( NodeID id ) const

inline

Get PAGNode ID.

Definition at line 513 of file PAG.h.

     {
         return getGNode(id);
     }

◆ getPAGNodeNum()

Size_t SVF::PAG::getPAGNodeNum ( ) const

inline

Node and edge statistics.

Definition at line 414 of file PAG.h.

     {
         return nodeNum;
     }

◆ getPhiNodeMap()

PHINodeMap& SVF::PAG::getPhiNodeMap ( )

inline

Get all phi copy edges.

Definition at line 265 of file PAG.h.

     {
         return phiNodeMap;
     }

◆ getPTAEdgeSet()

PAGEdge::PAGEdgeSetTy& SVF::PAG::getPTAEdgeSet ( PAGEdge::PEDGEK kind )

inline

Get PTA edges set according to its kind.

Definition at line 213 of file PAG.h.

     {
         return PTAPAGEdgeKindToSetMap[kind];
     }

◆ getReturnNode()

NodeID SVF::PAG::getReturnNode ( const SVFFunction * func ) const

inline

GetReturnNode - Return the unique node representing the return value of a function.

Definition at line 559 of file PAG.h.

     {
         return symInfo->getRetSym(func->getLLVMFun());
     }

◆ getUnaryNodeMap()

UnaryNodeMap& SVF::PAG::getUnaryNodeMap ( )

inline

Get all unary edges.

Definition at line 295 of file PAG.h.

     {
         return unaryNodeMap;
     }

◆ getValueNode()

NodeID SVF::PAG::getValueNode ( const Value * V )

inline

Get PAG Node according to LLVM value.

getNode - Return the node corresponding to the specified pointer.

Definition at line 521 of file PAG.h.

     {
         return symInfo->getValSym(V);
     }

◆ getValueNodeNum()

Size_t SVF::PAG::getValueNodeNum ( ) const

inline

Definition at line 422 of file PAG.h.

     {
         return symInfo->valSyms().size();
     }

◆ getVarargNode()

NodeID SVF::PAG::getVarargNode ( const SVFFunction * func ) const

inline

getVarargNode - Return the unique node representing the variadic argument of a variadic function.

Definition at line 564 of file PAG.h.

     {
         return symInfo->getVarargSym(func->getLLVMFun());
     }

◆ handleBlackHole()

void PAG::handleBlackHole ( bool b )

static

PAG build configurations.

Whether to handle blackhole edge

Definition at line 1097 of file PAG.cpp.

 {
     Options::HandBlackHole = b;
 }

◆ hasCallSiteArgsMap()

bool SVF::PAG::hasCallSiteArgsMap ( const CallBlockNode * cs ) const

inline

Callsite has argument list.

Definition at line 362 of file PAG.h.

     {
         return (callSiteArgsListMap.find(cs) != callSiteArgsListMap.end());
     }

◆ hasFunArgsList()

bool SVF::PAG::hasFunArgsList ( const SVFFunction * func ) const

inline

Function has arguments list.

Definition at line 345 of file PAG.h.

     {
         return (funArgsListMap.find(func) != funArgsListMap.end());
     }

◆ hasLabeledEdge()

PAGEdge * PAG::hasLabeledEdge	(	PAGNode *	src,
		PAGNode *	dst,
		PAGEdge::PEDGEK	kind,
		const ICFGNode *	callInst
	)

Return true if this labeled edge exits, including store, call and load two store edge can have same dst and src but located in different basic blocks, thus flags are needed to distinguish them

Return true if it is an inter-procedural edge

Definition at line 739 of file PAG.cpp.

 {
     PAGEdge edge(src,dst,PAGEdge::makeEdgeFlagWithCallInst(kind,callInst));
     PAGEdge::PAGEdgeSetTy::iterator it = PAGEdgeKindToSetMap[kind].find(&edge);
     if (it != PAGEdgeKindToSetMap[kind].end())
     {
         return *it;
     }
     return nullptr;
 }

◆ hasNonlabeledEdge()

PAGEdge * PAG::hasNonlabeledEdge	(	PAGNode *	src,
		PAGNode *	dst,
		PAGEdge::PEDGEK	kind
	)

Return true if it is an intra-procedural edge

Definition at line 725 of file PAG.cpp.

 {
     PAGEdge edge(src,dst,kind);
     PAGEdge::PAGEdgeSetTy::iterator it = PAGEdgeKindToSetMap[kind].find(&edge);
     if (it != PAGEdgeKindToSetMap[kind].end())
     {
         return *it;
     }
     return nullptr;
 }

◆ hasPAGEdgeList()

bool SVF::PAG::hasPAGEdgeList ( const ICFGNode * inst ) const

inline

Whether this instruction has PAG Edge.

Definition at line 218 of file PAG.h.

     {
         return inst2PAGEdgesMap.find(inst)!=inst2PAGEdgesMap.end();
     }

◆ hasPTAPAGEdgeList()

bool SVF::PAG::hasPTAPAGEdgeList ( const ICFGNode * inst ) const

inline

Definition at line 222 of file PAG.h.

     {
         return inst2PTAPAGEdgesMap.find(inst)!=inst2PTAPAGEdgesMap.end();
     }

◆ hasValueNode()

bool SVF::PAG::hasValueNode ( const Value * V )

inline

Definition at line 525 of file PAG.h.

     {
         return symInfo->hasValSym(V);
     }

◆ initialiseCandidatePointers()

void SVF::PAG::initialiseCandidatePointers ( )

inline

Initialize candidate pointers.

Definition at line 144 of file PAG.h.

     {
         // collect candidate pointers for demand-driven analysis
         for (iterator nIter = begin(); nIter != end(); ++nIter)
         {
             NodeID nodeId = nIter->first;
             // do not compute points-to for isolated node
             if (isValidPointer(nodeId) == false)
                 continue;
 
             candidatePointers.insert(nodeId);
         }
     }

◆ isBinaryNode()

bool SVF::PAG::isBinaryNode ( const PAGNode * node ) const

inline

Whether this PAGNode is a result operand a of phi node.

Definition at line 275 of file PAG.h.

     {
         return binaryNodeMap.find(node) != binaryNodeMap.end();
     }

◆ isBlkObj()

bool SVF::PAG::isBlkObj ( NodeID id ) const

inline

Definition at line 617 of file PAG.h.

     {
         return SymbolTableInfo::isBlkObj(id);
     }

◆ isBlkObjOrConstantObj()

bool SVF::PAG::isBlkObjOrConstantObj ( NodeID id ) const

inline

Definition at line 613 of file PAG.h.

     {
         return (isBlkObj(id) || isConstantObj(id));
     }

◆ isBlkPtr()

bool SVF::PAG::isBlkPtr ( NodeID id ) const

inline

Definition at line 605 of file PAG.h.

     {
         return (SymbolTableInfo::isBlkPtr(id));
     }

◆ isBuiltFromFile()

bool SVF::PAG::isBuiltFromFile ( )

inline

Whether this PAG built from a txt file.

Definition at line 183 of file PAG.h.

     {
         return fromFile;
     }

◆ isCmpNode()

bool SVF::PAG::isCmpNode ( const PAGNode * node ) const

inline

Whether this PAGNode is a result operand a of phi node.

Definition at line 305 of file PAG.h.

     {
         return cmpNodeMap.find(node) != cmpNodeMap.end();
     }

◆ isConstantObj()

bool SVF::PAG::isConstantObj ( NodeID id ) const

inline

Definition at line 621 of file PAG.h.

     {
         const MemObj* obj = getObject(id);
         assert(obj && "not an object node?");
         return SymbolTableInfo::isConstantObj(id) || obj->isConstant();
     }

◆ isFunPtr()

bool SVF::PAG::isFunPtr ( NodeID id ) const

inline

Definition at line 484 of file PAG.h.

     {
         return (funPtrToCallSitesMap.find(id) != funPtrToCallSitesMap.end());
     }

◆ isIndirectCallSites()

bool SVF::PAG::isIndirectCallSites ( const CallBlockNode * cs ) const

inline

Definition at line 480 of file PAG.h.

     {
         return (indCallSiteToFunPtrMap.find(cs) != indCallSiteToFunPtrMap.end());
     }

◆ isNonPointerObj()

bool SVF::PAG::isNonPointerObj ( NodeID id ) const

inline

Definition at line 627 of file PAG.h.

     {
         PAGNode* node = getPAGNode(id);
         if (FIObjPN* fiNode = SVFUtil::dyn_cast<FIObjPN>(node))
         {
             return (fiNode->getMemObj()->hasPtrObj() == false);
         }
         else if (GepObjPN* gepNode = SVFUtil::dyn_cast<GepObjPN>(node))
         {
             return (gepNode->getMemObj()->isNonPtrFieldObj(gepNode->getLocationSet()));
         }
         else if (SVFUtil::isa<DummyObjPN>(node))
         {
             return false;
         }
         else
         {
             assert(false && "expecting a object node");
             return false;
         }
     }

◆ isNullPtr()

bool SVF::PAG::isNullPtr ( NodeID id ) const

inline

Definition at line 609 of file PAG.h.

     {
         return (SymbolTableInfo::isNullPtr(id));
     }

◆ isPhiNode()

bool SVF::PAG::isPhiNode ( const PAGNode * node ) const

inline

Whether this PAGNode is a result operand a of phi node.

Definition at line 260 of file PAG.h.

     {
         return phiNodeMap.find(node) != phiNodeMap.end();
     }

◆ isUnaryNode()

bool SVF::PAG::isUnaryNode ( const PAGNode * node ) const

inline

Whether this PAGNode is an unary node.

Definition at line 290 of file PAG.h.

     {
         return unaryNodeMap.find(node) != unaryNodeMap.end();
     }

◆ isValidPointer()

bool PAG::isValidPointer ( NodeID nodeId ) const

Whether a node is a valid pointer.

Definition at line 976 of file PAG.cpp.

 {
     PAGNode* node = pag->getPAGNode(nodeId);
     if ((node->getInEdges().empty() && node->getOutEdges().empty()))
         return false;
     return node->isPointer();
 }

◆ isValidTopLevelPtr()

bool PAG::isValidTopLevelPtr ( const PAGNode * node )

Definition at line 984 of file PAG.cpp.

 {
     if (node->isTopLevelPtr())
     {
         if (isValidPointer(node->getId()) && node->hasValue())
         {
             if (SVFUtil::ArgInNoCallerFunction(node->getValue()))
                 return false;
             return true;
         }
     }
     return false;
 }

◆ print()

void PAG::print ( )

Print PAG.

Print this PAG graph including its nodes and edges

Definition at line 885 of file PAG.cpp.

 {
 
     outs() << "-------------------PAG------------------------------------\n";
     PAGEdge::PAGEdgeSetTy& addrs = pag->getEdgeSet(PAGEdge::Addr);
     for (PAGEdge::PAGEdgeSetTy::iterator iter = addrs.begin(), eiter =
                 addrs.end(); iter != eiter; ++iter)
     {
         outs() << (*iter)->getSrcID() << " -- Addr --> " << (*iter)->getDstID()
                << "\n";
     }
 
     PAGEdge::PAGEdgeSetTy& copys = pag->getEdgeSet(PAGEdge::Copy);
     for (PAGEdge::PAGEdgeSetTy::iterator iter = copys.begin(), eiter =
                 copys.end(); iter != eiter; ++iter)
     {
         outs() << (*iter)->getSrcID() << " -- Copy --> " << (*iter)->getDstID()
                << "\n";
     }
 
     PAGEdge::PAGEdgeSetTy& calls = pag->getEdgeSet(PAGEdge::Call);
     for (PAGEdge::PAGEdgeSetTy::iterator iter = calls.begin(), eiter =
                 calls.end(); iter != eiter; ++iter)
     {
         outs() << (*iter)->getSrcID() << " -- Call --> " << (*iter)->getDstID()
                << "\n";
     }
 
     PAGEdge::PAGEdgeSetTy& rets = pag->getEdgeSet(PAGEdge::Ret);
     for (PAGEdge::PAGEdgeSetTy::iterator iter = rets.begin(), eiter =
                 rets.end(); iter != eiter; ++iter)
     {
         outs() << (*iter)->getSrcID() << " -- Ret --> " << (*iter)->getDstID()
                << "\n";
     }
 
     PAGEdge::PAGEdgeSetTy& tdfks = pag->getEdgeSet(PAGEdge::ThreadFork);
     for (PAGEdge::PAGEdgeSetTy::iterator iter = tdfks.begin(), eiter =
                 tdfks.end(); iter != eiter; ++iter)
     {
         outs() << (*iter)->getSrcID() << " -- ThreadFork --> "
                << (*iter)->getDstID() << "\n";
     }
 
     PAGEdge::PAGEdgeSetTy& tdjns = pag->getEdgeSet(PAGEdge::ThreadJoin);
     for (PAGEdge::PAGEdgeSetTy::iterator iter = tdjns.begin(), eiter =
                 tdjns.end(); iter != eiter; ++iter)
     {
         outs() << (*iter)->getSrcID() << " -- ThreadJoin --> "
                << (*iter)->getDstID() << "\n";
     }
 
     PAGEdge::PAGEdgeSetTy& ngeps = pag->getEdgeSet(PAGEdge::NormalGep);
     for (PAGEdge::PAGEdgeSetTy::iterator iter = ngeps.begin(), eiter =
                 ngeps.end(); iter != eiter; ++iter)
     {
         NormalGepPE* gep = SVFUtil::cast<NormalGepPE>(*iter);
         outs() << gep->getSrcID() << " -- NormalGep (" << gep->getOffset()
                << ") --> " << gep->getDstID() << "\n";
     }
 
     PAGEdge::PAGEdgeSetTy& vgeps = pag->getEdgeSet(PAGEdge::VariantGep);
     for (PAGEdge::PAGEdgeSetTy::iterator iter = vgeps.begin(), eiter =
                 vgeps.end(); iter != eiter; ++iter)
     {
         outs() << (*iter)->getSrcID() << " -- VariantGep --> "
                << (*iter)->getDstID() << "\n";
     }
 
     PAGEdge::PAGEdgeSetTy& loads = pag->getEdgeSet(PAGEdge::Load);
     for (PAGEdge::PAGEdgeSetTy::iterator iter = loads.begin(), eiter =
                 loads.end(); iter != eiter; ++iter)
     {
         outs() << (*iter)->getSrcID() << " -- Load --> " << (*iter)->getDstID()
                << "\n";
     }
 
     PAGEdge::PAGEdgeSetTy& stores = pag->getEdgeSet(PAGEdge::Store);
     for (PAGEdge::PAGEdgeSetTy::iterator iter = stores.begin(), eiter =
                 stores.end(); iter != eiter; ++iter)
     {
         outs() << (*iter)->getSrcID() << " -- Store --> " << (*iter)->getDstID()
                << "\n";
     }
     outs() << "----------------------------------------------------------\n";
 
 }

◆ releasePAG()

static void SVF::PAG::releasePAG ( )

inlinestatic

Definition at line 168 of file PAG.h.

     {
         if (pag)
             delete pag;
         pag = nullptr;
     }

◆ setNodeNumAfterPAGBuild()

void SVF::PAG::setNodeNumAfterPAGBuild ( u32_t num )

inline

Definition at line 662 of file PAG.h.

     {
         nodeNumAfterPAGBuild = num;
     }

◆ view()

void PAG::view ( )

View graph from the debugger.

View PAG

Definition at line 1089 of file PAG.cpp.

 {
     llvm::ViewGraph(this, "ProgramAssignmentGraph");
 }

Member Data Documentation

◆ binaryNodeMap

BinaryNodeMap SVF::PAG::binaryNodeMap

private

A set of binary edges.

Definition at line 93 of file PAG.h.

◆ callSiteArgsListMap

CSToArgsListMap SVF::PAG::callSiteArgsListMap

private

Map a callsite to a list of all its actual parameters.

Definition at line 97 of file PAG.h.

◆ callSiteRetMap

CSToRetMap SVF::PAG::callSiteRetMap

private

Map a callsite to its callsite returns PAGNodes.

Definition at line 98 of file PAG.h.

◆ callSiteSet

CallSiteSet SVF::PAG::callSiteSet

private

Definition at line 109 of file PAG.h.

◆ candidatePointers

OrderedNodeSet SVF::PAG::candidatePointers

private

Valid pointers for pointer analysis resolution connected by PAG edges (constraints) this set of candidate pointers can change during pointer resolution (e.g. adding new object nodes)

Definition at line 106 of file PAG.h.

◆ cmpNodeMap

CmpNodeMap SVF::PAG::cmpNodeMap

private

A set of comparision edges.

Definition at line 95 of file PAG.h.

◆ fromFile

bool SVF::PAG::fromFile

private

Whether the PAG is built according to user specified data from a txt file

Definition at line 103 of file PAG.h.

◆ funArgsListMap

FunToArgsListMap SVF::PAG::funArgsListMap

private

Map a function to a list of all its formal parameters.

Definition at line 96 of file PAG.h.

◆ funPtrToCallSitesMap

FunPtrToCallSitesMap SVF::PAG::funPtrToCallSitesMap

private

Map a function pointer to the callsites where it is used.

Definition at line 102 of file PAG.h.

◆ funRetMap

FunToRetMap SVF::PAG::funRetMap

private

Map a function to its unique function return PAGNodes.

Definition at line 99 of file PAG.h.

◆ GepObjNodeMap

NodeLocationSetMap SVF::PAG::GepObjNodeMap

private

Map a pair<base,off> to a gep obj node id.

Definition at line 89 of file PAG.h.

◆ GepValNodeMap

GepValPNMap SVF::PAG::GepValNodeMap

private

Map a pair<base,off> to a gep value node id.

Definition at line 88 of file PAG.h.

◆ globPAGEdgesSet

PAGEdgeSet SVF::PAG::globPAGEdgesSet

private

Global PAGEdges without control flow information.

Definition at line 91 of file PAG.h.

◆ icfg

ICFG* SVF::PAG::icfg

private

Definition at line 108 of file PAG.h.

◆ indCallSiteToFunPtrMap

CallSiteToFunPtrMap SVF::PAG::indCallSiteToFunPtrMap

private

Map an indirect callsite to its function pointer.

Definition at line 101 of file PAG.h.

◆ inst2PAGEdgesMap

Inst2PAGEdgesMap SVF::PAG::inst2PAGEdgesMap

private

Map a instruction to its PAGEdges.

Definition at line 86 of file PAG.h.

◆ inst2PTAPAGEdgesMap

Inst2PAGEdgesMap SVF::PAG::inst2PTAPAGEdgesMap

private

Map a instruction to its PointerAnalysis related PAGEdges.

Definition at line 87 of file PAG.h.

◆ memToFieldsMap

MemObjToFieldsMap SVF::PAG::memToFieldsMap

private

Map a mem object id to all its fields.

Definition at line 90 of file PAG.h.

◆ nodeNumAfterPAGBuild

NodeID SVF::PAG::nodeNumAfterPAGBuild

private

Definition at line 107 of file PAG.h.

◆ pag

PAG * PAG::pag = nullptr

staticprivate

Singleton pattern here to enable instance of PAG can only be created once.

Definition at line 100 of file PAG.h.

◆ PAGEdgeKindToSetMap

PAGEdge::PAGKindToEdgeSetMapTy SVF::PAG::PAGEdgeKindToSetMap

private

ValueNodes - This map indicates the Node that a particular Value* is represented by. This contains entries for all pointers.

Definition at line 84 of file PAG.h.

◆ phiNodeMap

PHINodeMap SVF::PAG::phiNodeMap

private

A set of phi copy edges.

Definition at line 92 of file PAG.h.

◆ PTAPAGEdgeKindToSetMap

PAGEdge::PAGKindToEdgeSetMapTy SVF::PAG::PTAPAGEdgeKindToSetMap

private

Definition at line 85 of file PAG.h.

◆ symInfo

SymbolTableInfo* SVF::PAG::symInfo

private

Definition at line 81 of file PAG.h.

◆ totalPTAPAGEdge

u32_t SVF::PAG::totalPTAPAGEdge

Definition at line 118 of file PAG.h.

◆ unaryNodeMap

UnaryNodeMap SVF::PAG::unaryNodeMap

private

A set of unary edges.

Definition at line 94 of file PAG.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BinaryNodeMap

◆ BinaryOPList

◆ CallSiteSet

◆ CallSiteToFunPtrMap

◆ CmpNodeMap

◆ CmpPEList

◆ CopyPEList

◆ CSToArgsListMap

◆ CSToRetMap

◆ FunPtrToCallSitesMap

◆ FunToArgsListMap

◆ FunToPAGEdgeSetMap

◆ FunToRetMap

◆ GepValPNMap

◆ Inst2PAGEdgesMap

◆ MemObjToFieldsMap

◆ NodeLocationSet

◆ NodeLocationSetMap

◆ NodeOffset

◆ NodeOffsetMap

◆ NodePairSetMap

◆ NodeToNodeMap

◆ PAGEdgeList

◆ PAGEdgeSet

◆ PAGNodeList

◆ PHINodeMap

◆ UnaryNodeMap

◆ UnaryOPList

Constructor & Destructor Documentation

◆ PAG()

◆ ~PAG()

Member Function Documentation

◆ addAddrPE()

◆ addBinaryNode()

◆ addBinaryOPPE()

◆ addBlackHoleAddrPE()

◆ addBlackholeObjNode()

◆ addBlackholePtrNode()

◆ addCallPE()

◆ addCallSite()

◆ addCallSiteArgs()

◆ addCallSiteRets()

◆ addCmpNode()

◆ addCmpPE()

◆ addConstantObjNode()

◆ addCopyPE()

◆ addDummyMemObj()

◆ addDummyObjNode() [1/2]

◆ addDummyObjNode() [2/2]

◆ addDummyValNode() [1/2]

◆ addDummyValNode() [2/2]

◆ addEdge()

◆ addFIObjNode()

◆ addFunArgs()

◆ addFunRet()

◆ addGepObjNode()

◆ addGepPE()

◆ addGepValNode()

◆ addGlobalPAGEdge()

◆ addIndirectCallsites()

◆ addLoadPE()

◆ addNode()

◆ addNormalGepPE()

◆ addObjNode() [1/2]

◆ addObjNode() [2/2]

◆ addPhiNode()

◆ addRetNode() [1/2]

◆ addRetNode() [2/2]

◆ addRetPE()

◆ addStorePE()