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<MDNode>(MD) && cast<MDNode>(MD)->isTemporary()) &&
159 "Expected non-temp node");
164 // Copy out uses since UseMap will get touched below.
165 typedef std::pair<void *, std::pair<OwnerTy, uint64_t>> UseTy;
166 SmallVector<UseTy, 8> Uses(UseMap.begin(), UseMap.end());
167 std::sort(Uses.begin(), Uses.end(), [](const UseTy &L, const UseTy &R) {
168 return L.second.second < R.second.second;
170 for (const auto &Pair : Uses) {
171 // Check that this Ref hasn't disappeared after RAUW (when updating a
173 if (!UseMap.count(Pair.first))
176 OwnerTy Owner = Pair.second.first;
178 // Update unowned tracking references directly.
179 Metadata *&Ref = *static_cast<Metadata **>(Pair.first);
182 MetadataTracking::track(Ref);
183 UseMap.erase(Pair.first);
187 // Check for MetadataAsValue.
188 if (Owner.is<MetadataAsValue *>()) {
189 Owner.get<MetadataAsValue *>()->handleChangedMetadata(MD);
193 // There's a Metadata owner -- dispatch.
194 Metadata *OwnerMD = Owner.get<Metadata *>();
195 switch (OwnerMD->getMetadataID()) {
196 #define HANDLE_METADATA_LEAF(CLASS) \
197 case Metadata::CLASS##Kind: \
198 cast<CLASS>(OwnerMD)->handleChangedOperand(Pair.first, MD); \
200 #include "llvm/IR/Metadata.def"
202 llvm_unreachable("Invalid metadata subclass");
205 assert(UseMap.empty() && "Expected all uses to be replaced");
208 void ReplaceableMetadataImpl::resolveAllUses(bool ResolveUsers) {
217 // Copy out uses since UseMap could get touched below.
218 typedef std::pair<void *, std::pair<OwnerTy, uint64_t>> UseTy;
219 SmallVector<UseTy, 8> Uses(UseMap.begin(), UseMap.end());
220 std::sort(Uses.begin(), Uses.end(), [](const UseTy &L, const UseTy &R) {
221 return L.second.second < R.second.second;
224 for (const auto &Pair : Uses) {
225 auto Owner = Pair.second.first;
228 if (Owner.is<MetadataAsValue *>())
231 // Resolve MDNodes that point at this.
232 auto *OwnerMD = dyn_cast<MDNode>(Owner.get<Metadata *>());
235 if (OwnerMD->isResolved())
237 OwnerMD->decrementUnresolvedOperandCount();
241 static Function *getLocalFunction(Value *V) {
242 assert(V && "Expected value");
243 if (auto *A = dyn_cast<Argument>(V))
244 return A->getParent();
245 if (BasicBlock *BB = cast<Instruction>(V)->getParent())
246 return BB->getParent();
250 ValueAsMetadata *ValueAsMetadata::get(Value *V) {
251 assert(V && "Unexpected null Value");
253 auto &Context = V->getContext();
254 auto *&Entry = Context.pImpl->ValuesAsMetadata[V];
256 assert((isa<Constant>(V) || isa<Argument>(V) || isa<Instruction>(V)) &&
257 "Expected constant or function-local value");
258 assert(!V->NameAndIsUsedByMD.getInt() &&
259 "Expected this to be the only metadata use");
260 V->NameAndIsUsedByMD.setInt(true);
261 if (auto *C = dyn_cast<Constant>(V))
262 Entry = new ConstantAsMetadata(C);
264 Entry = new LocalAsMetadata(V);
270 ValueAsMetadata *ValueAsMetadata::getIfExists(Value *V) {
271 assert(V && "Unexpected null Value");
272 return V->getContext().pImpl->ValuesAsMetadata.lookup(V);
275 void ValueAsMetadata::handleDeletion(Value *V) {
276 assert(V && "Expected valid value");
278 auto &Store = V->getType()->getContext().pImpl->ValuesAsMetadata;
279 auto I = Store.find(V);
280 if (I == Store.end())
283 // Remove old entry from the map.
284 ValueAsMetadata *MD = I->second;
285 assert(MD && "Expected valid metadata");
286 assert(MD->getValue() == V && "Expected valid mapping");
289 // Delete the metadata.
290 MD->replaceAllUsesWith(nullptr);
294 void ValueAsMetadata::handleRAUW(Value *From, Value *To) {
295 assert(From && "Expected valid value");
296 assert(To && "Expected valid value");
297 assert(From != To && "Expected changed value");
298 assert(From->getType() == To->getType() && "Unexpected type change");
300 LLVMContext &Context = From->getType()->getContext();
301 auto &Store = Context.pImpl->ValuesAsMetadata;
302 auto I = Store.find(From);
303 if (I == Store.end()) {
304 assert(!From->NameAndIsUsedByMD.getInt() &&
305 "Expected From not to be used by metadata");
309 // Remove old entry from the map.
310 assert(From->NameAndIsUsedByMD.getInt() &&
311 "Expected From to be used by metadata");
312 From->NameAndIsUsedByMD.setInt(false);
313 ValueAsMetadata *MD = I->second;
314 assert(MD && "Expected valid metadata");
315 assert(MD->getValue() == From && "Expected valid mapping");
318 if (isa<LocalAsMetadata>(MD)) {
319 if (auto *C = dyn_cast<Constant>(To)) {
320 // Local became a constant.
321 MD->replaceAllUsesWith(ConstantAsMetadata::get(C));
325 if (getLocalFunction(From) && getLocalFunction(To) &&
326 getLocalFunction(From) != getLocalFunction(To)) {
328 MD->replaceAllUsesWith(nullptr);
332 } else if (!isa<Constant>(To)) {
333 // Changed to function-local value.
334 MD->replaceAllUsesWith(nullptr);
339 auto *&Entry = Store[To];
341 // The target already exists.
342 MD->replaceAllUsesWith(Entry);
347 // Update MD in place (and update the map entry).
348 assert(!To->NameAndIsUsedByMD.getInt() &&
349 "Expected this to be the only metadata use");
350 To->NameAndIsUsedByMD.setInt(true);
355 //===----------------------------------------------------------------------===//
356 // MDString implementation.
359 MDString *MDString::get(LLVMContext &Context, StringRef Str) {
360 auto &Store = Context.pImpl->MDStringCache;
361 auto I = Store.find(Str);
362 if (I != Store.end())
366 StringMapEntry<MDString>::Create(Str, Store.getAllocator(), MDString());
367 bool WasInserted = Store.insert(Entry);
369 assert(WasInserted && "Expected entry to be inserted");
370 Entry->second.Entry = Entry;
371 return &Entry->second;
374 StringRef MDString::getString() const {
375 assert(Entry && "Expected to find string map entry");
376 return Entry->first();
379 //===----------------------------------------------------------------------===//
380 // MDNode implementation.
383 void *MDNode::operator new(size_t Size, unsigned NumOps) {
384 void *Ptr = ::operator new(Size + NumOps * sizeof(MDOperand));
385 MDOperand *O = static_cast<MDOperand *>(Ptr);
386 for (MDOperand *E = O + NumOps; O != E; ++O)
387 (void)new (O) MDOperand;
391 void MDNode::operator delete(void *Mem) {
392 MDNode *N = static_cast<MDNode *>(Mem);
393 MDOperand *O = static_cast<MDOperand *>(Mem);
394 for (MDOperand *E = O - N->NumOperands; O != E; --O)
395 (O - 1)->~MDOperand();
396 ::operator delete(O);
399 MDNode::MDNode(LLVMContext &Context, unsigned ID, StorageType Storage,
400 ArrayRef<Metadata *> Ops1, ArrayRef<Metadata *> Ops2)
401 : Metadata(ID, Storage), NumOperands(Ops1.size() + Ops2.size()),
402 NumUnresolved(0), Context(Context) {
404 for (Metadata *MD : Ops1)
405 setOperand(Op++, MD);
406 for (Metadata *MD : Ops2)
407 setOperand(Op++, MD);
413 // Check whether any operands are unresolved, requiring re-uniquing. If
414 // not, don't support RAUW.
415 if (!countUnresolvedOperands())
418 this->Context.makeReplaceable(make_unique<ReplaceableMetadataImpl>(Context));
421 TempMDNode MDNode::clone() const {
422 switch (getMetadataID()) {
424 llvm_unreachable("Invalid MDNode subclass");
425 #define HANDLE_MDNODE_LEAF(CLASS) \
427 return cast<CLASS>(this)->cloneImpl();
428 #include "llvm/IR/Metadata.def"
432 static bool isOperandUnresolved(Metadata *Op) {
433 if (auto *N = dyn_cast_or_null<MDNode>(Op))
434 return !N->isResolved();
438 unsigned MDNode::countUnresolvedOperands() {
439 assert(NumUnresolved == 0 && "Expected unresolved ops to be uncounted");
440 for (const auto &Op : operands())
441 NumUnresolved += unsigned(isOperandUnresolved(Op));
442 return NumUnresolved;
445 void MDNode::makeUniqued() {
446 assert(isTemporary() && "Expected this to be temporary");
447 assert(!isResolved() && "Expected this to be unresolved");
449 // Make this 'uniqued'.
451 if (!countUnresolvedOperands())
454 assert(isUniqued() && "Expected this to be uniqued");
457 void MDNode::makeDistinct() {
458 assert(isTemporary() && "Expected this to be temporary");
459 assert(!isResolved() && "Expected this to be unresolved");
461 // Pretend to be uniqued, resolve the node, and then store in distinct table.
464 storeDistinctInContext();
466 assert(isDistinct() && "Expected this to be distinct");
467 assert(isResolved() && "Expected this to be resolved");
470 void MDNode::resolve() {
471 assert(isUniqued() && "Expected this to be uniqued");
472 assert(!isResolved() && "Expected this to be unresolved");
474 // Move the map, so that this immediately looks resolved.
475 auto Uses = Context.takeReplaceableUses();
477 assert(isResolved() && "Expected this to be resolved");
479 // Drop RAUW support.
480 Uses->resolveAllUses();
483 void MDNode::resolveAfterOperandChange(Metadata *Old, Metadata *New) {
484 assert(NumUnresolved != 0 && "Expected unresolved operands");
486 // Check if an operand was resolved.
487 if (!isOperandUnresolved(Old)) {
488 if (isOperandUnresolved(New))
489 // An operand was un-resolved!
491 } else if (!isOperandUnresolved(New))
492 decrementUnresolvedOperandCount();
495 void MDNode::decrementUnresolvedOperandCount() {
496 if (!--NumUnresolved)
497 // Last unresolved operand has just been resolved.
501 void MDNode::resolveCycles() {
505 // Resolve this node immediately.
508 // Resolve all operands.
509 for (const auto &Op : operands()) {
510 auto *N = dyn_cast_or_null<MDNode>(Op);
514 assert(!N->isTemporary() &&
515 "Expected all forward declarations to be resolved");
516 if (!N->isResolved())
521 MDNode *MDNode::replaceWithUniquedImpl() {
522 // Try to uniquify in place.
523 MDNode *UniquedNode = uniquify();
524 if (UniquedNode == this) {
529 // Collision, so RAUW instead.
530 replaceAllUsesWith(UniquedNode);
535 MDNode *MDNode::replaceWithDistinctImpl() {
540 void MDTuple::recalculateHash() {
541 setHash(MDTupleInfo::KeyTy::calculateHash(this));
544 void GenericDebugNode::recalculateHash() {
545 setHash(GenericDebugNodeInfo::KeyTy::calculateHash(this));
548 void MDNode::dropAllReferences() {
549 for (unsigned I = 0, E = NumOperands; I != E; ++I)
550 setOperand(I, nullptr);
552 Context.getReplaceableUses()->resolveAllUses(/* ResolveUsers */ false);
553 (void)Context.takeReplaceableUses();
557 void MDNode::handleChangedOperand(void *Ref, Metadata *New) {
558 unsigned Op = static_cast<MDOperand *>(Ref) - op_begin();
559 assert(Op < getNumOperands() && "Expected valid operand");
562 // This node is not uniqued. Just set the operand and be done with it.
567 // This node is uniqued.
570 Metadata *Old = getOperand(Op);
573 // Drop uniquing for self-reference cycles.
577 storeDistinctInContext();
581 // Re-unique the node.
582 auto *Uniqued = uniquify();
583 if (Uniqued == this) {
585 resolveAfterOperandChange(Old, New);
591 // Still unresolved, so RAUW.
593 // First, clear out all operands to prevent any recursion (similar to
594 // dropAllReferences(), but we still need the use-list).
595 for (unsigned O = 0, E = getNumOperands(); O != E; ++O)
596 setOperand(O, nullptr);
597 Context.getReplaceableUses()->replaceAllUsesWith(Uniqued);
602 // Store in non-uniqued form if RAUW isn't possible.
603 storeDistinctInContext();
606 void MDNode::deleteAsSubclass() {
607 switch (getMetadataID()) {
609 llvm_unreachable("Invalid subclass of MDNode");
610 #define HANDLE_MDNODE_LEAF(CLASS) \
612 delete cast<CLASS>(this); \
614 #include "llvm/IR/Metadata.def"
618 template <class T, class InfoT>
619 static T *getUniqued(DenseSet<T *, InfoT> &Store,
620 const typename InfoT::KeyTy &Key) {
621 auto I = Store.find_as(Key);
622 return I == Store.end() ? nullptr : *I;
625 template <class T, class InfoT>
626 static T *uniquifyImpl(T *N, DenseSet<T *, InfoT> &Store) {
627 if (T *U = getUniqued(Store, N))
634 template <class NodeTy> struct MDNode::HasCachedHash {
637 template <class U, U Val> struct SFINAE {};
640 static Yes &check(SFINAE<void (U::*)(unsigned), &U::setHash> *);
641 template <class U> static No &check(...);
643 static const bool value = sizeof(check<NodeTy>(nullptr)) == sizeof(Yes);
646 MDNode *MDNode::uniquify() {
647 // Try to insert into uniquing store.
648 switch (getMetadataID()) {
650 llvm_unreachable("Invalid subclass of MDNode");
651 #define HANDLE_MDNODE_LEAF(CLASS) \
652 case CLASS##Kind: { \
653 CLASS *SubclassThis = cast<CLASS>(this); \
654 std::integral_constant<bool, HasCachedHash<CLASS>::value> \
655 ShouldRecalculateHash; \
656 dispatchRecalculateHash(SubclassThis, ShouldRecalculateHash); \
657 return uniquifyImpl(SubclassThis, getContext().pImpl->CLASS##s); \
659 #include "llvm/IR/Metadata.def"
663 void MDNode::eraseFromStore() {
664 switch (getMetadataID()) {
666 llvm_unreachable("Invalid subclass of MDNode");
667 #define HANDLE_MDNODE_LEAF(CLASS) \
669 getContext().pImpl->CLASS##s.erase(cast<CLASS>(this)); \
671 #include "llvm/IR/Metadata.def"
675 template <class T, class StoreT>
676 T *MDNode::storeImpl(T *N, StorageType Storage, StoreT &Store) {
682 N->storeDistinctInContext();
690 MDTuple *MDTuple::getImpl(LLVMContext &Context, ArrayRef<Metadata *> MDs,
691 StorageType Storage, bool ShouldCreate) {
693 if (Storage == Uniqued) {
694 MDTupleInfo::KeyTy Key(MDs);
695 if (auto *N = getUniqued(Context.pImpl->MDTuples, Key))
699 Hash = Key.getHash();
701 assert(ShouldCreate && "Expected non-uniqued nodes to always be created");
704 return storeImpl(new (MDs.size()) MDTuple(Context, Storage, Hash, MDs),
705 Storage, Context.pImpl->MDTuples);
708 MDLocation::MDLocation(LLVMContext &C, StorageType Storage, unsigned Line,
709 unsigned Column, ArrayRef<Metadata *> MDs)
710 : MDNode(C, MDLocationKind, Storage, MDs) {
711 assert((MDs.size() == 1 || MDs.size() == 2) &&
712 "Expected a scope and optional inlined-at");
714 // Set line and column.
715 assert(Line < (1u << 24) && "Expected 24-bit line");
716 assert(Column < (1u << 16) && "Expected 16-bit column");
718 SubclassData32 = Line;
719 SubclassData16 = Column;
722 static void adjustLine(unsigned &Line) {
723 // Set to unknown on overflow. Still use 24 bits for now.
724 if (Line >= (1u << 24))
728 static void adjustColumn(unsigned &Column) {
729 // Set to unknown on overflow. We only have 16 bits to play with here.
730 if (Column >= (1u << 16))
734 MDLocation *MDLocation::getImpl(LLVMContext &Context, unsigned Line,
735 unsigned Column, Metadata *Scope,
736 Metadata *InlinedAt, StorageType Storage,
738 // Fixup line/column.
740 adjustColumn(Column);
742 if (Storage == Uniqued) {
743 if (auto *N = getUniqued(
744 Context.pImpl->MDLocations,
745 MDLocationInfo::KeyTy(Line, Column, Scope, InlinedAt)))
750 assert(ShouldCreate && "Expected non-uniqued nodes to always be created");
753 SmallVector<Metadata *, 2> Ops;
754 Ops.push_back(Scope);
756 Ops.push_back(InlinedAt);
757 return storeImpl(new (Ops.size())
758 MDLocation(Context, Storage, Line, Column, Ops),
759 Storage, Context.pImpl->MDLocations);
762 GenericDebugNode *GenericDebugNode::getImpl(LLVMContext &Context, unsigned Tag,
764 ArrayRef<Metadata *> DwarfOps,
768 if (Storage == Uniqued) {
769 GenericDebugNodeInfo::KeyTy Key(Tag, Header, DwarfOps);
770 if (auto *N = getUniqued(Context.pImpl->GenericDebugNodes, Key))
774 Hash = Key.getHash();
776 assert(ShouldCreate && "Expected non-uniqued nodes to always be created");
779 // Use a nullptr for empty headers.
780 Metadata *PreOps[] = {Header.empty() ? nullptr
781 : MDString::get(Context, Header)};
782 return storeImpl(new (DwarfOps.size() + 1) GenericDebugNode(
783 Context, Storage, Hash, Tag, PreOps, DwarfOps),
784 Storage, Context.pImpl->GenericDebugNodes);
787 void MDNode::deleteTemporary(MDNode *N) {
788 assert(N->isTemporary() && "Expected temporary node");
789 N->replaceAllUsesWith(nullptr);
790 N->deleteAsSubclass();
793 void MDNode::storeDistinctInContext() {
794 assert(isResolved() && "Expected resolved nodes");
798 switch (getMetadataID()) {
800 llvm_unreachable("Invalid subclass of MDNode");
801 #define HANDLE_MDNODE_LEAF(CLASS) \
802 case CLASS##Kind: { \
803 std::integral_constant<bool, HasCachedHash<CLASS>::value> ShouldResetHash; \
804 dispatchResetHash(cast<CLASS>(this), ShouldResetHash); \
807 #include "llvm/IR/Metadata.def"
810 getContext().pImpl->DistinctMDNodes.insert(this);
813 void MDNode::replaceOperandWith(unsigned I, Metadata *New) {
814 if (getOperand(I) == New)
822 handleChangedOperand(mutable_begin() + I, New);
825 void MDNode::setOperand(unsigned I, Metadata *New) {
826 assert(I < NumOperands);
827 mutable_begin()[I].reset(New, isUniqued() ? this : nullptr);
830 /// \brief Get a node, or a self-reference that looks like it.
832 /// Special handling for finding self-references, for use by \a
833 /// MDNode::concatenate() and \a MDNode::intersect() to maintain behaviour from
834 /// when self-referencing nodes were still uniqued. If the first operand has
835 /// the same operands as \c Ops, return the first operand instead.
836 static MDNode *getOrSelfReference(LLVMContext &Context,
837 ArrayRef<Metadata *> Ops) {
839 if (MDNode *N = dyn_cast_or_null<MDNode>(Ops[0]))
840 if (N->getNumOperands() == Ops.size() && N == N->getOperand(0)) {
841 for (unsigned I = 1, E = Ops.size(); I != E; ++I)
842 if (Ops[I] != N->getOperand(I))
843 return MDNode::get(Context, Ops);
847 return MDNode::get(Context, Ops);
850 MDNode *MDNode::concatenate(MDNode *A, MDNode *B) {
856 SmallVector<Metadata *, 4> MDs(A->getNumOperands() + B->getNumOperands());
859 for (unsigned i = 0, ie = A->getNumOperands(); i != ie; ++i)
860 MDs[j++] = A->getOperand(i);
861 for (unsigned i = 0, ie = B->getNumOperands(); i != ie; ++i)
862 MDs[j++] = B->getOperand(i);
864 // FIXME: This preserves long-standing behaviour, but is it really the right
865 // behaviour? Or was that an unintended side-effect of node uniquing?
866 return getOrSelfReference(A->getContext(), MDs);
869 MDNode *MDNode::intersect(MDNode *A, MDNode *B) {
873 SmallVector<Metadata *, 4> MDs;
874 for (unsigned i = 0, ie = A->getNumOperands(); i != ie; ++i) {
875 Metadata *MD = A->getOperand(i);
876 for (unsigned j = 0, je = B->getNumOperands(); j != je; ++j)
877 if (MD == B->getOperand(j)) {
883 // FIXME: This preserves long-standing behaviour, but is it really the right
884 // behaviour? Or was that an unintended side-effect of node uniquing?
885 return getOrSelfReference(A->getContext(), MDs);
888 MDNode *MDNode::getMostGenericFPMath(MDNode *A, MDNode *B) {
892 APFloat AVal = mdconst::extract<ConstantFP>(A->getOperand(0))->getValueAPF();
893 APFloat BVal = mdconst::extract<ConstantFP>(B->getOperand(0))->getValueAPF();
894 if (AVal.compare(BVal) == APFloat::cmpLessThan)
899 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
900 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
903 static bool canBeMerged(const ConstantRange &A, const ConstantRange &B) {
904 return !A.intersectWith(B).isEmptySet() || isContiguous(A, B);
907 static bool tryMergeRange(SmallVectorImpl<ConstantInt *> &EndPoints,
908 ConstantInt *Low, ConstantInt *High) {
909 ConstantRange NewRange(Low->getValue(), High->getValue());
910 unsigned Size = EndPoints.size();
911 APInt LB = EndPoints[Size - 2]->getValue();
912 APInt LE = EndPoints[Size - 1]->getValue();
913 ConstantRange LastRange(LB, LE);
914 if (canBeMerged(NewRange, LastRange)) {
915 ConstantRange Union = LastRange.unionWith(NewRange);
916 Type *Ty = High->getType();
917 EndPoints[Size - 2] =
918 cast<ConstantInt>(ConstantInt::get(Ty, Union.getLower()));
919 EndPoints[Size - 1] =
920 cast<ConstantInt>(ConstantInt::get(Ty, Union.getUpper()));
926 static void addRange(SmallVectorImpl<ConstantInt *> &EndPoints,
927 ConstantInt *Low, ConstantInt *High) {
928 if (!EndPoints.empty())
929 if (tryMergeRange(EndPoints, Low, High))
932 EndPoints.push_back(Low);
933 EndPoints.push_back(High);
936 MDNode *MDNode::getMostGenericRange(MDNode *A, MDNode *B) {
937 // Given two ranges, we want to compute the union of the ranges. This
938 // is slightly complitade by having to combine the intervals and merge
939 // the ones that overlap.
947 // First, walk both lists in older of the lower boundary of each interval.
948 // At each step, try to merge the new interval to the last one we adedd.
949 SmallVector<ConstantInt *, 4> EndPoints;
952 int AN = A->getNumOperands() / 2;
953 int BN = B->getNumOperands() / 2;
954 while (AI < AN && BI < BN) {
955 ConstantInt *ALow = mdconst::extract<ConstantInt>(A->getOperand(2 * AI));
956 ConstantInt *BLow = mdconst::extract<ConstantInt>(B->getOperand(2 * BI));
958 if (ALow->getValue().slt(BLow->getValue())) {
959 addRange(EndPoints, ALow,
960 mdconst::extract<ConstantInt>(A->getOperand(2 * AI + 1)));
963 addRange(EndPoints, BLow,
964 mdconst::extract<ConstantInt>(B->getOperand(2 * BI + 1)));
969 addRange(EndPoints, mdconst::extract<ConstantInt>(A->getOperand(2 * AI)),
970 mdconst::extract<ConstantInt>(A->getOperand(2 * AI + 1)));
974 addRange(EndPoints, mdconst::extract<ConstantInt>(B->getOperand(2 * BI)),
975 mdconst::extract<ConstantInt>(B->getOperand(2 * BI + 1)));
979 // If we have more than 2 ranges (4 endpoints) we have to try to merge
980 // the last and first ones.
981 unsigned Size = EndPoints.size();
983 ConstantInt *FB = EndPoints[0];
984 ConstantInt *FE = EndPoints[1];
985 if (tryMergeRange(EndPoints, FB, FE)) {
986 for (unsigned i = 0; i < Size - 2; ++i) {
987 EndPoints[i] = EndPoints[i + 2];
989 EndPoints.resize(Size - 2);
993 // If in the end we have a single range, it is possible that it is now the
994 // full range. Just drop the metadata in that case.
995 if (EndPoints.size() == 2) {
996 ConstantRange Range(EndPoints[0]->getValue(), EndPoints[1]->getValue());
997 if (Range.isFullSet())
1001 SmallVector<Metadata *, 4> MDs;
1002 MDs.reserve(EndPoints.size());
1003 for (auto *I : EndPoints)
1004 MDs.push_back(ConstantAsMetadata::get(I));
1005 return MDNode::get(A->getContext(), MDs);
1008 //===----------------------------------------------------------------------===//
1009 // NamedMDNode implementation.
1012 static SmallVector<TrackingMDRef, 4> &getNMDOps(void *Operands) {
1013 return *(SmallVector<TrackingMDRef, 4> *)Operands;
1016 NamedMDNode::NamedMDNode(const Twine &N)
1017 : Name(N.str()), Parent(nullptr),
1018 Operands(new SmallVector<TrackingMDRef, 4>()) {}
1020 NamedMDNode::~NamedMDNode() {
1021 dropAllReferences();
1022 delete &getNMDOps(Operands);
1025 unsigned NamedMDNode::getNumOperands() const {
1026 return (unsigned)getNMDOps(Operands).size();
1029 MDNode *NamedMDNode::getOperand(unsigned i) const {
1030 assert(i < getNumOperands() && "Invalid Operand number!");
1031 auto *N = getNMDOps(Operands)[i].get();
1032 return cast_or_null<MDNode>(N);
1035 void NamedMDNode::addOperand(MDNode *M) { getNMDOps(Operands).emplace_back(M); }
1037 void NamedMDNode::setOperand(unsigned I, MDNode *New) {
1038 assert(I < getNumOperands() && "Invalid operand number");
1039 getNMDOps(Operands)[I].reset(New);
1042 void NamedMDNode::eraseFromParent() {
1043 getParent()->eraseNamedMetadata(this);
1046 void NamedMDNode::dropAllReferences() {
1047 getNMDOps(Operands).clear();
1050 StringRef NamedMDNode::getName() const {
1051 return StringRef(Name);
1054 //===----------------------------------------------------------------------===//
1055 // Instruction Metadata method implementations.
1058 void Instruction::setMetadata(StringRef Kind, MDNode *Node) {
1059 if (!Node && !hasMetadata())
1061 setMetadata(getContext().getMDKindID(Kind), Node);
1064 MDNode *Instruction::getMetadataImpl(StringRef Kind) const {
1065 return getMetadataImpl(getContext().getMDKindID(Kind));
1068 void Instruction::dropUnknownMetadata(ArrayRef<unsigned> KnownIDs) {
1069 SmallSet<unsigned, 5> KnownSet;
1070 KnownSet.insert(KnownIDs.begin(), KnownIDs.end());
1072 // Drop debug if needed
1073 if (KnownSet.erase(LLVMContext::MD_dbg))
1074 DbgLoc = DebugLoc();
1076 if (!hasMetadataHashEntry())
1077 return; // Nothing to remove!
1079 DenseMap<const Instruction *, LLVMContextImpl::MDMapTy> &MetadataStore =
1080 getContext().pImpl->MetadataStore;
1082 if (KnownSet.empty()) {
1083 // Just drop our entry at the store.
1084 MetadataStore.erase(this);
1085 setHasMetadataHashEntry(false);
1089 LLVMContextImpl::MDMapTy &Info = MetadataStore[this];
1092 // Walk the array and drop any metadata we don't know.
1093 for (I = 0, E = Info.size(); I != E;) {
1094 if (KnownSet.count(Info[I].first)) {
1099 Info[I] = std::move(Info.back());
1103 assert(E == Info.size());
1106 // Drop our entry at the store.
1107 MetadataStore.erase(this);
1108 setHasMetadataHashEntry(false);
1112 /// setMetadata - Set the metadata of of the specified kind to the specified
1113 /// node. This updates/replaces metadata if already present, or removes it if
1115 void Instruction::setMetadata(unsigned KindID, MDNode *Node) {
1116 if (!Node && !hasMetadata())
1119 // Handle 'dbg' as a special case since it is not stored in the hash table.
1120 if (KindID == LLVMContext::MD_dbg) {
1121 DbgLoc = DebugLoc::getFromDILocation(Node);
1125 // Handle the case when we're adding/updating metadata on an instruction.
1127 LLVMContextImpl::MDMapTy &Info = getContext().pImpl->MetadataStore[this];
1128 assert(!Info.empty() == hasMetadataHashEntry() &&
1129 "HasMetadata bit is wonked");
1131 setHasMetadataHashEntry(true);
1133 // Handle replacement of an existing value.
1134 for (auto &P : Info)
1135 if (P.first == KindID) {
1136 P.second.reset(Node);
1141 // No replacement, just add it to the list.
1142 Info.emplace_back(std::piecewise_construct, std::make_tuple(KindID),
1143 std::make_tuple(Node));
1147 // Otherwise, we're removing metadata from an instruction.
1148 assert((hasMetadataHashEntry() ==
1149 (getContext().pImpl->MetadataStore.count(this) > 0)) &&
1150 "HasMetadata bit out of date!");
1151 if (!hasMetadataHashEntry())
1152 return; // Nothing to remove!
1153 LLVMContextImpl::MDMapTy &Info = getContext().pImpl->MetadataStore[this];
1155 // Common case is removing the only entry.
1156 if (Info.size() == 1 && Info[0].first == KindID) {
1157 getContext().pImpl->MetadataStore.erase(this);
1158 setHasMetadataHashEntry(false);
1162 // Handle removal of an existing value.
1163 for (unsigned i = 0, e = Info.size(); i != e; ++i)
1164 if (Info[i].first == KindID) {
1165 Info[i] = std::move(Info.back());
1167 assert(!Info.empty() && "Removing last entry should be handled above");
1170 // Otherwise, removing an entry that doesn't exist on the instruction.
1173 void Instruction::setAAMetadata(const AAMDNodes &N) {
1174 setMetadata(LLVMContext::MD_tbaa, N.TBAA);
1175 setMetadata(LLVMContext::MD_alias_scope, N.Scope);
1176 setMetadata(LLVMContext::MD_noalias, N.NoAlias);
1179 MDNode *Instruction::getMetadataImpl(unsigned KindID) const {
1180 // Handle 'dbg' as a special case since it is not stored in the hash table.
1181 if (KindID == LLVMContext::MD_dbg)
1182 return DbgLoc.getAsMDNode();
1184 if (!hasMetadataHashEntry()) return nullptr;
1186 LLVMContextImpl::MDMapTy &Info = getContext().pImpl->MetadataStore[this];
1187 assert(!Info.empty() && "bit out of sync with hash table");
1189 for (const auto &I : Info)
1190 if (I.first == KindID)
1195 void Instruction::getAllMetadataImpl(
1196 SmallVectorImpl<std::pair<unsigned, MDNode *>> &Result) const {
1199 // Handle 'dbg' as a special case since it is not stored in the hash table.
1200 if (!DbgLoc.isUnknown()) {
1202 std::make_pair((unsigned)LLVMContext::MD_dbg, DbgLoc.getAsMDNode()));
1203 if (!hasMetadataHashEntry()) return;
1206 assert(hasMetadataHashEntry() &&
1207 getContext().pImpl->MetadataStore.count(this) &&
1208 "Shouldn't have called this");
1209 const LLVMContextImpl::MDMapTy &Info =
1210 getContext().pImpl->MetadataStore.find(this)->second;
1211 assert(!Info.empty() && "Shouldn't have called this");
1213 Result.reserve(Result.size() + Info.size());
1214 for (auto &I : Info)
1215 Result.push_back(std::make_pair(I.first, cast<MDNode>(I.second.get())));
1217 // Sort the resulting array so it is stable.
1218 if (Result.size() > 1)
1219 array_pod_sort(Result.begin(), Result.end());
1222 void Instruction::getAllMetadataOtherThanDebugLocImpl(
1223 SmallVectorImpl<std::pair<unsigned, MDNode *>> &Result) const {
1225 assert(hasMetadataHashEntry() &&
1226 getContext().pImpl->MetadataStore.count(this) &&
1227 "Shouldn't have called this");
1228 const LLVMContextImpl::MDMapTy &Info =
1229 getContext().pImpl->MetadataStore.find(this)->second;
1230 assert(!Info.empty() && "Shouldn't have called this");
1231 Result.reserve(Result.size() + Info.size());
1232 for (auto &I : Info)
1233 Result.push_back(std::make_pair(I.first, cast<MDNode>(I.second.get())));
1235 // Sort the resulting array so it is stable.
1236 if (Result.size() > 1)
1237 array_pod_sort(Result.begin(), Result.end());
1240 /// clearMetadataHashEntries - Clear all hashtable-based metadata from
1241 /// this instruction.
1242 void Instruction::clearMetadataHashEntries() {
1243 assert(hasMetadataHashEntry() && "Caller should check");
1244 getContext().pImpl->MetadataStore.erase(this);
1245 setHasMetadataHashEntry(false);