sanitizer_internal_defs.h revision 4c2ddda9ac80f94782b2b040208831233db578af
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//===-- sanitizer_internal_defs.h -------------------------------*- C++ -*-===// 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// The LLVM Compiler Infrastructure 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This file is distributed under the University of Illinois Open Source 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// License. See LICENSE.TXT for details. 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//===----------------------------------------------------------------------===// 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This file is shared between AddressSanitizer and ThreadSanitizer. 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// It contains macro used in run-time libraries code. 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//===----------------------------------------------------------------------===// 137d4cd473f85ac64c3747c96c277f9e506a0d2246Torne (Richard Coles)#ifndef SANITIZER_DEFS_H 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define SANITIZER_DEFS_H 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 16cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#include "sanitizer_interface_defs.h" 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)using namespace __sanitizer; // NOLINT 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// ----------- ATTENTION ------------- 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This header should NOT include any other headers to avoid portability issues. 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Common defs. 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define INLINE static inline 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define INTERFACE_ATTRIBUTE SANITIZER_INTERFACE_ATTRIBUTE 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define WEAK SANITIZER_WEAK_ATTRIBUTE 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Platform-specific defs. 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(_WIN32) 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef unsigned long DWORD; // NOLINT 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# define ALWAYS_INLINE __declspec(forceinline) 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// FIXME(timurrrr): do we need this on Windows? 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# define ALIAS(x) 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# define ALIGNED(x) __declspec(align(x)) 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# define FORMAT(f, a) 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# define NOINLINE __declspec(noinline) 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# define NORETURN __declspec(noreturn) 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# define THREADLOCAL __declspec(thread) 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# define NOTHROW 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#else // _WIN32 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# define ALWAYS_INLINE __attribute__((always_inline)) 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# define ALIAS(x) __attribute__((alias(x))) 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# define ALIGNED(x) __attribute__((aligned(x))) 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# define FORMAT(f, a) __attribute__((format(printf, f, a))) 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# define NOINLINE __attribute__((noinline)) 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# define NORETURN __attribute__((noreturn)) 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# define THREADLOCAL __thread 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# ifdef __cplusplus 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# define NOTHROW throw() 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# else 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# define NOTHROW __attribute__((__nothrow__)) 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // _WIN32 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// We have no equivalent of these on Windows. 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef _WIN32 5558537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# define LIKELY(x) __builtin_expect(!!(x), 1) 5658537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)# define UNLIKELY(x) __builtin_expect(!!(x), 0) 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# define UNUSED __attribute__((unused)) 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# define USED __attribute__((used)) 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(_WIN32) 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef DWORD thread_return_t; 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# define THREAD_CALLING_CONV __stdcall 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#else // _WIN32 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef void* thread_return_t; 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# define THREAD_CALLING_CONV 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // _WIN32 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef thread_return_t (THREAD_CALLING_CONV *thread_callback_t)(void* arg); 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// If __WORDSIZE was undefined by the platform, define it in terms of the 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// compiler built-ins __LP64__ and _WIN64. 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef __WORDSIZE 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# if __LP64__ || defined(_WIN64) 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# define __WORDSIZE 64 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# else 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# define __WORDSIZE 32 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# endif 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // __WORDSIZE 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// NOTE: Functions below must be defined in each run-time. 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace __sanitizer { 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void NORETURN Die(); 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void NORETURN CheckFailed(const char *file, int line, const char *cond, 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) u64 v1, u64 v2); 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace __sanitizer 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Check macro 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define RAW_CHECK_MSG(expr, msg) do { \ 8958537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) if (!(expr)) { \ 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) RawWrite(msg); \ 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Die(); \ 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } \ 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} while (0) 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define RAW_CHECK(expr) RAW_CHECK_MSG(expr, #expr) 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define CHECK_IMPL(c1, op, c2) \ 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) do { \ 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) __sanitizer::u64 v1 = (u64)(c1); \ 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) __sanitizer::u64 v2 = (u64)(c2); \ 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!(v1 op v2)) \ 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) __sanitizer::CheckFailed(__FILE__, __LINE__, \ 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) "(" #c1 ") " #op " (" #c2 ")", v1, v2); \ 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } while (false) \ 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/**/ 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define CHECK(a) CHECK_IMPL((a), !=, 0) 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define CHECK_EQ(a, b) CHECK_IMPL((a), ==, (b)) 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define CHECK_NE(a, b) CHECK_IMPL((a), !=, (b)) 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define CHECK_LT(a, b) CHECK_IMPL((a), <, (b)) 1112a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#define CHECK_LE(a, b) CHECK_IMPL((a), <=, (b)) 1122a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#define CHECK_GT(a, b) CHECK_IMPL((a), >, (b)) 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define CHECK_GE(a, b) CHECK_IMPL((a), >=, (b)) 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1152a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#if TSAN_DEBUG 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DCHECK(a) CHECK(a) 1171320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#define DCHECK_EQ(a, b) CHECK_EQ(a, b) 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DCHECK_NE(a, b) CHECK_NE(a, b) 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DCHECK_LT(a, b) CHECK_LT(a, b) 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DCHECK_LE(a, b) CHECK_LE(a, b) 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DCHECK_GT(a, b) CHECK_GT(a, b) 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DCHECK_GE(a, b) CHECK_GE(a, b) 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#else 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DCHECK(a) 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DCHECK_EQ(a, b) 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DCHECK_NE(a, b) 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DCHECK_LT(a, b) 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DCHECK_LE(a, b) 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DCHECK_GT(a, b) 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DCHECK_GE(a, b) 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define UNIMPLEMENTED() CHECK("unimplemented" && 0) 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define COMPILER_CHECK(pred) IMPL_COMPILER_ASSERT(pred, __LINE__) 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13758537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#define ARRAY_SIZE(a) (sizeof(a)/sizeof((a)[0])) 13858537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 13958537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#define IMPL_PASTE(a, b) a##b 1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define IMPL_COMPILER_ASSERT(pred, line) \ 1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef char IMPL_PASTE(assertion_failed_##_, line)[2*(int)(pred)-1]; 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Limits for integral types. We have to redefine it in case we don't 1441320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci// have stdint.h (like in Visual Studio 9). 1455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if __WORDSIZE == 64 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# define __INT64_C(c) c ## L 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# define __UINT64_C(c) c ## UL 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#else 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# define __INT64_C(c) c ## LL 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# define __UINT64_C(c) c ## ULL 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // __WORDSIZE == 64 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#undef INT32_MIN 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define INT32_MIN (-2147483647-1) 15458537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#undef INT32_MAX 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define INT32_MAX (2147483647) 1565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#undef UINT32_MAX 1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define UINT32_MAX (4294967295U) 1585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#undef INT64_MIN 1595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define INT64_MIN (-__INT64_C(9223372036854775807)-1) 160a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)#undef INT64_MAX 1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define INT64_MAX (__INT64_C(9223372036854775807)) 1625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#undef UINT64_MAX 1635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define UINT64_MAX (__UINT64_C(18446744073709551615)) 1645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)enum LinkerInitialized { LINKER_INITIALIZED = 0 }; 1665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // SANITIZER_DEFS_H 1685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)