Class representing a function argument variable in the SVFIR. More...

#include <SVFVariables.h>

Inheritance diagram for SVF::ArgValVar:

Public Member Functions
	ArgValVar (NodeID i, u32_t argNo, const ICFGNode icn, const FunObjVar callGraphNode, const SVFType *svfType)
	Constructor.

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

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

const FunObjVar *	getParent () const

u32_t	getArgNo () const

bool	isArgOfUncalledFunction () const

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

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

Public Member Functions inherited from SVF::ValVar
	ValVar (NodeID i, const SVFType svfType, const ICFGNode node, PNODEK ty=ValNode)
	Constructor.

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

const ICFGNode *	getICFGNode () const

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

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

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

static bool	classof (const ValVar *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::ValVar
static bool	classof (const ValVar *)
	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
	ArgValVar (NodeID i, PNODEK ty=ArgValNode)
	Constructor to create function argument (for SVFIRReader/deserialization)

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

Protected Member Functions inherited from SVF::SVFVar
	SVFVar (NodeID i, PNODEK k)
	Empty constructor for deserialization.

Private Attributes
const FunObjVar *	cgNode

u32_t	argNo

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 function argument variable in the SVFIR.

This class models function argument in the program analysis. It extends ValVar to specifically handle function argument.

Definition at line 355 of file SVFVariables.h.

Constructor & Destructor Documentation

◆ ArgValVar() [1/2]

SVF::ArgValVar::ArgValVar	(	NodeID	i,
		PNODEK	ty = `ArgValNode`
	)

inlineprotected

Constructor to create function argument (for SVFIRReader/deserialization)

Definition at line 366 of file SVFVariables.h.

366: ValVar(i, ty) {}

SVF::ValVar::ValVar

ValVar(NodeID i, PNODEK ty=ValNode)

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

Definition SVFVariables.h:258

SVF::IRBuilder

llvm::IRBuilder IRBuilder

Definition BasicTypes.h:74

◆ ArgValVar() [2/2]

ArgValVar::ArgValVar	(	NodeID	i,
		u32_t	argNo,
		const ICFGNode *	icn,
		const FunObjVar *	callGraphNode,
		const SVFType *	svfType
	)

Constructor.

Definition at line 118 of file SVFVariables.cpp.

    : ValVar(i, svfType, icn, ArgValNode),
      cgNode(callGraphNode), argNo(argNo)
{
 
}

Member Function Documentation

◆ classof() [1/5]

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

inlinestatic

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

Definition at line 371 of file SVFVariables.h.

    {
        return true;
    }

◆ classof() [2/5]

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

inlinestatic

Definition at line 383 of file SVFVariables.h.

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

◆ classof() [3/5]

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

inlinestatic

Definition at line 387 of file SVFVariables.h.

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

◆ classof() [4/5]

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

inlinestatic

Definition at line 379 of file SVFVariables.h.

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

◆ classof() [5/5]

static bool SVF::ArgValVar::classof ( const ValVar * node )

inlinestatic

Definition at line 375 of file SVFVariables.h.

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

◆ getArgNo()

u32_t SVF::ArgValVar::getArgNo ( ) const

inline

Return the index of this formal argument in its containing function. For example in "void foo(int a, float b)" a is 0 and b is 1.

Definition at line 409 of file SVFVariables.h.

    {
        return argNo;
    }

◆ getFunction()

const FunObjVar * ArgValVar::getFunction ( ) const

virtual

Get containing function, or null for globals/constants.

Reimplemented from SVF::ValVar.

Definition at line 126 of file SVFVariables.cpp.

{
    return getParent();
}

◆ getParent()

const FunObjVar * ArgValVar::getParent ( ) const

Definition at line 131 of file SVFVariables.cpp.

{
    return cgNode;
}

◆ getValueName()

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

inlinevirtual

Return name of a LLVM value.

Implements SVF::SVFVar.

Definition at line 398 of file SVFVariables.h.

    {
        return getName() + " (argument valvar)";
    }

◆ isArgOfUncalledFunction()

bool ArgValVar::isArgOfUncalledFunction ( ) const

Definition at line 136 of file SVFVariables.cpp.

{
    return getFunction()->isUncalledFunction();
}

◆ isPointer()

bool ArgValVar::isPointer ( ) const

virtual

Check if this variable represents a pointer.

Reimplemented from SVF::SVFVar.

Definition at line 141 of file SVFVariables.cpp.

{
    return cgNode->getArg(argNo)->getType()->isPointerTy();
}

◆ toString()

const std::string ArgValVar::toString ( ) const

virtual

Get string representation.

Reimplemented from SVF::ValVar.

Definition at line 146 of file SVFVariables.cpp.

{
    std::string str;
    std::stringstream rawstr(str);
    rawstr << "ArgValVar 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 358 of file SVFVariables.h.

◆ SVFIRWriter

friend class SVFIRWriter

friend

Definition at line 357 of file SVFVariables.h.

Member Data Documentation

◆ argNo

u32_t SVF::ArgValVar::argNo

private

Definition at line 362 of file SVFVariables.h.

◆ cgNode

const FunObjVar* SVF::ArgValVar::cgNode

private

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

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ArgValVar() [1/2]

◆ ArgValVar() [2/2]

Member Function Documentation

◆ classof() [1/5]

◆ classof() [2/5]

◆ classof() [3/5]

◆ classof() [4/5]

◆ classof() [5/5]

◆ getArgNo()

◆ getFunction()

◆ getParent()

◆ getValueName()

◆ isArgOfUncalledFunction()

◆ isPointer()

◆ toString()

Friends And Related Symbol Documentation

◆ SVFIRReader

◆ SVFIRWriter

Member Data Documentation

◆ argNo

◆ cgNode