#include <SVFValue.h>

Inheritance diagram for SVF::SVFValue:

Public Types
enum	SVFValKind { SVFVal , SVFFunc , SVFBB , SVFInst , SVFCall , SVFVCall , SVFGlob , SVFArg , SVFConst , SVFConstData , SVFConstInt , SVFConstFP , SVFNullPtr , SVFBlackHole , SVFMetaAsValue , SVFOther }

typedef s64_t	GNodeK

Public Member Functions
	SVFValue ()=delete

virtual	~SVFValue ()=default

GNodeK	getKind () const
	Get the type of this SVFValue.

const std::string &	getName () const

void	setName (const std::string &n)

void	setName (std::string &&n)

virtual const SVFType *	getType () const

bool	isConstDataOrAggData () const

bool	ptrInUncalledFunction () const

bool	isblackHole () const

bool	isNullPtr () const

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

virtual const std::string	getSourceLoc () const

std::string	toString () const
	Needs to be implemented by a SVF front end.

Protected Member Functions
	SVFValue (const SVFType *ty, SVFValKind k)
	Constructor without name.


void	setConstDataOrAggData ()

void	setPtrInUncalledFunction ()

Protected Attributes
const SVFType *	type
	Type of this SVFValue.

std::string	name
	Short name of value for printing & debugging.

std::string	sourceLoc

Private Attributes
GNodeK	kind
	used for classof

bool	ptrInUncalledFun
	true if this pointer is in an uncalled function

bool	constDataOrAggData
	true if this value is a ConstantData (e.g., numbers, string, floats) or a constantAggregate

Friends
class	SVFIRWriter

class	SVFIRReader

class	LLVMModuleSet

OutStream &	operator<< (OutStream &os, const SVFValue &value)
	Overloading operator << for dumping ICFG node ID.

Detailed Description

Definition at line 177 of file SVFValue.h.

Member Typedef Documentation

◆ GNodeK

typedef s64_t SVF::SVFValue::GNodeK

Definition at line 184 of file SVFValue.h.

Member Enumeration Documentation

◆ SVFValKind

enum SVF::SVFValue::SVFValKind

Enumerator
SVFVal
SVFFunc
SVFBB
SVFInst
SVFCall
SVFVCall
SVFGlob
SVFArg
SVFConst
SVFConstData
SVFConstInt
SVFConstFP
SVFNullPtr
SVFBlackHole
SVFMetaAsValue
SVFOther

Definition at line 186 of file SVFValue.h.

    {
        SVFVal,
        SVFFunc,
        SVFBB,
        SVFInst,
        SVFCall,
        SVFVCall,
        SVFGlob,
        SVFArg,
        SVFConst,
        SVFConstData,
        SVFConstInt,
        SVFConstFP,
        SVFNullPtr,
        SVFBlackHole,
        SVFMetaAsValue,
        SVFOther
    };

Constructor & Destructor Documentation

◆ SVFValue() [1/2]

SVF::SVFValue::SVFValue	(	const SVFType *	ty,
		SVFValKind	k
	)

inlineprotected

Constructor without name.

Definition at line 216 of file SVFValue.h.

        : kind(k), ptrInUncalledFun(false),
          constDataOrAggData(SVFConstData == k), type(ty), sourceLoc("NoLoc")
    {
    }

◆ SVFValue() [2/2]

SVF::SVFValue::SVFValue ( )

delete

◆ ~SVFValue()

virtual SVF::SVFValue::~SVFValue ( )

virtualdefault

Member Function Documentation

◆ getKind()

GNodeK SVF::SVFValue::getKind ( ) const

inline

Get the type of this SVFValue.

Definition at line 238 of file SVFValue.h.

    {
        return kind;
    }

◆ getName()

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

inline

Definition at line 243 of file SVFValue.h.

    {
        return name;
    }

◆ getSourceLoc()

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

inlinevirtual

Definition at line 280 of file SVFValue.h.

    {
        return sourceLoc;
    }

◆ getType()

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

inlinevirtual

Definition at line 256 of file SVFValue.h.

    {
        return type;
    }

◆ isblackHole()

bool SVF::SVFValue::isblackHole ( ) const

inline

Definition at line 268 of file SVFValue.h.

    {
        return getKind() == SVFBlackHole;;
    }

◆ isConstDataOrAggData()

bool SVF::SVFValue::isConstDataOrAggData ( ) const

inline

Definition at line 260 of file SVFValue.h.

    {
        return constDataOrAggData;
    }

◆ isNullPtr()

bool SVF::SVFValue::isNullPtr ( ) const

inline

Definition at line 272 of file SVFValue.h.

    {
        return getKind() == SVFNullPtr;
    }

◆ ptrInUncalledFunction()

bool SVF::SVFValue::ptrInUncalledFunction ( ) const

inline

Definition at line 264 of file SVFValue.h.

    {
        return ptrInUncalledFun;
    }

◆ setConstDataOrAggData()

void SVF::SVFValue::setConstDataOrAggData ( )

inlineprotected

attributes to be set only through Module builders e.g., LLVMModule

Definition at line 224 of file SVFValue.h.

    {
        constDataOrAggData = true;
    }

◆ setName() [1/2]

void SVF::SVFValue::setName ( const std::string & n )

inline

Definition at line 247 of file SVFValue.h.

    {
        name = n;
    }

◆ setName() [2/2]

void SVF::SVFValue::setName ( std::string && n )

inline

Definition at line 251 of file SVFValue.h.

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

◆ setPtrInUncalledFunction()

void SVF::SVFValue::setPtrInUncalledFunction ( )

inlineprotected

Definition at line 228 of file SVFValue.h.

    {
        ptrInUncalledFun = true;
    }

◆ setSourceLoc()

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

inlinevirtual

Definition at line 276 of file SVFValue.h.

    {
        sourceLoc = sourceCodeInfo;
    }

◆ toString()

std::string SVF::SVFValue::toString ( ) const

Needs to be implemented by a SVF front end.

Definition at line 721 of file LLVMUtil.cpp.

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

Friends And Related Symbol Documentation

◆ LLVMModuleSet

friend class LLVMModuleSet

friend

Definition at line 181 of file SVFValue.h.

◆ operator<<

OutStream & operator<<	(	OutStream &	os,
		const SVFValue &	value
	)

friend

Overloading operator << for dumping ICFG node ID.

Definition at line 290 of file SVFValue.h.

    {
        return os << value.toString();
    }

◆ SVFIRReader

friend class SVFIRReader

friend

Definition at line 180 of file SVFValue.h.

◆ SVFIRWriter

friend class SVFIRWriter

friend

Definition at line 179 of file SVFValue.h.

Member Data Documentation

◆ constDataOrAggData

bool SVF::SVFValue::constDataOrAggData

private

true if this value is a ConstantData (e.g., numbers, string, floats) or a constantAggregate

Definition at line 209 of file SVFValue.h.

◆ kind

GNodeK SVF::SVFValue::kind

private

used for classof

Definition at line 207 of file SVFValue.h.

◆ name

std::string SVF::SVFValue::name

protected

Short name of value for printing & debugging.

Definition at line 213 of file SVFValue.h.

◆ ptrInUncalledFun

bool SVF::SVFValue::ptrInUncalledFun

private

true if this pointer is in an uncalled function

Definition at line 208 of file SVFValue.h.

◆ sourceLoc

std::string SVF::SVFValue::sourceLoc

protected

Source code information of this value

Definition at line 214 of file SVFValue.h.

◆ type

const SVFType* SVF::SVFValue::type

protected

Type of this SVFValue.

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ GNodeK

Member Enumeration Documentation

◆ SVFValKind

Constructor & Destructor Documentation

◆ SVFValue() [1/2]

◆ SVFValue() [2/2]

◆ ~SVFValue()

Member Function Documentation

◆ getKind()

◆ getName()

◆ getSourceLoc()

◆ getType()

◆ isblackHole()

◆ isConstDataOrAggData()

◆ isNullPtr()

◆ ptrInUncalledFunction()

◆ setConstDataOrAggData()

◆ setName() [1/2]

◆ setName() [2/2]

◆ setPtrInUncalledFunction()

◆ setSourceLoc()

◆ toString()

Friends And Related Symbol Documentation

◆ LLVMModuleSet

◆ operator<<

◆ SVFIRReader

◆ SVFIRWriter

Member Data Documentation

◆ constDataOrAggData

◆ kind

◆ name

◆ ptrInUncalledFun

◆ sourceLoc

◆ type