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

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