| OLD | NEW |
| 1 /* | 1 // Copyright 2017 The Chromium Authors. All rights reserved. |
| 2 * Copyright (C) 2011 Google Inc. All rights reserved. | 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 * | 3 // found in the LICENSE file. |
| 4 * Redistribution and use in source and binary forms, with or without | |
| 5 * modification, are permitted provided that the following conditions are | |
| 6 * met: | |
| 7 * | |
| 8 * * Redistributions of source code must retain the above copyright | |
| 9 * notice, this list of conditions and the following disclaimer. | |
| 10 * * Neither the name of Google Inc. nor the names of its | |
| 11 * contributors may be used to endorse or promote products derived from | |
| 12 * this software without specific prior written permission. | |
| 13 * | |
| 14 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| 15 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| 16 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| 17 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
| 18 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
| 19 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | |
| 20 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | |
| 21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | |
| 22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |
| 23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | |
| 24 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| 25 */ | |
| 26 | 4 |
| 27 #ifndef WTF_DynamicAnnotations_h | 5 #include "platform/wtf/DynamicAnnotations.h" |
| 28 #define WTF_DynamicAnnotations_h | |
| 29 | 6 |
| 30 /* This file defines dynamic annotations for use with dynamic analysis | 7 // The contents of this header was moved to platform/wtf as part of |
| 31 * tool such as ThreadSanitizer, Valgrind, etc. | 8 // WTF migration project. See the following post for details: |
| 32 * | 9 // https://groups.google.com/a/chromium.org/d/msg/blink-dev/tLdAZCTlcAA/bYXVT8gY
CAAJ |
| 33 * Dynamic annotation is a source code annotation that affects | |
| 34 * the generated code (that is, the annotation is not a comment). | |
| 35 * Each such annotation is attached to a particular | |
| 36 * instruction and/or to a particular object (address) in the program. | |
| 37 * | |
| 38 * By using dynamic annotations a developer can give more details to the dynamic | |
| 39 * analysis tool to improve its precision. | |
| 40 * | |
| 41 * In C/C++ program the annotations are represented as C macros. | |
| 42 * With the default build flags, these macros are empty, hence don't affect | |
| 43 * performance of a compiled binary. | |
| 44 * If dynamic annotations are enabled, they just call no-op functions. | |
| 45 * The dynamic analysis tools can intercept these functions and replace them | |
| 46 * with their own implementations. | |
| 47 * | |
| 48 * See http://code.google.com/p/data-race-test/wiki/DynamicAnnotations for more | |
| 49 * information. | |
| 50 */ | |
| 51 | |
| 52 #include "wtf/WTFExport.h" | |
| 53 #include "wtf/build_config.h" | |
| 54 | |
| 55 #if USE(DYNAMIC_ANNOTATIONS) | |
| 56 /* Tell data race detector that we're not interested in reports on the given | |
| 57 * address range. */ | |
| 58 #define WTF_ANNOTATE_BENIGN_RACE_SIZED(address, size, description) \ | |
| 59 WTFAnnotateBenignRaceSized(__FILE__, __LINE__, address, size, description) | |
| 60 #define WTF_ANNOTATE_BENIGN_RACE(pointer, description) \ | |
| 61 WTFAnnotateBenignRaceSized(__FILE__, __LINE__, pointer, sizeof(*(pointer)), \ | |
| 62 description) | |
| 63 | |
| 64 /* Annotations for user-defined synchronization mechanisms. | |
| 65 * These annotations can be used to define happens-before arcs in user-defined | |
| 66 * synchronization mechanisms: the race detector will infer an arc from | |
| 67 * the former to the latter when they share the same argument pointer. | |
| 68 * | |
| 69 * The most common case requiring annotations is atomic reference counting: | |
| 70 * bool deref() { | |
| 71 * ANNOTATE_HAPPENS_BEFORE(&m_refCount); | |
| 72 * if (!atomicDecrement(&m_refCount)) { | |
| 73 * // m_refCount is now 0 | |
| 74 * ANNOTATE_HAPPENS_AFTER(&m_refCount); | |
| 75 * // "return true; happens-after each atomicDecrement of m_refCount" | |
| 76 * return true; | |
| 77 * } | |
| 78 * return false; | |
| 79 * } | |
| 80 */ | |
| 81 #define WTF_ANNOTATE_HAPPENS_BEFORE(address) \ | |
| 82 WTFAnnotateHappensBefore(__FILE__, __LINE__, address) | |
| 83 #define WTF_ANNOTATE_HAPPENS_AFTER(address) \ | |
| 84 WTFAnnotateHappensAfter(__FILE__, __LINE__, address) | |
| 85 | |
| 86 #ifdef __cplusplus | |
| 87 extern "C" { | |
| 88 #endif | |
| 89 /* Don't use these directly, use the above macros instead. */ | |
| 90 WTF_EXPORT void WTFAnnotateBenignRaceSized(const char* file, | |
| 91 int line, | |
| 92 const volatile void* memory, | |
| 93 long size, | |
| 94 const char* description); | |
| 95 WTF_EXPORT void WTFAnnotateHappensBefore(const char* file, | |
| 96 int line, | |
| 97 const volatile void* address); | |
| 98 WTF_EXPORT void WTFAnnotateHappensAfter(const char* file, | |
| 99 int line, | |
| 100 const volatile void* address); | |
| 101 #ifdef __cplusplus | |
| 102 } // extern "C" | |
| 103 #endif | |
| 104 | |
| 105 #else // USE(DYNAMIC_ANNOTATIONS) | |
| 106 /* These macros are empty when dynamic annotations are not enabled so you can | |
| 107 * use them without affecting the performance of release binaries. */ | |
| 108 #define WTF_ANNOTATE_BENIGN_RACE_SIZED(address, size, description) | |
| 109 #define WTF_ANNOTATE_BENIGN_RACE(pointer, description) | |
| 110 #define WTF_ANNOTATE_HAPPENS_BEFORE(address) | |
| 111 #define WTF_ANNOTATE_HAPPENS_AFTER(address) | |
| 112 #endif // USE(DYNAMIC_ANNOTATIONS) | |
| 113 | |
| 114 #endif // WTF_DynamicAnnotations_h | |
| OLD | NEW |