</li>
<li><a href="#tree">LLVM Test Suite Tree</a></li>
<li><a href="#dgstructure">DejaGNU Structure</a></li>
- <li><a href="#qmstructure">QMTest Structure</a></li>
<li><a href="#progstructure"><tt>llvm-test</tt> Structure</a></li>
<li><a href="#run">Running the LLVM Tests</a></li>
<li><a href="#nightly">Running the nightly tester</a></li>
<dd>The Feature and Regressions tests are organized and run by DejaGNU.</dd>
<dt><a href="http://expect.nist.gov/">Expect</a></dt>
<dd>Expect is required by DejaGNU.</dd>
-<dt>tclsh</dt>
-<dd>Tclsh is required by DejaGNU. </dd>
-
-<dt><a href="http://www.qmtest.com">QMTest</a></dt>
-<dd>The LLVM test suite uses QMTest to organize and run tests. <b>Note:
-you will need <a href="http://llvm.cs.uiuc.edu/qm-2.0.3.tar.gz">QMTest
-2.0.3 (source tar.gz file)</a> to be successful. The tests do not run with
-any other version.</b> (optional, required only for QMTest)</dd>
-
-<dt><a href="http://www.python.org">Python</a></dt>
-<dd>You will need a Python interpreter that works with QMTest. Python will
-need zlib and SAX support enabled. (optional, required only for QMTest) </dd>
+<dt><a href="http://www.tcl.tk/software/tcltk/">tcl</a></dt>
+<dd>Tcl is required by DejaGNU. </dd>
<dt><a href="http://www.netlib.org/f2c">F2C</a></dt>
<dd>For now, LLVM does not have a Fortran front-end, but using F2C, we can run
programs in C and C++ is in the <tt>llvm-test</tt> module. This module should
be checked out to the <tt>llvm/projects</tt> directory. When you
<tt>configure</tt> the <tt>llvm</tt> module, the <tt>llvm-test</tt> module
-will be automatically configured. Or you can do it manually.</p>
+will be automatically configured. Alternatively, you can configure the <tt>llvm-test</tt> module manually.</p>
<p>To run all of the simple tests in LLVM using DejaGNU, use the master Makefile in the
<tt>llvm/test</tt> directory:</p>
<pre>
<pre>
% gmake -C llvm/test TESTSUITE=Regression/Transforms
</pre>
-<dd><b>Note: If you are running the tests with <tt>objdir != subdir</tt> you must have run the complete testsuite before you can specify a subdirectory.</b></dd>
-<p>To run the simple tests (i.e. those that do basic testing of
-LLVM), using QMTest:</p>
-<pre>
-% gmake -C llvm/test qmtest
-</pre>
-
-<p>To run only the basic feature tests, QMTest supports the following
-target:</p>
-<pre>
-% gmake -C llvm/test Feature.t
-</pre>
-
-<p>To run only the regression tests, QMTest supports the following
-target:</p>
-<pre>
-% gmake -C llvm/test Regression.t
-</pre>
+<p><b>Note: If you are running the tests with <tt>objdir != subdir</tt> you must
+have run the complete testsuite before you can specify a subdirectory.</b></p>
<p>To run the comprehensive test suite (tests that compile and execute whole
programs), run the <tt>llvm-test</tt> tests:</p>
<p>The LLVM test suite contains two major categories of tests: code
fragments and whole programs. Code fragments are in the <tt>llvm</tt> module
under the directory under the <tt>llvm/test</tt> directory. The whole programs
-test suite are n the <tt>llvm-test</tt> module under the main directory.</p>
+test suite are in the <tt>llvm-test</tt> module under the main directory.</p>
</div>
location of these external programs is configured by the llvm-test
<tt>configure</tt> script.</p></li>
-<li><tt>llvm/test/QMTest</tt>
-<p>This directory contains the QMTest information files. Inside this directory
-are QMTest administration files and the Python code that implements the LLVM
-test and database classes.</p></li>
-
</ul>
</div>
<div class="doc_text">
<p>The LLVM test suite is partially driven by DejaGNU and partially
driven by GNU Make. Specifically, the Features and Regression tests
-are all driven by DejaGNU (and optionally QMTest). The llvm-test
+are all driven by DejaGNU. The <tt>llvm-test</tt>
module is currently driven by a set of Makefiles.</p>
<p>The DejaGNU structure is very simple, but does require some
-information to be set. This information is gathered via configure and
-is written to a file, <tt>site.exp</tt> in llvm/test. The llvm/test
+information to be set. This information is gathered via <tt>configure</tt> and
+is written to a file, <tt>site.exp</tt> in <tt>llvm/test</tt>. The
+<tt>llvm/test</tt>
Makefile does this work for you.</p>
<p>In order for DejaGNU to work, each directory of tests must have a
<p>There are a couple patterns within a <tt>RUN</tt> line that the
llvm-runtest procedure looks for and replaces with the appropriate
syntax:</p>
-<ul>
+
+<dl style="margin-left: 25px">
<dt>%p</dt>
<dd>The path to the source directory. This is for locating
any supporting files that are not generated by the test, but used by
<dt>%s</dt>
<dd>The test file.</dd>
-<dt>$t</dt>
+<dt>%t</dt>
<dd>Temporary filename: testscript.test_filename.tmp, where
test_filename is the name of the test file. All temporary files are
placed in the Output directory within the directory the test is
<dd>Path to a script that performs grep -C. Use this since not all
platforms support grep -C.</dd>
-<dt>%llvmgcc</dt> <dd>Full path to the llvmgcc executable.</dd>
-<dt>%llvmgxx</dt> <dd>Full path to the llvmg++ executable.</dd>
-</ul>
+<dt>%llvmgcc</dt> <dd>Full path to the llvm-gcc executable.</dd>
+<dt>%llvmgxx</dt> <dd>Full path to the llvm-g++ executable.</dd>
+</dl>
<p>There are also several scripts in the llvm/test/Scripts directory
that you might find useful when writing <tt>RUN</tt> lines.</p>
</div>
-<!--=========================================================================-->
-<div class="doc_section"><a name="qmstructure">QMTest Structure</a></div>
-<!--=========================================================================-->
-
-<div class="doc_text">
-
-<p>The Feature and Regression tests can also be run using QMTest.</p>
-
-<p>The QMTest system needs to have several pieces of information available;
-these pieces of configuration information are known collectively as the
-"context" in QMTest parlance. Since the context for LLVM is relatively large,
-the master Makefile in llvm/test sets it for you.</p>
-
-<p>The LLVM database class makes the subdirectories of llvm/test a QMTest test
-database. For each directory that contains tests driven by QMTest, it knows
-what type of test the source file is and how to run it.</p>
-
-<p>Hence, the QMTest namespace is essentially what you see in the Feature and
-Regression directories, but there is some magic that the database class performs
-(as described below).</p>
-
-<p>The QMTest namespace is currently composed of the following tests and test
-suites:</p>
-
-<ul>
-<li>Feature
-
-<p>These are the feature tests found in the Feature directory.
-They are broken up into the following categories:</p>
-
-<ul>
- <li>ad
- <p>Assembler/Disassembler tests. These tests verify that a piece of LLVM
- assembly language can be assembled into bytecode and then disassembled
- into the original assembly language code. It does this several times to
- ensure that assembled output can be disassembled and disassembler output
- can be assembled. It also verifies that the give assembly language file
- can be assembled correctly.</p></li>
-
- <li>opt
- <p>Optimizer tests. These tests verify that two of the optimizer passes
- completely optimize a program (i.e. after a single pass, they cannot
- optimize a program any further).</p></li>
-
- <li>mc
- <p> Machine code tests. These tests verify that the LLVM assembly
- language file can be translated into native assembly code.</p></li>
-
- <li>cc
- <p>C code tests. These tests verify that the specified LLVM assembly
- code can be converted into C source code using the C backend.</p></li>
-</ul>
-
-<p>The LLVM database class looks at every file in the Feature directory and
-creates a fake test hierarchy containing
-<tt>Feature.<testtype>.<testname></tt>. So, if you add an LLVM
-assembly language file to the Feature directory, it actually creates 5 new
-tests: assembler/disassembler, assembler, optimizer, machine code, and C code.
-</p></li>
-
-<li>Regression
- <p>These are the regression tests. There is one suite for each
- subdirectory of the Regression directory. If you add a new subdirectory
- there, you will need to modify, at least, the <tt>RegressionMap</tt>
- variable in <tt>QMTest/llvmdb.py</tt> so that QMTest knows how to run the
- tests in the new subdirectory.</p>
-</li>
-
-</ul>
-
-</div>
-
<!--=========================================================================-->
<div class="doc_section"><a name="progstructure"><tt>llvm-test</tt>
Structure</a></div>
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>
-
+
+<p>Note, when configuring the <tt>llvm-test</tt> module, you might want to
+specify the following configuration options:</p>
+<dl>
+ <dt><i>--enable-spec2000</i>
+ <dt><i>--enable-spec2000=<<tt>directory</tt>></i>
+ <dd>
+ Enable the use of SPEC2000 when testing LLVM. This is disabled by default
+ (unless <tt>configure</tt> finds SPEC2000 installed). By specifying
+ <tt>directory</tt>, you can tell configure where to find the SPEC2000
+ benchmarks. If <tt>directory</tt> is left unspecified, <tt>configure</tt>
+ uses the default value
+ <tt>/home/vadve/shared/benchmarks/speccpu2000/benchspec</tt>.
+ <p>
+ <dt><i>--enable-spec95</i>
+ <dt><i>--enable-spec95=<<tt>directory</tt>></i>
+ <dd>
+ Enable the use of SPEC95 when testing LLVM. It is similar to the
+ <i>--enable-spec2000</i> option.
+ <p>
+ <dt><i>--enable-povray</i>
+ <dt><i>--enable-povray=<<tt>directory</tt>></i>
+ <dd>
+ Enable the use of Povray as an external test. Versions of Povray written
+ in C should work. This option is similar to the <i>--enable-spec2000</i>
+ option.
+</dl>
</div>
<!--=========================================================================-->
<i>are not</i> executed inside of the LLVM source tree. This is because the
test suite creates temporary files during execution.</p>
-<p>The master Makefile in llvm/test is capable of running only the QMTest driven
+<p>The master Makefile in llvm/test is capable of running only the DejaGNU driven
tests. By default, it will run all of these tests.</p>
-<p>To run only the QMTest driven tests, run <tt>gmake qmtest</tt> at the
-command line in llvm/tests. To run a specific qmtest, suffix the test name with
-".t" when running gmake.</p>
+<p>To run only the DejaGNU driven tests, run <tt>gmake</tt> at the
+command line in llvm/tests. To run a specific directory of tests, use the
+TESTSUITE variable.
+</p>
-<p>For example, to run the Regression.LLC tests, type
-<tt>gmake Regression.LLC.t</tt> in <tt>llvm/tests</tt>.</p>
+<p>For example, to run the Regression tests, type
+<tt>gmake TESTSUITE=Regression</tt> in <tt>llvm/tests</tt>.</p>
<p>Note that there are no Makefiles in <tt>llvm/test/Features</tt> and
-<tt>llvm/test/Regression</tt>. You must use QMTest from the <tt>llvm/test</tt>
+<tt>llvm/test/Regression</tt>. You must use DejaGNU from the <tt>llvm/test</tt>
directory to run them.</p>
<p>To run the <tt>llvm-test</tt> suite, you need to use the following steps:
choose.</p>
<p>Some tests are known to fail. Some are bugs that we have not fixed yet;
-others are features that we haven't added yet (or may never add). In QMTest,
+others are features that we haven't added yet (or may never add). In DejaGNU,
the result for such tests will be XFAIL (eXpected FAILure). In this way, you
can tell the difference between an expected and unexpected failure.</p>
and then delete the checked out tree. This tester is designed to ensure that
programs don't break as well as keep track of LLVM's progress over time.</p>
-<p>
-If you'd like to set up an instance of the nightly tester to run on your
-machine, take a look at the comments at the top of the utils/NightlyTester.pl
-file. We usually run it from a crontab entry that looks ilke this:
-</p>
+<p>If you'd like to set up an instance of the nightly tester to run on your
+machine, take a look at the comments at the top of the
+<tt>utils/NightlyTester.pl</tt> file. We usually run it from a crontab entry
+that looks ilke this:</p>
+<div class="doc_code">
<pre>
-5 3 * * * LLVM_LIB_SEARCH_PATH=.../llvm-gcc/bytecode-libs $HOME/llvm/utils/NightlyTest.pl -parallel -enable-linscan ...CVSREPOSTRING... $HOME/buildtest-X86 $HOME/cvs/testresults-X86
+5 3 * * * $HOME/llvm/utils/NightlyTest.pl -parallel $CVSROOT $HOME/buildtest-X86 $HOME/cvs/testresults-X86
</pre>
+</div>
<p>Or, you can create a shell script to encapsulate the running of the script.
-The optimized x86 Linux nightly test is run from just such a script:
+The optimized x86 Linux nightly test is run from just such a script:</p>
+
+<div class="doc_code">
<pre>
#!/bin/bash
BASE=/proj/work/llvm/nightlytest
export LLVMGCCDIR=/proj/work/llvm/cfrontend/install
export PATH=/proj/install/bin:$LLVMGCCDIR/bin:$PATH
export LD_LIBRARY_PATH=/proj/install/lib
-export LLVM_LIB_SEARCH_PATH=/proj/work/llvm/cfrontend/install/bytecode-libs
cd $BASE
cp /proj/work/llvm/llvm/utils/NightlyTest.pl .
-nice ./NightlyTest.pl -nice -release -verbose -parallel -enable-linscan -noexternals
+nice ./NightlyTest.pl -nice -release -verbose -parallel -enable-linscan -noexternals 2>&1 > output.log
+mail -s 'X86 nightly tester results' <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-testresults">llvm-testresults@cs.uiuc.edu</a> < output.log
</pre>
+</div>
+
+<p>Take a look at the <tt>NightlyTest.pl</tt> file to see what all of the flags
+and strings do. If you start running the nightly tests, please let us know and
+we'll link your page to the global tester page. Thanks!</p>
-<p>
-Take a look at the NightlyTest.pl file to see what all of the flags and
-strings do. If you start running the nightly tests, please let us know and
-we'll link your page to the global tester page. Thanks!
-</p>
-
</div>
<!-- *********************************************************************** -->