Static Value-Flow Analysis
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
SVF::GepStmt Class Reference

#include <SVFStatements.h>

Inheritance diagram for SVF::GepStmt:
SVF::AssignStmt SVF::SVFStmt SVF::GenericEdge< NodeTy >

Public Member Functions

const AccessPathgetAccessPath () 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
SVFVargetRHSVar () const
 
SVFVargetLHSVar () 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.
 
void setValue (const SVFVar *val)
 Get/set methods for llvm instruction.
 
const SVFVargetValue () const
 
void setBB (const SVFBasicBlock *bb)
 
const SVFBasicBlockgetBB () const
 
void setICFGNode (ICFGNode *node)
 
ICFGNodegetICFGNode () 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
 
NodeTypegetSrcNode () const
 
NodeTypegetDstNode () 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 (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)
 

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, SVFStmtSetTyPAGEdgeToSetMapTy
 
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
 
- 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 502 of file SVFStatements.h.

Constructor & Destructor Documentation

◆ GepStmt() [1/2]

SVF::GepStmt::GepStmt ( const GepStmt )
private

place holder

◆ GepStmt() [2/2]

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

constructor

Definition at line 570 of file SVFStatements.h.

572 {
573 }
AssignStmt()
place holder
AccessPath ap
Access path of the GEP edge.
bool variantField
Gep statement with a variant field index (pointer arithmetic) for struct field access (e....
llvm::IRBuilder IRBuilder
Definition BasicTypes.h:74

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 547 of file SVFStatements.h.

548 {
550 }
APOffset computeConstantByteOffset() const
const AccessPath & getAccessPath() const

◆ 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 553 of file SVFStatements.h.

554 {
556 }
APOffset computeConstantOffset() const
For example,.

◆ classof() [1/3]

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

Definition at line 522 of file SVFStatements.h.

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

◆ 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 514 of file SVFStatements.h.

515 {
516 return true;
517 }

◆ classof() [3/3]

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

Definition at line 518 of file SVFStatements.h.

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

◆ getAccessPath()

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

Definition at line 528 of file SVFStatements.h.

529 {
530 return ap;
531 }

◆ getConstantStructFldIdx()

APOffset SVF::GepStmt::getConstantStructFldIdx ( ) const
inline

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

Definition at line 558 of file SVFStatements.h.

559 {
560 assert(isVariantFieldGep()==false && "Can't retrieve the AccessPath if using a variable field index (pointer arithmetic) for struct field access ");
562 }
APOffset getConstantStructFldIdx() const
Get methods.
Definition AccessPath.h:97
bool isVariantFieldGep() const
Gep statement with a variant field index (pointer arithmetic) for struct field access.

◆ getOffsetVarAndGepTypePairVec()

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

Definition at line 532 of file SVFStatements.h.

533 {
535 }
const IdxOperandPairs & getIdxOperandPairVec() const
Definition AccessPath.h:105

◆ isConstantOffset()

bool SVF::GepStmt::isConstantOffset ( ) const
inline

Return TRUE if this is a constant location set.

Definition at line 537 of file SVFStatements.h.

538 {
540 }
bool isConstantOffset() const
Return TRUE if this is a constant location set.

◆ isVariantFieldGep()

bool SVF::GepStmt::isVariantFieldGep ( ) const
inline

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

Definition at line 564 of file SVFStatements.h.

565 {
566 return variantField;
567 }

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

219{
220 std::string str;
221 std::stringstream rawstr(str);
222 rawstr << "GepStmt: [Var" << getLHSVarID() << " <-- Var" << getRHSVarID() << "]\t";
224 {
225 rawstr << "\n";
226 rawstr << getValue()->toString();
227 }
228 return rawstr.str();
229}
NodeID getRHSVarID() const
NodeID getLHSVarID() const
static const Option< bool > ShowSVFIRValue
Definition Options.h:119
const SVFVar * getValue() const
virtual const std::string toString() const
Get string representation.

Member Data Documentation

◆ ap

AccessPath SVF::GepStmt::ap
private

Access path of the GEP edge.

Definition at line 509 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 510 of file SVFStatements.h.


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