1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
5 <title>LLVM Test Suite Guide</title>
6 <link rel="stylesheet" href="llvm.css" type="text/css">
10 <div class="doc_title">
15 <li><a href="#overview">Overview</a></li>
16 <li><a href="#Requirements">Requirements</a></li>
17 <li><a href="#quick">Quick Start</a></li>
18 <li><a href="#org">LLVM Test Suite Organization</a>
20 <li><a href="#codefragments">Code Fragments</a></li>
21 <li><a href="#wholeprograms">Whole Programs</a></li>
24 <li><a href="#tree">LLVM Test Suite Tree</a></li>
25 <li><a href="#dgstructure">DejaGNU Structure</a></li>
26 <li><a href="#progstructure"><tt>llvm-test</tt> Structure</a></li>
27 <li><a href="#run">Running the LLVM Tests</a></li>
28 <li><a href="#nightly">Running the nightly tester</a></li>
31 <div class="doc_author">
32 <p>Written by John T. Criswell, <a
33 href="http://llvm.x10sys.com/rspencer">Reid Spencer</a>, and Tanya Lattner</p>
36 <!--=========================================================================-->
37 <div class="doc_section"><a name="overview">Overview</a></div>
38 <!--=========================================================================-->
40 <div class="doc_text">
42 <p>This document is the reference manual for the LLVM test suite. It documents
43 the structure of the LLVM test suite, the tools needed to use it, and how to add
48 <!--=========================================================================-->
49 <div class="doc_section"><a name="Requirements">Requirements</a></div>
50 <!--=========================================================================-->
52 <div class="doc_text">
54 <p>In order to use the LLVM test suite, you will need all of the software
55 required to build LLVM, plus the following:</p>
58 <dt><a href="http://www.gnu.org/software/dejagnu/">DejaGNU</a></dt>
59 <dd>The Feature and Regressions tests are organized and run by DejaGNU.</dd>
60 <dt><a href="http://expect.nist.gov/">Expect</a></dt>
61 <dd>Expect is required by DejaGNU.</dd>
62 <dt><a href="http://www.tcl.tk/software/tcltk/">tcl</a></dt>
63 <dd>Tcl is required by DejaGNU. </dd>
65 <dt><a href="http://www.netlib.org/f2c">F2C</a></dt>
66 <dd>For now, LLVM does not have a Fortran front-end, but using F2C, we can run
67 Fortran benchmarks. F2C support must be enabled via <tt>configure</tt> if not
68 installed in a standard place. F2C requires three items: the <tt>f2c</tt>
69 executable, <tt>f2c.h</tt> to compile the generated code, and <tt>libf2c.a</tt>
70 to link generated code. By default, given an F2C directory <tt>$DIR</tt>, the
71 configure script will search <tt>$DIR/bin</tt> for <tt>f2c</tt>,
72 <tt>$DIR/include</tt> for <tt>f2c.h</tt>, and <tt>$DIR/lib</tt> for
73 <tt>libf2c.a</tt>. The default <tt>$DIR</tt> values are: <tt>/usr</tt>,
74 <tt>/usr/local</tt>, <tt>/sw</tt>, and <tt>/opt</tt>. If you installed F2C in a
75 different location, you must tell <tt>configure</tt>:
78 <li><tt>./configure --with-f2c=$DIR</tt><br>
79 This will specify a new <tt>$DIR</tt> for the above-described search
80 process. This will only work if the binary, header, and library are in their
81 respective subdirectories of <tt>$DIR</tt>.</li>
83 <li><tt>./configure --with-f2c-bin=/binary/path --with-f2c-inc=/include/path
84 --with-f2c-lib=/lib/path</tt><br>
85 This allows you to specify the F2C components separately. Note: if you choose
86 this route, you MUST specify all three components, and you need to only specify
87 <em>directories</em> where the files are located; do NOT include the
88 filenames themselves on the <tt>configure</tt> line.</li>
92 <p>Darwin (Mac OS X) developers can simplify the installation of Expect and tcl
93 by using fink. <tt>fink install expect</tt> will install both. Alternatively,
94 Darwinports users can use <tt>sudo port install expect</tt> to install Expect
99 <!--=========================================================================-->
100 <div class="doc_section"><a name="quick">Quick Start</a></div>
101 <!--=========================================================================-->
103 <div class="doc_text">
105 <p>The tests are located in two separate CVS modules. The basic feature and
106 regression tests are in the main "llvm" module under the directory
107 <tt>llvm/test</tt>. A more comprehensive test suite that includes whole
108 programs in C and C++ is in the <tt>llvm-test</tt> module. This module should
109 be checked out to the <tt>llvm/projects</tt> directory. When you
110 <tt>configure</tt> the <tt>llvm</tt> module, the <tt>llvm-test</tt> module
111 will be automatically configured. Alternatively, you can configure the
112 <tt>llvm-test</tt> module manually.</p>
113 <p>To run all of the simple tests in LLVM using DejaGNU, use the master Makefile
114 in the <tt>llvm/test</tt> directory:</p>
123 <p>To run only a subdirectory of tests in llvm/test using DejaGNU (ie.
124 Regression/Transforms), just set the TESTSUITE variable to the path of the
125 subdirectory (relative to <tt>llvm/test</tt>):</p>
127 % gmake -C llvm/test TESTSUITE=Regression/Transforms
130 <p><b>Note: If you are running the tests with <tt>objdir != subdir</tt>, you
131 must have run the complete testsuite before you can specify a
132 subdirectory.</b></p>
134 <p>To run the comprehensive test suite (tests that compile and execute whole
135 programs), run the <tt>llvm-test</tt> tests:</p>
141 % ./configure --with-llvmsrc=$LLVM_SRC_ROOT --with-llvmobj=$LLVM_OBJ_ROOT
147 <!--=========================================================================-->
148 <div class="doc_section"><a name="org">LLVM Test Suite Organization</a></div>
149 <!--=========================================================================-->
151 <div class="doc_text">
153 <p>The LLVM test suite contains two major categories of tests: code
154 fragments and whole programs. Code fragments are in the <tt>llvm</tt> module
155 under the <tt>llvm/test</tt> directory. The whole programs
156 test suite is in the <tt>llvm-test</tt> module under the main directory.</p>
160 <div class="doc_subsection"><a name="codefragments">Code Fragments</a>
163 <div class="doc_text">
165 <p>Code fragments are small pieces of code that test a specific feature of LLVM
166 or trigger a specific bug in LLVM. They are usually written in LLVM assembly
167 language, but can be written in other languages if the test targets a particular
168 language front end.</p>
170 <p>Code fragments are not complete programs, and they are never executed to
171 determine correct behavior.</p>
173 <p>These code fragment tests are located in the <tt>llvm/test/Features</tt> and
174 <tt>llvm/test/Regression</tt> directories.</p>
178 <div class="doc_subsection"><a name="wholeprograms">Whole Programs</a></div>
180 <div class="doc_text">
182 <p>Whole Programs are pieces of code which can be compiled and linked into a
183 stand-alone program that can be executed. These programs are generally written
184 in high level languages such as C or C++, but sometimes they are written
185 straight in LLVM assembly.</p>
187 <p>These programs are compiled and then executed using several different
188 methods (native compiler, LLVM C backend, LLVM JIT, LLVM native code generation,
189 etc). The output of these programs is compared to ensure that LLVM is compiling
190 the program correctly.</p>
192 <p>In addition to compiling and executing programs, whole program tests serve as
193 a way of benchmarking LLVM performance, both in terms of the efficiency of the
194 programs generated as well as the speed with which LLVM compiles, optimizes, and
197 <p>All "whole program" tests are located in the <tt>llvm-test</tt> CVS
202 <!--=========================================================================-->
203 <div class="doc_section"><a name="tree">LLVM Test Suite Tree</a></div>
204 <!--=========================================================================-->
206 <div class="doc_text">
208 <p>Each type of test in the LLVM test suite has its own directory. The major
209 subtrees of the test suite directory tree are as follows:</p>
212 <li><tt>llvm/test/Features</tt>
213 <p>This directory contains sample codes that test various features of the
214 LLVM language. These pieces of sample code are run through various
215 assembler, disassembler, and optimizer passes.</p>
218 <li><tt>llvm/test/Regression</tt>
219 <p>This directory contains regression tests for LLVM. When a bug is found
220 in LLVM, a regression test containing just enough code to reproduce the
221 problem should be written and placed somewhere underneath this directory.
222 In most cases, this will be a small piece of LLVM assembly language code,
223 often distilled from an actual application or benchmark.</p>
226 <li><tt>llvm-test</tt>
227 <p>The <tt>llvm-test</tt> CVS module contains programs that can be compiled
228 with LLVM and executed. These programs are compiled using the native compiler
229 and various LLVM backends. The output from the program compiled with the
230 native compiler is assumed correct; the results from the other programs are
231 compared to the native program output and pass if they match.</p>
233 <p>In addition for testing correctness, the <tt>llvm-test</tt> directory also
234 performs timing tests of various LLVM optimizations. It also records
235 compilation times for the compilers and the JIT. This information can be
236 used to compare the effectiveness of LLVM's optimizations and code
239 <li><tt>llvm-test/SingleSource</tt>
240 <p>The SingleSource directory contains test programs that are only a single
241 source file in size. These are usually small benchmark programs or small
242 programs that calculate a particular value. Several such programs are grouped
243 together in each directory.</p></li>
245 <li><tt>llvm-test/MultiSource</tt>
246 <p>The MultiSource directory contains subdirectories which contain entire
247 programs with multiple source files. Large benchmarks and whole applications
250 <li><tt>llvm-test/External</tt>
251 <p>The External directory contains Makefiles for building code that is external
252 to (i.e., not distributed with) LLVM. The most prominent members of this
253 directory are the SPEC 95 and SPEC 2000 benchmark suites. The presence and
254 location of these external programs is configured by the llvm-test
255 <tt>configure</tt> script.</p></li>
260 <!--=========================================================================-->
261 <div class="doc_section"><a name="dgstructure">DejaGNU Structure</a></div>
262 <!--=========================================================================-->
264 <div class="doc_text">
265 <p>The LLVM test suite is partially driven by DejaGNU and partially
266 driven by GNU Make. Specifically, the Features and Regression tests
267 are all driven by DejaGNU. The <tt>llvm-test</tt>
268 module is currently driven by a set of Makefiles.</p>
270 <p>The DejaGNU structure is very simple, but does require some
271 information to be set. This information is gathered via <tt>configure</tt> and
272 is written to a file, <tt>site.exp</tt> in <tt>llvm/test</tt>. The
274 Makefile does this work for you.</p>
276 <p>In order for DejaGNU to work, each directory of tests must have a
277 <tt>dg.exp</tt> file. This file is a program written in tcl that calls
278 the <tt>llvm-runtests</tt> procedure on each test file. The
279 llvm-runtests procedure is defined in
280 <tt>llvm/test/lib/llvm-dg.exp</tt>. Any directory that contains only
281 directories does not need the <tt>dg.exp</tt> file.</p>
283 <p>In order for a test to be run, it must contain information within
284 the test file on how to run the test. These are called <tt>RUN</tt>
285 lines. Run lines are specified in the comments of the test program
286 using the keyword <tt>RUN</tt> followed by a colon, and lastly the
287 commands to execute. These commands will be executed in a bash script,
288 so any bash syntax is acceptable. You can specify as many RUN lines as
289 necessary. Each RUN line translates to one line in the resulting bash
290 script. Below is an example of legal RUN lines in a <tt>.ll</tt>
293 ; RUN: llvm-as < %s | llvm-dis > %t1
294 ; RUN: llvm-dis < %s.bc-13 > %t2
297 <p>There are a couple patterns within a <tt>RUN</tt> line that the
298 llvm-runtest procedure looks for and replaces with the appropriate
301 <dl style="margin-left: 25px">
303 <dd>The path to the source directory. This is for locating
304 any supporting files that are not generated by the test, but used by
307 <dd>The test file.</dd>
310 <dd>Temporary filename: testscript.test_filename.tmp, where
311 test_filename is the name of the test file. All temporary files are
312 placed in the Output directory within the directory the test is
316 <dd>Path to a script that performs grep -C. Use this since not all
317 platforms support grep -C.</dd>
319 <dt>%llvmgcc</dt> <dd>Full path to the llvm-gcc executable.</dd>
320 <dt>%llvmgxx</dt> <dd>Full path to the llvm-g++ executable.</dd>
323 <p>There are also several scripts in the llvm/test/Scripts directory
324 that you might find useful when writing <tt>RUN</tt> lines.</p>
326 <p>Lastly, you can easily mark a test that is expected to fail on a
327 specific platform or with a specific version of llvmgcc by using the
328 <tt>XFAIL</tt> keyword. Xfail lines are
329 specified in the comments of the test program using <tt>XFAIL</tt>,
330 followed by a colon, and one or more regular expressions (separated by
331 a comma) that will match against the target triplet or llvmgcc version for the
332 machine. You can use * to match all targets. You can specify the major or full
333 version (i.e. 3.4) for llvmgcc. Here is an example of an
334 <tt>XFAIL</tt> line:</p>
336 ; XFAIL: darwin,sun,llvmgcc4
341 <!--=========================================================================-->
342 <div class="doc_section"><a name="progstructure"><tt>llvm-test</tt>
344 <!--=========================================================================-->
346 <div class="doc_text">
348 <p>As mentioned previously, the <tt>llvm-test</tt> module provides three types
349 of tests: MultiSource, SingleSource, and External. Each tree is then subdivided
350 into several categories, including applications, benchmarks, regression tests,
351 code that is strange grammatically, etc. These organizations should be
352 relatively self explanatory.</p>
354 <p>In addition to the regular "whole program" tests, the <tt>llvm-test</tt>
355 module also provides a mechanism for compiling the programs in different ways.
356 If the variable TEST is defined on the gmake command line, the test system will
357 include a Makefile named <tt>TEST.<value of TEST variable>.Makefile</tt>.
358 This Makefile can modify build rules to yield different results.</p>
360 <p>For example, the LLVM nightly tester uses <tt>TEST.nightly.Makefile</tt> to
361 create the nightly test reports. To run the nightly tests, run <tt>gmake
362 TEST=nightly</tt>.</p>
364 <p>There are several TEST Makefiles available in the tree. Some of them are
365 designed for internal LLVM research and will not work outside of the LLVM
366 research group. They may still be valuable, however, as a guide to writing your
367 own TEST Makefile for any optimization or analysis passes that you develop with
370 <p>Note, when configuring the <tt>llvm-test</tt> module, you might want to
371 specify the following configuration options:</p>
373 <dt><i>--enable-spec2000</i>
374 <dt><i>--enable-spec2000=<<tt>directory</tt>></i>
376 Enable the use of SPEC2000 when testing LLVM. This is disabled by default
377 (unless <tt>configure</tt> finds SPEC2000 installed). By specifying
378 <tt>directory</tt>, you can tell configure where to find the SPEC2000
379 benchmarks. If <tt>directory</tt> is left unspecified, <tt>configure</tt>
380 uses the default value
381 <tt>/home/vadve/shared/benchmarks/speccpu2000/benchspec</tt>.
383 <dt><i>--enable-spec95</i>
384 <dt><i>--enable-spec95=<<tt>directory</tt>></i>
386 Enable the use of SPEC95 when testing LLVM. It is similar to the
387 <i>--enable-spec2000</i> option.
389 <dt><i>--enable-povray</i>
390 <dt><i>--enable-povray=<<tt>directory</tt>></i>
392 Enable the use of Povray as an external test. Versions of Povray written
393 in C should work. This option is similar to the <i>--enable-spec2000</i>
398 <!--=========================================================================-->
399 <div class="doc_section"><a name="run">Running the LLVM Tests</a></div>
400 <!--=========================================================================-->
402 <div class="doc_text">
404 <p>First, all tests are executed within the LLVM object directory tree. They
405 <i>are not</i> executed inside of the LLVM source tree. This is because the
406 test suite creates temporary files during execution.</p>
408 <p>The master Makefile in llvm/test is capable of running only the DejaGNU
409 driven tests. By default, it will run all of these tests.</p>
411 <p>To run only the DejaGNU driven tests, run <tt>gmake</tt> at the
412 command line in <tt>llvm/test</tt>. To run a specific directory of tests, use
413 the TESTSUITE variable.
416 <p>For example, to run the Regression tests, type
417 <tt>gmake TESTSUITE=Regression</tt> in <tt>llvm/tests</tt>.</p>
419 <p>Note that there are no Makefiles in <tt>llvm/test/Features</tt> and
420 <tt>llvm/test/Regression</tt>. You must use DejaGNU from the <tt>llvm/test</tt>
421 directory to run them.</p>
423 <p>To run the <tt>llvm-test</tt> suite, you need to use the following steps:
426 <li>cd into the llvm/projects directory</li>
427 <li>check out the <tt>llvm-test</tt> module with:<br/>
428 <tt>cvs -d :pserver:anon@llvm.org:/var/cvs/llvm co -PR llvm-test</tt><br>
429 This will get the test suite into <tt>llvm/projects/llvm-test</tt></li>
430 <li>configure the test suite. You can do this one of two ways:
432 <li>Use the regular llvm configure:<br/>
433 <tt>cd $LLVM_OBJ_ROOT ; $LLVM_SRC_ROOT/configure</tt><br/>
434 This will ensure that the <tt>projects/llvm-test</tt> directory is also
435 properly configured.</li>
436 <li>Use the <tt>configure</tt> script found in the <tt>llvm-test</tt> source
438 <tt>$LLVM_SRC_ROOT/projects/llvm-test/configure
439 --with-llvmsrc=$LLVM_SRC_ROOT --with-llvmobj=$LLVM_OBJ_ROOT</tt>
444 <p>Note that the second and third steps only need to be done once. After you
445 have the suite checked out and configured, you don't need to do it again (unless
446 the test code or configure script changes).</p>
448 <p>To make a specialized test (use one of the
449 <tt>llvm-test/TEST.<type>.Makefile</tt>s), just run:<br/>
450 <tt>gmake TEST=<type> test</tt><br/>For example, you could run the
451 nightly tester tests using the following commands:</p>
454 % cd llvm/projects/llvm-test
455 % gmake TEST=nightly test
458 <p>Regardless of which test you're running, the results are printed on standard
459 output and standard error. You can redirect these results to a file if you
462 <p>Some tests are known to fail. Some are bugs that we have not fixed yet;
463 others are features that we haven't added yet (or may never add). In DejaGNU,
464 the result for such tests will be XFAIL (eXpected FAILure). In this way, you
465 can tell the difference between an expected and unexpected failure.</p>
467 <p>The tests in <tt>llvm-test</tt> have no such feature at this time. If the
468 test passes, only warnings and other miscellaneous output will be generated. If
469 a test fails, a large <program> FAILED message will be displayed. This
470 will help you separate benign warnings from actual test failures.</p>
474 <!--=========================================================================-->
475 <div class="doc_section"><a name="nightly">Running the nightly tester</a></div>
476 <!--=========================================================================-->
478 <div class="doc_text">
481 The <a href="http://llvm.org/testresults/">LLVM Nightly Testers</a>
482 automatically check out an LLVM tree, build it, run the "nightly"
483 program test (described above), run all of the feature and regression tests,
484 and then delete the checked out tree. This tester is designed to ensure that
485 programs don't break as well as keep track of LLVM's progress over time.</p>
487 <p>If you'd like to set up an instance of the nightly tester to run on your
488 machine, take a look at the comments at the top of the
489 <tt>utils/NightlyTester.pl</tt> file. We usually run it from a crontab entry
490 that looks like this:</p>
492 <div class="doc_code">
494 5 3 * * * $HOME/llvm/utils/NightlyTest.pl -parallel $CVSROOT \
495 $HOME/buildtest $HOME/cvs/testresults
499 <p>Or, you can create a shell script to encapsulate the running of the script.
500 The optimized x86 Linux nightly test is run from just such a script:</p>
502 <div class="doc_code">
505 BASE=/proj/work/llvm/nightlytest
506 export CVSROOT=:pserver:anon@llvm.org:/var/cvs/llvm
507 export BUILDDIR=$BASE/build
508 export WEBDIR=$BASE/testresults
509 export LLVMGCCDIR=/proj/work/llvm/cfrontend/install
510 export PATH=/proj/install/bin:$LLVMGCCDIR/bin:$PATH
511 export LD_LIBRARY_PATH=/proj/install/lib
513 cp /proj/work/llvm/llvm/utils/NightlyTest.pl .
514 nice ./NightlyTest.pl -nice -release -verbose -parallel -enable-linscan \
515 -noexternals 2>&1 > output.log
516 mail -s 'X86 nightly tester results' <a href="http://mail.cs.uiuc.edu/mailman/\
517 listinfo/llvm-testresults">llvm-testresults@cs.uiuc.edu</a> < output.log
521 <p>Take a look at the <tt>NightlyTest.pl</tt> file to see what all of the flags
522 and strings do. If you start running the nightly tests, please let us know and
523 we'll link your page to the global tester page. Thanks!</p>
527 <!-- *********************************************************************** -->
531 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
532 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
533 <a href="http://validator.w3.org/check/referer"><img
534 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
536 John T. Criswell, Reid Spencer, and Tanya Lattner<br>
537 <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br/>
538 Last modified: $Date$