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