sanitizer_internal_defs.h revision dd3a911e46b3f0416d60d9be5c84ccfc4b1c3aa8 
1//===-- sanitizer_internal_defs.h -------------------------------*- C++ -*-===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file is shared between AddressSanitizer and ThreadSanitizer.
11// It contains macro used in run-time libraries code.
12//===----------------------------------------------------------------------===//
13#ifndef SANITIZER_DEFS_H
14#define SANITIZER_DEFS_H
15
16#include "sanitizer_interface_defs.h"
17using namespace __sanitizer;  // NOLINT
18// ----------- ATTENTION -------------
19// This header should NOT include any other headers to avoid portability issues.
20
21// Common defs.
22#define INLINE static inline
23#define INTERFACE_ATTRIBUTE SANITIZER_INTERFACE_ATTRIBUTE
24#define WEAK SANITIZER_WEAK_ATTRIBUTE
25
26// Platform-specific defs.
27#if defined(_WIN32)
28typedef unsigned long    DWORD;  // NOLINT
29// FIXME(timurrrr): do we need this on Windows?
30# define ALIAS(x)
31# define ALIGNED(x) __declspec(align(x))
32# define FORMAT(f, a)
33# define NOINLINE __declspec(noinline)
34# define NORETURN __declspec(noreturn)
35# define THREADLOCAL   __declspec(thread)
36#else  // _WIN32
37# define ALIAS(x) __attribute__((alias(x)))
38# define ALIGNED(x) __attribute__((aligned(x)))
39# define FORMAT(f, a)  __attribute__((format(printf, f, a)))
40# define NOINLINE __attribute__((noinline))
41# define NORETURN  __attribute__((noreturn))
42# define THREADLOCAL   __thread
43#endif  // _WIN32
44
45// We have no equivalent of these on Windows.
46#ifndef _WIN32
47# define ALWAYS_INLINE __attribute__((always_inline))
48# define LIKELY(x)     __builtin_expect(!!(x), 1)
49# define UNLIKELY(x)   __builtin_expect(!!(x), 0)
50# define UNUSED __attribute__((unused))
51# define USED __attribute__((used))
52#endif
53
54#if defined(_WIN32)
55typedef DWORD thread_return_t;
56# define THREAD_CALLING_CONV __stdcall
57#else  // _WIN32
58typedef void* thread_return_t;
59# define THREAD_CALLING_CONV
60#endif  // _WIN32
61typedef thread_return_t (THREAD_CALLING_CONV *thread_callback_t)(void* arg);
62
63// If __WORDSIZE was undefined by the platform, define it in terms of the
64// compiler built-ins __LP64__ and _WIN64.
65#ifndef __WORDSIZE
66# if __LP64__ || defined(_WIN64)
67#  define __WORDSIZE 64
68# else
69#  define __WORDSIZE 32
70#  endif
71#endif  // __WORDSIZE
72
73// NOTE: Functions below must be defined in each run-time.
74namespace __sanitizer {
75void NORETURN Die();
76void NORETURN CheckFailed(const char *file, int line, const char *cond,
77                          u64 v1, u64 v2);
78}  // namespace __sanitizer
79
80// Check macro
81#define RAW_CHECK_MSG(expr, msg) do { \
82  if (!(expr)) { \
83    RawWrite(msg); \
84    Die(); \
85  } \
86} while (0)
87
88#define RAW_CHECK(expr) RAW_CHECK_MSG(expr, #expr)
89
90#define CHECK_IMPL(c1, op, c2) \
91  do { \
92    __sanitizer::u64 v1 = (u64)(c1); \
93    __sanitizer::u64 v2 = (u64)(c2); \
94    if (!(v1 op v2)) \
95      __sanitizer::CheckFailed(__FILE__, __LINE__, \
96        "(" #c1 ") " #op " (" #c2 ")", v1, v2); \
97  } while (false) \
98/**/
99
100#define CHECK(a)       CHECK_IMPL((a), !=, 0)
101#define CHECK_EQ(a, b) CHECK_IMPL((a), ==, (b))
102#define CHECK_NE(a, b) CHECK_IMPL((a), !=, (b))
103#define CHECK_LT(a, b) CHECK_IMPL((a), <,  (b))
104#define CHECK_LE(a, b) CHECK_IMPL((a), <=, (b))
105#define CHECK_GT(a, b) CHECK_IMPL((a), >,  (b))
106#define CHECK_GE(a, b) CHECK_IMPL((a), >=, (b))
107
108#define UNIMPLEMENTED() CHECK("unimplemented" && 0)
109
110#endif  // SANITIZER_DEFS_H
111