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(__has_cpp_attribute)
75 #if __has_cpp_attribute(nodiscard)
76 #define FOLLY_NODISCARD [[nodiscard]]
79 #if !defined FOLLY_NODISCARD
80 #if defined(_MSC_VER) && (_MSC_VER >= 1700)
81 #define FOLLY_NODISCARD _Check_return_
82 #elif defined(__clang__) || defined(__GNUC__)
83 #define FOLLY_NODISCARD __attribute__((__warn_unused_result__))
85 #define FOLLY_NODISCARD
91 # define FOLLY_TARGET_ATTRIBUTE(target)
93 # define FOLLY_TARGET_ATTRIBUTE(target) __attribute__((__target__(target)))
96 // detection for 64 bit
97 #if defined(__x86_64__) || defined(_M_X64)
103 #if defined(__aarch64__)
109 #if defined (__powerpc64__)
110 # define FOLLY_PPC64 1
112 # define FOLLY_PPC64 0
116 constexpr bool kIsArchAmd64 = FOLLY_X64 == 1;
117 constexpr bool kIsArchAArch64 = FOLLY_A64 == 1;
118 constexpr bool kIsArchPPC64 = FOLLY_PPC64 == 1;
123 #if FOLLY_SANITIZE_ADDRESS
124 constexpr bool kIsSanitizeAddress = true;
126 constexpr bool kIsSanitizeAddress = false;
129 #if FOLLY_SANITIZE_THREAD
130 constexpr bool kIsSanitizeThread = true;
132 constexpr bool kIsSanitizeThread = false;
136 // packing is very ugly in msvc
138 # define FOLLY_PACK_ATTR /**/
139 # define FOLLY_PACK_PUSH __pragma(pack(push, 1))
140 # define FOLLY_PACK_POP __pragma(pack(pop))
141 #elif defined(__clang__) || defined(__GNUC__)
142 # define FOLLY_PACK_ATTR __attribute__((__packed__))
143 # define FOLLY_PACK_PUSH /**/
144 # define FOLLY_PACK_POP /**/
146 # define FOLLY_PACK_ATTR /**/
147 # define FOLLY_PACK_PUSH /**/
148 # define FOLLY_PACK_POP /**/
151 // Generalize warning push/pop.
152 #if defined(_MSC_VER)
153 # define FOLLY_PUSH_WARNING __pragma(warning(push))
154 # define FOLLY_POP_WARNING __pragma(warning(pop))
155 // Disable the GCC warnings.
156 # define FOLLY_GCC_DISABLE_WARNING(warningName)
157 # define FOLLY_MSVC_DISABLE_WARNING(warningNumber) __pragma(warning(disable: warningNumber))
158 #elif defined(__clang__) || defined(__GNUC__)
159 # define FOLLY_PUSH_WARNING _Pragma("GCC diagnostic push")
160 # define FOLLY_POP_WARNING _Pragma("GCC diagnostic pop")
161 # define FOLLY_GCC_DISABLE_WARNING_INTERNAL2(warningName) #warningName
162 # define FOLLY_GCC_DISABLE_WARNING(warningName) \
164 FOLLY_GCC_DISABLE_WARNING_INTERNAL2(GCC diagnostic ignored warningName))
165 // Disable the MSVC warnings.
166 # define FOLLY_MSVC_DISABLE_WARNING(warningNumber)
168 # define FOLLY_PUSH_WARNING
169 # define FOLLY_POP_WARNING
170 # define FOLLY_GCC_DISABLE_WARNING(warningName)
171 # define FOLLY_MSVC_DISABLE_WARNING(warningNumber)
174 #ifdef HAVE_SHADOW_LOCAL_WARNINGS
175 #define FOLLY_GCC_DISABLE_NEW_SHADOW_WARNINGS \
176 FOLLY_GCC_DISABLE_WARNING("-Wshadow-compatible-local") \
177 FOLLY_GCC_DISABLE_WARNING("-Wshadow-local")
179 #define FOLLY_GCC_DISABLE_NEW_SHADOW_WARNINGS /* empty */
182 #if defined(__GNUC__) && !defined(__APPLE__) && !__GNUC_PREREQ(4,9)
183 // https://gcc.gnu.org/bugzilla/show_bug.cgi?id=56019
184 // gcc 4.8.x incorrectly placed max_align_t in the root namespace
185 // Alias it into std (where it's found in 4.9 and later)
186 namespace std { typedef ::max_align_t max_align_t; }
189 // portable version check for clang
190 #ifndef __CLANG_PREREQ
191 # if defined __clang__ && defined __clang_major__ && defined __clang_minor__
193 # define __CLANG_PREREQ(maj, min) \
194 ((__clang_major__ << 16) + __clang_minor__ >= ((maj) << 16) + (min))
197 # define __CLANG_PREREQ(maj, min) 0
201 /* Platform specific TLS support
202 * gcc implements __thread
203 * msvc implements __declspec(thread)
204 * the semantics are the same
205 * (but remember __thread has different semantics when using emutls (ex. apple))
207 #if defined(_MSC_VER)
208 # define FOLLY_TLS __declspec(thread)
209 #elif defined(__GNUC__) || defined(__clang__)
210 # define FOLLY_TLS __thread
212 # error cannot define platform specific thread local storage
219 // It turns out that GNU libstdc++ and LLVM libc++ differ on how they implement
220 // the 'std' namespace; the latter uses inline namespaces. Wrap this decision
221 // up in a macro to make forward-declarations easier.
224 #define FOLLY_NAMESPACE_STD_BEGIN _LIBCPP_BEGIN_NAMESPACE_STD
225 #define FOLLY_NAMESPACE_STD_END _LIBCPP_END_NAMESPACE_STD
227 #define FOLLY_NAMESPACE_STD_BEGIN namespace std {
228 #define FOLLY_NAMESPACE_STD_END }
231 // If the new c++ ABI is used, __cxx11 inline namespace needs to be added to
232 // some types, e.g. std::list.
233 #if _GLIBCXX_USE_CXX11_ABI
234 #define FOLLY_GLIBCXX_NAMESPACE_CXX11_BEGIN \
235 inline _GLIBCXX_BEGIN_NAMESPACE_CXX11
236 # define FOLLY_GLIBCXX_NAMESPACE_CXX11_END _GLIBCXX_END_NAMESPACE_CXX11
238 # define FOLLY_GLIBCXX_NAMESPACE_CXX11_BEGIN
239 # define FOLLY_GLIBCXX_NAMESPACE_CXX11_END
242 // MSVC specific defines
243 // mainly for posix compat
245 #include <folly/portability/SysTypes.h>
247 // compiler specific to compiler specific
249 # define __PRETTY_FUNCTION__ __FUNCSIG__
251 // Hide a GCC specific thing that breaks MSVC if left alone.
252 # define __extension__
254 // We have compiler support for the newest of the new, but
255 // MSVC doesn't tell us that.
263 constexpr auto kIsDebug = false;
265 constexpr auto kIsDebug = true;
272 // It's MSVC, so we just have to guess ... and allow an override
273 #ifdef FOLLY_ENDIAN_BE
274 constexpr auto kIsLittleEndian = false;
276 constexpr auto kIsLittleEndian = true;
279 constexpr auto kIsLittleEndian = __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__;
281 constexpr auto kIsBigEndian = !kIsLittleEndian;
285 # if defined(__SSE4_2__)
287 # define FOLLY_SSE_MINOR 2
288 # elif defined(__SSE4_1__)
290 # define FOLLY_SSE_MINOR 1
291 # elif defined(__SSE4__)
293 # define FOLLY_SSE_MINOR 0
294 # elif defined(__SSE3__)
296 # define FOLLY_SSE_MINOR 0
297 # elif defined(__SSE2__)
299 # define FOLLY_SSE_MINOR 0
300 # elif defined(__SSE__)
302 # define FOLLY_SSE_MINOR 0
305 # define FOLLY_SSE_MINOR 0
309 #define FOLLY_SSE_PREREQ(major, minor) \
310 (FOLLY_SSE > major || FOLLY_SSE == major && FOLLY_SSE_MINOR >= minor)
312 #if FOLLY_UNUSUAL_GFLAGS_NAMESPACE
313 namespace FOLLY_GFLAGS_NAMESPACE { }
315 using namespace FOLLY_GFLAGS_NAMESPACE;
316 } // namespace gflags
319 // for TARGET_OS_IPHONE
321 #include <TargetConditionals.h>
324 // RTTI may not be enabled for this compilation unit.
325 #if defined(__GXX_RTTI) || defined(__cpp_rtti) || \
326 (defined(_MSC_VER) && defined(_CPPRTTI))
327 # define FOLLY_HAS_RTTI 1
330 #if defined(__APPLE__) || defined(_MSC_VER)
331 #define FOLLY_STATIC_CTOR_PRIORITY_MAX
333 // 101 is the highest priority allowed by the init_priority attribute.
334 // This priority is already used by JEMalloc and other memory allocators so
335 // we will take the next one.
336 #define FOLLY_STATIC_CTOR_PRIORITY_MAX __attribute__((__init_priority__(102)))
342 constexpr auto kIsObjC = true;
344 constexpr auto kIsObjC = false;
347 #if defined(__linux__) && !FOLLY_MOBILE
348 constexpr auto kIsLinux = true;
350 constexpr auto kIsLinux = false;
354 constexpr auto kIsWindows = true;
356 constexpr auto kIsWindows = false;