1 /* Declarations for interface to insn recognizer and insn-output.c.
2 Copyright (C) 1987-2020 Free Software Foundation, Inc.
3
4 This file is part of GCC.
5
6 GCC is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 3, or (at your option) any later
9 version.
10
11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with GCC; see the file COPYING3. If not see
18 <http://www.gnu.org/licenses/>. */
19
20 #ifndef GCC_RECOG_H
21 #define GCC_RECOG_H
22
23 /* Random number that should be large enough for all purposes. Also define
24 a type that has at least MAX_RECOG_ALTERNATIVES + 1 bits, with the extra
25 bit giving an invalid value that can be used to mean "uninitialized". */
26 #define MAX_RECOG_ALTERNATIVES 35
27 typedef uint64_t alternative_mask; /* Keep in sync with genattrtab.c. */
28
29 /* A mask of all alternatives. */
30 #define ALL_ALTERNATIVES ((alternative_mask) -1)
31
32 /* A mask containing just alternative X. */
33 #define ALTERNATIVE_BIT(X) ((alternative_mask) 1 << (X))
34
35 /* Types of operands. */
36 enum op_type {
37 OP_IN,
38 OP_OUT,
39 OP_INOUT
40 };
41
42 struct operand_alternative
43 {
44 /* Pointer to the beginning of the constraint string for this alternative,
45 for easier access by alternative number. */
46 const char *constraint;
47
48 /* The register class valid for this alternative (possibly NO_REGS). */
49 ENUM_BITFIELD (reg_class) cl : 16;
50
51 /* "Badness" of this alternative, computed from number of '?' and '!'
52 characters in the constraint string. */
53 unsigned int reject : 16;
54
55 /* -1 if no matching constraint was found, or an operand number. */
56 int matches : 8;
57 /* The same information, but reversed: -1 if this operand is not
58 matched by any other, or the operand number of the operand that
59 matches this one. */
60 int matched : 8;
61
62 /* Nonzero if '&' was found in the constraint string. */
63 unsigned int earlyclobber : 1;
64 /* Nonzero if TARGET_MEM_CONSTRAINT was found in the constraint
65 string. */
66 unsigned int memory_ok : 1;
67 /* Nonzero if 'p' was found in the constraint string. */
68 unsigned int is_address : 1;
69 /* Nonzero if 'X' was found in the constraint string, or if the constraint
70 string for this alternative was empty. */
71 unsigned int anything_ok : 1;
72
73 unsigned int unused : 12;
74 };
75
76 /* Return the class for operand I of alternative ALT, taking matching
77 constraints into account. */
78
79 static inline enum reg_class
alternative_class(const operand_alternative * alt,int i)80 alternative_class (const operand_alternative *alt, int i)
81 {
82 return alt[i].matches >= 0 ? alt[alt[i].matches].cl : alt[i].cl;
83 }
84
85 extern void init_recog (void);
86 extern void init_recog_no_volatile (void);
87 extern int check_asm_operands (rtx);
88 extern int asm_operand_ok (rtx, const char *, const char **);
89 extern bool validate_change (rtx, rtx *, rtx, bool);
90 extern bool validate_unshare_change (rtx, rtx *, rtx, bool);
91 extern bool canonicalize_change_group (rtx_insn *insn, rtx x);
92 extern int insn_invalid_p (rtx_insn *, bool);
93 extern int verify_changes (int);
94 extern void confirm_change_group (void);
95 extern int apply_change_group (void);
96 extern int num_validated_changes (void);
97 extern void cancel_changes (int);
98 extern int constrain_operands (int, alternative_mask);
99 extern int constrain_operands_cached (rtx_insn *, int);
100 extern int memory_address_addr_space_p (machine_mode, rtx, addr_space_t);
101 #define memory_address_p(mode,addr) \
102 memory_address_addr_space_p ((mode), (addr), ADDR_SPACE_GENERIC)
103 extern int strict_memory_address_addr_space_p (machine_mode, rtx,
104 addr_space_t);
105 #define strict_memory_address_p(mode,addr) \
106 strict_memory_address_addr_space_p ((mode), (addr), ADDR_SPACE_GENERIC)
107 extern int validate_replace_rtx_subexp (rtx, rtx, rtx_insn *, rtx *);
108 extern int validate_replace_rtx (rtx, rtx, rtx_insn *);
109 extern int validate_replace_rtx_part (rtx, rtx, rtx *, rtx_insn *);
110 extern int validate_replace_rtx_part_nosimplify (rtx, rtx, rtx *, rtx_insn *);
111 extern void validate_replace_rtx_group (rtx, rtx, rtx_insn *);
112 extern void validate_replace_src_group (rtx, rtx, rtx_insn *);
113 extern bool validate_simplify_insn (rtx_insn *insn);
114 extern int num_changes_pending (void);
115 extern bool reg_fits_class_p (const_rtx, reg_class_t, int, machine_mode);
116
117 extern int offsettable_memref_p (rtx);
118 extern int offsettable_nonstrict_memref_p (rtx);
119 extern int offsettable_address_addr_space_p (int, machine_mode, rtx,
120 addr_space_t);
121 #define offsettable_address_p(strict,mode,addr) \
122 offsettable_address_addr_space_p ((strict), (mode), (addr), \
123 ADDR_SPACE_GENERIC)
124 extern bool mode_dependent_address_p (rtx, addr_space_t);
125
126 extern int recog (rtx, rtx_insn *, int *);
127 #ifndef GENERATOR_FILE
128 static inline int recog_memoized (rtx_insn *insn);
129 #endif
130 extern void add_clobbers (rtx, int);
131 extern int added_clobbers_hard_reg_p (int);
132 extern void insn_extract (rtx_insn *);
133 extern void extract_insn (rtx_insn *);
134 extern void extract_constrain_insn (rtx_insn *insn);
135 extern void extract_constrain_insn_cached (rtx_insn *);
136 extern void extract_insn_cached (rtx_insn *);
137 extern void preprocess_constraints (int, int, const char **,
138 operand_alternative *, rtx **);
139 extern const operand_alternative *preprocess_insn_constraints (unsigned int);
140 extern void preprocess_constraints (rtx_insn *);
141 extern rtx_insn *peep2_next_insn (int);
142 extern int peep2_regno_dead_p (int, int);
143 extern int peep2_reg_dead_p (int, rtx);
144 #ifdef HARD_CONST
145 extern rtx peep2_find_free_register (int, int, const char *,
146 machine_mode, HARD_REG_SET *);
147 #endif
148 extern rtx_insn *peephole2_insns (rtx, rtx_insn *, int *);
149
150 extern int store_data_bypass_p (rtx_insn *, rtx_insn *);
151 extern int if_test_bypass_p (rtx_insn *, rtx_insn *);
152
153 #ifndef GENERATOR_FILE
154 /* Try recognizing the instruction INSN,
155 and return the code number that results.
156 Remember the code so that repeated calls do not
157 need to spend the time for actual rerecognition.
158
159 This function is the normal interface to instruction recognition.
160 The automatically-generated function `recog' is normally called
161 through this one. */
162
163 static inline int
recog_memoized(rtx_insn * insn)164 recog_memoized (rtx_insn *insn)
165 {
166 if (INSN_CODE (insn) < 0)
167 INSN_CODE (insn) = recog (PATTERN (insn), insn, 0);
168 return INSN_CODE (insn);
169 }
170 #endif
171
172 /* Skip chars until the next ',' or the end of the string. This is
173 useful to skip alternatives in a constraint string. */
174 static inline const char *
skip_alternative(const char * p)175 skip_alternative (const char *p)
176 {
177 const char *r = p;
178 while (*r != '\0' && *r != ',')
179 r++;
180 if (*r == ',')
181 r++;
182 return r;
183 }
184
185 /* Nonzero means volatile operands are recognized. */
186 extern int volatile_ok;
187
188 /* RAII class for temporarily setting volatile_ok. */
189
190 class temporary_volatile_ok
191 {
192 public:
temporary_volatile_ok(int value)193 temporary_volatile_ok (int value) : save_volatile_ok (volatile_ok)
194 {
195 volatile_ok = value;
196 }
197
~temporary_volatile_ok()198 ~temporary_volatile_ok () { volatile_ok = save_volatile_ok; }
199
200 private:
201 temporary_volatile_ok (const temporary_volatile_ok &);
202 int save_volatile_ok;
203 };
204
205 /* Set by constrain_operands to the number of the alternative that
206 matched. */
207 extern int which_alternative;
208
209 /* The following vectors hold the results from insn_extract. */
210
211 struct recog_data_d
212 {
213 /* It is very tempting to make the 5 operand related arrays into a
214 structure and index on that. However, to be source compatible
215 with all of the existing md file insn constraints and output
216 templates, we need `operand' as a flat array. Without that
217 member, making an array for the rest seems pointless. */
218
219 /* Gives value of operand N. */
220 rtx operand[MAX_RECOG_OPERANDS];
221
222 /* Gives location where operand N was found. */
223 rtx *operand_loc[MAX_RECOG_OPERANDS];
224
225 /* Gives the constraint string for operand N. */
226 const char *constraints[MAX_RECOG_OPERANDS];
227
228 /* Nonzero if operand N is a match_operator or a match_parallel. */
229 char is_operator[MAX_RECOG_OPERANDS];
230
231 /* Gives the mode of operand N. */
232 machine_mode operand_mode[MAX_RECOG_OPERANDS];
233
234 /* Gives the type (in, out, inout) for operand N. */
235 enum op_type operand_type[MAX_RECOG_OPERANDS];
236
237 /* Gives location where the Nth duplicate-appearance of an operand
238 was found. This is something that matched MATCH_DUP. */
239 rtx *dup_loc[MAX_DUP_OPERANDS];
240
241 /* Gives the operand number that was duplicated in the Nth
242 duplicate-appearance of an operand. */
243 char dup_num[MAX_DUP_OPERANDS];
244
245 /* ??? Note that these are `char' instead of `unsigned char' to (try to)
246 avoid certain lossage from K&R C, wherein `unsigned char' default
247 promotes to `unsigned int' instead of `int' as in ISO C. As of 1999,
248 the most common places to bootstrap from K&R C are SunOS and HPUX,
249 both of which have signed characters by default. The only other
250 supported natives that have both K&R C and unsigned characters are
251 ROMP and Irix 3, and neither have been seen for a while, but do
252 continue to consider unsignedness when performing arithmetic inside
253 a comparison. */
254
255 /* The number of operands of the insn. */
256 char n_operands;
257
258 /* The number of MATCH_DUPs in the insn. */
259 char n_dups;
260
261 /* The number of alternatives in the constraints for the insn. */
262 char n_alternatives;
263
264 /* True if insn is ASM_OPERANDS. */
265 bool is_asm;
266
267 /* In case we are caching, hold insn data was generated for. */
268 rtx_insn *insn;
269 };
270
271 extern struct recog_data_d recog_data;
272
273 extern const operand_alternative *recog_op_alt;
274
275 /* Return a pointer to an array in which index OP describes the constraints
276 on operand OP of the current instruction alternative (which_alternative).
277 Only valid after calling preprocess_constraints and constrain_operands. */
278
279 inline static const operand_alternative *
which_op_alt()280 which_op_alt ()
281 {
282 gcc_checking_assert (IN_RANGE (which_alternative, 0,
283 recog_data.n_alternatives - 1));
284 return &recog_op_alt[which_alternative * recog_data.n_operands];
285 }
286
287 /* A table defined in insn-output.c that give information about
288 each insn-code value. */
289
290 typedef int (*insn_operand_predicate_fn) (rtx, machine_mode);
291 typedef const char * (*insn_output_fn) (rtx *, rtx_insn *);
292
293 struct insn_gen_fn
294 {
295 typedef rtx_insn * (*f0) (void);
296 typedef rtx_insn * (*f1) (rtx);
297 typedef rtx_insn * (*f2) (rtx, rtx);
298 typedef rtx_insn * (*f3) (rtx, rtx, rtx);
299 typedef rtx_insn * (*f4) (rtx, rtx, rtx, rtx);
300 typedef rtx_insn * (*f5) (rtx, rtx, rtx, rtx, rtx);
301 typedef rtx_insn * (*f6) (rtx, rtx, rtx, rtx, rtx, rtx);
302 typedef rtx_insn * (*f7) (rtx, rtx, rtx, rtx, rtx, rtx, rtx);
303 typedef rtx_insn * (*f8) (rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx);
304 typedef rtx_insn * (*f9) (rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx);
305 typedef rtx_insn * (*f10) (rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx);
306 typedef rtx_insn * (*f11) (rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx);
307 typedef rtx_insn * (*f12) (rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx);
308 typedef rtx_insn * (*f13) (rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx);
309 typedef rtx_insn * (*f14) (rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx);
310 typedef rtx_insn * (*f15) (rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx);
311 typedef rtx_insn * (*f16) (rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx);
312
313 typedef void (*stored_funcptr) (void);
314
operatorinsn_gen_fn315 rtx_insn * operator () (void) const { return ((f0)func) (); }
operatorinsn_gen_fn316 rtx_insn * operator () (rtx a0) const { return ((f1)func) (a0); }
operatorinsn_gen_fn317 rtx_insn * operator () (rtx a0, rtx a1) const { return ((f2)func) (a0, a1); }
operatorinsn_gen_fn318 rtx_insn * operator () (rtx a0, rtx a1, rtx a2) const { return ((f3)func) (a0, a1, a2); }
operatorinsn_gen_fn319 rtx_insn * operator () (rtx a0, rtx a1, rtx a2, rtx a3) const { return ((f4)func) (a0, a1, a2, a3); }
operatorinsn_gen_fn320 rtx_insn * operator () (rtx a0, rtx a1, rtx a2, rtx a3, rtx a4) const { return ((f5)func) (a0, a1, a2, a3, a4); }
operatorinsn_gen_fn321 rtx_insn * operator () (rtx a0, rtx a1, rtx a2, rtx a3, rtx a4, rtx a5) const { return ((f6)func) (a0, a1, a2, a3, a4, a5); }
operatorinsn_gen_fn322 rtx_insn * operator () (rtx a0, rtx a1, rtx a2, rtx a3, rtx a4, rtx a5, rtx a6) const { return ((f7)func) (a0, a1, a2, a3, a4, a5, a6); }
operatorinsn_gen_fn323 rtx_insn * operator () (rtx a0, rtx a1, rtx a2, rtx a3, rtx a4, rtx a5, rtx a6, rtx a7) const { return ((f8)func) (a0, a1, a2, a3, a4, a5, a6, a7); }
operatorinsn_gen_fn324 rtx_insn * operator () (rtx a0, rtx a1, rtx a2, rtx a3, rtx a4, rtx a5, rtx a6, rtx a7, rtx a8) const { return ((f9)func) (a0, a1, a2, a3, a4, a5, a6, a7, a8); }
operatorinsn_gen_fn325 rtx_insn * operator () (rtx a0, rtx a1, rtx a2, rtx a3, rtx a4, rtx a5, rtx a6, rtx a7, rtx a8, rtx a9) const { return ((f10)func) (a0, a1, a2, a3, a4, a5, a6, a7, a8, a9); }
operatorinsn_gen_fn326 rtx_insn * operator () (rtx a0, rtx a1, rtx a2, rtx a3, rtx a4, rtx a5, rtx a6, rtx a7, rtx a8, rtx a9, rtx a10) const { return ((f11)func) (a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10); }
operatorinsn_gen_fn327 rtx_insn * operator () (rtx a0, rtx a1, rtx a2, rtx a3, rtx a4, rtx a5, rtx a6, rtx a7, rtx a8, rtx a9, rtx a10, rtx a11) const { return ((f12)func) (a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11); }
operatorinsn_gen_fn328 rtx_insn * operator () (rtx a0, rtx a1, rtx a2, rtx a3, rtx a4, rtx a5, rtx a6, rtx a7, rtx a8, rtx a9, rtx a10, rtx a11, rtx a12) const { return ((f13)func) (a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12); }
operatorinsn_gen_fn329 rtx_insn * operator () (rtx a0, rtx a1, rtx a2, rtx a3, rtx a4, rtx a5, rtx a6, rtx a7, rtx a8, rtx a9, rtx a10, rtx a11, rtx a12, rtx a13) const { return ((f14)func) (a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13); }
operatorinsn_gen_fn330 rtx_insn * operator () (rtx a0, rtx a1, rtx a2, rtx a3, rtx a4, rtx a5, rtx a6, rtx a7, rtx a8, rtx a9, rtx a10, rtx a11, rtx a12, rtx a13, rtx a14) const { return ((f15)func) (a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14); }
operatorinsn_gen_fn331 rtx_insn * operator () (rtx a0, rtx a1, rtx a2, rtx a3, rtx a4, rtx a5, rtx a6, rtx a7, rtx a8, rtx a9, rtx a10, rtx a11, rtx a12, rtx a13, rtx a14, rtx a15) const { return ((f16)func) (a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15); }
332
333 // This is for compatibility of code that invokes functions like
334 // (*funcptr) (arg)
335 insn_gen_fn operator * (void) const { return *this; }
336
337 // The wrapped function pointer must be public and there must not be any
338 // constructors. Otherwise the insn_data_d struct initializers generated
339 // by genoutput.c will result in static initializer functions, which defeats
340 // the purpose of the generated insn_data_d array.
341 stored_funcptr func;
342 };
343
344 struct insn_operand_data
345 {
346 const insn_operand_predicate_fn predicate;
347
348 const char *const constraint;
349
350 ENUM_BITFIELD(machine_mode) const mode : 16;
351
352 const char strict_low;
353
354 const char is_operator;
355
356 const char eliminable;
357
358 const char allows_mem;
359 };
360
361 /* Legal values for insn_data.output_format. Indicate what type of data
362 is stored in insn_data.output. */
363 #define INSN_OUTPUT_FORMAT_NONE 0 /* abort */
364 #define INSN_OUTPUT_FORMAT_SINGLE 1 /* const char * */
365 #define INSN_OUTPUT_FORMAT_MULTI 2 /* const char * const * */
366 #define INSN_OUTPUT_FORMAT_FUNCTION 3 /* const char * (*)(...) */
367
368 struct insn_data_d
369 {
370 const char *const name;
371 #if HAVE_DESIGNATED_UNION_INITIALIZERS
372 union {
373 const char *single;
374 const char *const *multi;
375 insn_output_fn function;
376 } output;
377 #else
378 struct {
379 const char *single;
380 const char *const *multi;
381 insn_output_fn function;
382 } output;
383 #endif
384 const insn_gen_fn genfun;
385 const struct insn_operand_data *const operand;
386
387 const char n_generator_args;
388 const char n_operands;
389 const char n_dups;
390 const char n_alternatives;
391 const char output_format;
392 };
393
394 extern const struct insn_data_d insn_data[];
395 extern int peep2_current_count;
396
397 #ifndef GENERATOR_FILE
398 #include "insn-codes.h"
399
400 /* An enum of boolean attributes that may only depend on the current
401 subtarget, not on things like operands or compiler phase. */
402 enum bool_attr {
403 BA_ENABLED,
404 BA_PREFERRED_FOR_SPEED,
405 BA_PREFERRED_FOR_SIZE,
406 BA_LAST = BA_PREFERRED_FOR_SIZE
407 };
408
409 /* Target-dependent globals. */
410 struct target_recog {
411 bool x_initialized;
412 alternative_mask x_bool_attr_masks[NUM_INSN_CODES][BA_LAST + 1];
413 operand_alternative *x_op_alt[NUM_INSN_CODES];
414 };
415
416 extern struct target_recog default_target_recog;
417 #if SWITCHABLE_TARGET
418 extern struct target_recog *this_target_recog;
419 #else
420 #define this_target_recog (&default_target_recog)
421 #endif
422
423 alternative_mask get_enabled_alternatives (rtx_insn *);
424 alternative_mask get_preferred_alternatives (rtx_insn *);
425 alternative_mask get_preferred_alternatives (rtx_insn *, basic_block);
426 bool check_bool_attrs (rtx_insn *);
427
428 void recog_init ();
429 #endif
430
431 #endif /* GCC_RECOG_H */
432