svf-tools 1.0.704 → 1.0.706

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svf-tools",
-  "version": "1.0.704",
+  "version": "1.0.706",
   "description": "* <b>[TypeClone](https://github.com/SVF-tools/SVF/wiki/TypeClone) published in our [ECOOP paper](https://yuleisui.github.io/publications/ecoop20.pdf) is now available in SVF </b> * <b>SVF now uses a single script for its build. Just type [`source ./build.sh`](https://github.com/SVF-tools/SVF/blob/master/build.sh) in your terminal, that's it!</b> * <b>SVF now supports LLVM-10.0.0! </b> * <b>We thank [bsauce](https://github.com/bsauce) for writing a user manual of SVF ([link1](https://www.jianshu.com/p/068a08ec749c) and [link2](https://www.jianshu.com/p/777c30d4240e)) in Chinese </b> * <b>SVF now supports LLVM-9.0.0 (Thank [Byoungyoung Lee](https://github.com/SVF-tools/SVF/issues/142) for his help!). </b> * <b>SVF now supports a set of [field-sensitive pointer analyses](https://yuleisui.github.io/publications/sas2019a.pdf). </b> * <b>[Use SVF as an external lib](https://github.com/SVF-tools/SVF/wiki/Using-SVF-as-a-lib-in-your-own-tool) for your own project (Contributed by [Hongxu Chen](https://github.com/HongxuChen)). </b> * <b>SVF now supports LLVM-7.0.0. </b> * <b>SVF now supports Docker. [Try SVF in Docker](https://github.com/SVF-tools/SVF/wiki/Try-SVF-in-Docker)! </b> * <b>SVF now supports [LLVM-6.0.0](https://github.com/svf-tools/SVF/pull/38) (Contributed by [Jack Anthony](https://github.com/jackanth)). </b> * <b>SVF now supports [LLVM-4.0.0](https://github.com/svf-tools/SVF/pull/23) (Contributed by Jared Carlson. Thank [Jared](https://github.com/jcarlson23) and [Will](https://github.com/dtzWill) for their in-depth [discussions](https://github.com/svf-tools/SVF/pull/18) about updating SVF!) </b> * <b>SVF now supports analysis for C++ programs.</b> <br />",
   "main": "index.js",
   "scripts": {

package/svf/include/Util/ExtAPI.h

@@ -31,8 +31,8 @@
 #define __ExtAPI_H
 
 #include "SVFIR/SVFValue.h"
-#include "Util/cJSON.h"
-#include "Util/config.h"
+#include <Util/cJSON.h>
+#include <Util/config.h>
 #include <string>
 #include <map>
 
@@ -261,7 +261,9 @@ public:
     static void destory();
 
     // Add an entry with the specified fields to the ExtAPI, which will be reflected immediately by further ExtAPI queries
-    void add_entry(const char* funName, extType type, bool overwrite_app_function);
+    void add_entry(const char* funName, const char* returnType,
+                   std::vector<const char*> argTypes, extType type,
+                   bool overwrite_app_function);
 
     // Get numeric index of the argument in external function
     u32_t getArgPos(const std::string& s);
@@ -299,6 +301,9 @@ public:
     // 0: Apply user-defined functions
     // 1: Apply function specification in ExtAPI.json
     u32_t isOverwrittenAppFunction(const SVF::SVFFunction *callee);
+    u32_t isOverwrittenAppFunction(const std::string& funcName);
+    // set priority of the function
+    void setOverWrittenAppFunction(const std::string& funcName, u32_t overwrite_app_function);
 
     // Does (F) have a static var X (unavailable to us) that its return points to?
     bool has_static(const SVFFunction *F);

package/svf/lib/Util/ExtAPI.cpp

@@ -185,13 +185,30 @@ void ExtAPI::destory()
     }
 }
 
-void ExtAPI::add_entry(const char* funName, extType type,
+void ExtAPI::add_entry(const char* funName, const char* returnType,
+                       std::vector<const char*> argTypes, extType type,
                        bool overwrite_app_function)
 {
-    assert(root);
-    assert(get_type(funName) == EFT_NULL);
+    assert(root && "Parse the json before adding additional entries");
+    assert(get_type(funName) == EFT_NULL && "Do not add entries that already exist");
     auto entry = cJSON_CreateObject();
 
+    // add the signature fields
+    auto returnTypeString = cJSON_CreateString(returnType);
+    cJSON_AddItemToObject(entry, "return", returnTypeString);
+
+    std::stringstream ss;
+    ss << "(";
+    for (auto str : argTypes)
+        ss << str << ",";
+    std::string formattedArgs = ss.str();
+    if (formattedArgs.back() == ',')
+        formattedArgs.back() = ')';
+    else
+        formattedArgs.append(")");
+    auto argsString = cJSON_CreateString(formattedArgs.c_str());
+    cJSON_AddItemToObject(entry, "argument", argsString);
+
     // add the type field
     auto typeString = cJSON_CreateString(extType_toString(type).c_str());
     cJSON_AddItemToObject(entry, JSON_OPT_FUNCTIONTYPE, typeString);
@@ -200,8 +217,8 @@ void ExtAPI::add_entry(const char* funName, extType type,
     auto overwriteBool = cJSON_CreateNumber(overwrite_app_function ? 1 : 0);
     cJSON_AddItemToObject(entry, JSON_OPT_OVERWRITE, overwriteBool);
 
-    // we don't know where the `funName` comes from, so copy it just in case
-    cJSON_AddItemToObject(root, strdup(funName), entry);
+    // add object to root
+    cJSON_AddItemToObject(root, funName, entry);
 }
 
 // Get the corresponding name in ext_t, e.g. "EXT_ADDR" in {"addr", EXT_ADDR},
@@ -416,6 +433,11 @@ ExtAPI::extType ExtAPI::get_type(const SVF::SVFFunction* F)
 u32_t ExtAPI::isOverwrittenAppFunction(const SVF::SVFFunction* callee)
 {
     std::string funName = get_name(callee);
+    return isOverwrittenAppFunction(funName);
+}
+
+u32_t ExtAPI::isOverwrittenAppFunction(const std::string& funName)
+{
     cJSON* item = get_FunJson(funName);
     if (item != nullptr)
     {
@@ -429,6 +451,16 @@ u32_t ExtAPI::isOverwrittenAppFunction(const SVF::SVFFunction* callee)
     return 0;
 }
 
+void ExtAPI::setOverWrittenAppFunction(const std::string& funcName, u32_t overwrite_app_function)
+{
+    auto item = get_FunJson(funcName);
+    assert(item && "Do not set fields for ExtAPI funcs that don't exist!");
+    auto overwrite_obj = item->child->next->next->next;
+    assert(overwrite_obj);
+    assert(strcmp(overwrite_obj->string, JSON_OPT_OVERWRITE) == 0);
+    cJSON_SetIntValue(overwrite_obj, overwrite_app_function);
+}
+
 // Does (F) have a static var X (unavailable to us) that its return points to?
 bool ExtAPI::has_static(const SVFFunction* F)
 {

package/svf-llvm/lib/SVFIRBuilder.cpp

@@ -1224,6 +1224,7 @@ void SVFIRBuilder::parseOperations(std::vector<ExtAPI::Operation>  &operations,
             else
             {
                 s32_t nodeIDType = ExtAPI::getExtAPI()->getNodeIDType(s);
+                // return value >= 0 is an argument node
                 if (nodeIDType >= 0)
                 {
                     if( svfcall->arg_size() <= (u32_t) nodeIDType)
@@ -1239,29 +1240,41 @@ void SVFIRBuilder::parseOperations(std::vector<ExtAPI::Operation>  &operations,
                         nodeIDMap[s] = pag->getValueNode(svfcall->getArgOperand(nodeIDType));
                     }
                 }
+                // return value = -1 is an inst node
                 else if (nodeIDType == -1)
                 {
                     operands.push_back(pag->getValueNode(svfcall));
                     nodeIDMap[s] = pag->getValueNode(svfcall);
                 }
+                // return value = -2 is a Dummy node
                 else if (nodeIDType == -2)
                 {
                     operands.push_back(pag->addDummyValNode());
                     nodeIDMap[s] = operands[operands.size() - 1];
                 }
+                // return value = -3 is an object node
                 else if (nodeIDType == -3)
                 {
                     if (svfcall->getType()->isPointerTy())
                     {
-                        operands.push_back(pag->getObjectNode(svfcall));
-                        nodeIDMap[s] = pag->getObjectNode(svfcall);
+                        NodeID objId;
+                        // Indirect call
+                        if (getCallee(svfcall) == nullptr)
+                            objId = pag->addDummyObjNode(svfcall->getType());
+                        else // Direct call
+                            objId = pag->getObjectNode(svfcall);
+
+                        operands.push_back(objId);
+                        nodeIDMap[s] = objId;
                     }
                 }
+                // return value = -4 is a nullptr node
                 else if (nodeIDType == -4)
                 {
                     operands.push_back(pag->getNullPtr());
                     nodeIDMap[s] = operands[operands.size() - 1];
                 }
+                // return value = -5 is an offset
                 else if (nodeIDType == -5)
                 {
                     for (char const &c : s)
@@ -1272,6 +1285,7 @@ void SVFIRBuilder::parseOperations(std::vector<ExtAPI::Operation>  &operations,
                     operands.push_back(atoi(s.c_str()));
                     nodeIDMap[s] = atoi(s.c_str());
                 }
+                // return value = -6 is an illegal operand format
                 else
                     assert(false && "The operand format of function operation is illegal!");
             }