-
Notifications
You must be signed in to change notification settings - Fork 10.8k
/
params.py
326 lines (305 loc) · 12.8 KB
/
params.py
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
# ===----------------------------------------------------------------------===##
#
# Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
# See https://llvm.org/LICENSE.txt for license information.
# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#
# ===----------------------------------------------------------------------===##
from libcxx.test.dsl import *
from libcxx.test.features import _isMSVC
import re
_warningFlags = [
"-Werror",
"-Wall",
"-Wctad-maybe-unsupported",
"-Wextra",
"-Wshadow",
"-Wundef",
"-Wunused-template",
"-Wno-unused-command-line-argument",
"-Wno-attributes",
"-Wno-pessimizing-move",
"-Wno-noexcept-type",
"-Wno-aligned-allocation-unavailable",
"-Wno-atomic-alignment",
"-Wno-reserved-module-identifier",
# GCC warns about places where we might want to add sized allocation/deallocation
# functions, but we know better what we're doing/testing in the test suite.
"-Wno-sized-deallocation",
# Turn off warnings about user-defined literals with reserved suffixes. Those are
# just noise since we are testing the Standard Library itself.
"-Wno-literal-suffix", # GCC
"-Wno-user-defined-literals", # Clang
# GCC warns about this when TEST_IS_CONSTANT_EVALUATED is used on a non-constexpr
# function. (This mostely happens in C++11 mode.)
# TODO(mordante) investigate a solution for this issue.
"-Wno-tautological-compare",
# -Wstringop-overread and -Wstringop-overflow seem to be a bit buggy currently
"-Wno-stringop-overread",
"-Wno-stringop-overflow",
# These warnings should be enabled in order to support the MSVC
# team using the test suite; They enable the warnings below and
# expect the test suite to be clean.
"-Wsign-compare",
"-Wunused-variable",
"-Wunused-parameter",
"-Wunreachable-code",
"-Wno-unused-local-typedef",
# Disable warnings for extensions used in C++03
"-Wno-local-type-template-args",
"-Wno-c++11-extensions",
]
_allStandards = ["c++03", "c++11", "c++14", "c++17", "c++20", "c++23", "c++26"]
def getStdFlag(cfg, std):
# TODO(LLVM-17) Remove this clang-tidy-16 work-around
if std == "c++23":
std = "c++2b"
if hasCompileFlag(cfg, "-std=" + std):
return "-std=" + std
# TODO(LLVM-19) Remove the fallbacks needed for Clang 16.
fallbacks = {
"c++23": "c++2b",
}
if std in fallbacks and hasCompileFlag(cfg, "-std=" + fallbacks[std]):
return "-std=" + fallbacks[std]
return None
_allModules = ["none", "clang", "std"]
def getModuleFlag(cfg, enable_modules):
if enable_modules in _allModules:
return enable_modules
return None
# fmt: off
DEFAULT_PARAMETERS = [
Parameter(
name="target_triple",
type=str,
help="The target triple to compile the test suite for. This must be "
"compatible with the target that the tests will be run on.",
actions=lambda triple: filter(
None,
[
AddFeature("target={}".format(triple)),
AddFlagIfSupported("--target={}".format(triple)),
AddSubstitution("%{triple}", triple),
],
),
),
Parameter(
name="std",
choices=_allStandards,
type=str,
help="The version of the standard to compile the test suite with.",
default=lambda cfg: next(
s for s in reversed(_allStandards) if getStdFlag(cfg, s)
),
actions=lambda std: [
AddFeature(std),
AddSubstitution("%{cxx_std}", re.sub("\+", "x", std)),
AddCompileFlag(lambda cfg: getStdFlag(cfg, std)),
],
),
Parameter(
name="enable_modules",
choices=_allModules,
type=str,
help="Whether to build the test suite with modules enabled. Select "
"`clang` for Clang modules and `std` for C++23 std module",
default=lambda cfg: next(s for s in _allModules if getModuleFlag(cfg, s)),
actions=lambda enable_modules: [
AddFeature("modules-build"),
AddCompileFlag("-fmodules"),
AddCompileFlag("-fcxx-modules"), # AppleClang disregards -fmodules entirely when compiling C++. This enables modules for C++.
]
if enable_modules == "clang"
else [
AddFeature("use_module_std"),
AddCompileFlag("-DTEST_USE_MODULE"),
AddCompileFlag("-DTEST_USE_MODULE_STD"),
AddCompileFlag(
lambda cfg: "-fprebuilt-module-path="
+ os.path.join(
cfg.test_exec_root, "__config_module__/CMakeFiles/std.dir"
)
),
BuildStdModule(),
]
if enable_modules == "std"
else [],
),
Parameter(
name="enable_modules_lsv",
choices=[True, False],
type=bool,
default=False,
help="Whether to enable Local Submodule Visibility in the Modules build.",
actions=lambda lsv: [] if not lsv else [
AddCompileFlag("-Xclang -fmodules-local-submodule-visibility"),
],
),
Parameter(
name="enable_exceptions",
choices=[True, False],
type=bool,
default=True,
help="Whether to enable exceptions when compiling the test suite.",
actions=lambda exceptions: [] if exceptions else [
AddFeature("no-exceptions"),
AddCompileFlag("-fno-exceptions")
],
),
Parameter(
name="enable_rtti",
choices=[True, False],
type=bool,
default=True,
help="Whether to enable RTTI when compiling the test suite.",
actions=lambda rtti: [] if rtti else [
AddFeature("no-rtti"),
AddCompileFlag("-fno-rtti")
],
),
Parameter(
name="stdlib",
choices=["llvm-libc++", "apple-libc++", "libstdc++", "msvc"],
type=str,
default="llvm-libc++",
help="""The C++ Standard Library implementation being tested.
Note that this parameter can also be used to encode different 'flavors' of the same
standard library, such as libc++ as shipped by a different vendor, if it has different
properties worth testing.
The Standard libraries currently supported are:
- llvm-libc++: The 'upstream' libc++ as shipped with LLVM.
- apple-libc++: libc++ as shipped by Apple. This is basically like the LLVM one, but
there are a few differences like installation paths, the use of
universal dylibs and the existence of availability markup.
- libstdc++: The GNU C++ library typically shipped with GCC.
- msvc: The Microsoft implementation of the C++ Standard Library.
""",
actions=lambda stdlib: filter(
None,
[
AddFeature("stdlib={}".format(stdlib)),
# Also add an umbrella feature 'stdlib=libc++' for all flavors of libc++, to simplify
# the test suite.
AddFeature("stdlib=libc++") if re.match(".+-libc\+\+", stdlib) else None,
],
),
),
Parameter(
name="enable_warnings",
choices=[True, False],
type=bool,
default=True,
help="Whether to enable warnings when compiling the test suite.",
actions=lambda warnings: [] if not warnings else
[AddOptionalWarningFlag(w) for w in _warningFlags] +
[AddCompileFlag("-D_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER")],
),
Parameter(
name="use_sanitizer",
choices=[
"",
"Address",
"HWAddress",
"Undefined",
"Memory",
"MemoryWithOrigins",
"Thread",
"DataFlow",
"Leaks",
],
type=str,
default="",
help="An optional sanitizer to enable when building and running the test suite.",
actions=lambda sanitizer: filter(
None,
[
AddFlag("-g -fno-omit-frame-pointer") if sanitizer else None,
AddFlag("-fsanitize=undefined -fno-sanitize=float-divide-by-zero -fno-sanitize-recover=all") if sanitizer == "Undefined" else None,
AddFeature("ubsan") if sanitizer == "Undefined" else None,
AddFlag("-fsanitize=address") if sanitizer == "Address" else None,
AddFeature("asan") if sanitizer == "Address" else None,
AddFlag("-fsanitize=hwaddress") if sanitizer == "HWAddress" else None,
AddFeature("hwasan") if sanitizer == "HWAddress" else None,
AddFlag("-fsanitize=memory") if sanitizer in ["Memory", "MemoryWithOrigins"] else None,
AddFeature("msan") if sanitizer in ["Memory", "MemoryWithOrigins"] else None,
AddFlag("-fsanitize-memory-track-origins") if sanitizer == "MemoryWithOrigins" else None,
AddFlag("-fsanitize=thread") if sanitizer == "Thread" else None,
AddFeature("tsan") if sanitizer == "Thread" else None,
AddFlag("-fsanitize=dataflow") if sanitizer == "DataFlow" else None,
AddFlag("-fsanitize=leaks") if sanitizer == "Leaks" else None,
AddFeature("sanitizer-new-delete") if sanitizer in ["Address", "HWAddress", "Memory", "MemoryWithOrigins", "Thread"] else None,
]
)
),
Parameter(
name="enable_experimental",
choices=[True, False],
type=bool,
default=True,
help="Whether to enable tests for experimental C++ Library features.",
actions=lambda experimental: [
# When linking in MSVC mode via the Clang driver, a -l<foo>
# maps to <foo>.lib, so we need to use -llibc++experimental here
# to make it link against the static libc++experimental.lib.
# We can't check for the feature 'msvc' in available_features
# as those features are added after processing parameters.
AddFeature("c++experimental"),
PrependLinkFlag(lambda cfg: "-llibc++experimental" if _isMSVC(cfg) else "-lc++experimental"),
AddCompileFlag("-D_LIBCPP_ENABLE_EXPERIMENTAL"),
]
if experimental
else [
AddFeature("libcpp-has-no-incomplete-pstl"),
AddFeature("libcpp-has-no-experimental-stop_token"),
],
),
Parameter(
name="long_tests",
choices=[True, False],
type=bool,
default=True,
help="Whether to enable tests that take longer to run. This can be useful when running on a very slow device.",
actions=lambda enabled: [] if not enabled else [AddFeature("long_tests")],
),
Parameter(
name="hardening_mode",
choices=["unchecked", "hardened", "debug"],
type=str,
default="unchecked",
help="Whether to enable the hardened mode or the debug mode when compiling the test suite. This is only "
"meaningful when running the tests against libc++.",
actions=lambda hardening_mode: filter(
None,
[
AddCompileFlag("-D_LIBCPP_ENABLE_HARDENED_MODE=1") if hardening_mode == "hardened" else None,
AddCompileFlag("-D_LIBCPP_ENABLE_DEBUG_MODE=1") if hardening_mode == "debug" else None,
AddFeature("libcpp-has-hardened-mode") if hardening_mode == "hardened" else None,
AddFeature("libcpp-has-debug-mode") if hardening_mode == "debug" else None,
],
),
),
Parameter(
name="additional_features",
type=list,
default=[],
help="A comma-delimited list of additional features that will be enabled when running the tests. "
"This should be used sparingly since specifying ad-hoc features manually is error-prone and "
"brittle in the long run as changes are made to the test suite.",
actions=lambda features: [AddFeature(f) for f in features],
),
Parameter(
name="enable_transitive_includes",
choices=[True, False],
type=bool,
default=True,
help="Whether to enable backwards-compatibility transitive includes when running the tests. This "
"is provided to ensure that the trimmed-down version of libc++ does not bit-rot in between "
"points at which we bulk-remove transitive includes.",
actions=lambda enabled: [] if enabled else [
AddFeature("transitive-includes-disabled"),
AddCompileFlag("-D_LIBCPP_REMOVE_TRANSITIVE_INCLUDES"),
],
),
]
# fmt: on