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   /* Nonzero if the loop has a NOTE_INSN_LOOP_VTOP.  */
 139   rtx vtop;
 140
 141   /* Nonzero if the loop has a NOTE_INSN_LOOP_CONT.
 142      A continue statement will generate a branch to NEXT_INSN (cont).  */
 143   rtx cont;
 144
 145   /* The dominator of cont.  */
 146   rtx cont_dominator;
 147
 148   /* The NOTE_INSN_LOOP_BEG.  */
 149   rtx start;
 150
 151   /* The NOTE_INSN_LOOP_END.  */
 152   rtx end;
 153
 154   /* For a rotated loop that is entered near the bottom,
 155      this is the label at the top.  Otherwise it is zero.  */
 156   rtx top;
 157
 158   /* Place in the loop where control enters.  */
 159   rtx scan_start;
 160
 161   /* The position where to sink insns out of the loop.  */
 162   rtx sink;
 163
 164   /* List of all LABEL_REFs which refer to code labels outside the
 165      loop.  Used by routines that need to know all loop exits, such as
 166      final_biv_value and final_giv_value.
 167
 168      This does not include loop exits due to return instructions.
 169      This is because all bivs and givs are pseudos, and hence must be
 170      dead after a return, so the presence of a return does not affect
 171      any of the optimizations that use this info.  It is simpler to
 172      just not include return instructions on this list.  */
 173   rtx exit_labels;
 174
 175   /* The number of LABEL_REFs on exit_labels for this loop and all
 176      loops nested inside it.  */
 177   int exit_count;
 178
 179   /* The probable number of times the loop is executed at runtime.
 180      This is an INTEGER_CST or an expression containing symbolic
 181      names.  Don't access this field directly:
 182      number_of_iterations_in_loop computes and caches the computed
 183      information in this field.  */
 184   tree nb_iterations;
 185
 186   /* Upper bound on number of iterations of a loop.  */
 187   struct nb_iter_bound *bounds;
 188
 189   /* If not NULL, loop has just single exit edge stored here (edges to the
 190      EXIT_BLOCK_PTR do not count.  */
 191   edge single_exit;
 192 };
 193
 194 /* Flags for state of loop structure.  */
 195 enum
 196 {
 197   LOOPS_HAVE_PREHEADERS = 1,
 198   LOOPS_HAVE_SIMPLE_LATCHES = 2,
 199   LOOPS_HAVE_MARKED_IRREDUCIBLE_REGIONS = 4,
 200   LOOPS_HAVE_MARKED_SINGLE_EXITS = 8
 201 };
 202
 203 /* Structure to hold CFG information about natural loops within a function.  */
 204 struct loops
 205 {
 206   /* Number of natural loops in the function.  */
 207   unsigned num;
 208
 209   /* Maximum nested loop level in the function.  */
 210   unsigned levels;
 211
 212   /* Array of natural loop descriptors (scanning this array in reverse order
 213      will find the inner loops before their enclosing outer loops).  */
 214   struct loop *array;
 215
 216   /* The above array is unused in new loop infrastructure and is kept only for
 217      purposes of the old loop optimizer.  Instead we store just pointers to
 218      loops here.  */
 219   struct loop **parray;
 220
 221   /* Pointer to root of loop hierarchy tree.  */
 222   struct loop *tree_root;
 223
 224   /* Information derived from the CFG.  */
 225   struct cfg
 226   {
 227     /* The ordering of the basic blocks in a depth first search.  */
 228     int *dfs_order;
 229
 230     /* The reverse completion ordering of the basic blocks found in a
 231        depth first search.  */
 232     int *rc_order;
 233   } cfg;
 234
 235   /* Headers shared by multiple loops that should be merged.  */
 236   sbitmap shared_headers;
 237
 238   /* State of loops.  */
 239   int state;
 240 };
 241
 242 /* The loop tree currently optimized.  */
 243
 244 extern struct loops *current_loops;
 245
 246 /* Flags for loop discovery.  */
 247
 248 #define LOOP_TREE               1       /* Build loop hierarchy tree.  */
 249 #define LOOP_PRE_HEADER         2       /* Analyze loop preheader.  */
 250 #define LOOP_ENTRY_EDGES        4       /* Find entry edges.  */
 251 #define LOOP_EXIT_EDGES         8       /* Find exit edges.  */
 252 #define LOOP_EDGES              (LOOP_ENTRY_EDGES | LOOP_EXIT_EDGES)
 253 #define LOOP_ALL               15       /* All of the above  */
 254
 255 /* Loop recognition.  */
 256 extern int flow_loops_find (struct loops *, int flags);
 257 extern int flow_loops_update (struct loops *, int flags);
 258 extern void flow_loops_free (struct loops *);
 259 extern void flow_loops_dump (const struct loops *, FILE *,
 260                              void (*)(const struct loop *, FILE *, int), int);
 261 extern void flow_loop_dump (const struct loop *, FILE *,
 262                             void (*)(const struct loop *, FILE *, int), int);
 263 extern int flow_loop_scan (struct loop *, int);
 264 extern void flow_loop_free (struct loop *);
 265 void mark_irreducible_loops (struct loops *);
 266 void mark_single_exit_loops (struct loops *);
 267 extern void create_loop_notes (void);
 268
 269 /* Loop data structure manipulation/querying.  */
 270 extern void flow_loop_tree_node_add (struct loop *, struct loop *);
 271 extern void flow_loop_tree_node_remove (struct loop *);
 272 extern bool flow_loop_outside_edge_p (const struct loop *, edge);
 273 extern bool flow_loop_nested_p  (const struct loop *, const struct loop *);
 274 extern bool flow_bb_inside_loop_p (const struct loop *, const basic_block);
 275 extern struct loop * find_common_loop (struct loop *, struct loop *);
 276 struct loop *superloop_at_depth (struct loop *, unsigned);
 277 extern unsigned tree_num_loop_insns (struct loop *);
 278 extern int num_loop_insns (struct loop *);
 279 extern int average_num_loop_insns (struct loop *);
 280 extern unsigned get_loop_level (const struct loop *);
 281
 282 /* Loops & cfg manipulation.  */
 283 extern basic_block *get_loop_body (const struct loop *);
 284 extern basic_block *get_loop_body_in_dom_order (const struct loop *);
 285 extern edge *get_loop_exit_edges (const struct loop *, unsigned *);
 286 extern unsigned num_loop_branches (const struct loop *);
 287
 288 extern edge loop_preheader_edge (const struct loop *);
 289 extern edge loop_latch_edge (const struct loop *);
 290
 291 extern void add_bb_to_loop (basic_block, struct loop *);
 292 extern void remove_bb_from_loops (basic_block);
 293
 294 extern void cancel_loop (struct loops *, struct loop *);
 295 extern void cancel_loop_tree (struct loops *, struct loop *);
 296
 297 extern basic_block loop_split_edge_with (edge, rtx);
 298 extern int fix_loop_placement (struct loop *);
 299
 300 enum
 301 {
 302   CP_SIMPLE_PREHEADERS = 1
 303 };
 304
 305 extern void create_preheaders (struct loops *, int);
 306 extern void force_single_succ_latches (struct loops *);
 307
 308 extern void verify_loop_structure (struct loops *);
 309
 310 /* Loop analysis.  */
 311 extern bool just_once_each_iteration_p (struct loop *, basic_block);
 312 extern unsigned expected_loop_iterations (const struct loop *);
 313
 314 /* Loop manipulation.  */
 315 extern bool can_duplicate_loop_p (struct loop *loop);
 316
 317 #define DLTHE_FLAG_UPDATE_FREQ  1       /* Update frequencies in
 318                                            duplicate_loop_to_header_edge.  */
 319
 320 extern int duplicate_loop_to_header_edge (struct loop *, edge, struct loops *,
 321                                           unsigned, sbitmap, edge, edge *,
 322                                           unsigned *, int);
 323 extern struct loop *loopify (struct loops *, edge, edge, basic_block);
 324 extern void unloop (struct loops *, struct loop *);
 325 extern bool remove_path (struct loops *, edge);
 326 extern edge split_loop_bb (basic_block, rtx);
 327
 328 /* Induction variable analysis.  */
 329
 330 /* The description of induction variable.  The things are a bit complicated
 331    due to need to handle subregs and extends.  The value of the object described
 332    by it can be obtained as follows (all computations are done in extend_mode):
 333
 334    Value in i-th iteration is
 335      delta + mult * extend_{extend_mode} (subreg_{mode} (base + i * step)).
 336
 337    If first_special is true, the value in the first iteration is
 338      delta + mult * base
 339
 340    If extend = UNKNOWN, first_special must be false, delta 0, mult 1 and value is
 341      subreg_{mode} (base + i * step)
 342
 343    The get_iv_value function can be used to obtain these expressions.
 344
 345    ??? Add a third mode field that would specify the mode in that inner
 346    computation is done, which would enable it to be different from the
 347    outer one?  */
 348
 349 struct rtx_iv
 350 {
 351   /* Its base and step (mode of base and step is supposed to be extend_mode,
 352      see the description above).  */
 353   rtx base, step;
 354
 355   /* The type of extend applied to it (SIGN_EXTEND, ZERO_EXTEND or UNKNOWN).  */
 356   enum rtx_code extend;
 357
 358   /* Operations applied in the extended mode.  */
 359   rtx delta, mult;
 360
 361   /* The mode it is extended to.  */
 362   enum machine_mode extend_mode;
 363
 364   /* The mode the variable iterates in.  */
 365   enum machine_mode mode;
 366
 367   /* Whether we have already filled the remaining fields.  */
 368   unsigned analysed : 1;
 369
 370   /* Whether the first iteration needs to be handled specially.  */
 371   unsigned first_special : 1;
 372 };
 373
 374 /* The description of an exit from the loop and of the number of iterations
 375    till we take the exit.  */
 376
 377 struct niter_desc
 378 {
 379   /* The edge out of the loop.  */
 380   edge out_edge;
 381
 382   /* The other edge leading from the condition.  */
 383   edge in_edge;
 384
 385   /* True if we are able to say anything about number of iterations of the
 386      loop.  */
 387   bool simple_p;
 388
 389   /* True if the loop iterates the constant number of times.  */
 390   bool const_iter;
 391
 392   /* Number of iterations if constant.  */
 393   unsigned HOST_WIDEST_INT niter;
 394
 395   /* Upper bound on the number of iterations.  */
 396   unsigned HOST_WIDEST_INT niter_max;
 397
 398   /* Assumptions under that the rest of the information is valid.  */
 399   rtx assumptions;
 400
 401   /* Assumptions under that the loop ends before reaching the latch,
 402      even if value of niter_expr says otherwise.  */
 403   rtx noloop_assumptions;
 404
 405   /* Condition under that the loop is infinite.  */
 406   rtx infinite;
 407
 408   /* Whether the comparison is signed.  */
 409   bool signed_p;
 410
 411   /* The mode in that niter_expr should be computed.  */
 412   enum machine_mode mode;
 413
 414   /* The number of iterations of the loop.  */
 415   rtx niter_expr;
 416 };
 417
 418 extern void iv_analysis_loop_init (struct loop *);
 419 extern rtx iv_get_reaching_def (rtx, rtx);
 420 extern bool iv_analyze (rtx, rtx, struct rtx_iv *);
 421 extern rtx get_iv_value (struct rtx_iv *, rtx);
 422 extern void find_simple_exit (struct loop *, struct niter_desc *);
 423 extern void iv_number_of_iterations (struct loop *, rtx, rtx,
 424                                      struct niter_desc *);
 425 extern void iv_analysis_done (void);
 426
 427 extern struct niter_desc *get_simple_loop_desc (struct loop *loop);
 428 extern void free_simple_loop_desc (struct loop *loop);
 429
 430 static inline struct niter_desc *
 431 simple_loop_desc (struct loop *loop)
 432 {
 433   return loop->aux;
 434 }
 435
 436 /* Register pressure estimation for induction variable optimizations & loop
 437    invariant motion.  */
 438 extern unsigned global_cost_for_size (unsigned, unsigned, unsigned);
 439 extern void init_set_costs (void);
 440
 441 /* Loop optimizer initialization.  */
 442 extern struct loops *loop_optimizer_init (FILE *);
 443 extern void loop_optimizer_finalize (struct loops *, FILE *);
 444
 445 /* Optimization passes.  */
 446 extern void unswitch_loops (struct loops *);
 447
 448 enum
 449 {
 450   UAP_PEEL = 1,         /* Enables loop peeling.  */
 451   UAP_UNROLL = 2,       /* Enables peeling of loops if it seems profitable.  */
 452   UAP_UNROLL_ALL = 4    /* Enables peeling of all loops.  */
 453 };
 454
 455 extern void unroll_and_peel_loops (struct loops *, int);
 456 extern void doloop_optimize_loops (struct loops *);
 457 extern void move_loop_invariants (struct loops *);
 458
 459 #endif /* GCC_CFGLOOP_H */