2 * Copyright 2014 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.
17 #ifndef FOLLY_PORTABILITY_H_
18 #define FOLLY_PORTABILITY_H_
20 #ifndef FOLLY_NO_CONFIG
21 #include <folly/folly-config.h>
24 #ifdef FOLLY_PLATFORM_CONFIG
25 #include FOLLY_PLATFORM_CONFIG
28 #if FOLLY_HAVE_FEATURES_H
32 #include <folly/CPortability.h>
34 #if FOLLY_HAVE_SCHED_H
36 #ifndef FOLLY_HAVE_PTHREAD_YIELD
37 #define pthread_yield sched_yield
41 // A change in folly/MemoryMapping.cpp uses MAP_ANONYMOUS, which is named
42 // MAP_ANON on OSX/BSD.
43 #if defined(__APPLE__) || defined(__FreeBSD__)
47 #define MAP_ANONYMOUS MAP_ANON
52 // MaxAlign: max_align_t isn't supported by gcc
54 struct MaxAlign { char c; } __attribute__((__aligned__));
56 # error Cannot define MaxAlign on this platform
59 // compiler specific attribute translation
60 // msvc should come first, so if clang is in msvc mode it gets the right defines
62 // NOTE: this will only do checking in msvc with versions that support /analyze
64 # ifdef _USE_ATTRIBUTES_FOR_SAL
65 # undef _USE_ATTRIBUTES_FOR_SAL
68 # define _USE_ATTRIBUTES_FOR_SAL 1
70 # define FOLLY_PRINTF_FORMAT _Printf_format_string_
71 # define FOLLY_PRINTF_FORMAT_ATTR(format_param, dots_param) /**/
73 # define FOLLY_PRINTF_FORMAT /**/
74 # define FOLLY_PRINTF_FORMAT_ATTR(format_param, dots_param) \
75 __attribute__((__format__(__printf__, format_param, dots_param)))
80 # define FOLLY_NORETURN __declspec(noreturn)
81 #elif defined(__clang__) || defined(__GNUC__)
82 # define FOLLY_NORETURN __attribute__((__noreturn__))
84 # define FOLLY_NORETURN
89 # define FOLLY_NOINLINE __declspec(noinline)
90 #elif defined(__clang__) || defined(__GNUC__)
91 # define FOLLY_NOINLINE __attribute__((__noinline__))
93 # define FOLLY_NOINLINE
98 # define FOLLY_ALWAYS_INLINE __forceinline
99 #elif defined(__clang__) || defined(__GNUC__)
100 # define FOLLY_ALWAYS_INLINE inline __attribute__((__always_inline__))
102 # define FOLLY_ALWAYS_INLINE
105 // detection for 64 bit
106 #if defined(__x86_64__) || defined(_M_X64)
112 // packing is very ugly in msvc
114 # define FOLLY_PACK_ATTR /**/
115 # define FOLLY_PACK_PUSH __pragma(pack(push, 1))
116 # define FOLLY_PACK_POP __pragma(pack(pop))
117 #elif defined(__clang__) || defined(__GNUC__)
118 # define FOLLY_PACK_ATTR __attribute__((__packed__))
119 # define FOLLY_PACK_PUSH /**/
120 # define FOLLY_PACK_POP /**/
122 # define FOLLY_PACK_ATTR /**/
123 # define FOLLY_PACK_PUSH /**/
124 # define FOLLY_PACK_POP /**/
127 // portable version check
128 #ifndef __GNUC_PREREQ
129 # if defined __GNUC__ && defined __GNUC_MINOR__
131 # define __GNUC_PREREQ(maj, min) ((__GNUC__ << 16) + __GNUC_MINOR__ >= \
132 ((maj) << 16) + (min))
135 # define __GNUC_PREREQ(maj, min) 0
140 /* Define macro wrappers for C++11's "final" and "override" keywords, which
141 * are supported in gcc 4.7 but not gcc 4.6. */
142 #if !defined(FOLLY_FINAL) && !defined(FOLLY_OVERRIDE)
143 # if defined(__clang__) || __GNUC_PREREQ(4, 7)
144 # define FOLLY_FINAL final
145 # define FOLLY_OVERRIDE override
147 # define FOLLY_FINAL /**/
148 # define FOLLY_OVERRIDE /**/
152 /* Platform specific TLS support
153 * gcc implements __thread
154 * msvc implements __declspec(thread)
155 * the semantics are the same
156 * (but remember __thread has different semantics when using emutls (ex. apple))
158 #if defined(_MSC_VER)
159 # define FOLLY_TLS __declspec(thread)
160 #elif defined(__GNUC__) || defined(__clang__)
161 # define FOLLY_TLS __thread
163 # error cannot define platform specific thread local storage
166 // Define to 1 if you have the `preadv' and `pwritev' functions, respectively
167 #if !defined(FOLLY_HAVE_PREADV) && !defined(FOLLY_HAVE_PWRITEV)
168 # if defined(__GLIBC_PREREQ)
169 # if __GLIBC_PREREQ(2, 10)
170 # define FOLLY_HAVE_PREADV 1
171 # define FOLLY_HAVE_PWRITEV 1
176 // It turns out that GNU libstdc++ and LLVM libc++ differ on how they implement
177 // the 'std' namespace; the latter uses inline namepsaces. Wrap this decision
178 // up in a macro to make forward-declarations easier.
181 #define FOLLY_NAMESPACE_STD_BEGIN _LIBCPP_BEGIN_NAMESPACE_STD
182 #define FOLLY_NAMESPACE_STD_END _LIBCPP_END_NAMESPACE_STD
184 #define FOLLY_NAMESPACE_STD_BEGIN namespace std {
185 #define FOLLY_NAMESPACE_STD_END }
188 // Some platforms lack clock_gettime(2) and clock_getres(2). Inject our own
189 // versions of these into the global namespace.
190 #if FOLLY_HAVE_CLOCK_GETTIME
193 #include <folly/detail/Clock.h>
196 // Provide our own std::__throw_* wrappers for platforms that don't have them
197 #if FOLLY_HAVE_BITS_FUNCTEXCEPT_H
198 #include <bits/functexcept.h>
200 #include <folly/detail/FunctionalExcept.h>
203 #if defined(__cplusplus)
204 // Unfortunately, boost::has_trivial_copy<T> is broken in libc++ due to its
205 // usage of __has_trivial_copy(), so we can't use it as a
206 // least-common-denominator for C++11 implementations that don't support
207 // std::is_trivially_copyable<T>.
209 // http://stackoverflow.com/questions/12754886/has-trivial-copy-behaves-differently-in-clang-and-gcc-whos-right
211 // As a result, use std::is_trivially_copyable() where it exists, and fall back
212 // to Boost otherwise.
213 #if FOLLY_HAVE_STD__IS_TRIVIALLY_COPYABLE
214 #include <type_traits>
215 #define FOLLY_IS_TRIVIALLY_COPYABLE(T) \
216 (std::is_trivially_copyable<T>::value)
218 #include <boost/type_traits.hpp>
219 #define FOLLY_IS_TRIVIALLY_COPYABLE(T) \
220 (boost::has_trivial_copy<T>::value && \
221 boost::has_trivial_destructor<T>::value)
223 #endif // __cplusplus
225 // MSVC specific defines
226 // mainly for posix compat
229 // this definition is in a really silly place with a silly name
230 // and ifdefing it every time we want it is painful
232 typedef SSIZE_T ssize_t;
234 // sprintf semantics are not exactly identical
235 // but current usage is not a problem
236 # define snprintf _snprintf
238 // semantics here are identical
239 # define strerror_r(errno,buf,len) strerror_s(buf,len,errno)
241 // compiler specific to compiler specific
243 # define __PRETTY_FUNCTION__ __FUNCSIG__
246 #if FOLLY_UNUSUAL_GFLAGS_NAMESPACE
247 namespace FOLLY_GFLAGS_NAMESPACE { }
249 using namespace FOLLY_GFLAGS_NAMESPACE;
250 } // namespace gflags
253 // for TARGET_OS_IPHONE
255 #include <TargetConditionals.h>
258 #endif // FOLLY_PORTABILITY_H_