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 Lo) : Count(Count), Lo(Lo) {}
281 MDNodeKeyImpl(const MDSubrange *N) : Count(N->getCount()), Lo(N->getLo()) {}
283 bool isKeyOf(const MDSubrange *RHS) const {
284 return Count == RHS->getCount() && Lo == RHS->getLo();
286 unsigned getHashValue() const { return hash_combine(Count, Lo); }
289 template <> struct MDNodeKeyImpl<MDEnumerator> {
293 MDNodeKeyImpl(int64_t Value, StringRef Name) : Value(Value), Name(Name) {}
294 MDNodeKeyImpl(const MDEnumerator *N)
295 : Value(N->getValue()), Name(N->getName()) {}
297 bool isKeyOf(const MDEnumerator *RHS) const {
298 return Value == RHS->getValue() && Name == RHS->getName();
300 unsigned getHashValue() const { return hash_combine(Value, Name); }
303 template <> struct MDNodeKeyImpl<MDBasicType> {
307 uint64_t AlignInBits;
310 MDNodeKeyImpl(unsigned Tag, StringRef Name, uint64_t SizeInBits,
311 uint64_t AlignInBits, unsigned Encoding)
312 : Tag(Tag), Name(Name), SizeInBits(SizeInBits), AlignInBits(AlignInBits),
313 Encoding(Encoding) {}
314 MDNodeKeyImpl(const MDBasicType *N)
315 : Tag(N->getTag()), Name(N->getName()), SizeInBits(N->getSizeInBits()),
316 AlignInBits(N->getAlignInBits()), Encoding(N->getEncoding()) {}
318 bool isKeyOf(const MDBasicType *RHS) const {
319 return Tag == RHS->getTag() && Name == RHS->getName() &&
320 SizeInBits == RHS->getSizeInBits() &&
321 AlignInBits == RHS->getAlignInBits() &&
322 Encoding == RHS->getEncoding();
324 unsigned getHashValue() const {
325 return hash_combine(Tag, Name, SizeInBits, AlignInBits, Encoding);
329 template <> struct MDNodeKeyImpl<MDDerivedType> {
337 uint64_t AlignInBits;
338 uint64_t OffsetInBits;
342 MDNodeKeyImpl(unsigned Tag, StringRef Name, Metadata *File, unsigned Line,
343 Metadata *Scope, Metadata *BaseType, uint64_t SizeInBits,
344 uint64_t AlignInBits, uint64_t OffsetInBits, unsigned Flags,
346 : Tag(Tag), Name(Name), File(File), Line(Line), Scope(Scope),
347 BaseType(BaseType), SizeInBits(SizeInBits), AlignInBits(AlignInBits),
348 OffsetInBits(OffsetInBits), Flags(Flags), ExtraData(ExtraData) {}
349 MDNodeKeyImpl(const MDDerivedType *N)
350 : Tag(N->getTag()), Name(N->getName()), File(N->getRawFile()),
351 Line(N->getLine()), Scope(N->getRawScope()),
352 BaseType(N->getRawBaseType()), SizeInBits(N->getSizeInBits()),
353 AlignInBits(N->getAlignInBits()), OffsetInBits(N->getOffsetInBits()),
354 Flags(N->getFlags()), ExtraData(N->getRawExtraData()) {}
356 bool isKeyOf(const MDDerivedType *RHS) const {
357 return Tag == RHS->getTag() && Name == RHS->getName() &&
358 File == RHS->getRawFile() && Line == RHS->getLine() &&
359 Scope == RHS->getRawScope() && BaseType == RHS->getRawBaseType() &&
360 SizeInBits == RHS->getSizeInBits() &&
361 AlignInBits == RHS->getAlignInBits() &&
362 OffsetInBits == RHS->getOffsetInBits() && Flags == RHS->getFlags() &&
363 ExtraData == RHS->getRawExtraData();
365 unsigned getHashValue() const {
366 return hash_combine(Tag, Name, File, Line, Scope, BaseType, SizeInBits,
367 AlignInBits, OffsetInBits, Flags, ExtraData);
371 template <> struct MDNodeKeyImpl<MDCompositeType> {
379 uint64_t AlignInBits;
380 uint64_t OffsetInBits;
383 unsigned RuntimeLang;
384 Metadata *VTableHolder;
385 Metadata *TemplateParams;
386 StringRef Identifier;
388 MDNodeKeyImpl(unsigned Tag, StringRef Name, Metadata *File, unsigned Line,
389 Metadata *Scope, Metadata *BaseType, uint64_t SizeInBits,
390 uint64_t AlignInBits, uint64_t OffsetInBits, unsigned Flags,
391 Metadata *Elements, unsigned RuntimeLang,
392 Metadata *VTableHolder, Metadata *TemplateParams,
393 StringRef Identifier)
394 : Tag(Tag), Name(Name), File(File), Line(Line), Scope(Scope),
395 BaseType(BaseType), SizeInBits(SizeInBits), AlignInBits(AlignInBits),
396 OffsetInBits(OffsetInBits), Flags(Flags), Elements(Elements),
397 RuntimeLang(RuntimeLang), VTableHolder(VTableHolder),
398 TemplateParams(TemplateParams), Identifier(Identifier) {}
399 MDNodeKeyImpl(const MDCompositeType *N)
400 : Tag(N->getTag()), Name(N->getName()), File(N->getRawFile()),
401 Line(N->getLine()), Scope(N->getRawScope()),
402 BaseType(N->getRawBaseType()), SizeInBits(N->getSizeInBits()),
403 AlignInBits(N->getAlignInBits()), OffsetInBits(N->getOffsetInBits()),
404 Flags(N->getFlags()), Elements(N->getRawElements()),
405 RuntimeLang(N->getRuntimeLang()), VTableHolder(N->getRawVTableHolder()),
406 TemplateParams(N->getRawTemplateParams()),
407 Identifier(N->getIdentifier()) {}
409 bool isKeyOf(const MDCompositeType *RHS) const {
410 return Tag == RHS->getTag() && Name == RHS->getName() &&
411 File == RHS->getRawFile() && Line == RHS->getLine() &&
412 Scope == RHS->getRawScope() && BaseType == RHS->getRawBaseType() &&
413 SizeInBits == RHS->getSizeInBits() &&
414 AlignInBits == RHS->getAlignInBits() &&
415 OffsetInBits == RHS->getOffsetInBits() && Flags == RHS->getFlags() &&
416 Elements == RHS->getRawElements() &&
417 RuntimeLang == RHS->getRuntimeLang() &&
418 VTableHolder == RHS->getRawVTableHolder() &&
419 TemplateParams == RHS->getRawTemplateParams() &&
420 Identifier == RHS->getIdentifier();
422 unsigned getHashValue() const {
423 return hash_combine(Tag, Name, File, Line, Scope, BaseType, SizeInBits,
424 AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang,
425 VTableHolder, TemplateParams, Identifier);
429 template <> struct MDNodeKeyImpl<MDSubroutineType> {
433 MDNodeKeyImpl(int64_t Flags, Metadata *TypeArray)
434 : Flags(Flags), TypeArray(TypeArray) {}
435 MDNodeKeyImpl(const MDSubroutineType *N)
436 : Flags(N->getFlags()), TypeArray(N->getRawTypeArray()) {}
438 bool isKeyOf(const MDSubroutineType *RHS) const {
439 return Flags == RHS->getFlags() && TypeArray == RHS->getRawTypeArray();
441 unsigned getHashValue() const { return hash_combine(Flags, TypeArray); }
444 template <> struct MDNodeKeyImpl<MDFile> {
448 MDNodeKeyImpl(StringRef Filename, StringRef Directory)
449 : Filename(Filename), Directory(Directory) {}
450 MDNodeKeyImpl(const MDFile *N)
451 : Filename(N->getFilename()), Directory(N->getDirectory()) {}
453 bool isKeyOf(const MDFile *RHS) const {
454 return Filename == RHS->getFilename() && Directory == RHS->getDirectory();
456 unsigned getHashValue() const { return hash_combine(Filename, Directory); }
459 template <> struct MDNodeKeyImpl<MDCompileUnit> {
460 unsigned SourceLanguage;
465 unsigned RuntimeVersion;
466 StringRef SplitDebugFilename;
467 unsigned EmissionKind;
469 Metadata *RetainedTypes;
470 Metadata *Subprograms;
471 Metadata *GlobalVariables;
472 Metadata *ImportedEntities;
474 MDNodeKeyImpl(unsigned SourceLanguage, Metadata *File, StringRef Producer,
475 bool IsOptimized, StringRef Flags, unsigned RuntimeVersion,
476 StringRef SplitDebugFilename, unsigned EmissionKind,
477 Metadata *EnumTypes, Metadata *RetainedTypes,
478 Metadata *Subprograms, Metadata *GlobalVariables,
479 Metadata *ImportedEntities)
480 : SourceLanguage(SourceLanguage), File(File), Producer(Producer),
481 IsOptimized(IsOptimized), Flags(Flags), RuntimeVersion(RuntimeVersion),
482 SplitDebugFilename(SplitDebugFilename), EmissionKind(EmissionKind),
483 EnumTypes(EnumTypes), RetainedTypes(RetainedTypes),
484 Subprograms(Subprograms), GlobalVariables(GlobalVariables),
485 ImportedEntities(ImportedEntities) {}
486 MDNodeKeyImpl(const MDCompileUnit *N)
487 : SourceLanguage(N->getSourceLanguage()), File(N->getRawFile()),
488 Producer(N->getProducer()), IsOptimized(N->isOptimized()),
489 Flags(N->getFlags()), RuntimeVersion(N->getRuntimeVersion()),
490 SplitDebugFilename(N->getSplitDebugFilename()),
491 EmissionKind(N->getEmissionKind()), EnumTypes(N->getRawEnumTypes()),
492 RetainedTypes(N->getRawRetainedTypes()),
493 Subprograms(N->getRawSubprograms()),
494 GlobalVariables(N->getRawGlobalVariables()),
495 ImportedEntities(N->getRawImportedEntities()) {}
497 bool isKeyOf(const MDCompileUnit *RHS) const {
498 return SourceLanguage == RHS->getSourceLanguage() &&
499 File == RHS->getRawFile() && Producer == RHS->getProducer() &&
500 IsOptimized == RHS->isOptimized() && Flags == RHS->getFlags() &&
501 RuntimeVersion == RHS->getRuntimeVersion() &&
502 SplitDebugFilename == RHS->getSplitDebugFilename() &&
503 EmissionKind == RHS->getEmissionKind() &&
504 EnumTypes == RHS->getRawEnumTypes() &&
505 RetainedTypes == RHS->getRawRetainedTypes() &&
506 Subprograms == RHS->getRawSubprograms() &&
507 GlobalVariables == RHS->getRawGlobalVariables() &&
508 ImportedEntities == RHS->getRawImportedEntities();
510 unsigned getHashValue() const {
511 return hash_combine(SourceLanguage, File, Producer, IsOptimized, Flags,
512 RuntimeVersion, SplitDebugFilename, EmissionKind,
513 EnumTypes, RetainedTypes, Subprograms, GlobalVariables,
518 template <> struct MDNodeKeyImpl<MDSubprogram> {
521 StringRef LinkageName;
528 Metadata *ContainingType;
530 unsigned VirtualIndex;
534 Metadata *TemplateParams;
535 Metadata *Declaration;
538 MDNodeKeyImpl(Metadata *Scope, StringRef Name, StringRef LinkageName,
539 Metadata *File, unsigned Line, Metadata *Type,
540 bool IsLocalToUnit, bool IsDefinition, unsigned ScopeLine,
541 Metadata *ContainingType, unsigned Virtuality,
542 unsigned VirtualIndex, unsigned Flags, bool IsOptimized,
543 Metadata *Function, Metadata *TemplateParams,
544 Metadata *Declaration, Metadata *Variables)
545 : Scope(Scope), Name(Name), LinkageName(LinkageName), File(File),
546 Line(Line), Type(Type), IsLocalToUnit(IsLocalToUnit),
547 IsDefinition(IsDefinition), ScopeLine(ScopeLine),
548 ContainingType(ContainingType), Virtuality(Virtuality),
549 VirtualIndex(VirtualIndex), Flags(Flags), IsOptimized(IsOptimized),
550 Function(Function), TemplateParams(TemplateParams),
551 Declaration(Declaration), Variables(Variables) {}
552 MDNodeKeyImpl(const MDSubprogram *N)
553 : Scope(N->getRawScope()), Name(N->getName()),
554 LinkageName(N->getLinkageName()), File(N->getRawFile()),
555 Line(N->getLine()), Type(N->getRawType()),
556 IsLocalToUnit(N->isLocalToUnit()), IsDefinition(N->isDefinition()),
557 ScopeLine(N->getScopeLine()), ContainingType(N->getRawContainingType()),
558 Virtuality(N->getVirtuality()), VirtualIndex(N->getVirtualIndex()),
559 Flags(N->getFlags()), IsOptimized(N->isOptimized()),
560 Function(N->getRawFunction()),
561 TemplateParams(N->getRawTemplateParams()),
562 Declaration(N->getRawDeclaration()), Variables(N->getRawVariables()) {}
564 bool isKeyOf(const MDSubprogram *RHS) const {
565 return Scope == RHS->getRawScope() && Name == RHS->getName() &&
566 LinkageName == RHS->getLinkageName() && File == RHS->getRawFile() &&
567 Line == RHS->getLine() && Type == RHS->getRawType() &&
568 IsLocalToUnit == RHS->isLocalToUnit() &&
569 IsDefinition == RHS->isDefinition() &&
570 ScopeLine == RHS->getScopeLine() &&
571 ContainingType == RHS->getRawContainingType() &&
572 Virtuality == RHS->getVirtuality() &&
573 VirtualIndex == RHS->getVirtualIndex() && Flags == RHS->getFlags() &&
574 IsOptimized == RHS->isOptimized() &&
575 Function == RHS->getRawFunction() &&
576 TemplateParams == RHS->getRawTemplateParams() &&
577 Declaration == RHS->getRawDeclaration() &&
578 Variables == RHS->getRawVariables();
580 unsigned getHashValue() const {
581 return hash_combine(Scope, Name, LinkageName, File, Line, Type,
582 IsLocalToUnit, IsDefinition, ScopeLine, ContainingType,
583 Virtuality, VirtualIndex, Flags, IsOptimized, Function,
584 TemplateParams, Declaration, Variables);
588 template <> struct MDNodeKeyImpl<MDLexicalBlock> {
594 MDNodeKeyImpl(Metadata *Scope, Metadata *File, unsigned Line, unsigned Column)
595 : Scope(Scope), File(File), Line(Line), Column(Column) {}
596 MDNodeKeyImpl(const MDLexicalBlock *N)
597 : Scope(N->getScope()), File(N->getFile()), Line(N->getLine()),
598 Column(N->getColumn()) {}
600 bool isKeyOf(const MDLexicalBlock *RHS) const {
601 return Scope == RHS->getScope() && File == RHS->getFile() &&
602 Line == RHS->getLine() && Column == RHS->getColumn();
604 unsigned getHashValue() const {
605 return hash_combine(Scope, File, Line, Column);
609 template <> struct MDNodeKeyImpl<MDLexicalBlockFile> {
612 unsigned Discriminator;
614 MDNodeKeyImpl(Metadata *Scope, Metadata *File, unsigned Discriminator)
615 : Scope(Scope), File(File), Discriminator(Discriminator) {}
616 MDNodeKeyImpl(const MDLexicalBlockFile *N)
617 : Scope(N->getScope()), File(N->getFile()),
618 Discriminator(N->getDiscriminator()) {}
620 bool isKeyOf(const MDLexicalBlockFile *RHS) const {
621 return Scope == RHS->getScope() && File == RHS->getFile() &&
622 Discriminator == RHS->getDiscriminator();
624 unsigned getHashValue() const {
625 return hash_combine(Scope, File, Discriminator);
629 template <> struct MDNodeKeyImpl<MDNamespace> {
635 MDNodeKeyImpl(Metadata *Scope, Metadata *File, StringRef Name, unsigned Line)
636 : Scope(Scope), File(File), Name(Name), Line(Line) {}
637 MDNodeKeyImpl(const MDNamespace *N)
638 : Scope(N->getScope()), File(N->getFile()), Name(N->getName()),
639 Line(N->getLine()) {}
641 bool isKeyOf(const MDNamespace *RHS) const {
642 return Scope == RHS->getScope() && File == RHS->getFile() &&
643 Name == RHS->getName() && Line == RHS->getLine();
645 unsigned getHashValue() const {
646 return hash_combine(Scope, File, Name, Line);
650 template <> struct MDNodeKeyImpl<MDTemplateTypeParameter> {
654 MDNodeKeyImpl(StringRef Name, Metadata *Type) : Name(Name), Type(Type) {}
655 MDNodeKeyImpl(const MDTemplateTypeParameter *N)
656 : Name(N->getName()), Type(N->getType()) {}
658 bool isKeyOf(const MDTemplateTypeParameter *RHS) const {
659 return Name == RHS->getName() && Type == RHS->getType();
661 unsigned getHashValue() const { return hash_combine(Name, Type); }
664 template <> struct MDNodeKeyImpl<MDTemplateValueParameter> {
670 MDNodeKeyImpl(unsigned Tag, StringRef Name, Metadata *Type, Metadata *Value)
671 : Tag(Tag), Name(Name), Type(Type), Value(Value) {}
672 MDNodeKeyImpl(const MDTemplateValueParameter *N)
673 : Tag(N->getTag()), Name(N->getName()), Type(N->getType()),
674 Value(N->getValue()) {}
676 bool isKeyOf(const MDTemplateValueParameter *RHS) const {
677 return Tag == RHS->getTag() && Name == RHS->getName() &&
678 Type == RHS->getType() && Value == RHS->getValue();
680 unsigned getHashValue() const { return hash_combine(Tag, Name, Type, Value); }
683 template <> struct MDNodeKeyImpl<MDGlobalVariable> {
686 StringRef LinkageName;
693 Metadata *StaticDataMemberDeclaration;
695 MDNodeKeyImpl(Metadata *Scope, StringRef Name, StringRef LinkageName,
696 Metadata *File, unsigned Line, Metadata *Type,
697 bool IsLocalToUnit, bool IsDefinition, Metadata *Variable,
698 Metadata *StaticDataMemberDeclaration)
699 : Scope(Scope), Name(Name), LinkageName(LinkageName), File(File),
700 Line(Line), Type(Type), IsLocalToUnit(IsLocalToUnit),
701 IsDefinition(IsDefinition), Variable(Variable),
702 StaticDataMemberDeclaration(StaticDataMemberDeclaration) {}
703 MDNodeKeyImpl(const MDGlobalVariable *N)
704 : Scope(N->getRawScope()), Name(N->getName()),
705 LinkageName(N->getLinkageName()), File(N->getRawFile()),
706 Line(N->getLine()), Type(N->getRawType()),
707 IsLocalToUnit(N->isLocalToUnit()), IsDefinition(N->isDefinition()),
708 Variable(N->getRawVariable()),
709 StaticDataMemberDeclaration(N->getRawStaticDataMemberDeclaration()) {}
711 bool isKeyOf(const MDGlobalVariable *RHS) const {
712 return Scope == RHS->getRawScope() && Name == RHS->getName() &&
713 LinkageName == RHS->getLinkageName() && File == RHS->getRawFile() &&
714 Line == RHS->getLine() && Type == RHS->getRawType() &&
715 IsLocalToUnit == RHS->isLocalToUnit() &&
716 IsDefinition == RHS->isDefinition() &&
717 Variable == RHS->getRawVariable() &&
718 StaticDataMemberDeclaration ==
719 RHS->getRawStaticDataMemberDeclaration();
721 unsigned getHashValue() const {
722 return hash_combine(Scope, Name, LinkageName, File, Line, Type,
723 IsLocalToUnit, IsDefinition, Variable,
724 StaticDataMemberDeclaration);
728 template <> struct MDNodeKeyImpl<MDLocalVariable> {
739 MDNodeKeyImpl(unsigned Tag, Metadata *Scope, StringRef Name, Metadata *File,
740 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), InlinedAt(InlinedAt) {}
744 MDNodeKeyImpl(const MDLocalVariable *N)
745 : Tag(N->getTag()), Scope(N->getRawScope()), Name(N->getName()),
746 File(N->getRawFile()), Line(N->getLine()), Type(N->getRawType()),
747 Arg(N->getArg()), Flags(N->getFlags()),
748 InlinedAt(N->getRawInlinedAt()) {}
750 bool isKeyOf(const MDLocalVariable *RHS) const {
751 return Tag == RHS->getTag() && Scope == RHS->getRawScope() &&
752 Name == RHS->getName() && File == RHS->getRawFile() &&
753 Line == RHS->getLine() && Type == RHS->getRawType() &&
754 Arg == RHS->getArg() && Flags == RHS->getFlags() &&
755 InlinedAt == RHS->getRawInlinedAt();
757 unsigned getHashValue() const {
758 return hash_combine(Tag, Scope, Name, File, Line, Type, Arg, Flags,
763 template <> struct MDNodeKeyImpl<MDExpression> {
764 ArrayRef<uint64_t> Elements;
766 MDNodeKeyImpl(ArrayRef<uint64_t> Elements) : Elements(Elements) {}
767 MDNodeKeyImpl(const MDExpression *N) : Elements(N->getElements()) {}
769 bool isKeyOf(const MDExpression *RHS) const {
770 return Elements == RHS->getElements();
772 unsigned getHashValue() const {
773 return hash_combine_range(Elements.begin(), Elements.end());
777 template <> struct MDNodeKeyImpl<MDObjCProperty> {
781 StringRef GetterName;
782 StringRef SetterName;
786 MDNodeKeyImpl(StringRef Name, Metadata *File, unsigned Line,
787 StringRef GetterName, StringRef SetterName, unsigned Attributes,
789 : Name(Name), File(File), Line(Line), GetterName(GetterName),
790 SetterName(SetterName), Attributes(Attributes), Type(Type) {}
791 MDNodeKeyImpl(const MDObjCProperty *N)
792 : Name(N->getName()), File(N->getFile()), Line(N->getLine()),
793 GetterName(N->getGetterName()), SetterName(N->getSetterName()),
794 Attributes(N->getAttributes()), Type(N->getType()) {}
796 bool isKeyOf(const MDObjCProperty *RHS) const {
797 return Name == RHS->getName() && File == RHS->getFile() &&
798 Line == RHS->getLine() && GetterName == RHS->getGetterName() &&
799 SetterName == RHS->getSetterName() &&
800 Attributes == RHS->getAttributes() && Type == RHS->getType();
802 unsigned getHashValue() const {
803 return hash_combine(Name, File, Line, GetterName, SetterName, Attributes,
808 template <> struct MDNodeKeyImpl<MDImportedEntity> {
815 MDNodeKeyImpl(unsigned Tag, Metadata *Scope, Metadata *Entity, unsigned Line,
817 : Tag(Tag), Scope(Scope), Entity(Entity), Line(Line), Name(Name) {}
818 MDNodeKeyImpl(const MDImportedEntity *N)
819 : Tag(N->getTag()), Scope(N->getScope()), Entity(N->getEntity()),
820 Line(N->getLine()), Name(N->getName()) {}
822 bool isKeyOf(const MDImportedEntity *RHS) const {
823 return Tag == RHS->getTag() && Scope == RHS->getScope() &&
824 Entity == RHS->getEntity() && Line == RHS->getLine() &&
825 Name == RHS->getName();
827 unsigned getHashValue() const {
828 return hash_combine(Tag, Scope, Entity, Line, Name);
832 /// \brief DenseMapInfo for MDNode subclasses.
833 template <class NodeTy> struct MDNodeInfo {
834 typedef MDNodeKeyImpl<NodeTy> KeyTy;
835 static inline NodeTy *getEmptyKey() {
836 return DenseMapInfo<NodeTy *>::getEmptyKey();
838 static inline NodeTy *getTombstoneKey() {
839 return DenseMapInfo<NodeTy *>::getTombstoneKey();
841 static unsigned getHashValue(const KeyTy &Key) { return Key.getHashValue(); }
842 static unsigned getHashValue(const NodeTy *N) {
843 return KeyTy(N).getHashValue();
845 static bool isEqual(const KeyTy &LHS, const NodeTy *RHS) {
846 if (RHS == getEmptyKey() || RHS == getTombstoneKey())
848 return LHS.isKeyOf(RHS);
850 static bool isEqual(const NodeTy *LHS, const NodeTy *RHS) {
855 #define HANDLE_MDNODE_LEAF(CLASS) typedef MDNodeInfo<CLASS> CLASS##Info;
856 #include "llvm/IR/Metadata.def"
858 class LLVMContextImpl {
860 /// OwnedModules - The set of modules instantiated in this context, and which
861 /// will be automatically deleted if this context is deleted.
862 SmallPtrSet<Module*, 4> OwnedModules;
864 LLVMContext::InlineAsmDiagHandlerTy InlineAsmDiagHandler;
865 void *InlineAsmDiagContext;
867 LLVMContext::DiagnosticHandlerTy DiagnosticHandler;
868 void *DiagnosticContext;
869 bool RespectDiagnosticFilters;
871 LLVMContext::YieldCallbackTy YieldCallback;
872 void *YieldOpaqueHandle;
874 typedef DenseMap<APInt, ConstantInt *, DenseMapAPIntKeyInfo> IntMapTy;
875 IntMapTy IntConstants;
877 typedef DenseMap<APFloat, ConstantFP *, DenseMapAPFloatKeyInfo> FPMapTy;
880 FoldingSet<AttributeImpl> AttrsSet;
881 FoldingSet<AttributeSetImpl> AttrsLists;
882 FoldingSet<AttributeSetNode> AttrsSetNodes;
884 StringMap<MDString> MDStringCache;
885 DenseMap<Value *, ValueAsMetadata *> ValuesAsMetadata;
886 DenseMap<Metadata *, MetadataAsValue *> MetadataAsValues;
888 #define HANDLE_MDNODE_LEAF(CLASS) DenseSet<CLASS *, CLASS##Info> CLASS##s;
889 #include "llvm/IR/Metadata.def"
891 // MDNodes may be uniqued or not uniqued. When they're not uniqued, they
892 // aren't in the MDNodeSet, but they're still shared between objects, so no
893 // one object can destroy them. This set allows us to at least destroy them
894 // on Context destruction.
895 SmallPtrSet<MDNode *, 1> DistinctMDNodes;
897 DenseMap<Type*, ConstantAggregateZero*> CAZConstants;
899 typedef ConstantUniqueMap<ConstantArray> ArrayConstantsTy;
900 ArrayConstantsTy ArrayConstants;
902 typedef ConstantUniqueMap<ConstantStruct> StructConstantsTy;
903 StructConstantsTy StructConstants;
905 typedef ConstantUniqueMap<ConstantVector> VectorConstantsTy;
906 VectorConstantsTy VectorConstants;
908 DenseMap<PointerType*, ConstantPointerNull*> CPNConstants;
910 DenseMap<Type*, UndefValue*> UVConstants;
912 StringMap<ConstantDataSequential*> CDSConstants;
914 DenseMap<std::pair<const Function *, const BasicBlock *>, BlockAddress *>
916 ConstantUniqueMap<ConstantExpr> ExprConstants;
918 ConstantUniqueMap<InlineAsm> InlineAsms;
920 ConstantInt *TheTrueVal;
921 ConstantInt *TheFalseVal;
923 // Basic type instances.
924 Type VoidTy, LabelTy, HalfTy, FloatTy, DoubleTy, MetadataTy;
925 Type X86_FP80Ty, FP128Ty, PPC_FP128Ty, X86_MMXTy;
926 IntegerType Int1Ty, Int8Ty, Int16Ty, Int32Ty, Int64Ty;
929 /// TypeAllocator - All dynamically allocated types are allocated from this.
930 /// They live forever until the context is torn down.
931 BumpPtrAllocator TypeAllocator;
933 DenseMap<unsigned, IntegerType*> IntegerTypes;
935 typedef DenseSet<FunctionType *, FunctionTypeKeyInfo> FunctionTypeSet;
936 FunctionTypeSet FunctionTypes;
937 typedef DenseSet<StructType *, AnonStructTypeKeyInfo> StructTypeSet;
938 StructTypeSet AnonStructTypes;
939 StringMap<StructType*> NamedStructTypes;
940 unsigned NamedStructTypesUniqueID;
942 DenseMap<std::pair<Type *, uint64_t>, ArrayType*> ArrayTypes;
943 DenseMap<std::pair<Type *, unsigned>, VectorType*> VectorTypes;
944 DenseMap<Type*, PointerType*> PointerTypes; // Pointers in AddrSpace = 0
945 DenseMap<std::pair<Type*, unsigned>, PointerType*> ASPointerTypes;
948 /// ValueHandles - This map keeps track of all of the value handles that are
949 /// watching a Value*. The Value::HasValueHandle bit is used to know
950 /// whether or not a value has an entry in this map.
951 typedef DenseMap<Value*, ValueHandleBase*> ValueHandlesTy;
952 ValueHandlesTy ValueHandles;
954 /// CustomMDKindNames - Map to hold the metadata string to ID mapping.
955 StringMap<unsigned> CustomMDKindNames;
957 typedef std::pair<unsigned, TrackingMDNodeRef> MDPairTy;
958 typedef SmallVector<MDPairTy, 2> MDMapTy;
960 /// MetadataStore - Collection of per-instruction metadata used in this
962 DenseMap<const Instruction *, MDMapTy> MetadataStore;
964 /// DiscriminatorTable - This table maps file:line locations to an
965 /// integer representing the next DWARF path discriminator to assign to
966 /// instructions in different blocks at the same location.
967 DenseMap<std::pair<const char *, unsigned>, unsigned> DiscriminatorTable;
969 /// IntrinsicIDCache - Cache of intrinsic name (string) to numeric ID mappings
970 /// requested in this context
971 typedef DenseMap<const Function*, unsigned> IntrinsicIDCacheTy;
972 IntrinsicIDCacheTy IntrinsicIDCache;
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 typedef DenseMap<const Function *, ReturnInst *> PrefixDataMapTy;
977 PrefixDataMapTy PrefixDataMap;
979 /// \brief Mapping from a function to its prologue data, which is stored as
980 /// the operand of an unparented ReturnInst so that the prologue data has a
982 typedef DenseMap<const Function *, ReturnInst *> PrologueDataMapTy;
983 PrologueDataMapTy PrologueDataMap;
985 int getOrAddScopeRecordIdxEntry(MDNode *N, int ExistingIdx);
986 int getOrAddScopeInlinedAtIdxEntry(MDNode *Scope, MDNode *IA,int ExistingIdx);
988 LLVMContextImpl(LLVMContext &C);
991 /// Destroy the ConstantArrays if they are not used.
992 void dropTriviallyDeadConstantArrays();