include/llvm/MDNode.h

   1 //===-- llvm/Metadata.h - Constant class subclass 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 the subclasses of Constant,
  12 /// which represent the different flavors of constant values that live in LLVM.
  13 /// Note that Constants are immutable (once created they never change) and are
  14 /// fully shared by structural equivalence.  This means that two structurally
  15 /// equivalent constants will always have the same address.  Constant's are
  16 /// created on demand as needed and never deleted: thus clients don't have to
  17 /// worry about the lifetime of the objects.
  18 //
  19 //===----------------------------------------------------------------------===//
  20
  21 #ifndef LLVM_MDNODE_H
  22 #define LLVM_MDNODE_H
  23
  24 #include "llvm/Constant.h"
  25 #include "llvm/Type.h"
  26 #include "llvm/ADT/FoldingSet.h"
  27 #include "llvm/ADT/SmallVector.h"
  28 #include "llvm/Support/ErrorHandling.h"
  29 #include "llvm/Support/ValueHandle.h"
  30
  31 namespace llvm {
  32
  33 //===----------------------------------------------------------------------===//
  34 // MetadataBase  - A base class for MDNode and MDString.
  35 class MetadataBase : public Value {
  36 public:
  37   MetadataBase(const Type *Ty, unsigned scid)
  38     : Value(Ty, scid) {}
  39
  40   /// getType() specialization - Type is always MetadataTy.
  41   ///
  42   inline const Type *getType() const {
  43     return Type::MetadataTy;
  44   }
  45
  46   /// isNullValue - Return true if this is the value that would be returned by
  47   /// getNullValue.  This always returns false because getNullValue will never
  48   /// produce metadata.
  49   virtual bool isNullValue() const {
  50     return false;
  51   }
  52
  53   /// Methods for support type inquiry through isa, cast, and dyn_cast:
  54   static inline bool classof(const MDString *) { return true; }
  55   static bool classof(const Value *V) {
  56     return V->getValueID() == MDStringVal || V->getValueID() == MDNodeVal;
  57   }
  58 };
  59
  60 //===----------------------------------------------------------------------===//
  61 /// MDString - a single uniqued string.
  62 /// These are used to efficiently contain a byte sequence for metadata.
  63 ///
  64 class MDString : public MetadataBase {
  65   MDString(const MDString &);            // DO NOT IMPLEMENT
  66
  67   const char *StrBegin, *StrEnd;
  68   friend class LLVMContextImpl;
  69
  70 public:
  71   MDString(const char *begin, const char *end)
  72     : MetadataBase(Type::MetadataTy, Value::MDStringVal),
  73       StrBegin(begin), StrEnd(end) {}
  74
  75   intptr_t size() const { return StrEnd - StrBegin; }
  76
  77   /// begin() - Pointer to the first byte of the string.
  78   ///
  79   const char *begin() const { return StrBegin; }
  80
  81   /// end() - Pointer to one byte past the end of the string.
  82   ///
  83   const char *end() const { return StrEnd; }
  84
  85   /// Methods for support type inquiry through isa, cast, and dyn_cast:
  86   static inline bool classof(const MDString *) { return true; }
  87   static bool classof(const Value *V) {
  88     return V->getValueID() == MDStringVal;
  89   }
  90 };
  91
  92 //===----------------------------------------------------------------------===//
  93 /// MDNode - a tuple of other values.
  94 /// These contain a list of the values that represent the metadata.
  95 ///
  96 class MDNode : public MetadataBase, public FoldingSetNode {
  97   MDNode(const MDNode &);      // DO NOT IMPLEMENT
  98
  99   friend class LLVMContextImpl;
 100
 101   void replaceElement(Value *From, Value *To);
 102
 103   SmallVector<WeakVH, 4> Node;
 104   typedef SmallVectorImpl<WeakVH>::iterator elem_iterator;
 105
 106 protected:
 107   explicit MDNode(Value*const* Vals, unsigned NumVals);
 108 public:
 109   typedef SmallVectorImpl<WeakVH>::const_iterator const_elem_iterator;
 110
 111   Value *getElement(unsigned i) const {
 112     return Node[i];
 113   }
 114
 115   unsigned getNumElements() const {
 116     return Node.size();
 117   }
 118
 119   bool elem_empty() const {
 120     return Node.empty();
 121   }
 122
 123   const_elem_iterator elem_begin() const {
 124     return Node.begin();
 125   }
 126
 127   const_elem_iterator elem_end() const {
 128     return Node.end();
 129   }
 130
 131   /// getType() specialization - Type is always MetadataTy.
 132   ///
 133   inline const Type *getType() const {
 134     return Type::MetadataTy;
 135   }
 136
 137   /// isNullValue - Return true if this is the value that would be returned by
 138   /// getNullValue.  This always returns false because getNullValue will never
 139   /// produce metadata.
 140   virtual bool isNullValue() const {
 141     return false;
 142   }
 143
 144   /// Profile - calculate a unique identifier for this MDNode to collapse
 145   /// duplicates
 146   void Profile(FoldingSetNodeID &ID) const;
 147
 148   virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U) {
 149     llvm_unreachable("This should never be called because MDNodes have no ops");
 150   }
 151
 152   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 153   static inline bool classof(const MDNode *) { return true; }
 154   static bool classof(const Value *V) {
 155     return V->getValueID() == MDNodeVal;
 156   }
 157 };
 158
 159 } // end llvm namespace
 160
 161 #endif