include/llvm/Metadata.h

   1 //===-- llvm/Metadata.h - Metadata definitions ------------------*- C++ -*-===//
   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 /// @file
  11 /// This file contains the declarations for metadata subclasses.
  12 /// They represent the different flavors of metadata that live in LLVM.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef LLVM_METADATA_H
  17 #define LLVM_METADATA_H
  18
  19 #include "llvm/Value.h"
  20 #include "llvm/Type.h"
  21 #include "llvm/ADT/FoldingSet.h"
  22 #include "llvm/ADT/SmallPtrSet.h"
  23 #include "llvm/ADT/SmallVector.h"
  24 #include "llvm/ADT/ilist_node.h"
  25 #include "llvm/Support/ValueHandle.h"
  26
  27 namespace llvm {
  28 class Constant;
  29 class Instruction;
  30 class LLVMContext;
  31 class MetadataContextImpl;
  32
  33 //===----------------------------------------------------------------------===//
  34 // MetadataBase  - A base class for MDNode, MDString and NamedMDNode.
  35 class MetadataBase : public Value {
  36 protected:
  37   MetadataBase(const Type *Ty, unsigned scid)
  38     : Value(Ty, scid) {}
  39
  40 public:
  41
  42   /// Methods for support type inquiry through isa, cast, and dyn_cast:
  43   static inline bool classof(const MetadataBase *) { return true; }
  44   static bool classof(const Value *V) {
  45     return V->getValueID() == MDStringVal || V->getValueID() == MDNodeVal
  46       || V->getValueID() == NamedMDNodeVal;
  47   }
  48 };
  49
  50 //===----------------------------------------------------------------------===//
  51 /// MDString - a single uniqued string.
  52 /// These are used to efficiently contain a byte sequence for metadata.
  53 /// MDString is always unnamd.
  54 class MDString : public MetadataBase {
  55   MDString(const MDString &);            // DO NOT IMPLEMENT
  56
  57   StringRef Str;
  58 protected:
  59   explicit MDString(LLVMContext &C, StringRef S)
  60     : MetadataBase(Type::getMetadataTy(C), Value::MDStringVal), Str(S) {}
  61
  62 public:
  63   static MDString *get(LLVMContext &Context, StringRef Str);
  64   static MDString *get(LLVMContext &Context, const char *Str);
  65
  66   StringRef getString() const { return Str; }
  67
  68   unsigned getLength() const { return (unsigned)Str.size(); }
  69
  70   typedef StringRef::iterator iterator;
  71
  72   /// begin() - Pointer to the first byte of the string.
  73   ///
  74   iterator begin() const { return Str.begin(); }
  75
  76   /// end() - Pointer to one byte past the end of the string.
  77   ///
  78   iterator end() const { return Str.end(); }
  79
  80   /// Methods for support type inquiry through isa, cast, and dyn_cast:
  81   static inline bool classof(const MDString *) { return true; }
  82   static bool classof(const Value *V) {
  83     return V->getValueID() == MDStringVal;
  84   }
  85 };
  86
  87 //===----------------------------------------------------------------------===//
  88 /// MDNode - a tuple of other values.
  89 /// These contain a list of the values that represent the metadata.
  90 /// MDNode is always unnamed.
  91 class MDNode : public MetadataBase, public FoldingSetNode {
  92   MDNode(const MDNode &);                // DO NOT IMPLEMENT
  93
  94   friend class ElementVH;
  95   // Use CallbackVH to hold MDNode elements.
  96   struct ElementVH : public CallbackVH {
  97     MDNode *Parent;
  98     ElementVH() {}
  99     ElementVH(Value *V, MDNode *P) : CallbackVH(V), Parent(P) {}
 100     ~ElementVH() {}
 101
 102     virtual void deleted() {
 103       Parent->replaceElement(this->operator Value*(), 0);
 104     }
 105
 106     virtual void allUsesReplacedWith(Value *NV) {
 107       Parent->replaceElement(this->operator Value*(), NV);
 108     }
 109   };
 110
 111   static const unsigned short FunctionLocalBit = 1;
 112
 113   // Replace each instance of F from the element list of this node with T.
 114   void replaceElement(Value *F, Value *T);
 115
 116   ElementVH *Node;
 117   unsigned NodeSize;
 118
 119 protected:
 120   explicit MDNode(LLVMContext &C, Value *const *Vals, unsigned NumVals,
 121                   bool isFunctionLocal);
 122 public:
 123   // Constructors and destructors.
 124   static MDNode *get(LLVMContext &Context, Value *const *Vals, unsigned NumVals,
 125                      bool isFunctionLocal = false);
 126
 127   /// ~MDNode - Destroy MDNode.
 128   ~MDNode();
 129
 130   /// getElement - Return specified element.
 131   Value *getElement(unsigned i) const {
 132     assert(i < getNumElements() && "Invalid element number!");
 133     return Node[i];
 134   }
 135
 136   /// getNumElements - Return number of MDNode elements.
 137   unsigned getNumElements() const { return NodeSize; }
 138
 139   /// isFunctionLocal - Return whether MDNode is local to a function.
 140   /// Note: MDNodes are designated as function-local when created, and keep
 141   ///       that designation even if their operands are modified to no longer
 142   ///       refer to function-local IR.
 143   bool isFunctionLocal() const { return SubclassData & FunctionLocalBit; }
 144
 145   /// getLocalFunction - Return false if MDNode's recursive function-localness
 146   /// is invalid (local to more than one function).  Return true otherwise.
 147   /// If MDNode has one function to which it is local, set LocalFunction to that
 148   /// function.
 149   bool getLocalFunction(Function *LocalFunction,
 150                         SmallPtrSet<MDNode *, 32> *VisitedMDNodes = NULL);
 151
 152   /// Profile - calculate a unique identifier for this MDNode to collapse
 153   /// duplicates
 154   void Profile(FoldingSetNodeID &ID) const;
 155
 156   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 157   static inline bool classof(const MDNode *) { return true; }
 158   static bool classof(const Value *V) {
 159     return V->getValueID() == MDNodeVal;
 160   }
 161 };
 162
 163 //===----------------------------------------------------------------------===//
 164 /// NamedMDNode - a tuple of other metadata.
 165 /// NamedMDNode is always named. All NamedMDNode element has a type of metadata.
 166 template<typename ValueSubClass, typename ItemParentClass>
 167   class SymbolTableListTraits;
 168
 169 class NamedMDNode : public MetadataBase, public ilist_node<NamedMDNode> {
 170   friend class SymbolTableListTraits<NamedMDNode, Module>;
 171   friend class LLVMContextImpl;
 172
 173   NamedMDNode(const NamedMDNode &);      // DO NOT IMPLEMENT
 174
 175   Module *Parent;
 176   SmallVector<TrackingVH<MetadataBase>, 4> Node;
 177
 178   void setParent(Module *M) { Parent = M; }
 179 protected:
 180   explicit NamedMDNode(LLVMContext &C, const Twine &N, MetadataBase*const *Vals,
 181                        unsigned NumVals, Module *M = 0);
 182 public:
 183   static NamedMDNode *Create(LLVMContext &C, const Twine &N,
 184                              MetadataBase *const *MDs,
 185                              unsigned NumMDs, Module *M = 0) {
 186     return new NamedMDNode(C, N, MDs, NumMDs, M);
 187   }
 188
 189   static NamedMDNode *Create(const NamedMDNode *NMD, Module *M = 0);
 190
 191   /// eraseFromParent - Drop all references and remove the node from parent
 192   /// module.
 193   void eraseFromParent();
 194
 195   /// dropAllReferences - Remove all uses and clear node vector.
 196   void dropAllReferences();
 197
 198   /// ~NamedMDNode - Destroy NamedMDNode.
 199   ~NamedMDNode();
 200
 201   /// getParent - Get the module that holds this named metadata collection.
 202   inline Module *getParent() { return Parent; }
 203   inline const Module *getParent() const { return Parent; }
 204
 205   /// getElement - Return specified element.
 206   MetadataBase *getElement(unsigned i) const {
 207     assert(i < getNumElements() && "Invalid element number!");
 208     return Node[i];
 209   }
 210
 211   /// getNumElements - Return number of NamedMDNode elements.
 212   unsigned getNumElements() const {
 213     return (unsigned)Node.size();
 214   }
 215
 216   /// addElement - Add metadata element.
 217   void addElement(MetadataBase *M) {
 218     Node.push_back(TrackingVH<MetadataBase>(M));
 219   }
 220
 221   typedef SmallVectorImpl<TrackingVH<MetadataBase> >::iterator elem_iterator;
 222   typedef SmallVectorImpl<TrackingVH<MetadataBase> >::const_iterator
 223     const_elem_iterator;
 224   bool elem_empty() const                { return Node.empty(); }
 225   const_elem_iterator elem_begin() const { return Node.begin(); }
 226   const_elem_iterator elem_end() const   { return Node.end();   }
 227   elem_iterator elem_begin()             { return Node.begin(); }
 228   elem_iterator elem_end()               { return Node.end();   }
 229
 230   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 231   static inline bool classof(const NamedMDNode *) { return true; }
 232   static bool classof(const Value *V) {
 233     return V->getValueID() == NamedMDNodeVal;
 234   }
 235 };
 236
 237 //===----------------------------------------------------------------------===//
 238 /// MetadataContext -
 239 /// MetadataContext handles uniquing and assignment of IDs for custom metadata
 240 /// types. Custom metadata handler names do not contain spaces. And the name
 241 /// must start with an alphabet. The regular expression used to check name
 242 /// is [a-zA-Z$._][a-zA-Z$._0-9]*
 243 class MetadataContext {
 244   // DO NOT IMPLEMENT
 245   MetadataContext(MetadataContext&);
 246   void operator=(MetadataContext&);
 247
 248   MetadataContextImpl *const pImpl;
 249 public:
 250   MetadataContext();
 251   ~MetadataContext();
 252
 253   /// registerMDKind - Register a new metadata kind and return its ID.
 254   /// A metadata kind can be registered only once.
 255   unsigned registerMDKind(StringRef Name);
 256
 257   /// getMDKind - Return metadata kind. If the requested metadata kind
 258   /// is not registered then return 0.
 259   unsigned getMDKind(StringRef Name) const;
 260
 261   /// isValidName - Return true if Name is a valid custom metadata handler name.
 262   static bool isValidName(StringRef Name);
 263
 264   /// getMD - Get the metadata of given kind attached to an Instruction.
 265   /// If the metadata is not found then return 0.
 266   MDNode *getMD(unsigned Kind, const Instruction *Inst);
 267
 268   /// getMDs - Get the metadata attached to an Instruction.
 269   void getMDs(const Instruction *Inst,
 270         SmallVectorImpl<std::pair<unsigned, TrackingVH<MDNode> > > &MDs) const;
 271
 272   /// addMD - Attach the metadata of given kind to an Instruction.
 273   void addMD(unsigned Kind, MDNode *Node, Instruction *Inst);
 274
 275   /// removeMD - Remove metadata of given kind attached with an instuction.
 276   void removeMD(unsigned Kind, Instruction *Inst);
 277
 278   /// removeAllMetadata - Remove all metadata attached with an instruction.
 279   void removeAllMetadata(Instruction *Inst);
 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   /// getHandlerNames - Populate client supplied smallvector using custom
 286   /// metadata name and ID.
 287   void getHandlerNames(SmallVectorImpl<std::pair<unsigned, StringRef> >&) const;
 288
 289   /// ValueIsDeleted - This handler is used to update metadata store
 290   /// when a value is deleted.
 291   void ValueIsDeleted(const Value *) {}
 292   void ValueIsDeleted(Instruction *Inst);
 293   void ValueIsRAUWd(Value *V1, Value *V2);
 294
 295   /// ValueIsCloned - This handler is used to update metadata store
 296   /// when In1 is cloned to create In2.
 297   void ValueIsCloned(const Instruction *In1, Instruction *In2);
 298 };
 299
 300 } // end llvm namespace
 301
 302 #endif