1 //===-- llvm/Support/LeakDetector.h - Provide leak detection ----*- 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 a class that can be used to provide very simple memory leak
11 // checks for an API. Basically LLVM uses this to make sure that Instructions,
12 // for example, are deleted when they are supposed to be, and not leaked away.
14 // When compiling with NDEBUG (Release build), this class does nothing, thus
15 // adding no checking overhead to release builds. Note that this class is
16 // implemented in a very simple way, requiring completely manual manipulation
17 // and checking for garbage, but this is intentional: users should not be using
18 // this API, only other APIs should.
20 //===----------------------------------------------------------------------===//
22 #ifndef LLVM_SUPPORT_LEAKDETECTOR_H
23 #define LLVM_SUPPORT_LEAKDETECTOR_H
32 /// addGarbageObject - Add a pointer to the internal set of "garbage" object
33 /// pointers. This should be called when objects are created, or if they are
34 /// taken out of an owning collection.
36 static void addGarbageObject(void *Object) {
38 addGarbageObjectImpl(Object);
42 /// removeGarbageObject - Remove a pointer from our internal representation of
43 /// our "garbage" objects. This should be called when an object is added to
44 /// an "owning" collection.
46 static void removeGarbageObject(void *Object) {
48 removeGarbageObjectImpl(Object);
52 /// checkForGarbage - Traverse the internal representation of garbage
53 /// pointers. If there are any pointers that have been add'ed, but not
54 /// remove'd, big obnoxious warnings about memory leaks are issued.
56 /// The specified message will be printed indicating when the check was
59 static void checkForGarbage(const std::string &Message) {
61 checkForGarbageImpl(Message);
65 /// Overload the normal methods to work better with Value*'s because they are
66 /// by far the most common in LLVM. This does not affect the actual
67 /// functioning of this class, it just makes the warning messages nicer.
69 static void addGarbageObject(const Value *Object) {
71 addGarbageObjectImpl(Object);
74 static void removeGarbageObject(const Value *Object) {
76 removeGarbageObjectImpl(Object);
81 // If we are debugging, the actual implementations will be called...
82 static void addGarbageObjectImpl(const Value *Object);
83 static void removeGarbageObjectImpl(const Value *Object);
84 static void addGarbageObjectImpl(void *Object);
85 static void removeGarbageObjectImpl(void *Object);
86 static void checkForGarbageImpl(const std::string &Message);
89 } // End llvm namespace