SVF::SymbolTableInfo Class Reference

#include <SymbolTableInfo.h>

Public Types
enum	SYMTYPE {   NullPtr , BlkPtr , BlackHole , ConstantObj ,   ValSymbol , ObjSymbol , RetSymbol , VarargSymbol }
	Symbol types. More...
typedef OrderedMap< const SVFValue *, SymID >	ValueToIDMapTy
	various maps defined More...
typedef OrderedMap< SymID, MemObj * >	IDToMemMapTy
	sym id to memory object map More...
typedef OrderedMap< const SVFFunction *, SymID >	FunToIDMapTy
	function to sym id map More...
typedef Set< const SVFType * >	SVFTypeSet
	struct type to struct info map More...

Public Member Functions
virtual	~SymbolTableInfo ()
void	setModelConstants (bool _modelConstants)
	Set / Get modelConstants. More...
bool	getModelConstants () const
SVFModule *	getModule ()
	Module. More...
void	setModule (SVFModule *m)
	Module. More...
MemObj *	getBlkObj () const
MemObj *	getConstantObj () const
SymID	blkPtrSymID () const
SymID	nullPtrSymID () const
SymID	constantSymID () const
SymID	blackholeSymID () const
const MemObj *	createDummyObj (SymID symId, const SVFType *type)
	Can only be invoked by SVFIR::addDummyNode() when creating SVFIR from file. More...
SymID	getValSym (const SVFValue *val)
	Get different kinds of syms. More...
bool	hasValSym (const SVFValue *val)
SymID	getObjSym (const SVFValue *val) const
MemObj *	getObj (SymID id) const
SymID	getRetSym (const SVFFunction *val) const
SymID	getVarargSym (const SVFFunction *val) const
u32_t	getTotalSymNum () const
	Statistics. More...
u32_t	getMaxStructSize () const
ValueToIDMapTy &	valSyms ()
	Get different kinds of syms maps. More...
ValueToIDMapTy &	objSyms ()
IDToMemMapTy &	idToObjMap ()
const IDToMemMapTy &	idToObjMap () const
FunToIDMapTy &	retSyms ()
FunToIDMapTy &	varargSyms ()
const SVFTypeSet &	getSVFTypes () const
	Constant reader that won't change the state of the symbol table. More...
const Set< const StInfo * > &	getStInfos () const
const StInfo *	getTypeInfo (const SVFType *T) const
	Get struct info. More...
bool	hasSVFTypeInfo (const SVFType *T)
u32_t	getNumOfFlattenElements (const SVFType *T)
	Number of flattened elements of an array or struct. More...
u32_t	getFlattenedElemIdx (const SVFType *T, u32_t origId)
	Flattened element idx of an array or struct by considering stride. More...
const SVFType *	getFlatternedElemType (const SVFType *baseType, u32_t flatten_idx)
	Return the type of a flattened element given a flattened index. More...
const SVFType *	getOriginalElemType (const SVFType *baseType, u32_t origId) const
void	printFlattenFields (const SVFType *type)
	Debug method. More...
virtual void	dump ()
	Another debug method. More...
virtual APOffset	getModulusOffset (const MemObj *obj, const APOffset &apOffset)
	Given an offset from a Gep Instruction, return it modulus offset by considering memory layout. More...
void	addTypeInfo (const SVFType *ty)
void	addStInfo (StInfo *stInfo)

Static Public Member Functions
static SymbolTableInfo *	SymbolInfo ()
	Singleton design here to make sure we only have one instance during any analysis. More...
static void	releaseSymbolInfo ()
static bool	isBlkPtr (NodeID id)
	special value More...
static bool	isNullPtr (NodeID id)
static bool	isBlkObj (NodeID id)
static bool	isConstantObj (NodeID id)
static bool	isBlkObjOrConstantObj (NodeID id)
static std::string	toString (SYMTYPE symtype)

Public Attributes
const SVFType *	maxStruct
	The struct type with the most fields. More...
u32_t	maxStSize
	The number of fields in max_struct. More...

Protected Member Functions
	SymbolTableInfo (void)
	Constructor. More...
const std::vector< const SVFType * > &	getFlattenFieldTypes (const SVFStructType *T)
	Return the flattened field type for struct type only. More...
ObjTypeInfo *	createObjTypeInfo (const SVFType *type)
	Create an objectInfo based on LLVM type (value is null, and type could be null, representing a dummy object) More...

Protected Attributes
SVFTypeSet	svfTypes
Set< const StInfo * >	stInfos
	(owned) All StInfo More...

Private Member Functions
void	destroy ()
	Clean up memory. More...

Private Attributes
ValueToIDMapTy	valSymMap
	map a value to its sym id More...
ValueToIDMapTy	objSymMap
	map a obj reference to its sym id More...
FunToIDMapTy	returnSymMap
	return map More...
FunToIDMapTy	varargSymMap
	vararg map More...
IDToMemMapTy	objMap
	map a memory sym id to its obj More...
SVFModule *	mod
	Module. More...
bool	modelConstants
	Whether to model constants. More...
SymID	totalSymNum
	total number of symbols More...

Static Private Attributes
static SymbolTableInfo *	symInfo = nullptr

Friends
class	SymbolTableBuilder
class	SVFIRWriter
class	SVFIRReader

Detailed Description

Symbol table of the memory model for analysis

Definition at line 47 of file SymbolTableInfo.h.

Member Typedef Documentation

FunToIDMapTy

typedef OrderedMap<const SVFFunction*, SymID> SVF::SymbolTableInfo::FunToIDMapTy

function to sym id map

Definition at line 76 of file SymbolTableInfo.h.

IDToMemMapTy

typedef OrderedMap<SymID, MemObj*> SVF::SymbolTableInfo::IDToMemMapTy

sym id to memory object map

Definition at line 74 of file SymbolTableInfo.h.

SVFTypeSet

typedef Set<const SVFType*> SVF::SymbolTableInfo::SVFTypeSet

struct type to struct info map

Definition at line 78 of file SymbolTableInfo.h.

ValueToIDMapTy

typedef OrderedMap<const SVFValue*, SymID> SVF::SymbolTableInfo::ValueToIDMapTy

various maps defined

llvm value to sym id map local (%) and global (@) identifiers are pointer types which have a value node id.

Definition at line 72 of file SymbolTableInfo.h.

Member Enumeration Documentation

SYMTYPE

enum SVF::SymbolTableInfo::SYMTYPE

Symbol types.

Enumerator
NullPtr
BlkPtr
BlackHole
ConstantObj
ValSymbol
ObjSymbol
RetSymbol
VarargSymbol

Definition at line 56 of file SymbolTableInfo.h.

    {
        NullPtr,
        BlkPtr,
        BlackHole,
        ConstantObj,
        ValSymbol,
        ObjSymbol,
        RetSymbol,
        VarargSymbol
    };

Constructor & Destructor Documentation

SymbolTableInfo()

SVF::SymbolTableInfo::SymbolTableInfo ( void  )

inlineprotected

Constructor.

Definition at line 105 of file SymbolTableInfo.h.

        : mod(nullptr), modelConstants(false), totalSymNum(0),
          maxStruct(nullptr), maxStSize(0)
    {
    }

~SymbolTableInfo()

virtual SVF::SymbolTableInfo::~SymbolTableInfo ( )

inlinevirtual

Definition at line 122 of file SymbolTableInfo.h.

    {
        destroy();
    }

Member Function Documentation

addStInfo()

void SVF::SymbolTableInfo::addStInfo ( StInfo *  stInfo )

inline

Definition at line 352 of file SymbolTableInfo.h.

    {
        stInfos.insert(stInfo);
    }

addTypeInfo()

void SVF::SymbolTableInfo::addTypeInfo ( const SVFType *  ty )

inline

Definition at line 345 of file SymbolTableInfo.h.

    {
        bool inserted = svfTypes.insert(ty).second;
        if(!inserted)
            assert(false && "this type info has been added before");
    }

blackholeSymID()

SymID SVF::SymbolTableInfo::blackholeSymID ( ) const

inline

Definition at line 198 of file SymbolTableInfo.h.

    {
        return BlackHole;
    }

blkPtrSymID()

SymID SVF::SymbolTableInfo::blkPtrSymID ( ) const

inline

Definition at line 183 of file SymbolTableInfo.h.

    {
        return BlkPtr;
    }

constantSymID()

SymID SVF::SymbolTableInfo::constantSymID ( ) const

inline

Definition at line 193 of file SymbolTableInfo.h.

    {
        return ConstantObj;
    }

createDummyObj()

const MemObj * SymbolTableInfo::createDummyObj	(	SymID	symId,
		const SVFType *	type
	)

Can only be invoked by SVFIR::addDummyNode() when creating SVFIR from file.

Definition at line 163 of file SymbolTableInfo.cpp.

{
    assert(objMap.find(symId)==objMap.end() && "this dummy obj has been created before");
    MemObj* memObj = new MemObj(symId, createObjTypeInfo(type));
    objMap[symId] = memObj;
    return memObj;
}

createObjTypeInfo()

ObjTypeInfo * SymbolTableInfo::createObjTypeInfo ( const SVFType *  type )

protected

Create an objectInfo based on LLVM type (value is null, and type could be null, representing a dummy object)

Definition at line 68 of file SymbolTableInfo.cpp.

{
    ObjTypeInfo* typeInfo = new ObjTypeInfo(type, Options::MaxFieldLimit());
    if(type && type->isPointerTy())
    {
        typeInfo->setFlag(ObjTypeInfo::HEAP_OBJ);
    }
    return typeInfo;
}

destroy()

void SymbolTableInfo::destroy ( )

private

Clean up memory.

Destroy the memory for this symbol table after use

Definition at line 143 of file SymbolTableInfo.cpp.

{
 
    for (auto &pair: objMap)
    {
        if (MemObj* memObj = pair.second)
            delete memObj;
    }
 
    for (const SVFType* type : svfTypes)
        delete type;
    svfTypes.clear();
 
    for (const StInfo* st : stInfos)
        delete st;
    stInfos.clear();
 
    mod = nullptr;
}

dump()

void SymbolTableInfo::dump ( )

virtual

Another debug method.

Definition at line 326 of file SymbolTableInfo.cpp.

{
    OrderedMap<SymID, SVFValue*> idmap;
    for (ValueToIDMapTy::iterator iter = valSymMap.begin(); iter != valSymMap.end();
            ++iter)
    {
        const SymID i = iter->second;
        SVFValue* val = (SVFValue*) iter->first;
        idmap[i] = val;
    }
    for (ValueToIDMapTy::iterator iter = objSymMap.begin(); iter != objSymMap.end();
            ++iter)
    {
        const SymID i = iter->second;
        SVFValue* val = (SVFValue*) iter->first;
        idmap[i] = val;
    }
    for (FunToIDMapTy::iterator iter = returnSymMap.begin(); iter != returnSymMap.end();
            ++iter)
    {
        const SymID i = iter->second;
        SVFValue* val = (SVFValue*) iter->first;
        idmap[i] = val;
    }
    for (FunToIDMapTy::iterator iter = varargSymMap.begin(); iter != varargSymMap.end();
            ++iter)
    {
        const SymID i = iter->second;
        SVFValue* val = (SVFValue*) iter->first;
        idmap[i] = val;
    }
    outs() << "{SymbolTableInfo \n";
    for (auto iter : idmap)
    {
        outs() << iter.first << " " << iter.second->toString() << "\n";
    }
    outs() << "}\n";
}

getBlkObj()

MemObj* SVF::SymbolTableInfo::getBlkObj ( ) const

inline

Definition at line 174 of file SymbolTableInfo.h.

    {
        return getObj(blackholeSymID());
    }

getConstantObj()

MemObj* SVF::SymbolTableInfo::getConstantObj ( ) const

inline

Definition at line 178 of file SymbolTableInfo.h.

    {
        return getObj(constantSymID());
    }

getFlattenedElemIdx()

u32_t SymbolTableInfo::getFlattenedElemIdx	(	const SVFType *	T,
		u32_t	origId
	)

Flattened element idx of an array or struct by considering stride.

Flattened offset information of a struct or an array including its array fields.

When Options::ModelArrays is disabled, any element index Array is modeled as the base

Definition at line 181 of file SymbolTableInfo.cpp.

{
    if(Options::ModelArrays())
    {
        const std::vector<u32_t>& so = getTypeInfo(T)->getFlattenedElemIdxVec();
        assert ((unsigned)origId < so.size() && !so.empty() && "element index out of bounds, can't get flattened index!");
        return so[origId];
    }
    else
    {
        if(SVFUtil::isa<SVFStructType>(T))
        {
            const std::vector<u32_t>& so = getTypeInfo(T)->getFlattenedFieldIdxVec();
            assert ((unsigned)origId < so.size() && !so.empty() && "Struct index out of bounds, can't get flattened index!");
            return so[origId];
        }
        else
        {
            assert(SVFUtil::isa<SVFArrayType>(T) && "Only accept struct or array type if Options::ModelArrays is disabled!");
            return 0;
        }
    }
}

getFlattenFieldTypes()

const std::vector< const SVFType * > & SymbolTableInfo::getFlattenFieldTypes ( const SVFStructType *  T )

protected

Return the flattened field type for struct type only.

Definition at line 229 of file SymbolTableInfo.cpp.

{
    return getTypeInfo(T)->getFlattenFieldTypes();
}

getFlatternedElemType()

const SVFType * SymbolTableInfo::getFlatternedElemType	(	const SVFType *	baseType,
		u32_t	flatten_idx
	)

Return the type of a flattened element given a flattened index.

Definition at line 212 of file SymbolTableInfo.cpp.

{
    if(Options::ModelArrays())
    {
        const std::vector<const SVFType*>& so = getTypeInfo(baseType)->getFlattenElementTypes();
        assert (flatten_idx < so.size() && !so.empty() && "element index out of bounds or struct opaque type, can't get element type!");
        return so[flatten_idx];
    }
    else
    {
        const std::vector<const SVFType*>& so = getTypeInfo(baseType)->getFlattenFieldTypes();
        assert (flatten_idx < so.size() && !so.empty() && "element index out of bounds or struct opaque type, can't get element type!");
        return so[flatten_idx];
    }
}

getMaxStructSize()

u32_t SVF::SymbolTableInfo::getMaxStructSize ( ) const

inline

Definition at line 252 of file SymbolTableInfo.h.

    {
        return maxStSize;
    }

getModelConstants()

bool SVF::SymbolTableInfo::getModelConstants ( ) const

inline

Definition at line 134 of file SymbolTableInfo.h.

    {
        return modelConstants;
    }

getModule()

SVFModule* SVF::SymbolTableInfo::getModule ( )

inline

Module.

Definition at line 141 of file SymbolTableInfo.h.

    {
        return mod;
    }

getModulusOffset()

APOffset SymbolTableInfo::getModulusOffset ( const MemObj *  obj, const APOffset &  apOffset  )

virtual

Given an offset from a Gep Instruction, return it modulus offset by considering memory layout.

Get modulus offset given the type information

if the offset is negative, it's possible that we're looking for an obj node out of range of current struct. Make the offset positive so we can still get a node within current struct to represent this obj.

@offset: the index allocated to the newly generated field node; @Options::MaxFieldLimit(): preset upper bound of field number; @maxOffset: the max field number of the base object;

E.g., offset == 260, maxOffset == 270, Options::MaxFieldLimit() == 256 ==> offset = 4

E.g., offset == 100, maxOffset == 98, Options::MaxFieldLimit() == 256 ==> offset = 2

E.g., offset == 100, maxOffset == 98, Options::MaxFieldLimit() == 256 ==> offset = 97

Definition at line 94 of file SymbolTableInfo.cpp.

{
 
 
    APOffset offset = apOffset;
    if(offset < 0)
    {
        writeWrnMsg("try to create a gep node with negative offset.");
        offset = abs(offset);
    }
    u32_t maxOffset = obj->getMaxFieldOffsetLimit();
 
    if (maxOffset == 0)
        offset = 0;
    else if (Options::MaxFieldLimit() < maxOffset)
        offset = offset % maxOffset;
    else if ((u32_t)offset > maxOffset - 1)
    {
        if (Options::CyclicFldIdx())
            offset = offset % maxOffset;
        else
            offset = maxOffset - 1;
    }
 
    return offset;
}

getNumOfFlattenElements()

u32_t SymbolTableInfo::getNumOfFlattenElements

(

const SVFType *

T

)

Number of flattened elements of an array or struct.

Get a reference to the components of struct_info. Number of flattened elements of an array or struct

Definition at line 172 of file SymbolTableInfo.cpp.

{
    if(Options::ModelArrays())
        return getTypeInfo(T)->getNumOfFlattenElements();
    else
        return getTypeInfo(T)->getNumOfFlattenFields();
}

getObj()

MemObj* SVF::SymbolTableInfo::getObj ( SymID  id ) const

inline

Definition at line 223 of file SymbolTableInfo.h.

    {
        IDToMemMapTy::const_iterator iter = objMap.find(id);
        assert(iter!=objMap.end() && "obj not found");
        return iter->second;
    }

getObjSym()

SymID SVF::SymbolTableInfo::getObjSym ( const SVFValue *  val ) const

inline

Definition at line 213 of file SymbolTableInfo.h.

    {
        const SVFValue* svfVal = val;
        if(const SVFGlobalValue* g = SVFUtil::dyn_cast<SVFGlobalValue>(val))
            svfVal = g->getDefGlobalForMultipleModule();
        ValueToIDMapTy::const_iterator iter = objSymMap.find(svfVal);
        assert(iter!=objSymMap.end() && "obj sym not found");
        return iter->second;
    }

getOriginalElemType()

const SVFType * SymbolTableInfo::getOriginalElemType	(	const SVFType *	baseType,
		u32_t	origId
	)		const

struct A { int id; int salary; }; struct B { char name[20]; struct A a;} B b; OriginalElemType of b with field_idx 1 : Struct A FlatternedElemType of b with field_idx 1 : int

Definition at line 206 of file SymbolTableInfo.cpp.

{
    return getTypeInfo(baseType)->getOriginalElemType(origId);
}

getRetSym()

SymID SVF::SymbolTableInfo::getRetSym ( const SVFFunction *  val ) const

inline

Definition at line 230 of file SymbolTableInfo.h.

    {
        FunToIDMapTy::const_iterator iter =  returnSymMap.find(val);
        assert(iter!=returnSymMap.end() && "ret sym not found");
        return iter->second;
    }

getStInfos()

const Set<const StInfo*>& SVF::SymbolTableInfo::getStInfos ( ) const

inline

Definition at line 299 of file SymbolTableInfo.h.

    {
        return stInfos;
    }

getSVFTypes()

const SVFTypeSet& SVF::SymbolTableInfo::getSVFTypes ( ) const

inline

Constant reader that won't change the state of the symbol table.

Definition at line 294 of file SymbolTableInfo.h.

    {
        return svfTypes;
    }

getTotalSymNum()

u32_t SVF::SymbolTableInfo::getTotalSymNum ( ) const

inline

Statistics.

Definition at line 248 of file SymbolTableInfo.h.

    {
        return totalSymNum;
    }

getTypeInfo()

const StInfo * SymbolTableInfo::getTypeInfo

(

const SVFType *

T

)

const

Get struct info.

Get a reference to StructInfo.

Definition at line 57 of file SymbolTableInfo.cpp.

{
    assert(T);
    SVFTypeSet::const_iterator it = svfTypes.find(T);
    assert(it != svfTypes.end() && "type info not found? collect them first during SVFIR Building");
    return (*it)->getTypeInfo();
}

getValSym()

SymID SymbolTableInfo::getValSym

(

const SVFValue *

val

)

Get different kinds of syms.

Definition at line 523 of file SymbolTableInfo.cpp.

{
 
    if(val->isNullPtr())
        return nullPtrSymID();
    else if (val->isblackHole())
        return blkPtrSymID();
    else
    {
        ValueToIDMapTy::const_iterator iter =  valSymMap.find(val);
        assert(iter!=valSymMap.end() &&"value sym not found");
        return iter->second;
    }
}

getVarargSym()

SymID SVF::SymbolTableInfo::getVarargSym ( const SVFFunction *  val ) const

inline

Definition at line 237 of file SymbolTableInfo.h.

    {
        FunToIDMapTy::const_iterator iter =  varargSymMap.find(val);
        assert(iter!=varargSymMap.end() && "vararg sym not found");
        return iter->second;
    }

hasSVFTypeInfo()

bool SVF::SymbolTableInfo::hasSVFTypeInfo ( const SVFType *  T )

inline

Definition at line 309 of file SymbolTableInfo.h.

    {
        return svfTypes.find(T) != svfTypes.end();
    }

hasValSym()

bool SymbolTableInfo::hasValSym

(

const SVFValue *

val

)

Definition at line 538 of file SymbolTableInfo.cpp.

{
    if (val->isNullPtr() || val->isblackHole())
        return true;
    else
        return (valSymMap.find(val) != valSymMap.end());
}

idToObjMap() [1/2]

IDToMemMapTy& SVF::SymbolTableInfo::idToObjMap ( )

inline

Definition at line 270 of file SymbolTableInfo.h.

    {
        return objMap;
    }

idToObjMap() [2/2]

const IDToMemMapTy& SVF::SymbolTableInfo::idToObjMap ( ) const

inline

Definition at line 275 of file SymbolTableInfo.h.

    {
        return objMap;
    }

isBlkObj()

static bool SVF::SymbolTableInfo::isBlkObj ( NodeID  id )

inlinestatic

Definition at line 161 of file SymbolTableInfo.h.

    {
        return (id == BlackHole);
    }

isBlkObjOrConstantObj()

static bool SVF::SymbolTableInfo::isBlkObjOrConstantObj ( NodeID  id )

inlinestatic

Definition at line 169 of file SymbolTableInfo.h.

    {
        return (isBlkObj(id) || isConstantObj(id));
    }

isBlkPtr()

static bool SVF::SymbolTableInfo::isBlkPtr ( NodeID  id )

inlinestatic

special value

Definition at line 153 of file SymbolTableInfo.h.

    {
        return (id == BlkPtr);
    }

isConstantObj()

static bool SVF::SymbolTableInfo::isConstantObj ( NodeID  id )

inlinestatic

Definition at line 165 of file SymbolTableInfo.h.

    {
        return (id == ConstantObj);
    }

isNullPtr()

static bool SVF::SymbolTableInfo::isNullPtr ( NodeID  id )

inlinestatic

Definition at line 157 of file SymbolTableInfo.h.

    {
        return (id == NullPtr);
    }

nullPtrSymID()

SymID SVF::SymbolTableInfo::nullPtrSymID ( ) const

inline

Definition at line 188 of file SymbolTableInfo.h.

    {
        return NullPtr;
    }

objSyms()

ValueToIDMapTy& SVF::SymbolTableInfo::objSyms ( )

inline

Definition at line 265 of file SymbolTableInfo.h.

    {
        return objSymMap;
    }

printFlattenFields()

void SymbolTableInfo::printFlattenFields

(

const SVFType *

type

)

Debug method.

All rest types are scalar type?

Definition at line 237 of file SymbolTableInfo.cpp.

{
 
    if (const SVFArrayType* at = SVFUtil::dyn_cast<SVFArrayType>(type))
    {
        outs() << "  {Type: " << *at << "}\n"
               << "\tarray type "
               << "\t [element size = " << getNumOfFlattenElements(at) << "]\n"
               << "\n";
    }
    else if (const SVFStructType *st = SVFUtil::dyn_cast<SVFStructType>(type))
    {
        outs() <<"  {Type: " << *st << "}\n";
        const std::vector<const SVFType*>& finfo = getTypeInfo(st)->getFlattenFieldTypes();
        int field_idx = 0;
        for(const SVFType* type : finfo)
        {
            outs() << " \tField_idx = " << ++field_idx
                   << ", field type: " << *type << "\n";
        }
        outs() << "\n";
    }
    else if (const SVFPointerType* pt= SVFUtil::dyn_cast<SVFPointerType>(type))
    {
        outs() << *pt << "\n";
    }
    else if (const SVFFunctionType* fu =
                 SVFUtil::dyn_cast<SVFFunctionType>(type))
    {
        outs() << "  {Type: " << *fu << "}\n\n";
    }
    else if (const SVFOtherType* ot = SVFUtil::dyn_cast<SVFOtherType>(type))
    {
        outs() << "  {Type: "<< *ot << "(SVFOtherType)}\n\n";
    }
    else
    {
        assert(type->isSingleValueType() && "not a single value type, then what else!!");
        u32_t eSize = getNumOfFlattenElements(type);
        outs() << "  {Type: " << *type << "}\n"
               << "\t [object size = " << eSize << "]\n"
               << "\n";
    }
}

releaseSymbolInfo()

static void SVF::SymbolTableInfo::releaseSymbolInfo ( )

inlinestatic

Definition at line 117 of file SymbolTableInfo.h.

    {
        delete symInfo;
        symInfo = nullptr;
    }

retSyms()

FunToIDMapTy& SVF::SymbolTableInfo::retSyms ( )

inline

Definition at line 280 of file SymbolTableInfo.h.

    {
        return returnSymMap;
    }

setModelConstants()

void SVF::SymbolTableInfo::setModelConstants ( bool  _modelConstants )

inline

Set / Get modelConstants.

Definition at line 130 of file SymbolTableInfo.h.

    {
        modelConstants = _modelConstants;
    }

setModule()

void SVF::SymbolTableInfo::setModule ( SVFModule *  m )

inline

Module.

Definition at line 146 of file SymbolTableInfo.h.

    {
        mod = m;
    }

SymbolInfo()

SymbolTableInfo * SymbolTableInfo::SymbolInfo ( )

static

Singleton design here to make sure we only have one instance during any analysis.

Get the symbol table instance

Definition at line 81 of file SymbolTableInfo.cpp.

{
    if (symInfo == nullptr)
    {
        symInfo = new SymbolTableInfo();
        symInfo->setModelConstants(Options::ModelConsts());
    }
    return symInfo;
}

toString()

std::string SymbolTableInfo::toString ( SYMTYPE  symtype )

static

Definition at line 283 of file SymbolTableInfo.cpp.

{
    switch (symtype)
    {
    case SYMTYPE::BlackHole:
    {
        return "BlackHole";
    }
    case SYMTYPE::ConstantObj:
    {
        return "ConstantObj";
    }
    case SYMTYPE::BlkPtr:
    {
        return "BlkPtr";
    }
    case SYMTYPE::NullPtr:
    {
        return "NullPtr";
    }
    case SYMTYPE::ValSymbol:
    {
        return "ValSym";
    }
    case SYMTYPE::ObjSymbol:
    {
        return "ObjSym";
    }
    case SYMTYPE::RetSymbol:
    {
        return "RetSym";
    }
    case SYMTYPE::VarargSymbol:
    {
        return "VarargSym";
    }
    default:
    {
        return "Invalid SYMTYPE";
    }
    }
}

valSyms()

ValueToIDMapTy& SVF::SymbolTableInfo::valSyms ( )

inline

Get different kinds of syms maps.

Definition at line 260 of file SymbolTableInfo.h.

    {
        return valSymMap;
    }

varargSyms()

FunToIDMapTy& SVF::SymbolTableInfo::varargSyms ( )

inline

Definition at line 285 of file SymbolTableInfo.h.

    {
        return varargSymMap;
    }

Friends And Related Function Documentation

SVFIRReader

friend class SVFIRReader

friend

Definition at line 51 of file SymbolTableInfo.h.

SVFIRWriter

friend class SVFIRWriter

friend

Definition at line 50 of file SymbolTableInfo.h.

SymbolTableBuilder

friend class SymbolTableBuilder

friend

Definition at line 49 of file SymbolTableInfo.h.

Member Data Documentation

maxStruct

const SVFType* SVF::SymbolTableInfo::maxStruct

The struct type with the most fields.

Definition at line 340 of file SymbolTableInfo.h.

maxStSize

u32_t SVF::SymbolTableInfo::maxStSize

The number of fields in max_struct.

Definition at line 343 of file SymbolTableInfo.h.

mod

SVFModule* SVF::SymbolTableInfo::mod

private

Module.

Definition at line 92 of file SymbolTableInfo.h.

modelConstants

bool SVF::SymbolTableInfo::modelConstants

private

Whether to model constants.

Definition at line 98 of file SymbolTableInfo.h.

objMap

IDToMemMapTy SVF::SymbolTableInfo::objMap

private

map a memory sym id to its obj

Definition at line 86 of file SymbolTableInfo.h.

objSymMap

ValueToIDMapTy SVF::SymbolTableInfo::objSymMap

private

map a obj reference to its sym id

Definition at line 83 of file SymbolTableInfo.h.

returnSymMap

FunToIDMapTy SVF::SymbolTableInfo::returnSymMap

private

return map

Definition at line 84 of file SymbolTableInfo.h.

stInfos

Set<const StInfo*> SVF::SymbolTableInfo::stInfos

protected

(owned) All StInfo

Definition at line 373 of file SymbolTableInfo.h.

svfTypes

SVFTypeSet SVF::SymbolTableInfo::svfTypes

protected

(owned) All SVF Types Every type T is mapped to StInfo which contains size (fsize) , offset(foffset) fsize[i] is the number of fields in the largest such struct, else fsize[i] = 1. fsize[0] is always the size of the expanded struct.

Definition at line 370 of file SymbolTableInfo.h.

symInfo

SymbolTableInfo * SymbolTableInfo::symInfo = nullptr

staticprivate

Definition at line 89 of file SymbolTableInfo.h.

totalSymNum

SymID SVF::SymbolTableInfo::totalSymNum

private

total number of symbols

Definition at line 101 of file SymbolTableInfo.h.

valSymMap

ValueToIDMapTy SVF::SymbolTableInfo::valSymMap

private

map a value to its sym id

Definition at line 82 of file SymbolTableInfo.h.

varargSymMap

FunToIDMapTy SVF::SymbolTableInfo::varargSymMap

private

vararg map

Definition at line 85 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