svf-lib 1.0.2319 → 1.0.2321

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

@@ -0,0 +1,474 @@
+//===----- DCHG.h -- CHG using DWARF debug info ---------------------------//
+// This is based upon the original CHA.h (now CHG.h).
+
+/*
+ * DCHG.h
+ *
+ *  Created on: Aug 23, 2019
+ *      Author: Mohamad Barbar
+ */
+
+// TODO: add a flag such that getCanonicalType returns its arg so
+//       that the impl. does not "node collapsing" based on teq.
+
+#ifndef DCHG_H_
+#define DCHG_H_
+
+#include "Graphs/GenericGraph.h"
+#include "Graphs/CHG.h"
+#include "SVF-LLVM/BasicTypes.h"
+#include "Util/SVFUtil.h"
+#include "Util/WorkList.h"
+
+namespace SVF
+{
+
+class DCHNode;
+
+class DCHEdge : public GenericEdge<DCHNode>
+{
+public:
+    enum
+    {
+        INHERITANCE,  // inheritance relation
+        INSTANCE,     // template-instance relation
+        FIRST_FIELD,  // src -ff-> dst => dst is first field of src
+        STD_DEF       // Edges defined by the standard like (int -std-> char)
+        // We also make the char --> void edge a STD_DEF edge.
+    };
+
+    typedef GenericNode<DCHNode, DCHEdge>::GEdgeSetTy DCHEdgeSetTy;
+
+    DCHEdge(DCHNode *src, DCHNode *dst, GEdgeFlag k = 0)
+        : GenericEdge<DCHNode>(src, dst, k), offset(0)
+    {
+    }
+
+    u32_t getConstantFieldIdx(void) const
+    {
+        return offset;
+    }
+
+    void setOffset(u32_t offset)
+    {
+        this->offset = offset;
+    }
+
+private:
+    u32_t offset;
+};
+
+class DCHNode : public GenericNode<DCHNode, DCHEdge>
+{
+public:
+    typedef enum
+    {
+        PURE_ABSTRACT = 0x1,     // pure virtual abstract class
+        MULTI_INHERITANCE = 0x2, // multi inheritance class
+        TEMPLATE = 0x04,         // template class
+        SCALAR = 0x08            // non-class scalar type
+    } CLASSATTR;
+
+    typedef std::vector<const Function*> FuncVector;
+
+    DCHNode(const DIType* diType, NodeID i = 0, GNodeK k = GNodeK::DCHNodeKd)
+        : GenericNode<DCHNode, DCHEdge>(i, k), vtable(nullptr), flags(0)
+    {
+        this->diType = diType;
+        if (diType == nullptr)
+        {
+            typeName = "null-void";
+        }
+        else if (diType->getRawName() != nullptr)
+        {
+            typeName = diType->getName().str();
+        }
+        else
+        {
+            typeName = "unnamed!";
+        }
+    }
+
+    ~DCHNode() { }
+
+    const DIType * getDIType(void) const
+    {
+        return diType;
+    }
+
+    virtual const std::string& getName() const
+    {
+        return typeName;
+    }
+
+    /// Flags
+    //@{
+    inline void setFlag(CLASSATTR mask)
+    {
+        flags |= mask;
+    }
+    inline bool hasFlag(CLASSATTR mask) const
+    {
+        return (flags & mask) == mask;
+    }
+    //@}
+
+    /// Attribute
+    //@{
+    inline void setPureAbstract()
+    {
+        setFlag(PURE_ABSTRACT);
+    }
+    inline void setMultiInheritance()
+    {
+        setFlag(MULTI_INHERITANCE);
+    }
+    inline void setTemplate()
+    {
+        setFlag(TEMPLATE);
+    }
+    inline void setScalar()
+    {
+        setFlag(SCALAR);
+    }
+    inline bool isPureAbstract() const
+    {
+        return hasFlag(PURE_ABSTRACT);
+    }
+    inline bool isMultiInheritance() const
+    {
+        return hasFlag(MULTI_INHERITANCE);
+    }
+    inline bool isTemplate() const
+    {
+        return hasFlag(TEMPLATE);
+    }
+    inline bool isScalar() const
+    {
+        return hasFlag(SCALAR);
+    }
+    //@}
+
+    void addTypedef(const DIDerivedType *diTypedef)
+    {
+        typedefs.insert(diTypedef);
+    }
+
+    const Set<const DIDerivedType *> &getTypedefs(void) const
+    {
+        return typedefs;
+    }
+
+    void setVTable(const GlobalObjVar *vtbl)
+    {
+        vtable = vtbl;
+    }
+
+    const GlobalObjVar *getVTable() const
+    {
+        return vtable;
+    }
+
+    /// Returns the vector of virtual function vectors.
+    const std::vector<std::vector<const Function* >> &getVfnVectors(void) const
+    {
+        return vfnVectors;
+    }
+
+    /// Return the nth virtual function vector in the vtable.
+    std::vector<const Function* > &getVfnVector(unsigned n)
+    {
+        if (vfnVectors.size() < n + 1)
+        {
+            vfnVectors.resize(n + 1);
+        }
+
+        return vfnVectors[n];
+    }
+
+private:
+    /// Type of this node.
+    const DIType *diType;
+    /// Typedefs which map to this type.
+    Set<const DIDerivedType *> typedefs;
+    const GlobalObjVar* vtable;
+    std::string typeName;
+    size_t flags;
+    /// The virtual functions which this class actually defines/overrides.
+    std::vector<const Function* > primaryVTable;
+    /// If a vtable is split into more than one vfn vector for multiple inheritance,
+    /// 0 would be the primary base + this classes virtual functions, 1 would be
+    /// the second parent, 2 would be third parent, etc.
+    std::vector<std::vector<const Function*>> vfnVectors;
+};
+
+/// Dwarf based CHG.
+class DCHGraph :
+    public CommonCHGraph, public GenericGraph<DCHNode, DCHEdge>
+{
+public:
+    /// Returns the DIType beneath the qualifiers. Does not strip away "DW_TAG_members".
+    static const DIType* stripQualifiers(const DIType*);
+
+    /// Returns the DIType beneath all qualifiers and arrays.
+    static const DIType* stripArray(const DIType*);
+
+    /// Returns true if t1 and t2 are equivalent, ignoring qualifiers.
+    /// For equality...
+    ///  Tags always need to be equal.
+    ///   DIBasicType:      shallow pointer equality.
+    ///   DIDerivedType:    base types (teq).
+    ///   DICompositeType:  shallow pointer equality.
+    ///   DISubroutineType: shallow pointer equality.
+    static bool teq(const DIType* t1, const DIType* t2);
+
+    /// Returns a human-readable version of the DIType.
+    static std::string diTypeToStr(const DIType *);
+
+    // Returns whether t is an array, a struct, a class, a union, or neither.
+    static bool isAgg(const DIType* t);
+
+public:
+    DCHGraph()
+        :numTypes(0)   // vfID(0), buildingCHGTime(0) {
+    {
+        this->kind = DI;
+    }
+
+    virtual ~DCHGraph() { };
+
+    /// Builds the CHG from DWARF debug information. extend determines
+    /// whether to extend the CHG with first field edges.
+    virtual void buildCHG(bool extend);
+
+    void dump(const std::string& filename)
+    {
+        GraphPrinter::WriteGraphToFile(SVFUtil::outs(), filename, this);
+    }
+
+    void print(void);
+
+    virtual bool csHasVFnsBasedonCHA(const CallICFGNode* cs) override
+    {
+        return csHasVtblsBasedonCHA(cs);
+    }
+
+    virtual const VFunSet &getCSVFsBasedonCHA(const CallICFGNode* cs) override;
+
+    virtual bool csHasVtblsBasedonCHA(CallBase* cs)
+    {
+        assert(false && "not supported");
+        const DIType *type = getCanonicalType(getCSStaticType(cs));
+        if (!hasNode(type))
+        {
+            return false;
+        }
+
+        return getNode(type)->getVTable() != nullptr;
+    }
+
+    virtual bool csHasVtblsBasedonCHA(const CallICFGNode* cs) override
+    {
+        assert(false && "not supported!");
+        abort();
+    }
+
+    virtual const VTableSet &getCSVtblsBasedonCHA(const CallICFGNode* cs) override;
+    virtual void getVFnsFromVtbls(const CallICFGNode* cs, const VTableSet &vtbls, VFunSet &virtualFunctions) override;
+
+    /// Returns true if a is a transitive base of b. firstField determines
+    /// whether to consider first-field edges.
+    virtual bool isBase(const DIType *a, const DIType *b, bool firstField);
+
+    /// Returns true if f is a field of b (fields from getFieldTypes).
+    virtual bool isFieldOf(const DIType *f, const DIType *b);
+
+    static inline bool classof(const CommonCHGraph *chg)
+    {
+        return chg->getKind() == DI;
+    }
+
+    /// Returns the type representing all qualifier-variations of t.
+    /// This should only matter in the case of DerivedTypes where
+    /// qualifiers and have qualified base types cause a mess.
+    const DIType* getCanonicalType(const DIType* t);
+
+    /// Returns the type of field number idx (flattened) in base.
+    const DIType *getFieldType(const DIType *base, unsigned idx)
+    {
+        base = getCanonicalType(base);
+        if (base == nullptr)
+        {
+            // Conservative; the base object is untyped, sadly.
+            return nullptr;
+        }
+
+        // For TBHC this is conservative because the union type is lower in the DCHG
+        // than its fields. TODO: make more precise.
+        if (base->getTag() == dwarf::DW_TAG_union_type)
+        {
+            return base;
+        }
+
+        if (base->getTag() == dwarf::DW_TAG_array_type)
+        {
+            const DICompositeType* cbase =
+                SVFUtil::dyn_cast<DICompositeType>(base);
+            assert(cbase && "DCHG: bad DIComposite case");
+            return cbase->getBaseType();
+        }
+
+        if (!(base->getTag() == dwarf::DW_TAG_class_type ||
+                base->getTag() == dwarf::DW_TAG_structure_type))
+        {
+            return nullptr;
+        }
+
+        assert(fieldTypes.find(base) != fieldTypes.end() && "DCHG: base not flattened!");
+        std::vector<const DIType *> &fields = fieldTypes[base];
+        assert(fields.size() > idx && "DCHG: idx into struct larger than # fields!");
+        return getCanonicalType(fields[idx]);
+    }
+
+    /// Returns a vector of the types of all fields in base.
+    const std::vector<const DIType *> &getFieldTypes(const DIType *base)
+    {
+        base = getCanonicalType(base);
+        assert(fieldTypes.find(base) != fieldTypes.end() && "DCHG: base not flattened!");
+        return fieldTypes[base];
+    }
+
+    // Returns the number of fields in base (length of getFieldTypes).
+    unsigned getNumFields(const DIType *base)
+    {
+        base = getCanonicalType(base);
+        assert(fieldTypes.find(base) != fieldTypes.end() && "DCHG: base not flattened!");
+        return fieldTypes[base].size();
+    }
+
+    /// Returns all the aggregates contained (transitively) in base.
+    const Set<const DIType *> &getAggs(const DIType *base)
+    {
+        base = getCanonicalType(base);
+        assert(containingAggs.find(base) != containingAggs.end() && "DCHG: aggregates not gathered for base!");
+        return containingAggs[base];
+    }
+
+    bool isFirstField(const DIType* f, const DIType* b);
+
+protected:
+    /// Whether this CHG is an extended CHG (first-field). Set by buildCHG.
+    bool extended = false;
+    /// Maps DITypes to their nodes.
+    Map<const DIType*, DCHNode*> diTypeToNodeMap;
+    /// Maps VTables to the DIType associated with them.
+    Map<const GlobalObjVar*, const DIType*> vtblToTypeMap;
+    /// Maps types to all children (i.e. CHA).
+    Map<const DIType*, NodeBS> chaMap;
+    /// Maps types to all children but also considering first field.
+    Map<const DIType*, NodeBS> chaFFMap;
+    /// Maps types to a set with their vtable and all their children's.
+    Map<const DIType*, VTableSet> vtblCHAMap;
+    /// Maps callsites to a set of potential virtual functions based on CHA.
+    Map<const CallICFGNode*, VFunSet> csCHAMap;
+    /// Maps types to their canonical type (many-to-one).
+    Map<const DIType*, const DIType*> canonicalTypeMap;
+    /// Set of all possible canonical types (i.e. values of canonicalTypeMap).
+    Set<const DIType*> canonicalTypes;
+    /// Maps types to their flattened fields' types.
+    Map<const DIType*, std::vector<const DIType*>> fieldTypes;
+    /// Maps aggregate types to all the aggregate types it transitively contains.
+    Map<const DIType*, Set<const DIType*>> containingAggs;
+
+private:
+    /// Construction helper to process DIBasicTypes.
+    void handleDIBasicType(const DIBasicType* basicType);
+    /// Construction helper to process DICompositeTypes.
+    void handleDICompositeType(const DICompositeType* compositeType);
+    /// Construction helper to process DIDerivedTypes.
+    void handleDIDerivedType(const DIDerivedType* derivedType);
+    /// Construction helper to process DISubroutineTypes.
+    void handleDISubroutineType(const DISubroutineType* subroutineType);
+
+    /// Finds all defined virtual functions and attaches them to nodes.
+    void buildVTables();
+
+    /// Returns a set of all children of type (CHA). Also gradually builds chaMap.
+    const NodeBS& cha(const DIType* type, bool firstField);
+
+    /// Attaches the typedef(s) to the base node.
+    void handleTypedef(const DIType* typedefType);
+
+    /// Populates fieldTypes for type and all its elements.
+    void flatten(const DICompositeType* type);
+
+    /// Populates containingAggs for type and all its elements.
+    void gatherAggs(const DICompositeType* type);
+
+    /// Creates a node from type, or returns it if it exists.
+    DCHNode* getOrCreateNode(const DIType* type);
+
+    /// Retrieves the metadata associated with a *virtual* callsite.
+    const DIType* getCSStaticType(CallBase* cs) const;
+
+    const DIType *getCSStaticType(const CallICFGNode* cs) const
+    {
+        assert(false && "not supported!");
+        abort();
+    }
+
+    /// Checks if a node exists for type.
+    bool hasNode(const DIType* type)
+    {
+        type = getCanonicalType(type);
+        return diTypeToNodeMap.find(type) != diTypeToNodeMap.end();
+    }
+
+    /// Returns the node for type (nullptr if it doesn't exist).
+    DCHNode* getNode(const DIType* type)
+    {
+        type = getCanonicalType(type);
+        if (hasNode(type))
+        {
+            return diTypeToNodeMap.at(type);
+        }
+
+        return nullptr;
+    }
+
+
+    /// Creates an edge between from t1 to t2.
+    DCHEdge* addEdge(const DIType* t1, const DIType* t2, DCHEdge::GEdgeKind et);
+    /// Returns the edge between t1 and t2 if it exists, returns nullptr otherwise.
+    DCHEdge* hasEdge(const DIType* t1, const DIType* t2, DCHEdge::GEdgeKind et);
+
+    /// Number of types (nodes) in the graph.
+    NodeID numTypes;
+};
+
+} // End namespace SVF
+
+namespace SVF
+{
+/* !
+ * GenericGraphTraits specializations for generic graph algorithms.
+ * Provide graph traits for traversing from a constraint node using standard graph traversals.
+ */
+template<> struct GenericGraphTraits<SVF::DCHNode*> : public GenericGraphTraits<SVF::GenericNode<SVF::DCHNode,SVF::DCHEdge>*  >
+{
+};
+
+/// Inverse GenericGraphTraits specializations for call graph node, it is used for inverse traversal.
+template<>
+struct GenericGraphTraits<Inverse<SVF::DCHNode*> > : public GenericGraphTraits<Inverse<SVF::GenericNode<SVF::DCHNode,SVF::DCHEdge>* > >
+{
+};
+
+template<> struct GenericGraphTraits<SVF::DCHGraph*> : public GenericGraphTraits<SVF::GenericGraph<SVF::DCHNode,SVF::DCHEdge>* >
+{
+    typedef SVF::DCHNode *NodeRef;
+};
+
+} // End namespace llvm
+
+#endif /* DCHG_H_ */

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

@@ -0,0 +1,183 @@
+// GEPTypeBridgeIterator
+//
+//
+#ifndef SVF_GEPTYPEBRIDGEITERATOR_H
+#define SVF_GEPTYPEBRIDGEITERATOR_H
+
+#include "llvm/IR/DerivedTypes.h"
+#include "llvm/IR/Operator.h"
+#include "llvm/IR/User.h"
+#include "llvm/ADT/PointerIntPair.h"
+#include "llvm/IR/GetElementPtrTypeIterator.h"
+
+namespace llvm
+{
+
+template<typename ItTy = User::const_op_iterator>
+class generic_bridge_gep_type_iterator : public std::iterator<std::forward_iterator_tag, Type*, ptrdiff_t>
+{
+
+    typedef std::iterator<std::forward_iterator_tag,Type*, ptrdiff_t> super;
+    ItTy OpIt;
+    PointerIntPair<Type*,1> CurTy;
+    unsigned AddrSpace;
+    generic_bridge_gep_type_iterator() {}
+public:
+
+    static generic_bridge_gep_type_iterator begin(Type* Ty, ItTy It)
+    {
+        generic_bridge_gep_type_iterator I;
+        I.CurTy.setPointer(Ty);
+        I.OpIt = It;
+        return I;
+    }
+
+    static generic_bridge_gep_type_iterator begin(Type* Ty, unsigned AddrSpace,
+            ItTy It)
+    {
+        generic_bridge_gep_type_iterator I;
+        I.CurTy.setPointer(Ty);
+        I.CurTy.setInt(true);
+        I.AddrSpace = AddrSpace;
+        I.OpIt = It;
+        return I;
+    }
+
+    static generic_bridge_gep_type_iterator end(ItTy It)
+    {
+        generic_bridge_gep_type_iterator I;
+        I.OpIt = It;
+        return I;
+    }
+
+    bool operator==(const generic_bridge_gep_type_iterator& x) const
+    {
+        return OpIt == x.OpIt;
+    }
+
+    bool operator!=(const generic_bridge_gep_type_iterator& x) const
+    {
+        return !operator==(x);
+    }
+
+    Type* operator*() const
+    {
+        if ( CurTy.getInt() )
+            return CurTy.getPointer()->getPointerTo(AddrSpace);
+        return CurTy.getPointer();
+    }
+
+    Type* getIndexedType() const
+    {
+        assert(false && "needs to be refactored");
+        if ( CurTy.getInt() )
+            return CurTy.getPointer();
+#if LLVM_VERSION_MAJOR >= 11
+        Type*  CT = CurTy.getPointer();
+        if (auto ST = dyn_cast<StructType>(CT))
+            return ST->getTypeAtIndex(getOperand());
+        else if (auto Array = dyn_cast<ArrayType>(CT))
+            return Array->getElementType();
+        else if (auto Vector = dyn_cast<VectorType>(CT))
+            return Vector->getElementType();
+        else
+            return CT;
+#else
+        CompositeType *CT = llvm::cast<CompositeType>( CurTy.getPointer() );
+        return CT->getTypeAtIndex(getOperand());
+#endif
+    }
+
+    // non-standard operators, these may not need be bridged but seems it's
+    // prudent to do so...
+    Type* operator->() const
+    {
+        return operator*();
+    }
+
+    Value* getOperand() const
+    {
+        return const_cast<Value*>(&**OpIt);
+    }
+
+
+    generic_bridge_gep_type_iterator& operator++()
+    {
+        if ( CurTy.getInt() )
+        {
+            CurTy.setInt(false);
+        }
+#if LLVM_VERSION_MAJOR >= 11
+        else if ( Type*  CT = CurTy.getPointer() )
+        {
+            if (auto ST = dyn_cast<StructType>(CT))
+                CurTy.setPointer(ST->getTypeAtIndex(getOperand()));
+            else if (auto Array = dyn_cast<ArrayType>(CT))
+                CurTy.setPointer(Array->getElementType());
+            else if (auto Vector = dyn_cast<VectorType>(CT))
+                CurTy.setPointer(Vector->getElementType());
+            else
+                CurTy.setPointer(nullptr);
+        }
+#else
+        else if ( CompositeType * CT = dyn_cast<CompositeType>(CurTy.getPointer()) )
+        {
+            CurTy.setPointer(CT->getTypeAtIndex(getOperand()));
+        }
+#endif
+        else
+        {
+            CurTy.setPointer(nullptr);
+        }
+        ++OpIt;
+        return *this;
+    }
+
+
+    generic_bridge_gep_type_iterator operator++(int)
+    {
+        generic_bridge_gep_type_iterator tmp = *this;
+        ++*this;
+        return tmp;
+    }
+
+};
+
+
+typedef generic_bridge_gep_type_iterator<> bridge_gep_iterator;
+
+inline bridge_gep_iterator bridge_gep_begin(const User* GEP)
+{
+    auto *GEPOp = llvm::cast<GEPOperator>(GEP);
+    return bridge_gep_iterator::begin(GEPOp->getSourceElementType(),
+                                      llvm::cast<PointerType>(GEPOp->getPointerOperandType()->getScalarType())->getAddressSpace(),
+                                      GEP->op_begin() + 1);
+}
+
+inline bridge_gep_iterator bridge_gep_end(const User* GEP)
+{
+    return bridge_gep_iterator::end(GEP->op_end());
+}
+
+inline bridge_gep_iterator bridge_gep_begin(const User &GEP)
+{
+    auto &GEPOp = llvm::cast<GEPOperator>(GEP);
+    return bridge_gep_iterator::begin( GEPOp.getSourceElementType(),
+                                       llvm::cast<PointerType>(GEPOp.getPointerOperandType()->getScalarType())->getAddressSpace(),
+                                       GEP.op_begin() + 1);
+}
+
+inline bridge_gep_iterator bridge_gep_end(const User &GEP)
+{
+    return bridge_gep_iterator::end(GEP.op_end());
+}
+
+template<typename T>
+inline generic_bridge_gep_type_iterator<const T*> bridge_gep_end( Type*  /*Op0*/, ArrayRef<T> A )
+{
+    return generic_bridge_gep_type_iterator<const T*>::end(A.end());
+}
+
+} // End namespace llvm
+
+#endif