as "Instruction".</p>
<p><b>TableGen multiclasses</b> are groups of abstract records that are
-instantiated all at once. Each instantiation can result in multiple TableGen
-definitions.</p>
+instantiated all at once. Each instantiation can result in multiple
+TableGen definitions. If a multiclass inherits from another multiclass,
+the definitions in the sub-multiclass become part of the current
+multiclass, as if they were declared in the current multiclass.</p>
</div>
<b>bit</b> isIndirectBranch = 0;
<b>bit</b> isBarrier = 0;
<b>bit</b> isCall = 0;
- <b>bit</b> isSimpleLoad = 0;
+ <b>bit</b> canFoldAsLoad = 0;
<b>bit</b> mayLoad = 0;
<b>bit</b> mayStore = 0;
<b>bit</b> isImplicitDef = 0;
<b>bit</b> isReMaterializable = 0;
<b>bit</b> isPredicable = 0;
<b>bit</b> hasDelaySlot = 0;
- <b>bit</b> usesCustomDAGSchedInserter = 0;
+ <b>bit</b> usesCustomInserter = 0;
<b>bit</b> hasCtrlDep = 0;
<b>bit</b> isNotDuplicable = 0;
<b>bit</b> hasSideEffects = 0;
- <b>bit</b> mayHaveSideEffects = 0;
<b>bit</b> neverHasSideEffects = 0;
InstrItinClass Itinerary = NoItinerary;
<b>string</b> Constraints = "";
<p>As you can see, a lot of information is needed for every instruction
supported by the code generator, and specifying it all manually would be
-unmaintainble, prone to bugs, and tiring to do in the first place. Because we
+unmaintainable, prone to bugs, and tiring to do in the first place. Because we
are using TableGen, all of the information was derived from the following
definition:</p>
allows it to describe a wide range of information conveniently and compactly.
The TableGen types are:</p>
-<ul>
<dl>
-
-<di><tt><b>bit</b></tt></di>
+<dt><tt><b>bit</b></tt></dt>
<dd>A 'bit' is a boolean value that can hold either 0 or 1.</dd>
-<di><tt><b>int</b></tt></di>
+<dt><tt><b>int</b></tt></dt>
<dd>The 'int' type represents a simple 32-bit integer value, such as 5.</dd>
-<di><tt><b>string</b></tt></di>
+<dt><tt><b>string</b></tt></dt>
<dd>The 'string' type represents an ordered sequence of characters of
arbitrary length.</dd>
-<di><tt><b>bits</b><n></tt></di>
+<dt><tt><b>bits</b><n></tt></dt>
<dd>A 'bits' type is an arbitrary, but fixed, size integer that is broken up
into individual bits. This type is useful because it can handle some bits
being defined while others are undefined.</dd>
-<di><tt><b>list</b><ty></tt></di>
+<dt><tt><b>list</b><ty></tt></dt>
<dd>This type represents a list whose elements are some other type. The
contained type is arbitrary: it can even be another list type.</dd>
-<di>Class type</di>
+<dt>Class type</dt>
<dd>Specifying a class name in a type context means that the defined value
must be a subclass of the specified class. This is useful in conjunction with
the <b><tt>list</tt></b> type, for example, to constrain the elements of the
list to a common base class (e.g., a <tt><b>list</b><Register></tt> can
only contain definitions derived from the "<tt>Register</tt>" class).</dd>
-<di><tt><b>dag</b></tt></di>
+<dt><tt><b>dag</b></tt></dt>
<dd>This type represents a nestable directed graph of elements.</dd>
-<di><tt><b>code</b></tt></di>
+<dt><tt><b>code</b></tt></dt>
<dd>This represents a big hunk of text. NOTE: I don't remember why this is
distinct from string!</dd>
</dl>
-</ul>
<p>To date, these types have been sufficient for describing things that
TableGen has been used for, but it is straight-forward to extend this list if
natural syntax and flavor for the application. The current expression forms
supported include:</p>
-<ul>
<dl>
-<di><tt>?</tt></di>
+<dt><tt>?</tt></dt>
<dd>uninitialized field</dd>
-<di><tt>0b1001011</tt></di>
+<dt><tt>0b1001011</tt></dt>
<dd>binary integer value</dd>
-<di><tt>07654321</tt></di>
+<dt><tt>07654321</tt></dt>
<dd>octal integer value (indicated by a leading 0)</dd>
-<di><tt>7</tt></di>
+<dt><tt>7</tt></dt>
<dd>decimal integer value</dd>
-<di><tt>0x7F</tt></di>
+<dt><tt>0x7F</tt></dt>
<dd>hexadecimal integer value</dd>
-<di><tt>"foo"</tt></di>
+<dt><tt>"foo"</tt></dt>
<dd>string value</dd>
-<di><tt>[{ ... }]</tt></di>
+<dt><tt>[{ ... }]</tt></dt>
<dd>code fragment</dd>
-<di><tt>[ X, Y, Z ]</tt></di>
- <dd>list value.</dd>
-<di><tt>{ a, b, c }</tt></di>
+<dt><tt>[ X, Y, Z ]<type></tt></dt>
+ <dd>list value. <type> is the type of the list
+element and is usually optional. In rare cases,
+TableGen is unable to deduce the element type in
+which case the user must specify it explicitly.</dd>
+<dt><tt>{ a, b, c }</tt></dt>
<dd>initializer for a "bits<3>" value</dd>
-<di><tt>value</tt></di>
+<dt><tt>value</tt></dt>
<dd>value reference</dd>
-<di><tt>value{17}</tt></di>
+<dt><tt>value{17}</tt></dt>
<dd>access to one bit of a value</dd>
-<di><tt>value{15-17}</tt></di>
+<dt><tt>value{15-17}</tt></dt>
<dd>access to multiple bits of a value</dd>
-<di><tt>DEF</tt></di>
+<dt><tt>DEF</tt></dt>
<dd>reference to a record definition</dd>
-<di><tt>CLASS<val list></tt></di>
+<dt><tt>CLASS<val list></tt></dt>
<dd>reference to a new anonymous definition of CLASS with the specified
template arguments.</dd>
-<di><tt>X.Y</tt></di>
+<dt><tt>X.Y</tt></dt>
<dd>reference to the subfield of a value</dd>
-<di><tt>list[4-7,17,2-3]</tt></di>
+<dt><tt>list[4-7,17,2-3]</tt></dt>
<dd>A slice of the 'list' list, including elements 4,5,6,7,17,2, and 3 from
it. Elements may be included multiple times.</dd>
-<di><tt>(DEF a, b)</tt></di>
+<dt><tt>(DEF a, b)</tt></dt>
<dd>a dag value. The first element is required to be a record definition, the
remaining elements in the list may be arbitrary other values, including nested
`<tt>dag</tt>' values.</dd>
-<di><tt>!strconcat(a, b)</tt></di>
+<dt><tt>!strconcat(a, b)</tt></dt>
<dd>A string value that is the result of concatenating the 'a' and 'b'
strings.</dd>
+<dt><tt>!cast<type>(a)</tt></dt>
+ <dd>A symbol of type <em>type</em> obtained by looking up the string 'a' in
+the symbol table. If the type of 'a' does not match <em>type</em>, TableGen
+aborts with an error. !cast<string> is a special case in that the argument must
+be an object defined by a 'def' construct.</dd>
+<dt><tt>!nameconcat<type>(a, b)</tt></dt>
+ <dd>Shorthand for !cast<type>(!strconcat(a, b))</dd>
+<dt><tt>!subst(a, b, c)</tt></dt>
+ <dd>If 'a' and 'b' are of string type or are symbol references, substitute
+'b' for 'a' in 'c.' This operation is analogous to $(subst) in GNU make.</dd>
+<dt><tt>!foreach(a, b, c)</tt></dt>
+ <dd>For each member 'b' of dag or list 'a' apply operator 'c.' 'b' is a
+dummy variable that should be declared as a member variable of an instantiated
+class. This operation is analogous to $(foreach) in GNU make.</dd>
+<dt><tt>!car(a)</tt></dt>
+ <dd>The first element of list 'a.'</dd>
+<dt><tt>!cdr(a)</tt></dt>
+ <dd>The 2nd-N elements of list 'a.'</dd>
+<dt><tt>!null(a)</tt></dt>
+ <dd>An integer {0,1} indicating whether list 'a' is empty.</dd>
+<dt><tt>!if(a,b,c)</tt></dt>
+ <dd>'b' if the result of integer operator 'a' is nonzero, 'c' otherwise.</dd>
+<dt><tt>!eq(a,b)</tt></dt>
+ <dd>Integer one if string a is equal to string b, zero otherwise. This
+ only operates on string objects. Use !cast<string> to compare other
+ types of objects.</dd>
</dl>
-</ul>
<p>Note that all of the values have rules specifying how they convert to values
for different types. These rules allow you to assign a value like "<tt>7</tt>"
<p>The name of the resultant definitions has the multidef fragment names
appended to them, so this defines <tt>ADD_rr</tt>, <tt>ADD_ri</tt>,
- <tt>SUB_rr</tt>, etc. Using a multiclass this way is exactly equivalent to
- instantiating the classes multiple times yourself, e.g. by writing:</p>
+ <tt>SUB_rr</tt>, etc. A defm may inherit from multiple multiclasses,
+ instantiating definitions from each multiclass. Using a multiclass
+ this way is exactly equivalent to instantiating the classes multiple
+ times yourself, e.g. by writing:</p>
<div class="doc_code">
<pre>
end-user to factor out commonality from the records.</p>
<p>File-scope "let" expressions take a comma-separated list of bindings to
-apply, and one of more records to bind the values in. Here are some
+apply, and one or more records to bind the values in. Here are some
examples:</p>
<div class="doc_code">
<b>let</b> Defs = [EAX, ECX, EDX, FP0, FP1, FP2, FP3, FP4, FP5, FP6, ST0,
MM0, MM1, MM2, MM3, MM4, MM5, MM6, MM7,
XMM0, XMM1, XMM2, XMM3, XMM4, XMM5, XMM6, XMM7, EFLAGS] <b>in</b> {
- <b>def</b> CALLpcrel32 : Ii32<0xE8, RawFrm, (outs), (ins i32imm:$dst,variable_ops),
- "call\t${dst:call}", []>;
- <b>def</b> CALL32r : I<0xFF, MRM2r, (outs), (ins GR32:$dst, variable_ops),
- "call\t{*}$dst", [(X86call GR32:$dst)]>;
- <b>def</b> CALL32m : I<0xFF, MRM2m, (outs), (ins i32mem:$dst, variable_ops),
- "call\t{*}$dst", []>;
+ <b>def</b> CALLpcrel32 : Ii32<0xE8, RawFrm, (outs), (ins i32imm:$dst,variable_ops),
+ "call\t${dst:call}", []>;
+ <b>def</b> CALL32r : I<0xFF, MRM2r, (outs), (ins GR32:$dst, variable_ops),
+ "call\t{*}$dst", [(X86call GR32:$dst)]>;
+ <b>def</b> CALL32m : I<0xFF, MRM2m, (outs), (ins i32mem:$dst, variable_ops),
+ "call\t{*}$dst", []>;
}
</pre>
</div>
</div>
+<!-- *********************************************************************** -->
+<div class="doc_section"><a name="codegen">Code Generator backend info</a></div>
+<!-- *********************************************************************** -->
+
+<p>Expressions used by code generator to describe instructions and isel
+patterns:</p>
+
+<div class="doc_text">
+
+<dt><tt>(implicit a)</tt></dt>
+ <dd>an implicitly defined physical register. This tells the dag instruction
+ selection emitter the input pattern's extra definitions matches implicit
+ physical register definitions.</dd>
+<dt><tt>(parallel (a), (b))</tt></dt>
+ <dd>a list of dags specifying parallel operations which map to the same
+ instruction.</dd>
+
+</div>
+
<!-- *********************************************************************** -->
<div class="doc_section"><a name="backends">TableGen backends</a></div>
<!-- *********************************************************************** -->
<hr>
<address>
<a href="http://jigsaw.w3.org/css-validator/check/referer"><img
- src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
+ src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
<a href="http://validator.w3.org/check/referer"><img
- src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
+ src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
<a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
<a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
projects / oota-llvm.git / blobdiff