OSDN Git Service

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