1//===- LLVMContextImpl.h - The LLVMContextImpl opaque class -----*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file declares LLVMContextImpl, the opaque implementation
10// of LLVMContext.
11//
12//===----------------------------------------------------------------------===//
13
14#ifndef LLVM_LIB_IR_LLVMCONTEXTIMPL_H
15#define LLVM_LIB_IR_LLVMCONTEXTIMPL_H
16
17#include "ConstantsContext.h"
18#include "llvm/ADT/APFloat.h"
19#include "llvm/ADT/APInt.h"
20#include "llvm/ADT/ArrayRef.h"
21#include "llvm/ADT/DenseMap.h"
22#include "llvm/ADT/DenseMapInfo.h"
23#include "llvm/ADT/DenseSet.h"
24#include "llvm/ADT/FoldingSet.h"
25#include "llvm/ADT/Hashing.h"
26#include "llvm/ADT/STLExtras.h"
27#include "llvm/ADT/SmallPtrSet.h"
28#include "llvm/ADT/SmallVector.h"
29#include "llvm/ADT/StringMap.h"
30#include "llvm/BinaryFormat/Dwarf.h"
31#include "llvm/IR/Constants.h"
32#include "llvm/IR/DebugInfoMetadata.h"
33#include "llvm/IR/DerivedTypes.h"
34#include "llvm/IR/LLVMContext.h"
35#include "llvm/IR/Metadata.h"
36#include "llvm/IR/Module.h"
37#include "llvm/IR/TrackingMDRef.h"
38#include "llvm/IR/Type.h"
39#include "llvm/IR/Value.h"
40#include "llvm/Support/Allocator.h"
41#include "llvm/Support/Casting.h"
42#include "llvm/Support/StringSaver.h"
43#include <algorithm>
44#include <cassert>
45#include <cstddef>
46#include <cstdint>
47#include <memory>
48#include <optional>
49#include <string>
50#include <utility>
51#include <vector>
52
53namespace llvm {
54
55class AttributeImpl;
56class AttributeListImpl;
57class AttributeSetNode;
58class BasicBlock;
59class ConstantRangeAttributeImpl;
60class ConstantRangeListAttributeImpl;
61struct DiagnosticHandler;
62class DbgMarker;
63class ElementCount;
64class Function;
65class GlobalObject;
66class GlobalValue;
67class InlineAsm;
68class LLVMRemarkStreamer;
69class OptPassGate;
70namespace remarks {
71class RemarkStreamer;
72}
73template <typename T> class StringMapEntry;
74class StringRef;
75class TypedPointerType;
76class ValueHandleBase;
77
78template <> struct DenseMapInfo<APFloat> {
79 static inline APFloat getEmptyKey() { return APFloat(APFloat::Bogus(), 1); }
80 static inline APFloat getTombstoneKey() {
81 return APFloat(APFloat::Bogus(), 2);
82 }
83
84 static unsigned getHashValue(const APFloat &Key) {
85 return static_cast<unsigned>(hash_value(Arg: Key));
86 }
87
88 static bool isEqual(const APFloat &LHS, const APFloat &RHS) {
89 return LHS.bitwiseIsEqual(RHS);
90 }
91};
92
93struct AnonStructTypeKeyInfo {
94 struct KeyTy {
95 ArrayRef<Type *> ETypes;
96 bool isPacked;
97
98 KeyTy(const ArrayRef<Type *> &E, bool P) : ETypes(E), isPacked(P) {}
99
100 KeyTy(const StructType *ST)
101 : ETypes(ST->elements()), isPacked(ST->isPacked()) {}
102
103 bool operator==(const KeyTy &that) const {
104 if (isPacked != that.isPacked)
105 return false;
106 if (ETypes != that.ETypes)
107 return false;
108 return true;
109 }
110 bool operator!=(const KeyTy &that) const { return !this->operator==(that); }
111 };
112
113 static inline StructType *getEmptyKey() {
114 return DenseMapInfo<StructType *>::getEmptyKey();
115 }
116
117 static inline StructType *getTombstoneKey() {
118 return DenseMapInfo<StructType *>::getTombstoneKey();
119 }
120
121 static unsigned getHashValue(const KeyTy &Key) {
122 return hash_combine(
123 args: hash_combine_range(first: Key.ETypes.begin(), last: Key.ETypes.end()), args: Key.isPacked);
124 }
125
126 static unsigned getHashValue(const StructType *ST) {
127 return getHashValue(Key: KeyTy(ST));
128 }
129
130 static bool isEqual(const KeyTy &LHS, const StructType *RHS) {
131 if (RHS == getEmptyKey() || RHS == getTombstoneKey())
132 return false;
133 return LHS == KeyTy(RHS);
134 }
135
136 static bool isEqual(const StructType *LHS, const StructType *RHS) {
137 return LHS == RHS;
138 }
139};
140
141struct FunctionTypeKeyInfo {
142 struct KeyTy {
143 const Type *ReturnType;
144 ArrayRef<Type *> Params;
145 bool isVarArg;
146
147 KeyTy(const Type *R, const ArrayRef<Type *> &P, bool V)
148 : ReturnType(R), Params(P), isVarArg(V) {}
149 KeyTy(const FunctionType *FT)
150 : ReturnType(FT->getReturnType()), Params(FT->params()),
151 isVarArg(FT->isVarArg()) {}
152
153 bool operator==(const KeyTy &that) const {
154 if (ReturnType != that.ReturnType)
155 return false;
156 if (isVarArg != that.isVarArg)
157 return false;
158 if (Params != that.Params)
159 return false;
160 return true;
161 }
162 bool operator!=(const KeyTy &that) const { return !this->operator==(that); }
163 };
164
165 static inline FunctionType *getEmptyKey() {
166 return DenseMapInfo<FunctionType *>::getEmptyKey();
167 }
168
169 static inline FunctionType *getTombstoneKey() {
170 return DenseMapInfo<FunctionType *>::getTombstoneKey();
171 }
172
173 static unsigned getHashValue(const KeyTy &Key) {
174 return hash_combine(
175 args: Key.ReturnType,
176 args: hash_combine_range(first: Key.Params.begin(), last: Key.Params.end()), args: Key.isVarArg);
177 }
178
179 static unsigned getHashValue(const FunctionType *FT) {
180 return getHashValue(Key: KeyTy(FT));
181 }
182
183 static bool isEqual(const KeyTy &LHS, const FunctionType *RHS) {
184 if (RHS == getEmptyKey() || RHS == getTombstoneKey())
185 return false;
186 return LHS == KeyTy(RHS);
187 }
188
189 static bool isEqual(const FunctionType *LHS, const FunctionType *RHS) {
190 return LHS == RHS;
191 }
192};
193
194struct TargetExtTypeKeyInfo {
195 struct KeyTy {
196 StringRef Name;
197 ArrayRef<Type *> TypeParams;
198 ArrayRef<unsigned> IntParams;
199
200 KeyTy(StringRef N, const ArrayRef<Type *> &TP, const ArrayRef<unsigned> &IP)
201 : Name(N), TypeParams(TP), IntParams(IP) {}
202 KeyTy(const TargetExtType *TT)
203 : Name(TT->getName()), TypeParams(TT->type_params()),
204 IntParams(TT->int_params()) {}
205
206 bool operator==(const KeyTy &that) const {
207 return Name == that.Name && TypeParams == that.TypeParams &&
208 IntParams == that.IntParams;
209 }
210 bool operator!=(const KeyTy &that) const { return !this->operator==(that); }
211 };
212
213 static inline TargetExtType *getEmptyKey() {
214 return DenseMapInfo<TargetExtType *>::getEmptyKey();
215 }
216
217 static inline TargetExtType *getTombstoneKey() {
218 return DenseMapInfo<TargetExtType *>::getTombstoneKey();
219 }
220
221 static unsigned getHashValue(const KeyTy &Key) {
222 return hash_combine(
223 args: Key.Name,
224 args: hash_combine_range(first: Key.TypeParams.begin(), last: Key.TypeParams.end()),
225 args: hash_combine_range(first: Key.IntParams.begin(), last: Key.IntParams.end()));
226 }
227
228 static unsigned getHashValue(const TargetExtType *FT) {
229 return getHashValue(Key: KeyTy(FT));
230 }
231
232 static bool isEqual(const KeyTy &LHS, const TargetExtType *RHS) {
233 if (RHS == getEmptyKey() || RHS == getTombstoneKey())
234 return false;
235 return LHS == KeyTy(RHS);
236 }
237
238 static bool isEqual(const TargetExtType *LHS, const TargetExtType *RHS) {
239 return LHS == RHS;
240 }
241};
242
243/// Structure for hashing arbitrary MDNode operands.
244class MDNodeOpsKey {
245 ArrayRef<Metadata *> RawOps;
246 ArrayRef<MDOperand> Ops;
247 unsigned Hash;
248
249protected:
250 MDNodeOpsKey(ArrayRef<Metadata *> Ops)
251 : RawOps(Ops), Hash(calculateHash(Ops)) {}
252
253 template <class NodeTy>
254 MDNodeOpsKey(const NodeTy *N, unsigned Offset = 0)
255 : Ops(N->op_begin() + Offset, N->op_end()), Hash(N->getHash()) {}
256
257 template <class NodeTy>
258 bool compareOps(const NodeTy *RHS, unsigned Offset = 0) const {
259 if (getHash() != RHS->getHash())
260 return false;
261
262 assert((RawOps.empty() || Ops.empty()) && "Two sets of operands?");
263 return RawOps.empty() ? compareOps(Ops, RHS, Offset)
264 : compareOps(RawOps, RHS, Offset);
265 }
266
267 static unsigned calculateHash(MDNode *N, unsigned Offset = 0);
268
269private:
270 template <class T>
271 static bool compareOps(ArrayRef<T> Ops, const MDNode *RHS, unsigned Offset) {
272 if (Ops.size() != RHS->getNumOperands() - Offset)
273 return false;
274 return std::equal(Ops.begin(), Ops.end(), RHS->op_begin() + Offset);
275 }
276
277 static unsigned calculateHash(ArrayRef<Metadata *> Ops);
278
279public:
280 unsigned getHash() const { return Hash; }
281};
282
283template <class NodeTy> struct MDNodeKeyImpl;
284
285/// Configuration point for MDNodeInfo::isEqual().
286template <class NodeTy> struct MDNodeSubsetEqualImpl {
287 using KeyTy = MDNodeKeyImpl<NodeTy>;
288
289 static bool isSubsetEqual(const KeyTy &LHS, const NodeTy *RHS) {
290 return false;
291 }
292
293 static bool isSubsetEqual(const NodeTy *LHS, const NodeTy *RHS) {
294 return false;
295 }
296};
297
298/// DenseMapInfo for MDTuple.
299///
300/// Note that we don't need the is-function-local bit, since that's implicit in
301/// the operands.
302template <> struct MDNodeKeyImpl<MDTuple> : MDNodeOpsKey {
303 MDNodeKeyImpl(ArrayRef<Metadata *> Ops) : MDNodeOpsKey(Ops) {}
304 MDNodeKeyImpl(const MDTuple *N) : MDNodeOpsKey(N) {}
305
306 bool isKeyOf(const MDTuple *RHS) const { return compareOps(RHS); }
307
308 unsigned getHashValue() const { return getHash(); }
309
310 static unsigned calculateHash(MDTuple *N) {
311 return MDNodeOpsKey::calculateHash(N);
312 }
313};
314
315/// DenseMapInfo for DILocation.
316template <> struct MDNodeKeyImpl<DILocation> {
317 unsigned Line;
318 unsigned Column;
319 Metadata *Scope;
320 Metadata *InlinedAt;
321 bool ImplicitCode;
322
323 MDNodeKeyImpl(unsigned Line, unsigned Column, Metadata *Scope,
324 Metadata *InlinedAt, bool ImplicitCode)
325 : Line(Line), Column(Column), Scope(Scope), InlinedAt(InlinedAt),
326 ImplicitCode(ImplicitCode) {}
327 MDNodeKeyImpl(const DILocation *L)
328 : Line(L->getLine()), Column(L->getColumn()), Scope(L->getRawScope()),
329 InlinedAt(L->getRawInlinedAt()), ImplicitCode(L->isImplicitCode()) {}
330
331 bool isKeyOf(const DILocation *RHS) const {
332 return Line == RHS->getLine() && Column == RHS->getColumn() &&
333 Scope == RHS->getRawScope() && InlinedAt == RHS->getRawInlinedAt() &&
334 ImplicitCode == RHS->isImplicitCode();
335 }
336
337 unsigned getHashValue() const {
338 return hash_combine(args: Line, args: Column, args: Scope, args: InlinedAt, args: ImplicitCode);
339 }
340};
341
342/// DenseMapInfo for GenericDINode.
343template <> struct MDNodeKeyImpl<GenericDINode> : MDNodeOpsKey {
344 unsigned Tag;
345 MDString *Header;
346
347 MDNodeKeyImpl(unsigned Tag, MDString *Header, ArrayRef<Metadata *> DwarfOps)
348 : MDNodeOpsKey(DwarfOps), Tag(Tag), Header(Header) {}
349 MDNodeKeyImpl(const GenericDINode *N)
350 : MDNodeOpsKey(N, 1), Tag(N->getTag()), Header(N->getRawHeader()) {}
351
352 bool isKeyOf(const GenericDINode *RHS) const {
353 return Tag == RHS->getTag() && Header == RHS->getRawHeader() &&
354 compareOps(RHS, Offset: 1);
355 }
356
357 unsigned getHashValue() const { return hash_combine(args: getHash(), args: Tag, args: Header); }
358
359 static unsigned calculateHash(GenericDINode *N) {
360 return MDNodeOpsKey::calculateHash(N, Offset: 1);
361 }
362};
363
364template <> struct MDNodeKeyImpl<DISubrange> {
365 Metadata *CountNode;
366 Metadata *LowerBound;
367 Metadata *UpperBound;
368 Metadata *Stride;
369
370 MDNodeKeyImpl(Metadata *CountNode, Metadata *LowerBound, Metadata *UpperBound,
371 Metadata *Stride)
372 : CountNode(CountNode), LowerBound(LowerBound), UpperBound(UpperBound),
373 Stride(Stride) {}
374 MDNodeKeyImpl(const DISubrange *N)
375 : CountNode(N->getRawCountNode()), LowerBound(N->getRawLowerBound()),
376 UpperBound(N->getRawUpperBound()), Stride(N->getRawStride()) {}
377
378 bool isKeyOf(const DISubrange *RHS) const {
379 auto BoundsEqual = [=](Metadata *Node1, Metadata *Node2) -> bool {
380 if (Node1 == Node2)
381 return true;
382
383 ConstantAsMetadata *MD1 = dyn_cast_or_null<ConstantAsMetadata>(Val: Node1);
384 ConstantAsMetadata *MD2 = dyn_cast_or_null<ConstantAsMetadata>(Val: Node2);
385 if (MD1 && MD2) {
386 ConstantInt *CV1 = cast<ConstantInt>(Val: MD1->getValue());
387 ConstantInt *CV2 = cast<ConstantInt>(Val: MD2->getValue());
388 if (CV1->getSExtValue() == CV2->getSExtValue())
389 return true;
390 }
391 return false;
392 };
393
394 return BoundsEqual(CountNode, RHS->getRawCountNode()) &&
395 BoundsEqual(LowerBound, RHS->getRawLowerBound()) &&
396 BoundsEqual(UpperBound, RHS->getRawUpperBound()) &&
397 BoundsEqual(Stride, RHS->getRawStride());
398 }
399
400 unsigned getHashValue() const {
401 if (CountNode)
402 if (auto *MD = dyn_cast<ConstantAsMetadata>(Val: CountNode))
403 return hash_combine(args: cast<ConstantInt>(Val: MD->getValue())->getSExtValue(),
404 args: LowerBound, args: UpperBound, args: Stride);
405 return hash_combine(args: CountNode, args: LowerBound, args: UpperBound, args: Stride);
406 }
407};
408
409template <> struct MDNodeKeyImpl<DIGenericSubrange> {
410 Metadata *CountNode;
411 Metadata *LowerBound;
412 Metadata *UpperBound;
413 Metadata *Stride;
414
415 MDNodeKeyImpl(Metadata *CountNode, Metadata *LowerBound, Metadata *UpperBound,
416 Metadata *Stride)
417 : CountNode(CountNode), LowerBound(LowerBound), UpperBound(UpperBound),
418 Stride(Stride) {}
419 MDNodeKeyImpl(const DIGenericSubrange *N)
420 : CountNode(N->getRawCountNode()), LowerBound(N->getRawLowerBound()),
421 UpperBound(N->getRawUpperBound()), Stride(N->getRawStride()) {}
422
423 bool isKeyOf(const DIGenericSubrange *RHS) const {
424 return (CountNode == RHS->getRawCountNode()) &&
425 (LowerBound == RHS->getRawLowerBound()) &&
426 (UpperBound == RHS->getRawUpperBound()) &&
427 (Stride == RHS->getRawStride());
428 }
429
430 unsigned getHashValue() const {
431 auto *MD = dyn_cast_or_null<ConstantAsMetadata>(Val: CountNode);
432 if (CountNode && MD)
433 return hash_combine(args: cast<ConstantInt>(Val: MD->getValue())->getSExtValue(),
434 args: LowerBound, args: UpperBound, args: Stride);
435 return hash_combine(args: CountNode, args: LowerBound, args: UpperBound, args: Stride);
436 }
437};
438
439template <> struct MDNodeKeyImpl<DIEnumerator> {
440 APInt Value;
441 MDString *Name;
442 bool IsUnsigned;
443
444 MDNodeKeyImpl(APInt Value, bool IsUnsigned, MDString *Name)
445 : Value(std::move(Value)), Name(Name), IsUnsigned(IsUnsigned) {}
446 MDNodeKeyImpl(int64_t Value, bool IsUnsigned, MDString *Name)
447 : Value(APInt(64, Value, !IsUnsigned)), Name(Name),
448 IsUnsigned(IsUnsigned) {}
449 MDNodeKeyImpl(const DIEnumerator *N)
450 : Value(N->getValue()), Name(N->getRawName()),
451 IsUnsigned(N->isUnsigned()) {}
452
453 bool isKeyOf(const DIEnumerator *RHS) const {
454 return Value.getBitWidth() == RHS->getValue().getBitWidth() &&
455 Value == RHS->getValue() && IsUnsigned == RHS->isUnsigned() &&
456 Name == RHS->getRawName();
457 }
458
459 unsigned getHashValue() const { return hash_combine(args: Value, args: Name); }
460};
461
462template <> struct MDNodeKeyImpl<DIBasicType> {
463 unsigned Tag;
464 MDString *Name;
465 uint64_t SizeInBits;
466 uint32_t AlignInBits;
467 unsigned Encoding;
468 unsigned Flags;
469
470 MDNodeKeyImpl(unsigned Tag, MDString *Name, uint64_t SizeInBits,
471 uint32_t AlignInBits, unsigned Encoding, unsigned Flags)
472 : Tag(Tag), Name(Name), SizeInBits(SizeInBits), AlignInBits(AlignInBits),
473 Encoding(Encoding), Flags(Flags) {}
474 MDNodeKeyImpl(const DIBasicType *N)
475 : Tag(N->getTag()), Name(N->getRawName()), SizeInBits(N->getSizeInBits()),
476 AlignInBits(N->getAlignInBits()), Encoding(N->getEncoding()),
477 Flags(N->getFlags()) {}
478
479 bool isKeyOf(const DIBasicType *RHS) const {
480 return Tag == RHS->getTag() && Name == RHS->getRawName() &&
481 SizeInBits == RHS->getSizeInBits() &&
482 AlignInBits == RHS->getAlignInBits() &&
483 Encoding == RHS->getEncoding() && Flags == RHS->getFlags();
484 }
485
486 unsigned getHashValue() const {
487 return hash_combine(args: Tag, args: Name, args: SizeInBits, args: AlignInBits, args: Encoding);
488 }
489};
490
491template <> struct MDNodeKeyImpl<DIStringType> {
492 unsigned Tag;
493 MDString *Name;
494 Metadata *StringLength;
495 Metadata *StringLengthExp;
496 Metadata *StringLocationExp;
497 uint64_t SizeInBits;
498 uint32_t AlignInBits;
499 unsigned Encoding;
500
501 MDNodeKeyImpl(unsigned Tag, MDString *Name, Metadata *StringLength,
502 Metadata *StringLengthExp, Metadata *StringLocationExp,
503 uint64_t SizeInBits, uint32_t AlignInBits, unsigned Encoding)
504 : Tag(Tag), Name(Name), StringLength(StringLength),
505 StringLengthExp(StringLengthExp), StringLocationExp(StringLocationExp),
506 SizeInBits(SizeInBits), AlignInBits(AlignInBits), Encoding(Encoding) {}
507 MDNodeKeyImpl(const DIStringType *N)
508 : Tag(N->getTag()), Name(N->getRawName()),
509 StringLength(N->getRawStringLength()),
510 StringLengthExp(N->getRawStringLengthExp()),
511 StringLocationExp(N->getRawStringLocationExp()),
512 SizeInBits(N->getSizeInBits()), AlignInBits(N->getAlignInBits()),
513 Encoding(N->getEncoding()) {}
514
515 bool isKeyOf(const DIStringType *RHS) const {
516 return Tag == RHS->getTag() && Name == RHS->getRawName() &&
517 StringLength == RHS->getRawStringLength() &&
518 StringLengthExp == RHS->getRawStringLengthExp() &&
519 StringLocationExp == RHS->getRawStringLocationExp() &&
520 SizeInBits == RHS->getSizeInBits() &&
521 AlignInBits == RHS->getAlignInBits() &&
522 Encoding == RHS->getEncoding();
523 }
524 unsigned getHashValue() const {
525 // Intentionally computes the hash on a subset of the operands for
526 // performance reason. The subset has to be significant enough to avoid
527 // collision "most of the time". There is no correctness issue in case of
528 // collision because of the full check above.
529 return hash_combine(args: Tag, args: Name, args: StringLength, args: Encoding);
530 }
531};
532
533template <> struct MDNodeKeyImpl<DIDerivedType> {
534 unsigned Tag;
535 MDString *Name;
536 Metadata *File;
537 unsigned Line;
538 Metadata *Scope;
539 Metadata *BaseType;
540 uint64_t SizeInBits;
541 uint64_t OffsetInBits;
542 uint32_t AlignInBits;
543 std::optional<unsigned> DWARFAddressSpace;
544 std::optional<DIDerivedType::PtrAuthData> PtrAuthData;
545 unsigned Flags;
546 Metadata *ExtraData;
547 Metadata *Annotations;
548
549 MDNodeKeyImpl(unsigned Tag, MDString *Name, Metadata *File, unsigned Line,
550 Metadata *Scope, Metadata *BaseType, uint64_t SizeInBits,
551 uint32_t AlignInBits, uint64_t OffsetInBits,
552 std::optional<unsigned> DWARFAddressSpace,
553 std::optional<DIDerivedType::PtrAuthData> PtrAuthData,
554 unsigned Flags, Metadata *ExtraData, Metadata *Annotations)
555 : Tag(Tag), Name(Name), File(File), Line(Line), Scope(Scope),
556 BaseType(BaseType), SizeInBits(SizeInBits), OffsetInBits(OffsetInBits),
557 AlignInBits(AlignInBits), DWARFAddressSpace(DWARFAddressSpace),
558 PtrAuthData(PtrAuthData), Flags(Flags), ExtraData(ExtraData),
559 Annotations(Annotations) {}
560 MDNodeKeyImpl(const DIDerivedType *N)
561 : Tag(N->getTag()), Name(N->getRawName()), File(N->getRawFile()),
562 Line(N->getLine()), Scope(N->getRawScope()),
563 BaseType(N->getRawBaseType()), SizeInBits(N->getSizeInBits()),
564 OffsetInBits(N->getOffsetInBits()), AlignInBits(N->getAlignInBits()),
565 DWARFAddressSpace(N->getDWARFAddressSpace()),
566 PtrAuthData(N->getPtrAuthData()), Flags(N->getFlags()),
567 ExtraData(N->getRawExtraData()), Annotations(N->getRawAnnotations()) {}
568
569 bool isKeyOf(const DIDerivedType *RHS) const {
570 return Tag == RHS->getTag() && Name == RHS->getRawName() &&
571 File == RHS->getRawFile() && Line == RHS->getLine() &&
572 Scope == RHS->getRawScope() && BaseType == RHS->getRawBaseType() &&
573 SizeInBits == RHS->getSizeInBits() &&
574 AlignInBits == RHS->getAlignInBits() &&
575 OffsetInBits == RHS->getOffsetInBits() &&
576 DWARFAddressSpace == RHS->getDWARFAddressSpace() &&
577 PtrAuthData == RHS->getPtrAuthData() && Flags == RHS->getFlags() &&
578 ExtraData == RHS->getRawExtraData() &&
579 Annotations == RHS->getRawAnnotations();
580 }
581
582 unsigned getHashValue() const {
583 // If this is a member inside an ODR type, only hash the type and the name.
584 // Otherwise the hash will be stronger than
585 // MDNodeSubsetEqualImpl::isODRMember().
586 if (Tag == dwarf::DW_TAG_member && Name)
587 if (auto *CT = dyn_cast_or_null<DICompositeType>(Val: Scope))
588 if (CT->getRawIdentifier())
589 return hash_combine(args: Name, args: Scope);
590
591 // Intentionally computes the hash on a subset of the operands for
592 // performance reason. The subset has to be significant enough to avoid
593 // collision "most of the time". There is no correctness issue in case of
594 // collision because of the full check above.
595 return hash_combine(args: Tag, args: Name, args: File, args: Line, args: Scope, args: BaseType, args: Flags);
596 }
597};
598
599template <> struct MDNodeSubsetEqualImpl<DIDerivedType> {
600 using KeyTy = MDNodeKeyImpl<DIDerivedType>;
601
602 static bool isSubsetEqual(const KeyTy &LHS, const DIDerivedType *RHS) {
603 return isODRMember(Tag: LHS.Tag, Scope: LHS.Scope, Name: LHS.Name, RHS);
604 }
605
606 static bool isSubsetEqual(const DIDerivedType *LHS,
607 const DIDerivedType *RHS) {
608 return isODRMember(Tag: LHS->getTag(), Scope: LHS->getRawScope(), Name: LHS->getRawName(),
609 RHS);
610 }
611
612 /// Subprograms compare equal if they declare the same function in an ODR
613 /// type.
614 static bool isODRMember(unsigned Tag, const Metadata *Scope,
615 const MDString *Name, const DIDerivedType *RHS) {
616 // Check whether the LHS is eligible.
617 if (Tag != dwarf::DW_TAG_member || !Name)
618 return false;
619
620 auto *CT = dyn_cast_or_null<DICompositeType>(Val: Scope);
621 if (!CT || !CT->getRawIdentifier())
622 return false;
623
624 // Compare to the RHS.
625 return Tag == RHS->getTag() && Name == RHS->getRawName() &&
626 Scope == RHS->getRawScope();
627 }
628};
629
630template <> struct MDNodeKeyImpl<DICompositeType> {
631 unsigned Tag;
632 MDString *Name;
633 Metadata *File;
634 unsigned Line;
635 Metadata *Scope;
636 Metadata *BaseType;
637 uint64_t SizeInBits;
638 uint64_t OffsetInBits;
639 uint32_t AlignInBits;
640 unsigned Flags;
641 Metadata *Elements;
642 unsigned RuntimeLang;
643 Metadata *VTableHolder;
644 Metadata *TemplateParams;
645 MDString *Identifier;
646 Metadata *Discriminator;
647 Metadata *DataLocation;
648 Metadata *Associated;
649 Metadata *Allocated;
650 Metadata *Rank;
651 Metadata *Annotations;
652
653 MDNodeKeyImpl(unsigned Tag, MDString *Name, Metadata *File, unsigned Line,
654 Metadata *Scope, Metadata *BaseType, uint64_t SizeInBits,
655 uint32_t AlignInBits, uint64_t OffsetInBits, unsigned Flags,
656 Metadata *Elements, unsigned RuntimeLang,
657 Metadata *VTableHolder, Metadata *TemplateParams,
658 MDString *Identifier, Metadata *Discriminator,
659 Metadata *DataLocation, Metadata *Associated,
660 Metadata *Allocated, Metadata *Rank, Metadata *Annotations)
661 : Tag(Tag), Name(Name), File(File), Line(Line), Scope(Scope),
662 BaseType(BaseType), SizeInBits(SizeInBits), OffsetInBits(OffsetInBits),
663 AlignInBits(AlignInBits), Flags(Flags), Elements(Elements),
664 RuntimeLang(RuntimeLang), VTableHolder(VTableHolder),
665 TemplateParams(TemplateParams), Identifier(Identifier),
666 Discriminator(Discriminator), DataLocation(DataLocation),
667 Associated(Associated), Allocated(Allocated), Rank(Rank),
668 Annotations(Annotations) {}
669 MDNodeKeyImpl(const DICompositeType *N)
670 : Tag(N->getTag()), Name(N->getRawName()), File(N->getRawFile()),
671 Line(N->getLine()), Scope(N->getRawScope()),
672 BaseType(N->getRawBaseType()), SizeInBits(N->getSizeInBits()),
673 OffsetInBits(N->getOffsetInBits()), AlignInBits(N->getAlignInBits()),
674 Flags(N->getFlags()), Elements(N->getRawElements()),
675 RuntimeLang(N->getRuntimeLang()), VTableHolder(N->getRawVTableHolder()),
676 TemplateParams(N->getRawTemplateParams()),
677 Identifier(N->getRawIdentifier()),
678 Discriminator(N->getRawDiscriminator()),
679 DataLocation(N->getRawDataLocation()),
680 Associated(N->getRawAssociated()), Allocated(N->getRawAllocated()),
681 Rank(N->getRawRank()), Annotations(N->getRawAnnotations()) {}
682
683 bool isKeyOf(const DICompositeType *RHS) const {
684 return Tag == RHS->getTag() && Name == RHS->getRawName() &&
685 File == RHS->getRawFile() && Line == RHS->getLine() &&
686 Scope == RHS->getRawScope() && BaseType == RHS->getRawBaseType() &&
687 SizeInBits == RHS->getSizeInBits() &&
688 AlignInBits == RHS->getAlignInBits() &&
689 OffsetInBits == RHS->getOffsetInBits() && Flags == RHS->getFlags() &&
690 Elements == RHS->getRawElements() &&
691 RuntimeLang == RHS->getRuntimeLang() &&
692 VTableHolder == RHS->getRawVTableHolder() &&
693 TemplateParams == RHS->getRawTemplateParams() &&
694 Identifier == RHS->getRawIdentifier() &&
695 Discriminator == RHS->getRawDiscriminator() &&
696 DataLocation == RHS->getRawDataLocation() &&
697 Associated == RHS->getRawAssociated() &&
698 Allocated == RHS->getRawAllocated() && Rank == RHS->getRawRank() &&
699 Annotations == RHS->getRawAnnotations();
700 }
701
702 unsigned getHashValue() const {
703 // Intentionally computes the hash on a subset of the operands for
704 // performance reason. The subset has to be significant enough to avoid
705 // collision "most of the time". There is no correctness issue in case of
706 // collision because of the full check above.
707 return hash_combine(args: Name, args: File, args: Line, args: BaseType, args: Scope, args: Elements,
708 args: TemplateParams, args: Annotations);
709 }
710};
711
712template <> struct MDNodeKeyImpl<DISubroutineType> {
713 unsigned Flags;
714 uint8_t CC;
715 Metadata *TypeArray;
716
717 MDNodeKeyImpl(unsigned Flags, uint8_t CC, Metadata *TypeArray)
718 : Flags(Flags), CC(CC), TypeArray(TypeArray) {}
719 MDNodeKeyImpl(const DISubroutineType *N)
720 : Flags(N->getFlags()), CC(N->getCC()), TypeArray(N->getRawTypeArray()) {}
721
722 bool isKeyOf(const DISubroutineType *RHS) const {
723 return Flags == RHS->getFlags() && CC == RHS->getCC() &&
724 TypeArray == RHS->getRawTypeArray();
725 }
726
727 unsigned getHashValue() const { return hash_combine(args: Flags, args: CC, args: TypeArray); }
728};
729
730template <> struct MDNodeKeyImpl<DIFile> {
731 MDString *Filename;
732 MDString *Directory;
733 std::optional<DIFile::ChecksumInfo<MDString *>> Checksum;
734 MDString *Source;
735
736 MDNodeKeyImpl(MDString *Filename, MDString *Directory,
737 std::optional<DIFile::ChecksumInfo<MDString *>> Checksum,
738 MDString *Source)
739 : Filename(Filename), Directory(Directory), Checksum(Checksum),
740 Source(Source) {}
741 MDNodeKeyImpl(const DIFile *N)
742 : Filename(N->getRawFilename()), Directory(N->getRawDirectory()),
743 Checksum(N->getRawChecksum()), Source(N->getRawSource()) {}
744
745 bool isKeyOf(const DIFile *RHS) const {
746 return Filename == RHS->getRawFilename() &&
747 Directory == RHS->getRawDirectory() &&
748 Checksum == RHS->getRawChecksum() && Source == RHS->getRawSource();
749 }
750
751 unsigned getHashValue() const {
752 return hash_combine(args: Filename, args: Directory, args: Checksum ? Checksum->Kind : 0,
753 args: Checksum ? Checksum->Value : nullptr, args: Source);
754 }
755};
756
757template <> struct MDNodeKeyImpl<DISubprogram> {
758 Metadata *Scope;
759 MDString *Name;
760 MDString *LinkageName;
761 Metadata *File;
762 unsigned Line;
763 Metadata *Type;
764 unsigned ScopeLine;
765 Metadata *ContainingType;
766 unsigned VirtualIndex;
767 int ThisAdjustment;
768 unsigned Flags;
769 unsigned SPFlags;
770 Metadata *Unit;
771 Metadata *TemplateParams;
772 Metadata *Declaration;
773 Metadata *RetainedNodes;
774 Metadata *ThrownTypes;
775 Metadata *Annotations;
776 MDString *TargetFuncName;
777
778 MDNodeKeyImpl(Metadata *Scope, MDString *Name, MDString *LinkageName,
779 Metadata *File, unsigned Line, Metadata *Type,
780 unsigned ScopeLine, Metadata *ContainingType,
781 unsigned VirtualIndex, int ThisAdjustment, unsigned Flags,
782 unsigned SPFlags, Metadata *Unit, Metadata *TemplateParams,
783 Metadata *Declaration, Metadata *RetainedNodes,
784 Metadata *ThrownTypes, Metadata *Annotations,
785 MDString *TargetFuncName)
786 : Scope(Scope), Name(Name), LinkageName(LinkageName), File(File),
787 Line(Line), Type(Type), ScopeLine(ScopeLine),
788 ContainingType(ContainingType), VirtualIndex(VirtualIndex),
789 ThisAdjustment(ThisAdjustment), Flags(Flags), SPFlags(SPFlags),
790 Unit(Unit), TemplateParams(TemplateParams), Declaration(Declaration),
791 RetainedNodes(RetainedNodes), ThrownTypes(ThrownTypes),
792 Annotations(Annotations), TargetFuncName(TargetFuncName) {}
793 MDNodeKeyImpl(const DISubprogram *N)
794 : Scope(N->getRawScope()), Name(N->getRawName()),
795 LinkageName(N->getRawLinkageName()), File(N->getRawFile()),
796 Line(N->getLine()), Type(N->getRawType()), ScopeLine(N->getScopeLine()),
797 ContainingType(N->getRawContainingType()),
798 VirtualIndex(N->getVirtualIndex()),
799 ThisAdjustment(N->getThisAdjustment()), Flags(N->getFlags()),
800 SPFlags(N->getSPFlags()), Unit(N->getRawUnit()),
801 TemplateParams(N->getRawTemplateParams()),
802 Declaration(N->getRawDeclaration()),
803 RetainedNodes(N->getRawRetainedNodes()),
804 ThrownTypes(N->getRawThrownTypes()),
805 Annotations(N->getRawAnnotations()),
806 TargetFuncName(N->getRawTargetFuncName()) {}
807
808 bool isKeyOf(const DISubprogram *RHS) const {
809 return Scope == RHS->getRawScope() && Name == RHS->getRawName() &&
810 LinkageName == RHS->getRawLinkageName() &&
811 File == RHS->getRawFile() && Line == RHS->getLine() &&
812 Type == RHS->getRawType() && ScopeLine == RHS->getScopeLine() &&
813 ContainingType == RHS->getRawContainingType() &&
814 VirtualIndex == RHS->getVirtualIndex() &&
815 ThisAdjustment == RHS->getThisAdjustment() &&
816 Flags == RHS->getFlags() && SPFlags == RHS->getSPFlags() &&
817 Unit == RHS->getUnit() &&
818 TemplateParams == RHS->getRawTemplateParams() &&
819 Declaration == RHS->getRawDeclaration() &&
820 RetainedNodes == RHS->getRawRetainedNodes() &&
821 ThrownTypes == RHS->getRawThrownTypes() &&
822 Annotations == RHS->getRawAnnotations() &&
823 TargetFuncName == RHS->getRawTargetFuncName();
824 }
825
826 bool isDefinition() const { return SPFlags & DISubprogram::SPFlagDefinition; }
827
828 unsigned getHashValue() const {
829 // Use the Scope's linkage name instead of using the scope directly, as the
830 // scope may be a temporary one which can replaced, which would produce a
831 // different hash for the same DISubprogram.
832 llvm::StringRef ScopeLinkageName;
833 if (auto *CT = dyn_cast_or_null<DICompositeType>(Val: Scope))
834 if (auto *ID = CT->getRawIdentifier())
835 ScopeLinkageName = ID->getString();
836
837 // If this is a declaration inside an ODR type, only hash the type and the
838 // name. Otherwise the hash will be stronger than
839 // MDNodeSubsetEqualImpl::isDeclarationOfODRMember().
840 if (!isDefinition() && LinkageName &&
841 isa_and_nonnull<DICompositeType>(Val: Scope))
842 return hash_combine(args: LinkageName, args: ScopeLinkageName);
843
844 // Intentionally computes the hash on a subset of the operands for
845 // performance reason. The subset has to be significant enough to avoid
846 // collision "most of the time". There is no correctness issue in case of
847 // collision because of the full check above.
848 return hash_combine(args: Name, args: ScopeLinkageName, args: File, args: Type, args: Line);
849 }
850};
851
852template <> struct MDNodeSubsetEqualImpl<DISubprogram> {
853 using KeyTy = MDNodeKeyImpl<DISubprogram>;
854
855 static bool isSubsetEqual(const KeyTy &LHS, const DISubprogram *RHS) {
856 return isDeclarationOfODRMember(IsDefinition: LHS.isDefinition(), Scope: LHS.Scope,
857 LinkageName: LHS.LinkageName, TemplateParams: LHS.TemplateParams, RHS);
858 }
859
860 static bool isSubsetEqual(const DISubprogram *LHS, const DISubprogram *RHS) {
861 return isDeclarationOfODRMember(IsDefinition: LHS->isDefinition(), Scope: LHS->getRawScope(),
862 LinkageName: LHS->getRawLinkageName(),
863 TemplateParams: LHS->getRawTemplateParams(), RHS);
864 }
865
866 /// Subprograms compare equal if they declare the same function in an ODR
867 /// type.
868 static bool isDeclarationOfODRMember(bool IsDefinition, const Metadata *Scope,
869 const MDString *LinkageName,
870 const Metadata *TemplateParams,
871 const DISubprogram *RHS) {
872 // Check whether the LHS is eligible.
873 if (IsDefinition || !Scope || !LinkageName)
874 return false;
875
876 auto *CT = dyn_cast_or_null<DICompositeType>(Val: Scope);
877 if (!CT || !CT->getRawIdentifier())
878 return false;
879
880 // Compare to the RHS.
881 // FIXME: We need to compare template parameters here to avoid incorrect
882 // collisions in mapMetadata when RF_ReuseAndMutateDistinctMDs and a
883 // ODR-DISubprogram has a non-ODR template parameter (i.e., a
884 // DICompositeType that does not have an identifier). Eventually we should
885 // decouple ODR logic from uniquing logic.
886 return IsDefinition == RHS->isDefinition() && Scope == RHS->getRawScope() &&
887 LinkageName == RHS->getRawLinkageName() &&
888 TemplateParams == RHS->getRawTemplateParams();
889 }
890};
891
892template <> struct MDNodeKeyImpl<DILexicalBlock> {
893 Metadata *Scope;
894 Metadata *File;
895 unsigned Line;
896 unsigned Column;
897
898 MDNodeKeyImpl(Metadata *Scope, Metadata *File, unsigned Line, unsigned Column)
899 : Scope(Scope), File(File), Line(Line), Column(Column) {}
900 MDNodeKeyImpl(const DILexicalBlock *N)
901 : Scope(N->getRawScope()), File(N->getRawFile()), Line(N->getLine()),
902 Column(N->getColumn()) {}
903
904 bool isKeyOf(const DILexicalBlock *RHS) const {
905 return Scope == RHS->getRawScope() && File == RHS->getRawFile() &&
906 Line == RHS->getLine() && Column == RHS->getColumn();
907 }
908
909 unsigned getHashValue() const {
910 return hash_combine(args: Scope, args: File, args: Line, args: Column);
911 }
912};
913
914template <> struct MDNodeKeyImpl<DILexicalBlockFile> {
915 Metadata *Scope;
916 Metadata *File;
917 unsigned Discriminator;
918
919 MDNodeKeyImpl(Metadata *Scope, Metadata *File, unsigned Discriminator)
920 : Scope(Scope), File(File), Discriminator(Discriminator) {}
921 MDNodeKeyImpl(const DILexicalBlockFile *N)
922 : Scope(N->getRawScope()), File(N->getRawFile()),
923 Discriminator(N->getDiscriminator()) {}
924
925 bool isKeyOf(const DILexicalBlockFile *RHS) const {
926 return Scope == RHS->getRawScope() && File == RHS->getRawFile() &&
927 Discriminator == RHS->getDiscriminator();
928 }
929
930 unsigned getHashValue() const {
931 return hash_combine(args: Scope, args: File, args: Discriminator);
932 }
933};
934
935template <> struct MDNodeKeyImpl<DINamespace> {
936 Metadata *Scope;
937 MDString *Name;
938 bool ExportSymbols;
939
940 MDNodeKeyImpl(Metadata *Scope, MDString *Name, bool ExportSymbols)
941 : Scope(Scope), Name(Name), ExportSymbols(ExportSymbols) {}
942 MDNodeKeyImpl(const DINamespace *N)
943 : Scope(N->getRawScope()), Name(N->getRawName()),
944 ExportSymbols(N->getExportSymbols()) {}
945
946 bool isKeyOf(const DINamespace *RHS) const {
947 return Scope == RHS->getRawScope() && Name == RHS->getRawName() &&
948 ExportSymbols == RHS->getExportSymbols();
949 }
950
951 unsigned getHashValue() const { return hash_combine(args: Scope, args: Name); }
952};
953
954template <> struct MDNodeKeyImpl<DICommonBlock> {
955 Metadata *Scope;
956 Metadata *Decl;
957 MDString *Name;
958 Metadata *File;
959 unsigned LineNo;
960
961 MDNodeKeyImpl(Metadata *Scope, Metadata *Decl, MDString *Name, Metadata *File,
962 unsigned LineNo)
963 : Scope(Scope), Decl(Decl), Name(Name), File(File), LineNo(LineNo) {}
964 MDNodeKeyImpl(const DICommonBlock *N)
965 : Scope(N->getRawScope()), Decl(N->getRawDecl()), Name(N->getRawName()),
966 File(N->getRawFile()), LineNo(N->getLineNo()) {}
967
968 bool isKeyOf(const DICommonBlock *RHS) const {
969 return Scope == RHS->getRawScope() && Decl == RHS->getRawDecl() &&
970 Name == RHS->getRawName() && File == RHS->getRawFile() &&
971 LineNo == RHS->getLineNo();
972 }
973
974 unsigned getHashValue() const {
975 return hash_combine(args: Scope, args: Decl, args: Name, args: File, args: LineNo);
976 }
977};
978
979template <> struct MDNodeKeyImpl<DIModule> {
980 Metadata *File;
981 Metadata *Scope;
982 MDString *Name;
983 MDString *ConfigurationMacros;
984 MDString *IncludePath;
985 MDString *APINotesFile;
986 unsigned LineNo;
987 bool IsDecl;
988
989 MDNodeKeyImpl(Metadata *File, Metadata *Scope, MDString *Name,
990 MDString *ConfigurationMacros, MDString *IncludePath,
991 MDString *APINotesFile, unsigned LineNo, bool IsDecl)
992 : File(File), Scope(Scope), Name(Name),
993 ConfigurationMacros(ConfigurationMacros), IncludePath(IncludePath),
994 APINotesFile(APINotesFile), LineNo(LineNo), IsDecl(IsDecl) {}
995 MDNodeKeyImpl(const DIModule *N)
996 : File(N->getRawFile()), Scope(N->getRawScope()), Name(N->getRawName()),
997 ConfigurationMacros(N->getRawConfigurationMacros()),
998 IncludePath(N->getRawIncludePath()),
999 APINotesFile(N->getRawAPINotesFile()), LineNo(N->getLineNo()),
1000 IsDecl(N->getIsDecl()) {}
1001
1002 bool isKeyOf(const DIModule *RHS) const {
1003 return Scope == RHS->getRawScope() && Name == RHS->getRawName() &&
1004 ConfigurationMacros == RHS->getRawConfigurationMacros() &&
1005 IncludePath == RHS->getRawIncludePath() &&
1006 APINotesFile == RHS->getRawAPINotesFile() &&
1007 File == RHS->getRawFile() && LineNo == RHS->getLineNo() &&
1008 IsDecl == RHS->getIsDecl();
1009 }
1010
1011 unsigned getHashValue() const {
1012 return hash_combine(args: Scope, args: Name, args: ConfigurationMacros, args: IncludePath);
1013 }
1014};
1015
1016template <> struct MDNodeKeyImpl<DITemplateTypeParameter> {
1017 MDString *Name;
1018 Metadata *Type;
1019 bool IsDefault;
1020
1021 MDNodeKeyImpl(MDString *Name, Metadata *Type, bool IsDefault)
1022 : Name(Name), Type(Type), IsDefault(IsDefault) {}
1023 MDNodeKeyImpl(const DITemplateTypeParameter *N)
1024 : Name(N->getRawName()), Type(N->getRawType()),
1025 IsDefault(N->isDefault()) {}
1026
1027 bool isKeyOf(const DITemplateTypeParameter *RHS) const {
1028 return Name == RHS->getRawName() && Type == RHS->getRawType() &&
1029 IsDefault == RHS->isDefault();
1030 }
1031
1032 unsigned getHashValue() const { return hash_combine(args: Name, args: Type, args: IsDefault); }
1033};
1034
1035template <> struct MDNodeKeyImpl<DITemplateValueParameter> {
1036 unsigned Tag;
1037 MDString *Name;
1038 Metadata *Type;
1039 bool IsDefault;
1040 Metadata *Value;
1041
1042 MDNodeKeyImpl(unsigned Tag, MDString *Name, Metadata *Type, bool IsDefault,
1043 Metadata *Value)
1044 : Tag(Tag), Name(Name), Type(Type), IsDefault(IsDefault), Value(Value) {}
1045 MDNodeKeyImpl(const DITemplateValueParameter *N)
1046 : Tag(N->getTag()), Name(N->getRawName()), Type(N->getRawType()),
1047 IsDefault(N->isDefault()), Value(N->getValue()) {}
1048
1049 bool isKeyOf(const DITemplateValueParameter *RHS) const {
1050 return Tag == RHS->getTag() && Name == RHS->getRawName() &&
1051 Type == RHS->getRawType() && IsDefault == RHS->isDefault() &&
1052 Value == RHS->getValue();
1053 }
1054
1055 unsigned getHashValue() const {
1056 return hash_combine(args: Tag, args: Name, args: Type, args: IsDefault, args: Value);
1057 }
1058};
1059
1060template <> struct MDNodeKeyImpl<DIGlobalVariable> {
1061 Metadata *Scope;
1062 MDString *Name;
1063 MDString *LinkageName;
1064 Metadata *File;
1065 unsigned Line;
1066 Metadata *Type;
1067 bool IsLocalToUnit;
1068 bool IsDefinition;
1069 Metadata *StaticDataMemberDeclaration;
1070 Metadata *TemplateParams;
1071 uint32_t AlignInBits;
1072 Metadata *Annotations;
1073
1074 MDNodeKeyImpl(Metadata *Scope, MDString *Name, MDString *LinkageName,
1075 Metadata *File, unsigned Line, Metadata *Type,
1076 bool IsLocalToUnit, bool IsDefinition,
1077 Metadata *StaticDataMemberDeclaration, Metadata *TemplateParams,
1078 uint32_t AlignInBits, Metadata *Annotations)
1079 : Scope(Scope), Name(Name), LinkageName(LinkageName), File(File),
1080 Line(Line), Type(Type), IsLocalToUnit(IsLocalToUnit),
1081 IsDefinition(IsDefinition),
1082 StaticDataMemberDeclaration(StaticDataMemberDeclaration),
1083 TemplateParams(TemplateParams), AlignInBits(AlignInBits),
1084 Annotations(Annotations) {}
1085 MDNodeKeyImpl(const DIGlobalVariable *N)
1086 : Scope(N->getRawScope()), Name(N->getRawName()),
1087 LinkageName(N->getRawLinkageName()), File(N->getRawFile()),
1088 Line(N->getLine()), Type(N->getRawType()),
1089 IsLocalToUnit(N->isLocalToUnit()), IsDefinition(N->isDefinition()),
1090 StaticDataMemberDeclaration(N->getRawStaticDataMemberDeclaration()),
1091 TemplateParams(N->getRawTemplateParams()),
1092 AlignInBits(N->getAlignInBits()), Annotations(N->getRawAnnotations()) {}
1093
1094 bool isKeyOf(const DIGlobalVariable *RHS) const {
1095 return Scope == RHS->getRawScope() && Name == RHS->getRawName() &&
1096 LinkageName == RHS->getRawLinkageName() &&
1097 File == RHS->getRawFile() && Line == RHS->getLine() &&
1098 Type == RHS->getRawType() && IsLocalToUnit == RHS->isLocalToUnit() &&
1099 IsDefinition == RHS->isDefinition() &&
1100 StaticDataMemberDeclaration ==
1101 RHS->getRawStaticDataMemberDeclaration() &&
1102 TemplateParams == RHS->getRawTemplateParams() &&
1103 AlignInBits == RHS->getAlignInBits() &&
1104 Annotations == RHS->getRawAnnotations();
1105 }
1106
1107 unsigned getHashValue() const {
1108 // We do not use AlignInBits in hashing function here on purpose:
1109 // in most cases this param for local variable is zero (for function param
1110 // it is always zero). This leads to lots of hash collisions and errors on
1111 // cases with lots of similar variables.
1112 // clang/test/CodeGen/debug-info-257-args.c is an example of this problem,
1113 // generated IR is random for each run and test fails with Align included.
1114 // TODO: make hashing work fine with such situations
1115 return hash_combine(args: Scope, args: Name, args: LinkageName, args: File, args: Line, args: Type,
1116 args: IsLocalToUnit, args: IsDefinition, /* AlignInBits, */
1117 args: StaticDataMemberDeclaration, args: Annotations);
1118 }
1119};
1120
1121template <> struct MDNodeKeyImpl<DILocalVariable> {
1122 Metadata *Scope;
1123 MDString *Name;
1124 Metadata *File;
1125 unsigned Line;
1126 Metadata *Type;
1127 unsigned Arg;
1128 unsigned Flags;
1129 uint32_t AlignInBits;
1130 Metadata *Annotations;
1131
1132 MDNodeKeyImpl(Metadata *Scope, MDString *Name, Metadata *File, unsigned Line,
1133 Metadata *Type, unsigned Arg, unsigned Flags,
1134 uint32_t AlignInBits, Metadata *Annotations)
1135 : Scope(Scope), Name(Name), File(File), Line(Line), Type(Type), Arg(Arg),
1136 Flags(Flags), AlignInBits(AlignInBits), Annotations(Annotations) {}
1137 MDNodeKeyImpl(const DILocalVariable *N)
1138 : Scope(N->getRawScope()), Name(N->getRawName()), File(N->getRawFile()),
1139 Line(N->getLine()), Type(N->getRawType()), Arg(N->getArg()),
1140 Flags(N->getFlags()), AlignInBits(N->getAlignInBits()),
1141 Annotations(N->getRawAnnotations()) {}
1142
1143 bool isKeyOf(const DILocalVariable *RHS) const {
1144 return Scope == RHS->getRawScope() && Name == RHS->getRawName() &&
1145 File == RHS->getRawFile() && Line == RHS->getLine() &&
1146 Type == RHS->getRawType() && Arg == RHS->getArg() &&
1147 Flags == RHS->getFlags() && AlignInBits == RHS->getAlignInBits() &&
1148 Annotations == RHS->getRawAnnotations();
1149 }
1150
1151 unsigned getHashValue() const {
1152 // We do not use AlignInBits in hashing function here on purpose:
1153 // in most cases this param for local variable is zero (for function param
1154 // it is always zero). This leads to lots of hash collisions and errors on
1155 // cases with lots of similar variables.
1156 // clang/test/CodeGen/debug-info-257-args.c is an example of this problem,
1157 // generated IR is random for each run and test fails with Align included.
1158 // TODO: make hashing work fine with such situations
1159 return hash_combine(args: Scope, args: Name, args: File, args: Line, args: Type, args: Arg, args: Flags, args: Annotations);
1160 }
1161};
1162
1163template <> struct MDNodeKeyImpl<DILabel> {
1164 Metadata *Scope;
1165 MDString *Name;
1166 Metadata *File;
1167 unsigned Line;
1168
1169 MDNodeKeyImpl(Metadata *Scope, MDString *Name, Metadata *File, unsigned Line)
1170 : Scope(Scope), Name(Name), File(File), Line(Line) {}
1171 MDNodeKeyImpl(const DILabel *N)
1172 : Scope(N->getRawScope()), Name(N->getRawName()), File(N->getRawFile()),
1173 Line(N->getLine()) {}
1174
1175 bool isKeyOf(const DILabel *RHS) const {
1176 return Scope == RHS->getRawScope() && Name == RHS->getRawName() &&
1177 File == RHS->getRawFile() && Line == RHS->getLine();
1178 }
1179
1180 /// Using name and line to get hash value. It should already be mostly unique.
1181 unsigned getHashValue() const { return hash_combine(args: Scope, args: Name, args: Line); }
1182};
1183
1184template <> struct MDNodeKeyImpl<DIExpression> {
1185 ArrayRef<uint64_t> Elements;
1186
1187 MDNodeKeyImpl(ArrayRef<uint64_t> Elements) : Elements(Elements) {}
1188 MDNodeKeyImpl(const DIExpression *N) : Elements(N->getElements()) {}
1189
1190 bool isKeyOf(const DIExpression *RHS) const {
1191 return Elements == RHS->getElements();
1192 }
1193
1194 unsigned getHashValue() const {
1195 return hash_combine_range(first: Elements.begin(), last: Elements.end());
1196 }
1197};
1198
1199template <> struct MDNodeKeyImpl<DIGlobalVariableExpression> {
1200 Metadata *Variable;
1201 Metadata *Expression;
1202
1203 MDNodeKeyImpl(Metadata *Variable, Metadata *Expression)
1204 : Variable(Variable), Expression(Expression) {}
1205 MDNodeKeyImpl(const DIGlobalVariableExpression *N)
1206 : Variable(N->getRawVariable()), Expression(N->getRawExpression()) {}
1207
1208 bool isKeyOf(const DIGlobalVariableExpression *RHS) const {
1209 return Variable == RHS->getRawVariable() &&
1210 Expression == RHS->getRawExpression();
1211 }
1212
1213 unsigned getHashValue() const { return hash_combine(args: Variable, args: Expression); }
1214};
1215
1216template <> struct MDNodeKeyImpl<DIObjCProperty> {
1217 MDString *Name;
1218 Metadata *File;
1219 unsigned Line;
1220 MDString *GetterName;
1221 MDString *SetterName;
1222 unsigned Attributes;
1223 Metadata *Type;
1224
1225 MDNodeKeyImpl(MDString *Name, Metadata *File, unsigned Line,
1226 MDString *GetterName, MDString *SetterName, unsigned Attributes,
1227 Metadata *Type)
1228 : Name(Name), File(File), Line(Line), GetterName(GetterName),
1229 SetterName(SetterName), Attributes(Attributes), Type(Type) {}
1230 MDNodeKeyImpl(const DIObjCProperty *N)
1231 : Name(N->getRawName()), File(N->getRawFile()), Line(N->getLine()),
1232 GetterName(N->getRawGetterName()), SetterName(N->getRawSetterName()),
1233 Attributes(N->getAttributes()), Type(N->getRawType()) {}
1234
1235 bool isKeyOf(const DIObjCProperty *RHS) const {
1236 return Name == RHS->getRawName() && File == RHS->getRawFile() &&
1237 Line == RHS->getLine() && GetterName == RHS->getRawGetterName() &&
1238 SetterName == RHS->getRawSetterName() &&
1239 Attributes == RHS->getAttributes() && Type == RHS->getRawType();
1240 }
1241
1242 unsigned getHashValue() const {
1243 return hash_combine(args: Name, args: File, args: Line, args: GetterName, args: SetterName, args: Attributes,
1244 args: Type);
1245 }
1246};
1247
1248template <> struct MDNodeKeyImpl<DIImportedEntity> {
1249 unsigned Tag;
1250 Metadata *Scope;
1251 Metadata *Entity;
1252 Metadata *File;
1253 unsigned Line;
1254 MDString *Name;
1255 Metadata *Elements;
1256
1257 MDNodeKeyImpl(unsigned Tag, Metadata *Scope, Metadata *Entity, Metadata *File,
1258 unsigned Line, MDString *Name, Metadata *Elements)
1259 : Tag(Tag), Scope(Scope), Entity(Entity), File(File), Line(Line),
1260 Name(Name), Elements(Elements) {}
1261 MDNodeKeyImpl(const DIImportedEntity *N)
1262 : Tag(N->getTag()), Scope(N->getRawScope()), Entity(N->getRawEntity()),
1263 File(N->getRawFile()), Line(N->getLine()), Name(N->getRawName()),
1264 Elements(N->getRawElements()) {}
1265
1266 bool isKeyOf(const DIImportedEntity *RHS) const {
1267 return Tag == RHS->getTag() && Scope == RHS->getRawScope() &&
1268 Entity == RHS->getRawEntity() && File == RHS->getFile() &&
1269 Line == RHS->getLine() && Name == RHS->getRawName() &&
1270 Elements == RHS->getRawElements();
1271 }
1272
1273 unsigned getHashValue() const {
1274 return hash_combine(args: Tag, args: Scope, args: Entity, args: File, args: Line, args: Name, args: Elements);
1275 }
1276};
1277
1278template <> struct MDNodeKeyImpl<DIMacro> {
1279 unsigned MIType;
1280 unsigned Line;
1281 MDString *Name;
1282 MDString *Value;
1283
1284 MDNodeKeyImpl(unsigned MIType, unsigned Line, MDString *Name, MDString *Value)
1285 : MIType(MIType), Line(Line), Name(Name), Value(Value) {}
1286 MDNodeKeyImpl(const DIMacro *N)
1287 : MIType(N->getMacinfoType()), Line(N->getLine()), Name(N->getRawName()),
1288 Value(N->getRawValue()) {}
1289
1290 bool isKeyOf(const DIMacro *RHS) const {
1291 return MIType == RHS->getMacinfoType() && Line == RHS->getLine() &&
1292 Name == RHS->getRawName() && Value == RHS->getRawValue();
1293 }
1294
1295 unsigned getHashValue() const {
1296 return hash_combine(args: MIType, args: Line, args: Name, args: Value);
1297 }
1298};
1299
1300template <> struct MDNodeKeyImpl<DIMacroFile> {
1301 unsigned MIType;
1302 unsigned Line;
1303 Metadata *File;
1304 Metadata *Elements;
1305
1306 MDNodeKeyImpl(unsigned MIType, unsigned Line, Metadata *File,
1307 Metadata *Elements)
1308 : MIType(MIType), Line(Line), File(File), Elements(Elements) {}
1309 MDNodeKeyImpl(const DIMacroFile *N)
1310 : MIType(N->getMacinfoType()), Line(N->getLine()), File(N->getRawFile()),
1311 Elements(N->getRawElements()) {}
1312
1313 bool isKeyOf(const DIMacroFile *RHS) const {
1314 return MIType == RHS->getMacinfoType() && Line == RHS->getLine() &&
1315 File == RHS->getRawFile() && Elements == RHS->getRawElements();
1316 }
1317
1318 unsigned getHashValue() const {
1319 return hash_combine(args: MIType, args: Line, args: File, args: Elements);
1320 }
1321};
1322
1323// DIArgLists are not MDNodes, but we still want to unique them in a DenseSet
1324// based on a hash of their arguments.
1325struct DIArgListKeyInfo {
1326 ArrayRef<ValueAsMetadata *> Args;
1327
1328 DIArgListKeyInfo(ArrayRef<ValueAsMetadata *> Args) : Args(Args) {}
1329 DIArgListKeyInfo(const DIArgList *N) : Args(N->getArgs()) {}
1330
1331 bool isKeyOf(const DIArgList *RHS) const { return Args == RHS->getArgs(); }
1332
1333 unsigned getHashValue() const {
1334 return hash_combine_range(first: Args.begin(), last: Args.end());
1335 }
1336};
1337
1338/// DenseMapInfo for DIArgList.
1339struct DIArgListInfo {
1340 using KeyTy = DIArgListKeyInfo;
1341
1342 static inline DIArgList *getEmptyKey() {
1343 return DenseMapInfo<DIArgList *>::getEmptyKey();
1344 }
1345
1346 static inline DIArgList *getTombstoneKey() {
1347 return DenseMapInfo<DIArgList *>::getTombstoneKey();
1348 }
1349
1350 static unsigned getHashValue(const KeyTy &Key) { return Key.getHashValue(); }
1351
1352 static unsigned getHashValue(const DIArgList *N) {
1353 return KeyTy(N).getHashValue();
1354 }
1355
1356 static bool isEqual(const KeyTy &LHS, const DIArgList *RHS) {
1357 if (RHS == getEmptyKey() || RHS == getTombstoneKey())
1358 return false;
1359 return LHS.isKeyOf(RHS);
1360 }
1361
1362 static bool isEqual(const DIArgList *LHS, const DIArgList *RHS) {
1363 return LHS == RHS;
1364 }
1365};
1366
1367/// DenseMapInfo for MDNode subclasses.
1368template <class NodeTy> struct MDNodeInfo {
1369 using KeyTy = MDNodeKeyImpl<NodeTy>;
1370 using SubsetEqualTy = MDNodeSubsetEqualImpl<NodeTy>;
1371
1372 static inline NodeTy *getEmptyKey() {
1373 return DenseMapInfo<NodeTy *>::getEmptyKey();
1374 }
1375
1376 static inline NodeTy *getTombstoneKey() {
1377 return DenseMapInfo<NodeTy *>::getTombstoneKey();
1378 }
1379
1380 static unsigned getHashValue(const KeyTy &Key) { return Key.getHashValue(); }
1381
1382 static unsigned getHashValue(const NodeTy *N) {
1383 return KeyTy(N).getHashValue();
1384 }
1385
1386 static bool isEqual(const KeyTy &LHS, const NodeTy *RHS) {
1387 if (RHS == getEmptyKey() || RHS == getTombstoneKey())
1388 return false;
1389 return SubsetEqualTy::isSubsetEqual(LHS, RHS) || LHS.isKeyOf(RHS);
1390 }
1391
1392 static bool isEqual(const NodeTy *LHS, const NodeTy *RHS) {
1393 if (LHS == RHS)
1394 return true;
1395 if (RHS == getEmptyKey() || RHS == getTombstoneKey())
1396 return false;
1397 return SubsetEqualTy::isSubsetEqual(LHS, RHS);
1398 }
1399};
1400
1401#define HANDLE_MDNODE_LEAF(CLASS) using CLASS##Info = MDNodeInfo<CLASS>;
1402#include "llvm/IR/Metadata.def"
1403
1404/// Multimap-like storage for metadata attachments.
1405class MDAttachments {
1406public:
1407 struct Attachment {
1408 unsigned MDKind;
1409 TrackingMDNodeRef Node;
1410 };
1411
1412private:
1413 SmallVector<Attachment, 1> Attachments;
1414
1415public:
1416 bool empty() const { return Attachments.empty(); }
1417 size_t size() const { return Attachments.size(); }
1418
1419 /// Returns the first attachment with the given ID or nullptr if no such
1420 /// attachment exists.
1421 MDNode *lookup(unsigned ID) const;
1422
1423 /// Appends all attachments with the given ID to \c Result in insertion order.
1424 /// If the global has no attachments with the given ID, or if ID is invalid,
1425 /// leaves Result unchanged.
1426 void get(unsigned ID, SmallVectorImpl<MDNode *> &Result) const;
1427
1428 /// Appends all attachments for the global to \c Result, sorting by attachment
1429 /// ID. Attachments with the same ID appear in insertion order. This function
1430 /// does \em not clear \c Result.
1431 void getAll(SmallVectorImpl<std::pair<unsigned, MDNode *>> &Result) const;
1432
1433 /// Set an attachment to a particular node.
1434 ///
1435 /// Set the \c ID attachment to \c MD, replacing the current attachments at \c
1436 /// ID (if anyway).
1437 void set(unsigned ID, MDNode *MD);
1438
1439 /// Adds an attachment to a particular node.
1440 void insert(unsigned ID, MDNode &MD);
1441
1442 /// Remove attachments with the given ID.
1443 ///
1444 /// Remove the attachments at \c ID, if any.
1445 bool erase(unsigned ID);
1446
1447 /// Erase matching attachments.
1448 ///
1449 /// Erases all attachments matching the \c shouldRemove predicate.
1450 template <class PredTy> void remove_if(PredTy shouldRemove) {
1451 llvm::erase_if(Attachments, shouldRemove);
1452 }
1453};
1454
1455class LLVMContextImpl {
1456public:
1457 /// OwnedModules - The set of modules instantiated in this context, and which
1458 /// will be automatically deleted if this context is deleted.
1459 SmallPtrSet<Module *, 4> OwnedModules;
1460
1461 /// MachineFunctionNums - Keep the next available unique number available for
1462 /// a MachineFunction in given module. Module must in OwnedModules.
1463 DenseMap<Module *, unsigned> MachineFunctionNums;
1464
1465 /// The main remark streamer used by all the other streamers (e.g. IR, MIR,
1466 /// frontends, etc.). This should only be used by the specific streamers, and
1467 /// never directly.
1468 std::unique_ptr<remarks::RemarkStreamer> MainRemarkStreamer;
1469
1470 std::unique_ptr<DiagnosticHandler> DiagHandler;
1471 bool RespectDiagnosticFilters = false;
1472 bool DiagnosticsHotnessRequested = false;
1473 /// The minimum hotness value a diagnostic needs in order to be included in
1474 /// optimization diagnostics.
1475 ///
1476 /// The threshold is an Optional value, which maps to one of the 3 states:
1477 /// 1). 0 => threshold disabled. All emarks will be printed.
1478 /// 2). positive int => manual threshold by user. Remarks with hotness exceed
1479 /// threshold will be printed.
1480 /// 3). None => 'auto' threshold by user. The actual value is not
1481 /// available at command line, but will be synced with
1482 /// hotness threhold from profile summary during
1483 /// compilation.
1484 ///
1485 /// State 1 and 2 are considered as terminal states. State transition is
1486 /// only allowed from 3 to 2, when the threshold is first synced with profile
1487 /// summary. This ensures that the threshold is set only once and stays
1488 /// constant.
1489 ///
1490 /// If threshold option is not specified, it is disabled (0) by default.
1491 std::optional<uint64_t> DiagnosticsHotnessThreshold = 0;
1492
1493 /// The percentage of difference between profiling branch weights and
1494 /// llvm.expect branch weights to tolerate when emiting MisExpect diagnostics
1495 std::optional<uint32_t> DiagnosticsMisExpectTolerance = 0;
1496 bool MisExpectWarningRequested = false;
1497
1498 /// The specialized remark streamer used by LLVM's OptimizationRemarkEmitter.
1499 std::unique_ptr<LLVMRemarkStreamer> LLVMRS;
1500
1501 LLVMContext::YieldCallbackTy YieldCallback = nullptr;
1502 void *YieldOpaqueHandle = nullptr;
1503
1504 DenseMap<const Value *, ValueName *> ValueNames;
1505
1506 DenseMap<unsigned, std::unique_ptr<ConstantInt>> IntZeroConstants;
1507 DenseMap<unsigned, std::unique_ptr<ConstantInt>> IntOneConstants;
1508 DenseMap<APInt, std::unique_ptr<ConstantInt>> IntConstants;
1509 DenseMap<std::pair<ElementCount, APInt>, std::unique_ptr<ConstantInt>>
1510 IntSplatConstants;
1511
1512 DenseMap<APFloat, std::unique_ptr<ConstantFP>> FPConstants;
1513 DenseMap<std::pair<ElementCount, APFloat>, std::unique_ptr<ConstantFP>>
1514 FPSplatConstants;
1515
1516 FoldingSet<AttributeImpl> AttrsSet;
1517 FoldingSet<AttributeListImpl> AttrsLists;
1518 FoldingSet<AttributeSetNode> AttrsSetNodes;
1519
1520 StringMap<MDString, BumpPtrAllocator> MDStringCache;
1521 DenseMap<Value *, ValueAsMetadata *> ValuesAsMetadata;
1522 DenseMap<Metadata *, MetadataAsValue *> MetadataAsValues;
1523 DenseSet<DIArgList *, DIArgListInfo> DIArgLists;
1524
1525#define HANDLE_MDNODE_LEAF_UNIQUABLE(CLASS) \
1526 DenseSet<CLASS *, CLASS##Info> CLASS##s;
1527#include "llvm/IR/Metadata.def"
1528
1529 // Optional map for looking up composite types by identifier.
1530 std::optional<DenseMap<const MDString *, DICompositeType *>> DITypeMap;
1531
1532 // MDNodes may be uniqued or not uniqued. When they're not uniqued, they
1533 // aren't in the MDNodeSet, but they're still shared between objects, so no
1534 // one object can destroy them. Keep track of them here so we can delete
1535 // them on context teardown.
1536 std::vector<MDNode *> DistinctMDNodes;
1537
1538 // ConstantRangeListAttributeImpl is a TrailingObjects/ArrayRef of
1539 // ConstantRange. Since this is a dynamically sized class, it's not
1540 // possible to use SpecificBumpPtrAllocator. Instead, we use normal Alloc
1541 // for allocation and record all allocated pointers in this vector. In the
1542 // LLVMContext destructor, call the destuctors of everything in the vector.
1543 std::vector<ConstantRangeListAttributeImpl *> ConstantRangeListAttributes;
1544
1545 DenseMap<Type *, std::unique_ptr<ConstantAggregateZero>> CAZConstants;
1546
1547 using ArrayConstantsTy = ConstantUniqueMap<ConstantArray>;
1548 ArrayConstantsTy ArrayConstants;
1549
1550 using StructConstantsTy = ConstantUniqueMap<ConstantStruct>;
1551 StructConstantsTy StructConstants;
1552
1553 using VectorConstantsTy = ConstantUniqueMap<ConstantVector>;
1554 VectorConstantsTy VectorConstants;
1555
1556 DenseMap<PointerType *, std::unique_ptr<ConstantPointerNull>> CPNConstants;
1557
1558 DenseMap<TargetExtType *, std::unique_ptr<ConstantTargetNone>> CTNConstants;
1559
1560 DenseMap<Type *, std::unique_ptr<UndefValue>> UVConstants;
1561
1562 DenseMap<Type *, std::unique_ptr<PoisonValue>> PVConstants;
1563
1564 StringMap<std::unique_ptr<ConstantDataSequential>> CDSConstants;
1565
1566 DenseMap<std::pair<const Function *, const BasicBlock *>, BlockAddress *>
1567 BlockAddresses;
1568
1569 DenseMap<const GlobalValue *, DSOLocalEquivalent *> DSOLocalEquivalents;
1570
1571 DenseMap<const GlobalValue *, NoCFIValue *> NoCFIValues;
1572
1573 ConstantUniqueMap<ConstantPtrAuth> ConstantPtrAuths;
1574
1575 ConstantUniqueMap<ConstantExpr> ExprConstants;
1576
1577 ConstantUniqueMap<InlineAsm> InlineAsms;
1578
1579 ConstantInt *TheTrueVal = nullptr;
1580 ConstantInt *TheFalseVal = nullptr;
1581
1582 // Basic type instances.
1583 Type VoidTy, LabelTy, HalfTy, BFloatTy, FloatTy, DoubleTy, MetadataTy,
1584 TokenTy;
1585 Type X86_FP80Ty, FP128Ty, PPC_FP128Ty, X86_MMXTy, X86_AMXTy;
1586 IntegerType Int1Ty, Int8Ty, Int16Ty, Int32Ty, Int64Ty, Int128Ty;
1587
1588 std::unique_ptr<ConstantTokenNone> TheNoneToken;
1589
1590 BumpPtrAllocator Alloc;
1591 UniqueStringSaver Saver{Alloc};
1592 SpecificBumpPtrAllocator<ConstantRangeAttributeImpl>
1593 ConstantRangeAttributeAlloc;
1594
1595 DenseMap<unsigned, IntegerType *> IntegerTypes;
1596
1597 using FunctionTypeSet = DenseSet<FunctionType *, FunctionTypeKeyInfo>;
1598 FunctionTypeSet FunctionTypes;
1599 using StructTypeSet = DenseSet<StructType *, AnonStructTypeKeyInfo>;
1600 StructTypeSet AnonStructTypes;
1601 StringMap<StructType *> NamedStructTypes;
1602 unsigned NamedStructTypesUniqueID = 0;
1603
1604 using TargetExtTypeSet = DenseSet<TargetExtType *, TargetExtTypeKeyInfo>;
1605 TargetExtTypeSet TargetExtTypes;
1606
1607 DenseMap<std::pair<Type *, uint64_t>, ArrayType *> ArrayTypes;
1608 DenseMap<std::pair<Type *, ElementCount>, VectorType *> VectorTypes;
1609 PointerType *AS0PointerType = nullptr; // AddrSpace = 0
1610 DenseMap<unsigned, PointerType *> PointerTypes;
1611 DenseMap<std::pair<Type *, unsigned>, PointerType *> LegacyPointerTypes;
1612 DenseMap<std::pair<Type *, unsigned>, TypedPointerType *> ASTypedPointerTypes;
1613
1614 /// ValueHandles - This map keeps track of all of the value handles that are
1615 /// watching a Value*. The Value::HasValueHandle bit is used to know
1616 /// whether or not a value has an entry in this map.
1617 using ValueHandlesTy = DenseMap<Value *, ValueHandleBase *>;
1618 ValueHandlesTy ValueHandles;
1619
1620 /// CustomMDKindNames - Map to hold the metadata string to ID mapping.
1621 StringMap<unsigned> CustomMDKindNames;
1622
1623 /// Collection of metadata used in this context.
1624 DenseMap<const Value *, MDAttachments> ValueMetadata;
1625
1626 /// Map DIAssignID -> Instructions with that attachment.
1627 /// Managed by Instruction via Instruction::updateDIAssignIDMapping.
1628 /// Query using the at:: functions defined in DebugInfo.h.
1629 DenseMap<DIAssignID *, SmallVector<Instruction *, 1>> AssignmentIDToInstrs;
1630
1631 /// Collection of per-GlobalObject sections used in this context.
1632 DenseMap<const GlobalObject *, StringRef> GlobalObjectSections;
1633
1634 /// Collection of per-GlobalValue partitions used in this context.
1635 DenseMap<const GlobalValue *, StringRef> GlobalValuePartitions;
1636
1637 DenseMap<const GlobalValue *, GlobalValue::SanitizerMetadata>
1638 GlobalValueSanitizerMetadata;
1639
1640 /// DiscriminatorTable - This table maps file:line locations to an
1641 /// integer representing the next DWARF path discriminator to assign to
1642 /// instructions in different blocks at the same location.
1643 DenseMap<std::pair<const char *, unsigned>, unsigned> DiscriminatorTable;
1644
1645 /// A set of interned tags for operand bundles. The StringMap maps
1646 /// bundle tags to their IDs.
1647 ///
1648 /// \see LLVMContext::getOperandBundleTagID
1649 StringMap<uint32_t> BundleTagCache;
1650
1651 StringMapEntry<uint32_t> *getOrInsertBundleTag(StringRef Tag);
1652 void getOperandBundleTags(SmallVectorImpl<StringRef> &Tags) const;
1653 uint32_t getOperandBundleTagID(StringRef Tag) const;
1654
1655 /// A set of interned synchronization scopes. The StringMap maps
1656 /// synchronization scope names to their respective synchronization scope IDs.
1657 StringMap<SyncScope::ID> SSC;
1658
1659 /// getOrInsertSyncScopeID - Maps synchronization scope name to
1660 /// synchronization scope ID. Every synchronization scope registered with
1661 /// LLVMContext has unique ID except pre-defined ones.
1662 SyncScope::ID getOrInsertSyncScopeID(StringRef SSN);
1663
1664 /// getSyncScopeNames - Populates client supplied SmallVector with
1665 /// synchronization scope names registered with LLVMContext. Synchronization
1666 /// scope names are ordered by increasing synchronization scope IDs.
1667 void getSyncScopeNames(SmallVectorImpl<StringRef> &SSNs) const;
1668
1669 /// Maintain the GC name for each function.
1670 ///
1671 /// This saves allocating an additional word in Function for programs which
1672 /// do not use GC (i.e., most programs) at the cost of increased overhead for
1673 /// clients which do use GC.
1674 DenseMap<const Function *, std::string> GCNames;
1675
1676 /// Flag to indicate if Value (other than GlobalValue) retains their name or
1677 /// not.
1678 bool DiscardValueNames = false;
1679
1680 LLVMContextImpl(LLVMContext &C);
1681 ~LLVMContextImpl();
1682
1683 /// Destroy the ConstantArrays if they are not used.
1684 void dropTriviallyDeadConstantArrays();
1685
1686 mutable OptPassGate *OPG = nullptr;
1687
1688 /// Access the object which can disable optional passes and individual
1689 /// optimizations at compile time.
1690 OptPassGate &getOptPassGate() const;
1691
1692 /// Set the object which can disable optional passes and individual
1693 /// optimizations at compile time.
1694 ///
1695 /// The lifetime of the object must be guaranteed to extend as long as the
1696 /// LLVMContext is used by compilation.
1697 void setOptPassGate(OptPassGate &);
1698
1699 /// Mapping of blocks to collections of "trailing" DbgVariableRecords. As part
1700 /// of the "RemoveDIs" project, debug-info variable location records are going
1701 /// to cease being instructions... which raises the problem of where should
1702 /// they be recorded when we remove the terminator of a blocks, such as:
1703 ///
1704 /// %foo = add i32 0, 0
1705 /// br label %bar
1706 ///
1707 /// If the branch is removed, a legitimate transient state while editing a
1708 /// block, any debug-records between those two instructions will not have a
1709 /// location. Each block thus records any DbgVariableRecord records that
1710 /// "trail" in such a way. These are stored in LLVMContext because typically
1711 /// LLVM only edits a small number of blocks at a time, so there's no need to
1712 /// bloat BasicBlock with such a data structure.
1713 SmallDenseMap<BasicBlock *, DbgMarker *> TrailingDbgRecords;
1714
1715 // Set, get and delete operations for TrailingDbgRecords.
1716 void setTrailingDbgRecords(BasicBlock *B, DbgMarker *M) {
1717 assert(!TrailingDbgRecords.count(B));
1718 TrailingDbgRecords[B] = M;
1719 }
1720
1721 DbgMarker *getTrailingDbgRecords(BasicBlock *B) {
1722 return TrailingDbgRecords.lookup(Val: B);
1723 }
1724
1725 void deleteTrailingDbgRecords(BasicBlock *B) { TrailingDbgRecords.erase(Val: B); }
1726
1727 std::string DefaultTargetCPU;
1728 std::string DefaultTargetFeatures;
1729};
1730
1731} // end namespace llvm
1732
1733#endif // LLVM_LIB_IR_LLVMCONTEXTIMPL_H
1734