1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
|
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>test-suite Makefile Guide (deprecated) — LLVM 13 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/llvm-theme.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Code Transformation Metadata" href="TransformMetadata.html" />
<link rel="prev" title="test-suite Guide" href="TestSuiteGuide.html" />
<style type="text/css">
table.right { float: right; margin-left: 20px; }
table.right td { border: 1px solid #ccc; }
</style>
</head><body>
<div class="logo">
<a href="index.html">
<img src="_static/logo.png"
alt="LLVM Logo" width="250" height="88"/></a>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="TransformMetadata.html" title="Code Transformation Metadata"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="TestSuiteGuide.html" title="test-suite Guide"
accesskey="P">previous</a> |</li>
<li><a href="https://llvm.org/">LLVM Home</a> | </li>
<li><a href="index.html">Documentation</a>»</li>
<li class="nav-item nav-item-1"><a href="Reference.html" >Reference</a> »</li>
<li class="nav-item nav-item-2"><a href="TestingGuide.html" accesskey="U">LLVM Testing Infrastructure Guide</a> »</li>
<li class="nav-item nav-item-this"><a href="">test-suite Makefile Guide (deprecated)</a></li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3>Documentation</h3>
<ul class="want-points">
<li><a href="https://llvm.org/docs/GettingStartedTutorials.html">Getting Started/Tutorials</a></li>
<li><a href="https://llvm.org/docs/UserGuides.html">User Guides</a></li>
<li><a href="https://llvm.org/docs/Reference.html">Reference</a></li>
</ul>
<h3>Getting Involved</h3>
<ul class="want-points">
<li><a href="https://llvm.org/docs/Contributing.html">Contributing to LLVM</a></li>
<li><a href="https://llvm.org/docs/HowToSubmitABug.html">Submitting Bug Reports</a></li>
<li><a href="https://llvm.org/docs/GettingInvolved.html#mailing-lists">Mailing Lists</a></li>
<li><a href="https://llvm.org/docs/GettingInvolved.html#irc">IRC</a></li>
<li><a href="https://llvm.org/docs/GettingInvolved.html#meetups-and-social-events">Meetups and Social Events</a></li>
</ul>
<h3>Additional Links</h3>
<ul class="want-points">
<li><a href="https://llvm.org/docs/FAQ.html">FAQ</a></li>
<li><a href="https://llvm.org/docs/Lexicon.html">Glossary</a></li>
<li><a href="https://llvm.org/pubs">Publications</a></li>
<li><a href="https://github.com/llvm/llvm-project//">Github Repository</a></li>
</ul>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/TestSuiteMakefileGuide.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="test-suite-makefile-guide-deprecated">
<h1>test-suite Makefile Guide (deprecated)<a class="headerlink" href="#test-suite-makefile-guide-deprecated" title="Permalink to this headline">¶</a></h1>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#overview" id="id1">Overview</a></p></li>
<li><p><a class="reference internal" href="#configuring-external-tests" id="id2">Configuring External Tests</a></p></li>
<li><p><a class="reference internal" href="#running-different-tests" id="id3">Running Different Tests</a></p></li>
<li><p><a class="reference internal" href="#generating-test-output" id="id4">Generating Test Output</a></p></li>
<li><p><a class="reference internal" href="#writing-custom-tests-for-the-test-suite" id="id5">Writing Custom Tests for the test-suite</a></p></li>
</ul>
</div>
<div class="section" id="overview">
<h2><a class="toc-backref" href="#id1">Overview</a><a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2>
<p>First, all tests are executed within the LLVM object directory tree.
They <em>are not</em> executed inside of the LLVM source tree. This is because
the test suite creates temporary files during execution.</p>
<p>To run the test suite, you need to use the following steps:</p>
<ol class="arabic">
<li><p>Check out the <code class="docutils literal notranslate"><span class="pre">test-suite</span></code> module with:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>% git clone https://github.com/llvm/llvm-test-suite.git test-suite
</pre></div>
</div>
</li>
<li><p>FIXME: these directions are outdated and won’t work. Figure out
what the correct thing to do is, and write it down here.</p></li>
<li><p>Configure and build <code class="docutils literal notranslate"><span class="pre">llvm</span></code>.</p></li>
<li><p>Configure and build <code class="docutils literal notranslate"><span class="pre">llvm-gcc</span></code>.</p></li>
<li><p>Install <code class="docutils literal notranslate"><span class="pre">llvm-gcc</span></code> somewhere.</p></li>
<li><p><em>Re-configure</em> <code class="docutils literal notranslate"><span class="pre">llvm</span></code> from the top level of each build tree (LLVM
object directory tree) in which you want to run the test suite, just
as you do before building LLVM.</p>
<p>During the <em>re-configuration</em>, you must either: (1) have <code class="docutils literal notranslate"><span class="pre">llvm-gcc</span></code>
you just built in your path, or (2) specify the directory where your
just-built <code class="docutils literal notranslate"><span class="pre">llvm-gcc</span></code> is installed using
<code class="docutils literal notranslate"><span class="pre">--with-llvmgccdir=$LLVM_GCC_DIR</span></code>.</p>
<p>You must also tell the configure machinery that the test suite is
available so it can be configured for your build tree:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>% <span class="nb">cd</span> <span class="nv">$LLVM_OBJ_ROOT</span> <span class="p">;</span> <span class="nv">$LLVM_SRC_ROOT</span>/configure <span class="o">[</span>--with-llvmgccdir<span class="o">=</span><span class="nv">$LLVM_GCC_DIR</span><span class="o">]</span>
</pre></div>
</div>
<p>[Remember that <code class="docutils literal notranslate"><span class="pre">$LLVM_GCC_DIR</span></code> is the directory where you
<em>installed</em> llvm-gcc, not its src or obj directory.]</p>
</li>
<li><p>You can now run the test suite from your build tree as follows:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>% <span class="nb">cd</span> <span class="nv">$LLVM_OBJ_ROOT</span>/projects/test-suite
% make
</pre></div>
</div>
</li>
</ol>
<p>Note that the second and third steps only need to be done once. After
you have the suite checked out and configured, you don’t need to do it
again (unless the test code or configure script changes).</p>
</div>
<div class="section" id="configuring-external-tests">
<h2><a class="toc-backref" href="#id2">Configuring External Tests</a><a class="headerlink" href="#configuring-external-tests" title="Permalink to this headline">¶</a></h2>
<p>In order to run the External tests in the <code class="docutils literal notranslate"><span class="pre">test-suite</span></code> module, you
must specify <em>–with-externals</em>. This must be done during the
<em>re-configuration</em> step (see above), and the <code class="docutils literal notranslate"><span class="pre">llvm</span></code> re-configuration
must recognize the previously-built <code class="docutils literal notranslate"><span class="pre">llvm-gcc</span></code>. If any of these is
missing or neglected, the External tests won’t work.</p>
<ul class="simple">
<li><p><em>–with-externals</em></p></li>
<li><p><em>–with-externals=<directory></em></p></li>
</ul>
<p>This tells LLVM where to find any external tests. They are expected to
be in specifically named subdirectories of <<code class="docutils literal notranslate"><span class="pre">directory</span></code>>. If
<code class="docutils literal notranslate"><span class="pre">directory</span></code> is left unspecified, <code class="docutils literal notranslate"><span class="pre">configure</span></code> uses the default value
<code class="docutils literal notranslate"><span class="pre">/home/vadve/shared/benchmarks/speccpu2000/benchspec</span></code>. Subdirectory
names known to LLVM include:</p>
<ul class="simple">
<li><p>spec95</p></li>
<li><p>speccpu2000</p></li>
<li><p>speccpu2006</p></li>
<li><p>povray31</p></li>
</ul>
<p>Others are added from time to time, and can be determined from
<code class="docutils literal notranslate"><span class="pre">configure</span></code>.</p>
</div>
<div class="section" id="running-different-tests">
<h2><a class="toc-backref" href="#id3">Running Different Tests</a><a class="headerlink" href="#running-different-tests" title="Permalink to this headline">¶</a></h2>
<p>In addition to the regular “whole program” tests, the <code class="docutils literal notranslate"><span class="pre">test-suite</span></code>
module also provides a mechanism for compiling the programs in different
ways. If the variable TEST is defined on the <code class="docutils literal notranslate"><span class="pre">gmake</span></code> command line, the
test system will include a Makefile named
<code class="docutils literal notranslate"><span class="pre">TEST.<value</span> <span class="pre">of</span> <span class="pre">TEST</span> <span class="pre">variable>.Makefile</span></code>. This Makefile can modify
build rules to yield different results.</p>
<p>For example, the LLVM nightly tester uses <code class="docutils literal notranslate"><span class="pre">TEST.nightly.Makefile</span></code> to
create the nightly test reports. To run the nightly tests, run
<code class="docutils literal notranslate"><span class="pre">gmake</span> <span class="pre">TEST=nightly</span></code>.</p>
<p>There are several TEST Makefiles available in the tree. Some of them are
designed for internal LLVM research and will not work outside of the
LLVM research group. They may still be valuable, however, as a guide to
writing your own TEST Makefile for any optimization or analysis passes
that you develop with LLVM.</p>
</div>
<div class="section" id="generating-test-output">
<h2><a class="toc-backref" href="#id4">Generating Test Output</a><a class="headerlink" href="#generating-test-output" title="Permalink to this headline">¶</a></h2>
<p>There are a number of ways to run the tests and generate output. The
most simple one is simply running <code class="docutils literal notranslate"><span class="pre">gmake</span></code> with no arguments. This will
compile and run all programs in the tree using a number of different
methods and compare results. Any failures are reported in the output,
but are likely drowned in the other output. Passes are not reported
explicitly.</p>
<p>Somewhat better is running <code class="docutils literal notranslate"><span class="pre">gmake</span> <span class="pre">TEST=sometest</span> <span class="pre">test</span></code>, which runs the
specified test and usually adds per-program summaries to the output
(depending on which sometest you use). For example, the <code class="docutils literal notranslate"><span class="pre">nightly</span></code> test
explicitly outputs TEST-PASS or TEST-FAIL for every test after each
program. Though these lines are still drowned in the output, it’s easy
to grep the output logs in the Output directories.</p>
<p>Even better are the <code class="docutils literal notranslate"><span class="pre">report</span></code> and <code class="docutils literal notranslate"><span class="pre">report.format</span></code> targets (where
<code class="docutils literal notranslate"><span class="pre">format</span></code> is one of <code class="docutils literal notranslate"><span class="pre">html</span></code>, <code class="docutils literal notranslate"><span class="pre">csv</span></code>, <code class="docutils literal notranslate"><span class="pre">text</span></code> or <code class="docutils literal notranslate"><span class="pre">graphs</span></code>). The
exact contents of the report are dependent on which <code class="docutils literal notranslate"><span class="pre">TEST</span></code> you are
running, but the text results are always shown at the end of the run and
the results are always stored in the <code class="docutils literal notranslate"><span class="pre">report.<type>.format</span></code> file (when
running with <code class="docutils literal notranslate"><span class="pre">TEST=<type></span></code>). The <code class="docutils literal notranslate"><span class="pre">report</span></code> also generate a file
called <code class="docutils literal notranslate"><span class="pre">report.<type>.raw.out</span></code> containing the output of the entire
test run.</p>
</div>
<div class="section" id="writing-custom-tests-for-the-test-suite">
<h2><a class="toc-backref" href="#id5">Writing Custom Tests for the test-suite</a><a class="headerlink" href="#writing-custom-tests-for-the-test-suite" title="Permalink to this headline">¶</a></h2>
<p>Assuming you can run the test suite, (e.g.
“<code class="docutils literal notranslate"><span class="pre">gmake</span> <span class="pre">TEST=nightly</span> <span class="pre">report</span></code>” should work), it is really easy to run
optimizations or code generator components against every program in the
tree, collecting statistics or running custom checks for correctness. At
base, this is how the nightly tester works, it’s just one example of a
general framework.</p>
<p>Lets say that you have an LLVM optimization pass, and you want to see
how many times it triggers. First thing you should do is add an LLVM
<a class="reference external" href="ProgrammersManual.html#Statistic">statistic</a> to your pass, which will
tally counts of things you care about.</p>
<p>Following this, you can set up a test and a report that collects these
and formats them for easy viewing. This consists of two files, a
“<code class="docutils literal notranslate"><span class="pre">test-suite/TEST.XXX.Makefile</span></code>” fragment (where XXX is the name of
your test) and a “<code class="docutils literal notranslate"><span class="pre">test-suite/TEST.XXX.report</span></code>” file that indicates
how to format the output into a table. There are many example reports of
various levels of sophistication included with the test suite, and the
framework is very general.</p>
<p>If you are interested in testing an optimization pass, check out the
“libcalls” test as an example. It can be run like this:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>% <span class="nb">cd</span> llvm/projects/test-suite/MultiSource/Benchmarks <span class="c1"># or some other level</span>
% make <span class="nv">TEST</span><span class="o">=</span>libcalls report
</pre></div>
</div>
<p>This will do a bunch of stuff, then eventually print a table like this:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Name</span> <span class="o">|</span> <span class="n">total</span> <span class="o">|</span> <span class="c1">#exit |</span>
<span class="o">...</span>
<span class="n">FreeBench</span><span class="o">/</span><span class="n">analyzer</span><span class="o">/</span><span class="n">analyzer</span> <span class="o">|</span> <span class="mi">51</span> <span class="o">|</span> <span class="mi">6</span> <span class="o">|</span>
<span class="n">FreeBench</span><span class="o">/</span><span class="n">fourinarow</span><span class="o">/</span><span class="n">fourinarow</span> <span class="o">|</span> <span class="mi">1</span> <span class="o">|</span> <span class="mi">1</span> <span class="o">|</span>
<span class="n">FreeBench</span><span class="o">/</span><span class="n">neural</span><span class="o">/</span><span class="n">neural</span> <span class="o">|</span> <span class="mi">19</span> <span class="o">|</span> <span class="mi">9</span> <span class="o">|</span>
<span class="n">FreeBench</span><span class="o">/</span><span class="n">pifft</span><span class="o">/</span><span class="n">pifft</span> <span class="o">|</span> <span class="mi">5</span> <span class="o">|</span> <span class="mi">3</span> <span class="o">|</span>
<span class="n">MallocBench</span><span class="o">/</span><span class="n">cfrac</span><span class="o">/</span><span class="n">cfrac</span> <span class="o">|</span> <span class="mi">1</span> <span class="o">|</span> <span class="o">*</span> <span class="o">|</span>
<span class="n">MallocBench</span><span class="o">/</span><span class="n">espresso</span><span class="o">/</span><span class="n">espresso</span> <span class="o">|</span> <span class="mi">52</span> <span class="o">|</span> <span class="mi">12</span> <span class="o">|</span>
<span class="n">MallocBench</span><span class="o">/</span><span class="n">gs</span><span class="o">/</span><span class="n">gs</span> <span class="o">|</span> <span class="mi">4</span> <span class="o">|</span> <span class="o">*</span> <span class="o">|</span>
<span class="n">Prolangs</span><span class="o">-</span><span class="n">C</span><span class="o">/</span><span class="n">TimberWolfMC</span><span class="o">/</span><span class="n">timberwolfmc</span> <span class="o">|</span> <span class="mi">302</span> <span class="o">|</span> <span class="o">*</span> <span class="o">|</span>
<span class="n">Prolangs</span><span class="o">-</span><span class="n">C</span><span class="o">/</span><span class="n">agrep</span><span class="o">/</span><span class="n">agrep</span> <span class="o">|</span> <span class="mi">33</span> <span class="o">|</span> <span class="mi">12</span> <span class="o">|</span>
<span class="n">Prolangs</span><span class="o">-</span><span class="n">C</span><span class="o">/</span><span class="n">allroots</span><span class="o">/</span><span class="n">allroots</span> <span class="o">|</span> <span class="o">*</span> <span class="o">|</span> <span class="o">*</span> <span class="o">|</span>
<span class="n">Prolangs</span><span class="o">-</span><span class="n">C</span><span class="o">/</span><span class="n">assembler</span><span class="o">/</span><span class="n">assembler</span> <span class="o">|</span> <span class="mi">47</span> <span class="o">|</span> <span class="o">*</span> <span class="o">|</span>
<span class="n">Prolangs</span><span class="o">-</span><span class="n">C</span><span class="o">/</span><span class="n">bison</span><span class="o">/</span><span class="n">mybison</span> <span class="o">|</span> <span class="mi">74</span> <span class="o">|</span> <span class="o">*</span> <span class="o">|</span>
<span class="o">...</span>
</pre></div>
</div>
<p>This basically is grepping the -stats output and displaying it in a
table. You can also use the “TEST=libcalls report.html” target to get
the table in HTML form, similarly for report.csv and report.tex.</p>
<p>The source for this is in <code class="docutils literal notranslate"><span class="pre">test-suite/TEST.libcalls.*</span></code>. The format is
pretty simple: the Makefile indicates how to run the test (in this case,
“<code class="docutils literal notranslate"><span class="pre">opt</span> <span class="pre">-simplify-libcalls</span> <span class="pre">-stats</span></code>”), and the report contains one line
for each column of the output. The first value is the header for the
column and the second is the regex to grep the output of the command
for. There are lots of example reports that can do fancy stuff.</p>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="TransformMetadata.html" title="Code Transformation Metadata"
>next</a> |</li>
<li class="right" >
<a href="TestSuiteGuide.html" title="test-suite Guide"
>previous</a> |</li>
<li><a href="https://llvm.org/">LLVM Home</a> | </li>
<li><a href="index.html">Documentation</a>»</li>
<li class="nav-item nav-item-1"><a href="Reference.html" >Reference</a> »</li>
<li class="nav-item nav-item-2"><a href="TestingGuide.html" >LLVM Testing Infrastructure Guide</a> »</li>
<li class="nav-item nav-item-this"><a href="">test-suite Makefile Guide (deprecated)</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2003-2021, LLVM Project.
Last updated on 2021-09-18.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.5.4.
</div>
</body>
</html>
|
