1 //===- Metadata.cpp - Implement Metadata classes --------------------------===//
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 implements the Metadata classes.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/IR/Metadata.h"
15 #include "LLVMContextImpl.h"
16 #include "MetadataImpl.h"
17 #include "SymbolTableListTraitsImpl.h"
18 #include "llvm/ADT/STLExtras.h"
19 #include "llvm/ADT/SmallSet.h"
20 #include "llvm/ADT/StringMap.h"
21 #include "llvm/IR/ConstantRange.h"
22 #include "llvm/IR/DebugInfoMetadata.h"
23 #include "llvm/IR/Instruction.h"
24 #include "llvm/IR/LLVMContext.h"
25 #include "llvm/IR/Module.h"
26 #include "llvm/IR/ValueHandle.h"
30 MetadataAsValue::MetadataAsValue(Type *Ty, Metadata *MD)
31 : Value(Ty, MetadataAsValueVal), MD(MD) {
35 MetadataAsValue::~MetadataAsValue() {
36 getType()->getContext().pImpl->MetadataAsValues.erase(MD);
40 /// Canonicalize metadata arguments to intrinsics.
42 /// To support bitcode upgrades (and assembly semantic sugar) for \a
43 /// MetadataAsValue, we need to canonicalize certain metadata.
45 /// - nullptr is replaced by an empty MDNode.
46 /// - An MDNode with a single null operand is replaced by an empty MDNode.
47 /// - An MDNode whose only operand is a \a ConstantAsMetadata gets skipped.
49 /// This maintains readability of bitcode from when metadata was a type of
50 /// value, and these bridges were unnecessary.
51 static Metadata *canonicalizeMetadataForValue(LLVMContext &Context,
55 return MDNode::get(Context, None);
57 // Return early if this isn't a single-operand MDNode.
58 auto *N = dyn_cast<MDNode>(MD);
59 if (!N || N->getNumOperands() != 1)
62 if (!N->getOperand(0))
64 return MDNode::get(Context, None);
66 if (auto *C = dyn_cast<ConstantAsMetadata>(N->getOperand(0)))
67 // Look through the MDNode.
73 MetadataAsValue *MetadataAsValue::get(LLVMContext &Context, Metadata *MD) {
74 MD = canonicalizeMetadataForValue(Context, MD);
75 auto *&Entry = Context.pImpl->MetadataAsValues[MD];
77 Entry = new MetadataAsValue(Type::getMetadataTy(Context), MD);
81 MetadataAsValue *MetadataAsValue::getIfExists(LLVMContext &Context,
83 MD = canonicalizeMetadataForValue(Context, MD);
84 auto &Store = Context.pImpl->MetadataAsValues;
85 return Store.lookup(MD);
88 void MetadataAsValue::handleChangedMetadata(Metadata *MD) {
89 LLVMContext &Context = getContext();
90 MD = canonicalizeMetadataForValue(Context, MD);
91 auto &Store = Context.pImpl->MetadataAsValues;
93 // Stop tracking the old metadata.
94 Store.erase(this->MD);
98 // Start tracking MD, or RAUW if necessary.
99 auto *&Entry = Store[MD];
101 replaceAllUsesWith(Entry);
111 void MetadataAsValue::track() {
113 MetadataTracking::track(&MD, *MD, *this);
116 void MetadataAsValue::untrack() {
118 MetadataTracking::untrack(MD);
121 bool MetadataTracking::track(void *Ref, Metadata &MD, OwnerTy Owner) {
122 assert(Ref && "Expected live reference");
123 assert((Owner || *static_cast<Metadata **>(Ref) == &MD) &&
124 "Reference without owner must be direct");
125 if (auto *R = ReplaceableMetadataImpl::getOrCreate(MD)) {
126 R->addRef(Ref, Owner);
129 if (auto *PH = dyn_cast<DistinctMDOperandPlaceholder>(&MD)) {
130 assert(!PH->Use && "Placeholders can only be used once");
131 assert(!Owner && "Unexpected callback to owner");
132 PH->Use = static_cast<Metadata **>(Ref);
138 void MetadataTracking::untrack(void *Ref, Metadata &MD) {
139 assert(Ref && "Expected live reference");
140 if (auto *R = ReplaceableMetadataImpl::getIfExists(MD))
142 else if (auto *PH = dyn_cast<DistinctMDOperandPlaceholder>(&MD))
146 bool MetadataTracking::retrack(void *Ref, Metadata &MD, void *New) {
147 assert(Ref && "Expected live reference");
148 assert(New && "Expected live reference");
149 assert(Ref != New && "Expected change");
150 if (auto *R = ReplaceableMetadataImpl::getIfExists(MD)) {
151 R->moveRef(Ref, New, MD);
154 assert(!isa<DistinctMDOperandPlaceholder>(MD) &&
155 "Unexpected move of an MDOperand");
156 assert(!isReplaceable(MD) &&
157 "Expected un-replaceable metadata, since we didn't move a reference");
161 bool MetadataTracking::isReplaceable(const Metadata &MD) {
162 return ReplaceableMetadataImpl::isReplaceable(MD);
165 void ReplaceableMetadataImpl::addRef(void *Ref, OwnerTy Owner) {
167 UseMap.insert(std::make_pair(Ref, std::make_pair(Owner, NextIndex)))
170 assert(WasInserted && "Expected to add a reference");
173 assert(NextIndex != 0 && "Unexpected overflow");
176 void ReplaceableMetadataImpl::dropRef(void *Ref) {
177 bool WasErased = UseMap.erase(Ref);
179 assert(WasErased && "Expected to drop a reference");
182 void ReplaceableMetadataImpl::moveRef(void *Ref, void *New,
183 const Metadata &MD) {
184 auto I = UseMap.find(Ref);
185 assert(I != UseMap.end() && "Expected to move a reference");
186 auto OwnerAndIndex = I->second;
188 bool WasInserted = UseMap.insert(std::make_pair(New, OwnerAndIndex)).second;
190 assert(WasInserted && "Expected to add a reference");
192 // Check that the references are direct if there's no owner.
194 assert((OwnerAndIndex.first || *static_cast<Metadata **>(Ref) == &MD) &&
195 "Reference without owner must be direct");
196 assert((OwnerAndIndex.first || *static_cast<Metadata **>(New) == &MD) &&
197 "Reference without owner must be direct");
200 void ReplaceableMetadataImpl::replaceAllUsesWith(Metadata *MD) {
204 // Copy out uses since UseMap will get touched below.
205 typedef std::pair<void *, std::pair<OwnerTy, uint64_t>> UseTy;
206 SmallVector<UseTy, 8> Uses(UseMap.begin(), UseMap.end());
207 std::sort(Uses.begin(), Uses.end(), [](const UseTy &L, const UseTy &R) {
208 return L.second.second < R.second.second;
210 for (const auto &Pair : Uses) {
211 // Check that this Ref hasn't disappeared after RAUW (when updating a
213 if (!UseMap.count(Pair.first))
216 OwnerTy Owner = Pair.second.first;
218 // Update unowned tracking references directly.
219 Metadata *&Ref = *static_cast<Metadata **>(Pair.first);
222 MetadataTracking::track(Ref);
223 UseMap.erase(Pair.first);
227 // Check for MetadataAsValue.
228 if (Owner.is<MetadataAsValue *>()) {
229 Owner.get<MetadataAsValue *>()->handleChangedMetadata(MD);
233 // There's a Metadata owner -- dispatch.
234 Metadata *OwnerMD = Owner.get<Metadata *>();
235 switch (OwnerMD->getMetadataID()) {
236 #define HANDLE_METADATA_LEAF(CLASS) \
237 case Metadata::CLASS##Kind: \
238 cast<CLASS>(OwnerMD)->handleChangedOperand(Pair.first, MD); \
240 #include "llvm/IR/Metadata.def"
242 llvm_unreachable("Invalid metadata subclass");
245 assert(UseMap.empty() && "Expected all uses to be replaced");
248 void ReplaceableMetadataImpl::resolveAllUses(bool ResolveUsers) {
257 // Copy out uses since UseMap could get touched below.
258 typedef std::pair<void *, std::pair<OwnerTy, uint64_t>> UseTy;
259 SmallVector<UseTy, 8> Uses(UseMap.begin(), UseMap.end());
260 std::sort(Uses.begin(), Uses.end(), [](const UseTy &L, const UseTy &R) {
261 return L.second.second < R.second.second;
264 for (const auto &Pair : Uses) {
265 auto Owner = Pair.second.first;
268 if (Owner.is<MetadataAsValue *>())
271 // Resolve MDNodes that point at this.
272 auto *OwnerMD = dyn_cast<MDNode>(Owner.get<Metadata *>());
275 if (OwnerMD->isResolved())
277 OwnerMD->decrementUnresolvedOperandCount();
281 ReplaceableMetadataImpl *ReplaceableMetadataImpl::getOrCreate(Metadata &MD) {
282 if (auto *N = dyn_cast<MDNode>(&MD))
283 return N->isResolved() ? nullptr : N->Context.getOrCreateReplaceableUses();
284 return dyn_cast<ValueAsMetadata>(&MD);
287 ReplaceableMetadataImpl *ReplaceableMetadataImpl::getIfExists(Metadata &MD) {
288 if (auto *N = dyn_cast<MDNode>(&MD))
289 return N->isResolved() ? nullptr : N->Context.getReplaceableUses();
290 return dyn_cast<ValueAsMetadata>(&MD);
293 bool ReplaceableMetadataImpl::isReplaceable(const Metadata &MD) {
294 if (auto *N = dyn_cast<MDNode>(&MD))
295 return !N->isResolved();
296 return dyn_cast<ValueAsMetadata>(&MD);
299 static Function *getLocalFunction(Value *V) {
300 assert(V && "Expected value");
301 if (auto *A = dyn_cast<Argument>(V))
302 return A->getParent();
303 if (BasicBlock *BB = cast<Instruction>(V)->getParent())
304 return BB->getParent();
308 ValueAsMetadata *ValueAsMetadata::get(Value *V) {
309 assert(V && "Unexpected null Value");
311 auto &Context = V->getContext();
312 auto *&Entry = Context.pImpl->ValuesAsMetadata[V];
314 assert((isa<Constant>(V) || isa<Argument>(V) || isa<Instruction>(V)) &&
315 "Expected constant or function-local value");
316 assert(!V->IsUsedByMD &&
317 "Expected this to be the only metadata use");
318 V->IsUsedByMD = true;
319 if (auto *C = dyn_cast<Constant>(V))
320 Entry = new ConstantAsMetadata(C);
322 Entry = new LocalAsMetadata(V);
328 ValueAsMetadata *ValueAsMetadata::getIfExists(Value *V) {
329 assert(V && "Unexpected null Value");
330 return V->getContext().pImpl->ValuesAsMetadata.lookup(V);
333 void ValueAsMetadata::handleDeletion(Value *V) {
334 assert(V && "Expected valid value");
336 auto &Store = V->getType()->getContext().pImpl->ValuesAsMetadata;
337 auto I = Store.find(V);
338 if (I == Store.end())
341 // Remove old entry from the map.
342 ValueAsMetadata *MD = I->second;
343 assert(MD && "Expected valid metadata");
344 assert(MD->getValue() == V && "Expected valid mapping");
347 // Delete the metadata.
348 MD->replaceAllUsesWith(nullptr);
352 void ValueAsMetadata::handleRAUW(Value *From, Value *To) {
353 assert(From && "Expected valid value");
354 assert(To && "Expected valid value");
355 assert(From != To && "Expected changed value");
356 assert(From->getType() == To->getType() && "Unexpected type change");
358 LLVMContext &Context = From->getType()->getContext();
359 auto &Store = Context.pImpl->ValuesAsMetadata;
360 auto I = Store.find(From);
361 if (I == Store.end()) {
362 assert(!From->IsUsedByMD &&
363 "Expected From not to be used by metadata");
367 // Remove old entry from the map.
368 assert(From->IsUsedByMD &&
369 "Expected From to be used by metadata");
370 From->IsUsedByMD = false;
371 ValueAsMetadata *MD = I->second;
372 assert(MD && "Expected valid metadata");
373 assert(MD->getValue() == From && "Expected valid mapping");
376 if (isa<LocalAsMetadata>(MD)) {
377 if (auto *C = dyn_cast<Constant>(To)) {
378 // Local became a constant.
379 MD->replaceAllUsesWith(ConstantAsMetadata::get(C));
383 if (getLocalFunction(From) && getLocalFunction(To) &&
384 getLocalFunction(From) != getLocalFunction(To)) {
386 MD->replaceAllUsesWith(nullptr);
390 } else if (!isa<Constant>(To)) {
391 // Changed to function-local value.
392 MD->replaceAllUsesWith(nullptr);
397 auto *&Entry = Store[To];
399 // The target already exists.
400 MD->replaceAllUsesWith(Entry);
405 // Update MD in place (and update the map entry).
406 assert(!To->IsUsedByMD &&
407 "Expected this to be the only metadata use");
408 To->IsUsedByMD = true;
413 //===----------------------------------------------------------------------===//
414 // MDString implementation.
417 MDString *MDString::get(LLVMContext &Context, StringRef Str) {
418 auto &Store = Context.pImpl->MDStringCache;
419 auto I = Store.emplace_second(Str);
420 auto &MapEntry = I.first->getValue();
423 MapEntry.Entry = &*I.first;
427 StringRef MDString::getString() const {
428 assert(Entry && "Expected to find string map entry");
429 return Entry->first();
432 //===----------------------------------------------------------------------===//
433 // MDNode implementation.
436 // Assert that the MDNode types will not be unaligned by the objects
437 // prepended to them.
438 #define HANDLE_MDNODE_LEAF(CLASS) \
440 llvm::AlignOf<uint64_t>::Alignment >= llvm::AlignOf<CLASS>::Alignment, \
441 "Alignment is insufficient after objects prepended to " #CLASS);
442 #include "llvm/IR/Metadata.def"
444 void *MDNode::operator new(size_t Size, unsigned NumOps) {
445 size_t OpSize = NumOps * sizeof(MDOperand);
446 // uint64_t is the most aligned type we need support (ensured by static_assert
448 OpSize = alignTo(OpSize, llvm::alignOf<uint64_t>());
449 void *Ptr = reinterpret_cast<char *>(::operator new(OpSize + Size)) + OpSize;
450 MDOperand *O = static_cast<MDOperand *>(Ptr);
451 for (MDOperand *E = O - NumOps; O != E; --O)
452 (void)new (O - 1) MDOperand;
456 void MDNode::operator delete(void *Mem) {
457 MDNode *N = static_cast<MDNode *>(Mem);
458 size_t OpSize = N->NumOperands * sizeof(MDOperand);
459 OpSize = alignTo(OpSize, llvm::alignOf<uint64_t>());
461 MDOperand *O = static_cast<MDOperand *>(Mem);
462 for (MDOperand *E = O - N->NumOperands; O != E; --O)
463 (O - 1)->~MDOperand();
464 ::operator delete(reinterpret_cast<char *>(Mem) - OpSize);
467 MDNode::MDNode(LLVMContext &Context, unsigned ID, StorageType Storage,
468 ArrayRef<Metadata *> Ops1, ArrayRef<Metadata *> Ops2)
469 : Metadata(ID, Storage), NumOperands(Ops1.size() + Ops2.size()),
470 NumUnresolved(0), Context(Context) {
472 for (Metadata *MD : Ops1)
473 setOperand(Op++, MD);
474 for (Metadata *MD : Ops2)
475 setOperand(Op++, MD);
480 // Count the unresolved operands. If there are any, RAUW support will be
481 // added lazily on first reference.
482 countUnresolvedOperands();
485 TempMDNode MDNode::clone() const {
486 switch (getMetadataID()) {
488 llvm_unreachable("Invalid MDNode subclass");
489 #define HANDLE_MDNODE_LEAF(CLASS) \
491 return cast<CLASS>(this)->cloneImpl();
492 #include "llvm/IR/Metadata.def"
496 static bool isOperandUnresolved(Metadata *Op) {
497 if (auto *N = dyn_cast_or_null<MDNode>(Op))
498 return !N->isResolved();
502 void MDNode::countUnresolvedOperands() {
503 assert(NumUnresolved == 0 && "Expected unresolved ops to be uncounted");
504 assert(isUniqued() && "Expected this to be uniqued");
505 NumUnresolved = count_if(operands(), isOperandUnresolved);
508 void MDNode::makeUniqued() {
509 assert(isTemporary() && "Expected this to be temporary");
510 assert(!isResolved() && "Expected this to be unresolved");
512 // Enable uniquing callbacks.
513 for (auto &Op : mutable_operands())
514 Op.reset(Op.get(), this);
516 // Make this 'uniqued'.
518 countUnresolvedOperands();
519 if (!NumUnresolved) {
520 dropReplaceableUses();
521 assert(isResolved() && "Expected this to be resolved");
524 assert(isUniqued() && "Expected this to be uniqued");
527 void MDNode::makeDistinct() {
528 assert(isTemporary() && "Expected this to be temporary");
529 assert(!isResolved() && "Expected this to be unresolved");
531 // Drop RAUW support and store as a distinct node.
532 dropReplaceableUses();
533 storeDistinctInContext();
535 assert(isDistinct() && "Expected this to be distinct");
536 assert(isResolved() && "Expected this to be resolved");
539 void MDNode::resolve() {
540 assert(isUniqued() && "Expected this to be uniqued");
541 assert(!isResolved() && "Expected this to be unresolved");
544 dropReplaceableUses();
546 assert(isResolved() && "Expected this to be resolved");
549 void MDNode::dropReplaceableUses() {
550 assert(!NumUnresolved && "Unexpected unresolved operand");
552 // Drop any RAUW support.
553 if (Context.hasReplaceableUses())
554 Context.takeReplaceableUses()->resolveAllUses();
557 void MDNode::resolveAfterOperandChange(Metadata *Old, Metadata *New) {
558 assert(isUniqued() && "Expected this to be uniqued");
559 assert(NumUnresolved != 0 && "Expected unresolved operands");
561 // Check if an operand was resolved.
562 if (!isOperandUnresolved(Old)) {
563 if (isOperandUnresolved(New))
564 // An operand was un-resolved!
566 } else if (!isOperandUnresolved(New))
567 decrementUnresolvedOperandCount();
570 void MDNode::decrementUnresolvedOperandCount() {
571 assert(!isResolved() && "Expected this to be unresolved");
575 assert(isUniqued() && "Expected this to be uniqued");
579 // Last unresolved operand has just been resolved.
580 dropReplaceableUses();
581 assert(isResolved() && "Expected this to become resolved");
584 void MDNode::resolveCycles() {
588 // Resolve this node immediately.
591 // Resolve all operands.
592 for (const auto &Op : operands()) {
593 auto *N = dyn_cast_or_null<MDNode>(Op);
597 assert(!N->isTemporary() &&
598 "Expected all forward declarations to be resolved");
599 if (!N->isResolved())
604 static bool hasSelfReference(MDNode *N) {
605 for (Metadata *MD : N->operands())
611 MDNode *MDNode::replaceWithPermanentImpl() {
612 switch (getMetadataID()) {
614 // If this type isn't uniquable, replace with a distinct node.
615 return replaceWithDistinctImpl();
617 #define HANDLE_MDNODE_LEAF_UNIQUABLE(CLASS) \
620 #include "llvm/IR/Metadata.def"
623 // Even if this type is uniquable, self-references have to be distinct.
624 if (hasSelfReference(this))
625 return replaceWithDistinctImpl();
626 return replaceWithUniquedImpl();
629 MDNode *MDNode::replaceWithUniquedImpl() {
630 // Try to uniquify in place.
631 MDNode *UniquedNode = uniquify();
633 if (UniquedNode == this) {
638 // Collision, so RAUW instead.
639 replaceAllUsesWith(UniquedNode);
644 MDNode *MDNode::replaceWithDistinctImpl() {
649 void MDTuple::recalculateHash() {
650 setHash(MDTupleInfo::KeyTy::calculateHash(this));
653 void MDNode::dropAllReferences() {
654 for (unsigned I = 0, E = NumOperands; I != E; ++I)
655 setOperand(I, nullptr);
656 if (Context.hasReplaceableUses()) {
657 Context.getReplaceableUses()->resolveAllUses(/* ResolveUsers */ false);
658 (void)Context.takeReplaceableUses();
662 void MDNode::handleChangedOperand(void *Ref, Metadata *New) {
663 unsigned Op = static_cast<MDOperand *>(Ref) - op_begin();
664 assert(Op < getNumOperands() && "Expected valid operand");
667 // This node is not uniqued. Just set the operand and be done with it.
672 // This node is uniqued.
675 Metadata *Old = getOperand(Op);
678 // Drop uniquing for self-reference cycles and deleted constants.
679 if (New == this || (!New && Old && isa<ConstantAsMetadata>(Old))) {
682 storeDistinctInContext();
686 // Re-unique the node.
687 auto *Uniqued = uniquify();
688 if (Uniqued == this) {
690 resolveAfterOperandChange(Old, New);
696 // Still unresolved, so RAUW.
698 // First, clear out all operands to prevent any recursion (similar to
699 // dropAllReferences(), but we still need the use-list).
700 for (unsigned O = 0, E = getNumOperands(); O != E; ++O)
701 setOperand(O, nullptr);
702 if (Context.hasReplaceableUses())
703 Context.getReplaceableUses()->replaceAllUsesWith(Uniqued);
708 // Store in non-uniqued form if RAUW isn't possible.
709 storeDistinctInContext();
712 void MDNode::deleteAsSubclass() {
713 switch (getMetadataID()) {
715 llvm_unreachable("Invalid subclass of MDNode");
716 #define HANDLE_MDNODE_LEAF(CLASS) \
718 delete cast<CLASS>(this); \
720 #include "llvm/IR/Metadata.def"
724 template <class T, class InfoT>
725 static T *uniquifyImpl(T *N, DenseSet<T *, InfoT> &Store) {
726 if (T *U = getUniqued(Store, N))
733 template <class NodeTy> struct MDNode::HasCachedHash {
736 template <class U, U Val> struct SFINAE {};
739 static Yes &check(SFINAE<void (U::*)(unsigned), &U::setHash> *);
740 template <class U> static No &check(...);
742 static const bool value = sizeof(check<NodeTy>(nullptr)) == sizeof(Yes);
745 MDNode *MDNode::uniquify() {
746 assert(!hasSelfReference(this) && "Cannot uniquify a self-referencing node");
748 // Try to insert into uniquing store.
749 switch (getMetadataID()) {
751 llvm_unreachable("Invalid or non-uniquable subclass of MDNode");
752 #define HANDLE_MDNODE_LEAF_UNIQUABLE(CLASS) \
753 case CLASS##Kind: { \
754 CLASS *SubclassThis = cast<CLASS>(this); \
755 std::integral_constant<bool, HasCachedHash<CLASS>::value> \
756 ShouldRecalculateHash; \
757 dispatchRecalculateHash(SubclassThis, ShouldRecalculateHash); \
758 return uniquifyImpl(SubclassThis, getContext().pImpl->CLASS##s); \
760 #include "llvm/IR/Metadata.def"
764 void MDNode::eraseFromStore() {
765 switch (getMetadataID()) {
767 llvm_unreachable("Invalid or non-uniquable subclass of MDNode");
768 #define HANDLE_MDNODE_LEAF_UNIQUABLE(CLASS) \
770 getContext().pImpl->CLASS##s.erase(cast<CLASS>(this)); \
772 #include "llvm/IR/Metadata.def"
776 MDTuple *MDTuple::getImpl(LLVMContext &Context, ArrayRef<Metadata *> MDs,
777 StorageType Storage, bool ShouldCreate) {
779 if (Storage == Uniqued) {
780 MDTupleInfo::KeyTy Key(MDs);
781 if (auto *N = getUniqued(Context.pImpl->MDTuples, Key))
785 Hash = Key.getHash();
787 assert(ShouldCreate && "Expected non-uniqued nodes to always be created");
790 return storeImpl(new (MDs.size()) MDTuple(Context, Storage, Hash, MDs),
791 Storage, Context.pImpl->MDTuples);
794 void MDNode::deleteTemporary(MDNode *N) {
795 assert(N->isTemporary() && "Expected temporary node");
796 N->replaceAllUsesWith(nullptr);
797 N->deleteAsSubclass();
800 void MDNode::storeDistinctInContext() {
801 assert(!Context.hasReplaceableUses() && "Unexpected replaceable uses");
802 assert(!NumUnresolved && "Unexpected unresolved nodes");
804 assert(isResolved() && "Expected this to be resolved");
807 switch (getMetadataID()) {
809 llvm_unreachable("Invalid subclass of MDNode");
810 #define HANDLE_MDNODE_LEAF(CLASS) \
811 case CLASS##Kind: { \
812 std::integral_constant<bool, HasCachedHash<CLASS>::value> ShouldResetHash; \
813 dispatchResetHash(cast<CLASS>(this), ShouldResetHash); \
816 #include "llvm/IR/Metadata.def"
819 getContext().pImpl->DistinctMDNodes.push_back(this);
822 void MDNode::replaceOperandWith(unsigned I, Metadata *New) {
823 if (getOperand(I) == New)
831 handleChangedOperand(mutable_begin() + I, New);
834 void MDNode::setOperand(unsigned I, Metadata *New) {
835 assert(I < NumOperands);
836 mutable_begin()[I].reset(New, isUniqued() ? this : nullptr);
839 /// Get a node or a self-reference that looks like it.
841 /// Special handling for finding self-references, for use by \a
842 /// MDNode::concatenate() and \a MDNode::intersect() to maintain behaviour from
843 /// when self-referencing nodes were still uniqued. If the first operand has
844 /// the same operands as \c Ops, return the first operand instead.
845 static MDNode *getOrSelfReference(LLVMContext &Context,
846 ArrayRef<Metadata *> Ops) {
848 if (MDNode *N = dyn_cast_or_null<MDNode>(Ops[0]))
849 if (N->getNumOperands() == Ops.size() && N == N->getOperand(0)) {
850 for (unsigned I = 1, E = Ops.size(); I != E; ++I)
851 if (Ops[I] != N->getOperand(I))
852 return MDNode::get(Context, Ops);
856 return MDNode::get(Context, Ops);
859 MDNode *MDNode::concatenate(MDNode *A, MDNode *B) {
865 SmallVector<Metadata *, 4> MDs;
866 MDs.reserve(A->getNumOperands() + B->getNumOperands());
867 MDs.append(A->op_begin(), A->op_end());
868 MDs.append(B->op_begin(), B->op_end());
870 // FIXME: This preserves long-standing behaviour, but is it really the right
871 // behaviour? Or was that an unintended side-effect of node uniquing?
872 return getOrSelfReference(A->getContext(), MDs);
875 MDNode *MDNode::intersect(MDNode *A, MDNode *B) {
879 SmallVector<Metadata *, 4> MDs;
880 for (Metadata *MD : A->operands())
881 if (std::find(B->op_begin(), B->op_end(), MD) != B->op_end())
884 // FIXME: This preserves long-standing behaviour, but is it really the right
885 // behaviour? Or was that an unintended side-effect of node uniquing?
886 return getOrSelfReference(A->getContext(), MDs);
889 MDNode *MDNode::getMostGenericAliasScope(MDNode *A, MDNode *B) {
893 SmallVector<Metadata *, 4> MDs(B->op_begin(), B->op_end());
894 for (Metadata *MD : A->operands())
895 if (std::find(B->op_begin(), B->op_end(), MD) == B->op_end())
898 // FIXME: This preserves long-standing behaviour, but is it really the right
899 // behaviour? Or was that an unintended side-effect of node uniquing?
900 return getOrSelfReference(A->getContext(), MDs);
903 MDNode *MDNode::getMostGenericFPMath(MDNode *A, MDNode *B) {
907 APFloat AVal = mdconst::extract<ConstantFP>(A->getOperand(0))->getValueAPF();
908 APFloat BVal = mdconst::extract<ConstantFP>(B->getOperand(0))->getValueAPF();
909 if (AVal.compare(BVal) == APFloat::cmpLessThan)
914 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
915 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
918 static bool canBeMerged(const ConstantRange &A, const ConstantRange &B) {
919 return !A.intersectWith(B).isEmptySet() || isContiguous(A, B);
922 static bool tryMergeRange(SmallVectorImpl<ConstantInt *> &EndPoints,
923 ConstantInt *Low, ConstantInt *High) {
924 ConstantRange NewRange(Low->getValue(), High->getValue());
925 unsigned Size = EndPoints.size();
926 APInt LB = EndPoints[Size - 2]->getValue();
927 APInt LE = EndPoints[Size - 1]->getValue();
928 ConstantRange LastRange(LB, LE);
929 if (canBeMerged(NewRange, LastRange)) {
930 ConstantRange Union = LastRange.unionWith(NewRange);
931 Type *Ty = High->getType();
932 EndPoints[Size - 2] =
933 cast<ConstantInt>(ConstantInt::get(Ty, Union.getLower()));
934 EndPoints[Size - 1] =
935 cast<ConstantInt>(ConstantInt::get(Ty, Union.getUpper()));
941 static void addRange(SmallVectorImpl<ConstantInt *> &EndPoints,
942 ConstantInt *Low, ConstantInt *High) {
943 if (!EndPoints.empty())
944 if (tryMergeRange(EndPoints, Low, High))
947 EndPoints.push_back(Low);
948 EndPoints.push_back(High);
951 MDNode *MDNode::getMostGenericRange(MDNode *A, MDNode *B) {
952 // Given two ranges, we want to compute the union of the ranges. This
953 // is slightly complitade by having to combine the intervals and merge
954 // the ones that overlap.
962 // First, walk both lists in older of the lower boundary of each interval.
963 // At each step, try to merge the new interval to the last one we adedd.
964 SmallVector<ConstantInt *, 4> EndPoints;
967 int AN = A->getNumOperands() / 2;
968 int BN = B->getNumOperands() / 2;
969 while (AI < AN && BI < BN) {
970 ConstantInt *ALow = mdconst::extract<ConstantInt>(A->getOperand(2 * AI));
971 ConstantInt *BLow = mdconst::extract<ConstantInt>(B->getOperand(2 * BI));
973 if (ALow->getValue().slt(BLow->getValue())) {
974 addRange(EndPoints, ALow,
975 mdconst::extract<ConstantInt>(A->getOperand(2 * AI + 1)));
978 addRange(EndPoints, BLow,
979 mdconst::extract<ConstantInt>(B->getOperand(2 * BI + 1)));
984 addRange(EndPoints, mdconst::extract<ConstantInt>(A->getOperand(2 * AI)),
985 mdconst::extract<ConstantInt>(A->getOperand(2 * AI + 1)));
989 addRange(EndPoints, mdconst::extract<ConstantInt>(B->getOperand(2 * BI)),
990 mdconst::extract<ConstantInt>(B->getOperand(2 * BI + 1)));
994 // If we have more than 2 ranges (4 endpoints) we have to try to merge
995 // the last and first ones.
996 unsigned Size = EndPoints.size();
998 ConstantInt *FB = EndPoints[0];
999 ConstantInt *FE = EndPoints[1];
1000 if (tryMergeRange(EndPoints, FB, FE)) {
1001 for (unsigned i = 0; i < Size - 2; ++i) {
1002 EndPoints[i] = EndPoints[i + 2];
1004 EndPoints.resize(Size - 2);
1008 // If in the end we have a single range, it is possible that it is now the
1009 // full range. Just drop the metadata in that case.
1010 if (EndPoints.size() == 2) {
1011 ConstantRange Range(EndPoints[0]->getValue(), EndPoints[1]->getValue());
1012 if (Range.isFullSet())
1016 SmallVector<Metadata *, 4> MDs;
1017 MDs.reserve(EndPoints.size());
1018 for (auto *I : EndPoints)
1019 MDs.push_back(ConstantAsMetadata::get(I));
1020 return MDNode::get(A->getContext(), MDs);
1023 MDNode *MDNode::getMostGenericAlignmentOrDereferenceable(MDNode *A, MDNode *B) {
1027 ConstantInt *AVal = mdconst::extract<ConstantInt>(A->getOperand(0));
1028 ConstantInt *BVal = mdconst::extract<ConstantInt>(B->getOperand(0));
1029 if (AVal->getZExtValue() < BVal->getZExtValue())
1034 //===----------------------------------------------------------------------===//
1035 // NamedMDNode implementation.
1038 static SmallVector<TrackingMDRef, 4> &getNMDOps(void *Operands) {
1039 return *(SmallVector<TrackingMDRef, 4> *)Operands;
1042 NamedMDNode::NamedMDNode(const Twine &N)
1043 : Name(N.str()), Parent(nullptr),
1044 Operands(new SmallVector<TrackingMDRef, 4>()) {}
1046 NamedMDNode::~NamedMDNode() {
1047 dropAllReferences();
1048 delete &getNMDOps(Operands);
1051 unsigned NamedMDNode::getNumOperands() const {
1052 return (unsigned)getNMDOps(Operands).size();
1055 MDNode *NamedMDNode::getOperand(unsigned i) const {
1056 assert(i < getNumOperands() && "Invalid Operand number!");
1057 auto *N = getNMDOps(Operands)[i].get();
1058 return cast_or_null<MDNode>(N);
1061 void NamedMDNode::addOperand(MDNode *M) { getNMDOps(Operands).emplace_back(M); }
1063 void NamedMDNode::setOperand(unsigned I, MDNode *New) {
1064 assert(I < getNumOperands() && "Invalid operand number");
1065 getNMDOps(Operands)[I].reset(New);
1068 void NamedMDNode::eraseFromParent() {
1069 getParent()->eraseNamedMetadata(this);
1072 void NamedMDNode::dropAllReferences() {
1073 getNMDOps(Operands).clear();
1076 StringRef NamedMDNode::getName() const {
1077 return StringRef(Name);
1080 //===----------------------------------------------------------------------===//
1081 // Instruction Metadata method implementations.
1083 void MDAttachmentMap::set(unsigned ID, MDNode &MD) {
1084 for (auto &I : Attachments)
1085 if (I.first == ID) {
1086 I.second.reset(&MD);
1089 Attachments.emplace_back(std::piecewise_construct, std::make_tuple(ID),
1090 std::make_tuple(&MD));
1093 void MDAttachmentMap::erase(unsigned ID) {
1097 // Common case is one/last value.
1098 if (Attachments.back().first == ID) {
1099 Attachments.pop_back();
1103 for (auto I = Attachments.begin(), E = std::prev(Attachments.end()); I != E;
1105 if (I->first == ID) {
1106 *I = std::move(Attachments.back());
1107 Attachments.pop_back();
1112 MDNode *MDAttachmentMap::lookup(unsigned ID) const {
1113 for (const auto &I : Attachments)
1119 void MDAttachmentMap::getAll(
1120 SmallVectorImpl<std::pair<unsigned, MDNode *>> &Result) const {
1121 Result.append(Attachments.begin(), Attachments.end());
1123 // Sort the resulting array so it is stable.
1124 if (Result.size() > 1)
1125 array_pod_sort(Result.begin(), Result.end());
1128 void MDGlobalAttachmentMap::insert(unsigned ID, MDNode &MD) {
1129 Attachments.push_back({ID, TrackingMDNodeRef(&MD)});
1132 void MDGlobalAttachmentMap::get(unsigned ID,
1133 SmallVectorImpl<MDNode *> &Result) {
1134 for (auto A : Attachments)
1136 Result.push_back(A.Node);
1139 void MDGlobalAttachmentMap::erase(unsigned ID) {
1140 auto Follower = Attachments.begin();
1141 for (auto Leader = Attachments.begin(), E = Attachments.end(); Leader != E;
1143 if (Leader->MDKind != ID) {
1144 if (Follower != Leader)
1145 *Follower = std::move(*Leader);
1149 Attachments.resize(Follower - Attachments.begin());
1152 void MDGlobalAttachmentMap::getAll(
1153 SmallVectorImpl<std::pair<unsigned, MDNode *>> &Result) const {
1154 for (auto &A : Attachments)
1155 Result.emplace_back(A.MDKind, A.Node);
1157 // Sort the resulting array so it is stable with respect to metadata IDs. We
1158 // need to preserve the original insertion order though.
1160 Result.begin(), Result.end(),
1161 [](const std::pair<unsigned, MDNode *> &A,
1162 const std::pair<unsigned, MDNode *> &B) { return A.first < B.first; });
1165 void Instruction::setMetadata(StringRef Kind, MDNode *Node) {
1166 if (!Node && !hasMetadata())
1168 setMetadata(getContext().getMDKindID(Kind), Node);
1171 MDNode *Instruction::getMetadataImpl(StringRef Kind) const {
1172 return getMetadataImpl(getContext().getMDKindID(Kind));
1175 void Instruction::dropUnknownNonDebugMetadata(ArrayRef<unsigned> KnownIDs) {
1176 SmallSet<unsigned, 5> KnownSet;
1177 KnownSet.insert(KnownIDs.begin(), KnownIDs.end());
1179 if (!hasMetadataHashEntry())
1180 return; // Nothing to remove!
1182 auto &InstructionMetadata = getContext().pImpl->InstructionMetadata;
1184 if (KnownSet.empty()) {
1185 // Just drop our entry at the store.
1186 InstructionMetadata.erase(this);
1187 setHasMetadataHashEntry(false);
1191 auto &Info = InstructionMetadata[this];
1192 Info.remove_if([&KnownSet](const std::pair<unsigned, TrackingMDNodeRef> &I) {
1193 return !KnownSet.count(I.first);
1197 // Drop our entry at the store.
1198 InstructionMetadata.erase(this);
1199 setHasMetadataHashEntry(false);
1203 void Instruction::setMetadata(unsigned KindID, MDNode *Node) {
1204 if (!Node && !hasMetadata())
1207 // Handle 'dbg' as a special case since it is not stored in the hash table.
1208 if (KindID == LLVMContext::MD_dbg) {
1209 DbgLoc = DebugLoc(Node);
1213 // Handle the case when we're adding/updating metadata on an instruction.
1215 auto &Info = getContext().pImpl->InstructionMetadata[this];
1216 assert(!Info.empty() == hasMetadataHashEntry() &&
1217 "HasMetadata bit is wonked");
1219 setHasMetadataHashEntry(true);
1220 Info.set(KindID, *Node);
1224 // Otherwise, we're removing metadata from an instruction.
1225 assert((hasMetadataHashEntry() ==
1226 (getContext().pImpl->InstructionMetadata.count(this) > 0)) &&
1227 "HasMetadata bit out of date!");
1228 if (!hasMetadataHashEntry())
1229 return; // Nothing to remove!
1230 auto &Info = getContext().pImpl->InstructionMetadata[this];
1232 // Handle removal of an existing value.
1238 getContext().pImpl->InstructionMetadata.erase(this);
1239 setHasMetadataHashEntry(false);
1242 void Instruction::setAAMetadata(const AAMDNodes &N) {
1243 setMetadata(LLVMContext::MD_tbaa, N.TBAA);
1244 setMetadata(LLVMContext::MD_alias_scope, N.Scope);
1245 setMetadata(LLVMContext::MD_noalias, N.NoAlias);
1248 MDNode *Instruction::getMetadataImpl(unsigned KindID) const {
1249 // Handle 'dbg' as a special case since it is not stored in the hash table.
1250 if (KindID == LLVMContext::MD_dbg)
1251 return DbgLoc.getAsMDNode();
1253 if (!hasMetadataHashEntry())
1255 auto &Info = getContext().pImpl->InstructionMetadata[this];
1256 assert(!Info.empty() && "bit out of sync with hash table");
1258 return Info.lookup(KindID);
1261 void Instruction::getAllMetadataImpl(
1262 SmallVectorImpl<std::pair<unsigned, MDNode *>> &Result) const {
1265 // Handle 'dbg' as a special case since it is not stored in the hash table.
1268 std::make_pair((unsigned)LLVMContext::MD_dbg, DbgLoc.getAsMDNode()));
1269 if (!hasMetadataHashEntry()) return;
1272 assert(hasMetadataHashEntry() &&
1273 getContext().pImpl->InstructionMetadata.count(this) &&
1274 "Shouldn't have called this");
1275 const auto &Info = getContext().pImpl->InstructionMetadata.find(this)->second;
1276 assert(!Info.empty() && "Shouldn't have called this");
1277 Info.getAll(Result);
1280 void Instruction::getAllMetadataOtherThanDebugLocImpl(
1281 SmallVectorImpl<std::pair<unsigned, MDNode *>> &Result) const {
1283 assert(hasMetadataHashEntry() &&
1284 getContext().pImpl->InstructionMetadata.count(this) &&
1285 "Shouldn't have called this");
1286 const auto &Info = getContext().pImpl->InstructionMetadata.find(this)->second;
1287 assert(!Info.empty() && "Shouldn't have called this");
1288 Info.getAll(Result);
1291 bool Instruction::extractProfMetadata(uint64_t &TrueVal, uint64_t &FalseVal) {
1292 assert((getOpcode() == Instruction::Br ||
1293 getOpcode() == Instruction::Select) &&
1294 "Looking for branch weights on something besides branch or select");
1296 auto *ProfileData = getMetadata(LLVMContext::MD_prof);
1297 if (!ProfileData || ProfileData->getNumOperands() != 3)
1300 auto *ProfDataName = dyn_cast<MDString>(ProfileData->getOperand(0));
1301 if (!ProfDataName || !ProfDataName->getString().equals("branch_weights"))
1304 auto *CITrue = mdconst::dyn_extract<ConstantInt>(ProfileData->getOperand(1));
1305 auto *CIFalse = mdconst::dyn_extract<ConstantInt>(ProfileData->getOperand(2));
1306 if (!CITrue || !CIFalse)
1309 TrueVal = CITrue->getValue().getZExtValue();
1310 FalseVal = CIFalse->getValue().getZExtValue();
1315 bool Instruction::extractProfTotalWeight(uint64_t &TotalVal) {
1316 assert((getOpcode() == Instruction::Br ||
1317 getOpcode() == Instruction::Select ||
1318 getOpcode() == Instruction::Call ||
1319 getOpcode() == Instruction::Invoke) &&
1320 "Looking for branch weights on something besides branch");
1323 auto *ProfileData = getMetadata(LLVMContext::MD_prof);
1327 auto *ProfDataName = dyn_cast<MDString>(ProfileData->getOperand(0));
1328 if (!ProfDataName || !ProfDataName->getString().equals("branch_weights"))
1332 for (unsigned i = 1; i < ProfileData->getNumOperands(); i++) {
1333 auto *V = mdconst::dyn_extract<ConstantInt>(ProfileData->getOperand(i));
1336 TotalVal += V->getValue().getZExtValue();
1341 void Instruction::clearMetadataHashEntries() {
1342 assert(hasMetadataHashEntry() && "Caller should check");
1343 getContext().pImpl->InstructionMetadata.erase(this);
1344 setHasMetadataHashEntry(false);
1347 void GlobalObject::getMetadata(unsigned KindID,
1348 SmallVectorImpl<MDNode *> &MDs) const {
1350 getContext().pImpl->GlobalObjectMetadata[this].get(KindID, MDs);
1353 void GlobalObject::getMetadata(StringRef Kind,
1354 SmallVectorImpl<MDNode *> &MDs) const {
1356 getMetadata(getContext().getMDKindID(Kind), MDs);
1359 void GlobalObject::addMetadata(unsigned KindID, MDNode &MD) {
1361 setHasMetadataHashEntry(true);
1363 getContext().pImpl->GlobalObjectMetadata[this].insert(KindID, MD);
1366 void GlobalObject::addMetadata(StringRef Kind, MDNode &MD) {
1367 addMetadata(getContext().getMDKindID(Kind), MD);
1370 void GlobalObject::eraseMetadata(unsigned KindID) {
1371 // Nothing to unset.
1375 auto &Store = getContext().pImpl->GlobalObjectMetadata[this];
1376 Store.erase(KindID);
1381 void GlobalObject::getAllMetadata(
1382 SmallVectorImpl<std::pair<unsigned, MDNode *>> &MDs) const {
1388 getContext().pImpl->GlobalObjectMetadata[this].getAll(MDs);
1391 void GlobalObject::clearMetadata() {
1394 getContext().pImpl->GlobalObjectMetadata.erase(this);
1395 setHasMetadataHashEntry(false);
1398 void GlobalObject::setMetadata(unsigned KindID, MDNode *N) {
1399 eraseMetadata(KindID);
1401 addMetadata(KindID, *N);
1404 void GlobalObject::setMetadata(StringRef Kind, MDNode *N) {
1405 setMetadata(getContext().getMDKindID(Kind), N);
1408 MDNode *GlobalObject::getMetadata(unsigned KindID) const {
1409 SmallVector<MDNode *, 1> MDs;
1410 getMetadata(KindID, MDs);
1411 assert(MDs.size() <= 1 && "Expected at most one metadata attachment");
1417 MDNode *GlobalObject::getMetadata(StringRef Kind) const {
1418 return getMetadata(getContext().getMDKindID(Kind));
1421 void GlobalObject::copyMetadata(const GlobalObject *Other, unsigned Offset) {
1422 SmallVector<std::pair<unsigned, MDNode *>, 8> MDs;
1423 Other->getAllMetadata(MDs);
1424 for (auto &MD : MDs) {
1425 // We need to adjust the type metadata offset.
1426 if (Offset != 0 && MD.first == LLVMContext::MD_type) {
1427 auto *OffsetConst = cast<ConstantInt>(
1428 cast<ConstantAsMetadata>(MD.second->getOperand(0))->getValue());
1429 Metadata *TypeId = MD.second->getOperand(1);
1430 auto *NewOffsetMD = ConstantAsMetadata::get(ConstantInt::get(
1431 OffsetConst->getType(), OffsetConst->getValue() + Offset));
1432 addMetadata(LLVMContext::MD_type,
1433 *MDNode::get(getContext(), {NewOffsetMD, TypeId}));
1436 addMetadata(MD.first, *MD.second);
1440 void GlobalObject::addTypeMetadata(unsigned Offset, Metadata *TypeID) {
1442 LLVMContext::MD_type,
1443 *MDTuple::get(getContext(),
1444 {llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
1445 Type::getInt64Ty(getContext()), Offset)),
1449 void Function::setSubprogram(DISubprogram *SP) {
1450 setMetadata(LLVMContext::MD_dbg, SP);
1453 DISubprogram *Function::getSubprogram() const {
1454 return cast_or_null<DISubprogram>(getMetadata(LLVMContext::MD_dbg));