#include <SVFStatements.h>

Inheritance diagram for SVF::SVFStmt:

Public Types
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
	SVFStmt (SVFVar s, SVFVar d, GEdgeFlag k, bool real=true)
	Constructor.

	~SVFStmt ()
	Destructor.

EdgeID	getEdgeID () const
	Return Edge ID.

virtual 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

virtual const std::string	toString () 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 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)

static const Inst2LabelMap *	getInst2LabelMap ()

static const Var2LabelMap *	getVar2LabelMap ()

static const u64_t *	getCallEdgeLabelCounter ()

static const u64_t *	getStoreEdgeLabelCounter ()

static const u64_t *	getMultiOpndLabelCounter ()

Protected Member Functions
	SVFStmt (GEdgeFlag k)
	Private constructor for reading SVFIR from file without side-effect.

	SVFStmt (SVFVar s, SVFVar d, GEdgeFlag k, EdgeID eid, SVFVar value, ICFGNode icfgNode, bool real=true)

void	setBasicBlock (const SVFBasicBlock *bb)

void	setCallEdgeLabelCounter (u64_t counter)

void	setStoreEdgeLabelCounter (u64_t counter)

void	setMultiOpndLabelCounter (u64_t counter)

Static Protected Member Functions
static void	addInst2Labeled (const ICFGNode *cs, u32_t label)

static void	addVar2Labeled (const SVFVar *var, u32_t label)

Private Types
typedef Map< const ICFGNode *, u32_t >	Inst2LabelMap

typedef Map< const SVFVar *, u32_t >	Var2LabelMap

Private Attributes
const SVFVar *	value
	LLVM value.

const SVFBasicBlock *	basicBlock
	LLVM BasicBlock.

ICFGNode *	icfgNode
	ICFGNode.

EdgeID	edgeId
	Edge ID.

Static Private Attributes
static Inst2LabelMap	inst2LabelMap
	Call site Instruction to label map.

static Var2LabelMap	var2LabelMap
	Second operand of MultiOpndStmt to label map.

static u64_t	callEdgeLabelCounter = 0
	Call site Instruction counter.

static u64_t	storeEdgeLabelCounter = 0
	Store Instruction counter.

static u64_t	multiOpndLabelCounter = 0
	MultiOpndStmt counter.

Friends
class	GraphDBClient

OutStream &	operator<< (OutStream &o, const SVFStmt &edge)
	Overloading operator << for dumping SVFVar value.

Additional Inherited Members
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

Definition at line 55 of file SVFStatements.h.

Member Typedef Documentation

◆ Inst2LabelMap

typedef Map<const ICFGNode*, u32_t> SVF::SVFStmt::Inst2LabelMap

private

Definition at line 268 of file SVFStatements.h.

◆ KindToSVFStmtMapTy

typedef PAGEdgeToSetMapTy SVF::SVFStmt::KindToSVFStmtMapTy

Definition at line 264 of file SVFStatements.h.

◆ PAGEdgeSetTy

typedef SVFStmtSetTy SVF::SVFStmt::PAGEdgeSetTy

Definition at line 265 of file SVFStatements.h.

◆ PAGEdgeToSetMapTy

typedef Map<EdgeID, SVFStmtSetTy> SVF::SVFStmt::PAGEdgeToSetMapTy

Definition at line 263 of file SVFStatements.h.

◆ SVFStmtSetTy

typedef GenericNode<SVFVar,SVFStmt>::GEdgeSetTy SVF::SVFStmt::SVFStmtSetTy

Definition at line 262 of file SVFStatements.h.

◆ Var2LabelMap

typedef Map<const SVFVar*, u32_t> SVF::SVFStmt::Var2LabelMap

private

Definition at line 269 of file SVFStatements.h.

Member Enumeration Documentation

◆ PEDGEK

enum SVF::SVFStmt::PEDGEK

Types of SVFIR statements Gep represents (base + offset) for field sensitivity ThreadFork/ThreadJoin is to model parameter passings between thread spawners and spawnees.

Enumerator
Addr
Copy
Store
Load
Call
Ret
Gep
Phi
Select
Cmp
BinaryOp
UnaryOp
Branch
ThreadFork
ThreadJoin

Definition at line 64 of file SVFStatements.h.

    {
        Addr,
        Copy,
        Store,
        Load,
        Call,
        Ret,
        Gep,
        Phi,
        Select,
        Cmp,
        BinaryOp,
        UnaryOp,
        Branch,
        ThreadFork,
        ThreadJoin
    };

Constructor & Destructor Documentation

◆ SVFStmt() [1/3]

SVF::SVFStmt::SVFStmt ( GEdgeFlag k )

inlineprotected

Private constructor for reading SVFIR from file without side-effect.

Definition at line 91 of file SVFStatements.h.

        : GenericPAGEdgeTy({}, {}, k), value{}, basicBlock{}, icfgNode{}
    {
    }

◆ SVFStmt() [2/3]

SVFStmt::SVFStmt	(	SVFVar *	s,
		SVFVar *	d,
		GEdgeFlag	k,
		EdgeID	eid,
		SVFVar *	value,
		ICFGNode *	icfgNode,
		bool	real = `true`
	)

protected

Definition at line 58 of file SVFStatements.cpp.

                                                                                                            :
    GenericPAGEdgeTy(s,d,k),value(value),basicBlock(nullptr),icfgNode(icfgNode),edgeId(eid)
{
    if(real)
    {
        edgeId = eid;
        SVFIR::getPAG()->incEdgeNum();
    }
}

◆ SVFStmt() [3/3]

SVFStmt::SVFStmt	(	SVFVar *	s,
		SVFVar *	d,
		GEdgeFlag	k,
		bool	real = `true`
	)

Constructor.

SVFStmt constructor

Definition at line 48 of file SVFStatements.cpp.

                                                             :
    GenericPAGEdgeTy(s,d,k),value(nullptr),basicBlock(nullptr),icfgNode(nullptr),edgeId(UINT_MAX)
{
    if(real)
    {
        edgeId = SVFIR::getPAG()->getTotalEdgeNum();
        SVFIR::getPAG()->incEdgeNum();
    }
}

◆ ~SVFStmt()

SVF::SVFStmt::~SVFStmt ( )

inline

Destructor.

Definition at line 148 of file SVFStatements.h.

148{}

Member Function Documentation

◆ addInst2Labeled()

static void SVF::SVFStmt::addInst2Labeled	(	const ICFGNode *	cs,
		u32_t	label
	)

inlinestaticprotected

Add a call site Instruction to label mapping, this is used when loading statements from DB

Definition at line 133 of file SVFStatements.h.

    {
        inst2LabelMap.emplace(cs, label);
    }

◆ addVar2Labeled()

static void SVF::SVFStmt::addVar2Labeled	(	const SVFVar *	var,
		u32_t	label
	)

inlinestaticprotected

Definition at line 138 of file SVFStatements.h.

    {
        var2LabelMap.emplace(var, label);
    }

◆ classof() [1/2]

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

inlinestatic

Definition at line 156 of file SVFStatements.h.

    {
        return edge->getEdgeKind() == SVFStmt::Addr ||
               edge->getEdgeKind() == SVFStmt::Copy ||
               edge->getEdgeKind() == SVFStmt::Store ||
               edge->getEdgeKind() == SVFStmt::Load ||
               edge->getEdgeKind() == SVFStmt::Call ||
               edge->getEdgeKind() == SVFStmt::Ret ||
               edge->getEdgeKind() == SVFStmt::Gep ||
               edge->getEdgeKind() == SVFStmt::Phi ||
               edge->getEdgeKind() == SVFStmt::Select ||
               edge->getEdgeKind() == SVFStmt::Cmp ||
               edge->getEdgeKind() == SVFStmt::BinaryOp ||
               edge->getEdgeKind() == SVFStmt::UnaryOp ||
               edge->getEdgeKind() == SVFStmt::Branch ||
               edge->getEdgeKind() == SVFStmt::ThreadFork ||
               edge->getEdgeKind() == SVFStmt::ThreadJoin;
    }

◆ classof() [2/2]

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

inlinestatic

ClassOf.

Definition at line 152 of file SVFStatements.h.

    {
        return true;
    }

◆ getBB()

const SVFBasicBlock * SVF::SVFStmt::getBB ( ) const

inline

Definition at line 200 of file SVFStatements.h.

    {
        return basicBlock;
    }

◆ getCallEdgeLabelCounter()

static const u64_t * SVF::SVFStmt::getCallEdgeLabelCounter ( )

inlinestatic

Definition at line 287 of file SVFStatements.h.

    {
        return &callEdgeLabelCounter;
    }

◆ getEdgeID()

EdgeID SVF::SVFStmt::getEdgeID ( ) const

inline

Return Edge ID.

Definition at line 177 of file SVFStatements.h.

    {
        return edgeId;
    }

◆ getICFGNode()

ICFGNode * SVF::SVFStmt::getICFGNode ( ) const

inline

Definition at line 208 of file SVFStatements.h.

    {
        return icfgNode;
    }

◆ getInst2LabelMap()

static const Inst2LabelMap * SVF::SVFStmt::getInst2LabelMap ( )

inlinestatic

Definition at line 277 of file SVFStatements.h.

    {
        return &inst2LabelMap;
    }

◆ getMultiOpndLabelCounter()

static const u64_t * SVF::SVFStmt::getMultiOpndLabelCounter ( )

inlinestatic

Definition at line 297 of file SVFStatements.h.

    {
        return &multiOpndLabelCounter;
    }

◆ getStoreEdgeLabelCounter()

static const u64_t * SVF::SVFStmt::getStoreEdgeLabelCounter ( )

inlinestatic

Definition at line 292 of file SVFStatements.h.

    {
        return &storeEdgeLabelCounter;
    }

◆ getValue()

const SVFVar * SVF::SVFStmt::getValue ( ) const

inline

Definition at line 191 of file SVFStatements.h.

    {
        return value;
    }

◆ getVar2LabelMap()

static const Var2LabelMap * SVF::SVFStmt::getVar2LabelMap ( )

inlinestatic

Definition at line 282 of file SVFStatements.h.

    {
        return &var2LabelMap;
    }

◆ isPTAEdge()

bool SVFStmt::isPTAEdge ( ) const

virtual

Whether src and dst nodes are both of pointer type.

Whether src and dst nodes are both pointer type

Reimplemented in SVF::AddrStmt.

Definition at line 71 of file SVFStatements.cpp.

{
    return getSrcNode()->isPointer() && getDstNode()->isPointer();
}

◆ makeEdgeFlagWithAddionalOpnd()

static GEdgeFlag SVF::SVFStmt::makeEdgeFlagWithAddionalOpnd	(	GEdgeKind	k,
		const SVFVar *	var
	)

inlinestatic

Compute the unique edgeFlag value from edge kind and second variable operand for MultiOpndStmt.

Definition at line 216 of file SVFStatements.h.

    {
        auto it_inserted = var2LabelMap.emplace(var, multiOpndLabelCounter);
        if (it_inserted.second)
            ++multiOpndLabelCounter;
        u64_t label = it_inserted.first->second;
        return (label << EdgeKindMaskBits) | k;
    }

◆ makeEdgeFlagWithCallInst()

static GEdgeFlag SVF::SVFStmt::makeEdgeFlagWithCallInst	(	GEdgeKind	k,
		const ICFGNode *	cs
	)

inlinestatic

Compute the unique edgeFlag value from edge kind and call site Instruction.

Definition at line 228 of file SVFStatements.h.

    {
        auto it_inserted = inst2LabelMap.emplace(cs, callEdgeLabelCounter);
        if (it_inserted.second)
            ++callEdgeLabelCounter;
        u64_t label = it_inserted.first->second;
        return (label << EdgeKindMaskBits) | k;
    }

◆ makeEdgeFlagWithStoreInst()

static GEdgeFlag SVF::SVFStmt::makeEdgeFlagWithStoreInst	(	GEdgeKind	k,
		const ICFGNode *	store
	)

inlinestatic

Compute the unique edgeFlag value from edge kind and store Instruction. Two store instructions may share the same StorePAGEdge

Definition at line 240 of file SVFStatements.h.

    {
        auto it_inserted = inst2LabelMap.emplace(store, storeEdgeLabelCounter);
        if (it_inserted.second)
            ++storeEdgeLabelCounter;
        u64_t label = it_inserted.first->second;
        return (label << EdgeKindMaskBits) | k;
    }

◆ setBasicBlock()

void SVF::SVFStmt::setBasicBlock ( const SVFBasicBlock * bb )

inlineprotected

Set the SVF BasicBlock for the new statements, this is used when loading statements from DB

Definition at line 101 of file SVFStatements.h.

    {
        basicBlock = bb;
    }

◆ setBB()

void SVF::SVFStmt::setBB ( const SVFBasicBlock * bb )

inline

Definition at line 196 of file SVFStatements.h.

    {
        basicBlock = bb;
    }

◆ setCallEdgeLabelCounter()

void SVF::SVFStmt::setCallEdgeLabelCounter ( u64_t counter )

inlineprotected

set the call edge lanbel counter for the new statements, this is used when loading statements from DB

Definition at line 109 of file SVFStatements.h.

    {
        callEdgeLabelCounter = counter;
    }

◆ setICFGNode()

void SVF::SVFStmt::setICFGNode ( ICFGNode * node )

inline

Definition at line 204 of file SVFStatements.h.

    {
        icfgNode = node;
    }

◆ setMultiOpndLabelCounter()

void SVF::SVFStmt::setMultiOpndLabelCounter ( u64_t counter )

inlineprotected

set the multi operand edge lanbel counter for the new statements, this is used when loading statements from DB

Definition at line 125 of file SVFStatements.h.

    {
        multiOpndLabelCounter = counter;
    }

◆ setStoreEdgeLabelCounter()

void SVF::SVFStmt::setStoreEdgeLabelCounter ( u64_t counter )

inlineprotected

set the store edge lanbel counter for the new statements, this is used when loading statements from DB

Definition at line 117 of file SVFStatements.h.

    {
        storeEdgeLabelCounter = counter;
    }

◆ setValue()

void SVF::SVFStmt::setValue ( const SVFVar * val )

inline

Get/set methods for llvm instruction.

Definition at line 187 of file SVFStatements.h.

    {
        value = val;
    }

◆ toString()

const std::string SVFStmt::toString ( ) const

virtual

Reimplemented in SVF::GepStmt, SVF::TDForkPE, SVF::TDJoinPE, SVF::AssignStmt, SVF::AddrStmt, SVF::CopyStmt, SVF::StoreStmt, SVF::LoadStmt, SVF::RetPE, SVF::CallPE, SVF::PhiStmt, SVF::SelectStmt, SVF::CmpStmt, SVF::BinaryOPStmt, SVF::UnaryOPStmt, and SVF::BranchStmt.

Definition at line 76 of file SVFStatements.cpp.

{
    std::string str;
    std::stringstream rawstr(str);
    rawstr << "SVFStmt: [Var" << getDstID() << " <-- Var" << getSrcID() << "]\t";
    return rawstr.str();
}

Friends And Related Symbol Documentation

◆ GraphDBClient

friend class GraphDBClient

friend

Definition at line 57 of file SVFStatements.h.

◆ operator<<

OutStream & operator<<	(	OutStream &	o,
		const SVFStmt &	edge
	)

friend

Overloading operator << for dumping SVFVar value.

Definition at line 255 of file SVFStatements.h.

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

Member Data Documentation

◆ basicBlock

const SVFBasicBlock* SVF::SVFStmt::basicBlock

private

LLVM BasicBlock.

Definition at line 85 of file SVFStatements.h.

◆ callEdgeLabelCounter

u64_t SVFStmt::callEdgeLabelCounter = 0

staticprivate

Call site Instruction counter.

Definition at line 272 of file SVFStatements.h.

◆ edgeId

EdgeID SVF::SVFStmt::edgeId

private

Edge ID.

Definition at line 87 of file SVFStatements.h.

◆ icfgNode

ICFGNode* SVF::SVFStmt::icfgNode

private

ICFGNode.

Definition at line 86 of file SVFStatements.h.

◆ inst2LabelMap

SVFStmt::Inst2LabelMap SVFStmt::inst2LabelMap

staticprivate

Call site Instruction to label map.

Definition at line 270 of file SVFStatements.h.

◆ multiOpndLabelCounter

u64_t SVFStmt::multiOpndLabelCounter = 0

staticprivate

MultiOpndStmt counter.

Definition at line 274 of file SVFStatements.h.

◆ storeEdgeLabelCounter

u64_t SVFStmt::storeEdgeLabelCounter = 0

staticprivate

Store Instruction counter.

Definition at line 273 of file SVFStatements.h.

◆ value

const SVFVar* SVF::SVFStmt::value

private

LLVM value.

Definition at line 84 of file SVFStatements.h.

◆ var2LabelMap

SVFStmt::Var2LabelMap SVFStmt::var2LabelMap

staticprivate

Second operand of MultiOpndStmt to label map.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Private Types

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Inst2LabelMap

◆ KindToSVFStmtMapTy

◆ PAGEdgeSetTy

◆ PAGEdgeToSetMapTy

◆ SVFStmtSetTy

◆ Var2LabelMap

Member Enumeration Documentation

◆ PEDGEK

Constructor & Destructor Documentation

◆ SVFStmt() [1/3]

◆ SVFStmt() [2/3]

◆ SVFStmt() [3/3]

◆ ~SVFStmt()

Member Function Documentation

◆ addInst2Labeled()

◆ addVar2Labeled()

◆ classof() [1/2]

◆ classof() [2/2]

◆ getBB()

◆ getCallEdgeLabelCounter()

◆ getEdgeID()

◆ getICFGNode()

◆ getInst2LabelMap()

◆ getMultiOpndLabelCounter()

◆ getStoreEdgeLabelCounter()

◆ getValue()

◆ getVar2LabelMap()

◆ isPTAEdge()

◆ makeEdgeFlagWithAddionalOpnd()

◆ makeEdgeFlagWithCallInst()

◆ makeEdgeFlagWithStoreInst()

◆ setBasicBlock()

◆ setBB()

◆ setCallEdgeLabelCounter()

◆ setICFGNode()

◆ setMultiOpndLabelCounter()

◆ setStoreEdgeLabelCounter()

◆ setValue()

◆ toString()

Friends And Related Symbol Documentation

◆ GraphDBClient

◆ operator<<

Member Data Documentation

◆ basicBlock

◆ callEdgeLabelCounter

◆ edgeId

◆ icfgNode

◆ inst2LabelMap

◆ multiOpndLabelCounter

◆ storeEdgeLabelCounter

◆ value

◆ var2LabelMap