folly/Portability.h

   1 /*
   2  * Copyright 2015 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 #ifndef FOLLY_PORTABILITY_H_
  18 #define FOLLY_PORTABILITY_H_
  19
  20 #ifndef FOLLY_NO_CONFIG
  21 #include <folly/folly-config.h>
  22 #endif
  23
  24 #ifdef FOLLY_PLATFORM_CONFIG
  25 #include FOLLY_PLATFORM_CONFIG
  26 #endif
  27
  28 #if FOLLY_HAVE_FEATURES_H
  29 #include <features.h>
  30 #endif
  31
  32 #include <folly/CPortability.h>
  33
  34 #ifdef __APPLE__
  35 # include <malloc/malloc.h>
  36 #endif
  37
  38 #if FOLLY_HAVE_SCHED_H
  39  #include <sched.h>
  40  #ifndef FOLLY_HAVE_PTHREAD_YIELD
  41   #define pthread_yield sched_yield
  42  #endif
  43 #endif
  44
  45 // A change in folly/MemoryMapping.cpp uses MAP_ANONYMOUS, which is named
  46 // MAP_ANON on OSX/BSD.
  47 #if defined(__APPLE__) || defined(__FreeBSD__)
  48   #include <sys/mman.h>
  49   #ifndef MAP_ANONYMOUS
  50     #ifdef MAP_ANON
  51       #define MAP_ANONYMOUS MAP_ANON
  52     #endif
  53   #endif
  54 #endif
  55
  56 // MaxAlign: max_align_t isn't supported by gcc
  57 #ifdef __GNUC__
  58 struct MaxAlign { char c; } __attribute__((__aligned__));
  59 #else /* !__GNUC__ */
  60 # error Cannot define MaxAlign on this platform
  61 #endif
  62
  63 // compiler specific attribute translation
  64 // msvc should come first, so if clang is in msvc mode it gets the right defines
  65
  66 // NOTE: this will only do checking in msvc with versions that support /analyze
  67 #if _MSC_VER
  68 # ifdef _USE_ATTRIBUTES_FOR_SAL
  69 #    undef _USE_ATTRIBUTES_FOR_SAL
  70 # endif
  71 /* nolint */
  72 # define _USE_ATTRIBUTES_FOR_SAL 1
  73 # include <sal.h>
  74 # define FOLLY_PRINTF_FORMAT _Printf_format_string_
  75 # define FOLLY_PRINTF_FORMAT_ATTR(format_param, dots_param) /**/
  76 #else
  77 # define FOLLY_PRINTF_FORMAT /**/
  78 # define FOLLY_PRINTF_FORMAT_ATTR(format_param, dots_param) \
  79   __attribute__((__format__(__printf__, format_param, dots_param)))
  80 #endif
  81
  82 // deprecated
  83 #if defined(__clang__) || defined(__GNUC__)
  84 # define FOLLY_DEPRECATED(msg) __attribute__((__deprecated__(msg)))
  85 #else
  86 # define FOLLY_DEPRECATED
  87 #endif
  88
  89 // noreturn
  90 #if defined(_MSC_VER)
  91 # define FOLLY_NORETURN __declspec(noreturn)
  92 #elif defined(__clang__) || defined(__GNUC__)
  93 # define FOLLY_NORETURN __attribute__((__noreturn__))
  94 #else
  95 # define FOLLY_NORETURN
  96 #endif
  97
  98 // noinline
  99 #ifdef _MSC_VER
 100 # define FOLLY_NOINLINE __declspec(noinline)
 101 #elif defined(__clang__) || defined(__GNUC__)
 102 # define FOLLY_NOINLINE __attribute__((__noinline__))
 103 #else
 104 # define FOLLY_NOINLINE
 105 #endif
 106
 107 // always inline
 108 #ifdef _MSC_VER
 109 # define FOLLY_ALWAYS_INLINE __forceinline
 110 #elif defined(__clang__) || defined(__GNUC__)
 111 # define FOLLY_ALWAYS_INLINE inline __attribute__((__always_inline__))
 112 #else
 113 # define FOLLY_ALWAYS_INLINE
 114 #endif
 115
 116 // detection for 64 bit
 117 #if defined(__x86_64__) || defined(_M_X64)
 118 # define FOLLY_X64 1
 119 #else
 120 # define FOLLY_X64 0
 121 #endif
 122
 123 // packing is very ugly in msvc
 124 #ifdef _MSC_VER
 125 # define FOLLY_PACK_ATTR /**/
 126 # define FOLLY_PACK_PUSH __pragma(pack(push, 1))
 127 # define FOLLY_PACK_POP __pragma(pack(pop))
 128 #elif defined(__clang__) || defined(__GNUC__)
 129 # define FOLLY_PACK_ATTR __attribute__((__packed__))
 130 # define FOLLY_PACK_PUSH /**/
 131 # define FOLLY_PACK_POP /**/
 132 #else
 133 # define FOLLY_PACK_ATTR /**/
 134 # define FOLLY_PACK_PUSH /**/
 135 # define FOLLY_PACK_POP /**/
 136 #endif
 137
 138 // portable version check
 139 #ifndef __GNUC_PREREQ
 140 # if defined __GNUC__ && defined __GNUC_MINOR__
 141 /* nolint */
 142 #  define __GNUC_PREREQ(maj, min) ((__GNUC__ << 16) + __GNUC_MINOR__ >= \
 143                                    ((maj) << 16) + (min))
 144 # else
 145 /* nolint */
 146 #  define __GNUC_PREREQ(maj, min) 0
 147 # endif
 148 #endif
 149
 150
 151 /* Define macro wrappers for C++11's "final" and "override" keywords, which
 152  * are supported in gcc 4.7 but not gcc 4.6. */
 153 #if !defined(FOLLY_FINAL) && !defined(FOLLY_OVERRIDE)
 154 # if defined(__clang__) || __GNUC_PREREQ(4, 7)
 155 #  define FOLLY_FINAL final
 156 #  define FOLLY_OVERRIDE override
 157 # else
 158 #  define FOLLY_FINAL /**/
 159 #  define FOLLY_OVERRIDE /**/
 160 # endif
 161 #endif
 162
 163 /* Platform specific TLS support
 164  * gcc implements __thread
 165  * msvc implements __declspec(thread)
 166  * the semantics are the same
 167  * (but remember __thread has different semantics when using emutls (ex. apple))
 168  */
 169 #if defined(_MSC_VER)
 170 # define FOLLY_TLS __declspec(thread)
 171 #elif defined(__GNUC__) || defined(__clang__)
 172 # define FOLLY_TLS __thread
 173 #else
 174 # error cannot define platform specific thread local storage
 175 #endif
 176
 177 // Define to 1 if you have the `preadv' and `pwritev' functions, respectively
 178 #if !defined(FOLLY_HAVE_PREADV) && !defined(FOLLY_HAVE_PWRITEV)
 179 # if defined(__GLIBC_PREREQ)
 180 #  if __GLIBC_PREREQ(2, 10)
 181 #   define FOLLY_HAVE_PREADV 1
 182 #   define FOLLY_HAVE_PWRITEV 1
 183 #  endif
 184 # endif
 185 #endif
 186
 187 // It turns out that GNU libstdc++ and LLVM libc++ differ on how they implement
 188 // the 'std' namespace; the latter uses inline namepsaces. Wrap this decision
 189 // up in a macro to make forward-declarations easier.
 190 #if FOLLY_USE_LIBCPP
 191 #include <__config>
 192 #define FOLLY_NAMESPACE_STD_BEGIN     _LIBCPP_BEGIN_NAMESPACE_STD
 193 #define FOLLY_NAMESPACE_STD_END       _LIBCPP_END_NAMESPACE_STD
 194 #else
 195 #define FOLLY_NAMESPACE_STD_BEGIN     namespace std {
 196 #define FOLLY_NAMESPACE_STD_END       }
 197 #endif
 198
 199 // Some platforms lack clock_gettime(2) and clock_getres(2). Inject our own
 200 // versions of these into the global namespace.
 201 #if FOLLY_HAVE_CLOCK_GETTIME
 202 #include <time.h>
 203 #else
 204 #include <folly/detail/Clock.h>
 205 #endif
 206
 207 // Provide our own std::__throw_* wrappers for platforms that don't have them
 208 #if FOLLY_HAVE_BITS_FUNCTEXCEPT_H
 209 #include <bits/functexcept.h>
 210 #else
 211 #include <folly/detail/FunctionalExcept.h>
 212 #endif
 213
 214 #if defined(__cplusplus)
 215 // Unfortunately, boost::has_trivial_copy<T> is broken in libc++ due to its
 216 // usage of __has_trivial_copy(), so we can't use it as a
 217 // least-common-denominator for C++11 implementations that don't support
 218 // std::is_trivially_copyable<T>.
 219 //
 220 //      http://stackoverflow.com/questions/12754886/has-trivial-copy-behaves-differently-in-clang-and-gcc-whos-right
 221 //
 222 // As a result, use std::is_trivially_copyable() where it exists, and fall back
 223 // to Boost otherwise.
 224 #if FOLLY_HAVE_STD__IS_TRIVIALLY_COPYABLE
 225 #include <type_traits>
 226 #define FOLLY_IS_TRIVIALLY_COPYABLE(T)                   \
 227   (std::is_trivially_copyable<T>::value)
 228 #else
 229 #include <boost/type_traits.hpp>
 230 #define FOLLY_IS_TRIVIALLY_COPYABLE(T)                   \
 231   (boost::has_trivial_copy<T>::value &&                  \
 232    boost::has_trivial_destructor<T>::value)
 233 #endif
 234 #endif // __cplusplus
 235
 236 // MSVC specific defines
 237 // mainly for posix compat
 238 #ifdef _MSC_VER
 239
 240 // this definition is in a really silly place with a silly name
 241 // and ifdefing it every time we want it is painful
 242 #include <basetsd.h>
 243 typedef SSIZE_T ssize_t;
 244
 245 // sprintf semantics are not exactly identical
 246 // but current usage is not a problem
 247 # define snprintf _snprintf
 248
 249 // semantics here are identical
 250 # define strerror_r(errno,buf,len) strerror_s(buf,len,errno)
 251
 252 // compiler specific to compiler specific
 253 // nolint
 254 # define __PRETTY_FUNCTION__ __FUNCSIG__
 255 #endif
 256
 257 #if FOLLY_UNUSUAL_GFLAGS_NAMESPACE
 258 namespace FOLLY_GFLAGS_NAMESPACE { }
 259 namespace gflags {
 260 using namespace FOLLY_GFLAGS_NAMESPACE;
 261 }  // namespace gflags
 262 #endif
 263
 264 // for TARGET_OS_IPHONE
 265 #ifdef __APPLE__
 266 #include <TargetConditionals.h>
 267 #endif
 268
 269 // MacOS doesn't have malloc_usable_size()
 270 #if defined(__APPLE__) && !defined(FOLLY_HAVE_MALLOC_USABLE_SIZE)
 271 inline size_t malloc_usable_size(void* ptr) {
 272   return malloc_size(ptr);
 273 }
 274 #endif
 275
 276 #endif // FOLLY_PORTABILITY_H_