#include <SVFValue.h>

Inheritance diagram for SVF::SVFValue:

Public Types

enum GNodeK {
IntraBlock , GlobalBlock , FunEntryBlock , FunExitBlock ,
FunCallBlock , FunRetBlock , ValNode , ArgValNode ,
FunValNode , GepValNode , RetValNode , VarargValNode ,
GlobalValNode , ConstDataValNode , BlackHoleValNode , ConstFPValNode ,
ConstIntValNode , ConstNullptrValNode , DummyValNode , IntrinsicValNode ,
AsmPCValNode , ObjNode , GepObjNode , BaseObjNode ,
FunObjNode , HeapObjNode , StackObjNode , GlobalObjNode ,
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 ,
BasicBlockKd , OtherKd
}

Public Member Functions
	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
const bool	hasLLVMValue () const

Static Protected Member Functions
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
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 42 of file SVFValue.h.

Member Enumeration Documentation

◆ GNodeK

enum SVF::SVFValue::GNodeK

Enumerator
IntraBlock
GlobalBlock
FunEntryBlock
FunExitBlock
FunCallBlock
FunRetBlock
ValNode
ArgValNode
FunValNode
GepValNode
RetValNode
VarargValNode
GlobalValNode
ConstDataValNode
BlackHoleValNode
ConstFPValNode
ConstIntValNode
ConstNullptrValNode
DummyValNode
IntrinsicValNode
AsmPCValNode
ObjNode
GepObjNode
BaseObjNode
FunObjNode
HeapObjNode
StackObjNode
GlobalObjNode
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
BasicBlockKd
OtherKd

Definition at line 47 of file SVFValue.h.

    {
        // ┌─────────────────────────────────────────────────────────────────────────┐
        // │ ICFGNode: Classes of inter-procedural and intra-procedural control flow │
        // │ graph nodes (Parent class: ICFGNode)                                   │
        // └─────────────────────────────────────────────────────────────────────────┘
        IntraBlock,       // ├── Represents a node within a single procedure
        GlobalBlock,      // ├── Represents a global-level block
        // │   └─ Subclass: InterICFGNode
        FunEntryBlock,    // │   ├── Entry point of a function
        FunExitBlock,     // │   ├── Exit point of a function
        FunCallBlock,     // │   ├── Call site in the function
        FunRetBlock,      // │   └── Return site in the function
 
        // ┌─────────────────────────────────────────────────────────────────────────┐
        // │ SVFVar: Classes of variable nodes (Parent class: SVFVar)               │
        // │   Includes two main subclasses: ValVar and ObjVar                      │
        // └─────────────────────────────────────────────────────────────────────────┘
        // └─ Subclass: ValVar (Top-level variable nodes)
        ValNode,                 // ├── Represents a standard value variable
        ArgValNode,              // ├── Represents an argument value variable
        FunValNode,              // ├── Represents a function value variable
        GepValNode,              // ├── Represents a GEP value variable
        RetValNode,              // ├── Represents a return value node
        VarargValNode,           // ├── Represents a variadic argument node
        GlobalValNode,           // ├── Represents a global variable node
        // │   └─ Subclass: ConstDataValVar
        ConstDataValNode,        // │   ├── Represents a constant data variable
        BlackHoleValNode,        // │   ├── Represents a black hole node
        ConstFPValNode,          // │   ├── Represents a constant floating-point value node
        ConstIntValNode,         // │   ├── Represents a constant integer value node
        ConstNullptrValNode,     // │   └── Represents a constant nullptr value node
        // │   └─ Subclass: DummyValVar
        DummyValNode,            // │   └── Dummy node for uninitialized values
        IntrinsicValNode,        // │   └── LLVM intrinsic call instruction (e.g. llvm.dbg.declare)
        AsmPCValNode,            // │   └── InlineAsm, DSOLocalEquivalent, NoCFIValue
 
        // └─ Subclass: ObjVar (Object variable nodes)
        ObjNode,                 // ├── Represents an object variable
        // │   └─ Subclass: GepObjVar
        GepObjNode,              // │   ├── Represents a GEP object variable
        // │   └─ Subclass: BaseObjVar
        BaseObjNode,             // │   ├── Represents a base object node
        FunObjNode,              // │   ├── Represents a function object
        HeapObjNode,             // │   ├── Represents a heap object
        StackObjNode,            // │   ├── Represents a stack object
        GlobalObjNode,           // │   ├── Represents a global object
        // │   └─ Subclass: ConstDataObjVar
        ConstDataObjNode,        // │   ├── Represents a constant data object
        ConstFPObjNode,          // │   ├── Represents a constant floating-point object
        ConstIntObjNode,         // │   ├── Represents a constant integer object
        ConstNullptrObjNode,     // │   └── Represents a constant nullptr object
        // │   └─ Subclass: DummyObjVar
        DummyObjNode,            // │   └── Dummy node for uninitialized objects
 
        // ┌─────────────────────────────────────────────────────────────────────────┐
        // │ VFGNode: Classes of Value Flow Graph (VFG) node kinds (Parent class:   │
        // │ VFGNode)                                                               │
        // │   Includes operation nodes and specialized subclasses                  │
        // └─────────────────────────────────────────────────────────────────────────┘
        Cmp,              // ├── Represents a comparison operation
        BinaryOp,         // ├── Represents a binary operation
        UnaryOp,          // ├── Represents a unary operation
        Branch,           // ├── Represents a branch operation
        DummyVProp,       // ├── Dummy node for value propagation
        NPtr,             // ├── Represents a null pointer operation
        // │   └─ Subclass: ArgumentVFGNode
        FRet,             // │   ├── Represents a function return value
        ARet,             // │   ├── Represents an argument return value
        AParm,            // │   ├── Represents an argument parameter
        FParm,            // │   └── Represents a function parameter
        // │   └─ Subclass: StmtVFGNode
        Addr,             // │   ├── Represents an address operation
        Copy,             // │   ├── Represents a copy operation
        Gep,              // │   ├── Represents a GEP operation
        Store,            // │   ├── Represents a store operation
        Load,             // │   └── Represents a load operation
        // │   └─ Subclass: PHIVFGNode
        TPhi,             // │   ├── Represents a type-based PHI node
        TIntraPhi,        // │   ├── Represents an intra-procedural PHI node
        TInterPhi,        // │   └── Represents an inter-procedural PHI node
        // │   └─ Subclass: MRSVFGNode
        FPIN,             // │   ├── Function parameter input
        FPOUT,            // │   ├── Function parameter output
        APIN,             // │   ├── Argument parameter input
        APOUT,            // │   └── Argument parameter output
        // │       └─ Subclass: MSSAPHISVFGNode
        MPhi,             // │       ├── Memory PHI node
        MIntraPhi,        // │       ├── Intra-procedural memory PHI node
        MInterPhi,        // │       └── Inter-procedural memory PHI node
 
        // ┌─────────────────────────────────────────────────────────────────────────┐
        // │ Additional specific graph node types                                   │
        // └─────────────────────────────────────────────────────────────────────────┘
        CallNodeKd,       // Callgraph node
        CDNodeKd,         // Control dependence graph node
        CFLNodeKd,        // CFL graph node
        CHNodeKd,         // Class hierarchy graph node
        ConstraintNodeKd, // Constraint graph node
        TCTNodeKd,        // Thread creation tree node
        BasicBlockKd,     // Basic block node
        OtherKd           // Other node kind
    };

Constructor & Destructor Documentation

◆ SVFValue()

SVF::SVFValue::SVFValue	(	NodeID	i,
		GNodeK	k,
		const SVFType *	ty = nullptr )

inline

Definition at line 152 of file SVFValue.h.

                                                             : id(i),nodeKind(k), type(ty)
    {
 
    }

Member Function Documentation

◆ getId()

NodeID SVF::SVFValue::getId ( ) const

inline

Get ID.

Definition at line 158 of file SVFValue.h.

    {
        return id;
    }

◆ getName()

virtual const std::string & SVF::SVFValue::getName ( ) const

inlinevirtual

Reimplemented in SVF::CallGraphNode, and SVF::CHNode.

Definition at line 184 of file SVFValue.h.

    {
        return name;
    }

◆ getNodeKind()

GNodeK SVF::SVFValue::getNodeKind ( ) const

inline

Get node kind.

Definition at line 164 of file SVFValue.h.

    {
        return nodeKind;
    }

◆ getSourceLoc()

virtual const std::string SVF::SVFValue::getSourceLoc ( ) const

inlinevirtual

Reimplemented in SVF::CallICFGNode, SVF::FunEntryICFGNode, SVF::FunExitICFGNode, SVF::GlobalICFGNode, and SVF::RetICFGNode.

Definition at line 194 of file SVFValue.h.

    {
        return sourceLoc;
    }

◆ getType()

virtual const SVFType * SVF::SVFValue::getType ( ) const

inlinevirtual

Reimplemented in SVF::BaseObjVar, SVF::GepObjVar, and SVF::GepValVar.

Definition at line 169 of file SVFValue.h.

    {
        return type;
    }

◆ hasLLVMValue()

SVF_WEAK const bool SVFValue::hasLLVMValue ( ) const

Definition at line 766 of file LLVMUtil.cpp.

{
    return LLVMModuleSet::getLLVMModuleSet()->hasLLVMValue(this);
 
}

◆ isArgumentVFGNodeKinds()

bool SVF::SVFValue::isArgumentVFGNodeKinds ( GNodeK n )

inlinestaticprotected

Definition at line 287 of file SVFValue.h.

    {
        static_assert(FParm - FRet == 3,
                      "The number of ArgumentVFGNodeKinds has changed, make "
                      "sure the range is correct");
        return n <= FParm && n >= FRet;
    }

◆ isBaseObjVarKinds()

bool SVF::SVFValue::isBaseObjVarKinds ( GNodeK n )

inlinestaticprotected

Definition at line 263 of file SVFValue.h.

    {
        static_assert(DummyObjNode - BaseObjNode == 9,
                      "The number of BaseObjVarKinds has changed, make sure the "
                      "range is correct");
        return n <= DummyObjNode && n >= BaseObjNode;
    }

◆ isConstantDataObjVarKinds()

bool SVF::SVFValue::isConstantDataObjVarKinds ( GNodeK n )

inlinestaticprotected

Definition at line 271 of file SVFValue.h.

    {
        static_assert(ConstNullptrObjNode - ConstDataObjNode == 3,
                      "The number of ConstantDataObjVarKinds has changed, make "
                      "sure the range is correct");
        return n <= ConstNullptrObjNode && n >= ConstDataObjNode;
    }

◆ isConstantDataValVar()

bool SVF::SVFValue::isConstantDataValVar ( GNodeK n )

inlinestaticprotected

Definition at line 247 of file SVFValue.h.

    {
        static_assert(ConstNullptrValNode - ConstDataValNode == 4,
                      "The number of ConstantDataValVarKinds has changed, make "
                      "sure the range is correct");
        return n <= ConstNullptrValNode && n >= ConstDataValNode;
    }

◆ isICFGNodeKinds()

bool SVF::SVFValue::isICFGNodeKinds ( GNodeK n )

inlinestaticprotected

Helper functions to check node kinds.

Definition at line 213 of file SVFValue.h.

    {
        static_assert(FunRetBlock - IntraBlock == 5,
                      "the number of ICFGNodeKinds has changed, make sure "
                      "the range is correct");
        return n <= FunRetBlock && n >= IntraBlock;
    }

◆ isInterICFGNodeKind()

bool SVF::SVFValue::isInterICFGNodeKind ( GNodeK n )

inlinestaticprotected

Definition at line 221 of file SVFValue.h.

    {
        static_assert(FunRetBlock - FunEntryBlock == 3,
                      "the number of InterICFGNodeKind has changed, make sure "
                      "the range is correct");
        return n <= FunRetBlock && n >= FunEntryBlock;
    }

◆ isMRSVFGNodeKinds()

bool SVF::SVFValue::isMRSVFGNodeKinds ( GNodeK n )

inlinestaticprotected

Definition at line 311 of file SVFValue.h.

    {
        static_assert(MInterPhi - FPIN == 6,
                      "The number of MRSVFGNodeKinds has changed, make sure "
                      "the range is correct");
        return n <= MInterPhi && n >= FPIN;
    }

◆ isMSSAPHISVFGNodeKinds()

bool SVF::SVFValue::isMSSAPHISVFGNodeKinds ( GNodeK n )

inlinestaticprotected

Definition at line 319 of file SVFValue.h.

    {
        static_assert(MInterPhi - MPhi == 2,
                      "The number of MSSAPHISVFGNodeKinds has changed, make "
                      "sure the range is correct");
        return n <= MInterPhi && n >= MPhi;
    }

◆ isObjVarKinds()

bool SVF::SVFValue::isObjVarKinds ( GNodeK n )

inlinestaticprotected

Definition at line 255 of file SVFValue.h.

    {
        static_assert(DummyObjNode - ObjNode == 11,
                      "The number of ObjVarKinds has changed, make sure the "
                      "range is correct");
        return n <= DummyObjNode && n >= ObjNode;
    }

◆ isPHIVFGNodeKinds()

bool SVF::SVFValue::isPHIVFGNodeKinds ( GNodeK n )

inlinestaticprotected

Definition at line 303 of file SVFValue.h.

    {
        static_assert(TInterPhi - TPhi == 2,
                      "The number of PHIVFGNodeKinds has changed, make sure "
                      "the range is correct");
        return n <= TInterPhi && n >= TPhi;
    }

◆ isStmtVFGNodeKinds()

bool SVF::SVFValue::isStmtVFGNodeKinds ( GNodeK n )

inlinestaticprotected

Definition at line 295 of file SVFValue.h.

    {
        static_assert(Load - Addr == 4,
                      "The number of StmtVFGNodeKinds has changed, make sure "
                      "the range is correct");
        return n <= Load && n >= Addr;
    }

◆ isSVFVarKind()

bool SVF::SVFValue::isSVFVarKind ( GNodeK n )

inlinestaticprotected

Definition at line 229 of file SVFValue.h.

    {
        static_assert(DummyObjNode - ValNode == 26,
                      "The number of SVFVarKinds has changed, make sure the "
                      "range is correct");
 
        return n <= DummyObjNode && n >= ValNode;
    }

◆ isValVarKinds()

bool SVF::SVFValue::isValVarKinds ( GNodeK n )

inlinestaticprotected

Definition at line 238 of file SVFValue.h.

    {
        static_assert(AsmPCValNode - ValNode == 14,
                      "The number of ValVarKinds has changed, make sure the "
                      "range is correct");
        return n <= AsmPCValNode && n >= ValNode;
    }

◆ isVFGNodeKinds()

bool SVF::SVFValue::isVFGNodeKinds ( GNodeK n )

inlinestaticprotected

Definition at line 279 of file SVFValue.h.

    {
        static_assert(MInterPhi - Cmp == 24,
                      "The number of VFGNodeKinds has changed, make sure the "
                      "range is correct");
        return n <= MInterPhi && n >= Cmp;
    }

◆ setName() [1/2]

virtual void SVF::SVFValue::setName ( const std::string & nameInfo )

inlinevirtual

Definition at line 174 of file SVFValue.h.

    {
        name = nameInfo;
    }

◆ setName() [2/2]

virtual void SVF::SVFValue::setName ( std::string && nameInfo )

inlinevirtual

Definition at line 179 of file SVFValue.h.

    {
        name = std::move(nameInfo);
    }

◆ setSourceLoc()

virtual void SVF::SVFValue::setSourceLoc ( const std::string & sourceCodeInfo )

inlinevirtual

Definition at line 189 of file SVFValue.h.

    {
        sourceLoc = sourceCodeInfo;
    }

◆ valueOnlyToString()

SVF_WEAK const std::string SVFValue::valueOnlyToString ( ) const

Definition at line 747 of file LLVMUtil.cpp.

{
    std::string str;
    llvm::raw_string_ostream rawstr(str);
    assert(
        !SVFUtil::isa<GepObjVar>(this) && !SVFUtil::isa<GepValVar>(this) &&
        !SVFUtil::isa<DummyObjVar>(this) &&!SVFUtil::isa<DummyValVar>(this) &&
        !SVFUtil::isa<BlackHoleValVar>(this) &&
        "invalid value, refer to their toString method");
    auto llvmVal =
        LLVMModuleSet::getLLVMModuleSet()->getLLVMValue(this);
    if (llvmVal)
        rawstr << " " << *llvmVal << " ";
    else
        rawstr << "";
    rawstr << getSourceLoc();
    return rawstr.str();
}

Member Data Documentation

◆ id

NodeID SVF::SVFValue::id

protected

Node ID.

Definition at line 204 of file SVFValue.h.

◆ name

std::string SVF::SVFValue::name

protected

Definition at line 208 of file SVFValue.h.

◆ nodeKind

GNodeK SVF::SVFValue::nodeKind

protected

Node kind.

Definition at line 205 of file SVFValue.h.

◆ sourceLoc

std::string SVF::SVFValue::sourceLoc

protected

Source code information of this value.

Definition at line 209 of file SVFValue.h.

◆ type

const SVFType* SVF::SVFValue::type

protected

SVF type.

Definition at line 206 of file SVFValue.h.

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

/home/runner/work/SVF/SVF/svf/include/SVFIR/SVFValue.h
/home/runner/work/SVF/SVF/svf-llvm/lib/LLVMUtil.cpp
/home/runner/work/SVF/SVF/svf/lib/SVFIR/SVFValue.cpp

Public Types

Public Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ GNodeK

Constructor & Destructor Documentation

◆ SVFValue()

Member Function Documentation

◆ getId()

◆ getName()

◆ getNodeKind()

◆ getSourceLoc()

◆ getType()

◆ hasLLVMValue()

◆ isArgumentVFGNodeKinds()

◆ isBaseObjVarKinds()

◆ isConstantDataObjVarKinds()

◆ isConstantDataValVar()

◆ isICFGNodeKinds()

◆ isInterICFGNodeKind()

◆ isMRSVFGNodeKinds()

◆ isMSSAPHISVFGNodeKinds()

◆ isObjVarKinds()

◆ isPHIVFGNodeKinds()

◆ isStmtVFGNodeKinds()

◆ isSVFVarKind()

◆ isValVarKinds()

◆ isVFGNodeKinds()

◆ setName() [1/2]

◆ setName() [2/2]

◆ setSourceLoc()

◆ valueOnlyToString()

Member Data Documentation

◆ id

◆ name

◆ nodeKind

◆ sourceLoc

◆ type