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