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/Metadata.h"
20 #include "llvm/IR/Value.h"
21 #include "llvm/Support/raw_ostream.h"
27 static void print(const T* P) { errs() << P; }
31 struct PrinterTrait<Value> {
32 static void print(const Value* P) { errs() << *P; }
35 template <> struct PrinterTrait<Metadata> {
36 static void print(const Metadata *P) { P->print(errs()); }
40 struct LeakDetectorImpl {
41 explicit LeakDetectorImpl(const char* const name = "") :
42 Cache(nullptr), Name(name) { }
49 void setName(const char* n) {
53 // Because the most common usage pattern, by far, is to add a
54 // garbage object, then remove it immediately, we optimize this
55 // case. When an object is added, it is not added to the set
56 // immediately, it is added to the CachedValue Value. If it is
57 // immediately removed, no set search need be performed.
58 void addGarbage(const T* o) {
59 assert(Ts.count(o) == 0 && "Object already in set!");
61 assert(Cache != o && "Object already in set!");
67 void removeGarbage(const T* o) {
69 Cache = nullptr; // Cache hit
74 bool hasGarbage(const std::string& Message) {
75 addGarbage(nullptr); // Flush the Cache
77 assert(!Cache && "No value should be cached anymore!");
80 errs() << "Leaked " << Name << " objects found: " << Message << ":\n";
81 for (typename SmallPtrSet<const T*, 8>::iterator I = Ts.begin(),
82 E = Ts.end(); I != E; ++I) {
84 PrinterTrait<T>::print(*I);
96 SmallPtrSet<const T*, 8> Ts;