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