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