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