SVF::BaseObjVar Class Reference

#include <SVFVariables.h>

Inheritance diagram for SVF::BaseObjVar:

Public Member Functions
	BaseObjVar (NodeID i, ObjTypeInfo *ti, const ICFGNode *node, PNODEK ty=BaseObjNode)
	Constructor.
virtual const BaseObjVar *	getBaseMemObj () const
const ICFGNode *	getICFGNode () const
	Get the ICFGNode related to the creation of this object.
const std::string	getValueName () const
	Return name of a LLVM value.
virtual const std::string	toString () const
	Get string representation.
NodeID	getId () const
	Get the memory object id.
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 FunObjVar *	getFunction () 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::SVFStmtSetTy &	getIncomingEdges (SVFStmt::PEDGEK kind)
	Edge accessors and checkers.
SVFStmt::SVFStmtSetTy &	getOutgoingEdges (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)
EdgeType *	hasIncomingEdge (EdgeType *edge) const
	Find incoming and outgoing edges.
EdgeType *	hasOutgoingEdge (EdgeType *edge) const
const GEdgeSetTy &	getOutEdges () const
const GEdgeSetTy &	getInEdges () 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 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 Public Member Functions
static bool	classof (const BaseObjVar *)
	ICFGNode related to the creation of this object.
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 Attributes
ObjTypeInfo *	typeInfo
const ICFGNode *	icfgNode

Friends
class	SVFIRBuilder

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::ObjVar
	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 SVFType *	type
	SVF type.
std::string	name
std::string	sourceLoc
	Source code information of this value.

Detailed Description

Definition at line 502 of file SVFVariables.h.

Constructor & Destructor Documentation

BaseObjVar()

SVF::BaseObjVar::BaseObjVar ( NodeID  i, ObjTypeInfo *  ti, const ICFGNode *  node, PNODEK  ty = BaseObjNode  )

inline

Constructor.

Definition at line 536 of file SVFVariables.h.

        : ObjVar(i, ti->getType(), ty), typeInfo(ti), icfgNode(node)
    {
    }

Member Function Documentation

classof() [1/5]

static bool SVF::BaseObjVar::classof ( const BaseObjVar *  )

inlinestatic

ICFGNode related to the creation of this object.

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

Definition at line 513 of file SVFVariables.h.

    {
        return true;
    }

classof() [2/5]

static bool SVF::BaseObjVar::classof ( const GenericPAGNodeTy *  node )

inlinestatic

Definition at line 525 of file SVFVariables.h.

    {
        return isBaseObjVarKinds(node->getNodeKind());
    }

classof() [3/5]

static bool SVF::BaseObjVar::classof ( const ObjVar *  node )

inlinestatic

Definition at line 517 of file SVFVariables.h.

    {
        return isBaseObjVarKinds(node->getNodeKind());
    }

classof() [4/5]

static bool SVF::BaseObjVar::classof ( const SVFValue *  node )

inlinestatic

Definition at line 529 of file SVFVariables.h.

    {
        return isBaseObjVarKinds(node->getNodeKind());
    }

classof() [5/5]

static bool SVF::BaseObjVar::classof ( const SVFVar *  node )

inlinestatic

Definition at line 521 of file SVFVariables.h.

    {
        return isBaseObjVarKinds(node->getNodeKind());
    }

destroy()

void SVF::BaseObjVar::destroy ( )

inline

Clean up memory.

Definition at line 677 of file SVFVariables.h.

    {
        delete typeInfo;
        typeInfo = nullptr;
    }

getBaseMemObj()

virtual const BaseObjVar * SVF::BaseObjVar::getBaseMemObj ( ) const

inlinevirtual

Definition at line 541 of file SVFVariables.h.

    {
        return this;
    }

getByteSizeOfObj()

u32_t SVF::BaseObjVar::getByteSizeOfObj ( ) const

inline

Get the byte size of this object.

Definition at line 608 of file SVFVariables.h.

    {
        return typeInfo->getByteSizeOfObj();
    }

getFunction()

const FunObjVar * BaseObjVar::getFunction ( ) const

virtual

Get containing function, or null for globals/constants.

Reimplemented from SVF::SVFVar.

Reimplemented in SVF::FunObjVar.

Definition at line 224 of file SVFVariables.cpp.

{
    if(icfgNode)
        return icfgNode->getFun();
    return nullptr;
}

getICFGNode()

const ICFGNode * SVF::BaseObjVar::getICFGNode ( ) const

inline

Get the ICFGNode related to the creation of this object.

Definition at line 547 of file SVFVariables.h.

    {
        return icfgNode;
    }

getId()

NodeID SVF::BaseObjVar::getId ( ) const

inline

Get the memory object id.

Definition at line 561 of file SVFVariables.h.

    {
        return id;
    }

getMaxFieldOffsetLimit()

u32_t SVF::BaseObjVar::getMaxFieldOffsetLimit ( ) const

inline

Get max field offset limit.

Definition at line 579 of file SVFVariables.h.

    {
        return typeInfo->getMaxFieldOffsetLimit();
    }

getNumOfElements()

u32_t SVF::BaseObjVar::getNumOfElements ( ) const

inline

Get the number of elements of this object.

Definition at line 567 of file SVFVariables.h.

    {
        return typeInfo->getNumOfElements();
    }

getValueName()

const std::string SVF::BaseObjVar::getValueName ( ) const

inlinevirtual

Return name of a LLVM value.

Reimplemented from SVF::ObjVar.

Reimplemented in SVF::HeapObjVar, SVF::StackObjVar, and SVF::DummyObjVar.

Definition at line 553 of file SVFVariables.h.

    {
        return getName() + " (base object)";
    }

isArray()

bool SVF::BaseObjVar::isArray ( ) const

inline

Definition at line 646 of file SVFVariables.h.

    {
        return typeInfo->isArray();
    }

isBlackHoleObj()

bool BaseObjVar::isBlackHoleObj

(

)

const

Whether it is a black hole object.

Definition at line 218 of file SVFVariables.cpp.

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

isConstantArray()

bool SVF::BaseObjVar::isConstantArray ( ) const

inline

Definition at line 662 of file SVFVariables.h.

    {
        return typeInfo->isConstantArray();
    }

isConstantByteSize()

bool SVF::BaseObjVar::isConstantByteSize ( ) const

inline

Check if byte size is a const value.

Definition at line 614 of file SVFVariables.h.

    {
        return typeInfo->isConstantByteSize();
    }

isConstantStruct()

bool SVF::BaseObjVar::isConstantStruct ( ) const

inline

Definition at line 658 of file SVFVariables.h.

    {
        return typeInfo->isConstantStruct();
    }

isConstDataOrAggData()

virtual bool SVF::BaseObjVar::isConstDataOrAggData ( ) const

inlinevirtual

Check if this variable represents constant/aggregate data.

Reimplemented from SVF::SVFVar.

Reimplemented in SVF::ConstAggObjVar, and SVF::ConstDataObjVar.

Definition at line 670 of file SVFVariables.h.

    {
        return typeInfo->isConstDataOrAggData();
    }

isConstDataOrConstGlobal()

bool SVF::BaseObjVar::isConstDataOrConstGlobal ( ) const

inline

Definition at line 666 of file SVFVariables.h.

    {
        return typeInfo->isConstDataOrConstGlobal();
    }

isFieldInsensitive()

bool SVF::BaseObjVar::isFieldInsensitive ( ) const

inline

Return true if its field limit is 0.

Definition at line 586 of file SVFVariables.h.

    {
        return getMaxFieldOffsetLimit() == 0;
    }

isFunction()

bool SVF::BaseObjVar::isFunction ( ) const

inline

object attributes methods

Definition at line 622 of file SVFVariables.h.

    {
        return typeInfo->isFunction();
    }

isGlobalObj()

bool SVF::BaseObjVar::isGlobalObj ( ) const

inline

Definition at line 626 of file SVFVariables.h.

    {
        return typeInfo->isGlobalObj();
    }

isHeap()

bool SVF::BaseObjVar::isHeap ( ) const

inline

Definition at line 638 of file SVFVariables.h.

    {
        return typeInfo->isHeap();
    }

isStack()

bool SVF::BaseObjVar::isStack ( ) const

inline

Definition at line 634 of file SVFVariables.h.

    {
        return typeInfo->isStack();
    }

isStaticObj()

bool SVF::BaseObjVar::isStaticObj ( ) const

inline

Definition at line 630 of file SVFVariables.h.

    {
        return typeInfo->isStaticObj();
    }

isStruct()

bool SVF::BaseObjVar::isStruct ( ) const

inline

Definition at line 642 of file SVFVariables.h.

    {
        return typeInfo->isStruct();
    }

isVarArray()

bool SVF::BaseObjVar::isVarArray ( ) const

inline

Definition at line 654 of file SVFVariables.h.

    {
        return typeInfo->isVarArray();
    }

isVarStruct()

bool SVF::BaseObjVar::isVarStruct ( ) const

inline

Definition at line 650 of file SVFVariables.h.

    {
        return typeInfo->isVarStruct();
    }

setFieldInsensitive()

void SVF::BaseObjVar::setFieldInsensitive ( )

inline

Set the memory object to be field insensitive.

Definition at line 592 of file SVFVariables.h.

    {
        typeInfo->setMaxFieldOffsetLimit(0);
    }

setFieldSensitive()

void SVF::BaseObjVar::setFieldSensitive ( )

inline

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

Definition at line 599 of file SVFVariables.h.

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

setNumOfElements()

void SVF::BaseObjVar::setNumOfElements ( u32_t  num )

inline

Set the number of elements of this object.

Definition at line 573 of file SVFVariables.h.

    {
        return typeInfo->setNumOfElements(num);
    }

toString()

const std::string BaseObjVar::toString ( ) const

virtual

Get string representation.

Reimplemented from SVF::ObjVar.

Reimplemented in SVF::HeapObjVar, SVF::StackObjVar, SVF::FunObjVar, SVF::GlobalObjVar, SVF::ConstAggObjVar, SVF::ConstDataObjVar, SVF::ConstFPObjVar, SVF::ConstIntObjVar, SVF::ConstNullPtrObjVar, and SVF::DummyObjVar.

Definition at line 230 of file SVFVariables.cpp.

{
    std::string str;
    std::stringstream rawstr(str);
    rawstr << "BaseObjVar ID: " << getId() << " (base object)";
    if (Options::ShowSVFIRValue())
    {
        rawstr << "\n";
        rawstr << valueOnlyToString();
    }
    return rawstr.str();
}

Friends And Related Symbol Documentation

SVFIRBuilder

friend class SVFIRBuilder

friend

Definition at line 504 of file SVFVariables.h.

Member Data Documentation

icfgNode

const ICFGNode* SVF::BaseObjVar::icfgNode

private

Definition at line 508 of file SVFVariables.h.

typeInfo

ObjTypeInfo* SVF::BaseObjVar::typeInfo

private

Definition at line 506 of file SVFVariables.h.

---

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

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