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