lib/VMCore/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/Metadata.h"
  15 #include "LLVMContextImpl.h"
  16 #include "llvm/LLVMContext.h"
  17 #include "llvm/Module.h"
  18 #include "llvm/Instruction.h"
  19 #include "llvm/ADT/DenseMap.h"
  20 #include "llvm/ADT/StringMap.h"
  21 #include "llvm/ADT/SmallString.h"
  22 #include "SymbolTableListTraitsImpl.h"
  23 #include "llvm/Support/LeakDetector.h"
  24 #include "llvm/Support/ValueHandle.h"
  25 using namespace llvm;
  26
  27 //===----------------------------------------------------------------------===//
  28 // MDString implementation.
  29 //
  30
  31 MDString::MDString(LLVMContext &C, StringRef S)
  32   : Value(Type::getMetadataTy(C), Value::MDStringVal), Str(S) {}
  33
  34 MDString *MDString::get(LLVMContext &Context, StringRef Str) {
  35   LLVMContextImpl *pImpl = Context.pImpl;
  36   StringMapEntry<MDString *> &Entry =
  37     pImpl->MDStringCache.GetOrCreateValue(Str);
  38   MDString *&S = Entry.getValue();
  39   if (!S) S = new MDString(Context, Entry.getKey());
  40   return S;
  41 }
  42
  43 //===----------------------------------------------------------------------===//
  44 // MDNodeOperand implementation.
  45 //
  46
  47 // Use CallbackVH to hold MDNode operands.
  48 namespace llvm {
  49 class MDNodeOperand : public CallbackVH {
  50   MDNode *Parent;
  51 public:
  52   MDNodeOperand(Value *V, MDNode *P) : CallbackVH(V), Parent(P) {}
  53   ~MDNodeOperand() {}
  54
  55   void set(Value *V) {
  56     setValPtr(V);
  57   }
  58
  59   virtual void deleted();
  60   virtual void allUsesReplacedWith(Value *NV);
  61 };
  62 } // end namespace llvm.
  63
  64
  65 void MDNodeOperand::deleted() {
  66   Parent->replaceOperand(this, 0);
  67 }
  68
  69 void MDNodeOperand::allUsesReplacedWith(Value *NV) {
  70   Parent->replaceOperand(this, NV);
  71 }
  72
  73
  74
  75 //===----------------------------------------------------------------------===//
  76 // MDNode implementation.
  77 //
  78
  79 /// getOperandPtr - Helper function to get the MDNodeOperand's coallocated on
  80 /// the end of the MDNode.
  81 static MDNodeOperand *getOperandPtr(MDNode *N, unsigned Op) {
  82   // Use <= instead of < to permit a one-past-the-end address.
  83   assert(Op <= N->getNumOperands() && "Invalid operand number");
  84   return reinterpret_cast<MDNodeOperand*>(N+1)+Op;
  85 }
  86
  87 MDNode::MDNode(LLVMContext &C, Value *const *Vals, unsigned NumVals,
  88                bool isFunctionLocal)
  89 : Value(Type::getMetadataTy(C), Value::MDNodeVal) {
  90   NumOperands = NumVals;
  91
  92   if (isFunctionLocal)
  93     setValueSubclassData(getSubclassDataFromValue() | FunctionLocalBit);
  94
  95   // Initialize the operand list, which is co-allocated on the end of the node.
  96   for (MDNodeOperand *Op = getOperandPtr(this, 0), *E = Op+NumOperands;
  97        Op != E; ++Op, ++Vals)
  98     new (Op) MDNodeOperand(*Vals, this);
  99 }
 100
 101
 102 /// ~MDNode - Destroy MDNode.
 103 MDNode::~MDNode() {
 104   assert((getSubclassDataFromValue() & DestroyFlag) != 0 &&
 105          "Not being destroyed through destroy()?");
 106   LLVMContextImpl *pImpl = getType()->getContext().pImpl;
 107   if (isNotUniqued()) {
 108     pImpl->NonUniquedMDNodes.erase(this);
 109   } else {
 110     pImpl->MDNodeSet.RemoveNode(this);
 111   }
 112
 113   // Destroy the operands.
 114   for (MDNodeOperand *Op = getOperandPtr(this, 0), *E = Op+NumOperands;
 115        Op != E; ++Op)
 116     Op->~MDNodeOperand();
 117 }
 118
 119 static const Function *getFunctionForValue(Value *V) {
 120   if (!V) return NULL;
 121   if (Instruction *I = dyn_cast<Instruction>(V)) {
 122     BasicBlock *BB = I->getParent();
 123     return BB ? BB->getParent() : 0;
 124   }
 125   if (Argument *A = dyn_cast<Argument>(V))
 126     return A->getParent();
 127   if (BasicBlock *BB = dyn_cast<BasicBlock>(V))
 128     return BB->getParent();
 129   if (MDNode *MD = dyn_cast<MDNode>(V))
 130     return MD->getFunction();
 131   return NULL;
 132 }
 133
 134 #ifndef NDEBUG
 135 static const Function *assertLocalFunction(const MDNode *N) {
 136   if (!N->isFunctionLocal()) return 0;
 137
 138   // FIXME: This does not handle cyclic function local metadata.
 139   const Function *F = 0, *NewF = 0;
 140   for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
 141     if (Value *V = N->getOperand(i)) {
 142       if (MDNode *MD = dyn_cast<MDNode>(V))
 143         NewF = assertLocalFunction(MD);
 144       else
 145         NewF = getFunctionForValue(V);
 146     }
 147     if (F == 0)
 148       F = NewF;
 149     else
 150       assert((NewF == 0 || F == NewF) &&"inconsistent function-local metadata");
 151   }
 152   return F;
 153 }
 154 #endif
 155
 156 // getFunction - If this metadata is function-local and recursively has a
 157 // function-local operand, return the first such operand's parent function.
 158 // Otherwise, return null. getFunction() should not be used for performance-
 159 // critical code because it recursively visits all the MDNode's operands.
 160 const Function *MDNode::getFunction() const {
 161 #ifndef NDEBUG
 162   return assertLocalFunction(this);
 163 #endif
 164   if (!isFunctionLocal()) return NULL;
 165   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
 166     if (const Function *F = getFunctionForValue(getOperand(i)))
 167       return F;
 168   return NULL;
 169 }
 170
 171 // destroy - Delete this node.  Only when there are no uses.
 172 void MDNode::destroy() {
 173   setValueSubclassData(getSubclassDataFromValue() | DestroyFlag);
 174   // Placement delete, the free the memory.
 175   this->~MDNode();
 176   free(this);
 177 }
 178
 179 /// isFunctionLocalValue - Return true if this is a value that would require a
 180 /// function-local MDNode.
 181 static bool isFunctionLocalValue(Value *V) {
 182   return isa<Instruction>(V) || isa<Argument>(V) || isa<BasicBlock>(V) ||
 183          (isa<MDNode>(V) && cast<MDNode>(V)->isFunctionLocal());
 184 }
 185
 186 MDNode *MDNode::getMDNode(LLVMContext &Context, Value *const *Vals,
 187                           unsigned NumVals, FunctionLocalness FL,
 188                           bool Insert) {
 189   LLVMContextImpl *pImpl = Context.pImpl;
 190   bool isFunctionLocal = false;
 191   switch (FL) {
 192   case FL_Unknown:
 193     for (unsigned i = 0; i != NumVals; ++i) {
 194       Value *V = Vals[i];
 195       if (!V) continue;
 196       if (isFunctionLocalValue(V)) {
 197         isFunctionLocal = true;
 198         break;
 199       }
 200     }
 201     break;
 202   case FL_No:
 203     isFunctionLocal = false;
 204     break;
 205   case FL_Yes:
 206     isFunctionLocal = true;
 207     break;
 208   }
 209
 210   FoldingSetNodeID ID;
 211   for (unsigned i = 0; i != NumVals; ++i)
 212     ID.AddPointer(Vals[i]);
 213   ID.AddBoolean(isFunctionLocal);
 214
 215   void *InsertPoint;
 216   MDNode *N = NULL;
 217
 218   if ((N = pImpl->MDNodeSet.FindNodeOrInsertPos(ID, InsertPoint)))
 219     return N;
 220
 221   if (!Insert)
 222     return NULL;
 223
 224   // Coallocate space for the node and Operands together, then placement new.
 225   void *Ptr = malloc(sizeof(MDNode)+NumVals*sizeof(MDNodeOperand));
 226   N = new (Ptr) MDNode(Context, Vals, NumVals, isFunctionLocal);
 227
 228   // InsertPoint will have been set by the FindNodeOrInsertPos call.
 229   pImpl->MDNodeSet.InsertNode(N, InsertPoint);
 230
 231   return N;
 232 }
 233
 234 MDNode *MDNode::get(LLVMContext &Context, Value*const* Vals, unsigned NumVals) {
 235   return getMDNode(Context, Vals, NumVals, FL_Unknown);
 236 }
 237
 238 MDNode *MDNode::getWhenValsUnresolved(LLVMContext &Context, Value *const *Vals,
 239                                       unsigned NumVals, bool isFunctionLocal) {
 240   return getMDNode(Context, Vals, NumVals, isFunctionLocal ? FL_Yes : FL_No);
 241 }
 242
 243 MDNode *MDNode::getIfExists(LLVMContext &Context, Value *const *Vals,
 244                             unsigned NumVals) {
 245   return getMDNode(Context, Vals, NumVals, FL_Unknown, false);
 246 }
 247
 248 MDNode *MDNode::getTemporary(LLVMContext &Context, Value *const *Vals,
 249                              unsigned NumVals) {
 250   MDNode *N = (MDNode *)malloc(sizeof(MDNode)+NumVals*sizeof(MDNodeOperand));
 251   N = new (N) MDNode(Context, Vals, NumVals, FL_No);
 252   N->setValueSubclassData(N->getSubclassDataFromValue() |
 253                           NotUniquedBit);
 254   LeakDetector::addGarbageObject(N);
 255   return N;
 256 }
 257
 258 void MDNode::deleteTemporary(MDNode *N) {
 259   assert(N->use_empty() && "Temporary MDNode has uses!");
 260   assert(!N->getContext().pImpl->MDNodeSet.RemoveNode(N) &&
 261          "Deleting a non-temporary node!");
 262   assert((N->getSubclassDataFromValue() & NotUniquedBit) &&
 263          "Temporary MDNode does not have NotUniquedBit set!");
 264   assert((N->getSubclassDataFromValue() & DestroyFlag) == 0 &&
 265          "Temporary MDNode has DestroyFlag set!");
 266   N->setValueSubclassData(N->getSubclassDataFromValue() |
 267                           DestroyFlag);
 268   LeakDetector::removeGarbageObject(N);
 269   delete N;
 270 }
 271
 272 /// getOperand - Return specified operand.
 273 Value *MDNode::getOperand(unsigned i) const {
 274   return *getOperandPtr(const_cast<MDNode*>(this), i);
 275 }
 276
 277 void MDNode::Profile(FoldingSetNodeID &ID) const {
 278   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
 279     ID.AddPointer(getOperand(i));
 280   ID.AddBoolean(isFunctionLocal());
 281 }
 282
 283 void MDNode::setIsNotUniqued() {
 284   setValueSubclassData(getSubclassDataFromValue() | NotUniquedBit);
 285   LLVMContextImpl *pImpl = getType()->getContext().pImpl;
 286   pImpl->NonUniquedMDNodes.insert(this);
 287 }
 288
 289 // Replace value from this node's operand list.
 290 void MDNode::replaceOperand(MDNodeOperand *Op, Value *To) {
 291   Value *From = *Op;
 292
 293   // If is possible that someone did GV->RAUW(inst), replacing a global variable
 294   // with an instruction or some other function-local object.  If this is a
 295   // non-function-local MDNode, it can't point to a function-local object.
 296   // Handle this case by implicitly dropping the MDNode reference to null.
 297   // Likewise if the MDNode is function-local but for a different function.
 298   if (To && isFunctionLocalValue(To)) {
 299     if (!isFunctionLocal())
 300       To = 0;
 301     else {
 302       const Function *F = getFunction();
 303       const Function *FV = getFunctionForValue(To);
 304       // Metadata can be function-local without having an associated function.
 305       // So only consider functions to have changed if non-null.
 306       if (F && FV && F != FV)
 307         To = 0;
 308     }
 309   }
 310
 311   if (From == To)
 312     return;
 313
 314   // Update the operand.
 315   Op->set(To);
 316
 317   // If this node is already not being uniqued (because one of the operands
 318   // already went to null), then there is nothing else to do here.
 319   if (isNotUniqued()) return;
 320
 321   LLVMContextImpl *pImpl = getType()->getContext().pImpl;
 322
 323   // Remove "this" from the context map.  FoldingSet doesn't have to reprofile
 324   // this node to remove it, so we don't care what state the operands are in.
 325   pImpl->MDNodeSet.RemoveNode(this);
 326
 327   // If we are dropping an argument to null, we choose to not unique the MDNode
 328   // anymore.  This commonly occurs during destruction, and uniquing these
 329   // brings little reuse.
 330   if (To == 0) {
 331     setIsNotUniqued();
 332     return;
 333   }
 334
 335   // Now that the node is out of the folding set, get ready to reinsert it.
 336   // First, check to see if another node with the same operands already exists
 337   // in the set.  If it doesn't exist, this returns the position to insert it.
 338   FoldingSetNodeID ID;
 339   Profile(ID);
 340   void *InsertPoint;
 341   MDNode *N = pImpl->MDNodeSet.FindNodeOrInsertPos(ID, InsertPoint);
 342
 343   if (N) {
 344     N->replaceAllUsesWith(this);
 345     N->destroy();
 346     N = pImpl->MDNodeSet.FindNodeOrInsertPos(ID, InsertPoint);
 347     assert(N == 0 && "shouldn't be in the map now!"); (void)N;
 348   }
 349
 350   // InsertPoint will have been set by the FindNodeOrInsertPos call.
 351   pImpl->MDNodeSet.InsertNode(this, InsertPoint);
 352 }
 353
 354 //===----------------------------------------------------------------------===//
 355 // NamedMDNode implementation.
 356 //
 357
 358 static SmallVector<TrackingVH<MDNode>, 4> &getNMDOps(void *Operands) {
 359   return *(SmallVector<TrackingVH<MDNode>, 4>*)Operands;
 360 }
 361
 362 NamedMDNode::NamedMDNode(const Twine &N)
 363   : Name(N.str()), Parent(0),
 364     Operands(new SmallVector<TrackingVH<MDNode>, 4>()) {
 365 }
 366
 367 NamedMDNode::~NamedMDNode() {
 368   dropAllReferences();
 369   delete &getNMDOps(Operands);
 370 }
 371
 372 /// getNumOperands - Return number of NamedMDNode operands.
 373 unsigned NamedMDNode::getNumOperands() const {
 374   return (unsigned)getNMDOps(Operands).size();
 375 }
 376
 377 /// getOperand - Return specified operand.
 378 MDNode *NamedMDNode::getOperand(unsigned i) const {
 379   assert(i < getNumOperands() && "Invalid Operand number!");
 380   return dyn_cast<MDNode>(&*getNMDOps(Operands)[i]);
 381 }
 382
 383 /// addOperand - Add metadata Operand.
 384 void NamedMDNode::addOperand(MDNode *M) {
 385   getNMDOps(Operands).push_back(TrackingVH<MDNode>(M));
 386 }
 387
 388 /// eraseFromParent - Drop all references and remove the node from parent
 389 /// module.
 390 void NamedMDNode::eraseFromParent() {
 391   getParent()->eraseNamedMetadata(this);
 392 }
 393
 394 /// dropAllReferences - Remove all uses and clear node vector.
 395 void NamedMDNode::dropAllReferences() {
 396   getNMDOps(Operands).clear();
 397 }
 398
 399 /// getName - Return a constant reference to this named metadata's name.
 400 StringRef NamedMDNode::getName() const {
 401   return StringRef(Name);
 402 }
 403
 404 //===----------------------------------------------------------------------===//
 405 // Instruction Metadata method implementations.
 406 //
 407
 408 void Instruction::setMetadata(const char *Kind, MDNode *Node) {
 409   if (Node == 0 && !hasMetadata()) return;
 410   setMetadata(getContext().getMDKindID(Kind), Node);
 411 }
 412
 413 MDNode *Instruction::getMetadataImpl(const char *Kind) const {
 414   return getMetadataImpl(getContext().getMDKindID(Kind));
 415 }
 416
 417 /// setMetadata - Set the metadata of of the specified kind to the specified
 418 /// node.  This updates/replaces metadata if already present, or removes it if
 419 /// Node is null.
 420 void Instruction::setMetadata(unsigned KindID, MDNode *Node) {
 421   if (Node == 0 && !hasMetadata()) return;
 422
 423   // Handle 'dbg' as a special case since it is not stored in the hash table.
 424   if (KindID == LLVMContext::MD_dbg) {
 425     DbgLoc = DebugLoc::getFromDILocation(Node);
 426     return;
 427   }
 428
 429   // Handle the case when we're adding/updating metadata on an instruction.
 430   if (Node) {
 431     LLVMContextImpl::MDMapTy &Info = getContext().pImpl->MetadataStore[this];
 432     assert(!Info.empty() == hasMetadataHashEntry() &&
 433            "HasMetadata bit is wonked");
 434     if (Info.empty()) {
 435       setHasMetadataHashEntry(true);
 436     } else {
 437       // Handle replacement of an existing value.
 438       for (unsigned i = 0, e = Info.size(); i != e; ++i)
 439         if (Info[i].first == KindID) {
 440           Info[i].second = Node;
 441           return;
 442         }
 443     }
 444
 445     // No replacement, just add it to the list.
 446     Info.push_back(std::make_pair(KindID, Node));
 447     return;
 448   }
 449
 450   // Otherwise, we're removing metadata from an instruction.
 451   assert(hasMetadataHashEntry() &&
 452          getContext().pImpl->MetadataStore.count(this) &&
 453          "HasMetadata bit out of date!");
 454   LLVMContextImpl::MDMapTy &Info = getContext().pImpl->MetadataStore[this];
 455
 456   // Common case is removing the only entry.
 457   if (Info.size() == 1 && Info[0].first == KindID) {
 458     getContext().pImpl->MetadataStore.erase(this);
 459     setHasMetadataHashEntry(false);
 460     return;
 461   }
 462
 463   // Handle removal of an existing value.
 464   for (unsigned i = 0, e = Info.size(); i != e; ++i)
 465     if (Info[i].first == KindID) {
 466       Info[i] = Info.back();
 467       Info.pop_back();
 468       assert(!Info.empty() && "Removing last entry should be handled above");
 469       return;
 470     }
 471   // Otherwise, removing an entry that doesn't exist on the instruction.
 472 }
 473
 474 MDNode *Instruction::getMetadataImpl(unsigned KindID) const {
 475   // Handle 'dbg' as a special case since it is not stored in the hash table.
 476   if (KindID == LLVMContext::MD_dbg)
 477     return DbgLoc.getAsMDNode(getContext());
 478
 479   if (!hasMetadataHashEntry()) return 0;
 480
 481   LLVMContextImpl::MDMapTy &Info = getContext().pImpl->MetadataStore[this];
 482   assert(!Info.empty() && "bit out of sync with hash table");
 483
 484   for (LLVMContextImpl::MDMapTy::iterator I = Info.begin(), E = Info.end();
 485        I != E; ++I)
 486     if (I->first == KindID)
 487       return I->second;
 488   return 0;
 489 }
 490
 491 void Instruction::getAllMetadataImpl(SmallVectorImpl<std::pair<unsigned,
 492                                        MDNode*> > &Result) const {
 493   Result.clear();
 494
 495   // Handle 'dbg' as a special case since it is not stored in the hash table.
 496   if (!DbgLoc.isUnknown()) {
 497     Result.push_back(std::make_pair((unsigned)LLVMContext::MD_dbg,
 498                                     DbgLoc.getAsMDNode(getContext())));
 499     if (!hasMetadataHashEntry()) return;
 500   }
 501
 502   assert(hasMetadataHashEntry() &&
 503          getContext().pImpl->MetadataStore.count(this) &&
 504          "Shouldn't have called this");
 505   const LLVMContextImpl::MDMapTy &Info =
 506     getContext().pImpl->MetadataStore.find(this)->second;
 507   assert(!Info.empty() && "Shouldn't have called this");
 508
 509   Result.append(Info.begin(), Info.end());
 510
 511   // Sort the resulting array so it is stable.
 512   if (Result.size() > 1)
 513     array_pod_sort(Result.begin(), Result.end());
 514 }
 515
 516 void Instruction::
 517 getAllMetadataOtherThanDebugLocImpl(SmallVectorImpl<std::pair<unsigned,
 518                                     MDNode*> > &Result) const {
 519   Result.clear();
 520   assert(hasMetadataHashEntry() &&
 521          getContext().pImpl->MetadataStore.count(this) &&
 522          "Shouldn't have called this");
 523   const LLVMContextImpl::MDMapTy &Info =
 524   getContext().pImpl->MetadataStore.find(this)->second;
 525   assert(!Info.empty() && "Shouldn't have called this");
 526
 527   Result.append(Info.begin(), Info.end());
 528
 529   // Sort the resulting array so it is stable.
 530   if (Result.size() > 1)
 531     array_pod_sort(Result.begin(), Result.end());
 532 }
 533
 534
 535 /// clearMetadataHashEntries - Clear all hashtable-based metadata from
 536 /// this instruction.
 537 void Instruction::clearMetadataHashEntries() {
 538   assert(hasMetadataHashEntry() && "Caller should check");
 539   getContext().pImpl->MetadataStore.erase(this);
 540   setHasMetadataHashEntry(false);
 541 }
 542