#include <GenericGraph.h>

Inheritance diagram for SVF::SVFBaseNode:

Public Types
enum	GNodeK { IntraBlock , GlobalBlock , FunEntryBlock , FunExitBlock , FunCallBlock , FunRetBlock , ValNode , FunValNode , GepValNode , RetNode , VarargNode , DummyValNode , ObjNode , GepObjNode , BaseObjNode , FunObjNode , HeapObjNode , StackObjNode , 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 }

Public Member Functions
	SVFBaseNode (NodeID i, GNodeK k, SVFType *ty=nullptr)

NodeID	getId () const
	Get ID.

GNodeK	getNodeKind () const
	Get node kind.

virtual const SVFType *	getType () const

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

virtual const std::string	getSourceLoc () const

const std::string	valueOnlyToString () 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	isObjVarKinds (GNodeK n)

static bool	isBaseObjVarKinds (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	sourceLoc
	Source code information of this value.

Detailed Description

Definition at line 137 of file GenericGraph.h.

Member Enumeration Documentation

◆ GNodeK

enum SVF::SVFBaseNode::GNodeK

Enumerator
IntraBlock
GlobalBlock
FunEntryBlock
FunExitBlock
FunCallBlock
FunRetBlock
ValNode
FunValNode
GepValNode
RetNode
VarargNode
DummyValNode
ObjNode
GepObjNode
BaseObjNode
FunObjNode
HeapObjNode
StackObjNode
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

Definition at line 142 of file GenericGraph.h.

    {
        // ┌── ICFGNode: Classes of inter-procedural and intra-procedural control flow graph nodes
        IntraBlock,       // ├──Represents a node within a single procedure
        GlobalBlock,      // ├──Represents a global-level block
        // │   └─ InterICFGNode: Classes of inter-procedural control flow graph nodes
        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 top-level variables (ValVar) and address-taken variables (ObjVar)
        // │   └── ValVar: Classes of top-level variable nodes
        ValNode,          // ├──Represents a standard value variable
        FunValNode,       // ├──Represents a Function value variable
        GepValNode,       // ├──Represents a GEP value variable
        RetNode,          // ├──Represents a return value node
        VarargNode,       // ├──Represents a variadic argument node
        DummyValNode,     // ├──Dummy node for uninitialized values
        // │   └── ObjVar: Classes of object variable nodes
        ObjNode,          // ├──Represents an object variable
        GepObjNode,       // ├──Represents a GEP object variable
        // │        └── BaseObjVar: Classes of base object nodes
        BaseObjNode,      // ├──Represents a base object node
        FunObjNode,       // ├──Types of function object
        HeapObjNode,      // ├──Types of heap object
        StackObjNode,     // ├──Types of stack object
        DummyObjNode,     // ├──Dummy node for uninitialized objects
        // └────────
 
        // ┌── VFGNode: Classes of Value Flow Graph (VFG) node kinds with operations
        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
        // │   └── ArgumentVFGNode: Classes of argument nodes in VFG
        FRet,             // ├──Represents a function return value
        ARet,             // ├──Represents an argument return value
        AParm,            // ├──Represents an argument parameter
        FParm,            // ├──Represents a function parameter
        // │   └── StmtVFGNode: Classes of statement nodes in VFG
        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
        // │   └── PHIVFGNode: Classes of PHI nodes in VFG
        TPhi,             // ├──Represents a type-based PHI node
        TIntraPhi,        // ├──Represents an intra-procedural PHI node
        TInterPhi,        // ├──Represents an inter-procedural PHI node
        // │   └── MRSVFGNode: Classes of Memory-related SVFG nodes
        FPIN,             // ├──Function parameter input
        FPOUT,            // ├──Function parameter output
        APIN,             // ├──Argument parameter input
        APOUT,            // ├──Argument parameter output
        // │        └── MSSAPHISVFGNode: Classes of Mem SSA PHI nodes for SVFG
        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
        DCHNodeKd,     // DCHG node
        OtherKd        // Other node kind
    };

Constructor & Destructor Documentation

◆ SVFBaseNode()

SVF::SVFBaseNode::SVFBaseNode	(	NodeID	i,
		GNodeK	k,
		SVFType *	ty = `nullptr`
	)

inline

Definition at line 219 of file GenericGraph.h.

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

Member Function Documentation

◆ getId()

NodeID SVF::SVFBaseNode::getId ( ) const

inline

Get ID.

Definition at line 225 of file GenericGraph.h.

    {
        return id;
    }

◆ getNodeKind()

GNodeK SVF::SVFBaseNode::getNodeKind ( ) const

inline

Get node kind.

Definition at line 231 of file GenericGraph.h.

    {
        return nodeKind;
    }

◆ getSourceLoc()

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

inlinevirtual

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

Definition at line 246 of file GenericGraph.h.

    {
        return sourceLoc;
    }

◆ getType()

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

inlinevirtual

Reimplemented in SVF::SVFVar, SVF::ObjVar, SVF::GepValVar, and SVF::GepObjVar.

Definition at line 236 of file GenericGraph.h.

    {
        return type;
    }

◆ isArgumentVFGNodeKinds()

static bool SVF::SVFBaseNode::isArgumentVFGNodeKinds ( GNodeK n )

inlinestaticprotected

Definition at line 320 of file GenericGraph.h.

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

◆ isBaseObjVarKinds()

static bool SVF::SVFBaseNode::isBaseObjVarKinds ( GNodeK n )

inlinestaticprotected

Definition at line 304 of file GenericGraph.h.

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

◆ isICFGNodeKinds()

static bool SVF::SVFBaseNode::isICFGNodeKinds ( GNodeK n )

inlinestaticprotected

Helper functions to check node kinds.

Definition at line 263 of file GenericGraph.h.

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

◆ isInterICFGNodeKind()

static bool SVF::SVFBaseNode::isInterICFGNodeKind ( GNodeK n )

inlinestaticprotected

Definition at line 271 of file GenericGraph.h.

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

◆ isMRSVFGNodeKinds()

static bool SVF::SVFBaseNode::isMRSVFGNodeKinds ( GNodeK n )

inlinestaticprotected

Definition at line 344 of file GenericGraph.h.

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

◆ isMSSAPHISVFGNodeKinds()

static bool SVF::SVFBaseNode::isMSSAPHISVFGNodeKinds ( GNodeK n )

inlinestaticprotected

Definition at line 352 of file GenericGraph.h.

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

◆ isObjVarKinds()

static bool SVF::SVFBaseNode::isObjVarKinds ( GNodeK n )

inlinestaticprotected

Definition at line 296 of file GenericGraph.h.

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

◆ isPHIVFGNodeKinds()

static bool SVF::SVFBaseNode::isPHIVFGNodeKinds ( GNodeK n )

inlinestaticprotected

Definition at line 336 of file GenericGraph.h.

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

◆ isStmtVFGNodeKinds()

static bool SVF::SVFBaseNode::isStmtVFGNodeKinds ( GNodeK n )

inlinestaticprotected

Definition at line 328 of file GenericGraph.h.

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

◆ isSVFVarKind()

static bool SVF::SVFBaseNode::isSVFVarKind ( GNodeK n )

inlinestaticprotected

Definition at line 279 of file GenericGraph.h.

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

◆ isValVarKinds()

static bool SVF::SVFBaseNode::isValVarKinds ( GNodeK n )

inlinestaticprotected

Definition at line 288 of file GenericGraph.h.

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

◆ isVFGNodeKinds()

static bool SVF::SVFBaseNode::isVFGNodeKinds ( GNodeK n )

inlinestaticprotected

Definition at line 312 of file GenericGraph.h.

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

◆ setSourceLoc()

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

inlinevirtual

Definition at line 241 of file GenericGraph.h.

    {
        sourceLoc = sourceCodeInfo;
    }

◆ valueOnlyToString()

const std::string SVF::SVFBaseNode::valueOnlyToString ( ) const

Definition at line 746 of file LLVMUtil.cpp.

{
    std::string str;
    llvm::raw_string_ostream rawstr(str);
    if (const SVF::PTACallGraphNode* fun = SVFUtil::dyn_cast<PTACallGraphNode>(this))
    {
        rawstr << "Function: " << fun->getFunction()->getName() << " ";
    }
    else
    {
        auto llvmVal = LLVMModuleSet::getLLVMModuleSet()->getLLVMValue(this);
        if (llvmVal)
            rawstr << " " << *llvmVal << " ";
        else
            rawstr << " No llvmVal found";
    }
    rawstr << getSourceLoc();
    return rawstr.str();
}

Member Data Documentation

◆ id

NodeID SVF::SVFBaseNode::id

protected

Node ID.

Definition at line 255 of file GenericGraph.h.

◆ nodeKind

GNodeK SVF::SVFBaseNode::nodeKind

protected

Node kind.

Definition at line 256 of file GenericGraph.h.

◆ sourceLoc

std::string SVF::SVFBaseNode::sourceLoc

protected

Source code information of this value.

Definition at line 259 of file GenericGraph.h.

◆ type

const SVFType* SVF::SVFBaseNode::type

protected

SVF type.

Definition at line 257 of file GenericGraph.h.

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

/home/runner/work/SVF/SVF/svf/include/Graphs/GenericGraph.h
/home/runner/work/SVF/SVF/svf-llvm/lib/LLVMUtil.cpp

Public Types

Public Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ GNodeK

Constructor & Destructor Documentation

◆ SVFBaseNode()

Member Function Documentation

◆ getId()

◆ getNodeKind()

◆ getSourceLoc()

◆ getType()

◆ isArgumentVFGNodeKinds()

◆ isBaseObjVarKinds()

◆ isICFGNodeKinds()

◆ isInterICFGNodeKind()

◆ isMRSVFGNodeKinds()

◆ isMSSAPHISVFGNodeKinds()

◆ isObjVarKinds()

◆ isPHIVFGNodeKinds()

◆ isStmtVFGNodeKinds()

◆ isSVFVarKind()

◆ isValVarKinds()

◆ isVFGNodeKinds()

◆ setSourceLoc()

◆ valueOnlyToString()

Member Data Documentation

◆ id

◆ nodeKind

◆ sourceLoc

◆ type