]>
Commit | Line | Data |
---|---|---|
b5e01d4b | 1 | @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1996, 1998, 1999, 2000, 2001, |
feeeff5c | 2 | @c 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 |
66647d44 | 3 | @c Free Software Foundation, Inc. |
03dda8e3 RK |
4 | @c This is part of the GCC manual. |
5 | @c For copying conditions, see the file gcc.texi. | |
6 | ||
7 | @ifset INTERNALS | |
8 | @node Machine Desc | |
9 | @chapter Machine Descriptions | |
10 | @cindex machine descriptions | |
11 | ||
12 | A machine description has two parts: a file of instruction patterns | |
13 | (@file{.md} file) and a C header file of macro definitions. | |
14 | ||
15 | The @file{.md} file for a target machine contains a pattern for each | |
16 | instruction that the target machine supports (or at least each instruction | |
17 | that is worth telling the compiler about). It may also contain comments. | |
18 | A semicolon causes the rest of the line to be a comment, unless the semicolon | |
19 | is inside a quoted string. | |
20 | ||
21 | See the next chapter for information on the C header file. | |
22 | ||
23 | @menu | |
55e4756f | 24 | * Overview:: How the machine description is used. |
03dda8e3 RK |
25 | * Patterns:: How to write instruction patterns. |
26 | * Example:: An explained example of a @code{define_insn} pattern. | |
27 | * RTL Template:: The RTL template defines what insns match a pattern. | |
28 | * Output Template:: The output template says how to make assembler code | |
6ccde948 | 29 | from such an insn. |
03dda8e3 | 30 | * Output Statement:: For more generality, write C code to output |
6ccde948 | 31 | the assembler code. |
e543e219 | 32 | * Predicates:: Controlling what kinds of operands can be used |
6ccde948 | 33 | for an insn. |
e543e219 | 34 | * Constraints:: Fine-tuning operand selection. |
03dda8e3 RK |
35 | * Standard Names:: Names mark patterns to use for code generation. |
36 | * Pattern Ordering:: When the order of patterns makes a difference. | |
37 | * Dependent Patterns:: Having one pattern may make you need another. | |
38 | * Jump Patterns:: Special considerations for patterns for jump insns. | |
6e4fcc95 | 39 | * Looping Patterns:: How to define patterns for special looping insns. |
03dda8e3 | 40 | * Insn Canonicalizations::Canonicalization of Instructions |
03dda8e3 | 41 | * Expander Definitions::Generating a sequence of several RTL insns |
6ccde948 | 42 | for a standard operation. |
f3a3d0d3 | 43 | * Insn Splitting:: Splitting Instructions into Multiple Instructions. |
6ccde948 | 44 | * Including Patterns:: Including Patterns in Machine Descriptions. |
f3a3d0d3 | 45 | * Peephole Definitions::Defining machine-specific peephole optimizations. |
03dda8e3 | 46 | * Insn Attributes:: Specifying the value of attributes for generated insns. |
3262c1f5 | 47 | * Conditional Execution::Generating @code{define_insn} patterns for |
6ccde948 | 48 | predication. |
c25c12b8 R |
49 | * Constant Definitions::Defining symbolic constants that can be used in the |
50 | md file. | |
3abcb3a7 | 51 | * Iterators:: Using iterators to generate patterns from a template. |
03dda8e3 RK |
52 | @end menu |
53 | ||
55e4756f DD |
54 | @node Overview |
55 | @section Overview of How the Machine Description is Used | |
56 | ||
57 | There are three main conversions that happen in the compiler: | |
58 | ||
59 | @enumerate | |
60 | ||
61 | @item | |
62 | The front end reads the source code and builds a parse tree. | |
63 | ||
64 | @item | |
65 | The parse tree is used to generate an RTL insn list based on named | |
66 | instruction patterns. | |
67 | ||
68 | @item | |
69 | The insn list is matched against the RTL templates to produce assembler | |
70 | code. | |
71 | ||
72 | @end enumerate | |
73 | ||
74 | For the generate pass, only the names of the insns matter, from either a | |
75 | named @code{define_insn} or a @code{define_expand}. The compiler will | |
76 | choose the pattern with the right name and apply the operands according | |
77 | to the documentation later in this chapter, without regard for the RTL | |
78 | template or operand constraints. Note that the names the compiler looks | |
d7d9c429 | 79 | for are hard-coded in the compiler---it will ignore unnamed patterns and |
55e4756f DD |
80 | patterns with names it doesn't know about, but if you don't provide a |
81 | named pattern it needs, it will abort. | |
82 | ||
83 | If a @code{define_insn} is used, the template given is inserted into the | |
84 | insn list. If a @code{define_expand} is used, one of three things | |
85 | happens, based on the condition logic. The condition logic may manually | |
86 | create new insns for the insn list, say via @code{emit_insn()}, and | |
aee96fe9 | 87 | invoke @code{DONE}. For certain named patterns, it may invoke @code{FAIL} to tell the |
55e4756f DD |
88 | compiler to use an alternate way of performing that task. If it invokes |
89 | neither @code{DONE} nor @code{FAIL}, the template given in the pattern | |
90 | is inserted, as if the @code{define_expand} were a @code{define_insn}. | |
91 | ||
92 | Once the insn list is generated, various optimization passes convert, | |
93 | replace, and rearrange the insns in the insn list. This is where the | |
94 | @code{define_split} and @code{define_peephole} patterns get used, for | |
95 | example. | |
96 | ||
97 | Finally, the insn list's RTL is matched up with the RTL templates in the | |
98 | @code{define_insn} patterns, and those patterns are used to emit the | |
99 | final assembly code. For this purpose, each named @code{define_insn} | |
100 | acts like it's unnamed, since the names are ignored. | |
101 | ||
03dda8e3 RK |
102 | @node Patterns |
103 | @section Everything about Instruction Patterns | |
104 | @cindex patterns | |
105 | @cindex instruction patterns | |
106 | ||
107 | @findex define_insn | |
108 | Each instruction pattern contains an incomplete RTL expression, with pieces | |
109 | to be filled in later, operand constraints that restrict how the pieces can | |
110 | be filled in, and an output pattern or C code to generate the assembler | |
111 | output, all wrapped up in a @code{define_insn} expression. | |
112 | ||
113 | A @code{define_insn} is an RTL expression containing four or five operands: | |
114 | ||
115 | @enumerate | |
116 | @item | |
117 | An optional name. The presence of a name indicate that this instruction | |
118 | pattern can perform a certain standard job for the RTL-generation | |
119 | pass of the compiler. This pass knows certain names and will use | |
120 | the instruction patterns with those names, if the names are defined | |
121 | in the machine description. | |
122 | ||
123 | The absence of a name is indicated by writing an empty string | |
124 | where the name should go. Nameless instruction patterns are never | |
125 | used for generating RTL code, but they may permit several simpler insns | |
126 | to be combined later on. | |
127 | ||
128 | Names that are not thus known and used in RTL-generation have no | |
129 | effect; they are equivalent to no name at all. | |
130 | ||
661cb0b7 RK |
131 | For the purpose of debugging the compiler, you may also specify a |
132 | name beginning with the @samp{*} character. Such a name is used only | |
133 | for identifying the instruction in RTL dumps; it is entirely equivalent | |
134 | to having a nameless pattern for all other purposes. | |
135 | ||
03dda8e3 RK |
136 | @item |
137 | The @dfn{RTL template} (@pxref{RTL Template}) is a vector of incomplete | |
138 | RTL expressions which show what the instruction should look like. It is | |
139 | incomplete because it may contain @code{match_operand}, | |
140 | @code{match_operator}, and @code{match_dup} expressions that stand for | |
141 | operands of the instruction. | |
142 | ||
143 | If the vector has only one element, that element is the template for the | |
144 | instruction pattern. If the vector has multiple elements, then the | |
145 | instruction pattern is a @code{parallel} expression containing the | |
146 | elements described. | |
147 | ||
148 | @item | |
149 | @cindex pattern conditions | |
150 | @cindex conditions, in patterns | |
151 | A condition. This is a string which contains a C expression that is | |
152 | the final test to decide whether an insn body matches this pattern. | |
153 | ||
154 | @cindex named patterns and conditions | |
155 | For a named pattern, the condition (if present) may not depend on | |
156 | the data in the insn being matched, but only the target-machine-type | |
157 | flags. The compiler needs to test these conditions during | |
158 | initialization in order to learn exactly which named instructions are | |
159 | available in a particular run. | |
160 | ||
161 | @findex operands | |
162 | For nameless patterns, the condition is applied only when matching an | |
163 | individual insn, and only after the insn has matched the pattern's | |
164 | recognition template. The insn's operands may be found in the vector | |
fde6d81f HPN |
165 | @code{operands}. For an insn where the condition has once matched, it |
166 | can't be used to control register allocation, for example by excluding | |
167 | certain hard registers or hard register combinations. | |
03dda8e3 RK |
168 | |
169 | @item | |
170 | The @dfn{output template}: a string that says how to output matching | |
171 | insns as assembler code. @samp{%} in this string specifies where | |
172 | to substitute the value of an operand. @xref{Output Template}. | |
173 | ||
174 | When simple substitution isn't general enough, you can specify a piece | |
175 | of C code to compute the output. @xref{Output Statement}. | |
176 | ||
177 | @item | |
178 | Optionally, a vector containing the values of attributes for insns matching | |
179 | this pattern. @xref{Insn Attributes}. | |
180 | @end enumerate | |
181 | ||
182 | @node Example | |
183 | @section Example of @code{define_insn} | |
184 | @cindex @code{define_insn} example | |
185 | ||
186 | Here is an actual example of an instruction pattern, for the 68000/68020. | |
187 | ||
3ab51846 | 188 | @smallexample |
03dda8e3 RK |
189 | (define_insn "tstsi" |
190 | [(set (cc0) | |
191 | (match_operand:SI 0 "general_operand" "rm"))] | |
192 | "" | |
193 | "* | |
f282ffb3 | 194 | @{ |
0f40f9f7 | 195 | if (TARGET_68020 || ! ADDRESS_REG_P (operands[0])) |
03dda8e3 | 196 | return \"tstl %0\"; |
f282ffb3 | 197 | return \"cmpl #0,%0\"; |
0f40f9f7 | 198 | @}") |
3ab51846 | 199 | @end smallexample |
0f40f9f7 ZW |
200 | |
201 | @noindent | |
202 | This can also be written using braced strings: | |
203 | ||
3ab51846 | 204 | @smallexample |
0f40f9f7 ZW |
205 | (define_insn "tstsi" |
206 | [(set (cc0) | |
207 | (match_operand:SI 0 "general_operand" "rm"))] | |
208 | "" | |
f282ffb3 | 209 | @{ |
0f40f9f7 ZW |
210 | if (TARGET_68020 || ! ADDRESS_REG_P (operands[0])) |
211 | return "tstl %0"; | |
f282ffb3 | 212 | return "cmpl #0,%0"; |
0f40f9f7 | 213 | @}) |
3ab51846 | 214 | @end smallexample |
03dda8e3 RK |
215 | |
216 | This is an instruction that sets the condition codes based on the value of | |
217 | a general operand. It has no condition, so any insn whose RTL description | |
218 | has the form shown may be handled according to this pattern. The name | |
219 | @samp{tstsi} means ``test a @code{SImode} value'' and tells the RTL generation | |
220 | pass that, when it is necessary to test such a value, an insn to do so | |
221 | can be constructed using this pattern. | |
222 | ||
223 | The output control string is a piece of C code which chooses which | |
224 | output template to return based on the kind of operand and the specific | |
225 | type of CPU for which code is being generated. | |
226 | ||
227 | @samp{"rm"} is an operand constraint. Its meaning is explained below. | |
228 | ||
229 | @node RTL Template | |
230 | @section RTL Template | |
231 | @cindex RTL insn template | |
232 | @cindex generating insns | |
233 | @cindex insns, generating | |
234 | @cindex recognizing insns | |
235 | @cindex insns, recognizing | |
236 | ||
237 | The RTL template is used to define which insns match the particular pattern | |
238 | and how to find their operands. For named patterns, the RTL template also | |
239 | says how to construct an insn from specified operands. | |
240 | ||
241 | Construction involves substituting specified operands into a copy of the | |
242 | template. Matching involves determining the values that serve as the | |
243 | operands in the insn being matched. Both of these activities are | |
244 | controlled by special expression types that direct matching and | |
245 | substitution of the operands. | |
246 | ||
247 | @table @code | |
248 | @findex match_operand | |
249 | @item (match_operand:@var{m} @var{n} @var{predicate} @var{constraint}) | |
250 | This expression is a placeholder for operand number @var{n} of | |
251 | the insn. When constructing an insn, operand number @var{n} | |
252 | will be substituted at this point. When matching an insn, whatever | |
253 | appears at this position in the insn will be taken as operand | |
254 | number @var{n}; but it must satisfy @var{predicate} or this instruction | |
255 | pattern will not match at all. | |
256 | ||
257 | Operand numbers must be chosen consecutively counting from zero in | |
258 | each instruction pattern. There may be only one @code{match_operand} | |
259 | expression in the pattern for each operand number. Usually operands | |
260 | are numbered in the order of appearance in @code{match_operand} | |
72938a4c MM |
261 | expressions. In the case of a @code{define_expand}, any operand numbers |
262 | used only in @code{match_dup} expressions have higher values than all | |
263 | other operand numbers. | |
03dda8e3 | 264 | |
e543e219 ZW |
265 | @var{predicate} is a string that is the name of a function that |
266 | accepts two arguments, an expression and a machine mode. | |
267 | @xref{Predicates}. During matching, the function will be called with | |
268 | the putative operand as the expression and @var{m} as the mode | |
269 | argument (if @var{m} is not specified, @code{VOIDmode} will be used, | |
270 | which normally causes @var{predicate} to accept any mode). If it | |
271 | returns zero, this instruction pattern fails to match. | |
272 | @var{predicate} may be an empty string; then it means no test is to be | |
273 | done on the operand, so anything which occurs in this position is | |
274 | valid. | |
03dda8e3 RK |
275 | |
276 | Most of the time, @var{predicate} will reject modes other than @var{m}---but | |
277 | not always. For example, the predicate @code{address_operand} uses | |
278 | @var{m} as the mode of memory ref that the address should be valid for. | |
279 | Many predicates accept @code{const_int} nodes even though their mode is | |
280 | @code{VOIDmode}. | |
281 | ||
282 | @var{constraint} controls reloading and the choice of the best register | |
283 | class to use for a value, as explained later (@pxref{Constraints}). | |
e543e219 | 284 | If the constraint would be an empty string, it can be omitted. |
03dda8e3 RK |
285 | |
286 | People are often unclear on the difference between the constraint and the | |
287 | predicate. The predicate helps decide whether a given insn matches the | |
288 | pattern. The constraint plays no role in this decision; instead, it | |
289 | controls various decisions in the case of an insn which does match. | |
290 | ||
03dda8e3 RK |
291 | @findex match_scratch |
292 | @item (match_scratch:@var{m} @var{n} @var{constraint}) | |
293 | This expression is also a placeholder for operand number @var{n} | |
294 | and indicates that operand must be a @code{scratch} or @code{reg} | |
295 | expression. | |
296 | ||
297 | When matching patterns, this is equivalent to | |
298 | ||
299 | @smallexample | |
300 | (match_operand:@var{m} @var{n} "scratch_operand" @var{pred}) | |
301 | @end smallexample | |
302 | ||
303 | but, when generating RTL, it produces a (@code{scratch}:@var{m}) | |
304 | expression. | |
305 | ||
306 | If the last few expressions in a @code{parallel} are @code{clobber} | |
307 | expressions whose operands are either a hard register or | |
308 | @code{match_scratch}, the combiner can add or delete them when | |
309 | necessary. @xref{Side Effects}. | |
310 | ||
311 | @findex match_dup | |
312 | @item (match_dup @var{n}) | |
313 | This expression is also a placeholder for operand number @var{n}. | |
314 | It is used when the operand needs to appear more than once in the | |
315 | insn. | |
316 | ||
317 | In construction, @code{match_dup} acts just like @code{match_operand}: | |
318 | the operand is substituted into the insn being constructed. But in | |
319 | matching, @code{match_dup} behaves differently. It assumes that operand | |
320 | number @var{n} has already been determined by a @code{match_operand} | |
321 | appearing earlier in the recognition template, and it matches only an | |
322 | identical-looking expression. | |
323 | ||
55e4756f DD |
324 | Note that @code{match_dup} should not be used to tell the compiler that |
325 | a particular register is being used for two operands (example: | |
326 | @code{add} that adds one register to another; the second register is | |
327 | both an input operand and the output operand). Use a matching | |
328 | constraint (@pxref{Simple Constraints}) for those. @code{match_dup} is for the cases where one | |
329 | operand is used in two places in the template, such as an instruction | |
330 | that computes both a quotient and a remainder, where the opcode takes | |
331 | two input operands but the RTL template has to refer to each of those | |
332 | twice; once for the quotient pattern and once for the remainder pattern. | |
333 | ||
03dda8e3 RK |
334 | @findex match_operator |
335 | @item (match_operator:@var{m} @var{n} @var{predicate} [@var{operands}@dots{}]) | |
336 | This pattern is a kind of placeholder for a variable RTL expression | |
337 | code. | |
338 | ||
339 | When constructing an insn, it stands for an RTL expression whose | |
340 | expression code is taken from that of operand @var{n}, and whose | |
341 | operands are constructed from the patterns @var{operands}. | |
342 | ||
343 | When matching an expression, it matches an expression if the function | |
344 | @var{predicate} returns nonzero on that expression @emph{and} the | |
345 | patterns @var{operands} match the operands of the expression. | |
346 | ||
347 | Suppose that the function @code{commutative_operator} is defined as | |
348 | follows, to match any expression whose operator is one of the | |
349 | commutative arithmetic operators of RTL and whose mode is @var{mode}: | |
350 | ||
351 | @smallexample | |
352 | int | |
ec8e098d | 353 | commutative_integer_operator (x, mode) |
03dda8e3 RK |
354 | rtx x; |
355 | enum machine_mode mode; | |
356 | @{ | |
357 | enum rtx_code code = GET_CODE (x); | |
358 | if (GET_MODE (x) != mode) | |
359 | return 0; | |
ec8e098d | 360 | return (GET_RTX_CLASS (code) == RTX_COMM_ARITH |
03dda8e3 RK |
361 | || code == EQ || code == NE); |
362 | @} | |
363 | @end smallexample | |
364 | ||
365 | Then the following pattern will match any RTL expression consisting | |
366 | of a commutative operator applied to two general operands: | |
367 | ||
368 | @smallexample | |
369 | (match_operator:SI 3 "commutative_operator" | |
370 | [(match_operand:SI 1 "general_operand" "g") | |
371 | (match_operand:SI 2 "general_operand" "g")]) | |
372 | @end smallexample | |
373 | ||
374 | Here the vector @code{[@var{operands}@dots{}]} contains two patterns | |
375 | because the expressions to be matched all contain two operands. | |
376 | ||
377 | When this pattern does match, the two operands of the commutative | |
378 | operator are recorded as operands 1 and 2 of the insn. (This is done | |
379 | by the two instances of @code{match_operand}.) Operand 3 of the insn | |
380 | will be the entire commutative expression: use @code{GET_CODE | |
381 | (operands[3])} to see which commutative operator was used. | |
382 | ||
383 | The machine mode @var{m} of @code{match_operator} works like that of | |
384 | @code{match_operand}: it is passed as the second argument to the | |
385 | predicate function, and that function is solely responsible for | |
386 | deciding whether the expression to be matched ``has'' that mode. | |
387 | ||
388 | When constructing an insn, argument 3 of the gen-function will specify | |
e979f9e8 | 389 | the operation (i.e.@: the expression code) for the expression to be |
03dda8e3 RK |
390 | made. It should be an RTL expression, whose expression code is copied |
391 | into a new expression whose operands are arguments 1 and 2 of the | |
392 | gen-function. The subexpressions of argument 3 are not used; | |
393 | only its expression code matters. | |
394 | ||
395 | When @code{match_operator} is used in a pattern for matching an insn, | |
396 | it usually best if the operand number of the @code{match_operator} | |
397 | is higher than that of the actual operands of the insn. This improves | |
398 | register allocation because the register allocator often looks at | |
399 | operands 1 and 2 of insns to see if it can do register tying. | |
400 | ||
401 | There is no way to specify constraints in @code{match_operator}. The | |
402 | operand of the insn which corresponds to the @code{match_operator} | |
403 | never has any constraints because it is never reloaded as a whole. | |
404 | However, if parts of its @var{operands} are matched by | |
405 | @code{match_operand} patterns, those parts may have constraints of | |
406 | their own. | |
407 | ||
408 | @findex match_op_dup | |
409 | @item (match_op_dup:@var{m} @var{n}[@var{operands}@dots{}]) | |
410 | Like @code{match_dup}, except that it applies to operators instead of | |
411 | operands. When constructing an insn, operand number @var{n} will be | |
412 | substituted at this point. But in matching, @code{match_op_dup} behaves | |
413 | differently. It assumes that operand number @var{n} has already been | |
414 | determined by a @code{match_operator} appearing earlier in the | |
415 | recognition template, and it matches only an identical-looking | |
416 | expression. | |
417 | ||
418 | @findex match_parallel | |
419 | @item (match_parallel @var{n} @var{predicate} [@var{subpat}@dots{}]) | |
420 | This pattern is a placeholder for an insn that consists of a | |
421 | @code{parallel} expression with a variable number of elements. This | |
422 | expression should only appear at the top level of an insn pattern. | |
423 | ||
424 | When constructing an insn, operand number @var{n} will be substituted at | |
425 | this point. When matching an insn, it matches if the body of the insn | |
426 | is a @code{parallel} expression with at least as many elements as the | |
427 | vector of @var{subpat} expressions in the @code{match_parallel}, if each | |
428 | @var{subpat} matches the corresponding element of the @code{parallel}, | |
429 | @emph{and} the function @var{predicate} returns nonzero on the | |
430 | @code{parallel} that is the body of the insn. It is the responsibility | |
431 | of the predicate to validate elements of the @code{parallel} beyond | |
bd819a4a | 432 | those listed in the @code{match_parallel}. |
03dda8e3 RK |
433 | |
434 | A typical use of @code{match_parallel} is to match load and store | |
435 | multiple expressions, which can contain a variable number of elements | |
436 | in a @code{parallel}. For example, | |
03dda8e3 RK |
437 | |
438 | @smallexample | |
439 | (define_insn "" | |
440 | [(match_parallel 0 "load_multiple_operation" | |
441 | [(set (match_operand:SI 1 "gpc_reg_operand" "=r") | |
442 | (match_operand:SI 2 "memory_operand" "m")) | |
443 | (use (reg:SI 179)) | |
444 | (clobber (reg:SI 179))])] | |
445 | "" | |
446 | "loadm 0,0,%1,%2") | |
447 | @end smallexample | |
448 | ||
449 | This example comes from @file{a29k.md}. The function | |
9c34dbbf | 450 | @code{load_multiple_operation} is defined in @file{a29k.c} and checks |
03dda8e3 RK |
451 | that subsequent elements in the @code{parallel} are the same as the |
452 | @code{set} in the pattern, except that they are referencing subsequent | |
453 | registers and memory locations. | |
454 | ||
455 | An insn that matches this pattern might look like: | |
456 | ||
457 | @smallexample | |
458 | (parallel | |
459 | [(set (reg:SI 20) (mem:SI (reg:SI 100))) | |
460 | (use (reg:SI 179)) | |
461 | (clobber (reg:SI 179)) | |
462 | (set (reg:SI 21) | |
463 | (mem:SI (plus:SI (reg:SI 100) | |
464 | (const_int 4)))) | |
465 | (set (reg:SI 22) | |
466 | (mem:SI (plus:SI (reg:SI 100) | |
467 | (const_int 8))))]) | |
468 | @end smallexample | |
469 | ||
470 | @findex match_par_dup | |
471 | @item (match_par_dup @var{n} [@var{subpat}@dots{}]) | |
472 | Like @code{match_op_dup}, but for @code{match_parallel} instead of | |
473 | @code{match_operator}. | |
474 | ||
03dda8e3 RK |
475 | @end table |
476 | ||
477 | @node Output Template | |
478 | @section Output Templates and Operand Substitution | |
479 | @cindex output templates | |
480 | @cindex operand substitution | |
481 | ||
482 | @cindex @samp{%} in template | |
483 | @cindex percent sign | |
484 | The @dfn{output template} is a string which specifies how to output the | |
485 | assembler code for an instruction pattern. Most of the template is a | |
486 | fixed string which is output literally. The character @samp{%} is used | |
487 | to specify where to substitute an operand; it can also be used to | |
488 | identify places where different variants of the assembler require | |
489 | different syntax. | |
490 | ||
491 | In the simplest case, a @samp{%} followed by a digit @var{n} says to output | |
492 | operand @var{n} at that point in the string. | |
493 | ||
494 | @samp{%} followed by a letter and a digit says to output an operand in an | |
495 | alternate fashion. Four letters have standard, built-in meanings described | |
496 | below. The machine description macro @code{PRINT_OPERAND} can define | |
497 | additional letters with nonstandard meanings. | |
498 | ||
499 | @samp{%c@var{digit}} can be used to substitute an operand that is a | |
500 | constant value without the syntax that normally indicates an immediate | |
501 | operand. | |
502 | ||
503 | @samp{%n@var{digit}} is like @samp{%c@var{digit}} except that the value of | |
504 | the constant is negated before printing. | |
505 | ||
506 | @samp{%a@var{digit}} can be used to substitute an operand as if it were a | |
507 | memory reference, with the actual operand treated as the address. This may | |
508 | be useful when outputting a ``load address'' instruction, because often the | |
509 | assembler syntax for such an instruction requires you to write the operand | |
510 | as if it were a memory reference. | |
511 | ||
512 | @samp{%l@var{digit}} is used to substitute a @code{label_ref} into a jump | |
513 | instruction. | |
514 | ||
515 | @samp{%=} outputs a number which is unique to each instruction in the | |
516 | entire compilation. This is useful for making local labels to be | |
517 | referred to more than once in a single template that generates multiple | |
518 | assembler instructions. | |
519 | ||
520 | @samp{%} followed by a punctuation character specifies a substitution that | |
521 | does not use an operand. Only one case is standard: @samp{%%} outputs a | |
522 | @samp{%} into the assembler code. Other nonstandard cases can be | |
523 | defined in the @code{PRINT_OPERAND} macro. You must also define | |
524 | which punctuation characters are valid with the | |
525 | @code{PRINT_OPERAND_PUNCT_VALID_P} macro. | |
526 | ||
527 | @cindex \ | |
528 | @cindex backslash | |
529 | The template may generate multiple assembler instructions. Write the text | |
530 | for the instructions, with @samp{\;} between them. | |
531 | ||
532 | @cindex matching operands | |
533 | When the RTL contains two operands which are required by constraint to match | |
534 | each other, the output template must refer only to the lower-numbered operand. | |
535 | Matching operands are not always identical, and the rest of the compiler | |
536 | arranges to put the proper RTL expression for printing into the lower-numbered | |
537 | operand. | |
538 | ||
539 | One use of nonstandard letters or punctuation following @samp{%} is to | |
540 | distinguish between different assembler languages for the same machine; for | |
541 | example, Motorola syntax versus MIT syntax for the 68000. Motorola syntax | |
542 | requires periods in most opcode names, while MIT syntax does not. For | |
543 | example, the opcode @samp{movel} in MIT syntax is @samp{move.l} in Motorola | |
544 | syntax. The same file of patterns is used for both kinds of output syntax, | |
545 | but the character sequence @samp{%.} is used in each place where Motorola | |
546 | syntax wants a period. The @code{PRINT_OPERAND} macro for Motorola syntax | |
547 | defines the sequence to output a period; the macro for MIT syntax defines | |
548 | it to do nothing. | |
549 | ||
550 | @cindex @code{#} in template | |
551 | As a special case, a template consisting of the single character @code{#} | |
552 | instructs the compiler to first split the insn, and then output the | |
553 | resulting instructions separately. This helps eliminate redundancy in the | |
554 | output templates. If you have a @code{define_insn} that needs to emit | |
e4ae5e77 | 555 | multiple assembler instructions, and there is a matching @code{define_split} |
03dda8e3 RK |
556 | already defined, then you can simply use @code{#} as the output template |
557 | instead of writing an output template that emits the multiple assembler | |
558 | instructions. | |
559 | ||
560 | If the macro @code{ASSEMBLER_DIALECT} is defined, you can use construct | |
561 | of the form @samp{@{option0|option1|option2@}} in the templates. These | |
562 | describe multiple variants of assembler language syntax. | |
563 | @xref{Instruction Output}. | |
564 | ||
565 | @node Output Statement | |
566 | @section C Statements for Assembler Output | |
567 | @cindex output statements | |
568 | @cindex C statements for assembler output | |
569 | @cindex generating assembler output | |
570 | ||
571 | Often a single fixed template string cannot produce correct and efficient | |
572 | assembler code for all the cases that are recognized by a single | |
573 | instruction pattern. For example, the opcodes may depend on the kinds of | |
574 | operands; or some unfortunate combinations of operands may require extra | |
575 | machine instructions. | |
576 | ||
577 | If the output control string starts with a @samp{@@}, then it is actually | |
578 | a series of templates, each on a separate line. (Blank lines and | |
579 | leading spaces and tabs are ignored.) The templates correspond to the | |
580 | pattern's constraint alternatives (@pxref{Multi-Alternative}). For example, | |
581 | if a target machine has a two-address add instruction @samp{addr} to add | |
582 | into a register and another @samp{addm} to add a register to memory, you | |
583 | might write this pattern: | |
584 | ||
585 | @smallexample | |
586 | (define_insn "addsi3" | |
587 | [(set (match_operand:SI 0 "general_operand" "=r,m") | |
588 | (plus:SI (match_operand:SI 1 "general_operand" "0,0") | |
589 | (match_operand:SI 2 "general_operand" "g,r")))] | |
590 | "" | |
591 | "@@ | |
592 | addr %2,%0 | |
593 | addm %2,%0") | |
594 | @end smallexample | |
595 | ||
596 | @cindex @code{*} in template | |
597 | @cindex asterisk in template | |
598 | If the output control string starts with a @samp{*}, then it is not an | |
599 | output template but rather a piece of C program that should compute a | |
600 | template. It should execute a @code{return} statement to return the | |
601 | template-string you want. Most such templates use C string literals, which | |
602 | require doublequote characters to delimit them. To include these | |
603 | doublequote characters in the string, prefix each one with @samp{\}. | |
604 | ||
0f40f9f7 ZW |
605 | If the output control string is written as a brace block instead of a |
606 | double-quoted string, it is automatically assumed to be C code. In that | |
607 | case, it is not necessary to put in a leading asterisk, or to escape the | |
608 | doublequotes surrounding C string literals. | |
609 | ||
03dda8e3 RK |
610 | The operands may be found in the array @code{operands}, whose C data type |
611 | is @code{rtx []}. | |
612 | ||
613 | It is very common to select different ways of generating assembler code | |
614 | based on whether an immediate operand is within a certain range. Be | |
615 | careful when doing this, because the result of @code{INTVAL} is an | |
616 | integer on the host machine. If the host machine has more bits in an | |
617 | @code{int} than the target machine has in the mode in which the constant | |
618 | will be used, then some of the bits you get from @code{INTVAL} will be | |
619 | superfluous. For proper results, you must carefully disregard the | |
620 | values of those bits. | |
621 | ||
622 | @findex output_asm_insn | |
623 | It is possible to output an assembler instruction and then go on to output | |
624 | or compute more of them, using the subroutine @code{output_asm_insn}. This | |
625 | receives two arguments: a template-string and a vector of operands. The | |
626 | vector may be @code{operands}, or it may be another array of @code{rtx} | |
627 | that you declare locally and initialize yourself. | |
628 | ||
629 | @findex which_alternative | |
630 | When an insn pattern has multiple alternatives in its constraints, often | |
631 | the appearance of the assembler code is determined mostly by which alternative | |
632 | was matched. When this is so, the C code can test the variable | |
633 | @code{which_alternative}, which is the ordinal number of the alternative | |
634 | that was actually satisfied (0 for the first, 1 for the second alternative, | |
635 | etc.). | |
636 | ||
637 | For example, suppose there are two opcodes for storing zero, @samp{clrreg} | |
638 | for registers and @samp{clrmem} for memory locations. Here is how | |
639 | a pattern could use @code{which_alternative} to choose between them: | |
640 | ||
641 | @smallexample | |
642 | (define_insn "" | |
643 | [(set (match_operand:SI 0 "general_operand" "=r,m") | |
644 | (const_int 0))] | |
645 | "" | |
0f40f9f7 | 646 | @{ |
03dda8e3 | 647 | return (which_alternative == 0 |
0f40f9f7 ZW |
648 | ? "clrreg %0" : "clrmem %0"); |
649 | @}) | |
03dda8e3 RK |
650 | @end smallexample |
651 | ||
652 | The example above, where the assembler code to generate was | |
653 | @emph{solely} determined by the alternative, could also have been specified | |
654 | as follows, having the output control string start with a @samp{@@}: | |
655 | ||
656 | @smallexample | |
657 | @group | |
658 | (define_insn "" | |
659 | [(set (match_operand:SI 0 "general_operand" "=r,m") | |
660 | (const_int 0))] | |
661 | "" | |
662 | "@@ | |
663 | clrreg %0 | |
664 | clrmem %0") | |
665 | @end group | |
666 | @end smallexample | |
e543e219 ZW |
667 | |
668 | @node Predicates | |
669 | @section Predicates | |
670 | @cindex predicates | |
671 | @cindex operand predicates | |
672 | @cindex operator predicates | |
673 | ||
674 | A predicate determines whether a @code{match_operand} or | |
675 | @code{match_operator} expression matches, and therefore whether the | |
676 | surrounding instruction pattern will be used for that combination of | |
677 | operands. GCC has a number of machine-independent predicates, and you | |
678 | can define machine-specific predicates as needed. By convention, | |
679 | predicates used with @code{match_operand} have names that end in | |
680 | @samp{_operand}, and those used with @code{match_operator} have names | |
681 | that end in @samp{_operator}. | |
682 | ||
683 | All predicates are Boolean functions (in the mathematical sense) of | |
684 | two arguments: the RTL expression that is being considered at that | |
685 | position in the instruction pattern, and the machine mode that the | |
686 | @code{match_operand} or @code{match_operator} specifies. In this | |
687 | section, the first argument is called @var{op} and the second argument | |
688 | @var{mode}. Predicates can be called from C as ordinary two-argument | |
689 | functions; this can be useful in output templates or other | |
690 | machine-specific code. | |
691 | ||
692 | Operand predicates can allow operands that are not actually acceptable | |
693 | to the hardware, as long as the constraints give reload the ability to | |
694 | fix them up (@pxref{Constraints}). However, GCC will usually generate | |
695 | better code if the predicates specify the requirements of the machine | |
696 | instructions as closely as possible. Reload cannot fix up operands | |
697 | that must be constants (``immediate operands''); you must use a | |
698 | predicate that allows only constants, or else enforce the requirement | |
699 | in the extra condition. | |
700 | ||
701 | @cindex predicates and machine modes | |
702 | @cindex normal predicates | |
703 | @cindex special predicates | |
704 | Most predicates handle their @var{mode} argument in a uniform manner. | |
705 | If @var{mode} is @code{VOIDmode} (unspecified), then @var{op} can have | |
706 | any mode. If @var{mode} is anything else, then @var{op} must have the | |
707 | same mode, unless @var{op} is a @code{CONST_INT} or integer | |
708 | @code{CONST_DOUBLE}. These RTL expressions always have | |
709 | @code{VOIDmode}, so it would be counterproductive to check that their | |
710 | mode matches. Instead, predicates that accept @code{CONST_INT} and/or | |
711 | integer @code{CONST_DOUBLE} check that the value stored in the | |
712 | constant will fit in the requested mode. | |
713 | ||
714 | Predicates with this behavior are called @dfn{normal}. | |
715 | @command{genrecog} can optimize the instruction recognizer based on | |
716 | knowledge of how normal predicates treat modes. It can also diagnose | |
717 | certain kinds of common errors in the use of normal predicates; for | |
718 | instance, it is almost always an error to use a normal predicate | |
719 | without specifying a mode. | |
720 | ||
721 | Predicates that do something different with their @var{mode} argument | |
722 | are called @dfn{special}. The generic predicates | |
723 | @code{address_operand} and @code{pmode_register_operand} are special | |
724 | predicates. @command{genrecog} does not do any optimizations or | |
725 | diagnosis when special predicates are used. | |
726 | ||
727 | @menu | |
728 | * Machine-Independent Predicates:: Predicates available to all back ends. | |
729 | * Defining Predicates:: How to write machine-specific predicate | |
730 | functions. | |
731 | @end menu | |
732 | ||
733 | @node Machine-Independent Predicates | |
734 | @subsection Machine-Independent Predicates | |
735 | @cindex machine-independent predicates | |
736 | @cindex generic predicates | |
737 | ||
738 | These are the generic predicates available to all back ends. They are | |
739 | defined in @file{recog.c}. The first category of predicates allow | |
740 | only constant, or @dfn{immediate}, operands. | |
741 | ||
742 | @defun immediate_operand | |
743 | This predicate allows any sort of constant that fits in @var{mode}. | |
744 | It is an appropriate choice for instructions that take operands that | |
745 | must be constant. | |
746 | @end defun | |
747 | ||
748 | @defun const_int_operand | |
749 | This predicate allows any @code{CONST_INT} expression that fits in | |
750 | @var{mode}. It is an appropriate choice for an immediate operand that | |
751 | does not allow a symbol or label. | |
752 | @end defun | |
753 | ||
754 | @defun const_double_operand | |
755 | This predicate accepts any @code{CONST_DOUBLE} expression that has | |
756 | exactly @var{mode}. If @var{mode} is @code{VOIDmode}, it will also | |
757 | accept @code{CONST_INT}. It is intended for immediate floating point | |
758 | constants. | |
759 | @end defun | |
760 | ||
761 | @noindent | |
762 | The second category of predicates allow only some kind of machine | |
763 | register. | |
764 | ||
765 | @defun register_operand | |
766 | This predicate allows any @code{REG} or @code{SUBREG} expression that | |
767 | is valid for @var{mode}. It is often suitable for arithmetic | |
768 | instruction operands on a RISC machine. | |
769 | @end defun | |
770 | ||
771 | @defun pmode_register_operand | |
772 | This is a slight variant on @code{register_operand} which works around | |
773 | a limitation in the machine-description reader. | |
774 | ||
cd1a8088 | 775 | @smallexample |
e543e219 | 776 | (match_operand @var{n} "pmode_register_operand" @var{constraint}) |
cd1a8088 | 777 | @end smallexample |
e543e219 ZW |
778 | |
779 | @noindent | |
780 | means exactly what | |
781 | ||
cd1a8088 | 782 | @smallexample |
e543e219 | 783 | (match_operand:P @var{n} "register_operand" @var{constraint}) |
cd1a8088 | 784 | @end smallexample |
e543e219 ZW |
785 | |
786 | @noindent | |
787 | would mean, if the machine-description reader accepted @samp{:P} | |
788 | mode suffixes. Unfortunately, it cannot, because @code{Pmode} is an | |
789 | alias for some other mode, and might vary with machine-specific | |
8a36672b | 790 | options. @xref{Misc}. |
e543e219 ZW |
791 | @end defun |
792 | ||
793 | @defun scratch_operand | |
794 | This predicate allows hard registers and @code{SCRATCH} expressions, | |
795 | but not pseudo-registers. It is used internally by @code{match_scratch}; | |
796 | it should not be used directly. | |
797 | @end defun | |
798 | ||
799 | @noindent | |
800 | The third category of predicates allow only some kind of memory reference. | |
801 | ||
802 | @defun memory_operand | |
803 | This predicate allows any valid reference to a quantity of mode | |
804 | @var{mode} in memory, as determined by the weak form of | |
805 | @code{GO_IF_LEGITIMATE_ADDRESS} (@pxref{Addressing Modes}). | |
806 | @end defun | |
807 | ||
808 | @defun address_operand | |
809 | This predicate is a little unusual; it allows any operand that is a | |
810 | valid expression for the @emph{address} of a quantity of mode | |
811 | @var{mode}, again determined by the weak form of | |
812 | @code{GO_IF_LEGITIMATE_ADDRESS}. To first order, if | |
813 | @samp{@w{(mem:@var{mode} (@var{exp}))}} is acceptable to | |
814 | @code{memory_operand}, then @var{exp} is acceptable to | |
815 | @code{address_operand}. Note that @var{exp} does not necessarily have | |
816 | the mode @var{mode}. | |
817 | @end defun | |
818 | ||
819 | @defun indirect_operand | |
820 | This is a stricter form of @code{memory_operand} which allows only | |
821 | memory references with a @code{general_operand} as the address | |
822 | expression. New uses of this predicate are discouraged, because | |
823 | @code{general_operand} is very permissive, so it's hard to tell what | |
824 | an @code{indirect_operand} does or does not allow. If a target has | |
825 | different requirements for memory operands for different instructions, | |
826 | it is better to define target-specific predicates which enforce the | |
827 | hardware's requirements explicitly. | |
828 | @end defun | |
829 | ||
830 | @defun push_operand | |
831 | This predicate allows a memory reference suitable for pushing a value | |
832 | onto the stack. This will be a @code{MEM} which refers to | |
833 | @code{stack_pointer_rtx}, with a side-effect in its address expression | |
834 | (@pxref{Incdec}); which one is determined by the | |
835 | @code{STACK_PUSH_CODE} macro (@pxref{Frame Layout}). | |
836 | @end defun | |
837 | ||
838 | @defun pop_operand | |
839 | This predicate allows a memory reference suitable for popping a value | |
840 | off the stack. Again, this will be a @code{MEM} referring to | |
841 | @code{stack_pointer_rtx}, with a side-effect in its address | |
842 | expression. However, this time @code{STACK_POP_CODE} is expected. | |
843 | @end defun | |
844 | ||
845 | @noindent | |
846 | The fourth category of predicates allow some combination of the above | |
847 | operands. | |
848 | ||
849 | @defun nonmemory_operand | |
850 | This predicate allows any immediate or register operand valid for @var{mode}. | |
851 | @end defun | |
852 | ||
853 | @defun nonimmediate_operand | |
854 | This predicate allows any register or memory operand valid for @var{mode}. | |
855 | @end defun | |
856 | ||
857 | @defun general_operand | |
858 | This predicate allows any immediate, register, or memory operand | |
859 | valid for @var{mode}. | |
860 | @end defun | |
861 | ||
862 | @noindent | |
c6963675 | 863 | Finally, there are two generic operator predicates. |
e543e219 ZW |
864 | |
865 | @defun comparison_operator | |
866 | This predicate matches any expression which performs an arithmetic | |
867 | comparison in @var{mode}; that is, @code{COMPARISON_P} is true for the | |
868 | expression code. | |
869 | @end defun | |
870 | ||
c6963675 PB |
871 | @defun ordered_comparison_operator |
872 | This predicate matches any expression which performs an arithmetic | |
873 | comparison in @var{mode} and whose expression code is valid for integer | |
874 | modes; that is, the expression code will be one of @code{eq}, @code{ne}, | |
875 | @code{lt}, @code{ltu}, @code{le}, @code{leu}, @code{gt}, @code{gtu}, | |
876 | @code{ge}, @code{geu}. | |
877 | @end defun | |
878 | ||
e543e219 ZW |
879 | @node Defining Predicates |
880 | @subsection Defining Machine-Specific Predicates | |
881 | @cindex defining predicates | |
882 | @findex define_predicate | |
883 | @findex define_special_predicate | |
884 | ||
885 | Many machines have requirements for their operands that cannot be | |
886 | expressed precisely using the generic predicates. You can define | |
887 | additional predicates using @code{define_predicate} and | |
888 | @code{define_special_predicate} expressions. These expressions have | |
889 | three operands: | |
890 | ||
891 | @itemize @bullet | |
892 | @item | |
893 | The name of the predicate, as it will be referred to in | |
894 | @code{match_operand} or @code{match_operator} expressions. | |
895 | ||
896 | @item | |
897 | An RTL expression which evaluates to true if the predicate allows the | |
898 | operand @var{op}, false if it does not. This expression can only use | |
899 | the following RTL codes: | |
900 | ||
901 | @table @code | |
902 | @item MATCH_OPERAND | |
903 | When written inside a predicate expression, a @code{MATCH_OPERAND} | |
904 | expression evaluates to true if the predicate it names would allow | |
905 | @var{op}. The operand number and constraint are ignored. Due to | |
906 | limitations in @command{genrecog}, you can only refer to generic | |
907 | predicates and predicates that have already been defined. | |
908 | ||
909 | @item MATCH_CODE | |
6e7a4706 ZW |
910 | This expression evaluates to true if @var{op} or a specified |
911 | subexpression of @var{op} has one of a given list of RTX codes. | |
912 | ||
913 | The first operand of this expression is a string constant containing a | |
914 | comma-separated list of RTX code names (in lower case). These are the | |
915 | codes for which the @code{MATCH_CODE} will be true. | |
916 | ||
917 | The second operand is a string constant which indicates what | |
918 | subexpression of @var{op} to examine. If it is absent or the empty | |
919 | string, @var{op} itself is examined. Otherwise, the string constant | |
920 | must be a sequence of digits and/or lowercase letters. Each character | |
921 | indicates a subexpression to extract from the current expression; for | |
922 | the first character this is @var{op}, for the second and subsequent | |
923 | characters it is the result of the previous character. A digit | |
924 | @var{n} extracts @samp{@w{XEXP (@var{e}, @var{n})}}; a letter @var{l} | |
925 | extracts @samp{@w{XVECEXP (@var{e}, 0, @var{n})}} where @var{n} is the | |
926 | alphabetic ordinal of @var{l} (0 for `a', 1 for 'b', and so on). The | |
927 | @code{MATCH_CODE} then examines the RTX code of the subexpression | |
928 | extracted by the complete string. It is not possible to extract | |
929 | components of an @code{rtvec} that is not at position 0 within its RTX | |
930 | object. | |
e543e219 ZW |
931 | |
932 | @item MATCH_TEST | |
933 | This expression has one operand, a string constant containing a C | |
934 | expression. The predicate's arguments, @var{op} and @var{mode}, are | |
935 | available with those names in the C expression. The @code{MATCH_TEST} | |
936 | evaluates to true if the C expression evaluates to a nonzero value. | |
937 | @code{MATCH_TEST} expressions must not have side effects. | |
938 | ||
939 | @item AND | |
940 | @itemx IOR | |
941 | @itemx NOT | |
942 | @itemx IF_THEN_ELSE | |
943 | The basic @samp{MATCH_} expressions can be combined using these | |
944 | logical operators, which have the semantics of the C operators | |
6e7a4706 ZW |
945 | @samp{&&}, @samp{||}, @samp{!}, and @samp{@w{? :}} respectively. As |
946 | in Common Lisp, you may give an @code{AND} or @code{IOR} expression an | |
947 | arbitrary number of arguments; this has exactly the same effect as | |
948 | writing a chain of two-argument @code{AND} or @code{IOR} expressions. | |
e543e219 ZW |
949 | @end table |
950 | ||
951 | @item | |
f0eb93a8 | 952 | An optional block of C code, which should execute |
e543e219 ZW |
953 | @samp{@w{return true}} if the predicate is found to match and |
954 | @samp{@w{return false}} if it does not. It must not have any side | |
955 | effects. The predicate arguments, @var{op} and @var{mode}, are | |
956 | available with those names. | |
957 | ||
958 | If a code block is present in a predicate definition, then the RTL | |
959 | expression must evaluate to true @emph{and} the code block must | |
960 | execute @samp{@w{return true}} for the predicate to allow the operand. | |
961 | The RTL expression is evaluated first; do not re-check anything in the | |
962 | code block that was checked in the RTL expression. | |
963 | @end itemize | |
964 | ||
965 | The program @command{genrecog} scans @code{define_predicate} and | |
966 | @code{define_special_predicate} expressions to determine which RTX | |
967 | codes are possibly allowed. You should always make this explicit in | |
968 | the RTL predicate expression, using @code{MATCH_OPERAND} and | |
969 | @code{MATCH_CODE}. | |
970 | ||
971 | Here is an example of a simple predicate definition, from the IA64 | |
972 | machine description: | |
973 | ||
974 | @smallexample | |
975 | @group | |
976 | ;; @r{True if @var{op} is a @code{SYMBOL_REF} which refers to the sdata section.} | |
977 | (define_predicate "small_addr_symbolic_operand" | |
978 | (and (match_code "symbol_ref") | |
979 | (match_test "SYMBOL_REF_SMALL_ADDR_P (op)"))) | |
980 | @end group | |
981 | @end smallexample | |
982 | ||
983 | @noindent | |
984 | And here is another, showing the use of the C block. | |
985 | ||
986 | @smallexample | |
987 | @group | |
988 | ;; @r{True if @var{op} is a register operand that is (or could be) a GR reg.} | |
989 | (define_predicate "gr_register_operand" | |
990 | (match_operand 0 "register_operand") | |
991 | @{ | |
992 | unsigned int regno; | |
993 | if (GET_CODE (op) == SUBREG) | |
994 | op = SUBREG_REG (op); | |
995 | ||
996 | regno = REGNO (op); | |
997 | return (regno >= FIRST_PSEUDO_REGISTER || GENERAL_REGNO_P (regno)); | |
998 | @}) | |
999 | @end group | |
1000 | @end smallexample | |
1001 | ||
1002 | Predicates written with @code{define_predicate} automatically include | |
1003 | a test that @var{mode} is @code{VOIDmode}, or @var{op} has the same | |
1004 | mode as @var{mode}, or @var{op} is a @code{CONST_INT} or | |
1005 | @code{CONST_DOUBLE}. They do @emph{not} check specifically for | |
1006 | integer @code{CONST_DOUBLE}, nor do they test that the value of either | |
1007 | kind of constant fits in the requested mode. This is because | |
1008 | target-specific predicates that take constants usually have to do more | |
1009 | stringent value checks anyway. If you need the exact same treatment | |
1010 | of @code{CONST_INT} or @code{CONST_DOUBLE} that the generic predicates | |
1011 | provide, use a @code{MATCH_OPERAND} subexpression to call | |
1012 | @code{const_int_operand}, @code{const_double_operand}, or | |
1013 | @code{immediate_operand}. | |
1014 | ||
1015 | Predicates written with @code{define_special_predicate} do not get any | |
1016 | automatic mode checks, and are treated as having special mode handling | |
1017 | by @command{genrecog}. | |
1018 | ||
1019 | The program @command{genpreds} is responsible for generating code to | |
1020 | test predicates. It also writes a header file containing function | |
1021 | declarations for all machine-specific predicates. It is not necessary | |
1022 | to declare these predicates in @file{@var{cpu}-protos.h}. | |
03dda8e3 RK |
1023 | @end ifset |
1024 | ||
1025 | @c Most of this node appears by itself (in a different place) even | |
b11cc610 JM |
1026 | @c when the INTERNALS flag is clear. Passages that require the internals |
1027 | @c manual's context are conditionalized to appear only in the internals manual. | |
03dda8e3 RK |
1028 | @ifset INTERNALS |
1029 | @node Constraints | |
1030 | @section Operand Constraints | |
1031 | @cindex operand constraints | |
1032 | @cindex constraints | |
1033 | ||
e543e219 ZW |
1034 | Each @code{match_operand} in an instruction pattern can specify |
1035 | constraints for the operands allowed. The constraints allow you to | |
1036 | fine-tune matching within the set of operands allowed by the | |
1037 | predicate. | |
1038 | ||
03dda8e3 RK |
1039 | @end ifset |
1040 | @ifclear INTERNALS | |
1041 | @node Constraints | |
1042 | @section Constraints for @code{asm} Operands | |
1043 | @cindex operand constraints, @code{asm} | |
1044 | @cindex constraints, @code{asm} | |
1045 | @cindex @code{asm} constraints | |
1046 | ||
1047 | Here are specific details on what constraint letters you can use with | |
1048 | @code{asm} operands. | |
1049 | @end ifclear | |
1050 | Constraints can say whether | |
1051 | an operand may be in a register, and which kinds of register; whether the | |
1052 | operand can be a memory reference, and which kinds of address; whether the | |
1053 | operand may be an immediate constant, and which possible values it may | |
1054 | have. Constraints can also require two operands to match. | |
54f044eb JJ |
1055 | Side-effects aren't allowed in operands of inline @code{asm}, unless |
1056 | @samp{<} or @samp{>} constraints are used, because there is no guarantee | |
1057 | that the side-effects will happen exactly once in an instruction that can update | |
1058 | the addressing register. | |
03dda8e3 RK |
1059 | |
1060 | @ifset INTERNALS | |
1061 | @menu | |
1062 | * Simple Constraints:: Basic use of constraints. | |
1063 | * Multi-Alternative:: When an insn has two alternative constraint-patterns. | |
1064 | * Class Preferences:: Constraints guide which hard register to put things in. | |
1065 | * Modifiers:: More precise control over effects of constraints. | |
7ac28727 | 1066 | * Disable Insn Alternatives:: Disable insn alternatives using the @code{enabled} attribute. |
03dda8e3 | 1067 | * Machine Constraints:: Existing constraints for some particular machines. |
f38840db ZW |
1068 | * Define Constraints:: How to define machine-specific constraints. |
1069 | * C Constraint Interface:: How to test constraints from C code. | |
03dda8e3 RK |
1070 | @end menu |
1071 | @end ifset | |
1072 | ||
1073 | @ifclear INTERNALS | |
1074 | @menu | |
1075 | * Simple Constraints:: Basic use of constraints. | |
1076 | * Multi-Alternative:: When an insn has two alternative constraint-patterns. | |
1077 | * Modifiers:: More precise control over effects of constraints. | |
1078 | * Machine Constraints:: Special constraints for some particular machines. | |
1079 | @end menu | |
1080 | @end ifclear | |
1081 | ||
1082 | @node Simple Constraints | |
1083 | @subsection Simple Constraints | |
1084 | @cindex simple constraints | |
1085 | ||
1086 | The simplest kind of constraint is a string full of letters, each of | |
1087 | which describes one kind of operand that is permitted. Here are | |
1088 | the letters that are allowed: | |
1089 | ||
1090 | @table @asis | |
88a56c2e HPN |
1091 | @item whitespace |
1092 | Whitespace characters are ignored and can be inserted at any position | |
1093 | except the first. This enables each alternative for different operands to | |
1094 | be visually aligned in the machine description even if they have different | |
1095 | number of constraints and modifiers. | |
1096 | ||
03dda8e3 RK |
1097 | @cindex @samp{m} in constraint |
1098 | @cindex memory references in constraints | |
1099 | @item @samp{m} | |
1100 | A memory operand is allowed, with any kind of address that the machine | |
1101 | supports in general. | |
a4edaf83 AK |
1102 | Note that the letter used for the general memory constraint can be |
1103 | re-defined by a back end using the @code{TARGET_MEM_CONSTRAINT} macro. | |
03dda8e3 RK |
1104 | |
1105 | @cindex offsettable address | |
1106 | @cindex @samp{o} in constraint | |
1107 | @item @samp{o} | |
1108 | A memory operand is allowed, but only if the address is | |
1109 | @dfn{offsettable}. This means that adding a small integer (actually, | |
1110 | the width in bytes of the operand, as determined by its machine mode) | |
1111 | may be added to the address and the result is also a valid memory | |
1112 | address. | |
1113 | ||
1114 | @cindex autoincrement/decrement addressing | |
1115 | For example, an address which is constant is offsettable; so is an | |
1116 | address that is the sum of a register and a constant (as long as a | |
1117 | slightly larger constant is also within the range of address-offsets | |
1118 | supported by the machine); but an autoincrement or autodecrement | |
1119 | address is not offsettable. More complicated indirect/indexed | |
1120 | addresses may or may not be offsettable depending on the other | |
1121 | addressing modes that the machine supports. | |
1122 | ||
1123 | Note that in an output operand which can be matched by another | |
1124 | operand, the constraint letter @samp{o} is valid only when accompanied | |
1125 | by both @samp{<} (if the target machine has predecrement addressing) | |
1126 | and @samp{>} (if the target machine has preincrement addressing). | |
1127 | ||
1128 | @cindex @samp{V} in constraint | |
1129 | @item @samp{V} | |
1130 | A memory operand that is not offsettable. In other words, anything that | |
1131 | would fit the @samp{m} constraint but not the @samp{o} constraint. | |
1132 | ||
1133 | @cindex @samp{<} in constraint | |
1134 | @item @samp{<} | |
1135 | A memory operand with autodecrement addressing (either predecrement or | |
54f044eb JJ |
1136 | postdecrement) is allowed. In inline @code{asm} this constraint is only |
1137 | allowed if the operand is used exactly once in an instruction that can | |
1138 | handle the side-effects. Not using an operand with @samp{<} in constraint | |
1139 | string in the inline @code{asm} pattern at all or using it in multiple | |
1140 | instructions isn't valid, because the side-effects wouldn't be performed | |
1141 | or would be performed more than once. Furthermore, on some targets | |
1142 | the operand with @samp{<} in constraint string must be accompanied by | |
1143 | special instruction suffixes like @code{%U0} instruction suffix on PowerPC | |
1144 | or @code{%P0} on IA-64. | |
03dda8e3 RK |
1145 | |
1146 | @cindex @samp{>} in constraint | |
1147 | @item @samp{>} | |
1148 | A memory operand with autoincrement addressing (either preincrement or | |
54f044eb JJ |
1149 | postincrement) is allowed. In inline @code{asm} the same restrictions |
1150 | as for @samp{<} apply. | |
03dda8e3 RK |
1151 | |
1152 | @cindex @samp{r} in constraint | |
1153 | @cindex registers in constraints | |
1154 | @item @samp{r} | |
1155 | A register operand is allowed provided that it is in a general | |
1156 | register. | |
1157 | ||
03dda8e3 RK |
1158 | @cindex constants in constraints |
1159 | @cindex @samp{i} in constraint | |
1160 | @item @samp{i} | |
1161 | An immediate integer operand (one with constant value) is allowed. | |
1162 | This includes symbolic constants whose values will be known only at | |
8ac658b6 | 1163 | assembly time or later. |
03dda8e3 RK |
1164 | |
1165 | @cindex @samp{n} in constraint | |
1166 | @item @samp{n} | |
1167 | An immediate integer operand with a known numeric value is allowed. | |
1168 | Many systems cannot support assembly-time constants for operands less | |
1169 | than a word wide. Constraints for these operands should use @samp{n} | |
1170 | rather than @samp{i}. | |
1171 | ||
1172 | @cindex @samp{I} in constraint | |
1173 | @item @samp{I}, @samp{J}, @samp{K}, @dots{} @samp{P} | |
1174 | Other letters in the range @samp{I} through @samp{P} may be defined in | |
1175 | a machine-dependent fashion to permit immediate integer operands with | |
1176 | explicit integer values in specified ranges. For example, on the | |
1177 | 68000, @samp{I} is defined to stand for the range of values 1 to 8. | |
1178 | This is the range permitted as a shift count in the shift | |
1179 | instructions. | |
1180 | ||
1181 | @cindex @samp{E} in constraint | |
1182 | @item @samp{E} | |
1183 | An immediate floating operand (expression code @code{const_double}) is | |
1184 | allowed, but only if the target floating point format is the same as | |
1185 | that of the host machine (on which the compiler is running). | |
1186 | ||
1187 | @cindex @samp{F} in constraint | |
1188 | @item @samp{F} | |
bf7cd754 R |
1189 | An immediate floating operand (expression code @code{const_double} or |
1190 | @code{const_vector}) is allowed. | |
03dda8e3 RK |
1191 | |
1192 | @cindex @samp{G} in constraint | |
1193 | @cindex @samp{H} in constraint | |
1194 | @item @samp{G}, @samp{H} | |
1195 | @samp{G} and @samp{H} may be defined in a machine-dependent fashion to | |
1196 | permit immediate floating operands in particular ranges of values. | |
1197 | ||
1198 | @cindex @samp{s} in constraint | |
1199 | @item @samp{s} | |
1200 | An immediate integer operand whose value is not an explicit integer is | |
1201 | allowed. | |
1202 | ||
1203 | This might appear strange; if an insn allows a constant operand with a | |
1204 | value not known at compile time, it certainly must allow any known | |
1205 | value. So why use @samp{s} instead of @samp{i}? Sometimes it allows | |
1206 | better code to be generated. | |
1207 | ||
1208 | For example, on the 68000 in a fullword instruction it is possible to | |
630d3d5a | 1209 | use an immediate operand; but if the immediate value is between @minus{}128 |
03dda8e3 RK |
1210 | and 127, better code results from loading the value into a register and |
1211 | using the register. This is because the load into the register can be | |
1212 | done with a @samp{moveq} instruction. We arrange for this to happen | |
1213 | by defining the letter @samp{K} to mean ``any integer outside the | |
630d3d5a | 1214 | range @minus{}128 to 127'', and then specifying @samp{Ks} in the operand |
03dda8e3 RK |
1215 | constraints. |
1216 | ||
1217 | @cindex @samp{g} in constraint | |
1218 | @item @samp{g} | |
1219 | Any register, memory or immediate integer operand is allowed, except for | |
1220 | registers that are not general registers. | |
1221 | ||
1222 | @cindex @samp{X} in constraint | |
1223 | @item @samp{X} | |
1224 | @ifset INTERNALS | |
1225 | Any operand whatsoever is allowed, even if it does not satisfy | |
1226 | @code{general_operand}. This is normally used in the constraint of | |
1227 | a @code{match_scratch} when certain alternatives will not actually | |
1228 | require a scratch register. | |
1229 | @end ifset | |
1230 | @ifclear INTERNALS | |
1231 | Any operand whatsoever is allowed. | |
1232 | @end ifclear | |
1233 | ||
1234 | @cindex @samp{0} in constraint | |
1235 | @cindex digits in constraint | |
1236 | @item @samp{0}, @samp{1}, @samp{2}, @dots{} @samp{9} | |
1237 | An operand that matches the specified operand number is allowed. If a | |
1238 | digit is used together with letters within the same alternative, the | |
1239 | digit should come last. | |
1240 | ||
84b72302 | 1241 | This number is allowed to be more than a single digit. If multiple |
c0478a66 | 1242 | digits are encountered consecutively, they are interpreted as a single |
84b72302 RH |
1243 | decimal integer. There is scant chance for ambiguity, since to-date |
1244 | it has never been desirable that @samp{10} be interpreted as matching | |
1245 | either operand 1 @emph{or} operand 0. Should this be desired, one | |
1246 | can use multiple alternatives instead. | |
1247 | ||
03dda8e3 RK |
1248 | @cindex matching constraint |
1249 | @cindex constraint, matching | |
1250 | This is called a @dfn{matching constraint} and what it really means is | |
1251 | that the assembler has only a single operand that fills two roles | |
1252 | @ifset INTERNALS | |
1253 | considered separate in the RTL insn. For example, an add insn has two | |
1254 | input operands and one output operand in the RTL, but on most CISC | |
1255 | @end ifset | |
1256 | @ifclear INTERNALS | |
1257 | which @code{asm} distinguishes. For example, an add instruction uses | |
1258 | two input operands and an output operand, but on most CISC | |
1259 | @end ifclear | |
1260 | machines an add instruction really has only two operands, one of them an | |
1261 | input-output operand: | |
1262 | ||
1263 | @smallexample | |
1264 | addl #35,r12 | |
1265 | @end smallexample | |
1266 | ||
1267 | Matching constraints are used in these circumstances. | |
1268 | More precisely, the two operands that match must include one input-only | |
1269 | operand and one output-only operand. Moreover, the digit must be a | |
1270 | smaller number than the number of the operand that uses it in the | |
1271 | constraint. | |
1272 | ||
1273 | @ifset INTERNALS | |
1274 | For operands to match in a particular case usually means that they | |
1275 | are identical-looking RTL expressions. But in a few special cases | |
1276 | specific kinds of dissimilarity are allowed. For example, @code{*x} | |
1277 | as an input operand will match @code{*x++} as an output operand. | |
1278 | For proper results in such cases, the output template should always | |
1279 | use the output-operand's number when printing the operand. | |
1280 | @end ifset | |
1281 | ||
1282 | @cindex load address instruction | |
1283 | @cindex push address instruction | |
1284 | @cindex address constraints | |
1285 | @cindex @samp{p} in constraint | |
1286 | @item @samp{p} | |
1287 | An operand that is a valid memory address is allowed. This is | |
1288 | for ``load address'' and ``push address'' instructions. | |
1289 | ||
1290 | @findex address_operand | |
1291 | @samp{p} in the constraint must be accompanied by @code{address_operand} | |
1292 | as the predicate in the @code{match_operand}. This predicate interprets | |
1293 | the mode specified in the @code{match_operand} as the mode of the memory | |
1294 | reference for which the address would be valid. | |
1295 | ||
c2cba7a9 | 1296 | @cindex other register constraints |
03dda8e3 | 1297 | @cindex extensible constraints |
630d3d5a | 1298 | @item @var{other-letters} |
c2cba7a9 RH |
1299 | Other letters can be defined in machine-dependent fashion to stand for |
1300 | particular classes of registers or other arbitrary operand types. | |
1301 | @samp{d}, @samp{a} and @samp{f} are defined on the 68000/68020 to stand | |
1302 | for data, address and floating point registers. | |
03dda8e3 RK |
1303 | @end table |
1304 | ||
1305 | @ifset INTERNALS | |
1306 | In order to have valid assembler code, each operand must satisfy | |
1307 | its constraint. But a failure to do so does not prevent the pattern | |
1308 | from applying to an insn. Instead, it directs the compiler to modify | |
1309 | the code so that the constraint will be satisfied. Usually this is | |
1310 | done by copying an operand into a register. | |
1311 | ||
1312 | Contrast, therefore, the two instruction patterns that follow: | |
1313 | ||
1314 | @smallexample | |
1315 | (define_insn "" | |
1316 | [(set (match_operand:SI 0 "general_operand" "=r") | |
1317 | (plus:SI (match_dup 0) | |
1318 | (match_operand:SI 1 "general_operand" "r")))] | |
1319 | "" | |
1320 | "@dots{}") | |
1321 | @end smallexample | |
1322 | ||
1323 | @noindent | |
1324 | which has two operands, one of which must appear in two places, and | |
1325 | ||
1326 | @smallexample | |
1327 | (define_insn "" | |
1328 | [(set (match_operand:SI 0 "general_operand" "=r") | |
1329 | (plus:SI (match_operand:SI 1 "general_operand" "0") | |
1330 | (match_operand:SI 2 "general_operand" "r")))] | |
1331 | "" | |
1332 | "@dots{}") | |
1333 | @end smallexample | |
1334 | ||
1335 | @noindent | |
1336 | which has three operands, two of which are required by a constraint to be | |
1337 | identical. If we are considering an insn of the form | |
1338 | ||
1339 | @smallexample | |
1340 | (insn @var{n} @var{prev} @var{next} | |
1341 | (set (reg:SI 3) | |
1342 | (plus:SI (reg:SI 6) (reg:SI 109))) | |
1343 | @dots{}) | |
1344 | @end smallexample | |
1345 | ||
1346 | @noindent | |
1347 | the first pattern would not apply at all, because this insn does not | |
1348 | contain two identical subexpressions in the right place. The pattern would | |
d78aa55c | 1349 | say, ``That does not look like an add instruction; try other patterns''. |
03dda8e3 | 1350 | The second pattern would say, ``Yes, that's an add instruction, but there |
d78aa55c | 1351 | is something wrong with it''. It would direct the reload pass of the |
03dda8e3 RK |
1352 | compiler to generate additional insns to make the constraint true. The |
1353 | results might look like this: | |
1354 | ||
1355 | @smallexample | |
1356 | (insn @var{n2} @var{prev} @var{n} | |
1357 | (set (reg:SI 3) (reg:SI 6)) | |
1358 | @dots{}) | |
1359 | ||
1360 | (insn @var{n} @var{n2} @var{next} | |
1361 | (set (reg:SI 3) | |
1362 | (plus:SI (reg:SI 3) (reg:SI 109))) | |
1363 | @dots{}) | |
1364 | @end smallexample | |
1365 | ||
1366 | It is up to you to make sure that each operand, in each pattern, has | |
1367 | constraints that can handle any RTL expression that could be present for | |
1368 | that operand. (When multiple alternatives are in use, each pattern must, | |
1369 | for each possible combination of operand expressions, have at least one | |
1370 | alternative which can handle that combination of operands.) The | |
1371 | constraints don't need to @emph{allow} any possible operand---when this is | |
1372 | the case, they do not constrain---but they must at least point the way to | |
1373 | reloading any possible operand so that it will fit. | |
1374 | ||
1375 | @itemize @bullet | |
1376 | @item | |
1377 | If the constraint accepts whatever operands the predicate permits, | |
1378 | there is no problem: reloading is never necessary for this operand. | |
1379 | ||
1380 | For example, an operand whose constraints permit everything except | |
1381 | registers is safe provided its predicate rejects registers. | |
1382 | ||
1383 | An operand whose predicate accepts only constant values is safe | |
1384 | provided its constraints include the letter @samp{i}. If any possible | |
1385 | constant value is accepted, then nothing less than @samp{i} will do; | |
1386 | if the predicate is more selective, then the constraints may also be | |
1387 | more selective. | |
1388 | ||
1389 | @item | |
1390 | Any operand expression can be reloaded by copying it into a register. | |
1391 | So if an operand's constraints allow some kind of register, it is | |
1392 | certain to be safe. It need not permit all classes of registers; the | |
1393 | compiler knows how to copy a register into another register of the | |
1394 | proper class in order to make an instruction valid. | |
1395 | ||
1396 | @cindex nonoffsettable memory reference | |
1397 | @cindex memory reference, nonoffsettable | |
1398 | @item | |
1399 | A nonoffsettable memory reference can be reloaded by copying the | |
1400 | address into a register. So if the constraint uses the letter | |
1401 | @samp{o}, all memory references are taken care of. | |
1402 | ||
1403 | @item | |
1404 | A constant operand can be reloaded by allocating space in memory to | |
1405 | hold it as preinitialized data. Then the memory reference can be used | |
1406 | in place of the constant. So if the constraint uses the letters | |
1407 | @samp{o} or @samp{m}, constant operands are not a problem. | |
1408 | ||
1409 | @item | |
1410 | If the constraint permits a constant and a pseudo register used in an insn | |
1411 | was not allocated to a hard register and is equivalent to a constant, | |
1412 | the register will be replaced with the constant. If the predicate does | |
1413 | not permit a constant and the insn is re-recognized for some reason, the | |
1414 | compiler will crash. Thus the predicate must always recognize any | |
1415 | objects allowed by the constraint. | |
1416 | @end itemize | |
1417 | ||
1418 | If the operand's predicate can recognize registers, but the constraint does | |
1419 | not permit them, it can make the compiler crash. When this operand happens | |
1420 | to be a register, the reload pass will be stymied, because it does not know | |
1421 | how to copy a register temporarily into memory. | |
1422 | ||
1423 | If the predicate accepts a unary operator, the constraint applies to the | |
1424 | operand. For example, the MIPS processor at ISA level 3 supports an | |
1425 | instruction which adds two registers in @code{SImode} to produce a | |
1426 | @code{DImode} result, but only if the registers are correctly sign | |
1427 | extended. This predicate for the input operands accepts a | |
1428 | @code{sign_extend} of an @code{SImode} register. Write the constraint | |
1429 | to indicate the type of register that is required for the operand of the | |
1430 | @code{sign_extend}. | |
1431 | @end ifset | |
1432 | ||
1433 | @node Multi-Alternative | |
1434 | @subsection Multiple Alternative Constraints | |
1435 | @cindex multiple alternative constraints | |
1436 | ||
1437 | Sometimes a single instruction has multiple alternative sets of possible | |
1438 | operands. For example, on the 68000, a logical-or instruction can combine | |
1439 | register or an immediate value into memory, or it can combine any kind of | |
1440 | operand into a register; but it cannot combine one memory location into | |
1441 | another. | |
1442 | ||
1443 | These constraints are represented as multiple alternatives. An alternative | |
1444 | can be described by a series of letters for each operand. The overall | |
1445 | constraint for an operand is made from the letters for this operand | |
1446 | from the first alternative, a comma, the letters for this operand from | |
1447 | the second alternative, a comma, and so on until the last alternative. | |
1448 | @ifset INTERNALS | |
1449 | Here is how it is done for fullword logical-or on the 68000: | |
1450 | ||
1451 | @smallexample | |
1452 | (define_insn "iorsi3" | |
1453 | [(set (match_operand:SI 0 "general_operand" "=m,d") | |
1454 | (ior:SI (match_operand:SI 1 "general_operand" "%0,0") | |
1455 | (match_operand:SI 2 "general_operand" "dKs,dmKs")))] | |
1456 | @dots{}) | |
1457 | @end smallexample | |
1458 | ||
1459 | The first alternative has @samp{m} (memory) for operand 0, @samp{0} for | |
1460 | operand 1 (meaning it must match operand 0), and @samp{dKs} for operand | |
1461 | 2. The second alternative has @samp{d} (data register) for operand 0, | |
1462 | @samp{0} for operand 1, and @samp{dmKs} for operand 2. The @samp{=} and | |
1463 | @samp{%} in the constraints apply to all the alternatives; their | |
1464 | meaning is explained in the next section (@pxref{Class Preferences}). | |
1465 | @end ifset | |
1466 | ||
1467 | @c FIXME Is this ? and ! stuff of use in asm()? If not, hide unless INTERNAL | |
1468 | If all the operands fit any one alternative, the instruction is valid. | |
1469 | Otherwise, for each alternative, the compiler counts how many instructions | |
1470 | must be added to copy the operands so that that alternative applies. | |
1471 | The alternative requiring the least copying is chosen. If two alternatives | |
1472 | need the same amount of copying, the one that comes first is chosen. | |
1473 | These choices can be altered with the @samp{?} and @samp{!} characters: | |
1474 | ||
1475 | @table @code | |
1476 | @cindex @samp{?} in constraint | |
1477 | @cindex question mark | |
1478 | @item ? | |
1479 | Disparage slightly the alternative that the @samp{?} appears in, | |
1480 | as a choice when no alternative applies exactly. The compiler regards | |
1481 | this alternative as one unit more costly for each @samp{?} that appears | |
1482 | in it. | |
1483 | ||
1484 | @cindex @samp{!} in constraint | |
1485 | @cindex exclamation point | |
1486 | @item ! | |
1487 | Disparage severely the alternative that the @samp{!} appears in. | |
1488 | This alternative can still be used if it fits without reloading, | |
1489 | but if reloading is needed, some other alternative will be used. | |
1490 | @end table | |
1491 | ||
1492 | @ifset INTERNALS | |
1493 | When an insn pattern has multiple alternatives in its constraints, often | |
1494 | the appearance of the assembler code is determined mostly by which | |
1495 | alternative was matched. When this is so, the C code for writing the | |
1496 | assembler code can use the variable @code{which_alternative}, which is | |
1497 | the ordinal number of the alternative that was actually satisfied (0 for | |
1498 | the first, 1 for the second alternative, etc.). @xref{Output Statement}. | |
1499 | @end ifset | |
1500 | ||
1501 | @ifset INTERNALS | |
1502 | @node Class Preferences | |
1503 | @subsection Register Class Preferences | |
1504 | @cindex class preference constraints | |
1505 | @cindex register class preference constraints | |
1506 | ||
1507 | @cindex voting between constraint alternatives | |
1508 | The operand constraints have another function: they enable the compiler | |
1509 | to decide which kind of hardware register a pseudo register is best | |
1510 | allocated to. The compiler examines the constraints that apply to the | |
1511 | insns that use the pseudo register, looking for the machine-dependent | |
1512 | letters such as @samp{d} and @samp{a} that specify classes of registers. | |
1513 | The pseudo register is put in whichever class gets the most ``votes''. | |
1514 | The constraint letters @samp{g} and @samp{r} also vote: they vote in | |
1515 | favor of a general register. The machine description says which registers | |
1516 | are considered general. | |
1517 | ||
1518 | Of course, on some machines all registers are equivalent, and no register | |
1519 | classes are defined. Then none of this complexity is relevant. | |
1520 | @end ifset | |
1521 | ||
1522 | @node Modifiers | |
1523 | @subsection Constraint Modifier Characters | |
1524 | @cindex modifiers in constraints | |
1525 | @cindex constraint modifier characters | |
1526 | ||
1527 | @c prevent bad page break with this line | |
1528 | Here are constraint modifier characters. | |
1529 | ||
1530 | @table @samp | |
1531 | @cindex @samp{=} in constraint | |
1532 | @item = | |
1533 | Means that this operand is write-only for this instruction: the previous | |
1534 | value is discarded and replaced by output data. | |
1535 | ||
1536 | @cindex @samp{+} in constraint | |
1537 | @item + | |
1538 | Means that this operand is both read and written by the instruction. | |
1539 | ||
1540 | When the compiler fixes up the operands to satisfy the constraints, | |
1541 | it needs to know which operands are inputs to the instruction and | |
1542 | which are outputs from it. @samp{=} identifies an output; @samp{+} | |
1543 | identifies an operand that is both input and output; all other operands | |
1544 | are assumed to be input only. | |
1545 | ||
c5c76735 JL |
1546 | If you specify @samp{=} or @samp{+} in a constraint, you put it in the |
1547 | first character of the constraint string. | |
1548 | ||
03dda8e3 RK |
1549 | @cindex @samp{&} in constraint |
1550 | @cindex earlyclobber operand | |
1551 | @item & | |
1552 | Means (in a particular alternative) that this operand is an | |
1553 | @dfn{earlyclobber} operand, which is modified before the instruction is | |
1554 | finished using the input operands. Therefore, this operand may not lie | |
1555 | in a register that is used as an input operand or as part of any memory | |
1556 | address. | |
1557 | ||
1558 | @samp{&} applies only to the alternative in which it is written. In | |
1559 | constraints with multiple alternatives, sometimes one alternative | |
1560 | requires @samp{&} while others do not. See, for example, the | |
1561 | @samp{movdf} insn of the 68000. | |
1562 | ||
ebb48a4d | 1563 | An input operand can be tied to an earlyclobber operand if its only |
03dda8e3 RK |
1564 | use as an input occurs before the early result is written. Adding |
1565 | alternatives of this form often allows GCC to produce better code | |
ebb48a4d | 1566 | when only some of the inputs can be affected by the earlyclobber. |
161d7b59 | 1567 | See, for example, the @samp{mulsi3} insn of the ARM@. |
03dda8e3 RK |
1568 | |
1569 | @samp{&} does not obviate the need to write @samp{=}. | |
1570 | ||
1571 | @cindex @samp{%} in constraint | |
1572 | @item % | |
1573 | Declares the instruction to be commutative for this operand and the | |
1574 | following operand. This means that the compiler may interchange the | |
1575 | two operands if that is the cheapest way to make all operands fit the | |
1576 | constraints. | |
1577 | @ifset INTERNALS | |
1578 | This is often used in patterns for addition instructions | |
1579 | that really have only two operands: the result must go in one of the | |
1580 | arguments. Here for example, is how the 68000 halfword-add | |
1581 | instruction is defined: | |
1582 | ||
1583 | @smallexample | |
1584 | (define_insn "addhi3" | |
1585 | [(set (match_operand:HI 0 "general_operand" "=m,r") | |
1586 | (plus:HI (match_operand:HI 1 "general_operand" "%0,0") | |
1587 | (match_operand:HI 2 "general_operand" "di,g")))] | |
1588 | @dots{}) | |
1589 | @end smallexample | |
1590 | @end ifset | |
daf2f129 | 1591 | GCC can only handle one commutative pair in an asm; if you use more, |
595163db EB |
1592 | the compiler may fail. Note that you need not use the modifier if |
1593 | the two alternatives are strictly identical; this would only waste | |
be3914df HPN |
1594 | time in the reload pass. The modifier is not operational after |
1595 | register allocation, so the result of @code{define_peephole2} | |
1596 | and @code{define_split}s performed after reload cannot rely on | |
1597 | @samp{%} to make the intended insn match. | |
03dda8e3 RK |
1598 | |
1599 | @cindex @samp{#} in constraint | |
1600 | @item # | |
1601 | Says that all following characters, up to the next comma, are to be | |
1602 | ignored as a constraint. They are significant only for choosing | |
1603 | register preferences. | |
1604 | ||
03dda8e3 RK |
1605 | @cindex @samp{*} in constraint |
1606 | @item * | |
1607 | Says that the following character should be ignored when choosing | |
1608 | register preferences. @samp{*} has no effect on the meaning of the | |
1609 | constraint as a constraint, and no effect on reloading. | |
1610 | ||
9f339dde | 1611 | @ifset INTERNALS |
03dda8e3 RK |
1612 | Here is an example: the 68000 has an instruction to sign-extend a |
1613 | halfword in a data register, and can also sign-extend a value by | |
1614 | copying it into an address register. While either kind of register is | |
1615 | acceptable, the constraints on an address-register destination are | |
1616 | less strict, so it is best if register allocation makes an address | |
1617 | register its goal. Therefore, @samp{*} is used so that the @samp{d} | |
1618 | constraint letter (for data register) is ignored when computing | |
1619 | register preferences. | |
1620 | ||
1621 | @smallexample | |
1622 | (define_insn "extendhisi2" | |
1623 | [(set (match_operand:SI 0 "general_operand" "=*d,a") | |
1624 | (sign_extend:SI | |
1625 | (match_operand:HI 1 "general_operand" "0,g")))] | |
1626 | @dots{}) | |
1627 | @end smallexample | |
1628 | @end ifset | |
1629 | @end table | |
1630 | ||
1631 | @node Machine Constraints | |
1632 | @subsection Constraints for Particular Machines | |
1633 | @cindex machine specific constraints | |
1634 | @cindex constraints, machine specific | |
1635 | ||
1636 | Whenever possible, you should use the general-purpose constraint letters | |
1637 | in @code{asm} arguments, since they will convey meaning more readily to | |
1638 | people reading your code. Failing that, use the constraint letters | |
1639 | that usually have very similar meanings across architectures. The most | |
1640 | commonly used constraints are @samp{m} and @samp{r} (for memory and | |
1641 | general-purpose registers respectively; @pxref{Simple Constraints}), and | |
1642 | @samp{I}, usually the letter indicating the most common | |
1643 | immediate-constant format. | |
1644 | ||
f38840db ZW |
1645 | Each architecture defines additional constraints. These constraints |
1646 | are used by the compiler itself for instruction generation, as well as | |
1647 | for @code{asm} statements; therefore, some of the constraints are not | |
1648 | particularly useful for @code{asm}. Here is a summary of some of the | |
1649 | machine-dependent constraints available on some particular machines; | |
1650 | it includes both constraints that are useful for @code{asm} and | |
1651 | constraints that aren't. The compiler source file mentioned in the | |
1652 | table heading for each architecture is the definitive reference for | |
1653 | the meanings of that architecture's constraints. | |
6ccde948 | 1654 | |
03dda8e3 | 1655 | @table @emph |
74fe790b | 1656 | @item ARM family---@file{config/arm/arm.h} |
03dda8e3 RK |
1657 | @table @code |
1658 | @item f | |
1659 | Floating-point register | |
1660 | ||
9b66ebb1 PB |
1661 | @item w |
1662 | VFP floating-point register | |
1663 | ||
03dda8e3 RK |
1664 | @item F |
1665 | One of the floating-point constants 0.0, 0.5, 1.0, 2.0, 3.0, 4.0, 5.0 | |
1666 | or 10.0 | |
1667 | ||
1668 | @item G | |
1669 | Floating-point constant that would satisfy the constraint @samp{F} if it | |
1670 | were negated | |
1671 | ||
1672 | @item I | |
1673 | Integer that is valid as an immediate operand in a data processing | |
1674 | instruction. That is, an integer in the range 0 to 255 rotated by a | |
1675 | multiple of 2 | |
1676 | ||
1677 | @item J | |
630d3d5a | 1678 | Integer in the range @minus{}4095 to 4095 |
03dda8e3 RK |
1679 | |
1680 | @item K | |
1681 | Integer that satisfies constraint @samp{I} when inverted (ones complement) | |
1682 | ||
1683 | @item L | |
1684 | Integer that satisfies constraint @samp{I} when negated (twos complement) | |
1685 | ||
1686 | @item M | |
1687 | Integer in the range 0 to 32 | |
1688 | ||
1689 | @item Q | |
1690 | A memory reference where the exact address is in a single register | |
1691 | (`@samp{m}' is preferable for @code{asm} statements) | |
1692 | ||
1693 | @item R | |
1694 | An item in the constant pool | |
1695 | ||
1696 | @item S | |
1697 | A symbol in the text segment of the current file | |
03dda8e3 | 1698 | |
1e1ab407 | 1699 | @item Uv |
9b66ebb1 PB |
1700 | A memory reference suitable for VFP load/store insns (reg+constant offset) |
1701 | ||
fdd695fd PB |
1702 | @item Uy |
1703 | A memory reference suitable for iWMMXt load/store instructions. | |
1704 | ||
1e1ab407 | 1705 | @item Uq |
0bdcd332 | 1706 | A memory reference suitable for the ARMv4 ldrsb instruction. |
db875b15 | 1707 | @end table |
1e1ab407 | 1708 | |
fc262682 | 1709 | @item AVR family---@file{config/avr/constraints.md} |
052a4b28 DC |
1710 | @table @code |
1711 | @item l | |
1712 | Registers from r0 to r15 | |
1713 | ||
1714 | @item a | |
1715 | Registers from r16 to r23 | |
1716 | ||
1717 | @item d | |
1718 | Registers from r16 to r31 | |
1719 | ||
1720 | @item w | |
3a69a7d5 | 1721 | Registers from r24 to r31. These registers can be used in @samp{adiw} command |
052a4b28 DC |
1722 | |
1723 | @item e | |
d7d9c429 | 1724 | Pointer register (r26--r31) |
052a4b28 DC |
1725 | |
1726 | @item b | |
d7d9c429 | 1727 | Base pointer register (r28--r31) |
052a4b28 | 1728 | |
3a69a7d5 MM |
1729 | @item q |
1730 | Stack pointer register (SPH:SPL) | |
1731 | ||
052a4b28 DC |
1732 | @item t |
1733 | Temporary register r0 | |
1734 | ||
1735 | @item x | |
1736 | Register pair X (r27:r26) | |
1737 | ||
1738 | @item y | |
1739 | Register pair Y (r29:r28) | |
1740 | ||
1741 | @item z | |
1742 | Register pair Z (r31:r30) | |
1743 | ||
1744 | @item I | |
630d3d5a | 1745 | Constant greater than @minus{}1, less than 64 |
052a4b28 DC |
1746 | |
1747 | @item J | |
630d3d5a | 1748 | Constant greater than @minus{}64, less than 1 |
052a4b28 DC |
1749 | |
1750 | @item K | |
1751 | Constant integer 2 | |
1752 | ||
1753 | @item L | |
1754 | Constant integer 0 | |
1755 | ||
1756 | @item M | |
1757 | Constant that fits in 8 bits | |
1758 | ||
1759 | @item N | |
630d3d5a | 1760 | Constant integer @minus{}1 |
052a4b28 DC |
1761 | |
1762 | @item O | |
3a69a7d5 | 1763 | Constant integer 8, 16, or 24 |
052a4b28 DC |
1764 | |
1765 | @item P | |
1766 | Constant integer 1 | |
1767 | ||
1768 | @item G | |
1769 | A floating point constant 0.0 | |
0e8eb4d8 | 1770 | |
0e8eb4d8 EW |
1771 | @item Q |
1772 | A memory address based on Y or Z pointer with displacement. | |
052a4b28 | 1773 | @end table |
53054e77 | 1774 | |
feeeff5c JR |
1775 | @item Epiphany---@file{config/epiphany/constraints.md} |
1776 | @table @code | |
1777 | @item U16 | |
1778 | An unsigned 16-bit constant. | |
1779 | ||
1780 | @item K | |
1781 | An unsigned 5-bit constant. | |
1782 | ||
1783 | @item L | |
1784 | A signed 11-bit constant. | |
1785 | ||
1786 | @item Cm1 | |
1787 | A signed 11-bit constant added to @minus{}1. | |
1788 | Can only match when the @option{-m1reg-@var{reg}} option is active. | |
1789 | ||
1790 | @item Cl1 | |
1791 | Left-shift of @minus{}1, i.e., a bit mask with a block of leading ones, the rest | |
1792 | being a block of trailing zeroes. | |
1793 | Can only match when the @option{-m1reg-@var{reg}} option is active. | |
1794 | ||
1795 | @item Cr1 | |
1796 | Right-shift of @minus{}1, i.e., a bit mask with a trailing block of ones, the | |
1797 | rest being zeroes. Or to put it another way, one less than a power of two. | |
1798 | Can only match when the @option{-m1reg-@var{reg}} option is active. | |
1799 | ||
1800 | @item Cal | |
1801 | Constant for arithmetic/logical operations. | |
1802 | This is like @code{i}, except that for position independent code, | |
1803 | no symbols / expressions needing relocations are allowed. | |
1804 | ||
1805 | @item Csy | |
1806 | Symbolic constant for call/jump instruction. | |
1807 | ||
1808 | @item Rcs | |
1809 | The register class usable in short insns. This is a register class | |
1810 | constraint, and can thus drive register allocation. | |
1811 | This constraint won't match unless @option{-mprefer-short-insn-regs} is | |
1812 | in effect. | |
1813 | ||
1814 | @item Rsc | |
1815 | The the register class of registers that can be used to hold a | |
1816 | sibcall call address. I.e., a caller-saved register. | |
1817 | ||
1818 | @item Rct | |
1819 | Core control register class. | |
1820 | ||
1821 | @item Rgs | |
1822 | The register group usable in short insns. | |
1823 | This constraint does not use a register class, so that it only | |
1824 | passively matches suitable registers, and doesn't drive register allocation. | |
1825 | ||
1826 | @ifset INTERNALS | |
1827 | @item Car | |
1828 | Constant suitable for the addsi3_r pattern. This is a valid offset | |
1829 | For byte, halfword, or word addressing. | |
1830 | @end ifset | |
1831 | ||
1832 | @item Rra | |
1833 | Matches the return address if it can be replaced with the link register. | |
1834 | ||
1835 | @item Rcc | |
1836 | Matches the integer condition code register. | |
1837 | ||
1838 | @item Sra | |
1839 | Matches the return address if it is in a stack slot. | |
1840 | ||
1841 | @item Cfm | |
1842 | Matches control register values to switch fp mode, which are encapsulated in | |
1843 | @code{UNSPEC_FP_MODE}. | |
1844 | @end table | |
1845 | ||
b25364a0 S |
1846 | @item CR16 Architecture---@file{config/cr16/cr16.h} |
1847 | @table @code | |
1848 | ||
1849 | @item b | |
1850 | Registers from r0 to r14 (registers without stack pointer) | |
1851 | ||
1852 | @item t | |
1853 | Register from r0 to r11 (all 16-bit registers) | |
1854 | ||
1855 | @item p | |
1856 | Register from r12 to r15 (all 32-bit registers) | |
1857 | ||
1858 | @item I | |
1859 | Signed constant that fits in 4 bits | |
1860 | ||
1861 | @item J | |
1862 | Signed constant that fits in 5 bits | |
1863 | ||
1864 | @item K | |
1865 | Signed constant that fits in 6 bits | |
1866 | ||
1867 | @item L | |
1868 | Unsigned constant that fits in 4 bits | |
1869 | ||
1870 | @item M | |
1871 | Signed constant that fits in 32 bits | |
1872 | ||
1873 | @item N | |
1874 | Check for 64 bits wide constants for add/sub instructions | |
1875 | ||
1876 | @item G | |
1877 | Floating point constant that is legal for store immediate | |
1878 | @end table | |
1879 | ||
8119b4e4 JDA |
1880 | @item Hewlett-Packard PA-RISC---@file{config/pa/pa.h} |
1881 | @table @code | |
1882 | @item a | |
1883 | General register 1 | |
1884 | ||
1885 | @item f | |
1886 | Floating point register | |
1887 | ||
1888 | @item q | |
1889 | Shift amount register | |
1890 | ||
1891 | @item x | |
1892 | Floating point register (deprecated) | |
1893 | ||
1894 | @item y | |
1895 | Upper floating point register (32-bit), floating point register (64-bit) | |
1896 | ||
1897 | @item Z | |
1898 | Any register | |
1899 | ||
1900 | @item I | |
1901 | Signed 11-bit integer constant | |
1902 | ||
1903 | @item J | |
1904 | Signed 14-bit integer constant | |
1905 | ||
1906 | @item K | |
1907 | Integer constant that can be deposited with a @code{zdepi} instruction | |
1908 | ||
1909 | @item L | |
1910 | Signed 5-bit integer constant | |
1911 | ||
1912 | @item M | |
1913 | Integer constant 0 | |
1914 | ||
1915 | @item N | |
1916 | Integer constant that can be loaded with a @code{ldil} instruction | |
1917 | ||
1918 | @item O | |
1919 | Integer constant whose value plus one is a power of 2 | |
1920 | ||
1921 | @item P | |
1922 | Integer constant that can be used for @code{and} operations in @code{depi} | |
1923 | and @code{extru} instructions | |
1924 | ||
1925 | @item S | |
1926 | Integer constant 31 | |
1927 | ||
1928 | @item U | |
1929 | Integer constant 63 | |
1930 | ||
1931 | @item G | |
1932 | Floating-point constant 0.0 | |
1933 | ||
1934 | @item A | |
1935 | A @code{lo_sum} data-linkage-table memory operand | |
1936 | ||
1937 | @item Q | |
1938 | A memory operand that can be used as the destination operand of an | |
1939 | integer store instruction | |
1940 | ||
1941 | @item R | |
1942 | A scaled or unscaled indexed memory operand | |
1943 | ||
1944 | @item T | |
1945 | A memory operand for floating-point loads and stores | |
1946 | ||
1947 | @item W | |
1948 | A register indirect memory operand | |
1949 | @end table | |
1950 | ||
358da97e HS |
1951 | @item picoChip family---@file{picochip.h} |
1952 | @table @code | |
1953 | @item k | |
1954 | Stack register. | |
1955 | ||
1956 | @item f | |
1957 | Pointer register. A register which can be used to access memory without | |
1958 | supplying an offset. Any other register can be used to access memory, | |
1959 | but will need a constant offset. In the case of the offset being zero, | |
1960 | it is more efficient to use a pointer register, since this reduces code | |
1961 | size. | |
1962 | ||
1963 | @item t | |
1964 | A twin register. A register which may be paired with an adjacent | |
1965 | register to create a 32-bit register. | |
1966 | ||
1967 | @item a | |
1968 | Any absolute memory address (e.g., symbolic constant, symbolic | |
1969 | constant + offset). | |
1970 | ||
1971 | @item I | |
1972 | 4-bit signed integer. | |
1973 | ||
1974 | @item J | |
1975 | 4-bit unsigned integer. | |
1976 | ||
1977 | @item K | |
1978 | 8-bit signed integer. | |
1979 | ||
1980 | @item M | |
1981 | Any constant whose absolute value is no greater than 4-bits. | |
1982 | ||
1983 | @item N | |
1984 | 10-bit signed integer | |
1985 | ||
1986 | @item O | |
1987 | 16-bit signed integer. | |
1988 | ||
1989 | @end table | |
1990 | ||
74fe790b | 1991 | @item PowerPC and IBM RS6000---@file{config/rs6000/rs6000.h} |
03dda8e3 RK |
1992 | @table @code |
1993 | @item b | |
1994 | Address base register | |
1995 | ||
799dbb0f ME |
1996 | @item d |
1997 | Floating point register (containing 64-bit value) | |
1998 | ||
03dda8e3 | 1999 | @item f |
799dbb0f | 2000 | Floating point register (containing 32-bit value) |
03dda8e3 | 2001 | |
2dcfc29d | 2002 | @item v |
29e6733c MM |
2003 | Altivec vector register |
2004 | ||
2005 | @item wd | |
2006 | VSX vector register to hold vector double data | |
2007 | ||
2008 | @item wf | |
2009 | VSX vector register to hold vector float data | |
2010 | ||
2011 | @item ws | |
2012 | VSX vector register to hold scalar float data | |
2013 | ||
2014 | @item wa | |
2015 | Any VSX register | |
2dcfc29d | 2016 | |
03dda8e3 RK |
2017 | @item h |
2018 | @samp{MQ}, @samp{CTR}, or @samp{LINK} register | |
2019 | ||
2020 | @item q | |
2021 | @samp{MQ} register | |
2022 | ||
2023 | @item c | |
2024 | @samp{CTR} register | |
2025 | ||
2026 | @item l | |
2027 | @samp{LINK} register | |
2028 | ||
2029 | @item x | |
2030 | @samp{CR} register (condition register) number 0 | |
2031 | ||
2032 | @item y | |
2033 | @samp{CR} register (condition register) | |
2034 | ||
8f685459 | 2035 | @item z |
f6b5d695 | 2036 | @samp{XER[CA]} carry bit (part of the XER register) |
8f685459 | 2037 | |
03dda8e3 | 2038 | @item I |
1e5f973d | 2039 | Signed 16-bit constant |
03dda8e3 RK |
2040 | |
2041 | @item J | |
ebb48a4d | 2042 | Unsigned 16-bit constant shifted left 16 bits (use @samp{L} instead for |
5f59ecb7 | 2043 | @code{SImode} constants) |
03dda8e3 RK |
2044 | |
2045 | @item K | |
1e5f973d | 2046 | Unsigned 16-bit constant |
03dda8e3 RK |
2047 | |
2048 | @item L | |
1e5f973d | 2049 | Signed 16-bit constant shifted left 16 bits |
03dda8e3 RK |
2050 | |
2051 | @item M | |
2052 | Constant larger than 31 | |
2053 | ||
2054 | @item N | |
2055 | Exact power of 2 | |
2056 | ||
2057 | @item O | |
2058 | Zero | |
2059 | ||
2060 | @item P | |
1e5f973d | 2061 | Constant whose negation is a signed 16-bit constant |
03dda8e3 RK |
2062 | |
2063 | @item G | |
2064 | Floating point constant that can be loaded into a register with one | |
2065 | instruction per word | |
2066 | ||
a8a51a97 AP |
2067 | @item H |
2068 | Integer/Floating point constant that can be loaded into a register using | |
2069 | three instructions | |
2070 | ||
1d447995 | 2071 | @item m |
ff2ce160 | 2072 | Memory operand. |
fea31288 JJ |
2073 | Normally, @code{m} does not allow addresses that update the base register. |
2074 | If @samp{<} or @samp{>} constraint is also used, they are allowed and | |
2075 | therefore on PowerPC targets in that case it is only safe | |
2076 | to use @samp{m<>} in an @code{asm} statement if that @code{asm} statement | |
1d447995 RS |
2077 | accesses the operand exactly once. The @code{asm} statement must also |
2078 | use @samp{%U@var{<opno>}} as a placeholder for the ``update'' flag in the | |
2079 | corresponding load or store instruction. For example: | |
2080 | ||
2081 | @smallexample | |
fea31288 | 2082 | asm ("st%U0 %1,%0" : "=m<>" (mem) : "r" (val)); |
1d447995 RS |
2083 | @end smallexample |
2084 | ||
2085 | is correct but: | |
2086 | ||
2087 | @smallexample | |
fea31288 | 2088 | asm ("st %1,%0" : "=m<>" (mem) : "r" (val)); |
1d447995 RS |
2089 | @end smallexample |
2090 | ||
fea31288 | 2091 | is not. |
1d447995 RS |
2092 | |
2093 | @item es | |
2094 | A ``stable'' memory operand; that is, one which does not include any | |
fea31288 JJ |
2095 | automodification of the base register. This used to be useful when |
2096 | @samp{m} allowed automodification of the base register, but as those are now only | |
2097 | allowed when @samp{<} or @samp{>} is used, @samp{es} is basically the same | |
2098 | as @samp{m} without @samp{<} and @samp{>}. | |
1d447995 | 2099 | |
03dda8e3 | 2100 | @item Q |
1d447995 RS |
2101 | Memory operand that is an offset from a register (it is usually better |
2102 | to use @samp{m} or @samp{es} in @code{asm} statements) | |
03dda8e3 | 2103 | |
a8a51a97 | 2104 | @item Z |
1d447995 RS |
2105 | Memory operand that is an indexed or indirect from a register (it is |
2106 | usually better to use @samp{m} or @samp{es} in @code{asm} statements) | |
a8a51a97 | 2107 | |
03dda8e3 RK |
2108 | @item R |
2109 | AIX TOC entry | |
2110 | ||
a8a51a97 AP |
2111 | @item a |
2112 | Address operand that is an indexed or indirect from a register (@samp{p} is | |
2113 | preferable for @code{asm} statements) | |
2114 | ||
03dda8e3 | 2115 | @item S |
8f685459 | 2116 | Constant suitable as a 64-bit mask operand |
03dda8e3 | 2117 | |
5f59ecb7 DE |
2118 | @item T |
2119 | Constant suitable as a 32-bit mask operand | |
2120 | ||
03dda8e3 RK |
2121 | @item U |
2122 | System V Release 4 small data area reference | |
a8a51a97 AP |
2123 | |
2124 | @item t | |
2125 | AND masks that can be performed by two rldic@{l, r@} instructions | |
2126 | ||
2127 | @item W | |
2128 | Vector constant that does not require memory | |
2129 | ||
29e6733c MM |
2130 | @item j |
2131 | Vector constant that is all zeros. | |
2132 | ||
03dda8e3 RK |
2133 | @end table |
2134 | ||
08b1e29a | 2135 | @item Intel 386---@file{config/i386/constraints.md} |
03dda8e3 | 2136 | @table @code |
0c56474e | 2137 | @item R |
f38840db ZW |
2138 | Legacy register---the eight integer registers available on all |
2139 | i386 processors (@code{a}, @code{b}, @code{c}, @code{d}, | |
2140 | @code{si}, @code{di}, @code{bp}, @code{sp}). | |
03dda8e3 | 2141 | |
f38840db ZW |
2142 | @item q |
2143 | Any register accessible as @code{@var{r}l}. In 32-bit mode, @code{a}, | |
2144 | @code{b}, @code{c}, and @code{d}; in 64-bit mode, any integer register. | |
03dda8e3 | 2145 | |
f38840db ZW |
2146 | @item Q |
2147 | Any register accessible as @code{@var{r}h}: @code{a}, @code{b}, | |
2148 | @code{c}, and @code{d}. | |
03dda8e3 | 2149 | |
f38840db ZW |
2150 | @ifset INTERNALS |
2151 | @item l | |
2152 | Any register that can be used as the index in a base+index memory | |
2153 | access: that is, any general register except the stack pointer. | |
2154 | @end ifset | |
03dda8e3 RK |
2155 | |
2156 | @item a | |
f38840db | 2157 | The @code{a} register. |
03dda8e3 RK |
2158 | |
2159 | @item b | |
f38840db | 2160 | The @code{b} register. |
03dda8e3 RK |
2161 | |
2162 | @item c | |
f38840db | 2163 | The @code{c} register. |
f8ca7923 | 2164 | |
03dda8e3 | 2165 | @item d |
f38840db ZW |
2166 | The @code{d} register. |
2167 | ||
2168 | @item S | |
2169 | The @code{si} register. | |
03dda8e3 RK |
2170 | |
2171 | @item D | |
f38840db | 2172 | The @code{di} register. |
03dda8e3 | 2173 | |
f38840db | 2174 | @item A |
ae8358d6 RG |
2175 | The @code{a} and @code{d} registers. This class is used for instructions |
2176 | that return double word results in the @code{ax:dx} register pair. Single | |
2177 | word values will be allocated either in @code{ax} or @code{dx}. | |
2178 | For example on i386 the following implements @code{rdtsc}: | |
2179 | ||
2180 | @smallexample | |
2181 | unsigned long long rdtsc (void) | |
2182 | @{ | |
2183 | unsigned long long tick; | |
2184 | __asm__ __volatile__("rdtsc":"=A"(tick)); | |
2185 | return tick; | |
2186 | @} | |
2187 | @end smallexample | |
2188 | ||
2189 | This is not correct on x86_64 as it would allocate tick in either @code{ax} | |
2190 | or @code{dx}. You have to use the following variant instead: | |
2191 | ||
2192 | @smallexample | |
2193 | unsigned long long rdtsc (void) | |
2194 | @{ | |
2195 | unsigned int tickl, tickh; | |
2196 | __asm__ __volatile__("rdtsc":"=a"(tickl),"=d"(tickh)); | |
2197 | return ((unsigned long long)tickh << 32)|tickl; | |
2198 | @} | |
2199 | @end smallexample | |
2200 | ||
03dda8e3 | 2201 | |
f38840db ZW |
2202 | @item f |
2203 | Any 80387 floating-point (stack) register. | |
2204 | ||
2205 | @item t | |
2206 | Top of 80387 floating-point stack (@code{%st(0)}). | |
2207 | ||
2208 | @item u | |
2209 | Second from top of 80387 floating-point stack (@code{%st(1)}). | |
994682b9 AJ |
2210 | |
2211 | @item y | |
f38840db ZW |
2212 | Any MMX register. |
2213 | ||
2214 | @item x | |
2215 | Any SSE register. | |
2216 | ||
c5245af5 L |
2217 | @item Yz |
2218 | First SSE register (@code{%xmm0}). | |
2219 | ||
f38840db | 2220 | @ifset INTERNALS |
c5245af5 L |
2221 | @item Y2 |
2222 | Any SSE register, when SSE2 is enabled. | |
2223 | ||
2224 | @item Yi | |
2225 | Any SSE register, when SSE2 and inter-unit moves are enabled. | |
2226 | ||
2227 | @item Ym | |
2228 | Any MMX register, when inter-unit moves are enabled. | |
f38840db | 2229 | @end ifset |
994682b9 | 2230 | |
03dda8e3 | 2231 | @item I |
f38840db | 2232 | Integer constant in the range 0 @dots{} 31, for 32-bit shifts. |
03dda8e3 RK |
2233 | |
2234 | @item J | |
f38840db | 2235 | Integer constant in the range 0 @dots{} 63, for 64-bit shifts. |
03dda8e3 RK |
2236 | |
2237 | @item K | |
f38840db | 2238 | Signed 8-bit integer constant. |
03dda8e3 RK |
2239 | |
2240 | @item L | |
f38840db | 2241 | @code{0xFF} or @code{0xFFFF}, for andsi as a zero-extending move. |
03dda8e3 RK |
2242 | |
2243 | @item M | |
f38840db | 2244 | 0, 1, 2, or 3 (shifts for the @code{lea} instruction). |
03dda8e3 RK |
2245 | |
2246 | @item N | |
ff2ce160 | 2247 | Unsigned 8-bit integer constant (for @code{in} and @code{out} |
f38840db | 2248 | instructions). |
03dda8e3 | 2249 | |
f38840db ZW |
2250 | @ifset INTERNALS |
2251 | @item O | |
2252 | Integer constant in the range 0 @dots{} 127, for 128-bit shifts. | |
2253 | @end ifset | |
2254 | ||
2255 | @item G | |
2256 | Standard 80387 floating point constant. | |
2257 | ||
2258 | @item C | |
2259 | Standard SSE floating point constant. | |
0c56474e JH |
2260 | |
2261 | @item e | |
f38840db ZW |
2262 | 32-bit signed integer constant, or a symbolic reference known |
2263 | to fit that range (for immediate operands in sign-extending x86-64 | |
2264 | instructions). | |
2265 | ||
2266 | @item Z | |
2267 | 32-bit unsigned integer constant, or a symbolic reference known | |
2268 | to fit that range (for immediate operands in zero-extending x86-64 | |
2269 | instructions). | |
0c56474e | 2270 | |
03dda8e3 RK |
2271 | @end table |
2272 | ||
74fe790b | 2273 | @item Intel IA-64---@file{config/ia64/ia64.h} |
7a430e3b SC |
2274 | @table @code |
2275 | @item a | |
2276 | General register @code{r0} to @code{r3} for @code{addl} instruction | |
2277 | ||
2278 | @item b | |
2279 | Branch register | |
2280 | ||
2281 | @item c | |
2282 | Predicate register (@samp{c} as in ``conditional'') | |
2283 | ||
2284 | @item d | |
2285 | Application register residing in M-unit | |
2286 | ||
2287 | @item e | |
2288 | Application register residing in I-unit | |
2289 | ||
2290 | @item f | |
2291 | Floating-point register | |
2292 | ||
2293 | @item m | |
fea31288 JJ |
2294 | Memory operand. If used together with @samp{<} or @samp{>}, |
2295 | the operand can have postincrement and postdecrement which | |
7a430e3b | 2296 | require printing with @samp{%Pn} on IA-64. |
7a430e3b SC |
2297 | |
2298 | @item G | |
2299 | Floating-point constant 0.0 or 1.0 | |
2300 | ||
2301 | @item I | |
2302 | 14-bit signed integer constant | |
2303 | ||
2304 | @item J | |
2305 | 22-bit signed integer constant | |
2306 | ||
2307 | @item K | |
2308 | 8-bit signed integer constant for logical instructions | |
2309 | ||
2310 | @item L | |
2311 | 8-bit adjusted signed integer constant for compare pseudo-ops | |
2312 | ||
2313 | @item M | |
2314 | 6-bit unsigned integer constant for shift counts | |
2315 | ||
2316 | @item N | |
2317 | 9-bit signed integer constant for load and store postincrements | |
2318 | ||
2319 | @item O | |
2320 | The constant zero | |
2321 | ||
2322 | @item P | |
78466c0e | 2323 | 0 or @minus{}1 for @code{dep} instruction |
7a430e3b SC |
2324 | |
2325 | @item Q | |
2326 | Non-volatile memory for floating-point loads and stores | |
2327 | ||
2328 | @item R | |
2329 | Integer constant in the range 1 to 4 for @code{shladd} instruction | |
2330 | ||
2331 | @item S | |
fea31288 JJ |
2332 | Memory operand except postincrement and postdecrement. This is |
2333 | now roughly the same as @samp{m} when not used together with @samp{<} | |
2334 | or @samp{>}. | |
7a430e3b | 2335 | @end table |
03dda8e3 | 2336 | |
74fe790b | 2337 | @item FRV---@file{config/frv/frv.h} |
70899148 BS |
2338 | @table @code |
2339 | @item a | |
840758d3 | 2340 | Register in the class @code{ACC_REGS} (@code{acc0} to @code{acc7}). |
70899148 BS |
2341 | |
2342 | @item b | |
840758d3 | 2343 | Register in the class @code{EVEN_ACC_REGS} (@code{acc0} to @code{acc7}). |
70899148 BS |
2344 | |
2345 | @item c | |
840758d3 BS |
2346 | Register in the class @code{CC_REGS} (@code{fcc0} to @code{fcc3} and |
2347 | @code{icc0} to @code{icc3}). | |
70899148 BS |
2348 | |
2349 | @item d | |
840758d3 | 2350 | Register in the class @code{GPR_REGS} (@code{gr0} to @code{gr63}). |
70899148 BS |
2351 | |
2352 | @item e | |
840758d3 | 2353 | Register in the class @code{EVEN_REGS} (@code{gr0} to @code{gr63}). |
70899148 BS |
2354 | Odd registers are excluded not in the class but through the use of a machine |
2355 | mode larger than 4 bytes. | |
2356 | ||
2357 | @item f | |
840758d3 | 2358 | Register in the class @code{FPR_REGS} (@code{fr0} to @code{fr63}). |
70899148 BS |
2359 | |
2360 | @item h | |
840758d3 | 2361 | Register in the class @code{FEVEN_REGS} (@code{fr0} to @code{fr63}). |
70899148 BS |
2362 | Odd registers are excluded not in the class but through the use of a machine |
2363 | mode larger than 4 bytes. | |
2364 | ||
2365 | @item l | |
840758d3 | 2366 | Register in the class @code{LR_REG} (the @code{lr} register). |
70899148 BS |
2367 | |
2368 | @item q | |
840758d3 | 2369 | Register in the class @code{QUAD_REGS} (@code{gr2} to @code{gr63}). |
70899148 BS |
2370 | Register numbers not divisible by 4 are excluded not in the class but through |
2371 | the use of a machine mode larger than 8 bytes. | |
2372 | ||
2373 | @item t | |
840758d3 | 2374 | Register in the class @code{ICC_REGS} (@code{icc0} to @code{icc3}). |
70899148 BS |
2375 | |
2376 | @item u | |
840758d3 | 2377 | Register in the class @code{FCC_REGS} (@code{fcc0} to @code{fcc3}). |
70899148 BS |
2378 | |
2379 | @item v | |
840758d3 | 2380 | Register in the class @code{ICR_REGS} (@code{cc4} to @code{cc7}). |
70899148 BS |
2381 | |
2382 | @item w | |
840758d3 | 2383 | Register in the class @code{FCR_REGS} (@code{cc0} to @code{cc3}). |
70899148 BS |
2384 | |
2385 | @item x | |
840758d3 | 2386 | Register in the class @code{QUAD_FPR_REGS} (@code{fr0} to @code{fr63}). |
70899148 BS |
2387 | Register numbers not divisible by 4 are excluded not in the class but through |
2388 | the use of a machine mode larger than 8 bytes. | |
2389 | ||
2390 | @item z | |
840758d3 | 2391 | Register in the class @code{SPR_REGS} (@code{lcr} and @code{lr}). |
70899148 BS |
2392 | |
2393 | @item A | |
840758d3 | 2394 | Register in the class @code{QUAD_ACC_REGS} (@code{acc0} to @code{acc7}). |
70899148 BS |
2395 | |
2396 | @item B | |
840758d3 | 2397 | Register in the class @code{ACCG_REGS} (@code{accg0} to @code{accg7}). |
70899148 BS |
2398 | |
2399 | @item C | |
840758d3 | 2400 | Register in the class @code{CR_REGS} (@code{cc0} to @code{cc7}). |
70899148 BS |
2401 | |
2402 | @item G | |
2403 | Floating point constant zero | |
2404 | ||
2405 | @item I | |
2406 | 6-bit signed integer constant | |
2407 | ||
2408 | @item J | |
2409 | 10-bit signed integer constant | |
2410 | ||
2411 | @item L | |
2412 | 16-bit signed integer constant | |
2413 | ||
2414 | @item M | |
2415 | 16-bit unsigned integer constant | |
2416 | ||
2417 | @item N | |
840758d3 BS |
2418 | 12-bit signed integer constant that is negative---i.e.@: in the |
2419 | range of @minus{}2048 to @minus{}1 | |
70899148 BS |
2420 | |
2421 | @item O | |
2422 | Constant zero | |
2423 | ||
2424 | @item P | |
840758d3 | 2425 | 12-bit signed integer constant that is greater than zero---i.e.@: in the |
70899148 BS |
2426 | range of 1 to 2047. |
2427 | ||
2428 | @end table | |
2429 | ||
9fdd7520 | 2430 | @item Blackfin family---@file{config/bfin/constraints.md} |
0d4a78eb BS |
2431 | @table @code |
2432 | @item a | |
2433 | P register | |
2434 | ||
2435 | @item d | |
2436 | D register | |
2437 | ||
2438 | @item z | |
2439 | A call clobbered P register. | |
2440 | ||
03848bd0 BS |
2441 | @item q@var{n} |
2442 | A single register. If @var{n} is in the range 0 to 7, the corresponding D | |
2443 | register. If it is @code{A}, then the register P0. | |
2444 | ||
0d4a78eb BS |
2445 | @item D |
2446 | Even-numbered D register | |
2447 | ||
2448 | @item W | |
2449 | Odd-numbered D register | |
2450 | ||
2451 | @item e | |
2452 | Accumulator register. | |
2453 | ||
2454 | @item A | |
2455 | Even-numbered accumulator register. | |
2456 | ||
2457 | @item B | |
2458 | Odd-numbered accumulator register. | |
2459 | ||
2460 | @item b | |
2461 | I register | |
2462 | ||
a9c46998 | 2463 | @item v |
0d4a78eb BS |
2464 | B register |
2465 | ||
2466 | @item f | |
2467 | M register | |
2468 | ||
2469 | @item c | |
2470 | Registers used for circular buffering, i.e. I, B, or L registers. | |
2471 | ||
2472 | @item C | |
2473 | The CC register. | |
2474 | ||
a9c46998 JZ |
2475 | @item t |
2476 | LT0 or LT1. | |
2477 | ||
2478 | @item k | |
2479 | LC0 or LC1. | |
2480 | ||
2481 | @item u | |
2482 | LB0 or LB1. | |
2483 | ||
0d4a78eb BS |
2484 | @item x |
2485 | Any D, P, B, M, I or L register. | |
2486 | ||
2487 | @item y | |
2488 | Additional registers typically used only in prologues and epilogues: RETS, | |
2489 | RETN, RETI, RETX, RETE, ASTAT, SEQSTAT and USP. | |
2490 | ||
2491 | @item w | |
2492 | Any register except accumulators or CC. | |
2493 | ||
2494 | @item Ksh | |
8ad1dde7 | 2495 | Signed 16 bit integer (in the range @minus{}32768 to 32767) |
0d4a78eb BS |
2496 | |
2497 | @item Kuh | |
2498 | Unsigned 16 bit integer (in the range 0 to 65535) | |
2499 | ||
2500 | @item Ks7 | |
8ad1dde7 | 2501 | Signed 7 bit integer (in the range @minus{}64 to 63) |
0d4a78eb BS |
2502 | |
2503 | @item Ku7 | |
2504 | Unsigned 7 bit integer (in the range 0 to 127) | |
2505 | ||
2506 | @item Ku5 | |
2507 | Unsigned 5 bit integer (in the range 0 to 31) | |
2508 | ||
2509 | @item Ks4 | |
8ad1dde7 | 2510 | Signed 4 bit integer (in the range @minus{}8 to 7) |
0d4a78eb BS |
2511 | |
2512 | @item Ks3 | |
8ad1dde7 | 2513 | Signed 3 bit integer (in the range @minus{}3 to 4) |
0d4a78eb BS |
2514 | |
2515 | @item Ku3 | |
2516 | Unsigned 3 bit integer (in the range 0 to 7) | |
2517 | ||
2518 | @item P@var{n} | |
2519 | Constant @var{n}, where @var{n} is a single-digit constant in the range 0 to 4. | |
2520 | ||
3efd5670 BS |
2521 | @item PA |
2522 | An integer equal to one of the MACFLAG_XXX constants that is suitable for | |
2523 | use with either accumulator. | |
2524 | ||
2525 | @item PB | |
2526 | An integer equal to one of the MACFLAG_XXX constants that is suitable for | |
2527 | use only with accumulator A1. | |
2528 | ||
0d4a78eb BS |
2529 | @item M1 |
2530 | Constant 255. | |
2531 | ||
2532 | @item M2 | |
2533 | Constant 65535. | |
2534 | ||
2535 | @item J | |
2536 | An integer constant with exactly a single bit set. | |
2537 | ||
2538 | @item L | |
2539 | An integer constant with all bits set except exactly one. | |
2540 | ||
2541 | @item H | |
2542 | ||
2543 | @item Q | |
2544 | Any SYMBOL_REF. | |
2545 | @end table | |
2546 | ||
74fe790b ZW |
2547 | @item M32C---@file{config/m32c/m32c.c} |
2548 | @table @code | |
38b2d076 DD |
2549 | @item Rsp |
2550 | @itemx Rfb | |
2551 | @itemx Rsb | |
2552 | @samp{$sp}, @samp{$fb}, @samp{$sb}. | |
2553 | ||
2554 | @item Rcr | |
2555 | Any control register, when they're 16 bits wide (nothing if control | |
2556 | registers are 24 bits wide) | |
2557 | ||
2558 | @item Rcl | |
2559 | Any control register, when they're 24 bits wide. | |
2560 | ||
2561 | @item R0w | |
2562 | @itemx R1w | |
2563 | @itemx R2w | |
2564 | @itemx R3w | |
2565 | $r0, $r1, $r2, $r3. | |
2566 | ||
2567 | @item R02 | |
2568 | $r0 or $r2, or $r2r0 for 32 bit values. | |
2569 | ||
2570 | @item R13 | |
2571 | $r1 or $r3, or $r3r1 for 32 bit values. | |
2572 | ||
2573 | @item Rdi | |
2574 | A register that can hold a 64 bit value. | |
2575 | ||
2576 | @item Rhl | |
2577 | $r0 or $r1 (registers with addressable high/low bytes) | |
2578 | ||
2579 | @item R23 | |
2580 | $r2 or $r3 | |
2581 | ||
2582 | @item Raa | |
2583 | Address registers | |
2584 | ||
2585 | @item Raw | |
2586 | Address registers when they're 16 bits wide. | |
2587 | ||
2588 | @item Ral | |
2589 | Address registers when they're 24 bits wide. | |
2590 | ||
2591 | @item Rqi | |
2592 | Registers that can hold QI values. | |
2593 | ||
2594 | @item Rad | |
2595 | Registers that can be used with displacements ($a0, $a1, $sb). | |
2596 | ||
2597 | @item Rsi | |
2598 | Registers that can hold 32 bit values. | |
2599 | ||
2600 | @item Rhi | |
2601 | Registers that can hold 16 bit values. | |
2602 | ||
2603 | @item Rhc | |
2604 | Registers chat can hold 16 bit values, including all control | |
2605 | registers. | |
2606 | ||
2607 | @item Rra | |
2608 | $r0 through R1, plus $a0 and $a1. | |
2609 | ||
2610 | @item Rfl | |
2611 | The flags register. | |
2612 | ||
2613 | @item Rmm | |
2614 | The memory-based pseudo-registers $mem0 through $mem15. | |
2615 | ||
2616 | @item Rpi | |
2617 | Registers that can hold pointers (16 bit registers for r8c, m16c; 24 | |
2618 | bit registers for m32cm, m32c). | |
2619 | ||
2620 | @item Rpa | |
2621 | Matches multiple registers in a PARALLEL to form a larger register. | |
2622 | Used to match function return values. | |
2623 | ||
2624 | @item Is3 | |
8ad1dde7 | 2625 | @minus{}8 @dots{} 7 |
38b2d076 DD |
2626 | |
2627 | @item IS1 | |
8ad1dde7 | 2628 | @minus{}128 @dots{} 127 |
38b2d076 DD |
2629 | |
2630 | @item IS2 | |
8ad1dde7 | 2631 | @minus{}32768 @dots{} 32767 |
38b2d076 DD |
2632 | |
2633 | @item IU2 | |
2634 | 0 @dots{} 65535 | |
2635 | ||
2636 | @item In4 | |
8ad1dde7 | 2637 | @minus{}8 @dots{} @minus{}1 or 1 @dots{} 8 |
38b2d076 DD |
2638 | |
2639 | @item In5 | |
8ad1dde7 | 2640 | @minus{}16 @dots{} @minus{}1 or 1 @dots{} 16 |
38b2d076 | 2641 | |
23fed240 | 2642 | @item In6 |
8ad1dde7 | 2643 | @minus{}32 @dots{} @minus{}1 or 1 @dots{} 32 |
38b2d076 DD |
2644 | |
2645 | @item IM2 | |
8ad1dde7 | 2646 | @minus{}65536 @dots{} @minus{}1 |
38b2d076 DD |
2647 | |
2648 | @item Ilb | |
2649 | An 8 bit value with exactly one bit set. | |
2650 | ||
2651 | @item Ilw | |
2652 | A 16 bit value with exactly one bit set. | |
2653 | ||
2654 | @item Sd | |
2655 | The common src/dest memory addressing modes. | |
2656 | ||
2657 | @item Sa | |
2658 | Memory addressed using $a0 or $a1. | |
2659 | ||
2660 | @item Si | |
2661 | Memory addressed with immediate addresses. | |
2662 | ||
2663 | @item Ss | |
2664 | Memory addressed using the stack pointer ($sp). | |
2665 | ||
2666 | @item Sf | |
2667 | Memory addressed using the frame base register ($fb). | |
2668 | ||
2669 | @item Ss | |
2670 | Memory addressed using the small base register ($sb). | |
2671 | ||
2672 | @item S1 | |
2673 | $r1h | |
e2491744 DD |
2674 | @end table |
2675 | ||
2676 | @item MeP---@file{config/mep/constraints.md} | |
2677 | @table @code | |
2678 | ||
2679 | @item a | |
2680 | The $sp register. | |
2681 | ||
2682 | @item b | |
2683 | The $tp register. | |
2684 | ||
2685 | @item c | |
2686 | Any control register. | |
2687 | ||
2688 | @item d | |
2689 | Either the $hi or the $lo register. | |
2690 | ||
2691 | @item em | |
2692 | Coprocessor registers that can be directly loaded ($c0-$c15). | |
2693 | ||
2694 | @item ex | |
2695 | Coprocessor registers that can be moved to each other. | |
2696 | ||
2697 | @item er | |
2698 | Coprocessor registers that can be moved to core registers. | |
2699 | ||
2700 | @item h | |
2701 | The $hi register. | |
2702 | ||
2703 | @item j | |
2704 | The $rpc register. | |
2705 | ||
2706 | @item l | |
2707 | The $lo register. | |
2708 | ||
2709 | @item t | |
2710 | Registers which can be used in $tp-relative addressing. | |
2711 | ||
2712 | @item v | |
2713 | The $gp register. | |
2714 | ||
2715 | @item x | |
2716 | The coprocessor registers. | |
2717 | ||
2718 | @item y | |
2719 | The coprocessor control registers. | |
2720 | ||
2721 | @item z | |
2722 | The $0 register. | |
2723 | ||
2724 | @item A | |
2725 | User-defined register set A. | |
2726 | ||
2727 | @item B | |
2728 | User-defined register set B. | |
2729 | ||
2730 | @item C | |
2731 | User-defined register set C. | |
2732 | ||
2733 | @item D | |
2734 | User-defined register set D. | |
2735 | ||
2736 | @item I | |
2737 | Offsets for $gp-rel addressing. | |
2738 | ||
2739 | @item J | |
2740 | Constants that can be used directly with boolean insns. | |
2741 | ||
2742 | @item K | |
2743 | Constants that can be moved directly to registers. | |
2744 | ||
2745 | @item L | |
2746 | Small constants that can be added to registers. | |
2747 | ||
2748 | @item M | |
2749 | Long shift counts. | |
2750 | ||
2751 | @item N | |
2752 | Small constants that can be compared to registers. | |
2753 | ||
2754 | @item O | |
2755 | Constants that can be loaded into the top half of registers. | |
2756 | ||
2757 | @item S | |
2758 | Signed 8-bit immediates. | |
2759 | ||
2760 | @item T | |
2761 | Symbols encoded for $tp-rel or $gp-rel addressing. | |
2762 | ||
2763 | @item U | |
2764 | Non-constant addresses for loading/saving coprocessor registers. | |
2765 | ||
2766 | @item W | |
2767 | The top half of a symbol's value. | |
2768 | ||
2769 | @item Y | |
2770 | A register indirect address without offset. | |
2771 | ||
2772 | @item Z | |
2773 | Symbolic references to the control bus. | |
2774 | ||
80920132 | 2775 | @end table |
e2491744 | 2776 | |
80920132 ME |
2777 | @item MicroBlaze---@file{config/microblaze/constraints.md} |
2778 | @table @code | |
2779 | @item d | |
2780 | A general register (@code{r0} to @code{r31}). | |
2781 | ||
2782 | @item z | |
2783 | A status register (@code{rmsr}, @code{$fcc1} to @code{$fcc7}). | |
e2491744 | 2784 | |
74fe790b | 2785 | @end table |
38b2d076 | 2786 | |
cbbb5b6d | 2787 | @item MIPS---@file{config/mips/constraints.md} |
4226378a PK |
2788 | @table @code |
2789 | @item d | |
cbbb5b6d RS |
2790 | An address register. This is equivalent to @code{r} unless |
2791 | generating MIPS16 code. | |
4226378a PK |
2792 | |
2793 | @item f | |
cbbb5b6d | 2794 | A floating-point register (if available). |
4226378a PK |
2795 | |
2796 | @item h | |
21dfc6dc | 2797 | Formerly the @code{hi} register. This constraint is no longer supported. |
4226378a PK |
2798 | |
2799 | @item l | |
21dfc6dc RS |
2800 | The @code{lo} register. Use this register to store values that are |
2801 | no bigger than a word. | |
4226378a PK |
2802 | |
2803 | @item x | |
21dfc6dc RS |
2804 | The concatenated @code{hi} and @code{lo} registers. Use this register |
2805 | to store doubleword values. | |
cbbb5b6d RS |
2806 | |
2807 | @item c | |
2808 | A register suitable for use in an indirect jump. This will always be | |
2809 | @code{$25} for @option{-mabicalls}. | |
4226378a | 2810 | |
2feaae20 RS |
2811 | @item v |
2812 | Register @code{$3}. Do not use this constraint in new code; | |
2813 | it is retained only for compatibility with glibc. | |
2814 | ||
4226378a | 2815 | @item y |
cbbb5b6d | 2816 | Equivalent to @code{r}; retained for backwards compatibility. |
4226378a PK |
2817 | |
2818 | @item z | |
cbbb5b6d | 2819 | A floating-point condition code register. |
4226378a PK |
2820 | |
2821 | @item I | |
cbbb5b6d | 2822 | A signed 16-bit constant (for arithmetic instructions). |
4226378a PK |
2823 | |
2824 | @item J | |
cbbb5b6d | 2825 | Integer zero. |
4226378a PK |
2826 | |
2827 | @item K | |
cbbb5b6d | 2828 | An unsigned 16-bit constant (for logic instructions). |
4226378a PK |
2829 | |
2830 | @item L | |
cbbb5b6d RS |
2831 | A signed 32-bit constant in which the lower 16 bits are zero. |
2832 | Such constants can be loaded using @code{lui}. | |
4226378a PK |
2833 | |
2834 | @item M | |
cbbb5b6d RS |
2835 | A constant that cannot be loaded using @code{lui}, @code{addiu} |
2836 | or @code{ori}. | |
4226378a PK |
2837 | |
2838 | @item N | |
8ad1dde7 | 2839 | A constant in the range @minus{}65535 to @minus{}1 (inclusive). |
4226378a PK |
2840 | |
2841 | @item O | |
cbbb5b6d | 2842 | A signed 15-bit constant. |
4226378a PK |
2843 | |
2844 | @item P | |
cbbb5b6d | 2845 | A constant in the range 1 to 65535 (inclusive). |
4226378a PK |
2846 | |
2847 | @item G | |
cbbb5b6d | 2848 | Floating-point zero. |
4226378a PK |
2849 | |
2850 | @item R | |
cbbb5b6d | 2851 | An address that can be used in a non-macro load or store. |
4226378a PK |
2852 | @end table |
2853 | ||
c47b0cb4 | 2854 | @item Motorola 680x0---@file{config/m68k/constraints.md} |
03dda8e3 RK |
2855 | @table @code |
2856 | @item a | |
2857 | Address register | |
2858 | ||
2859 | @item d | |
2860 | Data register | |
2861 | ||
2862 | @item f | |
2863 | 68881 floating-point register, if available | |
2864 | ||
03dda8e3 RK |
2865 | @item I |
2866 | Integer in the range 1 to 8 | |
2867 | ||
2868 | @item J | |
1e5f973d | 2869 | 16-bit signed number |
03dda8e3 RK |
2870 | |
2871 | @item K | |
2872 | Signed number whose magnitude is greater than 0x80 | |
2873 | ||
2874 | @item L | |
630d3d5a | 2875 | Integer in the range @minus{}8 to @minus{}1 |
03dda8e3 RK |
2876 | |
2877 | @item M | |
2878 | Signed number whose magnitude is greater than 0x100 | |
2879 | ||
c47b0cb4 MK |
2880 | @item N |
2881 | Range 24 to 31, rotatert:SI 8 to 1 expressed as rotate | |
2882 | ||
2883 | @item O | |
2884 | 16 (for rotate using swap) | |
2885 | ||
2886 | @item P | |
2887 | Range 8 to 15, rotatert:HI 8 to 1 expressed as rotate | |
2888 | ||
2889 | @item R | |
2890 | Numbers that mov3q can handle | |
2891 | ||
03dda8e3 RK |
2892 | @item G |
2893 | Floating point constant that is not a 68881 constant | |
c47b0cb4 MK |
2894 | |
2895 | @item S | |
2896 | Operands that satisfy 'm' when -mpcrel is in effect | |
2897 | ||
2898 | @item T | |
2899 | Operands that satisfy 's' when -mpcrel is not in effect | |
2900 | ||
2901 | @item Q | |
2902 | Address register indirect addressing mode | |
2903 | ||
2904 | @item U | |
2905 | Register offset addressing | |
2906 | ||
2907 | @item W | |
2908 | const_call_operand | |
2909 | ||
2910 | @item Cs | |
2911 | symbol_ref or const | |
2912 | ||
2913 | @item Ci | |
2914 | const_int | |
2915 | ||
2916 | @item C0 | |
2917 | const_int 0 | |
2918 | ||
2919 | @item Cj | |
2920 | Range of signed numbers that don't fit in 16 bits | |
2921 | ||
2922 | @item Cmvq | |
2923 | Integers valid for mvq | |
2924 | ||
2925 | @item Capsw | |
2926 | Integers valid for a moveq followed by a swap | |
2927 | ||
2928 | @item Cmvz | |
2929 | Integers valid for mvz | |
2930 | ||
2931 | @item Cmvs | |
2932 | Integers valid for mvs | |
2933 | ||
2934 | @item Ap | |
2935 | push_operand | |
2936 | ||
2937 | @item Ac | |
2938 | Non-register operands allowed in clr | |
2939 | ||
03dda8e3 RK |
2940 | @end table |
2941 | ||
cceb575c AG |
2942 | @item Moxie---@file{config/moxie/constraints.md} |
2943 | @table @code | |
2944 | @item A | |
2945 | An absolute address | |
2946 | ||
2947 | @item B | |
2948 | An offset address | |
2949 | ||
2950 | @item W | |
2951 | A register indirect memory operand | |
2952 | ||
2953 | @item I | |
2954 | A constant in the range of 0 to 255. | |
2955 | ||
2956 | @item N | |
8ad1dde7 | 2957 | A constant in the range of 0 to @minus{}255. |
cceb575c AG |
2958 | |
2959 | @end table | |
2960 | ||
5e426dd4 PK |
2961 | @item PDP-11---@file{config/pdp11/constraints.md} |
2962 | @table @code | |
2963 | @item a | |
2964 | Floating point registers AC0 through AC3. These can be loaded from/to | |
2965 | memory with a single instruction. | |
2966 | ||
2967 | @item d | |
868e54d1 PK |
2968 | Odd numbered general registers (R1, R3, R5). These are used for |
2969 | 16-bit multiply operations. | |
5e426dd4 PK |
2970 | |
2971 | @item f | |
2972 | Any of the floating point registers (AC0 through AC5). | |
2973 | ||
2974 | @item G | |
2975 | Floating point constant 0. | |
2976 | ||
2977 | @item I | |
2978 | An integer constant that fits in 16 bits. | |
2979 | ||
2980 | @item J | |
2981 | An integer constant whose low order 16 bits are zero. | |
2982 | ||
2983 | @item K | |
2984 | An integer constant that does not meet the constraints for codes | |
2985 | @samp{I} or @samp{J}. | |
2986 | ||
2987 | @item L | |
2988 | The integer constant 1. | |
2989 | ||
2990 | @item M | |
868e54d1 | 2991 | The integer constant @minus{}1. |
5e426dd4 PK |
2992 | |
2993 | @item N | |
2994 | The integer constant 0. | |
2995 | ||
2996 | @item O | |
868e54d1 | 2997 | Integer constants @minus{}4 through @minus{}1 and 1 through 4; shifts by these |
5e426dd4 PK |
2998 | amounts are handled as multiple single-bit shifts rather than a single |
2999 | variable-length shift. | |
3000 | ||
3001 | @item Q | |
3002 | A memory reference which requires an additional word (address or | |
3003 | offset) after the opcode. | |
3004 | ||
3005 | @item R | |
3006 | A memory reference that is encoded within the opcode. | |
3007 | ||
3008 | @end table | |
3009 | ||
85b8555e DD |
3010 | @item RL78---@file{config/rl78/constraints.md} |
3011 | @table @code | |
3012 | ||
3013 | @item Int3 | |
3014 | An integer constant in the range 1 @dots{} 7. | |
3015 | @item Int8 | |
3016 | An integer constant in the range 0 @dots{} 255. | |
3017 | @item J | |
3018 | An integer constant in the range @minus{}255 @dots{} 0 | |
3019 | @item K | |
3020 | The integer constant 1. | |
3021 | @item L | |
3022 | The integer constant -1. | |
3023 | @item M | |
3024 | The integer constant 0. | |
3025 | @item N | |
3026 | The integer constant 2. | |
3027 | @item O | |
3028 | The integer constant -2. | |
3029 | @item P | |
3030 | An integer constant in the range 1 @dots{} 15. | |
3031 | @item Qbi | |
3032 | The built-in compare types--eq, ne, gtu, ltu, geu, and leu. | |
3033 | @item Qsc | |
3034 | The synthetic compare types--gt, lt, ge, and le. | |
3035 | @item Wab | |
3036 | A memory reference with an absolute address. | |
3037 | @item Wbc | |
3038 | A memory reference using @code{BC} as a base register, with an optional offset. | |
3039 | @item Wca | |
3040 | A memory reference using @code{AX}, @code{BC}, @code{DE}, or @code{HL} for the address, for calls. | |
3041 | @item Wcv | |
3042 | A memory reference using any 16-bit register pair for the address, for calls. | |
3043 | @item Wd2 | |
3044 | A memory reference using @code{DE} as a base register, with an optional offset. | |
3045 | @item Wde | |
3046 | A memory reference using @code{DE} as a base register, without any offset. | |
3047 | @item Wfr | |
3048 | Any memory reference to an address in the far address space. | |
3049 | @item Wh1 | |
3050 | A memory reference using @code{HL} as a base register, with an optional one-byte offset. | |
3051 | @item Whb | |
3052 | A memory reference using @code{HL} as a base register, with @code{B} or @code{C} as the index register. | |
3053 | @item Whl | |
3054 | A memory reference using @code{HL} as a base register, without any offset. | |
3055 | @item Ws1 | |
3056 | A memory reference using @code{SP} as a base register, with an optional one-byte offset. | |
3057 | @item Y | |
3058 | Any memory reference to an address in the near address space. | |
3059 | @item A | |
3060 | The @code{AX} register. | |
3061 | @item B | |
3062 | The @code{BC} register. | |
3063 | @item D | |
3064 | The @code{DE} register. | |
3065 | @item R | |
3066 | @code{A} through @code{L} registers. | |
3067 | @item S | |
3068 | The @code{SP} register. | |
3069 | @item T | |
3070 | The @code{HL} register. | |
3071 | @item Z08W | |
3072 | The 16-bit @code{R8} register. | |
3073 | @item Z10W | |
3074 | The 16-bit @code{R10} register. | |
3075 | @item Zint | |
3076 | The registers reserved for interrupts (@code{R24} to @code{R31}). | |
3077 | @item a | |
3078 | The @code{A} register. | |
3079 | @item b | |
3080 | The @code{B} register. | |
3081 | @item c | |
3082 | The @code{C} register. | |
3083 | @item d | |
3084 | The @code{D} register. | |
3085 | @item e | |
3086 | The @code{E} register. | |
3087 | @item h | |
3088 | The @code{H} register. | |
3089 | @item l | |
3090 | The @code{L} register. | |
3091 | @item v | |
3092 | The virtual registers. | |
3093 | @item w | |
3094 | The @code{PSW} register. | |
3095 | @item x | |
3096 | The @code{X} register. | |
3097 | ||
3098 | @end table | |
3099 | ||
65a324b4 NC |
3100 | @item RX---@file{config/rx/constraints.md} |
3101 | @table @code | |
3102 | @item Q | |
3103 | An address which does not involve register indirect addressing or | |
3104 | pre/post increment/decrement addressing. | |
3105 | ||
3106 | @item Symbol | |
3107 | A symbol reference. | |
3108 | ||
3109 | @item Int08 | |
3110 | A constant in the range @minus{}256 to 255, inclusive. | |
3111 | ||
3112 | @item Sint08 | |
3113 | A constant in the range @minus{}128 to 127, inclusive. | |
3114 | ||
3115 | @item Sint16 | |
3116 | A constant in the range @minus{}32768 to 32767, inclusive. | |
3117 | ||
3118 | @item Sint24 | |
3119 | A constant in the range @minus{}8388608 to 8388607, inclusive. | |
3120 | ||
3121 | @item Uint04 | |
3122 | A constant in the range 0 to 15, inclusive. | |
3123 | ||
3124 | @end table | |
3125 | ||
03dda8e3 | 3126 | @need 1000 |
74fe790b | 3127 | @item SPARC---@file{config/sparc/sparc.h} |
03dda8e3 RK |
3128 | @table @code |
3129 | @item f | |
53e5f173 EB |
3130 | Floating-point register on the SPARC-V8 architecture and |
3131 | lower floating-point register on the SPARC-V9 architecture. | |
03dda8e3 RK |
3132 | |
3133 | @item e | |
8a36672b | 3134 | Floating-point register. It is equivalent to @samp{f} on the |
53e5f173 EB |
3135 | SPARC-V8 architecture and contains both lower and upper |
3136 | floating-point registers on the SPARC-V9 architecture. | |
03dda8e3 | 3137 | |
8a69f99f EB |
3138 | @item c |
3139 | Floating-point condition code register. | |
3140 | ||
3141 | @item d | |
8a36672b | 3142 | Lower floating-point register. It is only valid on the SPARC-V9 |
53e5f173 | 3143 | architecture when the Visual Instruction Set is available. |
8a69f99f EB |
3144 | |
3145 | @item b | |
8a36672b | 3146 | Floating-point register. It is only valid on the SPARC-V9 architecture |
53e5f173 | 3147 | when the Visual Instruction Set is available. |
8a69f99f EB |
3148 | |
3149 | @item h | |
3150 | 64-bit global or out register for the SPARC-V8+ architecture. | |
3151 | ||
66e62b49 KH |
3152 | @item D |
3153 | A vector constant | |
3154 | ||
03dda8e3 | 3155 | @item I |
1e5f973d | 3156 | Signed 13-bit constant |
03dda8e3 RK |
3157 | |
3158 | @item J | |
3159 | Zero | |
3160 | ||
3161 | @item K | |
1e5f973d | 3162 | 32-bit constant with the low 12 bits clear (a constant that can be |
03dda8e3 RK |
3163 | loaded with the @code{sethi} instruction) |
3164 | ||
7d6040e8 AO |
3165 | @item L |
3166 | A constant in the range supported by @code{movcc} instructions | |
3167 | ||
3168 | @item M | |
3169 | A constant in the range supported by @code{movrcc} instructions | |
3170 | ||
3171 | @item N | |
3172 | Same as @samp{K}, except that it verifies that bits that are not in the | |
57694e40 | 3173 | lower 32-bit range are all zero. Must be used instead of @samp{K} for |
7d6040e8 AO |
3174 | modes wider than @code{SImode} |
3175 | ||
ef0139b1 EB |
3176 | @item O |
3177 | The constant 4096 | |
3178 | ||
03dda8e3 RK |
3179 | @item G |
3180 | Floating-point zero | |
3181 | ||
3182 | @item H | |
1e5f973d | 3183 | Signed 13-bit constant, sign-extended to 32 or 64 bits |
03dda8e3 RK |
3184 | |
3185 | @item Q | |
62190128 DM |
3186 | Floating-point constant whose integral representation can |
3187 | be moved into an integer register using a single sethi | |
3188 | instruction | |
3189 | ||
3190 | @item R | |
3191 | Floating-point constant whose integral representation can | |
3192 | be moved into an integer register using a single mov | |
3193 | instruction | |
03dda8e3 RK |
3194 | |
3195 | @item S | |
62190128 DM |
3196 | Floating-point constant whose integral representation can |
3197 | be moved into an integer register using a high/lo_sum | |
3198 | instruction sequence | |
03dda8e3 RK |
3199 | |
3200 | @item T | |
3201 | Memory address aligned to an 8-byte boundary | |
3202 | ||
3203 | @item U | |
3204 | Even register | |
6ca30df6 | 3205 | |
7a31a340 | 3206 | @item W |
c75d6010 JM |
3207 | Memory address for @samp{e} constraint registers |
3208 | ||
3209 | @item Y | |
3210 | Vector zero | |
7a31a340 | 3211 | |
6ca30df6 MH |
3212 | @end table |
3213 | ||
85d9c13c TS |
3214 | @item SPU---@file{config/spu/spu.h} |
3215 | @table @code | |
3216 | @item a | |
ff2ce160 | 3217 | An immediate which can be loaded with the il/ila/ilh/ilhu instructions. const_int is treated as a 64 bit value. |
85d9c13c TS |
3218 | |
3219 | @item c | |
ff2ce160 | 3220 | An immediate for and/xor/or instructions. const_int is treated as a 64 bit value. |
85d9c13c TS |
3221 | |
3222 | @item d | |
ff2ce160 | 3223 | An immediate for the @code{iohl} instruction. const_int is treated as a 64 bit value. |
85d9c13c TS |
3224 | |
3225 | @item f | |
ff2ce160 | 3226 | An immediate which can be loaded with @code{fsmbi}. |
85d9c13c TS |
3227 | |
3228 | @item A | |
ff2ce160 | 3229 | An immediate which can be loaded with the il/ila/ilh/ilhu instructions. const_int is treated as a 32 bit value. |
85d9c13c TS |
3230 | |
3231 | @item B | |
ff2ce160 | 3232 | An immediate for most arithmetic instructions. const_int is treated as a 32 bit value. |
85d9c13c TS |
3233 | |
3234 | @item C | |
ff2ce160 | 3235 | An immediate for and/xor/or instructions. const_int is treated as a 32 bit value. |
85d9c13c TS |
3236 | |
3237 | @item D | |
ff2ce160 | 3238 | An immediate for the @code{iohl} instruction. const_int is treated as a 32 bit value. |
85d9c13c TS |
3239 | |
3240 | @item I | |
ff2ce160 | 3241 | A constant in the range [@minus{}64, 63] for shift/rotate instructions. |
85d9c13c TS |
3242 | |
3243 | @item J | |
ff2ce160 | 3244 | An unsigned 7-bit constant for conversion/nop/channel instructions. |
85d9c13c TS |
3245 | |
3246 | @item K | |
ff2ce160 | 3247 | A signed 10-bit constant for most arithmetic instructions. |
85d9c13c TS |
3248 | |
3249 | @item M | |
ff2ce160 | 3250 | A signed 16 bit immediate for @code{stop}. |
85d9c13c TS |
3251 | |
3252 | @item N | |
ff2ce160 | 3253 | An unsigned 16-bit constant for @code{iohl} and @code{fsmbi}. |
85d9c13c TS |
3254 | |
3255 | @item O | |
ff2ce160 | 3256 | An unsigned 7-bit constant whose 3 least significant bits are 0. |
85d9c13c TS |
3257 | |
3258 | @item P | |
ff2ce160 | 3259 | An unsigned 3-bit constant for 16-byte rotates and shifts |
85d9c13c TS |
3260 | |
3261 | @item R | |
ff2ce160 | 3262 | Call operand, reg, for indirect calls |
85d9c13c TS |
3263 | |
3264 | @item S | |
ff2ce160 | 3265 | Call operand, symbol, for relative calls. |
85d9c13c TS |
3266 | |
3267 | @item T | |
ff2ce160 | 3268 | Call operand, const_int, for absolute calls. |
85d9c13c TS |
3269 | |
3270 | @item U | |
ff2ce160 | 3271 | An immediate which can be loaded with the il/ila/ilh/ilhu instructions. const_int is sign extended to 128 bit. |
85d9c13c TS |
3272 | |
3273 | @item W | |
ff2ce160 | 3274 | An immediate for shift and rotate instructions. const_int is treated as a 32 bit value. |
85d9c13c TS |
3275 | |
3276 | @item Y | |
ff2ce160 | 3277 | An immediate for and/xor/or instructions. const_int is sign extended as a 128 bit. |
85d9c13c TS |
3278 | |
3279 | @item Z | |
ff2ce160 | 3280 | An immediate for the @code{iohl} instruction. const_int is sign extended to 128 bit. |
85d9c13c TS |
3281 | |
3282 | @end table | |
3283 | ||
74fe790b | 3284 | @item S/390 and zSeries---@file{config/s390/s390.h} |
91abf72d HP |
3285 | @table @code |
3286 | @item a | |
3287 | Address register (general purpose register except r0) | |
3288 | ||
9dc62c00 AK |
3289 | @item c |
3290 | Condition code register | |
3291 | ||
91abf72d HP |
3292 | @item d |
3293 | Data register (arbitrary general purpose register) | |
3294 | ||
3295 | @item f | |
3296 | Floating-point register | |
3297 | ||
3298 | @item I | |
3299 | Unsigned 8-bit constant (0--255) | |
3300 | ||
3301 | @item J | |
3302 | Unsigned 12-bit constant (0--4095) | |
3303 | ||
3304 | @item K | |
3305 | Signed 16-bit constant (@minus{}32768--32767) | |
3306 | ||
3307 | @item L | |
f19a9af7 AK |
3308 | Value appropriate as displacement. |
3309 | @table @code | |
6ccde948 RW |
3310 | @item (0..4095) |
3311 | for short displacement | |
8ad1dde7 | 3312 | @item (@minus{}524288..524287) |
6ccde948 | 3313 | for long displacement |
f19a9af7 AK |
3314 | @end table |
3315 | ||
3316 | @item M | |
3317 | Constant integer with a value of 0x7fffffff. | |
3318 | ||
3319 | @item N | |
3320 | Multiple letter constraint followed by 4 parameter letters. | |
3321 | @table @code | |
6ccde948 RW |
3322 | @item 0..9: |
3323 | number of the part counting from most to least significant | |
3324 | @item H,Q: | |
3325 | mode of the part | |
3326 | @item D,S,H: | |
3327 | mode of the containing operand | |
3328 | @item 0,F: | |
3329 | value of the other parts (F---all bits set) | |
f19a9af7 AK |
3330 | @end table |
3331 | The constraint matches if the specified part of a constant | |
dc9a511d | 3332 | has a value different from its other parts. |
91abf72d HP |
3333 | |
3334 | @item Q | |
f19a9af7 AK |
3335 | Memory reference without index register and with short displacement. |
3336 | ||
3337 | @item R | |
3338 | Memory reference with index register and short displacement. | |
91abf72d HP |
3339 | |
3340 | @item S | |
f19a9af7 AK |
3341 | Memory reference without index register but with long displacement. |
3342 | ||
3343 | @item T | |
3344 | Memory reference with index register and long displacement. | |
3345 | ||
3346 | @item U | |
3347 | Pointer with short displacement. | |
3348 | ||
3349 | @item W | |
3350 | Pointer with long displacement. | |
3351 | ||
3352 | @item Y | |
3353 | Shift count operand. | |
91abf72d HP |
3354 | |
3355 | @end table | |
3356 | ||
93ef7c1f CL |
3357 | @item Score family---@file{config/score/score.h} |
3358 | @table @code | |
3359 | @item d | |
3360 | Registers from r0 to r32. | |
3361 | ||
3362 | @item e | |
3363 | Registers from r0 to r16. | |
3364 | ||
3365 | @item t | |
3366 | r8---r11 or r22---r27 registers. | |
3367 | ||
3368 | @item h | |
3369 | hi register. | |
3370 | ||
3371 | @item l | |
3372 | lo register. | |
3373 | ||
3374 | @item x | |
3375 | hi + lo register. | |
3376 | ||
3377 | @item q | |
3378 | cnt register. | |
3379 | ||
3380 | @item y | |
3381 | lcb register. | |
3382 | ||
3383 | @item z | |
3384 | scb register. | |
3385 | ||
3386 | @item a | |
3387 | cnt + lcb + scb register. | |
3388 | ||
3389 | @item c | |
3390 | cr0---cr15 register. | |
3391 | ||
3392 | @item b | |
3393 | cp1 registers. | |
3394 | ||
3395 | @item f | |
3396 | cp2 registers. | |
3397 | ||
3398 | @item i | |
3399 | cp3 registers. | |
3400 | ||
3401 | @item j | |
3402 | cp1 + cp2 + cp3 registers. | |
3403 | ||
3404 | @item I | |
c6681463 | 3405 | High 16-bit constant (32-bit constant with 16 LSBs zero). |
93ef7c1f CL |
3406 | |
3407 | @item J | |
3408 | Unsigned 5 bit integer (in the range 0 to 31). | |
3409 | ||
3410 | @item K | |
3411 | Unsigned 16 bit integer (in the range 0 to 65535). | |
3412 | ||
3413 | @item L | |
3414 | Signed 16 bit integer (in the range @minus{}32768 to 32767). | |
3415 | ||
3416 | @item M | |
3417 | Unsigned 14 bit integer (in the range 0 to 16383). | |
3418 | ||
3419 | @item N | |
3420 | Signed 14 bit integer (in the range @minus{}8192 to 8191). | |
3421 | ||
93ef7c1f CL |
3422 | @item Z |
3423 | Any SYMBOL_REF. | |
3424 | @end table | |
3425 | ||
74fe790b | 3426 | @item Xstormy16---@file{config/stormy16/stormy16.h} |
9f339dde GK |
3427 | @table @code |
3428 | @item a | |
3429 | Register r0. | |
3430 | ||
3431 | @item b | |
3432 | Register r1. | |
3433 | ||
3434 | @item c | |
3435 | Register r2. | |
3436 | ||
3437 | @item d | |
3438 | Register r8. | |
3439 | ||
3440 | @item e | |
3441 | Registers r0 through r7. | |
3442 | ||
3443 | @item t | |
3444 | Registers r0 and r1. | |
3445 | ||
3446 | @item y | |
3447 | The carry register. | |
3448 | ||
3449 | @item z | |
3450 | Registers r8 and r9. | |
3451 | ||
3452 | @item I | |
3453 | A constant between 0 and 3 inclusive. | |
3454 | ||
3455 | @item J | |
3456 | A constant that has exactly one bit set. | |
3457 | ||
3458 | @item K | |
3459 | A constant that has exactly one bit clear. | |
3460 | ||
3461 | @item L | |
3462 | A constant between 0 and 255 inclusive. | |
3463 | ||
3464 | @item M | |
69a0611f | 3465 | A constant between @minus{}255 and 0 inclusive. |
9f339dde GK |
3466 | |
3467 | @item N | |
69a0611f | 3468 | A constant between @minus{}3 and 0 inclusive. |
9f339dde GK |
3469 | |
3470 | @item O | |
3471 | A constant between 1 and 4 inclusive. | |
3472 | ||
3473 | @item P | |
69a0611f | 3474 | A constant between @minus{}4 and @minus{}1 inclusive. |
9f339dde GK |
3475 | |
3476 | @item Q | |
3477 | A memory reference that is a stack push. | |
3478 | ||
3479 | @item R | |
3480 | A memory reference that is a stack pop. | |
3481 | ||
3482 | @item S | |
63519d23 | 3483 | A memory reference that refers to a constant address of known value. |
9f339dde GK |
3484 | |
3485 | @item T | |
3486 | The register indicated by Rx (not implemented yet). | |
3487 | ||
3488 | @item U | |
3489 | A constant that is not between 2 and 15 inclusive. | |
3490 | ||
e2ce66a9 DD |
3491 | @item Z |
3492 | The constant 0. | |
3493 | ||
9f339dde GK |
3494 | @end table |
3495 | ||
bcead286 BS |
3496 | @item TI C6X family---@file{config/c6x/constraints.md} |
3497 | @table @code | |
3498 | @item a | |
3499 | Register file A (A0--A31). | |
3500 | ||
3501 | @item b | |
3502 | Register file B (B0--B31). | |
3503 | ||
3504 | @item A | |
3505 | Predicate registers in register file A (A0--A2 on C64X and | |
3506 | higher, A1 and A2 otherwise). | |
3507 | ||
3508 | @item B | |
3509 | Predicate registers in register file B (B0--B2). | |
3510 | ||
3511 | @item C | |
3512 | A call-used register in register file B (B0--B9, B16--B31). | |
3513 | ||
3514 | @item Da | |
3515 | Register file A, excluding predicate registers (A3--A31, | |
3516 | plus A0 if not C64X or higher). | |
3517 | ||
3518 | @item Db | |
3519 | Register file B, excluding predicate registers (B3--B31). | |
3520 | ||
3521 | @item Iu4 | |
3522 | Integer constant in the range 0 @dots{} 15. | |
3523 | ||
3524 | @item Iu5 | |
3525 | Integer constant in the range 0 @dots{} 31. | |
3526 | ||
3527 | @item In5 | |
3528 | Integer constant in the range @minus{}31 @dots{} 0. | |
3529 | ||
3530 | @item Is5 | |
3531 | Integer constant in the range @minus{}16 @dots{} 15. | |
3532 | ||
3533 | @item I5x | |
3534 | Integer constant that can be the operand of an ADDA or a SUBA insn. | |
3535 | ||
3536 | @item IuB | |
3537 | Integer constant in the range 0 @dots{} 65535. | |
3538 | ||
3539 | @item IsB | |
3540 | Integer constant in the range @minus{}32768 @dots{} 32767. | |
3541 | ||
3542 | @item IsC | |
3543 | Integer constant in the range @math{-2^{20}} @dots{} @math{2^{20} - 1}. | |
3544 | ||
3545 | @item Jc | |
3546 | Integer constant that is a valid mask for the clr instruction. | |
3547 | ||
3548 | @item Js | |
3549 | Integer constant that is a valid mask for the set instruction. | |
3550 | ||
3551 | @item Q | |
3552 | Memory location with A base register. | |
3553 | ||
3554 | @item R | |
3555 | Memory location with B base register. | |
3556 | ||
3557 | @ifset INTERNALS | |
3558 | @item S0 | |
3559 | On C64x+ targets, a GP-relative small data reference. | |
3560 | ||
3561 | @item S1 | |
3562 | Any kind of @code{SYMBOL_REF}, for use in a call address. | |
3563 | ||
3564 | @item Si | |
3565 | Any kind of immediate operand, unless it matches the S0 constraint. | |
3566 | ||
3567 | @item T | |
3568 | Memory location with B base register, but not using a long offset. | |
3569 | ||
3570 | @item W | |
3571 | A memory operand with an address that can't be used in an unaligned access. | |
3572 | ||
3573 | @end ifset | |
3574 | @item Z | |
3575 | Register B14 (aka DP). | |
3576 | ||
3577 | @end table | |
3578 | ||
dd552284 WL |
3579 | @item TILE-Gx---@file{config/tilegx/constraints.md} |
3580 | @table @code | |
3581 | @item R00 | |
3582 | @itemx R01 | |
3583 | @itemx R02 | |
3584 | @itemx R03 | |
3585 | @itemx R04 | |
3586 | @itemx R05 | |
3587 | @itemx R06 | |
3588 | @itemx R07 | |
3589 | @itemx R08 | |
3590 | @itemx R09 | |
3591 | @itemx R010 | |
3592 | Each of these represents a register constraint for an individual | |
3593 | register, from r0 to r10. | |
3594 | ||
3595 | @item I | |
3596 | Signed 8-bit integer constant. | |
3597 | ||
3598 | @item J | |
3599 | Signed 16-bit integer constant. | |
3600 | ||
3601 | @item K | |
3602 | Unsigned 16-bit integer constant. | |
3603 | ||
3604 | @item L | |
3605 | Integer constant that fits in one signed byte when incremented by one | |
3606 | (@minus{}129 @dots{} 126). | |
3607 | ||
3608 | @item m | |
3609 | Memory operand. If used together with @samp{<} or @samp{>}, the | |
3610 | operand can have postincrement which requires printing with @samp{%In} | |
3611 | and @samp{%in} on TILE-Gx. For example: | |
3612 | ||
3613 | @smallexample | |
3614 | asm ("st_add %I0,%1,%i0" : "=m<>" (*mem) : "r" (val)); | |
3615 | @end smallexample | |
3616 | ||
3617 | @item M | |
3618 | A bit mask suitable for the BFINS instruction. | |
3619 | ||
3620 | @item N | |
3621 | Integer constant that is a byte tiled out eight times. | |
3622 | ||
3623 | @item O | |
3624 | The integer zero constant. | |
3625 | ||
3626 | @item P | |
3627 | Integer constant that is a sign-extended byte tiled out as four shorts. | |
3628 | ||
3629 | @item Q | |
3630 | Integer constant that fits in one signed byte when incremented | |
3631 | (@minus{}129 @dots{} 126), but excluding -1. | |
3632 | ||
3633 | @item S | |
3634 | Integer constant that has all 1 bits consecutive and starting at bit 0. | |
3635 | ||
3636 | @item T | |
3637 | A 16-bit fragment of a got, tls, or pc-relative reference. | |
3638 | ||
3639 | @item U | |
3640 | Memory operand except postincrement. This is roughly the same as | |
3641 | @samp{m} when not used together with @samp{<} or @samp{>}. | |
3642 | ||
3643 | @item W | |
3644 | An 8-element vector constant with identical elements. | |
3645 | ||
3646 | @item Y | |
3647 | A 4-element vector constant with identical elements. | |
3648 | ||
3649 | @item Z0 | |
3650 | The integer constant 0xffffffff. | |
3651 | ||
3652 | @item Z1 | |
3653 | The integer constant 0xffffffff00000000. | |
3654 | ||
3655 | @end table | |
3656 | ||
3657 | @item TILEPro---@file{config/tilepro/constraints.md} | |
3658 | @table @code | |
3659 | @item R00 | |
3660 | @itemx R01 | |
3661 | @itemx R02 | |
3662 | @itemx R03 | |
3663 | @itemx R04 | |
3664 | @itemx R05 | |
3665 | @itemx R06 | |
3666 | @itemx R07 | |
3667 | @itemx R08 | |
3668 | @itemx R09 | |
3669 | @itemx R010 | |
3670 | Each of these represents a register constraint for an individual | |
3671 | register, from r0 to r10. | |
3672 | ||
3673 | @item I | |
3674 | Signed 8-bit integer constant. | |
3675 | ||
3676 | @item J | |
3677 | Signed 16-bit integer constant. | |
3678 | ||
3679 | @item K | |
3680 | Nonzero integer constant with low 16 bits zero. | |
3681 | ||
3682 | @item L | |
3683 | Integer constant that fits in one signed byte when incremented by one | |
3684 | (@minus{}129 @dots{} 126). | |
3685 | ||
3686 | @item m | |
3687 | Memory operand. If used together with @samp{<} or @samp{>}, the | |
3688 | operand can have postincrement which requires printing with @samp{%In} | |
3689 | and @samp{%in} on TILEPro. For example: | |
3690 | ||
3691 | @smallexample | |
3692 | asm ("swadd %I0,%1,%i0" : "=m<>" (mem) : "r" (val)); | |
3693 | @end smallexample | |
3694 | ||
3695 | @item M | |
3696 | A bit mask suitable for the MM instruction. | |
3697 | ||
3698 | @item N | |
3699 | Integer constant that is a byte tiled out four times. | |
3700 | ||
3701 | @item O | |
3702 | The integer zero constant. | |
3703 | ||
3704 | @item P | |
3705 | Integer constant that is a sign-extended byte tiled out as two shorts. | |
3706 | ||
3707 | @item Q | |
3708 | Integer constant that fits in one signed byte when incremented | |
3709 | (@minus{}129 @dots{} 126), but excluding -1. | |
3710 | ||
3711 | @item T | |
3712 | A symbolic operand, or a 16-bit fragment of a got, tls, or pc-relative | |
3713 | reference. | |
3714 | ||
3715 | @item U | |
3716 | Memory operand except postincrement. This is roughly the same as | |
3717 | @samp{m} when not used together with @samp{<} or @samp{>}. | |
3718 | ||
3719 | @item W | |
3720 | A 4-element vector constant with identical elements. | |
3721 | ||
3722 | @item Y | |
3723 | A 2-element vector constant with identical elements. | |
3724 | ||
3725 | @end table | |
3726 | ||
887af464 | 3727 | @item Xtensa---@file{config/xtensa/constraints.md} |
03984308 BW |
3728 | @table @code |
3729 | @item a | |
3730 | General-purpose 32-bit register | |
3731 | ||
3732 | @item b | |
3733 | One-bit boolean register | |
3734 | ||
3735 | @item A | |
3736 | MAC16 40-bit accumulator register | |
3737 | ||
3738 | @item I | |
3739 | Signed 12-bit integer constant, for use in MOVI instructions | |
3740 | ||
3741 | @item J | |
3742 | Signed 8-bit integer constant, for use in ADDI instructions | |
3743 | ||
3744 | @item K | |
3745 | Integer constant valid for BccI instructions | |
3746 | ||
3747 | @item L | |
3748 | Unsigned constant valid for BccUI instructions | |
3749 | ||
3750 | @end table | |
3751 | ||
03dda8e3 RK |
3752 | @end table |
3753 | ||
7ac28727 AK |
3754 | @ifset INTERNALS |
3755 | @node Disable Insn Alternatives | |
3756 | @subsection Disable insn alternatives using the @code{enabled} attribute | |
3757 | @cindex enabled | |
3758 | ||
3759 | The @code{enabled} insn attribute may be used to disable certain insn | |
3760 | alternatives for machine-specific reasons. This is useful when adding | |
3761 | new instructions to an existing pattern which are only available for | |
3762 | certain cpu architecture levels as specified with the @code{-march=} | |
3763 | option. | |
3764 | ||
3765 | If an insn alternative is disabled, then it will never be used. The | |
3766 | compiler treats the constraints for the disabled alternative as | |
3767 | unsatisfiable. | |
3768 | ||
3769 | In order to make use of the @code{enabled} attribute a back end has to add | |
3770 | in the machine description files: | |
3771 | ||
3772 | @enumerate | |
3773 | @item | |
3774 | A definition of the @code{enabled} insn attribute. The attribute is | |
3775 | defined as usual using the @code{define_attr} command. This | |
3776 | definition should be based on other insn attributes and/or target flags. | |
3777 | The @code{enabled} attribute is a numeric attribute and should evaluate to | |
3778 | @code{(const_int 1)} for an enabled alternative and to | |
3779 | @code{(const_int 0)} otherwise. | |
3780 | @item | |
3781 | A definition of another insn attribute used to describe for what | |
3782 | reason an insn alternative might be available or | |
3783 | not. E.g. @code{cpu_facility} as in the example below. | |
3784 | @item | |
a640c13b | 3785 | An assignment for the second attribute to each insn definition |
7ac28727 AK |
3786 | combining instructions which are not all available under the same |
3787 | circumstances. (Note: It obviously only makes sense for definitions | |
3788 | with more than one alternative. Otherwise the insn pattern should be | |
3789 | disabled or enabled using the insn condition.) | |
3790 | @end enumerate | |
3791 | ||
3792 | E.g. the following two patterns could easily be merged using the @code{enabled} | |
3793 | attribute: | |
3794 | ||
3795 | @smallexample | |
3796 | ||
3797 | (define_insn "*movdi_old" | |
3798 | [(set (match_operand:DI 0 "register_operand" "=d") | |
3799 | (match_operand:DI 1 "register_operand" " d"))] | |
3800 | "!TARGET_NEW" | |
3801 | "lgr %0,%1") | |
3802 | ||
3803 | (define_insn "*movdi_new" | |
3804 | [(set (match_operand:DI 0 "register_operand" "=d,f,d") | |
3805 | (match_operand:DI 1 "register_operand" " d,d,f"))] | |
3806 | "TARGET_NEW" | |
3807 | "@@ | |
3808 | lgr %0,%1 | |
3809 | ldgr %0,%1 | |
3810 | lgdr %0,%1") | |
3811 | ||
3812 | @end smallexample | |
3813 | ||
3814 | to: | |
3815 | ||
3816 | @smallexample | |
3817 | ||
3818 | (define_insn "*movdi_combined" | |
3819 | [(set (match_operand:DI 0 "register_operand" "=d,f,d") | |
3820 | (match_operand:DI 1 "register_operand" " d,d,f"))] | |
3821 | "" | |
3822 | "@@ | |
3823 | lgr %0,%1 | |
3824 | ldgr %0,%1 | |
3825 | lgdr %0,%1" | |
3826 | [(set_attr "cpu_facility" "*,new,new")]) | |
3827 | ||
3828 | @end smallexample | |
3829 | ||
3830 | with the @code{enabled} attribute defined like this: | |
3831 | ||
3832 | @smallexample | |
3833 | ||
3834 | (define_attr "cpu_facility" "standard,new" (const_string "standard")) | |
3835 | ||
3836 | (define_attr "enabled" "" | |
3837 | (cond [(eq_attr "cpu_facility" "standard") (const_int 1) | |
3838 | (and (eq_attr "cpu_facility" "new") | |
3839 | (ne (symbol_ref "TARGET_NEW") (const_int 0))) | |
3840 | (const_int 1)] | |
3841 | (const_int 0))) | |
3842 | ||
3843 | @end smallexample | |
3844 | ||
3845 | @end ifset | |
3846 | ||
03dda8e3 | 3847 | @ifset INTERNALS |
f38840db ZW |
3848 | @node Define Constraints |
3849 | @subsection Defining Machine-Specific Constraints | |
3850 | @cindex defining constraints | |
3851 | @cindex constraints, defining | |
3852 | ||
3853 | Machine-specific constraints fall into two categories: register and | |
3854 | non-register constraints. Within the latter category, constraints | |
3855 | which allow subsets of all possible memory or address operands should | |
3856 | be specially marked, to give @code{reload} more information. | |
3857 | ||
3858 | Machine-specific constraints can be given names of arbitrary length, | |
3859 | but they must be entirely composed of letters, digits, underscores | |
3860 | (@samp{_}), and angle brackets (@samp{< >}). Like C identifiers, they | |
ff2ce160 | 3861 | must begin with a letter or underscore. |
f38840db ZW |
3862 | |
3863 | In order to avoid ambiguity in operand constraint strings, no | |
3864 | constraint can have a name that begins with any other constraint's | |
3865 | name. For example, if @code{x} is defined as a constraint name, | |
3866 | @code{xy} may not be, and vice versa. As a consequence of this rule, | |
3867 | no constraint may begin with one of the generic constraint letters: | |
3868 | @samp{E F V X g i m n o p r s}. | |
3869 | ||
3870 | Register constraints correspond directly to register classes. | |
3871 | @xref{Register Classes}. There is thus not much flexibility in their | |
3872 | definitions. | |
3873 | ||
3874 | @deffn {MD Expression} define_register_constraint name regclass docstring | |
3875 | All three arguments are string constants. | |
3876 | @var{name} is the name of the constraint, as it will appear in | |
5be527d0 RG |
3877 | @code{match_operand} expressions. If @var{name} is a multi-letter |
3878 | constraint its length shall be the same for all constraints starting | |
3879 | with the same letter. @var{regclass} can be either the | |
f38840db ZW |
3880 | name of the corresponding register class (@pxref{Register Classes}), |
3881 | or a C expression which evaluates to the appropriate register class. | |
3882 | If it is an expression, it must have no side effects, and it cannot | |
3883 | look at the operand. The usual use of expressions is to map some | |
3884 | register constraints to @code{NO_REGS} when the register class | |
3885 | is not available on a given subarchitecture. | |
3886 | ||
3887 | @var{docstring} is a sentence documenting the meaning of the | |
3888 | constraint. Docstrings are explained further below. | |
3889 | @end deffn | |
3890 | ||
3891 | Non-register constraints are more like predicates: the constraint | |
3892 | definition gives a Boolean expression which indicates whether the | |
3893 | constraint matches. | |
3894 | ||
3895 | @deffn {MD Expression} define_constraint name docstring exp | |
3896 | The @var{name} and @var{docstring} arguments are the same as for | |
3897 | @code{define_register_constraint}, but note that the docstring comes | |
3898 | immediately after the name for these expressions. @var{exp} is an RTL | |
3899 | expression, obeying the same rules as the RTL expressions in predicate | |
3900 | definitions. @xref{Defining Predicates}, for details. If it | |
3901 | evaluates true, the constraint matches; if it evaluates false, it | |
3902 | doesn't. Constraint expressions should indicate which RTL codes they | |
3903 | might match, just like predicate expressions. | |
3904 | ||
3905 | @code{match_test} C expressions have access to the | |
3906 | following variables: | |
3907 | ||
3908 | @table @var | |
3909 | @item op | |
3910 | The RTL object defining the operand. | |
3911 | @item mode | |
3912 | The machine mode of @var{op}. | |
3913 | @item ival | |
3914 | @samp{INTVAL (@var{op})}, if @var{op} is a @code{const_int}. | |
3915 | @item hval | |
3916 | @samp{CONST_DOUBLE_HIGH (@var{op})}, if @var{op} is an integer | |
3917 | @code{const_double}. | |
3918 | @item lval | |
3919 | @samp{CONST_DOUBLE_LOW (@var{op})}, if @var{op} is an integer | |
3920 | @code{const_double}. | |
3921 | @item rval | |
3922 | @samp{CONST_DOUBLE_REAL_VALUE (@var{op})}, if @var{op} is a floating-point | |
3fa1b0e5 | 3923 | @code{const_double}. |
f38840db ZW |
3924 | @end table |
3925 | ||
3926 | The @var{*val} variables should only be used once another piece of the | |
3927 | expression has verified that @var{op} is the appropriate kind of RTL | |
3928 | object. | |
3929 | @end deffn | |
3930 | ||
3931 | Most non-register constraints should be defined with | |
3932 | @code{define_constraint}. The remaining two definition expressions | |
3933 | are only appropriate for constraints that should be handled specially | |
3934 | by @code{reload} if they fail to match. | |
3935 | ||
3936 | @deffn {MD Expression} define_memory_constraint name docstring exp | |
3937 | Use this expression for constraints that match a subset of all memory | |
3938 | operands: that is, @code{reload} can make them match by converting the | |
3939 | operand to the form @samp{@w{(mem (reg @var{X}))}}, where @var{X} is a | |
3940 | base register (from the register class specified by | |
3941 | @code{BASE_REG_CLASS}, @pxref{Register Classes}). | |
3942 | ||
3943 | For example, on the S/390, some instructions do not accept arbitrary | |
3944 | memory references, but only those that do not make use of an index | |
3945 | register. The constraint letter @samp{Q} is defined to represent a | |
3946 | memory address of this type. If @samp{Q} is defined with | |
3947 | @code{define_memory_constraint}, a @samp{Q} constraint can handle any | |
3948 | memory operand, because @code{reload} knows it can simply copy the | |
3949 | memory address into a base register if required. This is analogous to | |
e4ae5e77 | 3950 | the way an @samp{o} constraint can handle any memory operand. |
f38840db ZW |
3951 | |
3952 | The syntax and semantics are otherwise identical to | |
3953 | @code{define_constraint}. | |
3954 | @end deffn | |
3955 | ||
3956 | @deffn {MD Expression} define_address_constraint name docstring exp | |
3957 | Use this expression for constraints that match a subset of all address | |
3958 | operands: that is, @code{reload} can make the constraint match by | |
3959 | converting the operand to the form @samp{@w{(reg @var{X})}}, again | |
3960 | with @var{X} a base register. | |
3961 | ||
3962 | Constraints defined with @code{define_address_constraint} can only be | |
3963 | used with the @code{address_operand} predicate, or machine-specific | |
3964 | predicates that work the same way. They are treated analogously to | |
3965 | the generic @samp{p} constraint. | |
3966 | ||
3967 | The syntax and semantics are otherwise identical to | |
3968 | @code{define_constraint}. | |
3969 | @end deffn | |
3970 | ||
3971 | For historical reasons, names beginning with the letters @samp{G H} | |
3972 | are reserved for constraints that match only @code{const_double}s, and | |
3973 | names beginning with the letters @samp{I J K L M N O P} are reserved | |
3974 | for constraints that match only @code{const_int}s. This may change in | |
3975 | the future. For the time being, constraints with these names must be | |
3976 | written in a stylized form, so that @code{genpreds} can tell you did | |
3977 | it correctly: | |
3978 | ||
3979 | @smallexample | |
3980 | @group | |
3981 | (define_constraint "[@var{GHIJKLMNOP}]@dots{}" | |
3982 | "@var{doc}@dots{}" | |
3983 | (and (match_code "const_int") ; @r{@code{const_double} for G/H} | |
3984 | @var{condition}@dots{})) ; @r{usually a @code{match_test}} | |
3985 | @end group | |
3986 | @end smallexample | |
3987 | @c the semicolons line up in the formatted manual | |
3988 | ||
3989 | It is fine to use names beginning with other letters for constraints | |
3990 | that match @code{const_double}s or @code{const_int}s. | |
3991 | ||
3992 | Each docstring in a constraint definition should be one or more complete | |
3993 | sentences, marked up in Texinfo format. @emph{They are currently unused.} | |
3994 | In the future they will be copied into the GCC manual, in @ref{Machine | |
3995 | Constraints}, replacing the hand-maintained tables currently found in | |
3996 | that section. Also, in the future the compiler may use this to give | |
3997 | more helpful diagnostics when poor choice of @code{asm} constraints | |
3998 | causes a reload failure. | |
3999 | ||
4000 | If you put the pseudo-Texinfo directive @samp{@@internal} at the | |
4001 | beginning of a docstring, then (in the future) it will appear only in | |
4002 | the internals manual's version of the machine-specific constraint tables. | |
4003 | Use this for constraints that should not appear in @code{asm} statements. | |
4004 | ||
4005 | @node C Constraint Interface | |
4006 | @subsection Testing constraints from C | |
4007 | @cindex testing constraints | |
4008 | @cindex constraints, testing | |
4009 | ||
4010 | It is occasionally useful to test a constraint from C code rather than | |
4011 | implicitly via the constraint string in a @code{match_operand}. The | |
4012 | generated file @file{tm_p.h} declares a few interfaces for working | |
4013 | with machine-specific constraints. None of these interfaces work with | |
4014 | the generic constraints described in @ref{Simple Constraints}. This | |
4015 | may change in the future. | |
4016 | ||
4017 | @strong{Warning:} @file{tm_p.h} may declare other functions that | |
4018 | operate on constraints, besides the ones documented here. Do not use | |
4019 | those functions from machine-dependent code. They exist to implement | |
4020 | the old constraint interface that machine-independent components of | |
4021 | the compiler still expect. They will change or disappear in the | |
4022 | future. | |
4023 | ||
4024 | Some valid constraint names are not valid C identifiers, so there is a | |
4025 | mangling scheme for referring to them from C@. Constraint names that | |
4026 | do not contain angle brackets or underscores are left unchanged. | |
4027 | Underscores are doubled, each @samp{<} is replaced with @samp{_l}, and | |
4028 | each @samp{>} with @samp{_g}. Here are some examples: | |
4029 | ||
4030 | @c the @c's prevent double blank lines in the printed manual. | |
4031 | @example | |
4032 | @multitable {Original} {Mangled} | |
cccb0908 | 4033 | @item @strong{Original} @tab @strong{Mangled} @c |
f38840db ZW |
4034 | @item @code{x} @tab @code{x} @c |
4035 | @item @code{P42x} @tab @code{P42x} @c | |
4036 | @item @code{P4_x} @tab @code{P4__x} @c | |
4037 | @item @code{P4>x} @tab @code{P4_gx} @c | |
4038 | @item @code{P4>>} @tab @code{P4_g_g} @c | |
4039 | @item @code{P4_g>} @tab @code{P4__g_g} @c | |
4040 | @end multitable | |
4041 | @end example | |
4042 | ||
4043 | Throughout this section, the variable @var{c} is either a constraint | |
4044 | in the abstract sense, or a constant from @code{enum constraint_num}; | |
4045 | the variable @var{m} is a mangled constraint name (usually as part of | |
4046 | a larger identifier). | |
4047 | ||
4048 | @deftp Enum constraint_num | |
4049 | For each machine-specific constraint, there is a corresponding | |
4050 | enumeration constant: @samp{CONSTRAINT_} plus the mangled name of the | |
4051 | constraint. Functions that take an @code{enum constraint_num} as an | |
4052 | argument expect one of these constants. | |
4053 | ||
4054 | Machine-independent constraints do not have associated constants. | |
4055 | This may change in the future. | |
4056 | @end deftp | |
4057 | ||
4058 | @deftypefun {inline bool} satisfies_constraint_@var{m} (rtx @var{exp}) | |
4059 | For each machine-specific, non-register constraint @var{m}, there is | |
4060 | one of these functions; it returns @code{true} if @var{exp} satisfies the | |
4061 | constraint. These functions are only visible if @file{rtl.h} was included | |
4062 | before @file{tm_p.h}. | |
4063 | @end deftypefun | |
4064 | ||
4065 | @deftypefun bool constraint_satisfied_p (rtx @var{exp}, enum constraint_num @var{c}) | |
4066 | Like the @code{satisfies_constraint_@var{m}} functions, but the | |
4067 | constraint to test is given as an argument, @var{c}. If @var{c} | |
4068 | specifies a register constraint, this function will always return | |
4069 | @code{false}. | |
4070 | @end deftypefun | |
4071 | ||
4072 | @deftypefun {enum reg_class} regclass_for_constraint (enum constraint_num @var{c}) | |
4073 | Returns the register class associated with @var{c}. If @var{c} is not | |
4074 | a register constraint, or those registers are not available for the | |
4075 | currently selected subtarget, returns @code{NO_REGS}. | |
4076 | @end deftypefun | |
4077 | ||
4078 | Here is an example use of @code{satisfies_constraint_@var{m}}. In | |
4079 | peephole optimizations (@pxref{Peephole Definitions}), operand | |
4080 | constraint strings are ignored, so if there are relevant constraints, | |
4081 | they must be tested in the C condition. In the example, the | |
4082 | optimization is applied if operand 2 does @emph{not} satisfy the | |
4083 | @samp{K} constraint. (This is a simplified version of a peephole | |
4084 | definition from the i386 machine description.) | |
4085 | ||
4086 | @smallexample | |
4087 | (define_peephole2 | |
4088 | [(match_scratch:SI 3 "r") | |
4089 | (set (match_operand:SI 0 "register_operand" "") | |
6ccde948 RW |
4090 | (mult:SI (match_operand:SI 1 "memory_operand" "") |
4091 | (match_operand:SI 2 "immediate_operand" "")))] | |
f38840db ZW |
4092 | |
4093 | "!satisfies_constraint_K (operands[2])" | |
4094 | ||
4095 | [(set (match_dup 3) (match_dup 1)) | |
4096 | (set (match_dup 0) (mult:SI (match_dup 3) (match_dup 2)))] | |
4097 | ||
4098 | "") | |
4099 | @end smallexample | |
4100 | ||
03dda8e3 RK |
4101 | @node Standard Names |
4102 | @section Standard Pattern Names For Generation | |
4103 | @cindex standard pattern names | |
4104 | @cindex pattern names | |
4105 | @cindex names, pattern | |
4106 | ||
4107 | Here is a table of the instruction names that are meaningful in the RTL | |
4108 | generation pass of the compiler. Giving one of these names to an | |
4109 | instruction pattern tells the RTL generation pass that it can use the | |
556e0f21 | 4110 | pattern to accomplish a certain task. |
03dda8e3 RK |
4111 | |
4112 | @table @asis | |
4113 | @cindex @code{mov@var{m}} instruction pattern | |
4114 | @item @samp{mov@var{m}} | |
4bd0bee9 | 4115 | Here @var{m} stands for a two-letter machine mode name, in lowercase. |
03dda8e3 RK |
4116 | This instruction pattern moves data with that machine mode from operand |
4117 | 1 to operand 0. For example, @samp{movsi} moves full-word data. | |
4118 | ||
4119 | If operand 0 is a @code{subreg} with mode @var{m} of a register whose | |
4120 | own mode is wider than @var{m}, the effect of this instruction is | |
4121 | to store the specified value in the part of the register that corresponds | |
8feb4e28 JL |
4122 | to mode @var{m}. Bits outside of @var{m}, but which are within the |
4123 | same target word as the @code{subreg} are undefined. Bits which are | |
4124 | outside the target word are left unchanged. | |
03dda8e3 RK |
4125 | |
4126 | This class of patterns is special in several ways. First of all, each | |
65945ec1 HPN |
4127 | of these names up to and including full word size @emph{must} be defined, |
4128 | because there is no other way to copy a datum from one place to another. | |
4129 | If there are patterns accepting operands in larger modes, | |
4130 | @samp{mov@var{m}} must be defined for integer modes of those sizes. | |
03dda8e3 RK |
4131 | |
4132 | Second, these patterns are not used solely in the RTL generation pass. | |
4133 | Even the reload pass can generate move insns to copy values from stack | |
4134 | slots into temporary registers. When it does so, one of the operands is | |
4135 | a hard register and the other is an operand that can need to be reloaded | |
4136 | into a register. | |
4137 | ||
4138 | @findex force_reg | |
4139 | Therefore, when given such a pair of operands, the pattern must generate | |
4140 | RTL which needs no reloading and needs no temporary registers---no | |
4141 | registers other than the operands. For example, if you support the | |
4142 | pattern with a @code{define_expand}, then in such a case the | |
4143 | @code{define_expand} mustn't call @code{force_reg} or any other such | |
4144 | function which might generate new pseudo registers. | |
4145 | ||
4146 | This requirement exists even for subword modes on a RISC machine where | |
4147 | fetching those modes from memory normally requires several insns and | |
39ed8974 | 4148 | some temporary registers. |
03dda8e3 RK |
4149 | |
4150 | @findex change_address | |
4151 | During reload a memory reference with an invalid address may be passed | |
4152 | as an operand. Such an address will be replaced with a valid address | |
4153 | later in the reload pass. In this case, nothing may be done with the | |
4154 | address except to use it as it stands. If it is copied, it will not be | |
4155 | replaced with a valid address. No attempt should be made to make such | |
4156 | an address into a valid address and no routine (such as | |
4157 | @code{change_address}) that will do so may be called. Note that | |
4158 | @code{general_operand} will fail when applied to such an address. | |
4159 | ||
4160 | @findex reload_in_progress | |
4161 | The global variable @code{reload_in_progress} (which must be explicitly | |
4162 | declared if required) can be used to determine whether such special | |
4163 | handling is required. | |
4164 | ||
4165 | The variety of operands that have reloads depends on the rest of the | |
4166 | machine description, but typically on a RISC machine these can only be | |
4167 | pseudo registers that did not get hard registers, while on other | |
4168 | machines explicit memory references will get optional reloads. | |
4169 | ||
4170 | If a scratch register is required to move an object to or from memory, | |
f1db3576 JL |
4171 | it can be allocated using @code{gen_reg_rtx} prior to life analysis. |
4172 | ||
9c34dbbf | 4173 | If there are cases which need scratch registers during or after reload, |
8a99f6f9 | 4174 | you must provide an appropriate secondary_reload target hook. |
03dda8e3 | 4175 | |
ef4375b2 KZ |
4176 | @findex can_create_pseudo_p |
4177 | The macro @code{can_create_pseudo_p} can be used to determine if it | |
f1db3576 JL |
4178 | is unsafe to create new pseudo registers. If this variable is nonzero, then |
4179 | it is unsafe to call @code{gen_reg_rtx} to allocate a new pseudo. | |
4180 | ||
956d6950 | 4181 | The constraints on a @samp{mov@var{m}} must permit moving any hard |
03dda8e3 RK |
4182 | register to any other hard register provided that |
4183 | @code{HARD_REGNO_MODE_OK} permits mode @var{m} in both registers and | |
de8f4b07 AS |
4184 | @code{TARGET_REGISTER_MOVE_COST} applied to their classes returns a value |
4185 | of 2. | |
03dda8e3 | 4186 | |
956d6950 | 4187 | It is obligatory to support floating point @samp{mov@var{m}} |
03dda8e3 RK |
4188 | instructions into and out of any registers that can hold fixed point |
4189 | values, because unions and structures (which have modes @code{SImode} or | |
4190 | @code{DImode}) can be in those registers and they may have floating | |
4191 | point members. | |
4192 | ||
956d6950 | 4193 | There may also be a need to support fixed point @samp{mov@var{m}} |
03dda8e3 RK |
4194 | instructions in and out of floating point registers. Unfortunately, I |
4195 | have forgotten why this was so, and I don't know whether it is still | |
4196 | true. If @code{HARD_REGNO_MODE_OK} rejects fixed point values in | |
4197 | floating point registers, then the constraints of the fixed point | |
956d6950 | 4198 | @samp{mov@var{m}} instructions must be designed to avoid ever trying to |
03dda8e3 RK |
4199 | reload into a floating point register. |
4200 | ||
4201 | @cindex @code{reload_in} instruction pattern | |
4202 | @cindex @code{reload_out} instruction pattern | |
4203 | @item @samp{reload_in@var{m}} | |
4204 | @itemx @samp{reload_out@var{m}} | |
8a99f6f9 R |
4205 | These named patterns have been obsoleted by the target hook |
4206 | @code{secondary_reload}. | |
4207 | ||
03dda8e3 RK |
4208 | Like @samp{mov@var{m}}, but used when a scratch register is required to |
4209 | move between operand 0 and operand 1. Operand 2 describes the scratch | |
4210 | register. See the discussion of the @code{SECONDARY_RELOAD_CLASS} | |
4211 | macro in @pxref{Register Classes}. | |
4212 | ||
d989f648 | 4213 | There are special restrictions on the form of the @code{match_operand}s |
f282ffb3 | 4214 | used in these patterns. First, only the predicate for the reload |
560dbedd RH |
4215 | operand is examined, i.e., @code{reload_in} examines operand 1, but not |
4216 | the predicates for operand 0 or 2. Second, there may be only one | |
d989f648 RH |
4217 | alternative in the constraints. Third, only a single register class |
4218 | letter may be used for the constraint; subsequent constraint letters | |
4219 | are ignored. As a special exception, an empty constraint string | |
4220 | matches the @code{ALL_REGS} register class. This may relieve ports | |
4221 | of the burden of defining an @code{ALL_REGS} constraint letter just | |
4222 | for these patterns. | |
4223 | ||
03dda8e3 RK |
4224 | @cindex @code{movstrict@var{m}} instruction pattern |
4225 | @item @samp{movstrict@var{m}} | |
4226 | Like @samp{mov@var{m}} except that if operand 0 is a @code{subreg} | |
4227 | with mode @var{m} of a register whose natural mode is wider, | |
4228 | the @samp{movstrict@var{m}} instruction is guaranteed not to alter | |
4229 | any of the register except the part which belongs to mode @var{m}. | |
4230 | ||
1e0598e2 RH |
4231 | @cindex @code{movmisalign@var{m}} instruction pattern |
4232 | @item @samp{movmisalign@var{m}} | |
4233 | This variant of a move pattern is designed to load or store a value | |
4234 | from a memory address that is not naturally aligned for its mode. | |
4235 | For a store, the memory will be in operand 0; for a load, the memory | |
4236 | will be in operand 1. The other operand is guaranteed not to be a | |
4237 | memory, so that it's easy to tell whether this is a load or store. | |
4238 | ||
4239 | This pattern is used by the autovectorizer, and when expanding a | |
4240 | @code{MISALIGNED_INDIRECT_REF} expression. | |
4241 | ||
03dda8e3 RK |
4242 | @cindex @code{load_multiple} instruction pattern |
4243 | @item @samp{load_multiple} | |
4244 | Load several consecutive memory locations into consecutive registers. | |
4245 | Operand 0 is the first of the consecutive registers, operand 1 | |
4246 | is the first memory location, and operand 2 is a constant: the | |
4247 | number of consecutive registers. | |
4248 | ||
4249 | Define this only if the target machine really has such an instruction; | |
4250 | do not define this if the most efficient way of loading consecutive | |
4251 | registers from memory is to do them one at a time. | |
4252 | ||
4253 | On some machines, there are restrictions as to which consecutive | |
4254 | registers can be stored into memory, such as particular starting or | |
4255 | ending register numbers or only a range of valid counts. For those | |
4256 | machines, use a @code{define_expand} (@pxref{Expander Definitions}) | |
4257 | and make the pattern fail if the restrictions are not met. | |
4258 | ||
4259 | Write the generated insn as a @code{parallel} with elements being a | |
4260 | @code{set} of one register from the appropriate memory location (you may | |
4261 | also need @code{use} or @code{clobber} elements). Use a | |
4262 | @code{match_parallel} (@pxref{RTL Template}) to recognize the insn. See | |
c9693e96 | 4263 | @file{rs6000.md} for examples of the use of this insn pattern. |
03dda8e3 RK |
4264 | |
4265 | @cindex @samp{store_multiple} instruction pattern | |
4266 | @item @samp{store_multiple} | |
4267 | Similar to @samp{load_multiple}, but store several consecutive registers | |
4268 | into consecutive memory locations. Operand 0 is the first of the | |
4269 | consecutive memory locations, operand 1 is the first register, and | |
4270 | operand 2 is a constant: the number of consecutive registers. | |
4271 | ||
272c6793 RS |
4272 | @cindex @code{vec_load_lanes@var{m}@var{n}} instruction pattern |
4273 | @item @samp{vec_load_lanes@var{m}@var{n}} | |
4274 | Perform an interleaved load of several vectors from memory operand 1 | |
4275 | into register operand 0. Both operands have mode @var{m}. The register | |
4276 | operand is viewed as holding consecutive vectors of mode @var{n}, | |
4277 | while the memory operand is a flat array that contains the same number | |
4278 | of elements. The operation is equivalent to: | |
4279 | ||
4280 | @smallexample | |
4281 | int c = GET_MODE_SIZE (@var{m}) / GET_MODE_SIZE (@var{n}); | |
4282 | for (j = 0; j < GET_MODE_NUNITS (@var{n}); j++) | |
4283 | for (i = 0; i < c; i++) | |
4284 | operand0[i][j] = operand1[j * c + i]; | |
4285 | @end smallexample | |
4286 | ||
4287 | For example, @samp{vec_load_lanestiv4hi} loads 8 16-bit values | |
4288 | from memory into a register of mode @samp{TI}@. The register | |
4289 | contains two consecutive vectors of mode @samp{V4HI}@. | |
4290 | ||
4291 | This pattern can only be used if: | |
4292 | @smallexample | |
4293 | TARGET_ARRAY_MODE_SUPPORTED_P (@var{n}, @var{c}) | |
4294 | @end smallexample | |
4295 | is true. GCC assumes that, if a target supports this kind of | |
4296 | instruction for some mode @var{n}, it also supports unaligned | |
4297 | loads for vectors of mode @var{n}. | |
4298 | ||
4299 | @cindex @code{vec_store_lanes@var{m}@var{n}} instruction pattern | |
4300 | @item @samp{vec_store_lanes@var{m}@var{n}} | |
4301 | Equivalent to @samp{vec_load_lanes@var{m}@var{n}}, with the memory | |
4302 | and register operands reversed. That is, the instruction is | |
4303 | equivalent to: | |
4304 | ||
4305 | @smallexample | |
4306 | int c = GET_MODE_SIZE (@var{m}) / GET_MODE_SIZE (@var{n}); | |
4307 | for (j = 0; j < GET_MODE_NUNITS (@var{n}); j++) | |
4308 | for (i = 0; i < c; i++) | |
4309 | operand0[j * c + i] = operand1[i][j]; | |
4310 | @end smallexample | |
4311 | ||
4312 | for a memory operand 0 and register operand 1. | |
4313 | ||
ef1140a9 JH |
4314 | @cindex @code{vec_set@var{m}} instruction pattern |
4315 | @item @samp{vec_set@var{m}} | |
4316 | Set given field in the vector value. Operand 0 is the vector to modify, | |
4317 | operand 1 is new value of field and operand 2 specify the field index. | |
4318 | ||
4319 | @cindex @code{vec_extract@var{m}} instruction pattern | |
4320 | @item @samp{vec_extract@var{m}} | |
4321 | Extract given field from the vector value. Operand 1 is the vector, operand 2 | |
4322 | specify field index and operand 0 place to store value into. | |
4323 | ||
4324 | @cindex @code{vec_init@var{m}} instruction pattern | |
4325 | @item @samp{vec_init@var{m}} | |
425a2bde | 4326 | Initialize the vector to given values. Operand 0 is the vector to initialize |
ef1140a9 JH |
4327 | and operand 1 is parallel containing values for individual fields. |
4328 | ||
e9e1d143 RG |
4329 | @cindex @code{vcond@var{m}@var{n}} instruction pattern |
4330 | @item @samp{vcond@var{m}@var{n}} | |
4331 | Output a conditional vector move. Operand 0 is the destination to | |
4332 | receive a combination of operand 1 and operand 2, which are of mode @var{m}, | |
4333 | dependent on the outcome of the predicate in operand 3 which is a | |
4334 | vector comparison with operands of mode @var{n} in operands 4 and 5. The | |
4335 | modes @var{m} and @var{n} should have the same size. Operand 0 | |
4336 | will be set to the value @var{op1} & @var{msk} | @var{op2} & ~@var{msk} | |
4337 | where @var{msk} is computed by element-wise evaluation of the vector | |
4338 | comparison with a truth value of all-ones and a false value of all-zeros. | |
4339 | ||
2205ed25 RH |
4340 | @cindex @code{vec_perm@var{m}} instruction pattern |
4341 | @item @samp{vec_perm@var{m}} | |
4342 | Output a (variable) vector permutation. Operand 0 is the destination | |
4343 | to receive elements from operand 1 and operand 2, which are of mode | |
4344 | @var{m}. Operand 3 is the @dfn{selector}. It is an integral mode | |
4345 | vector of the same width and number of elements as mode @var{m}. | |
4346 | ||
4347 | The input elements are numbered from 0 in operand 1 through | |
4348 | @math{2*@var{N}-1} in operand 2. The elements of the selector must | |
4349 | be computed modulo @math{2*@var{N}}. Note that if | |
4350 | @code{rtx_equal_p(operand1, operand2)}, this can be implemented | |
4351 | with just operand 1 and selector elements modulo @var{N}. | |
4352 | ||
d7943c8b RH |
4353 | In order to make things easy for a number of targets, if there is no |
4354 | @samp{vec_perm} pattern for mode @var{m}, but there is for mode @var{q} | |
4355 | where @var{q} is a vector of @code{QImode} of the same width as @var{m}, | |
4356 | the middle-end will lower the mode @var{m} @code{VEC_PERM_EXPR} to | |
4357 | mode @var{q}. | |
4358 | ||
82675d94 | 4359 | @cindex @code{vec_perm_const@var{m}} instruction pattern |
2205ed25 RH |
4360 | @item @samp{vec_perm_const@var{m}} |
4361 | Like @samp{vec_perm} except that the permutation is a compile-time | |
4362 | constant. That is, operand 3, the @dfn{selector}, is a @code{CONST_VECTOR}. | |
4363 | ||
4364 | Some targets cannot perform a permutation with a variable selector, | |
4365 | but can efficiently perform a constant permutation. Further, the | |
4366 | target hook @code{vec_perm_ok} is queried to determine if the | |
4367 | specific constant permutation is available efficiently; the named | |
4368 | pattern is never expanded without @code{vec_perm_ok} returning true. | |
4369 | ||
4370 | There is no need for a target to supply both @samp{vec_perm@var{m}} | |
4371 | and @samp{vec_perm_const@var{m}} if the former can trivially implement | |
4372 | the operation with, say, the vector constant loaded into a register. | |
4373 | ||
759915ca EC |
4374 | @cindex @code{push@var{m}1} instruction pattern |
4375 | @item @samp{push@var{m}1} | |
299c5111 | 4376 | Output a push instruction. Operand 0 is value to push. Used only when |
38f4324c JH |
4377 | @code{PUSH_ROUNDING} is defined. For historical reason, this pattern may be |
4378 | missing and in such case an @code{mov} expander is used instead, with a | |
6e9aac46 | 4379 | @code{MEM} expression forming the push operation. The @code{mov} expander |
38f4324c JH |
4380 | method is deprecated. |
4381 | ||
03dda8e3 RK |
4382 | @cindex @code{add@var{m}3} instruction pattern |
4383 | @item @samp{add@var{m}3} | |
4384 | Add operand 2 and operand 1, storing the result in operand 0. All operands | |
4385 | must have mode @var{m}. This can be used even on two-address machines, by | |
4386 | means of constraints requiring operands 1 and 0 to be the same location. | |
4387 | ||
0f996086 CF |
4388 | @cindex @code{ssadd@var{m}3} instruction pattern |
4389 | @cindex @code{usadd@var{m}3} instruction pattern | |
03dda8e3 | 4390 | @cindex @code{sub@var{m}3} instruction pattern |
0f996086 CF |
4391 | @cindex @code{sssub@var{m}3} instruction pattern |
4392 | @cindex @code{ussub@var{m}3} instruction pattern | |
03dda8e3 | 4393 | @cindex @code{mul@var{m}3} instruction pattern |
0f996086 CF |
4394 | @cindex @code{ssmul@var{m}3} instruction pattern |
4395 | @cindex @code{usmul@var{m}3} instruction pattern | |
03dda8e3 | 4396 | @cindex @code{div@var{m}3} instruction pattern |
0f996086 | 4397 | @cindex @code{ssdiv@var{m}3} instruction pattern |
03dda8e3 | 4398 | @cindex @code{udiv@var{m}3} instruction pattern |
0f996086 | 4399 | @cindex @code{usdiv@var{m}3} instruction pattern |
03dda8e3 RK |
4400 | @cindex @code{mod@var{m}3} instruction pattern |
4401 | @cindex @code{umod@var{m}3} instruction pattern | |
03dda8e3 RK |
4402 | @cindex @code{umin@var{m}3} instruction pattern |
4403 | @cindex @code{umax@var{m}3} instruction pattern | |
4404 | @cindex @code{and@var{m}3} instruction pattern | |
4405 | @cindex @code{ior@var{m}3} instruction pattern | |
4406 | @cindex @code{xor@var{m}3} instruction pattern | |
0f996086 CF |
4407 | @item @samp{ssadd@var{m}3}, @samp{usadd@var{m}3} |
4408 | @item @samp{sub@var{m}3}, @samp{sssub@var{m}3}, @samp{ussub@var{m}3} | |
4409 | @item @samp{mul@var{m}3}, @samp{ssmul@var{m}3}, @samp{usmul@var{m}3} | |
4410 | @itemx @samp{div@var{m}3}, @samp{ssdiv@var{m}3} | |
4411 | @itemx @samp{udiv@var{m}3}, @samp{usdiv@var{m}3} | |
7ae4d8d4 RH |
4412 | @itemx @samp{mod@var{m}3}, @samp{umod@var{m}3} |
4413 | @itemx @samp{umin@var{m}3}, @samp{umax@var{m}3} | |
03dda8e3 RK |
4414 | @itemx @samp{and@var{m}3}, @samp{ior@var{m}3}, @samp{xor@var{m}3} |
4415 | Similar, for other arithmetic operations. | |
7ae4d8d4 | 4416 | |
1b1562a5 MM |
4417 | @cindex @code{fma@var{m}4} instruction pattern |
4418 | @item @samp{fma@var{m}4} | |
4419 | Multiply operand 2 and operand 1, then add operand 3, storing the | |
4420 | result in operand 0. All operands must have mode @var{m}. This | |
4421 | pattern is used to implement the @code{fma}, @code{fmaf}, and | |
4422 | @code{fmal} builtin functions from the ISO C99 standard. The | |
4423 | @code{fma} operation may produce different results than doing the | |
4424 | multiply followed by the add if the machine does not perform a | |
4425 | rounding step between the operations. | |
4426 | ||
16949072 RG |
4427 | @cindex @code{fms@var{m}4} instruction pattern |
4428 | @item @samp{fms@var{m}4} | |
4429 | Like @code{fma@var{m}4}, except operand 3 subtracted from the | |
4430 | product instead of added to the product. This is represented | |
4431 | in the rtl as | |
4432 | ||
4433 | @smallexample | |
4434 | (fma:@var{m} @var{op1} @var{op2} (neg:@var{m} @var{op3})) | |
4435 | @end smallexample | |
4436 | ||
4437 | @cindex @code{fnma@var{m}4} instruction pattern | |
4438 | @item @samp{fnma@var{m}4} | |
4439 | Like @code{fma@var{m}4} except that the intermediate product | |
4440 | is negated before being added to operand 3. This is represented | |
4441 | in the rtl as | |
4442 | ||
4443 | @smallexample | |
4444 | (fma:@var{m} (neg:@var{m} @var{op1}) @var{op2} @var{op3}) | |
4445 | @end smallexample | |
4446 | ||
4447 | @cindex @code{fnms@var{m}4} instruction pattern | |
4448 | @item @samp{fnms@var{m}4} | |
4449 | Like @code{fms@var{m}4} except that the intermediate product | |
4450 | is negated before subtracting operand 3. This is represented | |
4451 | in the rtl as | |
4452 | ||
4453 | @smallexample | |
4454 | (fma:@var{m} (neg:@var{m} @var{op1}) @var{op2} (neg:@var{m} @var{op3})) | |
4455 | @end smallexample | |
4456 | ||
b71b019a JH |
4457 | @cindex @code{min@var{m}3} instruction pattern |
4458 | @cindex @code{max@var{m}3} instruction pattern | |
7ae4d8d4 RH |
4459 | @item @samp{smin@var{m}3}, @samp{smax@var{m}3} |
4460 | Signed minimum and maximum operations. When used with floating point, | |
4461 | if both operands are zeros, or if either operand is @code{NaN}, then | |
4462 | it is unspecified which of the two operands is returned as the result. | |
03dda8e3 | 4463 | |
61abee65 DN |
4464 | @cindex @code{reduc_smin_@var{m}} instruction pattern |
4465 | @cindex @code{reduc_smax_@var{m}} instruction pattern | |
4466 | @item @samp{reduc_smin_@var{m}}, @samp{reduc_smax_@var{m}} | |
4467 | Find the signed minimum/maximum of the elements of a vector. The vector is | |
759915ca EC |
4468 | operand 1, and the scalar result is stored in the least significant bits of |
4469 | operand 0 (also a vector). The output and input vector should have the same | |
61abee65 DN |
4470 | modes. |
4471 | ||
4472 | @cindex @code{reduc_umin_@var{m}} instruction pattern | |
4473 | @cindex @code{reduc_umax_@var{m}} instruction pattern | |
4474 | @item @samp{reduc_umin_@var{m}}, @samp{reduc_umax_@var{m}} | |
4475 | Find the unsigned minimum/maximum of the elements of a vector. The vector is | |
759915ca EC |
4476 | operand 1, and the scalar result is stored in the least significant bits of |
4477 | operand 0 (also a vector). The output and input vector should have the same | |
61abee65 DN |
4478 | modes. |
4479 | ||
4480 | @cindex @code{reduc_splus_@var{m}} instruction pattern | |
4481 | @item @samp{reduc_splus_@var{m}} | |
759915ca EC |
4482 | Compute the sum of the signed elements of a vector. The vector is operand 1, |
4483 | and the scalar result is stored in the least significant bits of operand 0 | |
61abee65 DN |
4484 | (also a vector). The output and input vector should have the same modes. |
4485 | ||
4486 | @cindex @code{reduc_uplus_@var{m}} instruction pattern | |
4487 | @item @samp{reduc_uplus_@var{m}} | |
759915ca EC |
4488 | Compute the sum of the unsigned elements of a vector. The vector is operand 1, |
4489 | and the scalar result is stored in the least significant bits of operand 0 | |
61abee65 DN |
4490 | (also a vector). The output and input vector should have the same modes. |
4491 | ||
20f06221 DN |
4492 | @cindex @code{sdot_prod@var{m}} instruction pattern |
4493 | @item @samp{sdot_prod@var{m}} | |
4494 | @cindex @code{udot_prod@var{m}} instruction pattern | |
4495 | @item @samp{udot_prod@var{m}} | |
ff2ce160 MS |
4496 | Compute the sum of the products of two signed/unsigned elements. |
4497 | Operand 1 and operand 2 are of the same mode. Their product, which is of a | |
4498 | wider mode, is computed and added to operand 3. Operand 3 is of a mode equal or | |
20f06221 | 4499 | wider than the mode of the product. The result is placed in operand 0, which |
ff2ce160 | 4500 | is of the same mode as operand 3. |
20f06221 DN |
4501 | |
4502 | @cindex @code{ssum_widen@var{m3}} instruction pattern | |
4503 | @item @samp{ssum_widen@var{m3}} | |
4504 | @cindex @code{usum_widen@var{m3}} instruction pattern | |
4505 | @item @samp{usum_widen@var{m3}} | |
ff2ce160 | 4506 | Operands 0 and 2 are of the same mode, which is wider than the mode of |
20f06221 DN |
4507 | operand 1. Add operand 1 to operand 2 and place the widened result in |
4508 | operand 0. (This is used express accumulation of elements into an accumulator | |
4509 | of a wider mode.) | |
4510 | ||
61abee65 DN |
4511 | @cindex @code{vec_shl_@var{m}} instruction pattern |
4512 | @cindex @code{vec_shr_@var{m}} instruction pattern | |
4513 | @item @samp{vec_shl_@var{m}}, @samp{vec_shr_@var{m}} | |
4514 | Whole vector left/right shift in bits. | |
4515 | Operand 1 is a vector to be shifted. | |
759915ca | 4516 | Operand 2 is an integer shift amount in bits. |
61abee65 DN |
4517 | Operand 0 is where the resulting shifted vector is stored. |
4518 | The output and input vectors should have the same modes. | |
4519 | ||
8115817b UB |
4520 | @cindex @code{vec_pack_trunc_@var{m}} instruction pattern |
4521 | @item @samp{vec_pack_trunc_@var{m}} | |
4522 | Narrow (demote) and merge the elements of two vectors. Operands 1 and 2 | |
4523 | are vectors of the same mode having N integral or floating point elements | |
0ee2ea09 | 4524 | of size S@. Operand 0 is the resulting vector in which 2*N elements of |
8115817b UB |
4525 | size N/2 are concatenated after narrowing them down using truncation. |
4526 | ||
89d67cca DN |
4527 | @cindex @code{vec_pack_ssat_@var{m}} instruction pattern |
4528 | @cindex @code{vec_pack_usat_@var{m}} instruction pattern | |
8115817b UB |
4529 | @item @samp{vec_pack_ssat_@var{m}}, @samp{vec_pack_usat_@var{m}} |
4530 | Narrow (demote) and merge the elements of two vectors. Operands 1 and 2 | |
4531 | are vectors of the same mode having N integral elements of size S. | |
89d67cca | 4532 | Operand 0 is the resulting vector in which the elements of the two input |
8115817b UB |
4533 | vectors are concatenated after narrowing them down using signed/unsigned |
4534 | saturating arithmetic. | |
89d67cca | 4535 | |
d9987fb4 UB |
4536 | @cindex @code{vec_pack_sfix_trunc_@var{m}} instruction pattern |
4537 | @cindex @code{vec_pack_ufix_trunc_@var{m}} instruction pattern | |
4538 | @item @samp{vec_pack_sfix_trunc_@var{m}}, @samp{vec_pack_ufix_trunc_@var{m}} | |
4539 | Narrow, convert to signed/unsigned integral type and merge the elements | |
4540 | of two vectors. Operands 1 and 2 are vectors of the same mode having N | |
0ee2ea09 | 4541 | floating point elements of size S@. Operand 0 is the resulting vector |
d9987fb4 UB |
4542 | in which 2*N elements of size N/2 are concatenated. |
4543 | ||
89d67cca DN |
4544 | @cindex @code{vec_unpacks_hi_@var{m}} instruction pattern |
4545 | @cindex @code{vec_unpacks_lo_@var{m}} instruction pattern | |
8115817b UB |
4546 | @item @samp{vec_unpacks_hi_@var{m}}, @samp{vec_unpacks_lo_@var{m}} |
4547 | Extract and widen (promote) the high/low part of a vector of signed | |
4548 | integral or floating point elements. The input vector (operand 1) has N | |
0ee2ea09 | 4549 | elements of size S@. Widen (promote) the high/low elements of the vector |
8115817b UB |
4550 | using signed or floating point extension and place the resulting N/2 |
4551 | values of size 2*S in the output vector (operand 0). | |
4552 | ||
89d67cca DN |
4553 | @cindex @code{vec_unpacku_hi_@var{m}} instruction pattern |
4554 | @cindex @code{vec_unpacku_lo_@var{m}} instruction pattern | |
8115817b UB |
4555 | @item @samp{vec_unpacku_hi_@var{m}}, @samp{vec_unpacku_lo_@var{m}} |
4556 | Extract and widen (promote) the high/low part of a vector of unsigned | |
4557 | integral elements. The input vector (operand 1) has N elements of size S. | |
4558 | Widen (promote) the high/low elements of the vector using zero extension and | |
4559 | place the resulting N/2 values of size 2*S in the output vector (operand 0). | |
89d67cca | 4560 | |
d9987fb4 UB |
4561 | @cindex @code{vec_unpacks_float_hi_@var{m}} instruction pattern |
4562 | @cindex @code{vec_unpacks_float_lo_@var{m}} instruction pattern | |
4563 | @cindex @code{vec_unpacku_float_hi_@var{m}} instruction pattern | |
4564 | @cindex @code{vec_unpacku_float_lo_@var{m}} instruction pattern | |
4565 | @item @samp{vec_unpacks_float_hi_@var{m}}, @samp{vec_unpacks_float_lo_@var{m}} | |
4566 | @itemx @samp{vec_unpacku_float_hi_@var{m}}, @samp{vec_unpacku_float_lo_@var{m}} | |
4567 | Extract, convert to floating point type and widen the high/low part of a | |
4568 | vector of signed/unsigned integral elements. The input vector (operand 1) | |
0ee2ea09 | 4569 | has N elements of size S@. Convert the high/low elements of the vector using |
d9987fb4 UB |
4570 | floating point conversion and place the resulting N/2 values of size 2*S in |
4571 | the output vector (operand 0). | |
4572 | ||
89d67cca DN |
4573 | @cindex @code{vec_widen_umult_hi_@var{m}} instruction pattern |
4574 | @cindex @code{vec_widen_umult_lo__@var{m}} instruction pattern | |
4575 | @cindex @code{vec_widen_smult_hi_@var{m}} instruction pattern | |
4576 | @cindex @code{vec_widen_smult_lo_@var{m}} instruction pattern | |
d9987fb4 UB |
4577 | @item @samp{vec_widen_umult_hi_@var{m}}, @samp{vec_widen_umult_lo_@var{m}} |
4578 | @itemx @samp{vec_widen_smult_hi_@var{m}}, @samp{vec_widen_smult_lo_@var{m}} | |
8115817b | 4579 | Signed/Unsigned widening multiplication. The two inputs (operands 1 and 2) |
0ee2ea09 | 4580 | are vectors with N signed/unsigned elements of size S@. Multiply the high/low |
8115817b UB |
4581 | elements of the two vectors, and put the N/2 products of size 2*S in the |
4582 | output vector (operand 0). | |
89d67cca | 4583 | |
36ba4aae IR |
4584 | @cindex @code{vec_widen_ushiftl_hi_@var{m}} instruction pattern |
4585 | @cindex @code{vec_widen_ushiftl_lo_@var{m}} instruction pattern | |
4586 | @cindex @code{vec_widen_sshiftl_hi_@var{m}} instruction pattern | |
4587 | @cindex @code{vec_widen_sshiftl_lo_@var{m}} instruction pattern | |
4588 | @item @samp{vec_widen_ushiftl_hi_@var{m}}, @samp{vec_widen_ushiftl_lo_@var{m}} | |
4589 | @itemx @samp{vec_widen_sshiftl_hi_@var{m}}, @samp{vec_widen_sshiftl_lo_@var{m}} | |
4590 | Signed/Unsigned widening shift left. The first input (operand 1) is a vector | |
4591 | with N signed/unsigned elements of size S@. Operand 2 is a constant. Shift | |
4592 | the high/low elements of operand 1, and put the N/2 results of size 2*S in the | |
4593 | output vector (operand 0). | |
4594 | ||
03dda8e3 RK |
4595 | @cindex @code{mulhisi3} instruction pattern |
4596 | @item @samp{mulhisi3} | |
4597 | Multiply operands 1 and 2, which have mode @code{HImode}, and store | |
4598 | a @code{SImode} product in operand 0. | |
4599 | ||
4600 | @cindex @code{mulqihi3} instruction pattern | |
4601 | @cindex @code{mulsidi3} instruction pattern | |
4602 | @item @samp{mulqihi3}, @samp{mulsidi3} | |
4603 | Similar widening-multiplication instructions of other widths. | |
4604 | ||
4605 | @cindex @code{umulqihi3} instruction pattern | |
4606 | @cindex @code{umulhisi3} instruction pattern | |
4607 | @cindex @code{umulsidi3} instruction pattern | |
4608 | @item @samp{umulqihi3}, @samp{umulhisi3}, @samp{umulsidi3} | |
4609 | Similar widening-multiplication instructions that do unsigned | |
4610 | multiplication. | |
4611 | ||
8b44057d BS |
4612 | @cindex @code{usmulqihi3} instruction pattern |
4613 | @cindex @code{usmulhisi3} instruction pattern | |
4614 | @cindex @code{usmulsidi3} instruction pattern | |
4615 | @item @samp{usmulqihi3}, @samp{usmulhisi3}, @samp{usmulsidi3} | |
4616 | Similar widening-multiplication instructions that interpret the first | |
4617 | operand as unsigned and the second operand as signed, then do a signed | |
4618 | multiplication. | |
4619 | ||
03dda8e3 | 4620 | @cindex @code{smul@var{m}3_highpart} instruction pattern |
759c58af | 4621 | @item @samp{smul@var{m}3_highpart} |
03dda8e3 RK |
4622 | Perform a signed multiplication of operands 1 and 2, which have mode |
4623 | @var{m}, and store the most significant half of the product in operand 0. | |
4624 | The least significant half of the product is discarded. | |
4625 | ||
4626 | @cindex @code{umul@var{m}3_highpart} instruction pattern | |
4627 | @item @samp{umul@var{m}3_highpart} | |
4628 | Similar, but the multiplication is unsigned. | |
4629 | ||
7f9844ca RS |
4630 | @cindex @code{madd@var{m}@var{n}4} instruction pattern |
4631 | @item @samp{madd@var{m}@var{n}4} | |
4632 | Multiply operands 1 and 2, sign-extend them to mode @var{n}, add | |
4633 | operand 3, and store the result in operand 0. Operands 1 and 2 | |
4634 | have mode @var{m} and operands 0 and 3 have mode @var{n}. | |
0f996086 | 4635 | Both modes must be integer or fixed-point modes and @var{n} must be twice |
7f9844ca RS |
4636 | the size of @var{m}. |
4637 | ||
4638 | In other words, @code{madd@var{m}@var{n}4} is like | |
4639 | @code{mul@var{m}@var{n}3} except that it also adds operand 3. | |
4640 | ||
4641 | These instructions are not allowed to @code{FAIL}. | |
4642 | ||
4643 | @cindex @code{umadd@var{m}@var{n}4} instruction pattern | |
4644 | @item @samp{umadd@var{m}@var{n}4} | |
4645 | Like @code{madd@var{m}@var{n}4}, but zero-extend the multiplication | |
4646 | operands instead of sign-extending them. | |
4647 | ||
0f996086 CF |
4648 | @cindex @code{ssmadd@var{m}@var{n}4} instruction pattern |
4649 | @item @samp{ssmadd@var{m}@var{n}4} | |
4650 | Like @code{madd@var{m}@var{n}4}, but all involved operations must be | |
4651 | signed-saturating. | |
4652 | ||
4653 | @cindex @code{usmadd@var{m}@var{n}4} instruction pattern | |
4654 | @item @samp{usmadd@var{m}@var{n}4} | |
4655 | Like @code{umadd@var{m}@var{n}4}, but all involved operations must be | |
4656 | unsigned-saturating. | |
4657 | ||
14661f36 CF |
4658 | @cindex @code{msub@var{m}@var{n}4} instruction pattern |
4659 | @item @samp{msub@var{m}@var{n}4} | |
4660 | Multiply operands 1 and 2, sign-extend them to mode @var{n}, subtract the | |
4661 | result from operand 3, and store the result in operand 0. Operands 1 and 2 | |
4662 | have mode @var{m} and operands 0 and 3 have mode @var{n}. | |
0f996086 | 4663 | Both modes must be integer or fixed-point modes and @var{n} must be twice |
14661f36 CF |
4664 | the size of @var{m}. |
4665 | ||
4666 | In other words, @code{msub@var{m}@var{n}4} is like | |
4667 | @code{mul@var{m}@var{n}3} except that it also subtracts the result | |
4668 | from operand 3. | |
4669 | ||
4670 | These instructions are not allowed to @code{FAIL}. | |
4671 | ||
4672 | @cindex @code{umsub@var{m}@var{n}4} instruction pattern | |
4673 | @item @samp{umsub@var{m}@var{n}4} | |
4674 | Like @code{msub@var{m}@var{n}4}, but zero-extend the multiplication | |
4675 | operands instead of sign-extending them. | |
4676 | ||
0f996086 CF |
4677 | @cindex @code{ssmsub@var{m}@var{n}4} instruction pattern |
4678 | @item @samp{ssmsub@var{m}@var{n}4} | |
4679 | Like @code{msub@var{m}@var{n}4}, but all involved operations must be | |
4680 | signed-saturating. | |
4681 | ||
4682 | @cindex @code{usmsub@var{m}@var{n}4} instruction pattern | |
4683 | @item @samp{usmsub@var{m}@var{n}4} | |
4684 | Like @code{umsub@var{m}@var{n}4}, but all involved operations must be | |
4685 | unsigned-saturating. | |
4686 | ||
03dda8e3 RK |
4687 | @cindex @code{divmod@var{m}4} instruction pattern |
4688 | @item @samp{divmod@var{m}4} | |
4689 | Signed division that produces both a quotient and a remainder. | |
4690 | Operand 1 is divided by operand 2 to produce a quotient stored | |
4691 | in operand 0 and a remainder stored in operand 3. | |
4692 | ||
4693 | For machines with an instruction that produces both a quotient and a | |
4694 | remainder, provide a pattern for @samp{divmod@var{m}4} but do not | |
4695 | provide patterns for @samp{div@var{m}3} and @samp{mod@var{m}3}. This | |
4696 | allows optimization in the relatively common case when both the quotient | |
4697 | and remainder are computed. | |
4698 | ||
4699 | If an instruction that just produces a quotient or just a remainder | |
4700 | exists and is more efficient than the instruction that produces both, | |
4701 | write the output routine of @samp{divmod@var{m}4} to call | |
4702 | @code{find_reg_note} and look for a @code{REG_UNUSED} note on the | |
4703 | quotient or remainder and generate the appropriate instruction. | |
4704 | ||
4705 | @cindex @code{udivmod@var{m}4} instruction pattern | |
4706 | @item @samp{udivmod@var{m}4} | |
4707 | Similar, but does unsigned division. | |
4708 | ||
273a2526 | 4709 | @anchor{shift patterns} |
03dda8e3 | 4710 | @cindex @code{ashl@var{m}3} instruction pattern |
0f996086 CF |
4711 | @cindex @code{ssashl@var{m}3} instruction pattern |
4712 | @cindex @code{usashl@var{m}3} instruction pattern | |
4713 | @item @samp{ashl@var{m}3}, @samp{ssashl@var{m}3}, @samp{usashl@var{m}3} | |
03dda8e3 RK |
4714 | Arithmetic-shift operand 1 left by a number of bits specified by operand |
4715 | 2, and store the result in operand 0. Here @var{m} is the mode of | |
4716 | operand 0 and operand 1; operand 2's mode is specified by the | |
4717 | instruction pattern, and the compiler will convert the operand to that | |
273a2526 RS |
4718 | mode before generating the instruction. The meaning of out-of-range shift |
4719 | counts can optionally be specified by @code{TARGET_SHIFT_TRUNCATION_MASK}. | |
71d46ca5 | 4720 | @xref{TARGET_SHIFT_TRUNCATION_MASK}. Operand 2 is always a scalar type. |
03dda8e3 RK |
4721 | |
4722 | @cindex @code{ashr@var{m}3} instruction pattern | |
4723 | @cindex @code{lshr@var{m}3} instruction pattern | |
4724 | @cindex @code{rotl@var{m}3} instruction pattern | |
4725 | @cindex @code{rotr@var{m}3} instruction pattern | |
4726 | @item @samp{ashr@var{m}3}, @samp{lshr@var{m}3}, @samp{rotl@var{m}3}, @samp{rotr@var{m}3} | |
4727 | Other shift and rotate instructions, analogous to the | |
71d46ca5 MM |
4728 | @code{ashl@var{m}3} instructions. Operand 2 is always a scalar type. |
4729 | ||
4730 | @cindex @code{vashl@var{m}3} instruction pattern | |
4731 | @cindex @code{vashr@var{m}3} instruction pattern | |
4732 | @cindex @code{vlshr@var{m}3} instruction pattern | |
4733 | @cindex @code{vrotl@var{m}3} instruction pattern | |
4734 | @cindex @code{vrotr@var{m}3} instruction pattern | |
4735 | @item @samp{vashl@var{m}3}, @samp{vashr@var{m}3}, @samp{vlshr@var{m}3}, @samp{vrotl@var{m}3}, @samp{vrotr@var{m}3} | |
4736 | Vector shift and rotate instructions that take vectors as operand 2 | |
4737 | instead of a scalar type. | |
03dda8e3 RK |
4738 | |
4739 | @cindex @code{neg@var{m}2} instruction pattern | |
0f996086 CF |
4740 | @cindex @code{ssneg@var{m}2} instruction pattern |
4741 | @cindex @code{usneg@var{m}2} instruction pattern | |
4742 | @item @samp{neg@var{m}2}, @samp{ssneg@var{m}2}, @samp{usneg@var{m}2} | |
03dda8e3 RK |
4743 | Negate operand 1 and store the result in operand 0. |
4744 | ||
4745 | @cindex @code{abs@var{m}2} instruction pattern | |
4746 | @item @samp{abs@var{m}2} | |
4747 | Store the absolute value of operand 1 into operand 0. | |
4748 | ||
4749 | @cindex @code{sqrt@var{m}2} instruction pattern | |
4750 | @item @samp{sqrt@var{m}2} | |
4751 | Store the square root of operand 1 into operand 0. | |
4752 | ||
4753 | The @code{sqrt} built-in function of C always uses the mode which | |
e7b489c8 RS |
4754 | corresponds to the C data type @code{double} and the @code{sqrtf} |
4755 | built-in function uses the mode which corresponds to the C data | |
4756 | type @code{float}. | |
4757 | ||
17b98269 UB |
4758 | @cindex @code{fmod@var{m}3} instruction pattern |
4759 | @item @samp{fmod@var{m}3} | |
4760 | Store the remainder of dividing operand 1 by operand 2 into | |
4761 | operand 0, rounded towards zero to an integer. | |
4762 | ||
4763 | The @code{fmod} built-in function of C always uses the mode which | |
4764 | corresponds to the C data type @code{double} and the @code{fmodf} | |
4765 | built-in function uses the mode which corresponds to the C data | |
4766 | type @code{float}. | |
4767 | ||
4768 | @cindex @code{remainder@var{m}3} instruction pattern | |
4769 | @item @samp{remainder@var{m}3} | |
4770 | Store the remainder of dividing operand 1 by operand 2 into | |
4771 | operand 0, rounded to the nearest integer. | |
4772 | ||
4773 | The @code{remainder} built-in function of C always uses the mode | |
4774 | which corresponds to the C data type @code{double} and the | |
4775 | @code{remainderf} built-in function uses the mode which corresponds | |
4776 | to the C data type @code{float}. | |
4777 | ||
e7b489c8 RS |
4778 | @cindex @code{cos@var{m}2} instruction pattern |
4779 | @item @samp{cos@var{m}2} | |
4780 | Store the cosine of operand 1 into operand 0. | |
4781 | ||
4782 | The @code{cos} built-in function of C always uses the mode which | |
4783 | corresponds to the C data type @code{double} and the @code{cosf} | |
4784 | built-in function uses the mode which corresponds to the C data | |
4785 | type @code{float}. | |
4786 | ||
4787 | @cindex @code{sin@var{m}2} instruction pattern | |
4788 | @item @samp{sin@var{m}2} | |
4789 | Store the sine of operand 1 into operand 0. | |
4790 | ||
4791 | The @code{sin} built-in function of C always uses the mode which | |
4792 | corresponds to the C data type @code{double} and the @code{sinf} | |
4793 | built-in function uses the mode which corresponds to the C data | |
4794 | type @code{float}. | |
4795 | ||
4796 | @cindex @code{exp@var{m}2} instruction pattern | |
4797 | @item @samp{exp@var{m}2} | |
4798 | Store the exponential of operand 1 into operand 0. | |
4799 | ||
4800 | The @code{exp} built-in function of C always uses the mode which | |
4801 | corresponds to the C data type @code{double} and the @code{expf} | |
4802 | built-in function uses the mode which corresponds to the C data | |
4803 | type @code{float}. | |
4804 | ||
4805 | @cindex @code{log@var{m}2} instruction pattern | |
4806 | @item @samp{log@var{m}2} | |
4807 | Store the natural logarithm of operand 1 into operand 0. | |
4808 | ||
4809 | The @code{log} built-in function of C always uses the mode which | |
4810 | corresponds to the C data type @code{double} and the @code{logf} | |
4811 | built-in function uses the mode which corresponds to the C data | |
4812 | type @code{float}. | |
03dda8e3 | 4813 | |
b5e01d4b RS |
4814 | @cindex @code{pow@var{m}3} instruction pattern |
4815 | @item @samp{pow@var{m}3} | |
4816 | Store the value of operand 1 raised to the exponent operand 2 | |
4817 | into operand 0. | |
4818 | ||
4819 | The @code{pow} built-in function of C always uses the mode which | |
4820 | corresponds to the C data type @code{double} and the @code{powf} | |
4821 | built-in function uses the mode which corresponds to the C data | |
4822 | type @code{float}. | |
4823 | ||
4824 | @cindex @code{atan2@var{m}3} instruction pattern | |
4825 | @item @samp{atan2@var{m}3} | |
4826 | Store the arc tangent (inverse tangent) of operand 1 divided by | |
4827 | operand 2 into operand 0, using the signs of both arguments to | |
4828 | determine the quadrant of the result. | |
4829 | ||
4830 | The @code{atan2} built-in function of C always uses the mode which | |
4831 | corresponds to the C data type @code{double} and the @code{atan2f} | |
4832 | built-in function uses the mode which corresponds to the C data | |
4833 | type @code{float}. | |
4834 | ||
4977bab6 ZW |
4835 | @cindex @code{floor@var{m}2} instruction pattern |
4836 | @item @samp{floor@var{m}2} | |
4837 | Store the largest integral value not greater than argument. | |
4838 | ||
4839 | The @code{floor} built-in function of C always uses the mode which | |
4840 | corresponds to the C data type @code{double} and the @code{floorf} | |
4841 | built-in function uses the mode which corresponds to the C data | |
4842 | type @code{float}. | |
4843 | ||
10553f10 UB |
4844 | @cindex @code{btrunc@var{m}2} instruction pattern |
4845 | @item @samp{btrunc@var{m}2} | |
4977bab6 ZW |
4846 | Store the argument rounded to integer towards zero. |
4847 | ||
4848 | The @code{trunc} built-in function of C always uses the mode which | |
4849 | corresponds to the C data type @code{double} and the @code{truncf} | |
4850 | built-in function uses the mode which corresponds to the C data | |
4851 | type @code{float}. | |
4852 | ||
4853 | @cindex @code{round@var{m}2} instruction pattern | |
4854 | @item @samp{round@var{m}2} | |
4855 | Store the argument rounded to integer away from zero. | |
4856 | ||
4857 | The @code{round} built-in function of C always uses the mode which | |
4858 | corresponds to the C data type @code{double} and the @code{roundf} | |
4859 | built-in function uses the mode which corresponds to the C data | |
4860 | type @code{float}. | |
4861 | ||
4862 | @cindex @code{ceil@var{m}2} instruction pattern | |
4863 | @item @samp{ceil@var{m}2} | |
4864 | Store the argument rounded to integer away from zero. | |
4865 | ||
4866 | The @code{ceil} built-in function of C always uses the mode which | |
4867 | corresponds to the C data type @code{double} and the @code{ceilf} | |
4868 | built-in function uses the mode which corresponds to the C data | |
4869 | type @code{float}. | |
4870 | ||
4871 | @cindex @code{nearbyint@var{m}2} instruction pattern | |
4872 | @item @samp{nearbyint@var{m}2} | |
4873 | Store the argument rounded according to the default rounding mode | |
4874 | ||
4875 | The @code{nearbyint} built-in function of C always uses the mode which | |
4876 | corresponds to the C data type @code{double} and the @code{nearbyintf} | |
4877 | built-in function uses the mode which corresponds to the C data | |
4878 | type @code{float}. | |
4879 | ||
10553f10 UB |
4880 | @cindex @code{rint@var{m}2} instruction pattern |
4881 | @item @samp{rint@var{m}2} | |
4882 | Store the argument rounded according to the default rounding mode and | |
4883 | raise the inexact exception when the result differs in value from | |
4884 | the argument | |
4885 | ||
4886 | The @code{rint} built-in function of C always uses the mode which | |
4887 | corresponds to the C data type @code{double} and the @code{rintf} | |
4888 | built-in function uses the mode which corresponds to the C data | |
4889 | type @code{float}. | |
4890 | ||
bb7f0423 RG |
4891 | @cindex @code{lrint@var{m}@var{n}2} |
4892 | @item @samp{lrint@var{m}@var{n}2} | |
4893 | Convert operand 1 (valid for floating point mode @var{m}) to fixed | |
4894 | point mode @var{n} as a signed number according to the current | |
4895 | rounding mode and store in operand 0 (which has mode @var{n}). | |
4896 | ||
4d81bf84 | 4897 | @cindex @code{lround@var{m}@var{n}2} |
e0d4c0b3 | 4898 | @item @samp{lround@var{m}@var{n}2} |
4d81bf84 RG |
4899 | Convert operand 1 (valid for floating point mode @var{m}) to fixed |
4900 | point mode @var{n} as a signed number rounding to nearest and away | |
4901 | from zero and store in operand 0 (which has mode @var{n}). | |
4902 | ||
c3a4177f | 4903 | @cindex @code{lfloor@var{m}@var{n}2} |
e0d4c0b3 | 4904 | @item @samp{lfloor@var{m}@var{n}2} |
c3a4177f RG |
4905 | Convert operand 1 (valid for floating point mode @var{m}) to fixed |
4906 | point mode @var{n} as a signed number rounding down and store in | |
4907 | operand 0 (which has mode @var{n}). | |
4908 | ||
4909 | @cindex @code{lceil@var{m}@var{n}2} | |
e0d4c0b3 | 4910 | @item @samp{lceil@var{m}@var{n}2} |
c3a4177f RG |
4911 | Convert operand 1 (valid for floating point mode @var{m}) to fixed |
4912 | point mode @var{n} as a signed number rounding up and store in | |
4913 | operand 0 (which has mode @var{n}). | |
4914 | ||
d35a40fc DE |
4915 | @cindex @code{copysign@var{m}3} instruction pattern |
4916 | @item @samp{copysign@var{m}3} | |
4917 | Store a value with the magnitude of operand 1 and the sign of operand | |
4918 | 2 into operand 0. | |
4919 | ||
4920 | The @code{copysign} built-in function of C always uses the mode which | |
4921 | corresponds to the C data type @code{double} and the @code{copysignf} | |
4922 | built-in function uses the mode which corresponds to the C data | |
4923 | type @code{float}. | |
4924 | ||
03dda8e3 RK |
4925 | @cindex @code{ffs@var{m}2} instruction pattern |
4926 | @item @samp{ffs@var{m}2} | |
4927 | Store into operand 0 one plus the index of the least significant 1-bit | |
4928 | of operand 1. If operand 1 is zero, store zero. @var{m} is the mode | |
4929 | of operand 0; operand 1's mode is specified by the instruction | |
4930 | pattern, and the compiler will convert the operand to that mode before | |
4931 | generating the instruction. | |
4932 | ||
4933 | The @code{ffs} built-in function of C always uses the mode which | |
4934 | corresponds to the C data type @code{int}. | |
4935 | ||
2928cd7a RH |
4936 | @cindex @code{clz@var{m}2} instruction pattern |
4937 | @item @samp{clz@var{m}2} | |
4938 | Store into operand 0 the number of leading 0-bits in @var{x}, starting | |
2a6627c2 JN |
4939 | at the most significant bit position. If @var{x} is 0, the |
4940 | @code{CLZ_DEFINED_VALUE_AT_ZERO} (@pxref{Misc}) macro defines if | |
4941 | the result is undefined or has a useful value. | |
4942 | @var{m} is the mode of operand 0; operand 1's mode is | |
2928cd7a RH |
4943 | specified by the instruction pattern, and the compiler will convert the |
4944 | operand to that mode before generating the instruction. | |
4945 | ||
4946 | @cindex @code{ctz@var{m}2} instruction pattern | |
4947 | @item @samp{ctz@var{m}2} | |
4948 | Store into operand 0 the number of trailing 0-bits in @var{x}, starting | |
2a6627c2 JN |
4949 | at the least significant bit position. If @var{x} is 0, the |
4950 | @code{CTZ_DEFINED_VALUE_AT_ZERO} (@pxref{Misc}) macro defines if | |
4951 | the result is undefined or has a useful value. | |
4952 | @var{m} is the mode of operand 0; operand 1's mode is | |
2928cd7a RH |
4953 | specified by the instruction pattern, and the compiler will convert the |
4954 | operand to that mode before generating the instruction. | |
4955 | ||
4956 | @cindex @code{popcount@var{m}2} instruction pattern | |
4957 | @item @samp{popcount@var{m}2} | |
4958 | Store into operand 0 the number of 1-bits in @var{x}. @var{m} is the | |
4959 | mode of operand 0; operand 1's mode is specified by the instruction | |
4960 | pattern, and the compiler will convert the operand to that mode before | |
4961 | generating the instruction. | |
4962 | ||
4963 | @cindex @code{parity@var{m}2} instruction pattern | |
4964 | @item @samp{parity@var{m}2} | |
8a36672b | 4965 | Store into operand 0 the parity of @var{x}, i.e.@: the number of 1-bits |
2928cd7a RH |
4966 | in @var{x} modulo 2. @var{m} is the mode of operand 0; operand 1's mode |
4967 | is specified by the instruction pattern, and the compiler will convert | |
4968 | the operand to that mode before generating the instruction. | |
4969 | ||
03dda8e3 RK |
4970 | @cindex @code{one_cmpl@var{m}2} instruction pattern |
4971 | @item @samp{one_cmpl@var{m}2} | |
4972 | Store the bitwise-complement of operand 1 into operand 0. | |
4973 | ||
70128ad9 AO |
4974 | @cindex @code{movmem@var{m}} instruction pattern |
4975 | @item @samp{movmem@var{m}} | |
beed8fc0 AO |
4976 | Block move instruction. The destination and source blocks of memory |
4977 | are the first two operands, and both are @code{mem:BLK}s with an | |
4978 | address in mode @code{Pmode}. | |
e5e809f4 | 4979 | |
03dda8e3 | 4980 | The number of bytes to move is the third operand, in mode @var{m}. |
e5e809f4 JL |
4981 | Usually, you specify @code{word_mode} for @var{m}. However, if you can |
4982 | generate better code knowing the range of valid lengths is smaller than | |
4983 | those representable in a full word, you should provide a pattern with a | |
4984 | mode corresponding to the range of values you can handle efficiently | |
4985 | (e.g., @code{QImode} for values in the range 0--127; note we avoid numbers | |
4986 | that appear negative) and also a pattern with @code{word_mode}. | |
03dda8e3 RK |
4987 | |
4988 | The fourth operand is the known shared alignment of the source and | |
4989 | destination, in the form of a @code{const_int} rtx. Thus, if the | |
4990 | compiler knows that both source and destination are word-aligned, | |
4991 | it may provide the value 4 for this operand. | |
4992 | ||
079a182e JH |
4993 | Optional operands 5 and 6 specify expected alignment and size of block |
4994 | respectively. The expected alignment differs from alignment in operand 4 | |
4995 | in a way that the blocks are not required to be aligned according to it in | |
9946ca2d RA |
4996 | all cases. This expected alignment is also in bytes, just like operand 4. |
4997 | Expected size, when unknown, is set to @code{(const_int -1)}. | |
079a182e | 4998 | |
70128ad9 | 4999 | Descriptions of multiple @code{movmem@var{m}} patterns can only be |
4693911f | 5000 | beneficial if the patterns for smaller modes have fewer restrictions |
8c01d9b6 | 5001 | on their first, second and fourth operands. Note that the mode @var{m} |
70128ad9 | 5002 | in @code{movmem@var{m}} does not impose any restriction on the mode of |
8c01d9b6 JL |
5003 | individually moved data units in the block. |
5004 | ||
03dda8e3 RK |
5005 | These patterns need not give special consideration to the possibility |
5006 | that the source and destination strings might overlap. | |
5007 | ||
beed8fc0 AO |
5008 | @cindex @code{movstr} instruction pattern |
5009 | @item @samp{movstr} | |
5010 | String copy instruction, with @code{stpcpy} semantics. Operand 0 is | |
5011 | an output operand in mode @code{Pmode}. The addresses of the | |
5012 | destination and source strings are operands 1 and 2, and both are | |
5013 | @code{mem:BLK}s with addresses in mode @code{Pmode}. The execution of | |
5014 | the expansion of this pattern should store in operand 0 the address in | |
5015 | which the @code{NUL} terminator was stored in the destination string. | |
5016 | ||
57e84f18 AS |
5017 | @cindex @code{setmem@var{m}} instruction pattern |
5018 | @item @samp{setmem@var{m}} | |
5019 | Block set instruction. The destination string is the first operand, | |
beed8fc0 | 5020 | given as a @code{mem:BLK} whose address is in mode @code{Pmode}. The |
57e84f18 AS |
5021 | number of bytes to set is the second operand, in mode @var{m}. The value to |
5022 | initialize the memory with is the third operand. Targets that only support the | |
5023 | clearing of memory should reject any value that is not the constant 0. See | |
beed8fc0 | 5024 | @samp{movmem@var{m}} for a discussion of the choice of mode. |
03dda8e3 | 5025 | |
57e84f18 | 5026 | The fourth operand is the known alignment of the destination, in the form |
03dda8e3 RK |
5027 | of a @code{const_int} rtx. Thus, if the compiler knows that the |
5028 | destination is word-aligned, it may provide the value 4 for this | |
5029 | operand. | |
5030 | ||
079a182e JH |
5031 | Optional operands 5 and 6 specify expected alignment and size of block |
5032 | respectively. The expected alignment differs from alignment in operand 4 | |
5033 | in a way that the blocks are not required to be aligned according to it in | |
9946ca2d RA |
5034 | all cases. This expected alignment is also in bytes, just like operand 4. |
5035 | Expected size, when unknown, is set to @code{(const_int -1)}. | |
079a182e | 5036 | |
57e84f18 | 5037 | The use for multiple @code{setmem@var{m}} is as for @code{movmem@var{m}}. |
8c01d9b6 | 5038 | |
40c1d5f8 AS |
5039 | @cindex @code{cmpstrn@var{m}} instruction pattern |
5040 | @item @samp{cmpstrn@var{m}} | |
358b8f01 | 5041 | String compare instruction, with five operands. Operand 0 is the output; |
03dda8e3 | 5042 | it has mode @var{m}. The remaining four operands are like the operands |
70128ad9 | 5043 | of @samp{movmem@var{m}}. The two memory blocks specified are compared |
5cc2f4f3 KG |
5044 | byte by byte in lexicographic order starting at the beginning of each |
5045 | string. The instruction is not allowed to prefetch more than one byte | |
5046 | at a time since either string may end in the first byte and reading past | |
5047 | that may access an invalid page or segment and cause a fault. The | |
9b0f6f5e NC |
5048 | comparison terminates early if the fetched bytes are different or if |
5049 | they are equal to zero. The effect of the instruction is to store a | |
5050 | value in operand 0 whose sign indicates the result of the comparison. | |
03dda8e3 | 5051 | |
40c1d5f8 AS |
5052 | @cindex @code{cmpstr@var{m}} instruction pattern |
5053 | @item @samp{cmpstr@var{m}} | |
5054 | String compare instruction, without known maximum length. Operand 0 is the | |
5055 | output; it has mode @var{m}. The second and third operand are the blocks of | |
5056 | memory to be compared; both are @code{mem:BLK} with an address in mode | |
5057 | @code{Pmode}. | |
5058 | ||
5059 | The fourth operand is the known shared alignment of the source and | |
5060 | destination, in the form of a @code{const_int} rtx. Thus, if the | |
5061 | compiler knows that both source and destination are word-aligned, | |
5062 | it may provide the value 4 for this operand. | |
5063 | ||
5064 | The two memory blocks specified are compared byte by byte in lexicographic | |
5065 | order starting at the beginning of each string. The instruction is not allowed | |
5066 | to prefetch more than one byte at a time since either string may end in the | |
5067 | first byte and reading past that may access an invalid page or segment and | |
9b0f6f5e NC |
5068 | cause a fault. The comparison will terminate when the fetched bytes |
5069 | are different or if they are equal to zero. The effect of the | |
5070 | instruction is to store a value in operand 0 whose sign indicates the | |
5071 | result of the comparison. | |
40c1d5f8 | 5072 | |
358b8f01 JJ |
5073 | @cindex @code{cmpmem@var{m}} instruction pattern |
5074 | @item @samp{cmpmem@var{m}} | |
5075 | Block compare instruction, with five operands like the operands | |
5076 | of @samp{cmpstr@var{m}}. The two memory blocks specified are compared | |
5077 | byte by byte in lexicographic order starting at the beginning of each | |
5078 | block. Unlike @samp{cmpstr@var{m}} the instruction can prefetch | |
9b0f6f5e NC |
5079 | any bytes in the two memory blocks. Also unlike @samp{cmpstr@var{m}} |
5080 | the comparison will not stop if both bytes are zero. The effect of | |
5081 | the instruction is to store a value in operand 0 whose sign indicates | |
5082 | the result of the comparison. | |
358b8f01 | 5083 | |
03dda8e3 RK |
5084 | @cindex @code{strlen@var{m}} instruction pattern |
5085 | @item @samp{strlen@var{m}} | |
5086 | Compute the length of a string, with three operands. | |
5087 | Operand 0 is the result (of mode @var{m}), operand 1 is | |
5088 | a @code{mem} referring to the first character of the string, | |
5089 | operand 2 is the character to search for (normally zero), | |
5090 | and operand 3 is a constant describing the known alignment | |
5091 | of the beginning of the string. | |
5092 | ||
e0d4c0b3 | 5093 | @cindex @code{float@var{m}@var{n}2} instruction pattern |
03dda8e3 RK |
5094 | @item @samp{float@var{m}@var{n}2} |
5095 | Convert signed integer operand 1 (valid for fixed point mode @var{m}) to | |
5096 | floating point mode @var{n} and store in operand 0 (which has mode | |
5097 | @var{n}). | |
5098 | ||
e0d4c0b3 | 5099 | @cindex @code{floatuns@var{m}@var{n}2} instruction pattern |
03dda8e3 RK |
5100 | @item @samp{floatuns@var{m}@var{n}2} |
5101 | Convert unsigned integer operand 1 (valid for fixed point mode @var{m}) | |
5102 | to floating point mode @var{n} and store in operand 0 (which has mode | |
5103 | @var{n}). | |
5104 | ||
e0d4c0b3 | 5105 | @cindex @code{fix@var{m}@var{n}2} instruction pattern |
03dda8e3 RK |
5106 | @item @samp{fix@var{m}@var{n}2} |
5107 | Convert operand 1 (valid for floating point mode @var{m}) to fixed | |
5108 | point mode @var{n} as a signed number and store in operand 0 (which | |
5109 | has mode @var{n}). This instruction's result is defined only when | |
5110 | the value of operand 1 is an integer. | |
5111 | ||
0e1d7f32 AH |
5112 | If the machine description defines this pattern, it also needs to |
5113 | define the @code{ftrunc} pattern. | |
5114 | ||
e0d4c0b3 | 5115 | @cindex @code{fixuns@var{m}@var{n}2} instruction pattern |
03dda8e3 RK |
5116 | @item @samp{fixuns@var{m}@var{n}2} |
5117 | Convert operand 1 (valid for floating point mode @var{m}) to fixed | |
5118 | point mode @var{n} as an unsigned number and store in operand 0 (which | |
5119 | has mode @var{n}). This instruction's result is defined only when the | |
5120 | value of operand 1 is an integer. | |
5121 | ||
5122 | @cindex @code{ftrunc@var{m}2} instruction pattern | |
5123 | @item @samp{ftrunc@var{m}2} | |
5124 | Convert operand 1 (valid for floating point mode @var{m}) to an | |
5125 | integer value, still represented in floating point mode @var{m}, and | |
5126 | store it in operand 0 (valid for floating point mode @var{m}). | |
5127 | ||
e0d4c0b3 | 5128 | @cindex @code{fix_trunc@var{m}@var{n}2} instruction pattern |
03dda8e3 RK |
5129 | @item @samp{fix_trunc@var{m}@var{n}2} |
5130 | Like @samp{fix@var{m}@var{n}2} but works for any floating point value | |
5131 | of mode @var{m} by converting the value to an integer. | |
5132 | ||
e0d4c0b3 | 5133 | @cindex @code{fixuns_trunc@var{m}@var{n}2} instruction pattern |
03dda8e3 RK |
5134 | @item @samp{fixuns_trunc@var{m}@var{n}2} |
5135 | Like @samp{fixuns@var{m}@var{n}2} but works for any floating point | |
5136 | value of mode @var{m} by converting the value to an integer. | |
5137 | ||
e0d4c0b3 | 5138 | @cindex @code{trunc@var{m}@var{n}2} instruction pattern |
03dda8e3 RK |
5139 | @item @samp{trunc@var{m}@var{n}2} |
5140 | Truncate operand 1 (valid for mode @var{m}) to mode @var{n} and | |
5141 | store in operand 0 (which has mode @var{n}). Both modes must be fixed | |
5142 | point or both floating point. | |
5143 | ||
e0d4c0b3 | 5144 | @cindex @code{extend@var{m}@var{n}2} instruction pattern |
03dda8e3 RK |
5145 | @item @samp{extend@var{m}@var{n}2} |
5146 | Sign-extend operand 1 (valid for mode @var{m}) to mode @var{n} and | |
5147 | store in operand 0 (which has mode @var{n}). Both modes must be fixed | |
5148 | point or both floating point. | |
5149 | ||
e0d4c0b3 | 5150 | @cindex @code{zero_extend@var{m}@var{n}2} instruction pattern |
03dda8e3 RK |
5151 | @item @samp{zero_extend@var{m}@var{n}2} |
5152 | Zero-extend operand 1 (valid for mode @var{m}) to mode @var{n} and | |
5153 | store in operand 0 (which has mode @var{n}). Both modes must be fixed | |
5154 | point. | |
5155 | ||
e0d4c0b3 | 5156 | @cindex @code{fract@var{m}@var{n}2} instruction pattern |
0f996086 CF |
5157 | @item @samp{fract@var{m}@var{n}2} |
5158 | Convert operand 1 of mode @var{m} to mode @var{n} and store in | |
5159 | operand 0 (which has mode @var{n}). Mode @var{m} and mode @var{n} | |
5160 | could be fixed-point to fixed-point, signed integer to fixed-point, | |
5161 | fixed-point to signed integer, floating-point to fixed-point, | |
5162 | or fixed-point to floating-point. | |
5163 | When overflows or underflows happen, the results are undefined. | |
5164 | ||
e0d4c0b3 | 5165 | @cindex @code{satfract@var{m}@var{n}2} instruction pattern |
0f996086 CF |
5166 | @item @samp{satfract@var{m}@var{n}2} |
5167 | Convert operand 1 of mode @var{m} to mode @var{n} and store in | |
5168 | operand 0 (which has mode @var{n}). Mode @var{m} and mode @var{n} | |
5169 | could be fixed-point to fixed-point, signed integer to fixed-point, | |
5170 | or floating-point to fixed-point. | |
5171 | When overflows or underflows happen, the instruction saturates the | |
5172 | results to the maximum or the minimum. | |
5173 | ||
e0d4c0b3 | 5174 | @cindex @code{fractuns@var{m}@var{n}2} instruction pattern |
0f996086 CF |
5175 | @item @samp{fractuns@var{m}@var{n}2} |
5176 | Convert operand 1 of mode @var{m} to mode @var{n} and store in | |
5177 | operand 0 (which has mode @var{n}). Mode @var{m} and mode @var{n} | |
5178 | could be unsigned integer to fixed-point, or | |
5179 | fixed-point to unsigned integer. | |
5180 | When overflows or underflows happen, the results are undefined. | |
5181 | ||
e0d4c0b3 | 5182 | @cindex @code{satfractuns@var{m}@var{n}2} instruction pattern |
0f996086 CF |
5183 | @item @samp{satfractuns@var{m}@var{n}2} |
5184 | Convert unsigned integer operand 1 of mode @var{m} to fixed-point mode | |
5185 | @var{n} and store in operand 0 (which has mode @var{n}). | |
5186 | When overflows or underflows happen, the instruction saturates the | |
5187 | results to the maximum or the minimum. | |
5188 | ||
03dda8e3 RK |
5189 | @cindex @code{extv} instruction pattern |
5190 | @item @samp{extv} | |
c771326b | 5191 | Extract a bit-field from operand 1 (a register or memory operand), where |
03dda8e3 RK |
5192 | operand 2 specifies the width in bits and operand 3 the starting bit, |
5193 | and store it in operand 0. Operand 0 must have mode @code{word_mode}. | |
5194 | Operand 1 may have mode @code{byte_mode} or @code{word_mode}; often | |
5195 | @code{word_mode} is allowed only for registers. Operands 2 and 3 must | |
5196 | be valid for @code{word_mode}. | |
5197 | ||
5198 | The RTL generation pass generates this instruction only with constants | |
3ab997e8 | 5199 | for operands 2 and 3 and the constant is never zero for operand 2. |
03dda8e3 RK |
5200 | |
5201 | The bit-field value is sign-extended to a full word integer | |
5202 | before it is stored in operand 0. | |
5203 | ||
5204 | @cindex @code{extzv} instruction pattern | |
5205 | @item @samp{extzv} | |
5206 | Like @samp{extv} except that the bit-field value is zero-extended. | |
5207 | ||
5208 | @cindex @code{insv} instruction pattern | |
5209 | @item @samp{insv} | |
c771326b JM |
5210 | Store operand 3 (which must be valid for @code{word_mode}) into a |
5211 | bit-field in operand 0, where operand 1 specifies the width in bits and | |
03dda8e3 RK |
5212 | operand 2 the starting bit. Operand 0 may have mode @code{byte_mode} or |
5213 | @code{word_mode}; often @code{word_mode} is allowed only for registers. | |
5214 | Operands 1 and 2 must be valid for @code{word_mode}. | |
5215 | ||
5216 | The RTL generation pass generates this instruction only with constants | |
3ab997e8 | 5217 | for operands 1 and 2 and the constant is never zero for operand 1. |
03dda8e3 RK |
5218 | |
5219 | @cindex @code{mov@var{mode}cc} instruction pattern | |
5220 | @item @samp{mov@var{mode}cc} | |
5221 | Conditionally move operand 2 or operand 3 into operand 0 according to the | |
5222 | comparison in operand 1. If the comparison is true, operand 2 is moved | |
5223 | into operand 0, otherwise operand 3 is moved. | |
5224 | ||
5225 | The mode of the operands being compared need not be the same as the operands | |
5226 | being moved. Some machines, sparc64 for example, have instructions that | |
5227 | conditionally move an integer value based on the floating point condition | |
5228 | codes and vice versa. | |
5229 | ||
5230 | If the machine does not have conditional move instructions, do not | |
5231 | define these patterns. | |
5232 | ||
068f5dea | 5233 | @cindex @code{add@var{mode}cc} instruction pattern |
4b5cc2b3 | 5234 | @item @samp{add@var{mode}cc} |
068f5dea JH |
5235 | Similar to @samp{mov@var{mode}cc} but for conditional addition. Conditionally |
5236 | move operand 2 or (operands 2 + operand 3) into operand 0 according to the | |
5237 | comparison in operand 1. If the comparison is true, operand 2 is moved into | |
4b5cc2b3 | 5238 | operand 0, otherwise (operand 2 + operand 3) is moved. |
068f5dea | 5239 | |
f90b7a5a PB |
5240 | @cindex @code{cstore@var{mode}4} instruction pattern |
5241 | @item @samp{cstore@var{mode}4} | |
5242 | Store zero or nonzero in operand 0 according to whether a comparison | |
5243 | is true. Operand 1 is a comparison operator. Operand 2 and operand 3 | |
5244 | are the first and second operand of the comparison, respectively. | |
5245 | You specify the mode that operand 0 must have when you write the | |
5246 | @code{match_operand} expression. The compiler automatically sees which | |
5247 | mode you have used and supplies an operand of that mode. | |
03dda8e3 RK |
5248 | |
5249 | The value stored for a true condition must have 1 as its low bit, or | |
5250 | else must be negative. Otherwise the instruction is not suitable and | |
5251 | you should omit it from the machine description. You describe to the | |
5252 | compiler exactly which value is stored by defining the macro | |
5253 | @code{STORE_FLAG_VALUE} (@pxref{Misc}). If a description cannot be | |
ac5eda13 PB |
5254 | found that can be used for all the possible comparison operators, you |
5255 | should pick one and use a @code{define_expand} to map all results | |
5256 | onto the one you chose. | |
5257 | ||
5258 | These operations may @code{FAIL}, but should do so only in relatively | |
5259 | uncommon cases; if they would @code{FAIL} for common cases involving | |
5260 | integer comparisons, it is best to restrict the predicates to not | |
5261 | allow these operands. Likewise if a given comparison operator will | |
5262 | always fail, independent of the operands (for floating-point modes, the | |
5263 | @code{ordered_comparison_operator} predicate is often useful in this case). | |
5264 | ||
5265 | If this pattern is omitted, the compiler will generate a conditional | |
5266 | branch---for example, it may copy a constant one to the target and branching | |
5267 | around an assignment of zero to the target---or a libcall. If the predicate | |
5268 | for operand 1 only rejects some operators, it will also try reordering the | |
5269 | operands and/or inverting the result value (e.g.@: by an exclusive OR). | |
5270 | These possibilities could be cheaper or equivalent to the instructions | |
5271 | used for the @samp{cstore@var{mode}4} pattern followed by those required | |
5272 | to convert a positive result from @code{STORE_FLAG_VALUE} to 1; in this | |
5273 | case, you can and should make operand 1's predicate reject some operators | |
5274 | in the @samp{cstore@var{mode}4} pattern, or remove the pattern altogether | |
5275 | from the machine description. | |
03dda8e3 | 5276 | |
66c87bae KH |
5277 | @cindex @code{cbranch@var{mode}4} instruction pattern |
5278 | @item @samp{cbranch@var{mode}4} | |
5279 | Conditional branch instruction combined with a compare instruction. | |
5280 | Operand 0 is a comparison operator. Operand 1 and operand 2 are the | |
5281 | first and second operands of the comparison, respectively. Operand 3 | |
5282 | is a @code{label_ref} that refers to the label to jump to. | |
5283 | ||
d26eedb6 HPN |
5284 | @cindex @code{jump} instruction pattern |
5285 | @item @samp{jump} | |
5286 | A jump inside a function; an unconditional branch. Operand 0 is the | |
5287 | @code{label_ref} of the label to jump to. This pattern name is mandatory | |
5288 | on all machines. | |
5289 | ||
03dda8e3 RK |
5290 | @cindex @code{call} instruction pattern |
5291 | @item @samp{call} | |
5292 | Subroutine call instruction returning no value. Operand 0 is the | |
5293 | function to call; operand 1 is the number of bytes of arguments pushed | |
f5963e61 JL |
5294 | as a @code{const_int}; operand 2 is the number of registers used as |
5295 | operands. | |
03dda8e3 RK |
5296 | |
5297 | On most machines, operand 2 is not actually stored into the RTL | |
5298 | pattern. It is supplied for the sake of some RISC machines which need | |
5299 | to put this information into the assembler code; they can put it in | |
5300 | the RTL instead of operand 1. | |
5301 | ||
5302 | Operand 0 should be a @code{mem} RTX whose address is the address of the | |
5303 | function. Note, however, that this address can be a @code{symbol_ref} | |
5304 | expression even if it would not be a legitimate memory address on the | |
5305 | target machine. If it is also not a valid argument for a call | |
5306 | instruction, the pattern for this operation should be a | |
5307 | @code{define_expand} (@pxref{Expander Definitions}) that places the | |
5308 | address into a register and uses that register in the call instruction. | |
5309 | ||
5310 | @cindex @code{call_value} instruction pattern | |
5311 | @item @samp{call_value} | |
5312 | Subroutine call instruction returning a value. Operand 0 is the hard | |
5313 | register in which the value is returned. There are three more | |
5314 | operands, the same as the three operands of the @samp{call} | |
5315 | instruction (but with numbers increased by one). | |
5316 | ||
5317 | Subroutines that return @code{BLKmode} objects use the @samp{call} | |
5318 | insn. | |
5319 | ||
5320 | @cindex @code{call_pop} instruction pattern | |
5321 | @cindex @code{call_value_pop} instruction pattern | |
5322 | @item @samp{call_pop}, @samp{call_value_pop} | |
5323 | Similar to @samp{call} and @samp{call_value}, except used if defined and | |
df2a54e9 | 5324 | if @code{RETURN_POPS_ARGS} is nonzero. They should emit a @code{parallel} |
03dda8e3 RK |
5325 | that contains both the function call and a @code{set} to indicate the |
5326 | adjustment made to the frame pointer. | |
5327 | ||
df2a54e9 | 5328 | For machines where @code{RETURN_POPS_ARGS} can be nonzero, the use of these |
03dda8e3 RK |
5329 | patterns increases the number of functions for which the frame pointer |
5330 | can be eliminated, if desired. | |
5331 | ||
5332 | @cindex @code{untyped_call} instruction pattern | |
5333 | @item @samp{untyped_call} | |
5334 | Subroutine call instruction returning a value of any type. Operand 0 is | |
5335 | the function to call; operand 1 is a memory location where the result of | |
5336 | calling the function is to be stored; operand 2 is a @code{parallel} | |
5337 | expression where each element is a @code{set} expression that indicates | |
5338 | the saving of a function return value into the result block. | |
5339 | ||
5340 | This instruction pattern should be defined to support | |
5341 | @code{__builtin_apply} on machines where special instructions are needed | |
5342 | to call a subroutine with arbitrary arguments or to save the value | |
5343 | returned. This instruction pattern is required on machines that have | |
e979f9e8 JM |
5344 | multiple registers that can hold a return value |
5345 | (i.e.@: @code{FUNCTION_VALUE_REGNO_P} is true for more than one register). | |
03dda8e3 RK |
5346 | |
5347 | @cindex @code{return} instruction pattern | |
5348 | @item @samp{return} | |
5349 | Subroutine return instruction. This instruction pattern name should be | |
5350 | defined only if a single instruction can do all the work of returning | |
5351 | from a function. | |
5352 | ||
5353 | Like the @samp{mov@var{m}} patterns, this pattern is also used after the | |
5354 | RTL generation phase. In this case it is to support machines where | |
5355 | multiple instructions are usually needed to return from a function, but | |
5356 | some class of functions only requires one instruction to implement a | |
5357 | return. Normally, the applicable functions are those which do not need | |
5358 | to save any registers or allocate stack space. | |
5359 | ||
26898771 BS |
5360 | It is valid for this pattern to expand to an instruction using |
5361 | @code{simple_return} if no epilogue is required. | |
5362 | ||
5363 | @cindex @code{simple_return} instruction pattern | |
5364 | @item @samp{simple_return} | |
5365 | Subroutine return instruction. This instruction pattern name should be | |
5366 | defined only if a single instruction can do all the work of returning | |
5367 | from a function on a path where no epilogue is required. This pattern | |
5368 | is very similar to the @code{return} instruction pattern, but it is emitted | |
5369 | only by the shrink-wrapping optimization on paths where the function | |
5370 | prologue has not been executed, and a function return should occur without | |
5371 | any of the effects of the epilogue. Additional uses may be introduced on | |
5372 | paths where both the prologue and the epilogue have executed. | |
5373 | ||
03dda8e3 RK |
5374 | @findex reload_completed |
5375 | @findex leaf_function_p | |
5376 | For such machines, the condition specified in this pattern should only | |
df2a54e9 | 5377 | be true when @code{reload_completed} is nonzero and the function's |
03dda8e3 RK |
5378 | epilogue would only be a single instruction. For machines with register |
5379 | windows, the routine @code{leaf_function_p} may be used to determine if | |
5380 | a register window push is required. | |
5381 | ||
5382 | Machines that have conditional return instructions should define patterns | |
5383 | such as | |
5384 | ||
5385 | @smallexample | |
5386 | (define_insn "" | |
5387 | [(set (pc) | |
5388 | (if_then_else (match_operator | |
5389 | 0 "comparison_operator" | |
5390 | [(cc0) (const_int 0)]) | |
5391 | (return) | |
5392 | (pc)))] | |
5393 | "@var{condition}" | |
5394 | "@dots{}") | |
5395 | @end smallexample | |
5396 | ||
5397 | where @var{condition} would normally be the same condition specified on the | |
5398 | named @samp{return} pattern. | |
5399 | ||
5400 | @cindex @code{untyped_return} instruction pattern | |
5401 | @item @samp{untyped_return} | |
5402 | Untyped subroutine return instruction. This instruction pattern should | |
5403 | be defined to support @code{__builtin_return} on machines where special | |
5404 | instructions are needed to return a value of any type. | |
5405 | ||
5406 | Operand 0 is a memory location where the result of calling a function | |
5407 | with @code{__builtin_apply} is stored; operand 1 is a @code{parallel} | |
5408 | expression where each element is a @code{set} expression that indicates | |
5409 | the restoring of a function return value from the result block. | |
5410 | ||
5411 | @cindex @code{nop} instruction pattern | |
5412 | @item @samp{nop} | |
5413 | No-op instruction. This instruction pattern name should always be defined | |
5414 | to output a no-op in assembler code. @code{(const_int 0)} will do as an | |
5415 | RTL pattern. | |
5416 | ||
5417 | @cindex @code{indirect_jump} instruction pattern | |
5418 | @item @samp{indirect_jump} | |
5419 | An instruction to jump to an address which is operand zero. | |
5420 | This pattern name is mandatory on all machines. | |
5421 | ||
5422 | @cindex @code{casesi} instruction pattern | |
5423 | @item @samp{casesi} | |
5424 | Instruction to jump through a dispatch table, including bounds checking. | |
5425 | This instruction takes five operands: | |
5426 | ||
5427 | @enumerate | |
5428 | @item | |
5429 | The index to dispatch on, which has mode @code{SImode}. | |
5430 | ||
5431 | @item | |
5432 | The lower bound for indices in the table, an integer constant. | |
5433 | ||
5434 | @item | |
5435 | The total range of indices in the table---the largest index | |
5436 | minus the smallest one (both inclusive). | |
5437 | ||
5438 | @item | |
5439 | A label that precedes the table itself. | |
5440 | ||
5441 | @item | |
5442 | A label to jump to if the index has a value outside the bounds. | |
03dda8e3 RK |
5443 | @end enumerate |
5444 | ||
e4ae5e77 | 5445 | The table is an @code{addr_vec} or @code{addr_diff_vec} inside of a |
03dda8e3 RK |
5446 | @code{jump_insn}. The number of elements in the table is one plus the |
5447 | difference between the upper bound and the lower bound. | |
5448 | ||
5449 | @cindex @code{tablejump} instruction pattern | |
5450 | @item @samp{tablejump} | |
5451 | Instruction to jump to a variable address. This is a low-level | |
5452 | capability which can be used to implement a dispatch table when there | |
5453 | is no @samp{casesi} pattern. | |
5454 | ||
5455 | This pattern requires two operands: the address or offset, and a label | |
5456 | which should immediately precede the jump table. If the macro | |
f1f5f142 JL |
5457 | @code{CASE_VECTOR_PC_RELATIVE} evaluates to a nonzero value then the first |
5458 | operand is an offset which counts from the address of the table; otherwise, | |
5459 | it is an absolute address to jump to. In either case, the first operand has | |
03dda8e3 RK |
5460 | mode @code{Pmode}. |
5461 | ||
5462 | The @samp{tablejump} insn is always the last insn before the jump | |
5463 | table it uses. Its assembler code normally has no need to use the | |
5464 | second operand, but you should incorporate it in the RTL pattern so | |
5465 | that the jump optimizer will not delete the table as unreachable code. | |
5466 | ||
6e4fcc95 MH |
5467 | |
5468 | @cindex @code{decrement_and_branch_until_zero} instruction pattern | |
5469 | @item @samp{decrement_and_branch_until_zero} | |
5470 | Conditional branch instruction that decrements a register and | |
df2a54e9 | 5471 | jumps if the register is nonzero. Operand 0 is the register to |
6e4fcc95 | 5472 | decrement and test; operand 1 is the label to jump to if the |
df2a54e9 | 5473 | register is nonzero. @xref{Looping Patterns}. |
6e4fcc95 MH |
5474 | |
5475 | This optional instruction pattern is only used by the combiner, | |
5476 | typically for loops reversed by the loop optimizer when strength | |
5477 | reduction is enabled. | |
5478 | ||
5479 | @cindex @code{doloop_end} instruction pattern | |
5480 | @item @samp{doloop_end} | |
5481 | Conditional branch instruction that decrements a register and jumps if | |
df2a54e9 | 5482 | the register is nonzero. This instruction takes five operands: Operand |
6e4fcc95 MH |
5483 | 0 is the register to decrement and test; operand 1 is the number of loop |
5484 | iterations as a @code{const_int} or @code{const0_rtx} if this cannot be | |
5485 | determined until run-time; operand 2 is the actual or estimated maximum | |
5486 | number of iterations as a @code{const_int}; operand 3 is the number of | |
5487 | enclosed loops as a @code{const_int} (an innermost loop has a value of | |
df2a54e9 | 5488 | 1); operand 4 is the label to jump to if the register is nonzero. |
5c25e11d | 5489 | @xref{Looping Patterns}. |
6e4fcc95 MH |
5490 | |
5491 | This optional instruction pattern should be defined for machines with | |
5492 | low-overhead looping instructions as the loop optimizer will try to | |
5493 | modify suitable loops to utilize it. If nested low-overhead looping is | |
5494 | not supported, use a @code{define_expand} (@pxref{Expander Definitions}) | |
5495 | and make the pattern fail if operand 3 is not @code{const1_rtx}. | |
5496 | Similarly, if the actual or estimated maximum number of iterations is | |
5497 | too large for this instruction, make it fail. | |
5498 | ||
5499 | @cindex @code{doloop_begin} instruction pattern | |
5500 | @item @samp{doloop_begin} | |
5501 | Companion instruction to @code{doloop_end} required for machines that | |
c21cd8b1 JM |
5502 | need to perform some initialization, such as loading special registers |
5503 | used by a low-overhead looping instruction. If initialization insns do | |
6e4fcc95 MH |
5504 | not always need to be emitted, use a @code{define_expand} |
5505 | (@pxref{Expander Definitions}) and make it fail. | |
5506 | ||
5507 | ||
03dda8e3 RK |
5508 | @cindex @code{canonicalize_funcptr_for_compare} instruction pattern |
5509 | @item @samp{canonicalize_funcptr_for_compare} | |
5510 | Canonicalize the function pointer in operand 1 and store the result | |
5511 | into operand 0. | |
5512 | ||
5513 | Operand 0 is always a @code{reg} and has mode @code{Pmode}; operand 1 | |
5514 | may be a @code{reg}, @code{mem}, @code{symbol_ref}, @code{const_int}, etc | |
5515 | and also has mode @code{Pmode}. | |
5516 | ||
5517 | Canonicalization of a function pointer usually involves computing | |
5518 | the address of the function which would be called if the function | |
5519 | pointer were used in an indirect call. | |
5520 | ||
5521 | Only define this pattern if function pointers on the target machine | |
5522 | can have different values but still call the same function when | |
5523 | used in an indirect call. | |
5524 | ||
5525 | @cindex @code{save_stack_block} instruction pattern | |
5526 | @cindex @code{save_stack_function} instruction pattern | |
5527 | @cindex @code{save_stack_nonlocal} instruction pattern | |
5528 | @cindex @code{restore_stack_block} instruction pattern | |
5529 | @cindex @code{restore_stack_function} instruction pattern | |
5530 | @cindex @code{restore_stack_nonlocal} instruction pattern | |
5531 | @item @samp{save_stack_block} | |
5532 | @itemx @samp{save_stack_function} | |
5533 | @itemx @samp{save_stack_nonlocal} | |
5534 | @itemx @samp{restore_stack_block} | |
5535 | @itemx @samp{restore_stack_function} | |
5536 | @itemx @samp{restore_stack_nonlocal} | |
5537 | Most machines save and restore the stack pointer by copying it to or | |
5538 | from an object of mode @code{Pmode}. Do not define these patterns on | |
5539 | such machines. | |
5540 | ||
5541 | Some machines require special handling for stack pointer saves and | |
5542 | restores. On those machines, define the patterns corresponding to the | |
5543 | non-standard cases by using a @code{define_expand} (@pxref{Expander | |
5544 | Definitions}) that produces the required insns. The three types of | |
5545 | saves and restores are: | |
5546 | ||
5547 | @enumerate | |
5548 | @item | |
5549 | @samp{save_stack_block} saves the stack pointer at the start of a block | |
5550 | that allocates a variable-sized object, and @samp{restore_stack_block} | |
5551 | restores the stack pointer when the block is exited. | |
5552 | ||
5553 | @item | |
5554 | @samp{save_stack_function} and @samp{restore_stack_function} do a | |
5555 | similar job for the outermost block of a function and are used when the | |
5556 | function allocates variable-sized objects or calls @code{alloca}. Only | |
5557 | the epilogue uses the restored stack pointer, allowing a simpler save or | |
5558 | restore sequence on some machines. | |
5559 | ||
5560 | @item | |
5561 | @samp{save_stack_nonlocal} is used in functions that contain labels | |
5562 | branched to by nested functions. It saves the stack pointer in such a | |
5563 | way that the inner function can use @samp{restore_stack_nonlocal} to | |
5564 | restore the stack pointer. The compiler generates code to restore the | |
5565 | frame and argument pointer registers, but some machines require saving | |
5566 | and restoring additional data such as register window information or | |
5567 | stack backchains. Place insns in these patterns to save and restore any | |
5568 | such required data. | |
5569 | @end enumerate | |
5570 | ||
5571 | When saving the stack pointer, operand 0 is the save area and operand 1 | |
73c8090f DE |
5572 | is the stack pointer. The mode used to allocate the save area defaults |
5573 | to @code{Pmode} but you can override that choice by defining the | |
7e390c9d | 5574 | @code{STACK_SAVEAREA_MODE} macro (@pxref{Storage Layout}). You must |
73c8090f DE |
5575 | specify an integral mode, or @code{VOIDmode} if no save area is needed |
5576 | for a particular type of save (either because no save is needed or | |
5577 | because a machine-specific save area can be used). Operand 0 is the | |
5578 | stack pointer and operand 1 is the save area for restore operations. If | |
5579 | @samp{save_stack_block} is defined, operand 0 must not be | |
5580 | @code{VOIDmode} since these saves can be arbitrarily nested. | |
03dda8e3 RK |
5581 | |
5582 | A save area is a @code{mem} that is at a constant offset from | |
5583 | @code{virtual_stack_vars_rtx} when the stack pointer is saved for use by | |
5584 | nonlocal gotos and a @code{reg} in the other two cases. | |
5585 | ||
5586 | @cindex @code{allocate_stack} instruction pattern | |
5587 | @item @samp{allocate_stack} | |
72938a4c | 5588 | Subtract (or add if @code{STACK_GROWS_DOWNWARD} is undefined) operand 1 from |
03dda8e3 RK |
5589 | the stack pointer to create space for dynamically allocated data. |
5590 | ||
72938a4c MM |
5591 | Store the resultant pointer to this space into operand 0. If you |
5592 | are allocating space from the main stack, do this by emitting a | |
5593 | move insn to copy @code{virtual_stack_dynamic_rtx} to operand 0. | |
5594 | If you are allocating the space elsewhere, generate code to copy the | |
5595 | location of the space to operand 0. In the latter case, you must | |
956d6950 | 5596 | ensure this space gets freed when the corresponding space on the main |
72938a4c MM |
5597 | stack is free. |
5598 | ||
03dda8e3 RK |
5599 | Do not define this pattern if all that must be done is the subtraction. |
5600 | Some machines require other operations such as stack probes or | |
5601 | maintaining the back chain. Define this pattern to emit those | |
5602 | operations in addition to updating the stack pointer. | |
5603 | ||
861bb6c1 JL |
5604 | @cindex @code{check_stack} instruction pattern |
5605 | @item @samp{check_stack} | |
507d0069 EB |
5606 | If stack checking (@pxref{Stack Checking}) cannot be done on your system by |
5607 | probing the stack, define this pattern to perform the needed check and signal | |
5608 | an error if the stack has overflowed. The single operand is the address in | |
5609 | the stack farthest from the current stack pointer that you need to validate. | |
5610 | Normally, on platforms where this pattern is needed, you would obtain the | |
5611 | stack limit from a global or thread-specific variable or register. | |
d809253a EB |
5612 | |
5613 | @cindex @code{probe_stack} instruction pattern | |
5614 | @item @samp{probe_stack} | |
507d0069 EB |
5615 | If stack checking (@pxref{Stack Checking}) can be done on your system by |
5616 | probing the stack but doing it with a ``store zero'' instruction is not valid | |
5617 | or optimal, define this pattern to do the probing differently and signal an | |
5618 | error if the stack has overflowed. The single operand is the memory reference | |
5619 | in the stack that needs to be probed. | |
861bb6c1 | 5620 | |
03dda8e3 RK |
5621 | @cindex @code{nonlocal_goto} instruction pattern |
5622 | @item @samp{nonlocal_goto} | |
5623 | Emit code to generate a non-local goto, e.g., a jump from one function | |
5624 | to a label in an outer function. This pattern has four arguments, | |
5625 | each representing a value to be used in the jump. The first | |
45bb86fd | 5626 | argument is to be loaded into the frame pointer, the second is |
03dda8e3 RK |
5627 | the address to branch to (code to dispatch to the actual label), |
5628 | the third is the address of a location where the stack is saved, | |
5629 | and the last is the address of the label, to be placed in the | |
5630 | location for the incoming static chain. | |
5631 | ||
f0523f02 | 5632 | On most machines you need not define this pattern, since GCC will |
03dda8e3 RK |
5633 | already generate the correct code, which is to load the frame pointer |
5634 | and static chain, restore the stack (using the | |
5635 | @samp{restore_stack_nonlocal} pattern, if defined), and jump indirectly | |
5636 | to the dispatcher. You need only define this pattern if this code will | |
5637 | not work on your machine. | |
5638 | ||
5639 | @cindex @code{nonlocal_goto_receiver} instruction pattern | |
5640 | @item @samp{nonlocal_goto_receiver} | |
5641 | This pattern, if defined, contains code needed at the target of a | |
161d7b59 | 5642 | nonlocal goto after the code already generated by GCC@. You will not |
03dda8e3 RK |
5643 | normally need to define this pattern. A typical reason why you might |
5644 | need this pattern is if some value, such as a pointer to a global table, | |
c30ddbc9 | 5645 | must be restored when the frame pointer is restored. Note that a nonlocal |
89bcce1b | 5646 | goto only occurs within a unit-of-translation, so a global table pointer |
c30ddbc9 RH |
5647 | that is shared by all functions of a given module need not be restored. |
5648 | There are no arguments. | |
861bb6c1 JL |
5649 | |
5650 | @cindex @code{exception_receiver} instruction pattern | |
5651 | @item @samp{exception_receiver} | |
5652 | This pattern, if defined, contains code needed at the site of an | |
5653 | exception handler that isn't needed at the site of a nonlocal goto. You | |
5654 | will not normally need to define this pattern. A typical reason why you | |
5655 | might need this pattern is if some value, such as a pointer to a global | |
5656 | table, must be restored after control flow is branched to the handler of | |
5657 | an exception. There are no arguments. | |
c85f7c16 | 5658 | |
c30ddbc9 RH |
5659 | @cindex @code{builtin_setjmp_setup} instruction pattern |
5660 | @item @samp{builtin_setjmp_setup} | |
5661 | This pattern, if defined, contains additional code needed to initialize | |
5662 | the @code{jmp_buf}. You will not normally need to define this pattern. | |
5663 | A typical reason why you might need this pattern is if some value, such | |
5664 | as a pointer to a global table, must be restored. Though it is | |
5665 | preferred that the pointer value be recalculated if possible (given the | |
5666 | address of a label for instance). The single argument is a pointer to | |
5667 | the @code{jmp_buf}. Note that the buffer is five words long and that | |
5668 | the first three are normally used by the generic mechanism. | |
5669 | ||
c85f7c16 JL |
5670 | @cindex @code{builtin_setjmp_receiver} instruction pattern |
5671 | @item @samp{builtin_setjmp_receiver} | |
e4ae5e77 | 5672 | This pattern, if defined, contains code needed at the site of a |
c771326b | 5673 | built-in setjmp that isn't needed at the site of a nonlocal goto. You |
c85f7c16 JL |
5674 | will not normally need to define this pattern. A typical reason why you |
5675 | might need this pattern is if some value, such as a pointer to a global | |
c30ddbc9 RH |
5676 | table, must be restored. It takes one argument, which is the label |
5677 | to which builtin_longjmp transfered control; this pattern may be emitted | |
5678 | at a small offset from that label. | |
5679 | ||
5680 | @cindex @code{builtin_longjmp} instruction pattern | |
5681 | @item @samp{builtin_longjmp} | |
5682 | This pattern, if defined, performs the entire action of the longjmp. | |
5683 | You will not normally need to define this pattern unless you also define | |
5684 | @code{builtin_setjmp_setup}. The single argument is a pointer to the | |
5685 | @code{jmp_buf}. | |
f69864aa | 5686 | |
52a11cbf RH |
5687 | @cindex @code{eh_return} instruction pattern |
5688 | @item @samp{eh_return} | |
f69864aa | 5689 | This pattern, if defined, affects the way @code{__builtin_eh_return}, |
52a11cbf RH |
5690 | and thence the call frame exception handling library routines, are |
5691 | built. It is intended to handle non-trivial actions needed along | |
5692 | the abnormal return path. | |
5693 | ||
34dc173c | 5694 | The address of the exception handler to which the function should return |
daf2f129 | 5695 | is passed as operand to this pattern. It will normally need to copied by |
34dc173c UW |
5696 | the pattern to some special register or memory location. |
5697 | If the pattern needs to determine the location of the target call | |
5698 | frame in order to do so, it may use @code{EH_RETURN_STACKADJ_RTX}, | |
5699 | if defined; it will have already been assigned. | |
5700 | ||
5701 | If this pattern is not defined, the default action will be to simply | |
5702 | copy the return address to @code{EH_RETURN_HANDLER_RTX}. Either | |
5703 | that macro or this pattern needs to be defined if call frame exception | |
5704 | handling is to be used. | |
0b433de6 JL |
5705 | |
5706 | @cindex @code{prologue} instruction pattern | |
17b53c33 | 5707 | @anchor{prologue instruction pattern} |
0b433de6 JL |
5708 | @item @samp{prologue} |
5709 | This pattern, if defined, emits RTL for entry to a function. The function | |
b192711e | 5710 | entry is responsible for setting up the stack frame, initializing the frame |
0b433de6 JL |
5711 | pointer register, saving callee saved registers, etc. |
5712 | ||
5713 | Using a prologue pattern is generally preferred over defining | |
17b53c33 | 5714 | @code{TARGET_ASM_FUNCTION_PROLOGUE} to emit assembly code for the prologue. |
0b433de6 JL |
5715 | |
5716 | The @code{prologue} pattern is particularly useful for targets which perform | |
5717 | instruction scheduling. | |
5718 | ||
12c5ffe5 EB |
5719 | @cindex @code{window_save} instruction pattern |
5720 | @anchor{window_save instruction pattern} | |
5721 | @item @samp{window_save} | |
5722 | This pattern, if defined, emits RTL for a register window save. It should | |
5723 | be defined if the target machine has register windows but the window events | |
5724 | are decoupled from calls to subroutines. The canonical example is the SPARC | |
5725 | architecture. | |
5726 | ||
0b433de6 | 5727 | @cindex @code{epilogue} instruction pattern |
17b53c33 | 5728 | @anchor{epilogue instruction pattern} |
0b433de6 | 5729 | @item @samp{epilogue} |
396ad517 | 5730 | This pattern emits RTL for exit from a function. The function |
b192711e | 5731 | exit is responsible for deallocating the stack frame, restoring callee saved |
0b433de6 JL |
5732 | registers and emitting the return instruction. |
5733 | ||
5734 | Using an epilogue pattern is generally preferred over defining | |
17b53c33 | 5735 | @code{TARGET_ASM_FUNCTION_EPILOGUE} to emit assembly code for the epilogue. |
0b433de6 JL |
5736 | |
5737 | The @code{epilogue} pattern is particularly useful for targets which perform | |
5738 | instruction scheduling or which have delay slots for their return instruction. | |
5739 | ||
5740 | @cindex @code{sibcall_epilogue} instruction pattern | |
5741 | @item @samp{sibcall_epilogue} | |
5742 | This pattern, if defined, emits RTL for exit from a function without the final | |
5743 | branch back to the calling function. This pattern will be emitted before any | |
5744 | sibling call (aka tail call) sites. | |
5745 | ||
5746 | The @code{sibcall_epilogue} pattern must not clobber any arguments used for | |
5747 | parameter passing or any stack slots for arguments passed to the current | |
ebb48a4d | 5748 | function. |
a157febd GK |
5749 | |
5750 | @cindex @code{trap} instruction pattern | |
5751 | @item @samp{trap} | |
5752 | This pattern, if defined, signals an error, typically by causing some | |
5753 | kind of signal to be raised. Among other places, it is used by the Java | |
c771326b | 5754 | front end to signal `invalid array index' exceptions. |
a157febd | 5755 | |
f90b7a5a PB |
5756 | @cindex @code{ctrap@var{MM}4} instruction pattern |
5757 | @item @samp{ctrap@var{MM}4} | |
a157febd | 5758 | Conditional trap instruction. Operand 0 is a piece of RTL which |
f90b7a5a PB |
5759 | performs a comparison, and operands 1 and 2 are the arms of the |
5760 | comparison. Operand 3 is the trap code, an integer. | |
a157febd | 5761 | |
f90b7a5a | 5762 | A typical @code{ctrap} pattern looks like |
a157febd GK |
5763 | |
5764 | @smallexample | |
f90b7a5a | 5765 | (define_insn "ctrapsi4" |
ebb48a4d | 5766 | [(trap_if (match_operator 0 "trap_operator" |
f90b7a5a | 5767 | [(match_operand 1 "register_operand") |
73b8bfe1 | 5768 | (match_operand 2 "immediate_operand")]) |
f90b7a5a | 5769 | (match_operand 3 "const_int_operand" "i"))] |
a157febd GK |
5770 | "" |
5771 | "@dots{}") | |
5772 | @end smallexample | |
5773 | ||
e83d297b JJ |
5774 | @cindex @code{prefetch} instruction pattern |
5775 | @item @samp{prefetch} | |
5776 | ||
5777 | This pattern, if defined, emits code for a non-faulting data prefetch | |
5778 | instruction. Operand 0 is the address of the memory to prefetch. Operand 1 | |
5779 | is a constant 1 if the prefetch is preparing for a write to the memory | |
5780 | address, or a constant 0 otherwise. Operand 2 is the expected degree of | |
5781 | temporal locality of the data and is a value between 0 and 3, inclusive; 0 | |
5782 | means that the data has no temporal locality, so it need not be left in the | |
5783 | cache after the access; 3 means that the data has a high degree of temporal | |
5784 | locality and should be left in all levels of cache possible; 1 and 2 mean, | |
5785 | respectively, a low or moderate degree of temporal locality. | |
5786 | ||
5787 | Targets that do not support write prefetches or locality hints can ignore | |
5788 | the values of operands 1 and 2. | |
5789 | ||
b6bd3371 DE |
5790 | @cindex @code{blockage} instruction pattern |
5791 | @item @samp{blockage} | |
5792 | ||
5793 | This pattern defines a pseudo insn that prevents the instruction | |
5794 | scheduler from moving instructions across the boundary defined by the | |
5795 | blockage insn. Normally an UNSPEC_VOLATILE pattern. | |
5796 | ||
48ae6c13 RH |
5797 | @cindex @code{memory_barrier} instruction pattern |
5798 | @item @samp{memory_barrier} | |
5799 | ||
5800 | If the target memory model is not fully synchronous, then this pattern | |
5801 | should be defined to an instruction that orders both loads and stores | |
5802 | before the instruction with respect to loads and stores after the instruction. | |
5803 | This pattern has no operands. | |
5804 | ||
5805 | @cindex @code{sync_compare_and_swap@var{mode}} instruction pattern | |
5806 | @item @samp{sync_compare_and_swap@var{mode}} | |
5807 | ||
5808 | This pattern, if defined, emits code for an atomic compare-and-swap | |
5809 | operation. Operand 1 is the memory on which the atomic operation is | |
5810 | performed. Operand 2 is the ``old'' value to be compared against the | |
5811 | current contents of the memory location. Operand 3 is the ``new'' value | |
5812 | to store in the memory if the compare succeeds. Operand 0 is the result | |
915167f5 GK |
5813 | of the operation; it should contain the contents of the memory |
5814 | before the operation. If the compare succeeds, this should obviously be | |
5815 | a copy of operand 2. | |
48ae6c13 RH |
5816 | |
5817 | This pattern must show that both operand 0 and operand 1 are modified. | |
5818 | ||
915167f5 GK |
5819 | This pattern must issue any memory barrier instructions such that all |
5820 | memory operations before the atomic operation occur before the atomic | |
5821 | operation and all memory operations after the atomic operation occur | |
5822 | after the atomic operation. | |
48ae6c13 | 5823 | |
4a77c72b | 5824 | For targets where the success or failure of the compare-and-swap |
f90b7a5a PB |
5825 | operation is available via the status flags, it is possible to |
5826 | avoid a separate compare operation and issue the subsequent | |
5827 | branch or store-flag operation immediately after the compare-and-swap. | |
5828 | To this end, GCC will look for a @code{MODE_CC} set in the | |
5829 | output of @code{sync_compare_and_swap@var{mode}}; if the machine | |
5830 | description includes such a set, the target should also define special | |
5831 | @code{cbranchcc4} and/or @code{cstorecc4} instructions. GCC will then | |
5832 | be able to take the destination of the @code{MODE_CC} set and pass it | |
5833 | to the @code{cbranchcc4} or @code{cstorecc4} pattern as the first | |
5834 | operand of the comparison (the second will be @code{(const_int 0)}). | |
48ae6c13 | 5835 | |
cedb4a1a RH |
5836 | For targets where the operating system may provide support for this |
5837 | operation via library calls, the @code{sync_compare_and_swap_optab} | |
5838 | may be initialized to a function with the same interface as the | |
5839 | @code{__sync_val_compare_and_swap_@var{n}} built-in. If the entire | |
5840 | set of @var{__sync} builtins are supported via library calls, the | |
5841 | target can initialize all of the optabs at once with | |
5842 | @code{init_sync_libfuncs}. | |
5843 | For the purposes of C++11 @code{std::atomic::is_lock_free}, it is | |
5844 | assumed that these library calls do @emph{not} use any kind of | |
5845 | interruptable locking. | |
5846 | ||
48ae6c13 RH |
5847 | @cindex @code{sync_add@var{mode}} instruction pattern |
5848 | @cindex @code{sync_sub@var{mode}} instruction pattern | |
5849 | @cindex @code{sync_ior@var{mode}} instruction pattern | |
5850 | @cindex @code{sync_and@var{mode}} instruction pattern | |
5851 | @cindex @code{sync_xor@var{mode}} instruction pattern | |
5852 | @cindex @code{sync_nand@var{mode}} instruction pattern | |
5853 | @item @samp{sync_add@var{mode}}, @samp{sync_sub@var{mode}} | |
5854 | @itemx @samp{sync_ior@var{mode}}, @samp{sync_and@var{mode}} | |
5855 | @itemx @samp{sync_xor@var{mode}}, @samp{sync_nand@var{mode}} | |
5856 | ||
5857 | These patterns emit code for an atomic operation on memory. | |
5858 | Operand 0 is the memory on which the atomic operation is performed. | |
5859 | Operand 1 is the second operand to the binary operator. | |
5860 | ||
915167f5 GK |
5861 | This pattern must issue any memory barrier instructions such that all |
5862 | memory operations before the atomic operation occur before the atomic | |
5863 | operation and all memory operations after the atomic operation occur | |
5864 | after the atomic operation. | |
48ae6c13 RH |
5865 | |
5866 | If these patterns are not defined, the operation will be constructed | |
5867 | from a compare-and-swap operation, if defined. | |
5868 | ||
5869 | @cindex @code{sync_old_add@var{mode}} instruction pattern | |
5870 | @cindex @code{sync_old_sub@var{mode}} instruction pattern | |
5871 | @cindex @code{sync_old_ior@var{mode}} instruction pattern | |
5872 | @cindex @code{sync_old_and@var{mode}} instruction pattern | |
5873 | @cindex @code{sync_old_xor@var{mode}} instruction pattern | |
5874 | @cindex @code{sync_old_nand@var{mode}} instruction pattern | |
5875 | @item @samp{sync_old_add@var{mode}}, @samp{sync_old_sub@var{mode}} | |
5876 | @itemx @samp{sync_old_ior@var{mode}}, @samp{sync_old_and@var{mode}} | |
5877 | @itemx @samp{sync_old_xor@var{mode}}, @samp{sync_old_nand@var{mode}} | |
5878 | ||
5879 | These patterns are emit code for an atomic operation on memory, | |
5880 | and return the value that the memory contained before the operation. | |
5881 | Operand 0 is the result value, operand 1 is the memory on which the | |
5882 | atomic operation is performed, and operand 2 is the second operand | |
5883 | to the binary operator. | |
5884 | ||
915167f5 GK |
5885 | This pattern must issue any memory barrier instructions such that all |
5886 | memory operations before the atomic operation occur before the atomic | |
5887 | operation and all memory operations after the atomic operation occur | |
5888 | after the atomic operation. | |
48ae6c13 RH |
5889 | |
5890 | If these patterns are not defined, the operation will be constructed | |
5891 | from a compare-and-swap operation, if defined. | |
5892 | ||
5893 | @cindex @code{sync_new_add@var{mode}} instruction pattern | |
5894 | @cindex @code{sync_new_sub@var{mode}} instruction pattern | |
5895 | @cindex @code{sync_new_ior@var{mode}} instruction pattern | |
5896 | @cindex @code{sync_new_and@var{mode}} instruction pattern | |
5897 | @cindex @code{sync_new_xor@var{mode}} instruction pattern | |
5898 | @cindex @code{sync_new_nand@var{mode}} instruction pattern | |
5899 | @item @samp{sync_new_add@var{mode}}, @samp{sync_new_sub@var{mode}} | |
5900 | @itemx @samp{sync_new_ior@var{mode}}, @samp{sync_new_and@var{mode}} | |
5901 | @itemx @samp{sync_new_xor@var{mode}}, @samp{sync_new_nand@var{mode}} | |
5902 | ||
5903 | These patterns are like their @code{sync_old_@var{op}} counterparts, | |
5904 | except that they return the value that exists in the memory location | |
5905 | after the operation, rather than before the operation. | |
5906 | ||
5907 | @cindex @code{sync_lock_test_and_set@var{mode}} instruction pattern | |
5908 | @item @samp{sync_lock_test_and_set@var{mode}} | |
5909 | ||
5910 | This pattern takes two forms, based on the capabilities of the target. | |
5911 | In either case, operand 0 is the result of the operand, operand 1 is | |
5912 | the memory on which the atomic operation is performed, and operand 2 | |
5913 | is the value to set in the lock. | |
5914 | ||
5915 | In the ideal case, this operation is an atomic exchange operation, in | |
5916 | which the previous value in memory operand is copied into the result | |
5917 | operand, and the value operand is stored in the memory operand. | |
5918 | ||
5919 | For less capable targets, any value operand that is not the constant 1 | |
5920 | should be rejected with @code{FAIL}. In this case the target may use | |
5921 | an atomic test-and-set bit operation. The result operand should contain | |
5922 | 1 if the bit was previously set and 0 if the bit was previously clear. | |
5923 | The true contents of the memory operand are implementation defined. | |
5924 | ||
5925 | This pattern must issue any memory barrier instructions such that the | |
915167f5 GK |
5926 | pattern as a whole acts as an acquire barrier, that is all memory |
5927 | operations after the pattern do not occur until the lock is acquired. | |
48ae6c13 RH |
5928 | |
5929 | If this pattern is not defined, the operation will be constructed from | |
5930 | a compare-and-swap operation, if defined. | |
5931 | ||
5932 | @cindex @code{sync_lock_release@var{mode}} instruction pattern | |
5933 | @item @samp{sync_lock_release@var{mode}} | |
5934 | ||
5935 | This pattern, if defined, releases a lock set by | |
5936 | @code{sync_lock_test_and_set@var{mode}}. Operand 0 is the memory | |
8635a919 GK |
5937 | that contains the lock; operand 1 is the value to store in the lock. |
5938 | ||
5939 | If the target doesn't implement full semantics for | |
5940 | @code{sync_lock_test_and_set@var{mode}}, any value operand which is not | |
5941 | the constant 0 should be rejected with @code{FAIL}, and the true contents | |
5942 | of the memory operand are implementation defined. | |
48ae6c13 RH |
5943 | |
5944 | This pattern must issue any memory barrier instructions such that the | |
915167f5 GK |
5945 | pattern as a whole acts as a release barrier, that is the lock is |
5946 | released only after all previous memory operations have completed. | |
48ae6c13 RH |
5947 | |
5948 | If this pattern is not defined, then a @code{memory_barrier} pattern | |
8635a919 | 5949 | will be emitted, followed by a store of the value to the memory operand. |
48ae6c13 | 5950 | |
86951993 AM |
5951 | @cindex @code{atomic_compare_and_swap@var{mode}} instruction pattern |
5952 | @item @samp{atomic_compare_and_swap@var{mode}} | |
5953 | This pattern, if defined, emits code for an atomic compare-and-swap | |
5954 | operation with memory model semantics. Operand 2 is the memory on which | |
5955 | the atomic operation is performed. Operand 0 is an output operand which | |
5956 | is set to true or false based on whether the operation succeeded. Operand | |
5957 | 1 is an output operand which is set to the contents of the memory before | |
5958 | the operation was attempted. Operand 3 is the value that is expected to | |
5959 | be in memory. Operand 4 is the value to put in memory if the expected | |
5960 | value is found there. Operand 5 is set to 1 if this compare and swap is to | |
5961 | be treated as a weak operation. Operand 6 is the memory model to be used | |
5962 | if the operation is a success. Operand 7 is the memory model to be used | |
5963 | if the operation fails. | |
5964 | ||
5965 | If memory referred to in operand 2 contains the value in operand 3, then | |
5966 | operand 4 is stored in memory pointed to by operand 2 and fencing based on | |
5967 | the memory model in operand 6 is issued. | |
5968 | ||
5969 | If memory referred to in operand 2 does not contain the value in operand 3, | |
5970 | then fencing based on the memory model in operand 7 is issued. | |
5971 | ||
5972 | If a target does not support weak compare-and-swap operations, or the port | |
5973 | elects not to implement weak operations, the argument in operand 5 can be | |
5974 | ignored. Note a strong implementation must be provided. | |
5975 | ||
5976 | If this pattern is not provided, the @code{__atomic_compare_exchange} | |
5977 | built-in functions will utilize the legacy @code{sync_compare_and_swap} | |
5978 | pattern with an @code{__ATOMIC_SEQ_CST} memory model. | |
5979 | ||
5980 | @cindex @code{atomic_load@var{mode}} instruction pattern | |
5981 | @item @samp{atomic_load@var{mode}} | |
5982 | This pattern implements an atomic load operation with memory model | |
5983 | semantics. Operand 1 is the memory address being loaded from. Operand 0 | |
5984 | is the result of the load. Operand 2 is the memory model to be used for | |
5985 | the load operation. | |
5986 | ||
5987 | If not present, the @code{__atomic_load} built-in function will either | |
5988 | resort to a normal load with memory barriers, or a compare-and-swap | |
5989 | operation if a normal load would not be atomic. | |
5990 | ||
5991 | @cindex @code{atomic_store@var{mode}} instruction pattern | |
5992 | @item @samp{atomic_store@var{mode}} | |
5993 | This pattern implements an atomic store operation with memory model | |
5994 | semantics. Operand 0 is the memory address being stored to. Operand 1 | |
5995 | is the value to be written. Operand 2 is the memory model to be used for | |
5996 | the operation. | |
5997 | ||
5998 | If not present, the @code{__atomic_store} built-in function will attempt to | |
5999 | perform a normal store and surround it with any required memory fences. If | |
6000 | the store would not be atomic, then an @code{__atomic_exchange} is | |
6001 | attempted with the result being ignored. | |
6002 | ||
6003 | @cindex @code{atomic_exchange@var{mode}} instruction pattern | |
6004 | @item @samp{atomic_exchange@var{mode}} | |
6005 | This pattern implements an atomic exchange operation with memory model | |
6006 | semantics. Operand 1 is the memory location the operation is performed on. | |
6007 | Operand 0 is an output operand which is set to the original value contained | |
6008 | in the memory pointed to by operand 1. Operand 2 is the value to be | |
6009 | stored. Operand 3 is the memory model to be used. | |
6010 | ||
6011 | If this pattern is not present, the built-in function | |
6012 | @code{__atomic_exchange} will attempt to preform the operation with a | |
6013 | compare and swap loop. | |
6014 | ||
6015 | @cindex @code{atomic_add@var{mode}} instruction pattern | |
6016 | @cindex @code{atomic_sub@var{mode}} instruction pattern | |
6017 | @cindex @code{atomic_or@var{mode}} instruction pattern | |
6018 | @cindex @code{atomic_and@var{mode}} instruction pattern | |
6019 | @cindex @code{atomic_xor@var{mode}} instruction pattern | |
6020 | @cindex @code{atomic_nand@var{mode}} instruction pattern | |
6021 | @item @samp{atomic_add@var{mode}}, @samp{atomic_sub@var{mode}} | |
6022 | @itemx @samp{atomic_or@var{mode}}, @samp{atomic_and@var{mode}} | |
6023 | @itemx @samp{atomic_xor@var{mode}}, @samp{atomic_nand@var{mode}} | |
6024 | ||
6025 | These patterns emit code for an atomic operation on memory with memory | |
6026 | model semantics. Operand 0 is the memory on which the atomic operation is | |
6027 | performed. Operand 1 is the second operand to the binary operator. | |
6028 | Operand 2 is the memory model to be used by the operation. | |
6029 | ||
6030 | If these patterns are not defined, attempts will be made to use legacy | |
6031 | @code{sync} patterns, or equivilent patterns which return a result. If | |
6032 | none of these are available a compare-and-swap loop will be used. | |
6033 | ||
6034 | @cindex @code{atomic_fetch_add@var{mode}} instruction pattern | |
6035 | @cindex @code{atomic_fetch_sub@var{mode}} instruction pattern | |
6036 | @cindex @code{atomic_fetch_or@var{mode}} instruction pattern | |
6037 | @cindex @code{atomic_fetch_and@var{mode}} instruction pattern | |
6038 | @cindex @code{atomic_fetch_xor@var{mode}} instruction pattern | |
6039 | @cindex @code{atomic_fetch_nand@var{mode}} instruction pattern | |
6040 | @item @samp{atomic_fetch_add@var{mode}}, @samp{atomic_fetch_sub@var{mode}} | |
6041 | @itemx @samp{atomic_fetch_or@var{mode}}, @samp{atomic_fetch_and@var{mode}} | |
6042 | @itemx @samp{atomic_fetch_xor@var{mode}}, @samp{atomic_fetch_nand@var{mode}} | |
6043 | ||
6044 | These patterns emit code for an atomic operation on memory with memory | |
6045 | model semantics, and return the original value. Operand 0 is an output | |
6046 | operand which contains the value of the memory location before the | |
6047 | operation was performed. Operand 1 is the memory on which the atomic | |
6048 | operation is performed. Operand 2 is the second operand to the binary | |
6049 | operator. Operand 3 is the memory model to be used by the operation. | |
6050 | ||
6051 | If these patterns are not defined, attempts will be made to use legacy | |
6052 | @code{sync} patterns. If none of these are available a compare-and-swap | |
6053 | loop will be used. | |
6054 | ||
6055 | @cindex @code{atomic_add_fetch@var{mode}} instruction pattern | |
6056 | @cindex @code{atomic_sub_fetch@var{mode}} instruction pattern | |
6057 | @cindex @code{atomic_or_fetch@var{mode}} instruction pattern | |
6058 | @cindex @code{atomic_and_fetch@var{mode}} instruction pattern | |
6059 | @cindex @code{atomic_xor_fetch@var{mode}} instruction pattern | |
6060 | @cindex @code{atomic_nand_fetch@var{mode}} instruction pattern | |
6061 | @item @samp{atomic_add_fetch@var{mode}}, @samp{atomic_sub_fetch@var{mode}} | |
6062 | @itemx @samp{atomic_or_fetch@var{mode}}, @samp{atomic_and_fetch@var{mode}} | |
6063 | @itemx @samp{atomic_xor_fetch@var{mode}}, @samp{atomic_nand_fetch@var{mode}} | |
6064 | ||
6065 | These patterns emit code for an atomic operation on memory with memory | |
6066 | model semantics and return the result after the operation is performed. | |
6067 | Operand 0 is an output operand which contains the value after the | |
6068 | operation. Operand 1 is the memory on which the atomic operation is | |
6069 | performed. Operand 2 is the second operand to the binary operator. | |
6070 | Operand 3 is the memory model to be used by the operation. | |
6071 | ||
6072 | If these patterns are not defined, attempts will be made to use legacy | |
6073 | @code{sync} patterns, or equivilent patterns which return the result before | |
6074 | the operation followed by the arithmetic operation required to produce the | |
6075 | result. If none of these are available a compare-and-swap loop will be | |
6076 | used. | |
6077 | ||
f8a27aa6 RH |
6078 | @cindex @code{atomic_test_and_set} instruction pattern |
6079 | @item @samp{atomic_test_and_set} | |
6080 | ||
6081 | This pattern emits code for @code{__builtin_atomic_test_and_set}. | |
6082 | Operand 0 is an output operand which is set to true if the previous | |
6083 | previous contents of the byte was "set", and false otherwise. Operand 1 | |
6084 | is the @code{QImode} memory to be modified. Operand 2 is the memory | |
6085 | model to be used. | |
6086 | ||
6087 | The specific value that defines "set" is implementation defined, and | |
6088 | is normally based on what is performed by the native atomic test and set | |
6089 | instruction. | |
6090 | ||
86951993 AM |
6091 | @cindex @code{mem_thread_fence@var{mode}} instruction pattern |
6092 | @item @samp{mem_thread_fence@var{mode}} | |
6093 | This pattern emits code required to implement a thread fence with | |
6094 | memory model semantics. Operand 0 is the memory model to be used. | |
6095 | ||
6096 | If this pattern is not specified, all memory models except | |
6097 | @code{__ATOMIC_RELAXED} will result in issuing a @code{sync_synchronize} | |
6098 | barrier pattern. | |
6099 | ||
6100 | @cindex @code{mem_signal_fence@var{mode}} instruction pattern | |
6101 | @item @samp{mem_signal_fence@var{mode}} | |
6102 | This pattern emits code required to implement a signal fence with | |
6103 | memory model semantics. Operand 0 is the memory model to be used. | |
6104 | ||
6105 | This pattern should impact the compiler optimizers the same way that | |
6106 | mem_signal_fence does, but it does not need to issue any barrier | |
6107 | instructions. | |
6108 | ||
6109 | If this pattern is not specified, all memory models except | |
6110 | @code{__ATOMIC_RELAXED} will result in issuing a @code{sync_synchronize} | |
6111 | barrier pattern. | |
6112 | ||
7d69de61 RH |
6113 | @cindex @code{stack_protect_set} instruction pattern |
6114 | @item @samp{stack_protect_set} | |
6115 | ||
643e867f | 6116 | This pattern, if defined, moves a @code{ptr_mode} value from the memory |
7d69de61 RH |
6117 | in operand 1 to the memory in operand 0 without leaving the value in |
6118 | a register afterward. This is to avoid leaking the value some place | |
759915ca | 6119 | that an attacker might use to rewrite the stack guard slot after |
7d69de61 RH |
6120 | having clobbered it. |
6121 | ||
6122 | If this pattern is not defined, then a plain move pattern is generated. | |
6123 | ||
6124 | @cindex @code{stack_protect_test} instruction pattern | |
6125 | @item @samp{stack_protect_test} | |
6126 | ||
643e867f | 6127 | This pattern, if defined, compares a @code{ptr_mode} value from the |
7d69de61 | 6128 | memory in operand 1 with the memory in operand 0 without leaving the |
3aebbe5f JJ |
6129 | value in a register afterward and branches to operand 2 if the values |
6130 | weren't equal. | |
7d69de61 | 6131 | |
3aebbe5f JJ |
6132 | If this pattern is not defined, then a plain compare pattern and |
6133 | conditional branch pattern is used. | |
7d69de61 | 6134 | |
677feb77 DD |
6135 | @cindex @code{clear_cache} instruction pattern |
6136 | @item @samp{clear_cache} | |
6137 | ||
6138 | This pattern, if defined, flushes the instruction cache for a region of | |
6139 | memory. The region is bounded to by the Pmode pointers in operand 0 | |
6140 | inclusive and operand 1 exclusive. | |
6141 | ||
6142 | If this pattern is not defined, a call to the library function | |
6143 | @code{__clear_cache} is used. | |
6144 | ||
03dda8e3 RK |
6145 | @end table |
6146 | ||
a5249a21 HPN |
6147 | @end ifset |
6148 | @c Each of the following nodes are wrapped in separate | |
6149 | @c "@ifset INTERNALS" to work around memory limits for the default | |
6150 | @c configuration in older tetex distributions. Known to not work: | |
6151 | @c tetex-1.0.7, known to work: tetex-2.0.2. | |
6152 | @ifset INTERNALS | |
03dda8e3 RK |
6153 | @node Pattern Ordering |
6154 | @section When the Order of Patterns Matters | |
6155 | @cindex Pattern Ordering | |
6156 | @cindex Ordering of Patterns | |
6157 | ||
6158 | Sometimes an insn can match more than one instruction pattern. Then the | |
6159 | pattern that appears first in the machine description is the one used. | |
6160 | Therefore, more specific patterns (patterns that will match fewer things) | |
6161 | and faster instructions (those that will produce better code when they | |
6162 | do match) should usually go first in the description. | |
6163 | ||
6164 | In some cases the effect of ordering the patterns can be used to hide | |
6165 | a pattern when it is not valid. For example, the 68000 has an | |
6166 | instruction for converting a fullword to floating point and another | |
6167 | for converting a byte to floating point. An instruction converting | |
6168 | an integer to floating point could match either one. We put the | |
6169 | pattern to convert the fullword first to make sure that one will | |
6170 | be used rather than the other. (Otherwise a large integer might | |
6171 | be generated as a single-byte immediate quantity, which would not work.) | |
6172 | Instead of using this pattern ordering it would be possible to make the | |
6173 | pattern for convert-a-byte smart enough to deal properly with any | |
6174 | constant value. | |
6175 | ||
a5249a21 HPN |
6176 | @end ifset |
6177 | @ifset INTERNALS | |
03dda8e3 RK |
6178 | @node Dependent Patterns |
6179 | @section Interdependence of Patterns | |
6180 | @cindex Dependent Patterns | |
6181 | @cindex Interdependence of Patterns | |
6182 | ||
03dda8e3 RK |
6183 | In some cases machines support instructions identical except for the |
6184 | machine mode of one or more operands. For example, there may be | |
6185 | ``sign-extend halfword'' and ``sign-extend byte'' instructions whose | |
6186 | patterns are | |
6187 | ||
3ab51846 | 6188 | @smallexample |
03dda8e3 RK |
6189 | (set (match_operand:SI 0 @dots{}) |
6190 | (extend:SI (match_operand:HI 1 @dots{}))) | |
6191 | ||
6192 | (set (match_operand:SI 0 @dots{}) | |
6193 | (extend:SI (match_operand:QI 1 @dots{}))) | |
3ab51846 | 6194 | @end smallexample |
03dda8e3 RK |
6195 | |
6196 | @noindent | |
6197 | Constant integers do not specify a machine mode, so an instruction to | |
6198 | extend a constant value could match either pattern. The pattern it | |
6199 | actually will match is the one that appears first in the file. For correct | |
6200 | results, this must be the one for the widest possible mode (@code{HImode}, | |
6201 | here). If the pattern matches the @code{QImode} instruction, the results | |
6202 | will be incorrect if the constant value does not actually fit that mode. | |
6203 | ||
6204 | Such instructions to extend constants are rarely generated because they are | |
6205 | optimized away, but they do occasionally happen in nonoptimized | |
6206 | compilations. | |
6207 | ||
6208 | If a constraint in a pattern allows a constant, the reload pass may | |
6209 | replace a register with a constant permitted by the constraint in some | |
6210 | cases. Similarly for memory references. Because of this substitution, | |
6211 | you should not provide separate patterns for increment and decrement | |
6212 | instructions. Instead, they should be generated from the same pattern | |
6213 | that supports register-register add insns by examining the operands and | |
6214 | generating the appropriate machine instruction. | |
6215 | ||
a5249a21 HPN |
6216 | @end ifset |
6217 | @ifset INTERNALS | |
03dda8e3 RK |
6218 | @node Jump Patterns |
6219 | @section Defining Jump Instruction Patterns | |
6220 | @cindex jump instruction patterns | |
6221 | @cindex defining jump instruction patterns | |
6222 | ||
f90b7a5a PB |
6223 | GCC does not assume anything about how the machine realizes jumps. |
6224 | The machine description should define a single pattern, usually | |
6225 | a @code{define_expand}, which expands to all the required insns. | |
6226 | ||
6227 | Usually, this would be a comparison insn to set the condition code | |
6228 | and a separate branch insn testing the condition code and branching | |
6229 | or not according to its value. For many machines, however, | |
6230 | separating compares and branches is limiting, which is why the | |
6231 | more flexible approach with one @code{define_expand} is used in GCC. | |
6232 | The machine description becomes clearer for architectures that | |
6233 | have compare-and-branch instructions but no condition code. It also | |
6234 | works better when different sets of comparison operators are supported | |
6235 | by different kinds of conditional branches (e.g. integer vs. floating-point), | |
6236 | or by conditional branches with respect to conditional stores. | |
6237 | ||
6238 | Two separate insns are always used if the machine description represents | |
6239 | a condition code register using the legacy RTL expression @code{(cc0)}, | |
6240 | and on most machines that use a separate condition code register | |
6241 | (@pxref{Condition Code}). For machines that use @code{(cc0)}, in | |
6242 | fact, the set and use of the condition code must be separate and | |
6243 | adjacent@footnote{@code{note} insns can separate them, though.}, thus | |
6244 | allowing flags in @code{cc_status} to be used (@pxref{Condition Code}) and | |
6245 | so that the comparison and branch insns could be located from each other | |
6246 | by using the functions @code{prev_cc0_setter} and @code{next_cc0_user}. | |
6247 | ||
6248 | Even in this case having a single entry point for conditional branches | |
6249 | is advantageous, because it handles equally well the case where a single | |
6250 | comparison instruction records the results of both signed and unsigned | |
6251 | comparison of the given operands (with the branch insns coming in distinct | |
6252 | signed and unsigned flavors) as in the x86 or SPARC, and the case where | |
6253 | there are distinct signed and unsigned compare instructions and only | |
6254 | one set of conditional branch instructions as in the PowerPC. | |
03dda8e3 | 6255 | |
a5249a21 HPN |
6256 | @end ifset |
6257 | @ifset INTERNALS | |
6e4fcc95 MH |
6258 | @node Looping Patterns |
6259 | @section Defining Looping Instruction Patterns | |
6260 | @cindex looping instruction patterns | |
6261 | @cindex defining looping instruction patterns | |
6262 | ||
05713b80 | 6263 | Some machines have special jump instructions that can be utilized to |
6e4fcc95 MH |
6264 | make loops more efficient. A common example is the 68000 @samp{dbra} |
6265 | instruction which performs a decrement of a register and a branch if the | |
6266 | result was greater than zero. Other machines, in particular digital | |
6267 | signal processors (DSPs), have special block repeat instructions to | |
6268 | provide low-overhead loop support. For example, the TI TMS320C3x/C4x | |
6269 | DSPs have a block repeat instruction that loads special registers to | |
6270 | mark the top and end of a loop and to count the number of loop | |
6271 | iterations. This avoids the need for fetching and executing a | |
c771326b | 6272 | @samp{dbra}-like instruction and avoids pipeline stalls associated with |
6e4fcc95 MH |
6273 | the jump. |
6274 | ||
9c34dbbf ZW |
6275 | GCC has three special named patterns to support low overhead looping. |
6276 | They are @samp{decrement_and_branch_until_zero}, @samp{doloop_begin}, | |
6277 | and @samp{doloop_end}. The first pattern, | |
6e4fcc95 MH |
6278 | @samp{decrement_and_branch_until_zero}, is not emitted during RTL |
6279 | generation but may be emitted during the instruction combination phase. | |
6280 | This requires the assistance of the loop optimizer, using information | |
6281 | collected during strength reduction, to reverse a loop to count down to | |
6282 | zero. Some targets also require the loop optimizer to add a | |
6283 | @code{REG_NONNEG} note to indicate that the iteration count is always | |
6284 | positive. This is needed if the target performs a signed loop | |
6285 | termination test. For example, the 68000 uses a pattern similar to the | |
6286 | following for its @code{dbra} instruction: | |
6287 | ||
6288 | @smallexample | |
6289 | @group | |
6290 | (define_insn "decrement_and_branch_until_zero" | |
6291 | [(set (pc) | |
6ccde948 RW |
6292 | (if_then_else |
6293 | (ge (plus:SI (match_operand:SI 0 "general_operand" "+d*am") | |
6294 | (const_int -1)) | |
6295 | (const_int 0)) | |
6296 | (label_ref (match_operand 1 "" "")) | |
6297 | (pc))) | |
6e4fcc95 | 6298 | (set (match_dup 0) |
6ccde948 RW |
6299 | (plus:SI (match_dup 0) |
6300 | (const_int -1)))] | |
6e4fcc95 | 6301 | "find_reg_note (insn, REG_NONNEG, 0)" |
630d3d5a | 6302 | "@dots{}") |
6e4fcc95 MH |
6303 | @end group |
6304 | @end smallexample | |
6305 | ||
6306 | Note that since the insn is both a jump insn and has an output, it must | |
6307 | deal with its own reloads, hence the `m' constraints. Also note that | |
6308 | since this insn is generated by the instruction combination phase | |
6309 | combining two sequential insns together into an implicit parallel insn, | |
6310 | the iteration counter needs to be biased by the same amount as the | |
630d3d5a | 6311 | decrement operation, in this case @minus{}1. Note that the following similar |
6e4fcc95 MH |
6312 | pattern will not be matched by the combiner. |
6313 | ||
6314 | @smallexample | |
6315 | @group | |
6316 | (define_insn "decrement_and_branch_until_zero" | |
6317 | [(set (pc) | |
6ccde948 RW |
6318 | (if_then_else |
6319 | (ge (match_operand:SI 0 "general_operand" "+d*am") | |
6320 | (const_int 1)) | |
6321 | (label_ref (match_operand 1 "" "")) | |
6322 | (pc))) | |
6e4fcc95 | 6323 | (set (match_dup 0) |
6ccde948 RW |
6324 | (plus:SI (match_dup 0) |
6325 | (const_int -1)))] | |
6e4fcc95 | 6326 | "find_reg_note (insn, REG_NONNEG, 0)" |
630d3d5a | 6327 | "@dots{}") |
6e4fcc95 MH |
6328 | @end group |
6329 | @end smallexample | |
6330 | ||
6331 | The other two special looping patterns, @samp{doloop_begin} and | |
c21cd8b1 | 6332 | @samp{doloop_end}, are emitted by the loop optimizer for certain |
6e4fcc95 | 6333 | well-behaved loops with a finite number of loop iterations using |
ebb48a4d | 6334 | information collected during strength reduction. |
6e4fcc95 MH |
6335 | |
6336 | The @samp{doloop_end} pattern describes the actual looping instruction | |
6337 | (or the implicit looping operation) and the @samp{doloop_begin} pattern | |
c21cd8b1 | 6338 | is an optional companion pattern that can be used for initialization |
6e4fcc95 MH |
6339 | needed for some low-overhead looping instructions. |
6340 | ||
6341 | Note that some machines require the actual looping instruction to be | |
6342 | emitted at the top of the loop (e.g., the TMS320C3x/C4x DSPs). Emitting | |
6343 | the true RTL for a looping instruction at the top of the loop can cause | |
6344 | problems with flow analysis. So instead, a dummy @code{doloop} insn is | |
6345 | emitted at the end of the loop. The machine dependent reorg pass checks | |
6346 | for the presence of this @code{doloop} insn and then searches back to | |
6347 | the top of the loop, where it inserts the true looping insn (provided | |
6348 | there are no instructions in the loop which would cause problems). Any | |
6349 | additional labels can be emitted at this point. In addition, if the | |
6350 | desired special iteration counter register was not allocated, this | |
6351 | machine dependent reorg pass could emit a traditional compare and jump | |
6352 | instruction pair. | |
6353 | ||
6354 | The essential difference between the | |
6355 | @samp{decrement_and_branch_until_zero} and the @samp{doloop_end} | |
6356 | patterns is that the loop optimizer allocates an additional pseudo | |
6357 | register for the latter as an iteration counter. This pseudo register | |
6358 | cannot be used within the loop (i.e., general induction variables cannot | |
6359 | be derived from it), however, in many cases the loop induction variable | |
6360 | may become redundant and removed by the flow pass. | |
6361 | ||
6362 | ||
a5249a21 HPN |
6363 | @end ifset |
6364 | @ifset INTERNALS | |
03dda8e3 RK |
6365 | @node Insn Canonicalizations |
6366 | @section Canonicalization of Instructions | |
6367 | @cindex canonicalization of instructions | |
6368 | @cindex insn canonicalization | |
6369 | ||
6370 | There are often cases where multiple RTL expressions could represent an | |
6371 | operation performed by a single machine instruction. This situation is | |
6372 | most commonly encountered with logical, branch, and multiply-accumulate | |
6373 | instructions. In such cases, the compiler attempts to convert these | |
6374 | multiple RTL expressions into a single canonical form to reduce the | |
6375 | number of insn patterns required. | |
6376 | ||
6377 | In addition to algebraic simplifications, following canonicalizations | |
6378 | are performed: | |
6379 | ||
6380 | @itemize @bullet | |
6381 | @item | |
6382 | For commutative and comparison operators, a constant is always made the | |
6383 | second operand. If a machine only supports a constant as the second | |
6384 | operand, only patterns that match a constant in the second operand need | |
6385 | be supplied. | |
6386 | ||
e3d6e740 GK |
6387 | @item |
6388 | For associative operators, a sequence of operators will always chain | |
6389 | to the left; for instance, only the left operand of an integer @code{plus} | |
6390 | can itself be a @code{plus}. @code{and}, @code{ior}, @code{xor}, | |
6391 | @code{plus}, @code{mult}, @code{smin}, @code{smax}, @code{umin}, and | |
6392 | @code{umax} are associative when applied to integers, and sometimes to | |
6393 | floating-point. | |
6394 | ||
6395 | @item | |
03dda8e3 RK |
6396 | @cindex @code{neg}, canonicalization of |
6397 | @cindex @code{not}, canonicalization of | |
6398 | @cindex @code{mult}, canonicalization of | |
6399 | @cindex @code{plus}, canonicalization of | |
6400 | @cindex @code{minus}, canonicalization of | |
6401 | For these operators, if only one operand is a @code{neg}, @code{not}, | |
6402 | @code{mult}, @code{plus}, or @code{minus} expression, it will be the | |
6403 | first operand. | |
6404 | ||
16823694 GK |
6405 | @item |
6406 | In combinations of @code{neg}, @code{mult}, @code{plus}, and | |
6407 | @code{minus}, the @code{neg} operations (if any) will be moved inside | |
daf2f129 | 6408 | the operations as far as possible. For instance, |
16823694 | 6409 | @code{(neg (mult A B))} is canonicalized as @code{(mult (neg A) B)}, but |
9302a061 | 6410 | @code{(plus (mult (neg B) C) A)} is canonicalized as |
16823694 GK |
6411 | @code{(minus A (mult B C))}. |
6412 | ||
03dda8e3 RK |
6413 | @cindex @code{compare}, canonicalization of |
6414 | @item | |
6415 | For the @code{compare} operator, a constant is always the second operand | |
f90b7a5a | 6416 | if the first argument is a condition code register or @code{(cc0)}. |
03dda8e3 | 6417 | |
f90b7a5a | 6418 | @item |
03dda8e3 RK |
6419 | An operand of @code{neg}, @code{not}, @code{mult}, @code{plus}, or |
6420 | @code{minus} is made the first operand under the same conditions as | |
6421 | above. | |
6422 | ||
921c4418 RIL |
6423 | @item |
6424 | @code{(ltu (plus @var{a} @var{b}) @var{b})} is converted to | |
6425 | @code{(ltu (plus @var{a} @var{b}) @var{a})}. Likewise with @code{geu} instead | |
6426 | of @code{ltu}. | |
6427 | ||
03dda8e3 RK |
6428 | @item |
6429 | @code{(minus @var{x} (const_int @var{n}))} is converted to | |
6430 | @code{(plus @var{x} (const_int @var{-n}))}. | |
6431 | ||
6432 | @item | |
6433 | Within address computations (i.e., inside @code{mem}), a left shift is | |
6434 | converted into the appropriate multiplication by a power of two. | |
6435 | ||
6436 | @cindex @code{ior}, canonicalization of | |
6437 | @cindex @code{and}, canonicalization of | |
6438 | @cindex De Morgan's law | |
72938a4c | 6439 | @item |
090359d6 | 6440 | De Morgan's Law is used to move bitwise negation inside a bitwise |
03dda8e3 RK |
6441 | logical-and or logical-or operation. If this results in only one |
6442 | operand being a @code{not} expression, it will be the first one. | |
6443 | ||
6444 | A machine that has an instruction that performs a bitwise logical-and of one | |
6445 | operand with the bitwise negation of the other should specify the pattern | |
6446 | for that instruction as | |
6447 | ||
3ab51846 | 6448 | @smallexample |
03dda8e3 RK |
6449 | (define_insn "" |
6450 | [(set (match_operand:@var{m} 0 @dots{}) | |
6451 | (and:@var{m} (not:@var{m} (match_operand:@var{m} 1 @dots{})) | |
6452 | (match_operand:@var{m} 2 @dots{})))] | |
6453 | "@dots{}" | |
6454 | "@dots{}") | |
3ab51846 | 6455 | @end smallexample |
03dda8e3 RK |
6456 | |
6457 | @noindent | |
6458 | Similarly, a pattern for a ``NAND'' instruction should be written | |
6459 | ||
3ab51846 | 6460 | @smallexample |
03dda8e3 RK |
6461 | (define_insn "" |
6462 | [(set (match_operand:@var{m} 0 @dots{}) | |
6463 | (ior:@var{m} (not:@var{m} (match_operand:@var{m} 1 @dots{})) | |
6464 | (not:@var{m} (match_operand:@var{m} 2 @dots{}))))] | |
6465 | "@dots{}" | |
6466 | "@dots{}") | |
3ab51846 | 6467 | @end smallexample |
03dda8e3 RK |
6468 | |
6469 | In both cases, it is not necessary to include patterns for the many | |
6470 | logically equivalent RTL expressions. | |
6471 | ||
6472 | @cindex @code{xor}, canonicalization of | |
6473 | @item | |
6474 | The only possible RTL expressions involving both bitwise exclusive-or | |
6475 | and bitwise negation are @code{(xor:@var{m} @var{x} @var{y})} | |
bd819a4a | 6476 | and @code{(not:@var{m} (xor:@var{m} @var{x} @var{y}))}. |
03dda8e3 RK |
6477 | |
6478 | @item | |
6479 | The sum of three items, one of which is a constant, will only appear in | |
6480 | the form | |
6481 | ||
3ab51846 | 6482 | @smallexample |
03dda8e3 | 6483 | (plus:@var{m} (plus:@var{m} @var{x} @var{y}) @var{constant}) |
3ab51846 | 6484 | @end smallexample |
03dda8e3 | 6485 | |
03dda8e3 RK |
6486 | @cindex @code{zero_extract}, canonicalization of |
6487 | @cindex @code{sign_extract}, canonicalization of | |
6488 | @item | |
6489 | Equality comparisons of a group of bits (usually a single bit) with zero | |
6490 | will be written using @code{zero_extract} rather than the equivalent | |
6491 | @code{and} or @code{sign_extract} operations. | |
6492 | ||
c536876e AS |
6493 | @cindex @code{mult}, canonicalization of |
6494 | @item | |
6495 | @code{(sign_extend:@var{m1} (mult:@var{m2} (sign_extend:@var{m2} @var{x}) | |
6496 | (sign_extend:@var{m2} @var{y})))} is converted to @code{(mult:@var{m1} | |
6497 | (sign_extend:@var{m1} @var{x}) (sign_extend:@var{m1} @var{y}))}, and likewise | |
6498 | for @code{zero_extend}. | |
6499 | ||
6500 | @item | |
6501 | @code{(sign_extend:@var{m1} (mult:@var{m2} (ashiftrt:@var{m2} | |
6502 | @var{x} @var{s}) (sign_extend:@var{m2} @var{y})))} is converted | |
6503 | to @code{(mult:@var{m1} (sign_extend:@var{m1} (ashiftrt:@var{m2} | |
6504 | @var{x} @var{s})) (sign_extend:@var{m1} @var{y}))}, and likewise for | |
6505 | patterns using @code{zero_extend} and @code{lshiftrt}. If the second | |
6506 | operand of @code{mult} is also a shift, then that is extended also. | |
6507 | This transformation is only applied when it can be proven that the | |
6508 | original operation had sufficient precision to prevent overflow. | |
6509 | ||
03dda8e3 RK |
6510 | @end itemize |
6511 | ||
cd16503a HPN |
6512 | Further canonicalization rules are defined in the function |
6513 | @code{commutative_operand_precedence} in @file{gcc/rtlanal.c}. | |
6514 | ||
a5249a21 HPN |
6515 | @end ifset |
6516 | @ifset INTERNALS | |
03dda8e3 RK |
6517 | @node Expander Definitions |
6518 | @section Defining RTL Sequences for Code Generation | |
6519 | @cindex expander definitions | |
6520 | @cindex code generation RTL sequences | |
6521 | @cindex defining RTL sequences for code generation | |
6522 | ||
6523 | On some target machines, some standard pattern names for RTL generation | |
6524 | cannot be handled with single insn, but a sequence of RTL insns can | |
6525 | represent them. For these target machines, you can write a | |
161d7b59 | 6526 | @code{define_expand} to specify how to generate the sequence of RTL@. |
03dda8e3 RK |
6527 | |
6528 | @findex define_expand | |
6529 | A @code{define_expand} is an RTL expression that looks almost like a | |
6530 | @code{define_insn}; but, unlike the latter, a @code{define_expand} is used | |
6531 | only for RTL generation and it can produce more than one RTL insn. | |
6532 | ||
6533 | A @code{define_expand} RTX has four operands: | |
6534 | ||
6535 | @itemize @bullet | |
6536 | @item | |
6537 | The name. Each @code{define_expand} must have a name, since the only | |
6538 | use for it is to refer to it by name. | |
6539 | ||
03dda8e3 | 6540 | @item |
f3a3d0d3 RH |
6541 | The RTL template. This is a vector of RTL expressions representing |
6542 | a sequence of separate instructions. Unlike @code{define_insn}, there | |
6543 | is no implicit surrounding @code{PARALLEL}. | |
03dda8e3 RK |
6544 | |
6545 | @item | |
6546 | The condition, a string containing a C expression. This expression is | |
6547 | used to express how the availability of this pattern depends on | |
f0523f02 JM |
6548 | subclasses of target machine, selected by command-line options when GCC |
6549 | is run. This is just like the condition of a @code{define_insn} that | |
03dda8e3 RK |
6550 | has a standard name. Therefore, the condition (if present) may not |
6551 | depend on the data in the insn being matched, but only the | |
6552 | target-machine-type flags. The compiler needs to test these conditions | |
6553 | during initialization in order to learn exactly which named instructions | |
6554 | are available in a particular run. | |
6555 | ||
6556 | @item | |
6557 | The preparation statements, a string containing zero or more C | |
6558 | statements which are to be executed before RTL code is generated from | |
6559 | the RTL template. | |
6560 | ||
6561 | Usually these statements prepare temporary registers for use as | |
6562 | internal operands in the RTL template, but they can also generate RTL | |
6563 | insns directly by calling routines such as @code{emit_insn}, etc. | |
6564 | Any such insns precede the ones that come from the RTL template. | |
6565 | @end itemize | |
6566 | ||
6567 | Every RTL insn emitted by a @code{define_expand} must match some | |
6568 | @code{define_insn} in the machine description. Otherwise, the compiler | |
6569 | will crash when trying to generate code for the insn or trying to optimize | |
6570 | it. | |
6571 | ||
6572 | The RTL template, in addition to controlling generation of RTL insns, | |
6573 | also describes the operands that need to be specified when this pattern | |
6574 | is used. In particular, it gives a predicate for each operand. | |
6575 | ||
6576 | A true operand, which needs to be specified in order to generate RTL from | |
6577 | the pattern, should be described with a @code{match_operand} in its first | |
6578 | occurrence in the RTL template. This enters information on the operand's | |
f0523f02 | 6579 | predicate into the tables that record such things. GCC uses the |
03dda8e3 RK |
6580 | information to preload the operand into a register if that is required for |
6581 | valid RTL code. If the operand is referred to more than once, subsequent | |
6582 | references should use @code{match_dup}. | |
6583 | ||
6584 | The RTL template may also refer to internal ``operands'' which are | |
6585 | temporary registers or labels used only within the sequence made by the | |
6586 | @code{define_expand}. Internal operands are substituted into the RTL | |
6587 | template with @code{match_dup}, never with @code{match_operand}. The | |
6588 | values of the internal operands are not passed in as arguments by the | |
6589 | compiler when it requests use of this pattern. Instead, they are computed | |
6590 | within the pattern, in the preparation statements. These statements | |
6591 | compute the values and store them into the appropriate elements of | |
6592 | @code{operands} so that @code{match_dup} can find them. | |
6593 | ||
6594 | There are two special macros defined for use in the preparation statements: | |
6595 | @code{DONE} and @code{FAIL}. Use them with a following semicolon, | |
6596 | as a statement. | |
6597 | ||
6598 | @table @code | |
6599 | ||
6600 | @findex DONE | |
6601 | @item DONE | |
6602 | Use the @code{DONE} macro to end RTL generation for the pattern. The | |
6603 | only RTL insns resulting from the pattern on this occasion will be | |
6604 | those already emitted by explicit calls to @code{emit_insn} within the | |
6605 | preparation statements; the RTL template will not be generated. | |
6606 | ||
6607 | @findex FAIL | |
6608 | @item FAIL | |
6609 | Make the pattern fail on this occasion. When a pattern fails, it means | |
6610 | that the pattern was not truly available. The calling routines in the | |
6611 | compiler will try other strategies for code generation using other patterns. | |
6612 | ||
6613 | Failure is currently supported only for binary (addition, multiplication, | |
c771326b | 6614 | shifting, etc.) and bit-field (@code{extv}, @code{extzv}, and @code{insv}) |
03dda8e3 RK |
6615 | operations. |
6616 | @end table | |
6617 | ||
55e4756f DD |
6618 | If the preparation falls through (invokes neither @code{DONE} nor |
6619 | @code{FAIL}), then the @code{define_expand} acts like a | |
6620 | @code{define_insn} in that the RTL template is used to generate the | |
6621 | insn. | |
6622 | ||
6623 | The RTL template is not used for matching, only for generating the | |
6624 | initial insn list. If the preparation statement always invokes | |
6625 | @code{DONE} or @code{FAIL}, the RTL template may be reduced to a simple | |
6626 | list of operands, such as this example: | |
6627 | ||
6628 | @smallexample | |
6629 | @group | |
6630 | (define_expand "addsi3" | |
6631 | [(match_operand:SI 0 "register_operand" "") | |
6632 | (match_operand:SI 1 "register_operand" "") | |
6633 | (match_operand:SI 2 "register_operand" "")] | |
6634 | @end group | |
6635 | @group | |
6636 | "" | |
6637 | " | |
58097133 | 6638 | @{ |
55e4756f DD |
6639 | handle_add (operands[0], operands[1], operands[2]); |
6640 | DONE; | |
58097133 | 6641 | @}") |
55e4756f DD |
6642 | @end group |
6643 | @end smallexample | |
6644 | ||
03dda8e3 RK |
6645 | Here is an example, the definition of left-shift for the SPUR chip: |
6646 | ||
6647 | @smallexample | |
6648 | @group | |
6649 | (define_expand "ashlsi3" | |
6650 | [(set (match_operand:SI 0 "register_operand" "") | |
6651 | (ashift:SI | |
6652 | @end group | |
6653 | @group | |
6654 | (match_operand:SI 1 "register_operand" "") | |
6655 | (match_operand:SI 2 "nonmemory_operand" "")))] | |
6656 | "" | |
6657 | " | |
6658 | @end group | |
6659 | @end smallexample | |
6660 | ||
6661 | @smallexample | |
6662 | @group | |
6663 | @{ | |
6664 | if (GET_CODE (operands[2]) != CONST_INT | |
6665 | || (unsigned) INTVAL (operands[2]) > 3) | |
6666 | FAIL; | |
6667 | @}") | |
6668 | @end group | |
6669 | @end smallexample | |
6670 | ||
6671 | @noindent | |
6672 | This example uses @code{define_expand} so that it can generate an RTL insn | |
6673 | for shifting when the shift-count is in the supported range of 0 to 3 but | |
6674 | fail in other cases where machine insns aren't available. When it fails, | |
6675 | the compiler tries another strategy using different patterns (such as, a | |
6676 | library call). | |
6677 | ||
6678 | If the compiler were able to handle nontrivial condition-strings in | |
6679 | patterns with names, then it would be possible to use a | |
6680 | @code{define_insn} in that case. Here is another case (zero-extension | |
6681 | on the 68000) which makes more use of the power of @code{define_expand}: | |
6682 | ||
6683 | @smallexample | |
6684 | (define_expand "zero_extendhisi2" | |
6685 | [(set (match_operand:SI 0 "general_operand" "") | |
6686 | (const_int 0)) | |
6687 | (set (strict_low_part | |
6688 | (subreg:HI | |
6689 | (match_dup 0) | |
6690 | 0)) | |
6691 | (match_operand:HI 1 "general_operand" ""))] | |
6692 | "" | |
6693 | "operands[1] = make_safe_from (operands[1], operands[0]);") | |
6694 | @end smallexample | |
6695 | ||
6696 | @noindent | |
6697 | @findex make_safe_from | |
6698 | Here two RTL insns are generated, one to clear the entire output operand | |
6699 | and the other to copy the input operand into its low half. This sequence | |
6700 | is incorrect if the input operand refers to [the old value of] the output | |
6701 | operand, so the preparation statement makes sure this isn't so. The | |
6702 | function @code{make_safe_from} copies the @code{operands[1]} into a | |
6703 | temporary register if it refers to @code{operands[0]}. It does this | |
6704 | by emitting another RTL insn. | |
6705 | ||
6706 | Finally, a third example shows the use of an internal operand. | |
6707 | Zero-extension on the SPUR chip is done by @code{and}-ing the result | |
6708 | against a halfword mask. But this mask cannot be represented by a | |
6709 | @code{const_int} because the constant value is too large to be legitimate | |
6710 | on this machine. So it must be copied into a register with | |
6711 | @code{force_reg} and then the register used in the @code{and}. | |
6712 | ||
6713 | @smallexample | |
6714 | (define_expand "zero_extendhisi2" | |
6715 | [(set (match_operand:SI 0 "register_operand" "") | |
6716 | (and:SI (subreg:SI | |
6717 | (match_operand:HI 1 "register_operand" "") | |
6718 | 0) | |
6719 | (match_dup 2)))] | |
6720 | "" | |
6721 | "operands[2] | |
3a598fbe | 6722 | = force_reg (SImode, GEN_INT (65535)); ") |
03dda8e3 RK |
6723 | @end smallexample |
6724 | ||
f4559287 | 6725 | @emph{Note:} If the @code{define_expand} is used to serve a |
c771326b | 6726 | standard binary or unary arithmetic operation or a bit-field operation, |
03dda8e3 RK |
6727 | then the last insn it generates must not be a @code{code_label}, |
6728 | @code{barrier} or @code{note}. It must be an @code{insn}, | |
6729 | @code{jump_insn} or @code{call_insn}. If you don't need a real insn | |
6730 | at the end, emit an insn to copy the result of the operation into | |
6731 | itself. Such an insn will generate no code, but it can avoid problems | |
bd819a4a | 6732 | in the compiler. |
03dda8e3 | 6733 | |
a5249a21 HPN |
6734 | @end ifset |
6735 | @ifset INTERNALS | |
03dda8e3 RK |
6736 | @node Insn Splitting |
6737 | @section Defining How to Split Instructions | |
6738 | @cindex insn splitting | |
6739 | @cindex instruction splitting | |
6740 | @cindex splitting instructions | |
6741 | ||
fae15c93 VM |
6742 | There are two cases where you should specify how to split a pattern |
6743 | into multiple insns. On machines that have instructions requiring | |
6744 | delay slots (@pxref{Delay Slots}) or that have instructions whose | |
6745 | output is not available for multiple cycles (@pxref{Processor pipeline | |
6746 | description}), the compiler phases that optimize these cases need to | |
6747 | be able to move insns into one-instruction delay slots. However, some | |
6748 | insns may generate more than one machine instruction. These insns | |
6749 | cannot be placed into a delay slot. | |
03dda8e3 RK |
6750 | |
6751 | Often you can rewrite the single insn as a list of individual insns, | |
6752 | each corresponding to one machine instruction. The disadvantage of | |
6753 | doing so is that it will cause the compilation to be slower and require | |
6754 | more space. If the resulting insns are too complex, it may also | |
6755 | suppress some optimizations. The compiler splits the insn if there is a | |
6756 | reason to believe that it might improve instruction or delay slot | |
6757 | scheduling. | |
6758 | ||
6759 | The insn combiner phase also splits putative insns. If three insns are | |
6760 | merged into one insn with a complex expression that cannot be matched by | |
6761 | some @code{define_insn} pattern, the combiner phase attempts to split | |
6762 | the complex pattern into two insns that are recognized. Usually it can | |
6763 | break the complex pattern into two patterns by splitting out some | |
6764 | subexpression. However, in some other cases, such as performing an | |
6765 | addition of a large constant in two insns on a RISC machine, the way to | |
6766 | split the addition into two insns is machine-dependent. | |
6767 | ||
f3a3d0d3 | 6768 | @findex define_split |
03dda8e3 RK |
6769 | The @code{define_split} definition tells the compiler how to split a |
6770 | complex insn into several simpler insns. It looks like this: | |
6771 | ||
6772 | @smallexample | |
6773 | (define_split | |
6774 | [@var{insn-pattern}] | |
6775 | "@var{condition}" | |
6776 | [@var{new-insn-pattern-1} | |
6777 | @var{new-insn-pattern-2} | |
6778 | @dots{}] | |
630d3d5a | 6779 | "@var{preparation-statements}") |
03dda8e3 RK |
6780 | @end smallexample |
6781 | ||
6782 | @var{insn-pattern} is a pattern that needs to be split and | |
6783 | @var{condition} is the final condition to be tested, as in a | |
6784 | @code{define_insn}. When an insn matching @var{insn-pattern} and | |
6785 | satisfying @var{condition} is found, it is replaced in the insn list | |
6786 | with the insns given by @var{new-insn-pattern-1}, | |
6787 | @var{new-insn-pattern-2}, etc. | |
6788 | ||
630d3d5a | 6789 | The @var{preparation-statements} are similar to those statements that |
03dda8e3 RK |
6790 | are specified for @code{define_expand} (@pxref{Expander Definitions}) |
6791 | and are executed before the new RTL is generated to prepare for the | |
6792 | generated code or emit some insns whose pattern is not fixed. Unlike | |
6793 | those in @code{define_expand}, however, these statements must not | |
6794 | generate any new pseudo-registers. Once reload has completed, they also | |
6795 | must not allocate any space in the stack frame. | |
6796 | ||
6797 | Patterns are matched against @var{insn-pattern} in two different | |
6798 | circumstances. If an insn needs to be split for delay slot scheduling | |
6799 | or insn scheduling, the insn is already known to be valid, which means | |
6800 | that it must have been matched by some @code{define_insn} and, if | |
df2a54e9 | 6801 | @code{reload_completed} is nonzero, is known to satisfy the constraints |
03dda8e3 RK |
6802 | of that @code{define_insn}. In that case, the new insn patterns must |
6803 | also be insns that are matched by some @code{define_insn} and, if | |
df2a54e9 | 6804 | @code{reload_completed} is nonzero, must also satisfy the constraints |
03dda8e3 RK |
6805 | of those definitions. |
6806 | ||
6807 | As an example of this usage of @code{define_split}, consider the following | |
6808 | example from @file{a29k.md}, which splits a @code{sign_extend} from | |
6809 | @code{HImode} to @code{SImode} into a pair of shift insns: | |
6810 | ||
6811 | @smallexample | |
6812 | (define_split | |
6813 | [(set (match_operand:SI 0 "gen_reg_operand" "") | |
6814 | (sign_extend:SI (match_operand:HI 1 "gen_reg_operand" "")))] | |
6815 | "" | |
6816 | [(set (match_dup 0) | |
6817 | (ashift:SI (match_dup 1) | |
6818 | (const_int 16))) | |
6819 | (set (match_dup 0) | |
6820 | (ashiftrt:SI (match_dup 0) | |
6821 | (const_int 16)))] | |
6822 | " | |
6823 | @{ operands[1] = gen_lowpart (SImode, operands[1]); @}") | |
6824 | @end smallexample | |
6825 | ||
6826 | When the combiner phase tries to split an insn pattern, it is always the | |
6827 | case that the pattern is @emph{not} matched by any @code{define_insn}. | |
6828 | The combiner pass first tries to split a single @code{set} expression | |
6829 | and then the same @code{set} expression inside a @code{parallel}, but | |
6830 | followed by a @code{clobber} of a pseudo-reg to use as a scratch | |
6831 | register. In these cases, the combiner expects exactly two new insn | |
6832 | patterns to be generated. It will verify that these patterns match some | |
6833 | @code{define_insn} definitions, so you need not do this test in the | |
6834 | @code{define_split} (of course, there is no point in writing a | |
6835 | @code{define_split} that will never produce insns that match). | |
6836 | ||
6837 | Here is an example of this use of @code{define_split}, taken from | |
6838 | @file{rs6000.md}: | |
6839 | ||
6840 | @smallexample | |
6841 | (define_split | |
6842 | [(set (match_operand:SI 0 "gen_reg_operand" "") | |
6843 | (plus:SI (match_operand:SI 1 "gen_reg_operand" "") | |
6844 | (match_operand:SI 2 "non_add_cint_operand" "")))] | |
6845 | "" | |
6846 | [(set (match_dup 0) (plus:SI (match_dup 1) (match_dup 3))) | |
6847 | (set (match_dup 0) (plus:SI (match_dup 0) (match_dup 4)))] | |
6848 | " | |
6849 | @{ | |
6850 | int low = INTVAL (operands[2]) & 0xffff; | |
6851 | int high = (unsigned) INTVAL (operands[2]) >> 16; | |
6852 | ||
6853 | if (low & 0x8000) | |
6854 | high++, low |= 0xffff0000; | |
6855 | ||
3a598fbe JL |
6856 | operands[3] = GEN_INT (high << 16); |
6857 | operands[4] = GEN_INT (low); | |
03dda8e3 RK |
6858 | @}") |
6859 | @end smallexample | |
6860 | ||
6861 | Here the predicate @code{non_add_cint_operand} matches any | |
6862 | @code{const_int} that is @emph{not} a valid operand of a single add | |
6863 | insn. The add with the smaller displacement is written so that it | |
6864 | can be substituted into the address of a subsequent operation. | |
6865 | ||
6866 | An example that uses a scratch register, from the same file, generates | |
6867 | an equality comparison of a register and a large constant: | |
6868 | ||
6869 | @smallexample | |
6870 | (define_split | |
6871 | [(set (match_operand:CC 0 "cc_reg_operand" "") | |
6872 | (compare:CC (match_operand:SI 1 "gen_reg_operand" "") | |
6873 | (match_operand:SI 2 "non_short_cint_operand" ""))) | |
6874 | (clobber (match_operand:SI 3 "gen_reg_operand" ""))] | |
6875 | "find_single_use (operands[0], insn, 0) | |
6876 | && (GET_CODE (*find_single_use (operands[0], insn, 0)) == EQ | |
6877 | || GET_CODE (*find_single_use (operands[0], insn, 0)) == NE)" | |
6878 | [(set (match_dup 3) (xor:SI (match_dup 1) (match_dup 4))) | |
6879 | (set (match_dup 0) (compare:CC (match_dup 3) (match_dup 5)))] | |
6880 | " | |
6881 | @{ | |
12bcfaa1 | 6882 | /* @r{Get the constant we are comparing against, C, and see what it |
03dda8e3 | 6883 | looks like sign-extended to 16 bits. Then see what constant |
12bcfaa1 | 6884 | could be XOR'ed with C to get the sign-extended value.} */ |
03dda8e3 RK |
6885 | |
6886 | int c = INTVAL (operands[2]); | |
6887 | int sextc = (c << 16) >> 16; | |
6888 | int xorv = c ^ sextc; | |
6889 | ||
3a598fbe JL |
6890 | operands[4] = GEN_INT (xorv); |
6891 | operands[5] = GEN_INT (sextc); | |
03dda8e3 RK |
6892 | @}") |
6893 | @end smallexample | |
6894 | ||
6895 | To avoid confusion, don't write a single @code{define_split} that | |
6896 | accepts some insns that match some @code{define_insn} as well as some | |
6897 | insns that don't. Instead, write two separate @code{define_split} | |
6898 | definitions, one for the insns that are valid and one for the insns that | |
6899 | are not valid. | |
6900 | ||
6b24c259 JH |
6901 | The splitter is allowed to split jump instructions into sequence of |
6902 | jumps or create new jumps in while splitting non-jump instructions. As | |
6903 | the central flowgraph and branch prediction information needs to be updated, | |
f282ffb3 | 6904 | several restriction apply. |
6b24c259 JH |
6905 | |
6906 | Splitting of jump instruction into sequence that over by another jump | |
c21cd8b1 | 6907 | instruction is always valid, as compiler expect identical behavior of new |
6b24c259 JH |
6908 | jump. When new sequence contains multiple jump instructions or new labels, |
6909 | more assistance is needed. Splitter is required to create only unconditional | |
6910 | jumps, or simple conditional jump instructions. Additionally it must attach a | |
63519d23 | 6911 | @code{REG_BR_PROB} note to each conditional jump. A global variable |
addd6f64 | 6912 | @code{split_branch_probability} holds the probability of the original branch in case |
e4ae5e77 | 6913 | it was a simple conditional jump, @minus{}1 otherwise. To simplify |
addd6f64 | 6914 | recomputing of edge frequencies, the new sequence is required to have only |
6b24c259 JH |
6915 | forward jumps to the newly created labels. |
6916 | ||
fae81b38 | 6917 | @findex define_insn_and_split |
c88c0d42 CP |
6918 | For the common case where the pattern of a define_split exactly matches the |
6919 | pattern of a define_insn, use @code{define_insn_and_split}. It looks like | |
6920 | this: | |
6921 | ||
6922 | @smallexample | |
6923 | (define_insn_and_split | |
6924 | [@var{insn-pattern}] | |
6925 | "@var{condition}" | |
6926 | "@var{output-template}" | |
6927 | "@var{split-condition}" | |
6928 | [@var{new-insn-pattern-1} | |
6929 | @var{new-insn-pattern-2} | |
6930 | @dots{}] | |
630d3d5a | 6931 | "@var{preparation-statements}" |
c88c0d42 CP |
6932 | [@var{insn-attributes}]) |
6933 | ||
6934 | @end smallexample | |
6935 | ||
6936 | @var{insn-pattern}, @var{condition}, @var{output-template}, and | |
6937 | @var{insn-attributes} are used as in @code{define_insn}. The | |
6938 | @var{new-insn-pattern} vector and the @var{preparation-statements} are used as | |
6939 | in a @code{define_split}. The @var{split-condition} is also used as in | |
6940 | @code{define_split}, with the additional behavior that if the condition starts | |
6941 | with @samp{&&}, the condition used for the split will be the constructed as a | |
d7d9c429 | 6942 | logical ``and'' of the split condition with the insn condition. For example, |
c88c0d42 CP |
6943 | from i386.md: |
6944 | ||
6945 | @smallexample | |
6946 | (define_insn_and_split "zero_extendhisi2_and" | |
6947 | [(set (match_operand:SI 0 "register_operand" "=r") | |
6948 | (zero_extend:SI (match_operand:HI 1 "register_operand" "0"))) | |
6949 | (clobber (reg:CC 17))] | |
6950 | "TARGET_ZERO_EXTEND_WITH_AND && !optimize_size" | |
6951 | "#" | |
6952 | "&& reload_completed" | |
f282ffb3 | 6953 | [(parallel [(set (match_dup 0) |
9c34dbbf | 6954 | (and:SI (match_dup 0) (const_int 65535))) |
6ccde948 | 6955 | (clobber (reg:CC 17))])] |
c88c0d42 CP |
6956 | "" |
6957 | [(set_attr "type" "alu1")]) | |
6958 | ||
6959 | @end smallexample | |
6960 | ||
ebb48a4d | 6961 | In this case, the actual split condition will be |
aee96fe9 | 6962 | @samp{TARGET_ZERO_EXTEND_WITH_AND && !optimize_size && reload_completed}. |
c88c0d42 CP |
6963 | |
6964 | The @code{define_insn_and_split} construction provides exactly the same | |
6965 | functionality as two separate @code{define_insn} and @code{define_split} | |
6966 | patterns. It exists for compactness, and as a maintenance tool to prevent | |
6967 | having to ensure the two patterns' templates match. | |
6968 | ||
a5249a21 HPN |
6969 | @end ifset |
6970 | @ifset INTERNALS | |
04d8aa70 AM |
6971 | @node Including Patterns |
6972 | @section Including Patterns in Machine Descriptions. | |
6973 | @cindex insn includes | |
6974 | ||
6975 | @findex include | |
6976 | The @code{include} pattern tells the compiler tools where to | |
6977 | look for patterns that are in files other than in the file | |
8a36672b | 6978 | @file{.md}. This is used only at build time and there is no preprocessing allowed. |
04d8aa70 AM |
6979 | |
6980 | It looks like: | |
6981 | ||
6982 | @smallexample | |
6983 | ||
6984 | (include | |
6985 | @var{pathname}) | |
6986 | @end smallexample | |
6987 | ||
6988 | For example: | |
6989 | ||
6990 | @smallexample | |
6991 | ||
f282ffb3 | 6992 | (include "filestuff") |
04d8aa70 AM |
6993 | |
6994 | @end smallexample | |
6995 | ||
27d30956 | 6996 | Where @var{pathname} is a string that specifies the location of the file, |
8a36672b | 6997 | specifies the include file to be in @file{gcc/config/target/filestuff}. The |
04d8aa70 AM |
6998 | directory @file{gcc/config/target} is regarded as the default directory. |
6999 | ||
7000 | ||
f282ffb3 JM |
7001 | Machine descriptions may be split up into smaller more manageable subsections |
7002 | and placed into subdirectories. | |
04d8aa70 AM |
7003 | |
7004 | By specifying: | |
7005 | ||
7006 | @smallexample | |
7007 | ||
f282ffb3 | 7008 | (include "BOGUS/filestuff") |
04d8aa70 AM |
7009 | |
7010 | @end smallexample | |
7011 | ||
7012 | the include file is specified to be in @file{gcc/config/@var{target}/BOGUS/filestuff}. | |
7013 | ||
7014 | Specifying an absolute path for the include file such as; | |
7015 | @smallexample | |
7016 | ||
f282ffb3 | 7017 | (include "/u2/BOGUS/filestuff") |
04d8aa70 AM |
7018 | |
7019 | @end smallexample | |
f282ffb3 | 7020 | is permitted but is not encouraged. |
04d8aa70 AM |
7021 | |
7022 | @subsection RTL Generation Tool Options for Directory Search | |
7023 | @cindex directory options .md | |
7024 | @cindex options, directory search | |
7025 | @cindex search options | |
7026 | ||
7027 | The @option{-I@var{dir}} option specifies directories to search for machine descriptions. | |
7028 | For example: | |
7029 | ||
7030 | @smallexample | |
7031 | ||
7032 | genrecog -I/p1/abc/proc1 -I/p2/abcd/pro2 target.md | |
7033 | ||
7034 | @end smallexample | |
7035 | ||
7036 | ||
7037 | Add the directory @var{dir} to the head of the list of directories to be | |
7038 | searched for header files. This can be used to override a system machine definition | |
7039 | file, substituting your own version, since these directories are | |
7040 | searched before the default machine description file directories. If you use more than | |
7041 | one @option{-I} option, the directories are scanned in left-to-right | |
7042 | order; the standard default directory come after. | |
7043 | ||
7044 | ||
a5249a21 HPN |
7045 | @end ifset |
7046 | @ifset INTERNALS | |
f3a3d0d3 RH |
7047 | @node Peephole Definitions |
7048 | @section Machine-Specific Peephole Optimizers | |
7049 | @cindex peephole optimizer definitions | |
7050 | @cindex defining peephole optimizers | |
7051 | ||
7052 | In addition to instruction patterns the @file{md} file may contain | |
7053 | definitions of machine-specific peephole optimizations. | |
7054 | ||
7055 | The combiner does not notice certain peephole optimizations when the data | |
7056 | flow in the program does not suggest that it should try them. For example, | |
7057 | sometimes two consecutive insns related in purpose can be combined even | |
7058 | though the second one does not appear to use a register computed in the | |
7059 | first one. A machine-specific peephole optimizer can detect such | |
7060 | opportunities. | |
7061 | ||
7062 | There are two forms of peephole definitions that may be used. The | |
7063 | original @code{define_peephole} is run at assembly output time to | |
7064 | match insns and substitute assembly text. Use of @code{define_peephole} | |
7065 | is deprecated. | |
7066 | ||
7067 | A newer @code{define_peephole2} matches insns and substitutes new | |
7068 | insns. The @code{peephole2} pass is run after register allocation | |
ebb48a4d | 7069 | but before scheduling, which may result in much better code for |
f3a3d0d3 RH |
7070 | targets that do scheduling. |
7071 | ||
7072 | @menu | |
7073 | * define_peephole:: RTL to Text Peephole Optimizers | |
7074 | * define_peephole2:: RTL to RTL Peephole Optimizers | |
7075 | @end menu | |
7076 | ||
a5249a21 HPN |
7077 | @end ifset |
7078 | @ifset INTERNALS | |
f3a3d0d3 RH |
7079 | @node define_peephole |
7080 | @subsection RTL to Text Peephole Optimizers | |
7081 | @findex define_peephole | |
7082 | ||
7083 | @need 1000 | |
7084 | A definition looks like this: | |
7085 | ||
7086 | @smallexample | |
7087 | (define_peephole | |
7088 | [@var{insn-pattern-1} | |
7089 | @var{insn-pattern-2} | |
7090 | @dots{}] | |
7091 | "@var{condition}" | |
7092 | "@var{template}" | |
630d3d5a | 7093 | "@var{optional-insn-attributes}") |
f3a3d0d3 RH |
7094 | @end smallexample |
7095 | ||
7096 | @noindent | |
7097 | The last string operand may be omitted if you are not using any | |
7098 | machine-specific information in this machine description. If present, | |
7099 | it must obey the same rules as in a @code{define_insn}. | |
7100 | ||
7101 | In this skeleton, @var{insn-pattern-1} and so on are patterns to match | |
7102 | consecutive insns. The optimization applies to a sequence of insns when | |
7103 | @var{insn-pattern-1} matches the first one, @var{insn-pattern-2} matches | |
bd819a4a | 7104 | the next, and so on. |
f3a3d0d3 RH |
7105 | |
7106 | Each of the insns matched by a peephole must also match a | |
7107 | @code{define_insn}. Peepholes are checked only at the last stage just | |
7108 | before code generation, and only optionally. Therefore, any insn which | |
7109 | would match a peephole but no @code{define_insn} will cause a crash in code | |
7110 | generation in an unoptimized compilation, or at various optimization | |
7111 | stages. | |
7112 | ||
7113 | The operands of the insns are matched with @code{match_operands}, | |
7114 | @code{match_operator}, and @code{match_dup}, as usual. What is not | |
7115 | usual is that the operand numbers apply to all the insn patterns in the | |
7116 | definition. So, you can check for identical operands in two insns by | |
7117 | using @code{match_operand} in one insn and @code{match_dup} in the | |
7118 | other. | |
7119 | ||
7120 | The operand constraints used in @code{match_operand} patterns do not have | |
7121 | any direct effect on the applicability of the peephole, but they will | |
7122 | be validated afterward, so make sure your constraints are general enough | |
7123 | to apply whenever the peephole matches. If the peephole matches | |
7124 | but the constraints are not satisfied, the compiler will crash. | |
7125 | ||
7126 | It is safe to omit constraints in all the operands of the peephole; or | |
7127 | you can write constraints which serve as a double-check on the criteria | |
7128 | previously tested. | |
7129 | ||
7130 | Once a sequence of insns matches the patterns, the @var{condition} is | |
7131 | checked. This is a C expression which makes the final decision whether to | |
7132 | perform the optimization (we do so if the expression is nonzero). If | |
7133 | @var{condition} is omitted (in other words, the string is empty) then the | |
7134 | optimization is applied to every sequence of insns that matches the | |
7135 | patterns. | |
7136 | ||
7137 | The defined peephole optimizations are applied after register allocation | |
7138 | is complete. Therefore, the peephole definition can check which | |
7139 | operands have ended up in which kinds of registers, just by looking at | |
7140 | the operands. | |
7141 | ||
7142 | @findex prev_active_insn | |
7143 | The way to refer to the operands in @var{condition} is to write | |
7144 | @code{operands[@var{i}]} for operand number @var{i} (as matched by | |
7145 | @code{(match_operand @var{i} @dots{})}). Use the variable @code{insn} | |
7146 | to refer to the last of the insns being matched; use | |
7147 | @code{prev_active_insn} to find the preceding insns. | |
7148 | ||
7149 | @findex dead_or_set_p | |
7150 | When optimizing computations with intermediate results, you can use | |
7151 | @var{condition} to match only when the intermediate results are not used | |
7152 | elsewhere. Use the C expression @code{dead_or_set_p (@var{insn}, | |
7153 | @var{op})}, where @var{insn} is the insn in which you expect the value | |
7154 | to be used for the last time (from the value of @code{insn}, together | |
7155 | with use of @code{prev_nonnote_insn}), and @var{op} is the intermediate | |
bd819a4a | 7156 | value (from @code{operands[@var{i}]}). |
f3a3d0d3 RH |
7157 | |
7158 | Applying the optimization means replacing the sequence of insns with one | |
7159 | new insn. The @var{template} controls ultimate output of assembler code | |
7160 | for this combined insn. It works exactly like the template of a | |
7161 | @code{define_insn}. Operand numbers in this template are the same ones | |
7162 | used in matching the original sequence of insns. | |
7163 | ||
7164 | The result of a defined peephole optimizer does not need to match any of | |
7165 | the insn patterns in the machine description; it does not even have an | |
7166 | opportunity to match them. The peephole optimizer definition itself serves | |
7167 | as the insn pattern to control how the insn is output. | |
7168 | ||
7169 | Defined peephole optimizers are run as assembler code is being output, | |
7170 | so the insns they produce are never combined or rearranged in any way. | |
7171 | ||
7172 | Here is an example, taken from the 68000 machine description: | |
7173 | ||
7174 | @smallexample | |
7175 | (define_peephole | |
7176 | [(set (reg:SI 15) (plus:SI (reg:SI 15) (const_int 4))) | |
7177 | (set (match_operand:DF 0 "register_operand" "=f") | |
7178 | (match_operand:DF 1 "register_operand" "ad"))] | |
7179 | "FP_REG_P (operands[0]) && ! FP_REG_P (operands[1])" | |
f3a3d0d3 RH |
7180 | @{ |
7181 | rtx xoperands[2]; | |
a2a8cc44 | 7182 | xoperands[1] = gen_rtx_REG (SImode, REGNO (operands[1]) + 1); |
f3a3d0d3 | 7183 | #ifdef MOTOROLA |
0f40f9f7 ZW |
7184 | output_asm_insn ("move.l %1,(sp)", xoperands); |
7185 | output_asm_insn ("move.l %1,-(sp)", operands); | |
7186 | return "fmove.d (sp)+,%0"; | |
f3a3d0d3 | 7187 | #else |
0f40f9f7 ZW |
7188 | output_asm_insn ("movel %1,sp@@", xoperands); |
7189 | output_asm_insn ("movel %1,sp@@-", operands); | |
7190 | return "fmoved sp@@+,%0"; | |
f3a3d0d3 | 7191 | #endif |
0f40f9f7 | 7192 | @}) |
f3a3d0d3 RH |
7193 | @end smallexample |
7194 | ||
7195 | @need 1000 | |
7196 | The effect of this optimization is to change | |
7197 | ||
7198 | @smallexample | |
7199 | @group | |
7200 | jbsr _foobar | |
7201 | addql #4,sp | |
7202 | movel d1,sp@@- | |
7203 | movel d0,sp@@- | |
7204 | fmoved sp@@+,fp0 | |
7205 | @end group | |
7206 | @end smallexample | |
7207 | ||
7208 | @noindent | |
7209 | into | |
7210 | ||
7211 | @smallexample | |
7212 | @group | |
7213 | jbsr _foobar | |
7214 | movel d1,sp@@ | |
7215 | movel d0,sp@@- | |
7216 | fmoved sp@@+,fp0 | |
7217 | @end group | |
7218 | @end smallexample | |
7219 | ||
7220 | @ignore | |
7221 | @findex CC_REVERSED | |
7222 | If a peephole matches a sequence including one or more jump insns, you must | |
7223 | take account of the flags such as @code{CC_REVERSED} which specify that the | |
7224 | condition codes are represented in an unusual manner. The compiler | |
7225 | automatically alters any ordinary conditional jumps which occur in such | |
7226 | situations, but the compiler cannot alter jumps which have been replaced by | |
7227 | peephole optimizations. So it is up to you to alter the assembler code | |
7228 | that the peephole produces. Supply C code to write the assembler output, | |
7229 | and in this C code check the condition code status flags and change the | |
7230 | assembler code as appropriate. | |
7231 | @end ignore | |
7232 | ||
7233 | @var{insn-pattern-1} and so on look @emph{almost} like the second | |
7234 | operand of @code{define_insn}. There is one important difference: the | |
7235 | second operand of @code{define_insn} consists of one or more RTX's | |
7236 | enclosed in square brackets. Usually, there is only one: then the same | |
7237 | action can be written as an element of a @code{define_peephole}. But | |
7238 | when there are multiple actions in a @code{define_insn}, they are | |
7239 | implicitly enclosed in a @code{parallel}. Then you must explicitly | |
7240 | write the @code{parallel}, and the square brackets within it, in the | |
7241 | @code{define_peephole}. Thus, if an insn pattern looks like this, | |
7242 | ||
7243 | @smallexample | |
7244 | (define_insn "divmodsi4" | |
7245 | [(set (match_operand:SI 0 "general_operand" "=d") | |
7246 | (div:SI (match_operand:SI 1 "general_operand" "0") | |
7247 | (match_operand:SI 2 "general_operand" "dmsK"))) | |
7248 | (set (match_operand:SI 3 "general_operand" "=d") | |
7249 | (mod:SI (match_dup 1) (match_dup 2)))] | |
7250 | "TARGET_68020" | |
7251 | "divsl%.l %2,%3:%0") | |
7252 | @end smallexample | |
7253 | ||
7254 | @noindent | |
7255 | then the way to mention this insn in a peephole is as follows: | |
7256 | ||
7257 | @smallexample | |
7258 | (define_peephole | |
7259 | [@dots{} | |
7260 | (parallel | |
7261 | [(set (match_operand:SI 0 "general_operand" "=d") | |
7262 | (div:SI (match_operand:SI 1 "general_operand" "0") | |
7263 | (match_operand:SI 2 "general_operand" "dmsK"))) | |
7264 | (set (match_operand:SI 3 "general_operand" "=d") | |
7265 | (mod:SI (match_dup 1) (match_dup 2)))]) | |
7266 | @dots{}] | |
7267 | @dots{}) | |
7268 | @end smallexample | |
7269 | ||
a5249a21 HPN |
7270 | @end ifset |
7271 | @ifset INTERNALS | |
f3a3d0d3 RH |
7272 | @node define_peephole2 |
7273 | @subsection RTL to RTL Peephole Optimizers | |
7274 | @findex define_peephole2 | |
7275 | ||
7276 | The @code{define_peephole2} definition tells the compiler how to | |
ebb48a4d | 7277 | substitute one sequence of instructions for another sequence, |
f3a3d0d3 RH |
7278 | what additional scratch registers may be needed and what their |
7279 | lifetimes must be. | |
7280 | ||
7281 | @smallexample | |
7282 | (define_peephole2 | |
7283 | [@var{insn-pattern-1} | |
7284 | @var{insn-pattern-2} | |
7285 | @dots{}] | |
7286 | "@var{condition}" | |
7287 | [@var{new-insn-pattern-1} | |
7288 | @var{new-insn-pattern-2} | |
7289 | @dots{}] | |
630d3d5a | 7290 | "@var{preparation-statements}") |
f3a3d0d3 RH |
7291 | @end smallexample |
7292 | ||
7293 | The definition is almost identical to @code{define_split} | |
7294 | (@pxref{Insn Splitting}) except that the pattern to match is not a | |
7295 | single instruction, but a sequence of instructions. | |
7296 | ||
7297 | It is possible to request additional scratch registers for use in the | |
7298 | output template. If appropriate registers are not free, the pattern | |
7299 | will simply not match. | |
7300 | ||
7301 | @findex match_scratch | |
7302 | @findex match_dup | |
7303 | Scratch registers are requested with a @code{match_scratch} pattern at | |
7304 | the top level of the input pattern. The allocated register (initially) will | |
7305 | be dead at the point requested within the original sequence. If the scratch | |
7306 | is used at more than a single point, a @code{match_dup} pattern at the | |
7307 | top level of the input pattern marks the last position in the input sequence | |
7308 | at which the register must be available. | |
7309 | ||
7310 | Here is an example from the IA-32 machine description: | |
7311 | ||
7312 | @smallexample | |
7313 | (define_peephole2 | |
7314 | [(match_scratch:SI 2 "r") | |
7315 | (parallel [(set (match_operand:SI 0 "register_operand" "") | |
7316 | (match_operator:SI 3 "arith_or_logical_operator" | |
7317 | [(match_dup 0) | |
7318 | (match_operand:SI 1 "memory_operand" "")])) | |
7319 | (clobber (reg:CC 17))])] | |
7320 | "! optimize_size && ! TARGET_READ_MODIFY" | |
7321 | [(set (match_dup 2) (match_dup 1)) | |
7322 | (parallel [(set (match_dup 0) | |
7323 | (match_op_dup 3 [(match_dup 0) (match_dup 2)])) | |
7324 | (clobber (reg:CC 17))])] | |
7325 | "") | |
7326 | @end smallexample | |
7327 | ||
7328 | @noindent | |
7329 | This pattern tries to split a load from its use in the hopes that we'll be | |
7330 | able to schedule around the memory load latency. It allocates a single | |
7331 | @code{SImode} register of class @code{GENERAL_REGS} (@code{"r"}) that needs | |
7332 | to be live only at the point just before the arithmetic. | |
7333 | ||
b192711e | 7334 | A real example requiring extended scratch lifetimes is harder to come by, |
f3a3d0d3 RH |
7335 | so here's a silly made-up example: |
7336 | ||
7337 | @smallexample | |
7338 | (define_peephole2 | |
7339 | [(match_scratch:SI 4 "r") | |
7340 | (set (match_operand:SI 0 "" "") (match_operand:SI 1 "" "")) | |
7341 | (set (match_operand:SI 2 "" "") (match_dup 1)) | |
7342 | (match_dup 4) | |
7343 | (set (match_operand:SI 3 "" "") (match_dup 1))] | |
630d3d5a | 7344 | "/* @r{determine 1 does not overlap 0 and 2} */" |
f3a3d0d3 RH |
7345 | [(set (match_dup 4) (match_dup 1)) |
7346 | (set (match_dup 0) (match_dup 4)) | |
7347 | (set (match_dup 2) (match_dup 4))] | |
7348 | (set (match_dup 3) (match_dup 4))] | |
7349 | "") | |
7350 | @end smallexample | |
7351 | ||
7352 | @noindent | |
a628d195 RH |
7353 | If we had not added the @code{(match_dup 4)} in the middle of the input |
7354 | sequence, it might have been the case that the register we chose at the | |
7355 | beginning of the sequence is killed by the first or second @code{set}. | |
f3a3d0d3 | 7356 | |
a5249a21 HPN |
7357 | @end ifset |
7358 | @ifset INTERNALS | |
03dda8e3 RK |
7359 | @node Insn Attributes |
7360 | @section Instruction Attributes | |
7361 | @cindex insn attributes | |
7362 | @cindex instruction attributes | |
7363 | ||
7364 | In addition to describing the instruction supported by the target machine, | |
7365 | the @file{md} file also defines a group of @dfn{attributes} and a set of | |
7366 | values for each. Every generated insn is assigned a value for each attribute. | |
7367 | One possible attribute would be the effect that the insn has on the machine's | |
7368 | condition code. This attribute can then be used by @code{NOTICE_UPDATE_CC} | |
7369 | to track the condition codes. | |
7370 | ||
7371 | @menu | |
7372 | * Defining Attributes:: Specifying attributes and their values. | |
7373 | * Expressions:: Valid expressions for attribute values. | |
7374 | * Tagging Insns:: Assigning attribute values to insns. | |
7375 | * Attr Example:: An example of assigning attributes. | |
7376 | * Insn Lengths:: Computing the length of insns. | |
7377 | * Constant Attributes:: Defining attributes that are constant. | |
7378 | * Delay Slots:: Defining delay slots required for a machine. | |
fae15c93 | 7379 | * Processor pipeline description:: Specifying information for insn scheduling. |
03dda8e3 RK |
7380 | @end menu |
7381 | ||
a5249a21 HPN |
7382 | @end ifset |
7383 | @ifset INTERNALS | |
03dda8e3 RK |
7384 | @node Defining Attributes |
7385 | @subsection Defining Attributes and their Values | |
7386 | @cindex defining attributes and their values | |
7387 | @cindex attributes, defining | |
7388 | ||
7389 | @findex define_attr | |
7390 | The @code{define_attr} expression is used to define each attribute required | |
7391 | by the target machine. It looks like: | |
7392 | ||
7393 | @smallexample | |
7394 | (define_attr @var{name} @var{list-of-values} @var{default}) | |
7395 | @end smallexample | |
7396 | ||
7397 | @var{name} is a string specifying the name of the attribute being defined. | |
0bddee8e BS |
7398 | Some attributes are used in a special way by the rest of the compiler. The |
7399 | @code{enabled} attribute can be used to conditionally enable or disable | |
7400 | insn alternatives (@pxref{Disable Insn Alternatives}). The @code{predicable} | |
7401 | attribute, together with a suitable @code{define_cond_exec} | |
7402 | (@pxref{Conditional Execution}), can be used to automatically generate | |
7403 | conditional variants of instruction patterns. The compiler internally uses | |
7404 | the names @code{ce_enabled} and @code{nonce_enabled}, so they should not be | |
7405 | used elsewhere as alternative names. | |
03dda8e3 RK |
7406 | |
7407 | @var{list-of-values} is either a string that specifies a comma-separated | |
7408 | list of values that can be assigned to the attribute, or a null string to | |
7409 | indicate that the attribute takes numeric values. | |
7410 | ||
7411 | @var{default} is an attribute expression that gives the value of this | |
7412 | attribute for insns that match patterns whose definition does not include | |
7413 | an explicit value for this attribute. @xref{Attr Example}, for more | |
7414 | information on the handling of defaults. @xref{Constant Attributes}, | |
7415 | for information on attributes that do not depend on any particular insn. | |
7416 | ||
7417 | @findex insn-attr.h | |
7418 | For each defined attribute, a number of definitions are written to the | |
7419 | @file{insn-attr.h} file. For cases where an explicit set of values is | |
7420 | specified for an attribute, the following are defined: | |
7421 | ||
7422 | @itemize @bullet | |
7423 | @item | |
7424 | A @samp{#define} is written for the symbol @samp{HAVE_ATTR_@var{name}}. | |
7425 | ||
7426 | @item | |
2eac577f | 7427 | An enumerated class is defined for @samp{attr_@var{name}} with |
03dda8e3 | 7428 | elements of the form @samp{@var{upper-name}_@var{upper-value}} where |
4bd0bee9 | 7429 | the attribute name and value are first converted to uppercase. |
03dda8e3 RK |
7430 | |
7431 | @item | |
7432 | A function @samp{get_attr_@var{name}} is defined that is passed an insn and | |
7433 | returns the attribute value for that insn. | |
7434 | @end itemize | |
7435 | ||
7436 | For example, if the following is present in the @file{md} file: | |
7437 | ||
7438 | @smallexample | |
7439 | (define_attr "type" "branch,fp,load,store,arith" @dots{}) | |
7440 | @end smallexample | |
7441 | ||
7442 | @noindent | |
7443 | the following lines will be written to the file @file{insn-attr.h}. | |
7444 | ||
7445 | @smallexample | |
7446 | #define HAVE_ATTR_type | |
7447 | enum attr_type @{TYPE_BRANCH, TYPE_FP, TYPE_LOAD, | |
7448 | TYPE_STORE, TYPE_ARITH@}; | |
7449 | extern enum attr_type get_attr_type (); | |
7450 | @end smallexample | |
7451 | ||
7452 | If the attribute takes numeric values, no @code{enum} type will be | |
7453 | defined and the function to obtain the attribute's value will return | |
7454 | @code{int}. | |
7455 | ||
7ac28727 AK |
7456 | There are attributes which are tied to a specific meaning. These |
7457 | attributes are not free to use for other purposes: | |
7458 | ||
7459 | @table @code | |
7460 | @item length | |
7461 | The @code{length} attribute is used to calculate the length of emitted | |
7462 | code chunks. This is especially important when verifying branch | |
7463 | distances. @xref{Insn Lengths}. | |
7464 | ||
7465 | @item enabled | |
7466 | The @code{enabled} attribute can be defined to prevent certain | |
7467 | alternatives of an insn definition from being used during code | |
7468 | generation. @xref{Disable Insn Alternatives}. | |
7ac28727 AK |
7469 | @end table |
7470 | ||
8f4fe86c RS |
7471 | @findex define_enum_attr |
7472 | @anchor{define_enum_attr} | |
7473 | Another way of defining an attribute is to use: | |
7474 | ||
7475 | @smallexample | |
7476 | (define_enum_attr "@var{attr}" "@var{enum}" @var{default}) | |
7477 | @end smallexample | |
7478 | ||
7479 | This works in just the same way as @code{define_attr}, except that | |
7480 | the list of values is taken from a separate enumeration called | |
7481 | @var{enum} (@pxref{define_enum}). This form allows you to use | |
7482 | the same list of values for several attributes without having to | |
7483 | repeat the list each time. For example: | |
7484 | ||
7485 | @smallexample | |
7486 | (define_enum "processor" [ | |
7487 | model_a | |
7488 | model_b | |
7489 | @dots{} | |
7490 | ]) | |
7491 | (define_enum_attr "arch" "processor" | |
7492 | (const (symbol_ref "target_arch"))) | |
7493 | (define_enum_attr "tune" "processor" | |
7494 | (const (symbol_ref "target_tune"))) | |
7495 | @end smallexample | |
7496 | ||
7497 | defines the same attributes as: | |
7498 | ||
7499 | @smallexample | |
7500 | (define_attr "arch" "model_a,model_b,@dots{}" | |
7501 | (const (symbol_ref "target_arch"))) | |
7502 | (define_attr "tune" "model_a,model_b,@dots{}" | |
7503 | (const (symbol_ref "target_tune"))) | |
7504 | @end smallexample | |
7505 | ||
7506 | but without duplicating the processor list. The second example defines two | |
7507 | separate C enums (@code{attr_arch} and @code{attr_tune}) whereas the first | |
7508 | defines a single C enum (@code{processor}). | |
a5249a21 HPN |
7509 | @end ifset |
7510 | @ifset INTERNALS | |
03dda8e3 RK |
7511 | @node Expressions |
7512 | @subsection Attribute Expressions | |
7513 | @cindex attribute expressions | |
7514 | ||
7515 | RTL expressions used to define attributes use the codes described above | |
7516 | plus a few specific to attribute definitions, to be discussed below. | |
7517 | Attribute value expressions must have one of the following forms: | |
7518 | ||
7519 | @table @code | |
7520 | @cindex @code{const_int} and attributes | |
7521 | @item (const_int @var{i}) | |
7522 | The integer @var{i} specifies the value of a numeric attribute. @var{i} | |
7523 | must be non-negative. | |
7524 | ||
7525 | The value of a numeric attribute can be specified either with a | |
00bc45c1 RH |
7526 | @code{const_int}, or as an integer represented as a string in |
7527 | @code{const_string}, @code{eq_attr} (see below), @code{attr}, | |
7528 | @code{symbol_ref}, simple arithmetic expressions, and @code{set_attr} | |
7529 | overrides on specific instructions (@pxref{Tagging Insns}). | |
03dda8e3 RK |
7530 | |
7531 | @cindex @code{const_string} and attributes | |
7532 | @item (const_string @var{value}) | |
7533 | The string @var{value} specifies a constant attribute value. | |
7534 | If @var{value} is specified as @samp{"*"}, it means that the default value of | |
7535 | the attribute is to be used for the insn containing this expression. | |
7536 | @samp{"*"} obviously cannot be used in the @var{default} expression | |
bd819a4a | 7537 | of a @code{define_attr}. |
03dda8e3 RK |
7538 | |
7539 | If the attribute whose value is being specified is numeric, @var{value} | |
7540 | must be a string containing a non-negative integer (normally | |
7541 | @code{const_int} would be used in this case). Otherwise, it must | |
7542 | contain one of the valid values for the attribute. | |
7543 | ||
7544 | @cindex @code{if_then_else} and attributes | |
7545 | @item (if_then_else @var{test} @var{true-value} @var{false-value}) | |
7546 | @var{test} specifies an attribute test, whose format is defined below. | |
7547 | The value of this expression is @var{true-value} if @var{test} is true, | |
7548 | otherwise it is @var{false-value}. | |
7549 | ||
7550 | @cindex @code{cond} and attributes | |
7551 | @item (cond [@var{test1} @var{value1} @dots{}] @var{default}) | |
7552 | The first operand of this expression is a vector containing an even | |
7553 | number of expressions and consisting of pairs of @var{test} and @var{value} | |
7554 | expressions. The value of the @code{cond} expression is that of the | |
7555 | @var{value} corresponding to the first true @var{test} expression. If | |
7556 | none of the @var{test} expressions are true, the value of the @code{cond} | |
7557 | expression is that of the @var{default} expression. | |
7558 | @end table | |
7559 | ||
7560 | @var{test} expressions can have one of the following forms: | |
7561 | ||
7562 | @table @code | |
7563 | @cindex @code{const_int} and attribute tests | |
7564 | @item (const_int @var{i}) | |
df2a54e9 | 7565 | This test is true if @var{i} is nonzero and false otherwise. |
03dda8e3 RK |
7566 | |
7567 | @cindex @code{not} and attributes | |
7568 | @cindex @code{ior} and attributes | |
7569 | @cindex @code{and} and attributes | |
7570 | @item (not @var{test}) | |
7571 | @itemx (ior @var{test1} @var{test2}) | |
7572 | @itemx (and @var{test1} @var{test2}) | |
7573 | These tests are true if the indicated logical function is true. | |
7574 | ||
7575 | @cindex @code{match_operand} and attributes | |
7576 | @item (match_operand:@var{m} @var{n} @var{pred} @var{constraints}) | |
7577 | This test is true if operand @var{n} of the insn whose attribute value | |
7578 | is being determined has mode @var{m} (this part of the test is ignored | |
7579 | if @var{m} is @code{VOIDmode}) and the function specified by the string | |
df2a54e9 | 7580 | @var{pred} returns a nonzero value when passed operand @var{n} and mode |
03dda8e3 RK |
7581 | @var{m} (this part of the test is ignored if @var{pred} is the null |
7582 | string). | |
7583 | ||
7584 | The @var{constraints} operand is ignored and should be the null string. | |
7585 | ||
0c0d3957 RS |
7586 | @cindex @code{match_test} and attributes |
7587 | @item (match_test @var{c-expr}) | |
7588 | The test is true if C expression @var{c-expr} is true. In non-constant | |
7589 | attributes, @var{c-expr} has access to the following variables: | |
7590 | ||
7591 | @table @var | |
7592 | @item insn | |
7593 | The rtl instruction under test. | |
7594 | @item which_alternative | |
7595 | The @code{define_insn} alternative that @var{insn} matches. | |
7596 | @xref{Output Statement}. | |
7597 | @item operands | |
7598 | An array of @var{insn}'s rtl operands. | |
7599 | @end table | |
7600 | ||
7601 | @var{c-expr} behaves like the condition in a C @code{if} statement, | |
7602 | so there is no need to explicitly convert the expression into a boolean | |
7603 | 0 or 1 value. For example, the following two tests are equivalent: | |
7604 | ||
7605 | @smallexample | |
7606 | (match_test "x & 2") | |
7607 | (match_test "(x & 2) != 0") | |
7608 | @end smallexample | |
7609 | ||
03dda8e3 RK |
7610 | @cindex @code{le} and attributes |
7611 | @cindex @code{leu} and attributes | |
7612 | @cindex @code{lt} and attributes | |
7613 | @cindex @code{gt} and attributes | |
7614 | @cindex @code{gtu} and attributes | |
7615 | @cindex @code{ge} and attributes | |
7616 | @cindex @code{geu} and attributes | |
7617 | @cindex @code{ne} and attributes | |
7618 | @cindex @code{eq} and attributes | |
7619 | @cindex @code{plus} and attributes | |
7620 | @cindex @code{minus} and attributes | |
7621 | @cindex @code{mult} and attributes | |
7622 | @cindex @code{div} and attributes | |
7623 | @cindex @code{mod} and attributes | |
7624 | @cindex @code{abs} and attributes | |
7625 | @cindex @code{neg} and attributes | |
7626 | @cindex @code{ashift} and attributes | |
7627 | @cindex @code{lshiftrt} and attributes | |
7628 | @cindex @code{ashiftrt} and attributes | |
7629 | @item (le @var{arith1} @var{arith2}) | |
7630 | @itemx (leu @var{arith1} @var{arith2}) | |
7631 | @itemx (lt @var{arith1} @var{arith2}) | |
7632 | @itemx (ltu @var{arith1} @var{arith2}) | |
7633 | @itemx (gt @var{arith1} @var{arith2}) | |
7634 | @itemx (gtu @var{arith1} @var{arith2}) | |
7635 | @itemx (ge @var{arith1} @var{arith2}) | |
7636 | @itemx (geu @var{arith1} @var{arith2}) | |
7637 | @itemx (ne @var{arith1} @var{arith2}) | |
7638 | @itemx (eq @var{arith1} @var{arith2}) | |
7639 | These tests are true if the indicated comparison of the two arithmetic | |
7640 | expressions is true. Arithmetic expressions are formed with | |
7641 | @code{plus}, @code{minus}, @code{mult}, @code{div}, @code{mod}, | |
7642 | @code{abs}, @code{neg}, @code{and}, @code{ior}, @code{xor}, @code{not}, | |
bd819a4a | 7643 | @code{ashift}, @code{lshiftrt}, and @code{ashiftrt} expressions. |
03dda8e3 RK |
7644 | |
7645 | @findex get_attr | |
7646 | @code{const_int} and @code{symbol_ref} are always valid terms (@pxref{Insn | |
7647 | Lengths},for additional forms). @code{symbol_ref} is a string | |
7648 | denoting a C expression that yields an @code{int} when evaluated by the | |
7649 | @samp{get_attr_@dots{}} routine. It should normally be a global | |
bd819a4a | 7650 | variable. |
03dda8e3 RK |
7651 | |
7652 | @findex eq_attr | |
7653 | @item (eq_attr @var{name} @var{value}) | |
7654 | @var{name} is a string specifying the name of an attribute. | |
7655 | ||
7656 | @var{value} is a string that is either a valid value for attribute | |
7657 | @var{name}, a comma-separated list of values, or @samp{!} followed by a | |
7658 | value or list. If @var{value} does not begin with a @samp{!}, this | |
7659 | test is true if the value of the @var{name} attribute of the current | |
7660 | insn is in the list specified by @var{value}. If @var{value} begins | |
7661 | with a @samp{!}, this test is true if the attribute's value is | |
7662 | @emph{not} in the specified list. | |
7663 | ||
7664 | For example, | |
7665 | ||
7666 | @smallexample | |
7667 | (eq_attr "type" "load,store") | |
7668 | @end smallexample | |
7669 | ||
7670 | @noindent | |
7671 | is equivalent to | |
7672 | ||
7673 | @smallexample | |
7674 | (ior (eq_attr "type" "load") (eq_attr "type" "store")) | |
7675 | @end smallexample | |
7676 | ||
7677 | If @var{name} specifies an attribute of @samp{alternative}, it refers to the | |
7678 | value of the compiler variable @code{which_alternative} | |
7679 | (@pxref{Output Statement}) and the values must be small integers. For | |
bd819a4a | 7680 | example, |
03dda8e3 RK |
7681 | |
7682 | @smallexample | |
7683 | (eq_attr "alternative" "2,3") | |
7684 | @end smallexample | |
7685 | ||
7686 | @noindent | |
7687 | is equivalent to | |
7688 | ||
7689 | @smallexample | |
7690 | (ior (eq (symbol_ref "which_alternative") (const_int 2)) | |
7691 | (eq (symbol_ref "which_alternative") (const_int 3))) | |
7692 | @end smallexample | |
7693 | ||
7694 | Note that, for most attributes, an @code{eq_attr} test is simplified in cases | |
7695 | where the value of the attribute being tested is known for all insns matching | |
bd819a4a | 7696 | a particular pattern. This is by far the most common case. |
03dda8e3 RK |
7697 | |
7698 | @findex attr_flag | |
7699 | @item (attr_flag @var{name}) | |
7700 | The value of an @code{attr_flag} expression is true if the flag | |
7701 | specified by @var{name} is true for the @code{insn} currently being | |
7702 | scheduled. | |
7703 | ||
7704 | @var{name} is a string specifying one of a fixed set of flags to test. | |
7705 | Test the flags @code{forward} and @code{backward} to determine the | |
7706 | direction of a conditional branch. Test the flags @code{very_likely}, | |
7707 | @code{likely}, @code{very_unlikely}, and @code{unlikely} to determine | |
7708 | if a conditional branch is expected to be taken. | |
7709 | ||
7710 | If the @code{very_likely} flag is true, then the @code{likely} flag is also | |
7711 | true. Likewise for the @code{very_unlikely} and @code{unlikely} flags. | |
7712 | ||
7713 | This example describes a conditional branch delay slot which | |
7714 | can be nullified for forward branches that are taken (annul-true) or | |
7715 | for backward branches which are not taken (annul-false). | |
7716 | ||
7717 | @smallexample | |
7718 | (define_delay (eq_attr "type" "cbranch") | |
7719 | [(eq_attr "in_branch_delay" "true") | |
7720 | (and (eq_attr "in_branch_delay" "true") | |
7721 | (attr_flag "forward")) | |
7722 | (and (eq_attr "in_branch_delay" "true") | |
7723 | (attr_flag "backward"))]) | |
7724 | @end smallexample | |
7725 | ||
7726 | The @code{forward} and @code{backward} flags are false if the current | |
7727 | @code{insn} being scheduled is not a conditional branch. | |
7728 | ||
7729 | The @code{very_likely} and @code{likely} flags are true if the | |
7730 | @code{insn} being scheduled is not a conditional branch. | |
7731 | The @code{very_unlikely} and @code{unlikely} flags are false if the | |
7732 | @code{insn} being scheduled is not a conditional branch. | |
7733 | ||
7734 | @code{attr_flag} is only used during delay slot scheduling and has no | |
7735 | meaning to other passes of the compiler. | |
00bc45c1 RH |
7736 | |
7737 | @findex attr | |
7738 | @item (attr @var{name}) | |
7739 | The value of another attribute is returned. This is most useful | |
7740 | for numeric attributes, as @code{eq_attr} and @code{attr_flag} | |
7741 | produce more efficient code for non-numeric attributes. | |
03dda8e3 RK |
7742 | @end table |
7743 | ||
a5249a21 HPN |
7744 | @end ifset |
7745 | @ifset INTERNALS | |
03dda8e3 RK |
7746 | @node Tagging Insns |
7747 | @subsection Assigning Attribute Values to Insns | |
7748 | @cindex tagging insns | |
7749 | @cindex assigning attribute values to insns | |
7750 | ||
7751 | The value assigned to an attribute of an insn is primarily determined by | |
7752 | which pattern is matched by that insn (or which @code{define_peephole} | |
7753 | generated it). Every @code{define_insn} and @code{define_peephole} can | |
7754 | have an optional last argument to specify the values of attributes for | |
7755 | matching insns. The value of any attribute not specified in a particular | |
7756 | insn is set to the default value for that attribute, as specified in its | |
7757 | @code{define_attr}. Extensive use of default values for attributes | |
7758 | permits the specification of the values for only one or two attributes | |
7759 | in the definition of most insn patterns, as seen in the example in the | |
bd819a4a | 7760 | next section. |
03dda8e3 RK |
7761 | |
7762 | The optional last argument of @code{define_insn} and | |
7763 | @code{define_peephole} is a vector of expressions, each of which defines | |
7764 | the value for a single attribute. The most general way of assigning an | |
7765 | attribute's value is to use a @code{set} expression whose first operand is an | |
7766 | @code{attr} expression giving the name of the attribute being set. The | |
7767 | second operand of the @code{set} is an attribute expression | |
bd819a4a | 7768 | (@pxref{Expressions}) giving the value of the attribute. |
03dda8e3 RK |
7769 | |
7770 | When the attribute value depends on the @samp{alternative} attribute | |
7771 | (i.e., which is the applicable alternative in the constraint of the | |
7772 | insn), the @code{set_attr_alternative} expression can be used. It | |
7773 | allows the specification of a vector of attribute expressions, one for | |
7774 | each alternative. | |
7775 | ||
7776 | @findex set_attr | |
7777 | When the generality of arbitrary attribute expressions is not required, | |
7778 | the simpler @code{set_attr} expression can be used, which allows | |
7779 | specifying a string giving either a single attribute value or a list | |
7780 | of attribute values, one for each alternative. | |
7781 | ||
7782 | The form of each of the above specifications is shown below. In each case, | |
7783 | @var{name} is a string specifying the attribute to be set. | |
7784 | ||
7785 | @table @code | |
7786 | @item (set_attr @var{name} @var{value-string}) | |
7787 | @var{value-string} is either a string giving the desired attribute value, | |
7788 | or a string containing a comma-separated list giving the values for | |
7789 | succeeding alternatives. The number of elements must match the number | |
7790 | of alternatives in the constraint of the insn pattern. | |
7791 | ||
7792 | Note that it may be useful to specify @samp{*} for some alternative, in | |
7793 | which case the attribute will assume its default value for insns matching | |
7794 | that alternative. | |
7795 | ||
7796 | @findex set_attr_alternative | |
7797 | @item (set_attr_alternative @var{name} [@var{value1} @var{value2} @dots{}]) | |
7798 | Depending on the alternative of the insn, the value will be one of the | |
7799 | specified values. This is a shorthand for using a @code{cond} with | |
7800 | tests on the @samp{alternative} attribute. | |
7801 | ||
7802 | @findex attr | |
7803 | @item (set (attr @var{name}) @var{value}) | |
7804 | The first operand of this @code{set} must be the special RTL expression | |
7805 | @code{attr}, whose sole operand is a string giving the name of the | |
7806 | attribute being set. @var{value} is the value of the attribute. | |
7807 | @end table | |
7808 | ||
7809 | The following shows three different ways of representing the same | |
7810 | attribute value specification: | |
7811 | ||
7812 | @smallexample | |
7813 | (set_attr "type" "load,store,arith") | |
7814 | ||
7815 | (set_attr_alternative "type" | |
7816 | [(const_string "load") (const_string "store") | |
7817 | (const_string "arith")]) | |
7818 | ||
7819 | (set (attr "type") | |
7820 | (cond [(eq_attr "alternative" "1") (const_string "load") | |
7821 | (eq_attr "alternative" "2") (const_string "store")] | |
7822 | (const_string "arith"))) | |
7823 | @end smallexample | |
7824 | ||
7825 | @need 1000 | |
7826 | @findex define_asm_attributes | |
7827 | The @code{define_asm_attributes} expression provides a mechanism to | |
7828 | specify the attributes assigned to insns produced from an @code{asm} | |
7829 | statement. It has the form: | |
7830 | ||
7831 | @smallexample | |
7832 | (define_asm_attributes [@var{attr-sets}]) | |
7833 | @end smallexample | |
7834 | ||
7835 | @noindent | |
7836 | where @var{attr-sets} is specified the same as for both the | |
7837 | @code{define_insn} and the @code{define_peephole} expressions. | |
7838 | ||
7839 | These values will typically be the ``worst case'' attribute values. For | |
7840 | example, they might indicate that the condition code will be clobbered. | |
7841 | ||
7842 | A specification for a @code{length} attribute is handled specially. The | |
7843 | way to compute the length of an @code{asm} insn is to multiply the | |
7844 | length specified in the expression @code{define_asm_attributes} by the | |
7845 | number of machine instructions specified in the @code{asm} statement, | |
7846 | determined by counting the number of semicolons and newlines in the | |
7847 | string. Therefore, the value of the @code{length} attribute specified | |
7848 | in a @code{define_asm_attributes} should be the maximum possible length | |
7849 | of a single machine instruction. | |
7850 | ||
a5249a21 HPN |
7851 | @end ifset |
7852 | @ifset INTERNALS | |
03dda8e3 RK |
7853 | @node Attr Example |
7854 | @subsection Example of Attribute Specifications | |
7855 | @cindex attribute specifications example | |
7856 | @cindex attribute specifications | |
7857 | ||
7858 | The judicious use of defaulting is important in the efficient use of | |
7859 | insn attributes. Typically, insns are divided into @dfn{types} and an | |
7860 | attribute, customarily called @code{type}, is used to represent this | |
7861 | value. This attribute is normally used only to define the default value | |
7862 | for other attributes. An example will clarify this usage. | |
7863 | ||
7864 | Assume we have a RISC machine with a condition code and in which only | |
7865 | full-word operations are performed in registers. Let us assume that we | |
7866 | can divide all insns into loads, stores, (integer) arithmetic | |
7867 | operations, floating point operations, and branches. | |
7868 | ||
7869 | Here we will concern ourselves with determining the effect of an insn on | |
7870 | the condition code and will limit ourselves to the following possible | |
7871 | effects: The condition code can be set unpredictably (clobbered), not | |
7872 | be changed, be set to agree with the results of the operation, or only | |
7873 | changed if the item previously set into the condition code has been | |
7874 | modified. | |
7875 | ||
7876 | Here is part of a sample @file{md} file for such a machine: | |
7877 | ||
7878 | @smallexample | |
7879 | (define_attr "type" "load,store,arith,fp,branch" (const_string "arith")) | |
7880 | ||
7881 | (define_attr "cc" "clobber,unchanged,set,change0" | |
7882 | (cond [(eq_attr "type" "load") | |
7883 | (const_string "change0") | |
7884 | (eq_attr "type" "store,branch") | |
7885 | (const_string "unchanged") | |
7886 | (eq_attr "type" "arith") | |
7887 | (if_then_else (match_operand:SI 0 "" "") | |
7888 | (const_string "set") | |
7889 | (const_string "clobber"))] | |
7890 | (const_string "clobber"))) | |
7891 | ||
7892 | (define_insn "" | |
7893 | [(set (match_operand:SI 0 "general_operand" "=r,r,m") | |
7894 | (match_operand:SI 1 "general_operand" "r,m,r"))] | |
7895 | "" | |
7896 | "@@ | |
7897 | move %0,%1 | |
7898 | load %0,%1 | |
7899 | store %0,%1" | |
7900 | [(set_attr "type" "arith,load,store")]) | |
7901 | @end smallexample | |
7902 | ||
7903 | Note that we assume in the above example that arithmetic operations | |
7904 | performed on quantities smaller than a machine word clobber the condition | |
7905 | code since they will set the condition code to a value corresponding to the | |
7906 | full-word result. | |
7907 | ||
a5249a21 HPN |
7908 | @end ifset |
7909 | @ifset INTERNALS | |
03dda8e3 RK |
7910 | @node Insn Lengths |
7911 | @subsection Computing the Length of an Insn | |
7912 | @cindex insn lengths, computing | |
7913 | @cindex computing the length of an insn | |
7914 | ||
7915 | For many machines, multiple types of branch instructions are provided, each | |
7916 | for different length branch displacements. In most cases, the assembler | |
7917 | will choose the correct instruction to use. However, when the assembler | |
b49900cc | 7918 | cannot do so, GCC can when a special attribute, the @code{length} |
03dda8e3 RK |
7919 | attribute, is defined. This attribute must be defined to have numeric |
7920 | values by specifying a null string in its @code{define_attr}. | |
7921 | ||
b49900cc | 7922 | In the case of the @code{length} attribute, two additional forms of |
03dda8e3 RK |
7923 | arithmetic terms are allowed in test expressions: |
7924 | ||
7925 | @table @code | |
7926 | @cindex @code{match_dup} and attributes | |
7927 | @item (match_dup @var{n}) | |
7928 | This refers to the address of operand @var{n} of the current insn, which | |
7929 | must be a @code{label_ref}. | |
7930 | ||
7931 | @cindex @code{pc} and attributes | |
7932 | @item (pc) | |
7933 | This refers to the address of the @emph{current} insn. It might have | |
7934 | been more consistent with other usage to make this the address of the | |
7935 | @emph{next} insn but this would be confusing because the length of the | |
7936 | current insn is to be computed. | |
7937 | @end table | |
7938 | ||
7939 | @cindex @code{addr_vec}, length of | |
7940 | @cindex @code{addr_diff_vec}, length of | |
7941 | For normal insns, the length will be determined by value of the | |
b49900cc | 7942 | @code{length} attribute. In the case of @code{addr_vec} and |
03dda8e3 RK |
7943 | @code{addr_diff_vec} insn patterns, the length is computed as |
7944 | the number of vectors multiplied by the size of each vector. | |
7945 | ||
7946 | Lengths are measured in addressable storage units (bytes). | |
7947 | ||
7948 | The following macros can be used to refine the length computation: | |
7949 | ||
7950 | @table @code | |
03dda8e3 RK |
7951 | @findex ADJUST_INSN_LENGTH |
7952 | @item ADJUST_INSN_LENGTH (@var{insn}, @var{length}) | |
7953 | If defined, modifies the length assigned to instruction @var{insn} as a | |
7954 | function of the context in which it is used. @var{length} is an lvalue | |
7955 | that contains the initially computed length of the insn and should be | |
a8aa4e0b | 7956 | updated with the correct length of the insn. |
03dda8e3 RK |
7957 | |
7958 | This macro will normally not be required. A case in which it is | |
161d7b59 | 7959 | required is the ROMP@. On this machine, the size of an @code{addr_vec} |
03dda8e3 RK |
7960 | insn must be increased by two to compensate for the fact that alignment |
7961 | may be required. | |
7962 | @end table | |
7963 | ||
7964 | @findex get_attr_length | |
7965 | The routine that returns @code{get_attr_length} (the value of the | |
7966 | @code{length} attribute) can be used by the output routine to | |
7967 | determine the form of the branch instruction to be written, as the | |
7968 | example below illustrates. | |
7969 | ||
7970 | As an example of the specification of variable-length branches, consider | |
7971 | the IBM 360. If we adopt the convention that a register will be set to | |
7972 | the starting address of a function, we can jump to labels within 4k of | |
7973 | the start using a four-byte instruction. Otherwise, we need a six-byte | |
7974 | sequence to load the address from memory and then branch to it. | |
7975 | ||
7976 | On such a machine, a pattern for a branch instruction might be specified | |
7977 | as follows: | |
7978 | ||
7979 | @smallexample | |
7980 | (define_insn "jump" | |
7981 | [(set (pc) | |
7982 | (label_ref (match_operand 0 "" "")))] | |
7983 | "" | |
03dda8e3 RK |
7984 | @{ |
7985 | return (get_attr_length (insn) == 4 | |
0f40f9f7 ZW |
7986 | ? "b %l0" : "l r15,=a(%l0); br r15"); |
7987 | @} | |
9c34dbbf ZW |
7988 | [(set (attr "length") |
7989 | (if_then_else (lt (match_dup 0) (const_int 4096)) | |
7990 | (const_int 4) | |
7991 | (const_int 6)))]) | |
03dda8e3 RK |
7992 | @end smallexample |
7993 | ||
a5249a21 HPN |
7994 | @end ifset |
7995 | @ifset INTERNALS | |
03dda8e3 RK |
7996 | @node Constant Attributes |
7997 | @subsection Constant Attributes | |
7998 | @cindex constant attributes | |
7999 | ||
8000 | A special form of @code{define_attr}, where the expression for the | |
8001 | default value is a @code{const} expression, indicates an attribute that | |
8002 | is constant for a given run of the compiler. Constant attributes may be | |
8003 | used to specify which variety of processor is used. For example, | |
8004 | ||
8005 | @smallexample | |
8006 | (define_attr "cpu" "m88100,m88110,m88000" | |
8007 | (const | |
8008 | (cond [(symbol_ref "TARGET_88100") (const_string "m88100") | |
8009 | (symbol_ref "TARGET_88110") (const_string "m88110")] | |
8010 | (const_string "m88000")))) | |
8011 | ||
8012 | (define_attr "memory" "fast,slow" | |
8013 | (const | |
8014 | (if_then_else (symbol_ref "TARGET_FAST_MEM") | |
8015 | (const_string "fast") | |
8016 | (const_string "slow")))) | |
8017 | @end smallexample | |
8018 | ||
8019 | The routine generated for constant attributes has no parameters as it | |
8020 | does not depend on any particular insn. RTL expressions used to define | |
8021 | the value of a constant attribute may use the @code{symbol_ref} form, | |
8022 | but may not use either the @code{match_operand} form or @code{eq_attr} | |
8023 | forms involving insn attributes. | |
8024 | ||
a5249a21 HPN |
8025 | @end ifset |
8026 | @ifset INTERNALS | |
03dda8e3 RK |
8027 | @node Delay Slots |
8028 | @subsection Delay Slot Scheduling | |
8029 | @cindex delay slots, defining | |
8030 | ||
8031 | The insn attribute mechanism can be used to specify the requirements for | |
8032 | delay slots, if any, on a target machine. An instruction is said to | |
8033 | require a @dfn{delay slot} if some instructions that are physically | |
8034 | after the instruction are executed as if they were located before it. | |
8035 | Classic examples are branch and call instructions, which often execute | |
8036 | the following instruction before the branch or call is performed. | |
8037 | ||
8038 | On some machines, conditional branch instructions can optionally | |
8039 | @dfn{annul} instructions in the delay slot. This means that the | |
8040 | instruction will not be executed for certain branch outcomes. Both | |
8041 | instructions that annul if the branch is true and instructions that | |
8042 | annul if the branch is false are supported. | |
8043 | ||
8044 | Delay slot scheduling differs from instruction scheduling in that | |
8045 | determining whether an instruction needs a delay slot is dependent only | |
8046 | on the type of instruction being generated, not on data flow between the | |
8047 | instructions. See the next section for a discussion of data-dependent | |
8048 | instruction scheduling. | |
8049 | ||
8050 | @findex define_delay | |
8051 | The requirement of an insn needing one or more delay slots is indicated | |
8052 | via the @code{define_delay} expression. It has the following form: | |
8053 | ||
8054 | @smallexample | |
8055 | (define_delay @var{test} | |
8056 | [@var{delay-1} @var{annul-true-1} @var{annul-false-1} | |
8057 | @var{delay-2} @var{annul-true-2} @var{annul-false-2} | |
8058 | @dots{}]) | |
8059 | @end smallexample | |
8060 | ||
8061 | @var{test} is an attribute test that indicates whether this | |
8062 | @code{define_delay} applies to a particular insn. If so, the number of | |
8063 | required delay slots is determined by the length of the vector specified | |
8064 | as the second argument. An insn placed in delay slot @var{n} must | |
8065 | satisfy attribute test @var{delay-n}. @var{annul-true-n} is an | |
8066 | attribute test that specifies which insns may be annulled if the branch | |
8067 | is true. Similarly, @var{annul-false-n} specifies which insns in the | |
8068 | delay slot may be annulled if the branch is false. If annulling is not | |
bd819a4a | 8069 | supported for that delay slot, @code{(nil)} should be coded. |
03dda8e3 RK |
8070 | |
8071 | For example, in the common case where branch and call insns require | |
8072 | a single delay slot, which may contain any insn other than a branch or | |
8073 | call, the following would be placed in the @file{md} file: | |
8074 | ||
8075 | @smallexample | |
8076 | (define_delay (eq_attr "type" "branch,call") | |
8077 | [(eq_attr "type" "!branch,call") (nil) (nil)]) | |
8078 | @end smallexample | |
8079 | ||
8080 | Multiple @code{define_delay} expressions may be specified. In this | |
8081 | case, each such expression specifies different delay slot requirements | |
8082 | and there must be no insn for which tests in two @code{define_delay} | |
8083 | expressions are both true. | |
8084 | ||
8085 | For example, if we have a machine that requires one delay slot for branches | |
8086 | but two for calls, no delay slot can contain a branch or call insn, | |
8087 | and any valid insn in the delay slot for the branch can be annulled if the | |
8088 | branch is true, we might represent this as follows: | |
8089 | ||
8090 | @smallexample | |
8091 | (define_delay (eq_attr "type" "branch") | |
8092 | [(eq_attr "type" "!branch,call") | |
8093 | (eq_attr "type" "!branch,call") | |
8094 | (nil)]) | |
8095 | ||
8096 | (define_delay (eq_attr "type" "call") | |
8097 | [(eq_attr "type" "!branch,call") (nil) (nil) | |
8098 | (eq_attr "type" "!branch,call") (nil) (nil)]) | |
8099 | @end smallexample | |
8100 | @c the above is *still* too long. --mew 4feb93 | |
8101 | ||
a5249a21 HPN |
8102 | @end ifset |
8103 | @ifset INTERNALS | |
fae15c93 VM |
8104 | @node Processor pipeline description |
8105 | @subsection Specifying processor pipeline description | |
8106 | @cindex processor pipeline description | |
8107 | @cindex processor functional units | |
8108 | @cindex instruction latency time | |
8109 | @cindex interlock delays | |
8110 | @cindex data dependence delays | |
8111 | @cindex reservation delays | |
8112 | @cindex pipeline hazard recognizer | |
8113 | @cindex automaton based pipeline description | |
8114 | @cindex regular expressions | |
8115 | @cindex deterministic finite state automaton | |
8116 | @cindex automaton based scheduler | |
8117 | @cindex RISC | |
8118 | @cindex VLIW | |
8119 | ||
ef261fee | 8120 | To achieve better performance, most modern processors |
fae15c93 VM |
8121 | (super-pipelined, superscalar @acronym{RISC}, and @acronym{VLIW} |
8122 | processors) have many @dfn{functional units} on which several | |
8123 | instructions can be executed simultaneously. An instruction starts | |
8124 | execution if its issue conditions are satisfied. If not, the | |
ef261fee | 8125 | instruction is stalled until its conditions are satisfied. Such |
fae15c93 | 8126 | @dfn{interlock (pipeline) delay} causes interruption of the fetching |
431ae0bf | 8127 | of successor instructions (or demands nop instructions, e.g.@: for some |
fae15c93 VM |
8128 | MIPS processors). |
8129 | ||
8130 | There are two major kinds of interlock delays in modern processors. | |
8131 | The first one is a data dependence delay determining @dfn{instruction | |
8132 | latency time}. The instruction execution is not started until all | |
8133 | source data have been evaluated by prior instructions (there are more | |
8134 | complex cases when the instruction execution starts even when the data | |
c0478a66 | 8135 | are not available but will be ready in given time after the |
fae15c93 VM |
8136 | instruction execution start). Taking the data dependence delays into |
8137 | account is simple. The data dependence (true, output, and | |
8138 | anti-dependence) delay between two instructions is given by a | |
8139 | constant. In most cases this approach is adequate. The second kind | |
8140 | of interlock delays is a reservation delay. The reservation delay | |
8141 | means that two instructions under execution will be in need of shared | |
431ae0bf | 8142 | processors resources, i.e.@: buses, internal registers, and/or |
fae15c93 VM |
8143 | functional units, which are reserved for some time. Taking this kind |
8144 | of delay into account is complex especially for modern @acronym{RISC} | |
8145 | processors. | |
8146 | ||
8147 | The task of exploiting more processor parallelism is solved by an | |
ef261fee | 8148 | instruction scheduler. For a better solution to this problem, the |
fae15c93 | 8149 | instruction scheduler has to have an adequate description of the |
fa0aee89 PB |
8150 | processor parallelism (or @dfn{pipeline description}). GCC |
8151 | machine descriptions describe processor parallelism and functional | |
8152 | unit reservations for groups of instructions with the aid of | |
8153 | @dfn{regular expressions}. | |
ef261fee R |
8154 | |
8155 | The GCC instruction scheduler uses a @dfn{pipeline hazard recognizer} to | |
fae15c93 | 8156 | figure out the possibility of the instruction issue by the processor |
ef261fee R |
8157 | on a given simulated processor cycle. The pipeline hazard recognizer is |
8158 | automatically generated from the processor pipeline description. The | |
fa0aee89 PB |
8159 | pipeline hazard recognizer generated from the machine description |
8160 | is based on a deterministic finite state automaton (@acronym{DFA}): | |
8161 | the instruction issue is possible if there is a transition from one | |
8162 | automaton state to another one. This algorithm is very fast, and | |
8163 | furthermore, its speed is not dependent on processor | |
8164 | complexity@footnote{However, the size of the automaton depends on | |
6ccde948 RW |
8165 | processor complexity. To limit this effect, machine descriptions |
8166 | can split orthogonal parts of the machine description among several | |
8167 | automata: but then, since each of these must be stepped independently, | |
8168 | this does cause a small decrease in the algorithm's performance.}. | |
fae15c93 | 8169 | |
fae15c93 | 8170 | @cindex automaton based pipeline description |
fa0aee89 PB |
8171 | The rest of this section describes the directives that constitute |
8172 | an automaton-based processor pipeline description. The order of | |
8173 | these constructions within the machine description file is not | |
8174 | important. | |
fae15c93 VM |
8175 | |
8176 | @findex define_automaton | |
8177 | @cindex pipeline hazard recognizer | |
8178 | The following optional construction describes names of automata | |
8179 | generated and used for the pipeline hazards recognition. Sometimes | |
8180 | the generated finite state automaton used by the pipeline hazard | |
ef261fee | 8181 | recognizer is large. If we use more than one automaton and bind functional |
daf2f129 | 8182 | units to the automata, the total size of the automata is usually |
fae15c93 VM |
8183 | less than the size of the single automaton. If there is no one such |
8184 | construction, only one finite state automaton is generated. | |
8185 | ||
8186 | @smallexample | |
8187 | (define_automaton @var{automata-names}) | |
8188 | @end smallexample | |
8189 | ||
8190 | @var{automata-names} is a string giving names of the automata. The | |
8191 | names are separated by commas. All the automata should have unique names. | |
c62347f0 | 8192 | The automaton name is used in the constructions @code{define_cpu_unit} and |
fae15c93 VM |
8193 | @code{define_query_cpu_unit}. |
8194 | ||
8195 | @findex define_cpu_unit | |
8196 | @cindex processor functional units | |
c62347f0 | 8197 | Each processor functional unit used in the description of instruction |
fae15c93 VM |
8198 | reservations should be described by the following construction. |
8199 | ||
8200 | @smallexample | |
8201 | (define_cpu_unit @var{unit-names} [@var{automaton-name}]) | |
8202 | @end smallexample | |
8203 | ||
8204 | @var{unit-names} is a string giving the names of the functional units | |
8205 | separated by commas. Don't use name @samp{nothing}, it is reserved | |
8206 | for other goals. | |
8207 | ||
ef261fee | 8208 | @var{automaton-name} is a string giving the name of the automaton with |
fae15c93 VM |
8209 | which the unit is bound. The automaton should be described in |
8210 | construction @code{define_automaton}. You should give | |
8211 | @dfn{automaton-name}, if there is a defined automaton. | |
8212 | ||
30028c85 VM |
8213 | The assignment of units to automata are constrained by the uses of the |
8214 | units in insn reservations. The most important constraint is: if a | |
8215 | unit reservation is present on a particular cycle of an alternative | |
8216 | for an insn reservation, then some unit from the same automaton must | |
8217 | be present on the same cycle for the other alternatives of the insn | |
8218 | reservation. The rest of the constraints are mentioned in the | |
8219 | description of the subsequent constructions. | |
8220 | ||
fae15c93 VM |
8221 | @findex define_query_cpu_unit |
8222 | @cindex querying function unit reservations | |
8223 | The following construction describes CPU functional units analogously | |
30028c85 VM |
8224 | to @code{define_cpu_unit}. The reservation of such units can be |
8225 | queried for an automaton state. The instruction scheduler never | |
8226 | queries reservation of functional units for given automaton state. So | |
8227 | as a rule, you don't need this construction. This construction could | |
431ae0bf | 8228 | be used for future code generation goals (e.g.@: to generate |
30028c85 | 8229 | @acronym{VLIW} insn templates). |
fae15c93 VM |
8230 | |
8231 | @smallexample | |
8232 | (define_query_cpu_unit @var{unit-names} [@var{automaton-name}]) | |
8233 | @end smallexample | |
8234 | ||
8235 | @var{unit-names} is a string giving names of the functional units | |
8236 | separated by commas. | |
8237 | ||
ef261fee | 8238 | @var{automaton-name} is a string giving the name of the automaton with |
fae15c93 VM |
8239 | which the unit is bound. |
8240 | ||
8241 | @findex define_insn_reservation | |
8242 | @cindex instruction latency time | |
8243 | @cindex regular expressions | |
8244 | @cindex data bypass | |
ef261fee | 8245 | The following construction is the major one to describe pipeline |
fae15c93 VM |
8246 | characteristics of an instruction. |
8247 | ||
8248 | @smallexample | |
8249 | (define_insn_reservation @var{insn-name} @var{default_latency} | |
8250 | @var{condition} @var{regexp}) | |
8251 | @end smallexample | |
8252 | ||
8253 | @var{default_latency} is a number giving latency time of the | |
8254 | instruction. There is an important difference between the old | |
8255 | description and the automaton based pipeline description. The latency | |
8256 | time is used for all dependencies when we use the old description. In | |
ef261fee R |
8257 | the automaton based pipeline description, the given latency time is only |
8258 | used for true dependencies. The cost of anti-dependencies is always | |
fae15c93 VM |
8259 | zero and the cost of output dependencies is the difference between |
8260 | latency times of the producing and consuming insns (if the difference | |
ef261fee R |
8261 | is negative, the cost is considered to be zero). You can always |
8262 | change the default costs for any description by using the target hook | |
fae15c93 VM |
8263 | @code{TARGET_SCHED_ADJUST_COST} (@pxref{Scheduling}). |
8264 | ||
cc6a602b | 8265 | @var{insn-name} is a string giving the internal name of the insn. The |
fae15c93 VM |
8266 | internal names are used in constructions @code{define_bypass} and in |
8267 | the automaton description file generated for debugging. The internal | |
ef261fee | 8268 | name has nothing in common with the names in @code{define_insn}. It is a |
fae15c93 VM |
8269 | good practice to use insn classes described in the processor manual. |
8270 | ||
8271 | @var{condition} defines what RTL insns are described by this | |
8272 | construction. You should remember that you will be in trouble if | |
8273 | @var{condition} for two or more different | |
8274 | @code{define_insn_reservation} constructions is TRUE for an insn. In | |
8275 | this case what reservation will be used for the insn is not defined. | |
8276 | Such cases are not checked during generation of the pipeline hazards | |
8277 | recognizer because in general recognizing that two conditions may have | |
8278 | the same value is quite difficult (especially if the conditions | |
8279 | contain @code{symbol_ref}). It is also not checked during the | |
8280 | pipeline hazard recognizer work because it would slow down the | |
8281 | recognizer considerably. | |
8282 | ||
ef261fee | 8283 | @var{regexp} is a string describing the reservation of the cpu's functional |
fae15c93 VM |
8284 | units by the instruction. The reservations are described by a regular |
8285 | expression according to the following syntax: | |
8286 | ||
8287 | @smallexample | |
8288 | regexp = regexp "," oneof | |
8289 | | oneof | |
8290 | ||
8291 | oneof = oneof "|" allof | |
8292 | | allof | |
8293 | ||
8294 | allof = allof "+" repeat | |
8295 | | repeat | |
daf2f129 | 8296 | |
fae15c93 VM |
8297 | repeat = element "*" number |
8298 | | element | |
8299 | ||
8300 | element = cpu_function_unit_name | |
8301 | | reservation_name | |
8302 | | result_name | |
8303 | | "nothing" | |
8304 | | "(" regexp ")" | |
8305 | @end smallexample | |
8306 | ||
8307 | @itemize @bullet | |
8308 | @item | |
8309 | @samp{,} is used for describing the start of the next cycle in | |
8310 | the reservation. | |
8311 | ||
8312 | @item | |
8313 | @samp{|} is used for describing a reservation described by the first | |
8314 | regular expression @strong{or} a reservation described by the second | |
8315 | regular expression @strong{or} etc. | |
8316 | ||
8317 | @item | |
8318 | @samp{+} is used for describing a reservation described by the first | |
8319 | regular expression @strong{and} a reservation described by the | |
8320 | second regular expression @strong{and} etc. | |
8321 | ||
8322 | @item | |
8323 | @samp{*} is used for convenience and simply means a sequence in which | |
8324 | the regular expression are repeated @var{number} times with cycle | |
8325 | advancing (see @samp{,}). | |
8326 | ||
8327 | @item | |
8328 | @samp{cpu_function_unit_name} denotes reservation of the named | |
8329 | functional unit. | |
8330 | ||
8331 | @item | |
8332 | @samp{reservation_name} --- see description of construction | |
8333 | @samp{define_reservation}. | |
8334 | ||
8335 | @item | |
8336 | @samp{nothing} denotes no unit reservations. | |
8337 | @end itemize | |
8338 | ||
8339 | @findex define_reservation | |
8340 | Sometimes unit reservations for different insns contain common parts. | |
8341 | In such case, you can simplify the pipeline description by describing | |
8342 | the common part by the following construction | |
8343 | ||
8344 | @smallexample | |
8345 | (define_reservation @var{reservation-name} @var{regexp}) | |
8346 | @end smallexample | |
8347 | ||
8348 | @var{reservation-name} is a string giving name of @var{regexp}. | |
8349 | Functional unit names and reservation names are in the same name | |
8350 | space. So the reservation names should be different from the | |
cc6a602b | 8351 | functional unit names and can not be the reserved name @samp{nothing}. |
fae15c93 VM |
8352 | |
8353 | @findex define_bypass | |
8354 | @cindex instruction latency time | |
8355 | @cindex data bypass | |
8356 | The following construction is used to describe exceptions in the | |
8357 | latency time for given instruction pair. This is so called bypasses. | |
8358 | ||
8359 | @smallexample | |
8360 | (define_bypass @var{number} @var{out_insn_names} @var{in_insn_names} | |
8361 | [@var{guard}]) | |
8362 | @end smallexample | |
8363 | ||
8364 | @var{number} defines when the result generated by the instructions | |
8365 | given in string @var{out_insn_names} will be ready for the | |
f9bf5a8e RS |
8366 | instructions given in string @var{in_insn_names}. Each of these |
8367 | strings is a comma-separated list of filename-style globs and | |
8368 | they refer to the names of @code{define_insn_reservation}s. | |
8369 | For example: | |
8370 | @smallexample | |
8371 | (define_bypass 1 "cpu1_load_*, cpu1_store_*" "cpu1_load_*") | |
8372 | @end smallexample | |
8373 | defines a bypass between instructions that start with | |
8374 | @samp{cpu1_load_} or @samp{cpu1_store_} and those that start with | |
8375 | @samp{cpu1_load_}. | |
fae15c93 | 8376 | |
ef261fee | 8377 | @var{guard} is an optional string giving the name of a C function which |
fae15c93 VM |
8378 | defines an additional guard for the bypass. The function will get the |
8379 | two insns as parameters. If the function returns zero the bypass will | |
8380 | be ignored for this case. The additional guard is necessary to | |
431ae0bf | 8381 | recognize complicated bypasses, e.g.@: when the consumer is only an address |
fae15c93 VM |
8382 | of insn @samp{store} (not a stored value). |
8383 | ||
20a07f44 VM |
8384 | If there are more one bypass with the same output and input insns, the |
8385 | chosen bypass is the first bypass with a guard in description whose | |
8386 | guard function returns nonzero. If there is no such bypass, then | |
8387 | bypass without the guard function is chosen. | |
8388 | ||
fae15c93 VM |
8389 | @findex exclusion_set |
8390 | @findex presence_set | |
30028c85 | 8391 | @findex final_presence_set |
fae15c93 | 8392 | @findex absence_set |
30028c85 | 8393 | @findex final_absence_set |
fae15c93 VM |
8394 | @cindex VLIW |
8395 | @cindex RISC | |
cc6a602b BE |
8396 | The following five constructions are usually used to describe |
8397 | @acronym{VLIW} processors, or more precisely, to describe a placement | |
8398 | of small instructions into @acronym{VLIW} instruction slots. They | |
8399 | can be used for @acronym{RISC} processors, too. | |
fae15c93 VM |
8400 | |
8401 | @smallexample | |
8402 | (exclusion_set @var{unit-names} @var{unit-names}) | |
30028c85 VM |
8403 | (presence_set @var{unit-names} @var{patterns}) |
8404 | (final_presence_set @var{unit-names} @var{patterns}) | |
8405 | (absence_set @var{unit-names} @var{patterns}) | |
8406 | (final_absence_set @var{unit-names} @var{patterns}) | |
fae15c93 VM |
8407 | @end smallexample |
8408 | ||
8409 | @var{unit-names} is a string giving names of functional units | |
8410 | separated by commas. | |
8411 | ||
30028c85 | 8412 | @var{patterns} is a string giving patterns of functional units |
0bdcd332 | 8413 | separated by comma. Currently pattern is one unit or units |
30028c85 VM |
8414 | separated by white-spaces. |
8415 | ||
fae15c93 VM |
8416 | The first construction (@samp{exclusion_set}) means that each |
8417 | functional unit in the first string can not be reserved simultaneously | |
8418 | with a unit whose name is in the second string and vice versa. For | |
8419 | example, the construction is useful for describing processors | |
431ae0bf | 8420 | (e.g.@: some SPARC processors) with a fully pipelined floating point |
fae15c93 VM |
8421 | functional unit which can execute simultaneously only single floating |
8422 | point insns or only double floating point insns. | |
8423 | ||
8424 | The second construction (@samp{presence_set}) means that each | |
8425 | functional unit in the first string can not be reserved unless at | |
30028c85 VM |
8426 | least one of pattern of units whose names are in the second string is |
8427 | reserved. This is an asymmetric relation. For example, it is useful | |
8428 | for description that @acronym{VLIW} @samp{slot1} is reserved after | |
8429 | @samp{slot0} reservation. We could describe it by the following | |
8430 | construction | |
8431 | ||
8432 | @smallexample | |
8433 | (presence_set "slot1" "slot0") | |
8434 | @end smallexample | |
8435 | ||
8436 | Or @samp{slot1} is reserved only after @samp{slot0} and unit @samp{b0} | |
8437 | reservation. In this case we could write | |
8438 | ||
8439 | @smallexample | |
8440 | (presence_set "slot1" "slot0 b0") | |
8441 | @end smallexample | |
8442 | ||
8443 | The third construction (@samp{final_presence_set}) is analogous to | |
8444 | @samp{presence_set}. The difference between them is when checking is | |
8445 | done. When an instruction is issued in given automaton state | |
8446 | reflecting all current and planned unit reservations, the automaton | |
8447 | state is changed. The first state is a source state, the second one | |
8448 | is a result state. Checking for @samp{presence_set} is done on the | |
8449 | source state reservation, checking for @samp{final_presence_set} is | |
8450 | done on the result reservation. This construction is useful to | |
8451 | describe a reservation which is actually two subsequent reservations. | |
8452 | For example, if we use | |
8453 | ||
8454 | @smallexample | |
8455 | (presence_set "slot1" "slot0") | |
8456 | @end smallexample | |
8457 | ||
8458 | the following insn will be never issued (because @samp{slot1} requires | |
8459 | @samp{slot0} which is absent in the source state). | |
8460 | ||
8461 | @smallexample | |
8462 | (define_reservation "insn_and_nop" "slot0 + slot1") | |
8463 | @end smallexample | |
8464 | ||
8465 | but it can be issued if we use analogous @samp{final_presence_set}. | |
8466 | ||
8467 | The forth construction (@samp{absence_set}) means that each functional | |
8468 | unit in the first string can be reserved only if each pattern of units | |
8469 | whose names are in the second string is not reserved. This is an | |
8470 | asymmetric relation (actually @samp{exclusion_set} is analogous to | |
ff2ce160 | 8471 | this one but it is symmetric). For example it might be useful in a |
a71b1c58 NC |
8472 | @acronym{VLIW} description to say that @samp{slot0} cannot be reserved |
8473 | after either @samp{slot1} or @samp{slot2} have been reserved. This | |
8474 | can be described as: | |
30028c85 VM |
8475 | |
8476 | @smallexample | |
a71b1c58 | 8477 | (absence_set "slot0" "slot1, slot2") |
30028c85 VM |
8478 | @end smallexample |
8479 | ||
8480 | Or @samp{slot2} can not be reserved if @samp{slot0} and unit @samp{b0} | |
8481 | are reserved or @samp{slot1} and unit @samp{b1} are reserved. In | |
8482 | this case we could write | |
8483 | ||
8484 | @smallexample | |
8485 | (absence_set "slot2" "slot0 b0, slot1 b1") | |
8486 | @end smallexample | |
fae15c93 | 8487 | |
ef261fee | 8488 | All functional units mentioned in a set should belong to the same |
fae15c93 VM |
8489 | automaton. |
8490 | ||
30028c85 VM |
8491 | The last construction (@samp{final_absence_set}) is analogous to |
8492 | @samp{absence_set} but checking is done on the result (state) | |
8493 | reservation. See comments for @samp{final_presence_set}. | |
8494 | ||
fae15c93 VM |
8495 | @findex automata_option |
8496 | @cindex deterministic finite state automaton | |
8497 | @cindex nondeterministic finite state automaton | |
8498 | @cindex finite state automaton minimization | |
8499 | You can control the generator of the pipeline hazard recognizer with | |
8500 | the following construction. | |
8501 | ||
8502 | @smallexample | |
8503 | (automata_option @var{options}) | |
8504 | @end smallexample | |
8505 | ||
8506 | @var{options} is a string giving options which affect the generated | |
8507 | code. Currently there are the following options: | |
8508 | ||
8509 | @itemize @bullet | |
8510 | @item | |
8511 | @dfn{no-minimization} makes no minimization of the automaton. This is | |
30028c85 VM |
8512 | only worth to do when we are debugging the description and need to |
8513 | look more accurately at reservations of states. | |
fae15c93 VM |
8514 | |
8515 | @item | |
df1133a6 BE |
8516 | @dfn{time} means printing time statistics about the generation of |
8517 | automata. | |
8518 | ||
8519 | @item | |
8520 | @dfn{stats} means printing statistics about the generated automata | |
8521 | such as the number of DFA states, NDFA states and arcs. | |
e3c8eb86 VM |
8522 | |
8523 | @item | |
8524 | @dfn{v} means a generation of the file describing the result automata. | |
8525 | The file has suffix @samp{.dfa} and can be used for the description | |
8526 | verification and debugging. | |
8527 | ||
8528 | @item | |
8529 | @dfn{w} means a generation of warning instead of error for | |
8530 | non-critical errors. | |
fae15c93 | 8531 | |
e12da141 BS |
8532 | @item |
8533 | @dfn{no-comb-vect} prevents the automaton generator from generating | |
8534 | two data structures and comparing them for space efficiency. Using | |
8535 | a comb vector to represent transitions may be better, but it can be | |
8536 | very expensive to construct. This option is useful if the build | |
8537 | process spends an unacceptably long time in genautomata. | |
8538 | ||
fae15c93 VM |
8539 | @item |
8540 | @dfn{ndfa} makes nondeterministic finite state automata. This affects | |
8541 | the treatment of operator @samp{|} in the regular expressions. The | |
8542 | usual treatment of the operator is to try the first alternative and, | |
8543 | if the reservation is not possible, the second alternative. The | |
8544 | nondeterministic treatment means trying all alternatives, some of them | |
96ddf8ef | 8545 | may be rejected by reservations in the subsequent insns. |
dfa849f3 | 8546 | |
1e6a9047 BS |
8547 | @item |
8548 | @dfn{collapse-ndfa} modifies the behaviour of the generator when | |
8549 | producing an automaton. An additional state transition to collapse a | |
8550 | nondeterministic @acronym{NDFA} state to a deterministic @acronym{DFA} | |
8551 | state is generated. It can be triggered by passing @code{const0_rtx} to | |
8552 | state_transition. In such an automaton, cycle advance transitions are | |
8553 | available only for these collapsed states. This option is useful for | |
8554 | ports that want to use the @code{ndfa} option, but also want to use | |
8555 | @code{define_query_cpu_unit} to assign units to insns issued in a cycle. | |
8556 | ||
dfa849f3 VM |
8557 | @item |
8558 | @dfn{progress} means output of a progress bar showing how many states | |
8559 | were generated so far for automaton being processed. This is useful | |
8560 | during debugging a @acronym{DFA} description. If you see too many | |
8561 | generated states, you could interrupt the generator of the pipeline | |
8562 | hazard recognizer and try to figure out a reason for generation of the | |
8563 | huge automaton. | |
fae15c93 VM |
8564 | @end itemize |
8565 | ||
8566 | As an example, consider a superscalar @acronym{RISC} machine which can | |
8567 | issue three insns (two integer insns and one floating point insn) on | |
8568 | the cycle but can finish only two insns. To describe this, we define | |
8569 | the following functional units. | |
8570 | ||
8571 | @smallexample | |
8572 | (define_cpu_unit "i0_pipeline, i1_pipeline, f_pipeline") | |
ef261fee | 8573 | (define_cpu_unit "port0, port1") |
fae15c93 VM |
8574 | @end smallexample |
8575 | ||
8576 | All simple integer insns can be executed in any integer pipeline and | |
8577 | their result is ready in two cycles. The simple integer insns are | |
8578 | issued into the first pipeline unless it is reserved, otherwise they | |
8579 | are issued into the second pipeline. Integer division and | |
8580 | multiplication insns can be executed only in the second integer | |
8581 | pipeline and their results are ready correspondingly in 8 and 4 | |
431ae0bf | 8582 | cycles. The integer division is not pipelined, i.e.@: the subsequent |
fae15c93 VM |
8583 | integer division insn can not be issued until the current division |
8584 | insn finished. Floating point insns are fully pipelined and their | |
ef261fee R |
8585 | results are ready in 3 cycles. Where the result of a floating point |
8586 | insn is used by an integer insn, an additional delay of one cycle is | |
8587 | incurred. To describe all of this we could specify | |
fae15c93 VM |
8588 | |
8589 | @smallexample | |
8590 | (define_cpu_unit "div") | |
8591 | ||
68e4d4c5 | 8592 | (define_insn_reservation "simple" 2 (eq_attr "type" "int") |
ef261fee | 8593 | "(i0_pipeline | i1_pipeline), (port0 | port1)") |
fae15c93 | 8594 | |
68e4d4c5 | 8595 | (define_insn_reservation "mult" 4 (eq_attr "type" "mult") |
ef261fee | 8596 | "i1_pipeline, nothing*2, (port0 | port1)") |
fae15c93 | 8597 | |
68e4d4c5 | 8598 | (define_insn_reservation "div" 8 (eq_attr "type" "div") |
ef261fee | 8599 | "i1_pipeline, div*7, div + (port0 | port1)") |
fae15c93 | 8600 | |
68e4d4c5 | 8601 | (define_insn_reservation "float" 3 (eq_attr "type" "float") |
ef261fee | 8602 | "f_pipeline, nothing, (port0 | port1)) |
fae15c93 | 8603 | |
ef261fee | 8604 | (define_bypass 4 "float" "simple,mult,div") |
fae15c93 VM |
8605 | @end smallexample |
8606 | ||
8607 | To simplify the description we could describe the following reservation | |
8608 | ||
8609 | @smallexample | |
8610 | (define_reservation "finish" "port0|port1") | |
8611 | @end smallexample | |
8612 | ||
8613 | and use it in all @code{define_insn_reservation} as in the following | |
8614 | construction | |
8615 | ||
8616 | @smallexample | |
68e4d4c5 | 8617 | (define_insn_reservation "simple" 2 (eq_attr "type" "int") |
fae15c93 VM |
8618 | "(i0_pipeline | i1_pipeline), finish") |
8619 | @end smallexample | |
8620 | ||
8621 | ||
a5249a21 HPN |
8622 | @end ifset |
8623 | @ifset INTERNALS | |
3262c1f5 RH |
8624 | @node Conditional Execution |
8625 | @section Conditional Execution | |
8626 | @cindex conditional execution | |
8627 | @cindex predication | |
8628 | ||
8629 | A number of architectures provide for some form of conditional | |
8630 | execution, or predication. The hallmark of this feature is the | |
8631 | ability to nullify most of the instructions in the instruction set. | |
8632 | When the instruction set is large and not entirely symmetric, it | |
8633 | can be quite tedious to describe these forms directly in the | |
8634 | @file{.md} file. An alternative is the @code{define_cond_exec} template. | |
8635 | ||
8636 | @findex define_cond_exec | |
8637 | @smallexample | |
8638 | (define_cond_exec | |
8639 | [@var{predicate-pattern}] | |
8640 | "@var{condition}" | |
630d3d5a | 8641 | "@var{output-template}") |
3262c1f5 RH |
8642 | @end smallexample |
8643 | ||
8644 | @var{predicate-pattern} is the condition that must be true for the | |
8645 | insn to be executed at runtime and should match a relational operator. | |
8646 | One can use @code{match_operator} to match several relational operators | |
8647 | at once. Any @code{match_operand} operands must have no more than one | |
8648 | alternative. | |
8649 | ||
8650 | @var{condition} is a C expression that must be true for the generated | |
8651 | pattern to match. | |
8652 | ||
8653 | @findex current_insn_predicate | |
630d3d5a | 8654 | @var{output-template} is a string similar to the @code{define_insn} |
3262c1f5 RH |
8655 | output template (@pxref{Output Template}), except that the @samp{*} |
8656 | and @samp{@@} special cases do not apply. This is only useful if the | |
8657 | assembly text for the predicate is a simple prefix to the main insn. | |
8658 | In order to handle the general case, there is a global variable | |
8659 | @code{current_insn_predicate} that will contain the entire predicate | |
8660 | if the current insn is predicated, and will otherwise be @code{NULL}. | |
8661 | ||
ebb48a4d JM |
8662 | When @code{define_cond_exec} is used, an implicit reference to |
8663 | the @code{predicable} instruction attribute is made. | |
0bddee8e BS |
8664 | @xref{Insn Attributes}. This attribute must be a boolean (i.e.@: have |
8665 | exactly two elements in its @var{list-of-values}), with the possible | |
8666 | values being @code{no} and @code{yes}. The default and all uses in | |
8667 | the insns must be a simple constant, not a complex expressions. It | |
8668 | may, however, depend on the alternative, by using a comma-separated | |
8669 | list of values. If that is the case, the port should also define an | |
8670 | @code{enabled} attribute (@pxref{Disable Insn Alternatives}), which | |
8671 | should also allow only @code{no} and @code{yes} as its values. | |
3262c1f5 | 8672 | |
ebb48a4d | 8673 | For each @code{define_insn} for which the @code{predicable} |
3262c1f5 RH |
8674 | attribute is true, a new @code{define_insn} pattern will be |
8675 | generated that matches a predicated version of the instruction. | |
8676 | For example, | |
8677 | ||
8678 | @smallexample | |
8679 | (define_insn "addsi" | |
8680 | [(set (match_operand:SI 0 "register_operand" "r") | |
8681 | (plus:SI (match_operand:SI 1 "register_operand" "r") | |
8682 | (match_operand:SI 2 "register_operand" "r")))] | |
8683 | "@var{test1}" | |
8684 | "add %2,%1,%0") | |
8685 | ||
8686 | (define_cond_exec | |
8687 | [(ne (match_operand:CC 0 "register_operand" "c") | |
8688 | (const_int 0))] | |
8689 | "@var{test2}" | |
8690 | "(%0)") | |
8691 | @end smallexample | |
8692 | ||
8693 | @noindent | |
8694 | generates a new pattern | |
8695 | ||
8696 | @smallexample | |
8697 | (define_insn "" | |
8698 | [(cond_exec | |
8699 | (ne (match_operand:CC 3 "register_operand" "c") (const_int 0)) | |
8700 | (set (match_operand:SI 0 "register_operand" "r") | |
8701 | (plus:SI (match_operand:SI 1 "register_operand" "r") | |
8702 | (match_operand:SI 2 "register_operand" "r"))))] | |
8703 | "(@var{test2}) && (@var{test1})" | |
8704 | "(%3) add %2,%1,%0") | |
8705 | @end smallexample | |
c25c12b8 | 8706 | |
a5249a21 HPN |
8707 | @end ifset |
8708 | @ifset INTERNALS | |
c25c12b8 R |
8709 | @node Constant Definitions |
8710 | @section Constant Definitions | |
8711 | @cindex constant definitions | |
8712 | @findex define_constants | |
8713 | ||
8714 | Using literal constants inside instruction patterns reduces legibility and | |
8715 | can be a maintenance problem. | |
8716 | ||
8717 | To overcome this problem, you may use the @code{define_constants} | |
8718 | expression. It contains a vector of name-value pairs. From that | |
8719 | point on, wherever any of the names appears in the MD file, it is as | |
8720 | if the corresponding value had been written instead. You may use | |
8721 | @code{define_constants} multiple times; each appearance adds more | |
8722 | constants to the table. It is an error to redefine a constant with | |
8723 | a different value. | |
8724 | ||
8725 | To come back to the a29k load multiple example, instead of | |
8726 | ||
8727 | @smallexample | |
8728 | (define_insn "" | |
8729 | [(match_parallel 0 "load_multiple_operation" | |
8730 | [(set (match_operand:SI 1 "gpc_reg_operand" "=r") | |
8731 | (match_operand:SI 2 "memory_operand" "m")) | |
8732 | (use (reg:SI 179)) | |
8733 | (clobber (reg:SI 179))])] | |
8734 | "" | |
8735 | "loadm 0,0,%1,%2") | |
8736 | @end smallexample | |
8737 | ||
8738 | You could write: | |
8739 | ||
8740 | @smallexample | |
8741 | (define_constants [ | |
8742 | (R_BP 177) | |
8743 | (R_FC 178) | |
8744 | (R_CR 179) | |
8745 | (R_Q 180) | |
8746 | ]) | |
8747 | ||
8748 | (define_insn "" | |
8749 | [(match_parallel 0 "load_multiple_operation" | |
8750 | [(set (match_operand:SI 1 "gpc_reg_operand" "=r") | |
8751 | (match_operand:SI 2 "memory_operand" "m")) | |
8752 | (use (reg:SI R_CR)) | |
8753 | (clobber (reg:SI R_CR))])] | |
8754 | "" | |
8755 | "loadm 0,0,%1,%2") | |
8756 | @end smallexample | |
8757 | ||
8758 | The constants that are defined with a define_constant are also output | |
8759 | in the insn-codes.h header file as #defines. | |
24609606 RS |
8760 | |
8761 | @cindex enumerations | |
8762 | @findex define_c_enum | |
8763 | You can also use the machine description file to define enumerations. | |
8764 | Like the constants defined by @code{define_constant}, these enumerations | |
8765 | are visible to both the machine description file and the main C code. | |
8766 | ||
8767 | The syntax is as follows: | |
8768 | ||
8769 | @smallexample | |
8770 | (define_c_enum "@var{name}" [ | |
8771 | @var{value0} | |
8772 | @var{value1} | |
8773 | @dots{} | |
8774 | @var{valuen} | |
8775 | ]) | |
8776 | @end smallexample | |
8777 | ||
8778 | This definition causes the equivalent of the following C code to appear | |
8779 | in @file{insn-constants.h}: | |
8780 | ||
8781 | @smallexample | |
8782 | enum @var{name} @{ | |
8783 | @var{value0} = 0, | |
8784 | @var{value1} = 1, | |
8785 | @dots{} | |
8786 | @var{valuen} = @var{n} | |
8787 | @}; | |
8788 | #define NUM_@var{cname}_VALUES (@var{n} + 1) | |
8789 | @end smallexample | |
8790 | ||
8791 | where @var{cname} is the capitalized form of @var{name}. | |
8792 | It also makes each @var{valuei} available in the machine description | |
8793 | file, just as if it had been declared with: | |
8794 | ||
8795 | @smallexample | |
8796 | (define_constants [(@var{valuei} @var{i})]) | |
8797 | @end smallexample | |
8798 | ||
8799 | Each @var{valuei} is usually an upper-case identifier and usually | |
8800 | begins with @var{cname}. | |
8801 | ||
8802 | You can split the enumeration definition into as many statements as | |
8803 | you like. The above example is directly equivalent to: | |
8804 | ||
8805 | @smallexample | |
8806 | (define_c_enum "@var{name}" [@var{value0}]) | |
8807 | (define_c_enum "@var{name}" [@var{value1}]) | |
8808 | @dots{} | |
8809 | (define_c_enum "@var{name}" [@var{valuen}]) | |
8810 | @end smallexample | |
8811 | ||
8812 | Splitting the enumeration helps to improve the modularity of each | |
8813 | individual @code{.md} file. For example, if a port defines its | |
8814 | synchronization instructions in a separate @file{sync.md} file, | |
8815 | it is convenient to define all synchronization-specific enumeration | |
8816 | values in @file{sync.md} rather than in the main @file{.md} file. | |
8817 | ||
0fe60a1b RS |
8818 | Some enumeration names have special significance to GCC: |
8819 | ||
8820 | @table @code | |
8821 | @item unspecv | |
8822 | @findex unspec_volatile | |
8823 | If an enumeration called @code{unspecv} is defined, GCC will use it | |
8824 | when printing out @code{unspec_volatile} expressions. For example: | |
8825 | ||
8826 | @smallexample | |
8827 | (define_c_enum "unspecv" [ | |
8828 | UNSPECV_BLOCKAGE | |
8829 | ]) | |
8830 | @end smallexample | |
8831 | ||
8832 | causes GCC to print @samp{(unspec_volatile @dots{} 0)} as: | |
8833 | ||
8834 | @smallexample | |
8835 | (unspec_volatile ... UNSPECV_BLOCKAGE) | |
8836 | @end smallexample | |
8837 | ||
8838 | @item unspec | |
8839 | @findex unspec | |
8840 | If an enumeration called @code{unspec} is defined, GCC will use | |
8841 | it when printing out @code{unspec} expressions. GCC will also use | |
8842 | it when printing out @code{unspec_volatile} expressions unless an | |
8843 | @code{unspecv} enumeration is also defined. You can therefore | |
8844 | decide whether to keep separate enumerations for volatile and | |
8845 | non-volatile expressions or whether to use the same enumeration | |
8846 | for both. | |
8847 | @end table | |
8848 | ||
24609606 | 8849 | @findex define_enum |
8f4fe86c | 8850 | @anchor{define_enum} |
24609606 RS |
8851 | Another way of defining an enumeration is to use @code{define_enum}: |
8852 | ||
8853 | @smallexample | |
8854 | (define_enum "@var{name}" [ | |
8855 | @var{value0} | |
8856 | @var{value1} | |
8857 | @dots{} | |
8858 | @var{valuen} | |
8859 | ]) | |
8860 | @end smallexample | |
8861 | ||
8862 | This directive implies: | |
8863 | ||
8864 | @smallexample | |
8865 | (define_c_enum "@var{name}" [ | |
8866 | @var{cname}_@var{cvalue0} | |
8867 | @var{cname}_@var{cvalue1} | |
8868 | @dots{} | |
8869 | @var{cname}_@var{cvaluen} | |
8870 | ]) | |
8871 | @end smallexample | |
8872 | ||
8f4fe86c | 8873 | @findex define_enum_attr |
24609606 | 8874 | where @var{cvaluei} is the capitalized form of @var{valuei}. |
8f4fe86c RS |
8875 | However, unlike @code{define_c_enum}, the enumerations defined |
8876 | by @code{define_enum} can be used in attribute specifications | |
8877 | (@pxref{define_enum_attr}). | |
b11cc610 | 8878 | @end ifset |
032e8348 | 8879 | @ifset INTERNALS |
3abcb3a7 HPN |
8880 | @node Iterators |
8881 | @section Iterators | |
8882 | @cindex iterators in @file{.md} files | |
032e8348 RS |
8883 | |
8884 | Ports often need to define similar patterns for more than one machine | |
3abcb3a7 | 8885 | mode or for more than one rtx code. GCC provides some simple iterator |
032e8348 RS |
8886 | facilities to make this process easier. |
8887 | ||
8888 | @menu | |
3abcb3a7 HPN |
8889 | * Mode Iterators:: Generating variations of patterns for different modes. |
8890 | * Code Iterators:: Doing the same for codes. | |
032e8348 RS |
8891 | @end menu |
8892 | ||
3abcb3a7 HPN |
8893 | @node Mode Iterators |
8894 | @subsection Mode Iterators | |
8895 | @cindex mode iterators in @file{.md} files | |
032e8348 RS |
8896 | |
8897 | Ports often need to define similar patterns for two or more different modes. | |
8898 | For example: | |
8899 | ||
8900 | @itemize @bullet | |
8901 | @item | |
8902 | If a processor has hardware support for both single and double | |
8903 | floating-point arithmetic, the @code{SFmode} patterns tend to be | |
8904 | very similar to the @code{DFmode} ones. | |
8905 | ||
8906 | @item | |
8907 | If a port uses @code{SImode} pointers in one configuration and | |
8908 | @code{DImode} pointers in another, it will usually have very similar | |
8909 | @code{SImode} and @code{DImode} patterns for manipulating pointers. | |
8910 | @end itemize | |
8911 | ||
3abcb3a7 | 8912 | Mode iterators allow several patterns to be instantiated from one |
032e8348 RS |
8913 | @file{.md} file template. They can be used with any type of |
8914 | rtx-based construct, such as a @code{define_insn}, | |
8915 | @code{define_split}, or @code{define_peephole2}. | |
8916 | ||
8917 | @menu | |
3abcb3a7 | 8918 | * Defining Mode Iterators:: Defining a new mode iterator. |
6ccde948 RW |
8919 | * Substitutions:: Combining mode iterators with substitutions |
8920 | * Examples:: Examples | |
032e8348 RS |
8921 | @end menu |
8922 | ||
3abcb3a7 HPN |
8923 | @node Defining Mode Iterators |
8924 | @subsubsection Defining Mode Iterators | |
8925 | @findex define_mode_iterator | |
032e8348 | 8926 | |
3abcb3a7 | 8927 | The syntax for defining a mode iterator is: |
032e8348 RS |
8928 | |
8929 | @smallexample | |
923158be | 8930 | (define_mode_iterator @var{name} [(@var{mode1} "@var{cond1}") @dots{} (@var{moden} "@var{condn}")]) |
032e8348 RS |
8931 | @end smallexample |
8932 | ||
8933 | This allows subsequent @file{.md} file constructs to use the mode suffix | |
8934 | @code{:@var{name}}. Every construct that does so will be expanded | |
8935 | @var{n} times, once with every use of @code{:@var{name}} replaced by | |
8936 | @code{:@var{mode1}}, once with every use replaced by @code{:@var{mode2}}, | |
8937 | and so on. In the expansion for a particular @var{modei}, every | |
8938 | C condition will also require that @var{condi} be true. | |
8939 | ||
8940 | For example: | |
8941 | ||
8942 | @smallexample | |
3abcb3a7 | 8943 | (define_mode_iterator P [(SI "Pmode == SImode") (DI "Pmode == DImode")]) |
032e8348 RS |
8944 | @end smallexample |
8945 | ||
8946 | defines a new mode suffix @code{:P}. Every construct that uses | |
8947 | @code{:P} will be expanded twice, once with every @code{:P} replaced | |
8948 | by @code{:SI} and once with every @code{:P} replaced by @code{:DI}. | |
8949 | The @code{:SI} version will only apply if @code{Pmode == SImode} and | |
8950 | the @code{:DI} version will only apply if @code{Pmode == DImode}. | |
8951 | ||
8952 | As with other @file{.md} conditions, an empty string is treated | |
8953 | as ``always true''. @code{(@var{mode} "")} can also be abbreviated | |
8954 | to @code{@var{mode}}. For example: | |
8955 | ||
8956 | @smallexample | |
3abcb3a7 | 8957 | (define_mode_iterator GPR [SI (DI "TARGET_64BIT")]) |
032e8348 RS |
8958 | @end smallexample |
8959 | ||
8960 | means that the @code{:DI} expansion only applies if @code{TARGET_64BIT} | |
8961 | but that the @code{:SI} expansion has no such constraint. | |
8962 | ||
3abcb3a7 HPN |
8963 | Iterators are applied in the order they are defined. This can be |
8964 | significant if two iterators are used in a construct that requires | |
f30990b2 | 8965 | substitutions. @xref{Substitutions}. |
032e8348 | 8966 | |
f30990b2 | 8967 | @node Substitutions |
3abcb3a7 | 8968 | @subsubsection Substitution in Mode Iterators |
032e8348 RS |
8969 | @findex define_mode_attr |
8970 | ||
3abcb3a7 | 8971 | If an @file{.md} file construct uses mode iterators, each version of the |
f30990b2 ILT |
8972 | construct will often need slightly different strings or modes. For |
8973 | example: | |
032e8348 RS |
8974 | |
8975 | @itemize @bullet | |
8976 | @item | |
8977 | When a @code{define_expand} defines several @code{add@var{m}3} patterns | |
8978 | (@pxref{Standard Names}), each expander will need to use the | |
8979 | appropriate mode name for @var{m}. | |
8980 | ||
8981 | @item | |
8982 | When a @code{define_insn} defines several instruction patterns, | |
8983 | each instruction will often use a different assembler mnemonic. | |
f30990b2 ILT |
8984 | |
8985 | @item | |
8986 | When a @code{define_insn} requires operands with different modes, | |
3abcb3a7 | 8987 | using an iterator for one of the operand modes usually requires a specific |
f30990b2 | 8988 | mode for the other operand(s). |
032e8348 RS |
8989 | @end itemize |
8990 | ||
8991 | GCC supports such variations through a system of ``mode attributes''. | |
8992 | There are two standard attributes: @code{mode}, which is the name of | |
8993 | the mode in lower case, and @code{MODE}, which is the same thing in | |
8994 | upper case. You can define other attributes using: | |
8995 | ||
8996 | @smallexample | |
923158be | 8997 | (define_mode_attr @var{name} [(@var{mode1} "@var{value1}") @dots{} (@var{moden} "@var{valuen}")]) |
032e8348 RS |
8998 | @end smallexample |
8999 | ||
9000 | where @var{name} is the name of the attribute and @var{valuei} | |
9001 | is the value associated with @var{modei}. | |
9002 | ||
3abcb3a7 | 9003 | When GCC replaces some @var{:iterator} with @var{:mode}, it will scan |
f30990b2 | 9004 | each string and mode in the pattern for sequences of the form |
3abcb3a7 | 9005 | @code{<@var{iterator}:@var{attr}>}, where @var{attr} is the name of a |
f30990b2 | 9006 | mode attribute. If the attribute is defined for @var{mode}, the whole |
923158be | 9007 | @code{<@dots{}>} sequence will be replaced by the appropriate attribute |
f30990b2 | 9008 | value. |
032e8348 RS |
9009 | |
9010 | For example, suppose an @file{.md} file has: | |
9011 | ||
9012 | @smallexample | |
3abcb3a7 | 9013 | (define_mode_iterator P [(SI "Pmode == SImode") (DI "Pmode == DImode")]) |
032e8348 RS |
9014 | (define_mode_attr load [(SI "lw") (DI "ld")]) |
9015 | @end smallexample | |
9016 | ||
9017 | If one of the patterns that uses @code{:P} contains the string | |
9018 | @code{"<P:load>\t%0,%1"}, the @code{SI} version of that pattern | |
9019 | will use @code{"lw\t%0,%1"} and the @code{DI} version will use | |
9020 | @code{"ld\t%0,%1"}. | |
9021 | ||
f30990b2 ILT |
9022 | Here is an example of using an attribute for a mode: |
9023 | ||
9024 | @smallexample | |
3abcb3a7 | 9025 | (define_mode_iterator LONG [SI DI]) |
f30990b2 | 9026 | (define_mode_attr SHORT [(SI "HI") (DI "SI")]) |
923158be RW |
9027 | (define_insn @dots{} |
9028 | (sign_extend:LONG (match_operand:<LONG:SHORT> @dots{})) @dots{}) | |
f30990b2 ILT |
9029 | @end smallexample |
9030 | ||
3abcb3a7 HPN |
9031 | The @code{@var{iterator}:} prefix may be omitted, in which case the |
9032 | substitution will be attempted for every iterator expansion. | |
032e8348 RS |
9033 | |
9034 | @node Examples | |
3abcb3a7 | 9035 | @subsubsection Mode Iterator Examples |
032e8348 RS |
9036 | |
9037 | Here is an example from the MIPS port. It defines the following | |
9038 | modes and attributes (among others): | |
9039 | ||
9040 | @smallexample | |
3abcb3a7 | 9041 | (define_mode_iterator GPR [SI (DI "TARGET_64BIT")]) |
032e8348 RS |
9042 | (define_mode_attr d [(SI "") (DI "d")]) |
9043 | @end smallexample | |
9044 | ||
9045 | and uses the following template to define both @code{subsi3} | |
9046 | and @code{subdi3}: | |
9047 | ||
9048 | @smallexample | |
9049 | (define_insn "sub<mode>3" | |
9050 | [(set (match_operand:GPR 0 "register_operand" "=d") | |
9051 | (minus:GPR (match_operand:GPR 1 "register_operand" "d") | |
9052 | (match_operand:GPR 2 "register_operand" "d")))] | |
9053 | "" | |
9054 | "<d>subu\t%0,%1,%2" | |
9055 | [(set_attr "type" "arith") | |
9056 | (set_attr "mode" "<MODE>")]) | |
9057 | @end smallexample | |
9058 | ||
9059 | This is exactly equivalent to: | |
9060 | ||
9061 | @smallexample | |
9062 | (define_insn "subsi3" | |
9063 | [(set (match_operand:SI 0 "register_operand" "=d") | |
9064 | (minus:SI (match_operand:SI 1 "register_operand" "d") | |
9065 | (match_operand:SI 2 "register_operand" "d")))] | |
9066 | "" | |
9067 | "subu\t%0,%1,%2" | |
9068 | [(set_attr "type" "arith") | |
9069 | (set_attr "mode" "SI")]) | |
9070 | ||
9071 | (define_insn "subdi3" | |
9072 | [(set (match_operand:DI 0 "register_operand" "=d") | |
9073 | (minus:DI (match_operand:DI 1 "register_operand" "d") | |
9074 | (match_operand:DI 2 "register_operand" "d")))] | |
9075 | "" | |
9076 | "dsubu\t%0,%1,%2" | |
9077 | [(set_attr "type" "arith") | |
9078 | (set_attr "mode" "DI")]) | |
9079 | @end smallexample | |
9080 | ||
3abcb3a7 HPN |
9081 | @node Code Iterators |
9082 | @subsection Code Iterators | |
9083 | @cindex code iterators in @file{.md} files | |
9084 | @findex define_code_iterator | |
032e8348 RS |
9085 | @findex define_code_attr |
9086 | ||
3abcb3a7 | 9087 | Code iterators operate in a similar way to mode iterators. @xref{Mode Iterators}. |
032e8348 RS |
9088 | |
9089 | The construct: | |
9090 | ||
9091 | @smallexample | |
923158be | 9092 | (define_code_iterator @var{name} [(@var{code1} "@var{cond1}") @dots{} (@var{coden} "@var{condn}")]) |
032e8348 RS |
9093 | @end smallexample |
9094 | ||
9095 | defines a pseudo rtx code @var{name} that can be instantiated as | |
9096 | @var{codei} if condition @var{condi} is true. Each @var{codei} | |
9097 | must have the same rtx format. @xref{RTL Classes}. | |
9098 | ||
3abcb3a7 | 9099 | As with mode iterators, each pattern that uses @var{name} will be |
032e8348 RS |
9100 | expanded @var{n} times, once with all uses of @var{name} replaced by |
9101 | @var{code1}, once with all uses replaced by @var{code2}, and so on. | |
3abcb3a7 | 9102 | @xref{Defining Mode Iterators}. |
032e8348 RS |
9103 | |
9104 | It is possible to define attributes for codes as well as for modes. | |
9105 | There are two standard code attributes: @code{code}, the name of the | |
9106 | code in lower case, and @code{CODE}, the name of the code in upper case. | |
9107 | Other attributes are defined using: | |
9108 | ||
9109 | @smallexample | |
923158be | 9110 | (define_code_attr @var{name} [(@var{code1} "@var{value1}") @dots{} (@var{coden} "@var{valuen}")]) |
032e8348 RS |
9111 | @end smallexample |
9112 | ||
3abcb3a7 | 9113 | Here's an example of code iterators in action, taken from the MIPS port: |
032e8348 RS |
9114 | |
9115 | @smallexample | |
3abcb3a7 HPN |
9116 | (define_code_iterator any_cond [unordered ordered unlt unge uneq ltgt unle ungt |
9117 | eq ne gt ge lt le gtu geu ltu leu]) | |
032e8348 RS |
9118 | |
9119 | (define_expand "b<code>" | |
9120 | [(set (pc) | |
9121 | (if_then_else (any_cond:CC (cc0) | |
9122 | (const_int 0)) | |
9123 | (label_ref (match_operand 0 "")) | |
9124 | (pc)))] | |
9125 | "" | |
9126 | @{ | |
9127 | gen_conditional_branch (operands, <CODE>); | |
9128 | DONE; | |
9129 | @}) | |
9130 | @end smallexample | |
9131 | ||
9132 | This is equivalent to: | |
9133 | ||
9134 | @smallexample | |
9135 | (define_expand "bunordered" | |
9136 | [(set (pc) | |
9137 | (if_then_else (unordered:CC (cc0) | |
9138 | (const_int 0)) | |
9139 | (label_ref (match_operand 0 "")) | |
9140 | (pc)))] | |
9141 | "" | |
9142 | @{ | |
9143 | gen_conditional_branch (operands, UNORDERED); | |
9144 | DONE; | |
9145 | @}) | |
9146 | ||
9147 | (define_expand "bordered" | |
9148 | [(set (pc) | |
9149 | (if_then_else (ordered:CC (cc0) | |
9150 | (const_int 0)) | |
9151 | (label_ref (match_operand 0 "")) | |
9152 | (pc)))] | |
9153 | "" | |
9154 | @{ | |
9155 | gen_conditional_branch (operands, ORDERED); | |
9156 | DONE; | |
9157 | @}) | |
9158 | ||
923158be | 9159 | @dots{} |
032e8348 RS |
9160 | @end smallexample |
9161 | ||
9162 | @end ifset |