Gitiles
Code Review Sign In
gerrit-public.fairphone.software / toolchain / llvm-project / 762bc3351f29b5a71dca31ddd114034a383ff0bd / . / llvm / utils / UpdateTestChecks / common.py
blob: 336ccb9ba77cff06b1e5c08bf9c239b7127a197e [file] [log] [blame]
Fangrui Song3823fc42018-02-02 16:41:07 +0000[diff] [blame]1from __future__ import print_function
Fangrui Songee4e2e72018-01-30 00:40:05 +0000[diff] [blame]2import re
Fangrui Song4f0f4262018-02-10 05:01:33 +0000[diff] [blame]3import string
Fangrui Songee4e2e72018-01-30 00:40:05 +0000[diff] [blame]4import subprocess
Fangrui Song3823fc42018-02-02 16:41:07 +0000[diff] [blame]5import sys
Simon Pilgrimee769442018-06-01 13:37:01 +0000[diff] [blame]6import copy
Fangrui Songee4e2e72018-01-30 00:40:05 +0000[diff] [blame]7
Fangrui Song4f0f4262018-02-10 05:01:33 +0000[diff] [blame]8if sys.version_info[0] > 2:
9 class string:
10 expandtabs = str.expandtabs
11else:
12 import string
Fangrui Songee4e2e72018-01-30 00:40:05 +0000[diff] [blame]13
Fangrui Song4f0f4262018-02-10 05:01:33 +0000[diff] [blame]14##### Common utilities for update_*test_checks.py
Fangrui Songee4e2e72018-01-30 00:40:05 +0000[diff] [blame]15
16def should_add_line_to_output(input_line, prefix_set):
17 # Skip any blank comment lines in the IR.
18 if input_line.strip() == ';':
19 return False
20 # Skip any blank lines in the IR.
21 #if input_line.strip() == '':
22 # return False
23 # And skip any CHECK lines. We're building our own.
24 m = CHECK_RE.match(input_line)
25 if m and m.group(1) in prefix_set:
26 return False
27
28 return True
29
30# Invoke the tool that is being tested.
31def invoke_tool(exe, cmd_args, ir):
32 with open(ir) as ir_file:
Fangrui Song0a301a12018-03-02 17:37:04 +0000[diff] [blame]33 # TODO Remove the str form which is used by update_test_checks.py and
34 # update_llc_test_checks.py
35 # The safer list form is used by update_cc_test_checks.py
36 if isinstance(cmd_args, list):
37 stdout = subprocess.check_output([exe] + cmd_args, stdin=ir_file)
38 else:
39 stdout = subprocess.check_output(exe + ' ' + cmd_args,
40 shell=True, stdin=ir_file)
Fangrui Song3823fc42018-02-02 16:41:07 +0000[diff] [blame]41 if sys.version_info[0] > 2:
42 stdout = stdout.decode()
Fangrui Songee4e2e72018-01-30 00:40:05 +0000[diff] [blame]43 # Fix line endings to unix CR style.
Fangrui Song3823fc42018-02-02 16:41:07 +0000[diff] [blame]44 return stdout.replace('\r\n', '\n')
Fangrui Songee4e2e72018-01-30 00:40:05 +0000[diff] [blame]45
Fangrui Song4f0f4262018-02-10 05:01:33 +0000[diff] [blame]46##### LLVM IR parser
47
Justin Bogner35a9d1b2018-02-28 00:56:24 +0000[diff] [blame]48RUN_LINE_RE = re.compile('^\s*[;#]\s*RUN:\s*(.*)$')
49CHECK_PREFIX_RE = re.compile('--?check-prefix(?:es)?[= ](\S+)')
David Bolvansky45be5e42019-07-29 17:41:00 +0000[diff] [blame]50PREFIX_RE = re.compile('^[a-zA-Z0-9_-]+$')
Justin Bogner35a9d1b2018-02-28 00:56:24 +0000[diff] [blame]51CHECK_RE = re.compile(r'^\s*[;#]\s*([^:]+?)(?:-NEXT|-NOT|-DAG|-LABEL)?:')
Fangrui Song4f0f4262018-02-10 05:01:33 +0000[diff] [blame]52
53OPT_FUNCTION_RE = re.compile(
54 r'^\s*define\s+(?:internal\s+)?[^@]*@(?P<func>[\w-]+?)\s*\('
55 r'(\s+)?[^)]*[^{]*\{\n(?P<body>.*?)^\}$',
56 flags=(re.M | re.S))
57
Simon Pilgrim5334a2c2018-04-06 12:36:27 +0000[diff] [blame]58ANALYZE_FUNCTION_RE = re.compile(
59 r'^\s*\'(?P<analysis>[\w\s-]+?)\'\s+for\s+function\s+\'(?P<func>[\w-]+?)\':'
60 r'\s*\n(?P<body>.*)$',
61 flags=(re.X | re.S))
62
Fangrui Song4f0f4262018-02-10 05:01:33 +0000[diff] [blame]63IR_FUNCTION_RE = re.compile('^\s*define\s+(?:internal\s+)?[^@]*@(\w+)\s*\(')
Justin Bogner35a9d1b2018-02-28 00:56:24 +0000[diff] [blame]64TRIPLE_IR_RE = re.compile(r'^\s*target\s+triple\s*=\s*"([^"]+)"$')
65TRIPLE_ARG_RE = re.compile(r'-mtriple[= ]([^ ]+)')
66MARCH_ARG_RE = re.compile(r'-march[= ]([^ ]+)')
Fangrui Song4f0f4262018-02-10 05:01:33 +0000[diff] [blame]67
68SCRUB_LEADING_WHITESPACE_RE = re.compile(r'^(\s+)')
69SCRUB_WHITESPACE_RE = re.compile(r'(?!^(| \w))[ \t]+', flags=re.M)
70SCRUB_TRAILING_WHITESPACE_RE = re.compile(r'[ \t]+$', flags=re.M)
71SCRUB_KILL_COMMENT_RE = re.compile(r'^ *#+ +kill:.*\n')
72SCRUB_LOOP_COMMENT_RE = re.compile(
73 r'# =>This Inner Loop Header:.*|# in Loop:.*', flags=re.M)
74
75def scrub_body(body):
76 # Scrub runs of whitespace out of the assembly, but leave the leading
77 # whitespace in place.
78 body = SCRUB_WHITESPACE_RE.sub(r' ', body)
79 # Expand the tabs used for indentation.
80 body = string.expandtabs(body, 2)
81 # Strip trailing whitespace.
82 body = SCRUB_TRAILING_WHITESPACE_RE.sub(r'', body)
83 return body
84
Simon Pilgrimee769442018-06-01 13:37:01 +0000[diff] [blame]85def do_scrub(body, scrubber, scrubber_args, extra):
86 if scrubber_args:
87 local_args = copy.deepcopy(scrubber_args)
88 local_args[0].extra_scrub = extra
89 return scrubber(body, *local_args)
90 return scrubber(body, *scrubber_args)
91
Fangrui Songee4e2e72018-01-30 00:40:05 +0000[diff] [blame]92# Build up a dictionary of all the function bodies.
Simon Pilgrimee769442018-06-01 13:37:01 +0000[diff] [blame]93class function_body(object):
94 def __init__(self, string, extra):
95 self.scrub = string
96 self.extrascrub = extra
97 def __str__(self):
98 return self.scrub
99
Fangrui Songee4e2e72018-01-30 00:40:05 +0000[diff] [blame]100def build_function_body_dictionary(function_re, scrubber, scrubber_args, raw_tool_output, prefixes, func_dict, verbose):
101 for m in function_re.finditer(raw_tool_output):
102 if not m:
103 continue
104 func = m.group('func')
Simon Pilgrimee769442018-06-01 13:37:01 +0000[diff] [blame]105 body = m.group('body')
106 scrubbed_body = do_scrub(body, scrubber, scrubber_args, extra = False)
107 scrubbed_extra = do_scrub(body, scrubber, scrubber_args, extra = True)
Roger Ferrer Ibanez52a50392018-12-07 09:49:21 +0000[diff] [blame]108 if 'analysis' in m.groupdict():
Simon Pilgrim5334a2c2018-04-06 12:36:27 +0000[diff] [blame]109 analysis = m.group('analysis')
110 if analysis.lower() != 'cost model analysis':
111 print('WARNING: Unsupported analysis mode: %r!' % (analysis,), file=sys.stderr)
Fangrui Songee4e2e72018-01-30 00:40:05 +0000[diff] [blame]112 if func.startswith('stress'):
113 # We only use the last line of the function body for stress tests.
114 scrubbed_body = '\n'.join(scrubbed_body.splitlines()[-1:])
115 if verbose:
Fangrui Song3823fc42018-02-02 16:41:07 +0000[diff] [blame]116 print('Processing function: ' + func, file=sys.stderr)
Fangrui Songee4e2e72018-01-30 00:40:05 +0000[diff] [blame]117 for l in scrubbed_body.splitlines():
Fangrui Song3823fc42018-02-02 16:41:07 +0000[diff] [blame]118 print(' ' + l, file=sys.stderr)
Fangrui Songee4e2e72018-01-30 00:40:05 +0000[diff] [blame]119 for prefix in prefixes:
Simon Pilgrimee769442018-06-01 13:37:01 +0000[diff] [blame]120 if func in func_dict[prefix] and str(func_dict[prefix][func]) != scrubbed_body:
121 if func_dict[prefix][func] and func_dict[prefix][func].extrascrub == scrubbed_extra:
122 func_dict[prefix][func].scrub = scrubbed_extra
Fangrui Songee4e2e72018-01-30 00:40:05 +0000[diff] [blame]123 continue
Simon Pilgrimee769442018-06-01 13:37:01 +0000[diff] [blame]124 else:
125 if prefix == prefixes[-1]:
126 print('WARNING: Found conflicting asm under the '
127 'same prefix: %r!' % (prefix,), file=sys.stderr)
128 else:
129 func_dict[prefix][func] = None
130 continue
Fangrui Songee4e2e72018-01-30 00:40:05 +0000[diff] [blame]131
Simon Pilgrimee769442018-06-01 13:37:01 +0000[diff] [blame]132 func_dict[prefix][func] = function_body(scrubbed_body, scrubbed_extra)
Fangrui Song4f0f4262018-02-10 05:01:33 +0000[diff] [blame]133
134##### Generator of LLVM IR CHECK lines
135
136SCRUB_IR_COMMENT_RE = re.compile(r'\s*;.*')
137
138# Match things that look at identifiers, but only if they are followed by
139# spaces, commas, paren, or end of the string
Alexander Richardson115b0672018-03-14 20:28:53 +0000[diff] [blame]140IR_VALUE_RE = re.compile(r'(\s+)%([\w\.\-]+?)([,\s\(\)]|\Z)')
Fangrui Song4f0f4262018-02-10 05:01:33 +0000[diff] [blame]141
142# Create a FileCheck variable name based on an IR name.
143def get_value_name(var):
144 if var.isdigit():
145 var = 'TMP' + var
146 var = var.replace('.', '_')
Alexander Richardson115b0672018-03-14 20:28:53 +0000[diff] [blame]147 var = var.replace('-', '_')
Fangrui Song4f0f4262018-02-10 05:01:33 +0000[diff] [blame]148 return var.upper()
149
150
151# Create a FileCheck variable from regex.
152def get_value_definition(var):
153 return '[[' + get_value_name(var) + ':%.*]]'
154
155
156# Use a FileCheck variable.
157def get_value_use(var):
158 return '[[' + get_value_name(var) + ']]'
159
160# Replace IR value defs and uses with FileCheck variables.
Simon Pilgrim5334a2c2018-04-06 12:36:27 +0000[diff] [blame]161def genericize_check_lines(lines, is_analyze):
Fangrui Song4f0f4262018-02-10 05:01:33 +0000[diff] [blame]162 # This gets called for each match that occurs in
163 # a line. We transform variables we haven't seen
164 # into defs, and variables we have seen into uses.
165 def transform_line_vars(match):
166 var = match.group(2)
167 if var in vars_seen:
168 rv = get_value_use(var)
169 else:
170 vars_seen.add(var)
171 rv = get_value_definition(var)
172 # re.sub replaces the entire regex match
173 # with whatever you return, so we have
174 # to make sure to hand it back everything
175 # including the commas and spaces.
176 return match.group(1) + rv + match.group(3)
177
178 vars_seen = set()
179 lines_with_def = []
180
181 for i, line in enumerate(lines):
182 # An IR variable named '%.' matches the FileCheck regex string.
183 line = line.replace('%.', '%dot')
184 # Ignore any comments, since the check lines will too.
185 scrubbed_line = SCRUB_IR_COMMENT_RE.sub(r'', line)
Fangrui Song6ef23e62019-07-22 04:59:01 +0000[diff] [blame]186 if is_analyze:
187 lines[i] = scrubbed_line
Simon Pilgrim5334a2c2018-04-06 12:36:27 +0000[diff] [blame]188 else:
Fangrui Song6ef23e62019-07-22 04:59:01 +0000[diff] [blame]189 lines[i] = IR_VALUE_RE.sub(transform_line_vars, scrubbed_line)
Fangrui Song4f0f4262018-02-10 05:01:33 +0000[diff] [blame]190 return lines
191
192
Simon Pilgrim5334a2c2018-04-06 12:36:27 +0000[diff] [blame]193def add_checks(output_lines, comment_marker, prefix_list, func_dict, func_name, check_label_format, is_asm, is_analyze):
Fangrui Song4f0f4262018-02-10 05:01:33 +0000[diff] [blame]194 printed_prefixes = []
Fangrui Song56fb2b22018-03-14 17:47:07 +0000[diff] [blame]195 for p in prefix_list:
196 checkprefixes = p[0]
Fangrui Song4f0f4262018-02-10 05:01:33 +0000[diff] [blame]197 for checkprefix in checkprefixes:
198 if checkprefix in printed_prefixes:
199 break
Simon Pilgrim978502f2018-04-05 10:26:13 +0000[diff] [blame]200 # TODO func_dict[checkprefix] may be None, '' or not exist.
201 # Fix the call sites.
202 if func_name not in func_dict[checkprefix] or not func_dict[checkprefix][func_name]:
Fangrui Song4f0f4262018-02-10 05:01:33 +0000[diff] [blame]203 continue
Simon Pilgrim978502f2018-04-05 10:26:13 +0000[diff] [blame]204
Fangrui Song4f0f4262018-02-10 05:01:33 +0000[diff] [blame]205 # Add some space between different check prefixes, but not after the last
206 # check line (before the test code).
Fangrui Song6ef23e62019-07-22 04:59:01 +0000[diff] [blame]207 if is_asm:
Simon Pilgrim82962292018-04-05 10:48:38 +0000[diff] [blame]208 if len(printed_prefixes) != 0:
209 output_lines.append(comment_marker)
Simon Pilgrim978502f2018-04-05 10:26:13 +0000[diff] [blame]210
Fangrui Song4f0f4262018-02-10 05:01:33 +0000[diff] [blame]211 printed_prefixes.append(checkprefix)
212 output_lines.append(check_label_format % (checkprefix, func_name))
Simon Pilgrimee769442018-06-01 13:37:01 +0000[diff] [blame]213 func_body = str(func_dict[checkprefix][func_name]).splitlines()
Fangrui Song4f0f4262018-02-10 05:01:33 +0000[diff] [blame]214
Simon Pilgrim82962292018-04-05 10:48:38 +0000[diff] [blame]215 # For ASM output, just emit the check lines.
Fangrui Song6ef23e62019-07-22 04:59:01 +0000[diff] [blame]216 if is_asm:
Simon Pilgrim82962292018-04-05 10:48:38 +0000[diff] [blame]217 output_lines.append('%s %s: %s' % (comment_marker, checkprefix, func_body[0]))
218 for func_line in func_body[1:]:
219 output_lines.append('%s %s-NEXT: %s' % (comment_marker, checkprefix, func_line))
220 break
221
Fangrui Song4f0f4262018-02-10 05:01:33 +0000[diff] [blame]222 # For IR output, change all defs to FileCheck variables, so we're immune
223 # to variable naming fashions.
Simon Pilgrim5334a2c2018-04-06 12:36:27 +0000[diff] [blame]224 func_body = genericize_check_lines(func_body, is_analyze)
Fangrui Song4f0f4262018-02-10 05:01:33 +0000[diff] [blame]225
226 # This could be selectively enabled with an optional invocation argument.
227 # Disabled for now: better to check everything. Be safe rather than sorry.
228
229 # Handle the first line of the function body as a special case because
230 # it's often just noise (a useless asm comment or entry label).
231 #if func_body[0].startswith("#") or func_body[0].startswith("entry:"):
232 # is_blank_line = True
233 #else:
Simon Pilgrim978502f2018-04-05 10:26:13 +0000[diff] [blame]234 # output_lines.append('%s %s: %s' % (comment_marker, checkprefix, func_body[0]))
Fangrui Song4f0f4262018-02-10 05:01:33 +0000[diff] [blame]235 # is_blank_line = False
236
237 is_blank_line = False
238
239 for func_line in func_body:
240 if func_line.strip() == '':
241 is_blank_line = True
242 continue
243 # Do not waste time checking IR comments.
244 func_line = SCRUB_IR_COMMENT_RE.sub(r'', func_line)
245
246 # Skip blank lines instead of checking them.
Fangrui Song6ef23e62019-07-22 04:59:01 +0000[diff] [blame]247 if is_blank_line:
Fangrui Song56fb2b22018-03-14 17:47:07 +0000[diff] [blame]248 output_lines.append('{} {}: {}'.format(
249 comment_marker, checkprefix, func_line))
Fangrui Song4f0f4262018-02-10 05:01:33 +0000[diff] [blame]250 else:
Fangrui Song56fb2b22018-03-14 17:47:07 +0000[diff] [blame]251 output_lines.append('{} {}-NEXT: {}'.format(
252 comment_marker, checkprefix, func_line))
Fangrui Song4f0f4262018-02-10 05:01:33 +0000[diff] [blame]253 is_blank_line = False
254
255 # Add space between different check prefixes and also before the first
256 # line of code in the test function.
Fangrui Song56fb2b22018-03-14 17:47:07 +0000[diff] [blame]257 output_lines.append(comment_marker)
Fangrui Song4f0f4262018-02-10 05:01:33 +0000[diff] [blame]258 break
Simon Pilgrim978502f2018-04-05 10:26:13 +0000[diff] [blame]259
260def add_ir_checks(output_lines, comment_marker, prefix_list, func_dict, func_name):
261 # Label format is based on IR string.
262 check_label_format = '{} %s-LABEL: @%s('.format(comment_marker)
Simon Pilgrim5334a2c2018-04-06 12:36:27 +0000[diff] [blame]263 add_checks(output_lines, comment_marker, prefix_list, func_dict, func_name, check_label_format, False, False)
264
265def add_analyze_checks(output_lines, comment_marker, prefix_list, func_dict, func_name):
266 check_label_format = '{} %s-LABEL: \'%s\''.format(comment_marker)
267 add_checks(output_lines, comment_marker, prefix_list, func_dict, func_name, check_label_format, False, True)
David Bolvansky45be5e42019-07-29 17:41:00 +0000[diff] [blame]268
269
270def check_prefix(prefix):
271 if not PREFIX_RE.match(prefix):
272 hint = ""
273 if ',' in prefix:
274 hint = " Did you mean '--check-prefixes=" + prefix + "'?"
275 print(("WARNING: Supplied prefix '%s' is invalid. Prefix must contain only alphanumeric characters, hyphens and underscores." + hint) %
276 (prefix), file=sys.stderr)
277
278
279def verify_filecheck_prefixes(fc_cmd):
280 fc_cmd_parts = fc_cmd.split()
281 for part in fc_cmd_parts:
282 if "check-prefix=" in part:
283 prefix = part.split('=', 1)[1]
284 check_prefix(prefix)
285 elif "check-prefixes=" in part:
286 prefixes = part.split('=', 1)[1].split(',')
287 for prefix in prefixes:
288 check_prefix(prefix)
289 if prefixes.count(prefix) > 1:
290 print("WARNING: Supplied prefix '%s' is not unique in the prefix list." %
291 (prefix,), file=sys.stderr)