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 (Storage == Temporary)
 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 (Storage != Uniqued)
 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(!isResolved() && "Expected this to be unresolved");
 436
 437   // Move the map, so that this immediately looks resolved.
 438   auto Uses = Context.takeReplaceableUses();
 439   SubclassData32 = 0;
 440   assert(isResolved() && "Expected this to be resolved");
 441
 442   // Drop RAUW support.
 443   Uses->resolveAllUses();
 444 }
 445
 446 void UniquableMDNode::resolveAfterOperandChange(Metadata *Old, Metadata *New) {
 447   assert(SubclassData32 != 0 && "Expected unresolved operands");
 448
 449   // Check if an operand was resolved.
 450   if (!isOperandUnresolved(Old)) {
 451     if (isOperandUnresolved(New))
 452       // An operand was un-resolved!
 453       ++SubclassData32;
 454   } else if (!isOperandUnresolved(New))
 455     decrementUnresolvedOperandCount();
 456 }
 457
 458 void UniquableMDNode::decrementUnresolvedOperandCount() {
 459   if (!--SubclassData32)
 460     // Last unresolved operand has just been resolved.
 461     resolve();
 462 }
 463
 464 void UniquableMDNode::resolveCycles() {
 465   if (isResolved())
 466     return;
 467
 468   // Resolve this node immediately.
 469   resolve();
 470
 471   // Resolve all operands.
 472   for (const auto &Op : operands()) {
 473     if (!Op)
 474       continue;
 475     assert(!isa<MDNodeFwdDecl>(Op) &&
 476            "Expected all forward declarations to be resolved");
 477     if (auto *N = dyn_cast<UniquableMDNode>(Op))
 478       if (!N->isResolved())
 479         N->resolveCycles();
 480   }
 481 }
 482
 483 void MDTuple::recalculateHash() {
 484   setHash(hash_combine_range(op_begin(), op_end()));
 485 #ifndef NDEBUG
 486   {
 487     SmallVector<Metadata *, 8> MDs(op_begin(), op_end());
 488     unsigned RawHash = hash_combine_range(MDs.begin(), MDs.end());
 489     assert(getHash() == RawHash &&
 490            "Expected hash of MDOperand to equal hash of Metadata*");
 491   }
 492 #endif
 493 }
 494
 495 void MDNode::dropAllReferences() {
 496   for (unsigned I = 0, E = NumOperands; I != E; ++I)
 497     setOperand(I, nullptr);
 498   if (auto *N = dyn_cast<UniquableMDNode>(this))
 499     if (!N->isResolved()) {
 500       N->Context.getReplaceableUses()->resolveAllUses(/* ResolveUsers */ false);
 501       (void)N->Context.takeReplaceableUses();
 502     }
 503 }
 504
 505 namespace llvm {
 506 /// \brief Make MDOperand transparent for hashing.
 507 ///
 508 /// This overload of an implementation detail of the hashing library makes
 509 /// MDOperand hash to the same value as a \a Metadata pointer.
 510 ///
 511 /// Note that overloading \a hash_value() as follows:
 512 ///
 513 /// \code
 514 ///     size_t hash_value(const MDOperand &X) { return hash_value(X.get()); }
 515 /// \endcode
 516 ///
 517 /// does not cause MDOperand to be transparent.  In particular, a bare pointer
 518 /// doesn't get hashed before it's combined, whereas \a MDOperand would.
 519 static const Metadata *get_hashable_data(const MDOperand &X) { return X.get(); }
 520 }
 521
 522 void UniquableMDNode::handleChangedOperand(void *Ref, Metadata *New) {
 523   unsigned Op = static_cast<MDOperand *>(Ref) - op_begin();
 524   assert(Op < getNumOperands() && "Expected valid operand");
 525
 526   if (isStoredDistinctInContext()) {
 527     assert(isResolved() && "Expected distinct node to be resolved");
 528
 529     // This node is not uniqued.  Just set the operand and be done with it.
 530     setOperand(Op, New);
 531     return;
 532   }
 533
 534   // This node is uniqued.
 535   eraseFromStore();
 536
 537   Metadata *Old = getOperand(Op);
 538   setOperand(Op, New);
 539
 540   // Drop uniquing for self-reference cycles.
 541   if (New == this) {
 542     storeDistinctInContext();
 543     if (!isResolved())
 544       resolve();
 545     return;
 546   }
 547
 548   // Re-unique the node.
 549   auto *Uniqued = uniquify();
 550   if (Uniqued == this) {
 551     if (!isResolved())
 552       resolveAfterOperandChange(Old, New);
 553     return;
 554   }
 555
 556   // Collision.
 557   if (!isResolved()) {
 558     // Still unresolved, so RAUW.
 559     //
 560     // First, clear out all operands to prevent any recursion (similar to
 561     // dropAllReferences(), but we still need the use-list).
 562     for (unsigned O = 0, E = getNumOperands(); O != E; ++O)
 563       setOperand(O, nullptr);
 564     Context.getReplaceableUses()->replaceAllUsesWith(Uniqued);
 565     deleteAsSubclass();
 566     return;
 567   }
 568
 569   // Store in non-uniqued form if RAUW isn't possible.
 570   storeDistinctInContext();
 571 }
 572
 573 void UniquableMDNode::deleteAsSubclass() {
 574   switch (getMetadataID()) {
 575   default:
 576     llvm_unreachable("Invalid subclass of UniquableMDNode");
 577 #define HANDLE_UNIQUABLE_LEAF(CLASS)                                           \
 578   case CLASS##Kind:                                                            \
 579     delete cast<CLASS>(this);                                                  \
 580     break;
 581 #include "llvm/IR/Metadata.def"
 582   }
 583 }
 584
 585 UniquableMDNode *UniquableMDNode::uniquify() {
 586   switch (getMetadataID()) {
 587   default:
 588     llvm_unreachable("Invalid subclass of UniquableMDNode");
 589 #define HANDLE_UNIQUABLE_LEAF(CLASS)                                           \
 590   case CLASS##Kind:                                                            \
 591     return cast<CLASS>(this)->uniquifyImpl();
 592 #include "llvm/IR/Metadata.def"
 593   }
 594 }
 595
 596 void UniquableMDNode::eraseFromStore() {
 597   switch (getMetadataID()) {
 598   default:
 599     llvm_unreachable("Invalid subclass of UniquableMDNode");
 600 #define HANDLE_UNIQUABLE_LEAF(CLASS)                                           \
 601   case CLASS##Kind:                                                            \
 602     cast<CLASS>(this)->eraseFromStoreImpl();                                   \
 603     break;
 604 #include "llvm/IR/Metadata.def"
 605   }
 606 }
 607
 608 MDTuple *MDTuple::getImpl(LLVMContext &Context, ArrayRef<Metadata *> MDs,
 609                           bool ShouldCreate) {
 610   MDTupleInfo::KeyTy Key(MDs);
 611
 612   auto &Store = Context.pImpl->MDTuples;
 613   auto I = Store.find_as(Key);
 614   if (I != Store.end())
 615     return *I;
 616   if (!ShouldCreate)
 617     return nullptr;
 618
 619   // Coallocate space for the node and Operands together, then placement new.
 620   auto *N = new (MDs.size()) MDTuple(Context, Uniqued, MDs);
 621   N->setHash(Key.Hash);
 622   Store.insert(N);
 623   return N;
 624 }
 625
 626 MDTuple *MDTuple::getDistinct(LLVMContext &Context, ArrayRef<Metadata *> MDs) {
 627   auto *N = new (MDs.size()) MDTuple(Context, Distinct, MDs);
 628   N->storeDistinctInContext();
 629   return N;
 630 }
 631
 632 MDTuple *MDTuple::uniquifyImpl() {
 633   recalculateHash();
 634   MDTupleInfo::KeyTy Key(this);
 635
 636   auto &Store = getContext().pImpl->MDTuples;
 637   auto I = Store.find_as(Key);
 638   if (I == Store.end()) {
 639     Store.insert(this);
 640     return this;
 641   }
 642   return *I;
 643 }
 644
 645 void MDTuple::eraseFromStoreImpl() { getContext().pImpl->MDTuples.erase(this); }
 646
 647 MDLocation::MDLocation(LLVMContext &C, StorageType Storage, unsigned Line,
 648                        unsigned Column, ArrayRef<Metadata *> MDs)
 649     : UniquableMDNode(C, MDLocationKind, Storage, MDs) {
 650   assert((MDs.size() == 1 || MDs.size() == 2) &&
 651          "Expected a scope and optional inlined-at");
 652
 653   // Set line and column.
 654   assert(Line < (1u << 24) && "Expected 24-bit line");
 655   assert(Column < (1u << 16) && "Expected 16-bit column");
 656
 657   MDNodeSubclassData = Line;
 658   SubclassData16 = Column;
 659 }
 660
 661 MDLocation *MDLocation::constructHelper(LLVMContext &Context,
 662                                         StorageType Storage, unsigned Line,
 663                                         unsigned Column, Metadata *Scope,
 664                                         Metadata *InlinedAt) {
 665   SmallVector<Metadata *, 2> Ops;
 666   Ops.push_back(Scope);
 667   if (InlinedAt)
 668     Ops.push_back(InlinedAt);
 669   return new (Ops.size()) MDLocation(Context, Storage, Line, Column, Ops);
 670 }
 671
 672 static void adjustLine(unsigned &Line) {
 673   // Set to unknown on overflow.  Still use 24 bits for now.
 674   if (Line >= (1u << 24))
 675     Line = 0;
 676 }
 677
 678 static void adjustColumn(unsigned &Column) {
 679   // Set to unknown on overflow.  We only have 16 bits to play with here.
 680   if (Column >= (1u << 16))
 681     Column = 0;
 682 }
 683
 684 MDLocation *MDLocation::getImpl(LLVMContext &Context, unsigned Line,
 685                                 unsigned Column, Metadata *Scope,
 686                                 Metadata *InlinedAt, bool ShouldCreate) {
 687   // Fixup line/column.
 688   adjustLine(Line);
 689   adjustColumn(Column);
 690
 691   MDLocationInfo::KeyTy Key(Line, Column, Scope, InlinedAt);
 692
 693   auto &Store = Context.pImpl->MDLocations;
 694   auto I = Store.find_as(Key);
 695   if (I != Store.end())
 696     return *I;
 697   if (!ShouldCreate)
 698     return nullptr;
 699
 700   auto *N = constructHelper(Context, Uniqued, Line, Column, Scope, InlinedAt);
 701   Store.insert(N);
 702   return N;
 703 }
 704
 705 MDLocation *MDLocation::getDistinct(LLVMContext &Context, unsigned Line,
 706                                     unsigned Column, Metadata *Scope,
 707                                     Metadata *InlinedAt) {
 708   // Fixup line/column.
 709   adjustLine(Line);
 710   adjustColumn(Column);
 711
 712   auto *N = constructHelper(Context, Distinct, Line, Column, Scope, InlinedAt);
 713   N->storeDistinctInContext();
 714   return N;
 715 }
 716
 717 MDLocation *MDLocation::uniquifyImpl() {
 718   MDLocationInfo::KeyTy Key(this);
 719
 720   auto &Store = getContext().pImpl->MDLocations;
 721   auto I = Store.find_as(Key);
 722   if (I == Store.end()) {
 723     Store.insert(this);
 724     return this;
 725   }
 726   return *I;
 727 }
 728
 729 void MDLocation::eraseFromStoreImpl() {
 730   getContext().pImpl->MDLocations.erase(this);
 731 }
 732
 733 MDNodeFwdDecl *MDNode::getTemporary(LLVMContext &Context,
 734                                     ArrayRef<Metadata *> MDs) {
 735   return MDNodeFwdDecl::get(Context, MDs);
 736 }
 737
 738 void MDNode::deleteTemporary(MDNode *N) { delete cast<MDNodeFwdDecl>(N); }
 739
 740 void UniquableMDNode::storeDistinctInContext() {
 741   Storage = Distinct;
 742   if (auto *T = dyn_cast<MDTuple>(this))
 743     T->setHash(0);
 744   getContext().pImpl->DistinctMDNodes.insert(this);
 745 }
 746
 747 void MDNode::replaceOperandWith(unsigned I, Metadata *New) {
 748   if (getOperand(I) == New)
 749     return;
 750
 751   if (!isUniqued()) {
 752     setOperand(I, New);
 753     return;
 754   }
 755
 756   cast<UniquableMDNode>(this)->handleChangedOperand(mutable_begin() + I, New);
 757 }
 758
 759 void MDNode::setOperand(unsigned I, Metadata *New) {
 760   assert(I < NumOperands);
 761   if (isStoredDistinctInContext() || isa<MDNodeFwdDecl>(this))
 762     // No need for a callback, this isn't uniqued.
 763     mutable_begin()[I].reset(New, nullptr);
 764   else
 765     mutable_begin()[I].reset(New, this);
 766 }
 767
 768 /// \brief Get a node, or a self-reference that looks like it.
 769 ///
 770 /// Special handling for finding self-references, for use by \a
 771 /// MDNode::concatenate() and \a MDNode::intersect() to maintain behaviour from
 772 /// when self-referencing nodes were still uniqued.  If the first operand has
 773 /// the same operands as \c Ops, return the first operand instead.
 774 static MDNode *getOrSelfReference(LLVMContext &Context,
 775                                   ArrayRef<Metadata *> Ops) {
 776   if (!Ops.empty())
 777     if (MDNode *N = dyn_cast_or_null<MDNode>(Ops[0]))
 778       if (N->getNumOperands() == Ops.size() && N == N->getOperand(0)) {
 779         for (unsigned I = 1, E = Ops.size(); I != E; ++I)
 780           if (Ops[I] != N->getOperand(I))
 781             return MDNode::get(Context, Ops);
 782         return N;
 783       }
 784
 785   return MDNode::get(Context, Ops);
 786 }
 787
 788 MDNode *MDNode::concatenate(MDNode *A, MDNode *B) {
 789   if (!A)
 790     return B;
 791   if (!B)
 792     return A;
 793
 794   SmallVector<Metadata *, 4> MDs(A->getNumOperands() + B->getNumOperands());
 795
 796   unsigned j = 0;
 797   for (unsigned i = 0, ie = A->getNumOperands(); i != ie; ++i)
 798     MDs[j++] = A->getOperand(i);
 799   for (unsigned i = 0, ie = B->getNumOperands(); i != ie; ++i)
 800     MDs[j++] = B->getOperand(i);
 801
 802   // FIXME: This preserves long-standing behaviour, but is it really the right
 803   // behaviour?  Or was that an unintended side-effect of node uniquing?
 804   return getOrSelfReference(A->getContext(), MDs);
 805 }
 806
 807 MDNode *MDNode::intersect(MDNode *A, MDNode *B) {
 808   if (!A || !B)
 809     return nullptr;
 810
 811   SmallVector<Metadata *, 4> MDs;
 812   for (unsigned i = 0, ie = A->getNumOperands(); i != ie; ++i) {
 813     Metadata *MD = A->getOperand(i);
 814     for (unsigned j = 0, je = B->getNumOperands(); j != je; ++j)
 815       if (MD == B->getOperand(j)) {
 816         MDs.push_back(MD);
 817         break;
 818       }
 819   }
 820
 821   // FIXME: This preserves long-standing behaviour, but is it really the right
 822   // behaviour?  Or was that an unintended side-effect of node uniquing?
 823   return getOrSelfReference(A->getContext(), MDs);
 824 }
 825
 826 MDNode *MDNode::getMostGenericFPMath(MDNode *A, MDNode *B) {
 827   if (!A || !B)
 828     return nullptr;
 829
 830   APFloat AVal = mdconst::extract<ConstantFP>(A->getOperand(0))->getValueAPF();
 831   APFloat BVal = mdconst::extract<ConstantFP>(B->getOperand(0))->getValueAPF();
 832   if (AVal.compare(BVal) == APFloat::cmpLessThan)
 833     return A;
 834   return B;
 835 }
 836
 837 static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
 838   return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
 839 }
 840
 841 static bool canBeMerged(const ConstantRange &A, const ConstantRange &B) {
 842   return !A.intersectWith(B).isEmptySet() || isContiguous(A, B);
 843 }
 844
 845 static bool tryMergeRange(SmallVectorImpl<ConstantInt *> &EndPoints,
 846                           ConstantInt *Low, ConstantInt *High) {
 847   ConstantRange NewRange(Low->getValue(), High->getValue());
 848   unsigned Size = EndPoints.size();
 849   APInt LB = EndPoints[Size - 2]->getValue();
 850   APInt LE = EndPoints[Size - 1]->getValue();
 851   ConstantRange LastRange(LB, LE);
 852   if (canBeMerged(NewRange, LastRange)) {
 853     ConstantRange Union = LastRange.unionWith(NewRange);
 854     Type *Ty = High->getType();
 855     EndPoints[Size - 2] =
 856         cast<ConstantInt>(ConstantInt::get(Ty, Union.getLower()));
 857     EndPoints[Size - 1] =
 858         cast<ConstantInt>(ConstantInt::get(Ty, Union.getUpper()));
 859     return true;
 860   }
 861   return false;
 862 }
 863
 864 static void addRange(SmallVectorImpl<ConstantInt *> &EndPoints,
 865                      ConstantInt *Low, ConstantInt *High) {
 866   if (!EndPoints.empty())
 867     if (tryMergeRange(EndPoints, Low, High))
 868       return;
 869
 870   EndPoints.push_back(Low);
 871   EndPoints.push_back(High);
 872 }
 873
 874 MDNode *MDNode::getMostGenericRange(MDNode *A, MDNode *B) {
 875   // Given two ranges, we want to compute the union of the ranges. This
 876   // is slightly complitade by having to combine the intervals and merge
 877   // the ones that overlap.
 878
 879   if (!A || !B)
 880     return nullptr;
 881
 882   if (A == B)
 883     return A;
 884
 885   // First, walk both lists in older of the lower boundary of each interval.
 886   // At each step, try to merge the new interval to the last one we adedd.
 887   SmallVector<ConstantInt *, 4> EndPoints;
 888   int AI = 0;
 889   int BI = 0;
 890   int AN = A->getNumOperands() / 2;
 891   int BN = B->getNumOperands() / 2;
 892   while (AI < AN && BI < BN) {
 893     ConstantInt *ALow = mdconst::extract<ConstantInt>(A->getOperand(2 * AI));
 894     ConstantInt *BLow = mdconst::extract<ConstantInt>(B->getOperand(2 * BI));
 895
 896     if (ALow->getValue().slt(BLow->getValue())) {
 897       addRange(EndPoints, ALow,
 898                mdconst::extract<ConstantInt>(A->getOperand(2 * AI + 1)));
 899       ++AI;
 900     } else {
 901       addRange(EndPoints, BLow,
 902                mdconst::extract<ConstantInt>(B->getOperand(2 * BI + 1)));
 903       ++BI;
 904     }
 905   }
 906   while (AI < AN) {
 907     addRange(EndPoints, mdconst::extract<ConstantInt>(A->getOperand(2 * AI)),
 908              mdconst::extract<ConstantInt>(A->getOperand(2 * AI + 1)));
 909     ++AI;
 910   }
 911   while (BI < BN) {
 912     addRange(EndPoints, mdconst::extract<ConstantInt>(B->getOperand(2 * BI)),
 913              mdconst::extract<ConstantInt>(B->getOperand(2 * BI + 1)));
 914     ++BI;
 915   }
 916
 917   // If we have more than 2 ranges (4 endpoints) we have to try to merge
 918   // the last and first ones.
 919   unsigned Size = EndPoints.size();
 920   if (Size > 4) {
 921     ConstantInt *FB = EndPoints[0];
 922     ConstantInt *FE = EndPoints[1];
 923     if (tryMergeRange(EndPoints, FB, FE)) {
 924       for (unsigned i = 0; i < Size - 2; ++i) {
 925         EndPoints[i] = EndPoints[i + 2];
 926       }
 927       EndPoints.resize(Size - 2);
 928     }
 929   }
 930
 931   // If in the end we have a single range, it is possible that it is now the
 932   // full range. Just drop the metadata in that case.
 933   if (EndPoints.size() == 2) {
 934     ConstantRange Range(EndPoints[0]->getValue(), EndPoints[1]->getValue());
 935     if (Range.isFullSet())
 936       return nullptr;
 937   }
 938
 939   SmallVector<Metadata *, 4> MDs;
 940   MDs.reserve(EndPoints.size());
 941   for (auto *I : EndPoints)
 942     MDs.push_back(ConstantAsMetadata::get(I));
 943   return MDNode::get(A->getContext(), MDs);
 944 }
 945
 946 //===----------------------------------------------------------------------===//
 947 // NamedMDNode implementation.
 948 //
 949
 950 static SmallVector<TrackingMDRef, 4> &getNMDOps(void *Operands) {
 951   return *(SmallVector<TrackingMDRef, 4> *)Operands;
 952 }
 953
 954 NamedMDNode::NamedMDNode(const Twine &N)
 955     : Name(N.str()), Parent(nullptr),
 956       Operands(new SmallVector<TrackingMDRef, 4>()) {}
 957
 958 NamedMDNode::~NamedMDNode() {
 959   dropAllReferences();
 960   delete &getNMDOps(Operands);
 961 }
 962
 963 unsigned NamedMDNode::getNumOperands() const {
 964   return (unsigned)getNMDOps(Operands).size();
 965 }
 966
 967 MDNode *NamedMDNode::getOperand(unsigned i) const {
 968   assert(i < getNumOperands() && "Invalid Operand number!");
 969   auto *N = getNMDOps(Operands)[i].get();
 970   return cast_or_null<MDNode>(N);
 971 }
 972
 973 void NamedMDNode::addOperand(MDNode *M) { getNMDOps(Operands).emplace_back(M); }
 974
 975 void NamedMDNode::setOperand(unsigned I, MDNode *New) {
 976   assert(I < getNumOperands() && "Invalid operand number");
 977   getNMDOps(Operands)[I].reset(New);
 978 }
 979
 980 void NamedMDNode::eraseFromParent() {
 981   getParent()->eraseNamedMetadata(this);
 982 }
 983
 984 void NamedMDNode::dropAllReferences() {
 985   getNMDOps(Operands).clear();
 986 }
 987
 988 StringRef NamedMDNode::getName() const {
 989   return StringRef(Name);
 990 }
 991
 992 //===----------------------------------------------------------------------===//
 993 // Instruction Metadata method implementations.
 994 //
 995
 996 void Instruction::setMetadata(StringRef Kind, MDNode *Node) {
 997   if (!Node && !hasMetadata())
 998     return;
 999   setMetadata(getContext().getMDKindID(Kind), Node);
1000 }
1001
1002 MDNode *Instruction::getMetadataImpl(StringRef Kind) const {
1003   return getMetadataImpl(getContext().getMDKindID(Kind));
1004 }
1005
1006 void Instruction::dropUnknownMetadata(ArrayRef<unsigned> KnownIDs) {
1007   SmallSet<unsigned, 5> KnownSet;
1008   KnownSet.insert(KnownIDs.begin(), KnownIDs.end());
1009
1010   // Drop debug if needed
1011   if (KnownSet.erase(LLVMContext::MD_dbg))
1012     DbgLoc = DebugLoc();
1013
1014   if (!hasMetadataHashEntry())
1015     return; // Nothing to remove!
1016
1017   DenseMap<const Instruction *, LLVMContextImpl::MDMapTy> &MetadataStore =
1018       getContext().pImpl->MetadataStore;
1019
1020   if (KnownSet.empty()) {
1021     // Just drop our entry at the store.
1022     MetadataStore.erase(this);
1023     setHasMetadataHashEntry(false);
1024     return;
1025   }
1026
1027   LLVMContextImpl::MDMapTy &Info = MetadataStore[this];
1028   unsigned I;
1029   unsigned E;
1030   // Walk the array and drop any metadata we don't know.
1031   for (I = 0, E = Info.size(); I != E;) {
1032     if (KnownSet.count(Info[I].first)) {
1033       ++I;
1034       continue;
1035     }
1036
1037     Info[I] = std::move(Info.back());
1038     Info.pop_back();
1039     --E;
1040   }
1041   assert(E == Info.size());
1042
1043   if (E == 0) {
1044     // Drop our entry at the store.
1045     MetadataStore.erase(this);
1046     setHasMetadataHashEntry(false);
1047   }
1048 }
1049
1050 /// setMetadata - Set the metadata of of the specified kind to the specified
1051 /// node.  This updates/replaces metadata if already present, or removes it if
1052 /// Node is null.
1053 void Instruction::setMetadata(unsigned KindID, MDNode *Node) {
1054   if (!Node && !hasMetadata())
1055     return;
1056
1057   // Handle 'dbg' as a special case since it is not stored in the hash table.
1058   if (KindID == LLVMContext::MD_dbg) {
1059     DbgLoc = DebugLoc::getFromDILocation(Node);
1060     return;
1061   }
1062
1063   // Handle the case when we're adding/updating metadata on an instruction.
1064   if (Node) {
1065     LLVMContextImpl::MDMapTy &Info = getContext().pImpl->MetadataStore[this];
1066     assert(!Info.empty() == hasMetadataHashEntry() &&
1067            "HasMetadata bit is wonked");
1068     if (Info.empty()) {
1069       setHasMetadataHashEntry(true);
1070     } else {
1071       // Handle replacement of an existing value.
1072       for (auto &P : Info)
1073         if (P.first == KindID) {
1074           P.second.reset(Node);
1075           return;
1076         }
1077     }
1078
1079     // No replacement, just add it to the list.
1080     Info.emplace_back(std::piecewise_construct, std::make_tuple(KindID),
1081                       std::make_tuple(Node));
1082     return;
1083   }
1084
1085   // Otherwise, we're removing metadata from an instruction.
1086   assert((hasMetadataHashEntry() ==
1087           (getContext().pImpl->MetadataStore.count(this) > 0)) &&
1088          "HasMetadata bit out of date!");
1089   if (!hasMetadataHashEntry())
1090     return;  // Nothing to remove!
1091   LLVMContextImpl::MDMapTy &Info = getContext().pImpl->MetadataStore[this];
1092
1093   // Common case is removing the only entry.
1094   if (Info.size() == 1 && Info[0].first == KindID) {
1095     getContext().pImpl->MetadataStore.erase(this);
1096     setHasMetadataHashEntry(false);
1097     return;
1098   }
1099
1100   // Handle removal of an existing value.
1101   for (unsigned i = 0, e = Info.size(); i != e; ++i)
1102     if (Info[i].first == KindID) {
1103       Info[i] = std::move(Info.back());
1104       Info.pop_back();
1105       assert(!Info.empty() && "Removing last entry should be handled above");
1106       return;
1107     }
1108   // Otherwise, removing an entry that doesn't exist on the instruction.
1109 }
1110
1111 void Instruction::setAAMetadata(const AAMDNodes &N) {
1112   setMetadata(LLVMContext::MD_tbaa, N.TBAA);
1113   setMetadata(LLVMContext::MD_alias_scope, N.Scope);
1114   setMetadata(LLVMContext::MD_noalias, N.NoAlias);
1115 }
1116
1117 MDNode *Instruction::getMetadataImpl(unsigned KindID) const {
1118   // Handle 'dbg' as a special case since it is not stored in the hash table.
1119   if (KindID == LLVMContext::MD_dbg)
1120     return DbgLoc.getAsMDNode();
1121
1122   if (!hasMetadataHashEntry()) return nullptr;
1123
1124   LLVMContextImpl::MDMapTy &Info = getContext().pImpl->MetadataStore[this];
1125   assert(!Info.empty() && "bit out of sync with hash table");
1126
1127   for (const auto &I : Info)
1128     if (I.first == KindID)
1129       return I.second;
1130   return nullptr;
1131 }
1132
1133 void Instruction::getAllMetadataImpl(
1134     SmallVectorImpl<std::pair<unsigned, MDNode *>> &Result) const {
1135   Result.clear();
1136
1137   // Handle 'dbg' as a special case since it is not stored in the hash table.
1138   if (!DbgLoc.isUnknown()) {
1139     Result.push_back(
1140         std::make_pair((unsigned)LLVMContext::MD_dbg, DbgLoc.getAsMDNode()));
1141     if (!hasMetadataHashEntry()) return;
1142   }
1143
1144   assert(hasMetadataHashEntry() &&
1145          getContext().pImpl->MetadataStore.count(this) &&
1146          "Shouldn't have called this");
1147   const LLVMContextImpl::MDMapTy &Info =
1148     getContext().pImpl->MetadataStore.find(this)->second;
1149   assert(!Info.empty() && "Shouldn't have called this");
1150
1151   Result.reserve(Result.size() + Info.size());
1152   for (auto &I : Info)
1153     Result.push_back(std::make_pair(I.first, cast<MDNode>(I.second.get())));
1154
1155   // Sort the resulting array so it is stable.
1156   if (Result.size() > 1)
1157     array_pod_sort(Result.begin(), Result.end());
1158 }
1159
1160 void Instruction::getAllMetadataOtherThanDebugLocImpl(
1161     SmallVectorImpl<std::pair<unsigned, MDNode *>> &Result) const {
1162   Result.clear();
1163   assert(hasMetadataHashEntry() &&
1164          getContext().pImpl->MetadataStore.count(this) &&
1165          "Shouldn't have called this");
1166   const LLVMContextImpl::MDMapTy &Info =
1167     getContext().pImpl->MetadataStore.find(this)->second;
1168   assert(!Info.empty() && "Shouldn't have called this");
1169   Result.reserve(Result.size() + Info.size());
1170   for (auto &I : Info)
1171     Result.push_back(std::make_pair(I.first, cast<MDNode>(I.second.get())));
1172
1173   // Sort the resulting array so it is stable.
1174   if (Result.size() > 1)
1175     array_pod_sort(Result.begin(), Result.end());
1176 }
1177
1178 /// clearMetadataHashEntries - Clear all hashtable-based metadata from
1179 /// this instruction.
1180 void Instruction::clearMetadataHashEntries() {
1181   assert(hasMetadataHashEntry() && "Caller should check");
1182   getContext().pImpl->MetadataStore.erase(this);
1183   setHasMetadataHashEntry(false);
1184 }