lib/VMCore/LeaksContext.h

   1 //===- LeaksContext.h - LeadDetector Implementation ------------*- C++ -*--===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 //  This file defines various helper methods and classes used by
  11 // LLVMContextImpl for leaks detectors.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/Value.h"
  16 #include "llvm/ADT/SmallPtrSet.h"
  17 #include "llvm/Support/raw_ostream.h"
  18 using namespace llvm;
  19
  20 template <class T>
  21 struct PrinterTrait {
  22   static void print(const T* P) { errs() << P; }
  23 };
  24
  25 template<>
  26 struct PrinterTrait<Value> {
  27   static void print(const Value* P) { errs() << *P; }
  28 };
  29
  30 template <typename T>
  31 struct LeakDetectorImpl {
  32   explicit LeakDetectorImpl(const char* const name = "") :
  33     Cache(0), Name(name) { }
  34
  35   void clear() {
  36     Cache = 0;
  37     Ts.clear();
  38   }
  39
  40   void setName(const char* n) {
  41     Name = n;
  42   }
  43
  44   // Because the most common usage pattern, by far, is to add a
  45   // garbage object, then remove it immediately, we optimize this
  46   // case.  When an object is added, it is not added to the set
  47   // immediately, it is added to the CachedValue Value.  If it is
  48   // immediately removed, no set search need be performed.
  49   void addGarbage(const T* o) {
  50     if (Cache) {
  51       assert(Ts.count(Cache) == 0 && "Object already in set!");
  52       Ts.insert(Cache);
  53     }
  54     Cache = o;
  55   }
  56
  57   void removeGarbage(const T* o) {
  58     if (o == Cache)
  59       Cache = 0; // Cache hit
  60     else
  61       Ts.erase(o);
  62   }
  63
  64   bool hasGarbage(const std::string& Message) {
  65     addGarbage(0); // Flush the Cache
  66
  67     assert(Cache == 0 && "No value should be cached anymore!");
  68
  69     if (!Ts.empty()) {
  70       errs() << "Leaked " << Name << " objects found: " << Message << ":\n";
  71       for (typename SmallPtrSet<const T*, 8>::iterator I = Ts.begin(),
  72            E = Ts.end(); I != E; ++I) {
  73         errs() << '\t';
  74         PrinterTrait<T>::print(*I);
  75         errs() << '\n';
  76       }
  77       errs() << '\n';
  78
  79       return true;
  80     }
  81
  82     return false;
  83   }
  84
  85 private:
  86   SmallPtrSet<const T*, 8> Ts;
  87   const T* Cache;
  88   const char* Name;
  89 };