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_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	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	fileExists (const std::string &path)
	Check whether a file exists at the given path.
std::string	getStdoutFromCommand (const std::string &command)
	Execute a shell command and capture its stdout output.
std::string	getCurrentSOPath ()
	Return the absolute path of the current module/executable.
bool	cmpPts (const PointsTo &lpts, const PointsTo &rpts)
bool	cmpNodeBS (const NodeBS &lpts, const NodeBS &rpts)
void	dumpPointsToList (const PointsToList &ptl)
bool	isIntrinsicInst (const ICFGNode *inst)
	Return true if it is an llvm intrinsic 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 FunObjVar *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.
void	startAnalysisLimitTimer (unsigned timeLimit)
	Starts analysis timer. timeLimit must be non-0. Timer must not be already set.
void	stopAnalysisLimitTimer (void)
	Stops analysis timer.
bool	isExtCall (const FunObjVar *fun)
bool	isHeapAllocExtFunViaRet (const FunObjVar *fun)
	Return true if the call is a heap allocator/reallocator.
bool	isHeapAllocExtFunViaArg (const FunObjVar *fun)
u32_t	getHeapAllocHoldingArgPosition (const FunObjVar *fun)
	Get the position of argument that holds an allocated heap object.
bool	isReallocExtFun (const FunObjVar *fun)
	Return true if the call is a heap reallocator.
bool	isProgEntryFunction (const FunObjVar *)
	Program entry function e.g. main.
const FunObjVar *	getProgFunction (const std::string &funName)
	Get program entry function from function name.
const FunObjVar *	getProgEntryFunction ()
	Get program entry function.
bool	isProgExitFunction (const FunObjVar *fun)
	Return true if this is a program exit function call.
bool	isArgOfUncalledFunction (const SVFVar *svfvar)
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)
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 176 of file SVFUtil.h.

Function Documentation

bugMsg1()

std::string SVF::SVFUtil::bugMsg1

(

const std::string &

msg

)

Definition at line 103 of file SVFUtil.cpp.

{
    return KYEL + msg + KNRM;
}

bugMsg2()

std::string SVF::SVFUtil::bugMsg2

(

const std::string &

msg

)

Definition at line 108 of file SVFUtil.cpp.

{
    return KPUR + msg + KNRM;
}

bugMsg3()

std::string SVF::SVFUtil::bugMsg3

(

const std::string &

msg

)

Definition at line 113 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 142 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 124 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 159 of file SVFUtil.cpp.

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

dumpPointsToList()

void SVF::SVFUtil::dumpPointsToList

(

const PointsToList &

ptl

)

Definition at line 144 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 129 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 169 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 178 of file SVFUtil.cpp.

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

dumpSparseSet()

void SVF::SVFUtil::dumpSparseSet

(

const NodeBS &

To

)

Definition at line 137 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 98 of file SVFUtil.cpp.

{
    return KRED + msg + KNRM;
}

errs()

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

inline

Overwrite llvm::errs()

Definition at line 64 of file SVFUtil.h.

{
    return std::cerr;
}

fileExists()

bool SVF::SVFUtil::fileExists

(

const std::string &

path

)

Check whether a file exists at the given path.

Definition at line 271 of file SVFUtil.cpp.

{
    struct stat statbuf;
    return !path.empty() && (stat(path.c_str(), &statbuf) == 0);
}

getActualParmAtForkSite()

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

inline

Return sole argument of the thread routine.

Definition at line 413 of file SVFUtil.h.

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

getCurrentSOPath()

std::string SVF::SVFUtil::getCurrentSOPath

(

)

Return the absolute path of the current module/executable.

Definition at line 302 of file SVFUtil.cpp.

{
#ifdef _WIN32
    char path[MAX_PATH];
    HMODULE hm = NULL;
    if (GetModuleHandleExA(GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS |
                           GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT,
                           (LPCSTR)&getCurrentSOPath, &hm))
    {
        GetModuleFileNameA(hm, path, sizeof(path));
        std::string s(path);
        for (size_t i = 0; i < s.length(); ++i)
        {
            if (s[i] == '\\')
            {
                s[i] = '/';
            }
        }
        return s;
    }
    return "";
#else
    Dl_info info;
    if (dladdr((void*)&getCurrentSOPath, &info) && info.dli_fname)
    {
        return std::string(info.dli_fname);
    }
    return "";
#endif
}

getForkedFun()

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

inline

Return thread fork function.

Definition at line 336 of file SVFUtil.h.

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

getHeapAllocHoldingArgPosition() [1/2]

u32_t SVF::SVFUtil::getHeapAllocHoldingArgPosition

(

const CallICFGNode *

cs

)

Definition at line 434 of file SVFUtil.cpp.

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

getHeapAllocHoldingArgPosition() [2/2]

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

inline

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

Definition at line 298 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 199 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 520 of file SVFUtil.cpp.

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

getProgEntryFunction()

const FunObjVar * SVF::SVFUtil::getProgEntryFunction

(

)

Get program entry function.

Get program entry function from module.

Definition at line 499 of file SVFUtil.cpp.

{
    const 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 FunObjVar * SVF::SVFUtil::getProgFunction

(

const std::string &

funName

)

Get program entry function from function name.

Get program entry function from module.

Definition at line 486 of file SVFUtil.cpp.

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

getStdoutFromCommand()

std::string SVF::SVFUtil::getStdoutFromCommand

(

const std::string &

command

)

Execute a shell command and capture its stdout output.

Definition at line 277 of file SVFUtil.cpp.

{
    char buffer[128];
    std::string result;
 
    FILE* pipe = popen(command.c_str(), "r");
    if (!pipe)
        return "";
 
    while (fgets(buffer, sizeof(buffer), pipe) != nullptr)
    {
        result += buffer;
    }
 
    int status = pclose(pipe);
    if (status != 0)
        return "";
 
    // remove trailing newlines
    result.erase(std::remove(result.begin(), result.end(), '\n'), result.end());
    result.erase(std::remove(result.begin(), result.end(), '\r'), result.end());
 
    return result;
}

hclustMethodToString()

std::string SVF::SVFUtil::hclustMethodToString

(

hclust_fast_methods

method

)

Returns a string representation of a hclust method.

Definition at line 335 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 249 of file SVFUtil.cpp.

{
#ifdef _WIN32
    // On Windows, stack size is set at link time via CMake (/STACK:268435456)
#else
    // Increase stack size via POSIX rlimit
    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");
        }
    }
#endif
}

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 240 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 246 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 SVFVar *

svfvar

)

Definition at line 511 of file SVFUtil.cpp.

{
    const ValVar* pVar = PAG::getPAG()->getBaseValVar(svfvar->getId());
    if(const ArgValVar* arg = SVFUtil::dyn_cast<ArgValVar>(pVar))
        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 405 of file SVFUtil.h.

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

isCallSite()

bool SVF::SVFUtil::isCallSite

(

const ICFGNode *

inst

)

Definition at line 405 of file SVFUtil.cpp.

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

isExtCall() [1/3]

bool SVF::SVFUtil::isExtCall

(

const CallICFGNode *

cs

)

Definition at line 423 of file SVFUtil.cpp.

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

isExtCall() [2/3]

bool SVF::SVFUtil::isExtCall

(

const FunObjVar *

fun

)

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 526 of file SVFUtil.cpp.

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

isExtCall() [3/3]

bool SVF::SVFUtil::isExtCall

(

const ICFGNode *

node

)

Definition at line 440 of file SVFUtil.cpp.

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

isHeapAllocExtCall()

bool SVF::SVFUtil::isHeapAllocExtCall

(

const ICFGNode *

cs

)

Definition at line 446 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 428 of file SVFUtil.cpp.

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

isHeapAllocExtCallViaRet()

bool SVF::SVFUtil::isHeapAllocExtCallViaRet

(

const CallICFGNode *

cs

)

interfaces to be used externally

Definition at line 452 of file SVFUtil.cpp.

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

isHeapAllocExtFunViaArg()

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

inline

Definition at line 290 of file SVFUtil.h.

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

isHeapAllocExtFunViaRet()

bool SVF::SVFUtil::isHeapAllocExtFunViaRet ( const FunObjVar *  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 284 of file SVFUtil.h.

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

isIntrinsicInst()

bool SVF::SVFUtil::isIntrinsicInst

(

const ICFGNode *

inst

)

Return true if it is an llvm intrinsic instruction.

Definition at line 410 of file SVFUtil.cpp.

{
    if (const CallICFGNode* call = SVFUtil::dyn_cast<CallICFGNode>(inst))
    {
        const FunObjVar* 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 389 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 397 of file SVFUtil.h.

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

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 190 of file SVFUtil.h.

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

isProgEntryFunction()

bool SVF::SVFUtil::isProgEntryFunction

(

const FunObjVar *

funObjVar

)

Program entry function e.g. main.

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

Definition at line 531 of file SVFUtil.cpp.

{
    const char* main_name=Options::SVFMain() ? "svf.main" : "main";
    return funObjVar && funObjVar->getName() == main_name;
}

isProgExitCall()

bool SVF::SVFUtil::isProgExitCall

(

const CallICFGNode *

cs

)

Definition at line 480 of file SVFUtil.cpp.

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

isProgExitFunction()

bool SVF::SVFUtil::isProgExitFunction

(

const FunObjVar *

fun

)

Return true if this is a program exit function call.

Definition at line 473 of file SVFUtil.cpp.

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

isReallocExtCall()

bool SVF::SVFUtil::isReallocExtCall

(

const CallICFGNode *

cs

)

Definition at line 458 of file SVFUtil.cpp.

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

isReallocExtFun()

bool SVF::SVFUtil::isReallocExtFun ( const FunObjVar *  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 306 of file SVFUtil.h.

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

isRetInstNode()

bool SVF::SVFUtil::isRetInstNode

(

const ICFGNode *

node

)

Definition at line 465 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 381 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 365 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 373 of file SVFUtil.h.

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

matchArgs()

bool SVF::SVFUtil::matchArgs	(	const CallICFGNode *	call,
		const FunObjVar *	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 397 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 227 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 425 of file SVFUtil.h.

{
    return std::move(t);
}

outs()

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

inline

Overwrite llvm::outs()

Definition at line 58 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 121 of file SVFUtil.cpp.

{
    return KBLU + msg + KNRM;
}

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 253 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 259 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 189 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 204 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()

void SVF::SVFUtil::startAnalysisLimitTimer

(

unsigned

timeLimit

)

Starts analysis timer. timeLimit must be non-0. Timer must not be already set.

Definition at line 364 of file SVFUtil.cpp.

{
#ifdef _WIN32
    // POSIX alarm signals are not available on Win32
    (void)timeLimit;
#else
    assert(timeLimit > 0 && "startAnalysisTimer: given non-0 time-limit.");
 
    // 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);
    assert(remainingSeconds != 0 && "startAnalysisTimer: attempt to set a second alarm.");
 
    signal(SIGALRM, &timeLimitReached);
    alarm(timeLimit);
#endif
}

stopAnalysisLimitTimer()

void SVF::SVFUtil::stopAnalysisLimitTimer

(

void

)

Stops analysis timer.

Definition at line 383 of file SVFUtil.cpp.

{
#ifdef _WIN32
    // No-op on Win32
#else
    alarm(0);
#endif
}

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 75 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 355 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 88 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 83 of file SVFUtil.cpp.

{
    return KYEL + msg + KNRM;
}