FileCheck: using numeric variable defined on same line with caveats

Hi,

TL;DR: Is it ok to allow numeric variables used on same line as defined except for CHECK-NOT and with false negatives?

FileCheck does not currently allow a numeric variable from being used on the same line they were defined. I have a tentative patch to add that support but it comes with caveats so before going through review I’d like to get consensus on whether those caveats are acceptable.

== The problem ==

The problem with matching variables defined on the same line is that the matching is done separately from checking the numeric relation, because numeric relation cannot be expressed in regex. That is, when matching [[#VAR:]] [[#VAR+1]] FileCheck is first matching the input against ([0-9]+) ([0-9]+) and then the value of the two captured integer are checked.

This can lead to at times confusing or downward wrong outcomes. Consider the following input with the CHECK pattern mentioned above:

10 12 13

The regex would match numbers 10 and 12 and fail the CHECK directive despite 12 and 13 verifying the +1 relation. This could happen as a result of a change in the input after a new commit has landed. In the case of a CHECK directive, it would make the test regress and a developer would need to tighten the pattern somehow, for instance by chaning it for [[#VAR:]] [[#VAR+1]]{{$}}. Now in the context of a CHECK-NOT this could be a change from input 10 12 14 to 10 12 13 and the pattern would still fail to match and thus the test still pass despite the compiler having regressed.

== Proposed “solution” ==

Given the above, we can summarize the risks of supporting numeric expression using a variable defined on the same line to:

  • test regression on positive matching directives (CHECK, CHECK-NEXT, …)
  • silent compiler regression on negative matching directives (CHECK-NOT)

I am therefore proposing to prevent using numeric variables defined on the same line for negative matching directives but allow it for positive matching directives with a note in the documentation to be careful to make the pattern as tight as possible.

== CHECK-DAG case ==

CHECK-DAG is interesting because despite it being a positive matching directive, there’s a risk with CHECK-DAG in case a test rely on the way CHECK-DAG is implemented. Consider the following directives which rely on each directive being matched in order:

CHECK: BEGIN
CHECK-DAG: [[#VAR1:]] [[#VAR1+1]]
CHECK-DAG: FOO

CHECK-DAG: [[LINE_AFTER_FOO:.*]]

CHECK: END
CHECK-NOT: [[LINE_AFTER_FOO]] BAZ

This could be written if the line checked by the first CHECK-DAG is guaranteed to always be either before FOO or after the line after FOO. Now consider the following input that verifies this invariant:

BEGIN

10 12 13
FOO 10 11

FOOBAR

END

10 12 13 FOOBAR BAZ

The expectation from the test author relying on the CHECK-DAG behavior would be for LINE_AFTER_FOO to have the value FOOBAR once the CHECK-DAG block has matched. However due to the caveats mentioned above it would end up being set to “10 12 13” and thus the CHECK-NOT would pass because “10 12 13” is not followed by “BAZ”. That’s far fetched though, I’m not convinced we should worry about this beyond documenting CHECK-DAG as being able to match in any order.

Thoughts?

Best regards,

Thomas

I think I already gave my opinion on one of the previous patches, regarding CHECK-NOT, which approximately came to the same conclusion as what you’ve got here, so +1 from me. I also think the CHECK-DAG example is not one to care about. It seems to me that there’s no guarantee what CHECK-DAG: [[LINE_AFTER_FOO:.*]] would match, as, if I followed it correctly, CHECK-DAGs don’t have any guarantee of order within a group, so it could match either the next line after BEGIN, the line after [[#VAR1:]] [[#VAR1+1]] or indeed any line before END.

James

Before addressing the CHECK-NOT case, I’m still unclear about the DAG case.

What should the first DAG line match? The regex matching would first attempt to match “10 12” but the expression evaluation would fail; so the DAG candidate wouldn’t match; does this mean the DAG matching does not continue searching, and the test fails? Or would we restart the search…. where? With “0 12” (skipping only one character from the previous fail)? In that case it would ultimately match “12 13” from the first line. Or would it skip the entire previous candidate, and start searching at “ 13”? In which case it would ultimately match “10 11” on the second line.

In any case (if the first DAG ultimately matches something), the third DAG line would match the first previously unmatched text in the DAG search range, which would be either “10 “ or “10 12 13” from the first line, depending on the answer to the previous paragraph.

–paulr

Hi Paul,

Thanks for your question, for some reason I was thinking of CHECK-DAG matching as trying line by line instead of looking for the first match from the start of the block. To answer the first question, the first CHECK-DAG would fail to match altogether since the regex would match 10 12 as you pointed out which wouldn’t satisfy the operation. I don’t think we should skip and try matching again as it is difficult in the general case (think about CHECK-DAG: [[#NUMVAR:]]{{.*}}[[#NUMVAR+1]] and how to deal with the same input 10 12 13).

So my point is completely moot, for a valid input either a DAG match is found and it’s a legitimate match, or a match is not found and the failure will be on the line with the use of a variable defined on the same line which would not be too surprising. My apologies for the confusion.

So my questions should thus be:

  • are we fine with false negative (failing on valid input due to regex engine not understanding numeric values)
  • can you think of any situation that would lead to a false positive (directive match on invalid input) besides CHECK-NOT?

Best regards,

Thomas

Any kind of variable definition on a CHECK-NOT line would seem like it would be asking for trouble. Do we allow text variable definitions on a NOT?

False fails are better than false matches. Given that it will fail on a line where you’d expect a match, or possibly for the line to be skipped, it’s a matter of refining the match expression, which is something that you have to do sometimes anyway. The two-level matching process (regex first, evaluation later) might be surprising to people, and I’d hope the diagnostic would give a hint in that direction.

–paulr

What Paul said :slight_smile:

With a false negative, people will probably go, huh? But that’s okay, as long as it is clear what to do. Documentation and good diagnostic messages should both help.

We should avoid false positives at all costs in tests. I’ve tried thinking hard and I can’t see any problem in this regards, but I can’t say I’d trust my “thinking hard” all that much!

James

So [[#VAR+1]] has two possible behaviors:

  1. It matches the next integer, and then FileCheck fails if that integer is not VAR+1. This is the behavior if VAR is defined in the same directive.

  2. It matches the next integer that is VAR+1, but FileCheck fails if there is no such integer. This is the behavior if VAR is defined in a prior directive.

Is all that correct?

Imagine if someone has learned or assumed behavior #1, perhaps because he’s so far only written numeric variable expressions where VAR is defined in the same directive. Then let’s say he writes a directive where VAR is defined in a prior directive:

CHECK: [[#VAR:]]
CHECK: [[#VAR+1]]

Input: 10 11

He’s used to behavior #1, so he won’t expect that there will be a false pass when the input evolves to “10 9 11” because the behavior is actually #2 in this case.

Consider instead having consistent behavior for all occurrences of [[#VAR+1]]. Perhaps the decision will be not to permit the variable to be defined in the same directive because it’s too hard to implement behavior #2 in that case. I believe it is still possible to achieve either behavior with separate directives. For example, to convert my directives above from behavior #2 to behavior #1:

CHECK: [[#VAR1:]]
CHECK-NOT: [[#]]
CHECK: [[#VAR1+1]]

Joel