Implement __builtin_clzl for MSVC
[WebKit-https.git] / Source / bmalloc / bmalloc / BPlatform.h
1 /*
2  * Copyright (C) 2014 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 #ifdef __APPLE__
29 #include <Availability.h>
30 #include <AvailabilityMacros.h>
31 #include <TargetConditionals.h>
32 #endif
33
34 #define BPLATFORM(PLATFORM) (defined BPLATFORM_##PLATFORM && BPLATFORM_##PLATFORM)
35 #define BOS(OS) (defined BOS_##OS && BOS_##OS)
36
37 #ifdef __APPLE__
38 #define BOS_DARWIN 1
39 #endif
40
41 #ifdef __unix
42 #define BOS_UNIX 1
43 #endif
44
45 #if defined(WIN32) || defined(_WIN32)
46 #define BOS_WINDOWS 1
47 #endif
48
49 #if BOS(DARWIN) && ((defined(TARGET_OS_EMBEDDED) && TARGET_OS_EMBEDDED) \
50     || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) \
51     || (defined(TARGET_IPHONE_SIMULATOR) && TARGET_IPHONE_SIMULATOR))
52 #define BPLATFORM_IOS 1
53 #if (defined(TARGET_IPHONE_SIMULATOR) && TARGET_IPHONE_SIMULATOR)
54 #define BPLATFORM_IOS_SIMULATOR 1
55 #endif
56 #elif BOS(DARWIN) && defined(TARGET_OS_MAC) && TARGET_OS_MAC
57 #define BPLATFORM_MAC 1
58 #endif
59
60 /* ==== Policy decision macros: these define policy choices for a particular port. ==== */
61
62 /* BUSE() - use a particular third-party library or optional OS service */
63 #define BUSE(FEATURE) (defined BUSE_##FEATURE && BUSE_##FEATURE)
64
65 /* ==== Platform adaptation macros: these describe properties of the target environment. ==== */
66
67 /* BCPU() - the target CPU architecture */
68 #define BCPU(_FEATURE) (defined BCPU_##_FEATURE  && BCPU_##_FEATURE)
69
70 /* BCPU(X86) - i386 / x86 32-bit */
71 #if defined(__i386__) \
72 || defined(i386)     \
73 || defined(_M_IX86)  \
74 || defined(_X86_)    \
75 || defined(__THW_INTEL)
76 #define BCPU_X86 1
77 #endif
78
79 /* BCPU(X86_64) - AMD64 / Intel64 / x86_64 64-bit */
80 #if defined(__x86_64__) \
81 || defined(_M_X64)
82 #define BCPU_X86_64 1
83 #endif
84
85 /* BCPU(ARM64) - Apple */
86 #if (defined(__arm64__) && defined(__APPLE__)) || defined(__aarch64__)
87 #define BCPU_ARM64 1
88 #endif
89
90 /* BCPU(ARM) - ARM, any version*/
91 #define BARM_ARCH_AT_LEAST(N) (BCPU(ARM) && BARM_ARCH_VERSION >= N)
92
93 #if   defined(arm) \
94 || defined(__arm__) \
95 || defined(ARM) \
96 || defined(_ARM_)
97 #define BCPU_ARM 1
98
99 /* Set BARM_ARCH_VERSION */
100 #if   defined(__ARM_ARCH_4__) \
101 || defined(__ARM_ARCH_4T__) \
102 || defined(__MARM_ARMV4__)
103 #define BARM_ARCH_VERSION 4
104
105 #elif defined(__ARM_ARCH_5__) \
106 || defined(__ARM_ARCH_5T__) \
107 || defined(__MARM_ARMV5__)
108 #define BARM_ARCH_VERSION 5
109
110 #elif defined(__ARM_ARCH_5E__) \
111 || defined(__ARM_ARCH_5TE__) \
112 || defined(__ARM_ARCH_5TEJ__)
113 #define BARM_ARCH_VERSION 5
114
115 #elif defined(__ARM_ARCH_6__) \
116 || defined(__ARM_ARCH_6J__) \
117 || defined(__ARM_ARCH_6K__) \
118 || defined(__ARM_ARCH_6Z__) \
119 || defined(__ARM_ARCH_6ZK__) \
120 || defined(__ARM_ARCH_6T2__) \
121 || defined(__ARMV6__)
122 #define BARM_ARCH_VERSION 6
123
124 #elif defined(__ARM_ARCH_7A__) \
125 || defined(__ARM_ARCH_7K__) \
126 || defined(__ARM_ARCH_7R__) \
127 || defined(__ARM_ARCH_7S__)
128 #define BARM_ARCH_VERSION 7
129
130 #elif defined(__ARM_ARCH_8__) \
131 || defined(__ARM_ARCH_8A__)
132 #define BARM_ARCH_VERSION 8
133
134 /* MSVC sets _M_ARM */
135 #elif defined(_M_ARM)
136 #define BARM_ARCH_VERSION _M_ARM
137
138 /* RVCT sets _TARGET_ARCH_ARM */
139 #elif defined(__TARGET_ARCH_ARM)
140 #define BARM_ARCH_VERSION __TARGET_ARCH_ARM
141
142 #else
143 #define WTF_ARM_ARCH_VERSION 0
144
145 #endif
146
147 /* Set BTHUMB_ARCH_VERSION */
148 #if   defined(__ARM_ARCH_4T__)
149 #define BTHUMB_ARCH_VERSION 1
150
151 #elif defined(__ARM_ARCH_5T__) \
152 || defined(__ARM_ARCH_5TE__) \
153 || defined(__ARM_ARCH_5TEJ__)
154 #define BTHUMB_ARCH_VERSION 2
155
156 #elif defined(__ARM_ARCH_6J__) \
157 || defined(__ARM_ARCH_6K__) \
158 || defined(__ARM_ARCH_6Z__) \
159 || defined(__ARM_ARCH_6ZK__) \
160 || defined(__ARM_ARCH_6M__)
161 #define BTHUMB_ARCH_VERSION 3
162
163 #elif defined(__ARM_ARCH_6T2__) \
164 || defined(__ARM_ARCH_7__) \
165 || defined(__ARM_ARCH_7A__) \
166 || defined(__ARM_ARCH_7K__) \
167 || defined(__ARM_ARCH_7M__) \
168 || defined(__ARM_ARCH_7R__) \
169 || defined(__ARM_ARCH_7S__)
170 #define BTHUMB_ARCH_VERSION 4
171
172 /* RVCT sets __TARGET_ARCH_THUMB */
173 #elif defined(__TARGET_ARCH_THUMB)
174 #define BTHUMB_ARCH_VERSION __TARGET_ARCH_THUMB
175
176 #else
177 #define BTHUMB_ARCH_VERSION 0
178 #endif
179
180 /* BCPU(ARM_TRADITIONAL) - Thumb2 is not available, only traditional ARM (v4 or greater) */
181 /* BCPU(ARM_THUMB2) - Thumb2 instruction set is available */
182 /* Only one of these will be defined. */
183 #if !defined(BCPU_ARM_TRADITIONAL) && !defined(BCPU_ARM_THUMB2)
184 #  if defined(thumb2) || defined(__thumb2__) \
185 || ((defined(__thumb) || defined(__thumb__)) && BTHUMB_ARCH_VERSION == 4)
186 #    define BCPU_ARM_TRADITIONAL 0
187 #    define BCPU_ARM_THUMB2 1
188 #  elif BARM_ARCH_AT_LEAST(4)
189 #    define BCPU_ARM_TRADITIONAL 1
190 #    define BCPU_ARM_THUMB2 0
191 #  else
192 #    error "Not supported ARM architecture"
193 #  endif
194 #elif BCPU(ARM_TRADITIONAL) && BCPU(ARM_THUMB2) /* Sanity Check */
195 #  error "Cannot use both of BCPU_ARM_TRADITIONAL and BCPU_ARM_THUMB2 platforms"
196 #endif /* !defined(BCPU_ARM_TRADITIONAL) && !defined(BCPU_ARM_THUMB2) */
197
198 #endif /* ARM */
199
200 #define BATTRIBUTE_PRINTF(formatStringArgument, extraArguments) __attribute__((__format__(printf, formatStringArgument, extraArguments)))
201
202 #if (BPLATFORM(MAC) && __MAC_OS_X_VERSION_MIN_REQUIRED >= 101200) || BPLATFORM(IOS)
203 #define BUSE_OS_LOG 1
204 #endif