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 Test Suite Guide</title>
   6   <link rel="stylesheet" href="llvm.css" type="text/css">
   7 </head>
   8 <body>
   9
  10 <div class="doc_title">
  11   LLVM Test Suite 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="#quick">Quick Start</a></li>
  18   <li><a href="#org">LLVM Test Suite Organization</a>
  19     <ul>
  20       <li><a href="#codefragments">Code Fragments</a></li>
  21       <li><a href="#wholeprograms">Whole Programs</a></li>
  22     </ul>
  23   </li>
  24   <li><a href="#tree">LLVM Test Suite Tree</a></li>
  25   <li><a href="#dgstructure">DejaGNU Structure</a></li>
  26   <li><a href="#progstructure"><tt>llvm-test</tt> Structure</a></li>
  27   <li><a href="#run">Running the LLVM Tests</a>
  28     <ul>
  29       <li><a href="#customtest">Writing custom tests for llvm-test</a></li>
  30     </ul>
  31   </li>
  32   <li><a href="#nightly">Running the nightly tester</a></li>
  33 </ol>
  34
  35 <div class="doc_author">
  36   <p>Written by John T. Criswell, <a
  37   href="http://llvm.x10sys.com/rspencer">Reid Spencer</a>, and Tanya Lattner</p>
  38 </div>
  39
  40 <!--=========================================================================-->
  41 <div class="doc_section"><a name="overview">Overview</a></div>
  42 <!--=========================================================================-->
  43
  44 <div class="doc_text">
  45
  46 <p>This document is the reference manual for the LLVM test suite.  It documents
  47 the structure of the LLVM test suite, the tools needed to use it, and how to add
  48 and run tests.</p>
  49
  50 </div>
  51
  52 <!--=========================================================================-->
  53 <div class="doc_section"><a name="Requirements">Requirements</a></div>
  54 <!--=========================================================================-->
  55
  56 <div class="doc_text">
  57
  58 <p>In order to use the LLVM test suite, you will need all of the software
  59 required to build LLVM, plus the following:</p>
  60
  61 <dl>
  62 <dt><a href="http://www.gnu.org/software/dejagnu/">DejaGNU</a></dt>
  63 <dd>The Feature and Regressions tests are organized and run by DejaGNU.</dd>
  64 <dt><a href="http://expect.nist.gov/">Expect</a></dt>
  65 <dd>Expect is required by DejaGNU.</dd>
  66 <dt><a href="http://www.tcl.tk/software/tcltk/">tcl</a></dt>
  67 <dd>Tcl is required by DejaGNU. </dd>
  68
  69 <dt><a href="http://www.netlib.org/f2c">F2C</a></dt>
  70 <dd>For now, LLVM does not have a Fortran front-end, but using F2C, we can run
  71 Fortran benchmarks.  F2C support must be enabled via <tt>configure</tt> if not
  72 installed in a standard place.  F2C requires three items: the <tt>f2c</tt>
  73 executable, <tt>f2c.h</tt> to compile the generated code, and <tt>libf2c.a</tt>
  74 to link generated code.  By default, given an F2C directory <tt>$DIR</tt>, the
  75 configure script will search <tt>$DIR/bin</tt> for <tt>f2c</tt>,
  76 <tt>$DIR/include</tt> for <tt>f2c.h</tt>, and <tt>$DIR/lib</tt> for
  77 <tt>libf2c.a</tt>.  The default <tt>$DIR</tt> values are: <tt>/usr</tt>,
  78 <tt>/usr/local</tt>, <tt>/sw</tt>, and <tt>/opt</tt>.  If you installed F2C in a
  79 different location, you must tell <tt>configure</tt>:
  80
  81 <ul>
  82 <li><tt>./configure --with-f2c=$DIR</tt><br>
  83 This will specify a new <tt>$DIR</tt> for the above-described search
  84 process.  This will only work if the binary, header, and library are in their
  85 respective subdirectories of <tt>$DIR</tt>.</li>
  86
  87 <li><tt>./configure --with-f2c-bin=/binary/path --with-f2c-inc=/include/path
  88 --with-f2c-lib=/lib/path</tt><br>
  89 This allows you to specify the F2C components separately.  Note: if you choose
  90 this route, you MUST specify all three components, and you need to only specify
  91 <em>directories</em> where the files are located; do NOT include the
  92 filenames themselves on the <tt>configure</tt> line.</li>
  93 </ul></dd>
  94 </dl>
  95
  96 <p>Darwin (Mac OS X) developers can simplify the installation of Expect and tcl
  97 by using fink.  <tt>fink install expect</tt> will install both. Alternatively,
  98 Darwinports users can use <tt>sudo port install expect</tt> to install Expect
  99 and tcl.</p>
 100
 101 </div>
 102
 103 <!--=========================================================================-->
 104 <div class="doc_section"><a name="quick">Quick Start</a></div>
 105 <!--=========================================================================-->
 106
 107 <div class="doc_text">
 108
 109 <p>The tests are located in two separate CVS modules. The basic feature and
 110 regression tests are in the main "llvm" module under the directory
 111 <tt>llvm/test</tt>. A more comprehensive test suite that includes whole
 112 programs in C and C++ is in the <tt>llvm-test</tt> module. This module should
 113 be checked out to the <tt>llvm/projects</tt> directory. When you
 114 <tt>configure</tt> the <tt>llvm</tt> module, the <tt>llvm-test</tt> module
 115 will be automatically configured. Alternatively, you can configure the
 116  <tt>llvm-test</tt> module manually.</p>
 117 <p>To run all of the simple tests in LLVM using DejaGNU, use the master Makefile
 118  in the <tt>llvm/test</tt> directory:</p>
 119 <pre>
 120 % gmake -C llvm/test
 121 </pre>
 122 or<br>
 123 <pre>
 124 % gmake check
 125 </pre>
 126
 127 <p>To run only a subdirectory of tests in llvm/test using DejaGNU (ie.
 128 Regression/Transforms), just set the TESTSUITE variable to the path of the
 129 subdirectory (relative to <tt>llvm/test</tt>):</p>
 130 <pre>
 131 % gmake -C llvm/test TESTSUITE=Regression/Transforms
 132 </pre>
 133
 134 <p><b>Note: If you are running the tests with <tt>objdir != subdir</tt>, you
 135 must have run the complete testsuite before you can specify a
 136 subdirectory.</b></p>
 137
 138 <p>To run the comprehensive test suite (tests that compile and execute whole
 139 programs), run the <tt>llvm-test</tt> tests:</p>
 140
 141 <pre>
 142 % cd llvm/projects
 143 % cvs co llvm-test
 144 % cd llvm-test
 145 % ./configure --with-llvmsrc=$LLVM_SRC_ROOT --with-llvmobj=$LLVM_OBJ_ROOT
 146 % gmake
 147 </pre>
 148
 149 </div>
 150
 151 <!--=========================================================================-->
 152 <div class="doc_section"><a name="org">LLVM Test Suite Organization</a></div>
 153 <!--=========================================================================-->
 154
 155 <div class="doc_text">
 156
 157 <p>The LLVM test suite contains two major categories of tests: code
 158 fragments and whole programs. Code fragments are in the <tt>llvm</tt> module
 159 under the <tt>llvm/test</tt> directory. The whole programs
 160 test suite is in the <tt>llvm-test</tt> module under the main directory.</p>
 161
 162 </div>
 163
 164 <!-- _______________________________________________________________________ -->
 165 <div class="doc_subsection"><a name="codefragments">Code Fragments</a></div>
 166 <!-- _______________________________________________________________________ -->
 167
 168 <div class="doc_text">
 169
 170 <p>Code fragments are small pieces of code that test a specific feature of LLVM
 171 or trigger a specific bug in LLVM.  They are usually written in LLVM assembly
 172 language, but can be written in other languages if the test targets a particular
 173 language front end.</p>
 174
 175 <p>Code fragments are not complete programs, and they are never executed to
 176 determine correct behavior.</p>
 177
 178 <p>These code fragment tests are located in the <tt>llvm/test/Features</tt> and
 179 <tt>llvm/test/Regression</tt> directories.</p>
 180
 181 </div>
 182
 183 <!-- _______________________________________________________________________ -->
 184 <div class="doc_subsection"><a name="wholeprograms">Whole Programs</a></div>
 185 <!-- _______________________________________________________________________ -->
 186
 187 <div class="doc_text">
 188
 189 <p>Whole Programs are pieces of code which can be compiled and linked into a
 190 stand-alone program that can be executed.  These programs are generally written
 191 in high level languages such as C or C++, but sometimes they are written
 192 straight in LLVM assembly.</p>
 193
 194 <p>These programs are compiled and then executed using several different
 195 methods (native compiler, LLVM C backend, LLVM JIT, LLVM native code generation,
 196 etc).  The output of these programs is compared to ensure that LLVM is compiling
 197 the program correctly.</p>
 198
 199 <p>In addition to compiling and executing programs, whole program tests serve as
 200 a way of benchmarking LLVM performance, both in terms of the efficiency of the
 201 programs generated as well as the speed with which LLVM compiles, optimizes, and
 202 generates code.</p>
 203
 204 <p>All "whole program" tests are located in the <tt>llvm-test</tt> CVS
 205 module.</p>
 206
 207 </div>
 208
 209 <!--=========================================================================-->
 210 <div class="doc_section"><a name="tree">LLVM Test Suite Tree</a></div>
 211 <!--=========================================================================-->
 212
 213 <div class="doc_text">
 214
 215 <p>Each type of test in the LLVM test suite has its own directory. The major
 216 subtrees of the test suite directory tree are as follows:</p>
 217
 218 <ul>
 219   <li><tt>llvm/test</tt>
 220   <p>This directory contains a large array of small tests
 221   that exercise various features of LLVM and to ensure that regressions do not
 222   occur. The directory is broken into several sub-directories, each focused on
 223   a particular area of LLVM. A few of the important ones are:<ul>
 224     <li><tt>Analysis</tt>: checks Analysis passes.</li>
 225     <li><tt>Archive</tt>: checks the Archive library.</li>
 226     <li><tt>Assembler</tt>: checks Assembly reader/writer functionality.</li>
 227     <li><tt>Bytecode</tt>: checks Bytecode reader/writer functionality.</li>
 228     <li><tt>CodeGen</tt>: checks code generation and each target.</li>
 229     <li><tt>Features</tt>: checks various features of the LLVM language.</li>
 230     <li><tt>Linker</tt>: tests bytecode linking.</li>
 231     <li><tt>Transforms</tt>: tests each of the scalar, IPO, and utility
 232     transforms to ensure they make the right transformations.</li>
 233     <li><tt>Verifier</tt>: tests the IR verifier.</li>
 234   </ul></p>
 235   <p>Typically when a bug is found in LLVM, a regression test containing
 236   just enough code to reproduce the problem should be written and placed
 237   somewhere underneath this directory.  In most cases, this will be a small
 238   piece of LLVM assembly language code, often distilled from an actual
 239   application or benchmark.</p></li>
 240
 241 <li><tt>llvm-test</tt>
 242 <p>The <tt>llvm-test</tt> CVS module contains programs that can be compiled
 243 with LLVM and executed.  These programs are compiled using the native compiler
 244 and various LLVM backends.  The output from the program compiled with the
 245 native compiler is assumed correct; the results from the other programs are
 246 compared to the native program output and pass if they match.</p>
 247
 248 <p>In addition for testing correctness, the <tt>llvm-test</tt> directory also
 249 performs timing tests of various LLVM optimizations.  It also records
 250 compilation times for the compilers and the JIT.  This information can be
 251 used to compare the effectiveness of LLVM's optimizations and code
 252 generation.</p></li>
 253
 254 <li><tt>llvm-test/SingleSource</tt>
 255 <p>The SingleSource directory contains test programs that are only a single
 256 source file in size.  These are usually small benchmark programs or small
 257 programs that calculate a particular value.  Several such programs are grouped
 258 together in each directory.</p></li>
 259
 260 <li><tt>llvm-test/MultiSource</tt>
 261 <p>The MultiSource directory contains subdirectories which contain entire
 262 programs with multiple source files.  Large benchmarks and whole applications
 263 go here.</p></li>
 264
 265 <li><tt>llvm-test/External</tt>
 266 <p>The External directory contains Makefiles for building code that is external
 267 to (i.e., not distributed with) LLVM.  The most prominent members of this
 268 directory are the SPEC 95 and SPEC 2000 benchmark suites.  The presence and
 269 location of these external programs is configured by the llvm-test
 270 <tt>configure</tt> script.</p></li>
 271
 272 </ul>
 273
 274 </div>
 275 <!--=========================================================================-->
 276 <div class="doc_section"><a name="dgstructure">DejaGNU Structure</a></div>
 277 <!--=========================================================================-->
 278 <div class="doc_text">
 279   <p>The LLVM test suite is partially driven by DejaGNU and partially driven by
 280   GNU Make. Specifically, the Features and Regression tests are all driven by
 281   DejaGNU. The <tt>llvm-test</tt> module is currently driven by a set of
 282   Makefiles.</p>
 283
 284   <p>The DejaGNU structure is very simple, but does require some information to
 285   be set. This information is gathered via <tt>configure</tt> and is written
 286   to a file, <tt>site.exp</tt> in <tt>llvm/test</tt>. The <tt>llvm/test</tt>
 287   Makefile does this work for you.</p>
 288
 289   <p>In order for DejaGNU to work, each directory of tests must have a
 290   <tt>dg.exp</tt> file. DejaGNU looks for this file to determine how to run the
 291   tests. This file is just a Tcl script and it can do anything you want, but
 292   we've standardized it for the LLVM regression tests. It simply loads a Tcl
 293   library (<tt>test/lib/llvm.exp</tt>) and calls the <tt>llvm_runtests</tt>
 294   function defined in that library with a list of file names to run. The names
 295   are obtained by using Tcl's glob command.  Any directory that contains only
 296   directories does not need the <tt>dg.exp</tt> file.</p>
 297
 298   <p>The <tt>llvm-runtests</tt> function lookas at each file that is passed to
 299   it and gathers any lines together that match "RUN:". This are the "RUN" lines
 300   that specify how the test is to be run. So, each test script must contain
 301   RUN lines if it is to do anything. If there are no RUN lines, the
 302   <tt>llvm-runtests</tt> function will issue an error and the test will
 303   fail.</p>
 304
 305   <p>RUN lines are specified in the comments of the test program using the
 306   keyword <tt>RUN</tt> followed by a colon, and lastly the command (pipeline)
 307   to execute.  Together, these lines form the "script" that
 308   <tt>llvm-runtests</tt> executes to run the test case.  The syntax of the
 309   RUN lines is similar to a shell's syntax for pipelines including I/O
 310   redirection and variable substitution.  However, even though these lines
 311   may <i>look</i> like a shell script, they are not. RUN lines are interpreted
 312   directly by the Tcl <tt>exec</tt> command. They are never executed by a
 313   shell. Consequently the syntax differs from normal shell script syntax in a
 314   few ways.  You can specify as many RUN lines as needed.</p>
 315
 316   <p>Each RUN line is executed on its own, distinct from other lines unless
 317   its last character is <tt>\</tt>. This continuation character causes the RUN
 318   line to be concatenated with the next one. In this way you can build up long
 319   pipelines of commands without making huge line lengths. The lines ending in
 320   <tt>\</tt> are concatenated until a RUN line that doesn't end in <tt>\</tt> is
 321   found. This concatenated set or RUN lines then constitutes one execution.
 322   Tcl will substitute variables and arrange for the pipeline to be executed. If
 323   any process in the pipeline fails, the entire line (and test case) fails too.
 324   </p>
 325
 326   <p>As with a Unix shell, the RUN: lines permit pipelines and I/O redirection
 327   to be used. However, the usage is slightly different than for Bash. To check
 328   what's legal, see the documentation for the
 329   <a href="http://www.tcl.tk/man/tcl8.5/TclCmd/exec.htm#M2">Tcl exec</a>
 330   command and the
 331   <a href="http://www.tcl.tk/man/tcl8.5/tutorial/Tcl26.html">tutorial</a>.
 332   The major differences are:</p>
 333   <ul>
 334     <li>You can't do <tt>2&gt;&amp;1</tt>. That will cause Tcl to write to a
 335     file named <tt>&amp;1</tt>. Usually this is done to get stderr to go through
 336     a pipe. You can do that in tcl with <tt>|&amp;</tt> so replace this idiom:
 337     <tt>... 2&gt;&amp;1 | grep</tt> with <tt>... |&amp; grep</tt></li>
 338     <li>You can only redirect to a file, not to another descriptor and not from
 339     a here document.</li>
 340     <li>tcl supports redirecting to open files with the @ syntax but you
 341     shouldn't use that here.</li>
 342   </ul>
 343
 344   <p> Below is an example of legal RUN lines in a <tt>.ll</tt> file:</p>
 345   <pre>
 346   ; RUN: llvm-as &lt; %s | llvm-dis &gt; %t1
 347   ; RUN: llvm-dis &lt; %s.bc-13 &gt; %t2
 348   ; RUN: diff %t1 %t2
 349   </pre>
 350 </div>
 351
 352 <!-- _______________________________________________________________________ -->
 353 <div class="doc_subsection"><a name="dgvars">Vars And Substitutions</a></div>
 354 <div class="doc_text">
 355   <p>With a RUN line there are a number of substitutions that are permitted. In
 356   general, any Tcl variable that is available in the <tt>substitute</tt>
 357   function (in <tt>test/lib/llvm.exp</tt>) can be substituted into a RUN line.
 358   To make a substitution just write the variable's name preceded by a $.
 359   Additionally, for compatibility reasons with previous versions of the test
 360   library, certain names can be accessed with an alternate syntax: a % prefix.
 361   These alternates are deprecated and may go away in a future version.
 362   </p>
 363   Here are the available variable names. The alternate syntax is listed in
 364   parentheses.</p>
 365   <dl style="margin-left: 25px">
 366     <dt><b>$test</b> (%s)</dt>
 367     <dd>The full path to the test case's source. This is suitable for passing
 368     on the command line as the input to an llvm tool.</dd>
 369     <dt><b>$srcdir</b></dt>
 370     <dd>The source directory from where the "<tt>make check</tt>" was run.</dd>
 371     <dt><b>objdir</b></dt>
 372     <dd>The object directory that corresponds to the </tt>$srcdir</tt>.</dd>
 373     <dt><b>subdir</b></dt>
 374     <dd>A partial path from the <tt>test</tt> directory that contains the
 375     sub-directory that contains the test source being executed.</dd>
 376     <dt><b>srcroot</b></dt>
 377     <dd>The root directory of the LLVM src tree.</dd>
 378     <dt><b>objroot</b></dt>
 379     <dd>The root directory of the LLVM object tree. This could be the same
 380     as the srcroot.</dd>
 381     <dt><b>path</b><dt>
 382     <dd>The path to the directory that contains the test case source.  This is
 383     for locating any supporting files that are not generated by the test, but
 384     used by the test.</dd>
 385     <dt><b>tmp</b></dt>
 386     <dd>The path to a temporary file name that could be used for this test case.
 387     The file name won't conflict with other test cases. You can append to it if
 388     you need multiple temporaries. This is useful as the destination of some
 389     redirected output.</dd>
 390     <dt><b>llvmlibsdir</b> (%llvmlibsdir)</dt>
 391     <dd>The directory where the LLVM libraries are located.</dd>
 392     <dt><b>target_triplet</b> (%target_triplet)</dt>
 393     <dd>The target triplet that corresponds to the current host machine (the one
 394     running the test cases). This should probably be called "host".<dd>
 395     <dt><b>prcontext</b> (%prcontext)</dt>
 396     <dd>Path to the prcontext tcl script that prints some context around a
 397     line that matches a pattern. This isn't strictly necessary as the test suite
 398     is run with its PATH altered to include the test/Scripts directory where
 399     the prcontext script is located. Note that this script is similar to
 400     <tt>grep -C</tt> but you should use the <tt>prcontext</tt> script because
 401     not all platforms support <tt>grep -C</tt>.</dd>
 402     <dt><b>llvmgcc</b> (%llvmgcc)</dt>
 403     <dd>The full path to the <tt>llvm-gcc</tt> executable as specified in the
 404     configured LLVM environment</dd>
 405     <dt><b>llvmgxx</b> (%llvmgxx)</dt>
 406     <dd>The full path to the <tt>llvm-gxx</tt> executable as specified in the
 407     configured LLVM environment</dd>
 408     <dt><b>llvmgcc_version</b> (%llvmgcc_version)</dt>
 409     <dd>The full version number of the <tt>llvm-gcc</tt> executable.</dd>
 410     <dt><b>llvmgccmajvers</b> (%llvmgccmajvers)</dt>
 411     <dd>The major version number of the <tt>llvm-gcc</tt> executable.</dd>
 412     <dt><b>gccpath</b></dt>
 413     <dd>The full path to the C compiler used to <i>build </i> LLVM. Note that
 414     this might not be gcc.</dd>
 415     <dt><b>gxxpath</b></dt>
 416     <dd>The full path to the C++ compiler used to <i>build </i> LLVM. Note that
 417     this might not be g++.</dd>
 418     <dt><b>compile_c</b> (%compile_c)</dt>
 419     <dd>The full command line used to compile LLVM C source  code. This has all
 420     the configured -I, -D and optimization options.</dd>
 421     <dt><b>compile_cxx</b> (%compile_cxx)</dt>
 422     <dd>The full command used to compile LLVM C++ source  code. This has
 423     all the configured -I, -D and optimization options.</dd>
 424     <dt><b>link</b> (%link)</dt>
 425     <dd>This full link command used to link LLVM executables. This has all the
 426     configured -I, -L and -l options.</dd>
 427     <dt><b>shlibext</b> (%shlibext)</dt>
 428     <dd>The suffix for the host platforms share library (dll) files. This
 429     includes the period as the first character.</dd>
 430   </dl>
 431   <p>To add more variables, two things need to be changed. First, add a line in
 432   the <tt>test/Makefile</tt> that creates the <tt>site.exp</tt> file. This will
 433   "set" the variable as a global in the site.exp file. Second, in the
 434   <tt>test/lib/llvm.exp</tt> file, in the substitute proc, add the variable name
 435   to the list of "global" declarations at the beginning of the proc. That's it,
 436   the variable can then be used in test scripts.</p>
 437 </div>
 438
 439 <!-- _______________________________________________________________________ -->
 440 <div class="doc_subsection"><a name="dgfeatures">Other Features</a></div>
 441 <div class="doc_text">
 442   <p>To make RUN line writing easier, there are several shell scripts located
 443   in the <tt>llvm/test/Scripts</tt> directory. For example:</p>
 444   <dl>
 445     <dt><b>ignore</b></dt>
 446     <dd>This script runs its arguments and then always returns 0. This is useful
 447     in cases where the test needs to cause a tool to generate an error (e.g. to
 448     check the error output). However, any program in a pipeline that returns a
 449     non-zero result will cause the test to fail. This script overcomes that
 450     issue and nicely documents that the test case is purposefully ignoring the
 451     result code of the tool</dd>
 452     <dt><b>not</b></dt>
 453     <dd>This script runs its arguments and then inverts the result code from
 454     it. Zero result codes become 1. Non-zero result codes become 0. This is
 455     useful to invert the result of a grep. For example "not grep X" means
 456     succeed only if you don't find X in the input.</dd>
 457   </dl>
 458
 459   <p>Sometimes it is necessary to mark a test case as "expected fail" or XFAIL.
 460   You can easily mark a test as XFAIL just by including  <tt>XFAIL: </tt> on a
 461   line near the top of the file. This signals that the test case should succeed
 462   if the test fails. Such test cases are counted separately by DejaGnu. To
 463   specify an expected fail, use the XFAIL keyword in the comments of the test
 464   program followed by a colon and one or more regular expressions (separated by
 465   a comma). The regular expressions allow you to XFAIL the test conditionally
 466   by host platform. The regular expressions following the : are matched against
 467   the target triplet or llvmgcc version number for the host machine. If there is
 468   a match, the test is expected to fail. If not, the test is expected to
 469   succeed. To XFAIL everywhere just specify <tt>XFAIL: *</tt>. When matching
 470   the llvm-gcc version, you can specify the major (e.g. 3) or full version
 471   (i.e. 3.4) number. Here is an example of an <tt>XFAIL</tt> line:</p>
 472   <pre>
 473    ; XFAIL: darwin,sun,llvmgcc4
 474   </pre>
 475
 476   <p>To make the output more useful, the <tt>llvm_runtest</tt> function wil
 477   scan the lines of the test case for ones that contain a pattern that matches
 478   PR[0-9]+. This is the syntax for specifying a PR (Problem Report) number that
 479   is related to the test case. The numer after "PR" specifies the LLVM bugzilla
 480   number. When a PR number is specified, it will be used in the pass/fail
 481   reporting. This is useful to quickly get some context when a test fails.</p>
 482
 483   <p>Finally, any line that contains "END." will cause the special
 484   interpretation of lines to terminate. This is generally done right after the
 485   last RUN: line. This has two side effects: (a) it prevents special
 486   interpretation of lines that are part of the test program, not the
 487   instructions to the test case, and (b) it speeds things up for really big test
 488   cases by avoiding interpretation of the remainder of the file.</p>
 489
 490 </div>
 491
 492 <!--=========================================================================-->
 493 <div class="doc_section"><a name="progstructure"><tt>llvm-test</tt>
 494 Structure</a></div>
 495 <!--=========================================================================-->
 496
 497 <div class="doc_text">
 498
 499 <p>As mentioned previously, the <tt>llvm-test</tt> module  provides three types
 500 of tests: MultiSource, SingleSource, and External.  Each tree is then subdivided
 501 into several categories, including applications, benchmarks, regression tests,
 502 code that is strange grammatically, etc.  These organizations should be
 503 relatively self explanatory.</p>
 504
 505 <p>In addition to the regular "whole program"  tests, the <tt>llvm-test</tt>
 506 module also provides a mechanism for compiling the programs in different ways.
 507 If the variable TEST is defined on the gmake command line, the test system will
 508 include a Makefile named <tt>TEST.&lt;value of TEST variable&gt;.Makefile</tt>.
 509 This Makefile can modify build rules to yield different results.</p>
 510
 511 <p>For example, the LLVM nightly tester uses <tt>TEST.nightly.Makefile</tt> to
 512 create the nightly test reports.  To run the nightly tests, run <tt>gmake
 513 TEST=nightly</tt>.</p>
 514
 515 <p>There are several TEST Makefiles available in the tree.  Some of them are
 516 designed for internal LLVM research and will not work outside of the LLVM
 517 research group.  They may still be valuable, however, as a guide to writing your
 518 own TEST Makefile for any optimization or analysis passes that you develop with
 519 LLVM.</p>
 520
 521 <p>Note, when configuring the <tt>llvm-test</tt> module, you might want to
 522 specify the following configuration options:</p>
 523 <dl>
 524   <dt><i>--enable-spec2000</i>
 525   <dt><i>--enable-spec2000=&lt;<tt>directory</tt>&gt;</i>
 526   <dd>
 527     Enable the use of SPEC2000 when testing LLVM.  This is disabled by default
 528     (unless <tt>configure</tt> finds SPEC2000 installed).  By specifying
 529     <tt>directory</tt>, you can tell configure where to find the SPEC2000
 530     benchmarks.  If <tt>directory</tt> is left unspecified, <tt>configure</tt>
 531     uses the default value
 532     <tt>/home/vadve/shared/benchmarks/speccpu2000/benchspec</tt>.
 533     <p>
 534   <dt><i>--enable-spec95</i>
 535   <dt><i>--enable-spec95=&lt;<tt>directory</tt>&gt;</i>
 536   <dd>
 537     Enable the use of SPEC95 when testing LLVM.  It is similar to the
 538     <i>--enable-spec2000</i> option.
 539     <p>
 540   <dt><i>--enable-povray</i>
 541   <dt><i>--enable-povray=&lt;<tt>directory</tt>&gt;</i>
 542   <dd>
 543     Enable the use of Povray as an external test.  Versions of Povray written
 544     in C should work.  This option is similar to the <i>--enable-spec2000</i>
 545     option.
 546 </dl>
 547 </div>
 548
 549 <!--=========================================================================-->
 550 <div class="doc_section"><a name="run">Running the LLVM Tests</a></div>
 551 <!--=========================================================================-->
 552
 553 <div class="doc_text">
 554
 555 <p>First, all tests are executed within the LLVM object directory tree.  They
 556 <i>are not</i> executed inside of the LLVM source tree. This is because the
 557 test suite creates temporary files during execution.</p>
 558
 559 <p>The master Makefile in llvm/test is capable of running only the DejaGNU
 560 driven tests. By default, it will run all of these tests.</p>
 561
 562 <p>To run only the DejaGNU driven tests, run <tt>gmake</tt> at the
 563 command line in <tt>llvm/test</tt>.  To run a specific directory of tests, use
 564 the TESTSUITE variable.
 565 </p>
 566
 567 <p>For example, to run the Regression tests, type
 568 <tt>gmake TESTSUITE=Regression</tt> in <tt>llvm/tests</tt>.</p>
 569
 570 <p>Note that there are no Makefiles in <tt>llvm/test/Features</tt> and
 571 <tt>llvm/test/Regression</tt>. You must use DejaGNU from the <tt>llvm/test</tt>
 572 directory to run them.</p>
 573
 574 <p>To run the <tt>llvm-test</tt> suite, you need to use the following steps:
 575 </p>
 576 <ol>
 577   <li>cd into the llvm/projects directory</li>
 578   <li>check out the <tt>llvm-test</tt> module with:<br/>
 579   <tt>cvs -d :pserver:anon@llvm.org:/var/cvs/llvm co -PR llvm-test</tt><br>
 580   This will get the test suite into <tt>llvm/projects/llvm-test</tt></li>
 581   <li>configure the test suite. You can do this one of two ways:
 582   <ol>
 583     <li>Use the regular llvm configure:<br/>
 584     <tt>cd $LLVM_OBJ_ROOT ; $LLVM_SRC_ROOT/configure</tt><br/>
 585     This will ensure that the <tt>projects/llvm-test</tt> directory is also
 586     properly configured.</li>
 587     <li>Use the <tt>configure</tt> script found in the <tt>llvm-test</tt> source
 588     directory:<br/>
 589     <tt>$LLVM_SRC_ROOT/projects/llvm-test/configure
 590      --with-llvmsrc=$LLVM_SRC_ROOT --with-llvmobj=$LLVM_OBJ_ROOT</tt>
 591     </li>
 592   </ol>
 593   <li>gmake</li>
 594 </ol>
 595 <p>Note that the second and third steps only need to be done once. After you
 596 have the suite checked out and configured, you don't need to do it again (unless
 597 the test code or configure script changes).</p>
 598
 599 <p>To make a specialized test (use one of the
 600 <tt>llvm-test/TEST.&lt;type&gt;.Makefile</tt>s), just run:<br/>
 601 <tt>gmake TEST=&lt;type&gt; test</tt><br/>For example, you could run the
 602 nightly tester tests using the following commands:</p>
 603
 604 <pre>
 605  % cd llvm/projects/llvm-test
 606  % gmake TEST=nightly test
 607 </pre>
 608
 609 <p>Regardless of which test you're running, the results are printed on standard
 610 output and standard error.  You can redirect these results to a file if you
 611 choose.</p>
 612
 613 <p>Some tests are known to fail.  Some are bugs that we have not fixed yet;
 614 others are features that we haven't added yet (or may never add).  In DejaGNU,
 615 the result for such tests will be XFAIL (eXpected FAILure).  In this way, you
 616 can tell the difference between an expected and unexpected failure.</p>
 617
 618 <p>The tests in <tt>llvm-test</tt> have no such feature at this time. If the
 619 test passes, only warnings and other miscellaneous output will be generated.  If
 620 a test fails, a large &lt;program&gt; FAILED message will be displayed.  This
 621 will help you separate benign warnings from actual test failures.</p>
 622
 623 </div>
 624
 625 <!-- _______________________________________________________________________ -->
 626 <div class="doc_subsection">
 627 <a name="customtest">Writing custom tests for llvm-test</a></div>
 628 <!-- _______________________________________________________________________ -->
 629
 630 <div class="doc_text">
 631
 632 <p>Assuming you can run llvm-test, (e.g. "<tt>gmake TEST=nightly report</tt>"
 633 should work), it is really easy to run optimizations or code generator
 634 components against every program in the tree, collecting statistics or running
 635 custom checks for correctness.  At base, this is how the nightly tester works,
 636 it's just one example of a general framework.</p>
 637
 638 <p>Lets say that you have an LLVM optimization pass, and you want to see how
 639 many times it triggers.  First thing you should do is add an LLVM
 640 <a href="ProgrammersManual.html#Statistic">statistic</a> to your pass, which
 641 will tally counts of things you care about.</p>
 642
 643 <p>Following this, you can set up a test and a report that collects these and
 644 formats them for easy viewing.  This consists of two files, an
 645 "<tt>llvm-test/TEST.XXX.Makefile</tt>" fragment (where XXX is the name of your
 646 test) and an "<tt>llvm-test/TEST.XXX.report</tt>" file that indicates how to
 647 format the output into a table.  There are many example reports of various
 648 levels of sophistication included with llvm-test, and the framework is very
 649 general.</p>
 650
 651 <p>If you are interested in testing an optimization pass, check out the
 652 "libcalls" test as an example.  It can be run like this:<p>
 653
 654 <div class="doc_code">
 655 <pre>
 656 % cd llvm/projects/llvm-test/MultiSource/Benchmarks  # or some other level
 657 % make TEST=libcalls report
 658 </pre>
 659 </div>
 660
 661 <p>This will do a bunch of stuff, then eventually print a table like this:</p>
 662
 663 <div class="doc_code">
 664 <pre>
 665 Name                                  | total | #exit |
 666 ...
 667 FreeBench/analyzer/analyzer           | 51    | 6     |
 668 FreeBench/fourinarow/fourinarow       | 1     | 1     |
 669 FreeBench/neural/neural               | 19    | 9     |
 670 FreeBench/pifft/pifft                 | 5     | 3     |
 671 MallocBench/cfrac/cfrac               | 1     | *     |
 672 MallocBench/espresso/espresso         | 52    | 12    |
 673 MallocBench/gs/gs                     | 4     | *     |
 674 Prolangs-C/TimberWolfMC/timberwolfmc  | 302   | *     |
 675 Prolangs-C/agrep/agrep                | 33    | 12    |
 676 Prolangs-C/allroots/allroots          | *     | *     |
 677 Prolangs-C/assembler/assembler        | 47    | *     |
 678 Prolangs-C/bison/mybison              | 74    | *     |
 679 ...
 680 </pre>
 681 </div>
 682
 683 <p>This basically is grepping the -stats output and displaying it in a table.
 684 You can also use the "TEST=libcalls report.html" target to get the table in HTML
 685 form, similarly for report.csv and report.tex.</p>
 686
 687 <p>The source for this is in llvm-test/TEST.libcalls.*.  The format is pretty
 688 simple: the Makefile indicates how to run the test (in this case,
 689 "<tt>opt -simplify-libcalls -stats</tt>"), and the report contains one line for
 690 each column of the output.  The first value is the header for the column and the
 691 second is the regex to grep the output of the command for.  There are lots of
 692 example reports that can do fancy stuff.</p>
 693
 694 </div>
 695
 696
 697 <!--=========================================================================-->
 698 <div class="doc_section"><a name="nightly">Running the nightly tester</a></div>
 699 <!--=========================================================================-->
 700
 701 <div class="doc_text">
 702
 703 <p>
 704 The <a href="http://llvm.org/nightlytest/">LLVM Nightly Testers</a>
 705 automatically check out an LLVM tree, build it, run the "nightly"
 706 program test (described above), run all of the feature and regression tests,
 707 delete the checked out tree, and then submit the results to
 708 <a href="http://llvm.org/nightlytest/">http://llvm.org/nightlytest/</a>.
 709 After test results are submitted to
 710 <a href="http://llvm.org/nightlytest/">http://llvm.org/nightlytest/</a>,
 711 they are processed and displayed on the tests page. An email to
 712 <a href="http://lists.cs.uiuc.edu/pipermail/llvm-testresults/">
 713 llvm-testresults@cs.uiuc.edu</a> summarizing the results is also generated.
 714 This testing scheme is designed to ensure that programs don't break as well
 715 as keep track of LLVM's progress over time.</p>
 716
 717 <p>If you'd like to set up an instance of the nightly tester to run on your
 718 machine, take a look at the comments at the top of the
 719 <tt>utils/NewNightlyTest.pl</tt> file. If you decide to set up a nightly tester
 720 please choose a unique nickname and invoke <tt>utils/NewNightlyTest.pl</tt>
 721 with the "-nickname [yournickname]" command line option. We usually run it
 722 from a crontab entry that looks like this:</p>
 723
 724 <div class="doc_code">
 725 <pre>
 726 5 3 * * *  $HOME/llvm/utils/NewNightlyTest.pl -parallel -nickname Nickname \
 727            $CVSROOT $HOME/buildtest $HOME/cvs/testresults
 728 </pre>
 729 </div>
 730
 731 <p>Or, you can create a shell script to encapsulate the running of the script.
 732 The optimized x86 Linux nightly test is run from just such a script:</p>
 733
 734 <div class="doc_code">
 735 <pre>
 736 #!/bin/bash
 737 BASE=/proj/work/llvm/nightlytest
 738 export CVSROOT=:pserver:anon@llvm.org:/var/cvs/llvm
 739 export BUILDDIR=$BASE/build
 740 export WEBDIR=$BASE/testresults
 741 export LLVMGCCDIR=/proj/work/llvm/cfrontend/install
 742 export PATH=/proj/install/bin:$LLVMGCCDIR/bin:$PATH
 743 export LD_LIBRARY_PATH=/proj/install/lib
 744 cd $BASE
 745 cp /proj/work/llvm/llvm/utils/NewNightlyTest.pl .
 746 nice ./NewNightlyTest.pl -nice -release -verbose -parallel -enable-linscan \
 747    -nickname NightlyTester -noexternals 2&gt;&amp;1 &gt; output.log
 748 </pre>
 749 </div>
 750
 751 <p>It is also possible to specify the the location your nightly test results
 752 are submitted. You can do this by passing the command line option
 753 "-submit-server [server_address]" and "-submit-script [script_on_server]" to
 754 <tt>utils/NewNightlyTest.pl</tt>. For example, to submit to the llvm.org
 755 nightly test results page, you would invoke the nightly test script with
 756 "-submit-server llvm.org -submit-script /nightlytest/NightlyTestAccept.cgi".
 757 If these options are not specified, the nightly test script sends the results
 758 to the llvm.org nightly test results page.</p>
 759
 760 <p>Take a look at the <tt>NewNightlyTest.pl</tt> file to see what all of the
 761 flags and strings do.  If you start running the nightly tests, please let us
 762 know. Thanks!</p>
 763
 764 </div>
 765
 766 <!-- *********************************************************************** -->
 767
 768 <hr>
 769 <address>
 770   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 771   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
 772   <a href="http://validator.w3.org/check/referer"><img
 773   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
 774
 775   John T. Criswell, Reid Spencer, and Tanya Lattner<br>
 776   <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br/>
 777   Last modified: $Date$
 778 </address>
 779 </body>
 780 </html>