ChangeLog entry:
[official-gcc.git] / gcc / cfgloop.h
blobb3c862cb12e10aa58904d0202367944b326007d8
1 /* Natural loop functions
2 Copyright (C) 1987, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
3 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
5 This file is part of GCC.
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 3, or (at your option) any later
10 version.
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.
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING3. If not see
19 <http://www.gnu.org/licenses/>. */
21 #ifndef GCC_CFGLOOP_H
22 #define GCC_CFGLOOP_H
24 #include "basic-block.h"
25 /* For rtx_code. */
26 #include "rtl.h"
27 #include "vecprim.h"
28 #include "double-int.h"
30 #include "bitmap.h"
31 #include "sbitmap.h"
33 /* Structure to hold decision about unrolling/peeling. */
34 enum lpt_dec
36 LPT_NONE,
37 LPT_PEEL_COMPLETELY,
38 LPT_PEEL_SIMPLE,
39 LPT_UNROLL_CONSTANT,
40 LPT_UNROLL_RUNTIME,
41 LPT_UNROLL_STUPID
44 struct GTY (()) lpt_decision {
45 enum lpt_dec decision;
46 unsigned times;
49 /* The structure describing a bound on number of iterations of a loop. */
51 struct GTY ((chain_next ("%h.next"))) nb_iter_bound {
52 /* The statement STMT is executed at most ... */
53 gimple stmt;
55 /* ... BOUND + 1 times (BOUND must be an unsigned constant).
56 The + 1 is added for the following reasons:
58 a) 0 would otherwise be unused, while we would need to care more about
59 overflows (as MAX + 1 is sometimes produced as the estimate on number
60 of executions of STMT).
61 b) it is consistent with the result of number_of_iterations_exit. */
62 double_int bound;
64 /* True if the statement will cause the loop to be leaved the (at most)
65 BOUND + 1-st time it is executed, that is, all the statements after it
66 are executed at most BOUND times. */
67 bool is_exit;
69 /* The next bound in the list. */
70 struct nb_iter_bound *next;
73 /* Description of the loop exit. */
75 struct GTY (()) loop_exit {
76 /* The exit edge. */
77 struct edge_def *e;
79 /* Previous and next exit in the list of the exits of the loop. */
80 struct loop_exit *prev;
81 struct loop_exit *next;
83 /* Next element in the list of loops from that E exits. */
84 struct loop_exit *next_e;
87 typedef struct loop *loop_p;
88 DEF_VEC_P (loop_p);
89 DEF_VEC_ALLOC_P (loop_p, heap);
90 DEF_VEC_ALLOC_P (loop_p, gc);
92 /* An integer estimation of the number of iterations. Estimate_state
93 describes what is the state of the estimation. */
94 enum loop_estimation
96 /* Estimate was not computed yet. */
97 EST_NOT_COMPUTED,
98 /* Estimate is ready. */
99 EST_AVAILABLE
102 /* Structure to hold information for each natural loop. */
103 struct GTY ((chain_next ("%h.next"))) loop {
104 /* Index into loops array. */
105 int num;
107 /* Number of loop insns. */
108 unsigned ninsns;
110 /* Basic block of loop header. */
111 struct basic_block_def *header;
113 /* Basic block of loop latch. */
114 struct basic_block_def *latch;
116 /* For loop unrolling/peeling decision. */
117 struct lpt_decision lpt_decision;
119 /* Average number of executed insns per iteration. */
120 unsigned av_ninsns;
122 /* Number of blocks contained within the loop. */
123 unsigned num_nodes;
125 /* Superloops of the loop, starting with the outermost loop. */
126 VEC (loop_p, gc) *superloops;
128 /* The first inner (child) loop or NULL if innermost loop. */
129 struct loop *inner;
131 /* Link to the next (sibling) loop. */
132 struct loop *next;
134 /* Auxiliary info specific to a pass. */
135 PTR GTY ((skip (""))) aux;
137 /* The number of times the latch of the loop is executed. This can be an
138 INTEGER_CST, or a symbolic expression representing the number of
139 iterations like "N - 1", or a COND_EXPR containing the runtime
140 conditions under which the number of iterations is non zero.
142 Don't access this field directly: number_of_latch_executions
143 computes and caches the computed information in this field. */
144 tree nb_iterations;
146 /* An integer guaranteed to be greater or equal to nb_iterations. Only
147 valid if any_upper_bound is true. */
148 double_int nb_iterations_upper_bound;
150 /* An integer giving an estimate on nb_iterations. Unlike
151 nb_iterations_upper_bound, there is no guarantee that it is at least
152 nb_iterations. */
153 double_int nb_iterations_estimate;
155 bool any_upper_bound;
156 bool any_estimate;
158 /* True if the loop can be parallel. */
159 bool can_be_parallel;
161 /* An integer estimation of the number of iterations. Estimate_state
162 describes what is the state of the estimation. */
163 enum loop_estimation estimate_state;
165 /* Upper bound on number of iterations of a loop. */
166 struct nb_iter_bound *bounds;
168 /* Head of the cyclic list of the exits of the loop. */
169 struct loop_exit *exits;
172 /* Flags for state of loop structure. */
173 enum
175 LOOPS_HAVE_PREHEADERS = 1,
176 LOOPS_HAVE_SIMPLE_LATCHES = 2,
177 LOOPS_HAVE_MARKED_IRREDUCIBLE_REGIONS = 4,
178 LOOPS_HAVE_RECORDED_EXITS = 8,
179 LOOPS_MAY_HAVE_MULTIPLE_LATCHES = 16,
180 LOOP_CLOSED_SSA = 32,
181 LOOPS_NEED_FIXUP = 64,
182 LOOPS_HAVE_FALLTHRU_PREHEADERS = 128
185 #define LOOPS_NORMAL (LOOPS_HAVE_PREHEADERS | LOOPS_HAVE_SIMPLE_LATCHES \
186 | LOOPS_HAVE_MARKED_IRREDUCIBLE_REGIONS)
187 #define AVOID_CFG_MODIFICATIONS (LOOPS_MAY_HAVE_MULTIPLE_LATCHES)
189 /* Structure to hold CFG information about natural loops within a function. */
190 struct GTY (()) loops {
191 /* State of loops. */
192 int state;
194 /* Array of the loops. */
195 VEC (loop_p, gc) *larray;
197 /* Maps edges to the list of their descriptions as loop exits. Edges
198 whose sources or destinations have loop_father == NULL (which may
199 happen during the cfg manipulations) should not appear in EXITS. */
200 htab_t GTY((param_is (struct loop_exit))) exits;
202 /* Pointer to root of loop hierarchy tree. */
203 struct loop *tree_root;
206 /* Loop recognition. */
207 extern int flow_loops_find (struct loops *);
208 extern void disambiguate_loops_with_multiple_latches (void);
209 extern void flow_loops_free (struct loops *);
210 extern void flow_loops_dump (FILE *,
211 void (*)(const struct loop *, FILE *, int), int);
212 extern void flow_loop_dump (const struct loop *, FILE *,
213 void (*)(const struct loop *, FILE *, int), int);
214 struct loop *alloc_loop (void);
215 extern void flow_loop_free (struct loop *);
216 int flow_loop_nodes_find (basic_block, struct loop *);
217 void fix_loop_structure (bitmap changed_bbs);
218 bool mark_irreducible_loops (void);
219 void release_recorded_exits (void);
220 void record_loop_exits (void);
221 void rescan_loop_exit (edge, bool, bool);
223 /* Loop data structure manipulation/querying. */
224 extern void flow_loop_tree_node_add (struct loop *, struct loop *);
225 extern void flow_loop_tree_node_remove (struct loop *);
226 extern void add_loop (struct loop *, struct loop *);
227 extern bool flow_loop_nested_p (const struct loop *, const struct loop *);
228 extern bool flow_bb_inside_loop_p (const struct loop *, const_basic_block);
229 extern struct loop * find_common_loop (struct loop *, struct loop *);
230 struct loop *superloop_at_depth (struct loop *, unsigned);
231 struct eni_weights_d;
232 extern unsigned tree_num_loop_insns (struct loop *, struct eni_weights_d *);
233 extern int num_loop_insns (const struct loop *);
234 extern int average_num_loop_insns (const struct loop *);
235 extern unsigned get_loop_level (const struct loop *);
236 extern bool loop_exit_edge_p (const struct loop *, const_edge);
237 extern bool loop_exits_to_bb_p (struct loop *, basic_block);
238 extern bool loop_exits_from_bb_p (struct loop *, basic_block);
239 extern void mark_loop_exit_edges (void);
241 /* Loops & cfg manipulation. */
242 extern basic_block *get_loop_body (const struct loop *);
243 extern unsigned get_loop_body_with_size (const struct loop *, basic_block *,
244 unsigned);
245 extern basic_block *get_loop_body_in_dom_order (const struct loop *);
246 extern basic_block *get_loop_body_in_bfs_order (const struct loop *);
247 extern basic_block *get_loop_body_in_custom_order (const struct loop *,
248 int (*) (const void *, const void *));
250 extern VEC (edge, heap) *get_loop_exit_edges (const struct loop *);
251 edge single_exit (const struct loop *);
252 extern unsigned num_loop_branches (const struct loop *);
254 extern edge loop_preheader_edge (const struct loop *);
255 extern edge loop_latch_edge (const struct loop *);
257 extern void add_bb_to_loop (basic_block, struct loop *);
258 extern void remove_bb_from_loops (basic_block);
260 extern void cancel_loop_tree (struct loop *);
261 extern void delete_loop (struct loop *);
263 enum
265 CP_SIMPLE_PREHEADERS = 1,
266 CP_FALLTHRU_PREHEADERS = 2
269 basic_block create_preheader (struct loop *, int);
270 extern void create_preheaders (int);
271 extern void force_single_succ_latches (void);
273 extern void verify_loop_structure (void);
275 /* Loop analysis. */
276 extern bool just_once_each_iteration_p (const struct loop *, const_basic_block);
277 gcov_type expected_loop_iterations_unbounded (const struct loop *);
278 extern unsigned expected_loop_iterations (const struct loop *);
279 extern rtx doloop_condition_get (rtx);
281 void estimate_numbers_of_iterations_loop (struct loop *);
282 void record_niter_bound (struct loop *, double_int, bool, bool);
283 bool estimated_loop_iterations (struct loop *, double_int *);
284 bool max_loop_iterations (struct loop *, double_int *);
285 HOST_WIDE_INT estimated_loop_iterations_int (struct loop *);
286 HOST_WIDE_INT max_loop_iterations_int (struct loop *);
287 bool max_stmt_executions (struct loop *, double_int *);
288 bool estimated_stmt_executions (struct loop *, double_int *);
289 HOST_WIDE_INT max_stmt_executions_int (struct loop *);
290 HOST_WIDE_INT estimated_stmt_executions_int (struct loop *);
292 /* Loop manipulation. */
293 extern bool can_duplicate_loop_p (const struct loop *loop);
295 #define DLTHE_FLAG_UPDATE_FREQ 1 /* Update frequencies in
296 duplicate_loop_to_header_edge. */
297 #define DLTHE_RECORD_COPY_NUMBER 2 /* Record copy number in the aux
298 field of newly create BB. */
299 #define DLTHE_FLAG_COMPLETTE_PEEL 4 /* Update frequencies expecting
300 a complete peeling. */
302 extern edge create_empty_if_region_on_edge (edge, tree);
303 extern struct loop *create_empty_loop_on_edge (edge, tree, tree, tree, tree,
304 tree *, tree *, struct loop *);
305 extern struct loop * duplicate_loop (struct loop *, struct loop *);
306 extern void duplicate_subloops (struct loop *, struct loop *);
307 extern bool duplicate_loop_to_header_edge (struct loop *, edge,
308 unsigned, sbitmap, edge,
309 VEC (edge, heap) **, int);
310 extern struct loop *loopify (edge, edge,
311 basic_block, edge, edge, bool,
312 unsigned, unsigned);
313 struct loop * loop_version (struct loop *, void *,
314 basic_block *, unsigned, unsigned, unsigned, bool);
315 extern bool remove_path (edge);
316 void scale_loop_frequencies (struct loop *, int, int);
318 /* Induction variable analysis. */
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):
324 Value in i-th iteration is
325 delta + mult * extend_{extend_mode} (subreg_{mode} (base + i * step)).
327 If first_special is true, the value in the first iteration is
328 delta + mult * base
330 If extend = UNKNOWN, first_special must be false, delta 0, mult 1 and value is
331 subreg_{mode} (base + i * step)
333 The get_iv_value function can be used to obtain these expressions.
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? */
339 struct rtx_iv
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;
345 /* The type of extend applied to it (SIGN_EXTEND, ZERO_EXTEND or UNKNOWN). */
346 enum rtx_code extend;
348 /* Operations applied in the extended mode. */
349 rtx delta, mult;
351 /* The mode it is extended to. */
352 enum machine_mode extend_mode;
354 /* The mode the variable iterates in. */
355 enum machine_mode mode;
357 /* Whether the first iteration needs to be handled specially. */
358 unsigned first_special : 1;
361 /* The description of an exit from the loop and of the number of iterations
362 till we take the exit. */
364 struct niter_desc
366 /* The edge out of the loop. */
367 edge out_edge;
369 /* The other edge leading from the condition. */
370 edge in_edge;
372 /* True if we are able to say anything about number of iterations of the
373 loop. */
374 bool simple_p;
376 /* True if the loop iterates the constant number of times. */
377 bool const_iter;
379 /* Number of iterations if constant. */
380 unsigned HOST_WIDEST_INT niter;
382 /* Upper bound on the number of iterations. */
383 unsigned HOST_WIDEST_INT niter_max;
385 /* Assumptions under that the rest of the information is valid. */
386 rtx assumptions;
388 /* Assumptions under that the loop ends before reaching the latch,
389 even if value of niter_expr says otherwise. */
390 rtx noloop_assumptions;
392 /* Condition under that the loop is infinite. */
393 rtx infinite;
395 /* Whether the comparison is signed. */
396 bool signed_p;
398 /* The mode in that niter_expr should be computed. */
399 enum machine_mode mode;
401 /* The number of iterations of the loop. */
402 rtx niter_expr;
405 extern void iv_analysis_loop_init (struct loop *);
406 extern bool iv_analyze (rtx, rtx, struct rtx_iv *);
407 extern bool iv_analyze_result (rtx, rtx, struct rtx_iv *);
408 extern bool iv_analyze_expr (rtx, rtx, enum machine_mode, struct rtx_iv *);
409 extern rtx get_iv_value (struct rtx_iv *, rtx);
410 extern bool biv_p (rtx, rtx);
411 extern void find_simple_exit (struct loop *, struct niter_desc *);
412 extern void iv_analysis_done (void);
414 extern struct niter_desc *get_simple_loop_desc (struct loop *loop);
415 extern void free_simple_loop_desc (struct loop *loop);
417 static inline struct niter_desc *
418 simple_loop_desc (struct loop *loop)
420 return (struct niter_desc *) loop->aux;
423 /* Accessors for the loop structures. */
425 /* Returns the loop with index NUM from current_loops. */
427 static inline struct loop *
428 get_loop (unsigned num)
430 return VEC_index (loop_p, current_loops->larray, num);
433 /* Returns the number of superloops of LOOP. */
435 static inline unsigned
436 loop_depth (const struct loop *loop)
438 return VEC_length (loop_p, loop->superloops);
441 /* Returns the immediate superloop of LOOP, or NULL if LOOP is the outermost
442 loop. */
444 static inline struct loop *
445 loop_outer (const struct loop *loop)
447 unsigned n = VEC_length (loop_p, loop->superloops);
449 if (n == 0)
450 return NULL;
452 return VEC_index (loop_p, loop->superloops, n - 1);
455 /* Returns true if LOOP has at least one exit edge. */
457 static inline bool
458 loop_has_exit_edges (const struct loop *loop)
460 return loop->exits->next->e != NULL;
463 /* Returns the list of loops in current_loops. */
465 static inline VEC (loop_p, gc) *
466 get_loops (void)
468 if (!current_loops)
469 return NULL;
471 return current_loops->larray;
474 /* Returns the number of loops in current_loops (including the removed
475 ones and the fake loop that forms the root of the loop tree). */
477 static inline unsigned
478 number_of_loops (void)
480 if (!current_loops)
481 return 0;
483 return VEC_length (loop_p, current_loops->larray);
486 /* Returns true if state of the loops satisfies all properties
487 described by FLAGS. */
489 static inline bool
490 loops_state_satisfies_p (unsigned flags)
492 return (current_loops->state & flags) == flags;
495 /* Sets FLAGS to the loops state. */
497 static inline void
498 loops_state_set (unsigned flags)
500 current_loops->state |= flags;
503 /* Clears FLAGS from the loops state. */
505 static inline void
506 loops_state_clear (unsigned flags)
508 if (!current_loops)
509 return;
510 current_loops->state &= ~flags;
513 /* Loop iterators. */
515 /* Flags for loop iteration. */
517 enum li_flags
519 LI_INCLUDE_ROOT = 1, /* Include the fake root of the loop tree. */
520 LI_FROM_INNERMOST = 2, /* Iterate over the loops in the reverse order,
521 starting from innermost ones. */
522 LI_ONLY_INNERMOST = 4 /* Iterate only over innermost loops. */
525 /* The iterator for loops. */
527 typedef struct
529 /* The list of loops to visit. */
530 VEC(int,heap) *to_visit;
532 /* The index of the actual loop. */
533 unsigned idx;
534 } loop_iterator;
536 static inline void
537 fel_next (loop_iterator *li, loop_p *loop)
539 int anum;
541 while (VEC_iterate (int, li->to_visit, li->idx, anum))
543 li->idx++;
544 *loop = get_loop (anum);
545 if (*loop)
546 return;
549 VEC_free (int, heap, li->to_visit);
550 *loop = NULL;
553 static inline void
554 fel_init (loop_iterator *li, loop_p *loop, unsigned flags)
556 struct loop *aloop;
557 unsigned i;
558 int mn;
560 li->idx = 0;
561 if (!current_loops)
563 li->to_visit = NULL;
564 *loop = NULL;
565 return;
568 li->to_visit = VEC_alloc (int, heap, number_of_loops ());
569 mn = (flags & LI_INCLUDE_ROOT) ? 0 : 1;
571 if (flags & LI_ONLY_INNERMOST)
573 for (i = 0; VEC_iterate (loop_p, current_loops->larray, i, aloop); i++)
574 if (aloop != NULL
575 && aloop->inner == NULL
576 && aloop->num >= mn)
577 VEC_quick_push (int, li->to_visit, aloop->num);
579 else if (flags & LI_FROM_INNERMOST)
581 /* Push the loops to LI->TO_VISIT in postorder. */
582 for (aloop = current_loops->tree_root;
583 aloop->inner != NULL;
584 aloop = aloop->inner)
585 continue;
587 while (1)
589 if (aloop->num >= mn)
590 VEC_quick_push (int, li->to_visit, aloop->num);
592 if (aloop->next)
594 for (aloop = aloop->next;
595 aloop->inner != NULL;
596 aloop = aloop->inner)
597 continue;
599 else if (!loop_outer (aloop))
600 break;
601 else
602 aloop = loop_outer (aloop);
605 else
607 /* Push the loops to LI->TO_VISIT in preorder. */
608 aloop = current_loops->tree_root;
609 while (1)
611 if (aloop->num >= mn)
612 VEC_quick_push (int, li->to_visit, aloop->num);
614 if (aloop->inner != NULL)
615 aloop = aloop->inner;
616 else
618 while (aloop != NULL && aloop->next == NULL)
619 aloop = loop_outer (aloop);
620 if (aloop == NULL)
621 break;
622 aloop = aloop->next;
627 fel_next (li, loop);
630 #define FOR_EACH_LOOP(LI, LOOP, FLAGS) \
631 for (fel_init (&(LI), &(LOOP), FLAGS); \
632 (LOOP); \
633 fel_next (&(LI), &(LOOP)))
635 #define FOR_EACH_LOOP_BREAK(LI) \
637 VEC_free (int, heap, (LI)->to_visit); \
638 break; \
641 /* The properties of the target. */
642 struct target_cfgloop {
643 /* Number of available registers. */
644 unsigned x_target_avail_regs;
646 /* Number of available registers that are call-clobbered. */
647 unsigned x_target_clobbered_regs;
649 /* Number of registers reserved for temporary expressions. */
650 unsigned x_target_res_regs;
652 /* The cost for register when there still is some reserve, but we are
653 approaching the number of available registers. */
654 unsigned x_target_reg_cost[2];
656 /* The cost for register when we need to spill. */
657 unsigned x_target_spill_cost[2];
660 extern struct target_cfgloop default_target_cfgloop;
661 #if SWITCHABLE_TARGET
662 extern struct target_cfgloop *this_target_cfgloop;
663 #else
664 #define this_target_cfgloop (&default_target_cfgloop)
665 #endif
667 #define target_avail_regs \
668 (this_target_cfgloop->x_target_avail_regs)
669 #define target_clobbered_regs \
670 (this_target_cfgloop->x_target_clobbered_regs)
671 #define target_res_regs \
672 (this_target_cfgloop->x_target_res_regs)
673 #define target_reg_cost \
674 (this_target_cfgloop->x_target_reg_cost)
675 #define target_spill_cost \
676 (this_target_cfgloop->x_target_spill_cost)
678 /* Register pressure estimation for induction variable optimizations & loop
679 invariant motion. */
680 extern unsigned estimate_reg_pressure_cost (unsigned, unsigned, bool, bool);
681 extern void init_set_costs (void);
683 /* Loop optimizer initialization. */
684 extern void loop_optimizer_init (unsigned);
685 extern void loop_optimizer_finalize (void);
687 /* Optimization passes. */
688 extern void unswitch_loops (void);
690 enum
692 UAP_PEEL = 1, /* Enables loop peeling. */
693 UAP_UNROLL = 2, /* Enables unrolling of loops if it seems profitable. */
694 UAP_UNROLL_ALL = 4 /* Enables unrolling of all loops. */
697 extern void unroll_and_peel_loops (int);
698 extern void doloop_optimize_loops (void);
699 extern void move_loop_invariants (void);
700 extern bool finite_loop_p (struct loop *);
702 #endif /* GCC_CFGLOOP_H */