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