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/ADT/FoldingSet.h"
  21 #include "llvm/ADT/ilist_node.h"
  22
  23 namespace llvm {
  24 class Constant;
  25 class Instruction;
  26 class LLVMContext;
  27 class Module;
  28 template <typename T> class SmallVectorImpl;
  29 template<typename ValueSubClass, typename ItemParentClass>
  30   class SymbolTableListTraits;
  31
  32
  33 //===----------------------------------------------------------------------===//
  34 // MetadataBase  - A base class for MDNode and MDString.
  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   }
  47 };
  48
  49 //===----------------------------------------------------------------------===//
  50 /// MDString - a single uniqued string.
  51 /// These are used to efficiently contain a byte sequence for metadata.
  52 /// MDString is always unnamd.
  53 class MDString : public MetadataBase {
  54   MDString(const MDString &);            // DO NOT IMPLEMENT
  55
  56   StringRef Str;
  57 protected:
  58   explicit MDString(LLVMContext &C, StringRef S);
  59
  60 public:
  61   static MDString *get(LLVMContext &Context, StringRef Str);
  62   static MDString *get(LLVMContext &Context, const char *Str);
  63
  64   StringRef getString() const { return Str; }
  65
  66   unsigned getLength() const { return (unsigned)Str.size(); }
  67
  68   typedef StringRef::iterator iterator;
  69
  70   /// begin() - Pointer to the first byte of the string.
  71   ///
  72   iterator begin() const { return Str.begin(); }
  73
  74   /// end() - Pointer to one byte past the end of the string.
  75   ///
  76   iterator end() const { return Str.end(); }
  77
  78   /// Methods for support type inquiry through isa, cast, and dyn_cast:
  79   static inline bool classof(const MDString *) { return true; }
  80   static bool classof(const Value *V) {
  81     return V->getValueID() == MDStringVal;
  82   }
  83 };
  84
  85
  86 class MDNodeOperand;
  87
  88 //===----------------------------------------------------------------------===//
  89 /// MDNode - a tuple of other values.
  90 class MDNode : public MetadataBase, public FoldingSetNode {
  91   MDNode(const MDNode &);                // DO NOT IMPLEMENT
  92   void operator=(const MDNode &);        // DO NOT IMPLEMENT
  93   friend class MDNodeOperand;
  94
  95   /// NumOperands - This many 'MDNodeOperand' items are co-allocated onto the
  96   /// end of this MDNode.
  97   unsigned NumOperands;
  98
  99   // Subclass data enums.
 100   enum {
 101     /// FunctionLocalBit - This bit is set if this MDNode is function local.
 102     /// This is true when it (potentially transitively) contains a reference to
 103     /// something in a function, like an argument, basicblock, or instruction.
 104     FunctionLocalBit = 1 << 0,
 105
 106     /// NotUniquedBit - This is set on MDNodes that are not uniqued because they
 107     /// have a null perand.
 108     NotUniquedBit    = 1 << 1,
 109
 110     /// DestroyFlag - This bit is set by destroy() so the destructor can assert
 111     /// that the node isn't being destroyed with a plain 'delete'.
 112     DestroyFlag      = 1 << 2
 113   };
 114
 115   // FunctionLocal enums.
 116   enum FunctionLocalness {
 117     FL_Unknown = -1,
 118     FL_No = 0,
 119     FL_Yes = 1
 120   };
 121
 122   // Replace each instance of F from the operand list of this node with T.
 123   void replaceOperand(MDNodeOperand *Op, Value *NewVal);
 124   ~MDNode();
 125
 126 protected:
 127   explicit MDNode(LLVMContext &C, Value *const *Vals, unsigned NumVals,
 128                   bool isFunctionLocal);
 129
 130   static MDNode *getMDNode(LLVMContext &C, Value *const *Vals, unsigned NumVals,
 131                            FunctionLocalness FL);
 132 public:
 133   // Constructors and destructors.
 134   static MDNode *get(LLVMContext &Context, Value *const *Vals,
 135                      unsigned NumVals);
 136   // getWhenValsUnresolved - Construct MDNode determining function-localness
 137   // from isFunctionLocal argument, not by analyzing Vals.
 138   static MDNode *getWhenValsUnresolved(LLVMContext &Context, Value *const *Vals,
 139                                        unsigned NumVals, bool isFunctionLocal);
 140
 141   /// getOperand - Return specified operand.
 142   Value *getOperand(unsigned i) const;
 143
 144   /// getNumOperands - Return number of MDNode operands.
 145   unsigned getNumOperands() const { return NumOperands; }
 146
 147   /// isFunctionLocal - Return whether MDNode is local to a function.
 148   /// Note: MDNodes are designated as function-local when created, and keep
 149   ///       that designation even if their operands are modified to no longer
 150   ///       refer to function-local IR.
 151   bool isFunctionLocal() const {
 152     return (getSubclassDataFromValue() & FunctionLocalBit) != 0;
 153   }
 154
 155   // destroy - Delete this node.  Only when there are no uses.
 156   void destroy();
 157
 158   /// Profile - calculate a unique identifier for this MDNode to collapse
 159   /// duplicates
 160   void Profile(FoldingSetNodeID &ID) const;
 161
 162   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 163   static inline bool classof(const MDNode *) { return true; }
 164   static bool classof(const Value *V) {
 165     return V->getValueID() == MDNodeVal;
 166   }
 167 private:
 168   bool isNotUniqued() const {
 169     return (getSubclassDataFromValue() & NotUniquedBit) != 0;
 170   }
 171   void setIsNotUniqued() {
 172     setValueSubclassData(getSubclassDataFromValue() | NotUniquedBit);
 173   }
 174
 175   // Shadow Value::setValueSubclassData with a private forwarding method so that
 176   // any future subclasses cannot accidentally use it.
 177   void setValueSubclassData(unsigned short D) {
 178     Value::setValueSubclassData(D);
 179   }
 180 };
 181
 182 //===----------------------------------------------------------------------===//
 183 /// NamedMDNode - a tuple of MDNodes.
 184 /// NamedMDNode is always named. All NamedMDNode operand has a type of metadata.
 185 class NamedMDNode : public Value, public ilist_node<NamedMDNode> {
 186   friend class SymbolTableListTraits<NamedMDNode, Module>;
 187   friend class ilist_traits<NamedMDNode>;
 188   friend class LLVMContextImpl;
 189   NamedMDNode(const NamedMDNode &);      // DO NOT IMPLEMENT
 190
 191   std::string Name;
 192   Module *Parent;
 193   void *Operands; // SmallVector<WeakVH<MDNode>, 4>
 194
 195   void setParent(Module *M) { Parent = M; }
 196 protected:
 197   explicit NamedMDNode(LLVMContext &C, StringRef N, MDNode*const *Vals,
 198                        unsigned NumVals, Module *M = 0);
 199 public:
 200   static NamedMDNode *Create(LLVMContext &C, StringRef N,
 201                              MDNode *const *MDs,
 202                              unsigned NumMDs, Module *M = 0) {
 203     return new NamedMDNode(C, N, MDs, NumMDs, M);
 204   }
 205
 206   static NamedMDNode *Create(const NamedMDNode *NMD, Module *M = 0);
 207
 208   /// eraseFromParent - Drop all references and remove the node from parent
 209   /// module.
 210   void eraseFromParent();
 211
 212   /// dropAllReferences - Remove all uses and clear node vector.
 213   void dropAllReferences();
 214
 215   /// ~NamedMDNode - Destroy NamedMDNode.
 216   ~NamedMDNode();
 217
 218   /// getParent - Get the module that holds this named metadata collection.
 219   inline Module *getParent() { return Parent; }
 220   inline const Module *getParent() const { return Parent; }
 221
 222   /// getOperand - Return specified operand.
 223   MDNode *getOperand(unsigned i) const;
 224
 225   /// getNumOperands - Return the number of NamedMDNode operands.
 226   unsigned getNumOperands() const;
 227
 228   /// addOperand - Add metadata operand.
 229   void addOperand(MDNode *M);
 230
 231   /// setName - Set the name of this named metadata.
 232   void setName(StringRef Name);
 233
 234   /// getName - Return a constant reference to this named metadata's name.
 235   StringRef getName() const;
 236
 237   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 238   static inline bool classof(const NamedMDNode *) { return true; }
 239   static bool classof(const Value *V) {
 240     return V->getValueID() == NamedMDNodeVal;
 241   }
 242 };
 243
 244 } // end llvm namespace
 245
 246 #endif