#include <IRGraph.h>

Inheritance diagram for SVF::IRGraph:

Public Types
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
	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 ()

Protected Member Functions
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
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

Friends
class	SVFIRWriter

class	SVFIRReader

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

Detailed Description

Definition at line 49 of file IRGraph.h.

Member Typedef Documentation

◆ SVFStmtSet

typedef Set<const SVFStmt*> SVF::IRGraph::SVFStmtSet

Definition at line 55 of file IRGraph.h.

◆ ValueToEdgeMap

typedef Map<const SVFValue*,SVFStmtSet> SVF::IRGraph::ValueToEdgeMap

Definition at line 56 of file IRGraph.h.

Constructor & Destructor Documentation

◆ IRGraph()

SVF::IRGraph::IRGraph ( bool buildFromFile )

inline

Definition at line 104 of file IRGraph.h.

        : fromFile(buildFromFile), nodeNumAfterPAGBuild(0), totalPTAPAGEdge(0)
    {
        symInfo = SymbolTableInfo::SymbolInfo();
        // insert dummy value if a correct value cannot be found
        valueToEdgeMap[nullptr] = SVFStmtSet();
    }

◆ ~IRGraph()

IRGraph::~IRGraph ( )

virtual

Definition at line 36 of file IRGraph.cpp.

{
    SymbolTableInfo::releaseSymbolInfo();
    symInfo = nullptr;
}

Member Function Documentation

◆ addEdge()

bool IRGraph::addEdge	(	SVFVar *	src,
		SVFVar *	dst,
		SVFStmt *	edge
	)

protected

Add an edge into the graph.

Add a SVFIR edge into edge map

Definition at line 45 of file IRGraph.cpp.

{
 
    DBOUT(DPAGBuild,
          outs() << "add edge from " << src->getId() << " kind :"
          << src->getNodeKind() << " to " << dst->getId()
          << " kind :" << dst->getNodeKind() << "\n");
    src->addOutEdge(edge);
    dst->addInEdge(edge);
    return true;
}

◆ addNode()

NodeID SVF::IRGraph::addNode	(	SVFVar *	node,
		NodeID	i
	)

inlineprotected

Add a node into the graph.

Definition at line 68 of file IRGraph.h.

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

◆ dump()

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

Dump SVFIR.

Dump this IRGraph

Definition at line 102 of file IRGraph.cpp.

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

◆ getBlackHoleNode()

NodeID SVF::IRGraph::getBlackHoleNode ( ) const

inline

Definition at line 161 of file IRGraph.h.

    {
        return symInfo->blackholeSymID();
    }

◆ getBlackHoleObj()

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

inline

Definition at line 177 of file IRGraph.h.

    {
        return symInfo->getBlkObj();
    }

◆ getBlkPtr()

NodeID SVF::IRGraph::getBlkPtr ( ) const

inline

Definition at line 169 of file IRGraph.h.

    {
        return symInfo->blkPtrSymID();
    }

◆ getConstantNode()

NodeID SVF::IRGraph::getConstantNode ( ) const

inline

Definition at line 165 of file IRGraph.h.

    {
        return symInfo->constantSymID();
    }

◆ getConstantObj()

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

inline

Definition at line 181 of file IRGraph.h.

    {
        return symInfo->getConstantObj();
    }

◆ getGraphName()

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

inline

Return graph name.

Definition at line 216 of file IRGraph.h.

    {
        return "SVFIR";
    }

◆ getMemObj()

const MemObj * SVF::IRGraph::getMemObj ( const SVFValue * val ) const

inlineprotected

get MemObj according to LLVM value

Definition at line 98 of file IRGraph.h.

    {
        return symInfo->getObj(symInfo->getObjSym(val));
    }

◆ getNodeNumAfterPAGBuild()

u32_t SVF::IRGraph::getNodeNumAfterPAGBuild ( ) const

inline

Definition at line 194 of file IRGraph.h.

    {
        return nodeNumAfterPAGBuild;
    }

◆ getNullPtr()

NodeID SVF::IRGraph::getNullPtr ( ) const

inline

Definition at line 173 of file IRGraph.h.

    {
        return symInfo->nullPtrSymID();
    }

◆ getObjectNode()

NodeID SVF::IRGraph::getObjectNode ( const SVFValue * V )

inline

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

Definition at line 147 of file IRGraph.h.

    {
        return symInfo->getObjSym(V);
    }

◆ getObjectNodeNum()

u32_t SVF::IRGraph::getObjectNodeNum ( ) const

inline

Definition at line 190 of file IRGraph.h.

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

◆ getPAGEdgeNum()

u32_t SVF::IRGraph::getPAGEdgeNum ( ) const

inline

Definition at line 207 of file IRGraph.h.

    {
        return edgeNum;
    }

◆ getPAGNodeNum()

u32_t SVF::IRGraph::getPAGNodeNum ( ) const

inline

Definition at line 203 of file IRGraph.h.

    {
        return nodeNum;
    }

◆ getPTAPAGEdgeNum()

u32_t SVF::IRGraph::getPTAPAGEdgeNum ( ) const

inline

Definition at line 211 of file IRGraph.h.

    {
        return totalPTAPAGEdge;
    }

◆ getReturnNode()

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

inline

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

Definition at line 152 of file IRGraph.h.

    {
        return symInfo->getRetSym(func);
    }

◆ getSymbolInfo()

SymbolTableInfo * SVF::IRGraph::getSymbolInfo ( ) const

inline

Definition at line 114 of file IRGraph.h.

    {
        return symInfo;
    }

◆ getValueEdges()

const SVFStmtSet & SVF::IRGraph::getValueEdges ( const SVFValue * V )

inline

Get all SVFIR Edges that corresponds to an LLVM value.

Definition at line 124 of file IRGraph.h.

    {
        auto it = valueToEdgeMap.find(V);
        if (it == valueToEdgeMap.end())
        {
            //special empty set
            return valueToEdgeMap.at(nullptr);
        }
        return it->second;
    }

◆ getValueNode()

NodeID SVF::IRGraph::getValueNode ( const SVFValue * V )

inline

Get SVFIR Node according to LLVM value getNode - Return the node corresponding to the specified pointer.

Definition at line 137 of file IRGraph.h.

    {
        return symInfo->getValSym(V);
    }

◆ getValueNodeNum()

u32_t SVF::IRGraph::getValueNodeNum ( ) const

inline

Definition at line 186 of file IRGraph.h.

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

◆ getVarargNode()

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

inline

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

Definition at line 157 of file IRGraph.h.

    {
        return symInfo->getVarargSym(func);
    }

◆ hasLabeledEdge() [1/2]

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

protected

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

Return an inter-procedural edge if found

Definition at line 88 of file IRGraph.cpp.

{
    SVFStmt edge(src,dst,SVFStmt::makeEdgeFlagWithCallInst(kind,callInst), false);
    SVFStmt::SVFStmtSetTy::iterator it = KindToSVFStmtSetMap[kind].find(&edge);
    if (it != KindToSVFStmtSetMap[kind].end())
    {
        return *it;
    }
    return nullptr;
}

◆ hasLabeledEdge() [2/2]

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

protected

Return MultiOpndStmt since it has more than one operands (we use operand 2 here to make the flag)

Return an MultiOpndStmt if found

Definition at line 74 of file IRGraph.cpp.

{
    SVFStmt edge(src,op1,SVFStmt::makeEdgeFlagWithAddionalOpnd(kind,op2), false);
    SVFStmt::SVFStmtSetTy::iterator it = KindToSVFStmtSetMap[kind].find(&edge);
    if (it != KindToSVFStmtSetMap[kind].end())
    {
        return *it;
    }
    return nullptr;
}

◆ hasNonlabeledEdge()

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

protected

Return true if it is an intra-procedural edge

Definition at line 60 of file IRGraph.cpp.

{
    SVFStmt edge(src,dst,kind, false);
    SVFStmt::SVFStmtSetTy::iterator it = KindToSVFStmtSetMap[kind].find(&edge);
    if (it != KindToSVFStmtSetMap[kind].end())
    {
        return *it;
    }
    return nullptr;
}

◆ hasValueNode()

bool SVF::IRGraph::hasValueNode ( const SVFValue * V )

inline

Definition at line 141 of file IRGraph.h.

    {
        return symInfo->hasValSym(V);
    }

◆ isBuiltFromFile()

bool SVF::IRGraph::isBuiltFromFile ( )

inline

Whether this SVFIR built from a txt file.

Definition at line 119 of file IRGraph.h.

    {
        return fromFile;
    }

◆ mapValueToEdge()

void SVF::IRGraph::mapValueToEdge	(	const SVFValue *	V,
		SVFStmt *	edge
	)

inlineprotected

Map a value to a set of edges.

Definition at line 89 of file IRGraph.h.

    {
        auto inserted = valueToEdgeMap.emplace(V, SVFStmtSet{edge});
        if (!inserted.second)
        {
            inserted.first->second.emplace(edge);
        }
    }

◆ setNodeNumAfterPAGBuild()

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

inline

Definition at line 198 of file IRGraph.h.

    {
        nodeNumAfterPAGBuild = num;
    }

◆ view()

void IRGraph::view ( )

View graph from the debugger.

View IRGraph

Definition at line 110 of file IRGraph.cpp.

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

Friends And Related Symbol Documentation

◆ SVFIRReader

friend class SVFIRReader

friend

Definition at line 52 of file IRGraph.h.

◆ SVFIRWriter

friend class SVFIRWriter

friend

Definition at line 51 of file IRGraph.h.

Member Data Documentation

◆ fromFile

bool SVF::IRGraph::fromFile

protected

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

Definition at line 61 of file IRGraph.h.

◆ KindToPTASVFStmtSetMap

SVFStmt::KindToSVFStmtMapTy SVF::IRGraph::KindToPTASVFStmtSetMap

protected

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

Definition at line 60 of file IRGraph.h.

◆ KindToSVFStmtSetMap

SVFStmt::KindToSVFStmtMapTy SVF::IRGraph::KindToSVFStmtSetMap

protected

SVFIR edge map containing all PAGEdges.

Definition at line 59 of file IRGraph.h.

◆ nodeNumAfterPAGBuild

NodeID SVF::IRGraph::nodeNumAfterPAGBuild

protected

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

Definition at line 62 of file IRGraph.h.

◆ symInfo

SymbolTableInfo* SVF::IRGraph::symInfo

protected

Definition at line 65 of file IRGraph.h.

◆ totalPTAPAGEdge

u32_t SVF::IRGraph::totalPTAPAGEdge

protected

Definition at line 63 of file IRGraph.h.

◆ valueToEdgeMap

ValueToEdgeMap SVF::IRGraph::valueToEdgeMap

protected

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

Definition at line 64 of file IRGraph.h.

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

/home/runner/work/SVF/SVF/svf/include/Graphs/IRGraph.h
/home/runner/work/SVF/SVF/svf/lib/Graphs/IRGraph.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ SVFStmtSet

◆ ValueToEdgeMap

Constructor & Destructor Documentation

◆ IRGraph()

◆ ~IRGraph()

Member Function Documentation

◆ addEdge()

◆ addNode()

◆ dump()

◆ getBlackHoleNode()

◆ getBlackHoleObj()

◆ getBlkPtr()

◆ getConstantNode()

◆ getConstantObj()

◆ getGraphName()

◆ getMemObj()

◆ getNodeNumAfterPAGBuild()

◆ getNullPtr()

◆ getObjectNode()

◆ getObjectNodeNum()

◆ getPAGEdgeNum()

◆ getPAGNodeNum()

◆ getPTAPAGEdgeNum()

◆ getReturnNode()

◆ getSymbolInfo()

◆ getValueEdges()

◆ getValueNode()

◆ getValueNodeNum()

◆ getVarargNode()

◆ hasLabeledEdge() [1/2]

◆ hasLabeledEdge() [2/2]

◆ hasNonlabeledEdge()

◆ hasValueNode()

◆ isBuiltFromFile()

◆ mapValueToEdge()

◆ setNodeNumAfterPAGBuild()

◆ view()

Friends And Related Symbol Documentation

◆ SVFIRReader

◆ SVFIRWriter

Member Data Documentation

◆ fromFile

◆ KindToPTASVFStmtSetMap

◆ KindToSVFStmtSetMap

◆ nodeNumAfterPAGBuild

◆ symInfo

◆ totalPTAPAGEdge

◆ valueToEdgeMap