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
   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, 59 Temple Place - Suite 330, Boston, MA
  20 02111-1307, USA.  */
  21
  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))
  26
  27 /* Types of operands.  */
  28 enum op_type {
  29   OP_IN,
  30   OP_OUT,
  31   OP_INOUT
  32 };
  33
  34 struct operand_alternative
  35 {
  36   /* Pointer to the beginning of the constraint string for this alternative,
  37      for easier access by alternative number.  */
  38   const char *constraint;
  39
  40   /* The register class valid for this alternative (possibly NO_REGS).  */
  41   enum reg_class cl;
  42
  43   /* "Badness" of this alternative, computed from number of '?' and '!'
  44      characters in the constraint string.  */
  45   unsigned int reject;
  46
  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;
  53
  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;
  71 };
  72
  73
  74 extern void init_recog (void);
  75 extern void init_recog_no_volatile (void);
  76 extern int recog_memoized_1 (rtx);
  77 extern int check_asm_operands (rtx);
  78 extern int asm_operand_ok (rtx, const char *);
  79 extern int validate_change (rtx, rtx *, rtx, int);
  80 extern int insn_invalid_p (rtx);
  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 extern void add_clobbers (rtx, int);
 106 extern int added_clobbers_hard_reg_p (int);
 107 extern void insn_extract (rtx);
 108 extern void extract_insn (rtx);
 109 extern void extract_constrain_insn_cached (rtx);
 110 extern void extract_insn_cached (rtx);
 111 extern void preprocess_constraints (void);
 112 extern rtx peep2_next_insn (int);
 113 extern int peep2_regno_dead_p (int, int);
 114 extern int peep2_reg_dead_p (int, rtx);
 115 #ifdef CLEAR_HARD_REG_SET
 116 extern rtx peep2_find_free_register (int, int, const char *,
 117                                      enum machine_mode, HARD_REG_SET *);
 118 #endif
 119 extern void peephole2_optimize (FILE *);
 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 /* Nonzero means volatile operands are recognized.  */
 126 extern int volatile_ok;
 127
 128 /* Set by constrain_operands to the number of the alternative that
 129    matched.  */
 130 extern int which_alternative;
 131
 132 /* The following vectors hold the results from insn_extract.  */
 133
 134 struct recog_data
 135 {
 136   /* It is very tempting to make the 5 operand related arrays into a
 137      structure and index on that.  However, to be source compatible
 138      with all of the existing md file insn constraints and output
 139      templates, we need `operand' as a flat array.  Without that
 140      member, making an array for the rest seems pointless.  */
 141
 142   /* Gives value of operand N.  */
 143   rtx operand[MAX_RECOG_OPERANDS];
 144
 145   /* Gives location where operand N was found.  */
 146   rtx *operand_loc[MAX_RECOG_OPERANDS];
 147
 148   /* Gives the constraint string for operand N.  */
 149   const char *constraints[MAX_RECOG_OPERANDS];
 150
 151   /* Gives the mode of operand N.  */
 152   enum machine_mode operand_mode[MAX_RECOG_OPERANDS];
 153
 154   /* Gives the type (in, out, inout) for operand N.  */
 155   enum op_type operand_type[MAX_RECOG_OPERANDS];
 156
 157   /* Gives location where the Nth duplicate-appearance of an operand
 158      was found.  This is something that matched MATCH_DUP.  */
 159   rtx *dup_loc[MAX_DUP_OPERANDS];
 160
 161   /* Gives the operand number that was duplicated in the Nth
 162      duplicate-appearance of an operand.  */
 163   char dup_num[MAX_DUP_OPERANDS];
 164
 165   /* ??? Note that these are `char' instead of `unsigned char' to (try to)
 166      avoid certain lossage from K&R C, wherein `unsigned char' default
 167      promotes to `unsigned int' instead of `int' as in ISO C.  As of 1999,
 168      the most common places to bootstrap from K&R C are SunOS and HPUX,
 169      both of which have signed characters by default.  The only other
 170      supported natives that have both K&R C and unsigned characters are
 171      ROMP and Irix 3, and neither have been seen for a while, but do
 172      continue to consider unsignedness when performing arithmetic inside
 173      a comparison.  */
 174
 175   /* The number of operands of the insn.  */
 176   char n_operands;
 177
 178   /* The number of MATCH_DUPs in the insn.  */
 179   char n_dups;
 180
 181   /* The number of alternatives in the constraints for the insn.  */
 182   char n_alternatives;
 183
 184   /* In case we are caching, hold insn data was generated for.  */
 185   rtx insn;
 186 };
 187
 188 extern struct recog_data recog_data;
 189
 190 /* Contains a vector of operand_alternative structures for every operand.
 191    Set up by preprocess_constraints.  */
 192 extern struct operand_alternative recog_op_alt[MAX_RECOG_OPERANDS][MAX_RECOG_ALTERNATIVES];
 193
 194 /* A table defined in insn-output.c that give information about
 195    each insn-code value.  */
 196
 197 typedef int (*insn_operand_predicate_fn) (rtx, enum machine_mode);
 198 typedef const char * (*insn_output_fn) (rtx *, rtx);
 199 typedef rtx (*insn_gen_fn) (rtx, ...);
 200
 201 struct insn_operand_data
 202 {
 203   const insn_operand_predicate_fn predicate;
 204
 205   const char *const constraint;
 206
 207   ENUM_BITFIELD(machine_mode) const mode : 16;
 208
 209   const char strict_low;
 210
 211   const char eliminable;
 212 };
 213
 214 /* Legal values for insn_data.output_format.  Indicate what type of data
 215    is stored in insn_data.output.  */
 216 #define INSN_OUTPUT_FORMAT_NONE         0       /* abort */
 217 #define INSN_OUTPUT_FORMAT_SINGLE       1       /* const char * */
 218 #define INSN_OUTPUT_FORMAT_MULTI        2       /* const char * const * */
 219 #define INSN_OUTPUT_FORMAT_FUNCTION     3       /* const char * (*)(...) */
 220
 221 struct insn_data
 222 {
 223   const char *const name;
 224 #if HAVE_DESIGNATED_INITIALIZERS
 225   union {
 226     const char *single;
 227     const char *const *multi;
 228     insn_output_fn function;
 229   } output;
 230 #else
 231   struct {
 232     const char *single;
 233     const char *const *multi;
 234     insn_output_fn function;
 235   } output;
 236 #endif
 237   const insn_gen_fn genfun;
 238   const struct insn_operand_data *const operand;
 239
 240   const char n_operands;
 241   const char n_dups;
 242   const char n_alternatives;
 243   const char output_format;
 244 };
 245
 246 extern const struct insn_data insn_data[];