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

#include <SVFVariables.h>

Inheritance diagram for SVF::GlobalObjVar:
SVF::BaseObjVar SVF::ObjVar SVF::SVFVar SVF::GenericNode< NodeTy, EdgeTy > SVF::SVFValue

Public Member Functions

 GlobalObjVar (NodeID i, ObjTypeInfo *ti, const SVFType *svfType, const ICFGNode *node, PNODEK ty=GlobalObjNode)
 Constructor.
 
virtual const std::string toString () const
 Get string representation.
 
- Public Member Functions inherited from SVF::BaseObjVar
 BaseObjVar (NodeID i, ObjTypeInfo *ti, const SVFType *svfType, const ICFGNode *node, PNODEK ty=BaseObjNode)
 Constructor.
 
virtual const BaseObjVargetBaseMemObj () const
 
const ICFGNodegetICFGNode () const
 Get the ICFGNode related to the creation of this object.
 
const std::string getValueName () const
 Return name of a LLVM value.
 
NodeID getId () const
 Get the memory object id.
 
const SVFTypegetType () const
 Get obj type.
 
u32_t getNumOfElements () const
 Get the number of elements of this object.
 
void setNumOfElements (u32_t num)
 Set the number of elements of this object.
 
u32_t getMaxFieldOffsetLimit () const
 Get max field offset limit.
 
bool isFieldInsensitive () const
 Return true if its field limit is 0.
 
void setFieldInsensitive ()
 Set the memory object to be field insensitive.
 
void setFieldSensitive ()
 Set the memory object to be field sensitive (up to max field limit)
 
bool isBlackHoleObj () const
 Whether it is a black hole object.
 
u32_t getByteSizeOfObj () const
 Get the byte size of this object.
 
bool isConstantByteSize () const
 Check if byte size is a const value.
 
bool isFunction () const
 object attributes methods
 
bool isGlobalObj () const
 
bool isStaticObj () const
 
bool isStack () const
 
bool isHeap () const
 
bool isStruct () const
 
bool isArray () const
 
bool isVarStruct () const
 
bool isVarArray () const
 
bool isConstantStruct () const
 
bool isConstantArray () const
 
bool isConstDataOrConstGlobal () const
 
virtual bool isConstDataOrAggData () const
 Check if this variable represents constant/aggregate data.
 
void destroy ()
 Clean up memory.
 
virtual const FunObjVargetFunction () const
 Get containing function, or null for globals/constants.
 
- Public Member Functions inherited from SVF::SVFVar
 SVFVar (NodeID i, const SVFType *svfType, PNODEK k)
 Standard constructor with ID, type and kind.
 
virtual ~SVFVar ()
 Virtual destructor.
 
virtual bool isPointer () const
 Check if this variable represents a pointer.
 
virtual bool isConstDataOrAggDataButNotNullPtr () const
 Check if this variable represents constant data/metadata but not null pointer.
 
virtual bool isIsolatedNode () const
 Check if this node is isolated (no edges) in the SVFIR graph.
 
SVFStmt::SVFStmtSetTygetIncomingEdges (SVFStmt::PEDGEK kind)
 Edge accessors and checkers.
 
SVFStmt::SVFStmtSetTygetOutgoingEdges (SVFStmt::PEDGEK kind)
 
bool hasIncomingEdges (SVFStmt::PEDGEK kind) const
 
bool hasOutgoingEdges (SVFStmt::PEDGEK kind) const
 
SVFStmt::SVFStmtSetTy::iterator getIncomingEdgesBegin (SVFStmt::PEDGEK kind) const
 Edge iterators.
 
SVFStmt::SVFStmtSetTy::iterator getIncomingEdgesEnd (SVFStmt::PEDGEK kind) const
 
SVFStmt::SVFStmtSetTy::iterator getOutgoingEdgesBegin (SVFStmt::PEDGEK kind) const
 
SVFStmt::SVFStmtSetTy::iterator getOutgoingEdgesEnd (SVFStmt::PEDGEK kind) const
 
virtual bool ptrInUncalledFunction () const
 Check if this pointer is in an uncalled function.
 
void dump () const
 Debug dump to console.
 
- Public Member Functions inherited from SVF::GenericNode< NodeTy, EdgeTy >
 GenericNode (NodeID i, GNodeK k, const SVFType *svfType=nullptr)
 Constructor.
 
virtual ~GenericNode ()
 Destructor.
 
bool hasIncomingEdge () const
 Has incoming/outgoing edge set.
 
bool hasOutgoingEdge () const
 
iterator OutEdgeBegin ()
 iterators
 
iterator OutEdgeEnd ()
 
iterator InEdgeBegin ()
 
iterator InEdgeEnd ()
 
const_iterator OutEdgeBegin () const
 
const_iterator OutEdgeEnd () const
 
const_iterator InEdgeBegin () const
 
const_iterator InEdgeEnd () const
 
virtual iterator directOutEdgeBegin ()
 Iterators used for SCC detection, overwrite it in child class if necessary.
 
virtual iterator directOutEdgeEnd ()
 
virtual iterator directInEdgeBegin ()
 
virtual iterator directInEdgeEnd ()
 
virtual const_iterator directOutEdgeBegin () const
 
virtual const_iterator directOutEdgeEnd () const
 
virtual const_iterator directInEdgeBegin () const
 
virtual const_iterator directInEdgeEnd () const
 
bool addIncomingEdge (EdgeType *inEdge)
 Add incoming and outgoing edges.
 
bool addOutgoingEdge (EdgeType *outEdge)
 
EdgeTypehasIncomingEdge (EdgeType *edge) const
 Find incoming and outgoing edges.
 
EdgeTypehasOutgoingEdge (EdgeType *edge) const
 
const GEdgeSetTygetOutEdges () const
 
const GEdgeSetTygetInEdges () const
 
u32_t removeIncomingEdge (EdgeType *edge)
 
u32_t removeOutgoingEdge (EdgeType *edge)
 
- Public Member Functions inherited from SVF::SVFValue
 SVFValue (NodeID i, GNodeK k, const SVFType *ty=nullptr)
 
NodeID getId () const
 Get ID.
 
GNodeK getNodeKind () const
 Get node kind.
 
virtual void setName (const std::string &nameInfo)
 
virtual void setName (std::string &&nameInfo)
 
virtual const std::string & getName () const
 
virtual void setSourceLoc (const std::string &sourceCodeInfo)
 
virtual const std::string getSourceLoc () const
 
const std::string valueOnlyToString () const
 

Static Public Member Functions

static bool classof (const GlobalObjVar *)
 Methods for support type inquiry through isa, cast, and dyn_cast:
 
static bool classof (const BaseObjVar *node)
 
static bool classof (const ObjVar *node)
 
static bool classof (const SVFVar *node)
 
static bool classof (const GenericPAGNodeTy *node)
 
static bool classof (const SVFValue *node)
 
- Static Public Member Functions inherited from SVF::BaseObjVar
static bool classof (const BaseObjVar *)
 Methods for support type inquiry through isa, cast, and dyn_cast:
 
static bool classof (const ObjVar *node)
 
static bool classof (const SVFVar *node)
 
static bool classof (const GenericPAGNodeTy *node)
 
static bool classof (const SVFValue *node)
 
- Static Public Member Functions inherited from SVF::ObjVar
static bool classof (const ObjVar *)
 Methods for support type inquiry through isa, cast, and dyn_cast:
 
static bool classof (const SVFVar *node)
 
static bool classof (const GenericPAGNodeTy *node)
 
static bool classof (const SVFValue *node)
 
- Static Public Member Functions inherited from SVF::SVFVar
static bool classof (const SVFVar *)
 Type checking support for LLVM-style RTTI.
 
static bool classof (const GenericPAGNodeTy *node)
 
static bool classof (const SVFValue *node)
 
- Static Public Member Functions inherited from SVF::GenericNode< NodeTy, EdgeTy >
static bool classof (const GenericNode< NodeTy, EdgeTy > *)
 
static bool classof (const SVFValue *)
 

Private Member Functions

 GlobalObjVar (NodeID i, const ICFGNode *node)
 Constructor to create empty ObjVar (for SVFIRReader/deserialization)
 

Friends

class SVFIRWriter
 
class SVFIRReader
 

Additional Inherited Members

- Public Types inherited from SVF::SVFVar
typedef GNodeK PNODEK
 
typedef s64_t GEdgeKind
 
- Public Types inherited from SVF::GenericNode< NodeTy, EdgeTy >
typedef NodeTy NodeType
 
typedef EdgeTy EdgeType
 
typedef OrderedSet< EdgeType *, typename EdgeType::equalGEdge > GEdgeSetTy
 Edge kind.
 
typedef GEdgeSetTy::iterator iterator
 
typedef GEdgeSetTy::const_iterator const_iterator
 
- Public Types inherited from SVF::SVFValue
enum  GNodeK {
  IntraBlock , GlobalBlock , FunEntryBlock , FunExitBlock ,
  FunCallBlock , FunRetBlock , ValNode , ArgValNode ,
  FunValNode , GepValNode , RetValNode , VarargValNode ,
  GlobalValNode , ConstAggValNode , ConstDataValNode , BlackHoleValNode ,
  ConstFPValNode , ConstIntValNode , ConstNullptrValNode , DummyValNode ,
  ObjNode , GepObjNode , BaseObjNode , FunObjNode ,
  HeapObjNode , StackObjNode , GlobalObjNode , ConstAggObjNode ,
  ConstDataObjNode , ConstFPObjNode , ConstIntObjNode , ConstNullptrObjNode ,
  DummyObjNode , Cmp , BinaryOp , UnaryOp ,
  Branch , DummyVProp , NPtr , FRet ,
  ARet , AParm , FParm , Addr ,
  Copy , Gep , Store , Load ,
  TPhi , TIntraPhi , TInterPhi , FPIN ,
  FPOUT , APIN , APOUT , MPhi ,
  MIntraPhi , MInterPhi , CallNodeKd , CDNodeKd ,
  CFLNodeKd , CHNodeKd , ConstraintNodeKd , TCTNodeKd ,
  DCHNodeKd , BasicBlockKd , OtherKd
}
 
- Protected Member Functions inherited from SVF::BaseObjVar
 BaseObjVar (NodeID i, const ICFGNode *node, PNODEK ty=BaseObjNode)
 ICFGNode related to the creation of this object.
 
- Protected Member Functions inherited from SVF::ObjVar
 ObjVar (NodeID i, PNODEK ty=ObjNode)
 Constructor to create an empty ObjVar (for SVFIRReader/deserialization)
 
 ObjVar (NodeID i, const SVFType *svfType, PNODEK ty=ObjNode)
 Constructor.
 
- Protected Member Functions inherited from SVF::SVFVar
 SVFVar (NodeID i, PNODEK k)
 Empty constructor for deserialization.
 
- Static Protected Member Functions inherited from SVF::SVFValue
static bool isICFGNodeKinds (GNodeK n)
 Helper functions to check node kinds.
 
static bool isInterICFGNodeKind (GNodeK n)
 
static bool isSVFVarKind (GNodeK n)
 
static bool isValVarKinds (GNodeK n)
 
static bool isConstantDataValVar (GNodeK n)
 
static bool isObjVarKinds (GNodeK n)
 
static bool isBaseObjVarKinds (GNodeK n)
 
static bool isConstantDataObjVarKinds (GNodeK n)
 
static bool isVFGNodeKinds (GNodeK n)
 
static bool isArgumentVFGNodeKinds (GNodeK n)
 
static bool isStmtVFGNodeKinds (GNodeK n)
 
static bool isPHIVFGNodeKinds (GNodeK n)
 
static bool isMRSVFGNodeKinds (GNodeK n)
 
static bool isMSSAPHISVFGNodeKinds (GNodeK n)
 
- Protected Attributes inherited from SVF::SVFVar
SVFStmt::KindToSVFStmtMapTy InEdgeKindToSetMap
 Maps tracking incoming and outgoing edges by kind.
 
SVFStmt::KindToSVFStmtMapTy OutEdgeKindToSetMap
 
- Protected Attributes inherited from SVF::SVFValue
NodeID id
 Node ID.
 
GNodeK nodeKind
 Node kind.
 
const SVFTypetype
 SVF type.
 
std::string name
 
std::string sourceLoc
 Source code information of this value.
 

Detailed Description

Definition at line 1634 of file SVFVariables.h.

Constructor & Destructor Documentation

◆ GlobalObjVar() [1/2]

SVF::GlobalObjVar::GlobalObjVar ( NodeID  i,
const ICFGNode node 
)
inlineprivate

Constructor to create empty ObjVar (for SVFIRReader/deserialization)

Definition at line 1641 of file SVFVariables.h.

1641: BaseObjVar(i, node, GlobalObjNode) {}
BaseObjVar(NodeID i, const ICFGNode *node, PNODEK ty=BaseObjNode)
ICFGNode related to the creation of this object.
llvm::IRBuilder IRBuilder
Definition BasicTypes.h:74

◆ GlobalObjVar() [2/2]

SVF::GlobalObjVar::GlobalObjVar ( NodeID  i,
ObjTypeInfo ti,
const SVFType svfType,
const ICFGNode node,
PNODEK  ty = GlobalObjNode 
)
inline

Constructor.

Definition at line 1673 of file SVFVariables.h.

1674 : BaseObjVar(i, ti, svfType, node, ty)
1675 {
1676
1677 }

Member Function Documentation

◆ classof() [1/6]

static bool SVF::GlobalObjVar::classof ( const BaseObjVar node)
inlinestatic

Definition at line 1650 of file SVFVariables.h.

1651 {
1652 return node->getNodeKind() == GlobalObjNode;
1653 }

◆ classof() [2/6]

static bool SVF::GlobalObjVar::classof ( const GenericPAGNodeTy node)
inlinestatic

Definition at line 1662 of file SVFVariables.h.

1663 {
1664 return node->getNodeKind() == GlobalObjNode;
1665 }

◆ classof() [3/6]

static bool SVF::GlobalObjVar::classof ( const GlobalObjVar )
inlinestatic

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

Definition at line 1646 of file SVFVariables.h.

1647 {
1648 return true;
1649 }

◆ classof() [4/6]

static bool SVF::GlobalObjVar::classof ( const ObjVar node)
inlinestatic

Definition at line 1654 of file SVFVariables.h.

1655 {
1656 return node->getNodeKind() == GlobalObjNode;
1657 }

◆ classof() [5/6]

static bool SVF::GlobalObjVar::classof ( const SVFValue node)
inlinestatic

Definition at line 1666 of file SVFVariables.h.

1667 {
1668 return node->getNodeKind() == GlobalObjNode;
1669 }

◆ classof() [6/6]

static bool SVF::GlobalObjVar::classof ( const SVFVar node)
inlinestatic

Definition at line 1658 of file SVFVariables.h.

1659 {
1660 return node->getNodeKind() == GlobalObjNode;
1661 }

◆ toString()

const std::string GlobalObjVar::toString ( ) const
virtual

Get string representation.

Reimplemented from SVF::BaseObjVar.

Definition at line 365 of file SVFVariables.cpp.

366{
367 std::string str;
368 std::stringstream rawstr(str);
369 rawstr << "GlobalObjVar ID: " << getId();
371 {
372 rawstr << "\n";
374 }
375 return rawstr.str();
376}
NodeID getId() const
Get the memory object id.
static const Option< bool > ShowSVFIRValue
Definition Options.h:122
const std::string valueOnlyToString() const
Definition LLVMUtil.cpp:735

Friends And Related Symbol Documentation

◆ SVFIRReader

friend class SVFIRReader
friend

Definition at line 1637 of file SVFVariables.h.

◆ SVFIRWriter

friend class SVFIRWriter
friend

Definition at line 1636 of file SVFVariables.h.


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