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)
18 # error "This operating system is not supported"
21 #if defined(__linux__)
22 # define SANITIZER_LINUX 1
24 # define SANITIZER_LINUX 0
27 #if defined(__FreeBSD__)
28 # define SANITIZER_FREEBSD 1
30 # define SANITIZER_FREEBSD 0
33 #if defined(__NetBSD__)
34 # define SANITIZER_NETBSD 1
36 # define SANITIZER_NETBSD 0
39 #if defined(__APPLE__)
40 # define SANITIZER_MAC 1
41 # include <TargetConditionals.h>
43 # define SANITIZER_IOS 1
45 # define SANITIZER_IOS 0
47 # if TARGET_IPHONE_SIMULATOR
48 # define SANITIZER_IOSSIM 1
50 # define SANITIZER_IOSSIM 0
53 # define SANITIZER_MAC 0
54 # define SANITIZER_IOS 0
55 # define SANITIZER_IOSSIM 0
58 #if defined(__APPLE__) && TARGET_OS_IPHONE && TARGET_OS_WATCH
59 # define SANITIZER_WATCHOS 1
61 # define SANITIZER_WATCHOS 0
64 #if defined(__APPLE__) && TARGET_OS_IPHONE && TARGET_OS_TV
65 # define SANITIZER_TVOS 1
67 # define SANITIZER_TVOS 0
71 # define SANITIZER_WINDOWS 1
73 # define SANITIZER_WINDOWS 0
77 # define SANITIZER_WINDOWS64 1
79 # define SANITIZER_WINDOWS64 0
82 #if defined(__ANDROID__)
83 # define SANITIZER_ANDROID 1
85 # define SANITIZER_ANDROID 0
88 #define SANITIZER_POSIX \
89 (SANITIZER_FREEBSD || SANITIZER_LINUX || SANITIZER_MAC || SANITIZER_NETBSD)
91 #if __LP64__ || defined(_WIN64)
92 # define SANITIZER_WORDSIZE 64
94 # define SANITIZER_WORDSIZE 32
97 #if SANITIZER_WORDSIZE == 64
98 # define FIRST_32_SECOND_64(a, b) (b)
100 # define FIRST_32_SECOND_64(a, b) (a)
103 #if defined(__x86_64__) && !defined(_LP64)
104 # define SANITIZER_X32 1
106 # define SANITIZER_X32 0
109 #if defined(__mips__)
110 # define SANITIZER_MIPS 1
111 # if defined(__mips64)
112 # define SANITIZER_MIPS32 0
113 # define SANITIZER_MIPS64 1
115 # define SANITIZER_MIPS32 1
116 # define SANITIZER_MIPS64 0
119 # define SANITIZER_MIPS 0
120 # define SANITIZER_MIPS32 0
121 # define SANITIZER_MIPS64 0
124 #if defined(__s390__)
125 # define SANITIZER_S390 1
126 # if defined(__s390x__)
127 # define SANITIZER_S390_31 0
128 # define SANITIZER_S390_64 1
130 # define SANITIZER_S390_31 1
131 # define SANITIZER_S390_64 0
134 # define SANITIZER_S390 0
135 # define SANITIZER_S390_31 0
136 # define SANITIZER_S390_64 0
139 #if defined(__powerpc__)
140 # define SANITIZER_PPC 1
141 # if defined(__powerpc64__)
142 # define SANITIZER_PPC32 0
143 # define SANITIZER_PPC64 1
144 // 64-bit PPC has two ABIs (v1 and v2). The old powerpc64 target is
145 // big-endian, and uses v1 ABI (known for its function descriptors),
146 // while the new powerpc64le target is little-endian and uses v2.
147 // In theory, you could convince gcc to compile for their evil twins
148 // (eg. big-endian v2), but you won't find such combinations in the wild
149 // (it'd require bootstrapping a whole system, which would be quite painful
150 // - there's no target triple for that). LLVM doesn't support them either.
152 # define SANITIZER_PPC64V1 0
153 # define SANITIZER_PPC64V2 1
155 # define SANITIZER_PPC64V1 1
156 # define SANITIZER_PPC64V2 0
159 # define SANITIZER_PPC32 1
160 # define SANITIZER_PPC64 0
161 # define SANITIZER_PPC64V1 0
162 # define SANITIZER_PPC64V2 0
165 # define SANITIZER_PPC 0
166 # define SANITIZER_PPC32 0
167 # define SANITIZER_PPC64 0
168 # define SANITIZER_PPC64V1 0
169 # define SANITIZER_PPC64V2 0
173 # define SANITIZER_ARM 1
175 # define SANITIZER_ARM 0
178 // By default we allow to use SizeClassAllocator64 on 64-bit platform.
179 // But in some cases (e.g. AArch64's 39-bit address space) SizeClassAllocator64
180 // does not work well and we need to fallback to SizeClassAllocator32.
181 // For such platforms build this code with -DSANITIZER_CAN_USE_ALLOCATOR64=0 or
182 // change the definition of SANITIZER_CAN_USE_ALLOCATOR64 here.
183 #ifndef SANITIZER_CAN_USE_ALLOCATOR64
184 # if SANITIZER_ANDROID && defined(__aarch64__)
185 # define SANITIZER_CAN_USE_ALLOCATOR64 1
186 # elif defined(__mips64) || defined(__aarch64__)
187 # define SANITIZER_CAN_USE_ALLOCATOR64 0
189 # define SANITIZER_CAN_USE_ALLOCATOR64 (SANITIZER_WORDSIZE == 64)
193 // The range of addresses which can be returned my mmap.
194 // FIXME: this value should be different on different platforms. Larger values
195 // will still work but will consume more memory for TwoLevelByteMap.
196 #if defined(__mips__)
197 # define SANITIZER_MMAP_RANGE_SIZE FIRST_32_SECOND_64(1ULL << 32, 1ULL << 40)
198 #elif defined(__aarch64__)
199 # define SANITIZER_MMAP_RANGE_SIZE FIRST_32_SECOND_64(1ULL << 32, 1ULL << 48)
201 # define SANITIZER_MMAP_RANGE_SIZE FIRST_32_SECOND_64(1ULL << 32, 1ULL << 47)
204 // The AArch64 linux port uses the canonical syscall set as mandated by
205 // the upstream linux community for all new ports. Other ports may still
206 // use legacy syscalls.
207 #ifndef SANITIZER_USES_CANONICAL_LINUX_SYSCALLS
208 # if defined(__aarch64__) && SANITIZER_LINUX
209 # define SANITIZER_USES_CANONICAL_LINUX_SYSCALLS 1
211 # define SANITIZER_USES_CANONICAL_LINUX_SYSCALLS 0
215 // udi16 syscalls can only be used when the following conditions are
217 // * target is one of arm32, x86-32, sparc32, sh or m68k
218 // * libc version is libc5, glibc-2.0, glibc-2.1 or glibc-2.2 to 2.15
219 // built against > linux-2.2 kernel headers
220 // Since we don't want to include libc headers here, we check the
222 #if defined(__arm__) || SANITIZER_X32 || defined(__sparc__)
223 #define SANITIZER_USES_UID16_SYSCALLS 1
225 #define SANITIZER_USES_UID16_SYSCALLS 0
228 #if defined(__mips__)
229 # define SANITIZER_POINTER_FORMAT_LENGTH FIRST_32_SECOND_64(8, 10)
231 # define SANITIZER_POINTER_FORMAT_LENGTH FIRST_32_SECOND_64(8, 12)
234 // Assume obsolete RPC headers are available by default
235 #if !defined(HAVE_RPC_XDR_H) && !defined(HAVE_TIRPC_RPC_XDR_H)
236 # define HAVE_RPC_XDR_H (SANITIZER_LINUX && !SANITIZER_ANDROID)
237 # define HAVE_TIRPC_RPC_XDR_H 0
240 /// \macro MSC_PREREQ
241 /// \brief Is the compiler MSVC of at least the specified version?
242 /// The common \param version values to check for are:
243 /// * 1800: Microsoft Visual Studio 2013 / 12.0
244 /// * 1900: Microsoft Visual Studio 2015 / 14.0
246 # define MSC_PREREQ(version) (_MSC_VER >= (version))
248 # define MSC_PREREQ(version) 0
251 #if defined(__arm64__) && SANITIZER_IOS
252 # define SANITIZER_NON_UNIQUE_TYPEINFO 1
254 # define SANITIZER_NON_UNIQUE_TYPEINFO 0
257 // On linux, some architectures had an ABI transition from 64-bit long double
258 // (ie. same as double) to 128-bit long double. On those, glibc symbols
259 // involving long doubles come in two versions, and we need to pass the
260 // correct one to dlvsym when intercepting them.
261 #if SANITIZER_LINUX && (SANITIZER_S390 || SANITIZER_PPC32 || SANITIZER_PPC64V1)
262 #define SANITIZER_NLDBL_VERSION "GLIBC_2.4"
265 #if SANITIZER_GO == 0
266 # define SANITIZER_GO 0
269 // On PowerPC and ARM Thumb, calling pthread_exit() causes LSan to detect leaks.
270 // pthread_exit() performs unwinding that leads to dlopen'ing libgcc_s.so.
271 // dlopen mallocs "libgcc_s.so" string which confuses LSan, it fails to realize
272 // that this allocation happens in dynamic linker and should be ignored.
273 #if SANITIZER_PPC || defined(__thumb__)
274 # define SANITIZER_SUPPRESS_LEAK_ON_PTHREAD_EXIT 1
276 # define SANITIZER_SUPPRESS_LEAK_ON_PTHREAD_EXIT 0
280 #endif // SANITIZER_PLATFORM_H