1 //===-- sanitizer_platform.h ------------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // Common platform macros.
11 //===----------------------------------------------------------------------===//
13 #ifndef SANITIZER_PLATFORM_H
14 #define SANITIZER_PLATFORM_H
16 #if !defined(__linux__) && !defined(__FreeBSD__) && !defined(__NetBSD__) && \
17 !defined(__APPLE__) && !defined(_WIN32) && !defined(__Fuchsia__) && \
18 !(defined(__sun__) && defined(__svr4__))
19 # error "This operating system is not supported"
22 #if defined(__linux__)
23 # define SANITIZER_LINUX 1
25 # define SANITIZER_LINUX 0
28 #if defined(__FreeBSD__)
29 # define SANITIZER_FREEBSD 1
31 # define SANITIZER_FREEBSD 0
34 #if defined(__NetBSD__)
35 # define SANITIZER_NETBSD 1
37 # define SANITIZER_NETBSD 0
40 #if defined(__sun__) && defined(__svr4__)
41 # define SANITIZER_SOLARIS 1
43 # define SANITIZER_SOLARIS 0
46 #if defined(__APPLE__)
47 # define SANITIZER_MAC 1
48 # include <TargetConditionals.h>
50 # define SANITIZER_IOS 1
52 # define SANITIZER_IOS 0
54 # if TARGET_OS_SIMULATOR
55 # define SANITIZER_IOSSIM 1
57 # define SANITIZER_IOSSIM 0
60 # define SANITIZER_MAC 0
61 # define SANITIZER_IOS 0
62 # define SANITIZER_IOSSIM 0
65 #if defined(__APPLE__) && TARGET_OS_IPHONE && TARGET_OS_WATCH
66 # define SANITIZER_WATCHOS 1
68 # define SANITIZER_WATCHOS 0
71 #if defined(__APPLE__) && TARGET_OS_IPHONE && TARGET_OS_TV
72 # define SANITIZER_TVOS 1
74 # define SANITIZER_TVOS 0
78 # define SANITIZER_WINDOWS 1
80 # define SANITIZER_WINDOWS 0
84 # define SANITIZER_WINDOWS64 1
86 # define SANITIZER_WINDOWS64 0
89 #if defined(__ANDROID__)
90 # define SANITIZER_ANDROID 1
92 # define SANITIZER_ANDROID 0
95 #if defined(__Fuchsia__)
96 # define SANITIZER_FUCHSIA 1
98 # define SANITIZER_FUCHSIA 0
101 #define SANITIZER_POSIX \
102 (SANITIZER_FREEBSD || SANITIZER_LINUX || SANITIZER_MAC || \
103 SANITIZER_NETBSD || SANITIZER_SOLARIS)
105 #if __LP64__ || defined(_WIN64)
106 # define SANITIZER_WORDSIZE 64
108 # define SANITIZER_WORDSIZE 32
111 #if SANITIZER_WORDSIZE == 64
112 # define FIRST_32_SECOND_64(a, b) (b)
114 # define FIRST_32_SECOND_64(a, b) (a)
117 #if defined(__x86_64__) && !defined(_LP64)
118 # define SANITIZER_X32 1
120 # define SANITIZER_X32 0
123 #if defined(__mips__)
124 # define SANITIZER_MIPS 1
125 # if defined(__mips64)
126 # define SANITIZER_MIPS32 0
127 # define SANITIZER_MIPS64 1
129 # define SANITIZER_MIPS32 1
130 # define SANITIZER_MIPS64 0
133 # define SANITIZER_MIPS 0
134 # define SANITIZER_MIPS32 0
135 # define SANITIZER_MIPS64 0
138 #if defined(__s390__)
139 # define SANITIZER_S390 1
140 # if defined(__s390x__)
141 # define SANITIZER_S390_31 0
142 # define SANITIZER_S390_64 1
144 # define SANITIZER_S390_31 1
145 # define SANITIZER_S390_64 0
148 # define SANITIZER_S390 0
149 # define SANITIZER_S390_31 0
150 # define SANITIZER_S390_64 0
153 #if defined(__powerpc__)
154 # define SANITIZER_PPC 1
155 # if defined(__powerpc64__)
156 # define SANITIZER_PPC32 0
157 # define SANITIZER_PPC64 1
158 // 64-bit PPC has two ABIs (v1 and v2). The old powerpc64 target is
159 // big-endian, and uses v1 ABI (known for its function descriptors),
160 // while the new powerpc64le target is little-endian and uses v2.
161 // In theory, you could convince gcc to compile for their evil twins
162 // (eg. big-endian v2), but you won't find such combinations in the wild
163 // (it'd require bootstrapping a whole system, which would be quite painful
164 // - there's no target triple for that). LLVM doesn't support them either.
166 # define SANITIZER_PPC64V1 0
167 # define SANITIZER_PPC64V2 1
169 # define SANITIZER_PPC64V1 1
170 # define SANITIZER_PPC64V2 0
173 # define SANITIZER_PPC32 1
174 # define SANITIZER_PPC64 0
175 # define SANITIZER_PPC64V1 0
176 # define SANITIZER_PPC64V2 0
179 # define SANITIZER_PPC 0
180 # define SANITIZER_PPC32 0
181 # define SANITIZER_PPC64 0
182 # define SANITIZER_PPC64V1 0
183 # define SANITIZER_PPC64V2 0
187 # define SANITIZER_ARM 1
189 # define SANITIZER_ARM 0
192 #if SANITIZER_SOLARIS && SANITIZER_WORDSIZE == 32
193 # define SANITIZER_SOLARIS32 1
195 # define SANITIZER_SOLARIS32 0
198 // By default we allow to use SizeClassAllocator64 on 64-bit platform.
199 // But in some cases (e.g. AArch64's 39-bit address space) SizeClassAllocator64
200 // does not work well and we need to fallback to SizeClassAllocator32.
201 // For such platforms build this code with -DSANITIZER_CAN_USE_ALLOCATOR64=0 or
202 // change the definition of SANITIZER_CAN_USE_ALLOCATOR64 here.
203 #ifndef SANITIZER_CAN_USE_ALLOCATOR64
204 # if (SANITIZER_ANDROID && defined(__aarch64__)) || SANITIZER_FUCHSIA
205 # define SANITIZER_CAN_USE_ALLOCATOR64 1
206 # elif defined(__mips64) || defined(__aarch64__)
207 # define SANITIZER_CAN_USE_ALLOCATOR64 0
209 # define SANITIZER_CAN_USE_ALLOCATOR64 (SANITIZER_WORDSIZE == 64)
213 // The range of addresses which can be returned my mmap.
214 // FIXME: this value should be different on different platforms. Larger values
215 // will still work but will consume more memory for TwoLevelByteMap.
216 #if defined(__mips__)
217 # define SANITIZER_MMAP_RANGE_SIZE FIRST_32_SECOND_64(1ULL << 32, 1ULL << 40)
218 #elif defined(__aarch64__)
219 # define SANITIZER_MMAP_RANGE_SIZE FIRST_32_SECOND_64(1ULL << 32, 1ULL << 48)
221 # define SANITIZER_MMAP_RANGE_SIZE FIRST_32_SECOND_64(1ULL << 32, 1ULL << 47)
224 // The AArch64 linux port uses the canonical syscall set as mandated by
225 // the upstream linux community for all new ports. Other ports may still
226 // use legacy syscalls.
227 #ifndef SANITIZER_USES_CANONICAL_LINUX_SYSCALLS
228 # if defined(__aarch64__) && SANITIZER_LINUX
229 # define SANITIZER_USES_CANONICAL_LINUX_SYSCALLS 1
231 # define SANITIZER_USES_CANONICAL_LINUX_SYSCALLS 0
235 // udi16 syscalls can only be used when the following conditions are
237 // * target is one of arm32, x86-32, sparc32, sh or m68k
238 // * libc version is libc5, glibc-2.0, glibc-2.1 or glibc-2.2 to 2.15
239 // built against > linux-2.2 kernel headers
240 // Since we don't want to include libc headers here, we check the
242 #if defined(__arm__) || SANITIZER_X32 || defined(__sparc__)
243 #define SANITIZER_USES_UID16_SYSCALLS 1
245 #define SANITIZER_USES_UID16_SYSCALLS 0
248 #if defined(__mips__)
249 # define SANITIZER_POINTER_FORMAT_LENGTH FIRST_32_SECOND_64(8, 10)
251 # define SANITIZER_POINTER_FORMAT_LENGTH FIRST_32_SECOND_64(8, 12)
254 // Assume obsolete RPC headers are available by default
255 #if !defined(HAVE_RPC_XDR_H) && !defined(HAVE_TIRPC_RPC_XDR_H)
256 # define HAVE_RPC_XDR_H (SANITIZER_LINUX && !SANITIZER_ANDROID)
257 # define HAVE_TIRPC_RPC_XDR_H 0
260 /// \macro MSC_PREREQ
261 /// \brief Is the compiler MSVC of at least the specified version?
262 /// The common \param version values to check for are:
263 /// * 1800: Microsoft Visual Studio 2013 / 12.0
264 /// * 1900: Microsoft Visual Studio 2015 / 14.0
266 # define MSC_PREREQ(version) (_MSC_VER >= (version))
268 # define MSC_PREREQ(version) 0
271 #if defined(__arm64__) && SANITIZER_IOS
272 # define SANITIZER_NON_UNIQUE_TYPEINFO 1
274 # define SANITIZER_NON_UNIQUE_TYPEINFO 0
277 // On linux, some architectures had an ABI transition from 64-bit long double
278 // (ie. same as double) to 128-bit long double. On those, glibc symbols
279 // involving long doubles come in two versions, and we need to pass the
280 // correct one to dlvsym when intercepting them.
281 #if SANITIZER_LINUX && (SANITIZER_S390 || SANITIZER_PPC32 || SANITIZER_PPC64V1)
282 #define SANITIZER_NLDBL_VERSION "GLIBC_2.4"
285 #if SANITIZER_GO == 0
286 # define SANITIZER_GO 0
289 // On PowerPC and ARM Thumb, calling pthread_exit() causes LSan to detect leaks.
290 // pthread_exit() performs unwinding that leads to dlopen'ing libgcc_s.so.
291 // dlopen mallocs "libgcc_s.so" string which confuses LSan, it fails to realize
292 // that this allocation happens in dynamic linker and should be ignored.
293 #if SANITIZER_PPC || defined(__thumb__)
294 # define SANITIZER_SUPPRESS_LEAK_ON_PTHREAD_EXIT 1
296 # define SANITIZER_SUPPRESS_LEAK_ON_PTHREAD_EXIT 0
299 #if SANITIZER_FREEBSD || SANITIZER_MAC || SANITIZER_NETBSD || SANITIZER_SOLARIS
300 # define SANITIZER_MADVISE_DONTNEED MADV_FREE
302 # define SANITIZER_MADVISE_DONTNEED MADV_DONTNEED
305 #endif // SANITIZER_PLATFORM_H