Changed to using LLVM streams.
[oota-llvm.git] / lib / VMCore / LeakDetector.cpp
1 //===-- LeakDetector.cpp - Implement LeakDetector interface ---------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file implements the LeakDetector class.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #include "llvm/Support/Compiler.h"
15 #include "llvm/Support/LeakDetector.h"
16 #include "llvm/Support/Streams.h"
17 #include "llvm/Value.h"
18 #include <set>
19 using namespace llvm;
20
21 namespace {
22   template <class T>
23   struct VISIBILITY_HIDDEN PrinterTrait {
24     static void print(const T* P) { llvm_cerr << P; }
25   };
26
27   template<>
28   struct VISIBILITY_HIDDEN PrinterTrait<Value> {
29     static void print(const Value* P) { llvm_cerr << *P; }
30   };
31
32   template <typename T>
33   struct VISIBILITY_HIDDEN LeakDetectorImpl {
34     LeakDetectorImpl(const char* const name) : Cache(0), Name(name) { }
35
36     // Because the most common usage pattern, by far, is to add a
37     // garbage object, then remove it immediately, we optimize this
38     // case.  When an object is added, it is not added to the set
39     // immediately, it is added to the CachedValue Value.  If it is
40     // immediately removed, no set search need be performed.
41     void addGarbage(const T* o) {
42       if (Cache) {
43         assert(Ts.count(Cache) == 0 && "Object already in set!");
44         Ts.insert(Cache);
45       }
46       Cache = o;
47     }
48
49     void removeGarbage(const T* o) {
50       if (o == Cache)
51         Cache = 0; // Cache hit
52       else
53         Ts.erase(o);
54     }
55
56     bool hasGarbage(const std::string& Message) {
57       addGarbage(0); // Flush the Cache
58
59       assert(Cache == 0 && "No value should be cached anymore!");
60
61       if (!Ts.empty()) {
62         llvm_cerr
63             << "Leaked " << Name << " objects found: " << Message << ":\n";
64         for (typename std::set<const T*>::iterator I = Ts.begin(),
65                E = Ts.end(); I != E; ++I) {
66           llvm_cerr << "\t";
67           PrinterTrait<T>::print(*I);
68           llvm_cerr << "\n";
69         }
70         llvm_cerr << '\n';
71
72         return true;
73       }
74       return false;
75     }
76
77   private:
78     std::set<const T*> Ts;
79     const T* Cache;
80     const char* const Name;
81   };
82
83   LeakDetectorImpl<void>  *Objects;
84   LeakDetectorImpl<Value> *LLVMObjects;
85
86   LeakDetectorImpl<void> &getObjects() {
87     if (Objects == 0)
88       Objects = new LeakDetectorImpl<void>("GENERIC");
89     return *Objects;
90   }
91
92   LeakDetectorImpl<Value> &getLLVMObjects() {
93     if (LLVMObjects == 0)
94       LLVMObjects = new LeakDetectorImpl<Value>("LLVM");
95     return *LLVMObjects;
96   }
97
98   void clearGarbage() {
99     delete Objects;
100     delete LLVMObjects;
101     Objects = 0;
102     LLVMObjects = 0;
103   }
104 }
105
106 void LeakDetector::addGarbageObjectImpl(void *Object) {
107   getObjects().addGarbage(Object);
108 }
109
110 void LeakDetector::addGarbageObjectImpl(const Value *Object) {
111   getLLVMObjects().addGarbage(Object);
112 }
113
114 void LeakDetector::removeGarbageObjectImpl(void *Object) {
115   getObjects().removeGarbage(Object);
116 }
117
118 void LeakDetector::removeGarbageObjectImpl(const Value *Object) {
119   getLLVMObjects().removeGarbage(Object);
120 }
121
122 void LeakDetector::checkForGarbageImpl(const std::string &Message) {
123   // use non-short-circuit version so that both checks are performed
124   if (getObjects().hasGarbage(Message) |
125       getLLVMObjects().hasGarbage(Message))
126     llvm_cerr << "\nThis is probably because you removed an object, but didn't "
127               << "delete it.  Please check your code for memory leaks.\n";
128
129   // Clear out results so we don't get duplicate warnings on
130   // next call...
131   clearGarbage();
132 }