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/DenseMap.h"
19 #include "llvm/ADT/STLExtras.h"
20 #include "llvm/ADT/SmallSet.h"
21 #include "llvm/ADT/SmallString.h"
22 #include "llvm/ADT/StringMap.h"
23 #include "llvm/IR/ConstantRange.h"
24 #include "llvm/IR/DebugInfoMetadata.h"
25 #include "llvm/IR/Instruction.h"
26 #include "llvm/IR/LLVMContext.h"
27 #include "llvm/IR/Module.h"
28 #include "llvm/IR/ValueHandle.h"
32 MetadataAsValue::MetadataAsValue(Type *Ty, Metadata *MD)
33 : Value(Ty, MetadataAsValueVal), MD(MD) {
37 MetadataAsValue::~MetadataAsValue() {
38 getType()->getContext().pImpl->MetadataAsValues.erase(MD);
42 /// \brief Canonicalize metadata arguments to intrinsics.
44 /// To support bitcode upgrades (and assembly semantic sugar) for \a
45 /// MetadataAsValue, we need to canonicalize certain metadata.
47 /// - nullptr is replaced by an empty MDNode.
48 /// - An MDNode with a single null operand is replaced by an empty MDNode.
49 /// - An MDNode whose only operand is a \a ConstantAsMetadata gets skipped.
51 /// This maintains readability of bitcode from when metadata was a type of
52 /// value, and these bridges were unnecessary.
53 static Metadata *canonicalizeMetadataForValue(LLVMContext &Context,
57 return MDNode::get(Context, None);
59 // Return early if this isn't a single-operand MDNode.
60 auto *N = dyn_cast<MDNode>(MD);
61 if (!N || N->getNumOperands() != 1)
64 if (!N->getOperand(0))
66 return MDNode::get(Context, None);
68 if (auto *C = dyn_cast<ConstantAsMetadata>(N->getOperand(0)))
69 // Look through the MDNode.
75 MetadataAsValue *MetadataAsValue::get(LLVMContext &Context, Metadata *MD) {
76 MD = canonicalizeMetadataForValue(Context, MD);
77 auto *&Entry = Context.pImpl->MetadataAsValues[MD];
79 Entry = new MetadataAsValue(Type::getMetadataTy(Context), MD);
83 MetadataAsValue *MetadataAsValue::getIfExists(LLVMContext &Context,
85 MD = canonicalizeMetadataForValue(Context, MD);
86 auto &Store = Context.pImpl->MetadataAsValues;
87 return Store.lookup(MD);
90 void MetadataAsValue::handleChangedMetadata(Metadata *MD) {
91 LLVMContext &Context = getContext();
92 MD = canonicalizeMetadataForValue(Context, MD);
93 auto &Store = Context.pImpl->MetadataAsValues;
95 // Stop tracking the old metadata.
96 Store.erase(this->MD);
100 // Start tracking MD, or RAUW if necessary.
101 auto *&Entry = Store[MD];
103 replaceAllUsesWith(Entry);
113 void MetadataAsValue::track() {
115 MetadataTracking::track(&MD, *MD, *this);
118 void MetadataAsValue::untrack() {
120 MetadataTracking::untrack(MD);
123 void ReplaceableMetadataImpl::addRef(void *Ref, OwnerTy Owner) {
125 UseMap.insert(std::make_pair(Ref, std::make_pair(Owner, NextIndex)))
128 assert(WasInserted && "Expected to add a reference");
131 assert(NextIndex != 0 && "Unexpected overflow");
134 void ReplaceableMetadataImpl::dropRef(void *Ref) {
135 bool WasErased = UseMap.erase(Ref);
137 assert(WasErased && "Expected to drop a reference");
140 void ReplaceableMetadataImpl::moveRef(void *Ref, void *New,
141 const Metadata &MD) {
142 auto I = UseMap.find(Ref);
143 assert(I != UseMap.end() && "Expected to move a reference");
144 auto OwnerAndIndex = I->second;
146 bool WasInserted = UseMap.insert(std::make_pair(New, OwnerAndIndex)).second;
148 assert(WasInserted && "Expected to add a reference");
150 // Check that the references are direct if there's no owner.
152 assert((OwnerAndIndex.first || *static_cast<Metadata **>(Ref) == &MD) &&
153 "Reference without owner must be direct");
154 assert((OwnerAndIndex.first || *static_cast<Metadata **>(New) == &MD) &&
155 "Reference without owner must be direct");
158 void ReplaceableMetadataImpl::replaceAllUsesWith(Metadata *MD) {
159 assert(!(MD && isa<MDNode>(MD) && cast<MDNode>(MD)->isTemporary()) &&
160 "Expected non-temp node");
165 // Copy out uses since UseMap will get touched below.
166 typedef std::pair<void *, std::pair<OwnerTy, uint64_t>> UseTy;
167 SmallVector<UseTy, 8> Uses(UseMap.begin(), UseMap.end());
168 std::sort(Uses.begin(), Uses.end(), [](const UseTy &L, const UseTy &R) {
169 return L.second.second < R.second.second;
171 for (const auto &Pair : Uses) {
172 // Check that this Ref hasn't disappeared after RAUW (when updating a
174 if (!UseMap.count(Pair.first))
177 OwnerTy Owner = Pair.second.first;
179 // Update unowned tracking references directly.
180 Metadata *&Ref = *static_cast<Metadata **>(Pair.first);
183 MetadataTracking::track(Ref);
184 UseMap.erase(Pair.first);
188 // Check for MetadataAsValue.
189 if (Owner.is<MetadataAsValue *>()) {
190 Owner.get<MetadataAsValue *>()->handleChangedMetadata(MD);
194 // There's a Metadata owner -- dispatch.
195 Metadata *OwnerMD = Owner.get<Metadata *>();
196 switch (OwnerMD->getMetadataID()) {
197 #define HANDLE_METADATA_LEAF(CLASS) \
198 case Metadata::CLASS##Kind: \
199 cast<CLASS>(OwnerMD)->handleChangedOperand(Pair.first, MD); \
201 #include "llvm/IR/Metadata.def"
203 llvm_unreachable("Invalid metadata subclass");
206 assert(UseMap.empty() && "Expected all uses to be replaced");
209 void ReplaceableMetadataImpl::resolveAllUses(bool ResolveUsers) {
218 // Copy out uses since UseMap could get touched below.
219 typedef std::pair<void *, std::pair<OwnerTy, uint64_t>> UseTy;
220 SmallVector<UseTy, 8> Uses(UseMap.begin(), UseMap.end());
221 std::sort(Uses.begin(), Uses.end(), [](const UseTy &L, const UseTy &R) {
222 return L.second.second < R.second.second;
225 for (const auto &Pair : Uses) {
226 auto Owner = Pair.second.first;
229 if (Owner.is<MetadataAsValue *>())
232 // Resolve MDNodes that point at this.
233 auto *OwnerMD = dyn_cast<MDNode>(Owner.get<Metadata *>());
236 if (OwnerMD->isResolved())
238 OwnerMD->decrementUnresolvedOperandCount();
242 static Function *getLocalFunction(Value *V) {
243 assert(V && "Expected value");
244 if (auto *A = dyn_cast<Argument>(V))
245 return A->getParent();
246 if (BasicBlock *BB = cast<Instruction>(V)->getParent())
247 return BB->getParent();
251 ValueAsMetadata *ValueAsMetadata::get(Value *V) {
252 assert(V && "Unexpected null Value");
254 auto &Context = V->getContext();
255 auto *&Entry = Context.pImpl->ValuesAsMetadata[V];
257 assert((isa<Constant>(V) || isa<Argument>(V) || isa<Instruction>(V)) &&
258 "Expected constant or function-local value");
259 assert(!V->IsUsedByMD &&
260 "Expected this to be the only metadata use");
261 V->IsUsedByMD = true;
262 if (auto *C = dyn_cast<Constant>(V))
263 Entry = new ConstantAsMetadata(C);
265 Entry = new LocalAsMetadata(V);
271 ValueAsMetadata *ValueAsMetadata::getIfExists(Value *V) {
272 assert(V && "Unexpected null Value");
273 return V->getContext().pImpl->ValuesAsMetadata.lookup(V);
276 void ValueAsMetadata::handleDeletion(Value *V) {
277 assert(V && "Expected valid value");
279 auto &Store = V->getType()->getContext().pImpl->ValuesAsMetadata;
280 auto I = Store.find(V);
281 if (I == Store.end())
284 // Remove old entry from the map.
285 ValueAsMetadata *MD = I->second;
286 assert(MD && "Expected valid metadata");
287 assert(MD->getValue() == V && "Expected valid mapping");
290 // Delete the metadata.
291 MD->replaceAllUsesWith(nullptr);
295 void ValueAsMetadata::handleRAUW(Value *From, Value *To) {
296 assert(From && "Expected valid value");
297 assert(To && "Expected valid value");
298 assert(From != To && "Expected changed value");
299 assert(From->getType() == To->getType() && "Unexpected type change");
301 LLVMContext &Context = From->getType()->getContext();
302 auto &Store = Context.pImpl->ValuesAsMetadata;
303 auto I = Store.find(From);
304 if (I == Store.end()) {
305 assert(!From->IsUsedByMD &&
306 "Expected From not to be used by metadata");
310 // Remove old entry from the map.
311 assert(From->IsUsedByMD &&
312 "Expected From to be used by metadata");
313 From->IsUsedByMD = false;
314 ValueAsMetadata *MD = I->second;
315 assert(MD && "Expected valid metadata");
316 assert(MD->getValue() == From && "Expected valid mapping");
319 if (isa<LocalAsMetadata>(MD)) {
320 if (auto *C = dyn_cast<Constant>(To)) {
321 // Local became a constant.
322 MD->replaceAllUsesWith(ConstantAsMetadata::get(C));
326 if (getLocalFunction(From) && getLocalFunction(To) &&
327 getLocalFunction(From) != getLocalFunction(To)) {
329 MD->replaceAllUsesWith(nullptr);
333 } else if (!isa<Constant>(To)) {
334 // Changed to function-local value.
335 MD->replaceAllUsesWith(nullptr);
340 auto *&Entry = Store[To];
342 // The target already exists.
343 MD->replaceAllUsesWith(Entry);
348 // Update MD in place (and update the map entry).
349 assert(!To->IsUsedByMD &&
350 "Expected this to be the only metadata use");
351 To->IsUsedByMD = true;
356 //===----------------------------------------------------------------------===//
357 // MDString implementation.
360 MDString *MDString::get(LLVMContext &Context, StringRef Str) {
361 auto &Store = Context.pImpl->MDStringCache;
362 auto I = Store.find(Str);
363 if (I != Store.end())
367 StringMapEntry<MDString>::Create(Str, Store.getAllocator(), MDString());
368 bool WasInserted = Store.insert(Entry);
370 assert(WasInserted && "Expected entry to be inserted");
371 Entry->second.Entry = Entry;
372 return &Entry->second;
375 StringRef MDString::getString() const {
376 assert(Entry && "Expected to find string map entry");
377 return Entry->first();
380 //===----------------------------------------------------------------------===//
381 // MDNode implementation.
384 // Assert that the MDNode types will not be unaligned by the objects
385 // prepended to them.
386 #define HANDLE_MDNODE_LEAF(CLASS) \
388 llvm::AlignOf<uint64_t>::Alignment >= llvm::AlignOf<CLASS>::Alignment, \
389 "Alignment is insufficient after objects prepended to " #CLASS);
390 #include "llvm/IR/Metadata.def"
392 void *MDNode::operator new(size_t Size, unsigned NumOps) {
393 size_t OpSize = NumOps * sizeof(MDOperand);
394 // uint64_t is the most aligned type we need support (ensured by static_assert
396 OpSize = RoundUpToAlignment(OpSize, llvm::alignOf<uint64_t>());
397 void *Ptr = reinterpret_cast<char *>(::operator new(OpSize + Size)) + OpSize;
398 MDOperand *O = static_cast<MDOperand *>(Ptr);
399 for (MDOperand *E = O - NumOps; O != E; --O)
400 (void)new (O - 1) MDOperand;
404 void MDNode::operator delete(void *Mem) {
405 MDNode *N = static_cast<MDNode *>(Mem);
406 size_t OpSize = N->NumOperands * sizeof(MDOperand);
407 OpSize = RoundUpToAlignment(OpSize, llvm::alignOf<uint64_t>());
409 MDOperand *O = static_cast<MDOperand *>(Mem);
410 for (MDOperand *E = O - N->NumOperands; O != E; --O)
411 (O - 1)->~MDOperand();
412 ::operator delete(reinterpret_cast<char *>(Mem) - OpSize);
415 MDNode::MDNode(LLVMContext &Context, unsigned ID, StorageType Storage,
416 ArrayRef<Metadata *> Ops1, ArrayRef<Metadata *> Ops2)
417 : Metadata(ID, Storage), NumOperands(Ops1.size() + Ops2.size()),
418 NumUnresolved(0), Context(Context) {
420 for (Metadata *MD : Ops1)
421 setOperand(Op++, MD);
422 for (Metadata *MD : Ops2)
423 setOperand(Op++, MD);
429 // Check whether any operands are unresolved, requiring re-uniquing. If
430 // not, don't support RAUW.
431 if (!countUnresolvedOperands())
434 this->Context.makeReplaceable(make_unique<ReplaceableMetadataImpl>(Context));
437 TempMDNode MDNode::clone() const {
438 switch (getMetadataID()) {
440 llvm_unreachable("Invalid MDNode subclass");
441 #define HANDLE_MDNODE_LEAF(CLASS) \
443 return cast<CLASS>(this)->cloneImpl();
444 #include "llvm/IR/Metadata.def"
448 static bool isOperandUnresolved(Metadata *Op) {
449 if (auto *N = dyn_cast_or_null<MDNode>(Op))
450 return !N->isResolved();
454 unsigned MDNode::countUnresolvedOperands() {
455 assert(NumUnresolved == 0 && "Expected unresolved ops to be uncounted");
456 NumUnresolved = std::count_if(op_begin(), op_end(), isOperandUnresolved);
457 return NumUnresolved;
460 void MDNode::makeUniqued() {
461 assert(isTemporary() && "Expected this to be temporary");
462 assert(!isResolved() && "Expected this to be unresolved");
464 // Enable uniquing callbacks.
465 for (auto &Op : mutable_operands())
466 Op.reset(Op.get(), this);
468 // Make this 'uniqued'.
470 if (!countUnresolvedOperands())
473 assert(isUniqued() && "Expected this to be uniqued");
476 void MDNode::makeDistinct() {
477 assert(isTemporary() && "Expected this to be temporary");
478 assert(!isResolved() && "Expected this to be unresolved");
480 // Pretend to be uniqued, resolve the node, and then store in distinct table.
483 storeDistinctInContext();
485 assert(isDistinct() && "Expected this to be distinct");
486 assert(isResolved() && "Expected this to be resolved");
489 void MDNode::resolve() {
490 assert(isUniqued() && "Expected this to be uniqued");
491 assert(!isResolved() && "Expected this to be unresolved");
493 // Move the map, so that this immediately looks resolved.
494 auto Uses = Context.takeReplaceableUses();
496 assert(isResolved() && "Expected this to be resolved");
498 // Drop RAUW support.
499 Uses->resolveAllUses();
502 void MDNode::resolveAfterOperandChange(Metadata *Old, Metadata *New) {
503 assert(NumUnresolved != 0 && "Expected unresolved operands");
505 // Check if an operand was resolved.
506 if (!isOperandUnresolved(Old)) {
507 if (isOperandUnresolved(New))
508 // An operand was un-resolved!
510 } else if (!isOperandUnresolved(New))
511 decrementUnresolvedOperandCount();
514 void MDNode::decrementUnresolvedOperandCount() {
515 if (!--NumUnresolved)
516 // Last unresolved operand has just been resolved.
520 void MDNode::resolveCycles(bool MDMaterialized) {
524 // Resolve this node immediately.
527 // Resolve all operands.
528 for (const auto &Op : operands()) {
529 auto *N = dyn_cast_or_null<MDNode>(Op);
533 if (N->isTemporary() && !MDMaterialized)
535 assert(!N->isTemporary() &&
536 "Expected all forward declarations to be resolved");
537 if (!N->isResolved())
542 static bool hasSelfReference(MDNode *N) {
543 for (Metadata *MD : N->operands())
549 MDNode *MDNode::replaceWithPermanentImpl() {
550 switch (getMetadataID()) {
552 // If this type isn't uniquable, replace with a distinct node.
553 return replaceWithDistinctImpl();
555 #define HANDLE_MDNODE_LEAF_UNIQUABLE(CLASS) \
558 #include "llvm/IR/Metadata.def"
561 // Even if this type is uniquable, self-references have to be distinct.
562 if (hasSelfReference(this))
563 return replaceWithDistinctImpl();
564 return replaceWithUniquedImpl();
567 MDNode *MDNode::replaceWithUniquedImpl() {
568 // Try to uniquify in place.
569 MDNode *UniquedNode = uniquify();
571 if (UniquedNode == this) {
576 // Collision, so RAUW instead.
577 replaceAllUsesWith(UniquedNode);
582 MDNode *MDNode::replaceWithDistinctImpl() {
587 void MDTuple::recalculateHash() {
588 setHash(MDTupleInfo::KeyTy::calculateHash(this));
591 void MDNode::dropAllReferences() {
592 for (unsigned I = 0, E = NumOperands; I != E; ++I)
593 setOperand(I, nullptr);
595 Context.getReplaceableUses()->resolveAllUses(/* ResolveUsers */ false);
596 (void)Context.takeReplaceableUses();
600 void MDNode::handleChangedOperand(void *Ref, Metadata *New) {
601 unsigned Op = static_cast<MDOperand *>(Ref) - op_begin();
602 assert(Op < getNumOperands() && "Expected valid operand");
605 // This node is not uniqued. Just set the operand and be done with it.
610 // This node is uniqued.
613 Metadata *Old = getOperand(Op);
616 // Drop uniquing for self-reference cycles.
620 storeDistinctInContext();
624 // Re-unique the node.
625 auto *Uniqued = uniquify();
626 if (Uniqued == this) {
628 resolveAfterOperandChange(Old, New);
634 // Still unresolved, so RAUW.
636 // First, clear out all operands to prevent any recursion (similar to
637 // dropAllReferences(), but we still need the use-list).
638 for (unsigned O = 0, E = getNumOperands(); O != E; ++O)
639 setOperand(O, nullptr);
640 Context.getReplaceableUses()->replaceAllUsesWith(Uniqued);
645 // Store in non-uniqued form if RAUW isn't possible.
646 storeDistinctInContext();
649 void MDNode::deleteAsSubclass() {
650 switch (getMetadataID()) {
652 llvm_unreachable("Invalid subclass of MDNode");
653 #define HANDLE_MDNODE_LEAF(CLASS) \
655 delete cast<CLASS>(this); \
657 #include "llvm/IR/Metadata.def"
661 template <class T, class InfoT>
662 static T *uniquifyImpl(T *N, DenseSet<T *, InfoT> &Store) {
663 if (T *U = getUniqued(Store, N))
670 template <class NodeTy> struct MDNode::HasCachedHash {
673 template <class U, U Val> struct SFINAE {};
676 static Yes &check(SFINAE<void (U::*)(unsigned), &U::setHash> *);
677 template <class U> static No &check(...);
679 static const bool value = sizeof(check<NodeTy>(nullptr)) == sizeof(Yes);
682 MDNode *MDNode::uniquify() {
683 assert(!hasSelfReference(this) && "Cannot uniquify a self-referencing node");
685 // Try to insert into uniquing store.
686 switch (getMetadataID()) {
688 llvm_unreachable("Invalid or non-uniquable subclass of MDNode");
689 #define HANDLE_MDNODE_LEAF_UNIQUABLE(CLASS) \
690 case CLASS##Kind: { \
691 CLASS *SubclassThis = cast<CLASS>(this); \
692 std::integral_constant<bool, HasCachedHash<CLASS>::value> \
693 ShouldRecalculateHash; \
694 dispatchRecalculateHash(SubclassThis, ShouldRecalculateHash); \
695 return uniquifyImpl(SubclassThis, getContext().pImpl->CLASS##s); \
697 #include "llvm/IR/Metadata.def"
701 void MDNode::eraseFromStore() {
702 switch (getMetadataID()) {
704 llvm_unreachable("Invalid or non-uniquable subclass of MDNode");
705 #define HANDLE_MDNODE_LEAF_UNIQUABLE(CLASS) \
707 getContext().pImpl->CLASS##s.erase(cast<CLASS>(this)); \
709 #include "llvm/IR/Metadata.def"
713 MDTuple *MDTuple::getImpl(LLVMContext &Context, ArrayRef<Metadata *> MDs,
714 StorageType Storage, bool ShouldCreate) {
716 if (Storage == Uniqued) {
717 MDTupleInfo::KeyTy Key(MDs);
718 if (auto *N = getUniqued(Context.pImpl->MDTuples, Key))
722 Hash = Key.getHash();
724 assert(ShouldCreate && "Expected non-uniqued nodes to always be created");
727 return storeImpl(new (MDs.size()) MDTuple(Context, Storage, Hash, MDs),
728 Storage, Context.pImpl->MDTuples);
731 void MDNode::deleteTemporary(MDNode *N) {
732 assert(N->isTemporary() && "Expected temporary node");
733 N->replaceAllUsesWith(nullptr);
734 N->deleteAsSubclass();
737 void MDNode::storeDistinctInContext() {
738 assert(isResolved() && "Expected resolved nodes");
742 switch (getMetadataID()) {
744 llvm_unreachable("Invalid subclass of MDNode");
745 #define HANDLE_MDNODE_LEAF(CLASS) \
746 case CLASS##Kind: { \
747 std::integral_constant<bool, HasCachedHash<CLASS>::value> ShouldResetHash; \
748 dispatchResetHash(cast<CLASS>(this), ShouldResetHash); \
751 #include "llvm/IR/Metadata.def"
754 getContext().pImpl->DistinctMDNodes.insert(this);
757 void MDNode::replaceOperandWith(unsigned I, Metadata *New) {
758 if (getOperand(I) == New)
766 handleChangedOperand(mutable_begin() + I, New);
769 void MDNode::setOperand(unsigned I, Metadata *New) {
770 assert(I < NumOperands);
771 mutable_begin()[I].reset(New, isUniqued() ? this : nullptr);
774 /// \brief Get a node, or a self-reference that looks like it.
776 /// Special handling for finding self-references, for use by \a
777 /// MDNode::concatenate() and \a MDNode::intersect() to maintain behaviour from
778 /// when self-referencing nodes were still uniqued. If the first operand has
779 /// the same operands as \c Ops, return the first operand instead.
780 static MDNode *getOrSelfReference(LLVMContext &Context,
781 ArrayRef<Metadata *> Ops) {
783 if (MDNode *N = dyn_cast_or_null<MDNode>(Ops[0]))
784 if (N->getNumOperands() == Ops.size() && N == N->getOperand(0)) {
785 for (unsigned I = 1, E = Ops.size(); I != E; ++I)
786 if (Ops[I] != N->getOperand(I))
787 return MDNode::get(Context, Ops);
791 return MDNode::get(Context, Ops);
794 MDNode *MDNode::concatenate(MDNode *A, MDNode *B) {
800 SmallVector<Metadata *, 4> MDs;
801 MDs.reserve(A->getNumOperands() + B->getNumOperands());
802 MDs.append(A->op_begin(), A->op_end());
803 MDs.append(B->op_begin(), B->op_end());
805 // FIXME: This preserves long-standing behaviour, but is it really the right
806 // behaviour? Or was that an unintended side-effect of node uniquing?
807 return getOrSelfReference(A->getContext(), MDs);
810 MDNode *MDNode::intersect(MDNode *A, MDNode *B) {
814 SmallVector<Metadata *, 4> MDs;
815 for (Metadata *MD : A->operands())
816 if (std::find(B->op_begin(), B->op_end(), MD) != B->op_end())
819 // FIXME: This preserves long-standing behaviour, but is it really the right
820 // behaviour? Or was that an unintended side-effect of node uniquing?
821 return getOrSelfReference(A->getContext(), MDs);
824 MDNode *MDNode::getMostGenericAliasScope(MDNode *A, MDNode *B) {
828 SmallVector<Metadata *, 4> MDs(B->op_begin(), B->op_end());
829 for (Metadata *MD : A->operands())
830 if (std::find(B->op_begin(), B->op_end(), MD) == B->op_end())
833 // FIXME: This preserves long-standing behaviour, but is it really the right
834 // behaviour? Or was that an unintended side-effect of node uniquing?
835 return getOrSelfReference(A->getContext(), MDs);
838 MDNode *MDNode::getMostGenericFPMath(MDNode *A, MDNode *B) {
842 APFloat AVal = mdconst::extract<ConstantFP>(A->getOperand(0))->getValueAPF();
843 APFloat BVal = mdconst::extract<ConstantFP>(B->getOperand(0))->getValueAPF();
844 if (AVal.compare(BVal) == APFloat::cmpLessThan)
849 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
850 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
853 static bool canBeMerged(const ConstantRange &A, const ConstantRange &B) {
854 return !A.intersectWith(B).isEmptySet() || isContiguous(A, B);
857 static bool tryMergeRange(SmallVectorImpl<ConstantInt *> &EndPoints,
858 ConstantInt *Low, ConstantInt *High) {
859 ConstantRange NewRange(Low->getValue(), High->getValue());
860 unsigned Size = EndPoints.size();
861 APInt LB = EndPoints[Size - 2]->getValue();
862 APInt LE = EndPoints[Size - 1]->getValue();
863 ConstantRange LastRange(LB, LE);
864 if (canBeMerged(NewRange, LastRange)) {
865 ConstantRange Union = LastRange.unionWith(NewRange);
866 Type *Ty = High->getType();
867 EndPoints[Size - 2] =
868 cast<ConstantInt>(ConstantInt::get(Ty, Union.getLower()));
869 EndPoints[Size - 1] =
870 cast<ConstantInt>(ConstantInt::get(Ty, Union.getUpper()));
876 static void addRange(SmallVectorImpl<ConstantInt *> &EndPoints,
877 ConstantInt *Low, ConstantInt *High) {
878 if (!EndPoints.empty())
879 if (tryMergeRange(EndPoints, Low, High))
882 EndPoints.push_back(Low);
883 EndPoints.push_back(High);
886 MDNode *MDNode::getMostGenericRange(MDNode *A, MDNode *B) {
887 // Given two ranges, we want to compute the union of the ranges. This
888 // is slightly complitade by having to combine the intervals and merge
889 // the ones that overlap.
897 // First, walk both lists in older of the lower boundary of each interval.
898 // At each step, try to merge the new interval to the last one we adedd.
899 SmallVector<ConstantInt *, 4> EndPoints;
902 int AN = A->getNumOperands() / 2;
903 int BN = B->getNumOperands() / 2;
904 while (AI < AN && BI < BN) {
905 ConstantInt *ALow = mdconst::extract<ConstantInt>(A->getOperand(2 * AI));
906 ConstantInt *BLow = mdconst::extract<ConstantInt>(B->getOperand(2 * BI));
908 if (ALow->getValue().slt(BLow->getValue())) {
909 addRange(EndPoints, ALow,
910 mdconst::extract<ConstantInt>(A->getOperand(2 * AI + 1)));
913 addRange(EndPoints, BLow,
914 mdconst::extract<ConstantInt>(B->getOperand(2 * BI + 1)));
919 addRange(EndPoints, mdconst::extract<ConstantInt>(A->getOperand(2 * AI)),
920 mdconst::extract<ConstantInt>(A->getOperand(2 * AI + 1)));
924 addRange(EndPoints, mdconst::extract<ConstantInt>(B->getOperand(2 * BI)),
925 mdconst::extract<ConstantInt>(B->getOperand(2 * BI + 1)));
929 // If we have more than 2 ranges (4 endpoints) we have to try to merge
930 // the last and first ones.
931 unsigned Size = EndPoints.size();
933 ConstantInt *FB = EndPoints[0];
934 ConstantInt *FE = EndPoints[1];
935 if (tryMergeRange(EndPoints, FB, FE)) {
936 for (unsigned i = 0; i < Size - 2; ++i) {
937 EndPoints[i] = EndPoints[i + 2];
939 EndPoints.resize(Size - 2);
943 // If in the end we have a single range, it is possible that it is now the
944 // full range. Just drop the metadata in that case.
945 if (EndPoints.size() == 2) {
946 ConstantRange Range(EndPoints[0]->getValue(), EndPoints[1]->getValue());
947 if (Range.isFullSet())
951 SmallVector<Metadata *, 4> MDs;
952 MDs.reserve(EndPoints.size());
953 for (auto *I : EndPoints)
954 MDs.push_back(ConstantAsMetadata::get(I));
955 return MDNode::get(A->getContext(), MDs);
958 MDNode *MDNode::getMostGenericAlignmentOrDereferenceable(MDNode *A, MDNode *B) {
962 ConstantInt *AVal = mdconst::extract<ConstantInt>(A->getOperand(0));
963 ConstantInt *BVal = mdconst::extract<ConstantInt>(B->getOperand(0));
964 if (AVal->getZExtValue() < BVal->getZExtValue())
969 //===----------------------------------------------------------------------===//
970 // NamedMDNode implementation.
973 static SmallVector<TrackingMDRef, 4> &getNMDOps(void *Operands) {
974 return *(SmallVector<TrackingMDRef, 4> *)Operands;
977 NamedMDNode::NamedMDNode(const Twine &N)
978 : Name(N.str()), Parent(nullptr),
979 Operands(new SmallVector<TrackingMDRef, 4>()) {}
981 NamedMDNode::~NamedMDNode() {
983 delete &getNMDOps(Operands);
986 unsigned NamedMDNode::getNumOperands() const {
987 return (unsigned)getNMDOps(Operands).size();
990 MDNode *NamedMDNode::getOperand(unsigned i) const {
991 assert(i < getNumOperands() && "Invalid Operand number!");
992 auto *N = getNMDOps(Operands)[i].get();
993 return cast_or_null<MDNode>(N);
996 void NamedMDNode::addOperand(MDNode *M) { getNMDOps(Operands).emplace_back(M); }
998 void NamedMDNode::setOperand(unsigned I, MDNode *New) {
999 assert(I < getNumOperands() && "Invalid operand number");
1000 getNMDOps(Operands)[I].reset(New);
1003 void NamedMDNode::eraseFromParent() {
1004 getParent()->eraseNamedMetadata(this);
1007 void NamedMDNode::dropAllReferences() {
1008 getNMDOps(Operands).clear();
1011 StringRef NamedMDNode::getName() const {
1012 return StringRef(Name);
1015 //===----------------------------------------------------------------------===//
1016 // Instruction Metadata method implementations.
1018 void MDAttachmentMap::set(unsigned ID, MDNode &MD) {
1019 for (auto &I : Attachments)
1020 if (I.first == ID) {
1021 I.second.reset(&MD);
1024 Attachments.emplace_back(std::piecewise_construct, std::make_tuple(ID),
1025 std::make_tuple(&MD));
1028 void MDAttachmentMap::erase(unsigned ID) {
1032 // Common case is one/last value.
1033 if (Attachments.back().first == ID) {
1034 Attachments.pop_back();
1038 for (auto I = Attachments.begin(), E = std::prev(Attachments.end()); I != E;
1040 if (I->first == ID) {
1041 *I = std::move(Attachments.back());
1042 Attachments.pop_back();
1047 MDNode *MDAttachmentMap::lookup(unsigned ID) const {
1048 for (const auto &I : Attachments)
1054 void MDAttachmentMap::getAll(
1055 SmallVectorImpl<std::pair<unsigned, MDNode *>> &Result) const {
1056 Result.append(Attachments.begin(), Attachments.end());
1058 // Sort the resulting array so it is stable.
1059 if (Result.size() > 1)
1060 array_pod_sort(Result.begin(), Result.end());
1063 void Instruction::setMetadata(StringRef Kind, MDNode *Node) {
1064 if (!Node && !hasMetadata())
1066 setMetadata(getContext().getMDKindID(Kind), Node);
1069 MDNode *Instruction::getMetadataImpl(StringRef Kind) const {
1070 return getMetadataImpl(getContext().getMDKindID(Kind));
1073 void Instruction::dropUnknownNonDebugMetadata(ArrayRef<unsigned> KnownIDs) {
1074 SmallSet<unsigned, 5> KnownSet;
1075 KnownSet.insert(KnownIDs.begin(), KnownIDs.end());
1077 if (!hasMetadataHashEntry())
1078 return; // Nothing to remove!
1080 auto &InstructionMetadata = getContext().pImpl->InstructionMetadata;
1082 if (KnownSet.empty()) {
1083 // Just drop our entry at the store.
1084 InstructionMetadata.erase(this);
1085 setHasMetadataHashEntry(false);
1089 auto &Info = InstructionMetadata[this];
1090 Info.remove_if([&KnownSet](const std::pair<unsigned, TrackingMDNodeRef> &I) {
1091 return !KnownSet.count(I.first);
1095 // Drop our entry at the store.
1096 InstructionMetadata.erase(this);
1097 setHasMetadataHashEntry(false);
1101 /// setMetadata - Set the metadata of the specified kind to the specified
1102 /// node. This updates/replaces metadata if already present, or removes it if
1104 void Instruction::setMetadata(unsigned KindID, MDNode *Node) {
1105 if (!Node && !hasMetadata())
1108 // Handle 'dbg' as a special case since it is not stored in the hash table.
1109 if (KindID == LLVMContext::MD_dbg) {
1110 DbgLoc = DebugLoc(Node);
1114 // Handle the case when we're adding/updating metadata on an instruction.
1116 auto &Info = getContext().pImpl->InstructionMetadata[this];
1117 assert(!Info.empty() == hasMetadataHashEntry() &&
1118 "HasMetadata bit is wonked");
1120 setHasMetadataHashEntry(true);
1121 Info.set(KindID, *Node);
1125 // Otherwise, we're removing metadata from an instruction.
1126 assert((hasMetadataHashEntry() ==
1127 (getContext().pImpl->InstructionMetadata.count(this) > 0)) &&
1128 "HasMetadata bit out of date!");
1129 if (!hasMetadataHashEntry())
1130 return; // Nothing to remove!
1131 auto &Info = getContext().pImpl->InstructionMetadata[this];
1133 // Handle removal of an existing value.
1139 getContext().pImpl->InstructionMetadata.erase(this);
1140 setHasMetadataHashEntry(false);
1143 void Instruction::setAAMetadata(const AAMDNodes &N) {
1144 setMetadata(LLVMContext::MD_tbaa, N.TBAA);
1145 setMetadata(LLVMContext::MD_alias_scope, N.Scope);
1146 setMetadata(LLVMContext::MD_noalias, N.NoAlias);
1149 MDNode *Instruction::getMetadataImpl(unsigned KindID) const {
1150 // Handle 'dbg' as a special case since it is not stored in the hash table.
1151 if (KindID == LLVMContext::MD_dbg)
1152 return DbgLoc.getAsMDNode();
1154 if (!hasMetadataHashEntry())
1156 auto &Info = getContext().pImpl->InstructionMetadata[this];
1157 assert(!Info.empty() && "bit out of sync with hash table");
1159 return Info.lookup(KindID);
1162 void Instruction::getAllMetadataImpl(
1163 SmallVectorImpl<std::pair<unsigned, MDNode *>> &Result) const {
1166 // Handle 'dbg' as a special case since it is not stored in the hash table.
1169 std::make_pair((unsigned)LLVMContext::MD_dbg, DbgLoc.getAsMDNode()));
1170 if (!hasMetadataHashEntry()) return;
1173 assert(hasMetadataHashEntry() &&
1174 getContext().pImpl->InstructionMetadata.count(this) &&
1175 "Shouldn't have called this");
1176 const auto &Info = getContext().pImpl->InstructionMetadata.find(this)->second;
1177 assert(!Info.empty() && "Shouldn't have called this");
1178 Info.getAll(Result);
1181 void Instruction::getAllMetadataOtherThanDebugLocImpl(
1182 SmallVectorImpl<std::pair<unsigned, MDNode *>> &Result) const {
1184 assert(hasMetadataHashEntry() &&
1185 getContext().pImpl->InstructionMetadata.count(this) &&
1186 "Shouldn't have called this");
1187 const auto &Info = getContext().pImpl->InstructionMetadata.find(this)->second;
1188 assert(!Info.empty() && "Shouldn't have called this");
1189 Info.getAll(Result);
1192 /// clearMetadataHashEntries - Clear all hashtable-based metadata from
1193 /// this instruction.
1194 void Instruction::clearMetadataHashEntries() {
1195 assert(hasMetadataHashEntry() && "Caller should check");
1196 getContext().pImpl->InstructionMetadata.erase(this);
1197 setHasMetadataHashEntry(false);
1200 MDNode *Function::getMetadata(unsigned KindID) const {
1203 return getContext().pImpl->FunctionMetadata[this].lookup(KindID);
1206 MDNode *Function::getMetadata(StringRef Kind) const {
1209 return getMetadata(getContext().getMDKindID(Kind));
1212 void Function::setMetadata(unsigned KindID, MDNode *MD) {
1215 setHasMetadataHashEntry(true);
1217 getContext().pImpl->FunctionMetadata[this].set(KindID, *MD);
1221 // Nothing to unset.
1225 auto &Store = getContext().pImpl->FunctionMetadata[this];
1226 Store.erase(KindID);
1231 void Function::setMetadata(StringRef Kind, MDNode *MD) {
1232 if (!MD && !hasMetadata())
1234 setMetadata(getContext().getMDKindID(Kind), MD);
1237 void Function::getAllMetadata(
1238 SmallVectorImpl<std::pair<unsigned, MDNode *>> &MDs) const {
1244 getContext().pImpl->FunctionMetadata[this].getAll(MDs);
1247 void Function::dropUnknownMetadata(ArrayRef<unsigned> KnownIDs) {
1250 if (KnownIDs.empty()) {
1255 SmallSet<unsigned, 5> KnownSet;
1256 KnownSet.insert(KnownIDs.begin(), KnownIDs.end());
1258 auto &Store = getContext().pImpl->FunctionMetadata[this];
1259 assert(!Store.empty());
1261 Store.remove_if([&KnownSet](const std::pair<unsigned, TrackingMDNodeRef> &I) {
1262 return !KnownSet.count(I.first);
1269 void Function::clearMetadata() {
1272 getContext().pImpl->FunctionMetadata.erase(this);
1273 setHasMetadataHashEntry(false);
1276 void Function::setSubprogram(DISubprogram *SP) {
1277 setMetadata(LLVMContext::MD_dbg, SP);
1280 DISubprogram *Function::getSubprogram() const {
1281 return cast_or_null<DISubprogram>(getMetadata(LLVMContext::MD_dbg));