#include <SVFStatements.h>

Inheritance diagram for SVF::RetPE:

Public Member Functions
	RetPE (SVFVar s, SVFVar d, const CallICFGNode i, const FunExitICFGNode e, GEdgeKind k=SVFStmt::Ret)
	constructor

const CallICFGNode *	getCallInst () const
	Get method for call instruction at caller.

const CallICFGNode *	getCallSite () const

const FunExitICFGNode *	getFunExitICFGNode () const

virtual const std::string	toString () const override

Public Member Functions inherited from SVF::AssignStmt
SVFVar *	getRHSVar () const

SVFVar *	getLHSVar () const

NodeID	getRHSVarID () const

NodeID	getLHSVarID () 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 RetPE *)
	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::AssignStmt
static bool	classof (const AssignStmt *)
	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)

Protected Member Functions
	RetPE (GEdgeFlag k=SVFStmt::Ret)
	the function exit statement returned from

Protected Member Functions inherited from SVF::AssignStmt
	AssignStmt (SVFVar s, SVFVar d, GEdgeFlag k)
	constructor

	AssignStmt (GEdgeFlag k)
	Constructor to create empty AssignStmt (for SVFIRReader/serialization)

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

Private Member Functions
	RetPE (const RetPE &)
	place holder

void	operator= (const RetPE &)
	place holder

Private Attributes
const CallICFGNode *	call

const FunExitICFGNode *	exit
	the callsite statement returning to

Friends
class	SVFIRWriter

class	SVFIRReader

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

Static Public Attributes inherited from SVF::SVFStmt
static u32_t	totalEdgeNum
	Total edge number.

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

Return

Definition at line 671 of file SVFStatements.h.

Constructor & Destructor Documentation

◆ RetPE() [1/3]

SVF::RetPE::RetPE ( const RetPE & )

private

place holder

◆ RetPE() [2/3]

SVF::RetPE::RetPE ( GEdgeFlag k = SVFStmt::Ret )

inlineprotected

the function exit statement returned from

Constructs empty RetPE (for SVFIRReader/serialization)

Definition at line 685 of file SVFStatements.h.

685: AssignStmt(k), call{}, exit{} {}

SVF::AssignStmt::AssignStmt

AssignStmt()

place holder

SVF::RetPE::exit

const FunExitICFGNode * exit

the callsite statement returning to

Definition SVFStatements.h:681

SVF::RetPE::call

const CallICFGNode * call

Definition SVFStatements.h:680

SVF::IRBuilder

llvm::IRBuilder IRBuilder

Definition BasicTypes.h:74

◆ RetPE() [3/3]

RetPE::RetPE	(	SVFVar *	s,
		SVFVar *	d,
		const CallICFGNode *	i,
		const FunExitICFGNode *	e,
		GEdgeKind	k = `SVFStmt::Ret`
	)

constructor

Definition at line 339 of file SVFStatements.cpp.

    : AssignStmt(s, d, makeEdgeFlagWithCallInst(k, i)), call(i), exit(e)
{
}

Member Function Documentation

◆ classof() [1/3]

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

inlinestatic

Definition at line 699 of file SVFStatements.h.

    {
        return edge->getEdgeKind() == SVFStmt::Ret ||
               edge->getEdgeKind() == SVFStmt::ThreadJoin;
    }

◆ classof() [2/3]

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

inlinestatic

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

Definition at line 690 of file SVFStatements.h.

    {
        return true;
    }

◆ classof() [3/3]

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

inlinestatic

Definition at line 694 of file SVFStatements.h.

    {
        return edge->getEdgeKind() == SVFStmt::Ret ||
               edge->getEdgeKind() == SVFStmt::ThreadJoin;
    }

◆ getCallInst()

const CallICFGNode * SVF::RetPE::getCallInst ( ) const

inline

Get method for call instruction at caller.

Definition at line 712 of file SVFStatements.h.

    {
        return call;
    }

◆ getCallSite()

const CallICFGNode * SVF::RetPE::getCallSite ( ) const

inline

Definition at line 716 of file SVFStatements.h.

    {
        return call;
    }

◆ getFunExitICFGNode()

const FunExitICFGNode * SVF::RetPE::getFunExitICFGNode ( ) const

inline

Definition at line 720 of file SVFStatements.h.

    {
        return exit;
    }

◆ operator=()

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

private

place holder

◆ toString()

const std::string RetPE::toString ( ) const

overridevirtual

Implements SVF::AssignStmt.

Reimplemented in SVF::TDJoinPE.

Definition at line 244 of file SVFStatements.cpp.

{
    std::string str;
    std::stringstream rawstr(str);
    rawstr << "RetPE: [Var" << getLHSVarID() << " <-- Var" << getRHSVarID() << "]\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 674 of file SVFStatements.h.

◆ SVFIRWriter

friend class SVFIRWriter

friend

Definition at line 673 of file SVFStatements.h.

Member Data Documentation

◆ call

const CallICFGNode* SVF::RetPE::call

private

Definition at line 680 of file SVFStatements.h.

◆ exit

const FunExitICFGNode* SVF::RetPE::exit

private

the callsite statement returning to

Definition at line 681 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 Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RetPE() [1/3]

◆ RetPE() [2/3]

◆ RetPE() [3/3]

Member Function Documentation

◆ classof() [1/3]

◆ classof() [2/3]

◆ classof() [3/3]

◆ getCallInst()

◆ getCallSite()

◆ getFunExitICFGNode()

◆ operator=()

◆ toString()

Friends And Related Symbol Documentation

◆ SVFIRReader

◆ SVFIRWriter

Member Data Documentation

◆ call

◆ exit