gcc/recog.h

   1 /* Declarations for interface to insn recognizer and insn-output.c.
   2    Copyright (C) 1987-2019 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 35
  27 typedef uint64_t alternative_mask;  /* Keep in sync with genattrtab.c.  */
  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 *insn, rtx x);
  92 extern int insn_invalid_p (rtx_insn *, 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, alternative_mask);
  99 extern int constrain_operands_cached (rtx_insn *, int);
 100 extern int memory_address_addr_space_p (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 (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_insn *, rtx *);
 108 extern int validate_replace_rtx (rtx, rtx, rtx_insn *);
 109 extern int validate_replace_rtx_part (rtx, rtx, rtx *, rtx_insn *);
 110 extern int validate_replace_rtx_part_nosimplify (rtx, rtx, rtx *, rtx_insn *);
 111 extern void validate_replace_rtx_group (rtx, rtx, rtx_insn *);
 112 extern void validate_replace_src_group (rtx, rtx, rtx_insn *);
 113 extern bool validate_simplify_insn (rtx_insn *insn);
 114 extern int num_changes_pending (void);
 115 extern int next_insn_tests_no_inequality (rtx_insn *);
 116 extern bool reg_fits_class_p (const_rtx, reg_class_t, int, 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, 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_insn *, int *);
 128 #ifndef GENERATOR_FILE
 129 static inline int recog_memoized (rtx_insn *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_insn *);
 134 extern void extract_insn (rtx_insn *);
 135 extern void extract_constrain_insn (rtx_insn *insn);
 136 extern void extract_constrain_insn_cached (rtx_insn *);
 137 extern void extract_insn_cached (rtx_insn *);
 138 extern void preprocess_constraints (int, int, const char **,
 139                                     operand_alternative *, rtx **);
 140 extern const operand_alternative *preprocess_insn_constraints (unsigned int);
 141 extern void preprocess_constraints (rtx_insn *);
 142 extern rtx_insn *peep2_next_insn (int);
 143 extern int peep2_regno_dead_p (int, int);
 144 extern int peep2_reg_dead_p (int, rtx);
 145 #ifdef CLEAR_HARD_REG_SET
 146 extern rtx peep2_find_free_register (int, int, const char *,
 147                                      machine_mode, HARD_REG_SET *);
 148 #endif
 149 extern rtx_insn *peephole2_insns (rtx, rtx_insn *, int *);
 150
 151 extern int store_data_bypass_p (rtx_insn *, rtx_insn *);
 152 extern int if_test_bypass_p (rtx_insn *, rtx_insn *);
 153
 154 #ifndef GENERATOR_FILE
 155 /* Try recognizing the instruction INSN,
 156    and return the code number that results.
 157    Remember the code so that repeated calls do not
 158    need to spend the time for actual rerecognition.
 159
 160    This function is the normal interface to instruction recognition.
 161    The automatically-generated function `recog' is normally called
 162    through this one.  */
 163
 164 static inline int
 165 recog_memoized (rtx_insn *insn)
 166 {
 167   if (INSN_CODE (insn) < 0)
 168     INSN_CODE (insn) = recog (PATTERN (insn), insn, 0);
 169   return INSN_CODE (insn);
 170 }
 171 #endif
 172
 173 /* Skip chars until the next ',' or the end of the string.  This is
 174    useful to skip alternatives in a constraint string.  */
 175 static inline const char *
 176 skip_alternative (const char *p)
 177 {
 178   const char *r = p;
 179   while (*r != '\0' && *r != ',')
 180     r++;
 181   if (*r == ',')
 182     r++;
 183   return r;
 184 }
 185
 186 /* Nonzero means volatile operands are recognized.  */
 187 extern int volatile_ok;
 188
 189 /* RAII class for temporarily setting volatile_ok.  */
 190
 191 class temporary_volatile_ok
 192 {
 193 public:
 194   temporary_volatile_ok (int value) : save_volatile_ok (volatile_ok)
 195   {
 196     volatile_ok = value;
 197   }
 198
 199   ~temporary_volatile_ok () { volatile_ok = save_volatile_ok; }
 200
 201 private:
 202   temporary_volatile_ok (const temporary_volatile_ok &);
 203   int save_volatile_ok;
 204 };
 205
 206 /* Set by constrain_operands to the number of the alternative that
 207    matched.  */
 208 extern int which_alternative;
 209
 210 /* The following vectors hold the results from insn_extract.  */
 211
 212 struct recog_data_d
 213 {
 214   /* It is very tempting to make the 5 operand related arrays into a
 215      structure and index on that.  However, to be source compatible
 216      with all of the existing md file insn constraints and output
 217      templates, we need `operand' as a flat array.  Without that
 218      member, making an array for the rest seems pointless.  */
 219
 220   /* Gives value of operand N.  */
 221   rtx operand[MAX_RECOG_OPERANDS];
 222
 223   /* Gives location where operand N was found.  */
 224   rtx *operand_loc[MAX_RECOG_OPERANDS];
 225
 226   /* Gives the constraint string for operand N.  */
 227   const char *constraints[MAX_RECOG_OPERANDS];
 228
 229   /* Nonzero if operand N is a match_operator or a match_parallel.  */
 230   char is_operator[MAX_RECOG_OPERANDS];
 231
 232   /* Gives the mode of operand N.  */
 233   machine_mode operand_mode[MAX_RECOG_OPERANDS];
 234
 235   /* Gives the type (in, out, inout) for operand N.  */
 236   enum op_type operand_type[MAX_RECOG_OPERANDS];
 237
 238   /* Gives location where the Nth duplicate-appearance of an operand
 239      was found.  This is something that matched MATCH_DUP.  */
 240   rtx *dup_loc[MAX_DUP_OPERANDS];
 241
 242   /* Gives the operand number that was duplicated in the Nth
 243      duplicate-appearance of an operand.  */
 244   char dup_num[MAX_DUP_OPERANDS];
 245
 246   /* ??? Note that these are `char' instead of `unsigned char' to (try to)
 247      avoid certain lossage from K&R C, wherein `unsigned char' default
 248      promotes to `unsigned int' instead of `int' as in ISO C.  As of 1999,
 249      the most common places to bootstrap from K&R C are SunOS and HPUX,
 250      both of which have signed characters by default.  The only other
 251      supported natives that have both K&R C and unsigned characters are
 252      ROMP and Irix 3, and neither have been seen for a while, but do
 253      continue to consider unsignedness when performing arithmetic inside
 254      a comparison.  */
 255
 256   /* The number of operands of the insn.  */
 257   char n_operands;
 258
 259   /* The number of MATCH_DUPs in the insn.  */
 260   char n_dups;
 261
 262   /* The number of alternatives in the constraints for the insn.  */
 263   char n_alternatives;
 264
 265   /* True if insn is ASM_OPERANDS.  */
 266   bool is_asm;
 267
 268   /* In case we are caching, hold insn data was generated for.  */
 269   rtx_insn *insn;
 270 };
 271
 272 extern struct recog_data_d recog_data;
 273
 274 extern const operand_alternative *recog_op_alt;
 275
 276 /* Return a pointer to an array in which index OP describes the constraints
 277    on operand OP of the current instruction alternative (which_alternative).
 278    Only valid after calling preprocess_constraints and constrain_operands.  */
 279
 280 inline static const operand_alternative *
 281 which_op_alt ()
 282 {
 283   gcc_checking_assert (IN_RANGE (which_alternative, 0,
 284                                  recog_data.n_alternatives - 1));
 285   return &recog_op_alt[which_alternative * recog_data.n_operands];
 286 }
 287
 288 /* A table defined in insn-output.c that give information about
 289    each insn-code value.  */
 290
 291 typedef int (*insn_operand_predicate_fn) (rtx, machine_mode);
 292 typedef const char * (*insn_output_fn) (rtx *, rtx_insn *);
 293
 294 struct insn_gen_fn
 295 {
 296   typedef rtx_insn * (*f0) (void);
 297   typedef rtx_insn * (*f1) (rtx);
 298   typedef rtx_insn * (*f2) (rtx, rtx);
 299   typedef rtx_insn * (*f3) (rtx, rtx, rtx);
 300   typedef rtx_insn * (*f4) (rtx, rtx, rtx, rtx);
 301   typedef rtx_insn * (*f5) (rtx, rtx, rtx, rtx, rtx);
 302   typedef rtx_insn * (*f6) (rtx, rtx, rtx, rtx, rtx, rtx);
 303   typedef rtx_insn * (*f7) (rtx, rtx, rtx, rtx, rtx, rtx, rtx);
 304   typedef rtx_insn * (*f8) (rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx);
 305   typedef rtx_insn * (*f9) (rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx);
 306   typedef rtx_insn * (*f10) (rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx);
 307   typedef rtx_insn * (*f11) (rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx);
 308   typedef rtx_insn * (*f12) (rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx);
 309   typedef rtx_insn * (*f13) (rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx);
 310   typedef rtx_insn * (*f14) (rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx);
 311   typedef rtx_insn * (*f15) (rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx);
 312   typedef rtx_insn * (*f16) (rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx, rtx);
 313
 314   typedef void (*stored_funcptr) (void);
 315
 316   rtx_insn * operator () (void) const { return ((f0)func) (); }
 317   rtx_insn * operator () (rtx a0) const { return ((f1)func) (a0); }
 318   rtx_insn * operator () (rtx a0, rtx a1) const { return ((f2)func) (a0, a1); }
 319   rtx_insn * operator () (rtx a0, rtx a1, rtx a2) const { return ((f3)func) (a0, a1, a2); }
 320   rtx_insn * operator () (rtx a0, rtx a1, rtx a2, rtx a3) const { return ((f4)func) (a0, a1, a2, a3); }
 321   rtx_insn * operator () (rtx a0, rtx a1, rtx a2, rtx a3, rtx a4) const { return ((f5)func) (a0, a1, a2, a3, a4); }
 322   rtx_insn * operator () (rtx a0, rtx a1, rtx a2, rtx a3, rtx a4, rtx a5) const { return ((f6)func) (a0, a1, a2, a3, a4, a5); }
 323   rtx_insn * 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); }
 324   rtx_insn * 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); }
 325   rtx_insn * 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); }
 326   rtx_insn * 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); }
 327   rtx_insn * 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); }
 328   rtx_insn * 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); }
 329   rtx_insn * 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); }
 330   rtx_insn * 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); }
 331   rtx_insn * 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); }
 332   rtx_insn * 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); }
 333
 334   // This is for compatibility of code that invokes functions like
 335   //   (*funcptr) (arg)
 336   insn_gen_fn operator * (void) const { return *this; }
 337
 338   // The wrapped function pointer must be public and there must not be any
 339   // constructors.  Otherwise the insn_data_d struct initializers generated
 340   // by genoutput.c will result in static initializer functions, which defeats
 341   // the purpose of the generated insn_data_d array.
 342   stored_funcptr func;
 343 };
 344
 345 struct insn_operand_data
 346 {
 347   const insn_operand_predicate_fn predicate;
 348
 349   const char *const constraint;
 350
 351   ENUM_BITFIELD(machine_mode) const mode : 16;
 352
 353   const char strict_low;
 354
 355   const char is_operator;
 356
 357   const char eliminable;
 358
 359   const char allows_mem;
 360 };
 361
 362 /* Legal values for insn_data.output_format.  Indicate what type of data
 363    is stored in insn_data.output.  */
 364 #define INSN_OUTPUT_FORMAT_NONE         0       /* abort */
 365 #define INSN_OUTPUT_FORMAT_SINGLE       1       /* const char * */
 366 #define INSN_OUTPUT_FORMAT_MULTI        2       /* const char * const * */
 367 #define INSN_OUTPUT_FORMAT_FUNCTION     3       /* const char * (*)(...) */
 368
 369 struct insn_data_d
 370 {
 371   const char *const name;
 372 #if HAVE_DESIGNATED_UNION_INITIALIZERS
 373   union {
 374     const char *single;
 375     const char *const *multi;
 376     insn_output_fn function;
 377   } output;
 378 #else
 379   struct {
 380     const char *single;
 381     const char *const *multi;
 382     insn_output_fn function;
 383   } output;
 384 #endif
 385   const insn_gen_fn genfun;
 386   const struct insn_operand_data *const operand;
 387
 388   const char n_generator_args;
 389   const char n_operands;
 390   const char n_dups;
 391   const char n_alternatives;
 392   const char output_format;
 393 };
 394
 395 extern const struct insn_data_d insn_data[];
 396 extern int peep2_current_count;
 397
 398 #ifndef GENERATOR_FILE
 399 #include "insn-codes.h"
 400
 401 /* An enum of boolean attributes that may only depend on the current
 402    subtarget, not on things like operands or compiler phase.  */
 403 enum bool_attr {
 404   BA_ENABLED,
 405   BA_PREFERRED_FOR_SPEED,
 406   BA_PREFERRED_FOR_SIZE,
 407   BA_LAST = BA_PREFERRED_FOR_SIZE
 408 };
 409
 410 /* Target-dependent globals.  */
 411 struct target_recog {
 412   bool x_initialized;
 413   alternative_mask x_bool_attr_masks[NUM_INSN_CODES][BA_LAST + 1];
 414   operand_alternative *x_op_alt[NUM_INSN_CODES];
 415 };
 416
 417 extern struct target_recog default_target_recog;
 418 #if SWITCHABLE_TARGET
 419 extern struct target_recog *this_target_recog;
 420 #else
 421 #define this_target_recog (&default_target_recog)
 422 #endif
 423
 424 alternative_mask get_enabled_alternatives (rtx_insn *);
 425 alternative_mask get_preferred_alternatives (rtx_insn *);
 426 alternative_mask get_preferred_alternatives (rtx_insn *, basic_block);
 427 bool check_bool_attrs (rtx_insn *);
 428
 429 void recog_init ();
 430 #endif
 431
 432 #endif /* GCC_RECOG_H */