Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / 0904f090911d29b8d41342247aea26a56dbc040a / . / docs / TestingGuide.html
blob: a6a44efff1147b6a41779ac8c62885589394ef06 [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>
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>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]18<li><a href="#org">LLVM Test Suite Organization</a>
Brian Gaekeaf19f2e2003-10-23 18:10:28 +0000[diff] [blame]19<ul>
20 <li><a href="#codefragments">Code Fragments</a></li>
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]21<li><a href="#wholeprograms">Whole Programs</a></li>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]22</ul></li>
Brian Gaekeaf19f2e2003-10-23 18:10:28 +0000[diff] [blame]23<li><a href="#tree">LLVM Test Suite Tree</a></li>
24<li><a href="#qmstructure">QMTest Structure</a></li>
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]25<li><a href="#progstructure"><tt>llvm-test</tt> Structure</a></li>
Brian Gaekeaf19f2e2003-10-23 18:10:28 +0000[diff] [blame]26<li><a href="#run">Running the LLVM Tests</a></li>
Chris Lattnerfd9d1b32004-06-24 20:53:09 +0000[diff] [blame]27<li><a href="#nightly">Running the nightly tester</a></li>
Brian Gaekeaf19f2e2003-10-23 18:10:28 +0000[diff] [blame]28</ol>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]29
Chris Lattner7911ce22004-05-23 21:07:27 +0000[diff] [blame]30<div class="doc_author">
Misha Brukman0904f092004-10-08 00:41:27 +0000[diff] [blame^]31<p>Written by John T. Criswell and <a
32href="http://llvm.x10sys.com/rspencer">Reid Spencer</a></p>
Chris Lattner7911ce22004-05-23 21:07:27 +0000[diff] [blame]33</div>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]34
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]35<!--=========================================================================-->
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]36<div class="doc_section"><a name="overview">Overview</a></div>
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]37<!--=========================================================================-->
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]38
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]39<div class="doc_text">
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]40
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]41<p>This document is the reference manual for the LLVM test suite. It documents
42the structure of the LLVM test suite, the tools needed to use it, and how to add
43and run tests.</p>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]44
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]45</div>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]46
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]47<!--=========================================================================-->
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]48<div class="doc_section"><a name="Requirements">Requirements</a></div>
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]49<!--=========================================================================-->
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]50
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]51<div class="doc_text">
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]52
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]53<p>In order to use the LLVM test suite, you will need all of the software
54required to build LLVM, plus the following:</p>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]55
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]56<dl>
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]57<dt><a href="http://www.qmtest.com">QMTest</A></dt>
58<dd>The LLVM test suite uses QMTest to organize and run tests. <b>Note:
59you will need <a href="http://llvm.cs.uiuc.edu/qm-2.0.3.tar.gz">QMTest
602.0.3 (source tar.gz file)</a> to be successful. The tests do not run with
61any other version.</b></dd>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]62
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]63<dt><a href="http://www.python.org">Python</A></dt>
64<dd>You will need a Python interpreter that works with QMTest. Python will
65need zlib and SAX support enabled.</dd>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]66</dl>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]67
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]68</div>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]69
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]70<!--=========================================================================-->
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]71<div class="doc_section"><a name="quick">Quick Start</a></div>
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]72<!--=========================================================================-->
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]73
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]74<div class="doc_text">
Brian Gaekeaf19f2e2003-10-23 18:10:28 +0000[diff] [blame]75
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]76<p>The tests are located in two separate CVS modules. The basic feature and
77regression tests are in the main "llvm" module under the directory
78<tt>llvm/test</tt>. A more comprehensive test suite that includes whole
79programs in C and C++ is in the <tt>llvm-test</tt> module. This module should
80be checked out to the <tt>llvm/projects</tt> directory. When you
81<tt>configure</tt> the <tt>llvm</tt> module, the <tt>llvm-test</tt> module
82will be automatically configured. Or you can do it manually.</p>
83<p>To run all of the simple tests in LLVM, use the master Makefile in the
84<tt>llvm/test</tt> directory:</p>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]85<pre>
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]86% gmake -C llvm/test
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]87</pre>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]88
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]89<p>To run only the code fragment tests (i.e. those that do basic testing of
90LLVM), run the tests organized by QMTest:</p>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]91<pre>
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]92% gmake -C llvm/test qmtest
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]93</pre>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]94
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]95<p>To run only the basic feature tests, QMTest supports the following
96target:</p>
97<pre>
98% gmake -C llvm/test Feature.t
99</pre>
100
101<p>To run only the regression tests, QMTest supports the following
102target:</p>
103<pre>
104% gmake -C llvm/test Regression.t
105</pre>
106
107<p>To run the comprehensive test suite (tests that compile and execute whole
108programs), run the <tt>llvm-test</tt> tests:</p>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]109
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]110<pre>
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]111% cd llvm/projects
112% cvs co llvm-test
113% cd llvm-test
114% ./configure --with-llvmsrc=$LLVM_SRC_ROOT --with-llvmobj=$LLVM_OBJ_ROOT
115% gmake
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]116</pre>
117
118</div>
119
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]120<!--=========================================================================-->
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]121<div class="doc_section"><a name="org">LLVM Test Suite Organization</a></div>
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]122<!--=========================================================================-->
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]123
124<div class="doc_text">
125
126<p>The LLVM test suite contains two major categories of tests: code
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]127fragments and whole programs. Code fragments are in the <tt>llvm</tt> module
128under the directory under the <tt>llvm/test</tt> directory. The whole programs
129test suite are n the <tt>llvm-test</tt> module under the main directory.</p>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]130
131</div>
132
133<div class="doc_subsection"><a name="codefragments">Code Fragments</a>
134</div>
135
136<div class="doc_text">
137
138<p>Code fragments are small pieces of code that test a specific feature of LLVM
139or trigger a specific bug in LLVM. They are usually written in LLVM assembly
140language, but can be written in other languages if the test targets a particular
141language front end.</p>
142
143<p>Code fragments are not complete programs, and they are never executed to
144determine correct behavior.</p>
145
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]146<p>Thes code fragment tests are located in the <tt>llvm/test/Features</tt> and
147<tt>llvm/test/Regression</tt> directories.</p>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]148
149</div>
150
151<div class="doc_subsection"><a name="wholeprograms">Whole Programs</a></div>
152
153<div class="doc_text">
154
155<p>Whole Programs are pieces of code which can be compiled and linked into a
156stand-alone program that can be executed. These programs are generally written
157in high level languages such as C or C++, but sometimes they are written
158straight in LLVM assembly.</p>
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]159
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]160<p>These programs are compiled and then executed using several different
161methods (native compiler, LLVM C backend, LLVM JIT, LLVM native code generation,
162etc). The output of these programs is compared to ensure that LLVM is compiling
163the program correctly.</p>
164
165<p>In addition to compiling and executing programs, whole program tests serve as
166a way of benchmarking LLVM performance, both in terms of the efficiency of the
167programs generated as well as the speed with which LLVM compiles, optimizes, and
168generates code.</p>
169
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]170<p>All "whole program" tests are located in the <tt>llvm-test</tt> CVS
171module.</p>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]172
173</div>
174
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]175<!--=========================================================================-->
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]176<div class="doc_section"><a name="tree">LLVM Test Suite Tree</a></div>
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]177<!--=========================================================================-->
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]178
179<div class="doc_text">
180
181<p>Each type of test in the LLVM test suite has its own directory. The major
182subtrees of the test suite directory tree are as follows:</p>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]183
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]184<ul>
185<li><tt>llvm/test/Features</tt>
186<p>This directory contains sample codes that test various features of the
187LLVM language. These pieces of sample code are run through various
188assembler, disassembler, and optimizer passes.</p>
189</li>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]190
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]191<li><tt>llvm/test/Regression</tt>
192<p>This directory contains regression tests for LLVM. When a bug is found
193in LLVM, a regression test containing just enough code to reproduce the
194problem should be written and placed somewhere underneath this directory.
195In most cases, this will be a small piece of LLVM assembly language code,
196often distilled from an actual application or benchmark.</p>
197</li>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]198
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]199<li><tt>llvm-test</tt>
200<p>The <tt>llvm-test</tt> CVS module contains programs that can be compiled
201with LLVM and executed. These programs are compiled using the native compiler
202and various LLVM backends. The output from the program compiled with the
203native compiler is assumed correct; the results from the other programs are
Misha Brukman0904f092004-10-08 00:41:27 +0000[diff] [blame^]204compared to the native program output and pass if they match.</p>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]205
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]206<p>In addition for testing correctness, the <tt>llvm-test</tt> directory also
207performs timing tests of various LLVM optimizations. It also records
208compilation times for the compilers and the JIT. This information can be
209used to compare the effectiveness of LLVM's optimizations and code
210generation.</p></li>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]211
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]212<li><tt>llvm-test/SingleSource</tt>
213<p>The SingleSource directory contains test programs that are only a single
214source file in size. These are usually small benchmark programs or small
215programs that calculate a particular value. Several such programs are grouped
216together in each directory.</p></li>
217
218<li><tt>llvm-test/MultiSource</tt>
219<p>The MultiSource directory contains subdirectories which contain entire
220programs with multiple source files. Large benchmarks and whole applications
221go here.</p></li>
222
223<li><tt>llvm-test/External</tt>
Misha Brukman0904f092004-10-08 00:41:27 +0000[diff] [blame^]224<p>The External directory contains Makefiles for building code that is external
225to (i.e., not distributed with) LLVM. The most prominent members of this
226directory are the SPEC 95 and SPEC 2000 benchmark suites. The presence and
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]227location of these external programs is configured by the llvm-test
228<tt>configure</tt> script.</p></li>
229
230<li><tt>llvm/test/QMTest</tt>
Misha Brukman0904f092004-10-08 00:41:27 +0000[diff] [blame^]231<p>This directory contains the QMTest information files. Inside this directory
232are QMTest administration files and the Python code that implements the LLVM
233test and database classes.</p></li>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]234
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]235</ul>
Brian Gaekeaf19f2e2003-10-23 18:10:28 +0000[diff] [blame]236
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]237</div>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]238
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]239<!--=========================================================================-->
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]240<div class="doc_section"><a name="qmstructure">QMTest Structure</a></div>
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]241<!--=========================================================================-->
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]242
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]243<div class="doc_text">
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]244
Misha Brukman0904f092004-10-08 00:41:27 +0000[diff] [blame^]245<p>The LLVM test suite is partially driven by QMTest and partially driven by GNU
246Make. Specifically, the Features and Regression tests are all driven by QMTest.
247The <tt>llvm-test</tt> module is currently driven by a set of Makefiles.</p>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]248
Misha Brukman0904f092004-10-08 00:41:27 +0000[diff] [blame^]249<p>The QMTest system needs to have several pieces of information available;
250these pieces of configuration information are known collectively as the
251"context" in QMTest parlance. Since the context for LLVM is relatively large,
252the master Makefile in llvm/test sets it for you.</p>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]253
Misha Brukman0904f092004-10-08 00:41:27 +0000[diff] [blame^]254<p>The LLVM database class makes the subdirectories of llvm/test a QMTest test
255database. For each directory that contains tests driven by QMTest, it knows
256what type of test the source file is and how to run it.</p>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]257
Misha Brukman0904f092004-10-08 00:41:27 +0000[diff] [blame^]258<p>Hence, the QMTest namespace is essentially what you see in the Feature and
259Regression directories, but there is some magic that the database class performs
260(as described below).</p>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]261
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]262<p>The QMTest namespace is currently composed of the following tests and test
263suites:</p>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]264
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]265<ul>
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]266<li>Feature
Misha Brukman0904f092004-10-08 00:41:27 +0000[diff] [blame^]267
268<p>These are the feature tests found in the Feature directory.
269They are broken up into the following categories:</p>
270
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]271<ul>
272 <li>ad
273 <p>Assembler/Disassembler tests. These tests verify that a piece of LLVM
274 assembly language can be assembled into bytecode and then disassembled
275 into the original assembly language code. It does this several times to
276 ensure that assembled output can be disassembled and disassembler output
277 can be assembled. It also verifies that the give assembly language file
278 can be assembled correctly.</p></li>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]279
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]280 <li>opt
281 <p>Optimizer tests. These tests verify that two of the optimizer passes
282 completely optimize a program (i.e. after a single pass, they cannot
283 optimize a program any further).</p></li>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]284
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]285 <li>mc
286 <p> Machine code tests. These tests verify that the LLVM assembly
287 language file can be translated into native assembly code.</p></li>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]288
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]289 <li>cc
290 <p>C code tests. These tests verify that the specified LLVM assembly
291 code can be converted into C source code using the C backend.</p></li>
292</ul>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]293
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]294<p>The LLVM database class looks at every file in the Feature directory and
295creates a fake test hierarchy containing
296<tt>Feature.&lt;testtype&gt;.&lt;testname&gt;</tt>. So, if you add an LLVM
297assembly language file to the Feature directory, it actually creates 5 new
298tests: assembler/disassembler, assembler, optimizer, machine code, and C code.
Misha Brukman0904f092004-10-08 00:41:27 +0000[diff] [blame^]299</p></li>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]300
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]301<li>Regression
302 <p>These are the regression tests. There is one suite for each
303 subdirectory of the Regression directory. If you add a new subdirectory
304 there, you will need to modify, at least, the <tt>RegressionMap</tt>
305 variable in <tt>QMTest/llvmdb.py</tt> so that QMTest knows how to run the
306 tests in the new subdirectory.</p>
Misha Brukman0904f092004-10-08 00:41:27 +0000[diff] [blame^]307</li>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]308
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]309</ul>
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]310
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]311</div>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]312
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]313<!--=========================================================================-->
314<div class="doc_section"><a name="progstructure"><tt>llvm-test</tt>
315Structure</a></div>
316<!--=========================================================================-->
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]317
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]318<div class="doc_text">
Brian Gaekeaf19f2e2003-10-23 18:10:28 +0000[diff] [blame]319
Misha Brukman0904f092004-10-08 00:41:27 +0000[diff] [blame^]320<p>As mentioned previously, the <tt>llvm-test</tt> module provides three types
321of tests: MultiSource, SingleSource, and External. Each tree is then subdivided
322into several categories, including applications, benchmarks, regression tests,
323code that is strange grammatically, etc. These organizations should be
324relatively self explanatory.</p>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]325
Misha Brukman0904f092004-10-08 00:41:27 +0000[diff] [blame^]326<p>In addition to the regular "whole program" tests, the <tt>llvm-test</tt>
327module also provides a mechanism for compiling the programs in different ways.
328If the variable TEST is defined on the gmake command line, the test system will
329include a Makefile named <tt>TEST.&lt;value of TEST variable&gt;.Makefile</tt>.
330This Makefile can modify build rules to yield different results.</p>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]331
Misha Brukman0904f092004-10-08 00:41:27 +0000[diff] [blame^]332<p>For example, the LLVM nightly tester uses <tt>TEST.nightly.Makefile</tt> to
333create the nightly test reports. To run the nightly tests, run <tt>gmake
334TEST=nightly</tt>.</p>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]335
Misha Brukman0904f092004-10-08 00:41:27 +0000[diff] [blame^]336<p>There are several TEST Makefiles available in the tree. Some of them are
337designed for internal LLVM research and will not work outside of the LLVM
338research group. They may still be valuable, however, as a guide to writing your
339own TEST Makefile for any optimization or analysis passes that you develop with
340LLVM.</p>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]341
342</div>
343
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]344<!--=========================================================================-->
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]345<div class="doc_section"><a name="run">Running the LLVM Tests</a></div>
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]346<!--=========================================================================-->
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]347
348<div class="doc_text">
349
350<p>First, all tests are executed within the LLVM object directory tree. They
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]351<i>are not</i> executed inside of the LLVM source tree. This is because the
352test suite creates temporary files during execution.</p>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]353
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]354<p>The master Makefile in llvm/test is capable of running only the QMTest driven
355tests. By default, it will run all of these tests.</p>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]356
357<p>To run only the QMTest driven tests, run <tt>gmake qmtest</tt> at the
358command line in llvm/tests. To run a specific qmtest, suffix the test name with
359".t" when running gmake.</p>
360
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]361<p>For example, to run the Regression.LLC tests, type
362<tt>gmake Regression.LLC.t</tt> in <tt>llvm/tests</tt>.</p>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]363
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]364<p>Note that there are no Makefiles in <tt>llvm/test/Features</tt> and
365<tt>llvm/test/Regression</tt>. You must use QMTest from the <tt>llvm/test</tt>
366directory to run them.</p>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]367
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]368<p>To run the <tt>llvm-test</tt> suite, you need to use the following steps:
369</p>
370<ol>
371 <li>cd into the llvm/projects directory</li>
372 <li>check out the <tt>llvm-test</tt> module with:<br/>
373 <tt>cvs -d :pserver:anon@llvm.cs.uiuc.edu:/var/cvs/llvm co -PR llvm-test</tt><br>
374 This will get the test suite into <tt>llvm/projects/llvm-test</tt></li>
375 <li>configure the test suite. You can do this one of two ways:
376 <ol>
377 <li>Use the regular llvm configure:<br/>
378 <tt>cd $LLVM_OBJ_ROOT ; $LLVM_SRC_ROOT/configure</tt><br/>
379 This will ensure that the <tt>projects/llvm-test</tt> directory is also
380 properly configured.</li>
381 <li>Use the <tt>configure</tt> script found in the <tt>llvm-test</tt> source
382 directory:<br/>
383 <tt>$BUILD_SRC_DIR/configure --with-llvmsrc=$LLVM_SRC_ROOT --with-llvmobj=$LLVM_OBJ_ROOT</tt>
384 </li>
385 </ol>
386 <li>gmake</li>
387</ol>
388<p>Note that the second and third steps only need to be done once. After you
389have the suite checked out and configured, you don't need to do it again (unless
390the test code or configure script changes).</p>
391
392<p>To make a specialized test (use one of the
393<tt>llvm-test/TEST.&lt;type&gt;.Makefile</tt>s), just run:<br/>
394<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]395nightly tester tests using the following commands:</p>
396
397<pre>
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]398 % cd llvm/projects/llvm-test
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]399 % gmake TEST=nightly test
400</pre>
401
402<p>Regardless of which test you're running, the results are printed on standard
403output and standard error. You can redirect these results to a file if you
404choose.</p>
405
406<p>Some tests are known to fail. Some are bugs that we have not fixed yet;
407others are features that we haven't added yet (or may never add). In QMTest,
408the result for such tests will be XFAIL (eXpected FAILure). In this way, you
409can tell the difference between an expected and unexpected failure.</p>
410
Misha Brukman0904f092004-10-08 00:41:27 +0000[diff] [blame^]411<p>The tests in <tt>llvm-test</tt> have no such feature as of this time. If the
412test passes, only warnings and other miscellaneous output will be generated. If
413a test fails, a large &lt;program&gt; FAILED message will be displayed. This
414will help you separate benign warnings from actual test failures.</p>
Chris Lattnerfd9d1b32004-06-24 20:53:09 +0000[diff] [blame]415
416</div>
417
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]418<!--=========================================================================-->
Chris Lattnerfd9d1b32004-06-24 20:53:09 +0000[diff] [blame]419<div class="doc_section"><a name="nightly">Running the nightly tester</a></div>
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]420<!--=========================================================================-->
Chris Lattnerfd9d1b32004-06-24 20:53:09 +0000[diff] [blame]421
422<div class="doc_text">
423
424<p>
425The <a href="http://llvm.cs.uiuc.edu/testresults/">LLVM Nightly Testers</a>
426automatically check out an LLVM tree, build it, run the "nightly"
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]427program test (described above), run all of the feature and regression tests,
428and then delete the checked out tree. This tester is designed to ensure that
Chris Lattnerfd9d1b32004-06-24 20:53:09 +0000[diff] [blame]429programs don't break as well as keep track of LLVM's progress over time.</p>
430
431<p>
432If you'd like to set up an instance of the nightly tester to run on your
433machine, take a look at the comments at the top of the utils/NightlyTester.pl
434file. We usually run it from a crontab entry that looks ilke this:
435</p>
436
437<pre>
4385 3 * * * LLVM_LIB_SEARCH_PATH=.../llvm-gcc/bytecode-libs $HOME/llvm/utils/NightlyTest.pl -parallel -enable-linscan ...CVSREPOSTRING... $HOME/buildtest-X86 $HOME/cvs/testresults-X86
439</pre>
440
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]441<p>Or, you can create a shell script to encapsulate the running of the script.
442The optimized x86 Linux nightly test is run from just such a script:
443<pre>
444#!/bin/bash
445BASE=/proj/work/llvm/nightlytest
446export CVSROOT=:pserver:anon@llvm.cs.uiuc.edu:/var/cvs/llvm
447export BUILDDIR=$BASE/build
448export WEBDIR=$BASE/testresults
449export LLVMGCCDIR=/proj/work/llvm/cfrontend/install
450export PATH=/proj/install/bin:$LLVMGCCDIR/bin:$PATH
451export LD_LIBRARY_PATH=/proj/install/lib
452export LLVM_LIB_SEARCH_PATH=/proj/work/llvm/cfrontend/install/bytecode-libs
453cd $BASE
454cp /proj/work/llvm/llvm/utils/NightlyTest.pl .
455nice ./NightlyTest.pl -nice -release -verbose -parallel -enable-linscan -noexternals
456</pre>
457
Chris Lattnerfd9d1b32004-06-24 20:53:09 +0000[diff] [blame]458<p>
459Take a look at the NightlyTest.pl file to see what all of the flags and
460strings do. If you start running the nightly tests, please let us know and
461we'll link your page to the global tester page. Thanks!
462</p>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]463
464</div>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]465
Brian Gaekeaf19f2e2003-10-23 18:10:28 +0000[diff] [blame]466<!-- *********************************************************************** -->
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]467
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]468<hr>
469<address>
470 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
471 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
472 <a href="http://validator.w3.org/check/referer"><img
473 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
Brian Gaekeaf19f2e2003-10-23 18:10:28 +0000[diff] [blame]474
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]475 John T. Criswell<br>
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]476 <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br/>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]477 Last modified: $Date$
478</address>
Brian Gaekeaf19f2e2003-10-23 18:10:28 +0000[diff] [blame]479</body>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]480</html>