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