Wasm: Any function argument of type Void should be a validation error
[WebKit-https.git] / Source / bmalloc / bmalloc / BPlatform.h
1 /*
2  * Copyright (C) 2014-2018 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(BUILDING_WITH_CMAKE)
56 #if TARGET_OS_IPHONE
57 #define BPLATFORM_IOS 1
58 #if TARGET_OS_SIMULATOR
59 #define BPLATFORM_IOS_SIMULATOR 1
60 #endif
61 #elif TARGET_OS_MAC
62 #define BPLATFORM_MAC 1
63 #endif
64 #endif
65
66 #if BPLATFORM(MAC) || BPLATFORM(IOS)
67 #define BPLATFORM_COCOA 1
68 #endif
69
70 #if defined(TARGET_OS_WATCH) && TARGET_OS_WATCH
71 #define BPLATFORM_WATCHOS 1
72 #endif
73
74 #if defined(TARGET_OS_TV) && TARGET_OS_TV
75 #define BPLATFORM_APPLETV 1
76 #endif
77
78 /* ==== Policy decision macros: these define policy choices for a particular port. ==== */
79
80 /* BUSE() - use a particular third-party library or optional OS service */
81 #define BUSE(FEATURE) (defined BUSE_##FEATURE && BUSE_##FEATURE)
82
83 /* ==== Compiler adaptation macros: these describe the capabilities of the compiler. ==== */
84
85 /* BCOMPILER_SUPPORTS() - check for a compiler feature */
86 #define BCOMPILER_SUPPORTS(FEATURE) (defined BCOMPILER_SUPPORTS_##FEATURE && BCOMPILER_SUPPORTS_##FEATURE)
87
88 /* ==== Platform adaptation macros: these describe properties of the target environment. ==== */
89
90 /* BCPU() - the target CPU architecture */
91 #define BCPU(_FEATURE) (defined BCPU_##_FEATURE  && BCPU_##_FEATURE)
92
93 /* BCPU(X86) - i386 / x86 32-bit */
94 #if defined(__i386__) \
95 || defined(i386)     \
96 || defined(_M_IX86)  \
97 || defined(_X86_)    \
98 || defined(__THW_INTEL)
99 #define BCPU_X86 1
100 #endif
101
102 /* BCPU(X86_64) - AMD64 / Intel64 / x86_64 64-bit */
103 #if defined(__x86_64__) \
104 || defined(_M_X64)
105 #define BCPU_X86_64 1
106 #endif
107
108 /* BCPU(ARM64) - Apple */
109 #if (defined(__arm64__) && defined(__APPLE__)) || defined(__aarch64__)
110 #define BCPU_ARM64 1
111 #endif
112
113 /* BCPU(ARM) - ARM, any version*/
114 #define BARM_ARCH_AT_LEAST(N) (BCPU(ARM) && BARM_ARCH_VERSION >= N)
115
116 #if   defined(arm) \
117 || defined(__arm__) \
118 || defined(ARM) \
119 || defined(_ARM_)
120 #define BCPU_ARM 1
121
122 /* Set BARM_ARCH_VERSION */
123 #if   defined(__ARM_ARCH_4__) \
124 || defined(__ARM_ARCH_4T__) \
125 || defined(__MARM_ARMV4__)
126 #define BARM_ARCH_VERSION 4
127
128 #elif defined(__ARM_ARCH_5__) \
129 || defined(__ARM_ARCH_5T__) \
130 || defined(__MARM_ARMV5__)
131 #define BARM_ARCH_VERSION 5
132
133 #elif defined(__ARM_ARCH_5E__) \
134 || defined(__ARM_ARCH_5TE__) \
135 || defined(__ARM_ARCH_5TEJ__)
136 #define BARM_ARCH_VERSION 5
137
138 #elif defined(__ARM_ARCH_6__) \
139 || defined(__ARM_ARCH_6J__) \
140 || defined(__ARM_ARCH_6K__) \
141 || defined(__ARM_ARCH_6Z__) \
142 || defined(__ARM_ARCH_6ZK__) \
143 || defined(__ARM_ARCH_6T2__) \
144 || defined(__ARMV6__)
145 #define BARM_ARCH_VERSION 6
146
147 #elif defined(__ARM_ARCH_7A__) \
148 || defined(__ARM_ARCH_7K__) \
149 || defined(__ARM_ARCH_7R__) \
150 || defined(__ARM_ARCH_7S__)
151 #define BARM_ARCH_VERSION 7
152
153 #elif defined(__ARM_ARCH_8__) \
154 || defined(__ARM_ARCH_8A__)
155 #define BARM_ARCH_VERSION 8
156
157 /* MSVC sets _M_ARM */
158 #elif defined(_M_ARM)
159 #define BARM_ARCH_VERSION _M_ARM
160
161 /* RVCT sets _TARGET_ARCH_ARM */
162 #elif defined(__TARGET_ARCH_ARM)
163 #define BARM_ARCH_VERSION __TARGET_ARCH_ARM
164
165 #else
166 #define WTF_ARM_ARCH_VERSION 0
167
168 #endif
169
170 /* Set BTHUMB_ARCH_VERSION */
171 #if   defined(__ARM_ARCH_4T__)
172 #define BTHUMB_ARCH_VERSION 1
173
174 #elif defined(__ARM_ARCH_5T__) \
175 || defined(__ARM_ARCH_5TE__) \
176 || defined(__ARM_ARCH_5TEJ__)
177 #define BTHUMB_ARCH_VERSION 2
178
179 #elif defined(__ARM_ARCH_6J__) \
180 || defined(__ARM_ARCH_6K__) \
181 || defined(__ARM_ARCH_6Z__) \
182 || defined(__ARM_ARCH_6ZK__) \
183 || defined(__ARM_ARCH_6M__)
184 #define BTHUMB_ARCH_VERSION 3
185
186 #elif defined(__ARM_ARCH_6T2__) \
187 || defined(__ARM_ARCH_7__) \
188 || defined(__ARM_ARCH_7A__) \
189 || defined(__ARM_ARCH_7K__) \
190 || defined(__ARM_ARCH_7M__) \
191 || defined(__ARM_ARCH_7R__) \
192 || defined(__ARM_ARCH_7S__)
193 #define BTHUMB_ARCH_VERSION 4
194
195 /* RVCT sets __TARGET_ARCH_THUMB */
196 #elif defined(__TARGET_ARCH_THUMB)
197 #define BTHUMB_ARCH_VERSION __TARGET_ARCH_THUMB
198
199 #else
200 #define BTHUMB_ARCH_VERSION 0
201 #endif
202
203 /* BCPU(ARM_TRADITIONAL) - Thumb2 is not available, only traditional ARM (v4 or greater) */
204 /* BCPU(ARM_THUMB2) - Thumb2 instruction set is available */
205 /* Only one of these will be defined. */
206 #if !defined(BCPU_ARM_TRADITIONAL) && !defined(BCPU_ARM_THUMB2)
207 #  if defined(thumb2) || defined(__thumb2__) \
208 || ((defined(__thumb) || defined(__thumb__)) && BTHUMB_ARCH_VERSION == 4)
209 #    define BCPU_ARM_TRADITIONAL 0
210 #    define BCPU_ARM_THUMB2 1
211 #  elif BARM_ARCH_AT_LEAST(4)
212 #    define BCPU_ARM_TRADITIONAL 1
213 #    define BCPU_ARM_THUMB2 0
214 #  else
215 #    error "Not supported ARM architecture"
216 #  endif
217 #elif BCPU(ARM_TRADITIONAL) && BCPU(ARM_THUMB2) /* Sanity Check */
218 #  error "Cannot use both of BCPU_ARM_TRADITIONAL and BCPU_ARM_THUMB2 platforms"
219 #endif /* !defined(BCPU_ARM_TRADITIONAL) && !defined(BCPU_ARM_THUMB2) */
220
221 #endif /* ARM */
222
223 #define BATTRIBUTE_PRINTF(formatStringArgument, extraArguments) __attribute__((__format__(printf, formatStringArgument, extraArguments)))
224
225 #if (BPLATFORM(MAC) && __MAC_OS_X_VERSION_MIN_REQUIRED >= 101200) || BPLATFORM(IOS)
226 #define BUSE_OS_LOG 1
227 #endif
228
229 #if !defined(BUSE_EXPORT_MACROS) && (BPLATFORM(MAC) || BPLATFORM(IOS))
230 #define BUSE_EXPORT_MACROS 1
231 #endif
232
233 /* BUNUSED_PARAM */
234 #if !defined(BUNUSED_PARAM)
235 #define BUNUSED_PARAM(variable) (void)variable
236 #endif
237
238 /* This is used for debugging when hacking on how bmalloc calculates its physical footprint. */
239 #define ENABLE_PHYSICAL_PAGE_MAP 0
240
241 #if ((BPLATFORM(IOS) && __IPHONE_OS_VERSION_MIN_REQUIRED >= 120000) || (BPLATFORM(WATCHOS) && __WATCH_OS_VERSION_MIN_REQUIRED >= 50000) || (BPLATFORM(APPLETV) && __TV_OS_VERSION_MIN_REQUIRED >= 120000)) \
242     && (BCPU(ARM64) || BCPU(ARM))
243 #define BUSE_CHECK_NANO_MALLOC 1
244 #else
245 #define BUSE_CHECK_NANO_MALLOC 0
246 #endif
247