#include <IRGraph.h>

Inheritance diagram for SVF::IRGraph:

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

u32_t	getPAGEdgeNum () 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 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)

Public Attributes
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 Member Functions
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 *	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.

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

u32_t	valVarNum

u32_t	objVarNum

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

Private Member Functions
void	destorySymTable ()

Private Attributes
FunObjVarToIDMapTy	returnFunObjSymMap
	return map

FunObjVarToIDMapTy	varargFunObjSymMap
	vararg map

IDToTypeInfoMapTy	objTypeInfoMap
	map a memory sym id to its obj

SVFTypeSet	svfTypes

Set< const StInfo * >	stInfos
	(owned) All StInfo

NodeID	totalSymNum
	total number of symbols

Friends
class	SVFIRWriter

class	SVFIRReader

class	SVFIRBuilder

class	SymbolTableBuilder

Detailed Description

Definition at line 51 of file IRGraph.h.

Member Typedef Documentation

◆ FunObjVarToIDMapTy

typedef OrderedMap<const FunObjVar*, NodeID> SVF::IRGraph::FunObjVarToIDMapTy

function to sym id map

Definition at line 79 of file IRGraph.h.

◆ IDToTypeInfoMapTy

typedef OrderedMap<NodeID, ObjTypeInfo*> SVF::IRGraph::IDToTypeInfoMapTy

various maps defined

sym id to obj type info map

Definition at line 76 of file IRGraph.h.

◆ SVFStmtSet

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

Definition at line 106 of file IRGraph.h.

◆ SVFTypeSet

typedef Set<const SVFType*> SVF::IRGraph::SVFTypeSet

struct type to struct info map

Definition at line 82 of file IRGraph.h.

Member Enumeration Documentation

◆ SYMTYPE

enum SVF::IRGraph::SYMTYPE

Symbol types.

Enumerator
NullPtr
BlkPtr
BlackHole
ConstantObj
ValSymbol
ObjSymbol
RetSymbol
VarargSymbol

Definition at line 61 of file IRGraph.h.

    {
        NullPtr,
        BlkPtr,
        BlackHole,
        ConstantObj,
        ValSymbol,
        ObjSymbol,
        RetSymbol,
        VarargSymbol
    };

Constructor & Destructor Documentation

◆ IRGraph()

SVF::IRGraph::IRGraph ( bool buildFromFile )

inline

Definition at line 140 of file IRGraph.h.

        : totalSymNum(0), fromFile(buildFromFile), nodeNumAfterPAGBuild(0), totalPTAPAGEdge(0), valVarNum(0), objVarNum(0),
          maxStruct(nullptr), maxStSize(0)
    {
    }

◆ ~IRGraph()

IRGraph::~IRGraph ( )

virtual

Definition at line 54 of file IRGraph.cpp.

{
    destorySymTable();
}

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 253 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 )

inlineprotected

Add a node into the graph.

Definition at line 118 of file IRGraph.h.

    {
        assert(node && "cannot add a null node");
        addGNode(node->getId(),node);
        return node->getId();
    }

◆ addStInfo()

void SVF::IRGraph::addStInfo ( StInfo * stInfo )

inline

Definition at line 363 of file IRGraph.h.

    {
        stInfos.insert(stInfo);
    }

◆ addTypeInfo()

void SVF::IRGraph::addTypeInfo ( const SVFType * ty )

inline

Definition at line 356 of file IRGraph.h.

    {
        bool inserted = svfTypes.insert(ty).second;
        if(!inserted)
            assert(false && "this type info has been added before");
    }

◆ blackholeSymID()

NodeID SVF::IRGraph::blackholeSymID ( ) const

inline

Definition at line 193 of file IRGraph.h.

    {
        return BlackHole;
    }

◆ blkPtrSymID()

NodeID SVF::IRGraph::blkPtrSymID ( ) const

inline

Definition at line 178 of file IRGraph.h.

    {
        return BlkPtr;
    }

◆ constantSymID()

NodeID SVF::IRGraph::constantSymID ( ) const

inline

Definition at line 188 of file IRGraph.h.

    {
        return ConstantObj;
    }

◆ createDummyObjTypeInfo()

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

Definition at line 177 of file IRGraph.cpp.

{
    if (objTypeInfoMap.find(symId)==objTypeInfoMap.end())
    {
        ObjTypeInfo* ti = createObjTypeInfo(type);
        objTypeInfoMap[symId] = ti;
    }
    ObjTypeInfo* ti = objTypeInfoMap[symId];
    return ti;
}

◆ createObjTypeInfo()

ObjTypeInfo * IRGraph::createObjTypeInfo ( const SVFType * type )

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

Definition at line 231 of file IRGraph.cpp.

{
 
    ObjTypeInfo* typeInfo = new ObjTypeInfo(type, Options::MaxFieldLimit());
    if(type && type->isPointerTy())
    {
        typeInfo->setFlag(ObjTypeInfo::HEAP_OBJ);
    }
    return typeInfo;
}

◆ destorySymTable()

void IRGraph::destorySymTable ( )

private

Definition at line 36 of file IRGraph.cpp.

{
 
    for (auto &pair: objTypeInfoMap)
    {
        if (ObjTypeInfo* ti = pair.second)
            delete ti;
    }
 
    for (const SVFType* type : svfTypes)
        delete type;
    svfTypes.clear();
 
    for (const StInfo* st : stInfos)
        delete st;
    stInfos.clear();
}

◆ dump()

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

Dump SVFIR.

Dump this IRGraph

Definition at line 310 of file IRGraph.cpp.

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

◆ dumpSymTable()

void SVF::IRGraph::dumpSymTable ( )

◆ getBlackHoleNode()

NodeID SVF::IRGraph::getBlackHoleNode ( ) const

inline

Definition at line 247 of file IRGraph.h.

    {
        return blackholeSymID();
    }

◆ getBlkPtr()

NodeID SVF::IRGraph::getBlkPtr ( ) const

inline

Definition at line 255 of file IRGraph.h.

    {
        return blkPtrSymID();
    }

◆ getConstantNode()

NodeID SVF::IRGraph::getConstantNode ( ) const

inline

Definition at line 251 of file IRGraph.h.

    {
        return constantSymID();
    }

◆ getFlattenedElemIdx()

u32_t IRGraph::getFlattenedElemIdx	(	const SVFType *	T,
		u32_t	origId
	)

Flattened element idx of an array or struct by considering stride.

When Options::ModelArrays is disabled, any element index Array is modeled as the base

Definition at line 144 of file IRGraph.cpp.

{
    if(Options::ModelArrays())
    {
        const std::vector<u32_t>& so = getTypeInfo(T)->getFlattenedElemIdxVec();
        assert ((unsigned)origId < so.size() && !so.empty() && "element index out of bounds, can't get flattened index!");
        return so[origId];
    }
    else
    {
        if(SVFUtil::isa<SVFStructType>(T))
        {
            const std::vector<u32_t>& so = getTypeInfo(T)->getFlattenedFieldIdxVec();
            assert ((unsigned)origId < so.size() && !so.empty() && "Struct index out of bounds, can't get flattened index!");
            return so[origId];
        }
        else
        {
            assert(SVFUtil::isa<SVFArrayType>(T) && "Only accept struct or array type if Options::ModelArrays is disabled!");
            return 0;
        }
    }
}

◆ getFlattenFieldTypes()

const std::vector< const SVFType * > & IRGraph::getFlattenFieldTypes ( const SVFStructType * T )

protected

Return the flattened field type for struct type only.

Definition at line 118 of file IRGraph.cpp.

{
    return getTypeInfo(T)->getFlattenFieldTypes();
}

◆ getFlatternedElemType()

const SVFType * IRGraph::getFlatternedElemType	(	const SVFType *	baseType,
		u32_t	flatten_idx
	)

Return the type of a flattened element given a flattened index.

Definition at line 123 of file IRGraph.cpp.

{
    if(Options::ModelArrays())
    {
        const std::vector<const SVFType*>& so = getTypeInfo(baseType)->getFlattenElementTypes();
        assert (flatten_idx < so.size() && !so.empty() && "element index out of bounds or struct opaque type, can't get element type!");
        return so[flatten_idx];
    }
    else
    {
        const std::vector<const SVFType*>& so = getTypeInfo(baseType)->getFlattenFieldTypes();
        assert (flatten_idx < so.size() && !so.empty() && "element index out of bounds or struct opaque type, can't get element type!");
        return so[flatten_idx];
    }
}

◆ getGraphName()

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

inline

Return graph name.

Definition at line 335 of file IRGraph.h.

    {
        return "SVFIR";
    }

◆ getMaxStructSize()

u32_t SVF::IRGraph::getMaxStructSize ( ) const

inline

Definition at line 204 of file IRGraph.h.

    {
        return maxStSize;
    }

◆ getModulusOffset()

APOffset IRGraph::getModulusOffset	(	const BaseObjVar *	baseObj,
		const APOffset &	apOffset
	)

virtual

Given an offset from a Gep Instruction, return it modulus offset by considering memory layout.

if the offset is negative, it's possible that we're looking for an obj node out of range of current struct. Make the offset positive so we can still get a node within current struct to represent this obj.

@offset: the index allocated to the newly generated field node; @Options::MaxFieldLimit(): preset upper bound of field number; @maxOffset: the max field number of the base object;

E.g., offset == 260, maxOffset == 270, Options::MaxFieldLimit() == 256 ==> offset = 4

E.g., offset == 100, maxOffset == 98, Options::MaxFieldLimit() == 256 ==> offset = 2

E.g., offset == 100, maxOffset == 98, Options::MaxFieldLimit() == 256 ==> offset = 97

Definition at line 188 of file IRGraph.cpp.

{
 
    APOffset offset = apOffset;
    if(offset < 0)
    {
        writeWrnMsg("try to create a gep node with negative offset.");
        offset = std::abs(offset);
    }
    u32_t maxOffset = baseObj->getMaxFieldOffsetLimit();
 
    if (maxOffset == 0)
        offset = 0;
    else if (Options::MaxFieldLimit() < maxOffset)
        offset = offset % maxOffset;
    else if ((u32_t)offset > maxOffset - 1)
    {
        if (Options::CyclicFldIdx())
            offset = offset % maxOffset;
        else
            offset = maxOffset - 1;
    }
 
    return offset;
}

◆ getNodeNumAfterPAGBuild()

u32_t SVF::IRGraph::getNodeNumAfterPAGBuild ( ) const

inline

Definition at line 313 of file IRGraph.h.

    {
        return nodeNumAfterPAGBuild;
    }

◆ getNullPtr()

NodeID SVF::IRGraph::getNullPtr ( ) const

inline

Definition at line 259 of file IRGraph.h.

    {
        return nullPtrSymID();
    }

◆ getNumOfFlattenElements()

u32_t IRGraph::getNumOfFlattenElements ( const SVFType * T )

Get a reference to the components of struct_info. Number of flattened elements of an array or struct

Definition at line 169 of file IRGraph.cpp.

{
    if(Options::ModelArrays())
        return getTypeInfo(T)->getNumOfFlattenElements();
    else
        return getTypeInfo(T)->getNumOfFlattenFields();
}

◆ getObjectNodeNum()

u32_t IRGraph::getObjectNodeNum ( )

Definition at line 337 of file IRGraph.cpp.

{
    if (objVarNum != 0) return objVarNum;
    u32_t num = 0;
    for (const auto& item: *this)
    {
        if (SVFUtil::isa<ObjVar>(item.second))
            num++;
    }
    return objVarNum = num;
}

◆ getObjTypeInfo()

ObjTypeInfo * SVF::IRGraph::getObjTypeInfo ( NodeID id ) const

inline

Definition at line 234 of file IRGraph.h.

    {
        IDToTypeInfoMapTy::const_iterator iter = objTypeInfoMap.find(id);
        assert(iter!=objTypeInfoMap.end() && "obj type info not found");
        return iter->second;
    }

◆ getOriginalElemType()

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

struct A { int id; int salary; }; struct B { char name[20]; struct A a;} B b; OriginalElemType of b with field_idx 1 : Struct A FlatternedElemType of b with field_idx 1 : int

Definition at line 139 of file IRGraph.cpp.

{
    return getTypeInfo(baseType)->getOriginalElemType(origId);
}

◆ getPAGEdgeNum()

u32_t SVF::IRGraph::getPAGEdgeNum ( ) const

inline

Definition at line 326 of file IRGraph.h.

    {
        return edgeNum;
    }

◆ getPAGNodeNum()

u32_t SVF::IRGraph::getPAGNodeNum ( ) const

inline

Definition at line 322 of file IRGraph.h.

    {
        return nodeNum;
    }

◆ getPTAPAGEdgeNum()

u32_t SVF::IRGraph::getPTAPAGEdgeNum ( ) const

inline

Definition at line 330 of file IRGraph.h.

    {
        return totalPTAPAGEdge;
    }

◆ getReturnNode()

NodeID IRGraph::getReturnNode ( const FunObjVar * func ) const

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

Definition at line 60 of file IRGraph.cpp.

{
    FunObjVarToIDMapTy::const_iterator iter =  returnFunObjSymMap.find(func);
    assert(iter!=returnFunObjSymMap.end() && "ret sym not found");
    return iter->second;
}

◆ getStInfos()

const Set< const StInfo * > & SVF::IRGraph::getStInfos ( ) const

inline

Definition at line 275 of file IRGraph.h.

    {
        return stInfos;
    }

◆ getSVFTypes()

const SVFTypeSet & SVF::IRGraph::getSVFTypes ( ) const

inline

Constant reader that won't change the state of the symbol table.

Definition at line 270 of file IRGraph.h.

    {
        return svfTypes;
    }

◆ getTotalSymNum()

u32_t SVF::IRGraph::getTotalSymNum ( ) const

inline

Statistics.

Definition at line 200 of file IRGraph.h.

    {
        return totalSymNum;
    }

◆ getTypeInfo()

const StInfo * IRGraph::getTypeInfo ( const SVFType * T ) const

Get struct info.

Get a reference to StructInfo.

Definition at line 242 of file IRGraph.cpp.

{
    assert(T);
    SVFTypeSet::const_iterator it = svfTypes.find(T);
    assert(it != svfTypes.end() && "type info not found? collect them first during SVFIR Building");
    return (*it)->getTypeInfo();
}

◆ getValueNodeNum()

u32_t IRGraph::getValueNodeNum ( )

Definition at line 324 of file IRGraph.cpp.

{
    if (valVarNum != 0) return valVarNum;
    u32_t num = 0;
    for (const auto& item: *this)
    {
        if (SVFUtil::isa<ValVar>(item.second))
            num++;
    }
    return valVarNum = num;
}

◆ getVarargNode()

NodeID IRGraph::getVarargNode ( const FunObjVar * func ) const

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

Definition at line 67 of file IRGraph.cpp.

{
    FunObjVarToIDMapTy::const_iterator iter =  varargFunObjSymMap.find(func);
    assert(iter!=varargFunObjSymMap.end() && "vararg sym not found");
    return iter->second;
}

◆ 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 296 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 282 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 268 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;
}

◆ hasSVFTypeInfo()

bool SVF::IRGraph::hasSVFTypeInfo ( const SVFType * T )

inline

Definition at line 286 of file IRGraph.h.

    {
        return svfTypes.find(T) != svfTypes.end();
    }

◆ idToObjTypeInfoMap() [1/2]

IDToTypeInfoMapTy & SVF::IRGraph::idToObjTypeInfoMap ( )

inline

Get different kinds of syms maps.

Definition at line 212 of file IRGraph.h.

    {
        return objTypeInfoMap;
    }

◆ idToObjTypeInfoMap() [2/2]

const IDToTypeInfoMapTy & SVF::IRGraph::idToObjTypeInfoMap ( ) const

inline

Definition at line 217 of file IRGraph.h.

    {
        return objTypeInfoMap;
    }

◆ isBlkObj()

static bool SVF::IRGraph::isBlkObj ( NodeID id )

inlinestatic

Definition at line 165 of file IRGraph.h.

    {
        return (id == BlackHole);
    }

◆ isBlkObjOrConstantObj()

static bool SVF::IRGraph::isBlkObjOrConstantObj ( NodeID id )

inlinestatic

Definition at line 173 of file IRGraph.h.

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

◆ isBlkPtr()

static bool SVF::IRGraph::isBlkPtr ( NodeID id )

inlinestatic

special value

Definition at line 157 of file IRGraph.h.

    {
        return (id == BlkPtr);
    }

◆ isBuiltFromFile()

bool SVF::IRGraph::isBuiltFromFile ( )

inline

Whether this SVFIR built from a txt file.

Definition at line 150 of file IRGraph.h.

    {
        return fromFile;
    }

◆ isConstantSym()

static bool SVF::IRGraph::isConstantSym ( NodeID id )

inlinestatic

Definition at line 169 of file IRGraph.h.

    {
        return (id == ConstantObj);
    }

◆ isNullPtr()

static bool SVF::IRGraph::isNullPtr ( NodeID id )

inlinestatic

Definition at line 161 of file IRGraph.h.

    {
        return (id == NullPtr);
    }

◆ nullPtrSymID()

NodeID SVF::IRGraph::nullPtrSymID ( ) const

inline

Definition at line 183 of file IRGraph.h.

    {
        return NullPtr;
    }

◆ printFlattenFields()

void IRGraph::printFlattenFields ( const SVFType * type )

Debug method.

All rest types are scalar type?

Definition at line 73 of file IRGraph.cpp.

{
    if (const SVFArrayType* at = SVFUtil::dyn_cast<SVFArrayType>(type))
    {
        outs() << "  {Type: " << *at << "}\n"
               << "\tarray type "
               << "\t [element size = " << getNumOfFlattenElements(at) << "]\n"
               << "\n";
    }
    else if (const SVFStructType *st = SVFUtil::dyn_cast<SVFStructType>(type))
    {
        outs() <<"  {Type: " << *st << "}\n";
        const std::vector<const SVFType*>& finfo = getTypeInfo(st)->getFlattenFieldTypes();
        int field_idx = 0;
        for(const SVFType* type : finfo)
        {
            outs() << " \tField_idx = " << ++field_idx
                   << ", field type: " << *type << "\n";
        }
        outs() << "\n";
    }
    else if (const SVFPointerType* pt= SVFUtil::dyn_cast<SVFPointerType>(type))
    {
        outs() << *pt << "\n";
    }
    else if (const SVFFunctionType* fu =
                 SVFUtil::dyn_cast<SVFFunctionType>(type))
    {
        outs() << "  {Type: " << *fu << "}\n\n";
    }
    else if (const SVFOtherType* ot = SVFUtil::dyn_cast<SVFOtherType>(type))
    {
        outs() << "  {Type: "<< *ot << "(SVFOtherType)}\n\n";
    }
    else
    {
        assert(type->isSingleValueType() && "not a single value type, then what else!!");
        u32_t eSize = getNumOfFlattenElements(type);
        outs() << "  {Type: " << *type << "}\n"
               << "\t [object size = " << eSize << "]\n"
               << "\n";
    }
}

◆ retFunObjSyms()

FunObjVarToIDMapTy & SVF::IRGraph::retFunObjSyms ( )

inline

Definition at line 222 of file IRGraph.h.

    {
        return returnFunObjSymMap;
    }

◆ setNodeNumAfterPAGBuild()

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

inline

Definition at line 317 of file IRGraph.h.

    {
        nodeNumAfterPAGBuild = num;
    }

◆ varargFunObjSyms()

FunObjVarToIDMapTy & SVF::IRGraph::varargFunObjSyms ( )

inline

Definition at line 227 of file IRGraph.h.

    {
        return varargFunObjSymMap;
    }

◆ view()

void IRGraph::view ( )

View graph from the debugger.

View IRGraph

Definition at line 318 of file IRGraph.cpp.

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

Friends And Related Symbol Documentation

◆ SVFIRBuilder

friend class SVFIRBuilder

friend

Definition at line 55 of file IRGraph.h.

◆ SVFIRReader

friend class SVFIRReader

friend

Definition at line 54 of file IRGraph.h.

◆ SVFIRWriter

friend class SVFIRWriter

friend

Definition at line 53 of file IRGraph.h.

◆ SymbolTableBuilder

friend class SymbolTableBuilder

friend

Definition at line 56 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 111 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 110 of file IRGraph.h.

◆ KindToSVFStmtSetMap

SVFStmt::KindToSVFStmtMapTy SVF::IRGraph::KindToSVFStmtSetMap

protected

SVFIR edge map containing all PAGEdges.

Definition at line 109 of file IRGraph.h.

◆ maxStruct

const SVFType* SVF::IRGraph::maxStruct

The struct type with the most fields.

Definition at line 351 of file IRGraph.h.

◆ maxStSize

u32_t SVF::IRGraph::maxStSize

The number of fields in max_struct.

Definition at line 354 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 112 of file IRGraph.h.

◆ objTypeInfoMap

IDToTypeInfoMapTy SVF::IRGraph::objTypeInfoMap

private

map a memory sym id to its obj

Definition at line 88 of file IRGraph.h.

◆ objVarNum

u32_t SVF::IRGraph::objVarNum

protected

Definition at line 115 of file IRGraph.h.

◆ returnFunObjSymMap

FunObjVarToIDMapTy SVF::IRGraph::returnFunObjSymMap

private

return map

Definition at line 86 of file IRGraph.h.

◆ stInfos

Set<const StInfo*> SVF::IRGraph::stInfos

private

(owned) All StInfo

Definition at line 98 of file IRGraph.h.

◆ svfTypes

SVFTypeSet SVF::IRGraph::svfTypes

private

(owned) All SVF Types Every type T is mapped to StInfo which contains size (fsize) , offset(foffset) fsize[i] is the number of fields in the largest such struct, else fsize[i] = 1. fsize[0] is always the size of the expanded struct.

Definition at line 95 of file IRGraph.h.

◆ totalPTAPAGEdge

u32_t SVF::IRGraph::totalPTAPAGEdge

protected

Definition at line 113 of file IRGraph.h.

◆ totalSymNum

NodeID SVF::IRGraph::totalSymNum

private

total number of symbols

Definition at line 101 of file IRGraph.h.

◆ valVarNum

u32_t SVF::IRGraph::valVarNum

protected

Definition at line 114 of file IRGraph.h.

◆ varargFunObjSymMap

FunObjVarToIDMapTy SVF::IRGraph::varargFunObjSymMap

private

vararg map

Definition at line 87 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

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ FunObjVarToIDMapTy

◆ IDToTypeInfoMapTy

◆ SVFStmtSet

◆ SVFTypeSet

Member Enumeration Documentation

◆ SYMTYPE

Constructor & Destructor Documentation

◆ IRGraph()

◆ ~IRGraph()

Member Function Documentation

◆ addEdge()

◆ addNode()

◆ addStInfo()

◆ addTypeInfo()

◆ blackholeSymID()

◆ blkPtrSymID()

◆ constantSymID()

◆ createDummyObjTypeInfo()

◆ createObjTypeInfo()

◆ destorySymTable()

◆ dump()

◆ dumpSymTable()

◆ getBlackHoleNode()

◆ getBlkPtr()

◆ getConstantNode()

◆ getFlattenedElemIdx()

◆ getFlattenFieldTypes()

◆ getFlatternedElemType()

◆ getGraphName()

◆ getMaxStructSize()

◆ getModulusOffset()

◆ getNodeNumAfterPAGBuild()

◆ getNullPtr()

◆ getNumOfFlattenElements()

◆ getObjectNodeNum()

◆ getObjTypeInfo()

◆ getOriginalElemType()

◆ getPAGEdgeNum()

◆ getPAGNodeNum()

◆ getPTAPAGEdgeNum()

◆ getReturnNode()

◆ getStInfos()

◆ getSVFTypes()

◆ getTotalSymNum()

◆ getTypeInfo()

◆ getValueNodeNum()

◆ getVarargNode()

◆ hasLabeledEdge() [1/2]

◆ hasLabeledEdge() [2/2]

◆ hasNonlabeledEdge()

◆ hasSVFTypeInfo()

◆ idToObjTypeInfoMap() [1/2]

◆ idToObjTypeInfoMap() [2/2]

◆ isBlkObj()

◆ isBlkObjOrConstantObj()

◆ isBlkPtr()

◆ isBuiltFromFile()

◆ isConstantSym()

◆ isNullPtr()

◆ nullPtrSymID()

◆ printFlattenFields()

◆ retFunObjSyms()

◆ setNodeNumAfterPAGBuild()

◆ varargFunObjSyms()

◆ view()

Friends And Related Symbol Documentation

◆ SVFIRBuilder

◆ SVFIRReader

◆ SVFIRWriter