CodeGen: minor style tweaks to SSP

[oota-llvm.git] / include / llvm / IR / LeakDetector.h

diff --git a/include/llvm/IR/LeakDetector.h b/include/llvm/IR/LeakDetector.h
index cb18df875867a7591dda491cd27efe2ddb3b6816..b014fe081f003ad3a113defdba2099deaa884030 100644 (file)
--- a/include/llvm/IR/LeakDetector.h
+++ b/include/llvm/IR/LeakDetector.h
@@ -28,13 +28,14 @@ namespace llvm {
 
 class LLVMContext;
 class Value;
+class MDNode;
 
 struct LeakDetector {
   /// addGarbageObject - Add a pointer to the internal set of "garbage" object
   /// pointers.  This should be called when objects are created, or if they are
   /// taken out of an owning collection.
   ///
-  static void addGarbageObject(void *Object) {
+  template <class T> static void addGarbageObject(T *Object) {
 #ifndef NDEBUG
     addGarbageObjectImpl(Object);
 #endif
@@ -44,7 +45,7 @@ struct LeakDetector {
   /// our "garbage" objects.  This should be called when an object is added to
   /// an "owning" collection.
   ///
-  static void removeGarbageObject(void *Object) {
+  template <class T> static void removeGarbageObject(T *Object) {
 #ifndef NDEBUG
     removeGarbageObjectImpl(Object);
 #endif
@@ -63,25 +64,27 @@ struct LeakDetector {
 #endif
   }
 
-  /// Overload the normal methods to work better with Value*'s because they are
-  /// by far the most common in LLVM.  This does not affect the actual
-  /// functioning of this class, it just makes the warning messages nicer.
-  ///
-  static void addGarbageObject(const Value *Object) {
-#ifndef NDEBUG
-    addGarbageObjectImpl(Object);
-#endif
-  }
-  static void removeGarbageObject(const Value *Object) {
-#ifndef NDEBUG
-    removeGarbageObjectImpl(Object);
-#endif
-  }
-
 private:
-  // If we are debugging, the actual implementations will be called...
+  /// Overload the normal methods to work better with Value* because they are
+  /// by far the most common in LLVM.
+  ///
+  /// Besides making the warning messages nicer, this hides errors by storing
+  /// Value* in a different leak-detection container than other classes.
   static void addGarbageObjectImpl(const Value *Object);
   static void removeGarbageObjectImpl(const Value *Object);
+
+  /// Overload the normal methods to work better with MDNode* to improve error
+  /// messages.
+  ///
+  /// For better or worse, this hides errors when other types are added as
+  /// garbage, deleted without being removed, and an MDNode is allocated in the
+  /// same spot.
+  ///
+  /// \note Only handle \a MDNode for now, since we can't always get access to
+  /// an \a LLVMContext for other \a Metadata types.
+  static void addGarbageObjectImpl(const MDNode *Object);
+  static void removeGarbageObjectImpl(const MDNode *Object);
+
   static void addGarbageObjectImpl(void *Object);
   static void removeGarbageObjectImpl(void *Object);
   static void checkForGarbageImpl(LLVMContext &C, const std::string &Message);