gcc/reload.h

   1 /* Communication between reload.c, reload1.c and the rest of compiler.
   2    Copyright (C) 1987, 1991, 1992, 1993, 1994, 1995, 1997, 1998, 1999,
   3    2000, 2001, 2003, 2004, 2007, 2008, 2010
   4    Free Software Foundation, Inc.
   5
   6 This file is part of GCC.
   7
   8 GCC is free software; you can redistribute it and/or modify it under
   9 the terms of the GNU General Public License as published by the Free
  10 Software Foundation; either version 3, or (at your option) any later
  11 version.
  12
  13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  15 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  16 for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with GCC; see the file COPYING3.  If not see
  20 <http://www.gnu.org/licenses/>.  */
  21
  22
  23 /* If secondary reloads are the same for inputs and outputs, define those
  24    macros here.  */
  25
  26 #ifdef SECONDARY_RELOAD_CLASS
  27 #define SECONDARY_INPUT_RELOAD_CLASS(CLASS, MODE, X) \
  28   SECONDARY_RELOAD_CLASS (CLASS, MODE, X)
  29 #define SECONDARY_OUTPUT_RELOAD_CLASS(CLASS, MODE, X) \
  30   SECONDARY_RELOAD_CLASS (CLASS, MODE, X)
  31 #endif
  32
  33 extern int memory_move_cost (enum machine_mode, enum reg_class, bool);
  34 extern int memory_move_secondary_cost (enum machine_mode, enum reg_class,
  35                                        bool);
  36
  37 /* Maximum number of reloads we can need.  */
  38 #define MAX_RELOADS (2 * MAX_RECOG_OPERANDS * (MAX_REGS_PER_ADDRESS + 1))
  39
  40 /* Encode the usage of a reload.  The following codes are supported:
  41
  42    RELOAD_FOR_INPUT             reload of an input operand
  43    RELOAD_FOR_OUTPUT            likewise, for output
  44    RELOAD_FOR_INSN              a reload that must not conflict with anything
  45                                 used in the insn, but may conflict with
  46                                 something used before or after the insn
  47    RELOAD_FOR_INPUT_ADDRESS     reload for parts of the address of an object
  48                                 that is an input reload
  49    RELOAD_FOR_INPADDR_ADDRESS   reload needed for RELOAD_FOR_INPUT_ADDRESS
  50    RELOAD_FOR_OUTPUT_ADDRESS    like RELOAD_FOR INPUT_ADDRESS, for output
  51    RELOAD_FOR_OUTADDR_ADDRESS   reload needed for RELOAD_FOR_OUTPUT_ADDRESS
  52    RELOAD_FOR_OPERAND_ADDRESS   reload for the address of a non-reloaded
  53                                 operand; these don't conflict with
  54                                 any other addresses.
  55    RELOAD_FOR_OPADDR_ADDR       reload needed for RELOAD_FOR_OPERAND_ADDRESS
  56                                 reloads; usually secondary reloads
  57    RELOAD_OTHER                 none of the above, usually multiple uses
  58    RELOAD_FOR_OTHER_ADDRESS     reload for part of the address of an input
  59                                 that is marked RELOAD_OTHER.
  60
  61    This used to be "enum reload_when_needed" but some debuggers have trouble
  62    with an enum tag and variable of the same name.  */
  63
  64 enum reload_type
  65 {
  66   RELOAD_FOR_INPUT, RELOAD_FOR_OUTPUT, RELOAD_FOR_INSN,
  67   RELOAD_FOR_INPUT_ADDRESS, RELOAD_FOR_INPADDR_ADDRESS,
  68   RELOAD_FOR_OUTPUT_ADDRESS, RELOAD_FOR_OUTADDR_ADDRESS,
  69   RELOAD_FOR_OPERAND_ADDRESS, RELOAD_FOR_OPADDR_ADDR,
  70   RELOAD_OTHER, RELOAD_FOR_OTHER_ADDRESS
  71 };
  72
  73 #ifdef GCC_INSN_CODES_H
  74 /* Each reload is recorded with a structure like this.  */
  75 struct reload
  76 {
  77   /* The value to reload from */
  78   rtx in;
  79   /* Where to store reload-reg afterward if nec (often the same as
  80      reload_in)  */
  81   rtx out;
  82
  83   /* The class of registers to reload into.  */
  84   enum reg_class rclass;
  85
  86   /* The mode this operand should have when reloaded, on input.  */
  87   enum machine_mode inmode;
  88   /* The mode this operand should have when reloaded, on output.  */
  89   enum machine_mode outmode;
  90
  91   /* The mode of the reload register.  */
  92   enum machine_mode mode;
  93
  94   /* the largest number of registers this reload will require.  */
  95   unsigned int nregs;
  96
  97   /* Positive amount to increment or decrement by if
  98      reload_in is a PRE_DEC, PRE_INC, POST_DEC, POST_INC.
  99      Ignored otherwise (don't assume it is zero).  */
 100   int inc;
 101   /* A reg for which reload_in is the equivalent.
 102      If reload_in is a symbol_ref which came from
 103      reg_equiv_constant, then this is the pseudo
 104      which has that symbol_ref as equivalent.  */
 105   rtx in_reg;
 106   rtx out_reg;
 107
 108   /* Used in find_reload_regs to record the allocated register.  */
 109   int regno;
 110   /* This is the register to reload into.  If it is zero when `find_reloads'
 111      returns, you must find a suitable register in the class specified by
 112      reload_reg_class, and store here an rtx for that register with mode from
 113      reload_inmode or reload_outmode.  */
 114   rtx reg_rtx;
 115   /* The operand number being reloaded.  This is used to group related reloads
 116      and need not always be equal to the actual operand number in the insn,
 117      though it current will be; for in-out operands, it is one of the two
 118      operand numbers.  */
 119   int opnum;
 120
 121   /* Gives the reload number of a secondary input reload, when needed;
 122      otherwise -1.  */
 123   int secondary_in_reload;
 124   /* Gives the reload number of a secondary output reload, when needed;
 125      otherwise -1.  */
 126   int secondary_out_reload;
 127   /* If a secondary input reload is required, gives the INSN_CODE that uses the
 128      secondary reload as a scratch register, or CODE_FOR_nothing if the
 129      secondary reload register is to be an intermediate register.  */
 130   enum insn_code secondary_in_icode;
 131   /* Likewise, for a secondary output reload.  */
 132   enum insn_code secondary_out_icode;
 133
 134   /* Classifies reload as needed either for addressing an input reload,
 135      addressing an output, for addressing a non-reloaded mem ref, or for
 136      unspecified purposes (i.e., more than one of the above).  */
 137   enum reload_type when_needed;
 138
 139   /* Nonzero for an optional reload.  Optional reloads are ignored unless the
 140      value is already sitting in a register.  */
 141   unsigned int optional:1;
 142   /* nonzero if this reload shouldn't be combined with another reload.  */
 143   unsigned int nocombine:1;
 144   /* Nonzero if this is a secondary register for one or more reloads.  */
 145   unsigned int secondary_p:1;
 146   /* Nonzero if this reload must use a register not already allocated to a
 147      group.  */
 148   unsigned int nongroup:1;
 149 };
 150
 151 extern struct reload rld[MAX_RELOADS];
 152 extern int n_reloads;
 153 #endif
 154
 155 extern GTY (()) VEC(rtx,gc) *reg_equiv_memory_loc_vec;
 156 extern rtx *reg_equiv_constant;
 157 extern rtx *reg_equiv_invariant;
 158 extern rtx *reg_equiv_memory_loc;
 159 extern rtx *reg_equiv_address;
 160 extern rtx *reg_equiv_mem;
 161 extern rtx *reg_equiv_alt_mem_list;
 162
 163 /* Element N is the list of insns that initialized reg N from its equivalent
 164    constant or memory slot.  */
 165 extern GTY((length("reg_equiv_init_size"))) rtx *reg_equiv_init;
 166
 167 /* The size of the previous array, for GC purposes.  */
 168 extern GTY(()) int reg_equiv_init_size;
 169
 170 /* All the "earlyclobber" operands of the current insn
 171    are recorded here.  */
 172 extern int n_earlyclobbers;
 173 extern rtx reload_earlyclobbers[MAX_RECOG_OPERANDS];
 174
 175 /* Save the number of operands.  */
 176 extern int reload_n_operands;
 177
 178 /* First uid used by insns created by reload in this function.
 179    Used in find_equiv_reg.  */
 180 extern int reload_first_uid;
 181
 182 /* Nonzero if indirect addressing is supported when the innermost MEM is
 183    of the form (MEM (SYMBOL_REF sym)).  It is assumed that the level to
 184    which these are valid is the same as spill_indirect_levels, above.  */
 185
 186 extern char indirect_symref_ok;
 187
 188 /* Nonzero if an address (plus (reg frame_pointer) (reg ...)) is valid.  */
 189 extern char double_reg_address_ok;
 190
 191 extern int num_not_at_initial_offset;
 192
 193 #if defined SET_HARD_REG_BIT && defined CLEAR_REG_SET
 194 /* This structure describes instructions which are relevant for reload.
 195    Apart from all regular insns, this also includes CODE_LABELs, since they
 196    must be examined for register elimination.  */
 197 struct insn_chain
 198 {
 199   /* Links to the neighbor instructions.  */
 200   struct insn_chain *next, *prev;
 201
 202   /* Link through a chains set up by calculate_needs_all_insns, containing
 203      all insns that need reloading.  */
 204   struct insn_chain *next_need_reload;
 205
 206   /* The rtx of the insn.  */
 207   rtx insn;
 208
 209   /* The basic block this insn is in.  */
 210   int block;
 211
 212   /* Nonzero if find_reloads said the insn requires reloading.  */
 213   unsigned int need_reload:1;
 214   /* Nonzero if find_reloads needs to be run during reload_as_needed to
 215      perform modifications on any operands.  */
 216   unsigned int need_operand_change:1;
 217   /* Nonzero if eliminate_regs_in_insn said it requires eliminations.  */
 218   unsigned int need_elim:1;
 219   /* Nonzero if this insn was inserted by perform_caller_saves.  */
 220   unsigned int is_caller_save_insn:1;
 221
 222   /* Register life information: record all live hard registers, and
 223      all live pseudos that have a hard register.  This set also
 224      contains pseudos spilled by IRA.  */
 225   bitmap_head live_throughout;
 226   bitmap_head dead_or_set;
 227
 228   /* Copies of the global variables computed by find_reloads.  */
 229   struct reload *rld;
 230   int n_reloads;
 231
 232   /* Indicates which registers have already been used for spills.  */
 233   HARD_REG_SET used_spill_regs;
 234 };
 235
 236 /* A chain of insn_chain structures to describe all non-note insns in
 237    a function.  */
 238 extern struct insn_chain *reload_insn_chain;
 239
 240 /* Allocate a new insn_chain structure.  */
 241 extern struct insn_chain *new_insn_chain (void);
 242 #endif
 243
 244 #if defined SET_HARD_REG_BIT
 245 extern void compute_use_by_pseudos (HARD_REG_SET *, bitmap);
 246 #endif
 247
 248 /* Functions from reload.c:  */
 249
 250 extern enum reg_class secondary_reload_class (bool, enum reg_class,
 251                                               enum machine_mode, rtx);
 252
 253 #ifdef GCC_INSN_CODES_H
 254 extern enum reg_class scratch_reload_class (enum insn_code);
 255 #endif
 256
 257 /* Return a memory location that will be used to copy X in mode MODE.
 258    If we haven't already made a location for this mode in this insn,
 259    call find_reloads_address on the location being returned.  */
 260 extern rtx get_secondary_mem (rtx, enum machine_mode, int, enum reload_type);
 261
 262 /* Clear any secondary memory locations we've made.  */
 263 extern void clear_secondary_mem (void);
 264
 265 /* Transfer all replacements that used to be in reload FROM to be in
 266    reload TO.  */
 267 extern void transfer_replacements (int, int);
 268
 269 /* IN_RTX is the value loaded by a reload that we now decided to inherit,
 270    or a subpart of it.  If we have any replacements registered for IN_RTX,
 271    cancel the reloads that were supposed to load them.
 272    Return nonzero if we canceled any reloads.  */
 273 extern int remove_address_replacements (rtx in_rtx);
 274
 275 /* Like rtx_equal_p except that it allows a REG and a SUBREG to match
 276    if they are the same hard reg, and has special hacks for
 277    autoincrement and autodecrement.  */
 278 extern int operands_match_p (rtx, rtx);
 279
 280 /* Return 1 if altering OP will not modify the value of CLOBBER.  */
 281 extern int safe_from_earlyclobber (rtx, rtx);
 282
 283 /* Search the body of INSN for values that need reloading and record them
 284    with push_reload.  REPLACE nonzero means record also where the values occur
 285    so that subst_reloads can be used.  */
 286 extern int find_reloads (rtx, int, int, int, short *);
 287
 288 /* Compute the sum of X and Y, making canonicalizations assumed in an
 289    address, namely: sum constant integers, surround the sum of two
 290    constants with a CONST, put the constant as the second operand, and
 291    group the constant on the outermost sum.  */
 292 extern rtx form_sum (enum machine_mode, rtx, rtx);
 293
 294 /* Substitute into the current INSN the registers into which we have reloaded
 295    the things that need reloading.  */
 296 extern void subst_reloads (rtx);
 297
 298 /* Make a copy of any replacements being done into X and move those copies
 299    to locations in Y, a copy of X.  We only look at the highest level of
 300    the RTL.  */
 301 extern void copy_replacements (rtx, rtx);
 302
 303 /* Change any replacements being done to *X to be done to *Y */
 304 extern void move_replacements (rtx *x, rtx *y);
 305
 306 /* If LOC was scheduled to be replaced by something, return the replacement.
 307    Otherwise, return *LOC.  */
 308 extern rtx find_replacement (rtx *);
 309
 310 /* Nonzero if modifying X will affect IN.  */
 311 extern int reg_overlap_mentioned_for_reload_p (rtx, rtx);
 312
 313 /* Check the insns before INSN to see if there is a suitable register
 314    containing the same value as GOAL.  */
 315 extern rtx find_equiv_reg (rtx, rtx, enum reg_class, int, short *,
 316                            int, enum machine_mode);
 317
 318 /* Return 1 if register REGNO is the subject of a clobber in insn INSN.  */
 319 extern int regno_clobbered_p (unsigned int, rtx, enum machine_mode, int);
 320
 321 /* Return 1 if X is an operand of an insn that is being earlyclobbered.  */
 322 extern int earlyclobber_operand_p (rtx);
 323
 324 /* Record one reload that needs to be performed.  */
 325 extern int push_reload (rtx, rtx, rtx *, rtx *, enum reg_class,
 326                         enum machine_mode, enum machine_mode,
 327                         int, int, int, enum reload_type);
 328
 329 /* Functions in postreload.c:  */
 330 extern void reload_cse_regs (rtx);
 331
 332 /* Functions in reload1.c:  */
 333
 334 /* Initialize the reload pass once per compilation.  */
 335 extern void init_reload (void);
 336
 337 /* The reload pass itself.  */
 338 extern int reload (rtx, int);
 339
 340 /* Mark the slots in regs_ever_live for the hard regs
 341    used by pseudo-reg number REGNO.  */
 342 extern void mark_home_live (int);
 343
 344 /* Scan X and replace any eliminable registers (such as fp) with a
 345    replacement (such as sp), plus an offset.  */
 346 extern rtx eliminate_regs (rtx, enum machine_mode, rtx);
 347 extern bool elimination_target_reg_p (rtx);
 348
 349 /* Called from the register allocator to estimate costs of eliminating
 350    invariant registers.  */
 351 extern void calculate_elim_costs_all_insns (void);
 352
 353 /* Deallocate the reload register used by reload number R.  */
 354 extern void deallocate_reload_reg (int r);
 355
 356 /* True if caller-save has been reinitialized.  */
 357 extern bool caller_save_initialized_p;
 358
 359 /* Functions in caller-save.c:  */
 360
 361 /* Initialize for caller-save.  */
 362 extern void init_caller_save (void);
 363
 364 /* Initialize save areas by showing that we haven't allocated any yet.  */
 365 extern void init_save_areas (void);
 366
 367 /* Allocate save areas for any hard registers that might need saving.  */
 368 extern void setup_save_areas (void);
 369
 370 /* Find the places where hard regs are live across calls and save them.  */
 371 extern void save_call_clobbered_regs (void);
 372
 373 /* Replace (subreg (reg)) with the appropriate (reg) for any operands.  */
 374 extern void cleanup_subreg_operands (rtx);
 375
 376 /* Debugging support.  */
 377 extern void debug_reload_to_stream (FILE *);
 378 extern void debug_reload (void);
 379
 380 /* Compute the actual register we should reload to, in case we're
 381    reloading to/from a register that is wider than a word.  */
 382 extern rtx reload_adjust_reg_for_mode (rtx, enum machine_mode);