Gitiles
Code Review Sign In
gerrit-public.fairphone.software / toolchain / llvm-project / 153827b0861100fb9069649a35d694db49d1e331 / . / llvm / docs / TestingGuide.html
blob: 2dd66d31c085537b7517ff72f84eae30802031ba [file] [log] [blame]
Misha Brukman773d6f62004-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 Criswelle90fc1f2003-10-10 18:42:49 +0000[diff] [blame]3<html>
Brian Gaeke739811d2003-10-23 18:10:28 +0000[diff] [blame]4<head>
Misha Brukman773d6f62004-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 Gaeke739811d2003-10-23 18:10:28 +0000[diff] [blame]7</head>
Brian Gaeke739811d2003-10-23 18:10:28 +0000[diff] [blame]8<body>
9
10<div class="doc_title">
11 LLVM Test Suite Guide
12</div>
John Criswelle90fc1f2003-10-10 18:42:49 +0000[diff] [blame]13
Brian Gaeke739811d2003-10-23 18:10:28 +0000[diff] [blame]14<ol>
Reid Spencer49fb40c2004-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 Lattner4d690182004-12-06 02:11:52 +0000[diff] [blame]25 <li><a href="#dgstructure">DejaGNU Structure</a></li>
Reid Spencer49fb40c2004-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 Gaeke739811d2003-10-23 18:10:28 +0000[diff] [blame]29</ol>
John Criswelle90fc1f2003-10-10 18:42:49 +0000[diff] [blame]30
Chris Lattner020e1fc2004-05-23 21:07:27 +0000[diff] [blame]31<div class="doc_author">
Tanya Lattner4d690182004-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 Lattner020e1fc2004-05-23 21:07:27 +0000[diff] [blame]34</div>
John Criswelle90fc1f2003-10-10 18:42:49 +0000[diff] [blame]35
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]36<!--=========================================================================-->
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]37<div class="doc_section"><a name="overview">Overview</a></div>
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]38<!--=========================================================================-->
John Criswelle90fc1f2003-10-10 18:42:49 +0000[diff] [blame]39
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]40<div class="doc_text">
John Criswelle90fc1f2003-10-10 18:42:49 +0000[diff] [blame]41
Misha Brukman773d6f62004-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 Criswelle90fc1f2003-10-10 18:42:49 +0000[diff] [blame]45
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]46</div>
John Criswelle90fc1f2003-10-10 18:42:49 +0000[diff] [blame]47
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]48<!--=========================================================================-->
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]49<div class="doc_section"><a name="Requirements">Requirements</a></div>
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]50<!--=========================================================================-->
John Criswelle90fc1f2003-10-10 18:42:49 +0000[diff] [blame]51
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]52<div class="doc_text">
John Criswelle90fc1f2003-10-10 18:42:49 +0000[diff] [blame]53
Misha Brukman773d6f62004-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 Criswelle90fc1f2003-10-10 18:42:49 +0000[diff] [blame]56
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]57<dl>
Tanya Lattner4d690182004-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 Lattner9a1b8932004-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 Criswelle90fc1f2003-10-10 18:42:49 +0000[diff] [blame]64
Reid Spencer9f16cad2004-11-01 08:26:25 +0000[diff] [blame]65<dt><a href="http://www.netlib.org/f2c">F2C</a></dt>
Misha Brukmaned3dc432004-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>
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]91</div>
John Criswelle90fc1f2003-10-10 18:42:49 +0000[diff] [blame]92
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]93<!--=========================================================================-->
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]94<div class="doc_section"><a name="quick">Quick Start</a></div>
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]95<!--=========================================================================-->
John Criswelle90fc1f2003-10-10 18:42:49 +0000[diff] [blame]96
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]97<div class="doc_text">
Brian Gaeke739811d2003-10-23 18:10:28 +0000[diff] [blame]98
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]99<p>The tests are located in two separate CVS modules. The basic feature and
100regression tests are in the main "llvm" module under the directory
101<tt>llvm/test</tt>. A more comprehensive test suite that includes whole
102programs in C and C++ is in the <tt>llvm-test</tt> module. This module should
103be 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
John Criswelldfe6a862004-12-10 15:51:16 +0000[diff] [blame]105will be automatically configured. Alternatively, you can configure the <tt>llvm-test</tt> module manually.</p>
Tanya Lattner4d690182004-12-06 02:11:52 +0000[diff] [blame]106<p>To run all of the simple tests in LLVM using DejaGNU, use the master Makefile in the
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]107<tt>llvm/test</tt> directory:</p>
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]108<pre>
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]109% gmake -C llvm/test
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]110</pre>
Tanya Lattner4d690182004-12-06 02:11:52 +0000[diff] [blame]111or<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>
Misha Brukman5da60ba2005-03-10 22:51:59 +0000[diff] [blame]119
120<p><b>Note: If you are running the tests with <tt>objdir != subdir</tt> you must
121have run the complete testsuite before you can specify a subdirectory.</b></p>
John Criswelle90fc1f2003-10-10 18:42:49 +0000[diff] [blame]122
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]123<p>To run the comprehensive test suite (tests that compile and execute whole
124programs), run the <tt>llvm-test</tt> tests:</p>
John Criswelle90fc1f2003-10-10 18:42:49 +0000[diff] [blame]125
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]126<pre>
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]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
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]132</pre>
133
134</div>
135
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]136<!--=========================================================================-->
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]137<div class="doc_section"><a name="org">LLVM Test Suite Organization</a></div>
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]138<!--=========================================================================-->
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]139
140<div class="doc_text">
141
142<p>The LLVM test suite contains two major categories of tests: code
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]143fragments and whole programs. Code fragments are in the <tt>llvm</tt> module
144under the directory under the <tt>llvm/test</tt> directory. The whole programs
John Criswelldfe6a862004-12-10 15:51:16 +0000[diff] [blame]145test suite are in the <tt>llvm-test</tt> module under the main directory.</p>
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]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
155or trigger a specific bug in LLVM. They are usually written in LLVM assembly
156language, but can be written in other languages if the test targets a particular
157language front end.</p>
158
159<p>Code fragments are not complete programs, and they are never executed to
160determine correct behavior.</p>
161
Tanya Lattner4d690182004-12-06 02:11:52 +0000[diff] [blame]162<p>These code fragment tests are located in the <tt>llvm/test/Features</tt> and
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]163<tt>llvm/test/Regression</tt> directories.</p>
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]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
172stand-alone program that can be executed. These programs are generally written
173in high level languages such as C or C++, but sometimes they are written
174straight in LLVM assembly.</p>
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]175
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]176<p>These programs are compiled and then executed using several different
177methods (native compiler, LLVM C backend, LLVM JIT, LLVM native code generation,
178etc). The output of these programs is compared to ensure that LLVM is compiling
179the program correctly.</p>
180
181<p>In addition to compiling and executing programs, whole program tests serve as
182a way of benchmarking LLVM performance, both in terms of the efficiency of the
183programs generated as well as the speed with which LLVM compiles, optimizes, and
184generates code.</p>
185
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]186<p>All "whole program" tests are located in the <tt>llvm-test</tt> CVS
187module.</p>
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]188
189</div>
190
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]191<!--=========================================================================-->
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]192<div class="doc_section"><a name="tree">LLVM Test Suite Tree</a></div>
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]193<!--=========================================================================-->
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]194
195<div class="doc_text">
196
197<p>Each type of test in the LLVM test suite has its own directory. The major
198subtrees of the test suite directory tree are as follows:</p>
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]199
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]200<ul>
201<li><tt>llvm/test/Features</tt>
202<p>This directory contains sample codes that test various features of the
203LLVM language. These pieces of sample code are run through various
204assembler, disassembler, and optimizer passes.</p>
205</li>
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]206
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]207<li><tt>llvm/test/Regression</tt>
208<p>This directory contains regression tests for LLVM. When a bug is found
209in LLVM, a regression test containing just enough code to reproduce the
210problem should be written and placed somewhere underneath this directory.
211In most cases, this will be a small piece of LLVM assembly language code,
212often distilled from an actual application or benchmark.</p>
213</li>
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]214
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]215<li><tt>llvm-test</tt>
216<p>The <tt>llvm-test</tt> CVS module contains programs that can be compiled
217with LLVM and executed. These programs are compiled using the native compiler
218and various LLVM backends. The output from the program compiled with the
219native compiler is assumed correct; the results from the other programs are
Misha Brukman8d08d362004-10-08 00:41:27 +0000[diff] [blame]220compared to the native program output and pass if they match.</p>
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]221
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]222<p>In addition for testing correctness, the <tt>llvm-test</tt> directory also
223performs timing tests of various LLVM optimizations. It also records
224compilation times for the compilers and the JIT. This information can be
225used to compare the effectiveness of LLVM's optimizations and code
226generation.</p></li>
John Criswelle90fc1f2003-10-10 18:42:49 +0000[diff] [blame]227
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]228<li><tt>llvm-test/SingleSource</tt>
229<p>The SingleSource directory contains test programs that are only a single
230source file in size. These are usually small benchmark programs or small
231programs that calculate a particular value. Several such programs are grouped
232together in each directory.</p></li>
233
234<li><tt>llvm-test/MultiSource</tt>
235<p>The MultiSource directory contains subdirectories which contain entire
236programs with multiple source files. Large benchmarks and whole applications
237go here.</p></li>
238
239<li><tt>llvm-test/External</tt>
Misha Brukman8d08d362004-10-08 00:41:27 +0000[diff] [blame]240<p>The External directory contains Makefiles for building code that is external
241to (i.e., not distributed with) LLVM. The most prominent members of this
242directory are the SPEC 95 and SPEC 2000 benchmark suites. The presence and
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]243location of these external programs is configured by the llvm-test
244<tt>configure</tt> script.</p></li>
245
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]246</ul>
Brian Gaeke739811d2003-10-23 18:10:28 +0000[diff] [blame]247
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]248</div>
Tanya Lattner4d690182004-12-06 02:11:52 +0000[diff] [blame]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
255driven by GNU Make. Specifically, the Features and Regression tests
John Criswelldfe6a862004-12-10 15:51:16 +0000[diff] [blame]256are all driven by DejaGNU. The <tt>llvm-test</tt>
Tanya Lattner4d690182004-12-06 02:11:52 +0000[diff] [blame]257module is currently driven by a set of Makefiles.</p>
258
259<p>The DejaGNU structure is very simple, but does require some
John Criswelldfe6a862004-12-10 15:51:16 +0000[diff] [blame]260information to be set. This information is gathered via <tt>configure</tt> and
261is written to a file, <tt>site.exp</tt> in <tt>llvm/test</tt>. The
262<tt>llvm/test</tt>
Tanya Lattner4d690182004-12-06 02:11:52 +0000[diff] [blame]263Makefile 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
267the <tt>llvm-runtests</tt> procedure on each test file. The
268llvm-runtests procedure is defined in
269<tt>llvm/test/lib/llvm-dg.exp</tt>. Any directory that contains only
270directories 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
273the test file on how to run the test. These are called <tt>RUN</tt>
274lines. Run lines are specified in the comments of the test program
275using the keyword <tt>RUN</tt> followed by a colon, and lastly the
276commands to execute. These commands will be executed in a bash script,
277so any bash syntax is acceptable. You can specify as many RUN lines as
278necessary. Each RUN line translates to one line in the resulting bash
279script. Below is an example of legal RUN lines in a <tt>.ll</tt>
280file:</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
287llvm-runtest procedure looks for and replaces with the appropriate
288syntax:</p>
Misha Brukman5da60ba2005-03-10 22:51:59 +0000[diff] [blame]289
290<dl style="margin-left: 25px">
Tanya Lattner4d690182004-12-06 02:11:52 +0000[diff] [blame]291<dt>%p</dt>
292<dd>The path to the source directory. This is for locating
293any supporting files that are not generated by the test, but used by
294the test.</dd>
295<dt>%s</dt>
296<dd>The test file.</dd>
297
Tanya Lattnerd8697042004-12-08 17:37:21 +0000[diff] [blame]298<dt>%t</dt>
Tanya Lattner4d690182004-12-06 02:11:52 +0000[diff] [blame]299<dd>Temporary filename: testscript.test_filename.tmp, where
300test_filename is the name of the test file. All temporary files are
301placed in the Output directory within the directory the test is
302located.</dd>
303
304<dt>%prcontext</dt>
305<dd>Path to a script that performs grep -C. Use this since not all
306platforms support grep -C.</dd>
307
Reid Spencer31bf9a02004-12-22 06:45:24 +0000[diff] [blame]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>
Misha Brukman5da60ba2005-03-10 22:51:59 +0000[diff] [blame]310</dl>
Tanya Lattner4d690182004-12-06 02:11:52 +0000[diff] [blame]311
312<p>There are also several scripts in the llvm/test/Scripts directory
313that 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
316specific platform by using the <tt>XFAIL</tt> keyword. Xfail lines are
317specified in the comments of the test program using <tt>XFAIL</tt>,
318followed by a colon, and one or more regular expressions (separated by
319a comma) that will match against the target triplet for the
320machine. 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>
John Criswelle90fc1f2003-10-10 18:42:49 +0000[diff] [blame]327
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]328<!--=========================================================================-->
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]329<div class="doc_section"><a name="progstructure"><tt>llvm-test</tt>
330Structure</a></div>
331<!--=========================================================================-->
John Criswelle90fc1f2003-10-10 18:42:49 +0000[diff] [blame]332
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]333<div class="doc_text">
Brian Gaeke739811d2003-10-23 18:10:28 +0000[diff] [blame]334
Misha Brukman8d08d362004-10-08 00:41:27 +0000[diff] [blame]335<p>As mentioned previously, the <tt>llvm-test</tt> module provides three types
336of tests: MultiSource, SingleSource, and External. Each tree is then subdivided
337into several categories, including applications, benchmarks, regression tests,
338code that is strange grammatically, etc. These organizations should be
339relatively self explanatory.</p>
John Criswelle90fc1f2003-10-10 18:42:49 +0000[diff] [blame]340
Misha Brukman8d08d362004-10-08 00:41:27 +0000[diff] [blame]341<p>In addition to the regular "whole program" tests, the <tt>llvm-test</tt>
342module also provides a mechanism for compiling the programs in different ways.
343If the variable TEST is defined on the gmake command line, the test system will
344include a Makefile named <tt>TEST.&lt;value of TEST variable&gt;.Makefile</tt>.
345This Makefile can modify build rules to yield different results.</p>
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]346
Misha Brukman8d08d362004-10-08 00:41:27 +0000[diff] [blame]347<p>For example, the LLVM nightly tester uses <tt>TEST.nightly.Makefile</tt> to
348create the nightly test reports. To run the nightly tests, run <tt>gmake
349TEST=nightly</tt>.</p>
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]350
Misha Brukman8d08d362004-10-08 00:41:27 +0000[diff] [blame]351<p>There are several TEST Makefiles available in the tree. Some of them are
352designed for internal LLVM research and will not work outside of the LLVM
353research group. They may still be valuable, however, as a guide to writing your
354own TEST Makefile for any optimization or analysis passes that you develop with
355LLVM.</p>
Reid Spencercce67552004-12-08 16:52:51 +0000[diff] [blame]356
357<p>Note, when configuring the <tt>llvm-test</tt> module, you might want to
358specify 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>
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]383</div>
384
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]385<!--=========================================================================-->
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]386<div class="doc_section"><a name="run">Running the LLVM Tests</a></div>
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]387<!--=========================================================================-->
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]388
389<div class="doc_text">
390
391<p>First, all tests are executed within the LLVM object directory tree. They
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]392<i>are not</i> executed inside of the LLVM source tree. This is because the
393test suite creates temporary files during execution.</p>
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]394
Tanya Lattner9a1b8932004-12-08 17:35:31 +0000[diff] [blame]395<p>The master Makefile in llvm/test is capable of running only the DejaGNU driven
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]396tests. By default, it will run all of these tests.</p>
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]397
Tanya Lattner9a1b8932004-12-08 17:35:31 +0000[diff] [blame]398<p>To run only the DejaGNU driven tests, run <tt>gmake</tt> at the
John Criswell417cb0a2005-05-13 19:48:07 +0000[diff] [blame]399command line in <tt>llvm/test</tt>. To run a specific directory of tests, use
400the TESTSUITE variable.
Tanya Lattner9a1b8932004-12-08 17:35:31 +0000[diff] [blame]401</p>
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]402
Tanya Lattner9a1b8932004-12-08 17:35:31 +0000[diff] [blame]403<p>For example, to run the Regression tests, type
404<tt>gmake TESTSUITE=Regression</tt> in <tt>llvm/tests</tt>.</p>
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]405
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]406<p>Note that there are no Makefiles in <tt>llvm/test/Features</tt> and
Tanya Lattner9a1b8932004-12-08 17:35:31 +0000[diff] [blame]407<tt>llvm/test/Regression</tt>. You must use DejaGNU from the <tt>llvm/test</tt>
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]408directory to run them.</p>
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]409
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]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/>
John Criswell417cb0a2005-05-13 19:48:07 +0000[diff] [blame]425 <tt>$LLVM_SRC_ROOT/projects/llvm-test/configure --with-llvmsrc=$LLVM_SRC_ROOT --with-llvmobj=$LLVM_OBJ_ROOT</tt>
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]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
431have the suite checked out and configured, you don't need to do it again (unless
432the 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
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]437nightly tester tests using the following commands:</p>
438
439<pre>
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]440 % cd llvm/projects/llvm-test
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]441 % gmake TEST=nightly test
442</pre>
443
444<p>Regardless of which test you're running, the results are printed on standard
445output and standard error. You can redirect these results to a file if you
446choose.</p>
447
448<p>Some tests are known to fail. Some are bugs that we have not fixed yet;
Tanya Lattner9a1b8932004-12-08 17:35:31 +0000[diff] [blame]449others are features that we haven't added yet (or may never add). In DejaGNU,
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]450the result for such tests will be XFAIL (eXpected FAILure). In this way, you
451can tell the difference between an expected and unexpected failure.</p>
452
John Criswell417cb0a2005-05-13 19:48:07 +0000[diff] [blame]453<p>The tests in <tt>llvm-test</tt> have no such feature at this time. If the
Misha Brukman8d08d362004-10-08 00:41:27 +0000[diff] [blame]454test passes, only warnings and other miscellaneous output will be generated. If
455a test fails, a large &lt;program&gt; FAILED message will be displayed. This
456will help you separate benign warnings from actual test failures.</p>
Chris Lattnerc4f22522004-06-24 20:53:09 +0000[diff] [blame]457
458</div>
459
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]460<!--=========================================================================-->
Chris Lattnerc4f22522004-06-24 20:53:09 +0000[diff] [blame]461<div class="doc_section"><a name="nightly">Running the nightly tester</a></div>
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]462<!--=========================================================================-->
Chris Lattnerc4f22522004-06-24 20:53:09 +0000[diff] [blame]463
464<div class="doc_text">
465
466<p>
467The <a href="http://llvm.cs.uiuc.edu/testresults/">LLVM Nightly Testers</a>
468automatically check out an LLVM tree, build it, run the "nightly"
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]469program test (described above), run all of the feature and regression tests,
470and then delete the checked out tree. This tester is designed to ensure that
Chris Lattnerc4f22522004-06-24 20:53:09 +0000[diff] [blame]471programs don't break as well as keep track of LLVM's progress over time.</p>
472
Misha Brukman5da60ba2005-03-10 22:51:59 +0000[diff] [blame]473<p>If you'd like to set up an instance of the nightly tester to run on your
474machine, 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
476that looks ilke this:</p>
Chris Lattnerc4f22522004-06-24 20:53:09 +0000[diff] [blame]477
Misha Brukman5da60ba2005-03-10 22:51:59 +0000[diff] [blame]478<div class="doc_code">
Chris Lattnerc4f22522004-06-24 20:53:09 +0000[diff] [blame]479<pre>
Misha Brukman5da60ba2005-03-10 22:51:59 +0000[diff] [blame]4805 3 * * * $HOME/llvm/utils/NightlyTest.pl -parallel $CVSROOT $HOME/buildtest-X86 $HOME/cvs/testresults-X86
Chris Lattnerc4f22522004-06-24 20:53:09 +0000[diff] [blame]481</pre>
Misha Brukman5da60ba2005-03-10 22:51:59 +0000[diff] [blame]482</div>
Chris Lattnerc4f22522004-06-24 20:53:09 +0000[diff] [blame]483
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]484<p>Or, you can create a shell script to encapsulate the running of the script.
Misha Brukman5da60ba2005-03-10 22:51:59 +0000[diff] [blame]485The optimized x86 Linux nightly test is run from just such a script:</p>
486
487<div class="doc_code">
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]488<pre>
489#!/bin/bash
490BASE=/proj/work/llvm/nightlytest
491export CVSROOT=:pserver:anon@llvm.cs.uiuc.edu:/var/cvs/llvm
492export BUILDDIR=$BASE/build
493export WEBDIR=$BASE/testresults
494export LLVMGCCDIR=/proj/work/llvm/cfrontend/install
495export PATH=/proj/install/bin:$LLVMGCCDIR/bin:$PATH
496export LD_LIBRARY_PATH=/proj/install/lib
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]497cd $BASE
498cp /proj/work/llvm/llvm/utils/NightlyTest.pl .
Misha Brukman5da60ba2005-03-10 22:51:59 +0000[diff] [blame]499nice ./NightlyTest.pl -nice -release -verbose -parallel -enable-linscan -noexternals 2&gt;&amp;1 &gt; output.log
500mail -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 Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]501</pre>
Misha Brukman5da60ba2005-03-10 22:51:59 +0000[diff] [blame]502</div>
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]503
Misha Brukman5da60ba2005-03-10 22:51:59 +0000[diff] [blame]504<p>Take a look at the <tt>NightlyTest.pl</tt> file to see what all of the flags
505and strings do. If you start running the nightly tests, please let us know and
506we'll link your page to the global tester page. Thanks!</p>
507
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]508</div>
John Criswelle90fc1f2003-10-10 18:42:49 +0000[diff] [blame]509
Brian Gaeke739811d2003-10-23 18:10:28 +0000[diff] [blame]510<!-- *********************************************************************** -->
John Criswelle90fc1f2003-10-10 18:42:49 +0000[diff] [blame]511
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]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>
Brian Gaeke739811d2003-10-23 18:10:28 +0000[diff] [blame]518
John Criswell417cb0a2005-05-13 19:48:07 +0000[diff] [blame]519 John T. Criswell, Reid Spencer, and Tanya Lattner<br>
Reid Spencerae21b0b2004-09-05 20:07:26 +0000[diff] [blame]520 <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br/>
Misha Brukman773d6f62004-03-01 18:21:04 +0000[diff] [blame]521 Last modified: $Date$
522</address>
Brian Gaeke739811d2003-10-23 18:10:28 +0000[diff] [blame]523</body>
John Criswelle90fc1f2003-10-10 18:42:49 +0000[diff] [blame]524</html>