svf-tools 1.0.703 → 1.0.704

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svf-tools",
-  "version": "1.0.703",
+  "version": "1.0.704",
   "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/SVFIR/{SVFIRRW.h → SVFFileSystem.h}

@@ -1,4 +1,4 @@
-//===- SVFIRRW.h -- SVF IR Reader and Writer ------------------------------===//
+//===- SVFFileSystem.h -- SVF IR Reader and Writer ------------------------===//
 //
 //  SVF - Static Value-Flow Analysis Framework
 //                     SVF: Static Value-Flow Analysis
@@ -21,8 +21,8 @@
 //
 //===----------------------------------------------------------------------===//
 
-#ifndef INCLUDE_SVFIRRW_H_
-#define INCLUDE_SVFIRRW_H_
+#ifndef INCLUDE_SVFFILESYSTEM_H_
+#define INCLUDE_SVFFILESYSTEM_H_
 
 #include "Graphs/GenericGraph.h"
 #include "Util/SVFUtil.h"
@@ -99,6 +99,7 @@ namespace SVF
 {
 /// @brief Forward declarations.
 ///@{
+class NodeIDAllocator;
 // Classes created upon SVFMoudle construction
 class SVFType;
 class SVFPointerType;
@@ -404,6 +405,7 @@ private:
 
     const char* numToStr(size_t n);
 
+    cJSON* toJson(const NodeIDAllocator* nodeIDAllocator);
     cJSON* toJson(const SymbolTableInfo* symTable);
     cJSON* toJson(const SVFModule* module);
     cJSON* toJson(const SVFType* type);
@@ -582,6 +584,14 @@ private:
         return root;
     }
 
+    /** The following 2 functions are intended to convert SparseBitVectors
+     * to JSON. But they're buggy. Commentting them out would enable the
+     * toJson(T) where is_iterable_v<T> is true. But that implementation is less
+     * space-efficient if the bitvector contains many elements.
+     * It is observed that upon construction, SVF IR bitvectors contain at most
+     * 1 element. In that case, we can just use the toJson(T) for iterable T
+     * without much space overhead.
+
     template <unsigned ElementSize>
     cJSON* toJson(const SparseBitVectorElement<ElementSize>& element)
     {
@@ -598,6 +608,7 @@ private:
     {
         return toJson(bv.Elements);
     }
+    */
 
     template <typename T, typename U> cJSON* toJson(const std::pair<T, U>& pair)
     {
@@ -652,7 +663,7 @@ template <typename T, typename = void> struct KindBaseHelper
         using type = B;                                                        \
         static inline s64_t getKind(T* p)                                      \
         {                                                                      \
-            return p->KindGetter();                                            \
+            return {p->KindGetter()};                                          \
         }                                                                      \
     }
 KIND_BASE(SVFType, getKind);
@@ -797,6 +808,14 @@ public:
     {
         return ptrPool.size();
     }
+
+    template <typename Set> void saveToSet(Set& set) const
+    {
+        for (T* obj : ptrPool)
+        {
+            set.insert(obj);
+        }
+    }
 };
 
 template <typename NodeTy, typename EdgeTy> class GenericGraphReader
@@ -949,6 +968,9 @@ public:
 
 class SVFModuleReader
 {
+    friend class SVFIRReader;
+
+private:
     const cJSON* svfModuleFieldJson = nullptr;
     ReaderPtrPool<SVFType> svfTypePool;
     ReaderPtrPool<StInfo> stInfoPool;
@@ -1063,11 +1085,12 @@ private:
     SVFIR* read(const cJSON* root);
     const cJSON* createObjs(const cJSON* root);
 
-    void readJson(SymbolTableInfo*& symTabInfo);
-    void readJson(IRGraph*& graph); // IRGraph Graph
-    void readJson(ICFG*& icfg);     // ICFG Graph
-    void readJson(CHGraph*& graph); // CHGraph Graph
-    void readJson(SVFModule*& module);
+    void readJson(const cJSON* obj, NodeIDAllocator* idAllocator);
+    void readJson(SymbolTableInfo* symTabInfo);
+    void readJson(IRGraph* graph); // IRGraph Graph
+    void readJson(ICFG* icfg);     // ICFG Graph
+    void readJson(CHGraph* graph); // CHGraph Graph
+    void readJson(SVFModule* module);
 
     void readJson(const cJSON* obj, SVFType*& type);
     void readJson(const cJSON* obj, StInfo*& stInfo);
@@ -1077,7 +1100,6 @@ private:
     void readJson(const cJSON* obj, SVFStmt*& stmt);  // IRGraph Edge
     void readJson(const cJSON* obj, ICFGNode*& node); // ICFG Node
     void readJson(const cJSON* obj, ICFGEdge*& edge); // ICFG Edge
-    // void readJson(const cJSON* obj, CHGraph*& graph); // CHGraph Graph
     void readJson(const cJSON* obj, CHNode*& node); // CHGraph Node
     void readJson(const cJSON* obj, CHEdge*& edge); // CHGraph Edge
     void readJson(const cJSON* obj, CallSite& cs); // CHGraph's csToClassMap
@@ -1093,15 +1115,24 @@ private:
     template <unsigned ElementSize>
     inline void readJson(const cJSON* obj, SparseBitVector<ElementSize>& bv)
     {
-        readJson(obj, bv.Elements);
+        ABORT_IFNOT(jsonIsArray(obj), "SparseBitVector should be an array");
+        jsonForEach(nObj, obj)
+        {
+            unsigned n;
+            readJson(nObj, n);
+            bv.set(n);
+        }
     }
 
+    /* See comment of toJson(SparseBitVectorElement) for reason of commenting
+       it out.
     template <unsigned ElementSize>
     inline void readJson(const cJSON* obj,
                          SparseBitVectorElement<ElementSize>& element)
     {
         readJson(obj, element.Bits);
     }
+    */
 
     /// @brief Read a pointer of some child class of
     /// SVFType/SVFValue/SVFVar/SVFStmt/ICFGNode/ICFGEdge/CHNode/CHEdge
@@ -1299,4 +1330,4 @@ private:
 
 } // namespace SVF
 
-#endif // !INCLUDE_SVFIRRW_H_
+#endif // !INCLUDE_SVFFILESYSTEM_H_

package/svf/include/SVFIR/SVFModule.h

@@ -40,8 +40,6 @@ namespace SVF
 
 class SVFModule
 {
-    friend class SVFModuleWrite;
-    friend class SVFModuleRead;
     friend class SVFIRWriter;
     friend class SVFIRReader;
 
@@ -79,8 +77,6 @@ public:
 
     ~SVFModule();
 
-    void writeToJson(const std::string& filePath);
-
     static inline void setPagFromTXT(const std::string& txt)
     {
         pagReadFromTxt = txt;

package/svf/include/SVFIR/SVFType.h

@@ -130,8 +130,6 @@ typedef Set<VersionedVar> VersionedVarSet;
  */
 class StInfo
 {
-    friend class SVFModuleWrite;
-    friend class SVFModuleRead;
     friend class SVFIRWriter;
     friend class SVFIRReader;
 
@@ -242,8 +240,6 @@ public:
 
 class SVFType
 {
-    friend class SVFModuleWrite;
-    friend class SVFModuleRead;
     friend class SVFIRWriter;
     friend class SVFIRReader;
 
@@ -329,8 +325,6 @@ public:
 
 class SVFPointerType : public SVFType
 {
-    friend class SVFModuleWrite;
-    friend class SVFModuleRead;
     friend class SVFIRWriter;
     friend class SVFIRReader;
 
@@ -364,8 +358,6 @@ public:
 
 class SVFFunctionType : public SVFType
 {
-    friend class SVFModuleWrite;
-    friend class SVFModuleRead;
     friend class SVFIRWriter;
     friend class SVFIRReader;
 

package/svf/include/SVFIR/SVFValue.h

@@ -49,8 +49,6 @@ class SVFType;
 
 class SVFLoopAndDomInfo
 {
-    friend class SVFModuleWrite;
-    friend class SVFModuleRead;
     friend class SVFIRWriter;
     friend class SVFIRReader;
 public:
@@ -151,8 +149,6 @@ public:
 
 class SVFValue
 {
-    friend class SVFModuleWrite;
-    friend class SVFModuleRead;
     friend class SVFIRWriter;
     friend class SVFIRReader;
     friend class LLVMModuleSet;
@@ -268,8 +264,6 @@ public:
 class SVFFunction : public SVFValue
 {
     friend class LLVMModuleSet;
-    friend class SVFModuleWrite;
-    friend class SVFModuleRead;
     friend class SVFIRWriter;
     friend class SVFIRReader;
 
@@ -486,8 +480,6 @@ public:
 class SVFBasicBlock : public SVFValue
 {
     friend class LLVMModuleSet;
-    friend class SVFModuleWrite;
-    friend class SVFModuleRead;
     friend class SVFIRWriter;
     friend class SVFIRReader;
 
@@ -588,8 +580,6 @@ public:
 
 class SVFInstruction : public SVFValue
 {
-    friend class SVFModuleWrite;
-    friend class SVFModuleRead;
     friend class SVFIRWriter;
     friend class SVFIRReader;
 public:
@@ -657,8 +647,6 @@ public:
 
 class SVFCallInst : public SVFInstruction
 {
-    friend class SVFModuleWrite;
-    friend class SVFModuleRead;
     friend class SVFIRWriter;
     friend class SVFIRReader;
     friend class LLVMModuleSet;
@@ -733,8 +721,6 @@ public:
 
 class SVFVirtualCallInst : public SVFCallInst
 {
-    friend class SVFModuleWrite;
-    friend class SVFModuleRead;
     friend class SVFIRWriter;
     friend class SVFIRReader;
     friend class LLVMModuleSet;
@@ -793,8 +779,6 @@ public:
 
 class SVFConstant : public SVFValue
 {
-    friend class SVFModuleWrite;
-    friend class SVFModuleRead;
     friend class SVFIRWriter;
     friend class SVFIRReader;
 public:
@@ -817,8 +801,6 @@ public:
 
 class SVFGlobalValue : public SVFConstant
 {
-    friend class SVFModuleWrite;
-    friend class SVFModuleRead;
     friend class SVFIRWriter;
     friend class SVFIRReader;
     friend class LLVMModuleSet;
@@ -857,8 +839,6 @@ public:
 
 class SVFArgument : public SVFValue
 {
-    friend class SVFModuleWrite;
-    friend class SVFModuleRead;
     friend class SVFIRWriter;
     friend class SVFIRReader;
 private:
@@ -898,8 +878,6 @@ public:
 
 class SVFConstantData : public SVFConstant
 {
-    friend class SVFModuleWrite;
-    friend class SVFModuleRead;
     friend class SVFIRWriter;
     friend class SVFIRReader;
 public:
@@ -929,8 +907,6 @@ public:
 
 class SVFConstantInt : public SVFConstantData
 {
-    friend class SVFModuleWrite;
-    friend class SVFModuleRead;
     friend class SVFIRWriter;
     friend class SVFIRReader;
 private:
@@ -965,8 +941,6 @@ public:
 
 class SVFConstantFP : public SVFConstantData
 {
-    friend class SVFModuleWrite;
-    friend class SVFModuleRead;
     friend class SVFIRWriter;
     friend class SVFIRReader;
 private:
@@ -994,8 +968,6 @@ public:
 
 class SVFConstantNullPtr : public SVFConstantData
 {
-    friend class SVFModuleWrite;
-    friend class SVFModuleRead;
     friend class SVFIRWriter;
     friend class SVFIRReader;
 
@@ -1017,8 +989,6 @@ public:
 
 class SVFBlackHoleValue : public SVFConstantData
 {
-    friend class SVFModuleWrite;
-    friend class SVFModuleRead;
     friend class SVFIRWriter;
     friend class SVFIRReader;
 
@@ -1040,8 +1010,6 @@ public:
 
 class SVFOtherValue : public SVFValue
 {
-    friend class SVFModuleWrite;
-    friend class SVFModuleRead;
     friend class SVFIRWriter;
     friend class SVFIRReader;
 public:
@@ -1061,8 +1029,6 @@ public:
 */
 class SVFMetadataAsValue : public SVFOtherValue
 {
-    friend class SVFModuleWrite;
-    friend class SVFModuleRead;
     friend class SVFIRWriter;
     friend class SVFIRReader;
 public:

package/svf/include/Util/NodeIDAllocator.h

@@ -19,6 +19,9 @@ class BVDataPTAImpl;
 /// all symbols have been allocated through endSymbolAllocation.
 class NodeIDAllocator
 {
+    friend class SVFIRWriter;
+    friend class SVFIRReader;
+
 public:
     /// Allocation strategy to use.
     enum Strategy

package/svf/lib/SVFIR/{SVFIRRW.cpp → SVFFileSystem.cpp}

@@ -1,4 +1,4 @@
-#include "SVFIR/SVFIRRW.h"
+#include "SVFIR/SVFFileSystem.h"
 #include "Graphs/CHG.h"
 #include "SVFIR/SVFIR.h"
 #include "Util/CommandLine.h"
@@ -1022,6 +1022,8 @@ SVFIRWriter::autoCStr SVFIRWriter::generateJsonString()
 SVFIRWriter::autoJSON SVFIRWriter::generateJson()
 {
     const IRGraph* const irGraph = svfIR;
+    NodeIDAllocator* nodeIDAllocator = NodeIDAllocator::allocator;
+    assert(nodeIDAllocator && "NodeIDAllocator is not initialized?");
 
     cJSON* root = jsonCreateObject();
 #define F(field) JSON_WRITE_FIELD(root, svfIR, field)
@@ -1033,6 +1035,7 @@ SVFIRWriter::autoJSON SVFIRWriter::generateJson()
     F(icfgNode2SVFStmtsMap);
     F(icfgNode2PTASVFStmtsMap);
     F(GepValObjMap);
+    F(typeLocSetsMap);
     F(GepObjVarMap);
     F(memToFieldsMap);
     F(globSVFStmtSet);
@@ -1045,6 +1048,7 @@ SVFIRWriter::autoJSON SVFIRWriter::generateJson()
     F(funPtrToCallSitesMap);
     F(candidatePointers);
     F(callSiteSet);
+    jsonAddJsonableToObject(root, FIELD_NAME_ITEM(nodeIDAllocator));
 #undef F
 
     return {root, cJSON_Delete};
@@ -1237,6 +1241,19 @@ cJSON* SVFIRWriter::toJson(const LocationSet& ls)
     return root;
 }
 
+cJSON* SVFIRWriter::toJson(const NodeIDAllocator* nodeIDAllocator)
+{
+    ENSURE_NOT_VISITED(nodeIDAllocator);
+
+    cJSON* root = jsonCreateObject();
+    JSON_WRITE_FIELD(root, nodeIDAllocator, strategy);
+    JSON_WRITE_FIELD(root, nodeIDAllocator, numObjects);
+    JSON_WRITE_FIELD(root, nodeIDAllocator, numValues);
+    JSON_WRITE_FIELD(root, nodeIDAllocator, numSymbols);
+    JSON_WRITE_FIELD(root, nodeIDAllocator, numNodes);
+    return root;
+}
+
 cJSON* SVFIRWriter::toJson(const SymbolTableInfo* symTable)
 {
     ENSURE_NOT_VISITED(symTable);
@@ -1323,14 +1340,15 @@ SVFIR* SVFIRReader::read(const cJSON* root)
     auto svfModule = new SVFModule();
     auto icfg = new ICFG();
     auto chgraph = new CHGraph(svfModule);
-    auto symboTableInfo = SymbolTableInfo::SymbolInfo();
+    auto symInfo = SymbolTableInfo::SymbolInfo();
+    symInfo->mod = svfModule;
 
     svfIR->svfModule = svfModule;
     svfIR->icfg = icfg;
     svfIR->chgraph = chgraph;
 
 #define F(field) JSON_READ_FIELD_FWD(svfirField, svfIR, field)
-    readJson(symboTableInfo);
+    readJson(symInfo);
     readJson(irGraph);
     readJson(icfg);
     readJson(chgraph);
@@ -1339,6 +1357,7 @@ SVFIR* SVFIRReader::read(const cJSON* root)
     F(icfgNode2SVFStmtsMap);
     F(icfgNode2PTASVFStmtsMap);
     F(GepValObjMap);
+    F(typeLocSetsMap);
     F(GepObjVarMap);
     F(memToFieldsMap);
     F(globSVFStmtSet);
@@ -1352,6 +1371,9 @@ SVFIR* SVFIRReader::read(const cJSON* root)
     F(candidatePointers);
     F(callSiteSet);
 #undef F
+    assert(!NodeIDAllocator::allocator && "NodeIDAllocator should be NULL");
+    auto nodeIDAllocator = NodeIDAllocator::get();
+    JSON_READ_OBJ_FWD(svfirField, nodeIDAllocator);
 
     return svfIR;
 }
@@ -1636,7 +1658,26 @@ SVFStmt* SVFIRReader::createPAGEdge(GEdgeKind kind)
     }
 }
 
-void SVFIRReader::readJson(SymbolTableInfo*& symTabInfo)
+void SVFIRReader::readJson(const cJSON* obj, NodeIDAllocator* idAllocator)
+{
+    assert(idAllocator && "idAllocator should be nonempty");
+
+    ABORT_IFNOT(jsonIsObject(obj), "Expect object for " << JSON_KEY(obj));
+    obj = obj->child;
+
+    JSON_DEF_READ_FWD(obj, int, strategy);
+    static_assert(sizeof(idAllocator->strategy) == sizeof(strategy),
+                  "idAllocator->strategy should be represented by int");
+    idAllocator->strategy = static_cast<NodeIDAllocator::Strategy>(strategy);
+    JSON_READ_FIELD_FWD(obj, idAllocator, numObjects);
+    JSON_READ_FIELD_FWD(obj, idAllocator, numValues);
+    JSON_READ_FIELD_FWD(obj, idAllocator, numSymbols);
+    JSON_READ_FIELD_FWD(obj, idAllocator, numNodes);
+
+    ABORT_IFNOT(!obj, "Extra field " << JSON_KEY(obj) << " in NodeIDAllocator");
+}
+
+void SVFIRReader::readJson(SymbolTableInfo* symTabInfo)
 {
     const cJSON* obj = symTableReader.getFieldJson();
 #define F(field) JSON_READ_FIELD_FWD(obj, symTabInfo, field)
@@ -1654,7 +1695,7 @@ void SVFIRReader::readJson(SymbolTableInfo*& symTabInfo)
     ABORT_IFNOT(!obj, "Extra field " << JSON_KEY(obj) << " in SymbolTableInfo");
 }
 
-void SVFIRReader::readJson(IRGraph*& graph)
+void SVFIRReader::readJson(IRGraph* graph)
 {
     assert(SymbolTableInfo::symInfo && "SymbolTableInfo should be nonempty");
     assert(graph->symInfo == SymbolTableInfo::SymbolInfo() && "symInfo differ");
@@ -1679,7 +1720,7 @@ void SVFIRReader::readJson(IRGraph*& graph)
     ABORT_IFNOT(nullit->second.empty(), "valueToEdgeMap[NULL] should be empty");
 }
 
-void SVFIRReader::readJson(ICFG*& icfg)
+void SVFIRReader::readJson(ICFG* icfg)
 {
     icfgReader.saveToGenericGraph(icfg);
     const cJSON* obj = icfgReader.getFieldJson();
@@ -1695,7 +1736,7 @@ void SVFIRReader::readJson(ICFG*& icfg)
 #undef F
 }
 
-void SVFIRReader::readJson(CHGraph*& graph)
+void SVFIRReader::readJson(CHGraph* graph)
 {
     chGraphReader.saveToGenericGraph(graph);
     const cJSON* obj = chGraphReader.getFieldJson();
@@ -1714,9 +1755,14 @@ void SVFIRReader::readJson(CHGraph*& graph)
 #undef F
 }
 
-void SVFIRReader::readJson(SVFModule*& module)
+void SVFIRReader::readJson(SVFModule* module)
 {
     const cJSON* obj = svfModuleReader.getFieldJson();
+    auto symInfo = SymbolTableInfo::symInfo;
+    assert(symInfo && "SymbolTableInfo should be non-NULL");
+    svfModuleReader.svfTypePool.saveToSet(symInfo->svfTypes);
+    svfModuleReader.stInfoPool.saveToSet(symInfo->stInfos);
+
 #define F(field) JSON_READ_FIELD_FWD(obj, module, field)
     F(pagReadFromTxt);
     F(moduleIdentifier);

package/svf/lib/SVFIR/SVFModule.cpp

@@ -22,7 +22,6 @@
 
 
 #include "SVFIR/SVFModule.h"
-#include "SVFIR/SVFModuleRW.h"
 #include "SVFIR/SymbolTableInfo.h"
 #include "Util/SVFUtil.h"
 #include "Util/SVFStat.h"
@@ -54,9 +53,3 @@ const SVFFunction* SVFModule::getSVFFunction(const std::string& name)
     }
     return nullptr;
 }
-
-void SVFModule::writeToJson(const std::string& filePath)
-{
-    if (!filePath.empty())
-        SVFModuleWrite(this, filePath);
-}

package/svf-llvm/lib/LLVMModule.cpp

@@ -31,7 +31,6 @@
 #include <algorithm>
 #include "Util/Options.h"
 #include "SVFIR/SVFModule.h"
-#include "SVFIR/SVFModuleRW.h"
 #include "Util/SVFUtil.h"
 #include "SVF-LLVM/BasicTypes.h"
 #include "SVF-LLVM/LLVMUtil.h"

package/svf-llvm/lib/SVFIRBuilder.cpp

@@ -38,7 +38,7 @@
 #include "SVF-LLVM/LLVMLoopAnalysis.h"
 #include "Util/Options.h"
 #include "SVF-LLVM/CHGBuilder.h"
-#include "SVFIR/SVFIRRW.h"
+#include "SVFIR/SVFFileSystem.h"
 #include "SVF-LLVM/SymbolTableBuilder.h"
 
 

package/svf-llvm/tools/LLVM2SVF/llvm2svf.cpp

@@ -30,7 +30,7 @@
 #include "SVF-LLVM/SVFIRBuilder.h"
 #include "Util/CommandLine.h"
 #include "Util/Options.h"
-#include "SVFIR/SVFIRRW.h"
+#include "SVFIR/SVFFileSystem.h"
 
 
 using namespace std;

package/svf-llvm/tools/WPA/wpa.cpp

@@ -31,7 +31,7 @@
 #include "WPA/WPAPass.h"
 #include "Util/CommandLine.h"
 #include "Util/Options.h"
-#include "SVFIR/SVFIRRW.h"
+#include "SVFIR/SVFFileSystem.h"
 
 
 using namespace llvm;