Static Value-Flow Analysis
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Friends | 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 AccessPath & getAccessPath () const
 
const AccessPath::IdxOperandPairs getOffsetVarAndGepTypePairVec () const
 
bool isConstantOffset () const
 Return TRUE if this is a constant location set. More...
 
APOffset accumulateConstantByteOffset () const
 
APOffset accumulateConstantOffset () const
 Return accumulated constant offset (when accessing array or struct) if this offset is a constant. More...
 
APOffset getConstantStructFldIdx () const
 Field index of the gep statement if it access the field of a struct. More...
 
bool isVariantFieldGep () const
 Gep statement with a variant field index (pointer arithmetic) for struct field access. More...
 
 GepStmt (SVFVar *s, SVFVar *d, const AccessPath &ap, bool varfld=false)
 constructor More...
 
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. More...
 
 ~SVFStmt ()
 Destructor. More...
 
EdgeID getEdgeID () const
 Return Edge ID. More...
 
bool isPTAEdge () const
 Whether src and dst nodes are both of pointer type. More...
 
const SVFInstruction * getInst () const
 Get/set methods for llvm instruction. More...
 
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. More...
 
virtual ~GenericEdge ()
 Destructor. More...
 
NodeID getSrcID () const
 get methods of the components More...
 
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: More...
 
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: More...
 
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. More...
 
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) More...
 
 GepStmt (const GepStmt &)
 place holder More...
 
void operator= (const GepStmt &)
 place holder More...
 

Private Attributes

AccessPath ap
 Access path of the GEP edge. More...
 
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) More...
 

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. More...
 
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) More...
 
- Static Public Attributes inherited from SVF::SVFStmt
static u32_t totalEdgeNum
 Total edge number. More...
 
- Protected Member Functions inherited from SVF::AssignStmt
 AssignStmt (SVFVar *s, SVFVar *d, GEdgeFlag k)
 constructor More...
 
 AssignStmt (GEdgeFlag k)
 Constructor to create empty AssignStmt (for SVFIRReader/serialization) More...
 
- Protected Member Functions inherited from SVF::SVFStmt
 SVFStmt (GEdgeFlag k)
 Private constructor for reading SVFIR from file without side-effect. More...
 
- Static Protected Attributes inherited from SVF::GenericEdge< NodeTy >
static constexpr unsigned char EdgeKindMaskBits = 8
 We use the lower 8 bits to denote edge kind. More...
 
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.

533 : AssignStmt(SVFStmt::Gep) {}
SVF::AssignStmt::AssignStmt
AssignStmt()
place holder

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

599  : AssignStmt(s, d, SVFStmt::Gep), ap(ap), variantField(varfld)
600  {
601  }
SVF::GepStmt::ap
AccessPath ap
Access path of the GEP edge.
Definition: SVFStatements.h:537
SVF::GepStmt::variantField
bool variantField
Gep statement with a variant field index (pointer arithmetic) for struct field access (e....
Definition: SVFStatements.h:538

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.

576  {
577  return getAccessPath().computeConstantByteOffset();
578  }
SVF::AccessPath::computeConstantByteOffset
APOffset computeConstantByteOffset() const
Definition: AccessPath.cpp:125
SVF::GepStmt::getAccessPath
const AccessPath & getAccessPath() const
Definition: SVFStatements.h:556

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

582  {
583  return getAccessPath().computeConstantOffset();
584  }
SVF::AccessPath::computeConstantOffset
APOffset computeConstantOffset() const
For example,.
Definition: AccessPath.cpp:213

◆ classof() [1/3]

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

Definition at line 550 of file SVFStatements.h.

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

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

543  {
544  return true;
545  }

◆ classof() [3/3]

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

Definition at line 546 of file SVFStatements.h.

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

◆ getAccessPath()

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

Definition at line 556 of file SVFStatements.h.

557  {
558  return ap;
559  }

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

587  {
588  assert(isVariantFieldGep()==false && "Can't retrieve the AccessPath if using a variable field index (pointer arithmetic) for struct field access ");
589  return getAccessPath().getConstantStructFldIdx();
590  }
SVF::AccessPath::getConstantStructFldIdx
APOffset getConstantStructFldIdx() const
Get methods.
Definition: AccessPath.h:100
SVF::GepStmt::isVariantFieldGep
bool isVariantFieldGep() const
Gep statement with a variant field index (pointer arithmetic) for struct field access.
Definition: SVFStatements.h:592

◆ getOffsetVarAndGepTypePairVec()

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

Definition at line 560 of file SVFStatements.h.

561  {
562  return getAccessPath().getIdxOperandPairVec();
563  }
SVF::AccessPath::getIdxOperandPairVec
const IdxOperandPairs & getIdxOperandPairVec() const
Definition: AccessPath.h:108

◆ isConstantOffset()

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

Return TRUE if this is a constant location set.

Definition at line 565 of file SVFStatements.h.

566  {
567  return getAccessPath().isConstantOffset();
568  }
SVF::AccessPath::isConstantOffset
bool isConstantOffset() const
Return TRUE if this is a constant location set.
Definition: AccessPath.cpp:49

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

593  {
594  return variantField;
595  }

◆ 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";
223  if (Options::ShowSVFIRValue())
224  {
225  rawstr << "\n";
226  rawstr << getValue()->toString();
227  }
228  return rawstr.str();
229 }
string
const char *const string
Definition: cJSON.h:172
SVF::AssignStmt::getRHSVarID
NodeID getRHSVarID() const
Definition: SVFStatements.h:298
SVF::AssignStmt::getLHSVarID
NodeID getLHSVarID() const
Definition: SVFStatements.h:302
SVF::Options::ShowSVFIRValue
static const Option< bool > ShowSVFIRValue
Definition: Options.h:122
SVF::SVFStmt::getValue
const SVFValue * getValue() const
Definition: SVFStatements.h:147
SVF::SVFValue::toString
std::string toString() const
Needs to be implemented by a SVF front end.
Definition: LLVMUtil.cpp:663

Friends And Related Function 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:
Generated by doxygen 1.9.1