gcc/recog.h

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