1 | //===-- sanitizer_platform.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 | // Common platform macros. |
10 | //===----------------------------------------------------------------------===// |
11 | |
12 | #ifndef SANITIZER_PLATFORM_H |
13 | #define SANITIZER_PLATFORM_H |
14 | |
15 | #if !defined(__linux__) && !defined(__FreeBSD__) && !defined(__NetBSD__) && \ |
16 | !defined(__APPLE__) && !defined(_WIN32) && !defined(__Fuchsia__) && \ |
17 | !(defined(__sun__) && defined(__svr4__)) && !defined(__HAIKU__) |
18 | # error "This operating system is not supported" |
19 | #endif |
20 | |
21 | // Get __GLIBC__ on a glibc platform. Exclude Android: features.h includes C |
22 | // function declarations into a .S file which doesn't compile. |
23 | // https://crbug.com/1162741 |
24 | #if __has_include(<features.h>) && !defined(__ANDROID__) |
25 | # include <features.h> |
26 | #endif |
27 | |
28 | #if defined(__linux__) |
29 | # define SANITIZER_LINUX 1 |
30 | #else |
31 | # define SANITIZER_LINUX 0 |
32 | #endif |
33 | |
34 | #if defined(__GLIBC__) |
35 | # define SANITIZER_GLIBC 1 |
36 | #else |
37 | # define SANITIZER_GLIBC 0 |
38 | #endif |
39 | |
40 | #if defined(__FreeBSD__) |
41 | # define SANITIZER_FREEBSD 1 |
42 | #else |
43 | # define SANITIZER_FREEBSD 0 |
44 | #endif |
45 | |
46 | #if defined(__NetBSD__) |
47 | # define SANITIZER_NETBSD 1 |
48 | #else |
49 | # define SANITIZER_NETBSD 0 |
50 | #endif |
51 | |
52 | #if defined(__sun__) && defined(__svr4__) |
53 | # define SANITIZER_SOLARIS 1 |
54 | #else |
55 | # define SANITIZER_SOLARIS 0 |
56 | #endif |
57 | |
58 | #if defined(__HAIKU__) |
59 | # define SANITIZER_HAIKU 1 |
60 | #else |
61 | # define SANITIZER_HAIKU 0 |
62 | #endif |
63 | |
64 | // - SANITIZER_APPLE: all Apple code |
65 | // - TARGET_OS_OSX: macOS |
66 | // - SANITIZER_IOS: devices (iOS and iOS-like) |
67 | // - SANITIZER_WATCHOS |
68 | // - SANITIZER_TVOS |
69 | // - SANITIZER_IOSSIM: simulators (iOS and iOS-like) |
70 | // - SANITIZER_DRIVERKIT |
71 | #if defined(__APPLE__) |
72 | # define SANITIZER_APPLE 1 |
73 | # include <TargetConditionals.h> |
74 | # if TARGET_OS_OSX |
75 | # define SANITIZER_OSX 1 |
76 | # else |
77 | # define SANITIZER_OSX 0 |
78 | # endif |
79 | # if TARGET_OS_IPHONE |
80 | # define SANITIZER_IOS 1 |
81 | # else |
82 | # define SANITIZER_IOS 0 |
83 | # endif |
84 | # if TARGET_OS_WATCH |
85 | # define SANITIZER_WATCHOS 1 |
86 | # else |
87 | # define SANITIZER_WATCHOS 0 |
88 | # endif |
89 | # if TARGET_OS_TV |
90 | # define SANITIZER_TVOS 1 |
91 | # else |
92 | # define SANITIZER_TVOS 0 |
93 | # endif |
94 | # if TARGET_OS_SIMULATOR |
95 | # define SANITIZER_IOSSIM 1 |
96 | # else |
97 | # define SANITIZER_IOSSIM 0 |
98 | # endif |
99 | # if defined(TARGET_OS_DRIVERKIT) && TARGET_OS_DRIVERKIT |
100 | # define SANITIZER_DRIVERKIT 1 |
101 | # else |
102 | # define SANITIZER_DRIVERKIT 0 |
103 | # endif |
104 | #else |
105 | # define SANITIZER_APPLE 0 |
106 | # define SANITIZER_OSX 0 |
107 | # define SANITIZER_IOS 0 |
108 | # define SANITIZER_WATCHOS 0 |
109 | # define SANITIZER_TVOS 0 |
110 | # define SANITIZER_IOSSIM 0 |
111 | # define SANITIZER_DRIVERKIT 0 |
112 | #endif |
113 | |
114 | #if defined(_WIN32) |
115 | # define SANITIZER_WINDOWS 1 |
116 | #else |
117 | # define SANITIZER_WINDOWS 0 |
118 | #endif |
119 | |
120 | #if defined(_WIN64) |
121 | # define SANITIZER_WINDOWS64 1 |
122 | #else |
123 | # define SANITIZER_WINDOWS64 0 |
124 | #endif |
125 | |
126 | #if defined(__ANDROID__) |
127 | # define SANITIZER_ANDROID 1 |
128 | #else |
129 | # define SANITIZER_ANDROID 0 |
130 | #endif |
131 | |
132 | #if defined(__Fuchsia__) |
133 | # define SANITIZER_FUCHSIA 1 |
134 | #else |
135 | # define SANITIZER_FUCHSIA 0 |
136 | #endif |
137 | |
138 | // Assume linux that is not glibc or android is musl libc. |
139 | #if SANITIZER_LINUX && !SANITIZER_GLIBC && !SANITIZER_ANDROID |
140 | # define SANITIZER_MUSL 1 |
141 | #else |
142 | # define SANITIZER_MUSL 0 |
143 | #endif |
144 | |
145 | #define SANITIZER_POSIX \ |
146 | (SANITIZER_FREEBSD || SANITIZER_LINUX || SANITIZER_APPLE || \ |
147 | SANITIZER_NETBSD || SANITIZER_SOLARIS || SANITIZER_HAIKU) |
148 | |
149 | #if __LP64__ || defined(_WIN64) |
150 | # define SANITIZER_WORDSIZE 64 |
151 | #else |
152 | # define SANITIZER_WORDSIZE 32 |
153 | #endif |
154 | |
155 | #if SANITIZER_WORDSIZE == 64 |
156 | # define FIRST_32_SECOND_64(a, b) (b) |
157 | #else |
158 | # define FIRST_32_SECOND_64(a, b) (a) |
159 | #endif |
160 | |
161 | #if defined(__x86_64__) && !defined(_LP64) |
162 | # define SANITIZER_X32 1 |
163 | #else |
164 | # define SANITIZER_X32 0 |
165 | #endif |
166 | |
167 | #if defined(__x86_64__) || defined(_M_X64) |
168 | # define SANITIZER_X64 1 |
169 | #else |
170 | # define SANITIZER_X64 0 |
171 | #endif |
172 | |
173 | #if defined(__i386__) || defined(_M_IX86) |
174 | # define SANITIZER_I386 1 |
175 | #else |
176 | # define SANITIZER_I386 0 |
177 | #endif |
178 | |
179 | #if defined(__mips__) |
180 | # define SANITIZER_MIPS 1 |
181 | # if defined(__mips64) && _MIPS_SIM == _ABI64 |
182 | # define SANITIZER_MIPS32 0 |
183 | # define SANITIZER_MIPS64 1 |
184 | # else |
185 | # define SANITIZER_MIPS32 1 |
186 | # define SANITIZER_MIPS64 0 |
187 | # endif |
188 | #else |
189 | # define SANITIZER_MIPS 0 |
190 | # define SANITIZER_MIPS32 0 |
191 | # define SANITIZER_MIPS64 0 |
192 | #endif |
193 | |
194 | #if defined(__s390__) |
195 | # define SANITIZER_S390 1 |
196 | # if defined(__s390x__) |
197 | # define SANITIZER_S390_31 0 |
198 | # define SANITIZER_S390_64 1 |
199 | # else |
200 | # define SANITIZER_S390_31 1 |
201 | # define SANITIZER_S390_64 0 |
202 | # endif |
203 | #else |
204 | # define SANITIZER_S390 0 |
205 | # define SANITIZER_S390_31 0 |
206 | # define SANITIZER_S390_64 0 |
207 | #endif |
208 | |
209 | #if defined(__sparc__) |
210 | # define SANITIZER_SPARC 1 |
211 | # if defined(__arch64__) |
212 | # define SANITIZER_SPARC32 0 |
213 | # define SANITIZER_SPARC64 1 |
214 | # else |
215 | # define SANITIZER_SPARC32 1 |
216 | # define SANITIZER_SPARC64 0 |
217 | # endif |
218 | #else |
219 | # define SANITIZER_SPARC 0 |
220 | # define SANITIZER_SPARC32 0 |
221 | # define SANITIZER_SPARC64 0 |
222 | #endif |
223 | |
224 | #if defined(__powerpc__) |
225 | # define SANITIZER_PPC 1 |
226 | # if defined(__powerpc64__) |
227 | # define SANITIZER_PPC32 0 |
228 | # define SANITIZER_PPC64 1 |
229 | // 64-bit PPC has two ABIs (v1 and v2). The old powerpc64 target is |
230 | // big-endian, and uses v1 ABI (known for its function descriptors), |
231 | // while the new powerpc64le target is little-endian and uses v2. |
232 | // In theory, you could convince gcc to compile for their evil twins |
233 | // (eg. big-endian v2), but you won't find such combinations in the wild |
234 | // (it'd require bootstrapping a whole system, which would be quite painful |
235 | // - there's no target triple for that). LLVM doesn't support them either. |
236 | # if _CALL_ELF == 2 |
237 | # define SANITIZER_PPC64V1 0 |
238 | # define SANITIZER_PPC64V2 1 |
239 | # else |
240 | # define SANITIZER_PPC64V1 1 |
241 | # define SANITIZER_PPC64V2 0 |
242 | # endif |
243 | # else |
244 | # define SANITIZER_PPC32 1 |
245 | # define SANITIZER_PPC64 0 |
246 | # define SANITIZER_PPC64V1 0 |
247 | # define SANITIZER_PPC64V2 0 |
248 | # endif |
249 | #else |
250 | # define SANITIZER_PPC 0 |
251 | # define SANITIZER_PPC32 0 |
252 | # define SANITIZER_PPC64 0 |
253 | # define SANITIZER_PPC64V1 0 |
254 | # define SANITIZER_PPC64V2 0 |
255 | #endif |
256 | |
257 | #if defined(__arm__) || defined(_M_ARM) |
258 | # define SANITIZER_ARM 1 |
259 | #else |
260 | # define SANITIZER_ARM 0 |
261 | #endif |
262 | |
263 | #if defined(__aarch64__) || defined(_M_ARM64) |
264 | # define SANITIZER_ARM64 1 |
265 | #else |
266 | # define SANITIZER_ARM64 0 |
267 | #endif |
268 | |
269 | #if SANITIZER_WINDOWS64 && SANITIZER_ARM64 |
270 | # define SANITIZER_WINDOWS_ARM64 1 |
271 | # define SANITIZER_WINDOWS_x64 0 |
272 | #elif SANITIZER_WINDOWS64 && !SANITIZER_ARM64 |
273 | # define SANITIZER_WINDOWS_ARM64 0 |
274 | # define SANITIZER_WINDOWS_x64 1 |
275 | #else |
276 | # define SANITIZER_WINDOWS_ARM64 0 |
277 | # define SANITIZER_WINDOWS_x64 0 |
278 | #endif |
279 | |
280 | #if SANITIZER_SOLARIS && SANITIZER_WORDSIZE == 32 |
281 | # define SANITIZER_SOLARIS32 1 |
282 | #else |
283 | # define SANITIZER_SOLARIS32 0 |
284 | #endif |
285 | |
286 | #if defined(__riscv) && (__riscv_xlen == 64) |
287 | # define SANITIZER_RISCV64 1 |
288 | #else |
289 | # define SANITIZER_RISCV64 0 |
290 | #endif |
291 | |
292 | #if defined(__loongarch_lp64) |
293 | # define SANITIZER_LOONGARCH64 1 |
294 | #else |
295 | # define SANITIZER_LOONGARCH64 0 |
296 | #endif |
297 | |
298 | // By default we allow to use SizeClassAllocator64 on 64-bit platform. |
299 | // But in some cases SizeClassAllocator64 does not work well and we need to |
300 | // fallback to SizeClassAllocator32. |
301 | // For such platforms build this code with -DSANITIZER_CAN_USE_ALLOCATOR64=0 or |
302 | // change the definition of SANITIZER_CAN_USE_ALLOCATOR64 here. |
303 | #ifndef SANITIZER_CAN_USE_ALLOCATOR64 |
304 | # if (SANITIZER_RISCV64 && !SANITIZER_FUCHSIA && !SANITIZER_LINUX) || \ |
305 | SANITIZER_IOS || SANITIZER_DRIVERKIT |
306 | # define SANITIZER_CAN_USE_ALLOCATOR64 0 |
307 | # elif defined(__mips64) || defined(__hexagon__) |
308 | # define SANITIZER_CAN_USE_ALLOCATOR64 0 |
309 | # else |
310 | # define SANITIZER_CAN_USE_ALLOCATOR64 (SANITIZER_WORDSIZE == 64) |
311 | # endif |
312 | #endif |
313 | |
314 | // The range of addresses which can be returned my mmap. |
315 | // FIXME: this value should be different on different platforms. Larger values |
316 | // will still work but will consume more memory for TwoLevelByteMap. |
317 | #if defined(__mips__) |
318 | # if SANITIZER_GO && defined(__mips64) |
319 | # define SANITIZER_MMAP_RANGE_SIZE FIRST_32_SECOND_64(1ULL << 32, 1ULL << 47) |
320 | # else |
321 | # define SANITIZER_MMAP_RANGE_SIZE FIRST_32_SECOND_64(1ULL << 32, 1ULL << 40) |
322 | # endif |
323 | #elif SANITIZER_RISCV64 |
324 | // FIXME: Rather than hardcoding the VMA here, we should rely on |
325 | // GetMaxUserVirtualAddress(). This will require some refactoring though since |
326 | // many places either hardcode some value or SANITIZER_MMAP_RANGE_SIZE is |
327 | // assumed to be some constant integer. |
328 | # if SANITIZER_FUCHSIA |
329 | # define SANITIZER_MMAP_RANGE_SIZE (1ULL << 38) |
330 | # else |
331 | # define SANITIZER_MMAP_RANGE_SIZE FIRST_32_SECOND_64(1ULL << 32, 1ULL << 56) |
332 | # endif |
333 | #elif defined(__aarch64__) |
334 | # if SANITIZER_APPLE |
335 | # if SANITIZER_OSX || SANITIZER_IOSSIM |
336 | # define SANITIZER_MMAP_RANGE_SIZE \ |
337 | FIRST_32_SECOND_64(1ULL << 32, 1ULL << 47) |
338 | # else |
339 | // Darwin iOS/ARM64 has a 36-bit VMA, 64GiB VM |
340 | # define SANITIZER_MMAP_RANGE_SIZE \ |
341 | FIRST_32_SECOND_64(1ULL << 32, 1ULL << 36) |
342 | # endif |
343 | # else |
344 | # define SANITIZER_MMAP_RANGE_SIZE FIRST_32_SECOND_64(1ULL << 32, 1ULL << 48) |
345 | # endif |
346 | #elif defined(__sparc__) |
347 | # define SANITIZER_MMAP_RANGE_SIZE FIRST_32_SECOND_64(1ULL << 32, 1ULL << 52) |
348 | #else |
349 | # define SANITIZER_MMAP_RANGE_SIZE FIRST_32_SECOND_64(1ULL << 32, 1ULL << 47) |
350 | #endif |
351 | |
352 | // Whether the addresses are sign-extended from the VMA range to the word. |
353 | // The SPARC64 Linux port implements this to split the VMA space into two |
354 | // non-contiguous halves with a huge hole in the middle. |
355 | #if defined(__sparc__) && SANITIZER_WORDSIZE == 64 |
356 | # define SANITIZER_SIGN_EXTENDED_ADDRESSES 1 |
357 | #else |
358 | # define SANITIZER_SIGN_EXTENDED_ADDRESSES 0 |
359 | #endif |
360 | |
361 | // udi16 syscalls can only be used when the following conditions are |
362 | // met: |
363 | // * target is one of arm32, x86-32, sparc32, sh or m68k |
364 | // * libc version is libc5, glibc-2.0, glibc-2.1 or glibc-2.2 to 2.15 |
365 | // built against > linux-2.2 kernel headers |
366 | // Since we don't want to include libc headers here, we check the |
367 | // target only. |
368 | #if defined(__arm__) || SANITIZER_X32 || defined(__sparc__) |
369 | # define SANITIZER_USES_UID16_SYSCALLS 1 |
370 | #else |
371 | # define SANITIZER_USES_UID16_SYSCALLS 0 |
372 | #endif |
373 | |
374 | #if defined(__mips__) |
375 | # define SANITIZER_POINTER_FORMAT_LENGTH FIRST_32_SECOND_64(8, 10) |
376 | #else |
377 | # define SANITIZER_POINTER_FORMAT_LENGTH FIRST_32_SECOND_64(8, 12) |
378 | #endif |
379 | |
380 | /// \macro MSC_PREREQ |
381 | /// \brief Is the compiler MSVC of at least the specified version? |
382 | /// The common \param version values to check for are: |
383 | /// * 1800: Microsoft Visual Studio 2013 / 12.0 |
384 | /// * 1900: Microsoft Visual Studio 2015 / 14.0 |
385 | #ifdef _MSC_VER |
386 | # define MSC_PREREQ(version) (_MSC_VER >= (version)) |
387 | #else |
388 | # define MSC_PREREQ(version) 0 |
389 | #endif |
390 | |
391 | #if SANITIZER_APPLE && defined(__x86_64__) |
392 | # define SANITIZER_NON_UNIQUE_TYPEINFO 0 |
393 | #else |
394 | # define SANITIZER_NON_UNIQUE_TYPEINFO 1 |
395 | #endif |
396 | |
397 | // On linux, some architectures had an ABI transition from 64-bit long double |
398 | // (ie. same as double) to 128-bit long double. On those, glibc symbols |
399 | // involving long doubles come in two versions, and we need to pass the |
400 | // correct one to dlvsym when intercepting them. |
401 | #if SANITIZER_LINUX && (SANITIZER_S390 || SANITIZER_PPC32 || SANITIZER_PPC64V1) |
402 | # define SANITIZER_NLDBL_VERSION "GLIBC_2.4" |
403 | #endif |
404 | |
405 | #if SANITIZER_GO == 0 |
406 | # define SANITIZER_GO 0 |
407 | #endif |
408 | |
409 | // On PowerPC and ARM Thumb, calling pthread_exit() causes LSan to detect leaks. |
410 | // pthread_exit() performs unwinding that leads to dlopen'ing libgcc_s.so. |
411 | // dlopen mallocs "libgcc_s.so" string which confuses LSan, it fails to realize |
412 | // that this allocation happens in dynamic linker and should be ignored. |
413 | #if SANITIZER_PPC || defined(__thumb__) |
414 | # define SANITIZER_SUPPRESS_LEAK_ON_PTHREAD_EXIT 1 |
415 | #else |
416 | # define SANITIZER_SUPPRESS_LEAK_ON_PTHREAD_EXIT 0 |
417 | #endif |
418 | |
419 | #if SANITIZER_FREEBSD || SANITIZER_APPLE || SANITIZER_NETBSD || \ |
420 | SANITIZER_SOLARIS || SANITIZER_HAIKU |
421 | # define SANITIZER_MADVISE_DONTNEED MADV_FREE |
422 | #else |
423 | # define SANITIZER_MADVISE_DONTNEED MADV_DONTNEED |
424 | #endif |
425 | |
426 | // Older gcc have issues aligning to a constexpr, and require an integer. |
427 | // See https://gcc.gnu.org/bugzilla/show_bug.cgi?id=56859 among others. |
428 | #if defined(__powerpc__) || defined(__powerpc64__) |
429 | # define SANITIZER_CACHE_LINE_SIZE 128 |
430 | #else |
431 | # define SANITIZER_CACHE_LINE_SIZE 64 |
432 | #endif |
433 | |
434 | // Enable offline markup symbolizer for Fuchsia. |
435 | #if SANITIZER_FUCHSIA |
436 | # define SANITIZER_SYMBOLIZER_MARKUP 1 |
437 | #else |
438 | # define SANITIZER_SYMBOLIZER_MARKUP 0 |
439 | #endif |
440 | |
441 | // Enable ability to support sanitizer initialization that is |
442 | // compatible with the sanitizer library being loaded via |
443 | // `dlopen()`. |
444 | #if SANITIZER_APPLE |
445 | # define SANITIZER_SUPPORTS_INIT_FOR_DLOPEN 1 |
446 | #else |
447 | # define SANITIZER_SUPPORTS_INIT_FOR_DLOPEN 0 |
448 | #endif |
449 | |
450 | // SANITIZER_SUPPORTS_THREADLOCAL |
451 | // 1 - THREADLOCAL macro is supported by target |
452 | // 0 - THREADLOCAL macro is not supported by target |
453 | #ifndef __has_feature |
454 | // TODO: Support other compilers here |
455 | # define SANITIZER_SUPPORTS_THREADLOCAL 1 |
456 | #else |
457 | # if __has_feature(tls) |
458 | # define SANITIZER_SUPPORTS_THREADLOCAL 1 |
459 | # else |
460 | # define SANITIZER_SUPPORTS_THREADLOCAL 0 |
461 | # endif |
462 | #endif |
463 | |
464 | #if defined(__thumb__) && defined(__linux__) |
465 | // Workaround for |
466 | // https://lab.llvm.org/buildbot/#/builders/clang-thumbv7-full-2stage |
467 | // or |
468 | // https://lab.llvm.org/staging/#/builders/clang-thumbv7-full-2stage |
469 | // It fails *rss_limit_mb_test* without meaningful errors. |
470 | # define SANITIZER_START_BACKGROUND_THREAD_IN_ASAN_INTERNAL 1 |
471 | #else |
472 | # define SANITIZER_START_BACKGROUND_THREAD_IN_ASAN_INTERNAL 0 |
473 | #endif |
474 | |
475 | #endif // SANITIZER_PLATFORM_H |
476 | |