1 /* Loop optimizer initialization routines and RTL loop optimization passes.
2 Copyright (C) 2002-2014 Free Software Foundation, Inc.
4 This file is part of GCC.
6 GCC is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 3, or (at your option) any later
11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 You should have received a copy of the GNU General Public License
17 along with GCC; see the file COPYING3. If not see
18 <http://www.gnu.org/licenses/>. */
22 #include "coretypes.h"
28 #include "basic-block.h"
30 #include "tree-pass.h"
34 #include "tree-ssa-loop-niter.h"
37 /* Apply FLAGS to the loop state. */
40 apply_loop_flags (unsigned flags
)
42 if (flags
& LOOPS_MAY_HAVE_MULTIPLE_LATCHES
)
44 /* If the loops may have multiple latches, we cannot canonicalize
45 them further (and most of the loop manipulation functions will
46 not work). However, we avoid modifying cfg, which some
48 gcc_assert ((flags
& ~(LOOPS_MAY_HAVE_MULTIPLE_LATCHES
49 | LOOPS_HAVE_RECORDED_EXITS
)) == 0);
50 loops_state_set (LOOPS_MAY_HAVE_MULTIPLE_LATCHES
);
53 disambiguate_loops_with_multiple_latches ();
55 /* Create pre-headers. */
56 if (flags
& LOOPS_HAVE_PREHEADERS
)
58 int cp_flags
= CP_SIMPLE_PREHEADERS
;
60 if (flags
& LOOPS_HAVE_FALLTHRU_PREHEADERS
)
61 cp_flags
|= CP_FALLTHRU_PREHEADERS
;
63 create_preheaders (cp_flags
);
66 /* Force all latches to have only single successor. */
67 if (flags
& LOOPS_HAVE_SIMPLE_LATCHES
)
68 force_single_succ_latches ();
70 /* Mark irreducible loops. */
71 if (flags
& LOOPS_HAVE_MARKED_IRREDUCIBLE_REGIONS
)
72 mark_irreducible_loops ();
74 if (flags
& LOOPS_HAVE_RECORDED_EXITS
)
78 /* Initialize loop structures. This is used by the tree and RTL loop
79 optimizers. FLAGS specify what properties to compute and/or ensure for
83 loop_optimizer_init (unsigned flags
)
85 timevar_push (TV_LOOP_INIT
);
89 gcc_assert (!(cfun
->curr_properties
& PROP_loops
));
92 current_loops
= flow_loops_find (NULL
);
96 bool recorded_exits
= loops_state_satisfies_p (LOOPS_HAVE_RECORDED_EXITS
);
97 bool needs_fixup
= loops_state_satisfies_p (LOOPS_NEED_FIXUP
);
99 gcc_assert (cfun
->curr_properties
& PROP_loops
);
101 /* Ensure that the dominators are computed, like flow_loops_find does. */
102 calculate_dominance_info (CDI_DOMINATORS
);
104 #ifdef ENABLE_CHECKING
106 verify_loop_structure ();
109 /* Clear all flags. */
111 release_recorded_exits ();
112 loops_state_clear (~0U);
116 /* Apply LOOPS_MAY_HAVE_MULTIPLE_LATCHES early as fix_loop_structure
118 loops_state_set (flags
& LOOPS_MAY_HAVE_MULTIPLE_LATCHES
);
119 fix_loop_structure (NULL
);
123 /* Apply flags to loops. */
124 apply_loop_flags (flags
);
127 flow_loops_dump (dump_file
, NULL
, 1);
129 #ifdef ENABLE_CHECKING
130 verify_loop_structure ();
133 timevar_pop (TV_LOOP_INIT
);
136 /* Finalize loop structures. */
139 loop_optimizer_finalize (void)
144 timevar_push (TV_LOOP_FINI
);
146 if (loops_state_satisfies_p (LOOPS_HAVE_RECORDED_EXITS
))
147 release_recorded_exits ();
149 free_numbers_of_iterations_estimates ();
151 /* If we should preserve loop structure, do not free it but clear
152 flags that advanced properties are there as we are not preserving
154 if (cfun
->curr_properties
& PROP_loops
)
156 loops_state_clear (LOOP_CLOSED_SSA
157 | LOOPS_HAVE_MARKED_IRREDUCIBLE_REGIONS
158 | LOOPS_HAVE_PREHEADERS
159 | LOOPS_HAVE_SIMPLE_LATCHES
160 | LOOPS_HAVE_FALLTHRU_PREHEADERS
);
161 loops_state_set (LOOPS_MAY_HAVE_MULTIPLE_LATCHES
);
165 gcc_assert (current_loops
!= NULL
);
167 FOR_EACH_LOOP (loop
, 0)
168 free_simple_loop_desc (loop
);
171 flow_loops_free (current_loops
);
172 ggc_free (current_loops
);
173 current_loops
= NULL
;
175 FOR_ALL_BB_FN (bb
, cfun
)
177 bb
->loop_father
= NULL
;
181 timevar_pop (TV_LOOP_FINI
);
184 /* The structure of loops might have changed. Some loops might get removed
185 (and their headers and latches were set to NULL), loop exists might get
186 removed (thus the loop nesting may be wrong), and some blocks and edges
187 were changed (so the information about bb --> loop mapping does not have
188 to be correct). But still for the remaining loops the header dominates
189 the latch, and loops did not get new subloops (new loops might possibly
190 get created, but we are not interested in them). Fix up the mess.
192 If CHANGED_BBS is not NULL, basic blocks whose loop depth has changed are
195 Returns the number of new discovered loops. */
198 fix_loop_structure (bitmap changed_bbs
)
201 int record_exits
= 0;
203 unsigned old_nloops
, i
;
205 timevar_push (TV_LOOP_INIT
);
207 /* We need exact and fast dominance info to be available. */
208 gcc_assert (dom_info_state (CDI_DOMINATORS
) == DOM_OK
);
210 if (loops_state_satisfies_p (LOOPS_HAVE_RECORDED_EXITS
))
212 release_recorded_exits ();
213 record_exits
= LOOPS_HAVE_RECORDED_EXITS
;
216 /* Remember the depth of the blocks in the loop hierarchy, so that we can
217 recognize blocks whose loop nesting relationship has changed. */
219 FOR_EACH_BB_FN (bb
, cfun
)
220 bb
->aux
= (void *) (size_t) loop_depth (bb
->loop_father
);
222 /* Remove the dead loops from structures. We start from the innermost
223 loops, so that when we remove the loops, we know that the loops inside
224 are preserved, and do not waste time relinking loops that will be
226 FOR_EACH_LOOP (loop
, LI_FROM_INNERMOST
)
228 /* Detect the case that the loop is no longer present even though
229 it wasn't marked for removal.
230 ??? If we do that we can get away with not marking loops for
231 removal at all. And possibly avoid some spurious removals. */
233 && bb_loop_header_p (loop
->header
))
236 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
237 fprintf (dump_file
, "fix_loop_structure: removing loop %d\n",
242 struct loop
*ploop
= loop
->inner
;
243 flow_loop_tree_node_remove (ploop
);
244 flow_loop_tree_node_add (loop_outer (loop
), ploop
);
247 /* Remove the loop. */
249 flow_loop_tree_node_remove (loop
);
252 /* Remember the number of loops so we can return how many new loops
253 flow_loops_find discovered. */
254 old_nloops
= number_of_loops (cfun
);
256 /* Re-compute loop structure in-place. */
257 flow_loops_find (current_loops
);
259 /* Mark the blocks whose loop has changed. */
262 FOR_EACH_BB_FN (bb
, cfun
)
264 if ((void *) (size_t) loop_depth (bb
->loop_father
) != bb
->aux
)
265 bitmap_set_bit (changed_bbs
, bb
->index
);
271 /* Finally free deleted loops. */
272 FOR_EACH_VEC_ELT (*get_loops (cfun
), i
, loop
)
273 if (loop
&& loop
->header
== NULL
)
275 (*get_loops (cfun
))[i
] = NULL
;
276 flow_loop_free (loop
);
279 loops_state_clear (LOOPS_NEED_FIXUP
);
281 /* Apply flags to loops. */
282 apply_loop_flags (current_loops
->state
| record_exits
);
284 #ifdef ENABLE_CHECKING
285 verify_loop_structure ();
288 timevar_pop (TV_LOOP_INIT
);
290 return number_of_loops (cfun
) - old_nloops
;
293 /* Gate for the RTL loop superpass. The actual passes are subpasses.
294 See passes.c for more on that. */
297 gate_handle_loop2 (void)
300 && (flag_move_loop_invariants
301 || flag_unswitch_loops
304 #ifdef HAVE_doloop_end
305 || (flag_branch_on_count_reg
&& HAVE_doloop_end
)
311 /* No longer preserve loops, remove them now. */
312 cfun
->curr_properties
&= ~PROP_loops
;
314 loop_optimizer_finalize ();
321 const pass_data pass_data_loop2
=
325 OPTGROUP_LOOP
, /* optinfo_flags */
327 false, /* has_execute */
329 0, /* properties_required */
330 0, /* properties_provided */
331 0, /* properties_destroyed */
332 0, /* todo_flags_start */
333 0, /* todo_flags_finish */
336 class pass_loop2
: public rtl_opt_pass
339 pass_loop2 (gcc::context
*ctxt
)
340 : rtl_opt_pass (pass_data_loop2
, ctxt
)
343 /* opt_pass methods: */
344 bool gate () { return gate_handle_loop2 (); }
346 }; // class pass_loop2
351 make_pass_loop2 (gcc::context
*ctxt
)
353 return new pass_loop2 (ctxt
);
357 /* Initialization of the RTL loop passes. */
361 gcc_assert (current_ir_type () == IR_RTL_CFGLAYOUT
);
365 dump_reg_info (dump_file
);
366 dump_flow_info (dump_file
, dump_flags
);
369 loop_optimizer_init (LOOPS_NORMAL
);
375 const pass_data pass_data_rtl_loop_init
=
378 "loop2_init", /* name */
379 OPTGROUP_LOOP
, /* optinfo_flags */
380 false, /* has_gate */
381 true, /* has_execute */
383 0, /* properties_required */
384 0, /* properties_provided */
385 0, /* properties_destroyed */
386 0, /* todo_flags_start */
387 TODO_verify_rtl_sharing
, /* todo_flags_finish */
390 class pass_rtl_loop_init
: public rtl_opt_pass
393 pass_rtl_loop_init (gcc::context
*ctxt
)
394 : rtl_opt_pass (pass_data_rtl_loop_init
, ctxt
)
397 /* opt_pass methods: */
398 unsigned int execute () { return rtl_loop_init (); }
400 }; // class pass_rtl_loop_init
405 make_pass_rtl_loop_init (gcc::context
*ctxt
)
407 return new pass_rtl_loop_init (ctxt
);
411 /* Finalization of the RTL loop passes. */
416 /* No longer preserve loops, remove them now. */
417 cfun
->curr_properties
&= ~PROP_loops
;
418 loop_optimizer_finalize ();
419 free_dominance_info (CDI_DOMINATORS
);
424 dump_reg_info (dump_file
);
425 dump_flow_info (dump_file
, dump_flags
);
433 const pass_data pass_data_rtl_loop_done
=
436 "loop2_done", /* name */
437 OPTGROUP_LOOP
, /* optinfo_flags */
438 false, /* has_gate */
439 true, /* has_execute */
441 0, /* properties_required */
442 0, /* properties_provided */
443 PROP_loops
, /* properties_destroyed */
444 0, /* todo_flags_start */
445 ( TODO_verify_flow
| TODO_verify_rtl_sharing
), /* todo_flags_finish */
448 class pass_rtl_loop_done
: public rtl_opt_pass
451 pass_rtl_loop_done (gcc::context
*ctxt
)
452 : rtl_opt_pass (pass_data_rtl_loop_done
, ctxt
)
455 /* opt_pass methods: */
456 unsigned int execute () { return rtl_loop_done (); }
458 }; // class pass_rtl_loop_done
463 make_pass_rtl_loop_done (gcc::context
*ctxt
)
465 return new pass_rtl_loop_done (ctxt
);
469 /* Loop invariant code motion. */
471 gate_rtl_move_loop_invariants (void)
473 return flag_move_loop_invariants
;
477 rtl_move_loop_invariants (void)
479 if (number_of_loops (cfun
) > 1)
480 move_loop_invariants ();
486 const pass_data pass_data_rtl_move_loop_invariants
=
489 "loop2_invariant", /* name */
490 OPTGROUP_LOOP
, /* optinfo_flags */
492 true, /* has_execute */
493 TV_LOOP_MOVE_INVARIANTS
, /* tv_id */
494 0, /* properties_required */
495 0, /* properties_provided */
496 0, /* properties_destroyed */
497 0, /* todo_flags_start */
498 ( TODO_df_verify
| TODO_df_finish
499 | TODO_verify_rtl_sharing
), /* todo_flags_finish */
502 class pass_rtl_move_loop_invariants
: public rtl_opt_pass
505 pass_rtl_move_loop_invariants (gcc::context
*ctxt
)
506 : rtl_opt_pass (pass_data_rtl_move_loop_invariants
, ctxt
)
509 /* opt_pass methods: */
510 bool gate () { return gate_rtl_move_loop_invariants (); }
511 unsigned int execute () { return rtl_move_loop_invariants (); }
513 }; // class pass_rtl_move_loop_invariants
518 make_pass_rtl_move_loop_invariants (gcc::context
*ctxt
)
520 return new pass_rtl_move_loop_invariants (ctxt
);
524 /* Loop unswitching for RTL. */
526 gate_rtl_unswitch (void)
528 return flag_unswitch_loops
;
534 if (number_of_loops (cfun
) > 1)
541 const pass_data pass_data_rtl_unswitch
=
544 "loop2_unswitch", /* name */
545 OPTGROUP_LOOP
, /* optinfo_flags */
547 true, /* has_execute */
548 TV_LOOP_UNSWITCH
, /* tv_id */
549 0, /* properties_required */
550 0, /* properties_provided */
551 0, /* properties_destroyed */
552 0, /* todo_flags_start */
553 TODO_verify_rtl_sharing
, /* todo_flags_finish */
556 class pass_rtl_unswitch
: public rtl_opt_pass
559 pass_rtl_unswitch (gcc::context
*ctxt
)
560 : rtl_opt_pass (pass_data_rtl_unswitch
, ctxt
)
563 /* opt_pass methods: */
564 bool gate () { return gate_rtl_unswitch (); }
565 unsigned int execute () { return rtl_unswitch (); }
567 }; // class pass_rtl_unswitch
572 make_pass_rtl_unswitch (gcc::context
*ctxt
)
574 return new pass_rtl_unswitch (ctxt
);
578 /* Loop unswitching for RTL. */
580 gate_rtl_unroll_and_peel_loops (void)
582 return (flag_peel_loops
|| flag_unroll_loops
|| flag_unroll_all_loops
);
586 rtl_unroll_and_peel_loops (void)
588 if (number_of_loops (cfun
) > 1)
596 if (flag_unroll_loops
)
598 if (flag_unroll_all_loops
)
599 flags
|= UAP_UNROLL_ALL
;
601 unroll_and_peel_loops (flags
);
608 const pass_data pass_data_rtl_unroll_and_peel_loops
=
611 "loop2_unroll", /* name */
612 OPTGROUP_LOOP
, /* optinfo_flags */
614 true, /* has_execute */
615 TV_LOOP_UNROLL
, /* tv_id */
616 0, /* properties_required */
617 0, /* properties_provided */
618 0, /* properties_destroyed */
619 0, /* todo_flags_start */
620 TODO_verify_rtl_sharing
, /* todo_flags_finish */
623 class pass_rtl_unroll_and_peel_loops
: public rtl_opt_pass
626 pass_rtl_unroll_and_peel_loops (gcc::context
*ctxt
)
627 : rtl_opt_pass (pass_data_rtl_unroll_and_peel_loops
, ctxt
)
630 /* opt_pass methods: */
631 bool gate () { return gate_rtl_unroll_and_peel_loops (); }
632 unsigned int execute () { return rtl_unroll_and_peel_loops (); }
634 }; // class pass_rtl_unroll_and_peel_loops
639 make_pass_rtl_unroll_and_peel_loops (gcc::context
*ctxt
)
641 return new pass_rtl_unroll_and_peel_loops (ctxt
);
645 /* The doloop optimization. */
647 gate_rtl_doloop (void)
649 #ifdef HAVE_doloop_end
650 return (flag_branch_on_count_reg
&& HAVE_doloop_end
);
659 #ifdef HAVE_doloop_end
660 if (number_of_loops (cfun
) > 1)
661 doloop_optimize_loops ();
668 const pass_data pass_data_rtl_doloop
=
671 "loop2_doloop", /* name */
672 OPTGROUP_LOOP
, /* optinfo_flags */
674 true, /* has_execute */
675 TV_LOOP_DOLOOP
, /* tv_id */
676 0, /* properties_required */
677 0, /* properties_provided */
678 0, /* properties_destroyed */
679 0, /* todo_flags_start */
680 TODO_verify_rtl_sharing
, /* todo_flags_finish */
683 class pass_rtl_doloop
: public rtl_opt_pass
686 pass_rtl_doloop (gcc::context
*ctxt
)
687 : rtl_opt_pass (pass_data_rtl_doloop
, ctxt
)
690 /* opt_pass methods: */
691 bool gate () { return gate_rtl_doloop (); }
692 unsigned int execute () { return rtl_doloop (); }
694 }; // class pass_rtl_doloop
699 make_pass_rtl_doloop (gcc::context
*ctxt
)
701 return new pass_rtl_doloop (ctxt
);