1/*
2 * Copyright (C) 2013 Google Inc. All rights reserved.
3 * Copyright (C) 2013 Samsung Electronics. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met:
8 *
9 *     * Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *     * Redistributions in binary form must reproduce the above
12 * copyright notice, this list of conditions and the following disclaimer
13 * in the documentation and/or other materials provided with the
14 * distribution.
15 *     * Neither the name of Google Inc. nor the names of its
16 * contributors may be used to endorse or promote products derived from
17 * this software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32#ifndef WTF_LeakAnnotations_h
33#define WTF_LeakAnnotations_h
34
35// This file defines macros which can be used to annotate intentional memory
36// leaks. Support for annotations is implemented in HeapChecker and
37// LeakSanitizer. Annotated objects will be treated as a source of live
38// pointers, i.e. any heap objects reachable by following pointers from an
39// annotated object will not be reported as leaks.
40//
41// WTF_ANNOTATE_SCOPED_MEMORY_LEAK: all allocations made in the current scope
42// will be annotated as leaks.
43// WTF_ANNOTATE_LEAKING_OBJECT_PTR(X): the heap object referenced by pointer X
44// will be annotated as a leak.
45//
46// Note that HeapChecker will report a fatal error if an object which has been
47// annotated with ANNOTATE_LEAKING_OBJECT_PTR is later deleted (but
48// LeakSanitizer won't).
49
50#include "wtf/Noncopyable.h"
51
52namespace WTF {
53
54#if USE(LEAK_SANITIZER)
55extern "C" {
56void __lsan_disable();
57void __lsan_enable();
58void __lsan_ignore_object(const void *p);
59} // extern "C"
60
61class LeakSanitizerDisabler {
62    WTF_MAKE_NONCOPYABLE(LeakSanitizerDisabler);
63public:
64    LeakSanitizerDisabler()
65    {
66        __lsan_disable();
67    }
68
69    ~LeakSanitizerDisabler()
70    {
71        __lsan_enable();
72    }
73};
74
75#define WTF_ANNOTATE_SCOPED_MEMORY_LEAK \
76        WTF::LeakSanitizerDisabler leakSanitizerDisabler; static_cast<void>(0)
77
78#define WTF_ANNOTATE_LEAKING_OBJECT_PTR(X) \
79    WTF::__lsan_ignore_object(X)
80
81#else // USE(LEAK_SANITIZER)
82
83// If Leak Sanitizer is not being used, the annotations should be no-ops.
84#define WTF_ANNOTATE_SCOPED_MEMORY_LEAK
85#define WTF_ANNOTATE_LEAKING_OBJECT_PTR(X)
86
87#endif // USE(LEAK_SANITIZER)
88
89} // namespace WTF
90
91#endif // WTF_LeakAnnotations_h
92