From 1fc08f5e9ef733ef1ce6f363fecedc2260e78974 Mon Sep 17 00:00:00 2001 From: dim Date: Sat, 14 Apr 2012 13:54:10 +0000 Subject: Vendor import of llvm trunk r154661: http://llvm.org/svn/llvm-project/llvm/trunk@r154661 --- docs/CommandGuide/Makefile | 2 +- docs/CommandGuide/index.html | 8 +++- docs/CommandGuide/lit.pod | 70 ++++++++++++++++++++++++++----- docs/CommandGuide/llc.pod | 2 +- docs/CommandGuide/llvm-build.pod | 86 +++++++++++++++++++++++++++++++++++++++ docs/CommandGuide/llvm-cov.pod | 45 ++++++++++++++++++++ docs/CommandGuide/llvm-stress.pod | 42 +++++++++++++++++++ docs/CommandGuide/tblgen.pod | 52 ++++++++++++++++------- 8 files changed, 280 insertions(+), 27 deletions(-) create mode 100644 docs/CommandGuide/llvm-build.pod create mode 100644 docs/CommandGuide/llvm-cov.pod create mode 100644 docs/CommandGuide/llvm-stress.pod (limited to 'docs/CommandGuide') diff --git a/docs/CommandGuide/Makefile b/docs/CommandGuide/Makefile index 2c2d076..3f9f60b 100644 --- a/docs/CommandGuide/Makefile +++ b/docs/CommandGuide/Makefile @@ -49,7 +49,7 @@ MAN := $(patsubst $(SRC_DOC_DIR)%.pod, $(DST_MAN_DIR)%.1, $(POD)) PS := $(patsubst $(SRC_DOC_DIR)%.pod, $(DST_PS_DIR)%.ps, $(POD)) # The set of man pages we will not install -NO_INSTALL_MANS = $(DST_MAN_DIR)FileCheck.1 +NO_INSTALL_MANS = $(DST_MAN_DIR)FileCheck.1 $(DST_MAN_DIR)llvm-build.1 # The set of man pages that we will install INSTALL_MANS = $(filter-out $(NO_INSTALL_MANS), $(MAN)) diff --git a/docs/CommandGuide/index.html b/docs/CommandGuide/index.html index 3e4e220..74ac004 100644 --- a/docs/CommandGuide/index.html +++ b/docs/CommandGuide/index.html @@ -72,6 +72,12 @@ options) arguments to the tool you are interested in.

  • llvm-diff - structurally compare two modules
    • +
  • llvm-cov - + emit coverage information
    • + +
  • llvm-stress - + generate random .ll files to fuzz different llvm components
    • + @@ -129,7 +135,7 @@ options) arguments to the tool you are interested in.

    src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"> LLVM Compiler Infrastructure
    - Last modified: $Date: 2011-09-20 20:24:04 +0200 (Tue, 20 Sep 2011) $ + Last modified: $Date: 2012-02-26 09:35:53 +0100 (Sun, 26 Feb 2012) $ diff --git a/docs/CommandGuide/lit.pod b/docs/CommandGuide/lit.pod index faf4811..81fc2c9 100644 --- a/docs/CommandGuide/lit.pod +++ b/docs/CommandGuide/lit.pod @@ -28,7 +28,7 @@ By default B will use a succinct progress display and will only print summary information for test failures. See L<"OUTPUT OPTIONS"> for options controlling the B progress display and output. -B also includes a number of options for controlling how tests are exected +B also includes a number of options for controlling how tests are executed (specific features may depend on the particular test format). See L<"EXECUTION OPTIONS"> for more information. @@ -37,7 +37,7 @@ the options specified on the command line, see L<"SELECTION OPTIONS"> for more information. Users interested in the B architecture or designing a B testing -implementation should see L<"LIT ARCHITECTURE"> +implementation should see L<"LIT INFRASTRUCTURE"> =head1 GENERAL OPTIONS @@ -159,8 +159,8 @@ other results are not collated in any reasonable fashion. =head1 EXIT STATUS B will exit with an exit code of 1 if there are any FAIL or XPASS -results. Otherwise, it will exit with the status 0. Other exit codes used for -non-test related failures (for example a user error or an internal program +results. Otherwise, it will exit with the status 0. Other exit codes are used +for non-test related failures (for example a user error or an internal program error). =head1 TEST DISCOVERY @@ -208,7 +208,7 @@ suite. The test succeeded, but it was expected to fail. This is used for tests which were specified as expected to fail, but are now succeeding (generally because -the feautre they test was broken and has been fixed). +the feature they test was broken and has been fixed). =item B @@ -227,7 +227,7 @@ which can report unsupported tests. =back Depending on the test format tests may produce additional information about -their status (generally only for failures). See the L +their status (generally only for failures). See the L section for more information. =head1 LIT INFRASTRUCTURE @@ -247,7 +247,7 @@ suite>. Test suites serve to define the format of the tests they contain, the logic for finding those tests, and any additional information to run the tests. B identifies test suites as directories containing I or -I files (see also B<--config-prefix>. Test suites are initially +I files (see also B<--config-prefix>). Test suites are initially discovered by recursively searching up the directory hierarchy for all the input files passed on the command line. You can use B<--show-suites> to display the discovered test suites at startup. @@ -283,13 +283,13 @@ builds this is the directory that will be scanned for tests. B For out-of-dir builds, the path to the test suite root inside the object directory. This is where tests will be run and temporary output files -places. +placed. B A dictionary representing the environment to use when executing tests in the suite. B For B test formats which scan directories for tests, this -variable as a list of suffixes to identify test files. Used by: I, +variable is a list of suffixes to identify test files. Used by: I, I. B For B test formats which substitute variables into a test @@ -301,6 +301,9 @@ reported as unsupported. Used by: I, I. B The parent configuration, this is the config object for the directory containing the test suite, or None. +B The root configuration. This is the top-most B configuration in +the project. + B The config is actually cloned for every subdirectory inside a test suite, to allow local configuration on a per-directory basis. The I variable can be set to a Python function which will be called whenever a @@ -315,7 +318,7 @@ directory being scanned. Once test suites are located, B recursively traverses the source directory (following I) looking for tests. When B enters a -sub-directory, it first checks to see if a nest test suite is defined in that +sub-directory, it first checks to see if a nested test suite is defined in that directory. If so, it loads that test suite recursively, otherwise it instantiates a local test config for the directory (see L<"LOCAL CONFIGURATION FILES">). @@ -338,6 +341,53 @@ define subdirectories of optional tests, or to change other configuration parameters -- for example, to change the test format, or the suffixes which identify test files. +=head2 TEST RUN OUTPUT FORMAT + +The b output for a test run conforms to the following schema, in both short +and verbose modes (although in short mode no PASS lines will be shown). This +schema has been chosen to be relatively easy to reliably parse by a machine (for +example in buildbot log scraping), and for other tools to generate. + +Each test result is expected to appear on a line that matches: + +: () + +where is a standard test result such as PASS, FAIL, XFAIL, XPASS, +UNRESOLVED, or UNSUPPORTED. The performance result codes of IMPROVED and +REGRESSED are also allowed. + +The field can consist of an arbitrary string containing no newline. + +The field can be used to report progress information such as +(1/300) or can be empty, but even when empty the parentheses are required. + +Each test result may include additional (multiline) log information in the +following format. + + TEST '()' +... log message ... + + +where should be the name of a preceeding reported test, is a string of '*' characters I four characters long (the +recommended length is 20), and is an arbitrary (unparsed) +string. + +The following is an example of a test run output which consists of four tests A, +B, C, and D, and a log message for the failing test C. + +=head3 Example Test Run Output Listing + +PASS: A (1 of 4) +PASS: B (2 of 4) +FAIL: C (3 of 4) +******************** TEST 'C' FAILED ******************** +Test 'C' failed as a result of exit code 1. +******************** +PASS: D (4 of 4) + +=back + =head2 LIT EXAMPLE TESTS The B distribution contains several example implementations of test suites diff --git a/docs/CommandGuide/llc.pod b/docs/CommandGuide/llc.pod index 50b45c8..35abdae 100644 --- a/docs/CommandGuide/llc.pod +++ b/docs/CommandGuide/llc.pod @@ -45,7 +45,7 @@ Print a summary of command line options. =item B<-O>=I Generate code at different optimization levels. These correspond to the I<-O0>, -I<-O1>, I<-O2>, I<-O3>, and I<-O4> optimization levels used by B and +I<-O1>, I<-O2>, and I<-O3> optimization levels used by B and B. =item B<-mtriple>=I diff --git a/docs/CommandGuide/llvm-build.pod b/docs/CommandGuide/llvm-build.pod new file mode 100644 index 0000000..14e08cb --- /dev/null +++ b/docs/CommandGuide/llvm-build.pod @@ -0,0 +1,86 @@ +=pod + +=head1 NAME + +llvm-build - LLVM Project Build Utility + +=head1 SYNOPSIS + +B [I] + +=head1 DESCRIPTION + +B is a tool for working with LLVM projects that use the LLVMBuild +system for describing their components. + +At heart, B is responsible for loading, verifying, and manipulating +the project's component data. The tool is primarily designed for use in +implementing build systems and tools which need access to the project structure +information. + +=head1 OPTIONS + +=over + +=item B<-h>, B<--help> + +Print the builtin program help. + +=item B<--source-root>=I + +If given, load the project at the given source root path. If this option is not +given, the location of the project sources will be inferred from the location of +the B script itself. + +=item B<--print-tree> + +Print the component tree for the project. + +=item B<--write-library-table> + +Write out the C++ fragment which defines the components, library names, and +required libraries. This C++ fragment is built into L +in order to provide clients with the list of required libraries for arbitrary +component combinations. + +=item B<--write-llvmbuild> + +Write out new I files based on the loaded components. This is +useful for auto-upgrading the schema of the files. B will try to a +limited extent to preserve the comments which were written in the original +source file, although at this time it only preserves block comments that preceed +the section names in the I files. + +=item B<--write-cmake-fragment> + +Write out the LLVMBuild in the form of a CMake fragment, so it can easily be +consumed by the CMake based build system. The exact contents and format of this +file are closely tied to how LLVMBuild is integrated with CMake, see LLVM's +top-level CMakeLists.txt. + +=item B<--write-make-fragment> + +Write out the LLVMBuild in the form of a Makefile fragment, so it can easily be +consumed by a Make based build system. The exact contents and format of this +file are closely tied to how LLVMBuild is integrated with the Makefiles, see +LLVM's Makefile.rules. + +=item B<--llvmbuild-source-root>=I + +If given, expect the I files for the project to be rooted at the +given path, instead of inside the source tree itself. This option is primarily +designed for use in conjunction with B<--write-llvmbuild> to test changes to +I schema. + +=back + +=head1 EXIT STATUS + +B exits with 0 if operation was successful. Otherwise, it will exist +with a non-zero value. + +=head1 AUTHOR + +Maintained by the LLVM Team (L). + +=cut diff --git a/docs/CommandGuide/llvm-cov.pod b/docs/CommandGuide/llvm-cov.pod new file mode 100644 index 0000000..e8ff683 --- /dev/null +++ b/docs/CommandGuide/llvm-cov.pod @@ -0,0 +1,45 @@ +=pod + +=head1 NAME + +llvm-cov - emit coverage information + +=head1 SYNOPSIS + +B [-gcno=filename] [-gcda=filename] [dump] + +=head1 DESCRIPTION + +The experimental B tool reads in description file generated by compiler +and coverage data file generated by instrumented program. This program assumes +that the description and data file uses same format as gcov files. + +=head1 OPTIONS + +=over + +=item B<-gcno=filename] + +This option selects input description file generated by compiler while instrumenting +program. + +=item B<-gcda=filename] + +This option selects coverage data file generated by instrumented compiler. + +=item B<-dump> + +This options enables output dump that is suitable for a developer to help debug +B itself. + +=back + +=head1 EXIT STATUS + +B returns 1 if it cannot read input files. Otherwise, it exits with zero. + +=head1 AUTHOR + +B is maintained by the LLVM Team (L). + +=cut diff --git a/docs/CommandGuide/llvm-stress.pod b/docs/CommandGuide/llvm-stress.pod new file mode 100644 index 0000000..92083d2 --- /dev/null +++ b/docs/CommandGuide/llvm-stress.pod @@ -0,0 +1,42 @@ +=pod + +=head1 NAME + +llvm-stress - generate random .ll files + +=head1 SYNOPSIS + +B [-gcno=filename] [-gcda=filename] [dump] + +=head1 DESCRIPTION + +The B tool is used to generate random .ll files that can be used to +test different components of LLVM. + +=head1 OPTIONS + +=over + +=item B<-o> I + +Specify the output filename. + +=item B<-size> I + +Specify the size of the generated .ll file. + +=item B<-seed> I + +Specify the seed to be used for the randomly generated instructions. + +=back + +=head1 EXIT STATUS + +B returns 0. + +=head1 AUTHOR + +B is maintained by the LLVM Team (L). + +=cut diff --git a/docs/CommandGuide/tblgen.pod b/docs/CommandGuide/tblgen.pod index fe1be5e..180bcc1 100644 --- a/docs/CommandGuide/tblgen.pod +++ b/docs/CommandGuide/tblgen.pod @@ -41,6 +41,10 @@ Specify where to find other target description files for inclusion. The F value should be a full or partial path to a directory that contains target description files. +=item B<-asmparsernum> F + +Make -gen-asm-parser emit assembly writer number F. + =item B<-asmwriternum> F Make -gen-asm-writer emit assembly writer number F. @@ -57,38 +61,50 @@ Print all records to standard output (default). Print enumeration values for a class -=item B<-gen-emitter> +=item B<-print-sets> -Generate machine code emitter. +Print expanded sets for testing DAG exprs. -=item B<-gen-register-enums> +=item B<-gen-emitter> -Generate the enumeration values for all registers. +Generate machine code emitter. -=item B<-gen-register-desc> +=item B<-gen-register-info> -Generate a register info description for each register. +Generate registers and register classes info. -=item B<-gen-register-desc-header> +=item B<-gen-instr-info> -Generate a register info description header for each register. +Generate instruction descriptions. -=item B<-gen-instr-enums> +=item B<-gen-asm-writer> -Generate enumeration values for instructions. +Generate the assembly writer. -=item B<-gen-instr-desc> +=item B<-gen-disassembler> -Generate instruction descriptions. +Generate disassembler. -=item B<-gen-asm-writer> +=item B<-gen-pseudo-lowering> -Generate the assembly writer. +Generate pseudo instruction lowering. =item B<-gen-dag-isel> Generate a DAG (Directed Acycle Graph) instruction selector. +=item B<-gen-asm-matcher> + +Generate assembly instruction matcher. + +=item B<-gen-dfa-packetizer> + +Generate DFA Packetizer for VLIW targets. + +=item B<-gen-fast-isel> + +Generate a "fast" instruction selector. + =item B<-gen-subtarget> Generate subtarget enumerations. @@ -97,6 +113,14 @@ Generate subtarget enumerations. Generate intrinsic information. +=item B<-gen-tgt-intrinsic> + +Generate target intrinsic information. + +=item B<-gen-enhanced-disassembly-info> + +Generate enhanced disassembly info. + =item B<-version> Show the version number of this program. -- cgit v1.1