#include <SVFVariables.h>

Inheritance diagram for SVF::GepObjVar:

Public Member Functions
	GepObjVar (const BaseObjVar *baseObj, NodeID i, const APOffset &apOffset, PNODEK ty=GepObjNode)
	Constructor.

APOffset	getConstantFieldIdx () const
	offset of the mem object

NodeID	getBaseNode (void) const
	Return the base object from which this GEP node came from.

const BaseObjVar *	getBaseObj () const

virtual const SVFType *	getType () const
	Return the type of this gep object.

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

virtual const FunObjVar *	getFunction () const
	Get containing function, or null for globals/constants.

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

virtual bool	ptrInUncalledFunction () const
	Check if this pointer is in an uncalled function.

virtual bool	isConstDataOrAggData () const
	Check if this variable represents constant/aggregate data.

virtual bool	isConstDataOrAggDataButNotNullPtr () const
	Check if this variable represents constant data/metadata but not null pointer.

virtual bool	isPointer () const
	Check if this variable represents a pointer.

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

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

Private Member Functions
	GepObjVar (NodeID i, PNODEK ty=GepObjNode)
	Constructor to create empty GepObjVar (for SVFIRReader/deserialization)

Private Attributes
APOffset	apOffset = 0

const BaseObjVar *	base

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 }

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.

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

Constructor & Destructor Documentation

◆ GepObjVar() [1/2]

SVF::GepObjVar::GepObjVar	(	NodeID	i,
		PNODEK	ty = `GepObjNode`
	)

inlineprivate

Constructor to create empty GepObjVar (for SVFIRReader/deserialization)

Definition at line 738 of file SVFVariables.h.

738: ObjVar(i, ty), base{} {}

SVF::GepObjVar::base

const BaseObjVar * base

Definition SVFVariables.h:734

SVF::ObjVar::ObjVar

ObjVar(NodeID i, PNODEK ty=ObjNode)

Constructor to create an empty ObjVar (for SVFIRReader/deserialization)

Definition SVFVariables.h:312

SVF::IRBuilder

llvm::IRBuilder IRBuilder

Definition BasicTypes.h:74

◆ GepObjVar() [2/2]

SVF::GepObjVar::GepObjVar	(	const BaseObjVar *	baseObj,
		NodeID	i,
		const APOffset &	apOffset,
		PNODEK	ty = `GepObjNode`
	)

inline

Constructor.

Definition at line 766 of file SVFVariables.h.

        : ObjVar(i, baseObj->getType(), ty), apOffset(apOffset), base(baseObj)
    {
    }

Member Function Documentation

◆ classof() [1/5]

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

inlinestatic

Definition at line 755 of file SVFVariables.h.

    {
        return node->getNodeKind() == SVFVar::GepObjNode;
    }

◆ classof() [2/5]

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

inlinestatic

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

Definition at line 743 of file SVFVariables.h.

    {
        return true;
    }

◆ classof() [3/5]

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

inlinestatic

Definition at line 747 of file SVFVariables.h.

    {
        return node->getNodeKind() == SVFVar::GepObjNode;
    }

◆ classof() [4/5]

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

inlinestatic

Definition at line 759 of file SVFVariables.h.

    {
        return node->getNodeKind() == SVFVar::GepObjNode;
    }

◆ classof() [5/5]

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

inlinestatic

Definition at line 751 of file SVFVariables.h.

    {
        return node->getNodeKind() == SVFVar::GepObjNode;
    }

◆ getBaseNode()

NodeID SVF::GepObjVar::getBaseNode ( void ) const

inline

Return the base object from which this GEP node came from.

Definition at line 779 of file SVFVariables.h.

    {
        return base->getId();
    }

◆ getBaseObj()

const BaseObjVar * SVF::GepObjVar::getBaseObj ( ) const

inline

Definition at line 784 of file SVFVariables.h.

    {
        return base;
    }

◆ getConstantFieldIdx()

APOffset SVF::GepObjVar::getConstantFieldIdx ( ) const

inline

offset of the mem object

Definition at line 773 of file SVFVariables.h.

    {
        return apOffset;
    }

◆ getFunction()

virtual const FunObjVar * SVF::GepObjVar::getFunction ( ) const

inlinevirtual

Get containing function, or null for globals/constants.

Reimplemented from SVF::SVFVar.

Definition at line 799 of file SVFVariables.h.

    {
        return base->getFunction();
    }

◆ getType()

const SVFType * GepObjVar::getType ( ) const

inlinevirtual

Return the type of this gep object.

Reimplemented from SVF::SVFValue.

Definition at line 213 of file SVFVariables.cpp.

{
    return SVFIR::getPAG()->getFlatternedElemType(type, apOffset);
}

◆ getValueName()

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

inlinevirtual

Return name of a LLVM value.

Reimplemented from SVF::ObjVar.

Definition at line 794 of file SVFVariables.h.

    {
        return getName() + "_" + std::to_string(apOffset);
    }

◆ isConstDataOrAggData()

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

inlinevirtual

Check if this variable represents constant/aggregate data.

Reimplemented from SVF::SVFVar.

Definition at line 811 of file SVFVariables.h.

    {
        return base->isConstDataOrAggData();
    }

◆ isConstDataOrAggDataButNotNullPtr()

virtual bool SVF::GepObjVar::isConstDataOrAggDataButNotNullPtr ( ) const

inlinevirtual

Check if this variable represents constant data/metadata but not null pointer.

Reimplemented from SVF::SVFVar.

Definition at line 816 of file SVFVariables.h.

    {
        return base->isConstDataOrAggDataButNotNullPtr();
    }

◆ isPointer()

virtual bool SVF::GepObjVar::isPointer ( ) const

inlinevirtual

Check if this variable represents a pointer.

Reimplemented from SVF::SVFVar.

Definition at line 821 of file SVFVariables.h.

    {
        return base->isPointer();
    }

◆ ptrInUncalledFunction()

virtual bool SVF::GepObjVar::ptrInUncalledFunction ( ) const

inlinevirtual

Check if this pointer is in an uncalled function.

Reimplemented from SVF::SVFVar.

Definition at line 806 of file SVFVariables.h.

    {
        return base->ptrInUncalledFunction();
    }

◆ toString()

const std::string GepObjVar::toString ( ) const

virtual

Get string representation.

Reimplemented from SVF::ObjVar.

Definition at line 200 of file SVFVariables.cpp.

{
    std::string str;
    std::stringstream rawstr(str);
    rawstr << "GepObjVar ID: " << getId() << " with offset_" + std::to_string(apOffset);
    if (Options::ShowSVFIRValue())
    {
        rawstr << "\n";
        rawstr << getBaseObj()->valueOnlyToString();
    }
    return rawstr.str();
}

Friends And Related Symbol Documentation

◆ SVFIRReader

friend class SVFIRReader

friend

Definition at line 729 of file SVFVariables.h.

◆ SVFIRWriter

friend class SVFIRWriter

friend

Definition at line 728 of file SVFVariables.h.

Member Data Documentation

◆ apOffset

APOffset SVF::GepObjVar::apOffset = 0

private

Definition at line 732 of file SVFVariables.h.

◆ base

const BaseObjVar* SVF::GepObjVar::base

private

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

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GepObjVar() [1/2]

◆ GepObjVar() [2/2]

Member Function Documentation

◆ classof() [1/5]

◆ classof() [2/5]

◆ classof() [3/5]

◆ classof() [4/5]

◆ classof() [5/5]

◆ getBaseNode()

◆ getBaseObj()

◆ getConstantFieldIdx()

◆ getFunction()

◆ getType()

◆ getValueName()

◆ isConstDataOrAggData()

◆ isConstDataOrAggDataButNotNullPtr()

◆ isPointer()

◆ ptrInUncalledFunction()

◆ toString()

Friends And Related Symbol Documentation

◆ SVFIRReader

◆ SVFIRWriter

Member Data Documentation

◆ apOffset

◆ base