gcc/loop.h

   1 /* Loop optimization definitions for GNU C-Compiler
   2    Copyright (C) 1991, 1995, 1998, 1999, 2000 Free Software Foundation, Inc.
   3
   4 This file is part of GNU CC.
   5
   6 GNU CC is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU CC is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU CC; see the file COPYING.  If not, write to
  18 the Free Software Foundation, 59 Temple Place - Suite 330,
  19 Boston, MA 02111-1307, USA.  */
  20
  21 #include "varray.h"
  22 #include "bitmap.h"
  23
  24 /* Flags passed to loop_optimize.  */
  25 #define LOOP_UNROLL 1
  26 #define LOOP_BCT 2
  27
  28 /* Get the loop info pointer of a loop.  */
  29 #define LOOP_INFO(LOOP) ((struct loop_info *) (LOOP)->aux)
  30
  31 /* Get a pointer to the loop movables structure.  */
  32 #define LOOP_MOVABLES(LOOP) (&LOOP_INFO (loop)->movables)
  33
  34 /* Get a pointer to the loop registers structure.  */
  35 #define LOOP_REGS(LOOP) (&LOOP_INFO (loop)->regs)
  36
  37 /* Get a pointer to the loop induction variables structure.  */
  38 #define LOOP_IVS(LOOP) (&LOOP_INFO (loop)->ivs)
  39
  40 /* Get the luid of an insn.  Catch the error of trying to reference the LUID
  41    of an insn added during loop, since these don't have LUIDs.  */
  42
  43 #define INSN_LUID(INSN)                 \
  44   (INSN_UID (INSN) < max_uid_for_loop ? uid_luid[INSN_UID (INSN)] \
  45    : (abort (), -1))
  46
  47 #define REGNO_FIRST_LUID(REGNO) uid_luid[REGNO_FIRST_UID (REGNO)]
  48 #define REGNO_LAST_LUID(REGNO) uid_luid[REGNO_LAST_UID (REGNO)]
  49
  50
  51 /* A "basic induction variable" or biv is a pseudo reg that is set
  52    (within this loop) only by incrementing or decrementing it.  */
  53 /* A "general induction variable" or giv is a pseudo reg whose
  54    value is a linear function of a biv.  */
  55
  56 /* Bivs are recognized by `basic_induction_var';
  57    Givs by `general_induct_var'.  */
  58
  59 /* An enum for the two different types of givs, those that are used
  60    as memory addresses and those that are calculated into registers.  */
  61 enum g_types
  62 {
  63   DEST_ADDR,
  64   DEST_REG
  65 };
  66
  67 /* A `struct induction' is created for every instruction that sets
  68    an induction variable (either a biv or a giv).  */
  69
  70 struct induction
  71 {
  72   rtx insn;                     /* The insn that sets a biv or giv */
  73   rtx new_reg;                  /* New register, containing strength reduced
  74                                    version of this giv.  */
  75   rtx src_reg;                  /* Biv from which this giv is computed.
  76                                    (If this is a biv, then this is the biv.) */
  77   enum g_types giv_type;        /* Indicate whether DEST_ADDR or DEST_REG */
  78   rtx dest_reg;                 /* Destination register for insn: this is the
  79                                    register which was the biv or giv.
  80                                    For a biv, this equals src_reg.
  81                                    For a DEST_ADDR type giv, this is 0.  */
  82   rtx *location;                /* Place in the insn where this giv occurs.
  83                                    If GIV_TYPE is DEST_REG, this is 0.  */
  84                                 /* For a biv, this is the place where add_val
  85                                    was found.  */
  86   enum machine_mode mode;       /* The mode of this biv or giv */
  87   enum machine_mode mem_mode;   /* For DEST_ADDR, mode of the memory object.  */
  88   rtx mult_val;                 /* Multiplicative factor for src_reg.  */
  89   rtx add_val;                  /* Additive constant for that product.  */
  90   int benefit;                  /* Gain from eliminating this insn.  */
  91   rtx final_value;              /* If the giv is used outside the loop, and its
  92                                    final value could be calculated, it is put
  93                                    here, and the giv is made replaceable.  Set
  94                                    the giv to this value before the loop.  */
  95   unsigned combined_with;       /* The number of givs this giv has been
  96                                    combined with.  If nonzero, this giv
  97                                    cannot combine with any other giv.  */
  98   unsigned replaceable : 1;     /* 1 if we can substitute the strength-reduced
  99                                    variable for the original variable.
 100                                    0 means they must be kept separate and the
 101                                    new one must be copied into the old pseudo
 102                                    reg each time the old one is set.  */
 103   unsigned not_replaceable : 1; /* Used to prevent duplicating work.  This is
 104                                    1 if we know that the giv definitely can
 105                                    not be made replaceable, in which case we
 106                                    don't bother checking the variable again
 107                                    even if further info is available.
 108                                    Both this and the above can be zero.  */
 109   unsigned ignore : 1;          /* 1 prohibits further processing of giv */
 110   unsigned always_computable : 1;/* 1 if this value is computable every
 111                                     iteration.  */
 112   unsigned always_executed : 1; /* 1 if this set occurs each iteration.  */
 113   unsigned maybe_multiple : 1;  /* Only used for a biv and  1 if this biv
 114                                    update may be done multiple times per
 115                                    iteration.  */
 116   unsigned cant_derive : 1;     /* For giv's, 1 if this giv cannot derive
 117                                    another giv.  This occurs in many cases
 118                                    where a giv's lifetime spans an update to
 119                                    a biv.  */
 120   unsigned maybe_dead : 1;      /* 1 if this giv might be dead.  In that case,
 121                                    we won't use it to eliminate a biv, it
 122                                    would probably lose.  */
 123   unsigned auto_inc_opt : 1;    /* 1 if this giv had its increment output next
 124                                    to it to try to form an auto-inc address.  */
 125   unsigned unrolled : 1;        /* 1 if new register has been allocated and
 126                                    initialized in unrolled loop.  */
 127   unsigned shared : 1;
 128   unsigned no_const_addval : 1; /* 1 if add_val does not contain a const.  */
 129   int lifetime;                 /* Length of life of this giv */
 130   rtx derive_adjustment;        /* If nonzero, is an adjustment to be
 131                                    subtracted from add_val when this giv
 132                                    derives another.  This occurs when the
 133                                    giv spans a biv update by incrementation.  */
 134   rtx ext_dependant;            /* If nonzero, is a sign or zero extension
 135                                    if a biv on which this giv is dependant.  */
 136   struct induction *next_iv;    /* For givs, links together all givs that are
 137                                    based on the same biv.  For bivs, links
 138                                    together all biv entries that refer to the
 139                                    same biv register.  */
 140   struct induction *same;       /* If this giv has been combined with another
 141                                    giv, this points to the base giv.  The base
 142                                    giv will have COMBINED_WITH non-zero.  */
 143   HOST_WIDE_INT const_adjust;   /* Used by loop unrolling, when an address giv
 144                                    is split, and a constant is eliminated from
 145                                    the address, the -constant is stored here
 146                                    for later use.  */
 147   struct induction *same_insn;  /* If there are multiple identical givs in
 148                                    the same insn, then all but one have this
 149                                    field set, and they all point to the giv
 150                                    that doesn't have this field set.  */
 151   rtx last_use;                 /* For a giv made from a biv increment, this is
 152                                    a substitute for the lifetime information.  */
 153 };
 154
 155 /* A `struct iv_class' is created for each biv.  */
 156
 157 struct iv_class
 158 {
 159   unsigned int regno;           /* Pseudo reg which is the biv.  */
 160   int biv_count;                /* Number of insns setting this reg.  */
 161   struct induction *biv;        /* List of all insns that set this reg.  */
 162   int giv_count;                /* Number of DEST_REG givs computed from this
 163                                    biv.  The resulting count is only used in
 164                                    check_dbra_loop.  */
 165   struct induction *giv;        /* List of all insns that compute a giv
 166                                    from this reg.  */
 167   int total_benefit;            /* Sum of BENEFITs of all those givs.  */
 168   rtx initial_value;            /* Value of reg at loop start.  */
 169   rtx initial_test;             /* Test performed on BIV before loop.  */
 170   rtx final_value;              /* Value of reg at loop end, if known.  */
 171   struct iv_class *next;        /* Links all class structures together.  */
 172   rtx init_insn;                /* insn which initializes biv, 0 if none.  */
 173   rtx init_set;                 /* SET of INIT_INSN, if any.  */
 174   unsigned incremented : 1;     /* 1 if somewhere incremented/decremented */
 175   unsigned eliminable : 1;      /* 1 if plausible candidate for
 176                                    elimination.  */
 177   unsigned nonneg : 1;          /* 1 if we added a REG_NONNEG note for
 178                                    this.  */
 179   unsigned reversed : 1;        /* 1 if we reversed the loop that this
 180                                    biv controls.  */
 181   unsigned all_reduced : 1;     /* 1 if all givs using this biv have
 182                                    been reduced. */
 183 };
 184
 185 typedef struct loop_mem_info
 186 {
 187   rtx mem;      /* The MEM itself.  */
 188   rtx reg;      /* Corresponding pseudo, if any.  */
 189   int optimize; /* Nonzero if we can optimize access to this MEM.  */
 190 } loop_mem_info;
 191
 192 struct loop_ivs
 193 {
 194   /* Indexed by register number, indicates whether or not register is
 195      an induction variable, and if so what type.  */
 196   varray_type reg_iv_type;
 197
 198   /* Indexed by register number, contains pointer to `struct
 199      induction' if register is an induction variable.  This holds
 200      general info for all induction variables.  */
 201   varray_type reg_iv_info;
 202
 203   /* Indexed by register number, contains pointer to `struct iv_class'
 204      if register is a basic induction variable.  This holds info
 205      describing the class (a related group) of induction variables
 206      that the biv belongs to.  */
 207   struct iv_class **reg_biv_class;
 208
 209   /* The head of a list which links together (via the next field)
 210      every iv class for the current loop.  */
 211   struct iv_class *loop_iv_list;
 212 };
 213
 214 struct loop_regs
 215 {
 216   int num;
 217
 218   /* Indexed by register number, contains the number of times the reg
 219      is set during the loop being scanned.
 220      During code motion, a negative value indicates a reg that has been
 221      made a candidate; in particular -2 means that it is an candidate that
 222      we know is equal to a constant and -1 means that it is an candidate
 223      not known equal to a constant.
 224      After code motion, regs moved have 0 (which is accurate now)
 225      while the failed candidates have the original number of times set.
 226
 227      Therefore, at all times, == 0 indicates an invariant register;
 228      < 0 a conditionally invariant one.  */
 229   varray_type set_in_loop;
 230
 231   /* Original value of set_in_loop; same except that this value
 232      is not set negative for a reg whose sets have been made candidates
 233      and not set to 0 for a reg that is moved.  */
 234   varray_type n_times_set;
 235
 236   /* Index by register number, 1 indicates that the register
 237      cannot be moved or strength reduced.  */
 238   varray_type may_not_optimize;
 239
 240   /* Contains the insn in which a register was used if it was used
 241      exactly once; contains const0_rtx if it was used more than once.  */
 242   varray_type single_usage;
 243
 244   /* Nonzero means reg N has already been moved out of one loop.
 245      This reduces the desire to move it out of another.  */
 246   char *moved_once;
 247
 248   int multiple_uses;
 249 };
 250
 251
 252 struct loop_movables
 253 {
 254   /* Head of movable chain.  */
 255   struct movable *head;
 256   /* Last movable in chain.  */
 257   struct movable *last;
 258   /* Number of movables in the loop.  */
 259   int num;
 260 };
 261
 262
 263 /* Information pertaining to a loop.  */
 264
 265 struct loop_info
 266 {
 267   /* Nonzero if there is a subroutine call in the current loop.  */
 268   int has_call;
 269   /* Nonzero if there is a libcall in the current loop.  */
 270   int has_libcall;
 271   /* Nonzero if there is a non constant call in the current loop.  */
 272   int has_nonconst_call;
 273   /* Nonzero if there is a volatile memory reference in the current
 274      loop.  */
 275   int has_volatile;
 276   /* Nonzero if there is a tablejump in the current loop.  */
 277   int has_tablejump;
 278   /* Nonzero if there are ways to leave the loop other than falling
 279      off the end.  */
 280   int has_multiple_exit_targets;
 281   /* Nonzero if there is an indirect jump in the current function.  */
 282   int has_indirect_jump;
 283   /* Register or constant initial loop value.  */
 284   rtx initial_value;
 285   /* Register or constant value used for comparison test.  */
 286   rtx comparison_value;
 287   /* Register or constant approximate final value.  */
 288   rtx final_value;
 289   /* Register or constant initial loop value with term common to
 290      final_value removed.  */
 291   rtx initial_equiv_value;
 292   /* Register or constant final loop value with term common to
 293      initial_value removed.  */
 294   rtx final_equiv_value;
 295   /* Register corresponding to iteration variable.  */
 296   rtx iteration_var;
 297   /* Constant loop increment.  */
 298   rtx increment;
 299   enum rtx_code comparison_code;
 300   /* Holds the number of loop iterations.  It is zero if the number
 301      could not be calculated.  Must be unsigned since the number of
 302      iterations can be as high as 2^wordsize - 1.  For loops with a
 303      wider iterator, this number will be zero if the number of loop
 304      iterations is too large for an unsigned integer to hold.  */
 305   unsigned HOST_WIDE_INT n_iterations;
 306   /* The number of times the loop body was unrolled.  */
 307   unsigned int unroll_number;
 308   int used_count_register;
 309   /* The loop iterator induction variable.  */
 310   struct iv_class *iv;
 311   /* List of MEMs that are stored in this loop.  */
 312   rtx store_mems;
 313   /* Array of MEMs that are used (read or written) in this loop, but
 314      cannot be aliased by anything in this loop, except perhaps
 315      themselves.  In other words, if mems[i] is altered during
 316      the loop, it is altered by an expression that is rtx_equal_p to
 317      it.  */
 318   loop_mem_info *mems;
 319   /* The index of the next available slot in MEMS.  */
 320   int mems_idx;
 321   /* The number of elements allocated in MEMS.  */
 322   int mems_allocated;
 323   /* Nonzero if we don't know what MEMs were changed in the current
 324      loop.  This happens if the loop contains a call (in which case
 325      `has_call' will also be set) or if we store into more than
 326      NUM_STORES MEMs.  */
 327   int unknown_address_altered;
 328   /* The above doesn't count any readonly memory locations that are
 329      stored.  This does.  */
 330   int unknown_constant_address_altered;
 331   /* Count of memory write instructions discovered in the loop.  */
 332   int num_mem_sets;
 333   /* The insn where the first of these was found.  */
 334   rtx first_loop_store_insn;
 335   /* The chain of movable insns in loop.  */
 336   struct loop_movables movables;
 337   /* The registers used the in loop.  */
 338   struct loop_regs regs;
 339   /* The induction variable information in loop.  */
 340   struct loop_ivs ivs;
 341   /* Non-zero if call is in pre_header extended basic block.  */
 342   int pre_header_has_call;
 343 };
 344
 345 /* Definitions used by the basic induction variable discovery code.  */
 346 enum iv_mode
 347 {
 348   UNKNOWN_INDUCT,
 349   BASIC_INDUCT,
 350   NOT_BASIC_INDUCT,
 351   GENERAL_INDUCT
 352 };
 353
 354 /* Variables declared in loop.c, but also needed in unroll.c.  */
 355
 356 extern int *uid_luid;
 357 extern int max_uid_for_loop;
 358 extern unsigned int max_reg_before_loop;
 359 extern struct loop **uid_loop;
 360 extern FILE *loop_dump_stream;
 361
 362 #define REG_IV_TYPE(ivs, n) \
 363   (*(enum iv_mode *) &VARRAY_INT(ivs->reg_iv_type, (n)))
 364 #define REG_IV_INFO(ivs, n) \
 365   (*(struct induction **) &VARRAY_GENERIC_PTR(ivs->reg_iv_info, (n)))
 366 #define REG_IV_CLASS(ivs, n) ivs->reg_biv_class[n]
 367
 368 /* Forward declarations for non-static functions declared in loop.c and
 369    unroll.c.  */
 370 int loop_invariant_p PARAMS ((const struct loop *, rtx));
 371 rtx get_condition_for_loop PARAMS ((const struct loop *, rtx));
 372 void emit_iv_add_mult PARAMS ((rtx, rtx, rtx, rtx, rtx));
 373 rtx express_from PARAMS ((struct induction *, struct induction *));
 374 rtx extend_value_for_giv PARAMS ((struct induction *, rtx));
 375
 376 void unroll_loop PARAMS ((struct loop *, int, rtx, int));
 377 rtx biv_total_increment PARAMS ((struct iv_class *));
 378 unsigned HOST_WIDE_INT loop_iterations PARAMS ((struct loop *));
 379 int precondition_loop_p PARAMS ((const struct loop *,
 380                                  rtx *, rtx *, rtx *,
 381                                  enum machine_mode *mode));
 382 rtx final_biv_value PARAMS ((const struct loop *, struct iv_class *));
 383 rtx final_giv_value PARAMS ((const struct loop *, struct induction *));
 384 void emit_unrolled_add PARAMS ((rtx, rtx, rtx));
 385 int back_branch_in_range_p PARAMS ((const struct loop *, rtx));
 386
 387 int loop_insn_first_p PARAMS ((rtx, rtx));
 388 typedef rtx (*loop_insn_callback) PARAMS ((struct loop *, rtx, int, int));
 389 void for_each_insn_in_loop PARAMS ((struct loop *, loop_insn_callback));
 390
 391 /* Forward declarations for non-static functions declared in doloop.c.  */
 392 int doloop_optimize PARAMS ((const struct loop *));