SVF::ExtAPI Class Reference

#include <ExtAPI.h>

Public Member Functions
std::string	getExtBcPath ()
std::string	getExtFuncAnnotation (const FunObjVar *fun, const std::string &funcAnnotation)
const std::vector< std::string > &	getExtFuncAnnotations (const FunObjVar *fun)
bool	hasExtFuncAnnotation (const FunObjVar *fun, const std::string &funcAnnotation)
bool	has_static (const FunObjVar *F)
bool	is_memcpy (const FunObjVar *F)
bool	is_memset (const FunObjVar *F)
bool	is_alloc (const FunObjVar *F)
bool	is_arg_alloc (const FunObjVar *F)
bool	is_alloc_stack_ret (const FunObjVar *F)
s32_t	get_alloc_arg_pos (const FunObjVar *F)
bool	is_realloc (const FunObjVar *F)
bool	is_ext (const FunObjVar *funObjVar)

Static Public Member Functions
static ExtAPI *	getExtAPI ()
static void	destory ()
static bool	setExtBcPath (const std::string &path)

Private Member Functions
	ExtAPI ()=default
void	setExtFuncAnnotations (const FunObjVar *fun, const std::vector< std::string > &funcAnnotations)

Private Attributes
Map< const FunObjVar *, std::vector< std::string > >	funObjVar2Annotations

Static Private Attributes
static ExtAPI *	extOp = nullptr
static std::string	extBcPath = ""

Friends
class	LLVMModuleSet
class	SVFIRBuilder
class	GraphDBClient

Detailed Description

Definition at line 45 of file ExtAPI.h.

Constructor & Destructor Documentation

ExtAPI()

SVF::ExtAPI::ExtAPI ( )

privatedefault

Member Function Documentation

destory()

void ExtAPI::destory ( )

static

Definition at line 52 of file ExtAPI.cpp.

{
    if (extOp != nullptr)
    {
        delete extOp;
        extOp = nullptr;
    }
}

get_alloc_arg_pos()

s32_t ExtAPI::get_alloc_arg_pos

(

const FunObjVar *

F

)

Definition at line 270 of file ExtAPI.cpp.

{
    std::string allocArg = getExtFuncAnnotation(F, "ALLOC_HEAP_ARG");
    assert(!allocArg.empty() && "Not an alloc call via argument or incorrect extern function annotation!");
 
    std::string number;
    for (char c : allocArg)
    {
        if (isdigit(c))
            number.push_back(c);
    }
    assert(!number.empty() && "Incorrect naming convention for svf external functions(ALLOC_HEAP_ARG + number)?");
    return std::stoi(number);
}

getExtAPI()

ExtAPI * ExtAPI::getExtAPI ( )

static

Definition at line 43 of file ExtAPI.cpp.

{
    if (extOp == nullptr)
    {
        extOp = new ExtAPI;
    }
    return extOp;
}

getExtBcPath()

std::string ExtAPI::getExtBcPath

(

)

Definition at line 111 of file ExtAPI.cpp.

{
    // Try to locate extapi.bc in the following order:
    // 1. If setExtBcPath() has been called, use that path.
    // 2. If the command line argument -extapi=path/to/extapi.bc is provided, use that path.
    // 3. If SVF is being developed and used directly from a build directory, try the build dir (SVF_BUILD_DIR).
    // 4. If the SVF_DIR environment variable is set, try $SVF_DIR with the standard relative path.
    // 5. If installed via npm, use `npm root` and append the standard relative path.
    // 6. As a last resort, use the directory of the loaded libSVFCore.so (or .dylib) and append extapi.bc.
 
    std::vector<std::string> candidatePaths;
 
    // 1. Use path set by setExtBcPath()
    if (!extBcPath.empty())
        return extBcPath;
 
    // 2. Use command line argument -extapi=...
    if (setExtBcPath(Options::ExtAPIPath()))
    {
        return extBcPath;
    }
    else
    {
        candidatePaths.push_back(Options::ExtAPIPath());
    }
 
    // 3. SVF developer: try build directory (SVF_BUILD_DIR)
    if (setExtBcPath(SVF_BUILD_DIR "/lib/extapi.bc"))
    {
        return extBcPath;
    }
    else
    {
        candidatePaths.push_back(SVF_BUILD_DIR "/lib/extapi.bc");
    }
 
    // 4. Use $SVF_DIR environment variable + standard relative path
    if (setExtBcPath(getFilePath("SVF_DIR")))
    {
        return extBcPath;
    }
    else
    {
        candidatePaths.push_back(getFilePath("SVF_DIR"));
    }
 
    // 5. Use npm root + standard relative path (for npm installations)
    std::string npmPath = getFilePath("npm root");
    if (setExtBcPath(npmPath))
    {
        return extBcPath;
    }
    else
    {
        candidatePaths.push_back(npmPath.empty() ? "npm root unavailable" : npmPath);
    }
 
    // 6. Use the directory of the loaded libSVFCore.so/.dylib + extapi.bc
    std::string soPath = SVFUtil::getCurrentSOPath();
    if (!soPath.empty())
    {
        std::string dir = soPath.substr(0, soPath.find_last_of('/'));
        std::string candidate = dir + "/extapi.bc";
        if (setExtBcPath(candidate))
        {
            return extBcPath;
        }
        else
        {
            candidatePaths.push_back(candidate);
        }
    }
 
    // If all candidate paths failed, print error and suggestions
    SVFUtil::errs() << "ERROR: Failed to locate \"extapi.bc\". Tried the following candidate paths:" << std::endl;
    for (const auto& path : candidatePaths)
    {
        SVFUtil::errs() << "    " << path << std::endl;
    }
    SVFUtil::errs() << "To override the default locations for \"extapi.bc\", you can:" << std::endl
                    << "\t1. Use the command line argument \"-extapi=path/to/extapi.bc\"" << std::endl
                    << "\t2. Use the \"setExtBcPath()\" function *BEFORE* calling \"buildSVFModule()\"" << std::endl
                    << "\t3. Override the paths in \"include/SVF/Util/config.h\" (WARNING: will be overwritten "
                    << "when rebuilding SVF (generated by CMakeLists.txt))" << std::endl;
    abort();
}

getExtFuncAnnotation()

std::string ExtAPI::getExtFuncAnnotation	(	const FunObjVar *	fun,
		const std::string &	funcAnnotation
	)

Definition at line 219 of file ExtAPI.cpp.

{
    assert(fun && "Null FunObjVar* pointer");
    auto it = funObjVar2Annotations.find(fun);
    if (it != funObjVar2Annotations.end())
    {
        for (const std::string& annotation : it->second)
            if (annotation.find(funcAnnotation) != std::string::npos)
                return annotation;
    }
    return "";
}

getExtFuncAnnotations()

const std::vector< std::string > & ExtAPI::getExtFuncAnnotations

(

const FunObjVar *

fun

)

Definition at line 232 of file ExtAPI.cpp.

{
    assert(fun && "Null FunObjVar* pointer");
    auto it = funObjVar2Annotations.find(fun);
    if (it != funObjVar2Annotations.end())
        return it->second;
    return funObjVar2Annotations[fun];
}

has_static()

bool SVF::ExtAPI::has_static

(

const FunObjVar *

F

)

hasExtFuncAnnotation()

bool ExtAPI::hasExtFuncAnnotation	(	const FunObjVar *	fun,
		const std::string &	funcAnnotation
	)

Definition at line 205 of file ExtAPI.cpp.

{
    assert(fun && "Null FunObjVar* pointer");
    auto it = funObjVar2Annotations.find(fun);
    if (it != funObjVar2Annotations.end())
    {
        for (const std::string& annotation : it->second)
            if (annotation.find(funcAnnotation) != std::string::npos)
                return true;
    }
    return false;
}

is_alloc()

bool ExtAPI::is_alloc

(

const FunObjVar *

F

)

Definition at line 253 of file ExtAPI.cpp.

{
    return F && hasExtFuncAnnotation(F, "ALLOC_HEAP_RET");
}

is_alloc_stack_ret()

bool ExtAPI::is_alloc_stack_ret

(

const FunObjVar *

F

)

Definition at line 264 of file ExtAPI.cpp.

{
    return F && hasExtFuncAnnotation(F, "ALLOC_STACK_RET");
}

is_arg_alloc()

bool ExtAPI::is_arg_alloc

(

const FunObjVar *

F

)

Definition at line 259 of file ExtAPI.cpp.

{
    return F && hasExtFuncAnnotation(F, "ALLOC_HEAP_ARG");
}

is_ext()

bool ExtAPI::is_ext

(

const FunObjVar *

funObjVar

)

Definition at line 290 of file ExtAPI.cpp.

{
    assert(F && "Null FunObjVar* pointer");
    if (F->isDeclaration() || F->isIntrinsic())
        return true;
    else if (hasExtFuncAnnotation(F, "OVERWRITE") && getExtFuncAnnotations(F).size() == 1)
        return false;
    else
        return !getExtFuncAnnotations(F).empty();
}

is_memcpy()

bool ExtAPI::is_memcpy

(

const FunObjVar *

F

)

Definition at line 241 of file ExtAPI.cpp.

{
    return F &&
           (hasExtFuncAnnotation(F, "MEMCPY") ||  hasExtFuncAnnotation(F, "STRCPY")
            || hasExtFuncAnnotation(F, "STRCAT"));
}

is_memset()

bool ExtAPI::is_memset

(

const FunObjVar *

F

)

Definition at line 248 of file ExtAPI.cpp.

{
    return F && hasExtFuncAnnotation(F, "MEMSET");
}

is_realloc()

bool ExtAPI::is_realloc

(

const FunObjVar *

F

)

Definition at line 286 of file ExtAPI.cpp.

{
    return F && hasExtFuncAnnotation(F, "REALLOC_HEAP_RET");
}

setExtBcPath()

bool ExtAPI::setExtBcPath ( const std::string &  path )

static

Definition at line 62 of file ExtAPI.cpp.

{
    if (!path.empty() && SVFUtil::fileExists(path))
    {
        extBcPath = path;
        return true;
    }
    return false;
}

setExtFuncAnnotations()

void ExtAPI::setExtFuncAnnotations ( const FunObjVar *  fun, const std::vector< std::string > &  funcAnnotations  )

private

Definition at line 199 of file ExtAPI.cpp.

{
    assert(fun && "Null FunObjVar* pointer");
    funObjVar2Annotations[fun] = funcAnnotations;
}

Friends And Related Symbol Documentation

GraphDBClient

friend class GraphDBClient

friend

Definition at line 49 of file ExtAPI.h.

LLVMModuleSet

friend class LLVMModuleSet

friend

Definition at line 47 of file ExtAPI.h.

SVFIRBuilder

friend class SVFIRBuilder

friend

Definition at line 48 of file ExtAPI.h.

Member Data Documentation

extBcPath

std::string ExtAPI::extBcPath = ""

staticprivate

Definition at line 59 of file ExtAPI.h.

extOp

ExtAPI * ExtAPI::extOp = nullptr

staticprivate

Definition at line 53 of file ExtAPI.h.

funObjVar2Annotations

Map<const FunObjVar*, std::vector<std::string> > SVF::ExtAPI::funObjVar2Annotations

private

Definition at line 56 of file ExtAPI.h.

---

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

• /home/runner/work/SVF/SVF/svf/include/Util/ExtAPI.h
• /home/runner/work/SVF/SVF/svf/lib/Util/ExtAPI.cpp