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