lib/IR/Metadata.cpp

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