WTF / bmalloc: don't write to 0xbbadbeef when ASAN is looking
[WebKit-https.git] / Source / bmalloc / bmalloc / BPlatform.h
1 /*
2  * Copyright (C) 2014-2017 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #pragma once
27
28 #include "BCompiler.h"
29
30 #ifdef __APPLE__
31 #include <Availability.h>
32 #include <AvailabilityMacros.h>
33 #include <TargetConditionals.h>
34 #endif
35
36 #define BPLATFORM(PLATFORM) (defined BPLATFORM_##PLATFORM && BPLATFORM_##PLATFORM)
37 #define BOS(OS) (defined BOS_##OS && BOS_##OS)
38
39 #ifdef __APPLE__
40 #define BOS_DARWIN 1
41 #endif
42
43 #ifdef __unix
44 #define BOS_UNIX 1
45 #endif
46
47 #ifdef __linux__
48 #define BOS_LINUX 1
49 #endif
50
51 #if defined(WIN32) || defined(_WIN32)
52 #define BOS_WINDOWS 1
53 #endif
54
55 #if BOS(DARWIN) && ((defined(TARGET_OS_EMBEDDED) && TARGET_OS_EMBEDDED) \
56     || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) \
57     || (defined(TARGET_IPHONE_SIMULATOR) && TARGET_IPHONE_SIMULATOR))
58 #define BPLATFORM_IOS 1
59 #if (defined(TARGET_IPHONE_SIMULATOR) && TARGET_IPHONE_SIMULATOR)
60 #define BPLATFORM_IOS_SIMULATOR 1
61 #endif
62 #elif BOS(DARWIN) && defined(TARGET_OS_MAC) && TARGET_OS_MAC
63 #define BPLATFORM_MAC 1
64 #endif
65
66 /* ==== Policy decision macros: these define policy choices for a particular port. ==== */
67
68 /* BUSE() - use a particular third-party library or optional OS service */
69 #define BUSE(FEATURE) (defined BUSE_##FEATURE && BUSE_##FEATURE)
70
71 /* ==== Compiler adaptation macros: these describe the capabilities of the compiler. ==== */
72
73 /* BCOMPILER_SUPPORTS() - check for a compiler feature */
74 #define BCOMPILER_SUPPORTS(FEATURE) (defined BCOMPILER_SUPPORTS_##FEATURE && BCOMPILER_SUPPORTS_##FEATURE)
75
76 /* BCOMPILER_SUPPORTS(NSDMI_FOR_AGGREGATES) - compiler supports non-static data member initializers for aggregates */
77 #if defined(__cpp_aggregate_nsdmi) && __cpp_aggregate_nsdmi >= 201304
78 #define BCOMPILER_SUPPORTS_NSDMI_FOR_AGGREGATES 1
79 #endif
80
81 /* ==== Platform adaptation macros: these describe properties of the target environment. ==== */
82
83 /* BCPU() - the target CPU architecture */
84 #define BCPU(_FEATURE) (defined BCPU_##_FEATURE  && BCPU_##_FEATURE)
85
86 /* BCPU(X86) - i386 / x86 32-bit */
87 #if defined(__i386__) \
88 || defined(i386)     \
89 || defined(_M_IX86)  \
90 || defined(_X86_)    \
91 || defined(__THW_INTEL)
92 #define BCPU_X86 1
93 #endif
94
95 /* BCPU(X86_64) - AMD64 / Intel64 / x86_64 64-bit */
96 #if defined(__x86_64__) \
97 || defined(_M_X64)
98 #define BCPU_X86_64 1
99 #endif
100
101 /* BCPU(ARM64) - Apple */
102 #if (defined(__arm64__) && defined(__APPLE__)) || defined(__aarch64__)
103 #define BCPU_ARM64 1
104 #endif
105
106 /* BCPU(ARM) - ARM, any version*/
107 #define BARM_ARCH_AT_LEAST(N) (BCPU(ARM) && BARM_ARCH_VERSION >= N)
108
109 #if   defined(arm) \
110 || defined(__arm__) \
111 || defined(ARM) \
112 || defined(_ARM_)
113 #define BCPU_ARM 1
114
115 /* Set BARM_ARCH_VERSION */
116 #if   defined(__ARM_ARCH_4__) \
117 || defined(__ARM_ARCH_4T__) \
118 || defined(__MARM_ARMV4__)
119 #define BARM_ARCH_VERSION 4
120
121 #elif defined(__ARM_ARCH_5__) \
122 || defined(__ARM_ARCH_5T__) \
123 || defined(__MARM_ARMV5__)
124 #define BARM_ARCH_VERSION 5
125
126 #elif defined(__ARM_ARCH_5E__) \
127 || defined(__ARM_ARCH_5TE__) \
128 || defined(__ARM_ARCH_5TEJ__)
129 #define BARM_ARCH_VERSION 5
130
131 #elif defined(__ARM_ARCH_6__) \
132 || defined(__ARM_ARCH_6J__) \
133 || defined(__ARM_ARCH_6K__) \
134 || defined(__ARM_ARCH_6Z__) \
135 || defined(__ARM_ARCH_6ZK__) \
136 || defined(__ARM_ARCH_6T2__) \
137 || defined(__ARMV6__)
138 #define BARM_ARCH_VERSION 6
139
140 #elif defined(__ARM_ARCH_7A__) \
141 || defined(__ARM_ARCH_7K__) \
142 || defined(__ARM_ARCH_7R__) \
143 || defined(__ARM_ARCH_7S__)
144 #define BARM_ARCH_VERSION 7
145
146 #elif defined(__ARM_ARCH_8__) \
147 || defined(__ARM_ARCH_8A__)
148 #define BARM_ARCH_VERSION 8
149
150 /* MSVC sets _M_ARM */
151 #elif defined(_M_ARM)
152 #define BARM_ARCH_VERSION _M_ARM
153
154 /* RVCT sets _TARGET_ARCH_ARM */
155 #elif defined(__TARGET_ARCH_ARM)
156 #define BARM_ARCH_VERSION __TARGET_ARCH_ARM
157
158 #else
159 #define WTF_ARM_ARCH_VERSION 0
160
161 #endif
162
163 /* Set BTHUMB_ARCH_VERSION */
164 #if   defined(__ARM_ARCH_4T__)
165 #define BTHUMB_ARCH_VERSION 1
166
167 #elif defined(__ARM_ARCH_5T__) \
168 || defined(__ARM_ARCH_5TE__) \
169 || defined(__ARM_ARCH_5TEJ__)
170 #define BTHUMB_ARCH_VERSION 2
171
172 #elif defined(__ARM_ARCH_6J__) \
173 || defined(__ARM_ARCH_6K__) \
174 || defined(__ARM_ARCH_6Z__) \
175 || defined(__ARM_ARCH_6ZK__) \
176 || defined(__ARM_ARCH_6M__)
177 #define BTHUMB_ARCH_VERSION 3
178
179 #elif defined(__ARM_ARCH_6T2__) \
180 || defined(__ARM_ARCH_7__) \
181 || defined(__ARM_ARCH_7A__) \
182 || defined(__ARM_ARCH_7K__) \
183 || defined(__ARM_ARCH_7M__) \
184 || defined(__ARM_ARCH_7R__) \
185 || defined(__ARM_ARCH_7S__)
186 #define BTHUMB_ARCH_VERSION 4
187
188 /* RVCT sets __TARGET_ARCH_THUMB */
189 #elif defined(__TARGET_ARCH_THUMB)
190 #define BTHUMB_ARCH_VERSION __TARGET_ARCH_THUMB
191
192 #else
193 #define BTHUMB_ARCH_VERSION 0
194 #endif
195
196 /* BCPU(ARM_TRADITIONAL) - Thumb2 is not available, only traditional ARM (v4 or greater) */
197 /* BCPU(ARM_THUMB2) - Thumb2 instruction set is available */
198 /* Only one of these will be defined. */
199 #if !defined(BCPU_ARM_TRADITIONAL) && !defined(BCPU_ARM_THUMB2)
200 #  if defined(thumb2) || defined(__thumb2__) \
201 || ((defined(__thumb) || defined(__thumb__)) && BTHUMB_ARCH_VERSION == 4)
202 #    define BCPU_ARM_TRADITIONAL 0
203 #    define BCPU_ARM_THUMB2 1
204 #  elif BARM_ARCH_AT_LEAST(4)
205 #    define BCPU_ARM_TRADITIONAL 1
206 #    define BCPU_ARM_THUMB2 0
207 #  else
208 #    error "Not supported ARM architecture"
209 #  endif
210 #elif BCPU(ARM_TRADITIONAL) && BCPU(ARM_THUMB2) /* Sanity Check */
211 #  error "Cannot use both of BCPU_ARM_TRADITIONAL and BCPU_ARM_THUMB2 platforms"
212 #endif /* !defined(BCPU_ARM_TRADITIONAL) && !defined(BCPU_ARM_THUMB2) */
213
214 #endif /* ARM */
215
216 #define BATTRIBUTE_PRINTF(formatStringArgument, extraArguments) __attribute__((__format__(printf, formatStringArgument, extraArguments)))
217
218 #if (BPLATFORM(MAC) && __MAC_OS_X_VERSION_MIN_REQUIRED >= 101200) || BPLATFORM(IOS)
219 #define BUSE_OS_LOG 1
220 #endif
221
222 /* BUNUSED_PARAM */
223 #if !defined(BUNUSED_PARAM)
224 #define BUNUSED_PARAM(variable) (void)variable
225 #endif