1 /* CFG cleanup for trees.
2 Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007
3 Free Software Foundation, Inc.
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3, or (at your option)
12 GCC is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License 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/>. */
23 #include "coretypes.h"
28 #include "hard-reg-set.h"
29 #include "basic-block.h"
36 #include "langhooks.h"
37 #include "diagnostic.h"
38 #include "tree-flow.h"
40 #include "tree-dump.h"
41 #include "tree-pass.h"
45 #include "cfglayout.h"
47 #include "tree-ssa-propagate.h"
48 #include "tree-scalar-evolution.h"
50 /* Remove any fallthru edge from EV. Return true if an edge was removed. */
53 remove_fallthru_edge (VEC(edge
,gc
) *ev
)
58 FOR_EACH_EDGE (e
, ei
, ev
)
59 if ((e
->flags
& EDGE_FALLTHRU
) != 0)
67 /* Disconnect an unreachable block in the control expression starting
71 cleanup_control_expr_graph (basic_block bb
, block_stmt_iterator bsi
)
75 tree expr
= bsi_stmt (bsi
), val
;
77 if (!single_succ_p (bb
))
83 fold_defer_overflow_warnings ();
85 switch (TREE_CODE (expr
))
88 val
= fold (COND_EXPR_COND (expr
));
92 val
= fold (SWITCH_COND (expr
));
93 if (TREE_CODE (val
) != INTEGER_CST
)
95 fold_undefer_and_ignore_overflow_warnings ();
104 taken_edge
= find_taken_edge (bb
, val
);
107 fold_undefer_and_ignore_overflow_warnings ();
111 /* Remove all the edges except the one that is always executed. */
113 for (ei
= ei_start (bb
->succs
); (e
= ei_safe_edge (ei
)); )
119 fold_undefer_overflow_warnings
120 (true, expr
, WARN_STRICT_OVERFLOW_CONDITIONAL
);
124 taken_edge
->probability
+= e
->probability
;
125 taken_edge
->count
+= e
->count
;
133 fold_undefer_and_ignore_overflow_warnings ();
134 if (taken_edge
->probability
> REG_BR_PROB_BASE
)
135 taken_edge
->probability
= REG_BR_PROB_BASE
;
138 taken_edge
= single_succ_edge (bb
);
140 bsi_remove (&bsi
, true);
141 taken_edge
->flags
= EDGE_FALLTHRU
;
143 /* We removed some paths from the cfg. */
144 free_dominance_info (CDI_DOMINATORS
);
149 /* A list of all the noreturn calls passed to modify_stmt.
150 cleanup_control_flow uses it to detect cases where a mid-block
151 indirect call has been turned into a noreturn call. When this
152 happens, all the instructions after the call are no longer
153 reachable and must be deleted as dead. */
155 VEC(tree
,gc
) *modified_noreturn_calls
;
157 /* Try to remove superfluous control structures. */
160 cleanup_control_flow (void)
163 block_stmt_iterator bsi
;
167 /* Detect cases where a mid-block call is now known not to return. */
168 while (VEC_length (tree
, modified_noreturn_calls
))
170 stmt
= VEC_pop (tree
, modified_noreturn_calls
);
171 bb
= bb_for_stmt (stmt
);
172 if (bb
!= NULL
&& last_stmt (bb
) != stmt
&& noreturn_call_p (stmt
))
173 split_block (bb
, stmt
);
180 /* If the last statement of the block could throw and now cannot,
181 we need to prune cfg. */
182 retval
|= tree_purge_dead_eh_edges (bb
);
187 stmt
= bsi_stmt (bsi
);
189 if (TREE_CODE (stmt
) == COND_EXPR
190 || TREE_CODE (stmt
) == SWITCH_EXPR
)
191 retval
|= cleanup_control_expr_graph (bb
, bsi
);
192 /* If we had a computed goto which has a compile-time determinable
193 destination, then we can eliminate the goto. */
194 else if (TREE_CODE (stmt
) == GOTO_EXPR
195 && TREE_CODE (GOTO_DESTINATION (stmt
)) == ADDR_EXPR
196 && (TREE_CODE (TREE_OPERAND (GOTO_DESTINATION (stmt
), 0))
202 basic_block target_block
;
203 bool removed_edge
= false;
205 /* First look at all the outgoing edges. Delete any outgoing
206 edges which do not go to the right block. For the one
207 edge which goes to the right block, fix up its flags. */
208 label
= TREE_OPERAND (GOTO_DESTINATION (stmt
), 0);
209 target_block
= label_to_block (label
);
210 for (ei
= ei_start (bb
->succs
); (e
= ei_safe_edge (ei
)); )
212 if (e
->dest
!= target_block
)
219 /* Turn off the EDGE_ABNORMAL flag. */
220 e
->flags
&= ~EDGE_ABNORMAL
;
222 /* And set EDGE_FALLTHRU. */
223 e
->flags
|= EDGE_FALLTHRU
;
228 /* If we removed one or more edges, then we will need to fix the
229 dominators. It may be possible to incrementally update them. */
231 free_dominance_info (CDI_DOMINATORS
);
233 /* Remove the GOTO_EXPR as it is not needed. The CFG has all the
234 relevant information we need. */
235 bsi_remove (&bsi
, true);
239 /* Check for indirect calls that have been turned into
241 else if (noreturn_call_p (stmt
) && remove_fallthru_edge (bb
->succs
))
243 free_dominance_info (CDI_DOMINATORS
);
250 /* Return true if basic block BB does nothing except pass control
251 flow to another block and that we can safely insert a label at
252 the start of the successor block.
254 As a precondition, we require that BB be not equal to
258 tree_forwarder_block_p (basic_block bb
, bool phi_wanted
)
260 block_stmt_iterator bsi
;
265 /* BB must have a single outgoing edge. */
266 if (single_succ_p (bb
) != 1
267 /* If PHI_WANTED is false, BB must not have any PHI nodes.
268 Otherwise, BB must have PHI nodes. */
269 || (phi_nodes (bb
) != NULL_TREE
) != phi_wanted
270 /* BB may not be a predecessor of EXIT_BLOCK_PTR. */
271 || single_succ (bb
) == EXIT_BLOCK_PTR
272 /* Nor should this be an infinite loop. */
273 || single_succ (bb
) == bb
274 /* BB may not have an abnormal outgoing edge. */
275 || (single_succ_edge (bb
)->flags
& EDGE_ABNORMAL
))
279 gcc_assert (bb
!= ENTRY_BLOCK_PTR
);
282 /* Now walk through the statements backward. We can ignore labels,
283 anything else means this is not a forwarder block. */
284 for (bsi
= bsi_last (bb
); !bsi_end_p (bsi
); bsi_prev (&bsi
))
286 tree stmt
= bsi_stmt (bsi
);
288 switch (TREE_CODE (stmt
))
291 if (DECL_NONLOCAL (LABEL_EXPR_LABEL (stmt
)))
300 if (find_edge (ENTRY_BLOCK_PTR
, bb
))
306 /* Protect loop latches, headers and preheaders. */
307 if (bb
->loop_father
->header
== bb
)
309 dest
= EDGE_SUCC (bb
, 0)->dest
;
311 if (dest
->loop_father
->header
== dest
)
315 /* If we have an EH edge leaving this block, make sure that the
316 destination of this block has only one predecessor. This ensures
317 that we don't get into the situation where we try to remove two
318 forwarders that go to the same basic block but are handlers for
319 different EH regions. */
320 succ
= single_succ_edge (bb
);
322 FOR_EACH_EDGE (e
, ei
, bb
->preds
)
324 if (e
->flags
& EDGE_EH
)
326 if (!single_pred_p (dest
))
334 /* Return true if BB has at least one abnormal incoming edge. */
337 has_abnormal_incoming_edge_p (basic_block bb
)
342 FOR_EACH_EDGE (e
, ei
, bb
->preds
)
343 if (e
->flags
& EDGE_ABNORMAL
)
349 /* If all the PHI nodes in DEST have alternatives for E1 and E2 and
350 those alternatives are equal in each of the PHI nodes, then return
351 true, else return false. */
354 phi_alternatives_equal (basic_block dest
, edge e1
, edge e2
)
356 int n1
= e1
->dest_idx
;
357 int n2
= e2
->dest_idx
;
360 for (phi
= phi_nodes (dest
); phi
; phi
= PHI_CHAIN (phi
))
362 tree val1
= PHI_ARG_DEF (phi
, n1
);
363 tree val2
= PHI_ARG_DEF (phi
, n2
);
365 gcc_assert (val1
!= NULL_TREE
);
366 gcc_assert (val2
!= NULL_TREE
);
368 if (!operand_equal_for_phi_arg_p (val1
, val2
))
375 /* Removes forwarder block BB. Returns false if this failed. If a new
376 forwarder block is created due to redirection of edges, it is
377 stored to worklist. */
380 remove_forwarder_block (basic_block bb
, basic_block
**worklist
)
382 edge succ
= single_succ_edge (bb
), e
, s
;
383 basic_block dest
= succ
->dest
;
387 block_stmt_iterator bsi
, bsi_to
;
388 bool seen_abnormal_edge
= false;
390 /* We check for infinite loops already in tree_forwarder_block_p.
391 However it may happen that the infinite loop is created
392 afterwards due to removal of forwarders. */
396 /* If the destination block consists of a nonlocal label, do not merge
398 label
= first_stmt (dest
);
400 && TREE_CODE (label
) == LABEL_EXPR
401 && DECL_NONLOCAL (LABEL_EXPR_LABEL (label
)))
404 /* If there is an abnormal edge to basic block BB, but not into
405 dest, problems might occur during removal of the phi node at out
406 of ssa due to overlapping live ranges of registers.
408 If there is an abnormal edge in DEST, the problems would occur
409 anyway since cleanup_dead_labels would then merge the labels for
410 two different eh regions, and rest of exception handling code
413 So if there is an abnormal edge to BB, proceed only if there is
414 no abnormal edge to DEST and there are no phi nodes in DEST. */
415 if (has_abnormal_incoming_edge_p (bb
))
417 seen_abnormal_edge
= true;
419 if (has_abnormal_incoming_edge_p (dest
)
420 || phi_nodes (dest
) != NULL_TREE
)
424 /* If there are phi nodes in DEST, and some of the blocks that are
425 predecessors of BB are also predecessors of DEST, check that the
426 phi node arguments match. */
427 if (phi_nodes (dest
))
429 FOR_EACH_EDGE (e
, ei
, bb
->preds
)
431 s
= find_edge (e
->src
, dest
);
435 if (!phi_alternatives_equal (dest
, succ
, s
))
440 /* Redirect the edges. */
441 for (ei
= ei_start (bb
->preds
); (e
= ei_safe_edge (ei
)); )
443 if (e
->flags
& EDGE_ABNORMAL
)
445 /* If there is an abnormal edge, redirect it anyway, and
446 move the labels to the new block to make it legal. */
447 s
= redirect_edge_succ_nodup (e
, dest
);
450 s
= redirect_edge_and_branch (e
, dest
);
454 /* Create arguments for the phi nodes, since the edge was not
456 for (phi
= phi_nodes (dest
); phi
; phi
= PHI_CHAIN (phi
))
457 add_phi_arg (phi
, PHI_ARG_DEF (phi
, succ
->dest_idx
), s
);
461 /* The source basic block might become a forwarder. We know
462 that it was not a forwarder before, since it used to have
463 at least two outgoing edges, so we may just add it to
465 if (tree_forwarder_block_p (s
->src
, false))
466 *(*worklist
)++ = s
->src
;
470 if (seen_abnormal_edge
)
472 /* Move the labels to the new block, so that the redirection of
473 the abnormal edges works. */
475 bsi_to
= bsi_start (dest
);
476 for (bsi
= bsi_start (bb
); !bsi_end_p (bsi
); )
478 label
= bsi_stmt (bsi
);
479 gcc_assert (TREE_CODE (label
) == LABEL_EXPR
);
480 bsi_remove (&bsi
, false);
481 bsi_insert_before (&bsi_to
, label
, BSI_CONTINUE_LINKING
);
485 /* Update the dominators. */
486 if (dom_info_available_p (CDI_DOMINATORS
))
488 basic_block dom
, dombb
, domdest
;
490 dombb
= get_immediate_dominator (CDI_DOMINATORS
, bb
);
491 domdest
= get_immediate_dominator (CDI_DOMINATORS
, dest
);
494 /* Shortcut to avoid calling (relatively expensive)
495 nearest_common_dominator unless necessary. */
499 dom
= nearest_common_dominator (CDI_DOMINATORS
, domdest
, dombb
);
501 set_immediate_dominator (CDI_DOMINATORS
, dest
, dom
);
504 /* And kill the forwarder block. */
505 delete_basic_block (bb
);
510 /* Removes forwarder blocks. */
513 cleanup_forwarder_blocks (void)
516 bool changed
= false;
517 basic_block
*worklist
= XNEWVEC (basic_block
, n_basic_blocks
);
518 basic_block
*current
= worklist
;
522 if (tree_forwarder_block_p (bb
, false))
526 while (current
!= worklist
)
529 changed
|= remove_forwarder_block (bb
, ¤t
);
536 /* Do one round of CFG cleanup. */
539 cleanup_tree_cfg_1 (void)
543 retval
= cleanup_control_flow ();
544 retval
|= delete_unreachable_blocks ();
546 /* Forwarder blocks can carry line number information which is
547 useful when debugging, so we only clean them up when
552 /* cleanup_forwarder_blocks can redirect edges out of
553 SWITCH_EXPRs, which can get expensive. So we want to enable
554 recording of edge to CASE_LABEL_EXPR mappings around the call
555 to cleanup_forwarder_blocks. */
556 start_recording_case_labels ();
557 retval
|= cleanup_forwarder_blocks ();
558 end_recording_case_labels ();
561 /* Merging the blocks may create new opportunities for folding
562 conditional branches (due to the elimination of single-valued PHI
564 retval
|= merge_seq_blocks ();
570 /* Remove unreachable blocks and other miscellaneous clean up work.
571 Return true if the flowgraph was modified, false otherwise. */
574 cleanup_tree_cfg (void)
576 bool retval
, changed
;
578 timevar_push (TV_TREE_CLEANUP_CFG
);
580 /* Iterate until there are no more cleanups left to do. If any
581 iteration changed the flowgraph, set CHANGED to true. */
585 retval
= cleanup_tree_cfg_1 ();
592 #ifdef ENABLE_CHECKING
596 timevar_pop (TV_TREE_CLEANUP_CFG
);
601 /* Cleanup cfg and repair loop structures. */
604 cleanup_tree_cfg_loop (void)
606 bool changed
= cleanup_tree_cfg ();
610 bitmap changed_bbs
= BITMAP_ALLOC (NULL
);
611 fix_loop_structure (current_loops
, changed_bbs
);
612 calculate_dominance_info (CDI_DOMINATORS
);
614 /* This usually does nothing. But sometimes parts of cfg that originally
615 were inside a loop get out of it due to edge removal (since they
616 become unreachable by back edges from latch). */
617 rewrite_into_loop_closed_ssa (changed_bbs
, TODO_update_ssa
);
619 BITMAP_FREE (changed_bbs
);
621 #ifdef ENABLE_CHECKING
622 verify_loop_structure (current_loops
);
628 /* Merge the PHI nodes at BB into those at BB's sole successor. */
631 remove_forwarder_block_with_phi (basic_block bb
)
633 edge succ
= single_succ_edge (bb
);
634 basic_block dest
= succ
->dest
;
636 basic_block dombb
, domdest
, dom
;
638 /* We check for infinite loops already in tree_forwarder_block_p.
639 However it may happen that the infinite loop is created
640 afterwards due to removal of forwarders. */
644 /* If the destination block consists of a nonlocal label, do not
646 label
= first_stmt (dest
);
648 && TREE_CODE (label
) == LABEL_EXPR
649 && DECL_NONLOCAL (LABEL_EXPR_LABEL (label
)))
652 /* Redirect each incoming edge to BB to DEST. */
653 while (EDGE_COUNT (bb
->preds
) > 0)
655 edge e
= EDGE_PRED (bb
, 0), s
;
658 s
= find_edge (e
->src
, dest
);
661 /* We already have an edge S from E->src to DEST. If S and
662 E->dest's sole successor edge have the same PHI arguments
663 at DEST, redirect S to DEST. */
664 if (phi_alternatives_equal (dest
, s
, succ
))
666 e
= redirect_edge_and_branch (e
, dest
);
667 PENDING_STMT (e
) = NULL_TREE
;
671 /* PHI arguments are different. Create a forwarder block by
672 splitting E so that we can merge PHI arguments on E to
674 e
= single_succ_edge (split_edge (e
));
677 s
= redirect_edge_and_branch (e
, dest
);
679 /* redirect_edge_and_branch must not create a new edge. */
682 /* Add to the PHI nodes at DEST each PHI argument removed at the
684 for (phi
= phi_nodes (dest
); phi
; phi
= PHI_CHAIN (phi
))
686 tree def
= PHI_ARG_DEF (phi
, succ
->dest_idx
);
688 if (TREE_CODE (def
) == SSA_NAME
)
692 /* If DEF is one of the results of PHI nodes removed during
693 redirection, replace it with the PHI argument that used
695 for (var
= PENDING_STMT (e
); var
; var
= TREE_CHAIN (var
))
697 tree old_arg
= TREE_PURPOSE (var
);
698 tree new_arg
= TREE_VALUE (var
);
708 add_phi_arg (phi
, def
, s
);
711 PENDING_STMT (e
) = NULL
;
714 /* Update the dominators. */
715 dombb
= get_immediate_dominator (CDI_DOMINATORS
, bb
);
716 domdest
= get_immediate_dominator (CDI_DOMINATORS
, dest
);
719 /* Shortcut to avoid calling (relatively expensive)
720 nearest_common_dominator unless necessary. */
724 dom
= nearest_common_dominator (CDI_DOMINATORS
, domdest
, dombb
);
726 set_immediate_dominator (CDI_DOMINATORS
, dest
, dom
);
728 /* Remove BB since all of BB's incoming edges have been redirected
730 delete_basic_block (bb
);
733 /* This pass merges PHI nodes if one feeds into another. For example,
734 suppose we have the following:
741 # tem_6 = PHI <tem_17(8), tem_23(7)>;
744 # tem_3 = PHI <tem_6(9), tem_2(5)>;
747 Then we merge the first PHI node into the second one like so:
754 # tem_3 = PHI <tem_23(7), tem_2(5), tem_17(8)>;
759 merge_phi_nodes (void)
761 basic_block
*worklist
= XNEWVEC (basic_block
, n_basic_blocks
);
762 basic_block
*current
= worklist
;
765 calculate_dominance_info (CDI_DOMINATORS
);
767 /* Find all PHI nodes that we may be able to merge. */
772 /* Look for a forwarder block with PHI nodes. */
773 if (!tree_forwarder_block_p (bb
, true))
776 dest
= single_succ (bb
);
778 /* We have to feed into another basic block with PHI
780 if (!phi_nodes (dest
)
781 /* We don't want to deal with a basic block with
783 || has_abnormal_incoming_edge_p (bb
))
786 if (!dominated_by_p (CDI_DOMINATORS
, dest
, bb
))
788 /* If BB does not dominate DEST, then the PHI nodes at
789 DEST must be the only users of the results of the PHI
796 unsigned int dest_idx
= single_succ_edge (bb
)->dest_idx
;
798 /* BB dominates DEST. There may be many users of the PHI
799 nodes in BB. However, there is still a trivial case we
800 can handle. If the result of every PHI in BB is used
801 only by a PHI in DEST, then we can trivially merge the
802 PHI nodes from BB into DEST. */
803 for (phi
= phi_nodes (bb
); phi
; phi
= PHI_CHAIN (phi
))
805 tree result
= PHI_RESULT (phi
);
806 use_operand_p imm_use
;
809 /* If the PHI's result is never used, then we can just
811 if (has_zero_uses (result
))
814 /* Get the single use of the result of this PHI node. */
815 if (!single_imm_use (result
, &imm_use
, &use_stmt
)
816 || TREE_CODE (use_stmt
) != PHI_NODE
817 || bb_for_stmt (use_stmt
) != dest
818 || PHI_ARG_DEF (use_stmt
, dest_idx
) != result
)
822 /* If the loop above iterated through all the PHI nodes
823 in BB, then we can merge the PHIs from BB into DEST. */
829 /* Now let's drain WORKLIST. */
830 while (current
!= worklist
)
833 remove_forwarder_block_with_phi (bb
);
841 gate_merge_phi (void)
846 struct tree_opt_pass pass_merge_phi
= {
847 "mergephi", /* name */
848 gate_merge_phi
, /* gate */
849 merge_phi_nodes
, /* execute */
852 0, /* static_pass_number */
853 TV_TREE_MERGE_PHI
, /* tv_id */
854 PROP_cfg
| PROP_ssa
, /* properties_required */
855 0, /* properties_provided */
856 0, /* properties_destroyed */
857 0, /* todo_flags_start */
858 TODO_dump_func
| TODO_ggc_collect
/* todo_flags_finish */