Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / e6c27de069225e1122c78385ad22a2ff656db8e6 / . / docs / TableGenFundamentals.html
blob: 48fdd2a2018fe0ef2f4606784739a4c77007134b [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>
Chris Lattner84b35982006-09-01 21:44:18 +0000[diff] [blame]33 <li><a href="#multiclass">Multiclass definitions and instances</a></li>
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]34 </ol></li>
35 <li><a href="#filescope">File scope entities</a>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]36 <ol>
37 <li><a href="#include">File inclusion</a></li>
38 <li><a href="#globallet">'let' expressions</a></li>
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]39 </ol></li>
40 </ol></li>
41 <li><a href="#backends">TableGen backends</a>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]42 <ol>
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]43 <li><a href="#">todo</a></li>
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]44 </ol></li>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]45</ul>
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]46</div>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]47
Chris Lattner7911ce22004-05-23 21:07:27 +0000[diff] [blame]48<div class="doc_author">
49 <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a></p>
50</div>
51
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]52<!-- *********************************************************************** -->
53<div class="doc_section"><a name="introduction">Introduction</a></div>
54<!-- *********************************************************************** -->
55
56<div class="doc_text">
57
58<p>TableGen's purpose is to help a human develop and maintain records of
59domain-specific information. Because there may be a large number of these
60records, it is specifically designed to allow writing flexible descriptions and
61for common features of these records to be factored out. This reduces the
62amount of duplication in the description, reduces the chance of error, and
63makes it easier to structure domain specific information.</p>
64
65<p>The core part of TableGen <a href="#syntax">parses a file</a>, instantiates
66the declarations, and hands the result off to a domain-specific "<a
67href="#backends">TableGen backend</a>" for processing. The current major user
Chris Lattner1aab3272004-07-26 21:16:55 +0000[diff] [blame]68of TableGen is the <a href="CodeGenerator.html">LLVM code generator</a>.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]69
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]70<p>Note that if you work on TableGen much, and use emacs or vim, that you can
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]71find an emacs "TableGen mode" and a vim language file in the
72<tt>llvm/utils/emacs</tt> and <tt>llvm/utils/vim</tt> directories of your LLVM
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]73distribution, respectively.</p>
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]74
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]75</div>
76
77<!-- ======================================================================= -->
Jim Laskeyf1b5adb2006-09-09 09:10:37 +0000[diff] [blame]78<div class="doc_subsection"><a name="concepts">Basic concepts</a></div>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]79
80<div class="doc_text">
81
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]82<p>TableGen files consist of two key parts: 'classes' and 'definitions', both
83of which are considered 'records'.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]84
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]85<p><b>TableGen records</b> have a unique name, a list of values, and a list of
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]86superclasses. The list of values is the main data that TableGen builds for each
87record; it is this that holds the domain specific information for the
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]88application. The interpretation of this data is left to a specific <a
89href="#backends">TableGen backend</a>, but the structure and format rules are
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]90taken care of and are fixed by TableGen.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]91
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]92<p><b>TableGen definitions</b> are the concrete form of 'records'. These
93generally do not have any undefined values, and are marked with the
94'<tt>def</tt>' keyword.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]95
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]96<p><b>TableGen classes</b> are abstract records that are used to build and
97describe other records. These 'classes' allow the end-user to build
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]98abstractions for either the domain they are targeting (such as "Register",
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]99"RegisterClass", and "Instruction" in the LLVM code generator) or for the
100implementor to help factor out common properties of records (such as "FPInst",
101which is used to represent floating point instructions in the X86 backend).
102TableGen keeps track of all of the classes that are used to build up a
103definition, so the backend can find all definitions of a particular class, such
104as "Instruction".</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]105
Chris Lattner84b35982006-09-01 21:44:18 +0000[diff] [blame]106<p><b>TableGen multiclasses</b> are groups of abstract records that are
David Greenede444af2009-04-22 16:42:54 +0000[diff] [blame]107instantiated all at once. Each instantiation can result in multiple
108TableGen definitions. If a multiclass inherits from another multiclass,
109the definitions in the sub-multiclass become part of the current
110multiclass, as if they were declared in the current multiclass.</p>
Chris Lattner84b35982006-09-01 21:44:18 +0000[diff] [blame]111
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]112</div>
113
114<!-- ======================================================================= -->
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]115<div class="doc_subsection"><a name="example">An example record</a></div>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]116
117<div class="doc_text">
118
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]119<p>With no other arguments, TableGen parses the specified file and prints out
120all of the classes, then all of the definitions. This is a good way to see what
121the various definitions expand to fully. Running this on the <tt>X86.td</tt>
122file prints this (at the time of this writing):</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]123
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]124<div class="doc_code">
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]125<pre>
126...
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]127<b>def</b> ADD32rr { <i>// Instruction X86Inst I</i>
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]128 <b>string</b> Namespace = "X86";
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]129 <b>dag</b> OutOperandList = (outs GR32:$dst);
130 <b>dag</b> InOperandList = (ins GR32:$src1, GR32:$src2);
131 <b>string</b> AsmString = "add{l}\t{$src2, $dst|$dst, $src2}";
132 <b>list</b>&lt;dag&gt; Pattern = [(set GR32:$dst, (add GR32:$src1, GR32:$src2))];
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]133 <b>list</b>&lt;Register&gt; Uses = [];
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]134 <b>list</b>&lt;Register&gt; Defs = [EFLAGS];
135 <b>list</b>&lt;Predicate&gt; Predicates = [];
136 <b>int</b> CodeSize = 3;
137 <b>int</b> AddedComplexity = 0;
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]138 <b>bit</b> isReturn = 0;
139 <b>bit</b> isBranch = 0;
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]140 <b>bit</b> isIndirectBranch = 0;
141 <b>bit</b> isBarrier = 0;
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]142 <b>bit</b> isCall = 0;
Dan Gohman15511cf2008-12-03 18:15:48 +0000[diff] [blame]143 <b>bit</b> canFoldAsLoad = 0;
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]144 <b>bit</b> mayLoad = 0;
145 <b>bit</b> mayStore = 0;
146 <b>bit</b> isImplicitDef = 0;
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]147 <b>bit</b> isTwoAddress = 1;
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]148 <b>bit</b> isConvertibleToThreeAddress = 1;
149 <b>bit</b> isCommutable = 1;
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]150 <b>bit</b> isTerminator = 0;
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]151 <b>bit</b> isReMaterializable = 0;
152 <b>bit</b> isPredicable = 0;
153 <b>bit</b> hasDelaySlot = 0;
154 <b>bit</b> usesCustomDAGSchedInserter = 0;
155 <b>bit</b> hasCtrlDep = 0;
156 <b>bit</b> isNotDuplicable = 0;
157 <b>bit</b> hasSideEffects = 0;
158 <b>bit</b> mayHaveSideEffects = 0;
159 <b>bit</b> neverHasSideEffects = 0;
160 InstrItinClass Itinerary = NoItinerary;
161 <b>string</b> Constraints = "";
162 <b>string</b> DisableEncoding = "";
163 <b>bits</b>&lt;8&gt; Opcode = { 0, 0, 0, 0, 0, 0, 0, 1 };
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]164 Format Form = MRMDestReg;
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]165 <b>bits</b>&lt;6&gt; FormBits = { 0, 0, 0, 0, 1, 1 };
166 ImmType ImmT = NoImm;
167 <b>bits</b>&lt;3&gt; ImmTypeBits = { 0, 0, 0 };
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]168 <b>bit</b> hasOpSizePrefix = 0;
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]169 <b>bit</b> hasAdSizePrefix = 0;
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]170 <b>bits</b>&lt;4&gt; Prefix = { 0, 0, 0, 0 };
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]171 <b>bit</b> hasREX_WPrefix = 0;
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]172 FPFormat FPForm = ?;
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]173 <b>bits</b>&lt;3&gt; FPFormBits = { 0, 0, 0 };
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]174}
175...
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]176</pre>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]177</div>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]178
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]179<p>This definition corresponds to a 32-bit register-register add instruction in
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]180the X86. The string after the '<tt>def</tt>' string indicates the name of the
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]181record&mdash;"<tt>ADD32rr</tt>" in this case&mdash;and the comment at the end of
182the line indicates the superclasses of the definition. The body of the record
183contains all of the data that TableGen assembled for the record, indicating that
184the instruction is part of the "X86" namespace, the pattern indicating how the
185the instruction should be emitted into the assembly file, that it is a
186two-address instruction, has a particular encoding, etc. The contents and
187semantics of the information in the record is specific to the needs of the X86
188backend, and is only shown as an example.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]189
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]190<p>As you can see, a lot of information is needed for every instruction
191supported by the code generator, and specifying it all manually would be
192unmaintainble, prone to bugs, and tiring to do in the first place. Because we
193are using TableGen, all of the information was derived from the following
194definition:</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]195
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]196<div class="doc_code">
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]197<pre>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]198let Defs = [EFLAGS],
199 isCommutable = 1, <i>// X = ADD Y,Z --&gt; X = ADD Z,Y</i>
200 isConvertibleToThreeAddress = 1 <b>in</b> <i>// Can transform into LEA.</i>
201def ADD32rr : I&lt;0x01, MRMDestReg, (outs GR32:$dst),
202 (ins GR32:$src1, GR32:$src2),
203 "add{l}\t{$src2, $dst|$dst, $src2}",
204 [(set GR32:$dst, (add GR32:$src1, GR32:$src2))]&gt;;
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]205</pre>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]206</div>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]207
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]208<p>This definition makes use of the custom class <tt>I</tt> (extended from the
209custom class <tt>X86Inst</tt>), which is defined in the X86-specific TableGen
210file, to factor out the common features that instructions of its class share. A
211key feature of TableGen is that it allows the end-user to define the
212abstractions they prefer to use when describing their information.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]213
214</div>
215
216<!-- ======================================================================= -->
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]217<div class="doc_subsection"><a name="running">Running TableGen</a></div>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]218
219<div class="doc_text">
220
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]221<p>TableGen runs just like any other LLVM tool. The first (optional) argument
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]222specifies the file to read. If a filename is not specified, <tt>tblgen</tt>
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]223reads from standard input.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]224
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]225<p>To be useful, one of the <a href="#backends">TableGen backends</a> must be
226used. These backends are selectable on the command line (type '<tt>tblgen
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]227-help</tt>' for a list). For example, to get a list of all of the definitions
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]228that subclass a particular type (which can be useful for building up an enum
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]229list of these records), use the <tt>-print-enums</tt> option:</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]230
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]231<div class="doc_code">
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]232<pre>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]233$ tblgen X86.td -print-enums -class=Register
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]234AH, AL, AX, BH, BL, BP, BPL, BX, CH, CL, CX, DH, DI, DIL, DL, DX, EAX, EBP, EBX,
235ECX, EDI, EDX, EFLAGS, EIP, ESI, ESP, FP0, FP1, FP2, FP3, FP4, FP5, FP6, IP,
236MM0, MM1, MM2, MM3, MM4, MM5, MM6, MM7, R10, R10B, R10D, R10W, R11, R11B, R11D,
237R11W, R12, R12B, R12D, R12W, R13, R13B, R13D, R13W, R14, R14B, R14D, R14W, R15,
238R15B, R15D, R15W, R8, R8B, R8D, R8W, R9, R9B, R9D, R9W, RAX, RBP, RBX, RCX, RDI,
239RDX, RIP, RSI, RSP, SI, SIL, SP, SPL, ST0, ST1, ST2, ST3, ST4, ST5, ST6, ST7,
240XMM0, XMM1, XMM10, XMM11, XMM12, XMM13, XMM14, XMM15, XMM2, XMM3, XMM4, XMM5,
241XMM6, XMM7, XMM8, XMM9,
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]242
243$ tblgen X86.td -print-enums -class=Instruction
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]244ABS_F, ABS_Fp32, ABS_Fp64, ABS_Fp80, ADC32mi, ADC32mi8, ADC32mr, ADC32ri,
245ADC32ri8, ADC32rm, ADC32rr, ADC64mi32, ADC64mi8, ADC64mr, ADC64ri32, ADC64ri8,
246ADC64rm, ADC64rr, ADD16mi, ADD16mi8, ADD16mr, ADD16ri, ADD16ri8, ADD16rm,
247ADD16rr, ADD32mi, ADD32mi8, ADD32mr, ADD32ri, ADD32ri8, ADD32rm, ADD32rr,
248ADD64mi32, ADD64mi8, ADD64mr, ADD64ri32, ...
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]249</pre>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]250</div>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]251
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]252<p>The default backend prints out all of the records, as described <a
253href="#example">above</a>.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]254
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]255<p>If you plan to use TableGen, you will most likely have to <a
256href="#backends">write a backend</a> that extracts the information specific to
257what you need and formats it in the appropriate way.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]258
259</div>
260
261
262<!-- *********************************************************************** -->
263<div class="doc_section"><a name="syntax">TableGen syntax</a></div>
264<!-- *********************************************************************** -->
265
266<div class="doc_text">
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]267
268<p>TableGen doesn't care about the meaning of data (that is up to the backend to
269define), but it does care about syntax, and it enforces a simple type system.
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]270This section describes the syntax and the constructs allowed in a TableGen file.
271</p>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]272
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]273</div>
274
275<!-- ======================================================================= -->
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]276<div class="doc_subsection"><a name="primitives">TableGen primitives</a></div>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]277
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]278<!-- -------------------------------------------------------------------------->
279<div class="doc_subsubsection"><a name="comments">TableGen comments</a></div>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]280
281<div class="doc_text">
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]282
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]283<p>TableGen supports BCPL style "<tt>//</tt>" comments, which run to the end of
284the line, and it also supports <b>nestable</b> "<tt>/* */</tt>" comments.</p>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]285
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]286</div>
287
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]288<!-- -------------------------------------------------------------------------->
Misha Brukman78b648c2004-06-03 16:59:59 +0000[diff] [blame]289<div class="doc_subsubsection">
290 <a name="types">The TableGen type system</a>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]291</div>
292
293<div class="doc_text">
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]294
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]295<p>TableGen files are strongly typed, in a simple (but complete) type-system.
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]296These types are used to perform automatic conversions, check for errors, and to
297help interface designers constrain the input that they allow. Every <a
298href="#valuedef">value definition</a> is required to have an associated type.
299</p>
300
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]301<p>TableGen supports a mixture of very low-level types (such as <tt>bit</tt>)
302and very high-level types (such as <tt>dag</tt>). This flexibility is what
303allows it to describe a wide range of information conveniently and compactly.
304The TableGen types are:</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]305
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]306<dl>
Bill Wendling58d96d62008-02-12 07:09:05 +0000[diff] [blame]307<dt><tt><b>bit</b></tt></dt>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]308 <dd>A 'bit' is a boolean value that can hold either 0 or 1.</dd>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]309
Bill Wendling58d96d62008-02-12 07:09:05 +0000[diff] [blame]310<dt><tt><b>int</b></tt></dt>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]311 <dd>The 'int' type represents a simple 32-bit integer value, such as 5.</dd>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]312
Bill Wendling58d96d62008-02-12 07:09:05 +0000[diff] [blame]313<dt><tt><b>string</b></tt></dt>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]314 <dd>The 'string' type represents an ordered sequence of characters of
315 arbitrary length.</dd>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]316
Bill Wendling58d96d62008-02-12 07:09:05 +0000[diff] [blame]317<dt><tt><b>bits</b>&lt;n&gt;</tt></dt>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]318 <dd>A 'bits' type is an arbitrary, but fixed, size integer that is broken up
319 into individual bits. This type is useful because it can handle some bits
320 being defined while others are undefined.</dd>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]321
Bill Wendling58d96d62008-02-12 07:09:05 +0000[diff] [blame]322<dt><tt><b>list</b>&lt;ty&gt;</tt></dt>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]323 <dd>This type represents a list whose elements are some other type. The
324 contained type is arbitrary: it can even be another list type.</dd>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]325
Bill Wendling58d96d62008-02-12 07:09:05 +0000[diff] [blame]326<dt>Class type</dt>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]327 <dd>Specifying a class name in a type context means that the defined value
328 must be a subclass of the specified class. This is useful in conjunction with
329 the <b><tt>list</tt></b> type, for example, to constrain the elements of the
330 list to a common base class (e.g., a <tt><b>list</b>&lt;Register&gt;</tt> can
331 only contain definitions derived from the "<tt>Register</tt>" class).</dd>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]332
Bill Wendling58d96d62008-02-12 07:09:05 +0000[diff] [blame]333<dt><tt><b>dag</b></tt></dt>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]334 <dd>This type represents a nestable directed graph of elements.</dd>
335
Bill Wendling58d96d62008-02-12 07:09:05 +0000[diff] [blame]336<dt><tt><b>code</b></tt></dt>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]337 <dd>This represents a big hunk of text. NOTE: I don't remember why this is
338 distinct from string!</dd>
339</dl>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]340
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]341<p>To date, these types have been sufficient for describing things that
342TableGen has been used for, but it is straight-forward to extend this list if
343needed.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]344
345</div>
346
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]347<!-- -------------------------------------------------------------------------->
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]348<div class="doc_subsubsection">
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]349 <a name="values">TableGen values and expressions</a>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]350</div>
351
Misha Brukman78b648c2004-06-03 16:59:59 +0000[diff] [blame]352<div class="doc_text">
353
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]354<p>TableGen allows for a pretty reasonable number of different expression forms
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]355when building up values. These forms allow the TableGen file to be written in a
356natural syntax and flavor for the application. The current expression forms
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]357supported include:</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]358
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]359<dl>
Bill Wendling58d96d62008-02-12 07:09:05 +0000[diff] [blame]360<dt><tt>?</tt></dt>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]361 <dd>uninitialized field</dd>
Bill Wendling58d96d62008-02-12 07:09:05 +0000[diff] [blame]362<dt><tt>0b1001011</tt></dt>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]363 <dd>binary integer value</dd>
Bill Wendling58d96d62008-02-12 07:09:05 +0000[diff] [blame]364<dt><tt>07654321</tt></dt>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]365 <dd>octal integer value (indicated by a leading 0)</dd>
Bill Wendling58d96d62008-02-12 07:09:05 +0000[diff] [blame]366<dt><tt>7</tt></dt>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]367 <dd>decimal integer value</dd>
Bill Wendling58d96d62008-02-12 07:09:05 +0000[diff] [blame]368<dt><tt>0x7F</tt></dt>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]369 <dd>hexadecimal integer value</dd>
Bill Wendling58d96d62008-02-12 07:09:05 +0000[diff] [blame]370<dt><tt>"foo"</tt></dt>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]371 <dd>string value</dd>
Bill Wendling58d96d62008-02-12 07:09:05 +0000[diff] [blame]372<dt><tt>[{ ... }]</tt></dt>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]373 <dd>code fragment</dd>
Bill Wendling58d96d62008-02-12 07:09:05 +0000[diff] [blame]374<dt><tt>[ X, Y, Z ]</tt></dt>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]375 <dd>list value.</dd>
Bill Wendling58d96d62008-02-12 07:09:05 +0000[diff] [blame]376<dt><tt>{ a, b, c }</tt></dt>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]377 <dd>initializer for a "bits&lt;3&gt;" value</dd>
Bill Wendling58d96d62008-02-12 07:09:05 +0000[diff] [blame]378<dt><tt>value</tt></dt>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]379 <dd>value reference</dd>
Bill Wendling58d96d62008-02-12 07:09:05 +0000[diff] [blame]380<dt><tt>value{17}</tt></dt>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]381 <dd>access to one bit of a value</dd>
Bill Wendling58d96d62008-02-12 07:09:05 +0000[diff] [blame]382<dt><tt>value{15-17}</tt></dt>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]383 <dd>access to multiple bits of a value</dd>
Bill Wendling58d96d62008-02-12 07:09:05 +0000[diff] [blame]384<dt><tt>DEF</tt></dt>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]385 <dd>reference to a record definition</dd>
Bill Wendling58d96d62008-02-12 07:09:05 +0000[diff] [blame]386<dt><tt>CLASS&lt;val list&gt;</tt></dt>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]387 <dd>reference to a new anonymous definition of CLASS with the specified
388 template arguments.</dd>
Bill Wendling58d96d62008-02-12 07:09:05 +0000[diff] [blame]389<dt><tt>X.Y</tt></dt>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]390 <dd>reference to the subfield of a value</dd>
Bill Wendling58d96d62008-02-12 07:09:05 +0000[diff] [blame]391<dt><tt>list[4-7,17,2-3]</tt></dt>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]392 <dd>A slice of the 'list' list, including elements 4,5,6,7,17,2, and 3 from
393 it. Elements may be included multiple times.</dd>
Bill Wendling58d96d62008-02-12 07:09:05 +0000[diff] [blame]394<dt><tt>(DEF a, b)</tt></dt>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]395 <dd>a dag value. The first element is required to be a record definition, the
396 remaining elements in the list may be arbitrary other values, including nested
397 `<tt>dag</tt>' values.</dd>
Bill Wendling58d96d62008-02-12 07:09:05 +0000[diff] [blame]398<dt><tt>!strconcat(a, b)</tt></dt>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]399 <dd>A string value that is the result of concatenating the 'a' and 'b'
400 strings.</dd>
David Greenee6c27de2009-05-14 21:22:49 +0000[diff] [blame^]401<dt><tt>!cast<type>(a)</tt></dt>
402 <dd>A symbol of type <em>type</em> obtained by looking up the string 'a' in
403the symbol table. If the type of 'a' does not match <em>type</em>, TableGen
404aborts with an error. </dd>
David Greene3f47c292009-04-23 21:27:58 +0000[diff] [blame]405<dt><tt>!nameconcat&lt;type&gt;(a, b)</tt></dt>
David Greenee6c27de2009-05-14 21:22:49 +0000[diff] [blame^]406 <dd>Shorthand for !cast<type>(!strconcat(a, b))</dd>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]407</dl>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]408
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]409<p>Note that all of the values have rules specifying how they convert to values
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]410for different types. These rules allow you to assign a value like "<tt>7</tt>"
411to a "<tt>bits&lt;4&gt;</tt>" value, for example.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]412
413</div>
414
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]415<!-- ======================================================================= -->
Misha Brukman78b648c2004-06-03 16:59:59 +0000[diff] [blame]416<div class="doc_subsection">
417 <a name="classesdefs">Classes and definitions</a>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]418</div>
419
Misha Brukman78b648c2004-06-03 16:59:59 +0000[diff] [blame]420<div class="doc_text">
421
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]422<p>As mentioned in the <a href="#concepts">intro</a>, classes and definitions
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]423(collectively known as 'records') in TableGen are the main high-level unit of
424information that TableGen collects. Records are defined with a <tt>def</tt> or
425<tt>class</tt> keyword, the record name, and an optional list of "<a
Misha Brukman179bf4b2004-06-03 23:42:24 +0000[diff] [blame]426href="#templateargs">template arguments</a>". If the record has superclasses,
Jeff Cohen0b81cda2005-10-24 16:54:55 +0000[diff] [blame]427they are specified as a comma separated list that starts with a colon character
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]428("<tt>:</tt>"). If <a href="#valuedef">value definitions</a> or <a
429href="#recordlet">let expressions</a> are needed for the class, they are
430enclosed in curly braces ("<tt>{}</tt>"); otherwise, the record ends with a
431semicolon.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]432
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]433<p>Here is a simple TableGen file:</p>
434
435<div class="doc_code">
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]436<pre>
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]437<b>class</b> C { <b>bit</b> V = 1; }
438<b>def</b> X : C;
439<b>def</b> Y : C {
440 <b>string</b> Greeting = "hello";
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]441}
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]442</pre>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]443</div>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]444
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]445<p>This example defines two definitions, <tt>X</tt> and <tt>Y</tt>, both of
446which derive from the <tt>C</tt> class. Because of this, they both get the
447<tt>V</tt> bit value. The <tt>Y</tt> definition also gets the Greeting member
448as well.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]449
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]450<p>In general, classes are useful for collecting together the commonality
451between a group of records and isolating it in a single place. Also, classes
452permit the specification of default values for their subclasses, allowing the
453subclasses to override them as they wish.</p>
Chris Lattner23f54fa2004-02-06 06:37:00 +0000[diff] [blame]454
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]455</div>
456
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]457<!---------------------------------------------------------------------------->
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]458<div class="doc_subsubsection">
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]459 <a name="valuedef">Value definitions</a>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]460</div>
461
462<div class="doc_text">
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]463
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]464<p>Value definitions define named entries in records. A value must be defined
John Criswellaa55c8c2004-02-12 18:11:53 +0000[diff] [blame]465before it can be referred to as the operand for another value definition or
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]466before the value is reset with a <a href="#recordlet">let expression</a>. A
467value is defined by specifying a <a href="#types">TableGen type</a> and a name.
468If an initial value is available, it may be specified after the type with an
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]469equal sign. Value definitions require terminating semicolons.</p>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]470
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]471</div>
472
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]473<!-- -------------------------------------------------------------------------->
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]474<div class="doc_subsubsection">
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]475 <a name="recordlet">'let' expressions</a>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]476</div>
477
478<div class="doc_text">
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]479
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]480<p>A record-level let expression is used to change the value of a value
481definition in a record. This is primarily useful when a superclass defines a
482value that a derived class or definition wants to override. Let expressions
483consist of the '<tt>let</tt>' keyword followed by a value name, an equal sign
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]484("<tt>=</tt>"), and a new value. For example, a new class could be added to the
485example above, redefining the <tt>V</tt> field for all of its subclasses:</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]486
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]487<div class="doc_code">
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]488<pre>
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]489<b>class</b> D : C { let V = 0; }
490<b>def</b> Z : D;
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]491</pre>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]492</div>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]493
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]494<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]495value, despite the fact that it derives (indirectly) from the <tt>C</tt> class,
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]496because the <tt>D</tt> class overrode its value.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]497
498</div>
499
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]500<!-- -------------------------------------------------------------------------->
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]501<div class="doc_subsubsection">
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]502 <a name="templateargs">Class template arguments</a>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]503</div>
504
505<div class="doc_text">
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]506
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]507<p>TableGen permits the definition of parameterized classes as well as normal
Chris Lattner23f54fa2004-02-06 06:37:00 +0000[diff] [blame]508concrete classes. Parameterized TableGen classes specify a list of variable
509bindings (which may optionally have defaults) that are bound when used. Here is
510a simple example:</p>
511
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]512<div class="doc_code">
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]513<pre>
Chris Lattner23f54fa2004-02-06 06:37:00 +0000[diff] [blame]514<b>class</b> FPFormat&lt;<b>bits</b>&lt;3&gt; val&gt; {
515 <b>bits</b>&lt;3&gt; Value = val;
516}
517<b>def</b> NotFP : FPFormat&lt;0&gt;;
518<b>def</b> ZeroArgFP : FPFormat&lt;1&gt;;
519<b>def</b> OneArgFP : FPFormat&lt;2&gt;;
520<b>def</b> OneArgFPRW : FPFormat&lt;3&gt;;
521<b>def</b> TwoArgFP : FPFormat&lt;4&gt;;
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]522<b>def</b> CompareFP : FPFormat&lt;5&gt;;
523<b>def</b> CondMovFP : FPFormat&lt;6&gt;;
524<b>def</b> SpecialFP : FPFormat&lt;7&gt;;
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]525</pre>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]526</div>
Chris Lattner23f54fa2004-02-06 06:37:00 +0000[diff] [blame]527
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]528<p>In this case, template arguments are used as a space efficient way to specify
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]529a list of "enumeration values", each with a "<tt>Value</tt>" field set to the
530specified integer.</p>
Chris Lattner23f54fa2004-02-06 06:37:00 +0000[diff] [blame]531
532<p>The more esoteric forms of <a href="#values">TableGen expressions</a> are
533useful in conjunction with template arguments. As an example:</p>
534
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]535<div class="doc_code">
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]536<pre>
Chris Lattner23f54fa2004-02-06 06:37:00 +0000[diff] [blame]537<b>class</b> ModRefVal&lt;<b>bits</b>&lt;2&gt; val&gt; {
538 <b>bits</b>&lt;2&gt; Value = val;
539}
540
541<b>def</b> None : ModRefVal&lt;0&gt;;
542<b>def</b> Mod : ModRefVal&lt;1&gt;;
543<b>def</b> Ref : ModRefVal&lt;2&gt;;
544<b>def</b> ModRef : ModRefVal&lt;3&gt;;
545
546<b>class</b> Value&lt;ModRefVal MR&gt; {
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]547 <i>// Decode some information into a more convenient format, while providing
Chris Lattner23f54fa2004-02-06 06:37:00 +0000[diff] [blame]548 // a nice interface to the user of the "Value" class.</i>
549 <b>bit</b> isMod = MR.Value{0};
550 <b>bit</b> isRef = MR.Value{1};
551
552 <i>// other stuff...</i>
553}
554
555<i>// Example uses</i>
556<b>def</b> bork : Value&lt;Mod&gt;;
557<b>def</b> zork : Value&lt;Ref&gt;;
558<b>def</b> hork : Value&lt;ModRef&gt;;
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]559</pre>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]560</div>
Chris Lattner23f54fa2004-02-06 06:37:00 +0000[diff] [blame]561
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]562<p>This is obviously a contrived example, but it shows how template arguments
563can 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]564actual internal data representation expected by the class. In this case,
565running <tt>tblgen</tt> on the example prints the following definitions:</p>
566
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]567<div class="doc_code">
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]568<pre>
Chris Lattner23f54fa2004-02-06 06:37:00 +0000[diff] [blame]569<b>def</b> bork { <i>// Value</i>
Chris Lattner84b35982006-09-01 21:44:18 +0000[diff] [blame]570 <b>bit</b> isMod = 1;
571 <b>bit</b> isRef = 0;
Chris Lattner23f54fa2004-02-06 06:37:00 +0000[diff] [blame]572}
573<b>def</b> hork { <i>// Value</i>
Chris Lattner84b35982006-09-01 21:44:18 +0000[diff] [blame]574 <b>bit</b> isMod = 1;
575 <b>bit</b> isRef = 1;
Chris Lattner23f54fa2004-02-06 06:37:00 +0000[diff] [blame]576}
577<b>def</b> zork { <i>// Value</i>
Chris Lattner84b35982006-09-01 21:44:18 +0000[diff] [blame]578 <b>bit</b> isMod = 0;
579 <b>bit</b> isRef = 1;
Chris Lattner23f54fa2004-02-06 06:37:00 +0000[diff] [blame]580}
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]581</pre>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]582</div>
Chris Lattner23f54fa2004-02-06 06:37:00 +0000[diff] [blame]583
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]584<p> This shows that TableGen was able to dig into the argument and extract a
585piece of information that was requested by the designer of the "Value" class.
586For more realistic examples, please see existing users of TableGen, such as the
587X86 backend.</p>
Chris Lattner23f54fa2004-02-06 06:37:00 +0000[diff] [blame]588
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]589</div>
590
Chris Lattner84b35982006-09-01 21:44:18 +0000[diff] [blame]591<!-- -------------------------------------------------------------------------->
592<div class="doc_subsubsection">
593 <a name="multiclass">Multiclass definitions and instances</a>
594</div>
595
596<div class="doc_text">
597
598<p>
599While classes with template arguments are a good way to factor commonality
600between two instances of a definition, multiclasses allow a convenient notation
601for defining multiple definitions at once (instances of implicitly constructed
602classes). For example, consider an 3-address instruction set whose instructions
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]603come in two forms: "<tt>reg = reg op reg</tt>" and "<tt>reg = reg op imm</tt>"
604(e.g. SPARC). In this case, you'd like to specify in one place that this
605commonality exists, then in a separate place indicate what all the ops are.
Chris Lattner84b35982006-09-01 21:44:18 +0000[diff] [blame]606</p>
607
608<p>
609Here is an example TableGen fragment that shows this idea:
610</p>
611
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]612<div class="doc_code">
Chris Lattner84b35982006-09-01 21:44:18 +0000[diff] [blame]613<pre>
614<b>def</b> ops;
615<b>def</b> GPR;
616<b>def</b> Imm;
617<b>class</b> inst&lt;<b>int</b> opc, <b>string</b> asmstr, <b>dag</b> operandlist&gt;;
618
619<b>multiclass</b> ri_inst&lt;<b>int</b> opc, <b>string</b> asmstr&gt; {
620 def _rr : inst&lt;opc, !strconcat(asmstr, " $dst, $src1, $src2"),
621 (ops GPR:$dst, GPR:$src1, GPR:$src2)&gt;;
622 def _ri : inst&lt;opc, !strconcat(asmstr, " $dst, $src1, $src2"),
623 (ops GPR:$dst, GPR:$src1, Imm:$src2)&gt;;
624}
625
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]626<i>// Instantiations of the ri_inst multiclass.</i>
Chris Lattner84b35982006-09-01 21:44:18 +0000[diff] [blame]627<b>defm</b> ADD : ri_inst&lt;0b111, "add"&gt;;
628<b>defm</b> SUB : ri_inst&lt;0b101, "sub"&gt;;
629<b>defm</b> MUL : ri_inst&lt;0b100, "mul"&gt;;
630...
631</pre>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]632</div>
Chris Lattner84b35982006-09-01 21:44:18 +0000[diff] [blame]633
Chris Lattnere7173e12006-09-01 22:01:36 +0000[diff] [blame]634<p>The name of the resultant definitions has the multidef fragment names
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]635 appended to them, so this defines <tt>ADD_rr</tt>, <tt>ADD_ri</tt>,
David Greene56546132009-04-22 22:17:51 +0000[diff] [blame]636 <tt>SUB_rr</tt>, etc. A defm may inherit from multiple multiclasses,
637 instantiating definitions from each multiclass. Using a multiclass
638 this way is exactly equivalent to instantiating the classes multiple
639 times yourself, e.g. by writing:</p>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]640
641<div class="doc_code">
Chris Lattner84b35982006-09-01 21:44:18 +0000[diff] [blame]642<pre>
643<b>def</b> ops;
644<b>def</b> GPR;
645<b>def</b> Imm;
646<b>class</b> inst&lt;<b>int</b> opc, <b>string</b> asmstr, <b>dag</b> operandlist&gt;;
647
648<b>class</b> rrinst&lt;<b>int</b> opc, <b>string</b> asmstr&gt;
649 : inst&lt;opc, !strconcat(asmstr, " $dst, $src1, $src2"),
650 (ops GPR:$dst, GPR:$src1, GPR:$src2)&gt;;
651
652<b>class</b> riinst&lt;<b>int</b> opc, <b>string</b> asmstr&gt;
653 : inst&lt;opc, !strconcat(asmstr, " $dst, $src1, $src2"),
654 (ops GPR:$dst, GPR:$src1, Imm:$src2)&gt;;
655
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]656<i>// Instantiations of the ri_inst multiclass.</i>
Chris Lattner84b35982006-09-01 21:44:18 +0000[diff] [blame]657<b>def</b> ADD_rr : rrinst&lt;0b111, "add"&gt;;
658<b>def</b> ADD_ri : riinst&lt;0b111, "add"&gt;;
659<b>def</b> SUB_rr : rrinst&lt;0b101, "sub"&gt;;
660<b>def</b> SUB_ri : riinst&lt;0b101, "sub"&gt;;
661<b>def</b> MUL_rr : rrinst&lt;0b100, "mul"&gt;;
662<b>def</b> MUL_ri : riinst&lt;0b100, "mul"&gt;;
663...
664</pre>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]665</div>
Chris Lattner84b35982006-09-01 21:44:18 +0000[diff] [blame]666
667</div>
668
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]669<!-- ======================================================================= -->
670<div class="doc_subsection">
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]671 <a name="filescope">File scope entities</a>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]672</div>
673
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]674<!-- -------------------------------------------------------------------------->
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]675<div class="doc_subsubsection">
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]676 <a name="include">File inclusion</a>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]677</div>
678
679<div class="doc_text">
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]680<p>TableGen supports the '<tt>include</tt>' token, which textually substitutes
681the specified file in place of the include directive. The filename should be
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]682specified as a double quoted string immediately after the '<tt>include</tt>'
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]683keyword. Example:</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]684
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]685<div class="doc_code">
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]686<pre>
Chris Lattner23f54fa2004-02-06 06:37:00 +0000[diff] [blame]687<b>include</b> "foo.td"
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]688</pre>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]689</div>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]690
691</div>
692
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]693<!-- -------------------------------------------------------------------------->
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]694<div class="doc_subsubsection">
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]695 <a name="globallet">'let' expressions</a>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]696</div>
697
698<div class="doc_text">
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]699
700<p>"Let" expressions at file scope are similar to <a href="#recordlet">"let"
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]701expressions within a record</a>, except they can specify a value binding for
702multiple records at a time, and may be useful in certain other cases.
703File-scope let expressions are really just another way that TableGen allows the
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]704end-user to factor out commonality from the records.</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]705
Jeff Cohen0b81cda2005-10-24 16:54:55 +0000[diff] [blame]706<p>File-scope "let" expressions take a comma-separated list of bindings to
Matthijs Kooijman94199da2008-10-20 08:45:34 +0000[diff] [blame]707apply, and one or more records to bind the values in. Here are some
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]708examples:</p>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]709
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]710<div class="doc_code">
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]711<pre>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]712<b>let</b> isTerminator = 1, isReturn = 1, isBarrier = 1, hasCtrlDep = 1 <b>in</b>
713 <b>def</b> RET : I&lt;0xC3, RawFrm, (outs), (ins), "ret", [(X86retflag 0)]&gt;;
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]714
Chris Lattnerfa6f3092004-02-06 06:04:25 +0000[diff] [blame]715<b>let</b> isCall = 1 <b>in</b>
716 <i>// All calls clobber the non-callee saved registers...</i>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]717 <b>let</b> Defs = [EAX, ECX, EDX, FP0, FP1, FP2, FP3, FP4, FP5, FP6, ST0,
718 MM0, MM1, MM2, MM3, MM4, MM5, MM6, MM7,
719 XMM0, XMM1, XMM2, XMM3, XMM4, XMM5, XMM6, XMM7, EFLAGS] <b>in</b> {
Dan Gohman364a39f2008-10-14 17:00:38 +0000[diff] [blame]720 <b>def</b> CALLpcrel32 : Ii32&lt;0xE8, RawFrm, (outs), (ins i32imm:$dst,variable_ops),
721 "call\t${dst:call}", []&gt;;
722 <b>def</b> CALL32r : I&lt;0xFF, MRM2r, (outs), (ins GR32:$dst, variable_ops),
723 "call\t{*}$dst", [(X86call GR32:$dst)]&gt;;
724 <b>def</b> CALL32m : I&lt;0xFF, MRM2m, (outs), (ins i32mem:$dst, variable_ops),
725 "call\t{*}$dst", []&gt;;
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]726 }
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]727</pre>
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]728</div>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]729
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]730<p>File-scope "let" expressions are often useful when a couple of definitions
731need to be added to several records, and the records do not otherwise need to be
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]732opened, as in the case with the <tt>CALL*</tt> instructions above.</p>
733
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]734</div>
735
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]736<!-- *********************************************************************** -->
737<div class="doc_section"><a name="backends">TableGen backends</a></div>
738<!-- *********************************************************************** -->
739
740<div class="doc_text">
Bill Wendling643eb5d2008-02-12 07:06:19 +0000[diff] [blame]741
742<p>TODO: How they work, how to write one. This section should not contain
743details about any particular backend, except maybe -print-enums as an example.
744This should highlight the APIs in <tt>TableGen/Record.h</tt>.</p>
745
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]746</div>
747
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]748<!-- *********************************************************************** -->
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]749
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]750<hr>
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]751<address>
752 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +0000[diff] [blame]753 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]754 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +0000[diff] [blame]755 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]756
757 <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]758 <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]759 Last modified: $Date$
Misha Brukman85234ac2004-05-12 18:31:21 +0000[diff] [blame]760</address>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]761
762</body>
763</html>