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 #include <string.h>
  21
  22 #include <cstddef>
  23
  24 #ifndef FOLLY_NO_CONFIG
  25 #include <folly/folly-config.h>
  26 #endif
  27
  28 #ifdef FOLLY_PLATFORM_CONFIG
  29 #include FOLLY_PLATFORM_CONFIG
  30 #endif
  31
  32 #if FOLLY_HAVE_FEATURES_H
  33 #include <features.h>
  34 #endif
  35
  36 #include <folly/CPortability.h>
  37
  38 #ifdef __APPLE__
  39 # include <malloc/malloc.h>
  40 #endif
  41
  42 #if FOLLY_HAVE_SCHED_H
  43  #include <sched.h>
  44  #ifndef FOLLY_HAVE_PTHREAD_YIELD
  45   #define pthread_yield sched_yield
  46  #endif
  47 #endif
  48
  49 // A change in folly/MemoryMapping.cpp uses MAP_ANONYMOUS, which is named
  50 // MAP_ANON on OSX/BSD.
  51 #if defined(__APPLE__) || defined(__FreeBSD__)
  52   #include <sys/mman.h>
  53   #ifndef MAP_ANONYMOUS
  54     #ifdef MAP_ANON
  55       #define MAP_ANONYMOUS MAP_ANON
  56     #endif
  57   #endif
  58 #endif
  59
  60 // compiler specific attribute translation
  61 // msvc should come first, so if clang is in msvc mode it gets the right defines
  62
  63 #if defined(__clang__) || defined(__GNUC__)
  64 # define FOLLY_ALIGNED(size) __attribute__((__aligned__(size)))
  65 #elif defined(_MSC_VER)
  66 # define FOLLY_ALIGNED(size) __declspec(align(size))
  67 #else
  68 # error Cannot define FOLLY_ALIGNED on this platform
  69 #endif
  70 #define FOLLY_ALIGNED_MAX FOLLY_ALIGNED(alignof(std::max_align_t))
  71
  72 // NOTE: this will only do checking in msvc with versions that support /analyze
  73 #if _MSC_VER
  74 # ifdef _USE_ATTRIBUTES_FOR_SAL
  75 #    undef _USE_ATTRIBUTES_FOR_SAL
  76 # endif
  77 /* nolint */
  78 # define _USE_ATTRIBUTES_FOR_SAL 1
  79 # include <sal.h>
  80 # define FOLLY_PRINTF_FORMAT _Printf_format_string_
  81 # define FOLLY_PRINTF_FORMAT_ATTR(format_param, dots_param) /**/
  82 #else
  83 # define FOLLY_PRINTF_FORMAT /**/
  84 # define FOLLY_PRINTF_FORMAT_ATTR(format_param, dots_param) \
  85   __attribute__((__format__(__printf__, format_param, dots_param)))
  86 #endif
  87
  88 // deprecated
  89 #if defined(__clang__) || defined(__GNUC__)
  90 # define FOLLY_DEPRECATED(msg) __attribute__((__deprecated__(msg)))
  91 #elif defined(_MSC_VER)
  92 # define FOLLY_DEPRECATED(msg) __declspec(deprecated(msg))
  93 #else
  94 # define FOLLY_DEPRECATED(msg)
  95 #endif
  96
  97 // noreturn
  98 #if defined(_MSC_VER)
  99 # define FOLLY_NORETURN __declspec(noreturn)
 100 #elif defined(__clang__) || defined(__GNUC__)
 101 # define FOLLY_NORETURN __attribute__((__noreturn__))
 102 #else
 103 # define FOLLY_NORETURN
 104 #endif
 105
 106 // noinline
 107 #ifdef _MSC_VER
 108 # define FOLLY_NOINLINE __declspec(noinline)
 109 #elif defined(__clang__) || defined(__GNUC__)
 110 # define FOLLY_NOINLINE __attribute__((__noinline__))
 111 #else
 112 # define FOLLY_NOINLINE
 113 #endif
 114
 115 // always inline
 116 #ifdef _MSC_VER
 117 # define FOLLY_ALWAYS_INLINE __forceinline
 118 #elif defined(__clang__) || defined(__GNUC__)
 119 # define FOLLY_ALWAYS_INLINE inline __attribute__((__always_inline__))
 120 #else
 121 # define FOLLY_ALWAYS_INLINE inline
 122 #endif
 123
 124 // detection for 64 bit
 125 #if defined(__x86_64__) || defined(_M_X64)
 126 # define FOLLY_X64 1
 127 #else
 128 # define FOLLY_X64 0
 129 #endif
 130
 131 #if defined(__aarch64__)
 132 # define FOLLY_A64 1
 133 #else
 134 # define FOLLY_A64 0
 135 #endif
 136
 137 #if defined (__powerpc64__)
 138 # define FOLLY_PPC64 1
 139 #else
 140 # define FOLLY_PPC64 0
 141 #endif
 142
 143 // packing is very ugly in msvc
 144 #ifdef _MSC_VER
 145 # define FOLLY_PACK_ATTR /**/
 146 # define FOLLY_PACK_PUSH __pragma(pack(push, 1))
 147 # define FOLLY_PACK_POP __pragma(pack(pop))
 148 #elif defined(__clang__) || defined(__GNUC__)
 149 # define FOLLY_PACK_ATTR __attribute__((__packed__))
 150 # define FOLLY_PACK_PUSH /**/
 151 # define FOLLY_PACK_POP /**/
 152 #else
 153 # define FOLLY_PACK_ATTR /**/
 154 # define FOLLY_PACK_PUSH /**/
 155 # define FOLLY_PACK_POP /**/
 156 #endif
 157
 158 // portable version check
 159 #ifndef __GNUC_PREREQ
 160 # if defined __GNUC__ && defined __GNUC_MINOR__
 161 /* nolint */
 162 #  define __GNUC_PREREQ(maj, min) ((__GNUC__ << 16) + __GNUC_MINOR__ >= \
 163                                    ((maj) << 16) + (min))
 164 # else
 165 /* nolint */
 166 #  define __GNUC_PREREQ(maj, min) 0
 167 # endif
 168 #endif
 169
 170 #if defined(__GNUC__) && !defined(__APPLE__) && !__GNUC_PREREQ(4,9)
 171 // https://gcc.gnu.org/bugzilla/show_bug.cgi?id=56019
 172 // gcc 4.8.x incorrectly placed max_align_t in the root namespace
 173 // Alias it into std (where it's found in 4.9 and later)
 174 namespace std { typedef ::max_align_t max_align_t; }
 175 #endif
 176
 177 /* Platform specific TLS support
 178  * gcc implements __thread
 179  * msvc implements __declspec(thread)
 180  * the semantics are the same
 181  * (but remember __thread has different semantics when using emutls (ex. apple))
 182  */
 183 #if defined(_MSC_VER)
 184 # define FOLLY_TLS __declspec(thread)
 185 #elif defined(__GNUC__) || defined(__clang__)
 186 # define FOLLY_TLS __thread
 187 #else
 188 # error cannot define platform specific thread local storage
 189 #endif
 190
 191 // Define to 1 if you have the `preadv' and `pwritev' functions, respectively
 192 #if !defined(FOLLY_HAVE_PREADV) && !defined(FOLLY_HAVE_PWRITEV)
 193 # if defined(__GLIBC_PREREQ)
 194 #  if __GLIBC_PREREQ(2, 10)
 195 #   define FOLLY_HAVE_PREADV 1
 196 #   define FOLLY_HAVE_PWRITEV 1
 197 #  endif
 198 # endif
 199 #endif
 200
 201 // It turns out that GNU libstdc++ and LLVM libc++ differ on how they implement
 202 // the 'std' namespace; the latter uses inline namepsaces. Wrap this decision
 203 // up in a macro to make forward-declarations easier.
 204 #if FOLLY_USE_LIBCPP
 205 #include <__config>
 206 #define FOLLY_NAMESPACE_STD_BEGIN     _LIBCPP_BEGIN_NAMESPACE_STD
 207 #define FOLLY_NAMESPACE_STD_END       _LIBCPP_END_NAMESPACE_STD
 208 #else
 209 #define FOLLY_NAMESPACE_STD_BEGIN     namespace std {
 210 #define FOLLY_NAMESPACE_STD_END       }
 211 #endif
 212
 213 // If the new c++ ABI is used, __cxx11 inline namespace needs to be added to
 214 // some types, e.g. std::list.
 215 #if _GLIBCXX_USE_CXX11_ABI
 216 # define FOLLY_GLIBCXX_NAMESPACE_CXX11_BEGIN _GLIBCXX_BEGIN_NAMESPACE_CXX11
 217 # define FOLLY_GLIBCXX_NAMESPACE_CXX11_END   _GLIBCXX_END_NAMESPACE_CXX11
 218 #else
 219 # define FOLLY_GLIBCXX_NAMESPACE_CXX11_BEGIN
 220 # define FOLLY_GLIBCXX_NAMESPACE_CXX11_END
 221 #endif
 222
 223 // Some platforms lack clock_gettime(2) and clock_getres(2). Inject our own
 224 // versions of these into the global namespace.
 225 #if FOLLY_HAVE_CLOCK_GETTIME
 226 #include <time.h>
 227 #else
 228 #include <folly/detail/Clock.h>
 229 #endif
 230
 231 // Provide our own std::__throw_* wrappers for platforms that don't have them
 232 #if FOLLY_HAVE_BITS_FUNCTEXCEPT_H
 233 #include <bits/functexcept.h>
 234 #else
 235 #include <folly/detail/FunctionalExcept.h>
 236 #endif
 237
 238 #if defined(__cplusplus)
 239 // Unfortunately, boost::has_trivial_copy<T> is broken in libc++ due to its
 240 // usage of __has_trivial_copy(), so we can't use it as a
 241 // least-common-denominator for C++11 implementations that don't support
 242 // std::is_trivially_copyable<T>.
 243 //
 244 //      http://stackoverflow.com/questions/12754886/has-trivial-copy-behaves-differently-in-clang-and-gcc-whos-right
 245 //
 246 // As a result, use std::is_trivially_copyable() where it exists, and fall back
 247 // to Boost otherwise.
 248 #if FOLLY_HAVE_STD__IS_TRIVIALLY_COPYABLE
 249 #include <type_traits>
 250 #define FOLLY_IS_TRIVIALLY_COPYABLE(T)                   \
 251   (std::is_trivially_copyable<T>::value)
 252 #else
 253 #include <boost/type_traits.hpp>
 254 #define FOLLY_IS_TRIVIALLY_COPYABLE(T)                   \
 255   (boost::has_trivial_copy<T>::value &&                  \
 256    boost::has_trivial_destructor<T>::value)
 257 #endif
 258 #endif // __cplusplus
 259
 260 // MSVC specific defines
 261 // mainly for posix compat
 262 #ifdef _MSC_VER
 263
 264 // this definition is in a really silly place with a silly name
 265 // and ifdefing it every time we want it is painful
 266 #include <basetsd.h>
 267 typedef SSIZE_T ssize_t;
 268
 269 // sprintf semantics are not exactly identical
 270 // but current usage is not a problem
 271 # define snprintf _snprintf
 272
 273 // semantics here are identical
 274 # define strerror_r(errno,buf,len) strerror_s(buf,len,errno)
 275
 276 // compiler specific to compiler specific
 277 // nolint
 278 # define __PRETTY_FUNCTION__ __FUNCSIG__
 279
 280 // Hide a GCC specific thing that breaks MSVC if left alone.
 281 # define __extension__
 282
 283 #ifdef _M_IX86_FP
 284 # define FOLLY_SSE _M_IX86_FP
 285 # define FOLLY_SSE_MINOR 0
 286 #endif
 287
 288 #endif
 289
 290 #ifndef FOLLY_SSE
 291 # if defined(__SSE4_2__)
 292 #  define FOLLY_SSE 4
 293 #  define FOLLY_SSE_MINOR 2
 294 # elif defined(__SSE4_1__)
 295 #  define FOLLY_SSE 4
 296 #  define FOLLY_SSE_MINOR 1
 297 # elif defined(__SSE4__)
 298 #  define FOLLY_SSE 4
 299 #  define FOLLY_SSE_MINOR 0
 300 # elif defined(__SSE3__)
 301 #  define FOLLY_SSE 3
 302 #  define FOLLY_SSE_MINOR 0
 303 # elif defined(__SSE2__)
 304 #  define FOLLY_SSE 2
 305 #  define FOLLY_SSE_MINOR 0
 306 # elif defined(__SSE__)
 307 #  define FOLLY_SSE 1
 308 #  define FOLLY_SSE_MINOR 0
 309 # else
 310 #  define FOLLY_SSE 0
 311 #  define FOLLY_SSE_MINOR 0
 312 # endif
 313 #endif
 314
 315 #define FOLLY_SSE_PREREQ(major, minor) \
 316   (FOLLY_SSE > major || FOLLY_SSE == major && FOLLY_SSE_MINOR >= minor)
 317
 318 #if FOLLY_UNUSUAL_GFLAGS_NAMESPACE
 319 namespace FOLLY_GFLAGS_NAMESPACE { }
 320 namespace gflags {
 321 using namespace FOLLY_GFLAGS_NAMESPACE;
 322 }  // namespace gflags
 323 #endif
 324
 325 // for TARGET_OS_IPHONE
 326 #ifdef __APPLE__
 327 #include <TargetConditionals.h>
 328 #endif
 329
 330 // MacOS doesn't have malloc_usable_size()
 331 #if defined(__APPLE__) && !defined(FOLLY_HAVE_MALLOC_USABLE_SIZE)
 332 inline size_t malloc_usable_size(void* ptr) {
 333   return malloc_size(ptr);
 334 }
 335 #endif
 336
 337 // RTTI may not be enabled for this compilation unit.
 338 #if defined(__GXX_RTTI) || defined(__cpp_rtti) || \
 339     (defined(_MSC_VER) && defined(_CPPRTTI))
 340 # define FOLLY_HAS_RTTI 1
 341 #endif
 342
 343 #ifdef _MSC_VER
 344 # include <intrin.h>
 345 #endif
 346
 347 namespace folly {
 348
 349 inline void asm_volatile_memory() {
 350 #if defined(__clang__) || defined(__GNUC__)
 351   asm volatile("" : : : "memory");
 352 #elif defined(_MSC_VER)
 353   ::_ReadWriteBarrier();
 354 #endif
 355 }
 356
 357 inline void asm_volatile_pause() {
 358 #if defined(_MSC_VER) && (defined(_M_IX86) || defined(_M_X64))
 359   ::_mm_pause();
 360 #elif defined(__i386__) || FOLLY_X64
 361   asm volatile ("pause");
 362 #elif FOLLY_A64
 363   asm volatile ("wfe");
 364 #elif FOLLY_PPC64
 365   asm volatile("or 27,27,27");
 366 #endif
 367 }
 368 inline void asm_pause() {
 369 #if defined(_MSC_VER) && (defined(_M_IX86) || defined(_M_X64))
 370   ::_mm_pause();
 371 #elif defined(__i386__) || FOLLY_X64
 372   asm ("pause");
 373 #elif FOLLY_A64
 374   asm ("wfe");
 375 #elif FOLLY_PPC64
 376   asm ("or 31,31,31");
 377 #endif
 378 }
 379
 380 constexpr size_t constexpr_strlen(const char* s) {
 381 #if defined(__clang__)
 382   return __builtin_strlen(s);
 383 #else
 384   return strlen(s);
 385 #endif
 386 }
 387
 388 } // namespace folly
 389 #endif // FOLLY_PORTABILITY_H_