SVF::SVFFunction Class Reference

#include <SVFLLVMValue.h>

Inheritance diagram for SVF::SVFFunction:

Public Types
typedef BasicBlockGraph::IDToNodeMapTy::const_iterator	const_iterator
typedef SVFLoopAndDomInfo::BBSet	BBSet
typedef SVFLoopAndDomInfo::BBList	BBList
typedef SVFLoopAndDomInfo::LoopBBs	LoopBBs
Public Types inherited from SVF::SVFLLVMValue
enum	SVFValKind { SVFVal , SVFFunc }
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 ()
SVFLoopAndDomInfo *	getLoopAndDomInfo ()
bool	isDeclaration () const
void	setBasicBlockGraph (BasicBlockGraph *graph)
BasicBlockGraph *	getBasicBlockGraph ()
const BasicBlockGraph *	getBasicBlockGraph () 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 ArgValVar *	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 * > &	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::SVFLLVMValue
	SVFLLVMValue ()=delete
virtual	~SVFLLVMValue ()=default
GNodeK	getKind () const
	Get the type of this SVFValue.
const std::string &	getName () const
void	setName (std::string &&n)
virtual const SVFType *	getType () const
bool	isConstDataOrAggData () const
bool	ptrInUncalledFunction () 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 SVFLLVMValue *node)

Public Attributes
BasicBlockGraph::IDToNodeMapTy::iterator	iterator

Protected Member Functions
void	addArgument (const ArgValVar *arg)
	the basic block graph of this function
void	setIsUncalledFunction (bool uncalledFunction)
void	setIsNotRet (bool notRet)
void	setDefFunForMultipleModule (const SVFFunction *deffun)
Protected Member Functions inherited from SVF::SVFLLVMValue
	SVFLLVMValue (const SVFType *ty, SVFValKind k=SVFVal)
	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 ArgValVar * >	allArgs
	the definition of a function across multiple modules
SVFBasicBlock *	exitBlock
	all formal arguments of this function
BasicBlockGraph *	bbGraph
	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::SVFLLVMValue
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 150 of file SVFLLVMValue.h.

Member Typedef Documentation

BBList

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

Definition at line 161 of file SVFLLVMValue.h.

BBSet

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

Definition at line 160 of file SVFLLVMValue.h.

const_iterator

typedef BasicBlockGraph::IDToNodeMapTy::const_iterator SVF::SVFFunction::const_iterator

Definition at line 159 of file SVFLLVMValue.h.

LoopBBs

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

Definition at line 162 of file SVFLLVMValue.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 8 of file SVFLLVMValue.cpp.

    : SVFLLVMValue(ty, SVFLLVMValue::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 17 of file SVFLLVMValue.cpp.

{
    delete loopAndDom;
    delete bbGraph;
}

Member Function Documentation

addArgument()

void SVF::SVFFunction::addArgument ( const ArgValVar *  arg )

inlineprotected

the basic block graph of this function

Definition at line 180 of file SVFLLVMValue.h.

    {
        allArgs.push_back(arg);
    }

arg_size()

u32_t SVFFunction::arg_size

(

)

const

Definition at line 23 of file SVFLLVMValue.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 291 of file SVFLLVMValue.h.

    {
        assert(hasBasicBlock() && "function does not have any Basicblock, external function?");
        return std::prev(bbGraph->end())->second;
    }

begin()

const_iterator SVF::SVFFunction::begin ( ) const

inline

Definition at line 300 of file SVFLLVMValue.h.

    {
        return bbGraph->begin();
    }

classof()

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

inlinestatic

Definition at line 206 of file SVFLLVMValue.h.

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

dominate()

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

inline

Definition at line 366 of file SVFLLVMValue.h.

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

end()

const_iterator SVF::SVFFunction::end ( ) const

inline

Definition at line 305 of file SVFLLVMValue.h.

    {
        return bbGraph->end();
    }

front()

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

inline

Definition at line 286 of file SVFLLVMValue.h.

    {
        return getEntryBlock();
    }

getArg()

const ArgValVar * SVFFunction::getArg

(

u32_t

idx

)

const

Definition at line 28 of file SVFLLVMValue.cpp.

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

getBasicBlockGraph() [1/2]

BasicBlockGraph * SVF::SVFFunction::getBasicBlockGraph ( )

inline

Definition at line 225 of file SVFLLVMValue.h.

    {
        return bbGraph;
    }

getBasicBlockGraph() [2/2]

const BasicBlockGraph * SVF::SVFFunction::getBasicBlockGraph ( ) const

inline

Definition at line 230 of file SVFLLVMValue.h.

    {
        return bbGraph;
    }

getDefFunForMultipleModule()

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

inline

Definition at line 257 of file SVFLLVMValue.h.

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

getDomFrontierMap()

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

inline

Definition at line 356 of file SVFLLVMValue.h.

    {
        return loopAndDom->getDomFrontierMap();
    }

getDomTreeMap()

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

inline

Definition at line 351 of file SVFLLVMValue.h.

    {
        return loopAndDom->getDomTreeMap();
    }

getEntryBlock()

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

inline

Definition at line 273 of file SVFLLVMValue.h.

    {
        assert(hasBasicBlock() && "function does not have any Basicblock, external function?");
        assert(bbGraph->begin()->second->getInEdges().size() == 0 && "the first basic block is not entry block");
        return bbGraph->begin()->second;
    }

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 39 of file SVFLLVMValue.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 326 of file SVFLLVMValue.h.

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

getFunctionType()

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

inline

Returns the FunctionType.

Definition at line 246 of file SVFLLVMValue.h.

    {
        return funcType;
    }

getLoopAndDomInfo()

SVFLoopAndDomInfo * SVF::SVFFunction::getLoopAndDomInfo ( )

inline

Definition at line 211 of file SVFLLVMValue.h.

    {
        return loopAndDom;
    }

getLoopHeader()

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

inline

Definition at line 341 of file SVFLLVMValue.h.

    {
        return loopAndDom->getLoopHeader(lp);
    }

getLoopInfo()

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

inline

Definition at line 336 of file SVFLLVMValue.h.

    {
        return loopAndDom->getLoopInfo(bb);
    }

getReachableBBs()

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

inline

Definition at line 311 of file SVFLLVMValue.h.

    {
        return loopAndDom->getReachableBBs();
    }

getReturnType()

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

inline

Returns the FunctionType.

Definition at line 252 of file SVFLLVMValue.h.

    {
        return funcType->getReturnType();
    }

hasAddressTaken()

bool SVF::SVFFunction::hasAddressTaken ( ) const

inline

Definition at line 240 of file SVFLLVMValue.h.

    {
        return addrTaken;
    }

hasBasicBlock()

bool SVF::SVFFunction::hasBasicBlock ( ) const

inline

Definition at line 268 of file SVFLLVMValue.h.

    {
        return bbGraph && bbGraph->begin() != bbGraph->end();
    }

hasLoopInfo()

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

inline

Definition at line 331 of file SVFLLVMValue.h.

    {
        return loopAndDom->hasLoopInfo(bb);
    }

hasReturn()

bool SVF::SVFFunction::hasReturn ( ) const

inline

Definition at line 321 of file SVFLLVMValue.h.

    {
        return  !isNotRet;
    }

isDeclaration()

bool SVF::SVFFunction::isDeclaration ( ) const

inline

Definition at line 215 of file SVFLLVMValue.h.

    {
        return isDecl;
    }

isIntrinsic()

bool SVF::SVFFunction::isIntrinsic ( ) const

inline

Definition at line 235 of file SVFLLVMValue.h.

    {
        return intrinsic;
    }

isLoopHeader()

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

inline

Definition at line 361 of file SVFLLVMValue.h.

    {
        return loopAndDom->isLoopHeader(bb);
    }

isUncalledFunction()

bool SVF::SVFFunction::isUncalledFunction ( ) const

inline

Definition at line 316 of file SVFLLVMValue.h.

    {
        return isUncalled;
    }

isVarArg()

bool SVFFunction::isVarArg

(

)

const

Definition at line 34 of file SVFLLVMValue.cpp.

{
    return varArg;
}

loopContainsBB()

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

inline

Definition at line 346 of file SVFLLVMValue.h.

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

postDominate()

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

inline

Definition at line 371 of file SVFLLVMValue.h.

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

setBasicBlockGraph()

void SVF::SVFFunction::setBasicBlockGraph ( BasicBlockGraph *  graph )

inline

Definition at line 220 of file SVFLLVMValue.h.

    {
        this->bbGraph = graph;
    }

setDefFunForMultipleModule()

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

inlineprotected

Definition at line 195 of file SVFLLVMValue.h.

    {
        realDefFun = deffun;
    }

setExitBlock()

void SVFFunction::setExitBlock

(

SVFBasicBlock *

bb

)

Definition at line 46 of file SVFLLVMValue.cpp.

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

setIsNotRet()

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

inlineprotected

Definition at line 190 of file SVFLLVMValue.h.

    {
        isNotRet = notRet;
    }

setIsUncalledFunction()

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

inlineprotected

Definition at line 185 of file SVFLLVMValue.h.

    {
        isUncalled = uncalledFunction;
    }

Friends And Related Symbol Documentation

LLVMModuleSet

friend class LLVMModuleSet

friend

Definition at line 152 of file SVFLLVMValue.h.

SVFIRBuilder

friend class SVFIRBuilder

friend

Definition at line 155 of file SVFLLVMValue.h.

SVFIRReader

friend class SVFIRReader

friend

Definition at line 154 of file SVFLLVMValue.h.

SVFIRWriter

friend class SVFIRWriter

friend

Definition at line 153 of file SVFLLVMValue.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 167 of file SVFLLVMValue.h.

allArgs

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

private

the definition of a function across multiple modules

Definition at line 174 of file SVFLLVMValue.h.

bbGraph

BasicBlockGraph* SVF::SVFFunction::bbGraph

private

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

Definition at line 176 of file SVFLLVMValue.h.

exitBlock

SVFBasicBlock* SVF::SVFFunction::exitBlock

private

all formal arguments of this function

Definition at line 175 of file SVFLLVMValue.h.

funcType

const SVFFunctionType* SVF::SVFFunction::funcType

private

return true if this function supports variable arguments

Definition at line 171 of file SVFLLVMValue.h.

intrinsic

bool SVF::SVFFunction::intrinsic

private

return true if this function does not have a body

Definition at line 166 of file SVFLLVMValue.h.

isDecl

bool SVF::SVFFunction::isDecl

private

Definition at line 165 of file SVFLLVMValue.h.

isNotRet

bool SVF::SVFFunction::isNotRet

private

return true if this function is never called

Definition at line 169 of file SVFLLVMValue.h.

isUncalled

bool SVF::SVFFunction::isUncalled

private

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

Definition at line 168 of file SVFLLVMValue.h.

iterator

BasicBlockGraph::IDToNodeMapTy::iterator SVF::SVFFunction::iterator

Definition at line 158 of file SVFLLVMValue.h.

loopAndDom

SVFLoopAndDomInfo* SVF::SVFFunction::loopAndDom

private

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

Definition at line 172 of file SVFLLVMValue.h.

realDefFun

const SVFFunction* SVF::SVFFunction::realDefFun

private

the loop and dominate information

Definition at line 173 of file SVFLLVMValue.h.

varArg

bool SVF::SVFFunction::varArg

private

return true if this function never returns

Definition at line 170 of file SVFLLVMValue.h.

---

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

• /home/runner/work/SVF/SVF/svf-llvm/include/SVF-LLVM/SVFLLVMValue.h
• /home/runner/work/SVF/SVF/svf-llvm/lib/SVFLLVMValue.cpp