sanitizer_internal_defs.h revision b1bd208bfa496391085056b1709542b80dcfb21e
194b5036ee6ba866e1702848855b6d687d1e70afaAlexey Samsonov//===-- sanitizer_internal_defs.h -------------------------------*- C++ -*-===// 29aead37421a6e4bf43265e5195c6ac31fc519982Kostya Serebryany// 39aead37421a6e4bf43265e5195c6ac31fc519982Kostya Serebryany// The LLVM Compiler Infrastructure 49aead37421a6e4bf43265e5195c6ac31fc519982Kostya Serebryany// 59aead37421a6e4bf43265e5195c6ac31fc519982Kostya Serebryany// This file is distributed under the University of Illinois Open Source 69aead37421a6e4bf43265e5195c6ac31fc519982Kostya Serebryany// License. See LICENSE.TXT for details. 79aead37421a6e4bf43265e5195c6ac31fc519982Kostya Serebryany// 89aead37421a6e4bf43265e5195c6ac31fc519982Kostya Serebryany//===----------------------------------------------------------------------===// 99aead37421a6e4bf43265e5195c6ac31fc519982Kostya Serebryany// 109aead37421a6e4bf43265e5195c6ac31fc519982Kostya Serebryany// This file is shared between AddressSanitizer and ThreadSanitizer. 110a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov// It contains macro used in run-time libraries code. 129aead37421a6e4bf43265e5195c6ac31fc519982Kostya Serebryany//===----------------------------------------------------------------------===// 139aead37421a6e4bf43265e5195c6ac31fc519982Kostya Serebryany#ifndef SANITIZER_DEFS_H 149aead37421a6e4bf43265e5195c6ac31fc519982Kostya Serebryany#define SANITIZER_DEFS_H 159aead37421a6e4bf43265e5195c6ac31fc519982Kostya Serebryany 16d865fecddccebf898ceed24d096fc58fb29a6e57Chandler Carruth#include "sanitizer/common_interface_defs.h" 170a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonovusing namespace __sanitizer; // NOLINT 189aead37421a6e4bf43265e5195c6ac31fc519982Kostya Serebryany// ----------- ATTENTION ------------- 199aead37421a6e4bf43265e5195c6ac31fc519982Kostya Serebryany// This header should NOT include any other headers to avoid portability issues. 209aead37421a6e4bf43265e5195c6ac31fc519982Kostya Serebryany 210a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov// Common defs. 220a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov#define INLINE static inline 230a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov#define INTERFACE_ATTRIBUTE SANITIZER_INTERFACE_ATTRIBUTE 240a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov#define WEAK SANITIZER_WEAK_ATTRIBUTE 250a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov 260a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov// Platform-specific defs. 27bfa45e11e52081c55294355f36fa547f163dcc67Dmitry Vyukov#if defined(_MSC_VER) 28d51a1a10cba87be50e9ada9fa21337c387edb237Dmitry Vyukov# define ALWAYS_INLINE __declspec(forceinline) 290a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov// FIXME(timurrrr): do we need this on Windows? 300a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define ALIAS(x) 310a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define ALIGNED(x) __declspec(align(x)) 3215503b0a4331c7f27f9cebc25e25c2e494f61cb9Alexey Samsonov# define FORMAT(f, a) 330a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define NOINLINE __declspec(noinline) 340a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define NORETURN __declspec(noreturn) 350a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define THREADLOCAL __declspec(thread) 36d51a1a10cba87be50e9ada9fa21337c387edb237Dmitry Vyukov# define NOTHROW 37e2462f7461961925f7f20577352c01e867365d8bDmitry Vyukov# define LIKELY(x) (x) 38e2462f7461961925f7f20577352c01e867365d8bDmitry Vyukov# define UNLIKELY(x) (x) 39e2462f7461961925f7f20577352c01e867365d8bDmitry Vyukov# define UNUSED 40e2462f7461961925f7f20577352c01e867365d8bDmitry Vyukov# define USED 41b1bd208bfa496391085056b1709542b80dcfb21eDmitry Vyukov# define PREFETCH(x) /* _mm_prefetch(x, _MM_HINT_NTA) */ 42bfa45e11e52081c55294355f36fa547f163dcc67Dmitry Vyukov#else // _MSC_VER 43d51a1a10cba87be50e9ada9fa21337c387edb237Dmitry Vyukov# define ALWAYS_INLINE __attribute__((always_inline)) 440a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define ALIAS(x) __attribute__((alias(x))) 450a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define ALIGNED(x) __attribute__((aligned(x))) 4615503b0a4331c7f27f9cebc25e25c2e494f61cb9Alexey Samsonov# define FORMAT(f, a) __attribute__((format(printf, f, a))) 470a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define NOINLINE __attribute__((noinline)) 480a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define NORETURN __attribute__((noreturn)) 490a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define THREADLOCAL __thread 5097daee89b35f6141db09aee612f0f377f754092fDmitry Vyukov# define NOTHROW throw() 510a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define LIKELY(x) __builtin_expect(!!(x), 1) 520a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define UNLIKELY(x) __builtin_expect(!!(x), 0) 532ea978704a794e536d2801affcc7f301092d75daAlexey Samsonov# define UNUSED __attribute__((unused)) 540a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define USED __attribute__((used)) 55b1bd208bfa496391085056b1709542b80dcfb21eDmitry Vyukov# define PREFETCH(x) __builtin_prefetch(x) 56e2462f7461961925f7f20577352c01e867365d8bDmitry Vyukov#endif // _MSC_VER 579aead37421a6e4bf43265e5195c6ac31fc519982Kostya Serebryany 58dd3a911e46b3f0416d60d9be5c84ccfc4b1c3aa8Alexey Samsonov#if defined(_WIN32) 59bb19294a1195fb320047bace7732f15e85ac4da5Dmitry Vyukovtypedef unsigned long DWORD; // NOLINT 60dd3a911e46b3f0416d60d9be5c84ccfc4b1c3aa8Alexey Samsonovtypedef DWORD thread_return_t; 61dd3a911e46b3f0416d60d9be5c84ccfc4b1c3aa8Alexey Samsonov# define THREAD_CALLING_CONV __stdcall 62dd3a911e46b3f0416d60d9be5c84ccfc4b1c3aa8Alexey Samsonov#else // _WIN32 63dd3a911e46b3f0416d60d9be5c84ccfc4b1c3aa8Alexey Samsonovtypedef void* thread_return_t; 64dd3a911e46b3f0416d60d9be5c84ccfc4b1c3aa8Alexey Samsonov# define THREAD_CALLING_CONV 65dd3a911e46b3f0416d60d9be5c84ccfc4b1c3aa8Alexey Samsonov#endif // _WIN32 66dd3a911e46b3f0416d60d9be5c84ccfc4b1c3aa8Alexey Samsonovtypedef thread_return_t (THREAD_CALLING_CONV *thread_callback_t)(void* arg); 67dd3a911e46b3f0416d60d9be5c84ccfc4b1c3aa8Alexey Samsonov 685af39e50366f1aacbebc284f572f08ad1ad07357Kostya Serebryany#if __LP64__ || defined(_WIN64) 695af39e50366f1aacbebc284f572f08ad1ad07357Kostya Serebryany# define SANITIZER_WORDSIZE 64 705af39e50366f1aacbebc284f572f08ad1ad07357Kostya Serebryany#else 715af39e50366f1aacbebc284f572f08ad1ad07357Kostya Serebryany# define SANITIZER_WORDSIZE 32 725af39e50366f1aacbebc284f572f08ad1ad07357Kostya Serebryany#endif 739aead37421a6e4bf43265e5195c6ac31fc519982Kostya Serebryany 7415a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov// NOTE: Functions below must be defined in each run-time. 7515a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonovnamespace __sanitizer { 7615a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonovvoid NORETURN Die(); 7715a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonovvoid NORETURN CheckFailed(const char *file, int line, const char *cond, 7815a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov u64 v1, u64 v2); 7915a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov} // namespace __sanitizer 8015a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov 8115a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov// Check macro 82230c3be6cdd094a187f48e27ba0961dbeee70344Alexey Samsonov#define RAW_CHECK_MSG(expr, msg) do { \ 83230c3be6cdd094a187f48e27ba0961dbeee70344Alexey Samsonov if (!(expr)) { \ 84230c3be6cdd094a187f48e27ba0961dbeee70344Alexey Samsonov RawWrite(msg); \ 85230c3be6cdd094a187f48e27ba0961dbeee70344Alexey Samsonov Die(); \ 86230c3be6cdd094a187f48e27ba0961dbeee70344Alexey Samsonov } \ 87230c3be6cdd094a187f48e27ba0961dbeee70344Alexey Samsonov} while (0) 88230c3be6cdd094a187f48e27ba0961dbeee70344Alexey Samsonov 89230c3be6cdd094a187f48e27ba0961dbeee70344Alexey Samsonov#define RAW_CHECK(expr) RAW_CHECK_MSG(expr, #expr) 90230c3be6cdd094a187f48e27ba0961dbeee70344Alexey Samsonov 9115a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov#define CHECK_IMPL(c1, op, c2) \ 9215a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov do { \ 9315a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov __sanitizer::u64 v1 = (u64)(c1); \ 9415a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov __sanitizer::u64 v2 = (u64)(c2); \ 9515a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov if (!(v1 op v2)) \ 9615a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov __sanitizer::CheckFailed(__FILE__, __LINE__, \ 9715a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov "(" #c1 ") " #op " (" #c2 ")", v1, v2); \ 9815a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov } while (false) \ 9915a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov/**/ 10015a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov 10115a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov#define CHECK(a) CHECK_IMPL((a), !=, 0) 10215a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov#define CHECK_EQ(a, b) CHECK_IMPL((a), ==, (b)) 10315a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov#define CHECK_NE(a, b) CHECK_IMPL((a), !=, (b)) 10415a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov#define CHECK_LT(a, b) CHECK_IMPL((a), <, (b)) 10515a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov#define CHECK_LE(a, b) CHECK_IMPL((a), <=, (b)) 10615a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov#define CHECK_GT(a, b) CHECK_IMPL((a), >, (b)) 10715a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov#define CHECK_GE(a, b) CHECK_IMPL((a), >=, (b)) 10815a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov 109fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#if TSAN_DEBUG 110fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK(a) CHECK(a) 111fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_EQ(a, b) CHECK_EQ(a, b) 112fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_NE(a, b) CHECK_NE(a, b) 113fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_LT(a, b) CHECK_LT(a, b) 114fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_LE(a, b) CHECK_LE(a, b) 115fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_GT(a, b) CHECK_GT(a, b) 116fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_GE(a, b) CHECK_GE(a, b) 117fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#else 118fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK(a) 119fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_EQ(a, b) 120fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_NE(a, b) 121fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_LT(a, b) 122fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_LE(a, b) 123fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_GT(a, b) 124fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_GE(a, b) 125fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#endif 126fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov 12745418d1ccb083cad3cb84e0b8184adfb85876fc5Alexey Samsonov#define UNREACHABLE(msg) do { \ 12845418d1ccb083cad3cb84e0b8184adfb85876fc5Alexey Samsonov CHECK(0 && msg); \ 12945418d1ccb083cad3cb84e0b8184adfb85876fc5Alexey Samsonov Die(); \ 1305759d92e99e2b7adcc46a8729f16023208dd8f37Kostya Serebryany} while (0) 13145418d1ccb083cad3cb84e0b8184adfb85876fc5Alexey Samsonov 13245418d1ccb083cad3cb84e0b8184adfb85876fc5Alexey Samsonov#define UNIMPLEMENTED() UNREACHABLE("unimplemented") 1338c53e54ef9e713953ec9495e82e5c330b96e49f3Alexey Samsonov 134c375657778e8a72d566e29951060b7eadc749b0dKostya Serebryany#define COMPILER_CHECK(pred) IMPL_COMPILER_ASSERT(pred, __LINE__) 135c375657778e8a72d566e29951060b7eadc749b0dKostya Serebryany 1364c2ddda9ac80f94782b2b040208831233db578afKostya Serebryany#define ARRAY_SIZE(a) (sizeof(a)/sizeof((a)[0])) 1374c2ddda9ac80f94782b2b040208831233db578afKostya Serebryany 138c375657778e8a72d566e29951060b7eadc749b0dKostya Serebryany#define IMPL_PASTE(a, b) a##b 139c375657778e8a72d566e29951060b7eadc749b0dKostya Serebryany#define IMPL_COMPILER_ASSERT(pred, line) \ 140d7ed1f09f316628b2d981a1d8c2cf0f5af30e90eAlexey Samsonov typedef char IMPL_PASTE(assertion_failed_##_, line)[2*(int)(pred)-1] 141c375657778e8a72d566e29951060b7eadc749b0dKostya Serebryany 142c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov// Limits for integral types. We have to redefine it in case we don't 143c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov// have stdint.h (like in Visual Studio 9). 144b46941a1d23012491a7a8a52718cacbde3c19ba1Alexey Samsonov#undef __INT64_C 145b46941a1d23012491a7a8a52718cacbde3c19ba1Alexey Samsonov#undef __UINT64_C 1465af39e50366f1aacbebc284f572f08ad1ad07357Kostya Serebryany#if SANITIZER_WORDSIZE == 64 147c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov# define __INT64_C(c) c ## L 148c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov# define __UINT64_C(c) c ## UL 149c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#else 150c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov# define __INT64_C(c) c ## LL 151c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov# define __UINT64_C(c) c ## ULL 1525af39e50366f1aacbebc284f572f08ad1ad07357Kostya Serebryany#endif // SANITIZER_WORDSIZE == 64 153c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#undef INT32_MIN 154c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#define INT32_MIN (-2147483647-1) 155c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#undef INT32_MAX 156c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#define INT32_MAX (2147483647) 157c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#undef UINT32_MAX 158c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#define UINT32_MAX (4294967295U) 159c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#undef INT64_MIN 160c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#define INT64_MIN (-__INT64_C(9223372036854775807)-1) 161c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#undef INT64_MAX 162c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#define INT64_MAX (__INT64_C(9223372036854775807)) 163c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#undef UINT64_MAX 164c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#define UINT64_MAX (__UINT64_C(18446744073709551615)) 165c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov 16670e177e29c6f9ac987b65a79f6b4f3ebdabc75ccAlexey Samsonovenum LinkerInitialized { LINKER_INITIALIZED = 0 }; 16770e177e29c6f9ac987b65a79f6b4f3ebdabc75ccAlexey Samsonov 168b46941a1d23012491a7a8a52718cacbde3c19ba1Alexey Samsonov#if !defined(_MSC_VER) || defined(__clang__) 1691b5ea8fbbef73f5d9b41dbb26a21b9a0f4d1445eKostya Serebryany# define GET_CALLER_PC() (uptr)__builtin_return_address(0) 1701b5ea8fbbef73f5d9b41dbb26a21b9a0f4d1445eKostya Serebryany# define GET_CURRENT_FRAME() (uptr)__builtin_frame_address(0) 1711b5ea8fbbef73f5d9b41dbb26a21b9a0f4d1445eKostya Serebryany#else 17280acccf4647c3482c3e3e6ae21e757ba580a5956Kostya Serebryanyextern "C" void* _ReturnAddress(void); 17380acccf4647c3482c3e3e6ae21e757ba580a5956Kostya Serebryany# pragma intrinsic(_ReturnAddress) 1741b5ea8fbbef73f5d9b41dbb26a21b9a0f4d1445eKostya Serebryany# define GET_CALLER_PC() (uptr)_ReturnAddress() 1751b5ea8fbbef73f5d9b41dbb26a21b9a0f4d1445eKostya Serebryany// CaptureStackBackTrace doesn't need to know BP on Windows. 1761b5ea8fbbef73f5d9b41dbb26a21b9a0f4d1445eKostya Serebryany// FIXME: This macro is still used when printing error reports though it's not 1771b5ea8fbbef73f5d9b41dbb26a21b9a0f4d1445eKostya Serebryany// clear if the BP value is needed in the ASan reports on Windows. 1781b5ea8fbbef73f5d9b41dbb26a21b9a0f4d1445eKostya Serebryany# define GET_CURRENT_FRAME() (uptr)0xDEADBEEF 1791b5ea8fbbef73f5d9b41dbb26a21b9a0f4d1445eKostya Serebryany#endif 1801b5ea8fbbef73f5d9b41dbb26a21b9a0f4d1445eKostya Serebryany 1813334e12d33261cb8f211f2f49f28ddfa027a40c3Evgeniy Stepanov#define HANDLE_EINTR(res, f) { \ 1823334e12d33261cb8f211f2f49f28ddfa027a40c3Evgeniy Stepanov do { \ 1833334e12d33261cb8f211f2f49f28ddfa027a40c3Evgeniy Stepanov res = (f); \ 1843334e12d33261cb8f211f2f49f28ddfa027a40c3Evgeniy Stepanov } while (res == -1 && errno == EINTR); \ 1853334e12d33261cb8f211f2f49f28ddfa027a40c3Evgeniy Stepanov } 1863334e12d33261cb8f211f2f49f28ddfa027a40c3Evgeniy Stepanov 1879aead37421a6e4bf43265e5195c6ac31fc519982Kostya Serebryany#endif // SANITIZER_DEFS_H 188