SVF::GepStmt Class Reference

#include <SVFStatements.h>

Inheritance diagram for SVF::GepStmt:

Public Member Functions
const AccessPath &	getAccessPath () const
const AccessPath::IdxOperandPairs	getOffsetVarAndGepTypePairVec () const
bool	isConstantOffset () const
	Return TRUE if this is a constant location set.
APOffset	accumulateConstantByteOffset () const
APOffset	accumulateConstantOffset () const
	Return accumulated constant offset (when accessing array or struct) if this offset is a constant.
APOffset	getConstantStructFldIdx () const
	Field index of the gep statement if it access the field of a struct.
bool	isVariantFieldGep () const
	Gep statement with a variant field index (pointer arithmetic) for struct field access.
	GepStmt (SVFVar *s, SVFVar *d, const AccessPath &ap, bool varfld=false)
	constructor
virtual const std::string	toString () const
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 GepStmt *)
	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)

Private Member Functions
	GepStmt ()
	Constructs empty GepStmt (for SVFIRReader/serialization)
	GepStmt (const GepStmt &)
	place holder
void	operator= (const GepStmt &)
	place holder

Private Attributes
AccessPath	ap
	Access path of the GEP edge.
bool	variantField
	Gep statement with a variant field index (pointer arithmetic) for struct field access (e.g., p = &(q + f), where f is a variable)

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.
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.
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

Gep statement for struct field access, array access and pointer arithmetic

Definition at line 526 of file SVFStatements.h.

Constructor & Destructor Documentation

GepStmt() [1/3]

SVF::GepStmt::GepStmt ( )

inlineprivate

Constructs empty GepStmt (for SVFIRReader/serialization)

Definition at line 533 of file SVFStatements.h.

: AssignStmt(SVFStmt::Gep) {}

GepStmt() [2/3]

SVF::GepStmt::GepStmt ( const GepStmt &  )

private

place holder

GepStmt() [3/3]

SVF::GepStmt::GepStmt ( SVFVar *  s, SVFVar *  d, const AccessPath &  ap, bool  varfld = false  )

inline

constructor

Definition at line 598 of file SVFStatements.h.

        : AssignStmt(s, d, SVFStmt::Gep), ap(ap), variantField(varfld)
    {
    }

Member Function Documentation

accumulateConstantByteOffset()

APOffset SVF::GepStmt::accumulateConstantByteOffset ( ) const

inline

Return accumulated constant offset (when accessing array or struct) if this offset is a constant. elemBytesize is the element byte size of an static alloc or heap alloc array e.g. GepStmt* gep = **, s32_t elemBytesize = LLVMUtil::SVFType2ByteSize(gep->getRHSVar()->getValue()->getType()); APOffset byteOffset = gep->accumulateConstantByteOffset(elemBytesize);

Definition at line 575 of file SVFStatements.h.

    {
        return getAccessPath().computeConstantByteOffset();
    }

accumulateConstantOffset()

APOffset SVF::GepStmt::accumulateConstantOffset ( ) const

inline

Return accumulated constant offset (when accessing array or struct) if this offset is a constant.

Definition at line 581 of file SVFStatements.h.

    {
        return getAccessPath().computeConstantOffset();
    }

classof() [1/3]

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

inlinestatic

Definition at line 550 of file SVFStatements.h.

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

classof() [2/3]

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

inlinestatic

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

Definition at line 542 of file SVFStatements.h.

    {
        return true;
    }

classof() [3/3]

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

inlinestatic

Definition at line 546 of file SVFStatements.h.

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

getAccessPath()

const AccessPath & SVF::GepStmt::getAccessPath ( ) const

inline

Definition at line 556 of file SVFStatements.h.

    {
        return ap;
    }

getConstantStructFldIdx()

APOffset SVF::GepStmt::getConstantStructFldIdx ( ) const

inline

Field index of the gep statement if it access the field of a struct.

Definition at line 586 of file SVFStatements.h.

    {
        assert(isVariantFieldGep()==false && "Can't retrieve the AccessPath if using a variable field index (pointer arithmetic) for struct field access ");
        return getAccessPath().getConstantStructFldIdx();
    }

getOffsetVarAndGepTypePairVec()

const AccessPath::IdxOperandPairs SVF::GepStmt::getOffsetVarAndGepTypePairVec ( ) const

inline

Definition at line 560 of file SVFStatements.h.

    {
        return getAccessPath().getIdxOperandPairVec();
    }

isConstantOffset()

bool SVF::GepStmt::isConstantOffset ( ) const

inline

Return TRUE if this is a constant location set.

Definition at line 565 of file SVFStatements.h.

    {
        return getAccessPath().isConstantOffset();
    }

isVariantFieldGep()

bool SVF::GepStmt::isVariantFieldGep ( ) const

inline

Gep statement with a variant field index (pointer arithmetic) for struct field access.

Definition at line 592 of file SVFStatements.h.

    {
        return variantField;
    }

operator=()

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

private

place holder

toString()

const std::string GepStmt::toString ( ) const

virtual

Implements SVF::AssignStmt.

Definition at line 218 of file SVFStatements.cpp.

{
    std::string str;
    std::stringstream rawstr(str);
    rawstr << "GepStmt: [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 529 of file SVFStatements.h.

SVFIRWriter

friend class SVFIRWriter

friend

Definition at line 528 of file SVFStatements.h.

Member Data Documentation

ap

AccessPath SVF::GepStmt::ap

private

Access path of the GEP edge.

Definition at line 537 of file SVFStatements.h.

variantField

bool SVF::GepStmt::variantField

private

Gep statement with a variant field index (pointer arithmetic) for struct field access (e.g., p = &(q + f), where f is a variable)

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