svf-lib 1.0.2195 → 1.0.2197

package/SVF-osx/Release-build/include/SVFIR/SymbolTableInfo.h

@@ -1,545 +0,0 @@
-//===- 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 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/>.
-//
-//===----------------------------------------------------------------------===//
-
-/*
- * SymbolTableInfo.h
- *
- *  Created on: Nov 11, 2013
- *      Author: Yulei Sui
- */
-
-#ifndef INCLUDE_SVFIR_SYMBOLTABLEINFO_H_
-#define INCLUDE_SVFIR_SYMBOLTABLEINFO_H_
-
-
-#include "Util/SVFUtil.h"
-#include "MemoryModel/AccessPath.h"
-#include "SVFIR/SVFModule.h"
-namespace SVF
-{
-
-class ObjTypeInfo;
-class StInfo;
-class BaseObjVar;
-
-/*!
- * Symbol table of the memory model for analysis
- */
-class SymbolTableInfo
-{
-    friend class SymbolTableBuilder;
-    friend class SVFIRWriter;
-    friend class SVFIRReader;
-
-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*, SymID> ValueToIDMapTy;
-    /// sym id to obj type info map
-    typedef OrderedMap<SymID, ObjTypeInfo*> IDToTypeInfoMapTy;
-
-    /// function to sym id map
-    typedef OrderedMap<const SVFFunction*, SymID> 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
-
-    // Singleton pattern here to enable instance of SymbolTableInfo can only be created once.
-    static SymbolTableInfo* symInfo;
-
-    /// Module
-    SVFModule* mod;
-
-    /// 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;
-    }
-    //@}
-
-    /// Module
-    inline SVFModule* getModule()
-    {
-        return mod;
-    }
-    /// Module
-    inline void setModule(SVFModule* m)
-    {
-        mod = m;
-    }
-
-    /// 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 isConstantObj(NodeID id)
-    {
-        return (id == ConstantObj);
-    }
-    static inline bool isBlkObjOrConstantObj(NodeID id)
-    {
-        return (isBlkObj(id) || isConstantObj(id));
-    }
-
-    inline SymID blkPtrSymID() const
-    {
-        return BlkPtr;
-    }
-
-    inline SymID nullPtrSymID() const
-    {
-        return NullPtr;
-    }
-
-    inline SymID constantSymID() const
-    {
-        return ConstantObj;
-    }
-
-    inline SymID blackholeSymID() const
-    {
-        return BlackHole;
-    }
-
-    /// Get different kinds of syms
-    //@{
-    SymID getValSym(const SVFValue* val);
-
-    bool hasValSym(const SVFValue* val);
-
-    inline SymID getObjSym(const SVFValue* val) const
-    {
-        const SVFValue* svfVal = val;
-        if(const SVFGlobalValue* g = SVFUtil::dyn_cast<SVFGlobalValue>(val))
-            svfVal = g->getDefGlobalForMultipleModule();
-        ValueToIDMapTy::const_iterator iter = objSymMap.find(svfVal);
-        assert(iter!=objSymMap.end() && "obj sym not found");
-        return iter->second;
-    }
-
-    inline ObjTypeInfo* getObjTypeInfo(SymID id) const
-    {
-        IDToTypeInfoMapTy::const_iterator iter = objTypeInfoMap.find(id);
-        assert(iter!=objTypeInfoMap.end() && "obj type info not found");
-        return iter->second;
-    }
-
-    inline SymID getRetSym(const SVFFunction* val) const
-    {
-        FunToIDMapTy::const_iterator iter =  returnSymMap.find(val);
-        assert(iter!=returnSymMap.end() && "ret sym not found");
-        return iter->second;
-    }
-
-    inline SymID getVarargSym(const SVFFunction* val) const
-    {
-        FunToIDMapTy::const_iterator iter =  varargSymMap.find(val);
-        assert(iter!=varargSymMap.end() && "vararg sym not found");
-        return iter->second;
-    }
-    //@}
-
-
-    /// 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 objTypeInfoMap;
-    }
-
-    inline FunToIDMapTy& retSyms()
-    {
-        return returnSymMap;
-    }
-
-    inline FunToIDMapTy& varargSyms()
-    {
-        return varargSymMap;
-    }
-
-    //@}
-
-    /// 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;
-    }
-    //@}
-
-    /// 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(SymID 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);
-
-    static std::string toString(SYMTYPE symtype);
-
-    /// Another debug method
-    virtual void dump();
-
-    /// Given an offset from a Gep Instruction, return it modulus offset by considering memory layout
-    virtual APOffset getModulusOffset(const BaseObjVar* baseObj, const APOffset& apOffset);
-
-    ///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);
-
-    /// (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;
-};
-
-class SVFBaseNode;
-
-/*!
- * Type Info of an abstract memory object
- */
-class ObjTypeInfo
-{
-    friend class SVFIRWriter;
-    friend class SVFIRReader;
-    friend class SymbolTableBuilder;
-
-public:
-    typedef enum
-    {
-        FUNCTION_OBJ = 0x1,  // object is a function
-        GLOBVAR_OBJ = 0x2,  // object is a global variable
-        STATIC_OBJ = 0x4,  // object is a static variable allocated before main
-        STACK_OBJ = 0x8,  // object is a stack variable
-        HEAP_OBJ = 0x10,  // object is a heap variable
-        VAR_STRUCT_OBJ = 0x20,  // object contains struct
-        VAR_ARRAY_OBJ = 0x40,  // object contains array
-        CONST_STRUCT_OBJ = 0x80,  // constant struct
-        CONST_ARRAY_OBJ = 0x100,  // constant array
-        CONST_GLOBAL_OBJ = 0x200,  // global constant object
-        CONST_DATA = 0x400,  // constant object str e.g. 5, 10, 1.0
-    } MEMTYPE;
-
-private:
-    /// SVF type
-    const SVFType* type;
-    /// Type flags
-    u32_t flags;
-    /// Max offset for flexible field sensitive analysis
-    /// maximum number of field object can be created
-    /// minimum number is 0 (field insensitive analysis)
-    u32_t maxOffsetLimit;
-    /// Size of the object or number of elements
-    u32_t elemNum;
-
-    /// Byte size of object
-    u32_t byteSize;
-
-    void resetTypeForHeapStaticObj(const SVFType* type);
-public:
-
-    /// Constructors
-    ObjTypeInfo(const SVFType* t, u32_t max);
-
-    /// Destructor
-    virtual ~ObjTypeInfo()
-    {
-    }
-
-    /// Get LLVM type
-    inline const SVFType* getType() const
-    {
-        return type;
-    }
-
-    /// Get max field offset limit
-    inline u32_t getMaxFieldOffsetLimit()
-    {
-        return maxOffsetLimit;
-    }
-
-    /// Get max field offset limit
-    inline void setMaxFieldOffsetLimit(u32_t limit)
-    {
-        maxOffsetLimit = limit;
-    }
-
-    /// Set the number of elements of this object
-    inline void setNumOfElements(u32_t num)
-    {
-        elemNum = num;
-        setMaxFieldOffsetLimit(num);
-    }
-
-    /// Get the number of elements of this object
-    inline u32_t getNumOfElements() const
-    {
-        return elemNum;
-    }
-
-    /// Get the byte size of this object
-    inline u32_t getByteSizeOfObj() const
-    {
-        assert(isConstantByteSize() && "This Obj's byte size is not constant.");
-        return byteSize;
-    }
-
-    /// Set the byte size of this object
-    inline void setByteSizeOfObj(u32_t size)
-    {
-        byteSize = size;
-    }
-
-    /// Check if byte size is a const value
-    inline bool isConstantByteSize() const
-    {
-        return byteSize != 0;
-    }
-
-    /// Flag for this object type
-    //@{
-    inline void setFlag(MEMTYPE mask)
-    {
-        flags |= mask;
-    }
-    inline bool hasFlag(MEMTYPE mask)
-    {
-        return (flags & mask) == mask;
-    }
-    //@}
-
-    /// Object attributes
-    //@{
-    inline bool isFunction()
-    {
-        return hasFlag(FUNCTION_OBJ);
-    }
-    inline bool isGlobalObj()
-    {
-        return hasFlag(GLOBVAR_OBJ);
-    }
-    inline bool isStaticObj()
-    {
-        return hasFlag(STATIC_OBJ);
-    }
-    inline bool isStack()
-    {
-        return hasFlag(STACK_OBJ);
-    }
-    inline bool isHeap()
-    {
-        return hasFlag(HEAP_OBJ);
-    }
-    //@}
-
-    /// Object attributes (noted that an object can be a nested compound types)
-    /// e.g. both isStruct and isArray can return true
-    //@{
-    inline bool isVarStruct()
-    {
-        return hasFlag(VAR_STRUCT_OBJ);
-    }
-    inline bool isConstantStruct()
-    {
-        return hasFlag(CONST_STRUCT_OBJ);
-    }
-    inline bool isStruct()
-    {
-        return hasFlag(VAR_STRUCT_OBJ) || hasFlag(CONST_STRUCT_OBJ);
-    }
-    inline bool isVarArray()
-    {
-        return hasFlag(VAR_ARRAY_OBJ);
-    }
-    inline bool isConstantArray()
-    {
-        return  hasFlag(CONST_ARRAY_OBJ);
-    }
-    inline bool isArray()
-    {
-        return hasFlag(VAR_ARRAY_OBJ) || hasFlag(CONST_ARRAY_OBJ);
-    }
-    inline bool isConstDataOrConstGlobal()
-    {
-        return hasFlag(CONST_GLOBAL_OBJ) || hasFlag(CONST_DATA);
-    }
-    inline bool isConstDataOrAggData()
-    {
-        return hasFlag(CONST_DATA);
-    }
-    //@}
-};
-
-
-} // End namespace SVF
-
-#endif /* INCLUDE_SVFIR_SYMBOLTABLEINFO_H_ */