1 //===-- LLVMContextImpl.h - The LLVMContextImpl opaque class ----*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file declares LLVMContextImpl, the opaque implementation
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_LIB_IR_LLVMCONTEXTIMPL_H
16 #define LLVM_LIB_IR_LLVMCONTEXTIMPL_H
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"
41 class DiagnosticInfoOptimizationRemark;
42 class DiagnosticInfoOptimizationRemarkMissed;
43 class DiagnosticInfoOptimizationRemarkAnalysis;
49 struct DenseMapAPIntKeyInfo {
50 static inline APInt getEmptyKey() {
55 static inline APInt getTombstoneKey() {
60 static unsigned getHashValue(const APInt &Key) {
61 return static_cast<unsigned>(hash_value(Key));
63 static bool isEqual(const APInt &LHS, const APInt &RHS) {
64 return LHS.getBitWidth() == RHS.getBitWidth() && LHS == RHS;
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));
74 static bool isEqual(const APFloat &LHS, const APFloat &RHS) {
75 return LHS.bitwiseIsEqual(RHS);
79 struct AnonStructTypeKeyInfo {
81 ArrayRef<Type*> ETypes;
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)
90 if (ETypes != that.ETypes)
94 bool operator!=(const KeyTy& that) const {
95 return !this->operator==(that);
98 static inline StructType* getEmptyKey() {
99 return DenseMapInfo<StructType*>::getEmptyKey();
101 static inline StructType* getTombstoneKey() {
102 return DenseMapInfo<StructType*>::getTombstoneKey();
104 static unsigned getHashValue(const KeyTy& Key) {
105 return hash_combine(hash_combine_range(Key.ETypes.begin(),
109 static unsigned getHashValue(const StructType *ST) {
110 return getHashValue(KeyTy(ST));
112 static bool isEqual(const KeyTy& LHS, const StructType *RHS) {
113 if (RHS == getEmptyKey() || RHS == getTombstoneKey())
115 return LHS == KeyTy(RHS);
117 static bool isEqual(const StructType *LHS, const StructType *RHS) {
122 struct FunctionTypeKeyInfo {
124 const Type *ReturnType;
125 ArrayRef<Type*> Params;
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)
135 if (isVarArg != that.isVarArg)
137 if (Params != that.Params)
141 bool operator!=(const KeyTy& that) const {
142 return !this->operator==(that);
145 static inline FunctionType* getEmptyKey() {
146 return DenseMapInfo<FunctionType*>::getEmptyKey();
148 static inline FunctionType* getTombstoneKey() {
149 return DenseMapInfo<FunctionType*>::getTombstoneKey();
151 static unsigned getHashValue(const KeyTy& Key) {
152 return hash_combine(Key.ReturnType,
153 hash_combine_range(Key.Params.begin(),
157 static unsigned getHashValue(const FunctionType *FT) {
158 return getHashValue(KeyTy(FT));
160 static bool isEqual(const KeyTy& LHS, const FunctionType *RHS) {
161 if (RHS == getEmptyKey() || RHS == getTombstoneKey())
163 return LHS == KeyTy(RHS);
165 static bool isEqual(const FunctionType *LHS, const FunctionType *RHS) {
170 /// \brief Structure for hashing arbitrary MDNode operands.
172 ArrayRef<Metadata *> RawOps;
173 ArrayRef<MDOperand> Ops;
178 MDNodeOpsKey(ArrayRef<Metadata *> Ops)
179 : RawOps(Ops), Hash(calculateHash(Ops)) {}
181 template <class NodeTy>
182 MDNodeOpsKey(const NodeTy *N, unsigned Offset = 0)
183 : Ops(N->op_begin() + Offset, N->op_end()), Hash(N->getHash()) {}
185 template <class NodeTy>
186 bool compareOps(const NodeTy *RHS, unsigned Offset = 0) const {
187 if (getHash() != RHS->getHash())
190 assert((RawOps.empty() || Ops.empty()) && "Two sets of operands?");
191 return RawOps.empty() ? compareOps(Ops, RHS, Offset)
192 : compareOps(RawOps, RHS, Offset);
195 static unsigned calculateHash(MDNode *N, unsigned Offset = 0);
199 static bool compareOps(ArrayRef<T> Ops, const MDNode *RHS, unsigned Offset) {
200 if (Ops.size() != RHS->getNumOperands() - Offset)
202 return std::equal(Ops.begin(), Ops.end(), RHS->op_begin() + Offset);
205 static unsigned calculateHash(ArrayRef<Metadata *> Ops);
208 unsigned getHash() const { return Hash; }
211 template <class NodeTy> struct MDNodeKeyImpl;
212 template <class NodeTy> struct MDNodeInfo;
214 /// \brief DenseMapInfo for MDTuple.
216 /// Note that we don't need the is-function-local bit, since that's implicit in
218 template <> struct MDNodeKeyImpl<MDTuple> : MDNodeOpsKey {
219 MDNodeKeyImpl(ArrayRef<Metadata *> Ops) : MDNodeOpsKey(Ops) {}
220 MDNodeKeyImpl(const MDTuple *N) : MDNodeOpsKey(N) {}
222 bool isKeyOf(const MDTuple *RHS) const { return compareOps(RHS); }
224 unsigned getHashValue() const { return getHash(); }
226 static unsigned calculateHash(MDTuple *N) {
227 return MDNodeOpsKey::calculateHash(N);
231 /// \brief DenseMapInfo for DILocation.
232 template <> struct MDNodeKeyImpl<DILocation> {
238 MDNodeKeyImpl(unsigned Line, unsigned Column, Metadata *Scope,
240 : Line(Line), Column(Column), Scope(Scope), InlinedAt(InlinedAt) {}
242 MDNodeKeyImpl(const DILocation *L)
243 : Line(L->getLine()), Column(L->getColumn()), Scope(L->getRawScope()),
244 InlinedAt(L->getRawInlinedAt()) {}
246 bool isKeyOf(const DILocation *RHS) const {
247 return Line == RHS->getLine() && Column == RHS->getColumn() &&
248 Scope == RHS->getRawScope() && InlinedAt == RHS->getRawInlinedAt();
250 unsigned getHashValue() const {
251 return hash_combine(Line, Column, Scope, InlinedAt);
255 /// \brief DenseMapInfo for GenericDINode.
256 template <> struct MDNodeKeyImpl<GenericDINode> : MDNodeOpsKey {
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()) {}
264 bool isKeyOf(const GenericDINode *RHS) const {
265 return Tag == RHS->getTag() && Header == RHS->getHeader() &&
269 unsigned getHashValue() const { return hash_combine(getHash(), Tag, Header); }
271 static unsigned calculateHash(GenericDINode *N) {
272 return MDNodeOpsKey::calculateHash(N, 1);
276 template <> struct MDNodeKeyImpl<DISubrange> {
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()) {}
285 bool isKeyOf(const DISubrange *RHS) const {
286 return Count == RHS->getCount() && LowerBound == RHS->getLowerBound();
288 unsigned getHashValue() const { return hash_combine(Count, LowerBound); }
291 template <> struct MDNodeKeyImpl<DIEnumerator> {
295 MDNodeKeyImpl(int64_t Value, StringRef Name) : Value(Value), Name(Name) {}
296 MDNodeKeyImpl(const DIEnumerator *N)
297 : Value(N->getValue()), Name(N->getName()) {}
299 bool isKeyOf(const DIEnumerator *RHS) const {
300 return Value == RHS->getValue() && Name == RHS->getName();
302 unsigned getHashValue() const { return hash_combine(Value, Name); }
305 template <> struct MDNodeKeyImpl<DIBasicType> {
309 uint64_t AlignInBits;
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()) {}
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();
326 unsigned getHashValue() const {
327 return hash_combine(Tag, Name, SizeInBits, AlignInBits, Encoding);
331 template <> struct MDNodeKeyImpl<DIDerivedType> {
339 uint64_t AlignInBits;
340 uint64_t OffsetInBits;
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,
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()) {}
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();
367 unsigned getHashValue() const {
368 return hash_combine(Tag, Name, File, Line, Scope, BaseType, SizeInBits,
369 AlignInBits, OffsetInBits, Flags, ExtraData);
373 template <> struct MDNodeKeyImpl<DICompositeType> {
381 uint64_t AlignInBits;
382 uint64_t OffsetInBits;
385 unsigned RuntimeLang;
386 Metadata *VTableHolder;
387 Metadata *TemplateParams;
388 StringRef Identifier;
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()) {}
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();
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);
431 template <> struct MDNodeKeyImpl<DISubroutineType> {
435 MDNodeKeyImpl(int64_t Flags, Metadata *TypeArray)
436 : Flags(Flags), TypeArray(TypeArray) {}
437 MDNodeKeyImpl(const DISubroutineType *N)
438 : Flags(N->getFlags()), TypeArray(N->getRawTypeArray()) {}
440 bool isKeyOf(const DISubroutineType *RHS) const {
441 return Flags == RHS->getFlags() && TypeArray == RHS->getRawTypeArray();
443 unsigned getHashValue() const { return hash_combine(Flags, TypeArray); }
446 template <> struct MDNodeKeyImpl<DIFile> {
450 MDNodeKeyImpl(StringRef Filename, StringRef Directory)
451 : Filename(Filename), Directory(Directory) {}
452 MDNodeKeyImpl(const DIFile *N)
453 : Filename(N->getFilename()), Directory(N->getDirectory()) {}
455 bool isKeyOf(const DIFile *RHS) const {
456 return Filename == RHS->getFilename() && Directory == RHS->getDirectory();
458 unsigned getHashValue() const { return hash_combine(Filename, Directory); }
461 template <> struct MDNodeKeyImpl<DISubprogram> {
464 StringRef LinkageName;
471 Metadata *ContainingType;
473 unsigned VirtualIndex;
476 Metadata *TemplateParams;
477 Metadata *Declaration;
480 MDNodeKeyImpl(Metadata *Scope, StringRef Name, StringRef LinkageName,
481 Metadata *File, unsigned Line, Metadata *Type,
482 bool IsLocalToUnit, bool IsDefinition, unsigned ScopeLine,
483 Metadata *ContainingType, unsigned Virtuality,
484 unsigned VirtualIndex, unsigned Flags, bool IsOptimized,
485 Metadata *TemplateParams, Metadata *Declaration,
487 : Scope(Scope), Name(Name), LinkageName(LinkageName), File(File),
488 Line(Line), Type(Type), IsLocalToUnit(IsLocalToUnit),
489 IsDefinition(IsDefinition), ScopeLine(ScopeLine),
490 ContainingType(ContainingType), Virtuality(Virtuality),
491 VirtualIndex(VirtualIndex), Flags(Flags), IsOptimized(IsOptimized),
492 TemplateParams(TemplateParams), Declaration(Declaration),
493 Variables(Variables) {}
494 MDNodeKeyImpl(const DISubprogram *N)
495 : Scope(N->getRawScope()), Name(N->getName()),
496 LinkageName(N->getLinkageName()), File(N->getRawFile()),
497 Line(N->getLine()), Type(N->getRawType()),
498 IsLocalToUnit(N->isLocalToUnit()), IsDefinition(N->isDefinition()),
499 ScopeLine(N->getScopeLine()), ContainingType(N->getRawContainingType()),
500 Virtuality(N->getVirtuality()), VirtualIndex(N->getVirtualIndex()),
501 Flags(N->getFlags()), IsOptimized(N->isOptimized()),
502 TemplateParams(N->getRawTemplateParams()),
503 Declaration(N->getRawDeclaration()), Variables(N->getRawVariables()) {}
505 bool isKeyOf(const DISubprogram *RHS) const {
506 return Scope == RHS->getRawScope() && Name == RHS->getName() &&
507 LinkageName == RHS->getLinkageName() && File == RHS->getRawFile() &&
508 Line == RHS->getLine() && Type == RHS->getRawType() &&
509 IsLocalToUnit == RHS->isLocalToUnit() &&
510 IsDefinition == RHS->isDefinition() &&
511 ScopeLine == RHS->getScopeLine() &&
512 ContainingType == RHS->getRawContainingType() &&
513 Virtuality == RHS->getVirtuality() &&
514 VirtualIndex == RHS->getVirtualIndex() && Flags == RHS->getFlags() &&
515 IsOptimized == RHS->isOptimized() &&
516 TemplateParams == RHS->getRawTemplateParams() &&
517 Declaration == RHS->getRawDeclaration() &&
518 Variables == RHS->getRawVariables();
520 unsigned getHashValue() const {
521 return hash_combine(Scope, Name, LinkageName, File, Line, Type,
522 IsLocalToUnit, IsDefinition, ScopeLine, ContainingType,
523 Virtuality, VirtualIndex, Flags, IsOptimized,
524 TemplateParams, Declaration, Variables);
528 template <> struct MDNodeKeyImpl<DILexicalBlock> {
534 MDNodeKeyImpl(Metadata *Scope, Metadata *File, unsigned Line, unsigned Column)
535 : Scope(Scope), File(File), Line(Line), Column(Column) {}
536 MDNodeKeyImpl(const DILexicalBlock *N)
537 : Scope(N->getRawScope()), File(N->getRawFile()), Line(N->getLine()),
538 Column(N->getColumn()) {}
540 bool isKeyOf(const DILexicalBlock *RHS) const {
541 return Scope == RHS->getRawScope() && File == RHS->getRawFile() &&
542 Line == RHS->getLine() && Column == RHS->getColumn();
544 unsigned getHashValue() const {
545 return hash_combine(Scope, File, Line, Column);
549 template <> struct MDNodeKeyImpl<DILexicalBlockFile> {
552 unsigned Discriminator;
554 MDNodeKeyImpl(Metadata *Scope, Metadata *File, unsigned Discriminator)
555 : Scope(Scope), File(File), Discriminator(Discriminator) {}
556 MDNodeKeyImpl(const DILexicalBlockFile *N)
557 : Scope(N->getRawScope()), File(N->getRawFile()),
558 Discriminator(N->getDiscriminator()) {}
560 bool isKeyOf(const DILexicalBlockFile *RHS) const {
561 return Scope == RHS->getRawScope() && File == RHS->getRawFile() &&
562 Discriminator == RHS->getDiscriminator();
564 unsigned getHashValue() const {
565 return hash_combine(Scope, File, Discriminator);
569 template <> struct MDNodeKeyImpl<DINamespace> {
575 MDNodeKeyImpl(Metadata *Scope, Metadata *File, StringRef Name, unsigned Line)
576 : Scope(Scope), File(File), Name(Name), Line(Line) {}
577 MDNodeKeyImpl(const DINamespace *N)
578 : Scope(N->getRawScope()), File(N->getRawFile()), Name(N->getName()),
579 Line(N->getLine()) {}
581 bool isKeyOf(const DINamespace *RHS) const {
582 return Scope == RHS->getRawScope() && File == RHS->getRawFile() &&
583 Name == RHS->getName() && Line == RHS->getLine();
585 unsigned getHashValue() const {
586 return hash_combine(Scope, File, Name, Line);
590 template <> struct MDNodeKeyImpl<DIModule> {
593 StringRef ConfigurationMacros;
594 StringRef IncludePath;
596 MDNodeKeyImpl(Metadata *Scope, StringRef Name,
597 StringRef ConfigurationMacros,
598 StringRef IncludePath,
600 : Scope(Scope), Name(Name), ConfigurationMacros(ConfigurationMacros),
601 IncludePath(IncludePath), ISysRoot(ISysRoot) {}
602 MDNodeKeyImpl(const DIModule *N)
603 : Scope(N->getRawScope()), Name(N->getName()),
604 ConfigurationMacros(N->getConfigurationMacros()),
605 IncludePath(N->getIncludePath()), ISysRoot(N->getISysRoot()) {}
607 bool isKeyOf(const DIModule *RHS) const {
608 return Scope == RHS->getRawScope() && Name == RHS->getName() &&
609 ConfigurationMacros == RHS->getConfigurationMacros() &&
610 IncludePath == RHS->getIncludePath() &&
611 ISysRoot == RHS->getISysRoot();
613 unsigned getHashValue() const {
614 return hash_combine(Scope, Name,
615 ConfigurationMacros, IncludePath, ISysRoot);
619 template <> struct MDNodeKeyImpl<DITemplateTypeParameter> {
623 MDNodeKeyImpl(StringRef Name, Metadata *Type) : Name(Name), Type(Type) {}
624 MDNodeKeyImpl(const DITemplateTypeParameter *N)
625 : Name(N->getName()), Type(N->getRawType()) {}
627 bool isKeyOf(const DITemplateTypeParameter *RHS) const {
628 return Name == RHS->getName() && Type == RHS->getRawType();
630 unsigned getHashValue() const { return hash_combine(Name, Type); }
633 template <> struct MDNodeKeyImpl<DITemplateValueParameter> {
639 MDNodeKeyImpl(unsigned Tag, StringRef Name, Metadata *Type, Metadata *Value)
640 : Tag(Tag), Name(Name), Type(Type), Value(Value) {}
641 MDNodeKeyImpl(const DITemplateValueParameter *N)
642 : Tag(N->getTag()), Name(N->getName()), Type(N->getRawType()),
643 Value(N->getValue()) {}
645 bool isKeyOf(const DITemplateValueParameter *RHS) const {
646 return Tag == RHS->getTag() && Name == RHS->getName() &&
647 Type == RHS->getRawType() && Value == RHS->getValue();
649 unsigned getHashValue() const { return hash_combine(Tag, Name, Type, Value); }
652 template <> struct MDNodeKeyImpl<DIGlobalVariable> {
655 StringRef LinkageName;
662 Metadata *StaticDataMemberDeclaration;
664 MDNodeKeyImpl(Metadata *Scope, StringRef Name, StringRef LinkageName,
665 Metadata *File, unsigned Line, Metadata *Type,
666 bool IsLocalToUnit, bool IsDefinition, Metadata *Variable,
667 Metadata *StaticDataMemberDeclaration)
668 : Scope(Scope), Name(Name), LinkageName(LinkageName), File(File),
669 Line(Line), Type(Type), IsLocalToUnit(IsLocalToUnit),
670 IsDefinition(IsDefinition), Variable(Variable),
671 StaticDataMemberDeclaration(StaticDataMemberDeclaration) {}
672 MDNodeKeyImpl(const DIGlobalVariable *N)
673 : Scope(N->getRawScope()), Name(N->getName()),
674 LinkageName(N->getLinkageName()), File(N->getRawFile()),
675 Line(N->getLine()), Type(N->getRawType()),
676 IsLocalToUnit(N->isLocalToUnit()), IsDefinition(N->isDefinition()),
677 Variable(N->getRawVariable()),
678 StaticDataMemberDeclaration(N->getRawStaticDataMemberDeclaration()) {}
680 bool isKeyOf(const DIGlobalVariable *RHS) const {
681 return Scope == RHS->getRawScope() && Name == RHS->getName() &&
682 LinkageName == RHS->getLinkageName() && File == RHS->getRawFile() &&
683 Line == RHS->getLine() && Type == RHS->getRawType() &&
684 IsLocalToUnit == RHS->isLocalToUnit() &&
685 IsDefinition == RHS->isDefinition() &&
686 Variable == RHS->getRawVariable() &&
687 StaticDataMemberDeclaration ==
688 RHS->getRawStaticDataMemberDeclaration();
690 unsigned getHashValue() const {
691 return hash_combine(Scope, Name, LinkageName, File, Line, Type,
692 IsLocalToUnit, IsDefinition, Variable,
693 StaticDataMemberDeclaration);
697 template <> struct MDNodeKeyImpl<DILocalVariable> {
706 MDNodeKeyImpl(Metadata *Scope, StringRef Name, Metadata *File, unsigned Line,
707 Metadata *Type, unsigned Arg, unsigned Flags)
708 : Scope(Scope), Name(Name), File(File), Line(Line), Type(Type), Arg(Arg),
710 MDNodeKeyImpl(const DILocalVariable *N)
711 : Scope(N->getRawScope()), Name(N->getName()), File(N->getRawFile()),
712 Line(N->getLine()), Type(N->getRawType()), Arg(N->getArg()),
713 Flags(N->getFlags()) {}
715 bool isKeyOf(const DILocalVariable *RHS) const {
716 return Scope == RHS->getRawScope() && Name == RHS->getName() &&
717 File == RHS->getRawFile() && Line == RHS->getLine() &&
718 Type == RHS->getRawType() && Arg == RHS->getArg() &&
719 Flags == RHS->getFlags();
721 unsigned getHashValue() const {
722 return hash_combine(Scope, Name, File, Line, Type, Arg, Flags);
726 template <> struct MDNodeKeyImpl<DIExpression> {
727 ArrayRef<uint64_t> Elements;
729 MDNodeKeyImpl(ArrayRef<uint64_t> Elements) : Elements(Elements) {}
730 MDNodeKeyImpl(const DIExpression *N) : Elements(N->getElements()) {}
732 bool isKeyOf(const DIExpression *RHS) const {
733 return Elements == RHS->getElements();
735 unsigned getHashValue() const {
736 return hash_combine_range(Elements.begin(), Elements.end());
740 template <> struct MDNodeKeyImpl<DIObjCProperty> {
744 StringRef GetterName;
745 StringRef SetterName;
749 MDNodeKeyImpl(StringRef Name, Metadata *File, unsigned Line,
750 StringRef GetterName, StringRef SetterName, unsigned Attributes,
752 : Name(Name), File(File), Line(Line), GetterName(GetterName),
753 SetterName(SetterName), Attributes(Attributes), Type(Type) {}
754 MDNodeKeyImpl(const DIObjCProperty *N)
755 : Name(N->getName()), File(N->getRawFile()), Line(N->getLine()),
756 GetterName(N->getGetterName()), SetterName(N->getSetterName()),
757 Attributes(N->getAttributes()), Type(N->getRawType()) {}
759 bool isKeyOf(const DIObjCProperty *RHS) const {
760 return Name == RHS->getName() && File == RHS->getRawFile() &&
761 Line == RHS->getLine() && GetterName == RHS->getGetterName() &&
762 SetterName == RHS->getSetterName() &&
763 Attributes == RHS->getAttributes() && Type == RHS->getRawType();
765 unsigned getHashValue() const {
766 return hash_combine(Name, File, Line, GetterName, SetterName, Attributes,
771 template <> struct MDNodeKeyImpl<DIImportedEntity> {
778 MDNodeKeyImpl(unsigned Tag, Metadata *Scope, Metadata *Entity, unsigned Line,
780 : Tag(Tag), Scope(Scope), Entity(Entity), Line(Line), Name(Name) {}
781 MDNodeKeyImpl(const DIImportedEntity *N)
782 : Tag(N->getTag()), Scope(N->getRawScope()), Entity(N->getRawEntity()),
783 Line(N->getLine()), Name(N->getName()) {}
785 bool isKeyOf(const DIImportedEntity *RHS) const {
786 return Tag == RHS->getTag() && Scope == RHS->getRawScope() &&
787 Entity == RHS->getRawEntity() && Line == RHS->getLine() &&
788 Name == RHS->getName();
790 unsigned getHashValue() const {
791 return hash_combine(Tag, Scope, Entity, Line, Name);
795 /// \brief DenseMapInfo for MDNode subclasses.
796 template <class NodeTy> struct MDNodeInfo {
797 typedef MDNodeKeyImpl<NodeTy> KeyTy;
798 static inline NodeTy *getEmptyKey() {
799 return DenseMapInfo<NodeTy *>::getEmptyKey();
801 static inline NodeTy *getTombstoneKey() {
802 return DenseMapInfo<NodeTy *>::getTombstoneKey();
804 static unsigned getHashValue(const KeyTy &Key) { return Key.getHashValue(); }
805 static unsigned getHashValue(const NodeTy *N) {
806 return KeyTy(N).getHashValue();
808 static bool isEqual(const KeyTy &LHS, const NodeTy *RHS) {
809 if (RHS == getEmptyKey() || RHS == getTombstoneKey())
811 return LHS.isKeyOf(RHS);
813 static bool isEqual(const NodeTy *LHS, const NodeTy *RHS) {
818 #define HANDLE_MDNODE_LEAF(CLASS) typedef MDNodeInfo<CLASS> CLASS##Info;
819 #include "llvm/IR/Metadata.def"
821 /// \brief Map-like storage for metadata attachments.
822 class MDAttachmentMap {
823 SmallVector<std::pair<unsigned, TrackingMDNodeRef>, 2> Attachments;
826 bool empty() const { return Attachments.empty(); }
827 size_t size() const { return Attachments.size(); }
829 /// \brief Get a particular attachment (if any).
830 MDNode *lookup(unsigned ID) const;
832 /// \brief Set an attachment to a particular node.
834 /// Set the \c ID attachment to \c MD, replacing the current attachment at \c
836 void set(unsigned ID, MDNode &MD);
838 /// \brief Remove an attachment.
840 /// Remove the attachment at \c ID, if any.
841 void erase(unsigned ID);
843 /// \brief Copy out all the attachments.
845 /// Copies all the current attachments into \c Result, sorting by attachment
846 /// ID. This function does \em not clear \c Result.
847 void getAll(SmallVectorImpl<std::pair<unsigned, MDNode *>> &Result) const;
849 /// \brief Erase matching attachments.
851 /// Erases all attachments matching the \c shouldRemove predicate.
852 template <class PredTy> void remove_if(PredTy shouldRemove) {
854 std::remove_if(Attachments.begin(), Attachments.end(), shouldRemove),
859 class LLVMContextImpl {
861 /// OwnedModules - The set of modules instantiated in this context, and which
862 /// will be automatically deleted if this context is deleted.
863 SmallPtrSet<Module*, 4> OwnedModules;
865 LLVMContext::InlineAsmDiagHandlerTy InlineAsmDiagHandler;
866 void *InlineAsmDiagContext;
868 LLVMContext::DiagnosticHandlerTy DiagnosticHandler;
869 void *DiagnosticContext;
870 bool RespectDiagnosticFilters;
872 LLVMContext::YieldCallbackTy YieldCallback;
873 void *YieldOpaqueHandle;
875 typedef DenseMap<APInt, ConstantInt *, DenseMapAPIntKeyInfo> IntMapTy;
876 IntMapTy IntConstants;
878 typedef DenseMap<APFloat, ConstantFP *, DenseMapAPFloatKeyInfo> FPMapTy;
881 FoldingSet<AttributeImpl> AttrsSet;
882 FoldingSet<AttributeSetImpl> AttrsLists;
883 FoldingSet<AttributeSetNode> AttrsSetNodes;
885 StringMap<MDString> MDStringCache;
886 DenseMap<Value *, ValueAsMetadata *> ValuesAsMetadata;
887 DenseMap<Metadata *, MetadataAsValue *> MetadataAsValues;
889 DenseMap<const Value*, ValueName*> ValueNames;
891 #define HANDLE_MDNODE_LEAF_UNIQUABLE(CLASS) \
892 DenseSet<CLASS *, CLASS##Info> CLASS##s;
893 #include "llvm/IR/Metadata.def"
895 // MDNodes may be uniqued or not uniqued. When they're not uniqued, they
896 // aren't in the MDNodeSet, but they're still shared between objects, so no
897 // one object can destroy them. This set allows us to at least destroy them
898 // on Context destruction.
899 SmallPtrSet<MDNode *, 1> DistinctMDNodes;
901 DenseMap<Type*, ConstantAggregateZero*> CAZConstants;
903 typedef ConstantUniqueMap<ConstantArray> ArrayConstantsTy;
904 ArrayConstantsTy ArrayConstants;
906 typedef ConstantUniqueMap<ConstantStruct> StructConstantsTy;
907 StructConstantsTy StructConstants;
909 typedef ConstantUniqueMap<ConstantVector> VectorConstantsTy;
910 VectorConstantsTy VectorConstants;
912 DenseMap<PointerType*, ConstantPointerNull*> CPNConstants;
914 DenseMap<Type*, UndefValue*> UVConstants;
916 StringMap<ConstantDataSequential*> CDSConstants;
918 DenseMap<std::pair<const Function *, const BasicBlock *>, BlockAddress *>
920 ConstantUniqueMap<ConstantExpr> ExprConstants;
922 ConstantUniqueMap<InlineAsm> InlineAsms;
924 ConstantInt *TheTrueVal;
925 ConstantInt *TheFalseVal;
927 // Basic type instances.
928 Type VoidTy, LabelTy, HalfTy, FloatTy, DoubleTy, MetadataTy, TokenTy;
929 Type X86_FP80Ty, FP128Ty, PPC_FP128Ty, X86_MMXTy;
930 IntegerType Int1Ty, Int8Ty, Int16Ty, Int32Ty, Int64Ty, Int128Ty;
933 /// TypeAllocator - All dynamically allocated types are allocated from this.
934 /// They live forever until the context is torn down.
935 BumpPtrAllocator TypeAllocator;
937 DenseMap<unsigned, IntegerType*> IntegerTypes;
939 typedef DenseSet<FunctionType *, FunctionTypeKeyInfo> FunctionTypeSet;
940 FunctionTypeSet FunctionTypes;
941 typedef DenseSet<StructType *, AnonStructTypeKeyInfo> StructTypeSet;
942 StructTypeSet AnonStructTypes;
943 StringMap<StructType*> NamedStructTypes;
944 unsigned NamedStructTypesUniqueID;
946 DenseMap<std::pair<Type *, uint64_t>, ArrayType*> ArrayTypes;
947 DenseMap<std::pair<Type *, unsigned>, VectorType*> VectorTypes;
948 DenseMap<Type*, PointerType*> PointerTypes; // Pointers in AddrSpace = 0
949 DenseMap<std::pair<Type*, unsigned>, PointerType*> ASPointerTypes;
952 /// ValueHandles - This map keeps track of all of the value handles that are
953 /// watching a Value*. The Value::HasValueHandle bit is used to know
954 /// whether or not a value has an entry in this map.
955 typedef DenseMap<Value*, ValueHandleBase*> ValueHandlesTy;
956 ValueHandlesTy ValueHandles;
958 /// CustomMDKindNames - Map to hold the metadata string to ID mapping.
959 StringMap<unsigned> CustomMDKindNames;
961 /// Collection of per-instruction metadata used in this context.
962 DenseMap<const Instruction *, MDAttachmentMap> InstructionMetadata;
964 /// Collection of per-function metadata used in this context.
965 DenseMap<const Function *, MDAttachmentMap> FunctionMetadata;
967 /// DiscriminatorTable - This table maps file:line locations to an
968 /// integer representing the next DWARF path discriminator to assign to
969 /// instructions in different blocks at the same location.
970 DenseMap<std::pair<const char *, unsigned>, unsigned> DiscriminatorTable;
972 typedef DenseMap<const Function *, ReturnInst *> FunctionDataMapTy;
974 /// \brief Mapping from a function to its prefix data, which is stored as the
975 /// operand of an unparented ReturnInst so that the prefix data has a Use.
976 FunctionDataMapTy PrefixDataMap;
978 /// \brief Mapping from a function to its prologue data, which is stored as
979 /// the operand of an unparented ReturnInst so that the prologue data has a
981 FunctionDataMapTy PrologueDataMap;
983 int getOrAddScopeRecordIdxEntry(MDNode *N, int ExistingIdx);
984 int getOrAddScopeInlinedAtIdxEntry(MDNode *Scope, MDNode *IA,int ExistingIdx);
986 /// \brief A set of interned tags for operand bundles. The StringMap maps
987 /// bundle tags to their IDs.
989 /// \see LLVMContext::getOperandBundleTagID
990 StringMap<uint32_t> BundleTagCache;
992 StringMapEntry<uint32_t> *getOrInsertBundleTag(StringRef Tag);
993 void getOperandBundleTags(SmallVectorImpl<StringRef> &Tags) const;
994 uint32_t getOperandBundleTagID(StringRef Tag) const;
996 LLVMContextImpl(LLVMContext &C);
999 /// Destroy the ConstantArrays if they are not used.
1000 void dropTriviallyDeadConstantArrays();