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