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     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(C);
 259     else
 260       Entry = new LocalAsMetadata(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 *O = static_cast<MDOperand *>(Ptr);
 382   for (MDOperand *E = O + NumOps; O != E; ++O)
 383     (void)new (O) MDOperand;
 384   return O;
 385 }
 386
 387 void MDNode::operator delete(void *Mem) {
 388   MDNode *N = static_cast<MDNode *>(Mem);
 389   MDOperand *O = static_cast<MDOperand *>(Mem);
 390   for (MDOperand *E = O - N->NumOperands; O != E; --O)
 391     (O - 1)->~MDOperand();
 392   ::operator delete(O);
 393 }
 394
 395 MDNode::MDNode(LLVMContext &Context, unsigned ID, ArrayRef<Metadata *> MDs)
 396     : Metadata(ID), Context(Context), NumOperands(MDs.size()),
 397       MDNodeSubclassData(0) {
 398   for (unsigned I = 0, E = MDs.size(); I != E; ++I)
 399     setOperand(I, MDs[I]);
 400 }
 401
 402 bool MDNode::isResolved() const {
 403   if (isa<MDNodeFwdDecl>(this))
 404     return false;
 405   return cast<GenericMDNode>(this)->isResolved();
 406 }
 407
 408 static bool isOperandUnresolved(Metadata *Op) {
 409   if (auto *N = dyn_cast_or_null<MDNode>(Op))
 410     return !N->isResolved();
 411   return false;
 412 }
 413
 414 GenericMDNode::GenericMDNode(LLVMContext &C, ArrayRef<Metadata *> Vals,
 415                              bool AllowRAUW)
 416     : MDNode(C, GenericMDNodeKind, Vals) {
 417   if (!AllowRAUW)
 418     return;
 419
 420   // Check whether any operands are unresolved, requiring re-uniquing.
 421   for (const auto &Op : operands())
 422     if (isOperandUnresolved(Op))
 423       incrementUnresolvedOperands();
 424
 425   if (hasUnresolvedOperands())
 426     ReplaceableUses.reset(new ReplaceableMetadataImpl);
 427 }
 428
 429 GenericMDNode::~GenericMDNode() {
 430   LLVMContextImpl *pImpl = getContext().pImpl;
 431   if (isStoredDistinctInContext())
 432     pImpl->NonUniquedMDNodes.erase(this);
 433   else
 434     pImpl->MDNodeSet.erase(this);
 435   dropAllReferences();
 436 }
 437
 438 void GenericMDNode::resolve() {
 439   assert(!isResolved() && "Expected this to be unresolved");
 440
 441   // Move the map, so that this immediately looks resolved.
 442   auto Uses = std::move(ReplaceableUses);
 443   SubclassData32 = 0;
 444   assert(isResolved() && "Expected this to be resolved");
 445
 446   // Drop RAUW support.
 447   Uses->resolveAllUses();
 448 }
 449
 450 void GenericMDNode::resolveCycles() {
 451   if (isResolved())
 452     return;
 453
 454   // Resolve this node immediately.
 455   resolve();
 456
 457   // Resolve all operands.
 458   for (const auto &Op : operands()) {
 459     if (!Op)
 460       continue;
 461     assert(!isa<MDNodeFwdDecl>(Op) &&
 462            "Expected all forward declarations to be resolved");
 463     if (auto *N = dyn_cast<GenericMDNode>(Op))
 464       if (!N->isResolved())
 465         N->resolveCycles();
 466   }
 467 }
 468
 469 void MDNode::dropAllReferences() {
 470   for (unsigned I = 0, E = NumOperands; I != E; ++I)
 471     setOperand(I, nullptr);
 472   if (auto *G = dyn_cast<GenericMDNode>(this))
 473     if (!G->isResolved()) {
 474       G->ReplaceableUses->resolveAllUses(/* ResolveUsers */ false);
 475       G->ReplaceableUses.reset();
 476     }
 477 }
 478
 479 namespace llvm {
 480 /// \brief Make MDOperand transparent for hashing.
 481 ///
 482 /// This overload of an implementation detail of the hashing library makes
 483 /// MDOperand hash to the same value as a \a Metadata pointer.
 484 ///
 485 /// Note that overloading \a hash_value() as follows:
 486 ///
 487 /// \code
 488 ///     size_t hash_value(const MDOperand &X) { return hash_value(X.get()); }
 489 /// \endcode
 490 ///
 491 /// does not cause MDOperand to be transparent.  In particular, a bare pointer
 492 /// doesn't get hashed before it's combined, whereas \a MDOperand would.
 493 static const Metadata *get_hashable_data(const MDOperand &X) { return X.get(); }
 494 }
 495
 496 void GenericMDNode::handleChangedOperand(void *Ref, Metadata *New) {
 497   unsigned Op = static_cast<MDOperand *>(Ref) - op_begin();
 498   assert(Op < getNumOperands() && "Expected valid operand");
 499
 500   if (isStoredDistinctInContext()) {
 501     assert(isResolved() && "Expected distinct node to be resolved");
 502
 503     // This node is not uniqued.  Just set the operand and be done with it.
 504     setOperand(Op, New);
 505     return;
 506   }
 507   if (InRAUW) {
 508     // We just hit a recursion due to RAUW.  Set the operand and move on, since
 509     // we're about to be deleted.
 510     //
 511     // FIXME: Can this cycle really happen?
 512     setOperand(Op, New);
 513     return;
 514   }
 515
 516   auto &Store = getContext().pImpl->MDNodeSet;
 517   Store.erase(this);
 518
 519   Metadata *Old = getOperand(Op);
 520   setOperand(Op, New);
 521
 522   // Drop uniquing for self-reference cycles.
 523   if (New == this) {
 524     storeDistinctInContext();
 525     if (!isResolved())
 526       resolve();
 527     return;
 528   }
 529
 530   // Re-calculate the hash.
 531   setHash(hash_combine_range(op_begin(), op_end()));
 532 #ifndef NDEBUG
 533   {
 534     SmallVector<Metadata *, 8> MDs(op_begin(), op_end());
 535     unsigned RawHash = hash_combine_range(MDs.begin(), MDs.end());
 536     assert(getHash() == RawHash &&
 537            "Expected hash of MDOperand to equal hash of Metadata*");
 538   }
 539 #endif
 540
 541   // Re-unique the node.
 542   GenericMDNodeInfo::KeyTy Key(this);
 543   auto I = Store.find_as(Key);
 544   if (I == Store.end()) {
 545     Store.insert(this);
 546
 547     if (!isResolved()) {
 548       // Check if the last unresolved operand has just been resolved; if so,
 549       // resolve this as well.
 550       if (isOperandUnresolved(Old)) {
 551         if (!isOperandUnresolved(New)) {
 552           decrementUnresolvedOperands();
 553           if (!hasUnresolvedOperands())
 554             resolve();
 555         }
 556       } else {
 557         // Operands shouldn't become unresolved.
 558         assert(isOperandUnresolved(New) && "Operand just became unresolved");
 559       }
 560     }
 561
 562     return;
 563   }
 564
 565   // Collision.
 566   if (!isResolved()) {
 567     // Still unresolved, so RAUW.
 568     InRAUW = true;
 569     ReplaceableUses->replaceAllUsesWith(*I);
 570     delete this;
 571     return;
 572   }
 573
 574   // Store in non-uniqued form if this node has already been resolved.
 575   storeDistinctInContext();
 576 }
 577
 578 MDNode *MDNode::getMDNode(LLVMContext &Context, ArrayRef<Metadata *> MDs,
 579                           bool Insert) {
 580   auto &Store = Context.pImpl->MDNodeSet;
 581
 582   GenericMDNodeInfo::KeyTy Key(MDs);
 583   auto I = Store.find_as(Key);
 584   if (I != Store.end())
 585     return *I;
 586   if (!Insert)
 587     return nullptr;
 588
 589   // Coallocate space for the node and Operands together, then placement new.
 590   auto *N = new (MDs.size()) GenericMDNode(Context, MDs, /* AllowRAUW */ true);
 591   N->setHash(Key.Hash);
 592   Store.insert(N);
 593   return N;
 594 }
 595
 596 MDNode *MDNode::getDistinct(LLVMContext &Context, ArrayRef<Metadata *> MDs) {
 597   auto *N = new (MDs.size()) GenericMDNode(Context, MDs, /* AllowRAUW */ false);
 598   N->storeDistinctInContext();
 599   return N;
 600 }
 601
 602 MDNodeFwdDecl *MDNode::getTemporary(LLVMContext &Context,
 603                                     ArrayRef<Metadata *> MDs) {
 604   MDNodeFwdDecl *N = new (MDs.size()) MDNodeFwdDecl(Context, MDs);
 605   return N;
 606 }
 607
 608 void MDNode::deleteTemporary(MDNode *N) {
 609   assert(isa<MDNodeFwdDecl>(N) && "Expected forward declaration");
 610   delete cast<MDNodeFwdDecl>(N);
 611 }
 612
 613 void MDNode::storeDistinctInContext() {
 614   assert(!IsDistinctInContext && "Expected newly distinct metadata");
 615   IsDistinctInContext = true;
 616   auto *G = cast<GenericMDNode>(this);
 617   G->setHash(0);
 618   getContext().pImpl->NonUniquedMDNodes.insert(G);
 619 }
 620
 621 void MDNode::replaceOperandWith(unsigned I, Metadata *New) {
 622   if (getOperand(I) == New)
 623     return;
 624
 625   if (isDistinct()) {
 626     setOperand(I, New);
 627     return;
 628   }
 629
 630   cast<GenericMDNode>(this)->handleChangedOperand(mutable_begin() + I, New);
 631 }
 632
 633 void MDNode::setOperand(unsigned I, Metadata *New) {
 634   assert(I < NumOperands);
 635   if (isStoredDistinctInContext() || isa<MDNodeFwdDecl>(this))
 636     // No need for a callback, this isn't uniqued.
 637     mutable_begin()[I].reset(New, nullptr);
 638   else
 639     mutable_begin()[I].reset(New, this);
 640 }
 641
 642 /// \brief Get a node, or a self-reference that looks like it.
 643 ///
 644 /// Special handling for finding self-references, for use by \a
 645 /// MDNode::concatenate() and \a MDNode::intersect() to maintain behaviour from
 646 /// when self-referencing nodes were still uniqued.  If the first operand has
 647 /// the same operands as \c Ops, return the first operand instead.
 648 static MDNode *getOrSelfReference(LLVMContext &Context,
 649                                   ArrayRef<Metadata *> Ops) {
 650   if (!Ops.empty())
 651     if (MDNode *N = dyn_cast_or_null<MDNode>(Ops[0]))
 652       if (N->getNumOperands() == Ops.size() && N == N->getOperand(0)) {
 653         for (unsigned I = 1, E = Ops.size(); I != E; ++I)
 654           if (Ops[I] != N->getOperand(I))
 655             return MDNode::get(Context, Ops);
 656         return N;
 657       }
 658
 659   return MDNode::get(Context, Ops);
 660 }
 661
 662 MDNode *MDNode::concatenate(MDNode *A, MDNode *B) {
 663   if (!A)
 664     return B;
 665   if (!B)
 666     return A;
 667
 668   SmallVector<Metadata *, 4> MDs(A->getNumOperands() + B->getNumOperands());
 669
 670   unsigned j = 0;
 671   for (unsigned i = 0, ie = A->getNumOperands(); i != ie; ++i)
 672     MDs[j++] = A->getOperand(i);
 673   for (unsigned i = 0, ie = B->getNumOperands(); i != ie; ++i)
 674     MDs[j++] = B->getOperand(i);
 675
 676   // FIXME: This preserves long-standing behaviour, but is it really the right
 677   // behaviour?  Or was that an unintended side-effect of node uniquing?
 678   return getOrSelfReference(A->getContext(), MDs);
 679 }
 680
 681 MDNode *MDNode::intersect(MDNode *A, MDNode *B) {
 682   if (!A || !B)
 683     return nullptr;
 684
 685   SmallVector<Metadata *, 4> MDs;
 686   for (unsigned i = 0, ie = A->getNumOperands(); i != ie; ++i) {
 687     Metadata *MD = A->getOperand(i);
 688     for (unsigned j = 0, je = B->getNumOperands(); j != je; ++j)
 689       if (MD == B->getOperand(j)) {
 690         MDs.push_back(MD);
 691         break;
 692       }
 693   }
 694
 695   // FIXME: This preserves long-standing behaviour, but is it really the right
 696   // behaviour?  Or was that an unintended side-effect of node uniquing?
 697   return getOrSelfReference(A->getContext(), MDs);
 698 }
 699
 700 MDNode *MDNode::getMostGenericFPMath(MDNode *A, MDNode *B) {
 701   if (!A || !B)
 702     return nullptr;
 703
 704   APFloat AVal = mdconst::extract<ConstantFP>(A->getOperand(0))->getValueAPF();
 705   APFloat BVal = mdconst::extract<ConstantFP>(B->getOperand(0))->getValueAPF();
 706   if (AVal.compare(BVal) == APFloat::cmpLessThan)
 707     return A;
 708   return B;
 709 }
 710
 711 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
 712   return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
 713 }
 714
 715 static bool canBeMerged(const ConstantRange &A, const ConstantRange &B) {
 716   return !A.intersectWith(B).isEmptySet() || isContiguous(A, B);
 717 }
 718
 719 static bool tryMergeRange(SmallVectorImpl<ConstantInt *> &EndPoints,
 720                           ConstantInt *Low, ConstantInt *High) {
 721   ConstantRange NewRange(Low->getValue(), High->getValue());
 722   unsigned Size = EndPoints.size();
 723   APInt LB = EndPoints[Size - 2]->getValue();
 724   APInt LE = EndPoints[Size - 1]->getValue();
 725   ConstantRange LastRange(LB, LE);
 726   if (canBeMerged(NewRange, LastRange)) {
 727     ConstantRange Union = LastRange.unionWith(NewRange);
 728     Type *Ty = High->getType();
 729     EndPoints[Size - 2] =
 730         cast<ConstantInt>(ConstantInt::get(Ty, Union.getLower()));
 731     EndPoints[Size - 1] =
 732         cast<ConstantInt>(ConstantInt::get(Ty, Union.getUpper()));
 733     return true;
 734   }
 735   return false;
 736 }
 737
 738 static void addRange(SmallVectorImpl<ConstantInt *> &EndPoints,
 739                      ConstantInt *Low, ConstantInt *High) {
 740   if (!EndPoints.empty())
 741     if (tryMergeRange(EndPoints, Low, High))
 742       return;
 743
 744   EndPoints.push_back(Low);
 745   EndPoints.push_back(High);
 746 }
 747
 748 MDNode *MDNode::getMostGenericRange(MDNode *A, MDNode *B) {
 749   // Given two ranges, we want to compute the union of the ranges. This
 750   // is slightly complitade by having to combine the intervals and merge
 751   // the ones that overlap.
 752
 753   if (!A || !B)
 754     return nullptr;
 755
 756   if (A == B)
 757     return A;
 758
 759   // First, walk both lists in older of the lower boundary of each interval.
 760   // At each step, try to merge the new interval to the last one we adedd.
 761   SmallVector<ConstantInt *, 4> EndPoints;
 762   int AI = 0;
 763   int BI = 0;
 764   int AN = A->getNumOperands() / 2;
 765   int BN = B->getNumOperands() / 2;
 766   while (AI < AN && BI < BN) {
 767     ConstantInt *ALow = mdconst::extract<ConstantInt>(A->getOperand(2 * AI));
 768     ConstantInt *BLow = mdconst::extract<ConstantInt>(B->getOperand(2 * BI));
 769
 770     if (ALow->getValue().slt(BLow->getValue())) {
 771       addRange(EndPoints, ALow,
 772                mdconst::extract<ConstantInt>(A->getOperand(2 * AI + 1)));
 773       ++AI;
 774     } else {
 775       addRange(EndPoints, BLow,
 776                mdconst::extract<ConstantInt>(B->getOperand(2 * BI + 1)));
 777       ++BI;
 778     }
 779   }
 780   while (AI < AN) {
 781     addRange(EndPoints, mdconst::extract<ConstantInt>(A->getOperand(2 * AI)),
 782              mdconst::extract<ConstantInt>(A->getOperand(2 * AI + 1)));
 783     ++AI;
 784   }
 785   while (BI < BN) {
 786     addRange(EndPoints, mdconst::extract<ConstantInt>(B->getOperand(2 * BI)),
 787              mdconst::extract<ConstantInt>(B->getOperand(2 * BI + 1)));
 788     ++BI;
 789   }
 790
 791   // If we have more than 2 ranges (4 endpoints) we have to try to merge
 792   // the last and first ones.
 793   unsigned Size = EndPoints.size();
 794   if (Size > 4) {
 795     ConstantInt *FB = EndPoints[0];
 796     ConstantInt *FE = EndPoints[1];
 797     if (tryMergeRange(EndPoints, FB, FE)) {
 798       for (unsigned i = 0; i < Size - 2; ++i) {
 799         EndPoints[i] = EndPoints[i + 2];
 800       }
 801       EndPoints.resize(Size - 2);
 802     }
 803   }
 804
 805   // If in the end we have a single range, it is possible that it is now the
 806   // full range. Just drop the metadata in that case.
 807   if (EndPoints.size() == 2) {
 808     ConstantRange Range(EndPoints[0]->getValue(), EndPoints[1]->getValue());
 809     if (Range.isFullSet())
 810       return nullptr;
 811   }
 812
 813   SmallVector<Metadata *, 4> MDs;
 814   MDs.reserve(EndPoints.size());
 815   for (auto *I : EndPoints)
 816     MDs.push_back(ConstantAsMetadata::get(I));
 817   return MDNode::get(A->getContext(), MDs);
 818 }
 819
 820 //===----------------------------------------------------------------------===//
 821 // NamedMDNode implementation.
 822 //
 823
 824 static SmallVector<TrackingMDRef, 4> &getNMDOps(void *Operands) {
 825   return *(SmallVector<TrackingMDRef, 4> *)Operands;
 826 }
 827
 828 NamedMDNode::NamedMDNode(const Twine &N)
 829     : Name(N.str()), Parent(nullptr),
 830       Operands(new SmallVector<TrackingMDRef, 4>()) {}
 831
 832 NamedMDNode::~NamedMDNode() {
 833   dropAllReferences();
 834   delete &getNMDOps(Operands);
 835 }
 836
 837 unsigned NamedMDNode::getNumOperands() const {
 838   return (unsigned)getNMDOps(Operands).size();
 839 }
 840
 841 MDNode *NamedMDNode::getOperand(unsigned i) const {
 842   assert(i < getNumOperands() && "Invalid Operand number!");
 843   auto *N = getNMDOps(Operands)[i].get();
 844   return cast_or_null<MDNode>(N);
 845 }
 846
 847 void NamedMDNode::addOperand(MDNode *M) { getNMDOps(Operands).emplace_back(M); }
 848
 849 void NamedMDNode::setOperand(unsigned I, MDNode *New) {
 850   assert(I < getNumOperands() && "Invalid operand number");
 851   getNMDOps(Operands)[I].reset(New);
 852 }
 853
 854 void NamedMDNode::eraseFromParent() {
 855   getParent()->eraseNamedMetadata(this);
 856 }
 857
 858 void NamedMDNode::dropAllReferences() {
 859   getNMDOps(Operands).clear();
 860 }
 861
 862 StringRef NamedMDNode::getName() const {
 863   return StringRef(Name);
 864 }
 865
 866 //===----------------------------------------------------------------------===//
 867 // Instruction Metadata method implementations.
 868 //
 869
 870 void Instruction::setMetadata(StringRef Kind, MDNode *Node) {
 871   if (!Node && !hasMetadata())
 872     return;
 873   setMetadata(getContext().getMDKindID(Kind), Node);
 874 }
 875
 876 MDNode *Instruction::getMetadataImpl(StringRef Kind) const {
 877   return getMetadataImpl(getContext().getMDKindID(Kind));
 878 }
 879
 880 void Instruction::dropUnknownMetadata(ArrayRef<unsigned> KnownIDs) {
 881   SmallSet<unsigned, 5> KnownSet;
 882   KnownSet.insert(KnownIDs.begin(), KnownIDs.end());
 883
 884   // Drop debug if needed
 885   if (KnownSet.erase(LLVMContext::MD_dbg))
 886     DbgLoc = DebugLoc();
 887
 888   if (!hasMetadataHashEntry())
 889     return; // Nothing to remove!
 890
 891   DenseMap<const Instruction *, LLVMContextImpl::MDMapTy> &MetadataStore =
 892       getContext().pImpl->MetadataStore;
 893
 894   if (KnownSet.empty()) {
 895     // Just drop our entry at the store.
 896     MetadataStore.erase(this);
 897     setHasMetadataHashEntry(false);
 898     return;
 899   }
 900
 901   LLVMContextImpl::MDMapTy &Info = MetadataStore[this];
 902   unsigned I;
 903   unsigned E;
 904   // Walk the array and drop any metadata we don't know.
 905   for (I = 0, E = Info.size(); I != E;) {
 906     if (KnownSet.count(Info[I].first)) {
 907       ++I;
 908       continue;
 909     }
 910
 911     Info[I] = std::move(Info.back());
 912     Info.pop_back();
 913     --E;
 914   }
 915   assert(E == Info.size());
 916
 917   if (E == 0) {
 918     // Drop our entry at the store.
 919     MetadataStore.erase(this);
 920     setHasMetadataHashEntry(false);
 921   }
 922 }
 923
 924 /// setMetadata - Set the metadata of of the specified kind to the specified
 925 /// node.  This updates/replaces metadata if already present, or removes it if
 926 /// Node is null.
 927 void Instruction::setMetadata(unsigned KindID, MDNode *Node) {
 928   if (!Node && !hasMetadata())
 929     return;
 930
 931   // Handle 'dbg' as a special case since it is not stored in the hash table.
 932   if (KindID == LLVMContext::MD_dbg) {
 933     DbgLoc = DebugLoc::getFromDILocation(Node);
 934     return;
 935   }
 936
 937   // Handle the case when we're adding/updating metadata on an instruction.
 938   if (Node) {
 939     LLVMContextImpl::MDMapTy &Info = getContext().pImpl->MetadataStore[this];
 940     assert(!Info.empty() == hasMetadataHashEntry() &&
 941            "HasMetadata bit is wonked");
 942     if (Info.empty()) {
 943       setHasMetadataHashEntry(true);
 944     } else {
 945       // Handle replacement of an existing value.
 946       for (auto &P : Info)
 947         if (P.first == KindID) {
 948           P.second.reset(Node);
 949           return;
 950         }
 951     }
 952
 953     // No replacement, just add it to the list.
 954     Info.emplace_back(std::piecewise_construct, std::make_tuple(KindID),
 955                       std::make_tuple(Node));
 956     return;
 957   }
 958
 959   // Otherwise, we're removing metadata from an instruction.
 960   assert((hasMetadataHashEntry() ==
 961           (getContext().pImpl->MetadataStore.count(this) > 0)) &&
 962          "HasMetadata bit out of date!");
 963   if (!hasMetadataHashEntry())
 964     return;  // Nothing to remove!
 965   LLVMContextImpl::MDMapTy &Info = getContext().pImpl->MetadataStore[this];
 966
 967   // Common case is removing the only entry.
 968   if (Info.size() == 1 && Info[0].first == KindID) {
 969     getContext().pImpl->MetadataStore.erase(this);
 970     setHasMetadataHashEntry(false);
 971     return;
 972   }
 973
 974   // Handle removal of an existing value.
 975   for (unsigned i = 0, e = Info.size(); i != e; ++i)
 976     if (Info[i].first == KindID) {
 977       Info[i] = std::move(Info.back());
 978       Info.pop_back();
 979       assert(!Info.empty() && "Removing last entry should be handled above");
 980       return;
 981     }
 982   // Otherwise, removing an entry that doesn't exist on the instruction.
 983 }
 984
 985 void Instruction::setAAMetadata(const AAMDNodes &N) {
 986   setMetadata(LLVMContext::MD_tbaa, N.TBAA);
 987   setMetadata(LLVMContext::MD_alias_scope, N.Scope);
 988   setMetadata(LLVMContext::MD_noalias, N.NoAlias);
 989 }
 990
 991 MDNode *Instruction::getMetadataImpl(unsigned KindID) const {
 992   // Handle 'dbg' as a special case since it is not stored in the hash table.
 993   if (KindID == LLVMContext::MD_dbg)
 994     return DbgLoc.getAsMDNode();
 995
 996   if (!hasMetadataHashEntry()) return nullptr;
 997
 998   LLVMContextImpl::MDMapTy &Info = getContext().pImpl->MetadataStore[this];
 999   assert(!Info.empty() && "bit out of sync with hash table");
1000
1001   for (const auto &I : Info)
1002     if (I.first == KindID)
1003       return I.second;
1004   return nullptr;
1005 }
1006
1007 void Instruction::getAllMetadataImpl(
1008     SmallVectorImpl<std::pair<unsigned, MDNode *>> &Result) const {
1009   Result.clear();
1010
1011   // Handle 'dbg' as a special case since it is not stored in the hash table.
1012   if (!DbgLoc.isUnknown()) {
1013     Result.push_back(
1014         std::make_pair((unsigned)LLVMContext::MD_dbg, DbgLoc.getAsMDNode()));
1015     if (!hasMetadataHashEntry()) return;
1016   }
1017
1018   assert(hasMetadataHashEntry() &&
1019          getContext().pImpl->MetadataStore.count(this) &&
1020          "Shouldn't have called this");
1021   const LLVMContextImpl::MDMapTy &Info =
1022     getContext().pImpl->MetadataStore.find(this)->second;
1023   assert(!Info.empty() && "Shouldn't have called this");
1024
1025   Result.reserve(Result.size() + Info.size());
1026   for (auto &I : Info)
1027     Result.push_back(std::make_pair(I.first, cast<MDNode>(I.second.get())));
1028
1029   // Sort the resulting array so it is stable.
1030   if (Result.size() > 1)
1031     array_pod_sort(Result.begin(), Result.end());
1032 }
1033
1034 void Instruction::getAllMetadataOtherThanDebugLocImpl(
1035     SmallVectorImpl<std::pair<unsigned, MDNode *>> &Result) const {
1036   Result.clear();
1037   assert(hasMetadataHashEntry() &&
1038          getContext().pImpl->MetadataStore.count(this) &&
1039          "Shouldn't have called this");
1040   const LLVMContextImpl::MDMapTy &Info =
1041     getContext().pImpl->MetadataStore.find(this)->second;
1042   assert(!Info.empty() && "Shouldn't have called this");
1043   Result.reserve(Result.size() + Info.size());
1044   for (auto &I : Info)
1045     Result.push_back(std::make_pair(I.first, cast<MDNode>(I.second.get())));
1046
1047   // Sort the resulting array so it is stable.
1048   if (Result.size() > 1)
1049     array_pod_sort(Result.begin(), Result.end());
1050 }
1051
1052 /// clearMetadataHashEntries - Clear all hashtable-based metadata from
1053 /// this instruction.
1054 void Instruction::clearMetadataHashEntries() {
1055   assert(hasMetadataHashEntry() && "Caller should check");
1056   getContext().pImpl->MetadataStore.erase(this);
1057   setHasMetadataHashEntry(false);
1058 }