folly/Portability.h

   1 /*
   2  * Copyright 2014 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-config.h"
  22 #endif
  23
  24 #if FOLLY_HAVE_FEATURES_H
  25 #include <features.h>
  26 #endif
  27
  28 #include "CPortability.h"
  29
  30 #if FOLLY_HAVE_SCHED_H
  31  #include <sched.h>
  32  #ifndef FOLLY_HAVE_PTHREAD_YIELD
  33   #define pthread_yield sched_yield
  34  #endif
  35 #endif
  36
  37
  38 // MaxAlign: max_align_t isn't supported by gcc
  39 #ifdef __GNUC__
  40 struct MaxAlign { char c; } __attribute__((aligned));
  41 #else /* !__GNUC__ */
  42 # error Cannot define MaxAlign on this platform
  43 #endif
  44
  45 // compiler specific attribute translation
  46 // msvc should come first, so if clang is in msvc mode it gets the right defines
  47
  48 // noreturn
  49 #if defined(_MSC_VER)
  50 # define FOLLY_NORETURN __declspec(noreturn)
  51 #elif defined(__clang__) || defined(__GNUC__)
  52 # define FOLLY_NORETURN __attribute__((noreturn))
  53 #else
  54 # define FOLLY_NORETURN
  55 #endif
  56
  57 // noinline
  58 #ifdef _MSC_VER
  59 # define FOLLY_NOINLINE __declspec(noinline)
  60 #elif defined(__clang__) || defined(__GNUC__)
  61 # define FOLLY_NOINLINE __attribute__((noinline))
  62 #else
  63 # define FOLLY_NOINLINE
  64 #endif
  65
  66 // always inline
  67 #ifdef _MSC_VER
  68 # define FOLLY_ALWAYS_INLINE __forceinline
  69 #elif defined(__clang__) || defined(__GNUC__)
  70 # define FOLLY_ALWAYS_INLINE inline __attribute__((always_inline))
  71 #else
  72 # define FOLLY_ALWAYS_INLINE
  73 #endif
  74
  75 // portable version check
  76 #ifndef __GNUC_PREREQ
  77 # if defined __GNUC__ && defined __GNUC_MINOR__
  78 #  define __GNUC_PREREQ(maj, min) ((__GNUC__ << 16) + __GNUC_MINOR__ >= \
  79                                    ((maj) << 16) + (min))
  80 # else
  81 #  define __GNUC_PREREQ(maj, min) 0
  82 # endif
  83 #endif
  84
  85
  86 /* Define macro wrappers for C++11's "final" and "override" keywords, which
  87  * are supported in gcc 4.7 but not gcc 4.6. */
  88 #if !defined(FOLLY_FINAL) && !defined(FOLLY_OVERRIDE)
  89 # if defined(__clang__) || __GNUC_PREREQ(4, 7)
  90 #  define FOLLY_FINAL final
  91 #  define FOLLY_OVERRIDE override
  92 # else
  93 #  define FOLLY_FINAL /**/
  94 #  define FOLLY_OVERRIDE /**/
  95 # endif
  96 #endif
  97
  98
  99 // Define to 1 if you have the `preadv' and `pwritev' functions, respectively
 100 #if !defined(FOLLY_HAVE_PREADV) && !defined(FOLLY_HAVE_PWRITEV)
 101 # if defined(__GLIBC_PREREQ)
 102 #  if __GLIBC_PREREQ(2, 10)
 103 #   define FOLLY_HAVE_PREADV 1
 104 #   define FOLLY_HAVE_PWRITEV 1
 105 #  endif
 106 # endif
 107 #endif
 108
 109 // It turns out that GNU libstdc++ and LLVM libc++ differ on how they implement
 110 // the 'std' namespace; the latter uses inline namepsaces. Wrap this decision
 111 // up in a macro to make forward-declarations easier.
 112 #if FOLLY_USE_LIBCPP
 113 #define FOLLY_NAMESPACE_STD_BEGIN     _LIBCPP_BEGIN_NAMESPACE_STD
 114 #define FOLLY_NAMESPACE_STD_END       _LIBCPP_END_NAMESPACE_STD
 115 #else
 116 #define FOLLY_NAMESPACE_STD_BEGIN     namespace std {
 117 #define FOLLY_NAMESPACE_STD_END       }
 118 #endif
 119
 120 // Some platforms lack clock_gettime(2) and clock_getres(2). Inject our own
 121 // versions of these into the global namespace.
 122 #if FOLLY_HAVE_CLOCK_GETTIME
 123 #include <time.h>
 124 #else
 125 #include "folly/detail/Clock.h"
 126 #endif
 127
 128 // Provide our own std::__throw_* wrappers for platforms that don't have them
 129 #if FOLLY_HAVE_BITS_FUNCTEXCEPT_H
 130 #include <bits/functexcept.h>
 131 #else
 132 #include "folly/detail/FunctionalExcept.h"
 133 #endif
 134
 135 #if defined(__cplusplus)
 136 // Unfortunately, boost::has_trivial_copy<T> is broken in libc++ due to its
 137 // usage of __has_trivial_copy(), so we can't use it as a
 138 // least-common-denominator for C++11 implementations that don't support
 139 // std::is_trivially_copyable<T>.
 140 //
 141 //      http://stackoverflow.com/questions/12754886/has-trivial-copy-behaves-differently-in-clang-and-gcc-whos-right
 142 //
 143 // As a result, use std::is_trivially_copyable() where it exists, and fall back
 144 // to Boost otherwise.
 145 #if FOLLY_HAVE_STD__IS_TRIVIALLY_COPYABLE
 146 #include <type_traits>
 147 #define FOLLY_IS_TRIVIALLY_COPYABLE(T)                   \
 148   (std::is_trivially_copyable<T>::value)
 149 #else
 150 #include <boost/type_traits.hpp>
 151 #define FOLLY_IS_TRIVIALLY_COPYABLE(T)                   \
 152   (boost::has_trivial_copy<T>::value &&                  \
 153    boost::has_trivial_destructor<T>::value)
 154 #endif
 155 #endif // __cplusplus
 156
 157 #endif // FOLLY_PORTABILITY_H_