OLD | NEW |
1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef BASE_DEBUG_LEAK_ANNOTATIONS_H_ | 5 #ifndef BASE_DEBUG_LEAK_ANNOTATIONS_H_ |
6 #define BASE_DEBUG_LEAK_ANNOTATIONS_H_ | 6 #define BASE_DEBUG_LEAK_ANNOTATIONS_H_ |
7 | 7 |
8 #include "build/build_config.h" | 8 #include "build/build_config.h" |
9 | 9 |
| 10 // This file defines macros which can be used to annotate intentional memory |
| 11 // leaks. Support for annotations is implemented in HeapChecker and |
| 12 // LeakSanitizer. Annotated objects will be treated as a source of live |
| 13 // pointers, i.e. any heap objects reachable by following pointers from an |
| 14 // annotated object will not be reported as leaks. |
| 15 // |
| 16 // ANNOTATE_SCOPED_MEMORY_LEAK: all allocations made in the current scope |
| 17 // will be annotated as leaks. |
| 18 // ANNOTATE_LEAKING_OBJECT_PTR(X): the heap object referenced by pointer X will |
| 19 // be annotated as a leak. |
| 20 // |
| 21 // Note that HeapChecker will report a fatal error if an object which has been |
| 22 // annotated with ANNOTATE_LEAKING_OBJECT_PTR is later deleted (but |
| 23 // LeakSanitizer won't). |
| 24 |
10 #if defined(OS_POSIX) && !defined(OS_MACOSX) && !defined(OS_NACL) && \ | 25 #if defined(OS_POSIX) && !defined(OS_MACOSX) && !defined(OS_NACL) && \ |
11 defined(USE_HEAPCHECKER) | 26 defined(USE_HEAPCHECKER) |
12 | 27 |
13 #include "third_party/tcmalloc/chromium/src/gperftools/heap-checker.h" | 28 #include "third_party/tcmalloc/chromium/src/gperftools/heap-checker.h" |
14 | 29 |
15 // Annotate a program scope as having memory leaks. Tcmalloc's heap leak | |
16 // checker will ignore them. Note that these annotations may mask real bugs | |
17 // and should not be used in the production code. | |
18 #define ANNOTATE_SCOPED_MEMORY_LEAK \ | 30 #define ANNOTATE_SCOPED_MEMORY_LEAK \ |
19 HeapLeakChecker::Disabler heap_leak_checker_disabler | 31 HeapLeakChecker::Disabler heap_leak_checker_disabler |
20 | 32 |
21 // Annotate an object pointer as referencing a leaky object. This object and all | |
22 // the heap objects referenced by it will be ignored by the heap checker. | |
23 // | |
24 // X should be referencing an active allocated object. If it is not, the | |
25 // annotation will be ignored. | |
26 // No object should be annotated with ANNOTATE_SCOPED_MEMORY_LEAK twice. | |
27 // Once an object is annotated with ANNOTATE_SCOPED_MEMORY_LEAK, it cannot be | |
28 // deleted. | |
29 #define ANNOTATE_LEAKING_OBJECT_PTR(X) \ | 33 #define ANNOTATE_LEAKING_OBJECT_PTR(X) \ |
30 HeapLeakChecker::IgnoreObject(X) | 34 HeapLeakChecker::IgnoreObject(X) |
31 | 35 |
| 36 #elif defined(LEAK_SANITIZER) |
| 37 |
| 38 extern "C" { |
| 39 void __lsan_disable(); |
| 40 void __lsan_enable(); |
| 41 void __lsan_ignore_object(const void *p); |
| 42 } // extern "C" |
| 43 |
| 44 class ScopedLeakSanitizerDisabler { |
| 45 public: |
| 46 ScopedLeakSanitizerDisabler() { __lsan_disable(); } |
| 47 ~ScopedLeakSanitizerDisabler() { __lsan_enable(); } |
| 48 private: |
| 49 DISALLOW_COPY_AND_ASSIGN(ScopedLeakSanitizerDisabler); |
| 50 }; |
| 51 |
| 52 #define ANNOTATE_SCOPED_MEMORY_LEAK \ |
| 53 ScopedLeakSanitizerDisabler leak_sanitizer_disabler |
| 54 |
| 55 #define ANNOTATE_LEAKING_OBJECT_PTR(X) __lsan_ignore_object(X); |
| 56 |
32 #else | 57 #else |
33 | 58 |
34 // If tcmalloc is not used, the annotations should be no-ops. | 59 // If neither HeapChecker nor LSan are used, the annotations should be no-ops. |
35 #define ANNOTATE_SCOPED_MEMORY_LEAK ((void)0) | 60 #define ANNOTATE_SCOPED_MEMORY_LEAK ((void)0) |
36 #define ANNOTATE_LEAKING_OBJECT_PTR(X) ((void)0) | 61 #define ANNOTATE_LEAKING_OBJECT_PTR(X) ((void)0) |
37 | 62 |
38 #endif | 63 #endif |
39 | 64 |
40 #endif // BASE_DEBUG_LEAK_ANNOTATIONS_H_ | 65 #endif // BASE_DEBUG_LEAK_ANNOTATIONS_H_ |
OLD | NEW |