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 "SymbolTableListTraitsImpl.h"
  22 #include "llvm/Support/ValueHandle.h"
  23 using namespace llvm;
  24
  25 //===----------------------------------------------------------------------===//
  26 // MDString implementation.
  27 //
  28
  29 MDString::MDString(LLVMContext &C, StringRef S)
  30   : MetadataBase(Type::getMetadataTy(C), Value::MDStringVal), Str(S) {}
  31
  32 MDString *MDString::get(LLVMContext &Context, StringRef Str) {
  33   LLVMContextImpl *pImpl = Context.pImpl;
  34   StringMapEntry<MDString *> &Entry =
  35     pImpl->MDStringCache.GetOrCreateValue(Str);
  36   MDString *&S = Entry.getValue();
  37   if (!S) S = new MDString(Context, Entry.getKey());
  38   return S;
  39 }
  40
  41 MDString *MDString::get(LLVMContext &Context, const char *Str) {
  42   LLVMContextImpl *pImpl = Context.pImpl;
  43   StringMapEntry<MDString *> &Entry =
  44     pImpl->MDStringCache.GetOrCreateValue(Str ? StringRef(Str) : StringRef());
  45   MDString *&S = Entry.getValue();
  46   if (!S) S = new MDString(Context, Entry.getKey());
  47   return S;
  48 }
  49
  50 //===----------------------------------------------------------------------===//
  51 // MDNodeElement implementation.
  52 //
  53
  54 // Use CallbackVH to hold MDNode elements.
  55 namespace llvm {
  56 class MDNodeElement : public CallbackVH {
  57   MDNode *Parent;
  58 public:
  59   MDNodeElement() {}
  60   MDNodeElement(Value *V, MDNode *P) : CallbackVH(V), Parent(P) {}
  61   ~MDNodeElement() {}
  62
  63   void set(Value *V, MDNode *P) {
  64     setValPtr(V);
  65     Parent = P;
  66   }
  67
  68   virtual void deleted();
  69   virtual void allUsesReplacedWith(Value *NV);
  70 };
  71 } // end namespace llvm.
  72
  73
  74 void MDNodeElement::deleted() {
  75   Parent->replaceElement(this, 0);
  76 }
  77
  78 void MDNodeElement::allUsesReplacedWith(Value *NV) {
  79   Parent->replaceElement(this, NV);
  80 }
  81
  82
  83
  84 //===----------------------------------------------------------------------===//
  85 // MDNode implementation.
  86 //
  87
  88 /// ~MDNode - Destroy MDNode.
  89 MDNode::~MDNode() {
  90   LLVMContextImpl *pImpl = getType()->getContext().pImpl;
  91   pImpl->MDNodeSet.RemoveNode(this);
  92   delete [] Operands;
  93   Operands = NULL;
  94 }
  95
  96 MDNode::MDNode(LLVMContext &C, Value *const *Vals, unsigned NumVals,
  97                bool isFunctionLocal)
  98   : MetadataBase(Type::getMetadataTy(C), Value::MDNodeVal) {
  99   NumOperands = NumVals;
 100   Operands = new MDNodeElement[NumOperands];
 101
 102   for (unsigned i = 0; i != NumVals; ++i)
 103     Operands[i].set(Vals[i], this);
 104
 105   if (isFunctionLocal)
 106     setValueSubclassData(getSubclassDataFromValue() | FunctionLocalBit);
 107 }
 108
 109 MDNode *MDNode::get(LLVMContext &Context, Value*const* Vals, unsigned NumVals,
 110                     bool isFunctionLocal) {
 111   LLVMContextImpl *pImpl = Context.pImpl;
 112   FoldingSetNodeID ID;
 113   for (unsigned i = 0; i != NumVals; ++i)
 114     ID.AddPointer(Vals[i]);
 115
 116   void *InsertPoint;
 117   MDNode *N = pImpl->MDNodeSet.FindNodeOrInsertPos(ID, InsertPoint);
 118   if (!N) {
 119     // InsertPoint will have been set by the FindNodeOrInsertPos call.
 120     N = new MDNode(Context, Vals, NumVals, isFunctionLocal);
 121     pImpl->MDNodeSet.InsertNode(N, InsertPoint);
 122   }
 123   return N;
 124 }
 125
 126 void MDNode::Profile(FoldingSetNodeID &ID) const {
 127   for (unsigned i = 0, e = getNumElements(); i != e; ++i)
 128     ID.AddPointer(getElement(i));
 129   // HASH TABLE COLLISIONS?
 130   // DO NOT REINSERT AFTER AN OPERAND DROPS TO NULL!
 131 }
 132
 133
 134 /// getElement - Return specified element.
 135 Value *MDNode::getElement(unsigned i) const {
 136   assert(i < getNumElements() && "Invalid element number!");
 137   return Operands[i];
 138 }
 139
 140
 141
 142 // Replace value from this node's element list.
 143 void MDNode::replaceElement(MDNodeElement *Op, Value *To) {
 144   Value *From = *Op;
 145
 146   if (From == To)
 147     return;
 148
 149   LLVMContextImpl *pImpl = getType()->getContext().pImpl;
 150
 151   // Remove "this" from the context map.  FoldingSet doesn't have to reprofile
 152   // this node to remove it, so we don't care what state the operands are in.
 153   pImpl->MDNodeSet.RemoveNode(this);
 154
 155   // Update the operand.
 156   Op->set(To, this);
 157
 158   // Insert updated "this" into the context's folding node set.
 159   // If a node with same element list already exist then before inserting
 160   // updated "this" into the folding node set, replace all uses of existing
 161   // node with updated "this" node.
 162   FoldingSetNodeID ID;
 163   Profile(ID);
 164   void *InsertPoint;
 165   MDNode *N = pImpl->MDNodeSet.FindNodeOrInsertPos(ID, InsertPoint);
 166
 167   if (N) {
 168     N->replaceAllUsesWith(this);
 169     delete N;
 170     N = pImpl->MDNodeSet.FindNodeOrInsertPos(ID, InsertPoint);
 171     assert(N == 0 && "shouldn't be in the map now!"); (void)N;
 172   }
 173
 174   // InsertPoint will have been set by the FindNodeOrInsertPos call.
 175   pImpl->MDNodeSet.InsertNode(this, InsertPoint);
 176 }
 177
 178 //===----------------------------------------------------------------------===//
 179 // NamedMDNode implementation.
 180 //
 181 static SmallVector<TrackingVH<MetadataBase>, 4> &getNMDOps(void *Operands) {
 182   return *(SmallVector<TrackingVH<MetadataBase>, 4>*)Operands;
 183 }
 184
 185 NamedMDNode::NamedMDNode(LLVMContext &C, const Twine &N,
 186                          MetadataBase *const *MDs,
 187                          unsigned NumMDs, Module *ParentModule)
 188   : MetadataBase(Type::getMetadataTy(C), Value::NamedMDNodeVal), Parent(0) {
 189   setName(N);
 190
 191   Operands = new SmallVector<TrackingVH<MetadataBase>, 4>();
 192
 193   SmallVector<TrackingVH<MetadataBase>, 4> &Node = getNMDOps(Operands);
 194   for (unsigned i = 0; i != NumMDs; ++i)
 195     Node.push_back(TrackingVH<MetadataBase>(MDs[i]));
 196
 197   if (ParentModule)
 198     ParentModule->getNamedMDList().push_back(this);
 199 }
 200
 201 NamedMDNode *NamedMDNode::Create(const NamedMDNode *NMD, Module *M) {
 202   assert(NMD && "Invalid source NamedMDNode!");
 203   SmallVector<MetadataBase *, 4> Elems;
 204   Elems.reserve(NMD->getNumElements());
 205
 206   for (unsigned i = 0, e = NMD->getNumElements(); i != e; ++i)
 207     Elems.push_back(NMD->getElement(i));
 208   return new NamedMDNode(NMD->getContext(), NMD->getName().data(),
 209                          Elems.data(), Elems.size(), M);
 210 }
 211
 212 NamedMDNode::~NamedMDNode() {
 213   dropAllReferences();
 214   delete &getNMDOps(Operands);
 215 }
 216
 217 /// getNumElements - Return number of NamedMDNode elements.
 218 unsigned NamedMDNode::getNumElements() const {
 219   return (unsigned)getNMDOps(Operands).size();
 220 }
 221
 222 /// getElement - Return specified element.
 223 MetadataBase *NamedMDNode::getElement(unsigned i) const {
 224   assert(i < getNumElements() && "Invalid element number!");
 225   return getNMDOps(Operands)[i];
 226 }
 227
 228 /// addElement - Add metadata element.
 229 void NamedMDNode::addElement(MetadataBase *M) {
 230   getNMDOps(Operands).push_back(TrackingVH<MetadataBase>(M));
 231 }
 232
 233 /// eraseFromParent - Drop all references and remove the node from parent
 234 /// module.
 235 void NamedMDNode::eraseFromParent() {
 236   getParent()->getNamedMDList().erase(this);
 237 }
 238
 239 /// dropAllReferences - Remove all uses and clear node vector.
 240 void NamedMDNode::dropAllReferences() {
 241   getNMDOps(Operands).clear();
 242 }
 243
 244
 245 //===----------------------------------------------------------------------===//
 246 // MetadataContextImpl implementation.
 247 //
 248 namespace llvm {
 249 class MetadataContextImpl {
 250 public:
 251   typedef std::pair<unsigned, TrackingVH<MDNode> > MDPairTy;
 252   typedef SmallVector<MDPairTy, 2> MDMapTy;
 253   typedef DenseMap<const Instruction *, MDMapTy> MDStoreTy;
 254   friend class BitcodeReader;
 255 private:
 256
 257   /// MetadataStore - Collection of metadata used in this context.
 258   MDStoreTy MetadataStore;
 259
 260   /// MDHandlerNames - Map to hold metadata handler names.
 261   StringMap<unsigned> MDHandlerNames;
 262
 263 public:
 264   // Name <-> ID mapping methods.
 265   unsigned getMDKindID(StringRef Name);
 266   void getMDKindNames(SmallVectorImpl<StringRef> &) const;
 267
 268
 269   // Instruction metadata methods.
 270   MDNode *getMetadata(const Instruction *Inst, unsigned Kind);
 271   void getAllMetadata(const Instruction *Inst,
 272                       SmallVectorImpl<std::pair<unsigned, MDNode*> > &MDs)const;
 273
 274   void setMetadata(Instruction *Inst, unsigned Kind, MDNode *Node);
 275
 276   /// removeAllMetadata - Remove all metadata attached with an instruction.
 277   void removeAllMetadata(Instruction *Inst);
 278
 279
 280
 281   /// copyMD - If metadata is attached with Instruction In1 then attach
 282   /// the same metadata to In2.
 283   void copyMD(Instruction *In1, Instruction *In2);
 284
 285
 286   /// ValueIsDeleted - This handler is used to update metadata store
 287   /// when a value is deleted.
 288   void ValueIsDeleted(const Value *) {}
 289   void ValueIsDeleted(Instruction *Inst) {
 290     removeAllMetadata(Inst);
 291   }
 292   void ValueIsRAUWd(Value *V1, Value *V2);
 293
 294   /// ValueIsCloned - This handler is used to update metadata store
 295   /// when In1 is cloned to create In2.
 296   void ValueIsCloned(const Instruction *In1, Instruction *In2);
 297 };
 298 }
 299
 300 /// getMDKindID - Return a unique non-zero ID for the specified metadata kind.
 301 unsigned MetadataContextImpl::getMDKindID(StringRef Name) {
 302   unsigned &Entry = MDHandlerNames[Name];
 303
 304   // If this is new, assign it its ID.
 305   if (Entry == 0) Entry = MDHandlerNames.size();
 306   return Entry;
 307 }
 308
 309 /// getHandlerNames - Populate client supplied smallvector using custome
 310 /// metadata name and ID.
 311 void MetadataContextImpl::
 312 getMDKindNames(SmallVectorImpl<StringRef> &Names) const {
 313   Names.resize(MDHandlerNames.size()+1);
 314   Names[0] = "";
 315   for (StringMap<unsigned>::const_iterator I = MDHandlerNames.begin(),
 316        E = MDHandlerNames.end(); I != E; ++I)
 317     // MD Handlers are numbered from 1.
 318     Names[I->second] = I->first();
 319 }
 320
 321
 322 /// getMetadata - Get the metadata of given kind attached to an Instruction.
 323 /// If the metadata is not found then return 0.
 324 MDNode *MetadataContextImpl::
 325 getMetadata(const Instruction *Inst, unsigned MDKind) {
 326   MDMapTy &Info = MetadataStore[Inst];
 327   assert(Inst->hasMetadata() && !Info.empty() && "Shouldn't have called this");
 328
 329   for (MDMapTy::iterator I = Info.begin(), E = Info.end(); I != E; ++I)
 330     if (I->first == MDKind)
 331       return I->second;
 332   return 0;
 333 }
 334
 335 /// getAllMetadata - Get all of the metadata attached to an Instruction.
 336 void MetadataContextImpl::
 337 getAllMetadata(const Instruction *Inst,
 338                SmallVectorImpl<std::pair<unsigned, MDNode*> > &Result) const {
 339   assert(Inst->hasMetadata() && MetadataStore.find(Inst) != MetadataStore.end()
 340          && "Shouldn't have called this");
 341   const MDMapTy &Info = MetadataStore.find(Inst)->second;
 342   assert(!Info.empty() && "Shouldn't have called this");
 343
 344   Result.clear();
 345   Result.append(Info.begin(), Info.end());
 346
 347   // Sort the resulting array so it is stable.
 348   if (Result.size() > 1)
 349     array_pod_sort(Result.begin(), Result.end());
 350 }
 351
 352
 353 void MetadataContextImpl::setMetadata(Instruction *Inst, unsigned Kind,
 354                                       MDNode *Node) {
 355   // Handle the case when we're adding/updating metadata on an instruction.
 356   if (Node) {
 357     MDMapTy &Info = MetadataStore[Inst];
 358     assert(!Info.empty() == Inst->HasMetadata && "HasMetadata bit is wonked");
 359     if (Info.empty()) {
 360       Inst->HasMetadata = true;
 361     } else {
 362       // Handle replacement of an existing value.
 363       for (unsigned i = 0, e = Info.size(); i != e; ++i)
 364         if (Info[i].first == Kind) {
 365           Info[i].second = Node;
 366           return;
 367         }
 368     }
 369
 370     // No replacement, just add it to the list.
 371     Info.push_back(std::make_pair(Kind, Node));
 372     return;
 373   }
 374
 375   // Otherwise, we're removing metadata from an instruction.
 376   assert(Inst->HasMetadata && MetadataStore.count(Inst) &&
 377          "HasMetadata bit out of date!");
 378   MDMapTy &Info = MetadataStore[Inst];
 379
 380   // Common case is removing the only entry.
 381   if (Info.size() == 1 && Info[0].first == Kind) {
 382     MetadataStore.erase(Inst);
 383     Inst->HasMetadata = false;
 384     return;
 385   }
 386
 387   // Handle replacement of an existing value.
 388   for (unsigned i = 0, e = Info.size(); i != e; ++i)
 389     if (Info[i].first == Kind) {
 390       Info[i] = Info.back();
 391       Info.pop_back();
 392       assert(!Info.empty() && "Removing last entry should be handled above");
 393       return;
 394     }
 395   // Otherwise, removing an entry that doesn't exist on the instruction.
 396 }
 397
 398 /// removeAllMetadata - Remove all metadata attached with an instruction.
 399 void MetadataContextImpl::removeAllMetadata(Instruction *Inst) {
 400   MetadataStore.erase(Inst);
 401   Inst->HasMetadata = false;
 402 }
 403
 404
 405 /// copyMD - If metadata is attached with Instruction In1 then attach
 406 /// the same metadata to In2.
 407 void MetadataContextImpl::copyMD(Instruction *In1, Instruction *In2) {
 408   assert(In1 && In2 && "Invalid instruction!");
 409   MDMapTy &In1Info = MetadataStore[In1];
 410   if (In1Info.empty())
 411     return;
 412
 413   for (MDMapTy::iterator I = In1Info.begin(), E = In1Info.end(); I != E; ++I)
 414     In2->setMetadata(I->first, I->second);
 415 }
 416
 417 /// ValueIsCloned - This handler is used to update metadata store
 418 /// when In1 is cloned to create In2.
 419 void MetadataContextImpl::ValueIsCloned(const Instruction *In1,
 420                                         Instruction *In2) {
 421   // Find Metadata handles for In1.
 422   MDStoreTy::iterator I = MetadataStore.find(In1);
 423   assert(I != MetadataStore.end() && "Invalid custom metadata info!");
 424
 425   // FIXME: Give all metadata handlers a chance to adjust.
 426   MDMapTy &In1Info = I->second;
 427   for (MDMapTy::iterator I = In1Info.begin(), E = In1Info.end(); I != E; ++I)
 428     In2->setMetadata(I->first, I->second);
 429 }
 430
 431 /// ValueIsRAUWd - This handler is used when V1's all uses are replaced by
 432 /// V2.
 433 void MetadataContextImpl::ValueIsRAUWd(Value *V1, Value *V2) {
 434   Instruction *I1 = dyn_cast<Instruction>(V1);
 435   Instruction *I2 = dyn_cast<Instruction>(V2);
 436   if (!I1 || !I2)
 437     return;
 438
 439   // FIXME: Give custom handlers a chance to override this.
 440   ValueIsCloned(I1, I2);
 441 }
 442
 443 //===----------------------------------------------------------------------===//
 444 // MetadataContext implementation.
 445 //
 446 MetadataContext::MetadataContext() : pImpl(new MetadataContextImpl()) { }
 447 MetadataContext::~MetadataContext() { delete pImpl; }
 448
 449 /// isValidName - Return true if Name is a valid custom metadata handler name.
 450 bool MetadataContext::isValidName(StringRef MDName) {
 451   if (MDName.empty())
 452     return false;
 453
 454   if (!isalpha(MDName[0]))
 455     return false;
 456
 457   for (StringRef::iterator I = MDName.begin() + 1, E = MDName.end(); I != E;
 458        ++I) {
 459     if (!isalnum(*I) && *I != '_' && *I != '-' && *I != '.')
 460         return false;
 461   }
 462   return true;
 463 }
 464
 465 /// getMDKindID - Return a unique non-zero ID for the specified metadata kind.
 466 unsigned MetadataContext::getMDKindID(StringRef Name) const {
 467   return pImpl->getMDKindID(Name);
 468 }
 469
 470 /// copyMD - If metadata is attached with Instruction In1 then attach
 471 /// the same metadata to In2.
 472 void MetadataContext::copyMD(Instruction *In1, Instruction *In2) {
 473   pImpl->copyMD(In1, In2);
 474 }
 475
 476 /// getHandlerNames - Populate client supplied smallvector using custome
 477 /// metadata name and ID.
 478 void MetadataContext::getMDKindNames(SmallVectorImpl<StringRef> &N) const {
 479   pImpl->getMDKindNames(N);
 480 }
 481
 482 /// ValueIsDeleted - This handler is used to update metadata store
 483 /// when a value is deleted.
 484 void MetadataContext::ValueIsDeleted(Instruction *Inst) {
 485   pImpl->ValueIsDeleted(Inst);
 486 }
 487 void MetadataContext::ValueIsRAUWd(Value *V1, Value *V2) {
 488   pImpl->ValueIsRAUWd(V1, V2);
 489 }
 490
 491 /// ValueIsCloned - This handler is used to update metadata store
 492 /// when In1 is cloned to create In2.
 493 void MetadataContext::ValueIsCloned(const Instruction *In1, Instruction *In2) {
 494   pImpl->ValueIsCloned(In1, In2);
 495 }
 496
 497 //===----------------------------------------------------------------------===//
 498 // Instruction Metadata method implementations.
 499 //
 500
 501 void Instruction::setMetadata(const char *Kind, MDNode *Node) {
 502   if (Node == 0 && !hasMetadata()) return;
 503   setMetadata(getContext().getMetadata().getMDKindID(Kind), Node);
 504 }
 505
 506 MDNode *Instruction::getMetadataImpl(const char *Kind) const {
 507   return getMetadataImpl(getContext().getMetadata().getMDKindID(Kind));
 508 }
 509
 510 /// setMetadata - Set the metadata of of the specified kind to the specified
 511 /// node.  This updates/replaces metadata if already present, or removes it if
 512 /// Node is null.
 513 void Instruction::setMetadata(unsigned KindID, MDNode *Node) {
 514   if (Node == 0 && !hasMetadata()) return;
 515
 516   getContext().getMetadata().pImpl->setMetadata(this, KindID, Node);
 517 }
 518
 519 MDNode *Instruction::getMetadataImpl(unsigned KindID) const {
 520   return getContext().getMetadata().pImpl->getMetadata(this, KindID);
 521 }
 522
 523 void Instruction::getAllMetadataImpl(SmallVectorImpl<std::pair<unsigned,
 524                                        MDNode*> > &Result)const {
 525   getContext().getMetadata().pImpl->getAllMetadata(this, Result);
 526 }
 527