Chromium Code Reviews| Index: Source/wtf/LeakAnnotations.h |
| diff --git a/Source/wtf/LeakAnnotations.h b/Source/wtf/LeakAnnotations.h |
| new file mode 100644 |
| index 0000000000000000000000000000000000000000..1b5536b409bda3a4bc188803437fadbe32a6b0c5 |
| --- /dev/null |
| +++ b/Source/wtf/LeakAnnotations.h |
| @@ -0,0 +1,92 @@ |
| +/* |
| + * Copyright (C) 2013 Google Inc. All rights reserved. |
| + * Copyright (C) 2013 Samsung Electronics. All rights reserved. |
| + * |
| + * Redistribution and use in source and binary forms, with or without |
| + * modification, are permitted provided that the following conditions are |
| + * met: |
| + * |
| + * * Redistributions of source code must retain the above copyright |
| + * notice, this list of conditions and the following disclaimer. |
| + * * Redistributions in binary form must reproduce the above |
| + * copyright notice, this list of conditions and the following disclaimer |
| + * in the documentation and/or other materials provided with the |
| + * distribution. |
| + * * Neither the name of Google Inc. nor the names of its |
| + * contributors may be used to endorse or promote products derived from |
| + * this software without specific prior written permission. |
| + * |
| + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| + */ |
| + |
| +#ifndef WTF_LeakAnnotations_h |
| +#define WTF_LeakAnnotations_h |
| + |
| +/* This file defines macros which can be used to annotate intentional memory |
| + * leaks. Support for annotations is implemented in HeapChecker and |
| + * LeakSanitizer. Annotated objects will be treated as a source of live |
| + * pointers, i.e. any heap objects reachable by following pointers from an |
| + * annotated object will not be reported as leaks. |
| + * |
| + * ANNOTATE_SCOPED_MEMORY_LEAK: all allocations made in the current scope |
| + * will be annotated as leaks. |
| + * ANNOTATE_LEAKING_OBJECT_PTR(X): the heap object referenced by pointer X will |
| + * be annotated as a leak. |
| + * |
| + * Note that HeapChecker will report a fatal error if an object which has been |
| + * annotated with ANNOTATE_LEAKING_OBJECT_PTR is later deleted (but |
| + * LeakSanitizer won't). |
| + */ |
| + |
| +#if USE(LEAK_ANNOTATIONS) |
| + |
| +#if USE(LEAK_SANITIZER) |
| +#ifdef __cplusplus |
|
earthdok
2013/09/04 13:43:00
Isn't this always true? We have C++ code below any
|
| +extern "C" { |
| +#endif |
| +void __lsan_disable(); |
| +void __lsan_enable(); |
| +void __lsan_ignore_object(const void *p); |
| +#ifdef __cplusplus |
| +} // extern "C" |
| +#endif |
| + |
| +class WTFLeakSanitizerDisabler { |
|
earthdok
2013/09/04 13:43:00
Disallow copy and assign.
|
| +public: |
| + WTFLeakSanitizerDisabler() |
| + { |
| + __lsan_disable(); |
| + } |
| + |
| + ~WTFLeakSanitizerDisabler() |
| + { |
| + __lsan_enable(); |
| + } |
| +}; |
| + |
| +#define WTF_ANNOTATE_SCOPED_MEMORY_LEAK \ |
| + WTFLeakSanitizerDisabler leakSanitizerDisabler; static_cast<void>(0) |
| + |
| +#define WTF_ANNOTATE_LEAKING_OBJECT_PTR(X) __lsan_ignore_object(X); |
|
earthdok
2013/09/04 13:43:00
Nit: don't need the semicolon here.
|
| + |
| +#else // USE(LEAK_SANITIZER) |
| + |
| +// If Leak Sanitizer is not being used, the annotations should be no-ops. |
| +#define WTF_ANNOTATE_SCOPED_MEMORY_LEAK ((void)0) |
| +#define WTF_ANNOTATE_LEAKING_OBJECT_PTR(X) ((void)0) |
| + |
| +#endif // USE(LEAK_SANITIZER) |
| + |
| +#endif // USE(LEAK_ANNOTATIONS) |
| + |
| +#endif // WTF_LeakAnnotations_h |