#include <SVFStatements.h>

Inheritance diagram for SVF::PhiStmt:

Public Types
typedef std::vector< const ICFGNode * >	OpICFGNodeVec

Public Types inherited from SVF::MultiOpndStmt
typedef std::vector< SVFVar * >	OPVars

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
	PhiStmt (SVFVar *s, const OPVars &opnds, const OpICFGNodeVec &icfgNodes)
	constructor

void	addOpVar (SVFVar op, const ICFGNode inode)

const ICFGNode *	getOpICFGNode (u32_t op_idx) const
	Return the corresponding ICFGNode of this operand.

bool	isFunctionRetPhi () const

virtual const std::string	toString () const override

Public Member Functions inherited from SVF::MultiOpndStmt
const SVFVar *	getOpVar (u32_t pos) const
	Operand SVFVars.

const SVFVar *	getRes () const
	Result SVFVar.

NodeID	getOpVarID (u32_t pos) const

NodeID	getResID () const

u32_t	getOpVarNum () const

const OPVars &	getOpndVars () const

OPVars::const_iterator	opVarBegin () const

OPVars::const_iterator	opVerEnd () const

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.

const SVFInstruction *	getInst () const
	Get/set methods for llvm instruction.

void	setValue (const SVFValue *val)

const SVFValue *	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 PhiStmt *)
	Methods for support type inquiry through isa, cast, and dyn_cast:

static bool	classof (const SVFStmt *edge)

static bool	classof (const MultiOpndStmt *edge)

static bool	classof (const GenericPAGEdgeTy *edge)

Static Public Member Functions inherited from SVF::MultiOpndStmt
static bool	classof (const MultiOpndStmt *)
	Methods for support type inquiry through isa, cast, and dyn_cast:

static bool	classof (const SVFStmt *node)

static bool	classof (const GenericPAGEdgeTy *node)

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
	PhiStmt ()
	Constructs empty PhiStmt (for SVFIRReader/serialization)

	PhiStmt (const PhiStmt &)
	place holder

void	operator= (const PhiStmt &)
	place holder

Private Attributes
OpICFGNodeVec	opICFGNodes

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::MultiOpndStmt
	MultiOpndStmt (SVFVar *r, const OPVars &opnds, GEdgeFlag k)
	Constructor, only used by subclasses but not external users.

	MultiOpndStmt (GEdgeFlag k)
	Constructs empty MultiOpndStmt (for SVFIRReader/serialization)

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

Protected Attributes inherited from SVF::MultiOpndStmt
OPVars	opVars

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

Phi statement (e.g., p = phi(q,r) which receives values from variables q and r from different paths) it is typically at a joint point of the control-flow graph

Definition at line 814 of file SVFStatements.h.

Member Typedef Documentation

◆ OpICFGNodeVec

typedef std::vector<const ICFGNode*> SVF::PhiStmt::OpICFGNodeVec

Definition at line 820 of file SVFStatements.h.

Constructor & Destructor Documentation

◆ PhiStmt() [1/3]

SVF::PhiStmt::PhiStmt ( )

inlineprivate

Constructs empty PhiStmt (for SVFIRReader/serialization)

Definition at line 824 of file SVFStatements.h.

824: MultiOpndStmt(SVFStmt::Phi) {}

SVF::MultiOpndStmt::MultiOpndStmt

MultiOpndStmt()

place holder

SVF::SVFStmt::Phi

@ Phi

Definition SVFStatements.h:70

◆ PhiStmt() [2/3]

SVF::PhiStmt::PhiStmt ( const PhiStmt & )

private

place holder

◆ PhiStmt() [3/3]

SVF::PhiStmt::PhiStmt	(	SVFVar *	s,
		const OPVars &	opnds,
		const OpICFGNodeVec &	icfgNodes
	)

inline

constructor

Definition at line 852 of file SVFStatements.h.

        : MultiOpndStmt(s, opnds, SVFStmt::Phi), opICFGNodes(icfgNodes)
    {
        assert(opnds.size() == icfgNodes.size() &&
               "Numbers of operands and their ICFGNodes are not consistent?");
    }

Member Function Documentation

◆ addOpVar()

void SVF::PhiStmt::addOpVar	(	SVFVar *	op,
		const ICFGNode *	inode
	)

inline

Definition at line 858 of file SVFStatements.h.

    {
        opVars.push_back(op);
        opICFGNodes.push_back(inode);
        assert(opVars.size() == opICFGNodes.size() &&
               "Numbers of operands and their ICFGNodes are not consistent?");
    }

◆ classof() [1/4]

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

inlinestatic

Definition at line 845 of file SVFStatements.h.

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

◆ classof() [2/4]

static bool SVF::PhiStmt::classof ( const MultiOpndStmt * edge )

inlinestatic

Definition at line 841 of file SVFStatements.h.

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

◆ classof() [3/4]

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

inlinestatic

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

Definition at line 833 of file SVFStatements.h.

    {
        return true;
    }

◆ classof() [4/4]

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

inlinestatic

Definition at line 837 of file SVFStatements.h.

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

◆ getOpICFGNode()

const ICFGNode * SVF::PhiStmt::getOpICFGNode ( u32_t op_idx ) const

inline

Return the corresponding ICFGNode of this operand.

Definition at line 867 of file SVFStatements.h.

    {
        return opICFGNodes.at(op_idx);
    }

◆ isFunctionRetPhi()

bool PhiStmt::isFunctionRetPhi ( ) const

Return true if this is a phi at the function exit to receive one or multiple return values of this function

Definition at line 305 of file SVFStatements.cpp.

{
    return SVFUtil::isa<RetPN>(getRes());
}

◆ operator=()

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

private

place holder

◆ toString()

const std::string PhiStmt::toString ( ) const

overridevirtual

Reimplemented from SVF::SVFStmt.

Definition at line 100 of file SVFStatements.cpp.

{
    std::string str;
    std::stringstream rawstr(str);
    rawstr << "PhiStmt: [Var" << getResID() << " <-- (";
    for(u32_t i = 0; i < getOpVarNum(); i++)
        rawstr << "[Var" << getOpVar(i)->getId() << ", ICFGNode" << getOpICFGNode(i)->getId() <<  "],";
    rawstr << ")]\t";
    if (Options::ShowSVFIRValue())
    {
        rawstr << "\n";
        rawstr << getValue()->toString();
    }
    return rawstr.str();
}

Friends And Related Symbol Documentation

◆ SVFIRReader

friend class SVFIRReader

friend

Definition at line 817 of file SVFStatements.h.

◆ SVFIRWriter

friend class SVFIRWriter

friend

Definition at line 816 of file SVFStatements.h.

Member Data Documentation

◆ opICFGNodes

OpICFGNodeVec SVF::PhiStmt::opICFGNodes

private

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

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ OpICFGNodeVec

Constructor & Destructor Documentation

◆ PhiStmt() [1/3]

◆ PhiStmt() [2/3]

◆ PhiStmt() [3/3]

Member Function Documentation

◆ addOpVar()

◆ classof() [1/4]

◆ classof() [2/4]

◆ classof() [3/4]

◆ classof() [4/4]

◆ getOpICFGNode()

◆ isFunctionRetPhi()

◆ operator=()

◆ toString()

Friends And Related Symbol Documentation

◆ SVFIRReader

◆ SVFIRWriter

Member Data Documentation

◆ opICFGNodes