1 /* Single entry single exit control flow regions.
2 Copyright (C) 2008-2015 Free Software Foundation, Inc.
3 Contributed by Jan Sjodin <jan.sjodin@amd.com> and
4 Sebastian Pop <sebastian.pop@amd.com>.
6 This file is part of GCC.
8 GCC is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3, or (at your option)
13 GCC is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING3. If not see
20 <http://www.gnu.org/licenses/>. */
24 #include "coretypes.h"
29 #include "hard-reg-set.h"
32 #include "fold-const.h"
33 #include "tree-pretty-print.h"
34 #include "internal-fn.h"
35 #include "gimple-fold.h"
38 #include "gimple-iterator.h"
39 #include "gimplify-me.h"
41 #include "tree-ssa-loop.h"
42 #include "tree-into-ssa.h"
44 #include "tree-chrec.h"
45 #include "tree-data-ref.h"
46 #include "tree-scalar-evolution.h"
47 #include "tree-pass.h"
48 #include "value-prof.h"
50 #include "tree-ssa-propagate.h"
51 #include "tree-hash-traits.h"
53 /* Helper function for debug_rename_map. */
56 debug_rename_map_1 (tree_node
*const &old_name
, tree_node
*const &expr
,
59 fprintf (stderr
, "(");
60 print_generic_expr (stderr
, old_name
, 0);
61 fprintf (stderr
, ", ");
62 print_generic_expr (stderr
, expr
, 0);
63 fprintf (stderr
, ")\n");
67 typedef hash_map
<tree_ssa_name_hash
, tree
> rename_map_type
;
70 /* Print to stderr all the elements of RENAME_MAP. */
73 debug_rename_map (rename_map_type
*rename_map
)
75 rename_map
->traverse
<void *, debug_rename_map_1
> (NULL
);
79 /* Record LOOP as occurring in REGION. */
82 sese_record_loop (sese region
, loop_p loop
)
84 if (sese_contains_loop (region
, loop
))
87 bitmap_set_bit (SESE_LOOPS (region
), loop
->num
);
88 SESE_LOOP_NEST (region
).safe_push (loop
);
91 /* Build the loop nests contained in REGION. Returns true when the
92 operation was successful. */
95 build_sese_loop_nests (sese region
)
99 struct loop
*loop0
, *loop1
;
101 FOR_EACH_BB_FN (bb
, cfun
)
102 if (bb_in_sese_p (bb
, region
))
104 struct loop
*loop
= bb
->loop_father
;
106 /* Only add loops if they are completely contained in the SCoP. */
107 if (loop
->header
== bb
108 && bb_in_sese_p (loop
->latch
, region
))
109 sese_record_loop (region
, loop
);
112 /* Make sure that the loops in the SESE_LOOP_NEST are ordered. It
113 can be the case that an inner loop is inserted before an outer
114 loop. To avoid this, semi-sort once. */
115 FOR_EACH_VEC_ELT (SESE_LOOP_NEST (region
), i
, loop0
)
117 if (SESE_LOOP_NEST (region
).length () == i
+ 1)
120 loop1
= SESE_LOOP_NEST (region
)[i
+ 1];
121 if (loop0
->num
> loop1
->num
)
123 SESE_LOOP_NEST (region
)[i
] = loop1
;
124 SESE_LOOP_NEST (region
)[i
+ 1] = loop0
;
129 /* For a USE in BB, if BB is outside REGION, mark the USE in the
133 sese_build_liveouts_use (sese region
, bitmap liveouts
, basic_block bb
,
139 if (TREE_CODE (use
) != SSA_NAME
)
142 ver
= SSA_NAME_VERSION (use
);
143 def_bb
= gimple_bb (SSA_NAME_DEF_STMT (use
));
146 || !bb_in_sese_p (def_bb
, region
)
147 || bb_in_sese_p (bb
, region
))
150 bitmap_set_bit (liveouts
, ver
);
153 /* Marks for rewrite all the SSA_NAMES defined in REGION and that are
154 used in BB that is outside of the REGION. */
157 sese_build_liveouts_bb (sese region
, bitmap liveouts
, basic_block bb
)
164 FOR_EACH_EDGE (e
, ei
, bb
->succs
)
165 for (gphi_iterator bsi
= gsi_start_phis (e
->dest
); !gsi_end_p (bsi
);
167 sese_build_liveouts_use (region
, liveouts
, bb
,
168 PHI_ARG_DEF_FROM_EDGE (bsi
.phi (), e
));
170 for (gimple_stmt_iterator bsi
= gsi_start_bb (bb
); !gsi_end_p (bsi
);
173 gimple stmt
= gsi_stmt (bsi
);
175 if (is_gimple_debug (stmt
))
178 FOR_EACH_SSA_USE_OPERAND (use_p
, stmt
, iter
, SSA_OP_ALL_USES
)
179 sese_build_liveouts_use (region
, liveouts
, bb
, USE_FROM_PTR (use_p
));
183 /* For a USE in BB, return true if BB is outside REGION and it's not
184 in the LIVEOUTS set. */
187 sese_bad_liveouts_use (sese region
, bitmap liveouts
, basic_block bb
,
193 if (TREE_CODE (use
) != SSA_NAME
)
196 ver
= SSA_NAME_VERSION (use
);
198 /* If it's in liveouts, the variable will get a new PHI node, and
199 the debug use will be properly adjusted. */
200 if (bitmap_bit_p (liveouts
, ver
))
203 def_bb
= gimple_bb (SSA_NAME_DEF_STMT (use
));
206 || !bb_in_sese_p (def_bb
, region
)
207 || bb_in_sese_p (bb
, region
))
213 /* Reset debug stmts that reference SSA_NAMES defined in REGION that
214 are not marked as liveouts. */
217 sese_reset_debug_liveouts_bb (sese region
, bitmap liveouts
, basic_block bb
)
219 gimple_stmt_iterator bsi
;
223 for (bsi
= gsi_start_bb (bb
); !gsi_end_p (bsi
); gsi_next (&bsi
))
225 gimple stmt
= gsi_stmt (bsi
);
227 if (!is_gimple_debug (stmt
))
230 FOR_EACH_SSA_USE_OPERAND (use_p
, stmt
, iter
, SSA_OP_ALL_USES
)
231 if (sese_bad_liveouts_use (region
, liveouts
, bb
,
232 USE_FROM_PTR (use_p
)))
234 gimple_debug_bind_reset_value (stmt
);
241 /* Build the LIVEOUTS of REGION: the set of variables defined inside
242 and used outside the REGION. */
245 sese_build_liveouts (sese region
, bitmap liveouts
)
249 FOR_EACH_BB_FN (bb
, cfun
)
250 sese_build_liveouts_bb (region
, liveouts
, bb
);
251 if (MAY_HAVE_DEBUG_STMTS
)
252 FOR_EACH_BB_FN (bb
, cfun
)
253 sese_reset_debug_liveouts_bb (region
, liveouts
, bb
);
256 /* Builds a new SESE region from edges ENTRY and EXIT. */
259 new_sese (edge entry
, edge exit
)
261 sese region
= XNEW (struct sese_s
);
263 SESE_ENTRY (region
) = entry
;
264 SESE_EXIT (region
) = exit
;
265 SESE_LOOPS (region
) = BITMAP_ALLOC (NULL
);
266 SESE_LOOP_NEST (region
).create (3);
267 SESE_ADD_PARAMS (region
) = true;
268 SESE_PARAMS (region
).create (3);
273 /* Deletes REGION. */
276 free_sese (sese region
)
278 if (SESE_LOOPS (region
))
279 SESE_LOOPS (region
) = BITMAP_ALLOC (NULL
);
281 SESE_PARAMS (region
).release ();
282 SESE_LOOP_NEST (region
).release ();
287 /* Add exit phis for USE on EXIT. */
290 sese_add_exit_phis_edge (basic_block exit
, tree use
, edge false_e
, edge true_e
)
292 gphi
*phi
= create_phi_node (NULL_TREE
, exit
);
293 create_new_def_for (use
, phi
, gimple_phi_result_ptr (phi
));
294 add_phi_arg (phi
, use
, false_e
, UNKNOWN_LOCATION
);
295 add_phi_arg (phi
, use
, true_e
, UNKNOWN_LOCATION
);
298 /* Insert in the block BB phi nodes for variables defined in REGION
299 and used outside the REGION. The code generation moves REGION in
300 the else clause of an "if (1)" and generates code in the then
301 clause that is at this point empty:
310 sese_insert_phis_for_liveouts (sese region
, basic_block bb
,
311 edge false_e
, edge true_e
)
315 bitmap liveouts
= BITMAP_ALLOC (NULL
);
317 update_ssa (TODO_update_ssa
);
319 sese_build_liveouts (region
, liveouts
);
320 EXECUTE_IF_SET_IN_BITMAP (liveouts
, 0, i
, bi
)
321 sese_add_exit_phis_edge (bb
, ssa_name (i
), false_e
, true_e
);
322 BITMAP_FREE (liveouts
);
324 update_ssa (TODO_update_ssa
);
327 /* Returns the first successor edge of BB with EDGE_TRUE_VALUE flag set. */
330 get_true_edge_from_guard_bb (basic_block bb
)
335 FOR_EACH_EDGE (e
, ei
, bb
->succs
)
336 if (e
->flags
& EDGE_TRUE_VALUE
)
343 /* Returns the first successor edge of BB with EDGE_TRUE_VALUE flag cleared. */
346 get_false_edge_from_guard_bb (basic_block bb
)
351 FOR_EACH_EDGE (e
, ei
, bb
->succs
)
352 if (!(e
->flags
& EDGE_TRUE_VALUE
))
359 /* Returns the expression associated to OLD_NAME in RENAME_MAP. */
362 get_rename (rename_map_type
*rename_map
, tree old_name
)
364 gcc_assert (TREE_CODE (old_name
) == SSA_NAME
);
365 tree
*expr
= rename_map
->get (old_name
);
372 /* Register in RENAME_MAP the rename tuple (OLD_NAME, EXPR). */
375 set_rename (rename_map_type
*rename_map
, tree old_name
, tree expr
)
377 if (old_name
== expr
)
380 rename_map
->put (old_name
, expr
);
383 /* Renames the scalar uses of the statement COPY, using the
384 substitution map RENAME_MAP, inserting the gimplification code at
385 GSI_TGT, for the translation REGION, with the original copied
386 statement in LOOP, and using the induction variable renaming map
387 IV_MAP. Returns true when something has been renamed. GLOOG_ERROR
388 is set when the code generation cannot continue. */
391 rename_uses (gimple copy
, rename_map_type
*rename_map
,
392 gimple_stmt_iterator
*gsi_tgt
,
393 sese region
, loop_p loop
, vec
<tree
> iv_map
,
398 bool changed
= false;
400 if (is_gimple_debug (copy
))
402 if (gimple_debug_bind_p (copy
))
403 gimple_debug_bind_reset_value (copy
);
404 else if (gimple_debug_source_bind_p (copy
))
412 FOR_EACH_SSA_USE_OPERAND (use_p
, copy
, op_iter
, SSA_OP_USE
)
414 tree old_name
= USE_FROM_PTR (use_p
);
418 if (TREE_CODE (old_name
) != SSA_NAME
419 || SSA_NAME_IS_DEFAULT_DEF (old_name
))
423 new_expr
= get_rename (rename_map
, old_name
);
426 tree type_old_name
= TREE_TYPE (old_name
);
427 tree type_new_expr
= TREE_TYPE (new_expr
);
429 if (type_old_name
!= type_new_expr
430 || TREE_CODE (new_expr
) != SSA_NAME
)
432 tree var
= create_tmp_var (type_old_name
, "var");
434 if (!useless_type_conversion_p (type_old_name
, type_new_expr
))
435 new_expr
= fold_convert (type_old_name
, new_expr
);
437 new_expr
= force_gimple_operand (new_expr
, &stmts
, true, var
);
438 gsi_insert_seq_before (gsi_tgt
, stmts
, GSI_SAME_STMT
);
441 replace_exp (use_p
, new_expr
);
445 scev
= scalar_evolution_in_region (region
, loop
, old_name
);
447 /* At this point we should know the exact scev for each
448 scalar SSA_NAME used in the scop: all the other scalar
449 SSA_NAMEs should have been translated out of SSA using
450 arrays with one element. */
451 if (chrec_contains_undetermined (scev
))
454 new_expr
= build_zero_cst (TREE_TYPE (old_name
));
457 new_expr
= chrec_apply_map (scev
, iv_map
);
459 /* The apply should produce an expression tree containing
460 the uses of the new induction variables. We should be
461 able to use new_expr instead of the old_name in the newly
462 generated loop nest. */
463 if (chrec_contains_undetermined (new_expr
)
464 || tree_contains_chrecs (new_expr
, NULL
))
467 new_expr
= build_zero_cst (TREE_TYPE (old_name
));
470 /* Replace the old_name with the new_expr. */
471 new_expr
= force_gimple_operand (unshare_expr (new_expr
), &stmts
,
474 gsi_insert_seq_before (gsi_tgt
, stmts
, GSI_SAME_STMT
);
475 replace_exp (use_p
, new_expr
);
477 if (TREE_CODE (new_expr
) == INTEGER_CST
478 && is_gimple_assign (copy
))
480 tree rhs
= gimple_assign_rhs1 (copy
);
482 if (TREE_CODE (rhs
) == ADDR_EXPR
)
483 recompute_tree_invariant_for_addr_expr (rhs
);
486 set_rename (rename_map
, old_name
, new_expr
);
492 /* Duplicates the statements of basic block BB into basic block NEW_BB
493 and compute the new induction variables according to the IV_MAP.
494 GLOOG_ERROR is set when the code generation cannot continue. */
497 graphite_copy_stmts_from_block (basic_block bb
, basic_block new_bb
,
498 rename_map_type
*rename_map
,
499 vec
<tree
> iv_map
, sese region
,
502 gimple_stmt_iterator gsi
, gsi_tgt
;
503 loop_p loop
= bb
->loop_father
;
505 gsi_tgt
= gsi_start_bb (new_bb
);
506 for (gsi
= gsi_start_bb (bb
); !gsi_end_p (gsi
); gsi_next (&gsi
))
510 gimple stmt
= gsi_stmt (gsi
);
514 /* Do not copy labels or conditions. */
515 if (gimple_code (stmt
) == GIMPLE_LABEL
516 || gimple_code (stmt
) == GIMPLE_COND
)
519 /* Do not copy induction variables. */
520 if (is_gimple_assign (stmt
)
521 && (lhs
= gimple_assign_lhs (stmt
))
522 && TREE_CODE (lhs
) == SSA_NAME
523 && is_gimple_reg (lhs
)
524 && scev_analyzable_p (lhs
, region
))
527 /* Create a new copy of STMT and duplicate STMT's virtual
529 copy
= gimple_copy (stmt
);
530 gsi_insert_after (&gsi_tgt
, copy
, GSI_NEW_STMT
);
532 maybe_duplicate_eh_stmt (copy
, stmt
);
533 gimple_duplicate_stmt_histograms (cfun
, copy
, cfun
, stmt
);
535 /* Create new names for all the definitions created by COPY and
536 add replacement mappings for each new name. */
537 FOR_EACH_SSA_DEF_OPERAND (def_p
, copy
, op_iter
, SSA_OP_ALL_DEFS
)
539 tree old_name
= DEF_FROM_PTR (def_p
);
540 tree new_name
= create_new_def_for (old_name
, copy
, def_p
);
541 set_rename (rename_map
, old_name
, new_name
);
544 if (rename_uses (copy
, rename_map
, &gsi_tgt
, region
, loop
, iv_map
,
547 gcc_assert (gsi_stmt (gsi_tgt
) == copy
);
548 fold_stmt_inplace (&gsi_tgt
);
555 /* Copies BB and includes in the copied BB all the statements that can
556 be reached following the use-def chains from the memory accesses,
557 and returns the next edge following this new block. GLOOG_ERROR is
558 set when the code generation cannot continue. */
561 copy_bb_and_scalar_dependences (basic_block bb
, sese region
,
562 edge next_e
, vec
<tree
> iv_map
,
565 basic_block new_bb
= split_edge (next_e
);
566 rename_map_type
rename_map (10);
568 next_e
= single_succ_edge (new_bb
);
569 graphite_copy_stmts_from_block (bb
, new_bb
, &rename_map
, iv_map
, region
,
571 remove_phi_nodes (new_bb
);
576 /* Returns the outermost loop in SCOP that contains BB. */
579 outermost_loop_in_sese (sese region
, basic_block bb
)
583 nest
= bb
->loop_father
;
584 while (loop_outer (nest
)
585 && loop_in_sese_p (loop_outer (nest
), region
))
586 nest
= loop_outer (nest
);
591 /* Sets the false region of an IF_REGION to REGION. */
594 if_region_set_false_region (ifsese if_region
, sese region
)
596 basic_block condition
= if_region_get_condition_block (if_region
);
597 edge false_edge
= get_false_edge_from_guard_bb (condition
);
598 basic_block dummy
= false_edge
->dest
;
599 edge entry_region
= SESE_ENTRY (region
);
600 edge exit_region
= SESE_EXIT (region
);
601 basic_block before_region
= entry_region
->src
;
602 basic_block last_in_region
= exit_region
->src
;
603 hashval_t hash
= htab_hash_pointer (exit_region
);
605 = current_loops
->exits
->find_slot_with_hash (exit_region
, hash
, NO_INSERT
);
607 entry_region
->flags
= false_edge
->flags
;
608 false_edge
->flags
= exit_region
->flags
;
610 redirect_edge_pred (entry_region
, condition
);
611 redirect_edge_pred (exit_region
, before_region
);
612 redirect_edge_pred (false_edge
, last_in_region
);
613 redirect_edge_succ (false_edge
, single_succ (dummy
));
614 delete_basic_block (dummy
);
616 exit_region
->flags
= EDGE_FALLTHRU
;
617 recompute_all_dominators ();
619 SESE_EXIT (region
) = false_edge
;
621 free (if_region
->false_region
);
622 if_region
->false_region
= region
;
626 struct loop_exit
*loop_exit
= ggc_cleared_alloc
<struct loop_exit
> ();
628 memcpy (loop_exit
, *((struct loop_exit
**) slot
), sizeof (struct loop_exit
));
629 current_loops
->exits
->clear_slot (slot
);
631 hashval_t hash
= htab_hash_pointer (false_edge
);
632 slot
= current_loops
->exits
->find_slot_with_hash (false_edge
, hash
,
634 loop_exit
->e
= false_edge
;
636 false_edge
->src
->loop_father
->exits
->next
= loop_exit
;
640 /* Creates an IFSESE with CONDITION on edge ENTRY. */
643 create_if_region_on_edge (edge entry
, tree condition
)
647 sese sese_region
= XNEW (struct sese_s
);
648 sese true_region
= XNEW (struct sese_s
);
649 sese false_region
= XNEW (struct sese_s
);
650 ifsese if_region
= XNEW (struct ifsese_s
);
651 edge exit
= create_empty_if_region_on_edge (entry
, condition
);
653 if_region
->region
= sese_region
;
654 if_region
->region
->entry
= entry
;
655 if_region
->region
->exit
= exit
;
657 FOR_EACH_EDGE (e
, ei
, entry
->dest
->succs
)
659 if (e
->flags
& EDGE_TRUE_VALUE
)
661 true_region
->entry
= e
;
662 true_region
->exit
= single_succ_edge (e
->dest
);
663 if_region
->true_region
= true_region
;
665 else if (e
->flags
& EDGE_FALSE_VALUE
)
667 false_region
->entry
= e
;
668 false_region
->exit
= single_succ_edge (e
->dest
);
669 if_region
->false_region
= false_region
;
676 /* Moves REGION in a condition expression:
684 move_sese_in_condition (sese region
)
686 basic_block pred_block
= split_edge (SESE_ENTRY (region
));
689 SESE_ENTRY (region
) = single_succ_edge (pred_block
);
690 if_region
= create_if_region_on_edge (single_pred_edge (pred_block
), integer_one_node
);
691 if_region_set_false_region (if_region
, region
);
696 /* Replaces the condition of the IF_REGION with CONDITION:
704 set_ifsese_condition (ifsese if_region
, tree condition
)
706 sese region
= if_region
->region
;
707 edge entry
= region
->entry
;
708 basic_block bb
= entry
->dest
;
709 gimple last
= last_stmt (bb
);
710 gimple_stmt_iterator gsi
= gsi_last_bb (bb
);
713 gcc_assert (gimple_code (last
) == GIMPLE_COND
);
715 gsi_remove (&gsi
, true);
716 gsi
= gsi_last_bb (bb
);
717 condition
= force_gimple_operand_gsi (&gsi
, condition
, true, NULL
,
718 false, GSI_NEW_STMT
);
719 cond_stmt
= gimple_build_cond_from_tree (condition
, NULL_TREE
, NULL_TREE
);
720 gsi
= gsi_last_bb (bb
);
721 gsi_insert_after (&gsi
, cond_stmt
, GSI_NEW_STMT
);
724 /* Returns the scalar evolution of T in REGION. Every variable that
725 is not defined in the REGION is considered a parameter. */
728 scalar_evolution_in_region (sese region
, loop_p loop
, tree t
)
731 struct loop
*def_loop
;
732 basic_block before
= block_before_sese (region
);
734 /* SCOP parameters. */
735 if (TREE_CODE (t
) == SSA_NAME
736 && !defined_in_sese_p (t
, region
))
739 if (TREE_CODE (t
) != SSA_NAME
740 || loop_in_sese_p (loop
, region
))
741 return instantiate_scev (before
, loop
,
742 analyze_scalar_evolution (loop
, t
));
744 def
= SSA_NAME_DEF_STMT (t
);
745 def_loop
= loop_containing_stmt (def
);
747 if (loop_in_sese_p (def_loop
, region
))
749 t
= analyze_scalar_evolution (def_loop
, t
);
750 def_loop
= superloop_at_depth (def_loop
, loop_depth (loop
) + 1);
751 t
= compute_overall_effect_of_inner_loop (def_loop
, t
);
755 return instantiate_scev (before
, loop
, t
);