Use folly::Expected to implement folly::tryTo, a non-throwing variant of folly::to
[folly.git] / folly / Portability.h
1 /*
2  * Copyright 2016 Facebook, Inc.
3  *
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
7  *
8  *   http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16
17 #pragma once
18
19 #include <string.h>
20
21 #include <cstddef>
22
23 #include <folly/portability/Config.h>
24
25 #include <folly/CPortability.h>
26
27 #if FOLLY_HAVE_SCHED_H
28  #include <sched.h>
29 #endif
30
31 // Unaligned loads and stores
32 namespace folly {
33 #if FOLLY_HAVE_UNALIGNED_ACCESS
34 constexpr bool kHasUnalignedAccess = true;
35 #else
36 constexpr bool kHasUnalignedAccess = false;
37 #endif
38 }
39
40 // compiler specific attribute translation
41 // msvc should come first, so if clang is in msvc mode it gets the right defines
42
43 #if defined(__clang__) || defined(__GNUC__)
44 # define FOLLY_ALIGNED(size) __attribute__((__aligned__(size)))
45 #elif defined(_MSC_VER)
46 # define FOLLY_ALIGNED(size) __declspec(align(size))
47 #else
48 # error Cannot define FOLLY_ALIGNED on this platform
49 #endif
50 #define FOLLY_ALIGNED_MAX FOLLY_ALIGNED(alignof(std::max_align_t))
51
52 // NOTE: this will only do checking in msvc with versions that support /analyze
53 #if _MSC_VER
54 # ifdef _USE_ATTRIBUTES_FOR_SAL
55 #    undef _USE_ATTRIBUTES_FOR_SAL
56 # endif
57 /* nolint */
58 # define _USE_ATTRIBUTES_FOR_SAL 1
59 # include <sal.h>
60 # define FOLLY_PRINTF_FORMAT _Printf_format_string_
61 # define FOLLY_PRINTF_FORMAT_ATTR(format_param, dots_param) /**/
62 #else
63 # define FOLLY_PRINTF_FORMAT /**/
64 # define FOLLY_PRINTF_FORMAT_ATTR(format_param, dots_param) \
65   __attribute__((__format__(__printf__, format_param, dots_param)))
66 #endif
67
68 // deprecated
69 #if defined(__clang__) || defined(__GNUC__)
70 # define FOLLY_DEPRECATED(msg) __attribute__((__deprecated__(msg)))
71 #elif defined(_MSC_VER)
72 # define FOLLY_DEPRECATED(msg) __declspec(deprecated(msg))
73 #else
74 # define FOLLY_DEPRECATED(msg)
75 #endif
76
77 // noinline
78 #ifdef _MSC_VER
79 # define FOLLY_NOINLINE __declspec(noinline)
80 #elif defined(__clang__) || defined(__GNUC__)
81 # define FOLLY_NOINLINE __attribute__((__noinline__))
82 #else
83 # define FOLLY_NOINLINE
84 #endif
85
86 // always inline
87 #ifdef _MSC_VER
88 # define FOLLY_ALWAYS_INLINE __forceinline
89 #elif defined(__clang__) || defined(__GNUC__)
90 # define FOLLY_ALWAYS_INLINE inline __attribute__((__always_inline__))
91 #else
92 # define FOLLY_ALWAYS_INLINE inline
93 #endif
94
95 // warn unused result
96 #if defined(_MSC_VER) && (_MSC_VER >= 1700)
97 #define FOLLY_WARN_UNUSED_RESULT _Check_return_
98 #elif defined(__clang__) || defined(__GNUC__)
99 #define FOLLY_WARN_UNUSED_RESULT __attribute__((__warn_unused_result__))
100 #else
101 #define FOLLY_WARN_UNUSED_RESULT
102 #endif
103
104 // target
105 #ifdef _MSC_VER
106 # define FOLLY_TARGET_ATTRIBUTE(target)
107 #else
108 # define FOLLY_TARGET_ATTRIBUTE(target) __attribute__((__target__(target)))
109 #endif
110
111 // detection for 64 bit
112 #if defined(__x86_64__) || defined(_M_X64)
113 # define FOLLY_X64 1
114 #else
115 # define FOLLY_X64 0
116 #endif
117
118 #if defined(__aarch64__)
119 # define FOLLY_A64 1
120 #else
121 # define FOLLY_A64 0
122 #endif
123
124 #if defined (__powerpc64__)
125 # define FOLLY_PPC64 1
126 #else
127 # define FOLLY_PPC64 0
128 #endif
129
130 // packing is very ugly in msvc
131 #ifdef _MSC_VER
132 # define FOLLY_PACK_ATTR /**/
133 # define FOLLY_PACK_PUSH __pragma(pack(push, 1))
134 # define FOLLY_PACK_POP __pragma(pack(pop))
135 #elif defined(__clang__) || defined(__GNUC__)
136 # define FOLLY_PACK_ATTR __attribute__((__packed__))
137 # define FOLLY_PACK_PUSH /**/
138 # define FOLLY_PACK_POP /**/
139 #else
140 # define FOLLY_PACK_ATTR /**/
141 # define FOLLY_PACK_PUSH /**/
142 # define FOLLY_PACK_POP /**/
143 #endif
144
145 // Generalize warning push/pop.
146 #if defined(_MSC_VER)
147 # define FOLLY_PUSH_WARNING __pragma(warning(push))
148 # define FOLLY_POP_WARNING __pragma(warning(pop))
149 // Disable the GCC warnings.
150 # define FOLLY_GCC_DISABLE_WARNING(warningName)
151 # define FOLLY_MSVC_DISABLE_WARNING(warningNumber) __pragma(warning(disable: warningNumber))
152 #elif defined(__clang__) || defined(__GNUC__)
153 # define FOLLY_PUSH_WARNING _Pragma("GCC diagnostic push")
154 # define FOLLY_POP_WARNING _Pragma("GCC diagnostic pop")
155 #define FOLLY_GCC_DISABLE_WARNING_INTERNAL3(warningName) #warningName
156 #define FOLLY_GCC_DISABLE_WARNING_INTERNAL2(warningName) \
157   FOLLY_GCC_DISABLE_WARNING_INTERNAL3(warningName)
158 #define FOLLY_GCC_DISABLE_WARNING(warningName)                       \
159   _Pragma(FOLLY_GCC_DISABLE_WARNING_INTERNAL2(GCC diagnostic ignored \
160           FOLLY_GCC_DISABLE_WARNING_INTERNAL3(-W##warningName)))
161 // Disable the MSVC warnings.
162 # define FOLLY_MSVC_DISABLE_WARNING(warningNumber)
163 #else
164 # define FOLLY_PUSH_WARNING
165 # define FOLLY_POP_WARNING
166 # define FOLLY_GCC_DISABLE_WARNING(warningName)
167 # define FOLLY_MSVC_DISABLE_WARNING(warningNumber)
168 #endif
169
170 // portable version check
171 #ifndef __GNUC_PREREQ
172 # if defined __GNUC__ && defined __GNUC_MINOR__
173 /* nolint */
174 #  define __GNUC_PREREQ(maj, min) ((__GNUC__ << 16) + __GNUC_MINOR__ >= \
175                                    ((maj) << 16) + (min))
176 # else
177 /* nolint */
178 #  define __GNUC_PREREQ(maj, min) 0
179 # endif
180 #endif
181
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; }
187 #endif
188
189 // portable version check for clang
190 #ifndef __CLANG_PREREQ
191 # if defined __clang__ && defined __clang_major__ && defined __clang_minor__
192 /* nolint */
193 #  define __CLANG_PREREQ(maj, min) \
194     ((__clang_major__ << 16) + __clang_minor__ >= ((maj) << 16) + (min))
195 # else
196 /* nolint */
197 #  define __CLANG_PREREQ(maj, min) 0
198 # endif
199 #endif
200
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))
206  */
207 #if defined(_MSC_VER)
208 # define FOLLY_TLS __declspec(thread)
209 #elif defined(__GNUC__) || defined(__clang__)
210 # define FOLLY_TLS __thread
211 #else
212 # error cannot define platform specific thread local storage
213 #endif
214
215 #if FOLLY_MOBILE
216 #undef FOLLY_TLS
217 #endif
218
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.
222 #if FOLLY_USE_LIBCPP
223 #include <__config>
224 #define FOLLY_NAMESPACE_STD_BEGIN     _LIBCPP_BEGIN_NAMESPACE_STD
225 #define FOLLY_NAMESPACE_STD_END       _LIBCPP_END_NAMESPACE_STD
226 #else
227 #define FOLLY_NAMESPACE_STD_BEGIN     namespace std {
228 #define FOLLY_NAMESPACE_STD_END       }
229 #endif
230
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 _GLIBCXX_BEGIN_NAMESPACE_CXX11
235 # define FOLLY_GLIBCXX_NAMESPACE_CXX11_END   _GLIBCXX_END_NAMESPACE_CXX11
236 #else
237 # define FOLLY_GLIBCXX_NAMESPACE_CXX11_BEGIN
238 # define FOLLY_GLIBCXX_NAMESPACE_CXX11_END
239 #endif
240
241 // Provide our own std::__throw_* wrappers for platforms that don't have them
242 #if FOLLY_HAVE_BITS_FUNCTEXCEPT_H
243 #include <bits/functexcept.h>
244 #else
245 #include <folly/detail/FunctionalExcept.h>
246 #endif
247
248 #if defined(__cplusplus)
249 // Unfortunately, boost::has_trivial_copy<T> is broken in libc++ due to its
250 // usage of __has_trivial_copy(), so we can't use it as a
251 // least-common-denominator for C++11 implementations that don't support
252 // std::is_trivially_copyable<T>.
253 //
254 //      http://stackoverflow.com/questions/12754886/has-trivial-copy-behaves-differently-in-clang-and-gcc-whos-right
255 //
256 // As a result, use std::is_trivially_copyable() where it exists, and fall back
257 // to Boost otherwise.
258 #if FOLLY_HAVE_STD__IS_TRIVIALLY_COPYABLE
259 #include <type_traits>
260 #define FOLLY_IS_TRIVIALLY_COPYABLE(T)                   \
261   (std::is_trivially_copyable<T>::value)
262 #else
263 #include <boost/type_traits.hpp>
264 #define FOLLY_IS_TRIVIALLY_COPYABLE(T)                   \
265   (boost::has_trivial_copy<T>::value &&                  \
266    boost::has_trivial_destructor<T>::value)
267 #endif
268 #endif // __cplusplus
269
270 // MSVC specific defines
271 // mainly for posix compat
272 #ifdef _MSC_VER
273 #include <folly/portability/SysTypes.h>
274
275 // compiler specific to compiler specific
276 // nolint
277 # define __PRETTY_FUNCTION__ __FUNCSIG__
278
279 // Hide a GCC specific thing that breaks MSVC if left alone.
280 # define __extension__
281
282 // We have compiler support for the newest of the new, but
283 // MSVC doesn't tell us that.
284 #define __SSE4_2__ 1
285
286 #endif
287
288 // Debug
289 namespace folly {
290 #ifdef NDEBUG
291 constexpr auto kIsDebug = false;
292 #else
293 constexpr auto kIsDebug = true;
294 #endif
295 }
296
297 // Endianness
298 namespace folly {
299 #ifdef _MSC_VER
300 // It's MSVC, so we just have to guess ... and allow an override
301 #ifdef FOLLY_ENDIAN_BE
302 constexpr auto kIsLittleEndian = false;
303 #else
304 constexpr auto kIsLittleEndian = true;
305 #endif
306 #else
307 constexpr auto kIsLittleEndian = __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__;
308 #endif
309 constexpr auto kIsBigEndian = !kIsLittleEndian;
310 }
311
312 #ifndef FOLLY_SSE
313 # if defined(__SSE4_2__)
314 #  define FOLLY_SSE 4
315 #  define FOLLY_SSE_MINOR 2
316 # elif defined(__SSE4_1__)
317 #  define FOLLY_SSE 4
318 #  define FOLLY_SSE_MINOR 1
319 # elif defined(__SSE4__)
320 #  define FOLLY_SSE 4
321 #  define FOLLY_SSE_MINOR 0
322 # elif defined(__SSE3__)
323 #  define FOLLY_SSE 3
324 #  define FOLLY_SSE_MINOR 0
325 # elif defined(__SSE2__)
326 #  define FOLLY_SSE 2
327 #  define FOLLY_SSE_MINOR 0
328 # elif defined(__SSE__)
329 #  define FOLLY_SSE 1
330 #  define FOLLY_SSE_MINOR 0
331 # else
332 #  define FOLLY_SSE 0
333 #  define FOLLY_SSE_MINOR 0
334 # endif
335 #endif
336
337 #define FOLLY_SSE_PREREQ(major, minor) \
338   (FOLLY_SSE > major || FOLLY_SSE == major && FOLLY_SSE_MINOR >= minor)
339
340 #if FOLLY_UNUSUAL_GFLAGS_NAMESPACE
341 namespace FOLLY_GFLAGS_NAMESPACE { }
342 namespace gflags {
343 using namespace FOLLY_GFLAGS_NAMESPACE;
344 }  // namespace gflags
345 #endif
346
347 // for TARGET_OS_IPHONE
348 #ifdef __APPLE__
349 #include <TargetConditionals.h>
350 #endif
351
352 // RTTI may not be enabled for this compilation unit.
353 #if defined(__GXX_RTTI) || defined(__cpp_rtti) || \
354     (defined(_MSC_VER) && defined(_CPPRTTI))
355 # define FOLLY_HAS_RTTI 1
356 #endif
357
358 #if defined(__APPLE__) || defined(_MSC_VER)
359 #define FOLLY_STATIC_CTOR_PRIORITY_MAX
360 #else
361 // 101 is the highest priority allowed by the init_priority attribute.
362 // This priority is already used by JEMalloc and other memory allocators so
363 // we will take the next one.
364 #define FOLLY_STATIC_CTOR_PRIORITY_MAX __attribute__((__init_priority__(102)))
365 #endif
366
367 namespace folly {
368
369 #if defined(__linux__) && !FOLLY_MOBILE
370 constexpr auto kIsLinux = true;
371 #else
372 constexpr auto kIsLinux = false;
373 #endif
374 }