Import stripped gcc-4.0.1 sources.
[dragonfly.git] / contrib / gcc-4.0 / gcc / doc / md.texi
blob02fb6ff08ce5a8cba5ab850cf9d96bc289054131
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1996, 1998, 1999, 2000, 2001,
2 @c 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
6 @ifset INTERNALS
7 @node Machine Desc
8 @chapter Machine Descriptions
9 @cindex machine descriptions
11 A machine description has two parts: a file of instruction patterns
12 (@file{.md} file) and a C header file of macro definitions.
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.
20 See the next chapter for information on the C header file.
22 @menu
23 * Overview::            How the machine description is used.
24 * Patterns::            How to write instruction patterns.
25 * Example::             An explained example of a @code{define_insn} pattern.
26 * RTL Template::        The RTL template defines what insns match a pattern.
27 * Output Template::     The output template says how to make assembler code
28                           from such an insn.
29 * Output Statement::    For more generality, write C code to output
30                           the assembler code.
31 * Predicates::          Controlling what kinds of operands can be used
32                           for an insn.
33 * Constraints::         Fine-tuning operand selection.
34 * Standard Names::      Names mark patterns to use for code generation.
35 * Pattern Ordering::    When the order of patterns makes a difference.
36 * Dependent Patterns::  Having one pattern may make you need another.
37 * Jump Patterns::       Special considerations for patterns for jump insns.
38 * Looping Patterns::    How to define patterns for special looping insns.
39 * Insn Canonicalizations::Canonicalization of Instructions
40 * Expander Definitions::Generating a sequence of several RTL insns
41                           for a standard operation.
42 * Insn Splitting::      Splitting Instructions into Multiple Instructions.
43 * Including Patterns::      Including Patterns in Machine Descriptions.
44 * Peephole Definitions::Defining machine-specific peephole optimizations.
45 * Insn Attributes::     Specifying the value of attributes for generated insns.
46 * Conditional Execution::Generating @code{define_insn} patterns for
47                            predication.
48 * Constant Definitions::Defining symbolic constants that can be used in the
49                         md file.
50 * Macros::              Using macros to generate patterns from a template.
51 @end menu
53 @node Overview
54 @section Overview of How the Machine Description is Used
56 There are three main conversions that happen in the compiler:
58 @enumerate
60 @item
61 The front end reads the source code and builds a parse tree.
63 @item
64 The parse tree is used to generate an RTL insn list based on named
65 instruction patterns.
67 @item
68 The insn list is matched against the RTL templates to produce assembler
69 code.
71 @end enumerate
73 For the generate pass, only the names of the insns matter, from either a
74 named @code{define_insn} or a @code{define_expand}.  The compiler will
75 choose the pattern with the right name and apply the operands according
76 to the documentation later in this chapter, without regard for the RTL
77 template or operand constraints.  Note that the names the compiler looks
78 for are hard-coded in the compiler---it will ignore unnamed patterns and
79 patterns with names it doesn't know about, but if you don't provide a
80 named pattern it needs, it will abort.
82 If a @code{define_insn} is used, the template given is inserted into the
83 insn list.  If a @code{define_expand} is used, one of three things
84 happens, based on the condition logic.  The condition logic may manually
85 create new insns for the insn list, say via @code{emit_insn()}, and
86 invoke @code{DONE}.  For certain named patterns, it may invoke @code{FAIL} to tell the
87 compiler to use an alternate way of performing that task.  If it invokes
88 neither @code{DONE} nor @code{FAIL}, the template given in the pattern
89 is inserted, as if the @code{define_expand} were a @code{define_insn}.
91 Once the insn list is generated, various optimization passes convert,
92 replace, and rearrange the insns in the insn list.  This is where the
93 @code{define_split} and @code{define_peephole} patterns get used, for
94 example.
96 Finally, the insn list's RTL is matched up with the RTL templates in the
97 @code{define_insn} patterns, and those patterns are used to emit the
98 final assembly code.  For this purpose, each named @code{define_insn}
99 acts like it's unnamed, since the names are ignored.
101 @node Patterns
102 @section Everything about Instruction Patterns
103 @cindex patterns
104 @cindex instruction patterns
106 @findex define_insn
107 Each instruction pattern contains an incomplete RTL expression, with pieces
108 to be filled in later, operand constraints that restrict how the pieces can
109 be filled in, and an output pattern or C code to generate the assembler
110 output, all wrapped up in a @code{define_insn} expression.
112 A @code{define_insn} is an RTL expression containing four or five operands:
114 @enumerate
115 @item
116 An optional name.  The presence of a name indicate that this instruction
117 pattern can perform a certain standard job for the RTL-generation
118 pass of the compiler.  This pass knows certain names and will use
119 the instruction patterns with those names, if the names are defined
120 in the machine description.
122 The absence of a name is indicated by writing an empty string
123 where the name should go.  Nameless instruction patterns are never
124 used for generating RTL code, but they may permit several simpler insns
125 to be combined later on.
127 Names that are not thus known and used in RTL-generation have no
128 effect; they are equivalent to no name at all.
130 For the purpose of debugging the compiler, you may also specify a
131 name beginning with the @samp{*} character.  Such a name is used only
132 for identifying the instruction in RTL dumps; it is entirely equivalent
133 to having a nameless pattern for all other purposes.
135 @item
136 The @dfn{RTL template} (@pxref{RTL Template}) is a vector of incomplete
137 RTL expressions which show what the instruction should look like.  It is
138 incomplete because it may contain @code{match_operand},
139 @code{match_operator}, and @code{match_dup} expressions that stand for
140 operands of the instruction.
142 If the vector has only one element, that element is the template for the
143 instruction pattern.  If the vector has multiple elements, then the
144 instruction pattern is a @code{parallel} expression containing the
145 elements described.
147 @item
148 @cindex pattern conditions
149 @cindex conditions, in patterns
150 A condition.  This is a string which contains a C expression that is
151 the final test to decide whether an insn body matches this pattern.
153 @cindex named patterns and conditions
154 For a named pattern, the condition (if present) may not depend on
155 the data in the insn being matched, but only the target-machine-type
156 flags.  The compiler needs to test these conditions during
157 initialization in order to learn exactly which named instructions are
158 available in a particular run.
160 @findex operands
161 For nameless patterns, the condition is applied only when matching an
162 individual insn, and only after the insn has matched the pattern's
163 recognition template.  The insn's operands may be found in the vector
164 @code{operands}.  For an insn where the condition has once matched, it
165 can't be used to control register allocation, for example by excluding
166 certain hard registers or hard register combinations.
168 @item
169 The @dfn{output template}: a string that says how to output matching
170 insns as assembler code.  @samp{%} in this string specifies where
171 to substitute the value of an operand.  @xref{Output Template}.
173 When simple substitution isn't general enough, you can specify a piece
174 of C code to compute the output.  @xref{Output Statement}.
176 @item
177 Optionally, a vector containing the values of attributes for insns matching
178 this pattern.  @xref{Insn Attributes}.
179 @end enumerate
181 @node Example
182 @section Example of @code{define_insn}
183 @cindex @code{define_insn} example
185 Here is an actual example of an instruction pattern, for the 68000/68020.
187 @smallexample
188 (define_insn "tstsi"
189   [(set (cc0)
190         (match_operand:SI 0 "general_operand" "rm"))]
191   ""
192   "*
194   if (TARGET_68020 || ! ADDRESS_REG_P (operands[0]))
195     return \"tstl %0\";
196   return \"cmpl #0,%0\";
197 @}")
198 @end smallexample
200 @noindent
201 This can also be written using braced strings:
203 @smallexample
204 (define_insn "tstsi"
205   [(set (cc0)
206         (match_operand:SI 0 "general_operand" "rm"))]
207   ""
209   if (TARGET_68020 || ! ADDRESS_REG_P (operands[0]))
210     return "tstl %0";
211   return "cmpl #0,%0";
213 @end smallexample
215 This is an instruction that sets the condition codes based on the value of
216 a general operand.  It has no condition, so any insn whose RTL description
217 has the form shown may be handled according to this pattern.  The name
218 @samp{tstsi} means ``test a @code{SImode} value'' and tells the RTL generation
219 pass that, when it is necessary to test such a value, an insn to do so
220 can be constructed using this pattern.
222 The output control string is a piece of C code which chooses which
223 output template to return based on the kind of operand and the specific
224 type of CPU for which code is being generated.
226 @samp{"rm"} is an operand constraint.  Its meaning is explained below.
228 @node RTL Template
229 @section RTL Template
230 @cindex RTL insn template
231 @cindex generating insns
232 @cindex insns, generating
233 @cindex recognizing insns
234 @cindex insns, recognizing
236 The RTL template is used to define which insns match the particular pattern
237 and how to find their operands.  For named patterns, the RTL template also
238 says how to construct an insn from specified operands.
240 Construction involves substituting specified operands into a copy of the
241 template.  Matching involves determining the values that serve as the
242 operands in the insn being matched.  Both of these activities are
243 controlled by special expression types that direct matching and
244 substitution of the operands.
246 @table @code
247 @findex match_operand
248 @item (match_operand:@var{m} @var{n} @var{predicate} @var{constraint})
249 This expression is a placeholder for operand number @var{n} of
250 the insn.  When constructing an insn, operand number @var{n}
251 will be substituted at this point.  When matching an insn, whatever
252 appears at this position in the insn will be taken as operand
253 number @var{n}; but it must satisfy @var{predicate} or this instruction
254 pattern will not match at all.
256 Operand numbers must be chosen consecutively counting from zero in
257 each instruction pattern.  There may be only one @code{match_operand}
258 expression in the pattern for each operand number.  Usually operands
259 are numbered in the order of appearance in @code{match_operand}
260 expressions.  In the case of a @code{define_expand}, any operand numbers
261 used only in @code{match_dup} expressions have higher values than all
262 other operand numbers.
264 @var{predicate} is a string that is the name of a function that
265 accepts two arguments, an expression and a machine mode.
266 @xref{Predicates}.  During matching, the function will be called with
267 the putative operand as the expression and @var{m} as the mode
268 argument (if @var{m} is not specified, @code{VOIDmode} will be used,
269 which normally causes @var{predicate} to accept any mode).  If it
270 returns zero, this instruction pattern fails to match.
271 @var{predicate} may be an empty string; then it means no test is to be
272 done on the operand, so anything which occurs in this position is
273 valid.
275 Most of the time, @var{predicate} will reject modes other than @var{m}---but
276 not always.  For example, the predicate @code{address_operand} uses
277 @var{m} as the mode of memory ref that the address should be valid for.
278 Many predicates accept @code{const_int} nodes even though their mode is
279 @code{VOIDmode}.
281 @var{constraint} controls reloading and the choice of the best register
282 class to use for a value, as explained later (@pxref{Constraints}).
283 If the constraint would be an empty string, it can be omitted.
285 People are often unclear on the difference between the constraint and the
286 predicate.  The predicate helps decide whether a given insn matches the
287 pattern.  The constraint plays no role in this decision; instead, it
288 controls various decisions in the case of an insn which does match.
290 @findex match_scratch
291 @item (match_scratch:@var{m} @var{n} @var{constraint})
292 This expression is also a placeholder for operand number @var{n}
293 and indicates that operand must be a @code{scratch} or @code{reg}
294 expression.
296 When matching patterns, this is equivalent to
298 @smallexample
299 (match_operand:@var{m} @var{n} "scratch_operand" @var{pred})
300 @end smallexample
302 but, when generating RTL, it produces a (@code{scratch}:@var{m})
303 expression.
305 If the last few expressions in a @code{parallel} are @code{clobber}
306 expressions whose operands are either a hard register or
307 @code{match_scratch}, the combiner can add or delete them when
308 necessary.  @xref{Side Effects}.
310 @findex match_dup
311 @item (match_dup @var{n})
312 This expression is also a placeholder for operand number @var{n}.
313 It is used when the operand needs to appear more than once in the
314 insn.
316 In construction, @code{match_dup} acts just like @code{match_operand}:
317 the operand is substituted into the insn being constructed.  But in
318 matching, @code{match_dup} behaves differently.  It assumes that operand
319 number @var{n} has already been determined by a @code{match_operand}
320 appearing earlier in the recognition template, and it matches only an
321 identical-looking expression.
323 Note that @code{match_dup} should not be used to tell the compiler that
324 a particular register is being used for two operands (example:
325 @code{add} that adds one register to another; the second register is
326 both an input operand and the output operand).  Use a matching
327 constraint (@pxref{Simple Constraints}) for those.  @code{match_dup} is for the cases where one
328 operand is used in two places in the template, such as an instruction
329 that computes both a quotient and a remainder, where the opcode takes
330 two input operands but the RTL template has to refer to each of those
331 twice; once for the quotient pattern and once for the remainder pattern.
333 @findex match_operator
334 @item (match_operator:@var{m} @var{n} @var{predicate} [@var{operands}@dots{}])
335 This pattern is a kind of placeholder for a variable RTL expression
336 code.
338 When constructing an insn, it stands for an RTL expression whose
339 expression code is taken from that of operand @var{n}, and whose
340 operands are constructed from the patterns @var{operands}.
342 When matching an expression, it matches an expression if the function
343 @var{predicate} returns nonzero on that expression @emph{and} the
344 patterns @var{operands} match the operands of the expression.
346 Suppose that the function @code{commutative_operator} is defined as
347 follows, to match any expression whose operator is one of the
348 commutative arithmetic operators of RTL and whose mode is @var{mode}:
350 @smallexample
352 commutative_integer_operator (x, mode)
353      rtx x;
354      enum machine_mode mode;
356   enum rtx_code code = GET_CODE (x);
357   if (GET_MODE (x) != mode)
358     return 0;
359   return (GET_RTX_CLASS (code) == RTX_COMM_ARITH
360           || code == EQ || code == NE);
362 @end smallexample
364 Then the following pattern will match any RTL expression consisting
365 of a commutative operator applied to two general operands:
367 @smallexample
368 (match_operator:SI 3 "commutative_operator"
369   [(match_operand:SI 1 "general_operand" "g")
370    (match_operand:SI 2 "general_operand" "g")])
371 @end smallexample
373 Here the vector @code{[@var{operands}@dots{}]} contains two patterns
374 because the expressions to be matched all contain two operands.
376 When this pattern does match, the two operands of the commutative
377 operator are recorded as operands 1 and 2 of the insn.  (This is done
378 by the two instances of @code{match_operand}.)  Operand 3 of the insn
379 will be the entire commutative expression: use @code{GET_CODE
380 (operands[3])} to see which commutative operator was used.
382 The machine mode @var{m} of @code{match_operator} works like that of
383 @code{match_operand}: it is passed as the second argument to the
384 predicate function, and that function is solely responsible for
385 deciding whether the expression to be matched ``has'' that mode.
387 When constructing an insn, argument 3 of the gen-function will specify
388 the operation (i.e.@: the expression code) for the expression to be
389 made.  It should be an RTL expression, whose expression code is copied
390 into a new expression whose operands are arguments 1 and 2 of the
391 gen-function.  The subexpressions of argument 3 are not used;
392 only its expression code matters.
394 When @code{match_operator} is used in a pattern for matching an insn,
395 it usually best if the operand number of the @code{match_operator}
396 is higher than that of the actual operands of the insn.  This improves
397 register allocation because the register allocator often looks at
398 operands 1 and 2 of insns to see if it can do register tying.
400 There is no way to specify constraints in @code{match_operator}.  The
401 operand of the insn which corresponds to the @code{match_operator}
402 never has any constraints because it is never reloaded as a whole.
403 However, if parts of its @var{operands} are matched by
404 @code{match_operand} patterns, those parts may have constraints of
405 their own.
407 @findex match_op_dup
408 @item (match_op_dup:@var{m} @var{n}[@var{operands}@dots{}])
409 Like @code{match_dup}, except that it applies to operators instead of
410 operands.  When constructing an insn, operand number @var{n} will be
411 substituted at this point.  But in matching, @code{match_op_dup} behaves
412 differently.  It assumes that operand number @var{n} has already been
413 determined by a @code{match_operator} appearing earlier in the
414 recognition template, and it matches only an identical-looking
415 expression.
417 @findex match_parallel
418 @item (match_parallel @var{n} @var{predicate} [@var{subpat}@dots{}])
419 This pattern is a placeholder for an insn that consists of a
420 @code{parallel} expression with a variable number of elements.  This
421 expression should only appear at the top level of an insn pattern.
423 When constructing an insn, operand number @var{n} will be substituted at
424 this point.  When matching an insn, it matches if the body of the insn
425 is a @code{parallel} expression with at least as many elements as the
426 vector of @var{subpat} expressions in the @code{match_parallel}, if each
427 @var{subpat} matches the corresponding element of the @code{parallel},
428 @emph{and} the function @var{predicate} returns nonzero on the
429 @code{parallel} that is the body of the insn.  It is the responsibility
430 of the predicate to validate elements of the @code{parallel} beyond
431 those listed in the @code{match_parallel}.
433 A typical use of @code{match_parallel} is to match load and store
434 multiple expressions, which can contain a variable number of elements
435 in a @code{parallel}.  For example,
437 @smallexample
438 (define_insn ""
439   [(match_parallel 0 "load_multiple_operation"
440      [(set (match_operand:SI 1 "gpc_reg_operand" "=r")
441            (match_operand:SI 2 "memory_operand" "m"))
442       (use (reg:SI 179))
443       (clobber (reg:SI 179))])]
444   ""
445   "loadm 0,0,%1,%2")
446 @end smallexample
448 This example comes from @file{a29k.md}.  The function
449 @code{load_multiple_operation} is defined in @file{a29k.c} and checks
450 that subsequent elements in the @code{parallel} are the same as the
451 @code{set} in the pattern, except that they are referencing subsequent
452 registers and memory locations.
454 An insn that matches this pattern might look like:
456 @smallexample
457 (parallel
458  [(set (reg:SI 20) (mem:SI (reg:SI 100)))
459   (use (reg:SI 179))
460   (clobber (reg:SI 179))
461   (set (reg:SI 21)
462        (mem:SI (plus:SI (reg:SI 100)
463                         (const_int 4))))
464   (set (reg:SI 22)
465        (mem:SI (plus:SI (reg:SI 100)
466                         (const_int 8))))])
467 @end smallexample
469 @findex match_par_dup
470 @item (match_par_dup @var{n} [@var{subpat}@dots{}])
471 Like @code{match_op_dup}, but for @code{match_parallel} instead of
472 @code{match_operator}.
474 @end table
476 @node Output Template
477 @section Output Templates and Operand Substitution
478 @cindex output templates
479 @cindex operand substitution
481 @cindex @samp{%} in template
482 @cindex percent sign
483 The @dfn{output template} is a string which specifies how to output the
484 assembler code for an instruction pattern.  Most of the template is a
485 fixed string which is output literally.  The character @samp{%} is used
486 to specify where to substitute an operand; it can also be used to
487 identify places where different variants of the assembler require
488 different syntax.
490 In the simplest case, a @samp{%} followed by a digit @var{n} says to output
491 operand @var{n} at that point in the string.
493 @samp{%} followed by a letter and a digit says to output an operand in an
494 alternate fashion.  Four letters have standard, built-in meanings described
495 below.  The machine description macro @code{PRINT_OPERAND} can define
496 additional letters with nonstandard meanings.
498 @samp{%c@var{digit}} can be used to substitute an operand that is a
499 constant value without the syntax that normally indicates an immediate
500 operand.
502 @samp{%n@var{digit}} is like @samp{%c@var{digit}} except that the value of
503 the constant is negated before printing.
505 @samp{%a@var{digit}} can be used to substitute an operand as if it were a
506 memory reference, with the actual operand treated as the address.  This may
507 be useful when outputting a ``load address'' instruction, because often the
508 assembler syntax for such an instruction requires you to write the operand
509 as if it were a memory reference.
511 @samp{%l@var{digit}} is used to substitute a @code{label_ref} into a jump
512 instruction.
514 @samp{%=} outputs a number which is unique to each instruction in the
515 entire compilation.  This is useful for making local labels to be
516 referred to more than once in a single template that generates multiple
517 assembler instructions.
519 @samp{%} followed by a punctuation character specifies a substitution that
520 does not use an operand.  Only one case is standard: @samp{%%} outputs a
521 @samp{%} into the assembler code.  Other nonstandard cases can be
522 defined in the @code{PRINT_OPERAND} macro.  You must also define
523 which punctuation characters are valid with the
524 @code{PRINT_OPERAND_PUNCT_VALID_P} macro.
526 @cindex \
527 @cindex backslash
528 The template may generate multiple assembler instructions.  Write the text
529 for the instructions, with @samp{\;} between them.
531 @cindex matching operands
532 When the RTL contains two operands which are required by constraint to match
533 each other, the output template must refer only to the lower-numbered operand.
534 Matching operands are not always identical, and the rest of the compiler
535 arranges to put the proper RTL expression for printing into the lower-numbered
536 operand.
538 One use of nonstandard letters or punctuation following @samp{%} is to
539 distinguish between different assembler languages for the same machine; for
540 example, Motorola syntax versus MIT syntax for the 68000.  Motorola syntax
541 requires periods in most opcode names, while MIT syntax does not.  For
542 example, the opcode @samp{movel} in MIT syntax is @samp{move.l} in Motorola
543 syntax.  The same file of patterns is used for both kinds of output syntax,
544 but the character sequence @samp{%.} is used in each place where Motorola
545 syntax wants a period.  The @code{PRINT_OPERAND} macro for Motorola syntax
546 defines the sequence to output a period; the macro for MIT syntax defines
547 it to do nothing.
549 @cindex @code{#} in template
550 As a special case, a template consisting of the single character @code{#}
551 instructs the compiler to first split the insn, and then output the
552 resulting instructions separately.  This helps eliminate redundancy in the
553 output templates.   If you have a @code{define_insn} that needs to emit
554 multiple assembler instructions, and there is an matching @code{define_split}
555 already defined, then you can simply use @code{#} as the output template
556 instead of writing an output template that emits the multiple assembler
557 instructions.
559 If the macro @code{ASSEMBLER_DIALECT} is defined, you can use construct
560 of the form @samp{@{option0|option1|option2@}} in the templates.  These
561 describe multiple variants of assembler language syntax.
562 @xref{Instruction Output}.
564 @node Output Statement
565 @section C Statements for Assembler Output
566 @cindex output statements
567 @cindex C statements for assembler output
568 @cindex generating assembler output
570 Often a single fixed template string cannot produce correct and efficient
571 assembler code for all the cases that are recognized by a single
572 instruction pattern.  For example, the opcodes may depend on the kinds of
573 operands; or some unfortunate combinations of operands may require extra
574 machine instructions.
576 If the output control string starts with a @samp{@@}, then it is actually
577 a series of templates, each on a separate line.  (Blank lines and
578 leading spaces and tabs are ignored.)  The templates correspond to the
579 pattern's constraint alternatives (@pxref{Multi-Alternative}).  For example,
580 if a target machine has a two-address add instruction @samp{addr} to add
581 into a register and another @samp{addm} to add a register to memory, you
582 might write this pattern:
584 @smallexample
585 (define_insn "addsi3"
586   [(set (match_operand:SI 0 "general_operand" "=r,m")
587         (plus:SI (match_operand:SI 1 "general_operand" "0,0")
588                  (match_operand:SI 2 "general_operand" "g,r")))]
589   ""
590   "@@
591    addr %2,%0
592    addm %2,%0")
593 @end smallexample
595 @cindex @code{*} in template
596 @cindex asterisk in template
597 If the output control string starts with a @samp{*}, then it is not an
598 output template but rather a piece of C program that should compute a
599 template.  It should execute a @code{return} statement to return the
600 template-string you want.  Most such templates use C string literals, which
601 require doublequote characters to delimit them.  To include these
602 doublequote characters in the string, prefix each one with @samp{\}.
604 If the output control string is written as a brace block instead of a
605 double-quoted string, it is automatically assumed to be C code.  In that
606 case, it is not necessary to put in a leading asterisk, or to escape the
607 doublequotes surrounding C string literals.
609 The operands may be found in the array @code{operands}, whose C data type
610 is @code{rtx []}.
612 It is very common to select different ways of generating assembler code
613 based on whether an immediate operand is within a certain range.  Be
614 careful when doing this, because the result of @code{INTVAL} is an
615 integer on the host machine.  If the host machine has more bits in an
616 @code{int} than the target machine has in the mode in which the constant
617 will be used, then some of the bits you get from @code{INTVAL} will be
618 superfluous.  For proper results, you must carefully disregard the
619 values of those bits.
621 @findex output_asm_insn
622 It is possible to output an assembler instruction and then go on to output
623 or compute more of them, using the subroutine @code{output_asm_insn}.  This
624 receives two arguments: a template-string and a vector of operands.  The
625 vector may be @code{operands}, or it may be another array of @code{rtx}
626 that you declare locally and initialize yourself.
628 @findex which_alternative
629 When an insn pattern has multiple alternatives in its constraints, often
630 the appearance of the assembler code is determined mostly by which alternative
631 was matched.  When this is so, the C code can test the variable
632 @code{which_alternative}, which is the ordinal number of the alternative
633 that was actually satisfied (0 for the first, 1 for the second alternative,
634 etc.).
636 For example, suppose there are two opcodes for storing zero, @samp{clrreg}
637 for registers and @samp{clrmem} for memory locations.  Here is how
638 a pattern could use @code{which_alternative} to choose between them:
640 @smallexample
641 (define_insn ""
642   [(set (match_operand:SI 0 "general_operand" "=r,m")
643         (const_int 0))]
644   ""
645   @{
646   return (which_alternative == 0
647           ? "clrreg %0" : "clrmem %0");
648   @})
649 @end smallexample
651 The example above, where the assembler code to generate was
652 @emph{solely} determined by the alternative, could also have been specified
653 as follows, having the output control string start with a @samp{@@}:
655 @smallexample
656 @group
657 (define_insn ""
658   [(set (match_operand:SI 0 "general_operand" "=r,m")
659         (const_int 0))]
660   ""
661   "@@
662    clrreg %0
663    clrmem %0")
664 @end group
665 @end smallexample
667 @node Predicates
668 @section Predicates
669 @cindex predicates
670 @cindex operand predicates
671 @cindex operator predicates
673 A predicate determines whether a @code{match_operand} or
674 @code{match_operator} expression matches, and therefore whether the
675 surrounding instruction pattern will be used for that combination of
676 operands.  GCC has a number of machine-independent predicates, and you
677 can define machine-specific predicates as needed.  By convention,
678 predicates used with @code{match_operand} have names that end in
679 @samp{_operand}, and those used with @code{match_operator} have names
680 that end in @samp{_operator}.
682 All predicates are Boolean functions (in the mathematical sense) of
683 two arguments: the RTL expression that is being considered at that
684 position in the instruction pattern, and the machine mode that the
685 @code{match_operand} or @code{match_operator} specifies.  In this
686 section, the first argument is called @var{op} and the second argument
687 @var{mode}.  Predicates can be called from C as ordinary two-argument
688 functions; this can be useful in output templates or other
689 machine-specific code.
691 Operand predicates can allow operands that are not actually acceptable
692 to the hardware, as long as the constraints give reload the ability to
693 fix them up (@pxref{Constraints}).  However, GCC will usually generate
694 better code if the predicates specify the requirements of the machine
695 instructions as closely as possible.  Reload cannot fix up operands
696 that must be constants (``immediate operands''); you must use a
697 predicate that allows only constants, or else enforce the requirement
698 in the extra condition.
700 @cindex predicates and machine modes
701 @cindex normal predicates
702 @cindex special predicates
703 Most predicates handle their @var{mode} argument in a uniform manner.
704 If @var{mode} is @code{VOIDmode} (unspecified), then @var{op} can have
705 any mode.  If @var{mode} is anything else, then @var{op} must have the
706 same mode, unless @var{op} is a @code{CONST_INT} or integer
707 @code{CONST_DOUBLE}.  These RTL expressions always have
708 @code{VOIDmode}, so it would be counterproductive to check that their
709 mode matches.  Instead, predicates that accept @code{CONST_INT} and/or
710 integer @code{CONST_DOUBLE} check that the value stored in the
711 constant will fit in the requested mode.
713 Predicates with this behavior are called @dfn{normal}.
714 @command{genrecog} can optimize the instruction recognizer based on
715 knowledge of how normal predicates treat modes.  It can also diagnose
716 certain kinds of common errors in the use of normal predicates; for
717 instance, it is almost always an error to use a normal predicate
718 without specifying a mode.
720 Predicates that do something different with their @var{mode} argument
721 are called @dfn{special}.  The generic predicates
722 @code{address_operand} and @code{pmode_register_operand} are special
723 predicates.  @command{genrecog} does not do any optimizations or
724 diagnosis when special predicates are used.
726 @menu
727 * Machine-Independent Predicates::  Predicates available to all back ends.
728 * Defining Predicates::             How to write machine-specific predicate
729                                     functions.
730 @end menu
732 @node Machine-Independent Predicates
733 @subsection Machine-Independent Predicates
734 @cindex machine-independent predicates
735 @cindex generic predicates
737 These are the generic predicates available to all back ends.  They are
738 defined in @file{recog.c}.  The first category of predicates allow
739 only constant, or @dfn{immediate}, operands.
741 @defun immediate_operand
742 This predicate allows any sort of constant that fits in @var{mode}.
743 It is an appropriate choice for instructions that take operands that
744 must be constant.
745 @end defun
747 @defun const_int_operand
748 This predicate allows any @code{CONST_INT} expression that fits in
749 @var{mode}.  It is an appropriate choice for an immediate operand that
750 does not allow a symbol or label.
751 @end defun
753 @defun const_double_operand
754 This predicate accepts any @code{CONST_DOUBLE} expression that has
755 exactly @var{mode}.  If @var{mode} is @code{VOIDmode}, it will also
756 accept @code{CONST_INT}.  It is intended for immediate floating point
757 constants.
758 @end defun
760 @noindent
761 The second category of predicates allow only some kind of machine
762 register.
764 @defun register_operand
765 This predicate allows any @code{REG} or @code{SUBREG} expression that
766 is valid for @var{mode}.  It is often suitable for arithmetic
767 instruction operands on a RISC machine.
768 @end defun
770 @defun pmode_register_operand
771 This is a slight variant on @code{register_operand} which works around
772 a limitation in the machine-description reader.
774 @smallexample
775 (match_operand @var{n} "pmode_register_operand" @var{constraint})
776 @end smallexample
778 @noindent
779 means exactly what
781 @smallexample
782 (match_operand:P @var{n} "register_operand" @var{constraint})
783 @end smallexample
785 @noindent
786 would mean, if the machine-description reader accepted @samp{:P}
787 mode suffixes.  Unfortunately, it cannot, because @code{Pmode} is an
788 alias for some other mode, and might vary with machine-specific
789 options.  @xref{Misc}.
790 @end defun
792 @defun scratch_operand
793 This predicate allows hard registers and @code{SCRATCH} expressions,
794 but not pseudo-registers.  It is used internally by @code{match_scratch};
795 it should not be used directly.
796 @end defun
798 @noindent
799 The third category of predicates allow only some kind of memory reference.
801 @defun memory_operand
802 This predicate allows any valid reference to a quantity of mode
803 @var{mode} in memory, as determined by the weak form of
804 @code{GO_IF_LEGITIMATE_ADDRESS} (@pxref{Addressing Modes}).
805 @end defun
807 @defun address_operand
808 This predicate is a little unusual; it allows any operand that is a
809 valid expression for the @emph{address} of a quantity of mode
810 @var{mode}, again determined by the weak form of
811 @code{GO_IF_LEGITIMATE_ADDRESS}.  To first order, if
812 @samp{@w{(mem:@var{mode} (@var{exp}))}} is acceptable to
813 @code{memory_operand}, then @var{exp} is acceptable to
814 @code{address_operand}.  Note that @var{exp} does not necessarily have
815 the mode @var{mode}.
816 @end defun
818 @defun indirect_operand
819 This is a stricter form of @code{memory_operand} which allows only
820 memory references with a @code{general_operand} as the address
821 expression.  New uses of this predicate are discouraged, because
822 @code{general_operand} is very permissive, so it's hard to tell what
823 an @code{indirect_operand} does or does not allow.  If a target has
824 different requirements for memory operands for different instructions,
825 it is better to define target-specific predicates which enforce the
826 hardware's requirements explicitly.
827 @end defun
829 @defun push_operand
830 This predicate allows a memory reference suitable for pushing a value
831 onto the stack.  This will be a @code{MEM} which refers to
832 @code{stack_pointer_rtx}, with a side-effect in its address expression
833 (@pxref{Incdec}); which one is determined by the
834 @code{STACK_PUSH_CODE} macro (@pxref{Frame Layout}).
835 @end defun
837 @defun pop_operand
838 This predicate allows a memory reference suitable for popping a value
839 off the stack.  Again, this will be a @code{MEM} referring to
840 @code{stack_pointer_rtx}, with a side-effect in its address
841 expression.  However, this time @code{STACK_POP_CODE} is expected.
842 @end defun
844 @noindent
845 The fourth category of predicates allow some combination of the above
846 operands.
848 @defun nonmemory_operand
849 This predicate allows any immediate or register operand valid for @var{mode}.
850 @end defun
852 @defun nonimmediate_operand
853 This predicate allows any register or memory operand valid for @var{mode}.
854 @end defun
856 @defun general_operand
857 This predicate allows any immediate, register, or memory operand
858 valid for @var{mode}.
859 @end defun
861 @noindent
862 Finally, there is one generic operator predicate.
864 @defun comparison_operator
865 This predicate matches any expression which performs an arithmetic
866 comparison in @var{mode}; that is, @code{COMPARISON_P} is true for the
867 expression code.
868 @end defun
870 @node Defining Predicates
871 @subsection Defining Machine-Specific Predicates
872 @cindex defining predicates
873 @findex define_predicate
874 @findex define_special_predicate
876 Many machines have requirements for their operands that cannot be
877 expressed precisely using the generic predicates.  You can define
878 additional predicates using @code{define_predicate} and
879 @code{define_special_predicate} expressions.  These expressions have
880 three operands:
882 @itemize @bullet
883 @item
884 The name of the predicate, as it will be referred to in
885 @code{match_operand} or @code{match_operator} expressions.
887 @item
888 An RTL expression which evaluates to true if the predicate allows the
889 operand @var{op}, false if it does not.  This expression can only use
890 the following RTL codes:
892 @table @code
893 @item MATCH_OPERAND
894 When written inside a predicate expression, a @code{MATCH_OPERAND}
895 expression evaluates to true if the predicate it names would allow
896 @var{op}.  The operand number and constraint are ignored.  Due to
897 limitations in @command{genrecog}, you can only refer to generic
898 predicates and predicates that have already been defined.
900 @item MATCH_CODE
901 This expression has one operand, a string constant containing a
902 comma-separated list of RTX code names (in lower case).  It evaluates
903 to true if @var{op} has any of the listed codes.
905 @item MATCH_TEST
906 This expression has one operand, a string constant containing a C
907 expression.  The predicate's arguments, @var{op} and @var{mode}, are
908 available with those names in the C expression.  The @code{MATCH_TEST}
909 evaluates to true if the C expression evaluates to a nonzero value.
910 @code{MATCH_TEST} expressions must not have side effects.
912 @item  AND
913 @itemx IOR
914 @itemx NOT
915 @itemx IF_THEN_ELSE
916 The basic @samp{MATCH_} expressions can be combined using these
917 logical operators, which have the semantics of the C operators
918 @samp{&&}, @samp{||}, @samp{!}, and @samp{@w{? :}} respectively.
919 @end table
921 @item
922 An optional block of C code, which should execute
923 @samp{@w{return true}} if the predicate is found to match and
924 @samp{@w{return false}} if it does not.  It must not have any side
925 effects.  The predicate arguments, @var{op} and @var{mode}, are
926 available with those names.
928 If a code block is present in a predicate definition, then the RTL
929 expression must evaluate to true @emph{and} the code block must
930 execute @samp{@w{return true}} for the predicate to allow the operand.
931 The RTL expression is evaluated first; do not re-check anything in the
932 code block that was checked in the RTL expression.
933 @end itemize
935 The program @command{genrecog} scans @code{define_predicate} and
936 @code{define_special_predicate} expressions to determine which RTX
937 codes are possibly allowed.  You should always make this explicit in
938 the RTL predicate expression, using @code{MATCH_OPERAND} and
939 @code{MATCH_CODE}.
941 Here is an example of a simple predicate definition, from the IA64
942 machine description:
944 @smallexample
945 @group
946 ;; @r{True if @var{op} is a @code{SYMBOL_REF} which refers to the sdata section.}
947 (define_predicate "small_addr_symbolic_operand"
948   (and (match_code "symbol_ref")
949        (match_test "SYMBOL_REF_SMALL_ADDR_P (op)")))
950 @end group
951 @end smallexample
953 @noindent
954 And here is another, showing the use of the C block.
956 @smallexample
957 @group
958 ;; @r{True if @var{op} is a register operand that is (or could be) a GR reg.}
959 (define_predicate "gr_register_operand"
960   (match_operand 0 "register_operand")
962   unsigned int regno;
963   if (GET_CODE (op) == SUBREG)
964     op = SUBREG_REG (op);
966   regno = REGNO (op);
967   return (regno >= FIRST_PSEUDO_REGISTER || GENERAL_REGNO_P (regno));
969 @end group
970 @end smallexample
972 Predicates written with @code{define_predicate} automatically include
973 a test that @var{mode} is @code{VOIDmode}, or @var{op} has the same
974 mode as @var{mode}, or @var{op} is a @code{CONST_INT} or
975 @code{CONST_DOUBLE}.  They do @emph{not} check specifically for
976 integer @code{CONST_DOUBLE}, nor do they test that the value of either
977 kind of constant fits in the requested mode.  This is because
978 target-specific predicates that take constants usually have to do more
979 stringent value checks anyway.  If you need the exact same treatment
980 of @code{CONST_INT} or @code{CONST_DOUBLE} that the generic predicates
981 provide, use a @code{MATCH_OPERAND} subexpression to call
982 @code{const_int_operand}, @code{const_double_operand}, or
983 @code{immediate_operand}.
985 Predicates written with @code{define_special_predicate} do not get any
986 automatic mode checks, and are treated as having special mode handling
987 by @command{genrecog}.
989 The program @command{genpreds} is responsible for generating code to
990 test predicates.  It also writes a header file containing function
991 declarations for all machine-specific predicates.  It is not necessary
992 to declare these predicates in @file{@var{cpu}-protos.h}.
993 @end ifset
995 @c Most of this node appears by itself (in a different place) even
996 @c when the INTERNALS flag is clear.  Passages that require the internals
997 @c manual's context are conditionalized to appear only in the internals manual.
998 @ifset INTERNALS
999 @node Constraints
1000 @section Operand Constraints
1001 @cindex operand constraints
1002 @cindex constraints
1004 Each @code{match_operand} in an instruction pattern can specify
1005 constraints for the operands allowed.  The constraints allow you to
1006 fine-tune matching within the set of operands allowed by the
1007 predicate.
1009 @end ifset
1010 @ifclear INTERNALS
1011 @node Constraints
1012 @section Constraints for @code{asm} Operands
1013 @cindex operand constraints, @code{asm}
1014 @cindex constraints, @code{asm}
1015 @cindex @code{asm} constraints
1017 Here are specific details on what constraint letters you can use with
1018 @code{asm} operands.
1019 @end ifclear
1020 Constraints can say whether
1021 an operand may be in a register, and which kinds of register; whether the
1022 operand can be a memory reference, and which kinds of address; whether the
1023 operand may be an immediate constant, and which possible values it may
1024 have.  Constraints can also require two operands to match.
1026 @ifset INTERNALS
1027 @menu
1028 * Simple Constraints::  Basic use of constraints.
1029 * Multi-Alternative::   When an insn has two alternative constraint-patterns.
1030 * Class Preferences::   Constraints guide which hard register to put things in.
1031 * Modifiers::           More precise control over effects of constraints.
1032 * Machine Constraints:: Existing constraints for some particular machines.
1033 @end menu
1034 @end ifset
1036 @ifclear INTERNALS
1037 @menu
1038 * Simple Constraints::  Basic use of constraints.
1039 * Multi-Alternative::   When an insn has two alternative constraint-patterns.
1040 * Modifiers::           More precise control over effects of constraints.
1041 * Machine Constraints:: Special constraints for some particular machines.
1042 @end menu
1043 @end ifclear
1045 @node Simple Constraints
1046 @subsection Simple Constraints
1047 @cindex simple constraints
1049 The simplest kind of constraint is a string full of letters, each of
1050 which describes one kind of operand that is permitted.  Here are
1051 the letters that are allowed:
1053 @table @asis
1054 @item whitespace
1055 Whitespace characters are ignored and can be inserted at any position
1056 except the first.  This enables each alternative for different operands to
1057 be visually aligned in the machine description even if they have different
1058 number of constraints and modifiers.
1060 @cindex @samp{m} in constraint
1061 @cindex memory references in constraints
1062 @item @samp{m}
1063 A memory operand is allowed, with any kind of address that the machine
1064 supports in general.
1066 @cindex offsettable address
1067 @cindex @samp{o} in constraint
1068 @item @samp{o}
1069 A memory operand is allowed, but only if the address is
1070 @dfn{offsettable}.  This means that adding a small integer (actually,
1071 the width in bytes of the operand, as determined by its machine mode)
1072 may be added to the address and the result is also a valid memory
1073 address.
1075 @cindex autoincrement/decrement addressing
1076 For example, an address which is constant is offsettable; so is an
1077 address that is the sum of a register and a constant (as long as a
1078 slightly larger constant is also within the range of address-offsets
1079 supported by the machine); but an autoincrement or autodecrement
1080 address is not offsettable.  More complicated indirect/indexed
1081 addresses may or may not be offsettable depending on the other
1082 addressing modes that the machine supports.
1084 Note that in an output operand which can be matched by another
1085 operand, the constraint letter @samp{o} is valid only when accompanied
1086 by both @samp{<} (if the target machine has predecrement addressing)
1087 and @samp{>} (if the target machine has preincrement addressing).
1089 @cindex @samp{V} in constraint
1090 @item @samp{V}
1091 A memory operand that is not offsettable.  In other words, anything that
1092 would fit the @samp{m} constraint but not the @samp{o} constraint.
1094 @cindex @samp{<} in constraint
1095 @item @samp{<}
1096 A memory operand with autodecrement addressing (either predecrement or
1097 postdecrement) is allowed.
1099 @cindex @samp{>} in constraint
1100 @item @samp{>}
1101 A memory operand with autoincrement addressing (either preincrement or
1102 postincrement) is allowed.
1104 @cindex @samp{r} in constraint
1105 @cindex registers in constraints
1106 @item @samp{r}
1107 A register operand is allowed provided that it is in a general
1108 register.
1110 @cindex constants in constraints
1111 @cindex @samp{i} in constraint
1112 @item @samp{i}
1113 An immediate integer operand (one with constant value) is allowed.
1114 This includes symbolic constants whose values will be known only at
1115 assembly time or later.
1117 @cindex @samp{n} in constraint
1118 @item @samp{n}
1119 An immediate integer operand with a known numeric value is allowed.
1120 Many systems cannot support assembly-time constants for operands less
1121 than a word wide.  Constraints for these operands should use @samp{n}
1122 rather than @samp{i}.
1124 @cindex @samp{I} in constraint
1125 @item @samp{I}, @samp{J}, @samp{K}, @dots{} @samp{P}
1126 Other letters in the range @samp{I} through @samp{P} may be defined in
1127 a machine-dependent fashion to permit immediate integer operands with
1128 explicit integer values in specified ranges.  For example, on the
1129 68000, @samp{I} is defined to stand for the range of values 1 to 8.
1130 This is the range permitted as a shift count in the shift
1131 instructions.
1133 @cindex @samp{E} in constraint
1134 @item @samp{E}
1135 An immediate floating operand (expression code @code{const_double}) is
1136 allowed, but only if the target floating point format is the same as
1137 that of the host machine (on which the compiler is running).
1139 @cindex @samp{F} in constraint
1140 @item @samp{F}
1141 An immediate floating operand (expression code @code{const_double} or
1142 @code{const_vector}) is allowed.
1144 @cindex @samp{G} in constraint
1145 @cindex @samp{H} in constraint
1146 @item @samp{G}, @samp{H}
1147 @samp{G} and @samp{H} may be defined in a machine-dependent fashion to
1148 permit immediate floating operands in particular ranges of values.
1150 @cindex @samp{s} in constraint
1151 @item @samp{s}
1152 An immediate integer operand whose value is not an explicit integer is
1153 allowed.
1155 This might appear strange; if an insn allows a constant operand with a
1156 value not known at compile time, it certainly must allow any known
1157 value.  So why use @samp{s} instead of @samp{i}?  Sometimes it allows
1158 better code to be generated.
1160 For example, on the 68000 in a fullword instruction it is possible to
1161 use an immediate operand; but if the immediate value is between @minus{}128
1162 and 127, better code results from loading the value into a register and
1163 using the register.  This is because the load into the register can be
1164 done with a @samp{moveq} instruction.  We arrange for this to happen
1165 by defining the letter @samp{K} to mean ``any integer outside the
1166 range @minus{}128 to 127'', and then specifying @samp{Ks} in the operand
1167 constraints.
1169 @cindex @samp{g} in constraint
1170 @item @samp{g}
1171 Any register, memory or immediate integer operand is allowed, except for
1172 registers that are not general registers.
1174 @cindex @samp{X} in constraint
1175 @item @samp{X}
1176 @ifset INTERNALS
1177 Any operand whatsoever is allowed, even if it does not satisfy
1178 @code{general_operand}.  This is normally used in the constraint of
1179 a @code{match_scratch} when certain alternatives will not actually
1180 require a scratch register.
1181 @end ifset
1182 @ifclear INTERNALS
1183 Any operand whatsoever is allowed.
1184 @end ifclear
1186 @cindex @samp{0} in constraint
1187 @cindex digits in constraint
1188 @item @samp{0}, @samp{1}, @samp{2}, @dots{} @samp{9}
1189 An operand that matches the specified operand number is allowed.  If a
1190 digit is used together with letters within the same alternative, the
1191 digit should come last.
1193 This number is allowed to be more than a single digit.  If multiple
1194 digits are encountered consecutively, they are interpreted as a single
1195 decimal integer.  There is scant chance for ambiguity, since to-date
1196 it has never been desirable that @samp{10} be interpreted as matching
1197 either operand 1 @emph{or} operand 0.  Should this be desired, one
1198 can use multiple alternatives instead.
1200 @cindex matching constraint
1201 @cindex constraint, matching
1202 This is called a @dfn{matching constraint} and what it really means is
1203 that the assembler has only a single operand that fills two roles
1204 @ifset INTERNALS
1205 considered separate in the RTL insn.  For example, an add insn has two
1206 input operands and one output operand in the RTL, but on most CISC
1207 @end ifset
1208 @ifclear INTERNALS
1209 which @code{asm} distinguishes.  For example, an add instruction uses
1210 two input operands and an output operand, but on most CISC
1211 @end ifclear
1212 machines an add instruction really has only two operands, one of them an
1213 input-output operand:
1215 @smallexample
1216 addl #35,r12
1217 @end smallexample
1219 Matching constraints are used in these circumstances.
1220 More precisely, the two operands that match must include one input-only
1221 operand and one output-only operand.  Moreover, the digit must be a
1222 smaller number than the number of the operand that uses it in the
1223 constraint.
1225 @ifset INTERNALS
1226 For operands to match in a particular case usually means that they
1227 are identical-looking RTL expressions.  But in a few special cases
1228 specific kinds of dissimilarity are allowed.  For example, @code{*x}
1229 as an input operand will match @code{*x++} as an output operand.
1230 For proper results in such cases, the output template should always
1231 use the output-operand's number when printing the operand.
1232 @end ifset
1234 @cindex load address instruction
1235 @cindex push address instruction
1236 @cindex address constraints
1237 @cindex @samp{p} in constraint
1238 @item @samp{p}
1239 An operand that is a valid memory address is allowed.  This is
1240 for ``load address'' and ``push address'' instructions.
1242 @findex address_operand
1243 @samp{p} in the constraint must be accompanied by @code{address_operand}
1244 as the predicate in the @code{match_operand}.  This predicate interprets
1245 the mode specified in the @code{match_operand} as the mode of the memory
1246 reference for which the address would be valid.
1248 @cindex other register constraints
1249 @cindex extensible constraints
1250 @item @var{other-letters}
1251 Other letters can be defined in machine-dependent fashion to stand for
1252 particular classes of registers or other arbitrary operand types.
1253 @samp{d}, @samp{a} and @samp{f} are defined on the 68000/68020 to stand
1254 for data, address and floating point registers.
1256 @ifset INTERNALS
1257 The machine description macro @code{REG_CLASS_FROM_LETTER} has first
1258 cut at the otherwise unused letters.  If it evaluates to @code{NO_REGS},
1259 then @code{EXTRA_CONSTRAINT} is evaluated.
1261 A typical use for @code{EXTRA_CONSTRAINT} would be to distinguish certain
1262 types of memory references that affect other insn operands.
1263 @end ifset
1264 @end table
1266 @ifset INTERNALS
1267 In order to have valid assembler code, each operand must satisfy
1268 its constraint.  But a failure to do so does not prevent the pattern
1269 from applying to an insn.  Instead, it directs the compiler to modify
1270 the code so that the constraint will be satisfied.  Usually this is
1271 done by copying an operand into a register.
1273 Contrast, therefore, the two instruction patterns that follow:
1275 @smallexample
1276 (define_insn ""
1277   [(set (match_operand:SI 0 "general_operand" "=r")
1278         (plus:SI (match_dup 0)
1279                  (match_operand:SI 1 "general_operand" "r")))]
1280   ""
1281   "@dots{}")
1282 @end smallexample
1284 @noindent
1285 which has two operands, one of which must appear in two places, and
1287 @smallexample
1288 (define_insn ""
1289   [(set (match_operand:SI 0 "general_operand" "=r")
1290         (plus:SI (match_operand:SI 1 "general_operand" "0")
1291                  (match_operand:SI 2 "general_operand" "r")))]
1292   ""
1293   "@dots{}")
1294 @end smallexample
1296 @noindent
1297 which has three operands, two of which are required by a constraint to be
1298 identical.  If we are considering an insn of the form
1300 @smallexample
1301 (insn @var{n} @var{prev} @var{next}
1302   (set (reg:SI 3)
1303        (plus:SI (reg:SI 6) (reg:SI 109)))
1304   @dots{})
1305 @end smallexample
1307 @noindent
1308 the first pattern would not apply at all, because this insn does not
1309 contain two identical subexpressions in the right place.  The pattern would
1310 say, ``That does not look like an add instruction; try other patterns''.
1311 The second pattern would say, ``Yes, that's an add instruction, but there
1312 is something wrong with it''.  It would direct the reload pass of the
1313 compiler to generate additional insns to make the constraint true.  The
1314 results might look like this:
1316 @smallexample
1317 (insn @var{n2} @var{prev} @var{n}
1318   (set (reg:SI 3) (reg:SI 6))
1319   @dots{})
1321 (insn @var{n} @var{n2} @var{next}
1322   (set (reg:SI 3)
1323        (plus:SI (reg:SI 3) (reg:SI 109)))
1324   @dots{})
1325 @end smallexample
1327 It is up to you to make sure that each operand, in each pattern, has
1328 constraints that can handle any RTL expression that could be present for
1329 that operand.  (When multiple alternatives are in use, each pattern must,
1330 for each possible combination of operand expressions, have at least one
1331 alternative which can handle that combination of operands.)  The
1332 constraints don't need to @emph{allow} any possible operand---when this is
1333 the case, they do not constrain---but they must at least point the way to
1334 reloading any possible operand so that it will fit.
1336 @itemize @bullet
1337 @item
1338 If the constraint accepts whatever operands the predicate permits,
1339 there is no problem: reloading is never necessary for this operand.
1341 For example, an operand whose constraints permit everything except
1342 registers is safe provided its predicate rejects registers.
1344 An operand whose predicate accepts only constant values is safe
1345 provided its constraints include the letter @samp{i}.  If any possible
1346 constant value is accepted, then nothing less than @samp{i} will do;
1347 if the predicate is more selective, then the constraints may also be
1348 more selective.
1350 @item
1351 Any operand expression can be reloaded by copying it into a register.
1352 So if an operand's constraints allow some kind of register, it is
1353 certain to be safe.  It need not permit all classes of registers; the
1354 compiler knows how to copy a register into another register of the
1355 proper class in order to make an instruction valid.
1357 @cindex nonoffsettable memory reference
1358 @cindex memory reference, nonoffsettable
1359 @item
1360 A nonoffsettable memory reference can be reloaded by copying the
1361 address into a register.  So if the constraint uses the letter
1362 @samp{o}, all memory references are taken care of.
1364 @item
1365 A constant operand can be reloaded by allocating space in memory to
1366 hold it as preinitialized data.  Then the memory reference can be used
1367 in place of the constant.  So if the constraint uses the letters
1368 @samp{o} or @samp{m}, constant operands are not a problem.
1370 @item
1371 If the constraint permits a constant and a pseudo register used in an insn
1372 was not allocated to a hard register and is equivalent to a constant,
1373 the register will be replaced with the constant.  If the predicate does
1374 not permit a constant and the insn is re-recognized for some reason, the
1375 compiler will crash.  Thus the predicate must always recognize any
1376 objects allowed by the constraint.
1377 @end itemize
1379 If the operand's predicate can recognize registers, but the constraint does
1380 not permit them, it can make the compiler crash.  When this operand happens
1381 to be a register, the reload pass will be stymied, because it does not know
1382 how to copy a register temporarily into memory.
1384 If the predicate accepts a unary operator, the constraint applies to the
1385 operand.  For example, the MIPS processor at ISA level 3 supports an
1386 instruction which adds two registers in @code{SImode} to produce a
1387 @code{DImode} result, but only if the registers are correctly sign
1388 extended.  This predicate for the input operands accepts a
1389 @code{sign_extend} of an @code{SImode} register.  Write the constraint
1390 to indicate the type of register that is required for the operand of the
1391 @code{sign_extend}.
1392 @end ifset
1394 @node Multi-Alternative
1395 @subsection Multiple Alternative Constraints
1396 @cindex multiple alternative constraints
1398 Sometimes a single instruction has multiple alternative sets of possible
1399 operands.  For example, on the 68000, a logical-or instruction can combine
1400 register or an immediate value into memory, or it can combine any kind of
1401 operand into a register; but it cannot combine one memory location into
1402 another.
1404 These constraints are represented as multiple alternatives.  An alternative
1405 can be described by a series of letters for each operand.  The overall
1406 constraint for an operand is made from the letters for this operand
1407 from the first alternative, a comma, the letters for this operand from
1408 the second alternative, a comma, and so on until the last alternative.
1409 @ifset INTERNALS
1410 Here is how it is done for fullword logical-or on the 68000:
1412 @smallexample
1413 (define_insn "iorsi3"
1414   [(set (match_operand:SI 0 "general_operand" "=m,d")
1415         (ior:SI (match_operand:SI 1 "general_operand" "%0,0")
1416                 (match_operand:SI 2 "general_operand" "dKs,dmKs")))]
1417   @dots{})
1418 @end smallexample
1420 The first alternative has @samp{m} (memory) for operand 0, @samp{0} for
1421 operand 1 (meaning it must match operand 0), and @samp{dKs} for operand
1422 2.  The second alternative has @samp{d} (data register) for operand 0,
1423 @samp{0} for operand 1, and @samp{dmKs} for operand 2.  The @samp{=} and
1424 @samp{%} in the constraints apply to all the alternatives; their
1425 meaning is explained in the next section (@pxref{Class Preferences}).
1426 @end ifset
1428 @c FIXME Is this ? and ! stuff of use in asm()?  If not, hide unless INTERNAL
1429 If all the operands fit any one alternative, the instruction is valid.
1430 Otherwise, for each alternative, the compiler counts how many instructions
1431 must be added to copy the operands so that that alternative applies.
1432 The alternative requiring the least copying is chosen.  If two alternatives
1433 need the same amount of copying, the one that comes first is chosen.
1434 These choices can be altered with the @samp{?} and @samp{!} characters:
1436 @table @code
1437 @cindex @samp{?} in constraint
1438 @cindex question mark
1439 @item ?
1440 Disparage slightly the alternative that the @samp{?} appears in,
1441 as a choice when no alternative applies exactly.  The compiler regards
1442 this alternative as one unit more costly for each @samp{?} that appears
1443 in it.
1445 @cindex @samp{!} in constraint
1446 @cindex exclamation point
1447 @item !
1448 Disparage severely the alternative that the @samp{!} appears in.
1449 This alternative can still be used if it fits without reloading,
1450 but if reloading is needed, some other alternative will be used.
1451 @end table
1453 @ifset INTERNALS
1454 When an insn pattern has multiple alternatives in its constraints, often
1455 the appearance of the assembler code is determined mostly by which
1456 alternative was matched.  When this is so, the C code for writing the
1457 assembler code can use the variable @code{which_alternative}, which is
1458 the ordinal number of the alternative that was actually satisfied (0 for
1459 the first, 1 for the second alternative, etc.).  @xref{Output Statement}.
1460 @end ifset
1462 @ifset INTERNALS
1463 @node Class Preferences
1464 @subsection Register Class Preferences
1465 @cindex class preference constraints
1466 @cindex register class preference constraints
1468 @cindex voting between constraint alternatives
1469 The operand constraints have another function: they enable the compiler
1470 to decide which kind of hardware register a pseudo register is best
1471 allocated to.  The compiler examines the constraints that apply to the
1472 insns that use the pseudo register, looking for the machine-dependent
1473 letters such as @samp{d} and @samp{a} that specify classes of registers.
1474 The pseudo register is put in whichever class gets the most ``votes''.
1475 The constraint letters @samp{g} and @samp{r} also vote: they vote in
1476 favor of a general register.  The machine description says which registers
1477 are considered general.
1479 Of course, on some machines all registers are equivalent, and no register
1480 classes are defined.  Then none of this complexity is relevant.
1481 @end ifset
1483 @node Modifiers
1484 @subsection Constraint Modifier Characters
1485 @cindex modifiers in constraints
1486 @cindex constraint modifier characters
1488 @c prevent bad page break with this line
1489 Here are constraint modifier characters.
1491 @table @samp
1492 @cindex @samp{=} in constraint
1493 @item =
1494 Means that this operand is write-only for this instruction: the previous
1495 value is discarded and replaced by output data.
1497 @cindex @samp{+} in constraint
1498 @item +
1499 Means that this operand is both read and written by the instruction.
1501 When the compiler fixes up the operands to satisfy the constraints,
1502 it needs to know which operands are inputs to the instruction and
1503 which are outputs from it.  @samp{=} identifies an output; @samp{+}
1504 identifies an operand that is both input and output; all other operands
1505 are assumed to be input only.
1507 If you specify @samp{=} or @samp{+} in a constraint, you put it in the
1508 first character of the constraint string.
1510 @cindex @samp{&} in constraint
1511 @cindex earlyclobber operand
1512 @item &
1513 Means (in a particular alternative) that this operand is an
1514 @dfn{earlyclobber} operand, which is modified before the instruction is
1515 finished using the input operands.  Therefore, this operand may not lie
1516 in a register that is used as an input operand or as part of any memory
1517 address.
1519 @samp{&} applies only to the alternative in which it is written.  In
1520 constraints with multiple alternatives, sometimes one alternative
1521 requires @samp{&} while others do not.  See, for example, the
1522 @samp{movdf} insn of the 68000.
1524 An input operand can be tied to an earlyclobber operand if its only
1525 use as an input occurs before the early result is written.  Adding
1526 alternatives of this form often allows GCC to produce better code
1527 when only some of the inputs can be affected by the earlyclobber.
1528 See, for example, the @samp{mulsi3} insn of the ARM@.
1530 @samp{&} does not obviate the need to write @samp{=}.
1532 @cindex @samp{%} in constraint
1533 @item %
1534 Declares the instruction to be commutative for this operand and the
1535 following operand.  This means that the compiler may interchange the
1536 two operands if that is the cheapest way to make all operands fit the
1537 constraints.
1538 @ifset INTERNALS
1539 This is often used in patterns for addition instructions
1540 that really have only two operands: the result must go in one of the
1541 arguments.  Here for example, is how the 68000 halfword-add
1542 instruction is defined:
1544 @smallexample
1545 (define_insn "addhi3"
1546   [(set (match_operand:HI 0 "general_operand" "=m,r")
1547      (plus:HI (match_operand:HI 1 "general_operand" "%0,0")
1548               (match_operand:HI 2 "general_operand" "di,g")))]
1549   @dots{})
1550 @end smallexample
1551 @end ifset
1552 GCC can only handle one commutative pair in an asm; if you use more,
1553 the compiler may fail.  Note that you need not use the modifier if
1554 the two alternatives are strictly identical; this would only waste
1555 time in the reload pass.
1557 @cindex @samp{#} in constraint
1558 @item #
1559 Says that all following characters, up to the next comma, are to be
1560 ignored as a constraint.  They are significant only for choosing
1561 register preferences.
1563 @cindex @samp{*} in constraint
1564 @item *
1565 Says that the following character should be ignored when choosing
1566 register preferences.  @samp{*} has no effect on the meaning of the
1567 constraint as a constraint, and no effect on reloading.
1569 @ifset INTERNALS
1570 Here is an example: the 68000 has an instruction to sign-extend a
1571 halfword in a data register, and can also sign-extend a value by
1572 copying it into an address register.  While either kind of register is
1573 acceptable, the constraints on an address-register destination are
1574 less strict, so it is best if register allocation makes an address
1575 register its goal.  Therefore, @samp{*} is used so that the @samp{d}
1576 constraint letter (for data register) is ignored when computing
1577 register preferences.
1579 @smallexample
1580 (define_insn "extendhisi2"
1581   [(set (match_operand:SI 0 "general_operand" "=*d,a")
1582         (sign_extend:SI
1583          (match_operand:HI 1 "general_operand" "0,g")))]
1584   @dots{})
1585 @end smallexample
1586 @end ifset
1587 @end table
1589 @node Machine Constraints
1590 @subsection Constraints for Particular Machines
1591 @cindex machine specific constraints
1592 @cindex constraints, machine specific
1594 Whenever possible, you should use the general-purpose constraint letters
1595 in @code{asm} arguments, since they will convey meaning more readily to
1596 people reading your code.  Failing that, use the constraint letters
1597 that usually have very similar meanings across architectures.  The most
1598 commonly used constraints are @samp{m} and @samp{r} (for memory and
1599 general-purpose registers respectively; @pxref{Simple Constraints}), and
1600 @samp{I}, usually the letter indicating the most common
1601 immediate-constant format.
1603 For each machine architecture, the
1604 @file{config/@var{machine}/@var{machine}.h} file defines additional
1605 constraints.  These constraints are used by the compiler itself for
1606 instruction generation, as well as for @code{asm} statements; therefore,
1607 some of the constraints are not particularly interesting for @code{asm}.
1608 The constraints are defined through these macros:
1610 @table @code
1611 @item REG_CLASS_FROM_LETTER
1612 Register class constraints (usually lowercase).
1614 @item CONST_OK_FOR_LETTER_P
1615 Immediate constant constraints, for non-floating point constants of
1616 word size or smaller precision (usually uppercase).
1618 @item CONST_DOUBLE_OK_FOR_LETTER_P
1619 Immediate constant constraints, for all floating point constants and for
1620 constants of greater than word size precision (usually uppercase).
1622 @item EXTRA_CONSTRAINT
1623 Special cases of registers or memory.  This macro is not required, and
1624 is only defined for some machines.
1625 @end table
1627 Inspecting these macro definitions in the compiler source for your
1628 machine is the best way to be certain you have the right constraints.
1629 However, here is a summary of the machine-dependent constraints
1630 available on some particular machines.
1632 @table @emph
1633 @item ARM family---@file{arm.h}
1634 @table @code
1635 @item f
1636 Floating-point register
1638 @item w
1639 VFP floating-point register
1641 @item F
1642 One of the floating-point constants 0.0, 0.5, 1.0, 2.0, 3.0, 4.0, 5.0
1643 or 10.0
1645 @item G
1646 Floating-point constant that would satisfy the constraint @samp{F} if it
1647 were negated
1649 @item I
1650 Integer that is valid as an immediate operand in a data processing
1651 instruction.  That is, an integer in the range 0 to 255 rotated by a
1652 multiple of 2
1654 @item J
1655 Integer in the range @minus{}4095 to 4095
1657 @item K
1658 Integer that satisfies constraint @samp{I} when inverted (ones complement)
1660 @item L
1661 Integer that satisfies constraint @samp{I} when negated (twos complement)
1663 @item M
1664 Integer in the range 0 to 32
1666 @item Q
1667 A memory reference where the exact address is in a single register
1668 (`@samp{m}' is preferable for @code{asm} statements)
1670 @item R
1671 An item in the constant pool
1673 @item S
1674 A symbol in the text segment of the current file
1675 @end table
1677 @item Uv
1678 A memory reference suitable for VFP load/store insns (reg+constant offset)
1680 @item Uy
1681 A memory reference suitable for iWMMXt load/store instructions.
1683 @item Uq
1684 A memory reference suitable for the ARMv4 ldrsb instruction.
1686 @item AVR family---@file{avr.h}
1687 @table @code
1688 @item l
1689 Registers from r0 to r15
1691 @item a
1692 Registers from r16 to r23
1694 @item d
1695 Registers from r16 to r31
1697 @item w
1698 Registers from r24 to r31.  These registers can be used in @samp{adiw} command
1700 @item e
1701 Pointer register (r26--r31)
1703 @item b
1704 Base pointer register (r28--r31)
1706 @item q
1707 Stack pointer register (SPH:SPL)
1709 @item t
1710 Temporary register r0
1712 @item x
1713 Register pair X (r27:r26)
1715 @item y
1716 Register pair Y (r29:r28)
1718 @item z
1719 Register pair Z (r31:r30)
1721 @item I
1722 Constant greater than @minus{}1, less than 64
1724 @item J
1725 Constant greater than @minus{}64, less than 1
1727 @item K
1728 Constant integer 2
1730 @item L
1731 Constant integer 0
1733 @item M
1734 Constant that fits in 8 bits
1736 @item N
1737 Constant integer @minus{}1
1739 @item O
1740 Constant integer 8, 16, or 24
1742 @item P
1743 Constant integer 1
1745 @item G
1746 A floating point constant 0.0
1747 @end table
1749 @item PowerPC and IBM RS6000---@file{rs6000.h}
1750 @table @code
1751 @item b
1752 Address base register
1754 @item f
1755 Floating point register
1757 @item v
1758 Vector register
1760 @item h
1761 @samp{MQ}, @samp{CTR}, or @samp{LINK} register
1763 @item q
1764 @samp{MQ} register
1766 @item c
1767 @samp{CTR} register
1769 @item l
1770 @samp{LINK} register
1772 @item x
1773 @samp{CR} register (condition register) number 0
1775 @item y
1776 @samp{CR} register (condition register)
1778 @item z
1779 @samp{FPMEM} stack memory for FPR-GPR transfers
1781 @item I
1782 Signed 16-bit constant
1784 @item J
1785 Unsigned 16-bit constant shifted left 16 bits (use @samp{L} instead for
1786 @code{SImode} constants)
1788 @item K
1789 Unsigned 16-bit constant
1791 @item L
1792 Signed 16-bit constant shifted left 16 bits
1794 @item M
1795 Constant larger than 31
1797 @item N
1798 Exact power of 2
1800 @item O
1801 Zero
1803 @item P
1804 Constant whose negation is a signed 16-bit constant
1806 @item G
1807 Floating point constant that can be loaded into a register with one
1808 instruction per word
1810 @item Q
1811 Memory operand that is an offset from a register (@samp{m} is preferable
1812 for @code{asm} statements)
1814 @item R
1815 AIX TOC entry
1817 @item S
1818 Constant suitable as a 64-bit mask operand
1820 @item T
1821 Constant suitable as a 32-bit mask operand
1823 @item U
1824 System V Release 4 small data area reference
1825 @end table
1827 @item Intel 386---@file{i386.h}
1828 @table @code
1829 @item q
1830 @samp{a}, @code{b}, @code{c}, or @code{d} register for the i386.
1831 For x86-64 it is equivalent to @samp{r} class (for 8-bit instructions that
1832 do not use upper halves).
1834 @item Q
1835 @samp{a}, @code{b}, @code{c}, or @code{d} register (for 8-bit instructions,
1836 that do use upper halves).
1838 @item R
1839 Legacy register---equivalent to @code{r} class in i386 mode.
1840 (for non-8-bit registers used together with 8-bit upper halves in a single
1841 instruction)
1843 @item A
1844 Specifies the @samp{a} or @samp{d} registers.  This is primarily useful
1845 for 64-bit integer values (when in 32-bit mode) intended to be returned
1846 with the @samp{d} register holding the most significant bits and the
1847 @samp{a} register holding the least significant bits.
1849 @item f
1850 Floating point register
1852 @item t
1853 First (top of stack) floating point register
1855 @item u
1856 Second floating point register
1858 @item a
1859 @samp{a} register
1861 @item b
1862 @samp{b} register
1864 @item c
1865 @samp{c} register
1867 @item C
1868 Specifies constant that can be easily constructed in SSE register without
1869 loading it from memory.
1871 @item d
1872 @samp{d} register
1874 @item D
1875 @samp{di} register
1877 @item S
1878 @samp{si} register
1880 @item x
1881 @samp{xmm} SSE register
1883 @item y
1884 MMX register
1886 @item I
1887 Constant in range 0 to 31 (for 32-bit shifts)
1889 @item J
1890 Constant in range 0 to 63 (for 64-bit shifts)
1892 @item K
1893 @samp{0xff}
1895 @item L
1896 @samp{0xffff}
1898 @item M
1899 0, 1, 2, or 3 (shifts for @code{lea} instruction)
1901 @item N
1902 Constant in range 0 to 255 (for @code{out} instruction)
1904 @item Z
1905 Constant in range 0 to @code{0xffffffff} or symbolic reference known to fit specified range.
1906 (for using immediates in zero extending 32-bit to 64-bit x86-64 instructions)
1908 @item e
1909 Constant in range @minus{}2147483648 to 2147483647 or symbolic reference known to fit specified range.
1910 (for using immediates in 64-bit x86-64 instructions)
1912 @item G
1913 Standard 80387 floating point constant
1914 @end table
1916 @item Intel IA-64---@file{ia64.h}
1917 @table @code
1918 @item a
1919 General register @code{r0} to @code{r3} for @code{addl} instruction
1921 @item b
1922 Branch register
1924 @item c
1925 Predicate register (@samp{c} as in ``conditional'')
1927 @item d
1928 Application register residing in M-unit
1930 @item e
1931 Application register residing in I-unit
1933 @item f
1934 Floating-point register
1936 @item m
1937 Memory operand.
1938 Remember that @samp{m} allows postincrement and postdecrement which
1939 require printing with @samp{%Pn} on IA-64.
1940 Use @samp{S} to disallow postincrement and postdecrement.
1942 @item G
1943 Floating-point constant 0.0 or 1.0
1945 @item I
1946 14-bit signed integer constant
1948 @item J
1949 22-bit signed integer constant
1951 @item K
1952 8-bit signed integer constant for logical instructions
1954 @item L
1955 8-bit adjusted signed integer constant for compare pseudo-ops
1957 @item M
1958 6-bit unsigned integer constant for shift counts
1960 @item N
1961 9-bit signed integer constant for load and store postincrements
1963 @item O
1964 The constant zero
1966 @item P
1967 0 or @minus{}1 for @code{dep} instruction
1969 @item Q
1970 Non-volatile memory for floating-point loads and stores
1972 @item R
1973 Integer constant in the range 1 to 4 for @code{shladd} instruction
1975 @item S
1976 Memory operand except postincrement and postdecrement
1977 @end table
1979 @item FRV---@file{frv.h}
1980 @table @code
1981 @item a
1982 Register in the class @code{ACC_REGS} (@code{acc0} to @code{acc7}).
1984 @item b
1985 Register in the class @code{EVEN_ACC_REGS} (@code{acc0} to @code{acc7}).
1987 @item c
1988 Register in the class @code{CC_REGS} (@code{fcc0} to @code{fcc3} and
1989 @code{icc0} to @code{icc3}).
1991 @item d
1992 Register in the class @code{GPR_REGS} (@code{gr0} to @code{gr63}).
1994 @item e
1995 Register in the class @code{EVEN_REGS} (@code{gr0} to @code{gr63}).
1996 Odd registers are excluded not in the class but through the use of a machine
1997 mode larger than 4 bytes.
1999 @item f
2000 Register in the class @code{FPR_REGS} (@code{fr0} to @code{fr63}).
2002 @item h
2003 Register in the class @code{FEVEN_REGS} (@code{fr0} to @code{fr63}).
2004 Odd registers are excluded not in the class but through the use of a machine
2005 mode larger than 4 bytes.
2007 @item l
2008 Register in the class @code{LR_REG} (the @code{lr} register).
2010 @item q
2011 Register in the class @code{QUAD_REGS} (@code{gr2} to @code{gr63}).
2012 Register numbers not divisible by 4 are excluded not in the class but through
2013 the use of a machine mode larger than 8 bytes.
2015 @item t
2016 Register in the class @code{ICC_REGS} (@code{icc0} to @code{icc3}).
2018 @item u
2019 Register in the class @code{FCC_REGS} (@code{fcc0} to @code{fcc3}).
2021 @item v
2022 Register in the class @code{ICR_REGS} (@code{cc4} to @code{cc7}).
2024 @item w
2025 Register in the class @code{FCR_REGS} (@code{cc0} to @code{cc3}).
2027 @item x
2028 Register in the class @code{QUAD_FPR_REGS} (@code{fr0} to @code{fr63}).
2029 Register numbers not divisible by 4 are excluded not in the class but through
2030 the use of a machine mode larger than 8 bytes.
2032 @item z
2033 Register in the class @code{SPR_REGS} (@code{lcr} and @code{lr}).
2035 @item A
2036 Register in the class @code{QUAD_ACC_REGS} (@code{acc0} to @code{acc7}).
2038 @item B
2039 Register in the class @code{ACCG_REGS} (@code{accg0} to @code{accg7}).
2041 @item C
2042 Register in the class @code{CR_REGS} (@code{cc0} to @code{cc7}).
2044 @item G
2045 Floating point constant zero
2047 @item I
2048 6-bit signed integer constant
2050 @item J
2051 10-bit signed integer constant
2053 @item L
2054 16-bit signed integer constant
2056 @item M
2057 16-bit unsigned integer constant
2059 @item N
2060 12-bit signed integer constant that is negative---i.e.@: in the
2061 range of @minus{}2048 to @minus{}1
2063 @item O
2064 Constant zero
2066 @item P
2067 12-bit signed integer constant that is greater than zero---i.e.@: in the
2068 range of 1 to 2047.
2070 @end table
2072 @item Blackfin family---@file{bfin.h}
2073 @table @code
2074 @item a
2075 P register
2077 @item d
2078 D register
2080 @item z
2081 A call clobbered P register.
2083 @item D
2084 Even-numbered D register
2086 @item W
2087 Odd-numbered D register
2089 @item e
2090 Accumulator register.
2092 @item A
2093 Even-numbered accumulator register.
2095 @item B
2096 Odd-numbered accumulator register.
2098 @item b
2099 I register
2101 @item B
2102 B register
2104 @item f
2105 M register
2107 @item c
2108 Registers used for circular buffering, i.e. I, B, or L registers.
2110 @item C
2111 The CC register.
2113 @item x
2114 Any D, P, B, M, I or L register.
2116 @item y
2117 Additional registers typically used only in prologues and epilogues: RETS,
2118 RETN, RETI, RETX, RETE, ASTAT, SEQSTAT and USP.
2120 @item w
2121 Any register except accumulators or CC.
2123 @item Ksh
2124 Signed 16 bit integer (in the range -32768 to 32767)
2126 @item Kuh
2127 Unsigned 16 bit integer (in the range 0 to 65535)
2129 @item Ks7
2130 Signed 7 bit integer (in the range -64 to 63)
2132 @item Ku7
2133 Unsigned 7 bit integer (in the range 0 to 127)
2135 @item Ku5
2136 Unsigned 5 bit integer (in the range 0 to 31)
2138 @item Ks4
2139 Signed 4 bit integer (in the range -8 to 7)
2141 @item Ks3
2142 Signed 3 bit integer (in the range -3 to 4)
2144 @item Ku3
2145 Unsigned 3 bit integer (in the range 0 to 7)
2147 @item P@var{n}
2148 Constant @var{n}, where @var{n} is a single-digit constant in the range 0 to 4.
2150 @item M1
2151 Constant 255.
2153 @item M2
2154 Constant 65535.
2156 @item J
2157 An integer constant with exactly a single bit set.
2159 @item L
2160 An integer constant with all bits set except exactly one.
2162 @item H
2164 @item Q
2165 Any SYMBOL_REF.
2166 @end table
2168 @item IP2K---@file{ip2k.h}
2169 @table @code
2170 @item a
2171 @samp{DP} or @samp{IP} registers (general address)
2173 @item f
2174 @samp{IP} register
2176 @item j
2177 @samp{IPL} register
2179 @item k
2180 @samp{IPH} register
2182 @item b
2183 @samp{DP} register
2185 @item y
2186 @samp{DPH} register
2188 @item z
2189 @samp{DPL} register
2191 @item q
2192 @samp{SP} register
2194 @item c
2195 @samp{DP} or @samp{SP} registers (offsettable address)
2197 @item d
2198 Non-pointer registers (not @samp{SP}, @samp{DP}, @samp{IP})
2200 @item u
2201 Non-SP registers (everything except @samp{SP})
2203 @item R
2204 Indirect through @samp{IP}---Avoid this except for @code{QImode}, since we
2205 can't access extra bytes
2207 @item S
2208 Indirect through @samp{SP} or @samp{DP} with short displacement (0..127)
2210 @item T
2211 Data-section immediate value
2213 @item I
2214 Integers from @minus{}255 to @minus{}1
2216 @item J
2217 Integers from 0 to 7---valid bit number in a register
2219 @item K
2220 Integers from 0 to 127---valid displacement for addressing mode
2222 @item L
2223 Integers from 1 to 127
2225 @item M
2226 Integer @minus{}1
2228 @item N
2229 Integer 1
2231 @item O
2232 Zero
2234 @item P
2235 Integers from 0 to 255
2236 @end table
2238 @item MIPS---@file{mips.h}
2239 @table @code
2240 @item d
2241 General-purpose integer register
2243 @item f
2244 Floating-point register (if available)
2246 @item h
2247 @samp{Hi} register
2249 @item l
2250 @samp{Lo} register
2252 @item x
2253 @samp{Hi} or @samp{Lo} register
2255 @item y
2256 General-purpose integer register
2258 @item z
2259 Floating-point status register
2261 @item I
2262 Signed 16-bit constant (for arithmetic instructions)
2264 @item J
2265 Zero
2267 @item K
2268 Zero-extended 16-bit constant (for logic instructions)
2270 @item L
2271 Constant with low 16 bits zero (can be loaded with @code{lui})
2273 @item M
2274 32-bit constant which requires two instructions to load (a constant
2275 which is not @samp{I}, @samp{K}, or @samp{L})
2277 @item N
2278 Negative 16-bit constant
2280 @item O
2281 Exact power of two
2283 @item P
2284 Positive 16-bit constant
2286 @item G
2287 Floating point zero
2289 @item Q
2290 Memory reference that can be loaded with more than one instruction
2291 (@samp{m} is preferable for @code{asm} statements)
2293 @item R
2294 Memory reference that can be loaded with one instruction
2295 (@samp{m} is preferable for @code{asm} statements)
2297 @item S
2298 Memory reference in external OSF/rose PIC format
2299 (@samp{m} is preferable for @code{asm} statements)
2300 @end table
2302 @item Motorola 680x0---@file{m68k.h}
2303 @table @code
2304 @item a
2305 Address register
2307 @item d
2308 Data register
2310 @item f
2311 68881 floating-point register, if available
2313 @item I
2314 Integer in the range 1 to 8
2316 @item J
2317 16-bit signed number
2319 @item K
2320 Signed number whose magnitude is greater than 0x80
2322 @item L
2323 Integer in the range @minus{}8 to @minus{}1
2325 @item M
2326 Signed number whose magnitude is greater than 0x100
2328 @item G
2329 Floating point constant that is not a 68881 constant
2330 @end table
2332 @item Motorola 68HC11 & 68HC12 families---@file{m68hc11.h}
2333 @table @code
2334 @item a
2335 Register `a'
2337 @item b
2338 Register `b'
2340 @item d
2341 Register `d'
2343 @item q
2344 An 8-bit register
2346 @item t
2347 Temporary soft register _.tmp
2349 @item u
2350 A soft register _.d1 to _.d31
2352 @item w
2353 Stack pointer register
2355 @item x
2356 Register `x'
2358 @item y
2359 Register `y'
2361 @item z
2362 Pseudo register `z' (replaced by `x' or `y' at the end)
2364 @item A
2365 An address register: x, y or z
2367 @item B
2368 An address register: x or y
2370 @item D
2371 Register pair (x:d) to form a 32-bit value
2373 @item L
2374 Constants in the range @minus{}65536 to 65535
2376 @item M
2377 Constants whose 16-bit low part is zero
2379 @item N
2380 Constant integer 1 or @minus{}1
2382 @item O
2383 Constant integer 16
2385 @item P
2386 Constants in the range @minus{}8 to 2
2388 @end table
2390 @need 1000
2391 @item SPARC---@file{sparc.h}
2392 @table @code
2393 @item f
2394 Floating-point register on the SPARC-V8 architecture and
2395 lower floating-point register on the SPARC-V9 architecture.
2397 @item e
2398 Floating-point register.  It is equivalent to @samp{f} on the
2399 SPARC-V8 architecture and contains both lower and upper
2400 floating-point registers on the SPARC-V9 architecture.
2402 @item c
2403 Floating-point condition code register.
2405 @item d
2406 Lower floating-point register.  It is only valid on the SPARC-V9
2407 architecture when the Visual Instruction Set is available.
2409 @item b
2410 Floating-point register.  It is only valid on the SPARC-V9 architecture
2411 when the Visual Instruction Set is available.
2413 @item h
2414 64-bit global or out register for the SPARC-V8+ architecture.
2416 @item I
2417 Signed 13-bit constant
2419 @item J
2420 Zero
2422 @item K
2423 32-bit constant with the low 12 bits clear (a constant that can be
2424 loaded with the @code{sethi} instruction)
2426 @item L
2427 A constant in the range supported by @code{movcc} instructions
2429 @item M
2430 A constant in the range supported by @code{movrcc} instructions
2432 @item N
2433 Same as @samp{K}, except that it verifies that bits that are not in the
2434 lower 32-bit range are all zero.  Must be used instead of @samp{K} for
2435 modes wider than @code{SImode}
2437 @item O
2438 The constant 4096
2440 @item G
2441 Floating-point zero
2443 @item H
2444 Signed 13-bit constant, sign-extended to 32 or 64 bits
2446 @item Q
2447 Floating-point constant whose integral representation can
2448 be moved into an integer register using a single sethi
2449 instruction
2451 @item R
2452 Floating-point constant whose integral representation can
2453 be moved into an integer register using a single mov
2454 instruction
2456 @item S
2457 Floating-point constant whose integral representation can
2458 be moved into an integer register using a high/lo_sum
2459 instruction sequence
2461 @item T
2462 Memory address aligned to an 8-byte boundary
2464 @item U
2465 Even register
2467 @item W
2468 Memory address for @samp{e} constraint registers
2470 @item Y
2471 Vector zero
2473 @end table
2475 @item TMS320C3x/C4x---@file{c4x.h}
2476 @table @code
2477 @item a
2478 Auxiliary (address) register (ar0-ar7)
2480 @item b
2481 Stack pointer register (sp)
2483 @item c
2484 Standard (32-bit) precision integer register
2486 @item f
2487 Extended (40-bit) precision register (r0-r11)
2489 @item k
2490 Block count register (bk)
2492 @item q
2493 Extended (40-bit) precision low register (r0-r7)
2495 @item t
2496 Extended (40-bit) precision register (r0-r1)
2498 @item u
2499 Extended (40-bit) precision register (r2-r3)
2501 @item v
2502 Repeat count register (rc)
2504 @item x
2505 Index register (ir0-ir1)
2507 @item y
2508 Status (condition code) register (st)
2510 @item z
2511 Data page register (dp)
2513 @item G
2514 Floating-point zero
2516 @item H
2517 Immediate 16-bit floating-point constant
2519 @item I
2520 Signed 16-bit constant
2522 @item J
2523 Signed 8-bit constant
2525 @item K
2526 Signed 5-bit constant
2528 @item L
2529 Unsigned 16-bit constant
2531 @item M
2532 Unsigned 8-bit constant
2534 @item N
2535 Ones complement of unsigned 16-bit constant
2537 @item O
2538 High 16-bit constant (32-bit constant with 16 LSBs zero)
2540 @item Q
2541 Indirect memory reference with signed 8-bit or index register displacement
2543 @item R
2544 Indirect memory reference with unsigned 5-bit displacement
2546 @item S
2547 Indirect memory reference with 1 bit or index register displacement
2549 @item T
2550 Direct memory reference
2552 @item U
2553 Symbolic address
2555 @end table
2557 @item S/390 and zSeries---@file{s390.h}
2558 @table @code
2559 @item a
2560 Address register (general purpose register except r0)
2562 @item c
2563 Condition code register
2565 @item d
2566 Data register (arbitrary general purpose register)
2568 @item f
2569 Floating-point register
2571 @item I
2572 Unsigned 8-bit constant (0--255)
2574 @item J
2575 Unsigned 12-bit constant (0--4095)
2577 @item K
2578 Signed 16-bit constant (@minus{}32768--32767)
2580 @item L
2581 Value appropriate as displacement.
2582 @table @code
2583        @item (0..4095)
2584        for short displacement
2585        @item (-524288..524287)
2586        for long displacement
2587 @end table
2589 @item M
2590 Constant integer with a value of 0x7fffffff.
2592 @item N
2593 Multiple letter constraint followed by 4 parameter letters.
2594 @table @code
2595          @item 0..9:
2596          number of the part counting from most to least significant
2597          @item H,Q:
2598          mode of the part
2599          @item D,S,H:
2600          mode of the containing operand
2601          @item 0,F:
2602          value of the other parts (F---all bits set)
2603 @end table
2604 The constraint matches if the specified part of a constant
2605 has a value different from it's other parts.
2607 @item Q
2608 Memory reference without index register and with short displacement.
2610 @item R
2611 Memory reference with index register and short displacement.
2613 @item S
2614 Memory reference without index register but with long displacement.
2616 @item T
2617 Memory reference with index register and long displacement.
2619 @item U
2620 Pointer with short displacement.
2622 @item W
2623 Pointer with long displacement.
2625 @item Y
2626 Shift count operand.
2628 @end table
2630 @item Xstormy16---@file{stormy16.h}
2631 @table @code
2632 @item a
2633 Register r0.
2635 @item b
2636 Register r1.
2638 @item c
2639 Register r2.
2641 @item d
2642 Register r8.
2644 @item e
2645 Registers r0 through r7.
2647 @item t
2648 Registers r0 and r1.
2650 @item y
2651 The carry register.
2653 @item z
2654 Registers r8 and r9.
2656 @item I
2657 A constant between 0 and 3 inclusive.
2659 @item J
2660 A constant that has exactly one bit set.
2662 @item K
2663 A constant that has exactly one bit clear.
2665 @item L
2666 A constant between 0 and 255 inclusive.
2668 @item M
2669 A constant between @minus{}255 and 0 inclusive.
2671 @item N
2672 A constant between @minus{}3 and 0 inclusive.
2674 @item O
2675 A constant between 1 and 4 inclusive.
2677 @item P
2678 A constant between @minus{}4 and @minus{}1 inclusive.
2680 @item Q
2681 A memory reference that is a stack push.
2683 @item R
2684 A memory reference that is a stack pop.
2686 @item S
2687 A memory reference that refers to a constant address of known value.
2689 @item T
2690 The register indicated by Rx (not implemented yet).
2692 @item U
2693 A constant that is not between 2 and 15 inclusive.
2695 @item Z
2696 The constant 0.
2698 @end table
2700 @item Xtensa---@file{xtensa.h}
2701 @table @code
2702 @item a
2703 General-purpose 32-bit register
2705 @item b
2706 One-bit boolean register
2708 @item A
2709 MAC16 40-bit accumulator register
2711 @item I
2712 Signed 12-bit integer constant, for use in MOVI instructions
2714 @item J
2715 Signed 8-bit integer constant, for use in ADDI instructions
2717 @item K
2718 Integer constant valid for BccI instructions
2720 @item L
2721 Unsigned constant valid for BccUI instructions
2723 @end table
2725 @end table
2727 @ifset INTERNALS
2728 @node Standard Names
2729 @section Standard Pattern Names For Generation
2730 @cindex standard pattern names
2731 @cindex pattern names
2732 @cindex names, pattern
2734 Here is a table of the instruction names that are meaningful in the RTL
2735 generation pass of the compiler.  Giving one of these names to an
2736 instruction pattern tells the RTL generation pass that it can use the
2737 pattern to accomplish a certain task.
2739 @table @asis
2740 @cindex @code{mov@var{m}} instruction pattern
2741 @item @samp{mov@var{m}}
2742 Here @var{m} stands for a two-letter machine mode name, in lowercase.
2743 This instruction pattern moves data with that machine mode from operand
2744 1 to operand 0.  For example, @samp{movsi} moves full-word data.
2746 If operand 0 is a @code{subreg} with mode @var{m} of a register whose
2747 own mode is wider than @var{m}, the effect of this instruction is
2748 to store the specified value in the part of the register that corresponds
2749 to mode @var{m}.  Bits outside of @var{m}, but which are within the
2750 same target word as the @code{subreg} are undefined.  Bits which are
2751 outside the target word are left unchanged.
2753 This class of patterns is special in several ways.  First of all, each
2754 of these names up to and including full word size @emph{must} be defined,
2755 because there is no other way to copy a datum from one place to another.
2756 If there are patterns accepting operands in larger modes,
2757 @samp{mov@var{m}} must be defined for integer modes of those sizes.
2759 Second, these patterns are not used solely in the RTL generation pass.
2760 Even the reload pass can generate move insns to copy values from stack
2761 slots into temporary registers.  When it does so, one of the operands is
2762 a hard register and the other is an operand that can need to be reloaded
2763 into a register.
2765 @findex force_reg
2766 Therefore, when given such a pair of operands, the pattern must generate
2767 RTL which needs no reloading and needs no temporary registers---no
2768 registers other than the operands.  For example, if you support the
2769 pattern with a @code{define_expand}, then in such a case the
2770 @code{define_expand} mustn't call @code{force_reg} or any other such
2771 function which might generate new pseudo registers.
2773 This requirement exists even for subword modes on a RISC machine where
2774 fetching those modes from memory normally requires several insns and
2775 some temporary registers.
2777 @findex change_address
2778 During reload a memory reference with an invalid address may be passed
2779 as an operand.  Such an address will be replaced with a valid address
2780 later in the reload pass.  In this case, nothing may be done with the
2781 address except to use it as it stands.  If it is copied, it will not be
2782 replaced with a valid address.  No attempt should be made to make such
2783 an address into a valid address and no routine (such as
2784 @code{change_address}) that will do so may be called.  Note that
2785 @code{general_operand} will fail when applied to such an address.
2787 @findex reload_in_progress
2788 The global variable @code{reload_in_progress} (which must be explicitly
2789 declared if required) can be used to determine whether such special
2790 handling is required.
2792 The variety of operands that have reloads depends on the rest of the
2793 machine description, but typically on a RISC machine these can only be
2794 pseudo registers that did not get hard registers, while on other
2795 machines explicit memory references will get optional reloads.
2797 If a scratch register is required to move an object to or from memory,
2798 it can be allocated using @code{gen_reg_rtx} prior to life analysis.
2800 If there are cases which need scratch registers during or after reload,
2801 you must define @code{SECONDARY_INPUT_RELOAD_CLASS} and/or
2802 @code{SECONDARY_OUTPUT_RELOAD_CLASS} to detect them, and provide
2803 patterns @samp{reload_in@var{m}} or @samp{reload_out@var{m}} to handle
2804 them.  @xref{Register Classes}.
2806 @findex no_new_pseudos
2807 The global variable @code{no_new_pseudos} can be used to determine if it
2808 is unsafe to create new pseudo registers.  If this variable is nonzero, then
2809 it is unsafe to call @code{gen_reg_rtx} to allocate a new pseudo.
2811 The constraints on a @samp{mov@var{m}} must permit moving any hard
2812 register to any other hard register provided that
2813 @code{HARD_REGNO_MODE_OK} permits mode @var{m} in both registers and
2814 @code{REGISTER_MOVE_COST} applied to their classes returns a value of 2.
2816 It is obligatory to support floating point @samp{mov@var{m}}
2817 instructions into and out of any registers that can hold fixed point
2818 values, because unions and structures (which have modes @code{SImode} or
2819 @code{DImode}) can be in those registers and they may have floating
2820 point members.
2822 There may also be a need to support fixed point @samp{mov@var{m}}
2823 instructions in and out of floating point registers.  Unfortunately, I
2824 have forgotten why this was so, and I don't know whether it is still
2825 true.  If @code{HARD_REGNO_MODE_OK} rejects fixed point values in
2826 floating point registers, then the constraints of the fixed point
2827 @samp{mov@var{m}} instructions must be designed to avoid ever trying to
2828 reload into a floating point register.
2830 @cindex @code{reload_in} instruction pattern
2831 @cindex @code{reload_out} instruction pattern
2832 @item @samp{reload_in@var{m}}
2833 @itemx @samp{reload_out@var{m}}
2834 Like @samp{mov@var{m}}, but used when a scratch register is required to
2835 move between operand 0 and operand 1.  Operand 2 describes the scratch
2836 register.  See the discussion of the @code{SECONDARY_RELOAD_CLASS}
2837 macro in @pxref{Register Classes}.
2839 There are special restrictions on the form of the @code{match_operand}s
2840 used in these patterns.  First, only the predicate for the reload
2841 operand is examined, i.e., @code{reload_in} examines operand 1, but not
2842 the predicates for operand 0 or 2.  Second, there may be only one
2843 alternative in the constraints.  Third, only a single register class
2844 letter may be used for the constraint; subsequent constraint letters
2845 are ignored.  As a special exception, an empty constraint string
2846 matches the @code{ALL_REGS} register class.  This may relieve ports
2847 of the burden of defining an @code{ALL_REGS} constraint letter just
2848 for these patterns.
2850 @cindex @code{movstrict@var{m}} instruction pattern
2851 @item @samp{movstrict@var{m}}
2852 Like @samp{mov@var{m}} except that if operand 0 is a @code{subreg}
2853 with mode @var{m} of a register whose natural mode is wider,
2854 the @samp{movstrict@var{m}} instruction is guaranteed not to alter
2855 any of the register except the part which belongs to mode @var{m}.
2857 @cindex @code{movmisalign@var{m}} instruction pattern
2858 @item @samp{movmisalign@var{m}}
2859 This variant of a move pattern is designed to load or store a value
2860 from a memory address that is not naturally aligned for its mode.
2861 For a store, the memory will be in operand 0; for a load, the memory
2862 will be in operand 1.  The other operand is guaranteed not to be a
2863 memory, so that it's easy to tell whether this is a load or store.
2865 This pattern is used by the autovectorizer, and when expanding a
2866 @code{MISALIGNED_INDIRECT_REF} expression.
2868 @cindex @code{load_multiple} instruction pattern
2869 @item @samp{load_multiple}
2870 Load several consecutive memory locations into consecutive registers.
2871 Operand 0 is the first of the consecutive registers, operand 1
2872 is the first memory location, and operand 2 is a constant: the
2873 number of consecutive registers.
2875 Define this only if the target machine really has such an instruction;
2876 do not define this if the most efficient way of loading consecutive
2877 registers from memory is to do them one at a time.
2879 On some machines, there are restrictions as to which consecutive
2880 registers can be stored into memory, such as particular starting or
2881 ending register numbers or only a range of valid counts.  For those
2882 machines, use a @code{define_expand} (@pxref{Expander Definitions})
2883 and make the pattern fail if the restrictions are not met.
2885 Write the generated insn as a @code{parallel} with elements being a
2886 @code{set} of one register from the appropriate memory location (you may
2887 also need @code{use} or @code{clobber} elements).  Use a
2888 @code{match_parallel} (@pxref{RTL Template}) to recognize the insn.  See
2889 @file{rs6000.md} for examples of the use of this insn pattern.
2891 @cindex @samp{store_multiple} instruction pattern
2892 @item @samp{store_multiple}
2893 Similar to @samp{load_multiple}, but store several consecutive registers
2894 into consecutive memory locations.  Operand 0 is the first of the
2895 consecutive memory locations, operand 1 is the first register, and
2896 operand 2 is a constant: the number of consecutive registers.
2898 @cindex @code{vec_set@var{m}} instruction pattern
2899 @item @samp{vec_set@var{m}}
2900 Set given field in the vector value.  Operand 0 is the vector to modify,
2901 operand 1 is new value of field and operand 2 specify the field index.
2903 @cindex @code{vec_extract@var{m}} instruction pattern
2904 @item @samp{vec_extract@var{m}}
2905 Extract given field from the vector value.  Operand 1 is the vector, operand 2
2906 specify field index and operand 0 place to store value into.
2908 @cindex @code{vec_init@var{m}} instruction pattern
2909 @item @samp{vec_init@var{m}}
2910 Initialize the vector to given values.  Operand 0 is the vector to initialize
2911 and operand 1 is parallel containing values for individual fields.
2913 @cindex @code{push@var{m}} instruction pattern
2914 @item @samp{push@var{m}}
2915 Output a push instruction.  Operand 0 is value to push.  Used only when
2916 @code{PUSH_ROUNDING} is defined.  For historical reason, this pattern may be
2917 missing and in such case an @code{mov} expander is used instead, with a
2918 @code{MEM} expression forming the push operation.  The @code{mov} expander
2919 method is deprecated.
2921 @cindex @code{add@var{m}3} instruction pattern
2922 @item @samp{add@var{m}3}
2923 Add operand 2 and operand 1, storing the result in operand 0.  All operands
2924 must have mode @var{m}.  This can be used even on two-address machines, by
2925 means of constraints requiring operands 1 and 0 to be the same location.
2927 @cindex @code{sub@var{m}3} instruction pattern
2928 @cindex @code{mul@var{m}3} instruction pattern
2929 @cindex @code{div@var{m}3} instruction pattern
2930 @cindex @code{udiv@var{m}3} instruction pattern
2931 @cindex @code{mod@var{m}3} instruction pattern
2932 @cindex @code{umod@var{m}3} instruction pattern
2933 @cindex @code{umin@var{m}3} instruction pattern
2934 @cindex @code{umax@var{m}3} instruction pattern
2935 @cindex @code{and@var{m}3} instruction pattern
2936 @cindex @code{ior@var{m}3} instruction pattern
2937 @cindex @code{xor@var{m}3} instruction pattern
2938 @item @samp{sub@var{m}3}, @samp{mul@var{m}3}
2939 @itemx @samp{div@var{m}3}, @samp{udiv@var{m}3}
2940 @itemx @samp{mod@var{m}3}, @samp{umod@var{m}3}
2941 @itemx @samp{umin@var{m}3}, @samp{umax@var{m}3}
2942 @itemx @samp{and@var{m}3}, @samp{ior@var{m}3}, @samp{xor@var{m}3}
2943 Similar, for other arithmetic operations.
2945 @cindex @code{min@var{m}3} instruction pattern
2946 @cindex @code{max@var{m}3} instruction pattern
2947 @item @samp{smin@var{m}3}, @samp{smax@var{m}3}
2948 Signed minimum and maximum operations.  When used with floating point,
2949 if both operands are zeros, or if either operand is @code{NaN}, then
2950 it is unspecified which of the two operands is returned as the result.
2952 @cindex @code{mulhisi3} instruction pattern
2953 @item @samp{mulhisi3}
2954 Multiply operands 1 and 2, which have mode @code{HImode}, and store
2955 a @code{SImode} product in operand 0.
2957 @cindex @code{mulqihi3} instruction pattern
2958 @cindex @code{mulsidi3} instruction pattern
2959 @item @samp{mulqihi3}, @samp{mulsidi3}
2960 Similar widening-multiplication instructions of other widths.
2962 @cindex @code{umulqihi3} instruction pattern
2963 @cindex @code{umulhisi3} instruction pattern
2964 @cindex @code{umulsidi3} instruction pattern
2965 @item @samp{umulqihi3}, @samp{umulhisi3}, @samp{umulsidi3}
2966 Similar widening-multiplication instructions that do unsigned
2967 multiplication.
2969 @cindex @code{smul@var{m}3_highpart} instruction pattern
2970 @item @samp{smul@var{m}3_highpart}
2971 Perform a signed multiplication of operands 1 and 2, which have mode
2972 @var{m}, and store the most significant half of the product in operand 0.
2973 The least significant half of the product is discarded.
2975 @cindex @code{umul@var{m}3_highpart} instruction pattern
2976 @item @samp{umul@var{m}3_highpart}
2977 Similar, but the multiplication is unsigned.
2979 @cindex @code{divmod@var{m}4} instruction pattern
2980 @item @samp{divmod@var{m}4}
2981 Signed division that produces both a quotient and a remainder.
2982 Operand 1 is divided by operand 2 to produce a quotient stored
2983 in operand 0 and a remainder stored in operand 3.
2985 For machines with an instruction that produces both a quotient and a
2986 remainder, provide a pattern for @samp{divmod@var{m}4} but do not
2987 provide patterns for @samp{div@var{m}3} and @samp{mod@var{m}3}.  This
2988 allows optimization in the relatively common case when both the quotient
2989 and remainder are computed.
2991 If an instruction that just produces a quotient or just a remainder
2992 exists and is more efficient than the instruction that produces both,
2993 write the output routine of @samp{divmod@var{m}4} to call
2994 @code{find_reg_note} and look for a @code{REG_UNUSED} note on the
2995 quotient or remainder and generate the appropriate instruction.
2997 @cindex @code{udivmod@var{m}4} instruction pattern
2998 @item @samp{udivmod@var{m}4}
2999 Similar, but does unsigned division.
3001 @anchor{shift patterns}
3002 @cindex @code{ashl@var{m}3} instruction pattern
3003 @item @samp{ashl@var{m}3}
3004 Arithmetic-shift operand 1 left by a number of bits specified by operand
3005 2, and store the result in operand 0.  Here @var{m} is the mode of
3006 operand 0 and operand 1; operand 2's mode is specified by the
3007 instruction pattern, and the compiler will convert the operand to that
3008 mode before generating the instruction.  The meaning of out-of-range shift
3009 counts can optionally be specified by @code{TARGET_SHIFT_TRUNCATION_MASK}.
3010 @xref{TARGET_SHIFT_TRUNCATION_MASK}.
3012 @cindex @code{ashr@var{m}3} instruction pattern
3013 @cindex @code{lshr@var{m}3} instruction pattern
3014 @cindex @code{rotl@var{m}3} instruction pattern
3015 @cindex @code{rotr@var{m}3} instruction pattern
3016 @item @samp{ashr@var{m}3}, @samp{lshr@var{m}3}, @samp{rotl@var{m}3}, @samp{rotr@var{m}3}
3017 Other shift and rotate instructions, analogous to the
3018 @code{ashl@var{m}3} instructions.
3020 @cindex @code{neg@var{m}2} instruction pattern
3021 @item @samp{neg@var{m}2}
3022 Negate operand 1 and store the result in operand 0.
3024 @cindex @code{abs@var{m}2} instruction pattern
3025 @item @samp{abs@var{m}2}
3026 Store the absolute value of operand 1 into operand 0.
3028 @cindex @code{sqrt@var{m}2} instruction pattern
3029 @item @samp{sqrt@var{m}2}
3030 Store the square root of operand 1 into operand 0.
3032 The @code{sqrt} built-in function of C always uses the mode which
3033 corresponds to the C data type @code{double} and the @code{sqrtf}
3034 built-in function uses the mode which corresponds to the C data
3035 type @code{float}.
3037 @cindex @code{cos@var{m}2} instruction pattern
3038 @item @samp{cos@var{m}2}
3039 Store the cosine of operand 1 into operand 0.
3041 The @code{cos} built-in function of C always uses the mode which
3042 corresponds to the C data type @code{double} and the @code{cosf}
3043 built-in function uses the mode which corresponds to the C data
3044 type @code{float}.
3046 @cindex @code{sin@var{m}2} instruction pattern
3047 @item @samp{sin@var{m}2}
3048 Store the sine of operand 1 into operand 0.
3050 The @code{sin} built-in function of C always uses the mode which
3051 corresponds to the C data type @code{double} and the @code{sinf}
3052 built-in function uses the mode which corresponds to the C data
3053 type @code{float}.
3055 @cindex @code{exp@var{m}2} instruction pattern
3056 @item @samp{exp@var{m}2}
3057 Store the exponential of operand 1 into operand 0.
3059 The @code{exp} built-in function of C always uses the mode which
3060 corresponds to the C data type @code{double} and the @code{expf}
3061 built-in function uses the mode which corresponds to the C data
3062 type @code{float}.
3064 @cindex @code{log@var{m}2} instruction pattern
3065 @item @samp{log@var{m}2}
3066 Store the natural logarithm of operand 1 into operand 0.
3068 The @code{log} built-in function of C always uses the mode which
3069 corresponds to the C data type @code{double} and the @code{logf}
3070 built-in function uses the mode which corresponds to the C data
3071 type @code{float}.
3073 @cindex @code{pow@var{m}3} instruction pattern
3074 @item @samp{pow@var{m}3}
3075 Store the value of operand 1 raised to the exponent operand 2
3076 into operand 0.
3078 The @code{pow} built-in function of C always uses the mode which
3079 corresponds to the C data type @code{double} and the @code{powf}
3080 built-in function uses the mode which corresponds to the C data
3081 type @code{float}.
3083 @cindex @code{atan2@var{m}3} instruction pattern
3084 @item @samp{atan2@var{m}3}
3085 Store the arc tangent (inverse tangent) of operand 1 divided by
3086 operand 2 into operand 0, using the signs of both arguments to
3087 determine the quadrant of the result.
3089 The @code{atan2} built-in function of C always uses the mode which
3090 corresponds to the C data type @code{double} and the @code{atan2f}
3091 built-in function uses the mode which corresponds to the C data
3092 type @code{float}.
3094 @cindex @code{floor@var{m}2} instruction pattern
3095 @item @samp{floor@var{m}2}
3096 Store the largest integral value not greater than argument.
3098 The @code{floor} built-in function of C always uses the mode which
3099 corresponds to the C data type @code{double} and the @code{floorf}
3100 built-in function uses the mode which corresponds to the C data
3101 type @code{float}.
3103 @cindex @code{trunc@var{m}2} instruction pattern
3104 @item @samp{trunc@var{m}2}
3105 Store the argument rounded to integer towards zero.
3107 The @code{trunc} built-in function of C always uses the mode which
3108 corresponds to the C data type @code{double} and the @code{truncf}
3109 built-in function uses the mode which corresponds to the C data
3110 type @code{float}.
3112 @cindex @code{round@var{m}2} instruction pattern
3113 @item @samp{round@var{m}2}
3114 Store the argument rounded to integer away from zero.
3116 The @code{round} built-in function of C always uses the mode which
3117 corresponds to the C data type @code{double} and the @code{roundf}
3118 built-in function uses the mode which corresponds to the C data
3119 type @code{float}.
3121 @cindex @code{ceil@var{m}2} instruction pattern
3122 @item @samp{ceil@var{m}2}
3123 Store the argument rounded to integer away from zero.
3125 The @code{ceil} built-in function of C always uses the mode which
3126 corresponds to the C data type @code{double} and the @code{ceilf}
3127 built-in function uses the mode which corresponds to the C data
3128 type @code{float}.
3130 @cindex @code{nearbyint@var{m}2} instruction pattern
3131 @item @samp{nearbyint@var{m}2}
3132 Store the argument rounded according to the default rounding mode
3134 The @code{nearbyint} built-in function of C always uses the mode which
3135 corresponds to the C data type @code{double} and the @code{nearbyintf}
3136 built-in function uses the mode which corresponds to the C data
3137 type @code{float}.
3139 @cindex @code{ffs@var{m}2} instruction pattern
3140 @item @samp{ffs@var{m}2}
3141 Store into operand 0 one plus the index of the least significant 1-bit
3142 of operand 1.  If operand 1 is zero, store zero.  @var{m} is the mode
3143 of operand 0; operand 1's mode is specified by the instruction
3144 pattern, and the compiler will convert the operand to that mode before
3145 generating the instruction.
3147 The @code{ffs} built-in function of C always uses the mode which
3148 corresponds to the C data type @code{int}.
3150 @cindex @code{clz@var{m}2} instruction pattern
3151 @item @samp{clz@var{m}2}
3152 Store into operand 0 the number of leading 0-bits in @var{x}, starting
3153 at the most significant bit position.  If @var{x} is 0, the result is
3154 undefined.  @var{m} is the mode of operand 0; operand 1's mode is
3155 specified by the instruction pattern, and the compiler will convert the
3156 operand to that mode before generating the instruction.
3158 @cindex @code{ctz@var{m}2} instruction pattern
3159 @item @samp{ctz@var{m}2}
3160 Store into operand 0 the number of trailing 0-bits in @var{x}, starting
3161 at the least significant bit position.  If @var{x} is 0, the result is
3162 undefined.  @var{m} is the mode of operand 0; operand 1's mode is
3163 specified by the instruction pattern, and the compiler will convert the
3164 operand to that mode before generating the instruction.
3166 @cindex @code{popcount@var{m}2} instruction pattern
3167 @item @samp{popcount@var{m}2}
3168 Store into operand 0 the number of 1-bits in @var{x}.  @var{m} is the
3169 mode of operand 0; operand 1's mode is specified by the instruction
3170 pattern, and the compiler will convert the operand to that mode before
3171 generating the instruction.
3173 @cindex @code{parity@var{m}2} instruction pattern
3174 @item @samp{parity@var{m}2}
3175 Store into operand 0 the parity of @var{x}, i.e.@: the number of 1-bits
3176 in @var{x} modulo 2.  @var{m} is the mode of operand 0; operand 1's mode
3177 is specified by the instruction pattern, and the compiler will convert
3178 the operand to that mode before generating the instruction.
3180 @cindex @code{one_cmpl@var{m}2} instruction pattern
3181 @item @samp{one_cmpl@var{m}2}
3182 Store the bitwise-complement of operand 1 into operand 0.
3184 @cindex @code{cmp@var{m}} instruction pattern
3185 @item @samp{cmp@var{m}}
3186 Compare operand 0 and operand 1, and set the condition codes.
3187 The RTL pattern should look like this:
3189 @smallexample
3190 (set (cc0) (compare (match_operand:@var{m} 0 @dots{})
3191                     (match_operand:@var{m} 1 @dots{})))
3192 @end smallexample
3194 @cindex @code{tst@var{m}} instruction pattern
3195 @item @samp{tst@var{m}}
3196 Compare operand 0 against zero, and set the condition codes.
3197 The RTL pattern should look like this:
3199 @smallexample
3200 (set (cc0) (match_operand:@var{m} 0 @dots{}))
3201 @end smallexample
3203 @samp{tst@var{m}} patterns should not be defined for machines that do
3204 not use @code{(cc0)}.  Doing so would confuse the optimizer since it
3205 would no longer be clear which @code{set} operations were comparisons.
3206 The @samp{cmp@var{m}} patterns should be used instead.
3208 @cindex @code{movmem@var{m}} instruction pattern
3209 @item @samp{movmem@var{m}}
3210 Block move instruction.  The destination and source blocks of memory
3211 are the first two operands, and both are @code{mem:BLK}s with an
3212 address in mode @code{Pmode}.
3214 The number of bytes to move is the third operand, in mode @var{m}.
3215 Usually, you specify @code{word_mode} for @var{m}.  However, if you can
3216 generate better code knowing the range of valid lengths is smaller than
3217 those representable in a full word, you should provide a pattern with a
3218 mode corresponding to the range of values you can handle efficiently
3219 (e.g., @code{QImode} for values in the range 0--127; note we avoid numbers
3220 that appear negative) and also a pattern with @code{word_mode}.
3222 The fourth operand is the known shared alignment of the source and
3223 destination, in the form of a @code{const_int} rtx.  Thus, if the
3224 compiler knows that both source and destination are word-aligned,
3225 it may provide the value 4 for this operand.
3227 Descriptions of multiple @code{movmem@var{m}} patterns can only be
3228 beneficial if the patterns for smaller modes have fewer restrictions
3229 on their first, second and fourth operands.  Note that the mode @var{m}
3230 in @code{movmem@var{m}} does not impose any restriction on the mode of
3231 individually moved data units in the block.
3233 These patterns need not give special consideration to the possibility
3234 that the source and destination strings might overlap.
3236 @cindex @code{movstr} instruction pattern
3237 @item @samp{movstr}
3238 String copy instruction, with @code{stpcpy} semantics.  Operand 0 is
3239 an output operand in mode @code{Pmode}.  The addresses of the
3240 destination and source strings are operands 1 and 2, and both are
3241 @code{mem:BLK}s with addresses in mode @code{Pmode}.  The execution of
3242 the expansion of this pattern should store in operand 0 the address in
3243 which the @code{NUL} terminator was stored in the destination string.
3245 @cindex @code{clrmem@var{m}} instruction pattern
3246 @item @samp{clrmem@var{m}}
3247 Block clear instruction.  The destination string is the first operand,
3248 given as a @code{mem:BLK} whose address is in mode @code{Pmode}.  The
3249 number of bytes to clear is the second operand, in mode @var{m}.  See
3250 @samp{movmem@var{m}} for a discussion of the choice of mode.
3252 The third operand is the known alignment of the destination, in the form
3253 of a @code{const_int} rtx.  Thus, if the compiler knows that the
3254 destination is word-aligned, it may provide the value 4 for this
3255 operand.
3257 The use for multiple @code{clrmem@var{m}} is as for @code{movmem@var{m}}.
3259 @cindex @code{cmpstr@var{m}} instruction pattern
3260 @item @samp{cmpstr@var{m}}
3261 String compare instruction, with five operands.  Operand 0 is the output;
3262 it has mode @var{m}.  The remaining four operands are like the operands
3263 of @samp{movmem@var{m}}.  The two memory blocks specified are compared
3264 byte by byte in lexicographic order starting at the beginning of each
3265 string.  The instruction is not allowed to prefetch more than one byte
3266 at a time since either string may end in the first byte and reading past
3267 that may access an invalid page or segment and cause a fault.  The
3268 effect of the instruction is to store a value in operand 0 whose sign
3269 indicates the result of the comparison.
3271 @cindex @code{cmpmem@var{m}} instruction pattern
3272 @item @samp{cmpmem@var{m}}
3273 Block compare instruction, with five operands like the operands
3274 of @samp{cmpstr@var{m}}.  The two memory blocks specified are compared
3275 byte by byte in lexicographic order starting at the beginning of each
3276 block.  Unlike @samp{cmpstr@var{m}} the instruction can prefetch
3277 any bytes in the two memory blocks.  The effect of the instruction is
3278 to store a value in operand 0 whose sign indicates the result of the
3279 comparison.
3281 @cindex @code{strlen@var{m}} instruction pattern
3282 @item @samp{strlen@var{m}}
3283 Compute the length of a string, with three operands.
3284 Operand 0 is the result (of mode @var{m}), operand 1 is
3285 a @code{mem} referring to the first character of the string,
3286 operand 2 is the character to search for (normally zero),
3287 and operand 3 is a constant describing the known alignment
3288 of the beginning of the string.
3290 @cindex @code{float@var{mn}2} instruction pattern
3291 @item @samp{float@var{m}@var{n}2}
3292 Convert signed integer operand 1 (valid for fixed point mode @var{m}) to
3293 floating point mode @var{n} and store in operand 0 (which has mode
3294 @var{n}).
3296 @cindex @code{floatuns@var{mn}2} instruction pattern
3297 @item @samp{floatuns@var{m}@var{n}2}
3298 Convert unsigned integer operand 1 (valid for fixed point mode @var{m})
3299 to floating point mode @var{n} and store in operand 0 (which has mode
3300 @var{n}).
3302 @cindex @code{fix@var{mn}2} instruction pattern
3303 @item @samp{fix@var{m}@var{n}2}
3304 Convert operand 1 (valid for floating point mode @var{m}) to fixed
3305 point mode @var{n} as a signed number and store in operand 0 (which
3306 has mode @var{n}).  This instruction's result is defined only when
3307 the value of operand 1 is an integer.
3309 If the machine description defines this pattern, it also needs to
3310 define the @code{ftrunc} pattern.
3312 @cindex @code{fixuns@var{mn}2} instruction pattern
3313 @item @samp{fixuns@var{m}@var{n}2}
3314 Convert operand 1 (valid for floating point mode @var{m}) to fixed
3315 point mode @var{n} as an unsigned number and store in operand 0 (which
3316 has mode @var{n}).  This instruction's result is defined only when the
3317 value of operand 1 is an integer.
3319 @cindex @code{ftrunc@var{m}2} instruction pattern
3320 @item @samp{ftrunc@var{m}2}
3321 Convert operand 1 (valid for floating point mode @var{m}) to an
3322 integer value, still represented in floating point mode @var{m}, and
3323 store it in operand 0 (valid for floating point mode @var{m}).
3325 @cindex @code{fix_trunc@var{mn}2} instruction pattern
3326 @item @samp{fix_trunc@var{m}@var{n}2}
3327 Like @samp{fix@var{m}@var{n}2} but works for any floating point value
3328 of mode @var{m} by converting the value to an integer.
3330 @cindex @code{fixuns_trunc@var{mn}2} instruction pattern
3331 @item @samp{fixuns_trunc@var{m}@var{n}2}
3332 Like @samp{fixuns@var{m}@var{n}2} but works for any floating point
3333 value of mode @var{m} by converting the value to an integer.
3335 @cindex @code{trunc@var{mn}2} instruction pattern
3336 @item @samp{trunc@var{m}@var{n}2}
3337 Truncate operand 1 (valid for mode @var{m}) to mode @var{n} and
3338 store in operand 0 (which has mode @var{n}).  Both modes must be fixed
3339 point or both floating point.
3341 @cindex @code{extend@var{mn}2} instruction pattern
3342 @item @samp{extend@var{m}@var{n}2}
3343 Sign-extend operand 1 (valid for mode @var{m}) to mode @var{n} and
3344 store in operand 0 (which has mode @var{n}).  Both modes must be fixed
3345 point or both floating point.
3347 @cindex @code{zero_extend@var{mn}2} instruction pattern
3348 @item @samp{zero_extend@var{m}@var{n}2}
3349 Zero-extend operand 1 (valid for mode @var{m}) to mode @var{n} and
3350 store in operand 0 (which has mode @var{n}).  Both modes must be fixed
3351 point.
3353 @cindex @code{extv} instruction pattern
3354 @item @samp{extv}
3355 Extract a bit-field from operand 1 (a register or memory operand), where
3356 operand 2 specifies the width in bits and operand 3 the starting bit,
3357 and store it in operand 0.  Operand 0 must have mode @code{word_mode}.
3358 Operand 1 may have mode @code{byte_mode} or @code{word_mode}; often
3359 @code{word_mode} is allowed only for registers.  Operands 2 and 3 must
3360 be valid for @code{word_mode}.
3362 The RTL generation pass generates this instruction only with constants
3363 for operands 2 and 3.
3365 The bit-field value is sign-extended to a full word integer
3366 before it is stored in operand 0.
3368 @cindex @code{extzv} instruction pattern
3369 @item @samp{extzv}
3370 Like @samp{extv} except that the bit-field value is zero-extended.
3372 @cindex @code{insv} instruction pattern
3373 @item @samp{insv}
3374 Store operand 3 (which must be valid for @code{word_mode}) into a
3375 bit-field in operand 0, where operand 1 specifies the width in bits and
3376 operand 2 the starting bit.  Operand 0 may have mode @code{byte_mode} or
3377 @code{word_mode}; often @code{word_mode} is allowed only for registers.
3378 Operands 1 and 2 must be valid for @code{word_mode}.
3380 The RTL generation pass generates this instruction only with constants
3381 for operands 1 and 2.
3383 @cindex @code{mov@var{mode}cc} instruction pattern
3384 @item @samp{mov@var{mode}cc}
3385 Conditionally move operand 2 or operand 3 into operand 0 according to the
3386 comparison in operand 1.  If the comparison is true, operand 2 is moved
3387 into operand 0, otherwise operand 3 is moved.
3389 The mode of the operands being compared need not be the same as the operands
3390 being moved.  Some machines, sparc64 for example, have instructions that
3391 conditionally move an integer value based on the floating point condition
3392 codes and vice versa.
3394 If the machine does not have conditional move instructions, do not
3395 define these patterns.
3397 @cindex @code{add@var{mode}cc} instruction pattern
3398 @item @samp{add@var{mode}cc}
3399 Similar to @samp{mov@var{mode}cc} but for conditional addition.  Conditionally
3400 move operand 2 or (operands 2 + operand 3) into operand 0 according to the
3401 comparison in operand 1.  If the comparison is true, operand 2 is moved into
3402 operand 0, otherwise (operand 2 + operand 3) is moved.
3404 @cindex @code{s@var{cond}} instruction pattern
3405 @item @samp{s@var{cond}}
3406 Store zero or nonzero in the operand according to the condition codes.
3407 Value stored is nonzero iff the condition @var{cond} is true.
3408 @var{cond} is the name of a comparison operation expression code, such
3409 as @code{eq}, @code{lt} or @code{leu}.
3411 You specify the mode that the operand must have when you write the
3412 @code{match_operand} expression.  The compiler automatically sees
3413 which mode you have used and supplies an operand of that mode.
3415 The value stored for a true condition must have 1 as its low bit, or
3416 else must be negative.  Otherwise the instruction is not suitable and
3417 you should omit it from the machine description.  You describe to the
3418 compiler exactly which value is stored by defining the macro
3419 @code{STORE_FLAG_VALUE} (@pxref{Misc}).  If a description cannot be
3420 found that can be used for all the @samp{s@var{cond}} patterns, you
3421 should omit those operations from the machine description.
3423 These operations may fail, but should do so only in relatively
3424 uncommon cases; if they would fail for common cases involving
3425 integer comparisons, it is best to omit these patterns.
3427 If these operations are omitted, the compiler will usually generate code
3428 that copies the constant one to the target and branches around an
3429 assignment of zero to the target.  If this code is more efficient than
3430 the potential instructions used for the @samp{s@var{cond}} pattern
3431 followed by those required to convert the result into a 1 or a zero in
3432 @code{SImode}, you should omit the @samp{s@var{cond}} operations from
3433 the machine description.
3435 @cindex @code{b@var{cond}} instruction pattern
3436 @item @samp{b@var{cond}}
3437 Conditional branch instruction.  Operand 0 is a @code{label_ref} that
3438 refers to the label to jump to.  Jump if the condition codes meet
3439 condition @var{cond}.
3441 Some machines do not follow the model assumed here where a comparison
3442 instruction is followed by a conditional branch instruction.  In that
3443 case, the @samp{cmp@var{m}} (and @samp{tst@var{m}}) patterns should
3444 simply store the operands away and generate all the required insns in a
3445 @code{define_expand} (@pxref{Expander Definitions}) for the conditional
3446 branch operations.  All calls to expand @samp{b@var{cond}} patterns are
3447 immediately preceded by calls to expand either a @samp{cmp@var{m}}
3448 pattern or a @samp{tst@var{m}} pattern.
3450 Machines that use a pseudo register for the condition code value, or
3451 where the mode used for the comparison depends on the condition being
3452 tested, should also use the above mechanism.  @xref{Jump Patterns}.
3454 The above discussion also applies to the @samp{mov@var{mode}cc} and
3455 @samp{s@var{cond}} patterns.
3457 @cindex @code{cbranch@var{mode}4} instruction pattern
3458 @item @samp{cbranch@var{mode}4}
3459 Conditional branch instruction combined with a compare instruction.
3460 Operand 0 is a comparison operator.  Operand 1 and operand 2 are the
3461 first and second operands of the comparison, respectively.  Operand 3
3462 is a @code{label_ref} that refers to the label to jump to.
3464 @cindex @code{jump} instruction pattern
3465 @item @samp{jump}
3466 A jump inside a function; an unconditional branch.  Operand 0 is the
3467 @code{label_ref} of the label to jump to.  This pattern name is mandatory
3468 on all machines.
3470 @cindex @code{call} instruction pattern
3471 @item @samp{call}
3472 Subroutine call instruction returning no value.  Operand 0 is the
3473 function to call; operand 1 is the number of bytes of arguments pushed
3474 as a @code{const_int}; operand 2 is the number of registers used as
3475 operands.
3477 On most machines, operand 2 is not actually stored into the RTL
3478 pattern.  It is supplied for the sake of some RISC machines which need
3479 to put this information into the assembler code; they can put it in
3480 the RTL instead of operand 1.
3482 Operand 0 should be a @code{mem} RTX whose address is the address of the
3483 function.  Note, however, that this address can be a @code{symbol_ref}
3484 expression even if it would not be a legitimate memory address on the
3485 target machine.  If it is also not a valid argument for a call
3486 instruction, the pattern for this operation should be a
3487 @code{define_expand} (@pxref{Expander Definitions}) that places the
3488 address into a register and uses that register in the call instruction.
3490 @cindex @code{call_value} instruction pattern
3491 @item @samp{call_value}
3492 Subroutine call instruction returning a value.  Operand 0 is the hard
3493 register in which the value is returned.  There are three more
3494 operands, the same as the three operands of the @samp{call}
3495 instruction (but with numbers increased by one).
3497 Subroutines that return @code{BLKmode} objects use the @samp{call}
3498 insn.
3500 @cindex @code{call_pop} instruction pattern
3501 @cindex @code{call_value_pop} instruction pattern
3502 @item @samp{call_pop}, @samp{call_value_pop}
3503 Similar to @samp{call} and @samp{call_value}, except used if defined and
3504 if @code{RETURN_POPS_ARGS} is nonzero.  They should emit a @code{parallel}
3505 that contains both the function call and a @code{set} to indicate the
3506 adjustment made to the frame pointer.
3508 For machines where @code{RETURN_POPS_ARGS} can be nonzero, the use of these
3509 patterns increases the number of functions for which the frame pointer
3510 can be eliminated, if desired.
3512 @cindex @code{untyped_call} instruction pattern
3513 @item @samp{untyped_call}
3514 Subroutine call instruction returning a value of any type.  Operand 0 is
3515 the function to call; operand 1 is a memory location where the result of
3516 calling the function is to be stored; operand 2 is a @code{parallel}
3517 expression where each element is a @code{set} expression that indicates
3518 the saving of a function return value into the result block.
3520 This instruction pattern should be defined to support
3521 @code{__builtin_apply} on machines where special instructions are needed
3522 to call a subroutine with arbitrary arguments or to save the value
3523 returned.  This instruction pattern is required on machines that have
3524 multiple registers that can hold a return value
3525 (i.e.@: @code{FUNCTION_VALUE_REGNO_P} is true for more than one register).
3527 @cindex @code{return} instruction pattern
3528 @item @samp{return}
3529 Subroutine return instruction.  This instruction pattern name should be
3530 defined only if a single instruction can do all the work of returning
3531 from a function.
3533 Like the @samp{mov@var{m}} patterns, this pattern is also used after the
3534 RTL generation phase.  In this case it is to support machines where
3535 multiple instructions are usually needed to return from a function, but
3536 some class of functions only requires one instruction to implement a
3537 return.  Normally, the applicable functions are those which do not need
3538 to save any registers or allocate stack space.
3540 @findex reload_completed
3541 @findex leaf_function_p
3542 For such machines, the condition specified in this pattern should only
3543 be true when @code{reload_completed} is nonzero and the function's
3544 epilogue would only be a single instruction.  For machines with register
3545 windows, the routine @code{leaf_function_p} may be used to determine if
3546 a register window push is required.
3548 Machines that have conditional return instructions should define patterns
3549 such as
3551 @smallexample
3552 (define_insn ""
3553   [(set (pc)
3554         (if_then_else (match_operator
3555                          0 "comparison_operator"
3556                          [(cc0) (const_int 0)])
3557                       (return)
3558                       (pc)))]
3559   "@var{condition}"
3560   "@dots{}")
3561 @end smallexample
3563 where @var{condition} would normally be the same condition specified on the
3564 named @samp{return} pattern.
3566 @cindex @code{untyped_return} instruction pattern
3567 @item @samp{untyped_return}
3568 Untyped subroutine return instruction.  This instruction pattern should
3569 be defined to support @code{__builtin_return} on machines where special
3570 instructions are needed to return a value of any type.
3572 Operand 0 is a memory location where the result of calling a function
3573 with @code{__builtin_apply} is stored; operand 1 is a @code{parallel}
3574 expression where each element is a @code{set} expression that indicates
3575 the restoring of a function return value from the result block.
3577 @cindex @code{nop} instruction pattern
3578 @item @samp{nop}
3579 No-op instruction.  This instruction pattern name should always be defined
3580 to output a no-op in assembler code.  @code{(const_int 0)} will do as an
3581 RTL pattern.
3583 @cindex @code{indirect_jump} instruction pattern
3584 @item @samp{indirect_jump}
3585 An instruction to jump to an address which is operand zero.
3586 This pattern name is mandatory on all machines.
3588 @cindex @code{casesi} instruction pattern
3589 @item @samp{casesi}
3590 Instruction to jump through a dispatch table, including bounds checking.
3591 This instruction takes five operands:
3593 @enumerate
3594 @item
3595 The index to dispatch on, which has mode @code{SImode}.
3597 @item
3598 The lower bound for indices in the table, an integer constant.
3600 @item
3601 The total range of indices in the table---the largest index
3602 minus the smallest one (both inclusive).
3604 @item
3605 A label that precedes the table itself.
3607 @item
3608 A label to jump to if the index has a value outside the bounds.
3609 @end enumerate
3611 The table is a @code{addr_vec} or @code{addr_diff_vec} inside of a
3612 @code{jump_insn}.  The number of elements in the table is one plus the
3613 difference between the upper bound and the lower bound.
3615 @cindex @code{tablejump} instruction pattern
3616 @item @samp{tablejump}
3617 Instruction to jump to a variable address.  This is a low-level
3618 capability which can be used to implement a dispatch table when there
3619 is no @samp{casesi} pattern.
3621 This pattern requires two operands: the address or offset, and a label
3622 which should immediately precede the jump table.  If the macro
3623 @code{CASE_VECTOR_PC_RELATIVE} evaluates to a nonzero value then the first
3624 operand is an offset which counts from the address of the table; otherwise,
3625 it is an absolute address to jump to.  In either case, the first operand has
3626 mode @code{Pmode}.
3628 The @samp{tablejump} insn is always the last insn before the jump
3629 table it uses.  Its assembler code normally has no need to use the
3630 second operand, but you should incorporate it in the RTL pattern so
3631 that the jump optimizer will not delete the table as unreachable code.
3634 @cindex @code{decrement_and_branch_until_zero} instruction pattern
3635 @item @samp{decrement_and_branch_until_zero}
3636 Conditional branch instruction that decrements a register and
3637 jumps if the register is nonzero.  Operand 0 is the register to
3638 decrement and test; operand 1 is the label to jump to if the
3639 register is nonzero.  @xref{Looping Patterns}.
3641 This optional instruction pattern is only used by the combiner,
3642 typically for loops reversed by the loop optimizer when strength
3643 reduction is enabled.
3645 @cindex @code{doloop_end} instruction pattern
3646 @item @samp{doloop_end}
3647 Conditional branch instruction that decrements a register and jumps if
3648 the register is nonzero.  This instruction takes five operands: Operand
3649 0 is the register to decrement and test; operand 1 is the number of loop
3650 iterations as a @code{const_int} or @code{const0_rtx} if this cannot be
3651 determined until run-time; operand 2 is the actual or estimated maximum
3652 number of iterations as a @code{const_int}; operand 3 is the number of
3653 enclosed loops as a @code{const_int} (an innermost loop has a value of
3654 1); operand 4 is the label to jump to if the register is nonzero.
3655 @xref{Looping Patterns}.
3657 This optional instruction pattern should be defined for machines with
3658 low-overhead looping instructions as the loop optimizer will try to
3659 modify suitable loops to utilize it.  If nested low-overhead looping is
3660 not supported, use a @code{define_expand} (@pxref{Expander Definitions})
3661 and make the pattern fail if operand 3 is not @code{const1_rtx}.
3662 Similarly, if the actual or estimated maximum number of iterations is
3663 too large for this instruction, make it fail.
3665 @cindex @code{doloop_begin} instruction pattern
3666 @item @samp{doloop_begin}
3667 Companion instruction to @code{doloop_end} required for machines that
3668 need to perform some initialization, such as loading special registers
3669 used by a low-overhead looping instruction.  If initialization insns do
3670 not always need to be emitted, use a @code{define_expand}
3671 (@pxref{Expander Definitions}) and make it fail.
3674 @cindex @code{canonicalize_funcptr_for_compare} instruction pattern
3675 @item @samp{canonicalize_funcptr_for_compare}
3676 Canonicalize the function pointer in operand 1 and store the result
3677 into operand 0.
3679 Operand 0 is always a @code{reg} and has mode @code{Pmode}; operand 1
3680 may be a @code{reg}, @code{mem}, @code{symbol_ref}, @code{const_int}, etc
3681 and also has mode @code{Pmode}.
3683 Canonicalization of a function pointer usually involves computing
3684 the address of the function which would be called if the function
3685 pointer were used in an indirect call.
3687 Only define this pattern if function pointers on the target machine
3688 can have different values but still call the same function when
3689 used in an indirect call.
3691 @cindex @code{save_stack_block} instruction pattern
3692 @cindex @code{save_stack_function} instruction pattern
3693 @cindex @code{save_stack_nonlocal} instruction pattern
3694 @cindex @code{restore_stack_block} instruction pattern
3695 @cindex @code{restore_stack_function} instruction pattern
3696 @cindex @code{restore_stack_nonlocal} instruction pattern
3697 @item @samp{save_stack_block}
3698 @itemx @samp{save_stack_function}
3699 @itemx @samp{save_stack_nonlocal}
3700 @itemx @samp{restore_stack_block}
3701 @itemx @samp{restore_stack_function}
3702 @itemx @samp{restore_stack_nonlocal}
3703 Most machines save and restore the stack pointer by copying it to or
3704 from an object of mode @code{Pmode}.  Do not define these patterns on
3705 such machines.
3707 Some machines require special handling for stack pointer saves and
3708 restores.  On those machines, define the patterns corresponding to the
3709 non-standard cases by using a @code{define_expand} (@pxref{Expander
3710 Definitions}) that produces the required insns.  The three types of
3711 saves and restores are:
3713 @enumerate
3714 @item
3715 @samp{save_stack_block} saves the stack pointer at the start of a block
3716 that allocates a variable-sized object, and @samp{restore_stack_block}
3717 restores the stack pointer when the block is exited.
3719 @item
3720 @samp{save_stack_function} and @samp{restore_stack_function} do a
3721 similar job for the outermost block of a function and are used when the
3722 function allocates variable-sized objects or calls @code{alloca}.  Only
3723 the epilogue uses the restored stack pointer, allowing a simpler save or
3724 restore sequence on some machines.
3726 @item
3727 @samp{save_stack_nonlocal} is used in functions that contain labels
3728 branched to by nested functions.  It saves the stack pointer in such a
3729 way that the inner function can use @samp{restore_stack_nonlocal} to
3730 restore the stack pointer.  The compiler generates code to restore the
3731 frame and argument pointer registers, but some machines require saving
3732 and restoring additional data such as register window information or
3733 stack backchains.  Place insns in these patterns to save and restore any
3734 such required data.
3735 @end enumerate
3737 When saving the stack pointer, operand 0 is the save area and operand 1
3738 is the stack pointer.  The mode used to allocate the save area defaults
3739 to @code{Pmode} but you can override that choice by defining the
3740 @code{STACK_SAVEAREA_MODE} macro (@pxref{Storage Layout}).  You must
3741 specify an integral mode, or @code{VOIDmode} if no save area is needed
3742 for a particular type of save (either because no save is needed or
3743 because a machine-specific save area can be used).  Operand 0 is the
3744 stack pointer and operand 1 is the save area for restore operations.  If
3745 @samp{save_stack_block} is defined, operand 0 must not be
3746 @code{VOIDmode} since these saves can be arbitrarily nested.
3748 A save area is a @code{mem} that is at a constant offset from
3749 @code{virtual_stack_vars_rtx} when the stack pointer is saved for use by
3750 nonlocal gotos and a @code{reg} in the other two cases.
3752 @cindex @code{allocate_stack} instruction pattern
3753 @item @samp{allocate_stack}
3754 Subtract (or add if @code{STACK_GROWS_DOWNWARD} is undefined) operand 1 from
3755 the stack pointer to create space for dynamically allocated data.
3757 Store the resultant pointer to this space into operand 0.  If you
3758 are allocating space from the main stack, do this by emitting a
3759 move insn to copy @code{virtual_stack_dynamic_rtx} to operand 0.
3760 If you are allocating the space elsewhere, generate code to copy the
3761 location of the space to operand 0.  In the latter case, you must
3762 ensure this space gets freed when the corresponding space on the main
3763 stack is free.
3765 Do not define this pattern if all that must be done is the subtraction.
3766 Some machines require other operations such as stack probes or
3767 maintaining the back chain.  Define this pattern to emit those
3768 operations in addition to updating the stack pointer.
3770 @cindex @code{check_stack} instruction pattern
3771 @item @samp{check_stack}
3772 If stack checking cannot be done on your system by probing the stack with
3773 a load or store instruction (@pxref{Stack Checking}), define this pattern
3774 to perform the needed check and signaling an error if the stack
3775 has overflowed.  The single operand is the location in the stack furthest
3776 from the current stack pointer that you need to validate.  Normally,
3777 on machines where this pattern is needed, you would obtain the stack
3778 limit from a global or thread-specific variable or register.
3780 @cindex @code{nonlocal_goto} instruction pattern
3781 @item @samp{nonlocal_goto}
3782 Emit code to generate a non-local goto, e.g., a jump from one function
3783 to a label in an outer function.  This pattern has four arguments,
3784 each representing a value to be used in the jump.  The first
3785 argument is to be loaded into the frame pointer, the second is
3786 the address to branch to (code to dispatch to the actual label),
3787 the third is the address of a location where the stack is saved,
3788 and the last is the address of the label, to be placed in the
3789 location for the incoming static chain.
3791 On most machines you need not define this pattern, since GCC will
3792 already generate the correct code, which is to load the frame pointer
3793 and static chain, restore the stack (using the
3794 @samp{restore_stack_nonlocal} pattern, if defined), and jump indirectly
3795 to the dispatcher.  You need only define this pattern if this code will
3796 not work on your machine.
3798 @cindex @code{nonlocal_goto_receiver} instruction pattern
3799 @item @samp{nonlocal_goto_receiver}
3800 This pattern, if defined, contains code needed at the target of a
3801 nonlocal goto after the code already generated by GCC@.  You will not
3802 normally need to define this pattern.  A typical reason why you might
3803 need this pattern is if some value, such as a pointer to a global table,
3804 must be restored when the frame pointer is restored.  Note that a nonlocal
3805 goto only occurs within a unit-of-translation, so a global table pointer
3806 that is shared by all functions of a given module need not be restored.
3807 There are no arguments.
3809 @cindex @code{exception_receiver} instruction pattern
3810 @item @samp{exception_receiver}
3811 This pattern, if defined, contains code needed at the site of an
3812 exception handler that isn't needed at the site of a nonlocal goto.  You
3813 will not normally need to define this pattern.  A typical reason why you
3814 might need this pattern is if some value, such as a pointer to a global
3815 table, must be restored after control flow is branched to the handler of
3816 an exception.  There are no arguments.
3818 @cindex @code{builtin_setjmp_setup} instruction pattern
3819 @item @samp{builtin_setjmp_setup}
3820 This pattern, if defined, contains additional code needed to initialize
3821 the @code{jmp_buf}.  You will not normally need to define this pattern.
3822 A typical reason why you might need this pattern is if some value, such
3823 as a pointer to a global table, must be restored.  Though it is
3824 preferred that the pointer value be recalculated if possible (given the
3825 address of a label for instance).  The single argument is a pointer to
3826 the @code{jmp_buf}.  Note that the buffer is five words long and that
3827 the first three are normally used by the generic mechanism.
3829 @cindex @code{builtin_setjmp_receiver} instruction pattern
3830 @item @samp{builtin_setjmp_receiver}
3831 This pattern, if defined, contains code needed at the site of an
3832 built-in setjmp that isn't needed at the site of a nonlocal goto.  You
3833 will not normally need to define this pattern.  A typical reason why you
3834 might need this pattern is if some value, such as a pointer to a global
3835 table, must be restored.  It takes one argument, which is the label
3836 to which builtin_longjmp transfered control; this pattern may be emitted
3837 at a small offset from that label.
3839 @cindex @code{builtin_longjmp} instruction pattern
3840 @item @samp{builtin_longjmp}
3841 This pattern, if defined, performs the entire action of the longjmp.
3842 You will not normally need to define this pattern unless you also define
3843 @code{builtin_setjmp_setup}.  The single argument is a pointer to the
3844 @code{jmp_buf}.
3846 @cindex @code{eh_return} instruction pattern
3847 @item @samp{eh_return}
3848 This pattern, if defined, affects the way @code{__builtin_eh_return},
3849 and thence the call frame exception handling library routines, are
3850 built.  It is intended to handle non-trivial actions needed along
3851 the abnormal return path.
3853 The address of the exception handler to which the function should return
3854 is passed as operand to this pattern.  It will normally need to copied by
3855 the pattern to some special register or memory location.
3856 If the pattern needs to determine the location of the target call
3857 frame in order to do so, it may use @code{EH_RETURN_STACKADJ_RTX},
3858 if defined; it will have already been assigned.
3860 If this pattern is not defined, the default action will be to simply
3861 copy the return address to @code{EH_RETURN_HANDLER_RTX}.  Either
3862 that macro or this pattern needs to be defined if call frame exception
3863 handling is to be used.
3865 @cindex @code{prologue} instruction pattern
3866 @anchor{prologue instruction pattern}
3867 @item @samp{prologue}
3868 This pattern, if defined, emits RTL for entry to a function.  The function
3869 entry is responsible for setting up the stack frame, initializing the frame
3870 pointer register, saving callee saved registers, etc.
3872 Using a prologue pattern is generally preferred over defining
3873 @code{TARGET_ASM_FUNCTION_PROLOGUE} to emit assembly code for the prologue.
3875 The @code{prologue} pattern is particularly useful for targets which perform
3876 instruction scheduling.
3878 @cindex @code{epilogue} instruction pattern
3879 @anchor{epilogue instruction pattern}
3880 @item @samp{epilogue}
3881 This pattern emits RTL for exit from a function.  The function
3882 exit is responsible for deallocating the stack frame, restoring callee saved
3883 registers and emitting the return instruction.
3885 Using an epilogue pattern is generally preferred over defining
3886 @code{TARGET_ASM_FUNCTION_EPILOGUE} to emit assembly code for the epilogue.
3888 The @code{epilogue} pattern is particularly useful for targets which perform
3889 instruction scheduling or which have delay slots for their return instruction.
3891 @cindex @code{sibcall_epilogue} instruction pattern
3892 @item @samp{sibcall_epilogue}
3893 This pattern, if defined, emits RTL for exit from a function without the final
3894 branch back to the calling function.  This pattern will be emitted before any
3895 sibling call (aka tail call) sites.
3897 The @code{sibcall_epilogue} pattern must not clobber any arguments used for
3898 parameter passing or any stack slots for arguments passed to the current
3899 function.
3901 @cindex @code{trap} instruction pattern
3902 @item @samp{trap}
3903 This pattern, if defined, signals an error, typically by causing some
3904 kind of signal to be raised.  Among other places, it is used by the Java
3905 front end to signal `invalid array index' exceptions.
3907 @cindex @code{conditional_trap} instruction pattern
3908 @item @samp{conditional_trap}
3909 Conditional trap instruction.  Operand 0 is a piece of RTL which
3910 performs a comparison.  Operand 1 is the trap code, an integer.
3912 A typical @code{conditional_trap} pattern looks like
3914 @smallexample
3915 (define_insn "conditional_trap"
3916   [(trap_if (match_operator 0 "trap_operator"
3917              [(cc0) (const_int 0)])
3918             (match_operand 1 "const_int_operand" "i"))]
3919   ""
3920   "@dots{}")
3921 @end smallexample
3923 @cindex @code{prefetch} instruction pattern
3924 @item @samp{prefetch}
3926 This pattern, if defined, emits code for a non-faulting data prefetch
3927 instruction.  Operand 0 is the address of the memory to prefetch.  Operand 1
3928 is a constant 1 if the prefetch is preparing for a write to the memory
3929 address, or a constant 0 otherwise.  Operand 2 is the expected degree of
3930 temporal locality of the data and is a value between 0 and 3, inclusive; 0
3931 means that the data has no temporal locality, so it need not be left in the
3932 cache after the access; 3 means that the data has a high degree of temporal
3933 locality and should be left in all levels of cache possible;  1 and 2 mean,
3934 respectively, a low or moderate degree of temporal locality.
3936 Targets that do not support write prefetches or locality hints can ignore
3937 the values of operands 1 and 2.
3939 @end table
3941 @end ifset
3942 @c Each of the following nodes are wrapped in separate
3943 @c "@ifset INTERNALS" to work around memory limits for the default
3944 @c configuration in older tetex distributions.  Known to not work:
3945 @c tetex-1.0.7, known to work: tetex-2.0.2.
3946 @ifset INTERNALS
3947 @node Pattern Ordering
3948 @section When the Order of Patterns Matters
3949 @cindex Pattern Ordering
3950 @cindex Ordering of Patterns
3952 Sometimes an insn can match more than one instruction pattern.  Then the
3953 pattern that appears first in the machine description is the one used.
3954 Therefore, more specific patterns (patterns that will match fewer things)
3955 and faster instructions (those that will produce better code when they
3956 do match) should usually go first in the description.
3958 In some cases the effect of ordering the patterns can be used to hide
3959 a pattern when it is not valid.  For example, the 68000 has an
3960 instruction for converting a fullword to floating point and another
3961 for converting a byte to floating point.  An instruction converting
3962 an integer to floating point could match either one.  We put the
3963 pattern to convert the fullword first to make sure that one will
3964 be used rather than the other.  (Otherwise a large integer might
3965 be generated as a single-byte immediate quantity, which would not work.)
3966 Instead of using this pattern ordering it would be possible to make the
3967 pattern for convert-a-byte smart enough to deal properly with any
3968 constant value.
3970 @end ifset
3971 @ifset INTERNALS
3972 @node Dependent Patterns
3973 @section Interdependence of Patterns
3974 @cindex Dependent Patterns
3975 @cindex Interdependence of Patterns
3977 Every machine description must have a named pattern for each of the
3978 conditional branch names @samp{b@var{cond}}.  The recognition template
3979 must always have the form
3981 @smallexample
3982 (set (pc)
3983      (if_then_else (@var{cond} (cc0) (const_int 0))
3984                    (label_ref (match_operand 0 "" ""))
3985                    (pc)))
3986 @end smallexample
3988 @noindent
3989 In addition, every machine description must have an anonymous pattern
3990 for each of the possible reverse-conditional branches.  Their templates
3991 look like
3993 @smallexample
3994 (set (pc)
3995      (if_then_else (@var{cond} (cc0) (const_int 0))
3996                    (pc)
3997                    (label_ref (match_operand 0 "" ""))))
3998 @end smallexample
4000 @noindent
4001 They are necessary because jump optimization can turn direct-conditional
4002 branches into reverse-conditional branches.
4004 It is often convenient to use the @code{match_operator} construct to
4005 reduce the number of patterns that must be specified for branches.  For
4006 example,
4008 @smallexample
4009 (define_insn ""
4010   [(set (pc)
4011         (if_then_else (match_operator 0 "comparison_operator"
4012                                       [(cc0) (const_int 0)])
4013                       (pc)
4014                       (label_ref (match_operand 1 "" ""))))]
4015   "@var{condition}"
4016   "@dots{}")
4017 @end smallexample
4019 In some cases machines support instructions identical except for the
4020 machine mode of one or more operands.  For example, there may be
4021 ``sign-extend halfword'' and ``sign-extend byte'' instructions whose
4022 patterns are
4024 @smallexample
4025 (set (match_operand:SI 0 @dots{})
4026      (extend:SI (match_operand:HI 1 @dots{})))
4028 (set (match_operand:SI 0 @dots{})
4029      (extend:SI (match_operand:QI 1 @dots{})))
4030 @end smallexample
4032 @noindent
4033 Constant integers do not specify a machine mode, so an instruction to
4034 extend a constant value could match either pattern.  The pattern it
4035 actually will match is the one that appears first in the file.  For correct
4036 results, this must be the one for the widest possible mode (@code{HImode},
4037 here).  If the pattern matches the @code{QImode} instruction, the results
4038 will be incorrect if the constant value does not actually fit that mode.
4040 Such instructions to extend constants are rarely generated because they are
4041 optimized away, but they do occasionally happen in nonoptimized
4042 compilations.
4044 If a constraint in a pattern allows a constant, the reload pass may
4045 replace a register with a constant permitted by the constraint in some
4046 cases.  Similarly for memory references.  Because of this substitution,
4047 you should not provide separate patterns for increment and decrement
4048 instructions.  Instead, they should be generated from the same pattern
4049 that supports register-register add insns by examining the operands and
4050 generating the appropriate machine instruction.
4052 @end ifset
4053 @ifset INTERNALS
4054 @node Jump Patterns
4055 @section Defining Jump Instruction Patterns
4056 @cindex jump instruction patterns
4057 @cindex defining jump instruction patterns
4059 For most machines, GCC assumes that the machine has a condition code.
4060 A comparison insn sets the condition code, recording the results of both
4061 signed and unsigned comparison of the given operands.  A separate branch
4062 insn tests the condition code and branches or not according its value.
4063 The branch insns come in distinct signed and unsigned flavors.  Many
4064 common machines, such as the VAX, the 68000 and the 32000, work this
4065 way.
4067 Some machines have distinct signed and unsigned compare instructions, and
4068 only one set of conditional branch instructions.  The easiest way to handle
4069 these machines is to treat them just like the others until the final stage
4070 where assembly code is written.  At this time, when outputting code for the
4071 compare instruction, peek ahead at the following branch using
4072 @code{next_cc0_user (insn)}.  (The variable @code{insn} refers to the insn
4073 being output, in the output-writing code in an instruction pattern.)  If
4074 the RTL says that is an unsigned branch, output an unsigned compare;
4075 otherwise output a signed compare.  When the branch itself is output, you
4076 can treat signed and unsigned branches identically.
4078 The reason you can do this is that GCC always generates a pair of
4079 consecutive RTL insns, possibly separated by @code{note} insns, one to
4080 set the condition code and one to test it, and keeps the pair inviolate
4081 until the end.
4083 To go with this technique, you must define the machine-description macro
4084 @code{NOTICE_UPDATE_CC} to do @code{CC_STATUS_INIT}; in other words, no
4085 compare instruction is superfluous.
4087 Some machines have compare-and-branch instructions and no condition code.
4088 A similar technique works for them.  When it is time to ``output'' a
4089 compare instruction, record its operands in two static variables.  When
4090 outputting the branch-on-condition-code instruction that follows, actually
4091 output a compare-and-branch instruction that uses the remembered operands.
4093 It also works to define patterns for compare-and-branch instructions.
4094 In optimizing compilation, the pair of compare and branch instructions
4095 will be combined according to these patterns.  But this does not happen
4096 if optimization is not requested.  So you must use one of the solutions
4097 above in addition to any special patterns you define.
4099 In many RISC machines, most instructions do not affect the condition
4100 code and there may not even be a separate condition code register.  On
4101 these machines, the restriction that the definition and use of the
4102 condition code be adjacent insns is not necessary and can prevent
4103 important optimizations.  For example, on the IBM RS/6000, there is a
4104 delay for taken branches unless the condition code register is set three
4105 instructions earlier than the conditional branch.  The instruction
4106 scheduler cannot perform this optimization if it is not permitted to
4107 separate the definition and use of the condition code register.
4109 On these machines, do not use @code{(cc0)}, but instead use a register
4110 to represent the condition code.  If there is a specific condition code
4111 register in the machine, use a hard register.  If the condition code or
4112 comparison result can be placed in any general register, or if there are
4113 multiple condition registers, use a pseudo register.
4115 @findex prev_cc0_setter
4116 @findex next_cc0_user
4117 On some machines, the type of branch instruction generated may depend on
4118 the way the condition code was produced; for example, on the 68k and
4119 SPARC, setting the condition code directly from an add or subtract
4120 instruction does not clear the overflow bit the way that a test
4121 instruction does, so a different branch instruction must be used for
4122 some conditional branches.  For machines that use @code{(cc0)}, the set
4123 and use of the condition code must be adjacent (separated only by
4124 @code{note} insns) allowing flags in @code{cc_status} to be used.
4125 (@xref{Condition Code}.)  Also, the comparison and branch insns can be
4126 located from each other by using the functions @code{prev_cc0_setter}
4127 and @code{next_cc0_user}.
4129 However, this is not true on machines that do not use @code{(cc0)}.  On
4130 those machines, no assumptions can be made about the adjacency of the
4131 compare and branch insns and the above methods cannot be used.  Instead,
4132 we use the machine mode of the condition code register to record
4133 different formats of the condition code register.
4135 Registers used to store the condition code value should have a mode that
4136 is in class @code{MODE_CC}.  Normally, it will be @code{CCmode}.  If
4137 additional modes are required (as for the add example mentioned above in
4138 the SPARC), define the macro @code{EXTRA_CC_MODES} to list the
4139 additional modes required (@pxref{Condition Code}).  Also define
4140 @code{SELECT_CC_MODE} to choose a mode given an operand of a compare.
4142 If it is known during RTL generation that a different mode will be
4143 required (for example, if the machine has separate compare instructions
4144 for signed and unsigned quantities, like most IBM processors), they can
4145 be specified at that time.
4147 If the cases that require different modes would be made by instruction
4148 combination, the macro @code{SELECT_CC_MODE} determines which machine
4149 mode should be used for the comparison result.  The patterns should be
4150 written using that mode.  To support the case of the add on the SPARC
4151 discussed above, we have the pattern
4153 @smallexample
4154 (define_insn ""
4155   [(set (reg:CC_NOOV 0)
4156         (compare:CC_NOOV
4157           (plus:SI (match_operand:SI 0 "register_operand" "%r")
4158                    (match_operand:SI 1 "arith_operand" "rI"))
4159           (const_int 0)))]
4160   ""
4161   "@dots{}")
4162 @end smallexample
4164 The @code{SELECT_CC_MODE} macro on the SPARC returns @code{CC_NOOVmode}
4165 for comparisons whose argument is a @code{plus}.
4167 @end ifset
4168 @ifset INTERNALS
4169 @node Looping Patterns
4170 @section Defining Looping Instruction Patterns
4171 @cindex looping instruction patterns
4172 @cindex defining looping instruction patterns
4174 Some machines have special jump instructions that can be utilized to
4175 make loops more efficient.  A common example is the 68000 @samp{dbra}
4176 instruction which performs a decrement of a register and a branch if the
4177 result was greater than zero.  Other machines, in particular digital
4178 signal processors (DSPs), have special block repeat instructions to
4179 provide low-overhead loop support.  For example, the TI TMS320C3x/C4x
4180 DSPs have a block repeat instruction that loads special registers to
4181 mark the top and end of a loop and to count the number of loop
4182 iterations.  This avoids the need for fetching and executing a
4183 @samp{dbra}-like instruction and avoids pipeline stalls associated with
4184 the jump.
4186 GCC has three special named patterns to support low overhead looping.
4187 They are @samp{decrement_and_branch_until_zero}, @samp{doloop_begin},
4188 and @samp{doloop_end}.  The first pattern,
4189 @samp{decrement_and_branch_until_zero}, is not emitted during RTL
4190 generation but may be emitted during the instruction combination phase.
4191 This requires the assistance of the loop optimizer, using information
4192 collected during strength reduction, to reverse a loop to count down to
4193 zero.  Some targets also require the loop optimizer to add a
4194 @code{REG_NONNEG} note to indicate that the iteration count is always
4195 positive.  This is needed if the target performs a signed loop
4196 termination test.  For example, the 68000 uses a pattern similar to the
4197 following for its @code{dbra} instruction:
4199 @smallexample
4200 @group
4201 (define_insn "decrement_and_branch_until_zero"
4202   [(set (pc)
4203         (if_then_else
4204           (ge (plus:SI (match_operand:SI 0 "general_operand" "+d*am")
4205                        (const_int -1))
4206               (const_int 0))
4207           (label_ref (match_operand 1 "" ""))
4208           (pc)))
4209    (set (match_dup 0)
4210         (plus:SI (match_dup 0)
4211                  (const_int -1)))]
4212   "find_reg_note (insn, REG_NONNEG, 0)"
4213   "@dots{}")
4214 @end group
4215 @end smallexample
4217 Note that since the insn is both a jump insn and has an output, it must
4218 deal with its own reloads, hence the `m' constraints.  Also note that
4219 since this insn is generated by the instruction combination phase
4220 combining two sequential insns together into an implicit parallel insn,
4221 the iteration counter needs to be biased by the same amount as the
4222 decrement operation, in this case @minus{}1.  Note that the following similar
4223 pattern will not be matched by the combiner.
4225 @smallexample
4226 @group
4227 (define_insn "decrement_and_branch_until_zero"
4228   [(set (pc)
4229         (if_then_else
4230           (ge (match_operand:SI 0 "general_operand" "+d*am")
4231               (const_int 1))
4232           (label_ref (match_operand 1 "" ""))
4233           (pc)))
4234    (set (match_dup 0)
4235         (plus:SI (match_dup 0)
4236                  (const_int -1)))]
4237   "find_reg_note (insn, REG_NONNEG, 0)"
4238   "@dots{}")
4239 @end group
4240 @end smallexample
4242 The other two special looping patterns, @samp{doloop_begin} and
4243 @samp{doloop_end}, are emitted by the loop optimizer for certain
4244 well-behaved loops with a finite number of loop iterations using
4245 information collected during strength reduction.
4247 The @samp{doloop_end} pattern describes the actual looping instruction
4248 (or the implicit looping operation) and the @samp{doloop_begin} pattern
4249 is an optional companion pattern that can be used for initialization
4250 needed for some low-overhead looping instructions.
4252 Note that some machines require the actual looping instruction to be
4253 emitted at the top of the loop (e.g., the TMS320C3x/C4x DSPs).  Emitting
4254 the true RTL for a looping instruction at the top of the loop can cause
4255 problems with flow analysis.  So instead, a dummy @code{doloop} insn is
4256 emitted at the end of the loop.  The machine dependent reorg pass checks
4257 for the presence of this @code{doloop} insn and then searches back to
4258 the top of the loop, where it inserts the true looping insn (provided
4259 there are no instructions in the loop which would cause problems).  Any
4260 additional labels can be emitted at this point.  In addition, if the
4261 desired special iteration counter register was not allocated, this
4262 machine dependent reorg pass could emit a traditional compare and jump
4263 instruction pair.
4265 The essential difference between the
4266 @samp{decrement_and_branch_until_zero} and the @samp{doloop_end}
4267 patterns is that the loop optimizer allocates an additional pseudo
4268 register for the latter as an iteration counter.  This pseudo register
4269 cannot be used within the loop (i.e., general induction variables cannot
4270 be derived from it), however, in many cases the loop induction variable
4271 may become redundant and removed by the flow pass.
4274 @end ifset
4275 @ifset INTERNALS
4276 @node Insn Canonicalizations
4277 @section Canonicalization of Instructions
4278 @cindex canonicalization of instructions
4279 @cindex insn canonicalization
4281 There are often cases where multiple RTL expressions could represent an
4282 operation performed by a single machine instruction.  This situation is
4283 most commonly encountered with logical, branch, and multiply-accumulate
4284 instructions.  In such cases, the compiler attempts to convert these
4285 multiple RTL expressions into a single canonical form to reduce the
4286 number of insn patterns required.
4288 In addition to algebraic simplifications, following canonicalizations
4289 are performed:
4291 @itemize @bullet
4292 @item
4293 For commutative and comparison operators, a constant is always made the
4294 second operand.  If a machine only supports a constant as the second
4295 operand, only patterns that match a constant in the second operand need
4296 be supplied.
4298 @item
4299 For associative operators, a sequence of operators will always chain
4300 to the left; for instance, only the left operand of an integer @code{plus}
4301 can itself be a @code{plus}.  @code{and}, @code{ior}, @code{xor},
4302 @code{plus}, @code{mult}, @code{smin}, @code{smax}, @code{umin}, and
4303 @code{umax} are associative when applied to integers, and sometimes to
4304 floating-point.
4306 @item
4307 @cindex @code{neg}, canonicalization of
4308 @cindex @code{not}, canonicalization of
4309 @cindex @code{mult}, canonicalization of
4310 @cindex @code{plus}, canonicalization of
4311 @cindex @code{minus}, canonicalization of
4312 For these operators, if only one operand is a @code{neg}, @code{not},
4313 @code{mult}, @code{plus}, or @code{minus} expression, it will be the
4314 first operand.
4316 @item
4317 In combinations of @code{neg}, @code{mult}, @code{plus}, and
4318 @code{minus}, the @code{neg} operations (if any) will be moved inside
4319 the operations as far as possible.  For instance,
4320 @code{(neg (mult A B))} is canonicalized as @code{(mult (neg A) B)}, but
4321 @code{(plus (mult (neg A) B) C)} is canonicalized as
4322 @code{(minus A (mult B C))}.
4324 @cindex @code{compare}, canonicalization of
4325 @item
4326 For the @code{compare} operator, a constant is always the second operand
4327 on machines where @code{cc0} is used (@pxref{Jump Patterns}).  On other
4328 machines, there are rare cases where the compiler might want to construct
4329 a @code{compare} with a constant as the first operand.  However, these
4330 cases are not common enough for it to be worthwhile to provide a pattern
4331 matching a constant as the first operand unless the machine actually has
4332 such an instruction.
4334 An operand of @code{neg}, @code{not}, @code{mult}, @code{plus}, or
4335 @code{minus} is made the first operand under the same conditions as
4336 above.
4338 @item
4339 @code{(minus @var{x} (const_int @var{n}))} is converted to
4340 @code{(plus @var{x} (const_int @var{-n}))}.
4342 @item
4343 Within address computations (i.e., inside @code{mem}), a left shift is
4344 converted into the appropriate multiplication by a power of two.
4346 @cindex @code{ior}, canonicalization of
4347 @cindex @code{and}, canonicalization of
4348 @cindex De Morgan's law
4349 @item
4350 De Morgan's Law is used to move bitwise negation inside a bitwise
4351 logical-and or logical-or operation.  If this results in only one
4352 operand being a @code{not} expression, it will be the first one.
4354 A machine that has an instruction that performs a bitwise logical-and of one
4355 operand with the bitwise negation of the other should specify the pattern
4356 for that instruction as
4358 @smallexample
4359 (define_insn ""
4360   [(set (match_operand:@var{m} 0 @dots{})
4361         (and:@var{m} (not:@var{m} (match_operand:@var{m} 1 @dots{}))
4362                      (match_operand:@var{m} 2 @dots{})))]
4363   "@dots{}"
4364   "@dots{}")
4365 @end smallexample
4367 @noindent
4368 Similarly, a pattern for a ``NAND'' instruction should be written
4370 @smallexample
4371 (define_insn ""
4372   [(set (match_operand:@var{m} 0 @dots{})
4373         (ior:@var{m} (not:@var{m} (match_operand:@var{m} 1 @dots{}))
4374                      (not:@var{m} (match_operand:@var{m} 2 @dots{}))))]
4375   "@dots{}"
4376   "@dots{}")
4377 @end smallexample
4379 In both cases, it is not necessary to include patterns for the many
4380 logically equivalent RTL expressions.
4382 @cindex @code{xor}, canonicalization of
4383 @item
4384 The only possible RTL expressions involving both bitwise exclusive-or
4385 and bitwise negation are @code{(xor:@var{m} @var{x} @var{y})}
4386 and @code{(not:@var{m} (xor:@var{m} @var{x} @var{y}))}.
4388 @item
4389 The sum of three items, one of which is a constant, will only appear in
4390 the form
4392 @smallexample
4393 (plus:@var{m} (plus:@var{m} @var{x} @var{y}) @var{constant})
4394 @end smallexample
4396 @item
4397 On machines that do not use @code{cc0},
4398 @code{(compare @var{x} (const_int 0))} will be converted to
4399 @var{x}.
4401 @cindex @code{zero_extract}, canonicalization of
4402 @cindex @code{sign_extract}, canonicalization of
4403 @item
4404 Equality comparisons of a group of bits (usually a single bit) with zero
4405 will be written using @code{zero_extract} rather than the equivalent
4406 @code{and} or @code{sign_extract} operations.
4408 @end itemize
4410 @end ifset
4411 @ifset INTERNALS
4412 @node Expander Definitions
4413 @section Defining RTL Sequences for Code Generation
4414 @cindex expander definitions
4415 @cindex code generation RTL sequences
4416 @cindex defining RTL sequences for code generation
4418 On some target machines, some standard pattern names for RTL generation
4419 cannot be handled with single insn, but a sequence of RTL insns can
4420 represent them.  For these target machines, you can write a
4421 @code{define_expand} to specify how to generate the sequence of RTL@.
4423 @findex define_expand
4424 A @code{define_expand} is an RTL expression that looks almost like a
4425 @code{define_insn}; but, unlike the latter, a @code{define_expand} is used
4426 only for RTL generation and it can produce more than one RTL insn.
4428 A @code{define_expand} RTX has four operands:
4430 @itemize @bullet
4431 @item
4432 The name.  Each @code{define_expand} must have a name, since the only
4433 use for it is to refer to it by name.
4435 @item
4436 The RTL template.  This is a vector of RTL expressions representing
4437 a sequence of separate instructions.  Unlike @code{define_insn}, there
4438 is no implicit surrounding @code{PARALLEL}.
4440 @item
4441 The condition, a string containing a C expression.  This expression is
4442 used to express how the availability of this pattern depends on
4443 subclasses of target machine, selected by command-line options when GCC
4444 is run.  This is just like the condition of a @code{define_insn} that
4445 has a standard name.  Therefore, the condition (if present) may not
4446 depend on the data in the insn being matched, but only the
4447 target-machine-type flags.  The compiler needs to test these conditions
4448 during initialization in order to learn exactly which named instructions
4449 are available in a particular run.
4451 @item
4452 The preparation statements, a string containing zero or more C
4453 statements which are to be executed before RTL code is generated from
4454 the RTL template.
4456 Usually these statements prepare temporary registers for use as
4457 internal operands in the RTL template, but they can also generate RTL
4458 insns directly by calling routines such as @code{emit_insn}, etc.
4459 Any such insns precede the ones that come from the RTL template.
4460 @end itemize
4462 Every RTL insn emitted by a @code{define_expand} must match some
4463 @code{define_insn} in the machine description.  Otherwise, the compiler
4464 will crash when trying to generate code for the insn or trying to optimize
4467 The RTL template, in addition to controlling generation of RTL insns,
4468 also describes the operands that need to be specified when this pattern
4469 is used.  In particular, it gives a predicate for each operand.
4471 A true operand, which needs to be specified in order to generate RTL from
4472 the pattern, should be described with a @code{match_operand} in its first
4473 occurrence in the RTL template.  This enters information on the operand's
4474 predicate into the tables that record such things.  GCC uses the
4475 information to preload the operand into a register if that is required for
4476 valid RTL code.  If the operand is referred to more than once, subsequent
4477 references should use @code{match_dup}.
4479 The RTL template may also refer to internal ``operands'' which are
4480 temporary registers or labels used only within the sequence made by the
4481 @code{define_expand}.  Internal operands are substituted into the RTL
4482 template with @code{match_dup}, never with @code{match_operand}.  The
4483 values of the internal operands are not passed in as arguments by the
4484 compiler when it requests use of this pattern.  Instead, they are computed
4485 within the pattern, in the preparation statements.  These statements
4486 compute the values and store them into the appropriate elements of
4487 @code{operands} so that @code{match_dup} can find them.
4489 There are two special macros defined for use in the preparation statements:
4490 @code{DONE} and @code{FAIL}.  Use them with a following semicolon,
4491 as a statement.
4493 @table @code
4495 @findex DONE
4496 @item DONE
4497 Use the @code{DONE} macro to end RTL generation for the pattern.  The
4498 only RTL insns resulting from the pattern on this occasion will be
4499 those already emitted by explicit calls to @code{emit_insn} within the
4500 preparation statements; the RTL template will not be generated.
4502 @findex FAIL
4503 @item FAIL
4504 Make the pattern fail on this occasion.  When a pattern fails, it means
4505 that the pattern was not truly available.  The calling routines in the
4506 compiler will try other strategies for code generation using other patterns.
4508 Failure is currently supported only for binary (addition, multiplication,
4509 shifting, etc.) and bit-field (@code{extv}, @code{extzv}, and @code{insv})
4510 operations.
4511 @end table
4513 If the preparation falls through (invokes neither @code{DONE} nor
4514 @code{FAIL}), then the @code{define_expand} acts like a
4515 @code{define_insn} in that the RTL template is used to generate the
4516 insn.
4518 The RTL template is not used for matching, only for generating the
4519 initial insn list.  If the preparation statement always invokes
4520 @code{DONE} or @code{FAIL}, the RTL template may be reduced to a simple
4521 list of operands, such as this example:
4523 @smallexample
4524 @group
4525 (define_expand "addsi3"
4526   [(match_operand:SI 0 "register_operand" "")
4527    (match_operand:SI 1 "register_operand" "")
4528    (match_operand:SI 2 "register_operand" "")]
4529 @end group
4530 @group
4531   ""
4532   "
4534   handle_add (operands[0], operands[1], operands[2]);
4535   DONE;
4536 @}")
4537 @end group
4538 @end smallexample
4540 Here is an example, the definition of left-shift for the SPUR chip:
4542 @smallexample
4543 @group
4544 (define_expand "ashlsi3"
4545   [(set (match_operand:SI 0 "register_operand" "")
4546         (ashift:SI
4547 @end group
4548 @group
4549           (match_operand:SI 1 "register_operand" "")
4550           (match_operand:SI 2 "nonmemory_operand" "")))]
4551   ""
4552   "
4553 @end group
4554 @end smallexample
4556 @smallexample
4557 @group
4559   if (GET_CODE (operands[2]) != CONST_INT
4560       || (unsigned) INTVAL (operands[2]) > 3)
4561     FAIL;
4562 @}")
4563 @end group
4564 @end smallexample
4566 @noindent
4567 This example uses @code{define_expand} so that it can generate an RTL insn
4568 for shifting when the shift-count is in the supported range of 0 to 3 but
4569 fail in other cases where machine insns aren't available.  When it fails,
4570 the compiler tries another strategy using different patterns (such as, a
4571 library call).
4573 If the compiler were able to handle nontrivial condition-strings in
4574 patterns with names, then it would be possible to use a
4575 @code{define_insn} in that case.  Here is another case (zero-extension
4576 on the 68000) which makes more use of the power of @code{define_expand}:
4578 @smallexample
4579 (define_expand "zero_extendhisi2"
4580   [(set (match_operand:SI 0 "general_operand" "")
4581         (const_int 0))
4582    (set (strict_low_part
4583           (subreg:HI
4584             (match_dup 0)
4585             0))
4586         (match_operand:HI 1 "general_operand" ""))]
4587   ""
4588   "operands[1] = make_safe_from (operands[1], operands[0]);")
4589 @end smallexample
4591 @noindent
4592 @findex make_safe_from
4593 Here two RTL insns are generated, one to clear the entire output operand
4594 and the other to copy the input operand into its low half.  This sequence
4595 is incorrect if the input operand refers to [the old value of] the output
4596 operand, so the preparation statement makes sure this isn't so.  The
4597 function @code{make_safe_from} copies the @code{operands[1]} into a
4598 temporary register if it refers to @code{operands[0]}.  It does this
4599 by emitting another RTL insn.
4601 Finally, a third example shows the use of an internal operand.
4602 Zero-extension on the SPUR chip is done by @code{and}-ing the result
4603 against a halfword mask.  But this mask cannot be represented by a
4604 @code{const_int} because the constant value is too large to be legitimate
4605 on this machine.  So it must be copied into a register with
4606 @code{force_reg} and then the register used in the @code{and}.
4608 @smallexample
4609 (define_expand "zero_extendhisi2"
4610   [(set (match_operand:SI 0 "register_operand" "")
4611         (and:SI (subreg:SI
4612                   (match_operand:HI 1 "register_operand" "")
4613                   0)
4614                 (match_dup 2)))]
4615   ""
4616   "operands[2]
4617      = force_reg (SImode, GEN_INT (65535)); ")
4618 @end smallexample
4620 @emph{Note:} If the @code{define_expand} is used to serve a
4621 standard binary or unary arithmetic operation or a bit-field operation,
4622 then the last insn it generates must not be a @code{code_label},
4623 @code{barrier} or @code{note}.  It must be an @code{insn},
4624 @code{jump_insn} or @code{call_insn}.  If you don't need a real insn
4625 at the end, emit an insn to copy the result of the operation into
4626 itself.  Such an insn will generate no code, but it can avoid problems
4627 in the compiler.
4629 @end ifset
4630 @ifset INTERNALS
4631 @node Insn Splitting
4632 @section Defining How to Split Instructions
4633 @cindex insn splitting
4634 @cindex instruction splitting
4635 @cindex splitting instructions
4637 There are two cases where you should specify how to split a pattern
4638 into multiple insns.  On machines that have instructions requiring
4639 delay slots (@pxref{Delay Slots}) or that have instructions whose
4640 output is not available for multiple cycles (@pxref{Processor pipeline
4641 description}), the compiler phases that optimize these cases need to
4642 be able to move insns into one-instruction delay slots.  However, some
4643 insns may generate more than one machine instruction.  These insns
4644 cannot be placed into a delay slot.
4646 Often you can rewrite the single insn as a list of individual insns,
4647 each corresponding to one machine instruction.  The disadvantage of
4648 doing so is that it will cause the compilation to be slower and require
4649 more space.  If the resulting insns are too complex, it may also
4650 suppress some optimizations.  The compiler splits the insn if there is a
4651 reason to believe that it might improve instruction or delay slot
4652 scheduling.
4654 The insn combiner phase also splits putative insns.  If three insns are
4655 merged into one insn with a complex expression that cannot be matched by
4656 some @code{define_insn} pattern, the combiner phase attempts to split
4657 the complex pattern into two insns that are recognized.  Usually it can
4658 break the complex pattern into two patterns by splitting out some
4659 subexpression.  However, in some other cases, such as performing an
4660 addition of a large constant in two insns on a RISC machine, the way to
4661 split the addition into two insns is machine-dependent.
4663 @findex define_split
4664 The @code{define_split} definition tells the compiler how to split a
4665 complex insn into several simpler insns.  It looks like this:
4667 @smallexample
4668 (define_split
4669   [@var{insn-pattern}]
4670   "@var{condition}"
4671   [@var{new-insn-pattern-1}
4672    @var{new-insn-pattern-2}
4673    @dots{}]
4674   "@var{preparation-statements}")
4675 @end smallexample
4677 @var{insn-pattern} is a pattern that needs to be split and
4678 @var{condition} is the final condition to be tested, as in a
4679 @code{define_insn}.  When an insn matching @var{insn-pattern} and
4680 satisfying @var{condition} is found, it is replaced in the insn list
4681 with the insns given by @var{new-insn-pattern-1},
4682 @var{new-insn-pattern-2}, etc.
4684 The @var{preparation-statements} are similar to those statements that
4685 are specified for @code{define_expand} (@pxref{Expander Definitions})
4686 and are executed before the new RTL is generated to prepare for the
4687 generated code or emit some insns whose pattern is not fixed.  Unlike
4688 those in @code{define_expand}, however, these statements must not
4689 generate any new pseudo-registers.  Once reload has completed, they also
4690 must not allocate any space in the stack frame.
4692 Patterns are matched against @var{insn-pattern} in two different
4693 circumstances.  If an insn needs to be split for delay slot scheduling
4694 or insn scheduling, the insn is already known to be valid, which means
4695 that it must have been matched by some @code{define_insn} and, if
4696 @code{reload_completed} is nonzero, is known to satisfy the constraints
4697 of that @code{define_insn}.  In that case, the new insn patterns must
4698 also be insns that are matched by some @code{define_insn} and, if
4699 @code{reload_completed} is nonzero, must also satisfy the constraints
4700 of those definitions.
4702 As an example of this usage of @code{define_split}, consider the following
4703 example from @file{a29k.md}, which splits a @code{sign_extend} from
4704 @code{HImode} to @code{SImode} into a pair of shift insns:
4706 @smallexample
4707 (define_split
4708   [(set (match_operand:SI 0 "gen_reg_operand" "")
4709         (sign_extend:SI (match_operand:HI 1 "gen_reg_operand" "")))]
4710   ""
4711   [(set (match_dup 0)
4712         (ashift:SI (match_dup 1)
4713                    (const_int 16)))
4714    (set (match_dup 0)
4715         (ashiftrt:SI (match_dup 0)
4716                      (const_int 16)))]
4717   "
4718 @{ operands[1] = gen_lowpart (SImode, operands[1]); @}")
4719 @end smallexample
4721 When the combiner phase tries to split an insn pattern, it is always the
4722 case that the pattern is @emph{not} matched by any @code{define_insn}.
4723 The combiner pass first tries to split a single @code{set} expression
4724 and then the same @code{set} expression inside a @code{parallel}, but
4725 followed by a @code{clobber} of a pseudo-reg to use as a scratch
4726 register.  In these cases, the combiner expects exactly two new insn
4727 patterns to be generated.  It will verify that these patterns match some
4728 @code{define_insn} definitions, so you need not do this test in the
4729 @code{define_split} (of course, there is no point in writing a
4730 @code{define_split} that will never produce insns that match).
4732 Here is an example of this use of @code{define_split}, taken from
4733 @file{rs6000.md}:
4735 @smallexample
4736 (define_split
4737   [(set (match_operand:SI 0 "gen_reg_operand" "")
4738         (plus:SI (match_operand:SI 1 "gen_reg_operand" "")
4739                  (match_operand:SI 2 "non_add_cint_operand" "")))]
4740   ""
4741   [(set (match_dup 0) (plus:SI (match_dup 1) (match_dup 3)))
4742    (set (match_dup 0) (plus:SI (match_dup 0) (match_dup 4)))]
4745   int low = INTVAL (operands[2]) & 0xffff;
4746   int high = (unsigned) INTVAL (operands[2]) >> 16;
4748   if (low & 0x8000)
4749     high++, low |= 0xffff0000;
4751   operands[3] = GEN_INT (high << 16);
4752   operands[4] = GEN_INT (low);
4753 @}")
4754 @end smallexample
4756 Here the predicate @code{non_add_cint_operand} matches any
4757 @code{const_int} that is @emph{not} a valid operand of a single add
4758 insn.  The add with the smaller displacement is written so that it
4759 can be substituted into the address of a subsequent operation.
4761 An example that uses a scratch register, from the same file, generates
4762 an equality comparison of a register and a large constant:
4764 @smallexample
4765 (define_split
4766   [(set (match_operand:CC 0 "cc_reg_operand" "")
4767         (compare:CC (match_operand:SI 1 "gen_reg_operand" "")
4768                     (match_operand:SI 2 "non_short_cint_operand" "")))
4769    (clobber (match_operand:SI 3 "gen_reg_operand" ""))]
4770   "find_single_use (operands[0], insn, 0)
4771    && (GET_CODE (*find_single_use (operands[0], insn, 0)) == EQ
4772        || GET_CODE (*find_single_use (operands[0], insn, 0)) == NE)"
4773   [(set (match_dup 3) (xor:SI (match_dup 1) (match_dup 4)))
4774    (set (match_dup 0) (compare:CC (match_dup 3) (match_dup 5)))]
4775   "
4777   /* @r{Get the constant we are comparing against, C, and see what it
4778      looks like sign-extended to 16 bits.  Then see what constant
4779      could be XOR'ed with C to get the sign-extended value.}  */
4781   int c = INTVAL (operands[2]);
4782   int sextc = (c << 16) >> 16;
4783   int xorv = c ^ sextc;
4785   operands[4] = GEN_INT (xorv);
4786   operands[5] = GEN_INT (sextc);
4787 @}")
4788 @end smallexample
4790 To avoid confusion, don't write a single @code{define_split} that
4791 accepts some insns that match some @code{define_insn} as well as some
4792 insns that don't.  Instead, write two separate @code{define_split}
4793 definitions, one for the insns that are valid and one for the insns that
4794 are not valid.
4796 The splitter is allowed to split jump instructions into sequence of
4797 jumps or create new jumps in while splitting non-jump instructions.  As
4798 the central flowgraph and branch prediction information needs to be updated,
4799 several restriction apply.
4801 Splitting of jump instruction into sequence that over by another jump
4802 instruction is always valid, as compiler expect identical behavior of new
4803 jump.  When new sequence contains multiple jump instructions or new labels,
4804 more assistance is needed.  Splitter is required to create only unconditional
4805 jumps, or simple conditional jump instructions.  Additionally it must attach a
4806 @code{REG_BR_PROB} note to each conditional jump.  A global variable
4807 @code{split_branch_probability} hold the probability of original branch in case
4808 it was an simple conditional jump, @minus{}1 otherwise.  To simplify
4809 recomputing of edge frequencies, new sequence is required to have only
4810 forward jumps to the newly created labels.
4812 @findex define_insn_and_split
4813 For the common case where the pattern of a define_split exactly matches the
4814 pattern of a define_insn, use @code{define_insn_and_split}.  It looks like
4815 this:
4817 @smallexample
4818 (define_insn_and_split
4819   [@var{insn-pattern}]
4820   "@var{condition}"
4821   "@var{output-template}"
4822   "@var{split-condition}"
4823   [@var{new-insn-pattern-1}
4824    @var{new-insn-pattern-2}
4825    @dots{}]
4826   "@var{preparation-statements}"
4827   [@var{insn-attributes}])
4829 @end smallexample
4831 @var{insn-pattern}, @var{condition}, @var{output-template}, and
4832 @var{insn-attributes} are used as in @code{define_insn}.  The
4833 @var{new-insn-pattern} vector and the @var{preparation-statements} are used as
4834 in a @code{define_split}.  The @var{split-condition} is also used as in
4835 @code{define_split}, with the additional behavior that if the condition starts
4836 with @samp{&&}, the condition used for the split will be the constructed as a
4837 logical ``and'' of the split condition with the insn condition.  For example,
4838 from i386.md:
4840 @smallexample
4841 (define_insn_and_split "zero_extendhisi2_and"
4842   [(set (match_operand:SI 0 "register_operand" "=r")
4843      (zero_extend:SI (match_operand:HI 1 "register_operand" "0")))
4844    (clobber (reg:CC 17))]
4845   "TARGET_ZERO_EXTEND_WITH_AND && !optimize_size"
4846   "#"
4847   "&& reload_completed"
4848   [(parallel [(set (match_dup 0)
4849                    (and:SI (match_dup 0) (const_int 65535)))
4850               (clobber (reg:CC 17))])]
4851   ""
4852   [(set_attr "type" "alu1")])
4854 @end smallexample
4856 In this case, the actual split condition will be
4857 @samp{TARGET_ZERO_EXTEND_WITH_AND && !optimize_size && reload_completed}.
4859 The @code{define_insn_and_split} construction provides exactly the same
4860 functionality as two separate @code{define_insn} and @code{define_split}
4861 patterns.  It exists for compactness, and as a maintenance tool to prevent
4862 having to ensure the two patterns' templates match.
4864 @end ifset
4865 @ifset INTERNALS
4866 @node Including Patterns
4867 @section Including Patterns in Machine Descriptions.
4868 @cindex insn includes
4870 @findex include
4871 The @code{include} pattern tells the compiler tools where to
4872 look for patterns that are in files other than in the file
4873 @file{.md}.  This is used only at build time and there is no preprocessing allowed.
4875 It looks like:
4877 @smallexample
4879 (include
4880   @var{pathname})
4881 @end smallexample
4883 For example:
4885 @smallexample
4887 (include "filestuff")
4889 @end smallexample
4891 Where @var{pathname} is a string that specifies the location of the file,
4892 specifies the include file to be in @file{gcc/config/target/filestuff}.  The
4893 directory @file{gcc/config/target} is regarded as the default directory.
4896 Machine descriptions may be split up into smaller more manageable subsections
4897 and placed into subdirectories.
4899 By specifying:
4901 @smallexample
4903 (include "BOGUS/filestuff")
4905 @end smallexample
4907 the include file is specified to be in @file{gcc/config/@var{target}/BOGUS/filestuff}.
4909 Specifying an absolute path for the include file such as;
4910 @smallexample
4912 (include "/u2/BOGUS/filestuff")
4914 @end smallexample
4915 is permitted but is not encouraged.
4917 @subsection RTL Generation Tool Options for Directory Search
4918 @cindex directory options .md
4919 @cindex options, directory search
4920 @cindex search options
4922 The @option{-I@var{dir}} option specifies directories to search for machine descriptions.
4923 For example:
4925 @smallexample
4927 genrecog -I/p1/abc/proc1 -I/p2/abcd/pro2 target.md
4929 @end smallexample
4932 Add the directory @var{dir} to the head of the list of directories to be
4933 searched for header files.  This can be used to override a system machine definition
4934 file, substituting your own version, since these directories are
4935 searched before the default machine description file directories.  If you use more than
4936 one @option{-I} option, the directories are scanned in left-to-right
4937 order; the standard default directory come after.
4940 @end ifset
4941 @ifset INTERNALS
4942 @node Peephole Definitions
4943 @section Machine-Specific Peephole Optimizers
4944 @cindex peephole optimizer definitions
4945 @cindex defining peephole optimizers
4947 In addition to instruction patterns the @file{md} file may contain
4948 definitions of machine-specific peephole optimizations.
4950 The combiner does not notice certain peephole optimizations when the data
4951 flow in the program does not suggest that it should try them.  For example,
4952 sometimes two consecutive insns related in purpose can be combined even
4953 though the second one does not appear to use a register computed in the
4954 first one.  A machine-specific peephole optimizer can detect such
4955 opportunities.
4957 There are two forms of peephole definitions that may be used.  The
4958 original @code{define_peephole} is run at assembly output time to
4959 match insns and substitute assembly text.  Use of @code{define_peephole}
4960 is deprecated.
4962 A newer @code{define_peephole2} matches insns and substitutes new
4963 insns.  The @code{peephole2} pass is run after register allocation
4964 but before scheduling, which may result in much better code for
4965 targets that do scheduling.
4967 @menu
4968 * define_peephole::     RTL to Text Peephole Optimizers
4969 * define_peephole2::    RTL to RTL Peephole Optimizers
4970 @end menu
4972 @end ifset
4973 @ifset INTERNALS
4974 @node define_peephole
4975 @subsection RTL to Text Peephole Optimizers
4976 @findex define_peephole
4978 @need 1000
4979 A definition looks like this:
4981 @smallexample
4982 (define_peephole
4983   [@var{insn-pattern-1}
4984    @var{insn-pattern-2}
4985    @dots{}]
4986   "@var{condition}"
4987   "@var{template}"
4988   "@var{optional-insn-attributes}")
4989 @end smallexample
4991 @noindent
4992 The last string operand may be omitted if you are not using any
4993 machine-specific information in this machine description.  If present,
4994 it must obey the same rules as in a @code{define_insn}.
4996 In this skeleton, @var{insn-pattern-1} and so on are patterns to match
4997 consecutive insns.  The optimization applies to a sequence of insns when
4998 @var{insn-pattern-1} matches the first one, @var{insn-pattern-2} matches
4999 the next, and so on.
5001 Each of the insns matched by a peephole must also match a
5002 @code{define_insn}.  Peepholes are checked only at the last stage just
5003 before code generation, and only optionally.  Therefore, any insn which
5004 would match a peephole but no @code{define_insn} will cause a crash in code
5005 generation in an unoptimized compilation, or at various optimization
5006 stages.
5008 The operands of the insns are matched with @code{match_operands},
5009 @code{match_operator}, and @code{match_dup}, as usual.  What is not
5010 usual is that the operand numbers apply to all the insn patterns in the
5011 definition.  So, you can check for identical operands in two insns by
5012 using @code{match_operand} in one insn and @code{match_dup} in the
5013 other.
5015 The operand constraints used in @code{match_operand} patterns do not have
5016 any direct effect on the applicability of the peephole, but they will
5017 be validated afterward, so make sure your constraints are general enough
5018 to apply whenever the peephole matches.  If the peephole matches
5019 but the constraints are not satisfied, the compiler will crash.
5021 It is safe to omit constraints in all the operands of the peephole; or
5022 you can write constraints which serve as a double-check on the criteria
5023 previously tested.
5025 Once a sequence of insns matches the patterns, the @var{condition} is
5026 checked.  This is a C expression which makes the final decision whether to
5027 perform the optimization (we do so if the expression is nonzero).  If
5028 @var{condition} is omitted (in other words, the string is empty) then the
5029 optimization is applied to every sequence of insns that matches the
5030 patterns.
5032 The defined peephole optimizations are applied after register allocation
5033 is complete.  Therefore, the peephole definition can check which
5034 operands have ended up in which kinds of registers, just by looking at
5035 the operands.
5037 @findex prev_active_insn
5038 The way to refer to the operands in @var{condition} is to write
5039 @code{operands[@var{i}]} for operand number @var{i} (as matched by
5040 @code{(match_operand @var{i} @dots{})}).  Use the variable @code{insn}
5041 to refer to the last of the insns being matched; use
5042 @code{prev_active_insn} to find the preceding insns.
5044 @findex dead_or_set_p
5045 When optimizing computations with intermediate results, you can use
5046 @var{condition} to match only when the intermediate results are not used
5047 elsewhere.  Use the C expression @code{dead_or_set_p (@var{insn},
5048 @var{op})}, where @var{insn} is the insn in which you expect the value
5049 to be used for the last time (from the value of @code{insn}, together
5050 with use of @code{prev_nonnote_insn}), and @var{op} is the intermediate
5051 value (from @code{operands[@var{i}]}).
5053 Applying the optimization means replacing the sequence of insns with one
5054 new insn.  The @var{template} controls ultimate output of assembler code
5055 for this combined insn.  It works exactly like the template of a
5056 @code{define_insn}.  Operand numbers in this template are the same ones
5057 used in matching the original sequence of insns.
5059 The result of a defined peephole optimizer does not need to match any of
5060 the insn patterns in the machine description; it does not even have an
5061 opportunity to match them.  The peephole optimizer definition itself serves
5062 as the insn pattern to control how the insn is output.
5064 Defined peephole optimizers are run as assembler code is being output,
5065 so the insns they produce are never combined or rearranged in any way.
5067 Here is an example, taken from the 68000 machine description:
5069 @smallexample
5070 (define_peephole
5071   [(set (reg:SI 15) (plus:SI (reg:SI 15) (const_int 4)))
5072    (set (match_operand:DF 0 "register_operand" "=f")
5073         (match_operand:DF 1 "register_operand" "ad"))]
5074   "FP_REG_P (operands[0]) && ! FP_REG_P (operands[1])"
5076   rtx xoperands[2];
5077   xoperands[1] = gen_rtx_REG (SImode, REGNO (operands[1]) + 1);
5078 #ifdef MOTOROLA
5079   output_asm_insn ("move.l %1,(sp)", xoperands);
5080   output_asm_insn ("move.l %1,-(sp)", operands);
5081   return "fmove.d (sp)+,%0";
5082 #else
5083   output_asm_insn ("movel %1,sp@@", xoperands);
5084   output_asm_insn ("movel %1,sp@@-", operands);
5085   return "fmoved sp@@+,%0";
5086 #endif
5088 @end smallexample
5090 @need 1000
5091 The effect of this optimization is to change
5093 @smallexample
5094 @group
5095 jbsr _foobar
5096 addql #4,sp
5097 movel d1,sp@@-
5098 movel d0,sp@@-
5099 fmoved sp@@+,fp0
5100 @end group
5101 @end smallexample
5103 @noindent
5104 into
5106 @smallexample
5107 @group
5108 jbsr _foobar
5109 movel d1,sp@@
5110 movel d0,sp@@-
5111 fmoved sp@@+,fp0
5112 @end group
5113 @end smallexample
5115 @ignore
5116 @findex CC_REVERSED
5117 If a peephole matches a sequence including one or more jump insns, you must
5118 take account of the flags such as @code{CC_REVERSED} which specify that the
5119 condition codes are represented in an unusual manner.  The compiler
5120 automatically alters any ordinary conditional jumps which occur in such
5121 situations, but the compiler cannot alter jumps which have been replaced by
5122 peephole optimizations.  So it is up to you to alter the assembler code
5123 that the peephole produces.  Supply C code to write the assembler output,
5124 and in this C code check the condition code status flags and change the
5125 assembler code as appropriate.
5126 @end ignore
5128 @var{insn-pattern-1} and so on look @emph{almost} like the second
5129 operand of @code{define_insn}.  There is one important difference: the
5130 second operand of @code{define_insn} consists of one or more RTX's
5131 enclosed in square brackets.  Usually, there is only one: then the same
5132 action can be written as an element of a @code{define_peephole}.  But
5133 when there are multiple actions in a @code{define_insn}, they are
5134 implicitly enclosed in a @code{parallel}.  Then you must explicitly
5135 write the @code{parallel}, and the square brackets within it, in the
5136 @code{define_peephole}.  Thus, if an insn pattern looks like this,
5138 @smallexample
5139 (define_insn "divmodsi4"
5140   [(set (match_operand:SI 0 "general_operand" "=d")
5141         (div:SI (match_operand:SI 1 "general_operand" "0")
5142                 (match_operand:SI 2 "general_operand" "dmsK")))
5143    (set (match_operand:SI 3 "general_operand" "=d")
5144         (mod:SI (match_dup 1) (match_dup 2)))]
5145   "TARGET_68020"
5146   "divsl%.l %2,%3:%0")
5147 @end smallexample
5149 @noindent
5150 then the way to mention this insn in a peephole is as follows:
5152 @smallexample
5153 (define_peephole
5154   [@dots{}
5155    (parallel
5156     [(set (match_operand:SI 0 "general_operand" "=d")
5157           (div:SI (match_operand:SI 1 "general_operand" "0")
5158                   (match_operand:SI 2 "general_operand" "dmsK")))
5159      (set (match_operand:SI 3 "general_operand" "=d")
5160           (mod:SI (match_dup 1) (match_dup 2)))])
5161    @dots{}]
5162   @dots{})
5163 @end smallexample
5165 @end ifset
5166 @ifset INTERNALS
5167 @node define_peephole2
5168 @subsection RTL to RTL Peephole Optimizers
5169 @findex define_peephole2
5171 The @code{define_peephole2} definition tells the compiler how to
5172 substitute one sequence of instructions for another sequence,
5173 what additional scratch registers may be needed and what their
5174 lifetimes must be.
5176 @smallexample
5177 (define_peephole2
5178   [@var{insn-pattern-1}
5179    @var{insn-pattern-2}
5180    @dots{}]
5181   "@var{condition}"
5182   [@var{new-insn-pattern-1}
5183    @var{new-insn-pattern-2}
5184    @dots{}]
5185   "@var{preparation-statements}")
5186 @end smallexample
5188 The definition is almost identical to @code{define_split}
5189 (@pxref{Insn Splitting}) except that the pattern to match is not a
5190 single instruction, but a sequence of instructions.
5192 It is possible to request additional scratch registers for use in the
5193 output template.  If appropriate registers are not free, the pattern
5194 will simply not match.
5196 @findex match_scratch
5197 @findex match_dup
5198 Scratch registers are requested with a @code{match_scratch} pattern at
5199 the top level of the input pattern.  The allocated register (initially) will
5200 be dead at the point requested within the original sequence.  If the scratch
5201 is used at more than a single point, a @code{match_dup} pattern at the
5202 top level of the input pattern marks the last position in the input sequence
5203 at which the register must be available.
5205 Here is an example from the IA-32 machine description:
5207 @smallexample
5208 (define_peephole2
5209   [(match_scratch:SI 2 "r")
5210    (parallel [(set (match_operand:SI 0 "register_operand" "")
5211                    (match_operator:SI 3 "arith_or_logical_operator"
5212                      [(match_dup 0)
5213                       (match_operand:SI 1 "memory_operand" "")]))
5214               (clobber (reg:CC 17))])]
5215   "! optimize_size && ! TARGET_READ_MODIFY"
5216   [(set (match_dup 2) (match_dup 1))
5217    (parallel [(set (match_dup 0)
5218                    (match_op_dup 3 [(match_dup 0) (match_dup 2)]))
5219               (clobber (reg:CC 17))])]
5220   "")
5221 @end smallexample
5223 @noindent
5224 This pattern tries to split a load from its use in the hopes that we'll be
5225 able to schedule around the memory load latency.  It allocates a single
5226 @code{SImode} register of class @code{GENERAL_REGS} (@code{"r"}) that needs
5227 to be live only at the point just before the arithmetic.
5229 A real example requiring extended scratch lifetimes is harder to come by,
5230 so here's a silly made-up example:
5232 @smallexample
5233 (define_peephole2
5234   [(match_scratch:SI 4 "r")
5235    (set (match_operand:SI 0 "" "") (match_operand:SI 1 "" ""))
5236    (set (match_operand:SI 2 "" "") (match_dup 1))
5237    (match_dup 4)
5238    (set (match_operand:SI 3 "" "") (match_dup 1))]
5239   "/* @r{determine 1 does not overlap 0 and 2} */"
5240   [(set (match_dup 4) (match_dup 1))
5241    (set (match_dup 0) (match_dup 4))
5242    (set (match_dup 2) (match_dup 4))]
5243    (set (match_dup 3) (match_dup 4))]
5244   "")
5245 @end smallexample
5247 @noindent
5248 If we had not added the @code{(match_dup 4)} in the middle of the input
5249 sequence, it might have been the case that the register we chose at the
5250 beginning of the sequence is killed by the first or second @code{set}.
5252 @end ifset
5253 @ifset INTERNALS
5254 @node Insn Attributes
5255 @section Instruction Attributes
5256 @cindex insn attributes
5257 @cindex instruction attributes
5259 In addition to describing the instruction supported by the target machine,
5260 the @file{md} file also defines a group of @dfn{attributes} and a set of
5261 values for each.  Every generated insn is assigned a value for each attribute.
5262 One possible attribute would be the effect that the insn has on the machine's
5263 condition code.  This attribute can then be used by @code{NOTICE_UPDATE_CC}
5264 to track the condition codes.
5266 @menu
5267 * Defining Attributes:: Specifying attributes and their values.
5268 * Expressions::         Valid expressions for attribute values.
5269 * Tagging Insns::       Assigning attribute values to insns.
5270 * Attr Example::        An example of assigning attributes.
5271 * Insn Lengths::        Computing the length of insns.
5272 * Constant Attributes:: Defining attributes that are constant.
5273 * Delay Slots::         Defining delay slots required for a machine.
5274 * Processor pipeline description:: Specifying information for insn scheduling.
5275 @end menu
5277 @end ifset
5278 @ifset INTERNALS
5279 @node Defining Attributes
5280 @subsection Defining Attributes and their Values
5281 @cindex defining attributes and their values
5282 @cindex attributes, defining
5284 @findex define_attr
5285 The @code{define_attr} expression is used to define each attribute required
5286 by the target machine.  It looks like:
5288 @smallexample
5289 (define_attr @var{name} @var{list-of-values} @var{default})
5290 @end smallexample
5292 @var{name} is a string specifying the name of the attribute being defined.
5294 @var{list-of-values} is either a string that specifies a comma-separated
5295 list of values that can be assigned to the attribute, or a null string to
5296 indicate that the attribute takes numeric values.
5298 @var{default} is an attribute expression that gives the value of this
5299 attribute for insns that match patterns whose definition does not include
5300 an explicit value for this attribute.  @xref{Attr Example}, for more
5301 information on the handling of defaults.  @xref{Constant Attributes},
5302 for information on attributes that do not depend on any particular insn.
5304 @findex insn-attr.h
5305 For each defined attribute, a number of definitions are written to the
5306 @file{insn-attr.h} file.  For cases where an explicit set of values is
5307 specified for an attribute, the following are defined:
5309 @itemize @bullet
5310 @item
5311 A @samp{#define} is written for the symbol @samp{HAVE_ATTR_@var{name}}.
5313 @item
5314 An enumerated class is defined for @samp{attr_@var{name}} with
5315 elements of the form @samp{@var{upper-name}_@var{upper-value}} where
5316 the attribute name and value are first converted to uppercase.
5318 @item
5319 A function @samp{get_attr_@var{name}} is defined that is passed an insn and
5320 returns the attribute value for that insn.
5321 @end itemize
5323 For example, if the following is present in the @file{md} file:
5325 @smallexample
5326 (define_attr "type" "branch,fp,load,store,arith" @dots{})
5327 @end smallexample
5329 @noindent
5330 the following lines will be written to the file @file{insn-attr.h}.
5332 @smallexample
5333 #define HAVE_ATTR_type
5334 enum attr_type @{TYPE_BRANCH, TYPE_FP, TYPE_LOAD,
5335                  TYPE_STORE, TYPE_ARITH@};
5336 extern enum attr_type get_attr_type ();
5337 @end smallexample
5339 If the attribute takes numeric values, no @code{enum} type will be
5340 defined and the function to obtain the attribute's value will return
5341 @code{int}.
5343 @end ifset
5344 @ifset INTERNALS
5345 @node Expressions
5346 @subsection Attribute Expressions
5347 @cindex attribute expressions
5349 RTL expressions used to define attributes use the codes described above
5350 plus a few specific to attribute definitions, to be discussed below.
5351 Attribute value expressions must have one of the following forms:
5353 @table @code
5354 @cindex @code{const_int} and attributes
5355 @item (const_int @var{i})
5356 The integer @var{i} specifies the value of a numeric attribute.  @var{i}
5357 must be non-negative.
5359 The value of a numeric attribute can be specified either with a
5360 @code{const_int}, or as an integer represented as a string in
5361 @code{const_string}, @code{eq_attr} (see below), @code{attr},
5362 @code{symbol_ref}, simple arithmetic expressions, and @code{set_attr}
5363 overrides on specific instructions (@pxref{Tagging Insns}).
5365 @cindex @code{const_string} and attributes
5366 @item (const_string @var{value})
5367 The string @var{value} specifies a constant attribute value.
5368 If @var{value} is specified as @samp{"*"}, it means that the default value of
5369 the attribute is to be used for the insn containing this expression.
5370 @samp{"*"} obviously cannot be used in the @var{default} expression
5371 of a @code{define_attr}.
5373 If the attribute whose value is being specified is numeric, @var{value}
5374 must be a string containing a non-negative integer (normally
5375 @code{const_int} would be used in this case).  Otherwise, it must
5376 contain one of the valid values for the attribute.
5378 @cindex @code{if_then_else} and attributes
5379 @item (if_then_else @var{test} @var{true-value} @var{false-value})
5380 @var{test} specifies an attribute test, whose format is defined below.
5381 The value of this expression is @var{true-value} if @var{test} is true,
5382 otherwise it is @var{false-value}.
5384 @cindex @code{cond} and attributes
5385 @item (cond [@var{test1} @var{value1} @dots{}] @var{default})
5386 The first operand of this expression is a vector containing an even
5387 number of expressions and consisting of pairs of @var{test} and @var{value}
5388 expressions.  The value of the @code{cond} expression is that of the
5389 @var{value} corresponding to the first true @var{test} expression.  If
5390 none of the @var{test} expressions are true, the value of the @code{cond}
5391 expression is that of the @var{default} expression.
5392 @end table
5394 @var{test} expressions can have one of the following forms:
5396 @table @code
5397 @cindex @code{const_int} and attribute tests
5398 @item (const_int @var{i})
5399 This test is true if @var{i} is nonzero and false otherwise.
5401 @cindex @code{not} and attributes
5402 @cindex @code{ior} and attributes
5403 @cindex @code{and} and attributes
5404 @item (not @var{test})
5405 @itemx (ior @var{test1} @var{test2})
5406 @itemx (and @var{test1} @var{test2})
5407 These tests are true if the indicated logical function is true.
5409 @cindex @code{match_operand} and attributes
5410 @item (match_operand:@var{m} @var{n} @var{pred} @var{constraints})
5411 This test is true if operand @var{n} of the insn whose attribute value
5412 is being determined has mode @var{m} (this part of the test is ignored
5413 if @var{m} is @code{VOIDmode}) and the function specified by the string
5414 @var{pred} returns a nonzero value when passed operand @var{n} and mode
5415 @var{m} (this part of the test is ignored if @var{pred} is the null
5416 string).
5418 The @var{constraints} operand is ignored and should be the null string.
5420 @cindex @code{le} and attributes
5421 @cindex @code{leu} and attributes
5422 @cindex @code{lt} and attributes
5423 @cindex @code{gt} and attributes
5424 @cindex @code{gtu} and attributes
5425 @cindex @code{ge} and attributes
5426 @cindex @code{geu} and attributes
5427 @cindex @code{ne} and attributes
5428 @cindex @code{eq} and attributes
5429 @cindex @code{plus} and attributes
5430 @cindex @code{minus} and attributes
5431 @cindex @code{mult} and attributes
5432 @cindex @code{div} and attributes
5433 @cindex @code{mod} and attributes
5434 @cindex @code{abs} and attributes
5435 @cindex @code{neg} and attributes
5436 @cindex @code{ashift} and attributes
5437 @cindex @code{lshiftrt} and attributes
5438 @cindex @code{ashiftrt} and attributes
5439 @item (le @var{arith1} @var{arith2})
5440 @itemx (leu @var{arith1} @var{arith2})
5441 @itemx (lt @var{arith1} @var{arith2})
5442 @itemx (ltu @var{arith1} @var{arith2})
5443 @itemx (gt @var{arith1} @var{arith2})
5444 @itemx (gtu @var{arith1} @var{arith2})
5445 @itemx (ge @var{arith1} @var{arith2})
5446 @itemx (geu @var{arith1} @var{arith2})
5447 @itemx (ne @var{arith1} @var{arith2})
5448 @itemx (eq @var{arith1} @var{arith2})
5449 These tests are true if the indicated comparison of the two arithmetic
5450 expressions is true.  Arithmetic expressions are formed with
5451 @code{plus}, @code{minus}, @code{mult}, @code{div}, @code{mod},
5452 @code{abs}, @code{neg}, @code{and}, @code{ior}, @code{xor}, @code{not},
5453 @code{ashift}, @code{lshiftrt}, and @code{ashiftrt} expressions.
5455 @findex get_attr
5456 @code{const_int} and @code{symbol_ref} are always valid terms (@pxref{Insn
5457 Lengths},for additional forms).  @code{symbol_ref} is a string
5458 denoting a C expression that yields an @code{int} when evaluated by the
5459 @samp{get_attr_@dots{}} routine.  It should normally be a global
5460 variable.
5462 @findex eq_attr
5463 @item (eq_attr @var{name} @var{value})
5464 @var{name} is a string specifying the name of an attribute.
5466 @var{value} is a string that is either a valid value for attribute
5467 @var{name}, a comma-separated list of values, or @samp{!} followed by a
5468 value or list.  If @var{value} does not begin with a @samp{!}, this
5469 test is true if the value of the @var{name} attribute of the current
5470 insn is in the list specified by @var{value}.  If @var{value} begins
5471 with a @samp{!}, this test is true if the attribute's value is
5472 @emph{not} in the specified list.
5474 For example,
5476 @smallexample
5477 (eq_attr "type" "load,store")
5478 @end smallexample
5480 @noindent
5481 is equivalent to
5483 @smallexample
5484 (ior (eq_attr "type" "load") (eq_attr "type" "store"))
5485 @end smallexample
5487 If @var{name} specifies an attribute of @samp{alternative}, it refers to the
5488 value of the compiler variable @code{which_alternative}
5489 (@pxref{Output Statement}) and the values must be small integers.  For
5490 example,
5492 @smallexample
5493 (eq_attr "alternative" "2,3")
5494 @end smallexample
5496 @noindent
5497 is equivalent to
5499 @smallexample
5500 (ior (eq (symbol_ref "which_alternative") (const_int 2))
5501      (eq (symbol_ref "which_alternative") (const_int 3)))
5502 @end smallexample
5504 Note that, for most attributes, an @code{eq_attr} test is simplified in cases
5505 where the value of the attribute being tested is known for all insns matching
5506 a particular pattern.  This is by far the most common case.
5508 @findex attr_flag
5509 @item (attr_flag @var{name})
5510 The value of an @code{attr_flag} expression is true if the flag
5511 specified by @var{name} is true for the @code{insn} currently being
5512 scheduled.
5514 @var{name} is a string specifying one of a fixed set of flags to test.
5515 Test the flags @code{forward} and @code{backward} to determine the
5516 direction of a conditional branch.  Test the flags @code{very_likely},
5517 @code{likely}, @code{very_unlikely}, and @code{unlikely} to determine
5518 if a conditional branch is expected to be taken.
5520 If the @code{very_likely} flag is true, then the @code{likely} flag is also
5521 true.  Likewise for the @code{very_unlikely} and @code{unlikely} flags.
5523 This example describes a conditional branch delay slot which
5524 can be nullified for forward branches that are taken (annul-true) or
5525 for backward branches which are not taken (annul-false).
5527 @smallexample
5528 (define_delay (eq_attr "type" "cbranch")
5529   [(eq_attr "in_branch_delay" "true")
5530    (and (eq_attr "in_branch_delay" "true")
5531         (attr_flag "forward"))
5532    (and (eq_attr "in_branch_delay" "true")
5533         (attr_flag "backward"))])
5534 @end smallexample
5536 The @code{forward} and @code{backward} flags are false if the current
5537 @code{insn} being scheduled is not a conditional branch.
5539 The @code{very_likely} and @code{likely} flags are true if the
5540 @code{insn} being scheduled is not a conditional branch.
5541 The @code{very_unlikely} and @code{unlikely} flags are false if the
5542 @code{insn} being scheduled is not a conditional branch.
5544 @code{attr_flag} is only used during delay slot scheduling and has no
5545 meaning to other passes of the compiler.
5547 @findex attr
5548 @item (attr @var{name})
5549 The value of another attribute is returned.  This is most useful
5550 for numeric attributes, as @code{eq_attr} and @code{attr_flag}
5551 produce more efficient code for non-numeric attributes.
5552 @end table
5554 @end ifset
5555 @ifset INTERNALS
5556 @node Tagging Insns
5557 @subsection Assigning Attribute Values to Insns
5558 @cindex tagging insns
5559 @cindex assigning attribute values to insns
5561 The value assigned to an attribute of an insn is primarily determined by
5562 which pattern is matched by that insn (or which @code{define_peephole}
5563 generated it).  Every @code{define_insn} and @code{define_peephole} can
5564 have an optional last argument to specify the values of attributes for
5565 matching insns.  The value of any attribute not specified in a particular
5566 insn is set to the default value for that attribute, as specified in its
5567 @code{define_attr}.  Extensive use of default values for attributes
5568 permits the specification of the values for only one or two attributes
5569 in the definition of most insn patterns, as seen in the example in the
5570 next section.
5572 The optional last argument of @code{define_insn} and
5573 @code{define_peephole} is a vector of expressions, each of which defines
5574 the value for a single attribute.  The most general way of assigning an
5575 attribute's value is to use a @code{set} expression whose first operand is an
5576 @code{attr} expression giving the name of the attribute being set.  The
5577 second operand of the @code{set} is an attribute expression
5578 (@pxref{Expressions}) giving the value of the attribute.
5580 When the attribute value depends on the @samp{alternative} attribute
5581 (i.e., which is the applicable alternative in the constraint of the
5582 insn), the @code{set_attr_alternative} expression can be used.  It
5583 allows the specification of a vector of attribute expressions, one for
5584 each alternative.
5586 @findex set_attr
5587 When the generality of arbitrary attribute expressions is not required,
5588 the simpler @code{set_attr} expression can be used, which allows
5589 specifying a string giving either a single attribute value or a list
5590 of attribute values, one for each alternative.
5592 The form of each of the above specifications is shown below.  In each case,
5593 @var{name} is a string specifying the attribute to be set.
5595 @table @code
5596 @item (set_attr @var{name} @var{value-string})
5597 @var{value-string} is either a string giving the desired attribute value,
5598 or a string containing a comma-separated list giving the values for
5599 succeeding alternatives.  The number of elements must match the number
5600 of alternatives in the constraint of the insn pattern.
5602 Note that it may be useful to specify @samp{*} for some alternative, in
5603 which case the attribute will assume its default value for insns matching
5604 that alternative.
5606 @findex set_attr_alternative
5607 @item (set_attr_alternative @var{name} [@var{value1} @var{value2} @dots{}])
5608 Depending on the alternative of the insn, the value will be one of the
5609 specified values.  This is a shorthand for using a @code{cond} with
5610 tests on the @samp{alternative} attribute.
5612 @findex attr
5613 @item (set (attr @var{name}) @var{value})
5614 The first operand of this @code{set} must be the special RTL expression
5615 @code{attr}, whose sole operand is a string giving the name of the
5616 attribute being set.  @var{value} is the value of the attribute.
5617 @end table
5619 The following shows three different ways of representing the same
5620 attribute value specification:
5622 @smallexample
5623 (set_attr "type" "load,store,arith")
5625 (set_attr_alternative "type"
5626                       [(const_string "load") (const_string "store")
5627                        (const_string "arith")])
5629 (set (attr "type")
5630      (cond [(eq_attr "alternative" "1") (const_string "load")
5631             (eq_attr "alternative" "2") (const_string "store")]
5632            (const_string "arith")))
5633 @end smallexample
5635 @need 1000
5636 @findex define_asm_attributes
5637 The @code{define_asm_attributes} expression provides a mechanism to
5638 specify the attributes assigned to insns produced from an @code{asm}
5639 statement.  It has the form:
5641 @smallexample
5642 (define_asm_attributes [@var{attr-sets}])
5643 @end smallexample
5645 @noindent
5646 where @var{attr-sets} is specified the same as for both the
5647 @code{define_insn} and the @code{define_peephole} expressions.
5649 These values will typically be the ``worst case'' attribute values.  For
5650 example, they might indicate that the condition code will be clobbered.
5652 A specification for a @code{length} attribute is handled specially.  The
5653 way to compute the length of an @code{asm} insn is to multiply the
5654 length specified in the expression @code{define_asm_attributes} by the
5655 number of machine instructions specified in the @code{asm} statement,
5656 determined by counting the number of semicolons and newlines in the
5657 string.  Therefore, the value of the @code{length} attribute specified
5658 in a @code{define_asm_attributes} should be the maximum possible length
5659 of a single machine instruction.
5661 @end ifset
5662 @ifset INTERNALS
5663 @node Attr Example
5664 @subsection Example of Attribute Specifications
5665 @cindex attribute specifications example
5666 @cindex attribute specifications
5668 The judicious use of defaulting is important in the efficient use of
5669 insn attributes.  Typically, insns are divided into @dfn{types} and an
5670 attribute, customarily called @code{type}, is used to represent this
5671 value.  This attribute is normally used only to define the default value
5672 for other attributes.  An example will clarify this usage.
5674 Assume we have a RISC machine with a condition code and in which only
5675 full-word operations are performed in registers.  Let us assume that we
5676 can divide all insns into loads, stores, (integer) arithmetic
5677 operations, floating point operations, and branches.
5679 Here we will concern ourselves with determining the effect of an insn on
5680 the condition code and will limit ourselves to the following possible
5681 effects:  The condition code can be set unpredictably (clobbered), not
5682 be changed, be set to agree with the results of the operation, or only
5683 changed if the item previously set into the condition code has been
5684 modified.
5686 Here is part of a sample @file{md} file for such a machine:
5688 @smallexample
5689 (define_attr "type" "load,store,arith,fp,branch" (const_string "arith"))
5691 (define_attr "cc" "clobber,unchanged,set,change0"
5692              (cond [(eq_attr "type" "load")
5693                         (const_string "change0")
5694                     (eq_attr "type" "store,branch")
5695                         (const_string "unchanged")
5696                     (eq_attr "type" "arith")
5697                         (if_then_else (match_operand:SI 0 "" "")
5698                                       (const_string "set")
5699                                       (const_string "clobber"))]
5700                    (const_string "clobber")))
5702 (define_insn ""
5703   [(set (match_operand:SI 0 "general_operand" "=r,r,m")
5704         (match_operand:SI 1 "general_operand" "r,m,r"))]
5705   ""
5706   "@@
5707    move %0,%1
5708    load %0,%1
5709    store %0,%1"
5710   [(set_attr "type" "arith,load,store")])
5711 @end smallexample
5713 Note that we assume in the above example that arithmetic operations
5714 performed on quantities smaller than a machine word clobber the condition
5715 code since they will set the condition code to a value corresponding to the
5716 full-word result.
5718 @end ifset
5719 @ifset INTERNALS
5720 @node Insn Lengths
5721 @subsection Computing the Length of an Insn
5722 @cindex insn lengths, computing
5723 @cindex computing the length of an insn
5725 For many machines, multiple types of branch instructions are provided, each
5726 for different length branch displacements.  In most cases, the assembler
5727 will choose the correct instruction to use.  However, when the assembler
5728 cannot do so, GCC can when a special attribute, the @code{length}
5729 attribute, is defined.  This attribute must be defined to have numeric
5730 values by specifying a null string in its @code{define_attr}.
5732 In the case of the @code{length} attribute, two additional forms of
5733 arithmetic terms are allowed in test expressions:
5735 @table @code
5736 @cindex @code{match_dup} and attributes
5737 @item (match_dup @var{n})
5738 This refers to the address of operand @var{n} of the current insn, which
5739 must be a @code{label_ref}.
5741 @cindex @code{pc} and attributes
5742 @item (pc)
5743 This refers to the address of the @emph{current} insn.  It might have
5744 been more consistent with other usage to make this the address of the
5745 @emph{next} insn but this would be confusing because the length of the
5746 current insn is to be computed.
5747 @end table
5749 @cindex @code{addr_vec}, length of
5750 @cindex @code{addr_diff_vec}, length of
5751 For normal insns, the length will be determined by value of the
5752 @code{length} attribute.  In the case of @code{addr_vec} and
5753 @code{addr_diff_vec} insn patterns, the length is computed as
5754 the number of vectors multiplied by the size of each vector.
5756 Lengths are measured in addressable storage units (bytes).
5758 The following macros can be used to refine the length computation:
5760 @table @code
5761 @findex ADJUST_INSN_LENGTH
5762 @item ADJUST_INSN_LENGTH (@var{insn}, @var{length})
5763 If defined, modifies the length assigned to instruction @var{insn} as a
5764 function of the context in which it is used.  @var{length} is an lvalue
5765 that contains the initially computed length of the insn and should be
5766 updated with the correct length of the insn.
5768 This macro will normally not be required.  A case in which it is
5769 required is the ROMP@.  On this machine, the size of an @code{addr_vec}
5770 insn must be increased by two to compensate for the fact that alignment
5771 may be required.
5772 @end table
5774 @findex get_attr_length
5775 The routine that returns @code{get_attr_length} (the value of the
5776 @code{length} attribute) can be used by the output routine to
5777 determine the form of the branch instruction to be written, as the
5778 example below illustrates.
5780 As an example of the specification of variable-length branches, consider
5781 the IBM 360.  If we adopt the convention that a register will be set to
5782 the starting address of a function, we can jump to labels within 4k of
5783 the start using a four-byte instruction.  Otherwise, we need a six-byte
5784 sequence to load the address from memory and then branch to it.
5786 On such a machine, a pattern for a branch instruction might be specified
5787 as follows:
5789 @smallexample
5790 (define_insn "jump"
5791   [(set (pc)
5792         (label_ref (match_operand 0 "" "")))]
5793   ""
5795    return (get_attr_length (insn) == 4
5796            ? "b %l0" : "l r15,=a(%l0); br r15");
5798   [(set (attr "length")
5799         (if_then_else (lt (match_dup 0) (const_int 4096))
5800                       (const_int 4)
5801                       (const_int 6)))])
5802 @end smallexample
5804 @end ifset
5805 @ifset INTERNALS
5806 @node Constant Attributes
5807 @subsection Constant Attributes
5808 @cindex constant attributes
5810 A special form of @code{define_attr}, where the expression for the
5811 default value is a @code{const} expression, indicates an attribute that
5812 is constant for a given run of the compiler.  Constant attributes may be
5813 used to specify which variety of processor is used.  For example,
5815 @smallexample
5816 (define_attr "cpu" "m88100,m88110,m88000"
5817  (const
5818   (cond [(symbol_ref "TARGET_88100") (const_string "m88100")
5819          (symbol_ref "TARGET_88110") (const_string "m88110")]
5820         (const_string "m88000"))))
5822 (define_attr "memory" "fast,slow"
5823  (const
5824   (if_then_else (symbol_ref "TARGET_FAST_MEM")
5825                 (const_string "fast")
5826                 (const_string "slow"))))
5827 @end smallexample
5829 The routine generated for constant attributes has no parameters as it
5830 does not depend on any particular insn.  RTL expressions used to define
5831 the value of a constant attribute may use the @code{symbol_ref} form,
5832 but may not use either the @code{match_operand} form or @code{eq_attr}
5833 forms involving insn attributes.
5835 @end ifset
5836 @ifset INTERNALS
5837 @node Delay Slots
5838 @subsection Delay Slot Scheduling
5839 @cindex delay slots, defining
5841 The insn attribute mechanism can be used to specify the requirements for
5842 delay slots, if any, on a target machine.  An instruction is said to
5843 require a @dfn{delay slot} if some instructions that are physically
5844 after the instruction are executed as if they were located before it.
5845 Classic examples are branch and call instructions, which often execute
5846 the following instruction before the branch or call is performed.
5848 On some machines, conditional branch instructions can optionally
5849 @dfn{annul} instructions in the delay slot.  This means that the
5850 instruction will not be executed for certain branch outcomes.  Both
5851 instructions that annul if the branch is true and instructions that
5852 annul if the branch is false are supported.
5854 Delay slot scheduling differs from instruction scheduling in that
5855 determining whether an instruction needs a delay slot is dependent only
5856 on the type of instruction being generated, not on data flow between the
5857 instructions.  See the next section for a discussion of data-dependent
5858 instruction scheduling.
5860 @findex define_delay
5861 The requirement of an insn needing one or more delay slots is indicated
5862 via the @code{define_delay} expression.  It has the following form:
5864 @smallexample
5865 (define_delay @var{test}
5866               [@var{delay-1} @var{annul-true-1} @var{annul-false-1}
5867                @var{delay-2} @var{annul-true-2} @var{annul-false-2}
5868                @dots{}])
5869 @end smallexample
5871 @var{test} is an attribute test that indicates whether this
5872 @code{define_delay} applies to a particular insn.  If so, the number of
5873 required delay slots is determined by the length of the vector specified
5874 as the second argument.  An insn placed in delay slot @var{n} must
5875 satisfy attribute test @var{delay-n}.  @var{annul-true-n} is an
5876 attribute test that specifies which insns may be annulled if the branch
5877 is true.  Similarly, @var{annul-false-n} specifies which insns in the
5878 delay slot may be annulled if the branch is false.  If annulling is not
5879 supported for that delay slot, @code{(nil)} should be coded.
5881 For example, in the common case where branch and call insns require
5882 a single delay slot, which may contain any insn other than a branch or
5883 call, the following would be placed in the @file{md} file:
5885 @smallexample
5886 (define_delay (eq_attr "type" "branch,call")
5887               [(eq_attr "type" "!branch,call") (nil) (nil)])
5888 @end smallexample
5890 Multiple @code{define_delay} expressions may be specified.  In this
5891 case, each such expression specifies different delay slot requirements
5892 and there must be no insn for which tests in two @code{define_delay}
5893 expressions are both true.
5895 For example, if we have a machine that requires one delay slot for branches
5896 but two for calls,  no delay slot can contain a branch or call insn,
5897 and any valid insn in the delay slot for the branch can be annulled if the
5898 branch is true, we might represent this as follows:
5900 @smallexample
5901 (define_delay (eq_attr "type" "branch")
5902    [(eq_attr "type" "!branch,call")
5903     (eq_attr "type" "!branch,call")
5904     (nil)])
5906 (define_delay (eq_attr "type" "call")
5907               [(eq_attr "type" "!branch,call") (nil) (nil)
5908                (eq_attr "type" "!branch,call") (nil) (nil)])
5909 @end smallexample
5910 @c the above is *still* too long.  --mew 4feb93
5912 @end ifset
5913 @ifset INTERNALS
5914 @node Processor pipeline description
5915 @subsection Specifying processor pipeline description
5916 @cindex processor pipeline description
5917 @cindex processor functional units
5918 @cindex instruction latency time
5919 @cindex interlock delays
5920 @cindex data dependence delays
5921 @cindex reservation delays
5922 @cindex pipeline hazard recognizer
5923 @cindex automaton based pipeline description
5924 @cindex regular expressions
5925 @cindex deterministic finite state automaton
5926 @cindex automaton based scheduler
5927 @cindex RISC
5928 @cindex VLIW
5930 To achieve better performance, most modern processors
5931 (super-pipelined, superscalar @acronym{RISC}, and @acronym{VLIW}
5932 processors) have many @dfn{functional units} on which several
5933 instructions can be executed simultaneously.  An instruction starts
5934 execution if its issue conditions are satisfied.  If not, the
5935 instruction is stalled until its conditions are satisfied.  Such
5936 @dfn{interlock (pipeline) delay} causes interruption of the fetching
5937 of successor instructions (or demands nop instructions, e.g.@: for some
5938 MIPS processors).
5940 There are two major kinds of interlock delays in modern processors.
5941 The first one is a data dependence delay determining @dfn{instruction
5942 latency time}.  The instruction execution is not started until all
5943 source data have been evaluated by prior instructions (there are more
5944 complex cases when the instruction execution starts even when the data
5945 are not available but will be ready in given time after the
5946 instruction execution start).  Taking the data dependence delays into
5947 account is simple.  The data dependence (true, output, and
5948 anti-dependence) delay between two instructions is given by a
5949 constant.  In most cases this approach is adequate.  The second kind
5950 of interlock delays is a reservation delay.  The reservation delay
5951 means that two instructions under execution will be in need of shared
5952 processors resources, i.e.@: buses, internal registers, and/or
5953 functional units, which are reserved for some time.  Taking this kind
5954 of delay into account is complex especially for modern @acronym{RISC}
5955 processors.
5957 The task of exploiting more processor parallelism is solved by an
5958 instruction scheduler.  For a better solution to this problem, the
5959 instruction scheduler has to have an adequate description of the
5960 processor parallelism (or @dfn{pipeline description}).  GCC
5961 machine descriptions describe processor parallelism and functional
5962 unit reservations for groups of instructions with the aid of
5963 @dfn{regular expressions}.
5965 The GCC instruction scheduler uses a @dfn{pipeline hazard recognizer} to
5966 figure out the possibility of the instruction issue by the processor
5967 on a given simulated processor cycle.  The pipeline hazard recognizer is
5968 automatically generated from the processor pipeline description.  The
5969 pipeline hazard recognizer generated from the machine description
5970 is based on a deterministic finite state automaton (@acronym{DFA}):
5971 the instruction issue is possible if there is a transition from one
5972 automaton state to another one.  This algorithm is very fast, and
5973 furthermore, its speed is not dependent on processor
5974 complexity@footnote{However, the size of the automaton depends on
5975   processor complexity.  To limit this effect, machine descriptions
5976   can split orthogonal parts of the machine description among several
5977   automata: but then, since each of these must be stepped independently,
5978   this does cause a small decrease in the algorithm's performance.}.
5980 @cindex automaton based pipeline description
5981 The rest of this section describes the directives that constitute
5982 an automaton-based processor pipeline description.  The order of
5983 these constructions within the machine description file is not
5984 important.
5986 @findex define_automaton
5987 @cindex pipeline hazard recognizer
5988 The following optional construction describes names of automata
5989 generated and used for the pipeline hazards recognition.  Sometimes
5990 the generated finite state automaton used by the pipeline hazard
5991 recognizer is large.  If we use more than one automaton and bind functional
5992 units to the automata, the total size of the automata is usually
5993 less than the size of the single automaton.  If there is no one such
5994 construction, only one finite state automaton is generated.
5996 @smallexample
5997 (define_automaton @var{automata-names})
5998 @end smallexample
6000 @var{automata-names} is a string giving names of the automata.  The
6001 names are separated by commas.  All the automata should have unique names.
6002 The automaton name is used in the constructions @code{define_cpu_unit} and
6003 @code{define_query_cpu_unit}.
6005 @findex define_cpu_unit
6006 @cindex processor functional units
6007 Each processor functional unit used in the description of instruction
6008 reservations should be described by the following construction.
6010 @smallexample
6011 (define_cpu_unit @var{unit-names} [@var{automaton-name}])
6012 @end smallexample
6014 @var{unit-names} is a string giving the names of the functional units
6015 separated by commas.  Don't use name @samp{nothing}, it is reserved
6016 for other goals.
6018 @var{automaton-name} is a string giving the name of the automaton with
6019 which the unit is bound.  The automaton should be described in
6020 construction @code{define_automaton}.  You should give
6021 @dfn{automaton-name}, if there is a defined automaton.
6023 The assignment of units to automata are constrained by the uses of the
6024 units in insn reservations.  The most important constraint is: if a
6025 unit reservation is present on a particular cycle of an alternative
6026 for an insn reservation, then some unit from the same automaton must
6027 be present on the same cycle for the other alternatives of the insn
6028 reservation.  The rest of the constraints are mentioned in the
6029 description of the subsequent constructions.
6031 @findex define_query_cpu_unit
6032 @cindex querying function unit reservations
6033 The following construction describes CPU functional units analogously
6034 to @code{define_cpu_unit}.  The reservation of such units can be
6035 queried for an automaton state.  The instruction scheduler never
6036 queries reservation of functional units for given automaton state.  So
6037 as a rule, you don't need this construction.  This construction could
6038 be used for future code generation goals (e.g.@: to generate
6039 @acronym{VLIW} insn templates).
6041 @smallexample
6042 (define_query_cpu_unit @var{unit-names} [@var{automaton-name}])
6043 @end smallexample
6045 @var{unit-names} is a string giving names of the functional units
6046 separated by commas.
6048 @var{automaton-name} is a string giving the name of the automaton with
6049 which the unit is bound.
6051 @findex define_insn_reservation
6052 @cindex instruction latency time
6053 @cindex regular expressions
6054 @cindex data bypass
6055 The following construction is the major one to describe pipeline
6056 characteristics of an instruction.
6058 @smallexample
6059 (define_insn_reservation @var{insn-name} @var{default_latency}
6060                          @var{condition} @var{regexp})
6061 @end smallexample
6063 @var{default_latency} is a number giving latency time of the
6064 instruction.  There is an important difference between the old
6065 description and the automaton based pipeline description.  The latency
6066 time is used for all dependencies when we use the old description.  In
6067 the automaton based pipeline description, the given latency time is only
6068 used for true dependencies.  The cost of anti-dependencies is always
6069 zero and the cost of output dependencies is the difference between
6070 latency times of the producing and consuming insns (if the difference
6071 is negative, the cost is considered to be zero).  You can always
6072 change the default costs for any description by using the target hook
6073 @code{TARGET_SCHED_ADJUST_COST} (@pxref{Scheduling}).
6075 @var{insn-name} is a string giving the internal name of the insn.  The
6076 internal names are used in constructions @code{define_bypass} and in
6077 the automaton description file generated for debugging.  The internal
6078 name has nothing in common with the names in @code{define_insn}.  It is a
6079 good practice to use insn classes described in the processor manual.
6081 @var{condition} defines what RTL insns are described by this
6082 construction.  You should remember that you will be in trouble if
6083 @var{condition} for two or more different
6084 @code{define_insn_reservation} constructions is TRUE for an insn.  In
6085 this case what reservation will be used for the insn is not defined.
6086 Such cases are not checked during generation of the pipeline hazards
6087 recognizer because in general recognizing that two conditions may have
6088 the same value is quite difficult (especially if the conditions
6089 contain @code{symbol_ref}).  It is also not checked during the
6090 pipeline hazard recognizer work because it would slow down the
6091 recognizer considerably.
6093 @var{regexp} is a string describing the reservation of the cpu's functional
6094 units by the instruction.  The reservations are described by a regular
6095 expression according to the following syntax:
6097 @smallexample
6098        regexp = regexp "," oneof
6099               | oneof
6101        oneof = oneof "|" allof
6102              | allof
6104        allof = allof "+" repeat
6105              | repeat
6107        repeat = element "*" number
6108               | element
6110        element = cpu_function_unit_name
6111                | reservation_name
6112                | result_name
6113                | "nothing"
6114                | "(" regexp ")"
6115 @end smallexample
6117 @itemize @bullet
6118 @item
6119 @samp{,} is used for describing the start of the next cycle in
6120 the reservation.
6122 @item
6123 @samp{|} is used for describing a reservation described by the first
6124 regular expression @strong{or} a reservation described by the second
6125 regular expression @strong{or} etc.
6127 @item
6128 @samp{+} is used for describing a reservation described by the first
6129 regular expression @strong{and} a reservation described by the
6130 second regular expression @strong{and} etc.
6132 @item
6133 @samp{*} is used for convenience and simply means a sequence in which
6134 the regular expression are repeated @var{number} times with cycle
6135 advancing (see @samp{,}).
6137 @item
6138 @samp{cpu_function_unit_name} denotes reservation of the named
6139 functional unit.
6141 @item
6142 @samp{reservation_name} --- see description of construction
6143 @samp{define_reservation}.
6145 @item
6146 @samp{nothing} denotes no unit reservations.
6147 @end itemize
6149 @findex define_reservation
6150 Sometimes unit reservations for different insns contain common parts.
6151 In such case, you can simplify the pipeline description by describing
6152 the common part by the following construction
6154 @smallexample
6155 (define_reservation @var{reservation-name} @var{regexp})
6156 @end smallexample
6158 @var{reservation-name} is a string giving name of @var{regexp}.
6159 Functional unit names and reservation names are in the same name
6160 space.  So the reservation names should be different from the
6161 functional unit names and can not be the reserved name @samp{nothing}.
6163 @findex define_bypass
6164 @cindex instruction latency time
6165 @cindex data bypass
6166 The following construction is used to describe exceptions in the
6167 latency time for given instruction pair.  This is so called bypasses.
6169 @smallexample
6170 (define_bypass @var{number} @var{out_insn_names} @var{in_insn_names}
6171                [@var{guard}])
6172 @end smallexample
6174 @var{number} defines when the result generated by the instructions
6175 given in string @var{out_insn_names} will be ready for the
6176 instructions given in string @var{in_insn_names}.  The instructions in
6177 the string are separated by commas.
6179 @var{guard} is an optional string giving the name of a C function which
6180 defines an additional guard for the bypass.  The function will get the
6181 two insns as parameters.  If the function returns zero the bypass will
6182 be ignored for this case.  The additional guard is necessary to
6183 recognize complicated bypasses, e.g.@: when the consumer is only an address
6184 of insn @samp{store} (not a stored value).
6186 @findex exclusion_set
6187 @findex presence_set
6188 @findex final_presence_set
6189 @findex absence_set
6190 @findex final_absence_set
6191 @cindex VLIW
6192 @cindex RISC
6193 The following five constructions are usually used to describe
6194 @acronym{VLIW} processors, or more precisely, to describe a placement
6195 of small instructions into @acronym{VLIW} instruction slots.  They
6196 can be used for @acronym{RISC} processors, too.
6198 @smallexample
6199 (exclusion_set @var{unit-names} @var{unit-names})
6200 (presence_set @var{unit-names} @var{patterns})
6201 (final_presence_set @var{unit-names} @var{patterns})
6202 (absence_set @var{unit-names} @var{patterns})
6203 (final_absence_set @var{unit-names} @var{patterns})
6204 @end smallexample
6206 @var{unit-names} is a string giving names of functional units
6207 separated by commas.
6209 @var{patterns} is a string giving patterns of functional units
6210 separated by comma.  Currently pattern is one unit or units
6211 separated by white-spaces.
6213 The first construction (@samp{exclusion_set}) means that each
6214 functional unit in the first string can not be reserved simultaneously
6215 with a unit whose name is in the second string and vice versa.  For
6216 example, the construction is useful for describing processors
6217 (e.g.@: some SPARC processors) with a fully pipelined floating point
6218 functional unit which can execute simultaneously only single floating
6219 point insns or only double floating point insns.
6221 The second construction (@samp{presence_set}) means that each
6222 functional unit in the first string can not be reserved unless at
6223 least one of pattern of units whose names are in the second string is
6224 reserved.  This is an asymmetric relation.  For example, it is useful
6225 for description that @acronym{VLIW} @samp{slot1} is reserved after
6226 @samp{slot0} reservation.  We could describe it by the following
6227 construction
6229 @smallexample
6230 (presence_set "slot1" "slot0")
6231 @end smallexample
6233 Or @samp{slot1} is reserved only after @samp{slot0} and unit @samp{b0}
6234 reservation.  In this case we could write
6236 @smallexample
6237 (presence_set "slot1" "slot0 b0")
6238 @end smallexample
6240 The third construction (@samp{final_presence_set}) is analogous to
6241 @samp{presence_set}.  The difference between them is when checking is
6242 done.  When an instruction is issued in given automaton state
6243 reflecting all current and planned unit reservations, the automaton
6244 state is changed.  The first state is a source state, the second one
6245 is a result state.  Checking for @samp{presence_set} is done on the
6246 source state reservation, checking for @samp{final_presence_set} is
6247 done on the result reservation.  This construction is useful to
6248 describe a reservation which is actually two subsequent reservations.
6249 For example, if we use
6251 @smallexample
6252 (presence_set "slot1" "slot0")
6253 @end smallexample
6255 the following insn will be never issued (because @samp{slot1} requires
6256 @samp{slot0} which is absent in the source state).
6258 @smallexample
6259 (define_reservation "insn_and_nop" "slot0 + slot1")
6260 @end smallexample
6262 but it can be issued if we use analogous @samp{final_presence_set}.
6264 The forth construction (@samp{absence_set}) means that each functional
6265 unit in the first string can be reserved only if each pattern of units
6266 whose names are in the second string is not reserved.  This is an
6267 asymmetric relation (actually @samp{exclusion_set} is analogous to
6268 this one but it is symmetric).  For example, it is useful for
6269 description that @acronym{VLIW} @samp{slot0} can not be reserved after
6270 @samp{slot1} or @samp{slot2} reservation.  We could describe it by the
6271 following construction
6273 @smallexample
6274 (absence_set "slot2" "slot0, slot1")
6275 @end smallexample
6277 Or @samp{slot2} can not be reserved if @samp{slot0} and unit @samp{b0}
6278 are reserved or @samp{slot1} and unit @samp{b1} are reserved.  In
6279 this case we could write
6281 @smallexample
6282 (absence_set "slot2" "slot0 b0, slot1 b1")
6283 @end smallexample
6285 All functional units mentioned in a set should belong to the same
6286 automaton.
6288 The last construction (@samp{final_absence_set}) is analogous to
6289 @samp{absence_set} but checking is done on the result (state)
6290 reservation.  See comments for @samp{final_presence_set}.
6292 @findex automata_option
6293 @cindex deterministic finite state automaton
6294 @cindex nondeterministic finite state automaton
6295 @cindex finite state automaton minimization
6296 You can control the generator of the pipeline hazard recognizer with
6297 the following construction.
6299 @smallexample
6300 (automata_option @var{options})
6301 @end smallexample
6303 @var{options} is a string giving options which affect the generated
6304 code.  Currently there are the following options:
6306 @itemize @bullet
6307 @item
6308 @dfn{no-minimization} makes no minimization of the automaton.  This is
6309 only worth to do when we are debugging the description and need to
6310 look more accurately at reservations of states.
6312 @item
6313 @dfn{time} means printing additional time statistics about
6314 generation of automata.
6316 @item
6317 @dfn{v} means a generation of the file describing the result automata.
6318 The file has suffix @samp{.dfa} and can be used for the description
6319 verification and debugging.
6321 @item
6322 @dfn{w} means a generation of warning instead of error for
6323 non-critical errors.
6325 @item
6326 @dfn{ndfa} makes nondeterministic finite state automata.  This affects
6327 the treatment of operator @samp{|} in the regular expressions.  The
6328 usual treatment of the operator is to try the first alternative and,
6329 if the reservation is not possible, the second alternative.  The
6330 nondeterministic treatment means trying all alternatives, some of them
6331 may be rejected by reservations in the subsequent insns.  You can not
6332 query functional unit reservations in nondeterministic automaton
6333 states.
6335 @item
6336 @dfn{progress} means output of a progress bar showing how many states
6337 were generated so far for automaton being processed.  This is useful
6338 during debugging a @acronym{DFA} description.  If you see too many
6339 generated states, you could interrupt the generator of the pipeline
6340 hazard recognizer and try to figure out a reason for generation of the
6341 huge automaton.
6342 @end itemize
6344 As an example, consider a superscalar @acronym{RISC} machine which can
6345 issue three insns (two integer insns and one floating point insn) on
6346 the cycle but can finish only two insns.  To describe this, we define
6347 the following functional units.
6349 @smallexample
6350 (define_cpu_unit "i0_pipeline, i1_pipeline, f_pipeline")
6351 (define_cpu_unit "port0, port1")
6352 @end smallexample
6354 All simple integer insns can be executed in any integer pipeline and
6355 their result is ready in two cycles.  The simple integer insns are
6356 issued into the first pipeline unless it is reserved, otherwise they
6357 are issued into the second pipeline.  Integer division and
6358 multiplication insns can be executed only in the second integer
6359 pipeline and their results are ready correspondingly in 8 and 4
6360 cycles.  The integer division is not pipelined, i.e.@: the subsequent
6361 integer division insn can not be issued until the current division
6362 insn finished.  Floating point insns are fully pipelined and their
6363 results are ready in 3 cycles.  Where the result of a floating point
6364 insn is used by an integer insn, an additional delay of one cycle is
6365 incurred.  To describe all of this we could specify
6367 @smallexample
6368 (define_cpu_unit "div")
6370 (define_insn_reservation "simple" 2 (eq_attr "type" "int")
6371                          "(i0_pipeline | i1_pipeline), (port0 | port1)")
6373 (define_insn_reservation "mult" 4 (eq_attr "type" "mult")
6374                          "i1_pipeline, nothing*2, (port0 | port1)")
6376 (define_insn_reservation "div" 8 (eq_attr "type" "div")
6377                          "i1_pipeline, div*7, div + (port0 | port1)")
6379 (define_insn_reservation "float" 3 (eq_attr "type" "float")
6380                          "f_pipeline, nothing, (port0 | port1))
6382 (define_bypass 4 "float" "simple,mult,div")
6383 @end smallexample
6385 To simplify the description we could describe the following reservation
6387 @smallexample
6388 (define_reservation "finish" "port0|port1")
6389 @end smallexample
6391 and use it in all @code{define_insn_reservation} as in the following
6392 construction
6394 @smallexample
6395 (define_insn_reservation "simple" 2 (eq_attr "type" "int")
6396                          "(i0_pipeline | i1_pipeline), finish")
6397 @end smallexample
6400 @end ifset
6401 @ifset INTERNALS
6402 @node Conditional Execution
6403 @section Conditional Execution
6404 @cindex conditional execution
6405 @cindex predication
6407 A number of architectures provide for some form of conditional
6408 execution, or predication.  The hallmark of this feature is the
6409 ability to nullify most of the instructions in the instruction set.
6410 When the instruction set is large and not entirely symmetric, it
6411 can be quite tedious to describe these forms directly in the
6412 @file{.md} file.  An alternative is the @code{define_cond_exec} template.
6414 @findex define_cond_exec
6415 @smallexample
6416 (define_cond_exec
6417   [@var{predicate-pattern}]
6418   "@var{condition}"
6419   "@var{output-template}")
6420 @end smallexample
6422 @var{predicate-pattern} is the condition that must be true for the
6423 insn to be executed at runtime and should match a relational operator.
6424 One can use @code{match_operator} to match several relational operators
6425 at once.  Any @code{match_operand} operands must have no more than one
6426 alternative.
6428 @var{condition} is a C expression that must be true for the generated
6429 pattern to match.
6431 @findex current_insn_predicate
6432 @var{output-template} is a string similar to the @code{define_insn}
6433 output template (@pxref{Output Template}), except that the @samp{*}
6434 and @samp{@@} special cases do not apply.  This is only useful if the
6435 assembly text for the predicate is a simple prefix to the main insn.
6436 In order to handle the general case, there is a global variable
6437 @code{current_insn_predicate} that will contain the entire predicate
6438 if the current insn is predicated, and will otherwise be @code{NULL}.
6440 When @code{define_cond_exec} is used, an implicit reference to
6441 the @code{predicable} instruction attribute is made.
6442 @xref{Insn Attributes}.  This attribute must be boolean (i.e.@: have
6443 exactly two elements in its @var{list-of-values}).  Further, it must
6444 not be used with complex expressions.  That is, the default and all
6445 uses in the insns must be a simple constant, not dependent on the
6446 alternative or anything else.
6448 For each @code{define_insn} for which the @code{predicable}
6449 attribute is true, a new @code{define_insn} pattern will be
6450 generated that matches a predicated version of the instruction.
6451 For example,
6453 @smallexample
6454 (define_insn "addsi"
6455   [(set (match_operand:SI 0 "register_operand" "r")
6456         (plus:SI (match_operand:SI 1 "register_operand" "r")
6457                  (match_operand:SI 2 "register_operand" "r")))]
6458   "@var{test1}"
6459   "add %2,%1,%0")
6461 (define_cond_exec
6462   [(ne (match_operand:CC 0 "register_operand" "c")
6463        (const_int 0))]
6464   "@var{test2}"
6465   "(%0)")
6466 @end smallexample
6468 @noindent
6469 generates a new pattern
6471 @smallexample
6472 (define_insn ""
6473   [(cond_exec
6474      (ne (match_operand:CC 3 "register_operand" "c") (const_int 0))
6475      (set (match_operand:SI 0 "register_operand" "r")
6476           (plus:SI (match_operand:SI 1 "register_operand" "r")
6477                    (match_operand:SI 2 "register_operand" "r"))))]
6478   "(@var{test2}) && (@var{test1})"
6479   "(%3) add %2,%1,%0")
6480 @end smallexample
6482 @end ifset
6483 @ifset INTERNALS
6484 @node Constant Definitions
6485 @section Constant Definitions
6486 @cindex constant definitions
6487 @findex define_constants
6489 Using literal constants inside instruction patterns reduces legibility and
6490 can be a maintenance problem.
6492 To overcome this problem, you may use the @code{define_constants}
6493 expression.  It contains a vector of name-value pairs.  From that
6494 point on, wherever any of the names appears in the MD file, it is as
6495 if the corresponding value had been written instead.  You may use
6496 @code{define_constants} multiple times; each appearance adds more
6497 constants to the table.  It is an error to redefine a constant with
6498 a different value.
6500 To come back to the a29k load multiple example, instead of
6502 @smallexample
6503 (define_insn ""
6504   [(match_parallel 0 "load_multiple_operation"
6505      [(set (match_operand:SI 1 "gpc_reg_operand" "=r")
6506            (match_operand:SI 2 "memory_operand" "m"))
6507       (use (reg:SI 179))
6508       (clobber (reg:SI 179))])]
6509   ""
6510   "loadm 0,0,%1,%2")
6511 @end smallexample
6513 You could write:
6515 @smallexample
6516 (define_constants [
6517     (R_BP 177)
6518     (R_FC 178)
6519     (R_CR 179)
6520     (R_Q  180)
6523 (define_insn ""
6524   [(match_parallel 0 "load_multiple_operation"
6525      [(set (match_operand:SI 1 "gpc_reg_operand" "=r")
6526            (match_operand:SI 2 "memory_operand" "m"))
6527       (use (reg:SI R_CR))
6528       (clobber (reg:SI R_CR))])]
6529   ""
6530   "loadm 0,0,%1,%2")
6531 @end smallexample
6533 The constants that are defined with a define_constant are also output
6534 in the insn-codes.h header file as #defines.
6535 @end ifset
6536 @ifset INTERNALS
6537 @node Macros
6538 @section Macros
6539 @cindex macros in @file{.md} files
6541 Ports often need to define similar patterns for more than one machine
6542 mode or for more than one rtx code.  GCC provides some simple macro
6543 facilities to make this process easier.
6545 @menu
6546 * Mode Macros::         Generating variations of patterns for different modes.
6547 * Code Macros::         Doing the same for codes.
6548 @end menu
6550 @node Mode Macros
6551 @subsection Mode Macros
6552 @cindex mode macros in @file{.md} files
6554 Ports often need to define similar patterns for two or more different modes.
6555 For example:
6557 @itemize @bullet
6558 @item
6559 If a processor has hardware support for both single and double
6560 floating-point arithmetic, the @code{SFmode} patterns tend to be
6561 very similar to the @code{DFmode} ones.
6563 @item
6564 If a port uses @code{SImode} pointers in one configuration and
6565 @code{DImode} pointers in another, it will usually have very similar
6566 @code{SImode} and @code{DImode} patterns for manipulating pointers.
6567 @end itemize
6569 Mode macros allow several patterns to be instantiated from one
6570 @file{.md} file template.  They can be used with any type of
6571 rtx-based construct, such as a @code{define_insn},
6572 @code{define_split}, or @code{define_peephole2}.
6574 @menu
6575 * Defining Mode Macros:: Defining a new mode macro.
6576 * String Substitutions:: Combining mode macros with string substitutions
6577 * Examples::             Examples
6578 @end menu
6580 @node Defining Mode Macros
6581 @subsubsection Defining Mode Macros
6582 @findex define_mode_macro
6584 The syntax for defining a mode macro is:
6586 @smallexample
6587 (define_mode_macro @var{name} [(@var{mode1} "@var{cond1}") ... (@var{moden} "@var{condn}")])
6588 @end smallexample
6590 This allows subsequent @file{.md} file constructs to use the mode suffix
6591 @code{:@var{name}}.  Every construct that does so will be expanded
6592 @var{n} times, once with every use of @code{:@var{name}} replaced by
6593 @code{:@var{mode1}}, once with every use replaced by @code{:@var{mode2}},
6594 and so on.  In the expansion for a particular @var{modei}, every
6595 C condition will also require that @var{condi} be true.
6597 For example:
6599 @smallexample
6600 (define_mode_macro P [(SI "Pmode == SImode") (DI "Pmode == DImode")])
6601 @end smallexample
6603 defines a new mode suffix @code{:P}.  Every construct that uses
6604 @code{:P} will be expanded twice, once with every @code{:P} replaced
6605 by @code{:SI} and once with every @code{:P} replaced by @code{:DI}.
6606 The @code{:SI} version will only apply if @code{Pmode == SImode} and
6607 the @code{:DI} version will only apply if @code{Pmode == DImode}.
6609 As with other @file{.md} conditions, an empty string is treated
6610 as ``always true''.  @code{(@var{mode} "")} can also be abbreviated
6611 to @code{@var{mode}}.  For example:
6613 @smallexample
6614 (define_mode_macro GPR [SI (DI "TARGET_64BIT")])
6615 @end smallexample
6617 means that the @code{:DI} expansion only applies if @code{TARGET_64BIT}
6618 but that the @code{:SI} expansion has no such constraint.
6620 Macros are applied in the order they are defined.  This can be
6621 significant if two macros are used in a construct that requires
6622 string substitutions.  @xref{String Substitutions}.
6624 @node String Substitutions
6625 @subsubsection String Substitution in Mode Macros
6626 @findex define_mode_attr
6628 If an @file{.md} file construct uses mode macros, each version of the
6629 construct will often need slightly different strings.  For example:
6631 @itemize @bullet
6632 @item
6633 When a @code{define_expand} defines several @code{add@var{m}3} patterns
6634 (@pxref{Standard Names}), each expander will need to use the
6635 appropriate mode name for @var{m}.
6637 @item
6638 When a @code{define_insn} defines several instruction patterns,
6639 each instruction will often use a different assembler mnemonic.
6640 @end itemize
6642 GCC supports such variations through a system of ``mode attributes''.
6643 There are two standard attributes: @code{mode}, which is the name of
6644 the mode in lower case, and @code{MODE}, which is the same thing in
6645 upper case.  You can define other attributes using:
6647 @smallexample
6648 (define_mode_attr @var{name} [(@var{mode1} "@var{value1}") ... (@var{moden} "@var{valuen}")])
6649 @end smallexample
6651 where @var{name} is the name of the attribute and @var{valuei}
6652 is the value associated with @var{modei}.
6654 When GCC replaces some @var{:macro} with @var{:mode}, it will
6655 scan each string in the pattern for sequences of the form
6656 @code{<@var{macro}:@var{attr}>}, where @var{attr} is the name of
6657 a mode attribute.  If the attribute is defined for @var{mode}, the
6658 whole @code{<...>} sequence will be replaced by the appropriate
6659 attribute value.
6661 For example, suppose an @file{.md} file has:
6663 @smallexample
6664 (define_mode_macro P [(SI "Pmode == SImode") (DI "Pmode == DImode")])
6665 (define_mode_attr load [(SI "lw") (DI "ld")])
6666 @end smallexample
6668 If one of the patterns that uses @code{:P} contains the string
6669 @code{"<P:load>\t%0,%1"}, the @code{SI} version of that pattern
6670 will use @code{"lw\t%0,%1"} and the @code{DI} version will use
6671 @code{"ld\t%0,%1"}.
6673 The @code{@var{macro}:} prefix may be omitted, in which case the
6674 substitution will be attempted for every macro expansion.
6676 @node Examples
6677 @subsubsection Mode Macro Examples
6679 Here is an example from the MIPS port.  It defines the following
6680 modes and attributes (among others):
6682 @smallexample
6683 (define_mode_macro GPR [SI (DI "TARGET_64BIT")])
6684 (define_mode_attr d [(SI "") (DI "d")])
6685 @end smallexample
6687 and uses the following template to define both @code{subsi3}
6688 and @code{subdi3}:
6690 @smallexample
6691 (define_insn "sub<mode>3"
6692   [(set (match_operand:GPR 0 "register_operand" "=d")
6693         (minus:GPR (match_operand:GPR 1 "register_operand" "d")
6694                    (match_operand:GPR 2 "register_operand" "d")))]
6695   ""
6696   "<d>subu\t%0,%1,%2"
6697   [(set_attr "type" "arith")
6698    (set_attr "mode" "<MODE>")])
6699 @end smallexample
6701 This is exactly equivalent to:
6703 @smallexample
6704 (define_insn "subsi3"
6705   [(set (match_operand:SI 0 "register_operand" "=d")
6706         (minus:SI (match_operand:SI 1 "register_operand" "d")
6707                   (match_operand:SI 2 "register_operand" "d")))]
6708   ""
6709   "subu\t%0,%1,%2"
6710   [(set_attr "type" "arith")
6711    (set_attr "mode" "SI")])
6713 (define_insn "subdi3"
6714   [(set (match_operand:DI 0 "register_operand" "=d")
6715         (minus:DI (match_operand:DI 1 "register_operand" "d")
6716                   (match_operand:DI 2 "register_operand" "d")))]
6717   ""
6718   "dsubu\t%0,%1,%2"
6719   [(set_attr "type" "arith")
6720    (set_attr "mode" "DI")])
6721 @end smallexample
6723 @node Code Macros
6724 @subsection Code Macros
6725 @cindex code macros in @file{.md} files
6726 @findex define_code_macro
6727 @findex define_code_attr
6729 Code macros operate in a similar way to mode macros.  @xref{Mode Macros}.
6731 The construct:
6733 @smallexample
6734 (define_code_macro @var{name} [(@var{code1} "@var{cond1}") ... (@var{coden} "@var{condn}")])
6735 @end smallexample
6737 defines a pseudo rtx code @var{name} that can be instantiated as
6738 @var{codei} if condition @var{condi} is true.  Each @var{codei}
6739 must have the same rtx format.  @xref{RTL Classes}.
6741 As with mode macros, each pattern that uses @var{name} will be
6742 expanded @var{n} times, once with all uses of @var{name} replaced by
6743 @var{code1}, once with all uses replaced by @var{code2}, and so on.
6744 @xref{Defining Mode Macros}.
6746 It is possible to define attributes for codes as well as for modes.
6747 There are two standard code attributes: @code{code}, the name of the
6748 code in lower case, and @code{CODE}, the name of the code in upper case.
6749 Other attributes are defined using:
6751 @smallexample
6752 (define_code_attr @var{name} [(@var{code1} "@var{value1}") ... (@var{coden} "@var{valuen}")])
6753 @end smallexample
6755 Here's an example of code macros in action, taken from the MIPS port:
6757 @smallexample
6758 (define_code_macro any_cond [unordered ordered unlt unge uneq ltgt unle ungt
6759                              eq ne gt ge lt le gtu geu ltu leu])
6761 (define_expand "b<code>"
6762   [(set (pc)
6763         (if_then_else (any_cond:CC (cc0)
6764                                    (const_int 0))
6765                       (label_ref (match_operand 0 ""))
6766                       (pc)))]
6767   ""
6769   gen_conditional_branch (operands, <CODE>);
6770   DONE;
6772 @end smallexample
6774 This is equivalent to:
6776 @smallexample
6777 (define_expand "bunordered"
6778   [(set (pc)
6779         (if_then_else (unordered:CC (cc0)
6780                                     (const_int 0))
6781                       (label_ref (match_operand 0 ""))
6782                       (pc)))]
6783   ""
6785   gen_conditional_branch (operands, UNORDERED);
6786   DONE;
6789 (define_expand "bordered"
6790   [(set (pc)
6791         (if_then_else (ordered:CC (cc0)
6792                                   (const_int 0))
6793                       (label_ref (match_operand 0 ""))
6794                       (pc)))]
6795   ""
6797   gen_conditional_branch (operands, ORDERED);
6798   DONE;
6802 @end smallexample
6804 @end ifset