FileCheck.rst 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683
  1. FileCheck - Flexible pattern matching file verifier
  2. ===================================================
  3. .. program:: FileCheck
  4. SYNOPSIS
  5. --------
  6. :program:`FileCheck` *match-filename* [*--check-prefix=XXX*] [*--strict-whitespace*]
  7. DESCRIPTION
  8. -----------
  9. :program:`FileCheck` reads two files (one from standard input, and one
  10. specified on the command line) and uses one to verify the other. This
  11. behavior is particularly useful for the testsuite, which wants to verify that
  12. the output of some tool (e.g. :program:`llc`) contains the expected information
  13. (for example, a movsd from esp or whatever is interesting). This is similar to
  14. using :program:`grep`, but it is optimized for matching multiple different
  15. inputs in one file in a specific order.
  16. The ``match-filename`` file specifies the file that contains the patterns to
  17. match. The file to verify is read from standard input unless the
  18. :option:`--input-file` option is used.
  19. OPTIONS
  20. -------
  21. Options are parsed from the environment variable ``FILECHECK_OPTS``
  22. and from the command line.
  23. .. option:: -help
  24. Print a summary of command line options.
  25. .. option:: --check-prefix prefix
  26. FileCheck searches the contents of ``match-filename`` for patterns to
  27. match. By default, these patterns are prefixed with "``CHECK:``".
  28. If you'd like to use a different prefix (e.g. because the same input
  29. file is checking multiple different tool or options), the
  30. :option:`--check-prefix` argument allows you to specify one or more
  31. prefixes to match. Multiple prefixes are useful for tests which might
  32. change for different run options, but most lines remain the same.
  33. .. option:: --check-prefixes prefix1,prefix2,...
  34. An alias of :option:`--check-prefix` that allows multiple prefixes to be
  35. specified as a comma separated list.
  36. .. option:: --input-file filename
  37. File to check (defaults to stdin).
  38. .. option:: --match-full-lines
  39. By default, FileCheck allows matches of anywhere on a line. This
  40. option will require all positive matches to cover an entire
  41. line. Leading and trailing whitespace is ignored, unless
  42. :option:`--strict-whitespace` is also specified. (Note: negative
  43. matches from ``CHECK-NOT`` are not affected by this option!)
  44. Passing this option is equivalent to inserting ``{{^ *}}`` or
  45. ``{{^}}`` before, and ``{{ *$}}`` or ``{{$}}`` after every positive
  46. check pattern.
  47. .. option:: --strict-whitespace
  48. By default, FileCheck canonicalizes input horizontal whitespace (spaces and
  49. tabs) which causes it to ignore these differences (a space will match a tab).
  50. The :option:`--strict-whitespace` argument disables this behavior. End-of-line
  51. sequences are canonicalized to UNIX-style ``\n`` in all modes.
  52. .. option:: --implicit-check-not check-pattern
  53. Adds implicit negative checks for the specified patterns between positive
  54. checks. The option allows writing stricter tests without stuffing them with
  55. ``CHECK-NOT``\ s.
  56. For example, "``--implicit-check-not warning:``" can be useful when testing
  57. diagnostic messages from tools that don't have an option similar to ``clang
  58. -verify``. With this option FileCheck will verify that input does not contain
  59. warnings not covered by any ``CHECK:`` patterns.
  60. .. option:: --dump-input <mode>
  61. Dump input to stderr, adding annotations representing currently enabled
  62. diagnostics. Do this either 'always', on 'fail', or 'never'. Specify 'help'
  63. to explain the dump format and quit.
  64. .. option:: --dump-input-on-failure
  65. When the check fails, dump all of the original input. This option is
  66. deprecated in favor of `--dump-input=fail`.
  67. .. option:: --enable-var-scope
  68. Enables scope for regex variables.
  69. Variables with names that start with ``$`` are considered global and
  70. remain set throughout the file.
  71. All other variables get undefined after each encountered ``CHECK-LABEL``.
  72. .. option:: -D<VAR=VALUE>
  73. Sets a filecheck pattern variable ``VAR`` with value ``VALUE`` that can be
  74. used in ``CHECK:`` lines.
  75. .. option:: -D#<NUMVAR>=<VALUE>
  76. Sets a filecheck numeric variable ``NUMVAR`` to ``<VALUE>`` that can be used
  77. in ``CHECK:`` lines.
  78. .. option:: -version
  79. Show the version number of this program.
  80. .. option:: -v
  81. Print good directive pattern matches. However, if ``-input-dump=fail`` or
  82. ``-input-dump=always``, add those matches as input annotations instead.
  83. .. option:: -vv
  84. Print information helpful in diagnosing internal FileCheck issues, such as
  85. discarded overlapping ``CHECK-DAG:`` matches, implicit EOF pattern matches,
  86. and ``CHECK-NOT:`` patterns that do not have matches. Implies ``-v``.
  87. However, if ``-input-dump=fail`` or ``-input-dump=always``, just add that
  88. information as input annotations instead.
  89. .. option:: --allow-deprecated-dag-overlap
  90. Enable overlapping among matches in a group of consecutive ``CHECK-DAG:``
  91. directives. This option is deprecated and is only provided for convenience
  92. as old tests are migrated to the new non-overlapping ``CHECK-DAG:``
  93. implementation.
  94. .. option:: --color
  95. Use colors in output (autodetected by default).
  96. EXIT STATUS
  97. -----------
  98. If :program:`FileCheck` verifies that the file matches the expected contents,
  99. it exits with 0. Otherwise, if not, or if an error occurs, it will exit with a
  100. non-zero value.
  101. TUTORIAL
  102. --------
  103. FileCheck is typically used from LLVM regression tests, being invoked on the RUN
  104. line of the test. A simple example of using FileCheck from a RUN line looks
  105. like this:
  106. .. code-block:: llvm
  107. ; RUN: llvm-as < %s | llc -march=x86-64 | FileCheck %s
  108. This syntax says to pipe the current file ("``%s``") into ``llvm-as``, pipe
  109. that into ``llc``, then pipe the output of ``llc`` into ``FileCheck``. This
  110. means that FileCheck will be verifying its standard input (the llc output)
  111. against the filename argument specified (the original ``.ll`` file specified by
  112. "``%s``"). To see how this works, let's look at the rest of the ``.ll`` file
  113. (after the RUN line):
  114. .. code-block:: llvm
  115. define void @sub1(i32* %p, i32 %v) {
  116. entry:
  117. ; CHECK: sub1:
  118. ; CHECK: subl
  119. %0 = tail call i32 @llvm.atomic.load.sub.i32.p0i32(i32* %p, i32 %v)
  120. ret void
  121. }
  122. define void @inc4(i64* %p) {
  123. entry:
  124. ; CHECK: inc4:
  125. ; CHECK: incq
  126. %0 = tail call i64 @llvm.atomic.load.add.i64.p0i64(i64* %p, i64 1)
  127. ret void
  128. }
  129. Here you can see some "``CHECK:``" lines specified in comments. Now you can
  130. see how the file is piped into ``llvm-as``, then ``llc``, and the machine code
  131. output is what we are verifying. FileCheck checks the machine code output to
  132. verify that it matches what the "``CHECK:``" lines specify.
  133. The syntax of the "``CHECK:``" lines is very simple: they are fixed strings that
  134. must occur in order. FileCheck defaults to ignoring horizontal whitespace
  135. differences (e.g. a space is allowed to match a tab) but otherwise, the contents
  136. of the "``CHECK:``" line is required to match some thing in the test file exactly.
  137. One nice thing about FileCheck (compared to grep) is that it allows merging
  138. test cases together into logical groups. For example, because the test above
  139. is checking for the "``sub1:``" and "``inc4:``" labels, it will not match
  140. unless there is a "``subl``" in between those labels. If it existed somewhere
  141. else in the file, that would not count: "``grep subl``" matches if "``subl``"
  142. exists anywhere in the file.
  143. The FileCheck -check-prefix option
  144. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  145. The FileCheck `-check-prefix` option allows multiple test
  146. configurations to be driven from one `.ll` file. This is useful in many
  147. circumstances, for example, testing different architectural variants with
  148. :program:`llc`. Here's a simple example:
  149. .. code-block:: llvm
  150. ; RUN: llvm-as < %s | llc -mtriple=i686-apple-darwin9 -mattr=sse41 \
  151. ; RUN: | FileCheck %s -check-prefix=X32
  152. ; RUN: llvm-as < %s | llc -mtriple=x86_64-apple-darwin9 -mattr=sse41 \
  153. ; RUN: | FileCheck %s -check-prefix=X64
  154. define <4 x i32> @pinsrd_1(i32 %s, <4 x i32> %tmp) nounwind {
  155. %tmp1 = insertelement <4 x i32>; %tmp, i32 %s, i32 1
  156. ret <4 x i32> %tmp1
  157. ; X32: pinsrd_1:
  158. ; X32: pinsrd $1, 4(%esp), %xmm0
  159. ; X64: pinsrd_1:
  160. ; X64: pinsrd $1, %edi, %xmm0
  161. }
  162. In this case, we're testing that we get the expected code generation with
  163. both 32-bit and 64-bit code generation.
  164. The "CHECK-NEXT:" directive
  165. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  166. Sometimes you want to match lines and would like to verify that matches
  167. happen on exactly consecutive lines with no other lines in between them. In
  168. this case, you can use "``CHECK:``" and "``CHECK-NEXT:``" directives to specify
  169. this. If you specified a custom check prefix, just use "``<PREFIX>-NEXT:``".
  170. For example, something like this works as you'd expect:
  171. .. code-block:: llvm
  172. define void @t2(<2 x double>* %r, <2 x double>* %A, double %B) {
  173. %tmp3 = load <2 x double>* %A, align 16
  174. %tmp7 = insertelement <2 x double> undef, double %B, i32 0
  175. %tmp9 = shufflevector <2 x double> %tmp3,
  176. <2 x double> %tmp7,
  177. <2 x i32> < i32 0, i32 2 >
  178. store <2 x double> %tmp9, <2 x double>* %r, align 16
  179. ret void
  180. ; CHECK: t2:
  181. ; CHECK: movl 8(%esp), %eax
  182. ; CHECK-NEXT: movapd (%eax), %xmm0
  183. ; CHECK-NEXT: movhpd 12(%esp), %xmm0
  184. ; CHECK-NEXT: movl 4(%esp), %eax
  185. ; CHECK-NEXT: movapd %xmm0, (%eax)
  186. ; CHECK-NEXT: ret
  187. }
  188. "``CHECK-NEXT:``" directives reject the input unless there is exactly one
  189. newline between it and the previous directive. A "``CHECK-NEXT:``" cannot be
  190. the first directive in a file.
  191. The "CHECK-SAME:" directive
  192. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  193. Sometimes you want to match lines and would like to verify that matches happen
  194. on the same line as the previous match. In this case, you can use "``CHECK:``"
  195. and "``CHECK-SAME:``" directives to specify this. If you specified a custom
  196. check prefix, just use "``<PREFIX>-SAME:``".
  197. "``CHECK-SAME:``" is particularly powerful in conjunction with "``CHECK-NOT:``"
  198. (described below).
  199. For example, the following works like you'd expect:
  200. .. code-block:: llvm
  201. !0 = !DILocation(line: 5, scope: !1, inlinedAt: !2)
  202. ; CHECK: !DILocation(line: 5,
  203. ; CHECK-NOT: column:
  204. ; CHECK-SAME: scope: ![[SCOPE:[0-9]+]]
  205. "``CHECK-SAME:``" directives reject the input if there are any newlines between
  206. it and the previous directive. A "``CHECK-SAME:``" cannot be the first
  207. directive in a file.
  208. The "CHECK-EMPTY:" directive
  209. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  210. If you need to check that the next line has nothing on it, not even whitespace,
  211. you can use the "``CHECK-EMPTY:``" directive.
  212. .. code-block:: llvm
  213. declare void @foo()
  214. declare void @bar()
  215. ; CHECK: foo
  216. ; CHECK-EMPTY:
  217. ; CHECK-NEXT: bar
  218. Just like "``CHECK-NEXT:``" the directive will fail if there is more than one
  219. newline before it finds the next blank line, and it cannot be the first
  220. directive in a file.
  221. The "CHECK-NOT:" directive
  222. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  223. The "``CHECK-NOT:``" directive is used to verify that a string doesn't occur
  224. between two matches (or before the first match, or after the last match). For
  225. example, to verify that a load is removed by a transformation, a test like this
  226. can be used:
  227. .. code-block:: llvm
  228. define i8 @coerce_offset0(i32 %V, i32* %P) {
  229. store i32 %V, i32* %P
  230. %P2 = bitcast i32* %P to i8*
  231. %P3 = getelementptr i8* %P2, i32 2
  232. %A = load i8* %P3
  233. ret i8 %A
  234. ; CHECK: @coerce_offset0
  235. ; CHECK-NOT: load
  236. ; CHECK: ret i8
  237. }
  238. The "CHECK-COUNT:" directive
  239. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  240. If you need to match multiple lines with the same pattern over and over again
  241. you can repeat a plain ``CHECK:`` as many times as needed. If that looks too
  242. boring you can instead use a counted check "``CHECK-COUNT-<num>:``", where
  243. ``<num>`` is a positive decimal number. It will match the pattern exactly
  244. ``<num>`` times, no more and no less. If you specified a custom check prefix,
  245. just use "``<PREFIX>-COUNT-<num>:``" for the same effect.
  246. Here is a simple example:
  247. .. code-block:: text
  248. Loop at depth 1
  249. Loop at depth 1
  250. Loop at depth 1
  251. Loop at depth 1
  252. Loop at depth 2
  253. Loop at depth 3
  254. ; CHECK-COUNT-6: Loop at depth {{[0-9]+}}
  255. ; CHECK-NOT: Loop at depth {{[0-9]+}}
  256. The "CHECK-DAG:" directive
  257. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  258. If it's necessary to match strings that don't occur in a strictly sequential
  259. order, "``CHECK-DAG:``" could be used to verify them between two matches (or
  260. before the first match, or after the last match). For example, clang emits
  261. vtable globals in reverse order. Using ``CHECK-DAG:``, we can keep the checks
  262. in the natural order:
  263. .. code-block:: c++
  264. // RUN: %clang_cc1 %s -emit-llvm -o - | FileCheck %s
  265. struct Foo { virtual void method(); };
  266. Foo f; // emit vtable
  267. // CHECK-DAG: @_ZTV3Foo =
  268. struct Bar { virtual void method(); };
  269. Bar b;
  270. // CHECK-DAG: @_ZTV3Bar =
  271. ``CHECK-NOT:`` directives could be mixed with ``CHECK-DAG:`` directives to
  272. exclude strings between the surrounding ``CHECK-DAG:`` directives. As a result,
  273. the surrounding ``CHECK-DAG:`` directives cannot be reordered, i.e. all
  274. occurrences matching ``CHECK-DAG:`` before ``CHECK-NOT:`` must not fall behind
  275. occurrences matching ``CHECK-DAG:`` after ``CHECK-NOT:``. For example,
  276. .. code-block:: llvm
  277. ; CHECK-DAG: BEFORE
  278. ; CHECK-NOT: NOT
  279. ; CHECK-DAG: AFTER
  280. This case will reject input strings where ``BEFORE`` occurs after ``AFTER``.
  281. With captured variables, ``CHECK-DAG:`` is able to match valid topological
  282. orderings of a DAG with edges from the definition of a variable to its use.
  283. It's useful, e.g., when your test cases need to match different output
  284. sequences from the instruction scheduler. For example,
  285. .. code-block:: llvm
  286. ; CHECK-DAG: add [[REG1:r[0-9]+]], r1, r2
  287. ; CHECK-DAG: add [[REG2:r[0-9]+]], r3, r4
  288. ; CHECK: mul r5, [[REG1]], [[REG2]]
  289. In this case, any order of that two ``add`` instructions will be allowed.
  290. If you are defining `and` using variables in the same ``CHECK-DAG:`` block,
  291. be aware that the definition rule can match `after` its use.
  292. So, for instance, the code below will pass:
  293. .. code-block:: text
  294. ; CHECK-DAG: vmov.32 [[REG2:d[0-9]+]][0]
  295. ; CHECK-DAG: vmov.32 [[REG2]][1]
  296. vmov.32 d0[1]
  297. vmov.32 d0[0]
  298. While this other code, will not:
  299. .. code-block:: text
  300. ; CHECK-DAG: vmov.32 [[REG2:d[0-9]+]][0]
  301. ; CHECK-DAG: vmov.32 [[REG2]][1]
  302. vmov.32 d1[1]
  303. vmov.32 d0[0]
  304. While this can be very useful, it's also dangerous, because in the case of
  305. register sequence, you must have a strong order (read before write, copy before
  306. use, etc). If the definition your test is looking for doesn't match (because
  307. of a bug in the compiler), it may match further away from the use, and mask
  308. real bugs away.
  309. In those cases, to enforce the order, use a non-DAG directive between DAG-blocks.
  310. A ``CHECK-DAG:`` directive skips matches that overlap the matches of any
  311. preceding ``CHECK-DAG:`` directives in the same ``CHECK-DAG:`` block. Not only
  312. is this non-overlapping behavior consistent with other directives, but it's
  313. also necessary to handle sets of non-unique strings or patterns. For example,
  314. the following directives look for unordered log entries for two tasks in a
  315. parallel program, such as the OpenMP runtime:
  316. .. code-block:: text
  317. // CHECK-DAG: [[THREAD_ID:[0-9]+]]: task_begin
  318. // CHECK-DAG: [[THREAD_ID]]: task_end
  319. //
  320. // CHECK-DAG: [[THREAD_ID:[0-9]+]]: task_begin
  321. // CHECK-DAG: [[THREAD_ID]]: task_end
  322. The second pair of directives is guaranteed not to match the same log entries
  323. as the first pair even though the patterns are identical and even if the text
  324. of the log entries is identical because the thread ID manages to be reused.
  325. The "CHECK-LABEL:" directive
  326. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  327. Sometimes in a file containing multiple tests divided into logical blocks, one
  328. or more ``CHECK:`` directives may inadvertently succeed by matching lines in a
  329. later block. While an error will usually eventually be generated, the check
  330. flagged as causing the error may not actually bear any relationship to the
  331. actual source of the problem.
  332. In order to produce better error messages in these cases, the "``CHECK-LABEL:``"
  333. directive can be used. It is treated identically to a normal ``CHECK``
  334. directive except that FileCheck makes an additional assumption that a line
  335. matched by the directive cannot also be matched by any other check present in
  336. ``match-filename``; this is intended to be used for lines containing labels or
  337. other unique identifiers. Conceptually, the presence of ``CHECK-LABEL`` divides
  338. the input stream into separate blocks, each of which is processed independently,
  339. preventing a ``CHECK:`` directive in one block matching a line in another block.
  340. If ``--enable-var-scope`` is in effect, all local variables are cleared at the
  341. beginning of the block.
  342. For example,
  343. .. code-block:: llvm
  344. define %struct.C* @C_ctor_base(%struct.C* %this, i32 %x) {
  345. entry:
  346. ; CHECK-LABEL: C_ctor_base:
  347. ; CHECK: mov [[SAVETHIS:r[0-9]+]], r0
  348. ; CHECK: bl A_ctor_base
  349. ; CHECK: mov r0, [[SAVETHIS]]
  350. %0 = bitcast %struct.C* %this to %struct.A*
  351. %call = tail call %struct.A* @A_ctor_base(%struct.A* %0)
  352. %1 = bitcast %struct.C* %this to %struct.B*
  353. %call2 = tail call %struct.B* @B_ctor_base(%struct.B* %1, i32 %x)
  354. ret %struct.C* %this
  355. }
  356. define %struct.D* @D_ctor_base(%struct.D* %this, i32 %x) {
  357. entry:
  358. ; CHECK-LABEL: D_ctor_base:
  359. The use of ``CHECK-LABEL:`` directives in this case ensures that the three
  360. ``CHECK:`` directives only accept lines corresponding to the body of the
  361. ``@C_ctor_base`` function, even if the patterns match lines found later in
  362. the file. Furthermore, if one of these three ``CHECK:`` directives fail,
  363. FileCheck will recover by continuing to the next block, allowing multiple test
  364. failures to be detected in a single invocation.
  365. There is no requirement that ``CHECK-LABEL:`` directives contain strings that
  366. correspond to actual syntactic labels in a source or output language: they must
  367. simply uniquely match a single line in the file being verified.
  368. ``CHECK-LABEL:`` directives cannot contain variable definitions or uses.
  369. FileCheck Regex Matching Syntax
  370. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  371. All FileCheck directives take a pattern to match.
  372. For most uses of FileCheck, fixed string matching is perfectly sufficient. For
  373. some things, a more flexible form of matching is desired. To support this,
  374. FileCheck allows you to specify regular expressions in matching strings,
  375. surrounded by double braces: ``{{yourregex}}``. FileCheck implements a POSIX
  376. regular expression matcher; it supports Extended POSIX regular expressions
  377. (ERE). Because we want to use fixed string matching for a majority of what we
  378. do, FileCheck has been designed to support mixing and matching fixed string
  379. matching with regular expressions. This allows you to write things like this:
  380. .. code-block:: llvm
  381. ; CHECK: movhpd {{[0-9]+}}(%esp), {{%xmm[0-7]}}
  382. In this case, any offset from the ESP register will be allowed, and any xmm
  383. register will be allowed.
  384. Because regular expressions are enclosed with double braces, they are
  385. visually distinct, and you don't need to use escape characters within the double
  386. braces like you would in C. In the rare case that you want to match double
  387. braces explicitly from the input, you can use something ugly like
  388. ``{{[{][{]}}`` as your pattern.
  389. FileCheck String Substitution Blocks
  390. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  391. It is often useful to match a pattern and then verify that it occurs again
  392. later in the file. For codegen tests, this can be useful to allow any
  393. register, but verify that that register is used consistently later. To do
  394. this, :program:`FileCheck` supports string substitution blocks that allow
  395. string variables to be defined and substituted into patterns. Here is a simple
  396. example:
  397. .. code-block:: llvm
  398. ; CHECK: test5:
  399. ; CHECK: notw [[REGISTER:%[a-z]+]]
  400. ; CHECK: andw {{.*}}[[REGISTER]]
  401. The first check line matches a regex ``%[a-z]+`` and captures it into the
  402. string variable ``REGISTER``. The second line verifies that whatever is in
  403. ``REGISTER`` occurs later in the file after an "``andw``". :program:`FileCheck`
  404. string substitution blocks are always contained in ``[[ ]]`` pairs, and string
  405. variable names can be formed with the regex ``[a-zA-Z_][a-zA-Z0-9_]*``. If a
  406. colon follows the name, then it is a definition of the variable; otherwise, it
  407. is a substitution.
  408. :program:`FileCheck` variables can be defined multiple times, and substitutions
  409. always get the latest value. Variables can also be substituted later on the
  410. same line they were defined on. For example:
  411. .. code-block:: llvm
  412. ; CHECK: op [[REG:r[0-9]+]], [[REG]]
  413. Can be useful if you want the operands of ``op`` to be the same register,
  414. and don't care exactly which register it is.
  415. If ``--enable-var-scope`` is in effect, variables with names that
  416. start with ``$`` are considered to be global. All others variables are
  417. local. All local variables get undefined at the beginning of each
  418. CHECK-LABEL block. Global variables are not affected by CHECK-LABEL.
  419. This makes it easier to ensure that individual tests are not affected
  420. by variables set in preceding tests.
  421. FileCheck Numeric Substitution Blocks
  422. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  423. :program:`FileCheck` also supports numeric substitution blocks that allow
  424. defining numeric variables and checking for numeric values that satisfy a
  425. numeric expression constraint based on those variables via a numeric
  426. substitution. This allows ``CHECK:`` directives to verify a numeric relation
  427. between two numbers, such as the need for consecutive registers to be used.
  428. The syntax to define a numeric variable is ``[[#<NUMVAR>:]]`` where
  429. ``<NUMVAR>`` is the name of the numeric variable to define to the matching
  430. value.
  431. For example:
  432. .. code-block:: llvm
  433. ; CHECK: mov r[[#REG:]], 42
  434. would match ``mov r5, 42`` and set ``REG`` to the value ``5``.
  435. The syntax of a numeric substitution is ``[[#<NUMVAR><op><offset>]]`` where:
  436. * ``<NUMVAR>`` is the name of a defined numeric variable.
  437. * ``<op>`` is an optional operation to perform on the value of ``<NUMVAR>``.
  438. Currently supported operations are ``+`` and ``-``.
  439. * ``<offset>`` is the immediate value that constitutes the second operand of
  440. the operation ``<op>``. It must be present if ``<op>`` is present, absent
  441. otherwise.
  442. Spaces are accepted before, after and between any of these elements.
  443. For example:
  444. .. code-block:: llvm
  445. ; CHECK: load r[[#REG:]], [r0]
  446. ; CHECK: load r[[#REG+1]], [r1]
  447. The above example would match the text:
  448. .. code-block:: gas
  449. load r5, [r0]
  450. load r6, [r1]
  451. but would not match the text:
  452. .. code-block:: gas
  453. load r5, [r0]
  454. load r7, [r1]
  455. due to ``7`` being unequal to ``5 + 1``.
  456. The ``--enable-var-scope`` option has the same effect on numeric variables as
  457. on string variables.
  458. Important note: In its current implementation, an expression cannot use a
  459. numeric variable defined on the same line.
  460. FileCheck Pseudo Numeric Variables
  461. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  462. Sometimes there's a need to verify output that contains line numbers of the
  463. match file, e.g. when testing compiler diagnostics. This introduces a certain
  464. fragility of the match file structure, as "``CHECK:``" lines contain absolute
  465. line numbers in the same file, which have to be updated whenever line numbers
  466. change due to text addition or deletion.
  467. To support this case, FileCheck expressions understand the ``@LINE`` pseudo
  468. numeric variable which evaluates to the line number of the CHECK pattern where
  469. it is found.
  470. This way match patterns can be put near the relevant test lines and include
  471. relative line number references, for example:
  472. .. code-block:: c++
  473. // CHECK: test.cpp:[[# @LINE + 4]]:6: error: expected ';' after top level declarator
  474. // CHECK-NEXT: {{^int a}}
  475. // CHECK-NEXT: {{^ \^}}
  476. // CHECK-NEXT: {{^ ;}}
  477. int a
  478. To support legacy uses of ``@LINE`` as a special string variable,
  479. :program:`FileCheck` also accepts the following uses of ``@LINE`` with string
  480. substitution block syntax: ``[[@LINE]]``, ``[[@LINE+<offset>]]`` and
  481. ``[[@LINE-<offset>]]`` without any spaces inside the brackets and where
  482. ``offset`` is an integer.
  483. Matching Newline Characters
  484. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  485. To match newline characters in regular expressions the character class
  486. ``[[:space:]]`` can be used. For example, the following pattern:
  487. .. code-block:: c++
  488. // CHECK: DW_AT_location [DW_FORM_sec_offset] ([[DLOC:0x[0-9a-f]+]]){{[[:space:]].*}}"intd"
  489. matches output of the form (from llvm-dwarfdump):
  490. .. code-block:: text
  491. DW_AT_location [DW_FORM_sec_offset] (0x00000233)
  492. DW_AT_name [DW_FORM_strp] ( .debug_str[0x000000c9] = "intd")
  493. letting us set the :program:`FileCheck` variable ``DLOC`` to the desired value
  494. ``0x00000233``, extracted from the line immediately preceding "``intd``".