2012-05-09 00:50:35 +08:00
|
|
|
FileCheck - Flexible pattern matching file verifier
|
|
|
|
===================================================
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
--------
|
|
|
|
|
2012-11-30 03:21:02 +08:00
|
|
|
:program:`FileCheck` *match-filename* [*--check-prefix=XXX*] [*--strict-whitespace*]
|
2012-05-09 00:50:35 +08:00
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
-----------
|
|
|
|
|
2012-11-30 03:21:02 +08:00
|
|
|
:program:`FileCheck` reads two files (one from standard input, and one
|
|
|
|
specified on the command line) and uses one to verify the other. This
|
|
|
|
behavior is particularly useful for the testsuite, which wants to verify that
|
|
|
|
the output of some tool (e.g. :program:`llc`) contains the expected information
|
|
|
|
(for example, a movsd from esp or whatever is interesting). This is similar to
|
|
|
|
using :program:`grep`, but it is optimized for matching multiple different
|
|
|
|
inputs in one file in a specific order.
|
2012-05-09 00:50:35 +08:00
|
|
|
|
2012-11-30 03:21:02 +08:00
|
|
|
The ``match-filename`` file specifies the file that contains the patterns to
|
2013-07-15 02:12:25 +08:00
|
|
|
match. The file to verify is read from standard input unless the
|
|
|
|
:option:`--input-file` option is used.
|
2012-05-09 00:50:35 +08:00
|
|
|
|
|
|
|
OPTIONS
|
|
|
|
-------
|
|
|
|
|
2018-11-07 06:07:03 +08:00
|
|
|
Options are parsed from the environment variable ``FILECHECK_OPTS``
|
|
|
|
and from the command line.
|
|
|
|
|
2012-11-30 03:21:02 +08:00
|
|
|
.. option:: -help
|
2012-05-09 00:50:35 +08:00
|
|
|
|
|
|
|
Print a summary of command line options.
|
|
|
|
|
2012-11-30 03:21:02 +08:00
|
|
|
.. option:: --check-prefix prefix
|
2012-05-09 00:50:35 +08:00
|
|
|
|
2013-11-10 10:04:09 +08:00
|
|
|
FileCheck searches the contents of ``match-filename`` for patterns to
|
|
|
|
match. By default, these patterns are prefixed with "``CHECK:``".
|
|
|
|
If you'd like to use a different prefix (e.g. because the same input
|
|
|
|
file is checking multiple different tool or options), the
|
|
|
|
:option:`--check-prefix` argument allows you to specify one or more
|
|
|
|
prefixes to match. Multiple prefixes are useful for tests which might
|
|
|
|
change for different run options, but most lines remain the same.
|
2012-05-09 00:50:35 +08:00
|
|
|
|
2016-06-15 00:42:05 +08:00
|
|
|
.. option:: --check-prefixes prefix1,prefix2,...
|
|
|
|
|
|
|
|
An alias of :option:`--check-prefix` that allows multiple prefixes to be
|
|
|
|
specified as a comma separated list.
|
|
|
|
|
2012-11-30 03:21:02 +08:00
|
|
|
.. option:: --input-file filename
|
2012-11-07 09:41:30 +08:00
|
|
|
|
|
|
|
File to check (defaults to stdin).
|
|
|
|
|
2016-02-12 00:46:09 +08:00
|
|
|
.. option:: --match-full-lines
|
|
|
|
|
|
|
|
By default, FileCheck allows matches of anywhere on a line. This
|
|
|
|
option will require all positive matches to cover an entire
|
|
|
|
line. Leading and trailing whitespace is ignored, unless
|
|
|
|
:option:`--strict-whitespace` is also specified. (Note: negative
|
|
|
|
matches from ``CHECK-NOT`` are not affected by this option!)
|
|
|
|
|
|
|
|
Passing this option is equivalent to inserting ``{{^ *}}`` or
|
|
|
|
``{{^}}`` before, and ``{{ *$}}`` or ``{{$}}`` after every positive
|
|
|
|
check pattern.
|
|
|
|
|
2012-11-30 03:21:02 +08:00
|
|
|
.. option:: --strict-whitespace
|
2012-05-09 00:50:35 +08:00
|
|
|
|
|
|
|
By default, FileCheck canonicalizes input horizontal whitespace (spaces and
|
|
|
|
tabs) which causes it to ignore these differences (a space will match a tab).
|
2013-02-07 04:40:38 +08:00
|
|
|
The :option:`--strict-whitespace` argument disables this behavior. End-of-line
|
2013-06-21 08:27:54 +08:00
|
|
|
sequences are canonicalized to UNIX-style ``\n`` in all modes.
|
2012-05-09 00:50:35 +08:00
|
|
|
|
2014-07-11 20:39:32 +08:00
|
|
|
.. option:: --implicit-check-not check-pattern
|
|
|
|
|
|
|
|
Adds implicit negative checks for the specified patterns between positive
|
|
|
|
checks. The option allows writing stricter tests without stuffing them with
|
2014-07-22 00:39:00 +08:00
|
|
|
``CHECK-NOT``\ s.
|
2014-07-11 20:39:32 +08:00
|
|
|
|
|
|
|
For example, "``--implicit-check-not warning:``" can be useful when testing
|
|
|
|
diagnostic messages from tools that don't have an option similar to ``clang
|
|
|
|
-verify``. With this option FileCheck will verify that input does not contain
|
|
|
|
warnings not covered by any ``CHECK:`` patterns.
|
|
|
|
|
[FileCheck] Annotate input dump (1/7)
Extend FileCheck to dump its input annotated with FileCheck's
diagnostics: errors, good matches if -v, and additional information if
-vv. The goal is to make it easier to visualize FileCheck's matching
behavior when debugging.
Each patch in this series implements input annotations for a
particular category of FileCheck diagnostics. While the first few
patches alone are somewhat useful, the annotations become much more
useful as later patches implement annotations for -v and -vv
diagnostics, which show the matching behavior leading up to the error.
This first patch implements boilerplate plus input annotations for
error diagnostics reporting that no matches were found for a
directive. These annotations mark the search ranges of the failed
directives. Instead of using the usual `^~~`, which is used by later
patches for good matches, these annotations use `X~~` so that this
category of errors is visually distinct.
For example:
```
$ FileCheck -dump-input=help
The following description was requested by -dump-input=help to
explain the input annotations printed by -dump-input=always and
-dump-input=fail:
- L: labels line number L of the input file
- T:L labels the match result for a pattern of type T from line L of
the check file
- X~~ marks search range when no match is found
- colors error
If you are not seeing color above or in input dumps, try: -color
$ FileCheck -v -dump-input=always check1 < input1 |& sed -n '/^Input file/,$p'
Input file: <stdin>
Check file: check1
-dump-input=help describes the format of the following dump.
Full input was:
<<<<<<
1: ; abc def
2: ; ghI jkl
next:3 X~~~~~~~~ error: no match found
>>>>>>
$ cat check1
CHECK: abc
CHECK-SAME: def
CHECK-NEXT: ghi
CHECK-SAME: jkl
$ cat input1
; abc def
; ghI jkl
```
Some additional details related to the boilerplate:
* Enabling: The annotated input dump is enabled by `-dump-input`,
which can also be set via the `FILECHECK_OPTS` environment variable.
Accepted values are `help`, `always`, `fail`, or `never`. As shown
above, `help` describes the format of the dump. `always` is helpful
when you want to investigate a successful FileCheck run, perhaps for
an unexpected pass. `-dump-input-on-failure` and
`FILECHECK_DUMP_INPUT_ON_FAILURE` remain as a deprecated alias for
`-dump-input=fail`.
* Diagnostics: The usual diagnostics are not suppressed in this mode
and are printed first. For brevity in the example above, I've
omitted them using a sed command. Sometimes they're perfectly
sufficient, and then they make debugging quicker than if you were
forced to hunt through a dump of long input looking for the error.
If you think they'll get in the way sometimes, keep in mind that
it's pretty easy to grep for the start of the input dump, which is
`<<<`.
* Colored Annotations: The annotated input is colored if colors are
enabled (enabling colors can be forced using -color). For example,
errors are red. However, as in the above example, colors are not
vital to reading the annotations.
I don't know how to test color in the output, so any hints here would
be appreciated.
Reviewed By: george.karpenkov, zturner, probinson
Differential Revision: https://reviews.llvm.org/D52999
llvm-svn: 349418
2018-12-18 08:01:39 +08:00
|
|
|
.. option:: --dump-input <mode>
|
|
|
|
|
|
|
|
Dump input to stderr, adding annotations representing currently enabled
|
|
|
|
diagnostics. Do this either 'always', on 'fail', or 'never'. Specify 'help'
|
|
|
|
to explain the dump format and quit.
|
|
|
|
|
2018-07-21 04:21:57 +08:00
|
|
|
.. option:: --dump-input-on-failure
|
|
|
|
|
[FileCheck] Annotate input dump (1/7)
Extend FileCheck to dump its input annotated with FileCheck's
diagnostics: errors, good matches if -v, and additional information if
-vv. The goal is to make it easier to visualize FileCheck's matching
behavior when debugging.
Each patch in this series implements input annotations for a
particular category of FileCheck diagnostics. While the first few
patches alone are somewhat useful, the annotations become much more
useful as later patches implement annotations for -v and -vv
diagnostics, which show the matching behavior leading up to the error.
This first patch implements boilerplate plus input annotations for
error diagnostics reporting that no matches were found for a
directive. These annotations mark the search ranges of the failed
directives. Instead of using the usual `^~~`, which is used by later
patches for good matches, these annotations use `X~~` so that this
category of errors is visually distinct.
For example:
```
$ FileCheck -dump-input=help
The following description was requested by -dump-input=help to
explain the input annotations printed by -dump-input=always and
-dump-input=fail:
- L: labels line number L of the input file
- T:L labels the match result for a pattern of type T from line L of
the check file
- X~~ marks search range when no match is found
- colors error
If you are not seeing color above or in input dumps, try: -color
$ FileCheck -v -dump-input=always check1 < input1 |& sed -n '/^Input file/,$p'
Input file: <stdin>
Check file: check1
-dump-input=help describes the format of the following dump.
Full input was:
<<<<<<
1: ; abc def
2: ; ghI jkl
next:3 X~~~~~~~~ error: no match found
>>>>>>
$ cat check1
CHECK: abc
CHECK-SAME: def
CHECK-NEXT: ghi
CHECK-SAME: jkl
$ cat input1
; abc def
; ghI jkl
```
Some additional details related to the boilerplate:
* Enabling: The annotated input dump is enabled by `-dump-input`,
which can also be set via the `FILECHECK_OPTS` environment variable.
Accepted values are `help`, `always`, `fail`, or `never`. As shown
above, `help` describes the format of the dump. `always` is helpful
when you want to investigate a successful FileCheck run, perhaps for
an unexpected pass. `-dump-input-on-failure` and
`FILECHECK_DUMP_INPUT_ON_FAILURE` remain as a deprecated alias for
`-dump-input=fail`.
* Diagnostics: The usual diagnostics are not suppressed in this mode
and are printed first. For brevity in the example above, I've
omitted them using a sed command. Sometimes they're perfectly
sufficient, and then they make debugging quicker than if you were
forced to hunt through a dump of long input looking for the error.
If you think they'll get in the way sometimes, keep in mind that
it's pretty easy to grep for the start of the input dump, which is
`<<<`.
* Colored Annotations: The annotated input is colored if colors are
enabled (enabling colors can be forced using -color). For example,
errors are red. However, as in the above example, colors are not
vital to reading the annotations.
I don't know how to test color in the output, so any hints here would
be appreciated.
Reviewed By: george.karpenkov, zturner, probinson
Differential Revision: https://reviews.llvm.org/D52999
llvm-svn: 349418
2018-12-18 08:01:39 +08:00
|
|
|
When the check fails, dump all of the original input. This option is
|
|
|
|
deprecated in favor of `--dump-input=fail`.
|
2018-07-21 04:21:57 +08:00
|
|
|
|
2017-03-10 01:59:04 +08:00
|
|
|
.. option:: --enable-var-scope
|
|
|
|
|
|
|
|
Enables scope for regex variables.
|
|
|
|
|
|
|
|
Variables with names that start with ``$`` are considered global and
|
|
|
|
remain set throughout the file.
|
|
|
|
|
|
|
|
All other variables get undefined after each encountered ``CHECK-LABEL``.
|
|
|
|
|
2017-11-07 21:24:44 +08:00
|
|
|
.. option:: -D<VAR=VALUE>
|
|
|
|
|
FileCheck [4/12]: Introduce @LINE numeric expressions
Summary:
This patch is part of a patch series to add support for FileCheck
numeric expressions. This specific patch introduces the @LINE numeric
expressions.
This commit introduces a new syntax to express a relation a numeric
value in the input text must have with the line number of a given CHECK
pattern: [[#<@LINE numeric expression>]]. Further commits build on that
to express relations between several numeric values in the input text.
To help with naming, regular variables are renamed into pattern
variables and old @LINE expression syntax is referred to as legacy
numeric expression.
Compared to existing @LINE expressions, this new syntax allow arbitrary
spacing between the component of the expression. It offers otherwise the
same functionality but the commit serves to introduce some of the data
structure needed to support more general numeric expressions.
Copyright:
- Linaro (changes up to diff 183612 of revision D55940)
- GraphCore (changes in later versions of revision D55940 and
in new revision created off D55940)
Reviewers: jhenderson, chandlerc, jdenny, probinson, grimar, arichardson, rnk
Subscribers: hiraditya, llvm-commits, probinson, dblaikie, grimar, arichardson, tra, rnk, kristina, hfinkel, rogfer01, JonChesterfield
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D60384
llvm-svn: 359741
2019-05-02 08:04:38 +08:00
|
|
|
Sets a filecheck pattern variable ``VAR`` with value ``VALUE`` that can be
|
|
|
|
used in ``CHECK:`` lines.
|
2017-11-07 21:24:44 +08:00
|
|
|
|
Reinstate "FileCheck [5/12]: Introduce regular numeric variables"
This reinstates r360578 (git e47362c1ec1ea31b626336cc05822035601c3e57),
reverted in r360653 (git 004393681c25e34e921adccc69ae6378090dee54),
with a fix for the list added in FileCheck.rst to build without error.
Copyright:
- Linaro (changes up to diff 183612 of revision D55940)
- GraphCore (changes in later versions of revision D55940 and
in new revision created off D55940)
Reviewers: jhenderson, chandlerc, jdenny, probinson, grimar,
arichardson, rnk
Subscribers: hiraditya, llvm-commits, probinson, dblaikie, grimar,
arichardson, tra, rnk, kristina, hfinkel, rogfer01, JonChesterfield
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D60385
llvm-svn: 360665
2019-05-14 19:58:30 +08:00
|
|
|
.. option:: -D#<NUMVAR>=<VALUE>
|
|
|
|
|
|
|
|
Sets a filecheck numeric variable ``NUMVAR`` to ``<VALUE>`` that can be used
|
|
|
|
in ``CHECK:`` lines.
|
|
|
|
|
2012-11-30 03:21:02 +08:00
|
|
|
.. option:: -version
|
2012-05-09 00:50:35 +08:00
|
|
|
|
|
|
|
Show the version number of this program.
|
|
|
|
|
2018-07-13 11:08:23 +08:00
|
|
|
.. option:: -v
|
|
|
|
|
2019-01-23 05:41:42 +08:00
|
|
|
Print good directive pattern matches. However, if ``-input-dump=fail`` or
|
|
|
|
``-input-dump=always``, add those matches as input annotations instead.
|
2018-07-13 11:08:23 +08:00
|
|
|
|
|
|
|
.. option:: -vv
|
|
|
|
|
|
|
|
Print information helpful in diagnosing internal FileCheck issues, such as
|
|
|
|
discarded overlapping ``CHECK-DAG:`` matches, implicit EOF pattern matches,
|
|
|
|
and ``CHECK-NOT:`` patterns that do not have matches. Implies ``-v``.
|
2019-01-23 05:41:42 +08:00
|
|
|
However, if ``-input-dump=fail`` or ``-input-dump=always``, just add that
|
|
|
|
information as input annotations instead.
|
2018-07-13 11:08:23 +08:00
|
|
|
|
2018-07-12 04:27:27 +08:00
|
|
|
.. option:: --allow-deprecated-dag-overlap
|
|
|
|
|
|
|
|
Enable overlapping among matches in a group of consecutive ``CHECK-DAG:``
|
|
|
|
directives. This option is deprecated and is only provided for convenience
|
|
|
|
as old tests are migrated to the new non-overlapping ``CHECK-DAG:``
|
|
|
|
implementation.
|
|
|
|
|
[SourceMgr][FileCheck] Obey -color by extending WithColor
(Relands r344930, reverted in r344935, and now hopefully fixed for
Windows.)
While this change specifically targets FileCheck, it affects any tool
using the same SourceMgr facilities.
Previously, -color was documented in FileCheck's -help output, but
-color had no effect. Now, -color obeys its documentation: it forces
colors to be used in FileCheck diagnostics even when stderr is not a
terminal.
-color is especially helpful when combined with FileCheck's -v, which
can produce a long series of diagnostics that you might wish to pipe
to a pager, such as less -R. The WithColor extensions here will also
help to clean up color usage in FileCheck's annotated dump of input,
which is proposed in D52999.
Reviewed By: JDevlieghere, zturner
Differential Revision: https://reviews.llvm.org/D53419
llvm-svn: 345202
2018-10-25 05:46:42 +08:00
|
|
|
.. option:: --color
|
|
|
|
|
|
|
|
Use colors in output (autodetected by default).
|
|
|
|
|
2012-05-09 00:50:35 +08:00
|
|
|
EXIT STATUS
|
|
|
|
-----------
|
|
|
|
|
2012-11-30 03:21:02 +08:00
|
|
|
If :program:`FileCheck` verifies that the file matches the expected contents,
|
|
|
|
it exits with 0. Otherwise, if not, or if an error occurs, it will exit with a
|
|
|
|
non-zero value.
|
2012-05-09 00:50:35 +08:00
|
|
|
|
|
|
|
TUTORIAL
|
|
|
|
--------
|
|
|
|
|
|
|
|
FileCheck is typically used from LLVM regression tests, being invoked on the RUN
|
|
|
|
line of the test. A simple example of using FileCheck from a RUN line looks
|
|
|
|
like this:
|
|
|
|
|
2012-06-12 23:45:07 +08:00
|
|
|
.. code-block:: llvm
|
2012-05-09 00:50:35 +08:00
|
|
|
|
|
|
|
; RUN: llvm-as < %s | llc -march=x86-64 | FileCheck %s
|
|
|
|
|
2012-11-15 03:42:32 +08:00
|
|
|
This syntax says to pipe the current file ("``%s``") into ``llvm-as``, pipe
|
|
|
|
that into ``llc``, then pipe the output of ``llc`` into ``FileCheck``. This
|
|
|
|
means that FileCheck will be verifying its standard input (the llc output)
|
|
|
|
against the filename argument specified (the original ``.ll`` file specified by
|
|
|
|
"``%s``"). To see how this works, let's look at the rest of the ``.ll`` file
|
|
|
|
(after the RUN line):
|
2012-05-09 00:50:35 +08:00
|
|
|
|
2012-06-12 23:45:07 +08:00
|
|
|
.. code-block:: llvm
|
2012-05-09 00:50:35 +08:00
|
|
|
|
|
|
|
define void @sub1(i32* %p, i32 %v) {
|
|
|
|
entry:
|
|
|
|
; CHECK: sub1:
|
|
|
|
; CHECK: subl
|
|
|
|
%0 = tail call i32 @llvm.atomic.load.sub.i32.p0i32(i32* %p, i32 %v)
|
|
|
|
ret void
|
|
|
|
}
|
|
|
|
|
|
|
|
define void @inc4(i64* %p) {
|
|
|
|
entry:
|
|
|
|
; CHECK: inc4:
|
|
|
|
; CHECK: incq
|
|
|
|
%0 = tail call i64 @llvm.atomic.load.add.i64.p0i64(i64* %p, i64 1)
|
|
|
|
ret void
|
|
|
|
}
|
|
|
|
|
2012-11-15 03:42:32 +08:00
|
|
|
Here you can see some "``CHECK:``" lines specified in comments. Now you can
|
|
|
|
see how the file is piped into ``llvm-as``, then ``llc``, and the machine code
|
|
|
|
output is what we are verifying. FileCheck checks the machine code output to
|
|
|
|
verify that it matches what the "``CHECK:``" lines specify.
|
2012-05-09 00:50:35 +08:00
|
|
|
|
2012-11-15 03:42:32 +08:00
|
|
|
The syntax of the "``CHECK:``" lines is very simple: they are fixed strings that
|
2012-05-09 00:50:35 +08:00
|
|
|
must occur in order. FileCheck defaults to ignoring horizontal whitespace
|
|
|
|
differences (e.g. a space is allowed to match a tab) but otherwise, the contents
|
2012-11-15 03:42:32 +08:00
|
|
|
of the "``CHECK:``" line is required to match some thing in the test file exactly.
|
2012-05-09 00:50:35 +08:00
|
|
|
|
|
|
|
One nice thing about FileCheck (compared to grep) is that it allows merging
|
|
|
|
test cases together into logical groups. For example, because the test above
|
2012-11-15 03:42:32 +08:00
|
|
|
is checking for the "``sub1:``" and "``inc4:``" labels, it will not match
|
|
|
|
unless there is a "``subl``" in between those labels. If it existed somewhere
|
|
|
|
else in the file, that would not count: "``grep subl``" matches if "``subl``"
|
|
|
|
exists anywhere in the file.
|
2012-05-09 00:50:35 +08:00
|
|
|
|
|
|
|
The FileCheck -check-prefix option
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
[docs] Fixing Sphinx warnings to unclog the buildbot
Lots of blocks had "llvm" or "nasm" syntax types but either weren't following
the syntax, or the syntax has changed (and sphinx hasn't keep up) or the type
doesn't even exist (nasm?).
Other documents had :options: what were invalid. I only removed those that had
warnings, and left the ones that didn't, in order to follow the principle of
least surprise.
This is like this for ages, but the buildbot is now failing on errors. It may
take a while to upgrade the buildbot's sphinx, if that's even possible, but
that shouldn't stop us from getting docs updates (which seem down for quite
a while).
Also, we're not losing any syntax highlight, since when it doesn't parse, it
doesn't colour. Ie. those blocks are not being highlighted anyway.
I'm trying to get all docs in one go, so that it's easy to revert later if we
do fix, or at least easy to know what's to fix.
llvm-svn: 276109
2016-07-20 20:16:38 +08:00
|
|
|
The FileCheck `-check-prefix` option allows multiple test
|
2012-11-30 03:21:02 +08:00
|
|
|
configurations to be driven from one `.ll` file. This is useful in many
|
|
|
|
circumstances, for example, testing different architectural variants with
|
|
|
|
:program:`llc`. Here's a simple example:
|
2012-05-09 00:50:35 +08:00
|
|
|
|
2012-06-12 23:45:07 +08:00
|
|
|
.. code-block:: llvm
|
2012-05-09 00:50:35 +08:00
|
|
|
|
|
|
|
; RUN: llvm-as < %s | llc -mtriple=i686-apple-darwin9 -mattr=sse41 \
|
2012-06-12 08:48:47 +08:00
|
|
|
; RUN: | FileCheck %s -check-prefix=X32
|
2012-05-09 00:50:35 +08:00
|
|
|
; RUN: llvm-as < %s | llc -mtriple=x86_64-apple-darwin9 -mattr=sse41 \
|
2012-06-12 08:48:47 +08:00
|
|
|
; RUN: | FileCheck %s -check-prefix=X64
|
2012-05-09 00:50:35 +08:00
|
|
|
|
|
|
|
define <4 x i32> @pinsrd_1(i32 %s, <4 x i32> %tmp) nounwind {
|
|
|
|
%tmp1 = insertelement <4 x i32>; %tmp, i32 %s, i32 1
|
|
|
|
ret <4 x i32> %tmp1
|
|
|
|
; X32: pinsrd_1:
|
|
|
|
; X32: pinsrd $1, 4(%esp), %xmm0
|
|
|
|
|
|
|
|
; X64: pinsrd_1:
|
|
|
|
; X64: pinsrd $1, %edi, %xmm0
|
|
|
|
}
|
|
|
|
|
|
|
|
In this case, we're testing that we get the expected code generation with
|
|
|
|
both 32-bit and 64-bit code generation.
|
|
|
|
|
|
|
|
The "CHECK-NEXT:" directive
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
Sometimes you want to match lines and would like to verify that matches
|
|
|
|
happen on exactly consecutive lines with no other lines in between them. In
|
2012-11-15 03:42:32 +08:00
|
|
|
this case, you can use "``CHECK:``" and "``CHECK-NEXT:``" directives to specify
|
|
|
|
this. If you specified a custom check prefix, just use "``<PREFIX>-NEXT:``".
|
|
|
|
For example, something like this works as you'd expect:
|
2012-05-09 00:50:35 +08:00
|
|
|
|
2012-06-12 23:45:07 +08:00
|
|
|
.. code-block:: llvm
|
2012-05-09 00:50:35 +08:00
|
|
|
|
2012-06-12 08:48:47 +08:00
|
|
|
define void @t2(<2 x double>* %r, <2 x double>* %A, double %B) {
|
|
|
|
%tmp3 = load <2 x double>* %A, align 16
|
|
|
|
%tmp7 = insertelement <2 x double> undef, double %B, i32 0
|
|
|
|
%tmp9 = shufflevector <2 x double> %tmp3,
|
|
|
|
<2 x double> %tmp7,
|
|
|
|
<2 x i32> < i32 0, i32 2 >
|
|
|
|
store <2 x double> %tmp9, <2 x double>* %r, align 16
|
2012-05-09 00:50:35 +08:00
|
|
|
ret void
|
|
|
|
|
|
|
|
; CHECK: t2:
|
|
|
|
; CHECK: movl 8(%esp), %eax
|
|
|
|
; CHECK-NEXT: movapd (%eax), %xmm0
|
|
|
|
; CHECK-NEXT: movhpd 12(%esp), %xmm0
|
|
|
|
; CHECK-NEXT: movl 4(%esp), %eax
|
|
|
|
; CHECK-NEXT: movapd %xmm0, (%eax)
|
|
|
|
; CHECK-NEXT: ret
|
|
|
|
}
|
|
|
|
|
2012-11-15 03:42:32 +08:00
|
|
|
"``CHECK-NEXT:``" directives reject the input unless there is exactly one
|
2012-11-22 06:40:52 +08:00
|
|
|
newline between it and the previous directive. A "``CHECK-NEXT:``" cannot be
|
2012-11-15 03:42:32 +08:00
|
|
|
the first directive in a file.
|
2012-05-09 00:50:35 +08:00
|
|
|
|
2015-03-06 01:00:05 +08:00
|
|
|
The "CHECK-SAME:" directive
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
Sometimes you want to match lines and would like to verify that matches happen
|
|
|
|
on the same line as the previous match. In this case, you can use "``CHECK:``"
|
|
|
|
and "``CHECK-SAME:``" directives to specify this. If you specified a custom
|
|
|
|
check prefix, just use "``<PREFIX>-SAME:``".
|
|
|
|
|
|
|
|
"``CHECK-SAME:``" is particularly powerful in conjunction with "``CHECK-NOT:``"
|
|
|
|
(described below).
|
|
|
|
|
|
|
|
For example, the following works like you'd expect:
|
|
|
|
|
|
|
|
.. code-block:: llvm
|
|
|
|
|
2015-04-30 00:38:44 +08:00
|
|
|
!0 = !DILocation(line: 5, scope: !1, inlinedAt: !2)
|
2015-03-06 01:00:05 +08:00
|
|
|
|
2015-04-30 00:38:44 +08:00
|
|
|
; CHECK: !DILocation(line: 5,
|
2015-03-06 01:00:05 +08:00
|
|
|
; CHECK-NOT: column:
|
|
|
|
; CHECK-SAME: scope: ![[SCOPE:[0-9]+]]
|
|
|
|
|
|
|
|
"``CHECK-SAME:``" directives reject the input if there are any newlines between
|
|
|
|
it and the previous directive. A "``CHECK-SAME:``" cannot be the first
|
2018-06-26 23:15:45 +08:00
|
|
|
directive in a file.
|
|
|
|
|
|
|
|
The "CHECK-EMPTY:" directive
|
2018-06-26 23:29:09 +08:00
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
2018-06-26 23:15:45 +08:00
|
|
|
|
|
|
|
If you need to check that the next line has nothing on it, not even whitespace,
|
|
|
|
you can use the "``CHECK-EMPTY:``" directive.
|
|
|
|
|
|
|
|
.. code-block:: llvm
|
|
|
|
|
2018-08-06 09:41:25 +08:00
|
|
|
declare void @foo()
|
2018-06-26 23:15:45 +08:00
|
|
|
|
2018-08-06 09:41:25 +08:00
|
|
|
declare void @bar()
|
2018-06-26 23:15:45 +08:00
|
|
|
; CHECK: foo
|
|
|
|
; CHECK-EMPTY:
|
|
|
|
; CHECK-NEXT: bar
|
|
|
|
|
|
|
|
Just like "``CHECK-NEXT:``" the directive will fail if there is more than one
|
|
|
|
newline before it finds the next blank line, and it cannot be the first
|
2015-03-06 01:00:05 +08:00
|
|
|
directive in a file.
|
|
|
|
|
2012-05-09 00:50:35 +08:00
|
|
|
The "CHECK-NOT:" directive
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
2012-11-15 03:42:32 +08:00
|
|
|
The "``CHECK-NOT:``" directive is used to verify that a string doesn't occur
|
2012-05-09 00:50:35 +08:00
|
|
|
between two matches (or before the first match, or after the last match). For
|
|
|
|
example, to verify that a load is removed by a transformation, a test like this
|
|
|
|
can be used:
|
|
|
|
|
2012-06-12 23:45:07 +08:00
|
|
|
.. code-block:: llvm
|
2012-05-09 00:50:35 +08:00
|
|
|
|
|
|
|
define i8 @coerce_offset0(i32 %V, i32* %P) {
|
|
|
|
store i32 %V, i32* %P
|
|
|
|
|
|
|
|
%P2 = bitcast i32* %P to i8*
|
|
|
|
%P3 = getelementptr i8* %P2, i32 2
|
|
|
|
|
|
|
|
%A = load i8* %P3
|
|
|
|
ret i8 %A
|
|
|
|
; CHECK: @coerce_offset0
|
|
|
|
; CHECK-NOT: load
|
|
|
|
; CHECK: ret i8
|
|
|
|
}
|
|
|
|
|
2018-11-13 08:46:13 +08:00
|
|
|
The "CHECK-COUNT:" directive
|
2018-11-13 09:12:19 +08:00
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
2018-11-13 08:46:13 +08:00
|
|
|
|
|
|
|
If you need to match multiple lines with the same pattern over and over again
|
|
|
|
you can repeat a plain ``CHECK:`` as many times as needed. If that looks too
|
|
|
|
boring you can instead use a counted check "``CHECK-COUNT-<num>:``", where
|
|
|
|
``<num>`` is a positive decimal number. It will match the pattern exactly
|
|
|
|
``<num>`` times, no more and no less. If you specified a custom check prefix,
|
|
|
|
just use "``<PREFIX>-COUNT-<num>:``" for the same effect.
|
|
|
|
Here is a simple example:
|
|
|
|
|
2018-11-13 13:47:01 +08:00
|
|
|
.. code-block:: text
|
2018-11-13 08:46:13 +08:00
|
|
|
|
|
|
|
Loop at depth 1
|
|
|
|
Loop at depth 1
|
|
|
|
Loop at depth 1
|
|
|
|
Loop at depth 1
|
|
|
|
Loop at depth 2
|
|
|
|
Loop at depth 3
|
|
|
|
|
|
|
|
; CHECK-COUNT-6: Loop at depth {{[0-9]+}}
|
|
|
|
; CHECK-NOT: Loop at depth {{[0-9]+}}
|
|
|
|
|
2013-05-15 04:34:12 +08:00
|
|
|
The "CHECK-DAG:" directive
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
If it's necessary to match strings that don't occur in a strictly sequential
|
|
|
|
order, "``CHECK-DAG:``" could be used to verify them between two matches (or
|
|
|
|
before the first match, or after the last match). For example, clang emits
|
|
|
|
vtable globals in reverse order. Using ``CHECK-DAG:``, we can keep the checks
|
|
|
|
in the natural order:
|
|
|
|
|
|
|
|
.. code-block:: c++
|
|
|
|
|
|
|
|
// RUN: %clang_cc1 %s -emit-llvm -o - | FileCheck %s
|
|
|
|
|
|
|
|
struct Foo { virtual void method(); };
|
|
|
|
Foo f; // emit vtable
|
|
|
|
// CHECK-DAG: @_ZTV3Foo =
|
|
|
|
|
|
|
|
struct Bar { virtual void method(); };
|
|
|
|
Bar b;
|
|
|
|
// CHECK-DAG: @_ZTV3Bar =
|
|
|
|
|
2013-10-12 02:50:22 +08:00
|
|
|
``CHECK-NOT:`` directives could be mixed with ``CHECK-DAG:`` directives to
|
|
|
|
exclude strings between the surrounding ``CHECK-DAG:`` directives. As a result,
|
|
|
|
the surrounding ``CHECK-DAG:`` directives cannot be reordered, i.e. all
|
|
|
|
occurrences matching ``CHECK-DAG:`` before ``CHECK-NOT:`` must not fall behind
|
|
|
|
occurrences matching ``CHECK-DAG:`` after ``CHECK-NOT:``. For example,
|
|
|
|
|
|
|
|
.. code-block:: llvm
|
|
|
|
|
|
|
|
; CHECK-DAG: BEFORE
|
|
|
|
; CHECK-NOT: NOT
|
|
|
|
; CHECK-DAG: AFTER
|
|
|
|
|
|
|
|
This case will reject input strings where ``BEFORE`` occurs after ``AFTER``.
|
2013-05-15 04:34:12 +08:00
|
|
|
|
|
|
|
With captured variables, ``CHECK-DAG:`` is able to match valid topological
|
|
|
|
orderings of a DAG with edges from the definition of a variable to its use.
|
|
|
|
It's useful, e.g., when your test cases need to match different output
|
|
|
|
sequences from the instruction scheduler. For example,
|
|
|
|
|
|
|
|
.. code-block:: llvm
|
|
|
|
|
|
|
|
; CHECK-DAG: add [[REG1:r[0-9]+]], r1, r2
|
|
|
|
; CHECK-DAG: add [[REG2:r[0-9]+]], r3, r4
|
|
|
|
; CHECK: mul r5, [[REG1]], [[REG2]]
|
|
|
|
|
|
|
|
In this case, any order of that two ``add`` instructions will be allowed.
|
|
|
|
|
2013-10-12 02:50:22 +08:00
|
|
|
If you are defining `and` using variables in the same ``CHECK-DAG:`` block,
|
|
|
|
be aware that the definition rule can match `after` its use.
|
|
|
|
|
|
|
|
So, for instance, the code below will pass:
|
2013-05-15 04:34:12 +08:00
|
|
|
|
[docs] Fixing Sphinx warnings to unclog the buildbot
Lots of blocks had "llvm" or "nasm" syntax types but either weren't following
the syntax, or the syntax has changed (and sphinx hasn't keep up) or the type
doesn't even exist (nasm?).
Other documents had :options: what were invalid. I only removed those that had
warnings, and left the ones that didn't, in order to follow the principle of
least surprise.
This is like this for ages, but the buildbot is now failing on errors. It may
take a while to upgrade the buildbot's sphinx, if that's even possible, but
that shouldn't stop us from getting docs updates (which seem down for quite
a while).
Also, we're not losing any syntax highlight, since when it doesn't parse, it
doesn't colour. Ie. those blocks are not being highlighted anyway.
I'm trying to get all docs in one go, so that it's easy to revert later if we
do fix, or at least easy to know what's to fix.
llvm-svn: 276109
2016-07-20 20:16:38 +08:00
|
|
|
.. code-block:: text
|
2013-05-15 04:34:12 +08:00
|
|
|
|
2013-10-12 02:50:22 +08:00
|
|
|
; CHECK-DAG: vmov.32 [[REG2:d[0-9]+]][0]
|
|
|
|
; CHECK-DAG: vmov.32 [[REG2]][1]
|
|
|
|
vmov.32 d0[1]
|
|
|
|
vmov.32 d0[0]
|
2013-05-15 04:34:12 +08:00
|
|
|
|
2013-10-12 02:50:22 +08:00
|
|
|
While this other code, will not:
|
|
|
|
|
[docs] Fixing Sphinx warnings to unclog the buildbot
Lots of blocks had "llvm" or "nasm" syntax types but either weren't following
the syntax, or the syntax has changed (and sphinx hasn't keep up) or the type
doesn't even exist (nasm?).
Other documents had :options: what were invalid. I only removed those that had
warnings, and left the ones that didn't, in order to follow the principle of
least surprise.
This is like this for ages, but the buildbot is now failing on errors. It may
take a while to upgrade the buildbot's sphinx, if that's even possible, but
that shouldn't stop us from getting docs updates (which seem down for quite
a while).
Also, we're not losing any syntax highlight, since when it doesn't parse, it
doesn't colour. Ie. those blocks are not being highlighted anyway.
I'm trying to get all docs in one go, so that it's easy to revert later if we
do fix, or at least easy to know what's to fix.
llvm-svn: 276109
2016-07-20 20:16:38 +08:00
|
|
|
.. code-block:: text
|
2013-10-12 02:50:22 +08:00
|
|
|
|
|
|
|
; CHECK-DAG: vmov.32 [[REG2:d[0-9]+]][0]
|
|
|
|
; CHECK-DAG: vmov.32 [[REG2]][1]
|
|
|
|
vmov.32 d1[1]
|
|
|
|
vmov.32 d0[0]
|
|
|
|
|
|
|
|
While this can be very useful, it's also dangerous, because in the case of
|
|
|
|
register sequence, you must have a strong order (read before write, copy before
|
|
|
|
use, etc). If the definition your test is looking for doesn't match (because
|
|
|
|
of a bug in the compiler), it may match further away from the use, and mask
|
|
|
|
real bugs away.
|
|
|
|
|
|
|
|
In those cases, to enforce the order, use a non-DAG directive between DAG-blocks.
|
2013-05-15 04:34:12 +08:00
|
|
|
|
2018-07-12 04:27:27 +08:00
|
|
|
A ``CHECK-DAG:`` directive skips matches that overlap the matches of any
|
|
|
|
preceding ``CHECK-DAG:`` directives in the same ``CHECK-DAG:`` block. Not only
|
|
|
|
is this non-overlapping behavior consistent with other directives, but it's
|
|
|
|
also necessary to handle sets of non-unique strings or patterns. For example,
|
|
|
|
the following directives look for unordered log entries for two tasks in a
|
|
|
|
parallel program, such as the OpenMP runtime:
|
|
|
|
|
|
|
|
.. code-block:: text
|
|
|
|
|
|
|
|
// CHECK-DAG: [[THREAD_ID:[0-9]+]]: task_begin
|
|
|
|
// CHECK-DAG: [[THREAD_ID]]: task_end
|
|
|
|
//
|
|
|
|
// CHECK-DAG: [[THREAD_ID:[0-9]+]]: task_begin
|
|
|
|
// CHECK-DAG: [[THREAD_ID]]: task_end
|
|
|
|
|
|
|
|
The second pair of directives is guaranteed not to match the same log entries
|
|
|
|
as the first pair even though the patterns are identical and even if the text
|
|
|
|
of the log entries is identical because the thread ID manages to be reused.
|
|
|
|
|
2013-07-12 22:51:05 +08:00
|
|
|
The "CHECK-LABEL:" directive
|
2013-07-30 16:26:24 +08:00
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
2013-07-12 22:51:05 +08:00
|
|
|
|
|
|
|
Sometimes in a file containing multiple tests divided into logical blocks, one
|
|
|
|
or more ``CHECK:`` directives may inadvertently succeed by matching lines in a
|
|
|
|
later block. While an error will usually eventually be generated, the check
|
|
|
|
flagged as causing the error may not actually bear any relationship to the
|
|
|
|
actual source of the problem.
|
|
|
|
|
|
|
|
In order to produce better error messages in these cases, the "``CHECK-LABEL:``"
|
|
|
|
directive can be used. It is treated identically to a normal ``CHECK``
|
2013-07-19 07:26:58 +08:00
|
|
|
directive except that FileCheck makes an additional assumption that a line
|
|
|
|
matched by the directive cannot also be matched by any other check present in
|
|
|
|
``match-filename``; this is intended to be used for lines containing labels or
|
|
|
|
other unique identifiers. Conceptually, the presence of ``CHECK-LABEL`` divides
|
|
|
|
the input stream into separate blocks, each of which is processed independently,
|
|
|
|
preventing a ``CHECK:`` directive in one block matching a line in another block.
|
2017-03-10 01:59:04 +08:00
|
|
|
If ``--enable-var-scope`` is in effect, all local variables are cleared at the
|
|
|
|
beginning of the block.
|
|
|
|
|
2013-07-19 07:26:58 +08:00
|
|
|
For example,
|
2013-07-12 22:51:05 +08:00
|
|
|
|
|
|
|
.. code-block:: llvm
|
|
|
|
|
|
|
|
define %struct.C* @C_ctor_base(%struct.C* %this, i32 %x) {
|
|
|
|
entry:
|
|
|
|
; CHECK-LABEL: C_ctor_base:
|
|
|
|
; CHECK: mov [[SAVETHIS:r[0-9]+]], r0
|
|
|
|
; CHECK: bl A_ctor_base
|
|
|
|
; CHECK: mov r0, [[SAVETHIS]]
|
|
|
|
%0 = bitcast %struct.C* %this to %struct.A*
|
|
|
|
%call = tail call %struct.A* @A_ctor_base(%struct.A* %0)
|
|
|
|
%1 = bitcast %struct.C* %this to %struct.B*
|
|
|
|
%call2 = tail call %struct.B* @B_ctor_base(%struct.B* %1, i32 %x)
|
|
|
|
ret %struct.C* %this
|
|
|
|
}
|
|
|
|
|
|
|
|
define %struct.D* @D_ctor_base(%struct.D* %this, i32 %x) {
|
|
|
|
entry:
|
|
|
|
; CHECK-LABEL: D_ctor_base:
|
|
|
|
|
|
|
|
The use of ``CHECK-LABEL:`` directives in this case ensures that the three
|
|
|
|
``CHECK:`` directives only accept lines corresponding to the body of the
|
|
|
|
``@C_ctor_base`` function, even if the patterns match lines found later in
|
2013-07-19 07:26:58 +08:00
|
|
|
the file. Furthermore, if one of these three ``CHECK:`` directives fail,
|
|
|
|
FileCheck will recover by continuing to the next block, allowing multiple test
|
|
|
|
failures to be detected in a single invocation.
|
2013-07-12 22:51:05 +08:00
|
|
|
|
|
|
|
There is no requirement that ``CHECK-LABEL:`` directives contain strings that
|
|
|
|
correspond to actual syntactic labels in a source or output language: they must
|
|
|
|
simply uniquely match a single line in the file being verified.
|
|
|
|
|
|
|
|
``CHECK-LABEL:`` directives cannot contain variable definitions or uses.
|
|
|
|
|
FileCheck: Improve FileCheck variable terminology
Summary:
Terminology introduced by [[#]] blocks is confusing and does not
integrate well with existing terminology.
First, variables referred by [[]] blocks are called "pattern variables"
while the text a CHECK directive needs to match is called a "CHECK
pattern". This is inconsistent with variables in [[#]] blocks since
[[#]] blocks are also found in CHECK pattern yet those variables are
called "numeric variable".
Second, the replacing of both [[]] and [[#]] blocks by the value of the
variable or expression they contain is represented by a
FileCheckPatternSubstitution class. The naming refers to being a
substitution in a CHECK pattern but could be wrongly understood as being
a substitution of a pattern variable.
Third and lastly, comments use "numeric expression" to refer both to the
[[#]] blocks as well as to the numeric expressions these blocks contain
which get evaluated at match time.
This patch solves these confusions by
- calling variables in [[]] and [[#]] blocks as string and numeric
variables respectively;
- referring to [[]] and [[#]] as substitution *blocks*, with the former
being a string substitution block and the latter a numeric
substitution block;
- calling [[]] and [[#]] blocks to be replaced by the value of a
variable or expression they contain a substitution (as opposed to
definition when these blocks are used to defined a variable), with the
former being a string substitution and the latter a numeric
substitution;
- renaming the FileCheckPatternSubstitution as a FileCheckSubstitution
class with FileCheckStringSubstitution and
FileCheckNumericSubstitution subclasses;
- restricting the use of "numeric expression" to refer to the expression
that is evaluated in a numeric substitution.
While numeric substitution blocks only support numeric substitutions of
numeric expressions at the moment there are plans to augment numeric
substitution blocks to support numeric definitions as well as both a
numeric definition and numeric substitution in the same numeric
substitution block.
Reviewers: jhenderson, jdenny, probinson, arichardson
Subscribers: hiraditya, arichardson, probinson, llvm-commits
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D62146
llvm-svn: 361445
2019-05-23 08:10:14 +08:00
|
|
|
FileCheck Regex Matching Syntax
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
2012-05-09 00:50:35 +08:00
|
|
|
|
2015-03-06 07:04:26 +08:00
|
|
|
All FileCheck directives take a pattern to match.
|
2012-11-15 03:42:32 +08:00
|
|
|
For most uses of FileCheck, fixed string matching is perfectly sufficient. For
|
|
|
|
some things, a more flexible form of matching is desired. To support this,
|
|
|
|
FileCheck allows you to specify regular expressions in matching strings,
|
2017-10-13 22:02:36 +08:00
|
|
|
surrounded by double braces: ``{{yourregex}}``. FileCheck implements a POSIX
|
|
|
|
regular expression matcher; it supports Extended POSIX regular expressions
|
|
|
|
(ERE). Because we want to use fixed string matching for a majority of what we
|
|
|
|
do, FileCheck has been designed to support mixing and matching fixed string
|
|
|
|
matching with regular expressions. This allows you to write things like this:
|
2012-05-09 00:50:35 +08:00
|
|
|
|
2012-06-12 23:45:07 +08:00
|
|
|
.. code-block:: llvm
|
2012-05-09 00:50:35 +08:00
|
|
|
|
|
|
|
; CHECK: movhpd {{[0-9]+}}(%esp), {{%xmm[0-7]}}
|
|
|
|
|
|
|
|
In this case, any offset from the ESP register will be allowed, and any xmm
|
|
|
|
register will be allowed.
|
|
|
|
|
|
|
|
Because regular expressions are enclosed with double braces, they are
|
|
|
|
visually distinct, and you don't need to use escape characters within the double
|
|
|
|
braces like you would in C. In the rare case that you want to match double
|
|
|
|
braces explicitly from the input, you can use something ugly like
|
2012-11-15 03:42:32 +08:00
|
|
|
``{{[{][{]}}`` as your pattern.
|
2012-05-09 00:50:35 +08:00
|
|
|
|
FileCheck: Improve FileCheck variable terminology
Summary:
Terminology introduced by [[#]] blocks is confusing and does not
integrate well with existing terminology.
First, variables referred by [[]] blocks are called "pattern variables"
while the text a CHECK directive needs to match is called a "CHECK
pattern". This is inconsistent with variables in [[#]] blocks since
[[#]] blocks are also found in CHECK pattern yet those variables are
called "numeric variable".
Second, the replacing of both [[]] and [[#]] blocks by the value of the
variable or expression they contain is represented by a
FileCheckPatternSubstitution class. The naming refers to being a
substitution in a CHECK pattern but could be wrongly understood as being
a substitution of a pattern variable.
Third and lastly, comments use "numeric expression" to refer both to the
[[#]] blocks as well as to the numeric expressions these blocks contain
which get evaluated at match time.
This patch solves these confusions by
- calling variables in [[]] and [[#]] blocks as string and numeric
variables respectively;
- referring to [[]] and [[#]] as substitution *blocks*, with the former
being a string substitution block and the latter a numeric
substitution block;
- calling [[]] and [[#]] blocks to be replaced by the value of a
variable or expression they contain a substitution (as opposed to
definition when these blocks are used to defined a variable), with the
former being a string substitution and the latter a numeric
substitution;
- renaming the FileCheckPatternSubstitution as a FileCheckSubstitution
class with FileCheckStringSubstitution and
FileCheckNumericSubstitution subclasses;
- restricting the use of "numeric expression" to refer to the expression
that is evaluated in a numeric substitution.
While numeric substitution blocks only support numeric substitutions of
numeric expressions at the moment there are plans to augment numeric
substitution blocks to support numeric definitions as well as both a
numeric definition and numeric substitution in the same numeric
substitution block.
Reviewers: jhenderson, jdenny, probinson, arichardson
Subscribers: hiraditya, arichardson, probinson, llvm-commits
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D62146
llvm-svn: 361445
2019-05-23 08:10:14 +08:00
|
|
|
FileCheck String Substitution Blocks
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
2012-05-09 00:50:35 +08:00
|
|
|
|
|
|
|
It is often useful to match a pattern and then verify that it occurs again
|
FileCheck: Improve FileCheck variable terminology
Summary:
Terminology introduced by [[#]] blocks is confusing and does not
integrate well with existing terminology.
First, variables referred by [[]] blocks are called "pattern variables"
while the text a CHECK directive needs to match is called a "CHECK
pattern". This is inconsistent with variables in [[#]] blocks since
[[#]] blocks are also found in CHECK pattern yet those variables are
called "numeric variable".
Second, the replacing of both [[]] and [[#]] blocks by the value of the
variable or expression they contain is represented by a
FileCheckPatternSubstitution class. The naming refers to being a
substitution in a CHECK pattern but could be wrongly understood as being
a substitution of a pattern variable.
Third and lastly, comments use "numeric expression" to refer both to the
[[#]] blocks as well as to the numeric expressions these blocks contain
which get evaluated at match time.
This patch solves these confusions by
- calling variables in [[]] and [[#]] blocks as string and numeric
variables respectively;
- referring to [[]] and [[#]] as substitution *blocks*, with the former
being a string substitution block and the latter a numeric
substitution block;
- calling [[]] and [[#]] blocks to be replaced by the value of a
variable or expression they contain a substitution (as opposed to
definition when these blocks are used to defined a variable), with the
former being a string substitution and the latter a numeric
substitution;
- renaming the FileCheckPatternSubstitution as a FileCheckSubstitution
class with FileCheckStringSubstitution and
FileCheckNumericSubstitution subclasses;
- restricting the use of "numeric expression" to refer to the expression
that is evaluated in a numeric substitution.
While numeric substitution blocks only support numeric substitutions of
numeric expressions at the moment there are plans to augment numeric
substitution blocks to support numeric definitions as well as both a
numeric definition and numeric substitution in the same numeric
substitution block.
Reviewers: jhenderson, jdenny, probinson, arichardson
Subscribers: hiraditya, arichardson, probinson, llvm-commits
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D62146
llvm-svn: 361445
2019-05-23 08:10:14 +08:00
|
|
|
later in the file. For codegen tests, this can be useful to allow any
|
|
|
|
register, but verify that that register is used consistently later. To do
|
|
|
|
this, :program:`FileCheck` supports string substitution blocks that allow
|
|
|
|
string variables to be defined and substituted into patterns. Here is a simple
|
|
|
|
example:
|
2012-05-09 00:50:35 +08:00
|
|
|
|
2012-06-12 23:45:07 +08:00
|
|
|
.. code-block:: llvm
|
2012-05-09 00:50:35 +08:00
|
|
|
|
|
|
|
; CHECK: test5:
|
|
|
|
; CHECK: notw [[REGISTER:%[a-z]+]]
|
2012-05-25 05:17:47 +08:00
|
|
|
; CHECK: andw {{.*}}[[REGISTER]]
|
2012-05-09 00:50:35 +08:00
|
|
|
|
2012-11-15 03:42:32 +08:00
|
|
|
The first check line matches a regex ``%[a-z]+`` and captures it into the
|
FileCheck: Improve FileCheck variable terminology
Summary:
Terminology introduced by [[#]] blocks is confusing and does not
integrate well with existing terminology.
First, variables referred by [[]] blocks are called "pattern variables"
while the text a CHECK directive needs to match is called a "CHECK
pattern". This is inconsistent with variables in [[#]] blocks since
[[#]] blocks are also found in CHECK pattern yet those variables are
called "numeric variable".
Second, the replacing of both [[]] and [[#]] blocks by the value of the
variable or expression they contain is represented by a
FileCheckPatternSubstitution class. The naming refers to being a
substitution in a CHECK pattern but could be wrongly understood as being
a substitution of a pattern variable.
Third and lastly, comments use "numeric expression" to refer both to the
[[#]] blocks as well as to the numeric expressions these blocks contain
which get evaluated at match time.
This patch solves these confusions by
- calling variables in [[]] and [[#]] blocks as string and numeric
variables respectively;
- referring to [[]] and [[#]] as substitution *blocks*, with the former
being a string substitution block and the latter a numeric
substitution block;
- calling [[]] and [[#]] blocks to be replaced by the value of a
variable or expression they contain a substitution (as opposed to
definition when these blocks are used to defined a variable), with the
former being a string substitution and the latter a numeric
substitution;
- renaming the FileCheckPatternSubstitution as a FileCheckSubstitution
class with FileCheckStringSubstitution and
FileCheckNumericSubstitution subclasses;
- restricting the use of "numeric expression" to refer to the expression
that is evaluated in a numeric substitution.
While numeric substitution blocks only support numeric substitutions of
numeric expressions at the moment there are plans to augment numeric
substitution blocks to support numeric definitions as well as both a
numeric definition and numeric substitution in the same numeric
substitution block.
Reviewers: jhenderson, jdenny, probinson, arichardson
Subscribers: hiraditya, arichardson, probinson, llvm-commits
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D62146
llvm-svn: 361445
2019-05-23 08:10:14 +08:00
|
|
|
string variable ``REGISTER``. The second line verifies that whatever is in
|
|
|
|
``REGISTER`` occurs later in the file after an "``andw``". :program:`FileCheck`
|
|
|
|
string substitution blocks are always contained in ``[[ ]]`` pairs, and string
|
|
|
|
variable names can be formed with the regex ``[a-zA-Z_][a-zA-Z0-9_]*``. If a
|
|
|
|
colon follows the name, then it is a definition of the variable; otherwise, it
|
|
|
|
is a substitution.
|
2012-05-09 00:50:35 +08:00
|
|
|
|
FileCheck: Improve FileCheck variable terminology
Summary:
Terminology introduced by [[#]] blocks is confusing and does not
integrate well with existing terminology.
First, variables referred by [[]] blocks are called "pattern variables"
while the text a CHECK directive needs to match is called a "CHECK
pattern". This is inconsistent with variables in [[#]] blocks since
[[#]] blocks are also found in CHECK pattern yet those variables are
called "numeric variable".
Second, the replacing of both [[]] and [[#]] blocks by the value of the
variable or expression they contain is represented by a
FileCheckPatternSubstitution class. The naming refers to being a
substitution in a CHECK pattern but could be wrongly understood as being
a substitution of a pattern variable.
Third and lastly, comments use "numeric expression" to refer both to the
[[#]] blocks as well as to the numeric expressions these blocks contain
which get evaluated at match time.
This patch solves these confusions by
- calling variables in [[]] and [[#]] blocks as string and numeric
variables respectively;
- referring to [[]] and [[#]] as substitution *blocks*, with the former
being a string substitution block and the latter a numeric
substitution block;
- calling [[]] and [[#]] blocks to be replaced by the value of a
variable or expression they contain a substitution (as opposed to
definition when these blocks are used to defined a variable), with the
former being a string substitution and the latter a numeric
substitution;
- renaming the FileCheckPatternSubstitution as a FileCheckSubstitution
class with FileCheckStringSubstitution and
FileCheckNumericSubstitution subclasses;
- restricting the use of "numeric expression" to refer to the expression
that is evaluated in a numeric substitution.
While numeric substitution blocks only support numeric substitutions of
numeric expressions at the moment there are plans to augment numeric
substitution blocks to support numeric definitions as well as both a
numeric definition and numeric substitution in the same numeric
substitution block.
Reviewers: jhenderson, jdenny, probinson, arichardson
Subscribers: hiraditya, arichardson, probinson, llvm-commits
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D62146
llvm-svn: 361445
2019-05-23 08:10:14 +08:00
|
|
|
:program:`FileCheck` variables can be defined multiple times, and substitutions
|
|
|
|
always get the latest value. Variables can also be substituted later on the
|
|
|
|
same line they were defined on. For example:
|
2012-12-02 06:03:57 +08:00
|
|
|
|
|
|
|
.. code-block:: llvm
|
|
|
|
|
|
|
|
; CHECK: op [[REG:r[0-9]+]], [[REG]]
|
|
|
|
|
|
|
|
Can be useful if you want the operands of ``op`` to be the same register,
|
|
|
|
and don't care exactly which register it is.
|
2012-11-15 03:42:32 +08:00
|
|
|
|
2017-03-10 01:59:04 +08:00
|
|
|
If ``--enable-var-scope`` is in effect, variables with names that
|
|
|
|
start with ``$`` are considered to be global. All others variables are
|
|
|
|
local. All local variables get undefined at the beginning of each
|
|
|
|
CHECK-LABEL block. Global variables are not affected by CHECK-LABEL.
|
|
|
|
This makes it easier to ensure that individual tests are not affected
|
|
|
|
by variables set in preceding tests.
|
|
|
|
|
FileCheck: Improve FileCheck variable terminology
Summary:
Terminology introduced by [[#]] blocks is confusing and does not
integrate well with existing terminology.
First, variables referred by [[]] blocks are called "pattern variables"
while the text a CHECK directive needs to match is called a "CHECK
pattern". This is inconsistent with variables in [[#]] blocks since
[[#]] blocks are also found in CHECK pattern yet those variables are
called "numeric variable".
Second, the replacing of both [[]] and [[#]] blocks by the value of the
variable or expression they contain is represented by a
FileCheckPatternSubstitution class. The naming refers to being a
substitution in a CHECK pattern but could be wrongly understood as being
a substitution of a pattern variable.
Third and lastly, comments use "numeric expression" to refer both to the
[[#]] blocks as well as to the numeric expressions these blocks contain
which get evaluated at match time.
This patch solves these confusions by
- calling variables in [[]] and [[#]] blocks as string and numeric
variables respectively;
- referring to [[]] and [[#]] as substitution *blocks*, with the former
being a string substitution block and the latter a numeric
substitution block;
- calling [[]] and [[#]] blocks to be replaced by the value of a
variable or expression they contain a substitution (as opposed to
definition when these blocks are used to defined a variable), with the
former being a string substitution and the latter a numeric
substitution;
- renaming the FileCheckPatternSubstitution as a FileCheckSubstitution
class with FileCheckStringSubstitution and
FileCheckNumericSubstitution subclasses;
- restricting the use of "numeric expression" to refer to the expression
that is evaluated in a numeric substitution.
While numeric substitution blocks only support numeric substitutions of
numeric expressions at the moment there are plans to augment numeric
substitution blocks to support numeric definitions as well as both a
numeric definition and numeric substitution in the same numeric
substitution block.
Reviewers: jhenderson, jdenny, probinson, arichardson
Subscribers: hiraditya, arichardson, probinson, llvm-commits
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D62146
llvm-svn: 361445
2019-05-23 08:10:14 +08:00
|
|
|
FileCheck Numeric Substitution Blocks
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
Reinstate "FileCheck [5/12]: Introduce regular numeric variables"
This reinstates r360578 (git e47362c1ec1ea31b626336cc05822035601c3e57),
reverted in r360653 (git 004393681c25e34e921adccc69ae6378090dee54),
with a fix for the list added in FileCheck.rst to build without error.
Copyright:
- Linaro (changes up to diff 183612 of revision D55940)
- GraphCore (changes in later versions of revision D55940 and
in new revision created off D55940)
Reviewers: jhenderson, chandlerc, jdenny, probinson, grimar,
arichardson, rnk
Subscribers: hiraditya, llvm-commits, probinson, dblaikie, grimar,
arichardson, tra, rnk, kristina, hfinkel, rogfer01, JonChesterfield
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D60385
llvm-svn: 360665
2019-05-14 19:58:30 +08:00
|
|
|
|
FileCheck: Improve FileCheck variable terminology
Summary:
Terminology introduced by [[#]] blocks is confusing and does not
integrate well with existing terminology.
First, variables referred by [[]] blocks are called "pattern variables"
while the text a CHECK directive needs to match is called a "CHECK
pattern". This is inconsistent with variables in [[#]] blocks since
[[#]] blocks are also found in CHECK pattern yet those variables are
called "numeric variable".
Second, the replacing of both [[]] and [[#]] blocks by the value of the
variable or expression they contain is represented by a
FileCheckPatternSubstitution class. The naming refers to being a
substitution in a CHECK pattern but could be wrongly understood as being
a substitution of a pattern variable.
Third and lastly, comments use "numeric expression" to refer both to the
[[#]] blocks as well as to the numeric expressions these blocks contain
which get evaluated at match time.
This patch solves these confusions by
- calling variables in [[]] and [[#]] blocks as string and numeric
variables respectively;
- referring to [[]] and [[#]] as substitution *blocks*, with the former
being a string substitution block and the latter a numeric
substitution block;
- calling [[]] and [[#]] blocks to be replaced by the value of a
variable or expression they contain a substitution (as opposed to
definition when these blocks are used to defined a variable), with the
former being a string substitution and the latter a numeric
substitution;
- renaming the FileCheckPatternSubstitution as a FileCheckSubstitution
class with FileCheckStringSubstitution and
FileCheckNumericSubstitution subclasses;
- restricting the use of "numeric expression" to refer to the expression
that is evaluated in a numeric substitution.
While numeric substitution blocks only support numeric substitutions of
numeric expressions at the moment there are plans to augment numeric
substitution blocks to support numeric definitions as well as both a
numeric definition and numeric substitution in the same numeric
substitution block.
Reviewers: jhenderson, jdenny, probinson, arichardson
Subscribers: hiraditya, arichardson, probinson, llvm-commits
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D62146
llvm-svn: 361445
2019-05-23 08:10:14 +08:00
|
|
|
:program:`FileCheck` also supports numeric substitution blocks that allow
|
FileCheck [6/12]: Introduce numeric variable definition
Summary:
This patch is part of a patch series to add support for FileCheck
numeric expressions. This specific patch introduces support for defining
numeric variable in a CHECK directive.
This commit introduces support for defining numeric variable from a
litteral value in the input text. Numeric expressions can then use the
variable provided it is on a later line.
Copyright:
- Linaro (changes up to diff 183612 of revision D55940)
- GraphCore (changes in later versions of revision D55940 and
in new revision created off D55940)
Reviewers: jhenderson, chandlerc, jdenny, probinson, grimar, arichardson, rnk
Subscribers: hiraditya, llvm-commits, probinson, dblaikie, grimar, arichardson, tra, rnk, kristina, hfinkel, rogfer01, JonChesterfield
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D60386
llvm-svn: 362705
2019-06-06 21:21:06 +08:00
|
|
|
defining numeric variables and checking for numeric values that satisfy a
|
|
|
|
numeric expression constraint based on those variables via a numeric
|
|
|
|
substitution. This allows ``CHECK:`` directives to verify a numeric relation
|
|
|
|
between two numbers, such as the need for consecutive registers to be used.
|
Reinstate "FileCheck [5/12]: Introduce regular numeric variables"
This reinstates r360578 (git e47362c1ec1ea31b626336cc05822035601c3e57),
reverted in r360653 (git 004393681c25e34e921adccc69ae6378090dee54),
with a fix for the list added in FileCheck.rst to build without error.
Copyright:
- Linaro (changes up to diff 183612 of revision D55940)
- GraphCore (changes in later versions of revision D55940 and
in new revision created off D55940)
Reviewers: jhenderson, chandlerc, jdenny, probinson, grimar,
arichardson, rnk
Subscribers: hiraditya, llvm-commits, probinson, dblaikie, grimar,
arichardson, tra, rnk, kristina, hfinkel, rogfer01, JonChesterfield
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D60385
llvm-svn: 360665
2019-05-14 19:58:30 +08:00
|
|
|
|
FileCheck [6/12]: Introduce numeric variable definition
Summary:
This patch is part of a patch series to add support for FileCheck
numeric expressions. This specific patch introduces support for defining
numeric variable in a CHECK directive.
This commit introduces support for defining numeric variable from a
litteral value in the input text. Numeric expressions can then use the
variable provided it is on a later line.
Copyright:
- Linaro (changes up to diff 183612 of revision D55940)
- GraphCore (changes in later versions of revision D55940 and
in new revision created off D55940)
Reviewers: jhenderson, chandlerc, jdenny, probinson, grimar, arichardson, rnk
Subscribers: hiraditya, llvm-commits, probinson, dblaikie, grimar, arichardson, tra, rnk, kristina, hfinkel, rogfer01, JonChesterfield
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D60386
llvm-svn: 362705
2019-06-06 21:21:06 +08:00
|
|
|
The syntax to define a numeric variable is ``[[#<NUMVAR>:]]`` where
|
|
|
|
``<NUMVAR>`` is the name of the numeric variable to define to the matching
|
|
|
|
value.
|
Reinstate "FileCheck [5/12]: Introduce regular numeric variables"
This reinstates r360578 (git e47362c1ec1ea31b626336cc05822035601c3e57),
reverted in r360653 (git 004393681c25e34e921adccc69ae6378090dee54),
with a fix for the list added in FileCheck.rst to build without error.
Copyright:
- Linaro (changes up to diff 183612 of revision D55940)
- GraphCore (changes in later versions of revision D55940 and
in new revision created off D55940)
Reviewers: jhenderson, chandlerc, jdenny, probinson, grimar,
arichardson, rnk
Subscribers: hiraditya, llvm-commits, probinson, dblaikie, grimar,
arichardson, tra, rnk, kristina, hfinkel, rogfer01, JonChesterfield
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D60385
llvm-svn: 360665
2019-05-14 19:58:30 +08:00
|
|
|
|
FileCheck [6/12]: Introduce numeric variable definition
Summary:
This patch is part of a patch series to add support for FileCheck
numeric expressions. This specific patch introduces support for defining
numeric variable in a CHECK directive.
This commit introduces support for defining numeric variable from a
litteral value in the input text. Numeric expressions can then use the
variable provided it is on a later line.
Copyright:
- Linaro (changes up to diff 183612 of revision D55940)
- GraphCore (changes in later versions of revision D55940 and
in new revision created off D55940)
Reviewers: jhenderson, chandlerc, jdenny, probinson, grimar, arichardson, rnk
Subscribers: hiraditya, llvm-commits, probinson, dblaikie, grimar, arichardson, tra, rnk, kristina, hfinkel, rogfer01, JonChesterfield
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D60386
llvm-svn: 362705
2019-06-06 21:21:06 +08:00
|
|
|
For example:
|
|
|
|
|
|
|
|
.. code-block:: llvm
|
|
|
|
|
|
|
|
; CHECK: mov r[[#REG:]], 42
|
|
|
|
|
|
|
|
would match ``mov r5, 42`` and set ``REG`` to the value ``5``.
|
|
|
|
|
|
|
|
The syntax of a numeric substitution is ``[[#<NUMVAR><op><offset>]]`` where:
|
|
|
|
|
|
|
|
* ``<NUMVAR>`` is the name of a defined numeric variable.
|
Reinstate "FileCheck [5/12]: Introduce regular numeric variables"
This reinstates r360578 (git e47362c1ec1ea31b626336cc05822035601c3e57),
reverted in r360653 (git 004393681c25e34e921adccc69ae6378090dee54),
with a fix for the list added in FileCheck.rst to build without error.
Copyright:
- Linaro (changes up to diff 183612 of revision D55940)
- GraphCore (changes in later versions of revision D55940 and
in new revision created off D55940)
Reviewers: jhenderson, chandlerc, jdenny, probinson, grimar,
arichardson, rnk
Subscribers: hiraditya, llvm-commits, probinson, dblaikie, grimar,
arichardson, tra, rnk, kristina, hfinkel, rogfer01, JonChesterfield
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D60385
llvm-svn: 360665
2019-05-14 19:58:30 +08:00
|
|
|
|
2019-06-20 07:47:24 +08:00
|
|
|
* ``<op>`` is an optional operation to perform on the value of ``<NUMVAR>``.
|
|
|
|
Currently supported operations are ``+`` and ``-``.
|
Reinstate "FileCheck [5/12]: Introduce regular numeric variables"
This reinstates r360578 (git e47362c1ec1ea31b626336cc05822035601c3e57),
reverted in r360653 (git 004393681c25e34e921adccc69ae6378090dee54),
with a fix for the list added in FileCheck.rst to build without error.
Copyright:
- Linaro (changes up to diff 183612 of revision D55940)
- GraphCore (changes in later versions of revision D55940 and
in new revision created off D55940)
Reviewers: jhenderson, chandlerc, jdenny, probinson, grimar,
arichardson, rnk
Subscribers: hiraditya, llvm-commits, probinson, dblaikie, grimar,
arichardson, tra, rnk, kristina, hfinkel, rogfer01, JonChesterfield
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D60385
llvm-svn: 360665
2019-05-14 19:58:30 +08:00
|
|
|
|
|
|
|
* ``<offset>`` is the immediate value that constitutes the second operand of
|
2019-06-20 07:47:24 +08:00
|
|
|
the operation ``<op>``. It must be present if ``<op>`` is present, absent
|
|
|
|
otherwise.
|
Reinstate "FileCheck [5/12]: Introduce regular numeric variables"
This reinstates r360578 (git e47362c1ec1ea31b626336cc05822035601c3e57),
reverted in r360653 (git 004393681c25e34e921adccc69ae6378090dee54),
with a fix for the list added in FileCheck.rst to build without error.
Copyright:
- Linaro (changes up to diff 183612 of revision D55940)
- GraphCore (changes in later versions of revision D55940 and
in new revision created off D55940)
Reviewers: jhenderson, chandlerc, jdenny, probinson, grimar,
arichardson, rnk
Subscribers: hiraditya, llvm-commits, probinson, dblaikie, grimar,
arichardson, tra, rnk, kristina, hfinkel, rogfer01, JonChesterfield
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D60385
llvm-svn: 360665
2019-05-14 19:58:30 +08:00
|
|
|
|
FileCheck: Improve FileCheck variable terminology
Summary:
Terminology introduced by [[#]] blocks is confusing and does not
integrate well with existing terminology.
First, variables referred by [[]] blocks are called "pattern variables"
while the text a CHECK directive needs to match is called a "CHECK
pattern". This is inconsistent with variables in [[#]] blocks since
[[#]] blocks are also found in CHECK pattern yet those variables are
called "numeric variable".
Second, the replacing of both [[]] and [[#]] blocks by the value of the
variable or expression they contain is represented by a
FileCheckPatternSubstitution class. The naming refers to being a
substitution in a CHECK pattern but could be wrongly understood as being
a substitution of a pattern variable.
Third and lastly, comments use "numeric expression" to refer both to the
[[#]] blocks as well as to the numeric expressions these blocks contain
which get evaluated at match time.
This patch solves these confusions by
- calling variables in [[]] and [[#]] blocks as string and numeric
variables respectively;
- referring to [[]] and [[#]] as substitution *blocks*, with the former
being a string substitution block and the latter a numeric
substitution block;
- calling [[]] and [[#]] blocks to be replaced by the value of a
variable or expression they contain a substitution (as opposed to
definition when these blocks are used to defined a variable), with the
former being a string substitution and the latter a numeric
substitution;
- renaming the FileCheckPatternSubstitution as a FileCheckSubstitution
class with FileCheckStringSubstitution and
FileCheckNumericSubstitution subclasses;
- restricting the use of "numeric expression" to refer to the expression
that is evaluated in a numeric substitution.
While numeric substitution blocks only support numeric substitutions of
numeric expressions at the moment there are plans to augment numeric
substitution blocks to support numeric definitions as well as both a
numeric definition and numeric substitution in the same numeric
substitution block.
Reviewers: jhenderson, jdenny, probinson, arichardson
Subscribers: hiraditya, arichardson, probinson, llvm-commits
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D62146
llvm-svn: 361445
2019-05-23 08:10:14 +08:00
|
|
|
Spaces are accepted before, after and between any of these elements.
|
|
|
|
|
Reinstate "FileCheck [5/12]: Introduce regular numeric variables"
This reinstates r360578 (git e47362c1ec1ea31b626336cc05822035601c3e57),
reverted in r360653 (git 004393681c25e34e921adccc69ae6378090dee54),
with a fix for the list added in FileCheck.rst to build without error.
Copyright:
- Linaro (changes up to diff 183612 of revision D55940)
- GraphCore (changes in later versions of revision D55940 and
in new revision created off D55940)
Reviewers: jhenderson, chandlerc, jdenny, probinson, grimar,
arichardson, rnk
Subscribers: hiraditya, llvm-commits, probinson, dblaikie, grimar,
arichardson, tra, rnk, kristina, hfinkel, rogfer01, JonChesterfield
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D60385
llvm-svn: 360665
2019-05-14 19:58:30 +08:00
|
|
|
For example:
|
|
|
|
|
|
|
|
.. code-block:: llvm
|
|
|
|
|
FileCheck [6/12]: Introduce numeric variable definition
Summary:
This patch is part of a patch series to add support for FileCheck
numeric expressions. This specific patch introduces support for defining
numeric variable in a CHECK directive.
This commit introduces support for defining numeric variable from a
litteral value in the input text. Numeric expressions can then use the
variable provided it is on a later line.
Copyright:
- Linaro (changes up to diff 183612 of revision D55940)
- GraphCore (changes in later versions of revision D55940 and
in new revision created off D55940)
Reviewers: jhenderson, chandlerc, jdenny, probinson, grimar, arichardson, rnk
Subscribers: hiraditya, llvm-commits, probinson, dblaikie, grimar, arichardson, tra, rnk, kristina, hfinkel, rogfer01, JonChesterfield
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D60386
llvm-svn: 362705
2019-06-06 21:21:06 +08:00
|
|
|
; CHECK: load r[[#REG:]], [r0]
|
|
|
|
; CHECK: load r[[#REG+1]], [r1]
|
Reinstate "FileCheck [5/12]: Introduce regular numeric variables"
This reinstates r360578 (git e47362c1ec1ea31b626336cc05822035601c3e57),
reverted in r360653 (git 004393681c25e34e921adccc69ae6378090dee54),
with a fix for the list added in FileCheck.rst to build without error.
Copyright:
- Linaro (changes up to diff 183612 of revision D55940)
- GraphCore (changes in later versions of revision D55940 and
in new revision created off D55940)
Reviewers: jhenderson, chandlerc, jdenny, probinson, grimar,
arichardson, rnk
Subscribers: hiraditya, llvm-commits, probinson, dblaikie, grimar,
arichardson, tra, rnk, kristina, hfinkel, rogfer01, JonChesterfield
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D60385
llvm-svn: 360665
2019-05-14 19:58:30 +08:00
|
|
|
|
FileCheck [6/12]: Introduce numeric variable definition
Summary:
This patch is part of a patch series to add support for FileCheck
numeric expressions. This specific patch introduces support for defining
numeric variable in a CHECK directive.
This commit introduces support for defining numeric variable from a
litteral value in the input text. Numeric expressions can then use the
variable provided it is on a later line.
Copyright:
- Linaro (changes up to diff 183612 of revision D55940)
- GraphCore (changes in later versions of revision D55940 and
in new revision created off D55940)
Reviewers: jhenderson, chandlerc, jdenny, probinson, grimar, arichardson, rnk
Subscribers: hiraditya, llvm-commits, probinson, dblaikie, grimar, arichardson, tra, rnk, kristina, hfinkel, rogfer01, JonChesterfield
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D60386
llvm-svn: 362705
2019-06-06 21:21:06 +08:00
|
|
|
The above example would match the text:
|
Reinstate "FileCheck [5/12]: Introduce regular numeric variables"
This reinstates r360578 (git e47362c1ec1ea31b626336cc05822035601c3e57),
reverted in r360653 (git 004393681c25e34e921adccc69ae6378090dee54),
with a fix for the list added in FileCheck.rst to build without error.
Copyright:
- Linaro (changes up to diff 183612 of revision D55940)
- GraphCore (changes in later versions of revision D55940 and
in new revision created off D55940)
Reviewers: jhenderson, chandlerc, jdenny, probinson, grimar,
arichardson, rnk
Subscribers: hiraditya, llvm-commits, probinson, dblaikie, grimar,
arichardson, tra, rnk, kristina, hfinkel, rogfer01, JonChesterfield
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D60385
llvm-svn: 360665
2019-05-14 19:58:30 +08:00
|
|
|
|
2019-05-15 23:20:45 +08:00
|
|
|
.. code-block:: gas
|
Reinstate "FileCheck [5/12]: Introduce regular numeric variables"
This reinstates r360578 (git e47362c1ec1ea31b626336cc05822035601c3e57),
reverted in r360653 (git 004393681c25e34e921adccc69ae6378090dee54),
with a fix for the list added in FileCheck.rst to build without error.
Copyright:
- Linaro (changes up to diff 183612 of revision D55940)
- GraphCore (changes in later versions of revision D55940 and
in new revision created off D55940)
Reviewers: jhenderson, chandlerc, jdenny, probinson, grimar,
arichardson, rnk
Subscribers: hiraditya, llvm-commits, probinson, dblaikie, grimar,
arichardson, tra, rnk, kristina, hfinkel, rogfer01, JonChesterfield
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D60385
llvm-svn: 360665
2019-05-14 19:58:30 +08:00
|
|
|
|
FileCheck [6/12]: Introduce numeric variable definition
Summary:
This patch is part of a patch series to add support for FileCheck
numeric expressions. This specific patch introduces support for defining
numeric variable in a CHECK directive.
This commit introduces support for defining numeric variable from a
litteral value in the input text. Numeric expressions can then use the
variable provided it is on a later line.
Copyright:
- Linaro (changes up to diff 183612 of revision D55940)
- GraphCore (changes in later versions of revision D55940 and
in new revision created off D55940)
Reviewers: jhenderson, chandlerc, jdenny, probinson, grimar, arichardson, rnk
Subscribers: hiraditya, llvm-commits, probinson, dblaikie, grimar, arichardson, tra, rnk, kristina, hfinkel, rogfer01, JonChesterfield
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D60386
llvm-svn: 362705
2019-06-06 21:21:06 +08:00
|
|
|
load r5, [r0]
|
|
|
|
load r6, [r1]
|
Reinstate "FileCheck [5/12]: Introduce regular numeric variables"
This reinstates r360578 (git e47362c1ec1ea31b626336cc05822035601c3e57),
reverted in r360653 (git 004393681c25e34e921adccc69ae6378090dee54),
with a fix for the list added in FileCheck.rst to build without error.
Copyright:
- Linaro (changes up to diff 183612 of revision D55940)
- GraphCore (changes in later versions of revision D55940 and
in new revision created off D55940)
Reviewers: jhenderson, chandlerc, jdenny, probinson, grimar,
arichardson, rnk
Subscribers: hiraditya, llvm-commits, probinson, dblaikie, grimar,
arichardson, tra, rnk, kristina, hfinkel, rogfer01, JonChesterfield
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D60385
llvm-svn: 360665
2019-05-14 19:58:30 +08:00
|
|
|
|
FileCheck [6/12]: Introduce numeric variable definition
Summary:
This patch is part of a patch series to add support for FileCheck
numeric expressions. This specific patch introduces support for defining
numeric variable in a CHECK directive.
This commit introduces support for defining numeric variable from a
litteral value in the input text. Numeric expressions can then use the
variable provided it is on a later line.
Copyright:
- Linaro (changes up to diff 183612 of revision D55940)
- GraphCore (changes in later versions of revision D55940 and
in new revision created off D55940)
Reviewers: jhenderson, chandlerc, jdenny, probinson, grimar, arichardson, rnk
Subscribers: hiraditya, llvm-commits, probinson, dblaikie, grimar, arichardson, tra, rnk, kristina, hfinkel, rogfer01, JonChesterfield
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D60386
llvm-svn: 362705
2019-06-06 21:21:06 +08:00
|
|
|
but would not match the text:
|
Reinstate "FileCheck [5/12]: Introduce regular numeric variables"
This reinstates r360578 (git e47362c1ec1ea31b626336cc05822035601c3e57),
reverted in r360653 (git 004393681c25e34e921adccc69ae6378090dee54),
with a fix for the list added in FileCheck.rst to build without error.
Copyright:
- Linaro (changes up to diff 183612 of revision D55940)
- GraphCore (changes in later versions of revision D55940 and
in new revision created off D55940)
Reviewers: jhenderson, chandlerc, jdenny, probinson, grimar,
arichardson, rnk
Subscribers: hiraditya, llvm-commits, probinson, dblaikie, grimar,
arichardson, tra, rnk, kristina, hfinkel, rogfer01, JonChesterfield
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D60385
llvm-svn: 360665
2019-05-14 19:58:30 +08:00
|
|
|
|
2019-05-15 23:20:45 +08:00
|
|
|
.. code-block:: gas
|
Reinstate "FileCheck [5/12]: Introduce regular numeric variables"
This reinstates r360578 (git e47362c1ec1ea31b626336cc05822035601c3e57),
reverted in r360653 (git 004393681c25e34e921adccc69ae6378090dee54),
with a fix for the list added in FileCheck.rst to build without error.
Copyright:
- Linaro (changes up to diff 183612 of revision D55940)
- GraphCore (changes in later versions of revision D55940 and
in new revision created off D55940)
Reviewers: jhenderson, chandlerc, jdenny, probinson, grimar,
arichardson, rnk
Subscribers: hiraditya, llvm-commits, probinson, dblaikie, grimar,
arichardson, tra, rnk, kristina, hfinkel, rogfer01, JonChesterfield
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D60385
llvm-svn: 360665
2019-05-14 19:58:30 +08:00
|
|
|
|
FileCheck [6/12]: Introduce numeric variable definition
Summary:
This patch is part of a patch series to add support for FileCheck
numeric expressions. This specific patch introduces support for defining
numeric variable in a CHECK directive.
This commit introduces support for defining numeric variable from a
litteral value in the input text. Numeric expressions can then use the
variable provided it is on a later line.
Copyright:
- Linaro (changes up to diff 183612 of revision D55940)
- GraphCore (changes in later versions of revision D55940 and
in new revision created off D55940)
Reviewers: jhenderson, chandlerc, jdenny, probinson, grimar, arichardson, rnk
Subscribers: hiraditya, llvm-commits, probinson, dblaikie, grimar, arichardson, tra, rnk, kristina, hfinkel, rogfer01, JonChesterfield
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D60386
llvm-svn: 362705
2019-06-06 21:21:06 +08:00
|
|
|
load r5, [r0]
|
|
|
|
load r7, [r1]
|
Reinstate "FileCheck [5/12]: Introduce regular numeric variables"
This reinstates r360578 (git e47362c1ec1ea31b626336cc05822035601c3e57),
reverted in r360653 (git 004393681c25e34e921adccc69ae6378090dee54),
with a fix for the list added in FileCheck.rst to build without error.
Copyright:
- Linaro (changes up to diff 183612 of revision D55940)
- GraphCore (changes in later versions of revision D55940 and
in new revision created off D55940)
Reviewers: jhenderson, chandlerc, jdenny, probinson, grimar,
arichardson, rnk
Subscribers: hiraditya, llvm-commits, probinson, dblaikie, grimar,
arichardson, tra, rnk, kristina, hfinkel, rogfer01, JonChesterfield
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D60385
llvm-svn: 360665
2019-05-14 19:58:30 +08:00
|
|
|
|
|
|
|
due to ``7`` being unequal to ``5 + 1``.
|
|
|
|
|
|
|
|
The ``--enable-var-scope`` option has the same effect on numeric variables as
|
FileCheck: Improve FileCheck variable terminology
Summary:
Terminology introduced by [[#]] blocks is confusing and does not
integrate well with existing terminology.
First, variables referred by [[]] blocks are called "pattern variables"
while the text a CHECK directive needs to match is called a "CHECK
pattern". This is inconsistent with variables in [[#]] blocks since
[[#]] blocks are also found in CHECK pattern yet those variables are
called "numeric variable".
Second, the replacing of both [[]] and [[#]] blocks by the value of the
variable or expression they contain is represented by a
FileCheckPatternSubstitution class. The naming refers to being a
substitution in a CHECK pattern but could be wrongly understood as being
a substitution of a pattern variable.
Third and lastly, comments use "numeric expression" to refer both to the
[[#]] blocks as well as to the numeric expressions these blocks contain
which get evaluated at match time.
This patch solves these confusions by
- calling variables in [[]] and [[#]] blocks as string and numeric
variables respectively;
- referring to [[]] and [[#]] as substitution *blocks*, with the former
being a string substitution block and the latter a numeric
substitution block;
- calling [[]] and [[#]] blocks to be replaced by the value of a
variable or expression they contain a substitution (as opposed to
definition when these blocks are used to defined a variable), with the
former being a string substitution and the latter a numeric
substitution;
- renaming the FileCheckPatternSubstitution as a FileCheckSubstitution
class with FileCheckStringSubstitution and
FileCheckNumericSubstitution subclasses;
- restricting the use of "numeric expression" to refer to the expression
that is evaluated in a numeric substitution.
While numeric substitution blocks only support numeric substitutions of
numeric expressions at the moment there are plans to augment numeric
substitution blocks to support numeric definitions as well as both a
numeric definition and numeric substitution in the same numeric
substitution block.
Reviewers: jhenderson, jdenny, probinson, arichardson
Subscribers: hiraditya, arichardson, probinson, llvm-commits
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D62146
llvm-svn: 361445
2019-05-23 08:10:14 +08:00
|
|
|
on string variables.
|
Reinstate "FileCheck [5/12]: Introduce regular numeric variables"
This reinstates r360578 (git e47362c1ec1ea31b626336cc05822035601c3e57),
reverted in r360653 (git 004393681c25e34e921adccc69ae6378090dee54),
with a fix for the list added in FileCheck.rst to build without error.
Copyright:
- Linaro (changes up to diff 183612 of revision D55940)
- GraphCore (changes in later versions of revision D55940 and
in new revision created off D55940)
Reviewers: jhenderson, chandlerc, jdenny, probinson, grimar,
arichardson, rnk
Subscribers: hiraditya, llvm-commits, probinson, dblaikie, grimar,
arichardson, tra, rnk, kristina, hfinkel, rogfer01, JonChesterfield
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D60385
llvm-svn: 360665
2019-05-14 19:58:30 +08:00
|
|
|
|
2019-06-20 07:47:24 +08:00
|
|
|
Important note: In its current implementation, an expression cannot use a
|
|
|
|
numeric variable defined on the same line.
|
FileCheck [6/12]: Introduce numeric variable definition
Summary:
This patch is part of a patch series to add support for FileCheck
numeric expressions. This specific patch introduces support for defining
numeric variable in a CHECK directive.
This commit introduces support for defining numeric variable from a
litteral value in the input text. Numeric expressions can then use the
variable provided it is on a later line.
Copyright:
- Linaro (changes up to diff 183612 of revision D55940)
- GraphCore (changes in later versions of revision D55940 and
in new revision created off D55940)
Reviewers: jhenderson, chandlerc, jdenny, probinson, grimar, arichardson, rnk
Subscribers: hiraditya, llvm-commits, probinson, dblaikie, grimar, arichardson, tra, rnk, kristina, hfinkel, rogfer01, JonChesterfield
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D60386
llvm-svn: 362705
2019-06-06 21:21:06 +08:00
|
|
|
|
Reinstate "FileCheck [5/12]: Introduce regular numeric variables"
This reinstates r360578 (git e47362c1ec1ea31b626336cc05822035601c3e57),
reverted in r360653 (git 004393681c25e34e921adccc69ae6378090dee54),
with a fix for the list added in FileCheck.rst to build without error.
Copyright:
- Linaro (changes up to diff 183612 of revision D55940)
- GraphCore (changes in later versions of revision D55940 and
in new revision created off D55940)
Reviewers: jhenderson, chandlerc, jdenny, probinson, grimar,
arichardson, rnk
Subscribers: hiraditya, llvm-commits, probinson, dblaikie, grimar,
arichardson, tra, rnk, kristina, hfinkel, rogfer01, JonChesterfield
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D60385
llvm-svn: 360665
2019-05-14 19:58:30 +08:00
|
|
|
FileCheck Pseudo Numeric Variables
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
2012-11-15 05:07:37 +08:00
|
|
|
|
FileCheck [4/12]: Introduce @LINE numeric expressions
Summary:
This patch is part of a patch series to add support for FileCheck
numeric expressions. This specific patch introduces the @LINE numeric
expressions.
This commit introduces a new syntax to express a relation a numeric
value in the input text must have with the line number of a given CHECK
pattern: [[#<@LINE numeric expression>]]. Further commits build on that
to express relations between several numeric values in the input text.
To help with naming, regular variables are renamed into pattern
variables and old @LINE expression syntax is referred to as legacy
numeric expression.
Compared to existing @LINE expressions, this new syntax allow arbitrary
spacing between the component of the expression. It offers otherwise the
same functionality but the commit serves to introduce some of the data
structure needed to support more general numeric expressions.
Copyright:
- Linaro (changes up to diff 183612 of revision D55940)
- GraphCore (changes in later versions of revision D55940 and
in new revision created off D55940)
Reviewers: jhenderson, chandlerc, jdenny, probinson, grimar, arichardson, rnk
Subscribers: hiraditya, llvm-commits, probinson, dblaikie, grimar, arichardson, tra, rnk, kristina, hfinkel, rogfer01, JonChesterfield
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D60384
llvm-svn: 359741
2019-05-02 08:04:38 +08:00
|
|
|
Sometimes there's a need to verify output that contains line numbers of the
|
2012-11-30 03:21:02 +08:00
|
|
|
match file, e.g. when testing compiler diagnostics. This introduces a certain
|
|
|
|
fragility of the match file structure, as "``CHECK:``" lines contain absolute
|
|
|
|
line numbers in the same file, which have to be updated whenever line numbers
|
|
|
|
change due to text addition or deletion.
|
2012-11-15 05:07:37 +08:00
|
|
|
|
2019-06-20 07:47:24 +08:00
|
|
|
To support this case, FileCheck expressions understand the ``@LINE`` pseudo
|
|
|
|
numeric variable which evaluates to the line number of the CHECK pattern where
|
|
|
|
it is found.
|
2012-11-15 05:07:37 +08:00
|
|
|
|
|
|
|
This way match patterns can be put near the relevant test lines and include
|
|
|
|
relative line number references, for example:
|
|
|
|
|
|
|
|
.. code-block:: c++
|
|
|
|
|
FileCheck [4/12]: Introduce @LINE numeric expressions
Summary:
This patch is part of a patch series to add support for FileCheck
numeric expressions. This specific patch introduces the @LINE numeric
expressions.
This commit introduces a new syntax to express a relation a numeric
value in the input text must have with the line number of a given CHECK
pattern: [[#<@LINE numeric expression>]]. Further commits build on that
to express relations between several numeric values in the input text.
To help with naming, regular variables are renamed into pattern
variables and old @LINE expression syntax is referred to as legacy
numeric expression.
Compared to existing @LINE expressions, this new syntax allow arbitrary
spacing between the component of the expression. It offers otherwise the
same functionality but the commit serves to introduce some of the data
structure needed to support more general numeric expressions.
Copyright:
- Linaro (changes up to diff 183612 of revision D55940)
- GraphCore (changes in later versions of revision D55940 and
in new revision created off D55940)
Reviewers: jhenderson, chandlerc, jdenny, probinson, grimar, arichardson, rnk
Subscribers: hiraditya, llvm-commits, probinson, dblaikie, grimar, arichardson, tra, rnk, kristina, hfinkel, rogfer01, JonChesterfield
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D60384
llvm-svn: 359741
2019-05-02 08:04:38 +08:00
|
|
|
// CHECK: test.cpp:[[# @LINE + 4]]:6: error: expected ';' after top level declarator
|
2012-11-15 05:07:37 +08:00
|
|
|
// CHECK-NEXT: {{^int a}}
|
|
|
|
// CHECK-NEXT: {{^ \^}}
|
|
|
|
// CHECK-NEXT: {{^ ;}}
|
|
|
|
int a
|
|
|
|
|
FileCheck: Improve FileCheck variable terminology
Summary:
Terminology introduced by [[#]] blocks is confusing and does not
integrate well with existing terminology.
First, variables referred by [[]] blocks are called "pattern variables"
while the text a CHECK directive needs to match is called a "CHECK
pattern". This is inconsistent with variables in [[#]] blocks since
[[#]] blocks are also found in CHECK pattern yet those variables are
called "numeric variable".
Second, the replacing of both [[]] and [[#]] blocks by the value of the
variable or expression they contain is represented by a
FileCheckPatternSubstitution class. The naming refers to being a
substitution in a CHECK pattern but could be wrongly understood as being
a substitution of a pattern variable.
Third and lastly, comments use "numeric expression" to refer both to the
[[#]] blocks as well as to the numeric expressions these blocks contain
which get evaluated at match time.
This patch solves these confusions by
- calling variables in [[]] and [[#]] blocks as string and numeric
variables respectively;
- referring to [[]] and [[#]] as substitution *blocks*, with the former
being a string substitution block and the latter a numeric
substitution block;
- calling [[]] and [[#]] blocks to be replaced by the value of a
variable or expression they contain a substitution (as opposed to
definition when these blocks are used to defined a variable), with the
former being a string substitution and the latter a numeric
substitution;
- renaming the FileCheckPatternSubstitution as a FileCheckSubstitution
class with FileCheckStringSubstitution and
FileCheckNumericSubstitution subclasses;
- restricting the use of "numeric expression" to refer to the expression
that is evaluated in a numeric substitution.
While numeric substitution blocks only support numeric substitutions of
numeric expressions at the moment there are plans to augment numeric
substitution blocks to support numeric definitions as well as both a
numeric definition and numeric substitution in the same numeric
substitution block.
Reviewers: jhenderson, jdenny, probinson, arichardson
Subscribers: hiraditya, arichardson, probinson, llvm-commits
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D62146
llvm-svn: 361445
2019-05-23 08:10:14 +08:00
|
|
|
To support legacy uses of ``@LINE`` as a special string variable,
|
|
|
|
:program:`FileCheck` also accepts the following uses of ``@LINE`` with string
|
|
|
|
substitution block syntax: ``[[@LINE]]``, ``[[@LINE+<offset>]]`` and
|
FileCheck [4/12]: Introduce @LINE numeric expressions
Summary:
This patch is part of a patch series to add support for FileCheck
numeric expressions. This specific patch introduces the @LINE numeric
expressions.
This commit introduces a new syntax to express a relation a numeric
value in the input text must have with the line number of a given CHECK
pattern: [[#<@LINE numeric expression>]]. Further commits build on that
to express relations between several numeric values in the input text.
To help with naming, regular variables are renamed into pattern
variables and old @LINE expression syntax is referred to as legacy
numeric expression.
Compared to existing @LINE expressions, this new syntax allow arbitrary
spacing between the component of the expression. It offers otherwise the
same functionality but the commit serves to introduce some of the data
structure needed to support more general numeric expressions.
Copyright:
- Linaro (changes up to diff 183612 of revision D55940)
- GraphCore (changes in later versions of revision D55940 and
in new revision created off D55940)
Reviewers: jhenderson, chandlerc, jdenny, probinson, grimar, arichardson, rnk
Subscribers: hiraditya, llvm-commits, probinson, dblaikie, grimar, arichardson, tra, rnk, kristina, hfinkel, rogfer01, JonChesterfield
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D60384
llvm-svn: 359741
2019-05-02 08:04:38 +08:00
|
|
|
``[[@LINE-<offset>]]`` without any spaces inside the brackets and where
|
|
|
|
``offset`` is an integer.
|
|
|
|
|
2016-06-28 07:59:00 +08:00
|
|
|
Matching Newline Characters
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
To match newline characters in regular expressions the character class
|
|
|
|
``[[:space:]]`` can be used. For example, the following pattern:
|
|
|
|
|
|
|
|
.. code-block:: c++
|
|
|
|
|
|
|
|
// CHECK: DW_AT_location [DW_FORM_sec_offset] ([[DLOC:0x[0-9a-f]+]]){{[[:space:]].*}}"intd"
|
|
|
|
|
|
|
|
matches output of the form (from llvm-dwarfdump):
|
|
|
|
|
[docs] Fixing Sphinx warnings to unclog the buildbot
Lots of blocks had "llvm" or "nasm" syntax types but either weren't following
the syntax, or the syntax has changed (and sphinx hasn't keep up) or the type
doesn't even exist (nasm?).
Other documents had :options: what were invalid. I only removed those that had
warnings, and left the ones that didn't, in order to follow the principle of
least surprise.
This is like this for ages, but the buildbot is now failing on errors. It may
take a while to upgrade the buildbot's sphinx, if that's even possible, but
that shouldn't stop us from getting docs updates (which seem down for quite
a while).
Also, we're not losing any syntax highlight, since when it doesn't parse, it
doesn't colour. Ie. those blocks are not being highlighted anyway.
I'm trying to get all docs in one go, so that it's easy to revert later if we
do fix, or at least easy to know what's to fix.
llvm-svn: 276109
2016-07-20 20:16:38 +08:00
|
|
|
.. code-block:: text
|
2016-06-28 07:59:00 +08:00
|
|
|
|
|
|
|
DW_AT_location [DW_FORM_sec_offset] (0x00000233)
|
|
|
|
DW_AT_name [DW_FORM_strp] ( .debug_str[0x000000c9] = "intd")
|
|
|
|
|
|
|
|
letting us set the :program:`FileCheck` variable ``DLOC`` to the desired value
|
|
|
|
``0x00000233``, extracted from the line immediately preceding "``intd``".
|