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