folly/Portability.h

   1 /*
   2  * Copyright 2017 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 // warn unused result
  78 #if defined(_MSC_VER) && (_MSC_VER >= 1700)
  79 #define FOLLY_WARN_UNUSED_RESULT _Check_return_
  80 #elif defined(__clang__) || defined(__GNUC__)
  81 #define FOLLY_WARN_UNUSED_RESULT __attribute__((__warn_unused_result__))
  82 #else
  83 #define FOLLY_WARN_UNUSED_RESULT
  84 #endif
  85
  86 // target
  87 #ifdef _MSC_VER
  88 # define FOLLY_TARGET_ATTRIBUTE(target)
  89 #else
  90 # define FOLLY_TARGET_ATTRIBUTE(target) __attribute__((__target__(target)))
  91 #endif
  92
  93 // detection for 64 bit
  94 #if defined(__x86_64__) || defined(_M_X64)
  95 # define FOLLY_X64 1
  96 #else
  97 # define FOLLY_X64 0
  98 #endif
  99
 100 #if defined(__aarch64__)
 101 # define FOLLY_A64 1
 102 #else
 103 # define FOLLY_A64 0
 104 #endif
 105
 106 #if defined (__powerpc64__)
 107 # define FOLLY_PPC64 1
 108 #else
 109 # define FOLLY_PPC64 0
 110 #endif
 111
 112 namespace folly {
 113 constexpr bool kIsArchAmd64 = FOLLY_X64 == 1;
 114 constexpr bool kIsArchAArch64 = FOLLY_A64 == 1;
 115 constexpr bool kIsArchPPC64 = FOLLY_PPC64 == 1;
 116 }
 117
 118 // packing is very ugly in msvc
 119 #ifdef _MSC_VER
 120 # define FOLLY_PACK_ATTR /**/
 121 # define FOLLY_PACK_PUSH __pragma(pack(push, 1))
 122 # define FOLLY_PACK_POP __pragma(pack(pop))
 123 #elif defined(__clang__) || defined(__GNUC__)
 124 # define FOLLY_PACK_ATTR __attribute__((__packed__))
 125 # define FOLLY_PACK_PUSH /**/
 126 # define FOLLY_PACK_POP /**/
 127 #else
 128 # define FOLLY_PACK_ATTR /**/
 129 # define FOLLY_PACK_PUSH /**/
 130 # define FOLLY_PACK_POP /**/
 131 #endif
 132
 133 // Generalize warning push/pop.
 134 #if defined(_MSC_VER)
 135 # define FOLLY_PUSH_WARNING __pragma(warning(push))
 136 # define FOLLY_POP_WARNING __pragma(warning(pop))
 137 // Disable the GCC warnings.
 138 # define FOLLY_GCC_DISABLE_WARNING(warningName)
 139 # define FOLLY_MSVC_DISABLE_WARNING(warningNumber) __pragma(warning(disable: warningNumber))
 140 #elif defined(__clang__) || defined(__GNUC__)
 141 # define FOLLY_PUSH_WARNING _Pragma("GCC diagnostic push")
 142 # define FOLLY_POP_WARNING _Pragma("GCC diagnostic pop")
 143 #define FOLLY_GCC_DISABLE_WARNING_INTERNAL3(warningName) #warningName
 144 #define FOLLY_GCC_DISABLE_WARNING_INTERNAL2(warningName) \
 145   FOLLY_GCC_DISABLE_WARNING_INTERNAL3(warningName)
 146 #define FOLLY_GCC_DISABLE_WARNING(warningName)                       \
 147   _Pragma(FOLLY_GCC_DISABLE_WARNING_INTERNAL2(GCC diagnostic ignored \
 148           FOLLY_GCC_DISABLE_WARNING_INTERNAL3(-W##warningName)))
 149 // Disable the MSVC warnings.
 150 # define FOLLY_MSVC_DISABLE_WARNING(warningNumber)
 151 #else
 152 # define FOLLY_PUSH_WARNING
 153 # define FOLLY_POP_WARNING
 154 # define FOLLY_GCC_DISABLE_WARNING(warningName)
 155 # define FOLLY_MSVC_DISABLE_WARNING(warningNumber)
 156 #endif
 157
 158 #ifdef HAVE_SHADOW_LOCAL_WARNINGS
 159 #define FOLLY_GCC_DISABLE_NEW_SHADOW_WARNINGS        \
 160   FOLLY_GCC_DISABLE_WARNING(shadow-compatible-local) \
 161   FOLLY_GCC_DISABLE_WARNING(shadow-local)
 162 #else
 163 #define FOLLY_GCC_DISABLE_NEW_SHADOW_WARNINGS /* empty */
 164 #endif
 165
 166 #if defined(__GNUC__) && !defined(__APPLE__) && !__GNUC_PREREQ(4,9)
 167 // https://gcc.gnu.org/bugzilla/show_bug.cgi?id=56019
 168 // gcc 4.8.x incorrectly placed max_align_t in the root namespace
 169 // Alias it into std (where it's found in 4.9 and later)
 170 namespace std { typedef ::max_align_t max_align_t; }
 171 #endif
 172
 173 // portable version check for clang
 174 #ifndef __CLANG_PREREQ
 175 # if defined __clang__ && defined __clang_major__ && defined __clang_minor__
 176 /* nolint */
 177 #  define __CLANG_PREREQ(maj, min) \
 178     ((__clang_major__ << 16) + __clang_minor__ >= ((maj) << 16) + (min))
 179 # else
 180 /* nolint */
 181 #  define __CLANG_PREREQ(maj, min) 0
 182 # endif
 183 #endif
 184
 185 /* Platform specific TLS support
 186  * gcc implements __thread
 187  * msvc implements __declspec(thread)
 188  * the semantics are the same
 189  * (but remember __thread has different semantics when using emutls (ex. apple))
 190  */
 191 #if defined(_MSC_VER)
 192 # define FOLLY_TLS __declspec(thread)
 193 #elif defined(__GNUC__) || defined(__clang__)
 194 # define FOLLY_TLS __thread
 195 #else
 196 # error cannot define platform specific thread local storage
 197 #endif
 198
 199 #if FOLLY_MOBILE
 200 #undef FOLLY_TLS
 201 #endif
 202
 203 // It turns out that GNU libstdc++ and LLVM libc++ differ on how they implement
 204 // the 'std' namespace; the latter uses inline namespaces. Wrap this decision
 205 // up in a macro to make forward-declarations easier.
 206 #if FOLLY_USE_LIBCPP
 207 #include <__config>
 208 #define FOLLY_NAMESPACE_STD_BEGIN     _LIBCPP_BEGIN_NAMESPACE_STD
 209 #define FOLLY_NAMESPACE_STD_END       _LIBCPP_END_NAMESPACE_STD
 210 #else
 211 #define FOLLY_NAMESPACE_STD_BEGIN     namespace std {
 212 #define FOLLY_NAMESPACE_STD_END       }
 213 #endif
 214
 215 // If the new c++ ABI is used, __cxx11 inline namespace needs to be added to
 216 // some types, e.g. std::list.
 217 #if _GLIBCXX_USE_CXX11_ABI
 218 #define FOLLY_GLIBCXX_NAMESPACE_CXX11_BEGIN \
 219   inline _GLIBCXX_BEGIN_NAMESPACE_CXX11
 220 # define FOLLY_GLIBCXX_NAMESPACE_CXX11_END   _GLIBCXX_END_NAMESPACE_CXX11
 221 #else
 222 # define FOLLY_GLIBCXX_NAMESPACE_CXX11_BEGIN
 223 # define FOLLY_GLIBCXX_NAMESPACE_CXX11_END
 224 #endif
 225
 226 // MSVC specific defines
 227 // mainly for posix compat
 228 #ifdef _MSC_VER
 229 #include <folly/portability/SysTypes.h>
 230
 231 // compiler specific to compiler specific
 232 // nolint
 233 # define __PRETTY_FUNCTION__ __FUNCSIG__
 234
 235 // Hide a GCC specific thing that breaks MSVC if left alone.
 236 # define __extension__
 237
 238 // We have compiler support for the newest of the new, but
 239 // MSVC doesn't tell us that.
 240 #define __SSE4_2__ 1
 241
 242 #endif
 243
 244 // Debug
 245 namespace folly {
 246 #ifdef NDEBUG
 247 constexpr auto kIsDebug = false;
 248 #else
 249 constexpr auto kIsDebug = true;
 250 #endif
 251 }
 252
 253 // Endianness
 254 namespace folly {
 255 #ifdef _MSC_VER
 256 // It's MSVC, so we just have to guess ... and allow an override
 257 #ifdef FOLLY_ENDIAN_BE
 258 constexpr auto kIsLittleEndian = false;
 259 #else
 260 constexpr auto kIsLittleEndian = true;
 261 #endif
 262 #else
 263 constexpr auto kIsLittleEndian = __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__;
 264 #endif
 265 constexpr auto kIsBigEndian = !kIsLittleEndian;
 266 }
 267
 268 #ifndef FOLLY_SSE
 269 # if defined(__SSE4_2__)
 270 #  define FOLLY_SSE 4
 271 #  define FOLLY_SSE_MINOR 2
 272 # elif defined(__SSE4_1__)
 273 #  define FOLLY_SSE 4
 274 #  define FOLLY_SSE_MINOR 1
 275 # elif defined(__SSE4__)
 276 #  define FOLLY_SSE 4
 277 #  define FOLLY_SSE_MINOR 0
 278 # elif defined(__SSE3__)
 279 #  define FOLLY_SSE 3
 280 #  define FOLLY_SSE_MINOR 0
 281 # elif defined(__SSE2__)
 282 #  define FOLLY_SSE 2
 283 #  define FOLLY_SSE_MINOR 0
 284 # elif defined(__SSE__)
 285 #  define FOLLY_SSE 1
 286 #  define FOLLY_SSE_MINOR 0
 287 # else
 288 #  define FOLLY_SSE 0
 289 #  define FOLLY_SSE_MINOR 0
 290 # endif
 291 #endif
 292
 293 #define FOLLY_SSE_PREREQ(major, minor) \
 294   (FOLLY_SSE > major || FOLLY_SSE == major && FOLLY_SSE_MINOR >= minor)
 295
 296 #if FOLLY_UNUSUAL_GFLAGS_NAMESPACE
 297 namespace FOLLY_GFLAGS_NAMESPACE { }
 298 namespace gflags {
 299 using namespace FOLLY_GFLAGS_NAMESPACE;
 300 }  // namespace gflags
 301 #endif
 302
 303 // for TARGET_OS_IPHONE
 304 #ifdef __APPLE__
 305 #include <TargetConditionals.h>
 306 #endif
 307
 308 // RTTI may not be enabled for this compilation unit.
 309 #if defined(__GXX_RTTI) || defined(__cpp_rtti) || \
 310     (defined(_MSC_VER) && defined(_CPPRTTI))
 311 # define FOLLY_HAS_RTTI 1
 312 #endif
 313
 314 #if defined(__APPLE__) || defined(_MSC_VER)
 315 #define FOLLY_STATIC_CTOR_PRIORITY_MAX
 316 #else
 317 // 101 is the highest priority allowed by the init_priority attribute.
 318 // This priority is already used by JEMalloc and other memory allocators so
 319 // we will take the next one.
 320 #define FOLLY_STATIC_CTOR_PRIORITY_MAX __attribute__((__init_priority__(102)))
 321 #endif
 322
 323 namespace folly {
 324
 325 #if defined(__linux__) && !FOLLY_MOBILE
 326 constexpr auto kIsLinux = true;
 327 #else
 328 constexpr auto kIsLinux = false;
 329 #endif
 330
 331 #if defined(_WIN32)
 332 constexpr auto kIsWindows = true;
 333 #else
 334 constexpr auto kIsWindows = false;
 335 #endif
 336 }