X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=docs%2FTestingGuide.html;h=3be9279673d6764c95060f551bddfc40ae098d02;hb=6fc205fc446050a434e49e7cfcac89bb5d4435b1;hp=e57c39e200bb311cbf77449f275db04f43605e5a;hpb=3281ead31444ccabb5d638effc3946b11d555f2f;p=oota-llvm.git diff --git a/docs/TestingGuide.html b/docs/TestingGuide.html index e57c39e200b..3be9279673d 100644 --- a/docs/TestingGuide.html +++ b/docs/TestingGuide.html @@ -23,7 +23,6 @@
Darwin (Mac OS X) developers can simplify the installation of Expect and tcl +by using fink. fink install expect will install both. Alternatively, +Darwinports users can use sudo port install expect to install Expect +and tcl.
+ @@ -113,7 +108,7 @@ regression tests are in the main "llvm" module under the directory programs in C and C++ is in the llvm-test module. This module should be checked out to the llvm/projects directory. When you configure the llvm module, the llvm-test module -will be automatically configured. Or you can do it manually. +will be automatically configured. Alternatively, you can configure the llvm-test module manually.To run all of the simple tests in LLVM using DejaGNU, use the master Makefile in the llvm/test directory:
@@ -123,29 +118,17 @@ or
% gmake check-To run only a subdirectory of tests in llvm/test using DejaGNU (ie. Regression/Transforms). Just substitute the path to the subdirectory:
--% gmake -C llvm/test TESTSUITE=Regression/Transforms --
To run the simple tests (i.e. those that do basic testing of -LLVM), using QMTest:
+To run only a subdirectory of tests in llvm/test using DejaGNU (ie. +Regression/Transforms), just set the TESTSUITE variable to the path of the +subdirectory (relative to llvm/test):
-% gmake -C llvm/test qmtest -- -
To run only the basic feature tests, QMTest supports the following -target:
--% gmake -C llvm/test Feature.t +% gmake -C llvm/test TESTSUITE=Regression/Transforms-
To run only the regression tests, QMTest supports the following -target:
--% gmake -C llvm/test Regression.t -+
Note: If you are running the tests with objdir != subdir, you +must have run the complete testsuite before you can specify a +subdirectory.
To run the comprehensive test suite (tests that compile and execute whole programs), run the llvm-test tests:
@@ -168,8 +151,8 @@ programs), run the llvm-test tests:The LLVM test suite contains two major categories of tests: code fragments and whole programs. Code fragments are in the llvm module -under the directory under the llvm/test directory. The whole programs -test suite are n the llvm-test module under the main directory.
+under the llvm/test directory. The whole programs +test suite is in the llvm-test module under the main directory. @@ -270,11 +253,6 @@ directory are the SPEC 95 and SPEC 2000 benchmark suites. The presence and location of these external programs is configured by the llvm-test configure script. -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.
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 llvm-test module is currently driven by a set of Makefiles.
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, site.exp in llvm/test. The llvm/test +information to be set. This information is gathered via configure and +is written to a file, site.exp in llvm/test. The +llvm/test Makefile does this work for you.
In order for DejaGNU to work, each directory of tests must have a @@ -317,7 +296,8 @@ file:
There are a couple patterns within a RUN line that the llvm-runtest procedure looks for and replaces with the appropriate syntax:
-There are also several scripts in the llvm/test/Scripts directory that you might find useful when writing RUN lines.
Lastly, you can easily mark a test that is expected to fail on a -specific platform by using the XFAIL keyword. Xfail lines are +specific platform or with a specific version of llvmgcc by using the XFAIL keyword. Xfail lines are specified in the comments of the test program using XFAIL, followed by a colon, and one or more regular expressions (separated by -a comma) that will match against the target triplet for the -machine. You can use * to match all targets. Here is an example of an +a comma) that will match against the target triplet or llvmgcc version for the +machine. You can use * to match all targets. You can specify the major or full version (i.e. 3.4) for llvmgcc. Here is an example of an XFAIL line:
-; XFAIL: darwin,sun +; XFAIL: darwin,sun,llvmgcc4
The Feature and Regression tests can also be run using QMTest.
- -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.
- -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.
- -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).
- -The QMTest namespace is currently composed of the following tests and test -suites:
- -These are the feature tests found in the Feature directory. -They are broken up into the following categories:
- -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.
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).
Machine code tests. These tests verify that the LLVM assembly - language file can be translated into native assembly code.
C code tests. These tests verify that the specified LLVM assembly - code can be converted into C source code using the C backend.
The LLVM database class looks at every file in the Feature directory and -creates a fake test hierarchy containing -Feature.<testtype>.<testname>. 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. -
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 RegressionMap - variable in QMTest/llvmdb.py so that QMTest knows how to run the - tests in the new subdirectory.
-The master Makefile in llvm/test is capable of running only the QMTest driven +
The master Makefile in llvm/test is capable of running only the DejaGNU driven tests. By default, it will run all of these tests.
-To run only the QMTest driven tests, run gmake qmtest at the -command line in llvm/tests. To run a specific qmtest, suffix the test name with -".t" when running gmake.
+To run only the DejaGNU driven tests, run gmake at the +command line in llvm/test. To run a specific directory of tests, use +the TESTSUITE variable. +
-For example, to run the Regression.LLC tests, type -gmake Regression.LLC.t in llvm/tests.
+For example, to run the Regression tests, type +gmake TESTSUITE=Regression in llvm/tests.
Note that there are no Makefiles in llvm/test/Features and -llvm/test/Regression. You must use QMTest from the llvm/test +llvm/test/Regression. You must use DejaGNU from the llvm/test directory to run them.
To run the llvm-test suite, you need to use the following steps: @@ -513,7 +422,7 @@ directory to run them.
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.
-The tests in llvm-test have no such feature as of this time. If the +
The tests in llvm-test have no such feature at this time. If the test passes, only warnings and other miscellaneous output will be generated. If a test fails, a large <program> FAILED message will be displayed. This will help you separate benign warnings from actual test failures.
@@ -565,45 +474,47 @@ will help you separate benign warnings from actual test failures.-The LLVM Nightly Testers +The LLVM Nightly Testers automatically check out an LLVM tree, build it, run the "nightly" program test (described above), run all of the feature and regression tests, 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.
--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: -
+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:
+-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+
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:
+ +#!/bin/bash BASE=/proj/work/llvm/nightlytest -export CVSROOT=:pserver:anon@llvm.cs.uiuc.edu:/var/cvs/llvm +export CVSROOT=:pserver:anon@llvm.org:/var/cvs/llvm export BUILDDIR=$BASE/build export WEBDIR=$BASE/testresults 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' llvm-testresults@cs.uiuc.edu < output.log+
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!
--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! -
-