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