aboutsummaryrefslogtreecommitdiffstats
path: root/lib/VMCore/LeakDetector.cpp
blob: 036cb9c616cf0ec7e99820df2f220977d4a06952 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
//===-- LeakDetector.cpp - Implement LeakDetector interface ---------------===//
//
//                     The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// This file implements the LeakDetector class.
//
//===----------------------------------------------------------------------===//

#include "llvm/Support/LeakDetector.h"
#include "llvm/ADT/SmallPtrSet.h"
#include "llvm/Support/Compiler.h"
#include "llvm/Support/ManagedStatic.h"
#include "llvm/Support/Streams.h"
#include "llvm/System/RWMutex.h"
#include "llvm/System/Threading.h"
#include "llvm/Value.h"
using namespace llvm;

namespace {
  template <class T>
  struct VISIBILITY_HIDDEN PrinterTrait {
    static void print(const T* P) { cerr << P; }
  };

  template<>
  struct VISIBILITY_HIDDEN PrinterTrait<Value> {
    static void print(const Value* P) { cerr << *P; }
  };

  ManagedStatic<sys::RWMutex> LeakDetectorLock;

  template <typename T>
  struct VISIBILITY_HIDDEN LeakDetectorImpl {
    explicit LeakDetectorImpl(const char* const name = "") : 
      Cache(0), Name(name) { }

    void clear() {
      Cache = 0;
      Ts.clear();
    }
    
    void setName(const char* n) { 
      Name = n;
    }
    
    // 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 (llvm_is_multithreaded()) {
        sys::ScopedWriter Writer(&*LeakDetectorLock);
        if (Cache) {
          assert(Ts.count(Cache) == 0 && "Object already in set!");
          Ts.insert(Cache);
        }
        Cache = o;
      } else {
        if (Cache) {
          assert(Ts.count(Cache) == 0 && "Object already in set!");
          Ts.insert(Cache);
        }
        Cache = o;
      }
    }

    void removeGarbage(const T* o) {
      if (llvm_is_multithreaded()) {
        sys::ScopedWriter Writer(&*LeakDetectorLock);
        if (o == Cache)
          Cache = 0; // Cache hit
        else
          Ts.erase(o);
      } else {
        if (o == Cache)
          Cache = 0; // Cache hit
        else
          Ts.erase(o);
      }
    }

    bool hasGarbage(const std::string& Message) {
      addGarbage(0); // Flush the Cache

      if (llvm_is_multithreaded()) LeakDetectorLock->reader_acquire();
      assert(Cache == 0 && "No value should be cached anymore!");

      if (!Ts.empty()) {
        cerr << "Leaked " << Name << " objects found: " << Message << ":\n";
        for (typename SmallPtrSet<const T*, 8>::iterator I = Ts.begin(),
               E = Ts.end(); I != E; ++I) {
          cerr << "\t";
          PrinterTrait<T>::print(*I);
          cerr << "\n";
        }
        cerr << '\n';

        if (llvm_is_multithreaded()) LeakDetectorLock->reader_release();
        return true;
      }
      
      if (llvm_is_multithreaded()) LeakDetectorLock->reader_release();
      return false;
    }

  private:
    SmallPtrSet<const T*, 8> Ts;
    const T* Cache;
    const char* Name;
  };

  static ManagedStatic<LeakDetectorImpl<void> > Objects;
  static ManagedStatic<LeakDetectorImpl<Value> > LLVMObjects;

  static void clearGarbage() {
    Objects->clear();
    LLVMObjects->clear();
  }
}

void LeakDetector::addGarbageObjectImpl(void *Object) {
  Objects->addGarbage(Object);
}

void LeakDetector::addGarbageObjectImpl(const Value *Object) {
  LLVMObjects->addGarbage(Object);
}

void LeakDetector::removeGarbageObjectImpl(void *Object) {
  Objects->removeGarbage(Object);
}

void LeakDetector::removeGarbageObjectImpl(const Value *Object) {
  LLVMObjects->removeGarbage(Object);
}

void LeakDetector::checkForGarbageImpl(const std::string &Message) {
  Objects->setName("GENERIC");
  LLVMObjects->setName("LLVM");
  
  // use non-short-circuit version so that both checks are performed
  if (Objects->hasGarbage(Message) |
      LLVMObjects->hasGarbage(Message))
    cerr << "\nThis is probably because you removed an object, 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...
  clearGarbage();
}