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