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