lib/IR/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_LIB_IR_LLVMCONTEXTIMPL_H
  16 #define LLVM_LIB_IR_LLVMCONTEXTIMPL_H
  17
  18 #include "AttributeImpl.h"
  19 #include "ConstantsContext.h"
  20 #include "LeaksContext.h"
  21 #include "llvm/ADT/APFloat.h"
  22 #include "llvm/ADT/APInt.h"
  23 #include "llvm/ADT/ArrayRef.h"
  24 #include "llvm/ADT/DenseMap.h"
  25 #include "llvm/ADT/DenseSet.h"
  26 #include "llvm/ADT/FoldingSet.h"
  27 #include "llvm/ADT/Hashing.h"
  28 #include "llvm/ADT/SmallPtrSet.h"
  29 #include "llvm/ADT/StringMap.h"
  30 #include "llvm/IR/Constants.h"
  31 #include "llvm/IR/DerivedTypes.h"
  32 #include "llvm/IR/LLVMContext.h"
  33 #include "llvm/IR/Metadata.h"
  34 #include "llvm/IR/ValueHandle.h"
  35 #include <vector>
  36
  37 namespace llvm {
  38
  39 class ConstantInt;
  40 class ConstantFP;
  41 class DiagnosticInfoOptimizationRemark;
  42 class DiagnosticInfoOptimizationRemarkMissed;
  43 class DiagnosticInfoOptimizationRemarkAnalysis;
  44 class LLVMContext;
  45 class Type;
  46 class Value;
  47
  48 struct DenseMapAPIntKeyInfo {
  49   struct KeyTy {
  50     APInt val;
  51     Type* type;
  52     KeyTy(const APInt& V, Type* Ty) : val(V), type(Ty) {}
  53     bool operator==(const KeyTy& that) const {
  54       return type == that.type && this->val == that.val;
  55     }
  56     bool operator!=(const KeyTy& that) const {
  57       return !this->operator==(that);
  58     }
  59     friend hash_code hash_value(const KeyTy &Key) {
  60       return hash_combine(Key.type, Key.val);
  61     }
  62   };
  63   static inline KeyTy getEmptyKey() { return KeyTy(APInt(1,0), nullptr); }
  64   static inline KeyTy getTombstoneKey() { return KeyTy(APInt(1,1), nullptr); }
  65   static unsigned getHashValue(const KeyTy &Key) {
  66     return static_cast<unsigned>(hash_value(Key));
  67   }
  68   static bool isEqual(const KeyTy &LHS, const KeyTy &RHS) {
  69     return LHS == RHS;
  70   }
  71 };
  72
  73 struct DenseMapAPFloatKeyInfo {
  74   struct KeyTy {
  75     APFloat val;
  76     KeyTy(const APFloat& V) : val(V){}
  77     bool operator==(const KeyTy& that) const {
  78       return this->val.bitwiseIsEqual(that.val);
  79     }
  80     bool operator!=(const KeyTy& that) const {
  81       return !this->operator==(that);
  82     }
  83     friend hash_code hash_value(const KeyTy &Key) {
  84       return hash_combine(Key.val);
  85     }
  86   };
  87   static inline KeyTy getEmptyKey() {
  88     return KeyTy(APFloat(APFloat::Bogus,1));
  89   }
  90   static inline KeyTy getTombstoneKey() {
  91     return KeyTy(APFloat(APFloat::Bogus,2));
  92   }
  93   static unsigned getHashValue(const KeyTy &Key) {
  94     return static_cast<unsigned>(hash_value(Key));
  95   }
  96   static bool isEqual(const KeyTy &LHS, const KeyTy &RHS) {
  97     return LHS == RHS;
  98   }
  99 };
 100
 101 struct AnonStructTypeKeyInfo {
 102   struct KeyTy {
 103     ArrayRef<Type*> ETypes;
 104     bool isPacked;
 105     KeyTy(const ArrayRef<Type*>& E, bool P) :
 106       ETypes(E), isPacked(P) {}
 107     KeyTy(const StructType* ST) :
 108       ETypes(ArrayRef<Type*>(ST->element_begin(), ST->element_end())),
 109       isPacked(ST->isPacked()) {}
 110     bool operator==(const KeyTy& that) const {
 111       if (isPacked != that.isPacked)
 112         return false;
 113       if (ETypes != that.ETypes)
 114         return false;
 115       return true;
 116     }
 117     bool operator!=(const KeyTy& that) const {
 118       return !this->operator==(that);
 119     }
 120   };
 121   static inline StructType* getEmptyKey() {
 122     return DenseMapInfo<StructType*>::getEmptyKey();
 123   }
 124   static inline StructType* getTombstoneKey() {
 125     return DenseMapInfo<StructType*>::getTombstoneKey();
 126   }
 127   static unsigned getHashValue(const KeyTy& Key) {
 128     return hash_combine(hash_combine_range(Key.ETypes.begin(),
 129                                            Key.ETypes.end()),
 130                         Key.isPacked);
 131   }
 132   static unsigned getHashValue(const StructType *ST) {
 133     return getHashValue(KeyTy(ST));
 134   }
 135   static bool isEqual(const KeyTy& LHS, const StructType *RHS) {
 136     if (RHS == getEmptyKey() || RHS == getTombstoneKey())
 137       return false;
 138     return LHS == KeyTy(RHS);
 139   }
 140   static bool isEqual(const StructType *LHS, const StructType *RHS) {
 141     return LHS == RHS;
 142   }
 143 };
 144
 145 struct FunctionTypeKeyInfo {
 146   struct KeyTy {
 147     const Type *ReturnType;
 148     ArrayRef<Type*> Params;
 149     bool isVarArg;
 150     KeyTy(const Type* R, const ArrayRef<Type*>& P, bool V) :
 151       ReturnType(R), Params(P), isVarArg(V) {}
 152     KeyTy(const FunctionType* FT) :
 153       ReturnType(FT->getReturnType()),
 154       Params(makeArrayRef(FT->param_begin(), FT->param_end())),
 155       isVarArg(FT->isVarArg()) {}
 156     bool operator==(const KeyTy& that) const {
 157       if (ReturnType != that.ReturnType)
 158         return false;
 159       if (isVarArg != that.isVarArg)
 160         return false;
 161       if (Params != that.Params)
 162         return false;
 163       return true;
 164     }
 165     bool operator!=(const KeyTy& that) const {
 166       return !this->operator==(that);
 167     }
 168   };
 169   static inline FunctionType* getEmptyKey() {
 170     return DenseMapInfo<FunctionType*>::getEmptyKey();
 171   }
 172   static inline FunctionType* getTombstoneKey() {
 173     return DenseMapInfo<FunctionType*>::getTombstoneKey();
 174   }
 175   static unsigned getHashValue(const KeyTy& Key) {
 176     return hash_combine(Key.ReturnType,
 177                         hash_combine_range(Key.Params.begin(),
 178                                            Key.Params.end()),
 179                         Key.isVarArg);
 180   }
 181   static unsigned getHashValue(const FunctionType *FT) {
 182     return getHashValue(KeyTy(FT));
 183   }
 184   static bool isEqual(const KeyTy& LHS, const FunctionType *RHS) {
 185     if (RHS == getEmptyKey() || RHS == getTombstoneKey())
 186       return false;
 187     return LHS == KeyTy(RHS);
 188   }
 189   static bool isEqual(const FunctionType *LHS, const FunctionType *RHS) {
 190     return LHS == RHS;
 191   }
 192 };
 193
 194 /// \brief DenseMapInfo for GenericMDNode.
 195 ///
 196 /// Note that we don't need the is-function-local bit, since that's implicit in
 197 /// the operands.
 198 struct GenericMDNodeInfo {
 199   struct KeyTy {
 200     ArrayRef<Value *> Ops;
 201     unsigned Hash;
 202
 203     KeyTy(ArrayRef<Value *> Ops)
 204         : Ops(Ops), Hash(hash_combine_range(Ops.begin(), Ops.end())) {}
 205
 206     KeyTy(GenericMDNode *N, SmallVectorImpl<Value *> &Storage) {
 207       Storage.resize(N->getNumOperands());
 208       for (unsigned I = 0, E = N->getNumOperands(); I != E; ++I)
 209         Storage[I] = N->getOperand(I);
 210       Ops = Storage;
 211       Hash = hash_combine_range(Ops.begin(), Ops.end());
 212     }
 213
 214     bool operator==(const GenericMDNode *RHS) const {
 215       if (RHS == getEmptyKey() || RHS == getTombstoneKey())
 216         return false;
 217       if (Hash != RHS->getHash() || Ops.size() != RHS->getNumOperands())
 218         return false;
 219       for (unsigned I = 0, E = Ops.size(); I != E; ++I)
 220         if (Ops[I] != RHS->getOperand(I))
 221           return false;
 222       return true;
 223     }
 224   };
 225   static inline GenericMDNode *getEmptyKey() {
 226     return DenseMapInfo<GenericMDNode *>::getEmptyKey();
 227   }
 228   static inline GenericMDNode *getTombstoneKey() {
 229     return DenseMapInfo<GenericMDNode *>::getTombstoneKey();
 230   }
 231   static unsigned getHashValue(const KeyTy &Key) { return Key.Hash; }
 232   static unsigned getHashValue(const GenericMDNode *U) {
 233     return U->getHash();
 234   }
 235   static bool isEqual(const KeyTy &LHS, const GenericMDNode *RHS) {
 236     return LHS == RHS;
 237   }
 238   static bool isEqual(const GenericMDNode *LHS, const GenericMDNode *RHS) {
 239     return LHS == RHS;
 240   }
 241 };
 242
 243 /// DebugRecVH - This is a CallbackVH used to keep the Scope -> index maps
 244 /// up to date as MDNodes mutate.  This class is implemented in DebugLoc.cpp.
 245 class DebugRecVH : public CallbackVH {
 246   /// Ctx - This is the LLVM Context being referenced.
 247   LLVMContextImpl *Ctx;
 248
 249   /// Idx - The index into either ScopeRecordIdx or ScopeInlinedAtRecords that
 250   /// this reference lives in.  If this is zero, then it represents a
 251   /// non-canonical entry that has no DenseMap value.  This can happen due to
 252   /// RAUW.
 253   int Idx;
 254 public:
 255   DebugRecVH(MDNode *n, LLVMContextImpl *ctx, int idx)
 256     : CallbackVH(n), Ctx(ctx), Idx(idx) {}
 257
 258   MDNode *get() const {
 259     return cast_or_null<MDNode>(getValPtr());
 260   }
 261
 262   void deleted() override;
 263   void allUsesReplacedWith(Value *VNew) override;
 264 };
 265
 266 class LLVMContextImpl {
 267 public:
 268   /// OwnedModules - The set of modules instantiated in this context, and which
 269   /// will be automatically deleted if this context is deleted.
 270   SmallPtrSet<Module*, 4> OwnedModules;
 271
 272   LLVMContext::InlineAsmDiagHandlerTy InlineAsmDiagHandler;
 273   void *InlineAsmDiagContext;
 274
 275   LLVMContext::DiagnosticHandlerTy DiagnosticHandler;
 276   void *DiagnosticContext;
 277   bool RespectDiagnosticFilters;
 278
 279   LLVMContext::YieldCallbackTy YieldCallback;
 280   void *YieldOpaqueHandle;
 281
 282   typedef DenseMap<DenseMapAPIntKeyInfo::KeyTy, ConstantInt *,
 283                    DenseMapAPIntKeyInfo> IntMapTy;
 284   IntMapTy IntConstants;
 285
 286   typedef DenseMap<DenseMapAPFloatKeyInfo::KeyTy, ConstantFP*,
 287                          DenseMapAPFloatKeyInfo> FPMapTy;
 288   FPMapTy FPConstants;
 289
 290   FoldingSet<AttributeImpl> AttrsSet;
 291   FoldingSet<AttributeSetImpl> AttrsLists;
 292   FoldingSet<AttributeSetNode> AttrsSetNodes;
 293
 294   StringMap<MDString> MDStringCache;
 295
 296   DenseSet<GenericMDNode *, GenericMDNodeInfo> MDNodeSet;
 297
 298   // MDNodes may be uniqued or not uniqued.  When they're not uniqued, they
 299   // aren't in the MDNodeSet, but they're still shared between objects, so no
 300   // one object can destroy them.  This set allows us to at least destroy them
 301   // on Context destruction.
 302   SmallPtrSet<GenericMDNode *, 1> NonUniquedMDNodes;
 303
 304   DenseMap<Type*, ConstantAggregateZero*> CAZConstants;
 305
 306   typedef ConstantUniqueMap<ConstantArray> ArrayConstantsTy;
 307   ArrayConstantsTy ArrayConstants;
 308
 309   typedef ConstantUniqueMap<ConstantStruct> StructConstantsTy;
 310   StructConstantsTy StructConstants;
 311
 312   typedef ConstantUniqueMap<ConstantVector> VectorConstantsTy;
 313   VectorConstantsTy VectorConstants;
 314
 315   DenseMap<PointerType*, ConstantPointerNull*> CPNConstants;
 316
 317   DenseMap<Type*, UndefValue*> UVConstants;
 318
 319   StringMap<ConstantDataSequential*> CDSConstants;
 320
 321   DenseMap<std::pair<const Function *, const BasicBlock *>, BlockAddress *>
 322     BlockAddresses;
 323   ConstantUniqueMap<ConstantExpr> ExprConstants;
 324
 325   ConstantUniqueMap<InlineAsm> InlineAsms;
 326
 327   ConstantInt *TheTrueVal;
 328   ConstantInt *TheFalseVal;
 329
 330   LeakDetectorImpl<Value> LLVMObjects;
 331
 332   // Basic type instances.
 333   Type VoidTy, LabelTy, HalfTy, FloatTy, DoubleTy, MetadataTy;
 334   Type X86_FP80Ty, FP128Ty, PPC_FP128Ty, X86_MMXTy;
 335   IntegerType Int1Ty, Int8Ty, Int16Ty, Int32Ty, Int64Ty;
 336
 337
 338   /// TypeAllocator - All dynamically allocated types are allocated from this.
 339   /// They live forever until the context is torn down.
 340   BumpPtrAllocator TypeAllocator;
 341
 342   DenseMap<unsigned, IntegerType*> IntegerTypes;
 343
 344   typedef DenseMap<FunctionType*, bool, FunctionTypeKeyInfo> FunctionTypeMap;
 345   FunctionTypeMap FunctionTypes;
 346   typedef DenseMap<StructType*, bool, AnonStructTypeKeyInfo> StructTypeMap;
 347   StructTypeMap AnonStructTypes;
 348   StringMap<StructType*> NamedStructTypes;
 349   unsigned NamedStructTypesUniqueID;
 350
 351   DenseMap<std::pair<Type *, uint64_t>, ArrayType*> ArrayTypes;
 352   DenseMap<std::pair<Type *, unsigned>, VectorType*> VectorTypes;
 353   DenseMap<Type*, PointerType*> PointerTypes;  // Pointers in AddrSpace = 0
 354   DenseMap<std::pair<Type*, unsigned>, PointerType*> ASPointerTypes;
 355
 356
 357   /// ValueHandles - This map keeps track of all of the value handles that are
 358   /// watching a Value*.  The Value::HasValueHandle bit is used to know
 359   /// whether or not a value has an entry in this map.
 360   typedef DenseMap<Value*, ValueHandleBase*> ValueHandlesTy;
 361   ValueHandlesTy ValueHandles;
 362
 363   /// CustomMDKindNames - Map to hold the metadata string to ID mapping.
 364   StringMap<unsigned> CustomMDKindNames;
 365
 366   typedef std::pair<unsigned, TrackingVH<MDNode> > MDPairTy;
 367   typedef SmallVector<MDPairTy, 2> MDMapTy;
 368
 369   /// MetadataStore - Collection of per-instruction metadata used in this
 370   /// context.
 371   DenseMap<const Instruction *, MDMapTy> MetadataStore;
 372
 373   /// ScopeRecordIdx - This is the index in ScopeRecords for an MDNode scope
 374   /// entry with no "inlined at" element.
 375   DenseMap<MDNode*, int> ScopeRecordIdx;
 376
 377   /// ScopeRecords - These are the actual mdnodes (in a value handle) for an
 378   /// index.  The ValueHandle ensures that ScopeRecordIdx stays up to date if
 379   /// the MDNode is RAUW'd.
 380   std::vector<DebugRecVH> ScopeRecords;
 381
 382   /// ScopeInlinedAtIdx - This is the index in ScopeInlinedAtRecords for an
 383   /// scope/inlined-at pair.
 384   DenseMap<std::pair<MDNode*, MDNode*>, int> ScopeInlinedAtIdx;
 385
 386   /// ScopeInlinedAtRecords - These are the actual mdnodes (in value handles)
 387   /// for an index.  The ValueHandle ensures that ScopeINlinedAtIdx stays up
 388   /// to date.
 389   std::vector<std::pair<DebugRecVH, DebugRecVH> > ScopeInlinedAtRecords;
 390
 391   /// DiscriminatorTable - This table maps file:line locations to an
 392   /// integer representing the next DWARF path discriminator to assign to
 393   /// instructions in different blocks at the same location.
 394   DenseMap<std::pair<const char *, unsigned>, unsigned> DiscriminatorTable;
 395
 396   /// IntrinsicIDCache - Cache of intrinsic name (string) to numeric ID mappings
 397   /// requested in this context
 398   typedef DenseMap<const Function*, unsigned> IntrinsicIDCacheTy;
 399   IntrinsicIDCacheTy IntrinsicIDCache;
 400
 401   /// \brief Mapping from a function to its prefix data, which is stored as the
 402   /// operand of an unparented ReturnInst so that the prefix data has a Use.
 403   typedef DenseMap<const Function *, ReturnInst *> PrefixDataMapTy;
 404   PrefixDataMapTy PrefixDataMap;
 405
 406   int getOrAddScopeRecordIdxEntry(MDNode *N, int ExistingIdx);
 407   int getOrAddScopeInlinedAtIdxEntry(MDNode *Scope, MDNode *IA,int ExistingIdx);
 408
 409   LLVMContextImpl(LLVMContext &C);
 410   ~LLVMContextImpl();
 411 };
 412
 413 }
 414
 415 #endif