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/Features</tt>
 220 <p>This directory contains sample codes that test various features of the
 221 LLVM language.  These pieces of sample code are run through various
 222 assembler, disassembler, and optimizer passes.</p>
 223 </li>
 224
 225 <li><tt>llvm/test/Regression</tt>
 226 <p>This directory contains regression tests for LLVM.  When a bug is found
 227 in LLVM, a regression test containing just enough code to reproduce the
 228 problem should be written and placed somewhere underneath this directory.
 229 In most cases, this will be a small piece of LLVM assembly language code,
 230 often distilled from an actual application or benchmark.</p>
 231 </li>
 232
 233 <li><tt>llvm-test</tt>
 234 <p>The <tt>llvm-test</tt> CVS module contains programs that can be compiled
 235 with LLVM and executed.  These programs are compiled using the native compiler
 236 and various LLVM backends.  The output from the program compiled with the
 237 native compiler is assumed correct; the results from the other programs are
 238 compared to the native program output and pass if they match.</p>
 239
 240 <p>In addition for testing correctness, the <tt>llvm-test</tt> directory also
 241 performs timing tests of various LLVM optimizations.  It also records
 242 compilation times for the compilers and the JIT.  This information can be
 243 used to compare the effectiveness of LLVM's optimizations and code
 244 generation.</p></li>
 245
 246 <li><tt>llvm-test/SingleSource</tt>
 247 <p>The SingleSource directory contains test programs that are only a single
 248 source file in size.  These are usually small benchmark programs or small
 249 programs that calculate a particular value.  Several such programs are grouped
 250 together in each directory.</p></li>
 251
 252 <li><tt>llvm-test/MultiSource</tt>
 253 <p>The MultiSource directory contains subdirectories which contain entire
 254 programs with multiple source files.  Large benchmarks and whole applications
 255 go here.</p></li>
 256
 257 <li><tt>llvm-test/External</tt>
 258 <p>The External directory contains Makefiles for building code that is external
 259 to (i.e., not distributed with) LLVM.  The most prominent members of this
 260 directory are the SPEC 95 and SPEC 2000 benchmark suites.  The presence and
 261 location of these external programs is configured by the llvm-test
 262 <tt>configure</tt> script.</p></li>
 263
 264 </ul>
 265
 266 </div>
 267 <!--=========================================================================-->
 268 <div class="doc_section"><a name="dgstructure">DejaGNU Structure</a></div>
 269 <!--=========================================================================-->
 270
 271 <div class="doc_text">
 272 <p>The LLVM test suite is partially driven by DejaGNU and partially
 273 driven by GNU Make. Specifically, the Features and Regression tests
 274 are all driven by DejaGNU. The <tt>llvm-test</tt>
 275 module is currently driven by a set of Makefiles.</p>
 276
 277 <p>The DejaGNU structure is very simple, but does require some
 278 information to be set. This information is gathered via <tt>configure</tt> and
 279 is written to a file, <tt>site.exp</tt> in <tt>llvm/test</tt>. The
 280 <tt>llvm/test</tt>
 281 Makefile does this work for you.</p>
 282
 283 <p>In order for DejaGNU to work, each directory of tests must have a
 284 <tt>dg.exp</tt> file. This file is a program written in tcl that calls
 285 the <tt>llvm-runtests</tt> procedure on each test file. The
 286 llvm-runtests procedure is defined in
 287 <tt>llvm/test/lib/llvm-dg.exp</tt>. Any directory that contains only
 288 directories does not need the <tt>dg.exp</tt> file.</p>
 289
 290 <p>In order for a test to be run, it must contain information within
 291 the test file on how to run the test. These are called <tt>RUN</tt>
 292 lines. Run lines are specified in the comments of the test program
 293 using the keyword <tt>RUN</tt> followed by a colon, and lastly the
 294 commands to execute. These commands will be executed in a bash script,
 295 so any bash syntax is acceptable. You can specify as many RUN lines as
 296 necessary.  Each RUN line translates to one line in the resulting bash
 297 script. Below is an example of legal RUN lines in a <tt>.ll</tt>
 298 file:</p>
 299 <pre>
 300 ; RUN: llvm-as < %s | llvm-dis > %t1
 301 ; RUN: llvm-dis < %s.bc-13 > %t2
 302 ; RUN: diff %t1 %t2
 303 </pre>
 304 <p>There are a couple patterns within a <tt>RUN</tt> line that the
 305 llvm-runtest procedure looks for and replaces with the appropriate
 306 syntax:</p>
 307
 308 <dl style="margin-left: 25px">
 309 <dt>%p</dt>
 310 <dd>The path to the source directory. This is for locating
 311 any supporting files that are not generated by the test, but used by
 312 the test.</dd>
 313 <dt>%s</dt>
 314 <dd>The test file.</dd>
 315
 316 <dt>%t</dt>
 317 <dd>Temporary filename: testscript.test_filename.tmp, where
 318 test_filename is the name of the test file. All temporary files are
 319 placed in the Output directory within the directory the test is
 320 located.</dd>
 321
 322 <dt>%prcontext</dt>
 323 <dd>Path to a script that performs grep -C. Use this since not all
 324 platforms support grep -C.</dd>
 325
 326 <dt>%llvmgcc</dt> <dd>Full path to the llvm-gcc executable.</dd>
 327 <dt>%llvmgxx</dt> <dd>Full path to the llvm-g++ executable.</dd>
 328 </dl>
 329
 330 <p>There are also several scripts in the llvm/test/Scripts directory
 331 that you might find useful when writing <tt>RUN</tt> lines.</p>
 332
 333 <p>Lastly, you can easily mark a test that is expected to fail on a
 334 specific platform or with a specific version of llvmgcc by using the
 335  <tt>XFAIL</tt> keyword. Xfail lines are
 336 specified in the comments of the test program using <tt>XFAIL</tt>,
 337 followed by a colon, and one or more regular expressions (separated by
 338 a comma) that will match against the target triplet or llvmgcc version for the
 339 machine. You can use * to match all targets. You can specify the major or full
 340  version (i.e. 3.4) for llvmgcc. Here is an example of an
 341 <tt>XFAIL</tt> line:</p>
 342 <pre>
 343 ; XFAIL: darwin,sun,llvmgcc4
 344 </pre>
 345
 346 </div>
 347
 348 <!--=========================================================================-->
 349 <div class="doc_section"><a name="progstructure"><tt>llvm-test</tt>
 350 Structure</a></div>
 351 <!--=========================================================================-->
 352
 353 <div class="doc_text">
 354
 355 <p>As mentioned previously, the <tt>llvm-test</tt> module  provides three types
 356 of tests: MultiSource, SingleSource, and External.  Each tree is then subdivided
 357 into several categories, including applications, benchmarks, regression tests,
 358 code that is strange grammatically, etc.  These organizations should be
 359 relatively self explanatory.</p>
 360
 361 <p>In addition to the regular "whole program"  tests, the <tt>llvm-test</tt>
 362 module also provides a mechanism for compiling the programs in different ways.
 363 If the variable TEST is defined on the gmake command line, the test system will
 364 include a Makefile named <tt>TEST.&lt;value of TEST variable&gt;.Makefile</tt>.
 365 This Makefile can modify build rules to yield different results.</p>
 366
 367 <p>For example, the LLVM nightly tester uses <tt>TEST.nightly.Makefile</tt> to
 368 create the nightly test reports.  To run the nightly tests, run <tt>gmake
 369 TEST=nightly</tt>.</p>
 370
 371 <p>There are several TEST Makefiles available in the tree.  Some of them are
 372 designed for internal LLVM research and will not work outside of the LLVM
 373 research group.  They may still be valuable, however, as a guide to writing your
 374 own TEST Makefile for any optimization or analysis passes that you develop with
 375 LLVM.</p>
 376
 377 <p>Note, when configuring the <tt>llvm-test</tt> module, you might want to
 378 specify the following configuration options:</p>
 379 <dl>
 380   <dt><i>--enable-spec2000</i>
 381   <dt><i>--enable-spec2000=&lt;<tt>directory</tt>&gt;</i>
 382   <dd>
 383     Enable the use of SPEC2000 when testing LLVM.  This is disabled by default
 384     (unless <tt>configure</tt> finds SPEC2000 installed).  By specifying
 385     <tt>directory</tt>, you can tell configure where to find the SPEC2000
 386     benchmarks.  If <tt>directory</tt> is left unspecified, <tt>configure</tt>
 387     uses the default value
 388     <tt>/home/vadve/shared/benchmarks/speccpu2000/benchspec</tt>.
 389     <p>
 390   <dt><i>--enable-spec95</i>
 391   <dt><i>--enable-spec95=&lt;<tt>directory</tt>&gt;</i>
 392   <dd>
 393     Enable the use of SPEC95 when testing LLVM.  It is similar to the
 394     <i>--enable-spec2000</i> option.
 395     <p>
 396   <dt><i>--enable-povray</i>
 397   <dt><i>--enable-povray=&lt;<tt>directory</tt>&gt;</i>
 398   <dd>
 399     Enable the use of Povray as an external test.  Versions of Povray written
 400     in C should work.  This option is similar to the <i>--enable-spec2000</i>
 401     option.
 402 </dl>
 403 </div>
 404
 405 <!--=========================================================================-->
 406 <div class="doc_section"><a name="run">Running the LLVM Tests</a></div>
 407 <!--=========================================================================-->
 408
 409 <div class="doc_text">
 410
 411 <p>First, all tests are executed within the LLVM object directory tree.  They
 412 <i>are not</i> executed inside of the LLVM source tree. This is because the
 413 test suite creates temporary files during execution.</p>
 414
 415 <p>The master Makefile in llvm/test is capable of running only the DejaGNU
 416 driven tests. By default, it will run all of these tests.</p>
 417
 418 <p>To run only the DejaGNU driven tests, run <tt>gmake</tt> at the
 419 command line in <tt>llvm/test</tt>.  To run a specific directory of tests, use
 420 the TESTSUITE variable.
 421 </p>
 422
 423 <p>For example, to run the Regression tests, type
 424 <tt>gmake TESTSUITE=Regression</tt> in <tt>llvm/tests</tt>.</p>
 425
 426 <p>Note that there are no Makefiles in <tt>llvm/test/Features</tt> and
 427 <tt>llvm/test/Regression</tt>. You must use DejaGNU from the <tt>llvm/test</tt>
 428 directory to run them.</p>
 429
 430 <p>To run the <tt>llvm-test</tt> suite, you need to use the following steps:
 431 </p>
 432 <ol>
 433   <li>cd into the llvm/projects directory</li>
 434   <li>check out the <tt>llvm-test</tt> module with:<br/>
 435   <tt>cvs -d :pserver:anon@llvm.org:/var/cvs/llvm co -PR llvm-test</tt><br>
 436   This will get the test suite into <tt>llvm/projects/llvm-test</tt></li>
 437   <li>configure the test suite. You can do this one of two ways:
 438   <ol>
 439     <li>Use the regular llvm configure:<br/>
 440     <tt>cd $LLVM_OBJ_ROOT ; $LLVM_SRC_ROOT/configure</tt><br/>
 441     This will ensure that the <tt>projects/llvm-test</tt> directory is also
 442     properly configured.</li>
 443     <li>Use the <tt>configure</tt> script found in the <tt>llvm-test</tt> source
 444     directory:<br/>
 445     <tt>$LLVM_SRC_ROOT/projects/llvm-test/configure
 446      --with-llvmsrc=$LLVM_SRC_ROOT --with-llvmobj=$LLVM_OBJ_ROOT</tt>
 447     </li>
 448   </ol>
 449   <li>gmake</li>
 450 </ol>
 451 <p>Note that the second and third steps only need to be done once. After you
 452 have the suite checked out and configured, you don't need to do it again (unless
 453 the test code or configure script changes).</p>
 454
 455 <p>To make a specialized test (use one of the
 456 <tt>llvm-test/TEST.&lt;type&gt;.Makefile</tt>s), just run:<br/>
 457 <tt>gmake TEST=&lt;type&gt; test</tt><br/>For example, you could run the
 458 nightly tester tests using the following commands:</p>
 459
 460 <pre>
 461  % cd llvm/projects/llvm-test
 462  % gmake TEST=nightly test
 463 </pre>
 464
 465 <p>Regardless of which test you're running, the results are printed on standard
 466 output and standard error.  You can redirect these results to a file if you
 467 choose.</p>
 468
 469 <p>Some tests are known to fail.  Some are bugs that we have not fixed yet;
 470 others are features that we haven't added yet (or may never add).  In DejaGNU,
 471 the result for such tests will be XFAIL (eXpected FAILure).  In this way, you
 472 can tell the difference between an expected and unexpected failure.</p>
 473
 474 <p>The tests in <tt>llvm-test</tt> have no such feature at this time. If the
 475 test passes, only warnings and other miscellaneous output will be generated.  If
 476 a test fails, a large &lt;program&gt; FAILED message will be displayed.  This
 477 will help you separate benign warnings from actual test failures.</p>
 478
 479 </div>
 480
 481 <!-- _______________________________________________________________________ -->
 482 <div class="doc_subsection">
 483 <a name="customtest">Writing custom tests for llvm-test</a></div>
 484 <!-- _______________________________________________________________________ -->
 485
 486 <div class="doc_text">
 487
 488 <p>Assuming you can run llvm-test, (e.g. "<tt>gmake TEST=nightly report</tt>"
 489 should work), it is really easy to run optimizations or code generator
 490 components against every program in the tree, collecting statistics or running
 491 custom checks for correctness.  At base, this is how the nightly tester works,
 492 it's just one example of a general framework.</p>
 493
 494 <p>Lets say that you have an LLVM optimization pass, and you want to see how
 495 many times it triggers.  First thing you should do is add an LLVM
 496 <a href="ProgrammersManual.html#Statistic">statistic</a> to your pass, which
 497 will tally counts of things you care about.</p>
 498
 499 <p>Following this, you can set up a test and a report that collects these and
 500 formats them for easy viewing.  This consists of two files, an
 501 "<tt>llvm-test/TEST.XXX.Makefile</tt>" fragment (where XXX is the name of your
 502 test) and an "<tt>llvm-test/TEST.XXX.report</tt>" file that indicates how to
 503 format the output into a table.  There are many example reports of various
 504 levels of sophistication included with llvm-test, and the framework is very
 505 general.</p>
 506
 507 <p>If you are interested in testing an optimization pass, check out the
 508 "libcalls" test as an example.  It can be run like this:<p>
 509
 510 <div class="doc_code">
 511 <pre>
 512 % cd llvm/projects/llvm-test/MultiSource/Benchmarks  # or some other level
 513 % make TEST=libcalls report
 514 </pre>
 515 </div>
 516
 517 <p>This will do a bunch of stuff, then eventually print a table like this:</p>
 518
 519 <div class="doc_code">
 520 <pre>
 521 Name                                  | total | #exit |
 522 ...
 523 FreeBench/analyzer/analyzer           | 51    | 6     |
 524 FreeBench/fourinarow/fourinarow       | 1     | 1     |
 525 FreeBench/neural/neural               | 19    | 9     |
 526 FreeBench/pifft/pifft                 | 5     | 3     |
 527 MallocBench/cfrac/cfrac               | 1     | *     |
 528 MallocBench/espresso/espresso         | 52    | 12    |
 529 MallocBench/gs/gs                     | 4     | *     |
 530 Prolangs-C/TimberWolfMC/timberwolfmc  | 302   | *     |
 531 Prolangs-C/agrep/agrep                | 33    | 12    |
 532 Prolangs-C/allroots/allroots          | *     | *     |
 533 Prolangs-C/assembler/assembler        | 47    | *     |
 534 Prolangs-C/bison/mybison              | 74    | *     |
 535 ...
 536 </pre>
 537 </div>
 538
 539 <p>This basically is grepping the -stats output and displaying it in a table.
 540 You can also use the "TEST=libcalls report.html" target to get the table in HTML
 541 form, similarly for report.csv and report.tex.</p>
 542
 543 <p>The source for this is in llvm-test/TEST.libcalls.*.  The format is pretty
 544 simple: the Makefile indicates how to run the test (in this case,
 545 "<tt>opt -simplify-libcalls -stats</tt>"), and the report contains one line for
 546 each column of the output.  The first value is the header for the column and the
 547 second is the regex to grep the output of the command for.  There are lots of
 548 example reports that can do fancy stuff.</p>
 549
 550 </div>
 551
 552
 553 <!--=========================================================================-->
 554 <div class="doc_section"><a name="nightly">Running the nightly tester</a></div>
 555 <!--=========================================================================-->
 556
 557 <div class="doc_text">
 558
 559 <p>
 560 The <a href="http://llvm.org/testresults/">LLVM Nightly Testers</a>
 561 automatically check out an LLVM tree, build it, run the "nightly"
 562 program test (described above), run  all of the feature and regression tests,
 563 and then delete the checked out tree.  This tester is designed to ensure that
 564 programs don't break as well as keep track of LLVM's progress over time.</p>
 565
 566 <p>If you'd like to set up an instance of the nightly tester to run on your
 567 machine, take a look at the comments at the top of the
 568 <tt>utils/NightlyTest.pl</tt> file.  We usually run it from a crontab entry
 569 that looks like this:</p>
 570
 571 <div class="doc_code">
 572 <pre>
 573 5 3 * * *  $HOME/llvm/utils/NightlyTest.pl -parallel $CVSROOT \
 574            $HOME/buildtest $HOME/cvs/testresults
 575 </pre>
 576 </div>
 577
 578 <p>Or, you can create a shell script to encapsulate the running of the script.
 579 The optimized x86 Linux nightly test is run from just such a script:</p>
 580
 581 <div class="doc_code">
 582 <pre>
 583 #!/bin/bash
 584 BASE=/proj/work/llvm/nightlytest
 585 export CVSROOT=:pserver:anon@llvm.org:/var/cvs/llvm
 586 export BUILDDIR=$BASE/build
 587 export WEBDIR=$BASE/testresults
 588 export LLVMGCCDIR=/proj/work/llvm/cfrontend/install
 589 export PATH=/proj/install/bin:$LLVMGCCDIR/bin:$PATH
 590 export LD_LIBRARY_PATH=/proj/install/lib
 591 cd $BASE
 592 cp /proj/work/llvm/llvm/utils/NightlyTest.pl .
 593 nice ./NightlyTest.pl -nice -release -verbose -parallel -enable-linscan \
 594    -noexternals 2&gt;&amp;1 &gt; output.log
 595 mail -s 'X86 nightly tester results' <a href="http://mail.cs.uiuc.edu/mailman/\
 596    listinfo/llvm-testresults">llvm-testresults@cs.uiuc.edu</a> &lt; output.log
 597 </pre>
 598 </div>
 599
 600 <p>Take a look at the <tt>NightlyTest.pl</tt> file to see what all of the flags
 601 and strings do.  If you start running the nightly tests, please let us know and
 602 we'll link your page to the global tester page.  Thanks!</p>
 603
 604 </div>
 605
 606 <!-- *********************************************************************** -->
 607
 608 <hr>
 609 <address>
 610   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 611   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
 612   <a href="http://validator.w3.org/check/referer"><img
 613   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
 614
 615   John T. Criswell, Reid Spencer, and Tanya Lattner<br>
 616   <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br/>
 617   Last modified: $Date$
 618 </address>
 619 </body>
 620 </html>