1//===-- sanitizer_internal_defs.h -------------------------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file is shared between AddressSanitizer and ThreadSanitizer.
10// It contains macro used in run-time libraries code.
11//===----------------------------------------------------------------------===//
12#ifndef SANITIZER_DEFS_H
13#define SANITIZER_DEFS_H
14
15#include "sanitizer_platform.h"
16#include "sanitizer_redefine_builtins.h"
17
18// GCC does not understand __has_feature.
19#if !defined(__has_feature)
20#define __has_feature(x) 0
21#endif
22
23#ifndef SANITIZER_DEBUG
24# define SANITIZER_DEBUG 0
25#endif
26
27#define SANITIZER_STRINGIFY_(S) #S
28#define SANITIZER_STRINGIFY(S) SANITIZER_STRINGIFY_(S)
29
30// Only use SANITIZER_*ATTRIBUTE* before the function return type!
31#if SANITIZER_WINDOWS
32#if SANITIZER_IMPORT_INTERFACE
33# define SANITIZER_INTERFACE_ATTRIBUTE __declspec(dllimport)
34#else
35# define SANITIZER_INTERFACE_ATTRIBUTE __declspec(dllexport)
36#endif
37# define SANITIZER_WEAK_ATTRIBUTE
38# define SANITIZER_WEAK_IMPORT
39#elif SANITIZER_GO
40# define SANITIZER_INTERFACE_ATTRIBUTE
41# define SANITIZER_WEAK_ATTRIBUTE
42# define SANITIZER_WEAK_IMPORT
43#else
44# define SANITIZER_INTERFACE_ATTRIBUTE __attribute__((visibility("default")))
45# define SANITIZER_WEAK_ATTRIBUTE __attribute__((weak))
46# if SANITIZER_APPLE
47# define SANITIZER_WEAK_IMPORT extern "C" __attribute((weak_import))
48# else
49# define SANITIZER_WEAK_IMPORT extern "C" SANITIZER_WEAK_ATTRIBUTE
50# endif // SANITIZER_APPLE
51#endif // SANITIZER_WINDOWS
52
53//--------------------------- WEAK FUNCTIONS ---------------------------------//
54// When working with weak functions, to simplify the code and make it more
55// portable, when possible define a default implementation using this macro:
56//
57// SANITIZER_INTERFACE_WEAK_DEF(<return_type>, <name>, <parameter list>)
58//
59// For example:
60// SANITIZER_INTERFACE_WEAK_DEF(bool, compare, int a, int b) { return a > b; }
61//
62#if SANITIZER_WINDOWS
63#include "sanitizer_win_defs.h"
64# define SANITIZER_INTERFACE_WEAK_DEF(ReturnType, Name, ...) \
65 WIN_WEAK_EXPORT_DEF(ReturnType, Name, __VA_ARGS__)
66#else
67# define SANITIZER_INTERFACE_WEAK_DEF(ReturnType, Name, ...) \
68 extern "C" SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE \
69 ReturnType Name(__VA_ARGS__)
70#endif
71
72// SANITIZER_SUPPORTS_WEAK_HOOKS means that we support real weak functions that
73// will evaluate to a null pointer when not defined.
74#ifndef SANITIZER_SUPPORTS_WEAK_HOOKS
75#if (SANITIZER_LINUX || SANITIZER_SOLARIS) && !SANITIZER_GO
76# define SANITIZER_SUPPORTS_WEAK_HOOKS 1
77// Before Xcode 4.5, the Darwin linker doesn't reliably support undefined
78// weak symbols. Mac OS X 10.9/Darwin 13 is the first release only supported
79// by Xcode >= 4.5.
80#elif SANITIZER_APPLE && \
81 __ENVIRONMENT_MAC_OS_X_VERSION_MIN_REQUIRED__ >= 1090 && !SANITIZER_GO
82# define SANITIZER_SUPPORTS_WEAK_HOOKS 1
83#else
84# define SANITIZER_SUPPORTS_WEAK_HOOKS 0
85#endif
86#endif // SANITIZER_SUPPORTS_WEAK_HOOKS
87// For some weak hooks that will be called very often and we want to avoid the
88// overhead of executing the default implementation when it is not necessary,
89// we can use the flag SANITIZER_SUPPORTS_WEAK_HOOKS to only define the default
90// implementation for platforms that doesn't support weak symbols. For example:
91//
92// #if !SANITIZER_SUPPORT_WEAK_HOOKS
93// SANITIZER_INTERFACE_WEAK_DEF(bool, compare_hook, int a, int b) {
94// return a > b;
95// }
96// #endif
97//
98// And then use it as: if (compare_hook) compare_hook(a, b);
99//----------------------------------------------------------------------------//
100
101
102// We can use .preinit_array section on Linux to call sanitizer initialization
103// functions very early in the process startup (unless PIC macro is defined).
104//
105// On FreeBSD, .preinit_array functions are called with rtld_bind_lock writer
106// lock held. It will lead to dead lock if unresolved PLT functions (which helds
107// rtld_bind_lock reader lock) are called inside .preinit_array functions.
108//
109// FIXME: do we have anything like this on Mac?
110#ifndef SANITIZER_CAN_USE_PREINIT_ARRAY
111#if (SANITIZER_LINUX || SANITIZER_FUCHSIA || SANITIZER_NETBSD) && !defined(PIC)
112#define SANITIZER_CAN_USE_PREINIT_ARRAY 1
113// Before Solaris 11.4, .preinit_array is fully supported only with GNU ld.
114// FIXME: Check for those conditions.
115#elif SANITIZER_SOLARIS && !defined(PIC)
116# define SANITIZER_CAN_USE_PREINIT_ARRAY 1
117#else
118# define SANITIZER_CAN_USE_PREINIT_ARRAY 0
119#endif
120#endif // SANITIZER_CAN_USE_PREINIT_ARRAY
121
122// GCC does not understand __has_feature
123#if !defined(__has_feature)
124# define __has_feature(x) 0
125#endif
126
127// Older GCCs do not understand __has_attribute.
128#if !defined(__has_attribute)
129# define __has_attribute(x) 0
130#endif
131
132#if !defined(__has_cpp_attribute)
133# define __has_cpp_attribute(x) 0
134#endif
135
136// For portability reasons we do not include stddef.h, stdint.h or any other
137// system header, but we do need some basic types that are not defined
138// in a portable way by the language itself.
139namespace __sanitizer {
140
141#if defined(_WIN64)
142// 64-bit Windows uses LLP64 data model.
143typedef unsigned long long uptr;
144typedef signed long long sptr;
145#else
146# if (SANITIZER_WORDSIZE == 64) || SANITIZER_APPLE || SANITIZER_WINDOWS
147typedef unsigned long uptr;
148typedef signed long sptr;
149# else
150typedef unsigned int uptr;
151typedef signed int sptr;
152# endif
153#endif // defined(_WIN64)
154#if defined(__x86_64__)
155// Since x32 uses ILP32 data model in 64-bit hardware mode, we must use
156// 64-bit pointer to unwind stack frame.
157typedef unsigned long long uhwptr;
158#else
159typedef uptr uhwptr;
160#endif
161typedef unsigned char u8;
162typedef unsigned short u16;
163typedef unsigned int u32;
164typedef unsigned long long u64;
165typedef signed char s8;
166typedef signed short s16;
167typedef signed int s32;
168typedef signed long long s64;
169#if SANITIZER_WINDOWS
170// On Windows, files are HANDLE, which is a synonim of void*.
171// Use void* to avoid including <windows.h> everywhere.
172typedef void* fd_t;
173typedef unsigned error_t;
174#else
175typedef int fd_t;
176typedef int error_t;
177#endif
178#if SANITIZER_SOLARIS && !defined(_LP64)
179typedef long pid_t;
180#else
181typedef int pid_t;
182#endif
183
184#if SANITIZER_FREEBSD || SANITIZER_NETBSD || SANITIZER_APPLE || \
185 (SANITIZER_SOLARIS && (defined(_LP64) || _FILE_OFFSET_BITS == 64)) || \
186 (SANITIZER_LINUX && !SANITIZER_GLIBC && !SANITIZER_ANDROID) || \
187 (SANITIZER_LINUX && (defined(__x86_64__) || defined(__hexagon__)))
188typedef u64 OFF_T;
189#else
190typedef uptr OFF_T;
191#endif
192typedef u64 OFF64_T;
193
194#if (SANITIZER_WORDSIZE == 64) || SANITIZER_APPLE
195typedef uptr operator_new_size_type;
196#else
197# if defined(__s390__) && !defined(__s390x__)
198// Special case: 31-bit s390 has unsigned long as size_t.
199typedef unsigned long operator_new_size_type;
200# else
201typedef u32 operator_new_size_type;
202# endif
203#endif
204
205typedef u64 tid_t;
206
207// ----------- ATTENTION -------------
208// This header should NOT include any other headers to avoid portability issues.
209
210// Common defs.
211#define INTERFACE_ATTRIBUTE SANITIZER_INTERFACE_ATTRIBUTE
212#define SANITIZER_WEAK_DEFAULT_IMPL \
213 extern "C" SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE NOINLINE
214#define SANITIZER_WEAK_CXX_DEFAULT_IMPL \
215 extern "C++" SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE NOINLINE
216
217// Platform-specific defs.
218#if defined(_MSC_VER)
219# define ALWAYS_INLINE __forceinline
220// FIXME(timurrrr): do we need this on Windows?
221# define ALIAS(x)
222# define ALIGNED(x) __declspec(align(x))
223# define FORMAT(f, a)
224# define NOINLINE __declspec(noinline)
225# define NORETURN __declspec(noreturn)
226# define THREADLOCAL __declspec(thread)
227# define LIKELY(x) (x)
228# define UNLIKELY(x) (x)
229# define PREFETCH(x) /* _mm_prefetch(x, _MM_HINT_NTA) */ (void)0
230# define WARN_UNUSED_RESULT
231#else // _MSC_VER
232# define ALWAYS_INLINE inline __attribute__((always_inline))
233# define ALIAS(x) __attribute__((alias(SANITIZER_STRINGIFY(x))))
234// Please only use the ALIGNED macro before the type.
235// Using ALIGNED after the variable declaration is not portable!
236# define ALIGNED(x) __attribute__((aligned(x)))
237# define FORMAT(f, a) __attribute__((format(printf, f, a)))
238# define NOINLINE __attribute__((noinline))
239# define NORETURN __attribute__((noreturn))
240# define THREADLOCAL __thread
241# define LIKELY(x) __builtin_expect(!!(x), 1)
242# define UNLIKELY(x) __builtin_expect(!!(x), 0)
243# if defined(__i386__) || defined(__x86_64__)
244// __builtin_prefetch(x) generates prefetchnt0 on x86
245# define PREFETCH(x) __asm__("prefetchnta (%0)" : : "r" (x))
246# else
247# define PREFETCH(x) __builtin_prefetch(x)
248# endif
249# define WARN_UNUSED_RESULT __attribute__((warn_unused_result))
250#endif // _MSC_VER
251
252#if !defined(_MSC_VER) || defined(__clang__)
253# define UNUSED __attribute__((unused))
254# define USED __attribute__((used))
255#else
256# define UNUSED
257# define USED
258#endif
259
260#if !defined(_MSC_VER) || defined(__clang__) || MSC_PREREQ(1900)
261# define NOEXCEPT noexcept
262#else
263# define NOEXCEPT throw()
264#endif
265
266#if __has_cpp_attribute(clang::fallthrough)
267# define FALLTHROUGH [[clang::fallthrough]]
268#elif __has_cpp_attribute(fallthrough)
269# define FALLTHROUGH [[fallthrough]]
270#else
271# define FALLTHROUGH
272#endif
273
274#if __has_attribute(uninitialized)
275# define UNINITIALIZED __attribute__((uninitialized))
276#else
277# define UNINITIALIZED
278#endif
279
280// Unaligned versions of basic types.
281typedef ALIGNED(1) u16 uu16;
282typedef ALIGNED(1) u32 uu32;
283typedef ALIGNED(1) u64 uu64;
284typedef ALIGNED(1) s16 us16;
285typedef ALIGNED(1) s32 us32;
286typedef ALIGNED(1) s64 us64;
287
288#if SANITIZER_WINDOWS
289} // namespace __sanitizer
290typedef unsigned long DWORD;
291namespace __sanitizer {
292typedef DWORD thread_return_t;
293# define THREAD_CALLING_CONV __stdcall
294#else // _WIN32
295typedef void* thread_return_t;
296# define THREAD_CALLING_CONV
297#endif // _WIN32
298typedef thread_return_t (THREAD_CALLING_CONV *thread_callback_t)(void* arg);
299
300// NOTE: Functions below must be defined in each run-time.
301void NORETURN Die();
302
303void NORETURN CheckFailed(const char *file, int line, const char *cond,
304 u64 v1, u64 v2);
305
306// Check macro
307#define RAW_CHECK_MSG(expr, msg, ...) \
308 do { \
309 if (UNLIKELY(!(expr))) { \
310 const char* msgs[] = {msg, __VA_ARGS__}; \
311 for (const char* m : msgs) RawWrite(m); \
312 Die(); \
313 } \
314 } while (0)
315
316#define RAW_CHECK(expr) RAW_CHECK_MSG(expr, #expr "\n", )
317#define RAW_CHECK_VA(expr, ...) RAW_CHECK_MSG(expr, #expr "\n", __VA_ARGS__)
318
319#define CHECK_IMPL(c1, op, c2) \
320 do { \
321 __sanitizer::u64 v1 = (__sanitizer::u64)(c1); \
322 __sanitizer::u64 v2 = (__sanitizer::u64)(c2); \
323 if (UNLIKELY(!(v1 op v2))) \
324 __sanitizer::CheckFailed(__FILE__, __LINE__, \
325 "(" #c1 ") " #op " (" #c2 ")", v1, v2); \
326 } while (false) \
327/**/
328
329#define CHECK(a) CHECK_IMPL((a), !=, 0)
330#define CHECK_EQ(a, b) CHECK_IMPL((a), ==, (b))
331#define CHECK_NE(a, b) CHECK_IMPL((a), !=, (b))
332#define CHECK_LT(a, b) CHECK_IMPL((a), <, (b))
333#define CHECK_LE(a, b) CHECK_IMPL((a), <=, (b))
334#define CHECK_GT(a, b) CHECK_IMPL((a), >, (b))
335#define CHECK_GE(a, b) CHECK_IMPL((a), >=, (b))
336
337#if SANITIZER_DEBUG
338#define DCHECK(a) CHECK(a)
339#define DCHECK_EQ(a, b) CHECK_EQ(a, b)
340#define DCHECK_NE(a, b) CHECK_NE(a, b)
341#define DCHECK_LT(a, b) CHECK_LT(a, b)
342#define DCHECK_LE(a, b) CHECK_LE(a, b)
343#define DCHECK_GT(a, b) CHECK_GT(a, b)
344#define DCHECK_GE(a, b) CHECK_GE(a, b)
345#else
346#define DCHECK(a)
347#define DCHECK_EQ(a, b)
348#define DCHECK_NE(a, b)
349#define DCHECK_LT(a, b)
350#define DCHECK_LE(a, b)
351#define DCHECK_GT(a, b)
352#define DCHECK_GE(a, b)
353#endif
354
355#define UNREACHABLE(msg) do { \
356 CHECK(0 && msg); \
357 Die(); \
358} while (0)
359
360#define UNIMPLEMENTED() UNREACHABLE("unimplemented")
361
362#define COMPILER_CHECK(pred) static_assert(pred, "")
363
364#define ARRAY_SIZE(a) (sizeof(a)/sizeof((a)[0]))
365
366// Limits for integral types. We have to redefine it in case we don't
367// have stdint.h (like in Visual Studio 9).
368#undef __INT64_C
369#undef __UINT64_C
370#if SANITIZER_WORDSIZE == 64
371# define __INT64_C(c) c ## L
372# define __UINT64_C(c) c ## UL
373#else
374# define __INT64_C(c) c ## LL
375# define __UINT64_C(c) c ## ULL
376#endif // SANITIZER_WORDSIZE == 64
377#undef INT32_MIN
378#define INT32_MIN (-2147483647-1)
379#undef INT32_MAX
380#define INT32_MAX (2147483647)
381#undef UINT32_MAX
382#define UINT32_MAX (4294967295U)
383#undef INT64_MIN
384#define INT64_MIN (-__INT64_C(9223372036854775807)-1)
385#undef INT64_MAX
386#define INT64_MAX (__INT64_C(9223372036854775807))
387#undef UINT64_MAX
388#define UINT64_MAX (__UINT64_C(18446744073709551615))
389#undef UINTPTR_MAX
390#if SANITIZER_WORDSIZE == 64
391# define UINTPTR_MAX (18446744073709551615UL)
392#else
393# define UINTPTR_MAX (4294967295U)
394#endif // SANITIZER_WORDSIZE == 64
395
396enum LinkerInitialized { LINKER_INITIALIZED = 0 };
397
398#if !defined(_MSC_VER) || defined(__clang__)
399# define GET_CALLER_PC() \
400 ((__sanitizer::uptr)__builtin_extract_return_addr( \
401 __builtin_return_address(0)))
402# define GET_CURRENT_FRAME() ((__sanitizer::uptr)__builtin_frame_address(0))
403inline void Trap() {
404 __builtin_trap();
405}
406#else
407extern "C" void* _ReturnAddress(void);
408extern "C" void* _AddressOfReturnAddress(void);
409# pragma intrinsic(_ReturnAddress)
410# pragma intrinsic(_AddressOfReturnAddress)
411# define GET_CALLER_PC() ((__sanitizer::uptr)_ReturnAddress())
412// CaptureStackBackTrace doesn't need to know BP on Windows.
413# define GET_CURRENT_FRAME() \
414 (((__sanitizer::uptr)_AddressOfReturnAddress()) + sizeof(__sanitizer::uptr))
415
416extern "C" void __ud2(void);
417# pragma intrinsic(__ud2)
418inline void Trap() {
419 __ud2();
420}
421#endif
422
423#define HANDLE_EINTR(res, f) \
424 { \
425 int rverrno; \
426 do { \
427 res = (f); \
428 } while (internal_iserror(res, &rverrno) && rverrno == EINTR); \
429 }
430
431// Forces the compiler to generate a frame pointer in the function.
432#define ENABLE_FRAME_POINTER \
433 do { \
434 volatile __sanitizer::uptr enable_fp; \
435 enable_fp = GET_CURRENT_FRAME(); \
436 (void)enable_fp; \
437 } while (0)
438
439// Internal thread identifier allocated by ThreadRegistry.
440typedef u32 Tid;
441constexpr Tid kInvalidTid = -1;
442constexpr Tid kMainTid = 0;
443
444// Stack depot stack identifier.
445typedef u32 StackID;
446const StackID kInvalidStackID = 0;
447
448} // namespace __sanitizer
449
450namespace __asan {
451using namespace __sanitizer;
452}
453namespace __dsan {
454using namespace __sanitizer;
455}
456namespace __dfsan {
457using namespace __sanitizer;
458}
459namespace __lsan {
460using namespace __sanitizer;
461}
462namespace __msan {
463using namespace __sanitizer;
464}
465namespace __hwasan {
466using namespace __sanitizer;
467}
468namespace __tsan {
469using namespace __sanitizer;
470}
471namespace __scudo {
472using namespace __sanitizer;
473}
474namespace __ubsan {
475using namespace __sanitizer;
476}
477namespace __xray {
478using namespace __sanitizer;
479}
480namespace __interception {
481using namespace __sanitizer;
482}
483namespace __hwasan {
484using namespace __sanitizer;
485}
486namespace __memprof {
487using namespace __sanitizer;
488}
489
490#endif // SANITIZER_DEFS_H
491

source code of compiler-rt/lib/sanitizer_common/sanitizer_internal_defs.h