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
 117 extern int offsettable_memref_p (rtx);
 118 extern int offsettable_nonstrict_memref_p (rtx);
 119 extern int offsettable_address_addr_space_p (int, machine_mode, rtx,
 120                                              addr_space_t);
 121 #define offsettable_address_p(strict,mode,addr) \
 122         offsettable_address_addr_space_p ((strict), (mode), (addr), \
 123                                           ADDR_SPACE_GENERIC)
 124 extern bool mode_dependent_address_p (rtx, addr_space_t);
 125
 126 extern int recog (rtx, rtx_insn *, int *);
 127 #ifndef GENERATOR_FILE
 128 static inline int recog_memoized (rtx_insn *insn);
 129 #endif
 130 extern void add_clobbers (rtx, int);
 131 extern int added_clobbers_hard_reg_p (int);
 132 extern void insn_extract (rtx_insn *);
 133 extern void extract_insn (rtx_insn *);
 134 extern void extract_constrain_insn (rtx_insn *insn);
 135 extern void extract_constrain_insn_cached (rtx_insn *);
 136 extern void extract_insn_cached (rtx_insn *);
 137 extern void preprocess_constraints (int, int, const char **,
 138                                     operand_alternative *, rtx **);
 139 extern const operand_alternative *preprocess_insn_constraints (unsigned int);
 140 extern void preprocess_constraints (rtx_insn *);
 141 extern rtx_insn *peep2_next_insn (int);
 142 extern int peep2_regno_dead_p (int, int);
 143 extern int peep2_reg_dead_p (int, rtx);
 144 #ifdef HARD_CONST
 145 extern rtx peep2_find_free_register (int, int, const char *,
 146                                      machine_mode, HARD_REG_SET *);
 147 #endif
 148 extern rtx_insn *peephole2_insns (rtx, rtx_insn *, int *);
 149
 150 extern int store_data_bypass_p (rtx_insn *, rtx_insn *);
 151 extern int if_test_bypass_p (rtx_insn *, rtx_insn *);
 152
 153 extern void copy_frame_info_to_split_insn (rtx_insn *, rtx_insn *);
 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 *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 /* RAII class for temporarily setting volatile_ok.  */
 191
 192 class temporary_volatile_ok
 193 {
 194 public:
 195   temporary_volatile_ok (int value) : save_volatile_ok (volatile_ok)
 196   {
 197     volatile_ok = value;
 198   }
 199
 200   ~temporary_volatile_ok () { volatile_ok = save_volatile_ok; }
 201
 202 private:
 203   temporary_volatile_ok (const temporary_volatile_ok &);
 204   int save_volatile_ok;
 205 };
 206
 207 /* Set by constrain_operands to the number of the alternative that
 208    matched.  */
 209 extern int which_alternative;
 210
 211 /* The following vectors hold the results from insn_extract.  */
 212
 213 struct recog_data_d
 214 {
 215   /* It is very tempting to make the 5 operand related arrays into a
 216      structure and index on that.  However, to be source compatible
 217      with all of the existing md file insn constraints and output
 218      templates, we need `operand' as a flat array.  Without that
 219      member, making an array for the rest seems pointless.  */
 220
 221   /* Gives value of operand N.  */
 222   rtx operand[MAX_RECOG_OPERANDS];
 223
 224   /* Gives location where operand N was found.  */
 225   rtx *operand_loc[MAX_RECOG_OPERANDS];
 226
 227   /* Gives the constraint string for operand N.  */
 228   const char *constraints[MAX_RECOG_OPERANDS];
 229
 230   /* Nonzero if operand N is a match_operator or a match_parallel.  */
 231   char is_operator[MAX_RECOG_OPERANDS];
 232
 233   /* Gives the mode of operand N.  */
 234   machine_mode operand_mode[MAX_RECOG_OPERANDS];
 235
 236   /* Gives the type (in, out, inout) for operand N.  */
 237   enum op_type operand_type[MAX_RECOG_OPERANDS];
 238
 239   /* Gives location where the Nth duplicate-appearance of an operand
 240      was found.  This is something that matched MATCH_DUP.  */
 241   rtx *dup_loc[MAX_DUP_OPERANDS];
 242
 243   /* Gives the operand number that was duplicated in the Nth
 244      duplicate-appearance of an operand.  */
 245   char dup_num[MAX_DUP_OPERANDS];
 246
 247   /* ??? Note that these are `char' instead of `unsigned char' to (try to)
 248      avoid certain lossage from K&R C, wherein `unsigned char' default
 249      promotes to `unsigned int' instead of `int' as in ISO C.  As of 1999,
 250      the most common places to bootstrap from K&R C are SunOS and HPUX,
 251      both of which have signed characters by default.  The only other
 252      supported natives that have both K&R C and unsigned characters are
 253      ROMP and Irix 3, and neither have been seen for a while, but do
 254      continue to consider unsignedness when performing arithmetic inside
 255      a comparison.  */
 256
 257   /* The number of operands of the insn.  */
 258   char n_operands;
 259
 260   /* The number of MATCH_DUPs in the insn.  */
 261   char n_dups;
 262
 263   /* The number of alternatives in the constraints for the insn.  */
 264   char n_alternatives;
 265
 266   /* True if insn is ASM_OPERANDS.  */
 267   bool is_asm;
 268
 269   /* In case we are caching, hold insn data was generated for.  */
 270   rtx_insn *insn;
 271 };
 272
 273 extern struct recog_data_d recog_data;
 274
 275 extern const operand_alternative *recog_op_alt;
 276
 277 /* Return a pointer to an array in which index OP describes the constraints
 278    on operand OP of the current instruction alternative (which_alternative).
 279    Only valid after calling preprocess_constraints and constrain_operands.  */
 280
 281 inline static const operand_alternative *
 282 which_op_alt ()
 283 {
 284   gcc_checking_assert (IN_RANGE (which_alternative, 0,
 285                                  recog_data.n_alternatives - 1));
 286   return &recog_op_alt[which_alternative * recog_data.n_operands];
 287 }
 288
 289 /* A table defined in insn-output.c that give information about
 290    each insn-code value.  */
 291
 292 typedef int (*insn_operand_predicate_fn) (rtx, machine_mode);
 293 typedef const char * (*insn_output_fn) (rtx *, rtx_insn *);
 294
 295 struct insn_gen_fn
 296 {
 297   typedef void (*stored_funcptr) (void);
 298
 299   template<typename ...Ts>
 300   rtx_insn *operator() (Ts... args) const
 301   {
 302     typedef rtx_insn *(*funcptr) (decltype ((void) args, NULL_RTX)...);
 303     return ((funcptr) func) (args...);
 304   }
 305
 306   // This is for compatibility of code that invokes functions like
 307   //   (*funcptr) (arg)
 308   insn_gen_fn operator * (void) const { return *this; }
 309
 310   // The wrapped function pointer must be public and there must not be any
 311   // constructors.  Otherwise the insn_data_d struct initializers generated
 312   // by genoutput.c will result in static initializer functions, which defeats
 313   // the purpose of the generated insn_data_d array.
 314   stored_funcptr func;
 315 };
 316
 317 struct insn_operand_data
 318 {
 319   const insn_operand_predicate_fn predicate;
 320
 321   const char *const constraint;
 322
 323   ENUM_BITFIELD(machine_mode) const mode : 16;
 324
 325   const char strict_low;
 326
 327   const char is_operator;
 328
 329   const char eliminable;
 330
 331   const char allows_mem;
 332 };
 333
 334 /* Legal values for insn_data.output_format.  Indicate what type of data
 335    is stored in insn_data.output.  */
 336 #define INSN_OUTPUT_FORMAT_NONE         0       /* abort */
 337 #define INSN_OUTPUT_FORMAT_SINGLE       1       /* const char * */
 338 #define INSN_OUTPUT_FORMAT_MULTI        2       /* const char * const * */
 339 #define INSN_OUTPUT_FORMAT_FUNCTION     3       /* const char * (*)(...) */
 340
 341 struct insn_data_d
 342 {
 343   const char *const name;
 344 #if HAVE_DESIGNATED_UNION_INITIALIZERS
 345   union {
 346     const char *single;
 347     const char *const *multi;
 348     insn_output_fn function;
 349   } output;
 350 #else
 351   struct {
 352     const char *single;
 353     const char *const *multi;
 354     insn_output_fn function;
 355   } output;
 356 #endif
 357   const insn_gen_fn genfun;
 358   const struct insn_operand_data *const operand;
 359
 360   const char n_generator_args;
 361   const char n_operands;
 362   const char n_dups;
 363   const char n_alternatives;
 364   const char output_format;
 365 };
 366
 367 extern const struct insn_data_d insn_data[];
 368 extern int peep2_current_count;
 369
 370 #ifndef GENERATOR_FILE
 371 #include "insn-codes.h"
 372
 373 /* An enum of boolean attributes that may only depend on the current
 374    subtarget, not on things like operands or compiler phase.  */
 375 enum bool_attr {
 376   BA_ENABLED,
 377   BA_PREFERRED_FOR_SPEED,
 378   BA_PREFERRED_FOR_SIZE,
 379   BA_LAST = BA_PREFERRED_FOR_SIZE
 380 };
 381
 382 /* Target-dependent globals.  */
 383 struct target_recog {
 384   bool x_initialized;
 385   alternative_mask x_bool_attr_masks[NUM_INSN_CODES][BA_LAST + 1];
 386   operand_alternative *x_op_alt[NUM_INSN_CODES];
 387 };
 388
 389 extern struct target_recog default_target_recog;
 390 #if SWITCHABLE_TARGET
 391 extern struct target_recog *this_target_recog;
 392 #else
 393 #define this_target_recog (&default_target_recog)
 394 #endif
 395
 396 alternative_mask get_enabled_alternatives (rtx_insn *);
 397 alternative_mask get_preferred_alternatives (rtx_insn *);
 398 alternative_mask get_preferred_alternatives (rtx_insn *, basic_block);
 399 bool check_bool_attrs (rtx_insn *);
 400
 401 void recog_init ();
 402 #endif
 403
 404 #endif /* GCC_RECOG_H */