Blame - docs/CommandGuide/tblgen.rst - fp2-dev/platform/external/llvm

blob: 1c4682830d188393e63823773903ae4ca327ade1 [file] [log] [blame]

Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	1	tblgen - Target Description To C++ Code Generator
				2	=================================================
				3
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	4	SYNOPSIS
				5	--------
				6
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	7	:program:`tblgen` [options] [filename]
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	8
				9	DESCRIPTION
				10	-----------
				11
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	12	:program:`tblgen` translates from target description (``.td``) files into C++
				13	code that can be included in the definition of an LLVM target library. Most
				14	users of LLVM will not need to use this program. It is only for assisting with
				15	writing an LLVM target backend.
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	16
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	17	The input and output of :program:`tblgen` is beyond the scope of this short
				18	introduction. Please see :doc:`../TableGenFundamentals`.
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	19
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	20	The filename argument specifies the name of a Target Description (``.td``)
				21	file to read as input.
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	22
				23	OPTIONS
				24	-------
				25
Dmitri Gribenko	595dd5a	2013-04-27 16:34:24 +0000	[diff] [blame]	26	.. program:: tblgen
				27
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	28	.. option:: -help
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	29
				30	Print a summary of command line options.
				31
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	32	.. option:: -o filename
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	33
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	34	Specify the output file name. If ``filename`` is ``-``, then
				35	:program:`tblgen` sends its output to standard output.
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	36
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	37	.. option:: -I directory
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	38
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	39	Specify where to find other target description files for inclusion. The
				40	``directory`` value should be a full or partial path to a directory that
				41	contains target description files.
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	42
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	43	.. option:: -asmparsernum N
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	44
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	45	Make -gen-asm-parser emit assembly writer number ``N``.
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	46
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	47	.. option:: -asmwriternum N
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	48
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	49	Make -gen-asm-writer emit assembly writer number ``N``.
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	50
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	51	.. option:: -class className
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	52
				53	Print the enumeration list for this class.
				54
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	55	.. option:: -print-records
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	56
				57	Print all records to standard output (default).
				58
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	59	.. option:: -print-enums
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	60
Dmitri Gribenko	595dd5a	2013-04-27 16:34:24 +0000	[diff] [blame]	61	Print enumeration values for a class.
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	62
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	63	.. option:: -print-sets
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	64
				65	Print expanded sets for testing DAG exprs.
				66
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	67	.. option:: -gen-emitter
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	68
				69	Generate machine code emitter.
				70
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	71	.. option:: -gen-register-info
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	72
				73	Generate registers and register classes info.
				74
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	75	.. option:: -gen-instr-info
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	76
				77	Generate instruction descriptions.
				78
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	79	.. option:: -gen-asm-writer
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	80
				81	Generate the assembly writer.
				82
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	83	.. option:: -gen-disassembler
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	84
				85	Generate disassembler.
				86
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	87	.. option:: -gen-pseudo-lowering
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	88
				89	Generate pseudo instruction lowering.
				90
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	91	.. option:: -gen-dag-isel
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	92
				93	Generate a DAG (Directed Acycle Graph) instruction selector.
				94
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	95	.. option:: -gen-asm-matcher
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	96
				97	Generate assembly instruction matcher.
				98
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	99	.. option:: -gen-dfa-packetizer
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	100
				101	Generate DFA Packetizer for VLIW targets.
				102
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	103	.. option:: -gen-fast-isel
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	104
				105	Generate a "fast" instruction selector.
				106
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	107	.. option:: -gen-subtarget
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	108
				109	Generate subtarget enumerations.
				110
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	111	.. option:: -gen-intrinsic
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	112
				113	Generate intrinsic information.
				114
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	115	.. option:: -gen-tgt-intrinsic
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	116
				117	Generate target intrinsic information.
				118
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	119	.. option:: -gen-enhanced-disassembly-info
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	120
				121	Generate enhanced disassembly info.
				122
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	123	.. option:: -version
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	124
				125	Show the version number of this program.
				126
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	127	EXIT STATUS
				128	-----------
				129
Dmitri Gribenko	6a144e4	2012-11-29 17:41:05 +0000	[diff] [blame]	130	If :program:`tblgen` succeeds, it will exit with 0. Otherwise, if an error
Daniel Dunbar	3b709d5	2012-05-08 16:50:35 +0000	[diff] [blame]	131	occurs, it will exit with a non-zero value.