llvm-project
224 строки · 8.3 Кб
1#!/usr/bin/env python3
2
3"""A script to generate FileCheck statements for 'opt' analysis tests.
4
5This script is a utility to update LLVM opt analysis test cases with new
6FileCheck patterns. It can either update all of the tests in the file or
7a single test function.
8
9Example usage:
10$ update_analyze_test_checks.py --opt=../bin/opt test/foo.ll
11
12Workflow:
131. Make a compiler patch that requires updating some number of FileCheck lines
14in regression test files.
152. Save the patch and revert it from your local work area.
163. Update the RUN-lines in the affected regression tests to look canonical.
17Example: "; RUN: opt < %s -passes='print<cost-model>' -disable-output 2>&1 | FileCheck %s"
184. Refresh the FileCheck lines for either the entire file or select functions by
19running this script.
205. Commit the fresh baseline of checks.
216. Apply your patch from step 1 and rebuild your local binaries.
227. Re-run this script on affected regression tests.
238. Check the diffs to ensure the script has done something reasonable.
249. Submit a patch including the regression test diffs for review.
25
26A common pattern is to have the script insert complete checking of every
27instruction. Then, edit it down to only check the relevant instructions.
28The script is designed to make adding checks to a test case fast, it is *not*
29designed to be authoratitive about what constitutes a good test!
30"""
31
32from __future__ import print_function33
34import argparse35import os # Used to advertise this file's name ("autogenerated_note").36import sys37import re38
39from UpdateTestChecks import common40
41
42def main():43from argparse import RawTextHelpFormatter44
45parser = argparse.ArgumentParser(46description=__doc__, formatter_class=RawTextHelpFormatter47)48parser.add_argument(49"--opt-binary",50default="opt",51help="The opt binary used to generate the test case",52)53parser.add_argument("--function", help="The function in the test file to update")54parser.add_argument("tests", nargs="+")55initial_args = common.parse_commandline_args(parser)56
57script_name = os.path.basename(__file__)58
59opt_basename = os.path.basename(initial_args.opt_binary)60if opt_basename != "opt":61common.error("Unexpected opt name: " + opt_basename)62sys.exit(1)63
64for ti in common.itertests(65initial_args.tests, parser, script_name="utils/" + script_name66):67triple_in_ir = None68for l in ti.input_lines:69m = common.TRIPLE_IR_RE.match(l)70if m:71triple_in_ir = m.groups()[0]72break73
74prefix_list = []75for l in ti.run_lines:76if "|" not in l:77common.warn("Skipping unparsable RUN line: " + l)78continue79
80(tool_cmd, filecheck_cmd) = tuple([cmd.strip() for cmd in l.split("|", 1)])81common.verify_filecheck_prefixes(filecheck_cmd)82
83if not tool_cmd.startswith(opt_basename + " "):84common.warn("WSkipping non-%s RUN line: %s" % (opt_basename, l))85continue86
87if not filecheck_cmd.startswith("FileCheck "):88common.warn("Skipping non-FileChecked RUN line: " + l)89continue90
91tool_cmd_args = tool_cmd[len(opt_basename) :].strip()92tool_cmd_args = tool_cmd_args.replace("< %s", "").replace("%s", "").strip()93check_prefixes = common.get_check_prefixes(filecheck_cmd)94
95# FIXME: We should use multiple check prefixes to common check lines. For96# now, we just ignore all but the last.97prefix_list.append((check_prefixes, tool_cmd_args))98
99ginfo = common.make_analyze_generalizer(version=1)100builder = common.FunctionTestBuilder(101run_list=prefix_list,102flags=type(103"",104(object,),105{106"verbose": ti.args.verbose,107"filters": ti.args.filters,108"function_signature": False,109"check_attributes": False,110"replace_value_regex": [],111},112),113scrubber_args=[],114path=ti.path,115ginfo=ginfo,116)117
118for prefixes, opt_args in prefix_list:119common.debug("Extracted opt cmd:", opt_basename, opt_args, file=sys.stderr)120common.debug(121"Extracted FileCheck prefixes:", str(prefixes), file=sys.stderr122)123
124raw_tool_outputs = common.invoke_tool(ti.args.opt_binary, opt_args, ti.path)125
126if re.search(r"Printing analysis ", raw_tool_outputs) is not None:127# Split analysis outputs by "Printing analysis " declarations.128for raw_tool_output in re.split(129r"Printing analysis ", raw_tool_outputs130):131builder.process_run_line(132common.ANALYZE_FUNCTION_RE,133common.scrub_body,134raw_tool_output,135prefixes,136)137elif (138re.search(r"(LV|LDist): Checking a loop in ", raw_tool_outputs)139is not None140):141for raw_tool_output in re.split(142r"(LV|LDist): Checking a loop in ", raw_tool_outputs143):144builder.process_run_line(145common.LOOP_PASS_DEBUG_RE,146common.scrub_body,147raw_tool_output,148prefixes,149)150else:151common.warn("Don't know how to deal with this output")152continue153
154builder.processed_prefixes(prefixes)155
156func_dict = builder.finish_and_get_func_dict()157is_in_function = False158is_in_function_start = False159prefix_set = set([prefix for prefixes, _ in prefix_list for prefix in prefixes])160common.debug("Rewriting FileCheck prefixes:", str(prefix_set), file=sys.stderr)161output_lines = []162
163generated_prefixes = []164for input_info in ti.iterlines(output_lines):165input_line = input_info.line166args = input_info.args167if is_in_function_start:168if input_line == "":169continue170if input_line.lstrip().startswith(";"):171m = common.CHECK_RE.match(input_line)172if not m or m.group(1) not in prefix_set:173output_lines.append(input_line)174continue175
176# Print out the various check lines here.177generated_prefixes.extend(178common.add_analyze_checks(179output_lines,180";",181prefix_list,182func_dict,183func_name,184ginfo,185is_filtered=builder.is_filtered(),186)187)188is_in_function_start = False189
190if is_in_function:191if common.should_add_line_to_output(input_line, prefix_set):192# This input line of the function body will go as-is into the output.193output_lines.append(input_line)194else:195continue196if input_line.strip() == "}":197is_in_function = False198continue199
200# If it's outside a function, it just gets copied to the output.201output_lines.append(input_line)202
203m = common.IR_FUNCTION_RE.match(input_line)204if not m:205continue206func_name = m.group(1)207if ti.args.function is not None and func_name != ti.args.function:208# When filtering on a specific function, skip all others.209continue210is_in_function = is_in_function_start = True211
212if ti.args.gen_unused_prefix_body:213output_lines.extend(214ti.get_checks_for_unused_prefixes(prefix_list, generated_prefixes)215)216
217common.debug("Writing %d lines to %s..." % (len(output_lines), ti.path))218
219with open(ti.path, "wb") as f:220f.writelines(["{}\n".format(l).encode("utf-8") for l in output_lines])221
222
223if __name__ == "__main__":224main()225