-
Notifications
You must be signed in to change notification settings - Fork 87
/
Copy pathdisabled_for_test_case.h
147 lines (123 loc) · 6.2 KB
/
disabled_for_test_case.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
/*******************************************************************************
//
// SYCL 2020 Conformance Test Suite
//
// Copyright (c) 2022 The Khronos Group Inc.
//
*******************************************************************************/
#ifndef __SYCLCTS_TESTS_COMMON_DISABLED_FOR_TEST_CASE_H
#define __SYCLCTS_TESTS_COMMON_DISABLED_FOR_TEST_CASE_H
// This is required for detecting the active SYCL implementation
#include "macro_utils.h"
#include <catch2/catch_template_test_macros.hpp>
#include <catch2/catch_test_macros.hpp>
#include <sycl/sycl.hpp>
// TODO: Add other Catch2 test case variants, as needed
/**
* Registers a test case that is compile-time disabled for one or more SYCL
* implementations. This is useful for when a test case contains code that
* currently does not compile for a given implementation, while other test cases
* in the same translation unit would otherwise compile.
*
* The following implementations can be specified: DPCPP, AdaptiveCpp, SimSYCL.
* A disabled test case will fail automatically at runtime.
*
* Usage example:
* ```
* DISABLED_FOR_TEST_CASE(AdaptiveCpp)("my test case", "[my-tag]")({
* // ...
* });
* ```
*
* Apart from the initial list of implementations, the test case definition is
* quite similar to a regular test case, with two additional caveats:
* 1. The test case body needs to be wrapped in parentheses.
* 2. Unlike for regular TEST_CASE, tags are non-optional and must be provided.
*/
#define DISABLED_FOR_TEST_CASE(...) \
INTERNAL_CTS_DISABLED_FOR_TEST_CASE(__VA_ARGS__)
#define DISABLED_FOR_TEMPLATE_TEST_CASE_SIG(...) \
INTERNAL_CTS_DISABLED_FOR_TEMPLATE_TEST_CASE_SIG(__VA_ARGS__)
#define DISABLED_FOR_TEMPLATE_LIST_TEST_CASE(...) \
INTERNAL_CTS_DISABLED_FOR_TEMPLATE_LIST_TEST_CASE(__VA_ARGS__)
// ------------------------------------------------------------------------------------
#if SYCL_CTS_COMPILING_WITH_DPCPP
#define INTERNAL_CTS_SYCL_IMPL_DPCPP ()
#elif SYCL_CTS_COMPILING_WITH_ADAPTIVECPP
#define INTERNAL_CTS_SYCL_IMPL_AdaptiveCpp ()
#elif SYCL_CTS_COMPILING_WITH_SIMSYCL
#define INTERNAL_CTS_SYCL_IMPL_SimSYCL ()
#else
#error Unknown SYCL implementation
#endif
// ------------------------------------------------------------------------------------
#define INTERNAL_CTS_IMPL_PROBE(impl) \
_INTERNAL_CTS_IMPL_PROBE_APPEND( \
INTERNAL_CTS_CAT(INTERNAL_CTS_SYCL_IMPL_, impl))
#define _INTERNAL_CTS_IMPL_PROBE_APPEND(x) _INTERNAL_CTS_IMPL_PROBE_EXPAND x
#define _INTERNAL_CTS_IMPL_PROBE_EXPAND(...) INTERNAL_CTS_PROBE()
// Returns 1 if INTERNAL_CTS_SYCL_IMPL_<impl> is set to `()`, 0 otherwise.
#define INTERNAL_CTS_IS_IMPL(impl) \
INTERNAL_CTS_CHECK(INTERNAL_CTS_IMPL_PROBE(impl))
// ------------------------------------------------------------------------------------
// Helper macros for expanding recursive calls.
// This allows us to check for up to 16 + 1 SYCL implementations, which should
// be plenty. (Otherwise this could always be extended by another factor of
// two).
#define INTERNAL_CTS_EVAL(...) INTERNAL_CTS_EVAL16(__VA_ARGS__)
#define INTERNAL_CTS_EVAL16(...) \
INTERNAL_CTS_EVAL8(INTERNAL_CTS_EVAL8(__VA_ARGS__))
#define INTERNAL_CTS_EVAL8(...) \
INTERNAL_CTS_EVAL4(INTERNAL_CTS_EVAL4(__VA_ARGS__))
#define INTERNAL_CTS_EVAL4(...) \
INTERNAL_CTS_EVAL2(INTERNAL_CTS_EVAL2(__VA_ARGS__))
#define INTERNAL_CTS_EVAL2(...) __VA_ARGS__
#define INTERNAL_CTS_EMPTY()
// Defers macro expansion to allow for recursion (prevent macros from being
// "painted blue"). Depending on the nesting level of the recursive call, we
// need multiple defers (3 in this case).
#define INTERNAL_CTS_DEFER3(x) \
x INTERNAL_CTS_EMPTY INTERNAL_CTS_EMPTY INTERNAL_CTS_EMPTY()()()
// ------------------------------------------------------------------------------------
// In case we are compiling with a disabled implementation,
// replace test case with this auto-failing proxy.
// Note that we explicitly receive a description and tags here,
// so we can use the same macro for all types of test cases,
// including those that receive additional parameters.
// A downside of this is that we require test cases to provide
// tags, which normally would be optional.
#define INTERNAL_CTS_DISABLED_TEST_CASE(description, tags, ...) \
TEST_CASE(description, tags) { \
FAIL("This test case has been compile-time disabled."); \
} \
_INTERNAL_CTS_DISCARD
#define _INTERNAL_CTS_DISCARD(...)
#define INTERNAL_CTS_ENABLED_TEST_CASE_BODY(...) \
{ __VA_ARGS__; }
#define INTERNAL_CTS_CHECK_ALL_IMPLS(catchMacroProxy, impl, ...) \
INTERNAL_CTS_IF(INTERNAL_CTS_IS_IMPL(impl)) \
(INTERNAL_CTS_DISABLED_TEST_CASE, \
INTERNAL_CTS_IF(INTERNAL_CTS_HAS_ARGS(__VA_ARGS__))( \
INTERNAL_CTS_DEFER3(_INTERNAL_CTS_CHECK_ALL_IMPLS)()(catchMacroProxy, \
__VA_ARGS__), \
catchMacroProxy))
#define _INTERNAL_CTS_CHECK_ALL_IMPLS() INTERNAL_CTS_CHECK_ALL_IMPLS
#define INTERNAL_CTS_MAYBE_DISABLE_TEST_CASE(catchMacroProxy, ...) \
INTERNAL_CTS_EVAL(INTERNAL_CTS_CHECK_ALL_IMPLS(catchMacroProxy, __VA_ARGS__))
// Define proxies for all supported test macro types
#define INTERNAL_CTS_ENABLED_TEST_CASE(...) \
TEST_CASE(__VA_ARGS__) INTERNAL_CTS_ENABLED_TEST_CASE_BODY
#define INTERNAL_CTS_DISABLED_FOR_TEST_CASE(...) \
INTERNAL_CTS_MAYBE_DISABLE_TEST_CASE(INTERNAL_CTS_ENABLED_TEST_CASE, \
__VA_ARGS__)
#define INTERNAL_CTS_ENABLED_TEMPLATE_TEST_CASE_SIG(...) \
TEMPLATE_TEST_CASE_SIG(__VA_ARGS__) INTERNAL_CTS_ENABLED_TEST_CASE_BODY
#define INTERNAL_CTS_DISABLED_FOR_TEMPLATE_TEST_CASE_SIG(...) \
INTERNAL_CTS_MAYBE_DISABLE_TEST_CASE( \
INTERNAL_CTS_ENABLED_TEMPLATE_TEST_CASE_SIG, __VA_ARGS__)
#define INTERNAL_CTS_ENABLED_TEMPLATE_LIST_TEST_CASE(...) \
TEMPLATE_LIST_TEST_CASE(__VA_ARGS__) INTERNAL_CTS_ENABLED_TEST_CASE_BODY
#define INTERNAL_CTS_DISABLED_FOR_TEMPLATE_LIST_TEST_CASE(...) \
INTERNAL_CTS_MAYBE_DISABLE_TEST_CASE( \
INTERNAL_CTS_ENABLED_TEMPLATE_LIST_TEST_CASE, __VA_ARGS__)
#endif