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

blob: e4db61656bb79a155849dd3a22060deb2088153f [file] [log] [blame]

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