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

blob: 9e4a40ade8d0eff93dfc34ac8d8afc2182cb99f9 [file] [log] [blame]

Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	1	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
				2	"http://www.w3.org/TR/html4/strict.dtd">
				3	<html>
				4	<head>
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	5	<title>LLVM Testing Infrastructure Guide</title>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	6	<link rel="stylesheet" href="llvm.css" type="text/css">
				7	</head>
				8	<body>
				9
				10	<div class="doc_title">
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	11	LLVM Testing Infrastructure Guide
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	12	</div>
				13
				14	<ol>
				15	<li><a href="#overview">Overview</a></li>
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	16	<li><a href="#requirements">Requirements</a></li>
				17	<li><a href="#org">LLVM testing infrastructure organization</a>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	18	<ul>
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	19	<li><a href="#dejagnu">DejaGNU tests</a></li>
				20	<li><a href="#testsuite">Test suite</a></li>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	21	</ul>
				22	</li>
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	23	<li><a href="#quick">Quick start</a>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	24	<ul>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	25	<li><a href="#quickdejagnu">DejaGNU tests</a></li>
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	26	<li><a href="#quicktestsuite">Test suite</a></li>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	27	</ul>
				28	</li>
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	29	<li><a href="#dgstructure">DejaGNU structure</a>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	30	<ul>
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	31	<li><a href="#dgcustom">Writing new DejaGNU tests</a></li>
Chris Lattner	0012837	2009-08-15 15:40:48 +0000	[diff] [blame]	32	<li><a href="#FileCheck">The FileCheck utility</a></li>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	33	<li><a href="#dgvars">Variables and substitutions</a></li>
				34	<li><a href="#dgfeatures">Other features</a></li>
				35	</ul>
				36	</li>
Matthijs Kooijman	977ffef	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	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	39	<ul>
Stuart Hastings	aa8f28e	2009-05-21 20:23:59 +0000	[diff] [blame]	40	<li><a href="#testsuiteexternal">Configuring External Tests</a></li>
Matthijs Kooijman	977ffef	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	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	44	</ul>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	45	</li>
				46	<li><a href="#nightly">Running the nightly tester</a></li>
				47	</ol>
				48
				49	<div class="doc_author">
				50	<p>Written by John T. Criswell, <a
				51	href="http://llvm.x10sys.com/rspencer">Reid Spencer</a>, and Tanya Lattner</p>
				52	</div>
				53
				54	<!--=========================================================================-->
				55	<div class="doc_section"><a name="overview">Overview</a></div>
				56	<!--=========================================================================-->
				57
				58	<div class="doc_text">
				59
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	60	<p>This document is the reference manual for the LLVM testing infrastructure. It documents
				61	the structure of the LLVM testing infrastructure, the tools needed to use it,
				62	and how to add and run tests.</p>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	63
				64	</div>
				65
				66	<!--=========================================================================-->
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	67	<div class="doc_section"><a name="requirements">Requirements</a></div>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	68	<!--=========================================================================-->
				69
				70	<div class="doc_text">
				71
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	72	<p>In order to use the LLVM testing infrastructure, you will need all of the software
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	73	required to build LLVM, plus the following:</p>
				74
				75	<dl>
				76	<dt><a href="http://www.gnu.org/software/dejagnu/">DejaGNU</a></dt>
				77	<dd>The Feature and Regressions tests are organized and run by DejaGNU.</dd>
				78	<dt><a href="http://expect.nist.gov/">Expect</a></dt>
				79	<dd>Expect is required by DejaGNU.</dd>
				80	<dt><a href="http://www.tcl.tk/software/tcltk/">tcl</a></dt>
				81	<dd>Tcl is required by DejaGNU. </dd>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	82	</dl>
				83
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	84	</div>
				85
				86	<!--=========================================================================-->
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	87	<div class="doc_section"><a name="org">LLVM testing infrastructure organization</a></div>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	88	<!--=========================================================================-->
				89
				90	<div class="doc_text">
				91
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	92	<p>The LLVM testing infrastructure contains two major categories of tests: code
				93	fragments and whole programs. Code fragments are referred to as the "DejaGNU
				94	tests" and are in the <tt>llvm</tt> module in subversion under the
				95	<tt>llvm/test</tt> directory. The whole programs tests are referred to as the
				96	"Test suite" and are in the <tt>test-suite</tt> module in subversion.
				97	</p>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	98
				99	</div>
				100
				101	<!-- _______________________________________________________________________ -->
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	102	<div class="doc_subsection"><a name="dejagnu">DejaGNU tests</a></div>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	103	<!-- _______________________________________________________________________ -->
				104
				105	<div class="doc_text">
				106
Shantonu Sen	c0a63b2	2009-06-26 05:44:53 +0000	[diff] [blame]	107	<p>Code fragments are small pieces of code that test a specific
				108	feature of LLVM or trigger a specific bug in LLVM. They are usually
				109	written in LLVM assembly language, but can be written in other
				110	languages if the test targets a particular language front end (and the
				111	appropriate <tt>--with-llvmgcc</tt> options were used
				112	at <tt>configure</tt> time of the <tt>llvm</tt> module). These tests
				113	are driven by the DejaGNU testing framework, which is hidden behind a
				114	few simple makefiles.</p>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	115
Shantonu Sen	c0a63b2	2009-06-26 05:44:53 +0000	[diff] [blame]	116	<p>These code fragments are not complete programs. The code generated
				117	from them is never executed to determine correct behavior.</p>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	118
				119	<p>These code fragment tests are located in the <tt>llvm/test</tt>
				120	directory.</p>
				121
				122	<p>Typically when a bug is found in LLVM, a regression test containing
				123	just enough code to reproduce the problem should be written and placed
				124	somewhere underneath this directory. In most cases, this will be a small
				125	piece of LLVM assembly language code, often distilled from an actual
				126	application or benchmark.</p>
				127
				128	</div>
				129
				130	<!-- _______________________________________________________________________ -->
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	131	<div class="doc_subsection"><a name="testsuite">Test suite</a></div>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	132	<!-- _______________________________________________________________________ -->
				133
				134	<div class="doc_text">
				135
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	136	<p>The test suite contains whole programs, which are pieces of
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	137	code which can be compiled and linked into a stand-alone program that can be
				138	executed. These programs are generally written in high level languages such as
				139	C or C++, but sometimes they are written straight in LLVM assembly.</p>
				140
				141	<p>These programs are compiled and then executed using several different
				142	methods (native compiler, LLVM C backend, LLVM JIT, LLVM native code generation,
				143	etc). The output of these programs is compared to ensure that LLVM is compiling
				144	the program correctly.</p>
				145
				146	<p>In addition to compiling and executing programs, whole program tests serve as
				147	a way of benchmarking LLVM performance, both in terms of the efficiency of the
				148	programs generated as well as the speed with which LLVM compiles, optimizes, and
				149	generates code.</p>
				150
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	151	<p>The test-suite is located in the <tt>test-suite</tt> Subversion module.</p>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	152
				153	</div>
				154
				155	<!--=========================================================================-->
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	156	<div class="doc_section"><a name="quick">Quick start</a></div>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	157	<!--=========================================================================-->
				158
				159	<div class="doc_text">
				160
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	161	<p>The tests are located in two separate Subversion modules. The
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	162	DejaGNU tests are in the main "llvm" module under the directory
				163	<tt>llvm/test</tt> (so you get these tests for free with the main llvm tree).
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	164	The more comprehensive test suite that includes whole
				165	programs in C and C++ is in the <tt>test-suite</tt> module. This module should
				166	be checked out to the <tt>llvm/projects</tt> directory (don't use another name
				167	then the default "test-suite", for then the test suite will be run every time
				168	you run <tt>make</tt> in the main <tt>llvm</tt> directory).
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	169	When you <tt>configure</tt> the <tt>llvm</tt> module,
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	170	the <tt>test-suite</tt> directory will be automatically configured.
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	171	Alternatively, you can configure the <tt>test-suite</tt> module manually.</p>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	172
				173	<!-- _______________________________________________________________________ -->
				174	<div class="doc_subsection"><a name="quickdejagnu">DejaGNU tests</a></div>
				175	<!-- _______________________________________________________________________ -->
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	176	<p>To run all of the simple tests in LLVM using DejaGNU, use the master Makefile
				177	in the <tt>llvm/test</tt> directory:</p>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	178
				179	<div class="doc_code">
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	180	<pre>
				181	% gmake -C llvm/test
				182	</pre>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	183	</div>
				184
				185	<p>or</p>
				186
				187	<div class="doc_code">
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	188	<pre>
				189	% gmake check
				190	</pre>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	191	</div>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	192
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	193	<p>To run only a subdirectory of tests in <tt>llvm/test</tt> using DejaGNU (ie.
				194	Transforms), just set the TESTSUITE variable to the path of the
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	195	subdirectory (relative to <tt>llvm/test</tt>):</p>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	196
				197	<div class="doc_code">
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	198	<pre>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	199	% gmake TESTSUITE=Transforms check
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	200	</pre>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	201	</div>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	202
				203	<p><b>Note: If you are running the tests with <tt>objdir != subdir</tt>, you
				204	must have run the complete testsuite before you can specify a
				205	subdirectory.</b></p>
				206
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	207	<p>To run only a single test, set <tt>TESTONE</tt> to its path (relative to
				208	<tt>llvm/test</tt>) and make the <tt>check-one</tt> target:</p>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	209
				210	<div class="doc_code">
				211	<pre>
				212	% gmake TESTONE=Feature/basictest.ll check-one
				213	</pre>
				214	</div>
				215
Nuno Lopes	cae9010	2008-11-25 15:57:52 +0000	[diff] [blame]	216	<p>To run the tests with Valgrind (Memcheck by default), just append
				217	<tt>VG=1</tt> to the commands above, e.g.:</p>
				218
				219	<div class="doc_code">
				220	<pre>
				221	% gmake check VG=1
				222	</pre>
				223	</div>
				224
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	225	<!-- _______________________________________________________________________ -->
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	226	<div class="doc_subsection"><a name="quicktestsuite">Test suite</a></div>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	227	<!-- _______________________________________________________________________ -->
				228
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	229	<p>To run the comprehensive test suite (tests that compile and execute whole
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	230	programs), first checkout and setup the <tt>test-suite</tt> module:</p>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	231
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	232	<div class="doc_code">
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	233	<pre>
				234	% cd llvm/projects
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	235	% svn co http://llvm.org/svn/llvm-project/test-suite/trunk test-suite
Tanya Lattner	0da51e8	2007-11-28 05:13:45 +0000	[diff] [blame]	236	% cd ..
				237	% ./configure --with-llvmgccdir=$LLVM_GCC_DIR
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	238	</pre>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	239	</div>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	240
Shantonu Sen	c0a63b2	2009-06-26 05:44:53 +0000	[diff] [blame]	241	<p>where <tt>$LLVM_GCC_DIR</tt> is the directory where
				242	you <em>installed</em> llvm-gcc, not it's src or obj
				243	dir. The <tt>--with-llvmgccdir</tt> option assumes that
				244	the <tt>llvm-gcc-4.2</tt> module was configured with
				245	<tt>--program-prefix=llvm-</tt>, and therefore that the C and C++
				246	compiler drivers are called <tt>llvm-gcc</tt> and <tt>llvm-g++</tt>
				247	respectively. If this is not the case,
				248	use <tt>--with-llvmgcc</tt>/<tt>--with-llvmgxx</tt> to specify each
				249	executable's location.</p>
				250
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	251	<p>Then, run the entire test suite by running make in the <tt>test-suite</tt>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	252	directory:</p>
				253
				254	<div class="doc_code">
				255	<pre>
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	256	% cd projects/test-suite
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	257	% gmake
				258	</pre>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	259	</div>
				260
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	261	<p>Usually, running the "nightly" set of tests is a good idea, and you can also
				262	let it generate a report by running:</p>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	263
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	264	<div class="doc_code">
				265	<pre>
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	266	% cd projects/test-suite
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	267	% gmake TEST=nightly report report.html
				268	</pre>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	269	</div>
				270
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	271	<p>Any of the above commands can also be run in a subdirectory of
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	272	<tt>projects/test-suite</tt> to run the specified test only on the programs in
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	273	that subdirectory.</p>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	274
				275	</div>
				276
				277	<!--=========================================================================-->
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	278	<div class="doc_section"><a name="dgstructure">DejaGNU structure</a></div>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	279	<!--=========================================================================-->
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	280	<div class="doc_text">
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	281	<p>The LLVM DejaGNU tests are driven by DejaGNU together with GNU Make and are
				282	located in the <tt>llvm/test</tt> directory.
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	283
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	284	<p>This directory contains a large array of small tests
				285	that exercise various features of LLVM and to ensure that regressions do not
				286	occur. The directory is broken into several sub-directories, each focused on
Bill Wendling	650d3b3	2007-09-22 09:20:07 +0000	[diff] [blame]	287	a particular area of LLVM. A few of the important ones are:</p>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	288
Bill Wendling	650d3b3	2007-09-22 09:20:07 +0000	[diff] [blame]	289	<ul>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	290	<li><tt>Analysis</tt>: checks Analysis passes.</li>
				291	<li><tt>Archive</tt>: checks the Archive library.</li>
				292	<li><tt>Assembler</tt>: checks Assembly reader/writer functionality.</li>
				293	<li><tt>Bitcode</tt>: checks Bitcode reader/writer functionality.</li>
				294	<li><tt>CodeGen</tt>: checks code generation and each target.</li>
				295	<li><tt>Features</tt>: checks various features of the LLVM language.</li>
				296	<li><tt>Linker</tt>: tests bitcode linking.</li>
				297	<li><tt>Transforms</tt>: tests each of the scalar, IPO, and utility
				298	transforms to ensure they make the right transformations.</li>
				299	<li><tt>Verifier</tt>: tests the IR verifier.</li>
Bill Wendling	650d3b3	2007-09-22 09:20:07 +0000	[diff] [blame]	300	</ul>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	301
				302	</div>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	303
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	304	<!-- _______________________________________________________________________ -->
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	305	<div class="doc_subsection"><a name="dgcustom">Writing new DejaGNU tests</a></div>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	306	<!-- _______________________________________________________________________ -->
				307	<div class="doc_text">
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	308	<p>The DejaGNU structure is very simple, but does require some information to
				309	be set. This information is gathered via <tt>configure</tt> and is written
				310	to a file, <tt>site.exp</tt> in <tt>llvm/test</tt>. The <tt>llvm/test</tt>
				311	Makefile does this work for you.</p>
				312
				313	<p>In order for DejaGNU to work, each directory of tests must have a
				314	<tt>dg.exp</tt> file. DejaGNU looks for this file to determine how to run the
				315	tests. This file is just a Tcl script and it can do anything you want, but
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	316	we've standardized it for the LLVM regression tests. If you're adding a
				317	directory of tests, just copy <tt>dg.exp</tt> from another directory to get
				318	running. The standard <tt>dg.exp</tt> simply loads a Tcl
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	319	library (<tt>test/lib/llvm.exp</tt>) and calls the <tt>llvm_runtests</tt>
				320	function defined in that library with a list of file names to run. The names
				321	are obtained by using Tcl's glob command. Any directory that contains only
				322	directories does not need the <tt>dg.exp</tt> file.</p>
				323
				324	<p>The <tt>llvm-runtests</tt> function lookas at each file that is passed to
				325	it and gathers any lines together that match "RUN:". This are the "RUN" lines
				326	that specify how the test is to be run. So, each test script must contain
				327	RUN lines if it is to do anything. If there are no RUN lines, the
				328	<tt>llvm-runtests</tt> function will issue an error and the test will
				329	fail.</p>
				330
				331	<p>RUN lines are specified in the comments of the test program using the
				332	keyword <tt>RUN</tt> followed by a colon, and lastly the command (pipeline)
				333	to execute. Together, these lines form the "script" that
				334	<tt>llvm-runtests</tt> executes to run the test case. The syntax of the
				335	RUN lines is similar to a shell's syntax for pipelines including I/O
				336	redirection and variable substitution. However, even though these lines
				337	may <i>look</i> like a shell script, they are not. RUN lines are interpreted
				338	directly by the Tcl <tt>exec</tt> command. They are never executed by a
				339	shell. Consequently the syntax differs from normal shell script syntax in a
				340	few ways. You can specify as many RUN lines as needed.</p>
				341
				342	<p>Each RUN line is executed on its own, distinct from other lines unless
				343	its last character is <tt>\</tt>. This continuation character causes the RUN
				344	line to be concatenated with the next one. In this way you can build up long
				345	pipelines of commands without making huge line lengths. The lines ending in
				346	<tt>\</tt> are concatenated until a RUN line that doesn't end in <tt>\</tt> is
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	347	found. This concatenated set of RUN lines then constitutes one execution.
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	348	Tcl will substitute variables and arrange for the pipeline to be executed. If
				349	any process in the pipeline fails, the entire line (and test case) fails too.
				350	</p>
				351
				352	<p> Below is an example of legal RUN lines in a <tt>.ll</tt> file:</p>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	353
				354	<div class="doc_code">
				355	<pre>
				356	; RUN: llvm-as < %s \| llvm-dis > %t1
				357	; RUN: llvm-dis < %s.bc-13 > %t2
				358	; RUN: diff %t1 %t2
				359	</pre>
				360	</div>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	361
				362	<p>As with a Unix shell, the RUN: lines permit pipelines and I/O redirection
				363	to be used. However, the usage is slightly different than for Bash. To check
				364	what's legal, see the documentation for the
				365	<a href="http://www.tcl.tk/man/tcl8.5/TclCmd/exec.htm#M2">Tcl exec</a>
				366	command and the
				367	<a href="http://www.tcl.tk/man/tcl8.5/tutorial/Tcl26.html">tutorial</a>.
				368	The major differences are:</p>
				369	<ul>
				370	<li>You can't do <tt>2>&1</tt>. That will cause Tcl to write to a
				371	file named <tt>&1</tt>. Usually this is done to get stderr to go through
				372	a pipe. You can do that in tcl with <tt>\|&</tt> so replace this idiom:
				373	<tt>... 2>&1 \| grep</tt> with <tt>... \|& grep</tt></li>
				374	<li>You can only redirect to a file, not to another descriptor and not from
				375	a here document.</li>
				376	<li>tcl supports redirecting to open files with the @ syntax but you
				377	shouldn't use that here.</li>
				378	</ul>
				379
				380	<p>There are some quoting rules that you must pay attention to when writing
				381	your RUN lines. In general nothing needs to be quoted. Tcl won't strip off any
				382	' or " so they will get passed to the invoked program. For example:</p>
Bill Wendling	07370de	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
Dan Gohman	f17a25c	2007-07-18 16:29:46 +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	07370de	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
Dan Gohman	f17a25c	2007-07-18 16:29:46 +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	07370de	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
Dan Gohman	f17a25c	2007-07-18 16:29:46 +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	07370de	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
Dan Gohman	f17a25c	2007-07-18 16:29:46 +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	07370de	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
Dan Gohman	f17a25c	2007-07-18 16:29:46 +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	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	437
				438	<div class="doc_code">
				439	<pre>
				440	... \| grep {i32\\*}
				441	</pre>
				442	</div>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	443
Shantonu Sen	c0a63b2	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
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	449	</div>
				450
				451	<!-- _______________________________________________________________________ -->
Chris Lattner	0012837	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	4deb964	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	0012837	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	4deb964	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	0012837	2009-08-15 15:40:48 +0000	[diff] [blame]	477
Chris Lattner	4deb964	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	2337291	2009-08-15 18:32:21 +0000	[diff] [blame]	521	</div>
				522
				523	<!-- _______________________________________________________________________ -->
Chris Lattner	4deb964	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	2337291	2009-08-15 18:32:21 +0000	[diff] [blame]	527	<div class="doc_text">
				528
Chris Lattner	4deb964	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	4deb964	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	2337291	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	d1a2039	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	2337291	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	d1a2039	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	2337291	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	0012837	2009-08-15 15:40:48 +0000	[diff] [blame]	594
				595	</div>
				596
				597	<!-- _______________________________________________________________________ -->
Chris Lattner	0d82c70	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
				604	between two matches (or the first matches and the beginning of the file). For
				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	4deb964	2009-08-15 16:51:06 +0000	[diff] [blame]	628	<div class="doc_subsection"><a name="dgvars">Variables and
				629	substitutions</a></div>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	630	<!-- _______________________________________________________________________ -->
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	631	<div class="doc_text">
				632	<p>With a RUN line there are a number of substitutions that are permitted. In
				633	general, any Tcl variable that is available in the <tt>substitute</tt>
				634	function (in <tt>test/lib/llvm.exp</tt>) can be substituted into a RUN line.
				635	To make a substitution just write the variable's name preceded by a $.
				636	Additionally, for compatibility reasons with previous versions of the test
				637	library, certain names can be accessed with an alternate syntax: a % prefix.
				638	These alternates are deprecated and may go away in a future version.
				639	</p>
Bill Wendling	650d3b3	2007-09-22 09:20:07 +0000	[diff] [blame]	640	<p>Here are the available variable names. The alternate syntax is listed in
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	641	parentheses.</p>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	642
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	643	<dl style="margin-left: 25px">
				644	<dt><b>$test</b> (%s)</dt>
				645	<dd>The full path to the test case's source. This is suitable for passing
				646	on the command line as the input to an llvm tool.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	647
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	648	<dt><b>$srcdir</b></dt>
				649	<dd>The source directory from where the "<tt>make check</tt>" was run.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	650
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	651	<dt><b>objdir</b></dt>
Bill Wendling	650d3b3	2007-09-22 09:20:07 +0000	[diff] [blame]	652	<dd>The object directory that corresponds to the <tt>$srcdir</tt>.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	653
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	654	<dt><b>subdir</b></dt>
				655	<dd>A partial path from the <tt>test</tt> directory that contains the
				656	sub-directory that contains the test source being executed.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	657
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	658	<dt><b>srcroot</b></dt>
				659	<dd>The root directory of the LLVM src tree.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	660
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	661	<dt><b>objroot</b></dt>
				662	<dd>The root directory of the LLVM object tree. This could be the same
				663	as the srcroot.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	664
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	665	<dt><b>path</b><dt>
				666	<dd>The path to the directory that contains the test case source. This is
				667	for locating any supporting files that are not generated by the test, but
				668	used by the test.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	669
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	670	<dt><b>tmp</b></dt>
				671	<dd>The path to a temporary file name that could be used for this test case.
				672	The file name won't conflict with other test cases. You can append to it if
				673	you need multiple temporaries. This is useful as the destination of some
				674	redirected output.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	675
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	676	<dt><b>llvmlibsdir</b> (%llvmlibsdir)</dt>
				677	<dd>The directory where the LLVM libraries are located.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	678
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	679	<dt><b>target_triplet</b> (%target_triplet)</dt>
				680	<dd>The target triplet that corresponds to the current host machine (the one
				681	running the test cases). This should probably be called "host".<dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	682
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	683	<dt><b>llvmgcc</b> (%llvmgcc)</dt>
				684	<dd>The full path to the <tt>llvm-gcc</tt> executable as specified in the
				685	configured LLVM environment</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	686
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	687	<dt><b>llvmgxx</b> (%llvmgxx)</dt>
				688	<dd>The full path to the <tt>llvm-gxx</tt> executable as specified in the
				689	configured LLVM environment</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	690
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	691	<dt><b>llvmgcc_version</b> (%llvmgcc_version)</dt>
				692	<dd>The full version number of the <tt>llvm-gcc</tt> executable.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	693
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	694	<dt><b>llvmgccmajvers</b> (%llvmgccmajvers)</dt>
				695	<dd>The major version number of the <tt>llvm-gcc</tt> executable.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	696
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	697	<dt><b>gccpath</b></dt>
				698	<dd>The full path to the C compiler used to <i>build </i> LLVM. Note that
				699	this might not be gcc.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	700
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	701	<dt><b>gxxpath</b></dt>
				702	<dd>The full path to the C++ compiler used to <i>build </i> LLVM. Note that
				703	this might not be g++.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	704
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	705	<dt><b>compile_c</b> (%compile_c)</dt>
				706	<dd>The full command line used to compile LLVM C source code. This has all
				707	the configured -I, -D and optimization options.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	708
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	709	<dt><b>compile_cxx</b> (%compile_cxx)</dt>
				710	<dd>The full command used to compile LLVM C++ source code. This has
				711	all the configured -I, -D and optimization options.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	712
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	713	<dt><b>link</b> (%link)</dt>
				714	<dd>This full link command used to link LLVM executables. This has all the
				715	configured -I, -L and -l options.</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	716
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	717	<dt><b>shlibext</b> (%shlibext)</dt>
				718	<dd>The suffix for the host platforms share library (dll) files. This
				719	includes the period as the first character.</dd>
				720	</dl>
				721	<p>To add more variables, two things need to be changed. First, add a line in
				722	the <tt>test/Makefile</tt> that creates the <tt>site.exp</tt> file. This will
				723	"set" the variable as a global in the site.exp file. Second, in the
				724	<tt>test/lib/llvm.exp</tt> file, in the substitute proc, add the variable name
				725	to the list of "global" declarations at the beginning of the proc. That's it,
				726	the variable can then be used in test scripts.</p>
				727	</div>
				728
				729	<!-- _______________________________________________________________________ -->
				730	<div class="doc_subsection"><a name="dgfeatures">Other Features</a></div>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	731	<!-- _______________________________________________________________________ -->
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	732	<div class="doc_text">
				733	<p>To make RUN line writing easier, there are several shell scripts located
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	734	in the <tt>llvm/test/Scripts</tt> directory. This directory is in the PATH
				735	when running tests, so you can just call these scripts using their name. For
				736	example:</p>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	737	<dl>
				738	<dt><b>ignore</b></dt>
				739	<dd>This script runs its arguments and then always returns 0. This is useful
				740	in cases where the test needs to cause a tool to generate an error (e.g. to
				741	check the error output). However, any program in a pipeline that returns a
				742	non-zero result will cause the test to fail. This script overcomes that
				743	issue and nicely documents that the test case is purposefully ignoring the
				744	result code of the tool</dd>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	745
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	746	<dt><b>not</b></dt>
				747	<dd>This script runs its arguments and then inverts the result code from
				748	it. Zero result codes become 1. Non-zero result codes become 0. This is
				749	useful to invert the result of a grep. For example "not grep X" means
				750	succeed only if you don't find X in the input.</dd>
				751	</dl>
				752
				753	<p>Sometimes it is necessary to mark a test case as "expected fail" or XFAIL.
				754	You can easily mark a test as XFAIL just by including <tt>XFAIL: </tt> on a
				755	line near the top of the file. This signals that the test case should succeed
				756	if the test fails. Such test cases are counted separately by DejaGnu. To
				757	specify an expected fail, use the XFAIL keyword in the comments of the test
				758	program followed by a colon and one or more regular expressions (separated by
				759	a comma). The regular expressions allow you to XFAIL the test conditionally
				760	by host platform. The regular expressions following the : are matched against
				761	the target triplet or llvmgcc version number for the host machine. If there is
				762	a match, the test is expected to fail. If not, the test is expected to
				763	succeed. To XFAIL everywhere just specify <tt>XFAIL: *</tt>. When matching
				764	the llvm-gcc version, you can specify the major (e.g. 3) or full version
				765	(i.e. 3.4) number. Here is an example of an <tt>XFAIL</tt> line:</p>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	766
				767	<div class="doc_code">
				768	<pre>
				769	; XFAIL: darwin,sun,llvmgcc4
				770	</pre>
				771	</div>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	772
				773	<p>To make the output more useful, the <tt>llvm_runtest</tt> function wil
				774	scan the lines of the test case for ones that contain a pattern that matches
				775	PR[0-9]+. This is the syntax for specifying a PR (Problem Report) number that
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	776	is related to the test case. The number after "PR" specifies the LLVM bugzilla
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	777	number. When a PR number is specified, it will be used in the pass/fail
				778	reporting. This is useful to quickly get some context when a test fails.</p>
				779
				780	<p>Finally, any line that contains "END." will cause the special
				781	interpretation of lines to terminate. This is generally done right after the
				782	last RUN: line. This has two side effects: (a) it prevents special
				783	interpretation of lines that are part of the test program, not the
				784	instructions to the test case, and (b) it speeds things up for really big test
				785	cases by avoiding interpretation of the remainder of the file.</p>
				786
				787	</div>
				788
				789	<!--=========================================================================-->
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	790	<div class="doc_section"><a name="testsuitestructure">Test suite
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	791	Structure</a></div>
				792	<!--=========================================================================-->
				793
				794	<div class="doc_text">
				795
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	796	<p>The <tt>test-suite</tt> module contains a number of programs that can be compiled
				797	with LLVM and executed. These programs are compiled using the native compiler
				798	and various LLVM backends. The output from the program compiled with the
				799	native compiler is assumed correct; the results from the other programs are
				800	compared to the native program output and pass if they match.</p>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	801
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	802	<p>When executing tests, it is usually a good idea to start out with a subset of
				803	the available tests or programs. This makes test run times smaller at first and
				804	later on this is useful to investigate individual test failures. To run some
				805	test only on a subset of programs, simply change directory to the programs you
				806	want tested and run <tt>gmake</tt> there. Alternatively, you can run a different
				807	test using the <tt>TEST</tt> variable to change what tests or run on the
				808	selected programs (see below for more info).</p>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	809
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	810	<p>In addition for testing correctness, the <tt>llvm-test</tt> directory also
				811	performs timing tests of various LLVM optimizations. It also records
				812	compilation times for the compilers and the JIT. This information can be
				813	used to compare the effectiveness of LLVM's optimizations and code
				814	generation.</p>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	815
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	816	<p><tt>llvm-test</tt> tests are divided into three types of tests: MultiSource,
				817	SingleSource, and External.</p>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	818
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	819	<ul>
				820	<li><tt>llvm-test/SingleSource</tt>
				821	<p>The SingleSource directory contains test programs that are only a single
				822	source file in size. These are usually small benchmark programs or small
				823	programs that calculate a particular value. Several such programs are grouped
				824	together in each directory.</p></li>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	825
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	826	<li><tt>llvm-test/MultiSource</tt>
				827	<p>The MultiSource directory contains subdirectories which contain entire
				828	programs with multiple source files. Large benchmarks and whole applications
				829	go here.</p></li>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	830
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	831	<li><tt>llvm-test/External</tt>
				832	<p>The External directory contains Makefiles for building code that is external
				833	to (i.e., not distributed with) LLVM. The most prominent members of this
				834	directory are the SPEC 95 and SPEC 2000 benchmark suites. The <tt>External</tt>
Stuart Hastings	aa8f28e	2009-05-21 20:23:59 +0000	[diff] [blame]	835	directory does not contain these actual tests, but only the Makefiles that know
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	836	how to properly compile these programs from somewhere else. The presence and
				837	location of these external programs is configured by the llvm-test
				838	<tt>configure</tt> script.</p></li>
				839	</ul>
				840
				841	<p>Each tree is then subdivided into several categories, including applications,
				842	benchmarks, regression tests, code that is strange grammatically, etc. These
				843	organizations should be relatively self explanatory.</p>
				844
				845	<p>Some tests are known to fail. Some are bugs that we have not fixed yet;
				846	others are features that we haven't added yet (or may never add). In DejaGNU,
				847	the result for such tests will be XFAIL (eXpected FAILure). In this way, you
				848	can tell the difference between an expected and unexpected failure.</p>
				849
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	850	<p>The tests in the test suite have no such feature at this time. If the
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	851	test passes, only warnings and other miscellaneous output will be generated. If
				852	a test fails, a large <program> FAILED message will be displayed. This
				853	will help you separate benign warnings from actual test failures.</p>
				854
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	855	</div>
				856
				857	<!--=========================================================================-->
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	858	<div class="doc_section"><a name="testsuiterun">Running the test suite</a></div>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	859	<!--=========================================================================-->
				860
				861	<div class="doc_text">
				862
				863	<p>First, all tests are executed within the LLVM object directory tree. They
				864	<i>are not</i> executed inside of the LLVM source tree. This is because the
John Mosby	8102e9d	2009-03-30 18:56:53 +0000	[diff] [blame]	865	test suite creates temporary files during execution.</p>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	866
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	867	<p>To run the test suite, you need to use the following steps:</p>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	868
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	869	<ol>
John Mosby	2bdcc04	2009-03-30 04:37:51 +0000	[diff] [blame]	870	<li><tt>cd</tt> into the <tt>llvm/projects</tt> directory in your source tree.
				871	</li>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	872
				873	<li><p>Check out the <tt>test-suite</tt> module with:</p>
				874
				875	<div class="doc_code">
				876	<pre>
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	877	% svn co http://llvm.org/svn/llvm-project/test-suite/trunk test-suite
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	878	</pre>
				879	</div>
Stuart Hastings	aa8f28e	2009-05-21 20:23:59 +0000	[diff] [blame]	880	<p>This will get the test suite into <tt>llvm/projects/test-suite</tt>.</p>
John Mosby	2bdcc04	2009-03-30 04:37:51 +0000	[diff] [blame]	881	</li>
Stuart Hastings	aa8f28e	2009-05-21 20:23:59 +0000	[diff] [blame]	882	<li><p>Configure and build <tt>llvm</tt>.</p></li>
				883	<li><p>Configure and build <tt>llvm-gcc</tt>.</p></li>
				884	<li><p>Install <tt>llvm-gcc</tt> somewhere.</p></li>
				885	<li><p><em>Re-configure</em> <tt>llvm</tt> from the top level of
				886	each build tree (LLVM object directory tree) in which you want
				887	to run the test suite, just as you do before building LLVM.</p>
				888	<p>During the <em>re-configuration</em>, you must either: (1)
				889	have <tt>llvm-gcc</tt> you just built in your path, or (2)
				890	specify the directory where your just-built <tt>llvm-gcc</tt> is
				891	installed using <tt>--with-llvmgccdir=$LLVM_GCC_DIR</tt>.</p>
				892	<p>You must also tell the configure machinery that the test suite
				893	is available so it can be configured for your build tree:</p>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	894	<div class="doc_code">
				895	<pre>
John Mosby	2bdcc04	2009-03-30 04:37:51 +0000	[diff] [blame]	896	% cd $LLVM_OBJ_ROOT ; $LLVM_SRC_ROOT/configure [--with-llvmgccdir=$LLVM_GCC_DIR]
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	897	</pre>
				898	</div>
John Mosby	2bdcc04	2009-03-30 04:37:51 +0000	[diff] [blame]	899	<p>[Remember that <tt>$LLVM_GCC_DIR</tt> is the directory where you
				900	<em>installed</em> llvm-gcc, not its src or obj directory.]</p>
Matthijs Kooijman	c987d70	2008-05-20 10:28:55 +0000	[diff] [blame]	901	</li>
				902
John Mosby	2bdcc04	2009-03-30 04:37:51 +0000	[diff] [blame]	903	<li><p>You can now run the test suite from your build tree as follows:</p>
				904	<div class="doc_code">
				905	<pre>
				906	% cd $LLVM_OBJ_ROOT/projects/test-suite
				907	% make
				908	</pre>
				909	</div>
				910	</li>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	911	</ol>
				912	<p>Note that the second and third steps only need to be done once. After you
				913	have the suite checked out and configured, you don't need to do it again (unless
Matthijs Kooijman	c987d70	2008-05-20 10:28:55 +0000	[diff] [blame]	914	the test code or configure script changes).</p>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	915
Shantonu Sen	c0a63b2	2009-06-26 05:44:53 +0000	[diff] [blame]	916	</div>
				917
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	918	<!-- _______________________________________________________________________ -->
				919	<div class="doc_subsection">
Stuart Hastings	aa8f28e	2009-05-21 20:23:59 +0000	[diff] [blame]	920	<a name="testsuiteexternal">Configuring External Tests</a></div>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	921	<!-- _______________________________________________________________________ -->
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	922
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	923	<div class="doc_text">
Stuart Hastings	aa8f28e	2009-05-21 20:23:59 +0000	[diff] [blame]	924	<p>In order to run the External tests in the <tt>test-suite</tt>
				925	module, you must specify <i>--with-externals</i>. This
				926	must be done during the <em>re-configuration</em> step (see above),
				927	and the <tt>llvm</tt> re-configuration must recognize the
				928	previously-built <tt>llvm-gcc</tt>. If any of these is missing or
				929	neglected, the External tests won't work.</p>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	930	<dl>
Dale Johannesen	a184082	2008-12-10 01:58:32 +0000	[diff] [blame]	931	<dt><i>--with-externals</i></dt>
				932	<dt><i>--with-externals=<<tt>directory</tt>></i></dt>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	933	</dl>
Dale Johannesen	a184082	2008-12-10 01:58:32 +0000	[diff] [blame]	934	This tells LLVM where to find any external tests. They are expected to be
				935	in specifically named subdirectories of <<tt>directory</tt>>.
				936	If <tt>directory</tt> is left unspecified,
				937	<tt>configure</tt> uses the default value
				938	<tt>/home/vadve/shared/benchmarks/speccpu2000/benchspec</tt>.
				939	Subdirectory names known to LLVM include:
				940	<dl>
				941	<dt>spec95</dt>
				942	<dt>speccpu2000</dt>
				943	<dt>speccpu2006</dt>
				944	<dt>povray31</dt>
				945	</dl>
				946	Others are added from time to time, and can be determined from
				947	<tt>configure</tt>.
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	948	</div>
				949
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	950	<!-- _______________________________________________________________________ -->
				951	<div class="doc_subsection">
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	952	<a name="testsuitetests">Running different tests</a></div>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	953	<!-- _______________________________________________________________________ -->
				954	<div class="doc_text">
Stuart Hastings	aa8f28e	2009-05-21 20:23:59 +0000	[diff] [blame]	955	<p>In addition to the regular "whole program" tests, the <tt>test-suite</tt>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	956	module also provides a mechanism for compiling the programs in different ways.
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	957	If the variable TEST is defined on the <tt>gmake</tt> command line, the test system will
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	958	include a Makefile named <tt>TEST.<value of TEST variable>.Makefile</tt>.
				959	This Makefile can modify build rules to yield different results.</p>
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	960
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	961	<p>For example, the LLVM nightly tester uses <tt>TEST.nightly.Makefile</tt> to
				962	create the nightly test reports. To run the nightly tests, run <tt>gmake
				963	TEST=nightly</tt>.</p>
				964
				965	<p>There are several TEST Makefiles available in the tree. Some of them are
				966	designed for internal LLVM research and will not work outside of the LLVM
				967	research group. They may still be valuable, however, as a guide to writing your
				968	own TEST Makefile for any optimization or analysis passes that you develop with
				969	LLVM.</p>
				970
Bill Wendling	07370de	2007-09-22 09:16:44 +0000	[diff] [blame]	971	</div>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	972
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	973	<!-- _______________________________________________________________________ -->
				974	<div class="doc_subsection">
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	975	<a name="testsuiteoutput">Generating test output</a></div>
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	976	<!-- _______________________________________________________________________ -->
				977	<div class="doc_text">
				978	<p>There are a number of ways to run the tests and generate output. The most
				979	simple one is simply running <tt>gmake</tt> with no arguments. This will
				980	compile and run all programs in the tree using a number of different methods
				981	and compare results. Any failures are reported in the output, but are likely
				982	drowned in the other output. Passes are not reported explicitely.</p>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	983
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	984	<p>Somewhat better is running <tt>gmake TEST=sometest test</tt>, which runs
				985	the specified test and usually adds per-program summaries to the output
				986	(depending on which sometest you use). For example, the <tt>nightly</tt> test
				987	explicitely outputs TEST-PASS or TEST-FAIL for every test after each program.
				988	Though these lines are still drowned in the output, it's easy to grep the
				989	output logs in the Output directories.</p>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	990
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	991	<p>Even better are the <tt>report</tt> and <tt>report.format</tt> targets
				992	(where <tt>format</tt> is one of <tt>html</tt>, <tt>csv</tt>, <tt>text</tt> or
				993	<tt>graphs</tt>). The exact contents of the report are dependent on which
				994	<tt>TEST</tt> you are running, but the text results are always shown at the
				995	end of the run and the results are always stored in the
				996	<tt>report.<type>.format</tt> file (when running with
				997	<tt>TEST=<type></tt>).
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	998
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	999	The <tt>report</tt> also generate a file called
				1000	<tt>report.<type>.raw.out</tt> containing the output of the entire test
				1001	run.
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	1002	</div>
				1003
				1004	<!-- _______________________________________________________________________ -->
				1005	<div class="doc_subsection">
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	1006	<a name="testsuitecustom">Writing custom tests for the test suite</a></div>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	1007	<!-- _______________________________________________________________________ -->
				1008
				1009	<div class="doc_text">
				1010
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	1011	<p>Assuming you can run the test suite, (e.g. "<tt>gmake TEST=nightly report</tt>"
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	1012	should work), it is really easy to run optimizations or code generator
				1013	components against every program in the tree, collecting statistics or running
				1014	custom checks for correctness. At base, this is how the nightly tester works,
				1015	it's just one example of a general framework.</p>
				1016
				1017	<p>Lets say that you have an LLVM optimization pass, and you want to see how
				1018	many times it triggers. First thing you should do is add an LLVM
				1019	<a href="ProgrammersManual.html#Statistic">statistic</a> to your pass, which
				1020	will tally counts of things you care about.</p>
				1021
				1022	<p>Following this, you can set up a test and a report that collects these and
				1023	formats them for easy viewing. This consists of two files, an
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	1024	"<tt>test-suite/TEST.XXX.Makefile</tt>" fragment (where XXX is the name of your
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	1025	test) and an "<tt>llvm-test/TEST.XXX.report</tt>" file that indicates how to
				1026	format the output into a table. There are many example reports of various
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	1027	levels of sophistication included with the test suite, and the framework is very
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	1028	general.</p>
				1029
				1030	<p>If you are interested in testing an optimization pass, check out the
				1031	"libcalls" test as an example. It can be run like this:<p>
				1032
				1033	<div class="doc_code">
				1034	<pre>
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	1035	% cd llvm/projects/test-suite/MultiSource/Benchmarks # or some other level
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	1036	% make TEST=libcalls report
				1037	</pre>
				1038	</div>
				1039
				1040	<p>This will do a bunch of stuff, then eventually print a table like this:</p>
				1041
				1042	<div class="doc_code">
				1043	<pre>
				1044	Name \| total \| #exit \|
				1045	...
				1046	FreeBench/analyzer/analyzer \| 51 \| 6 \|
				1047	FreeBench/fourinarow/fourinarow \| 1 \| 1 \|
				1048	FreeBench/neural/neural \| 19 \| 9 \|
				1049	FreeBench/pifft/pifft \| 5 \| 3 \|
				1050	MallocBench/cfrac/cfrac \| 1 \| * \|
				1051	MallocBench/espresso/espresso \| 52 \| 12 \|
				1052	MallocBench/gs/gs \| 4 \| * \|
				1053	Prolangs-C/TimberWolfMC/timberwolfmc \| 302 \| * \|
				1054	Prolangs-C/agrep/agrep \| 33 \| 12 \|
				1055	Prolangs-C/allroots/allroots \| * \| * \|
				1056	Prolangs-C/assembler/assembler \| 47 \| * \|
				1057	Prolangs-C/bison/mybison \| 74 \| * \|
				1058	...
				1059	</pre>
				1060	</div>
				1061
				1062	<p>This basically is grepping the -stats output and displaying it in a table.
				1063	You can also use the "TEST=libcalls report.html" target to get the table in HTML
				1064	form, similarly for report.csv and report.tex.</p>
				1065
Matthijs Kooijman	977ffef	2008-06-24 12:58:31 +0000	[diff] [blame]	1066	<p>The source for this is in test-suite/TEST.libcalls.*. The format is pretty
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	1067	simple: the Makefile indicates how to run the test (in this case,
				1068	"<tt>opt -simplify-libcalls -stats</tt>"), and the report contains one line for
				1069	each column of the output. The first value is the header for the column and the
				1070	second is the regex to grep the output of the command for. There are lots of
				1071	example reports that can do fancy stuff.</p>
				1072
				1073	</div>
				1074
				1075
				1076	<!--=========================================================================-->
				1077	<div class="doc_section"><a name="nightly">Running the nightly tester</a></div>
				1078	<!--=========================================================================-->
				1079
				1080	<div class="doc_text">
				1081
				1082	<p>
				1083	The <a href="http://llvm.org/nightlytest/">LLVM Nightly Testers</a>
				1084	automatically check out an LLVM tree, build it, run the "nightly"
Matthijs Kooijman	9860486	2008-05-23 11:45:18 +0000	[diff] [blame]	1085	program test (described above), run all of the DejaGNU tests,
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	1086	delete the checked out tree, and then submit the results to
				1087	<a href="http://llvm.org/nightlytest/">http://llvm.org/nightlytest/</a>.
				1088	After test results are submitted to
				1089	<a href="http://llvm.org/nightlytest/">http://llvm.org/nightlytest/</a>,
				1090	they are processed and displayed on the tests page. An email to
				1091	<a href="http://lists.cs.uiuc.edu/pipermail/llvm-testresults/">
				1092	llvm-testresults@cs.uiuc.edu</a> summarizing the results is also generated.
				1093	This testing scheme is designed to ensure that programs don't break as well
				1094	as keep track of LLVM's progress over time.</p>
				1095
				1096	<p>If you'd like to set up an instance of the nightly tester to run on your
				1097	machine, take a look at the comments at the top of the
				1098	<tt>utils/NewNightlyTest.pl</tt> file. If you decide to set up a nightly tester
				1099	please choose a unique nickname and invoke <tt>utils/NewNightlyTest.pl</tt>
				1100	with the "-nickname [yournickname]" command line option.
				1101
				1102	<p>You can create a shell script to encapsulate the running of the script.
				1103	The optimized x86 Linux nightly test is run from just such a script:</p>
				1104
				1105	<div class="doc_code">
				1106	<pre>
				1107	#!/bin/bash
				1108	BASE=/proj/work/llvm/nightlytest
				1109	export BUILDDIR=$BASE/build
				1110	export WEBDIR=$BASE/testresults
				1111	export LLVMGCCDIR=/proj/work/llvm/cfrontend/install
				1112	export PATH=/proj/install/bin:$LLVMGCCDIR/bin:$PATH
				1113	export LD_LIBRARY_PATH=/proj/install/lib
				1114	cd $BASE
				1115	cp /proj/work/llvm/llvm/utils/NewNightlyTest.pl .
				1116	nice ./NewNightlyTest.pl -nice -release -verbose -parallel -enable-linscan \
				1117	-nickname NightlyTester -noexternals > output.log 2>&1
				1118	</pre>
				1119	</div>
				1120
				1121	<p>It is also possible to specify the the location your nightly test results
				1122	are submitted. You can do this by passing the command line option
				1123	"-submit-server [server_address]" and "-submit-script [script_on_server]" to
				1124	<tt>utils/NewNightlyTest.pl</tt>. For example, to submit to the llvm.org
				1125	nightly test results page, you would invoke the nightly test script with
				1126	"-submit-server llvm.org -submit-script /nightlytest/NightlyTestAccept.cgi".
				1127	If these options are not specified, the nightly test script sends the results
				1128	to the llvm.org nightly test results page.</p>
				1129
				1130	<p>Take a look at the <tt>NewNightlyTest.pl</tt> file to see what all of the
				1131	flags and strings do. If you start running the nightly tests, please let us
				1132	know. Thanks!</p>
				1133
				1134	</div>
				1135
				1136	<!-- *********************************************************************** -->
				1137
				1138	<hr>
				1139	<address>
				1140	<a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman	947321d	2008-12-11 17:34:48 +0000	[diff] [blame]	1141	src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	1142	<a href="http://validator.w3.org/check/referer"><img
Misha Brukman	947321d	2008-12-11 17:34:48 +0000	[diff] [blame]	1143	src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	1144
				1145	John T. Criswell, Reid Spencer, and Tanya Lattner<br>
Matthijs Kooijman	c987d70	2008-05-20 10:28:55 +0000	[diff] [blame]	1146	<a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>
Dan Gohman	f17a25c	2007-07-18 16:29:46 +0000	[diff] [blame]	1147	Last modified: $Date$
				1148	</address>
				1149	</body>
				1150	</html>