2 * Copyright 2017 Facebook, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
23 #include <folly/portability/Config.h>
25 #include <folly/CPortability.h>
27 // Unaligned loads and stores
29 #if FOLLY_HAVE_UNALIGNED_ACCESS
30 constexpr bool kHasUnalignedAccess = true;
32 constexpr bool kHasUnalignedAccess = false;
36 // compiler specific attribute translation
37 // msvc should come first, so if clang is in msvc mode it gets the right defines
39 #if defined(__clang__) || defined(__GNUC__)
40 # define FOLLY_ALIGNED(size) __attribute__((__aligned__(size)))
41 #elif defined(_MSC_VER)
42 # define FOLLY_ALIGNED(size) __declspec(align(size))
44 # error Cannot define FOLLY_ALIGNED on this platform
46 #define FOLLY_ALIGNED_MAX FOLLY_ALIGNED(alignof(std::max_align_t))
48 // NOTE: this will only do checking in msvc with versions that support /analyze
50 # ifdef _USE_ATTRIBUTES_FOR_SAL
51 # undef _USE_ATTRIBUTES_FOR_SAL
54 # define _USE_ATTRIBUTES_FOR_SAL 1
56 # define FOLLY_PRINTF_FORMAT _Printf_format_string_
57 # define FOLLY_PRINTF_FORMAT_ATTR(format_param, dots_param) /**/
59 # define FOLLY_PRINTF_FORMAT /**/
60 # define FOLLY_PRINTF_FORMAT_ATTR(format_param, dots_param) \
61 __attribute__((__format__(__printf__, format_param, dots_param)))
65 #if defined(__clang__) || defined(__GNUC__)
66 # define FOLLY_DEPRECATED(msg) __attribute__((__deprecated__(msg)))
67 #elif defined(_MSC_VER)
68 # define FOLLY_DEPRECATED(msg) __declspec(deprecated(msg))
70 # define FOLLY_DEPRECATED(msg)
74 #if defined(_MSC_VER) && (_MSC_VER >= 1700)
75 #define FOLLY_WARN_UNUSED_RESULT _Check_return_
76 #elif defined(__clang__) || defined(__GNUC__)
77 #define FOLLY_WARN_UNUSED_RESULT __attribute__((__warn_unused_result__))
79 #define FOLLY_WARN_UNUSED_RESULT
84 # define FOLLY_TARGET_ATTRIBUTE(target)
86 # define FOLLY_TARGET_ATTRIBUTE(target) __attribute__((__target__(target)))
89 // detection for 64 bit
90 #if defined(__x86_64__) || defined(_M_X64)
96 #if defined(__aarch64__)
102 #if defined (__powerpc64__)
103 # define FOLLY_PPC64 1
105 # define FOLLY_PPC64 0
109 constexpr bool kIsArchAmd64 = FOLLY_X64 == 1;
110 constexpr bool kIsArchAArch64 = FOLLY_A64 == 1;
111 constexpr bool kIsArchPPC64 = FOLLY_PPC64 == 1;
116 #if FOLLY_SANITIZE_ADDRESS
117 constexpr bool kIsSanitizeAddress = true;
119 constexpr bool kIsSanitizeAddress = false;
122 #if FOLLY_SANITIZE_THREAD
123 constexpr bool kIsSanitizeThread = true;
125 constexpr bool kIsSanitizeThread = false;
129 // packing is very ugly in msvc
131 # define FOLLY_PACK_ATTR /**/
132 # define FOLLY_PACK_PUSH __pragma(pack(push, 1))
133 # define FOLLY_PACK_POP __pragma(pack(pop))
134 #elif defined(__clang__) || defined(__GNUC__)
135 # define FOLLY_PACK_ATTR __attribute__((__packed__))
136 # define FOLLY_PACK_PUSH /**/
137 # define FOLLY_PACK_POP /**/
139 # define FOLLY_PACK_ATTR /**/
140 # define FOLLY_PACK_PUSH /**/
141 # define FOLLY_PACK_POP /**/
144 // Generalize warning push/pop.
145 #if defined(_MSC_VER)
146 # define FOLLY_PUSH_WARNING __pragma(warning(push))
147 # define FOLLY_POP_WARNING __pragma(warning(pop))
148 // Disable the GCC warnings.
149 # define FOLLY_GCC_DISABLE_WARNING(warningName)
150 # define FOLLY_MSVC_DISABLE_WARNING(warningNumber) __pragma(warning(disable: warningNumber))
151 #elif defined(__clang__) || defined(__GNUC__)
152 # define FOLLY_PUSH_WARNING _Pragma("GCC diagnostic push")
153 # define FOLLY_POP_WARNING _Pragma("GCC diagnostic pop")
154 # define FOLLY_GCC_DISABLE_WARNING_INTERNAL2(warningName) #warningName
155 # define FOLLY_GCC_DISABLE_WARNING(warningName) \
157 FOLLY_GCC_DISABLE_WARNING_INTERNAL2(GCC diagnostic ignored warningName))
158 // Disable the MSVC warnings.
159 # define FOLLY_MSVC_DISABLE_WARNING(warningNumber)
161 # define FOLLY_PUSH_WARNING
162 # define FOLLY_POP_WARNING
163 # define FOLLY_GCC_DISABLE_WARNING(warningName)
164 # define FOLLY_MSVC_DISABLE_WARNING(warningNumber)
167 #ifdef HAVE_SHADOW_LOCAL_WARNINGS
168 #define FOLLY_GCC_DISABLE_NEW_SHADOW_WARNINGS \
169 FOLLY_GCC_DISABLE_WARNING("-Wshadow-compatible-local") \
170 FOLLY_GCC_DISABLE_WARNING("-Wshadow-local")
172 #define FOLLY_GCC_DISABLE_NEW_SHADOW_WARNINGS /* empty */
175 #if defined(__GNUC__) && !defined(__APPLE__) && !__GNUC_PREREQ(4,9)
176 // https://gcc.gnu.org/bugzilla/show_bug.cgi?id=56019
177 // gcc 4.8.x incorrectly placed max_align_t in the root namespace
178 // Alias it into std (where it's found in 4.9 and later)
179 namespace std { typedef ::max_align_t max_align_t; }
182 // portable version check for clang
183 #ifndef __CLANG_PREREQ
184 # if defined __clang__ && defined __clang_major__ && defined __clang_minor__
186 # define __CLANG_PREREQ(maj, min) \
187 ((__clang_major__ << 16) + __clang_minor__ >= ((maj) << 16) + (min))
190 # define __CLANG_PREREQ(maj, min) 0
194 /* Platform specific TLS support
195 * gcc implements __thread
196 * msvc implements __declspec(thread)
197 * the semantics are the same
198 * (but remember __thread has different semantics when using emutls (ex. apple))
200 #if defined(_MSC_VER)
201 # define FOLLY_TLS __declspec(thread)
202 #elif defined(__GNUC__) || defined(__clang__)
203 # define FOLLY_TLS __thread
205 # error cannot define platform specific thread local storage
212 // It turns out that GNU libstdc++ and LLVM libc++ differ on how they implement
213 // the 'std' namespace; the latter uses inline namespaces. Wrap this decision
214 // up in a macro to make forward-declarations easier.
217 #define FOLLY_NAMESPACE_STD_BEGIN _LIBCPP_BEGIN_NAMESPACE_STD
218 #define FOLLY_NAMESPACE_STD_END _LIBCPP_END_NAMESPACE_STD
220 #define FOLLY_NAMESPACE_STD_BEGIN namespace std {
221 #define FOLLY_NAMESPACE_STD_END }
224 // If the new c++ ABI is used, __cxx11 inline namespace needs to be added to
225 // some types, e.g. std::list.
226 #if _GLIBCXX_USE_CXX11_ABI
227 #define FOLLY_GLIBCXX_NAMESPACE_CXX11_BEGIN \
228 inline _GLIBCXX_BEGIN_NAMESPACE_CXX11
229 # define FOLLY_GLIBCXX_NAMESPACE_CXX11_END _GLIBCXX_END_NAMESPACE_CXX11
231 # define FOLLY_GLIBCXX_NAMESPACE_CXX11_BEGIN
232 # define FOLLY_GLIBCXX_NAMESPACE_CXX11_END
235 // MSVC specific defines
236 // mainly for posix compat
238 #include <folly/portability/SysTypes.h>
240 // compiler specific to compiler specific
242 # define __PRETTY_FUNCTION__ __FUNCSIG__
244 // Hide a GCC specific thing that breaks MSVC if left alone.
245 # define __extension__
247 // We have compiler support for the newest of the new, but
248 // MSVC doesn't tell us that.
256 constexpr auto kIsDebug = false;
258 constexpr auto kIsDebug = true;
265 // It's MSVC, so we just have to guess ... and allow an override
266 #ifdef FOLLY_ENDIAN_BE
267 constexpr auto kIsLittleEndian = false;
269 constexpr auto kIsLittleEndian = true;
272 constexpr auto kIsLittleEndian = __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__;
274 constexpr auto kIsBigEndian = !kIsLittleEndian;
278 # if defined(__SSE4_2__)
280 # define FOLLY_SSE_MINOR 2
281 # elif defined(__SSE4_1__)
283 # define FOLLY_SSE_MINOR 1
284 # elif defined(__SSE4__)
286 # define FOLLY_SSE_MINOR 0
287 # elif defined(__SSE3__)
289 # define FOLLY_SSE_MINOR 0
290 # elif defined(__SSE2__)
292 # define FOLLY_SSE_MINOR 0
293 # elif defined(__SSE__)
295 # define FOLLY_SSE_MINOR 0
298 # define FOLLY_SSE_MINOR 0
302 #define FOLLY_SSE_PREREQ(major, minor) \
303 (FOLLY_SSE > major || FOLLY_SSE == major && FOLLY_SSE_MINOR >= minor)
305 #if FOLLY_UNUSUAL_GFLAGS_NAMESPACE
306 namespace FOLLY_GFLAGS_NAMESPACE { }
308 using namespace FOLLY_GFLAGS_NAMESPACE;
309 } // namespace gflags
312 // for TARGET_OS_IPHONE
314 #include <TargetConditionals.h>
317 // RTTI may not be enabled for this compilation unit.
318 #if defined(__GXX_RTTI) || defined(__cpp_rtti) || \
319 (defined(_MSC_VER) && defined(_CPPRTTI))
320 # define FOLLY_HAS_RTTI 1
323 #if defined(__APPLE__) || defined(_MSC_VER)
324 #define FOLLY_STATIC_CTOR_PRIORITY_MAX
326 // 101 is the highest priority allowed by the init_priority attribute.
327 // This priority is already used by JEMalloc and other memory allocators so
328 // we will take the next one.
329 #define FOLLY_STATIC_CTOR_PRIORITY_MAX __attribute__((__init_priority__(102)))
334 #if defined(__linux__) && !FOLLY_MOBILE
335 constexpr auto kIsLinux = true;
337 constexpr auto kIsLinux = false;
341 constexpr auto kIsWindows = true;
343 constexpr auto kIsWindows = false;