[llvm] r224060 - IR: Store MDNodes in a separate LeakDetector container

[Duncan P. N. Exon Smith]

Author: dexonsmith
Date: Thu Dec 11 15:39:39 2014
New Revision: 224060

URL: http://llvm.org/viewvc/llvm-project?rev=224060&view=rev
Log:
IR: Store MDNodes in a separate LeakDetector container

This gives us better leak detection messages, like `Value` has.

This also has the side effect of papering over a problem where
`MachineInstr`s are added as garbage to the leak detector and then
deleted without being removed.  If `MDNode::getTemporary()` allocates an
`MDNodeFwdDecl` in the same spot, the leak detector asserts.  By
separating `MDNode`s into their own container we lose that assertion.

Since `MachineInstr` is required to have a trivial destructor, its usage
of `LeakDetector` at all is pretty suspect.  I'll be sending a patch
soon to strip that out.

Modified:
    llvm/trunk/include/llvm/IR/LeakDetector.h
    llvm/trunk/lib/IR/LeakDetector.cpp
    llvm/trunk/lib/IR/LeaksContext.h

Modified: llvm/trunk/include/llvm/IR/LeakDetector.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/IR/LeakDetector.h?rev=224060&r1=224059&r2=224060&view=diff
==============================================================================
--- llvm/trunk/include/llvm/IR/LeakDetector.h (original)
+++ llvm/trunk/include/llvm/IR/LeakDetector.h Thu Dec 11 15:39:39 2014
@@ -28,6 +28,7 @@ namespace llvm {
 
 class LLVMContext;
 class Value;
+class MDNode;
 
 struct LeakDetector {
   /// addGarbageObject - Add a pointer to the internal set of "garbage" object
@@ -72,6 +73,18 @@ private:
   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);

Modified: llvm/trunk/lib/IR/LeakDetector.cpp
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/lib/IR/LeakDetector.cpp?rev=224060&r1=224059&r2=224060&view=diff
==============================================================================
--- llvm/trunk/lib/IR/LeakDetector.cpp (original)
+++ llvm/trunk/lib/IR/LeakDetector.cpp Thu Dec 11 15:39:39 2014
@@ -14,6 +14,7 @@
 #include "llvm/IR/LeakDetector.h"
 #include "LLVMContextImpl.h"
 #include "llvm/ADT/SmallPtrSet.h"
+#include "llvm/IR/Metadata.h"
 #include "llvm/IR/Value.h"
 #include "llvm/Support/Compiler.h"
 #include "llvm/Support/ManagedStatic.h"
@@ -39,6 +40,11 @@ void LeakDetector::addGarbageObjectImpl(
   pImpl->LLVMObjects.addGarbage(Object);
 }
 
+void LeakDetector::addGarbageObjectImpl(const MDNode *Object) {
+  LLVMContextImpl *pImpl = Object->getContext().pImpl;
+  pImpl->LLVMMDObjects.addGarbage(Object);
+}
+
 void LeakDetector::removeGarbageObjectImpl(void *Object) {
   sys::SmartScopedLock<true> Lock(*ObjectsLock);
   Objects->removeGarbage(Object);
@@ -49,6 +55,11 @@ void LeakDetector::removeGarbageObjectIm
   pImpl->LLVMObjects.removeGarbage(Object);
 }
 
+void LeakDetector::removeGarbageObjectImpl(const MDNode *Object) {
+  LLVMContextImpl *pImpl = Object->getContext().pImpl;
+  pImpl->LLVMMDObjects.removeGarbage(Object);
+}
+
 void LeakDetector::checkForGarbageImpl(LLVMContext &Context, 
                                        const std::string &Message) {
   LLVMContextImpl *pImpl = Context.pImpl;
@@ -56,10 +67,12 @@ void LeakDetector::checkForGarbageImpl(L
   
   Objects->setName("GENERIC");
   pImpl->LLVMObjects.setName("LLVM");
+  pImpl->LLVMMDObjects.setName("LLVM-MD");
   
   // use non-short-circuit version so that both checks are performed
   if (Objects->hasGarbage(Message) |
-      pImpl->LLVMObjects.hasGarbage(Message))
+      pImpl->LLVMObjects.hasGarbage(Message) |
+      pImpl->LLVMMDObjects.hasGarbage(Message))
     errs() << "\nThis is probably because you removed an object, but didn't "
            << "delete it.  Please check your code for memory leaks.\n";
 

Modified: llvm/trunk/lib/IR/LeaksContext.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/lib/IR/LeaksContext.h?rev=224060&r1=224059&r2=224060&view=diff
==============================================================================
--- llvm/trunk/lib/IR/LeaksContext.h (original)
+++ llvm/trunk/lib/IR/LeaksContext.h Thu Dec 11 15:39:39 2014
@@ -16,6 +16,7 @@
 #define LLVM_LIB_IR_LEAKSCONTEXT_H
 
 #include "llvm/ADT/SmallPtrSet.h"
+#include "llvm/IR/Metadata.h"
 #include "llvm/IR/Value.h"
 #include "llvm/Support/raw_ostream.h"
 
@@ -31,6 +32,10 @@ struct PrinterTrait<Value> {
   static void print(const Value* P) { errs() << *P; }
 };
 
+template <> struct PrinterTrait<Metadata> {
+  static void print(const Metadata *P) { P->print(errs()); }
+};
+
 template <typename T>
 struct LeakDetectorImpl {
   explicit LeakDetectorImpl(const char* const name = "") :