llvm/utils/update_test_checks.py

   1 #!/usr/bin/env python3
   2
   3 """A script to generate FileCheck statements for 'opt' regression tests.
   4
   5 This script is a utility to update LLVM opt 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_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 -instcombine -S | 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
  27 from __future__ import print_function
  28
  29 import argparse
  30 import os  # Used to advertise this file's name ("autogenerated_note").
  31 import re
  32 import sys
  33
  34 from UpdateTestChecks import common
  35
  36
  37 def main():
  38   from argparse import RawTextHelpFormatter
  39   parser = argparse.ArgumentParser(description=__doc__, formatter_class=RawTextHelpFormatter)
  40   parser.add_argument('--opt-binary', default='opt',
  41                       help='The opt binary used to generate the test case')
  42   parser.add_argument(
  43       '--function', help='The function in the test file to update')
  44   parser.add_argument('-p', '--preserve-names', action='store_true',
  45                       help='Do not scrub IR names')
  46   parser.add_argument('--function-signature', action='store_true',
  47                       help='Keep function signature information around for the check line')
  48   parser.add_argument('--scrub-attributes', action='store_true',
  49                       help='Remove attribute annotations (#0) from the end of check line')
  50   parser.add_argument('--check-attributes', action='store_true',
  51                       help='Check "Function Attributes" for functions')
  52   parser.add_argument('--check-globals', action='store_true',
  53                       help='Check global entries (global variables, metadata, attribute sets, ...) for functions')
  54   parser.add_argument('tests', nargs='+')
  55   initial_args = common.parse_commandline_args(parser)
  56
  57   script_name = os.path.basename(__file__)
  58   opt_basename = os.path.basename(initial_args.opt_binary)
  59   if not re.match(r'^opt(-\d+)?(\.exe)?$', opt_basename):
  60     common.error('Unexpected opt name: ' + opt_basename)
  61     sys.exit(1)
  62   opt_basename = 'opt'
  63
  64   for ti in common.itertests(initial_args.tests, parser,
  65                              script_name='utils/' + script_name):
  66     # If requested we scrub trailing attribute annotations, e.g., '#0', together with whitespaces
  67     if ti.args.scrub_attributes:
  68       common.SCRUB_TRAILING_WHITESPACE_TEST_RE = common.SCRUB_TRAILING_WHITESPACE_AND_ATTRIBUTES_RE
  69     else:
  70       common.SCRUB_TRAILING_WHITESPACE_TEST_RE = common.SCRUB_TRAILING_WHITESPACE_RE
  71
  72     prefix_list = []
  73     for l in ti.run_lines:
  74       if '|' not in l:
  75         common.warn('Skipping unparseable RUN line: ' + l)
  76         continue
  77
  78       commands = [cmd.strip() for cmd in l.split('|')]
  79       assert len(commands) >= 2
  80       preprocess_cmd = None
  81       if len(commands) > 2:
  82         preprocess_cmd = " | ".join(commands[:-2])
  83       tool_cmd = commands[-2]
  84       filecheck_cmd = commands[-1]
  85       common.verify_filecheck_prefixes(filecheck_cmd)
  86       if not tool_cmd.startswith(opt_basename + ' '):
  87         common.warn('Skipping non-%s RUN line: %s' % (opt_basename, l))
  88         continue
  89
  90       if not filecheck_cmd.startswith('FileCheck '):
  91         common.warn('Skipping non-FileChecked RUN line: ' + l)
  92         continue
  93
  94       tool_cmd_args = tool_cmd[len(opt_basename):].strip()
  95       tool_cmd_args = tool_cmd_args.replace('< %s', '').replace('%s', '').strip()
  96
  97       check_prefixes = [item for m in
  98                         common.CHECK_PREFIX_RE.finditer(filecheck_cmd)
  99                         for item in m.group(1).split(',')]
 100       if not check_prefixes:
 101         check_prefixes = ['CHECK']
 102
 103       # FIXME: We should use multiple check prefixes to common check lines. For
 104       # now, we just ignore all but the last.
 105       prefix_list.append((check_prefixes, tool_cmd_args, preprocess_cmd))
 106
 107     global_vars_seen_dict = {}
 108     builder = common.FunctionTestBuilder(
 109       run_list=prefix_list,
 110       flags=ti.args,
 111       scrubber_args=[],
 112       path=ti.path)
 113
 114     for prefixes, opt_args, preprocess_cmd in prefix_list:
 115       common.debug('Extracted opt cmd: ' + opt_basename + ' ' + opt_args)
 116       common.debug('Extracted FileCheck prefixes: ' + str(prefixes))
 117
 118       raw_tool_output = common.invoke_tool(ti.args.opt_binary, opt_args,
 119                                            ti.path, preprocess_cmd=preprocess_cmd,
 120                                            verbose=ti.args.verbose)
 121       builder.process_run_line(common.OPT_FUNCTION_RE, common.scrub_body,
 122               raw_tool_output, prefixes, False)
 123       builder.processed_prefixes(prefixes)
 124
 125     func_dict = builder.finish_and_get_func_dict()
 126     is_in_function = False
 127     is_in_function_start = False
 128     has_checked_pre_function_globals = False
 129     prefix_set = set([prefix for prefixes, _, _ in prefix_list for prefix in prefixes])
 130     common.debug('Rewriting FileCheck prefixes:', str(prefix_set))
 131     output_lines = []
 132
 133     include_generated_funcs = common.find_arg_in_test(ti,
 134                                                       lambda args: ti.args.include_generated_funcs,
 135                                                       '--include-generated-funcs',
 136                                                       True)
 137
 138     if include_generated_funcs:
 139       # Generate the appropriate checks for each function.  We need to emit
 140       # these in the order according to the generated output so that CHECK-LABEL
 141       # works properly.  func_order provides that.
 142
 143       # We can't predict where various passes might insert functions so we can't
 144       # be sure the input function order is maintained.  Therefore, first spit
 145       # out all the source lines.
 146       common.dump_input_lines(output_lines, ti, prefix_set, ';')
 147
 148       args = ti.args
 149       if args.check_globals:
 150           common.add_global_checks(builder.global_var_dict(), ';', prefix_list, output_lines, global_vars_seen_dict, args.preserve_names, True)
 151
 152       # Now generate all the checks.
 153       common.add_checks_at_end(output_lines, prefix_list, builder.func_order(),
 154                                ';', lambda my_output_lines, prefixes, func:
 155                                common.add_ir_checks(my_output_lines, ';',
 156                                                     prefixes,
 157                                                     func_dict, func, False,
 158                                                     args.function_signature,
 159                                                     global_vars_seen_dict,
 160                                                     is_filtered=builder.is_filtered()))
 161     else:
 162       # "Normal" mode.
 163       for input_line_info in ti.iterlines(output_lines):
 164         input_line = input_line_info.line
 165         args = input_line_info.args
 166         if is_in_function_start:
 167           if input_line == '':
 168             continue
 169           if input_line.lstrip().startswith(';'):
 170             m = common.CHECK_RE.match(input_line)
 171             if not m or m.group(1) not in prefix_set:
 172               output_lines.append(input_line)
 173               continue
 174
 175           # Print out the various check lines here.
 176           common.add_ir_checks(output_lines, ';', prefix_list, func_dict,
 177                                func_name, args.preserve_names, args.function_signature,
 178                                global_vars_seen_dict,
 179                                is_filtered=builder.is_filtered())
 180           is_in_function_start = False
 181
 182         m = common.IR_FUNCTION_RE.match(input_line)
 183         if m and not has_checked_pre_function_globals:
 184             if args.check_globals:
 185                 common.add_global_checks(builder.global_var_dict(), ';', prefix_list, output_lines, global_vars_seen_dict, args.preserve_names, True)
 186             has_checked_pre_function_globals = True
 187
 188         if common.should_add_line_to_output(input_line, prefix_set, not is_in_function):
 189             # This input line of the function body will go as-is into the output.
 190             # Except make leading whitespace uniform: 2 spaces.
 191             input_line = common.SCRUB_LEADING_WHITESPACE_RE.sub(r'  ', input_line)
 192             output_lines.append(input_line)
 193             if input_line.strip() == '}':
 194                  is_in_function = False
 195                  continue
 196
 197         if is_in_function:
 198            continue
 199
 200         m = common.IR_FUNCTION_RE.match(input_line)
 201         if not m:
 202           continue
 203         func_name = m.group(1)
 204         if args.function is not None and func_name != 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 args.check_globals:
 210         common.add_global_checks(builder.global_var_dict(), ';', prefix_list, output_lines, global_vars_seen_dict, args.preserve_names, False)
 211     common.debug('Writing %d lines to %s...' % (len(output_lines), ti.path))
 212
 213     with open(ti.path, 'wb') as f:
 214       f.writelines(['{}\n'.format(l).encode('utf-8') for l in output_lines])
 215
 216
 217 if __name__ == '__main__':
 218   main()