maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity
llvm-project/llvm/docs/CommandGuide/tblgen.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

711 lines
15 KiB
ReStructuredText
Raw Normal View History

[TableGen] Command description file requires a hyphen in document title.
2020-10-28 21:30:10 +08:00
xxx-tblgen - Target Description to C++ Code
===========================================
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[docs][tools] Add missing "program" tags to rst files Sphinx allows for definitions of command-line options using `.. option <name>` and references to those options via `:option:<name>`. However, it looks like there is no scoping of these options by default, meaning that links can end up pointing to incorrect documents. See for example the llvm-mca document, which contains references to -o that, prior to this patch, pointed to a different document. What's worse is that these links appear to be non-deterministic in which one is picked (on my machine, some references end up pointing to opt, whereas on the live docs, they point to llvm-dwarfdump, for example). The fix is to add the .. program <name> tag. This essentially namespaces the options (definitions and references) to the named program, ensuring that the links are kept correct. Reviwed by: andreadb Differential Revision: https://reviews.llvm.org/D63873 llvm-svn: 364538
2019-06-27 21:24:46 +08:00
.. program:: tblgen
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
SYNOPSIS
--------
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
:program:`xxx-tblgen` [*options*] [*filename*]
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
DESCRIPTION
-----------
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
:program:`xxx-tblgen` is a family of programs that translates target
description (``.td``) files into C++ code and other output formats. Most
users of LLVM will not need to use this program. It is used only for
writing parts of the compiler or LLVM target backends.
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
The details of the input and output of :program:`xxx-tblgen` is beyond the
scope of this short introduction; please see the :doc:`TableGen Overview
<../TableGen/index>` for an introduction and for references to additional
TableGen documents.
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
The *filename* argument specifies the name of the Target Description (``.td``)
file that TableGen processes.
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
OPTIONS
-------
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
General Options
~~~~~~~~~~~~~~~
Documentation: end option description with a period Patch by Dimitry Andric. llvm-svn: 180675
2013-04-28 00:34:24 +08:00
Documentation for tblgen: formatting llvm-svn: 168904
2012-11-30 01:41:05 +08:00
.. option:: -help
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Improve a couple of descriptions in the command guide Differential Revision: https://reviews.llvm.org/D91484
2020-11-15 05:11:15 +08:00
Print a description of the command line options.
.. option:: -help-list
Print a description of the command line options in a simple list format.
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
.. option:: -D=macroname
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
Specify the name of a macro to be defined. The name is defined, but it
has no particular value.
.. option:: -d=filename
Specify the name of the dependency filename.
[TableGen] Add frontend/backend phase timing capability. Describe in the BackEnd Developer's Guide. Instrument a few backends. Remove an old unused timing facility. Add a null backend for timing the parser. Differential Revision: https://reviews.llvm.org/D91388
2020-10-22 14:58:49 +08:00
.. option:: -debug
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
Enable debug output.
.. option:: -dump-json
Print a JSON representation of all records, suitable for further
automated processing.
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
Documentation for tblgen: formatting llvm-svn: 168904
2012-11-30 01:41:05 +08:00
.. option:: -I directory
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
Documentation for tblgen: formatting llvm-svn: 168904
2012-11-30 01:41:05 +08:00
Specify where to find other target description files for inclusion. The
``directory`` value should be a full or partial path to a directory that
contains target description files.
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Add frontend/backend phase timing capability. Describe in the BackEnd Developer's Guide. Instrument a few backends. Remove an old unused timing facility. Add a null backend for timing the parser. Differential Revision: https://reviews.llvm.org/D91388
2020-10-22 14:58:49 +08:00
.. option:: -null-backend
Parse the source files and build the records, but do not run any
backend. This is useful for timing the frontend.
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
.. option:: -o filename
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
Specify the output file name. If ``filename`` is ``-``, then
:program:`xxx-tblgen` sends its output to standard output.
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
.. option:: -print-records
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Add frontend/backend phase timing capability. Describe in the BackEnd Developer's Guide. Instrument a few backends. Remove an old unused timing facility. Add a null backend for timing the parser. Differential Revision: https://reviews.llvm.org/D91388
2020-10-22 14:58:49 +08:00
Print all classes and records to standard output (default backend option).
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
.. option:: -print-detailed-records
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
Print a detailed report of all global variables, classes, and records
to standard output.
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Add frontend/backend phase timing capability. Describe in the BackEnd Developer's Guide. Instrument a few backends. Remove an old unused timing facility. Add a null backend for timing the parser. Differential Revision: https://reviews.llvm.org/D91388
2020-10-22 14:58:49 +08:00
.. option:: -stats
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Improve a couple of descriptions in the command guide Differential Revision: https://reviews.llvm.org/D91484
2020-11-15 05:11:15 +08:00
Print a report with any statistics collected by the backend.
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Add frontend/backend phase timing capability. Describe in the BackEnd Developer's Guide. Instrument a few backends. Remove an old unused timing facility. Add a null backend for timing the parser. Differential Revision: https://reviews.llvm.org/D91388
2020-10-22 14:58:49 +08:00
.. option:: -time-phases
Time the parser and backend phases and print a report.
[TableGen] Improve a couple of descriptions in the command guide Differential Revision: https://reviews.llvm.org/D91484
2020-11-15 05:11:15 +08:00
.. option:: -version
Show the version number of the program.
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
.. option:: -write-if-changed
[TableGen] Add a general-purpose JSON backend. The aim of this backend is to output everything TableGen knows about the record set, similarly to the default -print-records backend. But where -print-records produces output in TableGen's input syntax (convenient for humans to read), this backend produces it as structured JSON data, which is convenient for loading into standard scripting languages such as Python, in order to extract information from the data set in an automated way. The output data contains a JSON representation of the variable definitions in output 'def' records, and a few pieces of metadata such as which of those definitions are tagged with the 'field' prefix and which defs are derived from which classes. It doesn't dump out absolutely every piece of knowledge it _could_ produce, such as type information and complicated arithmetic operator nodes in abstract superclasses; the main aim is to allow consumers of this JSON dump to essentially act as new backends, and backends don't generally need to depend on that kind of data. The new backend is implemented as an EmitJSON() function similar to all of llvm-tblgen's other EmitFoo functions, except that it lives in lib/TableGen instead of utils/TableGen on the basis that I'm expecting to add it to clang-tblgen too in a future patch. To test it, I've written a Python script that loads the JSON output and tests properties of it based on comments in the .td source - more or less like FileCheck, except that the CHECK: lines have Python expressions after them instead of textual pattern matches. Reviewers: nhaehnle Reviewed By: nhaehnle Subscribers: arichardson, labath, mgorny, llvm-commits Differential Revision: https://reviews.llvm.org/D46054 llvm-svn: 336771
2018-07-11 16:40:19 +08:00
[TableGen] Add frontend/backend phase timing capability. Describe in the BackEnd Developer's Guide. Instrument a few backends. Remove an old unused timing facility. Add a null backend for timing the parser. Differential Revision: https://reviews.llvm.org/D91388
2020-10-22 14:58:49 +08:00
Write the output file only if it is new or has changed.
[TableGen] Add a general-purpose JSON backend. The aim of this backend is to output everything TableGen knows about the record set, similarly to the default -print-records backend. But where -print-records produces output in TableGen's input syntax (convenient for humans to read), this backend produces it as structured JSON data, which is convenient for loading into standard scripting languages such as Python, in order to extract information from the data set in an automated way. The output data contains a JSON representation of the variable definitions in output 'def' records, and a few pieces of metadata such as which of those definitions are tagged with the 'field' prefix and which defs are derived from which classes. It doesn't dump out absolutely every piece of knowledge it _could_ produce, such as type information and complicated arithmetic operator nodes in abstract superclasses; the main aim is to allow consumers of this JSON dump to essentially act as new backends, and backends don't generally need to depend on that kind of data. The new backend is implemented as an EmitJSON() function similar to all of llvm-tblgen's other EmitFoo functions, except that it lives in lib/TableGen instead of utils/TableGen on the basis that I'm expecting to add it to clang-tblgen too in a future patch. To test it, I've written a Python script that loads the JSON output and tests properties of it based on comments in the .td source - more or less like FileCheck, except that the CHECK: lines have Python expressions after them instead of textual pattern matches. Reviewers: nhaehnle Reviewed By: nhaehnle Subscribers: arichardson, labath, mgorny, llvm-commits Differential Revision: https://reviews.llvm.org/D46054 llvm-svn: 336771
2018-07-11 16:40:19 +08:00
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
llvm-tblgen Options
~~~~~~~~~~~~~~~~~~~
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
.. option:: -gen-asm-matcher
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
Generate assembly instruction matcher.
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
.. option:: -match-prefix=prefix
Make -gen-asm-matcher match only instructions with the given *prefix*.
.. option:: -gen-asm-parser
Generate assembly instruction parser.
.. option:: -asmparsernum=n
Make -gen-asm-parser emit assembly parser number *n*.
.. option:: -gen-asm-writer
Generate assembly writer.
.. option:: -asmwriternum=n
Make -gen-asm-writer emit assembly writer number *n*.
.. option:: -gen-attrs
[llvm] Fix typos in documentation (NFC)
2021-02-28 02:09:23 +08:00
Generate attributes.
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
.. option:: -gen-automata
Generate generic automata.
.. option:: -gen-callingconv
Generate calling convention descriptions.
.. option:: -gen-compress-inst-emitter
[Docs] Fix Typo
2021-02-09 15:43:32 +08:00
Generate RISC-V compressed instructions.
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
.. option:: -gen-ctags
Generate ctags-compatible index.
.. option:: -gen-dag-isel
Generate a DAG (directed acyclic graph) instruction selector.
.. option:: -instrument-coverage
Make -gen-dag-isel generate tables to help identify the patterns matched.
.. option:: -omit-comments
Make -gen-dag-isel omit comments. The default is false.
.. option:: -gen-dfa-packetizer
Generate DFA Packetizer for VLIW targets.
.. option:: -gen-directive-decl
Generate directive related declaration code (header file).
.. option:: -gen-directive-gen
Generate directive related implementation code part.
.. option:: -gen-directive-impl
Generate directive related implementation code.
.. option:: -gen-disassembler
Generate disassembler.
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
Documentation for tblgen: formatting llvm-svn: 168904
2012-11-30 01:41:05 +08:00
.. option:: -gen-emitter
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
Generate machine code emitter.
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
.. option:: -gen-exegesis
Generate llvm-exegesis tables.
.. option:: -gen-fast-isel
Generate a "fast" instruction selector.
.. option:: -gen-global-isel
Generate GlobalISel selector.
.. option:: -gisel-coverage-file=filename
Specify the file from which to retrieve coverage information.
.. option:: -instrument-gisel-coverage
Make -gen-global-isel generate coverage instrumentation.
.. option:: -optimize-match-table
Make -gen-global-isel generate an optimized version of the match table.
.. option:: -warn-on-skipped-patterns
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
Make -gen-global-isel explain why a pattern was skipped for inclusion.
.. option:: -gen-global-isel-combiner
Generate GlobalISel combiner.
.. option:: -combiners=list
Make -gen-global-isel-combiner emit the specified combiners.
.. option:: -gicombiner-show-expansions
[llvm] Fix typos in documentation (NFC)
2021-02-28 02:09:23 +08:00
Make -gen-global-isel-combiner use C++ comments to indicate occurrences
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
of code expansion.
.. option:: -gicombiner-stop-after-build
Make -gen-global-isel-combiner stop processing after building the match tree.
.. option:: -gicombiner-stop-after-parse
Make -gen-global-isel-combiner stop processing after parsing rules
and dump state.
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
Documentation for tblgen: formatting llvm-svn: 168904
2012-11-30 01:41:05 +08:00
.. option:: -gen-instr-info
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
Generate instruction descriptions.
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
.. option:: -gen-instr-docs
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
Generate instruction documentation.
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
.. option:: -gen-intrinsic-enums
Generate intrinsic enums.
.. option:: -intrinsic-prefix=prefix
Make -gen-intrinsic-enums generate intrinsics with this target *prefix*.
.. option:: -gen-intrinsic-impl
Generate intrinsic information.
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
.. option:: -gen-opt-parser-defs
Generate options definitions.
.. option:: -gen-opt-rst
Generate option RST.
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
Documentation for tblgen: formatting llvm-svn: 168904
2012-11-30 01:41:05 +08:00
.. option:: -gen-pseudo-lowering
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
Generate pseudo instruction lowering.
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
.. option:: -gen-register-bank
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
Generate register bank descriptions.
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
.. option:: -gen-register-info
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
Generate registers and register classes info.
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
.. option:: -register-info-debug
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
Make -gen-register-info dump register information for debugging.
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
.. option:: -gen-searchable-tables
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[docs] Fix docs-llvm-html after recent TableGen changes D90617
2020-11-04 05:43:24 +08:00
Generate generic searchable tables. See :doc:`TableGen BackEnds <../TableGen/BackEnds>`
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
for a detailed description.
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
Documentation for tblgen: formatting llvm-svn: 168904
2012-11-30 01:41:05 +08:00
.. option:: -gen-subtarget
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
Generate subtarget enumerations.
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
.. option:: -gen-x86-EVEX2VEX-tables
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
Generate X86 EVEX to VEX compress tables.
[docs] Update doc after split of -gen-intrinsic in r335407 llvm-svn: 335515
2018-06-26 03:40:08 +08:00
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
.. option:: -gen-x86-fold-tables
Generate X86 fold tables.
.. option:: -long-string-literals
[docs] Update doc after split of -gen-intrinsic in r335407 llvm-svn: 335515
2018-06-26 03:40:08 +08:00
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
When emitting large string tables, prefer string literals over
comma-separated char literals. This can be a readability and
compile-time performance win, but upsets some compilers.
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
.. option:: -print-enums
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
Print enumeration values for a class.
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
.. option:: -class=classname
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
Make -print-enums print the enumeration list for the specified class.
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
.. option:: -print-sets
[MCSched] Bind PFM Counters to the CPUs instead of the SchedModel. Summary: The pfm counters are now in the ExegesisTarget rather than the MCSchedModel (PR39165). This also compresses the pfm counter tables (PR37068). Reviewers: RKSimon, gchatelet Subscribers: mgrang, llvm-commits Differential Revision: https://reviews.llvm.org/D52932 llvm-svn: 345243
2018-10-25 15:44:01 +08:00
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
Print expanded sets for testing DAG exprs.
[MCSched] Bind PFM Counters to the CPUs instead of the SchedModel. Summary: The pfm counters are now in the ExegesisTarget rather than the MCSchedModel (PR39165). This also compresses the pfm counter tables (PR37068). Reviewers: RKSimon, gchatelet Subscribers: mgrang, llvm-commits Differential Revision: https://reviews.llvm.org/D52932 llvm-svn: 345243
2018-10-25 15:44:01 +08:00
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
clang-tblgen Options
~~~~~~~~~~~~~~~~~~~~
.. option:: -gen-clang-attr-classes
Generate Clang attribute clases.
.. option:: -gen-clang-attr-parser-string-switches
Generate all parser-related attribute string switches.
.. option:: -gen-clang-attr-subject-match-rules-parser-string-switches
Generate all parser-related attribute subject match rule string switches.
.. option:: -gen-clang-attr-impl
Generate Clang attribute implementations.
.. option:: -gen-clang-attr-list"
Generate a Clang attribute list.
.. option:: -gen-clang-attr-subject-match-rule-list
Generate a Clang attribute subject match rule list.
.. option:: -gen-clang-attr-pch-read
Generate Clang PCH attribute reader.
.. option:: -gen-clang-attr-pch-write
Generate Clang PCH attribute writer.
.. option:: -gen-clang-attr-has-attribute-impl
Generate a Clang attribute spelling list.
.. option:: -gen-clang-attr-spelling-index
Generate a Clang attribute spelling index.
.. option:: -gen-clang-attr-ast-visitor
Generate a recursive AST visitor for Clang attributes.
.. option:: -gen-clang-attr-template-instantiate
Generate a Clang template instantiate code.
.. option:: -gen-clang-attr-parsed-attr-list
Generate a Clang parsed attribute list.
.. option:: -gen-clang-attr-parsed-attr-impl
Generate the Clang parsed attribute helpers.
.. option:: -gen-clang-attr-parsed-attr-kinds
Generate a Clang parsed attribute kinds.
.. option:: -gen-clang-attr-text-node-dump
Generate Clang attribute text node dumper.
.. option:: -gen-clang-attr-node-traverse
Generate Clang attribute traverser.
.. option:: -gen-clang-diags-defs
Generate Clang diagnostics definitions.
.. option:: -clang-component component
Only use warnings from specified component.
.. option:: -gen-clang-diag-groups
Generate Clang diagnostic groups.
.. option:: -gen-clang-diags-index-name
Generate Clang diagnostic name index.
.. option:: -gen-clang-basic-reader
Generate Clang BasicReader classes.
.. option:: -gen-clang-basic-writer
Generate Clang BasicWriter classes.
.. option:: -gen-clang-comment-nodes
Generate Clang AST comment nodes.
.. option:: -gen-clang-decl-nodes
Generate Clang AST declaration nodes.
.. option:: -gen-clang-stmt-nodes
Generate Clang AST statement nodes.
.. option:: -gen-clang-type-nodes
Generate Clang AST type nodes.
.. option:: -gen-clang-type-reader
Generate Clang AbstractTypeReader class.
.. option:: -gen-clang-type-writer
Generate Clang AbstractTypeWriter class.
.. option:: -gen-clang-opcodes
Generate Clang constexpr interpreter opcodes.
.. option:: -gen-clang-sa-checkers
Generate Clang static analyzer checkers.
.. option:: -gen-clang-comment-html-tags
Generate efficient matchers for HTML tag names that are used in
documentation comments.
.. option:: -gen-clang-comment-html-tags-properties
Generate efficient matchers for HTML tag properties.
.. option:: -gen-clang-comment-html-named-character-references
Generate function to translate named character references to UTF-8 sequences.
.. option:: -gen-clang-comment-command-info
Generate command properties for commands that are used in documentation comments.
.. option:: -gen-clang-comment-command-list
Generate list of commands that are used in documentation comments.
.. option:: -gen-clang-opencl-builtins
Generate OpenCL builtin declaration handlers.
.. option:: -gen-arm-neon
Generate ``arm_neon.h`` for Clang.
.. option:: -gen-arm-fp16
Generate ``arm_fp16.h`` for Clang.
.. option:: -gen-arm-bf16
Generate ``arm_bf16.h`` for Clang.
.. option:: -gen-arm-neon-sema
Generate ARM NEON sema support for Clang.
.. option:: -gen-arm-neon-test
Generate ARM NEON tests for Clang.
.. option:: -gen-arm-sve-header
Generate ``arm_sve.h`` for Clang.
.. option:: -gen-arm-sve-builtins
Generate ``arm_sve_builtins.inc`` for Clang.
.. option:: -gen-arm-sve-builtin-codegen
Generate ``arm_sve_builtin_cg_map.inc`` for Clang.
.. option:: -gen-arm-sve-typeflags
Generate ``arm_sve_typeflags.inc`` for Clang.
.. option:: -gen-arm-sve-sema-rangechecks
Generate ``arm_sve_sema_rangechecks.inc`` for Clang.
.. option:: -gen-arm-mve-header
Generate ``arm_mve.h`` for Clang.
.. option:: -gen-arm-mve-builtin-def
Generate ARM MVE builtin definitions for Clang.
.. option:: -gen-arm-mve-builtin-sema
Generate ARM MVE builtin sema checks for Clang.
.. option:: -gen-arm-mve-builtin-codegen
Generate ARM MVE builtin code-generator for Clang.
.. option:: -gen-arm-mve-builtin-aliases
Generate list of valid ARM MVE builtin aliases for Clang.
.. option:: -gen-arm-cde-header
Generate ``arm_cde.h`` for Clang.
.. option:: -gen-arm-cde-builtin-def
Generate ARM CDE builtin definitions for Clang.
.. option:: -gen-arm-cde-builtin-sema
Generate ARM CDE builtin sema checks for Clang.
.. option:: -gen-arm-cde-builtin-codegen
Generate ARM CDE builtin code-generator for Clang.
.. option:: -gen-arm-cde-builtin-aliases
Generate list of valid ARM CDE builtin aliases for Clang.
.. option:: -gen-attr-docs
Generate attribute documentation.
.. option:: -gen-diag-docs
Generate diagnostic documentation.
.. option:: -gen-opt-docs
Generate option documentation.
.. option:: -gen-clang-data-collectors
Generate data collectors for AST nodes.
.. option:: -gen-clang-test-pragma-attribute-supported-attributes
Generate a list of attributes supported by ``#pragma`` Clang attribute for
testing purposes.
mlir-tblgen Options
~~~~~~~~~~~~~~~~~~~
.. option:: -gen-avail-interface-decls
Generate availability interface declarations.
.. option:: -gen-avail-interface-defs
Generate op interface definitions.
.. option:: -gen-dialect-doc
Generate dialect documentation.
.. option:: -dialect
The dialect to generate.
.. option:: -gen-directive-decl
Generate declarations for directives (OpenMP, etc.).
.. option:: -gen-enum-decls
Generate enum utility declarations.
.. option:: -gen-enum-defs
Generate enum utility definitions.
.. option:: -gen-enum-from-llvmir-conversions
Generate conversions of EnumAttrs from LLVM IR.
.. option:: -gen-enum-to-llvmir-conversions
Generate conversions of EnumAttrs to LLVM IR.
.. option:: -gen-llvmir-conversions
Generate LLVM IR conversions.
.. option:: -gen-llvmir-intrinsics
Generate LLVM IR intrinsics.
.. option:: -llvmir-intrinsics-filter
Only keep the intrinsics with the specified substring in their record name.
.. option:: -dialect-opclass-base
The base class for the ops in the dialect we are to emit.
.. option:: -gen-op-decls
Generate operation declarations.
.. option:: -gen-op-defs
Generate operation definitions.
.. option:: -asmformat-error-is-fatal
Emit a fatal error if format parsing fails.
.. option:: -op-exclude-regex
Regular expression of name of ops to exclude (no filter if empty).
.. option:: -op-include-regex
Regular expression of name of ops to include (no filter if empty).
.. option:: -gen-op-doc
Generate operation documentation.
.. option:: -gen-pass-decls
Generate operation documentation.
.. option:: -name namestring
The name of this group of passes.
.. option:: -gen-pass-doc
Generate pass documentation.
.. option:: -gen-rewriters
Generate pattern rewriters.
.. option:: -gen-spirv-avail-impls
Generate SPIR-V operation utility definitions.
.. option:: -gen-spirv-capability-implication
Generate utility function to return implied capabilities for a given capability.
.. option:: -gen-spirv-enum-avail-decls
Generate SPIR-V enum availability declarations.
.. option:: -gen-spirv-enum-avail-defs
Generate SPIR-V enum availability definitions.
.. option:: -gen-spirv-op-utils
Generate SPIR-V operation utility definitions.
.. option:: -gen-spirv-serialization
Generate SPIR-V (de)serialization utilities and functions.
.. option:: -gen-struct-attr-decls
Generate struct utility declarations.
.. option:: -gen-struct-attr-defs
Generate struct utility definitions.
.. option:: -gen-typedef-decls
Generate TypeDef declarations.
.. option:: -gen-typedef-defs
Generate TypeDef definitions.
.. option:: -typedefs-dialect name
Generate types for this dialect.
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
EXIT STATUS
-----------
[TableGen] Update xxx-tblgen command document. Add a few cross-references among TableGen documents. Differential Revision: https://reviews.llvm.org/D90186 Add cross-references between TableGen documents.
2020-10-24 23:08:22 +08:00
If :program:`xxx-tblgen` succeeds, it will exit with 0. Otherwise, if an error
[docs] Add ReST version of all the man pages. - The POD versions are slated for execution, but are still around until llvm.org machinery is in place. llvm-svn: 156384
2012-05-09 00:50:35 +08:00
occurs, it will exit with a non-zero value.