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