#include <SVFIR.h>

Inheritance diagram for SVF::SVFIR:

Public Types
typedef Set< const CallICFGNode * >	CallSiteSet

typedef OrderedMap< const CallICFGNode *, NodeID >	CallSiteToFunPtrMap

typedef Map< NodeID, CallSiteSet >	FunPtrToCallSitesMap

typedef Map< NodeID, NodeBS >	MemObjToFieldsMap

typedef std::vector< const SVFStmt * >	SVFStmtList

typedef std::vector< const SVFVar * >	SVFVarList

typedef Map< const SVFVar , PhiStmt >	PHINodeMap

typedef Map< const SVFFunction *, SVFVarList >	FunToArgsListMap

typedef Map< const CallICFGNode *, SVFVarList >	CSToArgsListMap

typedef Map< const RetICFGNode , const SVFVar >	CSToRetMap

typedef Map< const SVFFunction , const SVFVar >	FunToRetMap

typedef Map< const SVFFunction *, SVFStmtSet >	FunToPAGEdgeSetMap

typedef Map< const ICFGNode *, SVFStmtList >	ICFGNode2SVFStmtsMap

typedef Map< NodeID, NodeID >	NodeToNodeMap

typedef std::pair< NodeID, APOffset >	NodeOffset

typedef std::pair< NodeID, AccessPath >	NodeAccessPath

typedef Map< NodeOffset, NodeID >	NodeOffsetMap

typedef Map< NodeAccessPath, NodeID >	NodeAccessPathMap

typedef Map< const SVFValue *, NodeAccessPathMap >	GepValueVarMap

typedef std::pair< const SVFType *, std::vector< AccessPath > >	SVFTypeLocSetsPair

typedef Map< NodeID, SVFTypeLocSetsPair >	TypeLocSetsMap

typedef Map< NodePair, NodeID >	NodePairSetMap

Public Types inherited from SVF::IRGraph
typedef Set< const SVFStmt * >	SVFStmtSet

typedef Map< const SVFValue *, SVFStmtSet >	ValueToEdgeMap

Public Types inherited from SVF::GenericGraph< SVFVar, SVFStmt >
typedef SVFVar	NodeType

typedef SVFStmt	EdgeType

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

typedef IDToNodeMapTy::iterator	iterator
	Node Iterators.

typedef IDToNodeMapTy::const_iterator	const_iterator

Public Member Functions
MemObjToFieldsMap &	getMemToFieldsMap ()
	Return memToFieldsMap.

NodeOffsetMap &	getGepObjNodeMap ()
	Return GepObjVarMap.

OrderedNodeSet &	getAllValidPtrs ()
	Return valid pointers.

void	initialiseCandidatePointers ()
	Initialize candidate pointers.

virtual	~SVFIR ()
	Destructor.

void	setModule (SVFModule *mod)
	Set/Get LLVM Module.

SVFModule *	getModule ()

void	setICFG (ICFG *i)
	Set/Get ICFG.

ICFG *	getICFG () const

void	setCHG (CommonCHGraph *c)
	Set/Get CHG.

CommonCHGraph *	getCHG ()

void	setCallGraph (CallGraph *c)
	Set/Get CG.

CallGraph *	getCallGraph ()

SVFStmt::SVFStmtSetTy &	getSVFStmtSet (SVFStmt::PEDGEK kind)
	Get/set methods to get SVFStmts based on their kinds and ICFGNodes.

SVFStmt::SVFStmtSetTy &	getPTASVFStmtSet (SVFStmt::PEDGEK kind)
	Get PTA edges set according to its kind.

bool	hasSVFStmtList (const ICFGNode *inst) const
	Whether this instruction has SVFIR Edge.

bool	hasPTASVFStmtList (const ICFGNode *inst) const

SVFStmtList &	getSVFStmtList (const ICFGNode *inst)
	Given an instruction, get all its PAGEdges.

SVFStmtList &	getPTASVFStmtList (const ICFGNode *inst)
	Given an instruction, get all its PTA PAGEdges.

void	addToSVFStmtList (ICFGNode inst, SVFStmt edge)
	Add a SVFStmt into instruction map.

void	addToTypeLocSetsMap (NodeID argId, SVFTypeLocSetsPair &locSets)
	Add a base SVFType* and all its field location sets to an arg NodeId.

SVFTypeLocSetsPair &	getTypeLocSetsMap (NodeID argId)
	Given an arg NodeId, get its base SVFType* and all its field location sets.

SVFStmtSet &	getGlobalSVFStmtSet ()
	Get global PAGEdges (not in a procedure)

const CallSiteSet &	getCallSiteSet () const
	Get all callsites.

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

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

FunToArgsListMap &	getFunArgsMap ()
	Get function arguments list.

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

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

CSToArgsListMap &	getCallSiteArgsMap ()
	Get callsite argument list.

const SVFVarList &	getCallSiteArgsList (const CallICFGNode *cs) const
	Get callsite argument list.

CSToRetMap &	getCallSiteRets ()
	Get callsite return.

const SVFVar *	getCallSiteRet (const RetICFGNode *cs) const
	Get callsite return.

bool	callsiteHasRet (const RetICFGNode *cs) const

FunToRetMap &	getFunRets ()
	Get function return list.

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

bool	funHasRet (const SVFFunction *func) const

u32_t	getFieldValNodeNum () const
	Node and edge statistics.

u32_t	getFieldObjNodeNum () const

NodeID	getGepValVar (const SVFValue *curInst, NodeID base, const AccessPath &ap) const
	Due to constraint expression, curInst is used to distinguish different instructions (e.g., memorycpy) when creating GepValVar.

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

NodeID	getFunPtr (const CallICFGNode *cs) const

const CallSiteSet &	getIndCallSites (NodeID funPtr) const

bool	isIndirectCallSites (const CallICFGNode *cs) const

bool	isFunPtr (NodeID id) const

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

SVFStmt *	getIntraPAGEdge (SVFVar src, SVFVar dst, SVFStmt::PEDGEK kind)

const MemObj *	getObject (NodeID id) const

const BaseObjVar *	getBaseObject (NodeID id) const

const ValVar *	getBaseValVar (NodeID id) const

const MemObj *	getObject (const ObjVar *node) const

NodeID	getGepObjVar (const MemObj *obj, const APOffset &ap)
	Get a field SVFIR Object node according to base mem obj and offset.

NodeID	getGepObjVar (NodeID id, const APOffset &ap)
	Get a field obj SVFIR node according to a mem obj and a given offset.

NodeID	getFIObjVar (const MemObj *obj) const
	Get a field-insensitive obj SVFIR node according to a mem obj.

NodeID	getFIObjVar (NodeID id) const

bool	isBlkPtr (NodeID id) const
	Get black hole and constant id.

bool	isNullPtr (NodeID id) const

bool	isBlkObjOrConstantObj (NodeID id) const

bool	isBlkObj (NodeID id) const

bool	isConstantObj (NodeID id) const

NodeID	getBaseObjVar (NodeID id) const
	Base and Offset methods for Value and Object node.

const MemObj *	getBaseObj (NodeID id) const

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

NodeBS &	getAllFieldsObjVars (NodeID id)

NodeBS	getFieldsAfterCollapse (NodeID id)

NodeID	addDummyValNode ()

NodeID	addDummyObjNode (const SVFType *type)

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

bool	isValidTopLevelPtr (const SVFVar *node)

void	print ()
	Print SVFIR.

Public Member Functions inherited from SVF::IRGraph
	IRGraph (bool buildFromFile)

virtual	~IRGraph ()

SymbolTableInfo *	getSymbolInfo () const

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

const SVFStmtSet &	getValueEdges (const SVFValue *V)
	Get all SVFIR Edges that corresponds to an LLVM value.

NodeID	getValueNode (const SVFValue *V)

bool	hasValueNode (const SVFValue *V)

NodeID	getObjectNode (const SVFValue *V)

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

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

NodeID	getBlackHoleNode () const

NodeID	getConstantNode () const

NodeID	getBlkPtr () const

NodeID	getNullPtr () const

const MemObj *	getBlackHoleObj () const

const MemObj *	getConstantObj () const

u32_t	getValueNodeNum () const

u32_t	getObjectNodeNum () const

u32_t	getNodeNumAfterPAGBuild () const

void	setNodeNumAfterPAGBuild (u32_t num)

u32_t	getPAGNodeNum () const

u32_t	getPAGEdgeNum () const

u32_t	getPTAPAGEdgeNum () const

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

void	dump (std::string name)
	Dump SVFIR.

void	view ()
	View graph from the debugger.

Public Member Functions inherited from SVF::GenericGraph< SVFVar, SVFStmt >
	GenericGraph ()
	Constructor.

virtual	~GenericGraph ()
	Destructor.

void	destroy ()
	Release memory.

iterator	begin ()
	Iterators.

const_iterator	begin () const

iterator	end ()

const_iterator	end () const

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

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

bool	hasGNode (NodeID id) const
	Has a node.

void	removeGNode (NodeType *node)
	Delete a node.

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

u32_t	getTotalEdgeNum () const

void	incNodeNum ()
	Increase number of node/edge.

void	incEdgeNum ()

Static Public Member Functions
static SVFIR *	getPAG (bool buildFromFile=false)
	Singleton design here to make sure we only have one instance during any analysis.

static void	releaseSVFIR ()

static void	handleBlackHole (bool b)
	SVFIR build configurations.

Private Member Functions
	SVFIR (bool buildFromFile)
	Constructor.

void	destroy ()
	Clean up memory.

void	addToStmt2TypeMap (SVFStmt *edge)
	Map a SVFStatement type to a set of corresponding SVF statements.

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

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

void	addCallSiteArgs (CallICFGNode callBlockNode, const ValVar arg)
	Add callsite arguments.

void	addCallSiteRets (RetICFGNode retBlockNode, const SVFVar arg)
	Add callsite returns.

void	addIndirectCallsites (const CallICFGNode *cs, NodeID funPtr)
	Add indirect callsites.

NodeID	addValNode (const SVFValue val, NodeID i, const ICFGNode icfgNode)
	add node into SVFIR

NodeID	addFunValNode (const CallGraphNode callGraphNode, NodeID i, const ICFGNode icfgNode)

NodeID	addConstantFPValNode (const SVFValue curInst, double dval, const NodeID i, const ICFGNode icfgNode)

NodeID	addConstantIntValNode (const SVFValue curInst, s64_t sval, u64_t zval, const NodeID i, const ICFGNode icfgNode)

NodeID	addConstantNullPtrValNode (const SVFValue curInst, const NodeID i, const ICFGNode icfgNode)

NodeID	addGlobalValueValNode (const SVFValue curInst, const NodeID i, const ICFGNode icfgNode)

NodeID	addConstantDataValNode (const SVFValue curInst, const NodeID i, const ICFGNode icfgNode)

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

NodeID	addHeapObjNode (const SVFValue val, const SVFFunction f, NodeID i)

NodeID	addStackObjNode (const SVFValue val, const SVFFunction f, NodeID i)

NodeID	addFunObjNode (const CallGraphNode *callGraphNode, NodeID id)

NodeID	addConstantFPObjNode (const SVFValue *curInst, double dval, const NodeID i)

NodeID	addConstantIntObjNode (const SVFValue *curInst, s64_t sval, u64_t zval, const NodeID i)

NodeID	addConstantNullPtrObjNode (const SVFValue *curInst, const NodeID i)

NodeID	addGlobalValueObjNode (const SVFValue *curInst, const NodeID i)

NodeID	addConstantDataObjNode (const SVFValue *curInst, const NodeID i)

NodeID	addRetNode (const CallGraphNode *callGraphNode, NodeID i)
	Add a unique return node for a procedure.

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

NodeID	addGepValNode (const SVFValue curInst, const SVFValue val, const AccessPath &ap, NodeID i, const SVFType *type)
	Add a temp field value node, this method can only invoked by getGepValVar.

NodeID	addGepObjNode (const MemObj *obj, const APOffset &apOffset, const NodeID gepId)
	Add a field obj node, this method can only invoked by getGepObjVar.

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

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

NodeID	addDummyObjNode (NodeID i, const SVFType *type)

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

NodeID	addBlackholeObjNode ()

NodeID	addConstantObjNode ()

NodeID	addBlackholePtrNode ()

NodeID	addValNode (const SVFValue , SVFVar node, NodeID i)
	Add a value (pointer) node.

NodeID	addObjNode (const SVFValue , SVFVar node, NodeID i)
	Add a memory obj node.

NodeID	addRetNode (const CallGraphNode , SVFVar node, NodeID i)
	Add a unique return node for a procedure.

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

void	addGlobalPAGEdge (const SVFStmt *edge)
	Add global PAGEdges (not in a procedure)

void	addCallSite (const CallICFGNode *call)
	Add callsites.

AddrStmt *	addAddrStmt (NodeID src, NodeID dst)
	Add an edge into SVFIR.

CopyStmt *	addCopyStmt (NodeID src, NodeID dst, CopyStmt::CopyKind type)
	Add Copy edge.

PhiStmt *	addPhiStmt (NodeID res, NodeID opnd, const ICFGNode *pred)
	Add phi node information.

SelectStmt *	addSelectStmt (NodeID res, NodeID op1, NodeID op2, NodeID cond)
	Add SelectStmt.

CmpStmt *	addCmpStmt (NodeID op1, NodeID op2, NodeID dst, u32_t predict)
	Add Copy edge.

BinaryOPStmt *	addBinaryOPStmt (NodeID op1, NodeID op2, NodeID dst, u32_t opcode)
	Add Copy edge.

UnaryOPStmt *	addUnaryOPStmt (NodeID src, NodeID dst, u32_t opcode)
	Add Unary edge.

BranchStmt *	addBranchStmt (NodeID br, NodeID cond, const BranchStmt::SuccAndCondPairVec &succs)
	Add BranchStmt.

LoadStmt *	addLoadStmt (NodeID src, NodeID dst)
	Add Load edge.

StoreStmt *	addStoreStmt (NodeID src, NodeID dst, const ICFGNode *val)
	Add Store edge.

CallPE *	addCallPE (NodeID src, NodeID dst, const CallICFGNode cs, const FunEntryICFGNode entry)
	Add Call edge.

RetPE *	addRetPE (NodeID src, NodeID dst, const CallICFGNode cs, const FunExitICFGNode exit)
	Add Return edge.

GepStmt *	addGepStmt (NodeID src, NodeID dst, const AccessPath &ap, bool constGep)
	Add Gep edge.

GepStmt *	addNormalGepStmt (NodeID src, NodeID dst, const AccessPath &ap)
	Add Offset(Gep) edge.

GepStmt *	addVariantGepStmt (NodeID src, NodeID dst, const AccessPath &ap)
	Add Variant(Gep) edge.

TDForkPE *	addThreadForkPE (NodeID src, NodeID dst, const CallICFGNode cs, const FunEntryICFGNode entry)
	Add Thread fork edge for parameter passing.

TDJoinPE *	addThreadJoinPE (NodeID src, NodeID dst, const CallICFGNode cs, const FunExitICFGNode exit)
	Add Thread join edge for parameter passing.

SVFStmt *	addBlackHoleAddrStmt (NodeID node)
	Set a pointer points-to black hole (e.g. int2ptr)

Private Attributes
ICFGNode2SVFStmtsMap	icfgNode2SVFStmtsMap
	Map an ICFGNode to its SVFStmts.

ICFGNode2SVFStmtsMap	icfgNode2PTASVFStmtsMap
	Map an ICFGNode to its PointerAnalysis related SVFStmts.

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

TypeLocSetsMap	typeLocSetsMap
	Map an arg to its base SVFType* and all its field location sets.

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

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

SVFStmtSet	globSVFStmtSet
	Global PAGEdges without control flow information.

PHINodeMap	phiNodeMap
	A set of phi copy edges.

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

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

CSToRetMap	callSiteRetMap
	Map a callsite to its callsite returns PAGNodes.

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

CallSiteToFunPtrMap	indCallSiteToFunPtrMap
	Map an indirect callsite to its function pointer.

FunPtrToCallSitesMap	funPtrToCallSitesMap

OrderedNodeSet	candidatePointers

SVFModule *	svfModule

ICFG *	icfg
	SVF Module.

CommonCHGraph *	chgraph

CallSiteSet	callSiteSet

CallGraph *	callGraph
	all the callsites of a program

Static Private Attributes
static std::unique_ptr< SVFIR >	pag
	call graph

Friends
class	SVFIRBuilder

class	ExternalPAG

class	PAGBuilderFromFile

class	TypeBasedHeapCloning

class	SVFIRWriter

class	SVFIRReader

class	BVDataPTAImpl

Additional Inherited Members
Public Attributes inherited from SVF::GenericGraph< SVFVar, SVFStmt >
u32_t	edgeNum
	total num of node

u32_t	nodeNum
	total num of edge

Protected Member Functions inherited from SVF::IRGraph
NodeID	addNode (SVFVar *node, NodeID i)
	Add a node into the graph.

bool	addEdge (SVFVar src, SVFVar dst, SVFStmt *edge)
	Add an edge into the graph.

SVFStmt *	hasNonlabeledEdge (SVFVar src, SVFVar dst, SVFStmt::PEDGEK kind)

SVFStmt *	hasLabeledEdge (SVFVar src, SVFVar dst, SVFStmt::PEDGEK kind, const ICFGNode *cs)

SVFStmt *	hasLabeledEdge (SVFVar src, SVFVar op1, SVFStmt::PEDGEK kind, const SVFVar *op2)

void	mapValueToEdge (const SVFValue V, SVFStmt edge)
	Map a value to a set of edges.

const MemObj *	getMemObj (const SVFValue *val) const
	get MemObj according to LLVM value

Protected Attributes inherited from SVF::IRGraph
SVFStmt::KindToSVFStmtMapTy	KindToSVFStmtSetMap
	SVFIR edge map containing all PAGEdges.

SVFStmt::KindToSVFStmtMapTy	KindToPTASVFStmtSetMap
	SVFIR edge map containing only pointer-related edges, i.e., both LHS and RHS are of pointer type.

bool	fromFile
	Whether the SVFIR is built according to user specified data from a txt file.

NodeID	nodeNumAfterPAGBuild
	initial node number after building SVFIR, excluding later added nodes, e.g., gepobj nodes

u32_t	totalPTAPAGEdge

ValueToEdgeMap	valueToEdgeMap
	Map SVFValues (e.g., ICFGNodes) to all corresponding PAGEdges.

SymbolTableInfo *	symInfo

Protected Attributes inherited from SVF::GenericGraph< SVFVar, SVFStmt >
IDToNodeMapTy	IDToNodeMap
	node map

Detailed Description

SVF Intermediate representation, representing variables and statements as a Program Assignment Graph (PAG) Variables as nodes and statements as edges. SymID and NodeID are equal here (same numbering).

Definition at line 44 of file SVFIR.h.

Member Typedef Documentation

◆ CallSiteSet

typedef Set<const CallICFGNode*> SVF::SVFIR::CallSiteSet

Definition at line 55 of file SVFIR.h.

◆ CallSiteToFunPtrMap

typedef OrderedMap<const CallICFGNode*,NodeID> SVF::SVFIR::CallSiteToFunPtrMap

Definition at line 56 of file SVFIR.h.

◆ CSToArgsListMap

typedef Map<const CallICFGNode*,SVFVarList> SVF::SVFIR::CSToArgsListMap

Definition at line 63 of file SVFIR.h.

◆ CSToRetMap

typedef Map<const RetICFGNode*,const SVFVar*> SVF::SVFIR::CSToRetMap

Definition at line 64 of file SVFIR.h.

◆ FunPtrToCallSitesMap

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

Definition at line 57 of file SVFIR.h.

◆ FunToArgsListMap

typedef Map<const SVFFunction*,SVFVarList> SVF::SVFIR::FunToArgsListMap

Definition at line 62 of file SVFIR.h.

◆ FunToPAGEdgeSetMap

typedef Map<const SVFFunction*,SVFStmtSet> SVF::SVFIR::FunToPAGEdgeSetMap

Definition at line 66 of file SVFIR.h.

◆ FunToRetMap

typedef Map<const SVFFunction*,const SVFVar*> SVF::SVFIR::FunToRetMap

Definition at line 65 of file SVFIR.h.

◆ GepValueVarMap

typedef Map<const SVFValue*, NodeAccessPathMap> SVF::SVFIR::GepValueVarMap

Definition at line 73 of file SVFIR.h.

◆ ICFGNode2SVFStmtsMap

typedef Map<const ICFGNode*,SVFStmtList> SVF::SVFIR::ICFGNode2SVFStmtsMap

Definition at line 67 of file SVFIR.h.

◆ MemObjToFieldsMap

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

Definition at line 58 of file SVFIR.h.

◆ NodeAccessPath

typedef std::pair<NodeID, AccessPath> SVF::SVFIR::NodeAccessPath

Definition at line 70 of file SVFIR.h.

◆ NodeAccessPathMap

typedef Map<NodeAccessPath,NodeID> SVF::SVFIR::NodeAccessPathMap

Definition at line 72 of file SVFIR.h.

◆ NodeOffset

typedef std::pair<NodeID, APOffset> SVF::SVFIR::NodeOffset

Definition at line 69 of file SVFIR.h.

◆ NodeOffsetMap

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

Definition at line 71 of file SVFIR.h.

◆ NodePairSetMap

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

Definition at line 76 of file SVFIR.h.

◆ NodeToNodeMap

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

Definition at line 68 of file SVFIR.h.

◆ PHINodeMap

typedef Map<const SVFVar*,PhiStmt*> SVF::SVFIR::PHINodeMap

Definition at line 61 of file SVFIR.h.

◆ SVFStmtList

typedef std::vector<const SVFStmt*> SVF::SVFIR::SVFStmtList

Definition at line 59 of file SVFIR.h.

◆ SVFTypeLocSetsPair

typedef std::pair<const SVFType*, std::vector<AccessPath> > SVF::SVFIR::SVFTypeLocSetsPair

Definition at line 74 of file SVFIR.h.

◆ SVFVarList

typedef std::vector<const SVFVar*> SVF::SVFIR::SVFVarList

Definition at line 60 of file SVFIR.h.

◆ TypeLocSetsMap

typedef Map<NodeID, SVFTypeLocSetsPair> SVF::SVFIR::TypeLocSetsMap

Definition at line 75 of file SVFIR.h.

Constructor & Destructor Documentation

◆ SVFIR()

SVFIR::SVFIR ( bool buildFromFile )

private

Constructor.

Definition at line 40 of file SVFIR.cpp.

                               : IRGraph(buildFromFile), svfModule(nullptr), icfg(nullptr), chgraph(nullptr)
{
}

◆ ~SVFIR()

virtual SVF::SVFIR::~SVFIR ( )

inlinevirtual

Destructor.

Definition at line 148 of file SVFIR.h.

    {
        destroy();
    }

Member Function Documentation

◆ addAddrStmt()

AddrStmt * SVFIR::addAddrStmt	(	NodeID	src,
		NodeID	dst
	)

private

Add an edge into SVFIR.

Add Address edge

Definition at line 47 of file SVFIR.cpp.

{
    SVFVar* srcNode = getGNode(src);
    SVFVar* dstNode = getGNode(dst);
    if(hasNonlabeledEdge(srcNode,dstNode, SVFStmt::Addr))
        return nullptr;
    else
    {
        AddrStmt* addrPE = new AddrStmt(srcNode, dstNode);
        addToStmt2TypeMap(addrPE);
        addEdge(srcNode,dstNode, addrPE);
        return addrPE;
    }
}

◆ addBinaryOPStmt()

BinaryOPStmt * SVFIR::addBinaryOPStmt	(	NodeID	op1,
		NodeID	op2,
		NodeID	dst,
		u32_t	opcode
	)

private

Add Copy edge.

Add Compare edge

Definition at line 149 of file SVFIR.cpp.

{
    SVFVar* op1Node = getGNode(op1);
    SVFVar* op2Node = getGNode(op2);
    SVFVar* dstNode = getGNode(dst);
    if(hasLabeledEdge(op1Node, dstNode, SVFStmt::BinaryOp, op2Node))
        return nullptr;
    else
    {
        std::vector<SVFVar*> opnds = {op1Node, op2Node};
        BinaryOPStmt* binaryOP = new BinaryOPStmt(dstNode, opnds, opcode);
        addToStmt2TypeMap(binaryOP);
        addEdge(op1Node,dstNode, binaryOP);
        return binaryOP;
    }
}

◆ addBlackHoleAddrStmt()

SVFStmt * SVFIR::addBlackHoleAddrStmt ( NodeID node )

private

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

Add blackhole/constant edge

Definition at line 278 of file SVFIR.cpp.

{
    if(Options::HandBlackHole())
        return pag->addAddrStmt(pag->getBlackHoleNode(), node);
    else
        return pag->addCopyStmt(pag->getNullPtr(), node, CopyStmt::COPYVAL);
}

◆ addBlackholeObjNode()

NodeID SVF::SVFIR::addBlackholeObjNode ( )

inlineprivate

Definition at line 734 of file SVFIR.h.

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

◆ addBlackholePtrNode()

NodeID SVF::SVFIR::addBlackholePtrNode ( )

inlineprivate

Definition at line 746 of file SVFIR.h.

    {
        return addDummyValNode(getBlkPtr());
    }

◆ addBranchStmt()

BranchStmt * SVFIR::addBranchStmt	(	NodeID	br,
		NodeID	cond,
		const BranchStmt::SuccAndCondPairVec &	succs
	)

private

Add BranchStmt.

Definition at line 187 of file SVFIR.cpp.

{
    SVFVar* brNode = getGNode(br);
    SVFVar* condNode = getGNode(cond);
    if(hasNonlabeledEdge(condNode,brNode, SVFStmt::Branch))
        return nullptr;
    else
    {
        BranchStmt* branch = new BranchStmt(brNode, condNode, succs);
        addToStmt2TypeMap(branch);
        addEdge(condNode,brNode, branch);
        return branch;
    }
}

◆ addCallPE()

CallPE * SVFIR::addCallPE	(	NodeID	src,
		NodeID	dst,
		const CallICFGNode *	cs,
		const FunEntryICFGNode *	entry
	)

private

Add Call edge.

Add Call edge

Definition at line 242 of file SVFIR.cpp.

{
    SVFVar* srcNode = getGNode(src);
    SVFVar* dstNode = getGNode(dst);
    if(hasLabeledEdge(srcNode,dstNode, SVFStmt::Call, cs))
        return nullptr;
    else
    {
        CallPE* callPE = new CallPE(srcNode, dstNode, cs,entry);
        addToStmt2TypeMap(callPE);
        addEdge(srcNode,dstNode, callPE);
        return callPE;
    }
}

◆ addCallSite()

void SVF::SVFIR::addCallSite ( const CallICFGNode * call )

inlineprivate

Add callsites.

Definition at line 785 of file SVFIR.h.

    {
        callSiteSet.insert(call);
    }

◆ addCallSiteArgs()

void SVF::SVFIR::addCallSiteArgs	(	CallICFGNode *	callBlockNode,
		const ValVar *	arg
	)

inlineprivate

Add callsite arguments.

Definition at line 546 of file SVFIR.h.

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

◆ addCallSiteRets()

void SVF::SVFIR::addCallSiteRets	(	RetICFGNode *	retBlockNode,
		const SVFVar *	arg
	)

inlineprivate

Add callsite returns.

Definition at line 552 of file SVFIR.h.

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

◆ addCmpStmt()

CmpStmt * SVFIR::addCmpStmt	(	NodeID	op1,
		NodeID	op2,
		NodeID	dst,
		u32_t	predicate
	)

private

Add Copy edge.

Add Compare edge

Definition at line 128 of file SVFIR.cpp.

{
    SVFVar* op1Node = getGNode(op1);
    SVFVar* op2Node = getGNode(op2);
    SVFVar* dstNode = getGNode(dst);
    if(hasLabeledEdge(op1Node, dstNode, SVFStmt::Cmp, op2Node))
        return nullptr;
    else
    {
        std::vector<SVFVar*> opnds = {op1Node, op2Node};
        CmpStmt* cmp = new CmpStmt(dstNode, opnds, predicate);
        addToStmt2TypeMap(cmp);
        addEdge(op1Node, dstNode, cmp);
        return cmp;
    }
}

◆ addConstantDataObjNode()

NodeID SVF::SVFIR::addConstantDataObjNode	(	const SVFValue *	curInst,
		const NodeID	i
	)

inlineprivate

Definition at line 688 of file SVFIR.h.

    {
        const MemObj* mem = getMemObj(curInst);
        NodeID base = mem->getId();
        memToFieldsMap[base].set(mem->getId());
        ConstantDataObjVar* node = new ConstantDataObjVar(curInst, mem->getId(), mem);
        return addObjNode(mem->getValue(), node, mem->getId());
    }

◆ addConstantDataValNode()

NodeID SVF::SVFIR::addConstantDataValNode	(	const SVFValue *	curInst,
		const NodeID	i,
		const ICFGNode *	icfgNode
	)

inlineprivate

Definition at line 607 of file SVFIR.h.

    {
        SVFVar* node = new ConstantDataValVar(curInst, i, icfgNode);
        return addNode(node, i);
    }

◆ addConstantFPObjNode()

NodeID SVF::SVFIR::addConstantFPObjNode	(	const SVFValue *	curInst,
		double	dval,
		const NodeID	i
	)

inlineprivate

Definition at line 649 of file SVFIR.h.

    {
        const MemObj* mem = getMemObj(curInst);
        NodeID base = mem->getId();
        memToFieldsMap[base].set(mem->getId());
        ConstantFPObjVar* node = new ConstantFPObjVar(curInst, dval, mem->getId(), mem);
        return addObjNode(curInst, node, mem->getId());
    }

◆ addConstantFPValNode()

NodeID SVF::SVFIR::addConstantFPValNode	(	const SVFValue *	curInst,
		double	dval,
		const NodeID	i,
		const ICFGNode *	icfgNode
	)

inlineprivate

Definition at line 581 of file SVFIR.h.

    {
        SVFVar* node = new ConstantFPValVar(curInst,  dval, i, icfgNode);
        return addNode(node, i);
    }

◆ addConstantIntObjNode()

NodeID SVF::SVFIR::addConstantIntObjNode	(	const SVFValue *	curInst,
		s64_t	sval,
		u64_t	zval,
		const NodeID	i
	)

inlineprivate

Definition at line 659 of file SVFIR.h.

    {
        const MemObj* mem = getMemObj(curInst);
        NodeID base = mem->getId();
        memToFieldsMap[base].set(mem->getId());
        ConstantIntObjVar* node =
            new ConstantIntObjVar(curInst, sval, zval, mem->getId(), mem);
        return addObjNode(curInst, node, mem->getId());
    }

◆ addConstantIntValNode()

NodeID SVF::SVFIR::addConstantIntValNode	(	const SVFValue *	curInst,
		s64_t	sval,
		u64_t	zval,
		const NodeID	i,
		const ICFGNode *	icfgNode
	)

inlineprivate

Definition at line 588 of file SVFIR.h.

    {
        SVFVar* node = new ConstantIntValVar(curInst, sval, zval, i, icfgNode);
        return addNode(node, i);
    }

◆ addConstantNullPtrObjNode()

NodeID SVF::SVFIR::addConstantNullPtrObjNode	(	const SVFValue *	curInst,
		const NodeID	i
	)

inlineprivate

Definition at line 670 of file SVFIR.h.

    {
        const MemObj* mem = getMemObj(curInst);
        NodeID base = mem->getId();
        memToFieldsMap[base].set(mem->getId());
        ConstantNullPtrObjVar* node = new ConstantNullPtrObjVar(curInst, mem->getId(), mem);
        return addObjNode(mem->getValue(), node, mem->getId());
    }

◆ addConstantNullPtrValNode()

NodeID SVF::SVFIR::addConstantNullPtrValNode	(	const SVFValue *	curInst,
		const NodeID	i,
		const ICFGNode *	icfgNode
	)

inlineprivate

Definition at line 595 of file SVFIR.h.

    {
        SVFVar* node = new ConstantNullPtrValVar(curInst, i, icfgNode);
        return addNode(node, i);
    }

◆ addConstantObjNode()

NodeID SVF::SVFIR::addConstantObjNode ( )

inlineprivate

Definition at line 740 of file SVFIR.h.

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

◆ addCopyStmt()

CopyStmt * SVFIR::addCopyStmt	(	NodeID	src,
		NodeID	dst,
		CopyStmt::CopyKind	type
	)

private

Add Copy edge.

Add Copy edge

Definition at line 65 of file SVFIR.cpp.

{
    SVFVar* srcNode = getGNode(src);
    SVFVar* dstNode = getGNode(dst);
    if(hasNonlabeledEdge(srcNode,dstNode, SVFStmt::Copy))
        return nullptr;
    else
    {
        CopyStmt* copyPE = new CopyStmt(srcNode, dstNode, type);
        addToStmt2TypeMap(copyPE);
        addEdge(srcNode,dstNode, copyPE);
        return copyPE;
    }
}

◆ addDummyMemObj()

const MemObj * SVF::SVFIR::addDummyMemObj	(	NodeID	i,
		const SVFType *	type
	)

inlineprivate

Definition at line 730 of file SVFIR.h.

    {
        return getSymbolInfo()->createDummyObj(i,type);
    }

◆ addDummyObjNode() [1/2]

NodeID SVF::SVFIR::addDummyObjNode ( const SVFType * type )

inline

Definition at line 500 of file SVFIR.h.

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

◆ addDummyObjNode() [2/2]

NodeID SVF::SVFIR::addDummyObjNode	(	NodeID	i,
		const SVFType *	type
	)

inlineprivate

Definition at line 725 of file SVFIR.h.

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

◆ addDummyValNode() [1/2]

NodeID SVF::SVFIR::addDummyValNode ( )

inline

Definition at line 496 of file SVFIR.h.

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

◆ addDummyValNode() [2/2]

NodeID SVF::SVFIR::addDummyValNode ( NodeID i )

inlineprivate

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

Definition at line 721 of file SVFIR.h.

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

◆ addFIObjNode()

NodeID SVFIR::addFIObjNode ( const MemObj * obj )

private

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 466 of file SVFIR.cpp.

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

◆ addFunArgs()

void SVF::SVFIR::addFunArgs	(	const SVFFunction *	fun,
		const SVFVar *	arg
	)

inlineprivate

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

Add function arguments

Definition at line 532 of file SVFIR.h.

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

◆ addFunObjNode()

NodeID SVFIR::addFunObjNode	(	const CallGraphNode *	callGraphNode,
		NodeID	id
	)

private

Definition at line 475 of file SVFIR.cpp.

{
    const MemObj* mem = getMemObj(callGraphNode->getFunction());
    assert(mem->getId() == id && "not same object id?");
    //assert(findPAGNode(i) == false && "this node should not be created before");
    NodeID base = mem->getId();
    memToFieldsMap[base].set(mem->getId());
    FunObjVar*node = new FunObjVar(callGraphNode, mem->getId(), mem);
    return addObjNode(mem->getValue(), node, mem->getId());
}

◆ addFunRet()

void SVF::SVFIR::addFunRet	(	const SVFFunction *	fun,
		const SVFVar *	ret
	)

inlineprivate

Add function returns.

Definition at line 539 of file SVFIR.h.

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

◆ addFunValNode()

NodeID SVF::SVFIR::addFunValNode	(	const CallGraphNode *	callGraphNode,
		NodeID	i,
		const ICFGNode *	icfgNode
	)

inlineprivate

Definition at line 575 of file SVFIR.h.

    {
        FunValVar* node = new FunValVar(callGraphNode, i, icfgNode);
        return addValNode(nullptr, node, i);
    }

◆ addGepObjNode()

NodeID SVFIR::addGepObjNode	(	const MemObj *	obj,
		const APOffset &	apOffset,
		const NodeID	gepId
	)

private

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

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

Definition at line 450 of file SVFIR.cpp.

{
    //assert(findPAGNode(i) == false && "this node should not be created before");
    NodeID base = obj->getId();
    assert(0==GepObjVarMap.count(std::make_pair(base, apOffset))
           && "this node should not be created before");
 
    GepObjVarMap[std::make_pair(base, apOffset)] = gepId;
    GepObjVar *node = new GepObjVar(obj, gepId, apOffset);
    memToFieldsMap[base].set(gepId);
    return addObjNode(obj->getValue(), node, gepId);
}

◆ addGepStmt()

GepStmt * SVFIR::addGepStmt	(	NodeID	src,
		NodeID	dst,
		const AccessPath &	ap,
		bool	constGep
	)

private

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 Variant GepStmt edge.

Definition at line 328 of file SVFIR.cpp.

{
 
    SVFVar* node = getGNode(src);
    if (!constGep || node->hasIncomingVariantGepEdge())
    {
        return addVariantGepStmt(src, dst, ap);
    }
    else
    {
        return addNormalGepStmt(src, dst, ap);
    }
}

◆ addGepValNode()

NodeID SVFIR::addGepValNode	(	const SVFValue *	curInst,
		const SVFValue *	gepVal,
		const AccessPath &	ap,
		NodeID	i,
		const SVFType *	type
	)

private

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

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

Definition at line 387 of file SVFIR.cpp.

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

◆ addGlobalPAGEdge()

void SVF::SVFIR::addGlobalPAGEdge ( const SVFStmt * edge )

inlineprivate

Add global PAGEdges (not in a procedure)

Definition at line 780 of file SVFIR.h.

    {
        globSVFStmtSet.insert(edge);
    }

◆ addGlobalValueObjNode()

NodeID SVF::SVFIR::addGlobalValueObjNode	(	const SVFValue *	curInst,
		const NodeID	i
	)

inlineprivate

Definition at line 679 of file SVFIR.h.

    {
        const MemObj* mem = getMemObj(curInst);
        NodeID base = mem->getId();
        memToFieldsMap[base].set(mem->getId());
        GlobalObjVar* node = new GlobalObjVar(curInst, mem->getId(), mem);
        return addObjNode(mem->getValue(), node, mem->getId());
    }

◆ addGlobalValueValNode()

NodeID SVF::SVFIR::addGlobalValueValNode	(	const SVFValue *	curInst,
		const NodeID	i,
		const ICFGNode *	icfgNode
	)

inlineprivate

Definition at line 601 of file SVFIR.h.

    {
        SVFVar* node = new GlobalValVar(curInst, i, icfgNode);
        return addNode(node, i);
    }

◆ addHeapObjNode()

NodeID SVF::SVFIR::addHeapObjNode	(	const SVFValue *	val,
		const SVFFunction *	f,
		NodeID	i
	)

inlineprivate

Creates and adds a heap object node to the SVFIR

Definition at line 625 of file SVFIR.h.

    {
        const MemObj* mem = getMemObj(val);
        assert(mem->getId() == i && "not same object id?");
        memToFieldsMap[i].set(i);
        HeapObjVar *node = new HeapObjVar(f, val->getType(), i, mem);
        return addObjNode(val, node, i);
    }

◆ addIndirectCallsites()

void SVF::SVFIR::addIndirectCallsites	(	const CallICFGNode *	cs,
		NodeID	funPtr
	)

inlineprivate

Add indirect callsites.

Definition at line 558 of file SVFIR.h.

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

◆ addLoadStmt()

LoadStmt * SVFIR::addLoadStmt	(	NodeID	src,
		NodeID	dst
	)

private

Add Load edge.

Add Load edge

Definition at line 205 of file SVFIR.cpp.

{
    SVFVar* srcNode = getGNode(src);
    SVFVar* dstNode = getGNode(dst);
    if(hasNonlabeledEdge(srcNode,dstNode, SVFStmt::Load))
        return nullptr;
    else
    {
        LoadStmt* loadPE = new LoadStmt(srcNode, dstNode);
        addToStmt2TypeMap(loadPE);
        addEdge(srcNode,dstNode, loadPE);
        return loadPE;
    }
}

◆ addNormalGepStmt()

GepStmt * SVFIR::addNormalGepStmt	(	NodeID	src,
		NodeID	dst,
		const AccessPath &	ap
	)

private

Add Offset(Gep) edge.

Add normal (Gep) edge

Definition at line 347 of file SVFIR.cpp.

{
    SVFVar* baseNode = getGNode(src);
    SVFVar* dstNode = getGNode(dst);
    if(hasNonlabeledEdge(baseNode, dstNode, SVFStmt::Gep))
        return nullptr;
    else
    {
        GepStmt* gepPE = new GepStmt(baseNode, dstNode, ap);
        addToStmt2TypeMap(gepPE);
        addEdge(baseNode, dstNode, gepPE);
        return gepPE;
    }
}

◆ addObjNode() [1/2]

NodeID SVF::SVFIR::addObjNode	(	const SVFValue *	,
		SVFVar *	node,
		NodeID	i
	)

inlineprivate

Add a memory obj node.

Definition at line 761 of file SVFIR.h.

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

◆ addObjNode() [2/2]

NodeID SVF::SVFIR::addObjNode	(	const SVFValue *	val,
		NodeID	i
	)

inlineprivate

Add a memory obj node.

Definition at line 615 of file SVFIR.h.

    {
        const MemObj* mem = getMemObj(val);
        assert(mem->getId() == i && "not same object id?");
        return addFIObjNode(mem);
    }

◆ addPhiStmt()

PhiStmt * SVFIR::addPhiStmt	(	NodeID	res,
		NodeID	opnd,
		const ICFGNode *	pred
	)

private

Add phi node information.

Add Phi statement

return null if we already added this PhiStmt

Definition at line 83 of file SVFIR.cpp.

{
    SVFVar* opNode = getGNode(opnd);
    SVFVar* resNode = getGNode(res);
    PHINodeMap::iterator it = phiNodeMap.find(resNode);
    if(it == phiNodeMap.end())
    {
        PhiStmt* phi = new PhiStmt(resNode, {opNode}, {pred});
        addToStmt2TypeMap(phi);
        addEdge(opNode, resNode, phi);
        phiNodeMap[resNode] = phi;
        return phi;
    }
    else
    {
        it->second->addOpVar(opNode,pred);
        return nullptr;
    }
}

◆ addRetNode() [1/2]

NodeID SVF::SVFIR::addRetNode	(	const CallGraphNode *	,
		SVFVar *	node,
		NodeID	i
	)

inlineprivate

Add a unique return node for a procedure.

Definition at line 769 of file SVFIR.h.

    {
        return addNode(node,i);
    }

◆ addRetNode() [2/2]

NodeID SVF::SVFIR::addRetNode	(	const CallGraphNode *	callGraphNode,
		NodeID	i
	)

inlineprivate

Add a unique return node for a procedure.

Definition at line 698 of file SVFIR.h.

    {
        SVFVar *node = new RetPN(callGraphNode,i);
        return addRetNode(callGraphNode, node, i);
    }

◆ addRetPE()

RetPE * SVFIR::addRetPE	(	NodeID	src,
		NodeID	dst,
		const CallICFGNode *	cs,
		const FunExitICFGNode *	exit
	)

private

Add Return edge.

Add Return edge

Definition at line 260 of file SVFIR.cpp.

{
    SVFVar* srcNode = getGNode(src);
    SVFVar* dstNode = getGNode(dst);
    if(hasLabeledEdge(srcNode,dstNode, SVFStmt::Ret, cs))
        return nullptr;
    else
    {
        RetPE* retPE = new RetPE(srcNode, dstNode, cs, exit);
        addToStmt2TypeMap(retPE);
        addEdge(srcNode,dstNode, retPE);
        return retPE;
    }
}

◆ addSelectStmt()

SelectStmt * SVFIR::addSelectStmt	(	NodeID	res,
		NodeID	op1,
		NodeID	op2,
		NodeID	cond
	)

private

Add SelectStmt.

Add Phi statement

Definition at line 107 of file SVFIR.cpp.

{
    SVFVar* op1Node = getGNode(op1);
    SVFVar* op2Node = getGNode(op2);
    SVFVar* dstNode = getGNode(res);
    SVFVar* condNode = getGNode(cond);
    if(hasLabeledEdge(op1Node, dstNode, SVFStmt::Select, op2Node))
        return nullptr;
    else
    {
        std::vector<SVFVar*> opnds = {op1Node, op2Node};
        SelectStmt* select = new SelectStmt(dstNode, opnds, condNode);
        addToStmt2TypeMap(select);
        addEdge(op1Node, dstNode, select);
        return select;
    }
}

◆ addStackObjNode()

NodeID SVF::SVFIR::addStackObjNode	(	const SVFValue *	val,
		const SVFFunction *	f,
		NodeID	i
	)

inlineprivate

Creates and adds a stack object node to the SVFIR

Definition at line 637 of file SVFIR.h.

    {
        const MemObj* mem = getMemObj(val);
        assert(mem->getId() == i && "not same object id?");
        memToFieldsMap[i].set(i);
        StackObjVar *node = new  StackObjVar(f, val->getType(), i, mem);
        return addObjNode(val, node, i);
    }

◆ addStoreStmt()

StoreStmt * SVFIR::addStoreStmt	(	NodeID	src,
		NodeID	dst,
		const ICFGNode *	curVal
	)

private

Add Store edge.

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

Definition at line 224 of file SVFIR.cpp.

{
    SVFVar* srcNode = getGNode(src);
    SVFVar* dstNode = getGNode(dst);
    if(hasLabeledEdge(srcNode,dstNode, SVFStmt::Store, curVal))
        return nullptr;
    else
    {
        StoreStmt* storePE = new StoreStmt(srcNode, dstNode, curVal);
        addToStmt2TypeMap(storePE);
        addEdge(srcNode,dstNode, storePE);
        return storePE;
    }
}

◆ addThreadForkPE()

TDForkPE * SVFIR::addThreadForkPE	(	NodeID	src,
		NodeID	dst,
		const CallICFGNode *	cs,
		const FunEntryICFGNode *	entry
	)

private

Add Thread fork edge for parameter passing.

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

Definition at line 289 of file SVFIR.cpp.

{
    SVFVar* srcNode = getGNode(src);
    SVFVar* dstNode = getGNode(dst);
    if(hasLabeledEdge(srcNode,dstNode, SVFStmt::ThreadFork, cs))
        return nullptr;
    else
    {
        TDForkPE* forkPE = new TDForkPE(srcNode, dstNode, cs, entry);
        addToStmt2TypeMap(forkPE);
        addEdge(srcNode,dstNode, forkPE);
        return forkPE;
    }
}

◆ addThreadJoinPE()

TDJoinPE * SVFIR::addThreadJoinPE	(	NodeID	src,
		NodeID	dst,
		const CallICFGNode *	cs,
		const FunExitICFGNode *	exit
	)

private

Add Thread join edge for parameter passing.

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

Definition at line 307 of file SVFIR.cpp.

{
    SVFVar* srcNode = getGNode(src);
    SVFVar* dstNode = getGNode(dst);
    if(hasLabeledEdge(srcNode,dstNode, SVFStmt::ThreadJoin, cs))
        return nullptr;
    else
    {
        TDJoinPE* joinPE = new TDJoinPE(srcNode, dstNode, cs, exit);
        addToStmt2TypeMap(joinPE);
        addEdge(srcNode,dstNode, joinPE);
        return joinPE;
    }
}

◆ addToStmt2TypeMap()

void SVF::SVFIR::addToStmt2TypeMap ( SVFStmt * edge )

inlineprivate

Map a SVFStatement type to a set of corresponding SVF statements.

this is a pointer-related SVFStmt if (1) both RHS and LHS are pointers or (2) this an int2ptr statment, i.e., LHS = int2ptr RHS

Definition at line 517 of file SVFIR.h.

    {
        bool added = KindToSVFStmtSetMap[edge->getEdgeKind()].insert(edge).second;
        (void)added; // Suppress warning of unused variable under release build
        assert(added && "duplicated edge, not added!!!");
        if (edge->isPTAEdge() || (SVFUtil::isa<CopyStmt>(edge) && SVFUtil::cast<CopyStmt>(edge)->isInt2Ptr()))
        {
            totalPTAPAGEdge++;
            KindToPTASVFStmtSetMap[edge->getEdgeKind()].insert(edge);
        }
    }

◆ addToSVFStmtList()

void SVF::SVFIR::addToSVFStmtList	(	ICFGNode *	inst,
		SVFStmt *	edge
	)

inline

Add a SVFStmt into instruction map.

Definition at line 232 of file SVFIR.h.

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

◆ addToTypeLocSetsMap()

void SVF::SVFIR::addToTypeLocSetsMap	(	NodeID	argId,
		SVFTypeLocSetsPair &	locSets
	)

inline

Add a base SVFType* and all its field location sets to an arg NodeId.

Definition at line 240 of file SVFIR.h.

    {
        typeLocSetsMap[argId]=locSets;
    }

◆ addUnaryOPStmt()

UnaryOPStmt * SVFIR::addUnaryOPStmt	(	NodeID	src,
		NodeID	dst,
		u32_t	opcode
	)

private

Add Unary edge.

Add Unary edge

Definition at line 169 of file SVFIR.cpp.

{
    SVFVar* srcNode = getGNode(src);
    SVFVar* dstNode = getGNode(dst);
    if(hasNonlabeledEdge(srcNode,dstNode, SVFStmt::UnaryOp))
        return nullptr;
    else
    {
        UnaryOPStmt* unaryOP = new UnaryOPStmt(srcNode, dstNode, opcode);
        addToStmt2TypeMap(unaryOP);
        addEdge(srcNode,dstNode, unaryOP);
        return unaryOP;
    }
}

◆ addValNode() [1/2]

NodeID SVF::SVFIR::addValNode	(	const SVFValue *	,
		SVFVar *	node,
		NodeID	i
	)

inlineprivate

Add a value (pointer) node.

Definition at line 753 of file SVFIR.h.

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

◆ addValNode() [2/2]

NodeID SVF::SVFIR::addValNode	(	const SVFValue *	val,
		NodeID	i,
		const ICFGNode *	icfgNode
	)

inlineprivate

add node into SVFIR

Add a value (pointer) node

Definition at line 569 of file SVFIR.h.

    {
        SVFVar *node = new ValVar(val,i, ValVar::ValNode, icfgNode);
        return addValNode(val, node, i);
    }

◆ addVarargNode() [1/2]

NodeID SVF::SVFIR::addVarargNode	(	const CallGraphNode *	val,
		NodeID	i
	)

inlineprivate

Add a unique vararg node for a procedure.

Definition at line 704 of file SVFIR.h.

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

◆ addVarargNode() [2/2]

NodeID SVF::SVFIR::addVarargNode	(	const SVFFunction *	,
		SVFVar *	node,
		NodeID	i
	)

inlineprivate

Add a unique vararg node for a procedure.

Definition at line 774 of file SVFIR.h.

    {
        return addNode(node,i);
    }

◆ addVariantGepStmt()

GepStmt * SVFIR::addVariantGepStmt	(	NodeID	src,
		NodeID	dst,
		const AccessPath &	ap
	)

private

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 366 of file SVFIR.cpp.

{
    SVFVar* baseNode = getGNode(src);
    SVFVar* dstNode = getGNode(dst);
    if(hasNonlabeledEdge(baseNode, dstNode, SVFStmt::Gep))
        return nullptr;
    else
    {
        GepStmt* gepPE = new GepStmt(baseNode, dstNode, ap, true);
        addToStmt2TypeMap(gepPE);
        addEdge(baseNode, dstNode, gepPE);
        return gepPE;
    }
}

◆ callsiteHasRet()

bool SVF::SVFIR::callsiteHasRet ( const RetICFGNode * cs ) const

inline

Definition at line 311 of file SVFIR.h.

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

◆ destroy()

void SVFIR::destroy ( )

private

Clean up memory.

Clean up memory

Definition at line 551 of file SVFIR.cpp.

{
    delete icfg;
    icfg = nullptr;
    delete chgraph;
    chgraph = nullptr;
    SVFModule::releaseSVFModule();
    svfModule = nullptr;
    delete callGraph;
    callGraph = nullptr;
}

◆ funHasRet()

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

inline

Definition at line 327 of file SVFIR.h.

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

◆ getAllFieldsObjVars() [1/2]

NodeBS & SVFIR::getAllFieldsObjVars ( const MemObj * obj )

Get all fields of an object.

Get all fields object nodes of an object

Definition at line 489 of file SVFIR.cpp.

{
    NodeID base = obj->getId();
    return memToFieldsMap[base];
}

◆ getAllFieldsObjVars() [2/2]

NodeBS & SVFIR::getAllFieldsObjVars ( NodeID id )

Get all fields object nodes of an object

Definition at line 498 of file SVFIR.cpp.

{
    const SVFVar* node = pag->getGNode(id);
    assert(SVFUtil::isa<ObjVar>(node) && "need an object node");
    const ObjVar* obj = SVFUtil::cast<ObjVar>(node);
    return getAllFieldsObjVars(obj->getMemObj());
}

◆ getAllValidPtrs()

OrderedNodeSet & SVF::SVFIR::getAllValidPtrs ( )

inline

Return valid pointers.

Definition at line 140 of file SVFIR.h.

    {
        return candidatePointers;
    }

◆ getBaseObj()

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

inline

Definition at line 481 of file SVFIR.h.

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

◆ getBaseObject()

const BaseObjVar * SVF::SVFIR::getBaseObject ( NodeID id ) const

inline

Definition at line 405 of file SVFIR.h.

    {
        const SVFVar* node = getGNode(id);
        if(const GepObjVar* gepObjVar = SVFUtil::dyn_cast<GepObjVar>(node))
            return SVFUtil::dyn_cast<BaseObjVar>(
                       getGNode(gepObjVar->getBaseNode()));
        else
            return SVFUtil::dyn_cast<BaseObjVar>(node);
    }

◆ getBaseObjVar()

NodeID SVF::SVFIR::getBaseObjVar ( NodeID id ) const

inline

Base and Offset methods for Value and Object node.

Get a base pointer node given a field pointer

Definition at line 477 of file SVFIR.h.

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

◆ getBaseValVar()

const ValVar * SVF::SVFIR::getBaseValVar ( NodeID id ) const

inline

Definition at line 415 of file SVFIR.h.

    {
        const SVFVar* node = getGNode(id);
        if(const GepValVar* gepVar = SVFUtil::dyn_cast<GepValVar>(node))
            return SVFUtil::dyn_cast<ValVar>(
                       getGNode(gepVar->getBaseNode()));
        else
            return SVFUtil::dyn_cast<ValVar>(node);
    }

◆ getCallGraph()

CallGraph * SVF::SVFIR::getCallGraph ( )

inline

Definition at line 193 of file SVFIR.h.

    {
        assert(callGraph && "empty CallGraph! Build SVF IR first!");
        return callGraph;
    }

◆ getCallSiteArgsList()

const SVFVarList & SVF::SVFIR::getCallSiteArgsList ( const CallICFGNode * cs ) const

inline

Get callsite argument list.

Definition at line 293 of file SVFIR.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::SVFIR::getCallSiteArgsMap ( )

inline

Get callsite argument list.

Definition at line 288 of file SVFIR.h.

    {
        return callSiteArgsListMap;
    }

◆ getCallSiteRet()

const SVFVar * SVF::SVFIR::getCallSiteRet ( const RetICFGNode * cs ) const

inline

Get callsite return.

Definition at line 305 of file SVFIR.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::SVFIR::getCallSiteRets ( )

inline

Get callsite return.

Definition at line 300 of file SVFIR.h.

    {
        return callSiteRetMap;
    }

◆ getCallSiteSet()

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

inline

Get all callsites.

Definition at line 255 of file SVFIR.h.

    {
        return callSiteSet;
    }

◆ getCHG()

CommonCHGraph * SVF::SVFIR::getCHG ( )

inline

Definition at line 182 of file SVFIR.h.

    {
        assert(chgraph && "empty ICFG! Build SVF IR first!");
        return chgraph;
    }

◆ getFieldObjNodeNum()

u32_t SVF::SVFIR::getFieldObjNodeNum ( ) const

inline

Definition at line 339 of file SVFIR.h.

    {
        return GepObjVarMap.size();
    }

◆ getFieldsAfterCollapse()

NodeBS SVFIR::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 511 of file SVFIR.cpp.

{
    const SVFVar* node = pag->getGNode(id);
    assert(SVFUtil::isa<ObjVar>(node) && "need an object node");
    const MemObj* mem = SVFUtil::cast<ObjVar>(node)->getMemObj();
    if(mem->isFieldInsensitive())
    {
        NodeBS bs;
        bs.set(getFIObjVar(mem));
        return bs;
    }
    else
        return getAllFieldsObjVars(mem);
}

◆ getFieldValNodeNum()

u32_t SVF::SVFIR::getFieldValNodeNum ( ) const

inline

Node and edge statistics.

Definition at line 335 of file SVFIR.h.

    {
        return GepValObjMap.size();
    }

◆ getFIObjVar() [1/2]

NodeID SVF::SVFIR::getFIObjVar ( const MemObj * obj ) const

inline

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

Definition at line 437 of file SVFIR.h.

    {
        return obj->getId();
    }

◆ getFIObjVar() [2/2]

NodeID SVF::SVFIR::getFIObjVar ( NodeID id ) const

inline

Definition at line 441 of file SVFIR.h.

    {
        return getBaseObjVar(id);
    }

◆ getFunArgsList()

const SVFVarList & SVF::SVFIR::getFunArgsList ( const SVFFunction * func ) const

inline

Get function arguments list.

Definition at line 276 of file SVFIR.h.

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

◆ getFunArgsMap()

FunToArgsListMap & SVF::SVFIR::getFunArgsMap ( )

inline

Get function arguments list.

Definition at line 271 of file SVFIR.h.

    {
        return funArgsListMap;
    }

◆ getFunPtr()

NodeID SVF::SVFIR::getFunPtr ( const CallICFGNode * cs ) const

inline

Definition at line 355 of file SVFIR.h.

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

◆ getFunRet()

const SVFVar * SVF::SVFIR::getFunRet ( const SVFFunction * func ) const

inline

Get function return list.

Definition at line 321 of file SVFIR.h.

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

◆ getFunRets()

FunToRetMap & SVF::SVFIR::getFunRets ( )

inline

Get function return list.

Definition at line 316 of file SVFIR.h.

    {
        return funRetMap;
    }

◆ getGepObjNodeMap()

NodeOffsetMap & SVF::SVFIR::getGepObjNodeMap ( )

inline

Return GepObjVarMap.

Definition at line 135 of file SVFIR.h.

    {
        return GepObjVarMap;
    }

◆ getGepObjVar() [1/2]

NodeID SVFIR::getGepObjVar	(	const MemObj *	obj,
		const APOffset &	apOffset
	)

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

Get a field obj SVFIR 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 423 of file SVFIR.cpp.

{
    NodeID base = obj->getId();
 
    if (obj->isFieldInsensitive())
        return getFIObjVar(obj);
 
    APOffset newLS = pag->getSymbolInfo()->getModulusOffset(obj, apOffset);
 
    // Base and first field are the same memory location.
    if (Options::FirstFieldEqBase() && newLS == 0) return base;
 
    NodeOffsetMap::iterator iter = GepObjVarMap.find(std::make_pair(base, newLS));
    if (iter == GepObjVarMap.end())
    {
        NodeID gepId = NodeIDAllocator::get()->allocateGepObjectId(base, apOffset, Options::MaxFieldLimit());
        return addGepObjNode(obj, newLS,gepId);
    }
    else
        return iter->second;
 
}

◆ getGepObjVar() [2/2]

NodeID SVFIR::getGepObjVar	(	NodeID	id,
		const APOffset &	apOffset
	)

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

Given an object node, find its field object node

Definition at line 401 of file SVFIR.cpp.

{
    SVFVar* node = pag->getGNode(id);
    if (GepObjVar* gepNode = SVFUtil::dyn_cast<GepObjVar>(node))
        return getGepObjVar(gepNode->getMemObj(), gepNode->getConstantFieldIdx() + apOffset);
    else if (BaseObjVar* baseNode = SVFUtil::dyn_cast<BaseObjVar>(node))
        return getGepObjVar(baseNode->getMemObj(), apOffset);
    else if (DummyObjVar* baseNode = SVFUtil::dyn_cast<DummyObjVar>(node))
        return getGepObjVar(baseNode->getMemObj(), apOffset);
    else
    {
        assert(false && "new gep obj node kind?");
        return id;
    }
}

◆ getGepValVar()

NodeID SVFIR::getGepValVar	(	const SVFValue *	curInst,
		NodeID	base,
		const AccessPath &	ap
	)		const

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

It is used to create a dummy GepValVar during global initialization.

Definition at line 529 of file SVFIR.cpp.

{
    GepValueVarMap::const_iterator iter = GepValObjMap.find(curInst);
    if(iter==GepValObjMap.end())
    {
        return UINT_MAX;
    }
    else
    {
        NodeAccessPathMap::const_iterator lit =
            iter->second.find(std::make_pair(base, ap));
        if (lit == iter->second.end())
            return UINT_MAX;
        else
            return lit->second;
    }
}

◆ getGlobalSVFStmtSet()

SVFStmtSet & SVF::SVFIR::getGlobalSVFStmtSet ( )

inline

Get global PAGEdges (not in a procedure)

Definition at line 250 of file SVFIR.h.

    {
        return globSVFStmtSet;
    }

◆ getICFG()

ICFG * SVF::SVFIR::getICFG ( ) const

inline

Definition at line 172 of file SVFIR.h.

    {
        assert(icfg->totalICFGNode>0 && "empty ICFG! Build SVF IR first!");
        return icfg;
    }

◆ getIndCallSites()

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

inline

Definition at line 361 of file SVFIR.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::SVFIR::getIndirectCallsites ( ) const

inline

Add/get indirect callsites.

Definition at line 351 of file SVFIR.h.

    {
        return indCallSiteToFunPtrMap;
    }

◆ getIntraPAGEdge() [1/2]

SVFStmt * SVF::SVFIR::getIntraPAGEdge	(	NodeID	src,
		NodeID	dst,
		SVFStmt::PEDGEK	kind
	)

inline

Get an edge according to src, dst and kind.

Definition at line 378 of file SVFIR.h.

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

◆ getIntraPAGEdge() [2/2]

SVFStmt * SVF::SVFIR::getIntraPAGEdge	(	SVFVar *	src,
		SVFVar *	dst,
		SVFStmt::PEDGEK	kind
	)

inline

Definition at line 382 of file SVFIR.h.

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

◆ getMemToFieldsMap()

MemObjToFieldsMap & SVF::SVFIR::getMemToFieldsMap ( )

inline

Return memToFieldsMap.

Definition at line 130 of file SVFIR.h.

    {
        return memToFieldsMap;
    }

◆ getModule()

SVFModule * SVF::SVFIR::getModule ( )

inline

Definition at line 162 of file SVFIR.h.

    {
        assert(svfModule && "empty SVFModule! Build SVF IR first!");
        return svfModule;
    }

◆ getObject() [1/2]

const MemObj * SVF::SVFIR::getObject ( const ObjVar * node ) const

inline

Definition at line 425 of file SVFIR.h.

    {
        return node->getMemObj();
    }

◆ getObject() [2/2]

const MemObj * SVF::SVFIR::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 ObjVar type

Definition at line 396 of file SVFIR.h.

    {
        const SVFVar* node = getGNode(id);
        if (const ObjVar* objPN = SVFUtil::dyn_cast<ObjVar>(node))
            return getObject(objPN);
        else
            return nullptr;
    }

◆ getPAG()

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

inlinestatic

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

Definition at line 116 of file SVFIR.h.

    {
        if (pag == nullptr)
        {
            pag = std::unique_ptr<SVFIR>(new SVFIR(buildFromFile));
        }
        return pag.get();
    }

◆ getPTASVFStmtList()

SVFStmtList & SVF::SVFIR::getPTASVFStmtList ( const ICFGNode * inst )

inline

Given an instruction, get all its PTA PAGEdges.

Definition at line 227 of file SVFIR.h.

    {
        return icfgNode2PTASVFStmtsMap[inst];
    }

◆ getPTASVFStmtSet()

SVFStmt::SVFStmtSetTy & SVF::SVFIR::getPTASVFStmtSet ( SVFStmt::PEDGEK kind )

inline

Get PTA edges set according to its kind.

Definition at line 207 of file SVFIR.h.

    {
        return KindToPTASVFStmtSetMap[kind];
    }

◆ getSVFStmtList()

SVFStmtList & SVF::SVFIR::getSVFStmtList ( const ICFGNode * inst )

inline

Given an instruction, get all its PAGEdges.

Definition at line 222 of file SVFIR.h.

    {
        return icfgNode2SVFStmtsMap[inst];
    }

◆ getSVFStmtSet()

SVFStmt::SVFStmtSetTy & SVF::SVFIR::getSVFStmtSet ( SVFStmt::PEDGEK kind )

inline

Get/set methods to get SVFStmts based on their kinds and ICFGNodes.

Get edges set according to its kind

Definition at line 202 of file SVFIR.h.

    {
        return KindToSVFStmtSetMap[kind];
    }

◆ getTypeLocSetsMap()

SVFTypeLocSetsPair & SVF::SVFIR::getTypeLocSetsMap ( NodeID argId )

inline

Given an arg NodeId, get its base SVFType* and all its field location sets.

Definition at line 245 of file SVFIR.h.

    {
        return typeLocSetsMap[argId];
    }

◆ handleBlackHole()

void SVFIR::handleBlackHole ( bool b )

static

SVFIR build configurations.

Whether to handle blackhole edge

Definition at line 706 of file SVFIR.cpp.

{
    Options::HandBlackHole.setValue(b);
}

◆ hasCallSiteArgsMap()

bool SVF::SVFIR::hasCallSiteArgsMap ( const CallICFGNode * cs ) const

inline

Callsite has argument list.

Definition at line 283 of file SVFIR.h.

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

◆ hasFunArgsList()

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

inline

Function has arguments list.

Definition at line 266 of file SVFIR.h.

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

◆ hasPTASVFStmtList()

bool SVF::SVFIR::hasPTASVFStmtList ( const ICFGNode * inst ) const

inline

Definition at line 216 of file SVFIR.h.

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

◆ hasSVFStmtList()

bool SVF::SVFIR::hasSVFStmtList ( const ICFGNode * inst ) const

inline

Whether this instruction has SVFIR Edge.

Definition at line 212 of file SVFIR.h.

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

◆ initialiseCandidatePointers()

void SVFIR::initialiseCandidatePointers ( )

Initialize candidate pointers.

Definition at line 651 of file SVFIR.cpp.

{
    // 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);
    }
}

◆ isBlkObj()

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

inline

Definition at line 461 of file SVFIR.h.

    {
        return SymbolTableInfo::isBlkObj(id);
    }

◆ isBlkObjOrConstantObj()

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

inline

Definition at line 457 of file SVFIR.h.

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

◆ isBlkPtr()

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

inline

Get black hole and constant id.

Definition at line 449 of file SVFIR.h.

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

◆ isConstantObj()

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

inline

Definition at line 465 of file SVFIR.h.

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

◆ isFunPtr()

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

inline

Definition at line 371 of file SVFIR.h.

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

◆ isIndirectCallSites()

bool SVF::SVFIR::isIndirectCallSites ( const CallICFGNode * cs ) const

inline

Definition at line 367 of file SVFIR.h.

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

◆ isNullPtr()

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

inline

Definition at line 453 of file SVFIR.h.

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

◆ isPhiNode()

bool SVF::SVFIR::isPhiNode ( const SVFVar * node ) const

inline

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

Definition at line 260 of file SVFIR.h.

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

◆ isValidPointer()

bool SVFIR::isValidPointer ( NodeID nodeId ) const

Whether a node is a valid pointer.

Definition at line 667 of file SVFIR.cpp.

{
    SVFVar* node = pag->getGNode(nodeId);
 
    if (node->hasValue() && node->isPointer())
    {
        if(const SVFArgument* arg = SVFUtil::dyn_cast<SVFArgument>(node->getValue()))
        {
            if (!(arg->getParent()->isDeclaration()))
                return true;
        }
    }
 
    if ((node->getInEdges().empty() && node->getOutEdges().empty()))
        return false;
    return node->isPointer();
}

◆ isValidTopLevelPtr()

bool SVFIR::isValidTopLevelPtr ( const SVFVar * node )

Definition at line 685 of file SVFIR.cpp.

{
    if (SVFUtil::isa<ValVar>(node))
    {
        if (isValidPointer(node->getId()))
        {
            // TODO: after svf value is removed, we use type to determine top level ptr
            if (SVFUtil::isa<RetPN, VarArgPN, FunValVar, HeapObjVar, StackObjVar>(node))
            {
                return true;
            }
            else if(node->hasValue())
                return !SVFUtil::isArgOfUncalledFunction(node->getValue());
        }
    }
    return false;
}

◆ print()

void SVFIR::print ( )

Print SVFIR.

Print this SVFIR graph including its nodes and edges

Definition at line 566 of file SVFIR.cpp.

{
 
    outs() << "-------------------SVFIR------------------------------------\n";
    SVFStmt::SVFStmtSetTy& addrs = pag->getSVFStmtSet(SVFStmt::Addr);
    for (SVFStmt::SVFStmtSetTy::iterator iter = addrs.begin(), eiter =
                addrs.end(); iter != eiter; ++iter)
    {
        outs() << (*iter)->getSrcID() << " -- Addr --> " << (*iter)->getDstID()
               << "\n";
    }
 
    SVFStmt::SVFStmtSetTy& copys = pag->getSVFStmtSet(SVFStmt::Copy);
    for (SVFStmt::SVFStmtSetTy::iterator iter = copys.begin(), eiter =
                copys.end(); iter != eiter; ++iter)
    {
        outs() << (*iter)->getSrcID() << " -- Copy --> " << (*iter)->getDstID()
               << "\n";
    }
 
    SVFStmt::SVFStmtSetTy& calls = pag->getSVFStmtSet(SVFStmt::Call);
    for (SVFStmt::SVFStmtSetTy::iterator iter = calls.begin(), eiter =
                calls.end(); iter != eiter; ++iter)
    {
        outs() << (*iter)->getSrcID() << " -- Call --> " << (*iter)->getDstID()
               << "\n";
    }
 
    SVFStmt::SVFStmtSetTy& rets = pag->getSVFStmtSet(SVFStmt::Ret);
    for (SVFStmt::SVFStmtSetTy::iterator iter = rets.begin(), eiter =
                rets.end(); iter != eiter; ++iter)
    {
        outs() << (*iter)->getSrcID() << " -- Ret --> " << (*iter)->getDstID()
               << "\n";
    }
 
    SVFStmt::SVFStmtSetTy& tdfks = pag->getSVFStmtSet(SVFStmt::ThreadFork);
    for (SVFStmt::SVFStmtSetTy::iterator iter = tdfks.begin(), eiter =
                tdfks.end(); iter != eiter; ++iter)
    {
        outs() << (*iter)->getSrcID() << " -- ThreadFork --> "
               << (*iter)->getDstID() << "\n";
    }
 
    SVFStmt::SVFStmtSetTy& tdjns = pag->getSVFStmtSet(SVFStmt::ThreadJoin);
    for (SVFStmt::SVFStmtSetTy::iterator iter = tdjns.begin(), eiter =
                tdjns.end(); iter != eiter; ++iter)
    {
        outs() << (*iter)->getSrcID() << " -- ThreadJoin --> "
               << (*iter)->getDstID() << "\n";
    }
 
    SVFStmt::SVFStmtSetTy& ngeps = pag->getSVFStmtSet(SVFStmt::Gep);
    for (SVFStmt::SVFStmtSetTy::iterator iter = ngeps.begin(), eiter =
                ngeps.end(); iter != eiter; ++iter)
    {
        GepStmt* gep = SVFUtil::cast<GepStmt>(*iter);
        if(gep->isVariantFieldGep())
            outs() << (*iter)->getSrcID() << " -- VariantGep --> "
                   << (*iter)->getDstID() << "\n";
        else
            outs() << gep->getRHSVarID() << " -- Gep (" << gep->getConstantStructFldIdx()
                   << ") --> " << gep->getLHSVarID() << "\n";
    }
 
    SVFStmt::SVFStmtSetTy& loads = pag->getSVFStmtSet(SVFStmt::Load);
    for (SVFStmt::SVFStmtSetTy::iterator iter = loads.begin(), eiter =
                loads.end(); iter != eiter; ++iter)
    {
        outs() << (*iter)->getSrcID() << " -- Load --> " << (*iter)->getDstID()
               << "\n";
    }
 
    SVFStmt::SVFStmtSetTy& stores = pag->getSVFStmtSet(SVFStmt::Store);
    for (SVFStmt::SVFStmtSetTy::iterator iter = stores.begin(), eiter =
                stores.end(); iter != eiter; ++iter)
    {
        outs() << (*iter)->getSrcID() << " -- Store --> " << (*iter)->getDstID()
               << "\n";
    }
    outs() << "----------------------------------------------------------\n";
 
}

◆ releaseSVFIR()

static void SVF::SVFIR::releaseSVFIR ( )

inlinestatic

Definition at line 124 of file SVFIR.h.

    {
        pag = nullptr;
    }

◆ setCallGraph()

void SVF::SVFIR::setCallGraph ( CallGraph * c )

inline

Set/Get CG.

Definition at line 189 of file SVFIR.h.

    {
        callGraph = c;
    }

◆ setCHG()

void SVF::SVFIR::setCHG ( CommonCHGraph * c )

inline

Set/Get CHG.

Definition at line 178 of file SVFIR.h.

    {
        chgraph = c;
    }

◆ setICFG()

void SVF::SVFIR::setICFG ( ICFG * i )

inline

Set/Get ICFG.

Definition at line 168 of file SVFIR.h.

    {
        icfg = i;
    }

◆ setModule()

void SVF::SVFIR::setModule ( SVFModule * mod )

inline

Set/Get LLVM Module.

Definition at line 158 of file SVFIR.h.

    {
        svfModule = mod;
    }

Friends And Related Symbol Documentation

◆ BVDataPTAImpl

friend class BVDataPTAImpl

friend

Definition at line 52 of file SVFIR.h.

◆ ExternalPAG

friend class ExternalPAG

friend

Definition at line 47 of file SVFIR.h.

◆ PAGBuilderFromFile

friend class PAGBuilderFromFile

friend

Definition at line 48 of file SVFIR.h.

◆ SVFIRBuilder

friend class SVFIRBuilder

friend

Definition at line 46 of file SVFIR.h.

◆ SVFIRReader

friend class SVFIRReader

friend

Definition at line 51 of file SVFIR.h.

◆ SVFIRWriter

friend class SVFIRWriter

friend

Definition at line 50 of file SVFIR.h.

◆ TypeBasedHeapCloning

friend class TypeBasedHeapCloning

friend

Definition at line 49 of file SVFIR.h.

Member Data Documentation

◆ callGraph

CallGraph* SVF::SVFIR::callGraph

private

all the callsites of a program

Definition at line 102 of file SVFIR.h.

◆ callSiteArgsListMap

CSToArgsListMap SVF::SVFIR::callSiteArgsListMap

private

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

Definition at line 90 of file SVFIR.h.

◆ callSiteRetMap

CSToRetMap SVF::SVFIR::callSiteRetMap

private

Map a callsite to its callsite returns PAGNodes.

Definition at line 91 of file SVFIR.h.

◆ callSiteSet

CallSiteSet SVF::SVFIR::callSiteSet

private

Definition at line 101 of file SVFIR.h.

◆ candidatePointers

OrderedNodeSet SVF::SVFIR::candidatePointers

private

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

Definition at line 97 of file SVFIR.h.

◆ chgraph

CommonCHGraph* SVF::SVFIR::chgraph

private

Definition at line 100 of file SVFIR.h.

◆ funArgsListMap

FunToArgsListMap SVF::SVFIR::funArgsListMap

private

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

Definition at line 89 of file SVFIR.h.

◆ funPtrToCallSitesMap

FunPtrToCallSitesMap SVF::SVFIR::funPtrToCallSitesMap

private

Map a function pointer to the callsites where it is used

Definition at line 94 of file SVFIR.h.

◆ funRetMap

FunToRetMap SVF::SVFIR::funRetMap

private

Map a function to its unique function return PAGNodes.

Definition at line 92 of file SVFIR.h.

◆ GepObjVarMap

NodeOffsetMap SVF::SVFIR::GepObjVarMap

private

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

Definition at line 85 of file SVFIR.h.

◆ GepValObjMap

GepValueVarMap SVF::SVFIR::GepValObjMap

private

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

Definition at line 83 of file SVFIR.h.

◆ globSVFStmtSet

SVFStmtSet SVF::SVFIR::globSVFStmtSet

private

Global PAGEdges without control flow information.

Definition at line 87 of file SVFIR.h.

◆ icfg

ICFG* SVF::SVFIR::icfg

private

SVF Module.

Definition at line 99 of file SVFIR.h.

◆ icfgNode2PTASVFStmtsMap

ICFGNode2SVFStmtsMap SVF::SVFIR::icfgNode2PTASVFStmtsMap

private

Map an ICFGNode to its PointerAnalysis related SVFStmts.

Definition at line 82 of file SVFIR.h.

◆ icfgNode2SVFStmtsMap

ICFGNode2SVFStmtsMap SVF::SVFIR::icfgNode2SVFStmtsMap

private

Map an ICFGNode to its SVFStmts.

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

Definition at line 81 of file SVFIR.h.

◆ indCallSiteToFunPtrMap

CallSiteToFunPtrMap SVF::SVFIR::indCallSiteToFunPtrMap

private

Map an indirect callsite to its function pointer.

Definition at line 93 of file SVFIR.h.

◆ memToFieldsMap

MemObjToFieldsMap SVF::SVFIR::memToFieldsMap

private

Map a mem object id to all its fields.

Definition at line 86 of file SVFIR.h.

◆ pag

std::unique_ptr< SVFIR > SVFIR::pag

staticprivate

call graph

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

Definition at line 104 of file SVFIR.h.

◆ phiNodeMap

PHINodeMap SVF::SVFIR::phiNodeMap

private

A set of phi copy edges.

Definition at line 88 of file SVFIR.h.

◆ svfModule

SVFModule* SVF::SVFIR::svfModule

private

Definition at line 98 of file SVFIR.h.

◆ typeLocSetsMap

TypeLocSetsMap SVF::SVFIR::typeLocSetsMap

private

Map an arg to its base SVFType* and all its field location sets.

Definition at line 84 of file SVFIR.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ CallSiteSet

◆ CallSiteToFunPtrMap

◆ CSToArgsListMap

◆ CSToRetMap

◆ FunPtrToCallSitesMap

◆ FunToArgsListMap

◆ FunToPAGEdgeSetMap

◆ FunToRetMap

◆ GepValueVarMap

◆ ICFGNode2SVFStmtsMap

◆ MemObjToFieldsMap

◆ NodeAccessPath

◆ NodeAccessPathMap

◆ NodeOffset

◆ NodeOffsetMap

◆ NodePairSetMap

◆ NodeToNodeMap

◆ PHINodeMap

◆ SVFStmtList

◆ SVFTypeLocSetsPair

◆ SVFVarList

◆ TypeLocSetsMap

Constructor & Destructor Documentation

◆ SVFIR()

◆ ~SVFIR()

Member Function Documentation

◆ addAddrStmt()

◆ addBinaryOPStmt()

◆ addBlackHoleAddrStmt()

◆ addBlackholeObjNode()

◆ addBlackholePtrNode()

◆ addBranchStmt()

◆ addCallPE()

◆ addCallSite()

◆ addCallSiteArgs()

◆ addCallSiteRets()

◆ addCmpStmt()

◆ addConstantDataObjNode()

◆ addConstantDataValNode()

◆ addConstantFPObjNode()

◆ addConstantFPValNode()

◆ addConstantIntObjNode()

◆ addConstantIntValNode()

◆ addConstantNullPtrObjNode()

◆ addConstantNullPtrValNode()

◆ addConstantObjNode()

◆ addCopyStmt()

◆ addDummyMemObj()

◆ addDummyObjNode() [1/2]

◆ addDummyObjNode() [2/2]

◆ addDummyValNode() [1/2]

◆ addDummyValNode() [2/2]

◆ addFIObjNode()

◆ addFunArgs()

◆ addFunObjNode()

◆ addFunRet()

◆ addFunValNode()

◆ addGepObjNode()

◆ addGepStmt()

◆ addGepValNode()

◆ addGlobalPAGEdge()

◆ addGlobalValueObjNode()

◆ addGlobalValueValNode()

◆ addHeapObjNode()

◆ addIndirectCallsites()

◆ addLoadStmt()

◆ addNormalGepStmt()

◆ addObjNode() [1/2]

◆ addObjNode() [2/2]

◆ addPhiStmt()