gcc/recog.h

   1 /* Declarations for interface to insn recognizer and insn-output.c.
   2    Copyright (C) 1987, 1996, 1997, 1998, 1999, 2000, 2001
   3    Free Software Foundation, Inc.
   4
   5 This file is part of GNU CC.
   6
   7 GNU CC is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2, or (at your option)
  10 any later version.
  11
  12 GNU CC is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GNU CC; see the file COPYING.  If not, write to
  19 the Free Software Foundation, 59 Temple Place - Suite 330,
  20 Boston, MA 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                  PARAMS ((void));
  75 extern void init_recog_no_volatile      PARAMS ((void));
  76 extern int recog_memoized_1             PARAMS ((rtx));
  77 extern int check_asm_operands           PARAMS ((rtx));
  78 extern int asm_operand_ok               PARAMS ((rtx, const char *));
  79 extern int validate_change              PARAMS ((rtx, rtx *, rtx, int));
  80 extern int insn_invalid_p               PARAMS ((rtx));
  81 extern int apply_change_group           PARAMS ((void));
  82 extern int num_validated_changes        PARAMS ((void));
  83 extern void cancel_changes              PARAMS ((int));
  84 extern int constrain_operands           PARAMS ((int));
  85 extern int constrain_operands_cached    PARAMS ((int));
  86 extern int memory_address_p             PARAMS ((enum machine_mode, rtx));
  87 extern int strict_memory_address_p      PARAMS ((enum machine_mode, rtx));
  88 extern int validate_replace_rtx_subexp  PARAMS ((rtx, rtx, rtx, rtx *));
  89 extern int validate_replace_rtx         PARAMS ((rtx, rtx, rtx));
  90 extern void validate_replace_rtx_group  PARAMS ((rtx, rtx, rtx));
  91 extern int validate_replace_src         PARAMS ((rtx, rtx, rtx));
  92 #ifdef HAVE_cc0
  93 extern int next_insn_tests_no_inequality PARAMS ((rtx));
  94 #endif
  95 extern int reg_fits_class_p             PARAMS ((rtx, enum reg_class, int,
  96                                                enum machine_mode));
  97 extern rtx *find_single_use             PARAMS ((rtx, rtx, rtx *));
  98
  99 extern int general_operand              PARAMS ((rtx, enum machine_mode));
 100 extern int address_operand              PARAMS ((rtx, enum machine_mode));
 101 extern int register_operand             PARAMS ((rtx, enum machine_mode));
 102 extern int pmode_register_operand       PARAMS ((rtx, enum machine_mode));
 103 extern int scratch_operand              PARAMS ((rtx, enum machine_mode));
 104 extern int immediate_operand            PARAMS ((rtx, enum machine_mode));
 105 extern int const_int_operand            PARAMS ((rtx, enum machine_mode));
 106 extern int const_double_operand         PARAMS ((rtx, enum machine_mode));
 107 extern int nonimmediate_operand         PARAMS ((rtx, enum machine_mode));
 108 extern int nonmemory_operand            PARAMS ((rtx, enum machine_mode));
 109 extern int push_operand                 PARAMS ((rtx, enum machine_mode));
 110 extern int pop_operand                  PARAMS ((rtx, enum machine_mode));
 111 extern int memory_operand               PARAMS ((rtx, enum machine_mode));
 112 extern int indirect_operand             PARAMS ((rtx, enum machine_mode));
 113 extern int mode_independent_operand     PARAMS ((rtx, enum machine_mode));
 114 extern int comparison_operator          PARAMS ((rtx, enum machine_mode));
 115
 116 extern int offsettable_memref_p         PARAMS ((rtx));
 117 extern int offsettable_nonstrict_memref_p       PARAMS ((rtx));
 118 extern int offsettable_address_p        PARAMS ((int, enum machine_mode, rtx));
 119 extern int mode_dependent_address_p     PARAMS ((rtx));
 120
 121 extern int recog                        PARAMS ((rtx, rtx, int *));
 122 extern void add_clobbers                PARAMS ((rtx, int));
 123 extern int added_clobbers_hard_reg_p    PARAMS ((int));
 124 extern void insn_extract                PARAMS ((rtx));
 125 extern void extract_insn                PARAMS ((rtx));
 126 extern void extract_constrain_insn_cached PARAMS ((rtx));
 127 extern void extract_insn_cached         PARAMS ((rtx));
 128 extern void preprocess_constraints      PARAMS ((void));
 129 extern rtx peep2_next_insn              PARAMS ((int));
 130 extern int peep2_regno_dead_p           PARAMS ((int, int));
 131 extern int peep2_reg_dead_p             PARAMS ((int, rtx));
 132 #ifdef CLEAR_HARD_REG_SET
 133 extern rtx peep2_find_free_register     PARAMS ((int, int, const char *,
 134                                                  enum machine_mode,
 135                                                  HARD_REG_SET *));
 136 #endif
 137 extern void peephole2_optimize          PARAMS ((FILE *));
 138 extern rtx peephole2_insns              PARAMS ((rtx, rtx, int *));
 139
 140 /* Nonzero means volatile operands are recognized.  */
 141 extern int volatile_ok;
 142
 143 /* Set by constrain_operands to the number of the alternative that
 144    matched.  */
 145 extern int which_alternative;
 146
 147 /* The following vectors hold the results from insn_extract.  */
 148
 149 struct recog_data
 150 {
 151   /* It is very tempting to make the 5 operand related arrays into a
 152      structure and index on that.  However, to be source compatible
 153      with all of the existing md file insn constraints and output
 154      templates, we need `operand' as a flat array.  Without that
 155      member, making an array for the rest seems pointless.  */
 156
 157   /* Gives value of operand N.  */
 158   rtx operand[MAX_RECOG_OPERANDS];
 159
 160   /* Gives location where operand N was found.  */
 161   rtx *operand_loc[MAX_RECOG_OPERANDS];
 162
 163   /* Gives the constraint string for operand N.  */
 164   const char *constraints[MAX_RECOG_OPERANDS];
 165
 166   /* Gives the mode of operand N.  */
 167   enum machine_mode operand_mode[MAX_RECOG_OPERANDS];
 168
 169   /* Gives the type (in, out, inout) for operand N.  */
 170   enum op_type operand_type[MAX_RECOG_OPERANDS];
 171
 172   /* Gives location where the Nth duplicate-appearance of an operand
 173      was found.  This is something that matched MATCH_DUP.  */
 174   rtx *dup_loc[MAX_DUP_OPERANDS];
 175
 176   /* Gives the operand number that was duplicated in the Nth
 177      duplicate-appearance of an operand.  */
 178   char dup_num[MAX_DUP_OPERANDS];
 179
 180   /* ??? Note that these are `char' instead of `unsigned char' to (try to)
 181      avoid certain lossage from K&R C, wherein `unsigned char' default
 182      promotes to `unsigned int' instead of `int' as in ISO C.  As of 1999,
 183      the most common places to bootstrap from K&R C are SunOS and HPUX,
 184      both of which have signed characters by default.  The only other
 185      supported natives that have both K&R C and unsigned characters are
 186      ROMP and Irix 3, and neither have been seen for a while, but do
 187      continue to consider unsignedness when performing arithmetic inside
 188      a comparison.  */
 189
 190   /* The number of operands of the insn.  */
 191   char n_operands;
 192
 193   /* The number of MATCH_DUPs in the insn.  */
 194   char n_dups;
 195
 196   /* The number of alternatives in the constraints for the insn.  */
 197   char n_alternatives;
 198
 199   /* In case we are caching, hold insn data was generated for.  */
 200   rtx insn;
 201 };
 202
 203 extern struct recog_data recog_data;
 204
 205 /* Contains a vector of operand_alternative structures for every operand.
 206    Set up by preprocess_constraints.  */
 207 extern struct operand_alternative recog_op_alt[MAX_RECOG_OPERANDS][MAX_RECOG_ALTERNATIVES];
 208
 209 /* A table defined in insn-output.c that give information about
 210    each insn-code value.  */
 211
 212 typedef int (*insn_operand_predicate_fn) PARAMS ((rtx, enum machine_mode));
 213 typedef const char * (*insn_output_fn) PARAMS ((rtx *, rtx));
 214 typedef rtx (*insn_gen_fn) PARAMS ((rtx, ...));
 215
 216 struct insn_operand_data
 217 {
 218   insn_operand_predicate_fn predicate;
 219
 220   const char *constraint;
 221
 222   enum machine_mode mode;
 223
 224   char strict_low;
 225
 226   char eliminable;
 227 };
 228
 229 /* Legal values for insn_data.output_format.  Indicate what type of data
 230    is stored in insn_data.output.  */
 231 #define INSN_OUTPUT_FORMAT_NONE         0       /* abort */
 232 #define INSN_OUTPUT_FORMAT_SINGLE       1       /* const char * */
 233 #define INSN_OUTPUT_FORMAT_MULTI        2       /* const char * const * */
 234 #define INSN_OUTPUT_FORMAT_FUNCTION     3       /* const char * (*)(...) */
 235
 236 struct insn_data
 237 {
 238   const char *name;
 239   const PTR output;
 240   insn_gen_fn genfun;
 241   const struct insn_operand_data *operand;
 242
 243   char n_operands;
 244   char n_dups;
 245   char n_alternatives;
 246   char output_format;
 247 };
 248
 249 extern const struct insn_data insn_data[];