svf-tools 1.0.665 → 1.0.667

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svf-tools",
-  "version": "1.0.665",
+  "version": "1.0.667",
   "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/SVFModule.h

@@ -40,6 +40,8 @@ namespace SVF
 
 class SVFModule
 {
+    friend class SVFModuleWrite;
+    friend class SVFModuleRead;
 public:
     typedef std::vector<const SVFFunction*> FunctionSetType;
     typedef std::vector<SVFGlobalValue*> GlobalSetType;
@@ -76,7 +78,9 @@ public:
 
     ~SVFModule();
 
-    static inline void setPagFromTXT(std::string txt)
+    void writeToJson(const std::string& filePath);
+
+    static inline void setPagFromTXT(const std::string& txt)
     {
         pagReadFromTxt = txt;
     }
@@ -88,13 +92,10 @@ public:
 
     static inline bool pagReadFromTXT()
     {
-        if(pagReadFromTxt.empty())
-            return false;
-        else
-            return true;
+        return !pagReadFromTxt.empty();
     }
 
-    const SVFFunction* getSVFFunction(const std::string name);
+    const SVFFunction* getSVFFunction(const std::string& name);
 
     ///@{
     inline void addFunctionSet(SVFFunction* svfFunc)
@@ -197,7 +198,8 @@ public:
     {
         if (pagReadFromTxt.empty())
         {
-            assert(moduleIdentifier.empty()==false && "No module found! Are you reading from a file other than LLVM-IR?");
+            assert(!moduleIdentifier.empty() &&
+                   "No module found! Reading from a file other than LLVM-IR?");
             return moduleIdentifier;
         }
         else

package/svf/include/SVFIR/SVFModuleRW.h

@@ -0,0 +1,178 @@
+/*
+ * SVFModuleRW.h
+ *
+ *  Created on: 27 Jan 2023
+ *      Author: Xudong Wang
+ */
+
+#ifndef INCLUDE_SVFMODULE_JSON_DUMPER_H_
+#define INCLUDE_SVFMODULE_JSON_DUMPER_H_
+
+#include <string>
+#include <vector>
+#include <unordered_map>
+#include <ostream>
+#include <memory>
+
+struct cJSON;
+
+namespace SVF
+{
+class SVFModule;
+
+class StInfo;
+class SVFType;
+class SVFPointerType;
+class SVFIntegerType;
+class SVFFunctionType;
+class SVFStructType;
+class SVFArrayType;
+class SVFOtherType;
+
+class SVFLoopAndDomInfo;
+class SVFValue;
+class SVFFunction;
+class SVFBasicBlock;
+class SVFInstruction;
+class SVFCallInst;
+class SVFVirtualCallInst;
+class SVFConstant;
+class SVFGlobalValue;
+class SVFArgument;
+class SVFConstantData;
+class SVFConstantInt;
+class SVFConstantFP;
+class SVFConstantNullPtr;
+class SVFBlackHoleValue;
+class SVFOtherValue;
+class SVFMetadataAsValue;
+
+using TypeIndex = std::size_t;
+using ValueIndex = std::size_t;
+
+class SVFModuleWrite
+{
+private:
+    const SVFModule* module; ///< Borrowed pointer to the SVFModule.
+    const char* jsonStr; ///< Json string of the SVFModule. It gets freed by
+    /// `cJSON_free()` in destructor.
+
+    std::unordered_map<const SVFType*, TypeIndex> typeToIndex;
+    std::vector<const SVFType*>
+    typePool; ///< A pool of all SVFTypes in the SVFModule
+    TypeIndex getTypeIndex(const SVFType* type);
+    const char* getStrTypeIndex(const SVFType* type);
+
+    std::unordered_map<const SVFValue*, ValueIndex> valueToIndex;
+    std::vector<const SVFValue*>
+    valuePool; ///< A pool of all SVFValues in the SVFModule
+    ValueIndex getValueIndex(const SVFValue* value);
+    const char* getStrValueIndex(const SVFValue* value);
+
+    std::vector<std::unique_ptr<std::string>> allIndices;
+    const char* getStrOfIndex(std::size_t index);
+
+public:
+    SVFModuleWrite(const SVFModule* module);
+    /// @brief  Dump the SVFModule to a file in JSON format at the given path.
+    SVFModuleWrite(const SVFModule* module, const std::string& path);
+    void dumpJsonToPath(const std::string& path);
+    void dumpJsonToOstream(std::ostream& os);
+    ~SVFModuleWrite();
+
+private:
+    cJSON* moduleToJson(const SVFModule* module);
+
+    cJSON* typeToJson(const SVFType* type);
+    cJSON* toJson(const StInfo* stInfo);
+    // SVFType and all its descendants/subclasses.
+    cJSON* toJson(const SVFType* type);
+    cJSON* toJson(const SVFPointerType* type);
+    cJSON* toJson(const SVFIntegerType* type);
+    cJSON* toJson(const SVFFunctionType* type);
+    cJSON* toJson(const SVFStructType* type);
+    cJSON* toJson(const SVFArrayType* type);
+    cJSON* toJson(const SVFOtherType* type);
+
+    cJSON* valueToJson(const SVFValue* value);
+    cJSON* toJson(const SVFLoopAndDomInfo* ldInfo);
+    // SVFValue and all its descendants/subclasses.
+    cJSON* toJson(const SVFValue* value);
+    cJSON* toJson(const SVFFunction* value);
+    cJSON* toJson(const SVFBasicBlock* value);
+    cJSON* toJson(const SVFInstruction* value);
+    cJSON* toJson(const SVFCallInst* value);
+    cJSON* toJson(const SVFVirtualCallInst* value);
+    cJSON* toJson(const SVFConstant* value);
+    cJSON* toJson(const SVFGlobalValue* value);
+    cJSON* toJson(const SVFArgument* value);
+    cJSON* toJson(const SVFConstantData* value);
+    cJSON* toJson(const SVFConstantInt* value);
+    cJSON* toJson(const SVFConstantFP* value);
+    cJSON* toJson(const SVFConstantNullPtr* value);
+    cJSON* toJson(const SVFBlackHoleValue* value);
+    cJSON* toJson(const SVFOtherValue* value);
+    cJSON* toJson(const SVFMetadataAsValue* value);
+};
+
+class SVFModuleRead
+{
+private:
+    cJSON* moduleJson; ///< Owned pointer to the root object of the SVFModule. Be
+    ///< sure to delete it with `cJSON_Delete()` it in
+    ///< destructor.
+
+    SVFModule* svfModule;
+
+    std::vector<SVFType*> typePool; ///< A pool of all SVFTypes in the SVFModule
+    std::vector<cJSON*> typeArray;
+
+    std::vector<SVFValue*>
+    valuePool; ///< A pool of all SVFValues in the SVFModule
+    std::vector<cJSON*> valueArray;
+
+public:
+    SVFModule* get();
+    SVFModuleRead(const std::string& path);
+    ~SVFModuleRead();
+
+private:
+    SVFModule* readSvfModule(cJSON* iter);
+
+    SVFType* indexToType(TypeIndex i);
+    SVFValue* indexToValue(ValueIndex i);
+
+    void fillSvfTypeAt(size_t i);
+    void fillSvfValueAt(size_t i);
+
+    StInfo* readStInfo(cJSON* iter);
+    cJSON* readJson(cJSON* iter, SVFType* type);
+    cJSON* readJson(cJSON* iter, SVFPointerType* type);
+    cJSON* readJson(cJSON* iter, SVFIntegerType* type);
+    cJSON* readJson(cJSON* iter, SVFFunctionType* type);
+    cJSON* readJson(cJSON* iter, SVFStructType* type);
+    cJSON* readJson(cJSON* iter, SVFArrayType* type);
+    cJSON* readJson(cJSON* iter, SVFOtherType* type);
+
+    SVFLoopAndDomInfo* readSvfLoopAndDomInfo(cJSON* iter);
+    cJSON* readJson(cJSON* iter, SVFValue* value);
+    cJSON* readJson(cJSON* iter, SVFFunction* value);
+    cJSON* readJson(cJSON* iter, SVFBasicBlock* value);
+    cJSON* readJson(cJSON* iter, SVFInstruction* value);
+    cJSON* readJson(cJSON* iter, SVFCallInst* value);
+    cJSON* readJson(cJSON* iter, SVFVirtualCallInst* value);
+    cJSON* readJson(cJSON* iter, SVFConstant* value);
+    cJSON* readJson(cJSON* iter, SVFGlobalValue* value);
+    cJSON* readJson(cJSON* iter, SVFArgument* value);
+    cJSON* readJson(cJSON* iter, SVFConstantData* value);
+    cJSON* readJson(cJSON* iter, SVFConstantInt* value);
+    cJSON* readJson(cJSON* iter, SVFConstantFP* value);
+    cJSON* readJson(cJSON* iter, SVFConstantNullPtr* value);
+    cJSON* readJson(cJSON* iter, SVFBlackHoleValue* value);
+    cJSON* readJson(cJSON* iter, SVFOtherValue* value);
+    cJSON* readJson(cJSON* iter, SVFMetadataAsValue* value);
+};
+
+} // namespace SVF
+
+#endif // !INCLUDE_SVFMODULE_JSON_DUMPER_H_

package/svf/include/SVFIR/SVFType.h

@@ -44,6 +44,8 @@
 
 namespace SVF
 {
+class SVFType;
+class SVFPointerType;
 
 typedef std::ostream OutStream;
 typedef unsigned u32_t;
@@ -123,14 +125,15 @@ template <typename Key, typename Value, typename Hash = Hash<Key>,
                     typedef std::pair<NodeID, Version> VersionedVar;
                     typedef Set<VersionedVar> VersionedVarSet;
 
-                    class SVFType;
-                    class SVFPointerType;
-
                     /*!
-                     * Flatterned type information of StructType, ArrayType and SingleValueType
+                     * Flatterned type information of StructType, ArrayType and
+                     * SingleValueType
                      */
                     class StInfo
 {
+    friend class SVFModuleWrite;
+    friend class SVFModuleRead;
+
 private:
     /// flattened field indices of a struct (ignoring arrays)
     std::vector<u32_t> fldIdxVec;
@@ -235,6 +238,8 @@ public:
 
 class SVFType
 {
+    friend class SVFModuleWrite;
+    friend class SVFModuleRead;
 
 public:
     typedef s64_t GNodeK;
@@ -254,7 +259,7 @@ private:
     GNodeK kind; ///< used for classof
     const SVFPointerType*
     getPointerToTy; /// Return a pointer to the current type
-    StInfo* typeinfo;   /// < SVF's TypeInfo
+    StInfo* typeinfo;   ///< SVF's TypeInfo
     bool isSingleValTy; ///< The type represents a single value, not struct or
     ///< array
 protected:
@@ -318,6 +323,8 @@ public:
 
 class SVFPointerType : public SVFType
 {
+    friend class SVFModuleWrite;
+    friend class SVFModuleRead;
 
 private:
     const SVFType* ptrElementType;
@@ -349,6 +356,9 @@ public:
 
 class SVFFunctionType : public SVFType
 {
+    friend class SVFModuleWrite;
+    friend class SVFModuleRead;
+
 private:
     const SVFType* retTy;
 

package/svf/include/SVFIR/SVFValue.h

@@ -49,6 +49,8 @@ class SVFType;
 
 class SVFLoopAndDomInfo
 {
+    friend class SVFModuleWrite;
+    friend class SVFModuleRead;
 public:
     typedef Set<const SVFBasicBlock*> BBSet;
     typedef std::vector<const SVFBasicBlock*> BBList;
@@ -79,7 +81,7 @@ public:
 
     inline bool hasLoopInfo(const SVFBasicBlock* bb) const
     {
-        return bb2LoopMap.find(bb)!=bb2LoopMap.end();
+        return bb2LoopMap.find(bb) != bb2LoopMap.end();
     }
 
     const LoopBBs& getLoopInfo(const SVFBasicBlock* bb) const;
@@ -92,7 +94,7 @@ public:
 
     inline bool loopContainsBB(const LoopBBs& lp, const SVFBasicBlock* bb) const
     {
-        return std::find(lp.begin(), lp.end(), bb)!=lp.end();
+        return std::find(lp.begin(), lp.end(), bb) != lp.end();
     }
 
     inline void addToBB2LoopMap(const SVFBasicBlock* bb, const SVFBasicBlock* loopBB)
@@ -122,7 +124,8 @@ public:
 
     inline bool isUnreachable(const SVFBasicBlock* bb) const
     {
-        return std::find(reachableBBs.begin(), reachableBBs.end(), bb)==reachableBBs.end();
+        return std::find(reachableBBs.begin(), reachableBBs.end(), bb) ==
+               reachableBBs.end();
     }
 
     inline const BBList& getReachableBBs() const
@@ -146,6 +149,8 @@ public:
 
 class SVFValue
 {
+    friend class SVFModuleWrite;
+    friend class SVFModuleRead;
     friend class LLVMModuleSet;
 
 public:
@@ -257,6 +262,8 @@ public:
 class SVFFunction : public SVFValue
 {
     friend class LLVMModuleSet;
+    friend class SVFModuleWrite;
+    friend class SVFModuleRead;
 
 public:
     typedef std::vector<const SVFBasicBlock*>::const_iterator const_iterator;
@@ -471,6 +478,8 @@ public:
 class SVFBasicBlock : public SVFValue
 {
     friend class LLVMModuleSet;
+    friend class SVFModuleWrite;
+    friend class SVFModuleRead;
 
 public:
     typedef std::vector<const SVFInstruction*>::const_iterator const_iterator;
@@ -569,6 +578,8 @@ public:
 
 class SVFInstruction : public SVFValue
 {
+    friend class SVFModuleWrite;
+    friend class SVFModuleRead;
 public:
     typedef std::vector<const SVFInstruction*> InstVec;
 
@@ -634,6 +645,8 @@ public:
 
 class SVFCallInst : public SVFInstruction
 {
+    friend class SVFModuleWrite;
+    friend class SVFModuleRead;
     friend class LLVMModuleSet;
 
 private:
@@ -706,6 +719,8 @@ public:
 
 class SVFVirtualCallInst : public SVFCallInst
 {
+    friend class SVFModuleWrite;
+    friend class SVFModuleRead;
     friend class LLVMModuleSet;
 
 private:
@@ -762,6 +777,8 @@ public:
 
 class SVFConstant : public SVFValue
 {
+    friend class SVFModuleWrite;
+    friend class SVFModuleRead;
 public:
     SVFConstant(const std::string& _const, const SVFType* ty, SVFValKind k = SVFConst): SVFValue(_const, ty, k)
     {
@@ -782,6 +799,8 @@ public:
 
 class SVFGlobalValue : public SVFConstant
 {
+    friend class SVFModuleWrite;
+    friend class SVFModuleRead;
     friend class LLVMModuleSet;
 
 private:
@@ -818,6 +837,8 @@ public:
 
 class SVFArgument : public SVFValue
 {
+    friend class SVFModuleWrite;
+    friend class SVFModuleRead;
 private:
     const SVFFunction* fun;
     u32_t argNo;
@@ -855,6 +876,8 @@ public:
 
 class SVFConstantData : public SVFConstant
 {
+    friend class SVFModuleWrite;
+    friend class SVFModuleRead;
 public:
     SVFConstantData(const std::string& _const, const SVFType* ty, SVFValKind k = SVFConstData): SVFConstant(_const, ty, k)
     {
@@ -882,6 +905,8 @@ public:
 
 class SVFConstantInt : public SVFConstantData
 {
+    friend class SVFModuleWrite;
+    friend class SVFModuleRead;
 private:
     u64_t zval;
     s64_t sval;
@@ -914,6 +939,8 @@ public:
 
 class SVFConstantFP : public SVFConstantData
 {
+    friend class SVFModuleWrite;
+    friend class SVFModuleRead;
 private:
     float dval;
 public:
@@ -939,6 +966,8 @@ public:
 
 class SVFConstantNullPtr : public SVFConstantData
 {
+    friend class SVFModuleWrite;
+    friend class SVFModuleRead;
 
 public:
     SVFConstantNullPtr(const std::string& _const, const SVFType* ty): SVFConstantData(_const, ty, SVFValue::SVFNullPtr)
@@ -958,6 +987,8 @@ public:
 
 class SVFBlackHoleValue : public SVFConstantData
 {
+    friend class SVFModuleWrite;
+    friend class SVFModuleRead;
 
 public:
     SVFBlackHoleValue(const std::string& _const, const SVFType* ty): SVFConstantData(_const, ty, SVFValue::SVFBlackHole)
@@ -977,6 +1008,8 @@ public:
 
 class SVFOtherValue : public SVFValue
 {
+    friend class SVFModuleWrite;
+    friend class SVFModuleRead;
 public:
     SVFOtherValue(const std::string& other, const SVFType* ty, SVFValKind k = SVFValue::SVFOther): SVFValue(other, ty, k)
     {
@@ -994,6 +1027,8 @@ public:
 */
 class SVFMetadataAsValue : public SVFOtherValue
 {
+    friend class SVFModuleWrite;
+    friend class SVFModuleRead;
 public:
     SVFMetadataAsValue(const std::string& other, const SVFType* ty): SVFOtherValue(other, ty, SVFValue::SVFMetaAsValue)
     {

package/svf/lib/Graphs/CFBasicBlockG.cpp

@@ -93,6 +93,8 @@ const CFBasicBlockEdge* CFBasicBlockGraph::getOrAddCFBasicBlockEdge(CFBasicBlock
     CFBasicBlockEdge *edge = new CFBasicBlockEdge(src, dst);
     bool added1 = edge->getDstNode()->addIncomingEdge(edge);
     bool added2 = edge->getSrcNode()->addOutgoingEdge(edge);
+    (void) added1;
+    (void) added2;
     assert(added1 && added2 && "edge not added??");
     _totalCFBasicBlockEdge++;
     return edge;

package/svf/lib/SVFIR/SVFModule.cpp

@@ -22,9 +22,11 @@
 
 
 #include "SVFIR/SVFModule.h"
+#include "SVFIR/SVFModuleRW.h"
 #include "SVFIR/SymbolTableInfo.h"
 #include "Util/SVFUtil.h"
 #include "Util/SVFStat.h"
+#include "Util/Options.h"
 
 using namespace SVF;
 
@@ -41,7 +43,7 @@ SVFModule::~SVFModule()
     ExtAPI::destory();
 }
 
-const SVFFunction* SVFModule::getSVFFunction(std::string name)
+const SVFFunction* SVFModule::getSVFFunction(const std::string& name)
 {
     for (const SVFFunction* fun : getFunctionSet())
     {
@@ -51,4 +53,10 @@ const SVFFunction* SVFModule::getSVFFunction(std::string name)
         }
     }
     return nullptr;
-}
+}
+
+void SVFModule::writeToJson(const std::string& filePath)
+{
+    if (!filePath.empty())
+        SVFModuleWrite(this, filePath);
+}