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 "llvm/ADT/APFloat.h"
  21 #include "llvm/ADT/APInt.h"
  22 #include "llvm/ADT/ArrayRef.h"
  23 #include "llvm/ADT/DenseMap.h"
  24 #include "llvm/ADT/DenseSet.h"
  25 #include "llvm/ADT/FoldingSet.h"
  26 #include "llvm/ADT/Hashing.h"
  27 #include "llvm/ADT/SmallPtrSet.h"
  28 #include "llvm/ADT/StringMap.h"
  29 #include "llvm/IR/Constants.h"
  30 #include "llvm/IR/DebugInfoMetadata.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 GCStrategy;
  45 class LLVMContext;
  46 class Type;
  47 class Value;
  48
  49 struct DenseMapAPIntKeyInfo {
  50   static inline APInt getEmptyKey() {
  51     APInt V(nullptr, 0);
  52     V.VAL = 0;
  53     return V;
  54   }
  55   static inline APInt getTombstoneKey() {
  56     APInt V(nullptr, 0);
  57     V.VAL = 1;
  58     return V;
  59   }
  60   static unsigned getHashValue(const APInt &Key) {
  61     return static_cast<unsigned>(hash_value(Key));
  62   }
  63   static bool isEqual(const APInt &LHS, const APInt &RHS) {
  64     return LHS.getBitWidth() == RHS.getBitWidth() && LHS == RHS;
  65   }
  66 };
  67
  68 struct DenseMapAPFloatKeyInfo {
  69   static inline APFloat getEmptyKey() { return APFloat(APFloat::Bogus, 1); }
  70   static inline APFloat getTombstoneKey() { return APFloat(APFloat::Bogus, 2); }
  71   static unsigned getHashValue(const APFloat &Key) {
  72     return static_cast<unsigned>(hash_value(Key));
  73   }
  74   static bool isEqual(const APFloat &LHS, const APFloat &RHS) {
  75     return LHS.bitwiseIsEqual(RHS);
  76   }
  77 };
  78
  79 struct AnonStructTypeKeyInfo {
  80   struct KeyTy {
  81     ArrayRef<Type*> ETypes;
  82     bool isPacked;
  83     KeyTy(const ArrayRef<Type*>& E, bool P) :
  84       ETypes(E), isPacked(P) {}
  85     KeyTy(const StructType *ST)
  86         : ETypes(ST->elements()), isPacked(ST->isPacked()) {}
  87     bool operator==(const KeyTy& that) const {
  88       if (isPacked != that.isPacked)
  89         return false;
  90       if (ETypes != that.ETypes)
  91         return false;
  92       return true;
  93     }
  94     bool operator!=(const KeyTy& that) const {
  95       return !this->operator==(that);
  96     }
  97   };
  98   static inline StructType* getEmptyKey() {
  99     return DenseMapInfo<StructType*>::getEmptyKey();
 100   }
 101   static inline StructType* getTombstoneKey() {
 102     return DenseMapInfo<StructType*>::getTombstoneKey();
 103   }
 104   static unsigned getHashValue(const KeyTy& Key) {
 105     return hash_combine(hash_combine_range(Key.ETypes.begin(),
 106                                            Key.ETypes.end()),
 107                         Key.isPacked);
 108   }
 109   static unsigned getHashValue(const StructType *ST) {
 110     return getHashValue(KeyTy(ST));
 111   }
 112   static bool isEqual(const KeyTy& LHS, const StructType *RHS) {
 113     if (RHS == getEmptyKey() || RHS == getTombstoneKey())
 114       return false;
 115     return LHS == KeyTy(RHS);
 116   }
 117   static bool isEqual(const StructType *LHS, const StructType *RHS) {
 118     return LHS == RHS;
 119   }
 120 };
 121
 122 struct FunctionTypeKeyInfo {
 123   struct KeyTy {
 124     const Type *ReturnType;
 125     ArrayRef<Type*> Params;
 126     bool isVarArg;
 127     KeyTy(const Type* R, const ArrayRef<Type*>& P, bool V) :
 128       ReturnType(R), Params(P), isVarArg(V) {}
 129     KeyTy(const FunctionType *FT)
 130         : ReturnType(FT->getReturnType()), Params(FT->params()),
 131           isVarArg(FT->isVarArg()) {}
 132     bool operator==(const KeyTy& that) const {
 133       if (ReturnType != that.ReturnType)
 134         return false;
 135       if (isVarArg != that.isVarArg)
 136         return false;
 137       if (Params != that.Params)
 138         return false;
 139       return true;
 140     }
 141     bool operator!=(const KeyTy& that) const {
 142       return !this->operator==(that);
 143     }
 144   };
 145   static inline FunctionType* getEmptyKey() {
 146     return DenseMapInfo<FunctionType*>::getEmptyKey();
 147   }
 148   static inline FunctionType* getTombstoneKey() {
 149     return DenseMapInfo<FunctionType*>::getTombstoneKey();
 150   }
 151   static unsigned getHashValue(const KeyTy& Key) {
 152     return hash_combine(Key.ReturnType,
 153                         hash_combine_range(Key.Params.begin(),
 154                                            Key.Params.end()),
 155                         Key.isVarArg);
 156   }
 157   static unsigned getHashValue(const FunctionType *FT) {
 158     return getHashValue(KeyTy(FT));
 159   }
 160   static bool isEqual(const KeyTy& LHS, const FunctionType *RHS) {
 161     if (RHS == getEmptyKey() || RHS == getTombstoneKey())
 162       return false;
 163     return LHS == KeyTy(RHS);
 164   }
 165   static bool isEqual(const FunctionType *LHS, const FunctionType *RHS) {
 166     return LHS == RHS;
 167   }
 168 };
 169
 170 /// \brief Structure for hashing arbitrary MDNode operands.
 171 class MDNodeOpsKey {
 172   ArrayRef<Metadata *> RawOps;
 173   ArrayRef<MDOperand> Ops;
 174
 175   unsigned Hash;
 176
 177 protected:
 178   MDNodeOpsKey(ArrayRef<Metadata *> Ops)
 179       : RawOps(Ops), Hash(calculateHash(Ops)) {}
 180
 181   template <class NodeTy>
 182   MDNodeOpsKey(const NodeTy *N, unsigned Offset = 0)
 183       : Ops(N->op_begin() + Offset, N->op_end()), Hash(N->getHash()) {}
 184
 185   template <class NodeTy>
 186   bool compareOps(const NodeTy *RHS, unsigned Offset = 0) const {
 187     if (getHash() != RHS->getHash())
 188       return false;
 189
 190     assert((RawOps.empty() || Ops.empty()) && "Two sets of operands?");
 191     return RawOps.empty() ? compareOps(Ops, RHS, Offset)
 192                           : compareOps(RawOps, RHS, Offset);
 193   }
 194
 195   static unsigned calculateHash(MDNode *N, unsigned Offset = 0);
 196
 197 private:
 198   template <class T>
 199   static bool compareOps(ArrayRef<T> Ops, const MDNode *RHS, unsigned Offset) {
 200     if (Ops.size() != RHS->getNumOperands() - Offset)
 201       return false;
 202     return std::equal(Ops.begin(), Ops.end(), RHS->op_begin() + Offset);
 203   }
 204
 205   static unsigned calculateHash(ArrayRef<Metadata *> Ops);
 206
 207 public:
 208   unsigned getHash() const { return Hash; }
 209 };
 210
 211 template <class NodeTy> struct MDNodeKeyImpl;
 212 template <class NodeTy> struct MDNodeInfo;
 213
 214 /// \brief DenseMapInfo for MDTuple.
 215 ///
 216 /// Note that we don't need the is-function-local bit, since that's implicit in
 217 /// the operands.
 218 template <> struct MDNodeKeyImpl<MDTuple> : MDNodeOpsKey {
 219   MDNodeKeyImpl(ArrayRef<Metadata *> Ops) : MDNodeOpsKey(Ops) {}
 220   MDNodeKeyImpl(const MDTuple *N) : MDNodeOpsKey(N) {}
 221
 222   bool isKeyOf(const MDTuple *RHS) const { return compareOps(RHS); }
 223
 224   unsigned getHashValue() const { return getHash(); }
 225
 226   static unsigned calculateHash(MDTuple *N) {
 227     return MDNodeOpsKey::calculateHash(N);
 228   }
 229 };
 230
 231 /// \brief DenseMapInfo for MDLocation.
 232 template <> struct MDNodeKeyImpl<MDLocation> {
 233   unsigned Line;
 234   unsigned Column;
 235   Metadata *Scope;
 236   Metadata *InlinedAt;
 237
 238   MDNodeKeyImpl(unsigned Line, unsigned Column, Metadata *Scope,
 239                 Metadata *InlinedAt)
 240       : Line(Line), Column(Column), Scope(Scope), InlinedAt(InlinedAt) {}
 241
 242   MDNodeKeyImpl(const MDLocation *L)
 243       : Line(L->getLine()), Column(L->getColumn()), Scope(L->getRawScope()),
 244         InlinedAt(L->getRawInlinedAt()) {}
 245
 246   bool isKeyOf(const MDLocation *RHS) const {
 247     return Line == RHS->getLine() && Column == RHS->getColumn() &&
 248            Scope == RHS->getRawScope() && InlinedAt == RHS->getRawInlinedAt();
 249   }
 250   unsigned getHashValue() const {
 251     return hash_combine(Line, Column, Scope, InlinedAt);
 252   }
 253 };
 254
 255 /// \brief DenseMapInfo for GenericDebugNode.
 256 template <> struct MDNodeKeyImpl<GenericDebugNode> : MDNodeOpsKey {
 257   unsigned Tag;
 258   StringRef Header;
 259   MDNodeKeyImpl(unsigned Tag, StringRef Header, ArrayRef<Metadata *> DwarfOps)
 260       : MDNodeOpsKey(DwarfOps), Tag(Tag), Header(Header) {}
 261   MDNodeKeyImpl(const GenericDebugNode *N)
 262       : MDNodeOpsKey(N, 1), Tag(N->getTag()), Header(N->getHeader()) {}
 263
 264   bool isKeyOf(const GenericDebugNode *RHS) const {
 265     return Tag == RHS->getTag() && Header == RHS->getHeader() &&
 266            compareOps(RHS, 1);
 267   }
 268
 269   unsigned getHashValue() const { return hash_combine(getHash(), Tag, Header); }
 270
 271   static unsigned calculateHash(GenericDebugNode *N) {
 272     return MDNodeOpsKey::calculateHash(N, 1);
 273   }
 274 };
 275
 276 template <> struct MDNodeKeyImpl<MDSubrange> {
 277   int64_t Count;
 278   int64_t LowerBound;
 279
 280   MDNodeKeyImpl(int64_t Count, int64_t LowerBound)
 281       : Count(Count), LowerBound(LowerBound) {}
 282   MDNodeKeyImpl(const MDSubrange *N)
 283       : Count(N->getCount()), LowerBound(N->getLowerBound()) {}
 284
 285   bool isKeyOf(const MDSubrange *RHS) const {
 286     return Count == RHS->getCount() && LowerBound == RHS->getLowerBound();
 287   }
 288   unsigned getHashValue() const { return hash_combine(Count, LowerBound); }
 289 };
 290
 291 template <> struct MDNodeKeyImpl<MDEnumerator> {
 292   int64_t Value;
 293   StringRef Name;
 294
 295   MDNodeKeyImpl(int64_t Value, StringRef Name) : Value(Value), Name(Name) {}
 296   MDNodeKeyImpl(const MDEnumerator *N)
 297       : Value(N->getValue()), Name(N->getName()) {}
 298
 299   bool isKeyOf(const MDEnumerator *RHS) const {
 300     return Value == RHS->getValue() && Name == RHS->getName();
 301   }
 302   unsigned getHashValue() const { return hash_combine(Value, Name); }
 303 };
 304
 305 template <> struct MDNodeKeyImpl<MDBasicType> {
 306   unsigned Tag;
 307   StringRef Name;
 308   uint64_t SizeInBits;
 309   uint64_t AlignInBits;
 310   unsigned Encoding;
 311
 312   MDNodeKeyImpl(unsigned Tag, StringRef Name, uint64_t SizeInBits,
 313                 uint64_t AlignInBits, unsigned Encoding)
 314       : Tag(Tag), Name(Name), SizeInBits(SizeInBits), AlignInBits(AlignInBits),
 315         Encoding(Encoding) {}
 316   MDNodeKeyImpl(const MDBasicType *N)
 317       : Tag(N->getTag()), Name(N->getName()), SizeInBits(N->getSizeInBits()),
 318         AlignInBits(N->getAlignInBits()), Encoding(N->getEncoding()) {}
 319
 320   bool isKeyOf(const MDBasicType *RHS) const {
 321     return Tag == RHS->getTag() && Name == RHS->getName() &&
 322            SizeInBits == RHS->getSizeInBits() &&
 323            AlignInBits == RHS->getAlignInBits() &&
 324            Encoding == RHS->getEncoding();
 325   }
 326   unsigned getHashValue() const {
 327     return hash_combine(Tag, Name, SizeInBits, AlignInBits, Encoding);
 328   }
 329 };
 330
 331 template <> struct MDNodeKeyImpl<MDDerivedType> {
 332   unsigned Tag;
 333   StringRef Name;
 334   Metadata *File;
 335   unsigned Line;
 336   Metadata *Scope;
 337   Metadata *BaseType;
 338   uint64_t SizeInBits;
 339   uint64_t AlignInBits;
 340   uint64_t OffsetInBits;
 341   unsigned Flags;
 342   Metadata *ExtraData;
 343
 344   MDNodeKeyImpl(unsigned Tag, StringRef Name, Metadata *File, unsigned Line,
 345                 Metadata *Scope, Metadata *BaseType, uint64_t SizeInBits,
 346                 uint64_t AlignInBits, uint64_t OffsetInBits, unsigned Flags,
 347                 Metadata *ExtraData)
 348       : Tag(Tag), Name(Name), File(File), Line(Line), Scope(Scope),
 349         BaseType(BaseType), SizeInBits(SizeInBits), AlignInBits(AlignInBits),
 350         OffsetInBits(OffsetInBits), Flags(Flags), ExtraData(ExtraData) {}
 351   MDNodeKeyImpl(const MDDerivedType *N)
 352       : Tag(N->getTag()), Name(N->getName()), File(N->getRawFile()),
 353         Line(N->getLine()), Scope(N->getRawScope()),
 354         BaseType(N->getRawBaseType()), SizeInBits(N->getSizeInBits()),
 355         AlignInBits(N->getAlignInBits()), OffsetInBits(N->getOffsetInBits()),
 356         Flags(N->getFlags()), ExtraData(N->getRawExtraData()) {}
 357
 358   bool isKeyOf(const MDDerivedType *RHS) const {
 359     return Tag == RHS->getTag() && Name == RHS->getName() &&
 360            File == RHS->getRawFile() && Line == RHS->getLine() &&
 361            Scope == RHS->getRawScope() && BaseType == RHS->getRawBaseType() &&
 362            SizeInBits == RHS->getSizeInBits() &&
 363            AlignInBits == RHS->getAlignInBits() &&
 364            OffsetInBits == RHS->getOffsetInBits() && Flags == RHS->getFlags() &&
 365            ExtraData == RHS->getRawExtraData();
 366   }
 367   unsigned getHashValue() const {
 368     return hash_combine(Tag, Name, File, Line, Scope, BaseType, SizeInBits,
 369                         AlignInBits, OffsetInBits, Flags, ExtraData);
 370   }
 371 };
 372
 373 template <> struct MDNodeKeyImpl<MDCompositeType> {
 374   unsigned Tag;
 375   StringRef Name;
 376   Metadata *File;
 377   unsigned Line;
 378   Metadata *Scope;
 379   Metadata *BaseType;
 380   uint64_t SizeInBits;
 381   uint64_t AlignInBits;
 382   uint64_t OffsetInBits;
 383   unsigned Flags;
 384   Metadata *Elements;
 385   unsigned RuntimeLang;
 386   Metadata *VTableHolder;
 387   Metadata *TemplateParams;
 388   StringRef Identifier;
 389
 390   MDNodeKeyImpl(unsigned Tag, StringRef Name, Metadata *File, unsigned Line,
 391                 Metadata *Scope, Metadata *BaseType, uint64_t SizeInBits,
 392                 uint64_t AlignInBits, uint64_t OffsetInBits, unsigned Flags,
 393                 Metadata *Elements, unsigned RuntimeLang,
 394                 Metadata *VTableHolder, Metadata *TemplateParams,
 395                 StringRef Identifier)
 396       : Tag(Tag), Name(Name), File(File), Line(Line), Scope(Scope),
 397         BaseType(BaseType), SizeInBits(SizeInBits), AlignInBits(AlignInBits),
 398         OffsetInBits(OffsetInBits), Flags(Flags), Elements(Elements),
 399         RuntimeLang(RuntimeLang), VTableHolder(VTableHolder),
 400         TemplateParams(TemplateParams), Identifier(Identifier) {}
 401   MDNodeKeyImpl(const MDCompositeType *N)
 402       : Tag(N->getTag()), Name(N->getName()), File(N->getRawFile()),
 403         Line(N->getLine()), Scope(N->getRawScope()),
 404         BaseType(N->getRawBaseType()), SizeInBits(N->getSizeInBits()),
 405         AlignInBits(N->getAlignInBits()), OffsetInBits(N->getOffsetInBits()),
 406         Flags(N->getFlags()), Elements(N->getRawElements()),
 407         RuntimeLang(N->getRuntimeLang()), VTableHolder(N->getRawVTableHolder()),
 408         TemplateParams(N->getRawTemplateParams()),
 409         Identifier(N->getIdentifier()) {}
 410
 411   bool isKeyOf(const MDCompositeType *RHS) const {
 412     return Tag == RHS->getTag() && Name == RHS->getName() &&
 413            File == RHS->getRawFile() && Line == RHS->getLine() &&
 414            Scope == RHS->getRawScope() && BaseType == RHS->getRawBaseType() &&
 415            SizeInBits == RHS->getSizeInBits() &&
 416            AlignInBits == RHS->getAlignInBits() &&
 417            OffsetInBits == RHS->getOffsetInBits() && Flags == RHS->getFlags() &&
 418            Elements == RHS->getRawElements() &&
 419            RuntimeLang == RHS->getRuntimeLang() &&
 420            VTableHolder == RHS->getRawVTableHolder() &&
 421            TemplateParams == RHS->getRawTemplateParams() &&
 422            Identifier == RHS->getIdentifier();
 423   }
 424   unsigned getHashValue() const {
 425     return hash_combine(Tag, Name, File, Line, Scope, BaseType, SizeInBits,
 426                         AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang,
 427                         VTableHolder, TemplateParams, Identifier);
 428   }
 429 };
 430
 431 template <> struct MDNodeKeyImpl<MDSubroutineType> {
 432   unsigned Flags;
 433   Metadata *TypeArray;
 434
 435   MDNodeKeyImpl(int64_t Flags, Metadata *TypeArray)
 436       : Flags(Flags), TypeArray(TypeArray) {}
 437   MDNodeKeyImpl(const MDSubroutineType *N)
 438       : Flags(N->getFlags()), TypeArray(N->getRawTypeArray()) {}
 439
 440   bool isKeyOf(const MDSubroutineType *RHS) const {
 441     return Flags == RHS->getFlags() && TypeArray == RHS->getRawTypeArray();
 442   }
 443   unsigned getHashValue() const { return hash_combine(Flags, TypeArray); }
 444 };
 445
 446 template <> struct MDNodeKeyImpl<MDFile> {
 447   StringRef Filename;
 448   StringRef Directory;
 449
 450   MDNodeKeyImpl(StringRef Filename, StringRef Directory)
 451       : Filename(Filename), Directory(Directory) {}
 452   MDNodeKeyImpl(const MDFile *N)
 453       : Filename(N->getFilename()), Directory(N->getDirectory()) {}
 454
 455   bool isKeyOf(const MDFile *RHS) const {
 456     return Filename == RHS->getFilename() && Directory == RHS->getDirectory();
 457   }
 458   unsigned getHashValue() const { return hash_combine(Filename, Directory); }
 459 };
 460
 461 template <> struct MDNodeKeyImpl<MDCompileUnit> {
 462   unsigned SourceLanguage;
 463   Metadata *File;
 464   StringRef Producer;
 465   bool IsOptimized;
 466   StringRef Flags;
 467   unsigned RuntimeVersion;
 468   StringRef SplitDebugFilename;
 469   unsigned EmissionKind;
 470   Metadata *EnumTypes;
 471   Metadata *RetainedTypes;
 472   Metadata *Subprograms;
 473   Metadata *GlobalVariables;
 474   Metadata *ImportedEntities;
 475
 476   MDNodeKeyImpl(unsigned SourceLanguage, Metadata *File, StringRef Producer,
 477                 bool IsOptimized, StringRef Flags, unsigned RuntimeVersion,
 478                 StringRef SplitDebugFilename, unsigned EmissionKind,
 479                 Metadata *EnumTypes, Metadata *RetainedTypes,
 480                 Metadata *Subprograms, Metadata *GlobalVariables,
 481                 Metadata *ImportedEntities)
 482       : SourceLanguage(SourceLanguage), File(File), Producer(Producer),
 483         IsOptimized(IsOptimized), Flags(Flags), RuntimeVersion(RuntimeVersion),
 484         SplitDebugFilename(SplitDebugFilename), EmissionKind(EmissionKind),
 485         EnumTypes(EnumTypes), RetainedTypes(RetainedTypes),
 486         Subprograms(Subprograms), GlobalVariables(GlobalVariables),
 487         ImportedEntities(ImportedEntities) {}
 488   MDNodeKeyImpl(const MDCompileUnit *N)
 489       : SourceLanguage(N->getSourceLanguage()), File(N->getRawFile()),
 490         Producer(N->getProducer()), IsOptimized(N->isOptimized()),
 491         Flags(N->getFlags()), RuntimeVersion(N->getRuntimeVersion()),
 492         SplitDebugFilename(N->getSplitDebugFilename()),
 493         EmissionKind(N->getEmissionKind()), EnumTypes(N->getRawEnumTypes()),
 494         RetainedTypes(N->getRawRetainedTypes()),
 495         Subprograms(N->getRawSubprograms()),
 496         GlobalVariables(N->getRawGlobalVariables()),
 497         ImportedEntities(N->getRawImportedEntities()) {}
 498
 499   bool isKeyOf(const MDCompileUnit *RHS) const {
 500     return SourceLanguage == RHS->getSourceLanguage() &&
 501            File == RHS->getRawFile() && Producer == RHS->getProducer() &&
 502            IsOptimized == RHS->isOptimized() && Flags == RHS->getFlags() &&
 503            RuntimeVersion == RHS->getRuntimeVersion() &&
 504            SplitDebugFilename == RHS->getSplitDebugFilename() &&
 505            EmissionKind == RHS->getEmissionKind() &&
 506            EnumTypes == RHS->getRawEnumTypes() &&
 507            RetainedTypes == RHS->getRawRetainedTypes() &&
 508            Subprograms == RHS->getRawSubprograms() &&
 509            GlobalVariables == RHS->getRawGlobalVariables() &&
 510            ImportedEntities == RHS->getRawImportedEntities();
 511   }
 512   unsigned getHashValue() const {
 513     return hash_combine(SourceLanguage, File, Producer, IsOptimized, Flags,
 514                         RuntimeVersion, SplitDebugFilename, EmissionKind,
 515                         EnumTypes, RetainedTypes, Subprograms, GlobalVariables,
 516                         ImportedEntities);
 517   }
 518 };
 519
 520 template <> struct MDNodeKeyImpl<MDSubprogram> {
 521   Metadata *Scope;
 522   StringRef Name;
 523   StringRef LinkageName;
 524   Metadata *File;
 525   unsigned Line;
 526   Metadata *Type;
 527   bool IsLocalToUnit;
 528   bool IsDefinition;
 529   unsigned ScopeLine;
 530   Metadata *ContainingType;
 531   unsigned Virtuality;
 532   unsigned VirtualIndex;
 533   unsigned Flags;
 534   bool IsOptimized;
 535   Metadata *Function;
 536   Metadata *TemplateParams;
 537   Metadata *Declaration;
 538   Metadata *Variables;
 539
 540   MDNodeKeyImpl(Metadata *Scope, StringRef Name, StringRef LinkageName,
 541                 Metadata *File, unsigned Line, Metadata *Type,
 542                 bool IsLocalToUnit, bool IsDefinition, unsigned ScopeLine,
 543                 Metadata *ContainingType, unsigned Virtuality,
 544                 unsigned VirtualIndex, unsigned Flags, bool IsOptimized,
 545                 Metadata *Function, Metadata *TemplateParams,
 546                 Metadata *Declaration, Metadata *Variables)
 547       : Scope(Scope), Name(Name), LinkageName(LinkageName), File(File),
 548         Line(Line), Type(Type), IsLocalToUnit(IsLocalToUnit),
 549         IsDefinition(IsDefinition), ScopeLine(ScopeLine),
 550         ContainingType(ContainingType), Virtuality(Virtuality),
 551         VirtualIndex(VirtualIndex), Flags(Flags), IsOptimized(IsOptimized),
 552         Function(Function), TemplateParams(TemplateParams),
 553         Declaration(Declaration), Variables(Variables) {}
 554   MDNodeKeyImpl(const MDSubprogram *N)
 555       : Scope(N->getRawScope()), Name(N->getName()),
 556         LinkageName(N->getLinkageName()), File(N->getRawFile()),
 557         Line(N->getLine()), Type(N->getRawType()),
 558         IsLocalToUnit(N->isLocalToUnit()), IsDefinition(N->isDefinition()),
 559         ScopeLine(N->getScopeLine()), ContainingType(N->getRawContainingType()),
 560         Virtuality(N->getVirtuality()), VirtualIndex(N->getVirtualIndex()),
 561         Flags(N->getFlags()), IsOptimized(N->isOptimized()),
 562         Function(N->getRawFunction()),
 563         TemplateParams(N->getRawTemplateParams()),
 564         Declaration(N->getRawDeclaration()), Variables(N->getRawVariables()) {}
 565
 566   bool isKeyOf(const MDSubprogram *RHS) const {
 567     return Scope == RHS->getRawScope() && Name == RHS->getName() &&
 568            LinkageName == RHS->getLinkageName() && File == RHS->getRawFile() &&
 569            Line == RHS->getLine() && Type == RHS->getRawType() &&
 570            IsLocalToUnit == RHS->isLocalToUnit() &&
 571            IsDefinition == RHS->isDefinition() &&
 572            ScopeLine == RHS->getScopeLine() &&
 573            ContainingType == RHS->getRawContainingType() &&
 574            Virtuality == RHS->getVirtuality() &&
 575            VirtualIndex == RHS->getVirtualIndex() && Flags == RHS->getFlags() &&
 576            IsOptimized == RHS->isOptimized() &&
 577            Function == RHS->getRawFunction() &&
 578            TemplateParams == RHS->getRawTemplateParams() &&
 579            Declaration == RHS->getRawDeclaration() &&
 580            Variables == RHS->getRawVariables();
 581   }
 582   unsigned getHashValue() const {
 583     return hash_combine(Scope, Name, LinkageName, File, Line, Type,
 584                         IsLocalToUnit, IsDefinition, ScopeLine, ContainingType,
 585                         Virtuality, VirtualIndex, Flags, IsOptimized, Function,
 586                         TemplateParams, Declaration, Variables);
 587   }
 588 };
 589
 590 template <> struct MDNodeKeyImpl<MDLexicalBlock> {
 591   Metadata *Scope;
 592   Metadata *File;
 593   unsigned Line;
 594   unsigned Column;
 595
 596   MDNodeKeyImpl(Metadata *Scope, Metadata *File, unsigned Line, unsigned Column)
 597       : Scope(Scope), File(File), Line(Line), Column(Column) {}
 598   MDNodeKeyImpl(const MDLexicalBlock *N)
 599       : Scope(N->getRawScope()), File(N->getRawFile()), Line(N->getLine()),
 600         Column(N->getColumn()) {}
 601
 602   bool isKeyOf(const MDLexicalBlock *RHS) const {
 603     return Scope == RHS->getRawScope() && File == RHS->getRawFile() &&
 604            Line == RHS->getLine() && Column == RHS->getColumn();
 605   }
 606   unsigned getHashValue() const {
 607     return hash_combine(Scope, File, Line, Column);
 608   }
 609 };
 610
 611 template <> struct MDNodeKeyImpl<MDLexicalBlockFile> {
 612   Metadata *Scope;
 613   Metadata *File;
 614   unsigned Discriminator;
 615
 616   MDNodeKeyImpl(Metadata *Scope, Metadata *File, unsigned Discriminator)
 617       : Scope(Scope), File(File), Discriminator(Discriminator) {}
 618   MDNodeKeyImpl(const MDLexicalBlockFile *N)
 619       : Scope(N->getRawScope()), File(N->getRawFile()),
 620         Discriminator(N->getDiscriminator()) {}
 621
 622   bool isKeyOf(const MDLexicalBlockFile *RHS) const {
 623     return Scope == RHS->getRawScope() && File == RHS->getRawFile() &&
 624            Discriminator == RHS->getDiscriminator();
 625   }
 626   unsigned getHashValue() const {
 627     return hash_combine(Scope, File, Discriminator);
 628   }
 629 };
 630
 631 template <> struct MDNodeKeyImpl<MDNamespace> {
 632   Metadata *Scope;
 633   Metadata *File;
 634   StringRef Name;
 635   unsigned Line;
 636
 637   MDNodeKeyImpl(Metadata *Scope, Metadata *File, StringRef Name, unsigned Line)
 638       : Scope(Scope), File(File), Name(Name), Line(Line) {}
 639   MDNodeKeyImpl(const MDNamespace *N)
 640       : Scope(N->getRawScope()), File(N->getRawFile()), Name(N->getName()),
 641         Line(N->getLine()) {}
 642
 643   bool isKeyOf(const MDNamespace *RHS) const {
 644     return Scope == RHS->getRawScope() && File == RHS->getRawFile() &&
 645            Name == RHS->getName() && Line == RHS->getLine();
 646   }
 647   unsigned getHashValue() const {
 648     return hash_combine(Scope, File, Name, Line);
 649   }
 650 };
 651
 652 template <> struct MDNodeKeyImpl<MDTemplateTypeParameter> {
 653   StringRef Name;
 654   Metadata *Type;
 655
 656   MDNodeKeyImpl(StringRef Name, Metadata *Type) : Name(Name), Type(Type) {}
 657   MDNodeKeyImpl(const MDTemplateTypeParameter *N)
 658       : Name(N->getName()), Type(N->getRawType()) {}
 659
 660   bool isKeyOf(const MDTemplateTypeParameter *RHS) const {
 661     return Name == RHS->getName() && Type == RHS->getRawType();
 662   }
 663   unsigned getHashValue() const { return hash_combine(Name, Type); }
 664 };
 665
 666 template <> struct MDNodeKeyImpl<MDTemplateValueParameter> {
 667   unsigned Tag;
 668   StringRef Name;
 669   Metadata *Type;
 670   Metadata *Value;
 671
 672   MDNodeKeyImpl(unsigned Tag, StringRef Name, Metadata *Type, Metadata *Value)
 673       : Tag(Tag), Name(Name), Type(Type), Value(Value) {}
 674   MDNodeKeyImpl(const MDTemplateValueParameter *N)
 675       : Tag(N->getTag()), Name(N->getName()), Type(N->getRawType()),
 676         Value(N->getValue()) {}
 677
 678   bool isKeyOf(const MDTemplateValueParameter *RHS) const {
 679     return Tag == RHS->getTag() && Name == RHS->getName() &&
 680            Type == RHS->getRawType() && Value == RHS->getValue();
 681   }
 682   unsigned getHashValue() const { return hash_combine(Tag, Name, Type, Value); }
 683 };
 684
 685 template <> struct MDNodeKeyImpl<MDGlobalVariable> {
 686   Metadata *Scope;
 687   StringRef Name;
 688   StringRef LinkageName;
 689   Metadata *File;
 690   unsigned Line;
 691   Metadata *Type;
 692   bool IsLocalToUnit;
 693   bool IsDefinition;
 694   Metadata *Variable;
 695   Metadata *StaticDataMemberDeclaration;
 696
 697   MDNodeKeyImpl(Metadata *Scope, StringRef Name, StringRef LinkageName,
 698                 Metadata *File, unsigned Line, Metadata *Type,
 699                 bool IsLocalToUnit, bool IsDefinition, Metadata *Variable,
 700                 Metadata *StaticDataMemberDeclaration)
 701       : Scope(Scope), Name(Name), LinkageName(LinkageName), File(File),
 702         Line(Line), Type(Type), IsLocalToUnit(IsLocalToUnit),
 703         IsDefinition(IsDefinition), Variable(Variable),
 704         StaticDataMemberDeclaration(StaticDataMemberDeclaration) {}
 705   MDNodeKeyImpl(const MDGlobalVariable *N)
 706       : Scope(N->getRawScope()), Name(N->getName()),
 707         LinkageName(N->getLinkageName()), File(N->getRawFile()),
 708         Line(N->getLine()), Type(N->getRawType()),
 709         IsLocalToUnit(N->isLocalToUnit()), IsDefinition(N->isDefinition()),
 710         Variable(N->getRawVariable()),
 711         StaticDataMemberDeclaration(N->getRawStaticDataMemberDeclaration()) {}
 712
 713   bool isKeyOf(const MDGlobalVariable *RHS) const {
 714     return Scope == RHS->getRawScope() && Name == RHS->getName() &&
 715            LinkageName == RHS->getLinkageName() && File == RHS->getRawFile() &&
 716            Line == RHS->getLine() && Type == RHS->getRawType() &&
 717            IsLocalToUnit == RHS->isLocalToUnit() &&
 718            IsDefinition == RHS->isDefinition() &&
 719            Variable == RHS->getRawVariable() &&
 720            StaticDataMemberDeclaration ==
 721                RHS->getRawStaticDataMemberDeclaration();
 722   }
 723   unsigned getHashValue() const {
 724     return hash_combine(Scope, Name, LinkageName, File, Line, Type,
 725                         IsLocalToUnit, IsDefinition, Variable,
 726                         StaticDataMemberDeclaration);
 727   }
 728 };
 729
 730 template <> struct MDNodeKeyImpl<MDLocalVariable> {
 731   unsigned Tag;
 732   Metadata *Scope;
 733   StringRef Name;
 734   Metadata *File;
 735   unsigned Line;
 736   Metadata *Type;
 737   unsigned Arg;
 738   unsigned Flags;
 739
 740   MDNodeKeyImpl(unsigned Tag, Metadata *Scope, StringRef Name, Metadata *File,
 741                 unsigned Line, Metadata *Type, unsigned Arg, unsigned Flags)
 742       : Tag(Tag), Scope(Scope), Name(Name), File(File), Line(Line), Type(Type),
 743         Arg(Arg), Flags(Flags) {}
 744   MDNodeKeyImpl(const MDLocalVariable *N)
 745       : Tag(N->getTag()), Scope(N->getRawScope()), Name(N->getName()),
 746         File(N->getRawFile()), Line(N->getLine()), Type(N->getRawType()),
 747         Arg(N->getArg()), Flags(N->getFlags()) {}
 748
 749   bool isKeyOf(const MDLocalVariable *RHS) const {
 750     return Tag == RHS->getTag() && Scope == RHS->getRawScope() &&
 751            Name == RHS->getName() && File == RHS->getRawFile() &&
 752            Line == RHS->getLine() && Type == RHS->getRawType() &&
 753            Arg == RHS->getArg() && Flags == RHS->getFlags();
 754   }
 755   unsigned getHashValue() const {
 756     return hash_combine(Tag, Scope, Name, File, Line, Type, Arg, Flags);
 757   }
 758 };
 759
 760 template <> struct MDNodeKeyImpl<MDExpression> {
 761   ArrayRef<uint64_t> Elements;
 762
 763   MDNodeKeyImpl(ArrayRef<uint64_t> Elements) : Elements(Elements) {}
 764   MDNodeKeyImpl(const MDExpression *N) : Elements(N->getElements()) {}
 765
 766   bool isKeyOf(const MDExpression *RHS) const {
 767     return Elements == RHS->getElements();
 768   }
 769   unsigned getHashValue() const {
 770     return hash_combine_range(Elements.begin(), Elements.end());
 771   }
 772 };
 773
 774 template <> struct MDNodeKeyImpl<MDObjCProperty> {
 775   StringRef Name;
 776   Metadata *File;
 777   unsigned Line;
 778   StringRef GetterName;
 779   StringRef SetterName;
 780   unsigned Attributes;
 781   Metadata *Type;
 782
 783   MDNodeKeyImpl(StringRef Name, Metadata *File, unsigned Line,
 784                 StringRef GetterName, StringRef SetterName, unsigned Attributes,
 785                 Metadata *Type)
 786       : Name(Name), File(File), Line(Line), GetterName(GetterName),
 787         SetterName(SetterName), Attributes(Attributes), Type(Type) {}
 788   MDNodeKeyImpl(const MDObjCProperty *N)
 789       : Name(N->getName()), File(N->getRawFile()), Line(N->getLine()),
 790         GetterName(N->getGetterName()), SetterName(N->getSetterName()),
 791         Attributes(N->getAttributes()), Type(N->getRawType()) {}
 792
 793   bool isKeyOf(const MDObjCProperty *RHS) const {
 794     return Name == RHS->getName() && File == RHS->getRawFile() &&
 795            Line == RHS->getLine() && GetterName == RHS->getGetterName() &&
 796            SetterName == RHS->getSetterName() &&
 797            Attributes == RHS->getAttributes() && Type == RHS->getRawType();
 798   }
 799   unsigned getHashValue() const {
 800     return hash_combine(Name, File, Line, GetterName, SetterName, Attributes,
 801                         Type);
 802   }
 803 };
 804
 805 template <> struct MDNodeKeyImpl<MDImportedEntity> {
 806   unsigned Tag;
 807   Metadata *Scope;
 808   Metadata *Entity;
 809   unsigned Line;
 810   StringRef Name;
 811
 812   MDNodeKeyImpl(unsigned Tag, Metadata *Scope, Metadata *Entity, unsigned Line,
 813                 StringRef Name)
 814       : Tag(Tag), Scope(Scope), Entity(Entity), Line(Line), Name(Name) {}
 815   MDNodeKeyImpl(const MDImportedEntity *N)
 816       : Tag(N->getTag()), Scope(N->getRawScope()), Entity(N->getRawEntity()),
 817         Line(N->getLine()), Name(N->getName()) {}
 818
 819   bool isKeyOf(const MDImportedEntity *RHS) const {
 820     return Tag == RHS->getTag() && Scope == RHS->getRawScope() &&
 821            Entity == RHS->getRawEntity() && Line == RHS->getLine() &&
 822            Name == RHS->getName();
 823   }
 824   unsigned getHashValue() const {
 825     return hash_combine(Tag, Scope, Entity, Line, Name);
 826   }
 827 };
 828
 829 /// \brief DenseMapInfo for MDNode subclasses.
 830 template <class NodeTy> struct MDNodeInfo {
 831   typedef MDNodeKeyImpl<NodeTy> KeyTy;
 832   static inline NodeTy *getEmptyKey() {
 833     return DenseMapInfo<NodeTy *>::getEmptyKey();
 834   }
 835   static inline NodeTy *getTombstoneKey() {
 836     return DenseMapInfo<NodeTy *>::getTombstoneKey();
 837   }
 838   static unsigned getHashValue(const KeyTy &Key) { return Key.getHashValue(); }
 839   static unsigned getHashValue(const NodeTy *N) {
 840     return KeyTy(N).getHashValue();
 841   }
 842   static bool isEqual(const KeyTy &LHS, const NodeTy *RHS) {
 843     if (RHS == getEmptyKey() || RHS == getTombstoneKey())
 844       return false;
 845     return LHS.isKeyOf(RHS);
 846   }
 847   static bool isEqual(const NodeTy *LHS, const NodeTy *RHS) {
 848     return LHS == RHS;
 849   }
 850 };
 851
 852 #define HANDLE_MDNODE_LEAF(CLASS) typedef MDNodeInfo<CLASS> CLASS##Info;
 853 #include "llvm/IR/Metadata.def"
 854
 855 class LLVMContextImpl {
 856 public:
 857   /// OwnedModules - The set of modules instantiated in this context, and which
 858   /// will be automatically deleted if this context is deleted.
 859   SmallPtrSet<Module*, 4> OwnedModules;
 860
 861   LLVMContext::InlineAsmDiagHandlerTy InlineAsmDiagHandler;
 862   void *InlineAsmDiagContext;
 863
 864   LLVMContext::DiagnosticHandlerTy DiagnosticHandler;
 865   void *DiagnosticContext;
 866   bool RespectDiagnosticFilters;
 867
 868   LLVMContext::YieldCallbackTy YieldCallback;
 869   void *YieldOpaqueHandle;
 870
 871   typedef DenseMap<APInt, ConstantInt *, DenseMapAPIntKeyInfo> IntMapTy;
 872   IntMapTy IntConstants;
 873
 874   typedef DenseMap<APFloat, ConstantFP *, DenseMapAPFloatKeyInfo> FPMapTy;
 875   FPMapTy FPConstants;
 876
 877   FoldingSet<AttributeImpl> AttrsSet;
 878   FoldingSet<AttributeSetImpl> AttrsLists;
 879   FoldingSet<AttributeSetNode> AttrsSetNodes;
 880
 881   StringMap<MDString> MDStringCache;
 882   DenseMap<Value *, ValueAsMetadata *> ValuesAsMetadata;
 883   DenseMap<Metadata *, MetadataAsValue *> MetadataAsValues;
 884
 885 #define HANDLE_MDNODE_LEAF(CLASS) DenseSet<CLASS *, CLASS##Info> CLASS##s;
 886 #include "llvm/IR/Metadata.def"
 887
 888   // MDNodes may be uniqued or not uniqued.  When they're not uniqued, they
 889   // aren't in the MDNodeSet, but they're still shared between objects, so no
 890   // one object can destroy them.  This set allows us to at least destroy them
 891   // on Context destruction.
 892   SmallPtrSet<MDNode *, 1> DistinctMDNodes;
 893
 894   DenseMap<Type*, ConstantAggregateZero*> CAZConstants;
 895
 896   typedef ConstantUniqueMap<ConstantArray> ArrayConstantsTy;
 897   ArrayConstantsTy ArrayConstants;
 898
 899   typedef ConstantUniqueMap<ConstantStruct> StructConstantsTy;
 900   StructConstantsTy StructConstants;
 901
 902   typedef ConstantUniqueMap<ConstantVector> VectorConstantsTy;
 903   VectorConstantsTy VectorConstants;
 904
 905   DenseMap<PointerType*, ConstantPointerNull*> CPNConstants;
 906
 907   DenseMap<Type*, UndefValue*> UVConstants;
 908
 909   StringMap<ConstantDataSequential*> CDSConstants;
 910
 911   DenseMap<std::pair<const Function *, const BasicBlock *>, BlockAddress *>
 912     BlockAddresses;
 913   ConstantUniqueMap<ConstantExpr> ExprConstants;
 914
 915   ConstantUniqueMap<InlineAsm> InlineAsms;
 916
 917   ConstantInt *TheTrueVal;
 918   ConstantInt *TheFalseVal;
 919
 920   // Basic type instances.
 921   Type VoidTy, LabelTy, HalfTy, FloatTy, DoubleTy, MetadataTy;
 922   Type X86_FP80Ty, FP128Ty, PPC_FP128Ty, X86_MMXTy;
 923   IntegerType Int1Ty, Int8Ty, Int16Ty, Int32Ty, Int64Ty;
 924
 925
 926   /// TypeAllocator - All dynamically allocated types are allocated from this.
 927   /// They live forever until the context is torn down.
 928   BumpPtrAllocator TypeAllocator;
 929
 930   DenseMap<unsigned, IntegerType*> IntegerTypes;
 931
 932   typedef DenseSet<FunctionType *, FunctionTypeKeyInfo> FunctionTypeSet;
 933   FunctionTypeSet FunctionTypes;
 934   typedef DenseSet<StructType *, AnonStructTypeKeyInfo> StructTypeSet;
 935   StructTypeSet AnonStructTypes;
 936   StringMap<StructType*> NamedStructTypes;
 937   unsigned NamedStructTypesUniqueID;
 938
 939   DenseMap<std::pair<Type *, uint64_t>, ArrayType*> ArrayTypes;
 940   DenseMap<std::pair<Type *, unsigned>, VectorType*> VectorTypes;
 941   DenseMap<Type*, PointerType*> PointerTypes;  // Pointers in AddrSpace = 0
 942   DenseMap<std::pair<Type*, unsigned>, PointerType*> ASPointerTypes;
 943
 944
 945   /// ValueHandles - This map keeps track of all of the value handles that are
 946   /// watching a Value*.  The Value::HasValueHandle bit is used to know
 947   /// whether or not a value has an entry in this map.
 948   typedef DenseMap<Value*, ValueHandleBase*> ValueHandlesTy;
 949   ValueHandlesTy ValueHandles;
 950
 951   /// CustomMDKindNames - Map to hold the metadata string to ID mapping.
 952   StringMap<unsigned> CustomMDKindNames;
 953
 954   typedef std::pair<unsigned, TrackingMDNodeRef> MDPairTy;
 955   typedef SmallVector<MDPairTy, 2> MDMapTy;
 956
 957   /// MetadataStore - Collection of per-instruction metadata used in this
 958   /// context.
 959   DenseMap<const Instruction *, MDMapTy> MetadataStore;
 960
 961   /// DiscriminatorTable - This table maps file:line locations to an
 962   /// integer representing the next DWARF path discriminator to assign to
 963   /// instructions in different blocks at the same location.
 964   DenseMap<std::pair<const char *, unsigned>, unsigned> DiscriminatorTable;
 965
 966   /// IntrinsicIDCache - Cache of intrinsic name (string) to numeric ID mappings
 967   /// requested in this context
 968   typedef DenseMap<const Function*, unsigned> IntrinsicIDCacheTy;
 969   IntrinsicIDCacheTy IntrinsicIDCache;
 970
 971   /// \brief Mapping from a function to its prefix data, which is stored as the
 972   /// operand of an unparented ReturnInst so that the prefix data has a Use.
 973   typedef DenseMap<const Function *, ReturnInst *> PrefixDataMapTy;
 974   PrefixDataMapTy PrefixDataMap;
 975
 976   /// \brief Mapping from a function to its prologue data, which is stored as
 977   /// the operand of an unparented ReturnInst so that the prologue data has a
 978   /// Use.
 979   typedef DenseMap<const Function *, ReturnInst *> PrologueDataMapTy;
 980   PrologueDataMapTy PrologueDataMap;
 981
 982   int getOrAddScopeRecordIdxEntry(MDNode *N, int ExistingIdx);
 983   int getOrAddScopeInlinedAtIdxEntry(MDNode *Scope, MDNode *IA,int ExistingIdx);
 984
 985   LLVMContextImpl(LLVMContext &C);
 986   ~LLVMContextImpl();
 987
 988   /// Destroy the ConstantArrays if they are not used.
 989   void dropTriviallyDeadConstantArrays();
 990 };
 991
 992 }
 993
 994 #endif