haikuwebkit/Source/WTF/wtf/ThreadSanitizerSupport.h

54 lines
2.0 KiB
C
Raw Permalink Normal View History

WebKit should support building with clang ThreadSanitizer enabled <https://webkit.org/b/216318> <rdar://problem/31615729> Reviewed by Darin Adler. This patch doesn't attempt to resolve every potential false positive, but makes it easy to build WebKit with TSan enabled. .: * Makefile.shared: - Update to work with `make [args] TSAN=YES`. Source/WTF: * WTF.xcodeproj/project.pbxproj: * wtf/CMakeLists.txt: - Add ThreadSanitizerSupport.h to the project. * wtf/Compiler.h: - Define TSAN_ENABLED and SUPPRESS_TSAN macros. * wtf/Locker.h: (WTF::Locker::~Locker): (WTF::Locker::unlockEarly): (WTF::Locker::operator=): (WTF::Locker::lock): - Instrument lock/unlock methods for ThreadSanitizer. * wtf/ThreadSanitizerSupport.h: Add. (AnnotateHappensBefore): (AnnotateHappensAfter): - Declare TSan runtime functions needed to annotate WTF::Locker. (TSAN_ANNOTATE_HAPPENS_BEFORE): (TSAN_ANNOTATE_HAPPENS_AFTER): - Define macros used to call TSan runtime functions if TSan is enabled. Tools: * Scripts/set-webkit-configuration: - Add support for --[no-]tsan switches. * Scripts/webkitdirs.pm: (determineTSanIsEnabled): (tsanIsEnabled): (XcodeOptions): (generateBuildSystemFromCMakeProject): - Add support for building with TSan enabled. * asan/asan.xcconfig: Rename to sanitizer/asan.xcconfig. * sanitizer/asan.xcconfig: Rename from asan/asan.xcconfig. - Extract common variables to sanitizer.xcconfig. * sanitizer/sanitizer.xcconfig: Add. - Extract common variables from asan.xcconfig. * sanitizer/tsan.xcconfig: Add. - Add support for TSan. Canonical link: https://commits.webkit.org/229406@main git-svn-id: https://svn.webkit.org/repository/webkit/trunk@267130 268f45cc-cd09-0410-ab3c-d52691b4dbfc
2020-09-16 02:53:36 +00:00
/*
* Copyright (C) 2020 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. 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.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``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 APPLE INC. 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.
*/
#pragma once
#include <wtf/Compiler.h>
// FIXME: Remove this header when <rdar://problem/56654773> is fixed.
#if TSAN_ENABLED
WTF_EXTERN_C_BEGIN
void AnnotateHappensBefore(const char* file, int line, const void* addr);
void AnnotateHappensAfter(const char* file, int line, const void* addr);
WTF_EXTERN_C_END
#define TSAN_ANNOTATE_HAPPENS_BEFORE(addr) \
do { \
AnnotateHappensBefore(__FILE__, __LINE__, addr); \
} while (0)
#define TSAN_ANNOTATE_HAPPENS_AFTER(addr) \
do { \
AnnotateHappensAfter(__FILE__, __LINE__, addr); \
} while (0)
#else
#define TSAN_ANNOTATE_HAPPENS_BEFORE(addr) ((void)0)
#define TSAN_ANNOTATE_HAPPENS_AFTER(addr) ((void)0)
#endif // TSAN_ENABLED