| blob | 5886c85242c38b1d6beef594e1e38144ae22173a |
3 <html>
4 <head>
7 </head>
8 <body>
11 LLVM Testing Infrastructure Guide
12 </div>
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 <!--=========================================================================-->
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 <!--=========================================================================-->
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 <!--=========================================================================-->
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 </div>
94 <!-- _______________________________________________________________________ -->
96 <!-- _______________________________________________________________________ -->
100 <p>The regression tests are small pieces of code that test a specific feature of
101 LLVM or trigger a specific bug in LLVM. They are usually written in LLVM
102 assembly language, but can be written in other languages if the test targets a
105 tests are driven by the 'lit' testing tool, which is part of LLVM.</p>
107 <p>These code fragments are not complete programs. The code generated
108 from them is never executed to determine correct behavior.</p>
111 directory.</p>
113 <p>Typically when a bug is found in LLVM, a regression test containing
114 just enough code to reproduce the problem should be written and placed
115 somewhere underneath this directory. In most cases, this will be a small
116 piece of LLVM assembly language code, often distilled from an actual
117 application or benchmark.</p>
119 </div>
121 <!-- _______________________________________________________________________ -->
123 <!-- _______________________________________________________________________ -->
127 <p>The test suite contains whole programs, which are pieces of
128 code which can be compiled and linked into a stand-alone program that can be
129 executed. These programs are generally written in high level languages such as
130 C or C++, but sometimes they are written straight in LLVM assembly.</p>
132 <p>These programs are compiled and then executed using several different
133 methods (native compiler, LLVM C backend, LLVM JIT, LLVM native code generation,
134 etc). The output of these programs is compared to ensure that LLVM is compiling
135 the program correctly.</p>
137 <p>In addition to compiling and executing programs, whole program tests serve as
138 a way of benchmarking LLVM performance, both in terms of the efficiency of the
139 programs generated as well as the speed with which LLVM compiles, optimizes, and
140 generates code.</p>
144 </div>
146 <!-- _______________________________________________________________________ -->
148 tests</a></div>
149 <!-- _______________________________________________________________________ -->
153 <p>The test suite contains tests to check quality of debugging information.
154 The test are written in C based languages or in LLVM assembly language. </p>
156 <p>These tests are compiled and run under a debugger. The debugger output
157 is checked to validate of debugging information. See README.txt in the
158 test suite for more information . This test suite is located in the
161 </div>
163 <!--=========================================================================-->
165 <!--=========================================================================-->
169 <p>The tests are located in two separate Subversion modules. The regressions
170 tests are in the main "llvm" module under the directory
172 The more comprehensive test suite that includes whole
175 than the default "test-suite", for then the test suite will be run every time
181 <!-- _______________________________________________________________________ -->
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 <!-- _______________________________________________________________________ -->
244 <!-- _______________________________________________________________________ -->
246 <p>To run the comprehensive test suite (tests that compile and execute whole
250 <pre>
251 % cd llvm/projects
252 % svn co http://llvm.org/svn/llvm-project/test-suite/trunk test-suite
253 % cd ..
254 % ./configure --with-llvmgccdir=$LLVM_GCC_DIR
255 </pre>
256 </div>
264 respectively. If this is not the case,
266 executable's location.</p>
269 directory:</p>
272 <pre>
273 % cd projects/test-suite
274 % gmake
275 </pre>
276 </div>
279 let it generate a report by running:</p>
282 <pre>
283 % cd projects/test-suite
284 % gmake TEST=nightly report report.html
285 </pre>
286 </div>
288 <p>Any of the above commands can also be run in a subdirectory of
290 that subdirectory.</p>
292 </div>
294 <!-- _______________________________________________________________________ -->
296 tests</a></div>
297 <!-- _______________________________________________________________________ -->
300 <p> To run debugging information tests simply checkout the tests inside
301 clang/test directory. </p>
304 <pre>
305 %cd clang/test
306 % svn co http://llvm.org/svn/llvm-project/debuginfo-tests/trunk debuginfo-tests
307 </pre>
308 </div>
312 </div>
314 <!--=========================================================================-->
316 <!--=========================================================================-->
318 <p>The LLVM regression tests are driven by 'lit' and are located in
321 <p>This directory contains a large array of small tests
322 that exercise various features of LLVM and to ensure that regressions do not
323 occur. The directory is broken into several sub-directories, each focused on
324 a particular area of LLVM. A few of the important ones are:</p>
326 <ul>
335 transforms to ensure they make the right transformations.</li>
337 </ul>
339 </div>
341 <!-- _______________________________________________________________________ -->
343 <!-- _______________________________________________________________________ -->
345 <p>The regression test structure is very simple, but does require some
349 you.</p>
351 <p>In order for the regression tests to work, each directory of tests must
353 run the tests. This file is just a Tcl script and it can do anything you want,
354 but we've standardized it for the LLVM regression tests. If you're adding a
358 defined in that library with a list of file names to run. The names are
359 obtained by using Tcl's glob command. Any directory that contains only
364 that specify how the test is to be run. So, each test script must contain
365 RUN lines if it is to do anything. If there are no RUN lines, the
367 fail.</p>
369 <p>RUN lines are specified in the comments of the test program using the
371 to execute. Together, these lines form the "script" that
373 RUN lines is similar to a shell's syntax for pipelines including I/O
374 redirection and variable substitution. However, even though these lines
377 shell. Consequently the syntax differs from normal shell script syntax in a
378 few ways. You can specify as many RUN lines as needed.</p>
380 <p>lit performs substitution on each RUN line to replace LLVM tool
381 names with the full paths to the executable built for each tool (in
382 $(LLVM_OBJ_ROOT)/$(BuildMode)/bin). This ensures that lit does not
383 invoke any stray LLVM tools in the user's path during testing.</p>
385 <p>Each RUN line is executed on its own, distinct from other lines unless
387 line to be concatenated with the next one. In this way you can build up long
388 pipelines of commands without making huge line lengths. The lines ending in
390 found. This concatenated set of RUN lines then constitutes one execution.
391 Tcl will substitute variables and arrange for the pipeline to be executed. If
392 any process in the pipeline fails, the entire line (and test case) fails too.
393 </p>
398 <pre>
401 ; RUN: diff %t1 %t2
402 </pre>
403 </div>
405 <p>As with a Unix shell, the RUN: lines permit pipelines and I/O redirection
406 to be used. However, the usage is slightly different than for Bash. To check
407 what's legal, see the documentation for the
409 command and the
411 The major differences are:</p>
412 <ul>
417 <li>You can only redirect to a file, not to another descriptor and not from
418 a here document.</li>
419 <li>tcl supports redirecting to open files with the @ syntax but you
420 shouldn't use that here.</li>
421 </ul>
423 <p>There are some quoting rules that you must pay attention to when writing
424 your RUN lines. In general nothing needs to be quoted. Tcl won't strip off any
425 quote characters so they will get passed to the invoked program. For
426 example:</p>
429 <pre>
430 ... | grep 'find this string'
431 </pre>
432 </div>
434 <p>This will fail because the ' characters are passed to grep. This would
437 treat everything enclosed as one value. So our example would become:</p>
440 <pre>
441 ... | grep {find this string}
442 </pre>
443 </div>
446 specially by Tcl. They tell Tcl to interpret the content as a command to
447 execute. Since these characters are often used in regular expressions this can
448 have disastrous results and cause the entire test run in a directory to fail.
449 For example, a common idiom is to look for some basicblock number:</p>
452 <pre>
454 </pre>
455 </div>
457 <p>This, however, will cause Tcl to fail because its going to try to execute
461 <pre>
463 </pre>
464 </div>
467 then it must be doubled. This is another Tcl special character. So, suppose
468 you had:
471 <pre>
472 ... | grep 'i32\*'
473 </pre>
474 </div>
476 <p>This will fail to match what you want (a pointer to i32). First, the
480 this:</p>
483 <pre>
484 ... | grep {i32\\*}
485 </pre>
486 </div>
490 you may get invalid results (both false positives and false
491 negatives).</p>
493 </div>
495 <!-- _______________________________________________________________________ -->
497 <!-- _______________________________________________________________________ -->
501 <p>A powerful feature of the RUN: lines is that it allows any arbitrary commands
502 to be executed as part of the test harness. While standard (portable) unix
503 tools like 'grep' work fine on run lines, as you see above, there are a lot
504 of caveats due to interaction with Tcl syntax, and we want to make sure the
505 run lines are portable to a wide range of systems. Another major problem is
506 that grep is not very good at checking to verify that the output of a tools
507 contains a series of different output in a specific order. The FileCheck
508 tool was designed to help with these problems.</p>
512 designed to read a file to check from standard input, and the set of things
513 to verify from a file specified as a command line argument. A simple example
514 of using FileCheck from a RUN line looks like this:</p>
517 <pre>
519 </pre>
520 </div>
523 llc, then pipe the output of llc into FileCheck. This means that FileCheck will
524 be verifying its standard input (the llc output) against the filename argument
525 specified (the original .ll file specified by "%s"). To see how this works,
526 lets look at the rest of the .ll file (after the RUN line):</p>
529 <pre>
530 define void @sub1(i32* %p, i32 %v) {
531 entry:
534 %0 = tail call i32 @llvm.atomic.load.sub.i32.p0i32(i32* %p, i32 %v)
535 ret void
536 }
538 define void @inc4(i64* %p) {
539 entry:
543 ret void
544 }
545 </pre>
546 </div>
549 how the file is piped into llvm-as, then llc, and the machine code output is
550 what we are verifying. FileCheck checks the machine code output to verify that
553 <p>The syntax of the CHECK: lines is very simple: they are fixed strings that
554 must occur in order. FileCheck defaults to ignoring horizontal whitespace
555 differences (e.g. a space is allowed to match a tab) but otherwise, the contents
556 of the CHECK: line is required to match some thing in the test file exactly.</p>
558 <p>One nice thing about FileCheck (compared to grep) is that it allows merging
559 test cases together into logical groups. For example, because the test above
561 is a "subl" in between those labels. If it existed somewhere else in the file,
562 that would not count: "grep subl" matches if subl exists anywhere in the
563 file.</p>
565 </div>
567 <!-- _______________________________________________________________________ -->
573 <p>The FileCheck -check-prefix option allows multiple test configurations to be
574 driven from one .ll file. This is useful in many circumstances, for example,
575 testing different architectural variants with llc. Here's a simple example:</p>
578 <pre>
579 ; RUN: llvm-as < %s | llc -mtriple=i686-apple-darwin9 -mattr=sse41 \
581 ; RUN: llvm-as < %s | llc -mtriple=x86_64-apple-darwin9 -mattr=sse41 \
592 }
593 </pre>
594 </div>
596 <p>In this case, we're testing that we get the expected code generation with
599 </div>
601 <!-- _______________________________________________________________________ -->
607 <p>Sometimes you want to match lines and would like to verify that matches
608 happen on exactly consecutive lines with no other lines in between them. In
609 this case, you can use CHECK: and CHECK-NEXT: directives to specify this. If
610 you specified a custom check prefix, just use "<PREFIX>-NEXT:". For
611 example, something like this works as you'd expect:</p>
614 <pre>
622 ret void
631 }
632 </pre>
633 </div>
635 <p>CHECK-NEXT: directives reject the input unless there is exactly one newline
636 between it an the previous directive. A CHECK-NEXT cannot be the first
637 directive in a file.</p>
639 </div>
641 <!-- _______________________________________________________________________ -->
647 <p>The CHECK-NOT: directive is used to verify that a string doesn't occur
648 between two matches (or the first match and the beginning of the file). For
649 example, to verify that a load is removed by a transformation, a test like this
650 can be used:</p>
653 <pre>
654 define i8 @coerce_offset0(i32 %V, i32* %P) {
655 store i32 %V, i32* %P
657 %P2 = bitcast i32* %P to i8*
658 %P3 = getelementptr i8* %P2, i32 2
660 %A = load i8* %P3
661 ret i8 %A
665 }
666 </pre>
667 </div>
669 </div>
671 <!-- _______________________________________________________________________ -->
677 <p>The CHECK: and CHECK-NOT: directives both take a pattern to match. For most
678 uses of FileCheck, fixed string matching is perfectly sufficient. For some
679 things, a more flexible form of matching is desired. To support this, FileCheck
680 allows you to specify regular expressions in matching strings, surrounded by
682 matching for a majority of what we do, FileCheck has been designed to support
683 mixing and matching fixed string matching with regular expressions. This allows
684 you to write things like this:</p>
687 <pre>
689 </pre>
690 </div>
692 <p>In this case, any offset from the ESP register will be allowed, and any xmm
693 register will be allowed.</p>
695 <p>Because regular expressions are enclosed with double braces, they are
696 visually distinct, and you don't need to use escape characters within the double
697 braces like you would in C. In the rare case that you want to match double
698 braces explicitly from the input, you can use something ugly like
701 </div>
703 <!-- _______________________________________________________________________ -->
709 <p>It is often useful to match a pattern and then verify that it occurs again
710 later in the file. For codegen tests, this can be useful to allow any register,
711 but verify that that register is used consistently later. To do this, FileCheck
712 allows named variables to be defined and substituted into patterns. Here is a
713 simple example:</p>
716 <pre>
717 ; CHECK: test5:
720 </pre>
721 </div>
724 the variables "REGISTER". The second line verifies that whatever is in REGISTER
725 occurs later in the file after an "andw". FileCheck variable references are
727 formed with the regex "<tt>[a-zA-Z][a-zA-Z0-9]*</tt>". If a colon follows the
728 name, then it is a definition of the variable, if not, it is a use.</p>
730 <p>FileCheck variables can be defined multiple times, and uses always get the
731 latest value. Note that variables are all read at the start of a "CHECK" line
732 and are all defined at the end. This means that if you have something like
733 "<tt>CHECK: [[XYZ:.*]]x[[XYZ]]</tt>" that the check line will read the previous
734 value of the XYZ variable and define a new one after the match is performed. If
735 you need to do something like this you can probably take advantage of the fact
736 that FileCheck is not actually line-oriented when it matches, this allows you to
737 define two separate CHECK lines that match on the same line.
738 </p>
740 </div>
742 <!-- _______________________________________________________________________ -->
744 substitutions</a></div>
745 <!-- _______________________________________________________________________ -->
747 <p>With a RUN line there are a number of substitutions that are permitted. In
750 To make a substitution just write the variable's name preceded by a $.
751 Additionally, for compatibility reasons with previous versions of the test
752 library, certain names can be accessed with an alternate syntax: a % prefix.
753 These alternates are deprecated and may go away in a future version.
754 </p>
755 <p>Here are the available variable names. The alternate syntax is listed in
756 parentheses.</p>
760 <dd>The full path to the test case's source. This is suitable for passing
761 on the command line as the input to an llvm tool.</dd>
771 sub-directory that contains the test source being executed.</dd>
777 <dd>The root directory of the LLVM object tree. This could be the same
778 as the srcroot.</dd>
781 <dd>The path to the directory that contains the test case source. This is
782 for locating any supporting files that are not generated by the test, but
783 used by the test.</dd>
786 <dd>The path to a temporary file name that could be used for this test case.
787 The file name won't conflict with other test cases. You can append to it if
788 you need multiple temporaries. This is useful as the destination of some
789 redirected output.</dd>
795 <dd>The target triplet that corresponds to the current host machine (the one
800 configured LLVM environment</dd>
804 configured LLVM environment</dd>
808 this might not be gcc.</dd>
812 this might not be g++.</dd>
815 <dd>The full command line used to compile LLVM C source code. This has all
816 the configured -I, -D and optimization options.</dd>
819 <dd>The full command used to compile LLVM C++ source code. This has
820 all the configured -I, -D and optimization options.</dd>
823 <dd>This full link command used to link LLVM executables. This has all the
824 configured -I, -L and -l options.</dd>
827 <dd>The suffix for the host platforms share library (dll) files. This
828 includes the period as the first character.</dd>
829 </dl>
830 <p>To add more variables, two things need to be changed. First, add a line in
832 "set" the variable as a global in the site.exp file. Second, in the
834 to the list of "global" declarations at the beginning of the proc. That's it,
835 the variable can then be used in test scripts.</p>
836 </div>
838 <!-- _______________________________________________________________________ -->
840 <!-- _______________________________________________________________________ -->
842 <p>To make RUN line writing easier, there are several shell scripts located
844 when running tests, so you can just call these scripts using their name. For
845 example:</p>
846 <dl>
849 in cases where the test needs to cause a tool to generate an error (e.g. to
850 check the error output). However, any program in a pipeline that returns a
851 non-zero result will cause the test to fail. This script overcomes that
852 issue and nicely documents that the test case is purposefully ignoring the
853 result code of the tool</dd>
856 <dd>This script runs its arguments and then inverts the result code from
858 useful to invert the result of a grep. For example "not grep X" means
859 succeed only if you don't find X in the input.</dd>
860 </dl>
864 line near the top of the file. This signals that the test case should succeed
865 if the test fails. Such test cases are counted separately by the testing tool. To
866 specify an expected fail, use the XFAIL keyword in the comments of the test
867 program followed by a colon and one or more regular expressions (separated by
868 a comma). The regular expressions allow you to XFAIL the test conditionally by
869 host platform. The regular expressions following the : are matched against the
870 target triplet for the host machine. If there is a match, the test is expected
871 to fail. If not, the test is expected to succeed. To XFAIL everywhere just
875 <pre>
876 ; XFAIL: darwin,sun
877 </pre>
878 </div>
881 scan the lines of the test case for ones that contain a pattern that matches
883 is related to the test case. The number after "PR" specifies the LLVM bugzilla
884 number. When a PR number is specified, it will be used in the pass/fail
885 reporting. This is useful to quickly get some context when a test fails.</p>
888 interpretation of lines to terminate. This is generally done right after the
889 last RUN: line. This has two side effects: (a) it prevents special
890 interpretation of lines that are part of the test program, not the
891 instructions to the test case, and (b) it speeds things up for really big test
892 cases by avoiding interpretation of the remainder of the file.</p>
894 </div>
896 <!--=========================================================================-->
898 Structure</a></div>
899 <!--=========================================================================-->
904 with LLVM and executed. These programs are compiled using the native compiler
905 and various LLVM backends. The output from the program compiled with the
906 native compiler is assumed correct; the results from the other programs are
907 compared to the native program output and pass if they match.</p>
909 <p>When executing tests, it is usually a good idea to start out with a subset of
910 the available tests or programs. This makes test run times smaller at first and
911 later on this is useful to investigate individual test failures. To run some
912 test only on a subset of programs, simply change directory to the programs you
915 selected programs (see below for more info).</p>
918 performs timing tests of various LLVM optimizations. It also records
919 compilation times for the compilers and the JIT. This information can be
920 used to compare the effectiveness of LLVM's optimizations and code
921 generation.</p>
924 SingleSource, and External.</p>
926 <ul>
928 <p>The SingleSource directory contains test programs that are only a single
929 source file in size. These are usually small benchmark programs or small
930 programs that calculate a particular value. Several such programs are grouped
931 together in each directory.</p></li>
934 <p>The MultiSource directory contains subdirectories which contain entire
935 programs with multiple source files. Large benchmarks and whole applications
936 go here.</p></li>
939 <p>The External directory contains Makefiles for building code that is external
940 to (i.e., not distributed with) LLVM. The most prominent members of this
942 directory does not contain these actual tests, but only the Makefiles that know
943 how to properly compile these programs from somewhere else. The presence and
944 location of these external programs is configured by the test-suite
946 </ul>
948 <p>Each tree is then subdivided into several categories, including applications,
949 benchmarks, regression tests, code that is strange grammatically, etc. These
950 organizations should be relatively self explanatory.</p>
952 <p>Some tests are known to fail. Some are bugs that we have not fixed yet;
953 others are features that we haven't added yet (or may never add). In the
954 regression tests, the result for such tests will be XFAIL (eXpected FAILure).
955 In this way, you can tell the difference between an expected and unexpected
956 failure.</p>
958 <p>The tests in the test suite have no such feature at this time. If the
959 test passes, only warnings and other miscellaneous output will be generated. If
961 will help you separate benign warnings from actual test failures.</p>
963 </div>
965 <!--=========================================================================-->
967 <!--=========================================================================-->
971 <p>First, all tests are executed within the LLVM object directory tree. They
973 test suite creates temporary files during execution.</p>
977 <ol>
979 </li>
984 <pre>
985 % svn co http://llvm.org/svn/llvm-project/test-suite/trunk test-suite
986 </pre>
987 </div>
989 </li>
994 each build tree (LLVM object directory tree) in which you want
995 to run the test suite, just as you do before building LLVM.</p>
1000 <p>You must also tell the configure machinery that the test suite
1001 is available so it can be configured for your build tree:</p>
1003 <pre>
1004 % cd $LLVM_OBJ_ROOT ; $LLVM_SRC_ROOT/configure [--with-llvmgccdir=$LLVM_GCC_DIR]
1005 </pre>
1006 </div>
1009 </li>
1013 <pre>
1014 % cd $LLVM_OBJ_ROOT/projects/test-suite
1015 % make
1016 </pre>
1017 </div>
1018 </li>
1019 </ol>
1020 <p>Note that the second and third steps only need to be done once. After you
1021 have the suite checked out and configured, you don't need to do it again (unless
1022 the test code or configure script changes).</p>
1024 </div>
1026 <!-- _______________________________________________________________________ -->
1029 <!-- _______________________________________________________________________ -->
1037 neglected, the External tests won't work.</p>
1038 <dl>
1041 </dl>
1042 This tells LLVM where to find any external tests. They are expected to be
1047 Subdirectory names known to LLVM include:
1048 <dl>
1053 </dl>
1054 Others are added from time to time, and can be determined from
1056 </div>
1058 <!-- _______________________________________________________________________ -->
1061 <!-- _______________________________________________________________________ -->
1064 module also provides a mechanism for compiling the programs in different ways.
1067 This Makefile can modify build rules to yield different results.</p>
1070 create the nightly test reports. To run the nightly tests, run <tt>gmake
1073 <p>There are several TEST Makefiles available in the tree. Some of them are
1074 designed for internal LLVM research and will not work outside of the LLVM
1075 research group. They may still be valuable, however, as a guide to writing your
1076 own TEST Makefile for any optimization or analysis passes that you develop with
1077 LLVM.</p>
1079 </div>
1081 <!-- _______________________________________________________________________ -->
1084 <!-- _______________________________________________________________________ -->
1086 <p>There are a number of ways to run the tests and generate output. The most
1088 compile and run all programs in the tree using a number of different methods
1089 and compare results. Any failures are reported in the output, but are likely
1090 drowned in the other output. Passes are not reported explicitely.</p>
1093 the specified test and usually adds per-program summaries to the output
1095 explicitely outputs TEST-PASS or TEST-FAIL for every test after each program.
1096 Though these lines are still drowned in the output, it's easy to grep the
1097 output logs in the Output directories.</p>
1103 end of the run and the results are always stored in the
1109 run.
1110 </div>
1112 <!-- _______________________________________________________________________ -->
1115 <!-- _______________________________________________________________________ -->
1120 should work), it is really easy to run optimizations or code generator
1121 components against every program in the tree, collecting statistics or running
1122 custom checks for correctness. At base, this is how the nightly tester works,
1123 it's just one example of a general framework.</p>
1125 <p>Lets say that you have an LLVM optimization pass, and you want to see how
1126 many times it triggers. First thing you should do is add an LLVM
1128 will tally counts of things you care about.</p>
1130 <p>Following this, you can set up a test and a report that collects these and
1131 formats them for easy viewing. This consists of two files, a
1132 "<tt>test-suite/TEST.XXX.Makefile</tt>" fragment (where XXX is the name of your
1133 test) and a "<tt>test-suite/TEST.XXX.report</tt>" file that indicates how to
1134 format the output into a table. There are many example reports of various
1135 levels of sophistication included with the test suite, and the framework is very
1136 general.</p>
1138 <p>If you are interested in testing an optimization pass, check out the
1142 <pre>
1143 % cd llvm/projects/test-suite/MultiSource/Benchmarks # or some other level
1144 % make TEST=libcalls report
1145 </pre>
1146 </div>
1151 <pre>
1152 Name | total | #exit |
1153 ...
1158 MallocBench/cfrac/cfrac | 1 | * |
1160 MallocBench/gs/gs | 4 | * |
1161 Prolangs-C/TimberWolfMC/timberwolfmc | 302 | * |
1163 Prolangs-C/allroots/allroots | * | * |
1164 Prolangs-C/assembler/assembler | 47 | * |
1165 Prolangs-C/bison/mybison | 74 | * |
1166 ...
1167 </pre>
1168 </div>
1170 <p>This basically is grepping the -stats output and displaying it in a table.
1171 You can also use the "TEST=libcalls report.html" target to get the table in HTML
1172 form, similarly for report.csv and report.tex.</p>
1174 <p>The source for this is in test-suite/TEST.libcalls.*. The format is pretty
1175 simple: the Makefile indicates how to run the test (in this case,
1176 "<tt>opt -simplify-libcalls -stats</tt>"), and the report contains one line for
1177 each column of the output. The first value is the header for the column and the
1178 second is the regex to grep the output of the command for. There are lots of
1179 example reports that can do fancy stuff.</p>
1181 </div>
1183 <!-- *********************************************************************** -->
1185 <hr>
1186 <address>
1192 John T. Criswell, Daniel Dunbar, Reid Spencer, and Tanya Lattner<br>
1194 Last modified: $Date$
1195 </address>
1196 </body>
1197 </html>