* extend.texi: Improve documentation of volatile asms.
[official-gcc.git] / gcc / recog.h
blobf591da6b3b4673cfe6e8d94e2e59054889202f40
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
24 #define recog_memoized(I) (INSN_CODE (I) >= 0 \
25 ? INSN_CODE (I) : recog_memoized_1 (I))
27 /* Types of operands. */
28 enum op_type {
29 OP_IN,
30 OP_OUT,
31 OP_INOUT
34 struct operand_alternative
36 /* Pointer to the beginning of the constraint string for this alternative,
37 for easier access by alternative number. */
38 const char *constraint;
40 /* The register class valid for this alternative (possibly NO_REGS). */
41 enum reg_class class;
43 /* "Badness" of this alternative, computed from number of '?' and '!'
44 characters in the constraint string. */
45 unsigned int reject;
47 /* -1 if no matching constraint was found, or an operand number. */
48 int matches;
49 /* The same information, but reversed: -1 if this operand is not
50 matched by any other, or the operand number of the operand that
51 matches this one. */
52 int matched;
54 /* Nonzero if '&' was found in the constraint string. */
55 unsigned int earlyclobber:1;
56 /* Nonzero if 'm' was found in the constraint string. */
57 unsigned int memory_ok:1;
58 /* Nonzero if 'o' was found in the constraint string. */
59 unsigned int offmem_ok:1;
60 /* Nonzero if 'V' was found in the constraint string. */
61 unsigned int nonoffmem_ok:1;
62 /* Nonzero if '<' was found in the constraint string. */
63 unsigned int decmem_ok:1;
64 /* Nonzero if '>' was found in the constraint string. */
65 unsigned int incmem_ok:1;
66 /* Nonzero if 'p' was found in the constraint string. */
67 unsigned int is_address:1;
68 /* Nonzero if 'X' was found in the constraint string, or if the constraint
69 string for this alternative was empty. */
70 unsigned int anything_ok:1;
74 extern void init_recog PARAMS ((void));
75 extern void init_recog_no_volatile PARAMS ((void));
76 extern int recog_memoized_1 PARAMS ((rtx));
77 extern int check_asm_operands PARAMS ((rtx));
78 extern int asm_operand_ok PARAMS ((rtx, const char *));
79 extern int validate_change PARAMS ((rtx, rtx *, rtx, int));
80 extern int apply_change_group PARAMS ((void));
81 extern int num_validated_changes PARAMS ((void));
82 extern void cancel_changes PARAMS ((int));
83 extern int constrain_operands PARAMS ((int));
84 extern int constrain_operands_cached PARAMS ((int));
85 extern int memory_address_p PARAMS ((enum machine_mode, rtx));
86 extern int strict_memory_address_p PARAMS ((enum machine_mode, rtx));
87 extern int validate_replace_rtx_subexp PARAMS ((rtx, rtx, rtx, rtx *));
88 extern int validate_replace_rtx PARAMS ((rtx, rtx, rtx));
89 extern void validate_replace_rtx_group PARAMS ((rtx, rtx, rtx));
90 extern int validate_replace_src PARAMS ((rtx, rtx, rtx));
91 #ifdef HAVE_cc0
92 extern int next_insn_tests_no_inequality PARAMS ((rtx));
93 #endif
94 extern int reg_fits_class_p PARAMS ((rtx, enum reg_class, int,
95 enum machine_mode));
96 extern rtx *find_single_use PARAMS ((rtx, rtx, rtx *));
98 extern int general_operand PARAMS ((rtx, enum machine_mode));
99 extern int address_operand PARAMS ((rtx, enum machine_mode));
100 extern int register_operand PARAMS ((rtx, enum machine_mode));
101 extern int pmode_register_operand PARAMS ((rtx, enum machine_mode));
102 extern int scratch_operand PARAMS ((rtx, enum machine_mode));
103 extern int immediate_operand PARAMS ((rtx, enum machine_mode));
104 extern int const_int_operand PARAMS ((rtx, enum machine_mode));
105 extern int const_double_operand PARAMS ((rtx, enum machine_mode));
106 extern int nonimmediate_operand PARAMS ((rtx, enum machine_mode));
107 extern int nonmemory_operand PARAMS ((rtx, enum machine_mode));
108 extern int push_operand PARAMS ((rtx, enum machine_mode));
109 extern int pop_operand PARAMS ((rtx, enum machine_mode));
110 extern int memory_operand PARAMS ((rtx, enum machine_mode));
111 extern int indirect_operand PARAMS ((rtx, enum machine_mode));
112 extern int mode_independent_operand PARAMS ((rtx, enum machine_mode));
113 extern int comparison_operator PARAMS ((rtx, enum machine_mode));
115 extern int offsettable_memref_p PARAMS ((rtx));
116 extern int offsettable_nonstrict_memref_p PARAMS ((rtx));
117 extern int offsettable_address_p PARAMS ((int, enum machine_mode, rtx));
118 extern int mode_dependent_address_p PARAMS ((rtx));
120 extern int recog PARAMS ((rtx, rtx, int *));
121 extern void add_clobbers PARAMS ((rtx, int));
122 extern void insn_extract PARAMS ((rtx));
123 extern void extract_insn PARAMS ((rtx));
124 extern void extract_constrain_insn_cached PARAMS ((rtx));
125 extern void extract_insn_cached PARAMS ((rtx));
126 extern void preprocess_constraints PARAMS ((void));
127 extern rtx peep2_next_insn PARAMS ((int));
128 extern int peep2_regno_dead_p PARAMS ((int, int));
129 extern int peep2_reg_dead_p PARAMS ((int, rtx));
130 #ifdef CLEAR_HARD_REG_SET
131 extern rtx peep2_find_free_register PARAMS ((int, int, const char *,
132 enum machine_mode,
133 HARD_REG_SET *));
134 #endif
135 extern void peephole2_optimize PARAMS ((FILE *));
136 extern rtx peephole2_insns PARAMS ((rtx, rtx, int *));
138 /* Nonzero means volatile operands are recognized. */
139 extern int volatile_ok;
141 /* Set by constrain_operands to the number of the alternative that
142 matched. */
143 extern int which_alternative;
145 /* The following vectors hold the results from insn_extract. */
147 struct recog_data
149 /* It is very tempting to make the 5 operand related arrays into a
150 structure and index on that. However, to be source compatible
151 with all of the existing md file insn constraints and output
152 templates, we need `operand' as a flat array. Without that
153 member, making an array for the rest seems pointless. */
155 /* Gives value of operand N. */
156 rtx operand[MAX_RECOG_OPERANDS];
158 /* Gives location where operand N was found. */
159 rtx *operand_loc[MAX_RECOG_OPERANDS];
161 /* Gives the constraint string for operand N. */
162 const char *constraints[MAX_RECOG_OPERANDS];
164 /* Gives the mode of operand N. */
165 enum machine_mode operand_mode[MAX_RECOG_OPERANDS];
167 /* Gives the type (in, out, inout) for operand N. */
168 enum op_type operand_type[MAX_RECOG_OPERANDS];
170 /* Gives location where the Nth duplicate-appearance of an operand
171 was found. This is something that matched MATCH_DUP. */
172 rtx *dup_loc[MAX_DUP_OPERANDS];
174 /* Gives the operand number that was duplicated in the Nth
175 duplicate-appearance of an operand. */
176 char dup_num[MAX_DUP_OPERANDS];
178 /* ??? Note that these are `char' instead of `unsigned char' to (try to)
179 avoid certain lossage from K&R C, wherein `unsigned char' default
180 promotes to `unsigned int' instead of `int' as in ISO C. As of 1999,
181 the most common places to bootstrap from K&R C are SunOS and HPUX,
182 both of which have signed characters by default. The only other
183 supported natives that have both K&R C and unsigned characters are
184 ROMP and Irix 3, and neither have been seen for a while, but do
185 continue to consider unsignedness when performing arithmetic inside
186 a comparison. */
188 /* The number of operands of the insn. */
189 char n_operands;
191 /* The number of MATCH_DUPs in the insn. */
192 char n_dups;
194 /* The number of alternatives in the constraints for the insn. */
195 char n_alternatives;
197 /* In case we are caching, hold insn data was generated for. */
198 rtx insn;
201 extern struct recog_data recog_data;
203 /* Contains a vector of operand_alternative structures for every operand.
204 Set up by preprocess_constraints. */
205 extern struct operand_alternative recog_op_alt[MAX_RECOG_OPERANDS][MAX_RECOG_ALTERNATIVES];
207 /* A table defined in insn-output.c that give information about
208 each insn-code value. */
210 typedef int (*insn_operand_predicate_fn) PARAMS ((rtx, enum machine_mode));
211 typedef const char * (*insn_output_fn) PARAMS ((rtx *, rtx));
212 typedef rtx (*insn_gen_fn) PARAMS ((rtx, ...));
214 struct insn_operand_data
216 insn_operand_predicate_fn predicate;
218 const char *constraint;
220 enum machine_mode mode;
222 char strict_low;
224 char eliminable;
227 /* Legal values for insn_data.output_format. Indicate what type of data
228 is stored in insn_data.output. */
229 #define INSN_OUTPUT_FORMAT_NONE 0 /* abort */
230 #define INSN_OUTPUT_FORMAT_SINGLE 1 /* const char * */
231 #define INSN_OUTPUT_FORMAT_MULTI 2 /* const char * const * */
232 #define INSN_OUTPUT_FORMAT_FUNCTION 3 /* const char * (*)(...) */
234 struct insn_data
236 const char *name;
237 const PTR output;
238 insn_gen_fn genfun;
239 const struct insn_operand_data *operand;
241 char n_operands;
242 char n_dups;
243 char n_alternatives;
244 char output_format;
247 extern const struct insn_data insn_data[];