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<MDNodeFwdDecl>(MD)) && "Expected non-temp node");
 159
 160   if (UseMap.empty())
 161     return;
 162
 163   // Copy out uses since UseMap will get touched below.
 164   typedef std::pair<void *, std::pair<OwnerTy, uint64_t>> UseTy;
 165   SmallVector<UseTy, 8> Uses(UseMap.begin(), UseMap.end());
 166   std::sort(Uses.begin(), Uses.end(), [](const UseTy &L, const UseTy &R) {
 167     return L.second.second < R.second.second;
 168   });
 169   for (const auto &Pair : Uses) {
 170     OwnerTy Owner = Pair.second.first;
 171     if (!Owner) {
 172       // Update unowned tracking references directly.
 173       Metadata *&Ref = *static_cast<Metadata **>(Pair.first);
 174       Ref = MD;
 175       if (MD)
 176         MetadataTracking::track(Ref);
 177       UseMap.erase(Pair.first);
 178       continue;
 179     }
 180
 181     // Check for MetadataAsValue.
 182     if (Owner.is<MetadataAsValue *>()) {
 183       Owner.get<MetadataAsValue *>()->handleChangedMetadata(MD);
 184       continue;
 185     }
 186
 187     // There's a Metadata owner -- dispatch.
 188     Metadata *OwnerMD = Owner.get<Metadata *>();
 189     switch (OwnerMD->getMetadataID()) {
 190 #define HANDLE_METADATA_LEAF(CLASS)                                            \
 191   case Metadata::CLASS##Kind:                                                  \
 192     cast<CLASS>(OwnerMD)->handleChangedOperand(Pair.first, MD);                \
 193     continue;
 194 #include "llvm/IR/Metadata.def"
 195     default:
 196       llvm_unreachable("Invalid metadata subclass");
 197     }
 198   }
 199   assert(UseMap.empty() && "Expected all uses to be replaced");
 200 }
 201
 202 void ReplaceableMetadataImpl::resolveAllUses(bool ResolveUsers) {
 203   if (UseMap.empty())
 204     return;
 205
 206   if (!ResolveUsers) {
 207     UseMap.clear();
 208     return;
 209   }
 210
 211   // Copy out uses since UseMap could get touched below.
 212   typedef std::pair<void *, std::pair<OwnerTy, uint64_t>> UseTy;
 213   SmallVector<UseTy, 8> Uses(UseMap.begin(), UseMap.end());
 214   std::sort(Uses.begin(), Uses.end(), [](const UseTy &L, const UseTy &R) {
 215     return L.second.second < R.second.second;
 216   });
 217   UseMap.clear();
 218   for (const auto &Pair : Uses) {
 219     auto Owner = Pair.second.first;
 220     if (!Owner)
 221       continue;
 222     if (Owner.is<MetadataAsValue *>())
 223       continue;
 224
 225     // Resolve GenericMDNodes that point at this.
 226     auto *OwnerMD = dyn_cast<GenericMDNode>(Owner.get<Metadata *>());
 227     if (!OwnerMD)
 228       continue;
 229     if (OwnerMD->isResolved())
 230       continue;
 231     if (!--OwnerMD->SubclassData32)
 232       OwnerMD->resolve();
 233   }
 234 }
 235
 236 static Function *getLocalFunction(Value *V) {
 237   assert(V && "Expected value");
 238   if (auto *A = dyn_cast<Argument>(V))
 239     return A->getParent();
 240   if (BasicBlock *BB = cast<Instruction>(V)->getParent())
 241     return BB->getParent();
 242   return nullptr;
 243 }
 244
 245 ValueAsMetadata *ValueAsMetadata::get(Value *V) {
 246   assert(V && "Unexpected null Value");
 247
 248   auto &Context = V->getContext();
 249   auto *&Entry = Context.pImpl->ValuesAsMetadata[V];
 250   if (!Entry) {
 251     assert((isa<Constant>(V) || isa<Argument>(V) || isa<Instruction>(V)) &&
 252            "Expected constant or function-local value");
 253     assert(!V->NameAndIsUsedByMD.getInt() &&
 254            "Expected this to be the only metadata use");
 255     V->NameAndIsUsedByMD.setInt(true);
 256     if (auto *C = dyn_cast<Constant>(V))
 257       Entry = new ConstantAsMetadata(C);
 258     else
 259       Entry = new LocalAsMetadata(V);
 260   }
 261
 262   return Entry;
 263 }
 264
 265 ValueAsMetadata *ValueAsMetadata::getIfExists(Value *V) {
 266   assert(V && "Unexpected null Value");
 267   return V->getContext().pImpl->ValuesAsMetadata.lookup(V);
 268 }
 269
 270 void ValueAsMetadata::handleDeletion(Value *V) {
 271   assert(V && "Expected valid value");
 272
 273   auto &Store = V->getType()->getContext().pImpl->ValuesAsMetadata;
 274   auto I = Store.find(V);
 275   if (I == Store.end())
 276     return;
 277
 278   // Remove old entry from the map.
 279   ValueAsMetadata *MD = I->second;
 280   assert(MD && "Expected valid metadata");
 281   assert(MD->getValue() == V && "Expected valid mapping");
 282   Store.erase(I);
 283
 284   // Delete the metadata.
 285   MD->replaceAllUsesWith(nullptr);
 286   delete MD;
 287 }
 288
 289 void ValueAsMetadata::handleRAUW(Value *From, Value *To) {
 290   assert(From && "Expected valid value");
 291   assert(To && "Expected valid value");
 292   assert(From != To && "Expected changed value");
 293   assert(From->getType() == To->getType() && "Unexpected type change");
 294
 295   LLVMContext &Context = From->getType()->getContext();
 296   auto &Store = Context.pImpl->ValuesAsMetadata;
 297   auto I = Store.find(From);
 298   if (I == Store.end()) {
 299     assert(!From->NameAndIsUsedByMD.getInt() &&
 300            "Expected From not to be used by metadata");
 301     return;
 302   }
 303
 304   // Remove old entry from the map.
 305   assert(From->NameAndIsUsedByMD.getInt() &&
 306          "Expected From to be used by metadata");
 307   From->NameAndIsUsedByMD.setInt(false);
 308   ValueAsMetadata *MD = I->second;
 309   assert(MD && "Expected valid metadata");
 310   assert(MD->getValue() == From && "Expected valid mapping");
 311   Store.erase(I);
 312
 313   if (isa<LocalAsMetadata>(MD)) {
 314     if (auto *C = dyn_cast<Constant>(To)) {
 315       // Local became a constant.
 316       MD->replaceAllUsesWith(ConstantAsMetadata::get(C));
 317       delete MD;
 318       return;
 319     }
 320     if (getLocalFunction(From) && getLocalFunction(To) &&
 321         getLocalFunction(From) != getLocalFunction(To)) {
 322       // Function changed.
 323       MD->replaceAllUsesWith(nullptr);
 324       delete MD;
 325       return;
 326     }
 327   } else if (!isa<Constant>(To)) {
 328     // Changed to function-local value.
 329     MD->replaceAllUsesWith(nullptr);
 330     delete MD;
 331     return;
 332   }
 333
 334   auto *&Entry = Store[To];
 335   if (Entry) {
 336     // The target already exists.
 337     MD->replaceAllUsesWith(Entry);
 338     delete MD;
 339     return;
 340   }
 341
 342   // Update MD in place (and update the map entry).
 343   assert(!To->NameAndIsUsedByMD.getInt() &&
 344          "Expected this to be the only metadata use");
 345   To->NameAndIsUsedByMD.setInt(true);
 346   MD->V = To;
 347   Entry = MD;
 348 }
 349
 350 //===----------------------------------------------------------------------===//
 351 // MDString implementation.
 352 //
 353
 354 MDString *MDString::get(LLVMContext &Context, StringRef Str) {
 355   auto &Store = Context.pImpl->MDStringCache;
 356   auto I = Store.find(Str);
 357   if (I != Store.end())
 358     return &I->second;
 359
 360   auto *Entry =
 361       StringMapEntry<MDString>::Create(Str, Store.getAllocator(), MDString());
 362   bool WasInserted = Store.insert(Entry);
 363   (void)WasInserted;
 364   assert(WasInserted && "Expected entry to be inserted");
 365   Entry->second.Entry = Entry;
 366   return &Entry->second;
 367 }
 368
 369 StringRef MDString::getString() const {
 370   assert(Entry && "Expected to find string map entry");
 371   return Entry->first();
 372 }
 373
 374 //===----------------------------------------------------------------------===//
 375 // MDNode implementation.
 376 //
 377
 378 void *MDNode::operator new(size_t Size, unsigned NumOps) {
 379   void *Ptr = ::operator new(Size + NumOps * sizeof(MDOperand));
 380   MDOperand *O = static_cast<MDOperand *>(Ptr);
 381   for (MDOperand *E = O + NumOps; O != E; ++O)
 382     (void)new (O) MDOperand;
 383   return O;
 384 }
 385
 386 void MDNode::operator delete(void *Mem) {
 387   MDNode *N = static_cast<MDNode *>(Mem);
 388   MDOperand *O = static_cast<MDOperand *>(Mem);
 389   for (MDOperand *E = O - N->NumOperands; O != E; --O)
 390     (O - 1)->~MDOperand();
 391   ::operator delete(O);
 392 }
 393
 394 MDNode::MDNode(LLVMContext &Context, unsigned ID, ArrayRef<Metadata *> MDs)
 395     : Metadata(ID), Context(Context), NumOperands(MDs.size()),
 396       MDNodeSubclassData(0) {
 397   for (unsigned I = 0, E = MDs.size(); I != E; ++I)
 398     setOperand(I, MDs[I]);
 399 }
 400
 401 bool MDNode::isResolved() const {
 402   if (isa<MDNodeFwdDecl>(this))
 403     return false;
 404   return cast<GenericMDNode>(this)->isResolved();
 405 }
 406
 407 static bool isOperandUnresolved(Metadata *Op) {
 408   if (auto *N = dyn_cast_or_null<MDNode>(Op))
 409     return !N->isResolved();
 410   return false;
 411 }
 412
 413 GenericMDNode::GenericMDNode(LLVMContext &C, ArrayRef<Metadata *> Vals,
 414                              bool AllowRAUW)
 415     : MDNode(C, GenericMDNodeKind, Vals) {
 416   if (!AllowRAUW)
 417     return;
 418
 419   // Check whether any operands are unresolved, requiring re-uniquing.
 420   unsigned NumUnresolved = 0;
 421   for (const auto &Op : operands())
 422     NumUnresolved += unsigned(isOperandUnresolved(Op));
 423
 424   if (!NumUnresolved)
 425     return;
 426
 427   ReplaceableUses.reset(new ReplaceableMetadataImpl);
 428   SubclassData32 = NumUnresolved;
 429 }
 430
 431 GenericMDNode::~GenericMDNode() {
 432   LLVMContextImpl *pImpl = getContext().pImpl;
 433   if (isStoredDistinctInContext())
 434     pImpl->NonUniquedMDNodes.erase(this);
 435   else
 436     pImpl->MDNodeSet.erase(this);
 437   dropAllReferences();
 438 }
 439
 440 void GenericMDNode::resolve() {
 441   assert(!isResolved() && "Expected this to be unresolved");
 442
 443   // Move the map, so that this immediately looks resolved.
 444   auto Uses = std::move(ReplaceableUses);
 445   SubclassData32 = 0;
 446   assert(isResolved() && "Expected this to be resolved");
 447
 448   // Drop RAUW support.
 449   Uses->resolveAllUses();
 450 }
 451
 452 void GenericMDNode::resolveAfterOperandChange(Metadata *Old, Metadata *New) {
 453   assert(SubclassData32 != 0 && "Expected unresolved operands");
 454
 455   // Check if the last unresolved operand has just been resolved; if so,
 456   // resolve this as well.
 457   if (isOperandUnresolved(Old)) {
 458     if (!isOperandUnresolved(New)) {
 459       if (!--SubclassData32)
 460         resolve();
 461     }
 462   } else {
 463     // Operands shouldn't become unresolved.
 464     assert(isOperandUnresolved(New) && "Operand just became unresolved");
 465   }
 466 }
 467
 468 void GenericMDNode::resolveCycles() {
 469   if (isResolved())
 470     return;
 471
 472   // Resolve this node immediately.
 473   resolve();
 474
 475   // Resolve all operands.
 476   for (const auto &Op : operands()) {
 477     if (!Op)
 478       continue;
 479     assert(!isa<MDNodeFwdDecl>(Op) &&
 480            "Expected all forward declarations to be resolved");
 481     if (auto *N = dyn_cast<GenericMDNode>(Op))
 482       if (!N->isResolved())
 483         N->resolveCycles();
 484   }
 485 }
 486
 487 void GenericMDNode::recalculateHash() {
 488   setHash(hash_combine_range(op_begin(), op_end()));
 489 #ifndef NDEBUG
 490   {
 491     SmallVector<Metadata *, 8> MDs(op_begin(), op_end());
 492     unsigned RawHash = hash_combine_range(MDs.begin(), MDs.end());
 493     assert(getHash() == RawHash &&
 494            "Expected hash of MDOperand to equal hash of Metadata*");
 495   }
 496 #endif
 497 }
 498
 499 void MDNode::dropAllReferences() {
 500   for (unsigned I = 0, E = NumOperands; I != E; ++I)
 501     setOperand(I, nullptr);
 502   if (auto *G = dyn_cast<GenericMDNode>(this))
 503     if (!G->isResolved()) {
 504       G->ReplaceableUses->resolveAllUses(/* ResolveUsers */ false);
 505       G->ReplaceableUses.reset();
 506     }
 507 }
 508
 509 namespace llvm {
 510 /// \brief Make MDOperand transparent for hashing.
 511 ///
 512 /// This overload of an implementation detail of the hashing library makes
 513 /// MDOperand hash to the same value as a \a Metadata pointer.
 514 ///
 515 /// Note that overloading \a hash_value() as follows:
 516 ///
 517 /// \code
 518 ///     size_t hash_value(const MDOperand &X) { return hash_value(X.get()); }
 519 /// \endcode
 520 ///
 521 /// does not cause MDOperand to be transparent.  In particular, a bare pointer
 522 /// doesn't get hashed before it's combined, whereas \a MDOperand would.
 523 static const Metadata *get_hashable_data(const MDOperand &X) { return X.get(); }
 524 }
 525
 526 void GenericMDNode::handleChangedOperand(void *Ref, Metadata *New) {
 527   unsigned Op = static_cast<MDOperand *>(Ref) - op_begin();
 528   assert(Op < getNumOperands() && "Expected valid operand");
 529
 530   if (isStoredDistinctInContext()) {
 531     assert(isResolved() && "Expected distinct node to be resolved");
 532
 533     // This node is not uniqued.  Just set the operand and be done with it.
 534     setOperand(Op, New);
 535     return;
 536   }
 537
 538   auto &Store = getContext().pImpl->MDNodeSet;
 539   Store.erase(this);
 540
 541   Metadata *Old = getOperand(Op);
 542   setOperand(Op, New);
 543
 544   // Drop uniquing for self-reference cycles.
 545   if (New == this) {
 546     storeDistinctInContext();
 547     if (!isResolved())
 548       resolve();
 549     return;
 550   }
 551
 552   // Re-unique the node.
 553   recalculateHash();
 554   GenericMDNodeInfo::KeyTy Key(this);
 555   auto I = Store.find_as(Key);
 556   if (I == Store.end()) {
 557     Store.insert(this);
 558
 559     if (!isResolved())
 560       resolveAfterOperandChange(Old, New);
 561
 562     return;
 563   }
 564
 565   // Collision.
 566   if (!isResolved()) {
 567     // Still unresolved, so RAUW.
 568     //
 569     // First, clear out all operands to prevent any recursion (similar to
 570     // dropAllReferences(), but we still need the use-list).
 571     for (unsigned O = 0, E = getNumOperands(); O != E; ++O)
 572       setOperand(O, nullptr);
 573     ReplaceableUses->replaceAllUsesWith(*I);
 574     delete this;
 575     return;
 576   }
 577
 578   // Store in non-uniqued form if RAUW isn't possible.
 579   storeDistinctInContext();
 580 }
 581
 582 MDNode *MDNode::getMDNode(LLVMContext &Context, ArrayRef<Metadata *> MDs,
 583                           bool Insert) {
 584   auto &Store = Context.pImpl->MDNodeSet;
 585
 586   GenericMDNodeInfo::KeyTy Key(MDs);
 587   auto I = Store.find_as(Key);
 588   if (I != Store.end())
 589     return *I;
 590   if (!Insert)
 591     return nullptr;
 592
 593   // Coallocate space for the node and Operands together, then placement new.
 594   auto *N = new (MDs.size()) GenericMDNode(Context, MDs, /* AllowRAUW */ true);
 595   N->setHash(Key.Hash);
 596   Store.insert(N);
 597   return N;
 598 }
 599
 600 MDNode *MDNode::getDistinct(LLVMContext &Context, ArrayRef<Metadata *> MDs) {
 601   auto *N = new (MDs.size()) GenericMDNode(Context, MDs, /* AllowRAUW */ false);
 602   N->storeDistinctInContext();
 603   return N;
 604 }
 605
 606 MDNodeFwdDecl *MDNode::getTemporary(LLVMContext &Context,
 607                                     ArrayRef<Metadata *> MDs) {
 608   MDNodeFwdDecl *N = new (MDs.size()) MDNodeFwdDecl(Context, MDs);
 609   return N;
 610 }
 611
 612 void MDNode::deleteTemporary(MDNode *N) {
 613   assert(isa<MDNodeFwdDecl>(N) && "Expected forward declaration");
 614   delete cast<MDNodeFwdDecl>(N);
 615 }
 616
 617 void MDNode::storeDistinctInContext() {
 618   assert(!IsDistinctInContext && "Expected newly distinct metadata");
 619   IsDistinctInContext = true;
 620   auto *G = cast<GenericMDNode>(this);
 621   G->setHash(0);
 622   getContext().pImpl->NonUniquedMDNodes.insert(G);
 623 }
 624
 625 void MDNode::replaceOperandWith(unsigned I, Metadata *New) {
 626   if (getOperand(I) == New)
 627     return;
 628
 629   if (isDistinct()) {
 630     setOperand(I, New);
 631     return;
 632   }
 633
 634   cast<GenericMDNode>(this)->handleChangedOperand(mutable_begin() + I, New);
 635 }
 636
 637 void MDNode::setOperand(unsigned I, Metadata *New) {
 638   assert(I < NumOperands);
 639   if (isStoredDistinctInContext() || isa<MDNodeFwdDecl>(this))
 640     // No need for a callback, this isn't uniqued.
 641     mutable_begin()[I].reset(New, nullptr);
 642   else
 643     mutable_begin()[I].reset(New, this);
 644 }
 645
 646 /// \brief Get a node, or a self-reference that looks like it.
 647 ///
 648 /// Special handling for finding self-references, for use by \a
 649 /// MDNode::concatenate() and \a MDNode::intersect() to maintain behaviour from
 650 /// when self-referencing nodes were still uniqued.  If the first operand has
 651 /// the same operands as \c Ops, return the first operand instead.
 652 static MDNode *getOrSelfReference(LLVMContext &Context,
 653                                   ArrayRef<Metadata *> Ops) {
 654   if (!Ops.empty())
 655     if (MDNode *N = dyn_cast_or_null<MDNode>(Ops[0]))
 656       if (N->getNumOperands() == Ops.size() && N == N->getOperand(0)) {
 657         for (unsigned I = 1, E = Ops.size(); I != E; ++I)
 658           if (Ops[I] != N->getOperand(I))
 659             return MDNode::get(Context, Ops);
 660         return N;
 661       }
 662
 663   return MDNode::get(Context, Ops);
 664 }
 665
 666 MDNode *MDNode::concatenate(MDNode *A, MDNode *B) {
 667   if (!A)
 668     return B;
 669   if (!B)
 670     return A;
 671
 672   SmallVector<Metadata *, 4> MDs(A->getNumOperands() + B->getNumOperands());
 673
 674   unsigned j = 0;
 675   for (unsigned i = 0, ie = A->getNumOperands(); i != ie; ++i)
 676     MDs[j++] = A->getOperand(i);
 677   for (unsigned i = 0, ie = B->getNumOperands(); i != ie; ++i)
 678     MDs[j++] = B->getOperand(i);
 679
 680   // FIXME: This preserves long-standing behaviour, but is it really the right
 681   // behaviour?  Or was that an unintended side-effect of node uniquing?
 682   return getOrSelfReference(A->getContext(), MDs);
 683 }
 684
 685 MDNode *MDNode::intersect(MDNode *A, MDNode *B) {
 686   if (!A || !B)
 687     return nullptr;
 688
 689   SmallVector<Metadata *, 4> MDs;
 690   for (unsigned i = 0, ie = A->getNumOperands(); i != ie; ++i) {
 691     Metadata *MD = A->getOperand(i);
 692     for (unsigned j = 0, je = B->getNumOperands(); j != je; ++j)
 693       if (MD == B->getOperand(j)) {
 694         MDs.push_back(MD);
 695         break;
 696       }
 697   }
 698
 699   // FIXME: This preserves long-standing behaviour, but is it really the right
 700   // behaviour?  Or was that an unintended side-effect of node uniquing?
 701   return getOrSelfReference(A->getContext(), MDs);
 702 }
 703
 704 MDNode *MDNode::getMostGenericFPMath(MDNode *A, MDNode *B) {
 705   if (!A || !B)
 706     return nullptr;
 707
 708   APFloat AVal = mdconst::extract<ConstantFP>(A->getOperand(0))->getValueAPF();
 709   APFloat BVal = mdconst::extract<ConstantFP>(B->getOperand(0))->getValueAPF();
 710   if (AVal.compare(BVal) == APFloat::cmpLessThan)
 711     return A;
 712   return B;
 713 }
 714
 715 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
 716   return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
 717 }
 718
 719 static bool canBeMerged(const ConstantRange &A, const ConstantRange &B) {
 720   return !A.intersectWith(B).isEmptySet() || isContiguous(A, B);
 721 }
 722
 723 static bool tryMergeRange(SmallVectorImpl<ConstantInt *> &EndPoints,
 724                           ConstantInt *Low, ConstantInt *High) {
 725   ConstantRange NewRange(Low->getValue(), High->getValue());
 726   unsigned Size = EndPoints.size();
 727   APInt LB = EndPoints[Size - 2]->getValue();
 728   APInt LE = EndPoints[Size - 1]->getValue();
 729   ConstantRange LastRange(LB, LE);
 730   if (canBeMerged(NewRange, LastRange)) {
 731     ConstantRange Union = LastRange.unionWith(NewRange);
 732     Type *Ty = High->getType();
 733     EndPoints[Size - 2] =
 734         cast<ConstantInt>(ConstantInt::get(Ty, Union.getLower()));
 735     EndPoints[Size - 1] =
 736         cast<ConstantInt>(ConstantInt::get(Ty, Union.getUpper()));
 737     return true;
 738   }
 739   return false;
 740 }
 741
 742 static void addRange(SmallVectorImpl<ConstantInt *> &EndPoints,
 743                      ConstantInt *Low, ConstantInt *High) {
 744   if (!EndPoints.empty())
 745     if (tryMergeRange(EndPoints, Low, High))
 746       return;
 747
 748   EndPoints.push_back(Low);
 749   EndPoints.push_back(High);
 750 }
 751
 752 MDNode *MDNode::getMostGenericRange(MDNode *A, MDNode *B) {
 753   // Given two ranges, we want to compute the union of the ranges. This
 754   // is slightly complitade by having to combine the intervals and merge
 755   // the ones that overlap.
 756
 757   if (!A || !B)
 758     return nullptr;
 759
 760   if (A == B)
 761     return A;
 762
 763   // First, walk both lists in older of the lower boundary of each interval.
 764   // At each step, try to merge the new interval to the last one we adedd.
 765   SmallVector<ConstantInt *, 4> EndPoints;
 766   int AI = 0;
 767   int BI = 0;
 768   int AN = A->getNumOperands() / 2;
 769   int BN = B->getNumOperands() / 2;
 770   while (AI < AN && BI < BN) {
 771     ConstantInt *ALow = mdconst::extract<ConstantInt>(A->getOperand(2 * AI));
 772     ConstantInt *BLow = mdconst::extract<ConstantInt>(B->getOperand(2 * BI));
 773
 774     if (ALow->getValue().slt(BLow->getValue())) {
 775       addRange(EndPoints, ALow,
 776                mdconst::extract<ConstantInt>(A->getOperand(2 * AI + 1)));
 777       ++AI;
 778     } else {
 779       addRange(EndPoints, BLow,
 780                mdconst::extract<ConstantInt>(B->getOperand(2 * BI + 1)));
 781       ++BI;
 782     }
 783   }
 784   while (AI < AN) {
 785     addRange(EndPoints, mdconst::extract<ConstantInt>(A->getOperand(2 * AI)),
 786              mdconst::extract<ConstantInt>(A->getOperand(2 * AI + 1)));
 787     ++AI;
 788   }
 789   while (BI < BN) {
 790     addRange(EndPoints, mdconst::extract<ConstantInt>(B->getOperand(2 * BI)),
 791              mdconst::extract<ConstantInt>(B->getOperand(2 * BI + 1)));
 792     ++BI;
 793   }
 794
 795   // If we have more than 2 ranges (4 endpoints) we have to try to merge
 796   // the last and first ones.
 797   unsigned Size = EndPoints.size();
 798   if (Size > 4) {
 799     ConstantInt *FB = EndPoints[0];
 800     ConstantInt *FE = EndPoints[1];
 801     if (tryMergeRange(EndPoints, FB, FE)) {
 802       for (unsigned i = 0; i < Size - 2; ++i) {
 803         EndPoints[i] = EndPoints[i + 2];
 804       }
 805       EndPoints.resize(Size - 2);
 806     }
 807   }
 808
 809   // If in the end we have a single range, it is possible that it is now the
 810   // full range. Just drop the metadata in that case.
 811   if (EndPoints.size() == 2) {
 812     ConstantRange Range(EndPoints[0]->getValue(), EndPoints[1]->getValue());
 813     if (Range.isFullSet())
 814       return nullptr;
 815   }
 816
 817   SmallVector<Metadata *, 4> MDs;
 818   MDs.reserve(EndPoints.size());
 819   for (auto *I : EndPoints)
 820     MDs.push_back(ConstantAsMetadata::get(I));
 821   return MDNode::get(A->getContext(), MDs);
 822 }
 823
 824 //===----------------------------------------------------------------------===//
 825 // NamedMDNode implementation.
 826 //
 827
 828 static SmallVector<TrackingMDRef, 4> &getNMDOps(void *Operands) {
 829   return *(SmallVector<TrackingMDRef, 4> *)Operands;
 830 }
 831
 832 NamedMDNode::NamedMDNode(const Twine &N)
 833     : Name(N.str()), Parent(nullptr),
 834       Operands(new SmallVector<TrackingMDRef, 4>()) {}
 835
 836 NamedMDNode::~NamedMDNode() {
 837   dropAllReferences();
 838   delete &getNMDOps(Operands);
 839 }
 840
 841 unsigned NamedMDNode::getNumOperands() const {
 842   return (unsigned)getNMDOps(Operands).size();
 843 }
 844
 845 MDNode *NamedMDNode::getOperand(unsigned i) const {
 846   assert(i < getNumOperands() && "Invalid Operand number!");
 847   auto *N = getNMDOps(Operands)[i].get();
 848   return cast_or_null<MDNode>(N);
 849 }
 850
 851 void NamedMDNode::addOperand(MDNode *M) { getNMDOps(Operands).emplace_back(M); }
 852
 853 void NamedMDNode::setOperand(unsigned I, MDNode *New) {
 854   assert(I < getNumOperands() && "Invalid operand number");
 855   getNMDOps(Operands)[I].reset(New);
 856 }
 857
 858 void NamedMDNode::eraseFromParent() {
 859   getParent()->eraseNamedMetadata(this);
 860 }
 861
 862 void NamedMDNode::dropAllReferences() {
 863   getNMDOps(Operands).clear();
 864 }
 865
 866 StringRef NamedMDNode::getName() const {
 867   return StringRef(Name);
 868 }
 869
 870 //===----------------------------------------------------------------------===//
 871 // Instruction Metadata method implementations.
 872 //
 873
 874 void Instruction::setMetadata(StringRef Kind, MDNode *Node) {
 875   if (!Node && !hasMetadata())
 876     return;
 877   setMetadata(getContext().getMDKindID(Kind), Node);
 878 }
 879
 880 MDNode *Instruction::getMetadataImpl(StringRef Kind) const {
 881   return getMetadataImpl(getContext().getMDKindID(Kind));
 882 }
 883
 884 void Instruction::dropUnknownMetadata(ArrayRef<unsigned> KnownIDs) {
 885   SmallSet<unsigned, 5> KnownSet;
 886   KnownSet.insert(KnownIDs.begin(), KnownIDs.end());
 887
 888   // Drop debug if needed
 889   if (KnownSet.erase(LLVMContext::MD_dbg))
 890     DbgLoc = DebugLoc();
 891
 892   if (!hasMetadataHashEntry())
 893     return; // Nothing to remove!
 894
 895   DenseMap<const Instruction *, LLVMContextImpl::MDMapTy> &MetadataStore =
 896       getContext().pImpl->MetadataStore;
 897
 898   if (KnownSet.empty()) {
 899     // Just drop our entry at the store.
 900     MetadataStore.erase(this);
 901     setHasMetadataHashEntry(false);
 902     return;
 903   }
 904
 905   LLVMContextImpl::MDMapTy &Info = MetadataStore[this];
 906   unsigned I;
 907   unsigned E;
 908   // Walk the array and drop any metadata we don't know.
 909   for (I = 0, E = Info.size(); I != E;) {
 910     if (KnownSet.count(Info[I].first)) {
 911       ++I;
 912       continue;
 913     }
 914
 915     Info[I] = std::move(Info.back());
 916     Info.pop_back();
 917     --E;
 918   }
 919   assert(E == Info.size());
 920
 921   if (E == 0) {
 922     // Drop our entry at the store.
 923     MetadataStore.erase(this);
 924     setHasMetadataHashEntry(false);
 925   }
 926 }
 927
 928 /// setMetadata - Set the metadata of of the specified kind to the specified
 929 /// node.  This updates/replaces metadata if already present, or removes it if
 930 /// Node is null.
 931 void Instruction::setMetadata(unsigned KindID, MDNode *Node) {
 932   if (!Node && !hasMetadata())
 933     return;
 934
 935   // Handle 'dbg' as a special case since it is not stored in the hash table.
 936   if (KindID == LLVMContext::MD_dbg) {
 937     DbgLoc = DebugLoc::getFromDILocation(Node);
 938     return;
 939   }
 940
 941   // Handle the case when we're adding/updating metadata on an instruction.
 942   if (Node) {
 943     LLVMContextImpl::MDMapTy &Info = getContext().pImpl->MetadataStore[this];
 944     assert(!Info.empty() == hasMetadataHashEntry() &&
 945            "HasMetadata bit is wonked");
 946     if (Info.empty()) {
 947       setHasMetadataHashEntry(true);
 948     } else {
 949       // Handle replacement of an existing value.
 950       for (auto &P : Info)
 951         if (P.first == KindID) {
 952           P.second.reset(Node);
 953           return;
 954         }
 955     }
 956
 957     // No replacement, just add it to the list.
 958     Info.emplace_back(std::piecewise_construct, std::make_tuple(KindID),
 959                       std::make_tuple(Node));
 960     return;
 961   }
 962
 963   // Otherwise, we're removing metadata from an instruction.
 964   assert((hasMetadataHashEntry() ==
 965           (getContext().pImpl->MetadataStore.count(this) > 0)) &&
 966          "HasMetadata bit out of date!");
 967   if (!hasMetadataHashEntry())
 968     return;  // Nothing to remove!
 969   LLVMContextImpl::MDMapTy &Info = getContext().pImpl->MetadataStore[this];
 970
 971   // Common case is removing the only entry.
 972   if (Info.size() == 1 && Info[0].first == KindID) {
 973     getContext().pImpl->MetadataStore.erase(this);
 974     setHasMetadataHashEntry(false);
 975     return;
 976   }
 977
 978   // Handle removal of an existing value.
 979   for (unsigned i = 0, e = Info.size(); i != e; ++i)
 980     if (Info[i].first == KindID) {
 981       Info[i] = std::move(Info.back());
 982       Info.pop_back();
 983       assert(!Info.empty() && "Removing last entry should be handled above");
 984       return;
 985     }
 986   // Otherwise, removing an entry that doesn't exist on the instruction.
 987 }
 988
 989 void Instruction::setAAMetadata(const AAMDNodes &N) {
 990   setMetadata(LLVMContext::MD_tbaa, N.TBAA);
 991   setMetadata(LLVMContext::MD_alias_scope, N.Scope);
 992   setMetadata(LLVMContext::MD_noalias, N.NoAlias);
 993 }
 994
 995 MDNode *Instruction::getMetadataImpl(unsigned KindID) const {
 996   // Handle 'dbg' as a special case since it is not stored in the hash table.
 997   if (KindID == LLVMContext::MD_dbg)
 998     return DbgLoc.getAsMDNode();
 999
1000   if (!hasMetadataHashEntry()) return nullptr;
1001
1002   LLVMContextImpl::MDMapTy &Info = getContext().pImpl->MetadataStore[this];
1003   assert(!Info.empty() && "bit out of sync with hash table");
1004
1005   for (const auto &I : Info)
1006     if (I.first == KindID)
1007       return I.second;
1008   return nullptr;
1009 }
1010
1011 void Instruction::getAllMetadataImpl(
1012     SmallVectorImpl<std::pair<unsigned, MDNode *>> &Result) const {
1013   Result.clear();
1014
1015   // Handle 'dbg' as a special case since it is not stored in the hash table.
1016   if (!DbgLoc.isUnknown()) {
1017     Result.push_back(
1018         std::make_pair((unsigned)LLVMContext::MD_dbg, DbgLoc.getAsMDNode()));
1019     if (!hasMetadataHashEntry()) return;
1020   }
1021
1022   assert(hasMetadataHashEntry() &&
1023          getContext().pImpl->MetadataStore.count(this) &&
1024          "Shouldn't have called this");
1025   const LLVMContextImpl::MDMapTy &Info =
1026     getContext().pImpl->MetadataStore.find(this)->second;
1027   assert(!Info.empty() && "Shouldn't have called this");
1028
1029   Result.reserve(Result.size() + Info.size());
1030   for (auto &I : Info)
1031     Result.push_back(std::make_pair(I.first, cast<MDNode>(I.second.get())));
1032
1033   // Sort the resulting array so it is stable.
1034   if (Result.size() > 1)
1035     array_pod_sort(Result.begin(), Result.end());
1036 }
1037
1038 void Instruction::getAllMetadataOtherThanDebugLocImpl(
1039     SmallVectorImpl<std::pair<unsigned, MDNode *>> &Result) const {
1040   Result.clear();
1041   assert(hasMetadataHashEntry() &&
1042          getContext().pImpl->MetadataStore.count(this) &&
1043          "Shouldn't have called this");
1044   const LLVMContextImpl::MDMapTy &Info =
1045     getContext().pImpl->MetadataStore.find(this)->second;
1046   assert(!Info.empty() && "Shouldn't have called this");
1047   Result.reserve(Result.size() + Info.size());
1048   for (auto &I : Info)
1049     Result.push_back(std::make_pair(I.first, cast<MDNode>(I.second.get())));
1050
1051   // Sort the resulting array so it is stable.
1052   if (Result.size() > 1)
1053     array_pod_sort(Result.begin(), Result.end());
1054 }
1055
1056 /// clearMetadataHashEntries - Clear all hashtable-based metadata from
1057 /// this instruction.
1058 void Instruction::clearMetadataHashEntries() {
1059   assert(hasMetadataHashEntry() && "Caller should check");
1060   getContext().pImpl->MetadataStore.erase(this);
1061   setHasMetadataHashEntry(false);
1062 }