svf-tools 1.0.1034 → 1.0.1036

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svf-tools",
-  "version": "1.0.1034",
+  "version": "1.0.1036",
   "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/AE/Svfexe/AbsExtAPI.h

@@ -130,13 +130,6 @@ public:
      */
     AbstractState& getAbsStateFromTrace(const ICFGNode* node);
 
-    /**
-     * @brief Retrieves the SVF variable from a given SVF value.
-     * @param val Pointer to the SVF value.
-     * @return Pointer to the corresponding SVF variable.
-     */
-    const SVFVar* getSVFVar(const SVFValue* val);
-
 protected:
     SVFIR* svfir; ///< Pointer to the SVF intermediate representation.
     ICFG* icfg; ///< Pointer to the interprocedural control flow graph.

package/svf/include/CFL/CFLAlias.h

@@ -61,14 +61,6 @@ public:
     /// Solving CFL Reachability
     virtual void solve();
 
-    /// Interface exposed to users of our Alias analysis, given Value infos
-    virtual AliasResult alias(const SVFValue* v1, const SVFValue* v2)
-    {
-        NodeID n1 = svfir->getValueNode(v1);
-        NodeID n2 = svfir->getValueNode(v2);
-        return alias(n1,n2);
-    }
-
     /// Interface exposed to users of our Alias analysis, given PAGNodeID
     virtual AliasResult alias(NodeID node1, NodeID node2)
     {

package/svf/include/DDA/DDAPass.h

@@ -57,7 +57,10 @@ public:
     ~DDAPass();
 
     /// Interface expose to users of our pointer analysis, given Value infos
-    virtual AliasResult alias(const SVFValue* V1,	const SVFValue* V2);
+    virtual AliasResult alias(const SVFVar* V1,	const SVFVar* V2)
+    {
+        return alias(V1->getId(), V2->getId());
+    }
 
     /// Interface expose to users of our pointer analysis, given PAGNodes
     virtual AliasResult alias(NodeID V1, NodeID V2);

package/svf/include/Graphs/ConsG.h

@@ -76,11 +76,6 @@ protected:
 
     /// Wrappers used internally, not expose to Andersen Pass
     //@{
-    inline NodeID getValueNode(const SVFValue* value) const
-    {
-        return sccRepNode(pag->getValueNode(value));
-    }
-
     inline NodeID getReturnNode(const SVFFunction* value) const
     {
         return pag->getReturnNode(value);

package/svf/include/Graphs/IRGraph.h

@@ -42,6 +42,8 @@ namespace SVF
 typedef SVFVar PAGNode;
 typedef SVFStmt PAGEdge;
 
+class ObjTypeInfo;
+
 /*
  * Graph representation of SVF IR.
  * It can be seen as a program assignment graph (PAG).
@@ -50,10 +52,61 @@ class IRGraph : public GenericGraph<SVFVar, SVFStmt>
 {
     friend class SVFIRWriter;
     friend class SVFIRReader;
+    friend class SymbolTableBuilder;
+
+public:
+
+    /// Symbol types
+    enum SYMTYPE
+    {
+        NullPtr,
+        BlkPtr,
+        BlackHole,
+        ConstantObj,
+        ValSymbol,
+        ObjSymbol,
+        RetSymbol,
+        VarargSymbol
+    };
+
+    /// various maps defined
+    //{@
+    /// llvm value to sym id map
+    /// local (%) and global (@) identifiers are pointer types which have a value node id.
+    typedef OrderedMap<const SVFValue*, NodeID> ValueToIDMapTy;
+    /// sym id to obj type info map
+    typedef OrderedMap<NodeID, ObjTypeInfo*> IDToTypeInfoMapTy;
+
+    /// function to sym id map
+    typedef OrderedMap<const SVFFunction*, NodeID> FunToIDMapTy;
+    /// struct type to struct info map
+    typedef Set<const SVFType*> SVFTypeSet;
+    //@}
+
+private:
+    ValueToIDMapTy valSymMap;  ///< map a value to its sym id
+    ValueToIDMapTy objSymMap;  ///< map a obj reference to its sym id
+    FunToIDMapTy returnSymMap; ///< return map
+    FunToIDMapTy varargSymMap; ///< vararg map
+    IDToTypeInfoMapTy objTypeInfoMap;       ///< map a memory sym id to its obj
+
+    /// (owned) All SVF Types
+    /// Every type T is mapped to StInfo
+    /// which contains size (fsize) , offset(foffset)
+    /// fsize[i] is the number of fields in the largest such struct, else fsize[i] = 1.
+    /// fsize[0] is always the size of the expanded struct.
+    SVFTypeSet svfTypes;
+
+    /// @brief (owned) All StInfo
+    Set<const StInfo*> stInfos;
+
+    /// total number of symbols
+    NodeID totalSymNum;
+
+    void destorySymTable();
 
 public:
     typedef Set<const SVFStmt*> SVFStmtSet;
-    typedef Map<const SVFValue*,SVFStmtSet> ValueToEdgeMap;
 
 protected:
     SVFStmt::KindToSVFStmtMapTy KindToSVFStmtSetMap; ///< SVFIR edge map containing all PAGEdges
@@ -61,8 +114,6 @@ protected:
     bool fromFile; ///< Whether the SVFIR is built according to user specified data from a txt file
     NodeID nodeNumAfterPAGBuild; ///< initial node number after building SVFIR, excluding later added nodes, e.g., gepobj nodes
     u32_t totalPTAPAGEdge;
-    ValueToEdgeMap valueToEdgeMap; ///< Map SVFValues (e.g., ICFGNodes) to all corresponding PAGEdges
-    SymbolTableInfo* symInfo;
 
     /// Add a node into the graph
     inline NodeID addNode(SVFVar* node)
@@ -86,98 +137,205 @@ protected:
     SVFStmt* hasLabeledEdge(SVFVar* src, SVFVar* op1, SVFStmt::PEDGEK kind,
                             const SVFVar* op2);
 
-    /// Map a value to a set of edges
-    inline void mapValueToEdge(const SVFValue* V, SVFStmt *edge)
-    {
-        auto inserted = valueToEdgeMap.emplace(V, SVFStmtSet{edge});
-        if (!inserted.second)
-        {
-            inserted.first->second.emplace(edge);
-        }
-    }
 public:
     IRGraph(bool buildFromFile)
-        : fromFile(buildFromFile), nodeNumAfterPAGBuild(0), totalPTAPAGEdge(0)
+        : totalSymNum(0), fromFile(buildFromFile), nodeNumAfterPAGBuild(0), totalPTAPAGEdge(0),
+          maxStruct(nullptr), maxStSize(0)
     {
-        symInfo = SymbolTableInfo::SymbolInfo();
-        // insert dummy value if a correct value cannot be found
-        valueToEdgeMap[nullptr] = SVFStmtSet();
     }
 
     virtual ~IRGraph();
 
-    inline SymbolTableInfo* getSymbolInfo() const
-    {
-        return symInfo;
-    }
+
     /// Whether this SVFIR built from a txt file
     inline bool isBuiltFromFile()
     {
         return fromFile;
     }
-    /// Get all SVFIR Edges that corresponds to an LLVM value
-    inline const SVFStmtSet& getValueEdges(const SVFValue* V)
+
+    /// special value
+    // @{
+    static inline bool isBlkPtr(NodeID id)
+    {
+        return (id == BlkPtr);
+    }
+    static inline bool isNullPtr(NodeID id)
+    {
+        return (id == NullPtr);
+    }
+    static inline bool isBlkObj(NodeID id)
+    {
+        return (id == BlackHole);
+    }
+    static inline bool isConstantSym(NodeID id)
+    {
+        return (id == ConstantObj);
+    }
+    static inline bool isBlkObjOrConstantObj(NodeID id)
     {
-        auto it = valueToEdgeMap.find(V);
-        if (it == valueToEdgeMap.end())
-        {
-            //special empty set
-            return valueToEdgeMap.at(nullptr);
-        }
-        return it->second;
+        return (isBlkObj(id) || isConstantSym(id));
     }
 
-    /// Get SVFIR Node according to LLVM value
-    ///getNode - Return the node corresponding to the specified pointer.
-    inline NodeID getValueNode(const SVFValue* V)
+    inline NodeID blkPtrSymID() const
     {
-        return symInfo->getValSym(V);
+        return BlkPtr;
     }
-    inline bool hasValueNode(const SVFValue* V)
+
+    inline NodeID nullPtrSymID() const
     {
-        return symInfo->hasValSym(V);
+        return NullPtr;
     }
-    /// getObject - Return the obj node id refer to the memory object for the
-    /// specified global, heap or alloca instruction according to llvm value.
-    inline NodeID getObjectNode(const SVFValue* V)
+
+    inline NodeID constantSymID() const
     {
-        return symInfo->getObjSym(V);
+        return ConstantObj;
     }
-    /// GetReturnNode - Return the unique node representing the return value of a function
-    inline NodeID getReturnNode(const SVFFunction* func) const
+
+    inline NodeID blackholeSymID() const
     {
-        return symInfo->getRetSym(func);
+        return BlackHole;
     }
-    /// getVarargNode - Return the unique node representing the variadic argument of a variadic function.
-    inline NodeID getVarargNode(const SVFFunction* func) const
+
+    /// Statistics
+    //@{
+    inline u32_t getTotalSymNum() const
+    {
+        return totalSymNum;
+    }
+    inline u32_t getMaxStructSize() const
+    {
+        return maxStSize;
+    }
+    //@}
+
+    /// Get different kinds of syms maps
+    //@{
+    inline ValueToIDMapTy& valSyms()
+    {
+        return valSymMap;
+    }
+
+    inline ValueToIDMapTy& objSyms()
+    {
+        return objSymMap;
+    }
+
+    inline IDToTypeInfoMapTy& idToObjTypeInfoMap()
+    {
+        return objTypeInfoMap;
+    }
+
+    inline const IDToTypeInfoMapTy& idToObjTypeInfoMap() const
     {
-        return symInfo->getVarargSym(func);
+        return objTypeInfoMap;
     }
+
+    inline FunToIDMapTy& retSyms()
+    {
+        return returnSymMap;
+    }
+
+    inline FunToIDMapTy& varargSyms()
+    {
+        return varargSymMap;
+    }
+
+    //@}
+
+    /// Get SVFIR Node according to LLVM value
+    ///getNode - Return the node corresponding to the specified pointer.
+    NodeID getValueNode(const SVFValue* V);
+
+    bool hasValueNode(const SVFValue* V);
+
+    /// getObject - Return the obj node id refer to the memory object for the
+    /// specified global, heap or alloca instruction according to llvm value.
+    NodeID getObjectNode(const SVFValue* V);
+
+    inline ObjTypeInfo* getObjTypeInfo(NodeID id) const
+    {
+        IDToTypeInfoMapTy::const_iterator iter = objTypeInfoMap.find(id);
+        assert(iter!=objTypeInfoMap.end() && "obj type info not found");
+        return iter->second;
+    }
+
+    /// GetReturnNode - Return the unique node representing the return value of a function
+    NodeID getReturnNode(const SVFFunction* func) const;
+
+    /// getVarargNode - Return the unique node representing the variadic argument of a variadic function.
+    NodeID getVarargNode(const SVFFunction* func) const;
+
     inline NodeID getBlackHoleNode() const
     {
-        return symInfo->blackholeSymID();
+        return blackholeSymID();
     }
     inline NodeID getConstantNode() const
     {
-        return symInfo->constantSymID();
+        return constantSymID();
     }
     inline NodeID getBlkPtr() const
     {
-        return symInfo->blkPtrSymID();
+        return blkPtrSymID();
     }
     inline NodeID getNullPtr() const
     {
-        return symInfo->nullPtrSymID();
+        return nullPtrSymID();
     }
 
     inline u32_t getValueNodeNum() const
     {
-        return symInfo->valSyms().size();
+        return valSymMap.size();
     }
     inline u32_t getObjectNodeNum() const
     {
-        return symInfo->idToObjTypeInfoMap().size();
+        return objTypeInfoMap.size();
+    }
+
+    /// Constant reader that won't change the state of the symbol table
+    //@{
+    inline const SVFTypeSet& getSVFTypes() const
+    {
+        return svfTypes;
     }
+
+    inline const Set<const StInfo*>& getStInfos() const
+    {
+        return stInfos;
+    }
+    //@}
+    /// Given an offset from a Gep Instruction, return it modulus offset by considering memory layout
+    virtual APOffset getModulusOffset(const BaseObjVar* baseObj, const APOffset& apOffset);
+    /// Get struct info
+    //@{
+    ///Get a reference to StructInfo.
+    const StInfo* getTypeInfo(const SVFType* T) const;
+    inline bool hasSVFTypeInfo(const SVFType* T)
+    {
+        return svfTypes.find(T) != svfTypes.end();
+    }
+
+    /// Create an objectInfo based on LLVM type (value is null, and type could be null, representing a dummy object)
+    ObjTypeInfo* createObjTypeInfo(const SVFType* type);
+
+    const ObjTypeInfo* createDummyObjTypeInfo(NodeID symId, const SVFType* type);
+
+    ///Get a reference to the components of struct_info.
+    /// Number of flattened elements of an array or struct
+    u32_t getNumOfFlattenElements(const SVFType* T);
+    /// Flattened element idx of an array or struct by considering stride
+    u32_t getFlattenedElemIdx(const SVFType* T, u32_t origId);
+    /// Return the type of a flattened element given a flattened index
+    const SVFType* getFlatternedElemType(const SVFType* baseType, u32_t flatten_idx);
+    ///  struct A { int id; int salary; }; struct B { char name[20]; struct A a;}   B b;
+    ///  OriginalElemType of b with field_idx 1 : Struct A
+    ///  FlatternedElemType of b with field_idx 1 : int
+    const SVFType* getOriginalElemType(const SVFType* baseType, u32_t origId) const;
+    //@}
+
+    /// Debug method
+    void printFlattenFields(const SVFType* type);
+
+
     inline u32_t getNodeNumAfterPAGBuild() const
     {
         return nodeNumAfterPAGBuild;
@@ -205,11 +363,38 @@ public:
         return "SVFIR";
     }
 
+    void dumpSymTable();
+
     /// Dump SVFIR
     void dump(std::string name);
 
     /// View graph from the debugger
     void view();
+
+
+
+    ///The struct type with the most fields
+    const SVFType* maxStruct;
+
+    ///The number of fields in max_struct
+    u32_t maxStSize;
+
+    inline void addTypeInfo(const SVFType* ty)
+    {
+        bool inserted = svfTypes.insert(ty).second;
+        if(!inserted)
+            assert(false && "this type info has been added before");
+    }
+
+    inline void addStInfo(StInfo* stInfo)
+    {
+        stInfos.insert(stInfo);
+    }
+
+protected:
+
+    /// Return the flattened field type for struct type only
+    const std::vector<const SVFType*>& getFlattenFieldTypes(const SVFStructType *T);
 };
 
 }

package/svf/include/MSSA/MemRegion.h

@@ -480,7 +480,7 @@ public:
     NodeBS getModInfoForCall(const CallICFGNode* cs);
     NodeBS getRefInfoForCall(const CallICFGNode* cs);
     ModRefInfo getModRefInfo(const CallICFGNode* cs);
-    ModRefInfo getModRefInfo(const CallICFGNode* cs, const SVFValue* V);
+    ModRefInfo getModRefInfo(const CallICFGNode* cs, const SVFVar* V);
     ModRefInfo getModRefInfo(const CallICFGNode* cs1, const CallICFGNode* cs2);
     //@}
 

package/svf/include/MemoryModel/AccessPath.h

@@ -51,7 +51,6 @@ class SVFVar;
 */
 class AccessPath
 {
-    friend class SymbolTableInfo;
     friend class SVFIRWriter;
     friend class SVFIRReader;
 

package/svf/include/MemoryModel/PointerAnalysis.h

@@ -233,8 +233,8 @@ public:
     virtual void computeDDAPts(NodeID) {}
 
     /// Interface exposed to users of our pointer analysis, given Value infos
-    virtual AliasResult alias(const SVFValue* V1,
-                              const SVFValue* V2) = 0;
+    virtual AliasResult alias(const SVFVar* V1,
+                              const SVFVar* V2) = 0;
 
     /// Interface exposed to users of our pointer analysis, given PAGNodeID
     virtual AliasResult alias(NodeID node1, NodeID node2) = 0;

package/svf/include/MemoryModel/PointerAnalysisImpl.h

@@ -215,8 +215,11 @@ private:
 
 public:
     /// Interface expose to users of our pointer analysis, given Value infos
-    AliasResult alias(const SVFValue* V1,
-                      const SVFValue* V2) override;
+    AliasResult alias(const SVFVar* V1,
+                      const SVFVar* V2) override
+    {
+        return alias(V1->getId(), V2->getId());
+    }
 
     /// Interface expose to users of our pointer analysis, given PAGNodeID
     AliasResult alias(NodeID node1, NodeID node2) override;
@@ -501,9 +504,9 @@ public:
     }
 
     /// Interface expose to users of our pointer analysis, given Value infos
-    virtual inline AliasResult alias(const SVFValue* V1, const SVFValue* V2)
+    virtual inline AliasResult alias(const SVFVar* V1, const SVFVar* V2)
     {
-        return  alias(pag->getValueNode(V1),pag->getValueNode(V2));
+        return  alias(V1->getId(), V2->getId());
     }
     /// Interface expose to users of our pointer analysis, given two pointers
     virtual inline AliasResult alias(NodeID node1, NodeID node2)