docs/TestingGuide.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
   2                       "http://www.w3.org/TR/html4/strict.dtd">
   3 <html>
   4 <head>
   5   <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   6   <title>LLVM Testing Infrastructure Guide</title>
   7   <link rel="stylesheet" href="llvm.css" type="text/css">
   8 </head>
   9 <body>
  10
  11 <h1>
  12   LLVM Testing Infrastructure Guide
  13 </h1>
  14
  15 <ol>
  16   <li><a href="#overview">Overview</a></li>
  17   <li><a href="#requirements">Requirements</a></li>
  18   <li><a href="#org">LLVM testing infrastructure organization</a>
  19     <ul>
  20       <li><a href="#regressiontests">Regression tests</a></li>
  21       <li><a href="#testsuite">Test suite</a></li>
  22       <li><a href="#debuginfotests">Debugging Information tests</a></li>
  23     </ul>
  24   </li>
  25   <li><a href="#quick">Quick start</a>
  26     <ul>
  27       <li><a href="#quickregressiontests">Regression tests</a></li>
  28       <li><a href="#quicktestsuite">Test suite</a></li>
  29       <li><a href="#quickdebuginfotests">Debugging Information tests</a></li>
  30    </ul>
  31   </li>
  32   <li><a href="#rtstructure">Regression test structure</a>
  33     <ul>
  34       <li><a href="#rtcustom">Writing new regression tests</a></li>
  35       <li><a href="#FileCheck">The FileCheck utility</a></li>
  36       <li><a href="#rtvars">Variables and substitutions</a></li>
  37       <li><a href="#rtfeatures">Other features</a></li>
  38    </ul>
  39   </li>
  40   <li><a href="#testsuitestructure">Test suite structure</a></li>
  41   <li><a href="#testsuiterun">Running the test suite</a>
  42     <ul>
  43       <li><a href="#testsuiteexternal">Configuring External Tests</a></li>
  44       <li><a href="#testsuitetests">Running different tests</a></li>
  45       <li><a href="#testsuiteoutput">Generating test output</a></li>
  46       <li><a href="#testsuitecustom">Writing custom tests for test-suite</a></li>
  47    </ul>
  48   </li>
  49 </ol>
  50
  51 <div class="doc_author">
  52   <p>Written by John T. Criswell, Daniel Dunbar, Reid Spencer, and Tanya Lattner</p>
  53 </div>
  54
  55 <!--=========================================================================-->
  56 <h2><a name="overview">Overview</a></h2>
  57 <!--=========================================================================-->
  58
  59 <div>
  60
  61 <p>This document is the reference manual for the LLVM testing infrastructure. It
  62 documents the structure of the LLVM testing infrastructure, the tools needed to
  63 use it, and how to add and run tests.</p>
  64
  65 </div>
  66
  67 <!--=========================================================================-->
  68 <h2><a name="requirements">Requirements</a></h2>
  69 <!--=========================================================================-->
  70
  71 <div>
  72
  73 <p>In order to use the LLVM testing infrastructure, you will need all of the
  74 software required to build LLVM, as well
  75 as <a href="http://python.org">Python</a> 2.4 or later.</p>
  76
  77 </div>
  78
  79 <!--=========================================================================-->
  80 <h2><a name="org">LLVM testing infrastructure organization</a></h2>
  81 <!--=========================================================================-->
  82
  83 <div>
  84
  85 <p>The LLVM testing infrastructure contains two major categories of tests:
  86 regression tests and whole programs. The regression tests are contained inside
  87 the LLVM repository itself under <tt>llvm/test</tt> and are expected to always
  88 pass -- they should be run before every commit. The whole programs tests are
  89 referred to as the "LLVM test suite" and are in the <tt>test-suite</tt> module
  90 in subversion.
  91 </p>
  92
  93 <!-- _______________________________________________________________________ -->
  94 <h3><a name="regressiontests">Regression tests</a></h3>
  95 <!-- _______________________________________________________________________ -->
  96
  97 <div>
  98
  99 <p>The regression tests are small pieces of code that test a specific feature of
 100 LLVM or trigger a specific bug in LLVM.  They are usually written in LLVM
 101 assembly language, but can be written in other languages if the test targets a
 102 particular language front end (and the appropriate <tt>--with-llvmgcc</tt>
 103 options were used at <tt>configure</tt> time of the <tt>llvm</tt> module). These
 104 tests are driven by the 'lit' testing tool, which is part of LLVM.</p>
 105
 106 <p>These code fragments are not complete programs. The code generated
 107 from them is never executed to determine correct behavior.</p>
 108
 109 <p>These code fragment tests are located in the <tt>llvm/test</tt>
 110 directory.</p>
 111
 112 <p>Typically when a bug is found in LLVM, a regression test containing
 113 just enough code to reproduce the problem should be written and placed
 114 somewhere underneath this directory.  In most cases, this will be a small
 115 piece of LLVM assembly language code, often distilled from an actual
 116 application or benchmark.</p>
 117
 118 </div>
 119
 120 <!-- _______________________________________________________________________ -->
 121 <h3><a name="testsuite">Test suite</a></h3>
 122 <!-- _______________________________________________________________________ -->
 123
 124 <div>
 125
 126 <p>The test suite contains whole programs, which are pieces of
 127 code which can be compiled and linked into a stand-alone program that can be
 128 executed.  These programs are generally written in high level languages such as
 129 C or C++, but sometimes they are written straight in LLVM assembly.</p>
 130
 131 <p>These programs are compiled and then executed using several different
 132 methods (native compiler, LLVM C backend, LLVM JIT, LLVM native code generation,
 133 etc).  The output of these programs is compared to ensure that LLVM is compiling
 134 the program correctly.</p>
 135
 136 <p>In addition to compiling and executing programs, whole program tests serve as
 137 a way of benchmarking LLVM performance, both in terms of the efficiency of the
 138 programs generated as well as the speed with which LLVM compiles, optimizes, and
 139 generates code.</p>
 140
 141 <p>The test-suite is located in the <tt>test-suite</tt> Subversion module.</p>
 142
 143 </div>
 144
 145 <!-- _______________________________________________________________________ -->
 146 <h3><a name="debuginfotests">Debugging Information tests</a></h3>
 147 <!-- _______________________________________________________________________ -->
 148
 149 <div>
 150
 151 <p>The test suite contains tests to check quality of debugging information.
 152 The test are written in C based languages or in LLVM assembly language. </p>
 153
 154 <p>These tests are compiled and run under a debugger. The debugger output
 155 is checked to validate of debugging information. See README.txt in the
 156 test suite for more information . This test suite is located in the
 157 <tt>debuginfo-tests</tt> Subversion module. </p>
 158
 159 </div>
 160
 161 </div>
 162
 163 <!--=========================================================================-->
 164 <h2><a name="quick">Quick start</a></h2>
 165 <!--=========================================================================-->
 166
 167 <div>
 168
 169   <p>The tests are located in two separate Subversion modules. The regressions
 170   tests are in the main "llvm" module under the directory
 171   <tt>llvm/test</tt> (so you get these tests for free with the main llvm tree).
 172   The more comprehensive test suite that includes whole
 173 programs in C and C++ is in the <tt>test-suite</tt> module. This module should
 174 be checked out to the <tt>llvm/projects</tt> directory (don't use another name
 175 than the default "test-suite", for then the test suite will be run every time
 176 you run <tt>make</tt> in the main <tt>llvm</tt> directory).
 177 When you <tt>configure</tt> the <tt>llvm</tt> module,
 178 the <tt>test-suite</tt> directory will be automatically configured.
 179 Alternatively, you can configure the <tt>test-suite</tt> module manually.</p>
 180
 181 <!-- _______________________________________________________________________ -->
 182 <h3><a name="quickregressiontests">Regression tests</a></h3>
 183 <div>
 184 <!-- _______________________________________________________________________ -->
 185 <p>To run all of the LLVM regression tests, use master Makefile in
 186  the <tt>llvm/test</tt> directory:</p>
 187
 188 <div class="doc_code">
 189 <pre>
 190 % gmake -C llvm/test
 191 </pre>
 192 </div>
 193
 194 <p>or</p>
 195
 196 <div class="doc_code">
 197 <pre>
 198 % gmake check
 199 </pre>
 200 </div>
 201
 202 <p>If you have <a href="http://clang.llvm.org/">Clang</a> checked out and built,
 203 you can run the LLVM and Clang tests simultaneously using:</p>
 204
 205 <p>or</p>
 206
 207 <div class="doc_code">
 208 <pre>
 209 % gmake check-all
 210 </pre>
 211 </div>
 212
 213 <p>To run the tests with Valgrind (Memcheck by default), just append
 214 <tt>VG=1</tt> to the commands above, e.g.:</p>
 215
 216 <div class="doc_code">
 217 <pre>
 218 % gmake check VG=1
 219 </pre>
 220 </div>
 221
 222 <p>To run individual tests or subsets of tests, you can use the 'llvm-lit'
 223 script which is built as part of LLVM. For example, to run the
 224 'Integer/BitCast.ll' test by itself you can run:</p>
 225
 226 <div class="doc_code">
 227 <pre>
 228 % llvm-lit ~/llvm/test/Integer/BitCast.ll
 229 </pre>
 230 </div>
 231
 232 <p>or to run all of the ARM CodeGen tests:</p>
 233
 234 <div class="doc_code">
 235 <pre>
 236 % llvm-lit ~/llvm/test/CodeGen/ARM
 237 </pre>
 238 </div>
 239
 240 <p>For more information on using the 'lit' tool, see 'llvm-lit --help' or the
 241 'lit' man page.</p>
 242
 243 </div>
 244
 245 <!-- _______________________________________________________________________ -->
 246 <h3><a name="quicktestsuite">Test suite</a></h3>
 247 <!-- _______________________________________________________________________ -->
 248
 249 <div>
 250
 251 <p>To run the comprehensive test suite (tests that compile and execute whole
 252 programs), first checkout and setup the <tt>test-suite</tt> module:</p>
 253
 254 <div class="doc_code">
 255 <pre>
 256 % cd llvm/projects
 257 % svn co http://llvm.org/svn/llvm-project/test-suite/trunk test-suite
 258 % cd ..
 259 % ./configure --with-llvmgccdir=$LLVM_GCC_DIR
 260 </pre>
 261 </div>
 262
 263 <p>where <tt>$LLVM_GCC_DIR</tt> is the directory where
 264 you <em>installed</em> llvm-gcc, not its src or obj
 265 dir. The <tt>--with-llvmgccdir</tt> option assumes that
 266 the <tt>llvm-gcc-4.2</tt> module was configured with
 267 <tt>--program-prefix=llvm-</tt>, and therefore that the C and C++
 268 compiler drivers are called <tt>llvm-gcc</tt> and <tt>llvm-g++</tt>
 269 respectively.  If this is not the case,
 270 use <tt>--with-llvmgcc</tt>/<tt>--with-llvmgxx</tt> to specify each
 271 executable's location.</p>
 272
 273 <p>Then, run the entire test suite by running make in the <tt>test-suite</tt>
 274 directory:</p>
 275
 276 <div class="doc_code">
 277 <pre>
 278 % cd projects/test-suite
 279 % gmake
 280 </pre>
 281 </div>
 282
 283 <p>Usually, running the "nightly" set of tests is a good idea, and you can also
 284 let it generate a report by running:</p>
 285
 286 <div class="doc_code">
 287 <pre>
 288 % cd projects/test-suite
 289 % gmake TEST=nightly report report.html
 290 </pre>
 291 </div>
 292
 293 <p>Any of the above commands can also be run in a subdirectory of
 294 <tt>projects/test-suite</tt> to run the specified test only on the programs in
 295 that subdirectory.</p>
 296
 297 </div>
 298
 299 <!-- _______________________________________________________________________ -->
 300 <h3><a name="quickdebuginfotests">Debugging Information tests</a></h3>
 301 <div>
 302 <!-- _______________________________________________________________________ -->
 303 <div>
 304
 305 <p> To run debugging information tests simply checkout the tests inside
 306 clang/test directory. </p>
 307
 308 <div class="doc_code">
 309 <pre>
 310 %cd clang/test
 311 % svn co http://llvm.org/svn/llvm-project/debuginfo-tests/trunk debuginfo-tests
 312 </pre>
 313 </div>
 314
 315 <p> These tests are already set up to run as part of clang regression tests.</p>
 316
 317 </div>
 318
 319 </div>
 320
 321 </div>
 322
 323 <!--=========================================================================-->
 324 <h2><a name="rtstructure">Regression test structure</a></h2>
 325 <!--=========================================================================-->
 326 <div>
 327   <p>The LLVM regression tests are driven by 'lit' and are located in
 328   the <tt>llvm/test</tt> directory.
 329
 330   <p>This directory contains a large array of small tests
 331   that exercise various features of LLVM and to ensure that regressions do not
 332   occur. The directory is broken into several sub-directories, each focused on
 333   a particular area of LLVM. A few of the important ones are:</p>
 334
 335   <ul>
 336     <li><tt>Analysis</tt>: checks Analysis passes.</li>
 337     <li><tt>Archive</tt>: checks the Archive library.</li>
 338     <li><tt>Assembler</tt>: checks Assembly reader/writer functionality.</li>
 339     <li><tt>Bitcode</tt>: checks Bitcode reader/writer functionality.</li>
 340     <li><tt>CodeGen</tt>: checks code generation and each target.</li>
 341     <li><tt>Features</tt>: checks various features of the LLVM language.</li>
 342     <li><tt>Linker</tt>: tests bitcode linking.</li>
 343     <li><tt>Transforms</tt>: tests each of the scalar, IPO, and utility
 344     transforms to ensure they make the right transformations.</li>
 345     <li><tt>Verifier</tt>: tests the IR verifier.</li>
 346   </ul>
 347
 348 <!-- _______________________________________________________________________ -->
 349 <h3><a name="rtcustom">Writing new regression tests</a></h3>
 350 <!-- _______________________________________________________________________ -->
 351 <div>
 352   <p>The regression test structure is very simple, but does require some
 353   information to be set. This information is gathered via <tt>configure</tt> and
 354   is written to a file, <tt>lit.site.cfg</tt>
 355   in <tt>llvm/test</tt>. The <tt>llvm/test</tt> Makefile does this work for
 356   you.</p>
 357
 358   <p>In order for the regression tests to work, each directory of tests must
 359   have a <tt>dg.exp</tt> file. Lit looks for this file to determine how to
 360   run the tests. This file is just a Tcl script and it can do anything you want,
 361   but we've standardized it for the LLVM regression tests. If you're adding a
 362   directory of tests, just copy <tt>dg.exp</tt> from another directory to get
 363   running. The standard <tt>dg.exp</tt> simply loads a Tcl library
 364   (<tt>test/lib/llvm.exp</tt>) and calls the <tt>llvm_runtests</tt> function
 365   defined in that library with a list of file names to run. The names are
 366   obtained by using Tcl's glob command.  Any directory that contains only
 367   directories does not need the <tt>dg.exp</tt> file.</p>
 368
 369   <p>The <tt>llvm-runtests</tt> function looks at each file that is passed to
 370   it and gathers any lines together that match "RUN:". These are the "RUN" lines
 371   that specify how the test is to be run. So, each test script must contain
 372   RUN lines if it is to do anything. If there are no RUN lines, the
 373   <tt>llvm-runtests</tt> function will issue an error and the test will
 374   fail.</p>
 375
 376   <p>RUN lines are specified in the comments of the test program using the
 377   keyword <tt>RUN</tt> followed by a colon, and lastly the command (pipeline)
 378   to execute.  Together, these lines form the "script" that
 379   <tt>llvm-runtests</tt> executes to run the test case.  The syntax of the
 380   RUN lines is similar to a shell's syntax for pipelines including I/O
 381   redirection and variable substitution.  However, even though these lines
 382   may <i>look</i> like a shell script, they are not. RUN lines are interpreted
 383   directly by the Tcl <tt>exec</tt> command. They are never executed by a
 384   shell. Consequently the syntax differs from normal shell script syntax in a
 385   few ways.  You can specify as many RUN lines as needed.</p>
 386
 387   <p>lit performs substitution on each RUN line to replace LLVM tool
 388   names with the full paths to the executable built for each tool (in
 389   $(LLVM_OBJ_ROOT)/$(BuildMode)/bin).  This ensures that lit does not
 390   invoke any stray LLVM tools in the user's path during testing.</p>
 391
 392   <p>Each RUN line is executed on its own, distinct from other lines unless
 393   its last character is <tt>\</tt>. This continuation character causes the RUN
 394   line to be concatenated with the next one. In this way you can build up long
 395   pipelines of commands without making huge line lengths. The lines ending in
 396   <tt>\</tt> are concatenated until a RUN line that doesn't end in <tt>\</tt> is
 397   found. This concatenated set of RUN lines then constitutes one execution.
 398   Tcl will substitute variables and arrange for the pipeline to be executed. If
 399   any process in the pipeline fails, the entire line (and test case) fails too.
 400   </p>
 401
 402   <p> Below is an example of legal RUN lines in a <tt>.ll</tt> file:</p>
 403
 404 <div class="doc_code">
 405 <pre>
 406 ; RUN: llvm-as &lt; %s | llvm-dis &gt; %t1
 407 ; RUN: llvm-dis &lt; %s.bc-13 &gt; %t2
 408 ; RUN: diff %t1 %t2
 409 </pre>
 410 </div>
 411
 412   <p>As with a Unix shell, the RUN: lines permit pipelines and I/O redirection
 413   to be used. However, the usage is slightly different than for Bash. To check
 414   what's legal, see the documentation for the
 415   <a href="http://www.tcl.tk/man/tcl8.5/TclCmd/exec.htm#M2">Tcl exec</a>
 416   command and the
 417   <a href="http://www.tcl.tk/man/tcl8.5/tutorial/Tcl26.html">tutorial</a>.
 418   The major differences are:</p>
 419   <ul>
 420     <li>You can't do <tt>2&gt;&amp;1</tt>. That will cause Tcl to write to a
 421     file named <tt>&amp;1</tt>. Usually this is done to get stderr to go through
 422     a pipe. You can do that in tcl with <tt>|&amp;</tt> so replace this idiom:
 423     <tt>... 2&gt;&amp;1 | grep</tt> with <tt>... |&amp; grep</tt></li>
 424     <li>You can only redirect to a file, not to another descriptor and not from
 425     a here document.</li>
 426     <li>tcl supports redirecting to open files with the @ syntax but you
 427     shouldn't use that here.</li>
 428   </ul>
 429
 430   <p>There are some quoting rules that you must pay attention to when writing
 431   your RUN lines. In general nothing needs to be quoted. Tcl won't strip off any
 432   quote characters so they will get passed to the invoked program. For
 433   example:</p>
 434
 435 <div class="doc_code">
 436 <pre>
 437 ... | grep 'find this string'
 438 </pre>
 439 </div>
 440
 441   <p>This will fail because the ' characters are passed to grep. This would
 442   instruction grep to look for <tt>'find</tt> in the files <tt>this</tt> and
 443   <tt>string'</tt>. To avoid this use curly braces to tell Tcl that it should
 444   treat everything enclosed as one value. So our example would become:</p>
 445
 446 <div class="doc_code">
 447 <pre>
 448 ... | grep {find this string}
 449 </pre>
 450 </div>
 451
 452   <p>Additionally, the characters <tt>[</tt> and <tt>]</tt> are treated
 453   specially by Tcl. They tell Tcl to interpret the content as a command to
 454   execute. Since these characters are often used in regular expressions this can
 455   have disastrous results and cause the entire test run in a directory to fail.
 456   For example, a common idiom is to look for some basicblock number:</p>
 457
 458 <div class="doc_code">
 459 <pre>
 460 ... | grep bb[2-8]
 461 </pre>
 462 </div>
 463
 464   <p>This, however, will cause Tcl to fail because its going to try to execute
 465   a program named "2-8". Instead, what you want is this:</p>
 466
 467 <div class="doc_code">
 468 <pre>
 469 ... | grep {bb\[2-8\]}
 470 </pre>
 471 </div>
 472
 473   <p>Finally, if you need to pass the <tt>\</tt> character down to a program,
 474   then it must be doubled. This is another Tcl special character. So, suppose
 475   you had:
 476
 477 <div class="doc_code">
 478 <pre>
 479 ... | grep 'i32\*'
 480 </pre>
 481 </div>
 482
 483   <p>This will fail to match what you want (a pointer to i32). First, the
 484   <tt>'</tt> do not get stripped off. Second, the <tt>\</tt> gets stripped off
 485   by Tcl so what grep sees is: <tt>'i32*'</tt>. That's not likely to match
 486   anything. To resolve this you must use <tt>\\</tt> and the <tt>{}</tt>, like
 487   this:</p>
 488
 489 <div class="doc_code">
 490 <pre>
 491 ... | grep {i32\\*}
 492 </pre>
 493 </div>
 494
 495 <p>If your system includes GNU <tt>grep</tt>, make sure
 496 that <tt>GREP_OPTIONS</tt> is not set in your environment. Otherwise,
 497 you may get invalid results (both false positives and false
 498 negatives).</p>
 499
 500 </div>
 501
 502 <!-- _______________________________________________________________________ -->
 503 <h3><a name="FileCheck">The FileCheck utility</a></h3>
 504 <!-- _______________________________________________________________________ -->
 505
 506 <div>
 507
 508 <p>A powerful feature of the RUN: lines is that it allows any arbitrary commands
 509    to be executed as part of the test harness.  While standard (portable) unix
 510    tools like 'grep' work fine on run lines, as you see above, there are a lot
 511    of caveats due to interaction with Tcl syntax, and we want to make sure the
 512    run lines are portable to a wide range of systems.  Another major problem is
 513    that grep is not very good at checking to verify that the output of a tools
 514    contains a series of different output in a specific order.  The FileCheck
 515    tool was designed to help with these problems.</p>
 516
 517 <p>FileCheck (whose basic command line arguments are described in <a
 518    href="http://llvm.org/cmds/FileCheck.html">the FileCheck man page</a> is
 519    designed to read a file to check from standard input, and the set of things
 520    to verify from a file specified as a command line argument.  A simple example
 521    of using FileCheck from a RUN line looks like this:</p>
 522
 523 <div class="doc_code">
 524 <pre>
 525 ; RUN: llvm-as &lt; %s | llc -march=x86-64 | <b>FileCheck %s</b>
 526 </pre>
 527 </div>
 528
 529 <p>This syntax says to pipe the current file ("%s") into llvm-as, pipe that into
 530 llc, then pipe the output of llc into FileCheck.  This means that FileCheck will
 531 be verifying its standard input (the llc output) against the filename argument
 532 specified (the original .ll file specified by "%s").  To see how this works,
 533 lets look at the rest of the .ll file (after the RUN line):</p>
 534
 535 <div class="doc_code">
 536 <pre>
 537 define void @sub1(i32* %p, i32 %v) {
 538 entry:
 539 ; <b>CHECK: sub1:</b>
 540 ; <b>CHECK: subl</b>
 541         %0 = tail call i32 @llvm.atomic.load.sub.i32.p0i32(i32* %p, i32 %v)
 542         ret void
 543 }
 544
 545 define void @inc4(i64* %p) {
 546 entry:
 547 ; <b>CHECK: inc4:</b>
 548 ; <b>CHECK: incq</b>
 549         %0 = tail call i64 @llvm.atomic.load.add.i64.p0i64(i64* %p, i64 1)
 550         ret void
 551 }
 552 </pre>
 553 </div>
 554
 555 <p>Here you can see some "CHECK:" lines specified in comments.  Now you can see
 556 how the file is piped into llvm-as, then llc, and the machine code output is
 557 what we are verifying.  FileCheck checks the machine code output to verify that
 558 it matches what the "CHECK:" lines specify.</p>
 559
 560 <p>The syntax of the CHECK: lines is very simple: they are fixed strings that
 561 must occur in order.  FileCheck defaults to ignoring horizontal whitespace
 562 differences (e.g. a space is allowed to match a tab) but otherwise, the contents
 563 of the CHECK: line is required to match some thing in the test file exactly.</p>
 564
 565 <p>One nice thing about FileCheck (compared to grep) is that it allows merging
 566 test cases together into logical groups.  For example, because the test above
 567 is checking for the "sub1:" and "inc4:" labels, it will not match unless there
 568 is a "subl" in between those labels.  If it existed somewhere else in the file,
 569 that would not count: "grep subl" matches if subl exists anywhere in the
 570 file.</p>
 571
 572 <!-- _______________________________________________________________________ -->
 573 <h4>
 574   <a name="FileCheck-check-prefix">The FileCheck -check-prefix option</a>
 575 </h4>
 576
 577 <div>
 578
 579 <p>The FileCheck -check-prefix option allows multiple test configurations to be
 580 driven from one .ll file.  This is useful in many circumstances, for example,
 581 testing different architectural variants with llc.  Here's a simple example:</p>
 582
 583 <div class="doc_code">
 584 <pre>
 585 ; RUN: llvm-as &lt; %s | llc -mtriple=i686-apple-darwin9 -mattr=sse41 \
 586 ; RUN:              | <b>FileCheck %s -check-prefix=X32</b>
 587 ; RUN: llvm-as &lt; %s | llc -mtriple=x86_64-apple-darwin9 -mattr=sse41 \
 588 ; RUN:              | <b>FileCheck %s -check-prefix=X64</b>
 589
 590 define &lt;4 x i32&gt; @pinsrd_1(i32 %s, &lt;4 x i32&gt; %tmp) nounwind {
 591         %tmp1 = insertelement &lt;4 x i32&gt; %tmp, i32 %s, i32 1
 592         ret &lt;4 x i32&gt; %tmp1
 593 ; <b>X32:</b> pinsrd_1:
 594 ; <b>X32:</b>    pinsrd $1, 4(%esp), %xmm0
 595
 596 ; <b>X64:</b> pinsrd_1:
 597 ; <b>X64:</b>    pinsrd $1, %edi, %xmm0
 598 }
 599 </pre>
 600 </div>
 601
 602 <p>In this case, we're testing that we get the expected code generation with
 603 both 32-bit and 64-bit code generation.</p>
 604
 605 </div>
 606
 607 <!-- _______________________________________________________________________ -->
 608 <h4>
 609   <a name="FileCheck-CHECK-NEXT">The "CHECK-NEXT:" directive</a>
 610 </h4>
 611
 612 <div>
 613
 614 <p>Sometimes you want to match lines and would like to verify that matches
 615 happen on exactly consecutive lines with no other lines in between them.  In
 616 this case, you can use CHECK: and CHECK-NEXT: directives to specify this.  If
 617 you specified a custom check prefix, just use "&lt;PREFIX&gt;-NEXT:".  For
 618 example, something like this works as you'd expect:</p>
 619
 620 <div class="doc_code">
 621 <pre>
 622 define void @t2(&lt;2 x double&gt;* %r, &lt;2 x double&gt;* %A, double %B) {
 623         %tmp3 = load &lt;2 x double&gt;* %A, align 16
 624         %tmp7 = insertelement &lt;2 x double&gt; undef, double %B, i32 0
 625         %tmp9 = shufflevector &lt;2 x double&gt; %tmp3,
 626                               &lt;2 x double&gt; %tmp7,
 627                               &lt;2 x i32&gt; &lt; i32 0, i32 2 &gt;
 628         store &lt;2 x double&gt; %tmp9, &lt;2 x double&gt;* %r, align 16
 629         ret void
 630
 631 ; <b>CHECK:</b> t2:
 632 ; <b>CHECK:</b>         movl    8(%esp), %eax
 633 ; <b>CHECK-NEXT:</b>    movapd  (%eax), %xmm0
 634 ; <b>CHECK-NEXT:</b>    movhpd  12(%esp), %xmm0
 635 ; <b>CHECK-NEXT:</b>    movl    4(%esp), %eax
 636 ; <b>CHECK-NEXT:</b>    movapd  %xmm0, (%eax)
 637 ; <b>CHECK-NEXT:</b>    ret
 638 }
 639 </pre>
 640 </div>
 641
 642 <p>CHECK-NEXT: directives reject the input unless there is exactly one newline
 643 between it an the previous directive.  A CHECK-NEXT cannot be the first
 644 directive in a file.</p>
 645
 646 </div>
 647
 648 <!-- _______________________________________________________________________ -->
 649 <h4>
 650   <a name="FileCheck-CHECK-NOT">The "CHECK-NOT:" directive</a>
 651 </h4>
 652
 653 <div>
 654
 655 <p>The CHECK-NOT: directive is used to verify that a string doesn't occur
 656 between two matches (or the first match and the beginning of the file).  For
 657 example, to verify that a load is removed by a transformation, a test like this
 658 can be used:</p>
 659
 660 <div class="doc_code">
 661 <pre>
 662 define i8 @coerce_offset0(i32 %V, i32* %P) {
 663   store i32 %V, i32* %P
 664
 665   %P2 = bitcast i32* %P to i8*
 666   %P3 = getelementptr i8* %P2, i32 2
 667
 668   %A = load i8* %P3
 669   ret i8 %A
 670 ; <b>CHECK:</b> @coerce_offset0
 671 ; <b>CHECK-NOT:</b> load
 672 ; <b>CHECK:</b> ret i8
 673 }
 674 </pre>
 675 </div>
 676
 677 </div>
 678
 679 <!-- _______________________________________________________________________ -->
 680 <h4>
 681   <a name="FileCheck-Matching">FileCheck Pattern Matching Syntax</a>
 682 </h4>
 683
 684 <div>
 685
 686 <p>The CHECK: and CHECK-NOT: directives both take a pattern to match.  For most
 687 uses of FileCheck, fixed string matching is perfectly sufficient.  For some
 688 things, a more flexible form of matching is desired.  To support this, FileCheck
 689 allows you to specify regular expressions in matching strings, surrounded by
 690 double braces: <b>{{yourregex}}</b>.  Because we want to use fixed string
 691 matching for a majority of what we do, FileCheck has been designed to support
 692 mixing and matching fixed string matching with regular expressions.  This allows
 693 you to write things like this:</p>
 694
 695 <div class="doc_code">
 696 <pre>
 697 ; CHECK: movhpd <b>{{[0-9]+}}</b>(%esp), <b>{{%xmm[0-7]}}</b>
 698 </pre>
 699 </div>
 700
 701 <p>In this case, any offset from the ESP register will be allowed, and any xmm
 702 register will be allowed.</p>
 703
 704 <p>Because regular expressions are enclosed with double braces, they are
 705 visually distinct, and you don't need to use escape characters within the double
 706 braces like you would in C.  In the rare case that you want to match double
 707 braces explicitly from the input, you can use something ugly like
 708 <b>{{[{][{]}}</b> as your pattern.</p>
 709
 710 </div>
 711
 712 <!-- _______________________________________________________________________ -->
 713 <h4>
 714   <a name="FileCheck-Variables">FileCheck Variables</a>
 715 </h4>
 716
 717 <div>
 718
 719 <p>It is often useful to match a pattern and then verify that it occurs again
 720 later in the file.  For codegen tests, this can be useful to allow any register,
 721 but verify that that register is used consistently later.  To do this, FileCheck
 722 allows named variables to be defined and substituted into patterns.  Here is a
 723 simple example:</p>
 724
 725 <div class="doc_code">
 726 <pre>
 727 ; CHECK: test5:
 728 ; CHECK:    notw        <b>[[REGISTER:%[a-z]+]]</b>
 729 ; CHECK:    andw        {{.*}}<b>[[REGISTER]]</b>
 730 </pre>
 731 </div>
 732
 733 <p>The first check line matches a regex (<tt>%[a-z]+</tt>) and captures it into
 734 the variables "REGISTER".  The second line verifies that whatever is in REGISTER
 735 occurs later in the file after an "andw".  FileCheck variable references are
 736 always contained in <tt>[[ ]]</tt> pairs, are named, and their names can be
 737 formed with the regex "<tt>[a-zA-Z][a-zA-Z0-9]*</tt>".  If a colon follows the
 738 name, then it is a definition of the variable, if not, it is a use.</p>
 739
 740 <p>FileCheck variables can be defined multiple times, and uses always get the
 741 latest value.  Note that variables are all read at the start of a "CHECK" line
 742 and are all defined at the end.  This means that if you have something like
 743 "<tt>CHECK: [[XYZ:.*]]x[[XYZ]]</tt>" that the check line will read the previous
 744 value of the XYZ variable and define a new one after the match is performed.  If
 745 you need to do something like this you can probably take advantage of the fact
 746 that FileCheck is not actually line-oriented when it matches, this allows you to
 747 define two separate CHECK lines that match on the same line.
 748 </p>
 749
 750 </div>
 751
 752 </div>
 753
 754 <!-- _______________________________________________________________________ -->
 755 <h3><a name="rtvars">Variables and substitutions</a></h3>
 756 <!-- _______________________________________________________________________ -->
 757 <div>
 758   <p>With a RUN line there are a number of substitutions that are permitted. In
 759   general, any Tcl variable that is available in the <tt>substitute</tt>
 760   function (in <tt>test/lib/llvm.exp</tt>) can be substituted into a RUN line.
 761   To make a substitution just write the variable's name preceded by a $.
 762   Additionally, for compatibility reasons with previous versions of the test
 763   library, certain names can be accessed with an alternate syntax: a % prefix.
 764   These alternates are deprecated and may go away in a future version.
 765   </p>
 766   <p>Here are the available variable names. The alternate syntax is listed in
 767   parentheses.</p>
 768
 769   <dl style="margin-left: 25px">
 770     <dt><b>$test</b> (%s)</dt>
 771     <dd>The full path to the test case's source. This is suitable for passing
 772     on the command line as the input to an llvm tool.</dd>
 773
 774     <dt><b>$srcdir</b></dt>
 775     <dd>The source directory from where the "<tt>make check</tt>" was run.</dd>
 776
 777     <dt><b>objdir</b></dt>
 778     <dd>The object directory that corresponds to the <tt>$srcdir</tt>.</dd>
 779
 780     <dt><b>subdir</b></dt>
 781     <dd>A partial path from the <tt>test</tt> directory that contains the
 782     sub-directory that contains the test source being executed.</dd>
 783
 784     <dt><b>srcroot</b></dt>
 785     <dd>The root directory of the LLVM src tree.</dd>
 786
 787     <dt><b>objroot</b></dt>
 788     <dd>The root directory of the LLVM object tree. This could be the same
 789     as the srcroot.</dd>
 790
 791     <dt><b>path</b><dt>
 792     <dd>The path to the directory that contains the test case source.  This is
 793     for locating any supporting files that are not generated by the test, but
 794     used by the test.</dd>
 795
 796     <dt><b>tmp</b></dt>
 797     <dd>The path to a temporary file name that could be used for this test case.
 798     The file name won't conflict with other test cases. You can append to it if
 799     you need multiple temporaries. This is useful as the destination of some
 800     redirected output.</dd>
 801
 802     <dt><b>target_triplet</b> (%target_triplet)</dt>
 803     <dd>The target triplet that corresponds to the current host machine (the one
 804     running the test cases). This should probably be called "host".<dd>
 805
 806     <dt><b>link</b> (%link)</dt>
 807     <dd>This full link command used to link LLVM executables. This has all the
 808     configured -I, -L and -l options.</dd>
 809
 810     <dt><b>shlibext</b> (%shlibext)</dt>
 811     <dd>The suffix for the host platforms share library (dll) files. This
 812     includes the period as the first character.</dd>
 813   </dl>
 814   <p>To add more variables, two things need to be changed. First, add a line in
 815   the <tt>test/Makefile</tt> that creates the <tt>site.exp</tt> file. This will
 816   "set" the variable as a global in the site.exp file. Second, in the
 817   <tt>test/lib/llvm.exp</tt> file, in the substitute proc, add the variable name
 818   to the list of "global" declarations at the beginning of the proc. That's it,
 819   the variable can then be used in test scripts.</p>
 820 </div>
 821
 822 <!-- _______________________________________________________________________ -->
 823 <h3><a name="rtfeatures">Other Features</a></h3>
 824 <!-- _______________________________________________________________________ -->
 825 <div>
 826   <p>To make RUN line writing easier, there are several shell scripts located
 827   in the <tt>llvm/test/Scripts</tt> directory. This directory is in the PATH
 828   when running tests, so you can just call these scripts using their name. For
 829   example:</p>
 830   <dl>
 831     <dt><b>ignore</b></dt>
 832     <dd>This script runs its arguments and then always returns 0. This is useful
 833     in cases where the test needs to cause a tool to generate an error (e.g. to
 834     check the error output). However, any program in a pipeline that returns a
 835     non-zero result will cause the test to fail. This script overcomes that
 836     issue and nicely documents that the test case is purposefully ignoring the
 837     result code of the tool</dd>
 838
 839     <dt><b>not</b></dt>
 840     <dd>This script runs its arguments and then inverts the result code from
 841     it. Zero result codes become 1. Non-zero result codes become 0. This is
 842     useful to invert the result of a grep. For example "not grep X" means
 843     succeed only if you don't find X in the input.</dd>
 844   </dl>
 845
 846   <p>Sometimes it is necessary to mark a test case as "expected fail" or XFAIL.
 847   You can easily mark a test as XFAIL just by including <tt>XFAIL: </tt> on a
 848   line near the top of the file. This signals that the test case should succeed
 849   if the test fails. Such test cases are counted separately by the testing tool. To
 850   specify an expected fail, use the XFAIL keyword in the comments of the test
 851   program followed by a colon and one or more regular expressions (separated by
 852   a comma). The regular expressions allow you to XFAIL the test conditionally by
 853   host platform. The regular expressions following the : are matched against the
 854   target triplet for the host machine. If there is a match, the test is expected
 855   to fail. If not, the test is expected to succeed. To XFAIL everywhere just
 856   specify <tt>XFAIL: *</tt>. Here is an example of an <tt>XFAIL</tt> line:</p>
 857
 858 <div class="doc_code">
 859 <pre>
 860 ; XFAIL: darwin,sun
 861 </pre>
 862 </div>
 863
 864   <p>To make the output more useful, the <tt>llvm_runtest</tt> function wil
 865   scan the lines of the test case for ones that contain a pattern that matches
 866   PR[0-9]+. This is the syntax for specifying a PR (Problem Report) number that
 867   is related to the test case. The number after "PR" specifies the LLVM bugzilla
 868   number. When a PR number is specified, it will be used in the pass/fail
 869   reporting. This is useful to quickly get some context when a test fails.</p>
 870
 871   <p>Finally, any line that contains "END." will cause the special
 872   interpretation of lines to terminate. This is generally done right after the
 873   last RUN: line. This has two side effects: (a) it prevents special
 874   interpretation of lines that are part of the test program, not the
 875   instructions to the test case, and (b) it speeds things up for really big test
 876   cases by avoiding interpretation of the remainder of the file.</p>
 877
 878 </div>
 879
 880 </div>
 881
 882 <!--=========================================================================-->
 883 <h2><a name="testsuitestructure">Test suite Structure</a></h2>
 884 <!--=========================================================================-->
 885
 886 <div>
 887
 888 <p>The <tt>test-suite</tt> module contains a number of programs that can be compiled
 889 with LLVM and executed. These programs are compiled using the native compiler
 890 and various LLVM backends. The output from the program compiled with the
 891 native compiler is assumed correct; the results from the other programs are
 892 compared to the native program output and pass if they match.</p>
 893
 894 <p>When executing tests, it is usually a good idea to start out with a subset of
 895 the available tests or programs. This makes test run times smaller at first and
 896 later on this is useful to investigate individual test failures. To run some
 897 test only on a subset of programs, simply change directory to the programs you
 898 want tested and run <tt>gmake</tt> there. Alternatively, you can run a different
 899 test using the <tt>TEST</tt> variable to change what tests or run on the
 900 selected programs (see below for more info).</p>
 901
 902 <p>In addition for testing correctness, the <tt>test-suite</tt> directory also
 903 performs timing tests of various LLVM optimizations.  It also records
 904 compilation times for the compilers and the JIT.  This information can be
 905 used to compare the effectiveness of LLVM's optimizations and code
 906 generation.</p>
 907
 908 <p><tt>test-suite</tt> tests are divided into three types of tests: MultiSource,
 909 SingleSource, and External.</p>
 910
 911 <ul>
 912 <li><tt>test-suite/SingleSource</tt>
 913 <p>The SingleSource directory contains test programs that are only a single
 914 source file in size.  These are usually small benchmark programs or small
 915 programs that calculate a particular value.  Several such programs are grouped
 916 together in each directory.</p></li>
 917
 918 <li><tt>test-suite/MultiSource</tt>
 919 <p>The MultiSource directory contains subdirectories which contain entire
 920 programs with multiple source files.  Large benchmarks and whole applications
 921 go here.</p></li>
 922
 923 <li><tt>test-suite/External</tt>
 924 <p>The External directory contains Makefiles for building code that is external
 925 to (i.e., not distributed with) LLVM.  The most prominent members of this
 926 directory are the SPEC 95 and SPEC 2000 benchmark suites. The <tt>External</tt>
 927 directory does not contain these actual tests, but only the Makefiles that know
 928 how to properly compile these programs from somewhere else. The presence and
 929 location of these external programs is configured by the test-suite
 930 <tt>configure</tt> script.</p></li>
 931 </ul>
 932
 933 <p>Each tree is then subdivided into several categories, including applications,
 934 benchmarks, regression tests, code that is strange grammatically, etc.  These
 935 organizations should be relatively self explanatory.</p>
 936
 937 <p>Some tests are known to fail.  Some are bugs that we have not fixed yet;
 938 others are features that we haven't added yet (or may never add).  In the
 939 regression tests, the result for such tests will be XFAIL (eXpected FAILure).
 940 In this way, you can tell the difference between an expected and unexpected
 941 failure.</p>
 942
 943 <p>The tests in the test suite have no such feature at this time. If the
 944 test passes, only warnings and other miscellaneous output will be generated.  If
 945 a test fails, a large &lt;program&gt; FAILED message will be displayed.  This
 946 will help you separate benign warnings from actual test failures.</p>
 947
 948 </div>
 949
 950 <!--=========================================================================-->
 951 <h2><a name="testsuiterun">Running the test suite</a></h2>
 952 <!--=========================================================================-->
 953
 954 <div>
 955
 956 <p>First, all tests are executed within the LLVM object directory tree.  They
 957 <i>are not</i> executed inside of the LLVM source tree. This is because the
 958 test suite creates temporary files during execution.</p>
 959
 960 <p>To run the test suite, you need to use the following steps:</p>
 961
 962 <ol>
 963   <li><tt>cd</tt> into the <tt>llvm/projects</tt> directory in your source tree.
 964   </li>
 965
 966   <li><p>Check out the <tt>test-suite</tt> module with:</p>
 967
 968 <div class="doc_code">
 969 <pre>
 970 % svn co http://llvm.org/svn/llvm-project/test-suite/trunk test-suite
 971 </pre>
 972 </div>
 973     <p>This will get the test suite into <tt>llvm/projects/test-suite</tt>.</p>
 974   </li>
 975   <li><p>Configure and build <tt>llvm</tt>.</p></li>
 976   <li><p>Configure and build <tt>llvm-gcc</tt>.</p></li>
 977   <li><p>Install <tt>llvm-gcc</tt> somewhere.</p></li>
 978   <li><p><em>Re-configure</em> <tt>llvm</tt> from the top level of
 979       each build tree (LLVM object directory tree) in which you want
 980       to run the test suite, just as you do before building LLVM.</p>
 981     <p>During the <em>re-configuration</em>, you must either: (1)
 982       have <tt>llvm-gcc</tt> you just built in your path, or (2)
 983       specify the directory where your just-built <tt>llvm-gcc</tt> is
 984       installed using <tt>--with-llvmgccdir=$LLVM_GCC_DIR</tt>.</p>
 985     <p>You must also tell the configure machinery that the test suite
 986       is available so it can be configured for your build tree:</p>
 987 <div class="doc_code">
 988 <pre>
 989 % cd $LLVM_OBJ_ROOT ; $LLVM_SRC_ROOT/configure [--with-llvmgccdir=$LLVM_GCC_DIR]
 990 </pre>
 991 </div>
 992     <p>[Remember that <tt>$LLVM_GCC_DIR</tt> is the directory where you
 993     <em>installed</em> llvm-gcc, not its src or obj directory.]</p>
 994   </li>
 995
 996   <li><p>You can now run the test suite from your build tree as follows:</p>
 997 <div class="doc_code">
 998 <pre>
 999 % cd $LLVM_OBJ_ROOT/projects/test-suite
1000 % make
1001 </pre>
1002 </div>
1003   </li>
1004 </ol>
1005 <p>Note that the second and third steps only need to be done once. After you
1006 have the suite checked out and configured, you don't need to do it again (unless
1007 the test code or configure script changes).</p>
1008
1009 <!-- _______________________________________________________________________ -->
1010 <h3>
1011   <a name="testsuiteexternal">Configuring External Tests</a>
1012 </h3>
1013 <!-- _______________________________________________________________________ -->
1014
1015 <div>
1016 <p>In order to run the External tests in the <tt>test-suite</tt>
1017   module, you must specify <i>--with-externals</i>.  This
1018   must be done during the <em>re-configuration</em> step (see above),
1019   and the <tt>llvm</tt> re-configuration must recognize the
1020   previously-built <tt>llvm-gcc</tt>.  If any of these is missing or
1021   neglected, the External tests won't work.</p>
1022 <dl>
1023 <dt><i>--with-externals</i></dt>
1024 <dt><i>--with-externals=&lt;<tt>directory</tt>&gt;</i></dt>
1025 </dl>
1026   This tells LLVM where to find any external tests.  They are expected to be
1027   in specifically named subdirectories of &lt;<tt>directory</tt>&gt;.
1028   If <tt>directory</tt> is left unspecified,
1029   <tt>configure</tt> uses the default value
1030   <tt>/home/vadve/shared/benchmarks/speccpu2000/benchspec</tt>.
1031   Subdirectory names known to LLVM include:
1032   <dl>
1033   <dt>spec95</dt>
1034   <dt>speccpu2000</dt>
1035   <dt>speccpu2006</dt>
1036   <dt>povray31</dt>
1037   </dl>
1038   Others are added from time to time, and can be determined from
1039   <tt>configure</tt>.
1040 </div>
1041
1042 <!-- _______________________________________________________________________ -->
1043 <h3>
1044   <a name="testsuitetests">Running different tests</a>
1045 </h3>
1046 <!-- _______________________________________________________________________ -->
1047 <div>
1048 <p>In addition to the regular "whole program" tests, the <tt>test-suite</tt>
1049 module also provides a mechanism for compiling the programs in different ways.
1050 If the variable TEST is defined on the <tt>gmake</tt> command line, the test system will
1051 include a Makefile named <tt>TEST.&lt;value of TEST variable&gt;.Makefile</tt>.
1052 This Makefile can modify build rules to yield different results.</p>
1053
1054 <p>For example, the LLVM nightly tester uses <tt>TEST.nightly.Makefile</tt> to
1055 create the nightly test reports.  To run the nightly tests, run <tt>gmake
1056 TEST=nightly</tt>.</p>
1057
1058 <p>There are several TEST Makefiles available in the tree.  Some of them are
1059 designed for internal LLVM research and will not work outside of the LLVM
1060 research group.  They may still be valuable, however, as a guide to writing your
1061 own TEST Makefile for any optimization or analysis passes that you develop with
1062 LLVM.</p>
1063
1064 </div>
1065
1066 <!-- _______________________________________________________________________ -->
1067 <h3>
1068   <a name="testsuiteoutput">Generating test output</a>
1069 </h3>
1070 <!-- _______________________________________________________________________ -->
1071 <div>
1072   <p>There are a number of ways to run the tests and generate output. The most
1073   simple one is simply running <tt>gmake</tt> with no arguments. This will
1074   compile and run all programs in the tree using a number of different methods
1075   and compare results. Any failures are reported in the output, but are likely
1076   drowned in the other output. Passes are not reported explicitely.</p>
1077
1078   <p>Somewhat better is running <tt>gmake TEST=sometest test</tt>, which runs
1079   the specified test and usually adds per-program summaries to the output
1080   (depending on which sometest you use). For example, the <tt>nightly</tt> test
1081   explicitely outputs TEST-PASS or TEST-FAIL for every test after each program.
1082   Though these lines are still drowned in the output, it's easy to grep the
1083   output logs in the Output directories.</p>
1084
1085   <p>Even better are the <tt>report</tt> and <tt>report.format</tt> targets
1086   (where <tt>format</tt> is one of <tt>html</tt>, <tt>csv</tt>, <tt>text</tt> or
1087   <tt>graphs</tt>). The exact contents of the report are dependent on which
1088   <tt>TEST</tt> you are running, but the text results are always shown at the
1089   end of the run and the results are always stored in the
1090   <tt>report.&lt;type&gt;.format</tt> file (when running with
1091   <tt>TEST=&lt;type&gt;</tt>).
1092
1093   The <tt>report</tt> also generate a file called
1094   <tt>report.&lt;type&gt;.raw.out</tt> containing the output of the entire test
1095   run.
1096 </div>
1097
1098 <!-- _______________________________________________________________________ -->
1099 <h3>
1100   <a name="testsuitecustom">Writing custom tests for the test suite</a>
1101 </h3>
1102 <!-- _______________________________________________________________________ -->
1103
1104 <div>
1105
1106 <p>Assuming you can run the test suite, (e.g. "<tt>gmake TEST=nightly report</tt>"
1107 should work), it is really easy to run optimizations or code generator
1108 components against every program in the tree, collecting statistics or running
1109 custom checks for correctness.  At base, this is how the nightly tester works,
1110 it's just one example of a general framework.</p>
1111
1112 <p>Lets say that you have an LLVM optimization pass, and you want to see how
1113 many times it triggers.  First thing you should do is add an LLVM
1114 <a href="ProgrammersManual.html#Statistic">statistic</a> to your pass, which
1115 will tally counts of things you care about.</p>
1116
1117 <p>Following this, you can set up a test and a report that collects these and
1118 formats them for easy viewing.  This consists of two files, a
1119 "<tt>test-suite/TEST.XXX.Makefile</tt>" fragment (where XXX is the name of your
1120 test) and a "<tt>test-suite/TEST.XXX.report</tt>" file that indicates how to
1121 format the output into a table.  There are many example reports of various
1122 levels of sophistication included with the test suite, and the framework is very
1123 general.</p>
1124
1125 <p>If you are interested in testing an optimization pass, check out the
1126 "libcalls" test as an example.  It can be run like this:<p>
1127
1128 <div class="doc_code">
1129 <pre>
1130 % cd llvm/projects/test-suite/MultiSource/Benchmarks  # or some other level
1131 % make TEST=libcalls report
1132 </pre>
1133 </div>
1134
1135 <p>This will do a bunch of stuff, then eventually print a table like this:</p>
1136
1137 <div class="doc_code">
1138 <pre>
1139 Name                                  | total | #exit |
1140 ...
1141 FreeBench/analyzer/analyzer           | 51    | 6     |
1142 FreeBench/fourinarow/fourinarow       | 1     | 1     |
1143 FreeBench/neural/neural               | 19    | 9     |
1144 FreeBench/pifft/pifft                 | 5     | 3     |
1145 MallocBench/cfrac/cfrac               | 1     | *     |
1146 MallocBench/espresso/espresso         | 52    | 12    |
1147 MallocBench/gs/gs                     | 4     | *     |
1148 Prolangs-C/TimberWolfMC/timberwolfmc  | 302   | *     |
1149 Prolangs-C/agrep/agrep                | 33    | 12    |
1150 Prolangs-C/allroots/allroots          | *     | *     |
1151 Prolangs-C/assembler/assembler        | 47    | *     |
1152 Prolangs-C/bison/mybison              | 74    | *     |
1153 ...
1154 </pre>
1155 </div>
1156
1157 <p>This basically is grepping the -stats output and displaying it in a table.
1158 You can also use the "TEST=libcalls report.html" target to get the table in HTML
1159 form, similarly for report.csv and report.tex.</p>
1160
1161 <p>The source for this is in test-suite/TEST.libcalls.*.  The format is pretty
1162 simple: the Makefile indicates how to run the test (in this case,
1163 "<tt>opt -simplify-libcalls -stats</tt>"), and the report contains one line for
1164 each column of the output.  The first value is the header for the column and the
1165 second is the regex to grep the output of the command for.  There are lots of
1166 example reports that can do fancy stuff.</p>
1167
1168 </div>
1169
1170 </div>
1171
1172 <!-- *********************************************************************** -->
1173
1174 <hr>
1175 <address>
1176   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
1177   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
1178   <a href="http://validator.w3.org/check/referer"><img
1179   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
1180
1181   John T. Criswell, Daniel Dunbar, Reid Spencer, and Tanya Lattner<br>
1182   <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br>
1183   Last modified: $Date$
1184 </address>
1185 </body>
1186 </html>