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