Fix this warning:

[oota-llvm.git] / lib / VMCore / LeakDetector.cpp

diff --git a/lib/VMCore/LeakDetector.cpp b/lib/VMCore/LeakDetector.cpp
index 0d7b4bedf3d51648ba9ebd05c006a7d0326b0bfc..68bf161699300038aecdf71fc3c09185b9343763 100644 (file)
--- a/lib/VMCore/LeakDetector.cpp
+++ b/lib/VMCore/LeakDetector.cpp
@@ -1,66 +1,131 @@
 //===-- LeakDetector.cpp - Implement LeakDetector interface ---------------===//
 //
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
 // This file implements the LeakDetector class.
 //
 //===----------------------------------------------------------------------===//
 
-#include "Support/LeakDetector.h"
+#include "llvm/Support/LeakDetector.h"
+#include "llvm/Support/Compiler.h"
+#include "llvm/Support/Streams.h"
 #include "llvm/Value.h"
 #include <set>
-#include <iostream>
+using namespace llvm;
 
-// Lazily allocate set so that release build doesn't have to do anything.
-static std::set<const void*> *Objects = 0;
-static std::set<const Value*> *LLVMObjects = 0;
+namespace {
+  template <class T>
+  struct VISIBILITY_HIDDEN PrinterTrait {
+    static void print(const T* P) { cerr << P; }
+  };
 
-void LeakDetector::addGarbageObjectImpl(void *Object) {
-  if (Objects == 0)
-    Objects = new std::set<const void*>();
-  assert(Objects->count(Object) == 0 && "Object already in set!");
-  Objects->insert(Object);
+  template<>
+  struct VISIBILITY_HIDDEN PrinterTrait<Value> {
+    static void print(const Value* P) { cerr << *P; }
+  };
+
+  template <typename T>
+  struct VISIBILITY_HIDDEN LeakDetectorImpl {
+    LeakDetectorImpl(const char* const name) : Cache(0), Name(name) { }
+
+    // Because the most common usage pattern, by far, is to add a
+    // garbage object, then remove it immediately, we optimize this
+    // case.  When an object is added, it is not added to the set
+    // immediately, it is added to the CachedValue Value.  If it is
+    // immediately removed, no set search need be performed.
+    void addGarbage(const T* o) {
+      if (Cache) {
+        assert(Ts.count(Cache) == 0 && "Object already in set!");
+        Ts.insert(Cache);
+      }
+      Cache = o;
+    }
+
+    void removeGarbage(const T* o) {
+      if (o == Cache)
+        Cache = 0; // Cache hit
+      else
+        Ts.erase(o);
+    }
+
+    bool hasGarbage(const std::string& Message) {
+      addGarbage(0); // Flush the Cache
+
+      assert(Cache == 0 && "No value should be cached anymore!");
+
+      if (!Ts.empty()) {
+        cerr << "Leaked " << Name << " objects found: " << Message << ":\n";
+        for (typename std::set<const T*>::iterator I = Ts.begin(),
+               E = Ts.end(); I != E; ++I) {
+          cerr << "\t";
+          PrinterTrait<T>::print(*I);
+          cerr << "\n";
+        }
+        cerr << '\n';
+
+        return true;
+      }
+      return false;
+    }
+
+  private:
+    std::set<const T*> Ts;
+    const T* Cache;
+    const char* const Name;
+  };
+
+  LeakDetectorImpl<void>  *Objects;
+  LeakDetectorImpl<Value> *LLVMObjects;
+
+  LeakDetectorImpl<void> &getObjects() {
+    if (Objects == 0)
+      Objects = new LeakDetectorImpl<void>("GENERIC");
+    return *Objects;
+  }
+
+  LeakDetectorImpl<Value> &getLLVMObjects() {
+    if (LLVMObjects == 0)
+      LLVMObjects = new LeakDetectorImpl<Value>("LLVM");
+    return *LLVMObjects;
+  }
+
+  void clearGarbage() {
+    delete Objects;
+    delete LLVMObjects;
+    Objects = 0;
+    LLVMObjects = 0;
+  }
 }
 
-void LeakDetector::removeGarbageObjectImpl(void *Object) {
-  if (Objects)
-    Objects->erase(Object);
+void LeakDetector::addGarbageObjectImpl(void *Object) {
+  getObjects().addGarbage(Object);
 }
 
 void LeakDetector::addGarbageObjectImpl(const Value *Object) {
-  if (LLVMObjects == 0)
-    LLVMObjects = new std::set<const Value*>();
-  assert(LLVMObjects->count(Object) == 0 && "Object already in set!");
-  LLVMObjects->insert(Object);
+  getLLVMObjects().addGarbage(Object);
+}
+
+void LeakDetector::removeGarbageObjectImpl(void *Object) {
+  getObjects().removeGarbage(Object);
 }
 
 void LeakDetector::removeGarbageObjectImpl(const Value *Object) {
-  if (LLVMObjects)
-    LLVMObjects->erase(Object);
+  getLLVMObjects().removeGarbage(Object);
 }
 
 void LeakDetector::checkForGarbageImpl(const std::string &Message) {
-  if ((Objects && !Objects->empty()) || (LLVMObjects && !LLVMObjects->empty())){
-    std::cerr << "Leaked objects found: " << Message << "\n";
-
-    if (Objects && !Objects->empty()) {
-      std::cerr << "  Non-Value objects leaked:";
-      for (std::set<const void*>::iterator I = Objects->begin(),
-             E = Objects->end(); I != E; ++I)
-        std::cerr << " " << *I;
-    }
+  // use non-short-circuit version so that both checks are performed
+  if (getObjects().hasGarbage(Message) |
+      getLLVMObjects().hasGarbage(Message))
+    cerr << "\nThis is probably because you removed an object, but didn't "
+         << "delete it.  Please check your code for memory leaks.\n";
 
-    if (LLVMObjects && !LLVMObjects->empty()) {
-      std::cerr << "  LLVM Value subclasses leaked:";
-      for (std::set<const Value*>::iterator I = LLVMObjects->begin(),
-             E = LLVMObjects->end(); I != E; ++I)
-        std::cerr << **I << "\n";
-    }
-
-    std::cerr << "This is probably because you removed an LLVM value "
-              << "(Instruction, BasicBlock, \netc), but didn't delete it.  "
-              << "Please check your code for memory leaks.\n";
-
-    // Clear out results so we don't get duplicate warnings on next call...
-    delete Objects; delete LLVMObjects;
-    Objects = 0; LLVMObjects = 0;
-  }
+  // Clear out results so we don't get duplicate warnings on
+  // next call...
+  clearGarbage();
 }