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