Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / 624dc1d4abf26a3ccd474f85a39058a99a9053ca / . / docs / TestingGuide.html
blob: 3d6aa92ffb16111742913fd844019bc965d5ee00 [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>
Matthijs Kooijman31ce08f2008-06-24 12:58:31 +0000[diff] [blame]5 <title>LLVM Testing Infrastructure Guide</title>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]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
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]10<h1>
Matthijs Kooijman31ce08f2008-06-24 12:58:31 +0000[diff] [blame]11 LLVM Testing Infrastructure Guide
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]12</h1>
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>
Matthijs Kooijman31ce08f2008-06-24 12:58:31 +0000[diff] [blame]16 <li><a href="#requirements">Requirements</a></li>
17 <li><a href="#org">LLVM testing infrastructure organization</a>
Reid Spencer820e2472004-11-01 08:30:14 +0000[diff] [blame]18 <ul>
Daniel Dunbarcd3b1172010-08-02 01:20:23 +0000[diff] [blame]19 <li><a href="#regressiontests">Regression tests</a></li>
Matthijs Kooijman31ce08f2008-06-24 12:58:31 +0000[diff] [blame]20 <li><a href="#testsuite">Test suite</a></li>
Devang Patel40d438e2010-11-11 00:13:39 +0000[diff] [blame]21 <li><a href="#debuginfotests">Debugging Information tests</a></li>
Reid Spencer820e2472004-11-01 08:30:14 +0000[diff] [blame]22 </ul>
23 </li>
Matthijs Kooijman31ce08f2008-06-24 12:58:31 +0000[diff] [blame]24 <li><a href="#quick">Quick start</a>
Chris Lattnereb82da82006-05-23 01:40:20 +0000[diff] [blame]25 <ul>
Daniel Dunbarcd3b1172010-08-02 01:20:23 +0000[diff] [blame]26 <li><a href="#quickregressiontests">Regression tests</a></li>
Matthijs Kooijman31ce08f2008-06-24 12:58:31 +0000[diff] [blame]27 <li><a href="#quicktestsuite">Test suite</a></li>
Devang Patel40d438e2010-11-11 00:13:39 +0000[diff] [blame]28 <li><a href="#quickdebuginfotests">Debugging Information tests</a></li>
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]29 </ul>
30 </li>
Daniel Dunbarcd3b1172010-08-02 01:20:23 +0000[diff] [blame]31 <li><a href="#rtstructure">Regression test structure</a>
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]32 <ul>
Daniel Dunbarcd3b1172010-08-02 01:20:23 +0000[diff] [blame]33 <li><a href="#rtcustom">Writing new regression tests</a></li>
Chris Lattner3d2de1d2009-08-15 15:40:48 +0000[diff] [blame]34 <li><a href="#FileCheck">The FileCheck utility</a></li>
Daniel Dunbarcd3b1172010-08-02 01:20:23 +0000[diff] [blame]35 <li><a href="#rtvars">Variables and substitutions</a></li>
36 <li><a href="#rtfeatures">Other features</a></li>
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]37 </ul>
38 </li>
Matthijs Kooijman31ce08f2008-06-24 12:58:31 +0000[diff] [blame]39 <li><a href="#testsuitestructure">Test suite structure</a></li>
40 <li><a href="#testsuiterun">Running the test suite</a>
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]41 <ul>
Stuart Hastingsc4c268b2009-05-21 20:23:59 +0000[diff] [blame]42 <li><a href="#testsuiteexternal">Configuring External Tests</a></li>
Matthijs Kooijman31ce08f2008-06-24 12:58:31 +0000[diff] [blame]43 <li><a href="#testsuitetests">Running different tests</a></li>
44 <li><a href="#testsuiteoutput">Generating test output</a></li>
Andrew Trickbcf01162010-09-23 20:26:44 +0000[diff] [blame]45 <li><a href="#testsuitecustom">Writing custom tests for test-suite</a></li>
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]46 </ul>
Chris Lattnereb82da82006-05-23 01:40:20 +0000[diff] [blame]47 </li>
Brian Gaekeaf19f2e2003-10-23 18:10:28 +0000[diff] [blame]48</ol>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]49
Chris Lattner7911ce22004-05-23 21:07:27 +0000[diff] [blame]50<div class="doc_author">
Daniel Dunbarcd3b1172010-08-02 01:20:23 +0000[diff] [blame]51 <p>Written by John T. Criswell, Daniel Dunbar, Reid Spencer, and Tanya Lattner</p>
Chris Lattner7911ce22004-05-23 21:07:27 +0000[diff] [blame]52</div>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]53
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]54<!--=========================================================================-->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]55<h2><a name="overview">Overview</a></h2>
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]56<!--=========================================================================-->
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]57
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]58<div class="doc_text">
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]59
Daniel Dunbarcd3b1172010-08-02 01:20:23 +0000[diff] [blame]60<p>This document is the reference manual for the LLVM testing infrastructure. It
61documents the structure of the LLVM testing infrastructure, the tools needed to
62use it, and how to add and run tests.</p>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]63
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]64</div>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]65
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]66<!--=========================================================================-->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]67<h2><a name="requirements">Requirements</a></h2>
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]68<!--=========================================================================-->
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]69
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]70<div class="doc_text">
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]71
Daniel Dunbarcd3b1172010-08-02 01:20:23 +0000[diff] [blame]72<p>In order to use the LLVM testing infrastructure, you will need all of the
73software required to build LLVM, as well
74as <a href="http://python.org">Python</a> 2.4 or later.</p>
Jim Laskeya2dee012006-03-27 18:41:06 +0000[diff] [blame]75
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]76</div>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]77
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]78<!--=========================================================================-->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]79<h2><a name="org">LLVM testing infrastructure organization</a></h2>
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]80<!--=========================================================================-->
81
82<div class="doc_text">
83
Daniel Dunbarcd3b1172010-08-02 01:20:23 +0000[diff] [blame]84<p>The LLVM testing infrastructure contains two major categories of tests:
85regression tests and whole programs. The regression tests are contained inside
86the LLVM repository itself under <tt>llvm/test</tt> and are expected to always
87pass -- they should be run before every commit. The whole programs tests are
88referred to as the "LLVM test suite" and are in the <tt>test-suite</tt> module
89in subversion.
Matthijs Kooijman31ce08f2008-06-24 12:58:31 +0000[diff] [blame]90</p>
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]91
92</div>
93
94<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]95<h3><a name="regressiontests">Regression tests</a></h3>
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]96<!-- _______________________________________________________________________ -->
97
98<div class="doc_text">
99
Daniel Dunbarcd3b1172010-08-02 01:20:23 +0000[diff] [blame]100<p>The regression tests are small pieces of code that test a specific feature of
101LLVM or trigger a specific bug in LLVM. They are usually written in LLVM
102assembly language, but can be written in other languages if the test targets a
103particular language front end (and the appropriate <tt>--with-llvmgcc</tt>
104options were used at <tt>configure</tt> time of the <tt>llvm</tt> module). These
105tests are driven by the 'lit' testing tool, which is part of LLVM.</p>
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]106
Shantonu Sen1b6d3da2009-06-26 05:44:53 +0000[diff] [blame]107<p>These code fragments are not complete programs. The code generated
108from them is never executed to determine correct behavior.</p>
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]109
110<p>These code fragment tests are located in the <tt>llvm/test</tt>
111directory.</p>
112
113<p>Typically when a bug is found in LLVM, a regression test containing
114just enough code to reproduce the problem should be written and placed
115somewhere underneath this directory. In most cases, this will be a small
116piece of LLVM assembly language code, often distilled from an actual
117application or benchmark.</p>
118
119</div>
120
121<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]122<h3><a name="testsuite">Test suite</a></h3>
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]123<!-- _______________________________________________________________________ -->
124
125<div class="doc_text">
126
Matthijs Kooijman31ce08f2008-06-24 12:58:31 +0000[diff] [blame]127<p>The test suite contains whole programs, which are pieces of
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]128code which can be compiled and linked into a stand-alone program that can be
129executed. These programs are generally written in high level languages such as
130C or C++, but sometimes they are written straight in LLVM assembly.</p>
131
132<p>These programs are compiled and then executed using several different
133methods (native compiler, LLVM C backend, LLVM JIT, LLVM native code generation,
134etc). The output of these programs is compared to ensure that LLVM is compiling
135the program correctly.</p>
136
137<p>In addition to compiling and executing programs, whole program tests serve as
138a way of benchmarking LLVM performance, both in terms of the efficiency of the
139programs generated as well as the speed with which LLVM compiles, optimizes, and
140generates code.</p>
141
Matthijs Kooijman31ce08f2008-06-24 12:58:31 +0000[diff] [blame]142<p>The test-suite is located in the <tt>test-suite</tt> Subversion module.</p>
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]143
144</div>
145
Devang Patel40d438e2010-11-11 00:13:39 +0000[diff] [blame]146<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]147<h3><a name="debuginfotests">Debugging Information tests</a></h3>
Devang Patel40d438e2010-11-11 00:13:39 +0000[diff] [blame]148<!-- _______________________________________________________________________ -->
149
150<div class="doc_text">
151
152<p>The test suite contains tests to check quality of debugging information.
153The test are written in C based languages or in LLVM assembly language. </p>
154
155<p>These tests are compiled and run under a debugger. The debugger output
156is checked to validate of debugging information. See README.txt in the
157test suite for more information . This test suite is located in the
158<tt>debuginfo-tests</tt> Subversion module. </p>
159
160</div>
161
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]162<!--=========================================================================-->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]163<h2><a name="quick">Quick start</a></h2>
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]164<!--=========================================================================-->
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]165
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]166<div class="doc_text">
Brian Gaekeaf19f2e2003-10-23 18:10:28 +0000[diff] [blame]167
Daniel Dunbarcd3b1172010-08-02 01:20:23 +0000[diff] [blame]168 <p>The tests are located in two separate Subversion modules. The regressions
169 tests are in the main "llvm" module under the directory
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]170 <tt>llvm/test</tt> (so you get these tests for free with the main llvm tree).
Matthijs Kooijman31ce08f2008-06-24 12:58:31 +0000[diff] [blame]171 The more comprehensive test suite that includes whole
172programs in C and C++ is in the <tt>test-suite</tt> module. This module should
173be checked out to the <tt>llvm/projects</tt> directory (don't use another name
Duncan Sandse3f75a32010-11-03 08:16:50 +0000[diff] [blame]174than the default "test-suite", for then the test suite will be run every time
Matthijs Kooijman31ce08f2008-06-24 12:58:31 +0000[diff] [blame]175you run <tt>make</tt> in the main <tt>llvm</tt> directory).
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]176When you <tt>configure</tt> the <tt>llvm</tt> module,
Matthijs Kooijman31ce08f2008-06-24 12:58:31 +0000[diff] [blame]177the <tt>test-suite</tt> directory will be automatically configured.
Reid Spencer669ed452007-07-09 08:04:31 +0000[diff] [blame]178Alternatively, you can configure the <tt>test-suite</tt> module manually.</p>
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]179
180<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]181<h3><a name="quickregressiontests">Regression tests</a></h3>
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]182<!-- _______________________________________________________________________ -->
Daniel Dunbarcd3b1172010-08-02 01:20:23 +0000[diff] [blame]183<p>To run all of the LLVM regression tests, use master Makefile in
184 the <tt>llvm/test</tt> directory:</p>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]185
186<div class="doc_code">
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]187<pre>
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]188% gmake -C llvm/test
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]189</pre>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]190</div>
191
192<p>or</p>
193
194<div class="doc_code">
Tanya Lattner5026c7f2004-12-06 02:11:52 +0000[diff] [blame]195<pre>
196% gmake check
197</pre>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]198</div>
John Criswell0c8a9a12005-05-13 20:25:49 +0000[diff] [blame]199
NAKAMURA Takumib9a33632011-04-09 02:13:37 +0000[diff] [blame]200<p>If you have <a href="http://clang.llvm.org/">Clang</a> checked out and built,
Daniel Dunbarcd3b1172010-08-02 01:20:23 +0000[diff] [blame]201you can run the LLVM and Clang tests simultaneously using:</p>
202
203<p>or</p>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]204
205<div class="doc_code">
Tanya Lattner5026c7f2004-12-06 02:11:52 +0000[diff] [blame]206<pre>
Daniel Dunbarcd3b1172010-08-02 01:20:23 +0000[diff] [blame]207% gmake check-all
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]208</pre>
209</div>
210
Nuno Lopes21bfe0b2008-11-25 15:57:52 +0000[diff] [blame]211<p>To run the tests with Valgrind (Memcheck by default), just append
212<tt>VG=1</tt> to the commands above, e.g.:</p>
213
214<div class="doc_code">
215<pre>
216% gmake check VG=1
217</pre>
218</div>
219
Daniel Dunbarcd3b1172010-08-02 01:20:23 +0000[diff] [blame]220<p>To run individual tests or subsets of tests, you can use the 'llvm-lit'
221script which is built as part of LLVM. For example, to run the
222'Integer/BitCast.ll' test by itself you can run:</p>
223
224<div class="doc_code">
225<pre>
226% llvm-lit ~/llvm/test/Integer/BitCast.ll
227</pre>
228</div>
229
230<p>or to run all of the ARM CodeGen tests:</p>
231
232<div class="doc_code">
233<pre>
234% llvm-lit ~/llvm/test/CodeGen/ARM
235</pre>
236</div>
237
238<p>For more information on using the 'lit' tool, see 'llvm-lit --help' or the
239'lit' man page.</p>
240
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]241<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]242<h3><a name="quicktestsuite">Test suite</a></h3>
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]243<!-- _______________________________________________________________________ -->
244
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]245<p>To run the comprehensive test suite (tests that compile and execute whole
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]246programs), first checkout and setup the <tt>test-suite</tt> module:</p>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]247
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]248<div class="doc_code">
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]249<pre>
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]250% cd llvm/projects
Matthijs Kooijman31ce08f2008-06-24 12:58:31 +0000[diff] [blame]251% svn co http://llvm.org/svn/llvm-project/test-suite/trunk test-suite
Tanya Lattner1de48492007-11-28 05:13:45 +0000[diff] [blame]252% cd ..
253% ./configure --with-llvmgccdir=$LLVM_GCC_DIR
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]254</pre>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]255</div>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]256
Shantonu Sen1b6d3da2009-06-26 05:44:53 +0000[diff] [blame]257<p>where <tt>$LLVM_GCC_DIR</tt> is the directory where
Chris Lattner9372fd32010-11-03 00:30:29 +0000[diff] [blame]258you <em>installed</em> llvm-gcc, not its src or obj
Shantonu Sen1b6d3da2009-06-26 05:44:53 +0000[diff] [blame]259dir. The <tt>--with-llvmgccdir</tt> option assumes that
260the <tt>llvm-gcc-4.2</tt> module was configured with
261<tt>--program-prefix=llvm-</tt>, and therefore that the C and C++
262compiler drivers are called <tt>llvm-gcc</tt> and <tt>llvm-g++</tt>
263respectively. If this is not the case,
264use <tt>--with-llvmgcc</tt>/<tt>--with-llvmgxx</tt> to specify each
265executable's location.</p>
266
Matthijs Kooijman31ce08f2008-06-24 12:58:31 +0000[diff] [blame]267<p>Then, run the entire test suite by running make in the <tt>test-suite</tt>
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]268directory:</p>
269
270<div class="doc_code">
271<pre>
Matthijs Kooijman31ce08f2008-06-24 12:58:31 +0000[diff] [blame]272% cd projects/test-suite
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]273% gmake
274</pre>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]275</div>
276
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]277<p>Usually, running the "nightly" set of tests is a good idea, and you can also
278let it generate a report by running:</p>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]279
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]280<div class="doc_code">
281<pre>
Matthijs Kooijman31ce08f2008-06-24 12:58:31 +0000[diff] [blame]282% cd projects/test-suite
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]283% gmake TEST=nightly report report.html
284</pre>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]285</div>
286
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]287<p>Any of the above commands can also be run in a subdirectory of
Matthijs Kooijman31ce08f2008-06-24 12:58:31 +0000[diff] [blame]288<tt>projects/test-suite</tt> to run the specified test only on the programs in
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]289that subdirectory.</p>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]290
291</div>
292
Devang Patel40d438e2010-11-11 00:13:39 +0000[diff] [blame]293<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]294<h3><a name="quickdebuginfotests">Debugging Information tests</a></h3>
Devang Patel40d438e2010-11-11 00:13:39 +0000[diff] [blame]295<!-- _______________________________________________________________________ -->
NAKAMURA Takumi4d6deb02011-04-09 09:51:57 +0000[diff] [blame]296<div class="doc_text">
Devang Patel40d438e2010-11-11 00:13:39 +0000[diff] [blame]297
298<p> To run debugging information tests simply checkout the tests inside
299clang/test directory. </p>
300
301<div class="doc_code">
302<pre>
303%cd clang/test
304% svn co http://llvm.org/svn/llvm-project/debuginfo-tests/trunk debuginfo-tests
305</pre>
306</div>
307
308<p> These tests are already set up to run as part of clang regression tests.</p>
309
310</div>
311
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]312<!--=========================================================================-->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]313<h2><a name="rtstructure">Regression test structure</a></h2>
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]314<!--=========================================================================-->
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]315<div class="doc_text">
Daniel Dunbarcd3b1172010-08-02 01:20:23 +0000[diff] [blame]316 <p>The LLVM regression tests are driven by 'lit' and are located in
317 the <tt>llvm/test</tt> directory.
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]318
Reid Spencera99256e2007-02-08 17:00:55 +0000[diff] [blame]319 <p>This directory contains a large array of small tests
320 that exercise various features of LLVM and to ensure that regressions do not
321 occur. The directory is broken into several sub-directories, each focused on
Bill Wendlingeb6aace2007-09-22 09:20:07 +0000[diff] [blame]322 a particular area of LLVM. A few of the important ones are:</p>
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]323
Bill Wendlingeb6aace2007-09-22 09:20:07 +0000[diff] [blame]324 <ul>
Reid Spencera99256e2007-02-08 17:00:55 +0000[diff] [blame]325 <li><tt>Analysis</tt>: checks Analysis passes.</li>
326 <li><tt>Archive</tt>: checks the Archive library.</li>
327 <li><tt>Assembler</tt>: checks Assembly reader/writer functionality.</li>
Gabor Greif04367bf2007-07-06 22:07:22 +0000[diff] [blame]328 <li><tt>Bitcode</tt>: checks Bitcode reader/writer functionality.</li>
Reid Spencera99256e2007-02-08 17:00:55 +0000[diff] [blame]329 <li><tt>CodeGen</tt>: checks code generation and each target.</li>
330 <li><tt>Features</tt>: checks various features of the LLVM language.</li>
Gabor Greif04367bf2007-07-06 22:07:22 +0000[diff] [blame]331 <li><tt>Linker</tt>: tests bitcode linking.</li>
Reid Spencera99256e2007-02-08 17:00:55 +0000[diff] [blame]332 <li><tt>Transforms</tt>: tests each of the scalar, IPO, and utility
333 transforms to ensure they make the right transformations.</li>
334 <li><tt>Verifier</tt>: tests the IR verifier.</li>
Bill Wendlingeb6aace2007-09-22 09:20:07 +0000[diff] [blame]335 </ul>
Brian Gaekeaf19f2e2003-10-23 18:10:28 +0000[diff] [blame]336
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]337</div>
Tanya Lattner5026c7f2004-12-06 02:11:52 +0000[diff] [blame]338
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]339<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]340<h3><a name="rtcustom">Writing new regression tests</a></h3>
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]341<!-- _______________________________________________________________________ -->
342<div class="doc_text">
Daniel Dunbarcd3b1172010-08-02 01:20:23 +0000[diff] [blame]343 <p>The regression test structure is very simple, but does require some
344 information to be set. This information is gathered via <tt>configure</tt> and
345 is written to a file, <tt>lit.site.cfg</tt>
346 in <tt>llvm/test</tt>. The <tt>llvm/test</tt> Makefile does this work for
347 you.</p>
Tanya Lattner5026c7f2004-12-06 02:11:52 +0000[diff] [blame]348
Daniel Dunbarcd3b1172010-08-02 01:20:23 +0000[diff] [blame]349 <p>In order for the regression tests to work, each directory of tests must
350 have a <tt>dg.exp</tt> file. Lit looks for this file to determine how to
351 run the tests. This file is just a Tcl script and it can do anything you want,
352 but we've standardized it for the LLVM regression tests. If you're adding a
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]353 directory of tests, just copy <tt>dg.exp</tt> from another directory to get
Daniel Dunbarcd3b1172010-08-02 01:20:23 +0000[diff] [blame]354 running. The standard <tt>dg.exp</tt> simply loads a Tcl library
355 (<tt>test/lib/llvm.exp</tt>) and calls the <tt>llvm_runtests</tt> function
356 defined in that library with a list of file names to run. The names are
357 obtained by using Tcl's glob command. Any directory that contains only
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]358 directories does not need the <tt>dg.exp</tt> file.</p>
Tanya Lattner5026c7f2004-12-06 02:11:52 +0000[diff] [blame]359
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]360 <p>The <tt>llvm-runtests</tt> function lookas at each file that is passed to
361 it and gathers any lines together that match "RUN:". This are the "RUN" lines
362 that specify how the test is to be run. So, each test script must contain
363 RUN lines if it is to do anything. If there are no RUN lines, the
364 <tt>llvm-runtests</tt> function will issue an error and the test will
365 fail.</p>
Misha Brukmanfc1a27b2005-03-10 22:51:59 +0000[diff] [blame]366
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]367 <p>RUN lines are specified in the comments of the test program using the
368 keyword <tt>RUN</tt> followed by a colon, and lastly the command (pipeline)
369 to execute. Together, these lines form the "script" that
370 <tt>llvm-runtests</tt> executes to run the test case. The syntax of the
371 RUN lines is similar to a shell's syntax for pipelines including I/O
372 redirection and variable substitution. However, even though these lines
373 may <i>look</i> like a shell script, they are not. RUN lines are interpreted
374 directly by the Tcl <tt>exec</tt> command. They are never executed by a
375 shell. Consequently the syntax differs from normal shell script syntax in a
376 few ways. You can specify as many RUN lines as needed.</p>
Tanya Lattner5026c7f2004-12-06 02:11:52 +0000[diff] [blame]377
David Greene18d49872011-01-03 17:30:25 +0000[diff] [blame]378 <p>lit performs substitution on each RUN line to replace LLVM tool
379 names with the full paths to the executable built for each tool (in
380 $(LLVM_OBJ_ROOT)/$(BuildMode)/bin). This ensures that lit does not
381 invoke any stray LLVM tools in the user's path during testing.</p>
382
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]383 <p>Each RUN line is executed on its own, distinct from other lines unless
384 its last character is <tt>\</tt>. This continuation character causes the RUN
385 line to be concatenated with the next one. In this way you can build up long
386 pipelines of commands without making huge line lengths. The lines ending in
387 <tt>\</tt> are concatenated until a RUN line that doesn't end in <tt>\</tt> is
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]388 found. This concatenated set of RUN lines then constitutes one execution.
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]389 Tcl will substitute variables and arrange for the pipeline to be executed. If
390 any process in the pipeline fails, the entire line (and test case) fails too.
391 </p>
Tanya Lattner5026c7f2004-12-06 02:11:52 +0000[diff] [blame]392
Reid Spencerf1902772007-04-15 08:01:04 +0000[diff] [blame]393 <p> Below is an example of legal RUN lines in a <tt>.ll</tt> file:</p>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]394
395<div class="doc_code">
396<pre>
397; RUN: llvm-as &lt; %s | llvm-dis &gt; %t1
398; RUN: llvm-dis &lt; %s.bc-13 &gt; %t2
399; RUN: diff %t1 %t2
400</pre>
401</div>
Reid Spencerf1902772007-04-15 08:01:04 +0000[diff] [blame]402
Reid Spencer024a1262007-04-14 23:27:06 +0000[diff] [blame]403 <p>As with a Unix shell, the RUN: lines permit pipelines and I/O redirection
404 to be used. However, the usage is slightly different than for Bash. To check
405 what's legal, see the documentation for the
406 <a href="http://www.tcl.tk/man/tcl8.5/TclCmd/exec.htm#M2">Tcl exec</a>
407 command and the
408 <a href="http://www.tcl.tk/man/tcl8.5/tutorial/Tcl26.html">tutorial</a>.
409 The major differences are:</p>
410 <ul>
411 <li>You can't do <tt>2&gt;&amp;1</tt>. That will cause Tcl to write to a
412 file named <tt>&amp;1</tt>. Usually this is done to get stderr to go through
413 a pipe. You can do that in tcl with <tt>|&amp;</tt> so replace this idiom:
414 <tt>... 2&gt;&amp;1 | grep</tt> with <tt>... |&amp; grep</tt></li>
415 <li>You can only redirect to a file, not to another descriptor and not from
416 a here document.</li>
417 <li>tcl supports redirecting to open files with the @ syntax but you
418 shouldn't use that here.</li>
419 </ul>
420
Reid Spencerf1902772007-04-15 08:01:04 +0000[diff] [blame]421 <p>There are some quoting rules that you must pay attention to when writing
422 your RUN lines. In general nothing needs to be quoted. Tcl won't strip off any
Daniel Dunbarcd3b1172010-08-02 01:20:23 +0000[diff] [blame]423 quote characters so they will get passed to the invoked program. For
424 example:</p>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]425
426<div class="doc_code">
427<pre>
428... | grep 'find this string'
429</pre>
430</div>
431
Reid Spencerf1902772007-04-15 08:01:04 +0000[diff] [blame]432 <p>This will fail because the ' characters are passed to grep. This would
433 instruction grep to look for <tt>'find</tt> in the files <tt>this</tt> and
434 <tt>string'</tt>. To avoid this use curly braces to tell Tcl that it should
435 treat everything enclosed as one value. So our example would become:</p>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]436
437<div class="doc_code">
438<pre>
439... | grep {find this string}
440</pre>
441</div>
442
Reid Spencerf1902772007-04-15 08:01:04 +0000[diff] [blame]443 <p>Additionally, the characters <tt>[</tt> and <tt>]</tt> are treated
444 specially by Tcl. They tell Tcl to interpret the content as a command to
445 execute. Since these characters are often used in regular expressions this can
446 have disastrous results and cause the entire test run in a directory to fail.
447 For example, a common idiom is to look for some basicblock number:</p>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]448
449<div class="doc_code">
450<pre>
451... | grep bb[2-8]
452</pre>
453</div>
454
Reid Spencerf1902772007-04-15 08:01:04 +0000[diff] [blame]455 <p>This, however, will cause Tcl to fail because its going to try to execute
456 a program named "2-8". Instead, what you want is this:</p>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]457
458<div class="doc_code">
459<pre>
460... | grep {bb\[2-8\]}
461</pre>
462</div>
463
Reid Spencerf1902772007-04-15 08:01:04 +0000[diff] [blame]464 <p>Finally, if you need to pass the <tt>\</tt> character down to a program,
465 then it must be doubled. This is another Tcl special character. So, suppose
466 you had:
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]467
468<div class="doc_code">
469<pre>
470... | grep 'i32\*'
471</pre>
472</div>
473
Reid Spencerf1902772007-04-15 08:01:04 +0000[diff] [blame]474 <p>This will fail to match what you want (a pointer to i32). First, the
475 <tt>'</tt> do not get stripped off. Second, the <tt>\</tt> gets stripped off
476 by Tcl so what grep sees is: <tt>'i32*'</tt>. That's not likely to match
477 anything. To resolve this you must use <tt>\\</tt> and the <tt>{}</tt>, like
478 this:</p>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]479
480<div class="doc_code">
481<pre>
482... | grep {i32\\*}
483</pre>
484</div>
Reid Spencerf1902772007-04-15 08:01:04 +0000[diff] [blame]485
Shantonu Sen1b6d3da2009-06-26 05:44:53 +0000[diff] [blame]486<p>If your system includes GNU <tt>grep</tt>, make sure
487that <tt>GREP_OPTIONS</tt> is not set in your environment. Otherwise,
488you may get invalid results (both false positives and false
489negatives).</p>
490
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]491</div>
Tanya Lattner5026c7f2004-12-06 02:11:52 +0000[diff] [blame]492
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]493<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]494<h3><a name="FileCheck">The FileCheck utility</a></h3>
Chris Lattner3d2de1d2009-08-15 15:40:48 +0000[diff] [blame]495<!-- _______________________________________________________________________ -->
496
497<div class="doc_text">
498
499<p>A powerful feature of the RUN: lines is that it allows any arbitrary commands
500 to be executed as part of the test harness. While standard (portable) unix
501 tools like 'grep' work fine on run lines, as you see above, there are a lot
Chris Lattner272e3082009-08-15 16:51:06 +0000[diff] [blame]502 of caveats due to interaction with Tcl syntax, and we want to make sure the
Chris Lattner3d2de1d2009-08-15 15:40:48 +0000[diff] [blame]503 run lines are portable to a wide range of systems. Another major problem is
504 that grep is not very good at checking to verify that the output of a tools
505 contains a series of different output in a specific order. The FileCheck
506 tool was designed to help with these problems.</p>
507
Chris Lattner272e3082009-08-15 16:51:06 +0000[diff] [blame]508<p>FileCheck (whose basic command line arguments are described in <a
509 href="http://llvm.org/cmds/FileCheck.html">the FileCheck man page</a> is
510 designed to read a file to check from standard input, and the set of things
511 to verify from a file specified as a command line argument. A simple example
512 of using FileCheck from a RUN line looks like this:</p>
513
514<div class="doc_code">
515<pre>
516; RUN: llvm-as &lt; %s | llc -march=x86-64 | <b>FileCheck %s</b>
517</pre>
518</div>
Chris Lattner3d2de1d2009-08-15 15:40:48 +0000[diff] [blame]519
Chris Lattner272e3082009-08-15 16:51:06 +0000[diff] [blame]520<p>This syntax says to pipe the current file ("%s") into llvm-as, pipe that into
521llc, then pipe the output of llc into FileCheck. This means that FileCheck will
522be verifying its standard input (the llc output) against the filename argument
523specified (the original .ll file specified by "%s"). To see how this works,
524lets look at the rest of the .ll file (after the RUN line):</p>
525
526<div class="doc_code">
527<pre>
528define void @sub1(i32* %p, i32 %v) {
529entry:
530; <b>CHECK: sub1:</b>
531; <b>CHECK: subl</b>
532 %0 = tail call i32 @llvm.atomic.load.sub.i32.p0i32(i32* %p, i32 %v)
533 ret void
534}
535
536define void @inc4(i64* %p) {
537entry:
538; <b>CHECK: inc4:</b>
539; <b>CHECK: incq</b>
540 %0 = tail call i64 @llvm.atomic.load.add.i64.p0i64(i64* %p, i64 1)
541 ret void
542}
543</pre>
544</div>
545
546<p>Here you can see some "CHECK:" lines specified in comments. Now you can see
547how the file is piped into llvm-as, then llc, and the machine code output is
548what we are verifying. FileCheck checks the machine code output to verify that
549it matches what the "CHECK:" lines specify.</p>
550
551<p>The syntax of the CHECK: lines is very simple: they are fixed strings that
552must occur in order. FileCheck defaults to ignoring horizontal whitespace
553differences (e.g. a space is allowed to match a tab) but otherwise, the contents
554of the CHECK: line is required to match some thing in the test file exactly.</p>
555
556<p>One nice thing about FileCheck (compared to grep) is that it allows merging
557test cases together into logical groups. For example, because the test above
558is checking for the "sub1:" and "inc4:" labels, it will not match unless there
559is a "subl" in between those labels. If it existed somewhere else in the file,
560that would not count: "grep subl" matches if subl exists anywhere in the
561file.</p>
562
Chris Lattner5dafafd2009-08-15 18:32:21 +0000[diff] [blame]563</div>
564
565<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]566<h4>
567 <a name="FileCheck-check-prefix">The FileCheck -check-prefix option</a>
568</h4>
Chris Lattner272e3082009-08-15 16:51:06 +0000[diff] [blame]569
Chris Lattner5dafafd2009-08-15 18:32:21 +0000[diff] [blame]570<div class="doc_text">
571
Chris Lattner272e3082009-08-15 16:51:06 +0000[diff] [blame]572<p>The FileCheck -check-prefix option allows multiple test configurations to be
573driven from one .ll file. This is useful in many circumstances, for example,
574testing different architectural variants with llc. Here's a simple example:</p>
575
Chris Lattner272e3082009-08-15 16:51:06 +0000[diff] [blame]576<div class="doc_code">
577<pre>
578; RUN: llvm-as &lt; %s | llc -mtriple=i686-apple-darwin9 -mattr=sse41 \
579; RUN: | <b>FileCheck %s -check-prefix=X32</b>
580; RUN: llvm-as &lt; %s | llc -mtriple=x86_64-apple-darwin9 -mattr=sse41 \
581; RUN: | <b>FileCheck %s -check-prefix=X64</b>
582
583define &lt;4 x i32&gt; @pinsrd_1(i32 %s, &lt;4 x i32&gt; %tmp) nounwind {
584 %tmp1 = insertelement &lt;4 x i32&gt; %tmp, i32 %s, i32 1
585 ret &lt;4 x i32&gt; %tmp1
586; <b>X32:</b> pinsrd_1:
587; <b>X32:</b> pinsrd $1, 4(%esp), %xmm0
588
589; <b>X64:</b> pinsrd_1:
590; <b>X64:</b> pinsrd $1, %edi, %xmm0
591}
592</pre>
593</div>
594
595<p>In this case, we're testing that we get the expected code generation with
596both 32-bit and 64-bit code generation.</p>
597
Chris Lattner5dafafd2009-08-15 18:32:21 +0000[diff] [blame]598</div>
599
600<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]601<h4>
602 <a name="FileCheck-CHECK-NEXT">The "CHECK-NEXT:" directive</a>
603</h4>
Chris Lattner5dafafd2009-08-15 18:32:21 +0000[diff] [blame]604
605<div class="doc_text">
606
607<p>Sometimes you want to match lines and would like to verify that matches
Duncan Sandsab4c3662011-02-15 09:23:02 +0000[diff] [blame]608happen on exactly consecutive lines with no other lines in between them. In
Chris Lattner5dafafd2009-08-15 18:32:21 +0000[diff] [blame]609this case, you can use CHECK: and CHECK-NEXT: directives to specify this. If
610you specified a custom check prefix, just use "&lt;PREFIX&gt;-NEXT:". For
611example, something like this works as you'd expect:</p>
612
613<div class="doc_code">
614<pre>
Chris Lattnere93f3732009-08-15 18:33:10 +0000[diff] [blame]615define void @t2(&lt;2 x double&gt;* %r, &lt;2 x double&gt;* %A, double %B) {
Chris Lattner5dafafd2009-08-15 18:32:21 +0000[diff] [blame]616 %tmp3 = load &lt;2 x double&gt;* %A, align 16
617 %tmp7 = insertelement &lt;2 x double&gt; undef, double %B, i32 0
Chris Lattnere93f3732009-08-15 18:33:10 +0000[diff] [blame]618 %tmp9 = shufflevector &lt;2 x double&gt; %tmp3,
619 &lt;2 x double&gt; %tmp7,
620 &lt;2 x i32&gt; &lt; i32 0, i32 2 &gt;
Chris Lattner5dafafd2009-08-15 18:32:21 +0000[diff] [blame]621 store &lt;2 x double&gt; %tmp9, &lt;2 x double&gt;* %r, align 16
622 ret void
623
624; <b>CHECK:</b> t2:
625; <b>CHECK:</b> movl 8(%esp), %eax
626; <b>CHECK-NEXT:</b> movapd (%eax), %xmm0
627; <b>CHECK-NEXT:</b> movhpd 12(%esp), %xmm0
628; <b>CHECK-NEXT:</b> movl 4(%esp), %eax
629; <b>CHECK-NEXT:</b> movapd %xmm0, (%eax)
630; <b>CHECK-NEXT:</b> ret
631}
632</pre>
633</div>
634
635<p>CHECK-NEXT: directives reject the input unless there is exactly one newline
636between it an the previous directive. A CHECK-NEXT cannot be the first
637directive in a file.</p>
Chris Lattner3d2de1d2009-08-15 15:40:48 +0000[diff] [blame]638
639</div>
640
641<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]642<h4>
643 <a name="FileCheck-CHECK-NOT">The "CHECK-NOT:" directive</a>
644</h4>
Chris Lattnerf15380b2009-09-20 22:35:26 +0000[diff] [blame]645
646<div class="doc_text">
647
648<p>The CHECK-NOT: directive is used to verify that a string doesn't occur
Chris Lattner4d0764d2009-09-20 22:45:18 +0000[diff] [blame]649between two matches (or the first match and the beginning of the file). For
Chris Lattnerf15380b2009-09-20 22:35:26 +0000[diff] [blame]650example, to verify that a load is removed by a transformation, a test like this
651can be used:</p>
652
653<div class="doc_code">
654<pre>
655define i8 @coerce_offset0(i32 %V, i32* %P) {
656 store i32 %V, i32* %P
657
658 %P2 = bitcast i32* %P to i8*
659 %P3 = getelementptr i8* %P2, i32 2
660
661 %A = load i8* %P3
662 ret i8 %A
663; <b>CHECK:</b> @coerce_offset0
664; <b>CHECK-NOT:</b> load
665; <b>CHECK:</b> ret i8
666}
667</pre>
668</div>
669
670</div>
671
672<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]673<h4>
674 <a name="FileCheck-Matching">FileCheck Pattern Matching Syntax</a>
675</h4>
Chris Lattner52870082009-09-24 21:47:32 +0000[diff] [blame]676
677<div class="doc_text">
678
679<p>The CHECK: and CHECK-NOT: directives both take a pattern to match. For most
680uses of FileCheck, fixed string matching is perfectly sufficient. For some
681things, a more flexible form of matching is desired. To support this, FileCheck
682allows you to specify regular expressions in matching strings, surrounded by
683double braces: <b>{{yourregex}}</b>. Because we want to use fixed string
684matching for a majority of what we do, FileCheck has been designed to support
685mixing and matching fixed string matching with regular expressions. This allows
686you to write things like this:</p>
687
688<div class="doc_code">
689<pre>
690; CHECK: movhpd <b>{{[0-9]+}}</b>(%esp), <b>{{%xmm[0-7]}}</b>
691</pre>
692</div>
693
694<p>In this case, any offset from the ESP register will be allowed, and any xmm
695register will be allowed.</p>
696
697<p>Because regular expressions are enclosed with double braces, they are
698visually distinct, and you don't need to use escape characters within the double
699braces like you would in C. In the rare case that you want to match double
700braces explicitly from the input, you can use something ugly like
701<b>{{[{][{]}}</b> as your pattern.</p>
702
703</div>
704
Chris Lattnereec96952009-09-27 07:56:52 +0000[diff] [blame]705<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]706<h4>
707 <a name="FileCheck-Variables">FileCheck Variables</a>
708</h4>
Chris Lattner52870082009-09-24 21:47:32 +0000[diff] [blame]709
Chris Lattnereec96952009-09-27 07:56:52 +0000[diff] [blame]710<div class="doc_text">
711
712<p>It is often useful to match a pattern and then verify that it occurs again
713later in the file. For codegen tests, this can be useful to allow any register,
714but verify that that register is used consistently later. To do this, FileCheck
715allows named variables to be defined and substituted into patterns. Here is a
716simple example:</p>
717
718<div class="doc_code">
719<pre>
720; CHECK: test5:
Chris Lattner9217f6b2009-09-27 08:01:44 +0000[diff] [blame]721; CHECK: notw <b>[[REGISTER:%[a-z]+]]</b>
722; CHECK: andw {{.*}}<b>[[REGISTER]]</b>
Chris Lattnereec96952009-09-27 07:56:52 +0000[diff] [blame]723</pre>
724</div>
725
Chris Lattner9217f6b2009-09-27 08:01:44 +0000[diff] [blame]726<p>The first check line matches a regex (<tt>%[a-z]+</tt>) and captures it into
727the variables "REGISTER". The second line verifies that whatever is in REGISTER
728occurs later in the file after an "andw". FileCheck variable references are
729always contained in <tt>[[ ]]</tt> pairs, are named, and their names can be
730formed with the regex "<tt>[a-zA-Z][a-zA-Z0-9]*</tt>". If a colon follows the
731name, then it is a definition of the variable, if not, it is a use.</p>
Chris Lattnereec96952009-09-27 07:56:52 +0000[diff] [blame]732
733<p>FileCheck variables can be defined multiple times, and uses always get the
734latest value. Note that variables are all read at the start of a "CHECK" line
735and are all defined at the end. This means that if you have something like
736"<tt>CHECK: [[XYZ:.*]]x[[XYZ]]</tt>" that the check line will read the previous
737value of the XYZ variable and define a new one after the match is performed. If
738you need to do something like this you can probably take advantage of the fact
739that FileCheck is not actually line-oriented when it matches, this allows you to
740define two separate CHECK lines that match on the same line.
741</p>
742
Chris Lattnereec96952009-09-27 07:56:52 +0000[diff] [blame]743</div>
Chris Lattner52870082009-09-24 21:47:32 +0000[diff] [blame]744
745<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]746<h3><a name="rtvars">Variables and substitutions</a></h3>
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]747<!-- _______________________________________________________________________ -->
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]748<div class="doc_text">
749 <p>With a RUN line there are a number of substitutions that are permitted. In
750 general, any Tcl variable that is available in the <tt>substitute</tt>
751 function (in <tt>test/lib/llvm.exp</tt>) can be substituted into a RUN line.
752 To make a substitution just write the variable's name preceded by a $.
753 Additionally, for compatibility reasons with previous versions of the test
754 library, certain names can be accessed with an alternate syntax: a % prefix.
755 These alternates are deprecated and may go away in a future version.
756 </p>
Bill Wendlingeb6aace2007-09-22 09:20:07 +0000[diff] [blame]757 <p>Here are the available variable names. The alternate syntax is listed in
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]758 parentheses.</p>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]759
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]760 <dl style="margin-left: 25px">
761 <dt><b>$test</b> (%s)</dt>
762 <dd>The full path to the test case's source. This is suitable for passing
763 on the command line as the input to an llvm tool.</dd>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]764
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]765 <dt><b>$srcdir</b></dt>
766 <dd>The source directory from where the "<tt>make check</tt>" was run.</dd>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]767
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]768 <dt><b>objdir</b></dt>
Bill Wendlingeb6aace2007-09-22 09:20:07 +0000[diff] [blame]769 <dd>The object directory that corresponds to the <tt>$srcdir</tt>.</dd>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]770
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]771 <dt><b>subdir</b></dt>
772 <dd>A partial path from the <tt>test</tt> directory that contains the
773 sub-directory that contains the test source being executed.</dd>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]774
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]775 <dt><b>srcroot</b></dt>
776 <dd>The root directory of the LLVM src tree.</dd>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]777
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]778 <dt><b>objroot</b></dt>
779 <dd>The root directory of the LLVM object tree. This could be the same
780 as the srcroot.</dd>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]781
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]782 <dt><b>path</b><dt>
783 <dd>The path to the directory that contains the test case source. This is
784 for locating any supporting files that are not generated by the test, but
785 used by the test.</dd>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]786
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]787 <dt><b>tmp</b></dt>
788 <dd>The path to a temporary file name that could be used for this test case.
789 The file name won't conflict with other test cases. You can append to it if
790 you need multiple temporaries. This is useful as the destination of some
791 redirected output.</dd>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]792
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]793 <dt><b>llvmlibsdir</b> (%llvmlibsdir)</dt>
794 <dd>The directory where the LLVM libraries are located.</dd>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]795
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]796 <dt><b>target_triplet</b> (%target_triplet)</dt>
797 <dd>The target triplet that corresponds to the current host machine (the one
798 running the test cases). This should probably be called "host".<dd>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]799
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]800 <dt><b>llvmgcc</b> (%llvmgcc)</dt>
801 <dd>The full path to the <tt>llvm-gcc</tt> executable as specified in the
802 configured LLVM environment</dd>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]803
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]804 <dt><b>llvmgxx</b> (%llvmgxx)</dt>
805 <dd>The full path to the <tt>llvm-gxx</tt> executable as specified in the
806 configured LLVM environment</dd>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]807
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]808 <dt><b>gccpath</b></dt>
809 <dd>The full path to the C compiler used to <i>build </i> LLVM. Note that
810 this might not be gcc.</dd>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]811
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]812 <dt><b>gxxpath</b></dt>
813 <dd>The full path to the C++ compiler used to <i>build </i> LLVM. Note that
814 this might not be g++.</dd>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]815
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]816 <dt><b>compile_c</b> (%compile_c)</dt>
817 <dd>The full command line used to compile LLVM C source code. This has all
818 the configured -I, -D and optimization options.</dd>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]819
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]820 <dt><b>compile_cxx</b> (%compile_cxx)</dt>
821 <dd>The full command used to compile LLVM C++ source code. This has
822 all the configured -I, -D and optimization options.</dd>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]823
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]824 <dt><b>link</b> (%link)</dt>
825 <dd>This full link command used to link LLVM executables. This has all the
826 configured -I, -L and -l options.</dd>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]827
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]828 <dt><b>shlibext</b> (%shlibext)</dt>
829 <dd>The suffix for the host platforms share library (dll) files. This
830 includes the period as the first character.</dd>
831 </dl>
832 <p>To add more variables, two things need to be changed. First, add a line in
833 the <tt>test/Makefile</tt> that creates the <tt>site.exp</tt> file. This will
834 "set" the variable as a global in the site.exp file. Second, in the
835 <tt>test/lib/llvm.exp</tt> file, in the substitute proc, add the variable name
836 to the list of "global" declarations at the beginning of the proc. That's it,
837 the variable can then be used in test scripts.</p>
838</div>
839
840<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]841<h3><a name="rtfeatures">Other Features</a></h3>
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]842<!-- _______________________________________________________________________ -->
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]843<div class="doc_text">
844 <p>To make RUN line writing easier, there are several shell scripts located
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]845 in the <tt>llvm/test/Scripts</tt> directory. This directory is in the PATH
846 when running tests, so you can just call these scripts using their name. For
847 example:</p>
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]848 <dl>
849 <dt><b>ignore</b></dt>
850 <dd>This script runs its arguments and then always returns 0. This is useful
851 in cases where the test needs to cause a tool to generate an error (e.g. to
852 check the error output). However, any program in a pipeline that returns a
853 non-zero result will cause the test to fail. This script overcomes that
854 issue and nicely documents that the test case is purposefully ignoring the
855 result code of the tool</dd>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]856
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]857 <dt><b>not</b></dt>
858 <dd>This script runs its arguments and then inverts the result code from
859 it. Zero result codes become 1. Non-zero result codes become 0. This is
860 useful to invert the result of a grep. For example "not grep X" means
861 succeed only if you don't find X in the input.</dd>
862 </dl>
Tanya Lattner5026c7f2004-12-06 02:11:52 +0000[diff] [blame]863
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]864 <p>Sometimes it is necessary to mark a test case as "expected fail" or XFAIL.
Daniel Dunbar3d4d01b2010-02-23 07:56:28 +0000[diff] [blame]865 You can easily mark a test as XFAIL just by including <tt>XFAIL: </tt> on a
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]866 line near the top of the file. This signals that the test case should succeed
Daniel Dunbarcd3b1172010-08-02 01:20:23 +0000[diff] [blame]867 if the test fails. Such test cases are counted separately by the testing tool. To
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]868 specify an expected fail, use the XFAIL keyword in the comments of the test
869 program followed by a colon and one or more regular expressions (separated by
Daniel Dunbar3d4d01b2010-02-23 07:56:28 +0000[diff] [blame]870 a comma). The regular expressions allow you to XFAIL the test conditionally by
871 host platform. The regular expressions following the : are matched against the
872 target triplet for the host machine. If there is a match, the test is expected
873 to fail. If not, the test is expected to succeed. To XFAIL everywhere just
874 specify <tt>XFAIL: *</tt>. Here is an example of an <tt>XFAIL</tt> line:</p>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]875
876<div class="doc_code">
877<pre>
Daniel Dunbar3d4d01b2010-02-23 07:56:28 +0000[diff] [blame]878; XFAIL: darwin,sun
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]879</pre>
880</div>
Tanya Lattner5026c7f2004-12-06 02:11:52 +0000[diff] [blame]881
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]882 <p>To make the output more useful, the <tt>llvm_runtest</tt> function wil
883 scan the lines of the test case for ones that contain a pattern that matches
884 PR[0-9]+. This is the syntax for specifying a PR (Problem Report) number that
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]885 is related to the test case. The number after "PR" specifies the LLVM bugzilla
Reid Spencerbbb2a7a2007-04-14 21:46:15 +0000[diff] [blame]886 number. When a PR number is specified, it will be used in the pass/fail
887 reporting. This is useful to quickly get some context when a test fails.</p>
888
889 <p>Finally, any line that contains "END." will cause the special
890 interpretation of lines to terminate. This is generally done right after the
891 last RUN: line. This has two side effects: (a) it prevents special
892 interpretation of lines that are part of the test program, not the
893 instructions to the test case, and (b) it speeds things up for really big test
894 cases by avoiding interpretation of the remainder of the file.</p>
Tanya Lattner5026c7f2004-12-06 02:11:52 +0000[diff] [blame]895
896</div>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]897
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]898<!--=========================================================================-->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]899<h2><a name="testsuitestructure">Test suite Structure</a></h2>
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]900<!--=========================================================================-->
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]901
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]902<div class="doc_text">
Brian Gaekeaf19f2e2003-10-23 18:10:28 +0000[diff] [blame]903
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]904<p>The <tt>test-suite</tt> module contains a number of programs that can be compiled
905with LLVM and executed. These programs are compiled using the native compiler
906and various LLVM backends. The output from the program compiled with the
907native compiler is assumed correct; the results from the other programs are
908compared to the native program output and pass if they match.</p>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]909
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]910<p>When executing tests, it is usually a good idea to start out with a subset of
911the available tests or programs. This makes test run times smaller at first and
912later on this is useful to investigate individual test failures. To run some
913test only on a subset of programs, simply change directory to the programs you
914want tested and run <tt>gmake</tt> there. Alternatively, you can run a different
915test using the <tt>TEST</tt> variable to change what tests or run on the
916selected programs (see below for more info).</p>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]917
Andrew Trickbcf01162010-09-23 20:26:44 +0000[diff] [blame]918<p>In addition for testing correctness, the <tt>test-suite</tt> directory also
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]919performs timing tests of various LLVM optimizations. It also records
920compilation times for the compilers and the JIT. This information can be
921used to compare the effectiveness of LLVM's optimizations and code
922generation.</p>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]923
Andrew Trickbcf01162010-09-23 20:26:44 +0000[diff] [blame]924<p><tt>test-suite</tt> tests are divided into three types of tests: MultiSource,
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]925SingleSource, and External.</p>
Reid Spencer3281ead2004-12-08 16:52:51 +0000[diff] [blame]926
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]927<ul>
Andrew Trickbcf01162010-09-23 20:26:44 +0000[diff] [blame]928<li><tt>test-suite/SingleSource</tt>
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]929<p>The SingleSource directory contains test programs that are only a single
930source file in size. These are usually small benchmark programs or small
931programs that calculate a particular value. Several such programs are grouped
932together in each directory.</p></li>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]933
Andrew Trickbcf01162010-09-23 20:26:44 +0000[diff] [blame]934<li><tt>test-suite/MultiSource</tt>
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]935<p>The MultiSource directory contains subdirectories which contain entire
936programs with multiple source files. Large benchmarks and whole applications
937go here.</p></li>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]938
Andrew Trickbcf01162010-09-23 20:26:44 +0000[diff] [blame]939<li><tt>test-suite/External</tt>
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]940<p>The External directory contains Makefiles for building code that is external
941to (i.e., not distributed with) LLVM. The most prominent members of this
942directory are the SPEC 95 and SPEC 2000 benchmark suites. The <tt>External</tt>
Stuart Hastingsc4c268b2009-05-21 20:23:59 +0000[diff] [blame]943directory does not contain these actual tests, but only the Makefiles that know
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]944how to properly compile these programs from somewhere else. The presence and
Andrew Trickbcf01162010-09-23 20:26:44 +0000[diff] [blame]945location of these external programs is configured by the test-suite
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]946<tt>configure</tt> script.</p></li>
947</ul>
948
949<p>Each tree is then subdivided into several categories, including applications,
950benchmarks, regression tests, code that is strange grammatically, etc. These
951organizations should be relatively self explanatory.</p>
952
953<p>Some tests are known to fail. Some are bugs that we have not fixed yet;
Daniel Dunbarcd3b1172010-08-02 01:20:23 +0000[diff] [blame]954others are features that we haven't added yet (or may never add). In the
955regression tests, the result for such tests will be XFAIL (eXpected FAILure).
956In this way, you can tell the difference between an expected and unexpected
957failure.</p>
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]958
Matthijs Kooijman31ce08f2008-06-24 12:58:31 +0000[diff] [blame]959<p>The tests in the test suite have no such feature at this time. If the
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]960test passes, only warnings and other miscellaneous output will be generated. If
961a test fails, a large &lt;program&gt; FAILED message will be displayed. This
962will help you separate benign warnings from actual test failures.</p>
963
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]964</div>
965
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]966<!--=========================================================================-->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]967<h2><a name="testsuiterun">Running the test suite</a></h2>
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]968<!--=========================================================================-->
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]969
970<div class="doc_text">
971
972<p>First, all tests are executed within the LLVM object directory tree. They
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]973<i>are not</i> executed inside of the LLVM source tree. This is because the
John Mosby3228abe2009-03-30 18:56:53 +0000[diff] [blame]974test suite creates temporary files during execution.</p>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]975
Matthijs Kooijman31ce08f2008-06-24 12:58:31 +0000[diff] [blame]976<p>To run the test suite, you need to use the following steps:</p>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]977
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]978<ol>
John Mosby24446d62009-03-30 04:37:51 +0000[diff] [blame]979 <li><tt>cd</tt> into the <tt>llvm/projects</tt> directory in your source tree.
980 </li>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]981
982 <li><p>Check out the <tt>test-suite</tt> module with:</p>
983
984<div class="doc_code">
985<pre>
Matthijs Kooijman31ce08f2008-06-24 12:58:31 +0000[diff] [blame]986% svn co http://llvm.org/svn/llvm-project/test-suite/trunk test-suite
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]987</pre>
988</div>
Stuart Hastingsc4c268b2009-05-21 20:23:59 +0000[diff] [blame]989 <p>This will get the test suite into <tt>llvm/projects/test-suite</tt>.</p>
John Mosby24446d62009-03-30 04:37:51 +0000[diff] [blame]990 </li>
Stuart Hastingsc4c268b2009-05-21 20:23:59 +0000[diff] [blame]991 <li><p>Configure and build <tt>llvm</tt>.</p></li>
992 <li><p>Configure and build <tt>llvm-gcc</tt>.</p></li>
993 <li><p>Install <tt>llvm-gcc</tt> somewhere.</p></li>
994 <li><p><em>Re-configure</em> <tt>llvm</tt> from the top level of
995 each build tree (LLVM object directory tree) in which you want
996 to run the test suite, just as you do before building LLVM.</p>
997 <p>During the <em>re-configuration</em>, you must either: (1)
998 have <tt>llvm-gcc</tt> you just built in your path, or (2)
999 specify the directory where your just-built <tt>llvm-gcc</tt> is
1000 installed using <tt>--with-llvmgccdir=$LLVM_GCC_DIR</tt>.</p>
1001 <p>You must also tell the configure machinery that the test suite
1002 is available so it can be configured for your build tree:</p>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]1003<div class="doc_code">
1004<pre>
John Mosby24446d62009-03-30 04:37:51 +0000[diff] [blame]1005% cd $LLVM_OBJ_ROOT ; $LLVM_SRC_ROOT/configure [--with-llvmgccdir=$LLVM_GCC_DIR]
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]1006</pre>
1007</div>
John Mosby24446d62009-03-30 04:37:51 +0000[diff] [blame]1008 <p>[Remember that <tt>$LLVM_GCC_DIR</tt> is the directory where you
1009 <em>installed</em> llvm-gcc, not its src or obj directory.]</p>
Matthijs Kooijmand30020a2008-05-20 10:28:55 +0000[diff] [blame]1010 </li>
1011
John Mosby24446d62009-03-30 04:37:51 +0000[diff] [blame]1012 <li><p>You can now run the test suite from your build tree as follows:</p>
1013<div class="doc_code">
1014<pre>
1015% cd $LLVM_OBJ_ROOT/projects/test-suite
1016% make
1017</pre>
1018</div>
1019 </li>
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]1020</ol>
1021<p>Note that the second and third steps only need to be done once. After you
1022have the suite checked out and configured, you don't need to do it again (unless
Matthijs Kooijmand30020a2008-05-20 10:28:55 +0000[diff] [blame]1023the test code or configure script changes).</p>
Reid Spencer8284f1f2004-09-05 20:07:26 +0000[diff] [blame]1024
Shantonu Sen1b6d3da2009-06-26 05:44:53 +0000[diff] [blame]1025</div>
1026
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]1027<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1028<h3>
1029 <a name="testsuiteexternal">Configuring External Tests</a>
1030</h3>
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]1031<!-- _______________________________________________________________________ -->
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]1032
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]1033<div class="doc_text">
Stuart Hastingsc4c268b2009-05-21 20:23:59 +0000[diff] [blame]1034<p>In order to run the External tests in the <tt>test-suite</tt>
1035 module, you must specify <i>--with-externals</i>. This
1036 must be done during the <em>re-configuration</em> step (see above),
1037 and the <tt>llvm</tt> re-configuration must recognize the
1038 previously-built <tt>llvm-gcc</tt>. If any of these is missing or
1039 neglected, the External tests won't work.</p>
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]1040<dl>
Dale Johannesen80b99022008-12-10 01:58:32 +0000[diff] [blame]1041<dt><i>--with-externals</i></dt>
1042<dt><i>--with-externals=&lt;<tt>directory</tt>&gt;</i></dt>
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]1043</dl>
Dale Johannesen80b99022008-12-10 01:58:32 +0000[diff] [blame]1044 This tells LLVM where to find any external tests. They are expected to be
1045 in specifically named subdirectories of &lt;<tt>directory</tt>&gt;.
1046 If <tt>directory</tt> is left unspecified,
1047 <tt>configure</tt> uses the default value
1048 <tt>/home/vadve/shared/benchmarks/speccpu2000/benchspec</tt>.
1049 Subdirectory names known to LLVM include:
1050 <dl>
1051 <dt>spec95</dt>
1052 <dt>speccpu2000</dt>
1053 <dt>speccpu2006</dt>
1054 <dt>povray31</dt>
1055 </dl>
1056 Others are added from time to time, and can be determined from
1057 <tt>configure</tt>.
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]1058</div>
1059
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]1060<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1061<h3>
1062 <a name="testsuitetests">Running different tests</a>
1063</h3>
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]1064<!-- _______________________________________________________________________ -->
1065<div class="doc_text">
Stuart Hastingsc4c268b2009-05-21 20:23:59 +0000[diff] [blame]1066<p>In addition to the regular "whole program" tests, the <tt>test-suite</tt>
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]1067module also provides a mechanism for compiling the programs in different ways.
Matthijs Kooijman31ce08f2008-06-24 12:58:31 +0000[diff] [blame]1068If the variable TEST is defined on the <tt>gmake</tt> command line, the test system will
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]1069include a Makefile named <tt>TEST.&lt;value of TEST variable&gt;.Makefile</tt>.
1070This Makefile can modify build rules to yield different results.</p>
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]1071
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]1072<p>For example, the LLVM nightly tester uses <tt>TEST.nightly.Makefile</tt> to
1073create the nightly test reports. To run the nightly tests, run <tt>gmake
1074TEST=nightly</tt>.</p>
1075
1076<p>There are several TEST Makefiles available in the tree. Some of them are
1077designed for internal LLVM research and will not work outside of the LLVM
1078research group. They may still be valuable, however, as a guide to writing your
1079own TEST Makefile for any optimization or analysis passes that you develop with
1080LLVM.</p>
1081
Bill Wendlingda51c4c2007-09-22 09:16:44 +0000[diff] [blame]1082</div>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]1083
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]1084<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1085<h3>
1086 <a name="testsuiteoutput">Generating test output</a>
1087</h3>
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]1088<!-- _______________________________________________________________________ -->
1089<div class="doc_text">
1090 <p>There are a number of ways to run the tests and generate output. The most
1091 simple one is simply running <tt>gmake</tt> with no arguments. This will
1092 compile and run all programs in the tree using a number of different methods
1093 and compare results. Any failures are reported in the output, but are likely
1094 drowned in the other output. Passes are not reported explicitely.</p>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]1095
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]1096 <p>Somewhat better is running <tt>gmake TEST=sometest test</tt>, which runs
1097 the specified test and usually adds per-program summaries to the output
1098 (depending on which sometest you use). For example, the <tt>nightly</tt> test
1099 explicitely outputs TEST-PASS or TEST-FAIL for every test after each program.
1100 Though these lines are still drowned in the output, it's easy to grep the
1101 output logs in the Output directories.</p>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]1102
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]1103 <p>Even better are the <tt>report</tt> and <tt>report.format</tt> targets
1104 (where <tt>format</tt> is one of <tt>html</tt>, <tt>csv</tt>, <tt>text</tt> or
1105 <tt>graphs</tt>). The exact contents of the report are dependent on which
1106 <tt>TEST</tt> you are running, but the text results are always shown at the
1107 end of the run and the results are always stored in the
1108 <tt>report.&lt;type&gt;.format</tt> file (when running with
1109 <tt>TEST=&lt;type&gt;</tt>).
Chris Lattnerfd9d1b32004-06-24 20:53:09 +0000[diff] [blame]1110
Matthijs Kooijman6fce8442008-05-23 11:45:18 +0000[diff] [blame]1111 The <tt>report</tt> also generate a file called
1112 <tt>report.&lt;type&gt;.raw.out</tt> containing the output of the entire test
1113 run.
Chris Lattnerfd9d1b32004-06-24 20:53:09 +0000[diff] [blame]1114</div>
1115
Chris Lattnereb82da82006-05-23 01:40:20 +0000[diff] [blame]1116<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1117<h3>
1118 <a name="testsuitecustom">Writing custom tests for the test suite</a>
1119</h3>
Chris Lattnereb82da82006-05-23 01:40:20 +0000[diff] [blame]1120<!-- _______________________________________________________________________ -->
1121
1122<div class="doc_text">
1123
Matthijs Kooijman31ce08f2008-06-24 12:58:31 +0000[diff] [blame]1124<p>Assuming you can run the test suite, (e.g. "<tt>gmake TEST=nightly report</tt>"
Chris Lattnereb82da82006-05-23 01:40:20 +0000[diff] [blame]1125should work), it is really easy to run optimizations or code generator
1126components against every program in the tree, collecting statistics or running
1127custom checks for correctness. At base, this is how the nightly tester works,
1128it's just one example of a general framework.</p>
1129
1130<p>Lets say that you have an LLVM optimization pass, and you want to see how
1131many times it triggers. First thing you should do is add an LLVM
1132<a href="ProgrammersManual.html#Statistic">statistic</a> to your pass, which
1133will tally counts of things you care about.</p>
1134
1135<p>Following this, you can set up a test and a report that collects these and
Andrew Trickbcf01162010-09-23 20:26:44 +0000[diff] [blame]1136formats them for easy viewing. This consists of two files, a
Matthijs Kooijman31ce08f2008-06-24 12:58:31 +0000[diff] [blame]1137"<tt>test-suite/TEST.XXX.Makefile</tt>" fragment (where XXX is the name of your
Andrew Trickbcf01162010-09-23 20:26:44 +0000[diff] [blame]1138test) and a "<tt>test-suite/TEST.XXX.report</tt>" file that indicates how to
Chris Lattnereb82da82006-05-23 01:40:20 +0000[diff] [blame]1139format the output into a table. There are many example reports of various
Matthijs Kooijman31ce08f2008-06-24 12:58:31 +0000[diff] [blame]1140levels of sophistication included with the test suite, and the framework is very
Chris Lattnereb82da82006-05-23 01:40:20 +0000[diff] [blame]1141general.</p>
1142
1143<p>If you are interested in testing an optimization pass, check out the
1144"libcalls" test as an example. It can be run like this:<p>
1145
1146<div class="doc_code">
1147<pre>
Matthijs Kooijman31ce08f2008-06-24 12:58:31 +0000[diff] [blame]1148% cd llvm/projects/test-suite/MultiSource/Benchmarks # or some other level
Chris Lattnereb82da82006-05-23 01:40:20 +0000[diff] [blame]1149% make TEST=libcalls report
1150</pre>
1151</div>
1152
1153<p>This will do a bunch of stuff, then eventually print a table like this:</p>
1154
1155<div class="doc_code">
1156<pre>
1157Name | total | #exit |
1158...
1159FreeBench/analyzer/analyzer | 51 | 6 |
1160FreeBench/fourinarow/fourinarow | 1 | 1 |
1161FreeBench/neural/neural | 19 | 9 |
1162FreeBench/pifft/pifft | 5 | 3 |
1163MallocBench/cfrac/cfrac | 1 | * |
1164MallocBench/espresso/espresso | 52 | 12 |
1165MallocBench/gs/gs | 4 | * |
1166Prolangs-C/TimberWolfMC/timberwolfmc | 302 | * |
1167Prolangs-C/agrep/agrep | 33 | 12 |
1168Prolangs-C/allroots/allroots | * | * |
1169Prolangs-C/assembler/assembler | 47 | * |
1170Prolangs-C/bison/mybison | 74 | * |
1171...
1172</pre>
1173</div>
1174
1175<p>This basically is grepping the -stats output and displaying it in a table.
1176You can also use the "TEST=libcalls report.html" target to get the table in HTML
1177form, similarly for report.csv and report.tex.</p>
1178
Matthijs Kooijman31ce08f2008-06-24 12:58:31 +0000[diff] [blame]1179<p>The source for this is in test-suite/TEST.libcalls.*. The format is pretty
Chris Lattnereb82da82006-05-23 01:40:20 +0000[diff] [blame]1180simple: the Makefile indicates how to run the test (in this case,
1181"<tt>opt -simplify-libcalls -stats</tt>"), and the report contains one line for
1182each column of the output. The first value is the header for the column and the
1183second is the regex to grep the output of the command for. There are lots of
1184example reports that can do fancy stuff.</p>
1185
1186</div>
1187
Brian Gaekeaf19f2e2003-10-23 18:10:28 +0000[diff] [blame]1188<!-- *********************************************************************** -->
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]1189
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]1190<hr>
1191<address>
1192 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +0000[diff] [blame]1193 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]1194 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +0000[diff] [blame]1195 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Brian Gaekeaf19f2e2003-10-23 18:10:28 +0000[diff] [blame]1196
Daniel Dunbarcd3b1172010-08-02 01:20:23 +0000[diff] [blame]1197 John T. Criswell, Daniel Dunbar, Reid Spencer, and Tanya Lattner<br>
NAKAMURA Takumib9a33632011-04-09 02:13:37 +0000[diff] [blame]1198 <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br>
Misha Brukman1d83e112004-03-01 18:21:04 +0000[diff] [blame]1199 Last modified: $Date$
1200</address>
Brian Gaekeaf19f2e2003-10-23 18:10:28 +0000[diff] [blame]1201</body>
John Criswell020cbd82003-10-10 18:42:49 +0000[diff] [blame]1202</html>