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 MDLocation.
232 template <> struct MDNodeKeyImpl<MDLocation> {
238 MDNodeKeyImpl(unsigned Line, unsigned Column, Metadata *Scope,
240 : Line(Line), Column(Column), Scope(Scope), InlinedAt(InlinedAt) {}
242 MDNodeKeyImpl(const MDLocation *L)
243 : Line(L->getLine()), Column(L->getColumn()), Scope(L->getRawScope()),
244 InlinedAt(L->getRawInlinedAt()) {}
246 bool isKeyOf(const MDLocation *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 GenericDebugNode.
256 template <> struct MDNodeKeyImpl<GenericDebugNode> : MDNodeOpsKey {
259 MDNodeKeyImpl(unsigned Tag, StringRef Header, ArrayRef<Metadata *> DwarfOps)
260 : MDNodeOpsKey(DwarfOps), Tag(Tag), Header(Header) {}
261 MDNodeKeyImpl(const GenericDebugNode *N)
262 : MDNodeOpsKey(N, 1), Tag(N->getTag()), Header(N->getHeader()) {}
264 bool isKeyOf(const GenericDebugNode *RHS) const {
265 return Tag == RHS->getTag() && Header == RHS->getHeader() &&
269 unsigned getHashValue() const { return hash_combine(getHash(), Tag, Header); }
271 static unsigned calculateHash(GenericDebugNode *N) {
272 return MDNodeOpsKey::calculateHash(N, 1);
276 template <> struct MDNodeKeyImpl<MDSubrange> {
280 MDNodeKeyImpl(int64_t Count, int64_t LowerBound)
281 : Count(Count), LowerBound(LowerBound) {}
282 MDNodeKeyImpl(const MDSubrange *N)
283 : Count(N->getCount()), LowerBound(N->getLowerBound()) {}
285 bool isKeyOf(const MDSubrange *RHS) const {
286 return Count == RHS->getCount() && LowerBound == RHS->getLowerBound();
288 unsigned getHashValue() const { return hash_combine(Count, LowerBound); }
291 template <> struct MDNodeKeyImpl<MDEnumerator> {
295 MDNodeKeyImpl(int64_t Value, StringRef Name) : Value(Value), Name(Name) {}
296 MDNodeKeyImpl(const MDEnumerator *N)
297 : Value(N->getValue()), Name(N->getName()) {}
299 bool isKeyOf(const MDEnumerator *RHS) const {
300 return Value == RHS->getValue() && Name == RHS->getName();
302 unsigned getHashValue() const { return hash_combine(Value, Name); }
305 template <> struct MDNodeKeyImpl<MDBasicType> {
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 MDBasicType *N)
317 : Tag(N->getTag()), Name(N->getName()), SizeInBits(N->getSizeInBits()),
318 AlignInBits(N->getAlignInBits()), Encoding(N->getEncoding()) {}
320 bool isKeyOf(const MDBasicType *RHS) const {
321 return Tag == RHS->getTag() && Name == RHS->getName() &&
322 SizeInBits == RHS->getSizeInBits() &&
323 AlignInBits == RHS->getAlignInBits() &&
324 Encoding == RHS->getEncoding();
326 unsigned getHashValue() const {
327 return hash_combine(Tag, Name, SizeInBits, AlignInBits, Encoding);
331 template <> struct MDNodeKeyImpl<MDDerivedType> {
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 MDDerivedType *N)
352 : Tag(N->getTag()), Name(N->getName()), File(N->getRawFile()),
353 Line(N->getLine()), Scope(N->getRawScope()),
354 BaseType(N->getRawBaseType()), SizeInBits(N->getSizeInBits()),
355 AlignInBits(N->getAlignInBits()), OffsetInBits(N->getOffsetInBits()),
356 Flags(N->getFlags()), ExtraData(N->getRawExtraData()) {}
358 bool isKeyOf(const MDDerivedType *RHS) const {
359 return Tag == RHS->getTag() && Name == RHS->getName() &&
360 File == RHS->getRawFile() && Line == RHS->getLine() &&
361 Scope == RHS->getRawScope() && BaseType == RHS->getRawBaseType() &&
362 SizeInBits == RHS->getSizeInBits() &&
363 AlignInBits == RHS->getAlignInBits() &&
364 OffsetInBits == RHS->getOffsetInBits() && Flags == RHS->getFlags() &&
365 ExtraData == RHS->getRawExtraData();
367 unsigned getHashValue() const {
368 return hash_combine(Tag, Name, File, Line, Scope, BaseType, SizeInBits,
369 AlignInBits, OffsetInBits, Flags, ExtraData);
373 template <> struct MDNodeKeyImpl<MDCompositeType> {
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 MDCompositeType *N)
402 : Tag(N->getTag()), Name(N->getName()), File(N->getRawFile()),
403 Line(N->getLine()), Scope(N->getRawScope()),
404 BaseType(N->getRawBaseType()), SizeInBits(N->getSizeInBits()),
405 AlignInBits(N->getAlignInBits()), OffsetInBits(N->getOffsetInBits()),
406 Flags(N->getFlags()), Elements(N->getRawElements()),
407 RuntimeLang(N->getRuntimeLang()), VTableHolder(N->getRawVTableHolder()),
408 TemplateParams(N->getRawTemplateParams()),
409 Identifier(N->getIdentifier()) {}
411 bool isKeyOf(const MDCompositeType *RHS) const {
412 return Tag == RHS->getTag() && Name == RHS->getName() &&
413 File == RHS->getRawFile() && Line == RHS->getLine() &&
414 Scope == RHS->getRawScope() && BaseType == RHS->getRawBaseType() &&
415 SizeInBits == RHS->getSizeInBits() &&
416 AlignInBits == RHS->getAlignInBits() &&
417 OffsetInBits == RHS->getOffsetInBits() && Flags == RHS->getFlags() &&
418 Elements == RHS->getRawElements() &&
419 RuntimeLang == RHS->getRuntimeLang() &&
420 VTableHolder == RHS->getRawVTableHolder() &&
421 TemplateParams == RHS->getRawTemplateParams() &&
422 Identifier == RHS->getIdentifier();
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<MDSubroutineType> {
435 MDNodeKeyImpl(int64_t Flags, Metadata *TypeArray)
436 : Flags(Flags), TypeArray(TypeArray) {}
437 MDNodeKeyImpl(const MDSubroutineType *N)
438 : Flags(N->getFlags()), TypeArray(N->getRawTypeArray()) {}
440 bool isKeyOf(const MDSubroutineType *RHS) const {
441 return Flags == RHS->getFlags() && TypeArray == RHS->getRawTypeArray();
443 unsigned getHashValue() const { return hash_combine(Flags, TypeArray); }
446 template <> struct MDNodeKeyImpl<MDFile> {
450 MDNodeKeyImpl(StringRef Filename, StringRef Directory)
451 : Filename(Filename), Directory(Directory) {}
452 MDNodeKeyImpl(const MDFile *N)
453 : Filename(N->getFilename()), Directory(N->getDirectory()) {}
455 bool isKeyOf(const MDFile *RHS) const {
456 return Filename == RHS->getFilename() && Directory == RHS->getDirectory();
458 unsigned getHashValue() const { return hash_combine(Filename, Directory); }
461 template <> struct MDNodeKeyImpl<MDCompileUnit> {
462 unsigned SourceLanguage;
467 unsigned RuntimeVersion;
468 StringRef SplitDebugFilename;
469 unsigned EmissionKind;
471 Metadata *RetainedTypes;
472 Metadata *Subprograms;
473 Metadata *GlobalVariables;
474 Metadata *ImportedEntities;
476 MDNodeKeyImpl(unsigned SourceLanguage, Metadata *File, StringRef Producer,
477 bool IsOptimized, StringRef Flags, unsigned RuntimeVersion,
478 StringRef SplitDebugFilename, unsigned EmissionKind,
479 Metadata *EnumTypes, Metadata *RetainedTypes,
480 Metadata *Subprograms, Metadata *GlobalVariables,
481 Metadata *ImportedEntities)
482 : SourceLanguage(SourceLanguage), File(File), Producer(Producer),
483 IsOptimized(IsOptimized), Flags(Flags), RuntimeVersion(RuntimeVersion),
484 SplitDebugFilename(SplitDebugFilename), EmissionKind(EmissionKind),
485 EnumTypes(EnumTypes), RetainedTypes(RetainedTypes),
486 Subprograms(Subprograms), GlobalVariables(GlobalVariables),
487 ImportedEntities(ImportedEntities) {}
488 MDNodeKeyImpl(const MDCompileUnit *N)
489 : SourceLanguage(N->getSourceLanguage()), File(N->getRawFile()),
490 Producer(N->getProducer()), IsOptimized(N->isOptimized()),
491 Flags(N->getFlags()), RuntimeVersion(N->getRuntimeVersion()),
492 SplitDebugFilename(N->getSplitDebugFilename()),
493 EmissionKind(N->getEmissionKind()), EnumTypes(N->getRawEnumTypes()),
494 RetainedTypes(N->getRawRetainedTypes()),
495 Subprograms(N->getRawSubprograms()),
496 GlobalVariables(N->getRawGlobalVariables()),
497 ImportedEntities(N->getRawImportedEntities()) {}
499 bool isKeyOf(const MDCompileUnit *RHS) const {
500 return SourceLanguage == RHS->getSourceLanguage() &&
501 File == RHS->getRawFile() && Producer == RHS->getProducer() &&
502 IsOptimized == RHS->isOptimized() && Flags == RHS->getFlags() &&
503 RuntimeVersion == RHS->getRuntimeVersion() &&
504 SplitDebugFilename == RHS->getSplitDebugFilename() &&
505 EmissionKind == RHS->getEmissionKind() &&
506 EnumTypes == RHS->getRawEnumTypes() &&
507 RetainedTypes == RHS->getRawRetainedTypes() &&
508 Subprograms == RHS->getRawSubprograms() &&
509 GlobalVariables == RHS->getRawGlobalVariables() &&
510 ImportedEntities == RHS->getRawImportedEntities();
512 unsigned getHashValue() const {
513 return hash_combine(SourceLanguage, File, Producer, IsOptimized, Flags,
514 RuntimeVersion, SplitDebugFilename, EmissionKind,
515 EnumTypes, RetainedTypes, Subprograms, GlobalVariables,
520 template <> struct MDNodeKeyImpl<MDSubprogram> {
523 StringRef LinkageName;
530 Metadata *ContainingType;
532 unsigned VirtualIndex;
536 Metadata *TemplateParams;
537 Metadata *Declaration;
540 MDNodeKeyImpl(Metadata *Scope, StringRef Name, StringRef LinkageName,
541 Metadata *File, unsigned Line, Metadata *Type,
542 bool IsLocalToUnit, bool IsDefinition, unsigned ScopeLine,
543 Metadata *ContainingType, unsigned Virtuality,
544 unsigned VirtualIndex, unsigned Flags, bool IsOptimized,
545 Metadata *Function, Metadata *TemplateParams,
546 Metadata *Declaration, Metadata *Variables)
547 : Scope(Scope), Name(Name), LinkageName(LinkageName), File(File),
548 Line(Line), Type(Type), IsLocalToUnit(IsLocalToUnit),
549 IsDefinition(IsDefinition), ScopeLine(ScopeLine),
550 ContainingType(ContainingType), Virtuality(Virtuality),
551 VirtualIndex(VirtualIndex), Flags(Flags), IsOptimized(IsOptimized),
552 Function(Function), TemplateParams(TemplateParams),
553 Declaration(Declaration), Variables(Variables) {}
554 MDNodeKeyImpl(const MDSubprogram *N)
555 : Scope(N->getRawScope()), Name(N->getName()),
556 LinkageName(N->getLinkageName()), File(N->getRawFile()),
557 Line(N->getLine()), Type(N->getRawType()),
558 IsLocalToUnit(N->isLocalToUnit()), IsDefinition(N->isDefinition()),
559 ScopeLine(N->getScopeLine()), ContainingType(N->getRawContainingType()),
560 Virtuality(N->getVirtuality()), VirtualIndex(N->getVirtualIndex()),
561 Flags(N->getFlags()), IsOptimized(N->isOptimized()),
562 Function(N->getRawFunction()),
563 TemplateParams(N->getRawTemplateParams()),
564 Declaration(N->getRawDeclaration()), Variables(N->getRawVariables()) {}
566 bool isKeyOf(const MDSubprogram *RHS) const {
567 return Scope == RHS->getRawScope() && Name == RHS->getName() &&
568 LinkageName == RHS->getLinkageName() && File == RHS->getRawFile() &&
569 Line == RHS->getLine() && Type == RHS->getRawType() &&
570 IsLocalToUnit == RHS->isLocalToUnit() &&
571 IsDefinition == RHS->isDefinition() &&
572 ScopeLine == RHS->getScopeLine() &&
573 ContainingType == RHS->getRawContainingType() &&
574 Virtuality == RHS->getVirtuality() &&
575 VirtualIndex == RHS->getVirtualIndex() && Flags == RHS->getFlags() &&
576 IsOptimized == RHS->isOptimized() &&
577 Function == RHS->getRawFunction() &&
578 TemplateParams == RHS->getRawTemplateParams() &&
579 Declaration == RHS->getRawDeclaration() &&
580 Variables == RHS->getRawVariables();
582 unsigned getHashValue() const {
583 return hash_combine(Scope, Name, LinkageName, File, Line, Type,
584 IsLocalToUnit, IsDefinition, ScopeLine, ContainingType,
585 Virtuality, VirtualIndex, Flags, IsOptimized, Function,
586 TemplateParams, Declaration, Variables);
590 template <> struct MDNodeKeyImpl<MDLexicalBlock> {
596 MDNodeKeyImpl(Metadata *Scope, Metadata *File, unsigned Line, unsigned Column)
597 : Scope(Scope), File(File), Line(Line), Column(Column) {}
598 MDNodeKeyImpl(const MDLexicalBlock *N)
599 : Scope(N->getRawScope()), File(N->getRawFile()), Line(N->getLine()),
600 Column(N->getColumn()) {}
602 bool isKeyOf(const MDLexicalBlock *RHS) const {
603 return Scope == RHS->getRawScope() && File == RHS->getRawFile() &&
604 Line == RHS->getLine() && Column == RHS->getColumn();
606 unsigned getHashValue() const {
607 return hash_combine(Scope, File, Line, Column);
611 template <> struct MDNodeKeyImpl<MDLexicalBlockFile> {
614 unsigned Discriminator;
616 MDNodeKeyImpl(Metadata *Scope, Metadata *File, unsigned Discriminator)
617 : Scope(Scope), File(File), Discriminator(Discriminator) {}
618 MDNodeKeyImpl(const MDLexicalBlockFile *N)
619 : Scope(N->getRawScope()), File(N->getRawFile()),
620 Discriminator(N->getDiscriminator()) {}
622 bool isKeyOf(const MDLexicalBlockFile *RHS) const {
623 return Scope == RHS->getRawScope() && File == RHS->getRawFile() &&
624 Discriminator == RHS->getDiscriminator();
626 unsigned getHashValue() const {
627 return hash_combine(Scope, File, Discriminator);
631 template <> struct MDNodeKeyImpl<MDNamespace> {
637 MDNodeKeyImpl(Metadata *Scope, Metadata *File, StringRef Name, unsigned Line)
638 : Scope(Scope), File(File), Name(Name), Line(Line) {}
639 MDNodeKeyImpl(const MDNamespace *N)
640 : Scope(N->getRawScope()), File(N->getRawFile()), Name(N->getName()),
641 Line(N->getLine()) {}
643 bool isKeyOf(const MDNamespace *RHS) const {
644 return Scope == RHS->getRawScope() && File == RHS->getRawFile() &&
645 Name == RHS->getName() && Line == RHS->getLine();
647 unsigned getHashValue() const {
648 return hash_combine(Scope, File, Name, Line);
652 template <> struct MDNodeKeyImpl<MDTemplateTypeParameter> {
656 MDNodeKeyImpl(StringRef Name, Metadata *Type) : Name(Name), Type(Type) {}
657 MDNodeKeyImpl(const MDTemplateTypeParameter *N)
658 : Name(N->getName()), Type(N->getRawType()) {}
660 bool isKeyOf(const MDTemplateTypeParameter *RHS) const {
661 return Name == RHS->getName() && Type == RHS->getRawType();
663 unsigned getHashValue() const { return hash_combine(Name, Type); }
666 template <> struct MDNodeKeyImpl<MDTemplateValueParameter> {
672 MDNodeKeyImpl(unsigned Tag, StringRef Name, Metadata *Type, Metadata *Value)
673 : Tag(Tag), Name(Name), Type(Type), Value(Value) {}
674 MDNodeKeyImpl(const MDTemplateValueParameter *N)
675 : Tag(N->getTag()), Name(N->getName()), Type(N->getRawType()),
676 Value(N->getValue()) {}
678 bool isKeyOf(const MDTemplateValueParameter *RHS) const {
679 return Tag == RHS->getTag() && Name == RHS->getName() &&
680 Type == RHS->getRawType() && Value == RHS->getValue();
682 unsigned getHashValue() const { return hash_combine(Tag, Name, Type, Value); }
685 template <> struct MDNodeKeyImpl<MDGlobalVariable> {
688 StringRef LinkageName;
695 Metadata *StaticDataMemberDeclaration;
697 MDNodeKeyImpl(Metadata *Scope, StringRef Name, StringRef LinkageName,
698 Metadata *File, unsigned Line, Metadata *Type,
699 bool IsLocalToUnit, bool IsDefinition, Metadata *Variable,
700 Metadata *StaticDataMemberDeclaration)
701 : Scope(Scope), Name(Name), LinkageName(LinkageName), File(File),
702 Line(Line), Type(Type), IsLocalToUnit(IsLocalToUnit),
703 IsDefinition(IsDefinition), Variable(Variable),
704 StaticDataMemberDeclaration(StaticDataMemberDeclaration) {}
705 MDNodeKeyImpl(const MDGlobalVariable *N)
706 : Scope(N->getRawScope()), Name(N->getName()),
707 LinkageName(N->getLinkageName()), File(N->getRawFile()),
708 Line(N->getLine()), Type(N->getRawType()),
709 IsLocalToUnit(N->isLocalToUnit()), IsDefinition(N->isDefinition()),
710 Variable(N->getRawVariable()),
711 StaticDataMemberDeclaration(N->getRawStaticDataMemberDeclaration()) {}
713 bool isKeyOf(const MDGlobalVariable *RHS) const {
714 return Scope == RHS->getRawScope() && Name == RHS->getName() &&
715 LinkageName == RHS->getLinkageName() && File == RHS->getRawFile() &&
716 Line == RHS->getLine() && Type == RHS->getRawType() &&
717 IsLocalToUnit == RHS->isLocalToUnit() &&
718 IsDefinition == RHS->isDefinition() &&
719 Variable == RHS->getRawVariable() &&
720 StaticDataMemberDeclaration ==
721 RHS->getRawStaticDataMemberDeclaration();
723 unsigned getHashValue() const {
724 return hash_combine(Scope, Name, LinkageName, File, Line, Type,
725 IsLocalToUnit, IsDefinition, Variable,
726 StaticDataMemberDeclaration);
730 template <> struct MDNodeKeyImpl<MDLocalVariable> {
740 MDNodeKeyImpl(unsigned Tag, Metadata *Scope, StringRef Name, Metadata *File,
741 unsigned Line, Metadata *Type, unsigned Arg, unsigned Flags)
742 : Tag(Tag), Scope(Scope), Name(Name), File(File), Line(Line), Type(Type),
743 Arg(Arg), Flags(Flags) {}
744 MDNodeKeyImpl(const MDLocalVariable *N)
745 : Tag(N->getTag()), Scope(N->getRawScope()), Name(N->getName()),
746 File(N->getRawFile()), Line(N->getLine()), Type(N->getRawType()),
747 Arg(N->getArg()), Flags(N->getFlags()) {}
749 bool isKeyOf(const MDLocalVariable *RHS) const {
750 return Tag == RHS->getTag() && Scope == RHS->getRawScope() &&
751 Name == RHS->getName() && File == RHS->getRawFile() &&
752 Line == RHS->getLine() && Type == RHS->getRawType() &&
753 Arg == RHS->getArg() && Flags == RHS->getFlags();
755 unsigned getHashValue() const {
756 return hash_combine(Tag, Scope, Name, File, Line, Type, Arg, Flags);
760 template <> struct MDNodeKeyImpl<MDExpression> {
761 ArrayRef<uint64_t> Elements;
763 MDNodeKeyImpl(ArrayRef<uint64_t> Elements) : Elements(Elements) {}
764 MDNodeKeyImpl(const MDExpression *N) : Elements(N->getElements()) {}
766 bool isKeyOf(const MDExpression *RHS) const {
767 return Elements == RHS->getElements();
769 unsigned getHashValue() const {
770 return hash_combine_range(Elements.begin(), Elements.end());
774 template <> struct MDNodeKeyImpl<MDObjCProperty> {
778 StringRef GetterName;
779 StringRef SetterName;
783 MDNodeKeyImpl(StringRef Name, Metadata *File, unsigned Line,
784 StringRef GetterName, StringRef SetterName, unsigned Attributes,
786 : Name(Name), File(File), Line(Line), GetterName(GetterName),
787 SetterName(SetterName), Attributes(Attributes), Type(Type) {}
788 MDNodeKeyImpl(const MDObjCProperty *N)
789 : Name(N->getName()), File(N->getRawFile()), Line(N->getLine()),
790 GetterName(N->getGetterName()), SetterName(N->getSetterName()),
791 Attributes(N->getAttributes()), Type(N->getRawType()) {}
793 bool isKeyOf(const MDObjCProperty *RHS) const {
794 return Name == RHS->getName() && File == RHS->getRawFile() &&
795 Line == RHS->getLine() && GetterName == RHS->getGetterName() &&
796 SetterName == RHS->getSetterName() &&
797 Attributes == RHS->getAttributes() && Type == RHS->getRawType();
799 unsigned getHashValue() const {
800 return hash_combine(Name, File, Line, GetterName, SetterName, Attributes,
805 template <> struct MDNodeKeyImpl<MDImportedEntity> {
812 MDNodeKeyImpl(unsigned Tag, Metadata *Scope, Metadata *Entity, unsigned Line,
814 : Tag(Tag), Scope(Scope), Entity(Entity), Line(Line), Name(Name) {}
815 MDNodeKeyImpl(const MDImportedEntity *N)
816 : Tag(N->getTag()), Scope(N->getRawScope()), Entity(N->getRawEntity()),
817 Line(N->getLine()), Name(N->getName()) {}
819 bool isKeyOf(const MDImportedEntity *RHS) const {
820 return Tag == RHS->getTag() && Scope == RHS->getRawScope() &&
821 Entity == RHS->getRawEntity() && Line == RHS->getLine() &&
822 Name == RHS->getName();
824 unsigned getHashValue() const {
825 return hash_combine(Tag, Scope, Entity, Line, Name);
829 /// \brief DenseMapInfo for MDNode subclasses.
830 template <class NodeTy> struct MDNodeInfo {
831 typedef MDNodeKeyImpl<NodeTy> KeyTy;
832 static inline NodeTy *getEmptyKey() {
833 return DenseMapInfo<NodeTy *>::getEmptyKey();
835 static inline NodeTy *getTombstoneKey() {
836 return DenseMapInfo<NodeTy *>::getTombstoneKey();
838 static unsigned getHashValue(const KeyTy &Key) { return Key.getHashValue(); }
839 static unsigned getHashValue(const NodeTy *N) {
840 return KeyTy(N).getHashValue();
842 static bool isEqual(const KeyTy &LHS, const NodeTy *RHS) {
843 if (RHS == getEmptyKey() || RHS == getTombstoneKey())
845 return LHS.isKeyOf(RHS);
847 static bool isEqual(const NodeTy *LHS, const NodeTy *RHS) {
852 #define HANDLE_MDNODE_LEAF(CLASS) typedef MDNodeInfo<CLASS> CLASS##Info;
853 #include "llvm/IR/Metadata.def"
855 class LLVMContextImpl {
857 /// OwnedModules - The set of modules instantiated in this context, and which
858 /// will be automatically deleted if this context is deleted.
859 SmallPtrSet<Module*, 4> OwnedModules;
861 LLVMContext::InlineAsmDiagHandlerTy InlineAsmDiagHandler;
862 void *InlineAsmDiagContext;
864 LLVMContext::DiagnosticHandlerTy DiagnosticHandler;
865 void *DiagnosticContext;
866 bool RespectDiagnosticFilters;
868 LLVMContext::YieldCallbackTy YieldCallback;
869 void *YieldOpaqueHandle;
871 typedef DenseMap<APInt, ConstantInt *, DenseMapAPIntKeyInfo> IntMapTy;
872 IntMapTy IntConstants;
874 typedef DenseMap<APFloat, ConstantFP *, DenseMapAPFloatKeyInfo> FPMapTy;
877 FoldingSet<AttributeImpl> AttrsSet;
878 FoldingSet<AttributeSetImpl> AttrsLists;
879 FoldingSet<AttributeSetNode> AttrsSetNodes;
881 StringMap<MDString> MDStringCache;
882 DenseMap<Value *, ValueAsMetadata *> ValuesAsMetadata;
883 DenseMap<Metadata *, MetadataAsValue *> MetadataAsValues;
885 #define HANDLE_MDNODE_LEAF(CLASS) DenseSet<CLASS *, CLASS##Info> CLASS##s;
886 #include "llvm/IR/Metadata.def"
888 // MDNodes may be uniqued or not uniqued. When they're not uniqued, they
889 // aren't in the MDNodeSet, but they're still shared between objects, so no
890 // one object can destroy them. This set allows us to at least destroy them
891 // on Context destruction.
892 SmallPtrSet<MDNode *, 1> DistinctMDNodes;
894 DenseMap<Type*, ConstantAggregateZero*> CAZConstants;
896 typedef ConstantUniqueMap<ConstantArray> ArrayConstantsTy;
897 ArrayConstantsTy ArrayConstants;
899 typedef ConstantUniqueMap<ConstantStruct> StructConstantsTy;
900 StructConstantsTy StructConstants;
902 typedef ConstantUniqueMap<ConstantVector> VectorConstantsTy;
903 VectorConstantsTy VectorConstants;
905 DenseMap<PointerType*, ConstantPointerNull*> CPNConstants;
907 DenseMap<Type*, UndefValue*> UVConstants;
909 StringMap<ConstantDataSequential*> CDSConstants;
911 DenseMap<std::pair<const Function *, const BasicBlock *>, BlockAddress *>
913 ConstantUniqueMap<ConstantExpr> ExprConstants;
915 ConstantUniqueMap<InlineAsm> InlineAsms;
917 ConstantInt *TheTrueVal;
918 ConstantInt *TheFalseVal;
920 // Basic type instances.
921 Type VoidTy, LabelTy, HalfTy, FloatTy, DoubleTy, MetadataTy;
922 Type X86_FP80Ty, FP128Ty, PPC_FP128Ty, X86_MMXTy;
923 IntegerType Int1Ty, Int8Ty, Int16Ty, Int32Ty, Int64Ty, Int128Ty;
926 /// TypeAllocator - All dynamically allocated types are allocated from this.
927 /// They live forever until the context is torn down.
928 BumpPtrAllocator TypeAllocator;
930 DenseMap<unsigned, IntegerType*> IntegerTypes;
932 typedef DenseSet<FunctionType *, FunctionTypeKeyInfo> FunctionTypeSet;
933 FunctionTypeSet FunctionTypes;
934 typedef DenseSet<StructType *, AnonStructTypeKeyInfo> StructTypeSet;
935 StructTypeSet AnonStructTypes;
936 StringMap<StructType*> NamedStructTypes;
937 unsigned NamedStructTypesUniqueID;
939 DenseMap<std::pair<Type *, uint64_t>, ArrayType*> ArrayTypes;
940 DenseMap<std::pair<Type *, unsigned>, VectorType*> VectorTypes;
941 DenseMap<Type*, PointerType*> PointerTypes; // Pointers in AddrSpace = 0
942 DenseMap<std::pair<Type*, unsigned>, PointerType*> ASPointerTypes;
945 /// ValueHandles - This map keeps track of all of the value handles that are
946 /// watching a Value*. The Value::HasValueHandle bit is used to know
947 /// whether or not a value has an entry in this map.
948 typedef DenseMap<Value*, ValueHandleBase*> ValueHandlesTy;
949 ValueHandlesTy ValueHandles;
951 /// CustomMDKindNames - Map to hold the metadata string to ID mapping.
952 StringMap<unsigned> CustomMDKindNames;
954 typedef std::pair<unsigned, TrackingMDNodeRef> MDPairTy;
955 typedef SmallVector<MDPairTy, 2> MDMapTy;
957 /// MetadataStore - Collection of per-instruction metadata used in this
959 DenseMap<const Instruction *, MDMapTy> MetadataStore;
961 /// DiscriminatorTable - This table maps file:line locations to an
962 /// integer representing the next DWARF path discriminator to assign to
963 /// instructions in different blocks at the same location.
964 DenseMap<std::pair<const char *, unsigned>, unsigned> DiscriminatorTable;
966 /// IntrinsicIDCache - Cache of intrinsic name (string) to numeric ID mappings
967 /// requested in this context
968 typedef DenseMap<const Function*, unsigned> IntrinsicIDCacheTy;
969 IntrinsicIDCacheTy IntrinsicIDCache;
971 /// \brief Mapping from a function to its prefix data, which is stored as the
972 /// operand of an unparented ReturnInst so that the prefix data has a Use.
973 typedef DenseMap<const Function *, ReturnInst *> PrefixDataMapTy;
974 PrefixDataMapTy PrefixDataMap;
976 /// \brief Mapping from a function to its prologue data, which is stored as
977 /// the operand of an unparented ReturnInst so that the prologue data has a
979 typedef DenseMap<const Function *, ReturnInst *> PrologueDataMapTy;
980 PrologueDataMapTy PrologueDataMap;
982 int getOrAddScopeRecordIdxEntry(MDNode *N, int ExistingIdx);
983 int getOrAddScopeInlinedAtIdxEntry(MDNode *Scope, MDNode *IA,int ExistingIdx);
985 LLVMContextImpl(LLVMContext &C);
988 /// Destroy the ConstantArrays if they are not used.
989 void dropTriviallyDeadConstantArrays();