1 // -*- C++ -*- 2 //===---------------------------- test_macros.h ---------------------------===// 3 // 4 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 5 // See https://llvm.org/LICENSE.txt for license information. 6 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 7 // 8 //===----------------------------------------------------------------------===// 9 10 #ifndef SUPPORT_TEST_MACROS_HPP 11 #define SUPPORT_TEST_MACROS_HPP 12 13 // Attempt to get STL specific macros like _LIBCPP_VERSION using the most 14 // minimal header possible. If we're testing libc++, we should use `<__config>`. 15 // If <__config> isn't available, fall back to <ciso646>. 16 #ifdef __has_include 17 # if __has_include("<__config>") 18 # include <__config> 19 # define TEST_IMP_INCLUDED_HEADER 20 # endif 21 #endif 22 #ifndef TEST_IMP_INCLUDED_HEADER 23 #include <ciso646> 24 #endif 25 26 #if defined(__GNUC__) 27 #pragma GCC diagnostic push 28 #pragma GCC diagnostic ignored "-Wvariadic-macros" 29 #endif 30 31 #define TEST_STRINGIZE_IMPL(x) #x 32 #define TEST_STRINGIZE(x) TEST_STRINGIZE_IMPL(x) 33 34 #define TEST_CONCAT1(X, Y) X##Y 35 #define TEST_CONCAT(X, Y) TEST_CONCAT1(X, Y) 36 37 #ifdef __has_feature 38 #define TEST_HAS_FEATURE(X) __has_feature(X) 39 #else 40 #define TEST_HAS_FEATURE(X) 0 41 #endif 42 43 #ifndef __has_include 44 #define __has_include(...) 0 45 #endif 46 47 #ifdef __has_extension 48 #define TEST_HAS_EXTENSION(X) __has_extension(X) 49 #else 50 #define TEST_HAS_EXTENSION(X) 0 51 #endif 52 53 #ifdef __has_warning 54 #define TEST_HAS_WARNING(X) __has_warning(X) 55 #else 56 #define TEST_HAS_WARNING(X) 0 57 #endif 58 59 #ifdef __has_builtin 60 #define TEST_HAS_BUILTIN(X) __has_builtin(X) 61 #else 62 #define TEST_HAS_BUILTIN(X) 0 63 #endif 64 #ifdef __is_identifier 65 // '__is_identifier' returns '0' if '__x' is a reserved identifier provided by 66 // the compiler and '1' otherwise. 67 #define TEST_HAS_BUILTIN_IDENTIFIER(X) !__is_identifier(X) 68 #else 69 #define TEST_HAS_BUILTIN_IDENTIFIER(X) 0 70 #endif 71 72 #if defined(__EDG__) 73 # define TEST_COMPILER_EDG 74 #elif defined(__clang__) 75 # define TEST_COMPILER_CLANG 76 # if defined(__apple_build_version__) 77 # define TEST_COMPILER_APPLE_CLANG 78 # endif 79 #elif defined(_MSC_VER) 80 # define TEST_COMPILER_C1XX 81 #elif defined(__GNUC__) 82 # define TEST_COMPILER_GCC 83 #endif 84 85 #if defined(__apple_build_version__) 86 #define TEST_APPLE_CLANG_VER (__clang_major__ * 100) + __clang_minor__ 87 #elif defined(__clang_major__) 88 #define TEST_CLANG_VER (__clang_major__ * 100) + __clang_minor__ 89 #elif defined(__GNUC__) 90 #define TEST_GCC_VER (__GNUC__ * 100 + __GNUC_MINOR__) 91 #define TEST_GCC_VER_NEW (TEST_GCC_VER * 10 + __GNUC_PATCHLEVEL__) 92 #endif 93 94 /* Make a nice name for the standard version */ 95 #ifndef TEST_STD_VER 96 #if __cplusplus <= 199711L 97 # define TEST_STD_VER 3 98 #elif __cplusplus <= 201103L 99 # define TEST_STD_VER 11 100 #elif __cplusplus <= 201402L 101 # define TEST_STD_VER 14 102 #elif __cplusplus <= 201703L 103 # define TEST_STD_VER 17 104 #elif __cplusplus <= 202002L 105 # define TEST_STD_VER 20 106 #else 107 # define TEST_STD_VER 99 // greater than current standard 108 // This is deliberately different than _LIBCPP_STD_VER to discourage matching them up. 109 #endif 110 #endif 111 112 // Attempt to deduce the GLIBC version 113 #if (defined(__has_include) && __has_include(<features.h>)) || \ 114 defined(__linux__) 115 #include <features.h> 116 #if defined(__GLIBC_PREREQ) 117 #define TEST_HAS_GLIBC 118 #define TEST_GLIBC_PREREQ(major, minor) __GLIBC_PREREQ(major, minor) 119 #endif 120 #endif 121 122 #if TEST_STD_VER >= 11 123 # define TEST_ALIGNOF(...) alignof(__VA_ARGS__) 124 # define TEST_ALIGNAS(...) alignas(__VA_ARGS__) 125 # define TEST_CONSTEXPR constexpr 126 # define TEST_NOEXCEPT noexcept 127 # define TEST_NOEXCEPT_FALSE noexcept(false) 128 # define TEST_NOEXCEPT_COND(...) noexcept(__VA_ARGS__) 129 #else 130 # if defined(TEST_COMPILER_CLANG) 131 # define TEST_ALIGNOF(...) _Alignof(__VA_ARGS__) 132 # else 133 # define TEST_ALIGNOF(...) __alignof(__VA_ARGS__) 134 # endif 135 # define TEST_ALIGNAS(...) __attribute__((__aligned__(__VA_ARGS__))) 136 # define TEST_CONSTEXPR 137 # define TEST_NOEXCEPT throw() 138 # define TEST_NOEXCEPT_FALSE 139 # define TEST_NOEXCEPT_COND(...) 140 #endif 141 142 #if TEST_STD_VER >= 11 143 # define TEST_THROW_SPEC(...) 144 #else 145 # define TEST_THROW_SPEC(...) throw(__VA_ARGS__) 146 #endif 147 148 #if TEST_STD_VER >= 14 149 # define TEST_CONSTEXPR_CXX14 constexpr 150 #else 151 # define TEST_CONSTEXPR_CXX14 152 #endif 153 154 #if TEST_STD_VER >= 17 155 # define TEST_CONSTEXPR_CXX17 constexpr 156 #else 157 # define TEST_CONSTEXPR_CXX17 158 #endif 159 160 #if TEST_STD_VER >= 20 161 # define TEST_CONSTEXPR_CXX20 constexpr 162 #else 163 # define TEST_CONSTEXPR_CXX20 164 #endif 165 166 /* Features that were introduced in C++14 */ 167 #if TEST_STD_VER >= 14 168 #define TEST_HAS_EXTENDED_CONSTEXPR 169 #define TEST_HAS_VARIABLE_TEMPLATES 170 #endif 171 172 /* Features that were introduced in C++17 */ 173 #if TEST_STD_VER >= 17 174 #endif 175 176 /* Features that were introduced after C++17 */ 177 #if TEST_STD_VER > 17 178 #endif 179 180 181 #define TEST_ALIGNAS_TYPE(...) TEST_ALIGNAS(TEST_ALIGNOF(__VA_ARGS__)) 182 183 #if !TEST_HAS_FEATURE(cxx_rtti) && !defined(__cpp_rtti) \ 184 && !defined(__GXX_RTTI) 185 #define TEST_HAS_NO_RTTI 186 #endif 187 188 #if !defined(TEST_HAS_NO_RTTI) 189 # define RTTI_ASSERT(X) assert(X) 190 #else 191 # define RTTI_ASSERT(X) 192 #endif 193 194 #if !TEST_HAS_FEATURE(cxx_exceptions) && !defined(__cpp_exceptions) \ 195 && !defined(__EXCEPTIONS) 196 #define TEST_HAS_NO_EXCEPTIONS 197 #endif 198 199 #if TEST_HAS_FEATURE(address_sanitizer) || TEST_HAS_FEATURE(memory_sanitizer) || \ 200 TEST_HAS_FEATURE(thread_sanitizer) 201 #define TEST_HAS_SANITIZERS 202 #endif 203 204 #if defined(_LIBCPP_NORETURN) 205 #define TEST_NORETURN _LIBCPP_NORETURN 206 #else 207 #define TEST_NORETURN [[noreturn]] 208 #endif 209 210 #if defined(_LIBCPP_HAS_NO_ALIGNED_ALLOCATION) || \ 211 (!(TEST_STD_VER > 14 || \ 212 (defined(__cpp_aligned_new) && __cpp_aligned_new >= 201606L))) 213 #define TEST_HAS_NO_ALIGNED_ALLOCATION 214 #endif 215 216 #if defined(_LIBCPP_SAFE_STATIC) 217 #define TEST_SAFE_STATIC _LIBCPP_SAFE_STATIC 218 #else 219 #define TEST_SAFE_STATIC 220 #endif 221 222 #if !defined(__cpp_impl_three_way_comparison) \ 223 && (!defined(_MSC_VER) || defined(__clang__) || _MSC_VER < 1920 || _MSVC_LANG <= 201703L) 224 #define TEST_HAS_NO_SPACESHIP_OPERATOR 225 #endif 226 227 #if TEST_STD_VER < 11 228 #define ASSERT_NOEXCEPT(...) 229 #define ASSERT_NOT_NOEXCEPT(...) 230 #else 231 #define ASSERT_NOEXCEPT(...) \ 232 static_assert(noexcept(__VA_ARGS__), "Operation must be noexcept") 233 234 #define ASSERT_NOT_NOEXCEPT(...) \ 235 static_assert(!noexcept(__VA_ARGS__), "Operation must NOT be noexcept") 236 #endif 237 238 /* Macros for testing libc++ specific behavior and extensions */ 239 #if defined(_LIBCPP_VERSION) 240 #define LIBCPP_ASSERT(...) assert(__VA_ARGS__) 241 #define LIBCPP_STATIC_ASSERT(...) static_assert(__VA_ARGS__) 242 #define LIBCPP_ASSERT_NOEXCEPT(...) ASSERT_NOEXCEPT(__VA_ARGS__) 243 #define LIBCPP_ASSERT_NOT_NOEXCEPT(...) ASSERT_NOT_NOEXCEPT(__VA_ARGS__) 244 #define LIBCPP_ONLY(...) __VA_ARGS__ 245 #else 246 #define LIBCPP_ASSERT(...) ((void)0) 247 #define LIBCPP_STATIC_ASSERT(...) ((void)0) 248 #define LIBCPP_ASSERT_NOEXCEPT(...) ((void)0) 249 #define LIBCPP_ASSERT_NOT_NOEXCEPT(...) ((void)0) 250 #define LIBCPP_ONLY(...) ((void)0) 251 #endif 252 253 #if !defined(_LIBCPP_HAS_NO_RANGES) 254 #define TEST_SUPPORTS_RANGES 255 #endif 256 257 #define TEST_IGNORE_NODISCARD (void) 258 259 namespace test_macros_detail { 260 template <class T, class U> 261 struct is_same { enum { value = 0};} ; 262 template <class T> 263 struct is_same<T, T> { enum {value = 1}; }; 264 } // namespace test_macros_detail 265 266 #define ASSERT_SAME_TYPE(...) \ 267 static_assert((test_macros_detail::is_same<__VA_ARGS__>::value), \ 268 "Types differ unexpectedly") 269 270 #ifndef TEST_HAS_NO_EXCEPTIONS 271 #define TEST_THROW(...) throw __VA_ARGS__ 272 #else 273 #if defined(__GNUC__) 274 #define TEST_THROW(...) __builtin_abort() 275 #else 276 #include <stdlib.h> 277 #define TEST_THROW(...) ::abort() 278 #endif 279 #endif 280 281 #if defined(__GNUC__) || defined(__clang__) 282 template <class Tp> 283 inline 284 void DoNotOptimize(Tp const& value) { 285 asm volatile("" : : "r,m"(value) : "memory"); 286 } 287 288 template <class Tp> 289 inline void DoNotOptimize(Tp& value) { 290 #if defined(__clang__) 291 asm volatile("" : "+r,m"(value) : : "memory"); 292 #else 293 asm volatile("" : "+m,r"(value) : : "memory"); 294 #endif 295 } 296 #else 297 #include <intrin.h> 298 template <class Tp> 299 inline void DoNotOptimize(Tp const& value) { 300 const volatile void* volatile unused = __builtin_addressof(value); 301 static_cast<void>(unused); 302 _ReadWriteBarrier(); 303 } 304 #endif 305 306 #if defined(__GNUC__) 307 #define TEST_ALWAYS_INLINE __attribute__((always_inline)) 308 #define TEST_NOINLINE __attribute__((noinline)) 309 #elif defined(_MSC_VER) 310 #define TEST_ALWAYS_INLINE __forceinline 311 #define TEST_NOINLINE __declspec(noinline) 312 #else 313 #define TEST_ALWAYS_INLINE 314 #define TEST_NOINLINE 315 #endif 316 317 #ifdef _WIN32 318 #define TEST_NOT_WIN32(...) ((void)0) 319 #else 320 #define TEST_NOT_WIN32(...) __VA_ARGS__ 321 #endif 322 323 #if defined(_WIN32) && !defined(_LIBCPP_DISABLE_VISIBILITY_ANNOTATIONS) 324 #define TEST_NOT_WIN32_DLL(...) ((void)0) 325 #define TEST_ONLY_WIN32_DLL(...) __VA_ARGS__ 326 #else 327 #define TEST_NOT_WIN32_DLL(...) __VA_ARGS__ 328 #define TEST_ONLY_WIN32_DLL(...) ((void)0) 329 #endif 330 331 #ifdef _WIN32 332 #define TEST_WIN_NO_FILESYSTEM_PERMS_NONE 333 #endif 334 335 #if defined(__GNUC__) 336 #pragma GCC diagnostic pop 337 #endif 338 339 #endif // SUPPORT_TEST_MACROS_HPP 340