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