TBLGEN(1)

📦
version 21.1.8 · 7 versions
, in epel 10, fedora 43

💖 TBLGEN(1) 💖

LLVM · tblgen — Description to C++ Code

okay bestie, sit down, hydrate, because we're about to talk about one of the most behind-the-scenes little icons in the whole LLVM universe 🎀 she's not famous, she's not in your face, but literally half the compiler is built on her. her name is -tblgen and she eats .td files for breakfast 💅

✨ NAME ✨

tblgen — Description to C++ Code 🦋

🌸 SYNOPSIS 🌸

clang-tblgen [options] [filename]

lldb-tblgen [options] [filename]

llvm-tblgen [options] [filename]

mlir-tblgen [options] [filename]

four siblings, one vibe, four different jobs, all wearing the same [options] [filename] fit 🫶

💜 DESCRIPTION 💜

so *-tblgen is actually a whole family of programs, not just one. what they do is take target description files (that's the .td files, keep up bestie) and translate them into C++ code and other output formats. no cap.

and listen — most people using LLVM will never need to touch this program. it's not for you unless you're literally writing parts of the compiler, the debugger, or LLVM target backends. it's giving backstage pass only energy. iykyk.

the tea on exactly what goes in and what comes out of the *-tblgen programs is way beyond the scope of this short intro — that's the official word, not me being lazy — so if you want the real lore, go read the TableGen Overview for an introduction and for pointers to more TableGen docs 📚✨

and the filename argument? that's just the name of the Target Description (.td) file that TableGen processes. that's it. that's the whole job of that one little word 🎀

👑 OPTIONS 👑

🧚 General Options 🧚

these are the ones everybody gets, no matter which sibling you're running 💖

  • -help — prints a description of the command line options. the classic cry for help, but make it useful.
  • -help-list — same tea, but in a simple list format. streamlined, minimal, cute.
  • -D=macroname — names a macro to be defined. and yes, it gets defined, but it doesn't get any particular value. she's defined and valueless, and honestly? relatable 💀
  • -d=filename — tells it the name of the dependency filename.
  • -debug — turns on debug output. chaos mode, but make it informative 🔥
  • -dump-json — prints a JSON representation of all records, suitable for further automated processing. robots love this one 🤖✨
  • -I directory — tells it 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. your little include-hunting map 🗺️
  • -null-backend — parses the source files and builds the records, but does not run any backend. super useful for timing the frontend. all vibes, no output 💅
  • -o filename — sets the output file name. and if filename is -, then *-tblgen sends its output to standard output. dash means stdout, always has, always will 🫶
  • -print-records — prints all classes and records to standard output. this one is the default backend option, so if you don't pick anything, this is what you get 🎀
  • -print-detailed-records — prints a detailed report of all global variables, classes, and records to standard output. the deluxe version. the director's cut. 👑
  • -stats — prints a report with any statistics collected by the backend. numbers, bestie, numbers 📊
  • -time-phases — times the parser and backend phases and prints a report. stopwatch out, we're measuring 🕰️
  • -version — shows the version number of the program. who are you, where did you come from 🦋
  • -write-if-changed — writes the output file only if it is new or has changed. eco-friendly queen, no wasted writes ♻️

🎀 clang-tblgen Options 🎀

the clang sibling's personal stash. she has a lot of them and she's not sorry 💅

  • -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 stray " is in there, i don't make the rules, i just report them 🙈)
  • -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 a 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 use warnings from the specified component. picky, and honestly? valid.
  • -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 a 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 a 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-immcheck-types — generates arm_immcheck_types.inc 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 a 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 a 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-riscv-sifive-vector-builtins — generates riscv_sifive_vector_builtins.inc for Clang.
  • -gen-riscv-sifive-vector-builtin-codegen — generates riscv_sifive_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.
bestie that was like sixty options in a row, i hope you're still with me, drink some water 🍓

🌈 lldb-tblgen Options 🌈

the lldb sibling. only three options. she's mysterious, she's lowkey, she's unbothered, she's thriving 🦋

  • gen-lldb-option-defs — generates lldb OptionDefinition values.
  • gen-lldb-property-defs — generates lldb PropertyDefinition values.
  • gen-lldb-property-enum-defs — generates lldb PropertyDefinition enum values.

🔥 llvm-tblgen Options 🔥

the main character of the family. this is where the real machinery lives, bestie 💅

  • -gen-asm-matcher — generates assembly instruction matcher.
  • -match-prefix=prefix — makes -gen-asm-matcher match only instructions with the given prefix. filter, bestie, filter.
  • -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 a 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. (so by default, comments stay. they're staying. periodt.)
  • -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.

and that's the first half of the tea, bestie — there's more where that came from, don't go anywhere 🫶

  • -gen-global-isel-combiner — spits out the GlobalISel combiner. slay 💅
  • -combiners=list — tells -gen-global-isel-combiner which specific combiners to actually emit, from that list.
  • -gicombiner-debug-cxxpreds — drops debug comments on every single C++ predicate that -gen-global-isel-combiner emits. yes, all of them 🫶
  • -gicombiner-stop-after-parse — makes -gen-global-isel-combiner stop once it's done parsing rules, and dump the state. mid-character energy, honestly.
  • -gen-instr-info — generates instruction descriptions.
  • -gen-instr-docs — generates instruction documentation.
  • -gen-intrinsic-enums — generates intrinsic enums.
  • -intrinsic-prefix=prefix — makes -gen-intrinsic-enums generate intrinsics using this target prefix.
  • -gen-intrinsic-impl — generates intrinsic information.
  • -gen-opt-parser-defs — generates options definitions.
  • -gen-opt-rst — generates option RST.
  • -gen-pseudo-lowering — generates pseudo instruction lowering.
  • -gen-register-bank — generates register bank descriptions.
  • -gen-register-info — generates registers and register classes info.
  • -register-info-debug — makes -gen-register-info dump register information for debugging. detective mode 🔍
  • -gen-searchable-tables — generates generic searchable tables. peek at TableGen BackEnds for the full deets.
  • -gen-subtarget — generates subtarget enumerations.
  • -gen-x86-EVEX2VEX-tables — generates X86 EVEX to VEX compress tables.
  • -gen-x86-fold-tables — generates X86 fold tables.
  • -long-string-literals — when emitting big string tables, it prefers string literals over comma-separated char literals. this can be a readability and compile-time performance win, but it upsets some compilers 😭 (yes, fr, they get mad).
  • -print-enums — prints enumeration values for a class.
  • -class=classname — makes -print-enums print the enumeration list for that specific classname.
  • -print-sets — prints expanded sets, for testing DAG exprs.

mlir-tblgen Options 🌈

  • -gen-avail-interface-decls — generates availability interface declarations.
  • -gen-avail-interface-defs — generates op interface definitions.
  • -gen-dialect-doc — generates dialect documentation.
  • -dialect — the dialect to generate. the one and only 🎀
  • -gen-directive-decl — generates declarations for directives (OpenMP, etc.).
  • -gen-enum-decls — generates enum utility declarations.
  • -gen-enum-defs — generates enum utility definitions.
  • -gen-enum-from-llvmir-conversions — generates conversions of EnumAttrs from LLVM IR.
  • -gen-enum-to-llvmir-conversions — generates conversions of EnumAttrs to LLVM IR.
  • -gen-llvmir-conversions — generates LLVM IR conversions.
  • -gen-llvmir-intrinsics — generates LLVM IR intrinsics.
  • -llvmir-intrinsics-filter — only keeps the intrinsics whose record name contains the specified substring. filter them, bestie ✨
  • -dialect-opclass-base — the base class for the ops in the dialect we're about to emit.
  • -gen-op-decls — generates operation declarations.
  • -gen-op-defs — generates operation definitions.
  • -asmformat-error-is-fatal — emits a fatal error if format parsing fails. dramatic, but valid 💀
  • -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 — generates operation documentation.
  • -gen-pass-decls — generates operation documentation.
  • -name namestring — the name of this group of passes.
  • -gen-pass-doc — generates pass documentation.
  • -gen-rewriters — generates pattern rewriters.
  • -gen-spirv-avail-impls — generates SPIR-V operation utility definitions.
  • -gen-spirv-capability-implication — generates a utility function to return implied capabilities for a given capability.
  • -gen-spirv-enum-avail-decls — generates SPIR-V enum availability declarations.
  • -gen-spirv-enum-avail-defs — generates SPIR-V enum availability definitions.
  • -gen-spirv-op-utils — generates SPIR-V operation utility definitions.
  • -gen-spirv-serialization — generates SPIR-V (de)serialization utilities and functions.
  • -gen-struct-attr-decls — generates struct utility declarations.
  • -gen-struct-attr-defs — generates struct utility definitions.
  • -gen-typedef-decls — generates TypeDef declarations.
  • -gen-typedef-defs — generates TypeDef definitions.
  • -typedefs-dialect name — generate types for this dialect.

EXIT STATUS 💜

If -tblgen succeeds, it exits with 0 ✨. Otherwise, if an error happens, it exits with a non-zero value. simple as that, no notes.

AUTHOR 🫶

Maintained by the LLVM Team (https://llvm.org/). they're doing the lord's work, ngl.

2003-2026, LLVM Project

and that's the whole thing bestie, you officially understand TBLGEN(1) 💖 this page came straight from the LLVM Project's own docs, dated 2026-07-22, and it's version 21 energy all the way through. go generate something iconic 👑✨

📦 where this page comes from