svf-lib 1.0.2319 → 1.0.2321

package/SVF-osx/Release-build/include/SVF/SVF-LLVM/LLVMModule.h

@@ -0,0 +1,527 @@
+//===- LLVMModule.h -- LLVM Module class-----------------------------------------//
+//
+//                     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 Affero 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 Affero General Public License for more details.
+
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+//===----------------------------------------------------------------------===//
+
+/*
+ * LLVMModule.h
+ *
+ *  Created on: 23 Mar.2020
+ *      Author: Yulei Sui
+ */
+
+#ifndef INCLUDE_SVF_FE_LLVMMODULE_H_
+#define INCLUDE_SVF_FE_LLVMMODULE_H_
+
+#include "SVF-LLVM/BasicTypes.h"
+#include "Util/Options.h"
+#include "Graphs/BasicBlockG.h"
+
+namespace SVF
+{
+
+class ObjTypeInference;
+
+class LLVMModuleSet
+{
+    friend class SVFIRBuilder;
+    friend class ICFGBuilder;
+    friend class SymbolTableBuilder;
+
+public:
+
+    typedef std::vector<const Function*> FunctionSetType;
+    typedef Map<const Function*, const Function*> FunDeclToDefMapTy;
+    typedef Map<const Function*, FunctionSetType> FunDefToDeclsMapTy;
+    typedef Map<const GlobalVariable*, GlobalVariable*> GlobalDefToRepMapTy;
+
+    typedef Map<const Function*, FunObjVar*> LLVMFun2FunObjVarMap;
+    typedef Map<const BasicBlock*, SVFBasicBlock*> LLVMBB2SVFBBMap;
+    typedef Map<const SVFValue*, const Value*> SVFBaseNode2LLVMValueMap;
+    typedef Map<const Type*, SVFType*> LLVMType2SVFTypeMap;
+    typedef Map<const Type*, StInfo*> Type2TypeInfoMap;
+    typedef Map<std::string, std::vector<std::string>> Fun2AnnoMap;
+
+    typedef Map<const Instruction*, CallICFGNode *> CSToCallNodeMapTy;
+    typedef Map<const Instruction*, RetICFGNode *> CSToRetNodeMapTy;
+    typedef Map<const Instruction*, IntraICFGNode *> InstToBlockNodeMapTy;
+    typedef Map<const Function*, FunEntryICFGNode *> FunToFunEntryNodeMapTy;
+    typedef Map<const Function*, FunExitICFGNode *> FunToFunExitNodeMapTy;
+
+    /// llvm value to sym id map
+    /// local (%) and global (@) identifiers are pointer types which have a value node id.
+    typedef OrderedMap<const Value*, NodeID> ValueToIDMapTy;
+
+    typedef OrderedMap<const Function*, NodeID> FunToIDMapTy;
+
+    typedef std::vector<const Function*> FunctionSet;
+    typedef Map<const Function*, const BasicBlock*> FunToExitBBMap;
+    typedef Map<const Function*, const Function *> FunToRealDefFunMap;
+
+private:
+    static LLVMModuleSet* llvmModuleSet;
+    static bool preProcessed;
+    SVFIR* svfir;
+    std::unique_ptr<LLVMContext> owned_ctx;
+    std::vector<std::unique_ptr<Module>> owned_modules;
+    std::vector<std::reference_wrapper<Module>> modules;
+
+    /// Record some "sse_" function declarations used in other ext function definition, e.g., svf_ext_foo(), and svf_ext_foo() used in app functions
+    FunctionSetType ExtFuncsVec;
+    /// Record annotations of function in extapi.bc
+    Fun2AnnoMap ExtFun2Annotations;
+
+    // Map SVFFunction to its annotations
+    Map<const Function*, std::vector<std::string>> func2Annotations;
+
+    /// Global definition to a rep definition map
+    GlobalDefToRepMapTy GlobalDefToRepMap;
+
+    LLVMFun2FunObjVarMap LLVMFun2FunObjVar; ///< Map an LLVM Function to an SVF Funobjvar
+    LLVMBB2SVFBBMap LLVMBB2SVFBB;
+    LLVMType2SVFTypeMap LLVMType2SVFType;
+    Type2TypeInfoMap Type2TypeInfo;
+    ObjTypeInference* typeInference;
+
+    SVFBaseNode2LLVMValueMap SVFBaseNode2LLVMValue;
+    CSToCallNodeMapTy CSToCallNodeMap; ///< map a callsite to its CallICFGNode
+    CSToRetNodeMapTy CSToRetNodeMap; ///< map a callsite to its RetICFGNode
+    InstToBlockNodeMapTy InstToBlockNodeMap; ///< map a basic block to its ICFGNode
+    FunToFunEntryNodeMapTy FunToFunEntryNodeMap; ///< map a function to its FunExitICFGNode
+    FunToFunExitNodeMapTy FunToFunExitNodeMap; ///< map a function to its FunEntryICFGNode
+
+    Map<const Function*, DominatorTree> FunToDominatorTree;
+
+    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
+
+    FunctionSet funSet;
+    FunToExitBBMap funToExitBB;
+    FunToRealDefFunMap funToRealDefFun;
+
+    /// Constructor
+    LLVMModuleSet();
+
+    void build();
+
+public:
+    ~LLVMModuleSet();
+
+    static inline LLVMModuleSet* getLLVMModuleSet()
+    {
+        if (!llvmModuleSet)
+            llvmModuleSet = new LLVMModuleSet;
+        return llvmModuleSet;
+    }
+
+    static void releaseLLVMModuleSet()
+    {
+        delete llvmModuleSet;
+        llvmModuleSet = nullptr;
+    }
+
+    // Build an SVF module from a given LLVM Module instance (for use e.g. in a LLVM pass)
+    static void buildSVFModule(Module& mod);
+
+    // Build an SVF module from the bitcode files provided in `moduleNameVec`
+    static void buildSVFModule(const std::vector<std::string>& moduleNameVec);
+
+    static void preProcessBCs(std::vector<std::string>& moduleNameVec);
+
+    u32_t getModuleNum() const
+    {
+        return modules.size();
+    }
+
+    const std::vector<std::reference_wrapper<Module>>& getLLVMModules() const
+    {
+        return modules;
+    }
+
+    Module *getModule(u32_t idx) const
+    {
+        return &getModuleRef(idx);
+    }
+
+    Module &getModuleRef(u32_t idx) const
+    {
+        assert(idx < getModuleNum() && "Out of range.");
+        return modules[idx];
+    }
+
+    // Dump modules to files
+    void dumpModulesToFile(const std::string& suffix);
+
+public:
+
+    inline const BasicBlock* getFunExitBB(const Function* fun) const
+    {
+        auto it = funToExitBB.find(fun);
+        if (it == funToExitBB.end()) return nullptr;
+        else return it->second;
+    }
+
+    inline const Function* getRealDefFun(const Function* fun) const
+    {
+        auto it = funToRealDefFun.find(fun);
+        if (it == funToRealDefFun.end()) return nullptr;
+        else return it->second;
+    }
+
+    inline const FunctionSet& getFunctionSet() const
+    {
+        return funSet;
+    }
+
+    inline u32_t getValueNodeNum() const
+    {
+        return valSymMap.size();
+    }
+
+    inline u32_t getObjNodeNum() const
+    {
+        return objSymMap.size();
+    }
+
+    inline ValueToIDMapTy& valSyms()
+    {
+        return valSymMap;
+    }
+
+    inline ValueToIDMapTy& objSyms()
+    {
+        return objSymMap;
+    }
+
+    /// Get SVFIR Node according to LLVM value
+    ///getNode - Return the node corresponding to the specified pointer.
+    NodeID getValueNode(const Value* V);
+
+    bool hasValueNode(const Value* 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 Value* V);
+
+    void dumpSymTable();
+
+public:
+
+    // create a SVFBasicBlock according to LLVM BasicBlock, then add it to SVFFunction's BasicBlockGraph
+    inline void addBasicBlock(FunObjVar* fun, const BasicBlock* bb)
+    {
+        SVFBasicBlock* svfBB = fun->getBasicBlockGraph()->addBasicBlock(bb->getName().str());
+        LLVMBB2SVFBB[bb] = svfBB;
+        SVFBaseNode2LLVMValue[svfBB] = bb;
+    }
+
+    inline void addInstructionMap(const Instruction* inst, CallICFGNode* svfInst)
+    {
+        CSToCallNodeMap[inst] = svfInst;
+        addToSVFVar2LLVMValueMap(inst, svfInst);
+    }
+    inline void addInstructionMap(const Instruction* inst, RetICFGNode* svfInst)
+    {
+        CSToRetNodeMap[inst] = svfInst;
+        addToSVFVar2LLVMValueMap(inst, svfInst);
+    }
+    inline void addInstructionMap(const Instruction* inst, IntraICFGNode* svfInst)
+    {
+        InstToBlockNodeMap[inst] = svfInst;
+        addToSVFVar2LLVMValueMap(inst, svfInst);
+    }
+
+    inline bool hasLLVMValue(const SVFValue* value) const
+    {
+        return SVFBaseNode2LLVMValue.find(value) != SVFBaseNode2LLVMValue.end();
+    }
+
+    const Value* getLLVMValue(const SVFValue* value) const
+    {
+        SVFBaseNode2LLVMValueMap ::const_iterator it = SVFBaseNode2LLVMValue.find(value);
+        assert(it != SVFBaseNode2LLVMValue.end() && "can't find corresponding llvm value!");
+        return it->second;
+    }
+
+    inline const FunObjVar* getFunObjVar(const Function* fun) const
+    {
+        LLVMFun2FunObjVarMap::const_iterator it = LLVMFun2FunObjVar.find(fun);
+        assert(it!=LLVMFun2FunObjVar.end() && "SVF Function not found!");
+        return it->second;
+    }
+
+    inline FunToIDMapTy& retSyms()
+    {
+        return returnSymMap;
+    }
+
+    inline FunToIDMapTy& varargSyms()
+    {
+        return varargSymMap;
+    }
+
+    NodeID getReturnNode(const Function *func) const
+    {
+        FunToIDMapTy::const_iterator iter =  returnSymMap.find(func);
+        assert(iter!=returnSymMap.end() && "ret sym not found");
+        return iter->second;
+    }
+
+    NodeID getVarargNode(const Function *func) const
+    {
+        FunToIDMapTy::const_iterator iter =  varargSymMap.find(func);
+        assert(iter!=varargSymMap.end() && "vararg sym not found");
+        return iter->second;
+    }
+
+    SVFBasicBlock* getSVFBasicBlock(const BasicBlock* bb)
+    {
+        LLVMBB2SVFBBMap::const_iterator it = LLVMBB2SVFBB.find(bb);
+        assert(it!=LLVMBB2SVFBB.end() && "SVF BasicBlock not found!");
+        return it->second;
+    }
+
+    /// Get the corresponding Function based on its name
+    inline const Function* getFunction(const std::string& name)
+    {
+        Function* fun = nullptr;
+
+        for (u32_t i = 0; i < llvmModuleSet->getModuleNum(); ++i)
+        {
+            Module* mod = llvmModuleSet->getModule(i);
+            fun = mod->getFunction(name);
+            if (fun)
+            {
+                return fun;
+            }
+        }
+        return nullptr;
+    }
+
+    /// Get the corresponding Function based on its name
+    const FunObjVar* getFunObjVar(const std::string& name);
+
+    ICFGNode* getICFGNode(const Instruction* inst);
+
+    bool hasICFGNode(const Instruction* inst);
+
+    /// get a call node
+    CallICFGNode* getCallICFGNode(const Instruction*  cs);
+    /// get a return node
+    RetICFGNode* getRetICFGNode(const Instruction*  cs);
+    /// get a intra node
+    IntraICFGNode* getIntraICFGNode(const Instruction* inst);
+
+    /// Add a function entry node
+    inline FunEntryICFGNode* getFunEntryICFGNode(const Function*  fun)
+    {
+        FunEntryICFGNode* b = getFunEntryBlock(fun);
+        assert(b && "Function entry not created?");
+        return b;
+    }
+    /// Add a function exit node
+    inline FunExitICFGNode* getFunExitICFGNode(const Function*  fun)
+    {
+        FunExitICFGNode* b = getFunExitBlock(fun);
+        assert(b && "Function exit not created?");
+        return b;
+    }
+
+
+    /// Global to rep
+    bool hasGlobalRep(const GlobalVariable* val) const
+    {
+        GlobalDefToRepMapTy::const_iterator it = GlobalDefToRepMap.find(val);
+        return it != GlobalDefToRepMap.end();
+    }
+
+    GlobalVariable *getGlobalRep(const GlobalVariable* val) const
+    {
+        GlobalDefToRepMapTy::const_iterator it = GlobalDefToRepMap.find(val);
+        assert(it != GlobalDefToRepMap.end() && "has no rep?");
+        return it->second;
+    }
+
+    Module* getMainLLVMModule() const
+    {
+        assert(!empty() && "empty LLVM module!!");
+        for (size_t i = 0; i < getModuleNum(); ++i)
+        {
+            Module& module = getModuleRef(i);
+            if (module.getName().str() != ExtAPI::getExtAPI()->getExtBcPath())
+            {
+                return &module;
+            }
+        }
+        assert(false && "no main module found!");
+        return nullptr;
+    }
+
+    LLVMContext& getContext() const
+    {
+        assert(!empty() && "empty LLVM module!!");
+        return getMainLLVMModule()->getContext();
+    }
+
+    bool empty() const
+    {
+        return getModuleNum() == 0;
+    }
+
+    /// Get or create SVFType and typeinfo
+    SVFType* getSVFType(const Type* T);
+    /// Get LLVM Type
+    const Type* getLLVMType(const SVFType* T) const;
+
+    ObjTypeInference* getTypeInference();
+
+    DominatorTree& getDomTree(const Function* fun);
+
+    std::string getExtFuncAnnotation(const Function* fun, const std::string& funcAnnotation);
+
+    const std::vector<std::string>& getExtFuncAnnotations(const Function* fun);
+
+    // Does (F) have some annotation?
+    bool hasExtFuncAnnotation(const Function* fun, const std::string& funcAnnotation);
+
+    // Does (F) have a static var X (unavailable to us) that its return points to?
+    bool has_static(const Function *F);
+
+    // Does (F) have a memcpy_like operation?
+    bool is_memcpy(const Function *F);
+
+    // Does (F) have a memset_like operation?
+    bool is_memset(const Function *F);
+
+    // Does (F) allocate a new object and return it?
+    bool is_alloc(const Function *F);
+
+    // Does (F) allocate a new object and assign it to one of its arguments?
+    bool is_arg_alloc(const Function *F);
+
+    // Does (F) allocate a new stack object and return it?
+    bool is_alloc_stack_ret(const Function *F);
+
+    // Get the position of argument which holds the new object
+    s32_t get_alloc_arg_pos(const Function *F);
+
+    // Does (F) reallocate a new object?
+    bool is_realloc(const Function *F);
+
+    // Should (F) be considered "external" (either not defined in the program
+    //   or a user-defined version of a known alloc or no-op)?
+    bool is_ext(const Function *F);
+
+    // Set the annotation of (F)
+    void setExtFuncAnnotations(const Function* fun, const std::vector<std::string>& funcAnnotations);
+
+private:
+    inline void addFunctionSet(const Function* svfFunc)
+    {
+        funSet.push_back(svfFunc);
+    }
+
+    inline void setFunExitBB(const Function* fun, const BasicBlock* bb)
+    {
+        funToExitBB[fun] = bb;
+    }
+
+    inline void setFunRealDefFun(const Function* fun, const Function* realDefFun)
+    {
+        funToRealDefFun[fun] = realDefFun;
+    }
+    /// Create SVFTypes
+    SVFType* addSVFTypeInfo(const Type* t);
+    /// Collect a type info
+    StInfo* collectTypeInfo(const Type* ty);
+    /// Collect the struct info and set the number of fields after flattening
+    StInfo* collectStructInfo(const StructType* structTy, u32_t& numFields);
+    /// Collect the array info
+    StInfo* collectArrayInfo(const ArrayType* T);
+    /// Collect simple type (non-aggregate) info
+    StInfo* collectSimpleTypeInfo(const Type* T);
+
+    std::vector<const Function*> getLLVMGlobalFunctions(const GlobalVariable* global);
+
+    void loadModules(const std::vector<std::string>& moduleNameVec);
+    // Loads ExtAPI bitcode file; uses LLVMContext made while loading module bitcode files or from Module
+    void loadExtAPIModules();
+    void addSVFMain();
+
+    void createSVFDataStructure();
+
+    void addToSVFVar2LLVMValueMap(const Value* val, SVFValue* svfBaseNode);
+    void buildFunToFunMap();
+    void buildGlobalDefToRepMap();
+    /// Invoke llvm passes to modify module
+    void prePassSchedule();
+    void buildSymbolTable() const;
+    void collectExtFunAnnotations(const Module* mod);
+
+    /// Get/Add a call node
+    inline CallICFGNode* getCallBlock(const Instruction* cs)
+    {
+        CSToCallNodeMapTy::const_iterator it = CSToCallNodeMap.find(cs);
+        if (it == CSToCallNodeMap.end())
+            return nullptr;
+        return it->second;
+    }
+
+    /// Get/Add a return node
+    inline RetICFGNode* getRetBlock(const Instruction* cs)
+    {
+        CSToRetNodeMapTy::const_iterator it = CSToRetNodeMap.find(cs);
+        if (it == CSToRetNodeMap.end())
+            return nullptr;
+        return it->second;
+    }
+
+    inline IntraICFGNode* getIntraBlock(const Instruction* inst)
+    {
+        InstToBlockNodeMapTy::const_iterator it = InstToBlockNodeMap.find(inst);
+        if (it == InstToBlockNodeMap.end())
+            return nullptr;
+        return it->second;
+    }
+
+    /// Get/Add a function entry node
+    inline FunEntryICFGNode* getFunEntryBlock(const Function* fun)
+    {
+        FunToFunEntryNodeMapTy::const_iterator it = FunToFunEntryNodeMap.find(fun);
+        if (it == FunToFunEntryNodeMap.end())
+            return nullptr;
+        return it->second;
+    }
+
+    /// Get/Add a function exit node
+    inline FunExitICFGNode* getFunExitBlock(const Function* fun)
+    {
+        FunToFunExitNodeMapTy::const_iterator it = FunToFunExitNodeMap.find(fun);
+        if (it == FunToFunExitNodeMap.end())
+            return nullptr;
+        return it->second;
+    }
+};
+
+} // End namespace SVF
+
+#endif /* INCLUDE_SVF_FE_LLVMMODULE_H_ */