OSDN Git Service

* MAINTAINERS (c4x port): Remove.
[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, 2007, 2008 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 * Iterators::           Using iterators 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
1746 @item R
1747 Integer constant in the range -6 @dots{} 5.
1748
1749 @item Q
1750 A memory address based on Y or Z pointer with displacement.
1751 @end table
1752
1753 @item CRX Architecture---@file{config/crx/crx.h}
1754 @table @code
1755
1756 @item b
1757 Registers from r0 to r14 (registers without stack pointer)
1758
1759 @item l
1760 Register r16 (64-bit accumulator lo register)
1761
1762 @item h
1763 Register r17 (64-bit accumulator hi register)
1764
1765 @item k
1766 Register pair r16-r17. (64-bit accumulator lo-hi pair)
1767
1768 @item I
1769 Constant that fits in 3 bits
1770
1771 @item J
1772 Constant that fits in 4 bits
1773
1774 @item K
1775 Constant that fits in 5 bits
1776
1777 @item L
1778 Constant that is one of -1, 4, -4, 7, 8, 12, 16, 20, 32, 48
1779
1780 @item G
1781 Floating point constant that is legal for store immediate
1782 @end table
1783
1784 @item Hewlett-Packard PA-RISC---@file{config/pa/pa.h}
1785 @table @code
1786 @item a
1787 General register 1
1788
1789 @item f
1790 Floating point register
1791
1792 @item q
1793 Shift amount register
1794
1795 @item x
1796 Floating point register (deprecated)
1797
1798 @item y
1799 Upper floating point register (32-bit), floating point register (64-bit)
1800
1801 @item Z
1802 Any register
1803
1804 @item I
1805 Signed 11-bit integer constant
1806
1807 @item J
1808 Signed 14-bit integer constant
1809
1810 @item K
1811 Integer constant that can be deposited with a @code{zdepi} instruction
1812
1813 @item L
1814 Signed 5-bit integer constant
1815
1816 @item M
1817 Integer constant 0
1818
1819 @item N
1820 Integer constant that can be loaded with a @code{ldil} instruction
1821
1822 @item O
1823 Integer constant whose value plus one is a power of 2
1824
1825 @item P
1826 Integer constant that can be used for @code{and} operations in @code{depi}
1827 and @code{extru} instructions
1828
1829 @item S
1830 Integer constant 31
1831
1832 @item U
1833 Integer constant 63
1834
1835 @item G
1836 Floating-point constant 0.0
1837
1838 @item A
1839 A @code{lo_sum} data-linkage-table memory operand
1840
1841 @item Q
1842 A memory operand that can be used as the destination operand of an
1843 integer store instruction
1844
1845 @item R
1846 A scaled or unscaled indexed memory operand
1847
1848 @item T
1849 A memory operand for floating-point loads and stores
1850
1851 @item W
1852 A register indirect memory operand
1853 @end table
1854
1855 @item PowerPC and IBM RS6000---@file{config/rs6000/rs6000.h}
1856 @table @code
1857 @item b
1858 Address base register
1859
1860 @item f
1861 Floating point register
1862
1863 @item v
1864 Vector register
1865
1866 @item h
1867 @samp{MQ}, @samp{CTR}, or @samp{LINK} register
1868
1869 @item q
1870 @samp{MQ} register
1871
1872 @item c
1873 @samp{CTR} register
1874
1875 @item l
1876 @samp{LINK} register
1877
1878 @item x
1879 @samp{CR} register (condition register) number 0
1880
1881 @item y
1882 @samp{CR} register (condition register)
1883
1884 @item z
1885 @samp{FPMEM} stack memory for FPR-GPR transfers
1886
1887 @item I
1888 Signed 16-bit constant
1889
1890 @item J
1891 Unsigned 16-bit constant shifted left 16 bits (use @samp{L} instead for
1892 @code{SImode} constants)
1893
1894 @item K
1895 Unsigned 16-bit constant
1896
1897 @item L
1898 Signed 16-bit constant shifted left 16 bits
1899
1900 @item M
1901 Constant larger than 31
1902
1903 @item N
1904 Exact power of 2
1905
1906 @item O
1907 Zero
1908
1909 @item P
1910 Constant whose negation is a signed 16-bit constant
1911
1912 @item G
1913 Floating point constant that can be loaded into a register with one
1914 instruction per word
1915
1916 @item H
1917 Integer/Floating point constant that can be loaded into a register using
1918 three instructions
1919
1920 @item Q
1921 Memory operand that is an offset from a register (@samp{m} is preferable
1922 for @code{asm} statements)
1923
1924 @item Z
1925 Memory operand that is an indexed or indirect from a register (@samp{m} is
1926 preferable for @code{asm} statements)
1927
1928 @item R
1929 AIX TOC entry
1930
1931 @item a
1932 Address operand that is an indexed or indirect from a register (@samp{p} is
1933 preferable for @code{asm} statements)
1934
1935 @item S
1936 Constant suitable as a 64-bit mask operand
1937
1938 @item T
1939 Constant suitable as a 32-bit mask operand
1940
1941 @item U
1942 System V Release 4 small data area reference
1943
1944 @item t
1945 AND masks that can be performed by two rldic@{l, r@} instructions
1946
1947 @item W
1948 Vector constant that does not require memory
1949
1950 @end table
1951
1952 @item MorphoTech family---@file{config/mt/mt.h}
1953 @table @code
1954 @item I
1955 Constant for an arithmetic insn (16-bit signed integer).
1956
1957 @item J
1958 The constant 0.
1959
1960 @item K
1961 Constant for a logical insn (16-bit zero-extended integer).
1962
1963 @item L
1964 A constant that can be loaded with @code{lui} (i.e.@: the bottom 16
1965 bits are zero).
1966
1967 @item M
1968 A constant that takes two words to load (i.e.@: not matched by
1969 @code{I}, @code{K}, or @code{L}).
1970
1971 @item N
1972 Negative 16-bit constants other than -65536.
1973
1974 @item O
1975 A 15-bit signed integer constant.
1976
1977 @item P
1978 A positive 16-bit constant.
1979 @end table
1980
1981 @item Intel 386---@file{config/i386/constraints.md}
1982 @table @code
1983 @item R
1984 Legacy register---the eight integer registers available on all
1985 i386 processors (@code{a}, @code{b}, @code{c}, @code{d},
1986 @code{si}, @code{di}, @code{bp}, @code{sp}).
1987
1988 @item q
1989 Any register accessible as @code{@var{r}l}.  In 32-bit mode, @code{a},
1990 @code{b}, @code{c}, and @code{d}; in 64-bit mode, any integer register.
1991
1992 @item Q
1993 Any register accessible as @code{@var{r}h}: @code{a}, @code{b},
1994 @code{c}, and @code{d}.
1995
1996 @ifset INTERNALS
1997 @item l
1998 Any register that can be used as the index in a base+index memory
1999 access: that is, any general register except the stack pointer.
2000 @end ifset
2001
2002 @item a
2003 The @code{a} register.
2004
2005 @item b
2006 The @code{b} register.
2007
2008 @item c
2009 The @code{c} register.
2010
2011 @item d
2012 The @code{d} register.
2013
2014 @item S
2015 The @code{si} register.
2016
2017 @item D
2018 The @code{di} register.
2019
2020 @item A
2021 The @code{a} and @code{d} registers, as a pair (for instructions that
2022 return half the result in one and half in the other).
2023
2024 @item f
2025 Any 80387 floating-point (stack) register.
2026
2027 @item t
2028 Top of 80387 floating-point stack (@code{%st(0)}).
2029
2030 @item u
2031 Second from top of 80387 floating-point stack (@code{%st(1)}).
2032
2033 @item y
2034 Any MMX register.
2035
2036 @item x
2037 Any SSE register.
2038
2039 @ifset INTERNALS
2040 @item Y
2041 Any SSE2 register.
2042 @end ifset
2043
2044 @item I
2045 Integer constant in the range 0 @dots{} 31, for 32-bit shifts.
2046
2047 @item J
2048 Integer constant in the range 0 @dots{} 63, for 64-bit shifts.
2049
2050 @item K
2051 Signed 8-bit integer constant.
2052
2053 @item L
2054 @code{0xFF} or @code{0xFFFF}, for andsi as a zero-extending move.
2055
2056 @item M
2057 0, 1, 2, or 3 (shifts for the @code{lea} instruction).
2058
2059 @item N
2060 Unsigned 8-bit integer constant (for @code{in} and @code{out} 
2061 instructions).
2062
2063 @ifset INTERNALS
2064 @item O
2065 Integer constant in the range 0 @dots{} 127, for 128-bit shifts.
2066 @end ifset
2067
2068 @item G
2069 Standard 80387 floating point constant.
2070
2071 @item C
2072 Standard SSE floating point constant.
2073
2074 @item e
2075 32-bit signed integer constant, or a symbolic reference known
2076 to fit that range (for immediate operands in sign-extending x86-64
2077 instructions).
2078
2079 @item Z
2080 32-bit unsigned integer constant, or a symbolic reference known
2081 to fit that range (for immediate operands in zero-extending x86-64
2082 instructions).
2083
2084 @end table
2085
2086 @item Intel IA-64---@file{config/ia64/ia64.h}
2087 @table @code
2088 @item a
2089 General register @code{r0} to @code{r3} for @code{addl} instruction
2090
2091 @item b
2092 Branch register
2093
2094 @item c
2095 Predicate register (@samp{c} as in ``conditional'')
2096
2097 @item d
2098 Application register residing in M-unit
2099
2100 @item e
2101 Application register residing in I-unit
2102
2103 @item f
2104 Floating-point register
2105
2106 @item m
2107 Memory operand.
2108 Remember that @samp{m} allows postincrement and postdecrement which
2109 require printing with @samp{%Pn} on IA-64.
2110 Use @samp{S} to disallow postincrement and postdecrement.
2111
2112 @item G
2113 Floating-point constant 0.0 or 1.0
2114
2115 @item I
2116 14-bit signed integer constant
2117
2118 @item J
2119 22-bit signed integer constant
2120
2121 @item K
2122 8-bit signed integer constant for logical instructions
2123
2124 @item L
2125 8-bit adjusted signed integer constant for compare pseudo-ops
2126
2127 @item M
2128 6-bit unsigned integer constant for shift counts
2129
2130 @item N
2131 9-bit signed integer constant for load and store postincrements
2132
2133 @item O
2134 The constant zero
2135
2136 @item P
2137 0 or @minus{}1 for @code{dep} instruction
2138
2139 @item Q
2140 Non-volatile memory for floating-point loads and stores
2141
2142 @item R
2143 Integer constant in the range 1 to 4 for @code{shladd} instruction
2144
2145 @item S
2146 Memory operand except postincrement and postdecrement
2147 @end table
2148
2149 @item FRV---@file{config/frv/frv.h}
2150 @table @code
2151 @item a
2152 Register in the class @code{ACC_REGS} (@code{acc0} to @code{acc7}).
2153
2154 @item b
2155 Register in the class @code{EVEN_ACC_REGS} (@code{acc0} to @code{acc7}).
2156
2157 @item c
2158 Register in the class @code{CC_REGS} (@code{fcc0} to @code{fcc3} and
2159 @code{icc0} to @code{icc3}).
2160
2161 @item d
2162 Register in the class @code{GPR_REGS} (@code{gr0} to @code{gr63}).
2163
2164 @item e
2165 Register in the class @code{EVEN_REGS} (@code{gr0} to @code{gr63}).
2166 Odd registers are excluded not in the class but through the use of a machine
2167 mode larger than 4 bytes.
2168
2169 @item f
2170 Register in the class @code{FPR_REGS} (@code{fr0} to @code{fr63}).
2171
2172 @item h
2173 Register in the class @code{FEVEN_REGS} (@code{fr0} to @code{fr63}).
2174 Odd registers are excluded not in the class but through the use of a machine
2175 mode larger than 4 bytes.
2176
2177 @item l
2178 Register in the class @code{LR_REG} (the @code{lr} register).
2179
2180 @item q
2181 Register in the class @code{QUAD_REGS} (@code{gr2} to @code{gr63}).
2182 Register numbers not divisible by 4 are excluded not in the class but through
2183 the use of a machine mode larger than 8 bytes.
2184
2185 @item t
2186 Register in the class @code{ICC_REGS} (@code{icc0} to @code{icc3}).
2187
2188 @item u
2189 Register in the class @code{FCC_REGS} (@code{fcc0} to @code{fcc3}).
2190
2191 @item v
2192 Register in the class @code{ICR_REGS} (@code{cc4} to @code{cc7}).
2193
2194 @item w
2195 Register in the class @code{FCR_REGS} (@code{cc0} to @code{cc3}).
2196
2197 @item x
2198 Register in the class @code{QUAD_FPR_REGS} (@code{fr0} to @code{fr63}).
2199 Register numbers not divisible by 4 are excluded not in the class but through
2200 the use of a machine mode larger than 8 bytes.
2201
2202 @item z
2203 Register in the class @code{SPR_REGS} (@code{lcr} and @code{lr}).
2204
2205 @item A
2206 Register in the class @code{QUAD_ACC_REGS} (@code{acc0} to @code{acc7}).
2207
2208 @item B
2209 Register in the class @code{ACCG_REGS} (@code{accg0} to @code{accg7}).
2210
2211 @item C
2212 Register in the class @code{CR_REGS} (@code{cc0} to @code{cc7}).
2213
2214 @item G
2215 Floating point constant zero
2216
2217 @item I
2218 6-bit signed integer constant
2219
2220 @item J
2221 10-bit signed integer constant
2222
2223 @item L
2224 16-bit signed integer constant
2225
2226 @item M
2227 16-bit unsigned integer constant
2228
2229 @item N
2230 12-bit signed integer constant that is negative---i.e.@: in the
2231 range of @minus{}2048 to @minus{}1
2232
2233 @item O
2234 Constant zero
2235
2236 @item P
2237 12-bit signed integer constant that is greater than zero---i.e.@: in the
2238 range of 1 to 2047.
2239
2240 @end table
2241
2242 @item Blackfin family---@file{config/bfin/bfin.h}
2243 @table @code
2244 @item a
2245 P register
2246
2247 @item d
2248 D register
2249
2250 @item z
2251 A call clobbered P register.
2252
2253 @item q@var{n}
2254 A single register.  If @var{n} is in the range 0 to 7, the corresponding D
2255 register.  If it is @code{A}, then the register P0.
2256
2257 @item D
2258 Even-numbered D register
2259
2260 @item W
2261 Odd-numbered D register
2262
2263 @item e
2264 Accumulator register.
2265
2266 @item A
2267 Even-numbered accumulator register.
2268
2269 @item B
2270 Odd-numbered accumulator register.
2271
2272 @item b
2273 I register
2274
2275 @item v
2276 B register
2277
2278 @item f
2279 M register
2280
2281 @item c
2282 Registers used for circular buffering, i.e. I, B, or L registers.
2283
2284 @item C
2285 The CC register.
2286
2287 @item t
2288 LT0 or LT1.
2289
2290 @item k
2291 LC0 or LC1.
2292
2293 @item u
2294 LB0 or LB1.
2295
2296 @item x
2297 Any D, P, B, M, I or L register.
2298
2299 @item y
2300 Additional registers typically used only in prologues and epilogues: RETS,
2301 RETN, RETI, RETX, RETE, ASTAT, SEQSTAT and USP.
2302
2303 @item w
2304 Any register except accumulators or CC.
2305
2306 @item Ksh
2307 Signed 16 bit integer (in the range -32768 to 32767)
2308
2309 @item Kuh
2310 Unsigned 16 bit integer (in the range 0 to 65535)
2311
2312 @item Ks7
2313 Signed 7 bit integer (in the range -64 to 63)
2314
2315 @item Ku7
2316 Unsigned 7 bit integer (in the range 0 to 127)
2317
2318 @item Ku5
2319 Unsigned 5 bit integer (in the range 0 to 31)
2320
2321 @item Ks4
2322 Signed 4 bit integer (in the range -8 to 7)
2323
2324 @item Ks3
2325 Signed 3 bit integer (in the range -3 to 4)
2326
2327 @item Ku3
2328 Unsigned 3 bit integer (in the range 0 to 7)
2329
2330 @item P@var{n}
2331 Constant @var{n}, where @var{n} is a single-digit constant in the range 0 to 4.
2332
2333 @item PA
2334 An integer equal to one of the MACFLAG_XXX constants that is suitable for
2335 use with either accumulator.
2336
2337 @item PB
2338 An integer equal to one of the MACFLAG_XXX constants that is suitable for
2339 use only with accumulator A1.
2340
2341 @item M1
2342 Constant 255.
2343
2344 @item M2
2345 Constant 65535.
2346
2347 @item J
2348 An integer constant with exactly a single bit set.
2349
2350 @item L
2351 An integer constant with all bits set except exactly one.
2352
2353 @item H
2354
2355 @item Q
2356 Any SYMBOL_REF.
2357 @end table
2358
2359 @item M32C---@file{config/m32c/m32c.c}
2360 @table @code
2361 @item Rsp
2362 @itemx Rfb
2363 @itemx Rsb
2364 @samp{$sp}, @samp{$fb}, @samp{$sb}.
2365
2366 @item Rcr
2367 Any control register, when they're 16 bits wide (nothing if control
2368 registers are 24 bits wide)
2369
2370 @item Rcl
2371 Any control register, when they're 24 bits wide.
2372
2373 @item R0w
2374 @itemx R1w
2375 @itemx R2w
2376 @itemx R3w
2377 $r0, $r1, $r2, $r3.
2378
2379 @item R02
2380 $r0 or $r2, or $r2r0 for 32 bit values.
2381
2382 @item R13
2383 $r1 or $r3, or $r3r1 for 32 bit values.
2384
2385 @item Rdi
2386 A register that can hold a 64 bit value.
2387
2388 @item Rhl
2389 $r0 or $r1 (registers with addressable high/low bytes)
2390
2391 @item R23
2392 $r2 or $r3
2393
2394 @item Raa
2395 Address registers
2396
2397 @item Raw
2398 Address registers when they're 16 bits wide.
2399
2400 @item Ral
2401 Address registers when they're 24 bits wide.
2402
2403 @item Rqi
2404 Registers that can hold QI values.
2405
2406 @item Rad
2407 Registers that can be used with displacements ($a0, $a1, $sb).
2408
2409 @item Rsi
2410 Registers that can hold 32 bit values.
2411
2412 @item Rhi
2413 Registers that can hold 16 bit values.
2414
2415 @item Rhc
2416 Registers chat can hold 16 bit values, including all control
2417 registers.
2418
2419 @item Rra
2420 $r0 through R1, plus $a0 and $a1.
2421
2422 @item Rfl
2423 The flags register.
2424
2425 @item Rmm
2426 The memory-based pseudo-registers $mem0 through $mem15.
2427
2428 @item Rpi
2429 Registers that can hold pointers (16 bit registers for r8c, m16c; 24
2430 bit registers for m32cm, m32c).
2431
2432 @item Rpa
2433 Matches multiple registers in a PARALLEL to form a larger register.
2434 Used to match function return values.
2435
2436 @item Is3
2437 -8 @dots{} 7
2438
2439 @item IS1
2440 -128 @dots{} 127
2441
2442 @item IS2
2443 -32768 @dots{} 32767
2444
2445 @item IU2
2446 0 @dots{} 65535
2447
2448 @item In4
2449 -8 @dots{} -1 or 1 @dots{} 8
2450
2451 @item In5
2452 -16 @dots{} -1 or 1 @dots{} 16
2453
2454 @item In6
2455 -32 @dots{} -1 or 1 @dots{} 32
2456
2457 @item IM2
2458 -65536 @dots{} -1
2459
2460 @item Ilb
2461 An 8 bit value with exactly one bit set.
2462
2463 @item Ilw
2464 A 16 bit value with exactly one bit set.
2465
2466 @item Sd
2467 The common src/dest memory addressing modes.
2468
2469 @item Sa
2470 Memory addressed using $a0 or $a1.
2471
2472 @item Si
2473 Memory addressed with immediate addresses.
2474
2475 @item Ss
2476 Memory addressed using the stack pointer ($sp).
2477
2478 @item Sf
2479 Memory addressed using the frame base register ($fb).
2480
2481 @item Ss
2482 Memory addressed using the small base register ($sb).
2483
2484 @item S1
2485 $r1h
2486 @end table
2487
2488 @item MIPS---@file{config/mips/constraints.md}
2489 @table @code
2490 @item d
2491 An address register.  This is equivalent to @code{r} unless
2492 generating MIPS16 code.
2493
2494 @item f
2495 A floating-point register (if available).
2496
2497 @item h
2498 The @code{hi} register.
2499
2500 @item l
2501 The @code{lo} register.
2502
2503 @item x
2504 The @code{hi} and @code{lo} registers.
2505
2506 @item c
2507 A register suitable for use in an indirect jump.  This will always be
2508 @code{$25} for @option{-mabicalls}.
2509
2510 @item y
2511 Equivalent to @code{r}; retained for backwards compatibility.
2512
2513 @item z
2514 A floating-point condition code register.
2515
2516 @item I
2517 A signed 16-bit constant (for arithmetic instructions).
2518
2519 @item J
2520 Integer zero.
2521
2522 @item K
2523 An unsigned 16-bit constant (for logic instructions).
2524
2525 @item L
2526 A signed 32-bit constant in which the lower 16 bits are zero.
2527 Such constants can be loaded using @code{lui}.
2528
2529 @item M
2530 A constant that cannot be loaded using @code{lui}, @code{addiu}
2531 or @code{ori}.
2532
2533 @item N
2534 A constant in the range -65535 to -1 (inclusive).
2535
2536 @item O
2537 A signed 15-bit constant.
2538
2539 @item P
2540 A constant in the range 1 to 65535 (inclusive).
2541
2542 @item G
2543 Floating-point zero.
2544
2545 @item R
2546 An address that can be used in a non-macro load or store.
2547 @end table
2548
2549 @item Motorola 680x0---@file{config/m68k/constraints.md}
2550 @table @code
2551 @item a
2552 Address register
2553
2554 @item d
2555 Data register
2556
2557 @item f
2558 68881 floating-point register, if available
2559
2560 @item I
2561 Integer in the range 1 to 8
2562
2563 @item J
2564 16-bit signed number
2565
2566 @item K
2567 Signed number whose magnitude is greater than 0x80
2568
2569 @item L
2570 Integer in the range @minus{}8 to @minus{}1
2571
2572 @item M
2573 Signed number whose magnitude is greater than 0x100
2574
2575 @item N
2576 Range 24 to 31, rotatert:SI 8 to 1 expressed as rotate
2577
2578 @item O
2579 16 (for rotate using swap)
2580
2581 @item P
2582 Range 8 to 15, rotatert:HI 8 to 1 expressed as rotate
2583
2584 @item R
2585 Numbers that mov3q can handle
2586
2587 @item G
2588 Floating point constant that is not a 68881 constant
2589
2590 @item S
2591 Operands that satisfy 'm' when -mpcrel is in effect
2592
2593 @item T
2594 Operands that satisfy 's' when -mpcrel is not in effect
2595
2596 @item Q
2597 Address register indirect addressing mode
2598
2599 @item U
2600 Register offset addressing
2601
2602 @item W
2603 const_call_operand
2604
2605 @item Cs
2606 symbol_ref or const
2607
2608 @item Ci
2609 const_int
2610
2611 @item C0
2612 const_int 0
2613
2614 @item Cj
2615 Range of signed numbers that don't fit in 16 bits
2616
2617 @item Cmvq
2618 Integers valid for mvq
2619
2620 @item Capsw
2621 Integers valid for a moveq followed by a swap
2622
2623 @item Cmvz
2624 Integers valid for mvz
2625
2626 @item Cmvs
2627 Integers valid for mvs
2628
2629 @item Ap
2630 push_operand
2631
2632 @item Ac
2633 Non-register operands allowed in clr
2634
2635 @end table
2636
2637 @item Motorola 68HC11 & 68HC12 families---@file{config/m68hc11/m68hc11.h}
2638 @table @code
2639 @item a
2640 Register `a'
2641
2642 @item b
2643 Register `b'
2644
2645 @item d
2646 Register `d'
2647
2648 @item q
2649 An 8-bit register
2650
2651 @item t
2652 Temporary soft register _.tmp
2653
2654 @item u
2655 A soft register _.d1 to _.d31
2656
2657 @item w
2658 Stack pointer register
2659
2660 @item x
2661 Register `x'
2662
2663 @item y
2664 Register `y'
2665
2666 @item z
2667 Pseudo register `z' (replaced by `x' or `y' at the end)
2668
2669 @item A
2670 An address register: x, y or z
2671
2672 @item B
2673 An address register: x or y
2674
2675 @item D
2676 Register pair (x:d) to form a 32-bit value
2677
2678 @item L
2679 Constants in the range @minus{}65536 to 65535
2680
2681 @item M
2682 Constants whose 16-bit low part is zero
2683
2684 @item N
2685 Constant integer 1 or @minus{}1
2686
2687 @item O
2688 Constant integer 16
2689
2690 @item P
2691 Constants in the range @minus{}8 to 2
2692
2693 @end table
2694
2695 @need 1000
2696 @item SPARC---@file{config/sparc/sparc.h}
2697 @table @code
2698 @item f
2699 Floating-point register on the SPARC-V8 architecture and
2700 lower floating-point register on the SPARC-V9 architecture.
2701
2702 @item e
2703 Floating-point register.  It is equivalent to @samp{f} on the
2704 SPARC-V8 architecture and contains both lower and upper
2705 floating-point registers on the SPARC-V9 architecture.
2706
2707 @item c
2708 Floating-point condition code register.
2709
2710 @item d
2711 Lower floating-point register.  It is only valid on the SPARC-V9
2712 architecture when the Visual Instruction Set is available.
2713
2714 @item b
2715 Floating-point register.  It is only valid on the SPARC-V9 architecture
2716 when the Visual Instruction Set is available.
2717
2718 @item h
2719 64-bit global or out register for the SPARC-V8+ architecture.
2720
2721 @item I
2722 Signed 13-bit constant
2723
2724 @item J
2725 Zero
2726
2727 @item K
2728 32-bit constant with the low 12 bits clear (a constant that can be
2729 loaded with the @code{sethi} instruction)
2730
2731 @item L
2732 A constant in the range supported by @code{movcc} instructions
2733
2734 @item M
2735 A constant in the range supported by @code{movrcc} instructions
2736
2737 @item N
2738 Same as @samp{K}, except that it verifies that bits that are not in the
2739 lower 32-bit range are all zero.  Must be used instead of @samp{K} for
2740 modes wider than @code{SImode}
2741
2742 @item O
2743 The constant 4096
2744
2745 @item G
2746 Floating-point zero
2747
2748 @item H
2749 Signed 13-bit constant, sign-extended to 32 or 64 bits
2750
2751 @item Q
2752 Floating-point constant whose integral representation can
2753 be moved into an integer register using a single sethi
2754 instruction
2755
2756 @item R
2757 Floating-point constant whose integral representation can
2758 be moved into an integer register using a single mov
2759 instruction
2760
2761 @item S
2762 Floating-point constant whose integral representation can
2763 be moved into an integer register using a high/lo_sum
2764 instruction sequence
2765
2766 @item T
2767 Memory address aligned to an 8-byte boundary
2768
2769 @item U
2770 Even register
2771
2772 @item W
2773 Memory address for @samp{e} constraint registers
2774
2775 @item Y
2776 Vector zero
2777
2778 @end table
2779
2780 @item SPU---@file{config/spu/spu.h}
2781 @table @code
2782 @item a
2783 An immediate which can be loaded with the il/ila/ilh/ilhu instructions.  const_int is treated as a 64 bit value.  
2784
2785 @item c
2786 An immediate for and/xor/or instructions.  const_int is treated as a 64 bit value.  
2787
2788 @item d
2789 An immediate for the @code{iohl} instruction.  const_int is treated as a 64 bit value.  
2790
2791 @item f
2792 An immediate which can be loaded with @code{fsmbi}.  
2793
2794 @item A
2795 An immediate which can be loaded with the il/ila/ilh/ilhu instructions.  const_int is treated as a 32 bit value.  
2796
2797 @item B
2798 An immediate for most arithmetic instructions.  const_int is treated as a 32 bit value.  
2799
2800 @item C
2801 An immediate for and/xor/or instructions.  const_int is treated as a 32 bit value.  
2802
2803 @item D
2804 An immediate for the @code{iohl} instruction.  const_int is treated as a 32 bit value.  
2805
2806 @item I
2807 A constant in the range [-64, 63] for shift/rotate instructions.  
2808
2809 @item J
2810 An unsigned 7-bit constant for conversion/nop/channel instructions.  
2811
2812 @item K
2813 A signed 10-bit constant for most arithmetic instructions.  
2814
2815 @item M
2816 A signed 16 bit immediate for @code{stop}.  
2817
2818 @item N
2819 An unsigned 16-bit constant for @code{iohl} and @code{fsmbi}.  
2820
2821 @item O
2822 An unsigned 7-bit constant whose 3 least significant bits are 0.  
2823
2824 @item P
2825 An unsigned 3-bit constant for 16-byte rotates and shifts 
2826
2827 @item R
2828 Call operand, reg, for indirect calls 
2829
2830 @item S
2831 Call operand, symbol, for relative calls.  
2832
2833 @item T
2834 Call operand, const_int, for absolute calls.  
2835
2836 @item U
2837 An immediate which can be loaded with the il/ila/ilh/ilhu instructions.  const_int is sign extended to 128 bit.  
2838
2839 @item W
2840 An immediate for shift and rotate instructions.  const_int is treated as a 32 bit value.  
2841
2842 @item Y
2843 An immediate for and/xor/or instructions.  const_int is sign extended as a 128 bit.  
2844
2845 @item Z
2846 An immediate for the @code{iohl} instruction.  const_int is sign extended to 128 bit.  
2847
2848 @end table
2849
2850 @item S/390 and zSeries---@file{config/s390/s390.h}
2851 @table @code
2852 @item a
2853 Address register (general purpose register except r0)
2854
2855 @item c
2856 Condition code register
2857
2858 @item d
2859 Data register (arbitrary general purpose register)
2860
2861 @item f
2862 Floating-point register
2863
2864 @item I
2865 Unsigned 8-bit constant (0--255)
2866
2867 @item J
2868 Unsigned 12-bit constant (0--4095)
2869
2870 @item K
2871 Signed 16-bit constant (@minus{}32768--32767)
2872
2873 @item L
2874 Value appropriate as displacement.
2875 @table @code
2876        @item (0..4095)
2877        for short displacement
2878        @item (-524288..524287)
2879        for long displacement
2880 @end table
2881
2882 @item M
2883 Constant integer with a value of 0x7fffffff.
2884
2885 @item N
2886 Multiple letter constraint followed by 4 parameter letters.
2887 @table @code
2888          @item 0..9:
2889          number of the part counting from most to least significant
2890          @item H,Q:
2891          mode of the part
2892          @item D,S,H:
2893          mode of the containing operand
2894          @item 0,F:
2895          value of the other parts (F---all bits set)
2896 @end table
2897 The constraint matches if the specified part of a constant
2898 has a value different from it's other parts.
2899
2900 @item Q
2901 Memory reference without index register and with short displacement.
2902
2903 @item R
2904 Memory reference with index register and short displacement.
2905
2906 @item S
2907 Memory reference without index register but with long displacement.
2908
2909 @item T
2910 Memory reference with index register and long displacement.
2911
2912 @item U
2913 Pointer with short displacement.
2914
2915 @item W
2916 Pointer with long displacement.
2917
2918 @item Y
2919 Shift count operand.
2920
2921 @end table
2922
2923 @item Score family---@file{config/score/score.h}
2924 @table @code
2925 @item d
2926 Registers from r0 to r32.
2927
2928 @item e
2929 Registers from r0 to r16.
2930
2931 @item t
2932 r8---r11 or r22---r27 registers.
2933
2934 @item h
2935 hi register.
2936
2937 @item l
2938 lo register.
2939
2940 @item x
2941 hi + lo register.
2942
2943 @item q
2944 cnt register.
2945
2946 @item y
2947 lcb register.
2948
2949 @item z
2950 scb register.
2951
2952 @item a
2953 cnt + lcb + scb register.
2954
2955 @item c
2956 cr0---cr15 register.
2957
2958 @item b
2959 cp1 registers.
2960
2961 @item f
2962 cp2 registers.
2963
2964 @item i
2965 cp3 registers.
2966
2967 @item j
2968 cp1 + cp2 + cp3 registers.
2969
2970 @item I
2971 High 16-bit constant (32-bit constant with 16 LSBs zero).
2972
2973 @item J
2974 Unsigned 5 bit integer (in the range 0 to 31).
2975
2976 @item K
2977 Unsigned 16 bit integer (in the range 0 to 65535).
2978
2979 @item L
2980 Signed 16 bit integer (in the range @minus{}32768 to 32767).
2981
2982 @item M
2983 Unsigned 14 bit integer (in the range 0 to 16383).
2984
2985 @item N
2986 Signed 14 bit integer (in the range @minus{}8192 to 8191).
2987
2988 @item Z
2989 Any SYMBOL_REF.
2990 @end table
2991
2992 @item Xstormy16---@file{config/stormy16/stormy16.h}
2993 @table @code
2994 @item a
2995 Register r0.
2996
2997 @item b
2998 Register r1.
2999
3000 @item c
3001 Register r2.
3002
3003 @item d
3004 Register r8.
3005
3006 @item e
3007 Registers r0 through r7.
3008
3009 @item t
3010 Registers r0 and r1.
3011
3012 @item y
3013 The carry register.
3014
3015 @item z
3016 Registers r8 and r9.
3017
3018 @item I
3019 A constant between 0 and 3 inclusive.
3020
3021 @item J
3022 A constant that has exactly one bit set.
3023
3024 @item K
3025 A constant that has exactly one bit clear.
3026
3027 @item L
3028 A constant between 0 and 255 inclusive.
3029
3030 @item M
3031 A constant between @minus{}255 and 0 inclusive.
3032
3033 @item N
3034 A constant between @minus{}3 and 0 inclusive.
3035
3036 @item O
3037 A constant between 1 and 4 inclusive.
3038
3039 @item P
3040 A constant between @minus{}4 and @minus{}1 inclusive.
3041
3042 @item Q
3043 A memory reference that is a stack push.
3044
3045 @item R
3046 A memory reference that is a stack pop.
3047
3048 @item S
3049 A memory reference that refers to a constant address of known value.
3050
3051 @item T
3052 The register indicated by Rx (not implemented yet).
3053
3054 @item U
3055 A constant that is not between 2 and 15 inclusive.
3056
3057 @item Z
3058 The constant 0.
3059
3060 @end table
3061
3062 @item Xtensa---@file{config/xtensa/constraints.md}
3063 @table @code
3064 @item a
3065 General-purpose 32-bit register
3066
3067 @item b
3068 One-bit boolean register
3069
3070 @item A
3071 MAC16 40-bit accumulator register
3072
3073 @item I
3074 Signed 12-bit integer constant, for use in MOVI instructions
3075
3076 @item J
3077 Signed 8-bit integer constant, for use in ADDI instructions
3078
3079 @item K
3080 Integer constant valid for BccI instructions
3081
3082 @item L
3083 Unsigned constant valid for BccUI instructions
3084
3085 @end table
3086
3087 @end table
3088
3089 @ifset INTERNALS
3090 @node Define Constraints
3091 @subsection Defining Machine-Specific Constraints
3092 @cindex defining constraints
3093 @cindex constraints, defining
3094
3095 Machine-specific constraints fall into two categories: register and
3096 non-register constraints.  Within the latter category, constraints
3097 which allow subsets of all possible memory or address operands should
3098 be specially marked, to give @code{reload} more information.
3099
3100 Machine-specific constraints can be given names of arbitrary length,
3101 but they must be entirely composed of letters, digits, underscores
3102 (@samp{_}), and angle brackets (@samp{< >}).  Like C identifiers, they
3103 must begin with a letter or underscore. 
3104
3105 In order to avoid ambiguity in operand constraint strings, no
3106 constraint can have a name that begins with any other constraint's
3107 name.  For example, if @code{x} is defined as a constraint name,
3108 @code{xy} may not be, and vice versa.  As a consequence of this rule,
3109 no constraint may begin with one of the generic constraint letters:
3110 @samp{E F V X g i m n o p r s}.
3111
3112 Register constraints correspond directly to register classes.
3113 @xref{Register Classes}.  There is thus not much flexibility in their
3114 definitions.
3115
3116 @deffn {MD Expression} define_register_constraint name regclass docstring
3117 All three arguments are string constants.
3118 @var{name} is the name of the constraint, as it will appear in
3119 @code{match_operand} expressions.  If @var{name} is a multi-letter
3120 constraint its length shall be the same for all constraints starting
3121 with the same letter.  @var{regclass} can be either the
3122 name of the corresponding register class (@pxref{Register Classes}),
3123 or a C expression which evaluates to the appropriate register class.
3124 If it is an expression, it must have no side effects, and it cannot
3125 look at the operand.  The usual use of expressions is to map some
3126 register constraints to @code{NO_REGS} when the register class
3127 is not available on a given subarchitecture.
3128
3129 @var{docstring} is a sentence documenting the meaning of the
3130 constraint.  Docstrings are explained further below.
3131 @end deffn
3132
3133 Non-register constraints are more like predicates: the constraint
3134 definition gives a Boolean expression which indicates whether the
3135 constraint matches.
3136
3137 @deffn {MD Expression} define_constraint name docstring exp
3138 The @var{name} and @var{docstring} arguments are the same as for
3139 @code{define_register_constraint}, but note that the docstring comes
3140 immediately after the name for these expressions.  @var{exp} is an RTL
3141 expression, obeying the same rules as the RTL expressions in predicate
3142 definitions.  @xref{Defining Predicates}, for details.  If it
3143 evaluates true, the constraint matches; if it evaluates false, it
3144 doesn't. Constraint expressions should indicate which RTL codes they
3145 might match, just like predicate expressions.
3146
3147 @code{match_test} C expressions have access to the
3148 following variables:
3149
3150 @table @var
3151 @item op
3152 The RTL object defining the operand.
3153 @item mode
3154 The machine mode of @var{op}.
3155 @item ival
3156 @samp{INTVAL (@var{op})}, if @var{op} is a @code{const_int}.
3157 @item hval
3158 @samp{CONST_DOUBLE_HIGH (@var{op})}, if @var{op} is an integer
3159 @code{const_double}.
3160 @item lval
3161 @samp{CONST_DOUBLE_LOW (@var{op})}, if @var{op} is an integer
3162 @code{const_double}.
3163 @item rval
3164 @samp{CONST_DOUBLE_REAL_VALUE (@var{op})}, if @var{op} is a floating-point
3165 @code{const_double}.
3166 @end table
3167
3168 The @var{*val} variables should only be used once another piece of the
3169 expression has verified that @var{op} is the appropriate kind of RTL
3170 object.
3171 @end deffn
3172
3173 Most non-register constraints should be defined with
3174 @code{define_constraint}.  The remaining two definition expressions
3175 are only appropriate for constraints that should be handled specially
3176 by @code{reload} if they fail to match.
3177
3178 @deffn {MD Expression} define_memory_constraint name docstring exp
3179 Use this expression for constraints that match a subset of all memory
3180 operands: that is, @code{reload} can make them match by converting the
3181 operand to the form @samp{@w{(mem (reg @var{X}))}}, where @var{X} is a
3182 base register (from the register class specified by
3183 @code{BASE_REG_CLASS}, @pxref{Register Classes}).
3184
3185 For example, on the S/390, some instructions do not accept arbitrary
3186 memory references, but only those that do not make use of an index
3187 register.  The constraint letter @samp{Q} is defined to represent a
3188 memory address of this type.  If @samp{Q} is defined with
3189 @code{define_memory_constraint}, a @samp{Q} constraint can handle any
3190 memory operand, because @code{reload} knows it can simply copy the
3191 memory address into a base register if required.  This is analogous to
3192 the way a @samp{o} constraint can handle any memory operand.
3193
3194 The syntax and semantics are otherwise identical to
3195 @code{define_constraint}.
3196 @end deffn
3197
3198 @deffn {MD Expression} define_address_constraint name docstring exp
3199 Use this expression for constraints that match a subset of all address
3200 operands: that is, @code{reload} can make the constraint match by
3201 converting the operand to the form @samp{@w{(reg @var{X})}}, again
3202 with @var{X} a base register.
3203
3204 Constraints defined with @code{define_address_constraint} can only be
3205 used with the @code{address_operand} predicate, or machine-specific
3206 predicates that work the same way.  They are treated analogously to
3207 the generic @samp{p} constraint.
3208
3209 The syntax and semantics are otherwise identical to
3210 @code{define_constraint}.
3211 @end deffn
3212
3213 For historical reasons, names beginning with the letters @samp{G H}
3214 are reserved for constraints that match only @code{const_double}s, and
3215 names beginning with the letters @samp{I J K L M N O P} are reserved
3216 for constraints that match only @code{const_int}s.  This may change in
3217 the future.  For the time being, constraints with these names must be
3218 written in a stylized form, so that @code{genpreds} can tell you did
3219 it correctly:
3220
3221 @smallexample
3222 @group
3223 (define_constraint "[@var{GHIJKLMNOP}]@dots{}"
3224   "@var{doc}@dots{}"
3225   (and (match_code "const_int")  ; @r{@code{const_double} for G/H}
3226        @var{condition}@dots{}))            ; @r{usually a @code{match_test}}
3227 @end group
3228 @end smallexample
3229 @c the semicolons line up in the formatted manual
3230
3231 It is fine to use names beginning with other letters for constraints
3232 that match @code{const_double}s or @code{const_int}s.
3233
3234 Each docstring in a constraint definition should be one or more complete
3235 sentences, marked up in Texinfo format.  @emph{They are currently unused.}
3236 In the future they will be copied into the GCC manual, in @ref{Machine
3237 Constraints}, replacing the hand-maintained tables currently found in
3238 that section.  Also, in the future the compiler may use this to give
3239 more helpful diagnostics when poor choice of @code{asm} constraints
3240 causes a reload failure.
3241
3242 If you put the pseudo-Texinfo directive @samp{@@internal} at the
3243 beginning of a docstring, then (in the future) it will appear only in
3244 the internals manual's version of the machine-specific constraint tables.
3245 Use this for constraints that should not appear in @code{asm} statements.
3246
3247 @node C Constraint Interface
3248 @subsection Testing constraints from C
3249 @cindex testing constraints
3250 @cindex constraints, testing
3251
3252 It is occasionally useful to test a constraint from C code rather than
3253 implicitly via the constraint string in a @code{match_operand}.  The
3254 generated file @file{tm_p.h} declares a few interfaces for working
3255 with machine-specific constraints.  None of these interfaces work with
3256 the generic constraints described in @ref{Simple Constraints}.  This
3257 may change in the future.
3258
3259 @strong{Warning:} @file{tm_p.h} may declare other functions that
3260 operate on constraints, besides the ones documented here.  Do not use
3261 those functions from machine-dependent code.  They exist to implement
3262 the old constraint interface that machine-independent components of
3263 the compiler still expect.  They will change or disappear in the
3264 future.
3265
3266 Some valid constraint names are not valid C identifiers, so there is a
3267 mangling scheme for referring to them from C@.  Constraint names that
3268 do not contain angle brackets or underscores are left unchanged.
3269 Underscores are doubled, each @samp{<} is replaced with @samp{_l}, and
3270 each @samp{>} with @samp{_g}.  Here are some examples:
3271
3272 @c the @c's prevent double blank lines in the printed manual.
3273 @example
3274 @multitable {Original} {Mangled}
3275 @item @strong{Original} @tab @strong{Mangled}  @c
3276 @item @code{x}     @tab @code{x}       @c
3277 @item @code{P42x}  @tab @code{P42x}    @c
3278 @item @code{P4_x}  @tab @code{P4__x}   @c
3279 @item @code{P4>x}  @tab @code{P4_gx}   @c
3280 @item @code{P4>>}  @tab @code{P4_g_g}  @c
3281 @item @code{P4_g>} @tab @code{P4__g_g} @c
3282 @end multitable
3283 @end example
3284
3285 Throughout this section, the variable @var{c} is either a constraint
3286 in the abstract sense, or a constant from @code{enum constraint_num};
3287 the variable @var{m} is a mangled constraint name (usually as part of
3288 a larger identifier).
3289
3290 @deftp Enum constraint_num
3291 For each machine-specific constraint, there is a corresponding
3292 enumeration constant: @samp{CONSTRAINT_} plus the mangled name of the
3293 constraint.  Functions that take an @code{enum constraint_num} as an
3294 argument expect one of these constants.
3295
3296 Machine-independent constraints do not have associated constants.
3297 This may change in the future.
3298 @end deftp
3299
3300 @deftypefun {inline bool} satisfies_constraint_@var{m} (rtx @var{exp})
3301 For each machine-specific, non-register constraint @var{m}, there is
3302 one of these functions; it returns @code{true} if @var{exp} satisfies the
3303 constraint.  These functions are only visible if @file{rtl.h} was included
3304 before @file{tm_p.h}.
3305 @end deftypefun
3306
3307 @deftypefun bool constraint_satisfied_p (rtx @var{exp}, enum constraint_num @var{c})
3308 Like the @code{satisfies_constraint_@var{m}} functions, but the
3309 constraint to test is given as an argument, @var{c}.  If @var{c}
3310 specifies a register constraint, this function will always return
3311 @code{false}.
3312 @end deftypefun
3313
3314 @deftypefun {enum reg_class} regclass_for_constraint (enum constraint_num @var{c})
3315 Returns the register class associated with @var{c}.  If @var{c} is not
3316 a register constraint, or those registers are not available for the
3317 currently selected subtarget, returns @code{NO_REGS}.
3318 @end deftypefun
3319
3320 Here is an example use of @code{satisfies_constraint_@var{m}}.  In
3321 peephole optimizations (@pxref{Peephole Definitions}), operand
3322 constraint strings are ignored, so if there are relevant constraints,
3323 they must be tested in the C condition.  In the example, the
3324 optimization is applied if operand 2 does @emph{not} satisfy the
3325 @samp{K} constraint.  (This is a simplified version of a peephole
3326 definition from the i386 machine description.)
3327
3328 @smallexample
3329 (define_peephole2
3330   [(match_scratch:SI 3 "r")
3331    (set (match_operand:SI 0 "register_operand" "")
3332         (mult:SI (match_operand:SI 1 "memory_operand" "")
3333                  (match_operand:SI 2 "immediate_operand" "")))]
3334
3335   "!satisfies_constraint_K (operands[2])"
3336
3337   [(set (match_dup 3) (match_dup 1))
3338    (set (match_dup 0) (mult:SI (match_dup 3) (match_dup 2)))]
3339
3340   "")
3341 @end smallexample
3342
3343 @node Standard Names
3344 @section Standard Pattern Names For Generation
3345 @cindex standard pattern names
3346 @cindex pattern names
3347 @cindex names, pattern
3348
3349 Here is a table of the instruction names that are meaningful in the RTL
3350 generation pass of the compiler.  Giving one of these names to an
3351 instruction pattern tells the RTL generation pass that it can use the
3352 pattern to accomplish a certain task.
3353
3354 @table @asis
3355 @cindex @code{mov@var{m}} instruction pattern
3356 @item @samp{mov@var{m}}
3357 Here @var{m} stands for a two-letter machine mode name, in lowercase.
3358 This instruction pattern moves data with that machine mode from operand
3359 1 to operand 0.  For example, @samp{movsi} moves full-word data.
3360
3361 If operand 0 is a @code{subreg} with mode @var{m} of a register whose
3362 own mode is wider than @var{m}, the effect of this instruction is
3363 to store the specified value in the part of the register that corresponds
3364 to mode @var{m}.  Bits outside of @var{m}, but which are within the
3365 same target word as the @code{subreg} are undefined.  Bits which are
3366 outside the target word are left unchanged.
3367
3368 This class of patterns is special in several ways.  First of all, each
3369 of these names up to and including full word size @emph{must} be defined,
3370 because there is no other way to copy a datum from one place to another.
3371 If there are patterns accepting operands in larger modes,
3372 @samp{mov@var{m}} must be defined for integer modes of those sizes.
3373
3374 Second, these patterns are not used solely in the RTL generation pass.
3375 Even the reload pass can generate move insns to copy values from stack
3376 slots into temporary registers.  When it does so, one of the operands is
3377 a hard register and the other is an operand that can need to be reloaded
3378 into a register.
3379
3380 @findex force_reg
3381 Therefore, when given such a pair of operands, the pattern must generate
3382 RTL which needs no reloading and needs no temporary registers---no
3383 registers other than the operands.  For example, if you support the
3384 pattern with a @code{define_expand}, then in such a case the
3385 @code{define_expand} mustn't call @code{force_reg} or any other such
3386 function which might generate new pseudo registers.
3387
3388 This requirement exists even for subword modes on a RISC machine where
3389 fetching those modes from memory normally requires several insns and
3390 some temporary registers.
3391
3392 @findex change_address
3393 During reload a memory reference with an invalid address may be passed
3394 as an operand.  Such an address will be replaced with a valid address
3395 later in the reload pass.  In this case, nothing may be done with the
3396 address except to use it as it stands.  If it is copied, it will not be
3397 replaced with a valid address.  No attempt should be made to make such
3398 an address into a valid address and no routine (such as
3399 @code{change_address}) that will do so may be called.  Note that
3400 @code{general_operand} will fail when applied to such an address.
3401
3402 @findex reload_in_progress
3403 The global variable @code{reload_in_progress} (which must be explicitly
3404 declared if required) can be used to determine whether such special
3405 handling is required.
3406
3407 The variety of operands that have reloads depends on the rest of the
3408 machine description, but typically on a RISC machine these can only be
3409 pseudo registers that did not get hard registers, while on other
3410 machines explicit memory references will get optional reloads.
3411
3412 If a scratch register is required to move an object to or from memory,
3413 it can be allocated using @code{gen_reg_rtx} prior to life analysis.
3414
3415 If there are cases which need scratch registers during or after reload,
3416 you must provide an appropriate secondary_reload target hook.
3417
3418 @findex can_create_pseudo_p
3419 The macro @code{can_create_pseudo_p} can be used to determine if it
3420 is unsafe to create new pseudo registers.  If this variable is nonzero, then
3421 it is unsafe to call @code{gen_reg_rtx} to allocate a new pseudo.
3422
3423 The constraints on a @samp{mov@var{m}} must permit moving any hard
3424 register to any other hard register provided that
3425 @code{HARD_REGNO_MODE_OK} permits mode @var{m} in both registers and
3426 @code{REGISTER_MOVE_COST} applied to their classes returns a value of 2.
3427
3428 It is obligatory to support floating point @samp{mov@var{m}}
3429 instructions into and out of any registers that can hold fixed point
3430 values, because unions and structures (which have modes @code{SImode} or
3431 @code{DImode}) can be in those registers and they may have floating
3432 point members.
3433
3434 There may also be a need to support fixed point @samp{mov@var{m}}
3435 instructions in and out of floating point registers.  Unfortunately, I
3436 have forgotten why this was so, and I don't know whether it is still
3437 true.  If @code{HARD_REGNO_MODE_OK} rejects fixed point values in
3438 floating point registers, then the constraints of the fixed point
3439 @samp{mov@var{m}} instructions must be designed to avoid ever trying to
3440 reload into a floating point register.
3441
3442 @cindex @code{reload_in} instruction pattern
3443 @cindex @code{reload_out} instruction pattern
3444 @item @samp{reload_in@var{m}}
3445 @itemx @samp{reload_out@var{m}}
3446 These named patterns have been obsoleted by the target hook
3447 @code{secondary_reload}.
3448
3449 Like @samp{mov@var{m}}, but used when a scratch register is required to
3450 move between operand 0 and operand 1.  Operand 2 describes the scratch
3451 register.  See the discussion of the @code{SECONDARY_RELOAD_CLASS}
3452 macro in @pxref{Register Classes}.
3453
3454 There are special restrictions on the form of the @code{match_operand}s
3455 used in these patterns.  First, only the predicate for the reload
3456 operand is examined, i.e., @code{reload_in} examines operand 1, but not
3457 the predicates for operand 0 or 2.  Second, there may be only one
3458 alternative in the constraints.  Third, only a single register class
3459 letter may be used for the constraint; subsequent constraint letters
3460 are ignored.  As a special exception, an empty constraint string
3461 matches the @code{ALL_REGS} register class.  This may relieve ports
3462 of the burden of defining an @code{ALL_REGS} constraint letter just
3463 for these patterns.
3464
3465 @cindex @code{movstrict@var{m}} instruction pattern
3466 @item @samp{movstrict@var{m}}
3467 Like @samp{mov@var{m}} except that if operand 0 is a @code{subreg}
3468 with mode @var{m} of a register whose natural mode is wider,
3469 the @samp{movstrict@var{m}} instruction is guaranteed not to alter
3470 any of the register except the part which belongs to mode @var{m}.
3471
3472 @cindex @code{movmisalign@var{m}} instruction pattern
3473 @item @samp{movmisalign@var{m}}
3474 This variant of a move pattern is designed to load or store a value
3475 from a memory address that is not naturally aligned for its mode.
3476 For a store, the memory will be in operand 0; for a load, the memory
3477 will be in operand 1.  The other operand is guaranteed not to be a
3478 memory, so that it's easy to tell whether this is a load or store.
3479
3480 This pattern is used by the autovectorizer, and when expanding a
3481 @code{MISALIGNED_INDIRECT_REF} expression.
3482
3483 @cindex @code{load_multiple} instruction pattern
3484 @item @samp{load_multiple}
3485 Load several consecutive memory locations into consecutive registers.
3486 Operand 0 is the first of the consecutive registers, operand 1
3487 is the first memory location, and operand 2 is a constant: the
3488 number of consecutive registers.
3489
3490 Define this only if the target machine really has such an instruction;
3491 do not define this if the most efficient way of loading consecutive
3492 registers from memory is to do them one at a time.
3493
3494 On some machines, there are restrictions as to which consecutive
3495 registers can be stored into memory, such as particular starting or
3496 ending register numbers or only a range of valid counts.  For those
3497 machines, use a @code{define_expand} (@pxref{Expander Definitions})
3498 and make the pattern fail if the restrictions are not met.
3499
3500 Write the generated insn as a @code{parallel} with elements being a
3501 @code{set} of one register from the appropriate memory location (you may
3502 also need @code{use} or @code{clobber} elements).  Use a
3503 @code{match_parallel} (@pxref{RTL Template}) to recognize the insn.  See
3504 @file{rs6000.md} for examples of the use of this insn pattern.
3505
3506 @cindex @samp{store_multiple} instruction pattern
3507 @item @samp{store_multiple}
3508 Similar to @samp{load_multiple}, but store several consecutive registers
3509 into consecutive memory locations.  Operand 0 is the first of the
3510 consecutive memory locations, operand 1 is the first register, and
3511 operand 2 is a constant: the number of consecutive registers.
3512
3513 @cindex @code{vec_set@var{m}} instruction pattern
3514 @item @samp{vec_set@var{m}}
3515 Set given field in the vector value.  Operand 0 is the vector to modify,
3516 operand 1 is new value of field and operand 2 specify the field index.
3517
3518 @cindex @code{vec_extract@var{m}} instruction pattern
3519 @item @samp{vec_extract@var{m}}
3520 Extract given field from the vector value.  Operand 1 is the vector, operand 2
3521 specify field index and operand 0 place to store value into.
3522
3523 @cindex @code{vec_extract_even@var{m}} instruction pattern
3524 @item @samp{vec_extract_even@var{m}}
3525 Extract even elements from the input vectors (operand 1 and operand 2). 
3526 The even elements of operand 2 are concatenated to the even elements of operand
3527 1 in their original order. The result is stored in operand 0. 
3528 The output and input vectors should have the same modes. 
3529
3530 @cindex @code{vec_extract_odd@var{m}} instruction pattern
3531 @item @samp{vec_extract_odd@var{m}}
3532 Extract odd elements from the input vectors (operand 1 and operand 2). 
3533 The odd elements of operand 2 are concatenated to the odd elements of operand 
3534 1 in their original order. The result is stored in operand 0.
3535 The output and input vectors should have the same modes.
3536
3537 @cindex @code{vec_interleave_high@var{m}} instruction pattern
3538 @item @samp{vec_interleave_high@var{m}}
3539 Merge high elements of the two input vectors into the output vector. The output
3540 and input vectors should have the same modes (@code{N} elements). The high
3541 @code{N/2} elements of the first input vector are interleaved with the high
3542 @code{N/2} elements of the second input vector.
3543
3544 @cindex @code{vec_interleave_low@var{m}} instruction pattern
3545 @item @samp{vec_interleave_low@var{m}}
3546 Merge low elements of the two input vectors into the output vector. The output
3547 and input vectors should have the same modes (@code{N} elements). The low
3548 @code{N/2} elements of the first input vector are interleaved with the low 
3549 @code{N/2} elements of the second input vector.
3550
3551 @cindex @code{vec_init@var{m}} instruction pattern
3552 @item @samp{vec_init@var{m}}
3553 Initialize the vector to given values.  Operand 0 is the vector to initialize
3554 and operand 1 is parallel containing values for individual fields.
3555
3556 @cindex @code{push@var{m}1} instruction pattern
3557 @item @samp{push@var{m}1}
3558 Output a push instruction.  Operand 0 is value to push.  Used only when
3559 @code{PUSH_ROUNDING} is defined.  For historical reason, this pattern may be
3560 missing and in such case an @code{mov} expander is used instead, with a
3561 @code{MEM} expression forming the push operation.  The @code{mov} expander
3562 method is deprecated.
3563
3564 @cindex @code{add@var{m}3} instruction pattern
3565 @item @samp{add@var{m}3}
3566 Add operand 2 and operand 1, storing the result in operand 0.  All operands
3567 must have mode @var{m}.  This can be used even on two-address machines, by
3568 means of constraints requiring operands 1 and 0 to be the same location.
3569
3570 @cindex @code{ssadd@var{m}3} instruction pattern
3571 @cindex @code{usadd@var{m}3} instruction pattern
3572 @cindex @code{sub@var{m}3} instruction pattern
3573 @cindex @code{sssub@var{m}3} instruction pattern
3574 @cindex @code{ussub@var{m}3} instruction pattern
3575 @cindex @code{mul@var{m}3} instruction pattern
3576 @cindex @code{ssmul@var{m}3} instruction pattern
3577 @cindex @code{usmul@var{m}3} instruction pattern
3578 @cindex @code{div@var{m}3} instruction pattern
3579 @cindex @code{ssdiv@var{m}3} instruction pattern
3580 @cindex @code{udiv@var{m}3} instruction pattern
3581 @cindex @code{usdiv@var{m}3} instruction pattern
3582 @cindex @code{mod@var{m}3} instruction pattern
3583 @cindex @code{umod@var{m}3} instruction pattern
3584 @cindex @code{umin@var{m}3} instruction pattern
3585 @cindex @code{umax@var{m}3} instruction pattern
3586 @cindex @code{and@var{m}3} instruction pattern
3587 @cindex @code{ior@var{m}3} instruction pattern
3588 @cindex @code{xor@var{m}3} instruction pattern
3589 @item @samp{ssadd@var{m}3}, @samp{usadd@var{m}3}
3590 @item @samp{sub@var{m}3}, @samp{sssub@var{m}3}, @samp{ussub@var{m}3}
3591 @item @samp{mul@var{m}3}, @samp{ssmul@var{m}3}, @samp{usmul@var{m}3}
3592 @itemx @samp{div@var{m}3}, @samp{ssdiv@var{m}3}
3593 @itemx @samp{udiv@var{m}3}, @samp{usdiv@var{m}3}
3594 @itemx @samp{mod@var{m}3}, @samp{umod@var{m}3}
3595 @itemx @samp{umin@var{m}3}, @samp{umax@var{m}3}
3596 @itemx @samp{and@var{m}3}, @samp{ior@var{m}3}, @samp{xor@var{m}3}
3597 Similar, for other arithmetic operations.
3598
3599 @cindex @code{min@var{m}3} instruction pattern
3600 @cindex @code{max@var{m}3} instruction pattern
3601 @item @samp{smin@var{m}3}, @samp{smax@var{m}3}
3602 Signed minimum and maximum operations.  When used with floating point,
3603 if both operands are zeros, or if either operand is @code{NaN}, then
3604 it is unspecified which of the two operands is returned as the result.
3605
3606 @cindex @code{reduc_smin_@var{m}} instruction pattern
3607 @cindex @code{reduc_smax_@var{m}} instruction pattern
3608 @item @samp{reduc_smin_@var{m}}, @samp{reduc_smax_@var{m}}
3609 Find the signed minimum/maximum of the elements of a vector. The vector is
3610 operand 1, and the scalar result is stored in the least significant bits of
3611 operand 0 (also a vector). The output and input vector should have the same
3612 modes.
3613
3614 @cindex @code{reduc_umin_@var{m}} instruction pattern
3615 @cindex @code{reduc_umax_@var{m}} instruction pattern
3616 @item @samp{reduc_umin_@var{m}}, @samp{reduc_umax_@var{m}}
3617 Find the unsigned minimum/maximum of the elements of a vector. The vector is
3618 operand 1, and the scalar result is stored in the least significant bits of
3619 operand 0 (also a vector). The output and input vector should have the same
3620 modes.
3621
3622 @cindex @code{reduc_splus_@var{m}} instruction pattern
3623 @item @samp{reduc_splus_@var{m}}
3624 Compute the sum of the signed elements of a vector. The vector is operand 1,
3625 and the scalar result is stored in the least significant bits of operand 0
3626 (also a vector). The output and input vector should have the same modes.
3627
3628 @cindex @code{reduc_uplus_@var{m}} instruction pattern
3629 @item @samp{reduc_uplus_@var{m}}
3630 Compute the sum of the unsigned elements of a vector. The vector is operand 1,
3631 and the scalar result is stored in the least significant bits of operand 0
3632 (also a vector). The output and input vector should have the same modes.
3633
3634 @cindex @code{sdot_prod@var{m}} instruction pattern
3635 @item @samp{sdot_prod@var{m}}
3636 @cindex @code{udot_prod@var{m}} instruction pattern
3637 @item @samp{udot_prod@var{m}}
3638 Compute the sum of the products of two signed/unsigned elements. 
3639 Operand 1 and operand 2 are of the same mode. Their product, which is of a 
3640 wider mode, is computed and added to operand 3. Operand 3 is of a mode equal or 
3641 wider than the mode of the product. The result is placed in operand 0, which
3642 is of the same mode as operand 3. 
3643
3644 @cindex @code{ssum_widen@var{m3}} instruction pattern
3645 @item @samp{ssum_widen@var{m3}}
3646 @cindex @code{usum_widen@var{m3}} instruction pattern
3647 @item @samp{usum_widen@var{m3}}
3648 Operands 0 and 2 are of the same mode, which is wider than the mode of 
3649 operand 1. Add operand 1 to operand 2 and place the widened result in
3650 operand 0. (This is used express accumulation of elements into an accumulator
3651 of a wider mode.)
3652
3653 @cindex @code{vec_shl_@var{m}} instruction pattern
3654 @cindex @code{vec_shr_@var{m}} instruction pattern
3655 @item @samp{vec_shl_@var{m}}, @samp{vec_shr_@var{m}}
3656 Whole vector left/right shift in bits.
3657 Operand 1 is a vector to be shifted.
3658 Operand 2 is an integer shift amount in bits.
3659 Operand 0 is where the resulting shifted vector is stored.
3660 The output and input vectors should have the same modes.
3661
3662 @cindex @code{vec_pack_trunc_@var{m}} instruction pattern
3663 @item @samp{vec_pack_trunc_@var{m}}
3664 Narrow (demote) and merge the elements of two vectors. Operands 1 and 2
3665 are vectors of the same mode having N integral or floating point elements
3666 of size S.  Operand 0 is the resulting vector in which 2*N elements of
3667 size N/2 are concatenated after narrowing them down using truncation.
3668
3669 @cindex @code{vec_pack_ssat_@var{m}} instruction pattern
3670 @cindex @code{vec_pack_usat_@var{m}} instruction pattern
3671 @item @samp{vec_pack_ssat_@var{m}}, @samp{vec_pack_usat_@var{m}}
3672 Narrow (demote) and merge the elements of two vectors.  Operands 1 and 2
3673 are vectors of the same mode having N integral elements of size S.
3674 Operand 0 is the resulting vector in which the elements of the two input
3675 vectors are concatenated after narrowing them down using signed/unsigned
3676 saturating arithmetic.
3677
3678 @cindex @code{vec_pack_sfix_trunc_@var{m}} instruction pattern
3679 @cindex @code{vec_pack_ufix_trunc_@var{m}} instruction pattern
3680 @item @samp{vec_pack_sfix_trunc_@var{m}}, @samp{vec_pack_ufix_trunc_@var{m}}
3681 Narrow, convert to signed/unsigned integral type and merge the elements
3682 of two vectors.  Operands 1 and 2 are vectors of the same mode having N
3683 floating point elements of size S.  Operand 0 is the resulting vector
3684 in which 2*N elements of size N/2 are concatenated.
3685
3686 @cindex @code{vec_unpacks_hi_@var{m}} instruction pattern
3687 @cindex @code{vec_unpacks_lo_@var{m}} instruction pattern
3688 @item @samp{vec_unpacks_hi_@var{m}}, @samp{vec_unpacks_lo_@var{m}}
3689 Extract and widen (promote) the high/low part of a vector of signed
3690 integral or floating point elements.  The input vector (operand 1) has N
3691 elements of size S.  Widen (promote) the high/low elements of the vector
3692 using signed or floating point extension and place the resulting N/2
3693 values of size 2*S in the output vector (operand 0).
3694
3695 @cindex @code{vec_unpacku_hi_@var{m}} instruction pattern
3696 @cindex @code{vec_unpacku_lo_@var{m}} instruction pattern
3697 @item @samp{vec_unpacku_hi_@var{m}}, @samp{vec_unpacku_lo_@var{m}}
3698 Extract and widen (promote) the high/low part of a vector of unsigned
3699 integral elements.  The input vector (operand 1) has N elements of size S.
3700 Widen (promote) the high/low elements of the vector using zero extension and
3701 place the resulting N/2 values of size 2*S in the output vector (operand 0).
3702
3703 @cindex @code{vec_unpacks_float_hi_@var{m}} instruction pattern
3704 @cindex @code{vec_unpacks_float_lo_@var{m}} instruction pattern
3705 @cindex @code{vec_unpacku_float_hi_@var{m}} instruction pattern
3706 @cindex @code{vec_unpacku_float_lo_@var{m}} instruction pattern
3707 @item @samp{vec_unpacks_float_hi_@var{m}}, @samp{vec_unpacks_float_lo_@var{m}}
3708 @itemx @samp{vec_unpacku_float_hi_@var{m}}, @samp{vec_unpacku_float_lo_@var{m}}
3709 Extract, convert to floating point type and widen the high/low part of a
3710 vector of signed/unsigned integral elements.  The input vector (operand 1)
3711 has N elements of size S.  Convert the high/low elements of the vector using
3712 floating point conversion and place the resulting N/2 values of size 2*S in
3713 the output vector (operand 0).
3714
3715 @cindex @code{vec_widen_umult_hi_@var{m}} instruction pattern
3716 @cindex @code{vec_widen_umult_lo__@var{m}} instruction pattern
3717 @cindex @code{vec_widen_smult_hi_@var{m}} instruction pattern
3718 @cindex @code{vec_widen_smult_lo_@var{m}} instruction pattern
3719 @item @samp{vec_widen_umult_hi_@var{m}}, @samp{vec_widen_umult_lo_@var{m}}
3720 @itemx @samp{vec_widen_smult_hi_@var{m}}, @samp{vec_widen_smult_lo_@var{m}}
3721 Signed/Unsigned widening multiplication.  The two inputs (operands 1 and 2)
3722 are vectors with N signed/unsigned elements of size S.  Multiply the high/low
3723 elements of the two vectors, and put the N/2 products of size 2*S in the
3724 output vector (operand 0).
3725
3726 @cindex @code{mulhisi3} instruction pattern
3727 @item @samp{mulhisi3}
3728 Multiply operands 1 and 2, which have mode @code{HImode}, and store
3729 a @code{SImode} product in operand 0.
3730
3731 @cindex @code{mulqihi3} instruction pattern
3732 @cindex @code{mulsidi3} instruction pattern
3733 @item @samp{mulqihi3}, @samp{mulsidi3}
3734 Similar widening-multiplication instructions of other widths.
3735
3736 @cindex @code{umulqihi3} instruction pattern
3737 @cindex @code{umulhisi3} instruction pattern
3738 @cindex @code{umulsidi3} instruction pattern
3739 @item @samp{umulqihi3}, @samp{umulhisi3}, @samp{umulsidi3}
3740 Similar widening-multiplication instructions that do unsigned
3741 multiplication.
3742
3743 @cindex @code{usmulqihi3} instruction pattern
3744 @cindex @code{usmulhisi3} instruction pattern
3745 @cindex @code{usmulsidi3} instruction pattern
3746 @item @samp{usmulqihi3}, @samp{usmulhisi3}, @samp{usmulsidi3}
3747 Similar widening-multiplication instructions that interpret the first
3748 operand as unsigned and the second operand as signed, then do a signed
3749 multiplication.
3750
3751 @cindex @code{smul@var{m}3_highpart} instruction pattern
3752 @item @samp{smul@var{m}3_highpart}
3753 Perform a signed multiplication of operands 1 and 2, which have mode
3754 @var{m}, and store the most significant half of the product in operand 0.
3755 The least significant half of the product is discarded.
3756
3757 @cindex @code{umul@var{m}3_highpart} instruction pattern
3758 @item @samp{umul@var{m}3_highpart}
3759 Similar, but the multiplication is unsigned.
3760
3761 @cindex @code{madd@var{m}@var{n}4} instruction pattern
3762 @item @samp{madd@var{m}@var{n}4}
3763 Multiply operands 1 and 2, sign-extend them to mode @var{n}, add
3764 operand 3, and store the result in operand 0.  Operands 1 and 2
3765 have mode @var{m} and operands 0 and 3 have mode @var{n}.
3766 Both modes must be integer or fixed-point modes and @var{n} must be twice
3767 the size of @var{m}.
3768
3769 In other words, @code{madd@var{m}@var{n}4} is like
3770 @code{mul@var{m}@var{n}3} except that it also adds operand 3.
3771
3772 These instructions are not allowed to @code{FAIL}.
3773
3774 @cindex @code{umadd@var{m}@var{n}4} instruction pattern
3775 @item @samp{umadd@var{m}@var{n}4}
3776 Like @code{madd@var{m}@var{n}4}, but zero-extend the multiplication
3777 operands instead of sign-extending them.
3778
3779 @cindex @code{ssmadd@var{m}@var{n}4} instruction pattern
3780 @item @samp{ssmadd@var{m}@var{n}4}
3781 Like @code{madd@var{m}@var{n}4}, but all involved operations must be
3782 signed-saturating.
3783
3784 @cindex @code{usmadd@var{m}@var{n}4} instruction pattern
3785 @item @samp{usmadd@var{m}@var{n}4}
3786 Like @code