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 "SymbolTableListTraitsImpl.h"
17 #include "llvm/ADT/DenseMap.h"
18 #include "llvm/ADT/STLExtras.h"
19 #include "llvm/ADT/SmallSet.h"
20 #include "llvm/ADT/SmallString.h"
21 #include "llvm/ADT/StringMap.h"
22 #include "llvm/IR/ConstantRange.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 /// \brief 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 auto I = Store.find(MD);
86 return I == Store.end() ? nullptr : I->second;
89 void MetadataAsValue::handleChangedMetadata(Metadata *MD) {
90 LLVMContext &Context = getContext();
91 MD = canonicalizeMetadataForValue(Context, MD);
92 auto &Store = Context.pImpl->MetadataAsValues;
94 // Stop tracking the old metadata.
95 Store.erase(this->MD);
99 // Start tracking MD, or RAUW if necessary.
100 auto *&Entry = Store[MD];
102 replaceAllUsesWith(Entry);
112 void MetadataAsValue::track() {
114 MetadataTracking::track(&MD, *MD, *this);
117 void MetadataAsValue::untrack() {
119 MetadataTracking::untrack(MD);
122 void ReplaceableMetadataImpl::addRef(void *Ref, OwnerTy Owner) {
124 UseMap.insert(std::make_pair(Ref, std::make_pair(Owner, NextIndex)))
127 assert(WasInserted && "Expected to add a reference");
130 assert(NextIndex != 0 && "Unexpected overflow");
133 void ReplaceableMetadataImpl::dropRef(void *Ref) {
134 bool WasErased = UseMap.erase(Ref);
136 assert(WasErased && "Expected to drop a reference");
139 void ReplaceableMetadataImpl::moveRef(void *Ref, void *New,
140 const Metadata &MD) {
141 auto I = UseMap.find(Ref);
142 assert(I != UseMap.end() && "Expected to move a reference");
143 auto OwnerAndIndex = I->second;
145 bool WasInserted = UseMap.insert(std::make_pair(New, OwnerAndIndex)).second;
147 assert(WasInserted && "Expected to add a reference");
149 // Check that the references are direct if there's no owner.
151 assert((OwnerAndIndex.first || *static_cast<Metadata **>(Ref) == &MD) &&
152 "Reference without owner must be direct");
153 assert((OwnerAndIndex.first || *static_cast<Metadata **>(New) == &MD) &&
154 "Reference without owner must be direct");
157 void ReplaceableMetadataImpl::replaceAllUsesWith(Metadata *MD) {
158 assert(!(MD && isa<MDNodeFwdDecl>(MD)) && "Expected non-temp node");
163 // Copy out uses since UseMap will get touched below.
164 typedef std::pair<void *, std::pair<OwnerTy, uint64_t>> UseTy;
165 SmallVector<UseTy, 8> Uses(UseMap.begin(), UseMap.end());
166 std::sort(Uses.begin(), Uses.end(), [](const UseTy &L, const UseTy &R) {
167 return L.second.second < R.second.second;
169 for (const auto &Pair : Uses) {
170 // Check that this Ref hasn't disappeared after RAUW (when updating a
172 if (!UseMap.count(Pair.first))
175 OwnerTy Owner = Pair.second.first;
177 // Update unowned tracking references directly.
178 Metadata *&Ref = *static_cast<Metadata **>(Pair.first);
181 MetadataTracking::track(Ref);
182 UseMap.erase(Pair.first);
186 // Check for MetadataAsValue.
187 if (Owner.is<MetadataAsValue *>()) {
188 Owner.get<MetadataAsValue *>()->handleChangedMetadata(MD);
192 // There's a Metadata owner -- dispatch.
193 Metadata *OwnerMD = Owner.get<Metadata *>();
194 switch (OwnerMD->getMetadataID()) {
195 #define HANDLE_METADATA_LEAF(CLASS) \
196 case Metadata::CLASS##Kind: \
197 cast<CLASS>(OwnerMD)->handleChangedOperand(Pair.first, MD); \
199 #include "llvm/IR/Metadata.def"
201 llvm_unreachable("Invalid metadata subclass");
204 assert(UseMap.empty() && "Expected all uses to be replaced");
207 void ReplaceableMetadataImpl::resolveAllUses(bool ResolveUsers) {
216 // Copy out uses since UseMap could get touched below.
217 typedef std::pair<void *, std::pair<OwnerTy, uint64_t>> UseTy;
218 SmallVector<UseTy, 8> Uses(UseMap.begin(), UseMap.end());
219 std::sort(Uses.begin(), Uses.end(), [](const UseTy &L, const UseTy &R) {
220 return L.second.second < R.second.second;
223 for (const auto &Pair : Uses) {
224 auto Owner = Pair.second.first;
227 if (Owner.is<MetadataAsValue *>())
230 // Resolve UniquableMDNodes that point at this.
231 auto *OwnerMD = dyn_cast<UniquableMDNode>(Owner.get<Metadata *>());
234 if (OwnerMD->isResolved())
236 OwnerMD->decrementUnresolvedOperandCount();
240 static Function *getLocalFunction(Value *V) {
241 assert(V && "Expected value");
242 if (auto *A = dyn_cast<Argument>(V))
243 return A->getParent();
244 if (BasicBlock *BB = cast<Instruction>(V)->getParent())
245 return BB->getParent();
249 ValueAsMetadata *ValueAsMetadata::get(Value *V) {
250 assert(V && "Unexpected null Value");
252 auto &Context = V->getContext();
253 auto *&Entry = Context.pImpl->ValuesAsMetadata[V];
255 assert((isa<Constant>(V) || isa<Argument>(V) || isa<Instruction>(V)) &&
256 "Expected constant or function-local value");
257 assert(!V->NameAndIsUsedByMD.getInt() &&
258 "Expected this to be the only metadata use");
259 V->NameAndIsUsedByMD.setInt(true);
260 if (auto *C = dyn_cast<Constant>(V))
261 Entry = new ConstantAsMetadata(C);
263 Entry = new LocalAsMetadata(V);
269 ValueAsMetadata *ValueAsMetadata::getIfExists(Value *V) {
270 assert(V && "Unexpected null Value");
271 return V->getContext().pImpl->ValuesAsMetadata.lookup(V);
274 void ValueAsMetadata::handleDeletion(Value *V) {
275 assert(V && "Expected valid value");
277 auto &Store = V->getType()->getContext().pImpl->ValuesAsMetadata;
278 auto I = Store.find(V);
279 if (I == Store.end())
282 // Remove old entry from the map.
283 ValueAsMetadata *MD = I->second;
284 assert(MD && "Expected valid metadata");
285 assert(MD->getValue() == V && "Expected valid mapping");
288 // Delete the metadata.
289 MD->replaceAllUsesWith(nullptr);
293 void ValueAsMetadata::handleRAUW(Value *From, Value *To) {
294 assert(From && "Expected valid value");
295 assert(To && "Expected valid value");
296 assert(From != To && "Expected changed value");
297 assert(From->getType() == To->getType() && "Unexpected type change");
299 LLVMContext &Context = From->getType()->getContext();
300 auto &Store = Context.pImpl->ValuesAsMetadata;
301 auto I = Store.find(From);
302 if (I == Store.end()) {
303 assert(!From->NameAndIsUsedByMD.getInt() &&
304 "Expected From not to be used by metadata");
308 // Remove old entry from the map.
309 assert(From->NameAndIsUsedByMD.getInt() &&
310 "Expected From to be used by metadata");
311 From->NameAndIsUsedByMD.setInt(false);
312 ValueAsMetadata *MD = I->second;
313 assert(MD && "Expected valid metadata");
314 assert(MD->getValue() == From && "Expected valid mapping");
317 if (isa<LocalAsMetadata>(MD)) {
318 if (auto *C = dyn_cast<Constant>(To)) {
319 // Local became a constant.
320 MD->replaceAllUsesWith(ConstantAsMetadata::get(C));
324 if (getLocalFunction(From) && getLocalFunction(To) &&
325 getLocalFunction(From) != getLocalFunction(To)) {
327 MD->replaceAllUsesWith(nullptr);
331 } else if (!isa<Constant>(To)) {
332 // Changed to function-local value.
333 MD->replaceAllUsesWith(nullptr);
338 auto *&Entry = Store[To];
340 // The target already exists.
341 MD->replaceAllUsesWith(Entry);
346 // Update MD in place (and update the map entry).
347 assert(!To->NameAndIsUsedByMD.getInt() &&
348 "Expected this to be the only metadata use");
349 To->NameAndIsUsedByMD.setInt(true);
354 //===----------------------------------------------------------------------===//
355 // MDString implementation.
358 MDString *MDString::get(LLVMContext &Context, StringRef Str) {
359 auto &Store = Context.pImpl->MDStringCache;
360 auto I = Store.find(Str);
361 if (I != Store.end())
365 StringMapEntry<MDString>::Create(Str, Store.getAllocator(), MDString());
366 bool WasInserted = Store.insert(Entry);
368 assert(WasInserted && "Expected entry to be inserted");
369 Entry->second.Entry = Entry;
370 return &Entry->second;
373 StringRef MDString::getString() const {
374 assert(Entry && "Expected to find string map entry");
375 return Entry->first();
378 //===----------------------------------------------------------------------===//
379 // MDNode implementation.
382 void *MDNode::operator new(size_t Size, unsigned NumOps) {
383 void *Ptr = ::operator new(Size + NumOps * sizeof(MDOperand));
384 MDOperand *O = static_cast<MDOperand *>(Ptr);
385 for (MDOperand *E = O + NumOps; O != E; ++O)
386 (void)new (O) MDOperand;
390 void MDNode::operator delete(void *Mem) {
391 MDNode *N = static_cast<MDNode *>(Mem);
392 MDOperand *O = static_cast<MDOperand *>(Mem);
393 for (MDOperand *E = O - N->NumOperands; O != E; --O)
394 (O - 1)->~MDOperand();
395 ::operator delete(O);
398 MDNode::MDNode(LLVMContext &Context, unsigned ID, StorageType Storage,
399 ArrayRef<Metadata *> MDs)
400 : Metadata(ID, Storage), Context(Context), NumOperands(MDs.size()),
401 MDNodeSubclassData(0) {
402 for (unsigned I = 0, E = MDs.size(); I != E; ++I)
403 setOperand(I, MDs[I]);
406 bool MDNode::isResolved() const {
407 if (isa<MDNodeFwdDecl>(this))
409 return cast<UniquableMDNode>(this)->isResolved();
412 static bool isOperandUnresolved(Metadata *Op) {
413 if (auto *N = dyn_cast_or_null<MDNode>(Op))
414 return !N->isResolved();
418 UniquableMDNode::UniquableMDNode(LLVMContext &C, unsigned ID,
419 StorageType Storage, ArrayRef<Metadata *> Vals)
420 : MDNode(C, ID, Storage, Vals) {
421 if (Storage != Uniqued)
424 // Check whether any operands are unresolved, requiring re-uniquing.
425 unsigned NumUnresolved = 0;
426 for (const auto &Op : operands())
427 NumUnresolved += unsigned(isOperandUnresolved(Op));
432 ReplaceableUses.reset(new ReplaceableMetadataImpl);
433 SubclassData32 = NumUnresolved;
436 void UniquableMDNode::resolve() {
437 assert(!isResolved() && "Expected this to be unresolved");
439 // Move the map, so that this immediately looks resolved.
440 auto Uses = std::move(ReplaceableUses);
442 assert(isResolved() && "Expected this to be resolved");
444 // Drop RAUW support.
445 Uses->resolveAllUses();
448 void UniquableMDNode::resolveAfterOperandChange(Metadata *Old, Metadata *New) {
449 assert(SubclassData32 != 0 && "Expected unresolved operands");
451 // Check if an operand was resolved.
452 if (!isOperandUnresolved(Old)) {
453 if (isOperandUnresolved(New))
454 // An operand was un-resolved!
456 } else if (!isOperandUnresolved(New))
457 decrementUnresolvedOperandCount();
460 void UniquableMDNode::decrementUnresolvedOperandCount() {
461 if (!--SubclassData32)
462 // Last unresolved operand has just been resolved.
466 void UniquableMDNode::resolveCycles() {
470 // Resolve this node immediately.
473 // Resolve all operands.
474 for (const auto &Op : operands()) {
477 assert(!isa<MDNodeFwdDecl>(Op) &&
478 "Expected all forward declarations to be resolved");
479 if (auto *N = dyn_cast<UniquableMDNode>(Op))
480 if (!N->isResolved())
485 void MDTuple::recalculateHash() {
486 setHash(hash_combine_range(op_begin(), op_end()));
489 SmallVector<Metadata *, 8> MDs(op_begin(), op_end());
490 unsigned RawHash = hash_combine_range(MDs.begin(), MDs.end());
491 assert(getHash() == RawHash &&
492 "Expected hash of MDOperand to equal hash of Metadata*");
497 void MDNode::dropAllReferences() {
498 for (unsigned I = 0, E = NumOperands; I != E; ++I)
499 setOperand(I, nullptr);
500 if (auto *N = dyn_cast<UniquableMDNode>(this))
501 if (!N->isResolved()) {
502 N->ReplaceableUses->resolveAllUses(/* ResolveUsers */ false);
503 N->ReplaceableUses.reset();
508 /// \brief Make MDOperand transparent for hashing.
510 /// This overload of an implementation detail of the hashing library makes
511 /// MDOperand hash to the same value as a \a Metadata pointer.
513 /// Note that overloading \a hash_value() as follows:
516 /// size_t hash_value(const MDOperand &X) { return hash_value(X.get()); }
519 /// does not cause MDOperand to be transparent. In particular, a bare pointer
520 /// doesn't get hashed before it's combined, whereas \a MDOperand would.
521 static const Metadata *get_hashable_data(const MDOperand &X) { return X.get(); }
524 void UniquableMDNode::handleChangedOperand(void *Ref, Metadata *New) {
525 unsigned Op = static_cast<MDOperand *>(Ref) - op_begin();
526 assert(Op < getNumOperands() && "Expected valid operand");
528 if (isStoredDistinctInContext()) {
529 assert(isResolved() && "Expected distinct node to be resolved");
531 // This node is not uniqued. Just set the operand and be done with it.
536 // This node is uniqued.
539 Metadata *Old = getOperand(Op);
542 // Drop uniquing for self-reference cycles.
544 storeDistinctInContext();
550 // Re-unique the node.
551 auto *Uniqued = uniquify();
552 if (Uniqued == this) {
554 resolveAfterOperandChange(Old, New);
560 // Still unresolved, so RAUW.
562 // First, clear out all operands to prevent any recursion (similar to
563 // dropAllReferences(), but we still need the use-list).
564 for (unsigned O = 0, E = getNumOperands(); O != E; ++O)
565 setOperand(O, nullptr);
566 ReplaceableUses->replaceAllUsesWith(Uniqued);
571 // Store in non-uniqued form if RAUW isn't possible.
572 storeDistinctInContext();
575 void UniquableMDNode::deleteAsSubclass() {
576 switch (getMetadataID()) {
578 llvm_unreachable("Invalid subclass of UniquableMDNode");
579 #define HANDLE_UNIQUABLE_LEAF(CLASS) \
581 delete cast<CLASS>(this); \
583 #include "llvm/IR/Metadata.def"
587 UniquableMDNode *UniquableMDNode::uniquify() {
588 switch (getMetadataID()) {
590 llvm_unreachable("Invalid subclass of UniquableMDNode");
591 #define HANDLE_UNIQUABLE_LEAF(CLASS) \
593 return cast<CLASS>(this)->uniquifyImpl();
594 #include "llvm/IR/Metadata.def"
598 void UniquableMDNode::eraseFromStore() {
599 switch (getMetadataID()) {
601 llvm_unreachable("Invalid subclass of UniquableMDNode");
602 #define HANDLE_UNIQUABLE_LEAF(CLASS) \
604 cast<CLASS>(this)->eraseFromStoreImpl(); \
606 #include "llvm/IR/Metadata.def"
610 MDTuple *MDTuple::getImpl(LLVMContext &Context, ArrayRef<Metadata *> MDs,
612 MDTupleInfo::KeyTy Key(MDs);
614 auto &Store = Context.pImpl->MDTuples;
615 auto I = Store.find_as(Key);
616 if (I != Store.end())
621 // Coallocate space for the node and Operands together, then placement new.
622 auto *N = new (MDs.size()) MDTuple(Context, Uniqued, MDs);
623 N->setHash(Key.Hash);
628 MDTuple *MDTuple::getDistinct(LLVMContext &Context, ArrayRef<Metadata *> MDs) {
629 auto *N = new (MDs.size()) MDTuple(Context, Distinct, MDs);
630 N->storeDistinctInContext();
634 MDTuple *MDTuple::uniquifyImpl() {
636 MDTupleInfo::KeyTy Key(this);
638 auto &Store = getContext().pImpl->MDTuples;
639 auto I = Store.find_as(Key);
640 if (I == Store.end()) {
647 void MDTuple::eraseFromStoreImpl() { getContext().pImpl->MDTuples.erase(this); }
649 MDLocation::MDLocation(LLVMContext &C, StorageType Storage, unsigned Line,
650 unsigned Column, ArrayRef<Metadata *> MDs)
651 : UniquableMDNode(C, MDLocationKind, Storage, MDs) {
652 assert((MDs.size() == 1 || MDs.size() == 2) &&
653 "Expected a scope and optional inlined-at");
655 // Set line and column.
656 assert(Line < (1u << 24) && "Expected 24-bit line");
657 assert(Column < (1u << 16) && "Expected 16-bit column");
659 MDNodeSubclassData = Line;
660 SubclassData16 = Column;
663 MDLocation *MDLocation::constructHelper(LLVMContext &Context,
664 StorageType Storage, unsigned Line,
665 unsigned Column, Metadata *Scope,
666 Metadata *InlinedAt) {
667 SmallVector<Metadata *, 2> Ops;
668 Ops.push_back(Scope);
670 Ops.push_back(InlinedAt);
671 return new (Ops.size()) MDLocation(Context, Storage, Line, Column, Ops);
674 static void adjustLine(unsigned &Line) {
675 // Set to unknown on overflow. Still use 24 bits for now.
676 if (Line >= (1u << 24))
680 static void adjustColumn(unsigned &Column) {
681 // Set to unknown on overflow. We only have 16 bits to play with here.
682 if (Column >= (1u << 16))
686 MDLocation *MDLocation::getImpl(LLVMContext &Context, unsigned Line,
687 unsigned Column, Metadata *Scope,
688 Metadata *InlinedAt, bool ShouldCreate) {
689 // Fixup line/column.
691 adjustColumn(Column);
693 MDLocationInfo::KeyTy Key(Line, Column, Scope, InlinedAt);
695 auto &Store = Context.pImpl->MDLocations;
696 auto I = Store.find_as(Key);
697 if (I != Store.end())
702 auto *N = constructHelper(Context, Uniqued, Line, Column, Scope, InlinedAt);
707 MDLocation *MDLocation::getDistinct(LLVMContext &Context, unsigned Line,
708 unsigned Column, Metadata *Scope,
709 Metadata *InlinedAt) {
710 // Fixup line/column.
712 adjustColumn(Column);
714 auto *N = constructHelper(Context, Distinct, Line, Column, Scope, InlinedAt);
715 N->storeDistinctInContext();
719 MDLocation *MDLocation::uniquifyImpl() {
720 MDLocationInfo::KeyTy Key(this);
722 auto &Store = getContext().pImpl->MDLocations;
723 auto I = Store.find_as(Key);
724 if (I == Store.end()) {
731 void MDLocation::eraseFromStoreImpl() {
732 getContext().pImpl->MDLocations.erase(this);
735 MDNodeFwdDecl *MDNode::getTemporary(LLVMContext &Context,
736 ArrayRef<Metadata *> MDs) {
737 return MDNodeFwdDecl::get(Context, MDs);
740 void MDNode::deleteTemporary(MDNode *N) { delete cast<MDNodeFwdDecl>(N); }
742 void UniquableMDNode::storeDistinctInContext() {
744 if (auto *T = dyn_cast<MDTuple>(this))
746 getContext().pImpl->DistinctMDNodes.insert(this);
749 void MDNode::replaceOperandWith(unsigned I, Metadata *New) {
750 if (getOperand(I) == New)
758 cast<UniquableMDNode>(this)->handleChangedOperand(mutable_begin() + I, New);
761 void MDNode::setOperand(unsigned I, Metadata *New) {
762 assert(I < NumOperands);
763 if (isStoredDistinctInContext() || isa<MDNodeFwdDecl>(this))
764 // No need for a callback, this isn't uniqued.
765 mutable_begin()[I].reset(New, nullptr);
767 mutable_begin()[I].reset(New, this);
770 /// \brief Get a node, or a self-reference that looks like it.
772 /// Special handling for finding self-references, for use by \a
773 /// MDNode::concatenate() and \a MDNode::intersect() to maintain behaviour from
774 /// when self-referencing nodes were still uniqued. If the first operand has
775 /// the same operands as \c Ops, return the first operand instead.
776 static MDNode *getOrSelfReference(LLVMContext &Context,
777 ArrayRef<Metadata *> Ops) {
779 if (MDNode *N = dyn_cast_or_null<MDNode>(Ops[0]))
780 if (N->getNumOperands() == Ops.size() && N == N->getOperand(0)) {
781 for (unsigned I = 1, E = Ops.size(); I != E; ++I)
782 if (Ops[I] != N->getOperand(I))
783 return MDNode::get(Context, Ops);
787 return MDNode::get(Context, Ops);
790 MDNode *MDNode::concatenate(MDNode *A, MDNode *B) {
796 SmallVector<Metadata *, 4> MDs(A->getNumOperands() + B->getNumOperands());
799 for (unsigned i = 0, ie = A->getNumOperands(); i != ie; ++i)
800 MDs[j++] = A->getOperand(i);
801 for (unsigned i = 0, ie = B->getNumOperands(); i != ie; ++i)
802 MDs[j++] = B->getOperand(i);
804 // FIXME: This preserves long-standing behaviour, but is it really the right
805 // behaviour? Or was that an unintended side-effect of node uniquing?
806 return getOrSelfReference(A->getContext(), MDs);
809 MDNode *MDNode::intersect(MDNode *A, MDNode *B) {
813 SmallVector<Metadata *, 4> MDs;
814 for (unsigned i = 0, ie = A->getNumOperands(); i != ie; ++i) {
815 Metadata *MD = A->getOperand(i);
816 for (unsigned j = 0, je = B->getNumOperands(); j != je; ++j)
817 if (MD == B->getOperand(j)) {
823 // FIXME: This preserves long-standing behaviour, but is it really the right
824 // behaviour? Or was that an unintended side-effect of node uniquing?
825 return getOrSelfReference(A->getContext(), MDs);
828 MDNode *MDNode::getMostGenericFPMath(MDNode *A, MDNode *B) {
832 APFloat AVal = mdconst::extract<ConstantFP>(A->getOperand(0))->getValueAPF();
833 APFloat BVal = mdconst::extract<ConstantFP>(B->getOperand(0))->getValueAPF();
834 if (AVal.compare(BVal) == APFloat::cmpLessThan)
839 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
840 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
843 static bool canBeMerged(const ConstantRange &A, const ConstantRange &B) {
844 return !A.intersectWith(B).isEmptySet() || isContiguous(A, B);
847 static bool tryMergeRange(SmallVectorImpl<ConstantInt *> &EndPoints,
848 ConstantInt *Low, ConstantInt *High) {
849 ConstantRange NewRange(Low->getValue(), High->getValue());
850 unsigned Size = EndPoints.size();
851 APInt LB = EndPoints[Size - 2]->getValue();
852 APInt LE = EndPoints[Size - 1]->getValue();
853 ConstantRange LastRange(LB, LE);
854 if (canBeMerged(NewRange, LastRange)) {
855 ConstantRange Union = LastRange.unionWith(NewRange);
856 Type *Ty = High->getType();
857 EndPoints[Size - 2] =
858 cast<ConstantInt>(ConstantInt::get(Ty, Union.getLower()));
859 EndPoints[Size - 1] =
860 cast<ConstantInt>(ConstantInt::get(Ty, Union.getUpper()));
866 static void addRange(SmallVectorImpl<ConstantInt *> &EndPoints,
867 ConstantInt *Low, ConstantInt *High) {
868 if (!EndPoints.empty())
869 if (tryMergeRange(EndPoints, Low, High))
872 EndPoints.push_back(Low);
873 EndPoints.push_back(High);
876 MDNode *MDNode::getMostGenericRange(MDNode *A, MDNode *B) {
877 // Given two ranges, we want to compute the union of the ranges. This
878 // is slightly complitade by having to combine the intervals and merge
879 // the ones that overlap.
887 // First, walk both lists in older of the lower boundary of each interval.
888 // At each step, try to merge the new interval to the last one we adedd.
889 SmallVector<ConstantInt *, 4> EndPoints;
892 int AN = A->getNumOperands() / 2;
893 int BN = B->getNumOperands() / 2;
894 while (AI < AN && BI < BN) {
895 ConstantInt *ALow = mdconst::extract<ConstantInt>(A->getOperand(2 * AI));
896 ConstantInt *BLow = mdconst::extract<ConstantInt>(B->getOperand(2 * BI));
898 if (ALow->getValue().slt(BLow->getValue())) {
899 addRange(EndPoints, ALow,
900 mdconst::extract<ConstantInt>(A->getOperand(2 * AI + 1)));
903 addRange(EndPoints, BLow,
904 mdconst::extract<ConstantInt>(B->getOperand(2 * BI + 1)));
909 addRange(EndPoints, mdconst::extract<ConstantInt>(A->getOperand(2 * AI)),
910 mdconst::extract<ConstantInt>(A->getOperand(2 * AI + 1)));
914 addRange(EndPoints, mdconst::extract<ConstantInt>(B->getOperand(2 * BI)),
915 mdconst::extract<ConstantInt>(B->getOperand(2 * BI + 1)));
919 // If we have more than 2 ranges (4 endpoints) we have to try to merge
920 // the last and first ones.
921 unsigned Size = EndPoints.size();
923 ConstantInt *FB = EndPoints[0];
924 ConstantInt *FE = EndPoints[1];
925 if (tryMergeRange(EndPoints, FB, FE)) {
926 for (unsigned i = 0; i < Size - 2; ++i) {
927 EndPoints[i] = EndPoints[i + 2];
929 EndPoints.resize(Size - 2);
933 // If in the end we have a single range, it is possible that it is now the
934 // full range. Just drop the metadata in that case.
935 if (EndPoints.size() == 2) {
936 ConstantRange Range(EndPoints[0]->getValue(), EndPoints[1]->getValue());
937 if (Range.isFullSet())
941 SmallVector<Metadata *, 4> MDs;
942 MDs.reserve(EndPoints.size());
943 for (auto *I : EndPoints)
944 MDs.push_back(ConstantAsMetadata::get(I));
945 return MDNode::get(A->getContext(), MDs);
948 //===----------------------------------------------------------------------===//
949 // NamedMDNode implementation.
952 static SmallVector<TrackingMDRef, 4> &getNMDOps(void *Operands) {
953 return *(SmallVector<TrackingMDRef, 4> *)Operands;
956 NamedMDNode::NamedMDNode(const Twine &N)
957 : Name(N.str()), Parent(nullptr),
958 Operands(new SmallVector<TrackingMDRef, 4>()) {}
960 NamedMDNode::~NamedMDNode() {
962 delete &getNMDOps(Operands);
965 unsigned NamedMDNode::getNumOperands() const {
966 return (unsigned)getNMDOps(Operands).size();
969 MDNode *NamedMDNode::getOperand(unsigned i) const {
970 assert(i < getNumOperands() && "Invalid Operand number!");
971 auto *N = getNMDOps(Operands)[i].get();
972 return cast_or_null<MDNode>(N);
975 void NamedMDNode::addOperand(MDNode *M) { getNMDOps(Operands).emplace_back(M); }
977 void NamedMDNode::setOperand(unsigned I, MDNode *New) {
978 assert(I < getNumOperands() && "Invalid operand number");
979 getNMDOps(Operands)[I].reset(New);
982 void NamedMDNode::eraseFromParent() {
983 getParent()->eraseNamedMetadata(this);
986 void NamedMDNode::dropAllReferences() {
987 getNMDOps(Operands).clear();
990 StringRef NamedMDNode::getName() const {
991 return StringRef(Name);
994 //===----------------------------------------------------------------------===//
995 // Instruction Metadata method implementations.
998 void Instruction::setMetadata(StringRef Kind, MDNode *Node) {
999 if (!Node && !hasMetadata())
1001 setMetadata(getContext().getMDKindID(Kind), Node);
1004 MDNode *Instruction::getMetadataImpl(StringRef Kind) const {
1005 return getMetadataImpl(getContext().getMDKindID(Kind));
1008 void Instruction::dropUnknownMetadata(ArrayRef<unsigned> KnownIDs) {
1009 SmallSet<unsigned, 5> KnownSet;
1010 KnownSet.insert(KnownIDs.begin(), KnownIDs.end());
1012 // Drop debug if needed
1013 if (KnownSet.erase(LLVMContext::MD_dbg))
1014 DbgLoc = DebugLoc();
1016 if (!hasMetadataHashEntry())
1017 return; // Nothing to remove!
1019 DenseMap<const Instruction *, LLVMContextImpl::MDMapTy> &MetadataStore =
1020 getContext().pImpl->MetadataStore;
1022 if (KnownSet.empty()) {
1023 // Just drop our entry at the store.
1024 MetadataStore.erase(this);
1025 setHasMetadataHashEntry(false);
1029 LLVMContextImpl::MDMapTy &Info = MetadataStore[this];
1032 // Walk the array and drop any metadata we don't know.
1033 for (I = 0, E = Info.size(); I != E;) {
1034 if (KnownSet.count(Info[I].first)) {
1039 Info[I] = std::move(Info.back());
1043 assert(E == Info.size());
1046 // Drop our entry at the store.
1047 MetadataStore.erase(this);
1048 setHasMetadataHashEntry(false);
1052 /// setMetadata - Set the metadata of of the specified kind to the specified
1053 /// node. This updates/replaces metadata if already present, or removes it if
1055 void Instruction::setMetadata(unsigned KindID, MDNode *Node) {
1056 if (!Node && !hasMetadata())
1059 // Handle 'dbg' as a special case since it is not stored in the hash table.
1060 if (KindID == LLVMContext::MD_dbg) {
1061 DbgLoc = DebugLoc::getFromDILocation(Node);
1065 // Handle the case when we're adding/updating metadata on an instruction.
1067 LLVMContextImpl::MDMapTy &Info = getContext().pImpl->MetadataStore[this];
1068 assert(!Info.empty() == hasMetadataHashEntry() &&
1069 "HasMetadata bit is wonked");
1071 setHasMetadataHashEntry(true);
1073 // Handle replacement of an existing value.
1074 for (auto &P : Info)
1075 if (P.first == KindID) {
1076 P.second.reset(Node);
1081 // No replacement, just add it to the list.
1082 Info.emplace_back(std::piecewise_construct, std::make_tuple(KindID),
1083 std::make_tuple(Node));
1087 // Otherwise, we're removing metadata from an instruction.
1088 assert((hasMetadataHashEntry() ==
1089 (getContext().pImpl->MetadataStore.count(this) > 0)) &&
1090 "HasMetadata bit out of date!");
1091 if (!hasMetadataHashEntry())
1092 return; // Nothing to remove!
1093 LLVMContextImpl::MDMapTy &Info = getContext().pImpl->MetadataStore[this];
1095 // Common case is removing the only entry.
1096 if (Info.size() == 1 && Info[0].first == KindID) {
1097 getContext().pImpl->MetadataStore.erase(this);
1098 setHasMetadataHashEntry(false);
1102 // Handle removal of an existing value.
1103 for (unsigned i = 0, e = Info.size(); i != e; ++i)
1104 if (Info[i].first == KindID) {
1105 Info[i] = std::move(Info.back());
1107 assert(!Info.empty() && "Removing last entry should be handled above");
1110 // Otherwise, removing an entry that doesn't exist on the instruction.
1113 void Instruction::setAAMetadata(const AAMDNodes &N) {
1114 setMetadata(LLVMContext::MD_tbaa, N.TBAA);
1115 setMetadata(LLVMContext::MD_alias_scope, N.Scope);
1116 setMetadata(LLVMContext::MD_noalias, N.NoAlias);
1119 MDNode *Instruction::getMetadataImpl(unsigned KindID) const {
1120 // Handle 'dbg' as a special case since it is not stored in the hash table.
1121 if (KindID == LLVMContext::MD_dbg)
1122 return DbgLoc.getAsMDNode();
1124 if (!hasMetadataHashEntry()) return nullptr;
1126 LLVMContextImpl::MDMapTy &Info = getContext().pImpl->MetadataStore[this];
1127 assert(!Info.empty() && "bit out of sync with hash table");
1129 for (const auto &I : Info)
1130 if (I.first == KindID)
1135 void Instruction::getAllMetadataImpl(
1136 SmallVectorImpl<std::pair<unsigned, MDNode *>> &Result) const {
1139 // Handle 'dbg' as a special case since it is not stored in the hash table.
1140 if (!DbgLoc.isUnknown()) {
1142 std::make_pair((unsigned)LLVMContext::MD_dbg, DbgLoc.getAsMDNode()));
1143 if (!hasMetadataHashEntry()) return;
1146 assert(hasMetadataHashEntry() &&
1147 getContext().pImpl->MetadataStore.count(this) &&
1148 "Shouldn't have called this");
1149 const LLVMContextImpl::MDMapTy &Info =
1150 getContext().pImpl->MetadataStore.find(this)->second;
1151 assert(!Info.empty() && "Shouldn't have called this");
1153 Result.reserve(Result.size() + Info.size());
1154 for (auto &I : Info)
1155 Result.push_back(std::make_pair(I.first, cast<MDNode>(I.second.get())));
1157 // Sort the resulting array so it is stable.
1158 if (Result.size() > 1)
1159 array_pod_sort(Result.begin(), Result.end());
1162 void Instruction::getAllMetadataOtherThanDebugLocImpl(
1163 SmallVectorImpl<std::pair<unsigned, MDNode *>> &Result) const {
1165 assert(hasMetadataHashEntry() &&
1166 getContext().pImpl->MetadataStore.count(this) &&
1167 "Shouldn't have called this");
1168 const LLVMContextImpl::MDMapTy &Info =
1169 getContext().pImpl->MetadataStore.find(this)->second;
1170 assert(!Info.empty() && "Shouldn't have called this");
1171 Result.reserve(Result.size() + Info.size());
1172 for (auto &I : Info)
1173 Result.push_back(std::make_pair(I.first, cast<MDNode>(I.second.get())));
1175 // Sort the resulting array so it is stable.
1176 if (Result.size() > 1)
1177 array_pod_sort(Result.begin(), Result.end());
1180 /// clearMetadataHashEntries - Clear all hashtable-based metadata from
1181 /// this instruction.
1182 void Instruction::clearMetadataHashEntries() {
1183 assert(hasMetadataHashEntry() && "Caller should check");
1184 getContext().pImpl->MetadataStore.erase(this);
1185 setHasMetadataHashEntry(false);