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></li>
  28   <li><a href="#nightly">Running the nightly tester</a></li>
  29 </ol>
  30
  31 <div class="doc_author">
  32   <p>Written by John T. Criswell, <a
  33   href="http://llvm.x10sys.com/rspencer">Reid Spencer</a>, and Tanya Lattner</p>
  34 </div>
  35
  36 <!--=========================================================================-->
  37 <div class="doc_section"><a name="overview">Overview</a></div>
  38 <!--=========================================================================-->
  39
  40 <div class="doc_text">
  41
  42 <p>This document is the reference manual for the LLVM test suite.  It documents
  43 the structure of the LLVM test suite, the tools needed to use it, and how to add
  44 and run tests.</p>
  45
  46 </div>
  47
  48 <!--=========================================================================-->
  49 <div class="doc_section"><a name="Requirements">Requirements</a></div>
  50 <!--=========================================================================-->
  51
  52 <div class="doc_text">
  53
  54 <p>In order to use the LLVM test suite, you will need all of the software
  55 required to build LLVM, plus the following:</p>
  56
  57 <dl>
  58 <dt><a href="http://www.gnu.org/software/dejagnu/">DejaGNU</a></dt>
  59 <dd>The Feature and Regressions tests are organized and run by DejaGNU.</dd>
  60 <dt><a href="http://expect.nist.gov/">Expect</a></dt>
  61 <dd>Expect is required by DejaGNU.</dd>
  62 <dt><a href="http://www.tcl.tk/software/tcltk/">tcl</a></dt>
  63 <dd>Tcl is required by DejaGNU. </dd>
  64
  65 <dt><a href="http://www.netlib.org/f2c">F2C</a></dt>
  66 <dd>For now, LLVM does not have a Fortran front-end, but using F2C, we can run
  67 Fortran benchmarks.  F2C support must be enabled via <tt>configure</tt> if not
  68 installed in a standard place.  F2C requires three items: the <tt>f2c</tt>
  69 executable, <tt>f2c.h</tt> to compile the generated code, and <tt>libf2c.a</tt>
  70 to link generated code.  By default, given an F2C directory <tt>$DIR</tt>, the
  71 configure script will search <tt>$DIR/bin</tt> for <tt>f2c</tt>,
  72 <tt>$DIR/include</tt> for <tt>f2c.h</tt>, and <tt>$DIR/lib</tt> for
  73 <tt>libf2c.a</tt>.  The default <tt>$DIR</tt> values are: <tt>/usr</tt>,
  74 <tt>/usr/local</tt>, <tt>/sw</tt>, and <tt>/opt</tt>.  If you installed F2C in a
  75 different location, you must tell <tt>configure</tt>:
  76
  77 <ul>
  78 <li><tt>./configure --with-f2c=$DIR</tt><br>
  79 This will specify a new <tt>$DIR</tt> for the above-described search
  80 process.  This will only work if the binary, header, and library are in their
  81 respective subdirectories of <tt>$DIR</tt>.</li>
  82
  83 <li><tt>./configure --with-f2c-bin=/binary/path --with-f2c-inc=/include/path
  84 --with-f2c-lib=/lib/path</tt><br>
  85 This allows you to specify the F2C components separately.  Note: if you choose
  86 this route, you MUST specify all three components, and you need to only specify
  87 <em>directories</em> where the files are located; do NOT include the
  88 filenames themselves on the <tt>configure</tt> line.</li>
  89 </ul></dd>
  90 </dl>
  91 </div>
  92
  93 <!--=========================================================================-->
  94 <div class="doc_section"><a name="quick">Quick Start</a></div>
  95 <!--=========================================================================-->
  96
  97 <div class="doc_text">
  98
  99 <p>The tests are located in two separate CVS modules. The basic feature and
 100 regression tests are in the main "llvm" module under the directory
 101 <tt>llvm/test</tt>. A more comprehensive test suite that includes whole
 102 programs in C and C++ is in the <tt>llvm-test</tt> module. This module should
 103 be checked out to the <tt>llvm/projects</tt> directory. When you
 104 <tt>configure</tt> the <tt>llvm</tt> module, the <tt>llvm-test</tt> module
 105 will be automatically configured. Alternatively, you can configure the <tt>llvm-test</tt> module manually.</p>
 106 <p>To run all of the simple tests in LLVM using DejaGNU, use the master Makefile in the
 107 <tt>llvm/test</tt> directory:</p>
 108 <pre>
 109 % gmake -C llvm/test
 110 </pre>
 111 or<br>
 112 <pre>
 113 % gmake check
 114 </pre>
 115 <p>To run only a subdirectory of tests in llvm/test using DejaGNU (ie. Regression/Transforms). Just substitute the path to the subdirectory:</p>
 116 <pre>
 117 % gmake -C llvm/test TESTSUITE=Regression/Transforms
 118 </pre>
 119 <dd><b>Note: If you are running the tests with <tt>objdir != subdir</tt> you must have run the complete testsuite before you can specify a subdirectory.</b></dd>
 120
 121 <p>To run the comprehensive test suite (tests that compile and execute whole
 122 programs), run the <tt>llvm-test</tt> tests:</p>
 123
 124 <pre>
 125 % cd llvm/projects
 126 % cvs co llvm-test
 127 % cd llvm-test
 128 % ./configure --with-llvmsrc=$LLVM_SRC_ROOT --with-llvmobj=$LLVM_OBJ_ROOT
 129 % gmake
 130 </pre>
 131
 132 </div>
 133
 134 <!--=========================================================================-->
 135 <div class="doc_section"><a name="org">LLVM Test Suite Organization</a></div>
 136 <!--=========================================================================-->
 137
 138 <div class="doc_text">
 139
 140 <p>The LLVM test suite contains two major categories of tests: code
 141 fragments and whole programs. Code fragments are in the <tt>llvm</tt> module
 142 under the directory under the <tt>llvm/test</tt> directory. The whole programs
 143 test suite are in the <tt>llvm-test</tt> module under the main directory.</p>
 144
 145 </div>
 146
 147 <div class="doc_subsection"><a name="codefragments">Code Fragments</a>
 148 </div>
 149
 150 <div class="doc_text">
 151
 152 <p>Code fragments are small pieces of code that test a specific feature of LLVM
 153 or trigger a specific bug in LLVM.  They are usually written in LLVM assembly
 154 language, but can be written in other languages if the test targets a particular
 155 language front end.</p>
 156
 157 <p>Code fragments are not complete programs, and they are never executed to
 158 determine correct behavior.</p>
 159
 160 <p>These code fragment tests are located in the <tt>llvm/test/Features</tt> and
 161 <tt>llvm/test/Regression</tt> directories.</p>
 162
 163 </div>
 164
 165 <div class="doc_subsection"><a name="wholeprograms">Whole Programs</a></div>
 166
 167 <div class="doc_text">
 168
 169 <p>Whole Programs are pieces of code which can be compiled and linked into a
 170 stand-alone program that can be executed.  These programs are generally written
 171 in high level languages such as C or C++, but sometimes they are written
 172 straight in LLVM assembly.</p>
 173
 174 <p>These programs are compiled and then executed using several different
 175 methods (native compiler, LLVM C backend, LLVM JIT, LLVM native code generation,
 176 etc).  The output of these programs is compared to ensure that LLVM is compiling
 177 the program correctly.</p>
 178
 179 <p>In addition to compiling and executing programs, whole program tests serve as
 180 a way of benchmarking LLVM performance, both in terms of the efficiency of the
 181 programs generated as well as the speed with which LLVM compiles, optimizes, and
 182 generates code.</p>
 183
 184 <p>All "whole program" tests are located in the <tt>llvm-test</tt> CVS
 185 module.</p>
 186
 187 </div>
 188
 189 <!--=========================================================================-->
 190 <div class="doc_section"><a name="tree">LLVM Test Suite Tree</a></div>
 191 <!--=========================================================================-->
 192
 193 <div class="doc_text">
 194
 195 <p>Each type of test in the LLVM test suite has its own directory. The major
 196 subtrees of the test suite directory tree are as follows:</p>
 197
 198 <ul>
 199 <li><tt>llvm/test/Features</tt>
 200 <p>This directory contains sample codes that test various features of the
 201 LLVM language.  These pieces of sample code are run through various
 202 assembler, disassembler, and optimizer passes.</p>
 203 </li>
 204
 205 <li><tt>llvm/test/Regression</tt>
 206 <p>This directory contains regression tests for LLVM.  When a bug is found
 207 in LLVM, a regression test containing just enough code to reproduce the
 208 problem should be written and placed somewhere underneath this directory.
 209 In most cases, this will be a small piece of LLVM assembly language code,
 210 often distilled from an actual application or benchmark.</p>
 211 </li>
 212
 213 <li><tt>llvm-test</tt>
 214 <p>The <tt>llvm-test</tt> CVS module contains programs that can be compiled
 215 with LLVM and executed.  These programs are compiled using the native compiler
 216 and various LLVM backends.  The output from the program compiled with the
 217 native compiler is assumed correct; the results from the other programs are
 218 compared to the native program output and pass if they match.</p>
 219
 220 <p>In addition for testing correctness, the <tt>llvm-test</tt> directory also
 221 performs timing tests of various LLVM optimizations.  It also records
 222 compilation times for the compilers and the JIT.  This information can be
 223 used to compare the effectiveness of LLVM's optimizations and code
 224 generation.</p></li>
 225
 226 <li><tt>llvm-test/SingleSource</tt>
 227 <p>The SingleSource directory contains test programs that are only a single
 228 source file in size.  These are usually small benchmark programs or small
 229 programs that calculate a particular value.  Several such programs are grouped
 230 together in each directory.</p></li>
 231
 232 <li><tt>llvm-test/MultiSource</tt>
 233 <p>The MultiSource directory contains subdirectories which contain entire
 234 programs with multiple source files.  Large benchmarks and whole applications
 235 go here.</p></li>
 236
 237 <li><tt>llvm-test/External</tt>
 238 <p>The External directory contains Makefiles for building code that is external
 239 to (i.e., not distributed with) LLVM.  The most prominent members of this
 240 directory are the SPEC 95 and SPEC 2000 benchmark suites.  The presence and
 241 location of these external programs is configured by the llvm-test
 242 <tt>configure</tt> script.</p></li>
 243
 244 </ul>
 245
 246 </div>
 247 <!--=========================================================================-->
 248 <div class="doc_section"><a name="dgstructure">DejaGNU Structure</a></div>
 249 <!--=========================================================================-->
 250
 251 <div class="doc_text">
 252 <p>The LLVM test suite is partially driven by DejaGNU and partially
 253 driven by GNU Make. Specifically, the Features and Regression tests
 254 are all driven by DejaGNU. The <tt>llvm-test</tt>
 255 module is currently driven by a set of Makefiles.</p>
 256
 257 <p>The DejaGNU structure is very simple, but does require some
 258 information to be set. This information is gathered via <tt>configure</tt> and
 259 is written to a file, <tt>site.exp</tt> in <tt>llvm/test</tt>. The
 260 <tt>llvm/test</tt>
 261 Makefile does this work for you.</p>
 262
 263 <p>In order for DejaGNU to work, each directory of tests must have a
 264 <tt>dg.exp</tt> file. This file is a program written in tcl that calls
 265 the <tt>llvm-runtests</tt> procedure on each test file. The
 266 llvm-runtests procedure is defined in
 267 <tt>llvm/test/lib/llvm-dg.exp</tt>. Any directory that contains only
 268 directories does not need the <tt>dg.exp</tt> file.</p>
 269
 270 <p>In order for a test to be run, it must contain information within
 271 the test file on how to run the test. These are called <tt>RUN</tt>
 272 lines. Run lines are specified in the comments of the test program
 273 using the keyword <tt>RUN</tt> followed by a colon, and lastly the
 274 commands to execute. These commands will be executed in a bash script,
 275 so any bash syntax is acceptable. You can specify as many RUN lines as
 276 necessary.  Each RUN line translates to one line in the resulting bash
 277 script. Below is an example of legal RUN lines in a <tt>.ll</tt>
 278 file:</p>
 279 <pre>
 280 ; RUN: llvm-as < %s | llvm-dis > %t1
 281 ; RUN: llvm-dis < %s.bc-13 > %t2
 282 ; RUN: diff %t1 %t2
 283 </pre>
 284 <p>There are a couple patterns within a <tt>RUN</tt> line that the
 285 llvm-runtest procedure looks for and replaces with the appropriate
 286 syntax:</p>
 287 <ul>
 288 <dt>%p</dt>
 289 <dd>The path to the source directory. This is for locating
 290 any supporting files that are not generated by the test, but used by
 291 the test.</dd>
 292 <dt>%s</dt>
 293 <dd>The test file.</dd>
 294
 295 <dt>%t</dt>
 296 <dd>Temporary filename: testscript.test_filename.tmp, where
 297 test_filename is the name of the test file. All temporary files are
 298 placed in the Output directory within the directory the test is
 299 located.</dd>
 300
 301 <dt>%prcontext</dt>
 302 <dd>Path to a script that performs grep -C. Use this since not all
 303 platforms support grep -C.</dd>
 304
 305 <dt>%llvmgcc</dt> <dd>Full path to the llvm-gcc executable.</dd>
 306 <dt>%llvmgxx</dt> <dd>Full path to the llvm-g++ executable.</dd>
 307 </ul>
 308
 309 <p>There are also several scripts in the llvm/test/Scripts directory
 310 that you might find useful when writing <tt>RUN</tt> lines.</p>
 311
 312 <p>Lastly, you can easily mark a test that is expected to fail on a
 313 specific platform by using the <tt>XFAIL</tt> keyword. Xfail lines are
 314 specified in the comments of the test program using <tt>XFAIL</tt>,
 315 followed by a colon, and one or more regular expressions (separated by
 316 a comma) that will match against the target triplet for the
 317 machine. You can use * to match all targets. Here is an example of an
 318 <tt>XFAIL</tt> line:</p>
 319 <pre>
 320 ; XFAIL: darwin,sun
 321 </pre>
 322
 323 </div>
 324
 325 <!--=========================================================================-->
 326 <div class="doc_section"><a name="progstructure"><tt>llvm-test</tt>
 327 Structure</a></div>
 328 <!--=========================================================================-->
 329
 330 <div class="doc_text">
 331
 332 <p>As mentioned previously, the <tt>llvm-test</tt> module  provides three types
 333 of tests: MultiSource, SingleSource, and External.  Each tree is then subdivided
 334 into several categories, including applications, benchmarks, regression tests,
 335 code that is strange grammatically, etc.  These organizations should be
 336 relatively self explanatory.</p>
 337
 338 <p>In addition to the regular "whole program"  tests, the <tt>llvm-test</tt>
 339 module also provides a mechanism for compiling the programs in different ways.
 340 If the variable TEST is defined on the gmake command line, the test system will
 341 include a Makefile named <tt>TEST.&lt;value of TEST variable&gt;.Makefile</tt>.
 342 This Makefile can modify build rules to yield different results.</p>
 343
 344 <p>For example, the LLVM nightly tester uses <tt>TEST.nightly.Makefile</tt> to
 345 create the nightly test reports.  To run the nightly tests, run <tt>gmake
 346 TEST=nightly</tt>.</p>
 347
 348 <p>There are several TEST Makefiles available in the tree.  Some of them are
 349 designed for internal LLVM research and will not work outside of the LLVM
 350 research group.  They may still be valuable, however, as a guide to writing your
 351 own TEST Makefile for any optimization or analysis passes that you develop with
 352 LLVM.</p>
 353
 354 <p>Note, when configuring the <tt>llvm-test</tt> module, you might want to
 355 specify the following configuration options:</p>
 356 <dl>
 357   <dt><i>--enable-spec2000</i>
 358   <dt><i>--enable-spec2000=&lt;<tt>directory</tt>&gt;</i>
 359   <dd>
 360     Enable the use of SPEC2000 when testing LLVM.  This is disabled by default
 361     (unless <tt>configure</tt> finds SPEC2000 installed).  By specifying
 362     <tt>directory</tt>, you can tell configure where to find the SPEC2000
 363     benchmarks.  If <tt>directory</tt> is left unspecified, <tt>configure</tt>
 364     uses the default value
 365     <tt>/home/vadve/shared/benchmarks/speccpu2000/benchspec</tt>.
 366     <p>
 367   <dt><i>--enable-spec95</i>
 368   <dt><i>--enable-spec95=&lt;<tt>directory</tt>&gt;</i>
 369   <dd>
 370     Enable the use of SPEC95 when testing LLVM.  It is similar to the
 371     <i>--enable-spec2000</i> option.
 372     <p>
 373   <dt><i>--enable-povray</i>
 374   <dt><i>--enable-povray=&lt;<tt>directory</tt>&gt;</i>
 375   <dd>
 376     Enable the use of Povray as an external test.  Versions of Povray written
 377     in C should work.  This option is similar to the <i>--enable-spec2000</i>
 378     option.
 379 </dl>
 380 </div>
 381
 382 <!--=========================================================================-->
 383 <div class="doc_section"><a name="run">Running the LLVM Tests</a></div>
 384 <!--=========================================================================-->
 385
 386 <div class="doc_text">
 387
 388 <p>First, all tests are executed within the LLVM object directory tree.  They
 389 <i>are not</i> executed inside of the LLVM source tree. This is because the
 390 test suite creates temporary files during execution.</p>
 391
 392 <p>The master Makefile in llvm/test is capable of running only the DejaGNU driven
 393 tests. By default, it will run all of these tests.</p>
 394
 395 <p>To run only the DejaGNU driven tests, run <tt>gmake</tt> at the
 396 command line in llvm/tests.  To run a specific directory of tests, use the
 397 TESTSUITE variable.
 398 </p>
 399
 400 <p>For example, to run the Regression tests, type
 401 <tt>gmake TESTSUITE=Regression</tt> in <tt>llvm/tests</tt>.</p>
 402
 403 <p>Note that there are no Makefiles in <tt>llvm/test/Features</tt> and
 404 <tt>llvm/test/Regression</tt>. You must use DejaGNU from the <tt>llvm/test</tt>
 405 directory to run them.</p>
 406
 407 <p>To run the <tt>llvm-test</tt> suite, you need to use the following steps:
 408 </p>
 409 <ol>
 410   <li>cd into the llvm/projects directory</li>
 411   <li>check out the <tt>llvm-test</tt> module with:<br/>
 412   <tt>cvs -d :pserver:anon@llvm.cs.uiuc.edu:/var/cvs/llvm co -PR llvm-test</tt><br>
 413   This will get the test suite into <tt>llvm/projects/llvm-test</tt></li>
 414   <li>configure the test suite. You can do this one of two ways:
 415   <ol>
 416     <li>Use the regular llvm configure:<br/>
 417     <tt>cd $LLVM_OBJ_ROOT ; $LLVM_SRC_ROOT/configure</tt><br/>
 418     This will ensure that the <tt>projects/llvm-test</tt> directory is also
 419     properly configured.</li>
 420     <li>Use the <tt>configure</tt> script found in the <tt>llvm-test</tt> source
 421     directory:<br/>
 422     <tt>$BUILD_SRC_DIR/configure --with-llvmsrc=$LLVM_SRC_ROOT --with-llvmobj=$LLVM_OBJ_ROOT</tt>
 423     </li>
 424   </ol>
 425   <li>gmake</li>
 426 </ol>
 427 <p>Note that the second and third steps only need to be done once. After you
 428 have the suite checked out and configured, you don't need to do it again (unless
 429 the test code or configure script changes).</p>
 430
 431 <p>To make a specialized test (use one of the
 432 <tt>llvm-test/TEST.&lt;type&gt;.Makefile</tt>s), just run:<br/>
 433 <tt>gmake TEST=&lt;type&gt; test</tt><br/>For example, you could run the
 434 nightly tester tests using the following commands:</p>
 435
 436 <pre>
 437  % cd llvm/projects/llvm-test
 438  % gmake TEST=nightly test
 439 </pre>
 440
 441 <p>Regardless of which test you're running, the results are printed on standard
 442 output and standard error.  You can redirect these results to a file if you
 443 choose.</p>
 444
 445 <p>Some tests are known to fail.  Some are bugs that we have not fixed yet;
 446 others are features that we haven't added yet (or may never add).  In DejaGNU,
 447 the result for such tests will be XFAIL (eXpected FAILure).  In this way, you
 448 can tell the difference between an expected and unexpected failure.</p>
 449
 450 <p>The tests in <tt>llvm-test</tt> have no such feature as of this time. If the
 451 test passes, only warnings and other miscellaneous output will be generated.  If
 452 a test fails, a large &lt;program&gt; FAILED message will be displayed.  This
 453 will help you separate benign warnings from actual test failures.</p>
 454
 455 </div>
 456
 457 <!--=========================================================================-->
 458 <div class="doc_section"><a name="nightly">Running the nightly tester</a></div>
 459 <!--=========================================================================-->
 460
 461 <div class="doc_text">
 462
 463 <p>
 464 The <a href="http://llvm.cs.uiuc.edu/testresults/">LLVM Nightly Testers</a>
 465 automatically check out an LLVM tree, build it, run the "nightly"
 466 program test (described above), run  all of the feature and regression tests,
 467 and then delete the checked out tree.  This tester is designed to ensure that
 468 programs don't break as well as keep track of LLVM's progress over time.</p>
 469
 470 <p>
 471 If you'd like to set up an instance of the nightly tester to run on your
 472 machine, take a look at the comments at the top of the utils/NightlyTester.pl
 473 file.  We usually run it from a crontab entry that looks ilke this:
 474 </p>
 475
 476 <pre>
 477 5 3 * * *  $HOME/llvm/utils/NightlyTest.pl -parallel -enable-linscan ...CVSREPOSTORY... $HOME/buildtest-X86 $HOME/cvs/testresults-X86
 478 </pre>
 479
 480 <p>Or, you can create a shell script to encapsulate the running of the script.
 481 The optimized x86 Linux nightly test is run from just such a script:
 482 <pre>
 483 #!/bin/bash
 484 BASE=/proj/work/llvm/nightlytest
 485 export CVSROOT=:pserver:anon@llvm.cs.uiuc.edu:/var/cvs/llvm
 486 export BUILDDIR=$BASE/build
 487 export WEBDIR=$BASE/testresults
 488 export LLVMGCCDIR=/proj/work/llvm/cfrontend/install
 489 export PATH=/proj/install/bin:$LLVMGCCDIR/bin:$PATH
 490 export LD_LIBRARY_PATH=/proj/install/lib
 491 cd $BASE
 492 cp /proj/work/llvm/llvm/utils/NightlyTest.pl .
 493 nice ./NightlyTest.pl -nice -release -verbose -parallel -enable-linscan -noexternals
 494 </pre>
 495
 496 <p>
 497 Take a look at the NightlyTest.pl file to see what all of the flags and
 498 strings do.  If you start running the nightly tests, please let us know and
 499 we'll link your page to the global tester page.  Thanks!
 500 </p>
 501
 502 </div>
 503
 504 <!-- *********************************************************************** -->
 505
 506 <hr>
 507 <address>
 508   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 509   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
 510   <a href="http://validator.w3.org/check/referer"><img
 511   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
 512
 513   John T. Criswell<br>
 514   <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br/>
 515   Last modified: $Date$
 516 </address>
 517 </body>
 518 </html>