remove DebugLoc from MCInst and eliminate "Comment printing" from
[oota-llvm.git] / include / llvm / Metadata.h
index f341475afb50b00063fecdc2a02f7a8ef6724c60..0844006396d8a0e2f7b56d7ace1be4d47fa6f2e0 100644 (file)
 #ifndef LLVM_MDNODE_H
 #define LLVM_MDNODE_H
 
-#include "llvm/Value.h"
+#include "llvm/User.h"
 #include "llvm/Type.h"
+#include "llvm/OperandTraits.h"
 #include "llvm/ADT/FoldingSet.h"
 #include "llvm/ADT/SmallVector.h"
+#include "llvm/ADT/SmallPtrSet.h"
+#include "llvm/ADT/ilist_node.h"
 #include "llvm/Support/ErrorHandling.h"
 #include "llvm/Support/ValueHandle.h"
 
 namespace llvm {
 class Constant;
+class LLVMContext;
 
 //===----------------------------------------------------------------------===//
 // MetadataBase  - A base class for MDNode, MDString and NamedMDNode.
-class MetadataBase : public Value {
+class MetadataBase : public User {
+private:
+  /// ReservedSpace - The number of operands actually allocated.  NumOperands is
+  /// the number actually in use.
+  unsigned ReservedSpace;
+
 protected:
   MetadataBase(const Type *Ty, unsigned scid)
-    : Value(Ty, scid) {}
+    : User(Ty, scid, NULL, 0), ReservedSpace(0) {}
 
+  void resizeOperands(unsigned NumOps);
 public:
-  /// getType() specialization - Type is always MetadataTy.
-  ///
-  inline const Type *getType() const {
-    return Type::MetadataTy;
-  }
-
   /// isNullValue - Return true if this is the value that would be returned by
   /// getNullValue.  This always returns false because getNullValue will never
   /// produce metadata.
@@ -48,7 +52,7 @@ public:
   }
 
   /// Methods for support type inquiry through isa, cast, and dyn_cast:
-  static inline bool classof(const MDString *) { return true; }
+  static inline bool classof(const MetadataBase *) { return true; }
   static bool classof(const Value *V) {
     return V->getValueID() == MDStringVal || V->getValueID() == MDNodeVal
       || V->getValueID() == NamedMDNodeVal;
@@ -61,14 +65,21 @@ public:
 /// MDString is always unnamd.
 class MDString : public MetadataBase {
   MDString(const MDString &);            // DO NOT IMPLEMENT
-  StringRef Str;
-  friend class LLVMContextImpl;
+  void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
+  unsigned getNumOperands();             // DO NOT IMPLEMENT
 
+  StringRef Str;
 protected:
-  explicit MDString(const char *begin, unsigned l)
-    : MetadataBase(Type::MetadataTy, Value::MDStringVal), Str(begin, l) {}
+  explicit MDString(LLVMContext &C, const char *begin, unsigned l)
+    : MetadataBase(Type::getMetadataTy(C), Value::MDStringVal), Str(begin, l) {}
 
 public:
+  // Do not allocate any space for operands.
+  void *operator new(size_t s) {
+    return User::operator new(s, 0);
+  }
+  static MDString *get(LLVMContext &Context, const StringRef &Str);
+  
   StringRef getString() const { return Str; }
 
   unsigned length() const { return Str.size(); }
@@ -93,43 +104,68 @@ public:
 /// These contain a list of the values that represent the metadata. 
 /// MDNode is always unnamed.
 class MDNode : public MetadataBase, public FoldingSetNode {
-  MDNode(const MDNode &);      // DO NOT IMPLEMENT
-
-  friend class LLVMContextImpl;
-
-  SmallVector<WeakVH, 4> Node;
-  typedef SmallVectorImpl<WeakVH>::iterator elem_iterator;
+  MDNode(const MDNode &);                // DO NOT IMPLEMENT
+  void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
+  // getNumOperands - Make this only available for private uses.
+  unsigned getNumOperands() { return User::getNumOperands();  }
+
+  friend class ElementVH;
+  // Use CallbackVH to hold MDNOde elements.
+  struct ElementVH : public CallbackVH {
+    MDNode *Parent;
+    ElementVH(Value *V, MDNode *P) : CallbackVH(V), Parent(P) {}
+    ~ElementVH() {}
+
+    virtual void deleted() {
+      Parent->replaceElement(this->operator Value*(), 0);
+    }
+
+    virtual void allUsesReplacedWith(Value *NV) {
+      Parent->replaceElement(this->operator Value*(), NV);
+    }
+  };
+  // Replace each instance of F from the element list of this node with T.
+  void replaceElement(Value *F, Value *T);
+
+  SmallVector<ElementVH, 4> Node;
 
 protected:
-  explicit MDNode(Value*const* Vals, unsigned NumVals);
+  explicit MDNode(LLVMContext &C, Value*const* Vals, unsigned NumVals);
 public:
-  typedef SmallVectorImpl<WeakVH>::const_iterator const_elem_iterator;
+  // Do not allocate any space for operands.
+  void *operator new(size_t s) {
+    return User::operator new(s, 0);
+  }
+  // Constructors and destructors.
+  static MDNode *get(LLVMContext &Context, 
+                     Value* const* Vals, unsigned NumVals);
 
+  /// dropAllReferences - Remove all uses and clear node vector.
+  void dropAllReferences();
+
+  /// ~MDNode - Destroy MDNode.
+  ~MDNode();
+  
+  /// getElement - Return specified element.
   Value *getElement(unsigned i) const {
+    assert (getNumElements() > i && "Invalid element number!");
     return Node[i];
   }
 
+  /// getNumElements - Return number of MDNode elements.
   unsigned getNumElements() const {
     return Node.size();
   }
 
-  bool elem_empty() const {
-    return Node.empty();
-  }
-
-  const_elem_iterator elem_begin() const {
-    return Node.begin();
-  }
-
-  const_elem_iterator elem_end() const {
-    return Node.end();
-  }
-
-  /// getType() specialization - Type is always MetadataTy.
-  ///
-  inline const Type *getType() const {
-    return Type::MetadataTy;
-  }
+  // Element access
+  typedef SmallVectorImpl<ElementVH>::const_iterator const_elem_iterator;
+  typedef SmallVectorImpl<ElementVH>::iterator elem_iterator;
+  /// elem_empty - Return true if MDNode is empty.
+  bool elem_empty() const                { return Node.empty(); }
+  const_elem_iterator elem_begin() const { return Node.begin(); }
+  const_elem_iterator elem_end() const   { return Node.end();   }
+  elem_iterator elem_begin()             { return Node.begin(); }
+  elem_iterator elem_end()               { return Node.end();   }
 
   /// isNullValue - Return true if this is the value that would be returned by
   /// getNullValue.  This always returns false because getNullValue will never
@@ -166,67 +202,84 @@ public:
   }
 
   operator MetadataBase*() const {
-   return cast<MetadataBase>(getValPtr());
+   return dyn_cast_or_null<MetadataBase>(getValPtr());
   }
 };
 
 //===----------------------------------------------------------------------===//
 /// NamedMDNode - a tuple of other metadata. 
 /// NamedMDNode is always named. All NamedMDNode element has a type of metadata.
-class NamedMDNode : public MetadataBase {
-  NamedMDNode(const NamedMDNode &);      // DO NOT IMPLEMENT
+template<typename ValueSubClass, typename ItemParentClass>
+  class SymbolTableListTraits;
 
+class NamedMDNode : public MetadataBase, public ilist_node<NamedMDNode> {
+  friend class SymbolTableListTraits<NamedMDNode, Module>;
   friend class LLVMContextImpl;
 
+  NamedMDNode(const NamedMDNode &);      // DO NOT IMPLEMENT
+  void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
+  // getNumOperands - Make this only available for private uses.
+  unsigned getNumOperands() { return User::getNumOperands();  }
+
   Module *Parent;
-  StringRef Name;
   SmallVector<WeakMetadataVH, 4> Node;
   typedef SmallVectorImpl<WeakMetadataVH>::iterator elem_iterator;
 
 protected:
-  explicit NamedMDNode(const char *N, unsigned NameLength,
-                       MetadataBase*const* Vals, unsigned NumVals,
-                       Module *M = 0);
+  explicit NamedMDNode(LLVMContext &C, const Twine &N, MetadataBase*const* Vals, 
+                       unsigned NumVals, Module *M = 0);
 public:
-  static NamedMDNode *Create(const char *N, unsigned NamedLength,
-                             MetadataBase*const*MDs, unsigned NumMDs,
-                             Module *M = 0) {
-    return new NamedMDNode(N,  NamedLength, MDs, NumMDs, M);
+  // Do not allocate any space for operands.
+  void *operator new(size_t s) {
+    return User::operator new(s, 0);
+  }
+  static NamedMDNode *Create(LLVMContext &C, const Twine &N, 
+                             MetadataBase*const*MDs, 
+                             unsigned NumMDs, Module *M = 0) {
+    return new NamedMDNode(C, N, MDs, NumMDs, M);
   }
 
-  typedef SmallVectorImpl<WeakMetadataVH>::const_iterator const_elem_iterator;
+  static NamedMDNode *Create(const NamedMDNode *NMD, Module *M = 0);
+
+  /// eraseFromParent - Drop all references and remove the node from parent
+  /// module.
+  void eraseFromParent();
+
+  /// dropAllReferences - Remove all uses and clear node vector.
+  void dropAllReferences();
 
-  StringRef getName() const { return Name; }
+  /// ~NamedMDNode - Destroy NamedMDNode.
+  ~NamedMDNode();
 
   /// getParent - Get the module that holds this named metadata collection.
   inline Module *getParent() { return Parent; }
   inline const Module *getParent() const { return Parent; }
+  void setParent(Module *M) { Parent = M; }
 
-  Value *getElement(unsigned i) const {
+  /// getElement - Return specified element.
+  MetadataBase *getElement(unsigned i) const {
+    assert (getNumElements() > i && "Invalid element number!");
     return Node[i];
   }
 
+  /// getNumElements - Return number of NamedMDNode elements.
   unsigned getNumElements() const {
     return Node.size();
   }
 
-  bool elem_empty() const {
-    return Node.empty();
+  /// addElement - Add metadata element.
+  void addElement(MetadataBase *M) {
+    resizeOperands(0);
+    OperandList[NumOperands++] = M;
+    Node.push_back(WeakMetadataVH(M));
   }
 
-  const_elem_iterator elem_begin() const {
-    return Node.begin();
-  }
-
-  const_elem_iterator elem_end() const {
-    return Node.end();
-  }
-
-  /// getType() specialization - Type is always MetadataTy.
-  ///
-  inline const Type *getType() const {
-    return Type::MetadataTy;
-  }
+  typedef SmallVectorImpl<WeakMetadataVH>::const_iterator const_elem_iterator;
+  bool elem_empty() const                { return Node.empty(); }
+  const_elem_iterator elem_begin() const { return Node.begin(); }
+  const_elem_iterator elem_end() const   { return Node.end();   }
+  elem_iterator elem_begin()             { return Node.begin(); }
+  elem_iterator elem_end()               { return Node.end();   }
 
   /// isNullValue - Return true if this is the value that would be returned by
   /// getNullValue.  This always returns false because getNullValue will never
@@ -235,10 +288,6 @@ public:
     return false;
   }
 
-  /// Profile - calculate a unique identifier for this MDNode to collapse
-  /// duplicates
-  void Profile(FoldingSetNodeID &ID) const;
-
   virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U) {
     llvm_unreachable(
                 "This should never be called because NamedMDNodes have no ops");