SVF::SVFUtil Namespace Reference

Classes
struct	add_const_past_pointer
struct	add_const_past_pointer< T, std::enable_if_t< std::is_pointer< T >::value > >
struct	add_lvalue_reference_if_not_pointer
	If T is a pointer, just return it. If it is not, return T&. More...
struct	add_lvalue_reference_if_not_pointer< T, std::enable_if_t< std::is_pointer< T >::value > >
struct	cast_convert_val
struct	cast_convert_val< To, FromTy, FromTy >
struct	cast_retty
struct	cast_retty_impl
struct	cast_retty_impl< To, const From * >
struct	cast_retty_impl< To, const From *const >
struct	cast_retty_impl< To, const From >
struct	cast_retty_impl< To, From * >
struct	cast_retty_impl< To, std::unique_ptr< From > >
struct	cast_retty_wrap
struct	cast_retty_wrap< To, FromTy, FromTy >
struct	equalNodeBS
struct	equalPointsTo
struct	is_iterable
	Type trait that checks if a type is iterable (can be applied on a range-based for loop) More...
struct	is_iterable< T, void_t< decltype(std::begin(std::declval< T & >()) !=std::end(std::declval< T & >()))> >
struct	is_map
	Type trait to check if a type is a map or unordered_map. More...
struct	is_map< std::map< Ts... > >
struct	is_map< std::unordered_map< Ts... > >
struct	is_sequence_container
	Type trait to check if a type is vector or list. More...
struct	is_sequence_container< std::deque< Ts... > >
struct	is_sequence_container< std::list< Ts... > >
struct	is_sequence_container< std::vector< Ts... > >
struct	is_set
	Type trait to check if a type is a set or unordered_set. More...
struct	is_set< std::set< Ts... > >
struct	is_set< std::unordered_set< Ts... > >
struct	is_simple_type
struct	isa_impl
struct	isa_impl< To, From, std::enable_if_t< std::is_base_of< To, From >::value > >
	Always allow upcasts, and perform no dynamic check for them. More...
struct	isa_impl_cl
struct	isa_impl_cl< To, const From * >
struct	isa_impl_cl< To, const From *const >
struct	isa_impl_cl< To, const From >
struct	isa_impl_cl< To, const std::unique_ptr< From > >
struct	isa_impl_cl< To, From * >
struct	isa_impl_cl< To, From *const >
struct	isa_impl_wrap
struct	isa_impl_wrap< To, FromTy, FromTy >
struct	make_void
	void_t is not available until C++17. We define it here for C++11/14. More...
struct	simplify_type
struct	simplify_type< const From >

Typedefs
typedef struct SVF::SVFUtil::equalPointsTo	equalPointsTo
typedef struct SVF::SVFUtil::equalNodeBS	equalNodeBS
typedef OrderedSet< PointsTo, equalPointsTo >	PointsToList

Functions
template<class X , class Y >
LLVM_NODISCARD bool	isa (const Y &Val)
template<typename First , typename Second , typename... Rest, typename Y >
LLVM_NODISCARD bool	isa (const Y &Val)
template<class X , class Y >
std::enable_if_t<!is_simple_type< Y >::value, typename cast_retty< X, const Y >::ret_type >	cast (const Y &Val)
template<class X , class Y >
cast_retty< X, Y >::ret_type	cast (Y &Val)
template<class X , class Y >
cast_retty< X, Y * >::ret_type	cast (Y *Val)
template<class X , class Y >
cast_retty< X, std::unique_ptr< Y > >::ret_type	cast (std::unique_ptr< Y > &&Val)
template<class X , class Y >
LLVM_NODISCARD std::enable_if_t<!is_simple_type< Y >::value, typename cast_retty< X, const Y >::ret_type >	dyn_cast (const Y &Val)
template<class X , class Y >
LLVM_NODISCARD cast_retty< X, Y >::ret_type	dyn_cast (Y &Val)
template<class X , class Y >
LLVM_NODISCARD cast_retty< X, Y * >::ret_type	dyn_cast (Y *Val)
std::ostream &	outs ()
	Overwrite llvm::outs()
std::ostream &	errs ()
	Overwrite llvm::errs()
void	dumpSet (NodeBS To, OutStream &O=SVFUtil::outs())
	Dump sparse bitvector set.
void	dumpSet (PointsTo To, OutStream &O=SVFUtil::outs())
void	dumpPointsToSet (unsigned node, NodeBS To)
	Dump points-to set.
void	dumpSparseSet (const NodeBS &To)
void	dumpAliasSet (unsigned node, NodeBS To)
	Dump alias set.
std::string	sucMsg (const std::string &msg)
	Returns successful message by converting a string into green string output.
std::string	wrnMsg (const std::string &msg)
	Returns warning message by converting a string into yellow string output.
void	writeWrnMsg (const std::string &msg)
	Writes a message run through wrnMsg.
std::string	errMsg (const std::string &msg)
	Print error message by converting a string into red string output.
std::string	bugMsg1 (const std::string &msg)
std::string	bugMsg2 (const std::string &msg)
std::string	bugMsg3 (const std::string &msg)
std::string	pasMsg (const std::string &msg)
	Print each pass/phase message by converting a string into blue string output.
void	reportMemoryUsageKB (const std::string &infor, OutStream &O=SVFUtil::outs())
	Print memory usage in KB.
bool	getMemoryUsageKB (u32_t *vmrss_kb, u32_t *vmsize_kb)
	Get memory usage from system file. Return TRUE if succeed.
void	increaseStackSize ()
	Increase the stack size limit.
bool	cmpPts (const PointsTo &lpts, const PointsTo &rpts)
bool	cmpNodeBS (const NodeBS &lpts, const NodeBS &rpts)
NodeBS	ptsToNodeBS (const PointsTo &pts)
void	dumpPointsToList (const PointsToList &ptl)
bool	isIntrinsicInst (const SVFInstruction *inst)
	Return true if it is an llvm intrinsic instruction.
bool	isIntrinsicInst (const ICFGNode *inst)
bool	isCallSite (const SVFValue *val)
	Whether an instruction is a call or invoke instruction.
bool	isCallSite (const ICFGNode *inst)
bool	isRetInstNode (const ICFGNode *node)
bool	isNonInstricCallSite (const ICFGNode *inst)
	Whether an instruction is a callsite in the application code, excluding llvm intrinsic calls.
bool	matchArgs (const CallICFGNode *cs, const SVFFunction *callee)
std::vector< std::string >	split (const std::string &s, char separator)
	Split into two substrings around the first occurrence of a separator string.
template<typename Data >
void	mergePtsOccMaps (Map< Data, unsigned > &to, const Map< Data, unsigned > from)
	Given a map mapping points-to sets to a count, adds from into to.
std::string	hclustMethodToString (hclust_fast_methods method)
	Returns a string representation of a hclust method.
template<typename Key , typename KeySet >
void	insertKey (const Key &key, KeySet &keySet)
	Inserts an element into a Set/CondSet (with ::insert).
void	insertKey (const NodeID &key, NodeBS &keySet)
	Inserts a NodeID into a NodeBS.
template<typename Key , typename KeySet >
void	removeKey (const Key &key, KeySet &keySet)
	Removes an element from a Set/CondSet (or anything implementing erase).
void	removeKey (const NodeID &key, NodeBS &keySet)
	Removes a NodeID from a NodeBS.
void	timeLimitReached (int signum)
	Function to call when alarm for time limit hits.
bool	startAnalysisLimitTimer (unsigned timeLimit)
void	stopAnalysisLimitTimer (bool limitTimerSet)
bool	isExtCall (const SVFFunction *fun)
bool	isMemcpyExtFun (const SVFFunction *fun)
bool	isMemsetExtFun (const SVFFunction *fun)
bool	isHeapAllocExtFunViaRet (const SVFFunction *fun)
	Return true if the call is a heap allocator/reallocator.
bool	isHeapAllocExtFunViaArg (const SVFFunction *fun)
u32_t	getHeapAllocHoldingArgPosition (const SVFFunction *fun)
	Get the position of argument that holds an allocated heap object.
bool	isReallocExtFun (const SVFFunction *fun)
	Return true if the call is a heap reallocator.
bool	isProgEntryFunction (const SVFFunction *fun)
	Program entry function e.g. main.
const SVFFunction *	getProgFunction (const std::string &funName)
	Get program entry function from function name.
const SVFFunction *	getProgEntryFunction ()
	Get program entry function.
bool	isProgExitFunction (const SVFFunction *fun)
	Return true if this is a program exit function call.
bool	isArgOfUncalledFunction (const SVFValue *svfval)
	Return true if this argument belongs to an uncalled function.
const ObjVar *	getObjVarOfValVar (const ValVar *valVar)
const ValVar *	getForkedFun (const CallICFGNode *inst)
	Return thread fork function.
bool	isExtCall (const CallICFGNode *cs)
bool	isExtCall (const ICFGNode *node)
bool	isHeapAllocExtCallViaArg (const CallICFGNode *cs)
bool	isHeapAllocExtCallViaRet (const CallICFGNode *cs)
	interfaces to be used externally
bool	isHeapAllocExtCall (const ICFGNode *cs)
u32_t	getHeapAllocHoldingArgPosition (const CallICFGNode *cs)
bool	isReallocExtCall (const CallICFGNode *cs)

Variables
template<typename... Ts>
constexpr bool	is_sequence_container_v = is_sequence_container<Ts...>::value
template<typename... Ts>
constexpr bool	is_map_v = is_map<Ts...>::value
template<typename... Ts>
constexpr bool	is_set_v = is_set<Ts...>::value
template<typename... Ts>
using	void_t = typename make_void< Ts... >::type
template<typename T >
constexpr bool	is_iterable_v = is_iterable<T>::value
bool	isThreadForkCall (const CallICFGNode *inst)
bool	isThreadJoinCall (const CallICFGNode *cs)
bool	isThreadExitCall (const CallICFGNode *cs)
bool	isLockAquireCall (const CallICFGNode *cs)
bool	isLockReleaseCall (const CallICFGNode *cs)
bool	isBarrierWaitCall (const CallICFGNode *cs)
	Return true if this is a barrier wait call.
const ValVar *	getActualParmAtForkSite (const CallICFGNode *cs)
	Return sole argument of the thread routine.
bool	isProgExitCall (const CallICFGNode *cs)
template<typename T >
constexpr std::remove_reference< T >::type &&	move (T &&t) noexcept

Typedef Documentation

equalNodeBS

typedef struct SVF::SVFUtil::equalNodeBS SVF::SVFUtil::equalNodeBS

equalPointsTo

typedef struct SVF::SVFUtil::equalPointsTo SVF::SVFUtil::equalPointsTo

PointsToList

typedef OrderedSet<PointsTo, equalPointsTo> SVF::SVFUtil::PointsToList

Definition at line 166 of file SVFUtil.h.

void_t

template<typename... Ts>

using SVF::SVFUtil::void_t = typedef typename make_void<Ts...>::type

Definition at line 457 of file SVFUtil.h.

Function Documentation

bugMsg1()

std::string SVF::SVFUtil::bugMsg1

(

const std::string &

msg

)

Definition at line 82 of file SVFUtil.cpp.

{
    return KYEL + msg + KNRM;
}

bugMsg2()

std::string SVF::SVFUtil::bugMsg2

(

const std::string &

msg

)

Definition at line 87 of file SVFUtil.cpp.

{
    return KPUR + msg + KNRM;
}

bugMsg3()

std::string SVF::SVFUtil::bugMsg3

(

const std::string &

msg

)

Definition at line 92 of file SVFUtil.cpp.

{
    return KCYA + msg + KNRM;
}

cast() [1/4]

template<class X , class Y >

std::enable_if_t<!is_simple_type< Y >::value, typename cast_retty< X, const Y >::ret_type > SVF::SVFUtil::cast ( const Y &  Val )

inline

Definition at line 360 of file Casting.h.

{
    assert(SVFUtil::isa<X>(Val) && "cast<Ty>() argument of incompatible type!");
    return cast_convert_val<
           X, const Y, typename simplify_type<const Y>::SimpleType>::doit(Val);
}

cast() [2/4]

template<class X , class Y >

cast_retty< X, std::unique_ptr< Y > >::ret_type SVF::SVFUtil::cast ( std::unique_ptr< Y > &&  Val )

inline

Definition at line 385 of file Casting.h.

{
    assert(SVFUtil::isa<X>(Val.get()) && "cast<Ty>() argument of incompatible type!");
    using ret_type = typename cast_retty<X, std::unique_ptr<Y>>::ret_type;
    return ret_type(
               cast_convert_val<X, Y *, typename simplify_type<Y *>::SimpleType>::doit(
                   Val.release()));
}

cast() [3/4]

template<class X , class Y >

cast_retty< X, Y >::ret_type SVF::SVFUtil::cast ( Y &  Val )

inline

Definition at line 368 of file Casting.h.

{
    assert(SVFUtil::isa<X>(Val) && "cast<Ty>() argument of incompatible type!");
    return cast_convert_val<X, Y,
           typename simplify_type<Y>::SimpleType>::doit(Val);
}

cast() [4/4]

template<class X , class Y >

cast_retty< X, Y * >::ret_type SVF::SVFUtil::cast ( Y *  Val )

inline

Definition at line 376 of file Casting.h.

{
    assert(SVFUtil::isa<X>(Val) && "cast<Ty>() argument of incompatible type!");
    return cast_convert_val<X, Y*,
           typename simplify_type<Y*>::SimpleType>::doit(Val);
}

cmpNodeBS()

bool SVF::SVFUtil::cmpNodeBS ( const NodeBS &  lpts, const NodeBS &  rpts  )

inline

Definition at line 125 of file SVFUtil.h.

{
    if (lpts.count() != rpts.count())
        return (lpts.count() < rpts.count());
    else
    {
        NodeBS::iterator bit = lpts.begin(), eit = lpts.end();
        NodeBS::iterator rbit = rpts.begin(), reit = rpts.end();
        for (; bit != eit && rbit != reit; bit++, rbit++)
        {
            if (*bit != *rbit)
                return (*bit < *rbit);
        }
 
        return false;
    }
}

cmpPts()

bool SVF::SVFUtil::cmpPts ( const PointsTo &  lpts, const PointsTo &  rpts  )

inline

Compare two PointsTo according to their size and points-to elements.

1. PointsTo with smaller size is smaller than the other;
2. If the sizes are equal, comparing the points-to targets.

Definition at line 107 of file SVFUtil.h.

{
    if (lpts.count() != rpts.count())
        return (lpts.count() < rpts.count());
    else
    {
        PointsTo::iterator bit = lpts.begin(), eit = lpts.end();
        PointsTo::iterator rbit = rpts.begin(), reit = rpts.end();
        for (; bit != eit && rbit != reit; bit++, rbit++)
        {
            if (*bit != *rbit)
                return (*bit < *rbit);
        }
 
        return false;
    }
}

dumpAliasSet()

void SVF::SVFUtil::dumpAliasSet	(	unsigned	node,
		NodeBS	bs
	)

Dump alias set.

Dump alias set

Definition at line 138 of file SVFUtil.cpp.

{
    outs() << "node " << node << " alias set: {";
    dumpSet(bs);
    outs() << "}\n";
}

dumpPointsToList()

void SVF::SVFUtil::dumpPointsToList

(

const PointsToList &

ptl

)

Definition at line 123 of file SVFUtil.cpp.

{
    outs() << "{";
    for (PointsToList::const_iterator ii = ptl.begin(), ie = ptl.end();
            ii != ie; ii++)
    {
        auto bs = *ii;
        dumpSet(bs);
    }
    outs() << "}\n";
}

dumpPointsToSet()

void SVF::SVFUtil::dumpPointsToSet	(	unsigned	node,
		NodeBS	bs
	)

Dump points-to set.

Dump points-to set

Definition at line 108 of file SVFUtil.cpp.

{
    outs() << "node " << node << " points-to: {";
    dumpSet(bs);
    outs() << "}\n";
}

dumpSet() [1/2]

void SVF::SVFUtil::dumpSet	(	NodeBS	bs,
		OutStream &	O = SVFUtil::outs()
	)

Dump sparse bitvector set.

Dump bit vector set

Definition at line 148 of file SVFUtil.cpp.

{
    for (NodeBS::iterator ii = bs.begin(), ie = bs.end();
            ii != ie; ii++)
    {
        O << " " << *ii << " ";
    }
}

dumpSet() [2/2]

void SVF::SVFUtil::dumpSet	(	PointsTo	To,
		OutStream &	O = SVFUtil::outs()
	)

Definition at line 157 of file SVFUtil.cpp.

{
    for (NodeID n : pt)
    {
        o << " " << n << " ";
    }
}

dumpSparseSet()

void SVF::SVFUtil::dumpSparseSet

(

const NodeBS &

To

)

Definition at line 116 of file SVFUtil.cpp.

{
    outs() << "{";
    dumpSet(bs);
    outs() << "}\n";
}

dyn_cast() [1/3]

template<class X , class Y >

LLVM_NODISCARD std::enable_if_t<!is_simple_type< Y >::value, typename cast_retty< X, const Y >::ret_type > SVF::SVFUtil::dyn_cast ( const Y &  Val )

inline

Definition at line 405 of file Casting.h.

{
    return SVFUtil::isa<X>(Val) ? SVFUtil::cast<X>(Val) : nullptr;
}

dyn_cast() [2/3]

template<class X , class Y >

LLVM_NODISCARD cast_retty< X, Y >::ret_type SVF::SVFUtil::dyn_cast ( Y &  Val )

inline

Definition at line 411 of file Casting.h.

{
    return SVFUtil::isa<X>(Val) ? SVFUtil::cast<X>(Val) : nullptr;
}

dyn_cast() [3/3]

template<class X , class Y >

LLVM_NODISCARD cast_retty< X, Y * >::ret_type SVF::SVFUtil::dyn_cast ( Y *  Val )

inline

Definition at line 417 of file Casting.h.

{
    return SVFUtil::isa<X>(Val) ? SVFUtil::cast<X>(Val) : nullptr;
}

errMsg()

std::string SVF::SVFUtil::errMsg

(

const std::string &

msg

)

Print error message by converting a string into red string output.

print error message by converting a string into red string output

Definition at line 77 of file SVFUtil.cpp.

{
    return KRED + msg + KNRM;
}

errs()

std::ostream & SVF::SVFUtil::errs ( )

inline

Overwrite llvm::errs()

Definition at line 56 of file SVFUtil.h.

{
    return std::cerr;
}

getActualParmAtForkSite()

const ValVar * SVF::SVFUtil::getActualParmAtForkSite ( const CallICFGNode *  cs )

inline

Return sole argument of the thread routine.

Definition at line 435 of file SVFUtil.h.

{
    return ThreadAPI::getThreadAPI()->getActualParmAtForkSite(cs);
}

getForkedFun()

const ValVar * SVF::SVFUtil::getForkedFun ( const CallICFGNode *  inst )

inline

Return thread fork function.

Definition at line 358 of file SVFUtil.h.

{
    return ThreadAPI::getThreadAPI()->getForkedFun(inst);
}

getHeapAllocHoldingArgPosition() [1/2]

u32_t SVF::SVFUtil::getHeapAllocHoldingArgPosition

(

const CallICFGNode *

cs

)

Definition at line 358 of file SVFUtil.cpp.

{
    return getHeapAllocHoldingArgPosition(cs->getCalledFunction());
}

getHeapAllocHoldingArgPosition() [2/2]

u32_t SVF::SVFUtil::getHeapAllocHoldingArgPosition ( const SVFFunction *  fun )

inline

Get the position of argument that holds an allocated heap object.

Definition at line 309 of file SVFUtil.h.

{
    return ExtAPI::getExtAPI()->get_alloc_arg_pos(fun);
}

getMemoryUsageKB()

bool SVF::SVFUtil::getMemoryUsageKB	(	u32_t *	vmrss_kb,
		u32_t *	vmsize_kb
	)

Get memory usage from system file. Return TRUE if succeed.

Get memory usage

Definition at line 178 of file SVFUtil.cpp.

{
    /* Get the current process' status file from the proc filesystem */
    char buffer[8192];
    FILE* procfile = fopen("/proc/self/status", "r");
    if(procfile)
    {
        u32_t result = fread(buffer, sizeof(char), 8192, procfile);
        if (result == 0)
        {
            fputs ("Reading error\n",stderr);
        }
    }
    else
    {
        SVFUtil::writeWrnMsg(" /proc/self/status file not exit!");
        return false;
    }
    fclose(procfile);
 
    /* Look through proc status contents line by line */
    char delims[] = "\n";
    char* line = strtok(buffer, delims);
 
    bool found_vmrss = false;
    bool found_vmsize = false;
 
    while (line != nullptr && (found_vmrss == false || found_vmsize == false))
    {
        if (strstr(line, "VmRSS:") != nullptr)
        {
            sscanf(line, "%*s %u", vmrss_kb);
            found_vmrss = true;
        }
 
        if (strstr(line, "VmSize:") != nullptr)
        {
            sscanf(line, "%*s %u", vmsize_kb);
            found_vmsize = true;
        }
 
        line = strtok(nullptr, delims);
    }
 
    return (found_vmrss && found_vmsize);
}

getObjVarOfValVar()

const ObjVar * SVF::SVFUtil::getObjVarOfValVar

(

const ValVar *

valVar

)

Definition at line 429 of file SVFUtil.cpp.

{
    assert(valVar->getInEdges().size() == 1);
    return SVFUtil::dyn_cast<ObjVar>((*valVar->getInEdges().begin())->getSrcNode());
}

getProgEntryFunction()

const SVFFunction * SVF::SVFUtil::getProgEntryFunction

(

)

Get program entry function.

Get program entry function from module.

Definition at line 416 of file SVFUtil.cpp.

{
    CallGraph* svfirCallGraph = PAG::getPAG()->getCallGraph();
    for (const auto& item: *svfirCallGraph)
    {
        const CallGraphNode*fun = item.second;
        if (isProgEntryFunction(fun->getFunction()))
            return (fun->getFunction());
    }
    return nullptr;
}

getProgFunction()

const SVFFunction * SVF::SVFUtil::getProgFunction

(

const std::string &

funName

)

Get program entry function from function name.

Get program entry function from module.

Definition at line 403 of file SVFUtil.cpp.

{
    CallGraph* svfirCallGraph = PAG::getPAG()->getCallGraph();
    for (const auto& item: *svfirCallGraph)
    {
        const CallGraphNode*fun = item.second;
        if (fun->getName()==funName)
            return fun->getFunction();
    }
    return nullptr;
}

hclustMethodToString()

std::string SVF::SVFUtil::hclustMethodToString

(

hclust_fast_methods

method

)

Returns a string representation of a hclust method.

Definition at line 261 of file SVFUtil.cpp.

{
    switch (method)
    {
    case HCLUST_METHOD_SINGLE:
        return "single";
    case HCLUST_METHOD_COMPLETE:
        return "complete";
    case HCLUST_METHOD_AVERAGE:
        return "average";
    case HCLUST_METHOD_MEDIAN:
        return "median";
    case HCLUST_METHOD_SVF_BEST:
        return "svf-best";
    default:
        assert(false && "SVFUtil::hclustMethodToString: unknown method");
        abort();
    }
}

increaseStackSize()

void SVF::SVFUtil::increaseStackSize

(

)

Increase the stack size limit.

Increase stack size

Definition at line 228 of file SVFUtil.cpp.

{
    const rlim_t kStackSize = 256L * 1024L * 1024L;   // min stack size = 256 Mb
    struct rlimit rl;
    int result = getrlimit(RLIMIT_STACK, &rl);
    if (result == 0)
    {
        if (rl.rlim_cur < kStackSize)
        {
            rl.rlim_cur = kStackSize;
            result = setrlimit(RLIMIT_STACK, &rl);
            if (result != 0)
                writeWrnMsg("setrlimit returned result !=0 \n");
        }
    }
}

insertKey() [1/2]

template<typename Key , typename KeySet >

void SVF::SVFUtil::insertKey ( const Key &  key, KeySet &  keySet  )

inline

Inserts an element into a Set/CondSet (with ::insert).

Definition at line 239 of file SVFUtil.h.

{
    keySet.insert(key);
}

insertKey() [2/2]

void SVF::SVFUtil::insertKey ( const NodeID &  key, NodeBS &  keySet  )

inline

Inserts a NodeID into a NodeBS.

Definition at line 245 of file SVFUtil.h.

{
    keySet.set(key);
}

isa() [1/2]

template<class X , class Y >

LLVM_NODISCARD bool SVF::SVFUtil::isa ( const Y &  Val )

inline

Definition at line 241 of file Casting.h.

{
    return isa_impl_wrap<X, const Y,
           typename simplify_type<const Y>::SimpleType>::doit(Val);
}

isa() [2/2]

template<typename First , typename Second , typename... Rest, typename Y >

LLVM_NODISCARD bool SVF::SVFUtil::isa ( const Y &  Val )

inline

Definition at line 248 of file Casting.h.

{
    return SVFUtil::isa<First>(Val) || SVFUtil::isa<Second, Rest...>(Val);
}

isArgOfUncalledFunction()

bool SVF::SVFUtil::isArgOfUncalledFunction ( const SVFValue *  svfval )

inline

Return true if this argument belongs to an uncalled function.

Definition at line 346 of file SVFUtil.h.

{
    if(const SVFArgument* arg = SVFUtil::dyn_cast<SVFArgument>(svfval))
        return arg->isArgOfUncalledFunction();
    else
        return false;
}

isBarrierWaitCall()

bool SVF::SVFUtil::isBarrierWaitCall ( const CallICFGNode *  cs )

inline

Return true if this is a barrier wait call.

Definition at line 427 of file SVFUtil.h.

{
    return ThreadAPI::getThreadAPI()->isTDBarWait(cs);
}

isCallSite() [1/2]

bool SVF::SVFUtil::isCallSite

(

const ICFGNode *

inst

)

Definition at line 329 of file SVFUtil.cpp.

{
    return SVFUtil::isa<CallICFGNode>(inst);
}

isCallSite() [2/2]

bool SVF::SVFUtil::isCallSite ( const SVFValue *  val )

inline

Whether an instruction is a call or invoke instruction.

Definition at line 175 of file SVFUtil.h.

{
    if(SVFUtil::isa<SVFCallInst>(val))
        return true;
    else
        return false;
}

isExtCall() [1/3]

bool SVF::SVFUtil::isExtCall

(

const CallICFGNode *

cs

)

Definition at line 347 of file SVFUtil.cpp.

{
    return isExtCall(cs->getCalledFunction());
}

isExtCall() [2/3]

bool SVF::SVFUtil::isExtCall

(

const ICFGNode *

node

)

Definition at line 364 of file SVFUtil.cpp.

{
    if(!isCallSite(node)) return false;
    return isExtCall(cast<CallICFGNode>(node)->getCalledFunction());
}

isExtCall() [3/3]

bool SVF::SVFUtil::isExtCall ( const SVFFunction *  fun )

inline

Return true if the call is an external call (external library in function summary table) If the library function is redefined in the application code (e.g., memcpy), it will return false and will not be treated as an external call.

Definition at line 278 of file SVFUtil.h.

{
    return fun && ExtAPI::getExtAPI()->is_ext(fun);
}

isHeapAllocExtCall()

bool SVF::SVFUtil::isHeapAllocExtCall

(

const ICFGNode *

cs

)

Definition at line 370 of file SVFUtil.cpp.

{
    if(!isCallSite(cs)) return false;
    return isHeapAllocExtCallViaRet(cast<CallICFGNode>(cs)) || isHeapAllocExtCallViaArg(cast<CallICFGNode>(cs));
}

isHeapAllocExtCallViaArg()

bool SVF::SVFUtil::isHeapAllocExtCallViaArg

(

const CallICFGNode *

cs

)

Definition at line 352 of file SVFUtil.cpp.

{
    return isHeapAllocExtFunViaArg(cs->getCalledFunction());
}

isHeapAllocExtCallViaRet()

bool SVF::SVFUtil::isHeapAllocExtCallViaRet

(

const CallICFGNode *

cs

)

interfaces to be used externally

Definition at line 376 of file SVFUtil.cpp.

{
    bool isPtrTy = cs->getType()->isPointerTy();
    return isPtrTy && isHeapAllocExtFunViaRet(cs->getCalledFunction());
}

isHeapAllocExtFunViaArg()

bool SVF::SVFUtil::isHeapAllocExtFunViaArg ( const SVFFunction *  fun )

inline

Definition at line 302 of file SVFUtil.h.

{
    return fun && ExtAPI::getExtAPI()->is_arg_alloc(fun);
}

isHeapAllocExtFunViaRet()

bool SVF::SVFUtil::isHeapAllocExtFunViaRet ( const SVFFunction *  fun )

inline

Return true if the call is a heap allocator/reallocator.

note that these two functions are not suppose to be used externally

Definition at line 296 of file SVFUtil.h.

{
    return fun && (ExtAPI::getExtAPI()->is_alloc(fun)
                   || ExtAPI::getExtAPI()->is_realloc(fun));
}

isIntrinsicInst() [1/2]

bool SVF::SVFUtil::isIntrinsicInst

(

const ICFGNode *

inst

)

Definition at line 334 of file SVFUtil.cpp.

{
    if (const CallICFGNode* call = SVFUtil::dyn_cast<CallICFGNode>(inst))
    {
        const SVFFunction* func = call->getCalledFunction();
        if (func && func->isIntrinsic())
        {
            return true;
        }
    }
    return false;
}

isIntrinsicInst() [2/2]

bool SVF::SVFUtil::isIntrinsicInst

(

const SVFInstruction *

inst

)

Return true if it is an llvm intrinsic instruction.

Return true if it is an llvm intrinsic instruction

Definition at line 248 of file SVFUtil.cpp.

{
    if (const SVFCallInst* call = SVFUtil::dyn_cast<SVFCallInst>(inst))
    {
        const SVFFunction* func = call->getCalledFunction();
        if (func && func->isIntrinsic())
        {
            return true;
        }
    }
    return false;
}

isLockAquireCall()

bool SVF::SVFUtil::isLockAquireCall ( const CallICFGNode *  cs )

inline

Return true if this is a lock acquire call

Definition at line 411 of file SVFUtil.h.

{
    return ThreadAPI::getThreadAPI()->isTDAcquire(cs);
}

isLockReleaseCall()

bool SVF::SVFUtil::isLockReleaseCall ( const CallICFGNode *  cs )

inline

Return true if this is a lock acquire call

Definition at line 419 of file SVFUtil.h.

{
    return ThreadAPI::getThreadAPI()->isTDRelease(cs);
}

isMemcpyExtFun()

bool SVF::SVFUtil::isMemcpyExtFun ( const SVFFunction *  fun )

inline

Definition at line 283 of file SVFUtil.h.

{
    return fun && ExtAPI::getExtAPI()->is_memcpy(fun);
}

isMemsetExtFun()

bool SVF::SVFUtil::isMemsetExtFun ( const SVFFunction *  fun )

inline

Definition at line 288 of file SVFUtil.h.

{
    return fun && ExtAPI::getExtAPI()->is_memset(fun);
}

isNonInstricCallSite()

bool SVF::SVFUtil::isNonInstricCallSite ( const ICFGNode *  inst )

inline

Whether an instruction is a callsite in the application code, excluding llvm intrinsic calls.

Definition at line 189 of file SVFUtil.h.

{
    if(isIntrinsicInst(inst))
        return false;
    return isCallSite(inst);
}

isProgEntryFunction()

bool SVF::SVFUtil::isProgEntryFunction ( const SVFFunction *  fun )

inline

Program entry function e.g. main.

Return true if this is a program entry function (e.g. main)

Definition at line 325 of file SVFUtil.h.

{
    return fun && fun->getName() == "main";
}

isProgExitCall()

bool SVF::SVFUtil::isProgExitCall

(

const CallICFGNode *

cs

)

Definition at line 397 of file SVFUtil.cpp.

{
    return isProgExitFunction(cs->getCalledFunction());
}

isProgExitFunction()

bool SVF::SVFUtil::isProgExitFunction ( const SVFFunction *  fun )

inline

Return true if this is a program exit function call.

Definition at line 338 of file SVFUtil.h.

{
    return fun && (fun->getName() == "exit" ||
                   fun->getName() == "__assert_rtn" ||
                   fun->getName() == "__assert_fail" );
}

isReallocExtCall()

bool SVF::SVFUtil::isReallocExtCall

(

const CallICFGNode *

cs

)

Definition at line 382 of file SVFUtil.cpp.

{
    bool isPtrTy = cs->getType()->isPointerTy();
    return isPtrTy && isReallocExtFun(cs->getCalledFunction());
}

isReallocExtFun()

bool SVF::SVFUtil::isReallocExtFun ( const SVFFunction *  fun )

inline

Return true if the call is a heap reallocator.

note that this function is not suppose to be used externally

Definition at line 317 of file SVFUtil.h.

{
    return fun && (ExtAPI::getExtAPI()->is_realloc(fun));
}

isRetInstNode()

bool SVF::SVFUtil::isRetInstNode

(

const ICFGNode *

node

)

Definition at line 389 of file SVFUtil.cpp.

{
    if (const auto& intraNode = dyn_cast<IntraICFGNode>(node))
        return intraNode->isRetInst();
    else
        return false;
}

isThreadExitCall()

bool SVF::SVFUtil::isThreadExitCall ( const CallICFGNode *  cs )

inline

Return true if this is a thread exit call

Definition at line 403 of file SVFUtil.h.

{
    return ThreadAPI::getThreadAPI()->isTDExit(cs);
}

isThreadForkCall()

bool SVF::SVFUtil::isThreadForkCall ( const CallICFGNode *  inst )

inline

Return true if this is a thread creation call

Definition at line 387 of file SVFUtil.h.

{
    return ThreadAPI::getThreadAPI()->isTDFork(inst);
}

isThreadJoinCall()

bool SVF::SVFUtil::isThreadJoinCall ( const CallICFGNode *  cs )

inline

Return true if this is a thread join call

Definition at line 395 of file SVFUtil.h.

{
    return ThreadAPI::getThreadAPI()->isTDJoin(cs);
}

matchArgs()

bool SVF::SVFUtil::matchArgs	(	const CallICFGNode *	call,
		const SVFFunction *	callee
	)

Match arguments for callsite at caller and callee if the arg size does not match then we do not need to connect this parameter unless the callee is a variadic function (the first parameter of variadic function is its parameter number)

Match arguments for callsite at caller and callee if the arg size does not match then we do not need to connect this parameter unless the callee is a variadic function (the first parameter of variadic function is its parameter number) e.g., void variadicFoo(int num, ...); variadicFoo(5, 1,2,3,4,5) for variadic function, callsite arg size must be greater than or equal to callee arg size

Definition at line 321 of file SVFUtil.cpp.

{
    if (callee->isVarArg() || ThreadAPI::getThreadAPI()->isTDFork(call))
        return call->arg_size() >= callee->arg_size();
    else
        return call->arg_size() == callee->arg_size();
}

mergePtsOccMaps()

template<typename Data >

void SVF::SVFUtil::mergePtsOccMaps	(	Map< Data, unsigned > &	to,
		const Map< Data, unsigned >	from
	)

Given a map mapping points-to sets to a count, adds from into to.

Definition at line 226 of file SVFUtil.h.

{
    for (const typename Map<Data, unsigned>::value_type &ptocc : from)
    {
        to[ptocc.first] += ptocc.second;
    }
}

move()

template<typename T >

constexpr std::remove_reference< T >::type && SVF::SVFUtil::move ( T &&  t )

constexprnoexcept

Definition at line 447 of file SVFUtil.h.

{
    return std::move(t);
}

outs()

std::ostream & SVF::SVFUtil::outs ( )

inline

Overwrite llvm::outs()

Definition at line 50 of file SVFUtil.h.

{
    return std::cout;
}

pasMsg()

std::string SVF::SVFUtil::pasMsg

(

const std::string &

msg

)

Print each pass/phase message by converting a string into blue string output.

print each pass/phase message by converting a string into blue string output

Definition at line 100 of file SVFUtil.cpp.

{
    return KBLU + msg + KNRM;
}

ptsToNodeBS()

NodeBS SVF::SVFUtil::ptsToNodeBS ( const PointsTo &  pts )

inline

Definition at line 159 of file SVFUtil.h.

{
    NodeBS nbs;
    for (const NodeID o : pts) nbs.set(o);
    return nbs;
}

removeKey() [1/2]

template<typename Key , typename KeySet >

void SVF::SVFUtil::removeKey ( const Key &  key, KeySet &  keySet  )

inline

Removes an element from a Set/CondSet (or anything implementing erase).

Definition at line 252 of file SVFUtil.h.

{
    keySet.erase(key);
}

removeKey() [2/2]

void SVF::SVFUtil::removeKey ( const NodeID &  key, NodeBS &  keySet  )

inline

Removes a NodeID from a NodeBS.

Definition at line 258 of file SVFUtil.h.

{
    keySet.reset(key);
}

reportMemoryUsageKB()

void SVF::SVFUtil::reportMemoryUsageKB	(	const std::string &	infor,
		OutStream &	O = SVFUtil::outs()
	)

Print memory usage in KB.

Print memory usage

Definition at line 168 of file SVFUtil.cpp.

{
    u32_t vmrss, vmsize;
    if (getMemoryUsageKB(&vmrss, &vmsize))
        O << infor << "\tVmRSS: " << vmrss << "\tVmSize: " << vmsize << "\n";
}

split()

std::vector< std::string > SVF::SVFUtil::split ( const std::string &  s, char  separator  )

inline

Split into two substrings around the first occurrence of a separator string.

Definition at line 203 of file SVFUtil.h.

{
    std::vector<std::string> output;
    std::string::size_type prev_pos = 0, pos = 0;
    while ((pos = s.find(separator, pos)) != std::string::npos)
    {
        std::string substring(s.substr(prev_pos, pos - prev_pos));
        if (!substring.empty())
        {
            output.push_back(substring);
        }
        prev_pos = ++pos;
    }
    std::string lastSubstring(s.substr(prev_pos, pos - prev_pos));
    if (!lastSubstring.empty())
    {
        output.push_back(lastSubstring);
    }
    return output;
}

startAnalysisLimitTimer()

bool SVF::SVFUtil::startAnalysisLimitTimer

(

unsigned

timeLimit

)

Starts an analysis timer. If timeLimit is 0, sets no timer. If an alarm has already been set, does not set another. Returns whether we set a timer or not.

Definition at line 290 of file SVFUtil.cpp.

{
    if (timeLimit == 0) return false;
 
    // If an alarm is already set, don't set another. That means this analysis
    // is part of another which has a time limit.
    unsigned remainingSeconds = alarm(0);
    if (remainingSeconds != 0)
    {
        // Continue the previous alarm and move on.
        alarm(remainingSeconds);
        return false;
    }
 
    signal(SIGALRM, &timeLimitReached);
    alarm(timeLimit);
    return true;
}

stopAnalysisLimitTimer()

void SVF::SVFUtil::stopAnalysisLimitTimer

(

bool

limitTimerSet

)

Stops an analysis timer. limitTimerSet indicates whether the caller set the timer or not (return value of startLimitTimer).

Definition at line 311 of file SVFUtil.cpp.

{
    if (limitTimerSet) alarm(0);
}

sucMsg()

std::string SVF::SVFUtil::sucMsg

(

const std::string &

msg

)

Returns successful message by converting a string into green string output.

print successful message by converting a string into green string output

Definition at line 54 of file SVFUtil.cpp.

{
    return KGRN + msg + KNRM;
}

timeLimitReached()

void SVF::SVFUtil::timeLimitReached

(

int

signum

)

Function to call when alarm for time limit hits.

Definition at line 281 of file SVFUtil.cpp.

{
    SVFUtil::outs().flush();
    // TODO: output does not indicate which time limit is reached.
    //       This can be better in the future.
    SVFUtil::outs() << "WPA: time limit reached\n";
    exit(101);
}

writeWrnMsg()

void SVF::SVFUtil::writeWrnMsg

(

const std::string &

msg

)

Writes a message run through wrnMsg.

Definition at line 67 of file SVFUtil.cpp.

{
    if (Options::DisableWarn())
        return;
    outs() << wrnMsg(msg) << "\n";
}

wrnMsg()

std::string SVF::SVFUtil::wrnMsg

(

const std::string &

msg

)

Returns warning message by converting a string into yellow string output.

print warning message by converting a string into yellow string output

Definition at line 62 of file SVFUtil.cpp.

{
    return KYEL + msg + KNRM;
}

Variable Documentation

is_iterable_v

template<typename T >

constexpr bool SVF::SVFUtil::is_iterable_v = is_iterable<T>::value

constexpr

Definition at line 467 of file SVFUtil.h.

is_map_v

template<typename... Ts>

constexpr bool SVF::SVFUtil::is_map_v = is_map<Ts...>::value

constexpr

Definition at line 476 of file SVFUtil.h.

is_sequence_container_v

template<typename... Ts>

constexpr bool SVF::SVFUtil::is_sequence_container_v = is_sequence_container<Ts...>::value

constexpr

Definition at line 497 of file SVFUtil.h.

is_set_v

template<typename... Ts>

constexpr bool SVF::SVFUtil::is_set_v = is_set<Ts...>::value

constexpr

Definition at line 485 of file SVFUtil.h.