[UTC] Keep function args parenthesis on label line (bumps version to 3)

[jsilvanus]

Summary

If the function argument block contains patterns, we split argument
matching into a separate SAME line, because LABEL labels may not contain
pattern matches.

Until now, in this case we moved the parenthesis opening the argument block
into the second line.

This generates incorrect labels in case function names are not prefix-free.

For example, for a function foo we generated:

CHECK-LABEL: foo
CHECK-SAME: (<args of foo>)

If the output also contains a function foo.specialzied, then the label for
foo can match foo.specialized, depending on output order.

This patch moves opening parenthesis to the first line, breaking common prefixes:

CHECK-LABEL: foo(
CHECK-SAME: <args of foo>)

Bump the UTC version to 3, and only move the parenthesis for version 3 and later.

The test case is new. I'll precommit it if this patch is accepted.

[jsilvanus]

Remove stale comment from test case.

[jsilvanus]

llvm/utils/UpdateTestChecks/common.py

1285

I'm not a fan of hardcoding "(" here, but this seems to be the only relevant case anyways?

[jdoerfert]

Do we have a fixed policy on version bumps? This seems small enough to be applied to the repository, no?

[mtrofin]

Also not enamored with the "(", but can't think of a better alternative.

[nikic]

In D158497#4621961, @jdoerfert wrote:

Do we have a fixed policy on version bumps? This seems small enough to be applied to the repository, no?

As this change affects ~all tests, I think we do want to bump the version, even if the difference itself is small.

LGTM from my side.

llvm/test/tools/UpdateTestChecks/update_test_checks/Inputs/named_function_arguments_split.ll.expected

10

This would also match if there's extra arguments before it, but I guess that's a less likely situation. Unless there's a way to get both, moving the parentheses seems fine...

[jsilvanus]

llvm/test/tools/UpdateTestChecks/update_test_checks/Inputs/named_function_arguments_split.ll.expected

10

Good point. I don't see a way to support both at this point, but it would be possible with FileCheck support, e.g. a CHECK-SAME variant that requires a match to start right at the end of the previous match, similar to what CHECK-NEXT does with lines.

I'm committing this as-is to fix the existing issue of incorrect matches.
We can add the FileCheck support later if needed.

llvm/test/tools/UpdateTestChecks/update_test_checks/Inputs/named_function_arguments_split.ll.expected

-; NOTE: Assertions have been autogenerated by utils/update_test_checks.py UTC_ARGS: --version 2
+; NOTE: Assertions have been autogenerated by utils/update_test_checks.py UTC_ARGS: --version 3
 ; Check that we split named function arguments correctly into a separate CHECK line,
 ; ensuring the opening parenthesis is on the label name, avoiding incorrect label
 ; matches if function names are not prefix free.
-; Note: This is a precommitted test, the current result is incorrect.
 ;
 ; RUN: opt < %s -passes=instsimplify -S | FileCheck %s
 ;
 define i32 @"foo"(i32 %named) {
-; CHECK-LABEL: define i32 @foo
-; CHECK-SAME: (i32 [[NAMED:%.*]]) {
+; CHECK-LABEL: define i32 @foo(
+; CHECK-SAME: i32 [[NAMED:%.*]]) {
 ; CHECK-NEXT:  entry:
 ; CHECK-NEXT:    ret i32 [[NAMED]]
 ;
 entry:
   ret i32 %named
 }

llvm/test/tools/UpdateTestChecks/update_test_checks/named_function_arguments_split.test

 # REQUIRES: x86-registered-target
 ## Basic test checking that update_test_checks.py works correctly
-# RUN: cp -f %S/Inputs/named_function_arguments_split.ll %t.ll && %update_test_checks %t.ll --version=2
+# RUN: cp -f %S/Inputs/named_function_arguments_split.ll %t.ll && %update_test_checks %t.ll --version=3
 # RUN: diff -u %t.ll %S/Inputs/named_function_arguments_split.ll.expected
 ## Check that running the script again does not change the result:
-# RUN: %update_test_checks %t.ll --version=2
+# RUN: %update_test_checks %t.ll --version=3
 # RUN: diff -u %t.ll %S/Inputs/named_function_arguments_split.ll.expected

llvm/utils/UpdateTestChecks/common.py

 _prefix_filecheck_ir_name = ""
 
 """
 Version changelog:
 
 1: Initial version, used by tests that don't specify --version explicitly.
 2: --function-signature is now enabled by default and also checks return
    type/attributes.
+3: Opening parenthesis of function args is kept on the first LABEL line
+   in case arguments are split to a separate SAME line.
 """
-DEFAULT_VERSION = 2
+DEFAULT_VERSION = 3
 
 
 class Regex(object):
     """Wrap a compiled regular expression object to allow deep copy of a regexp.
     This is required for the deep copy done in do_scrub.
 
     """
 
for p in prefix_list:
                 )
             args_and_sig = str(func_dict[checkprefix][func_name].args_and_sig)
             if args_and_sig:
                 args_and_sig = generalize_check_lines(
                     [args_and_sig], is_analyze, vars_seen, global_vars_seen
                 )[0]
             func_name_separator = func_dict[checkprefix][func_name].func_name_separator
             if "[[" in args_and_sig:
+                # Captures in label lines are not supported, thus split into a -LABEL
+                # and a separate -SAME line that contains the arguments with captures.
+                args_and_sig_prefix = ""
+                if version >= 3 and args_and_sig.startswith("("):
+                    # Ensure the "(" separating function name and arguments is in the
+                    # label line. This is required in case of function names that are
+                    # prefixes of each other. Otherwise, the label line for "foo" might
+                    # incorrectly match on "foo.specialized".
+                    args_and_sig_prefix = args_and_sig[0]
+                    args_and_sig = args_and_sig[1:]
+
+                # Removing args_and_sig from the label match line requires
+                # func_name_separator to be empty. Otherwise, the match will not work.
+                assert func_name_separator == ""
                 output_lines.append(
                     check_label_format
                     % (
                         checkprefix,
                         funcdef_attrs_and_ret,
                         func_name,
-                        "",
+                        args_and_sig_prefix,
                         func_name_separator,
                     )
                 )
                 output_lines.append(
                     "%s %s-SAME: %s" % (comment_marker, checkprefix, args_and_sig)
                 )
             else:
                 output_lines.append(