Class representing a heap object variable in the SVFIR. More...

#include <SVFVariables.h>

Inheritance diagram for SVF::HeapObjVar:

Public Member Functions
	HeapObjVar (NodeID i, ObjTypeInfo ti, const SVFType svfType, const ICFGNode *node)
	Constructor.

const std::string	getValueName () const
	Return name of a LLVM value.

virtual const std::string	toString () const
	Get string representation.

Public Member Functions inherited from SVF::BaseObjVar
	BaseObjVar (NodeID i, ObjTypeInfo ti, const SVFType svfType, 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.

NodeID	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

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 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 HeapObjVar *)
	Methods for support type inquiry through isa, cast, and dyn_cast:

static bool	classof (const BaseObjVar *node)

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::BaseObjVar
static bool	classof (const BaseObjVar *)
	Methods for support type inquiry through isa, cast, and dyn_cast:

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 *)

Protected Member Functions
	HeapObjVar (NodeID i, const ICFGNode *node)
	Constructor to create heap object var.

Protected Member Functions inherited from SVF::BaseObjVar
	BaseObjVar (NodeID i, const ICFGNode *node, PNODEK ty=BaseObjNode)
	ICFGNode related to the creation of this object.

Protected Member Functions inherited from SVF::ObjVar
	ObjVar (NodeID i, PNODEK ty=ObjNode)
	Constructor to create an empty ObjVar (for SVFIRReader/deserialization)

	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.

Friends
class	SVFIRWriter

class	SVFIRReader

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 }

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

Class representing a heap object variable in the SVFIR.

This class models heap-allocated objects in the program analysis. It extends BaseObjVar to specifically handle heap memory locations.

Definition at line 833 of file SVFVariables.h.

Constructor & Destructor Documentation

◆ HeapObjVar() [1/2]

SVF::HeapObjVar::HeapObjVar	(	NodeID	i,
		const ICFGNode *	node
	)

inlineprotected

Constructor to create heap object var.

Definition at line 841 of file SVFVariables.h.

841: BaseObjVar(i, node, HeapObjNode) {}

SVF::BaseObjVar::BaseObjVar

BaseObjVar(NodeID i, const ICFGNode *node, PNODEK ty=BaseObjNode)

ICFGNode related to the creation of this object.

Definition SVFVariables.h:533

SVF::SVFValue::HeapObjNode

@ HeapObjNode

Definition SVFValue.h:89

SVF::IRBuilder

llvm::IRBuilder IRBuilder

Definition BasicTypes.h:74

◆ HeapObjVar() [2/2]

SVF::HeapObjVar::HeapObjVar	(	NodeID	i,
		ObjTypeInfo *	ti,
		const SVFType *	svfType,
		const ICFGNode *	node
	)

inline

Constructor.

Definition at line 873 of file SVFVariables.h.

                                                                                       :
        BaseObjVar(i, ti, svfType, node, HeapObjNode)
    {
    }

Member Function Documentation

◆ classof() [1/6]

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

inlinestatic

Definition at line 850 of file SVFVariables.h.

    {
        return node->getNodeKind() == HeapObjNode;
    }

◆ classof() [2/6]

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

inlinestatic

Definition at line 862 of file SVFVariables.h.

    {
        return node->getNodeKind() == HeapObjNode;
    }

◆ classof() [3/6]

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

inlinestatic

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

Definition at line 846 of file SVFVariables.h.

    {
        return true;
    }

◆ classof() [4/6]

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

inlinestatic

Definition at line 854 of file SVFVariables.h.

    {
        return node->getNodeKind() == HeapObjNode;
    }

◆ classof() [5/6]

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

inlinestatic

Definition at line 866 of file SVFVariables.h.

    {
        return node->getNodeKind() == HeapObjNode;
    }

◆ classof() [6/6]

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

inlinestatic

Definition at line 858 of file SVFVariables.h.

    {
        return node->getNodeKind() == HeapObjNode;
    }

◆ getValueName()

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

inlinevirtual

Return name of a LLVM value.

Reimplemented from SVF::BaseObjVar.

Definition at line 879 of file SVFVariables.h.

    {
        return " (heap base object)";
    }

◆ toString()

const std::string HeapObjVar::toString ( ) const

virtual

Get string representation.

Reimplemented from SVF::BaseObjVar.

Definition at line 242 of file SVFVariables.cpp.

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

Friends And Related Symbol Documentation

◆ SVFIRReader

friend class SVFIRReader

friend

Definition at line 837 of file SVFVariables.h.

◆ SVFIRWriter

friend class SVFIRWriter

friend

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HeapObjVar() [1/2]

◆ HeapObjVar() [2/2]

Member Function Documentation

◆ classof() [1/6]

◆ classof() [2/6]

◆ classof() [3/6]

◆ classof() [4/6]

◆ classof() [5/6]

◆ classof() [6/6]

◆ getValueName()

◆ toString()

Friends And Related Symbol Documentation

◆ SVFIRReader

◆ SVFIRWriter