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    2005, 2006, 2007, 2008, 2009 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 3, 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 COPYING3.  If not see
  19 <http://www.gnu.org/licenses/>.  */
  20
  21 /* Random number that should be large enough for all purposes.  */
  22 #define MAX_RECOG_ALTERNATIVES 30
  23
  24 /* Types of operands.  */
  25 enum op_type {
  26   OP_IN,
  27   OP_OUT,
  28   OP_INOUT
  29 };
  30
  31 struct operand_alternative
  32 {
  33   /* Pointer to the beginning of the constraint string for this alternative,
  34      for easier access by alternative number.  */
  35   const char *constraint;
  36
  37   /* The register class valid for this alternative (possibly NO_REGS).  */
  38   enum reg_class cl;
  39
  40   /* "Badness" of this alternative, computed from number of '?' and '!'
  41      characters in the constraint string.  */
  42   unsigned int reject;
  43
  44   /* -1 if no matching constraint was found, or an operand number.  */
  45   int matches;
  46   /* The same information, but reversed: -1 if this operand is not
  47      matched by any other, or the operand number of the operand that
  48      matches this one.  */
  49   int matched;
  50
  51   /* Nonzero if '&' was found in the constraint string.  */
  52   unsigned int earlyclobber:1;
  53   /* Nonzero if TARGET_MEM_CONSTRAINT was found in the constraint
  54      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 *, const char **);
  76 extern bool validate_change (rtx, rtx *, rtx, bool);
  77 extern bool validate_unshare_change (rtx, rtx *, rtx, bool);
  78 extern bool canonicalize_change_group (rtx insn, rtx x);
  79 extern int insn_invalid_p (rtx);
  80 extern int verify_changes (int);
  81 extern void confirm_change_group (void);
  82 extern int apply_change_group (void);
  83 extern int num_validated_changes (void);
  84 extern void cancel_changes (int);
  85 extern int constrain_operands (int);
  86 extern int constrain_operands_cached (int);
  87 extern int memory_address_p (enum machine_mode, rtx);
  88 extern int strict_memory_address_p (enum machine_mode, rtx);
  89 extern int validate_replace_rtx_subexp (rtx, rtx, rtx, rtx *);
  90 extern int validate_replace_rtx (rtx, rtx, rtx);
  91 extern int validate_replace_rtx_part (rtx, rtx, rtx *, rtx);
  92 extern int validate_replace_rtx_part_nosimplify (rtx, rtx, rtx *, rtx);
  93 extern void validate_replace_rtx_group (rtx, rtx, rtx);
  94 extern void validate_replace_src_group (rtx, rtx, rtx);
  95 extern bool validate_simplify_insn (rtx insn);
  96 extern int num_changes_pending (void);
  97 #ifdef HAVE_cc0
  98 extern int next_insn_tests_no_inequality (rtx);
  99 #endif
 100 extern int reg_fits_class_p (rtx, enum reg_class, int, enum machine_mode);
 101
 102 extern int offsettable_memref_p (rtx);
 103 extern int offsettable_nonstrict_memref_p (rtx);
 104 extern int offsettable_address_p (int, enum machine_mode, rtx);
 105 extern int mode_dependent_address_p (rtx);
 106
 107 extern int recog (rtx, rtx, int *);
 108 #ifndef GENERATOR_FILE
 109 static inline int recog_memoized (rtx insn);
 110 #endif
 111 extern void add_clobbers (rtx, int);
 112 extern int added_clobbers_hard_reg_p (int);
 113 extern void insn_extract (rtx);
 114 extern void extract_insn (rtx);
 115 extern void extract_constrain_insn_cached (rtx);
 116 extern void extract_insn_cached (rtx);
 117 extern void preprocess_constraints (void);
 118 extern rtx peep2_next_insn (int);
 119 extern int peep2_regno_dead_p (int, int);
 120 extern int peep2_reg_dead_p (int, rtx);
 121 #ifdef CLEAR_HARD_REG_SET
 122 extern rtx peep2_find_free_register (int, int, const char *,
 123                                      enum machine_mode, HARD_REG_SET *);
 124 #endif
 125 extern rtx peephole2_insns (rtx, rtx, int *);
 126
 127 extern int store_data_bypass_p (rtx, rtx);
 128 extern int if_test_bypass_p (rtx, rtx);
 129
 130 #ifndef GENERATOR_FILE
 131 /* Try recognizing the instruction INSN,
 132    and return the code number that results.
 133    Remember the code so that repeated calls do not
 134    need to spend the time for actual rerecognition.
 135
 136    This function is the normal interface to instruction recognition.
 137    The automatically-generated function `recog' is normally called
 138    through this one.  */
 139
 140 static inline int
 141 recog_memoized (rtx insn)
 142 {
 143   if (INSN_CODE (insn) < 0)
 144     INSN_CODE (insn) = recog (PATTERN (insn), insn, 0);
 145   return INSN_CODE (insn);
 146 }
 147 #endif
 148
 149 /* Skip chars until the next ',' or the end of the string.  This is
 150    useful to skip alternatives in a constraint string.  */
 151 static inline const char *
 152 skip_alternative (const char *p)
 153 {
 154   const char *r = p;
 155   while (*r != '\0' && *r != ',')
 156     r++;
 157   if (*r == ',')
 158     r++;
 159   return r;
 160 }
 161
 162 /* Nonzero means volatile operands are recognized.  */
 163 extern int volatile_ok;
 164
 165 /* Set by constrain_operands to the number of the alternative that
 166    matched.  */
 167 extern int which_alternative;
 168
 169 /* The following vectors hold the results from insn_extract.  */
 170
 171 struct recog_data
 172 {
 173   /* It is very tempting to make the 5 operand related arrays into a
 174      structure and index on that.  However, to be source compatible
 175      with all of the existing md file insn constraints and output
 176      templates, we need `operand' as a flat array.  Without that
 177      member, making an array for the rest seems pointless.  */
 178
 179   /* Gives value of operand N.  */
 180   rtx operand[MAX_RECOG_OPERANDS];
 181
 182   /* Gives location where operand N was found.  */
 183   rtx *operand_loc[MAX_RECOG_OPERANDS];
 184
 185   /* Gives the constraint string for operand N.  */
 186   const char *constraints[MAX_RECOG_OPERANDS];
 187
 188   /* Gives the mode of operand N.  */
 189   enum machine_mode operand_mode[MAX_RECOG_OPERANDS];
 190
 191   /* Gives the type (in, out, inout) for operand N.  */
 192   enum op_type operand_type[MAX_RECOG_OPERANDS];
 193
 194   /* Gives location where the Nth duplicate-appearance of an operand
 195      was found.  This is something that matched MATCH_DUP.  */
 196   rtx *dup_loc[MAX_DUP_OPERANDS];
 197
 198   /* Gives the operand number that was duplicated in the Nth
 199      duplicate-appearance of an operand.  */
 200   char dup_num[MAX_DUP_OPERANDS];
 201
 202   /* ??? Note that these are `char' instead of `unsigned char' to (try to)
 203      avoid certain lossage from K&R C, wherein `unsigned char' default
 204      promotes to `unsigned int' instead of `int' as in ISO C.  As of 1999,
 205      the most common places to bootstrap from K&R C are SunOS and HPUX,
 206      both of which have signed characters by default.  The only other
 207      supported natives that have both K&R C and unsigned characters are
 208      ROMP and Irix 3, and neither have been seen for a while, but do
 209      continue to consider unsignedness when performing arithmetic inside
 210      a comparison.  */
 211
 212   /* The number of operands of the insn.  */
 213   char n_operands;
 214
 215   /* The number of MATCH_DUPs in the insn.  */
 216   char n_dups;
 217
 218   /* The number of alternatives in the constraints for the insn.  */
 219   char n_alternatives;
 220
 221   /* Specifies whether an insn alternative is enabled using the
 222      `enabled' attribute in the insn pattern definition.  For back
 223      ends not using the `enabled' attribute the array fields are
 224      always set to `true' in expand_insn.  */
 225   bool alternative_enabled_p [MAX_RECOG_ALTERNATIVES];
 226
 227   /* In case we are caching, hold insn data was generated for.  */
 228   rtx insn;
 229 };
 230
 231 extern struct recog_data recog_data;
 232
 233 /* Contains a vector of operand_alternative structures for every operand.
 234    Set up by preprocess_constraints.  */
 235 extern struct operand_alternative recog_op_alt[MAX_RECOG_OPERANDS][MAX_RECOG_ALTERNATIVES];
 236
 237 /* A table defined in insn-output.c that give information about
 238    each insn-code value.  */
 239
 240 typedef int (*insn_operand_predicate_fn) (rtx, enum machine_mode);
 241 typedef const char * (*insn_output_fn) (rtx *, rtx);
 242 typedef rtx (*insn_gen_fn) (rtx, ...);
 243
 244 struct insn_operand_data
 245 {
 246   const insn_operand_predicate_fn predicate;
 247
 248   const char *const constraint;
 249
 250   ENUM_BITFIELD(machine_mode) const mode : 16;
 251
 252   const char strict_low;
 253
 254   const char eliminable;
 255 };
 256
 257 /* Legal values for insn_data.output_format.  Indicate what type of data
 258    is stored in insn_data.output.  */
 259 #define INSN_OUTPUT_FORMAT_NONE         0       /* abort */
 260 #define INSN_OUTPUT_FORMAT_SINGLE       1       /* const char * */
 261 #define INSN_OUTPUT_FORMAT_MULTI        2       /* const char * const * */
 262 #define INSN_OUTPUT_FORMAT_FUNCTION     3       /* const char * (*)(...) */
 263
 264 struct insn_data
 265 {
 266   const char *const name;
 267 #if HAVE_DESIGNATED_INITIALIZERS
 268   union {
 269     const char *single;
 270     const char *const *multi;
 271     insn_output_fn function;
 272   } output;
 273 #else
 274   struct {
 275     const char *single;
 276     const char *const *multi;
 277     insn_output_fn function;
 278   } output;
 279 #endif
 280   const insn_gen_fn genfun;
 281   const struct insn_operand_data *const operand;
 282
 283   const char n_operands;
 284   const char n_dups;
 285   const char n_alternatives;
 286   const char output_format;
 287 };
 288
 289 extern const struct insn_data insn_data[];
 290 extern int peep2_current_count;