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

#include <SVFValue.h>

Inheritance diagram for SVF::SVFValue:
SVF::GenericNode< DCHNode, DCHEdge > SVF::GenericNode< CFLNode, CFLEdge > SVF::GenericNode< ConstraintNode, ConstraintEdge > SVF::GenericNode< NodeTy, EdgeTy > SVF::DCHNode SVF::CFLNode SVF::ConstraintNode SVF::CDGNode SVF::CHNode SVF::CallGraphNode SVF::ICFGNode SVF::SVFBasicBlock SVF::SVFVar SVF::TCTNode SVF::VFGNode

Public Types

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
}
 

Public Member Functions

 SVFValue (NodeID i, GNodeK k, const SVFType *ty=nullptr)
 
NodeID getId () const
 Get ID.
 
GNodeK getNodeKind () const
 Get node kind.
 
virtual const SVFType * getType () const
 
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 Protected Member Functions

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

NodeID id
 Node ID.
 
GNodeK nodeKind
 Node kind.
 
const SVFType * type
 SVF type.
 
std::string name
 
std::string sourceLoc
 Source code information of this value.
 

Detailed Description

Definition at line 41 of file SVFValue.h.

Member Enumeration Documentation

◆ GNodeK

enum SVF::SVFValue::GNodeK
Enumerator
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 

Definition at line 46 of file SVFValue.h.

47 {
48 // ┌─────────────────────────────────────────────────────────────────────────┐
49 // │ ICFGNode: Classes of inter-procedural and intra-procedural control flow │
50 // │ graph nodes (Parent class: ICFGNode) │
51 // └─────────────────────────────────────────────────────────────────────────┘
52 IntraBlock, // ├── Represents a node within a single procedure
53 GlobalBlock, // ├── Represents a global-level block
54 // │ └─ Subclass: InterICFGNode
55 FunEntryBlock, // │ ├── Entry point of a function
56 FunExitBlock, // │ ├── Exit point of a function
57 FunCallBlock, // │ ├── Call site in the function
58 FunRetBlock, // │ └── Return site in the function
59
60 // ┌─────────────────────────────────────────────────────────────────────────┐
61 // │ SVFVar: Classes of variable nodes (Parent class: SVFVar) │
62 // │ Includes two main subclasses: ValVar and ObjVar │
63 // └─────────────────────────────────────────────────────────────────────────┘
64 // └─ Subclass: ValVar (Top-level variable nodes)
65 ValNode, // ├── Represents a standard value variable
66 ArgValNode, // ├── Represents an argument value variable
67 FunValNode, // ├── Represents a function value variable
68 GepValNode, // ├── Represents a GEP value variable
69 RetValNode, // ├── Represents a return value node
70 VarargValNode, // ├── Represents a variadic argument node
71 GlobalValNode, // ├── Represents a global variable node
72 ConstAggValNode, // ├── Represents a constant aggregate value node
73 // │ └─ Subclass: ConstDataValVar
74 ConstDataValNode, // │ ├── Represents a constant data variable
75 BlackHoleValNode, // │ ├── Represents a black hole node
76 ConstFPValNode, // │ ├── Represents a constant floating-point value node
77 ConstIntValNode, // │ ├── Represents a constant integer value node
78 ConstNullptrValNode, // │ └── Represents a constant nullptr value node
79 // │ └─ Subclass: DummyValVar
80 DummyValNode, // │ └── Dummy node for uninitialized values
81
82 // └─ Subclass: ObjVar (Object variable nodes)
83 ObjNode, // ├── Represents an object variable
84 // │ └─ Subclass: GepObjVar
85 GepObjNode, // │ ├── Represents a GEP object variable
86 // │ └─ Subclass: BaseObjVar
87 BaseObjNode, // │ ├── Represents a base object node
88 FunObjNode, // │ ├── Represents a function object
89 HeapObjNode, // │ ├── Represents a heap object
90 StackObjNode, // │ ├── Represents a stack object
91 GlobalObjNode, // │ ├── Represents a global object
92 ConstAggObjNode, // │ ├── Represents a constant aggregate object
93 // │ └─ Subclass: ConstDataObjVar
94 ConstDataObjNode, // │ ├── Represents a constant data object
95 ConstFPObjNode, // │ ├── Represents a constant floating-point object
96 ConstIntObjNode, // │ ├── Represents a constant integer object
97 ConstNullptrObjNode, // │ └── Represents a constant nullptr object
98 // │ └─ Subclass: DummyObjVar
99 DummyObjNode, // │ └── Dummy node for uninitialized objects
100
101 // ┌─────────────────────────────────────────────────────────────────────────┐
102 // │ VFGNode: Classes of Value Flow Graph (VFG) node kinds (Parent class: │
103 // │ VFGNode) │
104 // │ Includes operation nodes and specialized subclasses │
105 // └─────────────────────────────────────────────────────────────────────────┘
106 Cmp, // ├── Represents a comparison operation
107 BinaryOp, // ├── Represents a binary operation
108 UnaryOp, // ├── Represents a unary operation
109 Branch, // ├── Represents a branch operation
110 DummyVProp, // ├── Dummy node for value propagation
111 NPtr, // ├── Represents a null pointer operation
112 // │ └─ Subclass: ArgumentVFGNode
113 FRet, // │ ├── Represents a function return value
114 ARet, // │ ├── Represents an argument return value
115 AParm, // │ ├── Represents an argument parameter
116 FParm, // │ └── Represents a function parameter
117 // │ └─ Subclass: StmtVFGNode
118 Addr, // │ ├── Represents an address operation
119 Copy, // │ ├── Represents a copy operation
120 Gep, // │ ├── Represents a GEP operation
121 Store, // │ ├── Represents a store operation
122 Load, // │ └── Represents a load operation
123 // │ └─ Subclass: PHIVFGNode
124 TPhi, // │ ├── Represents a type-based PHI node
125 TIntraPhi, // │ ├── Represents an intra-procedural PHI node
126 TInterPhi, // │ └── Represents an inter-procedural PHI node
127 // │ └─ Subclass: MRSVFGNode
128 FPIN, // │ ├── Function parameter input
129 FPOUT, // │ ├── Function parameter output
130 APIN, // │ ├── Argument parameter input
131 APOUT, // │ └── Argument parameter output
132 // │ └─ Subclass: MSSAPHISVFGNode
133 MPhi, // │ ├── Memory PHI node
134 MIntraPhi, // │ ├── Intra-procedural memory PHI node
135 MInterPhi, // │ └── Inter-procedural memory PHI node
136
137 // ┌─────────────────────────────────────────────────────────────────────────┐
138 // │ Additional specific graph node types │
139 // └─────────────────────────────────────────────────────────────────────────┘
140 CallNodeKd, // Callgraph node
141 CDNodeKd, // Control dependence graph node
142 CFLNodeKd, // CFL graph node
143 CHNodeKd, // Class hierarchy graph node
144 ConstraintNodeKd, // Constraint graph node
145 TCTNodeKd, // Thread creation tree node
146 DCHNodeKd, // DCHG node
147 BasicBlockKd, // Basic block node
148 OtherKd // Other node kind
149 };
SVF::SVFValue::ConstNullptrObjNode
@ ConstNullptrObjNode
Definition SVFValue.h:97
SVF::SVFValue::ConstNullptrValNode
@ ConstNullptrValNode
Definition SVFValue.h:78

Constructor & Destructor Documentation

◆ SVFValue()

SVF::SVFValue::SVFValue ( NodeID  i,
GNodeK  k,
const SVFType *  ty = nullptr 
)
inline

Definition at line 152 of file SVFValue.h.

152 : id(i),nodeKind(k), type(ty)
153 {
154
155 }
SVF::SVFValue::nodeKind
GNodeK nodeKind
Node kind.
Definition SVFValue.h:204
SVF::SVFValue::id
NodeID id
Node ID.
Definition SVFValue.h:203
SVF::SVFValue::type
const SVFType * type
SVF type.
Definition SVFValue.h:205
SVF::IRBuilder
llvm::IRBuilder IRBuilder
Definition BasicTypes.h:74

Member Function Documentation

◆ getId()

NodeID SVF::SVFValue::getId ( ) const
inline

Get ID.

Definition at line 158 of file SVFValue.h.

159 {
160 return id;
161 }

◆ getName()

virtual const std::string & SVF::SVFValue::getName ( ) const
inlinevirtual

Reimplemented in SVF::DCHNode, SVF::CallGraphNode, and SVF::CHNode.

Definition at line 184 of file SVFValue.h.

185 {
186 return name;
187 }
SVF::SVFValue::name
std::string name
Definition SVFValue.h:207

◆ getNodeKind()

GNodeK SVF::SVFValue::getNodeKind ( ) const
inline

Get node kind.

Definition at line 164 of file SVFValue.h.

165 {
166 return nodeKind;
167 }

◆ getSourceLoc()

virtual const std::string SVF::SVFValue::getSourceLoc ( ) const
inlinevirtual

Reimplemented in SVF::GlobalICFGNode, SVF::FunEntryICFGNode, SVF::FunExitICFGNode, SVF::CallICFGNode, and SVF::RetICFGNode.

Definition at line 194 of file SVFValue.h.

195 {
196 return sourceLoc;
197 }
SVF::SVFValue::sourceLoc
std::string sourceLoc
Source code information of this value.
Definition SVFValue.h:208

◆ getType()

virtual const SVFType * SVF::SVFValue::getType ( ) const
inlinevirtual

Reimplemented in SVF::GepValVar, SVF::BaseObjVar, and SVF::GepObjVar.

Definition at line 169 of file SVFValue.h.

170 {
171 return type;
172 }

◆ isArgumentVFGNodeKinds()

static bool SVF::SVFValue::isArgumentVFGNodeKinds ( GNodeK  n)
inlinestaticprotected

Definition at line 286 of file SVFValue.h.

287 {
288 static_assert(FParm - FRet == 3,
289 "The number of ArgumentVFGNodeKinds has changed, make "
290 "sure the range is correct");
291 return n <= FParm && n >= FRet;
292 }

◆ isBaseObjVarKinds()

static bool SVF::SVFValue::isBaseObjVarKinds ( GNodeK  n)
inlinestaticprotected

Definition at line 262 of file SVFValue.h.

263 {
264 static_assert(DummyObjNode - BaseObjNode == 10,
265 "The number of BaseObjVarKinds has changed, make sure the "
266 "range is correct");
267 return n <= DummyObjNode && n >= BaseObjNode;
268 }

◆ isConstantDataObjVarKinds()

static bool SVF::SVFValue::isConstantDataObjVarKinds ( GNodeK  n)
inlinestaticprotected

Definition at line 270 of file SVFValue.h.

271 {
272 static_assert(ConstNullptrObjNode - ConstDataObjNode == 3,
273 "The number of ConstantDataObjVarKinds has changed, make "
274 "sure the range is correct");
275 return n <= ConstNullptrObjNode && n >= ConstDataObjNode;
276 }

◆ isConstantDataValVar()

static bool SVF::SVFValue::isConstantDataValVar ( GNodeK  n)
inlinestaticprotected

Definition at line 246 of file SVFValue.h.

247 {
248 static_assert(ConstNullptrValNode - ConstDataValNode == 4,
249 "The number of ConstantDataValVarKinds has changed, make "
250 "sure the range is correct");
251 return n <= ConstNullptrValNode && n >= ConstDataValNode;
252 }

◆ isICFGNodeKinds()

static bool SVF::SVFValue::isICFGNodeKinds ( GNodeK  n)
inlinestaticprotected

Helper functions to check node kinds.

Definition at line 212 of file SVFValue.h.

213 {
214 static_assert(FunRetBlock - IntraBlock == 5,
215 "the number of ICFGNodeKinds has changed, make sure "
216 "the range is correct");
217 return n <= FunRetBlock && n >= IntraBlock;
218 }

◆ isInterICFGNodeKind()

static bool SVF::SVFValue::isInterICFGNodeKind ( GNodeK  n)
inlinestaticprotected

Definition at line 220 of file SVFValue.h.

221 {
222 static_assert(FunRetBlock - FunEntryBlock == 3,
223 "the number of InterICFGNodeKind has changed, make sure "
224 "the range is correct");
225 return n <= FunRetBlock && n >= FunEntryBlock;
226 }

◆ isMRSVFGNodeKinds()

static bool SVF::SVFValue::isMRSVFGNodeKinds ( GNodeK  n)
inlinestaticprotected

Definition at line 310 of file SVFValue.h.

311 {
312 static_assert(MInterPhi - FPIN == 6,
313 "The number of MRSVFGNodeKinds has changed, make sure "
314 "the range is correct");
315 return n <= MInterPhi && n >= FPIN;
316 }

◆ isMSSAPHISVFGNodeKinds()

static bool SVF::SVFValue::isMSSAPHISVFGNodeKinds ( GNodeK  n)
inlinestaticprotected

Definition at line 318 of file SVFValue.h.

319 {
320 static_assert(MInterPhi - MPhi == 2,
321 "The number of MSSAPHISVFGNodeKinds has changed, make "
322 "sure the range is correct");
323 return n <= MInterPhi && n >= MPhi;
324 }

◆ isObjVarKinds()

static bool SVF::SVFValue::isObjVarKinds ( GNodeK  n)
inlinestaticprotected

Definition at line 254 of file SVFValue.h.

255 {
256 static_assert(DummyObjNode - ObjNode == 12,
257 "The number of ObjVarKinds has changed, make sure the "
258 "range is correct");
259 return n <= DummyObjNode && n >= ObjNode;
260 }

◆ isPHIVFGNodeKinds()

static bool SVF::SVFValue::isPHIVFGNodeKinds ( GNodeK  n)
inlinestaticprotected

Definition at line 302 of file SVFValue.h.

303 {
304 static_assert(TInterPhi - TPhi == 2,
305 "The number of PHIVFGNodeKinds has changed, make sure "
306 "the range is correct");
307 return n <= TInterPhi && n >= TPhi;
308 }

◆ isStmtVFGNodeKinds()

static bool SVF::SVFValue::isStmtVFGNodeKinds ( GNodeK  n)
inlinestaticprotected

Definition at line 294 of file SVFValue.h.

295 {
296 static_assert(Load - Addr == 4,
297 "The number of StmtVFGNodeKinds has changed, make sure "
298 "the range is correct");
299 return n <= Load && n >= Addr;
300 }

◆ isSVFVarKind()

static bool SVF::SVFValue::isSVFVarKind ( GNodeK  n)
inlinestaticprotected

Definition at line 228 of file SVFValue.h.

229 {
230 static_assert(DummyObjNode - ValNode == 26,
231 "The number of SVFVarKinds has changed, make sure the "
232 "range is correct");
233
234 return n <= DummyObjNode && n >= ValNode;
235 }

◆ isValVarKinds()

static bool SVF::SVFValue::isValVarKinds ( GNodeK  n)
inlinestaticprotected

Definition at line 237 of file SVFValue.h.

238 {
239 static_assert(DummyValNode - ValNode == 13,
240 "The number of ValVarKinds has changed, make sure the "
241 "range is correct");
242 return n <= DummyValNode && n >= ValNode;
243 }

◆ isVFGNodeKinds()

static bool SVF::SVFValue::isVFGNodeKinds ( GNodeK  n)
inlinestaticprotected

Definition at line 278 of file SVFValue.h.

279 {
280 static_assert(MInterPhi - Cmp == 24,
281 "The number of VFGNodeKinds has changed, make sure the "
282 "range is correct");
283 return n <= MInterPhi && n >= Cmp;
284 }

◆ setName() [1/2]

virtual void SVF::SVFValue::setName ( const std::string &  nameInfo)
inlinevirtual

Definition at line 174 of file SVFValue.h.

175 {
176 name = nameInfo;
177 }

◆ setName() [2/2]

virtual void SVF::SVFValue::setName ( std::string &&  nameInfo)
inlinevirtual

Definition at line 179 of file SVFValue.h.

180 {
181 name = std::move(nameInfo);
182 }

◆ setSourceLoc()

virtual void SVF::SVFValue::setSourceLoc ( const std::string &  sourceCodeInfo)
inlinevirtual

Definition at line 189 of file SVFValue.h.

190 {
191 sourceLoc = sourceCodeInfo;
192 }

◆ valueOnlyToString()

const std::string SVF::SVFValue::valueOnlyToString ( ) const

Definition at line 735 of file LLVMUtil.cpp.

736{
737 std::string str;
738 llvm::raw_string_ostream rawstr(str);
739 assert(
740 !SVFUtil::isa<GepObjVar>(this) && !SVFUtil::isa<GepValVar>(this) &&
741 !SVFUtil::isa<DummyObjVar>(this) &&!SVFUtil::isa<DummyValVar>(this) &&
742 !SVFUtil::isa<BlackHoleValVar>(this) &&
743 "invalid value, refer to their toString method");
744 auto llvmVal =
745 LLVMModuleSet::getLLVMModuleSet()->getLLVMValue(this);
746 if (llvmVal)
747 rawstr << " " << *llvmVal << " ";
748 else
749 rawstr << "";
750 rawstr << getSourceLoc();
751 return rawstr.str();
752}
SVF::LLVMModuleSet::getLLVMModuleSet
static LLVMModuleSet * getLLVMModuleSet()
Definition LLVMModule.h:129
SVF::LLVMModuleSet::getLLVMValue
const Value * getLLVMValue(const SVFValue *value) const
Definition LLVMModule.h:253
SVF::SVFValue::getSourceLoc
virtual const std::string getSourceLoc() const
Definition SVFValue.h:194

Member Data Documentation

◆ id

NodeID SVF::SVFValue::id
protected

Node ID.

Definition at line 203 of file SVFValue.h.

◆ name

std::string SVF::SVFValue::name
protected

Definition at line 207 of file SVFValue.h.

◆ nodeKind

GNodeK SVF::SVFValue::nodeKind
protected

Node kind.

Definition at line 204 of file SVFValue.h.

◆ sourceLoc

std::string SVF::SVFValue::sourceLoc
protected

Source code information of this value.

Definition at line 208 of file SVFValue.h.

◆ type

const SVFType* SVF::SVFValue::type
protected

SVF type.

Definition at line 205 of file SVFValue.h.

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.8