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 *> MDs)
 401     : Metadata(ID, Storage), Context(Context), NumOperands(MDs.size()),
 402       MDNodeSubclassData(0) {
 403   for (unsigned I = 0, E = MDs.size(); I != E; ++I)
 404     setOperand(I, MDs[I]);
 405
 406   if (isDistinct())
 407     return;
 408
 409   if (isUniqued()) {
 410     // Check whether any operands are unresolved, requiring re-uniquing.
 411     unsigned NumUnresolved = countUnresolvedOperands();
 412     if (!NumUnresolved)
 413       return;
 414
 415     SubclassData32 = NumUnresolved;
 416   }
 417
 418   this->Context.makeReplaceable(make_unique<ReplaceableMetadataImpl>(Context));
 419 }
 420
 421 static bool isOperandUnresolved(Metadata *Op) {
 422   if (auto *N = dyn_cast_or_null<MDNode>(Op))
 423     return !N->isResolved();
 424   return false;
 425 }
 426
 427 unsigned MDNode::countUnresolvedOperands() const {
 428   unsigned NumUnresolved = 0;
 429   for (const auto &Op : operands())
 430     NumUnresolved += unsigned(isOperandUnresolved(Op));
 431   return NumUnresolved;
 432 }
 433
 434 void MDNode::makeUniqued() {
 435   assert(isTemporary() && "Expected this to be temporary");
 436   assert(!isResolved() && "Expected this to be unresolved");
 437
 438   // Make this 'uniqued'.
 439   Storage = Uniqued;
 440   if (unsigned NumUnresolved = countUnresolvedOperands())
 441     SubclassData32 = NumUnresolved;
 442   else
 443     resolve();
 444
 445   assert(isUniqued() && "Expected this to be uniqued");
 446 }
 447
 448 void MDNode::makeDistinct() {
 449   assert(isTemporary() && "Expected this to be temporary");
 450   assert(!isResolved() && "Expected this to be unresolved");
 451
 452   // Pretend to be uniqued, resolve the node, and then store in distinct table.
 453   Storage = Uniqued;
 454   resolve();
 455   storeDistinctInContext();
 456
 457   assert(isDistinct() && "Expected this to be distinct");
 458   assert(isResolved() && "Expected this to be resolved");
 459 }
 460
 461 void MDNode::resolve() {
 462   assert(isUniqued() && "Expected this to be uniqued");
 463   assert(!isResolved() && "Expected this to be unresolved");
 464
 465   // Move the map, so that this immediately looks resolved.
 466   auto Uses = Context.takeReplaceableUses();
 467   SubclassData32 = 0;
 468   assert(isResolved() && "Expected this to be resolved");
 469
 470   // Drop RAUW support.
 471   Uses->resolveAllUses();
 472 }
 473
 474 void MDNode::resolveAfterOperandChange(Metadata *Old, Metadata *New) {
 475   assert(SubclassData32 != 0 && "Expected unresolved operands");
 476
 477   // Check if an operand was resolved.
 478   if (!isOperandUnresolved(Old)) {
 479     if (isOperandUnresolved(New))
 480       // An operand was un-resolved!
 481       ++SubclassData32;
 482   } else if (!isOperandUnresolved(New))
 483     decrementUnresolvedOperandCount();
 484 }
 485
 486 void MDNode::decrementUnresolvedOperandCount() {
 487   if (!--SubclassData32)
 488     // Last unresolved operand has just been resolved.
 489     resolve();
 490 }
 491
 492 void MDNode::resolveCycles() {
 493   if (isResolved())
 494     return;
 495
 496   // Resolve this node immediately.
 497   resolve();
 498
 499   // Resolve all operands.
 500   for (const auto &Op : operands()) {
 501     auto *N = dyn_cast_or_null<MDNode>(Op);
 502     if (!N)
 503       continue;
 504
 505     assert(!N->isTemporary() &&
 506            "Expected all forward declarations to be resolved");
 507     if (!N->isResolved())
 508       N->resolveCycles();
 509   }
 510 }
 511
 512 void MDTuple::recalculateHash() {
 513   setHash(MDTupleInfo::KeyTy::calculateHash(this));
 514 }
 515
 516 void MDNode::dropAllReferences() {
 517   for (unsigned I = 0, E = NumOperands; I != E; ++I)
 518     setOperand(I, nullptr);
 519   if (!isResolved()) {
 520     Context.getReplaceableUses()->resolveAllUses(/* ResolveUsers */ false);
 521     (void)Context.takeReplaceableUses();
 522   }
 523 }
 524
 525 void MDNode::handleChangedOperand(void *Ref, Metadata *New) {
 526   unsigned Op = static_cast<MDOperand *>(Ref) - op_begin();
 527   assert(Op < getNumOperands() && "Expected valid operand");
 528
 529   if (!isUniqued()) {
 530     // This node is not uniqued.  Just set the operand and be done with it.
 531     setOperand(Op, New);
 532     return;
 533   }
 534
 535   // This node is uniqued.
 536   eraseFromStore();
 537
 538   Metadata *Old = getOperand(Op);
 539   setOperand(Op, New);
 540
 541   // Drop uniquing for self-reference cycles.
 542   if (New == this) {
 543     if (!isResolved())
 544       resolve();
 545     storeDistinctInContext();
 546     return;
 547   }
 548
 549   // Re-unique the node.
 550   auto *Uniqued = uniquify();
 551   if (Uniqued == this) {
 552     if (!isResolved())
 553       resolveAfterOperandChange(Old, New);
 554     return;
 555   }
 556
 557   // Collision.
 558   if (!isResolved()) {
 559     // Still unresolved, so RAUW.
 560     //
 561     // First, clear out all operands to prevent any recursion (similar to
 562     // dropAllReferences(), but we still need the use-list).
 563     for (unsigned O = 0, E = getNumOperands(); O != E; ++O)
 564       setOperand(O, nullptr);
 565     Context.getReplaceableUses()->replaceAllUsesWith(Uniqued);
 566     deleteAsSubclass();
 567     return;
 568   }
 569
 570   // Store in non-uniqued form if RAUW isn't possible.
 571   storeDistinctInContext();
 572 }
 573
 574 void MDNode::deleteAsSubclass() {
 575   switch (getMetadataID()) {
 576   default:
 577     llvm_unreachable("Invalid subclass of MDNode");
 578 #define HANDLE_MDNODE_LEAF(CLASS)                                              \
 579   case CLASS##Kind:                                                            \
 580     delete cast<CLASS>(this);                                                  \
 581     break;
 582 #include "llvm/IR/Metadata.def"
 583   }
 584 }
 585
 586 template <class T, class InfoT>
 587 static T *getUniqued(DenseSet<T *, InfoT> &Store,
 588                      const typename InfoT::KeyTy &Key) {
 589   auto I = Store.find_as(Key);
 590   return I == Store.end() ? nullptr : *I;
 591 }
 592
 593 template <class T, class InfoT>
 594 static T *uniquifyImpl(T *N, DenseSet<T *, InfoT> &Store) {
 595   if (T *U = getUniqued(Store, N))
 596     return U;
 597
 598   Store.insert(N);
 599   return N;
 600 }
 601
 602 MDNode *MDNode::uniquify() {
 603   // Recalculate hash, if necessary.
 604   switch (getMetadataID()) {
 605   default:
 606     break;
 607   case MDTupleKind:
 608     cast<MDTuple>(this)->recalculateHash();
 609     break;
 610   }
 611
 612   // Try to insert into uniquing store.
 613   switch (getMetadataID()) {
 614   default:
 615     llvm_unreachable("Invalid subclass of MDNode");
 616 #define HANDLE_MDNODE_LEAF(CLASS)                                              \
 617   case CLASS##Kind:                                                            \
 618     return uniquifyImpl(cast<CLASS>(this), getContext().pImpl->CLASS##s);
 619 #include "llvm/IR/Metadata.def"
 620   }
 621 }
 622
 623 void MDNode::eraseFromStore() {
 624   switch (getMetadataID()) {
 625   default:
 626     llvm_unreachable("Invalid subclass of MDNode");
 627 #define HANDLE_MDNODE_LEAF(CLASS)                                              \
 628   case CLASS##Kind:                                                            \
 629     getContext().pImpl->CLASS##s.erase(cast<CLASS>(this));                     \
 630     break;
 631 #include "llvm/IR/Metadata.def"
 632   }
 633 }
 634
 635 template <class T, class StoreT>
 636 T *MDNode::storeImpl(T *N, StorageType Storage, StoreT &Store) {
 637   switch (Storage) {
 638   case Uniqued:
 639     Store.insert(N);
 640     break;
 641   case Distinct:
 642     N->storeDistinctInContext();
 643     break;
 644   case Temporary:
 645     break;
 646   }
 647   return N;
 648 }
 649
 650 MDTuple *MDTuple::getImpl(LLVMContext &Context, ArrayRef<Metadata *> MDs,
 651                           StorageType Storage, bool ShouldCreate) {
 652   unsigned Hash = 0;
 653   if (Storage == Uniqued) {
 654     MDTupleInfo::KeyTy Key(MDs);
 655     if (auto *N = getUniqued(Context.pImpl->MDTuples, Key))
 656       return N;
 657     if (!ShouldCreate)
 658       return nullptr;
 659     Hash = Key.getHash();
 660   } else {
 661     assert(ShouldCreate && "Expected non-uniqued nodes to always be created");
 662   }
 663
 664   return storeImpl(new (MDs.size()) MDTuple(Context, Storage, Hash, MDs),
 665                    Storage, Context.pImpl->MDTuples);
 666 }
 667
 668 MDLocation::MDLocation(LLVMContext &C, StorageType Storage, unsigned Line,
 669                        unsigned Column, ArrayRef<Metadata *> MDs)
 670     : MDNode(C, MDLocationKind, Storage, MDs) {
 671   assert((MDs.size() == 1 || MDs.size() == 2) &&
 672          "Expected a scope and optional inlined-at");
 673
 674   // Set line and column.
 675   assert(Line < (1u << 24) && "Expected 24-bit line");
 676   assert(Column < (1u << 16) && "Expected 16-bit column");
 677
 678   MDNodeSubclassData = Line;
 679   SubclassData16 = Column;
 680 }
 681
 682 static void adjustLine(unsigned &Line) {
 683   // Set to unknown on overflow.  Still use 24 bits for now.
 684   if (Line >= (1u << 24))
 685     Line = 0;
 686 }
 687
 688 static void adjustColumn(unsigned &Column) {
 689   // Set to unknown on overflow.  We only have 16 bits to play with here.
 690   if (Column >= (1u << 16))
 691     Column = 0;
 692 }
 693
 694 MDLocation *MDLocation::getImpl(LLVMContext &Context, unsigned Line,
 695                                 unsigned Column, Metadata *Scope,
 696                                 Metadata *InlinedAt, StorageType Storage,
 697                                 bool ShouldCreate) {
 698   // Fixup line/column.
 699   adjustLine(Line);
 700   adjustColumn(Column);
 701
 702   if (Storage == Uniqued) {
 703     if (auto *N = getUniqued(
 704             Context.pImpl->MDLocations,
 705             MDLocationInfo::KeyTy(Line, Column, Scope, InlinedAt)))
 706       return N;
 707     if (!ShouldCreate)
 708       return nullptr;
 709   } else {
 710     assert(ShouldCreate && "Expected non-uniqued nodes to always be created");
 711   }
 712
 713   SmallVector<Metadata *, 2> Ops;
 714   Ops.push_back(Scope);
 715   if (InlinedAt)
 716     Ops.push_back(InlinedAt);
 717   return storeImpl(new (Ops.size())
 718                        MDLocation(Context, Storage, Line, Column, Ops),
 719                    Storage, Context.pImpl->MDLocations);
 720 }
 721
 722 void MDNode::deleteTemporary(MDNode *N) {
 723   assert(N->isTemporary() && "Expected temporary node");
 724   N->deleteAsSubclass();
 725 }
 726
 727 void MDNode::storeDistinctInContext() {
 728   assert(isResolved() && "Expected resolved nodes");
 729   Storage = Distinct;
 730   if (auto *T = dyn_cast<MDTuple>(this))
 731     T->setHash(0);
 732   getContext().pImpl->DistinctMDNodes.insert(this);
 733 }
 734
 735 void MDNode::replaceOperandWith(unsigned I, Metadata *New) {
 736   if (getOperand(I) == New)
 737     return;
 738
 739   if (!isUniqued()) {
 740     setOperand(I, New);
 741     return;
 742   }
 743
 744   handleChangedOperand(mutable_begin() + I, New);
 745 }
 746
 747 void MDNode::setOperand(unsigned I, Metadata *New) {
 748   assert(I < NumOperands);
 749   mutable_begin()[I].reset(New, isUniqued() ? this : nullptr);
 750 }
 751
 752 /// \brief Get a node, or a self-reference that looks like it.
 753 ///
 754 /// Special handling for finding self-references, for use by \a
 755 /// MDNode::concatenate() and \a MDNode::intersect() to maintain behaviour from
 756 /// when self-referencing nodes were still uniqued.  If the first operand has
 757 /// the same operands as \c Ops, return the first operand instead.
 758 static MDNode *getOrSelfReference(LLVMContext &Context,
 759                                   ArrayRef<Metadata *> Ops) {
 760   if (!Ops.empty())
 761     if (MDNode *N = dyn_cast_or_null<MDNode>(Ops[0]))
 762       if (N->getNumOperands() == Ops.size() && N == N->getOperand(0)) {
 763         for (unsigned I = 1, E = Ops.size(); I != E; ++I)
 764           if (Ops[I] != N->getOperand(I))
 765             return MDNode::get(Context, Ops);
 766         return N;
 767       }
 768
 769   return MDNode::get(Context, Ops);
 770 }
 771
 772 MDNode *MDNode::concatenate(MDNode *A, MDNode *B) {
 773   if (!A)
 774     return B;
 775   if (!B)
 776     return A;
 777
 778   SmallVector<Metadata *, 4> MDs(A->getNumOperands() + B->getNumOperands());
 779
 780   unsigned j = 0;
 781   for (unsigned i = 0, ie = A->getNumOperands(); i != ie; ++i)
 782     MDs[j++] = A->getOperand(i);
 783   for (unsigned i = 0, ie = B->getNumOperands(); i != ie; ++i)
 784     MDs[j++] = B->getOperand(i);
 785
 786   // FIXME: This preserves long-standing behaviour, but is it really the right
 787   // behaviour?  Or was that an unintended side-effect of node uniquing?
 788   return getOrSelfReference(A->getContext(), MDs);
 789 }
 790
 791 MDNode *MDNode::intersect(MDNode *A, MDNode *B) {
 792   if (!A || !B)
 793     return nullptr;
 794
 795   SmallVector<Metadata *, 4> MDs;
 796   for (unsigned i = 0, ie = A->getNumOperands(); i != ie; ++i) {
 797     Metadata *MD = A->getOperand(i);
 798     for (unsigned j = 0, je = B->getNumOperands(); j != je; ++j)
 799       if (MD == B->getOperand(j)) {
 800         MDs.push_back(MD);
 801         break;
 802       }
 803   }
 804
 805   // FIXME: This preserves long-standing behaviour, but is it really the right
 806   // behaviour?  Or was that an unintended side-effect of node uniquing?
 807   return getOrSelfReference(A->getContext(), MDs);
 808 }
 809
 810 MDNode *MDNode::getMostGenericFPMath(MDNode *A, MDNode *B) {
 811   if (!A || !B)
 812     return nullptr;
 813
 814   APFloat AVal = mdconst::extract<ConstantFP>(A->getOperand(0))->getValueAPF();
 815   APFloat BVal = mdconst::extract<ConstantFP>(B->getOperand(0))->getValueAPF();
 816   if (AVal.compare(BVal) == APFloat::cmpLessThan)
 817     return A;
 818   return B;
 819 }
 820
 821 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
 822   return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
 823 }
 824
 825 static bool canBeMerged(const ConstantRange &A, const ConstantRange &B) {
 826   return !A.intersectWith(B).isEmptySet() || isContiguous(A, B);
 827 }
 828
 829 static bool tryMergeRange(SmallVectorImpl<ConstantInt *> &EndPoints,
 830                           ConstantInt *Low, ConstantInt *High) {
 831   ConstantRange NewRange(Low->getValue(), High->getValue());
 832   unsigned Size = EndPoints.size();
 833   APInt LB = EndPoints[Size - 2]->getValue();
 834   APInt LE = EndPoints[Size - 1]->getValue();
 835   ConstantRange LastRange(LB, LE);
 836   if (canBeMerged(NewRange, LastRange)) {
 837     ConstantRange Union = LastRange.unionWith(NewRange);
 838     Type *Ty = High->getType();
 839     EndPoints[Size - 2] =
 840         cast<ConstantInt>(ConstantInt::get(Ty, Union.getLower()));
 841     EndPoints[Size - 1] =
 842         cast<ConstantInt>(ConstantInt::get(Ty, Union.getUpper()));
 843     return true;
 844   }
 845   return false;
 846 }
 847
 848 static void addRange(SmallVectorImpl<ConstantInt *> &EndPoints,
 849                      ConstantInt *Low, ConstantInt *High) {
 850   if (!EndPoints.empty())
 851     if (tryMergeRange(EndPoints, Low, High))
 852       return;
 853
 854   EndPoints.push_back(Low);
 855   EndPoints.push_back(High);
 856 }
 857
 858 MDNode *MDNode::getMostGenericRange(MDNode *A, MDNode *B) {
 859   // Given two ranges, we want to compute the union of the ranges. This
 860   // is slightly complitade by having to combine the intervals and merge
 861   // the ones that overlap.
 862
 863   if (!A || !B)
 864     return nullptr;
 865
 866   if (A == B)
 867     return A;
 868
 869   // First, walk both lists in older of the lower boundary of each interval.
 870   // At each step, try to merge the new interval to the last one we adedd.
 871   SmallVector<ConstantInt *, 4> EndPoints;
 872   int AI = 0;
 873   int BI = 0;
 874   int AN = A->getNumOperands() / 2;
 875   int BN = B->getNumOperands() / 2;
 876   while (AI < AN && BI < BN) {
 877     ConstantInt *ALow = mdconst::extract<ConstantInt>(A->getOperand(2 * AI));
 878     ConstantInt *BLow = mdconst::extract<ConstantInt>(B->getOperand(2 * BI));
 879
 880     if (ALow->getValue().slt(BLow->getValue())) {
 881       addRange(EndPoints, ALow,
 882                mdconst::extract<ConstantInt>(A->getOperand(2 * AI + 1)));
 883       ++AI;
 884     } else {
 885       addRange(EndPoints, BLow,
 886                mdconst::extract<ConstantInt>(B->getOperand(2 * BI + 1)));
 887       ++BI;
 888     }
 889   }
 890   while (AI < AN) {
 891     addRange(EndPoints, mdconst::extract<ConstantInt>(A->getOperand(2 * AI)),
 892              mdconst::extract<ConstantInt>(A->getOperand(2 * AI + 1)));
 893     ++AI;
 894   }
 895   while (BI < BN) {
 896     addRange(EndPoints, mdconst::extract<ConstantInt>(B->getOperand(2 * BI)),
 897              mdconst::extract<ConstantInt>(B->getOperand(2 * BI + 1)));
 898     ++BI;
 899   }
 900
 901   // If we have more than 2 ranges (4 endpoints) we have to try to merge
 902   // the last and first ones.
 903   unsigned Size = EndPoints.size();
 904   if (Size > 4) {
 905     ConstantInt *FB = EndPoints[0];
 906     ConstantInt *FE = EndPoints[1];
 907     if (tryMergeRange(EndPoints, FB, FE)) {
 908       for (unsigned i = 0; i < Size - 2; ++i) {
 909         EndPoints[i] = EndPoints[i + 2];
 910       }
 911       EndPoints.resize(Size - 2);
 912     }
 913   }
 914
 915   // If in the end we have a single range, it is possible that it is now the
 916   // full range. Just drop the metadata in that case.
 917   if (EndPoints.size() == 2) {
 918     ConstantRange Range(EndPoints[0]->getValue(), EndPoints[1]->getValue());
 919     if (Range.isFullSet())
 920       return nullptr;
 921   }
 922
 923   SmallVector<Metadata *, 4> MDs;
 924   MDs.reserve(EndPoints.size());
 925   for (auto *I : EndPoints)
 926     MDs.push_back(ConstantAsMetadata::get(I));
 927   return MDNode::get(A->getContext(), MDs);
 928 }
 929
 930 //===----------------------------------------------------------------------===//
 931 // NamedMDNode implementation.
 932 //
 933
 934 static SmallVector<TrackingMDRef, 4> &getNMDOps(void *Operands) {
 935   return *(SmallVector<TrackingMDRef, 4> *)Operands;
 936 }
 937
 938 NamedMDNode::NamedMDNode(const Twine &N)
 939     : Name(N.str()), Parent(nullptr),
 940       Operands(new SmallVector<TrackingMDRef, 4>()) {}
 941
 942 NamedMDNode::~NamedMDNode() {
 943   dropAllReferences();
 944   delete &getNMDOps(Operands);
 945 }
 946
 947 unsigned NamedMDNode::getNumOperands() const {
 948   return (unsigned)getNMDOps(Operands).size();
 949 }
 950
 951 MDNode *NamedMDNode::getOperand(unsigned i) const {
 952   assert(i < getNumOperands() && "Invalid Operand number!");
 953   auto *N = getNMDOps(Operands)[i].get();
 954   return cast_or_null<MDNode>(N);
 955 }
 956
 957 void NamedMDNode::addOperand(MDNode *M) { getNMDOps(Operands).emplace_back(M); }
 958
 959 void NamedMDNode::setOperand(unsigned I, MDNode *New) {
 960   assert(I < getNumOperands() && "Invalid operand number");
 961   getNMDOps(Operands)[I].reset(New);
 962 }
 963
 964 void NamedMDNode::eraseFromParent() {
 965   getParent()->eraseNamedMetadata(this);
 966 }
 967
 968 void NamedMDNode::dropAllReferences() {
 969   getNMDOps(Operands).clear();
 970 }
 971
 972 StringRef NamedMDNode::getName() const {
 973   return StringRef(Name);
 974 }
 975
 976 //===----------------------------------------------------------------------===//
 977 // Instruction Metadata method implementations.
 978 //
 979
 980 void Instruction::setMetadata(StringRef Kind, MDNode *Node) {
 981   if (!Node && !hasMetadata())
 982     return;
 983   setMetadata(getContext().getMDKindID(Kind), Node);
 984 }
 985
 986 MDNode *Instruction::getMetadataImpl(StringRef Kind) const {
 987   return getMetadataImpl(getContext().getMDKindID(Kind));
 988 }
 989
 990 void Instruction::dropUnknownMetadata(ArrayRef<unsigned> KnownIDs) {
 991   SmallSet<unsigned, 5> KnownSet;
 992   KnownSet.insert(KnownIDs.begin(), KnownIDs.end());
 993
 994   // Drop debug if needed
 995   if (KnownSet.erase(LLVMContext::MD_dbg))
 996     DbgLoc = DebugLoc();
 997
 998   if (!hasMetadataHashEntry())
 999     return; // Nothing to remove!
1000
1001   DenseMap<const Instruction *, LLVMContextImpl::MDMapTy> &MetadataStore =
1002       getContext().pImpl->MetadataStore;
1003
1004   if (KnownSet.empty()) {
1005     // Just drop our entry at the store.
1006     MetadataStore.erase(this);
1007     setHasMetadataHashEntry(false);
1008     return;
1009   }
1010
1011   LLVMContextImpl::MDMapTy &Info = MetadataStore[this];
1012   unsigned I;
1013   unsigned E;
1014   // Walk the array and drop any metadata we don't know.
1015   for (I = 0, E = Info.size(); I != E;) {
1016     if (KnownSet.count(Info[I].first)) {
1017       ++I;
1018       continue;
1019     }
1020
1021     Info[I] = std::move(Info.back());
1022     Info.pop_back();
1023     --E;
1024   }
1025   assert(E == Info.size());
1026
1027   if (E == 0) {
1028     // Drop our entry at the store.
1029     MetadataStore.erase(this);
1030     setHasMetadataHashEntry(false);
1031   }
1032 }
1033
1034 /// setMetadata - Set the metadata of of the specified kind to the specified
1035 /// node.  This updates/replaces metadata if already present, or removes it if
1036 /// Node is null.
1037 void Instruction::setMetadata(unsigned KindID, MDNode *Node) {
1038   if (!Node && !hasMetadata())
1039     return;
1040
1041   // Handle 'dbg' as a special case since it is not stored in the hash table.
1042   if (KindID == LLVMContext::MD_dbg) {
1043     DbgLoc = DebugLoc::getFromDILocation(Node);
1044     return;
1045   }
1046
1047   // Handle the case when we're adding/updating metadata on an instruction.
1048   if (Node) {
1049     LLVMContextImpl::MDMapTy &Info = getContext().pImpl->MetadataStore[this];
1050     assert(!Info.empty() == hasMetadataHashEntry() &&
1051            "HasMetadata bit is wonked");
1052     if (Info.empty()) {
1053       setHasMetadataHashEntry(true);
1054     } else {
1055       // Handle replacement of an existing value.
1056       for (auto &P : Info)
1057         if (P.first == KindID) {
1058           P.second.reset(Node);
1059           return;
1060         }
1061     }
1062
1063     // No replacement, just add it to the list.
1064     Info.emplace_back(std::piecewise_construct, std::make_tuple(KindID),
1065                       std::make_tuple(Node));
1066     return;
1067   }
1068
1069   // Otherwise, we're removing metadata from an instruction.
1070   assert((hasMetadataHashEntry() ==
1071           (getContext().pImpl->MetadataStore.count(this) > 0)) &&
1072          "HasMetadata bit out of date!");
1073   if (!hasMetadataHashEntry())
1074     return;  // Nothing to remove!
1075   LLVMContextImpl::MDMapTy &Info = getContext().pImpl->MetadataStore[this];
1076
1077   // Common case is removing the only entry.
1078   if (Info.size() == 1 && Info[0].first == KindID) {
1079     getContext().pImpl->MetadataStore.erase(this);
1080     setHasMetadataHashEntry(false);
1081     return;
1082   }
1083
1084   // Handle removal of an existing value.
1085   for (unsigned i = 0, e = Info.size(); i != e; ++i)
1086     if (Info[i].first == KindID) {
1087       Info[i] = std::move(Info.back());
1088       Info.pop_back();
1089       assert(!Info.empty() && "Removing last entry should be handled above");
1090       return;
1091     }
1092   // Otherwise, removing an entry that doesn't exist on the instruction.
1093 }
1094
1095 void Instruction::setAAMetadata(const AAMDNodes &N) {
1096   setMetadata(LLVMContext::MD_tbaa, N.TBAA);
1097   setMetadata(LLVMContext::MD_alias_scope, N.Scope);
1098   setMetadata(LLVMContext::MD_noalias, N.NoAlias);
1099 }
1100
1101 MDNode *Instruction::getMetadataImpl(unsigned KindID) const {
1102   // Handle 'dbg' as a special case since it is not stored in the hash table.
1103   if (KindID == LLVMContext::MD_dbg)
1104     return DbgLoc.getAsMDNode();
1105
1106   if (!hasMetadataHashEntry()) return nullptr;
1107
1108   LLVMContextImpl::MDMapTy &Info = getContext().pImpl->MetadataStore[this];
1109   assert(!Info.empty() && "bit out of sync with hash table");
1110
1111   for (const auto &I : Info)
1112     if (I.first == KindID)
1113       return I.second;
1114   return nullptr;
1115 }
1116
1117 void Instruction::getAllMetadataImpl(
1118     SmallVectorImpl<std::pair<unsigned, MDNode *>> &Result) const {
1119   Result.clear();
1120
1121   // Handle 'dbg' as a special case since it is not stored in the hash table.
1122   if (!DbgLoc.isUnknown()) {
1123     Result.push_back(
1124         std::make_pair((unsigned)LLVMContext::MD_dbg, DbgLoc.getAsMDNode()));
1125     if (!hasMetadataHashEntry()) return;
1126   }
1127
1128   assert(hasMetadataHashEntry() &&
1129          getContext().pImpl->MetadataStore.count(this) &&
1130          "Shouldn't have called this");
1131   const LLVMContextImpl::MDMapTy &Info =
1132     getContext().pImpl->MetadataStore.find(this)->second;
1133   assert(!Info.empty() && "Shouldn't have called this");
1134
1135   Result.reserve(Result.size() + Info.size());
1136   for (auto &I : Info)
1137     Result.push_back(std::make_pair(I.first, cast<MDNode>(I.second.get())));
1138
1139   // Sort the resulting array so it is stable.
1140   if (Result.size() > 1)
1141     array_pod_sort(Result.begin(), Result.end());
1142 }
1143
1144 void Instruction::getAllMetadataOtherThanDebugLocImpl(
1145     SmallVectorImpl<std::pair<unsigned, MDNode *>> &Result) const {
1146   Result.clear();
1147   assert(hasMetadataHashEntry() &&
1148          getContext().pImpl->MetadataStore.count(this) &&
1149          "Shouldn't have called this");
1150   const LLVMContextImpl::MDMapTy &Info =
1151     getContext().pImpl->MetadataStore.find(this)->second;
1152   assert(!Info.empty() && "Shouldn't have called this");
1153   Result.reserve(Result.size() + Info.size());
1154   for (auto &I : Info)
1155     Result.push_back(std::make_pair(I.first, cast<MDNode>(I.second.get())));
1156
1157   // Sort the resulting array so it is stable.
1158   if (Result.size() > 1)
1159     array_pod_sort(Result.begin(), Result.end());
1160 }
1161
1162 /// clearMetadataHashEntries - Clear all hashtable-based metadata from
1163 /// this instruction.
1164 void Instruction::clearMetadataHashEntries() {
1165   assert(hasMetadataHashEntry() && "Caller should check");
1166   getContext().pImpl->MetadataStore.erase(this);
1167   setHasMetadataHashEntry(false);
1168 }