The LLVM test suite contains two major categories of tests: code +fragments and whole programs. Code fragments are in the llvm module +under the llvm/test directory. The whole programs +test suite is in the llvm-test module under the main directory.
+ +Code fragments are small pieces of code that test a specific feature of LLVM +or trigger a specific bug in LLVM. They are usually written in LLVM assembly +language, but can be written in other languages if the test targets a particular +language front end. These tests are driven by the DejaGNU testing framework, +which is hidden behind a few simple makefiles.
+ +These code fragments are not complete programs. The code generated from them is +never executed to determine correct behavior.
+ +These code fragment tests are located in the llvm/test +directory.
+ +Typically when a bug is found in LLVM, a regression test containing +just enough code to reproduce the problem should be written and placed +somewhere underneath this directory. In most cases, this will be a small +piece of LLVM assembly language code, often distilled from an actual +application or benchmark.
+ +The llvm-test suite contains whole programs, which are pieces of +code which can be compiled and linked into a stand-alone program that can be +executed. These programs are generally written in high level languages such as +C or C++, but sometimes they are written straight in LLVM assembly.
+ +These programs are compiled and then executed using several different +methods (native compiler, LLVM C backend, LLVM JIT, LLVM native code generation, +etc). The output of these programs is compared to ensure that LLVM is compiling +the program correctly.
+ +In addition to compiling and executing programs, whole program tests serve as +a way of benchmarking LLVM performance, both in terms of the efficiency of the +programs generated as well as the speed with which LLVM compiles, optimizes, and +generates code.
+ +All "whole program" tests are located in the test-suite Subversion +module.
+ +The tests are located in two separate Subversion modules. The basic feature - and regression tests are in the main "llvm" module under the directory - llvm/test. A more comprehensive test suite that includes whole +
The tests are located in two separate Subversion modules. The code fragment + DejaGNU tests are in the main "llvm" module under the directory + llvm/test (so you get these tests for free with the main llvm tree). + The more comprehensive llvm-test suite that includes whole programs in C and C++ is in the test-suite module. This module should -be checked out to the llvm/projects directory as llvm-test (for -historical purpose). When you configure the llvm module, +be checked out to the llvm/projects directory as llvm-test (don't use +another name, for then the test suite will be run every time you run +make in the main llvm directory). +When you configure the llvm module, the llvm-test directory will be automatically configured. Alternatively, you can configure the test-suite module manually.
+ + + +To run all of the simple tests in LLVM using DejaGNU, use the master Makefile in the llvm/test directory:
@@ -137,7 +224,7 @@ subdirectory (relative to llvm/test):-% gmake -C llvm/test TESTSUITE=Regression/Transforms +% gmake TESTSUITE=Transforms check
To run only a single test, set TESTONE to its path (relative to +llvm/test) and make the check-one target:
+ ++% gmake TESTONE=Feature/basictest.ll check-one ++
To run the comprehensive test suite (tests that compile and execute whole -programs), run the llvm-test tests:
+programs), first checkout and setup the test-suite module:@@ -154,88 +254,49 @@ programs), run the llvm-test tests: % svn co http://llvm.org/svn/llvm-project/test-suite/trunk llvm-test % cd .. % ./configure --with-llvmgccdir=$LLVM_GCC_DIR -% cd projects/llvm-test -% gmake
where $LLVM_GCC_DIR is the directory where you installed llvm-gcc, not it's src or obj dir.
Then, run the entire test suite by running make in the llvm-test +directory:
+ ++% cd projects/llvm-test +% gmake +
The LLVM test suite contains two major categories of tests: code -fragments and whole programs. Code fragments are in the llvm module -under the llvm/test directory. The whole programs -test suite is in the llvm-test module under the main directory.
+Usually, running the "nightly" set of tests is a good idea, and you can also +let it generate a report by running:
++% cd projects/llvm-test +% gmake TEST=nightly report report.html +
Code fragments are small pieces of code that test a specific feature of LLVM -or trigger a specific bug in LLVM. They are usually written in LLVM assembly -language, but can be written in other languages if the test targets a particular -language front end.
- -Code fragments are not complete programs, and they are never executed to -determine correct behavior.
- -These code fragment tests are located in the llvm/test/Features and -llvm/test/Regression directories.
- -Whole Programs are pieces of code which can be compiled and linked into a -stand-alone program that can be executed. These programs are generally written -in high level languages such as C or C++, but sometimes they are written -straight in LLVM assembly.
- -These programs are compiled and then executed using several different -methods (native compiler, LLVM C backend, LLVM JIT, LLVM native code generation, -etc). The output of these programs is compared to ensure that LLVM is compiling -the program correctly.
- -In addition to compiling and executing programs, whole program tests serve as -a way of benchmarking LLVM performance, both in terms of the efficiency of the -programs generated as well as the speed with which LLVM compiles, optimizes, and -generates code.
- -All "whole program" tests are located in the test-suite Subversion -module.
+Any of the above commands can also be run in a subdirectory of +projects/llvm-test to run the specified test only on the programs in +that subdirectory.
The LLVM DejaGNU tests are driven by DejaGNU together with GNU Make and are + located in the llvm/test directory. -
Each type of test in the LLVM test suite has its own directory. The major -subtrees of the test suite directory tree are as follows:
- -This directory contains a large array of small tests that exercise various features of LLVM and to ensure that regressions do not occur. The directory is broken into several sub-directories, each focused on a particular area of LLVM. A few of the important ones are:
+Typically when a bug is found in LLVM, a regression test containing - just enough code to reproduce the problem should be written and placed - somewhere underneath this directory. In most cases, this will be a small - piece of LLVM assembly language code, often distilled from an actual - application or benchmark.
- -The test-suite module contains 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 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.
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.
The MultiSource directory contains subdirectories which contain entire -programs with multiple source files. Large benchmarks and whole applications -go here.
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 presence and -location of these external programs is configured by the llvm-test -configure script.
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 @@ -305,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 @@ -334,7 +355,7 @@ 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.
@@ -434,7 +455,8 @@ location of these external programs is configured by the llvm-testWith a RUN line there are a number of substitutions that are permitted. In general, any Tcl variable that is available in the substitute @@ -543,9 +565,12 @@ location of these external programs is configured by the llvm-test
+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: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.
@@ -599,66 +624,75 @@ location of these external programs is configured by the llvm-testAs 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.
-Note, when configuring the llvm-test module, you might want to -specify the following configuration options:
-+
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.
+
The MultiSource directory contains subdirectories which contain entire +programs with multiple source files. Large benchmarks and whole applications +go here.
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.
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.
-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:
To make a specialized test (use one of the -llvm-test/TEST.<type>.Makefiles), just run:
+ + + --% cd llvm/projects/llvm-test -% gmake TEST=<type> test -+
Note, when configuring the llvm-test module, you might want to +specify the following configuration options:
++ +
+ +
For example, you could run the nightly tester tests using the following -commands:
+ + + +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.
+ +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.
+ +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.
--% 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.
+ + + +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.
-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.
+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.
-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.
+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