lib/IR/Metadata.cpp

   1 //===-- Metadata.cpp - Implement Metadata classes -------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the Metadata classes.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  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"
  27
  28 using namespace llvm;
  29
  30 MetadataAsValue::MetadataAsValue(Type *Ty, Metadata *MD)
  31     : Value(Ty, MetadataAsValueVal), MD(MD) {
  32   track();
  33 }
  34
  35 MetadataAsValue::~MetadataAsValue() {
  36   getType()->getContext().pImpl->MetadataAsValues.erase(MD);
  37   untrack();
  38 }
  39
  40 /// \brief Canonicalize metadata arguments to intrinsics.
  41 ///
  42 /// To support bitcode upgrades (and assembly semantic sugar) for \a
  43 /// MetadataAsValue, we need to canonicalize certain metadata.
  44 ///
  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.
  48 ///
  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,
  52                                               Metadata *MD) {
  53   if (!MD)
  54     // !{}
  55     return MDNode::get(Context, None);
  56
  57   // Return early if this isn't a single-operand MDNode.
  58   auto *N = dyn_cast<MDNode>(MD);
  59   if (!N || N->getNumOperands() != 1)
  60     return MD;
  61
  62   if (!N->getOperand(0))
  63     // !{}
  64     return MDNode::get(Context, None);
  65
  66   if (auto *C = dyn_cast<ConstantAsMetadata>(N->getOperand(0)))
  67     // Look through the MDNode.
  68     return C;
  69
  70   return MD;
  71 }
  72
  73 MetadataAsValue *MetadataAsValue::get(LLVMContext &Context, Metadata *MD) {
  74   MD = canonicalizeMetadataForValue(Context, MD);
  75   auto *&Entry = Context.pImpl->MetadataAsValues[MD];
  76   if (!Entry)
  77     Entry = new MetadataAsValue(Type::getMetadataTy(Context), MD);
  78   return Entry;
  79 }
  80
  81 MetadataAsValue *MetadataAsValue::getIfExists(LLVMContext &Context,
  82                                               Metadata *MD) {
  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;
  87 }
  88
  89 void MetadataAsValue::handleChangedMetadata(Metadata *MD) {
  90   LLVMContext &Context = getContext();
  91   MD = canonicalizeMetadataForValue(Context, MD);
  92   auto &Store = Context.pImpl->MetadataAsValues;
  93
  94   // Stop tracking the old metadata.
  95   Store.erase(this->MD);
  96   untrack();
  97   this->MD = nullptr;
  98
  99   // Start tracking MD, or RAUW if necessary.
 100   auto *&Entry = Store[MD];
 101   if (Entry) {
 102     replaceAllUsesWith(Entry);
 103     delete this;
 104     return;
 105   }
 106
 107   this->MD = MD;
 108   track();
 109   Entry = this;
 110 }
 111
 112 void MetadataAsValue::track() {
 113   if (MD)
 114     MetadataTracking::track(&MD, *MD, *this);
 115 }
 116
 117 void MetadataAsValue::untrack() {
 118   if (MD)
 119     MetadataTracking::untrack(MD);
 120 }
 121
 122 void ReplaceableMetadataImpl::addRef(void *Ref, OwnerTy Owner) {
 123   bool WasInserted =
 124       UseMap.insert(std::make_pair(Ref, std::make_pair(Owner, NextIndex)))
 125           .second;
 126   (void)WasInserted;
 127   assert(WasInserted && "Expected to add a reference");
 128
 129   ++NextIndex;
 130   assert(NextIndex != 0 && "Unexpected overflow");
 131 }
 132
 133 void ReplaceableMetadataImpl::dropRef(void *Ref) {
 134   bool WasErased = UseMap.erase(Ref);
 135   (void)WasErased;
 136   assert(WasErased && "Expected to drop a reference");
 137 }
 138
 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;
 144   UseMap.erase(I);
 145   bool WasInserted = UseMap.insert(std::make_pair(New, OwnerAndIndex)).second;
 146   (void)WasInserted;
 147   assert(WasInserted && "Expected to add a reference");
 148
 149   // Check that the references are direct if there's no owner.
 150   (void)MD;
 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");
 155 }
 156
 157 void ReplaceableMetadataImpl::replaceAllUsesWith(Metadata *MD) {
 158   assert(!(MD && isa<MDNode>(MD) && cast<MDNode>(MD)->isTemporary()) &&
 159          "Expected non-temp node");
 160
 161   if (UseMap.empty())
 162     return;
 163
 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;
 169   });
 170   for (const auto &Pair : Uses) {
 171     // Check that this Ref hasn't disappeared after RAUW (when updating a
 172     // previous Ref).
 173     if (!UseMap.count(Pair.first))
 174       continue;
 175
 176     OwnerTy Owner = Pair.second.first;
 177     if (!Owner) {
 178       // Update unowned tracking references directly.
 179       Metadata *&Ref = *static_cast<Metadata **>(Pair.first);
 180       Ref = MD;
 181       if (MD)
 182         MetadataTracking::track(Ref);
 183       UseMap.erase(Pair.first);
 184       continue;
 185     }
 186
 187     // Check for MetadataAsValue.
 188     if (Owner.is<MetadataAsValue *>()) {
 189       Owner.get<MetadataAsValue *>()->handleChangedMetadata(MD);
 190       continue;
 191     }
 192
 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);                \
 199     continue;
 200 #include "llvm/IR/Metadata.def"
 201     default:
 202       llvm_unreachable("Invalid metadata subclass");
 203     }
 204   }
 205   assert(UseMap.empty() && "Expected all uses to be replaced");
 206 }
 207
 208 void ReplaceableMetadataImpl::resolveAllUses(bool ResolveUsers) {
 209   if (UseMap.empty())
 210     return;
 211
 212   if (!ResolveUsers) {
 213     UseMap.clear();
 214     return;
 215   }
 216
 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;
 222   });
 223   UseMap.clear();
 224   for (const auto &Pair : Uses) {
 225     auto Owner = Pair.second.first;
 226     if (!Owner)
 227       continue;
 228     if (Owner.is<MetadataAsValue *>())
 229       continue;
 230
 231     // Resolve MDNodes that point at this.
 232     auto *OwnerMD = dyn_cast<MDNode>(Owner.get<Metadata *>());
 233     if (!OwnerMD)
 234       continue;
 235     if (OwnerMD->isResolved())
 236       continue;
 237     OwnerMD->decrementUnresolvedOperandCount();
 238   }
 239 }
 240
 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();
 247   return nullptr;
 248 }
 249
 250 ValueAsMetadata *ValueAsMetadata::get(Value *V) {
 251   assert(V && "Unexpected null Value");
 252
 253   auto &Context = V->getContext();
 254   auto *&Entry = Context.pImpl->ValuesAsMetadata[V];
 255   if (!Entry) {
 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);
 263     else
 264       Entry = new LocalAsMetadata(V);
 265   }
 266
 267   return Entry;
 268 }
 269
 270 ValueAsMetadata *ValueAsMetadata::getIfExists(Value *V) {
 271   assert(V && "Unexpected null Value");
 272   return V->getContext().pImpl->ValuesAsMetadata.lookup(V);
 273 }
 274
 275 void ValueAsMetadata::handleDeletion(Value *V) {
 276   assert(V && "Expected valid value");
 277
 278   auto &Store = V->getType()->getContext().pImpl->ValuesAsMetadata;
 279   auto I = Store.find(V);
 280   if (I == Store.end())
 281     return;
 282
 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");
 287   Store.erase(I);
 288
 289   // Delete the metadata.
 290   MD->replaceAllUsesWith(nullptr);
 291   delete MD;
 292 }
 293
 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");
 299
 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");
 306     return;
 307   }
 308
 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");
 316   Store.erase(I);
 317
 318   if (isa<LocalAsMetadata>(MD)) {
 319     if (auto *C = dyn_cast<Constant>(To)) {
 320       // Local became a constant.
 321       MD->replaceAllUsesWith(ConstantAsMetadata::get(C));
 322       delete MD;
 323       return;
 324     }
 325     if (getLocalFunction(From) && getLocalFunction(To) &&
 326         getLocalFunction(From) != getLocalFunction(To)) {
 327       // Function changed.
 328       MD->replaceAllUsesWith(nullptr);
 329       delete MD;
 330       return;
 331     }
 332   } else if (!isa<Constant>(To)) {
 333     // Changed to function-local value.
 334     MD->replaceAllUsesWith(nullptr);
 335     delete MD;
 336     return;
 337   }
 338
 339   auto *&Entry = Store[To];
 340   if (Entry) {
 341     // The target already exists.
 342     MD->replaceAllUsesWith(Entry);
 343     delete MD;
 344     return;
 345   }
 346
 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);
 351   MD->V = To;
 352   Entry = MD;
 353 }
 354
 355 //===----------------------------------------------------------------------===//
 356 // MDString implementation.
 357 //
 358
 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())
 363     return &I->second;
 364
 365   auto *Entry =
 366       StringMapEntry<MDString>::Create(Str, Store.getAllocator(), MDString());
 367   bool WasInserted = Store.insert(Entry);
 368   (void)WasInserted;
 369   assert(WasInserted && "Expected entry to be inserted");
 370   Entry->second.Entry = Entry;
 371   return &Entry->second;
 372 }
 373
 374 StringRef MDString::getString() const {
 375   assert(Entry && "Expected to find string map entry");
 376   return Entry->first();
 377 }
 378
 379 //===----------------------------------------------------------------------===//
 380 // MDNode implementation.
 381 //
 382
 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;
 388   return O;
 389 }
 390
 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);
 397 }
 398
 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) {
 403   unsigned Op = 0;
 404   for (Metadata *MD : Ops1)
 405     setOperand(Op++, MD);
 406   for (Metadata *MD : Ops2)
 407     setOperand(Op++, MD);
 408
 409   if (isDistinct())
 410     return;
 411
 412   if (isUniqued())
 413     // Check whether any operands are unresolved, requiring re-uniquing.  If
 414     // not, don't support RAUW.
 415     if (!countUnresolvedOperands())
 416       return;
 417
 418   this->Context.makeReplaceable(make_unique<ReplaceableMetadataImpl>(Context));
 419 }
 420
 421 TempMDNode MDNode::clone() const {
 422   switch (getMetadataID()) {
 423   default:
 424     llvm_unreachable("Invalid MDNode subclass");
 425 #define HANDLE_MDNODE_LEAF(CLASS)                                              \
 426   case CLASS##Kind:                                                            \
 427     return cast<CLASS>(this)->cloneImpl();
 428 #include "llvm/IR/Metadata.def"
 429   }
 430 }
 431
 432 static bool isOperandUnresolved(Metadata *Op) {
 433   if (auto *N = dyn_cast_or_null<MDNode>(Op))
 434     return !N->isResolved();
 435   return false;
 436 }
 437
 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;
 443 }
 444
 445 void MDNode::makeUniqued() {
 446   assert(isTemporary() && "Expected this to be temporary");
 447   assert(!isResolved() && "Expected this to be unresolved");
 448
 449   // Make this 'uniqued'.
 450   Storage = Uniqued;
 451   if (!countUnresolvedOperands())
 452     resolve();
 453
 454   assert(isUniqued() && "Expected this to be uniqued");
 455 }
 456
 457 void MDNode::makeDistinct() {
 458   assert(isTemporary() && "Expected this to be temporary");
 459   assert(!isResolved() && "Expected this to be unresolved");
 460
 461   // Pretend to be uniqued, resolve the node, and then store in distinct table.
 462   Storage = Uniqued;
 463   resolve();
 464   storeDistinctInContext();
 465
 466   assert(isDistinct() && "Expected this to be distinct");
 467   assert(isResolved() && "Expected this to be resolved");
 468 }
 469
 470 void MDNode::resolve() {
 471   assert(isUniqued() && "Expected this to be uniqued");
 472   assert(!isResolved() && "Expected this to be unresolved");
 473
 474   // Move the map, so that this immediately looks resolved.
 475   auto Uses = Context.takeReplaceableUses();
 476   NumUnresolved = 0;
 477   assert(isResolved() && "Expected this to be resolved");
 478
 479   // Drop RAUW support.
 480   Uses->resolveAllUses();
 481 }
 482
 483 void MDNode::resolveAfterOperandChange(Metadata *Old, Metadata *New) {
 484   assert(NumUnresolved != 0 && "Expected unresolved operands");
 485
 486   // Check if an operand was resolved.
 487   if (!isOperandUnresolved(Old)) {
 488     if (isOperandUnresolved(New))
 489       // An operand was un-resolved!
 490       ++NumUnresolved;
 491   } else if (!isOperandUnresolved(New))
 492     decrementUnresolvedOperandCount();
 493 }
 494
 495 void MDNode::decrementUnresolvedOperandCount() {
 496   if (!--NumUnresolved)
 497     // Last unresolved operand has just been resolved.
 498     resolve();
 499 }
 500
 501 void MDNode::resolveCycles() {
 502   if (isResolved())
 503     return;
 504
 505   // Resolve this node immediately.
 506   resolve();
 507
 508   // Resolve all operands.
 509   for (const auto &Op : operands()) {
 510     auto *N = dyn_cast_or_null<MDNode>(Op);
 511     if (!N)
 512       continue;
 513
 514     assert(!N->isTemporary() &&
 515            "Expected all forward declarations to be resolved");
 516     if (!N->isResolved())
 517       N->resolveCycles();
 518   }
 519 }
 520
 521 MDNode *MDNode::replaceWithUniquedImpl() {
 522   // Try to uniquify in place.
 523   MDNode *UniquedNode = uniquify();
 524   if (UniquedNode == this) {
 525     makeUniqued();
 526     return this;
 527   }
 528
 529   // Collision, so RAUW instead.
 530   replaceAllUsesWith(UniquedNode);
 531   deleteAsSubclass();
 532   return UniquedNode;
 533 }
 534
 535 MDNode *MDNode::replaceWithDistinctImpl() {
 536   makeDistinct();
 537   return this;
 538 }
 539
 540 void MDTuple::recalculateHash() {
 541   setHash(MDTupleInfo::KeyTy::calculateHash(this));
 542 }
 543
 544 void GenericDebugNode::recalculateHash() {
 545   setHash(GenericDebugNodeInfo::KeyTy::calculateHash(this));
 546 }
 547
 548 void MDNode::dropAllReferences() {
 549   for (unsigned I = 0, E = NumOperands; I != E; ++I)
 550     setOperand(I, nullptr);
 551   if (!isResolved()) {
 552     Context.getReplaceableUses()->resolveAllUses(/* ResolveUsers */ false);
 553     (void)Context.takeReplaceableUses();
 554   }
 555 }
 556
 557 void MDNode::handleChangedOperand(void *Ref, Metadata *New) {
 558   unsigned Op = static_cast<MDOperand *>(Ref) - op_begin();
 559   assert(Op < getNumOperands() && "Expected valid operand");
 560
 561   if (!isUniqued()) {
 562     // This node is not uniqued.  Just set the operand and be done with it.
 563     setOperand(Op, New);
 564     return;
 565   }
 566
 567   // This node is uniqued.
 568   eraseFromStore();
 569
 570   Metadata *Old = getOperand(Op);
 571   setOperand(Op, New);
 572
 573   // Drop uniquing for self-reference cycles.
 574   if (New == this) {
 575     if (!isResolved())
 576       resolve();
 577     storeDistinctInContext();
 578     return;
 579   }
 580
 581   // Re-unique the node.
 582   auto *Uniqued = uniquify();
 583   if (Uniqued == this) {
 584     if (!isResolved())
 585       resolveAfterOperandChange(Old, New);
 586     return;
 587   }
 588
 589   // Collision.
 590   if (!isResolved()) {
 591     // Still unresolved, so RAUW.
 592     //
 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);
 598     deleteAsSubclass();
 599     return;
 600   }
 601
 602   // Store in non-uniqued form if RAUW isn't possible.
 603   storeDistinctInContext();
 604 }
 605
 606 void MDNode::deleteAsSubclass() {
 607   switch (getMetadataID()) {
 608   default:
 609     llvm_unreachable("Invalid subclass of MDNode");
 610 #define HANDLE_MDNODE_LEAF(CLASS)                                              \
 611   case CLASS##Kind:                                                            \
 612     delete cast<CLASS>(this);                                                  \
 613     break;
 614 #include "llvm/IR/Metadata.def"
 615   }
 616 }
 617
 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;
 623 }
 624
 625 template <class T, class InfoT>
 626 static T *uniquifyImpl(T *N, DenseSet<T *, InfoT> &Store) {
 627   if (T *U = getUniqued(Store, N))
 628     return U;
 629
 630   Store.insert(N);
 631   return N;
 632 }
 633
 634 template <class NodeTy> struct MDNode::HasCachedHash {
 635   typedef char Yes[1];
 636   typedef char No[2];
 637   template <class U, U Val> struct SFINAE {};
 638
 639   template <class U>
 640   static Yes &check(SFINAE<void (U::*)(unsigned), &U::setHash> *);
 641   template <class U> static No &check(...);
 642
 643   static const bool value = sizeof(check<NodeTy>(nullptr)) == sizeof(Yes);
 644 };
 645
 646 MDNode *MDNode::uniquify() {
 647   // Try to insert into uniquing store.
 648   switch (getMetadataID()) {
 649   default:
 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);           \
 658   }
 659 #include "llvm/IR/Metadata.def"
 660   }
 661 }
 662
 663 void MDNode::eraseFromStore() {
 664   switch (getMetadataID()) {
 665   default:
 666     llvm_unreachable("Invalid subclass of MDNode");
 667 #define HANDLE_MDNODE_LEAF(CLASS)                                              \
 668   case CLASS##Kind:                                                            \
 669     getContext().pImpl->CLASS##s.erase(cast<CLASS>(this));                     \
 670     break;
 671 #include "llvm/IR/Metadata.def"
 672   }
 673 }
 674
 675 template <class T, class StoreT>
 676 T *MDNode::storeImpl(T *N, StorageType Storage, StoreT &Store) {
 677   switch (Storage) {
 678   case Uniqued:
 679     Store.insert(N);
 680     break;
 681   case Distinct:
 682     N->storeDistinctInContext();
 683     break;
 684   case Temporary:
 685     break;
 686   }
 687   return N;
 688 }
 689
 690 MDTuple *MDTuple::getImpl(LLVMContext &Context, ArrayRef<Metadata *> MDs,
 691                           StorageType Storage, bool ShouldCreate) {
 692   unsigned Hash = 0;
 693   if (Storage == Uniqued) {
 694     MDTupleInfo::KeyTy Key(MDs);
 695     if (auto *N = getUniqued(Context.pImpl->MDTuples, Key))
 696       return N;
 697     if (!ShouldCreate)
 698       return nullptr;
 699     Hash = Key.getHash();
 700   } else {
 701     assert(ShouldCreate && "Expected non-uniqued nodes to always be created");
 702   }
 703
 704   return storeImpl(new (MDs.size()) MDTuple(Context, Storage, Hash, MDs),
 705                    Storage, Context.pImpl->MDTuples);
 706 }
 707
 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");
 713
 714   // Set line and column.
 715   assert(Line < (1u << 24) && "Expected 24-bit line");
 716   assert(Column < (1u << 16) && "Expected 16-bit column");
 717
 718   SubclassData32 = Line;
 719   SubclassData16 = Column;
 720 }
 721
 722 static void adjustLine(unsigned &Line) {
 723   // Set to unknown on overflow.  Still use 24 bits for now.
 724   if (Line >= (1u << 24))
 725     Line = 0;
 726 }
 727
 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))
 731     Column = 0;
 732 }
 733
 734 MDLocation *MDLocation::getImpl(LLVMContext &Context, unsigned Line,
 735                                 unsigned Column, Metadata *Scope,
 736                                 Metadata *InlinedAt, StorageType Storage,
 737                                 bool ShouldCreate) {
 738   // Fixup line/column.
 739   adjustLine(Line);
 740   adjustColumn(Column);
 741
 742   if (Storage == Uniqued) {
 743     if (auto *N = getUniqued(
 744             Context.pImpl->MDLocations,
 745             MDLocationInfo::KeyTy(Line, Column, Scope, InlinedAt)))
 746       return N;
 747     if (!ShouldCreate)
 748       return nullptr;
 749   } else {
 750     assert(ShouldCreate && "Expected non-uniqued nodes to always be created");
 751   }
 752
 753   SmallVector<Metadata *, 2> Ops;
 754   Ops.push_back(Scope);
 755   if (InlinedAt)
 756     Ops.push_back(InlinedAt);
 757   return storeImpl(new (Ops.size())
 758                        MDLocation(Context, Storage, Line, Column, Ops),
 759                    Storage, Context.pImpl->MDLocations);
 760 }
 761
 762 GenericDebugNode *GenericDebugNode::getImpl(LLVMContext &Context, unsigned Tag,
 763                                             StringRef Header,
 764                                             ArrayRef<Metadata *> DwarfOps,
 765                                             StorageType Storage,
 766                                             bool ShouldCreate) {
 767   unsigned Hash = 0;
 768   if (Storage == Uniqued) {
 769     GenericDebugNodeInfo::KeyTy Key(Tag, Header, DwarfOps);
 770     if (auto *N = getUniqued(Context.pImpl->GenericDebugNodes, Key))
 771       return N;
 772     if (!ShouldCreate)
 773       return nullptr;
 774     Hash = Key.getHash();
 775   } else {
 776     assert(ShouldCreate && "Expected non-uniqued nodes to always be created");
 777   }
 778
 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);
 785 }
 786
 787 void MDNode::deleteTemporary(MDNode *N) {
 788   assert(N->isTemporary() && "Expected temporary node");
 789   N->replaceAllUsesWith(nullptr);
 790   N->deleteAsSubclass();
 791 }
 792
 793 void MDNode::storeDistinctInContext() {
 794   assert(isResolved() && "Expected resolved nodes");
 795   Storage = Distinct;
 796
 797   // Reset the hash.
 798   switch (getMetadataID()) {
 799   default:
 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);                     \
 805     break;                                                                     \
 806   }
 807 #include "llvm/IR/Metadata.def"
 808   }
 809
 810   getContext().pImpl->DistinctMDNodes.insert(this);
 811 }
 812
 813 void MDNode::replaceOperandWith(unsigned I, Metadata *New) {
 814   if (getOperand(I) == New)
 815     return;
 816
 817   if (!isUniqued()) {
 818     setOperand(I, New);
 819     return;
 820   }
 821
 822   handleChangedOperand(mutable_begin() + I, New);
 823 }
 824
 825 void MDNode::setOperand(unsigned I, Metadata *New) {
 826   assert(I < NumOperands);
 827   mutable_begin()[I].reset(New, isUniqued() ? this : nullptr);
 828 }
 829
 830 /// \brief Get a node, or a self-reference that looks like it.
 831 ///
 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) {
 838   if (!Ops.empty())
 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);
 844         return N;
 845       }
 846
 847   return MDNode::get(Context, Ops);
 848 }
 849
 850 MDNode *MDNode::concatenate(MDNode *A, MDNode *B) {
 851   if (!A)
 852     return B;
 853   if (!B)
 854     return A;
 855
 856   SmallVector<Metadata *, 4> MDs(A->getNumOperands() + B->getNumOperands());
 857
 858   unsigned j = 0;
 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);
 863
 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);
 867 }
 868
 869 MDNode *MDNode::intersect(MDNode *A, MDNode *B) {
 870   if (!A || !B)
 871     return nullptr;
 872
 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)) {
 878         MDs.push_back(MD);
 879         break;
 880       }
 881   }
 882
 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);
 886 }
 887
 888 MDNode *MDNode::getMostGenericFPMath(MDNode *A, MDNode *B) {
 889   if (!A || !B)
 890     return nullptr;
 891
 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)
 895     return A;
 896   return B;
 897 }
 898
 899 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
 900   return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
 901 }
 902
 903 static bool canBeMerged(const ConstantRange &A, const ConstantRange &B) {
 904   return !A.intersectWith(B).isEmptySet() || isContiguous(A, B);
 905 }
 906
 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()));
 921     return true;
 922   }
 923   return false;
 924 }
 925
 926 static void addRange(SmallVectorImpl<ConstantInt *> &EndPoints,
 927                      ConstantInt *Low, ConstantInt *High) {
 928   if (!EndPoints.empty())
 929     if (tryMergeRange(EndPoints, Low, High))
 930       return;
 931
 932   EndPoints.push_back(Low);
 933   EndPoints.push_back(High);
 934 }
 935
 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.
 940
 941   if (!A || !B)
 942     return nullptr;
 943
 944   if (A == B)
 945     return A;
 946
 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;
 950   int AI = 0;
 951   int BI = 0;
 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));
 957
 958     if (ALow->getValue().slt(BLow->getValue())) {
 959       addRange(EndPoints, ALow,
 960                mdconst::extract<ConstantInt>(A->getOperand(2 * AI + 1)));
 961       ++AI;
 962     } else {
 963       addRange(EndPoints, BLow,
 964                mdconst::extract<ConstantInt>(B->getOperand(2 * BI + 1)));
 965       ++BI;
 966     }
 967   }
 968   while (AI < AN) {
 969     addRange(EndPoints, mdconst::extract<ConstantInt>(A->getOperand(2 * AI)),
 970              mdconst::extract<ConstantInt>(A->getOperand(2 * AI + 1)));
 971     ++AI;
 972   }
 973   while (BI < BN) {
 974     addRange(EndPoints, mdconst::extract<ConstantInt>(B->getOperand(2 * BI)),
 975              mdconst::extract<ConstantInt>(B->getOperand(2 * BI + 1)));
 976     ++BI;
 977   }
 978
 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();
 982   if (Size > 4) {
 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];
 988       }
 989       EndPoints.resize(Size - 2);
 990     }
 991   }
 992
 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())
 998       return nullptr;
 999   }
1000
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);
1006 }
1007
1008 //===----------------------------------------------------------------------===//
1009 // NamedMDNode implementation.
1010 //
1011
1012 static SmallVector<TrackingMDRef, 4> &getNMDOps(void *Operands) {
1013   return *(SmallVector<TrackingMDRef, 4> *)Operands;
1014 }
1015
1016 NamedMDNode::NamedMDNode(const Twine &N)
1017     : Name(N.str()), Parent(nullptr),
1018       Operands(new SmallVector<TrackingMDRef, 4>()) {}
1019
1020 NamedMDNode::~NamedMDNode() {
1021   dropAllReferences();
1022   delete &getNMDOps(Operands);
1023 }
1024
1025 unsigned NamedMDNode::getNumOperands() const {
1026   return (unsigned)getNMDOps(Operands).size();
1027 }
1028
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);
1033 }
1034
1035 void NamedMDNode::addOperand(MDNode *M) { getNMDOps(Operands).emplace_back(M); }
1036
1037 void NamedMDNode::setOperand(unsigned I, MDNode *New) {
1038   assert(I < getNumOperands() && "Invalid operand number");
1039   getNMDOps(Operands)[I].reset(New);
1040 }
1041
1042 void NamedMDNode::eraseFromParent() {
1043   getParent()->eraseNamedMetadata(this);
1044 }
1045
1046 void NamedMDNode::dropAllReferences() {
1047   getNMDOps(Operands).clear();
1048 }
1049
1050 StringRef NamedMDNode::getName() const {
1051   return StringRef(Name);
1052 }
1053
1054 //===----------------------------------------------------------------------===//
1055 // Instruction Metadata method implementations.
1056 //
1057
1058 void Instruction::setMetadata(StringRef Kind, MDNode *Node) {
1059   if (!Node && !hasMetadata())
1060     return;
1061   setMetadata(getContext().getMDKindID(Kind), Node);
1062 }
1063
1064 MDNode *Instruction::getMetadataImpl(StringRef Kind) const {
1065   return getMetadataImpl(getContext().getMDKindID(Kind));
1066 }
1067
1068 void Instruction::dropUnknownMetadata(ArrayRef<unsigned> KnownIDs) {
1069   SmallSet<unsigned, 5> KnownSet;
1070   KnownSet.insert(KnownIDs.begin(), KnownIDs.end());
1071
1072   // Drop debug if needed
1073   if (KnownSet.erase(LLVMContext::MD_dbg))
1074     DbgLoc = DebugLoc();
1075
1076   if (!hasMetadataHashEntry())
1077     return; // Nothing to remove!
1078
1079   DenseMap<const Instruction *, LLVMContextImpl::MDMapTy> &MetadataStore =
1080       getContext().pImpl->MetadataStore;
1081
1082   if (KnownSet.empty()) {
1083     // Just drop our entry at the store.
1084     MetadataStore.erase(this);
1085     setHasMetadataHashEntry(false);
1086     return;
1087   }
1088
1089   LLVMContextImpl::MDMapTy &Info = MetadataStore[this];
1090   unsigned I;
1091   unsigned E;
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)) {
1095       ++I;
1096       continue;
1097     }
1098
1099     Info[I] = std::move(Info.back());
1100     Info.pop_back();
1101     --E;
1102   }
1103   assert(E == Info.size());
1104
1105   if (E == 0) {
1106     // Drop our entry at the store.
1107     MetadataStore.erase(this);
1108     setHasMetadataHashEntry(false);
1109   }
1110 }
1111
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
1114 /// Node is null.
1115 void Instruction::setMetadata(unsigned KindID, MDNode *Node) {
1116   if (!Node && !hasMetadata())
1117     return;
1118
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);
1122     return;
1123   }
1124
1125   // Handle the case when we're adding/updating metadata on an instruction.
1126   if (Node) {
1127     LLVMContextImpl::MDMapTy &Info = getContext().pImpl->MetadataStore[this];
1128     assert(!Info.empty() == hasMetadataHashEntry() &&
1129            "HasMetadata bit is wonked");
1130     if (Info.empty()) {
1131       setHasMetadataHashEntry(true);
1132     } else {
1133       // Handle replacement of an existing value.
1134       for (auto &P : Info)
1135         if (P.first == KindID) {
1136           P.second.reset(Node);
1137           return;
1138         }
1139     }
1140
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));
1144     return;
1145   }
1146
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];
1154
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);
1159     return;
1160   }
1161
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());
1166       Info.pop_back();
1167       assert(!Info.empty() && "Removing last entry should be handled above");
1168       return;
1169     }
1170   // Otherwise, removing an entry that doesn't exist on the instruction.
1171 }
1172
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);
1177 }
1178
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();
1183
1184   if (!hasMetadataHashEntry()) return nullptr;
1185
1186   LLVMContextImpl::MDMapTy &Info = getContext().pImpl->MetadataStore[this];
1187   assert(!Info.empty() && "bit out of sync with hash table");
1188
1189   for (const auto &I : Info)
1190     if (I.first == KindID)
1191       return I.second;
1192   return nullptr;
1193 }
1194
1195 void Instruction::getAllMetadataImpl(
1196     SmallVectorImpl<std::pair<unsigned, MDNode *>> &Result) const {
1197   Result.clear();
1198
1199   // Handle 'dbg' as a special case since it is not stored in the hash table.
1200   if (!DbgLoc.isUnknown()) {
1201     Result.push_back(
1202         std::make_pair((unsigned)LLVMContext::MD_dbg, DbgLoc.getAsMDNode()));
1203     if (!hasMetadataHashEntry()) return;
1204   }
1205
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");
1212
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())));
1216
1217   // Sort the resulting array so it is stable.
1218   if (Result.size() > 1)
1219     array_pod_sort(Result.begin(), Result.end());
1220 }
1221
1222 void Instruction::getAllMetadataOtherThanDebugLocImpl(
1223     SmallVectorImpl<std::pair<unsigned, MDNode *>> &Result) const {
1224   Result.clear();
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())));
1234
1235   // Sort the resulting array so it is stable.
1236   if (Result.size() > 1)
1237     array_pod_sort(Result.begin(), Result.end());
1238 }
1239
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);
1246 }