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