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 2, 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 COPYING. If not, write to
19 the Free Software Foundation, 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
24 #include "coretypes.h"
29 #include "hard-reg-set.h"
30 #include "basic-block.h"
37 #include "langhooks.h"
38 #include "diagnostic.h"
39 #include "tree-flow.h"
41 #include "tree-dump.h"
42 #include "tree-pass.h"
46 #include "cfglayout.h"
48 #include "tree-ssa-propagate.h"
49 #include "tree-scalar-evolution.h"
51 /* Remove any fallthru edge from EV. Return true if an edge was removed. */
54 remove_fallthru_edge (VEC(edge
,gc
) *ev
)
59 FOR_EACH_EDGE (e
, ei
, ev
)
60 if ((e
->flags
& EDGE_FALLTHRU
) != 0)
68 /* Disconnect an unreachable block in the control expression starting
72 cleanup_control_expr_graph (basic_block bb
, block_stmt_iterator bsi
)
76 tree expr
= bsi_stmt (bsi
), val
;
78 if (!single_succ_p (bb
))
84 fold_defer_overflow_warnings ();
86 switch (TREE_CODE (expr
))
89 val
= fold (COND_EXPR_COND (expr
));
93 val
= fold (SWITCH_COND (expr
));
94 if (TREE_CODE (val
) != INTEGER_CST
)
96 fold_undefer_and_ignore_overflow_warnings ();
105 taken_edge
= find_taken_edge (bb
, val
);
108 fold_undefer_and_ignore_overflow_warnings ();
112 /* Remove all the edges except the one that is always executed. */
114 for (ei
= ei_start (bb
->succs
); (e
= ei_safe_edge (ei
)); )
120 fold_undefer_overflow_warnings
121 (true, expr
, WARN_STRICT_OVERFLOW_CONDITIONAL
);
125 taken_edge
->probability
+= e
->probability
;
126 taken_edge
->count
+= e
->count
;
134 fold_undefer_and_ignore_overflow_warnings ();
135 if (taken_edge
->probability
> REG_BR_PROB_BASE
)
136 taken_edge
->probability
= REG_BR_PROB_BASE
;
139 taken_edge
= single_succ_edge (bb
);
141 bsi_remove (&bsi
, true);
142 taken_edge
->flags
= EDGE_FALLTHRU
;
144 /* We removed some paths from the cfg. */
145 free_dominance_info (CDI_DOMINATORS
);
150 /* Try to remove superfluous control structures. */
153 cleanup_control_flow (void)
156 block_stmt_iterator bsi
;
160 /* Detect cases where a mid-block call is now known not to return. */
162 while (VEC_length (tree
, MODIFIED_NORETURN_CALLS (cfun
)))
164 stmt
= VEC_pop (tree
, MODIFIED_NORETURN_CALLS (cfun
));
165 bb
= bb_for_stmt (stmt
);
166 if (bb
!= NULL
&& last_stmt (bb
) != stmt
&& noreturn_call_p (stmt
))
167 split_block (bb
, stmt
);
174 /* If the last statement of the block could throw and now cannot,
175 we need to prune cfg. */
176 retval
|= tree_purge_dead_eh_edges (bb
);
181 stmt
= bsi_stmt (bsi
);
183 if (TREE_CODE (stmt
) == COND_EXPR
184 || TREE_CODE (stmt
) == SWITCH_EXPR
)
185 retval
|= cleanup_control_expr_graph (bb
, bsi
);
186 /* If we had a computed goto which has a compile-time determinable
187 destination, then we can eliminate the goto. */
188 else if (TREE_CODE (stmt
) == GOTO_EXPR
189 && TREE_CODE (GOTO_DESTINATION (stmt
)) == ADDR_EXPR
190 && (TREE_CODE (TREE_OPERAND (GOTO_DESTINATION (stmt
), 0))
196 basic_block target_block
;
197 bool removed_edge
= false;
199 /* First look at all the outgoing edges. Delete any outgoing
200 edges which do not go to the right block. For the one
201 edge which goes to the right block, fix up its flags. */
202 label
= TREE_OPERAND (GOTO_DESTINATION (stmt
), 0);
203 target_block
= label_to_block (label
);
204 for (ei
= ei_start (bb
->succs
); (e
= ei_safe_edge (ei
)); )
206 if (e
->dest
!= target_block
)
213 /* Turn off the EDGE_ABNORMAL flag. */
214 e
->flags
&= ~EDGE_ABNORMAL
;
216 /* And set EDGE_FALLTHRU. */
217 e
->flags
|= EDGE_FALLTHRU
;
222 /* If we removed one or more edges, then we will need to fix the
223 dominators. It may be possible to incrementally update them. */
225 free_dominance_info (CDI_DOMINATORS
);
227 /* Remove the GOTO_EXPR as it is not needed. The CFG has all the
228 relevant information we need. */
229 bsi_remove (&bsi
, true);
233 /* Check for indirect calls that have been turned into
235 else if (noreturn_call_p (stmt
) && remove_fallthru_edge (bb
->succs
))
237 free_dominance_info (CDI_DOMINATORS
);
244 /* Return true if basic block BB does nothing except pass control
245 flow to another block and that we can safely insert a label at
246 the start of the successor block.
248 As a precondition, we require that BB be not equal to
252 tree_forwarder_block_p (basic_block bb
, bool phi_wanted
)
254 block_stmt_iterator bsi
;
259 /* BB must have a single outgoing edge. */
260 if (single_succ_p (bb
) != 1
261 /* If PHI_WANTED is false, BB must not have any PHI nodes.
262 Otherwise, BB must have PHI nodes. */
263 || (phi_nodes (bb
) != NULL_TREE
) != phi_wanted
264 /* BB may not be a predecessor of EXIT_BLOCK_PTR. */
265 || single_succ (bb
) == EXIT_BLOCK_PTR
266 /* Nor should this be an infinite loop. */
267 || single_succ (bb
) == bb
268 /* BB may not have an abnormal outgoing edge. */
269 || (single_succ_edge (bb
)->flags
& EDGE_ABNORMAL
))
273 gcc_assert (bb
!= ENTRY_BLOCK_PTR
);
276 /* Now walk through the statements backward. We can ignore labels,
277 anything else means this is not a forwarder block. */
278 for (bsi
= bsi_last (bb
); !bsi_end_p (bsi
); bsi_prev (&bsi
))
280 tree stmt
= bsi_stmt (bsi
);
282 switch (TREE_CODE (stmt
))
285 if (DECL_NONLOCAL (LABEL_EXPR_LABEL (stmt
)))
294 if (find_edge (ENTRY_BLOCK_PTR
, bb
))
300 /* Protect loop latches, headers and preheaders. */
301 if (bb
->loop_father
->header
== bb
)
303 dest
= EDGE_SUCC (bb
, 0)->dest
;
305 if (dest
->loop_father
->header
== dest
)
309 /* If we have an EH edge leaving this block, make sure that the
310 destination of this block has only one predecessor. This ensures
311 that we don't get into the situation where we try to remove two
312 forwarders that go to the same basic block but are handlers for
313 different EH regions. */
314 succ
= single_succ_edge (bb
);
316 FOR_EACH_EDGE (e
, ei
, bb
->preds
)
318 if (e
->flags
& EDGE_EH
)
320 if (!single_pred_p (dest
))
328 /* Return true if BB has at least one abnormal incoming edge. */
331 has_abnormal_incoming_edge_p (basic_block bb
)
336 FOR_EACH_EDGE (e
, ei
, bb
->preds
)
337 if (e
->flags
& EDGE_ABNORMAL
)
343 /* If all the PHI nodes in DEST have alternatives for E1 and E2 and
344 those alternatives are equal in each of the PHI nodes, then return
345 true, else return false. */
348 phi_alternatives_equal (basic_block dest
, edge e1
, edge e2
)
350 int n1
= e1
->dest_idx
;
351 int n2
= e2
->dest_idx
;
354 for (phi
= phi_nodes (dest
); phi
; phi
= PHI_CHAIN (phi
))
356 tree val1
= PHI_ARG_DEF (phi
, n1
);
357 tree val2
= PHI_ARG_DEF (phi
, n2
);
359 gcc_assert (val1
!= NULL_TREE
);
360 gcc_assert (val2
!= NULL_TREE
);
362 if (!operand_equal_for_phi_arg_p (val1
, val2
))
369 /* Removes forwarder block BB. Returns false if this failed. If a new
370 forwarder block is created due to redirection of edges, it is
371 stored to worklist. */
374 remove_forwarder_block (basic_block bb
, basic_block
**worklist
)
376 edge succ
= single_succ_edge (bb
), e
, s
;
377 basic_block dest
= succ
->dest
;
381 block_stmt_iterator bsi
, bsi_to
;
382 bool seen_abnormal_edge
= false;
384 /* We check for infinite loops already in tree_forwarder_block_p.
385 However it may happen that the infinite loop is created
386 afterwards due to removal of forwarders. */
390 /* If the destination block consists of a nonlocal label, do not merge
392 label
= first_stmt (dest
);
394 && TREE_CODE (label
) == LABEL_EXPR
395 && DECL_NONLOCAL (LABEL_EXPR_LABEL (label
)))
398 /* If there is an abnormal edge to basic block BB, but not into
399 dest, problems might occur during removal of the phi node at out
400 of ssa due to overlapping live ranges of registers.
402 If there is an abnormal edge in DEST, the problems would occur
403 anyway since cleanup_dead_labels would then merge the labels for
404 two different eh regions, and rest of exception handling code
407 So if there is an abnormal edge to BB, proceed only if there is
408 no abnormal edge to DEST and there are no phi nodes in DEST. */
409 if (has_abnormal_incoming_edge_p (bb
))
411 seen_abnormal_edge
= true;
413 if (has_abnormal_incoming_edge_p (dest
)
414 || phi_nodes (dest
) != NULL_TREE
)
418 /* If there are phi nodes in DEST, and some of the blocks that are
419 predecessors of BB are also predecessors of DEST, check that the
420 phi node arguments match. */
421 if (phi_nodes (dest
))
423 FOR_EACH_EDGE (e
, ei
, bb
->preds
)
425 s
= find_edge (e
->src
, dest
);
429 if (!phi_alternatives_equal (dest
, succ
, s
))
434 /* Redirect the edges. */
435 for (ei
= ei_start (bb
->preds
); (e
= ei_safe_edge (ei
)); )
437 if (e
->flags
& EDGE_ABNORMAL
)
439 /* If there is an abnormal edge, redirect it anyway, and
440 move the labels to the new block to make it legal. */
441 s
= redirect_edge_succ_nodup (e
, dest
);
444 s
= redirect_edge_and_branch (e
, dest
);
448 /* Create arguments for the phi nodes, since the edge was not
450 for (phi
= phi_nodes (dest
); phi
; phi
= PHI_CHAIN (phi
))
451 add_phi_arg (phi
, PHI_ARG_DEF (phi
, succ
->dest_idx
), s
);
455 /* The source basic block might become a forwarder. We know
456 that it was not a forwarder before, since it used to have
457 at least two outgoing edges, so we may just add it to
459 if (tree_forwarder_block_p (s
->src
, false))
460 *(*worklist
)++ = s
->src
;
464 if (seen_abnormal_edge
)
466 /* Move the labels to the new block, so that the redirection of
467 the abnormal edges works. */
469 bsi_to
= bsi_start (dest
);
470 for (bsi
= bsi_start (bb
); !bsi_end_p (bsi
); )
472 label
= bsi_stmt (bsi
);
473 gcc_assert (TREE_CODE (label
) == LABEL_EXPR
);
474 bsi_remove (&bsi
, false);
475 bsi_insert_before (&bsi_to
, label
, BSI_CONTINUE_LINKING
);
479 /* Update the dominators. */
480 if (dom_info_available_p (CDI_DOMINATORS
))
482 basic_block dom
, dombb
, domdest
;
484 dombb
= get_immediate_dominator (CDI_DOMINATORS
, bb
);
485 domdest
= get_immediate_dominator (CDI_DOMINATORS
, dest
);
488 /* Shortcut to avoid calling (relatively expensive)
489 nearest_common_dominator unless necessary. */
493 dom
= nearest_common_dominator (CDI_DOMINATORS
, domdest
, dombb
);
495 set_immediate_dominator (CDI_DOMINATORS
, dest
, dom
);
498 /* And kill the forwarder block. */
499 delete_basic_block (bb
);
504 /* Removes forwarder blocks. */
507 cleanup_forwarder_blocks (void)
510 bool changed
= false;
511 basic_block
*worklist
= XNEWVEC (basic_block
, n_basic_blocks
);
512 basic_block
*current
= worklist
;
516 if (tree_forwarder_block_p (bb
, false))
520 while (current
!= worklist
)
523 changed
|= remove_forwarder_block (bb
, ¤t
);
530 /* Do one round of CFG cleanup. */
533 cleanup_tree_cfg_1 (void)
537 retval
= cleanup_control_flow ();
538 retval
|= delete_unreachable_blocks ();
540 /* Forwarder blocks can carry line number information which is
541 useful when debugging, so we only clean them up when
546 /* cleanup_forwarder_blocks can redirect edges out of
547 SWITCH_EXPRs, which can get expensive. So we want to enable
548 recording of edge to CASE_LABEL_EXPR mappings around the call
549 to cleanup_forwarder_blocks. */
550 start_recording_case_labels ();
551 retval
|= cleanup_forwarder_blocks ();
552 end_recording_case_labels ();
555 /* Merging the blocks may create new opportunities for folding
556 conditional branches (due to the elimination of single-valued PHI
558 retval
|= merge_seq_blocks ();
564 /* Remove unreachable blocks and other miscellaneous clean up work.
565 Return true if the flowgraph was modified, false otherwise. */
568 cleanup_tree_cfg (void)
570 bool retval
, changed
;
572 timevar_push (TV_TREE_CLEANUP_CFG
);
574 /* Iterate until there are no more cleanups left to do. If any
575 iteration changed the flowgraph, set CHANGED to true. */
579 retval
= cleanup_tree_cfg_1 ();
586 #ifdef ENABLE_CHECKING
590 timevar_pop (TV_TREE_CLEANUP_CFG
);
595 /* Cleanup cfg and repair loop structures. */
598 cleanup_tree_cfg_loop (void)
600 bool changed
= cleanup_tree_cfg ();
604 bitmap changed_bbs
= BITMAP_ALLOC (NULL
);
605 calculate_dominance_info (CDI_DOMINATORS
);
606 fix_loop_structure (changed_bbs
);
608 /* This usually does nothing. But sometimes parts of cfg that originally
609 were inside a loop get out of it due to edge removal (since they
610 become unreachable by back edges from latch). */
611 rewrite_into_loop_closed_ssa (changed_bbs
, TODO_update_ssa
);
613 BITMAP_FREE (changed_bbs
);
615 #ifdef ENABLE_CHECKING
616 verify_loop_structure ();
623 /* Merge the PHI nodes at BB into those at BB's sole successor. */
626 remove_forwarder_block_with_phi (basic_block bb
)
628 edge succ
= single_succ_edge (bb
);
629 basic_block dest
= succ
->dest
;
631 basic_block dombb
, domdest
, dom
;
633 /* We check for infinite loops already in tree_forwarder_block_p.
634 However it may happen that the infinite loop is created
635 afterwards due to removal of forwarders. */
639 /* If the destination block consists of a nonlocal label, do not
641 label
= first_stmt (dest
);
643 && TREE_CODE (label
) == LABEL_EXPR
644 && DECL_NONLOCAL (LABEL_EXPR_LABEL (label
)))
647 /* Redirect each incoming edge to BB to DEST. */
648 while (EDGE_COUNT (bb
->preds
) > 0)
650 edge e
= EDGE_PRED (bb
, 0), s
;
653 s
= find_edge (e
->src
, dest
);
656 /* We already have an edge S from E->src to DEST. If S and
657 E->dest's sole successor edge have the same PHI arguments
658 at DEST, redirect S to DEST. */
659 if (phi_alternatives_equal (dest
, s
, succ
))
661 e
= redirect_edge_and_branch (e
, dest
);
662 PENDING_STMT (e
) = NULL_TREE
;
666 /* PHI arguments are different. Create a forwarder block by
667 splitting E so that we can merge PHI arguments on E to
669 e
= single_succ_edge (split_edge (e
));
672 s
= redirect_edge_and_branch (e
, dest
);
674 /* redirect_edge_and_branch must not create a new edge. */
677 /* Add to the PHI nodes at DEST each PHI argument removed at the
679 for (phi
= phi_nodes (dest
); phi
; phi
= PHI_CHAIN (phi
))
681 tree def
= PHI_ARG_DEF (phi
, succ
->dest_idx
);
683 if (TREE_CODE (def
) == SSA_NAME
)
687 /* If DEF is one of the results of PHI nodes removed during
688 redirection, replace it with the PHI argument that used
690 for (var
= PENDING_STMT (e
); var
; var
= TREE_CHAIN (var
))
692 tree old_arg
= TREE_PURPOSE (var
);
693 tree new_arg
= TREE_VALUE (var
);
703 add_phi_arg (phi
, def
, s
);
706 PENDING_STMT (e
) = NULL
;
709 /* Update the dominators. */
710 dombb
= get_immediate_dominator (CDI_DOMINATORS
, bb
);
711 domdest
= get_immediate_dominator (CDI_DOMINATORS
, dest
);
714 /* Shortcut to avoid calling (relatively expensive)
715 nearest_common_dominator unless necessary. */
719 dom
= nearest_common_dominator (CDI_DOMINATORS
, domdest
, dombb
);
721 set_immediate_dominator (CDI_DOMINATORS
, dest
, dom
);
723 /* Remove BB since all of BB's incoming edges have been redirected
725 delete_basic_block (bb
);
728 /* This pass merges PHI nodes if one feeds into another. For example,
729 suppose we have the following:
736 # tem_6 = PHI <tem_17(8), tem_23(7)>;
739 # tem_3 = PHI <tem_6(9), tem_2(5)>;
742 Then we merge the first PHI node into the second one like so:
749 # tem_3 = PHI <tem_23(7), tem_2(5), tem_17(8)>;
754 merge_phi_nodes (void)
756 basic_block
*worklist
= XNEWVEC (basic_block
, n_basic_blocks
);
757 basic_block
*current
= worklist
;
760 calculate_dominance_info (CDI_DOMINATORS
);
762 /* Find all PHI nodes that we may be able to merge. */
767 /* Look for a forwarder block with PHI nodes. */
768 if (!tree_forwarder_block_p (bb
, true))
771 dest
= single_succ (bb
);
773 /* We have to feed into another basic block with PHI
775 if (!phi_nodes (dest
)
776 /* We don't want to deal with a basic block with
778 || has_abnormal_incoming_edge_p (bb
))
781 if (!dominated_by_p (CDI_DOMINATORS
, dest
, bb
))
783 /* If BB does not dominate DEST, then the PHI nodes at
784 DEST must be the only users of the results of the PHI
791 unsigned int dest_idx
= single_succ_edge (bb
)->dest_idx
;
793 /* BB dominates DEST. There may be many users of the PHI
794 nodes in BB. However, there is still a trivial case we
795 can handle. If the result of every PHI in BB is used
796 only by a PHI in DEST, then we can trivially merge the
797 PHI nodes from BB into DEST. */
798 for (phi
= phi_nodes (bb
); phi
; phi
= PHI_CHAIN (phi
))
800 tree result
= PHI_RESULT (phi
);
801 use_operand_p imm_use
;
804 /* If the PHI's result is never used, then we can just
806 if (has_zero_uses (result
))
809 /* Get the single use of the result of this PHI node. */
810 if (!single_imm_use (result
, &imm_use
, &use_stmt
)
811 || TREE_CODE (use_stmt
) != PHI_NODE
812 || bb_for_stmt (use_stmt
) != dest
813 || PHI_ARG_DEF (use_stmt
, dest_idx
) != result
)
817 /* If the loop above iterated through all the PHI nodes
818 in BB, then we can merge the PHIs from BB into DEST. */
824 /* Now let's drain WORKLIST. */
825 while (current
!= worklist
)
828 remove_forwarder_block_with_phi (bb
);
836 gate_merge_phi (void)
841 struct tree_opt_pass pass_merge_phi
= {
842 "mergephi", /* name */
843 gate_merge_phi
, /* gate */
844 merge_phi_nodes
, /* execute */
847 0, /* static_pass_number */
848 TV_TREE_MERGE_PHI
, /* tv_id */
849 PROP_cfg
| PROP_ssa
, /* properties_required */
850 0, /* properties_provided */
851 0, /* properties_destroyed */
852 0, /* todo_flags_start */
853 TODO_dump_func
| TODO_ggc_collect
/* todo_flags_finish */