1 /* Iterator routines for GIMPLE statements.
2 Copyright (C) 2007-2013 Free Software Foundation, Inc.
3 Contributed by Aldy Hernandez <aldy@quesejoda.com>
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 3, or (at your option) any later
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
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"
27 #include "gimple-iterator.h"
28 #include "gimple-ssa.h"
31 #include "tree-phinodes.h"
32 #include "ssa-iterators.h"
34 #include "value-prof.h"
37 /* Mark the statement STMT as modified, and update it. */
40 update_modified_stmt (gimple stmt
)
42 if (!ssa_operands_active (cfun
))
44 update_stmt_if_modified (stmt
);
48 /* Mark the statements in SEQ as modified, and update them. */
51 update_modified_stmts (gimple_seq seq
)
53 gimple_stmt_iterator gsi
;
55 if (!ssa_operands_active (cfun
))
57 for (gsi
= gsi_start (seq
); !gsi_end_p (gsi
); gsi_next (&gsi
))
58 update_stmt_if_modified (gsi_stmt (gsi
));
62 /* Set BB to be the basic block for all the statements in the list
63 starting at FIRST and LAST. */
66 update_bb_for_stmts (gimple_seq_node first
, gimple_seq_node last
,
71 for (n
= first
; n
; n
= n
->gsbase
.next
)
73 gimple_set_bb (n
, bb
);
79 /* Set the frequencies for the cgraph_edges for each of the calls
80 starting at FIRST for their new position within BB. */
83 update_call_edge_frequencies (gimple_seq_node first
, basic_block bb
)
85 struct cgraph_node
*cfun_node
= NULL
;
89 for (n
= first
; n
; n
= n
->gsbase
.next
)
90 if (is_gimple_call (n
))
92 struct cgraph_edge
*e
;
94 /* These function calls are expensive enough that we want
95 to avoid calling them if we never see any calls. */
96 if (cfun_node
== NULL
)
98 cfun_node
= cgraph_get_node (current_function_decl
);
99 bb_freq
= (compute_call_stmt_bb_frequency
100 (current_function_decl
, bb
));
103 e
= cgraph_edge (cfun_node
, n
);
105 e
->frequency
= bb_freq
;
109 /* Insert the sequence delimited by nodes FIRST and LAST before
110 iterator I. M specifies how to update iterator I after insertion
111 (see enum gsi_iterator_update).
113 This routine assumes that there is a forward and backward path
114 between FIRST and LAST (i.e., they are linked in a doubly-linked
115 list). Additionally, if FIRST == LAST, this routine will properly
116 insert a single node. */
119 gsi_insert_seq_nodes_before (gimple_stmt_iterator
*i
,
120 gimple_seq_node first
,
121 gimple_seq_node last
,
122 enum gsi_iterator_update mode
)
125 gimple_seq_node cur
= i
->ptr
;
127 gcc_assert (!cur
|| cur
->gsbase
.prev
);
129 if ((bb
= gsi_bb (*i
)) != NULL
)
130 update_bb_for_stmts (first
, last
, bb
);
132 /* Link SEQ before CUR in the sequence. */
135 first
->gsbase
.prev
= cur
->gsbase
.prev
;
136 if (first
->gsbase
.prev
->gsbase
.next
)
137 first
->gsbase
.prev
->gsbase
.next
= first
;
139 gimple_seq_set_first (i
->seq
, first
);
140 last
->gsbase
.next
= cur
;
141 cur
->gsbase
.prev
= last
;
145 gimple_seq_node itlast
= gimple_seq_last (*i
->seq
);
147 /* If CUR is NULL, we link at the end of the sequence (this case happens
148 when gsi_after_labels is called for a basic block that contains only
149 labels, so it returns an iterator after the end of the block, and
150 we need to insert before it; it might be cleaner to add a flag to the
151 iterator saying whether we are at the start or end of the list). */
152 last
->gsbase
.next
= NULL
;
155 first
->gsbase
.prev
= itlast
;
156 itlast
->gsbase
.next
= first
;
159 gimple_seq_set_first (i
->seq
, first
);
160 gimple_seq_set_last (i
->seq
, last
);
163 /* Update the iterator, if requested. */
167 case GSI_CONTINUE_LINKING
:
178 /* Inserts the sequence of statements SEQ before the statement pointed
179 by iterator I. MODE indicates what to do with the iterator after
180 insertion (see enum gsi_iterator_update).
182 This function does not scan for new operands. It is provided for
183 the use of the gimplifier, which manipulates statements for which
184 def/use information has not yet been constructed. Most callers
185 should use gsi_insert_seq_before. */
188 gsi_insert_seq_before_without_update (gimple_stmt_iterator
*i
, gimple_seq seq
,
189 enum gsi_iterator_update mode
)
191 gimple_seq_node first
, last
;
196 /* Don't allow inserting a sequence into itself. */
197 gcc_assert (seq
!= *i
->seq
);
199 first
= gimple_seq_first (seq
);
200 last
= gimple_seq_last (seq
);
202 /* Empty sequences need no work. */
205 gcc_assert (first
== last
);
209 gsi_insert_seq_nodes_before (i
, first
, last
, mode
);
213 /* Inserts the sequence of statements SEQ before the statement pointed
214 by iterator I. MODE indicates what to do with the iterator after
215 insertion (see enum gsi_iterator_update). Scan the statements in SEQ
219 gsi_insert_seq_before (gimple_stmt_iterator
*i
, gimple_seq seq
,
220 enum gsi_iterator_update mode
)
222 update_modified_stmts (seq
);
223 gsi_insert_seq_before_without_update (i
, seq
, mode
);
227 /* Insert the sequence delimited by nodes FIRST and LAST after
228 iterator I. M specifies how to update iterator I after insertion
229 (see enum gsi_iterator_update).
231 This routine assumes that there is a forward and backward path
232 between FIRST and LAST (i.e., they are linked in a doubly-linked
233 list). Additionally, if FIRST == LAST, this routine will properly
234 insert a single node. */
237 gsi_insert_seq_nodes_after (gimple_stmt_iterator
*i
,
238 gimple_seq_node first
,
239 gimple_seq_node last
,
240 enum gsi_iterator_update m
)
243 gimple_seq_node cur
= i
->ptr
;
245 gcc_assert (!cur
|| cur
->gsbase
.prev
);
247 /* If the iterator is inside a basic block, we need to update the
248 basic block information for all the nodes between FIRST and LAST. */
249 if ((bb
= gsi_bb (*i
)) != NULL
)
250 update_bb_for_stmts (first
, last
, bb
);
252 /* Link SEQ after CUR. */
255 last
->gsbase
.next
= cur
->gsbase
.next
;
256 if (last
->gsbase
.next
)
258 last
->gsbase
.next
->gsbase
.prev
= last
;
261 gimple_seq_set_last (i
->seq
, last
);
262 first
->gsbase
.prev
= cur
;
263 cur
->gsbase
.next
= first
;
267 gcc_assert (!gimple_seq_last (*i
->seq
));
268 last
->gsbase
.next
= NULL
;
269 gimple_seq_set_first (i
->seq
, first
);
270 gimple_seq_set_last (i
->seq
, last
);
273 /* Update the iterator, if requested. */
279 case GSI_CONTINUE_LINKING
:
291 /* Links sequence SEQ after the statement pointed-to by iterator I.
292 MODE is as in gsi_insert_after.
294 This function does not scan for new operands. It is provided for
295 the use of the gimplifier, which manipulates statements for which
296 def/use information has not yet been constructed. Most callers
297 should use gsi_insert_seq_after. */
300 gsi_insert_seq_after_without_update (gimple_stmt_iterator
*i
, gimple_seq seq
,
301 enum gsi_iterator_update mode
)
303 gimple_seq_node first
, last
;
308 /* Don't allow inserting a sequence into itself. */
309 gcc_assert (seq
!= *i
->seq
);
311 first
= gimple_seq_first (seq
);
312 last
= gimple_seq_last (seq
);
314 /* Empty sequences need no work. */
317 gcc_assert (first
== last
);
321 gsi_insert_seq_nodes_after (i
, first
, last
, mode
);
325 /* Links sequence SEQ after the statement pointed-to by iterator I.
326 MODE is as in gsi_insert_after. Scan the statements in SEQ
330 gsi_insert_seq_after (gimple_stmt_iterator
*i
, gimple_seq seq
,
331 enum gsi_iterator_update mode
)
333 update_modified_stmts (seq
);
334 gsi_insert_seq_after_without_update (i
, seq
, mode
);
338 /* Move all statements in the sequence after I to a new sequence.
339 Return this new sequence. */
342 gsi_split_seq_after (gimple_stmt_iterator i
)
344 gimple_seq_node cur
, next
;
345 gimple_seq
*pold_seq
, new_seq
;
349 /* How can we possibly split after the end, or before the beginning? */
350 gcc_assert (cur
&& cur
->gsbase
.next
);
351 next
= cur
->gsbase
.next
;
355 gimple_seq_set_first (&new_seq
, next
);
356 gimple_seq_set_last (&new_seq
, gimple_seq_last (*pold_seq
));
357 gimple_seq_set_last (pold_seq
, cur
);
358 cur
->gsbase
.next
= NULL
;
364 /* Set the statement to which GSI points to STMT. This only updates
365 the iterator and the gimple sequence, it doesn't do the bookkeeping
369 gsi_set_stmt (gimple_stmt_iterator
*gsi
, gimple stmt
)
371 gimple orig_stmt
= gsi_stmt (*gsi
);
374 stmt
->gsbase
.next
= next
= orig_stmt
->gsbase
.next
;
375 stmt
->gsbase
.prev
= prev
= orig_stmt
->gsbase
.prev
;
376 /* Note how we don't clear next/prev of orig_stmt. This is so that
377 copies of *GSI our callers might still hold (to orig_stmt)
378 can be advanced as if they too were replaced. */
379 if (prev
->gsbase
.next
)
380 prev
->gsbase
.next
= stmt
;
382 gimple_seq_set_first (gsi
->seq
, stmt
);
384 next
->gsbase
.prev
= stmt
;
386 gimple_seq_set_last (gsi
->seq
, stmt
);
392 /* Move all statements in the sequence before I to a new sequence.
393 Return this new sequence. I is set to the head of the new list. */
396 gsi_split_seq_before (gimple_stmt_iterator
*i
, gimple_seq
*pnew_seq
)
398 gimple_seq_node cur
, prev
;
403 /* How can we possibly split after the end? */
405 prev
= cur
->gsbase
.prev
;
408 if (!prev
->gsbase
.next
)
412 /* Set the limits on NEW_SEQ. */
413 gimple_seq_set_first (pnew_seq
, cur
);
414 gimple_seq_set_last (pnew_seq
, gimple_seq_last (old_seq
));
416 /* Cut OLD_SEQ before I. */
417 gimple_seq_set_last (&old_seq
, prev
);
418 if (prev
->gsbase
.next
)
419 prev
->gsbase
.next
= NULL
;
423 /* Replace the statement pointed-to by GSI to STMT. If UPDATE_EH_INFO
424 is true, the exception handling information of the original
425 statement is moved to the new statement. Assignments must only be
426 replaced with assignments to the same LHS. */
429 gsi_replace (gimple_stmt_iterator
*gsi
, gimple stmt
, bool update_eh_info
)
431 gimple orig_stmt
= gsi_stmt (*gsi
);
433 if (stmt
== orig_stmt
)
436 gcc_assert (!gimple_has_lhs (orig_stmt
) || !gimple_has_lhs (stmt
)
437 || gimple_get_lhs (orig_stmt
) == gimple_get_lhs (stmt
));
439 gimple_set_location (stmt
, gimple_location (orig_stmt
));
440 gimple_set_bb (stmt
, gsi_bb (*gsi
));
442 /* Preserve EH region information from the original statement, if
443 requested by the caller. */
445 maybe_clean_or_replace_eh_stmt (orig_stmt
, stmt
);
447 gimple_duplicate_stmt_histograms (cfun
, stmt
, cfun
, orig_stmt
);
449 /* Free all the data flow information for ORIG_STMT. */
450 gimple_set_bb (orig_stmt
, NULL
);
451 gimple_remove_stmt_histograms (cfun
, orig_stmt
);
452 delink_stmt_imm_use (orig_stmt
);
454 gsi_set_stmt (gsi
, stmt
);
455 gimple_set_modified (stmt
, true);
456 update_modified_stmt (stmt
);
460 /* Replace the statement pointed-to by GSI with the sequence SEQ.
461 If UPDATE_EH_INFO is true, the exception handling information of
462 the original statement is moved to the last statement of the new
463 sequence. If the old statement is an assignment, then so must
464 be the last statement of the new sequence, and they must have the
468 gsi_replace_with_seq (gimple_stmt_iterator
*gsi
, gimple_seq seq
,
471 gimple_stmt_iterator seqi
;
473 if (gimple_seq_empty_p (seq
))
475 gsi_remove (gsi
, true);
478 seqi
= gsi_last (seq
);
479 last
= gsi_stmt (seqi
);
480 gsi_remove (&seqi
, false);
481 gsi_insert_seq_before (gsi
, seq
, GSI_SAME_STMT
);
482 gsi_replace (gsi
, last
, update_eh_info
);
486 /* Insert statement STMT before the statement pointed-to by iterator I.
487 M specifies how to update iterator I after insertion (see enum
488 gsi_iterator_update).
490 This function does not scan for new operands. It is provided for
491 the use of the gimplifier, which manipulates statements for which
492 def/use information has not yet been constructed. Most callers
493 should use gsi_insert_before. */
496 gsi_insert_before_without_update (gimple_stmt_iterator
*i
, gimple stmt
,
497 enum gsi_iterator_update m
)
499 gsi_insert_seq_nodes_before (i
, stmt
, stmt
, m
);
502 /* Insert statement STMT before the statement pointed-to by iterator I.
503 Update STMT's basic block and scan it for new operands. M
504 specifies how to update iterator I after insertion (see enum
505 gsi_iterator_update). */
508 gsi_insert_before (gimple_stmt_iterator
*i
, gimple stmt
,
509 enum gsi_iterator_update m
)
511 update_modified_stmt (stmt
);
512 gsi_insert_before_without_update (i
, stmt
, m
);
516 /* Insert statement STMT after the statement pointed-to by iterator I.
517 M specifies how to update iterator I after insertion (see enum
518 gsi_iterator_update).
520 This function does not scan for new operands. It is provided for
521 the use of the gimplifier, which manipulates statements for which
522 def/use information has not yet been constructed. Most callers
523 should use gsi_insert_after. */
526 gsi_insert_after_without_update (gimple_stmt_iterator
*i
, gimple stmt
,
527 enum gsi_iterator_update m
)
529 gsi_insert_seq_nodes_after (i
, stmt
, stmt
, m
);
533 /* Insert statement STMT after the statement pointed-to by iterator I.
534 Update STMT's basic block and scan it for new operands. M
535 specifies how to update iterator I after insertion (see enum
536 gsi_iterator_update). */
539 gsi_insert_after (gimple_stmt_iterator
*i
, gimple stmt
,
540 enum gsi_iterator_update m
)
542 update_modified_stmt (stmt
);
543 gsi_insert_after_without_update (i
, stmt
, m
);
547 /* Remove the current stmt from the sequence. The iterator is updated
548 to point to the next statement.
550 REMOVE_PERMANENTLY is true when the statement is going to be removed
551 from the IL and not reinserted elsewhere. In that case we remove the
552 statement pointed to by iterator I from the EH tables, and free its
553 operand caches. Otherwise we do not modify this information. Returns
554 true whether EH edge cleanup is required. */
557 gsi_remove (gimple_stmt_iterator
*i
, bool remove_permanently
)
559 gimple_seq_node cur
, next
, prev
;
560 gimple stmt
= gsi_stmt (*i
);
561 bool require_eh_edge_purge
= false;
563 if (gimple_code (stmt
) != GIMPLE_PHI
)
564 insert_debug_temps_for_defs (i
);
566 /* Free all the data flow information for STMT. */
567 gimple_set_bb (stmt
, NULL
);
568 delink_stmt_imm_use (stmt
);
569 gimple_set_modified (stmt
, true);
571 if (remove_permanently
)
573 require_eh_edge_purge
= remove_stmt_from_eh_lp (stmt
);
574 gimple_remove_stmt_histograms (cfun
, stmt
);
577 /* Update the iterator and re-wire the links in I->SEQ. */
579 next
= cur
->gsbase
.next
;
580 prev
= cur
->gsbase
.prev
;
581 /* See gsi_set_stmt for why we don't reset prev/next of STMT. */
584 /* Cur is not last. */
585 next
->gsbase
.prev
= prev
;
586 else if (prev
->gsbase
.next
)
587 /* Cur is last but not first. */
588 gimple_seq_set_last (i
->seq
, prev
);
590 if (prev
->gsbase
.next
)
591 /* Cur is not first. */
592 prev
->gsbase
.next
= next
;
599 return require_eh_edge_purge
;
603 /* Finds iterator for STMT. */
606 gsi_for_stmt (gimple stmt
)
608 gimple_stmt_iterator i
;
609 basic_block bb
= gimple_bb (stmt
);
611 if (gimple_code (stmt
) == GIMPLE_PHI
)
612 i
= gsi_start_phis (bb
);
614 i
= gsi_start_bb (bb
);
621 /* Move the statement at FROM so it comes right after the statement at TO. */
624 gsi_move_after (gimple_stmt_iterator
*from
, gimple_stmt_iterator
*to
)
626 gimple stmt
= gsi_stmt (*from
);
627 gsi_remove (from
, false);
629 /* We must have GSI_NEW_STMT here, as gsi_move_after is sometimes used to
630 move statements to an empty block. */
631 gsi_insert_after (to
, stmt
, GSI_NEW_STMT
);
635 /* Move the statement at FROM so it comes right before the statement
639 gsi_move_before (gimple_stmt_iterator
*from
, gimple_stmt_iterator
*to
)
641 gimple stmt
= gsi_stmt (*from
);
642 gsi_remove (from
, false);
644 /* For consistency with gsi_move_after, it might be better to have
645 GSI_NEW_STMT here; however, that breaks several places that expect
646 that TO does not change. */
647 gsi_insert_before (to
, stmt
, GSI_SAME_STMT
);
651 /* Move the statement at FROM to the end of basic block BB. */
654 gsi_move_to_bb_end (gimple_stmt_iterator
*from
, basic_block bb
)
656 gimple_stmt_iterator last
= gsi_last_bb (bb
);
657 gcc_checking_assert (gsi_bb (last
) == bb
);
659 /* Have to check gsi_end_p because it could be an empty block. */
660 if (!gsi_end_p (last
) && is_ctrl_stmt (gsi_stmt (last
)))
661 gsi_move_before (from
, &last
);
663 gsi_move_after (from
, &last
);
667 /* Add STMT to the pending list of edge E. No actual insertion is
668 made until a call to gsi_commit_edge_inserts () is made. */
671 gsi_insert_on_edge (edge e
, gimple stmt
)
673 gimple_seq_add_stmt (&PENDING_STMT (e
), stmt
);
676 /* Add the sequence of statements SEQ to the pending list of edge E.
677 No actual insertion is made until a call to gsi_commit_edge_inserts
681 gsi_insert_seq_on_edge (edge e
, gimple_seq seq
)
683 gimple_seq_add_seq (&PENDING_STMT (e
), seq
);
687 /* Insert the statement pointed-to by GSI into edge E. Every attempt
688 is made to place the statement in an existing basic block, but
689 sometimes that isn't possible. When it isn't possible, the edge is
690 split and the statement is added to the new block.
692 In all cases, the returned *GSI points to the correct location. The
693 return value is true if insertion should be done after the location,
694 or false if it should be done before the location. If a new basic block
695 has to be created, it is stored in *NEW_BB. */
698 gimple_find_edge_insert_loc (edge e
, gimple_stmt_iterator
*gsi
,
701 basic_block dest
, src
;
706 /* If the destination has one predecessor which has no PHI nodes,
707 insert there. Except for the exit block.
709 The requirement for no PHI nodes could be relaxed. Basically we
710 would have to examine the PHIs to prove that none of them used
711 the value set by the statement we want to insert on E. That
712 hardly seems worth the effort. */
714 if (single_pred_p (dest
)
715 && gimple_seq_empty_p (phi_nodes (dest
))
716 && dest
!= EXIT_BLOCK_PTR
)
718 *gsi
= gsi_start_bb (dest
);
719 if (gsi_end_p (*gsi
))
722 /* Make sure we insert after any leading labels. */
723 tmp
= gsi_stmt (*gsi
);
724 while (gimple_code (tmp
) == GIMPLE_LABEL
)
727 if (gsi_end_p (*gsi
))
729 tmp
= gsi_stmt (*gsi
);
732 if (gsi_end_p (*gsi
))
734 *gsi
= gsi_last_bb (dest
);
741 /* If the source has one successor, the edge is not abnormal and
742 the last statement does not end a basic block, insert there.
743 Except for the entry block. */
745 if ((e
->flags
& EDGE_ABNORMAL
) == 0
746 && single_succ_p (src
)
747 && src
!= ENTRY_BLOCK_PTR
)
749 *gsi
= gsi_last_bb (src
);
750 if (gsi_end_p (*gsi
))
753 tmp
= gsi_stmt (*gsi
);
754 if (!stmt_ends_bb_p (tmp
))
757 switch (gimple_code (tmp
))
767 /* Otherwise, create a new basic block, and split this edge. */
768 dest
= split_edge (e
);
771 e
= single_pred_edge (dest
);
776 /* Similar to gsi_insert_on_edge+gsi_commit_edge_inserts. If a new
777 block has to be created, it is returned. */
780 gsi_insert_on_edge_immediate (edge e
, gimple stmt
)
782 gimple_stmt_iterator gsi
;
783 basic_block new_bb
= NULL
;
786 gcc_assert (!PENDING_STMT (e
));
788 ins_after
= gimple_find_edge_insert_loc (e
, &gsi
, &new_bb
);
790 update_call_edge_frequencies (stmt
, gsi
.bb
);
793 gsi_insert_after (&gsi
, stmt
, GSI_NEW_STMT
);
795 gsi_insert_before (&gsi
, stmt
, GSI_NEW_STMT
);
800 /* Insert STMTS on edge E. If a new block has to be created, it
804 gsi_insert_seq_on_edge_immediate (edge e
, gimple_seq stmts
)
806 gimple_stmt_iterator gsi
;
807 basic_block new_bb
= NULL
;
810 gcc_assert (!PENDING_STMT (e
));
812 ins_after
= gimple_find_edge_insert_loc (e
, &gsi
, &new_bb
);
813 update_call_edge_frequencies (gimple_seq_first (stmts
), gsi
.bb
);
816 gsi_insert_seq_after (&gsi
, stmts
, GSI_NEW_STMT
);
818 gsi_insert_seq_before (&gsi
, stmts
, GSI_NEW_STMT
);
823 /* This routine will commit all pending edge insertions, creating any new
824 basic blocks which are necessary. */
827 gsi_commit_edge_inserts (void)
833 gsi_commit_one_edge_insert (single_succ_edge (ENTRY_BLOCK_PTR
), NULL
);
836 FOR_EACH_EDGE (e
, ei
, bb
->succs
)
837 gsi_commit_one_edge_insert (e
, NULL
);
841 /* Commit insertions pending at edge E. If a new block is created, set NEW_BB
842 to this block, otherwise set it to NULL. */
845 gsi_commit_one_edge_insert (edge e
, basic_block
*new_bb
)
850 if (PENDING_STMT (e
))
852 gimple_stmt_iterator gsi
;
853 gimple_seq seq
= PENDING_STMT (e
);
856 PENDING_STMT (e
) = NULL
;
858 ins_after
= gimple_find_edge_insert_loc (e
, &gsi
, new_bb
);
859 update_call_edge_frequencies (gimple_seq_first (seq
), gsi
.bb
);
862 gsi_insert_seq_after (&gsi
, seq
, GSI_NEW_STMT
);
864 gsi_insert_seq_before (&gsi
, seq
, GSI_NEW_STMT
);
868 /* Returns iterator at the start of the list of phi nodes of BB. */
871 gsi_start_phis (basic_block bb
)
873 gimple_seq
*pseq
= phi_nodes_ptr (bb
);
874 return gsi_start_1 (pseq
);