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 OwnerTy Owner = Pair.second.first;
172 // Update unowned tracking references directly.
173 Metadata *&Ref = *static_cast<Metadata **>(Pair.first);
176 MetadataTracking::track(Ref);
177 UseMap.erase(Pair.first);
181 // Check for MetadataAsValue.
182 if (Owner.is<MetadataAsValue *>()) {
183 Owner.get<MetadataAsValue *>()->handleChangedMetadata(MD);
187 // There's a Metadata owner -- dispatch.
188 Metadata *OwnerMD = Owner.get<Metadata *>();
189 switch (OwnerMD->getMetadataID()) {
190 #define HANDLE_METADATA_LEAF(CLASS) \
191 case Metadata::CLASS##Kind: \
192 cast<CLASS>(OwnerMD)->handleChangedOperand(Pair.first, MD); \
194 #include "llvm/IR/Metadata.def"
196 llvm_unreachable("Invalid metadata subclass");
199 assert(UseMap.empty() && "Expected all uses to be replaced");
202 void ReplaceableMetadataImpl::resolveAllUses(bool ResolveUsers) {
211 // Copy out uses since UseMap could get touched below.
212 typedef std::pair<void *, std::pair<OwnerTy, uint64_t>> UseTy;
213 SmallVector<UseTy, 8> Uses(UseMap.begin(), UseMap.end());
214 std::sort(Uses.begin(), Uses.end(), [](const UseTy &L, const UseTy &R) {
215 return L.second.second < R.second.second;
218 for (const auto &Pair : Uses) {
219 auto Owner = Pair.second.first;
222 if (Owner.is<MetadataAsValue *>())
225 // Resolve GenericMDNodes that point at this.
226 auto *OwnerMD = dyn_cast<GenericMDNode>(Owner.get<Metadata *>());
229 if (OwnerMD->isResolved())
231 OwnerMD->decrementUnresolvedOperandCount();
235 static Function *getLocalFunction(Value *V) {
236 assert(V && "Expected value");
237 if (auto *A = dyn_cast<Argument>(V))
238 return A->getParent();
239 if (BasicBlock *BB = cast<Instruction>(V)->getParent())
240 return BB->getParent();
244 ValueAsMetadata *ValueAsMetadata::get(Value *V) {
245 assert(V && "Unexpected null Value");
247 auto &Context = V->getContext();
248 auto *&Entry = Context.pImpl->ValuesAsMetadata[V];
250 assert((isa<Constant>(V) || isa<Argument>(V) || isa<Instruction>(V)) &&
251 "Expected constant or function-local value");
252 assert(!V->NameAndIsUsedByMD.getInt() &&
253 "Expected this to be the only metadata use");
254 V->NameAndIsUsedByMD.setInt(true);
255 if (auto *C = dyn_cast<Constant>(V))
256 Entry = new ConstantAsMetadata(C);
258 Entry = new LocalAsMetadata(V);
264 ValueAsMetadata *ValueAsMetadata::getIfExists(Value *V) {
265 assert(V && "Unexpected null Value");
266 return V->getContext().pImpl->ValuesAsMetadata.lookup(V);
269 void ValueAsMetadata::handleDeletion(Value *V) {
270 assert(V && "Expected valid value");
272 auto &Store = V->getType()->getContext().pImpl->ValuesAsMetadata;
273 auto I = Store.find(V);
274 if (I == Store.end())
277 // Remove old entry from the map.
278 ValueAsMetadata *MD = I->second;
279 assert(MD && "Expected valid metadata");
280 assert(MD->getValue() == V && "Expected valid mapping");
283 // Delete the metadata.
284 MD->replaceAllUsesWith(nullptr);
288 void ValueAsMetadata::handleRAUW(Value *From, Value *To) {
289 assert(From && "Expected valid value");
290 assert(To && "Expected valid value");
291 assert(From != To && "Expected changed value");
292 assert(From->getType() == To->getType() && "Unexpected type change");
294 LLVMContext &Context = From->getType()->getContext();
295 auto &Store = Context.pImpl->ValuesAsMetadata;
296 auto I = Store.find(From);
297 if (I == Store.end()) {
298 assert(!From->NameAndIsUsedByMD.getInt() &&
299 "Expected From not to be used by metadata");
303 // Remove old entry from the map.
304 assert(From->NameAndIsUsedByMD.getInt() &&
305 "Expected From to be used by metadata");
306 From->NameAndIsUsedByMD.setInt(false);
307 ValueAsMetadata *MD = I->second;
308 assert(MD && "Expected valid metadata");
309 assert(MD->getValue() == From && "Expected valid mapping");
312 if (isa<LocalAsMetadata>(MD)) {
313 if (auto *C = dyn_cast<Constant>(To)) {
314 // Local became a constant.
315 MD->replaceAllUsesWith(ConstantAsMetadata::get(C));
319 if (getLocalFunction(From) && getLocalFunction(To) &&
320 getLocalFunction(From) != getLocalFunction(To)) {
322 MD->replaceAllUsesWith(nullptr);
326 } else if (!isa<Constant>(To)) {
327 // Changed to function-local value.
328 MD->replaceAllUsesWith(nullptr);
333 auto *&Entry = Store[To];
335 // The target already exists.
336 MD->replaceAllUsesWith(Entry);
341 // Update MD in place (and update the map entry).
342 assert(!To->NameAndIsUsedByMD.getInt() &&
343 "Expected this to be the only metadata use");
344 To->NameAndIsUsedByMD.setInt(true);
349 //===----------------------------------------------------------------------===//
350 // MDString implementation.
353 MDString *MDString::get(LLVMContext &Context, StringRef Str) {
354 auto &Store = Context.pImpl->MDStringCache;
355 auto I = Store.find(Str);
356 if (I != Store.end())
360 StringMapEntry<MDString>::Create(Str, Store.getAllocator(), MDString());
361 bool WasInserted = Store.insert(Entry);
363 assert(WasInserted && "Expected entry to be inserted");
364 Entry->second.Entry = Entry;
365 return &Entry->second;
368 StringRef MDString::getString() const {
369 assert(Entry && "Expected to find string map entry");
370 return Entry->first();
373 //===----------------------------------------------------------------------===//
374 // MDNode implementation.
377 void *MDNode::operator new(size_t Size, unsigned NumOps) {
378 void *Ptr = ::operator new(Size + NumOps * sizeof(MDOperand));
379 MDOperand *O = static_cast<MDOperand *>(Ptr);
380 for (MDOperand *E = O + NumOps; O != E; ++O)
381 (void)new (O) MDOperand;
385 void MDNode::operator delete(void *Mem) {
386 MDNode *N = static_cast<MDNode *>(Mem);
387 MDOperand *O = static_cast<MDOperand *>(Mem);
388 for (MDOperand *E = O - N->NumOperands; O != E; --O)
389 (O - 1)->~MDOperand();
390 ::operator delete(O);
393 MDNode::MDNode(LLVMContext &Context, unsigned ID, ArrayRef<Metadata *> MDs)
394 : Metadata(ID), Context(Context), NumOperands(MDs.size()),
395 MDNodeSubclassData(0) {
396 for (unsigned I = 0, E = MDs.size(); I != E; ++I)
397 setOperand(I, MDs[I]);
400 bool MDNode::isResolved() const {
401 if (isa<MDNodeFwdDecl>(this))
403 return cast<GenericMDNode>(this)->isResolved();
406 static bool isOperandUnresolved(Metadata *Op) {
407 if (auto *N = dyn_cast_or_null<MDNode>(Op))
408 return !N->isResolved();
412 GenericMDNode::GenericMDNode(LLVMContext &C, ArrayRef<Metadata *> Vals,
414 : MDNode(C, GenericMDNodeKind, Vals) {
418 // Check whether any operands are unresolved, requiring re-uniquing.
419 unsigned NumUnresolved = 0;
420 for (const auto &Op : operands())
421 NumUnresolved += unsigned(isOperandUnresolved(Op));
426 ReplaceableUses.reset(new ReplaceableMetadataImpl);
427 SubclassData32 = NumUnresolved;
430 GenericMDNode::~GenericMDNode() {
431 LLVMContextImpl *pImpl = getContext().pImpl;
432 if (isStoredDistinctInContext())
433 pImpl->NonUniquedMDNodes.erase(this);
435 pImpl->MDNodeSet.erase(this);
439 void GenericMDNode::resolve() {
440 assert(!isResolved() && "Expected this to be unresolved");
442 // Move the map, so that this immediately looks resolved.
443 auto Uses = std::move(ReplaceableUses);
445 assert(isResolved() && "Expected this to be resolved");
447 // Drop RAUW support.
448 Uses->resolveAllUses();
451 void GenericMDNode::resolveAfterOperandChange(Metadata *Old, Metadata *New) {
452 assert(SubclassData32 != 0 && "Expected unresolved operands");
454 // Check if the last unresolved operand has just been resolved; if so,
455 // resolve this as well.
456 if (isOperandUnresolved(Old)) {
457 if (!isOperandUnresolved(New))
458 decrementUnresolvedOperandCount();
460 // Operands shouldn't become unresolved.
461 assert(isOperandUnresolved(New) && "Operand just became unresolved");
465 void GenericMDNode::decrementUnresolvedOperandCount() {
466 if (!--SubclassData32)
470 void GenericMDNode::resolveCycles() {
474 // Resolve this node immediately.
477 // Resolve all operands.
478 for (const auto &Op : operands()) {
481 assert(!isa<MDNodeFwdDecl>(Op) &&
482 "Expected all forward declarations to be resolved");
483 if (auto *N = dyn_cast<GenericMDNode>(Op))
484 if (!N->isResolved())
489 void GenericMDNode::recalculateHash() {
490 setHash(hash_combine_range(op_begin(), op_end()));
493 SmallVector<Metadata *, 8> MDs(op_begin(), op_end());
494 unsigned RawHash = hash_combine_range(MDs.begin(), MDs.end());
495 assert(getHash() == RawHash &&
496 "Expected hash of MDOperand to equal hash of Metadata*");
501 void MDNode::dropAllReferences() {
502 for (unsigned I = 0, E = NumOperands; I != E; ++I)
503 setOperand(I, nullptr);
504 if (auto *G = dyn_cast<GenericMDNode>(this))
505 if (!G->isResolved()) {
506 G->ReplaceableUses->resolveAllUses(/* ResolveUsers */ false);
507 G->ReplaceableUses.reset();
512 /// \brief Make MDOperand transparent for hashing.
514 /// This overload of an implementation detail of the hashing library makes
515 /// MDOperand hash to the same value as a \a Metadata pointer.
517 /// Note that overloading \a hash_value() as follows:
520 /// size_t hash_value(const MDOperand &X) { return hash_value(X.get()); }
523 /// does not cause MDOperand to be transparent. In particular, a bare pointer
524 /// doesn't get hashed before it's combined, whereas \a MDOperand would.
525 static const Metadata *get_hashable_data(const MDOperand &X) { return X.get(); }
528 void GenericMDNode::handleChangedOperand(void *Ref, Metadata *New) {
529 unsigned Op = static_cast<MDOperand *>(Ref) - op_begin();
530 assert(Op < getNumOperands() && "Expected valid operand");
532 if (isStoredDistinctInContext()) {
533 assert(isResolved() && "Expected distinct node to be resolved");
535 // This node is not uniqued. Just set the operand and be done with it.
540 auto &Store = getContext().pImpl->MDNodeSet;
543 Metadata *Old = getOperand(Op);
546 // Drop uniquing for self-reference cycles.
548 storeDistinctInContext();
554 // Re-unique the node.
556 GenericMDNodeInfo::KeyTy Key(this);
557 auto I = Store.find_as(Key);
558 if (I == Store.end()) {
562 resolveAfterOperandChange(Old, New);
569 // Still unresolved, so RAUW.
571 // First, clear out all operands to prevent any recursion (similar to
572 // dropAllReferences(), but we still need the use-list).
573 for (unsigned O = 0, E = getNumOperands(); O != E; ++O)
574 setOperand(O, nullptr);
575 ReplaceableUses->replaceAllUsesWith(*I);
580 // Store in non-uniqued form if RAUW isn't possible.
581 storeDistinctInContext();
584 MDNode *MDNode::getMDNode(LLVMContext &Context, ArrayRef<Metadata *> MDs,
586 auto &Store = Context.pImpl->MDNodeSet;
588 GenericMDNodeInfo::KeyTy Key(MDs);
589 auto I = Store.find_as(Key);
590 if (I != Store.end())
595 // Coallocate space for the node and Operands together, then placement new.
596 auto *N = new (MDs.size()) GenericMDNode(Context, MDs, /* AllowRAUW */ true);
597 N->setHash(Key.Hash);
602 MDNode *MDNode::getDistinct(LLVMContext &Context, ArrayRef<Metadata *> MDs) {
603 auto *N = new (MDs.size()) GenericMDNode(Context, MDs, /* AllowRAUW */ false);
604 N->storeDistinctInContext();
608 MDNodeFwdDecl *MDNode::getTemporary(LLVMContext &Context,
609 ArrayRef<Metadata *> MDs) {
610 MDNodeFwdDecl *N = new (MDs.size()) MDNodeFwdDecl(Context, MDs);
614 void MDNode::deleteTemporary(MDNode *N) {
615 assert(isa<MDNodeFwdDecl>(N) && "Expected forward declaration");
616 delete cast<MDNodeFwdDecl>(N);
619 void MDNode::storeDistinctInContext() {
620 assert(!IsDistinctInContext && "Expected newly distinct metadata");
621 IsDistinctInContext = true;
622 auto *G = cast<GenericMDNode>(this);
624 getContext().pImpl->NonUniquedMDNodes.insert(G);
627 void MDNode::replaceOperandWith(unsigned I, Metadata *New) {
628 if (getOperand(I) == New)
636 cast<GenericMDNode>(this)->handleChangedOperand(mutable_begin() + I, New);
639 void MDNode::setOperand(unsigned I, Metadata *New) {
640 assert(I < NumOperands);
641 if (isStoredDistinctInContext() || isa<MDNodeFwdDecl>(this))
642 // No need for a callback, this isn't uniqued.
643 mutable_begin()[I].reset(New, nullptr);
645 mutable_begin()[I].reset(New, this);
648 /// \brief Get a node, or a self-reference that looks like it.
650 /// Special handling for finding self-references, for use by \a
651 /// MDNode::concatenate() and \a MDNode::intersect() to maintain behaviour from
652 /// when self-referencing nodes were still uniqued. If the first operand has
653 /// the same operands as \c Ops, return the first operand instead.
654 static MDNode *getOrSelfReference(LLVMContext &Context,
655 ArrayRef<Metadata *> Ops) {
657 if (MDNode *N = dyn_cast_or_null<MDNode>(Ops[0]))
658 if (N->getNumOperands() == Ops.size() && N == N->getOperand(0)) {
659 for (unsigned I = 1, E = Ops.size(); I != E; ++I)
660 if (Ops[I] != N->getOperand(I))
661 return MDNode::get(Context, Ops);
665 return MDNode::get(Context, Ops);
668 MDNode *MDNode::concatenate(MDNode *A, MDNode *B) {
674 SmallVector<Metadata *, 4> MDs(A->getNumOperands() + B->getNumOperands());
677 for (unsigned i = 0, ie = A->getNumOperands(); i != ie; ++i)
678 MDs[j++] = A->getOperand(i);
679 for (unsigned i = 0, ie = B->getNumOperands(); i != ie; ++i)
680 MDs[j++] = B->getOperand(i);
682 // FIXME: This preserves long-standing behaviour, but is it really the right
683 // behaviour? Or was that an unintended side-effect of node uniquing?
684 return getOrSelfReference(A->getContext(), MDs);
687 MDNode *MDNode::intersect(MDNode *A, MDNode *B) {
691 SmallVector<Metadata *, 4> MDs;
692 for (unsigned i = 0, ie = A->getNumOperands(); i != ie; ++i) {
693 Metadata *MD = A->getOperand(i);
694 for (unsigned j = 0, je = B->getNumOperands(); j != je; ++j)
695 if (MD == B->getOperand(j)) {
701 // FIXME: This preserves long-standing behaviour, but is it really the right
702 // behaviour? Or was that an unintended side-effect of node uniquing?
703 return getOrSelfReference(A->getContext(), MDs);
706 MDNode *MDNode::getMostGenericFPMath(MDNode *A, MDNode *B) {
710 APFloat AVal = mdconst::extract<ConstantFP>(A->getOperand(0))->getValueAPF();
711 APFloat BVal = mdconst::extract<ConstantFP>(B->getOperand(0))->getValueAPF();
712 if (AVal.compare(BVal) == APFloat::cmpLessThan)
717 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
718 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
721 static bool canBeMerged(const ConstantRange &A, const ConstantRange &B) {
722 return !A.intersectWith(B).isEmptySet() || isContiguous(A, B);
725 static bool tryMergeRange(SmallVectorImpl<ConstantInt *> &EndPoints,
726 ConstantInt *Low, ConstantInt *High) {
727 ConstantRange NewRange(Low->getValue(), High->getValue());
728 unsigned Size = EndPoints.size();
729 APInt LB = EndPoints[Size - 2]->getValue();
730 APInt LE = EndPoints[Size - 1]->getValue();
731 ConstantRange LastRange(LB, LE);
732 if (canBeMerged(NewRange, LastRange)) {
733 ConstantRange Union = LastRange.unionWith(NewRange);
734 Type *Ty = High->getType();
735 EndPoints[Size - 2] =
736 cast<ConstantInt>(ConstantInt::get(Ty, Union.getLower()));
737 EndPoints[Size - 1] =
738 cast<ConstantInt>(ConstantInt::get(Ty, Union.getUpper()));
744 static void addRange(SmallVectorImpl<ConstantInt *> &EndPoints,
745 ConstantInt *Low, ConstantInt *High) {
746 if (!EndPoints.empty())
747 if (tryMergeRange(EndPoints, Low, High))
750 EndPoints.push_back(Low);
751 EndPoints.push_back(High);
754 MDNode *MDNode::getMostGenericRange(MDNode *A, MDNode *B) {
755 // Given two ranges, we want to compute the union of the ranges. This
756 // is slightly complitade by having to combine the intervals and merge
757 // the ones that overlap.
765 // First, walk both lists in older of the lower boundary of each interval.
766 // At each step, try to merge the new interval to the last one we adedd.
767 SmallVector<ConstantInt *, 4> EndPoints;
770 int AN = A->getNumOperands() / 2;
771 int BN = B->getNumOperands() / 2;
772 while (AI < AN && BI < BN) {
773 ConstantInt *ALow = mdconst::extract<ConstantInt>(A->getOperand(2 * AI));
774 ConstantInt *BLow = mdconst::extract<ConstantInt>(B->getOperand(2 * BI));
776 if (ALow->getValue().slt(BLow->getValue())) {
777 addRange(EndPoints, ALow,
778 mdconst::extract<ConstantInt>(A->getOperand(2 * AI + 1)));
781 addRange(EndPoints, BLow,
782 mdconst::extract<ConstantInt>(B->getOperand(2 * BI + 1)));
787 addRange(EndPoints, mdconst::extract<ConstantInt>(A->getOperand(2 * AI)),
788 mdconst::extract<ConstantInt>(A->getOperand(2 * AI + 1)));
792 addRange(EndPoints, mdconst::extract<ConstantInt>(B->getOperand(2 * BI)),
793 mdconst::extract<ConstantInt>(B->getOperand(2 * BI + 1)));
797 // If we have more than 2 ranges (4 endpoints) we have to try to merge
798 // the last and first ones.
799 unsigned Size = EndPoints.size();
801 ConstantInt *FB = EndPoints[0];
802 ConstantInt *FE = EndPoints[1];
803 if (tryMergeRange(EndPoints, FB, FE)) {
804 for (unsigned i = 0; i < Size - 2; ++i) {
805 EndPoints[i] = EndPoints[i + 2];
807 EndPoints.resize(Size - 2);
811 // If in the end we have a single range, it is possible that it is now the
812 // full range. Just drop the metadata in that case.
813 if (EndPoints.size() == 2) {
814 ConstantRange Range(EndPoints[0]->getValue(), EndPoints[1]->getValue());
815 if (Range.isFullSet())
819 SmallVector<Metadata *, 4> MDs;
820 MDs.reserve(EndPoints.size());
821 for (auto *I : EndPoints)
822 MDs.push_back(ConstantAsMetadata::get(I));
823 return MDNode::get(A->getContext(), MDs);
826 //===----------------------------------------------------------------------===//
827 // NamedMDNode implementation.
830 static SmallVector<TrackingMDRef, 4> &getNMDOps(void *Operands) {
831 return *(SmallVector<TrackingMDRef, 4> *)Operands;
834 NamedMDNode::NamedMDNode(const Twine &N)
835 : Name(N.str()), Parent(nullptr),
836 Operands(new SmallVector<TrackingMDRef, 4>()) {}
838 NamedMDNode::~NamedMDNode() {
840 delete &getNMDOps(Operands);
843 unsigned NamedMDNode::getNumOperands() const {
844 return (unsigned)getNMDOps(Operands).size();
847 MDNode *NamedMDNode::getOperand(unsigned i) const {
848 assert(i < getNumOperands() && "Invalid Operand number!");
849 auto *N = getNMDOps(Operands)[i].get();
850 return cast_or_null<MDNode>(N);
853 void NamedMDNode::addOperand(MDNode *M) { getNMDOps(Operands).emplace_back(M); }
855 void NamedMDNode::setOperand(unsigned I, MDNode *New) {
856 assert(I < getNumOperands() && "Invalid operand number");
857 getNMDOps(Operands)[I].reset(New);
860 void NamedMDNode::eraseFromParent() {
861 getParent()->eraseNamedMetadata(this);
864 void NamedMDNode::dropAllReferences() {
865 getNMDOps(Operands).clear();
868 StringRef NamedMDNode::getName() const {
869 return StringRef(Name);
872 //===----------------------------------------------------------------------===//
873 // Instruction Metadata method implementations.
876 void Instruction::setMetadata(StringRef Kind, MDNode *Node) {
877 if (!Node && !hasMetadata())
879 setMetadata(getContext().getMDKindID(Kind), Node);
882 MDNode *Instruction::getMetadataImpl(StringRef Kind) const {
883 return getMetadataImpl(getContext().getMDKindID(Kind));
886 void Instruction::dropUnknownMetadata(ArrayRef<unsigned> KnownIDs) {
887 SmallSet<unsigned, 5> KnownSet;
888 KnownSet.insert(KnownIDs.begin(), KnownIDs.end());
890 // Drop debug if needed
891 if (KnownSet.erase(LLVMContext::MD_dbg))
894 if (!hasMetadataHashEntry())
895 return; // Nothing to remove!
897 DenseMap<const Instruction *, LLVMContextImpl::MDMapTy> &MetadataStore =
898 getContext().pImpl->MetadataStore;
900 if (KnownSet.empty()) {
901 // Just drop our entry at the store.
902 MetadataStore.erase(this);
903 setHasMetadataHashEntry(false);
907 LLVMContextImpl::MDMapTy &Info = MetadataStore[this];
910 // Walk the array and drop any metadata we don't know.
911 for (I = 0, E = Info.size(); I != E;) {
912 if (KnownSet.count(Info[I].first)) {
917 Info[I] = std::move(Info.back());
921 assert(E == Info.size());
924 // Drop our entry at the store.
925 MetadataStore.erase(this);
926 setHasMetadataHashEntry(false);
930 /// setMetadata - Set the metadata of of the specified kind to the specified
931 /// node. This updates/replaces metadata if already present, or removes it if
933 void Instruction::setMetadata(unsigned KindID, MDNode *Node) {
934 if (!Node && !hasMetadata())
937 // Handle 'dbg' as a special case since it is not stored in the hash table.
938 if (KindID == LLVMContext::MD_dbg) {
939 DbgLoc = DebugLoc::getFromDILocation(Node);
943 // Handle the case when we're adding/updating metadata on an instruction.
945 LLVMContextImpl::MDMapTy &Info = getContext().pImpl->MetadataStore[this];
946 assert(!Info.empty() == hasMetadataHashEntry() &&
947 "HasMetadata bit is wonked");
949 setHasMetadataHashEntry(true);
951 // Handle replacement of an existing value.
953 if (P.first == KindID) {
954 P.second.reset(Node);
959 // No replacement, just add it to the list.
960 Info.emplace_back(std::piecewise_construct, std::make_tuple(KindID),
961 std::make_tuple(Node));
965 // Otherwise, we're removing metadata from an instruction.
966 assert((hasMetadataHashEntry() ==
967 (getContext().pImpl->MetadataStore.count(this) > 0)) &&
968 "HasMetadata bit out of date!");
969 if (!hasMetadataHashEntry())
970 return; // Nothing to remove!
971 LLVMContextImpl::MDMapTy &Info = getContext().pImpl->MetadataStore[this];
973 // Common case is removing the only entry.
974 if (Info.size() == 1 && Info[0].first == KindID) {
975 getContext().pImpl->MetadataStore.erase(this);
976 setHasMetadataHashEntry(false);
980 // Handle removal of an existing value.
981 for (unsigned i = 0, e = Info.size(); i != e; ++i)
982 if (Info[i].first == KindID) {
983 Info[i] = std::move(Info.back());
985 assert(!Info.empty() && "Removing last entry should be handled above");
988 // Otherwise, removing an entry that doesn't exist on the instruction.
991 void Instruction::setAAMetadata(const AAMDNodes &N) {
992 setMetadata(LLVMContext::MD_tbaa, N.TBAA);
993 setMetadata(LLVMContext::MD_alias_scope, N.Scope);
994 setMetadata(LLVMContext::MD_noalias, N.NoAlias);
997 MDNode *Instruction::getMetadataImpl(unsigned KindID) const {
998 // Handle 'dbg' as a special case since it is not stored in the hash table.
999 if (KindID == LLVMContext::MD_dbg)
1000 return DbgLoc.getAsMDNode();
1002 if (!hasMetadataHashEntry()) return nullptr;
1004 LLVMContextImpl::MDMapTy &Info = getContext().pImpl->MetadataStore[this];
1005 assert(!Info.empty() && "bit out of sync with hash table");
1007 for (const auto &I : Info)
1008 if (I.first == KindID)
1013 void Instruction::getAllMetadataImpl(
1014 SmallVectorImpl<std::pair<unsigned, MDNode *>> &Result) const {
1017 // Handle 'dbg' as a special case since it is not stored in the hash table.
1018 if (!DbgLoc.isUnknown()) {
1020 std::make_pair((unsigned)LLVMContext::MD_dbg, DbgLoc.getAsMDNode()));
1021 if (!hasMetadataHashEntry()) return;
1024 assert(hasMetadataHashEntry() &&
1025 getContext().pImpl->MetadataStore.count(this) &&
1026 "Shouldn't have called this");
1027 const LLVMContextImpl::MDMapTy &Info =
1028 getContext().pImpl->MetadataStore.find(this)->second;
1029 assert(!Info.empty() && "Shouldn't have called this");
1031 Result.reserve(Result.size() + Info.size());
1032 for (auto &I : Info)
1033 Result.push_back(std::make_pair(I.first, cast<MDNode>(I.second.get())));
1035 // Sort the resulting array so it is stable.
1036 if (Result.size() > 1)
1037 array_pod_sort(Result.begin(), Result.end());
1040 void Instruction::getAllMetadataOtherThanDebugLocImpl(
1041 SmallVectorImpl<std::pair<unsigned, MDNode *>> &Result) const {
1043 assert(hasMetadataHashEntry() &&
1044 getContext().pImpl->MetadataStore.count(this) &&
1045 "Shouldn't have called this");
1046 const LLVMContextImpl::MDMapTy &Info =
1047 getContext().pImpl->MetadataStore.find(this)->second;
1048 assert(!Info.empty() && "Shouldn't have called this");
1049 Result.reserve(Result.size() + Info.size());
1050 for (auto &I : Info)
1051 Result.push_back(std::make_pair(I.first, cast<MDNode>(I.second.get())));
1053 // Sort the resulting array so it is stable.
1054 if (Result.size() > 1)
1055 array_pod_sort(Result.begin(), Result.end());
1058 /// clearMetadataHashEntries - Clear all hashtable-based metadata from
1059 /// this instruction.
1060 void Instruction::clearMetadataHashEntries() {
1061 assert(hasMetadataHashEntry() && "Caller should check");
1062 getContext().pImpl->MetadataStore.erase(this);
1063 setHasMetadataHashEntry(false);