sanitizer_internal_defs.h revision b1bd208bfa496391085056b1709542b80dcfb21e
151125a21eafc29c925cac3655b46cfd8ef55f764Ted Kremenek//===-- sanitizer_internal_defs.h -------------------------------*- C++ -*-===// 24241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek// 34241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek// The LLVM Compiler Infrastructure 44241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek// 54241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek// This file is distributed under the University of Illinois Open Source 64241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek// License. See LICENSE.TXT for details. 74241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek// 84241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek//===----------------------------------------------------------------------===// 94241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek// 1051125a21eafc29c925cac3655b46cfd8ef55f764Ted Kremenek// This file is shared between AddressSanitizer and ThreadSanitizer. 1151125a21eafc29c925cac3655b46cfd8ef55f764Ted Kremenek// It contains macro used in run-time libraries code. 124241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek//===----------------------------------------------------------------------===// 134241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek#ifndef SANITIZER_DEFS_H 144241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek#define SANITIZER_DEFS_H 154241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek 164241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek#include "sanitizer/common_interface_defs.h" 174241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenekusing namespace __sanitizer; // NOLINT 184a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek// ----------- ATTENTION ------------- 1963bbe5312cd89ce0ceb684bff68c5baef636e93cTed Kremenek// This header should NOT include any other headers to avoid portability issues. 204241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek 214241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek// Common defs. 22f6f5ef4aaa66b60270e84d1fe1292886369d2f38Ted Kremenek#define INLINE static inline 234241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek#define INTERFACE_ATTRIBUTE SANITIZER_INTERFACE_ATTRIBUTE 24ede5a4ba111f0590879670b6cb07f4d6d0bd9075Ted Kremenek#define WEAK SANITIZER_WEAK_ATTRIBUTE 254a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek 264a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek// Platform-specific defs. 2763bbe5312cd89ce0ceb684bff68c5baef636e93cTed Kremenek#if defined(_MSC_VER) 284241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek# define ALWAYS_INLINE __declspec(forceinline) 294241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek// FIXME(timurrrr): do we need this on Windows? 304a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek# define ALIAS(x) 314d4dd85923ecfc9c38ac0e94fb2602e1cce4406bTed Kremenek# define ALIGNED(x) __declspec(align(x)) 3237d887c6c8e3c653fc581183d012a646d1653f57Ted Kremenek# define FORMAT(f, a) 3311062b118476368fa5b294954713e5df97d8599fTed Kremenek# define NOINLINE __declspec(noinline) 3411062b118476368fa5b294954713e5df97d8599fTed Kremenek# define NORETURN __declspec(noreturn) 3511062b118476368fa5b294954713e5df97d8599fTed Kremenek# define THREADLOCAL __declspec(thread) 36f4b7a6940070f04d7845ac55f0d1e300a8bee0d9Ted Kremenek# define NOTHROW 377d7fe6d539b3bdb1701835223cca306c325614a7Ted Kremenek# define LIKELY(x) (x) 38754607e7cff2d902d9af8b771409449fb2f8d2bfTed Kremenek# define UNLIKELY(x) (x) 39daeb9a7376830d637e02b5bc51faf4750a7bce70Ted Kremenek# define UNUSED 4011062b118476368fa5b294954713e5df97d8599fTed Kremenek# define USED 414a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek# define PREFETCH(x) /* _mm_prefetch(x, _MM_HINT_NTA) */ 424a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek#else // _MSC_VER 434a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek# define ALWAYS_INLINE __attribute__((always_inline)) 444a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek# define ALIAS(x) __attribute__((alias(x))) 454d4dd85923ecfc9c38ac0e94fb2602e1cce4406bTed Kremenek# define ALIGNED(x) __attribute__((aligned(x))) 46f4b7a6940070f04d7845ac55f0d1e300a8bee0d9Ted Kremenek# define FORMAT(f, a) __attribute__((format(printf, f, a))) 477d7fe6d539b3bdb1701835223cca306c325614a7Ted Kremenek# define NOINLINE __attribute__((noinline)) 48754607e7cff2d902d9af8b771409449fb2f8d2bfTed Kremenek# define NORETURN __attribute__((noreturn)) 49daeb9a7376830d637e02b5bc51faf4750a7bce70Ted Kremenek# define THREADLOCAL __thread 5011062b118476368fa5b294954713e5df97d8599fTed Kremenek# define NOTHROW throw() 514a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek# define LIKELY(x) __builtin_expect(!!(x), 1) 524c4cb527a44037d076da82ad9d12b4e655e64dbbTed Kremenek# define UNLIKELY(x) __builtin_expect(!!(x), 0) 53b38911f16b4943548db6a3695fc6ae23070b25d2Ted Kremenek# define UNUSED __attribute__((unused)) 544c4cb527a44037d076da82ad9d12b4e655e64dbbTed Kremenek# define USED __attribute__((used)) 554c4cb527a44037d076da82ad9d12b4e655e64dbbTed Kremenek# define PREFETCH(x) __builtin_prefetch(x) 56ee98546b0d5f3439c4a590b0d7d1545af794a0ecTed Kremenek#endif // _MSC_VER 57596f0a1e54f610926e8bfded9efa1c639f824dedTed Kremenek 58ee98546b0d5f3439c4a590b0d7d1545af794a0ecTed Kremenek#if defined(_WIN32) 59ee98546b0d5f3439c4a590b0d7d1545af794a0ecTed Kremenektypedef unsigned long DWORD; // NOLINT 60ee98546b0d5f3439c4a590b0d7d1545af794a0ecTed Kremenektypedef DWORD thread_return_t; 61ffe0f43806d4823271c2406c1fccc2373115c36aTed Kremenek# define THREAD_CALLING_CONV __stdcall 62b38911f16b4943548db6a3695fc6ae23070b25d2Ted Kremenek#else // _WIN32 63ee98546b0d5f3439c4a590b0d7d1545af794a0ecTed Kremenektypedef void* thread_return_t; 64ee98546b0d5f3439c4a590b0d7d1545af794a0ecTed Kremenek# define THREAD_CALLING_CONV 65ee98546b0d5f3439c4a590b0d7d1545af794a0ecTed Kremenek#endif // _WIN32 66ee98546b0d5f3439c4a590b0d7d1545af794a0ecTed Kremenektypedef thread_return_t (THREAD_CALLING_CONV *thread_callback_t)(void* arg); 67ee98546b0d5f3439c4a590b0d7d1545af794a0ecTed Kremenek 684c4cb527a44037d076da82ad9d12b4e655e64dbbTed Kremenek#if __LP64__ || defined(_WIN64) 694c4cb527a44037d076da82ad9d12b4e655e64dbbTed Kremenek# define SANITIZER_WORDSIZE 64 704c4cb527a44037d076da82ad9d12b4e655e64dbbTed Kremenek#else 714c4cb527a44037d076da82ad9d12b4e655e64dbbTed Kremenek# define SANITIZER_WORDSIZE 32 729eb49a40df510313132eef147419c5abefff23ebTed Kremenek#endif 734c4cb527a44037d076da82ad9d12b4e655e64dbbTed Kremenek 745d5480380d7b7c3590a0283ddf239220e514e576Ted Kremenek// NOTE: Functions below must be defined in each run-time. 754c4cb527a44037d076da82ad9d12b4e655e64dbbTed Kremeneknamespace __sanitizer { 765d5480380d7b7c3590a0283ddf239220e514e576Ted Kremenekvoid NORETURN Die(); 774c4cb527a44037d076da82ad9d12b4e655e64dbbTed Kremenekvoid NORETURN CheckFailed(const char *file, int line, const char *cond, 785d5480380d7b7c3590a0283ddf239220e514e576Ted Kremenek u64 v1, u64 v2); 794c4cb527a44037d076da82ad9d12b4e655e64dbbTed Kremenek} // namespace __sanitizer 80ffe0f43806d4823271c2406c1fccc2373115c36aTed Kremenek 814c4cb527a44037d076da82ad9d12b4e655e64dbbTed Kremenek// Check macro 829eb49a40df510313132eef147419c5abefff23ebTed Kremenek#define RAW_CHECK_MSG(expr, msg) do { \ 83f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek if (!(expr)) { \ 84b38911f16b4943548db6a3695fc6ae23070b25d2Ted Kremenek RawWrite(msg); \ 85ffe0f43806d4823271c2406c1fccc2373115c36aTed Kremenek Die(); \ 86ffe0f43806d4823271c2406c1fccc2373115c36aTed Kremenek } \ 87f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek} while (0) 88f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek 89b38911f16b4943548db6a3695fc6ae23070b25d2Ted Kremenek#define RAW_CHECK(expr) RAW_CHECK_MSG(expr, #expr) 90b38911f16b4943548db6a3695fc6ae23070b25d2Ted Kremenek 91f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek#define CHECK_IMPL(c1, op, c2) \ 92b38911f16b4943548db6a3695fc6ae23070b25d2Ted Kremenek do { \ 934c4cb527a44037d076da82ad9d12b4e655e64dbbTed Kremenek __sanitizer::u64 v1 = (u64)(c1); \ 944a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek __sanitizer::u64 v2 = (u64)(c2); \ 954a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek if (!(v1 op v2)) \ 964a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek __sanitizer::CheckFailed(__FILE__, __LINE__, \ 974a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek "(" #c1 ") " #op " (" #c2 ")", v1, v2); \ 984323a57627e796dcfdfdb7d47672dc09ed308edaTed Kremenek } while (false) \ 994323a57627e796dcfdfdb7d47672dc09ed308edaTed Kremenek/**/ 1004a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek 1014a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek#define CHECK(a) CHECK_IMPL((a), !=, 0) 1024c4cb527a44037d076da82ad9d12b4e655e64dbbTed Kremenek#define CHECK_EQ(a, b) CHECK_IMPL((a), ==, (b)) 1034a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek#define CHECK_NE(a, b) CHECK_IMPL((a), !=, (b)) 1044a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek#define CHECK_LT(a, b) CHECK_IMPL((a), <, (b)) 1054c4cb527a44037d076da82ad9d12b4e655e64dbbTed Kremenek#define CHECK_LE(a, b) CHECK_IMPL((a), <=, (b)) 1064a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek#define CHECK_GT(a, b) CHECK_IMPL((a), >, (b)) 1074a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek#define CHECK_GE(a, b) CHECK_IMPL((a), >=, (b)) 1084323a57627e796dcfdfdb7d47672dc09ed308edaTed Kremenek 1094a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek#if TSAN_DEBUG 1104a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek#define DCHECK(a) CHECK(a) 1114a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek#define DCHECK_EQ(a, b) CHECK_EQ(a, b) 112f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek#define DCHECK_NE(a, b) CHECK_NE(a, b) 11345b8789258b282769b03cbeb68e9f5b0308f067bTed Kremenek#define DCHECK_LT(a, b) CHECK_LT(a, b) 1144a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek#define DCHECK_LE(a, b) CHECK_LE(a, b) 1154a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek#define DCHECK_GT(a, b) CHECK_GT(a, b) 116d880c1829395f55129fee31e2df542a475ec3cd7Ted Kremenek#define DCHECK_GE(a, b) CHECK_GE(a, b) 1174a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek#else 1180f9063c116b7c3b05d8042b5976463c2dae04861Ted Kremenek#define DCHECK(a) 1194a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek#define DCHECK_EQ(a, b) 1204a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek#define DCHECK_NE(a, b) 1214a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek#define DCHECK_LT(a, b) 1224a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek#define DCHECK_LE(a, b) 1230e8a3c743b9b3e3039e329a1736122d3b5b5fed9Ted Kremenek#define DCHECK_GT(a, b) 124f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek#define DCHECK_GE(a, b) 125ffe0f43806d4823271c2406c1fccc2373115c36aTed Kremenek#endif 1262e287540c90255e14208e7e5f43f07cb752a1fd7Ted Kremenek 1272e287540c90255e14208e7e5f43f07cb752a1fd7Ted Kremenek#define UNREACHABLE(msg) do { \ 1282e287540c90255e14208e7e5f43f07cb752a1fd7Ted Kremenek CHECK(0 && msg); \ 1292e287540c90255e14208e7e5f43f07cb752a1fd7Ted Kremenek Die(); \ 1302e287540c90255e14208e7e5f43f07cb752a1fd7Ted Kremenek} while (0) 1312e287540c90255e14208e7e5f43f07cb752a1fd7Ted Kremenek 1322e287540c90255e14208e7e5f43f07cb752a1fd7Ted Kremenek#define UNIMPLEMENTED() UNREACHABLE("unimplemented") 1332e287540c90255e14208e7e5f43f07cb752a1fd7Ted Kremenek 1342e287540c90255e14208e7e5f43f07cb752a1fd7Ted Kremenek#define COMPILER_CHECK(pred) IMPL_COMPILER_ASSERT(pred, __LINE__) 1352e287540c90255e14208e7e5f43f07cb752a1fd7Ted Kremenek 1362e287540c90255e14208e7e5f43f07cb752a1fd7Ted Kremenek#define ARRAY_SIZE(a) (sizeof(a)/sizeof((a)[0])) 1372e287540c90255e14208e7e5f43f07cb752a1fd7Ted Kremenek 1382e287540c90255e14208e7e5f43f07cb752a1fd7Ted Kremenek#define IMPL_PASTE(a, b) a##b 1394a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek#define IMPL_COMPILER_ASSERT(pred, line) \ 1404a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek typedef char IMPL_PASTE(assertion_failed_##_, line)[2*(int)(pred)-1] 1414a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek 1424a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek// Limits for integral types. We have to redefine it in case we don't 1434a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek// have stdint.h (like in Visual Studio 9). 144e5f4dcb6bd73a10df6eb6c3cfe057c88cb2362ccTed Kremenek#undef __INT64_C 145e5f4dcb6bd73a10df6eb6c3cfe057c88cb2362ccTed Kremenek#undef __UINT64_C 1464a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek#if SANITIZER_WORDSIZE == 64 1474a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek# define __INT64_C(c) c ## L 1484a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek# define __UINT64_C(c) c ## UL 1494a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek#else 1504a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek# define __INT64_C(c) c ## LL 1514a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek# define __UINT64_C(c) c ## ULL 1524a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek#endif // SANITIZER_WORDSIZE == 64 1534a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek#undef INT32_MIN 1544a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek#define INT32_MIN (-2147483647-1) 1554323a57627e796dcfdfdb7d47672dc09ed308edaTed Kremenek#undef INT32_MAX 156e5f4dcb6bd73a10df6eb6c3cfe057c88cb2362ccTed Kremenek#define INT32_MAX (2147483647) 1574a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek#undef UINT32_MAX 1584a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek#define UINT32_MAX (4294967295U) 1594323a57627e796dcfdfdb7d47672dc09ed308edaTed Kremenek#undef INT64_MIN 1604323a57627e796dcfdfdb7d47672dc09ed308edaTed Kremenek#define INT64_MIN (-__INT64_C(9223372036854775807)-1) 1614a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek#undef INT64_MAX 1624a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek#define INT64_MAX (__INT64_C(9223372036854775807)) 1634a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek#undef UINT64_MAX 1647fa6a4079fd68344e4d38c30f7681b3a7d30fbd1Ted Kremenek#define UINT64_MAX (__UINT64_C(18446744073709551615)) 1657fa6a4079fd68344e4d38c30f7681b3a7d30fbd1Ted Kremenek 1667fa6a4079fd68344e4d38c30f7681b3a7d30fbd1Ted Kremenekenum LinkerInitialized { LINKER_INITIALIZED = 0 }; 1674323a57627e796dcfdfdb7d47672dc09ed308edaTed Kremenek 1687fa6a4079fd68344e4d38c30f7681b3a7d30fbd1Ted Kremenek#if !defined(_MSC_VER) || defined(__clang__) 1697fa6a4079fd68344e4d38c30f7681b3a7d30fbd1Ted Kremenek# define GET_CALLER_PC() (uptr)__builtin_return_address(0) 1707fa6a4079fd68344e4d38c30f7681b3a7d30fbd1Ted Kremenek# define GET_CURRENT_FRAME() (uptr)__builtin_frame_address(0) 1717fa6a4079fd68344e4d38c30f7681b3a7d30fbd1Ted Kremenek#else 1724a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenekextern "C" void* _ReturnAddress(void); 1737fa6a4079fd68344e4d38c30f7681b3a7d30fbd1Ted Kremenek# pragma intrinsic(_ReturnAddress) 1744a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek# define GET_CALLER_PC() (uptr)_ReturnAddress() 1754a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek// CaptureStackBackTrace doesn't need to know BP on Windows. 176a43a1eb6e7c773b79898541794bf819601719493Ted Kremenek// FIXME: This macro is still used when printing error reports though it's not 177a43a1eb6e7c773b79898541794bf819601719493Ted Kremenek// clear if the BP value is needed in the ASan reports on Windows. 178a43a1eb6e7c773b79898541794bf819601719493Ted Kremenek# define GET_CURRENT_FRAME() (uptr)0xDEADBEEF 179a43a1eb6e7c773b79898541794bf819601719493Ted Kremenek#endif 1804a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek 1814a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek#define HANDLE_EINTR(res, f) { \ 1823148eb4a75f70f2636075c364d03104223f004d3Ted Kremenek do { \ 1834a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek res = (f); \ 1843148eb4a75f70f2636075c364d03104223f004d3Ted Kremenek } while (res == -1 && errno == EINTR); \ 1854a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek } 18637d887c6c8e3c653fc581183d012a646d1653f57Ted Kremenek 18737d887c6c8e3c653fc581183d012a646d1653f57Ted Kremenek#endif // SANITIZER_DEFS_H 1884a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek