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
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
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/>. */
24 #include "basic-block.h"
26 #include "double-int.h"
31 /* Structure to hold decision about unrolling/peeling. */
42 struct GTY (()) lpt_decision
{
43 enum lpt_dec decision
;
47 /* The type of extend applied to an IV. */
55 /* The structure describing a bound on number of iterations of a loop. */
57 struct GTY ((chain_next ("%h.next"))) nb_iter_bound
{
58 /* The statement STMT is executed at most ... */
61 /* ... BOUND + 1 times (BOUND must be an unsigned constant).
62 The + 1 is added for the following reasons:
64 a) 0 would otherwise be unused, while we would need to care more about
65 overflows (as MAX + 1 is sometimes produced as the estimate on number
66 of executions of STMT).
67 b) it is consistent with the result of number_of_iterations_exit. */
70 /* True if the statement will cause the loop to be leaved the (at most)
71 BOUND + 1-st time it is executed, that is, all the statements after it
72 are executed at most BOUND times. */
75 /* The next bound in the list. */
76 struct nb_iter_bound
*next
;
79 /* Description of the loop exit. */
81 struct GTY (()) loop_exit
{
85 /* Previous and next exit in the list of the exits of the loop. */
86 struct loop_exit
*prev
;
87 struct loop_exit
*next
;
89 /* Next element in the list of loops from that E exits. */
90 struct loop_exit
*next_e
;
93 typedef struct loop
*loop_p
;
95 DEF_VEC_ALLOC_P (loop_p
, heap
);
96 DEF_VEC_ALLOC_P (loop_p
, gc
);
98 /* An integer estimation of the number of iterations. Estimate_state
99 describes what is the state of the estimation. */
102 /* Estimate was not computed yet. */
104 /* Estimate is ready. */
108 /* Structure to hold information for each natural loop. */
109 struct GTY ((chain_next ("%h.next"))) loop
{
110 /* Index into loops array. */
113 /* Number of loop insns. */
116 /* Basic block of loop header. */
119 /* Basic block of loop latch. */
122 /* For loop unrolling/peeling decision. */
123 struct lpt_decision lpt_decision
;
125 /* Average number of executed insns per iteration. */
128 /* Number of blocks contained within the loop. */
131 /* Superloops of the loop, starting with the outermost loop. */
132 VEC (loop_p
, gc
) *superloops
;
134 /* The first inner (child) loop or NULL if innermost loop. */
137 /* Link to the next (sibling) loop. */
140 /* Auxiliary info specific to a pass. */
141 PTR
GTY ((skip (""))) aux
;
143 /* The number of times the latch of the loop is executed. This can be an
144 INTEGER_CST, or a symbolic expression representing the number of
145 iterations like "N - 1", or a COND_EXPR containing the runtime
146 conditions under which the number of iterations is non zero.
148 Don't access this field directly: number_of_latch_executions
149 computes and caches the computed information in this field. */
152 /* An integer guaranteed to be greater or equal to nb_iterations. Only
153 valid if any_upper_bound is true. */
154 double_int nb_iterations_upper_bound
;
156 /* An integer giving an estimate on nb_iterations. Unlike
157 nb_iterations_upper_bound, there is no guarantee that it is at least
159 double_int nb_iterations_estimate
;
161 bool any_upper_bound
;
164 /* True if the loop can be parallel. */
165 bool can_be_parallel
;
167 /* An integer estimation of the number of iterations. Estimate_state
168 describes what is the state of the estimation. */
169 enum loop_estimation estimate_state
;
171 /* Upper bound on number of iterations of a loop. */
172 struct nb_iter_bound
*bounds
;
174 /* Head of the cyclic list of the exits of the loop. */
175 struct loop_exit
*exits
;
178 /* Flags for state of loop structure. */
181 LOOPS_HAVE_PREHEADERS
= 1,
182 LOOPS_HAVE_SIMPLE_LATCHES
= 2,
183 LOOPS_HAVE_MARKED_IRREDUCIBLE_REGIONS
= 4,
184 LOOPS_HAVE_RECORDED_EXITS
= 8,
185 LOOPS_MAY_HAVE_MULTIPLE_LATCHES
= 16,
186 LOOP_CLOSED_SSA
= 32,
187 LOOPS_NEED_FIXUP
= 64,
188 LOOPS_HAVE_FALLTHRU_PREHEADERS
= 128
191 #define LOOPS_NORMAL (LOOPS_HAVE_PREHEADERS | LOOPS_HAVE_SIMPLE_LATCHES \
192 | LOOPS_HAVE_MARKED_IRREDUCIBLE_REGIONS)
193 #define AVOID_CFG_MODIFICATIONS (LOOPS_MAY_HAVE_MULTIPLE_LATCHES)
195 /* Structure to hold CFG information about natural loops within a function. */
196 struct GTY (()) loops
{
197 /* State of loops. */
200 /* Array of the loops. */
201 VEC (loop_p
, gc
) *larray
;
203 /* Maps edges to the list of their descriptions as loop exits. Edges
204 whose sources or destinations have loop_father == NULL (which may
205 happen during the cfg manipulations) should not appear in EXITS. */
206 htab_t
GTY((param_is (struct loop_exit
))) exits
;
208 /* Pointer to root of loop hierarchy tree. */
209 struct loop
*tree_root
;
212 /* Loop recognition. */
213 extern int flow_loops_find (struct loops
*);
214 extern void disambiguate_loops_with_multiple_latches (void);
215 extern void flow_loops_free (struct loops
*);
216 extern void flow_loops_dump (FILE *,
217 void (*)(const struct loop
*, FILE *, int), int);
218 extern void flow_loop_dump (const struct loop
*, FILE *,
219 void (*)(const struct loop
*, FILE *, int), int);
220 struct loop
*alloc_loop (void);
221 extern void flow_loop_free (struct loop
*);
222 int flow_loop_nodes_find (basic_block
, struct loop
*);
223 void fix_loop_structure (bitmap changed_bbs
);
224 bool mark_irreducible_loops (void);
225 void release_recorded_exits (void);
226 void record_loop_exits (void);
227 void rescan_loop_exit (edge
, bool, bool);
229 /* Loop data structure manipulation/querying. */
230 extern void flow_loop_tree_node_add (struct loop
*, struct loop
*);
231 extern void flow_loop_tree_node_remove (struct loop
*);
232 extern void add_loop (struct loop
*, struct loop
*);
233 extern bool flow_loop_nested_p (const struct loop
*, const struct loop
*);
234 extern bool flow_bb_inside_loop_p (const struct loop
*, const_basic_block
);
235 extern struct loop
* find_common_loop (struct loop
*, struct loop
*);
236 struct loop
*superloop_at_depth (struct loop
*, unsigned);
237 struct eni_weights_d
;
238 extern unsigned tree_num_loop_insns (struct loop
*, struct eni_weights_d
*);
239 extern int num_loop_insns (const struct loop
*);
240 extern int average_num_loop_insns (const struct loop
*);
241 extern unsigned get_loop_level (const struct loop
*);
242 extern bool loop_exit_edge_p (const struct loop
*, const_edge
);
243 extern bool loop_exits_to_bb_p (struct loop
*, basic_block
);
244 extern bool loop_exits_from_bb_p (struct loop
*, basic_block
);
245 extern void mark_loop_exit_edges (void);
247 /* Loops & cfg manipulation. */
248 extern basic_block
*get_loop_body (const struct loop
*);
249 extern unsigned get_loop_body_with_size (const struct loop
*, basic_block
*,
251 extern basic_block
*get_loop_body_in_dom_order (const struct loop
*);
252 extern basic_block
*get_loop_body_in_bfs_order (const struct loop
*);
253 extern basic_block
*get_loop_body_in_custom_order (const struct loop
*,
254 int (*) (const void *, const void *));
256 extern VEC (edge
, heap
) *get_loop_exit_edges (const struct loop
*);
257 extern edge
single_exit (const struct loop
*);
258 extern edge
single_likely_exit (struct loop
*loop
);
259 extern unsigned num_loop_branches (const struct loop
*);
261 extern edge
loop_preheader_edge (const struct loop
*);
262 extern edge
loop_latch_edge (const struct loop
*);
264 extern void add_bb_to_loop (basic_block
, struct loop
*);
265 extern void remove_bb_from_loops (basic_block
);
267 extern void cancel_loop_tree (struct loop
*);
268 extern void delete_loop (struct loop
*);
272 CP_SIMPLE_PREHEADERS
= 1,
273 CP_FALLTHRU_PREHEADERS
= 2
276 basic_block
create_preheader (struct loop
*, int);
277 extern void create_preheaders (int);
278 extern void force_single_succ_latches (void);
280 extern void verify_loop_structure (void);
283 extern bool just_once_each_iteration_p (const struct loop
*, const_basic_block
);
284 gcov_type
expected_loop_iterations_unbounded (const struct loop
*);
285 extern unsigned expected_loop_iterations (const struct loop
*);
286 extern rtx
doloop_condition_get (rtx
);
288 void estimate_numbers_of_iterations_loop (struct loop
*);
289 void record_niter_bound (struct loop
*, double_int
, bool, bool);
290 bool estimated_loop_iterations (struct loop
*, double_int
*);
291 bool max_loop_iterations (struct loop
*, double_int
*);
292 HOST_WIDE_INT
estimated_loop_iterations_int (struct loop
*);
293 HOST_WIDE_INT
max_loop_iterations_int (struct loop
*);
294 bool max_stmt_executions (struct loop
*, double_int
*);
295 bool estimated_stmt_executions (struct loop
*, double_int
*);
296 HOST_WIDE_INT
max_stmt_executions_int (struct loop
*);
297 HOST_WIDE_INT
estimated_stmt_executions_int (struct loop
*);
299 /* Loop manipulation. */
300 extern bool can_duplicate_loop_p (const struct loop
*loop
);
302 #define DLTHE_FLAG_UPDATE_FREQ 1 /* Update frequencies in
303 duplicate_loop_to_header_edge. */
304 #define DLTHE_RECORD_COPY_NUMBER 2 /* Record copy number in the aux
305 field of newly create BB. */
306 #define DLTHE_FLAG_COMPLETTE_PEEL 4 /* Update frequencies expecting
307 a complete peeling. */
309 extern edge
create_empty_if_region_on_edge (edge
, tree
);
310 extern struct loop
*create_empty_loop_on_edge (edge
, tree
, tree
, tree
, tree
,
311 tree
*, tree
*, struct loop
*);
312 extern struct loop
* duplicate_loop (struct loop
*, struct loop
*);
313 extern void duplicate_subloops (struct loop
*, struct loop
*);
314 extern bool duplicate_loop_to_header_edge (struct loop
*, edge
,
315 unsigned, sbitmap
, edge
,
316 VEC (edge
, heap
) **, int);
317 extern struct loop
*loopify (edge
, edge
,
318 basic_block
, edge
, edge
, bool,
320 struct loop
* loop_version (struct loop
*, void *,
321 basic_block
*, unsigned, unsigned, unsigned, bool);
322 extern bool remove_path (edge
);
323 extern void unloop (struct loop
*, bool *);
324 extern void scale_loop_frequencies (struct loop
*, int, int);
326 /* Induction variable analysis. */
328 /* The description of induction variable. The things are a bit complicated
329 due to need to handle subregs and extends. The value of the object described
330 by it can be obtained as follows (all computations are done in extend_mode):
332 Value in i-th iteration is
333 delta + mult * extend_{extend_mode} (subreg_{mode} (base + i * step)).
335 If first_special is true, the value in the first iteration is
338 If extend = UNKNOWN, first_special must be false, delta 0, mult 1 and value is
339 subreg_{mode} (base + i * step)
341 The get_iv_value function can be used to obtain these expressions.
343 ??? Add a third mode field that would specify the mode in that inner
344 computation is done, which would enable it to be different from the
349 /* Its base and step (mode of base and step is supposed to be extend_mode,
350 see the description above). */
353 /* The type of extend applied to it (IV_SIGN_EXTEND, IV_ZERO_EXTEND,
354 or IV_UNKNOWN_EXTEND). */
355 enum iv_extend_code extend
;
357 /* Operations applied in the extended mode. */
360 /* The mode it is extended to. */
361 enum machine_mode extend_mode
;
363 /* The mode the variable iterates in. */
364 enum machine_mode mode
;
366 /* Whether the first iteration needs to be handled specially. */
367 unsigned first_special
: 1;
370 /* The description of an exit from the loop and of the number of iterations
371 till we take the exit. */
375 /* The edge out of the loop. */
378 /* The other edge leading from the condition. */
381 /* True if we are able to say anything about number of iterations of the
385 /* True if the loop iterates the constant number of times. */
388 /* Number of iterations if constant. */
389 unsigned HOST_WIDEST_INT niter
;
391 /* Assumptions under that the rest of the information is valid. */
394 /* Assumptions under that the loop ends before reaching the latch,
395 even if value of niter_expr says otherwise. */
396 rtx noloop_assumptions
;
398 /* Condition under that the loop is infinite. */
401 /* Whether the comparison is signed. */
404 /* The mode in that niter_expr should be computed. */
405 enum machine_mode mode
;
407 /* The number of iterations of the loop. */
411 extern void iv_analysis_loop_init (struct loop
*);
412 extern bool iv_analyze (rtx
, rtx
, struct rtx_iv
*);
413 extern bool iv_analyze_result (rtx
, rtx
, struct rtx_iv
*);
414 extern bool iv_analyze_expr (rtx
, rtx
, enum machine_mode
, struct rtx_iv
*);
415 extern rtx
get_iv_value (struct rtx_iv
*, rtx
);
416 extern bool biv_p (rtx
, rtx
);
417 extern void find_simple_exit (struct loop
*, struct niter_desc
*);
418 extern void iv_analysis_done (void);
420 extern struct niter_desc
*get_simple_loop_desc (struct loop
*loop
);
421 extern void free_simple_loop_desc (struct loop
*loop
);
423 static inline struct niter_desc
*
424 simple_loop_desc (struct loop
*loop
)
426 return (struct niter_desc
*) loop
->aux
;
429 /* Accessors for the loop structures. */
431 /* Returns the loop with index NUM from current_loops. */
433 static inline struct loop
*
434 get_loop (unsigned num
)
436 return VEC_index (loop_p
, current_loops
->larray
, num
);
439 /* Returns the number of superloops of LOOP. */
441 static inline unsigned
442 loop_depth (const struct loop
*loop
)
444 return VEC_length (loop_p
, loop
->superloops
);
447 /* Returns the loop depth of the loop BB belongs to. */
450 bb_loop_depth (const_basic_block bb
)
452 return bb
->loop_father
? loop_depth (bb
->loop_father
) : 0;
455 /* Returns the immediate superloop of LOOP, or NULL if LOOP is the outermost
458 static inline struct loop
*
459 loop_outer (const struct loop
*loop
)
461 unsigned n
= VEC_length (loop_p
, loop
->superloops
);
466 return VEC_index (loop_p
, loop
->superloops
, n
- 1);
469 /* Returns true if LOOP has at least one exit edge. */
472 loop_has_exit_edges (const struct loop
*loop
)
474 return loop
->exits
->next
->e
!= NULL
;
477 /* Returns the list of loops in current_loops. */
479 static inline VEC (loop_p
, gc
) *
485 return current_loops
->larray
;
488 /* Returns the number of loops in current_loops (including the removed
489 ones and the fake loop that forms the root of the loop tree). */
491 static inline unsigned
492 number_of_loops (void)
497 return VEC_length (loop_p
, current_loops
->larray
);
500 /* Returns true if state of the loops satisfies all properties
501 described by FLAGS. */
504 loops_state_satisfies_p (unsigned flags
)
506 return (current_loops
->state
& flags
) == flags
;
509 /* Sets FLAGS to the loops state. */
512 loops_state_set (unsigned flags
)
514 current_loops
->state
|= flags
;
517 /* Clears FLAGS from the loops state. */
520 loops_state_clear (unsigned flags
)
524 current_loops
->state
&= ~flags
;
527 /* Loop iterators. */
529 /* Flags for loop iteration. */
533 LI_INCLUDE_ROOT
= 1, /* Include the fake root of the loop tree. */
534 LI_FROM_INNERMOST
= 2, /* Iterate over the loops in the reverse order,
535 starting from innermost ones. */
536 LI_ONLY_INNERMOST
= 4 /* Iterate only over innermost loops. */
539 /* The iterator for loops. */
543 /* The list of loops to visit. */
544 VEC(int,heap
) *to_visit
;
546 /* The index of the actual loop. */
551 fel_next (loop_iterator
*li
, loop_p
*loop
)
555 while (VEC_iterate (int, li
->to_visit
, li
->idx
, anum
))
558 *loop
= get_loop (anum
);
563 VEC_free (int, heap
, li
->to_visit
);
568 fel_init (loop_iterator
*li
, loop_p
*loop
, unsigned flags
)
582 li
->to_visit
= VEC_alloc (int, heap
, number_of_loops ());
583 mn
= (flags
& LI_INCLUDE_ROOT
) ? 0 : 1;
585 if (flags
& LI_ONLY_INNERMOST
)
587 for (i
= 0; VEC_iterate (loop_p
, current_loops
->larray
, i
, aloop
); i
++)
589 && aloop
->inner
== NULL
591 VEC_quick_push (int, li
->to_visit
, aloop
->num
);
593 else if (flags
& LI_FROM_INNERMOST
)
595 /* Push the loops to LI->TO_VISIT in postorder. */
596 for (aloop
= current_loops
->tree_root
;
597 aloop
->inner
!= NULL
;
598 aloop
= aloop
->inner
)
603 if (aloop
->num
>= mn
)
604 VEC_quick_push (int, li
->to_visit
, aloop
->num
);
608 for (aloop
= aloop
->next
;
609 aloop
->inner
!= NULL
;
610 aloop
= aloop
->inner
)
613 else if (!loop_outer (aloop
))
616 aloop
= loop_outer (aloop
);
621 /* Push the loops to LI->TO_VISIT in preorder. */
622 aloop
= current_loops
->tree_root
;
625 if (aloop
->num
>= mn
)
626 VEC_quick_push (int, li
->to_visit
, aloop
->num
);
628 if (aloop
->inner
!= NULL
)
629 aloop
= aloop
->inner
;
632 while (aloop
!= NULL
&& aloop
->next
== NULL
)
633 aloop
= loop_outer (aloop
);
644 #define FOR_EACH_LOOP(LI, LOOP, FLAGS) \
645 for (fel_init (&(LI), &(LOOP), FLAGS); \
647 fel_next (&(LI), &(LOOP)))
649 #define FOR_EACH_LOOP_BREAK(LI) \
651 VEC_free (int, heap, (LI).to_visit); \
655 /* The properties of the target. */
656 struct target_cfgloop
{
657 /* Number of available registers. */
658 unsigned x_target_avail_regs
;
660 /* Number of available registers that are call-clobbered. */
661 unsigned x_target_clobbered_regs
;
663 /* Number of registers reserved for temporary expressions. */
664 unsigned x_target_res_regs
;
666 /* The cost for register when there still is some reserve, but we are
667 approaching the number of available registers. */
668 unsigned x_target_reg_cost
[2];
670 /* The cost for register when we need to spill. */
671 unsigned x_target_spill_cost
[2];
674 extern struct target_cfgloop default_target_cfgloop
;
675 #if SWITCHABLE_TARGET
676 extern struct target_cfgloop
*this_target_cfgloop
;
678 #define this_target_cfgloop (&default_target_cfgloop)
681 #define target_avail_regs \
682 (this_target_cfgloop->x_target_avail_regs)
683 #define target_clobbered_regs \
684 (this_target_cfgloop->x_target_clobbered_regs)
685 #define target_res_regs \
686 (this_target_cfgloop->x_target_res_regs)
687 #define target_reg_cost \
688 (this_target_cfgloop->x_target_reg_cost)
689 #define target_spill_cost \
690 (this_target_cfgloop->x_target_spill_cost)
692 /* Register pressure estimation for induction variable optimizations & loop
694 extern unsigned estimate_reg_pressure_cost (unsigned, unsigned, bool, bool);
695 extern void init_set_costs (void);
697 /* Loop optimizer initialization. */
698 extern void loop_optimizer_init (unsigned);
699 extern void loop_optimizer_finalize (void);
701 /* Optimization passes. */
702 extern void unswitch_loops (void);
706 UAP_PEEL
= 1, /* Enables loop peeling. */
707 UAP_UNROLL
= 2, /* Enables unrolling of loops if it seems profitable. */
708 UAP_UNROLL_ALL
= 4 /* Enables unrolling of all loops. */
711 extern void unroll_and_peel_loops (int);
712 extern void doloop_optimize_loops (void);
713 extern void move_loop_invariants (void);
714 extern bool finite_loop_p (struct loop
*);
715 extern void scale_loop_profile (struct loop
*loop
, int scale
, int iteration_bound
);
717 /* Returns the outermost loop of the loop nest that contains LOOP.*/
718 static inline struct loop
*
719 loop_outermost (struct loop
*loop
)
722 unsigned n
= VEC_length (loop_p
, loop
->superloops
);
727 return VEC_index (loop_p
, loop
->superloops
, 1);
731 #endif /* GCC_CFGLOOP_H */