svf-lib 1.0.728 → 1.0.732

package/SVF-linux/include/MemoryModel/SymbolTableInfo.h

@@ -0,0 +1,440 @@
+//===- SymbolTableInfo.h -- Symbol information from IR------------------------//
+//
+//                     SVF: Static Value-Flow Analysis
+//
+// Copyright (C) <2013->  <Yulei Sui>
+//
+
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+//===----------------------------------------------------------------------===//
+
+/*
+ * SymbolTableInfo.h
+ *
+ *  Created on: Nov 11, 2013
+ *      Author: Yulei Sui
+ */
+
+#ifndef INCLUDE_SVF_FE_SYMBOLTABLEINFO_H_
+#define INCLUDE_SVF_FE_SYMBOLTABLEINFO_H_
+
+#include "MemoryModel/SVFSymbols.h"
+#include "Util/SVFUtil.h"
+
+namespace SVF
+{
+
+/*!
+ * Symbol table of the memory model for analysis
+ */
+class SymbolTableInfo
+{
+friend class SymbolTableBuilder;
+
+public:
+    /// 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 Value *, SymID> ValueToIDMapTy;
+    /// sym id to memory object map
+    typedef OrderedMap<SymID,ObjSym*> IDToMemMapTy;
+    /// function to sym id map
+    typedef OrderedMap<const Function *, SymID> FunToIDMapTy;
+    /// sym id to sym type map
+    typedef OrderedSet<const SVFVar*> SymSet;
+    /// struct type to struct info map
+    typedef OrderedMap<const Type*, StInfo*> TypeToFieldInfoMap;
+    typedef Set<CallSite> CallSiteSet;
+    typedef OrderedMap<const Instruction*,CallSiteID> CallSiteToIDMapTy;
+    typedef OrderedMap<CallSiteID,const Instruction*> IDToCallSiteMapTy;
+
+    //@}
+
+private:
+    /// Data layout on a target machine
+    static DataLayout *dl;
+
+    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
+    SymSet	symSet;	/// < a set of all symbols
+    IDToMemMapTy		objMap;		///< map a memory sym id to its obj
+
+    CallSiteSet callSiteSet;
+
+    // Singleton pattern here to enable instance of SymbolTableInfo can only be created once.
+    static SymbolTableInfo* symInfo;
+
+    /// Module
+    SVFModule* mod;
+
+    /// Max field limit
+    static u32_t maxFieldLimit;
+
+    /// Clean up memory
+    void destroy();
+
+    /// Whether to model constants
+    bool modelConstants;
+
+    /// total number of symbols
+    SymID totalSymNum;
+
+protected:
+    /// Constructor
+    SymbolTableInfo(void) :
+        mod(nullptr), modelConstants(false), totalSymNum(0), maxStruct(nullptr), maxStSize(0)
+    {
+    }
+
+public:
+
+    /// Singleton design here to make sure we only have one instance during any analysis
+    //@{
+    static SymbolTableInfo* SymbolInfo();
+
+    static void releaseSymbolInfo()
+    {
+        delete symInfo;
+        symInfo = nullptr;
+    }
+    virtual ~SymbolTableInfo()
+    {
+        destroy();
+    }
+    //@}
+
+    /// Set / Get modelConstants
+    //@{
+    void setModelConstants(bool _modelConstants)
+    {
+        modelConstants = _modelConstants;
+    }
+    bool getModelConstants() const
+    {
+        return modelConstants;
+    }
+    //@}
+
+    /// Get callsite set
+    //@{
+    inline const CallSiteSet& getCallSiteSet() const
+    {
+        return callSiteSet;
+    }
+    //@}
+
+    /// Module
+    inline SVFModule* getModule()
+    {
+        return mod;
+    }
+        /// Module
+    inline void setModule(SVFModule* m)
+    {
+        mod = m;
+    }
+
+    /// Get target machine data layout
+    inline static DataLayout* getDataLayout(Module* mod)
+    {
+        if(dl==nullptr)
+            return dl = new DataLayout(mod);
+        return dl;
+    }
+
+    /// Helper method to get the size of the type from target data layout
+    //@{
+    u32_t getTypeSizeInBytes(const Type* type);
+    u32_t getTypeSizeInBytes(const StructType *sty, u32_t field_index);
+    //@}
+
+    /// special value
+    // @{
+    static bool isNullPtrSym(const Value *val);
+
+    static bool isBlackholeSym(const Value *val);
+
+    bool isConstantObjSym(const Value *val);
+
+    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 isConstantObj(NodeID id)
+    {
+        return (id == ConstantObj);
+    }
+    static inline bool isBlkObjOrConstantObj(NodeID id)
+    {
+        return (isBlkObj(id) || isConstantObj(id));
+    }
+
+    inline ObjSym* createBlkObj(SymID symId)
+    {
+        assert(isBlkObj(symId));
+        assert(objMap.find(symId)==objMap.end());
+        ObjSym* obj = new BlackHoleSym(symId, createObjTypeInfo());
+        objMap[symId] = obj;
+        return obj;
+    }
+
+    inline ObjSym* createConstantObj(SymID symId)
+    {
+        assert(isConstantObj(symId));
+        assert(objMap.find(symId)==objMap.end());
+        ObjSym* obj = new ConstantObjSym(symId, createObjTypeInfo());
+        objMap[symId] = obj;
+        return obj;
+    }
+
+    inline ObjSym* getBlkObj() const
+    {
+        return getObj(blackholeSymID());
+    }
+    inline ObjSym* getConstantObj() const
+    {
+        return getObj(constantSymID());
+    }
+
+    inline SymID blkPtrSymID() const
+    {
+        return BlkPtr;
+    }
+
+    inline SymID nullPtrSymID() const
+    {
+        return NullPtr;
+    }
+
+    inline SymID constantSymID() const
+    {
+        return ConstantObj;
+    }
+
+    inline SymID blackholeSymID() const
+    {
+        return BlackHole;
+    }
+
+    /// Can only be invoked by PAG::addDummyNode() when creaing PAG from file.
+    inline const ObjSym* createDummyObj(SymID symId, const Type* type)
+    {
+        assert(objMap.find(symId)==objMap.end() && "this dummy obj has been created before");
+        ObjSym* memObj = new ObjSym(symId, createObjTypeInfo(type));
+        objMap[symId] = memObj;
+        symSet.insert(memObj);
+        return memObj;
+    }
+    // @}
+
+    /// Get different kinds of syms
+    //@{
+    SymID getValSym(const Value *val)
+    {
+
+        if(isNullPtrSym(val))
+            return nullPtrSymID();
+        else if(isBlackholeSym(val))
+            return blkPtrSymID();
+        else
+        {
+            ValueToIDMapTy::const_iterator iter =  valSymMap.find(val);
+            assert(iter!=valSymMap.end() &&"value sym not found");
+            return iter->second;
+        }
+    }
+
+    inline bool hasValSym(const Value* val)
+    {
+        if (isNullPtrSym(val) || isBlackholeSym(val))
+            return true;
+        else
+            return (valSymMap.find(val) != valSymMap.end());
+    }
+
+    inline SymID getObjSym(const Value *val) const
+    {
+        ValueToIDMapTy::const_iterator iter = objSymMap.find(SVFUtil::getGlobalRep(val));
+        assert(iter!=objSymMap.end() && "obj sym not found");
+        return iter->second;
+    }
+
+    inline ObjSym* getObj(SymID id) const
+    {
+        IDToMemMapTy::const_iterator iter = objMap.find(id);
+        assert(iter!=objMap.end() && "obj not found");
+        return iter->second;
+    }
+
+    inline SymID getRetSym(const Function *val) const
+    {
+        FunToIDMapTy::const_iterator iter =  returnSymMap.find(val);
+        assert(iter!=returnSymMap.end() && "ret sym not found");
+        return iter->second;
+    }
+
+    inline SymID getVarargSym(const Function *val) const
+    {
+        FunToIDMapTy::const_iterator iter =  varargSymMap.find(val);
+        assert(iter!=varargSymMap.end() && "vararg sym not found");
+        return iter->second;
+    }
+    //@}
+
+ 
+    /// Statistics
+    //@{
+    inline Size_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 IDToMemMapTy& idToObjMap()
+    {
+        return objMap;
+    }
+
+    inline FunToIDMapTy& retSyms()
+    {
+        return returnSymMap;
+    }
+
+    inline FunToIDMapTy& varargSyms()
+    {
+        return varargSymMap;
+    }
+
+    //@}
+
+    /// Get struct info
+    //@{
+    ///Get an iterator for StructInfo, designed as internal methods
+    TypeToFieldInfoMap::iterator getStructInfoIter(const Type *T)
+    {
+        assert(T);
+        TypeToFieldInfoMap::iterator it = typeToFieldInfo.find(T);
+        if (it != typeToFieldInfo.end())
+            return it;
+        else
+        {
+            collectTypeInfo(T);
+            return typeToFieldInfo.find(T);
+        }
+    }
+
+    ///Get a reference to StructInfo.
+    inline StInfo* getStructInfo(const Type *T)
+    {
+        return getStructInfoIter(T)->second;
+    }
+
+    ///Get a reference to the components of struct_info.
+    const inline std::vector<u32_t>& getFattenFieldIdxVec(const Type *T)
+    {
+        return getStructInfoIter(T)->second->getFieldIdxVec();
+    }
+    const inline std::vector<u32_t>& getFattenFieldOffsetVec(const Type *T)
+    {
+        return getStructInfoIter(T)->second->getFieldOffsetVec();
+    }
+    const inline std::vector<FieldInfo>& getFlattenFieldInfoVec(const Type *T)
+    {
+        return getStructInfoIter(T)->second->getFlattenFieldInfoVec();
+    }
+    const inline Type* getOrigSubTypeWithFldInx(const Type* baseType, u32_t field_idx)
+    {
+        return getStructInfoIter(baseType)->second->getFieldTypeWithFldIdx(field_idx);
+    }
+    const inline Type* getOrigSubTypeWithByteOffset(const Type* baseType, u32_t byteOffset)
+    {
+        return getStructInfoIter(baseType)->second->getFieldTypeWithByteOffset(byteOffset);
+    }
+    //@}
+
+    /// Compute gep offset
+    virtual bool computeGepOffset(const User *V, LocationSet& ls);
+    /// Get the base type and max offset
+    const Type *getBaseTypeAndFlattenedFields(const Value *V, std::vector<LocationSet> &fields);
+    /// Replace fields with flatten fields of T if the number of its fields is larger than msz.
+    u32_t getFields(std::vector<LocationSet>& fields, const Type* T, u32_t msz);
+    /// Collect type info
+    void collectTypeInfo(const Type* T);
+    /// Given an offset from a Gep Instruction, return it modulus offset by considering memory layout
+    virtual LocationSet getModulusOffset(const ObjSym* obj, const LocationSet& ls);
+
+    /// Debug method
+    void printFlattenFields(const Type* type);
+
+    static std::string toString(SYMTYPE symtype);
+
+    /// Another debug method
+    virtual void dump();
+
+protected:
+    /// Collect the struct info
+    virtual void collectStructInfo(const StructType *T);
+    /// Collect the array info
+    virtual void collectArrayInfo(const ArrayType* T);
+    /// Collect simple type (non-aggregate) info
+    virtual void collectSimpleTypeInfo(const Type* T);
+
+    /// Create an objectInfo based on LLVM type (value is null, and type could be null, representing a dummy object)
+    ObjTypeInfo* createObjTypeInfo(const Type *type = nullptr);
+
+    /// 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.
+    TypeToFieldInfoMap typeToFieldInfo;
+
+    ///The struct type with the most fields
+    const Type* maxStruct;
+
+    ///The number of fields in max_struct
+    u32_t maxStSize;
+};
+
+
+} // End namespace SVF
+
+#endif /* INCLUDE_SVF_FE_SYMBOLTABLEINFO_H_ */

package/SVF-linux/include/SVF-FE/SymbolTableBuilder.h

@@ -0,0 +1,90 @@
+//===- SymbolTableBuilder.h -- Symbol Table builder-----------------------//
+//
+//                     SVF: Static Value-Flow Analysis
+//
+// Copyright (C) <2013->  <Yulei Sui>
+//
+
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+//===----------------------------------------------------------------------===//
+
+/*
+ * SymbolTableBuilder.h
+ *
+ *  Created on: Apr 28, 2014
+ *      Author: Yulei
+ */
+
+#ifndef SymbolTableBuilder_H_
+#define SymbolTableBuilder_H_
+
+#include "MemoryModel/SVFSymbols.h"
+#include "SVF-FE/LLVMModule.h"
+#include "MemoryModel/SymbolTableInfo.h"
+
+/*
+* This class is to build SymbolTableInfo, MemObjs and ObjTypeInfo
+*/
+namespace SVF
+{
+
+class SymbolTableBuilder 
+{
+
+private:
+    SymbolTableInfo* symInfo;
+
+public:
+    /// Constructor
+    SymbolTableBuilder(SymbolTableInfo* si): symInfo(si){
+    }
+
+    /// Start building memory model
+    void buildMemModel(SVFModule* svfModule);
+
+    /// collect the syms
+    //@{
+    void collectSym(const Value *val);
+
+    void collectVal(const Value *val);
+
+    void collectObj(const Value *val);
+
+    void collectRet(const Function *val);
+
+    void collectVararg(const Function *val);
+    //@}
+
+    /// Handle constant expression
+    // @{
+    void handleGlobalCE(const GlobalVariable *G);
+    void handleGlobalInitializerCE(const Constant *C, u32_t offset);
+    void handleCE(const Value *val);
+    // @}
+
+    /// Create an objectInfo based on LLVM value
+    ObjTypeInfo* createObjTypeInfo(const Value *val);
+
+    /// Initialize TypeInfo based on LLVM Value
+    void initTypeInfo(ObjTypeInfo* typeinfo, const Value* value);
+    /// Analyse types of all flattened fields of this object
+    void analyzeGlobalStackObjType(ObjTypeInfo* typeinfo, const Value* val);
+    /// Return size of this object based on LLVM value
+    u32_t getObjSize(const Value* val);
+};
+
+}
+
+#endif /* SymbolTableBuilder_H_ */

package/SVF-linux/include/Util/BasicTypes.h

@@ -300,16 +300,6 @@ public:
 
 };
 
-class SVFInstruction : public SVFValue
-{
-
-public:
-    SVFInstruction(const std::string& val): SVFValue(val,SVFValue::SVFInst)
-    {
-    }
-
-};
-
 class CallSite {
 private:
     CallBase *CB;

package/SVF-linux/include/Util/SVFUtil.h

@@ -241,6 +241,17 @@ inline const SVFFunction* getFunction(StringRef name)
     return nullptr;
 }
 
+/// find the unique defined global across multiple modules
+inline const Value* getGlobalRep(const Value* val) 
+{
+    if(const GlobalVariable* gvar = SVFUtil::dyn_cast<GlobalVariable>(val))
+    {
+        if (LLVMModuleSet::getLLVMModuleSet()->hasGlobalRep(gvar))
+            val = LLVMModuleSet::getLLVMModuleSet()->getGlobalRep(gvar);
+    }
+    return val;
+}
+
 /// Get the definition of a function across multiple modules
 inline const SVFFunction* getDefFunForMultipleModule(const Function* fun)
 {

package/SVF-linux/include/WPA/Andersen.h

@@ -40,7 +40,6 @@
 namespace SVF
 {
 
-class PTAType;
 class SVFModule;
 
 /*!
@@ -464,94 +463,6 @@ protected:
 };
 
 
-
-/**
- * Wave propagation with diff points-to set with type filter.
- */
-class AndersenWaveDiffWithType : public AndersenWaveDiff
-{
-
-private:
-
-    typedef Map<NodeID, Set<const GepCGEdge*>> TypeMismatchedObjToEdgeTy;
-
-    TypeMismatchedObjToEdgeTy typeMismatchedObjToEdges;
-
-    void recordTypeMismatchedGep(NodeID obj, const GepCGEdge* gepEdge)
-    {
-        TypeMismatchedObjToEdgeTy::iterator it = typeMismatchedObjToEdges.find(obj);
-        if (it != typeMismatchedObjToEdges.end())
-        {
-            Set<const GepCGEdge*> &edges = it->second;
-            edges.insert(gepEdge);
-        }
-        else
-        {
-            Set<const GepCGEdge*> edges;
-            edges.insert(gepEdge);
-            typeMismatchedObjToEdges[obj] = edges;
-        }
-    }
-
-    static AndersenWaveDiffWithType* diffWaveWithType; // static instance
-
-    /// Handle diff points-to set.
-    //@{
-    virtual inline void computeDiffPts(NodeID id)
-    {
-        NodeID rep = sccRepNode(id);
-        getDiffPTDataTy()->computeDiffPts(rep, getDiffPTDataTy()->getPts(rep));
-    }
-    virtual inline const PointsTo& getDiffPts(NodeID id)
-    {
-        NodeID rep = sccRepNode(id);
-        return getDiffPTDataTy()->getDiffPts(rep);
-    }
-    //@}
-
-public:
-    AndersenWaveDiffWithType(PAG* _pag, PTATY type = AndersenWaveDiffWithType_WPA): AndersenWaveDiff(_pag,type)
-    {
-        assert(getTypeSystem()!=nullptr && "a type system is required for this pointer analysis");
-    }
-
-    /// Create an singleton instance directly instead of invoking llvm pass manager
-    static AndersenWaveDiffWithType* createAndersenWaveDiffWithType(PAG* p)
-    {
-        if(diffWaveWithType==nullptr)
-        {
-            diffWaveWithType = new AndersenWaveDiffWithType(p);
-            diffWaveWithType->analyze();
-            return diffWaveWithType;
-        }
-        return diffWaveWithType;
-    }
-    static void releaseAndersenWaveDiffWithType()
-    {
-        if (diffWaveWithType)
-            delete diffWaveWithType;
-        diffWaveWithType = nullptr;
-    }
-
-protected:
-    /// SCC detection
-    virtual NodeStack& SCCDetect();
-    /// merge types of nodes in a cycle
-    void mergeTypeOfNodes(const NodeBS &nodes);
-    /// process "bitcast" CopyCGEdge
-    virtual void processCast(const ConstraintEdge *edge);
-    /// update type of objects when process "bitcast" CopyCGEdge
-    void updateObjType(const Type *type, const PointsTo &objs);
-    /// process mismatched gep edges
-    void processTypeMismatchedGep(NodeID obj, const Type *type);
-    /// match types for Gep Edges
-    virtual bool matchType(NodeID ptrid, NodeID objid, const NormalGepCGEdge *normalGepEdge);
-    /// add type for newly created GepObjNode
-    virtual void addTypeForGepObjNode(NodeID id, const NormalGepCGEdge* normalGepEdge);
-};
-
-
-
 /*
  * Lazy Cycle Detection Based Andersen Analysis
  */

package/SVF-osx/include/DDA/DDAVFSolver.h

@@ -448,7 +448,7 @@ protected:
         assert(obj && "object not found!!");
         if(obj->isStack())
         {
-            if(const AllocaInst* local = SVFUtil::dyn_cast<AllocaInst>(obj->getRefVal()))
+            if(const AllocaInst* local = SVFUtil::dyn_cast<AllocaInst>(obj->getValue()))
             {
                 const SVFFunction* fun = LLVMModuleSet::getLLVMModuleSet()->getSVFFunction(local->getFunction());
                 return _callGraphSCC->isInCycle(_callGraph->getCallGraphNode(fun)->getId());