SVF::MemObj Class Reference

#include <SymbolTableInfo.h>

Public Member Functions
	MemObj (SymID id, ObjTypeInfo *ti, const SVFValue *val=nullptr, const SVFBaseNode *node=nullptr)
	Constructor.
virtual	~MemObj ()
	Destructor.
virtual const std::string	toString () const
const SVFValue *	getValue () const
	Get the reference value to this object.
const SVFBaseNode *	getGNode () const
	Get the reference value to this object.
SymID	getId () const
	Get the memory object id.
const SVFType *	getType () 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
bool	isConstDataOrAggData () const
bool	operator== (const MemObj &mem) const
	Operator overloading.
void	destroy ()
	Clean up memory.

Private Attributes
ObjTypeInfo *	typeInfo
	Type information of this object.
const SVFValue *	refVal
	The unique value of this symbol/variable.
SymID	symId
	The unique id to represent this symbol.
const SVFBaseNode *	gNode

Friends
class	SVFIRWriter
class	SVFIRReader
class	SVFIRBuilder

Detailed Description

Memory object symbols or MemObj (address-taken variables in LLVM-based languages)

Definition at line 381 of file SymbolTableInfo.h.

Constructor & Destructor Documentation

MemObj()

MemObj::MemObj	(	SymID	id,
		ObjTypeInfo *	ti,
		const SVFValue *	val = nullptr,
		const SVFBaseNode *	node = nullptr
	)

Constructor.

Constructor of a memory object

Definition at line 377 of file SymbolTableInfo.cpp.

                                                                                      :
    typeInfo(ti), refVal(val), symId(id), gNode(node)
{
}

~MemObj()

virtual SVF::MemObj::~MemObj ( )

inlinevirtual

Destructor.

Definition at line 402 of file SymbolTableInfo.h.

    {
        destroy();
    }

Member Function Documentation

destroy()

void MemObj::destroy

(

)

Clean up memory.

Definition at line 423 of file SymbolTableInfo.cpp.

{
    delete typeInfo;
    typeInfo = nullptr;
}

getByteSizeOfObj()

u32_t MemObj::getByteSizeOfObj

(

)

const

Get the byte size of this object.

Definition at line 397 of file SymbolTableInfo.cpp.

{
    return typeInfo->getByteSizeOfObj();
}

getGNode()

const SVFBaseNode * SVF::MemObj::getGNode ( ) const

inline

Get the reference value to this object.

Definition at line 416 of file SymbolTableInfo.h.

    {
        return gNode;
    }

getId()

SymID SVF::MemObj::getId ( ) const

inline

Get the memory object id.

Definition at line 422 of file SymbolTableInfo.h.

    {
        return symId;
    }

getMaxFieldOffsetLimit()

u32_t MemObj::getMaxFieldOffsetLimit

(

)

const

Get max field offset limit.

Definition at line 430 of file SymbolTableInfo.cpp.

{
    return typeInfo->getMaxFieldOffsetLimit();
}

getNumOfElements()

u32_t MemObj::getNumOfElements

(

)

const

Get the number of elements of this object.

Definition at line 391 of file SymbolTableInfo.cpp.

{
    return typeInfo->getNumOfElements();
}

getType()

const SVFType * MemObj::getType

(

)

const

Get obj type.

Get obj type info.

Definition at line 416 of file SymbolTableInfo.cpp.

{
    return typeInfo->getType();
}

getValue()

const SVFValue * SVF::MemObj::getValue ( ) const

inline

Get the reference value to this object.

Definition at line 410 of file SymbolTableInfo.h.

    {
        return refVal;
    }

isArray()

bool MemObj::isArray

(

)

const

Definition at line 477 of file SymbolTableInfo.cpp.

{
    return typeInfo->isArray();
}

isBlackHoleObj()

bool MemObj::isBlackHoleObj

(

)

const

Whether it is a black hole object.

Whether it is a black hole object

Definition at line 385 of file SymbolTableInfo.cpp.

{
    return SymbolTableInfo::isBlkObj(getId());
}

isConstantArray()

bool MemObj::isConstantArray

(

)

const

Definition at line 497 of file SymbolTableInfo.cpp.

{
    return typeInfo->isConstantArray();
}

isConstantByteSize()

bool MemObj::isConstantByteSize

(

)

const

Check if byte size is a const value.

Check if byte size is static determined.

Definition at line 403 of file SymbolTableInfo.cpp.

{
    return typeInfo->isConstantByteSize();
}

isConstantStruct()

bool MemObj::isConstantStruct

(

)

const

Definition at line 492 of file SymbolTableInfo.cpp.

{
    return typeInfo->isConstantStruct();
}

isConstDataOrAggData()

bool MemObj::isConstDataOrAggData

(

)

const

Definition at line 507 of file SymbolTableInfo.cpp.

{
    return typeInfo->isConstDataOrAggData();
}

isConstDataOrConstGlobal()

bool MemObj::isConstDataOrConstGlobal

(

)

const

Definition at line 502 of file SymbolTableInfo.cpp.

{
    return typeInfo->isConstDataOrConstGlobal();
}

isFieldInsensitive()

bool MemObj::isFieldInsensitive

(

)

const

Return true if its field limit is 0.

Definition at line 436 of file SymbolTableInfo.cpp.

{
    return getMaxFieldOffsetLimit() == 0;
}

isFunction()

bool MemObj::isFunction

(

)

const

object attributes methods

Definition at line 447 of file SymbolTableInfo.cpp.

{
    return typeInfo->isFunction();
}

isGlobalObj()

bool MemObj::isGlobalObj

(

)

const

Definition at line 452 of file SymbolTableInfo.cpp.

{
    return typeInfo->isGlobalObj();
}

isHeap()

bool MemObj::isHeap

(

)

const

Definition at line 467 of file SymbolTableInfo.cpp.

{
    return typeInfo->isHeap();
}

isStack()

bool MemObj::isStack

(

)

const

Definition at line 462 of file SymbolTableInfo.cpp.

{
    return typeInfo->isStack();
}

isStaticObj()

bool MemObj::isStaticObj

(

)

const

Definition at line 457 of file SymbolTableInfo.cpp.

{
    return typeInfo->isStaticObj();
}

isStruct()

bool MemObj::isStruct

(

)

const

Definition at line 472 of file SymbolTableInfo.cpp.

{
    return typeInfo->isStruct();
}

isVarArray()

bool MemObj::isVarArray

(

)

const

Definition at line 487 of file SymbolTableInfo.cpp.

{
    return typeInfo->isVarArray();
}

isVarStruct()

bool MemObj::isVarStruct

(

)

const

Definition at line 482 of file SymbolTableInfo.cpp.

{
    return typeInfo->isVarStruct();
}

operator==()

bool SVF::MemObj::operator== ( const MemObj &  mem ) const

inline

Operator overloading.

Definition at line 476 of file SymbolTableInfo.h.

    {
        return getValue() == mem.getValue();
    }

setFieldInsensitive()

void MemObj::setFieldInsensitive

(

)

Set the memory object to be field insensitive.

Definition at line 442 of file SymbolTableInfo.cpp.

{
    typeInfo->setMaxFieldOffsetLimit(0);
}

setFieldSensitive()

void MemObj::setFieldSensitive

(

)

Set the memory object to be field sensitive (up to max field limit)

Set mem object to be field sensitive (up to maximum field limit)

Definition at line 368 of file SymbolTableInfo.cpp.

{
    typeInfo->setMaxFieldOffsetLimit(typeInfo->getNumOfElements());
}

setNumOfElements()

void MemObj::setNumOfElements

(

u32_t

num

)

Set the number of elements of this object.

Definition at line 410 of file SymbolTableInfo.cpp.

{
    return typeInfo->setNumOfElements(num);
}

toString()

const std::string MemObj::toString ( ) const

virtual

Definition at line 513 of file SymbolTableInfo.cpp.

{
    std::string str;
    std::stringstream rawstr(str);
    rawstr << "MemObj : " << getId() << getValue()->toString() << "\n";
    return rawstr.str();
}

Friends And Related Symbol Documentation

SVFIRBuilder

friend class SVFIRBuilder

friend

Definition at line 385 of file SymbolTableInfo.h.

SVFIRReader

friend class SVFIRReader

friend

Definition at line 384 of file SymbolTableInfo.h.

SVFIRWriter

friend class SVFIRWriter

friend

Definition at line 383 of file SymbolTableInfo.h.

Member Data Documentation

gNode

const SVFBaseNode* SVF::MemObj::gNode

private

Definition at line 395 of file SymbolTableInfo.h.

refVal

const SVFValue* SVF::MemObj::refVal

private

The unique value of this symbol/variable.

Definition at line 391 of file SymbolTableInfo.h.

symId

SymID SVF::MemObj::symId

private

The unique id to represent this symbol.

Definition at line 393 of file SymbolTableInfo.h.

typeInfo

ObjTypeInfo* SVF::MemObj::typeInfo

private

Type information of this object.

Definition at line 389 of file SymbolTableInfo.h.

---

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

• /home/runner/work/SVF/SVF/svf/include/SVFIR/SymbolTableInfo.h
• /home/runner/work/SVF/SVF/svf/lib/SVFIR/SymbolTableInfo.cpp