OSDN Git Service

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