1 /* Single entry single exit control flow regions.
2 Copyright (C) 2008-2013 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"
25 #include "hash-table.h"
27 #include "tree-pretty-print.h"
30 #include "gimple-iterator.h"
31 #include "gimplify-me.h"
32 #include "gimple-ssa.h"
34 #include "tree-phinodes.h"
35 #include "ssa-iterators.h"
36 #include "tree-ssanames.h"
37 #include "tree-ssa-loop.h"
38 #include "tree-into-ssa.h"
40 #include "tree-chrec.h"
41 #include "tree-data-ref.h"
42 #include "tree-scalar-evolution.h"
43 #include "tree-pass.h"
44 #include "value-prof.h"
46 #include "tree-ssa-propagate.h"
48 /* Print to stderr the element ELT. */
51 debug_rename_elt (rename_map_elt elt
)
53 fprintf (stderr
, "(");
54 print_generic_expr (stderr
, elt
->old_name
, 0);
55 fprintf (stderr
, ", ");
56 print_generic_expr (stderr
, elt
->expr
, 0);
57 fprintf (stderr
, ")\n");
60 /* Helper function for debug_rename_map. */
63 debug_rename_map_1 (rename_map_elt_s
**slot
, void *s ATTRIBUTE_UNUSED
)
65 struct rename_map_elt_s
*entry
= *slot
;
66 debug_rename_elt (entry
);
71 /* Hashtable helpers. */
73 struct rename_map_hasher
: typed_free_remove
<rename_map_elt_s
>
75 typedef rename_map_elt_s value_type
;
76 typedef rename_map_elt_s compare_type
;
77 static inline hashval_t
hash (const value_type
*);
78 static inline bool equal (const value_type
*, const compare_type
*);
81 /* Computes a hash function for database element ELT. */
84 rename_map_hasher::hash (const value_type
*elt
)
86 return SSA_NAME_VERSION (elt
->old_name
);
89 /* Compares database elements E1 and E2. */
92 rename_map_hasher::equal (const value_type
*elt1
, const compare_type
*elt2
)
94 return (elt1
->old_name
== elt2
->old_name
);
97 typedef hash_table
<rename_map_hasher
> rename_map_type
;
100 /* Print to stderr all the elements of RENAME_MAP. */
103 debug_rename_map (rename_map_type rename_map
)
105 rename_map
.traverse
<void *, debug_rename_map_1
> (NULL
);
108 /* Computes a hash function for database element ELT. */
111 rename_map_elt_info (const void *elt
)
113 return SSA_NAME_VERSION (((const struct rename_map_elt_s
*) elt
)->old_name
);
116 /* Compares database elements E1 and E2. */
119 eq_rename_map_elts (const void *e1
, const void *e2
)
121 const struct rename_map_elt_s
*elt1
= (const struct rename_map_elt_s
*) e1
;
122 const struct rename_map_elt_s
*elt2
= (const struct rename_map_elt_s
*) e2
;
124 return (elt1
->old_name
== elt2
->old_name
);
129 /* Record LOOP as occurring in REGION. */
132 sese_record_loop (sese region
, loop_p loop
)
134 if (sese_contains_loop (region
, loop
))
137 bitmap_set_bit (SESE_LOOPS (region
), loop
->num
);
138 SESE_LOOP_NEST (region
).safe_push (loop
);
141 /* Build the loop nests contained in REGION. Returns true when the
142 operation was successful. */
145 build_sese_loop_nests (sese region
)
149 struct loop
*loop0
, *loop1
;
152 if (bb_in_sese_p (bb
, region
))
154 struct loop
*loop
= bb
->loop_father
;
156 /* Only add loops if they are completely contained in the SCoP. */
157 if (loop
->header
== bb
158 && bb_in_sese_p (loop
->latch
, region
))
159 sese_record_loop (region
, loop
);
162 /* Make sure that the loops in the SESE_LOOP_NEST are ordered. It
163 can be the case that an inner loop is inserted before an outer
164 loop. To avoid this, semi-sort once. */
165 FOR_EACH_VEC_ELT (SESE_LOOP_NEST (region
), i
, loop0
)
167 if (SESE_LOOP_NEST (region
).length () == i
+ 1)
170 loop1
= SESE_LOOP_NEST (region
)[i
+ 1];
171 if (loop0
->num
> loop1
->num
)
173 SESE_LOOP_NEST (region
)[i
] = loop1
;
174 SESE_LOOP_NEST (region
)[i
+ 1] = loop0
;
179 /* For a USE in BB, if BB is outside REGION, mark the USE in the
183 sese_build_liveouts_use (sese region
, bitmap liveouts
, basic_block bb
,
189 if (TREE_CODE (use
) != SSA_NAME
)
192 ver
= SSA_NAME_VERSION (use
);
193 def_bb
= gimple_bb (SSA_NAME_DEF_STMT (use
));
196 || !bb_in_sese_p (def_bb
, region
)
197 || bb_in_sese_p (bb
, region
))
200 bitmap_set_bit (liveouts
, ver
);
203 /* Marks for rewrite all the SSA_NAMES defined in REGION and that are
204 used in BB that is outside of the REGION. */
207 sese_build_liveouts_bb (sese region
, bitmap liveouts
, basic_block bb
)
209 gimple_stmt_iterator bsi
;
215 FOR_EACH_EDGE (e
, ei
, bb
->succs
)
216 for (bsi
= gsi_start_phis (e
->dest
); !gsi_end_p (bsi
); gsi_next (&bsi
))
217 sese_build_liveouts_use (region
, liveouts
, bb
,
218 PHI_ARG_DEF_FROM_EDGE (gsi_stmt (bsi
), e
));
220 for (bsi
= gsi_start_bb (bb
); !gsi_end_p (bsi
); gsi_next (&bsi
))
222 gimple stmt
= gsi_stmt (bsi
);
224 if (is_gimple_debug (stmt
))
227 FOR_EACH_SSA_USE_OPERAND (use_p
, stmt
, iter
, SSA_OP_ALL_USES
)
228 sese_build_liveouts_use (region
, liveouts
, bb
, USE_FROM_PTR (use_p
));
232 /* For a USE in BB, return true if BB is outside REGION and it's not
233 in the LIVEOUTS set. */
236 sese_bad_liveouts_use (sese region
, bitmap liveouts
, basic_block bb
,
242 if (TREE_CODE (use
) != SSA_NAME
)
245 ver
= SSA_NAME_VERSION (use
);
247 /* If it's in liveouts, the variable will get a new PHI node, and
248 the debug use will be properly adjusted. */
249 if (bitmap_bit_p (liveouts
, ver
))
252 def_bb
= gimple_bb (SSA_NAME_DEF_STMT (use
));
255 || !bb_in_sese_p (def_bb
, region
)
256 || bb_in_sese_p (bb
, region
))
262 /* Reset debug stmts that reference SSA_NAMES defined in REGION that
263 are not marked as liveouts. */
266 sese_reset_debug_liveouts_bb (sese region
, bitmap liveouts
, basic_block bb
)
268 gimple_stmt_iterator bsi
;
272 for (bsi
= gsi_start_bb (bb
); !gsi_end_p (bsi
); gsi_next (&bsi
))
274 gimple stmt
= gsi_stmt (bsi
);
276 if (!is_gimple_debug (stmt
))
279 FOR_EACH_SSA_USE_OPERAND (use_p
, stmt
, iter
, SSA_OP_ALL_USES
)
280 if (sese_bad_liveouts_use (region
, liveouts
, bb
,
281 USE_FROM_PTR (use_p
)))
283 gimple_debug_bind_reset_value (stmt
);
290 /* Build the LIVEOUTS of REGION: the set of variables defined inside
291 and used outside the REGION. */
294 sese_build_liveouts (sese region
, bitmap liveouts
)
299 sese_build_liveouts_bb (region
, liveouts
, bb
);
300 if (MAY_HAVE_DEBUG_STMTS
)
302 sese_reset_debug_liveouts_bb (region
, liveouts
, bb
);
305 /* Builds a new SESE region from edges ENTRY and EXIT. */
308 new_sese (edge entry
, edge exit
)
310 sese region
= XNEW (struct sese_s
);
312 SESE_ENTRY (region
) = entry
;
313 SESE_EXIT (region
) = exit
;
314 SESE_LOOPS (region
) = BITMAP_ALLOC (NULL
);
315 SESE_LOOP_NEST (region
).create (3);
316 SESE_ADD_PARAMS (region
) = true;
317 SESE_PARAMS (region
).create (3);
322 /* Deletes REGION. */
325 free_sese (sese region
)
327 if (SESE_LOOPS (region
))
328 SESE_LOOPS (region
) = BITMAP_ALLOC (NULL
);
330 SESE_PARAMS (region
).release ();
331 SESE_LOOP_NEST (region
).release ();
336 /* Add exit phis for USE on EXIT. */
339 sese_add_exit_phis_edge (basic_block exit
, tree use
, edge false_e
, edge true_e
)
341 gimple phi
= create_phi_node (NULL_TREE
, exit
);
342 create_new_def_for (use
, phi
, gimple_phi_result_ptr (phi
));
343 add_phi_arg (phi
, use
, false_e
, UNKNOWN_LOCATION
);
344 add_phi_arg (phi
, use
, true_e
, UNKNOWN_LOCATION
);
347 /* Insert in the block BB phi nodes for variables defined in REGION
348 and used outside the REGION. The code generation moves REGION in
349 the else clause of an "if (1)" and generates code in the then
350 clause that is at this point empty:
359 sese_insert_phis_for_liveouts (sese region
, basic_block bb
,
360 edge false_e
, edge true_e
)
364 bitmap liveouts
= BITMAP_ALLOC (NULL
);
366 update_ssa (TODO_update_ssa
);
368 sese_build_liveouts (region
, liveouts
);
369 EXECUTE_IF_SET_IN_BITMAP (liveouts
, 0, i
, bi
)
370 sese_add_exit_phis_edge (bb
, ssa_name (i
), false_e
, true_e
);
371 BITMAP_FREE (liveouts
);
373 update_ssa (TODO_update_ssa
);
376 /* Returns the first successor edge of BB with EDGE_TRUE_VALUE flag set. */
379 get_true_edge_from_guard_bb (basic_block bb
)
384 FOR_EACH_EDGE (e
, ei
, bb
->succs
)
385 if (e
->flags
& EDGE_TRUE_VALUE
)
392 /* Returns the first successor edge of BB with EDGE_TRUE_VALUE flag cleared. */
395 get_false_edge_from_guard_bb (basic_block bb
)
400 FOR_EACH_EDGE (e
, ei
, bb
->succs
)
401 if (!(e
->flags
& EDGE_TRUE_VALUE
))
408 /* Returns the expression associated to OLD_NAME in RENAME_MAP. */
411 get_rename (rename_map_type rename_map
, tree old_name
)
413 struct rename_map_elt_s tmp
;
414 rename_map_elt_s
**slot
;
416 gcc_assert (TREE_CODE (old_name
) == SSA_NAME
);
417 tmp
.old_name
= old_name
;
418 slot
= rename_map
.find_slot (&tmp
, NO_INSERT
);
421 return (*slot
)->expr
;
426 /* Register in RENAME_MAP the rename tuple (OLD_NAME, EXPR). */
429 set_rename (rename_map_type rename_map
, tree old_name
, tree expr
)
431 struct rename_map_elt_s tmp
;
432 rename_map_elt_s
**slot
;
434 if (old_name
== expr
)
437 tmp
.old_name
= old_name
;
438 slot
= rename_map
.find_slot (&tmp
, INSERT
);
445 *slot
= new_rename_map_elt (old_name
, expr
);
448 /* Renames the scalar uses of the statement COPY, using the
449 substitution map RENAME_MAP, inserting the gimplification code at
450 GSI_TGT, for the translation REGION, with the original copied
451 statement in LOOP, and using the induction variable renaming map
452 IV_MAP. Returns true when something has been renamed. GLOOG_ERROR
453 is set when the code generation cannot continue. */
456 rename_uses (gimple copy
, rename_map_type rename_map
,
457 gimple_stmt_iterator
*gsi_tgt
,
458 sese region
, loop_p loop
, vec
<tree
> iv_map
,
463 bool changed
= false;
465 if (is_gimple_debug (copy
))
467 if (gimple_debug_bind_p (copy
))
468 gimple_debug_bind_reset_value (copy
);
469 else if (gimple_debug_source_bind_p (copy
))
477 FOR_EACH_SSA_USE_OPERAND (use_p
, copy
, op_iter
, SSA_OP_USE
)
479 tree old_name
= USE_FROM_PTR (use_p
);
483 if (TREE_CODE (old_name
) != SSA_NAME
484 || SSA_NAME_IS_DEFAULT_DEF (old_name
))
488 new_expr
= get_rename (rename_map
, old_name
);
491 tree type_old_name
= TREE_TYPE (old_name
);
492 tree type_new_expr
= TREE_TYPE (new_expr
);
494 if (type_old_name
!= type_new_expr
495 || TREE_CODE (new_expr
) != SSA_NAME
)
497 tree var
= create_tmp_var (type_old_name
, "var");
499 if (!useless_type_conversion_p (type_old_name
, type_new_expr
))
500 new_expr
= fold_convert (type_old_name
, new_expr
);
502 new_expr
= force_gimple_operand (new_expr
, &stmts
, true, var
);
503 gsi_insert_seq_before (gsi_tgt
, stmts
, GSI_SAME_STMT
);
506 replace_exp (use_p
, new_expr
);
510 scev
= scalar_evolution_in_region (region
, loop
, old_name
);
512 /* At this point we should know the exact scev for each
513 scalar SSA_NAME used in the scop: all the other scalar
514 SSA_NAMEs should have been translated out of SSA using
515 arrays with one element. */
516 if (chrec_contains_undetermined (scev
))
519 new_expr
= build_zero_cst (TREE_TYPE (old_name
));
522 new_expr
= chrec_apply_map (scev
, iv_map
);
524 /* The apply should produce an expression tree containing
525 the uses of the new induction variables. We should be
526 able to use new_expr instead of the old_name in the newly
527 generated loop nest. */
528 if (chrec_contains_undetermined (new_expr
)
529 || tree_contains_chrecs (new_expr
, NULL
))
532 new_expr
= build_zero_cst (TREE_TYPE (old_name
));
535 /* Replace the old_name with the new_expr. */
536 new_expr
= force_gimple_operand (unshare_expr (new_expr
), &stmts
,
539 gsi_insert_seq_before (gsi_tgt
, stmts
, GSI_SAME_STMT
);
540 replace_exp (use_p
, new_expr
);
542 if (TREE_CODE (new_expr
) == INTEGER_CST
543 && is_gimple_assign (copy
))
545 tree rhs
= gimple_assign_rhs1 (copy
);
547 if (TREE_CODE (rhs
) == ADDR_EXPR
)
548 recompute_tree_invariant_for_addr_expr (rhs
);
551 set_rename (rename_map
, old_name
, new_expr
);
557 /* Duplicates the statements of basic block BB into basic block NEW_BB
558 and compute the new induction variables according to the IV_MAP.
559 GLOOG_ERROR is set when the code generation cannot continue. */
562 graphite_copy_stmts_from_block (basic_block bb
, basic_block new_bb
,
563 rename_map_type rename_map
,
564 vec
<tree
> iv_map
, sese region
,
567 gimple_stmt_iterator gsi
, gsi_tgt
;
568 loop_p loop
= bb
->loop_father
;
570 gsi_tgt
= gsi_start_bb (new_bb
);
571 for (gsi
= gsi_start_bb (bb
); !gsi_end_p (gsi
); gsi_next (&gsi
))
575 gimple stmt
= gsi_stmt (gsi
);
579 /* Do not copy labels or conditions. */
580 if (gimple_code (stmt
) == GIMPLE_LABEL
581 || gimple_code (stmt
) == GIMPLE_COND
)
584 /* Do not copy induction variables. */
585 if (is_gimple_assign (stmt
)
586 && (lhs
= gimple_assign_lhs (stmt
))
587 && TREE_CODE (lhs
) == SSA_NAME
588 && is_gimple_reg (lhs
)
589 && scev_analyzable_p (lhs
, region
))
592 /* Create a new copy of STMT and duplicate STMT's virtual
594 copy
= gimple_copy (stmt
);
595 gsi_insert_after (&gsi_tgt
, copy
, GSI_NEW_STMT
);
597 maybe_duplicate_eh_stmt (copy
, stmt
);
598 gimple_duplicate_stmt_histograms (cfun
, copy
, cfun
, stmt
);
600 /* Create new names for all the definitions created by COPY and
601 add replacement mappings for each new name. */
602 FOR_EACH_SSA_DEF_OPERAND (def_p
, copy
, op_iter
, SSA_OP_ALL_DEFS
)
604 tree old_name
= DEF_FROM_PTR (def_p
);
605 tree new_name
= create_new_def_for (old_name
, copy
, def_p
);
606 set_rename (rename_map
, old_name
, new_name
);
609 if (rename_uses (copy
, rename_map
, &gsi_tgt
, region
, loop
, iv_map
,
612 gcc_assert (gsi_stmt (gsi_tgt
) == copy
);
613 fold_stmt_inplace (&gsi_tgt
);
620 /* Copies BB and includes in the copied BB all the statements that can
621 be reached following the use-def chains from the memory accesses,
622 and returns the next edge following this new block. GLOOG_ERROR is
623 set when the code generation cannot continue. */
626 copy_bb_and_scalar_dependences (basic_block bb
, sese region
,
627 edge next_e
, vec
<tree
> iv_map
,
630 basic_block new_bb
= split_edge (next_e
);
631 rename_map_type rename_map
;
632 rename_map
.create (10);
634 next_e
= single_succ_edge (new_bb
);
635 graphite_copy_stmts_from_block (bb
, new_bb
, rename_map
, iv_map
, region
,
637 remove_phi_nodes (new_bb
);
638 rename_map
.dispose ();
643 /* Returns the outermost loop in SCOP that contains BB. */
646 outermost_loop_in_sese (sese region
, basic_block bb
)
650 nest
= bb
->loop_father
;
651 while (loop_outer (nest
)
652 && loop_in_sese_p (loop_outer (nest
), region
))
653 nest
= loop_outer (nest
);
658 /* Sets the false region of an IF_REGION to REGION. */
661 if_region_set_false_region (ifsese if_region
, sese region
)
663 basic_block condition
= if_region_get_condition_block (if_region
);
664 edge false_edge
= get_false_edge_from_guard_bb (condition
);
665 basic_block dummy
= false_edge
->dest
;
666 edge entry_region
= SESE_ENTRY (region
);
667 edge exit_region
= SESE_EXIT (region
);
668 basic_block before_region
= entry_region
->src
;
669 basic_block last_in_region
= exit_region
->src
;
670 void **slot
= htab_find_slot_with_hash (current_loops
->exits
, exit_region
,
671 htab_hash_pointer (exit_region
),
674 entry_region
->flags
= false_edge
->flags
;
675 false_edge
->flags
= exit_region
->flags
;
677 redirect_edge_pred (entry_region
, condition
);
678 redirect_edge_pred (exit_region
, before_region
);
679 redirect_edge_pred (false_edge
, last_in_region
);
680 redirect_edge_succ (false_edge
, single_succ (dummy
));
681 delete_basic_block (dummy
);
683 exit_region
->flags
= EDGE_FALLTHRU
;
684 recompute_all_dominators ();
686 SESE_EXIT (region
) = false_edge
;
688 free (if_region
->false_region
);
689 if_region
->false_region
= region
;
693 struct loop_exit
*loop_exit
= ggc_alloc_cleared_loop_exit ();
695 memcpy (loop_exit
, *((struct loop_exit
**) slot
), sizeof (struct loop_exit
));
696 htab_clear_slot (current_loops
->exits
, slot
);
698 slot
= htab_find_slot_with_hash (current_loops
->exits
, false_edge
,
699 htab_hash_pointer (false_edge
),
701 loop_exit
->e
= false_edge
;
703 false_edge
->src
->loop_father
->exits
->next
= loop_exit
;
707 /* Creates an IFSESE with CONDITION on edge ENTRY. */
710 create_if_region_on_edge (edge entry
, tree condition
)
714 sese sese_region
= XNEW (struct sese_s
);
715 sese true_region
= XNEW (struct sese_s
);
716 sese false_region
= XNEW (struct sese_s
);
717 ifsese if_region
= XNEW (struct ifsese_s
);
718 edge exit
= create_empty_if_region_on_edge (entry
, condition
);
720 if_region
->region
= sese_region
;
721 if_region
->region
->entry
= entry
;
722 if_region
->region
->exit
= exit
;
724 FOR_EACH_EDGE (e
, ei
, entry
->dest
->succs
)
726 if (e
->flags
& EDGE_TRUE_VALUE
)
728 true_region
->entry
= e
;
729 true_region
->exit
= single_succ_edge (e
->dest
);
730 if_region
->true_region
= true_region
;
732 else if (e
->flags
& EDGE_FALSE_VALUE
)
734 false_region
->entry
= e
;
735 false_region
->exit
= single_succ_edge (e
->dest
);
736 if_region
->false_region
= false_region
;
743 /* Moves REGION in a condition expression:
751 move_sese_in_condition (sese region
)
753 basic_block pred_block
= split_edge (SESE_ENTRY (region
));
756 SESE_ENTRY (region
) = single_succ_edge (pred_block
);
757 if_region
= create_if_region_on_edge (single_pred_edge (pred_block
), integer_one_node
);
758 if_region_set_false_region (if_region
, region
);
763 /* Replaces the condition of the IF_REGION with CONDITION:
771 set_ifsese_condition (ifsese if_region
, tree condition
)
773 sese region
= if_region
->region
;
774 edge entry
= region
->entry
;
775 basic_block bb
= entry
->dest
;
776 gimple last
= last_stmt (bb
);
777 gimple_stmt_iterator gsi
= gsi_last_bb (bb
);
780 gcc_assert (gimple_code (last
) == GIMPLE_COND
);
782 gsi_remove (&gsi
, true);
783 gsi
= gsi_last_bb (bb
);
784 condition
= force_gimple_operand_gsi (&gsi
, condition
, true, NULL
,
785 false, GSI_NEW_STMT
);
786 cond_stmt
= gimple_build_cond_from_tree (condition
, NULL_TREE
, NULL_TREE
);
787 gsi
= gsi_last_bb (bb
);
788 gsi_insert_after (&gsi
, cond_stmt
, GSI_NEW_STMT
);
791 /* Returns the scalar evolution of T in REGION. Every variable that
792 is not defined in the REGION is considered a parameter. */
795 scalar_evolution_in_region (sese region
, loop_p loop
, tree t
)
798 struct loop
*def_loop
;
799 basic_block before
= block_before_sese (region
);
801 /* SCOP parameters. */
802 if (TREE_CODE (t
) == SSA_NAME
803 && !defined_in_sese_p (t
, region
))
806 if (TREE_CODE (t
) != SSA_NAME
807 || loop_in_sese_p (loop
, region
))
808 return instantiate_scev (before
, loop
,
809 analyze_scalar_evolution (loop
, t
));
811 def
= SSA_NAME_DEF_STMT (t
);
812 def_loop
= loop_containing_stmt (def
);
814 if (loop_in_sese_p (def_loop
, region
))
816 t
= analyze_scalar_evolution (def_loop
, t
);
817 def_loop
= superloop_at_depth (def_loop
, loop_depth (loop
) + 1);
818 t
= compute_overall_effect_of_inner_loop (def_loop
, t
);
822 return instantiate_scev (before
, loop
, t
);