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 1624e13723f8477d8c42ab8b2a7f4f69fc089842f1Evgeniy Stepanov#include "sanitizer_platform.h" 1783cb7877f608eb9b3d65981095216842f686c527Evgeniy Stepanov 1886277eb844c4983c81de62d7c050e92fe7155788Stephen Hines#ifndef SANITIZER_DEBUG 1986277eb844c4983c81de62d7c050e92fe7155788Stephen Hines# define SANITIZER_DEBUG 0 2086277eb844c4983c81de62d7c050e92fe7155788Stephen Hines#endif 2186277eb844c4983c81de62d7c050e92fe7155788Stephen Hines 223c80c6c574850106481f82b9e23d1c728458d4a9Timur Iskhodzhanov// Only use SANITIZER_*ATTRIBUTE* before the function return type! 2330e110edf92303237d471f1cb8e3ad07954fb145Evgeniy Stepanov#if SANITIZER_WINDOWS 243c80c6c574850106481f82b9e23d1c728458d4a9Timur Iskhodzhanov# define SANITIZER_INTERFACE_ATTRIBUTE __declspec(dllexport) 253c80c6c574850106481f82b9e23d1c728458d4a9Timur Iskhodzhanov// FIXME find out what we need on Windows, if anything. 26250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov# define SANITIZER_WEAK_ATTRIBUTE 27250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov#elif defined(SANITIZER_GO) 28250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov# define SANITIZER_INTERFACE_ATTRIBUTE 29250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov# define SANITIZER_WEAK_ATTRIBUTE 30250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov#else 31250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov# define SANITIZER_INTERFACE_ATTRIBUTE __attribute__((visibility("default"))) 32250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov# define SANITIZER_WEAK_ATTRIBUTE __attribute__((weak)) 33250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov#endif 34250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov 3586277eb844c4983c81de62d7c050e92fe7155788Stephen Hines#if (SANITIZER_LINUX || SANITIZER_WINDOWS) && !defined(SANITIZER_GO) 36250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov# define SANITIZER_SUPPORTS_WEAK_HOOKS 1 37250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov#else 38250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov# define SANITIZER_SUPPORTS_WEAK_HOOKS 0 39250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov#endif 40250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov 416d1862363c88c183b0ed7740fca876342cf0474bStephen Hines// We can use .preinit_array section on Linux to call sanitizer initialization 426d1862363c88c183b0ed7740fca876342cf0474bStephen Hines// functions very early in the process startup (unless PIC macro is defined). 436d1862363c88c183b0ed7740fca876342cf0474bStephen Hines// FIXME: do we have anything like this on Mac? 446d1862363c88c183b0ed7740fca876342cf0474bStephen Hines#if SANITIZER_LINUX && !SANITIZER_ANDROID && !defined(PIC) 456d1862363c88c183b0ed7740fca876342cf0474bStephen Hines# define SANITIZER_CAN_USE_PREINIT_ARRAY 1 466d1862363c88c183b0ed7740fca876342cf0474bStephen Hines#else 476d1862363c88c183b0ed7740fca876342cf0474bStephen Hines# define SANITIZER_CAN_USE_PREINIT_ARRAY 0 486d1862363c88c183b0ed7740fca876342cf0474bStephen Hines#endif 496d1862363c88c183b0ed7740fca876342cf0474bStephen Hines 50e31eca900a1f8849af75100c2d92e838d79d0920Kostya Serebryany// GCC does not understand __has_feature 51250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov#if !defined(__has_feature) 52250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov# define __has_feature(x) 0 53250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov#endif 54250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov 55250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov// For portability reasons we do not include stddef.h, stdint.h or any other 56250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov// system header, but we do need some basic types that are not defined 57250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov// in a portable way by the language itself. 58250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanovnamespace __sanitizer { 59250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov 60250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov#if defined(_WIN64) 61250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov// 64-bit Windows uses LLP64 data model. 62250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanovtypedef unsigned long long uptr; // NOLINT 63250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanovtypedef signed long long sptr; // NOLINT 64250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov#else 65250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanovtypedef unsigned long uptr; // NOLINT 66250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanovtypedef signed long sptr; // NOLINT 67250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov#endif // defined(_WIN64) 687f790caa37ec1c9807c877297d30e040e83ed215Bill Wendling#if defined(__x86_64__) 692d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines// Since x32 uses ILP32 data model in 64-bit hardware mode, we must use 707f790caa37ec1c9807c877297d30e040e83ed215Bill Wendling// 64-bit pointer to unwind stack frame. 717f790caa37ec1c9807c877297d30e040e83ed215Bill Wendlingtypedef unsigned long long uhwptr; // NOLINT 727f790caa37ec1c9807c877297d30e040e83ed215Bill Wendling#else 737f790caa37ec1c9807c877297d30e040e83ed215Bill Wendlingtypedef uptr uhwptr; // NOLINT 747f790caa37ec1c9807c877297d30e040e83ed215Bill Wendling#endif 75250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanovtypedef unsigned char u8; 76250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanovtypedef unsigned short u16; // NOLINT 77250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanovtypedef unsigned int u32; 78250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanovtypedef unsigned long long u64; // NOLINT 79250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanovtypedef signed char s8; 80250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanovtypedef signed short s16; // NOLINT 81250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanovtypedef signed int s32; 82250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanovtypedef signed long long s64; // NOLINT 83259f7063e3e4c4b94dded1e90ab0a943d0fa737bPirama Arumuga Nainar#if SANITIZER_WINDOWS 84259f7063e3e4c4b94dded1e90ab0a943d0fa737bPirama Arumuga Nainar// On Windows, files are HANDLE, which is a synonim of void*. 85259f7063e3e4c4b94dded1e90ab0a943d0fa737bPirama Arumuga Nainar// Use void* to avoid including <windows.h> everywhere. 86259f7063e3e4c4b94dded1e90ab0a943d0fa737bPirama Arumuga Nainartypedef void* fd_t; 87259f7063e3e4c4b94dded1e90ab0a943d0fa737bPirama Arumuga Nainartypedef unsigned error_t; 88259f7063e3e4c4b94dded1e90ab0a943d0fa737bPirama Arumuga Nainar#else 89ee7cc4454421a176d23442382afd9a01d36e7ad4Alexey Samsonovtypedef int fd_t; 90259f7063e3e4c4b94dded1e90ab0a943d0fa737bPirama Arumuga Nainartypedef int error_t; 91259f7063e3e4c4b94dded1e90ab0a943d0fa737bPirama Arumuga Nainar#endif 92c58a43648cd6121c51a2e795a28e2ef90d7813e6Pirama Arumuga Nainartypedef int pid_t; 93250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov 946fb47af2d2d305adbfc3d41bea589d1527a364a9Kostya Serebryany// WARNING: OFF_T may be different from OS type off_t, depending on the value of 956fb47af2d2d305adbfc3d41bea589d1527a364a9Kostya Serebryany// _FILE_OFFSET_BITS. This definition of OFF_T matches the ABI of system calls 966fb47af2d2d305adbfc3d41bea589d1527a364a9Kostya Serebryany// like pread and mmap, as opposed to pread64 and mmap64. 9786277eb844c4983c81de62d7c050e92fe7155788Stephen Hines// FreeBSD, Mac and Linux/x86-64 are special. 9886277eb844c4983c81de62d7c050e92fe7155788Stephen Hines#if SANITIZER_FREEBSD || SANITIZER_MAC || \ 9986277eb844c4983c81de62d7c050e92fe7155788Stephen Hines (SANITIZER_LINUX && defined(__x86_64__)) 1006fb47af2d2d305adbfc3d41bea589d1527a364a9Kostya Serebryanytypedef u64 OFF_T; 1016fb47af2d2d305adbfc3d41bea589d1527a364a9Kostya Serebryany#else 1026fb47af2d2d305adbfc3d41bea589d1527a364a9Kostya Serebryanytypedef uptr OFF_T; 1036fb47af2d2d305adbfc3d41bea589d1527a364a9Kostya Serebryany#endif 1046fb47af2d2d305adbfc3d41bea589d1527a364a9Kostya Serebryanytypedef u64 OFF64_T; 10553177247698bfba075f2d5b255a447fc3ced6976Peter Collingbourne 10653177247698bfba075f2d5b255a447fc3ced6976Peter Collingbourne#if (SANITIZER_WORDSIZE == 64) || SANITIZER_MAC 10753177247698bfba075f2d5b255a447fc3ced6976Peter Collingbournetypedef uptr operator_new_size_type; 10853177247698bfba075f2d5b255a447fc3ced6976Peter Collingbourne#else 109c58a43648cd6121c51a2e795a28e2ef90d7813e6Pirama Arumuga Nainar# if defined(__s390__) && !defined(__s390x__) 110c58a43648cd6121c51a2e795a28e2ef90d7813e6Pirama Arumuga Nainar// Special case: 31-bit s390 has unsigned long as size_t. 111c58a43648cd6121c51a2e795a28e2ef90d7813e6Pirama Arumuga Nainartypedef unsigned long operator_new_size_type; 112c58a43648cd6121c51a2e795a28e2ef90d7813e6Pirama Arumuga Nainar# else 11353177247698bfba075f2d5b255a447fc3ced6976Peter Collingbournetypedef u32 operator_new_size_type; 114c58a43648cd6121c51a2e795a28e2ef90d7813e6Pirama Arumuga Nainar# endif 11553177247698bfba075f2d5b255a447fc3ced6976Peter Collingbourne#endif 116250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov 117250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov 1189aead37421a6e4bf43265e5195c6ac31fc519982Kostya Serebryany// ----------- ATTENTION ------------- 1199aead37421a6e4bf43265e5195c6ac31fc519982Kostya Serebryany// This header should NOT include any other headers to avoid portability issues. 1209aead37421a6e4bf43265e5195c6ac31fc519982Kostya Serebryany 1210a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov// Common defs. 12240e16683f3fdf23dba20d9d0fc2eb00d562cc8dfTimur Iskhodzhanov#define INLINE inline 1230a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov#define INTERFACE_ATTRIBUTE SANITIZER_INTERFACE_ATTRIBUTE 124799172d60d32feb1acba1a6867f3a9c39a999e5cPirama Arumuga Nainar#define SANITIZER_WEAK_DEFAULT_IMPL \ 125799172d60d32feb1acba1a6867f3a9c39a999e5cPirama Arumuga Nainar extern "C" SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE NOINLINE 126799172d60d32feb1acba1a6867f3a9c39a999e5cPirama Arumuga Nainar#define SANITIZER_WEAK_CXX_DEFAULT_IMPL \ 127799172d60d32feb1acba1a6867f3a9c39a999e5cPirama Arumuga Nainar extern "C++" SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE NOINLINE 1280a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov 1290a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov// Platform-specific defs. 130bfa45e11e52081c55294355f36fa547f163dcc67Dmitry Vyukov#if defined(_MSC_VER) 13140e16683f3fdf23dba20d9d0fc2eb00d562cc8dfTimur Iskhodzhanov# define ALWAYS_INLINE __forceinline 1320a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov// FIXME(timurrrr): do we need this on Windows? 1330a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define ALIAS(x) 1340a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define ALIGNED(x) __declspec(align(x)) 13515503b0a4331c7f27f9cebc25e25c2e494f61cb9Alexey Samsonov# define FORMAT(f, a) 1360a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define NOINLINE __declspec(noinline) 1370a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define NORETURN __declspec(noreturn) 1380a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define THREADLOCAL __declspec(thread) 139e2462f7461961925f7f20577352c01e867365d8bDmitry Vyukov# define LIKELY(x) (x) 140e2462f7461961925f7f20577352c01e867365d8bDmitry Vyukov# define UNLIKELY(x) (x) 141c58a43648cd6121c51a2e795a28e2ef90d7813e6Pirama Arumuga Nainar# define PREFETCH(x) /* _mm_prefetch(x, _MM_HINT_NTA) */ (void)0 142bfa45e11e52081c55294355f36fa547f163dcc67Dmitry Vyukov#else // _MSC_VER 143d475aa8578f4a1955cdb3e3159eda8b229f8c021Kostya Serebryany# define ALWAYS_INLINE inline __attribute__((always_inline)) 1440a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define ALIAS(x) __attribute__((alias(x))) 1457c9ffde46a475d6dd739e977b547c27ac5968976Timur Iskhodzhanov// Please only use the ALIGNED macro before the type. 1467c9ffde46a475d6dd739e977b547c27ac5968976Timur Iskhodzhanov// Using ALIGNED after the variable declaration is not portable! 1470a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define ALIGNED(x) __attribute__((aligned(x))) 14815503b0a4331c7f27f9cebc25e25c2e494f61cb9Alexey Samsonov# define FORMAT(f, a) __attribute__((format(printf, f, a))) 1490a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define NOINLINE __attribute__((noinline)) 1500a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define NORETURN __attribute__((noreturn)) 1510a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define THREADLOCAL __thread 1520a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define LIKELY(x) __builtin_expect(!!(x), 1) 1530a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define UNLIKELY(x) __builtin_expect(!!(x), 0) 1540c7f61c7f0a6981a1722aea325500ce80dc08a04Dmitry Vyukov# if defined(__i386__) || defined(__x86_64__) 1550c7f61c7f0a6981a1722aea325500ce80dc08a04Dmitry Vyukov// __builtin_prefetch(x) generates prefetchnt0 on x86 1560c7f61c7f0a6981a1722aea325500ce80dc08a04Dmitry Vyukov# define PREFETCH(x) __asm__("prefetchnta (%0)" : : "r" (x)) 1570c7f61c7f0a6981a1722aea325500ce80dc08a04Dmitry Vyukov# else 1580c7f61c7f0a6981a1722aea325500ce80dc08a04Dmitry Vyukov# define PREFETCH(x) __builtin_prefetch(x) 1590c7f61c7f0a6981a1722aea325500ce80dc08a04Dmitry Vyukov# endif 160e2462f7461961925f7f20577352c01e867365d8bDmitry Vyukov#endif // _MSC_VER 1619aead37421a6e4bf43265e5195c6ac31fc519982Kostya Serebryany 1622d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines#if !defined(_MSC_VER) || defined(__clang__) 1632d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines# define UNUSED __attribute__((unused)) 1642d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines# define USED __attribute__((used)) 1652d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines#else 1662d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines# define UNUSED 1672d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines# define USED 1682d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines#endif 1692d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines 170799172d60d32feb1acba1a6867f3a9c39a999e5cPirama Arumuga Nainar#if !defined(_MSC_VER) || defined(__clang__) || MSC_PREREQ(1900) 171799172d60d32feb1acba1a6867f3a9c39a999e5cPirama Arumuga Nainar# define NOEXCEPT noexcept 172799172d60d32feb1acba1a6867f3a9c39a999e5cPirama Arumuga Nainar#else 173799172d60d32feb1acba1a6867f3a9c39a999e5cPirama Arumuga Nainar# define NOEXCEPT throw() 174799172d60d32feb1acba1a6867f3a9c39a999e5cPirama Arumuga Nainar#endif 175799172d60d32feb1acba1a6867f3a9c39a999e5cPirama Arumuga Nainar 1767202e79d5457477b9db24daf0af2c6c7464c3378Evgeniy Stepanov// Unaligned versions of basic types. 1777202e79d5457477b9db24daf0af2c6c7464c3378Evgeniy Stepanovtypedef ALIGNED(1) u16 uu16; 1787202e79d5457477b9db24daf0af2c6c7464c3378Evgeniy Stepanovtypedef ALIGNED(1) u32 uu32; 1797202e79d5457477b9db24daf0af2c6c7464c3378Evgeniy Stepanovtypedef ALIGNED(1) u64 uu64; 1807202e79d5457477b9db24daf0af2c6c7464c3378Evgeniy Stepanovtypedef ALIGNED(1) s16 us16; 1817202e79d5457477b9db24daf0af2c6c7464c3378Evgeniy Stepanovtypedef ALIGNED(1) s32 us32; 1827202e79d5457477b9db24daf0af2c6c7464c3378Evgeniy Stepanovtypedef ALIGNED(1) s64 us64; 1837202e79d5457477b9db24daf0af2c6c7464c3378Evgeniy Stepanov 18430e110edf92303237d471f1cb8e3ad07954fb145Evgeniy Stepanov#if SANITIZER_WINDOWS 185c58a43648cd6121c51a2e795a28e2ef90d7813e6Pirama Arumuga Nainar} // namespace __sanitizer 186bb19294a1195fb320047bace7732f15e85ac4da5Dmitry Vyukovtypedef unsigned long DWORD; // NOLINT 187c58a43648cd6121c51a2e795a28e2ef90d7813e6Pirama Arumuga Nainarnamespace __sanitizer { 188dd3a911e46b3f0416d60d9be5c84ccfc4b1c3aa8Alexey Samsonovtypedef DWORD thread_return_t; 189dd3a911e46b3f0416d60d9be5c84ccfc4b1c3aa8Alexey Samsonov# define THREAD_CALLING_CONV __stdcall 190dd3a911e46b3f0416d60d9be5c84ccfc4b1c3aa8Alexey Samsonov#else // _WIN32 191dd3a911e46b3f0416d60d9be5c84ccfc4b1c3aa8Alexey Samsonovtypedef void* thread_return_t; 192dd3a911e46b3f0416d60d9be5c84ccfc4b1c3aa8Alexey Samsonov# define THREAD_CALLING_CONV 193dd3a911e46b3f0416d60d9be5c84ccfc4b1c3aa8Alexey Samsonov#endif // _WIN32 194dd3a911e46b3f0416d60d9be5c84ccfc4b1c3aa8Alexey Samsonovtypedef thread_return_t (THREAD_CALLING_CONV *thread_callback_t)(void* arg); 195dd3a911e46b3f0416d60d9be5c84ccfc4b1c3aa8Alexey Samsonov 19615a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov// NOTE: Functions below must be defined in each run-time. 19715a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonovvoid NORETURN Die(); 198f109267c5320210e69c1b66add801fd5f2e2a452Timur Iskhodzhanov 199f109267c5320210e69c1b66add801fd5f2e2a452Timur Iskhodzhanov// FIXME: No, this shouldn't be in the sanitizer interface. 200f109267c5320210e69c1b66add801fd5f2e2a452Timur IskhodzhanovSANITIZER_INTERFACE_ATTRIBUTE 20115a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonovvoid NORETURN CheckFailed(const char *file, int line, const char *cond, 20215a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov u64 v1, u64 v2); 20315a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov 20415a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov// Check macro 205230c3be6cdd094a187f48e27ba0961dbeee70344Alexey Samsonov#define RAW_CHECK_MSG(expr, msg) do { \ 2062d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines if (UNLIKELY(!(expr))) { \ 207230c3be6cdd094a187f48e27ba0961dbeee70344Alexey Samsonov RawWrite(msg); \ 208230c3be6cdd094a187f48e27ba0961dbeee70344Alexey Samsonov Die(); \ 209230c3be6cdd094a187f48e27ba0961dbeee70344Alexey Samsonov } \ 210230c3be6cdd094a187f48e27ba0961dbeee70344Alexey Samsonov} while (0) 211230c3be6cdd094a187f48e27ba0961dbeee70344Alexey Samsonov 212230c3be6cdd094a187f48e27ba0961dbeee70344Alexey Samsonov#define RAW_CHECK(expr) RAW_CHECK_MSG(expr, #expr) 213230c3be6cdd094a187f48e27ba0961dbeee70344Alexey Samsonov 21415a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov#define CHECK_IMPL(c1, op, c2) \ 21515a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov do { \ 21615a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov __sanitizer::u64 v1 = (u64)(c1); \ 21715a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov __sanitizer::u64 v2 = (u64)(c2); \ 2182d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines if (UNLIKELY(!(v1 op v2))) \ 21915a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov __sanitizer::CheckFailed(__FILE__, __LINE__, \ 22015a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov "(" #c1 ") " #op " (" #c2 ")", v1, v2); \ 22115a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov } while (false) \ 22215a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov/**/ 22315a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov 22415a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov#define CHECK(a) CHECK_IMPL((a), !=, 0) 22515a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov#define CHECK_EQ(a, b) CHECK_IMPL((a), ==, (b)) 22615a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov#define CHECK_NE(a, b) CHECK_IMPL((a), !=, (b)) 22715a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov#define CHECK_LT(a, b) CHECK_IMPL((a), <, (b)) 22815a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov#define CHECK_LE(a, b) CHECK_IMPL((a), <=, (b)) 22915a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov#define CHECK_GT(a, b) CHECK_IMPL((a), >, (b)) 23015a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov#define CHECK_GE(a, b) CHECK_IMPL((a), >=, (b)) 23115a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov 23286277eb844c4983c81de62d7c050e92fe7155788Stephen Hines#if SANITIZER_DEBUG 233fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK(a) CHECK(a) 234fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_EQ(a, b) CHECK_EQ(a, b) 235fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_NE(a, b) CHECK_NE(a, b) 236fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_LT(a, b) CHECK_LT(a, b) 237fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_LE(a, b) CHECK_LE(a, b) 238fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_GT(a, b) CHECK_GT(a, b) 239fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_GE(a, b) CHECK_GE(a, b) 240fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#else 241fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK(a) 242fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_EQ(a, b) 243fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_NE(a, b) 244fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_LT(a, b) 245fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_LE(a, b) 246fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_GT(a, b) 247fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_GE(a, b) 248fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#endif 249fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov 25045418d1ccb083cad3cb84e0b8184adfb85876fc5Alexey Samsonov#define UNREACHABLE(msg) do { \ 25145418d1ccb083cad3cb84e0b8184adfb85876fc5Alexey Samsonov CHECK(0 && msg); \ 25245418d1ccb083cad3cb84e0b8184adfb85876fc5Alexey Samsonov Die(); \ 2535759d92e99e2b7adcc46a8729f16023208dd8f37Kostya Serebryany} while (0) 25445418d1ccb083cad3cb84e0b8184adfb85876fc5Alexey Samsonov 25545418d1ccb083cad3cb84e0b8184adfb85876fc5Alexey Samsonov#define UNIMPLEMENTED() UNREACHABLE("unimplemented") 2568c53e54ef9e713953ec9495e82e5c330b96e49f3Alexey Samsonov 257c375657778e8a72d566e29951060b7eadc749b0dKostya Serebryany#define COMPILER_CHECK(pred) IMPL_COMPILER_ASSERT(pred, __LINE__) 258c375657778e8a72d566e29951060b7eadc749b0dKostya Serebryany 2594c2ddda9ac80f94782b2b040208831233db578afKostya Serebryany#define ARRAY_SIZE(a) (sizeof(a)/sizeof((a)[0])) 2604c2ddda9ac80f94782b2b040208831233db578afKostya Serebryany 261c375657778e8a72d566e29951060b7eadc749b0dKostya Serebryany#define IMPL_PASTE(a, b) a##b 262c375657778e8a72d566e29951060b7eadc749b0dKostya Serebryany#define IMPL_COMPILER_ASSERT(pred, line) \ 263d7ed1f09f316628b2d981a1d8c2cf0f5af30e90eAlexey Samsonov typedef char IMPL_PASTE(assertion_failed_##_, line)[2*(int)(pred)-1] 264c375657778e8a72d566e29951060b7eadc749b0dKostya Serebryany 265c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov// Limits for integral types. We have to redefine it in case we don't 266c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov// have stdint.h (like in Visual Studio 9). 267b46941a1d23012491a7a8a52718cacbde3c19ba1Alexey Samsonov#undef __INT64_C 268b46941a1d23012491a7a8a52718cacbde3c19ba1Alexey Samsonov#undef __UINT64_C 2695af39e50366f1aacbebc284f572f08ad1ad07357Kostya Serebryany#if SANITIZER_WORDSIZE == 64 270c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov# define __INT64_C(c) c ## L 271c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov# define __UINT64_C(c) c ## UL 272c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#else 273c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov# define __INT64_C(c) c ## LL 274c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov# define __UINT64_C(c) c ## ULL 2755af39e50366f1aacbebc284f572f08ad1ad07357Kostya Serebryany#endif // SANITIZER_WORDSIZE == 64 276c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#undef INT32_MIN 277c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#define INT32_MIN (-2147483647-1) 278c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#undef INT32_MAX 279c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#define INT32_MAX (2147483647) 280c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#undef UINT32_MAX 281c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#define UINT32_MAX (4294967295U) 282c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#undef INT64_MIN 283c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#define INT64_MIN (-__INT64_C(9223372036854775807)-1) 284c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#undef INT64_MAX 285c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#define INT64_MAX (__INT64_C(9223372036854775807)) 286c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#undef UINT64_MAX 287c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#define UINT64_MAX (__UINT64_C(18446744073709551615)) 288c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov 28970e177e29c6f9ac987b65a79f6b4f3ebdabc75ccAlexey Samsonovenum LinkerInitialized { LINKER_INITIALIZED = 0 }; 29070e177e29c6f9ac987b65a79f6b4f3ebdabc75ccAlexey Samsonov 291b46941a1d23012491a7a8a52718cacbde3c19ba1Alexey Samsonov#if !defined(_MSC_VER) || defined(__clang__) 2921b5ea8fbbef73f5d9b41dbb26a21b9a0f4d1445eKostya Serebryany# define GET_CALLER_PC() (uptr)__builtin_return_address(0) 2931b5ea8fbbef73f5d9b41dbb26a21b9a0f4d1445eKostya Serebryany# define GET_CURRENT_FRAME() (uptr)__builtin_frame_address(0) 294c58a43648cd6121c51a2e795a28e2ef90d7813e6Pirama Arumuga Nainarinline void Trap() { 295c58a43648cd6121c51a2e795a28e2ef90d7813e6Pirama Arumuga Nainar __builtin_trap(); 296c58a43648cd6121c51a2e795a28e2ef90d7813e6Pirama Arumuga Nainar} 2971b5ea8fbbef73f5d9b41dbb26a21b9a0f4d1445eKostya Serebryany#else 29880acccf4647c3482c3e3e6ae21e757ba580a5956Kostya Serebryanyextern "C" void* _ReturnAddress(void); 29980acccf4647c3482c3e3e6ae21e757ba580a5956Kostya Serebryany# pragma intrinsic(_ReturnAddress) 3001b5ea8fbbef73f5d9b41dbb26a21b9a0f4d1445eKostya Serebryany# define GET_CALLER_PC() (uptr)_ReturnAddress() 3011b5ea8fbbef73f5d9b41dbb26a21b9a0f4d1445eKostya Serebryany// CaptureStackBackTrace doesn't need to know BP on Windows. 3021b5ea8fbbef73f5d9b41dbb26a21b9a0f4d1445eKostya Serebryany// FIXME: This macro is still used when printing error reports though it's not 3031b5ea8fbbef73f5d9b41dbb26a21b9a0f4d1445eKostya Serebryany// clear if the BP value is needed in the ASan reports on Windows. 3041b5ea8fbbef73f5d9b41dbb26a21b9a0f4d1445eKostya Serebryany# define GET_CURRENT_FRAME() (uptr)0xDEADBEEF 305c58a43648cd6121c51a2e795a28e2ef90d7813e6Pirama Arumuga Nainar 306c58a43648cd6121c51a2e795a28e2ef90d7813e6Pirama Arumuga Nainarextern "C" void __ud2(void); 307c58a43648cd6121c51a2e795a28e2ef90d7813e6Pirama Arumuga Nainar# pragma intrinsic(__ud2) 308c58a43648cd6121c51a2e795a28e2ef90d7813e6Pirama Arumuga Nainarinline void Trap() { 309c58a43648cd6121c51a2e795a28e2ef90d7813e6Pirama Arumuga Nainar __ud2(); 310c58a43648cd6121c51a2e795a28e2ef90d7813e6Pirama Arumuga Nainar} 3111b5ea8fbbef73f5d9b41dbb26a21b9a0f4d1445eKostya Serebryany#endif 3121b5ea8fbbef73f5d9b41dbb26a21b9a0f4d1445eKostya Serebryany 3139578a3ecfc35a264ede1135033398e2a77a6cad6Peter Collingbourne#define HANDLE_EINTR(res, f) \ 3149578a3ecfc35a264ede1135033398e2a77a6cad6Peter Collingbourne { \ 3159578a3ecfc35a264ede1135033398e2a77a6cad6Peter Collingbourne int rverrno; \ 3169578a3ecfc35a264ede1135033398e2a77a6cad6Peter Collingbourne do { \ 3179578a3ecfc35a264ede1135033398e2a77a6cad6Peter Collingbourne res = (f); \ 3189578a3ecfc35a264ede1135033398e2a77a6cad6Peter Collingbourne } while (internal_iserror(res, &rverrno) && rverrno == EINTR); \ 3193334e12d33261cb8f211f2f49f28ddfa027a40c3Evgeniy Stepanov } 3203334e12d33261cb8f211f2f49f28ddfa027a40c3Evgeniy Stepanov 32186277eb844c4983c81de62d7c050e92fe7155788Stephen Hines// Forces the compiler to generate a frame pointer in the function. 32286277eb844c4983c81de62d7c050e92fe7155788Stephen Hines#define ENABLE_FRAME_POINTER \ 32386277eb844c4983c81de62d7c050e92fe7155788Stephen Hines do { \ 32486277eb844c4983c81de62d7c050e92fe7155788Stephen Hines volatile uptr enable_fp; \ 32586277eb844c4983c81de62d7c050e92fe7155788Stephen Hines enable_fp = GET_CURRENT_FRAME(); \ 32686277eb844c4983c81de62d7c050e92fe7155788Stephen Hines (void)enable_fp; \ 32786277eb844c4983c81de62d7c050e92fe7155788Stephen Hines } while (0) 32886277eb844c4983c81de62d7c050e92fe7155788Stephen Hines 329c58a43648cd6121c51a2e795a28e2ef90d7813e6Pirama Arumuga Nainar} // namespace __sanitizer 330c58a43648cd6121c51a2e795a28e2ef90d7813e6Pirama Arumuga Nainar 331c58a43648cd6121c51a2e795a28e2ef90d7813e6Pirama Arumuga Nainarusing namespace __sanitizer; // NOLINT 332c58a43648cd6121c51a2e795a28e2ef90d7813e6Pirama Arumuga Nainar 3339aead37421a6e4bf43265e5195c6ac31fc519982Kostya Serebryany#endif // SANITIZER_DEFS_H 334