Move the name pointer out of Value into a map that lives on the
[oota-llvm.git] / 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 DILocation.
232 template <> struct MDNodeKeyImpl<DILocation> {
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 DILocation *L)
243       : Line(L->getLine()), Column(L->getColumn()), Scope(L->getRawScope()),
244         InlinedAt(L->getRawInlinedAt()) {}
245
246   bool isKeyOf(const DILocation *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 GenericDINode.
256 template <> struct MDNodeKeyImpl<GenericDINode> : 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 GenericDINode *N)
262       : MDNodeOpsKey(N, 1), Tag(N->getTag()), Header(N->getHeader()) {}
263
264   bool isKeyOf(const GenericDINode *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(GenericDINode *N) {
272     return MDNodeOpsKey::calculateHash(N, 1);
273   }
274 };
275
276 template <> struct MDNodeKeyImpl<DISubrange> {
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 DISubrange *N)
283       : Count(N->getCount()), LowerBound(N->getLowerBound()) {}
284
285   bool isKeyOf(const DISubrange *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<DIEnumerator> {
292   int64_t Value;
293   StringRef Name;
294
295   MDNodeKeyImpl(int64_t Value, StringRef Name) : Value(Value), Name(Name) {}
296   MDNodeKeyImpl(const DIEnumerator *N)
297       : Value(N->getValue()), Name(N->getName()) {}
298
299   bool isKeyOf(const DIEnumerator *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<DIBasicType> {
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 DIBasicType *N)
317       : Tag(N->getTag()), Name(N->getName()), SizeInBits(N->getSizeInBits()),
318         AlignInBits(N->getAlignInBits()), Encoding(N->getEncoding()) {}
319
320   bool isKeyOf(const DIBasicType *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<DIDerivedType> {
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 DIDerivedType *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 DIDerivedType *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<DICompositeType> {
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 DICompositeType *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 DICompositeType *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<DISubroutineType> {
432   unsigned Flags;
433   Metadata *TypeArray;
434
435   MDNodeKeyImpl(int64_t Flags, Metadata *TypeArray)
436       : Flags(Flags), TypeArray(TypeArray) {}
437   MDNodeKeyImpl(const DISubroutineType *N)
438       : Flags(N->getFlags()), TypeArray(N->getRawTypeArray()) {}
439
440   bool isKeyOf(const DISubroutineType *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<DIFile> {
447   StringRef Filename;
448   StringRef Directory;
449
450   MDNodeKeyImpl(StringRef Filename, StringRef Directory)
451       : Filename(Filename), Directory(Directory) {}
452   MDNodeKeyImpl(const DIFile *N)
453       : Filename(N->getFilename()), Directory(N->getDirectory()) {}
454
455   bool isKeyOf(const DIFile *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<DICompileUnit> {
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   uint64_t DWOId;
476
477   MDNodeKeyImpl(unsigned SourceLanguage, Metadata *File, StringRef Producer,
478                 bool IsOptimized, StringRef Flags, unsigned RuntimeVersion,
479                 StringRef SplitDebugFilename, unsigned EmissionKind,
480                 Metadata *EnumTypes, Metadata *RetainedTypes,
481                 Metadata *Subprograms, Metadata *GlobalVariables,
482                 Metadata *ImportedEntities, uint64_t DWOId)
483       : SourceLanguage(SourceLanguage), File(File), Producer(Producer),
484         IsOptimized(IsOptimized), Flags(Flags), RuntimeVersion(RuntimeVersion),
485         SplitDebugFilename(SplitDebugFilename), EmissionKind(EmissionKind),
486         EnumTypes(EnumTypes), RetainedTypes(RetainedTypes),
487         Subprograms(Subprograms), GlobalVariables(GlobalVariables),
488         ImportedEntities(ImportedEntities), DWOId(DWOId) {}
489   MDNodeKeyImpl(const DICompileUnit *N)
490       : SourceLanguage(N->getSourceLanguage()), File(N->getRawFile()),
491         Producer(N->getProducer()), IsOptimized(N->isOptimized()),
492         Flags(N->getFlags()), RuntimeVersion(N->getRuntimeVersion()),
493         SplitDebugFilename(N->getSplitDebugFilename()),
494         EmissionKind(N->getEmissionKind()), EnumTypes(N->getRawEnumTypes()),
495         RetainedTypes(N->getRawRetainedTypes()),
496         Subprograms(N->getRawSubprograms()),
497         GlobalVariables(N->getRawGlobalVariables()),
498         ImportedEntities(N->getRawImportedEntities()), DWOId(N->getDWOId()) {}
499
500   bool isKeyOf(const DICompileUnit *RHS) const {
501     return SourceLanguage == RHS->getSourceLanguage() &&
502            File == RHS->getRawFile() && Producer == RHS->getProducer() &&
503            IsOptimized == RHS->isOptimized() && Flags == RHS->getFlags() &&
504            RuntimeVersion == RHS->getRuntimeVersion() &&
505            SplitDebugFilename == RHS->getSplitDebugFilename() &&
506            EmissionKind == RHS->getEmissionKind() &&
507            EnumTypes == RHS->getRawEnumTypes() &&
508            RetainedTypes == RHS->getRawRetainedTypes() &&
509            Subprograms == RHS->getRawSubprograms() &&
510            GlobalVariables == RHS->getRawGlobalVariables() &&
511            ImportedEntities == RHS->getRawImportedEntities() &&
512            DWOId == RHS->getDWOId();
513   }
514   unsigned getHashValue() const {
515     return hash_combine(SourceLanguage, File, Producer, IsOptimized, Flags,
516                         RuntimeVersion, SplitDebugFilename, EmissionKind,
517                         EnumTypes, RetainedTypes, Subprograms, GlobalVariables,
518                         ImportedEntities, DWOId);
519   }
520 };
521
522 template <> struct MDNodeKeyImpl<DISubprogram> {
523   Metadata *Scope;
524   StringRef Name;
525   StringRef LinkageName;
526   Metadata *File;
527   unsigned Line;
528   Metadata *Type;
529   bool IsLocalToUnit;
530   bool IsDefinition;
531   unsigned ScopeLine;
532   Metadata *ContainingType;
533   unsigned Virtuality;
534   unsigned VirtualIndex;
535   unsigned Flags;
536   bool IsOptimized;
537   Metadata *Function;
538   Metadata *TemplateParams;
539   Metadata *Declaration;
540   Metadata *Variables;
541
542   MDNodeKeyImpl(Metadata *Scope, StringRef Name, StringRef LinkageName,
543                 Metadata *File, unsigned Line, Metadata *Type,
544                 bool IsLocalToUnit, bool IsDefinition, unsigned ScopeLine,
545                 Metadata *ContainingType, unsigned Virtuality,
546                 unsigned VirtualIndex, unsigned Flags, bool IsOptimized,
547                 Metadata *Function, Metadata *TemplateParams,
548                 Metadata *Declaration, Metadata *Variables)
549       : Scope(Scope), Name(Name), LinkageName(LinkageName), File(File),
550         Line(Line), Type(Type), IsLocalToUnit(IsLocalToUnit),
551         IsDefinition(IsDefinition), ScopeLine(ScopeLine),
552         ContainingType(ContainingType), Virtuality(Virtuality),
553         VirtualIndex(VirtualIndex), Flags(Flags), IsOptimized(IsOptimized),
554         Function(Function), TemplateParams(TemplateParams),
555         Declaration(Declaration), Variables(Variables) {}
556   MDNodeKeyImpl(const DISubprogram *N)
557       : Scope(N->getRawScope()), Name(N->getName()),
558         LinkageName(N->getLinkageName()), File(N->getRawFile()),
559         Line(N->getLine()), Type(N->getRawType()),
560         IsLocalToUnit(N->isLocalToUnit()), IsDefinition(N->isDefinition()),
561         ScopeLine(N->getScopeLine()), ContainingType(N->getRawContainingType()),
562         Virtuality(N->getVirtuality()), VirtualIndex(N->getVirtualIndex()),
563         Flags(N->getFlags()), IsOptimized(N->isOptimized()),
564         Function(N->getRawFunction()),
565         TemplateParams(N->getRawTemplateParams()),
566         Declaration(N->getRawDeclaration()), Variables(N->getRawVariables()) {}
567
568   bool isKeyOf(const DISubprogram *RHS) const {
569     return Scope == RHS->getRawScope() && Name == RHS->getName() &&
570            LinkageName == RHS->getLinkageName() && File == RHS->getRawFile() &&
571            Line == RHS->getLine() && Type == RHS->getRawType() &&
572            IsLocalToUnit == RHS->isLocalToUnit() &&
573            IsDefinition == RHS->isDefinition() &&
574            ScopeLine == RHS->getScopeLine() &&
575            ContainingType == RHS->getRawContainingType() &&
576            Virtuality == RHS->getVirtuality() &&
577            VirtualIndex == RHS->getVirtualIndex() && Flags == RHS->getFlags() &&
578            IsOptimized == RHS->isOptimized() &&
579            Function == RHS->getRawFunction() &&
580            TemplateParams == RHS->getRawTemplateParams() &&
581            Declaration == RHS->getRawDeclaration() &&
582            Variables == RHS->getRawVariables();
583   }
584   unsigned getHashValue() const {
585     return hash_combine(Scope, Name, LinkageName, File, Line, Type,
586                         IsLocalToUnit, IsDefinition, ScopeLine, ContainingType,
587                         Virtuality, VirtualIndex, Flags, IsOptimized, Function,
588                         TemplateParams, Declaration, Variables);
589   }
590 };
591
592 template <> struct MDNodeKeyImpl<DILexicalBlock> {
593   Metadata *Scope;
594   Metadata *File;
595   unsigned Line;
596   unsigned Column;
597
598   MDNodeKeyImpl(Metadata *Scope, Metadata *File, unsigned Line, unsigned Column)
599       : Scope(Scope), File(File), Line(Line), Column(Column) {}
600   MDNodeKeyImpl(const DILexicalBlock *N)
601       : Scope(N->getRawScope()), File(N->getRawFile()), Line(N->getLine()),
602         Column(N->getColumn()) {}
603
604   bool isKeyOf(const DILexicalBlock *RHS) const {
605     return Scope == RHS->getRawScope() && File == RHS->getRawFile() &&
606            Line == RHS->getLine() && Column == RHS->getColumn();
607   }
608   unsigned getHashValue() const {
609     return hash_combine(Scope, File, Line, Column);
610   }
611 };
612
613 template <> struct MDNodeKeyImpl<DILexicalBlockFile> {
614   Metadata *Scope;
615   Metadata *File;
616   unsigned Discriminator;
617
618   MDNodeKeyImpl(Metadata *Scope, Metadata *File, unsigned Discriminator)
619       : Scope(Scope), File(File), Discriminator(Discriminator) {}
620   MDNodeKeyImpl(const DILexicalBlockFile *N)
621       : Scope(N->getRawScope()), File(N->getRawFile()),
622         Discriminator(N->getDiscriminator()) {}
623
624   bool isKeyOf(const DILexicalBlockFile *RHS) const {
625     return Scope == RHS->getRawScope() && File == RHS->getRawFile() &&
626            Discriminator == RHS->getDiscriminator();
627   }
628   unsigned getHashValue() const {
629     return hash_combine(Scope, File, Discriminator);
630   }
631 };
632
633 template <> struct MDNodeKeyImpl<DINamespace> {
634   Metadata *Scope;
635   Metadata *File;
636   StringRef Name;
637   unsigned Line;
638
639   MDNodeKeyImpl(Metadata *Scope, Metadata *File, StringRef Name, unsigned Line)
640       : Scope(Scope), File(File), Name(Name), Line(Line) {}
641   MDNodeKeyImpl(const DINamespace *N)
642       : Scope(N->getRawScope()), File(N->getRawFile()), Name(N->getName()),
643         Line(N->getLine()) {}
644
645   bool isKeyOf(const DINamespace *RHS) const {
646     return Scope == RHS->getRawScope() && File == RHS->getRawFile() &&
647            Name == RHS->getName() && Line == RHS->getLine();
648   }
649   unsigned getHashValue() const {
650     return hash_combine(Scope, File, Name, Line);
651   }
652 };
653
654 template <> struct MDNodeKeyImpl<DITemplateTypeParameter> {
655   StringRef Name;
656   Metadata *Type;
657
658   MDNodeKeyImpl(StringRef Name, Metadata *Type) : Name(Name), Type(Type) {}
659   MDNodeKeyImpl(const DITemplateTypeParameter *N)
660       : Name(N->getName()), Type(N->getRawType()) {}
661
662   bool isKeyOf(const DITemplateTypeParameter *RHS) const {
663     return Name == RHS->getName() && Type == RHS->getRawType();
664   }
665   unsigned getHashValue() const { return hash_combine(Name, Type); }
666 };
667
668 template <> struct MDNodeKeyImpl<DITemplateValueParameter> {
669   unsigned Tag;
670   StringRef Name;
671   Metadata *Type;
672   Metadata *Value;
673
674   MDNodeKeyImpl(unsigned Tag, StringRef Name, Metadata *Type, Metadata *Value)
675       : Tag(Tag), Name(Name), Type(Type), Value(Value) {}
676   MDNodeKeyImpl(const DITemplateValueParameter *N)
677       : Tag(N->getTag()), Name(N->getName()), Type(N->getRawType()),
678         Value(N->getValue()) {}
679
680   bool isKeyOf(const DITemplateValueParameter *RHS) const {
681     return Tag == RHS->getTag() && Name == RHS->getName() &&
682            Type == RHS->getRawType() && Value == RHS->getValue();
683   }
684   unsigned getHashValue() const { return hash_combine(Tag, Name, Type, Value); }
685 };
686
687 template <> struct MDNodeKeyImpl<DIGlobalVariable> {
688   Metadata *Scope;
689   StringRef Name;
690   StringRef LinkageName;
691   Metadata *File;
692   unsigned Line;
693   Metadata *Type;
694   bool IsLocalToUnit;
695   bool IsDefinition;
696   Metadata *Variable;
697   Metadata *StaticDataMemberDeclaration;
698
699   MDNodeKeyImpl(Metadata *Scope, StringRef Name, StringRef LinkageName,
700                 Metadata *File, unsigned Line, Metadata *Type,
701                 bool IsLocalToUnit, bool IsDefinition, Metadata *Variable,
702                 Metadata *StaticDataMemberDeclaration)
703       : Scope(Scope), Name(Name), LinkageName(LinkageName), File(File),
704         Line(Line), Type(Type), IsLocalToUnit(IsLocalToUnit),
705         IsDefinition(IsDefinition), Variable(Variable),
706         StaticDataMemberDeclaration(StaticDataMemberDeclaration) {}
707   MDNodeKeyImpl(const DIGlobalVariable *N)
708       : Scope(N->getRawScope()), Name(N->getName()),
709         LinkageName(N->getLinkageName()), File(N->getRawFile()),
710         Line(N->getLine()), Type(N->getRawType()),
711         IsLocalToUnit(N->isLocalToUnit()), IsDefinition(N->isDefinition()),
712         Variable(N->getRawVariable()),
713         StaticDataMemberDeclaration(N->getRawStaticDataMemberDeclaration()) {}
714
715   bool isKeyOf(const DIGlobalVariable *RHS) const {
716     return Scope == RHS->getRawScope() && Name == RHS->getName() &&
717            LinkageName == RHS->getLinkageName() && File == RHS->getRawFile() &&
718            Line == RHS->getLine() && Type == RHS->getRawType() &&
719            IsLocalToUnit == RHS->isLocalToUnit() &&
720            IsDefinition == RHS->isDefinition() &&
721            Variable == RHS->getRawVariable() &&
722            StaticDataMemberDeclaration ==
723                RHS->getRawStaticDataMemberDeclaration();
724   }
725   unsigned getHashValue() const {
726     return hash_combine(Scope, Name, LinkageName, File, Line, Type,
727                         IsLocalToUnit, IsDefinition, Variable,
728                         StaticDataMemberDeclaration);
729   }
730 };
731
732 template <> struct MDNodeKeyImpl<DILocalVariable> {
733   unsigned Tag;
734   Metadata *Scope;
735   StringRef Name;
736   Metadata *File;
737   unsigned Line;
738   Metadata *Type;
739   unsigned Arg;
740   unsigned Flags;
741
742   MDNodeKeyImpl(unsigned Tag, Metadata *Scope, StringRef Name, Metadata *File,
743                 unsigned Line, Metadata *Type, unsigned Arg, unsigned Flags)
744       : Tag(Tag), Scope(Scope), Name(Name), File(File), Line(Line), Type(Type),
745         Arg(Arg), Flags(Flags) {}
746   MDNodeKeyImpl(const DILocalVariable *N)
747       : Tag(N->getTag()), Scope(N->getRawScope()), Name(N->getName()),
748         File(N->getRawFile()), Line(N->getLine()), Type(N->getRawType()),
749         Arg(N->getArg()), Flags(N->getFlags()) {}
750
751   bool isKeyOf(const DILocalVariable *RHS) const {
752     return Tag == RHS->getTag() && Scope == RHS->getRawScope() &&
753            Name == RHS->getName() && File == RHS->getRawFile() &&
754            Line == RHS->getLine() && Type == RHS->getRawType() &&
755            Arg == RHS->getArg() && Flags == RHS->getFlags();
756   }
757   unsigned getHashValue() const {
758     return hash_combine(Tag, Scope, Name, File, Line, Type, Arg, Flags);
759   }
760 };
761
762 template <> struct MDNodeKeyImpl<DIExpression> {
763   ArrayRef<uint64_t> Elements;
764
765   MDNodeKeyImpl(ArrayRef<uint64_t> Elements) : Elements(Elements) {}
766   MDNodeKeyImpl(const DIExpression *N) : Elements(N->getElements()) {}
767
768   bool isKeyOf(const DIExpression *RHS) const {
769     return Elements == RHS->getElements();
770   }
771   unsigned getHashValue() const {
772     return hash_combine_range(Elements.begin(), Elements.end());
773   }
774 };
775
776 template <> struct MDNodeKeyImpl<DIObjCProperty> {
777   StringRef Name;
778   Metadata *File;
779   unsigned Line;
780   StringRef GetterName;
781   StringRef SetterName;
782   unsigned Attributes;
783   Metadata *Type;
784
785   MDNodeKeyImpl(StringRef Name, Metadata *File, unsigned Line,
786                 StringRef GetterName, StringRef SetterName, unsigned Attributes,
787                 Metadata *Type)
788       : Name(Name), File(File), Line(Line), GetterName(GetterName),
789         SetterName(SetterName), Attributes(Attributes), Type(Type) {}
790   MDNodeKeyImpl(const DIObjCProperty *N)
791       : Name(N->getName()), File(N->getRawFile()), Line(N->getLine()),
792         GetterName(N->getGetterName()), SetterName(N->getSetterName()),
793         Attributes(N->getAttributes()), Type(N->getRawType()) {}
794
795   bool isKeyOf(const DIObjCProperty *RHS) const {
796     return Name == RHS->getName() && File == RHS->getRawFile() &&
797            Line == RHS->getLine() && GetterName == RHS->getGetterName() &&
798            SetterName == RHS->getSetterName() &&
799            Attributes == RHS->getAttributes() && Type == RHS->getRawType();
800   }
801   unsigned getHashValue() const {
802     return hash_combine(Name, File, Line, GetterName, SetterName, Attributes,
803                         Type);
804   }
805 };
806
807 template <> struct MDNodeKeyImpl<DIImportedEntity> {
808   unsigned Tag;
809   Metadata *Scope;
810   Metadata *Entity;
811   unsigned Line;
812   StringRef Name;
813
814   MDNodeKeyImpl(unsigned Tag, Metadata *Scope, Metadata *Entity, unsigned Line,
815                 StringRef Name)
816       : Tag(Tag), Scope(Scope), Entity(Entity), Line(Line), Name(Name) {}
817   MDNodeKeyImpl(const DIImportedEntity *N)
818       : Tag(N->getTag()), Scope(N->getRawScope()), Entity(N->getRawEntity()),
819         Line(N->getLine()), Name(N->getName()) {}
820
821   bool isKeyOf(const DIImportedEntity *RHS) const {
822     return Tag == RHS->getTag() && Scope == RHS->getRawScope() &&
823            Entity == RHS->getRawEntity() && Line == RHS->getLine() &&
824            Name == RHS->getName();
825   }
826   unsigned getHashValue() const {
827     return hash_combine(Tag, Scope, Entity, Line, Name);
828   }
829 };
830
831 /// \brief DenseMapInfo for MDNode subclasses.
832 template <class NodeTy> struct MDNodeInfo {
833   typedef MDNodeKeyImpl<NodeTy> KeyTy;
834   static inline NodeTy *getEmptyKey() {
835     return DenseMapInfo<NodeTy *>::getEmptyKey();
836   }
837   static inline NodeTy *getTombstoneKey() {
838     return DenseMapInfo<NodeTy *>::getTombstoneKey();
839   }
840   static unsigned getHashValue(const KeyTy &Key) { return Key.getHashValue(); }
841   static unsigned getHashValue(const NodeTy *N) {
842     return KeyTy(N).getHashValue();
843   }
844   static bool isEqual(const KeyTy &LHS, const NodeTy *RHS) {
845     if (RHS == getEmptyKey() || RHS == getTombstoneKey())
846       return false;
847     return LHS.isKeyOf(RHS);
848   }
849   static bool isEqual(const NodeTy *LHS, const NodeTy *RHS) {
850     return LHS == RHS;
851   }
852 };
853
854 #define HANDLE_MDNODE_LEAF(CLASS) typedef MDNodeInfo<CLASS> CLASS##Info;
855 #include "llvm/IR/Metadata.def"
856
857 /// \brief Map-like storage for metadata attachments.
858 class MDAttachmentMap {
859   SmallVector<std::pair<unsigned, TrackingMDNodeRef>, 2> Attachments;
860
861 public:
862   bool empty() const { return Attachments.empty(); }
863   size_t size() const { return Attachments.size(); }
864
865   /// \brief Get a particular attachment (if any).
866   MDNode *lookup(unsigned ID) const;
867
868   /// \brief Set an attachment to a particular node.
869   ///
870   /// Set the \c ID attachment to \c MD, replacing the current attachment at \c
871   /// ID (if anyway).
872   void set(unsigned ID, MDNode &MD);
873
874   /// \brief Remove an attachment.
875   ///
876   /// Remove the attachment at \c ID, if any.
877   void erase(unsigned ID);
878
879   /// \brief Copy out all the attachments.
880   ///
881   /// Copies all the current attachments into \c Result, sorting by attachment
882   /// ID.  This function does \em not clear \c Result.
883   void getAll(SmallVectorImpl<std::pair<unsigned, MDNode *>> &Result) const;
884
885   /// \brief Erase matching attachments.
886   ///
887   /// Erases all attachments matching the \c shouldRemove predicate.
888   template <class PredTy> void remove_if(PredTy shouldRemove) {
889     Attachments.erase(
890         std::remove_if(Attachments.begin(), Attachments.end(), shouldRemove),
891         Attachments.end());
892   }
893 };
894
895 class LLVMContextImpl {
896 public:
897   /// OwnedModules - The set of modules instantiated in this context, and which
898   /// will be automatically deleted if this context is deleted.
899   SmallPtrSet<Module*, 4> OwnedModules;
900   
901   LLVMContext::InlineAsmDiagHandlerTy InlineAsmDiagHandler;
902   void *InlineAsmDiagContext;
903
904   LLVMContext::DiagnosticHandlerTy DiagnosticHandler;
905   void *DiagnosticContext;
906   bool RespectDiagnosticFilters;
907
908   LLVMContext::YieldCallbackTy YieldCallback;
909   void *YieldOpaqueHandle;
910
911   typedef DenseMap<APInt, ConstantInt *, DenseMapAPIntKeyInfo> IntMapTy;
912   IntMapTy IntConstants;
913
914   typedef DenseMap<APFloat, ConstantFP *, DenseMapAPFloatKeyInfo> FPMapTy;
915   FPMapTy FPConstants;
916
917   FoldingSet<AttributeImpl> AttrsSet;
918   FoldingSet<AttributeSetImpl> AttrsLists;
919   FoldingSet<AttributeSetNode> AttrsSetNodes;
920
921   StringMap<MDString> MDStringCache;
922   DenseMap<Value *, ValueAsMetadata *> ValuesAsMetadata;
923   DenseMap<Metadata *, MetadataAsValue *> MetadataAsValues;
924
925   DenseMap<const Value*, ValueName*> ValueNames;
926
927 #define HANDLE_MDNODE_LEAF(CLASS) DenseSet<CLASS *, CLASS##Info> CLASS##s;
928 #include "llvm/IR/Metadata.def"
929
930   // MDNodes may be uniqued or not uniqued.  When they're not uniqued, they
931   // aren't in the MDNodeSet, but they're still shared between objects, so no
932   // one object can destroy them.  This set allows us to at least destroy them
933   // on Context destruction.
934   SmallPtrSet<MDNode *, 1> DistinctMDNodes;
935
936   DenseMap<Type*, ConstantAggregateZero*> CAZConstants;
937
938   typedef ConstantUniqueMap<ConstantArray> ArrayConstantsTy;
939   ArrayConstantsTy ArrayConstants;
940   
941   typedef ConstantUniqueMap<ConstantStruct> StructConstantsTy;
942   StructConstantsTy StructConstants;
943   
944   typedef ConstantUniqueMap<ConstantVector> VectorConstantsTy;
945   VectorConstantsTy VectorConstants;
946   
947   DenseMap<PointerType*, ConstantPointerNull*> CPNConstants;
948
949   DenseMap<Type*, UndefValue*> UVConstants;
950   
951   StringMap<ConstantDataSequential*> CDSConstants;
952
953   DenseMap<std::pair<const Function *, const BasicBlock *>, BlockAddress *>
954     BlockAddresses;
955   ConstantUniqueMap<ConstantExpr> ExprConstants;
956
957   ConstantUniqueMap<InlineAsm> InlineAsms;
958
959   ConstantInt *TheTrueVal;
960   ConstantInt *TheFalseVal;
961
962   // Basic type instances.
963   Type VoidTy, LabelTy, HalfTy, FloatTy, DoubleTy, MetadataTy;
964   Type X86_FP80Ty, FP128Ty, PPC_FP128Ty, X86_MMXTy;
965   IntegerType Int1Ty, Int8Ty, Int16Ty, Int32Ty, Int64Ty, Int128Ty;
966
967   
968   /// TypeAllocator - All dynamically allocated types are allocated from this.
969   /// They live forever until the context is torn down.
970   BumpPtrAllocator TypeAllocator;
971   
972   DenseMap<unsigned, IntegerType*> IntegerTypes;
973
974   typedef DenseSet<FunctionType *, FunctionTypeKeyInfo> FunctionTypeSet;
975   FunctionTypeSet FunctionTypes;
976   typedef DenseSet<StructType *, AnonStructTypeKeyInfo> StructTypeSet;
977   StructTypeSet AnonStructTypes;
978   StringMap<StructType*> NamedStructTypes;
979   unsigned NamedStructTypesUniqueID;
980     
981   DenseMap<std::pair<Type *, uint64_t>, ArrayType*> ArrayTypes;
982   DenseMap<std::pair<Type *, unsigned>, VectorType*> VectorTypes;
983   DenseMap<Type*, PointerType*> PointerTypes;  // Pointers in AddrSpace = 0
984   DenseMap<std::pair<Type*, unsigned>, PointerType*> ASPointerTypes;
985
986
987   /// ValueHandles - This map keeps track of all of the value handles that are
988   /// watching a Value*.  The Value::HasValueHandle bit is used to know
989   /// whether or not a value has an entry in this map.
990   typedef DenseMap<Value*, ValueHandleBase*> ValueHandlesTy;
991   ValueHandlesTy ValueHandles;
992   
993   /// CustomMDKindNames - Map to hold the metadata string to ID mapping.
994   StringMap<unsigned> CustomMDKindNames;
995
996   /// Collection of per-instruction metadata used in this context.
997   DenseMap<const Instruction *, MDAttachmentMap> InstructionMetadata;
998
999   /// Collection of per-function metadata used in this context.
1000   DenseMap<const Function *, MDAttachmentMap> FunctionMetadata;
1001
1002   /// DiscriminatorTable - This table maps file:line locations to an
1003   /// integer representing the next DWARF path discriminator to assign to
1004   /// instructions in different blocks at the same location.
1005   DenseMap<std::pair<const char *, unsigned>, unsigned> DiscriminatorTable;
1006
1007   /// \brief Mapping from a function to its prefix data, which is stored as the
1008   /// operand of an unparented ReturnInst so that the prefix data has a Use.
1009   typedef DenseMap<const Function *, ReturnInst *> PrefixDataMapTy;
1010   PrefixDataMapTy PrefixDataMap;
1011
1012   /// \brief Mapping from a function to its prologue data, which is stored as
1013   /// the operand of an unparented ReturnInst so that the prologue data has a
1014   /// Use.
1015   typedef DenseMap<const Function *, ReturnInst *> PrologueDataMapTy;
1016   PrologueDataMapTy PrologueDataMap;
1017
1018   int getOrAddScopeRecordIdxEntry(MDNode *N, int ExistingIdx);
1019   int getOrAddScopeInlinedAtIdxEntry(MDNode *Scope, MDNode *IA,int ExistingIdx);
1020
1021   LLVMContextImpl(LLVMContext &C);
1022   ~LLVMContextImpl();
1023
1024   /// Destroy the ConstantArrays if they are not used.
1025   void dropTriviallyDeadConstantArrays();
1026 };
1027
1028 }
1029
1030 #endif