Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / llvm / 1bc686433bd5dea7ef4b8b5d97cd9461f041b56f / . / docs / TableGenFundamentals.html
blob: 7924bd9a2479d5554d736fefea6db20d7ce605fb [file] [log] [blame]
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<html>
4<head>
5 <title>TableGen Fundamentals</title>
6 <link rel="stylesheet" href="llvm.css" type="text/css">
7</head>
8<body>
9
10<div class="doc_title">TableGen Fundamentals</div>
11
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]12<div class="doc_text">
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]13<ul>
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]14 <li><a href="#introduction">Introduction</a>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]15 <ol>
16 <li><a href="#concepts">Basic concepts</a></li>
17 <li><a href="#example">An example record</a></li>
18 <li><a href="#running">Running TableGen</a></li>
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]19 </ol></li>
20 <li><a href="#syntax">TableGen syntax</a>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]21 <ol>
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]22 <li><a href="#primitives">TableGen primitives</a>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]23 <ol>
24 <li><a href="#comments">TableGen comments</a></li>
25 <li><a href="#types">The TableGen type system</a></li>
26 <li><a href="#values">TableGen values and expressions</a></li>
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]27 </ol></li>
28 <li><a href="#classesdefs">Classes and definitions</a>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]29 <ol>
30 <li><a href="#valuedef">Value definitions</a></li>
31 <li><a href="#recordlet">'let' expressions</a></li>
32 <li><a href="#templateargs">Class template arguments</a></li>
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]33 </ol></li>
34 <li><a href="#filescope">File scope entities</a>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]35 <ol>
36 <li><a href="#include">File inclusion</a></li>
37 <li><a href="#globallet">'let' expressions</a></li>
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]38 </ol></li>
39 </ol></li>
40 <li><a href="#backends">TableGen backends</a>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]41 <ol>
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]42 <li><a href="#">todo</a></li>
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]43 </ol></li>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]44</ul>
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]45</div>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]46
Chris Lattner7911ce22004-05-23 21:07:27 +0000[diff] [blame]47<div class="doc_author">
48 <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a></p>
49</div>
50
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]51<!-- *********************************************************************** -->
52<div class="doc_section"><a name="introduction">Introduction</a></div>
53<!-- *********************************************************************** -->
54
55<div class="doc_text">
56
57<p>TableGen's purpose is to help a human develop and maintain records of
58domain-specific information. Because there may be a large number of these
59records, it is specifically designed to allow writing flexible descriptions and
60for common features of these records to be factored out. This reduces the
61amount of duplication in the description, reduces the chance of error, and
62makes it easier to structure domain specific information.</p>
63
64<p>The core part of TableGen <a href="#syntax">parses a file</a>, instantiates
65the declarations, and hands the result off to a domain-specific "<a
66href="#backends">TableGen backend</a>" for processing. The current major user
Chris Lattner1aab3272004-07-26 21:16:55 +0000[diff] [blame]67of TableGen is the <a href="CodeGenerator.html">LLVM code generator</a>.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]68
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]69<p>Note that if you work on TableGen much, and use emacs or vim, that you can
70find an emacs "TableGen mode" and a vim language file in
71<tt>llvm/utils/emacs</tt> and <tt>llvm/utils/vim</tt> directory of your LLVM
72distribution, respectively.</p>
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]73
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]74</div>
75
76<!-- ======================================================================= -->
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]77<div class="doc_subsection"><a name="running">Basic concepts</a></div>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]78
79<div class="doc_text">
80
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]81<p>TableGen files consist of two key parts: 'classes' and 'definitions', both
82of which are considered 'records'.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]83
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]84<p><b>TableGen records</b> have a unique name, a list of values, and a list of
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]85superclasses. The list of values is main data that TableGen builds for each
86record, it is this that holds the domain specific information for the
87application. The interpretation of this data is left to a specific <a
88href="#backends">TableGen backend</a>, but the structure and format rules are
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]89taken care of and fixed by TableGen.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]90
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]91<p><b>TableGen definitions</b> are the concrete form of 'records'. These
92generally do not have any undefined values, and are marked with the
93'<tt>def</tt>' keyword.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]94
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]95<p><b>TableGen classes</b> are abstract records that are used to build and
96describe other records. These 'classes' allow the end-user to build
97abstractions for either the domain they are targetting (such as "Register",
98"RegisterClass", and "Instruction" in the LLVM code generator) or for the
99implementor to help factor out common properties of records (such as "FPInst",
100which is used to represent floating point instructions in the X86 backend).
101TableGen keeps track of all of the classes that are used to build up a
102definition, so the backend can find all definitions of a particular class, such
103as "Instruction".</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]104
105</div>
106
107<!-- ======================================================================= -->
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]108<div class="doc_subsection"><a name="example">An example record</a></div>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]109
110<div class="doc_text">
111
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]112<p>With no other arguments, TableGen parses the specified file and prints out
113all of the classes, then all of the definitions. This is a good way to see what
114the various definitions expand to fully. Running this on the <tt>X86.td</tt>
115file prints this (at the time of this writing):</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]116
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]117<pre>
118...
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]119<b>def</b> ADDrr8 { <i>// Instruction X86Inst I2A8 Pattern</i>
120 <b>string</b> Name = "add";
121 <b>string</b> Namespace = "X86";
122 <b>list</b>&lt;Register&gt; Uses = [];
123 <b>list</b>&lt;Register&gt; Defs = [];
124 <b>bit</b> isReturn = 0;
125 <b>bit</b> isBranch = 0;
126 <b>bit</b> isCall = 0;
127 <b>bit</b> isTwoAddress = 1;
128 <b>bit</b> isTerminator = 0;
129 <b>dag</b> Pattern = (set R8, (plus R8, R8));
130 <b>bits</b>&lt;8&gt; Opcode = { 0, 0, 0, 0, 0, 0, 0, 0 };
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]131 Format Form = MRMDestReg;
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]132 <b>bits</b>&lt;5&gt; FormBits = { 0, 0, 0, 1, 1 };
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]133 ArgType Type = Arg8;
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]134 <b>bits</b>&lt;3&gt; TypeBits = { 0, 0, 1 };
135 <b>bit</b> hasOpSizePrefix = 0;
136 <b>bit</b> printImplicitUses = 0;
137 <b>bits</b>&lt;4&gt; Prefix = { 0, 0, 0, 0 };
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]138 FPFormat FPForm = ?;
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]139 <b>bits</b>&lt;3&gt; FPFormBits = { 0, 0, 0 };
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]140}
141...
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]142</pre>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]143
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]144<p>This definition corresponds to an 8-bit register-register add instruction in
145the X86. The string after the '<tt>def</tt>' string indicates the name of the
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]146record ("<tt>ADDrr8</tt>" in this case), and the comment at the end of the line
147indicates the superclasses of the definition. The body of the record contains
148all of the data that TableGen assembled for the record, indicating that the
149instruction is part of the "X86" namespace, should be printed as "<tt>add</tt>"
150in the assembly file, it is a two-address instruction, has a particular
151encoding, etc. The contents and semantics of the information in the record is
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]152specific to the needs of the X86 backend, and is only shown as an example.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]153
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]154<p>As you can see, a lot of information is needed for every instruction
155supported by the code generator, and specifying it all manually would be
156unmaintainble, prone to bugs, and tiring to do in the first place. Because we
157are using TableGen, all of the information was derived from the following
158definition:</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]159
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]160<pre>
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]161<b>def</b> ADDrr8 : I2A8&lt;"add", 0x00, MRMDestReg&gt;,
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]162 Pattern&lt;(set R8, (plus R8, R8))&gt;;
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]163</pre>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]164
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]165<p>This definition makes use of the custom I2A8 (two address instruction with
1668-bit operand) class, which is defined in the X86-specific TableGen file to
167factor out the common features that instructions of its class share. A key
168feature of TableGen is that it allows the end-user to define the abstractions
169they prefer to use when describing their information.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]170
171</div>
172
173<!-- ======================================================================= -->
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]174<div class="doc_subsection"><a name="running">Running TableGen</a></div>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]175
176<div class="doc_text">
177
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]178<p>TableGen runs just like any other LLVM tool. The first (optional) argument
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]179specifies the file to read. If a filename is not specified, <tt>tblgen</tt>
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]180reads from standard input.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]181
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]182<p>To be useful, one of the <a href="#backends">TableGen backends</a> must be
183used. These backends are selectable on the command line (type '<tt>tblgen
184--help</tt>' for a list). For example, to get a list of all of the definitions
185that subclass a particular type (which can be useful for building up an enum
186list of these records), use the <tt>--print-enums</tt> option:</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]187
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]188<pre>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]189$ tblgen X86.td -print-enums -class=Register
190AH, AL, AX, BH, BL, BP, BX, CH, CL, CX, DH, DI, DL, DX,
191EAX, EBP, EBX, ECX, EDI, EDX, ESI, ESP, FP0, FP1, FP2, FP3, FP4, FP5, FP6,
192SI, SP, ST0, ST1, ST2, ST3, ST4, ST5, ST6, ST7,
193
194$ tblgen X86.td -print-enums -class=Instruction
195ADCrr32, ADDri16, ADDri16b, ADDri32, ADDri32b, ADDri8, ADDrr16, ADDrr32,
196ADDrr8, ADJCALLSTACKDOWN, ADJCALLSTACKUP, ANDri16, ANDri16b, ANDri32, ANDri32b,
197ANDri8, ANDrr16, ANDrr32, ANDrr8, BSWAPr32, CALLm32, CALLpcrel32, ...
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]198</pre>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]199
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]200<p>The default backend prints out all of the records, as described <a
201href="#example">above</a>.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]202
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]203<p>If you plan to use TableGen for some purpose, you will most likely have to
204<a href="#backends">write a backend</a> that extracts the information specific
205to what you need and formats it in the appropriate way.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]206
207</div>
208
209
210<!-- *********************************************************************** -->
211<div class="doc_section"><a name="syntax">TableGen syntax</a></div>
212<!-- *********************************************************************** -->
213
214<div class="doc_text">
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]215<p>TableGen doesn't care about the meaning of data (that is up to the backend
216to define), but it does care about syntax, and it enforces a simple type system.
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]217This section describes the syntax and the constructs allowed in a TableGen file.
218</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]219</div>
220
221<!-- ======================================================================= -->
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]222<div class="doc_subsection"><a name="primitives">TableGen primitives</a></div>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]223
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]224<!-- -------------------------------------------------------------------------->
225<div class="doc_subsubsection"><a name="comments">TableGen comments</a></div>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]226
227<div class="doc_text">
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]228<p>TableGen supports BCPL style "<tt>//</tt>" comments, which run to the end of
229the line, and it also supports <b>nestable</b> "<tt>/* */</tt>" comments.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]230</div>
231
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]232<!-- -------------------------------------------------------------------------->
Misha Brukman78b648c2004-06-03 16:59:59 +0000[diff] [blame]233<div class="doc_subsubsection">
234 <a name="types">The TableGen type system</a>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]235</div>
236
237<div class="doc_text">
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]238<p>TableGen files are strongly typed, in a simple (but complete) type-system.
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]239These types are used to perform automatic conversions, check for errors, and to
240help interface designers constrain the input that they allow. Every <a
241href="#valuedef">value definition</a> is required to have an associated type.
242</p>
243
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]244<p>TableGen supports a mixture of very low-level types (such as <tt>bit</tt>)
245and very high-level types (such as <tt>dag</tt>). This flexibility is what
246allows it to describe a wide range of information conveniently and compactly.
247The TableGen types are:</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]248
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]249<ul>
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]250<li>"<tt><b>bit</b></tt>" - A 'bit' is a boolean value that can hold either 0 or
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]2511.</li>
252
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]253<li>"<tt><b>int</b></tt>" - The 'int' type represents a simple 32-bit integer
254value, such as 5.</li>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]255
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]256<li>"<tt><b>string</b></tt>" - The 'string' type represents an ordered sequence
257of characters of arbitrary length.</li>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]258
John Criswellaa55c8c2004-02-12 18:11:53 +0000[diff] [blame]259<li>"<tt><b>bits</b>&lt;n&gt;</tt>" - A 'bits' type is an arbitrary, but fixed,
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]260size integer that is broken up into individual bits. This type is useful
261because it can handle some bits being defined while others are undefined.</li>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]262
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]263<li>"<tt><b>list</b>&lt;ty&gt;</tt>" - This type represents a list whose
264elements are some other type. The contained type is arbitrary: it can even be
265another list type.</li>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]266
267<li>Class type - Specifying a class name in a type context means that the
268defined value must be a subclass of the specified class. This is useful in
269conjunction with the "list" type, for example, to constrain the elements of the
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]270list to a common base class (e.g., a <tt><b>list</b>&lt;Register&gt;</tt> can
271only contain definitions derived from the "<tt>Register</tt>" class).</li>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]272
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]273<li>"<tt><b>code</b></tt>" - This represents a big hunk of text. NOTE: I don't
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]274remember why this is distinct from string!</li>
275
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]276<li>"<tt><b>dag</b></tt>" - This type represents a nestable directed graph of
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]277elements.</li>
278</ul>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]279
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]280<p>To date, these types have been sufficient for describing things that
281TableGen has been used for, but it is straight-forward to extend this list if
282needed.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]283
284</div>
285
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]286<!-- -------------------------------------------------------------------------->
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]287<div class="doc_subsubsection">
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]288 <a name="values">TableGen values and expressions</a>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]289</div>
290
Misha Brukman78b648c2004-06-03 16:59:59 +0000[diff] [blame]291<div class="doc_text">
292
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]293<p>TableGen allows for a pretty reasonable number of different expression forms
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]294when building up values. These forms allow the TableGen file to be written in a
295natural syntax and flavor for the application. The current expression forms
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]296supported include:</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]297
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]298<ul>
Misha Brukman08772da2004-07-28 22:09:29 +0000[diff] [blame]299<li><tt>?</tt> - uninitialized field</li>
300<li><tt>0b1001011</tt> - binary integer value</li>
301<li><tt>07654321</tt> - octal integer value (indicated by a leading 0)</li>
302<li><tt>7</tt> - decimal integer value</li>
303<li><tt>0x7F</tt> - hexadecimal integer value</li>
304<li><tt>"foo"</tt> - string value</li>
305<li><tt>[{ ... }]</tt> - code fragment</li>
306<li><tt>[ X, Y, Z ]</tt> - list value.</li>
307<li><tt>{ a, b, c }</tt> - initializer for a "bits&lt;3&gt;" value</li>
308<li><tt>value</tt> - value reference</li>
309<li><tt>value{17}</tt> - access to one bit of a value</li>
310<li><tt>value{15-17}</tt> - access to multiple bits of a value</li>
311<li><tt>DEF</tt> - reference to a record definition</li>
Chris Lattner33694cf2005-09-08 18:47:21 +0000[diff] [blame]312<li><tt>CLASS&lt;val list&gt;</tt> - reference to a new anonymous definition of
313 CLASS with the specified template arguments.</li>
Misha Brukman08772da2004-07-28 22:09:29 +0000[diff] [blame]314<li><tt>X.Y</tt> - reference to the subfield of a value</li>
Misha Brukman33066e92004-08-04 22:00:05 +0000[diff] [blame]315<li><tt>list[4-7,17,2-3]</tt> - A slice of the 'list' list, including elements
3164,5,6,7,17,2, and 3 from it. Elements may be included multiple times.</li>
Misha Brukman08772da2004-07-28 22:09:29 +0000[diff] [blame]317<li><tt>(DEF a, b)</tt> - a dag value. The first element is required to be a
318record definition, the remaining elements in the list may be arbitrary other
319values, including nested `<tt>dag</tt>' values.</li>
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]320</ul>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]321
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]322<p>Note that all of the values have rules specifying how they convert to values
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]323for different types. These rules allow you to assign a value like "7" to a
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]324"bits&lt;4&gt;" value, for example.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]325
326</div>
327
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]328<!-- ======================================================================= -->
Misha Brukman78b648c2004-06-03 16:59:59 +0000[diff] [blame]329<div class="doc_subsection">
330 <a name="classesdefs">Classes and definitions</a>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]331</div>
332
Misha Brukman78b648c2004-06-03 16:59:59 +0000[diff] [blame]333<div class="doc_text">
334
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]335<p>As mentioned in the <a href="#concepts">intro</a>, classes and definitions
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]336(collectively known as 'records') in TableGen are the main high-level unit of
337information that TableGen collects. Records are defined with a <tt>def</tt> or
338<tt>class</tt> keyword, the record name, and an optional list of "<a
Misha Brukman179bf4b2004-06-03 23:42:24 +0000[diff] [blame]339href="#templateargs">template arguments</a>". If the record has superclasses,
Jeff Cohen0b81cda2005-10-24 16:54:55 +0000[diff] [blame]340they are specified as a comma separated list that starts with a colon character
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]341(":"). If <a href="#valuedef">value definitions</a> or <a href="#recordlet">let
John Criswellaa55c8c2004-02-12 18:11:53 +0000[diff] [blame]342expressions</a> are needed for the class, they are enclosed in curly braces
343("{}"); otherwise, the record ends with a semicolon. Here is a simple TableGen
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]344file:</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]345
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]346<pre>
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]347<b>class</b> C { <b>bit</b> V = 1; }
348<b>def</b> X : C;
349<b>def</b> Y : C {
350 <b>string</b> Greeting = "hello";
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]351}
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]352</pre>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]353
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]354<p>This example defines two definitions, <tt>X</tt> and <tt>Y</tt>, both of
355which derive from the <tt>C</tt> class. Because of this, they both get the
356<tt>V</tt> bit value. The <tt>Y</tt> definition also gets the Greeting member
357as well.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]358
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]359<p>In general, classes are useful for collecting together the commonality
360between a group of records and isolating it in a single place. Also, classes
361permit the specification of default values for their subclasses, allowing the
362subclasses to override them as they wish.</p>
Chris Lattner23f54fa2004-02-06 06:37:00 +0000[diff] [blame]363
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]364</div>
365
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]366<!---------------------------------------------------------------------------->
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]367<div class="doc_subsubsection">
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]368 <a name="valuedef">Value definitions</a>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]369</div>
370
371<div class="doc_text">
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]372<p>Value definitions define named entries in records. A value must be defined
John Criswellaa55c8c2004-02-12 18:11:53 +0000[diff] [blame]373before it can be referred to as the operand for another value definition or
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]374before the value is reset with a <a href="#recordlet">let expression</a>. A
375value is defined by specifying a <a href="#types">TableGen type</a> and a name.
376If an initial value is available, it may be specified after the type with an
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]377equal sign. Value definitions require terminating semicolons.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]378</div>
379
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]380<!-- -------------------------------------------------------------------------->
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]381<div class="doc_subsubsection">
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]382 <a name="recordlet">'let' expressions</a>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]383</div>
384
385<div class="doc_text">
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]386<p>A record-level let expression is used to change the value of a value
387definition in a record. This is primarily useful when a superclass defines a
388value that a derived class or definition wants to override. Let expressions
389consist of the '<tt>let</tt>' keyword followed by a value name, an equal sign
390("="), and a new value. For example, a new class could be added to the example
391above, redefining the <tt>V</tt> field for all of its subclasses:</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]392
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]393<pre>
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]394<b>class</b> D : C { let V = 0; }
395<b>def</b> Z : D;
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]396</pre>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]397
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]398<p>In this case, the <tt>Z</tt> definition will have a zero value for its "V"
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]399value, despite the fact that it derives (indirectly) from the <tt>C</tt> class,
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]400because the <tt>D</tt> class overrode its value.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]401
402</div>
403
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]404<!-- -------------------------------------------------------------------------->
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]405<div class="doc_subsubsection">
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]406 <a name="templateargs">Class template arguments</a>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]407</div>
408
409<div class="doc_text">
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]410<p>TableGen permits the definition of parameterized classes as well as normal
Chris Lattner23f54fa2004-02-06 06:37:00 +0000[diff] [blame]411concrete classes. Parameterized TableGen classes specify a list of variable
412bindings (which may optionally have defaults) that are bound when used. Here is
413a simple example:</p>
414
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]415<pre>
Chris Lattner23f54fa2004-02-06 06:37:00 +0000[diff] [blame]416<b>class</b> FPFormat&lt;<b>bits</b>&lt;3&gt; val&gt; {
417 <b>bits</b>&lt;3&gt; Value = val;
418}
419<b>def</b> NotFP : FPFormat&lt;0&gt;;
420<b>def</b> ZeroArgFP : FPFormat&lt;1&gt;;
421<b>def</b> OneArgFP : FPFormat&lt;2&gt;;
422<b>def</b> OneArgFPRW : FPFormat&lt;3&gt;;
423<b>def</b> TwoArgFP : FPFormat&lt;4&gt;;
424<b>def</b> SpecialFP : FPFormat&lt;5&gt;;
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]425</pre>
Chris Lattner23f54fa2004-02-06 06:37:00 +0000[diff] [blame]426
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]427<p>In this case, template arguments are used as a space efficient way to specify
428a list of "enumeration values", each with a "Value" field set to the specified
Chris Lattner23f54fa2004-02-06 06:37:00 +0000[diff] [blame]429integer.</p>
430
431<p>The more esoteric forms of <a href="#values">TableGen expressions</a> are
432useful in conjunction with template arguments. As an example:</p>
433
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]434<pre>
Chris Lattner23f54fa2004-02-06 06:37:00 +0000[diff] [blame]435<b>class</b> ModRefVal&lt;<b>bits</b>&lt;2&gt; val&gt; {
436 <b>bits</b>&lt;2&gt; Value = val;
437}
438
439<b>def</b> None : ModRefVal&lt;0&gt;;
440<b>def</b> Mod : ModRefVal&lt;1&gt;;
441<b>def</b> Ref : ModRefVal&lt;2&gt;;
442<b>def</b> ModRef : ModRefVal&lt;3&gt;;
443
444<b>class</b> Value&lt;ModRefVal MR&gt; {
445 <i>// decode some information into a more convenient format, while providing
446 // a nice interface to the user of the "Value" class.</i>
447 <b>bit</b> isMod = MR.Value{0};
448 <b>bit</b> isRef = MR.Value{1};
449
450 <i>// other stuff...</i>
451}
452
453<i>// Example uses</i>
454<b>def</b> bork : Value&lt;Mod&gt;;
455<b>def</b> zork : Value&lt;Ref&gt;;
456<b>def</b> hork : Value&lt;ModRef&gt;;
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]457</pre>
Chris Lattner23f54fa2004-02-06 06:37:00 +0000[diff] [blame]458
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]459<p>This is obviously a contrived example, but it shows how template arguments
460can be used to decouple the interface provided to the user of the class from the
Chris Lattner23f54fa2004-02-06 06:37:00 +0000[diff] [blame]461actual internal data representation expected by the class. In this case,
462running <tt>tblgen</tt> on the example prints the following definitions:</p>
463
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]464<pre>
Chris Lattner23f54fa2004-02-06 06:37:00 +0000[diff] [blame]465<b>def</b> bork { <i>// Value</i>
466 bit isMod = 1;
467 bit isRef = 0;
468}
469<b>def</b> hork { <i>// Value</i>
470 bit isMod = 1;
471 bit isRef = 1;
472}
473<b>def</b> zork { <i>// Value</i>
474 bit isMod = 0;
475 bit isRef = 1;
476}
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]477</pre>
Chris Lattner23f54fa2004-02-06 06:37:00 +0000[diff] [blame]478
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]479<p> This shows that TableGen was able to dig into the argument and extract a
480piece of information that was requested by the designer of the "Value" class.
481For more realistic examples, please see existing users of TableGen, such as the
482X86 backend.</p>
Chris Lattner23f54fa2004-02-06 06:37:00 +0000[diff] [blame]483
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]484</div>
485
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]486<!-- ======================================================================= -->
487<div class="doc_subsection">
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]488 <a name="filescope">File scope entities</a>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]489</div>
490
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]491<!-- -------------------------------------------------------------------------->
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]492<div class="doc_subsubsection">
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]493 <a name="include">File inclusion</a>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]494</div>
495
496<div class="doc_text">
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]497<p>TableGen supports the '<tt>include</tt>' token, which textually substitutes
498the specified file in place of the include directive. The filename should be
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]499specified as a double quoted string immediately after the '<tt>include</tt>'
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]500keyword. Example:</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]501
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]502<pre>
Chris Lattner23f54fa2004-02-06 06:37:00 +0000[diff] [blame]503<b>include</b> "foo.td"
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]504</pre>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]505
506</div>
507
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]508<!-- -------------------------------------------------------------------------->
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]509<div class="doc_subsubsection">
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]510 <a name="globallet">'let' expressions</a>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]511</div>
512
513<div class="doc_text">
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]514<p> "let" expressions at file scope are similar to <a href="#recordlet">"let"
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]515expressions within a record</a>, except they can specify a value binding for
516multiple records at a time, and may be useful in certain other cases.
517File-scope let expressions are really just another way that TableGen allows the
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]518end-user to factor out commonality from the records.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]519
Jeff Cohen0b81cda2005-10-24 16:54:55 +0000[diff] [blame]520<p>File-scope "let" expressions take a comma-separated list of bindings to
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]521apply, and one of more records to bind the values in. Here are some
522examples:</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]523
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]524<pre>
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]525<b>let</b> isTerminator = 1, isReturn = 1 <b>in</b>
526 <b>def</b> RET : X86Inst&lt;"ret", 0xC3, RawFrm, NoArg&gt;;
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]527
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]528<b>let</b> isCall = 1 <b>in</b>
529 <i>// All calls clobber the non-callee saved registers...</i>
530 <b>let</b> Defs = [EAX, ECX, EDX, FP0, FP1, FP2, FP3, FP4, FP5, FP6] in {
531 <b>def</b> CALLpcrel32 : X86Inst&lt;"call", 0xE8, RawFrm, NoArg&gt;;
532 <b>def</b> CALLr32 : X86Inst&lt;"call", 0xFF, MRMS2r, Arg32&gt;;
533 <b>def</b> CALLm32 : X86Inst&lt;"call", 0xFF, MRMS2m, Arg32&gt;;
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]534 }
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]535</pre>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]536
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]537<p>File-scope "let" expressions are often useful when a couple of definitions
538need to be added to several records, and the records do not otherwise need to be
539opened, as in the case with the CALL* instructions above.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]540</div>
541
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]542<!-- *********************************************************************** -->
543<div class="doc_section"><a name="backends">TableGen backends</a></div>
544<!-- *********************************************************************** -->
545
546<div class="doc_text">
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]547<p>How they work, how to write one. This section should not contain details
548about any particular backend, except maybe -print-enums as an example. This
549should highlight the APIs in <tt>TableGen/Record.h</tt>.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]550</div>
551
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]552<!-- *********************************************************************** -->
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]553
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]554<hr>
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]555<address>
556 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
557 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
558 <a href="http://validator.w3.org/check/referer"><img
559 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
560
561 <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]562 <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]563 Last modified: $Date$
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]564</address>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]565
566</body>
567</html>