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

#include <ObjTypeInfo.h>

Public Types

enum  MEMTYPE {
  FUNCTION_OBJ = 0x1 , GLOBVAR_OBJ = 0x2 , STATIC_OBJ = 0x4 , STACK_OBJ = 0x8 ,
  HEAP_OBJ = 0x10 , VAR_STRUCT_OBJ = 0x20 , VAR_ARRAY_OBJ = 0x40 , CONST_STRUCT_OBJ = 0x80 ,
  CONST_ARRAY_OBJ = 0x100 , CONST_GLOBAL_OBJ = 0x200 , CONST_DATA = 0x400
}
 

Public Member Functions

 ObjTypeInfo (const SVFType *t, u32_t max)
 Constructors.
 
virtual ~ObjTypeInfo ()
 Destructor.
 
const SVFType * getType () const
 Get LLVM type.
 
u32_t getMaxFieldOffsetLimit ()
 Get max field offset limit.
 
void setMaxFieldOffsetLimit (u32_t limit)
 Get max field offset limit.
 
void setNumOfElements (u32_t num)
 Set the number of elements of this object.
 
u32_t getNumOfElements () const
 Get the number of elements of this object.
 
u32_t getByteSizeOfObj () const
 Get the byte size of this object.
 
void setByteSizeOfObj (u32_t size)
 Set the byte size of this object.
 
bool isConstantByteSize () const
 Check if byte size is a const value.
 
void setFlag (MEMTYPE mask)
 Flag for this object type.
 
bool hasFlag (MEMTYPE mask)
 
bool isFunction ()
 Object attributes.
 
bool isGlobalObj ()
 
bool isStaticObj ()
 
bool isStack ()
 
bool isHeap ()
 
bool isVarStruct ()
 
bool isConstantStruct ()
 
bool isStruct ()
 
bool isVarArray ()
 
bool isConstantArray ()
 
bool isArray ()
 
bool isConstDataOrConstGlobal ()
 
bool isConstDataOrAggData ()
 

Private Member Functions

void resetTypeForHeapStaticObj (const SVFType *t)
 

Private Attributes

const SVFType * type
 SVF type.
 
u32_t flags
 Type flags.
 
u32_t maxOffsetLimit
 
u32_t elemNum
 Size of the object or number of elements.
 
u32_t byteSize
 Byte size of object.
 

Friends

class SVFIRWriter
 
class SVFIRReader
 
class SymbolTableBuilder
 

Detailed Description

Type Info of an abstract memory object

Definition at line 42 of file ObjTypeInfo.h.

Member Enumeration Documentation

◆ MEMTYPE

enum SVF::ObjTypeInfo::MEMTYPE
Enumerator
FUNCTION_OBJ 
GLOBVAR_OBJ 
STATIC_OBJ 
STACK_OBJ 
HEAP_OBJ 
VAR_STRUCT_OBJ 
VAR_ARRAY_OBJ 
CONST_STRUCT_OBJ 
CONST_ARRAY_OBJ 
CONST_GLOBAL_OBJ 
CONST_DATA 

Definition at line 49 of file ObjTypeInfo.h.

50 {
51 FUNCTION_OBJ = 0x1, // object is a function
52 GLOBVAR_OBJ = 0x2, // object is a global variable
53 STATIC_OBJ = 0x4, // object is a static variable allocated before main
54 STACK_OBJ = 0x8, // object is a stack variable
55 HEAP_OBJ = 0x10, // object is a heap variable
56 VAR_STRUCT_OBJ = 0x20, // object contains struct
57 VAR_ARRAY_OBJ = 0x40, // object contains array
58 CONST_STRUCT_OBJ = 0x80, // constant struct
59 CONST_ARRAY_OBJ = 0x100, // constant array
60 CONST_GLOBAL_OBJ = 0x200, // global constant object
61 CONST_DATA = 0x400, // constant object str e.g. 5, 10, 1.0
62 } MEMTYPE;

Constructor & Destructor Documentation

◆ ObjTypeInfo()

SVF::ObjTypeInfo::ObjTypeInfo ( const SVFType *  t,
u32_t  max 
)
inline

Constructors.

Definition at line 87 of file ObjTypeInfo.h.

87 : type(t), flags(0), maxOffsetLimit(max), elemNum(max)
88 {
89 assert(t && "no type information for this object?");
90 }
SVF::ObjTypeInfo::type
const SVFType * type
SVF type.
Definition ObjTypeInfo.h:66
SVF::ObjTypeInfo::elemNum
u32_t elemNum
Size of the object or number of elements.
Definition ObjTypeInfo.h:74
SVF::ObjTypeInfo::flags
u32_t flags
Type flags.
Definition ObjTypeInfo.h:68
SVF::IRBuilder
llvm::IRBuilder IRBuilder
Definition BasicTypes.h:74

◆ ~ObjTypeInfo()

virtual SVF::ObjTypeInfo::~ObjTypeInfo ( )
inlinevirtual

Destructor.

Definition at line 93 of file ObjTypeInfo.h.

94 {
95 }

Member Function Documentation

◆ getByteSizeOfObj()

u32_t SVF::ObjTypeInfo::getByteSizeOfObj ( ) const
inline

Get the byte size of this object.

Definition at line 129 of file ObjTypeInfo.h.

130 {
131 assert(isConstantByteSize() && "This Obj's byte size is not constant.");
132 return byteSize;
133 }
SVF::ObjTypeInfo::isConstantByteSize
bool isConstantByteSize() const
Check if byte size is a const value.
Definition ObjTypeInfo.h:142
SVF::ObjTypeInfo::byteSize
u32_t byteSize
Byte size of object.
Definition ObjTypeInfo.h:77

◆ getMaxFieldOffsetLimit()

u32_t SVF::ObjTypeInfo::getMaxFieldOffsetLimit ( )
inline

Get max field offset limit.

Definition at line 104 of file ObjTypeInfo.h.

105 {
106 return maxOffsetLimit;
107 }

◆ getNumOfElements()

u32_t SVF::ObjTypeInfo::getNumOfElements ( ) const
inline

Get the number of elements of this object.

Definition at line 123 of file ObjTypeInfo.h.

124 {
125 return elemNum;
126 }

◆ getType()

const SVFType * SVF::ObjTypeInfo::getType ( ) const
inline

Get LLVM type.

Definition at line 98 of file ObjTypeInfo.h.

99 {
100 return type;
101 }

◆ hasFlag()

bool SVF::ObjTypeInfo::hasFlag ( MEMTYPE  mask)
inline

Definition at line 153 of file ObjTypeInfo.h.

154 {
155 return (flags & mask) == mask;
156 }

◆ isArray()

bool SVF::ObjTypeInfo::isArray ( )
inline

Definition at line 206 of file ObjTypeInfo.h.

207 {
208 return hasFlag(VAR_ARRAY_OBJ) || hasFlag(CONST_ARRAY_OBJ);
209 }
SVF::ObjTypeInfo::hasFlag
bool hasFlag(MEMTYPE mask)
Definition ObjTypeInfo.h:153

◆ isConstantArray()

bool SVF::ObjTypeInfo::isConstantArray ( )
inline

Definition at line 202 of file ObjTypeInfo.h.

203 {
204 return hasFlag(CONST_ARRAY_OBJ);
205 }

◆ isConstantByteSize()

bool SVF::ObjTypeInfo::isConstantByteSize ( ) const
inline

Check if byte size is a const value.

Definition at line 142 of file ObjTypeInfo.h.

143 {
144 return byteSize != 0;
145 }

◆ isConstantStruct()

bool SVF::ObjTypeInfo::isConstantStruct ( )
inline

Definition at line 190 of file ObjTypeInfo.h.

191 {
192 return hasFlag(CONST_STRUCT_OBJ);
193 }

◆ isConstDataOrAggData()

bool SVF::ObjTypeInfo::isConstDataOrAggData ( )
inline

Definition at line 214 of file ObjTypeInfo.h.

215 {
216 return hasFlag(CONST_DATA);
217 }

◆ isConstDataOrConstGlobal()

bool SVF::ObjTypeInfo::isConstDataOrConstGlobal ( )
inline

Definition at line 210 of file ObjTypeInfo.h.

211 {
212 return hasFlag(CONST_GLOBAL_OBJ) || hasFlag(CONST_DATA);
213 }

◆ isFunction()

bool SVF::ObjTypeInfo::isFunction ( )
inline

Object attributes.

Definition at line 161 of file ObjTypeInfo.h.

162 {
163 return hasFlag(FUNCTION_OBJ);
164 }

◆ isGlobalObj()

bool SVF::ObjTypeInfo::isGlobalObj ( )
inline

Definition at line 165 of file ObjTypeInfo.h.

166 {
167 return hasFlag(GLOBVAR_OBJ);
168 }

◆ isHeap()

bool SVF::ObjTypeInfo::isHeap ( )
inline

Definition at line 177 of file ObjTypeInfo.h.

178 {
179 return hasFlag(HEAP_OBJ);
180 }

◆ isStack()

bool SVF::ObjTypeInfo::isStack ( )
inline

Definition at line 173 of file ObjTypeInfo.h.

174 {
175 return hasFlag(STACK_OBJ);
176 }

◆ isStaticObj()

bool SVF::ObjTypeInfo::isStaticObj ( )
inline

Definition at line 169 of file ObjTypeInfo.h.

170 {
171 return hasFlag(STATIC_OBJ);
172 }

◆ isStruct()

bool SVF::ObjTypeInfo::isStruct ( )
inline

Definition at line 194 of file ObjTypeInfo.h.

195 {
196 return hasFlag(VAR_STRUCT_OBJ) || hasFlag(CONST_STRUCT_OBJ);
197 }

◆ isVarArray()

bool SVF::ObjTypeInfo::isVarArray ( )
inline

Definition at line 198 of file ObjTypeInfo.h.

199 {
200 return hasFlag(VAR_ARRAY_OBJ);
201 }

◆ isVarStruct()

bool SVF::ObjTypeInfo::isVarStruct ( )
inline

Object attributes (noted that an object can be a nested compound types) e.g. both isStruct and isArray can return true

Definition at line 186 of file ObjTypeInfo.h.

187 {
188 return hasFlag(VAR_STRUCT_OBJ);
189 }

◆ resetTypeForHeapStaticObj()

void SVF::ObjTypeInfo::resetTypeForHeapStaticObj ( const SVFType *  t)
inlineprivate

Definition at line 79 of file ObjTypeInfo.h.

80 {
81 assert((isStaticObj() || isHeap()) && "can only reset the inferred type for heap and static objects!");
82 type = t;
83 }

◆ setByteSizeOfObj()

void SVF::ObjTypeInfo::setByteSizeOfObj ( u32_t  size)
inline

Set the byte size of this object.

Definition at line 136 of file ObjTypeInfo.h.

137 {
138 byteSize = size;
139 }

◆ setFlag()

void SVF::ObjTypeInfo::setFlag ( MEMTYPE  mask)
inline

Flag for this object type.

Definition at line 149 of file ObjTypeInfo.h.

150 {
151 flags |= mask;
152 }

◆ setMaxFieldOffsetLimit()

void SVF::ObjTypeInfo::setMaxFieldOffsetLimit ( u32_t  limit)
inline

Get max field offset limit.

Definition at line 110 of file ObjTypeInfo.h.

111 {
112 maxOffsetLimit = limit;
113 }

◆ setNumOfElements()

void SVF::ObjTypeInfo::setNumOfElements ( u32_t  num)
inline

Set the number of elements of this object.

Definition at line 116 of file ObjTypeInfo.h.

117 {
118 elemNum = num;
119 setMaxFieldOffsetLimit(num);
120 }
SVF::ObjTypeInfo::setMaxFieldOffsetLimit
void setMaxFieldOffsetLimit(u32_t limit)
Get max field offset limit.
Definition ObjTypeInfo.h:110

Friends And Related Symbol Documentation

◆ SVFIRReader

friend class SVFIRReader
friend

Definition at line 45 of file ObjTypeInfo.h.

◆ SVFIRWriter

friend class SVFIRWriter
friend

Definition at line 44 of file ObjTypeInfo.h.

◆ SymbolTableBuilder

friend class SymbolTableBuilder
friend

Definition at line 46 of file ObjTypeInfo.h.

Member Data Documentation

◆ byteSize

u32_t SVF::ObjTypeInfo::byteSize
private

Byte size of object.

Definition at line 77 of file ObjTypeInfo.h.

◆ elemNum

u32_t SVF::ObjTypeInfo::elemNum
private

Size of the object or number of elements.

Definition at line 74 of file ObjTypeInfo.h.

◆ flags

u32_t SVF::ObjTypeInfo::flags
private

Type flags.

Definition at line 68 of file ObjTypeInfo.h.

◆ maxOffsetLimit

u32_t SVF::ObjTypeInfo::maxOffsetLimit
private

Max offset for flexible field sensitive analysis maximum number of field object can be created minimum number is 0 (field insensitive analysis)

Definition at line 72 of file ObjTypeInfo.h.

◆ type

const SVFType* SVF::ObjTypeInfo::type
private

SVF type.

Definition at line 66 of file ObjTypeInfo.h.

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