TBLGEN(1)

📦
version 22.1.8 · 6 versions
, in fedora 44

💖 tblgen — Description to C++ Code 💖

okay bestie, buckle up, this is the LLVM manual page for the tblgen family, and she's a big one 🫶

✨ NAME ✨

tblgen — Description to C++ Code

🌸 SYNOPSIS 🌸

clang-tblgen [options] [filename]

lldb-tblgen [options] [filename]

llvm-tblgen [options] [filename]

mlir-tblgen [options] [filename]

🦋 DESCRIPTION 🦋

so *-tblgen is literally a whole family of programs 💅 they take target description files (.td files, iconic extension) and translate them into C++ code and other output formats. that's the whole vibe.

ngl, most people using LLVM will never need to touch this program. it's for writing parts of the compiler, the debugger, and the LLVM target backends. so if you're just out here compiling stuff, this ain't your moment 🙈

the details of what goes in and what comes out of the *-tblgen programs? that's beyond the scope of this short little intro, bestie. go check out the TableGen Overview for an introduction and for pointers to more TableGen docs. iykyk 📚✨

the filename argument specifies the name of the Target Description (.td) file that TableGen processes. that's it, that's the tea ☕

👑 OPTIONS 👑

🌈 General Options

  • -help — prints a description of the command line options. your classic "wait what do i do" button.
  • -help-list — same energy as -help but in a simple list format. no frills, just list.
  • -D=macroname — specifies the name of a macro to be defined. the name gets defined, but it has no particular value — it's giving "i exist and that's enough" 💀
  • -d=filename — specifies the name of the dependency filename.
  • -debug — enable debug output. the lights come on ✨
  • -dump-json — prints a JSON representation of all records, suitable for further automated processing. very slay for scripting.
  • -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. think of it as "girl where are your friends at" 💖
  • -null-backend — parses the source files and builds the records, but does not run any backend. useful for timing the frontend. it's the "just vibes, no output" mode.
  • -o filename — specifies the output file name. and here's the cute part: if filename is -, then *-tblgen sends its output to standard output. periodt.
  • -print-records — prints all classes and records to standard output. this is the default backend option, so she's the main character 👑
  • -print-detailed-records — prints a detailed report of all global variables, classes, and records to standard output. more detail, more drama.
  • -stats — prints a report with any statistics collected by the backend. numbers girlies rise 🍓
  • -time-phases — times the parser and backend phases and prints a report. clock it ⏱️
  • -version — shows the version number of the program.
  • -write-if-changed — writes the output file only if it is new or has changed. no unnecessary rewrites, she's efficient 💅

🎀 clang-tblgen Options 🎀

  • -gen-clang-attr-classes — generate Clang attribute classes.
  • -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. (yes bestie, the quote is in the original, we keep the lore intact 🙈)
  • -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-immcheck-types — generate arm_immcheck_types.inc 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-riscv-sifive-vector-builtins — generate riscv_sifive_vector_builtins.inc for Clang.
  • -gen-riscv-sifive-vector-builtin-codegen — generate riscv_sifive_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 written without leading dashes in the original, and we are keeping 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.

ok bestie that's where this part wraps 🌈 but we are not done — more of this manual is coming, so don't go anywhere 💖

  • -gen-global-isel-combiner — bestie this one generates the GlobalISel combiner. that's it, that's the job ✨
  • -combiners=list — makes -gen-global-isel-combiner emit the specific combiners you list out. you're the one picking, not the machine 💅
  • -gicombiner-debug-cxxpreds — sprinkles debug comments on every single C++ predicate that -gen-global-isel-combiner spits out. little notes for future you 🎀
  • -gicombiner-stop-after-parse — tells -gen-global-isel-combiner to stop doing stuff right after it parses the rules, and then dump the state. like pausing the movie to scream about the plot 🔥
  • -gen-instr-info — generates instruction descriptions. the lore drops here 📝
  • -gen-instr-docs — generates instruction documentation. for the people who actually read 😌
  • -gen-intrinsic-enums — generates intrinsic enums. enum era 💖
  • -intrinsic-prefix=prefix — makes -gen-intrinsic-enums generate intrinsics carrying this target prefix. so they know where they belong 🌸
  • -gen-intrinsic-impl — generates intrinsic information. the details, the tea 🫖
  • -gen-opt-parser-defs — generates options definitions. defined, periodt ✨
  • -gen-opt-rst — generates option RST. fancy formatted docs, we love to see it 💅
  • -gen-pseudo-lowering — generates pseudo instruction lowering. pseudos getting real 😭
  • -gen-register-bank — generates register bank descriptions. banks but make it registers 🏦
  • -gen-register-info — generates registers and register classes info. the full register lore dump 💜
  • -register-info-debug — makes -gen-register-info dump register information for debugging. peek behind the curtain 🫣
  • -gen-searchable-tables — generates generic searchable tables. and hey, for a detailed description go check out TableGen BackEnds <> — yes the manpage literally has empty angle brackets there, i'm not making it up 💀
  • -gen-subtarget — generates subtarget enumerations. sub-characters get their moment 🌈
  • -gen-x86-EVEX2VEX-tables — generates X86 EVEX to VEX compress tables. very specific, very x86 of it 🧚
  • -gen-x86-fold-tables — generates X86 fold tables. folding, but architectural ✨
  • -long-string-literals — when it's emitting big string tables, it'll prefer string literals over comma-separated char literals. can be a readability win and a compile-time performance win — but heads up bestie, it upsets some compilers 😬
fr fr, "upsets some compilers" is doing a lot of heavy lifting there. tread carefully.
  • -print-enums — prints enumeration values for a class. show me the numbers 🔢
  • -class=classname — makes -print-enums print the enumeration list for classname, the class you named. specificity is a love language 💅
  • -print-sets — prints expanded sets, for testing DAG exprs. test girlies rise 🎀

🌈 mlir-tblgen Options 🌈

okay so now we're in the mlir-tblgen era. different tool energy, same chaotic-genius vibe. let's go 💜

  • -gen-avail-interface-decls — generates availability interface declarations. decls first, always ✨
  • -gen-avail-interface-defs — generates op interface definitions. and then the defs show up 💖
  • -gen-dialect-doc — generates dialect documentation. docs, but for your dialect 🌸
  • -dialect — the dialect to generate. just... the dialect. your main character 🎀
  • -gen-directive-decl — generates declarations for directives (OpenMP, etc.). directives said their piece 📣
  • -gen-enum-decls — generates enum utility declarations. utility enum decls, slay 🦋
  • -gen-enum-defs — generates enum utility definitions. the sequel ✨
  • -gen-enum-from-llvmir-conversions — generates conversions of EnumAttrs from LLVM IR. coming from LLVM IR 🔥
  • -gen-enum-to-llvmir-conversions — generates conversions of EnumAttrs to LLVM IR. and going to LLVM IR. a round trip, iconic 💅
  • -gen-llvmir-conversions — generates LLVM IR conversions. general-purpose conversion generation 💜
  • -gen-llvmir-intrinsics — generates LLVM IR intrinsics. intrinsics, but LLVM IR flavored 🌟
  • -llvmir-intrinsics-filter — only keeps the intrinsics whose record name contains the substring you specify. filtering, but make it ✨selective✨
  • -dialect-opclass-base — the base class for the ops in the dialect we're about to emit. the blueprint, the blueprint 💖
  • -gen-op-decls — generates operation declarations. ops said hi 👋
  • -gen-op-defs — generates operation definitions. ops said it again, in full 🫶
  • -asmformat-error-is-fatal — emits a fatal error if format parsing fails. not a warning. fatal. the drama is the point 💀
  • -op-exclude-regex — regular expression of the names of ops to exclude (no filter if empty). bye felicia 👋
  • -op-include-regex — regular expression of the names of ops to include (no filter if empty). come here bestie 🫂
  • -gen-op-doc — generates operation documentation. op docs, get into it 📖
  • -gen-pass-decls — generates operation documentation. yes, the manpage really says "operation documentation" here too. i am reporting, not judging 🙈
  • -name namestring — the name of this group of passes. name it like you mean it, namestring 💅
  • -gen-pass-doc — generates pass documentation. pass the docs 🌈
  • -gen-rewriters — generates pattern rewriters. rewriting patterns, rewriting my whole personality 🎀
  • -gen-spirv-avail-impls — generates SPIR-V operation utility definitions. spir-v said "utility" and "definitions" twice in a row, look above 👀
  • -gen-spirv-capability-implication — generates a utility function that returns the implied capabilities for a given capability. implication station 🚂
  • -gen-spirv-enum-avail-decls — generates SPIR-V enum availability declarations. decls, spir-v style ✨
  • -gen-spirv-enum-avail-defs — generates SPIR-V enum availability definitions. and the defs, obviously 💖
  • -gen-spirv-op-utils — generates SPIR-V operation utility definitions. utility definitions, the remix 🦋
  • -gen-spirv-serialization — generates SPIR-V (de)serialization utilities and functions. both directions, balanced queen 👑
  • -gen-struct-attr-decls — generates struct utility declarations. structs, but useful 💜
  • -gen-struct-attr-defs — generates struct utility definitions. the definitions arc 🌸
  • -gen-typedef-decls — generates TypeDef declarations. typedef bestie 🎀
  • -gen-typedef-defs — generates TypeDef definitions. typedef part two ✨
  • -typedefs-dialect name — generates types for name, that dialect. tell it which dialect and it'll do the types 💅

💀 EXIT STATUS 💀

okay so if -tblgen succeeds, it exits with 0. and if an error happens? it exits with a non-zero value. that's the whole tea. simple. clean. no cap ✅

💖 Author 💖

Maintained by the LLVM Team (https://llvm.org/). they're out here keeping it running, respect 🫶

2003-2026, LLVM Project — a two-decade-plus run, that's longevity for real 🌈👑

and that's the page bestie!! it's from the LLVM crew, dated 2026-07-16, and it's giving very much "i know my toolchain" energy. go forth and tblgen responsibly 💖✨🎀

📦 where this page comes from