lib/VMCore/LLVMContextImpl.h

   1 //===-- LLVMContextImpl.h - The LLVMContextImpl opaque class ----*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 //  This file declares LLVMContextImpl, the opaque implementation
  11 //  of LLVMContext.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_LLVMCONTEXT_IMPL_H
  16 #define LLVM_LLVMCONTEXT_IMPL_H
  17
  18 #include "ConstantsContext.h"
  19 #include "LeaksContext.h"
  20 #include "TypesContext.h"
  21 #include "llvm/LLVMContext.h"
  22 #include "llvm/Constants.h"
  23 #include "llvm/DerivedTypes.h"
  24 #include "llvm/Metadata.h"
  25 #include "llvm/Assembly/Writer.h"
  26 #include "llvm/Support/ValueHandle.h"
  27 #include "llvm/ADT/APFloat.h"
  28 #include "llvm/ADT/APInt.h"
  29 #include "llvm/ADT/DenseMap.h"
  30 #include "llvm/ADT/FoldingSet.h"
  31 #include "llvm/ADT/SmallPtrSet.h"
  32 #include "llvm/ADT/StringMap.h"
  33 #include <vector>
  34
  35 namespace llvm {
  36
  37 class ConstantInt;
  38 class ConstantFP;
  39 class LLVMContext;
  40 class Type;
  41 class Value;
  42
  43 struct DenseMapAPIntKeyInfo {
  44   struct KeyTy {
  45     APInt val;
  46     const Type* type;
  47     KeyTy(const APInt& V, const Type* Ty) : val(V), type(Ty) {}
  48     KeyTy(const KeyTy& that) : val(that.val), type(that.type) {}
  49     bool operator==(const KeyTy& that) const {
  50       return type == that.type && this->val == that.val;
  51     }
  52     bool operator!=(const KeyTy& that) const {
  53       return !this->operator==(that);
  54     }
  55   };
  56   static inline KeyTy getEmptyKey() { return KeyTy(APInt(1,0), 0); }
  57   static inline KeyTy getTombstoneKey() { return KeyTy(APInt(1,1), 0); }
  58   static unsigned getHashValue(const KeyTy &Key) {
  59     return DenseMapInfo<void*>::getHashValue(Key.type) ^
  60       Key.val.getHashValue();
  61   }
  62   static bool isEqual(const KeyTy &LHS, const KeyTy &RHS) {
  63     return LHS == RHS;
  64   }
  65 };
  66
  67 struct DenseMapAPFloatKeyInfo {
  68   struct KeyTy {
  69     APFloat val;
  70     KeyTy(const APFloat& V) : val(V){}
  71     KeyTy(const KeyTy& that) : val(that.val) {}
  72     bool operator==(const KeyTy& that) const {
  73       return this->val.bitwiseIsEqual(that.val);
  74     }
  75     bool operator!=(const KeyTy& that) const {
  76       return !this->operator==(that);
  77     }
  78   };
  79   static inline KeyTy getEmptyKey() {
  80     return KeyTy(APFloat(APFloat::Bogus,1));
  81   }
  82   static inline KeyTy getTombstoneKey() {
  83     return KeyTy(APFloat(APFloat::Bogus,2));
  84   }
  85   static unsigned getHashValue(const KeyTy &Key) {
  86     return Key.val.getHashValue();
  87   }
  88   static bool isEqual(const KeyTy &LHS, const KeyTy &RHS) {
  89     return LHS == RHS;
  90   }
  91 };
  92
  93 /// DebugRecVH - This is a CallbackVH used to keep the Scope -> index maps
  94 /// up to date as MDNodes mutate.  This class is implemented in DebugLoc.cpp.
  95 class DebugRecVH : public CallbackVH {
  96   /// Ctx - This is the LLVM Context being referenced.
  97   LLVMContextImpl *Ctx;
  98
  99   /// Idx - The index into either ScopeRecordIdx or ScopeInlinedAtRecords that
 100   /// this reference lives in.  If this is zero, then it represents a
 101   /// non-canonical entry that has no DenseMap value.  This can happen due to
 102   /// RAUW.
 103   int Idx;
 104 public:
 105   DebugRecVH(MDNode *n, LLVMContextImpl *ctx, int idx)
 106     : CallbackVH(n), Ctx(ctx), Idx(idx) {}
 107
 108   MDNode *get() const {
 109     return cast_or_null<MDNode>(getValPtr());
 110   }
 111
 112   virtual void deleted();
 113   virtual void allUsesReplacedWith(Value *VNew);
 114 };
 115
 116 class LLVMContextImpl {
 117 public:
 118   typedef DenseMap<DenseMapAPIntKeyInfo::KeyTy, ConstantInt*,
 119                          DenseMapAPIntKeyInfo> IntMapTy;
 120   IntMapTy IntConstants;
 121
 122   typedef DenseMap<DenseMapAPFloatKeyInfo::KeyTy, ConstantFP*,
 123                          DenseMapAPFloatKeyInfo> FPMapTy;
 124   FPMapTy FPConstants;
 125
 126   StringMap<MDString*> MDStringCache;
 127
 128   FoldingSet<MDNode> MDNodeSet;
 129   // MDNodes may be uniqued or not uniqued.  When they're not uniqued, they
 130   // aren't in the MDNodeSet, but they're still shared between objects, so no
 131   // one object can destroy them.  This set allows us to at least destroy them
 132   // on Context destruction.
 133   SmallPtrSet<MDNode*, 1> NonUniquedMDNodes;
 134
 135   ConstantUniqueMap<char, Type, ConstantAggregateZero> AggZeroConstants;
 136
 137   typedef ConstantUniqueMap<std::vector<Constant*>, ArrayType,
 138     ConstantArray, true /*largekey*/> ArrayConstantsTy;
 139   ArrayConstantsTy ArrayConstants;
 140
 141   typedef ConstantUniqueMap<std::vector<Constant*>, StructType,
 142     ConstantStruct, true /*largekey*/> StructConstantsTy;
 143   StructConstantsTy StructConstants;
 144
 145   typedef ConstantUniqueMap<Constant*, UnionType, ConstantUnion>
 146       UnionConstantsTy;
 147   UnionConstantsTy UnionConstants;
 148
 149   typedef ConstantUniqueMap<std::vector<Constant*>, VectorType,
 150                             ConstantVector> VectorConstantsTy;
 151   VectorConstantsTy VectorConstants;
 152
 153   ConstantUniqueMap<char, PointerType, ConstantPointerNull> NullPtrConstants;
 154   ConstantUniqueMap<char, Type, UndefValue> UndefValueConstants;
 155
 156   DenseMap<std::pair<Function*, BasicBlock*> , BlockAddress*> BlockAddresses;
 157   ConstantUniqueMap<ExprMapKeyType, Type, ConstantExpr> ExprConstants;
 158
 159   ConstantUniqueMap<InlineAsmKeyType, PointerType, InlineAsm> InlineAsms;
 160
 161   ConstantInt *TheTrueVal;
 162   ConstantInt *TheFalseVal;
 163
 164   LeakDetectorImpl<Value> LLVMObjects;
 165
 166   // Basic type instances.
 167   const Type VoidTy;
 168   const Type LabelTy;
 169   const Type FloatTy;
 170   const Type DoubleTy;
 171   const Type MetadataTy;
 172   const Type X86_FP80Ty;
 173   const Type FP128Ty;
 174   const Type PPC_FP128Ty;
 175   const IntegerType Int1Ty;
 176   const IntegerType Int8Ty;
 177   const IntegerType Int16Ty;
 178   const IntegerType Int32Ty;
 179   const IntegerType Int64Ty;
 180
 181   // Concrete/Abstract TypeDescriptions - We lazily calculate type descriptions
 182   // for types as they are needed.  Because resolution of types must invalidate
 183   // all of the abstract type descriptions, we keep them in a seperate map to
 184   // make this easy.
 185   TypePrinting ConcreteTypeDescriptions;
 186   TypePrinting AbstractTypeDescriptions;
 187
 188   TypeMap<ArrayValType, ArrayType> ArrayTypes;
 189   TypeMap<VectorValType, VectorType> VectorTypes;
 190   TypeMap<PointerValType, PointerType> PointerTypes;
 191   TypeMap<FunctionValType, FunctionType> FunctionTypes;
 192   TypeMap<StructValType, StructType> StructTypes;
 193   TypeMap<UnionValType, UnionType> UnionTypes;
 194   TypeMap<IntegerValType, IntegerType> IntegerTypes;
 195
 196   // Opaque types are not structurally uniqued, so don't use TypeMap.
 197   typedef SmallPtrSet<const OpaqueType*, 8> OpaqueTypesTy;
 198   OpaqueTypesTy OpaqueTypes;
 199
 200   /// Used as an abstract type that will never be resolved.
 201   OpaqueType *const AlwaysOpaqueTy;
 202
 203
 204   /// ValueHandles - This map keeps track of all of the value handles that are
 205   /// watching a Value*.  The Value::HasValueHandle bit is used to know
 206   // whether or not a value has an entry in this map.
 207   typedef DenseMap<Value*, ValueHandleBase*> ValueHandlesTy;
 208   ValueHandlesTy ValueHandles;
 209
 210   /// CustomMDKindNames - Map to hold the metadata string to ID mapping.
 211   StringMap<unsigned> CustomMDKindNames;
 212
 213   typedef std::pair<unsigned, TrackingVH<MDNode> > MDPairTy;
 214   typedef SmallVector<MDPairTy, 2> MDMapTy;
 215
 216   /// MetadataStore - Collection of per-instruction metadata used in this
 217   /// context.
 218   DenseMap<const Instruction *, MDMapTy> MetadataStore;
 219
 220   /// ScopeRecordIdx - This is the index in ScopeRecords for an MDNode scope
 221   /// entry with no "inlined at" element.
 222   DenseMap<MDNode*, int> ScopeRecordIdx;
 223
 224   /// ScopeRecords - These are the actual mdnodes (in a value handle) for an
 225   /// index.  The ValueHandle ensures that ScopeRecordIdx stays up to date if
 226   /// the MDNode is RAUW'd.
 227   std::vector<DebugRecVH> ScopeRecords;
 228
 229   /// ScopeInlinedAtIdx - This is the index in ScopeInlinedAtRecords for an
 230   /// scope/inlined-at pair.
 231   DenseMap<std::pair<MDNode*, MDNode*>, int> ScopeInlinedAtIdx;
 232
 233   /// ScopeInlinedAtRecords - These are the actual mdnodes (in value handles)
 234   /// for an index.  The ValueHandle ensures that ScopeINlinedAtIdx stays up
 235   /// to date.
 236   std::vector<std::pair<DebugRecVH, DebugRecVH> > ScopeInlinedAtRecords;
 237
 238   int getOrAddScopeRecordIdxEntry(MDNode *N, int ExistingIdx);
 239   int getOrAddScopeInlinedAtIdxEntry(MDNode *Scope, MDNode *IA,int ExistingIdx);
 240
 241   LLVMContextImpl(LLVMContext &C);
 242   ~LLVMContextImpl();
 243 };
 244
 245 }
 246
 247 #endif