gcc/recog.h

   1 /* Declarations for interface to insn recognizer and insn-output.c.
   2    Copyright (C) 1987, 1996, 1997, 1998, 1999, 2000, 2001, 2003, 2004, 2005
   3    Free Software Foundation, Inc.
   4
   5 This file is part of GCC.
   6
   7 GCC is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 2, or (at your option) any later
  10 version.
  11
  12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GCC; see the file COPYING.  If not, write to the Free
  19 Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
  20 02110-1301, USA.  */
  21
  22 /* Random number that should be large enough for all purposes.  */
  23 #define MAX_RECOG_ALTERNATIVES 30
  24
  25 /* Types of operands.  */
  26 enum op_type {
  27   OP_IN,
  28   OP_OUT,
  29   OP_INOUT
  30 };
  31
  32 struct operand_alternative
  33 {
  34   /* Pointer to the beginning of the constraint string for this alternative,
  35      for easier access by alternative number.  */
  36   const char *constraint;
  37
  38   /* The register class valid for this alternative (possibly NO_REGS).  */
  39   enum reg_class cl;
  40
  41   /* "Badness" of this alternative, computed from number of '?' and '!'
  42      characters in the constraint string.  */
  43   unsigned int reject;
  44
  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;
  51
  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 'p' was found in the constraint string.  */
  65   unsigned int is_address:1;
  66   /* Nonzero if 'X' was found in the constraint string, or if the constraint
  67      string for this alternative was empty.  */
  68   unsigned int anything_ok:1;
  69 };
  70
  71
  72 extern void init_recog (void);
  73 extern void init_recog_no_volatile (void);
  74 extern int check_asm_operands (rtx);
  75 extern int asm_operand_ok (rtx, const char *);
  76 extern int validate_change (rtx, rtx *, rtx, int);
  77 extern int insn_invalid_p (rtx);
  78 extern int verify_changes (int);
  79 extern void confirm_change_group (void);
  80 extern int apply_change_group (void);
  81 extern int num_validated_changes (void);
  82 extern void cancel_changes (int);
  83 extern int constrain_operands (int);
  84 extern int constrain_operands_cached (int);
  85 extern int memory_address_p (enum machine_mode, rtx);
  86 extern int strict_memory_address_p (enum machine_mode, rtx);
  87 extern int validate_replace_rtx (rtx, rtx, rtx);
  88 extern void validate_replace_rtx_group (rtx, rtx, rtx);
  89 extern void validate_replace_src_group (rtx, rtx, rtx);
  90 extern int num_changes_pending (void);
  91 #ifdef HAVE_cc0
  92 extern int next_insn_tests_no_inequality (rtx);
  93 #endif
  94 extern int reg_fits_class_p (rtx, enum reg_class, int, enum machine_mode);
  95 extern rtx *find_single_use (rtx, rtx, rtx *);
  96
  97 extern int offsettable_memref_p (rtx);
  98 extern int offsettable_nonstrict_memref_p (rtx);
  99 extern int offsettable_address_p (int, enum machine_mode, rtx);
 100 extern int mode_dependent_address_p (rtx);
 101
 102 extern int recog (rtx, rtx, int *);
 103 #ifndef GENERATOR_FILE
 104 static inline int recog_memoized (rtx insn);
 105 #endif
 106 extern void add_clobbers (rtx, int);
 107 extern int added_clobbers_hard_reg_p (int);
 108 extern void insn_extract (rtx);
 109 extern void extract_insn (rtx);
 110 extern void extract_constrain_insn_cached (rtx);
 111 extern void extract_insn_cached (rtx);
 112 extern void preprocess_constraints (void);
 113 extern rtx peep2_next_insn (int);
 114 extern int peep2_regno_dead_p (int, int);
 115 extern int peep2_reg_dead_p (int, rtx);
 116 #ifdef CLEAR_HARD_REG_SET
 117 extern rtx peep2_find_free_register (int, int, const char *,
 118                                      enum machine_mode, HARD_REG_SET *);
 119 #endif
 120 extern rtx peephole2_insns (rtx, rtx, int *);
 121
 122 extern int store_data_bypass_p (rtx, rtx);
 123 extern int if_test_bypass_p (rtx, rtx);
 124
 125 #ifndef GENERATOR_FILE
 126 /* Try recognizing the instruction INSN,
 127    and return the code number that results.
 128    Remember the code so that repeated calls do not
 129    need to spend the time for actual rerecognition.
 130
 131    This function is the normal interface to instruction recognition.
 132    The automatically-generated function `recog' is normally called
 133    through this one.  */
 134
 135 static inline int
 136 recog_memoized (rtx insn)
 137 {
 138   if (INSN_CODE (insn) < 0)
 139     INSN_CODE (insn) = recog (PATTERN (insn), insn, 0);
 140   return INSN_CODE (insn);
 141 }
 142 #endif
 143
 144 /* Nonzero means volatile operands are recognized.  */
 145 extern int volatile_ok;
 146
 147 /* Set by constrain_operands to the number of the alternative that
 148    matched.  */
 149 extern int which_alternative;
 150
 151 /* The following vectors hold the results from insn_extract.  */
 152
 153 struct recog_data
 154 {
 155   /* It is very tempting to make the 5 operand related arrays into a
 156      structure and index on that.  However, to be source compatible
 157      with all of the existing md file insn constraints and output
 158      templates, we need `operand' as a flat array.  Without that
 159      member, making an array for the rest seems pointless.  */
 160
 161   /* Gives value of operand N.  */
 162   rtx operand[MAX_RECOG_OPERANDS];
 163
 164   /* Gives location where operand N was found.  */
 165   rtx *operand_loc[MAX_RECOG_OPERANDS];
 166
 167   /* Gives the constraint string for operand N.  */
 168   const char *constraints[MAX_RECOG_OPERANDS];
 169
 170   /* Gives the mode of operand N.  */
 171   enum machine_mode operand_mode[MAX_RECOG_OPERANDS];
 172
 173   /* Gives the type (in, out, inout) for operand N.  */
 174   enum op_type operand_type[MAX_RECOG_OPERANDS];
 175
 176   /* Gives location where the Nth duplicate-appearance of an operand
 177      was found.  This is something that matched MATCH_DUP.  */
 178   rtx *dup_loc[MAX_DUP_OPERANDS];
 179
 180   /* Gives the operand number that was duplicated in the Nth
 181      duplicate-appearance of an operand.  */
 182   char dup_num[MAX_DUP_OPERANDS];
 183
 184   /* ??? Note that these are `char' instead of `unsigned char' to (try to)
 185      avoid certain lossage from K&R C, wherein `unsigned char' default
 186      promotes to `unsigned int' instead of `int' as in ISO C.  As of 1999,
 187      the most common places to bootstrap from K&R C are SunOS and HPUX,
 188      both of which have signed characters by default.  The only other
 189      supported natives that have both K&R C and unsigned characters are
 190      ROMP and Irix 3, and neither have been seen for a while, but do
 191      continue to consider unsignedness when performing arithmetic inside
 192      a comparison.  */
 193
 194   /* The number of operands of the insn.  */
 195   char n_operands;
 196
 197   /* The number of MATCH_DUPs in the insn.  */
 198   char n_dups;
 199
 200   /* The number of alternatives in the constraints for the insn.  */
 201   char n_alternatives;
 202
 203   /* In case we are caching, hold insn data was generated for.  */
 204   rtx insn;
 205 };
 206
 207 extern struct recog_data recog_data;
 208
 209 /* Contains a vector of operand_alternative structures for every operand.
 210    Set up by preprocess_constraints.  */
 211 extern struct operand_alternative recog_op_alt[MAX_RECOG_OPERANDS][MAX_RECOG_ALTERNATIVES];
 212
 213 /* A table defined in insn-output.c that give information about
 214    each insn-code value.  */
 215
 216 typedef int (*insn_operand_predicate_fn) (rtx, enum machine_mode);
 217 typedef const char * (*insn_output_fn) (rtx *, rtx);
 218 typedef rtx (*insn_gen_fn) (rtx, ...);
 219
 220 struct insn_operand_data
 221 {
 222   const insn_operand_predicate_fn predicate;
 223
 224   const char *const constraint;
 225
 226   ENUM_BITFIELD(machine_mode) const mode : 16;
 227
 228   const char strict_low;
 229
 230   const char eliminable;
 231 };
 232
 233 /* Legal values for insn_data.output_format.  Indicate what type of data
 234    is stored in insn_data.output.  */
 235 #define INSN_OUTPUT_FORMAT_NONE         0       /* abort */
 236 #define INSN_OUTPUT_FORMAT_SINGLE       1       /* const char * */
 237 #define INSN_OUTPUT_FORMAT_MULTI        2       /* const char * const * */
 238 #define INSN_OUTPUT_FORMAT_FUNCTION     3       /* const char * (*)(...) */
 239
 240 struct insn_data
 241 {
 242   const char *const name;
 243 #if HAVE_DESIGNATED_INITIALIZERS
 244   union {
 245     const char *single;
 246     const char *const *multi;
 247     insn_output_fn function;
 248   } output;
 249 #else
 250   struct {
 251     const char *single;
 252     const char *const *multi;
 253     insn_output_fn function;
 254   } output;
 255 #endif
 256   const insn_gen_fn genfun;
 257   const struct insn_operand_data *const operand;
 258
 259   const char n_operands;
 260   const char n_dups;
 261   const char n_alternatives;
 262   const char output_format;
 263 };
 264
 265 extern const struct insn_data insn_data[];
 266 extern int peep2_current_count;