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