| blob | b4fa672976d94af5c4763fb06d09ad982652fce3 |
3 <html>
4 <head>
7 </head>
8 <body>
10 <h1>
11 LLVM Testing Infrastructure Guide
12 </h1>
14 <ol>
18 <ul>
22 </ul>
23 </li>
25 <ul>
29 </ul>
30 </li>
32 <ul>
37 </ul>
38 </li>
41 <ul>
46 </ul>
47 </li>
48 </ol>
52 </div>
54 <!--=========================================================================-->
56 <!--=========================================================================-->
58 <div>
60 <p>This document is the reference manual for the LLVM testing infrastructure. It
61 documents the structure of the LLVM testing infrastructure, the tools needed to
62 use it, and how to add and run tests.</p>
64 </div>
66 <!--=========================================================================-->
68 <!--=========================================================================-->
70 <div>
72 <p>In order to use the LLVM testing infrastructure, you will need all of the
73 software required to build LLVM, as well
76 </div>
78 <!--=========================================================================-->
80 <!--=========================================================================-->
82 <div>
84 <p>The LLVM testing infrastructure contains two major categories of tests:
85 regression tests and whole programs. The regression tests are contained inside
87 pass -- they should be run before every commit. The whole programs tests are
89 in subversion.
90 </p>
92 <!-- _______________________________________________________________________ -->
94 <!-- _______________________________________________________________________ -->
96 <div>
98 <p>The regression tests are small pieces of code that test a specific feature of
99 LLVM or trigger a specific bug in LLVM. They are usually written in LLVM
100 assembly language, but can be written in other languages if the test targets a
103 tests are driven by the 'lit' testing tool, which is part of LLVM.</p>
105 <p>These code fragments are not complete programs. The code generated
106 from them is never executed to determine correct behavior.</p>
109 directory.</p>
111 <p>Typically when a bug is found in LLVM, a regression test containing
112 just enough code to reproduce the problem should be written and placed
113 somewhere underneath this directory. In most cases, this will be a small
114 piece of LLVM assembly language code, often distilled from an actual
115 application or benchmark.</p>
117 </div>
119 <!-- _______________________________________________________________________ -->
121 <!-- _______________________________________________________________________ -->
123 <div>
125 <p>The test suite contains whole programs, which are pieces of
126 code which can be compiled and linked into a stand-alone program that can be
127 executed. These programs are generally written in high level languages such as
128 C or C++, but sometimes they are written straight in LLVM assembly.</p>
130 <p>These programs are compiled and then executed using several different
131 methods (native compiler, LLVM C backend, LLVM JIT, LLVM native code generation,
132 etc). The output of these programs is compared to ensure that LLVM is compiling
133 the program correctly.</p>
135 <p>In addition to compiling and executing programs, whole program tests serve as
136 a way of benchmarking LLVM performance, both in terms of the efficiency of the
137 programs generated as well as the speed with which LLVM compiles, optimizes, and
138 generates code.</p>
142 </div>
144 <!-- _______________________________________________________________________ -->
146 <!-- _______________________________________________________________________ -->
148 <div>
150 <p>The test suite contains tests to check quality of debugging information.
151 The test are written in C based languages or in LLVM assembly language. </p>
153 <p>These tests are compiled and run under a debugger. The debugger output
154 is checked to validate of debugging information. See README.txt in the
155 test suite for more information . This test suite is located in the
158 </div>
160 </div>
162 <!--=========================================================================-->
164 <!--=========================================================================-->
166 <div>
168 <p>The tests are located in two separate Subversion modules. The regressions
169 tests are in the main "llvm" module under the directory
171 The more comprehensive test suite that includes whole
174 than the default "test-suite", for then the test suite will be run every time
180 <!-- _______________________________________________________________________ -->
182 <div>
183 <!-- _______________________________________________________________________ -->
184 <p>To run all of the LLVM regression tests, use master Makefile in
188 <pre>
189 % gmake -C llvm/test
190 </pre>
191 </div>
196 <pre>
197 % gmake check
198 </pre>
199 </div>
202 you can run the LLVM and Clang tests simultaneously using:</p>
207 <pre>
208 % gmake check-all
209 </pre>
210 </div>
212 <p>To run the tests with Valgrind (Memcheck by default), just append
216 <pre>
217 % gmake check VG=1
218 </pre>
219 </div>
221 <p>To run individual tests or subsets of tests, you can use the 'llvm-lit'
222 script which is built as part of LLVM. For example, to run the
223 'Integer/BitCast.ll' test by itself you can run:</p>
226 <pre>
227 % llvm-lit ~/llvm/test/Integer/BitCast.ll
228 </pre>
229 </div>
234 <pre>
235 % llvm-lit ~/llvm/test/CodeGen/ARM
236 </pre>
237 </div>
239 <p>For more information on using the 'lit' tool, see 'llvm-lit --help' or the
240 'lit' man page.</p>
242 </div>
244 <!-- _______________________________________________________________________ -->
246 <!-- _______________________________________________________________________ -->
248 <div>
250 <p>To run the comprehensive test suite (tests that compile and execute whole
254 <pre>
255 % cd llvm/projects
256 % svn co http://llvm.org/svn/llvm-project/test-suite/trunk test-suite
257 % cd ..
258 % ./configure --with-llvmgccdir=$LLVM_GCC_DIR
259 </pre>
260 </div>
268 respectively. If this is not the case,
270 executable's location.</p>
273 directory:</p>
276 <pre>
277 % cd projects/test-suite
278 % gmake
279 </pre>
280 </div>
283 let it generate a report by running:</p>
286 <pre>
287 % cd projects/test-suite
288 % gmake TEST=nightly report report.html
289 </pre>
290 </div>
292 <p>Any of the above commands can also be run in a subdirectory of
294 that subdirectory.</p>
296 </div>
298 <!-- _______________________________________________________________________ -->
300 <div>
301 <!-- _______________________________________________________________________ -->
302 <div>
304 <p> To run debugging information tests simply checkout the tests inside
305 clang/test directory. </p>
308 <pre>
309 %cd clang/test
310 % svn co http://llvm.org/svn/llvm-project/debuginfo-tests/trunk debuginfo-tests
311 </pre>
312 </div>
316 </div>
318 </div>
320 </div>
322 <!--=========================================================================-->
324 <!--=========================================================================-->
325 <div>
326 <p>The LLVM regression tests are driven by 'lit' and are located in
329 <p>This directory contains a large array of small tests
330 that exercise various features of LLVM and to ensure that regressions do not
331 occur. The directory is broken into several sub-directories, each focused on
332 a particular area of LLVM. A few of the important ones are:</p>
334 <ul>
343 transforms to ensure they make the right transformations.</li>
345 </ul>
347 <!-- _______________________________________________________________________ -->
349 <!-- _______________________________________________________________________ -->
350 <div>
351 <p>The regression test structure is very simple, but does require some
355 you.</p>
357 <p>In order for the regression tests to work, each directory of tests must
359 run the tests. This file is just a Tcl script and it can do anything you want,
360 but we've standardized it for the LLVM regression tests. If you're adding a
364 defined in that library with a list of file names to run. The names are
365 obtained by using Tcl's glob command. Any directory that contains only
370 that specify how the test is to be run. So, each test script must contain
371 RUN lines if it is to do anything. If there are no RUN lines, the
373 fail.</p>
375 <p>RUN lines are specified in the comments of the test program using the
377 to execute. Together, these lines form the "script" that
379 RUN lines is similar to a shell's syntax for pipelines including I/O
380 redirection and variable substitution. However, even though these lines
383 shell. Consequently the syntax differs from normal shell script syntax in a
384 few ways. You can specify as many RUN lines as needed.</p>
386 <p>lit performs substitution on each RUN line to replace LLVM tool
387 names with the full paths to the executable built for each tool (in
388 $(LLVM_OBJ_ROOT)/$(BuildMode)/bin). This ensures that lit does not
389 invoke any stray LLVM tools in the user's path during testing.</p>
391 <p>Each RUN line is executed on its own, distinct from other lines unless
393 line to be concatenated with the next one. In this way you can build up long
394 pipelines of commands without making huge line lengths. The lines ending in
396 found. This concatenated set of RUN lines then constitutes one execution.
397 Tcl will substitute variables and arrange for the pipeline to be executed. If
398 any process in the pipeline fails, the entire line (and test case) fails too.
399 </p>
404 <pre>
407 ; RUN: diff %t1 %t2
408 </pre>
409 </div>
411 <p>As with a Unix shell, the RUN: lines permit pipelines and I/O redirection
412 to be used. However, the usage is slightly different than for Bash. To check
413 what's legal, see the documentation for the
415 command and the
417 The major differences are:</p>
418 <ul>
423 <li>You can only redirect to a file, not to another descriptor and not from
424 a here document.</li>
425 <li>tcl supports redirecting to open files with the @ syntax but you
426 shouldn't use that here.</li>
427 </ul>
429 <p>There are some quoting rules that you must pay attention to when writing
430 your RUN lines. In general nothing needs to be quoted. Tcl won't strip off any
431 quote characters so they will get passed to the invoked program. For
432 example:</p>
435 <pre>
436 ... | grep 'find this string'
437 </pre>
438 </div>
440 <p>This will fail because the ' characters are passed to grep. This would
443 treat everything enclosed as one value. So our example would become:</p>
446 <pre>
447 ... | grep {find this string}
448 </pre>
449 </div>
452 specially by Tcl. They tell Tcl to interpret the content as a command to
453 execute. Since these characters are often used in regular expressions this can
454 have disastrous results and cause the entire test run in a directory to fail.
455 For example, a common idiom is to look for some basicblock number:</p>
458 <pre>
460 </pre>
461 </div>
463 <p>This, however, will cause Tcl to fail because its going to try to execute
467 <pre>
469 </pre>
470 </div>
473 then it must be doubled. This is another Tcl special character. So, suppose
474 you had:
477 <pre>
478 ... | grep 'i32\*'
479 </pre>
480 </div>
482 <p>This will fail to match what you want (a pointer to i32). First, the
486 this:</p>
489 <pre>
490 ... | grep {i32\\*}
491 </pre>
492 </div>
496 you may get invalid results (both false positives and false
497 negatives).</p>
499 </div>
501 <!-- _______________________________________________________________________ -->
503 <!-- _______________________________________________________________________ -->
505 <div>
507 <p>A powerful feature of the RUN: lines is that it allows any arbitrary commands
508 to be executed as part of the test harness. While standard (portable) unix
509 tools like 'grep' work fine on run lines, as you see above, there are a lot
510 of caveats due to interaction with Tcl syntax, and we want to make sure the
511 run lines are portable to a wide range of systems. Another major problem is
512 that grep is not very good at checking to verify that the output of a tools
513 contains a series of different output in a specific order. The FileCheck
514 tool was designed to help with these problems.</p>
518 designed to read a file to check from standard input, and the set of things
519 to verify from a file specified as a command line argument. A simple example
520 of using FileCheck from a RUN line looks like this:</p>
523 <pre>
525 </pre>
526 </div>
529 llc, then pipe the output of llc into FileCheck. This means that FileCheck will
530 be verifying its standard input (the llc output) against the filename argument
531 specified (the original .ll file specified by "%s"). To see how this works,
532 lets look at the rest of the .ll file (after the RUN line):</p>
535 <pre>
536 define void @sub1(i32* %p, i32 %v) {
537 entry:
540 %0 = tail call i32 @llvm.atomic.load.sub.i32.p0i32(i32* %p, i32 %v)
541 ret void
542 }
544 define void @inc4(i64* %p) {
545 entry:
549 ret void
550 }
551 </pre>
552 </div>
555 how the file is piped into llvm-as, then llc, and the machine code output is
556 what we are verifying. FileCheck checks the machine code output to verify that
559 <p>The syntax of the CHECK: lines is very simple: they are fixed strings that
560 must occur in order. FileCheck defaults to ignoring horizontal whitespace
561 differences (e.g. a space is allowed to match a tab) but otherwise, the contents
562 of the CHECK: line is required to match some thing in the test file exactly.</p>
564 <p>One nice thing about FileCheck (compared to grep) is that it allows merging
565 test cases together into logical groups. For example, because the test above
567 is a "subl" in between those labels. If it existed somewhere else in the file,
568 that would not count: "grep subl" matches if subl exists anywhere in the
569 file.</p>
571 <!-- _______________________________________________________________________ -->
572 <h4>
574 </h4>
576 <div>
578 <p>The FileCheck -check-prefix option allows multiple test configurations to be
579 driven from one .ll file. This is useful in many circumstances, for example,
580 testing different architectural variants with llc. Here's a simple example:</p>
583 <pre>
584 ; RUN: llvm-as < %s | llc -mtriple=i686-apple-darwin9 -mattr=sse41 \
586 ; RUN: llvm-as < %s | llc -mtriple=x86_64-apple-darwin9 -mattr=sse41 \
597 }
598 </pre>
599 </div>
601 <p>In this case, we're testing that we get the expected code generation with
604 </div>
606 <!-- _______________________________________________________________________ -->
607 <h4>
609 </h4>
611 <div>
613 <p>Sometimes you want to match lines and would like to verify that matches
614 happen on exactly consecutive lines with no other lines in between them. In
615 this case, you can use CHECK: and CHECK-NEXT: directives to specify this. If
616 you specified a custom check prefix, just use "<PREFIX>-NEXT:". For
617 example, something like this works as you'd expect:</p>
620 <pre>
628 ret void
637 }
638 </pre>
639 </div>
641 <p>CHECK-NEXT: directives reject the input unless there is exactly one newline
642 between it an the previous directive. A CHECK-NEXT cannot be the first
643 directive in a file.</p>
645 </div>
647 <!-- _______________________________________________________________________ -->
648 <h4>
650 </h4>
652 <div>
654 <p>The CHECK-NOT: directive is used to verify that a string doesn't occur
655 between two matches (or the first match and the beginning of the file). For
656 example, to verify that a load is removed by a transformation, a test like this
657 can be used:</p>
660 <pre>
661 define i8 @coerce_offset0(i32 %V, i32* %P) {
662 store i32 %V, i32* %P
664 %P2 = bitcast i32* %P to i8*
665 %P3 = getelementptr i8* %P2, i32 2
667 %A = load i8* %P3
668 ret i8 %A
672 }
673 </pre>
674 </div>
676 </div>
678 <!-- _______________________________________________________________________ -->
679 <h4>
681 </h4>
683 <div>
685 <p>The CHECK: and CHECK-NOT: directives both take a pattern to match. For most
686 uses of FileCheck, fixed string matching is perfectly sufficient. For some
687 things, a more flexible form of matching is desired. To support this, FileCheck
688 allows you to specify regular expressions in matching strings, surrounded by
690 matching for a majority of what we do, FileCheck has been designed to support
691 mixing and matching fixed string matching with regular expressions. This allows
692 you to write things like this:</p>
695 <pre>
697 </pre>
698 </div>
700 <p>In this case, any offset from the ESP register will be allowed, and any xmm
701 register will be allowed.</p>
703 <p>Because regular expressions are enclosed with double braces, they are
704 visually distinct, and you don't need to use escape characters within the double
705 braces like you would in C. In the rare case that you want to match double
706 braces explicitly from the input, you can use something ugly like
709 </div>
711 <!-- _______________________________________________________________________ -->
712 <h4>
714 </h4>
716 <div>
718 <p>It is often useful to match a pattern and then verify that it occurs again
719 later in the file. For codegen tests, this can be useful to allow any register,
720 but verify that that register is used consistently later. To do this, FileCheck
721 allows named variables to be defined and substituted into patterns. Here is a
722 simple example:</p>
725 <pre>
726 ; CHECK: test5:
729 </pre>
730 </div>
733 the variables "REGISTER". The second line verifies that whatever is in REGISTER
734 occurs later in the file after an "andw". FileCheck variable references are
736 formed with the regex "<tt>[a-zA-Z][a-zA-Z0-9]*</tt>". If a colon follows the
737 name, then it is a definition of the variable, if not, it is a use.</p>
739 <p>FileCheck variables can be defined multiple times, and uses always get the
740 latest value. Note that variables are all read at the start of a "CHECK" line
741 and are all defined at the end. This means that if you have something like
742 "<tt>CHECK: [[XYZ:.*]]x[[XYZ]]</tt>" that the check line will read the previous
743 value of the XYZ variable and define a new one after the match is performed. If
744 you need to do something like this you can probably take advantage of the fact
745 that FileCheck is not actually line-oriented when it matches, this allows you to
746 define two separate CHECK lines that match on the same line.
747 </p>
749 </div>
751 </div>
753 <!-- _______________________________________________________________________ -->
755 <!-- _______________________________________________________________________ -->
756 <div>
757 <p>With a RUN line there are a number of substitutions that are permitted. In
760 To make a substitution just write the variable's name preceded by a $.
761 Additionally, for compatibility reasons with previous versions of the test
762 library, certain names can be accessed with an alternate syntax: a % prefix.
763 These alternates are deprecated and may go away in a future version.
764 </p>
765 <p>Here are the available variable names. The alternate syntax is listed in
766 parentheses.</p>
770 <dd>The full path to the test case's source. This is suitable for passing
771 on the command line as the input to an llvm tool.</dd>
781 sub-directory that contains the test source being executed.</dd>
787 <dd>The root directory of the LLVM object tree. This could be the same
788 as the srcroot.</dd>
791 <dd>The path to the directory that contains the test case source. This is
792 for locating any supporting files that are not generated by the test, but
793 used by the test.</dd>
796 <dd>The path to a temporary file name that could be used for this test case.
797 The file name won't conflict with other test cases. You can append to it if
798 you need multiple temporaries. This is useful as the destination of some
799 redirected output.</dd>
805 <dd>The target triplet that corresponds to the current host machine (the one
810 configured LLVM environment</dd>
814 configured LLVM environment</dd>
818 this might not be gcc.</dd>
822 this might not be g++.</dd>
825 <dd>The full command line used to compile LLVM C source code. This has all
826 the configured -I, -D and optimization options.</dd>
829 <dd>The full command used to compile LLVM C++ source code. This has
830 all the configured -I, -D and optimization options.</dd>
833 <dd>This full link command used to link LLVM executables. This has all the
834 configured -I, -L and -l options.</dd>
837 <dd>The suffix for the host platforms share library (dll) files. This
838 includes the period as the first character.</dd>
839 </dl>
840 <p>To add more variables, two things need to be changed. First, add a line in
842 "set" the variable as a global in the site.exp file. Second, in the
844 to the list of "global" declarations at the beginning of the proc. That's it,
845 the variable can then be used in test scripts.</p>
846 </div>
848 <!-- _______________________________________________________________________ -->
850 <!-- _______________________________________________________________________ -->
851 <div>
852 <p>To make RUN line writing easier, there are several shell scripts located
854 when running tests, so you can just call these scripts using their name. For
855 example:</p>
856 <dl>
859 in cases where the test needs to cause a tool to generate an error (e.g. to
860 check the error output). However, any program in a pipeline that returns a
861 non-zero result will cause the test to fail. This script overcomes that
862 issue and nicely documents that the test case is purposefully ignoring the
863 result code of the tool</dd>
866 <dd>This script runs its arguments and then inverts the result code from
868 useful to invert the result of a grep. For example "not grep X" means
869 succeed only if you don't find X in the input.</dd>
870 </dl>
874 line near the top of the file. This signals that the test case should succeed
875 if the test fails. Such test cases are counted separately by the testing tool. To
876 specify an expected fail, use the XFAIL keyword in the comments of the test
877 program followed by a colon and one or more regular expressions (separated by
878 a comma). The regular expressions allow you to XFAIL the test conditionally by
879 host platform. The regular expressions following the : are matched against the
880 target triplet for the host machine. If there is a match, the test is expected
881 to fail. If not, the test is expected to succeed. To XFAIL everywhere just
885 <pre>
886 ; XFAIL: darwin,sun
887 </pre>
888 </div>
891 scan the lines of the test case for ones that contain a pattern that matches
893 is related to the test case. The number after "PR" specifies the LLVM bugzilla
894 number. When a PR number is specified, it will be used in the pass/fail
895 reporting. This is useful to quickly get some context when a test fails.</p>
898 interpretation of lines to terminate. This is generally done right after the
899 last RUN: line. This has two side effects: (a) it prevents special
900 interpretation of lines that are part of the test program, not the
901 instructions to the test case, and (b) it speeds things up for really big test
902 cases by avoiding interpretation of the remainder of the file.</p>
904 </div>
906 </div>
908 <!--=========================================================================-->
910 <!--=========================================================================-->
912 <div>
915 with LLVM and executed. These programs are compiled using the native compiler
916 and various LLVM backends. The output from the program compiled with the
917 native compiler is assumed correct; the results from the other programs are
918 compared to the native program output and pass if they match.</p>
920 <p>When executing tests, it is usually a good idea to start out with a subset of
921 the available tests or programs. This makes test run times smaller at first and
922 later on this is useful to investigate individual test failures. To run some
923 test only on a subset of programs, simply change directory to the programs you
926 selected programs (see below for more info).</p>
929 performs timing tests of various LLVM optimizations. It also records
930 compilation times for the compilers and the JIT. This information can be
931 used to compare the effectiveness of LLVM's optimizations and code
932 generation.</p>
935 SingleSource, and External.</p>
937 <ul>
939 <p>The SingleSource directory contains test programs that are only a single
940 source file in size. These are usually small benchmark programs or small
941 programs that calculate a particular value. Several such programs are grouped
942 together in each directory.</p></li>
945 <p>The MultiSource directory contains subdirectories which contain entire
946 programs with multiple source files. Large benchmarks and whole applications
947 go here.</p></li>
950 <p>The External directory contains Makefiles for building code that is external
951 to (i.e., not distributed with) LLVM. The most prominent members of this
953 directory does not contain these actual tests, but only the Makefiles that know
954 how to properly compile these programs from somewhere else. The presence and
955 location of these external programs is configured by the test-suite
957 </ul>
959 <p>Each tree is then subdivided into several categories, including applications,
960 benchmarks, regression tests, code that is strange grammatically, etc. These
961 organizations should be relatively self explanatory.</p>
963 <p>Some tests are known to fail. Some are bugs that we have not fixed yet;
964 others are features that we haven't added yet (or may never add). In the
965 regression tests, the result for such tests will be XFAIL (eXpected FAILure).
966 In this way, you can tell the difference between an expected and unexpected
967 failure.</p>
969 <p>The tests in the test suite have no such feature at this time. If the
970 test passes, only warnings and other miscellaneous output will be generated. If
972 will help you separate benign warnings from actual test failures.</p>
974 </div>
976 <!--=========================================================================-->
978 <!--=========================================================================-->
980 <div>
982 <p>First, all tests are executed within the LLVM object directory tree. They
984 test suite creates temporary files during execution.</p>
988 <ol>
990 </li>
995 <pre>
996 % svn co http://llvm.org/svn/llvm-project/test-suite/trunk test-suite
997 </pre>
998 </div>
1000 </li>
1005 each build tree (LLVM object directory tree) in which you want
1006 to run the test suite, just as you do before building LLVM.</p>
1011 <p>You must also tell the configure machinery that the test suite
1012 is available so it can be configured for your build tree:</p>
1014 <pre>
1015 % cd $LLVM_OBJ_ROOT ; $LLVM_SRC_ROOT/configure [--with-llvmgccdir=$LLVM_GCC_DIR]
1016 </pre>
1017 </div>
1020 </li>
1024 <pre>
1025 % cd $LLVM_OBJ_ROOT/projects/test-suite
1026 % make
1027 </pre>
1028 </div>
1029 </li>
1030 </ol>
1031 <p>Note that the second and third steps only need to be done once. After you
1032 have the suite checked out and configured, you don't need to do it again (unless
1033 the test code or configure script changes).</p>
1035 <!-- _______________________________________________________________________ -->
1036 <h3>
1038 </h3>
1039 <!-- _______________________________________________________________________ -->
1041 <div>
1047 neglected, the External tests won't work.</p>
1048 <dl>
1051 </dl>
1052 This tells LLVM where to find any external tests. They are expected to be
1057 Subdirectory names known to LLVM include:
1058 <dl>
1063 </dl>
1064 Others are added from time to time, and can be determined from
1066 </div>
1068 <!-- _______________________________________________________________________ -->
1069 <h3>
1071 </h3>
1072 <!-- _______________________________________________________________________ -->
1073 <div>
1075 module also provides a mechanism for compiling the programs in different ways.
1078 This Makefile can modify build rules to yield different results.</p>
1081 create the nightly test reports. To run the nightly tests, run <tt>gmake
1084 <p>There are several TEST Makefiles available in the tree. Some of them are
1085 designed for internal LLVM research and will not work outside of the LLVM
1086 research group. They may still be valuable, however, as a guide to writing your
1087 own TEST Makefile for any optimization or analysis passes that you develop with
1088 LLVM.</p>
1090 </div>
1092 <!-- _______________________________________________________________________ -->
1093 <h3>
1095 </h3>
1096 <!-- _______________________________________________________________________ -->
1097 <div>
1098 <p>There are a number of ways to run the tests and generate output. The most
1100 compile and run all programs in the tree using a number of different methods
1101 and compare results. Any failures are reported in the output, but are likely
1102 drowned in the other output. Passes are not reported explicitely.</p>
1105 the specified test and usually adds per-program summaries to the output
1107 explicitely outputs TEST-PASS or TEST-FAIL for every test after each program.
1108 Though these lines are still drowned in the output, it's easy to grep the
1109 output logs in the Output directories.</p>
1115 end of the run and the results are always stored in the
1121 run.
1122 </div>
1124 <!-- _______________________________________________________________________ -->
1125 <h3>
1127 </h3>
1128 <!-- _______________________________________________________________________ -->
1130 <div>
1133 should work), it is really easy to run optimizations or code generator
1134 components against every program in the tree, collecting statistics or running
1135 custom checks for correctness. At base, this is how the nightly tester works,
1136 it's just one example of a general framework.</p>
1138 <p>Lets say that you have an LLVM optimization pass, and you want to see how
1139 many times it triggers. First thing you should do is add an LLVM
1141 will tally counts of things you care about.</p>
1143 <p>Following this, you can set up a test and a report that collects these and
1144 formats them for easy viewing. This consists of two files, a
1145 "<tt>test-suite/TEST.XXX.Makefile</tt>" fragment (where XXX is the name of your
1146 test) and a "<tt>test-suite/TEST.XXX.report</tt>" file that indicates how to
1147 format the output into a table. There are many example reports of various
1148 levels of sophistication included with the test suite, and the framework is very
1149 general.</p>
1151 <p>If you are interested in testing an optimization pass, check out the
1155 <pre>
1156 % cd llvm/projects/test-suite/MultiSource/Benchmarks # or some other level
1157 % make TEST=libcalls report
1158 </pre>
1159 </div>
1164 <pre>
1165 Name | total | #exit |
1166 ...
1171 MallocBench/cfrac/cfrac | 1 | * |
1173 MallocBench/gs/gs | 4 | * |
1174 Prolangs-C/TimberWolfMC/timberwolfmc | 302 | * |
1176 Prolangs-C/allroots/allroots | * | * |
1177 Prolangs-C/assembler/assembler | 47 | * |
1178 Prolangs-C/bison/mybison | 74 | * |
1179 ...
1180 </pre>
1181 </div>
1183 <p>This basically is grepping the -stats output and displaying it in a table.
1184 You can also use the "TEST=libcalls report.html" target to get the table in HTML
1185 form, similarly for report.csv and report.tex.</p>
1187 <p>The source for this is in test-suite/TEST.libcalls.*. The format is pretty
1188 simple: the Makefile indicates how to run the test (in this case,
1189 "<tt>opt -simplify-libcalls -stats</tt>"), and the report contains one line for
1190 each column of the output. The first value is the header for the column and the
1191 second is the regex to grep the output of the command for. There are lots of
1192 example reports that can do fancy stuff.</p>
1194 </div>
1196 </div>
1198 <!-- *********************************************************************** -->
1200 <hr>
1201 <address>
1207 John T. Criswell, Daniel Dunbar, Reid Spencer, and Tanya Lattner<br>
1209 Last modified: $Date$
1210 </address>
1211 </body>
1212 </html>