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

#include <SVFVariables.h>

Inheritance diagram for SVF::HeapObjVar:

Public Member Functions
	HeapObjVar (const SVFFunction func, const SVFType svfType, NodeID i, const MemObj *mem, PNODEK ty=HeapObjNode)
	Constructor.

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

virtual const std::string	toString () const

Public Member Functions inherited from SVF::BaseObjVar
	BaseObjVar (const SVFValue val, NodeID i, const MemObj mem, PNODEK ty=BaseObjNode)
	Constructor.

Public Member Functions inherited from SVF::ObjVar
const MemObj *	getMemObj () const
	Return memory object.

virtual const SVFType *	getType () const
	Return type of the value.

Public Member Functions inherited from SVF::SVFVar
	SVFVar (const SVFValue *val, NodeID i, PNODEK k)
	Constructor.

virtual	~SVFVar ()
	Destructor.

const SVFValue *	getValue () const
	Get/has methods of the components.

bool	hasValue () const

virtual bool	isPointer () const
	Whether it is a pointer.

bool	isConstDataOrAggDataButNotNullPtr () const

virtual bool	isIsolatedNode () const
	Whether this is an isolated node on the SVFIR graph.

virtual const SVFFunction *	getFunction () const

SVFStmt::SVFStmtSetTy &	getIncomingEdges (SVFStmt::PEDGEK kind)
	Get incoming SVFIR statements (edges)

SVFStmt::SVFStmtSetTy &	getOutgoingEdges (SVFStmt::PEDGEK kind)
	Get outgoing SVFIR statements (edges)

bool	hasIncomingEdges (SVFStmt::PEDGEK kind) const
	Has incoming SVFIR statements (edges)

bool	hasOutgoingEdges (SVFStmt::PEDGEK kind) const
	Has outgoing SVFIR statements (edges)

SVFStmt::SVFStmtSetTy::iterator	getIncomingEdgesBegin (SVFStmt::PEDGEK kind) const
	Get incoming SVFStmt iterator.

SVFStmt::SVFStmtSetTy::iterator	getIncomingEdgesEnd (SVFStmt::PEDGEK kind) const
	Get incoming SVFStmt iterator.

SVFStmt::SVFStmtSetTy::iterator	getOutgoingEdgesBegin (SVFStmt::PEDGEK kind) const
	Get outgoing SVFStmt iterator.

SVFStmt::SVFStmtSetTy::iterator	getOutgoingEdgesEnd (SVFStmt::PEDGEK kind) const
	Get outgoing SVFStmt iterator.

void	dump () const
	Dump to console for debugging.

Public Member Functions inherited from SVF::GenericNode< NodeTy, EdgeTy >
	GenericNode (NodeID i, GNodeK k)
	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::SVFBaseNode
	SVFBaseNode (NodeID i, GNodeK k, SVFType *ty=nullptr)

NodeID	getId () const
	Get ID.

GNodeK	getNodeKind () const
	Get node kind.

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

Static Public Member Functions inherited from SVF::SVFVar
static bool	classof (const SVFVar *)

static bool	classof (const GenericPAGNodeTy *node)

static bool	classof (const SVFBaseNode *node)

Static Public Member Functions inherited from SVF::GenericNode< NodeTy, EdgeTy >
static bool	classof (const GenericNode< NodeTy, EdgeTy > *)

static bool	classof (const SVFBaseNode *)

Protected Member Functions
	HeapObjVar (NodeID i, PNODEK ty=HeapObjNode)
	Constructor to create heap object var.

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

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

	ObjVar (const SVFValue val, NodeID i, const MemObj m, PNODEK ty=ObjNode)
	Constructor.

Protected Member Functions inherited from SVF::SVFVar
	SVFVar (NodeID i, PNODEK k)
	function containing this variable

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::SVFBaseNode
enum	GNodeK { IntraBlock , GlobalBlock , FunEntryBlock , FunExitBlock , FunCallBlock , FunRetBlock , ValNode , FunValNode , GepValNode , RetNode , VarargNode , GlobalValNode , ConstantDataValNode , BlackHoleNode , ConstantFPValNode , ConstantIntValNode , ConstantNullptrValNode , DummyValNode , ObjNode , GepObjNode , BaseObjNode , FunObjNode , HeapObjNode , StackObjNode , GlobalObjNode , ConstantDataObjNode , ConstantFPObjNode , ConstantIntObjNode , ConstantNullptrObjNode , 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 , OtherKd }

Static Protected Member Functions inherited from SVF::SVFBaseNode
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::ObjVar
const MemObj *	mem

Protected Attributes inherited from SVF::SVFVar
const SVFValue *	value
	value of this SVFIR node

SVFStmt::KindToSVFStmtMapTy	InEdgeKindToSetMap

SVFStmt::KindToSVFStmtMapTy	OutEdgeKindToSetMap

bool	isPtr

const SVFFunction *	func
	whether it is a pointer (top-level or address-taken)

Protected Attributes inherited from SVF::SVFBaseNode
NodeID	id
	Node ID.

GNodeK	nodeKind
	Node kind.

const SVFType *	type
	SVF type.

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 615 of file SVFVariables.h.

Constructor & Destructor Documentation

◆ HeapObjVar() [1/2]

SVF::HeapObjVar::HeapObjVar	(	NodeID	i,
		PNODEK	ty = `HeapObjNode`
	)

inlineprotected

Constructor to create heap object var.

Definition at line 623 of file SVFVariables.h.

623: BaseObjVar(i, ty) {}

SVF::BaseObjVar::BaseObjVar

BaseObjVar(NodeID i, PNODEK ty=BaseObjNode)

Constructor to create empty ObjVar (for SVFIRReader/deserialization)

Definition SVFVariables.h:563

SVF::IRBuilder

llvm::IRBuilder IRBuilder

Definition BasicTypes.h:74

◆ HeapObjVar() [2/2]

HeapObjVar::HeapObjVar	(	const SVFFunction *	func,
		const SVFType *	svfType,
		NodeID	i,
		const MemObj *	mem,
		PNODEK	ty = `HeapObjNode`
	)

Constructor.

Definition at line 201 of file SVFVariables.cpp.

    : BaseObjVar(mem->getValue(), i, mem, ty)
{
    isPtr = svfType->isPointerTy();
    func = f;
}

Member Function Documentation

◆ classof() [1/6]

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

inlinestatic

Definition at line 632 of file SVFVariables.h.

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

◆ classof() [2/6]

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

inlinestatic

Definition at line 644 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 628 of file SVFVariables.h.

    {
        return true;
    }

◆ classof() [4/6]

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

inlinestatic

Definition at line 636 of file SVFVariables.h.

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

◆ classof() [5/6]

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

inlinestatic

Definition at line 648 of file SVFVariables.h.

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

◆ classof() [6/6]

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

inlinestatic

Definition at line 640 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 659 of file SVFVariables.h.

    {
        return " (heap base object)";
    }

◆ toString()

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

virtual

Reimplemented from SVF::BaseObjVar.

Definition at line 209 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 619 of file SVFVariables.h.

◆ SVFIRWriter

friend class SVFIRWriter

friend

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