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 validate_change_maybe_volatile (rtx, rtx *, rtx);
  78 extern int insn_invalid_p (rtx);
  79 extern int verify_changes (int);
  80 extern void confirm_change_group (void);
  81 extern int apply_change_group (void);
  82 extern int num_validated_changes (void);
  83 extern void cancel_changes (int);
  84 extern int constrain_operands (int);
  85 extern int constrain_operands_cached (int);
  86 extern int memory_address_p (enum machine_mode, rtx);
  87 extern int strict_memory_address_p (enum machine_mode, rtx);
  88 extern int validate_replace_rtx_subexp (rtx, rtx, rtx, rtx *);
  89 extern int validate_replace_rtx (rtx, rtx, rtx);
  90 extern void validate_replace_rtx_group (rtx, rtx, rtx);
  91 extern void validate_replace_src_group (rtx, rtx, rtx);
  92 extern int num_changes_pending (void);
  93 #ifdef HAVE_cc0
  94 extern int next_insn_tests_no_inequality (rtx);
  95 #endif
  96 extern int reg_fits_class_p (rtx, enum reg_class, int, enum machine_mode);
  97 extern rtx *find_single_use (rtx, rtx, rtx *);
  98
  99 extern int offsettable_memref_p (rtx);
 100 extern int offsettable_nonstrict_memref_p (rtx);
 101 extern int offsettable_address_p (int, enum machine_mode, rtx);
 102 extern int mode_dependent_address_p (rtx);
 103
 104 extern int recog (rtx, rtx, int *);
 105 #ifndef GENERATOR_FILE
 106 static inline int recog_memoized (rtx insn);
 107 #endif
 108 extern void add_clobbers (rtx, int);
 109 extern int added_clobbers_hard_reg_p (int);
 110 extern void insn_extract (rtx);
 111 extern void extract_insn (rtx);
 112 extern void extract_constrain_insn_cached (rtx);
 113 extern void extract_insn_cached (rtx);
 114 extern void preprocess_constraints (void);
 115 extern rtx peep2_next_insn (int);
 116 extern int peep2_regno_dead_p (int, int);
 117 extern int peep2_reg_dead_p (int, rtx);
 118 #ifdef CLEAR_HARD_REG_SET
 119 extern rtx peep2_find_free_register (int, int, const char *,
 120                                      enum machine_mode, HARD_REG_SET *);
 121 #endif
 122 extern void peephole2_optimize (FILE *);
 123 extern rtx peephole2_insns (rtx, rtx, int *);
 124
 125 extern int store_data_bypass_p (rtx, rtx);
 126 extern int if_test_bypass_p (rtx, rtx);
 127
 128 #ifndef GENERATOR_FILE
 129 /* Try recognizing the instruction INSN,
 130    and return the code number that results.
 131    Remember the code so that repeated calls do not
 132    need to spend the time for actual rerecognition.
 133
 134    This function is the normal interface to instruction recognition.
 135    The automatically-generated function `recog' is normally called
 136    through this one.  */
 137
 138 static inline int
 139 recog_memoized (rtx insn)
 140 {
 141   if (INSN_CODE (insn) < 0)
 142     INSN_CODE (insn) = recog (PATTERN (insn), insn, 0);
 143   return INSN_CODE (insn);
 144 }
 145 #endif
 146
 147 /* Nonzero means volatile operands are recognized.  */
 148 extern int volatile_ok;
 149
 150 /* Set by constrain_operands to the number of the alternative that
 151    matched.  */
 152 extern int which_alternative;
 153
 154 /* The following vectors hold the results from insn_extract.  */
 155
 156 struct recog_data
 157 {
 158   /* It is very tempting to make the 5 operand related arrays into a
 159      structure and index on that.  However, to be source compatible
 160      with all of the existing md file insn constraints and output
 161      templates, we need `operand' as a flat array.  Without that
 162      member, making an array for the rest seems pointless.  */
 163
 164   /* Gives value of operand N.  */
 165   rtx operand[MAX_RECOG_OPERANDS];
 166
 167   /* Gives location where operand N was found.  */
 168   rtx *operand_loc[MAX_RECOG_OPERANDS];
 169
 170   /* Gives the constraint string for operand N.  */
 171   const char *constraints[MAX_RECOG_OPERANDS];
 172
 173   /* Gives the mode of operand N.  */
 174   enum machine_mode operand_mode[MAX_RECOG_OPERANDS];
 175
 176   /* Gives the type (in, out, inout) for operand N.  */
 177   enum op_type operand_type[MAX_RECOG_OPERANDS];
 178
 179   /* Gives location where the Nth duplicate-appearance of an operand
 180      was found.  This is something that matched MATCH_DUP.  */
 181   rtx *dup_loc[MAX_DUP_OPERANDS];
 182
 183   /* Gives the operand number that was duplicated in the Nth
 184      duplicate-appearance of an operand.  */
 185   char dup_num[MAX_DUP_OPERANDS];
 186
 187   /* ??? Note that these are `char' instead of `unsigned char' to (try to)
 188      avoid certain lossage from K&R C, wherein `unsigned char' default
 189      promotes to `unsigned int' instead of `int' as in ISO C.  As of 1999,
 190      the most common places to bootstrap from K&R C are SunOS and HPUX,
 191      both of which have signed characters by default.  The only other
 192      supported natives that have both K&R C and unsigned characters are
 193      ROMP and Irix 3, and neither have been seen for a while, but do
 194      continue to consider unsignedness when performing arithmetic inside
 195      a comparison.  */
 196
 197   /* The number of operands of the insn.  */
 198   char n_operands;
 199
 200   /* The number of MATCH_DUPs in the insn.  */
 201   char n_dups;
 202
 203   /* The number of alternatives in the constraints for the insn.  */
 204   char n_alternatives;
 205
 206   /* In case we are caching, hold insn data was generated for.  */
 207   rtx insn;
 208 };
 209
 210 extern struct recog_data recog_data;
 211
 212 /* Contains a vector of operand_alternative structures for every operand.
 213    Set up by preprocess_constraints.  */
 214 extern struct operand_alternative recog_op_alt[MAX_RECOG_OPERANDS][MAX_RECOG_ALTERNATIVES];
 215
 216 /* A table defined in insn-output.c that give information about
 217    each insn-code value.  */
 218
 219 typedef int (*insn_operand_predicate_fn) (rtx, enum machine_mode);
 220 typedef const char * (*insn_output_fn) (rtx *, rtx);
 221 typedef rtx (*insn_gen_fn) (rtx, ...);
 222
 223 struct insn_operand_data
 224 {
 225   const insn_operand_predicate_fn predicate;
 226
 227   const char *const constraint;
 228
 229   ENUM_BITFIELD(machine_mode) const mode : 16;
 230
 231   const char strict_low;
 232
 233   const char eliminable;
 234 };
 235
 236 /* Legal values for insn_data.output_format.  Indicate what type of data
 237    is stored in insn_data.output.  */
 238 #define INSN_OUTPUT_FORMAT_NONE         0       /* abort */
 239 #define INSN_OUTPUT_FORMAT_SINGLE       1       /* const char * */
 240 #define INSN_OUTPUT_FORMAT_MULTI        2       /* const char * const * */
 241 #define INSN_OUTPUT_FORMAT_FUNCTION     3       /* const char * (*)(...) */
 242
 243 struct insn_data
 244 {
 245   const char *const name;
 246 #if HAVE_DESIGNATED_INITIALIZERS
 247   union {
 248     const char *single;
 249     const char *const *multi;
 250     insn_output_fn function;
 251   } output;
 252 #else
 253   struct {
 254     const char *single;
 255     const char *const *multi;
 256     insn_output_fn function;
 257   } output;
 258 #endif
 259   const insn_gen_fn genfun;
 260   const struct insn_operand_data *const operand;
 261
 262   const char n_operands;
 263   const char n_dups;
 264   const char n_alternatives;
 265   const char output_format;
 266 };
 267
 268 extern const struct insn_data insn_data[];
 269 extern int peep2_current_count;