OSDN Git Service

9d7771c27709a64b309d10d4a981f0eacfdd3d9f
[pf3gnuchains/gcc-fork.git] / gcc / doc / md.texi
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1996, 1998, 1999, 2000, 2001,
2 @c 2002, 2003, 2004 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
5
6 @ifset INTERNALS
7 @node Machine Desc
8 @chapter Machine Descriptions
9 @cindex machine descriptions
10
11 A machine description has two parts: a file of instruction patterns
12 (@file{.md} file) and a C header file of macro definitions.
13
14 The @file{.md} file for a target machine contains a pattern for each
15 instruction that the target machine supports (or at least each instruction
16 that is worth telling the compiler about).  It may also contain comments.
17 A semicolon causes the rest of the line to be a comment, unless the semicolon
18 is inside a quoted string.
19
20 See the next chapter for information on the C header file.
21
22 @menu
23 * Overview::            How the machine description is used.
24 * Patterns::            How to write instruction patterns.
25 * Example::             An explained example of a @code{define_insn} pattern.
26 * RTL Template::        The RTL template defines what insns match a pattern.
27 * Output Template::     The output template says how to make assembler code
28                           from such an insn.
29 * Output Statement::    For more generality, write C code to output
30                           the assembler code.
31 * Predicates::          Controlling what kinds of operands can be used
32                           for an insn.
33 * Constraints::         Fine-tuning operand selection.
34 * Standard Names::      Names mark patterns to use for code generation.
35 * Pattern Ordering::    When the order of patterns makes a difference.
36 * Dependent Patterns::  Having one pattern may make you need another.
37 * Jump Patterns::       Special considerations for patterns for jump insns.
38 * Looping Patterns::    How to define patterns for special looping insns.
39 * Insn Canonicalizations::Canonicalization of Instructions
40 * Expander Definitions::Generating a sequence of several RTL insns
41                           for a standard operation.
42 * Insn Splitting::      Splitting Instructions into Multiple Instructions.
43 * Including Patterns::      Including Patterns in Machine Descriptions.
44 * Peephole Definitions::Defining machine-specific peephole optimizations.
45 * Insn Attributes::     Specifying the value of attributes for generated insns.
46 * Conditional Execution::Generating @code{define_insn} patterns for
47                            predication.
48 * Constant Definitions::Defining symbolic constants that can be used in the
49                         md file.
50 * Macros::              Using macros to generate patterns from a template.
51 @end menu
52
53 @node Overview
54 @section Overview of How the Machine Description is Used
55
56 There are three main conversions that happen in the compiler:
57
58 @enumerate
59
60 @item
61 The front end reads the source code and builds a parse tree.
62
63 @item
64 The parse tree is used to generate an RTL insn list based on named
65 instruction patterns.
66
67 @item
68 The insn list is matched against the RTL templates to produce assembler
69 code.
70
71 @end enumerate
72
73 For the generate pass, only the names of the insns matter, from either a
74 named @code{define_insn} or a @code{define_expand}.  The compiler will
75 choose the pattern with the right name and apply the operands according
76 to the documentation later in this chapter, without regard for the RTL
77 template or operand constraints.  Note that the names the compiler looks
78 for are hard-coded in the compiler---it will ignore unnamed patterns and
79 patterns with names it doesn't know about, but if you don't provide a
80 named pattern it needs, it will abort.
81
82 If a @code{define_insn} is used, the template given is inserted into the
83 insn list.  If a @code{define_expand} is used, one of three things
84 happens, based on the condition logic.  The condition logic may manually
85 create new insns for the insn list, say via @code{emit_insn()}, and
86 invoke @code{DONE}.  For certain named patterns, it may invoke @code{FAIL} to tell the
87 compiler to use an alternate way of performing that task.  If it invokes
88 neither @code{DONE} nor @code{FAIL}, the template given in the pattern
89 is inserted, as if the @code{define_expand} were a @code{define_insn}.
90
91 Once the insn list is generated, various optimization passes convert,
92 replace, and rearrange the insns in the insn list.  This is where the
93 @code{define_split} and @code{define_peephole} patterns get used, for
94 example.
95
96 Finally, the insn list's RTL is matched up with the RTL templates in the
97 @code{define_insn} patterns, and those patterns are used to emit the
98 final assembly code.  For this purpose, each named @code{define_insn}
99 acts like it's unnamed, since the names are ignored.
100
101 @node Patterns
102 @section Everything about Instruction Patterns
103 @cindex patterns
104 @cindex instruction patterns
105
106 @findex define_insn
107 Each instruction pattern contains an incomplete RTL expression, with pieces
108 to be filled in later, operand constraints that restrict how the pieces can
109 be filled in, and an output pattern or C code to generate the assembler
110 output, all wrapped up in a @code{define_insn} expression.
111
112 A @code{define_insn} is an RTL expression containing four or five operands:
113
114 @enumerate
115 @item
116 An optional name.  The presence of a name indicate that this instruction
117 pattern can perform a certain standard job for the RTL-generation
118 pass of the compiler.  This pass knows certain names and will use
119 the instruction patterns with those names, if the names are defined
120 in the machine description.
121
122 The absence of a name is indicated by writing an empty string
123 where the name should go.  Nameless instruction patterns are never
124 used for generating RTL code, but they may permit several simpler insns
125 to be combined later on.
126
127 Names that are not thus known and used in RTL-generation have no
128 effect; they are equivalent to no name at all.
129
130 For the purpose of debugging the compiler, you may also specify a
131 name beginning with the @samp{*} character.  Such a name is used only
132 for identifying the instruction in RTL dumps; it is entirely equivalent
133 to having a nameless pattern for all other purposes.
134
135 @item
136 The @dfn{RTL template} (@pxref{RTL Template}) is a vector of incomplete
137 RTL expressions which show what the instruction should look like.  It is
138 incomplete because it may contain @code{match_operand},
139 @code{match_operator}, and @code{match_dup} expressions that stand for
140 operands of the instruction.
141
142 If the vector has only one element, that element is the template for the
143 instruction pattern.  If the vector has multiple elements, then the
144 instruction pattern is a @code{parallel} expression containing the
145 elements described.
146
147 @item
148 @cindex pattern conditions
149 @cindex conditions, in patterns
150 A condition.  This is a string which contains a C expression that is
151 the final test to decide whether an insn body matches this pattern.
152
153 @cindex named patterns and conditions
154 For a named pattern, the condition (if present) may not depend on
155 the data in the insn being matched, but only the target-machine-type
156 flags.  The compiler needs to test these conditions during
157 initialization in order to learn exactly which named instructions are
158 available in a particular run.
159
160 @findex operands
161 For nameless patterns, the condition is applied only when matching an
162 individual insn, and only after the insn has matched the pattern's
163 recognition template.  The insn's operands may be found in the vector
164 @code{operands}.  For an insn where the condition has once matched, it
165 can't be used to control register allocation, for example by excluding
166 certain hard registers or hard register combinations.
167
168 @item
169 The @dfn{output template}: a string that says how to output matching
170 insns as assembler code.  @samp{%} in this string specifies where
171 to substitute the value of an operand.  @xref{Output Template}.
172
173 When simple substitution isn't general enough, you can specify a piece
174 of C code to compute the output.  @xref{Output Statement}.
175
176 @item
177 Optionally, a vector containing the values of attributes for insns matching
178 this pattern.  @xref{Insn Attributes}.
179 @end enumerate
180
181 @node Example
182 @section Example of @code{define_insn}
183 @cindex @code{define_insn} example
184
185 Here is an actual example of an instruction pattern, for the 68000/68020.
186
187 @smallexample
188 (define_insn "tstsi"
189   [(set (cc0)
190         (match_operand:SI 0 "general_operand" "rm"))]
191   ""
192   "*
193 @{
194   if (TARGET_68020 || ! ADDRESS_REG_P (operands[0]))
195     return \"tstl %0\";
196   return \"cmpl #0,%0\";
197 @}")
198 @end smallexample
199
200 @noindent
201 This can also be written using braced strings:
202
203 @smallexample
204 (define_insn "tstsi"
205   [(set (cc0)
206         (match_operand:SI 0 "general_operand" "rm"))]
207   ""
208 @{
209   if (TARGET_68020 || ! ADDRESS_REG_P (operands[0]))
210     return "tstl %0";
211   return "cmpl #0,%0";
212 @})
213 @end smallexample
214
215 This is an instruction that sets the condition codes based on the value of
216 a general operand.  It has no condition, so any insn whose RTL description
217 has the form shown may be handled according to this pattern.  The name
218 @samp{tstsi} means ``test a @code{SImode} value'' and tells the RTL generation
219 pass that, when it is necessary to test such a value, an insn to do so
220 can be constructed using this pattern.
221
222 The output control string is a piece of C code which chooses which
223 output template to return based on the kind of operand and the specific
224 type of CPU for which code is being generated.
225
226 @samp{"rm"} is an operand constraint.  Its meaning is explained below.
227
228 @node RTL Template
229 @section RTL Template
230 @cindex RTL insn template
231 @cindex generating insns
232 @cindex insns, generating
233 @cindex recognizing insns
234 @cindex insns, recognizing
235
236 The RTL template is used to define which insns match the particular pattern
237 and how to find their operands.  For named patterns, the RTL template also
238 says how to construct an insn from specified operands.
239
240 Construction involves substituting specified operands into a copy of the
241 template.  Matching involves determining the values that serve as the
242 operands in the insn being matched.  Both of these activities are
243 controlled by special expression types that direct matching and
244 substitution of the operands.
245
246 @table @code
247 @findex match_operand
248 @item (match_operand:@var{m} @var{n} @var{predicate} @var{constraint})
249 This expression is a placeholder for operand number @var{n} of
250 the insn.  When constructing an insn, operand number @var{n}
251 will be substituted at this point.  When matching an insn, whatever
252 appears at this position in the insn will be taken as operand
253 number @var{n}; but it must satisfy @var{predicate} or this instruction
254 pattern will not match at all.
255
256 Operand numbers must be chosen consecutively counting from zero in
257 each instruction pattern.  There may be only one @code{match_operand}
258 expression in the pattern for each operand number.  Usually operands
259 are numbered in the order of appearance in @code{match_operand}
260 expressions.  In the case of a @code{define_expand}, any operand numbers
261 used only in @code{match_dup} expressions have higher values than all
262 other operand numbers.
263
264 @var{predicate} is a string that is the name of a function that
265 accepts two arguments, an expression and a machine mode.
266 @xref{Predicates}.  During matching, the function will be called with
267 the putative operand as the expression and @var{m} as the mode
268 argument (if @var{m} is not specified, @code{VOIDmode} will be used,
269 which normally causes @var{predicate} to accept any mode).  If it
270 returns zero, this instruction pattern fails to match.
271 @var{predicate} may be an empty string; then it means no test is to be
272 done on the operand, so anything which occurs in this position is
273 valid.
274
275 Most of the time, @var{predicate} will reject modes other than @var{m}---but
276 not always.  For example, the predicate @code{address_operand} uses
277 @var{m} as the mode of memory ref that the address should be valid for.
278 Many predicates accept @code{const_int} nodes even though their mode is
279 @code{VOIDmode}.
280
281 @var{constraint} controls reloading and the choice of the best register
282 class to use for a value, as explained later (@pxref{Constraints}).
283 If the constraint would be an empty string, it can be omitted.
284
285 People are often unclear on the difference between the constraint and the
286 predicate.  The predicate helps decide whether a given insn matches the
287 pattern.  The constraint plays no role in this decision; instead, it
288 controls various decisions in the case of an insn which does match.
289
290 @findex match_scratch
291 @item (match_scratch:@var{m} @var{n} @var{constraint})
292 This expression is also a placeholder for operand number @var{n}
293 and indicates that operand must be a @code{scratch} or @code{reg}
294 expression.
295
296 When matching patterns, this is equivalent to
297
298 @smallexample
299 (match_operand:@var{m} @var{n} "scratch_operand" @var{pred})
300 @end smallexample
301
302 but, when generating RTL, it produces a (@code{scratch}:@var{m})
303 expression.
304
305 If the last few expressions in a @code{parallel} are @code{clobber}
306 expressions whose operands are either a hard register or
307 @code{match_scratch}, the combiner can add or delete them when
308 necessary.  @xref{Side Effects}.
309
310 @findex match_dup
311 @item (match_dup @var{n})
312 This expression is also a placeholder for operand number @var{n}.
313 It is used when the operand needs to appear more than once in the
314 insn.
315
316 In construction, @code{match_dup} acts just like @code{match_operand}:
317 the operand is substituted into the insn being constructed.  But in
318 matching, @code{match_dup} behaves differently.  It assumes that operand
319 number @var{n} has already been determined by a @code{match_operand}
320 appearing earlier in the recognition template, and it matches only an
321 identical-looking expression.
322
323 Note that @code{match_dup} should not be used to tell the compiler that
324 a particular register is being used for two operands (example:
325 @code{add} that adds one register to another; the second register is
326 both an input operand and the output operand).  Use a matching
327 constraint (@pxref{Simple Constraints}) for those.  @code{match_dup} is for the cases where one
328 operand is used in two places in the template, such as an instruction
329 that computes both a quotient and a remainder, where the opcode takes
330 two input operands but the RTL template has to refer to each of those
331 twice; once for the quotient pattern and once for the remainder pattern.
332
333 @findex match_operator
334 @item (match_operator:@var{m} @var{n} @var{predicate} [@var{operands}@dots{}])
335 This pattern is a kind of placeholder for a variable RTL expression
336 code.
337
338 When constructing an insn, it stands for an RTL expression whose
339 expression code is taken from that of operand @var{n}, and whose
340 operands are constructed from the patterns @var{operands}.
341
342 When matching an expression, it matches an expression if the function
343 @var{predicate} returns nonzero on that expression @emph{and} the
344 patterns @var{operands} match the operands of the expression.
345
346 Suppose that the function @code{commutative_operator} is defined as
347 follows, to match any expression whose operator is one of the
348 commutative arithmetic operators of RTL and whose mode is @var{mode}:
349
350 @smallexample
351 int
352 commutative_integer_operator (x, mode)
353      rtx x;
354      enum machine_mode mode;
355 @{
356   enum rtx_code code = GET_CODE (x);
357   if (GET_MODE (x) != mode)
358     return 0;
359   return (GET_RTX_CLASS (code) == RTX_COMM_ARITH
360           || code == EQ || code == NE);
361 @}
362 @end smallexample
363
364 Then the following pattern will match any RTL expression consisting
365 of a commutative operator applied to two general operands:
366
367 @smallexample
368 (match_operator:SI 3 "commutative_operator"
369   [(match_operand:SI 1 "general_operand" "g")
370    (match_operand:SI 2 "general_operand" "g")])
371 @end smallexample
372
373 Here the vector @code{[@var{operands}@dots{}]} contains two patterns
374 because the expressions to be matched all contain two operands.
375
376 When this pattern does match, the two operands of the commutative
377 operator are recorded as operands 1 and 2 of the insn.  (This is done
378 by the two instances of @code{match_operand}.)  Operand 3 of the insn
379 will be the entire commutative expression: use @code{GET_CODE
380 (operands[3])} to see which commutative operator was used.
381
382 The machine mode @var{m} of @code{match_operator} works like that of
383 @code{match_operand}: it is passed as the second argument to the
384 predicate function, and that function is solely responsible for
385 deciding whether the expression to be matched ``has'' that mode.
386
387 When constructing an insn, argument 3 of the gen-function will specify
388 the operation (i.e.@: the expression code) for the expression to be
389 made.  It should be an RTL expression, whose expression code is copied
390 into a new expression whose operands are arguments 1 and 2 of the
391 gen-function.  The subexpressions of argument 3 are not used;
392 only its expression code matters.
393
394 When @code{match_operator} is used in a pattern for matching an insn,
395 it usually best if the operand number of the @code{match_operator}
396 is higher than that of the actual operands of the insn.  This improves
397 register allocation because the register allocator often looks at
398 operands 1 and 2 of insns to see if it can do register tying.
399
400 There is no way to specify constraints in @code{match_operator}.  The
401 operand of the insn which corresponds to the @code{match_operator}
402 never has any constraints because it is never reloaded as a whole.
403 However, if parts of its @var{operands} are matched by
404 @code{match_operand} patterns, those parts may have constraints of
405 their own.
406
407 @findex match_op_dup
408 @item (match_op_dup:@var{m} @var{n}[@var{operands}@dots{}])
409 Like @code{match_dup}, except that it applies to operators instead of
410 operands.  When constructing an insn, operand number @var{n} will be
411 substituted at this point.  But in matching, @code{match_op_dup} behaves
412 differently.  It assumes that operand number @var{n} has already been
413 determined by a @code{match_operator} appearing earlier in the
414 recognition template, and it matches only an identical-looking
415 expression.
416
417 @findex match_parallel
418 @item (match_parallel @var{n} @var{predicate} [@var{subpat}@dots{}])
419 This pattern is a placeholder for an insn that consists of a
420 @code{parallel} expression with a variable number of elements.  This
421 expression should only appear at the top level of an insn pattern.
422
423 When constructing an insn, operand number @var{n} will be substituted at
424 this point.  When matching an insn, it matches if the body of the insn
425 is a @code{parallel} expression with at least as many elements as the
426 vector of @var{subpat} expressions in the @code{match_parallel}, if each
427 @var{subpat} matches the corresponding element of the @code{parallel},
428 @emph{and} the function @var{predicate} returns nonzero on the
429 @code{parallel} that is the body of the insn.  It is the responsibility
430 of the predicate to validate elements of the @code{parallel} beyond
431 those listed in the @code{match_parallel}.
432
433 A typical use of @code{match_parallel} is to match load and store
434 multiple expressions, which can contain a variable number of elements
435 in a @code{parallel}.  For example,
436
437 @smallexample
438 (define_insn ""
439   [(match_parallel 0 "load_multiple_operation"
440      [(set (match_operand:SI 1 "gpc_reg_operand" "=r")
441            (match_operand:SI 2 "memory_operand" "m"))
442       (use (reg:SI 179))
443       (clobber (reg:SI 179))])]
444   ""
445   "loadm 0,0,%1,%2")
446 @end smallexample
447
448 This example comes from @file{a29k.md}.  The function
449 @code{load_multiple_operation} is defined in @file{a29k.c} and checks
450 that subsequent elements in the @code{parallel} are the same as the
451 @code{set} in the pattern, except that they are referencing subsequent
452 registers and memory locations.
453
454 An insn that matches this pattern might look like:
455
456 @smallexample
457 (parallel
458  [(set (reg:SI 20) (mem:SI (reg:SI 100)))
459   (use (reg:SI 179))
460   (clobber (reg:SI 179))
461   (set (reg:SI 21)
462        (mem:SI (plus:SI (reg:SI 100)
463                         (const_int 4))))
464   (set (reg:SI 22)
465        (mem:SI (plus:SI (reg:SI 100)
466                         (const_int 8))))])
467 @end smallexample
468
469 @findex match_par_dup
470 @item (match_par_dup @var{n} [@var{subpat}@dots{}])
471 Like @code{match_op_dup}, but for @code{match_parallel} instead of
472 @code{match_operator}.
473
474 @end table
475
476 @node Output Template
477 @section Output Templates and Operand Substitution
478 @cindex output templates
479 @cindex operand substitution
480
481 @cindex @samp{%} in template
482 @cindex percent sign
483 The @dfn{output template} is a string which specifies how to output the
484 assembler code for an instruction pattern.  Most of the template is a
485 fixed string which is output literally.  The character @samp{%} is used
486 to specify where to substitute an operand; it can also be used to
487 identify places where different variants of the assembler require
488 different syntax.
489
490 In the simplest case, a @samp{%} followed by a digit @var{n} says to output
491 operand @var{n} at that point in the string.
492
493 @samp{%} followed by a letter and a digit says to output an operand in an
494 alternate fashion.  Four letters have standard, built-in meanings described
495 below.  The machine description macro @code{PRINT_OPERAND} can define
496 additional letters with nonstandard meanings.
497
498 @samp{%c@var{digit}} can be used to substitute an operand that is a
499 constant value without the syntax that normally indicates an immediate
500 operand.
501
502 @samp{%n@var{digit}} is like @samp{%c@var{digit}} except that the value of
503 the constant is negated before printing.
504
505 @samp{%a@var{digit}} can be used to substitute an operand as if it were a
506 memory reference, with the actual operand treated as the address.  This may
507 be useful when outputting a ``load address'' instruction, because often the
508 assembler syntax for such an instruction requires you to write the operand
509 as if it were a memory reference.
510
511 @samp{%l@var{digit}} is used to substitute a @code{label_ref} into a jump
512 instruction.
513
514 @samp{%=} outputs a number which is unique to each instruction in the
515 entire compilation.  This is useful for making local labels to be
516 referred to more than once in a single template that generates multiple
517 assembler instructions.
518
519 @samp{%} followed by a punctuation character specifies a substitution that
520 does not use an operand.  Only one case is standard: @samp{%%} outputs a
521 @samp{%} into the assembler code.  Other nonstandard cases can be
522 defined in the @code{PRINT_OPERAND} macro.  You must also define
523 which punctuation characters are valid with the
524 @code{PRINT_OPERAND_PUNCT_VALID_P} macro.
525
526 @cindex \
527 @cindex backslash
528 The template may generate multiple assembler instructions.  Write the text
529 for the instructions, with @samp{\;} between them.
530
531 @cindex matching operands
532 When the RTL contains two operands which are required by constraint to match
533 each other, the output template must refer only to the lower-numbered operand.
534 Matching operands are not always identical, and the rest of the compiler
535 arranges to put the proper RTL expression for printing into the lower-numbered
536 operand.
537
538 One use of nonstandard letters or punctuation following @samp{%} is to
539 distinguish between different assembler languages for the same machine; for
540 example, Motorola syntax versus MIT syntax for the 68000.  Motorola syntax
541 requires periods in most opcode names, while MIT syntax does not.  For
542 example, the opcode @samp{movel} in MIT syntax is @samp{move.l} in Motorola
543 syntax.  The same file of patterns is used for both kinds of output syntax,
544 but the character sequence @samp{%.} is used in each place where Motorola
545 syntax wants a period.  The @code{PRINT_OPERAND} macro for Motorola syntax
546 defines the sequence to output a period; the macro for MIT syntax defines
547 it to do nothing.
548
549 @cindex @code{#} in template
550 As a special case, a template consisting of the single character @code{#}
551 instructs the compiler to first split the insn, and then output the
552 resulting instructions separately.  This helps eliminate redundancy in the
553 output templates.   If you have a @code{define_insn} that needs to emit
554 multiple assembler instructions, and there is an matching @code{define_split}
555 already defined, then you can simply use @code{#} as the output template
556 instead of writing an output template that emits the multiple assembler
557 instructions.
558
559 If the macro @code{ASSEMBLER_DIALECT} is defined, you can use construct
560 of the form @samp{@{option0|option1|option2@}} in the templates.  These
561 describe multiple variants of assembler language syntax.
562 @xref{Instruction Output}.
563
564 @node Output Statement
565 @section C Statements for Assembler Output
566 @cindex output statements
567 @cindex C statements for assembler output
568 @cindex generating assembler output
569
570 Often a single fixed template string cannot produce correct and efficient
571 assembler code for all the cases that are recognized by a single
572 instruction pattern.  For example, the opcodes may depend on the kinds of
573 operands; or some unfortunate combinations of operands may require extra
574 machine instructions.
575
576 If the output control string starts with a @samp{@@}, then it is actually
577 a series of templates, each on a separate line.  (Blank lines and
578 leading spaces and tabs are ignored.)  The templates correspond to the
579 pattern's constraint alternatives (@pxref{Multi-Alternative}).  For example,
580 if a target machine has a two-address add instruction @samp{addr} to add
581 into a register and another @samp{addm} to add a register to memory, you
582 might write this pattern:
583
584 @smallexample
585 (define_insn "addsi3"
586   [(set (match_operand:SI 0 "general_operand" "=r,m")
587         (plus:SI (match_operand:SI 1 "general_operand" "0,0")
588                  (match_operand:SI 2 "general_operand" "g,r")))]
589   ""
590   "@@
591    addr %2,%0
592    addm %2,%0")
593 @end smallexample
594
595 @cindex @code{*} in template
596 @cindex asterisk in template
597 If the output control string starts with a @samp{*}, then it is not an
598 output template but rather a piece of C program that should compute a
599 template.  It should execute a @code{return} statement to return the
600 template-string you want.  Most such templates use C string literals, which
601 require doublequote characters to delimit them.  To include these
602 doublequote characters in the string, prefix each one with @samp{\}.
603
604 If the output control string is written as a brace block instead of a
605 double-quoted string, it is automatically assumed to be C code.  In that
606 case, it is not necessary to put in a leading asterisk, or to escape the
607 doublequotes surrounding C string literals.
608
609 The operands may be found in the array @code{operands}, whose C data type
610 is @code{rtx []}.
611
612 It is very common to select different ways of generating assembler code
613 based on whether an immediate operand is within a certain range.  Be
614 careful when doing this, because the result of @code{INTVAL} is an
615 integer on the host machine.  If the host machine has more bits in an
616 @code{int} than the target machine has in the mode in which the constant
617 will be used, then some of the bits you get from @code{INTVAL} will be
618 superfluous.  For proper results, you must carefully disregard the
619 values of those bits.
620
621 @findex output_asm_insn
622 It is possible to output an assembler instruction and then go on to output
623 or compute more of them, using the subroutine @code{output_asm_insn}.  This
624 receives two arguments: a template-string and a vector of operands.  The
625 vector may be @code{operands}, or it may be another array of @code{rtx}
626 that you declare locally and initialize yourself.
627
628 @findex which_alternative
629 When an insn pattern has multiple alternatives in its constraints, often
630 the appearance of the assembler code is determined mostly by which alternative
631 was matched.  When this is so, the C code can test the variable
632 @code{which_alternative}, which is the ordinal number of the alternative
633 that was actually satisfied (0 for the first, 1 for the second alternative,
634 etc.).
635
636 For example, suppose there are two opcodes for storing zero, @samp{clrreg}
637 for registers and @samp{clrmem} for memory locations.  Here is how
638 a pattern could use @code{which_alternative} to choose between them:
639
640 @smallexample
641 (define_insn ""
642   [(set (match_operand:SI 0 "general_operand" "=r,m")
643         (const_int 0))]
644   ""
645   @{
646   return (which_alternative == 0
647           ? "clrreg %0" : "clrmem %0");
648   @})
649 @end smallexample
650
651 The example above, where the assembler code to generate was
652 @emph{solely} determined by the alternative, could also have been specified
653 as follows, having the output control string start with a @samp{@@}:
654
655 @smallexample
656 @group
657 (define_insn ""
658   [(set (match_operand:SI 0 "general_operand" "=r,m")
659         (const_int 0))]
660   ""
661   "@@
662    clrreg %0
663    clrmem %0")
664 @end group
665 @end smallexample
666
667 @node Predicates
668 @section Predicates
669 @cindex predicates
670 @cindex operand predicates
671 @cindex operator predicates
672
673 A predicate determines whether a @code{match_operand} or
674 @code{match_operator} expression matches, and therefore whether the
675 surrounding instruction pattern will be used for that combination of
676 operands.  GCC has a number of machine-independent predicates, and you
677 can define machine-specific predicates as needed.  By convention,
678 predicates used with @code{match_operand} have names that end in
679 @samp{_operand}, and those used with @code{match_operator} have names
680 that end in @samp{_operator}.
681
682 All predicates are Boolean functions (in the mathematical sense) of
683 two arguments: the RTL expression that is being considered at that
684 position in the instruction pattern, and the machine mode that the
685 @code{match_operand} or @code{match_operator} specifies.  In this
686 section, the first argument is called @var{op} and the second argument
687 @var{mode}.  Predicates can be called from C as ordinary two-argument
688 functions; this can be useful in output templates or other
689 machine-specific code.
690
691 Operand predicates can allow operands that are not actually acceptable
692 to the hardware, as long as the constraints give reload the ability to
693 fix them up (@pxref{Constraints}).  However, GCC will usually generate
694 better code if the predicates specify the requirements of the machine
695 instructions as closely as possible.  Reload cannot fix up operands
696 that must be constants (``immediate operands''); you must use a
697 predicate that allows only constants, or else enforce the requirement
698 in the extra condition.
699
700 @cindex predicates and machine modes
701 @cindex normal predicates
702 @cindex special predicates
703 Most predicates handle their @var{mode} argument in a uniform manner.
704 If @var{mode} is @code{VOIDmode} (unspecified), then @var{op} can have
705 any mode.  If @var{mode} is anything else, then @var{op} must have the
706 same mode, unless @var{op} is a @code{CONST_INT} or integer
707 @code{CONST_DOUBLE}.  These RTL expressions always have
708 @code{VOIDmode}, so it would be counterproductive to check that their
709 mode matches.  Instead, predicates that accept @code{CONST_INT} and/or
710 integer @code{CONST_DOUBLE} check that the value stored in the
711 constant will fit in the requested mode.
712
713 Predicates with this behavior are called @dfn{normal}.
714 @command{genrecog} can optimize the instruction recognizer based on
715 knowledge of how normal predicates treat modes.  It can also diagnose
716 certain kinds of common errors in the use of normal predicates; for
717 instance, it is almost always an error to use a normal predicate
718 without specifying a mode.
719
720 Predicates that do something different with their @var{mode} argument
721 are called @dfn{special}.  The generic predicates
722 @code{address_operand} and @code{pmode_register_operand} are special
723 predicates.  @command{genrecog} does not do any optimizations or
724 diagnosis when special predicates are used.
725
726 @menu
727 * Machine-Independent Predicates::  Predicates available to all back ends.
728 * Defining Predicates::             How to write machine-specific predicate
729                                     functions.
730 @end menu
731
732 @node Machine-Independent Predicates
733 @subsection Machine-Independent Predicates
734 @cindex machine-independent predicates
735 @cindex generic predicates
736
737 These are the generic predicates available to all back ends.  They are
738 defined in @file{recog.c}.  The first category of predicates allow
739 only constant, or @dfn{immediate}, operands.
740
741 @defun immediate_operand
742 This predicate allows any sort of constant that fits in @var{mode}.
743 It is an appropriate choice for instructions that take operands that
744 must be constant.
745 @end defun
746
747 @defun const_int_operand
748 This predicate allows any @code{CONST_INT} expression that fits in
749 @var{mode}.  It is an appropriate choice for an immediate operand that
750 does not allow a symbol or label.
751 @end defun
752
753 @defun const_double_operand
754 This predicate accepts any @code{CONST_DOUBLE} expression that has
755 exactly @var{mode}.  If @var{mode} is @code{VOIDmode}, it will also
756 accept @code{CONST_INT}.  It is intended for immediate floating point
757 constants.
758 @end defun
759
760 @noindent
761 The second category of predicates allow only some kind of machine
762 register.
763
764 @defun register_operand
765 This predicate allows any @code{REG} or @code{SUBREG} expression that
766 is valid for @var{mode}.  It is often suitable for arithmetic
767 instruction operands on a RISC machine.
768 @end defun
769
770 @defun pmode_register_operand
771 This is a slight variant on @code{register_operand} which works around
772 a limitation in the machine-description reader.
773
774 @smallexample
775 (match_operand @var{n} "pmode_register_operand" @var{constraint})
776 @end smallexample
777
778 @noindent
779 means exactly what
780
781 @smallexample
782 (match_operand:P @var{n} "register_operand" @var{constraint})
783 @end smallexample
784
785 @noindent
786 would mean, if the machine-description reader accepted @samp{:P}
787 mode suffixes.  Unfortunately, it cannot, because @code{Pmode} is an
788 alias for some other mode, and might vary with machine-specific
789 options.  @xref{Misc}.
790 @end defun
791
792 @defun scratch_operand
793 This predicate allows hard registers and @code{SCRATCH} expressions,
794 but not pseudo-registers.  It is used internally by @code{match_scratch};
795 it should not be used directly.
796 @end defun
797
798 @noindent
799 The third category of predicates allow only some kind of memory reference.
800
801 @defun memory_operand
802 This predicate allows any valid reference to a quantity of mode
803 @var{mode} in memory, as determined by the weak form of
804 @code{GO_IF_LEGITIMATE_ADDRESS} (@pxref{Addressing Modes}).
805 @end defun
806
807 @defun address_operand
808 This predicate is a little unusual; it allows any operand that is a
809 valid expression for the @emph{address} of a quantity of mode
810 @var{mode}, again determined by the weak form of
811 @code{GO_IF_LEGITIMATE_ADDRESS}.  To first order, if
812 @samp{@w{(mem:@var{mode} (@var{exp}))}} is acceptable to
813 @code{memory_operand}, then @var{exp} is acceptable to
814 @code{address_operand}.  Note that @var{exp} does not necessarily have
815 the mode @var{mode}.
816 @end defun
817
818 @defun indirect_operand
819 This is a stricter form of @code{memory_operand} which allows only
820 memory references with a @code{general_operand} as the address
821 expression.  New uses of this predicate are discouraged, because
822 @code{general_operand} is very permissive, so it's hard to tell what
823 an @code{indirect_operand} does or does not allow.  If a target has
824 different requirements for memory operands for different instructions,
825 it is better to define target-specific predicates which enforce the
826 hardware's requirements explicitly.
827 @end defun
828
829 @defun push_operand
830 This predicate allows a memory reference suitable for pushing a value
831 onto the stack.  This will be a @code{MEM} which refers to
832 @code{stack_pointer_rtx}, with a side-effect in its address expression
833 (@pxref{Incdec}); which one is determined by the
834 @code{STACK_PUSH_CODE} macro (@pxref{Frame Layout}).
835 @end defun
836
837 @defun pop_operand
838 This predicate allows a memory reference suitable for popping a value
839 off the stack.  Again, this will be a @code{MEM} referring to
840 @code{stack_pointer_rtx}, with a side-effect in its address
841 expression.  However, this time @code{STACK_POP_CODE} is expected.
842 @end defun
843
844 @noindent
845 The fourth category of predicates allow some combination of the above
846 operands.
847
848 @defun nonmemory_operand
849 This predicate allows any immediate or register operand valid for @var{mode}.
850 @end defun
851
852 @defun nonimmediate_operand
853 This predicate allows any register or memory operand valid for @var{mode}.
854 @end defun
855
856 @defun general_operand
857 This predicate allows any immediate, register, or memory operand
858 valid for @var{mode}.
859 @end defun
860
861 @noindent
862 Finally, there is one generic operator predicate.
863
864 @defun comparison_operator
865 This predicate matches any expression which performs an arithmetic
866 comparison in @var{mode}; that is, @code{COMPARISON_P} is true for the
867 expression code.
868 @end defun
869
870 @node Defining Predicates
871 @subsection Defining Machine-Specific Predicates
872 @cindex defining predicates
873 @findex define_predicate
874 @findex define_special_predicate
875
876 Many machines have requirements for their operands that cannot be
877 expressed precisely using the generic predicates.  You can define
878 additional predicates using @code{define_predicate} and
879 @code{define_special_predicate} expressions.  These expressions have
880 three operands:
881
882 @itemize @bullet
883 @item
884 The name of the predicate, as it will be referred to in
885 @code{match_operand} or @code{match_operator} expressions.
886
887 @item
888 An RTL expression which evaluates to true if the predicate allows the
889 operand @var{op}, false if it does not.  This expression can only use
890 the following RTL codes:
891
892 @table @code
893 @item MATCH_OPERAND
894 When written inside a predicate expression, a @code{MATCH_OPERAND}
895 expression evaluates to true if the predicate it names would allow
896 @var{op}.  The operand number and constraint are ignored.  Due to
897 limitations in @command{genrecog}, you can only refer to generic
898 predicates and predicates that have already been defined.
899
900 @item MATCH_CODE
901 This expression has one operand, a string constant containing a
902 comma-separated list of RTX code names (in lower case).  It evaluates
903 to true if @var{op} has any of the listed codes.
904
905 @item MATCH_TEST
906 This expression has one operand, a string constant containing a C
907 expression.  The predicate's arguments, @var{op} and @var{mode}, are
908 available with those names in the C expression.  The @code{MATCH_TEST}
909 evaluates to true if the C expression evaluates to a nonzero value.
910 @code{MATCH_TEST} expressions must not have side effects.
911
912 @item  AND
913 @itemx IOR
914 @itemx NOT
915 @itemx IF_THEN_ELSE
916 The basic @samp{MATCH_} expressions can be combined using these
917 logical operators, which have the semantics of the C operators
918 @samp{&&}, @samp{||}, @samp{!}, and @samp{@w{? :}} respectively.
919 @end table
920
921 @item
922 An optional block of C code, which should execute
923 @samp{@w{return true}} if the predicate is found to match and
924 @samp{@w{return false}} if it does not.  It must not have any side
925 effects.  The predicate arguments, @var{op} and @var{mode}, are
926 available with those names.
927
928 If a code block is present in a predicate definition, then the RTL
929 expression must evaluate to true @emph{and} the code block must
930 execute @samp{@w{return true}} for the predicate to allow the operand.
931 The RTL expression is evaluated first; do not re-check anything in the
932 code block that was checked in the RTL expression.
933 @end itemize
934
935 The program @command{genrecog} scans @code{define_predicate} and
936 @code{define_special_predicate} expressions to determine which RTX
937 codes are possibly allowed.  You should always make this explicit in
938 the RTL predicate expression, using @code{MATCH_OPERAND} and
939 @code{MATCH_CODE}.
940
941 Here is an example of a simple predicate definition, from the IA64
942 machine description:
943
944 @smallexample
945 @group
946 ;; @r{True if @var{op} is a @code{SYMBOL_REF} which refers to the sdata section.}
947 (define_predicate "small_addr_symbolic_operand"
948   (and (match_code "symbol_ref")
949        (match_test "SYMBOL_REF_SMALL_ADDR_P (op)")))
950 @end group
951 @end smallexample
952
953 @noindent
954 And here is another, showing the use of the C block.
955
956 @smallexample
957 @group
958 ;; @r{True if @var{op} is a register operand that is (or could be) a GR reg.}
959 (define_predicate "gr_register_operand"
960   (match_operand 0 "register_operand")
961 @{
962   unsigned int regno;
963   if (GET_CODE (op) == SUBREG)
964     op = SUBREG_REG (op);
965
966   regno = REGNO (op);
967   return (regno >= FIRST_PSEUDO_REGISTER || GENERAL_REGNO_P (regno));
968 @})
969 @end group
970 @end smallexample
971
972 Predicates written with @code{define_predicate} automatically include
973 a test that @var{mode} is @code{VOIDmode}, or @var{op} has the same
974 mode as @var{mode}, or @var{op} is a @code{CONST_INT} or
975 @code{CONST_DOUBLE}.  They do @emph{not} check specifically for
976 integer @code{CONST_DOUBLE}, nor do they test that the value of either
977 kind of constant fits in the requested mode.  This is because
978 target-specific predicates that take constants usually have to do more
979 stringent value checks anyway.  If you need the exact same treatment
980 of @code{CONST_INT} or @code{CONST_DOUBLE} that the generic predicates
981 provide, use a @code{MATCH_OPERAND} subexpression to call
982 @code{const_int_operand}, @code{const_double_operand}, or
983 @code{immediate_operand}.
984
985 Predicates written with @code{define_special_predicate} do not get any
986 automatic mode checks, and are treated as having special mode handling
987 by @command{genrecog}.
988
989 The program @command{genpreds} is responsible for generating code to
990 test predicates.  It also writes a header file containing function
991 declarations for all machine-specific predicates.  It is not necessary
992 to declare these predicates in @file{@var{cpu}-protos.h}.
993 @end ifset
994
995 @c Most of this node appears by itself (in a different place) even
996 @c when the INTERNALS flag is clear.  Passages that require the internals
997 @c manual's context are conditionalized to appear only in the internals manual.
998 @ifset INTERNALS
999 @node Constraints
1000 @section Operand Constraints
1001 @cindex operand constraints
1002 @cindex constraints
1003
1004 Each @code{match_operand} in an instruction pattern can specify
1005 constraints for the operands allowed.  The constraints allow you to
1006 fine-tune matching within the set of operands allowed by the
1007 predicate.
1008
1009 @end ifset
1010 @ifclear INTERNALS
1011 @node Constraints
1012 @section Constraints for @code{asm} Operands
1013 @cindex operand constraints, @code{asm}
1014 @cindex constraints, @code{asm}
1015 @cindex @code{asm} constraints
1016
1017 Here are specific details on what constraint letters you can use with
1018 @code{asm} operands.
1019 @end ifclear
1020 Constraints can say whether
1021 an operand may be in a register, and which kinds of register; whether the
1022 operand can be a memory reference, and which kinds of address; whether the
1023 operand may be an immediate constant, and which possible values it may
1024 have.  Constraints can also require two operands to match.
1025
1026 @ifset INTERNALS
1027 @menu
1028 * Simple Constraints::  Basic use of constraints.
1029 * Multi-Alternative::   When an insn has two alternative constraint-patterns.
1030 * Class Preferences::   Constraints guide which hard register to put things in.
1031 * Modifiers::           More precise control over effects of constraints.
1032 * Machine Constraints:: Existing constraints for some particular machines.
1033 @end menu
1034 @end ifset
1035
1036 @ifclear INTERNALS
1037 @menu
1038 * Simple Constraints::  Basic use of constraints.
1039 * Multi-Alternative::   When an insn has two alternative constraint-patterns.
1040 * Modifiers::           More precise control over effects of constraints.
1041 * Machine Constraints:: Special constraints for some particular machines.
1042 @end menu
1043 @end ifclear
1044
1045 @node Simple Constraints
1046 @subsection Simple Constraints
1047 @cindex simple constraints
1048
1049 The simplest kind of constraint is a string full of letters, each of
1050 which describes one kind of operand that is permitted.  Here are
1051 the letters that are allowed:
1052
1053 @table @asis
1054 @item whitespace
1055 Whitespace characters are ignored and can be inserted at any position
1056 except the first.  This enables each alternative for different operands to
1057 be visually aligned in the machine description even if they have different
1058 number of constraints and modifiers.
1059
1060 @cindex @samp{m} in constraint
1061 @cindex memory references in constraints
1062 @item @samp{m}
1063 A memory operand is allowed, with any kind of address that the machine
1064 supports in general.
1065
1066 @cindex offsettable address
1067 @cindex @samp{o} in constraint
1068 @item @samp{o}
1069 A memory operand is allowed, but only if the address is
1070 @dfn{offsettable}.  This means that adding a small integer (actually,
1071 the width in bytes of the operand, as determined by its machine mode)
1072 may be added to the address and the result is also a valid memory
1073 address.
1074
1075 @cindex autoincrement/decrement addressing
1076 For example, an address which is constant is offsettable; so is an
1077 address that is the sum of a register and a constant (as long as a
1078 slightly larger constant is also within the range of address-offsets
1079 supported by the machine); but an autoincrement or autodecrement
1080 address is not offsettable.  More complicated indirect/indexed
1081 addresses may or may not be offsettable depending on the other
1082 addressing modes that the machine supports.
1083
1084 Note that in an output operand which can be matched by another
1085 operand, the constraint letter @samp{o} is valid only when accompanied
1086 by both @samp{<} (if the target machine has predecrement addressing)
1087 and @samp{>} (if the target machine has preincrement addressing).
1088
1089 @cindex @samp{V} in constraint
1090 @item @samp{V}
1091 A memory operand that is not offsettable.  In other words, anything that
1092 would fit the @samp{m} constraint but not the @samp{o} constraint.
1093
1094 @cindex @samp{<} in constraint
1095 @item @samp{<}
1096 A memory operand with autodecrement addressing (either predecrement or
1097 postdecrement) is allowed.
1098
1099 @cindex @samp{>} in constraint
1100 @item @samp{>}
1101 A memory operand with autoincrement addressing (either preincrement or
1102 postincrement) is allowed.
1103
1104 @cindex @samp{r} in constraint
1105 @cindex registers in constraints
1106 @item @samp{r}
1107 A register operand is allowed provided that it is in a general
1108 register.
1109
1110 @cindex constants in constraints
1111 @cindex @samp{i} in constraint
1112 @item @samp{i}
1113 An immediate integer operand (one with constant value) is allowed.
1114 This includes symbolic constants whose values will be known only at
1115 assembly time or later.
1116
1117 @cindex @samp{n} in constraint
1118 @item @samp{n}
1119 An immediate integer operand with a known numeric value is allowed.
1120 Many systems cannot support assembly-time constants for operands less
1121 than a word wide.  Constraints for these operands should use @samp{n}
1122 rather than @samp{i}.
1123
1124 @cindex @samp{I} in constraint
1125 @item @samp{I}, @samp{J}, @samp{K}, @dots{} @samp{P}
1126 Other letters in the range @samp{I} through @samp{P} may be defined in
1127 a machine-dependent fashion to permit immediate integer operands with
1128 explicit integer values in specified ranges.  For example, on the
1129 68000, @samp{I} is defined to stand for the range of values 1 to 8.
1130 This is the range permitted as a shift count in the shift
1131 instructions.
1132
1133 @cindex @samp{E} in constraint
1134 @item @samp{E}
1135 An immediate floating operand (expression code @code{const_double}) is
1136 allowed, but only if the target floating point format is the same as
1137 that of the host machine (on which the compiler is running).
1138
1139 @cindex @samp{F} in constraint
1140 @item @samp{F}
1141 An immediate floating operand (expression code @code{const_double} or
1142 @code{const_vector}) is allowed.
1143
1144 @cindex @samp{G} in constraint
1145 @cindex @samp{H} in constraint
1146 @item @samp{G}, @samp{H}
1147 @samp{G} and @samp{H} may be defined in a machine-dependent fashion to
1148 permit immediate floating operands in particular ranges of values.
1149
1150 @cindex @samp{s} in constraint
1151 @item @samp{s}
1152 An immediate integer operand whose value is not an explicit integer is
1153 allowed.
1154
1155 This might appear strange; if an insn allows a constant operand with a
1156 value not known at compile time, it certainly must allow any known
1157 value.  So why use @samp{s} instead of @samp{i}?  Sometimes it allows
1158 better code to be generated.
1159
1160 For example, on the 68000 in a fullword instruction it is possible to
1161 use an immediate operand; but if the immediate value is between @minus{}128
1162 and 127, better code results from loading the value into a register and
1163 using the register.  This is because the load into the register can be
1164 done with a @samp{moveq} instruction.  We arrange for this to happen
1165 by defining the letter @samp{K} to mean ``any integer outside the
1166 range @minus{}128 to 127'', and then specifying @samp{Ks} in the operand
1167 constraints.
1168
1169 @cindex @samp{g} in constraint
1170 @item @samp{g}
1171 Any register, memory or immediate integer operand is allowed, except for
1172 registers that are not general registers.
1173
1174 @cindex @samp{X} in constraint
1175 @item @samp{X}
1176 @ifset INTERNALS
1177 Any operand whatsoever is allowed, even if it does not satisfy
1178 @code{general_operand}.  This is normally used in the constraint of
1179 a @code{match_scratch} when certain alternatives will not actually
1180 require a scratch register.
1181 @end ifset
1182 @ifclear INTERNALS
1183 Any operand whatsoever is allowed.
1184 @end ifclear
1185
1186 @cindex @samp{0} in constraint
1187 @cindex digits in constraint
1188 @item @samp{0}, @samp{1}, @samp{2}, @dots{} @samp{9}
1189 An operand that matches the specified operand number is allowed.  If a
1190 digit is used together with letters within the same alternative, the
1191 digit should come last.
1192
1193 This number is allowed to be more than a single digit.  If multiple
1194 digits are encountered consecutively, they are interpreted as a single
1195 decimal integer.  There is scant chance for ambiguity, since to-date
1196 it has never been desirable that @samp{10} be interpreted as matching
1197 either operand 1 @emph{or} operand 0.  Should this be desired, one
1198 can use multiple alternatives instead.
1199
1200 @cindex matching constraint
1201 @cindex constraint, matching
1202 This is called a @dfn{matching constraint} and what it really means is
1203 that the assembler has only a single operand that fills two roles
1204 @ifset INTERNALS
1205 considered separate in the RTL insn.  For example, an add insn has two
1206 input operands and one output operand in the RTL, but on most CISC
1207 @end ifset
1208 @ifclear INTERNALS
1209 which @code{asm} distinguishes.  For example, an add instruction uses
1210 two input operands and an output operand, but on most CISC
1211 @end ifclear
1212 machines an add instruction really has only two operands, one of them an
1213 input-output operand:
1214
1215 @smallexample
1216 addl #35,r12
1217 @end smallexample
1218
1219 Matching constraints are used in these circumstances.
1220 More precisely, the two operands that match must include one input-only
1221 operand and one output-only operand.  Moreover, the digit must be a
1222 smaller number than the number of the operand that uses it in the
1223 constraint.
1224
1225 @ifset INTERNALS
1226 For operands to match in a particular case usually means that they
1227 are identical-looking RTL expressions.  But in a few special cases
1228 specific kinds of dissimilarity are allowed.  For example, @code{*x}
1229 as an input operand will match @code{*x++} as an output operand.
1230 For proper results in such cases, the output template should always
1231 use the output-operand's number when printing the operand.
1232 @end ifset
1233
1234 @cindex load address instruction
1235 @cindex push address instruction
1236 @cindex address constraints
1237 @cindex @samp{p} in constraint
1238 @item @samp{p}
1239 An operand that is a valid memory address is allowed.  This is
1240 for ``load address'' and ``push address'' instructions.
1241
1242 @findex address_operand
1243 @samp{p} in the constraint must be accompanied by @code{address_operand}
1244 as the predicate in the @code{match_operand}.  This predicate interprets
1245 the mode specified in the @code{match_operand} as the mode of the memory
1246 reference for which the address would be valid.
1247
1248 @cindex other register constraints
1249 @cindex extensible constraints
1250 @item @var{other-letters}
1251 Other letters can be defined in machine-dependent fashion to stand for
1252 particular classes of registers or other arbitrary operand types.
1253 @samp{d}, @samp{a} and @samp{f} are defined on the 68000/68020 to stand
1254 for data, address and floating point registers.
1255
1256 @ifset INTERNALS
1257 The machine description macro @code{REG_CLASS_FROM_LETTER} has first
1258 cut at the otherwise unused letters.  If it evaluates to @code{NO_REGS},
1259 then @code{EXTRA_CONSTRAINT} is evaluated.
1260
1261 A typical use for @code{EXTRA_CONSTRAINT} would be to distinguish certain
1262 types of memory references that affect other insn operands.
1263 @end ifset
1264 @end table
1265
1266 @ifset INTERNALS
1267 In order to have valid assembler code, each operand must satisfy
1268 its constraint.  But a failure to do so does not prevent the pattern
1269 from applying to an insn.  Instead, it directs the compiler to modify
1270 the code so that the constraint will be satisfied.  Usually this is
1271 done by copying an operand into a register.
1272
1273 Contrast, therefore, the two instruction patterns that follow:
1274
1275 @smallexample
1276 (define_insn ""
1277   [(set (match_operand:SI 0 "general_operand" "=r")
1278         (plus:SI (match_dup 0)
1279                  (match_operand:SI 1 "general_operand" "r")))]
1280   ""
1281   "@dots{}")
1282 @end smallexample
1283
1284 @noindent
1285 which has two operands, one of which must appear in two places, and
1286
1287 @smallexample
1288 (define_insn ""
1289   [(set (match_operand:SI 0 "general_operand" "=r")
1290         (plus:SI (match_operand:SI 1 "general_operand" "0")
1291                  (match_operand:SI 2 "general_operand" "r")))]
1292   ""
1293   "@dots{}")
1294 @end smallexample
1295
1296 @noindent
1297 which has three operands, two of which are required by a constraint to be
1298 identical.  If we are considering an insn of the form
1299
1300 @smallexample
1301 (insn @var{n} @var{prev} @var{next}
1302   (set (reg:SI 3)
1303        (plus:SI (reg:SI 6) (reg:SI 109)))
1304   @dots{})
1305 @end smallexample
1306
1307 @noindent
1308 the first pattern would not apply at all, because this insn does not
1309 contain two identical subexpressions in the right place.  The pattern would
1310 say, ``That does not look like an add instruction; try other patterns''.
1311 The second pattern would say, ``Yes, that's an add instruction, but there
1312 is something wrong with it''.  It would direct the reload pass of the
1313 compiler to generate additional insns to make the constraint true.  The
1314 results might look like this:
1315
1316 @smallexample
1317 (insn @var{n2} @var{prev} @var{n}
1318   (set (reg:SI 3) (reg:SI 6))
1319   @dots{})
1320
1321 (insn @var{n} @var{n2} @var{next}
1322   (set (reg:SI 3)
1323        (plus:SI (reg:SI 3) (reg:SI 109)))
1324   @dots{})
1325 @end smallexample
1326
1327 It is up to you to make sure that each operand, in each pattern, has
1328 constraints that can handle any RTL expression that could be present for
1329 that operand.  (When multiple alternatives are in use, each pattern must,
1330 for each possible combination of operand expressions, have at least one
1331 alternative which can handle that combination of operands.)  The
1332 constraints don't need to @emph{allow} any possible operand---when this is
1333 the case, they do not constrain---but they must at least point the way to
1334 reloading any possible operand so that it will fit.
1335
1336 @itemize @bullet
1337 @item
1338 If the constraint accepts whatever operands the predicate permits,
1339 there is no problem: reloading is never necessary for this operand.
1340
1341 For example, an operand whose constraints permit everything except
1342 registers is safe provided its predicate rejects registers.
1343
1344 An operand whose predicate accepts only constant values is safe
1345 provided its constraints include the letter @samp{i}.  If any possible
1346 constant value is accepted, then nothing less than @samp{i} will do;
1347 if the predicate is more selective, then the constraints may also be
1348 more selective.
1349
1350 @item
1351 Any operand expression can be reloaded by copying it into a register.
1352 So if an operand's constraints allow some kind of register, it is
1353 certain to be safe.  It need not permit all classes of registers; the
1354 compiler knows how to copy a register into another register of the
1355 proper class in order to make an instruction valid.
1356
1357 @cindex nonoffsettable memory reference
1358 @cindex memory reference, nonoffsettable
1359 @item
1360 A nonoffsettable memory reference can be reloaded by copying the
1361 address into a register.  So if the constraint uses the letter
1362 @samp{o}, all memory references are taken care of.
1363
1364 @item
1365 A constant operand can be reloaded by allocating space in memory to
1366 hold it as preinitialized data.  Then the memory reference can be used
1367 in place of the constant.  So if the constraint uses the letters
1368 @samp{o} or @samp{m}, constant operands are not a problem.
1369
1370 @item
1371 If the constraint permits a constant and a pseudo register used in an insn
1372 was not allocated to a hard register and is equivalent to a constant,
1373 the register will be replaced with the constant.  If the predicate does
1374 not permit a constant and the insn is re-recognized for some reason, the
1375 compiler will crash.  Thus the predicate must always recognize any
1376 objects allowed by the constraint.
1377 @end itemize
1378
1379 If the operand's predicate can recognize registers, but the constraint does
1380 not permit them, it can make the compiler crash.  When this operand happens
1381 to be a register, the reload pass will be stymied, because it does not know
1382 how to copy a register temporarily into memory.
1383
1384 If the predicate accepts a unary operator, the constraint applies to the
1385 operand.  For example, the MIPS processor at ISA level 3 supports an
1386 instruction which adds two registers in @code{SImode} to produce a
1387 @code{DImode} result, but only if the registers are correctly sign
1388 extended.  This predicate for the input operands accepts a
1389 @code{sign_extend} of an @code{SImode} register.  Write the constraint
1390 to indicate the type of register that is required for the operand of the
1391 @code{sign_extend}.
1392 @end ifset
1393
1394 @node Multi-Alternative
1395 @subsection Multiple Alternative Constraints
1396 @cindex multiple alternative constraints
1397
1398 Sometimes a single instruction has multiple alternative sets of possible
1399 operands.  For example, on the 68000, a logical-or instruction can combine
1400 register or an immediate value into memory, or it can combine any kind of
1401 operand into a register; but it cannot combine one memory location into
1402 another.
1403
1404 These constraints are represented as multiple alternatives.  An alternative
1405 can be described by a series of letters for each operand.  The overall
1406 constraint for an operand is made from the letters for this operand
1407 from the first alternative, a comma, the letters for this operand from
1408 the second alternative, a comma, and so on until the last alternative.
1409 @ifset INTERNALS
1410 Here is how it is done for fullword logical-or on the 68000:
1411
1412 @smallexample
1413 (define_insn "iorsi3"
1414   [(set (match_operand:SI 0 "general_operand" "=m,d")
1415         (ior:SI (match_operand:SI 1 "general_operand" "%0,0")
1416                 (match_operand:SI 2 "general_operand" "dKs,dmKs")))]
1417   @dots{})
1418 @end smallexample
1419
1420 The first alternative has @samp{m} (memory) for operand 0, @samp{0} for
1421 operand 1 (meaning it must match operand 0), and @samp{dKs} for operand
1422 2.  The second alternative has @samp{d} (data register) for operand 0,
1423 @samp{0} for operand 1, and @samp{dmKs} for operand 2.  The @samp{=} and
1424 @samp{%} in the constraints apply to all the alternatives; their
1425 meaning is explained in the next section (@pxref{Class Preferences}).
1426 @end ifset
1427
1428 @c FIXME Is this ? and ! stuff of use in asm()?  If not, hide unless INTERNAL
1429 If all the operands fit any one alternative, the instruction is valid.
1430 Otherwise, for each alternative, the compiler counts how many instructions
1431 must be added to copy the operands so that that alternative applies.
1432 The alternative requiring the least copying is chosen.  If two alternatives
1433 need the same amount of copying, the one that comes first is chosen.
1434 These choices can be altered with the @samp{?} and @samp{!} characters:
1435
1436 @table @code
1437 @cindex @samp{?} in constraint
1438 @cindex question mark
1439 @item ?
1440 Disparage slightly the alternative that the @samp{?} appears in,
1441 as a choice when no alternative applies exactly.  The compiler regards
1442 this alternative as one unit more costly for each @samp{?} that appears
1443 in it.
1444
1445 @cindex @samp{!} in constraint
1446 @cindex exclamation point
1447 @item !
1448 Disparage severely the alternative that the @samp{!} appears in.
1449 This alternative can still be used if it fits without reloading,
1450 but if reloading is needed, some other alternative will be used.
1451 @end table
1452
1453 @ifset INTERNALS
1454 When an insn pattern has multiple alternatives in its constraints, often
1455 the appearance of the assembler code is determined mostly by which
1456 alternative was matched.  When this is so, the C code for writing the
1457 assembler code can use the variable @code{which_alternative}, which is
1458 the ordinal number of the alternative that was actually satisfied (0 for
1459 the first, 1 for the second alternative, etc.).  @xref{Output Statement}.
1460 @end ifset
1461
1462 @ifset INTERNALS
1463 @node Class Preferences
1464 @subsection Register Class Preferences
1465 @cindex class preference constraints
1466 @cindex register class preference constraints
1467
1468 @cindex voting between constraint alternatives
1469 The operand constraints have another function: they enable the compiler
1470 to decide which kind of hardware register a pseudo register is best
1471 allocated to.  The compiler examines the constraints that apply to the
1472 insns that use the pseudo register, looking for the machine-dependent
1473 letters such as @samp{d} and @samp{a} that specify classes of registers.
1474 The pseudo register is put in whichever class gets the most ``votes''.
1475 The constraint letters @samp{g} and @samp{r} also vote: they vote in
1476 favor of a general register.  The machine description says which registers
1477 are considered general.
1478
1479 Of course, on some machines all registers are equivalent, and no register
1480 classes are defined.  Then none of this complexity is relevant.
1481 @end ifset
1482
1483 @node Modifiers
1484 @subsection Constraint Modifier Characters
1485 @cindex modifiers in constraints
1486 @cindex constraint modifier characters
1487
1488 @c prevent bad page break with this line
1489 Here are constraint modifier characters.
1490
1491 @table @samp
1492 @cindex @samp{=} in constraint
1493 @item =
1494 Means that this operand is write-only for this instruction: the previous
1495 value is discarded and replaced by output data.
1496
1497 @cindex @samp{+} in constraint
1498 @item +
1499 Means that this operand is both read and written by the instruction.
1500
1501 When the compiler fixes up the operands to satisfy the constraints,
1502 it needs to know which operands are inputs to the instruction and
1503 which are outputs from it.  @samp{=} identifies an output; @samp{+}
1504 identifies an operand that is both input and output; all other operands
1505 are assumed to be input only.
1506
1507 If you specify @samp{=} or @samp{+} in a constraint, you put it in the
1508 first character of the constraint string.
1509
1510 @cindex @samp{&} in constraint
1511 @cindex earlyclobber operand
1512 @item &
1513 Means (in a particular alternative) that this operand is an
1514 @dfn{earlyclobber} operand, which is modified before the instruction is
1515 finished using the input operands.  Therefore, this operand may not lie
1516 in a register that is used as an input operand or as part of any memory
1517 address.
1518
1519 @samp{&} applies only to the alternative in which it is written.  In
1520 constraints with multiple alternatives, sometimes one alternative
1521 requires @samp{&} while others do not.  See, for example, the
1522 @samp{movdf} insn of the 68000.
1523
1524 An input operand can be tied to an earlyclobber operand if its only
1525 use as an input occurs before the early result is written.  Adding
1526 alternatives of this form often allows GCC to produce better code
1527 when only some of the inputs can be affected by the earlyclobber.
1528 See, for example, the @samp{mulsi3} insn of the ARM@.
1529
1530 @samp{&} does not obviate the need to write @samp{=}.
1531
1532 @cindex @samp{%} in constraint
1533 @item %
1534 Declares the instruction to be commutative for this operand and the
1535 following operand.  This means that the compiler may interchange the
1536 two operands if that is the cheapest way to make all operands fit the
1537 constraints.
1538 @ifset INTERNALS
1539 This is often used in patterns for addition instructions
1540 that really have only two operands: the result must go in one of the
1541 arguments.  Here for example, is how the 68000 halfword-add
1542 instruction is defined:
1543
1544 @smallexample
1545 (define_insn "addhi3"
1546   [(set (match_operand:HI 0 "general_operand" "=m,r")
1547      (plus:HI (match_operand:HI 1 "general_operand" "%0,0")
1548               (match_operand:HI 2 "general_operand" "di,g")))]
1549   @dots{})
1550 @end smallexample
1551 @end ifset
1552 GCC can only handle one commutative pair in an asm; if you use more,
1553 the compiler may fail.  Note that you need not use the modifier if
1554 the two alternatives are strictly identical; this would only waste
1555 time in the reload pass.
1556
1557 @cindex @samp{#} in constraint
1558 @item #
1559 Says that all following characters, up to the next comma, are to be
1560 ignored as a constraint.  They are significant only for choosing
1561 register preferences.
1562
1563 @cindex @samp{*} in constraint
1564 @item *
1565 Says that the following character should be ignored when choosing
1566 register preferences.  @samp{*} has no effect on the meaning of the
1567 constraint as a constraint, and no effect on reloading.
1568
1569 @ifset INTERNALS
1570 Here is an example: the 68000 has an instruction to sign-extend a
1571 halfword in a data register, and can also sign-extend a value by
1572 copying it into an address register.  While either kind of register is
1573 acceptable, the constraints on an address-register destination are
1574 less strict, so it is best if register allocation makes an address
1575 register its goal.  Therefore, @samp{*} is used so that the @samp{d}
1576 constraint letter (for data register) is ignored when computing
1577 register preferences.
1578
1579 @smallexample
1580 (define_insn "extendhisi2"
1581   [(set (match_operand:SI 0 "general_operand" "=*d,a")
1582         (sign_extend:SI
1583          (match_operand:HI 1 "general_operand" "0,g")))]
1584   @dots{})
1585 @end smallexample
1586 @end ifset
1587 @end table
1588
1589 @node Machine Constraints
1590 @subsection Constraints for Particular Machines
1591 @cindex machine specific constraints
1592 @cindex constraints, machine specific
1593
1594 Whenever possible, you should use the general-purpose constraint letters
1595 in @code{asm} arguments, since they will convey meaning more readily to
1596 people reading your code.  Failing that, use the constraint letters
1597 that usually have very similar meanings across architectures.  The most
1598 commonly used constraints are @samp{m} and @samp{r} (for memory and
1599 general-purpose registers respectively; @pxref{Simple Constraints}), and
1600 @samp{I}, usually the letter indicating the most common
1601 immediate-constant format.
1602
1603 For each machine architecture, the
1604 @file{config/@var{machine}/@var{machine}.h} file defines additional
1605 constraints.  These constraints are used by the compiler itself for
1606 instruction generation, as well as for @code{asm} statements; therefore,
1607 some of the constraints are not particularly interesting for @code{asm}.
1608 The constraints are defined through these macros:
1609
1610 @table @code
1611 @item REG_CLASS_FROM_LETTER
1612 Register class constraints (usually lowercase).
1613
1614 @item CONST_OK_FOR_LETTER_P
1615 Immediate constant constraints, for non-floating point constants of
1616 word size or smaller precision (usually uppercase).
1617
1618 @item CONST_DOUBLE_OK_FOR_LETTER_P
1619 Immediate constant constraints, for all floating point constants and for
1620 constants of greater than word size precision (usually uppercase).
1621
1622 @item EXTRA_CONSTRAINT
1623 Special cases of registers or memory.  This macro is not required, and
1624 is only defined for some machines.
1625 @end table
1626
1627 Inspecting these macro definitions in the compiler source for your
1628 machine is the best way to be certain you have the right constraints.
1629 However, here is a summary of the machine-dependent constraints
1630 available on some particular machines.
1631
1632 @table @emph
1633 @item ARM family---@file{arm.h}
1634 @table @code
1635 @item f
1636 Floating-point register
1637
1638 @item w
1639 VFP floating-point register
1640
1641 @item F
1642 One of the floating-point constants 0.0, 0.5, 1.0, 2.0, 3.0, 4.0, 5.0
1643 or 10.0
1644
1645 @item G
1646 Floating-point constant that would satisfy the constraint @samp{F} if it
1647 were negated
1648
1649 @item I
1650 Integer that is valid as an immediate operand in a data processing
1651 instruction.  That is, an integer in the range 0 to 255 rotated by a
1652 multiple of 2
1653
1654 @item J
1655 Integer in the range @minus{}4095 to 4095
1656
1657 @item K
1658 Integer that satisfies constraint @samp{I} when inverted (ones complement)
1659
1660 @item L
1661 Integer that satisfies constraint @samp{I} when negated (twos complement)
1662
1663 @item M
1664 Integer in the range 0 to 32
1665
1666 @item Q
1667 A memory reference where the exact address is in a single register
1668 (`@samp{m}' is preferable for @code{asm} statements)
1669
1670 @item R
1671 An item in the constant pool
1672
1673 @item S
1674 A symbol in the text segment of the current file
1675 @end table
1676
1677 @item Uv
1678 A memory reference suitable for VFP load/store insns (reg+constant offset)
1679
1680 @item Uy
1681 A memory reference suitable for iWMMXt load/store instructions.
1682
1683 @item Uq
1684 A memory reference suitable for for the ARMv4 ldrsb instruction.
1685
1686 @item AVR family---@file{avr.h}
1687 @table @code
1688 @item l
1689 Registers from r0 to r15
1690
1691 @item a
1692 Registers from r16 to r23
1693
1694 @item d
1695 Registers from r16 to r31
1696
1697 @item w
1698 Registers from r24 to r31.  These registers can be used in @samp{adiw} command
1699
1700 @item e
1701 Pointer register (r26--r31)
1702
1703 @item b
1704 Base pointer register (r28--r31)
1705
1706 @item q
1707 Stack pointer register (SPH:SPL)
1708
1709 @item t
1710 Temporary register r0
1711
1712 @item x
1713 Register pair X (r27:r26)
1714
1715 @item y
1716 Register pair Y (r29:r28)
1717
1718 @item z
1719 Register pair Z (r31:r30)
1720
1721 @item I
1722 Constant greater than @minus{}1, less than 64
1723
1724 @item J
1725 Constant greater than @minus{}64, less than 1
1726
1727 @item K
1728 Constant integer 2
1729
1730 @item L
1731 Constant integer 0
1732
1733 @item M
1734 Constant that fits in 8 bits
1735
1736 @item N
1737 Constant integer @minus{}1
1738
1739 @item O
1740 Constant integer 8, 16, or 24
1741
1742 @item P
1743 Constant integer 1
1744
1745 @item G
1746 A floating point constant 0.0
1747 @end table
1748
1749 @item PowerPC and IBM RS6000---@file{rs6000.h}
1750 @table @code
1751 @item b
1752 Address base register
1753
1754 @item f
1755 Floating point register
1756
1757 @item v
1758 Vector register
1759
1760 @item h
1761 @samp{MQ}, @samp{CTR}, or @samp{LINK} register
1762
1763 @item q
1764 @samp{MQ} register
1765
1766 @item c
1767 @samp{CTR} register
1768
1769 @item l
1770 @samp{LINK} register
1771
1772 @item x
1773 @samp{CR} register (condition register) number 0
1774
1775 @item y
1776 @samp{CR} register (condition register)
1777
1778 @item z
1779 @samp{FPMEM} stack memory for FPR-GPR transfers
1780
1781 @item I
1782 Signed 16-bit constant
1783
1784 @item J
1785 Unsigned 16-bit constant shifted left 16 bits (use @samp{L} instead for
1786 @code{SImode} constants)
1787
1788 @item K
1789 Unsigned 16-bit constant
1790
1791 @item L
1792 Signed 16-bit constant shifted left 16 bits
1793
1794 @item M
1795 Constant larger than 31
1796
1797 @item N
1798 Exact power of 2
1799
1800 @item O
1801 Zero
1802
1803 @item P
1804 Constant whose negation is a signed 16-bit constant
1805
1806 @item G
1807 Floating point constant that can be loaded into a register with one
1808 instruction per word
1809
1810 @item Q
1811 Memory operand that is an offset from a register (@samp{m} is preferable
1812 for @code{asm} statements)
1813
1814 @item R
1815 AIX TOC entry
1816
1817 @item S
1818 Constant suitable as a 64-bit mask operand
1819
1820 @item T
1821 Constant suitable as a 32-bit mask operand
1822
1823 @item U
1824 System V Release 4 small data area reference
1825 @end table
1826
1827 @item Intel 386---@file{i386.h}
1828 @table @code
1829 @item q
1830 @samp{a}, @code{b}, @code{c}, or @code{d} register for the i386.
1831 For x86-64 it is equivalent to @samp{r} class (for 8-bit instructions that
1832 do not use upper halves).
1833
1834 @item Q
1835 @samp{a}, @code{b}, @code{c}, or @code{d} register (for 8-bit instructions,
1836 that do use upper halves).
1837
1838 @item R
1839 Legacy register---equivalent to @code{r} class in i386 mode.
1840 (for non-8-bit registers used together with 8-bit upper halves in a single
1841 instruction)
1842
1843 @item A
1844 Specifies the @samp{a} or @samp{d} registers.  This is primarily useful
1845 for 64-bit integer values (when in 32-bit mode) intended to be returned
1846 with the @samp{d} register holding the most significant bits and the
1847 @samp{a} register holding the least significant bits.
1848
1849 @item f
1850 Floating point register
1851
1852 @item t
1853 First (top of stack) floating point register
1854
1855 @item u
1856 Second floating point register
1857
1858 @item a
1859 @samp{a} register
1860
1861 @item b
1862 @samp{b} register
1863
1864 @item c
1865 @samp{c} register
1866
1867 @item C
1868 Specifies constant that can be easily constructed in SSE register without
1869 loading it from memory.
1870
1871 @item d
1872 @samp{d} register
1873
1874 @item D
1875 @samp{di} register
1876
1877 @item S
1878 @samp{si} register
1879
1880 @item x
1881 @samp{xmm} SSE register
1882
1883 @item y
1884 MMX register
1885
1886 @item I
1887 Constant in range 0 to 31 (for 32-bit shifts)
1888
1889 @item J
1890 Constant in range 0 to 63 (for 64-bit shifts)
1891
1892 @item K
1893 @samp{0xff}
1894
1895 @item L
1896 @samp{0xffff}
1897
1898 @item M
1899 0, 1, 2, or 3 (shifts for @code{lea} instruction)
1900
1901 @item N
1902 Constant in range 0 to 255 (for @code{out} instruction)
1903
1904 @item Z
1905 Constant in range 0 to @code{0xffffffff} or symbolic reference known to fit specified range.
1906 (for using immediates in zero extending 32-bit to 64-bit x86-64 instructions)
1907
1908 @item e
1909 Constant in range @minus{}2147483648 to 2147483647 or symbolic reference known to fit specified range.
1910 (for using immediates in 64-bit x86-64 instructions)
1911
1912 @item G
1913 Standard 80387 floating point constant
1914 @end table
1915
1916 @item Intel IA-64---@file{ia64.h}
1917 @table @code
1918 @item a
1919 General register @code{r0} to @code{r3} for @code{addl} instruction
1920
1921 @item b
1922 Branch register
1923
1924 @item c
1925 Predicate register (@samp{c} as in ``conditional'')
1926
1927 @item d
1928 Application register residing in M-unit
1929
1930 @item e
1931 Application register residing in I-unit
1932
1933 @item f
1934 Floating-point register
1935
1936 @item m
1937 Memory operand.
1938 Remember that @samp{m} allows postincrement and postdecrement which
1939 require printing with @samp{%Pn} on IA-64.
1940 Use @samp{S} to disallow postincrement and postdecrement.
1941
1942 @item G
1943 Floating-point constant 0.0 or 1.0
1944
1945 @item I
1946 14-bit signed integer constant
1947
1948 @item J
1949 22-bit signed integer constant
1950
1951 @item K
1952 8-bit signed integer constant for logical instructions
1953
1954 @item L
1955 8-bit adjusted signed integer constant for compare pseudo-ops
1956
1957 @item M
1958 6-bit unsigned integer constant for shift counts
1959
1960 @item N
1961 9-bit signed integer constant for load and store postincrements
1962
1963 @item O
1964 The constant zero
1965
1966 @item P
1967 0 or @minus{}1 for @code{dep} instruction
1968
1969 @item Q
1970 Non-volatile memory for floating-point loads and stores
1971
1972 @item R
1973 Integer constant in the range 1 to 4 for @code{shladd} instruction
1974
1975 @item S
1976 Memory operand except postincrement and postdecrement
1977 @end table
1978
1979 @item FRV---@file{frv.h}
1980 @table @code
1981 @item a
1982 Register in the class @code{ACC_REGS} (@code{acc0} to @code{acc7}).
1983
1984 @item b
1985 Register in the class @code{EVEN_ACC_REGS} (@code{acc0} to @code{acc7}).
1986
1987 @item c
1988 Register in the class @code{CC_REGS} (@code{fcc0} to @code{fcc3} and
1989 @code{icc0} to @code{icc3}).
1990
1991 @item d
1992 Register in the class @code{GPR_REGS} (@code{gr0} to @code{gr63}).
1993
1994 @item e
1995 Register in the class @code{EVEN_REGS} (@code{gr0} to @code{gr63}).
1996 Odd registers are excluded not in the class but through the use of a machine
1997 mode larger than 4 bytes.
1998
1999 @item f
2000 Register in the class @code{FPR_REGS} (@code{fr0} to @code{fr63}).
2001
2002 @item h
2003 Register in the class @code{FEVEN_REGS} (@code{fr0} to @code{fr63}).
2004 Odd registers are excluded not in the class but through the use of a machine
2005 mode larger than 4 bytes.
2006
2007 @item l
2008 Register in the class @code{LR_REG} (the @code{lr} register).
2009
2010 @item q
2011 Register in the class @code{QUAD_REGS} (@code{gr2} to @code{gr63}).
2012 Register numbers not divisible by 4 are excluded not in the class but through
2013 the use of a machine mode larger than 8 bytes.
2014
2015 @item t
2016 Register in the class @code{ICC_REGS} (@code{icc0} to @code{icc3}).
2017
2018 @item u
2019 Register in the class @code{FCC_REGS} (@code{fcc0} to @code{fcc3}).
2020
2021 @item v
2022 Register in the class @code{ICR_REGS} (@code{cc4} to @code{cc7}).
2023
2024 @item w
2025 Register in the class @code{FCR_REGS} (@code{cc0} to @code{cc3}).
2026
2027 @item x
2028 Register in the class @code{QUAD_FPR_REGS} (@code{fr0} to @code{fr63}).
2029 Register numbers not divisible by 4 are excluded not in the class but through
2030 the use of a machine mode larger than 8 bytes.
2031
2032 @item z
2033 Register in the class @code{SPR_REGS} (@code{lcr} and @code{lr}).
2034
2035 @item A
2036 Register in the class @code{QUAD_ACC_REGS} (@code{acc0} to @code{acc7}).
2037
2038 @item B
2039 Register in the class @code{ACCG_REGS} (@code{accg0} to @code{accg7}).
2040
2041 @item C
2042 Register in the class @code{CR_REGS} (@code{cc0} to @code{cc7}).
2043
2044 @item G
2045 Floating point constant zero
2046
2047 @item I
2048 6-bit signed integer constant
2049
2050 @item J
2051 10-bit signed integer constant
2052
2053 @item L
2054 16-bit signed integer constant
2055
2056 @item M
2057 16-bit unsigned integer constant
2058
2059 @item N
2060 12-bit signed integer constant that is negative---i.e.@: in the
2061 range of @minus{}2048 to @minus{}1
2062
2063 @item O
2064 Constant zero
2065
2066 @item P
2067 12-bit signed integer constant that is greater than zero---i.e.@: in the
2068 range of 1 to 2047.
2069
2070 @end table
2071
2072 @item IP2K---@file{ip2k.h}
2073 @table @code
2074 @item a
2075 @samp{DP} or @samp{IP} registers (general address)
2076
2077 @item f
2078 @samp{IP} register
2079
2080 @item j
2081 @samp{IPL} register
2082
2083 @item k
2084 @samp{IPH} register
2085
2086 @item b
2087 @samp{DP} register
2088
2089 @item y
2090 @samp{DPH} register
2091
2092 @item z
2093 @samp{DPL} register
2094
2095 @item q
2096 @samp{SP} register
2097
2098 @item c
2099 @samp{DP} or @samp{SP} registers (offsettable address)
2100
2101 @item d
2102 Non-pointer registers (not @samp{SP}, @samp{DP}, @samp{IP})
2103
2104 @item u
2105 Non-SP registers (everything except @samp{SP})
2106
2107 @item R
2108 Indirect through @samp{IP}---Avoid this except for @code{QImode}, since we
2109 can't access extra bytes
2110
2111 @item S
2112 Indirect through @samp{SP} or @samp{DP} with short displacement (0..127)
2113
2114 @item T
2115 Data-section immediate value
2116
2117 @item I
2118 Integers from @minus{}255 to @minus{}1
2119
2120 @item J
2121 Integers from 0 to 7---valid bit number in a register
2122
2123 @item K
2124 Integers from 0 to 127---valid displacement for addressing mode
2125
2126 @item L
2127 Integers from 1 to 127
2128
2129 @item M
2130 Integer @minus{}1
2131
2132 @item N
2133 Integer 1
2134
2135 @item O
2136 Zero
2137
2138 @item P
2139 Integers from 0 to 255
2140 @end table
2141
2142 @item MIPS---@file{mips.h}
2143 @table @code
2144 @item d
2145 General-purpose integer register
2146
2147 @item f
2148 Floating-point register (if available)
2149
2150 @item h
2151 @samp{Hi} register
2152
2153 @item l
2154 @samp{Lo} register
2155
2156 @item x
2157 @samp{Hi} or @samp{Lo} register
2158
2159 @item y
2160 General-purpose integer register
2161
2162 @item z
2163 Floating-point status register
2164
2165 @item I
2166 Signed 16-bit constant (for arithmetic instructions)
2167
2168 @item J
2169 Zero
2170
2171 @item K
2172 Zero-extended 16-bit constant (for logic instructions)
2173
2174 @item L
2175 Constant with low 16 bits zero (can be loaded with @code{lui})
2176
2177 @item M
2178 32-bit constant which requires two instructions to load (a constant
2179 which is not @samp{I}, @samp{K}, or @samp{L})
2180
2181 @item N
2182 Negative 16-bit constant
2183
2184 @item O
2185 Exact power of two
2186
2187 @item P
2188 Positive 16-bit constant
2189
2190 @item G
2191 Floating point zero
2192
2193 @item Q
2194 Memory reference that can be loaded with more than one instruction
2195 (@samp{m} is preferable for @code{asm} statements)
2196
2197 @item R
2198 Memory reference that can be loaded with one instruction
2199 (@samp{m} is preferable for @code{asm} statements)
2200
2201 @item S
2202 Memory reference in external OSF/rose PIC format
2203 (@samp{m} is preferable for @code{asm} statements)
2204 @end table
2205
2206 @item Motorola 680x0---@file{m68k.h}
2207 @table @code
2208 @item a
2209 Address register
2210
2211 @item d
2212 Data register
2213
2214 @item f
2215 68881 floating-point register, if available
2216
2217 @item I
2218 Integer in the range 1 to 8
2219
2220 @item J
2221 16-bit signed number
2222
2223 @item K
2224 Signed number whose magnitude is greater than 0x80
2225
2226 @item L
2227 Integer in the range @minus{}8 to @minus{}1
2228
2229 @item M
2230 Signed number whose magnitude is greater than 0x100
2231
2232 @item G
2233 Floating point constant that is not a 68881 constant
2234 @end table
2235
2236 @item Motorola 68HC11 & 68HC12 families---@file{m68hc11.h}
2237 @table @code
2238 @item a
2239 Register `a'
2240
2241 @item b
2242 Register `b'
2243
2244 @item d
2245 Register `d'
2246
2247 @item q
2248 An 8-bit register
2249
2250 @item t
2251 Temporary soft register _.tmp
2252
2253 @item u
2254 A soft register _.d1 to _.d31
2255
2256 @item w
2257 Stack pointer register
2258
2259 @item x
2260 Register `x'
2261
2262 @item y
2263 Register `y'
2264
2265 @item z
2266 Pseudo register `z' (replaced by `x' or `y' at the end)
2267
2268 @item A
2269 An address register: x, y or z
2270
2271 @item B
2272 An address register: x or y
2273
2274 @item D
2275 Register pair (x:d) to form a 32-bit value
2276
2277 @item L
2278 Constants in the range @minus{}65536 to 65535
2279
2280 @item M
2281 Constants whose 16-bit low part is zero
2282
2283 @item N
2284 Constant integer 1 or @minus{}1
2285
2286 @item O
2287 Constant integer 16
2288
2289 @item P
2290 Constants in the range @minus{}8 to 2
2291
2292 @end table
2293
2294 @need 1000
2295 @item SPARC---@file{sparc.h}
2296 @table @code
2297 @item f
2298 Floating-point register on the SPARC-V8 architecture and
2299 lower floating-point register on the SPARC-V9 architecture.
2300
2301 @item e
2302 Floating-point register.  It is equivalent to @samp{f} on the
2303 SPARC-V8 architecture and contains both lower and upper
2304 floating-point registers on the SPARC-V9 architecture.
2305
2306 @item c
2307 Floating-point condition code register.
2308
2309 @item d
2310 Lower floating-point register.  It is only valid on the SPARC-V9
2311 architecture when the Visual Instruction Set is available.
2312
2313 @item b
2314 Floating-point register.  It is only valid on the SPARC-V9 architecture
2315 when the Visual Instruction Set is available.
2316
2317 @item h
2318 64-bit global or out register for the SPARC-V8+ architecture.
2319
2320 @item I
2321 Signed 13-bit constant
2322
2323 @item J
2324 Zero
2325
2326 @item K
2327 32-bit constant with the low 12 bits clear (a constant that can be
2328 loaded with the @code{sethi} instruction)
2329
2330 @item L
2331 A constant in the range supported by @code{movcc} instructions
2332
2333 @item M
2334 A constant in the range supported by @code{movrcc} instructions
2335
2336 @item N
2337 Same as @samp{K}, except that it verifies that bits that are not in the
2338 lower 32-bit range are all zero.  Must be used instead of @samp{K} for
2339 modes wider than @code{SImode}
2340
2341 @item O
2342 The constant 4096
2343
2344 @item G
2345 Floating-point zero
2346
2347 @item H
2348 Signed 13-bit constant, sign-extended to 32 or 64 bits
2349
2350 @item Q
2351 Floating-point constant whose integral representation can
2352 be moved into an integer register using a single sethi
2353 instruction
2354
2355 @item R
2356 Floating-point constant whose integral representation can
2357 be moved into an integer register using a single mov
2358 instruction
2359
2360 @item S
2361 Floating-point constant whose integral representation can
2362 be moved into an integer register using a high/lo_sum
2363 instruction sequence
2364
2365 @item T
2366 Memory address aligned to an 8-byte boundary
2367
2368 @item U
2369 Even register
2370
2371 @item W
2372 Memory address for @samp{e} constraint registers
2373
2374 @item Y
2375 Vector zero
2376
2377 @end table
2378
2379 @item TMS320C3x/C4x---@file{c4x.h}
2380 @table @code
2381 @item a
2382 Auxiliary (address) register (ar0-ar7)
2383
2384 @item b
2385 Stack pointer register (sp)
2386
2387 @item c
2388 Standard (32-bit) precision integer register
2389
2390 @item f
2391 Extended (40-bit) precision register (r0-r11)
2392
2393 @item k
2394 Block count register (bk)
2395
2396 @item q
2397 Extended (40-bit) precision low register (r0-r7)
2398
2399 @item t
2400 Extended (40-bit) precision register (r0-r1)
2401
2402 @item u
2403 Extended (40-bit) precision register (r2-r3)
2404
2405 @item v
2406 Repeat count register (rc)
2407
2408 @item x
2409 Index register (ir0-ir1)
2410
2411 @item y
2412 Status (condition code) register (st)
2413
2414 @item z
2415 Data page register (dp)
2416
2417 @item G
2418 Floating-point zero
2419
2420 @item H
2421 Immediate 16-bit floating-point constant
2422
2423 @item I
2424 Signed 16-bit constant
2425
2426 @item J
2427 Signed 8-bit constant
2428
2429 @item K
2430 Signed 5-bit constant
2431
2432 @item L
2433 Unsigned 16-bit constant
2434
2435 @item M
2436 Unsigned 8-bit constant
2437
2438 @item N
2439 Ones complement of unsigned 16-bit constant
2440
2441 @item O
2442 High 16-bit constant (32-bit constant with 16 LSBs zero)
2443
2444 @item Q
2445 Indirect memory reference with signed 8-bit or index register displacement
2446
2447 @item R
2448 Indirect memory reference with unsigned 5-bit displacement
2449
2450 @item S
2451 Indirect memory reference with 1 bit or index register displacement
2452
2453 @item T
2454 Direct memory reference
2455
2456 @item U
2457 Symbolic address
2458
2459 @end table
2460
2461 @item S/390 and zSeries---@file{s390.h}
2462 @table @code
2463 @item a
2464 Address register (general purpose register except r0)
2465
2466 @item c
2467 Condition code register
2468
2469 @item d
2470 Data register (arbitrary general purpose register)
2471
2472 @item f
2473 Floating-point register
2474
2475 @item I
2476 Unsigned 8-bit constant (0--255)
2477
2478 @item J
2479 Unsigned 12-bit constant (0--4095)
2480
2481 @item K
2482 Signed 16-bit constant (@minus{}32768--32767)
2483
2484 @item L
2485 Value appropriate as displacement.
2486 @table @code
2487        @item (0..4095)
2488        for short displacement
2489        @item (-524288..524287)
2490        for long displacement
2491 @end table
2492
2493 @item M
2494 Constant integer with a value of 0x7fffffff.
2495
2496 @item N
2497 Multiple letter constraint followed by 4 parameter letters.
2498 @table @code
2499          @item 0..9:
2500          number of the part counting from most to least significant
2501          @item H,Q:
2502          mode of the part
2503          @item D,S,H:
2504          mode of the containing operand
2505          @item 0,F:
2506          value of the other parts (F---all bits set)
2507 @end table
2508 The constraint matches if the specified part of a constant
2509 has a value different from it's other parts.
2510
2511 @item Q
2512 Memory reference without index register and with short displacement.
2513
2514 @item R
2515 Memory reference with index register and short displacement.
2516
2517 @item S
2518 Memory reference without index register but with long displacement.
2519
2520 @item T
2521 Memory reference with index register and long displacement.
2522
2523 @item U
2524 Pointer with short displacement.
2525
2526 @item W
2527 Pointer with long displacement.
2528
2529 @item Y
2530 Shift count operand.
2531
2532 @end table
2533
2534 @item Xstormy16---@file{stormy16.h}
2535 @table @code
2536 @item a
2537 Register r0.
2538
2539 @item b
2540 Register r1.
2541
2542 @item c
2543 Register r2.
2544
2545 @item d
2546 Register r8.
2547
2548 @item e
2549 Registers r0 through r7.
2550
2551 @item t
2552 Registers r0 and r1.
2553
2554 @item y
2555 The carry register.
2556
2557 @item z
2558 Registers r8 and r9.
2559
2560 @item I
2561 A constant between 0 and 3 inclusive.
2562
2563 @item J
2564 A constant that has exactly one bit set.
2565
2566 @item K
2567 A constant that has exactly one bit clear.
2568
2569 @item L
2570 A constant between 0 and 255 inclusive.
2571
2572 @item M
2573 A constant between @minus{}255 and 0 inclusive.
2574
2575 @item N
2576 A constant between @minus{}3 and 0 inclusive.
2577
2578 @item O
2579 A constant between 1 and 4 inclusive.
2580
2581 @item P
2582 A constant between @minus{}4 and @minus{}1 inclusive.
2583
2584 @item Q
2585 A memory reference that is a stack push.
2586
2587 @item R
2588 A memory reference that is a stack pop.
2589
2590 @item S
2591 A memory reference that refers to a constant address of known value.
2592
2593 @item T
2594 The register indicated by Rx (not implemented yet).
2595
2596 @item U
2597 A constant that is not between 2 and 15 inclusive.
2598
2599 @item Z
2600 The constant 0.
2601
2602 @end table
2603
2604 @item Xtensa---@file{xtensa.h}
2605 @table @code
2606 @item a
2607 General-purpose 32-bit register
2608
2609 @item b
2610 One-bit boolean register
2611
2612 @item A
2613 MAC16 40-bit accumulator register
2614
2615 @item I
2616 Signed 12-bit integer constant, for use in MOVI instructions
2617
2618 @item J
2619 Signed 8-bit integer constant, for use in ADDI instructions
2620
2621 @item K
2622 Integer constant valid for BccI instructions
2623
2624 @item L
2625 Unsigned constant valid for BccUI instructions
2626
2627 @end table
2628
2629 @end table
2630
2631 @ifset INTERNALS
2632 @node Standard Names
2633 @section Standard Pattern Names For Generation
2634 @cindex standard pattern names
2635 @cindex pattern names
2636 @cindex names, pattern
2637
2638 Here is a table of the instruction names that are meaningful in the RTL
2639 generation pass of the compiler.  Giving one of these names to an
2640 instruction pattern tells the RTL generation pass that it can use the
2641 pattern to accomplish a certain task.
2642
2643 @table @asis
2644 @cindex @code{mov@var{m}} instruction pattern
2645 @item @samp{mov@var{m}}
2646 Here @var{m} stands for a two-letter machine mode name, in lowercase.
2647 This instruction pattern moves data with that machine mode from operand
2648 1 to operand 0.  For example, @samp{movsi} moves full-word data.
2649
2650 If operand 0 is a @code{subreg} with mode @var{m} of a register whose
2651 own mode is wider than @var{m}, the effect of this instruction is
2652 to store the specified value in the part of the register that corresponds
2653 to mode @var{m}.  Bits outside of @var{m}, but which are within the
2654 same target word as the @code{subreg} are undefined.  Bits which are
2655 outside the target word are left unchanged.
2656
2657 This class of patterns is special in several ways.  First of all, each
2658 of these names up to and including full word size @emph{must} be defined,
2659 because there is no other way to copy a datum from one place to another.
2660 If there are patterns accepting operands in larger modes,
2661 @samp{mov@var{m}} must be defined for integer modes of those sizes.
2662
2663 Second, these patterns are not used solely in the RTL generation pass.
2664 Even the reload pass can generate move insns to copy values from stack
2665 slots into temporary registers.  When it does so, one of the operands is
2666 a hard register and the other is an operand that can need to be reloaded
2667 into a register.
2668
2669 @findex force_reg
2670 Therefore, when given such a pair of operands, the pattern must generate
2671 RTL which needs no reloading and needs no temporary registers---no
2672 registers other than the operands.  For example, if you support the
2673 pattern with a @code{define_expand}, then in such a case the
2674 @code{define_expand} mustn't call @code{force_reg} or any other such
2675 function which might generate new pseudo registers.
2676
2677 This requirement exists even for subword modes on a RISC machine where
2678 fetching those modes from memory normally requires several insns and
2679 some temporary registers.
2680
2681 @findex change_address
2682 During reload a memory reference with an invalid address may be passed
2683 as an operand.  Such an address will be replaced with a valid address
2684 later in the reload pass.  In this case, nothing may be done with the
2685 address except to use it as it stands.  If it is copied, it will not be
2686 replaced with a valid address.  No attempt should be made to make such
2687 an address into a valid address and no routine (such as
2688 @code{change_address}) that will do so may be called.  Note that
2689 @code{general_operand} will fail when applied to such an address.
2690
2691 @findex reload_in_progress
2692 The global variable @code{reload_in_progress} (which must be explicitly
2693 declared if required) can be used to determine whether such special
2694 handling is required.
2695
2696 The variety of operands that have reloads depends on the rest of the
2697 machine description, but typically on a RISC machine these can only be
2698 pseudo registers that did not get hard registers, while on other
2699 machines explicit memory references will get optional reloads.
2700
2701 If a scratch register is required to move an object to or from memory,
2702 it can be allocated using @code{gen_reg_rtx} prior to life analysis.
2703
2704 If there are cases which need scratch registers during or after reload,
2705 you must define @code{SECONDARY_INPUT_RELOAD_CLASS} and/or
2706 @code{SECONDARY_OUTPUT_RELOAD_CLASS} to detect them, and provide
2707 patterns @samp{reload_in@var{m}} or @samp{reload_out@var{m}} to handle
2708 them.  @xref{Register Classes}.
2709
2710 @findex no_new_pseudos
2711 The global variable @code{no_new_pseudos} can be used to determine if it
2712 is unsafe to create new pseudo registers.  If this variable is nonzero, then
2713 it is unsafe to call @code{gen_reg_rtx} to allocate a new pseudo.
2714
2715 The constraints on a @samp{mov@var{m}} must permit moving any hard
2716 register to any other hard register provided that
2717 @code{HARD_REGNO_MODE_OK} permits mode @var{m} in both registers and
2718 @code{REGISTER_MOVE_COST} applied to their classes returns a value of 2.
2719
2720 It is obligatory to support floating point @samp{mov@var{m}}
2721 instructions into and out of any registers that can hold fixed point
2722 values, because unions and structures (which have modes @code{SImode} or
2723 @code{DImode}) can be in those registers and they may have floating
2724 point members.
2725
2726 There may also be a need to support fixed point @samp{mov@var{m}}
2727 instructions in and out of floating point registers.  Unfortunately, I
2728 have forgotten why this was so, and I don't know whether it is still
2729 true.  If @code{HARD_REGNO_MODE_OK} rejects fixed point values in
2730 floating point registers, then the constraints of the fixed point
2731 @samp{mov@var{m}} instructions must be designed to avoid ever trying to
2732 reload into a floating point register.
2733
2734 @cindex @code{reload_in} instruction pattern
2735 @cindex @code{reload_out} instruction pattern
2736 @item @samp{reload_in@var{m}}
2737 @itemx @samp{reload_out@var{m}}
2738 Like @samp{mov@var{m}}, but used when a scratch register is required to
2739 move between operand 0 and operand 1.  Operand 2 describes the scratch
2740 register.  See the discussion of the @code{SECONDARY_RELOAD_CLASS}
2741 macro in @pxref{Register Classes}.
2742
2743 There are special restrictions on the form of the @code{match_operand}s
2744 used in these patterns.  First, only the predicate for the reload
2745 operand is examined, i.e., @code{reload_in} examines operand 1, but not
2746 the predicates for operand 0 or 2.  Second, there may be only one
2747 alternative in the constraints.  Third, only a single register class
2748 letter may be used for the constraint; subsequent constraint letters
2749 are ignored.  As a special exception, an empty constraint string
2750 matches the @code{ALL_REGS} register class.  This may relieve ports
2751 of the burden of defining an @code{ALL_REGS} constraint letter just
2752 for these patterns.
2753
2754 @cindex @code{movstrict@var{m}} instruction pattern
2755 @item @samp{movstrict@var{m}}
2756 Like @samp{mov@var{m}} except that if operand 0 is a @code{subreg}
2757 with mode @var{m} of a register whose natural mode is wider,
2758 the @samp{movstrict@var{m}} instruction is guaranteed not to alter
2759 any of the register except the part which belongs to mode @var{m}.
2760
2761 @cindex @code{load_multiple} instruction pattern
2762 @item @samp{load_multiple}
2763 Load several consecutive memory locations into consecutive registers.
2764 Operand 0 is the first of the consecutive registers, operand 1
2765 is the first memory location, and operand 2 is a constant: the
2766 number of consecutive registers.
2767
2768 Define this only if the target machine really has such an instruction;
2769 do not define this if the most efficient way of loading consecutive
2770 registers from memory is to do them one at a time.
2771
2772 On some machines, there are restrictions as to which consecutive
2773 registers can be stored into memory, such as particular starting or
2774 ending register numbers or only a range of valid counts.  For those
2775 machines, use a @code{define_expand} (@pxref{Expander Definitions})
2776 and make the pattern fail if the restrictions are not met.
2777
2778 Write the generated insn as a @code{parallel} with elements being a
2779 @code{set} of one register from the appropriate memory location (you may
2780 also need @code{use} or @code{clobber} elements).  Use a
2781 @code{match_parallel} (@pxref{RTL Template}) to recognize the insn.  See
2782 @file{rs6000.md} for examples of the use of this insn pattern.
2783
2784 @cindex @samp{store_multiple} instruction pattern
2785 @item @samp{store_multiple}
2786 Similar to @samp{load_multiple}, but store several consecutive registers
2787 into consecutive memory locations.  Operand 0 is the first of the
2788 consecutive memory locations, operand 1 is the first register, and
2789 operand 2 is a constant: the number of consecutive registers.
2790
2791 @cindex @code{vec_set@var{m}} instruction pattern
2792 @item @samp{vec_set@var{m}}
2793 Set given field in the vector value.  Operand 0 is the vector to modify,
2794 operand 1 is new value of field and operand 2 specify the field index.
2795
2796 @cindex @code{vec_extract@var{m}} instruction pattern
2797 @item @samp{vec_extract@var{m}}
2798 Extract given field from the vector value.  Operand 1 is the vector, operand 2
2799 specify field index and operand 0 place to store value into.
2800
2801 @cindex @code{vec_init@var{m}} instruction pattern
2802 @item @samp{vec_init@var{m}}
2803 Initialize the vector to given values.  Operand 0 is the vector to initialize
2804 and operand 1 is parallel containing values for individual fields.
2805
2806 @cindex @code{push@var{m}} instruction pattern
2807 @item @samp{push@var{m}}
2808 Output a push instruction.  Operand 0 is value to push.  Used only when
2809 @code{PUSH_ROUNDING} is defined.  For historical reason, this pattern may be
2810 missing and in such case an @code{mov} expander is used instead, with a
2811 @code{MEM} expression forming the push operation.  The @code{mov} expander
2812 method is deprecated.
2813
2814 @cindex @code{add@var{m}3} instruction pattern
2815 @item @samp{add@var{m}3}
2816 Add operand 2 and operand 1, storing the result in operand 0.  All operands
2817 must have mode @var{m}.  This can be used even on two-address machines, by
2818 means of constraints requiring operands 1 and 0 to be the same location.
2819
2820 @cindex @code{sub@var{m}3} instruction pattern
2821 @cindex @code{mul@var{m}3} instruction pattern
2822 @cindex @code{div@var{m}3} instruction pattern
2823 @cindex @code{udiv@var{m}3} instruction pattern
2824 @cindex @code{mod@var{m}3} instruction pattern
2825 @cindex @code{umod@var{m}3} instruction pattern
2826 @cindex @code{smin@var{m}3} instruction pattern
2827 @cindex @code{smax@var{m}3} instruction pattern
2828 @cindex @code{umin@var{m}3} instruction pattern
2829 @cindex @code{umax@var{m}3} instruction pattern
2830 @cindex @code{and@var{m}3} instruction pattern
2831 @cindex @code{ior@var{m}3} instruction pattern
2832 @cindex @code{xor@var{m}3} instruction pattern
2833 @item @samp{sub@var{m}3}, @samp{mul@var{m}3}
2834 @itemx @samp{div@var{m}3}, @samp{udiv@var{m}3}, @samp{mod@var{m}3}, @samp{umod@var{m}3}
2835 @itemx @samp{smin@var{m}3}, @samp{smax@var{m}3}, @samp{umin@var{m}3}, @samp{umax@var{m}3}
2836 @itemx @samp{and@var{m}3}, @samp{ior@var{m}3}, @samp{xor@var{m}3}
2837 Similar, for other arithmetic operations.
2838 @cindex @code{min@var{m}3} instruction pattern
2839 @cindex @code{max@var{m}3} instruction pattern
2840 @itemx @samp{min@var{m}3}, @samp{max@var{m}3}
2841 Floating point min and max operations.  If both operands are zeros,
2842 or if either operand is NaN, then it is unspecified which of the two
2843 operands is returned as the result.
2844
2845
2846 @cindex @code{mulhisi3} instruction pattern
2847 @item @samp{mulhisi3}
2848 Multiply operands 1 and 2, which have mode @code{HImode}, and store
2849 a @code{SImode} product in operand 0.
2850
2851 @cindex @code{mulqihi3} instruction pattern
2852 @cindex @code{mulsidi3} instruction pattern
2853 @item @samp{mulqihi3}, @samp{mulsidi3}
2854 Similar widening-multiplication instructions of other widths.
2855
2856 @cindex @code{umulqihi3} instruction pattern
2857 @cindex @code{umulhisi3} instruction pattern
2858 @cindex @code{umulsidi3} instruction pattern
2859 @item @samp{umulqihi3}, @samp{umulhisi3}, @samp{umulsidi3}
2860 Similar widening-multiplication instructions that do unsigned
2861 multiplication.
2862
2863 @cindex @code{smul@var{m}3_highpart} instruction pattern
2864 @item @samp{smul@var{m}3_highpart}
2865 Perform a signed multiplication of operands 1 and 2, which have mode
2866 @var{m}, and store the most significant half of the product in operand 0.
2867 The least significant half of the product is discarded.
2868
2869 @cindex @code{umul@var{m}3_highpart} instruction pattern
2870 @item @samp{umul@var{m}3_highpart}
2871 Similar, but the multiplication is unsigned.
2872
2873 @cindex @code{divmod@var{m}4} instruction pattern
2874 @item @samp{divmod@var{m}4}
2875 Signed division that produces both a quotient and a remainder.
2876 Operand 1 is divided by operand 2 to produce a quotient stored
2877 in operand 0 and a remainder stored in operand 3.
2878
2879 For machines with an instruction that produces both a quotient and a
2880 remainder, provide a pattern for @samp{divmod@var{m}4} but do not
2881 provide patterns for @samp{div@var{m}3} and @samp{mod@var{m}3}.  This
2882 allows optimization in the relatively common case when both the quotient
2883 and remainder are computed.
2884
2885 If an instruction that just produces a quotient or just a remainder
2886 exists and is more efficient than the instruction that produces both,
2887 write the output routine of @samp{divmod@var{m}4} to call
2888 @code{find_reg_note} and look for a @code{REG_UNUSED} note on the
2889 quotient or remainder and generate the appropriate instruction.
2890
2891 @cindex @code{udivmod@var{m}4} instruction pattern
2892 @item @samp{udivmod@var{m}4}
2893 Similar, but does unsigned division.
2894
2895 @anchor{shift patterns}
2896 @cindex @code{ashl@var{m}3} instruction pattern
2897 @item @samp{ashl@var{m}3}
2898 Arithmetic-shift operand 1 left by a number of bits specified by operand
2899 2, and store the result in operand 0.  Here @var{m} is the mode of
2900 operand 0 and operand 1; operand 2's mode is specified by the
2901 instruction pattern, and the compiler will convert the operand to that
2902 mode before generating the instruction.  The meaning of out-of-range shift
2903 counts can optionally be specified by @code{TARGET_SHIFT_TRUNCATION_MASK}.
2904 @xref{TARGET_SHIFT_TRUNCATION_MASK}.
2905
2906 @cindex @code{ashr@var{m}3} instruction pattern
2907 @cindex @code{lshr@var{m}3} instruction pattern
2908 @cindex @code{rotl@var{m}3} instruction pattern
2909 @cindex @code{rotr@var{m}3} instruction pattern
2910 @item @samp{ashr@var{m}3}, @samp{lshr@var{m}3}, @samp{rotl@var{m}3}, @samp{rotr@var{m}3}
2911 Other shift and rotate instructions, analogous to the
2912 @code{ashl@var{m}3} instructions.
2913
2914 @cindex @code{neg@var{m}2} instruction pattern
2915 @item @samp{neg@var{m}2}
2916 Negate operand 1 and store the result in operand 0.
2917
2918 @cindex @code{abs@var{m}2} instruction pattern
2919 @item @samp{abs@var{m}2}
2920 Store the absolute value of operand 1 into operand 0.
2921
2922 @cindex @code{sqrt@var{m}2} instruction pattern
2923 @item @samp{sqrt@var{m}2}
2924 Store the square root of operand 1 into operand 0.
2925
2926 The @code{sqrt} built-in function of C always uses the mode which
2927 corresponds to the C data type @code{double} and the @code{sqrtf}
2928 built-in function uses the mode which corresponds to the C data
2929 type @code{float}.
2930
2931 @cindex @code{cos@var{m}2} instruction pattern
2932 @item @samp{cos@var{m}2}
2933 Store the cosine of operand 1 into operand 0.
2934
2935 The @code{cos} built-in function of C always uses the mode which
2936 corresponds to the C data type @code{double} and the @code{cosf}
2937 built-in function uses the mode which corresponds to the C data
2938 type @code{float}.
2939
2940 @cindex @code{sin@var{m}2} instruction pattern
2941 @item @samp{sin@var{m}2}
2942 Store the sine of operand 1 into operand 0.
2943
2944 The @code{sin} built-in function of C always uses the mode which
2945 corresponds to the C data type @code{double} and the @code{sinf}
2946 built-in function uses the mode which corresponds to the C data
2947 type @code{float}.
2948
2949 @cindex @code{exp@var{m}2} instruction pattern
2950 @item @samp{exp@var{m}2}
2951 Store the exponential of operand 1 into operand 0.
2952
2953 The @code{exp} built-in function of C always uses the mode which
2954 corresponds to the C data type @code{double} and the @code{expf}
2955 built-in function uses the mode which corresponds to the C data
2956 type @code{float}.
2957
2958 @cindex @code{log@var{m}2} instruction pattern
2959 @item @samp{log@var{m}2}
2960 Store the natural logarithm of operand 1 into operand 0.
2961
2962 The @code{log} built-in function of C always uses the mode which
2963 corresponds to the C data type @code{double} and the @code{logf}
2964 built-in function uses the mode which corresponds to the C data
2965 type @code{float}.
2966
2967 @cindex @code{pow@var{m}3} instruction pattern
2968 @item @samp{pow@var{m}3}
2969 Store the value of operand 1 raised to the exponent operand 2
2970 into operand 0.
2971
2972 The @code{pow} built-in function of C always uses the mode which
2973 corresponds to the C data type @code{double} and the @code{powf}
2974 built-in function uses the mode which corresponds to the C data
2975 type @code{float}.
2976
2977 @cindex @code{atan2@var{m}3} instruction pattern
2978 @item @samp{atan2@var{m}3}
2979 Store the arc tangent (inverse tangent) of operand 1 divided by
2980 operand 2 into operand 0, using the signs of both arguments to
2981 determine the quadrant of the result.
2982
2983 The @code{atan2} built-in function of C always uses the mode which
2984 corresponds to the C data type @code{double} and the @code{atan2f}
2985 built-in function uses the mode which corresponds to the C data
2986 type @code{float}.
2987
2988 @cindex @code{floor@var{m}2} instruction pattern
2989 @item @samp{floor@var{m}2}
2990 Store the largest integral value not greater than argument.
2991
2992 The @code{floor} built-in function of C always uses the mode which
2993 corresponds to the C data type @code{double} and the @code{floorf}
2994 built-in function uses the mode which corresponds to the C data
2995 type @code{float}.
2996
2997 @cindex @code{trunc@var{m}2} instruction pattern
2998 @item @samp{trunc@var{m}2}
2999 Store the argument rounded to integer towards zero.
3000
3001 The @code{trunc} built-in function of C always uses the mode which
3002 corresponds to the C data type @code{double} and the @code{truncf}
3003 built-in function uses the mode which corresponds to the C data
3004 type @code{float}.
3005
3006 @cindex @code{round@var{m}2} instruction pattern
3007 @item @samp{round@var{m}2}
3008 Store the argument rounded to integer away from zero.
3009
3010 The @code{round} built-in function of C always uses the mode which
3011 corresponds to the C data type @code{double} and the @code{roundf}
3012 built-in function uses the mode which corresponds to the C data
3013 type @code{float}.
3014
3015 @cindex @code{ceil@var{m}2} instruction pattern
3016 @item @samp{ceil@var{m}2}
3017 Store the argument rounded to integer away from zero.
3018
3019 The @code{ceil} built-in function of C always uses the mode which
3020 corresponds to the C data type @code{double} and the @code{ceilf}
3021 built-in function uses the mode which corresponds to the C data
3022 type @code{float}.
3023
3024 @cindex @code{nearbyint@var{m}2} instruction pattern
3025 @item @samp{nearbyint@var{m}2}
3026 Store the argument rounded according to the default rounding mode
3027
3028 The @code{nearbyint} built-in function of C always uses the mode which
3029 corresponds to the C data type @code{double} and the @code{nearbyintf}
3030 built-in function uses the mode which corresponds to the C data
3031 type @code{float}.
3032
3033 @cindex @code{ffs@var{m}2} instruction pattern
3034 @item @samp{ffs@var{m}2}
3035 Store into operand 0 one plus the index of the least significant 1-bit
3036 of operand 1.  If operand 1 is zero, store zero.  @var{m} is the mode
3037 of operand 0; operand 1's mode is specified by the instruction
3038 pattern, and the compiler will convert the operand to that mode before
3039 generating the instruction.
3040
3041 The @code{ffs} built-in function of C always uses the mode which
3042 corresponds to the C data type @code{int}.
3043
3044 @cindex @code{clz@var{m}2} instruction pattern
3045 @item @samp{clz@var{m}2}
3046 Store into operand 0 the number of leading 0-bits in @var{x}, starting
3047 at the most significant bit position.  If @var{x} is 0, the result is
3048 undefined.  @var{m} is the mode of operand 0; operand 1's mode is
3049 specified by the instruction pattern, and the compiler will convert the
3050 operand to that mode before generating the instruction.
3051
3052 @cindex @code{ctz@var{m}2} instruction pattern
3053 @item @samp{ctz@var{m}2}
3054 Store into operand 0 the number of trailing 0-bits in @var{x}, starting
3055 at the least significant bit position.  If @var{x} is 0, the result is
3056 undefined.  @var{m} is the mode of operand 0; operand 1's mode is
3057 specified by the instruction pattern, and the compiler will convert the
3058 operand to that mode before generating the instruction.
3059
3060 @cindex @code{popcount@var{m}2} instruction pattern
3061 @item @samp{popcount@var{m}2}
3062 Store into operand 0 the number of 1-bits in @var{x}.  @var{m} is the
3063 mode of operand 0; operand 1's mode is specified by the instruction
3064 pattern, and the compiler will convert the operand to that mode before
3065 generating the instruction.
3066
3067 @cindex @code{parity@var{m}2} instruction pattern
3068 @item @samp{parity@var{m}2}
3069 Store into operand 0 the parity of @var{x}, i.e.@: the number of 1-bits
3070 in @var{x} modulo 2.  @var{m} is the mode of operand 0; operand 1's mode
3071 is specified by the instruction pattern, and the compiler will convert
3072 the operand to that mode before generating the instruction.
3073
3074 @cindex @code{one_cmpl@var{m}2} instruction pattern
3075 @item @samp{one_cmpl@var{m}2}
3076 Store the bitwise-complement of operand 1 into operand 0.
3077
3078 @cindex @code{cmp@var{m}} instruction pattern
3079 @item @samp{cmp@var{m}}
3080 Compare operand 0 and operand 1, and set the condition codes.
3081 The RTL pattern should look like this:
3082
3083 @smallexample
3084 (set (cc0) (compare (match_operand:@var{m} 0 @dots{})
3085                     (match_operand:@var{m} 1 @dots{})))
3086 @end smallexample
3087
3088 @cindex @code{tst@var{m}} instruction pattern
3089 @item @samp{tst@var{m}}
3090 Compare operand 0 against zero, and set the condition codes.
3091 The RTL pattern should look like this:
3092
3093 @smallexample
3094 (set (cc0) (match_operand:@var{m} 0 @dots{}))
3095 @end smallexample
3096
3097 @samp{tst@var{m}} patterns should not be defined for machines that do
3098 not use @code{(cc0)}.  Doing so would confuse the optimizer since it
3099 would no longer be clear which @code{set} operations were comparisons.
3100 The @samp{cmp@var{m}} patterns should be used instead.
3101
3102 @cindex @code{movmem@var{m}} instruction pattern
3103 @item @samp{movmem@var{m}}
3104 Block move instruction.  The destination and source blocks of memory
3105 are the first two operands, and both are @code{mem:BLK}s with an
3106 address in mode @code{Pmode}.
3107
3108 The number of bytes to move is the third operand, in mode @var{m}.
3109 Usually, you specify @code{word_mode} for @var{m}.  However, if you can
3110 generate better code knowing the range of valid lengths is smaller than
3111 those representable in a full word, you should provide a pattern with a
3112 mode corresponding to the range of values you can handle efficiently
3113 (e.g., @code{QImode} for values in the range 0--127; note we avoid numbers
3114 that appear negative) and also a pattern with @code{word_mode}.
3115
3116 The fourth operand is the known shared alignment of the source and
3117 destination, in the form of a @code{const_int} rtx.  Thus, if the
3118 compiler knows that both source and destination are word-aligned,
3119 it may provide the value 4 for this operand.
3120
3121 Descriptions of multiple @code{movmem@var{m}} patterns can only be
3122 beneficial if the patterns for smaller modes have fewer restrictions
3123 on their first, second and fourth operands.  Note that the mode @var{m}
3124 in @code{movmem@var{m}} does not impose any restriction on the mode of
3125 individually moved data units in the block.
3126
3127 These patterns need not give special consideration to the possibility
3128 that the source and destination strings might overlap.
3129
3130 @cindex @code{movstr} instruction pattern
3131 @item @samp{movstr}
3132 String copy instruction, with @code{stpcpy} semantics.  Operand 0 is
3133 an output operand in mode @code{Pmode}.  The addresses of the
3134 destination and source strings are operands 1 and 2, and both are
3135 @code{mem:BLK}s with addresses in mode @code{Pmode}.  The execution of
3136 the expansion of this pattern should store in operand 0 the address in
3137 which the @code{NUL} terminator was stored in the destination string.
3138
3139 @cindex @code{clrmem@var{m}} instruction pattern
3140 @item @samp{clrmem@var{m}}
3141 Block clear instruction.  The destination string is the first operand,
3142 given as a @code{mem:BLK} whose address is in mode @code{Pmode}.  The
3143 number of bytes to clear is the second operand, in mode @var{m}.  See
3144 @samp{movmem@var{m}} for a discussion of the choice of mode.
3145
3146 The third operand is the known alignment of the destination, in the form
3147 of a @code{const_int} rtx.  Thus, if the compiler knows that the
3148 destination is word-aligned, it may provide the value 4 for this
3149 operand.
3150
3151 The use for multiple @code{clrmem@var{m}} is as for @code{movmem@var{m}}.
3152
3153 @cindex @code{cmpstr@var{m}} instruction pattern
3154 @item @samp{cmpstr@var{m}}
3155 String compare instruction, with five operands.  Operand 0 is the output;
3156 it has mode @var{m}.  The remaining four operands are like the operands
3157 of @samp{movmem@var{m}}.  The two memory blocks specified are compared
3158 byte by byte in lexicographic order starting at the beginning of each
3159 string.  The instruction is not allowed to prefetch more than one byte
3160 at a time since either string may end in the first byte and reading past
3161 that may access an invalid page or segment and cause a fault.  The
3162 effect of the instruction is to store a value in operand 0 whose sign
3163 indicates the result of the comparison.
3164
3165 @cindex @code{cmpmem@var{m}} instruction pattern
3166 @item @samp{cmpmem@var{m}}
3167 Block compare instruction, with five operands like the operands
3168 of @samp{cmpstr@var{m}}.  The two memory blocks specified are compared
3169 byte by byte in lexicographic order starting at the beginning of each
3170 block.  Unlike @samp{cmpstr@var{m}} the instruction can prefetch
3171 any bytes in the two memory blocks.  The effect of the instruction is
3172 to store a value in operand 0 whose sign indicates the result of the
3173 comparison.
3174
3175 @cindex @code{strlen@var{m}} instruction pattern
3176 @item @samp{strlen@var{m}}
3177 Compute the length of a string, with three operands.
3178 Operand 0 is the result (of mode @var{m}), operand 1 is
3179 a @code{mem} referring to the first character of the string,
3180 operand 2 is the character to search for (normally zero),
3181 and operand 3 is a constant describing the known alignment
3182 of the beginning of the string.
3183
3184 @cindex @code{float@var{mn}2} instruction pattern
3185 @item @samp{float@var{m}@var{n}2}
3186 Convert signed integer operand 1 (valid for fixed point mode @var{m}) to
3187 floating point mode @var{n} and store in operand 0 (which has mode
3188 @var{n}).
3189
3190 @cindex @code{floatuns@var{mn}2} instruction pattern
3191 @item @samp{floatuns@var{m}@var{n}2}
3192 Convert unsigned integer operand 1 (valid for fixed point mode @var{m})
3193 to floating point mode @var{n} and store in operand 0 (which has mode
3194 @var{n}).
3195
3196 @cindex @code{fix@var{mn}2} instruction pattern
3197 @item @samp{fix@var{m}@var{n}2}
3198 Convert operand 1 (valid for floating point mode @var{m}) to fixed
3199 point mode @var{n} as a signed number and store in operand 0 (which
3200 has mode @var{n}).  This instruction's result is defined only when
3201 the value of operand 1 is an integer.
3202
3203 If the machine description defines this pattern, it also needs to
3204 define the @code{ftrunc} pattern.
3205
3206 @cindex @code{fixuns@var{mn}2} instruction pattern
3207 @item @samp{fixuns@var{m}@var{n}2}
3208 Convert operand 1 (valid for floating point mode @var{m}) to fixed
3209 point mode @var{n} as an unsigned number and store in operand 0 (which
3210 has mode @var{n}).  This instruction's result is defined only when the
3211 value of operand 1 is an integer.
3212
3213 @cindex @code{ftrunc@var{m}2} instruction pattern
3214 @item @samp{ftrunc@var{m}2}
3215 Convert operand 1 (valid for floating point mode @var{m}) to an
3216 integer value, still represented in floating point mode @var{m}, and
3217 store it in operand 0 (valid for floating point mode @var{m}).
3218
3219 @cindex @code{fix_trunc@var{mn}2} instruction pattern
3220 @item @samp{fix_trunc@var{m}@var{n}2}
3221 Like @samp{fix@var{m}@var{n}2} but works for any floating point value
3222 of mode @var{m} by converting the value to an integer.
3223
3224 @cindex @code{fixuns_trunc@var{mn}2} instruction pattern
3225 @item @samp{fixuns_trunc@var{m}@var{n}2}
3226 Like @samp{fixuns@var{m}@var{n}2} but works for any floating point
3227 value of mode @var{m} by converting the value to an integer.
3228
3229 @cindex @code{trunc@var{mn}2} instruction pattern
3230 @item @samp{trunc@var{m}@var{n}2}
3231 Truncate operand 1 (valid for mode @var{m}) to mode @var{n} and
3232 store in operand 0 (which has mode @var{n}).  Both modes must be fixed
3233 point or both floating point.
3234
3235 @cindex @code{extend@var{mn}2} instruction pattern
3236 @item @samp{extend@var{m}@var{n}2}
3237 Sign-extend operand 1 (valid for mode @var{m}) to mode @var{n} and
3238 store in operand 0 (which has mode @var{n}).  Both modes must be fixed
3239 point or both floating point.
3240
3241 @cindex @code{zero_extend@var{mn}2} instruction pattern
3242 @item @samp{zero_extend@var{m}@var{n}2}
3243 Zero-extend operand 1 (valid for mode @var{m}) to mode @var{n} and
3244 store in operand 0 (which has mode @var{n}).  Both modes must be fixed
3245 point.
3246
3247 @cindex @code{extv} instruction pattern
3248 @item @samp{extv}
3249 Extract a bit-field from operand 1 (a register or memory operand), where
3250 operand 2 specifies the width in bits and operand 3 the starting bit,
3251 and store it in operand 0.  Operand 0 must have mode @code{word_mode}.
3252 Operand 1 may have mode @code{byte_mode} or @code{word_mode}; often
3253 @code{word_mode} is allowed only for registers.  Operands 2 and 3 must
3254 be valid for @code{word_mode}.
3255
3256 The RTL generation pass generates this instruction only with constants
3257 for operands 2 and 3.
3258
3259 The bit-field value is sign-extended to a full word integer
3260 before it is stored in operand 0.
3261
3262 @cindex @code{extzv} instruction pattern
3263 @item @samp{extzv}
3264 Like @samp{extv} except that the bit-field value is zero-extended.
3265
3266 @cindex @code{insv} instruction pattern
3267 @item @samp{insv}
3268 Store operand 3 (which must be valid for @code{word_mode}) into a
3269 bit-field in operand 0, where operand 1 specifies the width in bits and
3270 operand 2 the starting bit.  Operand 0 may have mode @code{byte_mode} or
3271 @code{word_mode}; often @code{word_mode} is allowed only for registers.
3272 Operands 1 and 2 must be valid for @code{word_mode}.
3273
3274 The RTL generation pass generates this instruction only with constants
3275 for operands 1 and 2.
3276
3277 @cindex @code{mov@var{mode}cc} instruction pattern
3278 @item @samp{mov@var{mode}cc}
3279 Conditionally move operand 2 or operand 3 into operand 0 according to the
3280 comparison in operand 1.  If the comparison is true, operand 2 is moved
3281 into operand 0, otherwise operand 3 is moved.
3282
3283 The mode of the operands being compared need not be the same as the operands
3284 being moved.  Some machines, sparc64 for example, have instructions that
3285 conditionally move an integer value based on the floating point condition
3286 codes and vice versa.
3287
3288 If the machine does not have conditional move instructions, do not
3289 define these patterns.
3290
3291 @cindex @code{add@var{mode}cc} instruction pattern
3292 @item @samp{add@var{mode}cc}
3293 Similar to @samp{mov@var{mode}cc} but for conditional addition.  Conditionally
3294 move operand 2 or (operands 2 + operand 3) into operand 0 according to the
3295 comparison in operand 1.  If the comparison is true, operand 2 is moved into
3296 operand 0, otherwise (operand 2 + operand 3) is moved.
3297
3298 @cindex @code{s@var{cond}} instruction pattern
3299 @item @samp{s@var{cond}}
3300 Store zero or nonzero in the operand according to the condition codes.
3301 Value stored is nonzero iff the condition @var{cond} is true.
3302 @var{cond} is the name of a comparison operation expression code, such
3303 as @code{eq}, @code{lt} or @code{leu}.
3304
3305 You specify the mode that the operand must have when you write the
3306 @code{match_operand} expression.  The compiler automatically sees
3307 which mode you have used and supplies an operand of that mode.
3308
3309 The value stored for a true condition must have 1 as its low bit, or
3310 else must be negative.  Otherwise the instruction is not suitable and
3311 you should omit it from the machine description.  You describe to the
3312 compiler exactly which value is stored by defining the macro
3313 @code{STORE_FLAG_VALUE} (@pxref{Misc}).  If a description cannot be
3314 found that can be used for all the @samp{s@var{cond}} patterns, you
3315 should omit those operations from the machine description.
3316
3317 These operations may fail, but should do so only in relatively
3318 uncommon cases; if they would fail for common cases involving
3319 integer comparisons, it is best to omit these patterns.
3320
3321 If these operations are omitted, the compiler will usually generate code
3322 that copies the constant one to the target and branches around an
3323 assignment of zero to the target.  If this code is more efficient than
3324 the potential instructions used for the @samp{s@var{cond}} pattern
3325 followed by those required to convert the result into a 1 or a zero in
3326 @code{SImode}, you should omit the @samp{s@var{cond}} operations from
3327 the machine description.
3328
3329 @cindex @code{b@var{cond}} instruction pattern
3330 @item @samp{b@var{cond}}
3331 Conditional branch instruction.  Operand 0 is a @code{label_ref} that
3332 refers to the label to jump to.  Jump if the condition codes meet
3333 condition @var{cond}.
3334
3335 Some machines do not follow the model assumed here where a comparison
3336 instruction is followed by a conditional branch instruction.  In that
3337 case, the @samp{cmp@var{m}} (and @samp{tst@var{m}}) patterns should
3338 simply store the operands away and generate all the required insns in a
3339 @code{define_expand} (@pxref{Expander Definitions}) for the conditional
3340 branch operations.  All calls to expand @samp{b@var{cond}} patterns are
3341 immediately preceded by calls to expand either a @samp{cmp@var{m}}
3342 pattern or a @samp{tst@var{m}} pattern.
3343
3344 Machines that use a pseudo register for the condition code value, or
3345 where the mode used for the comparison depends on the condition being
3346 tested, should also use the above mechanism.  @xref{Jump Patterns}.
3347
3348 The above discussion also applies to the @samp{mov@var{mode}cc} and
3349 @samp{s@var{cond}} patterns.
3350
3351 @cindex @code{cbranch@var{mode}4} instruction pattern
3352 @item @samp{cbranch@var{mode}4}
3353 Conditional branch instruction combined with a compare instruction.
3354 Operand 0 is a comparison operator.  Operand 1 and operand 2 are the
3355 first and second operands of the comparison, respectively.  Operand 3
3356 is a @code{label_ref} that refers to the label to jump to.
3357
3358 @cindex @code{jump} instruction pattern
3359 @item @samp{jump}
3360 A jump inside a function; an unconditional branch.  Operand 0 is the
3361 @code{label_ref} of the label to jump to.  This pattern name is mandatory
3362 on all machines.
3363
3364 @cindex @code{call} instruction pattern
3365 @item @samp{call}
3366 Subroutine call instruction returning no value.  Operand 0 is the
3367 function to call; operand 1 is the number of bytes of arguments pushed
3368 as a @code{const_int}; operand 2 is the number of registers used as
3369 operands.
3370
3371 On most machines, operand 2 is not actually stored into the RTL
3372 pattern.  It is supplied for the sake of some RISC machines which need
3373 to put this information into the assembler code; they can put it in
3374 the RTL instead of operand 1.
3375
3376 Operand 0 should be a @code{mem} RTX whose address is the address of the
3377 function.  Note, however, that this address can be a @code{symbol_ref}
3378 expression even if it would not be a legitimate memory address on the
3379 target machine.  If it is also not a valid argument for a call
3380 instruction, the pattern for this operation should be a
3381 @code{define_expand} (@pxref{Expander Definitions}) that places the
3382 address into a register and uses that register in the call instruction.
3383
3384 @cindex @code{call_value} instruction pattern
3385 @item @samp{call_value}
3386 Subroutine call instruction returning a value.  Operand 0 is the hard
3387 register in which the value is returned.  There are three more
3388 operands, the same as the three operands of the @samp{call}
3389 instruction (but with numbers increased by one).
3390
3391 Subroutines that return @code{BLKmode} objects use the @samp{call}
3392 insn.
3393
3394 @cindex @code{call_pop} instruction pattern
3395 @cindex @code{call_value_pop} instruction pattern
3396 @item @samp{call_pop}, @samp{call_value_pop}
3397 Similar to @samp{call} and @samp{call_value}, except used if defined and
3398 if @code{RETURN_POPS_ARGS} is nonzero.  They should emit a @code{parallel}
3399 that contains both the function call and a @code{set} to indicate the
3400 adjustment made to the frame pointer.
3401
3402 For machines where @code{RETURN_POPS_ARGS} can be nonzero, the use of these
3403 patterns increases the number of functions for which the frame pointer
3404 can be eliminated, if desired.
3405
3406 @cindex @code{untyped_call} instruction pattern
3407 @item @samp{untyped_call}
3408 Subroutine call instruction returning a value of any type.  Operand 0 is
3409 the function to call; operand 1 is a memory location where the result of
3410 calling the function is to be stored; operand 2 is a @code{parallel}
3411 expression where each element is a @code{set} expression that indicates
3412 the saving of a function return value into the result block.
3413
3414 This instruction pattern should be defined to support
3415 @code{__builtin_apply} on machines where special instructions are needed
3416 to call a subroutine with arbitrary arguments or to save the value
3417 returned.  This instruction pattern is required on machines that have
3418 multiple registers that can hold a return value
3419 (i.e.@: @code{FUNCTION_VALUE_REGNO_P} is true for more than one register).
3420
3421 @cindex @code{return} instruction pattern
3422 @item @samp{return}
3423 Subroutine return instruction.  This instruction pattern name should be
3424 defined only if a single instruction can do all the work of returning
3425 from a function.
3426
3427 Like the @samp{mov@var{m}} patterns, this pattern is also used after the
3428 RTL generation phase.  In this case it is to support machines where
3429 multiple instructions are usually needed to return from a function, but
3430 some class of functions only requires one instruction to implement a
3431 return.  Normally, the applicable functions are those which do not need
3432 to save any registers or allocate stack space.
3433
3434 @findex reload_completed
3435 @findex leaf_function_p
3436 For such machines, the condition specified in this pattern should only
3437 be true when @code{reload_completed} is nonzero and the function's
3438 epilogue would only be a single instruction.  For machines with register
3439 windows, the routine @code{leaf_function_p} may be used to determine if
3440 a register window push is required.
3441
3442 Machines that have conditional return instructions should define patterns
3443 such as
3444
3445 @smallexample
3446 (define_insn ""
3447   [(set (pc)
3448         (if_then_else (match_operator
3449                          0 "comparison_operator"
3450                          [(cc0) (const_int 0)])
3451                       (return)
3452                       (pc)))]
3453   "@var{condition}"
3454   "@dots{}")
3455 @end smallexample
3456
3457 where @var{condition} would normally be the same condition specified on the
3458 named @samp{return} pattern.
3459
3460 @cindex @code{untyped_return} instruction pattern
3461 @item @samp{untyped_return}
3462 Untyped subroutine return instruction.  This instruction pattern should
3463 be defined to support @code{__builtin_return} on machines where special
3464 instructions are needed to return a value of any type.
3465
3466 Operand 0 is a memory location where the result of calling a function
3467 with @code{__builtin_apply} is stored; operand 1 is a @code{parallel}
3468 expression where each element is a @code{set} expression that indicates
3469 the restoring of a function return value from the result block.
3470
3471 @cindex @code{nop} instruction pattern
3472 @item @samp{nop}
3473 No-op instruction.  This instruction pattern name should always be defined
3474 to output a no-op in assembler code.  @code{(const_int 0)} will do as an
3475 RTL pattern.
3476
3477 @cindex @code{indirect_jump} instruction pattern
3478 @item @samp{indirect_jump}
3479 An instruction to jump to an address which is operand zero.
3480 This pattern name is mandatory on all machines.
3481
3482 @cindex @code{casesi} instruction pattern
3483 @item @samp{casesi}
3484 Instruction to jump through a dispatch table, including bounds checking.
3485 This instruction takes five operands:
3486
3487 @enumerate
3488 @item
3489 The index to dispatch on, which has mode @code{SImode}.
3490
3491 @item
3492 The lower bound for indices in the table, an integer constant.
3493
3494 @item
3495 The total range of indices in the table---the largest index
3496 minus the smallest one (both inclusive).
3497
3498 @item
3499 A label that precedes the table itself.
3500
3501 @item
3502 A label to jump to if the index has a value outside the bounds.
3503 (If the machine-description macro @code{CASE_DROPS_THROUGH} is defined,
3504 then an out-of-bounds index drops through to the code following
3505 the jump table instead of jumping to this label.  In that case,
3506 this label is not actually used by the @samp{casesi} instruction,
3507 but it is always provided as an operand.)
3508 @end enumerate
3509
3510 The table is a @code{addr_vec} or @code{addr_diff_vec} inside of a
3511 @code{jump_insn}.  The number of elements in the table is one plus the
3512 difference between the upper bound and the lower bound.
3513
3514 @cindex @code{tablejump} instruction pattern
3515 @item @samp{tablejump}
3516 Instruction to jump to a variable address.  This is a low-level
3517 capability which can be used to implement a dispatch table when there
3518 is no @samp{casesi} pattern.
3519
3520 This pattern requires two operands: the address or offset, and a label
3521 which should immediately precede the jump table.  If the macro
3522 @code{CASE_VECTOR_PC_RELATIVE} evaluates to a nonzero value then the first
3523 operand is an offset which counts from the address of the table; otherwise,
3524 it is an absolute address to jump to.  In either case, the first operand has
3525 mode @code{Pmode}.
3526
3527 The @samp{tablejump} insn is always the last insn before the jump
3528 table it uses.  Its assembler code normally has no need to use the
3529 second operand, but you should incorporate it in the RTL pattern so
3530 that the jump optimizer will not delete the table as unreachable code.
3531
3532
3533 @cindex @code{decrement_and_branch_until_zero} instruction pattern
3534 @item @samp{decrement_and_branch_until_zero}
3535 Conditional branch instruction that decrements a register and
3536 jumps if the register is nonzero.  Operand 0 is the register to
3537 decrement and test; operand 1 is the label to jump to if the
3538 register is nonzero.  @xref{Looping Patterns}.
3539
3540 This optional instruction pattern is only used by the combiner,
3541 typically for loops reversed by the loop optimizer when strength
3542 reduction is enabled.
3543
3544 @cindex @code{doloop_end} instruction pattern
3545 @item @samp{doloop_end}
3546 Conditional branch instruction that decrements a register and jumps if
3547 the register is nonzero.  This instruction takes five operands: Operand
3548 0 is the register to decrement and test; operand 1 is the number of loop
3549 iterations as a @code{const_int} or @code{const0_rtx} if this cannot be
3550 determined until run-time; operand 2 is the actual or estimated maximum
3551 number of iterations as a @code{const_int}; operand 3 is the number of
3552 enclosed loops as a @code{const_int} (an innermost loop has a value of
3553 1); operand 4 is the label to jump to if the register is nonzero.
3554 @xref{Looping Patterns}.
3555
3556 This optional instruction pattern should be defined for machines with
3557 low-overhead looping instructions as the loop optimizer will try to
3558 modify suitable loops to utilize it.  If nested low-overhead looping is
3559 not supported, use a @code{define_expand} (@pxref{Expander Definitions})
3560 and make the pattern fail if operand 3 is not @code{const1_rtx}.
3561 Similarly, if the actual or estimated maximum number of iterations is
3562 too large for this instruction, make it fail.
3563
3564 @cindex @code{doloop_begin} instruction pattern
3565 @item @samp{doloop_begin}
3566 Companion instruction to @code{doloop_end} required for machines that
3567 need to perform some initialization, such as loading special registers
3568 used by a low-overhead looping instruction.  If initialization insns do
3569 not always need to be emitted, use a @code{define_expand}
3570 (@pxref{Expander Definitions}) and make it fail.
3571
3572
3573 @cindex @code{canonicalize_funcptr_for_compare} instruction pattern
3574 @item @samp{canonicalize_funcptr_for_compare}
3575 Canonicalize the function pointer in operand 1 and store the result
3576 into operand 0.
3577
3578 Operand 0 is always a @code{reg} and has mode @code{Pmode}; operand 1
3579 may be a @code{reg}, @code{mem}, @code{symbol_ref}, @code{const_int}, etc
3580 and also has mode @code{Pmode}.
3581
3582 Canonicalization of a function pointer usually involves computing
3583 the address of the function which would be called if the function
3584 pointer were used in an indirect call.
3585
3586 Only define this pattern if function pointers on the target machine
3587 can have different values but still call the same function when
3588 used in an indirect call.
3589
3590 @cindex @code{save_stack_block} instruction pattern
3591 @cindex @code{save_stack_function} instruction pattern
3592 @cindex @code{save_stack_nonlocal} instruction pattern
3593 @cindex @code{restore_stack_block} instruction pattern
3594 @cindex @code{restore_stack_function} instruction pattern
3595 @cindex @code{restore_stack_nonlocal} instruction pattern
3596 @item @samp{save_stack_block}
3597 @itemx @samp{save_stack_function}
3598 @itemx @samp{save_stack_nonlocal}
3599 @itemx @samp{restore_stack_block}
3600 @itemx @samp{restore_stack_function}
3601 @itemx @samp{restore_stack_nonlocal}
3602 Most machines save and restore the stack pointer by copying it to or
3603 from an object of mode @code{Pmode}.  Do not define these patterns on
3604 such machines.
3605
3606 Some machines require special handling for stack pointer saves and
3607 restores.  On those machines, define the patterns corresponding to the
3608 non-standard cases by using a @code{define_expand} (@pxref{Expander
3609 Definitions}) that produces the required insns.  The three types of
3610 saves and restores are:
3611
3612 @enumerate
3613 @item
3614 @samp{save_stack_block} saves the stack pointer at the start of a block
3615 that allocates a variable-sized object, and @samp{restore_stack_block}
3616 restores the stack pointer when the block is exited.
3617
3618 @item
3619 @samp{save_stack_function} and @samp{restore_stack_function} do a
3620 similar job for the outermost block of a function and are used when the
3621 function allocates variable-sized objects or calls @code{alloca}.  Only
3622 the epilogue uses the restored stack pointer, allowing a simpler save or
3623 restore sequence on some machines.
3624
3625 @item
3626 @samp{save_stack_nonlocal} is used in functions that contain labels
3627 branched to by nested functions.  It saves the stack pointer in such a
3628 way that the inner function can use @samp{restore_stack_nonlocal} to
3629 restore the stack pointer.  The compiler generates code to restore the
3630 frame and argument pointer registers, but some machines require saving
3631 and restoring additional data such as register window information or
3632 stack backchains.  Place insns in these patterns to save and restore any
3633 such required data.
3634 @end enumerate
3635
3636 When saving the stack pointer, operand 0 is the save area and operand 1
3637 is the stack pointer.  The mode used to allocate the save area defaults
3638 to @code{Pmode} but you can override that choice by defining the
3639 @code{STACK_SAVEAREA_MODE} macro (@pxref{Storage Layout}).  You must
3640 specify an integral mode, or @code{VOIDmode} if no save area is needed
3641 for a particular type of save (either because no save is needed or
3642 because a machine-specific save area can be used).  Operand 0 is the
3643 stack pointer and operand 1 is the save area for restore operations.  If
3644 @samp{save_stack_block} is defined, operand 0 must not be
3645 @code{VOIDmode} since these saves can be arbitrarily nested.
3646
3647 A save area is a @code{mem} that is at a constant offset from
3648 @code{virtual_stack_vars_rtx} when the stack pointer is saved for use by
3649 nonlocal gotos and a @code{reg} in the other two cases.
3650
3651 @cindex @code{allocate_stack} instruction pattern
3652 @item @samp{allocate_stack}
3653 Subtract (or add if @code{STACK_GROWS_DOWNWARD} is undefined) operand 1 from
3654 the stack pointer to create space for dynamically allocated data.
3655
3656 Store the resultant pointer to this space into operand 0.  If you
3657 are allocating space from the main stack, do this by emitting a
3658 move insn to copy @code{virtual_stack_dynamic_rtx} to operand 0.
3659 If you are allocating the space elsewhere, generate code to copy the
3660 location of the space to operand 0.  In the latter case, you must
3661 ensure this space gets freed when the corresponding space on the main
3662 stack is free.
3663
3664 Do not define this pattern if all that must be done is the subtraction.
3665 Some machines require other operations such as stack probes or
3666 maintaining the back chain.  Define this pattern to emit those
3667 operations in addition to updating the stack pointer.
3668
3669 @cindex @code{check_stack} instruction pattern
3670 @item @samp{check_stack}
3671 If stack checking cannot be done on your system by probing the stack with
3672 a load or store instruction (@pxref{Stack Checking}), define this pattern
3673 to perform the needed check and signaling an error if the stack
3674 has overflowed.  The single operand is the location in the stack furthest
3675 from the current stack pointer that you need to validate.  Normally,
3676 on machines where this pattern is needed, you would obtain the stack
3677 limit from a global or thread-specific variable or register.
3678
3679 @cindex @code{nonlocal_goto} instruction pattern
3680 @item @samp{nonlocal_goto}
3681 Emit code to generate a non-local goto, e.g., a jump from one function
3682 to a label in an outer function.  This pattern has four arguments,
3683 each representing a value to be used in the jump.  The first
3684 argument is to be loaded into the frame pointer, the second is
3685 the address to branch to (code to dispatch to the actual label),
3686 the third is the address of a location where the stack is saved,
3687 and the last is the address of the label, to be placed in the
3688 location for the incoming static chain.
3689
3690 On most machines you need not define this pattern, since GCC will
3691 already generate the correct code, which is to load the frame pointer
3692 and static chain, restore the stack (using the
3693 @samp{restore_stack_nonlocal} pattern, if defined), and jump indirectly
3694 to the dispatcher.  You need only define this pattern if this code will
3695 not work on your machine.
3696
3697 @cindex @code{nonlocal_goto_receiver} instruction pattern
3698 @item @samp{nonlocal_goto_receiver}
3699 This pattern, if defined, contains code needed at the target of a
3700 nonlocal goto after the code already generated by GCC@.  You will not
3701 normally need to define this pattern.  A typical reason why you might
3702 need this pattern is if some value, such as a pointer to a global table,
3703 must be restored when the frame pointer is restored.  Note that a nonlocal
3704 goto only occurs within a unit-of-translation, so a global table pointer
3705 that is shared by all functions of a given module need not be restored.
3706 There are no arguments.
3707
3708 @cindex @code{exception_receiver} instruction pattern
3709 @item @samp{exception_receiver}
3710 This pattern, if defined, contains code needed at the site of an
3711 exception handler that isn't needed at the site of a nonlocal goto.  You
3712 will not normally need to define this pattern.  A typical reason why you
3713 might need this pattern is if some value, such as a pointer to a global
3714 table, must be restored after control flow is branched to the handler of
3715 an exception.  There are no arguments.
3716
3717 @cindex @code{builtin_setjmp_setup} instruction pattern
3718 @item @samp{builtin_setjmp_setup}
3719 This pattern, if defined, contains additional code needed to initialize
3720 the @code{jmp_buf}.  You will not normally need to define this pattern.
3721 A typical reason why you might need this pattern is if some value, such
3722 as a pointer to a global table, must be restored.  Though it is
3723 preferred that the pointer value be recalculated if possible (given the
3724 address of a label for instance).  The single argument is a pointer to
3725 the @code{jmp_buf}.  Note that the buffer is five words long and that
3726 the first three are normally used by the generic mechanism.
3727
3728 @cindex @code{builtin_setjmp_receiver} instruction pattern
3729 @item @samp{builtin_setjmp_receiver}
3730 This pattern, if defined, contains code needed at the site of an
3731 built-in setjmp that isn't needed at the site of a nonlocal goto.  You
3732 will not normally need to define this pattern.  A typical reason why you
3733 might need this pattern is if some value, such as a pointer to a global
3734 table, must be restored.  It takes one argument, which is the label
3735 to which builtin_longjmp transfered control; this pattern may be emitted
3736 at a small offset from that label.
3737
3738 @cindex @code{builtin_longjmp} instruction pattern
3739 @item @samp{builtin_longjmp}
3740 This pattern, if defined, performs the entire action of the longjmp.
3741 You will not normally need to define this pattern unless you also define
3742 @code{builtin_setjmp_setup}.  The single argument is a pointer to the
3743 @code{jmp_buf}.
3744
3745 @cindex @code{eh_return} instruction pattern
3746 @item @samp{eh_return}
3747 This pattern, if defined, affects the way @code{__builtin_eh_return},
3748 and thence the call frame exception handling library routines, are
3749 built.  It is intended to handle non-trivial actions needed along
3750 the abnormal return path.
3751
3752 The address of the exception handler to which the function should return
3753 is passed as operand to this pattern.  It will normally need to copied by
3754 the pattern to some special register or memory location.
3755 If the pattern needs to determine the location of the target call
3756 frame in order to do so, it may use @code{EH_RETURN_STACKADJ_RTX},
3757 if defined; it will have already been assigned.
3758
3759 If this pattern is not defined, the default action will be to simply
3760 copy the return address to @code{EH_RETURN_HANDLER_RTX}.  Either
3761 that macro or this pattern needs to be defined if call frame exception
3762 handling is to be used.
3763
3764 @cindex @code{prologue} instruction pattern
3765 @anchor{prologue instruction pattern}
3766 @item @samp{prologue}
3767 This pattern, if defined, emits RTL for entry to a function.  The function
3768 entry is responsible for setting up the stack frame, initializing the frame
3769 pointer register, saving callee saved registers, etc.
3770
3771 Using a prologue pattern is generally preferred over defining
3772 @code{TARGET_ASM_FUNCTION_PROLOGUE} to emit assembly code for the prologue.
3773
3774 The @code{prologue} pattern is particularly useful for targets which perform
3775 instruction scheduling.
3776
3777 @cindex @code{epilogue} instruction pattern
3778 @anchor{epilogue instruction pattern}
3779 @item @samp{epilogue}
3780 This pattern emits RTL for exit from a function.  The function
3781 exit is responsible for deallocating the stack frame, restoring callee saved
3782 registers and emitting the return instruction.
3783
3784 Using an epilogue pattern is generally preferred over defining
3785 @code{TARGET_ASM_FUNCTION_EPILOGUE} to emit assembly code for the epilogue.
3786
3787 The @code{epilogue} pattern is particularly useful for targets which perform
3788 instruction scheduling or which have delay slots for their return instruction.
3789
3790 @cindex @code{sibcall_epilogue} instruction pattern
3791 @item @samp{sibcall_epilogue}
3792 This pattern, if defined, emits RTL for exit from a function without the final
3793 branch back to the calling function.  This pattern will be emitted before any
3794 sibling call (aka tail call) sites.
3795
3796 The @code{sibcall_epilogue} pattern must not clobber any arguments used for
3797 parameter passing or any stack slots for arguments passed to the current
3798 function.
3799
3800 @cindex @code{trap} instruction pattern
3801 @item @samp{trap}
3802 This pattern, if defined, signals an error, typically by causing some
3803 kind of signal to be raised.  Among other places, it is used by the Java
3804 front end to signal `invalid array index' exceptions.
3805
3806 @cindex @code{conditional_trap} instruction pattern
3807 @item @samp{conditional_trap}
3808 Conditional trap instruction.  Operand 0 is a piece of RTL which
3809 performs a comparison.  Operand 1 is the trap code, an integer.
3810
3811 A typical @code{conditional_trap} pattern looks like
3812
3813 @smallexample
3814 (define_insn "conditional_trap"
3815   [(trap_if (match_operator 0 "trap_operator"
3816              [(cc0) (const_int 0)])
3817             (match_operand 1 "const_int_operand" "i"))]
3818   ""
3819   "@dots{}")
3820 @end smallexample
3821
3822 @cindex @code{prefetch} instruction pattern
3823 @item @samp{prefetch}
3824
3825 This pattern, if defined, emits code for a non-faulting data prefetch
3826 instruction.  Operand 0 is the address of the memory to prefetch.  Operand 1
3827 is a constant 1 if the prefetch is preparing for a write to the memory
3828 address, or a constant 0 otherwise.  Operand 2 is the expected degree of
3829 temporal locality of the data and is a value between 0 and 3, inclusive; 0
3830 means that the data has no temporal locality, so it need not be left in the
3831 cache after the access; 3 means that the data has a high degree of temporal
3832 locality and should be left in all levels of cache possible;  1 and 2 mean,
3833 respectively, a low or moderate degree of temporal locality.
3834
3835 Targets that do not support write prefetches or locality hints can ignore
3836 the values of operands 1 and 2.
3837
3838 @end table
3839
3840 @end ifset
3841 @c Each of the following nodes are wrapped in separate
3842 @c "@ifset INTERNALS" to work around memory limits for the default
3843 @c configuration in older tetex distributions.  Known to not work:
3844 @c tetex-1.0.7, known to work: tetex-2.0.2.
3845 @ifset INTERNALS
3846 @node Pattern Ordering
3847 @section When the Order of Patterns Matters
3848 @cindex Pattern Ordering
3849 @cindex Ordering of Patterns
3850
3851 Sometimes an insn can match more than one instruction pattern.  Then the
3852 pattern that appears first in the machine description is the one used.
3853 Therefore, more specific patterns (patterns that will match fewer things)
3854 and faster instructions (those that will produce better code when they
3855 do match) should usually go first in the description.
3856
3857 In some cases the effect of ordering the patterns can be used to hide
3858 a pattern when it is not valid.  For example, the 68000 has an
3859 instruction for converting a fullword to floating point and another
3860 for converting a byte to floating point.  An instruction converting
3861 an integer to floating point could match either one.  We put the
3862 pattern to convert the fullword first to make sure that one will
3863 be used rather than the other.  (Otherwise a large integer might
3864 be generated as a single-byte immediate quantity, which would not work.)
3865 Instead of using this pattern ordering it would be possible to make the
3866 pattern for convert-a-byte smart enough to deal properly with any
3867 constant value.
3868
3869 @end ifset
3870 @ifset INTERNALS
3871 @node Dependent Patterns
3872 @section Interdependence of Patterns
3873 @cindex Dependent Patterns
3874 @cindex Interdependence of Patterns
3875
3876 Every machine description must have a named pattern for each of the
3877 conditional branch names @samp{b@var{cond}}.  The recognition template
3878 must always have the form
3879
3880 @smallexample
3881 (set (pc)
3882      (if_then_else (@var{cond} (cc0) (const_int 0))
3883                    (label_ref (match_operand 0 "" ""))
3884                    (pc)))
3885 @end smallexample
3886
3887 @noindent
3888 In addition, every machine description must have an anonymous pattern
3889 for each of the possible reverse-conditional branches.  Their templates
3890 look like
3891
3892 @smallexample
3893 (set (pc)
3894      (if_then_else (@var{cond} (cc0) (const_int 0))
3895                    (pc)
3896                    (label_ref (match_operand 0 "" ""))))
3897 @end smallexample
3898
3899 @noindent
3900 They are necessary because jump optimization can turn direct-conditional
3901 branches into reverse-conditional branches.
3902
3903 It is often convenient to use the @code{match_operator} construct to
3904 reduce the number of patterns that must be specified for branches.  For
3905 example,
3906
3907 @smallexample
3908 (define_insn ""
3909   [(set (pc)
3910         (if_then_else (match_operator 0 "comparison_operator"
3911                                       [(cc0) (const_int 0)])
3912                       (pc)
3913                       (label_ref (match_operand 1 "" ""))))]
3914   "@var{condition}"
3915   "@dots{}")
3916 @end smallexample
3917
3918 In some cases machines support instructions identical except for the
3919 machine mode of one or more operands.  For example, there may be
3920 ``sign-extend halfword'' and ``sign-extend byte'' instructions whose
3921 patterns are
3922
3923 @smallexample
3924 (set (match_operand:SI 0 @dots{})
3925      (extend:SI (match_operand:HI 1 @dots{})))
3926
3927 (set (match_operand:SI 0 @dots{})
3928      (extend:SI (match_operand:QI 1 @dots{})))
3929 @end smallexample
3930
3931 @noindent
3932 Constant integers do not specify a machine mode, so an instruction to
3933 extend a constant value could match either pattern.  The pattern it
3934 actually will match is the one that appears first in the file.  For correct
3935 results, this must be the one for the widest possible mode (@code{HImode},
3936 here).  If the pattern matches the @code{QImode} instruction, the results
3937 will be incorrect if the constant value does not actually fit that mode.
3938
3939 Such instructions to extend constants are rarely generated because they are
3940 optimized away, but they do occasionally happen in nonoptimized
3941 compilations.
3942
3943 If a constraint in a pattern allows a constant, the reload pass may
3944 replace a register with a constant permitted by the constraint in some
3945 cases.  Similarly for memory references.  Because of this substitution,
3946 you should not provide separate patterns for increment and decrement
3947 instructions.  Instead, they should be generated from the same pattern
3948 that supports register-register add insns by examining the operands and
3949 generating the appropriate machine instruction.
3950
3951 @end ifset
3952 @ifset INTERNALS
3953 @node Jump Patterns
3954 @section Defining Jump Instruction Patterns
3955 @cindex jump instruction patterns
3956 @cindex defining jump instruction patterns
3957
3958 For most machines, GCC assumes that the machine has a condition code.
3959 A comparison insn sets the condition code, recording the results of both
3960 signed and unsigned comparison of the given operands.  A separate branch
3961 insn tests the condition code and branches or not according its value.
3962 The branch insns come in distinct signed and unsigned flavors.  Many
3963 common machines, such as the VAX, the 68000 and the 32000, work this
3964 way.
3965
3966 Some machines have distinct signed and unsigned compare instructions, and
3967 only one set of conditional branch instructions.  The easiest way to handle
3968 these machines is to treat them just like the others until the final stage
3969 where assembly code is written.  At this time, when outputting code for the
3970 compare instruction, peek ahead at the following branch using
3971 @code{next_cc0_user (insn)}.  (The variable @code{insn} refers to the insn
3972 being output, in the output-writing code in an instruction pattern.)  If
3973 the RTL says that is an unsigned branch, output an unsigned compare;
3974 otherwise output a signed compare.  When the branch itself is output, you
3975 can treat signed and unsigned branches identically.
3976
3977 The reason you can do this is that GCC always generates a pair of
3978 consecutive RTL insns, possibly separated by @code{note} insns, one to
3979 set the condition code and one to test it, and keeps the pair inviolate
3980 until the end.
3981
3982 To go with this technique, you must define the machine-description macro
3983 @code{NOTICE_UPDATE_CC} to do @code{CC_STATUS_INIT}; in other words, no
3984 compare instruction is superfluous.
3985
3986 Some machines have compare-and-branch instructions and no condition code.
3987 A similar technique works for them.  When it is time to ``output'' a
3988 compare instruction, record its operands in two static variables.  When
3989 outputting the branch-on-condition-code instruction that follows, actually
3990 output a compare-and-branch instruction that uses the remembered operands.
3991
3992 It also works to define patterns for compare-and-branch instructions.
3993 In optimizing compilation, the pair of compare and branch instructions
3994 will be combined according to these patterns.  But this does not happen
3995 if optimization is not requested.  So you must use one of the solutions
3996 above in addition to any special patterns you define.
3997
3998 In many RISC machines, most instructions do not affect the condition
3999 code and there may not even be a separate condition code register.  On
4000 these machines, the restriction that the definition and use of the
4001 condition code be adjacent insns is not necessary and can prevent
4002 important optimizations.  For example, on the IBM RS/6000, there is a
4003 delay for taken branches unless the condition code register is set three
4004 instructions earlier than the conditional branch.  The instruction
4005 scheduler cannot perform this optimization if it is not permitted to
4006 separate the definition and use of the condition code register.
4007
4008 On these machines, do not use @code{(cc0)}, but instead use a register
4009 to represent the condition code.  If there is a specific condition code
4010 register in the machine, use a hard register.  If the condition code or
4011 comparison result can be placed in any general register, or if there are
4012 multiple condition registers, use a pseudo register.
4013
4014 @findex prev_cc0_setter
4015 @findex next_cc0_user
4016 On some machines, the type of branch instruction generated may depend on
4017 the way the condition code was produced; for example, on the 68k and
4018 SPARC, setting the condition code directly from an add or subtract
4019 instruction does not clear the overflow bit the way that a test
4020 instruction does, so a different branch instruction must be used for
4021 some conditional branches.  For machines that use @code{(cc0)}, the set
4022 and use of the condition code must be adjacent (separated only by
4023 @code{note} insns) allowing flags in @code{cc_status} to be used.
4024 (@xref{Condition Code}.)  Also, the comparison and branch insns can be
4025 located from each other by using the functions @code{prev_cc0_setter}
4026 and @code{next_cc0_user}.
4027
4028 However, this is not true on machines that do not use @code{(cc0)}.  On
4029 those machines, no assumptions can be made about the adjacency of the
4030 compare and branch insns and the above methods cannot be used.  Instead,
4031 we use the machine mode of the condition code register to record
4032 different formats of the condition code register.
4033
4034 Registers used to store the condition code value should have a mode that
4035 is in class @code{MODE_CC}.  Normally, it will be @code{CCmode}.  If
4036 additional modes are required (as for the add example mentioned above in
4037 the SPARC), define the macro @code{EXTRA_CC_MODES} to list the
4038 additional modes required (@pxref{Condition Code}).  Also define
4039 @code{SELECT_CC_MODE} to choose a mode given an operand of a compare.
4040
4041 If it is known during RTL generation that a different mode will be
4042 required (for example, if the machine has separate compare instructions
4043 for signed and unsigned quantities, like most IBM processors), they can
4044 be specified at that time.
4045
4046 If the cases that require different modes would be made by instruction
4047 combination, the macro @code{SELECT_CC_MODE} determines which machine
4048 mode should be used for the comparison result.  The patterns should be
4049 written using that mode.  To support the case of the add on the SPARC
4050 discussed above, we have the pattern
4051
4052 @smallexample
4053 (define_insn ""
4054   [(set (reg:CC_NOOV 0)
4055         (compare:CC_NOOV
4056           (plus:SI (match_operand:SI 0 "register_operand" "%r")
4057                    (match_operand:SI 1 "arith_operand" "rI"))
4058           (const_int 0)))]
4059   ""
4060   "@dots{}")
4061 @end smallexample
4062
4063 The @code{SELECT_CC_MODE} macro on the SPARC returns @code{CC_NOOVmode}
4064 for comparisons whose argument is a @code{plus}.
4065
4066 @end ifset
4067 @ifset INTERNALS
4068 @node Looping Patterns
4069 @section Defining Looping Instruction Patterns
4070 @cindex looping instruction patterns
4071 @cindex defining looping instruction patterns
4072
4073 Some machines have special jump instructions that can be utilized to
4074 make loops more efficient.  A common example is the 68000 @samp{dbra}
4075 instruction which performs a decrement of a register and a branch if the
4076 result was greater than zero.  Other machines, in particular digital
4077 signal processors (DSPs), have special block repeat instructions to
4078 provide low-overhead loop support.  For example, the TI TMS320C3x/C4x
4079 DSPs have a block repeat instruction that loads special registers to
4080 mark the top and end of a loop and to count the number of loop
4081 iterations.  This avoids the need for fetching and executing a
4082 @samp{dbra}-like instruction and avoids pipeline stalls associated with
4083 the jump.
4084
4085 GCC has three special named patterns to support low overhead looping.
4086 They are @samp{decrement_and_branch_until_zero}, @samp{doloop_begin},
4087 and @samp{doloop_end}.  The first pattern,
4088 @samp{decrement_and_branch_until_zero}, is not emitted during RTL
4089 generation but may be emitted during the instruction combination phase.
4090 This requires the assistance of the loop optimizer, using information
4091 collected during strength reduction, to reverse a loop to count down to
4092 zero.  Some targets also require the loop optimizer to add a
4093 @code{REG_NONNEG} note to indicate that the iteration count is always
4094 positive.  This is needed if the target performs a signed loop
4095 termination test.  For example, the 68000 uses a pattern similar to the
4096 following for its @code{dbra} instruction:
4097
4098 @smallexample
4099 @group
4100 (define_insn "decrement_and_branch_until_zero"
4101   [(set (pc)
4102         (if_then_else
4103           (ge (plus:SI (match_operand:SI 0 "general_operand" "+d*am")
4104                        (const_int -1))
4105               (const_int 0))
4106           (label_ref (match_operand 1 "" ""))
4107           (pc)))
4108    (set (match_dup 0)
4109         (plus:SI (match_dup 0)
4110                  (const_int -1)))]
4111   "find_reg_note (insn, REG_NONNEG, 0)"
4112   "@dots{}")
4113 @end group
4114 @end smallexample
4115
4116 Note that since the insn is both a jump insn and has an output, it must
4117 deal with its own reloads, hence the `m' constraints.  Also note that
4118 since this insn is generated by the instruction combination phase
4119 combining two sequential insns together into an implicit parallel insn,
4120 the iteration counter needs to be biased by the same amount as the
4121 decrement operation, in this case @minus{}1.  Note that the following similar
4122 pattern will not be matched by the combiner.
4123
4124 @smallexample
4125 @group
4126 (define_insn "decrement_and_branch_until_zero"
4127   [(set (pc)
4128         (if_then_else
4129           (ge (match_operand:SI 0 "general_operand" "+d*am")
4130               (const_int 1))
4131           (label_ref (match_operand 1 "" ""))
4132           (pc)))
4133    (set (match_dup 0)
4134         (plus:SI (match_dup 0)
4135                  (const_int -1)))]
4136   "find_reg_note (insn, REG_NONNEG, 0)"
4137   "@dots{}")
4138 @end group
4139 @end smallexample
4140
4141 The other two special looping patterns, @samp{doloop_begin} and
4142 @samp{doloop_end}, are emitted by the loop optimizer for certain
4143 well-behaved loops with a finite number of loop iterations using
4144 information collected during strength reduction.
4145
4146 The @samp{doloop_end} pattern describes the actual looping instruction
4147 (or the implicit looping operation) and the @samp{doloop_begin} pattern
4148 is an optional companion pattern that can be used for initialization
4149 needed for some low-overhead looping instructions.
4150
4151 Note that some machines require the actual looping instruction to be
4152 emitted at the top of the loop (e.g., the TMS320C3x/C4x DSPs).  Emitting
4153 the true RTL for a looping instruction at the top of the loop can cause
4154 problems with flow analysis.  So instead, a dummy @code{doloop} insn is
4155 emitted at the end of the loop.  The machine dependent reorg pass checks
4156 for the presence of this @code{doloop} insn and then searches back to
4157 the top of the loop, where it inserts the true looping insn (provided
4158 there are no instructions in the loop which would cause problems).  Any
4159 additional labels can be emitted at this point.  In addition, if the
4160 desired special iteration counter register was not allocated, this
4161 machine dependent reorg pass could emit a traditional compare and jump
4162 instruction pair.
4163
4164 The essential difference between the
4165 @samp{decrement_and_branch_until_zero} and the @samp{doloop_end}
4166 patterns is that the loop optimizer allocates an additional pseudo
4167 register for the latter as an iteration counter.  This pseudo register
4168 cannot be used within the loop (i.e., general induction variables cannot
4169 be derived from it), however, in many cases the loop induction variable
4170 may become redundant and removed by the flow pass.
4171
4172
4173 @end ifset
4174 @ifset INTERNALS
4175 @node Insn Canonicalizations
4176 @section Canonicalization of Instructions
4177 @cindex canonicalization of instructions
4178 @cindex insn canonicalization
4179
4180 There are often cases where multiple RTL expressions could represent an
4181 operation performed by a single machine instruction.  This situation is
4182 most commonly encountered with logical, branch, and multiply-accumulate
4183 instructions.  In such cases, the compiler attempts to convert these
4184 multiple RTL expressions into a single canonical form to reduce the
4185 number of insn patterns required.
4186
4187 In addition to algebraic simplifications, following canonicalizations
4188 are performed:
4189
4190 @itemize @bullet
4191 @item
4192 For commutative and comparison operators, a constant is always made the
4193 second operand.  If a machine only supports a constant as the second
4194 operand, only patterns that match a constant in the second operand need
4195 be supplied.
4196
4197 @item
4198 For associative operators, a sequence of operators will always chain
4199 to the left; for instance, only the left operand of an integer @code{plus}
4200 can itself be a @code{plus}.  @code{and}, @code{ior}, @code{xor},
4201 @code{plus}, @code{mult}, @code{smin}, @code{smax}, @code{umin}, and
4202 @code{umax} are associative when applied to integers, and sometimes to
4203 floating-point.
4204
4205 @item
4206 @cindex @code{neg}, canonicalization of
4207 @cindex @code{not}, canonicalization of
4208 @cindex @code{mult}, canonicalization of
4209 @cindex @code{plus}, canonicalization of
4210 @cindex @code{minus}, canonicalization of
4211 For these operators, if only one operand is a @code{neg}, @code{not},
4212 @code{mult}, @code{plus}, or @code{minus} expression, it will be the
4213 first operand.
4214
4215 @item
4216 In combinations of @code{neg}, @code{mult}, @code{plus}, and
4217 @code{minus}, the @code{neg} operations (if any) will be moved inside
4218 the operations as far as possible.  For instance,
4219 @code{(neg (mult A B))} is canonicalized as @code{(mult (neg A) B)}, but
4220 @code{(plus (mult (neg A) B) C)} is canonicalized as
4221 @code{(minus A (mult B C))}.
4222
4223 @cindex @code{compare}, canonicalization of
4224 @item
4225 For the @code{compare} operator, a constant is always the second operand
4226 on machines where @code{cc0} is used (@pxref{Jump Patterns}).  On other
4227 machines, there are rare cases where the compiler might want to construct
4228 a @code{compare} with a constant as the first operand.  However, these
4229 cases are not common enough for it to be worthwhile to provide a pattern
4230 matching a constant as the first operand unless the machine actually has
4231 such an instruction.
4232
4233 An operand of @code{neg}, @code{not}, @code{mult}, @code{plus}, or
4234 @code{minus} is made the first operand under the same conditions as
4235 above.
4236
4237 @item
4238 @code{(minus @var{x} (const_int @var{n}))} is converted to
4239 @code{(plus @var{x} (const_int @var{-n}))}.
4240
4241 @item
4242 Within address computations (i.e., inside @code{mem}), a left shift is
4243 converted into the appropriate multiplication by a power of two.
4244
4245 @cindex @code{ior}, canonicalization of
4246 @cindex @code{and}, canonicalization of
4247 @cindex De Morgan's law
4248 @item
4249 De Morgan's Law is used to move bitwise negation inside a bitwise
4250 logical-and or logical-or operation.  If this results in only one
4251 operand being a @code{not} expression, it will be the first one.
4252
4253 A machine that has an instruction that performs a bitwise logical-and of one
4254 operand with the bitwise negation of the other should specify the pattern
4255 for that instruction as
4256
4257 @smallexample
4258 (define_insn ""
4259   [(set (match_operand:@var{m} 0 @dots{})
4260         (and:@var{m} (not:@var{m} (match_operand:@var{m} 1 @dots{}))
4261                      (match_operand:@var{m} 2 @dots{})))]
4262   "@dots{}"
4263   "@dots{}")
4264 @end smallexample
4265
4266 @noindent
4267 Similarly, a pattern for a ``NAND'' instruction should be written
4268
4269 @smallexample
4270 (define_insn ""
4271   [(set (match_operand:@var{m} 0 @dots{})
4272         (ior:@var{m} (not:@var{m} (match_operand:@var{m} 1 @dots{}))
4273                      (not:@var{m} (match_operand:@var{m} 2 @dots{}))))]
4274   "@dots{}"
4275   "@dots{}")
4276 @end smallexample
4277
4278 In both cases, it is not necessary to include patterns for the many
4279 logically equivalent RTL expressions.
4280
4281 @cindex @code{xor}, canonicalization of
4282 @item
4283 The only possible RTL expressions involving both bitwise exclusive-or
4284 and bitwise negation are @code{(xor:@var{m} @var{x} @var{y})}
4285 and @code{(not:@var{m} (xor:@var{m} @var{x} @var{y}))}.
4286
4287 @item
4288 The sum of three items, one of which is a constant, will only appear in
4289 the form
4290
4291 @smallexample
4292 (plus:@var{m} (plus:@var{m} @var{x} @var{y}) @var{constant})
4293 @end smallexample
4294
4295 @item
4296 On machines that do not use @code{cc0},
4297 @code{(compare @var{x} (const_int 0))} will be converted to
4298 @var{x}.
4299
4300 @cindex @code{zero_extract}, canonicalization of
4301 @cindex @code{sign_extract}, canonicalization of
4302 @item
4303 Equality comparisons of a group of bits (usually a single bit) with zero
4304 will be written using @code{zero_extract} rather than the equivalent
4305 @code{and} or @code{sign_extract} operations.
4306
4307 @end itemize
4308
4309 @end ifset
4310 @ifset INTERNALS
4311 @node Expander Definitions
4312 @section Defining RTL Sequences for Code Generation
4313 @cindex expander definitions
4314 @cindex code generation RTL sequences
4315 @cindex defining RTL sequences for code generation
4316
4317 On some target machines, some standard pattern names for RTL generation
4318 cannot be handled with single insn, but a sequence of RTL insns can
4319 represent them.  For these target machines, you can write a
4320 @code{define_expand} to specify how to generate the sequence of RTL@.
4321
4322 @findex define_expand
4323 A @code{define_expand} is an RTL expression that looks almost like a
4324 @code{define_insn}; but, unlike the latter, a @code{define_expand} is used
4325 only for RTL generation and it can produce more than one RTL insn.
4326
4327 A @code{define_expand} RTX has four operands:
4328
4329 @itemize @bullet
4330 @item
4331 The name.  Each @code{define_expand} must have a name, since the only
4332 use for it is to refer to it by name.
4333
4334 @item
4335 The RTL template.  This is a vector of RTL expressions representing
4336 a sequence of separate instructions.  Unlike @code{define_insn}, there
4337 is no implicit surrounding @code{PARALLEL}.
4338
4339 @item
4340 The condition, a string containing a C expression.  This expression is
4341 used to express how the availability of this pattern depends on
4342 subclasses of target machine, selected by command-line options when GCC
4343 is run.  This is just like the condition of a @code{define_insn} that
4344 has a standard name.  Therefore, the condition (if present) may not
4345 depend on the data in the insn being matched, but only the
4346 target-machine-type flags.  The compiler needs to test these conditions
4347 during initialization in order to learn exactly which named instructions
4348 are available in a particular run.
4349
4350 @item
4351 The preparation statements, a string containing zero or more C
4352 statements which are to be executed before RTL code is generated from
4353 the RTL template.
4354
4355 Usually these statements prepare temporary registers for use as
4356 internal operands in the RTL template, but they can also generate RTL
4357 insns directly by calling routines such as @code{emit_insn}, etc.
4358 Any such insns precede the ones that come from the RTL template.
4359 @end itemize
4360
4361 Every RTL insn emitted by a @code{define_expand} must match some
4362 @code{define_insn} in the machine description.  Otherwise, the compiler
4363 will crash when trying to generate code for the insn or trying to optimize
4364 it.
4365
4366 The RTL template, in addition to controlling generation of RTL insns,
4367 also describes the operands that need to be specified when this pattern
4368 is used.  In particular, it gives a predicate for each operand.
4369
4370 A true operand, which needs to be specified in order to generate RTL from
4371 the pattern, should be described with a @code{match_operand} in its first
4372 occurrence in the RTL template.  This enters information on the operand's
4373 predicate into the tables that record such things.  GCC uses the
4374 information to preload the operand into a register if that is required for
4375 valid RTL code.  If the operand is referred to more than once, subsequent
4376 references should use @code{match_dup}.
4377
4378 The RTL template may also refer to internal ``operands'' which are
4379 temporary registers or labels used only within the sequence made by the
4380 @code{define_expand}.  Internal operands are substituted into the RTL
4381 template with @code{match_dup}, never with @code{match_operand}.  The
4382 values of the internal operands are not passed in as arguments by the
4383 compiler when it requests use of this pattern.  Instead,&nb