Fix typos in comment
[official-gcc.git] / gcc / recog.h
blob465013a73070485c2b39139986420128571ed832
1 /* Declarations for interface to insn recognizer and insn-output.c.
2 Copyright (C) 1987, 1996, 1997, 1998,
3 1999, 2000 Free Software Foundation, Inc.
5 This file is part of GNU CC.
7 GNU CC is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
12 GNU CC is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU CC; see the file COPYING. If not, write to
19 the Free Software Foundation, 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 /* Random number that should be large enough for all purposes. */
23 #define MAX_RECOG_ALTERNATIVES 30
25 /* Types of operands. */
26 enum op_type {
27 OP_IN,
28 OP_OUT,
29 OP_INOUT
32 struct operand_alternative
34 /* Pointer to the beginning of the constraint string for this alternative,
35 for easier access by alternative number. */
36 const char *constraint;
38 /* The register class valid for this alternative (possibly NO_REGS). */
39 enum reg_class class;
41 /* "Badness" of this alternative, computed from number of '?' and '!'
42 characters in the constraint string. */
43 unsigned int reject;
45 /* -1 if no matching constraint was found, or an operand number. */
46 int matches;
47 /* The same information, but reversed: -1 if this operand is not
48 matched by any other, or the operand number of the operand that
49 matches this one. */
50 int matched;
52 /* Nonzero if '&' was found in the constraint string. */
53 unsigned int earlyclobber:1;
54 /* Nonzero if 'm' was found in the constraint string. */
55 unsigned int memory_ok:1;
56 /* Nonzero if 'o' was found in the constraint string. */
57 unsigned int offmem_ok:1;
58 /* Nonzero if 'V' was found in the constraint string. */
59 unsigned int nonoffmem_ok:1;
60 /* Nonzero if '<' was found in the constraint string. */
61 unsigned int decmem_ok:1;
62 /* Nonzero if '>' was found in the constraint string. */
63 unsigned int incmem_ok:1;
64 /* Nonzero if 'X' was found in the constraint string, or if the constraint
65 string for this alternative was empty. */
66 unsigned int anything_ok:1;
70 extern void init_recog PARAMS ((void));
71 extern void init_recog_no_volatile PARAMS ((void));
72 extern int recog_memoized PARAMS ((rtx));
73 extern int check_asm_operands PARAMS ((rtx));
74 extern int asm_operand_ok PARAMS ((rtx, const char *));
75 extern int validate_change PARAMS ((rtx, rtx *, rtx, int));
76 extern int apply_change_group PARAMS ((void));
77 extern int num_validated_changes PARAMS ((void));
78 extern void cancel_changes PARAMS ((int));
79 extern int constrain_operands PARAMS ((int));
80 extern int memory_address_p PARAMS ((enum machine_mode, rtx));
81 extern int strict_memory_address_p PARAMS ((enum machine_mode, rtx));
82 extern int validate_replace_rtx PARAMS ((rtx, rtx, rtx));
83 extern void validate_replace_rtx_group PARAMS ((rtx, rtx, rtx));
84 extern int validate_replace_src PARAMS ((rtx, rtx, rtx));
85 #ifdef HAVE_cc0
86 extern int next_insn_tests_no_inequality PARAMS ((rtx));
87 #endif
88 extern int reg_fits_class_p PARAMS ((rtx, enum reg_class, int,
89 enum machine_mode));
90 extern rtx *find_single_use PARAMS ((rtx, rtx, rtx *));
92 extern int general_operand PARAMS ((rtx, enum machine_mode));
93 extern int address_operand PARAMS ((rtx, enum machine_mode));
94 extern int register_operand PARAMS ((rtx, enum machine_mode));
95 extern int pmode_register_operand PARAMS ((rtx, enum machine_mode));
96 extern int scratch_operand PARAMS ((rtx, enum machine_mode));
97 extern int immediate_operand PARAMS ((rtx, enum machine_mode));
98 extern int const_int_operand PARAMS ((rtx, enum machine_mode));
99 extern int const_double_operand PARAMS ((rtx, enum machine_mode));
100 extern int nonimmediate_operand PARAMS ((rtx, enum machine_mode));
101 extern int nonmemory_operand PARAMS ((rtx, enum machine_mode));
102 extern int push_operand PARAMS ((rtx, enum machine_mode));
103 extern int pop_operand PARAMS ((rtx, enum machine_mode));
104 extern int memory_operand PARAMS ((rtx, enum machine_mode));
105 extern int indirect_operand PARAMS ((rtx, enum machine_mode));
106 extern int mode_independent_operand PARAMS ((rtx, enum machine_mode));
107 extern int comparison_operator PARAMS ((rtx, enum machine_mode));
109 extern int offsettable_memref_p PARAMS ((rtx));
110 extern int offsettable_nonstrict_memref_p PARAMS ((rtx));
111 extern int offsettable_address_p PARAMS ((int, enum machine_mode, rtx));
112 extern int mode_dependent_address_p PARAMS ((rtx));
114 extern int recog PARAMS ((rtx, rtx, int *));
115 extern void add_clobbers PARAMS ((rtx, int));
116 extern void insn_extract PARAMS ((rtx));
117 extern void extract_insn PARAMS ((rtx));
118 extern void preprocess_constraints PARAMS ((void));
119 extern rtx peep2_next_insn PARAMS ((int));
120 extern int peep2_regno_dead_p PARAMS ((int, int));
121 extern int peep2_reg_dead_p PARAMS ((int, rtx));
122 #ifdef CLEAR_HARD_REG_SET
123 extern rtx peep2_find_free_register PARAMS ((int, int, const char *,
124 enum machine_mode,
125 HARD_REG_SET *));
126 #endif
127 extern void peephole2_optimize PARAMS ((FILE *));
128 extern rtx peephole2_insns PARAMS ((rtx, rtx, int *));
130 /* Nonzero means volatile operands are recognized. */
131 extern int volatile_ok;
133 /* Set by constrain_operands to the number of the alternative that
134 matched. */
135 extern int which_alternative;
137 /* The following vectors hold the results from insn_extract. */
139 struct recog_data
141 /* It is very tempting to make the 5 operand related arrays into a
142 structure and index on that. However, to be source compatible
143 with all of the existing md file insn constraints and output
144 templates, we need `operand' as a flat array. Without that
145 member, making an array for the rest seems pointless. */
147 /* Gives value of operand N. */
148 rtx operand[MAX_RECOG_OPERANDS];
150 /* Gives location where operand N was found. */
151 rtx *operand_loc[MAX_RECOG_OPERANDS];
153 /* Gives the constraint string for operand N. */
154 const char *constraints[MAX_RECOG_OPERANDS];
156 /* Gives the mode of operand N. */
157 enum machine_mode operand_mode[MAX_RECOG_OPERANDS];
159 /* Gives the type (in, out, inout) for operand N. */
160 enum op_type operand_type[MAX_RECOG_OPERANDS];
162 /* Gives location where the Nth duplicate-appearance of an operand
163 was found. This is something that matched MATCH_DUP. */
164 rtx *dup_loc[MAX_DUP_OPERANDS];
166 /* Gives the operand number that was duplicated in the Nth
167 duplicate-appearance of an operand. */
168 char dup_num[MAX_DUP_OPERANDS];
170 /* ??? Note that these are `char' instead of `unsigned char' to (try to)
171 avoid certain lossage from K&R C, wherein `unsigned char' default
172 promotes to `unsigned int' instead of `int' as in ISO C. As of 1999,
173 the most common places to bootstrap from K&R C are SunOS and HPUX,
174 both of which have signed characters by default. The only other
175 supported natives that have both K&R C and unsigned characters are
176 ROMP and Irix 3, and neither have been seen for a while, but do
177 continue to consider unsignedness when performing arithmetic inside
178 a comparison. */
180 /* The number of operands of the insn. */
181 char n_operands;
183 /* The number of MATCH_DUPs in the insn. */
184 char n_dups;
186 /* The number of alternatives in the constraints for the insn. */
187 char n_alternatives;
190 extern struct recog_data recog_data;
192 /* Contains a vector of operand_alternative structures for every operand.
193 Set up by preprocess_constraints. */
194 extern struct operand_alternative recog_op_alt[MAX_RECOG_OPERANDS][MAX_RECOG_ALTERNATIVES];
196 /* A table defined in insn-output.c that give information about
197 each insn-code value. */
199 typedef int (*insn_operand_predicate_fn) PARAMS ((rtx, enum machine_mode));
200 typedef const char * (*insn_output_fn) PARAMS ((rtx *, rtx));
201 typedef rtx (*insn_gen_fn) PARAMS ((rtx, ...));
203 struct insn_operand_data
205 insn_operand_predicate_fn predicate;
207 const char *constraint;
209 enum machine_mode mode;
211 char strict_low;
213 char eliminable;
216 /* Legal values for insn_data.output_format. Indicate what type of data
217 is stored in insn_data.output. */
218 #define INSN_OUTPUT_FORMAT_NONE 0 /* abort */
219 #define INSN_OUTPUT_FORMAT_SINGLE 1 /* const char * */
220 #define INSN_OUTPUT_FORMAT_MULTI 2 /* const char * const * */
221 #define INSN_OUTPUT_FORMAT_FUNCTION 3 /* const char * (*)(...) */
223 struct insn_data
225 const char *name;
226 const PTR output;
227 insn_gen_fn genfun;
228 const struct insn_operand_data *operand;
230 char n_operands;
231 char n_dups;
232 char n_alternatives;
233 char output_format;
236 extern const struct insn_data insn_data[];