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__) && \
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(__APPLE__)
34 # define SANITIZER_MAC 1
35 # include <TargetConditionals.h>
37 # define SANITIZER_IOS 1
39 # define SANITIZER_IOS 0
41 # if TARGET_IPHONE_SIMULATOR
42 # define SANITIZER_IOSSIM 1
44 # define SANITIZER_IOSSIM 0
47 # define SANITIZER_MAC 0
48 # define SANITIZER_IOS 0
49 # define SANITIZER_IOSSIM 0
52 #if defined(__APPLE__) && TARGET_OS_IPHONE && TARGET_OS_WATCH
53 # define SANITIZER_WATCHOS 1
55 # define SANITIZER_WATCHOS 0
58 #if defined(__APPLE__) && TARGET_OS_IPHONE && TARGET_OS_TV
59 # define SANITIZER_TVOS 1
61 # define SANITIZER_TVOS 0
65 # define SANITIZER_WINDOWS 1
67 # define SANITIZER_WINDOWS 0
71 # define SANITIZER_WINDOWS64 1
73 # define SANITIZER_WINDOWS64 0
76 #if defined(__ANDROID__)
77 # define SANITIZER_ANDROID 1
79 # define SANITIZER_ANDROID 0
82 #define SANITIZER_POSIX (SANITIZER_FREEBSD || SANITIZER_LINUX || SANITIZER_MAC)
84 #if __LP64__ || defined(_WIN64)
85 # define SANITIZER_WORDSIZE 64
87 # define SANITIZER_WORDSIZE 32
90 #if SANITIZER_WORDSIZE == 64
91 # define FIRST_32_SECOND_64(a, b) (b)
93 # define FIRST_32_SECOND_64(a, b) (a)
96 #if defined(__x86_64__) && !defined(_LP64)
97 # define SANITIZER_X32 1
99 # define SANITIZER_X32 0
102 #if defined(__mips__)
103 # define SANITIZER_MIPS 1
104 # if defined(__mips64)
105 # define SANITIZER_MIPS32 0
106 # define SANITIZER_MIPS64 1
108 # define SANITIZER_MIPS32 1
109 # define SANITIZER_MIPS64 0
112 # define SANITIZER_MIPS 0
113 # define SANITIZER_MIPS32 0
114 # define SANITIZER_MIPS64 0
117 #if defined(__s390__)
118 # define SANITIZER_S390 1
119 # if defined(__s390x__)
120 # define SANITIZER_S390_31 0
121 # define SANITIZER_S390_64 1
123 # define SANITIZER_S390_31 1
124 # define SANITIZER_S390_64 0
127 # define SANITIZER_S390 0
128 # define SANITIZER_S390_31 0
129 # define SANITIZER_S390_64 0
132 #if defined(__powerpc__)
133 # define SANITIZER_PPC 1
134 # if defined(__powerpc64__)
135 # define SANITIZER_PPC32 0
136 # define SANITIZER_PPC64 1
137 // 64-bit PPC has two ABIs (v1 and v2). The old powerpc64 target is
138 // big-endian, and uses v1 ABI (known for its function descriptors),
139 // while the new powerpc64le target is little-endian and uses v2.
140 // In theory, you could convince gcc to compile for their evil twins
141 // (eg. big-endian v2), but you won't find such combinations in the wild
142 // (it'd require bootstrapping a whole system, which would be quite painful
143 // - there's no target triple for that). LLVM doesn't support them either.
145 # define SANITIZER_PPC64V1 0
146 # define SANITIZER_PPC64V2 1
148 # define SANITIZER_PPC64V1 1
149 # define SANITIZER_PPC64V2 0
152 # define SANITIZER_PPC32 1
153 # define SANITIZER_PPC64 0
154 # define SANITIZER_PPC64V1 0
155 # define SANITIZER_PPC64V2 0
158 # define SANITIZER_PPC 0
159 # define SANITIZER_PPC32 0
160 # define SANITIZER_PPC64 0
161 # define SANITIZER_PPC64V1 0
162 # define SANITIZER_PPC64V2 0
166 # define SANITIZER_ARM 1
168 # define SANITIZER_ARM 0
171 // By default we allow to use SizeClassAllocator64 on 64-bit platform.
172 // But in some cases (e.g. AArch64's 39-bit address space) SizeClassAllocator64
173 // does not work well and we need to fallback to SizeClassAllocator32.
174 // For such platforms build this code with -DSANITIZER_CAN_USE_ALLOCATOR64=0 or
175 // change the definition of SANITIZER_CAN_USE_ALLOCATOR64 here.
176 #ifndef SANITIZER_CAN_USE_ALLOCATOR64
177 # if SANITIZER_ANDROID && defined(__aarch64__)
178 # define SANITIZER_CAN_USE_ALLOCATOR64 1
179 # elif defined(__mips64) || defined(__aarch64__)
180 # define SANITIZER_CAN_USE_ALLOCATOR64 0
182 # define SANITIZER_CAN_USE_ALLOCATOR64 (SANITIZER_WORDSIZE == 64)
186 // The range of addresses which can be returned my mmap.
187 // FIXME: this value should be different on different platforms. Larger values
188 // will still work but will consume more memory for TwoLevelByteMap.
189 #if defined(__mips__)
190 # define SANITIZER_MMAP_RANGE_SIZE FIRST_32_SECOND_64(1ULL << 32, 1ULL << 40)
191 #elif defined(__aarch64__)
192 # define SANITIZER_MMAP_RANGE_SIZE FIRST_32_SECOND_64(1ULL << 32, 1ULL << 48)
194 # define SANITIZER_MMAP_RANGE_SIZE FIRST_32_SECOND_64(1ULL << 32, 1ULL << 47)
197 // The AArch64 linux port uses the canonical syscall set as mandated by
198 // the upstream linux community for all new ports. Other ports may still
199 // use legacy syscalls.
200 #ifndef SANITIZER_USES_CANONICAL_LINUX_SYSCALLS
201 # if defined(__aarch64__) && SANITIZER_LINUX
202 # define SANITIZER_USES_CANONICAL_LINUX_SYSCALLS 1
204 # define SANITIZER_USES_CANONICAL_LINUX_SYSCALLS 0
208 // udi16 syscalls can only be used when the following conditions are
210 // * target is one of arm32, x86-32, sparc32, sh or m68k
211 // * libc version is libc5, glibc-2.0, glibc-2.1 or glibc-2.2 to 2.15
212 // built against > linux-2.2 kernel headers
213 // Since we don't want to include libc headers here, we check the
215 #if defined(__arm__) || SANITIZER_X32 || defined(__sparc__)
216 #define SANITIZER_USES_UID16_SYSCALLS 1
218 #define SANITIZER_USES_UID16_SYSCALLS 0
221 #if defined(__mips__)
222 # define SANITIZER_POINTER_FORMAT_LENGTH FIRST_32_SECOND_64(8, 10)
224 # define SANITIZER_POINTER_FORMAT_LENGTH FIRST_32_SECOND_64(8, 12)
227 // Assume obsolete RPC headers are available by default
228 #if !defined(HAVE_RPC_XDR_H) && !defined(HAVE_TIRPC_RPC_XDR_H)
229 # define HAVE_RPC_XDR_H (SANITIZER_LINUX && !SANITIZER_ANDROID)
230 # define HAVE_TIRPC_RPC_XDR_H 0
233 /// \macro MSC_PREREQ
234 /// \brief Is the compiler MSVC of at least the specified version?
235 /// The common \param version values to check for are:
236 /// * 1800: Microsoft Visual Studio 2013 / 12.0
237 /// * 1900: Microsoft Visual Studio 2015 / 14.0
239 # define MSC_PREREQ(version) (_MSC_VER >= (version))
241 # define MSC_PREREQ(version) 0
244 #if defined(__arm64__) && SANITIZER_IOS
245 # define SANITIZER_NON_UNIQUE_TYPEINFO 1
247 # define SANITIZER_NON_UNIQUE_TYPEINFO 0
250 // On linux, some architectures had an ABI transition from 64-bit long double
251 // (ie. same as double) to 128-bit long double. On those, glibc symbols
252 // involving long doubles come in two versions, and we need to pass the
253 // correct one to dlvsym when intercepting them.
254 #if SANITIZER_LINUX && (SANITIZER_S390 || SANITIZER_PPC32 || SANITIZER_PPC64V1)
255 #define SANITIZER_NLDBL_VERSION "GLIBC_2.4"
258 #if SANITIZER_GO == 0
259 # define SANITIZER_GO 0
262 // On PowerPC and ARM Thumb, calling pthread_exit() causes LSan to detect leaks.
263 // pthread_exit() performs unwinding that leads to dlopen'ing libgcc_s.so.
264 // dlopen mallocs "libgcc_s.so" string which confuses LSan, it fails to realize
265 // that this allocation happens in dynamic linker and should be ignored.
266 #if SANITIZER_PPC || defined(__thumb__)
267 # define SANITIZER_SUPPRESS_LEAK_ON_PTHREAD_EXIT 1
269 # define SANITIZER_SUPPRESS_LEAK_ON_PTHREAD_EXIT 0
273 #endif // SANITIZER_PLATFORM_H