[clangd] Re-land "support outgoing calls in call hierarchy" (#117673)
[llvm-project.git] / libcxx / test / support / test_macros.h
blob7f50282d6271762cfc373fcca206756390919af7
1 // -*- C++ -*-
2 //===----------------------------------------------------------------------===//
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 //===----------------------------------------------------------------------===//
10 #ifndef SUPPORT_TEST_MACROS_HPP
11 #define SUPPORT_TEST_MACROS_HPP
13 #ifdef __has_include
14 # if __has_include(<version>)
15 # include <version>
16 # else
17 # include <ciso646>
18 # endif
19 #else
20 # include <ciso646>
21 #endif
23 #define TEST_STRINGIZE_IMPL(...) #__VA_ARGS__
24 #define TEST_STRINGIZE(...) TEST_STRINGIZE_IMPL(__VA_ARGS__)
26 #define TEST_CONCAT1(X, Y) X##Y
27 #define TEST_CONCAT(X, Y) TEST_CONCAT1(X, Y)
29 #ifdef __has_feature
30 #define TEST_HAS_FEATURE(X) __has_feature(X)
31 #else
32 #define TEST_HAS_FEATURE(X) 0
33 #endif
35 #ifndef __has_include
36 #define __has_include(...) 0
37 #endif
39 #ifdef __has_extension
40 #define TEST_HAS_EXTENSION(X) __has_extension(X)
41 #else
42 #define TEST_HAS_EXTENSION(X) 0
43 #endif
45 #ifdef __has_warning
46 #define TEST_HAS_WARNING(X) __has_warning(X)
47 #else
48 #define TEST_HAS_WARNING(X) 0
49 #endif
51 #ifdef __has_builtin
52 #define TEST_HAS_BUILTIN(X) __has_builtin(X)
53 #else
54 #define TEST_HAS_BUILTIN(X) 0
55 #endif
56 #ifdef __is_identifier
57 // '__is_identifier' returns '0' if '__x' is a reserved identifier provided by
58 // the compiler and '1' otherwise.
59 #define TEST_HAS_BUILTIN_IDENTIFIER(X) !__is_identifier(X)
60 #else
61 #define TEST_HAS_BUILTIN_IDENTIFIER(X) 0
62 #endif
64 #if defined(__EDG__)
65 # define TEST_COMPILER_EDG
66 #elif defined(__clang__)
67 # define TEST_COMPILER_CLANG
68 # if defined(__apple_build_version__)
69 # define TEST_COMPILER_APPLE_CLANG
70 # endif
71 #elif defined(_MSC_VER)
72 # define TEST_COMPILER_MSVC
73 #elif defined(__GNUC__)
74 # define TEST_COMPILER_GCC
75 #endif
77 #if defined(__apple_build_version__)
78 // Given AppleClang XX.Y.Z, TEST_APPLE_CLANG_VER is XXYZ (e.g. AppleClang 14.0.3 => 1403)
79 #define TEST_APPLE_CLANG_VER (__apple_build_version__ / 10000)
80 #elif defined(__clang_major__)
81 #define TEST_CLANG_VER (__clang_major__ * 100) + __clang_minor__
82 #elif defined(__GNUC__)
83 // Given GCC XX.YY.ZZ, TEST_GCC_VER is XXYYZZ
84 #define TEST_GCC_VER ((__GNUC__ * 10000) + (__GNUC_MINOR__ * 100) + __GNUC_PATCHLEVEL__)
85 #endif
87 /* Make a nice name for the standard version */
88 #ifndef TEST_STD_VER
89 #if __cplusplus <= 199711L
90 # define TEST_STD_VER 3
91 #elif __cplusplus <= 201103L
92 # define TEST_STD_VER 11
93 #elif __cplusplus <= 201402L
94 # define TEST_STD_VER 14
95 #elif __cplusplus <= 201703L
96 # define TEST_STD_VER 17
97 #elif __cplusplus <= 202002L
98 # define TEST_STD_VER 20
99 #elif __cplusplus <= 202302L
100 # define TEST_STD_VER 23
101 #else
102 # define TEST_STD_VER 99 // greater than current standard
103 // This is deliberately different than _LIBCPP_STD_VER to discourage matching them up.
104 #endif
105 #endif
107 // Attempt to deduce the GLIBC version
108 #if (defined(__has_include) && __has_include(<features.h>)) || \
109 defined(__linux__)
110 #include <features.h>
111 #if defined(__GLIBC_PREREQ)
112 #define TEST_HAS_GLIBC
113 #define TEST_GLIBC_PREREQ(major, minor) __GLIBC_PREREQ(major, minor)
114 #endif
115 #endif
117 #if TEST_STD_VER >= 11
118 # define TEST_ALIGNOF(...) alignof(__VA_ARGS__)
119 # define TEST_ALIGNAS(...) alignas(__VA_ARGS__)
120 # define TEST_CONSTEXPR constexpr
121 # define TEST_NOEXCEPT noexcept
122 # define TEST_NOEXCEPT_FALSE noexcept(false)
123 # define TEST_NOEXCEPT_COND(...) noexcept(__VA_ARGS__)
124 #else
125 # if defined(TEST_COMPILER_CLANG)
126 # define TEST_ALIGNOF(...) _Alignof(__VA_ARGS__)
127 # else
128 # define TEST_ALIGNOF(...) __alignof(__VA_ARGS__)
129 # endif
130 # define TEST_ALIGNAS(...) __attribute__((__aligned__(__VA_ARGS__)))
131 # define TEST_CONSTEXPR
132 # define TEST_NOEXCEPT throw()
133 # define TEST_NOEXCEPT_FALSE
134 # define TEST_NOEXCEPT_COND(...)
135 #endif
137 #if TEST_STD_VER >= 11
138 # define TEST_THROW_SPEC(...)
139 #else
140 # define TEST_THROW_SPEC(...) throw(__VA_ARGS__)
141 #endif
143 #if defined(__cpp_lib_is_constant_evaluated) && __cpp_lib_is_constant_evaluated >= 201811L
144 # define TEST_IS_CONSTANT_EVALUATED std::is_constant_evaluated()
145 #elif TEST_HAS_BUILTIN(__builtin_is_constant_evaluated)
146 # define TEST_IS_CONSTANT_EVALUATED __builtin_is_constant_evaluated()
147 #else
148 # define TEST_IS_CONSTANT_EVALUATED false
149 #endif
151 #if TEST_STD_VER >= 23
152 # define TEST_STD_AT_LEAST_23_OR_RUNTIME_EVALUATED true
153 #else
154 # define TEST_STD_AT_LEAST_23_OR_RUNTIME_EVALUATED (!TEST_IS_CONSTANT_EVALUATED)
155 #endif
157 #if TEST_STD_VER >= 20
158 # define TEST_STD_AT_LEAST_20_OR_RUNTIME_EVALUATED true
159 #else
160 # define TEST_STD_AT_LEAST_20_OR_RUNTIME_EVALUATED (!TEST_IS_CONSTANT_EVALUATED)
161 #endif
163 #if TEST_STD_VER >= 14
164 # define TEST_CONSTEXPR_CXX14 constexpr
165 #else
166 # define TEST_CONSTEXPR_CXX14
167 #endif
169 #if TEST_STD_VER >= 17
170 # define TEST_CONSTEXPR_CXX17 constexpr
171 #else
172 # define TEST_CONSTEXPR_CXX17
173 #endif
175 #if TEST_STD_VER >= 20
176 # define TEST_CONSTEXPR_CXX20 constexpr
177 #else
178 # define TEST_CONSTEXPR_CXX20
179 #endif
181 #if TEST_STD_VER >= 23
182 # define TEST_CONSTEXPR_CXX23 constexpr
183 #else
184 # define TEST_CONSTEXPR_CXX23
185 #endif
187 #if TEST_STD_VER >= 26
188 # define TEST_CONSTEXPR_CXX26 constexpr
189 #else
190 # define TEST_CONSTEXPR_CXX26
191 #endif
193 #define TEST_ALIGNAS_TYPE(...) TEST_ALIGNAS(TEST_ALIGNOF(__VA_ARGS__))
195 #if !TEST_HAS_FEATURE(cxx_rtti) && !defined(__cpp_rtti) \
196 && !defined(__GXX_RTTI)
197 #define TEST_HAS_NO_RTTI
198 #endif
200 #if !defined(TEST_HAS_NO_RTTI)
201 # define RTTI_ASSERT(X) assert(X)
202 #else
203 # define RTTI_ASSERT(X)
204 #endif
206 #if !TEST_HAS_FEATURE(cxx_exceptions) && !defined(__cpp_exceptions) \
207 && !defined(__EXCEPTIONS)
208 #define TEST_HAS_NO_EXCEPTIONS
209 #endif
211 #if TEST_HAS_FEATURE(address_sanitizer) || TEST_HAS_FEATURE(hwaddress_sanitizer) || \
212 TEST_HAS_FEATURE(memory_sanitizer) || TEST_HAS_FEATURE(thread_sanitizer)
213 #define TEST_HAS_SANITIZERS
214 #define TEST_IS_EXECUTED_IN_A_SLOW_ENVIRONMENT
215 #endif
217 #if defined(_LIBCPP_VERSION) && !_LIBCPP_HAS_ALIGNED_ALLOCATION
218 # define TEST_HAS_NO_ALIGNED_ALLOCATION
219 #elif TEST_STD_VER < 17 && (!defined(__cpp_aligned_new) || __cpp_aligned_new < 201606L)
220 # define TEST_HAS_NO_ALIGNED_ALLOCATION
221 #endif
223 #if TEST_STD_VER > 17
224 # define TEST_CONSTINIT constinit
225 #elif __has_cpp_attribute(clang::require_constant_initialization)
226 # define TEST_CONSTINIT [[clang::require_constant_initialization]]
227 #else
228 # define TEST_CONSTINIT
229 #endif
231 #if TEST_STD_VER < 11
232 #define ASSERT_NOEXCEPT(...)
233 #define ASSERT_NOT_NOEXCEPT(...)
234 #else
235 #define ASSERT_NOEXCEPT(...) \
236 static_assert(noexcept(__VA_ARGS__), "Operation must be noexcept")
238 #define ASSERT_NOT_NOEXCEPT(...) \
239 static_assert(!noexcept(__VA_ARGS__), "Operation must NOT be noexcept")
240 #endif
242 /* Macros for testing libc++ specific behavior and extensions */
243 #if defined(_LIBCPP_VERSION)
244 #define LIBCPP_ASSERT(...) assert(__VA_ARGS__)
245 #define LIBCPP_STATIC_ASSERT(...) static_assert(__VA_ARGS__)
246 #define LIBCPP_ASSERT_NOEXCEPT(...) ASSERT_NOEXCEPT(__VA_ARGS__)
247 #define LIBCPP_ASSERT_NOT_NOEXCEPT(...) ASSERT_NOT_NOEXCEPT(__VA_ARGS__)
248 #define LIBCPP_ONLY(...) __VA_ARGS__
249 #else
250 #define LIBCPP_ASSERT(...) static_assert(true, "")
251 #define LIBCPP_STATIC_ASSERT(...) static_assert(true, "")
252 #define LIBCPP_ASSERT_NOEXCEPT(...) static_assert(true, "")
253 #define LIBCPP_ASSERT_NOT_NOEXCEPT(...) static_assert(true, "")
254 #define LIBCPP_ONLY(...) static_assert(true, "")
255 #endif
257 #if __has_cpp_attribute(nodiscard)
258 # define TEST_NODISCARD [[nodiscard]]
259 #else
260 # define TEST_NODISCARD
261 #endif
263 #define TEST_IGNORE_NODISCARD (void)
265 #if !defined(_LIBCPP_VERSION) || _LIBCPP_AVAILABILITY_HAS_FROM_CHARS_FLOATING_POINT
266 # define TEST_HAS_FROM_CHARS_FLOATING_POINT
267 #endif
269 namespace test_macros_detail {
270 template <class T, class U>
271 struct is_same { enum { value = 0};} ;
272 template <class T>
273 struct is_same<T, T> { enum {value = 1}; };
274 } // namespace test_macros_detail
276 #define ASSERT_SAME_TYPE(...) \
277 static_assert((test_macros_detail::is_same<__VA_ARGS__>::value), \
278 "Types differ unexpectedly")
280 #ifndef TEST_HAS_NO_EXCEPTIONS
281 #define TEST_THROW(...) throw __VA_ARGS__
282 #else
283 #if defined(__GNUC__)
284 #define TEST_THROW(...) __builtin_abort()
285 #else
286 #include <stdlib.h>
287 #define TEST_THROW(...) ::abort()
288 #endif
289 #endif
291 #if defined(__GNUC__) || defined(__clang__)
292 // This function can be used to hide some objects from compiler optimizations.
294 // For example, this is useful to hide the result of a call to `new` and ensure
295 // that the compiler doesn't elide the call to new/delete. Otherwise, elliding
296 // calls to new/delete is allowed by the Standard and compilers actually do it
297 // when optimizations are enabled.
298 template <class Tp>
299 inline Tp const& DoNotOptimize(Tp const& value) {
300 // The `m` constraint is invalid in the AMDGPU backend.
301 # if defined(__AMDGPU__) || defined(__NVPTX__)
302 asm volatile("" : : "r"(value) : "memory");
303 # else
304 asm volatile("" : : "r,m"(value) : "memory");
305 # endif
306 return value;
309 template <class Tp>
310 inline Tp& DoNotOptimize(Tp& value) {
311 // The `m` and `r` output constraint is invalid in the AMDGPU backend as well
312 // as i8 / i1 arguments, so we just capture the pointer instead.
313 # if defined(__AMDGPU__)
314 Tp* tmp = &value;
315 asm volatile("" : "+v"(tmp) : : "memory");
316 # elif defined(__clang__)
317 asm volatile("" : "+r,m"(value) : : "memory");
318 # else
319 asm volatile("" : "+m,r"(value) : : "memory");
320 # endif
321 return value;
323 #else
324 #include <intrin.h>
325 template <class Tp>
326 inline Tp const& DoNotOptimize(Tp const& value) {
327 const volatile void* volatile unused = __builtin_addressof(value);
328 static_cast<void>(unused);
329 _ReadWriteBarrier();
330 return value;
332 #endif
334 #if defined(__GNUC__)
335 #define TEST_ALWAYS_INLINE __attribute__((always_inline))
336 #define TEST_NOINLINE __attribute__((noinline))
337 #elif defined(_MSC_VER)
338 #define TEST_ALWAYS_INLINE __forceinline
339 #define TEST_NOINLINE __declspec(noinline)
340 #else
341 #define TEST_ALWAYS_INLINE
342 #define TEST_NOINLINE
343 #endif
345 #ifdef _WIN32
346 #define TEST_NOT_WIN32(...) ((void)0)
347 #else
348 #define TEST_NOT_WIN32(...) __VA_ARGS__
349 #endif
351 #if defined(TEST_WINDOWS_DLL) ||defined(__MVS__) || defined(_AIX)
352 // Macros for waiving cases when we can't count allocations done within
353 // the library implementation.
355 // On Windows, when libc++ is built as a DLL, references to operator new/delete
356 // within the DLL are bound at link time to the operator new/delete within
357 // the library; replacing them in the user executable doesn't override the
358 // calls within the library.
360 // The same goes on IBM zOS.
361 // The same goes on AIX.
362 #define ASSERT_WITH_LIBRARY_INTERNAL_ALLOCATIONS(...) ((void)(__VA_ARGS__))
363 #define TEST_SUPPORTS_LIBRARY_INTERNAL_ALLOCATIONS 0
364 #else
365 #define ASSERT_WITH_LIBRARY_INTERNAL_ALLOCATIONS(...) assert(__VA_ARGS__)
366 #define TEST_SUPPORTS_LIBRARY_INTERNAL_ALLOCATIONS 1
367 #endif
369 #if (defined(TEST_WINDOWS_DLL) && !defined(_MSC_VER)) || \
370 defined(__MVS__)
371 // Normally, a replaced e.g. 'operator new' ends up used if the user code
372 // does a call to e.g. 'operator new[]'; it's enough to replace the base
373 // versions and have it override all of them.
375 // When the fallback operators are located within the libc++ library and we
376 // can't override the calls within it (see above), this fallback mechanism
377 // doesn't work either.
379 // On Windows, when using the MSVC vcruntime, the operator new/delete fallbacks
380 // are linked separately from the libc++ library, linked statically into
381 // the end user executable, and these fallbacks work even in DLL configurations.
382 // In MinGW configurations when built as a DLL, and on zOS, these fallbacks
383 // don't work though.
384 #define ASSERT_WITH_OPERATOR_NEW_FALLBACKS(...) ((void)(__VA_ARGS__))
385 #else
386 #define ASSERT_WITH_OPERATOR_NEW_FALLBACKS(...) assert(__VA_ARGS__)
387 #endif
389 #ifdef _WIN32
390 #define TEST_WIN_NO_FILESYSTEM_PERMS_NONE
391 #endif
393 // Support for carving out parts of the test suite, like removing wide characters, etc.
394 #if defined(_LIBCPP_VERSION) && !_LIBCPP_HAS_WIDE_CHARACTERS
395 # define TEST_HAS_NO_WIDE_CHARACTERS
396 #endif
398 #if defined(_LIBCPP_VERSION) && !_LIBCPP_HAS_UNICODE
399 # define TEST_HAS_NO_UNICODE
400 #elif defined(_MSVC_EXECUTION_CHARACTER_SET) && _MSVC_EXECUTION_CHARACTER_SET != 65001
401 # define TEST_HAS_NO_UNICODE
402 #endif
404 #if defined(_LIBCPP_VERSION) && _LIBCPP_HAS_OPEN_WITH_WCHAR
405 # define TEST_HAS_OPEN_WITH_WCHAR
406 #endif
408 #if (defined(_LIBCPP_VERSION) && !_LIBCPP_HAS_INT128) || defined(_MSVC_STL_VERSION)
409 # define TEST_HAS_NO_INT128
410 #endif
412 #if defined(_LIBCPP_VERSION) && !_LIBCPP_HAS_LOCALIZATION
413 # define TEST_HAS_NO_LOCALIZATION
414 #endif
416 #if TEST_STD_VER <= 17 || !defined(__cpp_char8_t)
417 # define TEST_HAS_NO_CHAR8_T
418 #endif
420 #if defined(_LIBCPP_VERSION) && !_LIBCPP_HAS_THREADS
421 # define TEST_HAS_NO_THREADS
422 #endif
424 #if defined(_LIBCPP_VERSION) && !_LIBCPP_HAS_FILESYSTEM
425 # define TEST_HAS_NO_FILESYSTEM
426 #endif
428 #if defined(_LIBCPP_VERSION) && !_LIBCPP_HAS_C8RTOMB_MBRTOC8
429 # define TEST_HAS_NO_C8RTOMB_MBRTOC8
430 #endif
432 #if defined(_LIBCPP_VERSION) && !_LIBCPP_HAS_RANDOM_DEVICE
433 # define TEST_HAS_NO_RANDOM_DEVICE
434 #endif
436 #if defined(_LIBCPP_HAS_NO_EXPERIMENTAL_TZDB)
437 # define TEST_HAS_NO_EXPERIMENTAL_TZDB
438 #endif
440 #if defined(_LIBCPP_VERSION) && !_LIBCPP_HAS_TIME_ZONE_DATABASE
441 # define TEST_HAS_NO_TIME_ZONE_DATABASE
442 #endif
444 #if defined(TEST_COMPILER_CLANG)
445 # define TEST_DIAGNOSTIC_PUSH _Pragma("clang diagnostic push")
446 # define TEST_DIAGNOSTIC_POP _Pragma("clang diagnostic pop")
447 # define TEST_CLANG_DIAGNOSTIC_IGNORED(str) _Pragma(TEST_STRINGIZE(clang diagnostic ignored str))
448 # define TEST_GCC_DIAGNOSTIC_IGNORED(str)
449 # define TEST_MSVC_DIAGNOSTIC_IGNORED(num)
450 #elif defined(TEST_COMPILER_GCC)
451 # define TEST_DIAGNOSTIC_PUSH _Pragma("GCC diagnostic push")
452 # define TEST_DIAGNOSTIC_POP _Pragma("GCC diagnostic pop")
453 # define TEST_CLANG_DIAGNOSTIC_IGNORED(str)
454 # define TEST_GCC_DIAGNOSTIC_IGNORED(str) _Pragma(TEST_STRINGIZE(GCC diagnostic ignored str))
455 # define TEST_MSVC_DIAGNOSTIC_IGNORED(num)
456 #elif defined(TEST_COMPILER_MSVC)
457 # define TEST_DIAGNOSTIC_PUSH _Pragma("warning(push)")
458 # define TEST_DIAGNOSTIC_POP _Pragma("warning(pop)")
459 # define TEST_CLANG_DIAGNOSTIC_IGNORED(str)
460 # define TEST_GCC_DIAGNOSTIC_IGNORED(str)
461 # define TEST_MSVC_DIAGNOSTIC_IGNORED(num) _Pragma(TEST_STRINGIZE(warning(disable: num)))
462 #else
463 # define TEST_DIAGNOSTIC_PUSH
464 # define TEST_DIAGNOSTIC_POP
465 # define TEST_CLANG_DIAGNOSTIC_IGNORED(str)
466 # define TEST_GCC_DIAGNOSTIC_IGNORED(str)
467 # define TEST_MSVC_DIAGNOSTIC_IGNORED(num)
468 #endif
470 #if __has_cpp_attribute(msvc::no_unique_address)
471 #define TEST_NO_UNIQUE_ADDRESS [[msvc::no_unique_address]]
472 #elif __has_cpp_attribute(no_unique_address)
473 #define TEST_NO_UNIQUE_ADDRESS [[no_unique_address]]
474 #else
475 #define TEST_NO_UNIQUE_ADDRESS
476 #endif
478 #ifdef _LIBCPP_SHORT_WCHAR
479 # define TEST_SHORT_WCHAR
480 #endif
482 #ifdef _LIBCPP_ABI_MICROSOFT
483 # define TEST_ABI_MICROSOFT
484 #endif
486 // This is a temporary workaround for user-defined `operator new` definitions
487 // not being picked up on Apple platforms in some circumstances. This is under
488 // investigation and should be short-lived.
489 #ifdef __APPLE__
490 # define TEST_WORKAROUND_BUG_109234844_WEAK __attribute__((weak))
491 #else
492 # define TEST_WORKAROUND_BUG_109234844_WEAK /* nothing */
493 #endif
495 #ifdef _AIX
496 # define TEST_IF_AIX(arg_true, arg_false) arg_true
497 #else
498 # define TEST_IF_AIX(arg_true, arg_false) arg_false
499 #endif
501 // Clang-18 has support for deducing this, but it does not set the FTM.
502 #if defined(_LIBCPP_VERSION) && _LIBCPP_HAS_EXPLICIT_THIS_PARAMETER
503 # define TEST_HAS_EXPLICIT_THIS_PARAMETER
504 #endif
506 // Placement `operator new`/`operator new[]` are not yet constexpr in C++26
507 // when using MS ABI, because they are from <vcruntime_new.h>.
508 #if defined(__cpp_lib_constexpr_new) && __cpp_lib_constexpr_new >= 202406L
509 # define TEST_CONSTEXPR_OPERATOR_NEW constexpr
510 #else
511 # define TEST_CONSTEXPR_OPERATOR_NEW
512 #endif
514 #if defined(_MSC_VER) || __SIZEOF_LONG_DOUBLE__ == __SIZEOF_DOUBLE__
515 # define TEST_LONG_DOUBLE_IS_DOUBLE
516 #endif
518 #endif // SUPPORT_TEST_MACROS_HPP