llvm/utils/update_analyze_test_checks.py

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