1 /* Header file for gimple iterators.
2 Copyright (C) 2013-2024 Free Software Foundation, Inc.
4 This file is part of GCC.
6 GCC is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 3, or (at your option) any later
11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 You should have received a copy of the GNU General Public License
17 along with GCC; see the file COPYING3. If not see
18 <http://www.gnu.org/licenses/>. */
20 #ifndef GCC_GIMPLE_ITERATOR_H
21 #define GCC_GIMPLE_ITERATOR_H
23 /* Iterator object for GIMPLE statement sequences. */
25 struct gimple_stmt_iterator
27 gimple
*operator * () const { return ptr
; }
29 /* Sequence node holding the current statement. */
32 /* Sequence and basic block holding the statement. These fields
33 are necessary to handle edge cases such as when statement is
34 added to an empty basic block or when the last statement of a
35 block/sequence is removed. */
40 /* Iterator over GIMPLE_PHI statements. */
41 struct gphi_iterator
: public gimple_stmt_iterator
43 gphi
*operator * () const { return as_a
<gphi
*> (ptr
); }
47 return as_a
<gphi
*> (ptr
);
51 enum gsi_iterator_update
53 GSI_NEW_STMT
= 2, /* Move the iterator to the first statement added. */
54 GSI_LAST_NEW_STMT
, /* Move the iterator to the last statement added. */
55 GSI_SAME_STMT
, /* Leave the iterator at the same statement. */
56 GSI_CONTINUE_LINKING
/* Move iterator to whatever position is suitable
57 for linking other statements in the same
61 extern void gsi_insert_seq_before_without_update (gimple_stmt_iterator
*,
63 enum gsi_iterator_update
);
64 extern void gsi_insert_seq_before (gimple_stmt_iterator
*, gimple_seq
,
65 enum gsi_iterator_update
);
66 extern void gsi_insert_seq_after_without_update (gimple_stmt_iterator
*,
68 enum gsi_iterator_update
);
69 extern void gsi_insert_seq_after (gimple_stmt_iterator
*, gimple_seq
,
70 enum gsi_iterator_update
);
71 extern gimple_seq
gsi_split_seq_after (gimple_stmt_iterator
);
72 extern void gsi_set_stmt (gimple_stmt_iterator
*, gimple
*);
73 extern void gsi_split_seq_before (gimple_stmt_iterator
*, gimple_seq
*);
74 extern bool gsi_replace (gimple_stmt_iterator
*, gimple
*, bool);
75 extern void gsi_replace_with_seq (gimple_stmt_iterator
*, gimple_seq
, bool);
76 extern void gsi_insert_before_without_update (gimple_stmt_iterator
*, gimple
*,
77 enum gsi_iterator_update
);
78 extern void gsi_insert_before (gimple_stmt_iterator
*, gimple
*,
79 enum gsi_iterator_update
);
80 extern void gsi_insert_after_without_update (gimple_stmt_iterator
*, gimple
*,
81 enum gsi_iterator_update
);
82 extern void gsi_insert_after (gimple_stmt_iterator
*, gimple
*,
83 enum gsi_iterator_update
);
84 extern bool gsi_remove (gimple_stmt_iterator
*, bool);
85 extern gimple_stmt_iterator
gsi_for_stmt (gimple
*);
86 extern gimple_stmt_iterator
gsi_for_stmt (gimple
*, gimple_seq
*);
87 extern gphi_iterator
gsi_for_phi (gphi
*);
88 extern void gsi_move_after (gimple_stmt_iterator
*, gimple_stmt_iterator
*);
89 extern void gsi_move_before (gimple_stmt_iterator
*, gimple_stmt_iterator
*,
90 gsi_iterator_update
= GSI_SAME_STMT
);
91 extern void gsi_move_to_bb_end (gimple_stmt_iterator
*, basic_block
);
92 extern void gsi_insert_on_edge (edge
, gimple
*);
93 extern void gsi_insert_seq_on_edge (edge
, gimple_seq
);
94 extern basic_block
gsi_insert_on_edge_immediate (edge
, gimple
*);
95 extern basic_block
gsi_insert_seq_on_edge_immediate (edge
, gimple_seq
);
96 extern void gsi_commit_edge_inserts (void);
97 extern void gsi_commit_one_edge_insert (edge
, basic_block
*);
98 extern gphi_iterator
gsi_start_phis (basic_block
);
99 extern void update_modified_stmts (gimple_seq
);
101 /* Return a new iterator pointing to GIMPLE_SEQ's first statement. */
103 inline gimple_stmt_iterator
104 gsi_start (gimple_seq
&seq
)
106 gimple_stmt_iterator i
;
108 i
.ptr
= gimple_seq_first (seq
);
110 i
.bb
= i
.ptr
? gimple_bb (i
.ptr
) : NULL
;
115 inline gimple_stmt_iterator
118 gimple_stmt_iterator i
;
125 /* Return a new iterator pointing to the first statement in basic block BB. */
127 inline gimple_stmt_iterator
128 gsi_start_bb (basic_block bb
)
130 gimple_stmt_iterator i
;
133 seq
= bb_seq_addr (bb
);
134 i
.ptr
= gimple_seq_first (*seq
);
141 gimple_stmt_iterator
gsi_start_edge (edge e
);
143 /* Return a new iterator initially pointing to GIMPLE_SEQ's last statement. */
145 inline gimple_stmt_iterator
146 gsi_last (gimple_seq
&seq
)
148 gimple_stmt_iterator i
;
150 i
.ptr
= gimple_seq_last (seq
);
152 i
.bb
= i
.ptr
? gimple_bb (i
.ptr
) : NULL
;
157 /* Return a new iterator pointing to the last statement in basic block BB. */
159 inline gimple_stmt_iterator
160 gsi_last_bb (basic_block bb
)
162 gimple_stmt_iterator i
;
165 seq
= bb_seq_addr (bb
);
166 i
.ptr
= gimple_seq_last (*seq
);
173 /* Return a new iterator pointing to before the first statement or after
174 last statement (depending on whether adding statements after it or before it)
177 inline gimple_stmt_iterator
178 gsi_end (gimple_seq
&seq
)
180 gimple_stmt_iterator i
;
181 gimple
*g
= gimple_seq_last (seq
);
185 i
.bb
= g
? gimple_bb (g
) : NULL
;
190 /* Return a new iterator pointing to before the first statement or after
191 last statement (depending on whether adding statements after it or before it)
192 in basic block BB. */
194 inline gimple_stmt_iterator
195 gsi_end_bb (basic_block bb
)
197 gimple_stmt_iterator i
;
200 seq
= bb_seq_addr (bb
);
208 /* Return true if I is at the end of its sequence. */
211 gsi_end_p (gimple_stmt_iterator i
)
213 return i
.ptr
== NULL
;
216 /* Return true if I is one statement before the end of its sequence. */
219 gsi_one_before_end_p (gimple_stmt_iterator i
)
221 return i
.ptr
!= NULL
&& i
.ptr
->next
== NULL
;
224 /* Advance the iterator to the next gimple statement. */
227 gsi_next (gimple_stmt_iterator
*i
)
229 i
->ptr
= i
->ptr
->next
;
232 /* Advance the iterator to the previous gimple statement. */
235 gsi_prev (gimple_stmt_iterator
*i
)
237 gimple
*prev
= i
->ptr
->prev
;
244 /* Return the current stmt. */
247 gsi_stmt (gimple_stmt_iterator i
)
252 /* Return a block statement iterator that points to the first
253 non-label statement in block BB. */
255 inline gimple_stmt_iterator
256 gsi_after_labels (basic_block bb
)
258 gimple_stmt_iterator gsi
= gsi_start_bb (bb
);
260 for (; !gsi_end_p (gsi
); )
262 if (gimple_code (gsi_stmt (gsi
)) == GIMPLE_LABEL
)
271 /* Return a statement iterator that points to the first
272 non-label statement in sequence SEQ. */
274 inline gimple_stmt_iterator
275 gsi_after_labels (gimple_seq
&seq
)
277 gimple_stmt_iterator gsi
= gsi_start (seq
);
279 for (; !gsi_end_p (gsi
); )
281 if (gimple_code (gsi_stmt (gsi
)) == GIMPLE_LABEL
)
290 /* Advance the iterator to the next non-debug gimple statement. */
293 gsi_next_nondebug (gimple_stmt_iterator
*i
)
299 while (!gsi_end_p (*i
) && is_gimple_debug (gsi_stmt (*i
)));
302 /* Advance the iterator to the previous non-debug gimple statement. */
305 gsi_prev_nondebug (gimple_stmt_iterator
*i
)
311 while (!gsi_end_p (*i
) && is_gimple_debug (gsi_stmt (*i
)));
314 /* Return a new iterator pointing to the first non-debug statement in
317 inline gimple_stmt_iterator
318 gsi_start_nondebug (gimple_seq seq
)
320 gimple_stmt_iterator gsi
= gsi_start (seq
);
321 if (!gsi_end_p (gsi
) && is_gimple_debug (gsi_stmt (gsi
)))
322 gsi_next_nondebug (&gsi
);
327 /* Return a new iterator pointing to the first non-debug statement in
330 inline gimple_stmt_iterator
331 gsi_start_nondebug_bb (basic_block bb
)
333 gimple_stmt_iterator i
= gsi_start_bb (bb
);
335 if (!gsi_end_p (i
) && is_gimple_debug (gsi_stmt (i
)))
336 gsi_next_nondebug (&i
);
341 /* Return a new iterator pointing to the first non-debug non-label statement in
344 inline gimple_stmt_iterator
345 gsi_start_nondebug_after_labels_bb (basic_block bb
)
347 gimple_stmt_iterator i
= gsi_after_labels (bb
);
349 if (!gsi_end_p (i
) && is_gimple_debug (gsi_stmt (i
)))
350 gsi_next_nondebug (&i
);
355 /* Return a new iterator pointing to the last non-debug statement in
358 inline gimple_stmt_iterator
359 gsi_last_nondebug_bb (basic_block bb
)
361 gimple_stmt_iterator i
= gsi_last_bb (bb
);
363 if (!gsi_end_p (i
) && is_gimple_debug (gsi_stmt (i
)))
364 gsi_prev_nondebug (&i
);
369 /* Return true if I is followed only by debug statements in its
373 gsi_one_nondebug_before_end_p (gimple_stmt_iterator i
)
375 if (gsi_one_before_end_p (i
))
379 gsi_next_nondebug (&i
);
380 return gsi_end_p (i
);
383 /* Advance I statement iterator to the next non-virtual GIMPLE_PHI
387 gsi_next_nonvirtual_phi (gphi_iterator
*i
)
393 while (!gsi_end_p (*i
) && virtual_operand_p (gimple_phi_result (i
->phi ())));
396 /* Return a new iterator pointing to the first non-virtual phi statement in
400 gsi_start_nonvirtual_phis (basic_block bb
)
402 gphi_iterator i
= gsi_start_phis (bb
);
404 if (!gsi_end_p (i
) && virtual_operand_p (gimple_phi_result (i
.phi ())))
405 gsi_next_nonvirtual_phi (&i
);
410 /* Return the basic block associated with this iterator. */
413 gsi_bb (gimple_stmt_iterator i
)
418 /* Return the sequence associated with this iterator. */
421 gsi_seq (gimple_stmt_iterator i
)
426 /* Determine whether SEQ is a nondebug singleton. */
429 gimple_seq_nondebug_singleton_p (gimple_seq seq
)
431 gimple_stmt_iterator gsi
;
433 /* Find a nondebug gimple. */
434 gsi
.ptr
= gimple_seq_first (seq
);
437 while (!gsi_end_p (gsi
)
438 && is_gimple_debug (gsi_stmt (gsi
)))
441 /* No nondebug gimple found, not a singleton. */
445 /* Find a next nondebug gimple. */
447 while (!gsi_end_p (gsi
)
448 && is_gimple_debug (gsi_stmt (gsi
)))
451 /* Only a singleton if there's no next nondebug gimple. */
452 return gsi_end_p (gsi
);
455 #endif /* GCC_GIMPLE_ITERATOR_H */