OSDN Git Service

56cc60f2e1e8d7120a029965946f55c33f5d7aea
[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, 2005, 2006 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 evaluates to true if @var{op} or a specified
902 subexpression of @var{op} has one of a given list of RTX codes.
903
904 The first operand of this expression is a string constant containing a
905 comma-separated list of RTX code names (in lower case).  These are the
906 codes for which the @code{MATCH_CODE} will be true.
907
908 The second operand is a string constant which indicates what
909 subexpression of @var{op} to examine.  If it is absent or the empty
910 string, @var{op} itself is examined.  Otherwise, the string constant
911 must be a sequence of digits and/or lowercase letters.  Each character
912 indicates a subexpression to extract from the current expression; for
913 the first character this is @var{op}, for the second and subsequent
914 characters it is the result of the previous character.  A digit
915 @var{n} extracts @samp{@w{XEXP (@var{e}, @var{n})}}; a letter @var{l}
916 extracts @samp{@w{XVECEXP (@var{e}, 0, @var{n})}} where @var{n} is the
917 alphabetic ordinal of @var{l} (0 for `a', 1 for 'b', and so on).  The
918 @code{MATCH_CODE} then examines the RTX code of the subexpression
919 extracted by the complete string.  It is not possible to extract
920 components of an @code{rtvec} that is not at position 0 within its RTX
921 object.
922
923 @item MATCH_TEST
924 This expression has one operand, a string constant containing a C
925 expression.  The predicate's arguments, @var{op} and @var{mode}, are
926 available with those names in the C expression.  The @code{MATCH_TEST}
927 evaluates to true if the C expression evaluates to a nonzero value.
928 @code{MATCH_TEST} expressions must not have side effects.
929
930 @item  AND
931 @itemx IOR
932 @itemx NOT
933 @itemx IF_THEN_ELSE
934 The basic @samp{MATCH_} expressions can be combined using these
935 logical operators, which have the semantics of the C operators
936 @samp{&&}, @samp{||}, @samp{!}, and @samp{@w{? :}} respectively.  As
937 in Common Lisp, you may give an @code{AND} or @code{IOR} expression an
938 arbitrary number of arguments; this has exactly the same effect as
939 writing a chain of two-argument @code{AND} or @code{IOR} expressions.
940 @end table
941
942 @item
943 An optional block of C code, which should execute
944 @samp{@w{return true}} if the predicate is found to match and
945 @samp{@w{return false}} if it does not.  It must not have any side
946 effects.  The predicate arguments, @var{op} and @var{mode}, are
947 available with those names.
948
949 If a code block is present in a predicate definition, then the RTL
950 expression must evaluate to true @emph{and} the code block must
951 execute @samp{@w{return true}} for the predicate to allow the operand.
952 The RTL expression is evaluated first; do not re-check anything in the
953 code block that was checked in the RTL expression.
954 @end itemize
955
956 The program @command{genrecog} scans @code{define_predicate} and
957 @code{define_special_predicate} expressions to determine which RTX
958 codes are possibly allowed.  You should always make this explicit in
959 the RTL predicate expression, using @code{MATCH_OPERAND} and
960 @code{MATCH_CODE}.
961
962 Here is an example of a simple predicate definition, from the IA64
963 machine description:
964
965 @smallexample
966 @group
967 ;; @r{True if @var{op} is a @code{SYMBOL_REF} which refers to the sdata section.}
968 (define_predicate "small_addr_symbolic_operand"
969   (and (match_code "symbol_ref")
970        (match_test "SYMBOL_REF_SMALL_ADDR_P (op)")))
971 @end group
972 @end smallexample
973
974 @noindent
975 And here is another, showing the use of the C block.
976
977 @smallexample
978 @group
979 ;; @r{True if @var{op} is a register operand that is (or could be) a GR reg.}
980 (define_predicate "gr_register_operand"
981   (match_operand 0 "register_operand")
982 @{
983   unsigned int regno;
984   if (GET_CODE (op) == SUBREG)
985     op = SUBREG_REG (op);
986
987   regno = REGNO (op);
988   return (regno >= FIRST_PSEUDO_REGISTER || GENERAL_REGNO_P (regno));
989 @})
990 @end group
991 @end smallexample
992
993 Predicates written with @code{define_predicate} automatically include
994 a test that @var{mode} is @code{VOIDmode}, or @var{op} has the same
995 mode as @var{mode}, or @var{op} is a @code{CONST_INT} or
996 @code{CONST_DOUBLE}.  They do @emph{not} check specifically for
997 integer @code{CONST_DOUBLE}, nor do they test that the value of either
998 kind of constant fits in the requested mode.  This is because
999 target-specific predicates that take constants usually have to do more
1000 stringent value checks anyway.  If you need the exact same treatment
1001 of @code{CONST_INT} or @code{CONST_DOUBLE} that the generic predicates
1002 provide, use a @code{MATCH_OPERAND} subexpression to call
1003 @code{const_int_operand}, @code{const_double_operand}, or
1004 @code{immediate_operand}.
1005
1006 Predicates written with @code{define_special_predicate} do not get any
1007 automatic mode checks, and are treated as having special mode handling
1008 by @command{genrecog}.
1009
1010 The program @command{genpreds} is responsible for generating code to
1011 test predicates.  It also writes a header file containing function
1012 declarations for all machine-specific predicates.  It is not necessary
1013 to declare these predicates in @file{@var{cpu}-protos.h}.
1014 @end ifset
1015
1016 @c Most of this node appears by itself (in a different place) even
1017 @c when the INTERNALS flag is clear.  Passages that require the internals
1018 @c manual's context are conditionalized to appear only in the internals manual.
1019 @ifset INTERNALS
1020 @node Constraints
1021 @section Operand Constraints
1022 @cindex operand constraints
1023 @cindex constraints
1024
1025 Each @code{match_operand} in an instruction pattern can specify
1026 constraints for the operands allowed.  The constraints allow you to
1027 fine-tune matching within the set of operands allowed by the
1028 predicate.
1029
1030 @end ifset
1031 @ifclear INTERNALS
1032 @node Constraints
1033 @section Constraints for @code{asm} Operands
1034 @cindex operand constraints, @code{asm}
1035 @cindex constraints, @code{asm}
1036 @cindex @code{asm} constraints
1037
1038 Here are specific details on what constraint letters you can use with
1039 @code{asm} operands.
1040 @end ifclear
1041 Constraints can say whether
1042 an operand may be in a register, and which kinds of register; whether the
1043 operand can be a memory reference, and which kinds of address; whether the
1044 operand may be an immediate constant, and which possible values it may
1045 have.  Constraints can also require two operands to match.
1046
1047 @ifset INTERNALS
1048 @menu
1049 * Simple Constraints::  Basic use of constraints.
1050 * Multi-Alternative::   When an insn has two alternative constraint-patterns.
1051 * Class Preferences::   Constraints guide which hard register to put things in.
1052 * Modifiers::           More precise control over effects of constraints.
1053 * Machine Constraints:: Existing constraints for some particular machines.
1054 * Define Constraints::  How to define machine-specific constraints.
1055 * C Constraint Interface:: How to test constraints from C code.
1056 @end menu
1057 @end ifset
1058
1059 @ifclear INTERNALS
1060 @menu
1061 * Simple Constraints::  Basic use of constraints.
1062 * Multi-Alternative::   When an insn has two alternative constraint-patterns.
1063 * Modifiers::           More precise control over effects of constraints.
1064 * Machine Constraints:: Special constraints for some particular machines.
1065 @end menu
1066 @end ifclear
1067
1068 @node Simple Constraints
1069 @subsection Simple Constraints
1070 @cindex simple constraints
1071
1072 The simplest kind of constraint is a string full of letters, each of
1073 which describes one kind of operand that is permitted.  Here are
1074 the letters that are allowed:
1075
1076 @table @asis
1077 @item whitespace
1078 Whitespace characters are ignored and can be inserted at any position
1079 except the first.  This enables each alternative for different operands to
1080 be visually aligned in the machine description even if they have different
1081 number of constraints and modifiers.
1082
1083 @cindex @samp{m} in constraint
1084 @cindex memory references in constraints
1085 @item @samp{m}
1086 A memory operand is allowed, with any kind of address that the machine
1087 supports in general.
1088
1089 @cindex offsettable address
1090 @cindex @samp{o} in constraint
1091 @item @samp{o}
1092 A memory operand is allowed, but only if the address is
1093 @dfn{offsettable}.  This means that adding a small integer (actually,
1094 the width in bytes of the operand, as determined by its machine mode)
1095 may be added to the address and the result is also a valid memory
1096 address.
1097
1098 @cindex autoincrement/decrement addressing
1099 For example, an address which is constant is offsettable; so is an
1100 address that is the sum of a register and a constant (as long as a
1101 slightly larger constant is also within the range of address-offsets
1102 supported by the machine); but an autoincrement or autodecrement
1103 address is not offsettable.  More complicated indirect/indexed
1104 addresses may or may not be offsettable depending on the other
1105 addressing modes that the machine supports.
1106
1107 Note that in an output operand which can be matched by another
1108 operand, the constraint letter @samp{o} is valid only when accompanied
1109 by both @samp{<} (if the target machine has predecrement addressing)
1110 and @samp{>} (if the target machine has preincrement addressing).
1111
1112 @cindex @samp{V} in constraint
1113 @item @samp{V}
1114 A memory operand that is not offsettable.  In other words, anything that
1115 would fit the @samp{m} constraint but not the @samp{o} constraint.
1116
1117 @cindex @samp{<} in constraint
1118 @item @samp{<}
1119 A memory operand with autodecrement addressing (either predecrement or
1120 postdecrement) is allowed.
1121
1122 @cindex @samp{>} in constraint
1123 @item @samp{>}
1124 A memory operand with autoincrement addressing (either preincrement or
1125 postincrement) is allowed.
1126
1127 @cindex @samp{r} in constraint
1128 @cindex registers in constraints
1129 @item @samp{r}
1130 A register operand is allowed provided that it is in a general
1131 register.
1132
1133 @cindex constants in constraints
1134 @cindex @samp{i} in constraint
1135 @item @samp{i}
1136 An immediate integer operand (one with constant value) is allowed.
1137 This includes symbolic constants whose values will be known only at
1138 assembly time or later.
1139
1140 @cindex @samp{n} in constraint
1141 @item @samp{n}
1142 An immediate integer operand with a known numeric value is allowed.
1143 Many systems cannot support assembly-time constants for operands less
1144 than a word wide.  Constraints for these operands should use @samp{n}
1145 rather than @samp{i}.
1146
1147 @cindex @samp{I} in constraint
1148 @item @samp{I}, @samp{J}, @samp{K}, @dots{} @samp{P}
1149 Other letters in the range @samp{I} through @samp{P} may be defined in
1150 a machine-dependent fashion to permit immediate integer operands with
1151 explicit integer values in specified ranges.  For example, on the
1152 68000, @samp{I} is defined to stand for the range of values 1 to 8.
1153 This is the range permitted as a shift count in the shift
1154 instructions.
1155
1156 @cindex @samp{E} in constraint
1157 @item @samp{E}
1158 An immediate floating operand (expression code @code{const_double}) is
1159 allowed, but only if the target floating point format is the same as
1160 that of the host machine (on which the compiler is running).
1161
1162 @cindex @samp{F} in constraint
1163 @item @samp{F}
1164 An immediate floating operand (expression code @code{const_double} or
1165 @code{const_vector}) is allowed.
1166
1167 @cindex @samp{G} in constraint
1168 @cindex @samp{H} in constraint
1169 @item @samp{G}, @samp{H}
1170 @samp{G} and @samp{H} may be defined in a machine-dependent fashion to
1171 permit immediate floating operands in particular ranges of values.
1172
1173 @cindex @samp{s} in constraint
1174 @item @samp{s}
1175 An immediate integer operand whose value is not an explicit integer is
1176 allowed.
1177
1178 This might appear strange; if an insn allows a constant operand with a
1179 value not known at compile time, it certainly must allow any known
1180 value.  So why use @samp{s} instead of @samp{i}?  Sometimes it allows
1181 better code to be generated.
1182
1183 For example, on the 68000 in a fullword instruction it is possible to
1184 use an immediate operand; but if the immediate value is between @minus{}128
1185 and 127, better code results from loading the value into a register and
1186 using the register.  This is because the load into the register can be
1187 done with a @samp{moveq} instruction.  We arrange for this to happen
1188 by defining the letter @samp{K} to mean ``any integer outside the
1189 range @minus{}128 to 127'', and then specifying @samp{Ks} in the operand
1190 constraints.
1191
1192 @cindex @samp{g} in constraint
1193 @item @samp{g}
1194 Any register, memory or immediate integer operand is allowed, except for
1195 registers that are not general registers.
1196
1197 @cindex @samp{X} in constraint
1198 @item @samp{X}
1199 @ifset INTERNALS
1200 Any operand whatsoever is allowed, even if it does not satisfy
1201 @code{general_operand}.  This is normally used in the constraint of
1202 a @code{match_scratch} when certain alternatives will not actually
1203 require a scratch register.
1204 @end ifset
1205 @ifclear INTERNALS
1206 Any operand whatsoever is allowed.
1207 @end ifclear
1208
1209 @cindex @samp{0} in constraint
1210 @cindex digits in constraint
1211 @item @samp{0}, @samp{1}, @samp{2}, @dots{} @samp{9}
1212 An operand that matches the specified operand number is allowed.  If a
1213 digit is used together with letters within the same alternative, the
1214 digit should come last.
1215
1216 This number is allowed to be more than a single digit.  If multiple
1217 digits are encountered consecutively, they are interpreted as a single
1218 decimal integer.  There is scant chance for ambiguity, since to-date
1219 it has never been desirable that @samp{10} be interpreted as matching
1220 either operand 1 @emph{or} operand 0.  Should this be desired, one
1221 can use multiple alternatives instead.
1222
1223 @cindex matching constraint
1224 @cindex constraint, matching
1225 This is called a @dfn{matching constraint} and what it really means is
1226 that the assembler has only a single operand that fills two roles
1227 @ifset INTERNALS
1228 considered separate in the RTL insn.  For example, an add insn has two
1229 input operands and one output operand in the RTL, but on most CISC
1230 @end ifset
1231 @ifclear INTERNALS
1232 which @code{asm} distinguishes.  For example, an add instruction uses
1233 two input operands and an output operand, but on most CISC
1234 @end ifclear
1235 machines an add instruction really has only two operands, one of them an
1236 input-output operand:
1237
1238 @smallexample
1239 addl #35,r12
1240 @end smallexample
1241
1242 Matching constraints are used in these circumstances.
1243 More precisely, the two operands that match must include one input-only
1244 operand and one output-only operand.  Moreover, the digit must be a
1245 smaller number than the number of the operand that uses it in the
1246 constraint.
1247
1248 @ifset INTERNALS
1249 For operands to match in a particular case usually means that they
1250 are identical-looking RTL expressions.  But in a few special cases
1251 specific kinds of dissimilarity are allowed.  For example, @code{*x}
1252 as an input operand will match @code{*x++} as an output operand.
1253 For proper results in such cases, the output template should always
1254 use the output-operand's number when printing the operand.
1255 @end ifset
1256
1257 @cindex load address instruction
1258 @cindex push address instruction
1259 @cindex address constraints
1260 @cindex @samp{p} in constraint
1261 @item @samp{p}
1262 An operand that is a valid memory address is allowed.  This is
1263 for ``load address'' and ``push address'' instructions.
1264
1265 @findex address_operand
1266 @samp{p} in the constraint must be accompanied by @code{address_operand}
1267 as the predicate in the @code{match_operand}.  This predicate interprets
1268 the mode specified in the @code{match_operand} as the mode of the memory
1269 reference for which the address would be valid.
1270
1271 @cindex other register constraints
1272 @cindex extensible constraints
1273 @item @var{other-letters}
1274 Other letters can be defined in machine-dependent fashion to stand for
1275 particular classes of registers or other arbitrary operand types.
1276 @samp{d}, @samp{a} and @samp{f} are defined on the 68000/68020 to stand
1277 for data, address and floating point registers.
1278 @end table
1279
1280 @ifset INTERNALS
1281 In order to have valid assembler code, each operand must satisfy
1282 its constraint.  But a failure to do so does not prevent the pattern
1283 from applying to an insn.  Instead, it directs the compiler to modify
1284 the code so that the constraint will be satisfied.  Usually this is
1285 done by copying an operand into a register.
1286
1287 Contrast, therefore, the two instruction patterns that follow:
1288
1289 @smallexample
1290 (define_insn ""
1291   [(set (match_operand:SI 0 "general_operand" "=r")
1292         (plus:SI (match_dup 0)
1293                  (match_operand:SI 1 "general_operand" "r")))]
1294   ""
1295   "@dots{}")
1296 @end smallexample
1297
1298 @noindent
1299 which has two operands, one of which must appear in two places, and
1300
1301 @smallexample
1302 (define_insn ""
1303   [(set (match_operand:SI 0 "general_operand" "=r")
1304         (plus:SI (match_operand:SI 1 "general_operand" "0")
1305                  (match_operand:SI 2 "general_operand" "r")))]
1306   ""
1307   "@dots{}")
1308 @end smallexample
1309
1310 @noindent
1311 which has three operands, two of which are required by a constraint to be
1312 identical.  If we are considering an insn of the form
1313
1314 @smallexample
1315 (insn @var{n} @var{prev} @var{next}
1316   (set (reg:SI 3)
1317        (plus:SI (reg:SI 6) (reg:SI 109)))
1318   @dots{})
1319 @end smallexample
1320
1321 @noindent
1322 the first pattern would not apply at all, because this insn does not
1323 contain two identical subexpressions in the right place.  The pattern would
1324 say, ``That does not look like an add instruction; try other patterns''.
1325 The second pattern would say, ``Yes, that's an add instruction, but there
1326 is something wrong with it''.  It would direct the reload pass of the
1327 compiler to generate additional insns to make the constraint true.  The
1328 results might look like this:
1329
1330 @smallexample
1331 (insn @var{n2} @var{prev} @var{n}
1332   (set (reg:SI 3) (reg:SI 6))
1333   @dots{})
1334
1335 (insn @var{n} @var{n2} @var{next}
1336   (set (reg:SI 3)
1337        (plus:SI (reg:SI 3) (reg:SI 109)))
1338   @dots{})
1339 @end smallexample
1340
1341 It is up to you to make sure that each operand, in each pattern, has
1342 constraints that can handle any RTL expression that could be present for
1343 that operand.  (When multiple alternatives are in use, each pattern must,
1344 for each possible combination of operand expressions, have at least one
1345 alternative which can handle that combination of operands.)  The
1346 constraints don't need to @emph{allow} any possible operand---when this is
1347 the case, they do not constrain---but they must at least point the way to
1348 reloading any possible operand so that it will fit.
1349
1350 @itemize @bullet
1351 @item
1352 If the constraint accepts whatever operands the predicate permits,
1353 there is no problem: reloading is never necessary for this operand.
1354
1355 For example, an operand whose constraints permit everything except
1356 registers is safe provided its predicate rejects registers.
1357
1358 An operand whose predicate accepts only constant values is safe
1359 provided its constraints include the letter @samp{i}.  If any possible
1360 constant value is accepted, then nothing less than @samp{i} will do;
1361 if the predicate is more selective, then the constraints may also be
1362 more selective.
1363
1364 @item
1365 Any operand expression can be reloaded by copying it into a register.
1366 So if an operand's constraints allow some kind of register, it is
1367 certain to be safe.  It need not permit all classes of registers; the
1368 compiler knows how to copy a register into another register of the
1369 proper class in order to make an instruction valid.
1370
1371 @cindex nonoffsettable memory reference
1372 @cindex memory reference, nonoffsettable
1373 @item
1374 A nonoffsettable memory reference can be reloaded by copying the
1375 address into a register.  So if the constraint uses the letter
1376 @samp{o}, all memory references are taken care of.
1377
1378 @item
1379 A constant operand can be reloaded by allocating space in memory to
1380 hold it as preinitialized data.  Then the memory reference can be used
1381 in place of the constant.  So if the constraint uses the letters
1382 @samp{o} or @samp{m}, constant operands are not a problem.
1383
1384 @item
1385 If the constraint permits a constant and a pseudo register used in an insn
1386 was not allocated to a hard register and is equivalent to a constant,
1387 the register will be replaced with the constant.  If the predicate does
1388 not permit a constant and the insn is re-recognized for some reason, the
1389 compiler will crash.  Thus the predicate must always recognize any
1390 objects allowed by the constraint.
1391 @end itemize
1392
1393 If the operand's predicate can recognize registers, but the constraint does
1394 not permit them, it can make the compiler crash.  When this operand happens
1395 to be a register, the reload pass will be stymied, because it does not know
1396 how to copy a register temporarily into memory.
1397
1398 If the predicate accepts a unary operator, the constraint applies to the
1399 operand.  For example, the MIPS processor at ISA level 3 supports an
1400 instruction which adds two registers in @code{SImode} to produce a
1401 @code{DImode} result, but only if the registers are correctly sign
1402 extended.  This predicate for the input operands accepts a
1403 @code{sign_extend} of an @code{SImode} register.  Write the constraint
1404 to indicate the type of register that is required for the operand of the
1405 @code{sign_extend}.
1406 @end ifset
1407
1408 @node Multi-Alternative
1409 @subsection Multiple Alternative Constraints
1410 @cindex multiple alternative constraints
1411
1412 Sometimes a single instruction has multiple alternative sets of possible
1413 operands.  For example, on the 68000, a logical-or instruction can combine
1414 register or an immediate value into memory, or it can combine any kind of
1415 operand into a register; but it cannot combine one memory location into
1416 another.
1417
1418 These constraints are represented as multiple alternatives.  An alternative
1419 can be described by a series of letters for each operand.  The overall
1420 constraint for an operand is made from the letters for this operand
1421 from the first alternative, a comma, the letters for this operand from
1422 the second alternative, a comma, and so on until the last alternative.
1423 @ifset INTERNALS
1424 Here is how it is done for fullword logical-or on the 68000:
1425
1426 @smallexample
1427 (define_insn "iorsi3"
1428   [(set (match_operand:SI 0 "general_operand" "=m,d")
1429         (ior:SI (match_operand:SI 1 "general_operand" "%0,0")
1430                 (match_operand:SI 2 "general_operand" "dKs,dmKs")))]
1431   @dots{})
1432 @end smallexample
1433
1434 The first alternative has @samp{m} (memory) for operand 0, @samp{0} for
1435 operand 1 (meaning it must match operand 0), and @samp{dKs} for operand
1436 2.  The second alternative has @samp{d} (data register) for operand 0,
1437 @samp{0} for operand 1, and @samp{dmKs} for operand 2.  The @samp{=} and
1438 @samp{%} in the constraints apply to all the alternatives; their
1439 meaning is explained in the next section (@pxref{Class Preferences}).
1440 @end ifset
1441
1442 @c FIXME Is this ? and ! stuff of use in asm()?  If not, hide unless INTERNAL
1443 If all the operands fit any one alternative, the instruction is valid.
1444 Otherwise, for each alternative, the compiler counts how many instructions
1445 must be added to copy the operands so that that alternative applies.
1446 The alternative requiring the least copying is chosen.  If two alternatives
1447 need the same amount of copying, the one that comes first is chosen.
1448 These choices can be altered with the @samp{?} and @samp{!} characters:
1449
1450 @table @code
1451 @cindex @samp{?} in constraint
1452 @cindex question mark
1453 @item ?
1454 Disparage slightly the alternative that the @samp{?} appears in,
1455 as a choice when no alternative applies exactly.  The compiler regards
1456 this alternative as one unit more costly for each @samp{?} that appears
1457 in it.
1458
1459 @cindex @samp{!} in constraint
1460 @cindex exclamation point
1461 @item !
1462 Disparage severely the alternative that the @samp{!} appears in.
1463 This alternative can still be used if it fits without reloading,
1464 but if reloading is needed, some other alternative will be used.
1465 @end table
1466
1467 @ifset INTERNALS
1468 When an insn pattern has multiple alternatives in its constraints, often
1469 the appearance of the assembler code is determined mostly by which
1470 alternative was matched.  When this is so, the C code for writing the
1471 assembler code can use the variable @code{which_alternative}, which is
1472 the ordinal number of the alternative that was actually satisfied (0 for
1473 the first, 1 for the second alternative, etc.).  @xref{Output Statement}.
1474 @end ifset
1475
1476 @ifset INTERNALS
1477 @node Class Preferences
1478 @subsection Register Class Preferences
1479 @cindex class preference constraints
1480 @cindex register class preference constraints
1481
1482 @cindex voting between constraint alternatives
1483 The operand constraints have another function: they enable the compiler
1484 to decide which kind of hardware register a pseudo register is best
1485 allocated to.  The compiler examines the constraints that apply to the
1486 insns that use the pseudo register, looking for the machine-dependent
1487 letters such as @samp{d} and @samp{a} that specify classes of registers.
1488 The pseudo register is put in whichever class gets the most ``votes''.
1489 The constraint letters @samp{g} and @samp{r} also vote: they vote in
1490 favor of a general register.  The machine description says which registers
1491 are considered general.
1492
1493 Of course, on some machines all registers are equivalent, and no register
1494 classes are defined.  Then none of this complexity is relevant.
1495 @end ifset
1496
1497 @node Modifiers
1498 @subsection Constraint Modifier Characters
1499 @cindex modifiers in constraints
1500 @cindex constraint modifier characters
1501
1502 @c prevent bad page break with this line
1503 Here are constraint modifier characters.
1504
1505 @table @samp
1506 @cindex @samp{=} in constraint
1507 @item =
1508 Means that this operand is write-only for this instruction: the previous
1509 value is discarded and replaced by output data.
1510
1511 @cindex @samp{+} in constraint
1512 @item +
1513 Means that this operand is both read and written by the instruction.
1514
1515 When the compiler fixes up the operands to satisfy the constraints,
1516 it needs to know which operands are inputs to the instruction and
1517 which are outputs from it.  @samp{=} identifies an output; @samp{+}
1518 identifies an operand that is both input and output; all other operands
1519 are assumed to be input only.
1520
1521 If you specify @samp{=} or @samp{+} in a constraint, you put it in the
1522 first character of the constraint string.
1523
1524 @cindex @samp{&} in constraint
1525 @cindex earlyclobber operand
1526 @item &
1527 Means (in a particular alternative) that this operand is an
1528 @dfn{earlyclobber} operand, which is modified before the instruction is
1529 finished using the input operands.  Therefore, this operand may not lie
1530 in a register that is used as an input operand or as part of any memory
1531 address.
1532
1533 @samp{&} applies only to the alternative in which it is written.  In
1534 constraints with multiple alternatives, sometimes one alternative
1535 requires @samp{&} while others do not.  See, for example, the
1536 @samp{movdf} insn of the 68000.
1537
1538 An input operand can be tied to an earlyclobber operand if its only
1539 use as an input occurs before the early result is written.  Adding
1540 alternatives of this form often allows GCC to produce better code
1541 when only some of the inputs can be affected by the earlyclobber.
1542 See, for example, the @samp{mulsi3} insn of the ARM@.
1543
1544 @samp{&} does not obviate the need to write @samp{=}.
1545
1546 @cindex @samp{%} in constraint
1547 @item %
1548 Declares the instruction to be commutative for this operand and the
1549 following operand.  This means that the compiler may interchange the
1550 two operands if that is the cheapest way to make all operands fit the
1551 constraints.
1552 @ifset INTERNALS
1553 This is often used in patterns for addition instructions
1554 that really have only two operands: the result must go in one of the
1555 arguments.  Here for example, is how the 68000 halfword-add
1556 instruction is defined:
1557
1558 @smallexample
1559 (define_insn "addhi3"
1560   [(set (match_operand:HI 0 "general_operand" "=m,r")
1561      (plus:HI (match_operand:HI 1 "general_operand" "%0,0")
1562               (match_operand:HI 2 "general_operand" "di,g")))]
1563   @dots{})
1564 @end smallexample
1565 @end ifset
1566 GCC can only handle one commutative pair in an asm; if you use more,
1567 the compiler may fail.  Note that you need not use the modifier if
1568 the two alternatives are strictly identical; this would only waste
1569 time in the reload pass.  The modifier is not operational after
1570 register allocation, so the result of @code{define_peephole2}
1571 and @code{define_split}s performed after reload cannot rely on
1572 @samp{%} to make the intended insn match.
1573
1574 @cindex @samp{#} in constraint
1575 @item #
1576 Says that all following characters, up to the next comma, are to be
1577 ignored as a constraint.  They are significant only for choosing
1578 register preferences.
1579
1580 @cindex @samp{*} in constraint
1581 @item *
1582 Says that the following character should be ignored when choosing
1583 register preferences.  @samp{*} has no effect on the meaning of the
1584 constraint as a constraint, and no effect on reloading.
1585
1586 @ifset INTERNALS
1587 Here is an example: the 68000 has an instruction to sign-extend a
1588 halfword in a data register, and can also sign-extend a value by
1589 copying it into an address register.  While either kind of register is
1590 acceptable, the constraints on an address-register destination are
1591 less strict, so it is best if register allocation makes an address
1592 register its goal.  Therefore, @samp{*} is used so that the @samp{d}
1593 constraint letter (for data register) is ignored when computing
1594 register preferences.
1595
1596 @smallexample
1597 (define_insn "extendhisi2"
1598   [(set (match_operand:SI 0 "general_operand" "=*d,a")
1599         (sign_extend:SI
1600          (match_operand:HI 1 "general_operand" "0,g")))]
1601   @dots{})
1602 @end smallexample
1603 @end ifset
1604 @end table
1605
1606 @node Machine Constraints
1607 @subsection Constraints for Particular Machines
1608 @cindex machine specific constraints
1609 @cindex constraints, machine specific
1610
1611 Whenever possible, you should use the general-purpose constraint letters
1612 in @code{asm} arguments, since they will convey meaning more readily to
1613 people reading your code.  Failing that, use the constraint letters
1614 that usually have very similar meanings across architectures.  The most
1615 commonly used constraints are @samp{m} and @samp{r} (for memory and
1616 general-purpose registers respectively; @pxref{Simple Constraints}), and
1617 @samp{I}, usually the letter indicating the most common
1618 immediate-constant format.
1619
1620 Each architecture defines additional constraints.  These constraints
1621 are used by the compiler itself for instruction generation, as well as
1622 for @code{asm} statements; therefore, some of the constraints are not
1623 particularly useful for @code{asm}.  Here is a summary of some of the
1624 machine-dependent constraints available on some particular machines;
1625 it includes both constraints that are useful for @code{asm} and
1626 constraints that aren't.  The compiler source file mentioned in the
1627 table heading for each architecture is the definitive reference for
1628 the meanings of that architecture's constraints.
1629  
1630 @table @emph
1631 @item ARM family---@file{config/arm/arm.h}
1632 @table @code
1633 @item f
1634 Floating-point register
1635
1636 @item w
1637 VFP floating-point register
1638
1639 @item F
1640 One of the floating-point constants 0.0, 0.5, 1.0, 2.0, 3.0, 4.0, 5.0
1641 or 10.0
1642
1643 @item G
1644 Floating-point constant that would satisfy the constraint @samp{F} if it
1645 were negated
1646
1647 @item I
1648 Integer that is valid as an immediate operand in a data processing
1649 instruction.  That is, an integer in the range 0 to 255 rotated by a
1650 multiple of 2
1651
1652 @item J
1653 Integer in the range @minus{}4095 to 4095
1654
1655 @item K
1656 Integer that satisfies constraint @samp{I} when inverted (ones complement)
1657
1658 @item L
1659 Integer that satisfies constraint @samp{I} when negated (twos complement)
1660
1661 @item M
1662 Integer in the range 0 to 32
1663
1664 @item Q
1665 A memory reference where the exact address is in a single register
1666 (`@samp{m}' is preferable for @code{asm} statements)
1667
1668 @item R
1669 An item in the constant pool
1670
1671 @item S
1672 A symbol in the text segment of the current file
1673
1674 @item Uv
1675 A memory reference suitable for VFP load/store insns (reg+constant offset)
1676
1677 @item Uy
1678 A memory reference suitable for iWMMXt load/store instructions.
1679
1680 @item Uq
1681 A memory reference suitable for the ARMv4 ldrsb instruction.
1682 @end table
1683
1684 @item AVR family---@file{config/avr/constraints.md}
1685 @table @code
1686 @item l
1687 Registers from r0 to r15
1688
1689 @item a
1690 Registers from r16 to r23
1691
1692 @item d
1693 Registers from r16 to r31
1694
1695 @item w
1696 Registers from r24 to r31.  These registers can be used in @samp{adiw} command
1697
1698 @item e
1699 Pointer register (r26--r31)
1700
1701 @item b
1702 Base pointer register (r28--r31)
1703
1704 @item q
1705 Stack pointer register (SPH:SPL)
1706
1707 @item t
1708 Temporary register r0
1709
1710 @item x
1711 Register pair X (r27:r26)
1712
1713 @item y
1714 Register pair Y (r29:r28)
1715
1716 @item z
1717 Register pair Z (r31:r30)
1718
1719 @item I
1720 Constant greater than @minus{}1, less than 64
1721
1722 @item J
1723 Constant greater than @minus{}64, less than 1
1724
1725 @item K
1726 Constant integer 2
1727
1728 @item L
1729 Constant integer 0
1730
1731 @item M
1732 Constant that fits in 8 bits
1733
1734 @item N
1735 Constant integer @minus{}1
1736
1737 @item O
1738 Constant integer 8, 16, or 24
1739
1740 @item P
1741 Constant integer 1
1742
1743 @item G
1744 A floating point constant 0.0
1745 @end table
1746
1747 @item CRX Architecture---@file{config/crx/crx.h}
1748 @table @code
1749
1750 @item b
1751 Registers from r0 to r14 (registers without stack pointer)
1752
1753 @item l
1754 Register r16 (64-bit accumulator lo register)
1755
1756 @item h
1757 Register r17 (64-bit accumulator hi register)
1758
1759 @item k
1760 Register pair r16-r17. (64-bit accumulator lo-hi pair)
1761
1762 @item I
1763 Constant that fits in 3 bits
1764
1765 @item J
1766 Constant that fits in 4 bits
1767
1768 @item K
1769 Constant that fits in 5 bits
1770
1771 @item L
1772 Constant that is one of -1, 4, -4, 7, 8, 12, 16, 20, 32, 48
1773
1774 @item G
1775 Floating point constant that is legal for store immediate
1776 @end table
1777
1778 @item PowerPC and IBM RS6000---@file{config/rs6000/rs6000.h}
1779 @table @code
1780 @item b
1781 Address base register
1782
1783 @item f
1784 Floating point register
1785
1786 @item v
1787 Vector register
1788
1789 @item h
1790 @samp{MQ}, @samp{CTR}, or @samp{LINK} register
1791
1792 @item q
1793 @samp{MQ} register
1794
1795 @item c
1796 @samp{CTR} register
1797
1798 @item l
1799 @samp{LINK} register
1800
1801 @item x
1802 @samp{CR} register (condition register) number 0
1803
1804 @item y
1805 @samp{CR} register (condition register)
1806
1807 @item z
1808 @samp{FPMEM} stack memory for FPR-GPR transfers
1809
1810 @item I
1811 Signed 16-bit constant
1812
1813 @item J
1814 Unsigned 16-bit constant shifted left 16 bits (use @samp{L} instead for
1815 @code{SImode} constants)
1816
1817 @item K
1818 Unsigned 16-bit constant
1819
1820 @item L
1821 Signed 16-bit constant shifted left 16 bits
1822
1823 @item M
1824 Constant larger than 31
1825
1826 @item N
1827 Exact power of 2
1828
1829 @item O
1830 Zero
1831
1832 @item P
1833 Constant whose negation is a signed 16-bit constant
1834
1835 @item G
1836 Floating point constant that can be loaded into a register with one
1837 instruction per word
1838
1839 @item H
1840 Integer/Floating point constant that can be loaded into a register using
1841 three instructions
1842
1843 @item Q
1844 Memory operand that is an offset from a register (@samp{m} is preferable
1845 for @code{asm} statements)
1846
1847 @item Z
1848 Memory operand that is an indexed or indirect from a register (@samp{m} is
1849 preferable for @code{asm} statements)
1850
1851 @item R
1852 AIX TOC entry
1853
1854 @item a
1855 Address operand that is an indexed or indirect from a register (@samp{p} is
1856 preferable for @code{asm} statements)
1857
1858 @item S
1859 Constant suitable as a 64-bit mask operand
1860
1861 @item T
1862 Constant suitable as a 32-bit mask operand
1863
1864 @item U
1865 System V Release 4 small data area reference
1866
1867 @item t
1868 AND masks that can be performed by two rldic@{l, r@} instructions
1869
1870 @item W
1871 Vector constant that does not require memory
1872
1873 @end table
1874
1875 @item MorphoTech family---@file{config/mt/mt.h}
1876 @table @code
1877 @item I
1878 Constant for an arithmetic insn (16-bit signed integer).
1879
1880 @item J
1881 The constant 0.
1882
1883 @item K
1884 Constant for a logical insn (16-bit zero-extended integer).
1885
1886 @item L
1887 A constant that can be loaded with @code{lui} (i.e.@: the bottom 16
1888 bits are zero).
1889
1890 @item M
1891 A constant that takes two words to load (i.e.@: not matched by
1892 @code{I}, @code{K}, or @code{L}).
1893
1894 @item N
1895 Negative 16-bit constants other than -65536.
1896
1897 @item O
1898 A 15-bit signed integer constant.
1899
1900 @item P
1901 A positive 16-bit constant.
1902 @end table
1903
1904 @item Intel 386---@file{config/i386/constraints.md}
1905 @table @code
1906 @item R
1907 Legacy register---the eight integer registers available on all
1908 i386 processors (@code{a}, @code{b}, @code{c}, @code{d},
1909 @code{si}, @code{di}, @code{bp}, @code{sp}).
1910
1911 @item q
1912 Any register accessible as @code{@var{r}l}.  In 32-bit mode, @code{a},
1913 @code{b}, @code{c}, and @code{d}; in 64-bit mode, any integer register.
1914
1915 @item Q
1916 Any register accessible as @code{@var{r}h}: @code{a}, @code{b},
1917 @code{c}, and @code{d}.
1918
1919 @ifset INTERNALS
1920 @item l
1921 Any register that can be used as the index in a base+index memory
1922 access: that is, any general register except the stack pointer.
1923 @end ifset
1924
1925 @item a
1926 The @code{a} register.
1927
1928 @item b
1929 The @code{b} register.
1930
1931 @item c
1932 The @code{c} register.
1933
1934 @item d
1935 The @code{d} register.
1936
1937 @item S
1938 The @code{si} register.
1939
1940 @item D
1941 The @code{di} register.
1942
1943 @item A
1944 The @code{a} and @code{d} registers, as a pair (for instructions that
1945 return half the result in one and half in the other).
1946
1947 @item f
1948 Any 80387 floating-point (stack) register.
1949
1950 @item t
1951 Top of 80387 floating-point stack (@code{%st(0)}).
1952
1953 @item u
1954 Second from top of 80387 floating-point stack (@code{%st(1)}).
1955
1956 @item y
1957 Any MMX register.
1958
1959 @item x
1960 Any SSE register.
1961
1962 @ifset INTERNALS
1963 @item Y
1964 Any SSE2 register.
1965 @end ifset
1966
1967 @item I
1968 Integer constant in the range 0 @dots{} 31, for 32-bit shifts.
1969
1970 @item J
1971 Integer constant in the range 0 @dots{} 63, for 64-bit shifts.
1972
1973 @item K
1974 Signed 8-bit integer constant.
1975
1976 @item L
1977 @code{0xFF} or @code{0xFFFF}, for andsi as a zero-extending move.
1978
1979 @item M
1980 0, 1, 2, or 3 (shifts for the @code{lea} instruction).
1981
1982 @item N
1983 Unsigned 8-bit integer constant (for @code{in} and @code{out} 
1984 instructions).
1985
1986 @ifset INTERNALS
1987 @item O
1988 Integer constant in the range 0 @dots{} 127, for 128-bit shifts.
1989 @end ifset
1990
1991 @item G
1992 Standard 80387 floating point constant.
1993
1994 @item C
1995 Standard SSE floating point constant.
1996
1997 @item e
1998 32-bit signed integer constant, or a symbolic reference known
1999 to fit that range (for immediate operands in sign-extending x86-64
2000 instructions).
2001
2002 @item Z
2003 32-bit unsigned integer constant, or a symbolic reference known
2004 to fit that range (for immediate operands in zero-extending x86-64
2005 instructions).
2006
2007 @end table
2008
2009 @item Intel IA-64---@file{config/ia64/ia64.h}
2010 @table @code
2011 @item a
2012 General register @code{r0} to @code{r3} for @code{addl} instruction
2013
2014 @item b
2015 Branch register
2016
2017 @item c
2018 Predicate register (@samp{c} as in ``conditional'')
2019
2020 @item d
2021 Application register residing in M-unit
2022
2023 @item e
2024 Application register residing in I-unit
2025
2026 @item f
2027 Floating-point register
2028
2029 @item m
2030 Memory operand.
2031 Remember that @samp{m} allows postincrement and postdecrement which
2032 require printing with @samp{%Pn} on IA-64.
2033 Use @samp{S} to disallow postincrement and postdecrement.
2034
2035 @item G
2036 Floating-point constant 0.0 or 1.0
2037
2038 @item I
2039 14-bit signed integer constant
2040
2041 @item J
2042 22-bit signed integer constant
2043
2044 @item K
2045 8-bit signed integer constant for logical instructions
2046
2047 @item L
2048 8-bit adjusted signed integer constant for compare pseudo-ops
2049
2050 @item M
2051 6-bit unsigned integer constant for shift counts
2052
2053 @item N
2054 9-bit signed integer constant for load and store postincrements
2055
2056 @item O
2057 The constant zero
2058
2059 @item P
2060 0 or @minus{}1 for @code{dep} instruction
2061
2062 @item Q
2063 Non-volatile memory for floating-point loads and stores
2064
2065 @item R
2066 Integer constant in the range 1 to 4 for @code{shladd} instruction
2067
2068 @item S
2069 Memory operand except postincrement and postdecrement
2070 @end table
2071
2072 @item FRV---@file{config/frv/frv.h}
2073 @table @code
2074 @item a
2075 Register in the class @code{ACC_REGS} (@code{acc0} to @code{acc7}).
2076
2077 @item b
2078 Register in the class @code{EVEN_ACC_REGS} (@code{acc0} to @code{acc7}).
2079
2080 @item c
2081 Register in the class @code{CC_REGS} (@code{fcc0} to @code{fcc3} and
2082 @code{icc0} to @code{icc3}).
2083
2084 @item d
2085 Register in the class @code{GPR_REGS} (@code{gr0} to @code{gr63}).
2086
2087 @item e
2088 Register in the class @code{EVEN_REGS} (@code{gr0} to @code{gr63}).
2089 Odd registers are excluded not in the class but through the use of a machine
2090 mode larger than 4 bytes.
2091
2092 @item f
2093 Register in the class @code{FPR_REGS} (@code{fr0} to @code{fr63}).
2094
2095 @item h
2096 Register in the class @code{FEVEN_REGS} (@code{fr0} to @code{fr63}).
2097 Odd registers are excluded not in the class but through the use of a machine
2098 mode larger than 4 bytes.
2099
2100 @item l
2101 Register in the class @code{LR_REG} (the @code{lr} register).
2102
2103 @item q
2104 Register in the class @code{QUAD_REGS} (@code{gr2} to @code{gr63}).
2105 Register numbers not divisible by 4 are excluded not in the class but through
2106 the use of a machine mode larger than 8 bytes.
2107
2108 @item t
2109 Register in the class @code{ICC_REGS} (@code{icc0} to @code{icc3}).
2110
2111 @item u
2112 Register in the class @code{FCC_REGS} (@code{fcc0} to @code{fcc3}).
2113
2114 @item v
2115 Register in the class @code{ICR_REGS} (@code{cc4} to @code{cc7}).
2116
2117 @item w
2118 Register in the class @code{FCR_REGS} (@code{cc0} to @code{cc3}).
2119
2120 @item x
2121 Register in the class @code{QUAD_FPR_REGS} (@code{fr0} to @code{fr63}).
2122 Register numbers not divisible by 4 are excluded not in the class but through
2123 the use of a machine mode larger than 8 bytes.
2124
2125 @item z
2126 Register in the class @code{SPR_REGS} (@code{lcr} and @code{lr}).
2127
2128 @item A
2129 Register in the class @code{QUAD_ACC_REGS} (@code{acc0} to @code{acc7}).
2130
2131 @item B
2132 Register in the class @code{ACCG_REGS} (@code{accg0} to @code{accg7}).
2133
2134 @item C
2135 Register in the class @code{CR_REGS} (@code{cc0} to @code{cc7}).
2136
2137 @item G
2138 Floating point constant zero
2139
2140 @item I
2141 6-bit signed integer constant
2142
2143 @item J
2144 10-bit signed integer constant
2145
2146 @item L
2147 16-bit signed integer constant
2148
2149 @item M
2150 16-bit unsigned integer constant
2151
2152 @item N
2153 12-bit signed integer constant that is negative---i.e.@: in the
2154 range of @minus{}2048 to @minus{}1
2155
2156 @item O
2157 Constant zero
2158
2159 @item P
2160 12-bit signed integer constant that is greater than zero---i.e.@: in the
2161 range of 1 to 2047.
2162
2163 @end table
2164
2165 @item Blackfin family---@file{config/bfin/bfin.h}
2166 @table @code
2167 @item a
2168 P register
2169
2170 @item d
2171 D register
2172
2173 @item z
2174 A call clobbered P register.
2175
2176 @item D
2177 Even-numbered D register
2178
2179 @item W
2180 Odd-numbered D register
2181
2182 @item e
2183 Accumulator register.
2184
2185 @item A
2186 Even-numbered accumulator register.
2187
2188 @item B
2189 Odd-numbered accumulator register.
2190
2191 @item b
2192 I register
2193
2194 @item v
2195 B register
2196
2197 @item f
2198 M register
2199
2200 @item c
2201 Registers used for circular buffering, i.e. I, B, or L registers.
2202
2203 @item C
2204 The CC register.
2205
2206 @item t
2207 LT0 or LT1.
2208
2209 @item k
2210 LC0 or LC1.
2211
2212 @item u
2213 LB0 or LB1.
2214
2215 @item x
2216 Any D, P, B, M, I or L register.
2217
2218 @item y
2219 Additional registers typically used only in prologues and epilogues: RETS,
2220 RETN, RETI, RETX, RETE, ASTAT, SEQSTAT and USP.
2221
2222 @item w
2223 Any register except accumulators or CC.
2224
2225 @item Ksh
2226 Signed 16 bit integer (in the range -32768 to 32767)
2227
2228 @item Kuh
2229 Unsigned 16 bit integer (in the range 0 to 65535)
2230
2231 @item Ks7
2232 Signed 7 bit integer (in the range -64 to 63)
2233
2234 @item Ku7
2235 Unsigned 7 bit integer (in the range 0 to 127)
2236
2237 @item Ku5
2238 Unsigned 5 bit integer (in the range 0 to 31)
2239
2240 @item Ks4
2241 Signed 4 bit integer (in the range -8 to 7)
2242
2243 @item Ks3
2244 Signed 3 bit integer (in the range -3 to 4)
2245
2246 @item Ku3
2247 Unsigned 3 bit integer (in the range 0 to 7)
2248
2249 @item P@var{n}
2250 Constant @var{n}, where @var{n} is a single-digit constant in the range 0 to 4.
2251
2252 @item PA
2253 An integer equal to one of the MACFLAG_XXX constants that is suitable for
2254 use with either accumulator.
2255
2256 @item PB
2257 An integer equal to one of the MACFLAG_XXX constants that is suitable for
2258 use only with accumulator A1.
2259
2260 @item M1
2261 Constant 255.
2262
2263 @item M2
2264 Constant 65535.
2265
2266 @item J
2267 An integer constant with exactly a single bit set.
2268
2269 @item L
2270 An integer constant with all bits set except exactly one.
2271
2272 @item H
2273
2274 @item Q
2275 Any SYMBOL_REF.
2276 @end table
2277
2278 @item M32C---@file{config/m32c/m32c.c}
2279 @table @code
2280 @item Rsp
2281 @itemx Rfb
2282 @itemx Rsb
2283 @samp{$sp}, @samp{$fb}, @samp{$sb}.
2284
2285 @item Rcr
2286 Any control register, when they're 16 bits wide (nothing if control
2287 registers are 24 bits wide)
2288
2289 @item Rcl
2290 Any control register, when they're 24 bits wide.
2291
2292 @item R0w
2293 @itemx R1w
2294 @itemx R2w
2295 @itemx R3w
2296 $r0, $r1, $r2, $r3.
2297
2298 @item R02
2299 $r0 or $r2, or $r2r0 for 32 bit values.
2300
2301 @item R13
2302 $r1 or $r3, or $r3r1 for 32 bit values.
2303
2304 @item Rdi
2305 A register that can hold a 64 bit value.
2306
2307 @item Rhl
2308 $r0 or $r1 (registers with addressable high/low bytes)
2309
2310 @item R23
2311 $r2 or $r3
2312
2313 @item Raa
2314 Address registers
2315
2316 @item Raw
2317 Address registers when they're 16 bits wide.
2318
2319 @item Ral
2320 Address registers when they're 24 bits wide.
2321
2322 @item Rqi
2323 Registers that can hold QI values.
2324
2325 @item Rad
2326 Registers that can be used with displacements ($a0, $a1, $sb).
2327
2328 @item Rsi
2329 Registers that can hold 32 bit values.
2330
2331 @item Rhi
2332 Registers that can hold 16 bit values.
2333
2334 @item Rhc
2335 Registers chat can hold 16 bit values, including all control
2336 registers.
2337
2338 @item Rra
2339 $r0 through R1, plus $a0 and $a1.
2340
2341 @item Rfl
2342 The flags register.
2343
2344 @item Rmm
2345 The memory-based pseudo-registers $mem0 through $mem15.
2346
2347 @item Rpi
2348 Registers that can hold pointers (16 bit registers for r8c, m16c; 24
2349 bit registers for m32cm, m32c).
2350
2351 @item Rpa
2352 Matches multiple registers in a PARALLEL to form a larger register.
2353 Used to match function return values.
2354
2355 @item Is3
2356 -8 @dots{} 7
2357
2358 @item IS1
2359 -128 @dots{} 127
2360
2361 @item IS2
2362 -32768 @dots{} 32767
2363
2364 @item IU2
2365 0 @dots{} 65535
2366
2367 @item In4
2368 -8 @dots{} -1 or 1 @dots{} 8
2369
2370 @item In5
2371 -16 @dots{} -1 or 1 @dots{} 16
2372
2373 @item In6
2374 -32 @dots{} -1 or 1 @dots{} 32
2375
2376 @item IM2
2377 -65536 @dots{} -1
2378
2379 @item Ilb
2380 An 8 bit value with exactly one bit set.
2381
2382 @item Ilw
2383 A 16 bit value with exactly one bit set.
2384
2385 @item Sd
2386 The common src/dest memory addressing modes.
2387
2388 @item Sa
2389 Memory addressed using $a0 or $a1.
2390
2391 @item Si
2392 Memory addressed with immediate addresses.
2393
2394 @item Ss
2395 Memory addressed using the stack pointer ($sp).
2396
2397 @item Sf
2398 Memory addressed using the frame base register ($fb).
2399
2400 @item Ss
2401 Memory addressed using the small base register ($sb).
2402
2403 @item S1
2404 $r1h
2405 @end table
2406
2407 @item MIPS---@file{config/mips/constraints.md}
2408 @table @code
2409 @item d
2410 An address register.  This is equivalent to @code{r} unless
2411 generating MIPS16 code.
2412
2413 @item f
2414 A floating-point register (if available).
2415
2416 @item h
2417 The @code{hi} register.
2418
2419 @item l
2420 The @code{lo} register.
2421
2422 @item x
2423 The @code{hi} and @code{lo} registers.
2424
2425 @item c
2426 A register suitable for use in an indirect jump.  This will always be
2427 @code{$25} for @option{-mabicalls}.
2428
2429 @item y
2430 Equivalent to @code{r}; retained for backwards compatibility.
2431
2432 @item z
2433 A floating-point condition code register.
2434
2435 @item I
2436 A signed 16-bit constant (for arithmetic instructions).
2437
2438 @item J
2439 Integer zero.
2440
2441 @item K
2442 An unsigned 16-bit constant (for logic instructions).
2443
2444 @item L
2445 A signed 32-bit constant in which the lower 16 bits are zero.
2446 Such constants can be loaded using @code{lui}.
2447
2448 @item M
2449 A constant that cannot be loaded using @code{lui}, @code{addiu}
2450 or @code{ori}.
2451
2452 @item N
2453 A constant in the range -65535 to -1 (inclusive).
2454
2455 @item O
2456 A signed 15-bit constant.
2457
2458 @item P
2459 A constant in the range 1 to 65535 (inclusive).
2460
2461 @item G
2462 Floating-point zero.
2463
2464 @item R
2465 An address that can be used in a non-macro load or store.
2466 @end table
2467
2468 @item Motorola 680x0---@file{config/m68k/m68k.h}
2469 @table @code
2470 @item a
2471 Address register
2472
2473 @item d
2474 Data register
2475
2476 @item f
2477 68881 floating-point register, if available
2478
2479 @item I
2480 Integer in the range 1 to 8
2481
2482 @item J
2483 16-bit signed number
2484
2485 @item K
2486 Signed number whose magnitude is greater than 0x80
2487
2488 @item L
2489 Integer in the range @minus{}8 to @minus{}1
2490
2491 @item M
2492 Signed number whose magnitude is greater than 0x100
2493
2494 @item G
2495 Floating point constant that is not a 68881 constant
2496 @end table
2497
2498 @item Motorola 68HC11 & 68HC12 families---@file{config/m68hc11/m68hc11.h}
2499 @table @code
2500 @item a
2501 Register `a'
2502
2503 @item b
2504 Register `b'
2505
2506 @item d
2507 Register `d'
2508
2509 @item q
2510 An 8-bit register
2511
2512 @item t
2513 Temporary soft register _.tmp
2514
2515 @item u
2516 A soft register _.d1 to _.d31
2517
2518 @item w
2519 Stack pointer register
2520
2521 @item x
2522 Register `x'
2523
2524 @item y
2525 Register `y'
2526
2527 @item z
2528 Pseudo register `z' (replaced by `x' or `y' at the end)
2529
2530 @item A
2531 An address register: x, y or z
2532
2533 @item B
2534 An address register: x or y
2535
2536 @item D
2537 Register pair (x:d) to form a 32-bit value
2538
2539 @item L
2540 Constants in the range @minus{}65536 to 65535
2541
2542 @item M
2543 Constants whose 16-bit low part is zero
2544
2545 @item N
2546 Constant integer 1 or @minus{}1
2547
2548 @item O
2549 Constant integer 16
2550
2551 @item P
2552 Constants in the range @minus{}8 to 2
2553
2554 @end table
2555
2556 @need 1000
2557 @item SPARC---@file{config/sparc/sparc.h}
2558 @table @code
2559 @item f
2560 Floating-point register on the SPARC-V8 architecture and
2561 lower floating-point register on the SPARC-V9 architecture.
2562
2563 @item e
2564 Floating-point register.  It is equivalent to @samp{f} on the
2565 SPARC-V8 architecture and contains both lower and upper
2566 floating-point registers on the SPARC-V9 architecture.
2567
2568 @item c
2569 Floating-point condition code register.
2570
2571 @item d
2572 Lower floating-point register.  It is only valid on the SPARC-V9
2573 architecture when the Visual Instruction Set is available.
2574
2575 @item b
2576 Floating-point register.  It is only valid on the SPARC-V9 architecture
2577 when the Visual Instruction Set is available.
2578
2579 @item h
2580 64-bit global or out register for the SPARC-V8+ architecture.
2581
2582 @item I
2583 Signed 13-bit constant
2584
2585 @item J
2586 Zero
2587
2588 @item K
2589 32-bit constant with the low 12 bits clear (a constant that can be
2590 loaded with the @code{sethi} instruction)
2591
2592 @item L
2593 A constant in the range supported by @code{movcc} instructions
2594
2595 @item M
2596 A constant in the range supported by @code{movrcc} instructions
2597
2598 @item N
2599 Same as @samp{K}, except that it verifies that bits that are not in the
2600 lower 32-bit range are all zero.  Must be used instead of @samp{K} for
2601 modes wider than @code{SImode}
2602
2603 @item O
2604 The constant 4096
2605
2606 @item G
2607 Floating-point zero
2608
2609 @item H
2610 Signed 13-bit constant, sign-extended to 32 or 64 bits
2611
2612 @item Q
2613 Floating-point constant whose integral representation can
2614 be moved into an integer register using a single sethi
2615 instruction
2616
2617 @item R
2618 Floating-point constant whose integral representation can
2619 be moved into an integer register using a single mov
2620 instruction
2621
2622 @item S
2623 Floating-point constant whose integral representation can
2624 be moved into an integer register using a high/lo_sum
2625 instruction sequence
2626
2627 @item T
2628 Memory address aligned to an 8-byte boundary
2629
2630 @item U
2631 Even register
2632
2633 @item W
2634 Memory address for @samp{e} constraint registers
2635
2636 @item Y
2637 Vector zero
2638
2639 @end table
2640
2641 @item SPU---@file{config/spu/spu.h}
2642 @table @code
2643 @item a
2644 An immediate which can be loaded with the il/ila/ilh/ilhu instructions.  const_int is treated as a 64 bit value.  
2645
2646 @item c
2647 An immediate for and/xor/or instructions.  const_int is treated as a 64 bit value.  
2648
2649 @item d
2650 An immediate for the @code{iohl} instruction.  const_int is treated as a 64 bit value.  
2651
2652 @item f
2653 An immediate which can be loaded with @code{fsmbi}.  
2654
2655 @item A
2656 An immediate which can be loaded with the il/ila/ilh/ilhu instructions.  const_int is treated as a 32 bit value.  
2657
2658 @item B
2659 An immediate for most arithmetic instructions.  const_int is treated as a 32 bit value.  
2660
2661 @item C
2662 An immediate for and/xor/or instructions.  const_int is treated as a 32 bit value.  
2663
2664 @item D
2665 An immediate for the @code{iohl} instruction.  const_int is treated as a 32 bit value.  
2666
2667 @item I
2668 A constant in the range [-64, 63] for shift/rotate instructions.  
2669
2670 @item J
2671 An unsigned 7-bit constant for conversion/nop/channel instructions.  
2672
2673 @item K
2674 A signed 10-bit constant for most arithmetic instructions.  
2675
2676 @item M
2677 A signed 16 bit immediate for @code{stop}.  
2678
2679 @item N
2680 An unsigned 16-bit constant for @code{iohl} and @code{fsmbi}.  
2681
2682 @item O
2683 An unsigned 7-bit constant whose 3 least significant bits are 0.  
2684
2685 @item P
2686 An unsigned 3-bit constant for 16-byte rotates and shifts 
2687
2688 @item R
2689 Call operand, reg, for indirect calls 
2690
2691 @item S
2692 Call operand, symbol, for relative calls.  
2693
2694 @item T
2695 Call operand, const_int, for absolute calls.  
2696
2697 @item U
2698 An immediate which can be loaded with the il/ila/ilh/ilhu instructions.  const_int is sign extended to 128 bit.  
2699
2700 @item W
2701 An immediate for shift and rotate instructions.  const_int is treated as a 32 bit value.  
2702
2703 @item Y
2704 An immediate for and/xor/or instructions.  const_int is sign extended as a 128 bit.  
2705
2706 @item Z
2707 An immediate for the @code{iohl} instruction.  const_int is sign extended to 128 bit.  
2708
2709 @end table
2710
2711 @item TMS320C3x/C4x---@file{config/c4x/c4x.h}
2712 @table @code
2713 @item a
2714 Auxiliary (address) register (ar0-ar7)
2715
2716 @item b
2717 Stack pointer register (sp)
2718
2719 @item c
2720 Standard (32-bit) precision integer register
2721
2722 @item f
2723 Extended (40-bit) precision register (r0-r11)
2724
2725 @item k
2726 Block count register (bk)
2727
2728 @item q
2729 Extended (40-bit) precision low register (r0-r7)
2730
2731 @item t
2732 Extended (40-bit) precision register (r0-r1)
2733
2734 @item u
2735 Extended (40-bit) precision register (r2-r3)
2736
2737 @item v
2738 Repeat count register (rc)
2739
2740 @item x
2741 Index register (ir0-ir1)
2742
2743 @item y
2744 Status (condition code) register (st)
2745
2746 @item z
2747 Data page register (dp)
2748
2749 @item G
2750 Floating-point zero
2751
2752 @item H
2753 Immediate 16-bit floating-point constant
2754
2755 @item I
2756 Signed 16-bit constant
2757
2758 @item J
2759 Signed 8-bit constant
2760
2761 @item K
2762 Signed 5-bit constant
2763
2764 @item L
2765 Unsigned 16-bit constant
2766
2767 @item M
2768 Unsigned 8-bit constant
2769
2770 @item N
2771 Ones complement of unsigned 16-bit constant
2772
2773 @item O
2774 High 16-bit constant (32-bit constant with 16 LSBs zero)
2775
2776 @item Q
2777 Indirect memory reference with signed 8-bit or index register displacement
2778
2779 @item R
2780 Indirect memory reference with unsigned 5-bit displacement
2781
2782 @item S
2783 Indirect memory reference with 1 bit or index register displacement
2784
2785 @item T
2786 Direct memory reference
2787
2788 @item U
2789 Symbolic address
2790
2791 @end table
2792
2793 @item S/390 and zSeries---@file{config/s390/s390.h}
2794 @table @code
2795 @item a
2796 Address register (general purpose register except r0)
2797
2798 @item c
2799 Condition code register
2800
2801 @item d
2802 Data register (arbitrary general purpose register)
2803
2804 @item f
2805 Floating-point register
2806
2807 @item I
2808 Unsigned 8-bit constant (0--255)
2809
2810 @item J
2811 Unsigned 12-bit constant (0--4095)
2812
2813 @item K
2814 Signed 16-bit constant (@minus{}32768--32767)
2815
2816 @item L
2817 Value appropriate as displacement.
2818 @table @code
2819        @item (0..4095)
2820        for short displacement
2821        @item (-524288..524287)
2822        for long displacement
2823 @end table
2824
2825 @item M
2826 Constant integer with a value of 0x7fffffff.
2827
2828 @item N
2829 Multiple letter constraint followed by 4 parameter letters.
2830 @table @code
2831          @item 0..9:
2832          number of the part counting from most to least significant
2833          @item H,Q:
2834          mode of the part
2835          @item D,S,H:
2836          mode of the containing operand
2837          @item 0,F:
2838          value of the other parts (F---all bits set)
2839 @end table
2840 The constraint matches if the specified part of a constant
2841 has a value different from it's other parts.
2842
2843 @item Q
2844 Memory reference without index register and with short displacement.
2845
2846 @item R
2847 Memory reference with index register and short displacement.
2848
2849 @item S
2850 Memory reference without index register but with long displacement.
2851
2852 @item T
2853 Memory reference with index register and long displacement.
2854
2855 @item U
2856 Pointer with short displacement.
2857
2858 @item W
2859 Pointer with long displacement.
2860
2861 @item Y
2862 Shift count operand.
2863
2864 @end table
2865
2866 @item Score family---@file{config/score/score.h}
2867 @table @code
2868 @item d
2869 Registers from r0 to r32.
2870
2871 @item e
2872 Registers from r0 to r16.
2873
2874 @item t
2875 r8---r11 or r22---r27 registers.
2876
2877 @item h
2878 hi register.
2879
2880 @item l
2881 lo register.
2882
2883 @item x
2884 hi + lo register.
2885
2886 @item q
2887 cnt register.
2888
2889 @item y
2890 lcb register.
2891
2892 @item z
2893 scb register.
2894
2895 @item a
2896 cnt + lcb + scb register.
2897
2898 @item c
2899 cr0---cr15 register.
2900
2901 @item b
2902 cp1 registers.
2903
2904 @item f
2905 cp2 registers.
2906
2907 @item i
2908 cp3 registers.
2909
2910 @item j
2911 cp1 + cp2 + cp3 registers.
2912
2913 @item I
2914 High 16-bit constant (32-bit constant with 16 LSBs zero).
2915
2916 @item J
2917 Unsigned 5 bit integer (in the range 0 to 31).
2918
2919 @item K
2920 Unsigned 16 bit integer (in the range 0 to 65535).
2921
2922 @item L
2923 Signed 16 bit integer (in the range @minus{}32768 to 32767).
2924
2925 @item M
2926 Unsigned 14 bit integer (in the range 0 to 16383).
2927
2928 @item N
2929 Signed 14 bit integer (in the range @minus{}8192 to 8191).
2930
2931 @item Z
2932 Any SYMBOL_REF.
2933 @end table
2934
2935 @item Xstormy16---@file{config/stormy16/stormy16.h}
2936 @table @code
2937 @item a
2938 Register r0.
2939
2940 @item b
2941 Register r1.
2942
2943 @item c
2944 Register r2.
2945
2946 @item d
2947 Register r8.
2948
2949 @item e
2950 Registers r0 through r7.
2951
2952 @item t
2953 Registers r0 and r1.
2954
2955 @item y
2956 The carry register.
2957
2958 @item z
2959 Registers r8 and r9.
2960
2961 @item I
2962 A constant between 0 and 3 inclusive.
2963
2964 @item J
2965 A constant that has exactly one bit set.
2966
2967 @item K
2968 A constant that has exactly one bit clear.
2969
2970 @item L
2971 A constant between 0 and 255 inclusive.
2972
2973 @item M
2974 A constant between @minus{}255 and 0 inclusive.
2975
2976 @item N
2977 A constant between @minus{}3 and 0 inclusive.
2978
2979 @item O
2980 A constant between 1 and 4 inclusive.
2981
2982 @item P
2983 A constant between @minus{}4 and @minus{}1 inclusive.
2984
2985 @item Q
2986 A memory reference that is a stack push.
2987
2988 @item R
2989 A memory reference that is a stack pop.
2990
2991 @item S
2992 A memory reference that refers to a constant address of known value.
2993
2994 @item T
2995 The register indicated by Rx (not implemented yet).
2996
2997 @item U
2998 A constant that is not between 2 and 15 inclusive.
2999
3000 @item Z
3001 The constant 0.
3002
3003 @end table
3004
3005 @item Xtensa---@file{config/xtensa/constraints.md}
3006 @table @code
3007 @item a
3008 General-purpose 32-bit register
3009
3010 @item b
3011 One-bit boolean register
3012
3013 @item A
3014 MAC16 40-bit accumulator register
3015
3016 @item I
3017 Signed 12-bit integer constant, for use in MOVI instructions
3018
3019 @item J
3020 Signed 8-bit integer constant, for use in ADDI instructions
3021
3022 @item K
3023 Integer constant valid for BccI instructions
3024
3025 @item L
3026 Unsigned constant valid for BccUI instructions
3027
3028 @end table
3029
3030 @end table
3031
3032 @ifset INTERNALS
3033 @node Define Constraints
3034 @subsection Defining Machine-Specific Constraints
3035 @cindex defining constraints
3036 @cindex constraints, defining
3037
3038 Machine-specific constraints fall into two categories: register and
3039 non-register constraints.  Within the latter category, constraints
3040 which allow subsets of all possible memory or address operands should
3041 be specially marked, to give @code{reload} more information.
3042
3043 Machine-specific constraints can be given names of arbitrary length,
3044 but they must be entirely composed of letters, digits, underscores
3045 (@samp{_}), and angle brackets (@samp{< >}).  Like C identifiers, they
3046 must begin with a letter or underscore. 
3047
3048 In order to avoid ambiguity in operand constraint strings, no
3049 constraint can have a name that begins with any other constraint's
3050 name.  For example, if @code{x} is defined as a constraint name,
3051 @code{xy} may not be, and vice versa.  As a consequence of this rule,
3052 no constraint may begin with one of the generic constraint letters:
3053 @samp{E F V X g i m n o p r s}.
3054
3055 Register constraints correspond directly to register classes.
3056 @xref{Register Classes}.  There is thus not much flexibility in their
3057 definitions.
3058
3059 @deffn {MD Expression} define_register_constraint name regclass docstring
3060 All three arguments are string constants.
3061 @var{name} is the name of the constraint, as it will appear in
3062 @code{match_operand} expressions.  If @var{name} is a multi-letter
3063 constraint its length shall be the same for all constraints starting
3064 with the same letter.  @var{regclass} can be either the
3065 name of the corresponding register class (@pxref{Register Classes}),
3066 or a C expression which evaluates to the appropriate register class.
3067 If it is an expression, it must have no side effects, and it cannot
3068 look at the operand.  The usual use of expressions is to map some
3069 register constraints to @code{NO_REGS} when the register class
3070 is not available on a given subarchitecture.
3071
3072 @var{docstring} is a sentence documenting the meaning of the
3073 constraint.  Docstrings are explained further below.
3074 @end deffn
3075
3076 Non-register constraints are more like predicates: the constraint
3077 definition gives a Boolean expression which indicates whether the
3078 constraint matches.
3079
3080 @deffn {MD Expression} define_constraint name docstring exp
3081 The @var{name} and @var{docstring} arguments are the same as for
3082 @code{define_register_constraint}, but note that the docstring comes
3083 immediately after the name for these expressions.  @var{exp} is an RTL
3084 expression, obeying the same rules as the RTL expressions in predicate
3085 definitions.  @xref{Defining Predicates}, for details.  If it
3086 evaluates true, the constraint matches; if it evaluates false, it
3087 doesn't. Constraint expressions should indicate which RTL codes they
3088 might match, just like predicate expressions.
3089
3090 @code{match_test} C expressions have access to the
3091 following variables:
3092
3093 @table @var
3094 @item op
3095 The RTL object defining the operand.
3096 @item mode
3097 The machine mode of @var{op}.
3098 @item ival
3099 @samp{INTVAL (@var{op})}, if @var{op} is a @code{const_int}.
3100 @item hval
3101 @samp{CONST_DOUBLE_HIGH (@var{op})}, if @var{op} is an integer
3102 @code{const_double}.
3103 @item lval
3104 @samp{CONST_DOUBLE_LOW (@var{op})}, if @var{op} is an integer
3105 @code{const_double}.
3106 @item rval
3107 @samp{CONST_DOUBLE_REAL_VALUE (@var{op})}, if @var{op} is a floating-point
3108 @code{const_double}.
3109 @end table
3110
3111 The @var{*val} variables should only be used once another piece of the
3112 expression has verified that @var{op} is the appropriate kind of RTL
3113 object.
3114 @end deffn
3115
3116 Most non-register constraints should be defined with
3117 @code{define_constraint}.  The remaining two definition expressions
3118 are only appropriate for constraints that should be handled specially
3119 by @code{reload} if they fail to match.
3120
3121 @deffn {MD Expression} define_memory_constraint name docstring exp
3122 Use this expression for constraints that match a subset of all memory
3123 operands: that is, @code{reload} can make them match by converting the
3124 operand to the form @samp{@w{(mem (reg @var{X}))}}, where @var{X} is a
3125 base register (from the register class specified by
3126 @code{BASE_REG_CLASS}, @pxref{Register Classes}).
3127
3128 For example, on the S/390, some instructions do not accept arbitrary
3129 memory references, but only those that do not make use of an index
3130 register.  The constraint letter @samp{Q} is defined to represent a
3131 memory address of this type.  If @samp{Q} is defined with
3132 @code{define_memory_constraint}, a @samp{Q} constraint can handle any
3133 memory operand, because @code{reload} knows it can simply copy the
3134 memory address into a base register if required.  This is analogous to
3135 the way a @samp{o} constraint can handle any memory operand.
3136
3137 The syntax and semantics are otherwise identical to
3138 @code{define_constraint}.
3139 @end deffn
3140
3141 @deffn {MD Expression} define_address_constraint name docstring exp
3142 Use this expression for constraints that match a subset of all address
3143 operands: that is, @code{reload} can make the constraint match by
3144 converting the operand to the form @samp{@w{(reg @var{X})}}, again
3145 with @var{X} a base register.
3146
3147 Constraints defined with @code{define_address_constraint} can only be
3148 used with the @code{address_operand} predicate, or machine-specific
3149 predicates that work the same way.  They are treated analogously to
3150 the generic @samp{p} constraint.
3151
3152 The syntax and semantics are otherwise identical to
3153 @code{define_constraint}.
3154 @end deffn
3155
3156 For historical reasons, names beginning with the letters @samp{G H}
3157 are reserved for constraints that match only @code{const_double}s, and
3158 names beginning with the letters @samp{I J K L M N O P} are reserved
3159 for constraints that match only @code{const_int}s.  This may change in
3160 the future.  For the time being, constraints with these names must be
3161 written in a stylized form, so that @code{genpreds} can tell you did
3162 it correctly:
3163
3164 @smallexample
3165 @group
3166 (define_constraint "[@var{GHIJKLMNOP}]@dots{}"
3167   "@var{doc}@dots{}"
3168   (and (match_code "const_int")  ; @r{@code{const_double} for G/H}
3169        @var{condition}@dots{}))            ; @r{usually a @code{match_test}}
3170 @end group
3171 @end smallexample
3172 @c the semicolons line up in the formatted manual
3173
3174 It is fine to use names beginning with other letters for constraints
3175 that match @code{const_double}s or @code{const_int}s.
3176
3177 Each docstring in a constraint definition should be one or more complete
3178 sentences, marked up in Texinfo format.  @emph{They are currently unused.}
3179 In the future they will be copied into the GCC manual, in @ref{Machine
3180 Constraints}, replacing the hand-maintained tables currently found in
3181 that section.  Also, in the future the compiler may use this to give
3182 more helpful diagnostics when poor choice of @code{asm} constraints
3183 causes a reload failure.
3184
3185 If you put the pseudo-Texinfo directive @samp{@@internal} at the
3186 beginning of a docstring, then (in the future) it will appear only in
3187 the internals manual's version of the machine-specific constraint tables.
3188 Use this for constraints that should not appear in @code{asm} statements.
3189
3190 @node C Constraint Interface
3191 @subsection Testing constraints from C
3192 @cindex testing constraints
3193 @cindex constraints, testing
3194
3195 It is occasionally useful to test a constraint from C code rather than
3196 implicitly via the constraint string in a @code{match_operand}.  The
3197 generated file @file{tm_p.h} declares a few interfaces for working
3198 with machine-specific constraints.  None of these interfaces work with
3199 the generic constraints described in @ref{Simple Constraints}.  This
3200 may change in the future.
3201
3202 @strong{Warning:} @file{tm_p.h} may declare other functions that
3203 operate on constraints, besides the ones documented here.  Do not use
3204 those functions from machine-dependent code.  They exist to implement
3205 the old constraint interface that machine-independent components of
3206 the compiler still expect.  They will change or disappear in the
3207 future.
3208
3209 Some valid constraint names are not valid C identifiers, so there is a
3210 mangling scheme for referring to them from C@.  Constraint names that
3211 do not contain angle brackets or underscores are left unchanged.
3212 Underscores are doubled, each @samp{<} is replaced with @samp{_l}, and
3213 each @samp{>} with @samp{_g}.  Here are some examples:
3214
3215 @c the @c's prevent double blank lines in the printed manual.
3216 @example
3217 @multitable {Original} {Mangled}
3218 @item @strong{Original} @tab @strong{Mangled}  @c
3219 @item @code{x}     @tab @code{x}       @c
3220 @item @code{P42x}  @tab @code{P42x}    @c
3221 @item @code{P4_x}  @tab @code{P4__x}   @c
3222 @item @code{P4>x}  @tab @code{P4_gx}   @c
3223 @item @code{P4>>}  @tab @code{P4_g_g}  @c
3224 @item @code{P4_g>} @tab @code{P4__g_g} @c
3225 @end multitable
3226 @end example
3227
3228 Throughout this section, the variable @var{c} is either a constraint
3229 in the abstract sense, or a constant from @code{enum constraint_num};
3230 the variable @var{m} is a mangled constraint name (usually as part of
3231 a larger identifier).
3232
3233 @deftp Enum constraint_num
3234 For each machine-specific constraint, there is a corresponding
3235 enumeration constant: @samp{CONSTRAINT_} plus the mangled name of the
3236 constraint.  Functions that take an @code{enum constraint_num} as an
3237 argument expect one of these constants.
3238
3239 Machine-independent constraints do not have associated constants.
3240 This may change in the future.
3241 @end deftp
3242
3243 @deftypefun {inline bool} satisfies_constraint_@var{m} (rtx @var{exp})
3244 For each machine-specific, non-register constraint @var{m}, there is
3245 one of these functions; it returns @code{true} if @var{exp} satisfies the
3246 constraint.  These functions are only visible if @file{rtl.h} was included
3247 before @file{tm_p.h}.
3248 @end deftypefun
3249
3250 @deftypefun bool constraint_satisfied_p (rtx @var{exp}, enum constraint_num @var{c})
3251 Like the @code{satisfies_constraint_@var{m}} functions, but the
3252 constraint to test is given as an argument, @var{c}.  If @var{c}
3253 specifies a register constraint, this function will always return
3254 @code{false}.
3255 @end deftypefun
3256
3257 @deftypefun {enum reg_class} regclass_for_constraint (enum constraint_num @var{c})
3258 Returns the register class associated with @var{c}.  If @var{c} is not
3259 a register constraint, or those registers are not available for the
3260 currently selected subtarget, returns @code{NO_REGS}.
3261 @end deftypefun
3262
3263 Here is an example use of @code{satisfies_constraint_@var{m}}.  In
3264 peephole optimizations (@pxref{Peephole Definitions}), operand
3265 constraint strings are ignored, so if there are relevant constraints,
3266 they must be tested in the C condition.  In the example, the
3267 optimization is applied if operand 2 does @emph{not} satisfy the
3268 @samp{K} constraint.  (This is a simplified version of a peephole
3269 definition from the i386 machine description.)
3270
3271 @smallexample
3272 (define_peephole2
3273   [(match_scratch:SI 3 "r")
3274    (set (match_operand:SI 0 "register_operand" "")
3275         (mult:SI (match_operand:SI 1 "memory_operand" "")
3276                  (match_operand:SI 2 "immediate_operand" "")))]
3277
3278   "!satisfies_constraint_K (operands[2])"
3279
3280   [(set (match_dup 3) (match_dup 1))
3281    (set (match_dup 0) (mult:SI (match_dup 3) (match_dup 2)))]
3282
3283   "")
3284 @end smallexample
3285
3286 @node Standard Names
3287 @section Standard Pattern Names For Generation
3288 @cindex standard pattern names
3289 @cindex pattern names
3290 @cindex names, pattern
3291
3292 Here is a table of the instruction names that are meaningful in the RTL
3293 generation pass of the compiler.  Giving one of these names to an
3294 instruction pattern tells the RTL generation pass that it can use the
3295 pattern to accomplish a certain task.
3296
3297 @table @asis
3298 @cindex @code{mov@var{m}} instruction pattern
3299 @item @samp{mov@var{m}}
3300 Here @var{m} stands for a two-letter machine mode name, in lowercase.
3301 This instruction pattern moves data with that machine mode from operand
3302 1 to operand 0.  For example, @samp{movsi} moves full-word data.
3303
3304 If operand 0 is a @code{subreg} with mode @var{m} of a register whose
3305 own mode is wider than @var{m}, the effect of this instruction is
3306 to store the specified value in the part of the register that corresponds
3307 to mode @var{m}.  Bits outside of @var{m}, but which are within the
3308 same target word as the @code{subreg} are undefined.  Bits which are
3309 outside the target word are left unchanged.
3310
3311 This class of patterns is special in several ways.  First of all, each
3312 of these names up to and including full word size @emph{must} be defined,
3313 because there is no other way to copy a datum from one place to another.
3314 If there are patterns accepting operands in larger modes,
3315 @samp{mov@var{m}} must be defined for integer modes of those sizes.
3316
3317 Second, these patterns are not used solely in the RTL generation pass.
3318 Even the reload pass can generate move insns to copy values from stack
3319 slots into temporary registers.  When it does so, one of the operands is
3320 a hard register and the other is an operand that can need to be reloaded
3321 into a register.
3322
3323 @findex force_reg
3324 Therefore, when given such a pair of operands, the pattern must generate
3325 RTL which needs no reloading and needs no temporary registers---no
3326 registers other than the operands.  For example, if you support the
3327 pattern with a @code{define_expand}, then in such a case the
3328 @code{define_expand} mustn't call @code{force_reg} or any other such
3329 function which might generate new pseudo registers.
3330
3331 This requirement exists even for subword modes on a RISC machine where
3332 fetching those modes from memory normally requires several insns and
3333 some temporary registers.
3334
3335 @findex change_address
3336 During reload a memory reference with an invalid address may be passed
3337 as an operand.  Such an address will be replaced with a valid address
3338 later in the reload pass.  In this case, nothing may be done with the
3339 address except to use it as it stands.  If it is copied, it will not be
3340 replaced with a valid address.  No attempt should be made to make such
3341 an address into a valid address and no routine (such as
3342 @code{change_address}) that will do so may be called.  Note that
3343 @code{general_operand} will fail when applied to such an address.
3344
3345 @findex reload_in_progress
3346 The global variable @code{reload_in_progress} (which must be explicitly
3347 declared if required) can be used to determine whether such special
3348 handling is required.
3349
3350 The variety of operands that have reloads depends on the rest of the
3351 machine description, but typically on a RISC machine these can only be
3352 pseudo registers that did not get hard registers, while on other
3353 machines explicit memory references will get optional reloads.
3354
3355 If a scratch register is required to move an object to or from memory,
3356 it can be allocated using @code{gen_reg_rtx} prior to life analysis.
3357
3358 If there are cases which need scratch registers during or after reload,
3359 you must provide an appropriate secondary_reload target hook.
3360
3361 @findex no_new_pseudos
3362 The global variable @code{no_new_pseudos} can be used to determine if it
3363 is unsafe to create new pseudo registers.  If this variable is nonzero, then
3364 it is unsafe to call @code{gen_reg_rtx} to allocate a new pseudo.
3365
3366 The constraints on a @samp{mov@var{m}} must permit moving any hard
3367 register to any other hard register provided that
3368 @code{HARD_REGNO_MODE_OK} permits mode @var{m} in both registers and
3369 @code{REGISTER_MOVE_COST} applied to their classes returns a value of 2.
3370
3371 It is obligatory to support floating point @samp{mov@var{m}}
3372 instructions into and out of any registers that can hold fixed point
3373 values, because unions and structures (which have modes @code{SImode} or
3374 @code{DImode}) can be in those registers and they may have floating
3375 point members.
3376
3377 There may also be a need to support fixed point @samp{mov@var{m}}
3378 instructions in and out of floating point registers.  Unfortunately, I
3379 have forgotten why this was so, and I don't know whether it is still
3380 true.  If @code{HARD_REGNO_MODE_OK} rejects fixed point values in
3381 floating point registers, then the constraints of the fixed point
3382 @samp{mov@var{m}} instructions must be designed to avoid ever trying to
3383 reload into a floating point register.
3384
3385 @cindex @code{reload_in} instruction pattern
3386 @cindex @code{reload_out} instruction pattern
3387 @item @samp{reload_in@var{m}}
3388 @itemx @samp{reload_out@var{m}}
3389 These named patterns have been obsoleted by the target hook
3390 @code{secondary_reload}.
3391
3392 Like @samp{mov@var{m}}, but used when a scratch register is required to
3393 move between operand 0 and operand 1.  Operand 2 describes the scratch
3394 register.  See the discussion of the @code{SECONDARY_RELOAD_CLASS}
3395 macro in @pxref{Register Classes}.
3396
3397 There are special restrictions on the form of the @code{match_operand}s
3398 used in these patterns.  First, only the predicate for the reload
3399 operand is examined, i.e., @code{reload_in} examines operand 1, but not
3400 the predicates for operand 0 or 2.  Second, there may be only one
3401 alternative in the constraints.  Third, only a single register class
3402 letter may be used for the constraint; subsequent constraint letters
3403 are ignored.  As a special exception, an empty constraint string
3404 matches the @code{ALL_REGS} register class.  This may relieve ports
3405 of the burden of defining an @code{ALL_REGS} constraint letter just
3406 for these patterns.
3407
3408 @cindex @code{movstrict@var{m}} instruction pattern
3409 @item @samp{movstrict@var{m}}
3410 Like @samp{mov@var{m}} except that if operand 0 is a @code{subreg}
3411 with mode @var{m} of a register whose natural mode is wider,
3412 the @samp{movstrict@var{m}} instruction is guaranteed not to alter
3413 any of the register except the part which belongs to mode @var{m}.
3414
3415 @cindex @code{movmisalign@var{m}} instruction pattern
3416 @item @samp{movmisalign@var{m}}
3417 This variant of a move pattern is designed to load or store a value
3418 from a memory address that is not naturally aligned for its mode.
3419 For a store, the memory will be in operand 0; for a load, the memory
3420 will be in operand 1.  The other operand is guaranteed not to be a
3421 memory, so that it's easy to tell whether this is a load or store.
3422
3423 This pattern is used by the autovectorizer, and when expanding a
3424 @code{MISALIGNED_INDIRECT_REF} expression.
3425
3426 @cindex @code{load_multiple} instruction pattern
3427 @item @samp{load_multiple}
3428 Load several consecutive memory locations into consecutive registers.
3429 Operand 0 is the first of the consecutive registers, operand 1
3430 is the first memory location, and operand 2 is a constant: the
3431 number of consecutive registers.
3432
3433 Define this only if the target machine really has such an instruction;
3434 do not define this if the most efficient way of loading consecutive
3435 registers from memory is to do them one at a time.
3436
3437 On some machines, there are restrictions as to which consecutive
3438 registers can be stored into memory, such as particular starting or
3439 ending register numbers or only a range of valid counts.  For those
3440 machines, use a @code{define_expand} (@pxref{Expander Definitions})
3441 and make the pattern fail if the restrictions are not met.
3442
3443 Write the generated insn as a @code{parallel} with elements being a
3444 @code{set} of one register from the appropriate memory location (you may
3445 also need @code{use} or @code{clobber} elements).  Use a
3446 @code{match_parallel} (@pxref{RTL Template}) to recognize the insn.  See
3447 @file{rs6000.md} for examples of the use of this insn pattern.
3448
3449 @cindex @samp{store_multiple} instruction pattern
3450 @item @samp{store_multiple}
3451 Similar to @samp{load_multiple}, but store several consecutive registers
3452 into consecutive memory locations.  Operand 0 is the first of the
3453 consecutive memory locations, operand 1 is the first register, and
3454 operand 2 is a constant: the number of consecutive registers.
3455
3456 @cindex @code{vec_set@var{m}} instruction pattern
3457 @item @samp{vec_set@var{m}}
3458 Set given field in the vector value.  Operand 0 is the vector to modify,
3459 operand 1 is new value of field and operand 2 specify the field index.
3460
3461 @cindex @code{vec_extract@var{m}} instruction pattern
3462 @item @samp{vec_extract@var{m}}
3463 Extract given field from the vector value.  Operand 1 is the vector, operand 2
3464 specify field index and operand 0 place to store value into.
3465
3466 @cindex @code{vec_extract_even@var{m}} instruction pattern
3467 @item @samp{vec_extract_even@var{m}}
3468 Extract even elements from the input vectors (operand 1 and operand 2). 
3469 The even elements of operand 2 are concatenated to the even elements of operand
3470 1 in their original order. The result is stored in operand 0. 
3471 The output and input vectors should have the same modes. 
3472
3473 @cindex @code{vec_extract_odd@var{m}} instruction pattern
3474 @item @samp{vec_extract_odd@var{m}}
3475 Extract odd elements from the input vectors (operand 1 and operand 2). 
3476 The odd elements of operand 2 are concatenated to the odd elements of operand 
3477 1 in their original order. The result is stored in operand 0.
3478 The output and input vectors should have the same modes.
3479
3480 @cindex @code{vec_interleave_high@var{m}} instruction pattern
3481 @item @samp{vec_interleave_high@var{m}}
3482 Merge high elements of the two input vectors into the output vector. The output
3483 and input vectors should have the same modes (@code{N} elements). The high
3484 @code{N/2} elements of the first input vector are interleaved with the high
3485 @code{N/2} elements of the second input vector.
3486
3487 @cindex @code{vec_interleave_low@var{m}} instruction pattern
3488 @item @samp{vec_interleave_low@var{m}}
3489 Merge low elements of the two input vectors into the output vector. The output
3490 and input vectors should have the same modes (@code{N} elements). The low
3491 @code{N/2} elements of the first input vector are interleaved with the low 
3492 @code{N/2} elements of the second input vector.
3493
3494 @cindex @code{vec_init@var{m}} instruction pattern
3495 @item @samp{vec_init@var{m}}
3496 Initialize the vector to given values.  Operand 0 is the vector to initialize
3497 and operand 1 is parallel containing values for individual fields.
3498
3499 @cindex @code{push@var{m}1} instruction pattern
3500 @item @samp{push@var{m}1}
3501 Output a push instruction.  Operand 0 is value to push.  Used only when
3502 @code{PUSH_ROUNDING} is defined.  For historical reason, this pattern may be
3503 missing and in such case an @code{mov} expander is used instead, with a
3504 @code{MEM} expression forming the push operation.  The @code{mov} expander
3505 method is deprecated.
3506
3507 @cindex @code{add@var{m}3} instruction pattern
3508 @item @samp{add@var{m}3}
3509 Add operand 2 and operand 1, storing the result in operand 0.  All operands
3510 must have mode @var{m}.  This can be used even on two-address machines, by
3511 means of constraints requiring operands 1 and 0 to be the same location.
3512
3513 @cindex @code{sub@var{m}3} instruction pattern
3514 @cindex @code{mul@var{m}3} instruction pattern
3515 @cindex @code{div@var{m}3} instruction pattern
3516 @cindex @code{udiv@var{m}3} instruction pattern
3517 @cindex @code{mod@var{m}3} instruction pattern
3518 @cindex @code{umod@var{m}3} instruction pattern
3519 @cindex @code{umin@var{m}3} instruction pattern
3520 @cindex @code{umax@var{m}3} instruction pattern
3521 @cindex @code{and@var{m}3} instruction pattern
3522 @cindex @code{ior@var{m}3} instruction pattern
3523 @cindex @code{xor@var{m}3} instruction pattern
3524 @item @samp{sub@var{m}3}, @samp{mul@var{m}3}
3525 @itemx @samp{div@var{m}3}, @samp{udiv@var{m}3}
3526 @itemx @samp{mod@var{m}3}, @samp{umod@var{m}3}
3527 @itemx @samp{umin@var{m}3}, @samp{umax@var{m}3}
3528 @itemx @samp{and@var{m}3}, @samp{ior@var{m}3}, @samp{xor@var{m}3}
3529 Similar, for other arithmetic operations.
3530
3531 @cindex @code{min@var{m}3} instruction pattern
3532 @cindex @code{max@var{m}3} instruction pattern
3533 @item @samp{smin@var{m}3}, @samp{smax@var{m}3}
3534 Signed minimum and maximum operations.  When used with floating point,
3535 if both operands are zeros, or if either operand is @code{NaN}, then
3536 it is unspecified which of the two operands is returned as the result.
3537
3538 @cindex @code{reduc_smin_@var{m}} instruction pattern
3539 @cindex @code{reduc_smax_@var{m}} instruction pattern
3540 @item @samp{reduc_smin_@var{m}}, @samp{reduc_smax_@var{m}}
3541 Find the signed minimum/maximum of the elements of a vector. The vector is
3542 operand 1, and the scalar result is stored in the least significant bits of
3543 operand 0 (also a vector). The output and input vector should have the same
3544 modes.
3545
3546 @cindex @code{reduc_umin_@var{m}} instruction pattern
3547 @cindex @code{reduc_umax_@var{m}} instruction pattern
3548 @item @samp{reduc_umin_@var{m}}, @samp{reduc_umax_@var{m}}
3549 Find the unsigned minimum/maximum of the elements of a vector. The vector is
3550 operand 1, and the scalar result is stored in the least significant bits of
3551 operand 0 (also a vector). The output and input vector should have the same
3552 modes.
3553
3554 @cindex @code{reduc_splus_@var{m}} instruction pattern
3555 @item @samp{reduc_splus_@var{m}}
3556 Compute the sum of the signed elements of a vector. The vector is operand 1,
3557 and the scalar result is stored in the least significant bits of operand 0
3558 (also a vector). The output and input vector should have the same modes.
3559
3560 @cindex @code{reduc_uplus_@var{m}} instruction pattern
3561 @item @samp{reduc_uplus_@var{m}}
3562 Compute the sum of the unsigned elements of a vector. The vector is operand 1,
3563 and the scalar result is stored in the least significant bits of operand 0
3564 (also a vector). The output and input vector should have the same modes.
3565
3566 @cindex @code{sdot_prod@var{m}} instruction pattern
3567 @item @samp{sdot_prod@var{m}}
3568 @cindex @code{udot_prod@var{m}} instruction pattern
3569 @item @samp{udot_prod@var{m}}
3570 Compute the sum of the products of two signed/unsigned elements. 
3571 Operand 1 and operand 2 are of the same mode. Their product, which is of a 
3572 wider mode, is computed and added to operand 3. Operand 3 is of a mode equal or 
3573 wider than the mode of the product. The result is placed in operand 0, which
3574 is of the same mode as operand 3. 
3575
3576 @cindex @code{ssum_widen@var{m3}} instruction pattern
3577 @item @samp{ssum_widen@var{m3}}
3578 @cindex @code{usum_widen@var{m3}} instruction pattern
3579 @item @samp{usum_widen@var{m3}}
3580 Operands 0 and 2 are of the same mode, which is wider than the mode of 
3581 operand 1. Add operand 1 to operand 2 and place the widened result in
3582 operand 0. (This is used express accumulation of elements into an accumulator
3583 of a wider mode.)
3584
3585 @cindex @code{vec_shl_@var{m}} instruction pattern
3586 @cindex @code{vec_shr_@var{m}} instruction pattern
3587 @item @samp{vec_shl_@var{m}}, @samp{vec_shr_@var{m}}
3588 Whole vector left/right shift in bits.
3589 Operand 1 is a vector to be shifted.
3590 Operand 2 is an integer shift amount in bits.
3591 Operand 0 is where the resulting shifted vector is stored.
3592 The output and input vectors should have the same modes.
3593
3594 @cindex @code{vec_pack_trunc_@var{m}} instruction pattern
3595 @item @samp{vec_pack_trunc_@var{m}}
3596 Narrow (demote) and merge the elements of two vectors. Operands 1 and 2
3597 are vectors of the same mode having N integral or floating point elements
3598 of size S.  Operand 0 is the resulting vector in which 2*N elements of
3599 size N/2 are concatenated after narrowing them down using truncation.
3600
3601 @cindex @code{vec_pack_ssat_@var{m}} instruction pattern
3602 @cindex @code{vec_pack_usat_@var{m}} instruction pattern
3603 @item @samp{vec_pack_ssat_@var{m}}, @samp{vec_pack_usat_@var{m}}
3604 Narrow (demote) and merge the elements of two vectors.  Operands 1 and 2
3605 are vectors of the same mode having N integral elements of size S.
3606 Operand 0 is the resulting vector in which the elements of the two input
3607 vectors are concatenated after narrowing them down using signed/unsigned
3608 saturating arithmetic.
3609
3610 @cindex @code{vec_unpacks_hi_@var{m}} instruction pattern
3611 @cindex @code{vec_unpacks_lo_@var{m}} instruction pattern
3612 @item @samp{vec_unpacks_hi_@var{m}}, @samp{vec_unpacks_lo_@var{m}}
3613 Extract and widen (promote) the high/low part of a vector of signed
3614 integral or floating point elements.  The input vector (operand 1) has N
3615 elements of size S.  Widen (promote) the high/low elements of the vector
3616 using signed or floating point extension and place the resulting N/2
3617 values of size 2*S in the output vector (operand 0).
3618
3619 @cindex @code{vec_unpacku_hi_@var{m}} instruction pattern
3620 @cindex @code{vec_unpacku_lo_@var{m}} instruction pattern
3621 @item @samp{vec_unpacku_hi_@var{m}}, @samp{vec_unpacku_lo_@var{m}}
3622 Extract and widen (promote) the high/low part of a vector of unsigned
3623 integral elements.  The input vector (operand 1) has N elements of size S.
3624 Widen (promote) the high/low elements of the vector using zero extension and
3625 place the resulting N/2 values of size 2*S in the output vector (operand 0).
3626
3627 @cindex @code{vec_widen_umult_hi_@var{m}} instruction pattern
3628 @cindex @code{vec_widen_umult_lo__@var{m}} instruction pattern
3629 @cindex @code{vec_widen_smult_hi_@var{m}} instruction pattern
3630 @cindex @code{vec_widen_smult_lo_@var{m}} instruction pattern
3631 @item @samp{vec_widen_umult_hi_@var{m}}, @samp{vec_widen_umult_lo_@var{m}}, @samp{vec_widen_smult_hi_@var{m}}, @samp{vec_widen_smult_lo_@var{m}}
3632 Signed/Unsigned widening multiplication.  The two inputs (operands 1 and 2)
3633 are vectors with N signed/unsigned elements of size S.  Multiply the high/low
3634 elements of the two vectors, and put the N/2 products of size 2*S in the
3635 output vector (operand 0).
3636
3637 @cindex @code{mulhisi3} instruction pattern
3638 @item @samp{mulhisi3}
3639 Multiply operands 1 and 2, which have mode @code{HImode}, and store
3640 a @code{SImode} product in operand 0.
3641
3642 @cindex @code{mulqihi3} instruction pattern
3643 @cindex @code{mulsidi3} instruction pattern
3644 @item @samp{mulqihi3}, @samp{mulsidi3}
3645 Similar widening-multiplication instructions of other widths.
3646
3647 @cindex @code{umulqihi3} instruction pattern
3648 @cindex @code{umulhisi3} instruction pattern
3649 @cindex @code{umulsidi3} instruction pattern
3650 @item @samp{umulqihi3}, @samp{umulhisi3}, @samp{umulsidi3}
3651 Similar widening-multiplication instructions that do unsigned
3652 multiplication.
3653
3654 @cindex @code{usmulqihi3} instruction pattern
3655 @cindex @code{usmulhisi3} instruction pattern
3656 @cindex @code{usmulsidi3} instruction pattern
3657 @item @samp{usmulqihi3}, @samp{usmulhisi3}, @samp{usmulsidi3}
3658 Similar widening-multiplication instructions that interpret the first
3659 operand as unsigned and the second operand as signed, then do a signed
3660 multiplication.
3661
3662 @cindex @code{smul@var{m}3_highpart} instruction pattern
3663 @item @samp{smul@var{m}3_highpart}
3664 Perform a signed multiplication of operands 1 and 2, which have mode
3665 @var{m}, and store the most significant half of the product in operand 0.
3666 The least significant half of the product is discarded.
3667
3668 @cindex @code{umul@var{m}3_highpart} instruction pattern
3669 @item @samp{umul@var{m}3_highpart}
3670 Similar, but the multiplication is unsigned.
3671
3672 @cindex @code{madd@var{m}@var{n}4} instruction pattern
3673 @item @samp{madd@var{m}@var{n}4}
3674 Multiply operands 1 and 2, sign-extend them to mode @var{n}, add
3675 operand 3, and store the result in operand 0.  Operands 1 and 2
3676 have mode @var{m} and operands 0 and 3 have mode @var{n}.
3677 Both modes must be integer modes and @var{n} must be twice
3678 the size of @var{m}.
3679
3680 In other words, @code{madd@var{m}@var{n}4} is like
3681 @code{mul@var{m}@var{n}3} except that it also adds operand 3.
3682
3683 These instructions are not allowed to @code{FAIL}.
3684
3685 @cindex @code{umadd@var{m}@var{n}4} instruction pattern
3686 @item @samp{umadd@var{m}@var{n}4}
3687 Like @code{madd@var{m}@var{n}4}, but zero-extend the multiplication
3688 operands instead of sign-extending them.
3689
3690 @cindex @code{divmod@var{m}4} instruction pattern
3691 @item @samp{divmod@var{m}4}
3692 Signed division that produces both a quotient and a remainder.
3693 Operand 1 is divided by operand 2 to produce a quotient stored
3694 in operand 0 and a remainder stored in operand 3.
3695
3696 For machines with an instruction that produces both a quotient and a
3697 remainder, provide a pattern for @samp{divmod@var{m}4} but do not
3698 provide patterns for @samp{div@var{m}3} and @samp{mod@var{m}3}.  This
3699 allows optimization in the relatively common case when both the quotient
3700 and remainder are computed.
3701
3702 If an instruction that just produces a quotient or just a remainder
3703 exists and is more efficient than the instruction that produces both,
3704 write the output routine of @samp{divmod@var{m}4} to call
3705 @code{find_reg_note} and look for a @code{REG_UNUSED} note on the
3706 quotient or remainder and generate the appropriate instruction.
3707
3708 @cindex @code{udivmod@var{m}4} instruction pattern
3709 @item @samp{udivmod@var{m}4}
3710 Similar, but does unsigned division.
3711
3712 @anchor{shift patterns}
3713 @cindex @code{ashl@var{m}3} instruction pattern
3714 @item @samp{ashl@var{m}3}
3715 Arithmetic-shift operand 1 left by a number of bits specified by operand
3716 2, and store the result in operand 0.  Here @var{m} is the mode of
3717 operand 0 and operand 1; operand 2's mode is specified by the
3718 instruction pattern, and the compiler will convert the operand to that
3719 mode before generating the instruction.  The meaning of out-of-range shift
3720 counts can optionally be specified by @code{TARGET_SHIFT_TRUNCATION_MASK}.
3721 @xref{TARGET_SHIFT_TRUNCATION_MASK}.
3722
3723 @cindex @code{ashr@var{m}3} instruction pattern
3724 @cindex @code{lshr@var{m}3} instruction pattern
3725 @cindex @code{rotl@var{m}3} instruction pattern
3726 @cindex @code{rotr@var{m}3} instruction pattern
3727 @item @samp{ashr@var{m}3}, @samp{lshr@var{m}3}, @samp{rotl@var{m}3}, @samp{rotr@var{m}3}
3728 Other shift and rotate instructions, analogous to the
3729 @code{ashl@var{m}3} instructions.
3730
3731 @cindex @code{neg@var{m}2} instruction pattern
3732 @item @samp{neg@var{m}2}
3733 Negate operand 1 and store the result in operand 0.
3734
3735 @cindex @code{abs@var{m}2} instruction pattern
3736 @item @samp{abs@var{m}2}
3737 Store the absolute value of operand 1 into operand 0.
3738
3739 @cindex @code{sqrt@var{m}2} instruction pattern
3740 @item @samp{sqrt@var{m}2}
3741 Store the square root of operand 1 into operand 0.
3742
3743 The @code{sqrt} built-in function of C always uses the mode which
3744 corresponds to the C data type @code{double} and the @code{sqrtf}
3745 built-in function uses the mode which corresponds to the C data
3746 type @code{float}.
3747
3748 @cindex @code{fmod@var{m}3} instruction pattern
3749 @item @samp{fmod@var{m}3}
3750 Store the remainder of dividing operand 1 by operand 2 into
3751 operand 0, rounded towards zero to an integer.
3752
3753 The @code{fmod} built-in function of C always uses the mode which
3754 corresponds to the C data type @code{double} and the @code{fmodf}
3755 built-in function uses the mode which corresponds to the C data
3756 type @code{float}.
3757
3758 @cindex @code{remainder@var{m}3} instruction pattern
3759 @item @samp{remainder@var{m}3}
3760 Store the remainder of dividing operand 1 by operand 2 into
3761 operand 0, rounded to the nearest integer.
3762
3763 The @code{remainder} built-in function of C always uses the mode
3764 which corresponds to the C data type @code{double} and the
3765 @code{remainderf} built-in function uses the mode which corresponds
3766 to the C data type @code{float}.
3767
3768 @cindex @code{cos@var{m}2} instruction pattern
3769 @item @samp{cos@var{m}2}
3770 Store the cosine of operand 1 into operand 0.
3771
3772 The @code{cos} built-in function of C always uses the mode which
3773 corresponds to the C data type @code{double} and the @code{cosf}
3774 built-in function uses the mode which corresponds to the C data
3775 type @code{float}.
3776
3777 @cindex @code{sin@var{m}2} instruction pattern
3778 @item @samp{sin@var{m}2}
3779 Store the sine of operand 1 into operand 0.
3780
3781 The @code{sin} built-in function of C always uses the mode which
3782 corresponds to the C data type @code{double} and the @code{sinf}
3783 built-in function uses the mode which corresponds to the C data
3784 type @code{float}.
3785
3786 @cindex @code{exp@var{m}2} instruction pattern
3787 @item @samp{exp@var{m}2}
3788 Store the exponential of operand 1 into operand 0.
3789
3790 The @code{exp} built-in function of C always uses the mode which
3791 corresponds to the C data type @code{double} and the @code{expf}
3792 built-in function uses the mode which corresponds to the C data
3793 type @code{float}.
3794
3795 @cindex @code{log@var{m}2} instruction pattern
3796 @item @samp{log@var{m}2}
3797 Store the natural logarithm of operand 1 into operand 0.
3798
3799 The @code{log} built-in function of C always uses the mode which
3800 corresponds to the C data type @code{double} and the @code{logf}
3801 built-in function uses the mode which corresponds to the C data
3802 type @code{float}.
3803
3804 @cindex @code{pow@var{m}3} instruction pattern
3805 @item @samp{pow@var{m}3}
3806 Store the value of operand 1 raised to the exponent operand 2
3807 into operand 0.
3808
3809 The @code{pow} built-in function of C always uses the mode which
3810 corresponds to the C data type @code{double} and the @code{powf}
3811 built-in function uses the mode which corresponds to the C data
3812 type @code{float}.
3813
3814 @cindex @code{atan2@var{m}3} instruction pattern
3815 @item @samp{atan2@var{m}3}
3816 Store the arc tangent (inverse tangent) of operand 1 divided by
3817 operand 2 into operand 0, using the signs of both arguments to
3818 determine the quadrant of the result.
3819
3820 The @code{atan2} built-in function of C always uses the mode which
3821 corresponds to the C data type @code{double} and the @code{atan2f}
3822 built-in function uses the mode which corresponds to the C data
3823 type @code{float}.
3824
3825 @cindex @code{floor@var{m}2} instruction pattern
3826 @item @samp{floor@var{m}2}
3827 Store the largest integral value not greater than argument.
3828
3829 The @code{floor} built-in function of C always uses the mode which
3830 corresponds to the C data type @code{double} and the @code{floorf}
3831 built-in function uses the mode which corresponds to the C data
3832 type @code{float}.
3833
3834 @cindex @code{btrunc@var{m}2} instruction pattern
3835 @item @samp{btrunc@var{m}2}
3836 Store the argument rounded to integer towards zero.
3837
3838 The @code{trunc} built-in function of C always uses the mode which
3839 corresponds to the C data type @code{double} and the @code{truncf}
3840 built-in function uses the mode which corresponds to the C data
3841 type @code{float}.
3842
3843 @cindex @code{round@var{m}2} instruction pattern
3844 @item @samp{round@var{m}2}
3845 Store the argument rounded to integer away from zero.
3846
3847 The @code{round} built-in function of C always uses the mode which
3848 corresponds to the C data type @code{double} and the @code{roundf}
3849 built-in function uses the mode which corresponds to the C data
3850 type @code{float}.
3851
3852 @cindex @code{ceil@var{m}2} instruction pattern
3853 @item @samp{ceil@var{m}2}
3854 Store the argument rounded to integer away from zero.
3855
3856 The @code{ceil} built-in function of C always uses the mode which
3857 corresponds to the C data type @code{double} and the @code{ceilf}
3858 built-in function uses the mode which corresponds to the C data
3859 type @code{float}.
3860
3861 @cindex @code{nearbyint@var{m}2} instruction pattern
3862 @item @samp{nearbyint@var{m}2}
3863 Store the argument rounded according to the default rounding mode
3864
3865 The @code{nearbyint} built-in function of C always uses the mode which
3866 corresponds to the C data type @code{double} and the @code{nearbyintf}
3867 built-in function uses the mode which corresponds to the C data
3868 type @code{float}.
3869
3870 @cindex @code{rint@var{m}2} instruction pattern
3871 @item @samp{rint@var{m}2}
3872 Store the argument rounded according to the default rounding mode and
3873 raise the inexact exception when the result differs in value from
3874 the argument
3875
3876 The @code{rint} built-in function of C always uses the mode which
3877 corresponds to the C data type @code{double} and the @code{rintf}
3878 built-in function uses the mode which corresponds to the C data
3879 type @code{float}.
3880
3881 @cindex @code{lrint@var{m}@var{n}2}
3882 @item @samp{lrint@var{m}@var{n}2}
3883 Convert operand 1 (valid for floating point mode @var{m}) to fixed
3884 point mode @var{n} as a signed number according to the current
3885 rounding mode and store in operand 0 (which has mode @var{n}).
3886
3887 @cindex @code{lround@var{m}@var{n}2}
3888 @item @samp{lround@var{m}2}
3889 Convert operand 1 (valid for floating point mode @var{m}) to fixed
3890 point mode @var{n} as a signed number rounding to nearest and away
3891 from zero and store in operand 0 (which has mode @var{n}).
3892
3893 @cindex @code{lfloor@var{m}@var{n}2}
3894 @item @samp{lfloor@var{m}2}
3895 Convert operand 1 (valid for floating point mode @var{m}) to fixed
3896 point mode @var{n} as a signed number rounding down and store in
3897 operand 0 (which has mode @var{n}).
3898
3899 @cindex @code{lceil@var{m}@var{n}2}
3900 @item @samp{lceil@var{m}2}
3901 Convert operand 1 (valid for floating point mode @var{m}) to fixed
3902 point mode @var{n} as a signed number rounding up and store in
3903 operand 0 (which has mode @var{n}).
3904
3905 @cindex @code{copysign@var{m}3} instruction pattern
3906 @item @samp{copysign@var{m}3}
3907 Store a value with the magnitude of operand 1 and the sign of operand
3908 2 into operand 0.
3909
3910 The @code{copysign} built-in function of C always uses the mode which
3911 corresponds to the C data type @code{double} and the @code{copysignf}
3912 built-in function uses the mode which corresponds to the C data
3913 type @code{float}.
3914
3915 @cindex @code{ffs@var{m}2} instruction pattern
3916 @item @samp{ffs@var{m}2}
3917 Store into operand 0 one plus the index of the least significant 1-bit
3918 of operand 1.  If operand 1 is zero, store zero.  @var{m} is the mode
3919 of operand 0; operand 1's mode is specified by the instruction
3920 pattern, and the compiler will convert the operand to that mode before
3921 generating the instruction.
3922
3923 The @code{ffs} built-in function of C always uses the mode which
3924 corresponds to the C data type @code{int}.
3925
3926 @cindex @code{clz@var{m}2} instruction pattern
3927 @item @samp{clz@var{m}2}
3928 Store into operand 0 the number of leading 0-bits in @var{x}, starting
3929 at the most significant bit position.  If @var{x} is 0, the result is
3930 undefined.  @var{m} is the mode of operand 0; operand 1's mode is
3931 specified by the instruction pattern, and the compiler will convert the
3932 operand to that mode before generating the instruction.
3933
3934 @cindex @code{ctz@var{m}2} instruction pattern
3935 @item @samp{ctz@var{m}2}
3936 Store into operand 0 the number of trailing 0-bits in @var{x}, starting
3937 at the least significant bit position.  If @var{x} is 0, the result is
3938 undefined.  @var{m} is the mode of operand 0; operand 1's mode is
3939 specified by the instruction pattern, and the compiler will convert the
3940 operand to that mode before generating the instruction.
3941
3942 @cindex @code{popcount@var{m}2} instruction pattern
3943 @item @samp{popcount@var{m}2}
3944 Store into operand 0 the number of 1-bits in @var{x}.  @var{m} is the
3945 mode of operand 0; operand 1's mode is specified by the instruction
3946 pattern, and the compiler will convert the operand to that mode before
3947 generating the instruction.
3948
3949 @cindex @code{parity@var{m}2} instruction pattern
3950 @item @samp{parity@var{m}2}
3951 Store into operand 0 the parity of @var{x}, i.e.@: the number of 1-bits
3952 in @var{x} modulo 2.  @var{m} is the mode of operand 0; operand 1's mode
3953 is specified by the instruction pattern, and the compiler will convert
3954 the operand to that mode before generating the instruction.
3955
3956 @cindex @code{one_cmpl@var{m}2} instruction pattern
3957 @item @samp{one_cmpl@var{m}2}
3958 Store the bitwise-complement of operand 1 into operand 0.
3959
3960 @cindex @code{cmp@var{m}} instruction pattern
3961 @item @samp{cmp@var{m}}
3962 Compare operand 0 and operand 1, and set the condition codes.
3963 The RTL pattern should look like this:
3964
3965 @smallexample
3966 (set (cc0) (compare (match_operand:@var{m} 0 @dots{})
3967                     (match_operand:@var{m} 1 @dots{})))
3968 @end smallexample
3969
3970 @cindex @code{tst@var{m}} instruction pattern
3971 @item @samp{tst@var{m}}
3972 Compare operand 0 against zero, and set the condition codes.
3973 The RTL pattern should look like this:
3974
3975 @smallexample
3976 (set (cc0) (match_operand:@var{m} 0 @dots{}))
3977 @end smallexample
3978
3979 @samp{tst@var{m}} patterns should not be defined for machines that do
3980 not use @code{(cc0)}.  Doing so would confuse the optimizer since it
3981 would no longer be clear which @code{set} operations were comparisons.
3982 The @samp{cmp@var{m}} patterns should be used instead.
3983
3984 @cindex @code{movmem@var{m}} instruction pattern
3985 @item @samp{movmem@var{m}}
3986 Block move instruction.  The destination and source blocks of memory
3987 are the first two operands, and both are @code{mem:BLK}s with an
3988 address in mode @code{Pmode}.
3989
3990 The number of bytes to move is the third operand, in mode @var{m}.
3991 Usually, you specify @code{word_mode} for @var{m}.  However, if you can
3992 generate better code knowing the range of valid lengths is smaller than
3993 those representable in a full word, you should provide a pattern with a
3994 mode corresponding to the range of values you can handle efficiently
3995 (e.g., @code{QImode} for values in the range 0--127; note we avoid numbers
3996 that appear negative) and also a pattern with @code{word_mode}.
3997
3998 The fourth operand is the known shared alignment of the source and
3999 destination, in the form of a @code{const_int} rtx.  Thus, if the
4000 compiler knows that both source and destination are word-aligned,
4001 it may provide the value 4 for this operand.
4002
4003 Optional operands 5 and 6 specify expected alignment and size of block
4004 respectively.  The expected alignment differs from alignment in operand 4
4005 in a way that the blocks are not required to be aligned according to it in
4006 all cases. Expected size, when unknown, is set to @code{(const_int -1)}.
4007
4008 Descriptions of multiple @code{movmem@var{m}} patterns can only be
4009 beneficial if the patterns for smaller modes have fewer restrictions
4010 on their first, second and fourth operands.  Note that the mode @var{m}
4011 in @code{movmem@var{m}} does not impose any restriction on the mode of
4012 individually moved data units in the block.
4013
4014 These patterns need not give special consideration to the possibility
4015 that the source and destination strings might overlap.
4016
4017 @cindex @code{movstr} instruction pattern
4018 @item @samp{movstr}
4019 String copy instruction, with @code{stpcpy} semantics.  Operand 0 is
4020 an output operand in mode @code{Pmode}.  The addresses of the
4021 destination and source strings are operands 1 and 2, and both are
4022 @code{mem:BLK}s with addresses in mode @code{Pmode}.  The execution of
4023 the expansion of this pattern should store in operand 0 the address in
4024 which the @code{NUL} terminator was stored in the destination string.
4025
4026 @cindex @code{setmem@var{m}} instruction pattern
4027 @item @samp{setmem@var{m}}
4028 Block set instruction.  The destination string is the first operand,
4029 given as a @code{mem:BLK} whose address is in mode @code{Pmode}.  The
4030 number of bytes to set is the second operand, in mode @var{m}.  The value to
4031 initialize the memory with is the third operand. Targets that only support the
4032 clearing of memory should reject any value that is not the constant 0.  See
4033 @samp{movmem@var{m}} for a discussion of the choice of mode.
4034
4035 The fourth operand is the known alignment of the destination, in the form
4036 of a @code{const_int} rtx.  Thus, if the compiler knows that the
4037 destination is word-aligned, it may provide the value 4 for this
4038 operand.
4039
4040 Optional operands 5 and 6 specify expected alignment and size of block
4041 respectively.  The expected alignment differs from alignment in operand 4
4042 in a way that the blocks are not required to be aligned according to it in
4043 all cases. Expected size, when unknown, is set to @code{(const_int -1)}.
4044
4045 The use for multiple @code{setmem@var{m}} is as for @code{movmem@var{m}}.
4046
4047 @cindex @code{cmpstrn@var{m}} instruction pattern
4048 @item @samp{cmpstrn@var{m}}
4049 String compare instruction, with five operands.  Operand 0 is the output;
4050 it has mode @var{m}.  The remaining four operands are like the operands
4051 of @samp{movmem@var{m}}.  The two memory blocks specified are compared
4052 byte by byte in lexicographic order starting at the beginning of each
4053 string.  The instruction is not allowed to prefetch more than one byte
4054 at a time since either string may end in the first byte and reading past
4055 that may access an invalid page or segment and cause a fault.  The
4056 effect of the instruction is to store a value in operand 0 whose sign
4057 indicates the result of the comparison.
4058
4059 @cindex @code{cmpstr@var{m}} instruction pattern
4060 @item @samp{cmpstr@var{m}}
4061 String compare instruction, without known maximum length.  Operand 0 is the
4062 output; it has mode @var{m}.  The second and third operand are the blocks of
4063 memory to be compared; both are @code{mem:BLK} with an address in mode
4064 @code{Pmode}.
4065
4066 The fourth operand is the known shared alignment of the source and
4067 destination, in the form of a @code{const_int} rtx.  Thus, if the
4068 compiler knows that both source and destination are word-aligned,
4069 it may provide the value 4 for this operand.
4070
4071 The two memory blocks specified are compared byte by byte in lexicographic
4072 order starting at the beginning of each string.  The instruction is not allowed
4073 to prefetch more than one byte at a time since either string may end in the
4074 first byte and reading past that may access an invalid page or segment and
4075 cause a fault.  The effect of the instruction is to store a value in operand 0
4076 whose sign indicates the result of the comparison.
4077
4078 @cindex @code{cmpmem@var{m}} instruction pattern
4079 @item @samp{cmpmem@var{m}}
4080 Block compare instruction, with five operands like the operands
4081 of @samp{cmpstr@var{m}}.  The two memory blocks specified are compared
4082 byte by byte in lexicographic order starting at the beginning of each
4083 block.  Unlike @samp{cmpstr@var{m}} the instruction can prefetch
4084 any bytes in the two memory blocks.  The effect of the instruction is
4085 to store a value in operand 0 whose sign indicates the result of the
4086 comparison.
4087
4088 @cindex @code{strlen@var{m}} instruction pattern
4089 @item @samp{strlen@var{m}}
4090 Compute the length of a string, with three operands.
4091 Operand 0 is the result (of mode @var{m}), operand 1 is
4092 a @code{mem} referring to the first character of the string,
4093 operand 2 is the character to search for (normally zero),
4094 and operand 3 is a constant describing the known alignment
4095 of the beginning of the string.
4096
4097 @cindex @code{float@var{mn}2} instruction pattern
4098 @item @samp{float@var{m}@var{n}2}
4099 Convert signed integer operand 1 (valid for fixed point mode @var{m}) to
4100 floating point mode @var{n} and store in operand 0 (which has mode
4101 @var{n}).
4102
4103 @cindex @code{floatuns@var{mn}2} instruction pattern
4104 @item @samp{floatuns@var{m}@var{n}2}
4105 Convert unsigned integer operand 1 (valid for fixed point mode @var{m})
4106 to floating point mode @var{n} and store in operand 0 (which has mode
4107 @var{n}).
4108
4109 @cindex @code{fix@var{mn}2} instruction pattern
4110 @item @samp{fix@var{m}@var{n}2}
4111 Convert operand 1 (valid for floating point mode @var{m}) to fixed
4112 point mode @var{n} as a signed number and store in operand 0 (which
4113 has mode @var{n}).  This instruction's result is defined only when
4114 the value of operand 1 is an integer.
4115
4116 If the machine description defines this pattern, it also needs to
4117 define the @code{ftrunc} pattern.
4118
4119 @cindex @code{fixuns@var{mn}2} instruction pattern
4120 @item @samp{fixuns@var{m}@var{n}2}
4121 Convert operand 1 (valid for floating point mode @var{m}) to fixed
4122 point mode @var{n} as an unsigned number and store in operand 0 (which
4123 has mode @var{n}).  This instruction's result is defined only when the
4124 value of operand 1 is an integer.
4125
4126 @cindex @code{ftrunc@var{m}2} instruction pattern
4127 @item @samp{ftrunc@var{m}2}
4128 Convert operand 1 (valid for floating point mode @var{m}) to an
4129 integer value, still represented in floating point mode @var{m}, and
4130 store it in operand 0 (valid for floating point mode @var{m}).
4131
4132 @cindex @code{fix_trunc@var{mn}2} instruction pattern
4133 @item @samp{fix_trunc@var{m}@var{n}2}
4134 Like @samp{fix@var{m}@var{n}2} but works for any floating point value
4135 of mode @var{m} by converting the value to an integer.
4136
4137 @cindex @code{fixuns_trunc@var{mn}2} instruction pattern
4138 @item @samp{fixuns_trunc@var{m}@var{n}2}
4139 Like @samp{fixuns@var{m}@var{n}2} but works for any floating point
4140 value of mode @var{m} by converting the value to an integer.
4141
4142 @cindex @code{trunc@var{mn}2} instruction pattern
4143 @item @samp{trunc@var{m}@var{n}2}
4144 Truncate operand 1 (valid for mode @var{m}) to mode @var{n} and
4145 store in operand 0 (which has mode @var{n}).  Both modes must be fixed
4146 point or both floating point.
4147
4148 @cindex @code{extend@var{mn}2} instruction pattern
4149 @item @samp{extend@var{m}@var{n}2}
4150 Sign-extend operand 1 (valid for mode @var{m}) to mode @var{n} and
4151 store in operand 0 (which has mode @var{n}).  Both modes must be fixed
4152 point or both floating point.
4153
4154 @cindex @code{zero_extend@var{mn}2} instruction pattern
4155 @item @samp{zero_extend@var{m}@var{n}2}
4156 Zero-extend operand 1 (valid for mode @var{m}) to mode @var{n} and
4157 store in operand 0 (which has mode @var{n}).  Both modes must be fixed
4158 point.
4159
4160 @cindex @code{extv} instruction pattern
4161 @item @samp{extv}
4162 Extract a bit-field from operand 1 (a register or memory operand), where
4163 operand 2 specifies the width in bits and operand 3 the starting bit,
4164 and store it in operand 0.  Operand 0 must have mode @code{word_mode}.
4165 Operand 1 may have mode @code{byte_mode} or @code{word_mode}; often
4166 @code{word_mode} is allowed only for registers.  Operands 2 and 3 must
4167 be valid for @code{word_mode}.
4168
4169 The RTL generation pass generates this instruction only with constants
4170 for operands 2 and 3 and the constant is never zero for operand 2.
4171
4172 The bit-field value is sign-extended to a full word integer
4173 before it is stored in operand 0.
4174
4175 @cindex @code{extzv} instruction pattern
4176 @item @samp{extzv}
4177 Like @samp{extv} except that the bit-field value is zero-extended.
4178
4179 @cindex @code{insv} instruction pattern
4180 @item @samp{insv}
4181 Store operand 3 (which must be valid for @code{word_mode}) into a
4182 bit-field in operand 0, where operand 1 specifies the width in bits and
4183 operand 2 the starting bit.  Operand 0 may have mode @code{byte_mode} or
4184 @code{word_mode}; often @code{word_mode} is allowed only for registers.
4185 Operands 1 and 2 must be valid for @code{word_mode}.
4186
4187 The RTL generation pass generates this instruction only with constants
4188 for operands 1 and 2 and the constant is never zero for operand 1.
4189
4190 @cindex @code{mov@var{mode}cc} instruction pattern
4191 @item @samp{mov@var{mode}cc}
4192 Conditionally move operand 2 or operand 3 into operand 0 according to the
4193 comparison in operand 1.  If the comparison is true, operand 2 is moved
4194 into operand 0, otherwise operand 3 is moved.
4195
4196 The mode of the operands being compared need not be the same as the operands
4197 being moved.  Some machines, sparc64 for example, have instructions that
4198 conditionally move an integer value based on the floating point condition
4199 codes and vice versa.
4200
4201 If the machine does not have conditional move instructions, do not
4202 define these patterns.
4203
4204 @cindex @code{add@var{mode}cc} instruction pattern
4205 @item @samp{add@var{mode}cc}
4206 Similar to @samp{mov@var{mode}cc} but for conditional addition.  Conditionally
4207 move operand 2 or (operands 2 + operand 3) into operand 0 according to the
4208 comparison in operand 1.  If the comparison is true, operand 2 is moved into
4209 operand 0, otherwise (operand 2 + operand 3) is moved.
4210
4211 @cindex @code{s@var{cond}} instruction pattern
4212 @item @samp{s@var{cond}}
4213 Store zero or nonzero in the operand according to the condition codes.
4214 Value stored is nonzero iff the condition @var{cond} is true.
4215 @var{cond} is the name of a comparison operation expression code, such
4216 as @code{eq}, @code{lt} or @code{leu}.
4217
4218 You specify the mode that the operand must have when you write the
4219 @code{match_operand} expression.  The compiler automatically sees
4220 which mode you have used and supplies an operand of that mode.
4221
4222 The value stored for a true condition must have 1 as its low bit, or
4223 else must be negative.  Otherwise the instruction is not suitable and
4224 you should omit it from the machine description.  You describe to the
4225 compiler exactly which value is stored by defining the macro
4226 @code{STORE_FLAG_VALUE} (@pxref{Misc}).  If a description cannot be
4227 found that can be used for all the @samp{s@var{cond}} patterns, you
4228 should omit those operations from the machine description.
4229
4230 These operations may fail, but should do so only in relatively
4231 uncommon cases; if they would fail for common cases involving
4232 integer comparisons, it is best to omit these patterns.
4233
4234 If these operations are omitted, the compiler will usually generate code
4235 that copies the constant one to the target and branches around an
4236 assignment of zero to the target.  If this code is more efficient than
4237 the potential instructions used for the @samp{s@var{cond}} pattern
4238 followed by those required to convert the result into a 1 or a zero in
4239 @code{SImode}, you should omit the @samp{s@var{cond}} operations from
4240 the machine description.
4241
4242 @cindex @code{b@var{cond}} instruction pattern
4243 @item @samp{b@var{cond}}
4244 Conditional branch instruction.  Operand 0 is a @code{label_ref} that
4245 refers to the label to jump to.  Jump if the condition codes meet
4246 condition @var{cond}.
4247
4248 Some machines do not follow the model assumed here where a comparison
4249 instruction is followed by a conditional branch instruction.  In that
4250 case, the @samp{cmp@var{m}} (and @samp{tst@var{m}}) patterns should
4251 simply store the operands away and generate all the required insns in a
4252 @code{define_expand} (@pxref{Expander Definitions}) for the conditional
4253 branch operations.  All calls to expand @samp{b@var{cond}} patterns are
4254 immediately preceded by calls to expand either a @samp{cmp@var{m}}
4255 pattern or a @samp{tst@var{m}} pattern.
4256
4257 Machines that use a pseudo register for the condition code value, or
4258 where the mode used for the comparison depends on the condition being
4259 tested, should also use the above mechanism.  @xref{Jump Patterns}.
4260
4261 The above discussion also applies to the @samp{mov@var{mode}cc} and
4262 @samp{s@var{cond}} patterns.
4263
4264 @cindex @code{cbranch@var{mode}4} instruction pattern
4265 @item @samp{cbranch@var{mode}4}
4266 Conditional branch instruction combined with a compare instruction.
4267 Operand 0 is a comparison operator.  Operand 1 and operand 2 are the
4268 first and second operands of the comparison, respectively.  Operand 3
4269 is a @code{label_ref} that refers to the label to jump to.
4270
4271 @cindex @code{jump} instruction pattern
4272 @item @samp{jump}
4273 A jump inside a function; an unconditional branch.  Operand 0 is the
4274 @code{label_ref} of the label to jump to.  This pattern name is mandatory
4275 on all machines.
4276
4277 @cindex @code{call} instruction pattern
4278 @item @samp{call}
4279 Subroutine call instruction returning no value.  Operand 0 is the
4280 function to call; operand 1 is the number of bytes of arguments pushed
4281 as a @code{const_int}; operand 2 is the number of registers used as
4282 operands.
4283
4284 On most machines, operand 2 is not actually stored into the RTL
4285 pattern.  It is supplied for the sake of some RISC machines which need
4286 to put this information into the assembler code; they can put it in
4287 the RTL instead of operand 1.
4288
4289 Operand 0 should be a @code{mem} RTX whose address is the address of the
4290 function.  Note, however, that this address can be a @code{symbol_ref}
4291 expression even if it would not be a legitimate memory address on the
4292 target machine.  If it is also not a valid argument for a call
4293 instruction, the pattern for this operation should be a
4294 @code{define_expand} (@pxref{Expander Definitions}) that places the
4295 address into a register and uses that register in the call instruction.
4296
4297 @cindex @code{call_value} instruction pattern
4298 @item @samp{call_value}
4299 Subroutine call instruction returning a value.  Operand 0 is the hard
4300 register in which the value is returned.  There are three more
4301 operands, the same as the three operands of the @samp{call}
4302 instruction (but with numbers increased by one).
4303
4304 Subroutines that return @code{BLKmode} objects use the @samp{call}
4305 insn.
4306
4307 @cindex @code{call_pop} instruction pattern
4308 @cindex @code{call_value_pop} instruction pattern
4309 @item @samp{call_pop}, @samp{call_value_pop}
4310 Similar to @samp{call} and @samp{call_value}, except used if defined and
4311 if @code{RETURN_POPS_ARGS} is nonzero.  They should emit a @code{parallel}
4312 that contains both the function call and a @code{set} to indicate the
4313 adjustment made to the frame pointer.
4314
4315 For machines where @code{RETURN_POPS_ARGS} can be nonzero, the use of these
4316 patterns increases the number of functions for which the frame pointer
4317 can be eliminated, if desired.
4318
4319 @cindex @code{untyped_call} instruction pattern
4320 @item @samp{untyped_call}
4321 Subroutine call instruction returning a value of any type.  Operand 0 is
4322 the function to call; operand 1 is a memory location where the result of
4323 calling the function is to be stored; operand 2 is a @code{parallel}
4324 expression where each element is a @code{set} expression that indicates
4325 the saving of a function return value into the result block.
4326
4327 This instruction pattern should be defined to support
4328 @code{__builtin_apply} on machines where special instructions are needed
4329 to call a subroutine with arbitrary arguments or to save the value
4330 returned.  This instruction pattern is required on machines that have
4331 multiple registers that can hold a return value
4332 (i.e.@: @code{FUNCTION_VALUE_REGNO_P} is true for more than one register).
4333
4334 @cindex @code{return} instruction pattern
4335 @item @samp{return}
4336 Subroutine return instruction.  This instruction pattern name should be
4337 defined only if a single instruction can do all the work of returning
4338 from a function.
4339
4340 Like the @samp{mov@var{m}} patterns, this pattern is also used after the
4341 RTL generation phase.  In this case it is to support machines where
4342 multiple instructions are usually needed to return from a function, but
4343 some class of functions only requires one instruction to implement a
4344 return.  Normally, the applicable functions are those which do not need
4345 to save any registers or allocate stack space.
4346
4347 @findex reload_completed
4348 @findex leaf_function_p
4349 For such machines, the condition specified in this pattern should only
4350 be true when @code{reload_completed} is nonzero and the function's
4351 epilogue would only be a single instruction.  For machines with register
4352 windows, the routine @code{leaf_function_p} may be used to determine if
4353 a register window push is required.
4354
4355 Machines that have conditional return instructions should define patterns
4356 such as
4357
4358 @smallexample
4359 (define_insn ""
4360   [(set (pc)
4361         (if_then_else (match_operator
4362                          0 "comparison_operator"
4363                          [(cc0) (const_int 0)])
4364                       (return)
4365                       (pc)))]
4366   "@var{condition}"
4367   "@dots{}")
4368 @end smallexample
4369
4370 where @var{condition} would normally be the same condition specified on the
4371 named @samp{return} pattern.
4372
4373 @cindex @code{untyped_return} instruction pattern
4374 @item @samp{untyped_return}
4375 Untyped subroutine return instruction.  This instruction pattern should
4376 be defined to support @code{__builtin_return} on machines where special
4377 instructions are needed to return a value of any type.
4378
4379 Operand 0 is a memory location where the result of calling a function
4380 with @code{__builtin_apply} is stored; operand 1 is a @code{parallel}
4381 expression where each element is a @code{set} expression that indicates
4382 the restoring of a function return value from the result block.
4383
4384 @cindex @code{nop} instruction pattern
4385 @item @samp{nop}
4386 No-op instruction.  This instruction pattern name should always be defined
4387 to output a no-op in assembler code.  @code{(const_int 0)} will do as an
4388 RTL pattern.
4389
4390 @cindex @code{indirect_jump} instruction pattern
4391 @item @samp{indirect_jump}
4392 An instruction to jump to an address which is operand zero.
4393 This pattern name is mandatory on all machines.
4394
4395 @cindex @code{casesi} instruction pattern
4396 @item @samp{casesi}
4397 Instruction to jump through a dispatch table, including bounds checking.
4398 This instruction takes five operands:
4399
4400 @enumerate
4401 @item
4402 The index to dispatch on, which has mode @code{SImode}.
4403
4404 @item
4405 The lower bound for indices in the table, an integer constant.
4406
4407 @item
4408 The total range of indices in the table---the largest index
4409 minus the smallest one (both inclusive).
4410
4411 @item
4412 A label that precedes the table itself.
4413
4414 @item
4415 A label to jump to if the index has a value outside the bounds.
4416 @end enumerate
4417
4418 The table is a @code{addr_vec} or @code{addr_diff_vec} inside of a
4419 @code{jump_insn}.  The number of elements in the table is one plus the
4420 difference between the upper bound and the lower bound.
4421
4422 @cindex @code{tablejump} instruction pattern
4423 @item @samp{tablejump}
4424 Instruction to jump to a variable address.  This is a low-level
4425 capability which can be used to implement a dispatch table when there
4426 is no @samp{casesi} pattern.
4427
4428 This pattern requires two operands: the address or offset, and a label
4429 which should immediately precede the jump table.  If the macro
4430 @code{CASE_VECTOR_PC_RELATIVE} evaluates to a nonzero value then the first
4431 operand is an offset which counts from the address of the table; otherwise,
4432 it is an absolute address to jump to.  In either case, the first operand has
4433 mode @code{Pmode}.
4434
4435 The @samp{tablejump} insn is always the last insn before the jump
4436 table it uses.  Its assembler code normally has no need to use the
4437 second operand, but you should incorporate it in the RTL pattern so
4438 that the jump optimizer will not delete the table as unreachable code.
4439
4440
4441 @cindex @code{decrement_and_branch_until_zero} instruction pattern
4442 @item @samp{decrement_and_branch_until_zero}
4443 Conditional branch instruction that decrements a register and
4444 jumps if the register is nonzero.  Operand 0 is the register to
4445 decrement and test; operand 1 is the label to jump to if the
4446 register is nonzero.  @xref{Looping Patterns}.
4447
4448 This optional instruction pattern is only used by the combiner,
4449 typically for loops reversed by the loop optimizer when strength
4450 reduction i