gcc/recog.h

   1 /* Declarations for interface to insn recognizer and insn-output.c.
   2    Copyright (C) 1987-2014 Free Software Foundation, Inc.
   3
   4 This file is part of GCC.
   5
   6 GCC is free software; you can redistribute it and/or modify it under
   7 the terms of the GNU General Public License as published by the Free
   8 Software Foundation; either version 3, or (at your option) any later
   9 version.
  10
  11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14 for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GCC; see the file COPYING3.  If not see
  18 <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef GCC_RECOG_H
  21 #define GCC_RECOG_H
  22
  23 /* Random number that should be large enough for all purposes.  Also define
  24    a type that has at least MAX_RECOG_ALTERNATIVES + 1 bits, with the extra
  25    bit giving an invalid value that can be used to mean "uninitialized".  */
  26 #define MAX_RECOG_ALTERNATIVES 30
  27 typedef unsigned int alternative_mask;
  28
  29 /* A mask of all alternatives.  */
  30 #define ALL_ALTERNATIVES ((alternative_mask) -1)
  31
  32 /* A mask containing just alternative X.  */
  33 #define ALTERNATIVE_BIT(X) ((alternative_mask) 1 << (X))
  34
  35 /* Types of operands.  */
  36 enum op_type {
  37   OP_IN,
  38   OP_OUT,
  39   OP_INOUT
  40 };
  41
  42 struct operand_alternative
  43 {
  44   /* Pointer to the beginning of the constraint string for this alternative,
  45      for easier access by alternative number.  */
  46   const char *constraint;
  47
  48   /* The register class valid for this alternative (possibly NO_REGS).  */
  49   ENUM_BITFIELD (reg_class) cl : 16;
  50
  51   /* "Badness" of this alternative, computed from number of '?' and '!'
  52      characters in the constraint string.  */
  53   unsigned int reject : 16;
  54
  55   /* -1 if no matching constraint was found, or an operand number.  */
  56   int matches : 8;
  57   /* The same information, but reversed: -1 if this operand is not
  58      matched by any other, or the operand number of the operand that
  59      matches this one.  */
  60   int matched : 8;
  61
  62   /* Nonzero if '&' was found in the constraint string.  */
  63   unsigned int earlyclobber : 1;
  64   /* Nonzero if TARGET_MEM_CONSTRAINT was found in the constraint
  65      string.  */
  66   unsigned int memory_ok : 1;
  67   /* Nonzero if 'p' was found in the constraint string.  */
  68   unsigned int is_address : 1;
  69   /* Nonzero if 'X' was found in the constraint string, or if the constraint
  70      string for this alternative was empty.  */
  71   unsigned int anything_ok : 1;
  72
  73   unsigned int unused : 12;
  74 };
  75
  76 /* Return the class for operand I of alternative ALT, taking matching
  77    constraints into account.  */
  78
  79 static inline enum reg_class
  80 alternative_class (const operand_alternative *alt, int i)
  81 {
  82   return alt[i].matches >= 0 ? alt[alt[i].matches].cl : alt[i].cl;
  83 }
  84
  85 extern void init_recog (void);
  86 extern void init_recog_no_volatile (void);
  87 extern int check_asm_operands (rtx);
  88 extern int asm_operand_ok (rtx, const char *, const char **);
  89 extern bool validate_change (rtx, rtx *, rtx, bool);
  90 extern bool validate_unshare_change (rtx, rtx *, rtx, bool);
  91 extern bool canonicalize_change_group (rtx insn, rtx x);
  92 extern int insn_invalid_p (rtx, bool);
  93 extern int verify_changes (int);
  94 extern void confirm_change_group (void);
  95 extern int apply_change_group (void);
  96 extern int num_validated_changes (void);
  97 extern void cancel_changes (int);
  98 extern int constrain_operands (int);
  99 extern int constrain_operands_cached (int);
 100 extern int memory_address_addr_space_p (enum machine_mode, rtx, addr_space_t);
 101 #define memory_address_p(mode,addr) \
 102         memory_address_addr_space_p ((mode), (addr), ADDR_SPACE_GENERIC)
 103 extern int strict_memory_address_addr_space_p (enum machine_mode, rtx,
 104                                                addr_space_t);
 105 #define strict_memory_address_p(mode,addr) \
 106         strict_memory_address_addr_space_p ((mode), (addr), ADDR_SPACE_GENERIC)
 107 extern int validate_replace_rtx_subexp (rtx, rtx, rtx, rtx *);
 108 extern int validate_replace_rtx (rtx, rtx, rtx);
 109 extern int validate_replace_rtx_part (rtx, rtx, rtx *, rtx);
 110 extern int validate_replace_rtx_part_nosimplify (rtx, rtx, rtx *, rtx);
 111 extern void validate_replace_rtx_group (rtx, rtx, rtx);
 112 extern void validate_replace_src_group (rtx, rtx, rtx);
 113 extern bool validate_simplify_insn (rtx insn);
 114 extern int num_changes_pending (void);
 115 #ifdef HAVE_cc0
 116 extern int next_insn_tests_no_inequality (rtx);
 117 #endif
 118 extern bool reg_fits_class_p (const_rtx, reg_class_t, int, enum machine_mode);
 119
 120 extern int offsettable_memref_p (rtx);
 121 extern int offsettable_nonstrict_memref_p (rtx);
 122 extern int offsettable_address_addr_space_p (int, enum machine_mode, rtx,
 123                                              addr_space_t);
 124 #define offsettable_address_p(strict,mode,addr) \
 125         offsettable_address_addr_space_p ((strict), (mode), (addr), \
 126                                           ADDR_SPACE_GENERIC)
 127 extern bool mode_dependent_address_p (rtx, addr_space_t);
 128
 129 extern int recog (rtx, rtx, int *);
 130 #ifndef GENERATOR_FILE
 131 static inline int recog_memoized (rtx insn);
 132 #endif
 133 extern void add_clobbers (rtx, int);
 134 extern int added_clobbers_hard_reg_p (int);
 135 extern void insn_extract (rtx);
 136 extern void extract_insn (rtx);
 137 extern void extract_constrain_insn_cached (rtx);
 138 extern void extract_insn_cached (rtx);
 139 extern void preprocess_constraints (int, int, const char **,
 140                                     operand_alternative *);
 141 extern const operand_alternative *preprocess_insn_constraints (int);
 142 extern void preprocess_constraints (rtx);
 143 extern rtx peep2_next_insn (int);
 144 extern int peep2_regno_dead_p (int, int);
 145 extern int peep2_reg_dead_p (int, rtx);
 146 #ifdef CLEAR_HARD_REG_SET
 147 extern rtx peep2_find_free_register (int, int, const char *,
 148                                      enum machine_mode, HARD_REG_SET *);
 149 #endif
 150 extern rtx peephole2_insns (rtx, rtx, int *);
 151
 152 extern int store_data_bypass_p (rtx, rtx);
 153 extern int if_test_bypass_p (rtx, rtx);
 154
 155 #ifndef GENERATOR_FILE
 156 /* Try recognizing the instruction INSN,
 157    and return the code number that results.
 158    Remember the code so that repeated calls do not
 159    need to spend the time for actual rerecognition.
 160
 161    This function is the normal interface to instruction recognition.
 162    The automatically-generated function `recog' is normally called
 163    through this one.  */
 164
 165 static inline int
 166 recog_memoized (rtx insn)
 167 {
 168   if (INSN_CODE (insn) < 0)
 169     INSN_CODE (insn) = recog (PATTERN (insn), insn, 0);
 170   return INSN_CODE (insn);
 171 }
 172 #endif
 173
 174 /* Skip chars until the next ',' or the end of the string.  This is
 175    useful to skip alternatives in a constraint string.  */
 176 static inline const char *
 177 skip_alternative (const char *p)
 178 {
 179   const char *r = p;
 180   while (*r != '\0' && *r != ',')
 181     r++;
 182   if (*r == ',')
 183     r++;
 184   return r;
 185 }
 186
 187 /* Nonzero means volatile operands are recognized.  */
 188 extern int volatile_ok;
 189
 190 /* Set by constrain_operands to the number of the alternative that
 191    matched.  */
 192 extern int which_alternative;
 193
 194 /* The following vectors hold the results from insn_extract.  */
 195
 196 struct recog_data_d
 197 {
 198   /* It is very tempting to make the 5 operand related arrays into a
 199      structure and index on that.  However, to be source compatible
 200      with all of the existing md file insn constraints and output
 201      templates, we need `operand' as a flat array.  Without that
 202      member, making an array for the rest seems pointless.  */
 203
 204   /* Gives value of operand N.  */
 205   rtx operand[MAX_RECOG_OPERANDS];
 206
 207   /* Gives location where operand N was found.  */
 208   rtx *operand_loc[MAX_RECOG_OPERANDS];
 209
 210   /* Gives the constraint string for operand N.  */
 211   const char *constraints[MAX_RECOG_OPERANDS];
 212
 213   /* Nonzero if operand N is a match_operator or a match_parallel.  */
 214   char is_operator[MAX_RECOG_OPERANDS];
 215
 216   /* Gives the mode of operand N.  */
 217   enum machine_mode operand_mode[MAX_RECOG_OPERANDS];
 218
 219   /* Gives the type (in, out, inout) for operand N.  */
 220   enum op_type operand_type[MAX_RECOG_OPERANDS];
 221
 222   /* Gives location where the Nth duplicate-appearance of an operand
 223      was found.  This is something that matched MATCH_DUP.  */
 224   rtx *dup_loc[MAX_DUP_OPERANDS];
 225
 226   /* Gives the operand number that was duplicated in the Nth
 227      duplicate-appearance of an operand.  */
 228   char dup_num[MAX_DUP_OPERANDS];
 229
 230   /* ??? Note that these are `char' instead of `unsigned char' to (try to)
 231      avoid certain lossage from K&R C, wherein `unsigned char' default
 232      promotes to `unsigned int' instead of `int' as in ISO C.  As of 1999,
 233      the most common places to bootstrap from K&R C are SunOS and HPUX,
 234      both of which have signed characters by default.  The only other
 235      supported natives that have both K&R C and unsigned characters are
 236      ROMP and Irix 3, and neither have been seen for a while, but do
 237      continue to consider unsignedness when performing arithmetic inside
 238      a comparison.  */
 239
 240   /* The number of operands of the insn.  */
 241   char n_operands;
 242
 243   /* The number of MATCH_DUPs in the insn.  */
 244   char n_dups;
 245
 246   /* The number of alternatives in the constraints for the insn.  */
 247   char n_alternatives;
 248
 249   /* True if insn is ASM_OPERANDS.  */
 250   bool is_asm;
 251
 252   /* Specifies whether an insn alternative is enabled using the `enabled'
 253      attribute in the insn pattern definition.  For back ends not using
 254      the `enabled' attribute the bits are always set to 1 in expand_insn.
 255      Bits beyond the last alternative are also set to 1.  */
 256   alternative_mask enabled_alternatives;
 257
 258   /* In case we are caching, hold insn data was generated for.  */
 259   rtx insn;
 260 };
 261
 262 extern struct recog_data_d recog_data;
 263
 264 extern const operand_alternative *recog_op_alt;
 265
 266 /* Return a pointer to an array in which index OP describes the constraints
 267    on operand OP of the current instruction alternative (which_alternative).
 268    Only valid after calling preprocess_constraints and constrain_operands.  */
 269
 270 inline static const operand_alternative *
 271 which_op_alt ()
 272 {
 273   gcc_checking_assert (IN_RANGE (which_alternative, 0,
 274                                  recog_data.n_alternatives - 1));
 275   return &recog_op_alt[which_alternative * recog_data.n_operands];
 276 }
 277
 278 /* A table defined in insn-output.c that give information about
 279    each insn-code value.  */
 280
 281 typedef int (*insn_operand_predicate_fn) (rtx, enum machine_mode);
 282 typedef const char * (*insn_output_fn) (rtx *, rtx);
 283
 284 struct insn_gen_fn
 285 {
 286   typedef rtx (*f0) (void);
 287   typedef rtx (*f1) (rtx);
 288   typedef rtx (*f2) (rtx, rtx);
 289   typedef rtx (*f3) (rtx, rtx, rtx);
 290   typedef rtx (*f4) (rtx, rtx, rtx, rtx);
 291   typedef rtx (*f5) (rtx, rtx, rtx, rtx, rtx);
 292   typedef rtx (*f6) (rtx, rtx, rtx, rtx, rtx, rtx);
 293   typedef rtx (*f7) (rtx, rtx, rtx, rtx, rtx, rtx, rtx);
 294   typedef rtx (*f8) (rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx);
 295   typedef rtx (*f9) (rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx);
 296   typedef rtx (*f10) (rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx);
 297   typedef rtx (*f11) (rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx);
 298   typedef rtx (*f12) (rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx);
 299   typedef rtx (*f13) (rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx);
 300   typedef rtx (*f14) (rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx);
 301   typedef rtx (*f15) (rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx);
 302   typedef rtx (*f16) (rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx);
 303
 304   typedef f0 stored_funcptr;
 305
 306   rtx operator () (void) const { return ((f0)func) (); }
 307   rtx operator () (rtx a0) const { return ((f1)func) (a0); }
 308   rtx operator () (rtx a0, rtx a1) const { return ((f2)func) (a0, a1); }
 309   rtx operator () (rtx a0, rtx a1, rtx a2) const { return ((f3)func) (a0, a1, a2); }
 310   rtx operator () (rtx a0, rtx a1, rtx a2, rtx a3) const { return ((f4)func) (a0, a1, a2, a3); }
 311   rtx operator () (rtx a0, rtx a1, rtx a2, rtx a3, rtx a4) const { return ((f5)func) (a0, a1, a2, a3, a4); }
 312   rtx operator () (rtx a0, rtx a1, rtx a2, rtx a3, rtx a4, rtx a5) const { return ((f6)func) (a0, a1, a2, a3, a4, a5); }
 313   rtx operator () (rtx a0, rtx a1, rtx a2, rtx a3, rtx a4, rtx a5, rtx a6) const { return ((f7)func) (a0, a1, a2, a3, a4, a5, a6); }
 314   rtx operator () (rtx a0, rtx a1, rtx a2, rtx a3, rtx a4, rtx a5, rtx a6, rtx a7) const { return ((f8)func) (a0, a1, a2, a3, a4, a5, a6, a7); }
 315   rtx operator () (rtx a0, rtx a1, rtx a2, rtx a3, rtx a4, rtx a5, rtx a6, rtx a7, rtx a8) const { return ((f9)func) (a0, a1, a2, a3, a4, a5, a6, a7, a8); }
 316   rtx operator () (rtx a0, rtx a1, rtx a2, rtx a3, rtx a4, rtx a5, rtx a6, rtx a7, rtx a8, rtx a9) const { return ((f10)func) (a0, a1, a2, a3, a4, a5, a6, a7, a8, a9); }
 317   rtx operator () (rtx a0, rtx a1, rtx a2, rtx a3, rtx a4, rtx a5, rtx a6, rtx a7, rtx a8, rtx a9, rtx a10) const { return ((f11)func) (a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10); }
 318   rtx operator () (rtx a0, rtx a1, rtx a2, rtx a3, rtx a4, rtx a5, rtx a6, rtx a7, rtx a8, rtx a9, rtx a10, rtx a11) const { return ((f12)func) (a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11); }
 319   rtx operator () (rtx a0, rtx a1, rtx a2, rtx a3, rtx a4, rtx a5, rtx a6, rtx a7, rtx a8, rtx a9, rtx a10, rtx a11, rtx a12) const { return ((f13)func) (a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12); }
 320   rtx operator () (rtx a0, rtx a1, rtx a2, rtx a3, rtx a4, rtx a5, rtx a6, rtx a7, rtx a8, rtx a9, rtx a10, rtx a11, rtx a12, rtx a13) const { return ((f14)func) (a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13); }
 321   rtx operator () (rtx a0, rtx a1, rtx a2, rtx a3, rtx a4, rtx a5, rtx a6, rtx a7, rtx a8, rtx a9, rtx a10, rtx a11, rtx a12, rtx a13, rtx a14) const { return ((f15)func) (a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14); }
 322   rtx operator () (rtx a0, rtx a1, rtx a2, rtx a3, rtx a4, rtx a5, rtx a6, rtx a7, rtx a8, rtx a9, rtx a10, rtx a11, rtx a12, rtx a13, rtx a14, rtx a15) const { return ((f16)func) (a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15); }
 323
 324   // This is for compatibility of code that invokes functions like
 325   //   (*funcptr) (arg)
 326   insn_gen_fn operator * (void) const { return *this; }
 327
 328   // The wrapped function pointer must be public and there must not be any
 329   // constructors.  Otherwise the insn_data_d struct initializers generated
 330   // by genoutput.c will result in static initializer functions, which defeats
 331   // the purpose of the generated insn_data_d array.
 332   stored_funcptr func;
 333 };
 334
 335 struct insn_operand_data
 336 {
 337   const insn_operand_predicate_fn predicate;
 338
 339   const char *const constraint;
 340
 341   ENUM_BITFIELD(machine_mode) const mode : 16;
 342
 343   const char strict_low;
 344
 345   const char is_operator;
 346
 347   const char eliminable;
 348
 349   const char allows_mem;
 350 };
 351
 352 /* Legal values for insn_data.output_format.  Indicate what type of data
 353    is stored in insn_data.output.  */
 354 #define INSN_OUTPUT_FORMAT_NONE         0       /* abort */
 355 #define INSN_OUTPUT_FORMAT_SINGLE       1       /* const char * */
 356 #define INSN_OUTPUT_FORMAT_MULTI        2       /* const char * const * */
 357 #define INSN_OUTPUT_FORMAT_FUNCTION     3       /* const char * (*)(...) */
 358
 359 struct insn_data_d
 360 {
 361   const char *const name;
 362 #if HAVE_DESIGNATED_UNION_INITIALIZERS
 363   union {
 364     const char *single;
 365     const char *const *multi;
 366     insn_output_fn function;
 367   } output;
 368 #else
 369   struct {
 370     const char *single;
 371     const char *const *multi;
 372     insn_output_fn function;
 373   } output;
 374 #endif
 375   const insn_gen_fn genfun;
 376   const struct insn_operand_data *const operand;
 377
 378   const char n_generator_args;
 379   const char n_operands;
 380   const char n_dups;
 381   const char n_alternatives;
 382   const char output_format;
 383 };
 384
 385 extern const struct insn_data_d insn_data[];
 386 extern int peep2_current_count;
 387
 388 #ifndef GENERATOR_FILE
 389 #include "insn-codes.h"
 390
 391 /* Target-dependent globals.  */
 392 struct target_recog {
 393   bool x_initialized;
 394   alternative_mask x_enabled_alternatives[LAST_INSN_CODE];
 395   operand_alternative *x_op_alt[LAST_INSN_CODE];
 396 };
 397
 398 extern struct target_recog default_target_recog;
 399 #if SWITCHABLE_TARGET
 400 extern struct target_recog *this_target_recog;
 401 #else
 402 #define this_target_recog (&default_target_recog)
 403 #endif
 404
 405 alternative_mask get_enabled_alternatives (rtx);
 406
 407 void recog_init ();
 408 #endif
 409
 410 #endif /* GCC_RECOG_H */