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 // Unaligned loads and stores
  28 namespace folly {
  29 #if FOLLY_HAVE_UNALIGNED_ACCESS
  30 constexpr bool kHasUnalignedAccess = true;
  31 #else
  32 constexpr bool kHasUnalignedAccess = false;
  33 #endif
  34 }
  35
  36 // compiler specific attribute translation
  37 // msvc should come first, so if clang is in msvc mode it gets the right defines
  38
  39 #if defined(__clang__) || defined(__GNUC__)
  40 # define FOLLY_ALIGNED(size) __attribute__((__aligned__(size)))
  41 #elif defined(_MSC_VER)
  42 # define FOLLY_ALIGNED(size) __declspec(align(size))
  43 #else
  44 # error Cannot define FOLLY_ALIGNED on this platform
  45 #endif
  46 #define FOLLY_ALIGNED_MAX FOLLY_ALIGNED(alignof(std::max_align_t))
  47
  48 // NOTE: this will only do checking in msvc with versions that support /analyze
  49 #if _MSC_VER
  50 # ifdef _USE_ATTRIBUTES_FOR_SAL
  51 #    undef _USE_ATTRIBUTES_FOR_SAL
  52 # endif
  53 /* nolint */
  54 # define _USE_ATTRIBUTES_FOR_SAL 1
  55 # include <sal.h> // @manual
  56 # define FOLLY_PRINTF_FORMAT _Printf_format_string_
  57 # define FOLLY_PRINTF_FORMAT_ATTR(format_param, dots_param) /**/
  58 #else
  59 # define FOLLY_PRINTF_FORMAT /**/
  60 # define FOLLY_PRINTF_FORMAT_ATTR(format_param, dots_param) \
  61   __attribute__((__format__(__printf__, format_param, dots_param)))
  62 #endif
  63
  64 // deprecated
  65 #if defined(__clang__) || defined(__GNUC__)
  66 # define FOLLY_DEPRECATED(msg) __attribute__((__deprecated__(msg)))
  67 #elif defined(_MSC_VER)
  68 # define FOLLY_DEPRECATED(msg) __declspec(deprecated(msg))
  69 #else
  70 # define FOLLY_DEPRECATED(msg)
  71 #endif
  72
  73 // warn unused result
  74 #if defined(__has_cpp_attribute)
  75 #if __has_cpp_attribute(nodiscard)
  76 #define FOLLY_NODISCARD [[nodiscard]]
  77 #endif
  78 #endif
  79 #if !defined FOLLY_NODISCARD
  80 #if defined(_MSC_VER) && (_MSC_VER >= 1700)
  81 #define FOLLY_NODISCARD _Check_return_
  82 #elif defined(__clang__) || defined(__GNUC__)
  83 #define FOLLY_NODISCARD __attribute__((__warn_unused_result__))
  84 #else
  85 #define FOLLY_NODISCARD
  86 #endif
  87 #endif
  88
  89 // target
  90 #ifdef _MSC_VER
  91 # define FOLLY_TARGET_ATTRIBUTE(target)
  92 #else
  93 # define FOLLY_TARGET_ATTRIBUTE(target) __attribute__((__target__(target)))
  94 #endif
  95
  96 // detection for 64 bit
  97 #if defined(__x86_64__) || defined(_M_X64)
  98 # define FOLLY_X64 1
  99 #else
 100 # define FOLLY_X64 0
 101 #endif
 102
 103 #if defined(__aarch64__)
 104 # define FOLLY_A64 1
 105 #else
 106 # define FOLLY_A64 0
 107 #endif
 108
 109 #if defined (__powerpc64__)
 110 # define FOLLY_PPC64 1
 111 #else
 112 # define FOLLY_PPC64 0
 113 #endif
 114
 115 namespace folly {
 116 constexpr bool kIsArchAmd64 = FOLLY_X64 == 1;
 117 constexpr bool kIsArchAArch64 = FOLLY_A64 == 1;
 118 constexpr bool kIsArchPPC64 = FOLLY_PPC64 == 1;
 119 }
 120
 121 namespace folly {
 122
 123 #if FOLLY_SANITIZE_ADDRESS
 124 constexpr bool kIsSanitizeAddress = true;
 125 #else
 126 constexpr bool kIsSanitizeAddress = false;
 127 #endif
 128
 129 #if FOLLY_SANITIZE_THREAD
 130 constexpr bool kIsSanitizeThread = true;
 131 #else
 132 constexpr bool kIsSanitizeThread = false;
 133 #endif
 134 }
 135
 136 // packing is very ugly in msvc
 137 #ifdef _MSC_VER
 138 # define FOLLY_PACK_ATTR /**/
 139 # define FOLLY_PACK_PUSH __pragma(pack(push, 1))
 140 # define FOLLY_PACK_POP __pragma(pack(pop))
 141 #elif defined(__clang__) || defined(__GNUC__)
 142 # define FOLLY_PACK_ATTR __attribute__((__packed__))
 143 # define FOLLY_PACK_PUSH /**/
 144 # define FOLLY_PACK_POP /**/
 145 #else
 146 # define FOLLY_PACK_ATTR /**/
 147 # define FOLLY_PACK_PUSH /**/
 148 # define FOLLY_PACK_POP /**/
 149 #endif
 150
 151 // Generalize warning push/pop.
 152 #if defined(_MSC_VER)
 153 # define FOLLY_PUSH_WARNING __pragma(warning(push))
 154 # define FOLLY_POP_WARNING __pragma(warning(pop))
 155 // Disable the GCC warnings.
 156 # define FOLLY_GCC_DISABLE_WARNING(warningName)
 157 # define FOLLY_MSVC_DISABLE_WARNING(warningNumber) __pragma(warning(disable: warningNumber))
 158 #elif defined(__clang__) || defined(__GNUC__)
 159 # define FOLLY_PUSH_WARNING _Pragma("GCC diagnostic push")
 160 # define FOLLY_POP_WARNING _Pragma("GCC diagnostic pop")
 161 # define FOLLY_GCC_DISABLE_WARNING_INTERNAL2(warningName) #warningName
 162 # define FOLLY_GCC_DISABLE_WARNING(warningName) \
 163   _Pragma(                                      \
 164   FOLLY_GCC_DISABLE_WARNING_INTERNAL2(GCC diagnostic ignored warningName))
 165 // Disable the MSVC warnings.
 166 # define FOLLY_MSVC_DISABLE_WARNING(warningNumber)
 167 #else
 168 # define FOLLY_PUSH_WARNING
 169 # define FOLLY_POP_WARNING
 170 # define FOLLY_GCC_DISABLE_WARNING(warningName)
 171 # define FOLLY_MSVC_DISABLE_WARNING(warningNumber)
 172 #endif
 173
 174 #ifdef HAVE_SHADOW_LOCAL_WARNINGS
 175 #define FOLLY_GCC_DISABLE_NEW_SHADOW_WARNINGS        \
 176   FOLLY_GCC_DISABLE_WARNING("-Wshadow-compatible-local") \
 177   FOLLY_GCC_DISABLE_WARNING("-Wshadow-local")
 178 #else
 179 #define FOLLY_GCC_DISABLE_NEW_SHADOW_WARNINGS /* empty */
 180 #endif
 181
 182 // portable version check for clang
 183 #ifndef __CLANG_PREREQ
 184 # if defined __clang__ && defined __clang_major__ && defined __clang_minor__
 185 /* nolint */
 186 #  define __CLANG_PREREQ(maj, min) \
 187     ((__clang_major__ << 16) + __clang_minor__ >= ((maj) << 16) + (min))
 188 # else
 189 /* nolint */
 190 #  define __CLANG_PREREQ(maj, min) 0
 191 # endif
 192 #endif
 193
 194 /* Platform specific TLS support
 195  * gcc implements __thread
 196  * msvc implements __declspec(thread)
 197  * the semantics are the same
 198  * (but remember __thread has different semantics when using emutls (ex. apple))
 199  */
 200 #if defined(_MSC_VER)
 201 # define FOLLY_TLS __declspec(thread)
 202 #elif defined(__GNUC__) || defined(__clang__)
 203 # define FOLLY_TLS __thread
 204 #else
 205 # error cannot define platform specific thread local storage
 206 #endif
 207
 208 #if FOLLY_MOBILE
 209 #undef FOLLY_TLS
 210 #endif
 211
 212 // It turns out that GNU libstdc++ and LLVM libc++ differ on how they implement
 213 // the 'std' namespace; the latter uses inline namespaces. Wrap this decision
 214 // up in a macro to make forward-declarations easier.
 215 #if FOLLY_USE_LIBCPP
 216 #include <__config> // @manual
 217 #define FOLLY_NAMESPACE_STD_BEGIN     _LIBCPP_BEGIN_NAMESPACE_STD
 218 #define FOLLY_NAMESPACE_STD_END       _LIBCPP_END_NAMESPACE_STD
 219 #else
 220 #define FOLLY_NAMESPACE_STD_BEGIN     namespace std {
 221 #define FOLLY_NAMESPACE_STD_END       }
 222 #endif
 223
 224 // If the new c++ ABI is used, __cxx11 inline namespace needs to be added to
 225 // some types, e.g. std::list.
 226 #if _GLIBCXX_USE_CXX11_ABI
 227 #define FOLLY_GLIBCXX_NAMESPACE_CXX11_BEGIN \
 228   inline _GLIBCXX_BEGIN_NAMESPACE_CXX11
 229 # define FOLLY_GLIBCXX_NAMESPACE_CXX11_END   _GLIBCXX_END_NAMESPACE_CXX11
 230 #else
 231 # define FOLLY_GLIBCXX_NAMESPACE_CXX11_BEGIN
 232 # define FOLLY_GLIBCXX_NAMESPACE_CXX11_END
 233 #endif
 234
 235 // MSVC specific defines
 236 // mainly for posix compat
 237 #ifdef _MSC_VER
 238 #include <folly/portability/SysTypes.h>
 239
 240 // compiler specific to compiler specific
 241 // nolint
 242 # define __PRETTY_FUNCTION__ __FUNCSIG__
 243
 244 // Hide a GCC specific thing that breaks MSVC if left alone.
 245 # define __extension__
 246
 247 // We have compiler support for the newest of the new, but
 248 // MSVC doesn't tell us that.
 249 #define __SSE4_2__ 1
 250
 251 #endif
 252
 253 // Debug
 254 namespace folly {
 255 #ifdef NDEBUG
 256 constexpr auto kIsDebug = false;
 257 #else
 258 constexpr auto kIsDebug = true;
 259 #endif
 260 }
 261
 262 // Endianness
 263 namespace folly {
 264 #ifdef _MSC_VER
 265 // It's MSVC, so we just have to guess ... and allow an override
 266 #ifdef FOLLY_ENDIAN_BE
 267 constexpr auto kIsLittleEndian = false;
 268 #else
 269 constexpr auto kIsLittleEndian = true;
 270 #endif
 271 #else
 272 constexpr auto kIsLittleEndian = __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__;
 273 #endif
 274 constexpr auto kIsBigEndian = !kIsLittleEndian;
 275 }
 276
 277 #ifndef FOLLY_SSE
 278 # if defined(__SSE4_2__)
 279 #  define FOLLY_SSE 4
 280 #  define FOLLY_SSE_MINOR 2
 281 # elif defined(__SSE4_1__)
 282 #  define FOLLY_SSE 4
 283 #  define FOLLY_SSE_MINOR 1
 284 # elif defined(__SSE4__)
 285 #  define FOLLY_SSE 4
 286 #  define FOLLY_SSE_MINOR 0
 287 # elif defined(__SSE3__)
 288 #  define FOLLY_SSE 3
 289 #  define FOLLY_SSE_MINOR 0
 290 # elif defined(__SSE2__)
 291 #  define FOLLY_SSE 2
 292 #  define FOLLY_SSE_MINOR 0
 293 # elif defined(__SSE__)
 294 #  define FOLLY_SSE 1
 295 #  define FOLLY_SSE_MINOR 0
 296 # else
 297 #  define FOLLY_SSE 0
 298 #  define FOLLY_SSE_MINOR 0
 299 # endif
 300 #endif
 301
 302 #define FOLLY_SSE_PREREQ(major, minor) \
 303   (FOLLY_SSE > major || FOLLY_SSE == major && FOLLY_SSE_MINOR >= minor)
 304
 305 #if FOLLY_UNUSUAL_GFLAGS_NAMESPACE
 306 namespace FOLLY_GFLAGS_NAMESPACE { }
 307 namespace gflags {
 308 using namespace FOLLY_GFLAGS_NAMESPACE;
 309 }  // namespace gflags
 310 #endif
 311
 312 // for TARGET_OS_IPHONE
 313 #ifdef __APPLE__
 314 #include <TargetConditionals.h> // @manual
 315 #endif
 316
 317 // RTTI may not be enabled for this compilation unit.
 318 #if defined(__GXX_RTTI) || defined(__cpp_rtti) || \
 319     (defined(_MSC_VER) && defined(_CPPRTTI))
 320 # define FOLLY_HAS_RTTI 1
 321 #endif
 322
 323 #if defined(__APPLE__) || defined(_MSC_VER)
 324 #define FOLLY_STATIC_CTOR_PRIORITY_MAX
 325 #else
 326 // 101 is the highest priority allowed by the init_priority attribute.
 327 // This priority is already used by JEMalloc and other memory allocators so
 328 // we will take the next one.
 329 #define FOLLY_STATIC_CTOR_PRIORITY_MAX __attribute__((__init_priority__(102)))
 330 #endif
 331
 332 namespace folly {
 333
 334 #if __OBJC__
 335 constexpr auto kIsObjC = true;
 336 #else
 337 constexpr auto kIsObjC = false;
 338 #endif
 339
 340 #if defined(__linux__) && !FOLLY_MOBILE
 341 constexpr auto kIsLinux = true;
 342 #else
 343 constexpr auto kIsLinux = false;
 344 #endif
 345
 346 #if defined(_WIN32)
 347 constexpr auto kIsWindows = true;
 348 constexpr auto kMscVer = _MSC_VER;
 349 #else
 350 constexpr auto kIsWindows = false;
 351 constexpr auto kMscVer = 0;
 352 #endif
 353 }