Blame - docs/TestingGuide.html - fp2-dev/platform/external/llvm

blob: 841974da3cdfa715a78eb0a27c34d84a6c9e6703 [file] [log] [blame]

Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	1	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
				2	"http://www.w3.org/TR/html4/strict.dtd">
				3	<html>
				4	<head>
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	5	<title>LLVM Testing Infrastructure Guide</title>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	6	<link rel="stylesheet" href="llvm.css" type="text/css">
				7	</head>
				8	<body>
				9
				10	<div class="doc_title">
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	11	LLVM Testing Infrastructure Guide
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	12	</div>
				13
				14	<ol>
				15	<li><a href="#overview">Overview</a></li>
Matthijs Kooijman	977ffef	2008-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>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	18	<ul>
Matthijs Kooijman	977ffef	2008-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>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	21	</ul>
				22	</li>
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	23	<li><a href="#quick">Quick start</a>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	24	<ul>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	25	<li><a href="#quickdejagnu">DejaGNU tests</a></li>
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	26	<li><a href="#quicktestsuite">Test suite</a></li>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	27	</ul>
				28	</li>
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	29	<li><a href="#dgstructure">DejaGNU structure</a>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	30	<ul>
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	31	<li><a href="#dgcustom">Writing new DejaGNU tests</a></li>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	32	<li><a href="#dgvars">Variables and substitutions</a></li>
				33	<li><a href="#dgfeatures">Other features</a></li>
				34	</ul>
				35	</li>
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	36	<li><a href="#testsuitestructure">Test suite structure</a></li>
				37	<li><a href="#testsuiterun">Running the test suite</a>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	38	<ul>
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	39	<li><a href="#testsuiteexternal">Configuring external tests</a></li>
				40	<li><a href="#testsuitetests">Running different tests</a></li>
				41	<li><a href="#testsuiteoutput">Generating test output</a></li>
				42	<li><a href="#testsuitecustom">Writing custom tests for llvm-test</a></li>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	43	</ul>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	44	</li>
				45	<li><a href="#nightly">Running the nightly tester</a></li>
				46	</ol>
				47
				48	<div class="doc_author">
				49	<p>Written by John T. Criswell, <a
				50	href="http://llvm.x10sys.com/rspencer">Reid Spencer</a>, and Tanya Lattner</p>
				51	</div>
				52
				53	<!--=========================================================================-->
				54	<div class="doc_section"><a name="overview">Overview</a></div>
				55	<!--=========================================================================-->
				56
				57	<div class="doc_text">
				58
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	59	<p>This document is the reference manual for the LLVM testing infrastructure. It documents
				60	the structure of the LLVM testing infrastructure, the tools needed to use it,
				61	and how to add and run tests.</p>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	62
				63	</div>
				64
				65	<!--=========================================================================-->
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	66	<div class="doc_section"><a name="requirements">Requirements</a></div>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	67	<!--=========================================================================-->
				68
				69	<div class="doc_text">
				70
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	71	<p>In order to use the LLVM testing infrastructure, you will need all of the software
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	72	required to build LLVM, plus the following:</p>
				73
				74	<dl>
				75	<dt><a href="http://www.gnu.org/software/dejagnu/">DejaGNU</a></dt>
				76	<dd>The Feature and Regressions tests are organized and run by DejaGNU.</dd>
				77	<dt><a href="http://expect.nist.gov/">Expect</a></dt>
				78	<dd>Expect is required by DejaGNU.</dd>
				79	<dt><a href="http://www.tcl.tk/software/tcltk/">tcl</a></dt>
				80	<dd>Tcl is required by DejaGNU. </dd>
				81
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	82	<ul>
				83	<li><tt>./configure --with-f2c=$DIR</tt><br>
				84	This will specify a new <tt>$DIR</tt> for the above-described search
				85	process. This will only work if the binary, header, and library are in their
				86	respective subdirectories of <tt>$DIR</tt>.</li>
				87
				88	<li><tt>./configure --with-f2c-bin=/binary/path --with-f2c-inc=/include/path
				89	--with-f2c-lib=/lib/path</tt><br>
				90	This allows you to specify the F2C components separately. Note: if you choose
				91	this route, you MUST specify all three components, and you need to only specify
				92	<em>directories</em> where the files are located; do NOT include the
				93	filenames themselves on the <tt>configure</tt> line.</li>
				94	</ul></dd>
				95	</dl>
				96
				97	<p>Darwin (Mac OS X) developers can simplify the installation of Expect and tcl
				98	by using fink. <tt>fink install expect</tt> will install both. Alternatively,
				99	Darwinports users can use <tt>sudo port install expect</tt> to install Expect
				100	and tcl.</p>
				101
				102	</div>
				103
				104	<!--=========================================================================-->
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	105	<div class="doc_section"><a name="org">LLVM testing infrastructure organization</a></div>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	106	<!--=========================================================================-->
				107
				108	<div class="doc_text">
				109
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	110	<p>The LLVM testing infrastructure contains two major categories of tests: code
				111	fragments and whole programs. Code fragments are referred to as the "DejaGNU
				112	tests" and are in the <tt>llvm</tt> module in subversion under the
				113	<tt>llvm/test</tt> directory. The whole programs tests are referred to as the
				114	"Test suite" and are in the <tt>test-suite</tt> module in subversion.
				115	</p>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	116
				117	</div>
				118
				119	<!-- _______________________________________________________________________ -->
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	120	<div class="doc_subsection"><a name="dejagnu">DejaGNU tests</a></div>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	121	<!-- _______________________________________________________________________ -->
				122
				123	<div class="doc_text">
				124
				125	<p>Code fragments are small pieces of code that test a specific feature of LLVM
				126	or trigger a specific bug in LLVM. They are usually written in LLVM assembly
				127	language, but can be written in other languages if the test targets a particular
				128	language front end. These tests are driven by the DejaGNU testing framework,
				129	which is hidden behind a few simple makefiles.</p>
				130
				131	<p>These code fragments are not complete programs. The code generated from them is
				132	never executed to determine correct behavior.</p>
				133
				134	<p>These code fragment tests are located in the <tt>llvm/test</tt>
				135	directory.</p>
				136
				137	<p>Typically when a bug is found in LLVM, a regression test containing
				138	just enough code to reproduce the problem should be written and placed
				139	somewhere underneath this directory. In most cases, this will be a small
				140	piece of LLVM assembly language code, often distilled from an actual
				141	application or benchmark.</p>
				142
				143	</div>
				144
				145	<!-- _______________________________________________________________________ -->
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	146	<div class="doc_subsection"><a name="testsuite">Test suite</a></div>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	147	<!-- _______________________________________________________________________ -->
				148
				149	<div class="doc_text">
				150
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	151	<p>The test suite contains whole programs, which are pieces of
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	152	code which can be compiled and linked into a stand-alone program that can be
				153	executed. These programs are generally written in high level languages such as
				154	C or C++, but sometimes they are written straight in LLVM assembly.</p>
				155
				156	<p>These programs are compiled and then executed using several different
				157	methods (native compiler, LLVM C backend, LLVM JIT, LLVM native code generation,
				158	etc). The output of these programs is compared to ensure that LLVM is compiling
				159	the program correctly.</p>
				160
				161	<p>In addition to compiling and executing programs, whole program tests serve as
				162	a way of benchmarking LLVM performance, both in terms of the efficiency of the
				163	programs generated as well as the speed with which LLVM compiles, optimizes, and
				164	generates code.</p>
				165
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	166	<p>The test-suite is located in the <tt>test-suite</tt> Subversion module.</p>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	167
				168	</div>
				169
				170	<!--=========================================================================-->
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	171	<div class="doc_section"><a name="quick">Quick start</a></div>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	172	<!--=========================================================================-->
				173
				174	<div class="doc_text">
				175
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	176	<p>The tests are located in two separate Subversion modules. The
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	177	DejaGNU tests are in the main "llvm" module under the directory
				178	<tt>llvm/test</tt> (so you get these tests for free with the main llvm tree).
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	179	The more comprehensive test suite that includes whole
				180	programs in C and C++ is in the <tt>test-suite</tt> module. This module should
				181	be checked out to the <tt>llvm/projects</tt> directory (don't use another name
				182	then the default "test-suite", for then the test suite will be run every time
				183	you run <tt>make</tt> in the main <tt>llvm</tt> directory).
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	184	When you <tt>configure</tt> the <tt>llvm</tt> module,
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	185	the <tt>test-suite</tt> directory will be automatically configured.
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	186	Alternatively, you can configure the <tt>test-suite</tt> module manually.</p>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	187
				188	<!-- _______________________________________________________________________ -->
				189	<div class="doc_subsection"><a name="quickdejagnu">DejaGNU tests</a></div>
				190	<!-- _______________________________________________________________________ -->
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	191	<p>To run all of the simple tests in LLVM using DejaGNU, use the master Makefile
				192	in the <tt>llvm/test</tt> directory:</p>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	193
				194	<div class="doc_code">
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	195	<pre>
				196	% gmake -C llvm/test
				197	</pre>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	198	</div>
				199
				200	<p>or</p>
				201
				202	<div class="doc_code">
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	203	<pre>
				204	% gmake check
				205	</pre>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	206	</div>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	207
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	208	<p>To run only a subdirectory of tests in <tt>llvm/test</tt> using DejaGNU (ie.
				209	Transforms), just set the TESTSUITE variable to the path of the
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	210	subdirectory (relative to <tt>llvm/test</tt>):</p>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	211
				212	<div class="doc_code">
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	213	<pre>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	214	% gmake TESTSUITE=Transforms check
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	215	</pre>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	216	</div>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	217
				218	<p><b>Note: If you are running the tests with <tt>objdir != subdir</tt>, you
				219	must have run the complete testsuite before you can specify a
				220	subdirectory.</b></p>
				221
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	222	<p>To run only a single test, set <tt>TESTONE</tt> to its path (relative to
				223	<tt>llvm/test</tt>) and make the <tt>check-one</tt> target:</p>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	224
				225	<div class="doc_code">
				226	<pre>
				227	% gmake TESTONE=Feature/basictest.ll check-one
				228	</pre>
				229	</div>
				230
				231	<!-- _______________________________________________________________________ -->
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	232	<div class="doc_subsection"><a name="quicktestsuite">Test suite</a></div>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	233	<!-- _______________________________________________________________________ -->
				234
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	235	<p>To run the comprehensive test suite (tests that compile and execute whole
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	236	programs), first checkout and setup the <tt>test-suite</tt> module:</p>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	237
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	238	<div class="doc_code">
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	239	<pre>
				240	% cd llvm/projects
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	241	% svn co http://llvm.org/svn/llvm-project/test-suite/trunk test-suite
Tanya Lattner	0da51e8	2007-11-28 05:13:45 +0000	[diff] [blame]	242	% cd ..
				243	% ./configure --with-llvmgccdir=$LLVM_GCC_DIR
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	244	</pre>
Matthijs Kooijman	c987d70	2008-05-20 10:28:55 +0000	[diff] [blame]	245	<p>where <tt>$LLVM_GCC_DIR</tt> is the directory where you <em>installed</em>
				246	llvm-gcc, not it's src or obj dir.</p>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	247	</div>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	248
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	249	<p>Then, run the entire test suite by running make in the <tt>test-suite</tt>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	250	directory:</p>
				251
				252	<div class="doc_code">
				253	<pre>
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	254	% cd projects/test-suite
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	255	% gmake
				256	</pre>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	257	</div>
				258
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	259	<p>Usually, running the "nightly" set of tests is a good idea, and you can also
				260	let it generate a report by running:</p>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	261
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	262	<div class="doc_code">
				263	<pre>
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	264	% cd projects/test-suite
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	265	% gmake TEST=nightly report report.html
				266	</pre>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	267	</div>
				268
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	269	<p>Any of the above commands can also be run in a subdirectory of
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	270	<tt>projects/test-suite</tt> to run the specified test only on the programs in
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	271	that subdirectory.</p>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	272
				273	</div>
				274
				275	<!--=========================================================================-->
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	276	<div class="doc_section"><a name="dgstructure">DejaGNU structure</a></div>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	277	<!--=========================================================================-->
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	278	<div class="doc_text">
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	279	<p>The LLVM DejaGNU tests are driven by DejaGNU together with GNU Make and are
				280	located in the <tt>llvm/test</tt> directory.
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	281
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	282	<p>This directory contains a large array of small tests
				283	that exercise various features of LLVM and to ensure that regressions do not
				284	occur. The directory is broken into several sub-directories, each focused on
Bill Wendling	650d3b3	2007-09-22 09:20:07 +0000	[diff] [blame]	285	a particular area of LLVM. A few of the important ones are:</p>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	286
Bill Wendling	650d3b3	2007-09-22 09:20:07 +0000	[diff] [blame]	287	<ul>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	288	<li><tt>Analysis</tt>: checks Analysis passes.</li>
				289	<li><tt>Archive</tt>: checks the Archive library.</li>
				290	<li><tt>Assembler</tt>: checks Assembly reader/writer functionality.</li>
				291	<li><tt>Bitcode</tt>: checks Bitcode reader/writer functionality.</li>
				292	<li><tt>CodeGen</tt>: checks code generation and each target.</li>
				293	<li><tt>Features</tt>: checks various features of the LLVM language.</li>
				294	<li><tt>Linker</tt>: tests bitcode linking.</li>
				295	<li><tt>Transforms</tt>: tests each of the scalar, IPO, and utility
				296	transforms to ensure they make the right transformations.</li>
				297	<li><tt>Verifier</tt>: tests the IR verifier.</li>
Bill Wendling	650d3b3	2007-09-22 09:20:07 +0000	[diff] [blame]	298	</ul>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	299
				300	</div>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	301
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	302	<!-- _______________________________________________________________________ -->
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	303	<div class="doc_subsection"><a name="dgcustom">Writing new DejaGNU tests</a></div>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	304	<!-- _______________________________________________________________________ -->
				305	<div class="doc_text">
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	306	<p>The DejaGNU structure is very simple, but does require some information to
				307	be set. This information is gathered via <tt>configure</tt> and is written
				308	to a file, <tt>site.exp</tt> in <tt>llvm/test</tt>. The <tt>llvm/test</tt>
				309	Makefile does this work for you.</p>
				310
				311	<p>In order for DejaGNU to work, each directory of tests must have a
				312	<tt>dg.exp</tt> file. DejaGNU looks for this file to determine how to run the
				313	tests. This file is just a Tcl script and it can do anything you want, but
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	314	we've standardized it for the LLVM regression tests. If you're adding a
				315	directory of tests, just copy <tt>dg.exp</tt> from another directory to get
				316	running. The standard <tt>dg.exp</tt> simply loads a Tcl
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	317	library (<tt>test/lib/llvm.exp</tt>) and calls the <tt>llvm_runtests</tt>
				318	function defined in that library with a list of file names to run. The names
				319	are obtained by using Tcl's glob command. Any directory that contains only
				320	directories does not need the <tt>dg.exp</tt> file.</p>
				321
				322	<p>The <tt>llvm-runtests</tt> function lookas at each file that is passed to
				323	it and gathers any lines together that match "RUN:". This are the "RUN" lines
				324	that specify how the test is to be run. So, each test script must contain
				325	RUN lines if it is to do anything. If there are no RUN lines, the
				326	<tt>llvm-runtests</tt> function will issue an error and the test will
				327	fail.</p>
				328
				329	<p>RUN lines are specified in the comments of the test program using the
				330	keyword <tt>RUN</tt> followed by a colon, and lastly the command (pipeline)
				331	to execute. Together, these lines form the "script" that
				332	<tt>llvm-runtests</tt> executes to run the test case. The syntax of the
				333	RUN lines is similar to a shell's syntax for pipelines including I/O
				334	redirection and variable substitution. However, even though these lines
				335	may <i>look</i> like a shell script, they are not. RUN lines are interpreted
				336	directly by the Tcl <tt>exec</tt> command. They are never executed by a
				337	shell. Consequently the syntax differs from normal shell script syntax in a
				338	few ways. You can specify as many RUN lines as needed.</p>
				339
				340	<p>Each RUN line is executed on its own, distinct from other lines unless
				341	its last character is <tt>\</tt>. This continuation character causes the RUN
				342	line to be concatenated with the next one. In this way you can build up long
				343	pipelines of commands without making huge line lengths. The lines ending in
				344	<tt>\</tt> are concatenated until a RUN line that doesn't end in <tt>\</tt> is
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	345	found. This concatenated set of RUN lines then constitutes one execution.
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	346	Tcl will substitute variables and arrange for the pipeline to be executed. If
				347	any process in the pipeline fails, the entire line (and test case) fails too.
				348	</p>
				349
				350	<p> Below is an example of legal RUN lines in a <tt>.ll</tt> file:</p>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	351
				352	<div class="doc_code">
				353	<pre>
				354	; RUN: llvm-as < %s \| llvm-dis > %t1
				355	; RUN: llvm-dis < %s.bc-13 > %t2
				356	; RUN: diff %t1 %t2
				357	</pre>
				358	</div>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	359
				360	<p>As with a Unix shell, the RUN: lines permit pipelines and I/O redirection
				361	to be used. However, the usage is slightly different than for Bash. To check
				362	what's legal, see the documentation for the
				363	<a href="http://www.tcl.tk/man/tcl8.5/TclCmd/exec.htm#M2">Tcl exec</a>
				364	command and the
				365	<a href="http://www.tcl.tk/man/tcl8.5/tutorial/Tcl26.html">tutorial</a>.
				366	The major differences are:</p>
				367	<ul>
				368	<li>You can't do <tt>2>&1</tt>. That will cause Tcl to write to a
				369	file named <tt>&1</tt>. Usually this is done to get stderr to go through
				370	a pipe. You can do that in tcl with <tt>\|&</tt> so replace this idiom:
				371	<tt>... 2>&1 \| grep</tt> with <tt>... \|& grep</tt></li>
				372	<li>You can only redirect to a file, not to another descriptor and not from
				373	a here document.</li>
				374	<li>tcl supports redirecting to open files with the @ syntax but you
				375	shouldn't use that here.</li>
				376	</ul>
				377
				378	<p>There are some quoting rules that you must pay attention to when writing
				379	your RUN lines. In general nothing needs to be quoted. Tcl won't strip off any
				380	' or " so they will get passed to the invoked program. For example:</p>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	381
				382	<div class="doc_code">
				383	<pre>
				384	... \| grep 'find this string'
				385	</pre>
				386	</div>
				387
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	388	<p>This will fail because the ' characters are passed to grep. This would
				389	instruction grep to look for <tt>'find</tt> in the files <tt>this</tt> and
				390	<tt>string'</tt>. To avoid this use curly braces to tell Tcl that it should
				391	treat everything enclosed as one value. So our example would become:</p>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	392
				393	<div class="doc_code">
				394	<pre>
				395	... \| grep {find this string}
				396	</pre>
				397	</div>
				398
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	399	<p>Additionally, the characters <tt>[</tt> and <tt>]</tt> are treated
				400	specially by Tcl. They tell Tcl to interpret the content as a command to
				401	execute. Since these characters are often used in regular expressions this can
				402	have disastrous results and cause the entire test run in a directory to fail.
				403	For example, a common idiom is to look for some basicblock number:</p>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	404
				405	<div class="doc_code">
				406	<pre>
				407	... \| grep bb[2-8]
				408	</pre>
				409	</div>
				410
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	411	<p>This, however, will cause Tcl to fail because its going to try to execute
				412	a program named "2-8". Instead, what you want is this:</p>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	413
				414	<div class="doc_code">
				415	<pre>
				416	... \| grep {bb\[2-8\]}
				417	</pre>
				418	</div>
				419
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	420	<p>Finally, if you need to pass the <tt>\</tt> character down to a program,
				421	then it must be doubled. This is another Tcl special character. So, suppose
				422	you had:
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	423
				424	<div class="doc_code">
				425	<pre>
				426	... \| grep 'i32\*'
				427	</pre>
				428	</div>
				429
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	430	<p>This will fail to match what you want (a pointer to i32). First, the
				431	<tt>'</tt> do not get stripped off. Second, the <tt>\</tt> gets stripped off
				432	by Tcl so what grep sees is: <tt>'i32*'</tt>. That's not likely to match
				433	anything. To resolve this you must use <tt>\\</tt> and the <tt>{}</tt>, like
				434	this:</p>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	435
				436	<div class="doc_code">
				437	<pre>
				438	... \| grep {i32\\*}
				439	</pre>
				440	</div>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	441
				442	</div>
				443
				444	<!-- _______________________________________________________________________ -->
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	445	<div class="doc_subsection"><a name="dgvars">Variables and substitutions</a></div>
				446	<!-- _______________________________________________________________________ -->
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	447	<div class="doc_text">
				448	<p>With a RUN line there are a number of substitutions that are permitted. In
				449	general, any Tcl variable that is available in the <tt>substitute</tt>
				450	function (in <tt>test/lib/llvm.exp</tt>) can be substituted into a RUN line.
				451	To make a substitution just write the variable's name preceded by a $.
				452	Additionally, for compatibility reasons with previous versions of the test
				453	library, certain names can be accessed with an alternate syntax: a % prefix.
				454	These alternates are deprecated and may go away in a future version.
				455	</p>
Bill Wendling	650d3b3	2007-09-22 09:20:07 +0000	[diff] [blame]	456	<p>Here are the available variable names. The alternate syntax is listed in
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	457	parentheses.</p>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	458
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	459	<dl style="margin-left: 25px">
				460	<dt><b>$test</b> (%s)</dt>
				461	<dd>The full path to the test case's source. This is suitable for passing
				462	on the command line as the input to an llvm tool.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	463
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	464	<dt><b>$srcdir</b></dt>
				465	<dd>The source directory from where the "<tt>make check</tt>" was run.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	466
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	467	<dt><b>objdir</b></dt>
Bill Wendling	650d3b3	2007-09-22 09:20:07 +0000	[diff] [blame]	468	<dd>The object directory that corresponds to the <tt>$srcdir</tt>.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	469
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	470	<dt><b>subdir</b></dt>
				471	<dd>A partial path from the <tt>test</tt> directory that contains the
				472	sub-directory that contains the test source being executed.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	473
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	474	<dt><b>srcroot</b></dt>
				475	<dd>The root directory of the LLVM src tree.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	476
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	477	<dt><b>objroot</b></dt>
				478	<dd>The root directory of the LLVM object tree. This could be the same
				479	as the srcroot.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	480
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	481	<dt><b>path</b><dt>
				482	<dd>The path to the directory that contains the test case source. This is
				483	for locating any supporting files that are not generated by the test, but
				484	used by the test.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	485
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	486	<dt><b>tmp</b></dt>
				487	<dd>The path to a temporary file name that could be used for this test case.
				488	The file name won't conflict with other test cases. You can append to it if
				489	you need multiple temporaries. This is useful as the destination of some
				490	redirected output.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	491
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	492	<dt><b>llvmlibsdir</b> (%llvmlibsdir)</dt>
				493	<dd>The directory where the LLVM libraries are located.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	494
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	495	<dt><b>target_triplet</b> (%target_triplet)</dt>
				496	<dd>The target triplet that corresponds to the current host machine (the one
				497	running the test cases). This should probably be called "host".<dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	498
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	499	<dt><b>prcontext</b> (%prcontext)</dt>
				500	<dd>Path to the prcontext tcl script that prints some context around a
				501	line that matches a pattern. This isn't strictly necessary as the test suite
				502	is run with its PATH altered to include the test/Scripts directory where
				503	the prcontext script is located. Note that this script is similar to
				504	<tt>grep -C</tt> but you should use the <tt>prcontext</tt> script because
				505	not all platforms support <tt>grep -C</tt>.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	506
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	507	<dt><b>llvmgcc</b> (%llvmgcc)</dt>
				508	<dd>The full path to the <tt>llvm-gcc</tt> executable as specified in the
				509	configured LLVM environment</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	510
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	511	<dt><b>llvmgxx</b> (%llvmgxx)</dt>
				512	<dd>The full path to the <tt>llvm-gxx</tt> executable as specified in the
				513	configured LLVM environment</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	514
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	515	<dt><b>llvmgcc_version</b> (%llvmgcc_version)</dt>
				516	<dd>The full version number of the <tt>llvm-gcc</tt> executable.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	517
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	518	<dt><b>llvmgccmajvers</b> (%llvmgccmajvers)</dt>
				519	<dd>The major version number of the <tt>llvm-gcc</tt> executable.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	520
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	521	<dt><b>gccpath</b></dt>
				522	<dd>The full path to the C compiler used to <i>build </i> LLVM. Note that
				523	this might not be gcc.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	524
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	525	<dt><b>gxxpath</b></dt>
				526	<dd>The full path to the C++ compiler used to <i>build </i> LLVM. Note that
				527	this might not be g++.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	528
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	529	<dt><b>compile_c</b> (%compile_c)</dt>
				530	<dd>The full command line used to compile LLVM C source code. This has all
				531	the configured -I, -D and optimization options.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	532
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	533	<dt><b>compile_cxx</b> (%compile_cxx)</dt>
				534	<dd>The full command used to compile LLVM C++ source code. This has
				535	all the configured -I, -D and optimization options.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	536
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	537	<dt><b>link</b> (%link)</dt>
				538	<dd>This full link command used to link LLVM executables. This has all the
				539	configured -I, -L and -l options.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	540
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	541	<dt><b>shlibext</b> (%shlibext)</dt>
				542	<dd>The suffix for the host platforms share library (dll) files. This
				543	includes the period as the first character.</dd>
				544	</dl>
				545	<p>To add more variables, two things need to be changed. First, add a line in
				546	the <tt>test/Makefile</tt> that creates the <tt>site.exp</tt> file. This will
				547	"set" the variable as a global in the site.exp file. Second, in the
				548	<tt>test/lib/llvm.exp</tt> file, in the substitute proc, add the variable name
				549	to the list of "global" declarations at the beginning of the proc. That's it,
				550	the variable can then be used in test scripts.</p>
				551	</div>
				552
				553	<!-- _______________________________________________________________________ -->
				554	<div class="doc_subsection"><a name="dgfeatures">Other Features</a></div>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	555	<!-- _______________________________________________________________________ -->
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	556	<div class="doc_text">
				557	<p>To make RUN line writing easier, there are several shell scripts located
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	558	in the <tt>llvm/test/Scripts</tt> directory. This directory is in the PATH
				559	when running tests, so you can just call these scripts using their name. For
				560	example:</p>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	561	<dl>
				562	<dt><b>ignore</b></dt>
				563	<dd>This script runs its arguments and then always returns 0. This is useful
				564	in cases where the test needs to cause a tool to generate an error (e.g. to
				565	check the error output). However, any program in a pipeline that returns a
				566	non-zero result will cause the test to fail. This script overcomes that
				567	issue and nicely documents that the test case is purposefully ignoring the
				568	result code of the tool</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	569
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	570	<dt><b>not</b></dt>
				571	<dd>This script runs its arguments and then inverts the result code from
				572	it. Zero result codes become 1. Non-zero result codes become 0. This is
				573	useful to invert the result of a grep. For example "not grep X" means
				574	succeed only if you don't find X in the input.</dd>
				575	</dl>
				576
				577	<p>Sometimes it is necessary to mark a test case as "expected fail" or XFAIL.
				578	You can easily mark a test as XFAIL just by including <tt>XFAIL: </tt> on a
				579	line near the top of the file. This signals that the test case should succeed
				580	if the test fails. Such test cases are counted separately by DejaGnu. To
				581	specify an expected fail, use the XFAIL keyword in the comments of the test
				582	program followed by a colon and one or more regular expressions (separated by
				583	a comma). The regular expressions allow you to XFAIL the test conditionally
				584	by host platform. The regular expressions following the : are matched against
				585	the target triplet or llvmgcc version number for the host machine. If there is
				586	a match, the test is expected to fail. If not, the test is expected to
				587	succeed. To XFAIL everywhere just specify <tt>XFAIL: *</tt>. When matching
				588	the llvm-gcc version, you can specify the major (e.g. 3) or full version
				589	(i.e. 3.4) number. Here is an example of an <tt>XFAIL</tt> line:</p>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	590
				591	<div class="doc_code">
				592	<pre>
				593	; XFAIL: darwin,sun,llvmgcc4
				594	</pre>
				595	</div>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	596
				597	<p>To make the output more useful, the <tt>llvm_runtest</tt> function wil
				598	scan the lines of the test case for ones that contain a pattern that matches
				599	PR[0-9]+. This is the syntax for specifying a PR (Problem Report) number that
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	600	is related to the test case. The number after "PR" specifies the LLVM bugzilla
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	601	number. When a PR number is specified, it will be used in the pass/fail
				602	reporting. This is useful to quickly get some context when a test fails.</p>
				603
				604	<p>Finally, any line that contains "END." will cause the special
				605	interpretation of lines to terminate. This is generally done right after the
				606	last RUN: line. This has two side effects: (a) it prevents special
				607	interpretation of lines that are part of the test program, not the
				608	instructions to the test case, and (b) it speeds things up for really big test
				609	cases by avoiding interpretation of the remainder of the file.</p>
				610
				611	</div>
				612
				613	<!--=========================================================================-->
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	614	<div class="doc_section"><a name="testsuitestructure">Test suite
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	615	Structure</a></div>
				616	<!--=========================================================================-->
				617
				618	<div class="doc_text">
				619
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	620	<p>The <tt>test-suite</tt> module contains a number of programs that can be compiled
				621	with LLVM and executed. These programs are compiled using the native compiler
				622	and various LLVM backends. The output from the program compiled with the
				623	native compiler is assumed correct; the results from the other programs are
				624	compared to the native program output and pass if they match.</p>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	625
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	626	<p>When executing tests, it is usually a good idea to start out with a subset of
				627	the available tests or programs. This makes test run times smaller at first and
				628	later on this is useful to investigate individual test failures. To run some
				629	test only on a subset of programs, simply change directory to the programs you
				630	want tested and run <tt>gmake</tt> there. Alternatively, you can run a different
				631	test using the <tt>TEST</tt> variable to change what tests or run on the
				632	selected programs (see below for more info).</p>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	633
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	634	<p>In addition for testing correctness, the <tt>llvm-test</tt> directory also
				635	performs timing tests of various LLVM optimizations. It also records
				636	compilation times for the compilers and the JIT. This information can be
				637	used to compare the effectiveness of LLVM's optimizations and code
				638	generation.</p>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	639
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	640	<p><tt>llvm-test</tt> tests are divided into three types of tests: MultiSource,
				641	SingleSource, and External.</p>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	642
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	643	<ul>
				644	<li><tt>llvm-test/SingleSource</tt>
				645	<p>The SingleSource directory contains test programs that are only a single
				646	source file in size. These are usually small benchmark programs or small
				647	programs that calculate a particular value. Several such programs are grouped
				648	together in each directory.</p></li>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	649
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	650	<li><tt>llvm-test/MultiSource</tt>
				651	<p>The MultiSource directory contains subdirectories which contain entire
				652	programs with multiple source files. Large benchmarks and whole applications
				653	go here.</p></li>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	654
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	655	<li><tt>llvm-test/External</tt>
				656	<p>The External directory contains Makefiles for building code that is external
				657	to (i.e., not distributed with) LLVM. The most prominent members of this
				658	directory are the SPEC 95 and SPEC 2000 benchmark suites. The <tt>External</tt>
				659	directory does not contain these actual tests,but only the Makefiles that know
				660	how to properly compile these programs from somewhere else. The presence and
				661	location of these external programs is configured by the llvm-test
				662	<tt>configure</tt> script.</p></li>
				663	</ul>
				664
				665	<p>Each tree is then subdivided into several categories, including applications,
				666	benchmarks, regression tests, code that is strange grammatically, etc. These
				667	organizations should be relatively self explanatory.</p>
				668
				669	<p>Some tests are known to fail. Some are bugs that we have not fixed yet;
				670	others are features that we haven't added yet (or may never add). In DejaGNU,
				671	the result for such tests will be XFAIL (eXpected FAILure). In this way, you
				672	can tell the difference between an expected and unexpected failure.</p>
				673
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	674	<p>The tests in the test suite have no such feature at this time. If the
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	675	test passes, only warnings and other miscellaneous output will be generated. If
				676	a test fails, a large <program> FAILED message will be displayed. This
				677	will help you separate benign warnings from actual test failures.</p>
				678
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	679	</div>
				680
				681	<!--=========================================================================-->
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	682	<div class="doc_section"><a name="testsuiterun">Running the test suite</a></div>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	683	<!--=========================================================================-->
				684
				685	<div class="doc_text">
				686
				687	<p>First, all tests are executed within the LLVM object directory tree. They
				688	<i>are not</i> executed inside of the LLVM source tree. This is because the
				689	test suite creates temporary files during execution.</p>
				690
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	691	<p>To run the test suite, you need to use the following steps:</p>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	692
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	693	<ol>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	694	<li><tt>cd</tt> into the <tt>llvm/projects</tt> directory</li>
				695
				696	<li><p>Check out the <tt>test-suite</tt> module with:</p>
				697
				698	<div class="doc_code">
				699	<pre>
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	700	% svn co http://llvm.org/svn/llvm-project/test-suite/trunk test-suite
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	701	</pre>
				702	</div>
				703
				704	<p>This will get the test suite into <tt>llvm/projects/llvm-test</tt></p>
				705
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	706	<li><p>Configure the test suite using llvm configure. This will automatically
				707	configure test-suite. You must do it from the top level otherwise llvm-gcc
				708	will not be set which is required to run llvm-test:</p>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	709	<div class="doc_code">
				710	<pre>
Tanya Lattner	0da51e8	2007-11-28 05:13:45 +0000	[diff] [blame]	711	% cd $LLVM_OBJ_ROOT ; $LLVM_SRC_ROOT/configure --with-llvmgccdir=$LLVM_GCC_DIR
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	712	</pre>
				713	</div>
Matthijs Kooijman	c987d70	2008-05-20 10:28:55 +0000	[diff] [blame]	714	<p>Note that that <tt>$LLVM_GCC_DIR</tt> is the directory where you
				715	<em>installed</em> llvm-gcc, not its src or obj directory.</p>
				716	</li>
				717
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	718	<li><p>Change back to the <tt>llvm/projects/test-suite</tt> directory you created before
Matthijs Kooijman	c987d70	2008-05-20 10:28:55 +0000	[diff] [blame]	719	and run <tt>gmake</tt> (or just "<tt>make</tt>" on systems where GNU make is
				720	the default, such as linux.</p></li>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	721	</ol>
				722	<p>Note that the second and third steps only need to be done once. After you
				723	have the suite checked out and configured, you don't need to do it again (unless
Matthijs Kooijman	c987d70	2008-05-20 10:28:55 +0000	[diff] [blame]	724	the test code or configure script changes).</p>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	725
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	726	<!-- _______________________________________________________________________ -->
				727	<div class="doc_subsection">
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	728	<a name="testsuiteexternal">Configuring external tests</a></div>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	729	<!-- _______________________________________________________________________ -->
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	730
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	731	<div class="doc_text">
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	732	<p>Note, when configuring the <tt>test-suite</tt> module, you might want to
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	733	specify the following configuration options:</p>
				734	<dl>
				735	<dt><i>--enable-spec2000</i>
				736	<dt><i>--enable-spec2000=<<tt>directory</tt>></i>
				737	<dd>
				738	Enable the use of SPEC2000 when testing LLVM. This is disabled by default
				739	(unless <tt>configure</tt> finds SPEC2000 installed). By specifying
				740	<tt>directory</tt>, you can tell configure where to find the SPEC2000
				741	benchmarks. If <tt>directory</tt> is left unspecified, <tt>configure</tt>
				742	uses the default value
				743	<tt>/home/vadve/shared/benchmarks/speccpu2000/benchspec</tt>.
				744	<p>
				745
				746	<dt><i>--enable-spec95</i>
				747	<dt><i>--enable-spec95=<<tt>directory</tt>></i>
				748	<dd>
				749	Enable the use of SPEC95 when testing LLVM. It is similar to the
				750	<i>--enable-spec2000</i> option.
				751	<p>
				752
				753	<dt><i>--enable-povray</i>
				754	<dt><i>--enable-povray=<<tt>directory</tt>></i>
				755	<dd>
				756	Enable the use of Povray as an external test. Versions of Povray written
				757	in C should work. This option is similar to the <i>--enable-spec2000</i>
				758	option.
				759	</dl>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	760	</div>
				761
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	762	<!-- _______________________________________________________________________ -->
				763	<div class="doc_subsection">
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	764	<a name="testsuitetests">Running different tests</a></div>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	765	<!-- _______________________________________________________________________ -->
				766	<div class="doc_text">
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	767	<p>In addition to the regular "whole program" tests, the <tt>test-suite</tt>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	768	module also provides a mechanism for compiling the programs in different ways.
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	769	If the variable TEST is defined on the <tt>gmake</tt> command line, the test system will
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	770	include a Makefile named <tt>TEST.<value of TEST variable>.Makefile</tt>.
				771	This Makefile can modify build rules to yield different results.</p>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	772
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	773	<p>For example, the LLVM nightly tester uses <tt>TEST.nightly.Makefile</tt> to
				774	create the nightly test reports. To run the nightly tests, run <tt>gmake
				775	TEST=nightly</tt>.</p>
				776
				777	<p>There are several TEST Makefiles available in the tree. Some of them are
				778	designed for internal LLVM research and will not work outside of the LLVM
				779	research group. They may still be valuable, however, as a guide to writing your
				780	own TEST Makefile for any optimization or analysis passes that you develop with
				781	LLVM.</p>
				782
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	783	</div>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	784
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	785	<!-- _______________________________________________________________________ -->
				786	<div class="doc_subsection">
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	787	<a name="testsuiteoutput">Generating test output</a></div>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	788	<!-- _______________________________________________________________________ -->
				789	<div class="doc_text">
				790	<p>There are a number of ways to run the tests and generate output. The most
				791	simple one is simply running <tt>gmake</tt> with no arguments. This will
				792	compile and run all programs in the tree using a number of different methods
				793	and compare results. Any failures are reported in the output, but are likely
				794	drowned in the other output. Passes are not reported explicitely.</p>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	795
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	796	<p>Somewhat better is running <tt>gmake TEST=sometest test</tt>, which runs
				797	the specified test and usually adds per-program summaries to the output
				798	(depending on which sometest you use). For example, the <tt>nightly</tt> test
				799	explicitely outputs TEST-PASS or TEST-FAIL for every test after each program.
				800	Though these lines are still drowned in the output, it's easy to grep the
				801	output logs in the Output directories.</p>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	802
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	803	<p>Even better are the <tt>report</tt> and <tt>report.format</tt> targets
				804	(where <tt>format</tt> is one of <tt>html</tt>, <tt>csv</tt>, <tt>text</tt> or
				805	<tt>graphs</tt>). The exact contents of the report are dependent on which
				806	<tt>TEST</tt> you are running, but the text results are always shown at the
				807	end of the run and the results are always stored in the
				808	<tt>report.<type>.format</tt> file (when running with
				809	<tt>TEST=<type></tt>).
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	810
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	811	The <tt>report</tt> also generate a file called
				812	<tt>report.<type>.raw.out</tt> containing the output of the entire test
				813	run.
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	814	</div>
				815
				816	<!-- _______________________________________________________________________ -->
				817	<div class="doc_subsection">
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	818	<a name="testsuitecustom">Writing custom tests for the test suite</a></div>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	819	<!-- _______________________________________________________________________ -->
				820
				821	<div class="doc_text">
				822
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	823	<p>Assuming you can run the test suite, (e.g. "<tt>gmake TEST=nightly report</tt>"
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	824	should work), it is really easy to run optimizations or code generator
				825	components against every program in the tree, collecting statistics or running
				826	custom checks for correctness. At base, this is how the nightly tester works,
				827	it's just one example of a general framework.</p>
				828
				829	<p>Lets say that you have an LLVM optimization pass, and you want to see how
				830	many times it triggers. First thing you should do is add an LLVM
				831	<a href="ProgrammersManual.html#Statistic">statistic</a> to your pass, which
				832	will tally counts of things you care about.</p>
				833
				834	<p>Following this, you can set up a test and a report that collects these and
				835	formats them for easy viewing. This consists of two files, an
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	836	"<tt>test-suite/TEST.XXX.Makefile</tt>" fragment (where XXX is the name of your
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	837	test) and an "<tt>llvm-test/TEST.XXX.report</tt>" file that indicates how to
				838	format the output into a table. There are many example reports of various
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	839	levels of sophistication included with the test suite, and the framework is very
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	840	general.</p>
				841
				842	<p>If you are interested in testing an optimization pass, check out the
				843	"libcalls" test as an example. It can be run like this:<p>
				844
				845	<div class="doc_code">
				846	<pre>
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	847	% cd llvm/projects/test-suite/MultiSource/Benchmarks # or some other level
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	848	% make TEST=libcalls report
				849	</pre>
				850	</div>
				851
				852	<p>This will do a bunch of stuff, then eventually print a table like this:</p>
				853
				854	<div class="doc_code">
				855	<pre>
				856	Name \| total \| #exit \|
				857	...
				858	FreeBench/analyzer/analyzer \| 51 \| 6 \|
				859	FreeBench/fourinarow/fourinarow \| 1 \| 1 \|
				860	FreeBench/neural/neural \| 19 \| 9 \|
				861	FreeBench/pifft/pifft \| 5 \| 3 \|
				862	MallocBench/cfrac/cfrac \| 1 \| * \|
				863	MallocBench/espresso/espresso \| 52 \| 12 \|
				864	MallocBench/gs/gs \| 4 \| * \|
				865	Prolangs-C/TimberWolfMC/timberwolfmc \| 302 \| * \|
				866	Prolangs-C/agrep/agrep \| 33 \| 12 \|
				867	Prolangs-C/allroots/allroots \| * \| * \|
				868	Prolangs-C/assembler/assembler \| 47 \| * \|
				869	Prolangs-C/bison/mybison \| 74 \| * \|
				870	...
				871	</pre>
				872	</div>
				873
				874	<p>This basically is grepping the -stats output and displaying it in a table.
				875	You can also use the "TEST=libcalls report.html" target to get the table in HTML
				876	form, similarly for report.csv and report.tex.</p>
				877
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	878	<p>The source for this is in test-suite/TEST.libcalls.*. The format is pretty
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	879	simple: the Makefile indicates how to run the test (in this case,
				880	"<tt>opt -simplify-libcalls -stats</tt>"), and the report contains one line for
				881	each column of the output. The first value is the header for the column and the
				882	second is the regex to grep the output of the command for. There are lots of
				883	example reports that can do fancy stuff.</p>
				884
				885	</div>
				886
				887
				888	<!--=========================================================================-->
				889	<div class="doc_section"><a name="nightly">Running the nightly tester</a></div>
				890	<!--=========================================================================-->
				891
				892	<div class="doc_text">
				893
				894	<p>
				895	The <a href="http://llvm.org/nightlytest/">LLVM Nightly Testers</a>
				896	automatically check out an LLVM tree, build it, run the "nightly"
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	897	program test (described above), run all of the DejaGNU tests,
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	898	delete the checked out tree, and then submit the results to
				899	<a href="http://llvm.org/nightlytest/">http://llvm.org/nightlytest/</a>.
				900	After test results are submitted to
				901	<a href="http://llvm.org/nightlytest/">http://llvm.org/nightlytest/</a>,
				902	they are processed and displayed on the tests page. An email to
				903	<a href="http://lists.cs.uiuc.edu/pipermail/llvm-testresults/">
				904	llvm-testresults@cs.uiuc.edu</a> summarizing the results is also generated.
				905	This testing scheme is designed to ensure that programs don't break as well
				906	as keep track of LLVM's progress over time.</p>
				907
				908	<p>If you'd like to set up an instance of the nightly tester to run on your
				909	machine, take a look at the comments at the top of the
				910	<tt>utils/NewNightlyTest.pl</tt> file. If you decide to set up a nightly tester
				911	please choose a unique nickname and invoke <tt>utils/NewNightlyTest.pl</tt>
				912	with the "-nickname [yournickname]" command line option.
				913
				914	<p>You can create a shell script to encapsulate the running of the script.
				915	The optimized x86 Linux nightly test is run from just such a script:</p>
				916
				917	<div class="doc_code">
				918	<pre>
				919	#!/bin/bash
				920	BASE=/proj/work/llvm/nightlytest
				921	export BUILDDIR=$BASE/build
				922	export WEBDIR=$BASE/testresults
				923	export LLVMGCCDIR=/proj/work/llvm/cfrontend/install
				924	export PATH=/proj/install/bin:$LLVMGCCDIR/bin:$PATH
				925	export LD_LIBRARY_PATH=/proj/install/lib
				926	cd $BASE
				927	cp /proj/work/llvm/llvm/utils/NewNightlyTest.pl .
				928	nice ./NewNightlyTest.pl -nice -release -verbose -parallel -enable-linscan \
				929	-nickname NightlyTester -noexternals > output.log 2>&1
				930	</pre>
				931	</div>
				932
				933	<p>It is also possible to specify the the location your nightly test results
				934	are submitted. You can do this by passing the command line option
				935	"-submit-server [server_address]" and "-submit-script [script_on_server]" to
				936	<tt>utils/NewNightlyTest.pl</tt>. For example, to submit to the llvm.org
				937	nightly test results page, you would invoke the nightly test script with
				938	"-submit-server llvm.org -submit-script /nightlytest/NightlyTestAccept.cgi".
				939	If these options are not specified, the nightly test script sends the results
				940	to the llvm.org nightly test results page.</p>
				941
				942	<p>Take a look at the <tt>NewNightlyTest.pl</tt> file to see what all of the
				943	flags and strings do. If you start running the nightly tests, please let us
				944	know. Thanks!</p>
				945
				946	</div>
				947
				948	<!-- *********************************************************************** -->
				949
				950	<hr>
				951	<address>
				952	<a href="http://jigsaw.w3.org/css-validator/check/referer"><img
				953	src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
				954	<a href="http://validator.w3.org/check/referer"><img
Matthijs Kooijman	c987d70	2008-05-20 10:28:55 +0000	[diff] [blame]	955	src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	956
				957	John T. Criswell, Reid Spencer, and Tanya Lattner<br>
Matthijs Kooijman	c987d70	2008-05-20 10:28:55 +0000	[diff] [blame]	958	<a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	959	Last modified: $Date$
				960	</address>
				961	</body>
				962	</html>