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