gcc/cfgloop.h

   1 /* Natural loop functions
   2    Copyright (C) 1987, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
   3    Free Software Foundation, Inc.
   4
   5 This file is part of GCC.
   6
   7 GCC is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 2, or (at your option) any later
  10 version.
  11
  12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GCC; see the file COPYING.  If not, write to the Free
  19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  20 02111-1307, USA.  */
  21
  22 #ifndef GCC_CFGLOOP_H
  23 #define GCC_CFGLOOP_H
  24
  25 #include "basic-block.h"
  26 /* For rtx_code.  */
  27 #include "rtl.h"
  28
  29 /* Structure to hold decision about unrolling/peeling.  */
  30 enum lpt_dec
  31 {
  32   LPT_NONE,
  33   LPT_PEEL_COMPLETELY,
  34   LPT_PEEL_SIMPLE,
  35   LPT_UNROLL_CONSTANT,
  36   LPT_UNROLL_RUNTIME,
  37   LPT_UNROLL_STUPID
  38 };
  39
  40 struct lpt_decision
  41 {
  42   enum lpt_dec decision;
  43   unsigned times;
  44 };
  45
  46 /* Structure to hold information for each natural loop.  */
  47 struct loop
  48 {
  49   /* Index into loops array.  */
  50   int num;
  51
  52   /* Basic block of loop header.  */
  53   basic_block header;
  54
  55   /* Basic block of loop latch.  */
  56   basic_block latch;
  57
  58   /* Basic block of loop preheader or NULL if it does not exist.  */
  59   basic_block pre_header;
  60
  61   /* For loop unrolling/peeling decision.  */
  62   struct lpt_decision lpt_decision;
  63
  64   /* Number of loop insns.  */
  65   unsigned ninsns;
  66
  67   /* Average number of executed insns per iteration.  */
  68   unsigned av_ninsns;
  69
  70   /* Array of edges along the preheader extended basic block trace.
  71      The source of the first edge is the root node of preheader
  72      extended basic block, if it exists.  */
  73   edge *pre_header_edges;
  74
  75   /* Number of edges along the pre_header extended basic block trace.  */
  76   int num_pre_header_edges;
  77
  78   /* The first block in the loop.  This is not necessarily the same as
  79      the loop header.  */
  80   basic_block first;
  81
  82   /* The last block in the loop.  This is not necessarily the same as
  83      the loop latch.  */
  84   basic_block last;
  85
  86   /* Bitmap of blocks contained within the loop.  */
  87   sbitmap nodes;
  88
  89   /* Number of blocks contained within the loop.  */
  90   unsigned num_nodes;
  91
  92   /* Array of edges that enter the loop.  */
  93   edge *entry_edges;
  94
  95   /* Number of edges that enter the loop.  */
  96   int num_entries;
  97
  98   /* Array of edges that exit the loop.  */
  99   edge *exit_edges;
 100
 101   /* Number of edges that exit the loop.  */
 102   int num_exits;
 103
 104   /* Bitmap of blocks that dominate all exits of the loop.  */
 105   sbitmap exits_doms;
 106
 107   /* The loop nesting depth.  */
 108   int depth;
 109
 110   /* Superloops of the loop.  */
 111   struct loop **pred;
 112
 113   /* The height of the loop (enclosed loop levels) within the loop
 114      hierarchy tree.  */
 115   int level;
 116
 117   /* The outer (parent) loop or NULL if outermost loop.  */
 118   struct loop *outer;
 119
 120   /* The first inner (child) loop or NULL if innermost loop.  */
 121   struct loop *inner;
 122
 123   /* Link to the next (sibling) loop.  */
 124   struct loop *next;
 125
 126   /* Loop that is copy of this loop.  */
 127   struct loop *copy;
 128
 129   /* Nonzero if the loop is invalid (e.g., contains setjmp.).  */
 130   int invalid;
 131
 132   /* Auxiliary info specific to a pass.  */
 133   void *aux;
 134
 135   /* The following are currently used by loop.c but they are likely to
 136      disappear as loop.c is converted to use the CFG.  */
 137
 138   /* The NOTE_INSN_LOOP_BEG.  */
 139   rtx start;
 140
 141   /* The NOTE_INSN_LOOP_END.  */
 142   rtx end;
 143
 144   /* For a rotated loop that is entered near the bottom,
 145      this is the label at the top.  Otherwise it is zero.  */
 146   rtx top;
 147
 148   /* Place in the loop where control enters.  */
 149   rtx scan_start;
 150
 151   /* The position where to sink insns out of the loop.  */
 152   rtx sink;
 153
 154   /* List of all LABEL_REFs which refer to code labels outside the
 155      loop.  Used by routines that need to know all loop exits, such as
 156      final_biv_value and final_giv_value.
 157
 158      This does not include loop exits due to return instructions.
 159      This is because all bivs and givs are pseudos, and hence must be
 160      dead after a return, so the presence of a return does not affect
 161      any of the optimizations that use this info.  It is simpler to
 162      just not include return instructions on this list.  */
 163   rtx exit_labels;
 164
 165   /* The number of LABEL_REFs on exit_labels for this loop and all
 166      loops nested inside it.  */
 167   int exit_count;
 168
 169   /* The probable number of times the loop is executed at runtime.
 170      This is an INTEGER_CST or an expression containing symbolic
 171      names.  Don't access this field directly:
 172      number_of_iterations_in_loop computes and caches the computed
 173      information in this field.  */
 174   tree nb_iterations;
 175
 176   /* Upper bound on number of iterations of a loop.  */
 177   struct nb_iter_bound *bounds;
 178
 179   /* If not NULL, loop has just single exit edge stored here (edges to the
 180      EXIT_BLOCK_PTR do not count.  */
 181   edge single_exit;
 182 };
 183
 184 /* Flags for state of loop structure.  */
 185 enum
 186 {
 187   LOOPS_HAVE_PREHEADERS = 1,
 188   LOOPS_HAVE_SIMPLE_LATCHES = 2,
 189   LOOPS_HAVE_MARKED_IRREDUCIBLE_REGIONS = 4,
 190   LOOPS_HAVE_MARKED_SINGLE_EXITS = 8
 191 };
 192
 193 /* Structure to hold CFG information about natural loops within a function.  */
 194 struct loops
 195 {
 196   /* Number of natural loops in the function.  */
 197   unsigned num;
 198
 199   /* Maximum nested loop level in the function.  */
 200   unsigned levels;
 201
 202   /* Array of natural loop descriptors (scanning this array in reverse order
 203      will find the inner loops before their enclosing outer loops).  */
 204   struct loop *array;
 205
 206   /* The above array is unused in new loop infrastructure and is kept only for
 207      purposes of the old loop optimizer.  Instead we store just pointers to
 208      loops here.  */
 209   struct loop **parray;
 210
 211   /* Pointer to root of loop hierarchy tree.  */
 212   struct loop *tree_root;
 213
 214   /* Information derived from the CFG.  */
 215   struct cfg
 216   {
 217     /* The ordering of the basic blocks in a depth first search.  */
 218     int *dfs_order;
 219
 220     /* The reverse completion ordering of the basic blocks found in a
 221        depth first search.  */
 222     int *rc_order;
 223   } cfg;
 224
 225   /* Headers shared by multiple loops that should be merged.  */
 226   sbitmap shared_headers;
 227
 228   /* State of loops.  */
 229   int state;
 230 };
 231
 232 /* The loop tree currently optimized.  */
 233
 234 extern struct loops *current_loops;
 235
 236 /* Flags for loop discovery.  */
 237
 238 #define LOOP_TREE               1       /* Build loop hierarchy tree.  */
 239 #define LOOP_PRE_HEADER         2       /* Analyze loop preheader.  */
 240 #define LOOP_ENTRY_EDGES        4       /* Find entry edges.  */
 241 #define LOOP_EXIT_EDGES         8       /* Find exit edges.  */
 242 #define LOOP_EDGES              (LOOP_ENTRY_EDGES | LOOP_EXIT_EDGES)
 243 #define LOOP_ALL               15       /* All of the above  */
 244
 245 /* Loop recognition.  */
 246 extern int flow_loops_find (struct loops *, int flags);
 247 extern int flow_loops_update (struct loops *, int flags);
 248 extern void flow_loops_free (struct loops *);
 249 extern void flow_loops_dump (const struct loops *, FILE *,
 250                              void (*)(const struct loop *, FILE *, int), int);
 251 extern void flow_loop_dump (const struct loop *, FILE *,
 252                             void (*)(const struct loop *, FILE *, int), int);
 253 extern int flow_loop_scan (struct loop *, int);
 254 extern void flow_loop_free (struct loop *);
 255 void mark_irreducible_loops (struct loops *);
 256 void mark_single_exit_loops (struct loops *);
 257 extern void create_loop_notes (void);
 258
 259 /* Loop data structure manipulation/querying.  */
 260 extern void flow_loop_tree_node_add (struct loop *, struct loop *);
 261 extern void flow_loop_tree_node_remove (struct loop *);
 262 extern bool flow_loop_outside_edge_p (const struct loop *, edge);
 263 extern bool flow_loop_nested_p  (const struct loop *, const struct loop *);
 264 extern bool flow_bb_inside_loop_p (const struct loop *, const basic_block);
 265 extern struct loop * find_common_loop (struct loop *, struct loop *);
 266 struct loop *superloop_at_depth (struct loop *, unsigned);
 267 extern unsigned tree_num_loop_insns (struct loop *);
 268 extern int num_loop_insns (struct loop *);
 269 extern int average_num_loop_insns (struct loop *);
 270 extern unsigned get_loop_level (const struct loop *);
 271
 272 /* Loops & cfg manipulation.  */
 273 extern basic_block *get_loop_body (const struct loop *);
 274 extern basic_block *get_loop_body_in_dom_order (const struct loop *);
 275 extern edge *get_loop_exit_edges (const struct loop *, unsigned *);
 276 extern unsigned num_loop_branches (const struct loop *);
 277
 278 extern edge loop_preheader_edge (const struct loop *);
 279 extern edge loop_latch_edge (const struct loop *);
 280
 281 extern void add_bb_to_loop (basic_block, struct loop *);
 282 extern void remove_bb_from_loops (basic_block);
 283
 284 extern void cancel_loop (struct loops *, struct loop *);
 285 extern void cancel_loop_tree (struct loops *, struct loop *);
 286
 287 extern basic_block loop_split_edge_with (edge, rtx);
 288 extern int fix_loop_placement (struct loop *);
 289
 290 enum
 291 {
 292   CP_SIMPLE_PREHEADERS = 1
 293 };
 294
 295 extern void create_preheaders (struct loops *, int);
 296 extern void force_single_succ_latches (struct loops *);
 297
 298 extern void verify_loop_structure (struct loops *);
 299
 300 /* Loop analysis.  */
 301 extern bool just_once_each_iteration_p (struct loop *, basic_block);
 302 extern unsigned expected_loop_iterations (const struct loop *);
 303
 304 /* Loop manipulation.  */
 305 extern bool can_duplicate_loop_p (struct loop *loop);
 306
 307 #define DLTHE_FLAG_UPDATE_FREQ  1       /* Update frequencies in
 308                                            duplicate_loop_to_header_edge.  */
 309
 310 extern int duplicate_loop_to_header_edge (struct loop *, edge, struct loops *,
 311                                           unsigned, sbitmap, edge, edge *,
 312                                           unsigned *, int);
 313 extern struct loop *loopify (struct loops *, edge, edge, basic_block);
 314 extern void unloop (struct loops *, struct loop *);
 315 extern bool remove_path (struct loops *, edge);
 316 extern edge split_loop_bb (basic_block, rtx);
 317
 318 /* Induction variable analysis.  */
 319
 320 /* The description of induction variable.  The things are a bit complicated
 321    due to need to handle subregs and extends.  The value of the object described
 322    by it can be obtained as follows (all computations are done in extend_mode):
 323
 324    Value in i-th iteration is
 325      delta + mult * extend_{extend_mode} (subreg_{mode} (base + i * step)).
 326
 327    If first_special is true, the value in the first iteration is
 328      delta + mult * base
 329
 330    If extend = UNKNOWN, first_special must be false, delta 0, mult 1 and value is
 331      subreg_{mode} (base + i * step)
 332
 333    The get_iv_value function can be used to obtain these expressions.
 334
 335    ??? Add a third mode field that would specify the mode in that inner
 336    computation is done, which would enable it to be different from the
 337    outer one?  */
 338
 339 struct rtx_iv
 340 {
 341   /* Its base and step (mode of base and step is supposed to be extend_mode,
 342      see the description above).  */
 343   rtx base, step;
 344
 345   /* The type of extend applied to it (SIGN_EXTEND, ZERO_EXTEND or UNKNOWN).  */
 346   enum rtx_code extend;
 347
 348   /* Operations applied in the extended mode.  */
 349   rtx delta, mult;
 350
 351   /* The mode it is extended to.  */
 352   enum machine_mode extend_mode;
 353
 354   /* The mode the variable iterates in.  */
 355   enum machine_mode mode;
 356
 357   /* Whether we have already filled the remaining fields.  */
 358   unsigned analysed : 1;
 359
 360   /* Whether the first iteration needs to be handled specially.  */
 361   unsigned first_special : 1;
 362 };
 363
 364 /* The description of an exit from the loop and of the number of iterations
 365    till we take the exit.  */
 366
 367 struct niter_desc
 368 {
 369   /* The edge out of the loop.  */
 370   edge out_edge;
 371
 372   /* The other edge leading from the condition.  */
 373   edge in_edge;
 374
 375   /* True if we are able to say anything about number of iterations of the
 376      loop.  */
 377   bool simple_p;
 378
 379   /* True if the loop iterates the constant number of times.  */
 380   bool const_iter;
 381
 382   /* Number of iterations if constant.  */
 383   unsigned HOST_WIDEST_INT niter;
 384
 385   /* Upper bound on the number of iterations.  */
 386   unsigned HOST_WIDEST_INT niter_max;
 387
 388   /* Assumptions under that the rest of the information is valid.  */
 389   rtx assumptions;
 390
 391   /* Assumptions under that the loop ends before reaching the latch,
 392      even if value of niter_expr says otherwise.  */
 393   rtx noloop_assumptions;
 394
 395   /* Condition under that the loop is infinite.  */
 396   rtx infinite;
 397
 398   /* Whether the comparison is signed.  */
 399   bool signed_p;
 400
 401   /* The mode in that niter_expr should be computed.  */
 402   enum machine_mode mode;
 403
 404   /* The number of iterations of the loop.  */
 405   rtx niter_expr;
 406 };
 407
 408 extern void iv_analysis_loop_init (struct loop *);
 409 extern rtx iv_get_reaching_def (rtx, rtx);
 410 extern bool iv_analyze (rtx, rtx, struct rtx_iv *);
 411 extern rtx get_iv_value (struct rtx_iv *, rtx);
 412 extern void find_simple_exit (struct loop *, struct niter_desc *);
 413 extern void iv_number_of_iterations (struct loop *, rtx, rtx,
 414                                      struct niter_desc *);
 415 extern void iv_analysis_done (void);
 416
 417 extern struct niter_desc *get_simple_loop_desc (struct loop *loop);
 418 extern void free_simple_loop_desc (struct loop *loop);
 419
 420 static inline struct niter_desc *
 421 simple_loop_desc (struct loop *loop)
 422 {
 423   return loop->aux;
 424 }
 425
 426 /* Register pressure estimation for induction variable optimizations & loop
 427    invariant motion.  */
 428 extern unsigned global_cost_for_size (unsigned, unsigned, unsigned);
 429 extern void init_set_costs (void);
 430
 431 /* Loop optimizer initialization.  */
 432 extern struct loops *loop_optimizer_init (FILE *);
 433 extern void loop_optimizer_finalize (struct loops *, FILE *);
 434
 435 /* Optimization passes.  */
 436 extern void unswitch_loops (struct loops *);
 437
 438 enum
 439 {
 440   UAP_PEEL = 1,         /* Enables loop peeling.  */
 441   UAP_UNROLL = 2,       /* Enables peeling of loops if it seems profitable.  */
 442   UAP_UNROLL_ALL = 4    /* Enables peeling of all loops.  */
 443 };
 444
 445 extern void unroll_and_peel_loops (struct loops *, int);
 446 extern void doloop_optimize_loops (struct loops *);
 447 extern void move_loop_invariants (struct loops *);
 448
 449 #endif /* GCC_CFGLOOP_H */