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 183c80c6c574850106481f82b9e23d1c728458d4a9Timur Iskhodzhanov// Only use SANITIZER_*ATTRIBUTE* before the function return type! 1930e110edf92303237d471f1cb8e3ad07954fb145Evgeniy Stepanov#if SANITIZER_WINDOWS 203c80c6c574850106481f82b9e23d1c728458d4a9Timur Iskhodzhanov# define SANITIZER_INTERFACE_ATTRIBUTE __declspec(dllexport) 213c80c6c574850106481f82b9e23d1c728458d4a9Timur Iskhodzhanov// FIXME find out what we need on Windows, if anything. 22250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov# define SANITIZER_WEAK_ATTRIBUTE 23250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov#elif defined(SANITIZER_GO) 24250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov# define SANITIZER_INTERFACE_ATTRIBUTE 25250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov# define SANITIZER_WEAK_ATTRIBUTE 26250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov#else 27250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov# define SANITIZER_INTERFACE_ATTRIBUTE __attribute__((visibility("default"))) 28250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov# define SANITIZER_WEAK_ATTRIBUTE __attribute__((weak)) 29250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov#endif 30250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov 3178b580f3d40132816f813c3dbf073d824137436aAlexey Samsonov#if SANITIZER_LINUX && !defined(SANITIZER_GO) 32250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov# define SANITIZER_SUPPORTS_WEAK_HOOKS 1 33250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov#else 34250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov# define SANITIZER_SUPPORTS_WEAK_HOOKS 0 35250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov#endif 36250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov 37e31eca900a1f8849af75100c2d92e838d79d0920Kostya Serebryany// GCC does not understand __has_feature 38250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov#if !defined(__has_feature) 39250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov# define __has_feature(x) 0 40250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov#endif 41250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov 42250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov// For portability reasons we do not include stddef.h, stdint.h or any other 43250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov// system header, but we do need some basic types that are not defined 44250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov// in a portable way by the language itself. 45250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanovnamespace __sanitizer { 46250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov 47250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov#if defined(_WIN64) 48250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov// 64-bit Windows uses LLP64 data model. 49250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanovtypedef unsigned long long uptr; // NOLINT 50250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanovtypedef signed long long sptr; // NOLINT 51250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov#else 52250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanovtypedef unsigned long uptr; // NOLINT 53250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanovtypedef signed long sptr; // NOLINT 54250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov#endif // defined(_WIN64) 557f790caa37ec1c9807c877297d30e040e83ed215Bill Wendling#if defined(__x86_64__) 562d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines// Since x32 uses ILP32 data model in 64-bit hardware mode, we must use 577f790caa37ec1c9807c877297d30e040e83ed215Bill Wendling// 64-bit pointer to unwind stack frame. 587f790caa37ec1c9807c877297d30e040e83ed215Bill Wendlingtypedef unsigned long long uhwptr; // NOLINT 597f790caa37ec1c9807c877297d30e040e83ed215Bill Wendling#else 607f790caa37ec1c9807c877297d30e040e83ed215Bill Wendlingtypedef uptr uhwptr; // NOLINT 617f790caa37ec1c9807c877297d30e040e83ed215Bill Wendling#endif 62250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanovtypedef unsigned char u8; 63250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanovtypedef unsigned short u16; // NOLINT 64250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanovtypedef unsigned int u32; 65250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanovtypedef unsigned long long u64; // NOLINT 66250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanovtypedef signed char s8; 67250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanovtypedef signed short s16; // NOLINT 68250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanovtypedef signed int s32; 69250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanovtypedef signed long long s64; // NOLINT 70ee7cc4454421a176d23442382afd9a01d36e7ad4Alexey Samsonovtypedef int fd_t; 71250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov 726fb47af2d2d305adbfc3d41bea589d1527a364a9Kostya Serebryany// WARNING: OFF_T may be different from OS type off_t, depending on the value of 736fb47af2d2d305adbfc3d41bea589d1527a364a9Kostya Serebryany// _FILE_OFFSET_BITS. This definition of OFF_T matches the ABI of system calls 746fb47af2d2d305adbfc3d41bea589d1527a364a9Kostya Serebryany// like pread and mmap, as opposed to pread64 and mmap64. 756fb47af2d2d305adbfc3d41bea589d1527a364a9Kostya Serebryany// Mac and Linux/x86-64 are special. 7630e110edf92303237d471f1cb8e3ad07954fb145Evgeniy Stepanov#if SANITIZER_MAC || (SANITIZER_LINUX && defined(__x86_64__)) 776fb47af2d2d305adbfc3d41bea589d1527a364a9Kostya Serebryanytypedef u64 OFF_T; 786fb47af2d2d305adbfc3d41bea589d1527a364a9Kostya Serebryany#else 796fb47af2d2d305adbfc3d41bea589d1527a364a9Kostya Serebryanytypedef uptr OFF_T; 806fb47af2d2d305adbfc3d41bea589d1527a364a9Kostya Serebryany#endif 816fb47af2d2d305adbfc3d41bea589d1527a364a9Kostya Serebryanytypedef u64 OFF64_T; 8253177247698bfba075f2d5b255a447fc3ced6976Peter Collingbourne 8353177247698bfba075f2d5b255a447fc3ced6976Peter Collingbourne#if (SANITIZER_WORDSIZE == 64) || SANITIZER_MAC 8453177247698bfba075f2d5b255a447fc3ced6976Peter Collingbournetypedef uptr operator_new_size_type; 8553177247698bfba075f2d5b255a447fc3ced6976Peter Collingbourne#else 8653177247698bfba075f2d5b255a447fc3ced6976Peter Collingbournetypedef u32 operator_new_size_type; 8753177247698bfba075f2d5b255a447fc3ced6976Peter Collingbourne#endif 88250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov} // namespace __sanitizer 89250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov 90250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanovextern "C" { 91250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov // Tell the tools to write their reports to "path.<pid>" instead of stderr. 92b48c2b2072c8cc17dc1579a6b20ce6c2a575821dDmitry Vyukov // The special values are "stdout" and "stderr". 933c80c6c574850106481f82b9e23d1c728458d4a9Timur Iskhodzhanov SANITIZER_INTERFACE_ATTRIBUTE 943c80c6c574850106481f82b9e23d1c728458d4a9Timur Iskhodzhanov void __sanitizer_set_report_path(const char *path); 95250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov 962d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines typedef struct { 972d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines int coverage_sandboxed; 982d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines __sanitizer::sptr coverage_fd; 992d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines unsigned int coverage_max_block_size; 1002d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines } __sanitizer_sandbox_arguments; 1012d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines 1022d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines // Notify the tools that the sandbox is going to be turned on. 1032d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE void 1042d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines __sanitizer_sandbox_on_notify(__sanitizer_sandbox_arguments *args); 1052673fd8406197c42f16cede6d287f72169298c2eKostya Serebryany 1062673fd8406197c42f16cede6d287f72169298c2eKostya Serebryany // This function is called by the tool when it has just finished reporting 1072673fd8406197c42f16cede6d287f72169298c2eKostya Serebryany // an error. 'error_summary' is a one-line string that summarizes 1082673fd8406197c42f16cede6d287f72169298c2eKostya Serebryany // the error message. This function can be overridden by the client. 1093c80c6c574850106481f82b9e23d1c728458d4a9Timur Iskhodzhanov SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE 1103c80c6c574850106481f82b9e23d1c728458d4a9Timur Iskhodzhanov void __sanitizer_report_error_summary(const char *error_summary); 111dbd69cc9ccda50efd0305cd0ce9bad50defe4b42Bob Wilson 112dbd69cc9ccda50efd0305cd0ce9bad50defe4b42Bob Wilson SANITIZER_INTERFACE_ATTRIBUTE void __sanitizer_cov_dump(); 1132d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines SANITIZER_INTERFACE_ATTRIBUTE void __sanitizer_cov_init(); 1142d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines SANITIZER_INTERFACE_ATTRIBUTE void __sanitizer_cov(); 1152d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines SANITIZER_INTERFACE_ATTRIBUTE 1162d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines void __sanitizer_annotate_contiguous_container(const void *beg, 1172d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines const void *end, 1182d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines const void *old_mid, 1192d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines const void *new_mid); 1202991200255098ac0739952351b2eb2b487819eecKostya Serebryany SANITIZER_INTERFACE_ATTRIBUTE 1212d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines int __sanitizer_verify_contiguous_container(const void *beg, const void *mid, 1222d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines const void *end); 123250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov} // extern "C" 124250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov 125250f221ae0dee295098da8aa631977b6c2ebc99bEvgeniy Stepanov 1260a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonovusing namespace __sanitizer; // NOLINT 1279aead37421a6e4bf43265e5195c6ac31fc519982Kostya Serebryany// ----------- ATTENTION ------------- 1289aead37421a6e4bf43265e5195c6ac31fc519982Kostya Serebryany// This header should NOT include any other headers to avoid portability issues. 1299aead37421a6e4bf43265e5195c6ac31fc519982Kostya Serebryany 1300a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov// Common defs. 13140e16683f3fdf23dba20d9d0fc2eb00d562cc8dfTimur Iskhodzhanov#define INLINE inline 1320a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov#define INTERFACE_ATTRIBUTE SANITIZER_INTERFACE_ATTRIBUTE 1330a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov#define WEAK SANITIZER_WEAK_ATTRIBUTE 1340a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov 1350a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov// Platform-specific defs. 136bfa45e11e52081c55294355f36fa547f163dcc67Dmitry Vyukov#if defined(_MSC_VER) 13740e16683f3fdf23dba20d9d0fc2eb00d562cc8dfTimur Iskhodzhanov# define ALWAYS_INLINE __forceinline 1380a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov// FIXME(timurrrr): do we need this on Windows? 1390a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define ALIAS(x) 1400a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define ALIGNED(x) __declspec(align(x)) 14115503b0a4331c7f27f9cebc25e25c2e494f61cb9Alexey Samsonov# define FORMAT(f, a) 1420a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define NOINLINE __declspec(noinline) 1430a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define NORETURN __declspec(noreturn) 1440a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define THREADLOCAL __declspec(thread) 145d51a1a10cba87be50e9ada9fa21337c387edb237Dmitry Vyukov# define NOTHROW 146e2462f7461961925f7f20577352c01e867365d8bDmitry Vyukov# define LIKELY(x) (x) 147e2462f7461961925f7f20577352c01e867365d8bDmitry Vyukov# define UNLIKELY(x) (x) 148b1bd208bfa496391085056b1709542b80dcfb21eDmitry Vyukov# define PREFETCH(x) /* _mm_prefetch(x, _MM_HINT_NTA) */ 149bfa45e11e52081c55294355f36fa547f163dcc67Dmitry Vyukov#else // _MSC_VER 150d475aa8578f4a1955cdb3e3159eda8b229f8c021Kostya Serebryany# define ALWAYS_INLINE inline __attribute__((always_inline)) 1510a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define ALIAS(x) __attribute__((alias(x))) 1527c9ffde46a475d6dd739e977b547c27ac5968976Timur Iskhodzhanov// Please only use the ALIGNED macro before the type. 1537c9ffde46a475d6dd739e977b547c27ac5968976Timur Iskhodzhanov// Using ALIGNED after the variable declaration is not portable! 1540a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define ALIGNED(x) __attribute__((aligned(x))) 15515503b0a4331c7f27f9cebc25e25c2e494f61cb9Alexey Samsonov# define FORMAT(f, a) __attribute__((format(printf, f, a))) 1560a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define NOINLINE __attribute__((noinline)) 1570a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define NORETURN __attribute__((noreturn)) 1580a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define THREADLOCAL __thread 15997daee89b35f6141db09aee612f0f377f754092fDmitry Vyukov# define NOTHROW throw() 1600a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define LIKELY(x) __builtin_expect(!!(x), 1) 1610a4c906dbc8f150657ddd4f19a7192b779f1d605Alexey Samsonov# define UNLIKELY(x) __builtin_expect(!!(x), 0) 1620c7f61c7f0a6981a1722aea325500ce80dc08a04Dmitry Vyukov# if defined(__i386__) || defined(__x86_64__) 1630c7f61c7f0a6981a1722aea325500ce80dc08a04Dmitry Vyukov// __builtin_prefetch(x) generates prefetchnt0 on x86 1640c7f61c7f0a6981a1722aea325500ce80dc08a04Dmitry Vyukov# define PREFETCH(x) __asm__("prefetchnta (%0)" : : "r" (x)) 1650c7f61c7f0a6981a1722aea325500ce80dc08a04Dmitry Vyukov# else 1660c7f61c7f0a6981a1722aea325500ce80dc08a04Dmitry Vyukov# define PREFETCH(x) __builtin_prefetch(x) 1670c7f61c7f0a6981a1722aea325500ce80dc08a04Dmitry Vyukov# endif 168e2462f7461961925f7f20577352c01e867365d8bDmitry Vyukov#endif // _MSC_VER 1699aead37421a6e4bf43265e5195c6ac31fc519982Kostya Serebryany 1702d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines#if !defined(_MSC_VER) || defined(__clang__) 1712d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines# define UNUSED __attribute__((unused)) 1722d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines# define USED __attribute__((used)) 1732d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines#else 1742d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines# define UNUSED 1752d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines# define USED 1762d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines#endif 1772d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines 1787202e79d5457477b9db24daf0af2c6c7464c3378Evgeniy Stepanov// Unaligned versions of basic types. 1797202e79d5457477b9db24daf0af2c6c7464c3378Evgeniy Stepanovtypedef ALIGNED(1) u16 uu16; 1807202e79d5457477b9db24daf0af2c6c7464c3378Evgeniy Stepanovtypedef ALIGNED(1) u32 uu32; 1817202e79d5457477b9db24daf0af2c6c7464c3378Evgeniy Stepanovtypedef ALIGNED(1) u64 uu64; 1827202e79d5457477b9db24daf0af2c6c7464c3378Evgeniy Stepanovtypedef ALIGNED(1) s16 us16; 1837202e79d5457477b9db24daf0af2c6c7464c3378Evgeniy Stepanovtypedef ALIGNED(1) s32 us32; 1847202e79d5457477b9db24daf0af2c6c7464c3378Evgeniy Stepanovtypedef ALIGNED(1) s64 us64; 1857202e79d5457477b9db24daf0af2c6c7464c3378Evgeniy Stepanov 18630e110edf92303237d471f1cb8e3ad07954fb145Evgeniy Stepanov#if SANITIZER_WINDOWS 187bb19294a1195fb320047bace7732f15e85ac4da5Dmitry Vyukovtypedef unsigned long DWORD; // NOLINT 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 Samsonovnamespace __sanitizer { 19815a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonovvoid NORETURN Die(); 199f109267c5320210e69c1b66add801fd5f2e2a452Timur Iskhodzhanov 200f109267c5320210e69c1b66add801fd5f2e2a452Timur Iskhodzhanov// FIXME: No, this shouldn't be in the sanitizer interface. 201f109267c5320210e69c1b66add801fd5f2e2a452Timur IskhodzhanovSANITIZER_INTERFACE_ATTRIBUTE 20215a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonovvoid NORETURN CheckFailed(const char *file, int line, const char *cond, 20315a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov u64 v1, u64 v2); 20415a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov} // namespace __sanitizer 20515a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov 20615a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov// Check macro 207230c3be6cdd094a187f48e27ba0961dbeee70344Alexey Samsonov#define RAW_CHECK_MSG(expr, msg) do { \ 2082d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines if (UNLIKELY(!(expr))) { \ 209230c3be6cdd094a187f48e27ba0961dbeee70344Alexey Samsonov RawWrite(msg); \ 210230c3be6cdd094a187f48e27ba0961dbeee70344Alexey Samsonov Die(); \ 211230c3be6cdd094a187f48e27ba0961dbeee70344Alexey Samsonov } \ 212230c3be6cdd094a187f48e27ba0961dbeee70344Alexey Samsonov} while (0) 213230c3be6cdd094a187f48e27ba0961dbeee70344Alexey Samsonov 214230c3be6cdd094a187f48e27ba0961dbeee70344Alexey Samsonov#define RAW_CHECK(expr) RAW_CHECK_MSG(expr, #expr) 215230c3be6cdd094a187f48e27ba0961dbeee70344Alexey Samsonov 21615a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov#define CHECK_IMPL(c1, op, c2) \ 21715a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov do { \ 21815a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov __sanitizer::u64 v1 = (u64)(c1); \ 21915a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov __sanitizer::u64 v2 = (u64)(c2); \ 2202d1fdb26e458c4ddc04155c1d421bced3ba90cd0Stephen Hines if (UNLIKELY(!(v1 op v2))) \ 22115a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov __sanitizer::CheckFailed(__FILE__, __LINE__, \ 22215a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov "(" #c1 ") " #op " (" #c2 ")", v1, v2); \ 22315a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov } while (false) \ 22415a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov/**/ 22515a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov 22615a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov#define CHECK(a) CHECK_IMPL((a), !=, 0) 22715a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov#define CHECK_EQ(a, b) CHECK_IMPL((a), ==, (b)) 22815a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov#define CHECK_NE(a, b) CHECK_IMPL((a), !=, (b)) 22915a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov#define CHECK_LT(a, b) CHECK_IMPL((a), <, (b)) 23015a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov#define CHECK_LE(a, b) CHECK_IMPL((a), <=, (b)) 23115a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov#define CHECK_GT(a, b) CHECK_IMPL((a), >, (b)) 23215a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov#define CHECK_GE(a, b) CHECK_IMPL((a), >=, (b)) 23315a77612e0a89c1df444a2034e531c8968d0cedfAlexey Samsonov 234fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#if TSAN_DEBUG 235fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK(a) CHECK(a) 236fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_EQ(a, b) CHECK_EQ(a, b) 237fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_NE(a, b) CHECK_NE(a, b) 238fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_LT(a, b) CHECK_LT(a, b) 239fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_LE(a, b) CHECK_LE(a, b) 240fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_GT(a, b) CHECK_GT(a, b) 241fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_GE(a, b) CHECK_GE(a, b) 242fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#else 243fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK(a) 244fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_EQ(a, b) 245fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_NE(a, b) 246fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_LT(a, b) 247fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_LE(a, b) 248fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_GT(a, b) 249fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#define DCHECK_GE(a, b) 250fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov#endif 251fce5bd4cc29fddb5e8f0cb9c12df7c10187a991dDmitry Vyukov 25245418d1ccb083cad3cb84e0b8184adfb85876fc5Alexey Samsonov#define UNREACHABLE(msg) do { \ 25345418d1ccb083cad3cb84e0b8184adfb85876fc5Alexey Samsonov CHECK(0 && msg); \ 25445418d1ccb083cad3cb84e0b8184adfb85876fc5Alexey Samsonov Die(); \ 2555759d92e99e2b7adcc46a8729f16023208dd8f37Kostya Serebryany} while (0) 25645418d1ccb083cad3cb84e0b8184adfb85876fc5Alexey Samsonov 25745418d1ccb083cad3cb84e0b8184adfb85876fc5Alexey Samsonov#define UNIMPLEMENTED() UNREACHABLE("unimplemented") 2588c53e54ef9e713953ec9495e82e5c330b96e49f3Alexey Samsonov 259c375657778e8a72d566e29951060b7eadc749b0dKostya Serebryany#define COMPILER_CHECK(pred) IMPL_COMPILER_ASSERT(pred, __LINE__) 260c375657778e8a72d566e29951060b7eadc749b0dKostya Serebryany 2614c2ddda9ac80f94782b2b040208831233db578afKostya Serebryany#define ARRAY_SIZE(a) (sizeof(a)/sizeof((a)[0])) 2624c2ddda9ac80f94782b2b040208831233db578afKostya Serebryany 263c375657778e8a72d566e29951060b7eadc749b0dKostya Serebryany#define IMPL_PASTE(a, b) a##b 264c375657778e8a72d566e29951060b7eadc749b0dKostya Serebryany#define IMPL_COMPILER_ASSERT(pred, line) \ 265d7ed1f09f316628b2d981a1d8c2cf0f5af30e90eAlexey Samsonov typedef char IMPL_PASTE(assertion_failed_##_, line)[2*(int)(pred)-1] 266c375657778e8a72d566e29951060b7eadc749b0dKostya Serebryany 267c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov// Limits for integral types. We have to redefine it in case we don't 268c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov// have stdint.h (like in Visual Studio 9). 269b46941a1d23012491a7a8a52718cacbde3c19ba1Alexey Samsonov#undef __INT64_C 270b46941a1d23012491a7a8a52718cacbde3c19ba1Alexey Samsonov#undef __UINT64_C 2715af39e50366f1aacbebc284f572f08ad1ad07357Kostya Serebryany#if SANITIZER_WORDSIZE == 64 272c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov# define __INT64_C(c) c ## L 273c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov# define __UINT64_C(c) c ## UL 274c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#else 275c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov# define __INT64_C(c) c ## LL 276c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov# define __UINT64_C(c) c ## ULL 2775af39e50366f1aacbebc284f572f08ad1ad07357Kostya Serebryany#endif // SANITIZER_WORDSIZE == 64 278c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#undef INT32_MIN 279c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#define INT32_MIN (-2147483647-1) 280c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#undef INT32_MAX 281c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#define INT32_MAX (2147483647) 282c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#undef UINT32_MAX 283c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#define UINT32_MAX (4294967295U) 284c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#undef INT64_MIN 285c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#define INT64_MIN (-__INT64_C(9223372036854775807)-1) 286c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#undef INT64_MAX 287c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#define INT64_MAX (__INT64_C(9223372036854775807)) 288c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#undef UINT64_MAX 289c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov#define UINT64_MAX (__UINT64_C(18446744073709551615)) 290c925697df6626bb0ea27ea96539bf0580f8f3d3dAlexey Samsonov 29170e177e29c6f9ac987b65a79f6b4f3ebdabc75ccAlexey Samsonovenum LinkerInitialized { LINKER_INITIALIZED = 0 }; 29270e177e29c6f9ac987b65a79f6b4f3ebdabc75ccAlexey Samsonov 293b46941a1d23012491a7a8a52718cacbde3c19ba1Alexey Samsonov#if !defined(_MSC_VER) || defined(__clang__) 2941b5ea8fbbef73f5d9b41dbb26a21b9a0f4d1445eKostya Serebryany# define GET_CALLER_PC() (uptr)__builtin_return_address(0) 2951b5ea8fbbef73f5d9b41dbb26a21b9a0f4d1445eKostya Serebryany# define GET_CURRENT_FRAME() (uptr)__builtin_frame_address(0) 2961b5ea8fbbef73f5d9b41dbb26a21b9a0f4d1445eKostya Serebryany#else 29780acccf4647c3482c3e3e6ae21e757ba580a5956Kostya Serebryanyextern "C" void* _ReturnAddress(void); 29880acccf4647c3482c3e3e6ae21e757ba580a5956Kostya Serebryany# pragma intrinsic(_ReturnAddress) 2991b5ea8fbbef73f5d9b41dbb26a21b9a0f4d1445eKostya Serebryany# define GET_CALLER_PC() (uptr)_ReturnAddress() 3001b5ea8fbbef73f5d9b41dbb26a21b9a0f4d1445eKostya Serebryany// CaptureStackBackTrace doesn't need to know BP on Windows. 3011b5ea8fbbef73f5d9b41dbb26a21b9a0f4d1445eKostya Serebryany// FIXME: This macro is still used when printing error reports though it's not 3021b5ea8fbbef73f5d9b41dbb26a21b9a0f4d1445eKostya Serebryany// clear if the BP value is needed in the ASan reports on Windows. 3031b5ea8fbbef73f5d9b41dbb26a21b9a0f4d1445eKostya Serebryany# define GET_CURRENT_FRAME() (uptr)0xDEADBEEF 3041b5ea8fbbef73f5d9b41dbb26a21b9a0f4d1445eKostya Serebryany#endif 3051b5ea8fbbef73f5d9b41dbb26a21b9a0f4d1445eKostya Serebryany 3069578a3ecfc35a264ede1135033398e2a77a6cad6Peter Collingbourne#define HANDLE_EINTR(res, f) \ 3079578a3ecfc35a264ede1135033398e2a77a6cad6Peter Collingbourne { \ 3089578a3ecfc35a264ede1135033398e2a77a6cad6Peter Collingbourne int rverrno; \ 3099578a3ecfc35a264ede1135033398e2a77a6cad6Peter Collingbourne do { \ 3109578a3ecfc35a264ede1135033398e2a77a6cad6Peter Collingbourne res = (f); \ 3119578a3ecfc35a264ede1135033398e2a77a6cad6Peter Collingbourne } while (internal_iserror(res, &rverrno) && rverrno == EINTR); \ 3123334e12d33261cb8f211f2f49f28ddfa027a40c3Evgeniy Stepanov } 3133334e12d33261cb8f211f2f49f28ddfa027a40c3Evgeniy Stepanov 3149aead37421a6e4bf43265e5195c6ac31fc519982Kostya Serebryany#endif // SANITIZER_DEFS_H 315