TBLGEN(1)

📦
version 15.0.7 · 7 versions
, in ubuntu jammy

TBLGEN(1) 💅 — the LLVM manual, bestie ✨

Okay so tblgen is literally the manual page for the *-tblgen family of programs. They translate target description (.td) files into C++ code and other output formats. Most LLVM users will not need this program — it’s only for writing parts of the compiler, debugger, and LLVM target backends, iykyk. 👑

🦋 SYNOPSIS 🦋

clang-tblgen [options] [filename]

lldb-tblgen [options] [filename]

llvm-tblgen [options] [filename]

mlir-tblgen [options] [filename]

💖 DESCRIPTION 💖

*-tblgen is a whole family of programs that translate 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, debugger, and LLVM target backends. No cap. 🫶

The details of the input and output of the *-tblgen programs is beyond the scope of this short introduction; please see the TableGen Overview for an introduction and for references to additional TableGen documents. 📚

The filename argument specifies the name of the Target Description (.td) file that TableGen processes. Slay. ✨

🎀 OPTIONS 🎀

🌸 General Options 🌸

  • -help — prints a description of the command-line options. Cute and useful.
  • -help-list — prints a description of the command-line options in a simple list format. List girlies stay winning.
  • -D=macroname — specifies the name of a macro to be defined. The name is defined, but it has no particular value. It’s giving “name only, no notes.”
  • -d=filename — specifies the name of the dependency filename.
  • -debug — enables debug output. Turn it on if you want the tea. 🍵
  • -dump-json — prints a JSON representation of all records, suitable for further automated processing.
  • -I directory — specifies 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.
  • -null-backend — parses the source files and builds the records, but does not run any backend. This is useful for timing the frontend.
  • -o filename — specifies the output file name. If filename is -, then *-tblgen sends its output to standard output.
  • -print-records — prints all classes and records to standard output (this is the default backend option).
  • -print-detailed-records — prints a detailed report of all global variables, classes, and records to standard output.
  • -stats — prints a report with any statistics collected by the backend.
  • -time-phases — times the parser and backend phases and prints a report.
  • -version — shows the version number of the program.
  • -write-if-changed — writes the output file only if it is new or has changed.

🎀 clang-tblgen Options 🎀

  • -gen-clang-attr-classes — generates Clang attribute classes.
  • -gen-clang-attr-parser-string-switches — generates all parser-related attribute string switches.
  • -gen-clang-attr-subject-match-rules-parser-string-switches — generates all parser-related attribute subject match rule string switches.
  • -gen-clang-attr-impl — generates Clang attribute implementations.
  • -gen-clang-attr-list" — generates a Clang attribute list. Yes, the trailing quote is part of the flag here. Preserve it, bestie. 🙈
  • -gen-clang-attr-subject-match-rule-list — generates a Clang attribute subject match rule list.
  • -gen-clang-attr-pch-read — generates Clang PCH attribute reader.
  • -gen-clang-attr-pch-write — generates Clang PCH attribute writer.
  • -gen-clang-attr-has-attribute-impl — generates a Clang attribute spelling list.
  • -gen-clang-attr-spelling-index — generates a Clang attribute spelling index.
  • -gen-clang-attr-ast-visitor — generates a recursive AST visitor for Clang attributes.
  • -gen-clang-attr-template-instantiate — generates Clang template instantiate code.
  • -gen-clang-attr-parsed-attr-list — generates a Clang parsed attribute list.
  • -gen-clang-attr-parsed-attr-impl — generates the Clang parsed attribute helpers.
  • -gen-clang-attr-parsed-attr-kinds — generates a Clang parsed attribute kinds.
  • -gen-clang-attr-text-node-dump — generates Clang attribute text node dumper.
  • -gen-clang-attr-node-traverse — generates Clang attribute traverser.
  • -gen-clang-diags-defs — generates Clang diagnostics definitions.
  • -clang-component component — only uses warnings from specified component.
  • -gen-clang-diag-groups — generates Clang diagnostic groups.
  • -gen-clang-diags-index-name — generates Clang diagnostic name index.
  • -gen-clang-basic-reader — generates Clang BasicReader classes.
  • -gen-clang-basic-writer — generates Clang BasicWriter classes.
  • -gen-clang-comment-nodes — generates Clang AST comment nodes.
  • -gen-clang-decl-nodes — generates Clang AST declaration nodes.
  • -gen-clang-stmt-nodes — generates Clang AST statement nodes.
  • -gen-clang-type-nodes — generates Clang AST type nodes.
  • -gen-clang-type-reader — generates Clang AbstractTypeReader class.
  • -gen-clang-type-writer — generates Clang AbstractTypeWriter class.
  • -gen-clang-opcodes — generates Clang constexpr interpreter opcodes.
  • -gen-clang-sa-checkers — generates Clang static analyzer checkers.
  • -gen-clang-comment-html-tags — generates efficient matchers for HTML tag names that are used in documentation comments.
  • -gen-clang-comment-html-tags-properties — generates efficient matchers for HTML tag properties.
  • -gen-clang-comment-html-named-character-references — generates function to translate named character references to UTF-8 sequences.
  • -gen-clang-comment-command-info — generates command properties for commands that are used in documentation comments.
  • -gen-clang-comment-command-list — generates list of commands that are used in documentation comments.
  • -gen-clang-opencl-builtins — generates OpenCL builtin declaration handlers.
  • -gen-arm-neon — generates arm_neon.h for Clang.
  • -gen-arm-fp16 — generates arm_fp16.h for Clang.
  • -gen-arm-bf16 — generates arm_bf16.h for Clang.
  • -gen-arm-neon-sema — generates ARM NEON sema support for Clang.
  • -gen-arm-neon-test — generates ARM NEON tests for Clang.
  • -gen-arm-sve-header — generates arm_sve.h for Clang.
  • -gen-arm-sve-builtins — generates arm_sve_builtins.inc for Clang.
  • -gen-arm-sve-builtin-codegen — generates arm_sve_builtin_cg_map.inc for Clang.
  • -gen-arm-sve-typeflags — generates arm_sve_typeflags.inc for Clang.
  • -gen-arm-sve-sema-rangechecks — generates arm_sve_sema_rangechecks.inc for Clang.
  • -gen-arm-mve-header — generates arm_mve.h for Clang.
  • -gen-arm-mve-builtin-def — generates ARM MVE builtin definitions for Clang.
  • -gen-arm-mve-builtin-sema — generates ARM MVE builtin sema checks for Clang.
  • -gen-arm-mve-builtin-codegen — generates ARM MVE builtin code-generator for Clang.
  • -gen-arm-mve-builtin-aliases — generates list of valid ARM MVE builtin aliases for Clang.
  • -gen-arm-cde-header — generates arm_cde.h for Clang.
  • -gen-arm-cde-builtin-def — generates ARM CDE builtin definitions for Clang.
  • -gen-arm-cde-builtin-sema — generates ARM CDE builtin sema checks for Clang.
  • -gen-arm-cde-builtin-codegen — generates ARM CDE builtin code-generator for Clang.
  • -gen-arm-cde-builtin-aliases — generates list of valid ARM CDE builtin aliases for Clang.
  • -gen-riscv-vector-header — generates riscv_vector.h for Clang.
  • -gen-riscv-vector-builtins — generates riscv_vector_builtins.inc for Clang.
  • -gen-riscv-vector-builtin-codegen — generates riscv_vector_builtin_cg.inc for Clang.
  • -gen-attr-docs — generates attribute documentation.
  • -gen-diag-docs — generates diagnostic documentation.
  • -gen-opt-docs — generates option documentation.
  • -gen-clang-data-collectors — generates data collectors for AST nodes.
  • -gen-clang-test-pragma-attribute-supported-attributes — generates a list of attributes supported by #pragma Clang attribute for testing purposes.

🦋 lldb-tblgen Options 🦋

  • gen-lldb-option-defs — generates lldb OptionDefinition values. No leading dash here, bestie — keep it exactly like this.
  • gen-lldb-property-defs — generates lldb PropertyDefinition values.
  • gen-lldb-property-enum-defs — generates lldb PropertyDefinition enum values.

🔥 llvm-tblgen Options 🔥

  • -gen-asm-matcher — generates assembly instruction matcher.
  • -match-prefix=prefix — makes -gen-asm-matcher match only instructions with the given prefix.
  • -gen-asm-parser — generates assembly instruction parser.
  • -asmparsernum=n — makes -gen-asm-parser emit assembly parser number n.
  • -gen-asm-writer — generates assembly writer.
  • -asmwriternum=n — makes -gen-asm-writer emit assembly writer number n.
  • -gen-attrs — generates attributes.
  • -gen-automata — generates generic automata.
  • -gen-callingconv — generates calling convention descriptions.
  • -gen-compress-inst-emitter — generates RISC-V compressed instructions.
  • -gen-ctags — generates ctags-compatible index.
  • -gen-dag-isel — generates a DAG (directed acyclic graph) instruction selector.
  • -instrument-coverage — makes -gen-dag-isel generate tables to help identify the patterns matched.
  • -omit-comments — makes -gen-dag-isel omit comments. The default is false.
  • -gen-dfa-packetizer — generates DFA Packetizer for VLIW targets.
  • -gen-directive-decl — generates directive related declaration code (header file).
  • -gen-directive-gen — generates directive related implementation code part.
  • -gen-directive-impl — generates directive related implementation code.
  • -gen-disassembler — generates disassembler.
  • -gen-emitter — generates machine code emitter.
  • -gen-exegesis — generates llvm-exegesis tables.
  • -gen-fast-isel — generates a “fast” instruction selector.
  • -gen-global-isel — generates GlobalISel selector.
  • -gisel-coverage-file=filename — specifies the file from which to retrieve coverage information.
  • -instrument-gisel-coverage — makes -gen-global-isel generate coverage instrumentation.
  • -optimize-match-table — makes -gen-global-isel generate an optimized version of the match table.
  • -warn-on-skipped-patterns — makes -gen-global-isel explain why a pattern was skipped for inclusion.
  • -gen-global-isel-combiner — generates GlobalISel combiner.
  • -combiners=list — makes -gen-global-isel-combiner emit the specified combiners.
  • -gicombiner-show-expansions — makes -gen-global-isel-combiner use C++ comments to indicate occurrences of code expansion.
  • -gicombiner-stop-after-build — makes -gen-global-isel-combiner stop processing right after it builds the match tree (basically a "ok we're done here" flag 💅).
  • -gicombiner-stop-after-parse — makes -gen-global-isel-combiner stop after parsing the rules and dump state — very "let me see what I'm working with first" of it.
  • -gen-instr-info — generate instruction descriptions.
  • -gen-instr-docs — generate instruction documentation.
  • -gen-intrinsic-enums — generate intrinsic enums.
  • -intrinsic-prefix=prefix — makes -gen-intrinsic-enums generate intrinsics with this target prefix.
  • -gen-intrinsic-impl — generate intrinsic information.
  • -gen-opt-parser-defs — generate options definitions.
  • -gen-opt-rst — generate option RST.
  • -gen-pseudo-lowering — generate pseudo instruction lowering.
  • -gen-register-bank — generate register bank descriptions.
  • -gen-register-info — generate registers and register classes info.
  • -register-info-debug — makes -gen-register-info dump register information for debugging 🐛.
  • -gen-searchable-tables — generate generic searchable tables. See TableGen BackEnds for a detailed description, iykyk.
  • -gen-subtarget — generate subtarget enumerations.
  • -gen-x86-EVEX2VEX-tables — generate X86 EVEX to VEX compress tables.
  • -gen-x86-fold-tables — generate X86 fold tables.
  • -long-string-literals — 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 😭 — so like, proceed with vibes checked.
  • -print-enums — print enumeration values for a class.
  • -class=classname — makes -print-enums print the enumeration list for the specified classname.
  • -print-sets — print expanded sets for testing DAG exprs.

🧚 mlir-tblgen Options 🧚

Bestie, this is the whole other flavor of the tool — same energy, different target 💖.

  • -gen-avail-interface-decls — generate availability interface declarations.
  • -gen-avail-interface-defs — generate op interface definitions.
  • -gen-dialect-doc — generate dialect documentation.
  • -dialect — the dialect to generate.
  • -gen-directive-decl — generate declarations for directives (OpenMP, etc.).
  • -gen-enum-decls — generate enum utility declarations.
  • -gen-enum-defs — generate enum utility definitions.
  • -gen-enum-from-llvmir-conversions — generate conversions of EnumAttrs from LLVM IR.
  • -gen-enum-to-llvmir-conversions — generate conversions of EnumAttrs to LLVM IR.
  • -gen-llvmir-conversions — generate LLVM IR conversions.
  • -gen-llvmir-intrinsics — generate LLVM IR intrinsics.
  • -llvmir-intrinsics-filter — only keep the intrinsics with the specified substring in their record name.
  • -dialect-opclass-base — the base class for the ops in the dialect we are to emit.
  • -gen-op-decls — generate operation declarations.
  • -gen-op-defs — generate operation definitions.
  • -asmformat-error-is-fatal — emit a fatal error if format parsing fails 💀.
  • -op-exclude-regex — regular expression of name of ops to exclude (no filter if empty).
  • -op-include-regex — regular expression of name of ops to include (no filter if empty).
  • -gen-op-doc — generate operation documentation.
  • -gen-pass-decls — generate operation documentation.
  • -name namestring — the name of this group of passes, as namestring.
  • -gen-pass-doc — generate pass documentation.
  • -gen-rewriters — generate pattern rewriters.
  • -gen-spirv-avail-impls — generate SPIR-V operation utility definitions.
  • -gen-spirv-capability-implication — generate utility function to return implied capabilities for a given capability.
  • -gen-spirv-enum-avail-decls — generate SPIR-V enum availability declarations.
  • -gen-spirv-enum-avail-defs — generate SPIR-V enum availability definitions.
  • -gen-spirv-op-utils — generate SPIR-V operation utility definitions.
  • -gen-spirv-serialization — generate SPIR-V (de)serialization utilities and functions.
  • -gen-struct-attr-decls — generate struct utility declarations.
  • -gen-struct-attr-defs — generate struct utility definitions.
  • -gen-typedef-decls — generate TypeDef declarations.
  • -gen-typedef-defs — generate TypeDef definitions.
  • -typedefs-dialect name — generate types for this dialect, name.

🌈 EXIT STATUS 🌈

If *-tblgen succeeds, it exits with 0 — slay, we love a clean exit 💅✨. Otherwise, if an error occurs, it exits with a non-zero value. That's the vibe check failing, bestie, no cap.

👑 AUTHOR 👑

Maintained by the LLVM Team (https://llvm.org/) — the actual main characters of this whole story, fr fr 🫶.

2003-2023, LLVM Project — iconic, legendary, the blueprint 💖.

And that's the whole page, bestie! 🦋 Go forth and generate all the things. This one's version 15, dated 2023-07-14, and it's filed under TBLGEN(1) — so if you ever forget, just remember: the girlies who read manpages together stay together ✨🌸💜

📦 where this page comes from