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