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