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