fix and cleanup constmul code a bit, this fixes mediabench/toast and
[oota-llvm.git] / docs / TestingGuide.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2                       "http://www.w3.org/TR/html4/strict.dtd">
3 <html>
4 <head>
5   <title>LLVM Test Suite Guide</title>
6   <link rel="stylesheet" href="llvm.css" type="text/css">
7 </head>
8 <body>
9       
10 <div class="doc_title">
11   LLVM Test Suite Guide
12 </div>
13
14 <ol>
15   <li><a href="#overview">Overview</a></li>
16   <li><a href="#Requirements">Requirements</a></li>
17   <li><a href="#quick">Quick Start</a></li>
18   <li><a href="#org">LLVM Test Suite Organization</a>
19     <ul>
20       <li><a href="#codefragments">Code Fragments</a></li>
21       <li><a href="#wholeprograms">Whole Programs</a></li>
22     </ul>
23   </li>
24   <li><a href="#tree">LLVM Test Suite Tree</a></li>
25   <li><a href="#dgstructure">DejaGNU Structure</a></li>
26   <li><a href="#progstructure"><tt>llvm-test</tt> Structure</a></li>
27   <li><a href="#run">Running the LLVM Tests</a></li>
28   <li><a href="#nightly">Running the nightly tester</a></li>
29 </ol>
30
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>
34 </div>
35
36 <!--=========================================================================-->
37 <div class="doc_section"><a name="overview">Overview</a></div>
38 <!--=========================================================================-->
39
40 <div class="doc_text">
41
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
44 and run tests.</p>
45
46 </div>
47
48 <!--=========================================================================-->
49 <div class="doc_section"><a name="Requirements">Requirements</a></div>
50 <!--=========================================================================-->
51
52 <div class="doc_text">
53
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>
56
57 <dl>
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>
64
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>:
76
77 <ul>
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>
82
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>
89 </ul></dd>
90 </dl>
91 </div>
92
93 <!--=========================================================================-->
94 <div class="doc_section"><a name="quick">Quick Start</a></div>
95 <!--=========================================================================-->
96
97 <div class="doc_text">
98
99 <p>The tests are located in two separate CVS modules. The basic feature and 
100 regression tests are in the main "llvm" module under the directory 
101 <tt>llvm/test</tt>. A more comprehensive test suite that includes whole 
102 programs in C and C++ is in the <tt>llvm-test</tt> module. This module should 
103 be checked out to the <tt>llvm/projects</tt> directory. When you
104 <tt>configure</tt> the <tt>llvm</tt> module, the <tt>llvm-test</tt> module
105 will be automatically configured. Alternatively, you can configure the <tt>llvm-test</tt> module manually.</p>
106 <p>To run all of the simple tests in LLVM using DejaGNU, use the master Makefile in the
107 <tt>llvm/test</tt> directory:</p>
108 <pre>
109 % gmake -C llvm/test
110 </pre>
111 or<br>
112 <pre>
113 % gmake check
114 </pre>
115 <p>To run only a subdirectory of tests in llvm/test using DejaGNU (ie. Regression/Transforms). Just substitute the path to the subdirectory:</p>
116 <pre>
117 % gmake -C llvm/test TESTSUITE=Regression/Transforms
118 </pre>
119
120 <p><b>Note: If you are running the tests with <tt>objdir != subdir</tt> you must
121 have run the complete testsuite before you can specify a subdirectory.</b></p>
122
123 <p>To run the comprehensive test suite (tests that compile and execute whole 
124 programs), run the <tt>llvm-test</tt> tests:</p>
125
126 <pre>
127 % cd llvm/projects
128 % cvs co llvm-test
129 % cd llvm-test
130 % ./configure --with-llvmsrc=$LLVM_SRC_ROOT --with-llvmobj=$LLVM_OBJ_ROOT
131 % gmake
132 </pre>
133
134 </div>
135
136 <!--=========================================================================-->
137 <div class="doc_section"><a name="org">LLVM Test Suite Organization</a></div>
138 <!--=========================================================================-->
139
140 <div class="doc_text">
141
142 <p>The LLVM test suite contains two major categories of tests: code
143 fragments and whole programs. Code fragments are in the <tt>llvm</tt> module
144 under the directory under the <tt>llvm/test</tt> directory. The whole programs
145 test suite are in the <tt>llvm-test</tt> module under the main directory.</p>
146
147 </div>
148
149 <div class="doc_subsection"><a name="codefragments">Code Fragments</a> 
150 </div>
151
152 <div class="doc_text">
153
154 <p>Code fragments are small pieces of code that test a specific feature of LLVM
155 or trigger a specific bug in LLVM.  They are usually written in LLVM assembly
156 language, but can be written in other languages if the test targets a particular
157 language front end.</p>
158
159 <p>Code fragments are not complete programs, and they are never executed to
160 determine correct behavior.</p> 
161
162 <p>These code fragment tests are located in the <tt>llvm/test/Features</tt> and 
163 <tt>llvm/test/Regression</tt> directories.</p>
164
165 </div>
166
167 <div class="doc_subsection"><a name="wholeprograms">Whole Programs</a></div>
168
169 <div class="doc_text">
170
171 <p>Whole Programs are pieces of code which can be compiled and linked into a
172 stand-alone program that can be executed.  These programs are generally written
173 in high level languages such as C or C++, but sometimes they are written
174 straight in LLVM assembly.</p>
175
176 <p>These programs are compiled and then executed using several different
177 methods (native compiler, LLVM C backend, LLVM JIT, LLVM native code generation,
178 etc).  The output of these programs is compared to ensure that LLVM is compiling
179 the program correctly.</p>
180
181 <p>In addition to compiling and executing programs, whole program tests serve as
182 a way of benchmarking LLVM performance, both in terms of the efficiency of the
183 programs generated as well as the speed with which LLVM compiles, optimizes, and
184 generates code.</p>
185
186 <p>All "whole program" tests are located in the <tt>llvm-test</tt> CVS
187 module.</p> 
188
189 </div>
190
191 <!--=========================================================================-->
192 <div class="doc_section"><a name="tree">LLVM Test Suite Tree</a></div>
193 <!--=========================================================================-->
194
195 <div class="doc_text">
196
197 <p>Each type of test in the LLVM test suite has its own directory. The major
198 subtrees of the test suite directory tree are as follows:</p>
199     
200 <ul>
201 <li><tt>llvm/test/Features</tt>
202 <p>This directory contains sample codes that test various features of the
203 LLVM language.  These pieces of sample code are run through various
204 assembler, disassembler, and optimizer passes.</p>
205 </li>
206
207 <li><tt>llvm/test/Regression</tt>
208 <p>This directory contains regression tests for LLVM.  When a bug is found
209 in LLVM, a regression test containing just enough code to reproduce the
210 problem should be written and placed somewhere underneath this directory.
211 In most cases, this will be a small piece of LLVM assembly language code,
212 often distilled from an actual application or benchmark.</p>
213 </li>
214
215 <li><tt>llvm-test</tt>
216 <p>The <tt>llvm-test</tt> CVS module contains programs that can be compiled 
217 with LLVM and executed.  These programs are compiled using the native compiler
218 and various LLVM backends.  The output from the program compiled with the 
219 native compiler is assumed correct; the results from the other programs are
220 compared to the native program output and pass if they match.</p>
221
222 <p>In addition for testing correctness, the <tt>llvm-test</tt> directory also
223 performs timing tests of various LLVM optimizations.  It also records
224 compilation times for the compilers and the JIT.  This information can be
225 used to compare the effectiveness of LLVM's optimizations and code
226 generation.</p></li>
227
228 <li><tt>llvm-test/SingleSource</tt>
229 <p>The SingleSource directory contains test programs that are only a single 
230 source file in size.  These are usually small benchmark programs or small 
231 programs that calculate a particular value.  Several such programs are grouped 
232 together in each directory.</p></li>
233
234 <li><tt>llvm-test/MultiSource</tt>
235 <p>The MultiSource directory contains subdirectories which contain entire 
236 programs with multiple source files.  Large benchmarks and whole applications 
237 go here.</p></li>
238
239 <li><tt>llvm-test/External</tt>
240 <p>The External directory contains Makefiles for building code that is external
241 to (i.e., not distributed with) LLVM.  The most prominent members of this
242 directory are the SPEC 95 and SPEC 2000 benchmark suites.  The presence and
243 location of these external programs is configured by the llvm-test
244 <tt>configure</tt> script.</p></li>
245       
246 </ul>
247
248 </div>
249 <!--=========================================================================-->
250 <div class="doc_section"><a name="dgstructure">DejaGNU Structure</a></div>
251 <!--=========================================================================-->
252
253 <div class="doc_text">
254 <p>The LLVM test suite is partially driven by DejaGNU and partially
255 driven by GNU Make. Specifically, the Features and Regression tests
256 are all driven by DejaGNU. The <tt>llvm-test</tt>
257 module is currently driven by a set of Makefiles.</p>
258
259 <p>The DejaGNU structure is very simple, but does require some
260 information to be set. This information is gathered via <tt>configure</tt> and
261 is written to a file, <tt>site.exp</tt> in <tt>llvm/test</tt>. The
262 <tt>llvm/test</tt>
263 Makefile does this work for you.</p>
264
265 <p>In order for DejaGNU to work, each directory of tests must have a
266 <tt>dg.exp</tt> file. This file is a program written in tcl that calls
267 the <tt>llvm-runtests</tt> procedure on each test file. The
268 llvm-runtests procedure is defined in
269 <tt>llvm/test/lib/llvm-dg.exp</tt>. Any directory that contains only
270 directories does not need the <tt>dg.exp</tt> file.</p>
271
272 <p>In order for a test to be run, it must contain information within
273 the test file on how to run the test. These are called <tt>RUN</tt>
274 lines. Run lines are specified in the comments of the test program
275 using the keyword <tt>RUN</tt> followed by a colon, and lastly the
276 commands to execute. These commands will be executed in a bash script,
277 so any bash syntax is acceptable. You can specify as many RUN lines as
278 necessary.  Each RUN line translates to one line in the resulting bash
279 script. Below is an example of legal RUN lines in a <tt>.ll</tt>
280 file:</p>
281 <pre>
282 ; RUN: llvm-as < %s | llvm-dis > %t1
283 ; RUN: llvm-dis < %s.bc-13 > %t2
284 ; RUN: diff %t1 %t2
285 </pre>
286 <p>There are a couple patterns within a <tt>RUN</tt> line that the
287 llvm-runtest procedure looks for and replaces with the appropriate
288 syntax:</p>
289
290 <dl style="margin-left: 25px">
291 <dt>%p</dt> 
292 <dd>The path to the source directory. This is for locating
293 any supporting files that are not generated by the test, but used by
294 the test.</dd> 
295 <dt>%s</dt> 
296 <dd>The test file.</dd> 
297
298 <dt>%t</dt>
299 <dd>Temporary filename: testscript.test_filename.tmp, where
300 test_filename is the name of the test file. All temporary files are
301 placed in the Output directory within the directory the test is
302 located.</dd> 
303
304 <dt>%prcontext</dt> 
305 <dd>Path to a script that performs grep -C. Use this since not all
306 platforms support grep -C.</dd>
307
308 <dt>%llvmgcc</dt> <dd>Full path to the llvm-gcc executable.</dd>
309 <dt>%llvmgxx</dt> <dd>Full path to the llvm-g++ executable.</dd>
310 </dl>
311
312 <p>There are also several scripts in the llvm/test/Scripts directory
313 that you might find useful when writing <tt>RUN</tt> lines.</p>
314
315 <p>Lastly, you can easily mark a test that is expected to fail on a
316 specific platform by using the <tt>XFAIL</tt> keyword. Xfail lines are
317 specified in the comments of the test program using <tt>XFAIL</tt>,
318 followed by a colon, and one or more regular expressions (separated by
319 a comma) that will match against the target triplet for the
320 machine. You can use * to match all targets. Here is an example of an
321 <tt>XFAIL</tt> line:</p>
322 <pre>
323 ; XFAIL: darwin,sun
324 </pre>
325
326 </div>
327
328 <!--=========================================================================-->
329 <div class="doc_section"><a name="progstructure"><tt>llvm-test</tt> 
330 Structure</a></div>
331 <!--=========================================================================-->
332
333 <div class="doc_text">
334
335 <p>As mentioned previously, the <tt>llvm-test</tt> module  provides three types
336 of tests: MultiSource, SingleSource, and External.  Each tree is then subdivided
337 into several categories, including applications, benchmarks, regression tests,
338 code that is strange grammatically, etc.  These organizations should be
339 relatively self explanatory.</p>
340
341 <p>In addition to the regular "whole program"  tests, the <tt>llvm-test</tt>
342 module also provides a mechanism for compiling the programs in different ways.
343 If the variable TEST is defined on the gmake command line, the test system will
344 include a Makefile named <tt>TEST.&lt;value of TEST variable&gt;.Makefile</tt>.
345 This Makefile can modify build rules to yield different results.</p>
346
347 <p>For example, the LLVM nightly tester uses <tt>TEST.nightly.Makefile</tt> to
348 create the nightly test reports.  To run the nightly tests, run <tt>gmake
349 TEST=nightly</tt>.</p>
350
351 <p>There are several TEST Makefiles available in the tree.  Some of them are
352 designed for internal LLVM research and will not work outside of the LLVM
353 research group.  They may still be valuable, however, as a guide to writing your
354 own TEST Makefile for any optimization or analysis passes that you develop with
355 LLVM.</p>
356
357 <p>Note, when configuring the <tt>llvm-test</tt> module, you might want to
358 specify the following configuration options:</p>
359 <dl>
360   <dt><i>--enable-spec2000</i>
361   <dt><i>--enable-spec2000=&lt;<tt>directory</tt>&gt;</i>
362   <dd>
363     Enable the use of SPEC2000 when testing LLVM.  This is disabled by default
364     (unless <tt>configure</tt> finds SPEC2000 installed).  By specifying
365     <tt>directory</tt>, you can tell configure where to find the SPEC2000
366     benchmarks.  If <tt>directory</tt> is left unspecified, <tt>configure</tt>
367     uses the default value
368     <tt>/home/vadve/shared/benchmarks/speccpu2000/benchspec</tt>.
369     <p>
370   <dt><i>--enable-spec95</i>
371   <dt><i>--enable-spec95=&lt;<tt>directory</tt>&gt;</i>
372   <dd>
373     Enable the use of SPEC95 when testing LLVM.  It is similar to the
374     <i>--enable-spec2000</i> option.
375     <p>
376   <dt><i>--enable-povray</i>
377   <dt><i>--enable-povray=&lt;<tt>directory</tt>&gt;</i>
378   <dd>
379     Enable the use of Povray as an external test.  Versions of Povray written
380     in C should work.  This option is similar to the <i>--enable-spec2000</i>
381     option.
382 </dl>
383 </div>
384
385 <!--=========================================================================-->
386 <div class="doc_section"><a name="run">Running the LLVM Tests</a></div>
387 <!--=========================================================================-->
388
389 <div class="doc_text">
390
391 <p>First, all tests are executed within the LLVM object directory tree.  They
392 <i>are not</i> executed inside of the LLVM source tree. This is because the
393 test suite creates temporary files during execution.</p>
394
395 <p>The master Makefile in llvm/test is capable of running only the DejaGNU driven
396 tests. By default, it will run all of these tests.</p>
397
398 <p>To run only the DejaGNU driven tests, run <tt>gmake</tt> at the
399 command line in llvm/tests.  To run a specific directory of tests, use the
400 TESTSUITE variable.
401 </p>
402
403 <p>For example, to run the Regression tests, type 
404 <tt>gmake TESTSUITE=Regression</tt> in <tt>llvm/tests</tt>.</p>
405
406 <p>Note that there are no Makefiles in <tt>llvm/test/Features</tt> and
407 <tt>llvm/test/Regression</tt>. You must use DejaGNU from the <tt>llvm/test</tt>
408 directory to run them.</p>
409
410 <p>To run the <tt>llvm-test</tt> suite, you need to use the following steps:
411 </p>
412 <ol>
413   <li>cd into the llvm/projects directory</li>
414   <li>check out the <tt>llvm-test</tt> module with:<br/>
415   <tt>cvs -d :pserver:anon@llvm.cs.uiuc.edu:/var/cvs/llvm co -PR llvm-test</tt><br> 
416   This will get the test suite into <tt>llvm/projects/llvm-test</tt></li>
417   <li>configure the test suite. You can do this one of two ways:
418   <ol>
419     <li>Use the regular llvm configure:<br/>
420     <tt>cd $LLVM_OBJ_ROOT ; $LLVM_SRC_ROOT/configure</tt><br/>
421     This will ensure that the <tt>projects/llvm-test</tt> directory is also
422     properly configured.</li>
423     <li>Use the <tt>configure</tt> script found in the <tt>llvm-test</tt> source
424     directory:<br/>
425     <tt>$BUILD_SRC_DIR/configure --with-llvmsrc=$LLVM_SRC_ROOT --with-llvmobj=$LLVM_OBJ_ROOT</tt>
426     </li>
427   </ol>
428   <li>gmake</li>
429 </ol>
430 <p>Note that the second and third steps only need to be done once. After you
431 have the suite checked out and configured, you don't need to do it again (unless
432 the test code or configure script changes).</p>
433
434 <p>To make a specialized test (use one of the
435 <tt>llvm-test/TEST.&lt;type&gt;.Makefile</tt>s), just run:<br/>
436 <tt>gmake TEST=&lt;type&gt; test</tt><br/>For example, you could run the
437 nightly tester tests using the following commands:</p>
438
439 <pre>
440  % cd llvm/projects/llvm-test
441  % gmake TEST=nightly test
442 </pre>
443
444 <p>Regardless of which test you're running, the results are printed on standard
445 output and standard error.  You can redirect these results to a file if you
446 choose.</p>
447
448 <p>Some tests are known to fail.  Some are bugs that we have not fixed yet;
449 others are features that we haven't added yet (or may never add).  In DejaGNU,
450 the result for such tests will be XFAIL (eXpected FAILure).  In this way, you
451 can tell the difference between an expected and unexpected failure.</p>
452
453 <p>The tests in <tt>llvm-test</tt> have no such feature as of this time. If the
454 test passes, only warnings and other miscellaneous output will be generated.  If
455 a test fails, a large &lt;program&gt; FAILED message will be displayed.  This
456 will help you separate benign warnings from actual test failures.</p>
457
458 </div>
459
460 <!--=========================================================================-->
461 <div class="doc_section"><a name="nightly">Running the nightly tester</a></div>
462 <!--=========================================================================-->
463
464 <div class="doc_text">
465
466 <p>
467 The <a href="http://llvm.cs.uiuc.edu/testresults/">LLVM Nightly Testers</a>
468 automatically check out an LLVM tree, build it, run the "nightly" 
469 program test (described above), run  all of the feature and regression tests, 
470 and then delete the checked out tree.  This tester is designed to ensure that 
471 programs don't break as well as keep track of LLVM's progress over time.</p>
472
473 <p>If you'd like to set up an instance of the nightly tester to run on your
474 machine, take a look at the comments at the top of the
475 <tt>utils/NightlyTester.pl</tt> file.  We usually run it from a crontab entry
476 that looks ilke this:</p>
477
478 <div class="doc_code">
479 <pre>
480 5 3 * * *  $HOME/llvm/utils/NightlyTest.pl -parallel $CVSROOT $HOME/buildtest-X86 $HOME/cvs/testresults-X86
481 </pre>
482 </div>
483
484 <p>Or, you can create a shell script to encapsulate the running of the script.
485 The optimized x86 Linux nightly test is run from just such a script:</p>
486
487 <div class="doc_code">
488 <pre>
489 #!/bin/bash
490 BASE=/proj/work/llvm/nightlytest
491 export CVSROOT=:pserver:anon@llvm.cs.uiuc.edu:/var/cvs/llvm
492 export BUILDDIR=$BASE/build 
493 export WEBDIR=$BASE/testresults 
494 export LLVMGCCDIR=/proj/work/llvm/cfrontend/install
495 export PATH=/proj/install/bin:$LLVMGCCDIR/bin:$PATH
496 export LD_LIBRARY_PATH=/proj/install/lib
497 cd $BASE
498 cp /proj/work/llvm/llvm/utils/NightlyTest.pl .
499 nice ./NightlyTest.pl -nice -release -verbose -parallel -enable-linscan -noexternals 2&gt;&amp;1 &gt; output.log
500 mail -s 'X86 nightly tester results' <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-testresults">llvm-testresults@cs.uiuc.edu</a> &lt; output.log
501 </pre>
502 </div>
503
504 <p>Take a look at the <tt>NightlyTest.pl</tt> file to see what all of the flags
505 and strings do.  If you start running the nightly tests, please let us know and
506 we'll link your page to the global tester page.  Thanks!</p>
507
508 </div>
509
510 <!-- *********************************************************************** -->
511
512 <hr>
513 <address>
514   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
515   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
516   <a href="http://validator.w3.org/check/referer"><img
517   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
518
519   John T. Criswell<br>
520   <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br/>
521   Last modified: $Date$
522 </address>
523 </body>
524 </html>