SVF::BranchStmt Class Reference

#include <SVFStatements.h>

Inheritance diagram for SVF::BranchStmt:

Public Types
typedef std::vector< std::pair< const ICFGNode *, s32_t > >	SuccAndCondPairVec
Public Types inherited from SVF::SVFStmt
enum	PEDGEK {   Addr , Copy , Store , Load ,   Call , Ret , Gep , Phi ,   Select , Cmp , BinaryOp , UnaryOp ,   Branch , ThreadFork , ThreadJoin }
typedef GenericNode< SVFVar, SVFStmt >::GEdgeSetTy	SVFStmtSetTy
typedef Map< EdgeID, SVFStmtSetTy >	PAGEdgeToSetMapTy
typedef PAGEdgeToSetMapTy	KindToSVFStmtMapTy
typedef SVFStmtSetTy	PAGEdgeSetTy
Public Types inherited from SVF::GenericEdge< NodeTy >
typedef NodeTy	NodeType
	Node type.
typedef u64_t	GEdgeFlag
typedef s64_t	GEdgeKind
typedef struct SVF::GenericEdge::equalGEdge	equalGEdge
	Add the hash function for std::set (we also can overload operator< to implement this)

Public Member Functions
	BranchStmt (SVFVar *inst, SVFVar *c, const SuccAndCondPairVec &succs)
	constructor
bool	isUnconditional () const
	The branch is unconditional if cond is a null value.
bool	isConditional () const
	The branch is conditional if cond is not a null value.
const SVFVar *	getCondition () const
	Return the condition.
const SVFVar *	getBranchInst () const
u32_t	getNumSuccessors () const
const SuccAndCondPairVec &	getSuccessors () const
const ICFGNode *	getSuccessor (u32_t i) const
s64_t	getSuccessorCondValue (u32_t i) const
virtual const std::string	toString () const override
Public Member Functions inherited from SVF::SVFStmt
	SVFStmt (SVFVar *s, SVFVar *d, GEdgeFlag k, bool real=true)
	Constructor.
	~SVFStmt ()
	Destructor.
EdgeID	getEdgeID () const
	Return Edge ID.
bool	isPTAEdge () const
	Whether src and dst nodes are both of pointer type.
void	setValue (const SVFVar *val)
	Get/set methods for llvm instruction.
const SVFVar *	getValue () const
void	setBB (const SVFBasicBlock *bb)
const SVFBasicBlock *	getBB () const
void	setICFGNode (ICFGNode *node)
ICFGNode *	getICFGNode () const
Public Member Functions inherited from SVF::GenericEdge< NodeTy >
	GenericEdge (NodeTy *s, NodeTy *d, GEdgeFlag k)
	Constructor.
virtual	~GenericEdge ()
	Destructor.
NodeID	getSrcID () const
	get methods of the components
NodeID	getDstID () const
GEdgeKind	getEdgeKind () const
GEdgeKind	getEdgeKindWithoutMask () const
NodeType *	getSrcNode () const
NodeType *	getDstNode () const
virtual bool	operator== (const GenericEdge< NodeType > *rhs) const

Static Public Member Functions
static bool	classof (const BranchStmt *)
	Methods for support type inquiry through isa, cast, and dyn_cast:
static bool	classof (const SVFStmt *edge)
static bool	classof (const GenericPAGEdgeTy *edge)
Static Public Member Functions inherited from SVF::SVFStmt
static bool	classof (const SVFStmt *)
	ClassOf.
static bool	classof (const GenericPAGEdgeTy *edge)
static GEdgeFlag	makeEdgeFlagWithAddionalOpnd (GEdgeKind k, const SVFVar *var)
static GEdgeFlag	makeEdgeFlagWithCallInst (GEdgeKind k, const ICFGNode *cs)
static GEdgeFlag	makeEdgeFlagWithStoreInst (GEdgeKind k, const ICFGNode *store)

Private Member Functions
	BranchStmt ()
	Constructs empty BranchStmt (for SVFIRReader/serialization)
	BranchStmt (const BranchStmt &)
	place holder
void	operator= (const BranchStmt &)
	place holder
SVFVar *	getSrcNode ()
	place holder, not allowed
SVFVar *	getDstNode ()
	place holder, not allowed
NodeID	getSrcID ()
	place holder, use getOpVarID(pos) instead
NodeID	getDstID ()
	place holder, use getResID() instead

Private Attributes
SuccAndCondPairVec	successors
const SVFVar *	cond
const SVFVar *	brInst

Friends
class	SVFIRWriter
class	SVFIRReader

Additional Inherited Members
Static Public Attributes inherited from SVF::SVFStmt
static u32_t	totalEdgeNum
	Total edge number.
Protected Member Functions inherited from SVF::SVFStmt
	SVFStmt (GEdgeFlag k)
	Private constructor for reading SVFIR from file without side-effect.
Static Protected Attributes inherited from SVF::GenericEdge< NodeTy >
static constexpr unsigned char	EdgeKindMaskBits = 8
	We use the lower 8 bits to denote edge kind.
static constexpr u64_t	EdgeKindMask = (~0ULL) >> (64 - EdgeKindMaskBits)

Detailed Description

Branch statements including if/else and switch

Definition at line 1157 of file SVFStatements.h.

Member Typedef Documentation

SuccAndCondPairVec

typedef std::vector<std::pair<const ICFGNode*, s32_t> > SVF::BranchStmt::SuccAndCondPairVec

Definition at line 1163 of file SVFStatements.h.

Constructor & Destructor Documentation

BranchStmt() [1/3]

SVF::BranchStmt::BranchStmt ( )

inlineprivate

Constructs empty BranchStmt (for SVFIRReader/serialization)

Definition at line 1167 of file SVFStatements.h.

: SVFStmt(SVFStmt::Branch), cond{}, brInst{} {}

BranchStmt() [2/3]

SVF::BranchStmt::BranchStmt ( const BranchStmt &  )

private

place holder

BranchStmt() [3/3]

SVF::BranchStmt::BranchStmt ( SVFVar *  inst, SVFVar *  c, const SuccAndCondPairVec &  succs  )

inline

constructor

Definition at line 1197 of file SVFStatements.h.

        : SVFStmt(c, inst, SVFStmt::Branch), successors(succs), cond(c),
          brInst(inst)
    {
    }

Member Function Documentation

classof() [1/3]

static bool SVF::BranchStmt::classof ( const BranchStmt *  )

inlinestatic

Methods for support type inquiry through isa, cast, and dyn_cast:

Definition at line 1182 of file SVFStatements.h.

    {
        return true;
    }

classof() [2/3]

static bool SVF::BranchStmt::classof ( const GenericPAGEdgeTy *  edge )

inlinestatic

Definition at line 1190 of file SVFStatements.h.

    {
        return edge->getEdgeKind() == SVFStmt::Branch;
    }

classof() [3/3]

static bool SVF::BranchStmt::classof ( const SVFStmt *  edge )

inlinestatic

Definition at line 1186 of file SVFStatements.h.

    {
        return edge->getEdgeKind() == SVFStmt::Branch;
    }

getBranchInst()

const SVFVar * SVF::BranchStmt::getBranchInst ( ) const

inline

Definition at line 1209 of file SVFStatements.h.

    {
        return brInst;
    }

getCondition()

const SVFVar * BranchStmt::getCondition

(

)

const

Return the condition.

Definition at line 322 of file SVFStatements.cpp.

{
    //assert(isConditional() && "this is a unconditional branch");
    return cond;
}

getDstID()

NodeID SVF::BranchStmt::getDstID ( )

private

place holder, use getResID() instead

getDstNode()

SVFVar * SVF::BranchStmt::getDstNode ( )

private

place holder, not allowed

getNumSuccessors()

u32_t SVF::BranchStmt::getNumSuccessors ( ) const

inline

For example if(c) {stmt1} else {stmt2} successor(0): stmt1, 1 successor(1): stmt2, 0 For example switch(c) case 0: {stmt1; break;} case 1: {stmt2; break;} default {stmt3: break} successor(0): stmt1, 0 successor(1): stmt2, 1 successor(3): stmt3, -1 Successors of this branch statement

Definition at line 1224 of file SVFStatements.h.

    {
        return successors.size();
    }

getSrcID()

NodeID SVF::BranchStmt::getSrcID ( )

private

place holder, use getOpVarID(pos) instead

getSrcNode()

SVFVar * SVF::BranchStmt::getSrcNode ( )

private

place holder, not allowed

getSuccessor()

const ICFGNode * SVF::BranchStmt::getSuccessor ( u32_t  i ) const

inline

Definition at line 1232 of file SVFStatements.h.

    {
        return successors.at(i).first;
    }

getSuccessorCondValue()

s64_t SVF::BranchStmt::getSuccessorCondValue ( u32_t  i ) const

inline

Definition at line 1236 of file SVFStatements.h.

    {
        return successors.at(i).second;
    }

getSuccessors()

const SuccAndCondPairVec & SVF::BranchStmt::getSuccessors ( ) const

inline

Definition at line 1228 of file SVFStatements.h.

    {
        return successors;
    }

isConditional()

bool BranchStmt::isConditional

(

)

const

The branch is conditional if cond is not a null value.

Definition at line 317 of file SVFStatements.cpp.

{
    return cond->getId() != PAG::getPAG()->nullPtrSymID();;
}

isUnconditional()

bool BranchStmt::isUnconditional

(

)

const

The branch is unconditional if cond is a null value.

Definition at line 312 of file SVFStatements.cpp.

{
    return cond->getId() == PAG::getPAG()->nullPtrSymID();
}

operator=()

void SVF::BranchStmt::operator= ( const BranchStmt &  )

private

place holder

toString()

const std::string BranchStmt::toString ( ) const

overridevirtual

Reimplemented from SVF::SVFStmt.

Definition at line 171 of file SVFStatements.cpp.

{
    std::string str;
    std::stringstream rawstr(str);
    if(isConditional())
        rawstr << "BranchStmt: [Condition Var" <<  getCondition()->getId() << "]\n";
    else
        rawstr << "BranchStmt: [" <<  " Unconditional branch" << "]\n";
 
    for(u32_t i = 0; i < getNumSuccessors(); i++)
        rawstr << "Successor " << i << " ICFGNode" << getSuccessor(i)->getId() << "   ";
 
    if (Options::ShowSVFIRValue())
    {
        rawstr << "\n";
        rawstr << getValue()->toString();
    }
    return rawstr.str();
}

Friends And Related Symbol Documentation

SVFIRReader

friend class SVFIRReader

friend

Definition at line 1160 of file SVFStatements.h.

SVFIRWriter

friend class SVFIRWriter

friend

Definition at line 1159 of file SVFStatements.h.

Member Data Documentation

brInst

const SVFVar* SVF::BranchStmt::brInst

private

Definition at line 1177 of file SVFStatements.h.

cond

const SVFVar* SVF::BranchStmt::cond

private

Definition at line 1176 of file SVFStatements.h.

successors

SuccAndCondPairVec SVF::BranchStmt::successors

private

Definition at line 1175 of file SVFStatements.h.

---

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

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