utils/update_mir_test_checks.py: support UTC_ARGS

[gbossu]

Summary

As a reminder, UTC_ARGS is used by lit test cases to specify which
arguments need to be passed to update_XXXX_test_checks.py to be
auto-updated properly.

The support is achieved by relying on common.itertests, which is what other test
updaters use to iterate over test files.

This commit also changes how the --llc-binary option is saved in args.
It used to be saved as "llc", but it is here changed to the standard
"llc_binary" to make use of an existing ignore mechanism for specific
arguments. Without that change, the option would not be ignored and
would appear in UTC_ARGS. This would be different from what e.g.
update_llc_test_checks does. As update_mir_test_checks.py now supports
UTC_ARGS, it became important to ensure the option is ignored.

Depends on D135579

[nhaehnle]

llvm/test/tools/UpdateTestChecks/update_mir_test_checks/print-stack.test

4–7

The common pattern for this is just re-run update_xxx_test_checks on %t.mir, but without the --print-fixed-stack argument.

Also, remove the print-stack-update.mir file.

[gbossu]

llvm/test/tools/UpdateTestChecks/update_mir_test_checks/print-stack.test

4–7

I usually tend to prefer having tests as self-contained as possible to have more control over their inputs. But then again, I'm fine making the change, I think this also is a valid approach.

[gbossu]

llvm/test/tools/UpdateTestChecks/update_mir_test_checks/print-stack.test

4–7

@nhaehnle Would you like me to change the test?

[nhaehnle]

llvm/test/tools/UpdateTestChecks/update_mir_test_checks/print-stack.test

4–7

Yes, please. We should follow a consistent pattern.

[gbossu]

Remove print-stack-update.mir test input file and just re-run update_mir_test_checks on the existing file instead.

[gbossu]

llvm/test/tools/UpdateTestChecks/update_mir_test_checks/print-stack.test

4–7

Fine to me, I pushed the change.

[nhaehnle]

Thank you, LGTM

[gbossu]

Rebase on latest main, otherwise tests seem to timeout.

[arichardson]

In D135580#3960700, @gbossu wrote:

Rebase on latest main, otherwise tests seem to timeout.

You can ignore the libfuzzer test failure - it's unrelated. I filed https://github.com/llvm/llvm-project/issues/59197 a few days ago since I noticed it failing on almost all reviews.

[gbossu]

In D135580#3961470, @arichardson wrote:

In D135580#3960700, @gbossu wrote:

Rebase on latest main, otherwise tests seem to timeout.

You can ignore the libfuzzer test failure - it's unrelated. I filed https://github.com/llvm/llvm-project/issues/59197 a few days ago since I noticed it failing on almost all reviews.

Thank you, I suspected that and checked other pre-merge builds, but I guess I checked the wrong ones :)

[aemerson]

Hi, it seems this fixedStack and related changes in the script breaks updating the regbankselect-amdgcn.s.buffer.load.ll from https://reviews.llvm.org/D150230

I had to check out an older update script to process that test.

llvm/test/tools/UpdateTestChecks/update_mir_test_checks/Inputs/print-stack.mir.expected

-# NOTE: Assertions have been autogenerated by utils/update_mir_test_checks.py
+# NOTE: Assertions have been autogenerated by utils/update_mir_test_checks.py UTC_ARGS: --print-fixed-stack
 # RUN: llc -mtriple=x86_64-linux-gnu -run-pass=none -o - %s | FileCheck %s
 
 # Note that this file isn't a test in itself (Inputs/ is excluded from lit's
 # test discovery). Instead, it is an input to the print-stack.test test that
 # verifies the --print-fixed-stack option of update_mir_test_checks.py.
 
 ---
 name:            test_arg_stack

llvm/test/tools/UpdateTestChecks/update_mir_test_checks/print-stack.test

 # REQUIRES: x86-registered-target
 ## Check that update_mir_test_checks handles --print-fixed-stack properly.
 
 ## Verify with --print-fixed-stack, the proper CHECK lines for fixedStack are
-## generated.
+## generated, and UTC_ARGS is written in the header comment.
 # RUN: cp -f %S/Inputs/print-stack-first.mir %t.mir && %update_mir_test_checks %t.mir --print-fixed-stack
 # RUN: diff -u %S/Inputs/print-stack.mir.expected %t.mir
+
+## Check that re-running without --print-fixed-stack does not change the
+## CHECK lines, because of UTC_ARGS.
+# RUN: %update_mir_test_checks %t.mir
+# RUN: diff -u %S/Inputs/print-stack.mir.expected %t.mir

llvm/utils/update_mir_test_checks.py

 def should_add_line_to_output(input_line, prefix_set):
     # Skip any check lines that we're handling.
     m = common.CHECK_RE.match(input_line)
     if m and m.group(1) in prefix_set:
         return False
     return True
 
 
-def update_test_file(args, test):
+def update_test_file(args, test, autogenerated_note):
     with open(test) as fd:
         input_lines = [l.rstrip() for l in fd]
 
-    script_name = os.path.basename(__file__)
-    first_line = input_lines[0] if input_lines else ""
-    if 'autogenerated' in first_line and script_name not in first_line:
-        common.warn("Skipping test which wasn't autogenerated by " +
-                    script_name + ": " + test)
-        return
-
-    if args.update_only:
-      if not first_line or 'autogenerated' not in first_line:
-        common.warn("Skipping test which isn't autogenerated: " + test)
-        return
-
     triple_in_ir = find_triple_in_ir(input_lines, args.verbose)
     run_lines = common.find_run_lines(test, input_lines)
     run_list = build_run_list(test, run_lines, args.verbose)
 
     simple_functions = find_functions_with_one_bb(input_lines, args.verbose)
 
     func_dict = {}
     for run in run_list:
         for prefix in run.prefixes:
             func_dict.update({prefix: dict()})
     for prefixes, llc_args, triple_in_cmd in run_list:
         log('Extracted LLC cmd: llc {}'.format(llc_args), args.verbose)
         log('Extracted FileCheck prefixes: {}'.format(prefixes), args.verbose)
 
-        raw_tool_output = args.llc(llc_args, test)
+        raw_tool_output = args.llc_binary(llc_args, test)
         if not triple_in_cmd and not triple_in_ir:
             common.warn('No triple found: skipping file', test_file=test)
             return
 
         build_function_info_dictionary(test, raw_tool_output,
                                        triple_in_cmd or triple_in_ir,
                                        prefixes, func_dict, args.verbose)
 
     state = 'toplevel'
     func_name = None
     prefix_set = set([prefix for run in run_list for prefix in run.prefixes])
     log('Rewriting FileCheck prefixes: {}'.format(prefix_set), args.verbose)
 
-    comment_char = '#' if test.endswith('.mir') else ';'
-    autogenerated_note = ('{} NOTE: Assertions have been autogenerated by '
-                          'utils/{}'.format(comment_char, script_name))
     output_lines = []
     output_lines.append(autogenerated_note)
 
     for input_line in input_lines:
         if input_line == autogenerated_note:
             continue
 
         if state == 'toplevel':
def update_test_file(args, test, autogenerated_note):
 
     with open(test, 'wb') as fd:
         fd.writelines(['{}\n'.format(l).encode('utf-8') for l in output_lines])
 
 
 def main():
     parser = argparse.ArgumentParser(
         description=__doc__, formatter_class=argparse.RawTextHelpFormatter)
-    parser.add_argument('--llc-binary', dest='llc', default='llc', type=LLC,
+    parser.add_argument('--llc-binary', default='llc', type=LLC,
                         help='The "llc" binary to generate the test case with')
     parser.add_argument('--print-fixed-stack', action='store_true',
                         help='Add check lines for fixedStack')
     parser.add_argument('tests', nargs='+')
     args = common.parse_commandline_args(parser)
 
-    test_paths = [test for pattern in args.tests for test in glob.glob(pattern)]
-    for test in test_paths:
+    script_name = os.path.basename(__file__)
+    for ti in common.itertests(args.tests, parser,
+                               script_name='utils/' + script_name):
         try:
-            update_test_file(args, test)
+            update_test_file(ti.args, ti.path, ti.test_autogenerated_note)
         except Exception:
-            common.warn('Error processing file', test_file=test)
+            common.warn('Error processing file', test_file=ti.path)
             raise
 
 
 if __name__ == '__main__':
   main()