#include <SVFValue.h>

Inheritance diagram for SVF::SVFFunction:

Public Types
typedef std::vector< constSVFBasicBlock * >::const_iterator	const_iterator

typedef SVFLoopAndDomInfo::BBSet	BBSet

typedef SVFLoopAndDomInfo::BBList	BBList

typedef SVFLoopAndDomInfo::LoopBBs	LoopBBs

Public Types inherited from SVF::SVFValue
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
	SVFFunction (const SVFType ty, const SVFFunctionType ft, bool declare, bool intrinsic, bool addrTaken, bool varg, SVFLoopAndDomInfo *ld)

	SVFFunction (void)=delete

virtual	~SVFFunction ()

const CallGraphNode *	getCallGraphNode () const

SVFLoopAndDomInfo *	getLoopAndDomInfo ()

bool	isDeclaration () const

bool	isIntrinsic () const

bool	hasAddressTaken () const

const SVFFunctionType *	getFunctionType () const
	Returns the FunctionType.

const SVFType *	getReturnType () const
	Returns the FunctionType.

const SVFFunction *	getDefFunForMultipleModule () const

u32_t	arg_size () const

const SVFArgument *	getArg (u32_t idx) const

bool	isVarArg () const

bool	hasBasicBlock () const

const SVFBasicBlock *	getEntryBlock () const

const SVFBasicBlock *	getExitBB () const

void	setExitBlock (SVFBasicBlock *bb)

const SVFBasicBlock *	front () const

const SVFBasicBlock *	back () const

const_iterator	begin () const

const_iterator	end () const

const std::vector< const SVFBasicBlock * > &	getBasicBlockList () const

const std::vector< const SVFBasicBlock * > &	getReachableBBs () const

bool	isUncalledFunction () const

bool	hasReturn () const

void	getExitBlocksOfLoop (const SVFBasicBlock *bb, BBList &exitbbs) const

bool	hasLoopInfo (const SVFBasicBlock *bb) const

const LoopBBs &	getLoopInfo (const SVFBasicBlock *bb) const

const SVFBasicBlock *	getLoopHeader (const BBList &lp) const

bool	loopContainsBB (const BBList &lp, const SVFBasicBlock *bb) const

const Map< const SVFBasicBlock *, BBSet > &	getDomTreeMap () const

const Map< const SVFBasicBlock *, BBSet > &	getDomFrontierMap () const

bool	isLoopHeader (const SVFBasicBlock *bb) const

bool	dominate (const SVFBasicBlock bbKey, const SVFBasicBlock bbValue) const

bool	postDominate (const SVFBasicBlock bbKey, const SVFBasicBlock bbValue) const

Public Member Functions inherited from SVF::SVFValue
	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.

Static Public Member Functions
static bool	classof (const SVFValue *node)

Protected Member Functions
void	setCallGraphNode (CallGraphNode *cgn)
	call graph node for this function


void	addBasicBlock (const SVFBasicBlock *bb)
	attributes to be set only through Module builders e.g., LLVMModule

void	addArgument (SVFArgument *arg)

void	setIsUncalledFunction (bool uncalledFunction)

void	setIsNotRet (bool notRet)

void	setDefFunForMultipleModule (const SVFFunction *deffun)

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

void	setConstDataOrAggData ()

void	setPtrInUncalledFunction ()

Private Attributes
bool	isDecl

bool	intrinsic
	return true if this function does not have a body

bool	addrTaken
	return true if this function is an intrinsic function (e.g., llvm.dbg), which does not reside in the application code

bool	isUncalled
	return true if this function is address-taken (for indirect call purposes)

bool	isNotRet
	return true if this function is never called

bool	varArg
	return true if this function never returns

const SVFFunctionType *	funcType
	return true if this function supports variable arguments

SVFLoopAndDomInfo *	loopAndDom
	FunctionType, which is different from the type (PointerType) of this SVFFunction.

const SVFFunction *	realDefFun
	the loop and dominate information

std::vector< const SVFBasicBlock * >	allBBs
	the definition of a function across multiple modules

std::vector< const SVFArgument * >	allArgs
	all BasicBlocks of this function

SVFBasicBlock *	exitBlock
	all formal arguments of this function

const CallGraphNode *	callGraphNode
	a 'single' basic block having no successors and containing return instruction in a function

Friends
class	LLVMModuleSet

class	SVFIRWriter

class	SVFIRReader

class	SVFIRBuilder

Additional Inherited Members
Protected Attributes inherited from SVF::SVFValue
const SVFType *	type
	Type of this SVFValue.

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

std::string	sourceLoc

Detailed Description

Definition at line 297 of file SVFValue.h.

Member Typedef Documentation

◆ BBList

typedef SVFLoopAndDomInfo::BBList SVF::SVFFunction::BBList

Definition at line 307 of file SVFValue.h.

◆ BBSet

typedef SVFLoopAndDomInfo::BBSet SVF::SVFFunction::BBSet

Definition at line 306 of file SVFValue.h.

◆ const_iterator

typedef std::vector<constSVFBasicBlock*>::const_iterator SVF::SVFFunction::const_iterator

Definition at line 305 of file SVFValue.h.

◆ LoopBBs

typedef SVFLoopAndDomInfo::LoopBBs SVF::SVFFunction::LoopBBs

Definition at line 308 of file SVFValue.h.

Constructor & Destructor Documentation

◆ SVFFunction() [1/2]

SVFFunction::SVFFunction	(	const SVFType *	ty,
		const SVFFunctionType *	ft,
		bool	declare,
		bool	intrinsic,
		bool	addrTaken,
		bool	varg,
		SVFLoopAndDomInfo *	ld
	)

Definition at line 152 of file SVFValue.cpp.

    : SVFValue(ty, SVFValue::SVFFunc), isDecl(declare), intrinsic(intrinsic),
      addrTaken(adt), isUncalled(false), isNotRet(false), varArg(varg),
      funcType(ft), loopAndDom(ld), realDefFun(nullptr), exitBlock(nullptr)
{
}

◆ SVFFunction() [2/2]

SVF::SVFFunction::SVFFunction ( void )

delete

◆ ~SVFFunction()

SVFFunction::~SVFFunction ( )

virtual

Definition at line 161 of file SVFValue.cpp.

{
    for(const SVFBasicBlock* bb : allBBs)
        delete bb;
    for(const SVFArgument* arg : allArgs)
        delete arg;
    delete loopAndDom;
}

Member Function Documentation

◆ addArgument()

void SVF::SVFFunction::addArgument ( SVFArgument * arg )

inlineprotected

Definition at line 337 of file SVFValue.h.

    {
        allArgs.push_back(arg);
    }

◆ addBasicBlock()

void SVF::SVFFunction::addBasicBlock ( const SVFBasicBlock * bb )

inlineprotected

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

Definition at line 332 of file SVFValue.h.

    {
        allBBs.push_back(bb);
    }

◆ arg_size()

u32_t SVFFunction::arg_size ( ) const

Definition at line 170 of file SVFValue.cpp.

{
    return allArgs.size();
}

◆ back()

const SVFBasicBlock * SVF::SVFFunction::back ( ) const

inline

Carefully! 'back' is just the last basic block of function, but not necessarily a exit basic block more refer to: https://github.com/SVF-tools/SVF/pull/1262

Definition at line 437 of file SVFValue.h.

    {
        assert(hasBasicBlock() && "function does not have any Basicblock, external function?");
        return allBBs.back();
    }

◆ begin()

const_iterator SVF::SVFFunction::begin ( ) const

inline

Definition at line 446 of file SVFValue.h.

    {
        return allBBs.begin();
    }

◆ classof()

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

inlinestatic

Definition at line 368 of file SVFValue.h.

    {
        return node->getKind() == SVFFunc;
    }

◆ dominate()

bool SVF::SVFFunction::dominate	(	const SVFBasicBlock *	bbKey,
		const SVFBasicBlock *	bbValue
	)		const

inline

Definition at line 516 of file SVFValue.h.

    {
        return loopAndDom->dominate(bbKey,bbValue);
    }

◆ end()

const_iterator SVF::SVFFunction::end ( ) const

inline

Definition at line 451 of file SVFValue.h.

    {
        return allBBs.end();
    }

◆ front()

const SVFBasicBlock * SVF::SVFFunction::front ( ) const

inline

Definition at line 432 of file SVFValue.h.

    {
        return getEntryBlock();
    }

◆ getArg()

const SVFArgument * SVFFunction::getArg ( u32_t idx ) const

Definition at line 175 of file SVFValue.cpp.

{
    assert (idx < allArgs.size() && "getArg() out of range!");
    return allArgs[idx];
}

◆ getBasicBlockList()

const std::vector< const SVFBasicBlock * > & SVF::SVFFunction::getBasicBlockList ( ) const

inline

Definition at line 456 of file SVFValue.h.

    {
        return allBBs;
    }

◆ getCallGraphNode()

const CallGraphNode * SVF::SVFFunction::getCallGraphNode ( ) const

inline

Definition at line 363 of file SVFValue.h.

    {
        return callGraphNode;
    }

◆ getDefFunForMultipleModule()

const SVFFunction * SVF::SVFFunction::getDefFunForMultipleModule ( ) const

inline

Definition at line 404 of file SVFValue.h.

    {
        if(realDefFun==nullptr)
            return this;
        return realDefFun;
    }

◆ getDomFrontierMap()

const Map< const SVFBasicBlock *, BBSet > & SVF::SVFFunction::getDomFrontierMap ( ) const

inline

Definition at line 506 of file SVFValue.h.

    {
        return loopAndDom->getDomFrontierMap();
    }

◆ getDomTreeMap()

const Map< const SVFBasicBlock *, BBSet > & SVF::SVFFunction::getDomTreeMap ( ) const

inline

Definition at line 501 of file SVFValue.h.

    {
        return loopAndDom->getDomTreeMap();
    }

◆ getEntryBlock()

const SVFBasicBlock * SVF::SVFFunction::getEntryBlock ( ) const

inline

Definition at line 420 of file SVFValue.h.

    {
        assert(hasBasicBlock() && "function does not have any Basicblock, external function?");
        return allBBs.front();
    }

◆ getExitBB()

const SVFBasicBlock * SVFFunction::getExitBB ( ) const

Carefully! when you call getExitBB, you need ensure the function has return instruction more refer to: https://github.com/SVF-tools/SVF/pull/1262

Definition at line 186 of file SVFValue.cpp.

{
    assert(hasBasicBlock() && "function does not have any Basicblock, external function?");
    assert(exitBlock && "must have an exitBlock");
    return exitBlock;
}

◆ getExitBlocksOfLoop()

void SVF::SVFFunction::getExitBlocksOfLoop	(	const SVFBasicBlock *	bb,
		BBList &	exitbbs
	)		const

inline

Definition at line 476 of file SVFValue.h.

    {
        return loopAndDom->getExitBlocksOfLoop(bb,exitbbs);
    }

◆ getFunctionType()

const SVFFunctionType * SVF::SVFFunction::getFunctionType ( ) const

inline

Returns the FunctionType.

Definition at line 393 of file SVFValue.h.

    {
        return funcType;
    }

◆ getLoopAndDomInfo()

SVFLoopAndDomInfo * SVF::SVFFunction::getLoopAndDomInfo ( )

inline

Definition at line 373 of file SVFValue.h.

    {
        return loopAndDom;
    }

◆ getLoopHeader()

const SVFBasicBlock * SVF::SVFFunction::getLoopHeader ( const BBList & lp ) const

inline

Definition at line 491 of file SVFValue.h.

    {
        return loopAndDom->getLoopHeader(lp);
    }

◆ getLoopInfo()

const LoopBBs & SVF::SVFFunction::getLoopInfo ( const SVFBasicBlock * bb ) const

inline

Definition at line 486 of file SVFValue.h.

    {
        return loopAndDom->getLoopInfo(bb);
    }

◆ getReachableBBs()

const std::vector< const SVFBasicBlock * > & SVF::SVFFunction::getReachableBBs ( ) const

inline

Definition at line 461 of file SVFValue.h.

    {
        return loopAndDom->getReachableBBs();
    }

◆ getReturnType()

const SVFType * SVF::SVFFunction::getReturnType ( ) const

inline

Returns the FunctionType.

Definition at line 399 of file SVFValue.h.

    {
        return funcType->getReturnType();
    }

◆ hasAddressTaken()

bool SVF::SVFFunction::hasAddressTaken ( ) const

inline

Definition at line 387 of file SVFValue.h.

    {
        return addrTaken;
    }

◆ hasBasicBlock()

bool SVF::SVFFunction::hasBasicBlock ( ) const

inline

Definition at line 415 of file SVFValue.h.

    {
        return !allBBs.empty();
    }

◆ hasLoopInfo()

bool SVF::SVFFunction::hasLoopInfo ( const SVFBasicBlock * bb ) const

inline

Definition at line 481 of file SVFValue.h.

    {
        return loopAndDom->hasLoopInfo(bb);
    }

◆ hasReturn()

bool SVF::SVFFunction::hasReturn ( ) const

inline

Definition at line 471 of file SVFValue.h.

    {
        return  !isNotRet;
    }

◆ isDeclaration()

bool SVF::SVFFunction::isDeclaration ( ) const

inline

Definition at line 377 of file SVFValue.h.

    {
        return isDecl;
    }

◆ isIntrinsic()

bool SVF::SVFFunction::isIntrinsic ( ) const

inline

Definition at line 382 of file SVFValue.h.

    {
        return intrinsic;
    }

◆ isLoopHeader()

bool SVF::SVFFunction::isLoopHeader ( const SVFBasicBlock * bb ) const

inline

Definition at line 511 of file SVFValue.h.

    {
        return loopAndDom->isLoopHeader(bb);
    }

◆ isUncalledFunction()

bool SVF::SVFFunction::isUncalledFunction ( ) const

inline

Definition at line 466 of file SVFValue.h.

    {
        return isUncalled;
    }

◆ isVarArg()

bool SVFFunction::isVarArg ( ) const

Definition at line 181 of file SVFValue.cpp.

{
    return varArg;
}

◆ loopContainsBB()

bool SVF::SVFFunction::loopContainsBB	(	const BBList &	lp,
		const SVFBasicBlock *	bb
	)		const

inline

Definition at line 496 of file SVFValue.h.

    {
        return loopAndDom->loopContainsBB(lp,bb);
    }

◆ postDominate()

bool SVF::SVFFunction::postDominate	(	const SVFBasicBlock *	bbKey,
		const SVFBasicBlock *	bbValue
	)		const

inline

Definition at line 521 of file SVFValue.h.

    {
        return loopAndDom->postDominate(bbKey,bbValue);
    }

◆ setCallGraphNode()

void SVF::SVFFunction::setCallGraphNode ( CallGraphNode * cgn )

inlineprotected

call graph node for this function

Definition at line 326 of file SVFValue.h.

    {
        callGraphNode = cgn;
    }

◆ setDefFunForMultipleModule()

void SVF::SVFFunction::setDefFunForMultipleModule ( const SVFFunction * deffun )

inlineprotected

Definition at line 352 of file SVFValue.h.

    {
        realDefFun = deffun;
    }

◆ setExitBlock()

void SVFFunction::setExitBlock ( SVFBasicBlock * bb )

Definition at line 193 of file SVFValue.cpp.

{
    assert(!exitBlock && "have already set exit Basicblock!");
    exitBlock = bb;
}

◆ setIsNotRet()

void SVF::SVFFunction::setIsNotRet ( bool notRet )

inlineprotected

Definition at line 347 of file SVFValue.h.

    {
        isNotRet = notRet;
    }

◆ setIsUncalledFunction()

void SVF::SVFFunction::setIsUncalledFunction ( bool uncalledFunction )

inlineprotected

Definition at line 342 of file SVFValue.h.

    {
        isUncalled = uncalledFunction;
    }

Friends And Related Symbol Documentation

◆ LLVMModuleSet

friend class LLVMModuleSet

friend

Definition at line 299 of file SVFValue.h.

◆ SVFIRBuilder

friend class SVFIRBuilder

friend

Definition at line 302 of file SVFValue.h.

◆ SVFIRReader

friend class SVFIRReader

friend

Definition at line 301 of file SVFValue.h.

◆ SVFIRWriter

friend class SVFIRWriter

friend

Definition at line 300 of file SVFValue.h.

Member Data Documentation

◆ addrTaken

bool SVF::SVFFunction::addrTaken

private

return true if this function is an intrinsic function (e.g., llvm.dbg), which does not reside in the application code

Definition at line 313 of file SVFValue.h.

◆ allArgs

std::vector<const SVFArgument*> SVF::SVFFunction::allArgs

private

all BasicBlocks of this function

Definition at line 321 of file SVFValue.h.

◆ allBBs

std::vector<const SVFBasicBlock*> SVF::SVFFunction::allBBs

private

the definition of a function across multiple modules

Definition at line 320 of file SVFValue.h.

◆ callGraphNode

const CallGraphNode* SVF::SVFFunction::callGraphNode

private

a 'single' basic block having no successors and containing return instruction in a function

Definition at line 323 of file SVFValue.h.

◆ exitBlock

SVFBasicBlock* SVF::SVFFunction::exitBlock

private

all formal arguments of this function

Definition at line 322 of file SVFValue.h.

◆ funcType

const SVFFunctionType* SVF::SVFFunction::funcType

private

return true if this function supports variable arguments

Definition at line 317 of file SVFValue.h.

◆ intrinsic

bool SVF::SVFFunction::intrinsic

private

return true if this function does not have a body

Definition at line 312 of file SVFValue.h.

◆ isDecl

bool SVF::SVFFunction::isDecl

private

Definition at line 311 of file SVFValue.h.

◆ isNotRet

bool SVF::SVFFunction::isNotRet

private

return true if this function is never called

Definition at line 315 of file SVFValue.h.

◆ isUncalled

bool SVF::SVFFunction::isUncalled

private

return true if this function is address-taken (for indirect call purposes)

Definition at line 314 of file SVFValue.h.

◆ loopAndDom

SVFLoopAndDomInfo* SVF::SVFFunction::loopAndDom

private

FunctionType, which is different from the type (PointerType) of this SVFFunction.

Definition at line 318 of file SVFValue.h.

◆ realDefFun

const SVFFunction* SVF::SVFFunction::realDefFun

private

the loop and dominate information

Definition at line 319 of file SVFValue.h.

◆ varArg

bool SVF::SVFFunction::varArg

private

return true if this function never returns

Definition at line 316 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/lib/SVFIR/SVFValue.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BBList

◆ BBSet

◆ const_iterator

◆ LoopBBs

Constructor & Destructor Documentation

◆ SVFFunction() [1/2]

◆ SVFFunction() [2/2]

◆ ~SVFFunction()

Member Function Documentation

◆ addArgument()

◆ addBasicBlock()

◆ arg_size()

◆ back()

◆ begin()

◆ classof()

◆ dominate()

◆ end()

◆ front()

◆ getArg()

◆ getBasicBlockList()

◆ getCallGraphNode()

◆ getDefFunForMultipleModule()

◆ getDomFrontierMap()

◆ getDomTreeMap()

◆ getEntryBlock()

◆ getExitBB()

◆ getExitBlocksOfLoop()

◆ getFunctionType()

◆ getLoopAndDomInfo()

◆ getLoopHeader()

◆ getLoopInfo()

◆ getReachableBBs()

◆ getReturnType()

◆ hasAddressTaken()

◆ hasBasicBlock()

◆ hasLoopInfo()

◆ hasReturn()

◆ isDeclaration()

◆ isIntrinsic()

◆ isLoopHeader()

◆ isUncalledFunction()

◆ isVarArg()

◆ loopContainsBB()

◆ postDominate()

◆ setCallGraphNode()

◆ setDefFunForMultipleModule()

◆ setExitBlock()

◆ setIsNotRet()

◆ setIsUncalledFunction()

Friends And Related Symbol Documentation

◆ LLVMModuleSet

◆ SVFIRBuilder

◆ SVFIRReader

◆ SVFIRWriter

Member Data Documentation

◆ addrTaken

◆ allArgs

◆ allBBs

◆ callGraphNode

◆ exitBlock

◆ funcType

◆ intrinsic

◆ isDecl

◆ isNotRet

◆ isUncalled

◆ loopAndDom

◆ realDefFun

◆ varArg