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<DICompileUnit> {
462 unsigned SourceLanguage;
467 unsigned RuntimeVersion;
468 StringRef SplitDebugFilename;
469 unsigned EmissionKind;
471 Metadata *RetainedTypes;
472 Metadata *Subprograms;
473 Metadata *GlobalVariables;
474 Metadata *ImportedEntities;
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()) {}
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();
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);
522 template <> struct MDNodeKeyImpl<DISubprogram> {
525 StringRef LinkageName;
532 Metadata *ContainingType;
534 unsigned VirtualIndex;
538 Metadata *TemplateParams;
539 Metadata *Declaration;
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()) {}
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();
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);
592 template <> struct MDNodeKeyImpl<DILexicalBlock> {
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()) {}
604 bool isKeyOf(const DILexicalBlock *RHS) const {
605 return Scope == RHS->getRawScope() && File == RHS->getRawFile() &&
606 Line == RHS->getLine() && Column == RHS->getColumn();
608 unsigned getHashValue() const {
609 return hash_combine(Scope, File, Line, Column);
613 template <> struct MDNodeKeyImpl<DILexicalBlockFile> {
616 unsigned Discriminator;
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()) {}
624 bool isKeyOf(const DILexicalBlockFile *RHS) const {
625 return Scope == RHS->getRawScope() && File == RHS->getRawFile() &&
626 Discriminator == RHS->getDiscriminator();
628 unsigned getHashValue() const {
629 return hash_combine(Scope, File, Discriminator);
633 template <> struct MDNodeKeyImpl<DINamespace> {
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()) {}
645 bool isKeyOf(const DINamespace *RHS) const {
646 return Scope == RHS->getRawScope() && File == RHS->getRawFile() &&
647 Name == RHS->getName() && Line == RHS->getLine();
649 unsigned getHashValue() const {
650 return hash_combine(Scope, File, Name, Line);
654 template <> struct MDNodeKeyImpl<DIModule> {
657 StringRef ConfigurationMacros;
658 StringRef IncludePath;
660 MDNodeKeyImpl(Metadata *Scope, StringRef Name,
661 StringRef ConfigurationMacros,
662 StringRef IncludePath,
664 : Scope(Scope), Name(Name), ConfigurationMacros(ConfigurationMacros),
665 IncludePath(IncludePath), ISysRoot(ISysRoot) {}
666 MDNodeKeyImpl(const DIModule *N)
667 : Scope(N->getRawScope()), Name(N->getName()),
668 ConfigurationMacros(N->getConfigurationMacros()),
669 IncludePath(N->getIncludePath()), ISysRoot(N->getISysRoot()) {}
671 bool isKeyOf(const DIModule *RHS) const {
672 return Scope == RHS->getRawScope() && Name == RHS->getName() &&
673 ConfigurationMacros == RHS->getConfigurationMacros() &&
674 IncludePath == RHS->getIncludePath() &&
675 ISysRoot == RHS->getISysRoot();
677 unsigned getHashValue() const {
678 return hash_combine(Scope, Name,
679 ConfigurationMacros, IncludePath, ISysRoot);
683 template <> struct MDNodeKeyImpl<DITemplateTypeParameter> {
687 MDNodeKeyImpl(StringRef Name, Metadata *Type) : Name(Name), Type(Type) {}
688 MDNodeKeyImpl(const DITemplateTypeParameter *N)
689 : Name(N->getName()), Type(N->getRawType()) {}
691 bool isKeyOf(const DITemplateTypeParameter *RHS) const {
692 return Name == RHS->getName() && Type == RHS->getRawType();
694 unsigned getHashValue() const { return hash_combine(Name, Type); }
697 template <> struct MDNodeKeyImpl<DITemplateValueParameter> {
703 MDNodeKeyImpl(unsigned Tag, StringRef Name, Metadata *Type, Metadata *Value)
704 : Tag(Tag), Name(Name), Type(Type), Value(Value) {}
705 MDNodeKeyImpl(const DITemplateValueParameter *N)
706 : Tag(N->getTag()), Name(N->getName()), Type(N->getRawType()),
707 Value(N->getValue()) {}
709 bool isKeyOf(const DITemplateValueParameter *RHS) const {
710 return Tag == RHS->getTag() && Name == RHS->getName() &&
711 Type == RHS->getRawType() && Value == RHS->getValue();
713 unsigned getHashValue() const { return hash_combine(Tag, Name, Type, Value); }
716 template <> struct MDNodeKeyImpl<DIGlobalVariable> {
719 StringRef LinkageName;
726 Metadata *StaticDataMemberDeclaration;
728 MDNodeKeyImpl(Metadata *Scope, StringRef Name, StringRef LinkageName,
729 Metadata *File, unsigned Line, Metadata *Type,
730 bool IsLocalToUnit, bool IsDefinition, Metadata *Variable,
731 Metadata *StaticDataMemberDeclaration)
732 : Scope(Scope), Name(Name), LinkageName(LinkageName), File(File),
733 Line(Line), Type(Type), IsLocalToUnit(IsLocalToUnit),
734 IsDefinition(IsDefinition), Variable(Variable),
735 StaticDataMemberDeclaration(StaticDataMemberDeclaration) {}
736 MDNodeKeyImpl(const DIGlobalVariable *N)
737 : Scope(N->getRawScope()), Name(N->getName()),
738 LinkageName(N->getLinkageName()), File(N->getRawFile()),
739 Line(N->getLine()), Type(N->getRawType()),
740 IsLocalToUnit(N->isLocalToUnit()), IsDefinition(N->isDefinition()),
741 Variable(N->getRawVariable()),
742 StaticDataMemberDeclaration(N->getRawStaticDataMemberDeclaration()) {}
744 bool isKeyOf(const DIGlobalVariable *RHS) const {
745 return Scope == RHS->getRawScope() && Name == RHS->getName() &&
746 LinkageName == RHS->getLinkageName() && File == RHS->getRawFile() &&
747 Line == RHS->getLine() && Type == RHS->getRawType() &&
748 IsLocalToUnit == RHS->isLocalToUnit() &&
749 IsDefinition == RHS->isDefinition() &&
750 Variable == RHS->getRawVariable() &&
751 StaticDataMemberDeclaration ==
752 RHS->getRawStaticDataMemberDeclaration();
754 unsigned getHashValue() const {
755 return hash_combine(Scope, Name, LinkageName, File, Line, Type,
756 IsLocalToUnit, IsDefinition, Variable,
757 StaticDataMemberDeclaration);
761 template <> struct MDNodeKeyImpl<DILocalVariable> {
771 MDNodeKeyImpl(unsigned Tag, Metadata *Scope, StringRef Name, Metadata *File,
772 unsigned Line, Metadata *Type, unsigned Arg, unsigned Flags)
773 : Tag(Tag), Scope(Scope), Name(Name), File(File), Line(Line), Type(Type),
774 Arg(Arg), Flags(Flags) {}
775 MDNodeKeyImpl(const DILocalVariable *N)
776 : Tag(N->getTag()), Scope(N->getRawScope()), Name(N->getName()),
777 File(N->getRawFile()), Line(N->getLine()), Type(N->getRawType()),
778 Arg(N->getArg()), Flags(N->getFlags()) {}
780 bool isKeyOf(const DILocalVariable *RHS) const {
781 return Tag == RHS->getTag() && Scope == RHS->getRawScope() &&
782 Name == RHS->getName() && File == RHS->getRawFile() &&
783 Line == RHS->getLine() && Type == RHS->getRawType() &&
784 Arg == RHS->getArg() && Flags == RHS->getFlags();
786 unsigned getHashValue() const {
787 return hash_combine(Tag, Scope, Name, File, Line, Type, Arg, Flags);
791 template <> struct MDNodeKeyImpl<DIExpression> {
792 ArrayRef<uint64_t> Elements;
794 MDNodeKeyImpl(ArrayRef<uint64_t> Elements) : Elements(Elements) {}
795 MDNodeKeyImpl(const DIExpression *N) : Elements(N->getElements()) {}
797 bool isKeyOf(const DIExpression *RHS) const {
798 return Elements == RHS->getElements();
800 unsigned getHashValue() const {
801 return hash_combine_range(Elements.begin(), Elements.end());
805 template <> struct MDNodeKeyImpl<DIObjCProperty> {
809 StringRef GetterName;
810 StringRef SetterName;
814 MDNodeKeyImpl(StringRef Name, Metadata *File, unsigned Line,
815 StringRef GetterName, StringRef SetterName, unsigned Attributes,
817 : Name(Name), File(File), Line(Line), GetterName(GetterName),
818 SetterName(SetterName), Attributes(Attributes), Type(Type) {}
819 MDNodeKeyImpl(const DIObjCProperty *N)
820 : Name(N->getName()), File(N->getRawFile()), Line(N->getLine()),
821 GetterName(N->getGetterName()), SetterName(N->getSetterName()),
822 Attributes(N->getAttributes()), Type(N->getRawType()) {}
824 bool isKeyOf(const DIObjCProperty *RHS) const {
825 return Name == RHS->getName() && File == RHS->getRawFile() &&
826 Line == RHS->getLine() && GetterName == RHS->getGetterName() &&
827 SetterName == RHS->getSetterName() &&
828 Attributes == RHS->getAttributes() && Type == RHS->getRawType();
830 unsigned getHashValue() const {
831 return hash_combine(Name, File, Line, GetterName, SetterName, Attributes,
836 template <> struct MDNodeKeyImpl<DIImportedEntity> {
843 MDNodeKeyImpl(unsigned Tag, Metadata *Scope, Metadata *Entity, unsigned Line,
845 : Tag(Tag), Scope(Scope), Entity(Entity), Line(Line), Name(Name) {}
846 MDNodeKeyImpl(const DIImportedEntity *N)
847 : Tag(N->getTag()), Scope(N->getRawScope()), Entity(N->getRawEntity()),
848 Line(N->getLine()), Name(N->getName()) {}
850 bool isKeyOf(const DIImportedEntity *RHS) const {
851 return Tag == RHS->getTag() && Scope == RHS->getRawScope() &&
852 Entity == RHS->getRawEntity() && Line == RHS->getLine() &&
853 Name == RHS->getName();
855 unsigned getHashValue() const {
856 return hash_combine(Tag, Scope, Entity, Line, Name);
860 /// \brief DenseMapInfo for MDNode subclasses.
861 template <class NodeTy> struct MDNodeInfo {
862 typedef MDNodeKeyImpl<NodeTy> KeyTy;
863 static inline NodeTy *getEmptyKey() {
864 return DenseMapInfo<NodeTy *>::getEmptyKey();
866 static inline NodeTy *getTombstoneKey() {
867 return DenseMapInfo<NodeTy *>::getTombstoneKey();
869 static unsigned getHashValue(const KeyTy &Key) { return Key.getHashValue(); }
870 static unsigned getHashValue(const NodeTy *N) {
871 return KeyTy(N).getHashValue();
873 static bool isEqual(const KeyTy &LHS, const NodeTy *RHS) {
874 if (RHS == getEmptyKey() || RHS == getTombstoneKey())
876 return LHS.isKeyOf(RHS);
878 static bool isEqual(const NodeTy *LHS, const NodeTy *RHS) {
883 #define HANDLE_MDNODE_LEAF(CLASS) typedef MDNodeInfo<CLASS> CLASS##Info;
884 #include "llvm/IR/Metadata.def"
886 /// \brief Map-like storage for metadata attachments.
887 class MDAttachmentMap {
888 SmallVector<std::pair<unsigned, TrackingMDNodeRef>, 2> Attachments;
891 bool empty() const { return Attachments.empty(); }
892 size_t size() const { return Attachments.size(); }
894 /// \brief Get a particular attachment (if any).
895 MDNode *lookup(unsigned ID) const;
897 /// \brief Set an attachment to a particular node.
899 /// Set the \c ID attachment to \c MD, replacing the current attachment at \c
901 void set(unsigned ID, MDNode &MD);
903 /// \brief Remove an attachment.
905 /// Remove the attachment at \c ID, if any.
906 void erase(unsigned ID);
908 /// \brief Copy out all the attachments.
910 /// Copies all the current attachments into \c Result, sorting by attachment
911 /// ID. This function does \em not clear \c Result.
912 void getAll(SmallVectorImpl<std::pair<unsigned, MDNode *>> &Result) const;
914 /// \brief Erase matching attachments.
916 /// Erases all attachments matching the \c shouldRemove predicate.
917 template <class PredTy> void remove_if(PredTy shouldRemove) {
919 std::remove_if(Attachments.begin(), Attachments.end(), shouldRemove),
924 class LLVMContextImpl {
926 /// OwnedModules - The set of modules instantiated in this context, and which
927 /// will be automatically deleted if this context is deleted.
928 SmallPtrSet<Module*, 4> OwnedModules;
930 LLVMContext::InlineAsmDiagHandlerTy InlineAsmDiagHandler;
931 void *InlineAsmDiagContext;
933 LLVMContext::DiagnosticHandlerTy DiagnosticHandler;
934 void *DiagnosticContext;
935 bool RespectDiagnosticFilters;
937 LLVMContext::YieldCallbackTy YieldCallback;
938 void *YieldOpaqueHandle;
940 typedef DenseMap<APInt, ConstantInt *, DenseMapAPIntKeyInfo> IntMapTy;
941 IntMapTy IntConstants;
943 typedef DenseMap<APFloat, ConstantFP *, DenseMapAPFloatKeyInfo> FPMapTy;
946 FoldingSet<AttributeImpl> AttrsSet;
947 FoldingSet<AttributeSetImpl> AttrsLists;
948 FoldingSet<AttributeSetNode> AttrsSetNodes;
950 StringMap<MDString> MDStringCache;
951 DenseMap<Value *, ValueAsMetadata *> ValuesAsMetadata;
952 DenseMap<Metadata *, MetadataAsValue *> MetadataAsValues;
954 DenseMap<const Value*, ValueName*> ValueNames;
956 #define HANDLE_MDNODE_LEAF(CLASS) DenseSet<CLASS *, CLASS##Info> CLASS##s;
957 #include "llvm/IR/Metadata.def"
959 // MDNodes may be uniqued or not uniqued. When they're not uniqued, they
960 // aren't in the MDNodeSet, but they're still shared between objects, so no
961 // one object can destroy them. This set allows us to at least destroy them
962 // on Context destruction.
963 SmallPtrSet<MDNode *, 1> DistinctMDNodes;
965 DenseMap<Type*, ConstantAggregateZero*> CAZConstants;
967 typedef ConstantUniqueMap<ConstantArray> ArrayConstantsTy;
968 ArrayConstantsTy ArrayConstants;
970 typedef ConstantUniqueMap<ConstantStruct> StructConstantsTy;
971 StructConstantsTy StructConstants;
973 typedef ConstantUniqueMap<ConstantVector> VectorConstantsTy;
974 VectorConstantsTy VectorConstants;
976 DenseMap<PointerType*, ConstantPointerNull*> CPNConstants;
978 DenseMap<Type*, UndefValue*> UVConstants;
980 StringMap<ConstantDataSequential*> CDSConstants;
982 DenseMap<std::pair<const Function *, const BasicBlock *>, BlockAddress *>
984 ConstantUniqueMap<ConstantExpr> ExprConstants;
986 ConstantUniqueMap<InlineAsm> InlineAsms;
988 ConstantInt *TheTrueVal;
989 ConstantInt *TheFalseVal;
991 // Basic type instances.
992 Type VoidTy, LabelTy, HalfTy, FloatTy, DoubleTy, MetadataTy;
993 Type X86_FP80Ty, FP128Ty, PPC_FP128Ty, X86_MMXTy;
994 IntegerType Int1Ty, Int8Ty, Int16Ty, Int32Ty, Int64Ty, Int128Ty;
997 /// TypeAllocator - All dynamically allocated types are allocated from this.
998 /// They live forever until the context is torn down.
999 BumpPtrAllocator TypeAllocator;
1001 DenseMap<unsigned, IntegerType*> IntegerTypes;
1003 typedef DenseSet<FunctionType *, FunctionTypeKeyInfo> FunctionTypeSet;
1004 FunctionTypeSet FunctionTypes;
1005 typedef DenseSet<StructType *, AnonStructTypeKeyInfo> StructTypeSet;
1006 StructTypeSet AnonStructTypes;
1007 StringMap<StructType*> NamedStructTypes;
1008 unsigned NamedStructTypesUniqueID;
1010 DenseMap<std::pair<Type *, uint64_t>, ArrayType*> ArrayTypes;
1011 DenseMap<std::pair<Type *, unsigned>, VectorType*> VectorTypes;
1012 DenseMap<Type*, PointerType*> PointerTypes; // Pointers in AddrSpace = 0
1013 DenseMap<std::pair<Type*, unsigned>, PointerType*> ASPointerTypes;
1016 /// ValueHandles - This map keeps track of all of the value handles that are
1017 /// watching a Value*. The Value::HasValueHandle bit is used to know
1018 /// whether or not a value has an entry in this map.
1019 typedef DenseMap<Value*, ValueHandleBase*> ValueHandlesTy;
1020 ValueHandlesTy ValueHandles;
1022 /// CustomMDKindNames - Map to hold the metadata string to ID mapping.
1023 StringMap<unsigned> CustomMDKindNames;
1025 /// Collection of per-instruction metadata used in this context.
1026 DenseMap<const Instruction *, MDAttachmentMap> InstructionMetadata;
1028 /// Collection of per-function metadata used in this context.
1029 DenseMap<const Function *, MDAttachmentMap> FunctionMetadata;
1031 /// DiscriminatorTable - This table maps file:line locations to an
1032 /// integer representing the next DWARF path discriminator to assign to
1033 /// instructions in different blocks at the same location.
1034 DenseMap<std::pair<const char *, unsigned>, unsigned> DiscriminatorTable;
1036 /// \brief Mapping from a function to its prefix data, which is stored as the
1037 /// operand of an unparented ReturnInst so that the prefix data has a Use.
1038 typedef DenseMap<const Function *, ReturnInst *> PrefixDataMapTy;
1039 PrefixDataMapTy PrefixDataMap;
1041 /// \brief Mapping from a function to its prologue data, which is stored as
1042 /// the operand of an unparented ReturnInst so that the prologue data has a
1044 typedef DenseMap<const Function *, ReturnInst *> PrologueDataMapTy;
1045 PrologueDataMapTy PrologueDataMap;
1047 int getOrAddScopeRecordIdxEntry(MDNode *N, int ExistingIdx);
1048 int getOrAddScopeInlinedAtIdxEntry(MDNode *Scope, MDNode *IA,int ExistingIdx);
1050 LLVMContextImpl(LLVMContext &C);
1053 /// Destroy the ConstantArrays if they are not used.
1054 void dropTriviallyDeadConstantArrays();