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