#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 ValVar * >	ValVarList

typedef Map< const SVFVar , PhiStmt >	PHINodeMap

typedef Map< const SVFVar , CallPE >	FParmToCallPEMap

typedef Map< const FunObjVar *, ValVarList >	FunToArgsListMap

typedef Map< const CallICFGNode *, ValVarList >	CSToArgsListMap

typedef Map< const RetICFGNode , const ValVar >	CSToRetMap

typedef Map< const FunObjVar , const ValVar >	FunToRetMap

typedef Map< const FunObjVar *, SVFStmtSet >	FunToPAGEdgeSetMap

typedef Map< const ICFGNode *, SVFStmtList >	ICFGNode2SVFStmtsMap

typedef Map< NodeID, NodeID >	NodeToNodeMap

typedef std::pair< NodeID, APOffset >	GepOffset

typedef std::pair< NodeID, AccessPath >	NodeAccessPath

typedef Map< GepOffset, NodeID >	OffsetToGepVarMap

typedef Map< NodeAccessPath, NodeID >	NodeAccessPathMap

typedef Map< NodeID, 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
enum	SYMTYPE { NullPtr , BlkPtr , BlackHole , ConstantObj , ValSymbol , ObjSymbol , RetSymbol , VarargSymbol }
	Symbol types. More...

typedef OrderedMap< NodeID, ObjTypeInfo * >	IDToTypeInfoMapTy
	various maps defined

typedef OrderedMap< const FunObjVar *, NodeID >	FunObjVarToIDMapTy
	function to sym id map

typedef Set< const SVFType * >	SVFTypeSet
	struct type to struct info map

typedef Set< const SVFStmt * >	SVFStmtSet

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
const SVFVar *	getSVFVar (NodeID id) const
	ObjVar/GepObjVar/BaseObjVar.

const ValVar *	getValVar (NodeID id) const

const ObjVar *	getObjVar (NodeID id) const

const BaseObjVar *	getBaseObjVar (NodeID id) const

const GepObjVar *	getGepObjVar (NodeID id) const

bool	isObjVar (NodeID id) const

bool	isBaseObjVar (NodeID id) const

bool	isGepObjVar (NodeID id) const

const IDToNodeMapTy &	getSVFVarMap () const
	Return the entire SVFID to SVFVar map.

MemObjToFieldsMap &	getMemToFieldsMap ()
	Return memToFieldsMap.

OffsetToGepVarMap &	getGepObjNodeMap ()
	Return GepObjVarMap.

OrderedNodeSet &	getAllValidPtrs ()
	Return valid pointers.

void	initialiseCandidatePointers ()
	Initialize candidate pointers.

virtual	~SVFIR ()
	Destructor.

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

ICFG *	getICFG () const

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

CommonCHGraph *	getCHG ()

const CallGraph *	getCallGraph ()
	Get CG.

void	setCallGraph (CallGraph *cg)

const FunObjVar *	getFunObjVar (const std::string &name)

const std::string &	getModuleIdentifier () const

void	setModuleIdentifier (const std::string &moduleIdentifier)

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.

CallPE *	getCallPEForFormalParm (const SVFVar *param) const
	Get the CallPE for a formal parameter (phi-like, nullptr if not found)

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

FunToArgsListMap &	getFunArgsMap ()
	Get function arguments list.

const ValVarList &	getFunArgsList (const FunObjVar *func) const
	Get function arguments list.

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

CSToArgsListMap &	getCallSiteArgsMap ()
	Get callsite argument list.

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

CSToRetMap &	getCallSiteRets ()
	Get callsite return.

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

bool	callsiteHasRet (const RetICFGNode *cs) const

FunToRetMap &	getFunRets ()
	Get function return list.

const ValVar *	getFunRet (const FunObjVar *func) const
	Get function return list.

bool	funHasRet (const FunObjVar *func) const

u32_t	getFieldValNodeNum () const
	Node and edge statistics.

u32_t	getFieldObjNodeNum () const

NodeID	getGepValVar (NodeID 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 BaseObjVar *	getBaseObject (NodeID id) const

const ValVar *	getBaseValVar (NodeID id) const

NodeID	getGepObjVar (const BaseObjVar *baseObj, 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 BaseObjVar *obj) const
	Get a field-insensitive obj SVFIR node according to a mem obj.

NodeID	getFIObjVar (NodeID id) const

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

bool	isConstantObj (NodeID id) const

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

NodeBS &	getAllFieldsObjVars (const BaseObjVar *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 ()

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

NodeID	blkPtrSymID () const

NodeID	nullPtrSymID () const

NodeID	constantSymID () const

NodeID	blackholeSymID () const

u32_t	getTotalSymNum () const
	Statistics.

u32_t	getMaxStructSize () const

IDToTypeInfoMapTy &	idToObjTypeInfoMap ()
	Get different kinds of syms maps.

const IDToTypeInfoMapTy &	idToObjTypeInfoMap () const

FunObjVarToIDMapTy &	retFunObjSyms ()

FunObjVarToIDMapTy &	varargFunObjSyms ()

ObjTypeInfo *	getObjTypeInfo (NodeID id) const

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

NodeID	getVarargNode (const FunObjVar *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

u32_t	getValueNodeNum ()

u32_t	getObjectNodeNum ()

const SVFTypeSet &	getSVFTypes () const
	Constant reader that won't change the state of the symbol table.

const SVFType *	getSVFType (u32_t id) const

const Set< const StInfo * > &	getStInfos () const

virtual APOffset	getModulusOffset (const BaseObjVar *baseObj, const APOffset &apOffset)
	Given an offset from a Gep Instruction, return it modulus offset by considering memory layout.

const StInfo *	getTypeInfo (const SVFType *T) const
	Get struct info.

bool	hasSVFTypeInfo (const SVFType *T)

ObjTypeInfo *	createObjTypeInfo (const SVFType *type)
	Create an objectInfo based on LLVM type (value is null, and type could be null, representing a dummy object)

const ObjTypeInfo *	createDummyObjTypeInfo (NodeID symId, const SVFType *type)

u32_t	getNumOfFlattenElements (const SVFType *T)

u32_t	getFlattenedElemIdx (const SVFType *T, u32_t origId)
	Flattened element idx of an array or struct by considering stride.

const SVFType *	getFlatternedElemType (const SVFType *baseType, u32_t flatten_idx)
	Return the type of a flattened element given a flattened index.

const SVFType *	getOriginalElemType (const SVFType *baseType, u32_t origId) const

void	printFlattenFields (const SVFType *type)
	Debug method.

u32_t	getNodeNumAfterPAGBuild () const

void	setNodeNumAfterPAGBuild (u32_t num)

u32_t	getSVFVarNum () const

u32_t	getSVFStmtNum () const

u32_t	getPTAPAGEdgeNum () const

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

void	dumpSymTable ()

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

void	view ()
	View graph from the debugger.

void	addTypeInfo (const SVFType *ty)

void	addStInfo (StInfo *stInfo)

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.

static std::string	pagFileName ()

static bool	pagReadFromTXT ()

static void	setPagFromTXT (const std::string &txt)

Static Public Member Functions inherited from SVF::IRGraph
static bool	isBlkPtr (NodeID id)
	special value

static bool	isNullPtr (NodeID id)

static bool	isBlkObj (NodeID id)

static bool	isConstantSym (NodeID id)

static bool	isBlkObjOrConstantObj (NodeID id)

Protected Member Functions
NodeID	addBaseObjNode (BaseObjVar *node)

NodeID	addDummyObjNode (DummyObjVar *node)

NodeID	addGepObjNode (GepObjVar *gepObj, NodeID base, const APOffset &apOffset)

void	addGepValObjFromDB (NodeID curInstID, const GepValVar *gepValvar)

Protected Member Functions inherited from SVF::IRGraph
NodeID	addNode (SVFVar *node)
	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 *	hasEdge (SVFStmt *edge, SVFStmt::PEDGEK kind)

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

const std::vector< const SVFType * > &	getFlattenFieldTypes (const SVFStructType *T)
	Return the flattened field type for struct type only.

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 FunObjVar fun, const ValVar arg)
	Get/set method for function/callsite arguments and returns.

void	addFunArgs (FunEntryICFGNode funEntryBlockNode, const FunObjVar fun, const ValVar *arg)

void	addFunRet (const FunObjVar fun, const ValVar ret)
	Add function returns.

void	addFunRet (FunExitICFGNode funExitBlockNode, const FunObjVar fun, const ValVar *ret)

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

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

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

NodeID	addValNode (NodeID i, const SVFType type, const ICFGNode icfgNode)
	add node into SVFIR

NodeID	addFunValNode (NodeID i, const ICFGNode icfgNode, const FunObjVar funObjVar, const SVFType *type)

NodeID	addArgValNode (NodeID i, u32_t argNo, const ICFGNode icfgNode, const FunObjVar callGraphNode, const SVFType *type)

NodeID	addConstantFPValNode (const NodeID i, double dval, const ICFGNode icfgNode, const SVFType type)

NodeID	addConstantIntValNode (NodeID i, const std::pair< s64_t, u64_t > &intValue, const ICFGNode icfgNode, const SVFType type)

NodeID	addConstantNullPtrValNode (const NodeID i, const ICFGNode icfgNode, const SVFType type)

NodeID	addGlobalValNode (const NodeID i, const ICFGNode icfgNode, const SVFType svfType)

NodeID	addConstantDataValNode (const NodeID i, const ICFGNode icfgNode, const SVFType type)

NodeID	addObjNode (NodeID i, ObjTypeInfo ti, const ICFGNode node)
	Add a memory obj node.

NodeID	addHeapObjNode (NodeID i, ObjTypeInfo ti, const ICFGNode node)

NodeID	addStackObjNode (NodeID i, ObjTypeInfo ti, const ICFGNode node)

NodeID	addFunObjNode (NodeID id, ObjTypeInfo ti, const ICFGNode node)

NodeID	addConstantFPObjNode (NodeID i, ObjTypeInfo ti, double dval, const ICFGNode node)

NodeID	addConstantIntObjNode (NodeID i, ObjTypeInfo ti, const std::pair< s64_t, u64_t > &intValue, const ICFGNode node)

NodeID	addConstantNullPtrObjNode (const NodeID i, ObjTypeInfo ti, const ICFGNode node)

NodeID	addGlobalObjNode (const NodeID i, ObjTypeInfo ti, const ICFGNode node)

NodeID	addConstantDataObjNode (const NodeID i, ObjTypeInfo ti, const ICFGNode node)

NodeID	addRetNode (NodeID i, const FunObjVar callGraphNode, const SVFType type, const ICFGNode *icn)
	Add a unique return node for a procedure.

NodeID	addVarargNode (NodeID i, const FunObjVar val, const SVFType type, const ICFGNode *n)
	Add a unique vararg node for a procedure.

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

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

NodeID	addFIObjNode (NodeID i, ObjTypeInfo ti, const ICFGNode node)
	Add a field-insensitive node, this method can only invoked by getFIGepObjNode.

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

NodeID	addDummyObjNode (NodeID i, const SVFType *type)

NodeID	addBlackholeObjNode ()

NodeID	addConstantObjNode ()

NodeID	addBlackholePtrNode ()

NodeID	addIntrinsicValNode (NodeID i, const SVFType *type)

NodeID	addAsmPCValNode (NodeID i, const SVFType *type)

NodeID	addValNode (ValVar *node)
	Add a value (pointer) node.

NodeID	addObjNode (ObjVar *node)
	Add a memory obj node.

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

NodeID	addVarargNode (const FunObjVar , SVFVar node)
	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.

void	addAddrStmt (AddrStmt *edge)

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

void	addCopyStmt (CopyStmt *edge)

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

void	addPhiStmt (PhiStmt edge, SVFVar src, SVFVar *dst)

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

void	addSelectStmt (SelectStmt edge, SVFVar src, SVFVar *dst)

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

void	addCmpStmt (CmpStmt edge, SVFVar src, SVFVar *dst)

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

void	addBinaryOPStmt (BinaryOPStmt edge, SVFVar src, SVFVar *dst)

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

void	addUnaryOPStmt (UnaryOPStmt edge, SVFVar src, SVFVar *dst)

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

void	addBranchStmt (BranchStmt edge, SVFVar src, SVFVar *dst)

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

void	addLoadStmt (LoadStmt *edge)

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

void	addStoreStmt (StoreStmt edge, SVFVar src, SVFVar *dst)

CallPE *	addCallPE (NodeID src, NodeID dst, const CallICFGNode cs, const FunEntryICFGNode entry)
	Add Call edge (phi-like: merges actual params from all call sites into formal param)

void	addCallPE (CallPE edge, SVFVar src, SVFVar *dst)

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

void	addRetPE (RetPE edge, SVFVar src, SVFVar *dst)

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

void	addGepStmt (GepStmt *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.

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

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

NodeSet	constantObjs
	Constant objects and their fields, recorded when each object node is added.

SVFStmtSet	globSVFStmtSet
	Global PAGEdges without control flow information.

PHINodeMap	phiNodeMap
	A set of phi copy edges.

FParmToCallPEMap	fParmToCallPEMap
	Map a formal param to its CallPE.

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

ICFG *	icfg

CommonCHGraph *	chgraph

CallSiteSet	callSiteSet

CallGraph *	callGraph
	all the callsites of a program

std::string	moduleIdentifier

Static Private Attributes
static std::unique_ptr< SVFIR >	pag
	Callgraph with direct calls only; no change allowed after init and use callgraph in PointerAnalysis for indirect calls)

static std::string	pagReadFromTxt = ""

Friends
class	SVFIRBuilder

class	ExternalPAG

class	PAGBuilderFromFile

class	BVDataPTAImpl

class	GraphDBClient

class	GraphDBSVFIRBuilder

Additional Inherited Members
Public Attributes inherited from SVF::IRGraph
const SVFType *	maxStruct
	The struct type with the most fields.

u32_t	maxStSize
	The number of fields in max_struct.

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

u32_t	nodeNum
	total num of edge

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

u32_t	valVarNum

u32_t	objVarNum

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.

Definition at line 45 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*,ValVarList> SVF::SVFIR::CSToArgsListMap

Definition at line 64 of file SVFIR.h.

◆ CSToRetMap

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

Definition at line 65 of file SVFIR.h.

◆ FParmToCallPEMap

typedef Map<const SVFVar*,CallPE*> SVF::SVFIR::FParmToCallPEMap

Definition at line 62 of file SVFIR.h.

◆ FunPtrToCallSitesMap

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

Definition at line 57 of file SVFIR.h.

◆ FunToArgsListMap

typedef Map<const FunObjVar*,ValVarList> SVF::SVFIR::FunToArgsListMap

Definition at line 63 of file SVFIR.h.

◆ FunToPAGEdgeSetMap

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

Definition at line 67 of file SVFIR.h.

◆ FunToRetMap

typedef Map<const FunObjVar*,const ValVar*> SVF::SVFIR::FunToRetMap

Definition at line 66 of file SVFIR.h.

◆ GepOffset

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

Definition at line 70 of file SVFIR.h.

◆ GepValueVarMap

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

Definition at line 74 of file SVFIR.h.

◆ ICFGNode2SVFStmtsMap

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

Definition at line 68 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 71 of file SVFIR.h.

◆ NodeAccessPathMap

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

Definition at line 73 of file SVFIR.h.

◆ NodePairSetMap

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

Definition at line 77 of file SVFIR.h.

◆ NodeToNodeMap

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

Definition at line 69 of file SVFIR.h.

◆ OffsetToGepVarMap

typedef Map<GepOffset,NodeID> SVF::SVFIR::OffsetToGepVarMap

Definition at line 72 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 75 of file SVFIR.h.

◆ TypeLocSetsMap

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

Definition at line 76 of file SVFIR.h.

◆ ValVarList

typedef std::vector<const ValVar*> SVF::SVFIR::ValVarList

Definition at line 60 of file SVFIR.h.

Constructor & Destructor Documentation

◆ SVFIR()

SVFIR::SVFIR ( bool buildFromFile )

private

Constructor.

Definition at line 43 of file SVFIR.cpp.

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

◆ ~SVFIR()

virtual SVF::SVFIR::~SVFIR ( )

inlinevirtual

Destructor.

Definition at line 217 of file SVFIR.h.

    {
        destroy();
    }

Member Function Documentation

◆ addAddrStmt() [1/2]

void SVFIR::addAddrStmt ( AddrStmt * edge )

private

Definition at line 77 of file SVFIR.cpp.

{
    addToStmt2TypeMap(edge);
    addEdge(getGNode(edge->getRHSVarID()),getGNode(edge->getLHSVarID()), edge);
}

◆ addAddrStmt() [2/2]

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

private

Add an edge into SVFIR.

Add Address edge

Definition at line 64 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);
        addAddrStmt(addrPE);
        return addrPE;
    }
}

◆ addArgValNode()

NodeID SVF::SVFIR::addArgValNode	(	NodeID	i,
		u32_t	argNo,
		const ICFGNode *	icfgNode,
		const FunObjVar *	callGraphNode,
		const SVFType *	type
	)

inlineprivate

Definition at line 677 of file SVFIR.h.

    {
        ArgValVar* node =
            new ArgValVar(i, argNo, icfgNode, callGraphNode, type);
        return addValNode(node);
    }

◆ addAsmPCValNode()

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

inlineprivate

Definition at line 843 of file SVFIR.h.

    {
        return addValNode(new AsmPCValVar(i, type));
    }

◆ addBaseObjNode()

NodeID SVF::SVFIR::addBaseObjNode ( BaseObjVar * node )

inlineprotected

Definition at line 585 of file SVFIR.h.

    {
        memToFieldsMap[node->getId()].set(node->getId());
        return addObjNode(node);
    }

◆ addBinaryOPStmt() [1/2]

void SVFIR::addBinaryOPStmt	(	BinaryOPStmt *	edge,
		SVFVar *	src,
		SVFVar *	dst
	)

private

Definition at line 210 of file SVFIR.cpp.

{
    addToStmt2TypeMap(edge);
    addEdge(src, dst, edge);
}

◆ addBinaryOPStmt() [2/2]

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

private

Add Copy edge.

Add Compare edge

Definition at line 194 of file SVFIR.cpp.

{
    ValVar* op1Node = const_cast<ValVar*>(getValVar(op1));
    ValVar* op2Node = const_cast<ValVar*>(getValVar(op2));
    ValVar* dstNode = const_cast<ValVar*>(getValVar(dst));
    if(hasLabeledEdge(op1Node, dstNode, SVFStmt::BinaryOp, op2Node))
        return nullptr;
    else
    {
        std::vector<ValVar*> opnds = {op1Node, op2Node};
        BinaryOPStmt* binaryOP = new BinaryOPStmt(dstNode, opnds, opcode);
        addBinaryOPStmt(binaryOP,op1Node,dstNode);
        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 364 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 827 of file SVFIR.h.

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

◆ addBlackholePtrNode()

NodeID SVF::SVFIR::addBlackholePtrNode ( )

inlineprivate

Definition at line 835 of file SVFIR.h.

    {
        return addDummyValNode(getBlkPtr(), nullptr);
    }

◆ addBranchStmt() [1/2]

void SVFIR::addBranchStmt	(	BranchStmt *	edge,
		SVFVar *	src,
		SVFVar *	dst
	)

private

Definition at line 255 of file SVFIR.cpp.

{
    addToStmt2TypeMap(edge);
    addEdge(src, dst, edge);
}

◆ addBranchStmt() [2/2]

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

private

Add BranchStmt.

Definition at line 241 of file SVFIR.cpp.

{
    ValVar* brNode = const_cast<ValVar*>(getValVar(br));
    ValVar* condNode = const_cast<ValVar*>(getValVar(cond));
    if(hasNonlabeledEdge(condNode,brNode, SVFStmt::Branch))
        return nullptr;
    else
    {
        BranchStmt* branch = new BranchStmt(brNode, condNode, succs);
        addBranchStmt(branch,condNode,brNode);
        return branch;
    }
}

◆ addCallPE() [1/2]

void SVFIR::addCallPE	(	CallPE *	edge,
		SVFVar *	src,
		SVFVar *	dst
	)

private

Definition at line 331 of file SVFIR.cpp.

{
    addToStmt2TypeMap(edge);
    addEdge(src, dst, edge);
    fParmToCallPEMap[dst] = edge;
}

◆ addCallPE() [2/2]

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

private

Add Call edge (phi-like: merges actual params from all call sites into formal param)

return null if we already added this CallPE

Definition at line 311 of file SVFIR.cpp.

{
    ValVar* opNode = const_cast<ValVar*>(getValVar(src));
    ValVar* resNode = const_cast<ValVar*>(getValVar(dst));
    FParmToCallPEMap::iterator it = fParmToCallPEMap.find(resNode);
    // if first operand, create a new CallPE, otherwise add the operand to the existing CallPE
    if(it == fParmToCallPEMap.end())
    {
        CallPE* callPE = new CallPE(resNode, {opNode}, {cs}, entry);
        addCallPE(callPE, opNode, resNode);
        return callPE;
    }
    else
    {
        it->second->addOpVar(opNode, cs);
        return nullptr;
    }
}

◆ addCallSite()

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

inlineprivate

Add callsites.

Definition at line 870 of file SVFIR.h.

    {
        callSiteSet.insert(call);
    }

◆ addCallSiteArgs()

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

inlineprivate

Add callsite arguments.

Definition at line 642 of file SVFIR.h.

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

◆ addCallSiteRets()

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

inlineprivate

Add callsite returns.

Definition at line 648 of file SVFIR.h.

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

◆ addCmpStmt() [1/2]

void SVFIR::addCmpStmt	(	CmpStmt *	edge,
		SVFVar *	src,
		SVFVar *	dst
	)

private

Definition at line 184 of file SVFIR.cpp.

{
    addToStmt2TypeMap(edge);
    addEdge(src, dst, edge);
}

◆ addCmpStmt() [2/2]

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

private

Add Copy edge.

Add Compare edge

Definition at line 168 of file SVFIR.cpp.

{
    ValVar* op1Node = const_cast<ValVar*>(getValVar(op1));
    ValVar* op2Node = const_cast<ValVar*>(getValVar(op2));
    ValVar* dstNode = const_cast<ValVar*>(getValVar(dst));
    if(hasLabeledEdge(op1Node, dstNode, SVFStmt::Cmp, op2Node))
        return nullptr;
    else
    {
        std::vector<ValVar*> opnds = {op1Node, op2Node};
        CmpStmt* cmp = new CmpStmt(dstNode, opnds, predicate);
        addCmpStmt(cmp, op1Node, dstNode);
        return cmp;
    }
}

◆ addConstantDataObjNode()

NodeID SVF::SVFIR::addConstantDataObjNode	(	const NodeID	i,
		ObjTypeInfo *	ti,
		const ICFGNode *	node
	)

inlineprivate

Definition at line 774 of file SVFIR.h.

    {
        ConstDataObjVar* conObj = new ConstDataObjVar(i, ti, node);
        return addBaseObjNode(conObj);
    }

◆ addConstantDataValNode()

NodeID SVF::SVFIR::addConstantDataValNode	(	const NodeID	i,
		const ICFGNode *	icfgNode,
		const SVFType *	type
	)

inlineprivate

Definition at line 710 of file SVFIR.h.

    {
        SVFVar* node = new ConstDataValVar(i, icfgNode, type);
        return addNode(node);
    }

◆ addConstantFPObjNode()

NodeID SVF::SVFIR::addConstantFPObjNode	(	NodeID	i,
		ObjTypeInfo *	ti,
		double	dval,
		const ICFGNode *	node
	)

inlineprivate

Definition at line 748 of file SVFIR.h.

    {
        ConstFPObjVar* conObj = new ConstFPObjVar(i, dval, ti, node);
        return addBaseObjNode(conObj);
    }

◆ addConstantFPValNode()

NodeID SVF::SVFIR::addConstantFPValNode	(	const NodeID	i,
		double	dval,
		const ICFGNode *	icfgNode,
		const SVFType *	type
	)

inlineprivate

Definition at line 684 of file SVFIR.h.

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

◆ addConstantIntObjNode()

NodeID SVF::SVFIR::addConstantIntObjNode	(	NodeID	i,
		ObjTypeInfo *	ti,
		const std::pair< s64_t, u64_t > &	intValue,
		const ICFGNode *	node
	)

inlineprivate

Definition at line 755 of file SVFIR.h.

    {
        ConstIntObjVar* conObj =
            new ConstIntObjVar(i, intValue.first, intValue.second, ti, node);
        return addBaseObjNode(conObj);
    }

◆ addConstantIntValNode()

NodeID SVF::SVFIR::addConstantIntValNode	(	NodeID	i,
		const std::pair< s64_t, u64_t > &	intValue,
		const ICFGNode *	icfgNode,
		const SVFType *	type
	)

inlineprivate

Definition at line 691 of file SVFIR.h.

    {
        SVFVar* node = new ConstIntValVar(i, intValue.first, intValue.second, icfgNode, type);
        return addNode(node);
    }

◆ addConstantNullPtrObjNode()

NodeID SVF::SVFIR::addConstantNullPtrObjNode	(	const NodeID	i,
		ObjTypeInfo *	ti,
		const ICFGNode *	node
	)

inlineprivate

Definition at line 763 of file SVFIR.h.

    {
        ConstNullPtrObjVar* conObj = new ConstNullPtrObjVar(i, ti, node);
        return addBaseObjNode(conObj);
    }

◆ addConstantNullPtrValNode()

NodeID SVF::SVFIR::addConstantNullPtrValNode	(	const NodeID	i,
		const ICFGNode *	icfgNode,
		const SVFType *	type
	)

inlineprivate

Definition at line 698 of file SVFIR.h.

    {
        SVFVar* node = new ConstNullPtrValVar(i, icfgNode, type);
        return addNode(node);
    }

◆ addConstantObjNode()

NodeID SVF::SVFIR::addConstantObjNode ( )

inlineprivate

Definition at line 831 of file SVFIR.h.

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

◆ addCopyStmt() [1/2]

void SVFIR::addCopyStmt ( CopyStmt * edge )

private

Definition at line 100 of file SVFIR.cpp.

{
    addToStmt2TypeMap(edge);
    addEdge(getGNode(edge->getRHSVarID()),getGNode(edge->getLHSVarID()), edge);
}

◆ addCopyStmt() [2/2]

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

private

Add Copy edge.

Add Copy edge

Definition at line 86 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);
        addCopyStmt(copyPE);
        return copyPE;
    }
}

◆ addDummyObjNode() [1/3]

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

inline

Definition at line 570 of file SVFIR.h.

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

◆ addDummyObjNode() [2/3]

NodeID SVFIR::addDummyObjNode ( DummyObjVar * node )

protected

Definition at line 813 of file SVFIR.cpp.

{
    return addObjNode(node);
}

◆ addDummyObjNode() [3/3]

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

inlineprivate

Definition at line 813 of file SVFIR.h.

    {
        if (idToObjTypeInfoMap().find(i) == idToObjTypeInfoMap().end())
        {
            ObjTypeInfo* ti = createObjTypeInfo(type);
            idToObjTypeInfoMap()[i] = ti;
            return addDummyObjNode(new DummyObjVar(i, ti, nullptr));
        }
        else
        {
            return addDummyObjNode(new DummyObjVar(i, getObjTypeInfo(i), nullptr));
        }
    }

◆ addDummyValNode() [1/2]

NodeID SVF::SVFIR::addDummyValNode ( )

inline

Definition at line 566 of file SVFIR.h.

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

◆ addDummyValNode() [2/2]

NodeID SVF::SVFIR::addDummyValNode	(	NodeID	i,
		const ICFGNode *	node
	)

inlineprivate

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

Definition at line 809 of file SVFIR.h.

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

◆ addFIObjNode()

NodeID SVF::SVFIR::addFIObjNode	(	NodeID	i,
		ObjTypeInfo *	ti,
		const ICFGNode *	node
	)

inlineprivate

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

Definition at line 798 of file SVFIR.h.

    {
        BaseObjVar* baseObj = new BaseObjVar(i, ti, node);
        return addBaseObjNode(baseObj);
    }

◆ addFunArgs() [1/2]

void SVF::SVFIR::addFunArgs	(	const FunObjVar *	fun,
		const ValVar *	arg
	)

inlineprivate

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

Add function arguments

Definition at line 618 of file SVFIR.h.

    {
        FunEntryICFGNode* funEntryBlockNode = icfg->getFunEntryICFGNode(fun);
        addFunArgs(funEntryBlockNode, fun, arg);
    }

◆ addFunArgs() [2/2]

void SVF::SVFIR::addFunArgs	(	FunEntryICFGNode *	funEntryBlockNode,
		const FunObjVar *	fun,
		const ValVar *	arg
	)

inlineprivate

Definition at line 624 of file SVFIR.h.

    {
        funEntryBlockNode->addFormalParms(arg);
        funArgsListMap[fun].push_back(arg);
    }

◆ addFunObjNode()

NodeID SVF::SVFIR::addFunObjNode	(	NodeID	id,
		ObjTypeInfo *	ti,
		const ICFGNode *	node
	)

inlineprivate

Definition at line 741 of file SVFIR.h.

    {
        FunObjVar* funObj = new FunObjVar(id, ti, node);
        return addBaseObjNode(funObj);
    }

◆ addFunRet() [1/2]

void SVF::SVFIR::addFunRet	(	const FunObjVar *	fun,
		const ValVar *	ret
	)

inlineprivate

Add function returns.

Definition at line 630 of file SVFIR.h.

    {
        FunExitICFGNode* funExitBlockNode = icfg->getFunExitICFGNode(fun);
        addFunRet(funExitBlockNode, fun, ret);
    }

◆ addFunRet() [2/2]

void SVF::SVFIR::addFunRet	(	FunExitICFGNode *	funExitBlockNode,
		const FunObjVar *	fun,
		const ValVar *	ret
	)

inlineprivate

Definition at line 636 of file SVFIR.h.

    {
        funExitBlockNode->addFormalRet(ret);
        funRetMap[fun] = ret;
    }

◆ addFunValNode()

NodeID SVF::SVFIR::addFunValNode	(	NodeID	i,
		const ICFGNode *	icfgNode,
		const FunObjVar *	funObjVar,
		const SVFType *	type
	)

inlineprivate

Definition at line 671 of file SVFIR.h.

    {
        FunValVar* node = new FunValVar(i, icfgNode, funObjVar, type);
        return addValNode(node);
    }

◆ addGepObjNode() [1/2]

NodeID SVFIR::addGepObjNode	(	const BaseObjVar *	baseObj,
		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 559 of file SVFIR.cpp.

{
    //assert(findPAGNode(i) == false && "this node should not be created before");
    NodeID base = baseObj->getId();
    assert(0==GepObjVarMap.count(std::make_pair(base, apOffset))
           && "this node should not be created before");
    //ABTest
    GepObjVar *node = new GepObjVar(baseObj, gepId, apOffset);
    return addGepObjNode(node, base, apOffset);
}

◆ addGepObjNode() [2/2]

NodeID SVFIR::addGepObjNode	(	GepObjVar *	gepObj,
		NodeID	base,
		const APOffset &	apOffset
	)

protected

Definition at line 547 of file SVFIR.cpp.

{
    assert(0==GepObjVarMap.count(std::make_pair(base, apOffset))
           && "this node should not be created before");
    GepObjVarMap[std::make_pair(base, apOffset)] = gepObj->getId();
    memToFieldsMap[base].set(gepObj->getId());
    return addObjNode(gepObj);
}

◆ addGepStmt() [1/2]

void SVFIR::addGepStmt ( GepStmt * edge )

private

Definition at line 452 of file SVFIR.cpp.

{
    SVFVar* baseNode = getGNode(gepPE->getRHSVarID());
    SVFVar* dstNode = getGNode(gepPE->getLHSVarID());
    addToStmt2TypeMap(gepPE);
    addEdge(baseNode, dstNode, gepPE);
 
}

◆ addGepStmt() [2/2]

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 419 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	(	NodeID	curInst,
		const ValVar *	baseVar,
		const AccessPath &	ap,
		NodeID	i,
		const SVFType *	type,
		const ICFGNode *	icn
	)

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

{
    NodeID base = baseVar->getId();
    //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(baseVar, i, ap, type, icn);
    node->setLLVMVarInstID(curInst);
    return addValNode(node);
}

◆ addGepValObjFromDB()

void SVF::SVFIR::addGepValObjFromDB	(	NodeID	curInstID,
		const GepValVar *	gepValvar
	)

inlineprotected

Definition at line 595 of file SVFIR.h.

    {
        GepValObjMap[curInstID][std::make_pair(gepValvar->getBaseNode()->getId(), gepValvar->getAccessPath())] = gepValvar->getId();
    }

◆ addGlobalObjNode()

NodeID SVF::SVFIR::addGlobalObjNode	(	const NodeID	i,
		ObjTypeInfo *	ti,
		const ICFGNode *	node
	)

inlineprivate

Definition at line 769 of file SVFIR.h.

    {
        GlobalObjVar* gObj = new GlobalObjVar(i, ti, node);
        return addBaseObjNode(gObj);
    }

◆ addGlobalPAGEdge()

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

inlineprivate

Add global PAGEdges (not in a procedure)

Definition at line 865 of file SVFIR.h.

    {
        globSVFStmtSet.insert(edge);
    }

◆ addGlobalValNode()

NodeID SVF::SVFIR::addGlobalValNode	(	const NodeID	i,
		const ICFGNode *	icfgNode,
		const SVFType *	svfType
	)

inlineprivate

Definition at line 704 of file SVFIR.h.

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

◆ addHeapObjNode()

NodeID SVF::SVFIR::addHeapObjNode	(	NodeID	i,
		ObjTypeInfo *	ti,
		const ICFGNode *	node
	)

inlineprivate

Creates and adds a heap object node to the SVFIR

Definition at line 726 of file SVFIR.h.

    {
        HeapObjVar *heapObj = new HeapObjVar(i, ti, node);
        return addBaseObjNode(heapObj);
    }

◆ addIndirectCallsites()

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

inlineprivate

Add indirect callsites.

Definition at line 654 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?");
    }

◆ addIntrinsicValNode()

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

inlineprivate

Definition at line 839 of file SVFIR.h.

    {
        return addValNode(new IntrinsicValVar(i, type));
    }

◆ addLoadStmt() [1/2]

void SVFIR::addLoadStmt ( LoadStmt * edge )

private

Definition at line 278 of file SVFIR.cpp.

{
    addToStmt2TypeMap(edge);
    addEdge(getGNode(edge->getRHSVarID()),getGNode(edge->getLHSVarID()), edge);
}

◆ addLoadStmt() [2/2]

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

private

Add Load edge.

Add Load edge

Definition at line 264 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);
        addLoadStmt(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 438 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);
        addGepStmt(gepPE);
        return gepPE;
    }
}

◆ addObjNode() [1/2]

NodeID SVF::SVFIR::addObjNode	(	NodeID	i,
		ObjTypeInfo *	ti,
		const ICFGNode *	node
	)

inlineprivate

Add a memory obj node.

Definition at line 718 of file SVFIR.h.

    {
        return addFIObjNode( i, ti, node);
    }

◆ addObjNode() [2/2]

NodeID SVFIR::addObjNode ( ObjVar * node )

private

Add a memory obj node.

Definition at line 796 of file SVFIR.cpp.

{
    assert(node && "node cannot be nullptr.");
    assert(hasGNode(node->getId()) == false &&
           "This NodeID clashes here. Please check NodeIDAllocator. Switch "
           "Strategy::DBUG to SEQ or DENSE");
    NodeID id = addNode(node);
    // An object's constness is fixed by the time its node is added: SymbolTableBuilder sets
    // the constant flags before the SVFIR is built, and a field object (GepObjVar) shares
    // the constness of its base object, which is added first.
    const BaseObjVar* obj = getBaseObject(id);
    assert(obj && "not an object node?");
    if (isConstantSym(id) || obj->isConstDataOrConstGlobal())
        constantObjs.insert(id);
    return id;
}

◆ addPhiStmt() [1/2]

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

{
    ValVar* opNode = const_cast<ValVar*>(getValVar(opnd));
    ValVar* resNode = const_cast<ValVar*>(getValVar(res));
    PHINodeMap::iterator it = phiNodeMap.find(resNode);
    if(it == phiNodeMap.end())
    {
        PhiStmt* phi = new PhiStmt(resNode, {opNode}, {pred});
        addPhiStmt(phi, opNode, resNode);
        return phi;
    }
    else
    {
        it->second->addOpVar(opNode,pred);
        return nullptr;
    }
}

◆ addPhiStmt() [2/2]

void SVFIR::addPhiStmt	(	PhiStmt *	edge,
		SVFVar *	src,
		SVFVar *	dst
	)

private

Definition at line 128 of file SVFIR.cpp.

{
    SVFVar* opNode = src;
    SVFVar* resNode = dst;
 
    addToStmt2TypeMap(edge);
    addEdge(opNode, resNode, edge);
    phiNodeMap[resNode] = edge;
 
}

◆ addRetNode() [1/2]

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

inlineprivate

Add a unique return node for a procedure.

Definition at line 854 of file SVFIR.h.

    {
        return addNode(node);
    }

◆ addRetNode() [2/2]

NodeID SVF::SVFIR::addRetNode	(	NodeID	i,
		const FunObjVar *	callGraphNode,
		const SVFType *	type,
		const ICFGNode *	icn
	)

inlineprivate

Add a unique return node for a procedure.

Definition at line 781 of file SVFIR.h.

    {
        SVFVar *node = new RetValPN(i, callGraphNode, type, icn);
        return addRetNode(callGraphNode, node);
    }

◆ addRetPE() [1/2]

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

private

Add Return edge.

Add Return edge

Definition at line 341 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);
        addRetPE(retPE,srcNode,dstNode);
        return retPE;
    }
}

◆ addRetPE() [2/2]

void SVFIR::addRetPE	(	RetPE *	edge,
		SVFVar *	src,
		SVFVar *	dst
	)

private

Definition at line 355 of file SVFIR.cpp.

{
    addToStmt2TypeMap(edge);
    addEdge(src, dst, edge);
}

◆ addSelectStmt() [1/2]

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

private

Add SelectStmt.

Add Phi statement

Definition at line 142 of file SVFIR.cpp.

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

◆ addSelectStmt() [2/2]

void SVFIR::addSelectStmt	(	SelectStmt *	edge,
		SVFVar *	src,
		SVFVar *	dst
	)

private

Definition at line 159 of file SVFIR.cpp.

{
    addToStmt2TypeMap(edge);
    addEdge(src, dst, edge);
}

◆ addStackObjNode()

NodeID SVF::SVFIR::addStackObjNode	(	NodeID	i,
		ObjTypeInfo *	ti,
		const ICFGNode *	node
	)

inlineprivate

Creates and adds a stack object node to the SVFIR

Definition at line 735 of file SVFIR.h.

    {
        StackObjVar *stackObj = new StackObjVar(i, ti, node);
        return addBaseObjNode(stackObj);
    }

◆ addStoreStmt() [1/2]

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 288 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);
        addStoreStmt(storePE,srcNode,dstNode);
        return storePE;
    }
}

◆ addStoreStmt() [2/2]

void SVFIR::addStoreStmt	(	StoreStmt *	edge,
		SVFVar *	src,
		SVFVar *	dst
	)

private

Definition at line 302 of file SVFIR.cpp.

{
    addToStmt2TypeMap(edge);
    addEdge(src,dst, edge);
}

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

{
    ValVar* opNode = const_cast<ValVar*>(getValVar(src));
    ValVar* resNode = const_cast<ValVar*>(getValVar(dst));
    FParmToCallPEMap::iterator it = fParmToCallPEMap.find(resNode);
    // if first operand, create a new TDForkPE, otherwise add the operand to the existing TDForkPE
    if(it == fParmToCallPEMap.end())
    {
        TDForkPE* forkPE = new TDForkPE(resNode, {opNode}, {cs}, entry);
        addToStmt2TypeMap(forkPE);
        addEdge(opNode, resNode, forkPE);
        fParmToCallPEMap[resNode] = forkPE;
        return forkPE;
    }
    else
    {
        it->second->addOpVar(opNode, cs);
        return nullptr;
    }
}

◆ 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 399 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);
        addRetPE(joinPE,srcNode,dstNode);
        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 603 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 329 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 337 of file SVFIR.h.

    {
        typeLocSetsMap[argId]=locSets;
    }

◆ addUnaryOPStmt() [1/2]

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

private

Add Unary edge.

Add Unary edge

Definition at line 218 of file SVFIR.cpp.

{
    ValVar* srcNode = const_cast<ValVar*>(getValVar(src));
    ValVar* dstNode = const_cast<ValVar*>(getValVar(dst));
    if(hasNonlabeledEdge(srcNode,dstNode, SVFStmt::UnaryOp))
        return nullptr;
    else
    {
        UnaryOPStmt* unaryOP = new UnaryOPStmt(srcNode, dstNode, opcode);
        addUnaryOPStmt(unaryOP, srcNode,dstNode);
        return unaryOP;
    }
}

◆ addUnaryOPStmt() [2/2]

void SVFIR::addUnaryOPStmt	(	UnaryOPStmt *	edge,
		SVFVar *	src,
		SVFVar *	dst
	)

private

Definition at line 232 of file SVFIR.cpp.

{
    addToStmt2TypeMap(edge);
    addEdge(src, dst, edge);
}

◆ addValNode() [1/2]

NodeID SVF::SVFIR::addValNode	(	NodeID	i,
		const SVFType *	type,
		const ICFGNode *	icfgNode
	)

inlineprivate

add node into SVFIR

Add a value (pointer) node

Definition at line 665 of file SVFIR.h.

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

◆ addValNode() [2/2]

NodeID SVFIR::addValNode ( ValVar * node )

private

Add a value (pointer) node.

Definition at line 787 of file SVFIR.cpp.

{
    assert(node && "node cannot be nullptr.");
    assert(hasGNode(node->getId()) == false &&
           "This NodeID clashes here. Please check NodeIDAllocator. Switch "
           "Strategy::DBUG to SEQ or DENSE");
    return addNode(node);
}

◆ addVarargNode() [1/2]

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

inlineprivate

Add a unique vararg node for a procedure.

Definition at line 859 of file SVFIR.h.

    {
        return addNode(node);
    }

◆ addVarargNode() [2/2]

NodeID SVF::SVFIR::addVarargNode	(	NodeID	i,
		const FunObjVar *	val,
		const SVFType *	type,
		const ICFGNode *	n
	)

inlineprivate

Add a unique vararg node for a procedure.

Definition at line 787 of file SVFIR.h.

    {
        SVFVar *node = new VarArgValPN(i, val, type, n);
        return addNode(node);
    }

◆ 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 465 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 414 of file SVFIR.h.

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

◆ destroy()

void SVFIR::destroy ( )

private

Clean up memory.

Clean up memory

Definition at line 636 of file SVFIR.cpp.

{
    delete icfg;
    icfg = nullptr;
    delete chgraph;
    chgraph = nullptr;
    delete callGraph;
    callGraph = nullptr;
}

◆ funHasRet()

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

inline

Definition at line 430 of file SVFIR.h.

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

◆ getAllFieldsObjVars() [1/2]

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

Get all fields of an object.

Get all fields object nodes of an object

Definition at line 573 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 582 of file SVFIR.cpp.

{
    const SVFVar* node = pag->getSVFVar(id);
    (void)node; // Suppress warning of unused variable under release build
    assert(SVFUtil::isa<ObjVar>(node) && "need an object node");
    return getAllFieldsObjVars(getBaseObject(id));
}

◆ getAllValidPtrs()

OrderedNodeSet & SVF::SVFIR::getAllValidPtrs ( )

inline

Return valid pointers.

Definition at line 209 of file SVFIR.h.

    {
        return candidatePointers;
    }

◆ getBaseObject()

const BaseObjVar * SVF::SVFIR::getBaseObject ( 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 499 of file SVFIR.h.

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

◆ getBaseObjVar()

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

inline

Definition at line 160 of file SVFIR.h.

    {
        if(const SVFVar* var = getSVFVar(id))
            return SVFUtil::dyn_cast<BaseObjVar>(var);
        else
        {
            assert(false && "the Node is not a BaseObjVar");
            return nullptr;
        }
    }

◆ getBaseObjVarID()

NodeID SVF::SVFIR::getBaseObjVarID ( 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 554 of file SVFIR.h.

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

◆ getBaseValVar()

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

inline

Definition at line 509 of file SVFIR.h.

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

◆ getCallGraph()

const CallGraph * SVF::SVFIR::getCallGraph ( )

inline

Get CG.

Definition at line 249 of file SVFIR.h.

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

◆ getCallPEForFormalParm()

CallPE * SVF::SVFIR::getCallPEForFormalParm ( const SVFVar * param ) const

inline

Get the CallPE for a formal parameter (phi-like, nullptr if not found)

Definition at line 362 of file SVFIR.h.

    {
        auto it = fParmToCallPEMap.find(param);
        return it != fParmToCallPEMap.end() ? it->second : nullptr;
    }

◆ getCallSiteArgsList()

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

inline

Get callsite argument list.

Definition at line 396 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 391 of file SVFIR.h.

    {
        return callSiteArgsListMap;
    }

◆ getCallSiteRet()

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

inline

Get callsite return.

Definition at line 408 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 403 of file SVFIR.h.

    {
        return callSiteRetMap;
    }

◆ getCallSiteSet()

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

inline

Get all callsites.

Definition at line 352 of file SVFIR.h.

    {
        return callSiteSet;
    }

◆ getCHG()

CommonCHGraph * SVF::SVFIR::getCHG ( )

inline

Definition at line 242 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 442 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 595 of file SVFIR.cpp.

{
    const SVFVar* node = pag->getSVFVar(id);
    (void)node; // Suppress warning of unused variable under release build
    assert(SVFUtil::isa<ObjVar>(node) && "need an object node");
    const BaseObjVar* obj = getBaseObject(id);
    if(obj->isFieldInsensitive())
    {
        NodeBS bs;
        bs.set(getFIObjVar(obj));
        return bs;
    }
    else
        return getAllFieldsObjVars(obj);
}

◆ getFieldValNodeNum()

u32_t SVF::SVFIR::getFieldValNodeNum ( ) const

inline

Node and edge statistics.

Definition at line 438 of file SVFIR.h.

    {
        return GepValObjMap.size();
    }

◆ getFIObjVar() [1/2]

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

inline

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

Definition at line 525 of file SVFIR.h.

    {
        return obj->getId();
    }

◆ getFIObjVar() [2/2]

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

inline

Definition at line 529 of file SVFIR.h.

    {
        return getBaseObjVarID(id);
    }

◆ getFunArgsList()

const ValVarList & SVF::SVFIR::getFunArgsList ( const FunObjVar * func ) const

inline

Get function arguments list.

Definition at line 379 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 374 of file SVFIR.h.

    {
        return funArgsListMap;
    }

◆ getFunObjVar()

const FunObjVar * SVFIR::getFunObjVar ( const std::string & name )

Definition at line 48 of file SVFIR.cpp.

{
    for (const auto &item: *callGraph)
    {
        if (item.second->getName() == name)
        {
            return item.second->getFunction();
        }
    }
    return nullptr;
}

◆ getFunPtr()

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

inline

Definition at line 458 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 ValVar * SVF::SVFIR::getFunRet ( const FunObjVar * func ) const

inline

Get function return list.

Definition at line 424 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 419 of file SVFIR.h.

    {
        return funRetMap;
    }

◆ getGepObjNodeMap()

OffsetToGepVarMap & SVF::SVFIR::getGepObjNodeMap ( )

inline

Return GepObjVarMap.

Definition at line 204 of file SVFIR.h.

    {
        return GepObjVarMap;
    }

◆ getGepObjVar() [1/3]

NodeID SVFIR::getGepObjVar	(	const BaseObjVar *	baseObj,
		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 523 of file SVFIR.cpp.

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

◆ getGepObjVar() [2/3]

const GepObjVar * SVF::SVFIR::getGepObjVar ( NodeID id ) const

inline

Definition at line 170 of file SVFIR.h.

    {
        if(const SVFVar* var = getSVFVar(id))
            return SVFUtil::dyn_cast<GepObjVar>(var);
        else
        {
            assert(false && "the Node is not a GepObjVar");
            return nullptr;
        }
    }

◆ getGepObjVar() [3/3]

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

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

◆ getGepValVar()

NodeID SVFIR::getGepValVar	(	NodeID	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 614 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 347 of file SVFIR.h.

    {
        return globSVFStmtSet;
    }

◆ getICFG()

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

inline

Definition at line 232 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 464 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 454 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 481 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 485 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 199 of file SVFIR.h.

    {
        return memToFieldsMap;
    }

◆ getModuleIdentifier()

const std::string & SVF::SVFIR::getModuleIdentifier ( ) const

inline

Definition at line 262 of file SVFIR.h.

    {
        if (pagReadFromTxt.empty())
        {
            assert(!moduleIdentifier.empty() &&
                   "No module found! Reading from a file other than LLVM-IR?");
            return moduleIdentifier;
        }
        else
        {
            return pagReadFromTxt;
        }
    }

◆ getObjVar()

const ObjVar * SVF::SVFIR::getObjVar ( NodeID id ) const

inline

Definition at line 150 of file SVFIR.h.

    {
        if(const SVFVar* var = getSVFVar(id))
            return SVFUtil::dyn_cast<ObjVar>(var);
        else
        {
            assert(false && "the Node is not an ObjVar");
            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 121 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 324 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 304 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 319 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 299 of file SVFIR.h.

    {
        return KindToSVFStmtSetMap[kind];
    }

◆ getSVFVar()

const SVFVar * SVF::SVFIR::getSVFVar ( NodeID id ) const

inline

ObjVar/GepObjVar/BaseObjVar.

Definition at line 136 of file SVFIR.h.

    {
        return getGNode(id);
    }

◆ getSVFVarMap()

const IDToNodeMapTy & SVF::SVFIR::getSVFVarMap ( ) const

inline

Return the entire SVFID to SVFVar map.

Definition at line 193 of file SVFIR.h.

    {
        return IDToNodeMap;
    }

◆ 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 342 of file SVFIR.h.

    {
        return typeLocSetsMap[argId];
    }

◆ getValVar()

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

inline

Definition at line 140 of file SVFIR.h.

    {
        if(const SVFVar* var = getSVFVar(id))
            return SVFUtil::dyn_cast<ValVar>(var);
        else
        {
            assert(false && "the Node is not a ValVar");
            return nullptr;
        }
    }

◆ handleBlackHole()

void SVFIR::handleBlackHole ( bool b )

static

SVFIR build configurations.

Whether to handle blackhole edge

Definition at line 782 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 386 of file SVFIR.h.

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

◆ hasFunArgsList()

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

inline

Function has arguments list.

Definition at line 369 of file SVFIR.h.

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

◆ hasPTASVFStmtList()

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

inline

Definition at line 313 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 309 of file SVFIR.h.

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

◆ initialiseCandidatePointers()

void SVFIR::initialiseCandidatePointers ( )

Initialize candidate pointers.

Definition at line 734 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);
    }
}

◆ isBaseObjVar()

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

inline

Definition at line 184 of file SVFIR.h.

    {
        return SVFUtil::isa<BaseObjVar>(getSVFVar(id));
    }

◆ isBlkObjOrConstantObj()

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

inline

Get black hole and constant id.

Definition at line 538 of file SVFIR.h.

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

◆ isConstantObj()

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

inline

Answered from a set filled in addObjNode, so the solvers' per-object test does not look the node up in the node map.

Definition at line 545 of file SVFIR.h.

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

◆ isFunPtr()

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

inline

Definition at line 474 of file SVFIR.h.

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

◆ isGepObjVar()

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

inline

Definition at line 188 of file SVFIR.h.

    {
        return SVFUtil::isa<GepObjVar>(getSVFVar(id));
    }

◆ isIndirectCallSites()

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

inline

Definition at line 470 of file SVFIR.h.

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

◆ isObjVar()

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

inline

Definition at line 180 of file SVFIR.h.

    {
        return SVFUtil::isa<ObjVar>(getSVFVar(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 357 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 750 of file SVFIR.cpp.

{
    const SVFVar* node = pag->getSVFVar(nodeId);
 
    if(node->isPointer())
        if (const ValVar* pVar = pag->getBaseValVar(nodeId))
            if (const ArgValVar* arg = SVFUtil::dyn_cast<ArgValVar>(pVar))
                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 765 of file SVFIR.cpp.

{
    if (SVFUtil::isa<ValVar>(node))
    {
        if (isValidPointer(node->getId()))
        {
            const ValVar* baseVar = pag->getBaseValVar(node->getId());
            if(!SVFUtil::isa<DummyValVar, BlackHoleValVar>(baseVar))
                return !SVFUtil::isArgOfUncalledFunction(baseVar);
        }
    }
    return false;
}

◆ pagFileName()

static std::string SVF::SVFIR::pagFileName ( )

inlinestatic

Definition at line 276 of file SVFIR.h.

    {
        return pagReadFromTxt;
    }

◆ pagReadFromTXT()

static bool SVF::SVFIR::pagReadFromTXT ( )

inlinestatic

Definition at line 281 of file SVFIR.h.

    {
        return !pagReadFromTxt.empty();
    }

◆ print()

void SVFIR::print ( )

Print SVFIR.

Print this SVFIR graph including its nodes and edges

Definition at line 649 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 129 of file SVFIR.h.

    {
        pag = nullptr;
    }

◆ setCallGraph()

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

inline

Definition at line 255 of file SVFIR.h.

    {
        callGraph = cg;
    }

◆ setCHG()

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

inline

Set/Get CHG.

Definition at line 238 of file SVFIR.h.

    {
        chgraph = c;
    }

◆ setICFG()

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

inline

Set/Get ICFG.

Definition at line 228 of file SVFIR.h.

    {
        icfg = i;
    }

◆ setModuleIdentifier()

void SVF::SVFIR::setModuleIdentifier ( const std::string & moduleIdentifier )

inline

Definition at line 291 of file SVFIR.h.

    {
        this->moduleIdentifier = moduleIdentifier;
    }

◆ setPagFromTXT()

static void SVF::SVFIR::setPagFromTXT ( const std::string & txt )

inlinestatic

Definition at line 286 of file SVFIR.h.

    {
        pagReadFromTxt = txt;
    }

Friends And Related Symbol Documentation

◆ BVDataPTAImpl

friend class BVDataPTAImpl

friend

Definition at line 50 of file SVFIR.h.

◆ ExternalPAG

friend class ExternalPAG

friend

Definition at line 48 of file SVFIR.h.

◆ GraphDBClient

friend class GraphDBClient

friend

Definition at line 51 of file SVFIR.h.

◆ GraphDBSVFIRBuilder

friend class GraphDBSVFIRBuilder

friend

Definition at line 52 of file SVFIR.h.

◆ PAGBuilderFromFile

friend class PAGBuilderFromFile

friend

Definition at line 49 of file SVFIR.h.

◆ SVFIRBuilder

friend class SVFIRBuilder

friend

Definition at line 47 of file SVFIR.h.

Member Data Documentation

◆ callGraph

CallGraph* SVF::SVFIR::callGraph

private

all the callsites of a program

Definition at line 104 of file SVFIR.h.

◆ callSiteArgsListMap

CSToArgsListMap SVF::SVFIR::callSiteArgsListMap

private

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

Definition at line 93 of file SVFIR.h.

◆ callSiteRetMap

CSToRetMap SVF::SVFIR::callSiteRetMap

private

Map a callsite to its callsite returns PAGNodes.

Definition at line 94 of file SVFIR.h.

◆ callSiteSet

CallSiteSet SVF::SVFIR::callSiteSet

private

Definition at line 103 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 100 of file SVFIR.h.

◆ chgraph

CommonCHGraph* SVF::SVFIR::chgraph

private

Definition at line 102 of file SVFIR.h.

◆ constantObjs

NodeSet SVF::SVFIR::constantObjs

private

Constant objects and their fields, recorded when each object node is added.

Definition at line 88 of file SVFIR.h.

◆ fParmToCallPEMap

FParmToCallPEMap SVF::SVFIR::fParmToCallPEMap

private

Map a formal param to its CallPE.

Definition at line 91 of file SVFIR.h.

◆ funArgsListMap

FunToArgsListMap SVF::SVFIR::funArgsListMap

private

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

Definition at line 92 of file SVFIR.h.

◆ funPtrToCallSitesMap

FunPtrToCallSitesMap SVF::SVFIR::funPtrToCallSitesMap

private

Map a function pointer to the callsites where it is used

Definition at line 97 of file SVFIR.h.

◆ funRetMap

FunToRetMap SVF::SVFIR::funRetMap

private

Map a function to its unique function return PAGNodes.

Definition at line 95 of file SVFIR.h.

◆ GepObjVarMap

OffsetToGepVarMap SVF::SVFIR::GepObjVarMap

private

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

Definition at line 86 of file SVFIR.h.

◆ GepValObjMap

GepValueVarMap SVF::SVFIR::GepValObjMap

private

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

Definition at line 84 of file SVFIR.h.

◆ globSVFStmtSet

SVFStmtSet SVF::SVFIR::globSVFStmtSet

private

Global PAGEdges without control flow information.

Definition at line 89 of file SVFIR.h.

◆ icfg

ICFG* SVF::SVFIR::icfg

private

Definition at line 101 of file SVFIR.h.

◆ icfgNode2PTASVFStmtsMap

ICFGNode2SVFStmtsMap SVF::SVFIR::icfgNode2PTASVFStmtsMap

private

Map an ICFGNode to its PointerAnalysis related SVFStmts.

Definition at line 83 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 82 of file SVFIR.h.

◆ indCallSiteToFunPtrMap

CallSiteToFunPtrMap SVF::SVFIR::indCallSiteToFunPtrMap

private

Map an indirect callsite to its function pointer.

Definition at line 96 of file SVFIR.h.

◆ memToFieldsMap

MemObjToFieldsMap SVF::SVFIR::memToFieldsMap

private

Map a mem object id to all its fields.

Definition at line 87 of file SVFIR.h.

◆ moduleIdentifier

std::string SVF::SVFIR::moduleIdentifier

private

Definition at line 109 of file SVFIR.h.

◆ pag

std::unique_ptr< SVFIR > SVFIR::pag

staticprivate

Callgraph with direct calls only; no change allowed after init and use callgraph in PointerAnalysis for indirect calls)

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

Definition at line 106 of file SVFIR.h.

◆ pagReadFromTxt

std::string SVFIR::pagReadFromTxt = ""

staticprivate

Definition at line 107 of file SVFIR.h.

◆ phiNodeMap

PHINodeMap SVF::SVFIR::phiNodeMap

private

A set of phi copy edges.

Definition at line 90 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 85 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

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ CallSiteSet

◆ CallSiteToFunPtrMap

◆ CSToArgsListMap

◆ CSToRetMap

◆ FParmToCallPEMap

◆ FunPtrToCallSitesMap

◆ FunToArgsListMap

◆ FunToPAGEdgeSetMap

◆ FunToRetMap

◆ GepOffset

◆ GepValueVarMap

◆ ICFGNode2SVFStmtsMap

◆ MemObjToFieldsMap

◆ NodeAccessPath

◆ NodeAccessPathMap

◆ NodePairSetMap

◆ NodeToNodeMap

◆ OffsetToGepVarMap

◆ PHINodeMap

◆ SVFStmtList

◆ SVFTypeLocSetsPair

◆ TypeLocSetsMap

◆ ValVarList

Constructor & Destructor Documentation

◆ SVFIR()

◆ ~SVFIR()

Member Function Documentation

◆ addAddrStmt() [1/2]

◆ addAddrStmt() [2/2]

◆ addArgValNode()

◆ addAsmPCValNode()

◆ addBaseObjNode()

◆ addBinaryOPStmt() [1/2]

◆ addBinaryOPStmt() [2/2]

◆ addBlackHoleAddrStmt()

◆ addBlackholeObjNode()

◆ addBlackholePtrNode()

◆ addBranchStmt() [1/2]

◆ addBranchStmt() [2/2]

◆ addCallPE() [1/2]

◆ addCallPE() [2/2]

◆ addCallSite()

◆ addCallSiteArgs()

◆ addCallSiteRets()

◆ addCmpStmt() [1/2]

◆ addCmpStmt() [2/2]

◆ addConstantDataObjNode()

◆ addConstantDataValNode()

◆ addConstantFPObjNode()

◆ addConstantFPValNode()

◆ addConstantIntObjNode()

◆ addConstantIntValNode()

◆ addConstantNullPtrObjNode()

◆ addConstantNullPtrValNode()

◆ addConstantObjNode()

◆ addCopyStmt() [1/2]

◆ addCopyStmt() [2/2]

◆ addDummyObjNode() [1/3]

◆ addDummyObjNode() [2/3]

◆ addDummyObjNode() [3/3]

◆ addDummyValNode() [1/2]

◆ addDummyValNode() [2/2]

◆ addFIObjNode()

◆ addFunArgs() [1/2]

◆ addFunArgs() [2/2]

◆ addFunObjNode()

◆ addFunRet() [1/2]

◆ addFunRet() [2/2]

◆ addFunValNode()