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