include/llvm/Support/Compiler.h

   1 //===-- llvm/Support/Compiler.h - Compiler abstraction support --*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines several macros, based on the current compiler.  This allows
  11 // use of compiler-specific features in a way that remains portable.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_SUPPORT_COMPILER_H
  16 #define LLVM_SUPPORT_COMPILER_H
  17
  18 #ifndef __has_feature
  19 # define __has_feature(x) 0
  20 #endif
  21
  22 /// \brief Does the compiler support r-value references?
  23 /// This implies that <utility> provides the one-argument std::move;  it
  24 /// does not imply the existence of any other C++ library features.
  25 #if (__has_feature(cxx_rvalue_references)   \
  26      || defined(__GXX_EXPERIMENTAL_CXX0X__) \
  27      || (defined(_MSC_VER) && _MSC_VER >= 1600))
  28 #define LLVM_HAS_RVALUE_REFERENCES 1
  29 #else
  30 #define LLVM_HAS_RVALUE_REFERENCES 0
  31 #endif
  32
  33 /// \brief Does the compiler support r-value reference *this?
  34 ///
  35 /// Sadly, this is separate from just r-value reference support because GCC
  36 /// implemented everything but this thus far. No release of GCC yet has support
  37 /// for this feature so it is enabled with Clang only.
  38 /// FIXME: This should change to a version check when GCC grows support for it.
  39 #if __has_feature(cxx_rvalue_references)
  40 #define LLVM_HAS_RVALUE_REFERENCE_THIS 1
  41 #else
  42 #define LLVM_HAS_RVALUE_REFERENCE_THIS 0
  43 #endif
  44
  45 /// llvm_move - Expands to ::std::move if the compiler supports
  46 /// r-value references; otherwise, expands to the argument.
  47 #if LLVM_HAS_RVALUE_REFERENCES
  48 #define llvm_move(value) (::std::move(value))
  49 #else
  50 #define llvm_move(value) (value)
  51 #endif
  52
  53 /// Expands to '&' if r-value references are supported.
  54 ///
  55 /// This can be used to provide l-value/r-value overrides of member functions.
  56 /// The r-value override should be guarded by LLVM_HAS_RVALUE_REFERENCE_THIS
  57 #if LLVM_HAS_RVALUE_REFERENCE_THIS
  58 #define LLVM_LVALUE_FUNCTION &
  59 #else
  60 #define LLVM_LVALUE_FUNCTION
  61 #endif
  62
  63 /// LLVM_DELETED_FUNCTION - Expands to = delete if the compiler supports it.
  64 /// Use to mark functions as uncallable. Member functions with this should
  65 /// be declared private so that some behavior is kept in C++03 mode.
  66 ///
  67 /// class DontCopy {
  68 /// private:
  69 ///   DontCopy(const DontCopy&) LLVM_DELETED_FUNCTION;
  70 ///   DontCopy &operator =(const DontCopy&) LLVM_DELETED_FUNCTION;
  71 /// public:
  72 ///   ...
  73 /// };
  74 #if (__has_feature(cxx_deleted_functions) \
  75      || defined(__GXX_EXPERIMENTAL_CXX0X__))
  76      // No version of MSVC currently supports this.
  77 #define LLVM_DELETED_FUNCTION = delete
  78 #else
  79 #define LLVM_DELETED_FUNCTION
  80 #endif
  81
  82 /// LLVM_FINAL - Expands to 'final' if the compiler supports it.
  83 /// Use to mark classes or virtual methods as final.
  84 #if (__has_feature(cxx_override_control))
  85 #define LLVM_FINAL final
  86 #else
  87 #define LLVM_FINAL
  88 #endif
  89
  90 /// LLVM_OVERRIDE - Expands to 'override' if the compiler supports it.
  91 /// Use to mark virtual methods as overriding a base class method.
  92 #if (__has_feature(cxx_override_control))
  93 #define LLVM_OVERRIDE override
  94 #else
  95 #define LLVM_OVERRIDE
  96 #endif
  97
  98 #if __has_feature(cxx_constexpr) || defined(__GXX_EXPERIMENTAL_CXX0X__)
  99 # define LLVM_CONSTEXPR constexpr
 100 #else
 101 # define LLVM_CONSTEXPR
 102 #endif
 103
 104 /// LLVM_LIBRARY_VISIBILITY - If a class marked with this attribute is linked
 105 /// into a shared library, then the class should be private to the library and
 106 /// not accessible from outside it.  Can also be used to mark variables and
 107 /// functions, making them private to any shared library they are linked into.
 108 #if (__GNUC__ >= 4) && !defined(__MINGW32__) && !defined(__CYGWIN__)
 109 #define LLVM_LIBRARY_VISIBILITY __attribute__ ((visibility("hidden")))
 110 #else
 111 #define LLVM_LIBRARY_VISIBILITY
 112 #endif
 113
 114 #if (__GNUC__ >= 4 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))
 115 #define LLVM_ATTRIBUTE_USED __attribute__((__used__))
 116 #else
 117 #define LLVM_ATTRIBUTE_USED
 118 #endif
 119
 120 // Some compilers warn about unused functions. When a function is sometimes
 121 // used or not depending on build settings (e.g. a function only called from
 122 // within "assert"), this attribute can be used to suppress such warnings.
 123 //
 124 // However, it shouldn't be used for unused *variables*, as those have a much
 125 // more portable solution:
 126 //   (void)unused_var_name;
 127 // Prefer cast-to-void wherever it is sufficient.
 128 #if (__GNUC__ >= 4 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))
 129 #define LLVM_ATTRIBUTE_UNUSED __attribute__((__unused__))
 130 #else
 131 #define LLVM_ATTRIBUTE_UNUSED
 132 #endif
 133
 134 #if (__GNUC__ >= 4) && !defined(__MINGW32__) && !defined(__CYGWIN__)
 135 #define LLVM_ATTRIBUTE_WEAK __attribute__((__weak__))
 136 #else
 137 #define LLVM_ATTRIBUTE_WEAK
 138 #endif
 139
 140 #ifdef __GNUC__ // aka 'CONST' but following LLVM Conventions.
 141 #define LLVM_READNONE __attribute__((__const__))
 142 #else
 143 #define LLVM_READNONE
 144 #endif
 145
 146 #ifdef __GNUC__  // aka 'PURE' but following LLVM Conventions.
 147 #define LLVM_READONLY __attribute__((__pure__))
 148 #else
 149 #define LLVM_READONLY
 150 #endif
 151
 152 #if (__GNUC__ >= 4)
 153 #define LLVM_LIKELY(EXPR) __builtin_expect((bool)(EXPR), true)
 154 #define LLVM_UNLIKELY(EXPR) __builtin_expect((bool)(EXPR), false)
 155 #else
 156 #define LLVM_LIKELY(EXPR) (EXPR)
 157 #define LLVM_UNLIKELY(EXPR) (EXPR)
 158 #endif
 159
 160 // C++ doesn't support 'extern template' of template specializations.  GCC does,
 161 // but requires __extension__ before it.  In the header, use this:
 162 //   EXTERN_TEMPLATE_INSTANTIATION(class foo<bar>);
 163 // in the .cpp file, use this:
 164 //   TEMPLATE_INSTANTIATION(class foo<bar>);
 165 #ifdef __GNUC__
 166 #define EXTERN_TEMPLATE_INSTANTIATION(X) __extension__ extern template X
 167 #define TEMPLATE_INSTANTIATION(X) template X
 168 #else
 169 #define EXTERN_TEMPLATE_INSTANTIATION(X)
 170 #define TEMPLATE_INSTANTIATION(X)
 171 #endif
 172
 173 /// LLVM_ATTRIBUTE_NOINLINE - On compilers where we have a directive to do so,
 174 /// mark a method "not for inlining".
 175 #if (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4))
 176 #define LLVM_ATTRIBUTE_NOINLINE __attribute__((noinline))
 177 #elif defined(_MSC_VER)
 178 #define LLVM_ATTRIBUTE_NOINLINE __declspec(noinline)
 179 #else
 180 #define LLVM_ATTRIBUTE_NOINLINE
 181 #endif
 182
 183 /// LLVM_ATTRIBUTE_ALWAYS_INLINE - On compilers where we have a directive to do
 184 /// so, mark a method "always inline" because it is performance sensitive. GCC
 185 /// 3.4 supported this but is buggy in various cases and produces unimplemented
 186 /// errors, just use it in GCC 4.0 and later.
 187 #if __GNUC__ > 3
 188 #define LLVM_ATTRIBUTE_ALWAYS_INLINE inline __attribute__((always_inline))
 189 #elif defined(_MSC_VER)
 190 #define LLVM_ATTRIBUTE_ALWAYS_INLINE __forceinline
 191 #else
 192 #define LLVM_ATTRIBUTE_ALWAYS_INLINE
 193 #endif
 194
 195 #ifdef __GNUC__
 196 #define LLVM_ATTRIBUTE_NORETURN __attribute__((noreturn))
 197 #elif defined(_MSC_VER)
 198 #define LLVM_ATTRIBUTE_NORETURN __declspec(noreturn)
 199 #else
 200 #define LLVM_ATTRIBUTE_NORETURN
 201 #endif
 202
 203 /// LLVM_EXTENSION - Support compilers where we have a keyword to suppress
 204 /// pedantic diagnostics.
 205 #ifdef __GNUC__
 206 #define LLVM_EXTENSION __extension__
 207 #else
 208 #define LLVM_EXTENSION
 209 #endif
 210
 211 // LLVM_ATTRIBUTE_DEPRECATED(decl, "message")
 212 #if __has_feature(attribute_deprecated_with_message)
 213 # define LLVM_ATTRIBUTE_DEPRECATED(decl, message) \
 214   decl __attribute__((deprecated(message)))
 215 #elif defined(__GNUC__)
 216 # define LLVM_ATTRIBUTE_DEPRECATED(decl, message) \
 217   decl __attribute__((deprecated))
 218 #elif defined(_MSC_VER)
 219 # define LLVM_ATTRIBUTE_DEPRECATED(decl, message) \
 220   __declspec(deprecated(message)) decl
 221 #else
 222 # define LLVM_ATTRIBUTE_DEPRECATED(decl, message) \
 223   decl
 224 #endif
 225
 226 /// LLVM_BUILTIN_UNREACHABLE - On compilers which support it, expands
 227 /// to an expression which states that it is undefined behavior for the
 228 /// compiler to reach this point.  Otherwise is not defined.
 229 #if defined(__clang__) || (__GNUC__ > 4) \
 230  || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5)
 231 # define LLVM_BUILTIN_UNREACHABLE __builtin_unreachable()
 232 #elif defined(_MSC_VER)
 233 # define LLVM_BUILTIN_UNREACHABLE __assume(false)
 234 #endif
 235
 236 /// LLVM_BUILTIN_TRAP - On compilers which support it, expands to an expression
 237 /// which causes the program to exit abnormally.
 238 #if defined(__clang__) || (__GNUC__ > 4) \
 239  || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)
 240 # define LLVM_BUILTIN_TRAP __builtin_trap()
 241 #else
 242 # define LLVM_BUILTIN_TRAP *(volatile int*)0x11 = 0
 243 #endif
 244
 245 /// \macro LLVM_ASSUME_ALIGNED
 246 /// \brief Returns a pointer with an assumed alignment.
 247 #if !defined(__clang__) && ((__GNUC__ > 4) \
 248  || (__GNUC__ == 4 && __GNUC_MINOR__ >= 7))
 249 // FIXME: Enable on clang when it supports it.
 250 # define LLVM_ASSUME_ALIGNED(p, a) __builtin_assume_aligned(p, a)
 251 #elif defined(LLVM_BUILTIN_UNREACHABLE)
 252 # define LLVM_ASSUME_ALIGNED(p, a) \
 253            (((uintptr_t(p) % (a)) == 0) ? (p) : (LLVM_BUILTIN_UNREACHABLE, (p)))
 254 #else
 255 # define LLVM_ASSUME_ALIGNED(p, a) (p)
 256 #endif
 257
 258 /// \macro LLVM_FUNCTION_NAME
 259 /// \brief Expands to __func__ on compilers which support it.  Otherwise,
 260 /// expands to a compiler-dependent replacement.
 261 #if defined(_MSC_VER)
 262 # define LLVM_FUNCTION_NAME __FUNCTION__
 263 #else
 264 # define LLVM_FUNCTION_NAME __func__
 265 #endif
 266
 267 #endif