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. 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 @@ -289,7 +324,9 @@ location of these external programs is configured by the llvm-test
In order for DejaGNU to work, each directory of tests must have a dg.exp file. DejaGNU looks for this file to determine how to run the tests. This file is just a Tcl script and it can do anything you want, but - we've standardized it for the LLVM regression tests. It simply loads a Tcl + we've standardized it for the LLVM regression tests. If you're adding a + directory of tests, just copy dg.exp from another directory to get + running. The standard dg.exp simply loads a Tcl library (test/lib/llvm.exp) and calls the llvm_runtests function defined in that library with a list of file names to run. The names are obtained by using Tcl's glob command. Any directory that contains only @@ -318,17 +355,20 @@ location of these external programs is configured by the llvm-test line to be concatenated with the next one. In this way you can build up long pipelines of commands without making huge line lengths. The lines ending in \ are concatenated until a RUN line that doesn't end in \ is - found. This concatenated set or RUN lines then constitutes one execution. + found. This concatenated set of RUN lines then constitutes one execution. Tcl will substitute variables and arrange for the pipeline to be executed. If any process in the pipeline fails, the entire line (and test case) fails too.
Below is an example of legal RUN lines in a .ll file:
-- ; RUN: llvm-as < %s | llvm-dis > %t1 - ; RUN: llvm-dis < %s.bc-13 > %t2 - ; RUN: diff %t1 %t2 -+ +
+; RUN: llvm-as < %s | llvm-dis > %t1 +; RUN: llvm-dis < %s.bc-13 > %t2 +; RUN: diff %t1 %t2 ++
As with a Unix shell, the RUN: lines permit pipelines and I/O redirection to be used. However, the usage is slightly different than for Bash. To check @@ -351,48 +391,72 @@ location of these external programs is configured by the llvm-test
There are some quoting rules that you must pay attention to when writing your RUN lines. In general nothing needs to be quoted. Tcl won't strip off any ' or " so they will get passed to the invoked program. For example:
-- ... | grep 'find this string' -+ +
+... | grep 'find this string' ++
This will fail because the ' characters are passed to grep. This would instruction grep to look for 'find in the files this and string'. To avoid this use curly braces to tell Tcl that it should treat everything enclosed as one value. So our example would become:
-
- ... | grep {find this string}
-
+
+
+... | grep {find this string}
+
+Additionally, the characters [ and ] are treated specially by Tcl. They tell Tcl to interpret the content as a command to execute. Since these characters are often used in regular expressions this can have disastrous results and cause the entire test run in a directory to fail. For example, a common idiom is to look for some basicblock number:
-- ... | grep bb[2-8] -+ +
+... | grep bb[2-8] ++
This, however, will cause Tcl to fail because its going to try to execute a program named "2-8". Instead, what you want is this:
-
- ... | grep {bb\[2-8\]}
-
+
+
+... | grep {bb\[2-8\]}
+
+Finally, if you need to pass the \ character down to a program, then it must be doubled. This is another Tcl special character. So, suppose you had: -
- ... | grep 'i32\*' -+ +
+... | grep 'i32\*' ++
This will fail to match what you want (a pointer to i32). First, the ' do not get stripped off. Second, the \ gets stripped off by Tcl so what grep sees is: 'i32*'. That's not likely to match anything. To resolve this you must use \\ and the {}, like this:
-
- ... | grep {i32\\*}
-
+
+... | grep {i32\\*}
+
With a RUN line there are a number of substitutions that are permitted. In general, any Tcl variable that is available in the substitute @@ -402,38 +466,49 @@ location of these external programs is configured by the llvm-test library, certain names can be accessed with an alternate syntax: a % prefix. These alternates are deprecated and may go away in a future version.
- Here are the available variable names. The alternate syntax is listed in +Here are the available variable names. The alternate syntax is listed in parentheses.
+- $test (%s)
- The full path to the test case's source. This is suitable for passing on the command line as the input to an llvm tool. +
- $srcdir
- The source directory from where the "make check" was run. +
- objdir -
- The object directory that corresponds to the $srcdir. +
- The object directory that corresponds to the $srcdir. +
- subdir
- A partial path from the test directory that contains the sub-directory that contains the test source being executed. +
- srcroot
- The root directory of the LLVM src tree. +
- objroot
- The root directory of the LLVM object tree. This could be the same as the srcroot. +
- path
- The path to the directory that contains the test case source. This is for locating any supporting files that are not generated by the test, but used by the test. +
- tmp
- The path to a temporary file name that could be used for this test case. The file name won't conflict with other test cases. You can append to it if you need multiple temporaries. This is useful as the destination of some redirected output. +
- llvmlibsdir (%llvmlibsdir)
- The directory where the LLVM libraries are located. +
- target_triplet (%target_triplet)
- The target triplet that corresponds to the current host machine (the one
running the test cases). This should probably be called "host".
- +
- prcontext (%prcontext)
- Path to the prcontext tcl script that prints some context around a line that matches a pattern. This isn't strictly necessary as the test suite @@ -441,31 +516,41 @@ location of these external programs is configured by the llvm-test the prcontext script is located. Note that this script is similar to grep -C but you should use the prcontext script because not all platforms support grep -C. +
- llvmgcc (%llvmgcc)
- The full path to the llvm-gcc executable as specified in the configured LLVM environment +
- llvmgxx (%llvmgxx)
- The full path to the llvm-gxx executable as specified in the configured LLVM environment +
- llvmgcc_version (%llvmgcc_version)
- The full version number of the llvm-gcc executable. +
- llvmgccmajvers (%llvmgccmajvers)
- The major version number of the llvm-gcc executable. +
- gccpath
- The full path to the C compiler used to build LLVM. Note that this might not be gcc. +
- gxxpath
- The full path to the C++ compiler used to build LLVM. Note that this might not be g++. +
- compile_c (%compile_c)
- The full command line used to compile LLVM C source code. This has all the configured -I, -D and optimization options. +
- compile_cxx (%compile_cxx)
- The full command used to compile LLVM C++ source code. This has all the configured -I, -D and optimization options. +
- link (%link)
- This full link command used to link LLVM executables. This has all the configured -I, -L and -l options. +
- shlibext (%shlibext)
- The suffix for the host platforms share library (dll) files. This includes the period as the first character. @@ -480,9 +565,12 @@ location of these external programs is configured by the llvm-test +
- ignore
- This script runs its arguments and then always returns 0. This is useful @@ -491,6 +579,7 @@ location of these external programs is configured by the llvm-test non-zero result will cause the test to fail. This script overcomes that issue and nicely documents that the test case is purposefully ignoring the result code of the tool +
- not
- This script runs its arguments and then inverts the result code from
it. Zero result codes become 1. Non-zero result codes become 0. This is
@@ -511,14 +600,17 @@ location of these external programs is configured by the llvm-test
succeed. To XFAIL everywhere just specify XFAIL: *. When matching
the llvm-gcc version, you can specify the major (e.g. 3) or full version
(i.e. 3.4) number. Here is an example of an XFAIL line:
-
- ; XFAIL: darwin,sun,llvmgcc4 -
+ +++; XFAIL: darwin,sun,llvmgcc4 +
+To make the output more useful, the llvm_runtest function wil scan the lines of the test case for ones that contain a pattern that matches PR[0-9]+. This is the syntax for specifying a PR (Problem Report) number that - is related to the test case. The numer after "PR" specifies the LLVM bugzilla + is related to the test case. The number after "PR" specifies the LLVM bugzilla number. When a PR number is specified, it will be used in the pass/fail reporting. This is useful to quickly get some context when a test fails.
@@ -532,34 +624,124 @@ location of these external programs is configured by the llvm-test - llvm-test/SingleSource
+
The SingleSource directory contains test programs that are only a single +source file in size. These are usually small benchmark programs or small +programs that calculate a particular value. Several such programs are grouped +together in each directory.
+
+ - llvm-test/MultiSource
+
The MultiSource directory contains subdirectories which contain entire +programs with multiple source files. Large benchmarks and whole applications +go here.
+
+ - llvm-test/External
+
The External directory contains Makefiles for building code that is external +to (i.e., not distributed with) LLVM. The most prominent members of this +directory are the SPEC 95 and SPEC 2000 benchmark suites. The External +directory does not contain these actual tests,but only the Makefiles that know +how to properly compile these programs from somewhere else. The presence and +location of these external programs is configured by the llvm-test +configure script.
+ - cd into the llvm/projects directory + +
Check out the test-suite module with:
+ +++ ++% svn co http://llvm.org/svn/llvm-project/test-suite/trunk llvm-test +
+This will get the test suite into llvm/projects/llvm-test
+Configure the test suite using llvm configure. This will automatically configure llvm-test. + You must do it from the top level otherwise llvm-gcc will not be set which is required to + run llvm-test:
++++% cd $LLVM_OBJ_ROOT ; $LLVM_SRC_ROOT/configure --with-llvmgccdir=$LLVM_GCC_DIR +
+Note that that $LLVM_GCC_DIR is the directory where you + installed llvm-gcc, not its src or obj directory.
+
+
+ Change back to the llvm/projects/llvm-test directory you created before + and run gmake (or just "make" on systems where GNU make is + the default, such as linux.
+- --enable-spec95
- --enable-spec95=<directory>
-
Enable the use of SPEC95 when testing LLVM. It is similar to the
--enable-spec2000 option.
+
- --enable-povray
- --enable-povray=<directory>
- @@ -588,80 +772,58 @@ specify the following configuration options:
- cd into the llvm/projects directory -
- check out the test-suite module with:
- svn co http://llvm.org/svn/llvm-project/test-suite/trunk llvm-test
- This will get the test suite into llvm/projects/llvm-test
- - configure the test suite. You can do this one of two ways:
-
-
-
- Use the regular llvm configure:
- cd $LLVM_OBJ_ROOT ; $LLVM_SRC_ROOT/configure
- This will ensure that the projects/llvm-test directory is also - properly configured.
- - Use the configure script found in the llvm-test source
- directory:
- $LLVM_SRC_ROOT/projects/llvm-test/configure - --with-llvmsrc=$LLVM_SRC_ROOT --with-llvmobj=$LLVM_OBJ_ROOT -
-
- Use the regular llvm configure:
- gmake -
To make RUN line writing easier, there are several shell scripts located - in the llvm/test/Scripts directory. For example:
+ in the llvm/test/Scripts directory. This directory is in the PATH + when running tests, so you can just call these scripts using their name. For + example:As mentioned previously, the llvm-test module provides three types -of tests: MultiSource, SingleSource, and External. Each tree is then subdivided -into several categories, including applications, benchmarks, regression tests, -code that is strange grammatically, etc. These organizations should be -relatively self explanatory.
+The test-suite module contains a number of programs that can be compiled +with LLVM and executed. These programs are compiled using the native compiler +and various LLVM backends. The output from the program compiled with the +native compiler is assumed correct; the results from the other programs are +compared to the native program output and pass if they match.
-In addition to the regular "whole program" tests, the llvm-test -module also provides a mechanism for compiling the programs in different ways. -If the variable TEST is defined on the gmake command line, the test system will -include a Makefile named TEST.<value of TEST variable>.Makefile. -This Makefile can modify build rules to yield different results.
+When executing tests, it is usually a good idea to start out with a subset of +the available tests or programs. This makes test run times smaller at first and +later on this is useful to investigate individual test failures. To run some +test only on a subset of programs, simply change directory to the programs you +want tested and run gmake there. Alternatively, you can run a different +test using the TEST variable to change what tests or run on the +selected programs (see below for more info).
-For example, the LLVM nightly tester uses TEST.nightly.Makefile to -create the nightly test reports. To run the nightly tests, run gmake -TEST=nightly.
+In addition for testing correctness, the llvm-test directory also +performs timing tests of various LLVM optimizations. It also records +compilation times for the compilers and the JIT. This information can be +used to compare the effectiveness of LLVM's optimizations and code +generation.
-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.
+llvm-test tests are divided into three types of tests: MultiSource, +SingleSource, and External.
+ +-
+
Each tree is then subdivided into several categories, including applications, +benchmarks, regression tests, code that is strange grammatically, etc. These +organizations should be relatively self explanatory.
+ +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 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 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.
+ +First, all tests are executed within the LLVM object directory tree. They +are not executed inside of the LLVM source tree. This is because the +test suite creates temporary files during execution.
+ +To run the llvm-test suite, you need to use the following steps:
+ +-
+
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).
+ + + + + +Note, when configuring the llvm-test module, you might want to specify the following configuration options:
-
@@ -573,12 +755,14 @@ specify the following configuration options:
uses the default value
/home/vadve/shared/benchmarks/speccpu2000/benchspec.
+
In addition to the regular "whole program" tests, the llvm-test +module also provides a mechanism for compiling the programs in different ways. +If the variable TEST is defined on the gmake command line, the test system will +include a Makefile named TEST.<value of TEST variable>.Makefile. +This Makefile can modify build rules to yield different results.
-First, all tests are executed within the LLVM object directory tree. They -are not executed inside of the LLVM source tree. This is because the -test suite creates temporary files during execution.
- -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 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 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 DejaGNU from the llvm/test -directory to run them.
- -To run the llvm-test suite, you need to use the following steps: -
--
-
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).
- -To make a specialized test (use one of the
-llvm-test/TEST.<type>.Makefiles), just run:
-gmake TEST=<type> test
For example, you could run the
-nightly tester tests using the following commands:
- % cd llvm/projects/llvm-test - % gmake TEST=nightly test -- -
Regardless of which test you're running, the results are printed on standard -output and standard error. You can redirect these results to a file if you -choose.
+For example, the LLVM nightly tester uses TEST.nightly.Makefile to +create the nightly test reports. To run the nightly tests, run gmake +TEST=nightly.
-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 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.
+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.
-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.
+There are a number of ways to run the tests and generate output. The most + simple one is simply running gmake 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 explicitely.
+ +Somewhat better is running gmake TEST=sometest test, which runs + the specified test and usually adds per-program summaries to the output + (depending on which sometest you use). For example, the nightly test + explicitely 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.
+ +Even better are the report and report.format targets + (where format is one of html, csv, text or + graphs). The exact contents of the report are dependent on which + TEST you are running, but the text results are always shown at the + end of the run and the results are always stored in the + report.<type>.format file (when running with + TEST=<type>). + + The report also generate a file called + report.<type>.raw.out containing the output of the entire test + run.
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, +program test (described above), run all of the DejaGNU tests, delete the checked out tree, and then submit the results to http://llvm.org/nightlytest/. After test results are submitted to @@ -803,10 +965,10 @@ know. Thanks!
- The LLVM Compiler Infrastructure
+ The LLVM Compiler Infrastructure
Last modified: $Date$