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