1 //===- LeaksContext.h - LeadDetector Implementation ------------*- C++ -*--===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines various helper methods and classes used by
11 // LLVMContextImpl for leaks detectors.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_LIB_IR_LEAKSCONTEXT_H
16 #define LLVM_LIB_IR_LEAKSCONTEXT_H
18 #include "llvm/ADT/SmallPtrSet.h"
19 #include "llvm/IR/Value.h"
20 #include "llvm/Support/raw_ostream.h"
26 static void print(const T* P) { errs() << P; }
30 struct PrinterTrait<Value> {
31 static void print(const Value* P) { errs() << *P; }
35 struct LeakDetectorImpl {
36 explicit LeakDetectorImpl(const char* const name = "") :
37 Cache(nullptr), Name(name) { }
44 void setName(const char* n) {
48 // Because the most common usage pattern, by far, is to add a
49 // garbage object, then remove it immediately, we optimize this
50 // case. When an object is added, it is not added to the set
51 // immediately, it is added to the CachedValue Value. If it is
52 // immediately removed, no set search need be performed.
53 void addGarbage(const T* o) {
54 assert(Ts.count(o) == 0 && "Object already in set!");
56 assert(Cache != o && "Object already in set!");
62 void removeGarbage(const T* o) {
64 Cache = nullptr; // Cache hit
69 bool hasGarbage(const std::string& Message) {
70 addGarbage(nullptr); // Flush the Cache
72 assert(!Cache && "No value should be cached anymore!");
75 errs() << "Leaked " << Name << " objects found: " << Message << ":\n";
76 for (typename SmallPtrSet<const T*, 8>::iterator I = Ts.begin(),
77 E = Ts.end(); I != E; ++I) {
79 PrinterTrait<T>::print(*I);
91 SmallPtrSet<const T*, 8> Ts;