#include <BasicBlockG.h>

Inheritance diagram for SVF::SVFBasicBlock:

Public Types
typedef std::vector< constICFGNode * >::const_iterator	const_iterator

Public Types inherited from SVF::GenericNode< NodeTy, EdgeTy >
typedef NodeTy	NodeType

typedef EdgeTy	EdgeType

typedef OrderedSet< EdgeType *, typename EdgeType::equalGEdge >	GEdgeSetTy
	Edge kind.

typedef GEdgeSetTy::iterator	iterator

typedef GEdgeSetTy::const_iterator	const_iterator

Public Types inherited from SVF::SVFValue
enum	GNodeK { IntraBlock , GlobalBlock , FunEntryBlock , FunExitBlock , FunCallBlock , FunRetBlock , ValNode , ArgValNode , FunValNode , GepValNode , RetValNode , VarargValNode , GlobalValNode , ConstAggValNode , ConstDataValNode , BlackHoleValNode , ConstFPValNode , ConstIntValNode , ConstNullptrValNode , DummyValNode , ObjNode , GepObjNode , BaseObjNode , FunObjNode , HeapObjNode , StackObjNode , GlobalObjNode , ConstAggObjNode , ConstDataObjNode , ConstFPObjNode , ConstIntObjNode , ConstNullptrObjNode , DummyObjNode , Cmp , BinaryOp , UnaryOp , Branch , DummyVProp , NPtr , FRet , ARet , AParm , FParm , Addr , Copy , Gep , Store , Load , TPhi , TIntraPhi , TInterPhi , FPIN , FPOUT , APIN , APOUT , MPhi , MIntraPhi , MInterPhi , CallNodeKd , CDNodeKd , CFLNodeKd , CHNodeKd , ConstraintNodeKd , TCTNodeKd , DCHNodeKd , BasicBlockKd , OtherKd }

Public Member Functions
	SVFBasicBlock (NodeID id, const FunObjVar *f)
	Constructor without name.

	SVFBasicBlock ()=delete

	~SVFBasicBlock ()

const std::vector< const ICFGNode * > &	getICFGNodeList () const

const_iterator	begin () const

const_iterator	end () const

void	setFun (const FunObjVar *f)

void	addSuccBasicBlock (const SVFBasicBlock *succ2)

void	addPredBasicBlock (const SVFBasicBlock *pred2)

const FunObjVar *	getParent () const

const FunObjVar *	getFunction () const

const ICFGNode *	front () const

const ICFGNode *	back () const

std::vector< const SVFBasicBlock * >	getSuccessors () const

std::vector< const SVFBasicBlock * >	getPredecessors () const

u32_t	getNumSuccessors () const

u32_t	getBBSuccessorPos (const SVFBasicBlock *Succ)

u32_t	getBBSuccessorPos (const SVFBasicBlock *Succ) const

u32_t	getBBPredecessorPos (const SVFBasicBlock *succbb)

u32_t	getBBPredecessorPos (const SVFBasicBlock *succbb) const

const std::string	toString () const

Public Member Functions inherited from SVF::GenericNode< NodeTy, EdgeTy >
	GenericNode (NodeID i, GNodeK k, const SVFType *svfType=nullptr)
	Constructor.

virtual	~GenericNode ()
	Destructor.

bool	hasIncomingEdge () const
	Has incoming/outgoing edge set.

bool	hasOutgoingEdge () const

iterator	OutEdgeBegin ()
	iterators

iterator	OutEdgeEnd ()

iterator	InEdgeBegin ()

iterator	InEdgeEnd ()

const_iterator	OutEdgeBegin () const

const_iterator	OutEdgeEnd () const

const_iterator	InEdgeBegin () const

const_iterator	InEdgeEnd () const

virtual iterator	directOutEdgeBegin ()
	Iterators used for SCC detection, overwrite it in child class if necessary.

virtual iterator	directOutEdgeEnd ()

virtual iterator	directInEdgeBegin ()

virtual iterator	directInEdgeEnd ()

virtual const_iterator	directOutEdgeBegin () const

virtual const_iterator	directOutEdgeEnd () const

virtual const_iterator	directInEdgeBegin () const

virtual const_iterator	directInEdgeEnd () const

bool	addIncomingEdge (EdgeType *inEdge)
	Add incoming and outgoing edges.

bool	addOutgoingEdge (EdgeType *outEdge)

EdgeType *	hasIncomingEdge (EdgeType *edge) const
	Find incoming and outgoing edges.

EdgeType *	hasOutgoingEdge (EdgeType *edge) const

const GEdgeSetTy &	getOutEdges () const

const GEdgeSetTy &	getInEdges () const

u32_t	removeIncomingEdge (EdgeType *edge)

u32_t	removeOutgoingEdge (EdgeType *edge)

Public Member Functions inherited from SVF::SVFValue
	SVFValue (NodeID i, GNodeK k, const SVFType *ty=nullptr)

NodeID	getId () const
	Get ID.

GNodeK	getNodeKind () const
	Get node kind.

virtual const SVFType *	getType () const

virtual void	setName (const std::string &nameInfo)

virtual void	setName (std::string &&nameInfo)

virtual const std::string &	getName () const

virtual void	setSourceLoc (const std::string &sourceCodeInfo)

virtual const std::string	getSourceLoc () const

const std::string	valueOnlyToString () const

Static Public Member Functions
static bool	classof (const SVFValue *node)

static bool	classof (const SVFBasicBlock *node)

Static Public Member Functions inherited from SVF::GenericNode< NodeTy, EdgeTy >
static bool	classof (const GenericNode< NodeTy, EdgeTy > *)

static bool	classof (const SVFValue *)

Public Attributes
std::vector< const SVFBasicBlock * >	succBBs

std::vector< const SVFBasicBlock * >	predBBs

Protected Member Functions

void	addICFGNode (const ICFGNode *icfgNode)
	Function where this BasicBlock is.

Private Attributes
std::vector< const ICFGNode * >	allICFGNodes
	all ICFGNodes in this BasicBlock

const FunObjVar *	fun

Friends
class	LLVMModuleSet

class	SVFIRWriter

class	SVFIRReader

class	SVFIRBuilder

class	FunObjVar

class	ICFGBuilder

class	ICFG

OutStream &	operator<< (OutStream &o, const SVFBasicBlock &node)

Additional Inherited Members
Static Protected Member Functions inherited from SVF::SVFValue
static bool	isICFGNodeKinds (GNodeK n)
	Helper functions to check node kinds.

static bool	isInterICFGNodeKind (GNodeK n)

static bool	isSVFVarKind (GNodeK n)

static bool	isValVarKinds (GNodeK n)

static bool	isConstantDataValVar (GNodeK n)

static bool	isObjVarKinds (GNodeK n)

static bool	isBaseObjVarKinds (GNodeK n)

static bool	isConstantDataObjVarKinds (GNodeK n)

static bool	isVFGNodeKinds (GNodeK n)

static bool	isArgumentVFGNodeKinds (GNodeK n)

static bool	isStmtVFGNodeKinds (GNodeK n)

static bool	isPHIVFGNodeKinds (GNodeK n)

static bool	isMRSVFGNodeKinds (GNodeK n)

static bool	isMSSAPHISVFGNodeKinds (GNodeK n)

Protected Attributes inherited from SVF::SVFValue
NodeID	id
	Node ID.

GNodeK	nodeKind
	Node kind.

const SVFType *	type
	SVF type.

std::string	name

std::string	sourceLoc
	Source code information of this value.

Detailed Description

Definition at line 73 of file BasicBlockG.h.

Member Typedef Documentation

◆ const_iterator

typedef std::vector<constICFGNode*>::const_iterator SVF::SVFBasicBlock::const_iterator

Definition at line 84 of file BasicBlockG.h.

Constructor & Destructor Documentation

◆ SVFBasicBlock() [1/2]

SVF::SVFBasicBlock::SVFBasicBlock	(	NodeID	id,
		const FunObjVar *	f
	)

inline

Constructor without name.

Definition at line 108 of file BasicBlockG.h.

                                                : GenericBasicBlockNodeTy(id, BasicBlockKd), fun(f)
    {
 
    }

◆ SVFBasicBlock() [2/2]

SVF::SVFBasicBlock::SVFBasicBlock ( )

delete

◆ ~SVFBasicBlock()

SVF::SVFBasicBlock::~SVFBasicBlock ( )

inline

Definition at line 113 of file BasicBlockG.h.

    {
 
    }

Member Function Documentation

◆ addICFGNode()

void SVF::SVFBasicBlock::addICFGNode ( const ICFGNode * icfgNode )

inlineprotected

Function where this BasicBlock is.

attributes to be set only through Module builders e.g., LLVMModule

Definition at line 97 of file BasicBlockG.h.

    {
        assert(std::find(getICFGNodeList().begin(), getICFGNodeList().end(),
                         icfgNode) == getICFGNodeList().end() && "duplicated icfgnode");
        allICFGNodes.push_back(icfgNode);
    }

◆ addPredBasicBlock()

void SVF::SVFBasicBlock::addPredBasicBlock ( const SVFBasicBlock * pred2 )

inline

Definition at line 175 of file BasicBlockG.h.

    {
        // check if the edge already exists
        for (auto edge: this->getInEdges())
        {
            if (edge->getSrcNode() == pred2)
                return;
        }
        SVFBasicBlock* pred = const_cast<SVFBasicBlock*>(pred2);
        BasicBlockEdge* edge = new BasicBlockEdge(pred, this);
        this->addIncomingEdge(edge);
        pred->addOutgoingEdge(edge);
        this->predBBs.push_back(pred);
        pred->succBBs.push_back(this);
    }

◆ addSuccBasicBlock()

void SVF::SVFBasicBlock::addSuccBasicBlock ( const SVFBasicBlock * succ2 )

inline

Definition at line 158 of file BasicBlockG.h.

    {
        // check if the edge already exists
        for (auto edge: this->getOutEdges())
        {
            if (edge->getDstNode() == succ2)
                return;
        }
 
        SVFBasicBlock* succ = const_cast<SVFBasicBlock*>(succ2);
        BasicBlockEdge* edge = new BasicBlockEdge(this, succ);
        this->addOutgoingEdge(edge);
        succ->addIncomingEdge(edge);
        this->succBBs.push_back(succ);
        succ->predBBs.push_back(this);
    }

◆ back()

const ICFGNode * SVF::SVFBasicBlock::back ( ) const

inline

Definition at line 209 of file BasicBlockG.h.

    {
        assert(!allICFGNodes.empty() && "bb empty?");
        return allICFGNodes.back();
    }

◆ begin()

const_iterator SVF::SVFBasicBlock::begin ( ) const

inline

Definition at line 142 of file BasicBlockG.h.

    {
        return allICFGNodes.begin();
    }

◆ classof() [1/2]

static bool SVF::SVFBasicBlock::classof ( const SVFBasicBlock * node )

inlinestatic

Definition at line 123 of file BasicBlockG.h.

    {
        return true;
    }

◆ classof() [2/2]

static bool SVF::SVFBasicBlock::classof ( const SVFValue * node )

inlinestatic

Definition at line 118 of file BasicBlockG.h.

    {
        return node->getNodeKind() == SVFValue::BasicBlockKd;
    }

◆ end()

const_iterator SVF::SVFBasicBlock::end ( ) const

inline

Definition at line 147 of file BasicBlockG.h.

    {
        return allICFGNodes.end();
    }

◆ front()

const ICFGNode * SVF::SVFBasicBlock::front ( ) const

inline

Definition at line 203 of file BasicBlockG.h.

    {
        assert(!allICFGNodes.empty() && "bb empty?");
        return allICFGNodes.front();
    }

◆ getBBPredecessorPos() [1/2]

u32_t SVF::SVFBasicBlock::getBBPredecessorPos ( const SVFBasicBlock * succbb )

inline

Definition at line 263 of file BasicBlockG.h.

    {
        u32_t pos = 0;
        for (const SVFBasicBlock* PredBB : succbb->getPredecessors())
        {
            if(PredBB == this)
                return pos;
            ++pos;
        }
        assert(false && "Didn't find predecessor edge?");
        return pos;
    }

◆ getBBPredecessorPos() [2/2]

u32_t SVF::SVFBasicBlock::getBBPredecessorPos ( const SVFBasicBlock * succbb ) const

inline

Definition at line 275 of file BasicBlockG.h.

    {
        u32_t pos = 0;
        for (const SVFBasicBlock* PredBB : succbb->getPredecessors())
        {
            if(PredBB == this)
                return pos;
            ++pos;
        }
        assert(false && "Didn't find predecessor edge?");
        return pos;
    }

◆ getBBSuccessorPos() [1/2]

u32_t SVF::SVFBasicBlock::getBBSuccessorPos ( const SVFBasicBlock * Succ )

inline

Definition at line 238 of file BasicBlockG.h.

    {
        u32_t i = 0;
        for (const SVFBasicBlock* SuccBB: succBBs)
        {
            if (SuccBB == Succ)
                return i;
            i++;
        }
        assert(false && "Didn't find successor edge?");
        return 0;
    }

◆ getBBSuccessorPos() [2/2]

u32_t SVF::SVFBasicBlock::getBBSuccessorPos ( const SVFBasicBlock * Succ ) const

inline

Definition at line 250 of file BasicBlockG.h.

    {
        u32_t i = 0;
        for (const SVFBasicBlock* SuccBB: succBBs)
        {
            if (SuccBB == Succ)
                return i;
            i++;
        }
        assert(false && "Didn't find successor edge?");
        return 0;
 
    }

◆ getFunction()

const FunObjVar * SVF::SVFBasicBlock::getFunction ( ) const

inline

Definition at line 197 of file BasicBlockG.h.

    {
        assert(fun && "Function is null?");
        return fun;
    }

◆ getICFGNodeList()

const std::vector< const ICFGNode * > & SVF::SVFBasicBlock::getICFGNodeList ( ) const

inline

Definition at line 137 of file BasicBlockG.h.

    {
        return allICFGNodes;
    }

◆ getNumSuccessors()

u32_t SVF::SVFBasicBlock::getNumSuccessors ( ) const

inline

Definition at line 234 of file BasicBlockG.h.

    {
        return this->getOutEdges().size();
    }

◆ getParent()

const FunObjVar * SVF::SVFBasicBlock::getParent ( ) const

inline

Definition at line 191 of file BasicBlockG.h.

    {
        assert(fun && "Function is null?");
        return fun;
    }

◆ getPredecessors()

std::vector< const SVFBasicBlock * > SVF::SVFBasicBlock::getPredecessors ( ) const

inline

Definition at line 225 of file BasicBlockG.h.

    {
        std::vector<const SVFBasicBlock*> res;
        for (auto edge : this->getInEdges())
        {
            res.push_back(edge->getSrcNode());
        }
        return res;
    }

◆ getSuccessors()

std::vector< const SVFBasicBlock * > SVF::SVFBasicBlock::getSuccessors ( ) const

inline

Definition at line 215 of file BasicBlockG.h.

    {
        std::vector<const SVFBasicBlock*> res;
        for (auto edge : this->getOutEdges())
        {
            res.push_back(edge->getDstNode());
        }
        return res;
    }

◆ setFun()

void SVF::SVFBasicBlock::setFun ( const FunObjVar * f )

inline

Definition at line 153 of file BasicBlockG.h.

    {
        fun = f;
    }

◆ toString()

const std::string SVFBasicBlock::toString ( ) const

Definition at line 13 of file BasicBlockG.cpp.

{
    std::string str;
    std::stringstream rawstr(str);
    rawstr << "----------"<< "SVFBasicBlock: " << getName() <<"----------\n";
    for (const ICFGNode* icfgNode : allICFGNodes)
    {
        rawstr << icfgNode->toString();
    }
    rawstr << "\n----------------------------------------\n";
    return rawstr.str();
}

Friends And Related Symbol Documentation

◆ FunObjVar

friend class FunObjVar

friend

Definition at line 79 of file BasicBlockG.h.

◆ ICFG

friend class ICFG

friend

Definition at line 81 of file BasicBlockG.h.

◆ ICFGBuilder

friend class ICFGBuilder

friend

Definition at line 80 of file BasicBlockG.h.

◆ LLVMModuleSet

friend class LLVMModuleSet

friend

Definition at line 75 of file BasicBlockG.h.

◆ operator<<

OutStream & operator<<	(	OutStream &	o,
		const SVFBasicBlock &	node
	)

friend

Definition at line 129 of file BasicBlockG.h.

    {
        o << node.toString();
        return o;
    }

◆ SVFIRBuilder

friend class SVFIRBuilder

friend

Definition at line 78 of file BasicBlockG.h.

◆ SVFIRReader

friend class SVFIRReader

friend

Definition at line 77 of file BasicBlockG.h.

◆ SVFIRWriter

friend class SVFIRWriter

friend

Definition at line 76 of file BasicBlockG.h.

Member Data Documentation

◆ allICFGNodes

std::vector<const ICFGNode*> SVF::SVFBasicBlock::allICFGNodes

private

all ICFGNodes in this BasicBlock

Definition at line 89 of file BasicBlockG.h.

◆ fun

const FunObjVar* SVF::SVFBasicBlock::fun

private

Definition at line 90 of file BasicBlockG.h.

◆ predBBs

std::vector<const SVFBasicBlock*> SVF::SVFBasicBlock::predBBs

Definition at line 86 of file BasicBlockG.h.

◆ succBBs

std::vector<const SVFBasicBlock*> SVF::SVFBasicBlock::succBBs

Definition at line 85 of file BasicBlockG.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ const_iterator

Constructor & Destructor Documentation

◆ SVFBasicBlock() [1/2]

◆ SVFBasicBlock() [2/2]

◆ ~SVFBasicBlock()

Member Function Documentation

◆ addICFGNode()

◆ addPredBasicBlock()

◆ addSuccBasicBlock()

◆ back()

◆ begin()

◆ classof() [1/2]

◆ classof() [2/2]

◆ end()

◆ front()

◆ getBBPredecessorPos() [1/2]

◆ getBBPredecessorPos() [2/2]

◆ getBBSuccessorPos() [1/2]

◆ getBBSuccessorPos() [2/2]

◆ getFunction()

◆ getICFGNodeList()

◆ getNumSuccessors()

◆ getParent()

◆ getPredecessors()

◆ getSuccessors()

◆ setFun()

◆ toString()

Friends And Related Symbol Documentation

◆ FunObjVar

◆ ICFG

◆ ICFGBuilder

◆ LLVMModuleSet

◆ operator<<

◆ SVFIRBuilder

◆ SVFIRReader

◆ SVFIRWriter

Member Data Documentation

◆ allICFGNodes

◆ fun

◆ predBBs

◆ succBBs