TBLGEN(1)

📦
version 16.0.6 · 3 versions
, in ubuntu noble

TBLGEN 💅✨

ok bestie, welcome to the tblgen family — part of LLVM, and it's giving compiler-girlboss energy 🎀

✨ NAME ✨

tblgen — Description to C++ Code 🦋

✨ SYNOPSIS ✨

clang-tblgen [options] [filename]

lldb-tblgen [options] [filename]

llvm-tblgen [options] [filename]

mlir-tblgen [options] [filename]

✨ DESCRIPTION ✨

okay so *-tblgen is literally a whole family of programs 🌈 that take target description files (.td files, bestie) and translate them into C++ code plus other output formats. no cap. 🫶

ngl, most people using LLVM will never need to touch this program. it's the backstage-pass situation — it's only used when you're writing parts of the compiler, the debugger, and the LLVM target backends. main character energy, but in a "you probably don't need me" way 😭

the actual details of what goes in and what comes out of the *-tblgen programs? way beyond the scope of this lil intro 💀 please go look at the TableGen Overview for an introduction and for pointers to more TableGen docs.

the filename argument specifies the name of the Target Description (.td) file that TableGen processes. periodt. 💅

✨ OPTIONS ✨

🌸 General Options 🌸

  • -help — Print a description of the command line options. 🫶
  • -help-list — Print a description of the command line options in a simple list format. cute and tidy ✨
  • -D=macroname — Specify the name of a macro to be defined. The name is defined, but it has no particular value. so it exists, it's just out here with no personality 😌
  • -d=filename — Specify the name of the dependency filename.
  • -debug — Enable debug output. 👀
  • -dump-json — Print a JSON representation of all records, suitable for further automated processing. for when you want machines to read your vibes 🤖
  • -I directory — 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.
  • -null-backend — Parse the source files and build the records, but do not run any backend. This is useful for timing the frontend. it does the reading and then just... doesn't do the homework 💀
  • -o filename — Specify the output file name. If filename is -, then *-tblgen sends its output to standard output.
  • -print-records — Print all classes and records to standard output (default backend option). the default, bestie 🎀
  • -print-detailed-records — Print a detailed report of all global variables, classes, and records to standard output. the ✨deluxe✨ version
  • -stats — Print a report with any statistics collected by the backend. 📊
  • -time-phases — Time the parser and backend phases and print a report. ⏱️
  • -version — Show the version number of the program.
  • -write-if-changed — Write the output file only if it is new or has changed. lowkey the politest option here 🫶

🎀 clang-tblgen Options 🎀

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

🦋 lldb-tblgen Options 🦋

heads up bestie, these ones are listed without a leading dash in the original — so we keep them exactly as they are 💜
  • gen-lldb-option-defs — Generate lldb OptionDefinition values.
  • gen-lldb-property-defs — Generate lldb PropertyDefinition values.
  • gen-lldb-property-enum-defs — Generate lldb PropertyDefinition enum values.

🔥 llvm-tblgen Options 🔥

  • -gen-asm-matcher — Generate assembly instruction matcher.
  • -match-prefix=prefix — Make -gen-asm-matcher match only instructions with the given prefix.
  • -gen-asm-parser — Generate assembly instruction parser.
  • -asmparsernum=n — Make -gen-asm-parser emit assembly parser number n.
  • -gen-asm-writer — Generate assembly writer.
  • -asmwriternum=n — Make -gen-asm-writer emit assembly writer number n.
  • -gen-attrs — Generate attributes.
  • -gen-automata — Generate generic automata.
  • -gen-callingconv — Generate calling convention descriptions.
  • -gen-compress-inst-emitter — Generate RISC-V compressed instructions.
  • -gen-ctags — Generate ctags-compatible index.
  • -gen-dag-isel — Generate a DAG (directed acyclic graph) instruction selector.
  • -instrument-coverage — Make -gen-dag-isel generate tables to help identify the patterns matched.
  • -omit-comments — Make -gen-dag-isel omit comments. The default is false.
  • -gen-dfa-packetizer — Generate DFA Packetizer for VLIW targets.
  • -gen-directive-decl — Generate directive related declaration code (header file).
  • -gen-directive-gen — Generate directive related implementation code part.
  • -gen-directive-impl — Generate directive related implementation code.
  • -gen-disassembler — Generate disassembler.
  • -gen-emitter — Generate machine code emitter.
  • -gen-exegesis — Generate llvm-exegesis tables.
  • -gen-fast-isel — Generate a “fast” instruction selector.
  • -gen-global-isel — Generate GlobalISel selector.
  • -gisel-coverage-file=filename — Specify the file from which to retrieve coverage information.
  • -instrument-gisel-coverage — Make -gen-global-isel generate coverage instrumentation.
  • -optimize-match-table — Make -gen-global-isel generate an optimized version of the match table.
  • -warn-on-skipped-patterns — Make -gen-global-isel explain why a pattern was skipped for inclusion.
  • -gen-global-isel-combiner — Generate GlobalISel combiner.
  • -combiners=list — Make -gen-global-isel-combiner emit the specified combiners.
  • -gicombiner-show-expansions — Make -gen-global-isel-combiner use C++ comments to indicate occurrences of code expansion.

and that's part 1 bestie… there's more coming, don't go anywhere 💖

  • -gicombiner-stop-after-build — makes -gen-global-isel-combiner stop processing right after it's built the match tree. like, done, no more ✋
  • -gicombiner-stop-after-parse — makes -gen-global-isel-combiner stop after parsing the rules and then dump state. early exit queen 💅
  • -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. so like, the prefix u want, bestie 🎀
  • -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. lil peek behind the curtain 🫣
  • -gen-searchable-tables — generate generic searchable tables. for the whole detailed rundown, go look at TableGen BackEnds, it's all there ✨
  • -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. it can be a readability and compile-time performance win, but ngl it upsets some compilers 😭
  • -print-enums — print enumeration values for a class.
  • *-class=classname* — makes -print-enums print the enumeration list for the class u specified. tell it which one bestie 👑
  • -print-sets — print expanded sets for testing DAG exprs.

✨ mlir-tblgen Options ✨

okay now we're in the mlir-tblgen era and the list keeps going, she's thorough 💖

  • -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. no chill, no mercy 💀
  • -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.
  • -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.

🌈 EXIT STATUS 🌈

if *-tblgen succeeds, it will exit with 0. slay, we love a clean exit 💅

otherwise, if an error occurs, it will exit with a non-zero value. and then u get to debug, which is its own journey bestie 😭

👑 AUTHOR 👑

maintained by the LLVM Team (https://llvm.org/). iconic behavior, fr fr 🫶

2003-2024, LLVM Project

and that's the whole page, no cap ✨ this was TBLGEN(1), version 15, dated 2024-04-14 — go forth and generate some tables, bestie, u got this 🦋🎀💜

📦 where this page comes from