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