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