svf-tools 1.0.1043 → 1.0.1044

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svf-tools",
-  "version": "1.0.1043",
+  "version": "1.0.1044",
   "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/DDA/DDAClient.h

@@ -48,11 +48,11 @@ namespace SVF
 class DDAClient
 {
 public:
-    DDAClient(SVFModule* mod) : pag(nullptr), module(mod), curPtr(0), solveAll(true) {}
+    DDAClient() : pag(nullptr), curPtr(0), solveAll(true) {}
 
     virtual ~DDAClient() {}
 
-    virtual inline void initialise(SVFModule*) {}
+    virtual inline void initialise() {}
 
     /// Collect candidate pointers for query.
     virtual inline OrderedNodeSet& collectCandidateQueries(SVFIR* p)
@@ -91,16 +91,12 @@ public:
         userInput.insert(ptr);
         solveAll = false;
     }
-    /// Get LLVM module
-    inline SVFModule* getModule() const
-    {
-        return module;
-    }
+
     virtual void answerQueries(PointerAnalysis* pta);
 
     virtual inline void performStat(PointerAnalysis*) {}
 
-    virtual inline void collectWPANum(SVFModule*) {}
+    virtual inline void collectWPANum() {}
 protected:
     void addCandidate(NodeID id)
     {
@@ -109,7 +105,6 @@ protected:
     }
 
     SVFIR*   pag;					///< SVFIR graph used by current DDA analysis
-    SVFModule* module;		///< LLVM module
     NodeID curPtr;				///< current pointer being queried
     OrderedNodeSet candidateQueries;	///< store all candidate pointers to be queried
 
@@ -128,7 +123,7 @@ private:
     typedef OrderedMap<NodeID,const CallICFGNode*> VTablePtrToCallSiteMap;
     VTablePtrToCallSiteMap vtableToCallSiteMap;
 public:
-    FunptrDDAClient(SVFModule* module) : DDAClient(module) {}
+    FunptrDDAClient() : DDAClient() {}
     ~FunptrDDAClient() {}
 
     /// Only collect function pointers as query candidates.
@@ -147,7 +142,7 @@ class AliasDDAClient : public DDAClient
 public:
     typedef OrderedSet<const PAGNode*> PAGNodeSet;
 
-    AliasDDAClient(SVFModule* module) : DDAClient(module) {}
+    AliasDDAClient() : DDAClient() {}
     ~AliasDDAClient() {}
 
     /// Only collect function pointers as query candidates.

package/svf/include/DDA/DDAPass.h

@@ -69,7 +69,7 @@ public:
     virtual void runOnModule(SVFIR* module);
 
     /// Select a client
-    virtual void selectClient(SVFModule* module);
+    virtual void selectClient();
 
     /// Pass name
     virtual inline std::string getPassName() const

package/svf/include/Graphs/CHG.h

@@ -33,7 +33,7 @@
 #ifndef CHA_H_
 #define CHA_H_
 
-#include "SVFIR/SVFModule.h"
+#include "Util/ThreadAPI.h"
 #include "Graphs/GenericGraph.h"
 #include "Util/WorkList.h"
 
@@ -252,7 +252,7 @@ public:
         DESTRUCTOR = 0x2 // connect node based on destructor
     } RELATIONTYPE;
 
-    CHGraph(SVFModule* svfModule): svfMod(svfModule), classNum(0), vfID(0), buildingCHGTime(0)
+    CHGraph(): classNum(0), vfID(0), buildingCHGTime(0)
     {
         this->kind = Standard;
     }
@@ -318,7 +318,6 @@ public:
 
 
 private:
-    SVFModule* svfMod;
     u32_t classNum;
     u32_t vfID;
     double buildingCHGTime;

package/svf/include/Graphs/GenericGraph.h

@@ -33,6 +33,7 @@
 #include "SVFIR/SVFType.h"
 #include "Util/iterator.h"
 #include "Graphs/GraphTraits.h"
+#include "SVFIR/SVFValue.h"
 
 namespace SVF
 {
@@ -134,292 +135,6 @@ protected:
 };
 
 
-class SVFBaseNode
-{
-
-public:
-
-    enum GNodeK
-    {
-        // ┌─────────────────────────────────────────────────────────────────────────┐
-        // │ ICFGNode: Classes of inter-procedural and intra-procedural control flow │
-        // │ graph nodes (Parent class: ICFGNode)                                   │
-        // └─────────────────────────────────────────────────────────────────────────┘
-        IntraBlock,       // ├── Represents a node within a single procedure
-        GlobalBlock,      // ├── Represents a global-level block
-        // │   └─ Subclass: InterICFGNode
-        FunEntryBlock,    // │   ├── Entry point of a function
-        FunExitBlock,     // │   ├── Exit point of a function
-        FunCallBlock,     // │   ├── Call site in the function
-        FunRetBlock,      // │   └── Return site in the function
-
-        // ┌─────────────────────────────────────────────────────────────────────────┐
-        // │ SVFVar: Classes of variable nodes (Parent class: SVFVar)               │
-        // │   Includes two main subclasses: ValVar and ObjVar                      │
-        // └─────────────────────────────────────────────────────────────────────────┘
-        // └─ Subclass: ValVar (Top-level variable nodes)
-        ValNode,                 // ├── Represents a standard value variable
-        ArgValNode,              // ├── Represents an argument value variable
-        FunValNode,              // ├── Represents a function value variable
-        GepValNode,              // ├── Represents a GEP value variable
-        RetValNode,              // ├── Represents a return value node
-        VarargValNode,           // ├── Represents a variadic argument node
-        GlobalValNode,           // ├── Represents a global variable node
-        ConstAggValNode,         // ├── Represents a constant aggregate value node
-        // │   └─ Subclass: ConstDataValVar
-        ConstDataValNode,        // │   ├── Represents a constant data variable
-        BlackHoleValNode,        // │   ├── Represents a black hole node
-        ConstFPValNode,          // │   ├── Represents a constant floating-point value node
-        ConstIntValNode,         // │   ├── Represents a constant integer value node
-        ConstNullptrValNode,     // │   └── Represents a constant nullptr value node
-        // │   └─ Subclass: DummyValVar
-        DummyValNode,            // │   └── Dummy node for uninitialized values
-
-        // └─ Subclass: ObjVar (Object variable nodes)
-        ObjNode,                 // ├── Represents an object variable
-        // │   └─ Subclass: GepObjVar
-        GepObjNode,              // │   ├── Represents a GEP object variable
-        // │   └─ Subclass: BaseObjVar
-        BaseObjNode,             // │   ├── Represents a base object node
-        FunObjNode,              // │   ├── Represents a function object
-        HeapObjNode,             // │   ├── Represents a heap object
-        StackObjNode,            // │   ├── Represents a stack object
-        GlobalObjNode,           // │   ├── Represents a global object
-        ConstAggObjNode,         // │   ├── Represents a constant aggregate object
-        // │   └─ Subclass: ConstDataObjVar
-        ConstDataObjNode,        // │   ├── Represents a constant data object
-        ConstFPObjNode,          // │   ├── Represents a constant floating-point object
-        ConstIntObjNode,         // │   ├── Represents a constant integer object
-        ConstNullptrObjNode,     // │   └── Represents a constant nullptr object
-        // │   └─ Subclass: DummyObjVar
-        DummyObjNode,            // │   └── Dummy node for uninitialized objects
-
-        // ┌─────────────────────────────────────────────────────────────────────────┐
-        // │ VFGNode: Classes of Value Flow Graph (VFG) node kinds (Parent class:   │
-        // │ VFGNode)                                                               │
-        // │   Includes operation nodes and specialized subclasses                  │
-        // └─────────────────────────────────────────────────────────────────────────┘
-        Cmp,              // ├── Represents a comparison operation
-        BinaryOp,         // ├── Represents a binary operation
-        UnaryOp,          // ├── Represents a unary operation
-        Branch,           // ├── Represents a branch operation
-        DummyVProp,       // ├── Dummy node for value propagation
-        NPtr,             // ├── Represents a null pointer operation
-        // │   └─ Subclass: ArgumentVFGNode
-        FRet,             // │   ├── Represents a function return value
-        ARet,             // │   ├── Represents an argument return value
-        AParm,            // │   ├── Represents an argument parameter
-        FParm,            // │   └── Represents a function parameter
-        // │   └─ Subclass: StmtVFGNode
-        Addr,             // │   ├── Represents an address operation
-        Copy,             // │   ├── Represents a copy operation
-        Gep,              // │   ├── Represents a GEP operation
-        Store,            // │   ├── Represents a store operation
-        Load,             // │   └── Represents a load operation
-        // │   └─ Subclass: PHIVFGNode
-        TPhi,             // │   ├── Represents a type-based PHI node
-        TIntraPhi,        // │   ├── Represents an intra-procedural PHI node
-        TInterPhi,        // │   └── Represents an inter-procedural PHI node
-        // │   └─ Subclass: MRSVFGNode
-        FPIN,             // │   ├── Function parameter input
-        FPOUT,            // │   ├── Function parameter output
-        APIN,             // │   ├── Argument parameter input
-        APOUT,            // │   └── Argument parameter output
-        // │       └─ Subclass: MSSAPHISVFGNode
-        MPhi,             // │       ├── Memory PHI node
-        MIntraPhi,        // │       ├── Intra-procedural memory PHI node
-        MInterPhi,        // │       └── Inter-procedural memory PHI node
-
-        // ┌─────────────────────────────────────────────────────────────────────────┐
-        // │ Additional specific graph node types                                   │
-        // └─────────────────────────────────────────────────────────────────────────┘
-        CallNodeKd,       // Callgraph node
-        CDNodeKd,         // Control dependence graph node
-        CFLNodeKd,        // CFL graph node
-        CHNodeKd,         // Class hierarchy graph node
-        ConstraintNodeKd, // Constraint graph node
-        TCTNodeKd,        // Thread creation tree node
-        DCHNodeKd,        // DCHG node
-        BasicBlockKd,     // Basic block node
-        OtherKd           // Other node kind
-    };
-
-
-    SVFBaseNode(NodeID i, GNodeK k, const SVFType* ty = nullptr): id(i),nodeKind(k), type(ty)
-    {
-
-    }
-
-    /// Get ID
-    inline NodeID getId() const
-    {
-        return id;
-    }
-
-    /// Get node kind
-    inline GNodeK getNodeKind() const
-    {
-        return nodeKind;
-    }
-
-    virtual const SVFType* getType() const
-    {
-        return type;
-    }
-
-    inline virtual void setName(const std::string& nameInfo)
-    {
-        name = nameInfo;
-    }
-
-    inline virtual void setName(std::string&& nameInfo)
-    {
-        name = std::move(nameInfo);
-    }
-
-    virtual const std::string& getName() const
-    {
-        return name;
-    }
-
-    inline virtual void setSourceLoc(const std::string& sourceCodeInfo)
-    {
-        sourceLoc = sourceCodeInfo;
-    }
-
-    virtual const std::string getSourceLoc() const
-    {
-        return sourceLoc;
-    }
-
-    const std::string valueOnlyToString() const;
-
-
-protected:
-    NodeID id;		///< Node ID
-    GNodeK nodeKind;	///< Node kind
-    const SVFType* type; ///< SVF type
-
-    std::string name;
-    std::string sourceLoc;  ///< Source code information of this value
-
-    /// Helper functions to check node kinds
-    //{@ Check node kind
-    static inline bool isICFGNodeKinds(GNodeK n)
-    {
-        static_assert(FunRetBlock - IntraBlock == 5,
-                      "the number of ICFGNodeKinds has changed, make sure "
-                      "the range is correct");
-        return n <= FunRetBlock && n >= IntraBlock;
-    }
-
-    static inline bool isInterICFGNodeKind(GNodeK n)
-    {
-        static_assert(FunRetBlock - FunEntryBlock == 3,
-                      "the number of InterICFGNodeKind has changed, make sure "
-                      "the range is correct");
-        return n <= FunRetBlock && n >= FunEntryBlock;
-    }
-
-    static inline bool isSVFVarKind(GNodeK n)
-    {
-        static_assert(DummyObjNode - ValNode == 26,
-                      "The number of SVFVarKinds has changed, make sure the "
-                      "range is correct");
-
-        return n <= DummyObjNode && n >= ValNode;
-    }
-
-    static inline bool isValVarKinds(GNodeK n)
-    {
-        static_assert(DummyValNode - ValNode == 13,
-                      "The number of ValVarKinds has changed, make sure the "
-                      "range is correct");
-        return n <= DummyValNode && n >= ValNode;
-    }
-
-
-    static inline bool isConstantDataValVar(GNodeK n)
-    {
-        static_assert(ConstNullptrValNode - ConstDataValNode == 4,
-                      "The number of ConstantDataValVarKinds has changed, make "
-                      "sure the range is correct");
-        return n <= ConstNullptrValNode && n >= ConstDataValNode;
-    }
-
-    static inline bool isObjVarKinds(GNodeK n)
-    {
-        static_assert(DummyObjNode - ObjNode == 12,
-                      "The number of ObjVarKinds has changed, make sure the "
-                      "range is correct");
-        return n <= DummyObjNode && n >= ObjNode;
-    }
-
-    static inline bool isBaseObjVarKinds(GNodeK n)
-    {
-        static_assert(DummyObjNode - BaseObjNode == 10,
-                      "The number of BaseObjVarKinds has changed, make sure the "
-                      "range is correct");
-        return n <= DummyObjNode && n >= BaseObjNode;
-    }
-
-    static inline bool isConstantDataObjVarKinds(GNodeK n)
-    {
-        static_assert(ConstNullptrObjNode - ConstDataObjNode == 3,
-                      "The number of ConstantDataObjVarKinds has changed, make "
-                      "sure the range is correct");
-        return n <= ConstNullptrObjNode && n >= ConstDataObjNode;
-    }
-
-    static inline bool isVFGNodeKinds(GNodeK n)
-    {
-        static_assert(MInterPhi - Cmp == 24,
-                      "The number of VFGNodeKinds has changed, make sure the "
-                      "range is correct");
-        return n <= MInterPhi && n >= Cmp;
-    }
-
-    static inline bool isArgumentVFGNodeKinds(GNodeK n)
-    {
-        static_assert(FParm - FRet == 3,
-                      "The number of ArgumentVFGNodeKinds has changed, make "
-                      "sure the range is correct");
-        return n <= FParm && n >= FRet;
-    }
-
-    static inline bool isStmtVFGNodeKinds(GNodeK n)
-    {
-        static_assert(Load - Addr == 4,
-                      "The number of StmtVFGNodeKinds has changed, make sure "
-                      "the range is correct");
-        return n <= Load && n >= Addr;
-    }
-
-    static inline bool isPHIVFGNodeKinds(GNodeK n)
-    {
-        static_assert(TInterPhi - TPhi == 2,
-                      "The number of PHIVFGNodeKinds has changed, make sure "
-                      "the range is correct");
-        return n <= TInterPhi && n >= TPhi;
-    }
-
-    static inline bool isMRSVFGNodeKinds(GNodeK n)
-    {
-        static_assert(MInterPhi - FPIN == 6,
-                      "The number of MRSVFGNodeKinds has changed, make sure "
-                      "the range is correct");
-        return n <= MInterPhi && n >= FPIN;
-    }
-
-    static inline bool isMSSAPHISVFGNodeKinds(GNodeK n)
-    {
-        static_assert(MInterPhi - MPhi == 2,
-                      "The number of MSSAPHISVFGNodeKinds has changed, make "
-                      "sure the range is correct");
-        return n <= MInterPhi && n >= MPhi;
-    }
-    //@}
-};
 
 /*!
  * Generic node on the graph as base class

package/svf/include/MTA/MTA.h

@@ -67,11 +67,11 @@ public:
     /// We start the pass here
     virtual bool runOnModule(SVFIR* module);
     /// Compute MHP
-    virtual MHP* computeMHP(SVFModule* module);
+    virtual MHP* computeMHP();
     /// Compute locksets
     virtual LockAnalysis* computeLocksets(TCT* tct);
     /// Perform detection
-    virtual void detect(SVFModule* module);
+    virtual void detect();
 
     // Not implemented for now
     // void dump(Module &module, MHP *mhp, LockAnalysis *lsa);

package/svf/include/MTA/TCT.h

@@ -186,12 +186,6 @@ public:
         destroy();
     }
 
-    /// Get SVFFModule
-    SVFModule* getSVFModule() const
-    {
-        return pta->getModule();
-    }
-
     /// Get TCG
     inline ThreadCallGraph* getThreadCallGraph() const
     {

package/svf/include/MemoryModel/PointerAnalysis.h

@@ -139,8 +139,6 @@ protected:
 
     /// SVFIR
     static SVFIR* pag;
-    /// Module
-    SVFModule* svfMod;
     /// Pointer analysis Type
     PTATY ptaTy;
     /// PTA implementation type.
@@ -206,11 +204,7 @@ public:
     {
         return stat;
     }
-    /// Module
-    inline SVFModule* getModule() const
-    {
-        return svfMod;
-    }
+
     /// Get all Valid Pointers for resolution
     inline OrderedNodeSet& getAllValidPtrs()
     {

package/svf/include/SABER/DoubleFreeChecker.h

@@ -57,7 +57,7 @@ public:
     virtual bool runOnModule(SVFIR* pag) override
     {
         /// start analysis
-        analyze(pag->getModule());
+        analyze();
         return false;
     }
 

package/svf/include/SABER/FileChecker.h

@@ -58,7 +58,7 @@ public:
     virtual bool runOnModule(SVFIR* pag)
     {
         /// start analysis
-        analyze(pag->getModule());
+        analyze();
         return false;
     }
 

package/svf/include/SABER/LeakChecker.h

@@ -68,7 +68,7 @@ public:
     virtual bool runOnModule(SVFIR* pag)
     {
         /// start analysis
-        analyze(pag->getModule());
+        analyze();
         return false;
     }
 

package/svf/include/SABER/SaberCondAllocator.h

@@ -30,7 +30,6 @@
 #ifndef PATHALLOCATOR_H_
 #define PATHALLOCATOR_H_
 
-#include "SVFIR/SVFModule.h"
 #include "SVFIR/SVFValue.h"
 #include "Util/WorkList.h"
 #include "Graphs/SVFG.h"
@@ -121,7 +120,7 @@ public:
     Condition newCond(const ICFGNode* inst);
 
     /// Perform path allocation
-    void allocate(const SVFModule* module);
+    void allocate();
 
     /// Get/Set instruction based on Z3 expression id
     //{@

package/svf/include/SABER/SrcSnkDDA.h

@@ -105,10 +105,10 @@ public:
     }
 
     /// Start analysis here
-    virtual void analyze(SVFModule* module);
+    virtual void analyze();
 
     /// Initialize analysis
-    virtual void initialize(SVFModule* module);
+    virtual void initialize();
 
     /// Finalize analysis
     virtual void finalize()

package/svf/include/SVFIR/ObjTypeInfo.h

@@ -33,7 +33,6 @@
 
 #include "Util/SVFUtil.h"
 #include "MemoryModel/AccessPath.h"
-#include "SVFIR/SVFModule.h"
 namespace SVF
 {
 

package/svf/include/SVFIR/SVFIR.h

@@ -93,13 +93,15 @@ private:
     /// Valid pointers for pointer analysis resolution connected by SVFIR edges (constraints)
     /// this set of candidate pointers can change during pointer resolution (e.g. adding new object nodes)
     OrderedNodeSet candidatePointers;
-    SVFModule* svfModule; /// SVF Module
     ICFG* icfg; // ICFG
     CommonCHGraph* chgraph; // class hierarchy graph
     CallSiteSet callSiteSet; /// all the callsites of a program
     CallGraph* callGraph; /// call graph
 
     static std::unique_ptr<SVFIR> pag;	///< Singleton pattern here to enable instance of SVFIR can only be created once.
+    static std::string pagReadFromTxt;
+
+    std::string moduleIdentifier;
 
     /// Constructor
     SVFIR(bool buildFromFile);
@@ -152,16 +154,7 @@ public:
     /// Whether to handle blackhole edge
     static void handleBlackHole(bool b);
     //@}
-    /// Set/Get LLVM Module
-    inline void setModule(SVFModule* mod)
-    {
-        svfModule = mod;
-    }
-    inline SVFModule* getModule()
-    {
-        assert(svfModule && "empty SVFModule! Build SVF IR first!");
-        return svfModule;
-    }
+
     /// Set/Get ICFG
     inline void setICFG(ICFG* i)
     {
@@ -196,6 +189,40 @@ public:
 
     const FunObjVar* getFunObjVar(const std::string& name);
 
+    inline const std::string& getModuleIdentifier() const
+    {
+        if (pagReadFromTxt.empty())
+        {
+            assert(!moduleIdentifier.empty() &&
+                   "No module found! Reading from a file other than LLVM-IR?");
+            return moduleIdentifier;
+        }
+        else
+        {
+            return pagReadFromTxt;
+        }
+    }
+
+    static inline std::string pagFileName()
+    {
+        return pagReadFromTxt;
+    }
+
+    static inline bool pagReadFromTXT()
+    {
+        return !pagReadFromTxt.empty();
+    }
+
+    static inline void setPagFromTXT(const std::string& txt)
+    {
+        pagReadFromTxt = txt;
+    }
+
+    inline void setModuleIdentifier(const std::string& moduleIdentifier)
+    {
+        this->moduleIdentifier = moduleIdentifier;
+    }
+
     /// Get/set methods to get SVFStmts based on their kinds and ICFGNodes
     //@{
     /// Get edges set according to its kind

package/svf/include/SVFIR/SVFStatements.h

@@ -43,6 +43,7 @@ class IntraICFGNode;
 class CallICFGNode;
 class FunEntryICFGNode;
 class FunExitICFGNode;
+class SVFBasicBlock;
 
 /*
  * SVFIR program statements (PAGEdges)