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