forked from GPUOpen-Drivers/llpc
-
Notifications
You must be signed in to change notification settings - Fork 0
/
update_llpc_test_checks.py
executable file
·330 lines (269 loc) · 12.6 KB
/
update_llpc_test_checks.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
327
328
329
330
#!/usr/bin/env python3
# This script is based on the LLVM Project's update_test_checks.py, which is
# licensed under the Apache License v2.0 with LLVM Exceptions; see the file
# UpdateTestChecks/LICENSE.txt relative to this directory. It has been heavily
# modified for use with LLPC.
"""Generate FileCheck statements for LLPC lit tests.
This tool is designed to be used on LLPC lit tests that are configured to
output a single batch of intermediate IR, for example, using the -emit-lgc
option.
Example usage:
# Default to using `amdllpc` as found in your PATH.
$ update_llpc_test_checks.py llpc/test/foo.comp
# Override the lookup of amdllpc.
$ update_llpc_test_checks.py --tool-binary=../../../build/dbg/compiler/llpc/amdllpc llpc/test/foo.comp
"""
import argparse
import os # Used to advertise this file's name ("autogenerated_note").
import re
import sys
from typing import List
from UpdateTestChecks import common
###############################################################################
# PAL metadata support
PAL_METADATA_RE = re.compile(
r'^[ \t]*\.amdgpu_pal_metadata\n'
r'---\n'
r'(?P<metadata>.*?)'
r'^...\n',
flags=(re.MULTILINE | re.DOTALL))
YAML_INDENT_RE = re.compile(r'(?P<indent>[ -]*)((?P<name>[^:]+):)?')
YAML_SUFFIX_RE = re.compile(r':[^:]*$')
HEX_RE = re.compile(r'0x[0-9a-f]+')
def process_pal_metadata(pal_metadata_dict, prefixes, raw_tool_output):
m = PAL_METADATA_RE.search(raw_tool_output)
if not m:
common.warn(f"Did not find PAL metadata")
return
metadata_in_lines = m.group("metadata").splitlines()
scrubbed_lines = []
scope = []
def get_scope_path():
return ''.join(name for name, _ in scope)
for line in metadata_in_lines:
m = YAML_INDENT_RE.match(line)
indent = len(m.group("indent"))
scope = [(name, ind) for name, ind in scope if ind < indent]
if m.group("name") is not None:
scope.append((m.group("name"), indent))
path = get_scope_path()
if 'hash' in path:
line = HEX_RE.subn("0x{{[0-9a-f]+}}", line)[0]
elif 'llpc_version' in path or 'PGM_CHKSUM' in path:
line = YAML_SUFFIX_RE.subn(": {{.*}}", line)[0]
scrubbed_lines.append(line)
metadata = '\n'.join(scrubbed_lines)
for prefix in prefixes:
if prefix not in pal_metadata_dict:
pal_metadata_dict[prefix] = metadata
else:
if pal_metadata_dict[prefix] != metadata:
pal_metadata_dict[prefix] = None
def add_pal_metadata_checks(pal_metadata_dict, comment_prefix, prefix_list,
output_lines: List[str]):
written_prefixes = set()
for prefix_list_entry in prefix_list:
prefixes = prefix_list_entry[0]
for prefix in prefixes:
if prefix in pal_metadata_dict and pal_metadata_dict[prefix] is not None:
break
else:
common.warn(f"Did not find PAL metadata for prefix list {prefixes}")
return
if prefix in written_prefixes:
continue
output_lines.append(comment_prefix)
output_lines.append(f'{comment_prefix} {prefix}-LABEL: .amdgpu_pal_metadata')
output_lines.append(f'{comment_prefix} {prefix}-NEXT: ---')
for line in pal_metadata_dict[prefix].splitlines():
output_lines.append(f'{comment_prefix} {prefix}-NEXT: {line}')
output_lines.append(f'{comment_prefix} {prefix}-NEXT: ...')
written_prefixes.add(prefix)
###############################################################################
# Assembly support
ASM_FUNCTION_AMDGPU_RE = re.compile(
r'^_?(?P<func>[^:\n]+):[ \t]*(?:;+[ \t]*@"?(?P=func)"?)?\n[^:]*?'
r'(?P<body>.*?)\n' # (body of the function)
# This list is incomplete
r'^\s*(\.Lfunc_end[0-9]+:\n|\.section)',
flags=(re.M | re.S))
def scrub_asm_amdgpu(asm, *args):
# Scrub runs of whitespace out of the assembly, but leave the leading
# whitespace in place.
asm = common.SCRUB_WHITESPACE_RE.sub(r' ', asm)
# Expand the tabs used for indentation.
asm = str.expandtabs(asm, 2)
# Strip trailing whitespace.
asm = common.SCRUB_TRAILING_WHITESPACE_RE.sub(r'', asm)
return asm
def add_asm_checks(output_lines, comment_marker, prefix_list, func_dict,
func_name, global_vars_seen_dict, args, is_filtered):
# Label format is based on ASM string.
check_label_format = '{} %s-LABEL: %s%s%s'.format(comment_marker)
return common.add_checks(output_lines, comment_marker, prefix_list, func_dict,
func_name, check_label_format, True, False,
global_vars_seen_dict, is_filtered=is_filtered)
def add_ir_checks(output_lines, comment_marker, prefix_list, func_dict,
func_name, global_vars_seen_dict, args, is_filtered):
return common.add_ir_checks(output_lines, comment_marker, prefix_list,
func_dict, func_name, False, args.function_signature,
global_vars_seen_dict, is_filtered)
COMMENT_PREFIXES_BY_FILE_SUFFIX = {
'.pipe': ';',
'.spvasm': ';',
'.ll': ';',
'.lgc': ';',
# Everything else defaults to '//'
}
def get_comment_prefix(test_name: str, input_lines):
ext = os.path.splitext(test_name)[1]
return COMMENT_PREFIXES_BY_FILE_SUFFIX.get(ext, '//')
def main():
from argparse import RawTextHelpFormatter
parser = argparse.ArgumentParser(description=__doc__, formatter_class=RawTextHelpFormatter)
parser.add_argument('--tool', default='amdllpc',
help='The name of the tool used to generate the test case (defaults to "amdllpc")')
parser.add_argument('--tool-binary',
help='The tool binary used to generate the test case')
parser.add_argument('--function', help='Only update functions whose name matches the given regex')
parser.add_argument('-p', '--preserve-names', action='store_true',
help='Do not scrub IR names')
parser.add_argument('--function-signature', action='store_true',
help='Keep function signature information around for the check line')
parser.add_argument('--scrub-attributes', action='store_true',
help='Remove attribute annotations (#0) from the end of check line')
parser.add_argument('--check-attributes', action='store_true',
help='Check "Function Attributes" for functions')
parser.add_argument('--check-globals', action='store_true',
help='Check global entries (global variables, metadata, attribute sets, ...) for functions')
parser.add_argument('--check-pal-metadata', action='store_true',
help='Check PAL metadata in output assembly')
parser.add_argument('tests', nargs='+')
initial_args = common.parse_commandline_args(parser)
if initial_args.tool_binary:
tool_basename = os.path.basename(initial_args.tool_binary)
if not re.match(r'^%s(-\d+)?(\.exe)?$' % (initial_args.tool), tool_basename):
common.error('Unexpected tool name: ' + tool_basename)
sys.exit(1)
for ti in common.itertests(initial_args.tests, parser, 'tool/update_llpc_test_checks.py',
comment_prefix_callback=get_comment_prefix):
# If requested we scrub trailing attribute annotations, e.g., '#0', together with whitespaces
if ti.args.scrub_attributes:
common.SCRUB_TRAILING_WHITESPACE_TEST_RE = common.SCRUB_TRAILING_WHITESPACE_AND_ATTRIBUTES_RE
else:
common.SCRUB_TRAILING_WHITESPACE_TEST_RE = common.SCRUB_TRAILING_WHITESPACE_RE
tool_basename = ti.args.tool
tool_binary = tool_basename
if tool_basename == initial_args.tool and initial_args.tool_binary:
tool_binary = initial_args.tool_binary
prefix_list = []
for l in ti.run_lines:
if '|' not in l:
common.warn('Skipping unparsable RUN line: ' + l)
continue
commands = [cmd.strip() for cmd in l.split('|')]
assert len(commands) >= 2
if len(commands) > 2:
common.error('Complex pipes are unsupported')
sys.exit(1)
tool_cmd = commands[-2]
filecheck_cmd = commands[-1]
common.verify_filecheck_prefixes(filecheck_cmd)
if not tool_cmd.startswith(tool_basename + ' '):
common.warn('Skipping non-%s RUN line: %s' % (tool_basename, l))
continue
if not filecheck_cmd.startswith('FileCheck '):
common.warn('Skipping non-FileChecked RUN line: ' + l)
continue
tool_cmd_args = tool_cmd[len(tool_basename):].strip()
check_prefixes = [item for m in
common.CHECK_PREFIX_RE.finditer(filecheck_cmd)
for item in m.group(1).split(',')]
if not check_prefixes:
check_prefixes = ['CHECK']
# FIXME: We should use multiple check prefixes to common check lines. For
# now, we just ignore all but the last.
prefix_list.append((check_prefixes, tool_cmd_args))
global_vars_seen_dict = {}
builder = common.FunctionTestBuilder(
run_list=prefix_list,
flags=ti.args,
scrubber_args=[],
path=ti.path)
function_re = None
scrubber = None
add_checks = None
is_backend = None
pal_metadata_dict = {}
for prefixes, tool_args in prefix_list:
common.debug('Extracted tool cmd: ' + tool_basename + ' ' + tool_args)
common.debug('Extracted FileCheck prefixes: ' + str(prefixes))
raw_tool_output = common.invoke_tool_only(tool_binary, tool_args, ti.path,
verbose=ti.args.verbose)
is_ir = common.OPT_FUNCTION_RE.search(raw_tool_output) is not None
if is_ir:
assert is_backend is None or is_backend == False # Currently can't support a mix of RUN lines
function_re = common.OPT_FUNCTION_RE
scrubber = common.scrub_body
add_checks = add_ir_checks
is_backend = False
else:
assert is_backend is None or is_backend == True # Currently can't support a mix of RUN lines
function_re = ASM_FUNCTION_AMDGPU_RE
scrubber = scrub_asm_amdgpu
add_checks = add_asm_checks
is_backend = True
builder.process_run_line(function_re, scrubber, raw_tool_output, prefixes,
is_backend)
builder.processed_prefixes(prefixes)
if ti.args.check_pal_metadata:
if not is_backend:
common.error(f"{ti.path}: --check-pal-metadata only applies with asm output")
sys.exit(1)
process_pal_metadata(pal_metadata_dict, prefixes, raw_tool_output)
func_dict = builder.finish_and_get_func_dict()
prefix_set = set([prefix for prefixes, _ in prefix_list for prefix in prefixes])
common.debug('Rewriting FileCheck prefixes:', str(prefix_set))
output_lines = []
# Generate the appropriate checks for each function. We need to emit
# these in the order according to the generated output so that CHECK-LABEL
# works properly. func_order provides that.
# We can't predict where various passes might insert functions so we can't
# be sure the input function order is maintained. Therefore, first spit
# out all the source lines.
common.dump_input_lines(output_lines, ti, prefix_set, ti.comment_prefix)
args = ti.args
if args.check_globals:
common.add_global_checks(builder.global_var_dict(), ti.comment_prefix,
prefix_list, output_lines, global_vars_seen_dict,
args.preserve_names, True)
# Filter out functions
func_order = builder.func_order()
if ti.args.function:
filter_re = re.compile(ti.args.function)
new_func_order = {}
for prefix, func_names in func_order.items():
new_func_order[prefix] = [
func_name for func_name in func_names
if filter_re.search(func_name)
]
func_order = new_func_order
# Now generate all the checks.
common.add_checks_at_end(output_lines, prefix_list, func_order,
ti.comment_prefix, lambda my_output_lines, prefixes, func:
add_checks(my_output_lines, ti.comment_prefix,
prefixes, func_dict, func,
global_vars_seen_dict, args,
is_filtered=builder.is_filtered()))
if args.check_globals:
common.add_global_checks(builder.global_var_dict(), ti.comment_prefix,
prefix_list, output_lines, global_vars_seen_dict,
args.preserve_names, False)
if args.check_pal_metadata:
add_pal_metadata_checks(pal_metadata_dict, ti.comment_prefix, prefix_list,
output_lines)
common.debug('Writing %d lines to %s...' % (len(output_lines), ti.path))
with open(ti.path, 'wb') as f:
f.writelines(['{}\n'.format(l).encode('utf-8') for l in output_lines])
if __name__ == '__main__':
main()