]>
Commit | Line | Data |
---|---|---|
7a8cba34 | 1 | /* Define control flow data structures for the CFG. |
cbe34bb5 | 2 | Copyright (C) 1987-2017 Free Software Foundation, Inc. |
3245eea0 | 3 | |
1322177d | 4 | This file is part of GCC. |
3245eea0 | 5 | |
1322177d LB |
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 | |
9dcd6f09 | 8 | Software Foundation; either version 3, or (at your option) any later |
1322177d | 9 | version. |
3245eea0 | 10 | |
1322177d LB |
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 | |
14 | for more details. | |
3245eea0 CH |
15 | |
16 | You should have received a copy of the GNU General Public License | |
9dcd6f09 NC |
17 | along with GCC; see the file COPYING3. If not see |
18 | <http://www.gnu.org/licenses/>. */ | |
3245eea0 | 19 | |
88657302 | 20 | #ifndef GCC_BASIC_BLOCK_H |
7f8a2125 | 21 | #define GCC_BASIC_BLOCK_H |
3245eea0 | 22 | |
3995f3a2 | 23 | #include <profile-count.h> |
b2aec5c0 | 24 | |
e881bb1b | 25 | /* Control flow edge information. */ |
0823efed | 26 | struct GTY((user)) edge_def { |
e881bb1b | 27 | /* The two blocks at the ends of the edge. */ |
b8244d74 SB |
28 | basic_block src; |
29 | basic_block dest; | |
e881bb1b RH |
30 | |
31 | /* Instructions queued on the edge. */ | |
6de9cd9a | 32 | union edge_def_insns { |
0823efed | 33 | gimple_seq g; |
3ffa95c2 | 34 | rtx_insn *r; |
0823efed | 35 | } insns; |
e881bb1b RH |
36 | |
37 | /* Auxiliary info specific to a pass. */ | |
0823efed | 38 | PTR aux; |
3245eea0 | 39 | |
5368224f | 40 | /* Location of any goto implicit in the edge. */ |
2d593c86 | 41 | location_t goto_locus; |
62b857ea | 42 | |
2eac9a76 RG |
43 | /* The index number corresponding to this edge in the edge vector |
44 | dest->preds. */ | |
45 | unsigned int dest_idx; | |
46 | ||
a315c44c | 47 | int flags; /* see cfg-flags.def */ |
357067f2 | 48 | profile_probability probability; |
ef30ab83 JH |
49 | |
50 | /* Return count of edge E. */ | |
51 | inline profile_count count () const; | |
6de9cd9a DN |
52 | }; |
53 | ||
a315c44c SB |
54 | /* Masks for edge.flags. */ |
55 | #define DEF_EDGE_FLAG(NAME,IDX) EDGE_##NAME = 1 << IDX , | |
56 | enum cfg_edge_flags { | |
57 | #include "cfg-flags.def" | |
58 | LAST_CFG_EDGE_FLAG /* this is only used for EDGE_ALL_FLAGS */ | |
59 | }; | |
60 | #undef DEF_EDGE_FLAG | |
61 | ||
62 | /* Bit mask for all edge flags. */ | |
63 | #define EDGE_ALL_FLAGS ((LAST_CFG_EDGE_FLAG - 1) * 2 - 1) | |
3245eea0 | 64 | |
a315c44c SB |
65 | /* The following four flags all indicate something special about an edge. |
66 | Test the edge flags on EDGE_COMPLEX to detect all forms of "strange" | |
67 | control flow transfers. */ | |
0be7e7a6 RH |
68 | #define EDGE_COMPLEX \ |
69 | (EDGE_ABNORMAL | EDGE_ABNORMAL_CALL | EDGE_EH | EDGE_PRESERVE) | |
65b98a02 | 70 | |
3e8b732e | 71 | struct GTY(()) rtl_bb_info { |
bcc708fc MM |
72 | /* The first insn of the block is embedded into bb->il.x. */ |
73 | /* The last insn of the block. */ | |
1130d5e3 | 74 | rtx_insn *end_; |
3e8b732e MM |
75 | |
76 | /* In CFGlayout mode points to insn notes/jumptables to be placed just before | |
77 | and after the block. */ | |
1130d5e3 | 78 | rtx_insn *header_; |
d8ce2eae | 79 | rtx_insn *footer_; |
3e8b732e MM |
80 | }; |
81 | ||
82 | struct GTY(()) gimple_bb_info { | |
83 | /* Sequence of statements in this block. */ | |
84 | gimple_seq seq; | |
85 | ||
86 | /* PHI nodes for this block. */ | |
87 | gimple_seq phi_nodes; | |
88 | }; | |
4aab792d | 89 | |
229ecb89 | 90 | /* A basic block is a sequence of instructions with only one entry and |
e68e3108 MM |
91 | only one exit. If any one of the instructions are executed, they |
92 | will all be executed, and in sequence from first to last. | |
93 | ||
94 | There may be COND_EXEC instructions in the basic block. The | |
95 | COND_EXEC *instructions* will be executed -- but if the condition | |
96 | is false the conditionally executed *expressions* will of course | |
97 | not be executed. We don't consider the conditionally executed | |
98 | expression (which might have side-effects) to be in a separate | |
99 | basic block because the program counter will always be at the same | |
100 | location after the COND_EXEC instruction, regardless of whether the | |
101 | condition is true or not. | |
102 | ||
103 | Basic blocks need not start with a label nor end with a jump insn. | |
b53978a3 JO |
104 | For example, a previous basic block may just "conditionally fall" |
105 | into the succeeding basic block, and the last basic block need not | |
106 | end with a jump insn. Block 0 is a descendant of the entry block. | |
107 | ||
108 | A basic block beginning with two labels cannot have notes between | |
109 | the labels. | |
110 | ||
111 | Data for jump tables are stored in jump_insns that occur in no | |
112 | basic block even though these insns can follow or precede insns in | |
113 | basic blocks. */ | |
114 | ||
e881bb1b | 115 | /* Basic block information indexed by block number. */ |
d1b38208 | 116 | struct GTY((chain_next ("%h.next_bb"), chain_prev ("%h.prev_bb"))) basic_block_def { |
e881bb1b | 117 | /* The edges into and out of the block. */ |
9771b263 DN |
118 | vec<edge, va_gc> *preds; |
119 | vec<edge, va_gc> *succs; | |
4d1d8045 | 120 | |
e881bb1b | 121 | /* Auxiliary info specific to a pass. */ |
6de9cd9a | 122 | PTR GTY ((skip (""))) aux; |
3245eea0 | 123 | |
076c7ab8 | 124 | /* Innermost loop containing the block. */ |
9e2f83a5 | 125 | struct loop *loop_father; |
076c7ab8 ZW |
126 | |
127 | /* The dominance and postdominance information node. */ | |
128 | struct et_node * GTY ((skip (""))) dom[2]; | |
336a6399 | 129 | |
918ed612 | 130 | /* Previous and next blocks in the chain. */ |
b8244d74 SB |
131 | basic_block prev_bb; |
132 | basic_block next_bb; | |
918ed612 | 133 | |
5e2d947c | 134 | union basic_block_il_dependent { |
3e8b732e | 135 | struct gimple_bb_info GTY ((tag ("0"))) gimple; |
bcc708fc | 136 | struct { |
1130d5e3 | 137 | rtx_insn *head_; |
bcc708fc MM |
138 | struct rtl_bb_info * rtl; |
139 | } GTY ((tag ("1"))) x; | |
5e2d947c JH |
140 | } GTY ((desc ("((%1.flags & BB_RTL) != 0)"))) il; |
141 | ||
391886c8 RG |
142 | /* Various flags. See cfg-flags.def. */ |
143 | int flags; | |
7f8a2125 | 144 | |
076c7ab8 ZW |
145 | /* The index of this block. */ |
146 | int index; | |
147 | ||
391886c8 | 148 | /* Expected number of executions: calculated in profile.c. */ |
3995f3a2 | 149 | profile_count count; |
076c7ab8 | 150 | |
a315c44c SB |
151 | /* The discriminator for this block. The discriminator distinguishes |
152 | among several basic blocks that share a common locus, allowing for | |
153 | more accurate sample-based profiling. */ | |
6c52e687 | 154 | int discriminator; |
6de9cd9a DN |
155 | }; |
156 | ||
3e8b732e MM |
157 | /* This ensures that struct gimple_bb_info is smaller than |
158 | struct rtl_bb_info, so that inlining the former into basic_block_def | |
159 | is the better choice. */ | |
160 | typedef int __assert_gimple_bb_smaller_rtl_bb | |
c3284718 RS |
161 | [(int) sizeof (struct rtl_bb_info) |
162 | - (int) sizeof (struct gimple_bb_info)]; | |
7506e1cb | 163 | |
c71070ab | 164 | |
861f9cd0 | 165 | #define BB_FREQ_MAX 10000 |
e881bb1b | 166 | |
a315c44c SB |
167 | /* Masks for basic_block.flags. */ |
168 | #define DEF_BASIC_BLOCK_FLAG(NAME,IDX) BB_##NAME = 1 << IDX , | |
169 | enum cfg_bb_flags | |
9e32d2be | 170 | { |
a315c44c SB |
171 | #include "cfg-flags.def" |
172 | LAST_CFG_BB_FLAG /* this is only used for BB_ALL_FLAGS */ | |
9e32d2be | 173 | }; |
a315c44c SB |
174 | #undef DEF_BASIC_BLOCK_FLAG |
175 | ||
c4669594 | 176 | /* Bit mask for all basic block flags. */ |
a315c44c | 177 | #define BB_ALL_FLAGS ((LAST_CFG_BB_FLAG - 1) * 2 - 1) |
740ce53d | 178 | |
c4669594 SB |
179 | /* Bit mask for all basic block flags that must be preserved. These are |
180 | the bit masks that are *not* cleared by clear_bb_flags. */ | |
181 | #define BB_FLAGS_TO_PRESERVE \ | |
182 | (BB_DISABLE_SCHEDULE | BB_RTL | BB_NON_LOCAL_GOTO_TARGET \ | |
183 | | BB_HOT_PARTITION | BB_COLD_PARTITION) | |
184 | ||
a315c44c | 185 | /* Dummy bitmask for convenience in the hot/cold partitioning code. */ |
076c7ab8 | 186 | #define BB_UNPARTITIONED 0 |
006844a3 | 187 | |
750054a2 CT |
188 | /* Partitions, to be used when partitioning hot and cold basic blocks into |
189 | separate sections. */ | |
076c7ab8 | 190 | #define BB_PARTITION(bb) ((bb)->flags & (BB_HOT_PARTITION|BB_COLD_PARTITION)) |
51a904c9 ZW |
191 | #define BB_SET_PARTITION(bb, part) do { \ |
192 | basic_block bb_ = (bb); \ | |
193 | bb_->flags = ((bb_->flags & ~(BB_HOT_PARTITION|BB_COLD_PARTITION)) \ | |
194 | | (part)); \ | |
195 | } while (0) | |
196 | ||
076c7ab8 ZW |
197 | #define BB_COPY_PARTITION(dstbb, srcbb) \ |
198 | BB_SET_PARTITION (dstbb, BB_PARTITION (srcbb)) | |
750054a2 | 199 | |
997de8ed | 200 | /* Defines for accessing the fields of the CFG structure for function FN. */ |
fefa31b5 DM |
201 | #define ENTRY_BLOCK_PTR_FOR_FN(FN) ((FN)->cfg->x_entry_block_ptr) |
202 | #define EXIT_BLOCK_PTR_FOR_FN(FN) ((FN)->cfg->x_exit_block_ptr) | |
bbd79259 | 203 | #define basic_block_info_for_fn(FN) ((FN)->cfg->x_basic_block_info) |
0cae8d31 | 204 | #define n_basic_blocks_for_fn(FN) ((FN)->cfg->x_n_basic_blocks) |
dc936fb2 | 205 | #define n_edges_for_fn(FN) ((FN)->cfg->x_n_edges) |
3986e690 | 206 | #define last_basic_block_for_fn(FN) ((FN)->cfg->x_last_basic_block) |
3e248e06 | 207 | #define label_to_block_map_for_fn(FN) ((FN)->cfg->x_label_to_block_map) |
ea19eb9f | 208 | #define profile_status_for_fn(FN) ((FN)->cfg->x_profile_status) |
997de8ed | 209 | |
bbd79259 DM |
210 | #define BASIC_BLOCK_FOR_FN(FN,N) \ |
211 | ((*basic_block_info_for_fn (FN))[(N)]) | |
212 | #define SET_BASIC_BLOCK_FOR_FN(FN,N,BB) \ | |
213 | ((*basic_block_info_for_fn (FN))[(N)] = (BB)) | |
997de8ed | 214 | |
918ed612 ZD |
215 | /* For iterating over basic blocks. */ |
216 | #define FOR_BB_BETWEEN(BB, FROM, TO, DIR) \ | |
217 | for (BB = FROM; BB != TO; BB = BB->DIR) | |
218 | ||
997de8ed SB |
219 | #define FOR_EACH_BB_FN(BB, FN) \ |
220 | FOR_BB_BETWEEN (BB, (FN)->cfg->x_entry_block_ptr->next_bb, (FN)->cfg->x_exit_block_ptr, next_bb) | |
221 | ||
997de8ed SB |
222 | #define FOR_EACH_BB_REVERSE_FN(BB, FN) \ |
223 | FOR_BB_BETWEEN (BB, (FN)->cfg->x_exit_block_ptr->prev_bb, (FN)->cfg->x_entry_block_ptr, prev_bb) | |
224 | ||
50654f6c ZD |
225 | /* For iterating over insns in basic block. */ |
226 | #define FOR_BB_INSNS(BB, INSN) \ | |
227 | for ((INSN) = BB_HEAD (BB); \ | |
24bd1a0b | 228 | (INSN) && (INSN) != NEXT_INSN (BB_END (BB)); \ |
50654f6c ZD |
229 | (INSN) = NEXT_INSN (INSN)) |
230 | ||
6fb5fa3c DB |
231 | /* For iterating over insns in basic block when we might remove the |
232 | current insn. */ | |
233 | #define FOR_BB_INSNS_SAFE(BB, INSN, CURR) \ | |
234 | for ((INSN) = BB_HEAD (BB), (CURR) = (INSN) ? NEXT_INSN ((INSN)): NULL; \ | |
235 | (INSN) && (INSN) != NEXT_INSN (BB_END (BB)); \ | |
236 | (INSN) = (CURR), (CURR) = (INSN) ? NEXT_INSN ((INSN)) : NULL) | |
b8698a0f | 237 | |
50654f6c ZD |
238 | #define FOR_BB_INSNS_REVERSE(BB, INSN) \ |
239 | for ((INSN) = BB_END (BB); \ | |
24bd1a0b | 240 | (INSN) && (INSN) != PREV_INSN (BB_HEAD (BB)); \ |
50654f6c ZD |
241 | (INSN) = PREV_INSN (INSN)) |
242 | ||
6fb5fa3c DB |
243 | #define FOR_BB_INSNS_REVERSE_SAFE(BB, INSN, CURR) \ |
244 | for ((INSN) = BB_END (BB),(CURR) = (INSN) ? PREV_INSN ((INSN)) : NULL; \ | |
245 | (INSN) && (INSN) != PREV_INSN (BB_HEAD (BB)); \ | |
246 | (INSN) = (CURR), (CURR) = (INSN) ? PREV_INSN ((INSN)) : NULL) | |
247 | ||
ed8d2920 MM |
248 | /* Cycles through _all_ basic blocks, even the fake ones (entry and |
249 | exit block). */ | |
250 | ||
a930a4ef | 251 | #define FOR_ALL_BB_FN(BB, FN) \ |
fefa31b5 | 252 | for (BB = ENTRY_BLOCK_PTR_FOR_FN (FN); BB; BB = BB->next_bb) |
a930a4ef | 253 | |
5ece9746 JL |
254 | \f |
255 | /* Stuff for recording basic block info. */ | |
256 | ||
ef0fe503 DM |
257 | /* For now, these will be functions (so that they can include checked casts |
258 | to rtx_insn. Once the underlying fields are converted from rtx | |
259 | to rtx_insn, these can be converted back to macros. */ | |
260 | ||
1130d5e3 DM |
261 | #define BB_HEAD(B) (B)->il.x.head_ |
262 | #define BB_END(B) (B)->il.x.rtl->end_ | |
263 | #define BB_HEADER(B) (B)->il.x.rtl->header_ | |
d8ce2eae | 264 | #define BB_FOOTER(B) (B)->il.x.rtl->footer_ |
2b1d9dc0 | 265 | |
95bca6b0 BRF |
266 | /* Special block numbers [markers] for entry and exit. |
267 | Neither of them is supposed to hold actual statements. */ | |
24bd1a0b DB |
268 | #define ENTRY_BLOCK (0) |
269 | #define EXIT_BLOCK (1) | |
270 | ||
271 | /* The two blocks that are always in the cfg. */ | |
272 | #define NUM_FIXED_BLOCKS (2) | |
5ece9746 | 273 | |
410538ea AM |
274 | /* This is the value which indicates no edge is present. */ |
275 | #define EDGE_INDEX_NO_EDGE -1 | |
276 | ||
277 | /* EDGE_INDEX returns an integer index for an edge, or EDGE_INDEX_NO_EDGE | |
278 | if there is no edge between the 2 basic blocks. */ | |
279 | #define EDGE_INDEX(el, pred, succ) (find_edge_index ((el), (pred), (succ))) | |
280 | ||
281 | /* INDEX_EDGE_PRED_BB and INDEX_EDGE_SUCC_BB return a pointer to the basic | |
282 | block which is either the pred or succ end of the indexed edge. */ | |
283 | #define INDEX_EDGE_PRED_BB(el, index) ((el)->index_to_edge[(index)]->src) | |
284 | #define INDEX_EDGE_SUCC_BB(el, index) ((el)->index_to_edge[(index)]->dest) | |
285 | ||
286 | /* INDEX_EDGE returns a pointer to the edge. */ | |
287 | #define INDEX_EDGE(el, index) ((el)->index_to_edge[(index)]) | |
288 | ||
289 | /* Number of edges in the compressed edge list. */ | |
290 | #define NUM_EDGES(el) ((el)->num_edges) | |
291 | ||
7a442791 | 292 | /* BB is assumed to contain conditional jump. Return the fallthru edge. */ |
628f6a4e BE |
293 | #define FALLTHRU_EDGE(bb) (EDGE_SUCC ((bb), 0)->flags & EDGE_FALLTHRU \ |
294 | ? EDGE_SUCC ((bb), 0) : EDGE_SUCC ((bb), 1)) | |
7a442791 JH |
295 | |
296 | /* BB is assumed to contain conditional jump. Return the branch edge. */ | |
628f6a4e BE |
297 | #define BRANCH_EDGE(bb) (EDGE_SUCC ((bb), 0)->flags & EDGE_FALLTHRU \ |
298 | ? EDGE_SUCC ((bb), 1) : EDGE_SUCC ((bb), 0)) | |
7a442791 | 299 | |
134d3a2e | 300 | /* Return expected execution frequency of the edge E. */ |
e7a74006 | 301 | #define EDGE_FREQUENCY(e) e->count ().to_frequency (cfun) |
134d3a2e | 302 | |
8ddb5a29 | 303 | /* Compute a scale factor (or probability) suitable for scaling of |
f41f80f9 | 304 | gcov_type values via apply_probability() and apply_scale(). */ |
8ddb5a29 TJ |
305 | #define GCOV_COMPUTE_SCALE(num,den) \ |
306 | ((den) ? RDIV ((num) * REG_BR_PROB_BASE, (den)) : REG_BR_PROB_BASE) | |
307 | ||
4262e623 | 308 | /* Return nonzero if edge is critical. */ |
628f6a4e BE |
309 | #define EDGE_CRITICAL_P(e) (EDGE_COUNT ((e)->src->succs) >= 2 \ |
310 | && EDGE_COUNT ((e)->dest->preds) >= 2) | |
311 | ||
9771b263 DN |
312 | #define EDGE_COUNT(ev) vec_safe_length (ev) |
313 | #define EDGE_I(ev,i) (*ev)[(i)] | |
314 | #define EDGE_PRED(bb,i) (*(bb)->preds)[(i)] | |
315 | #define EDGE_SUCC(bb,i) (*(bb)->succs)[(i)] | |
628f6a4e | 316 | |
c5cbcccf ZD |
317 | /* Returns true if BB has precisely one successor. */ |
318 | ||
319 | static inline bool | |
ed7a4b4b | 320 | single_succ_p (const_basic_block bb) |
c5cbcccf ZD |
321 | { |
322 | return EDGE_COUNT (bb->succs) == 1; | |
323 | } | |
324 | ||
325 | /* Returns true if BB has precisely one predecessor. */ | |
326 | ||
327 | static inline bool | |
ed7a4b4b | 328 | single_pred_p (const_basic_block bb) |
c5cbcccf ZD |
329 | { |
330 | return EDGE_COUNT (bb->preds) == 1; | |
331 | } | |
332 | ||
81b29e2f ZD |
333 | /* Returns the single successor edge of basic block BB. Aborts if |
334 | BB does not have exactly one successor. */ | |
c5cbcccf ZD |
335 | |
336 | static inline edge | |
ed7a4b4b | 337 | single_succ_edge (const_basic_block bb) |
c5cbcccf | 338 | { |
77a74ed7 | 339 | gcc_checking_assert (single_succ_p (bb)); |
c5cbcccf ZD |
340 | return EDGE_SUCC (bb, 0); |
341 | } | |
342 | ||
81b29e2f ZD |
343 | /* Returns the single predecessor edge of basic block BB. Aborts |
344 | if BB does not have exactly one predecessor. */ | |
c5cbcccf ZD |
345 | |
346 | static inline edge | |
ed7a4b4b | 347 | single_pred_edge (const_basic_block bb) |
c5cbcccf | 348 | { |
77a74ed7 | 349 | gcc_checking_assert (single_pred_p (bb)); |
c5cbcccf ZD |
350 | return EDGE_PRED (bb, 0); |
351 | } | |
352 | ||
81b29e2f ZD |
353 | /* Returns the single successor block of basic block BB. Aborts |
354 | if BB does not have exactly one successor. */ | |
c5cbcccf ZD |
355 | |
356 | static inline basic_block | |
ed7a4b4b | 357 | single_succ (const_basic_block bb) |
c5cbcccf ZD |
358 | { |
359 | return single_succ_edge (bb)->dest; | |
360 | } | |
361 | ||
81b29e2f ZD |
362 | /* Returns the single predecessor block of basic block BB. Aborts |
363 | if BB does not have exactly one predecessor.*/ | |
c5cbcccf ZD |
364 | |
365 | static inline basic_block | |
ed7a4b4b | 366 | single_pred (const_basic_block bb) |
c5cbcccf ZD |
367 | { |
368 | return single_pred_edge (bb)->src; | |
369 | } | |
370 | ||
628f6a4e BE |
371 | /* Iterator object for edges. */ |
372 | ||
84562394 | 373 | struct edge_iterator { |
628f6a4e | 374 | unsigned index; |
9771b263 | 375 | vec<edge, va_gc> **container; |
84562394 | 376 | }; |
628f6a4e | 377 | |
9771b263 | 378 | static inline vec<edge, va_gc> * |
f76ccf60 BE |
379 | ei_container (edge_iterator i) |
380 | { | |
77a74ed7 | 381 | gcc_checking_assert (i.container); |
f76ccf60 BE |
382 | return *i.container; |
383 | } | |
384 | ||
385 | #define ei_start(iter) ei_start_1 (&(iter)) | |
386 | #define ei_last(iter) ei_last_1 (&(iter)) | |
387 | ||
628f6a4e BE |
388 | /* Return an iterator pointing to the start of an edge vector. */ |
389 | static inline edge_iterator | |
9771b263 | 390 | ei_start_1 (vec<edge, va_gc> **ev) |
628f6a4e BE |
391 | { |
392 | edge_iterator i; | |
393 | ||
394 | i.index = 0; | |
395 | i.container = ev; | |
396 | ||
397 | return i; | |
398 | } | |
399 | ||
400 | /* Return an iterator pointing to the last element of an edge | |
471854f8 | 401 | vector. */ |
628f6a4e | 402 | static inline edge_iterator |
9771b263 | 403 | ei_last_1 (vec<edge, va_gc> **ev) |
628f6a4e BE |
404 | { |
405 | edge_iterator i; | |
406 | ||
f76ccf60 | 407 | i.index = EDGE_COUNT (*ev) - 1; |
628f6a4e BE |
408 | i.container = ev; |
409 | ||
410 | return i; | |
411 | } | |
412 | ||
413 | /* Is the iterator `i' at the end of the sequence? */ | |
414 | static inline bool | |
415 | ei_end_p (edge_iterator i) | |
416 | { | |
f76ccf60 | 417 | return (i.index == EDGE_COUNT (ei_container (i))); |
628f6a4e BE |
418 | } |
419 | ||
420 | /* Is the iterator `i' at one position before the end of the | |
421 | sequence? */ | |
422 | static inline bool | |
423 | ei_one_before_end_p (edge_iterator i) | |
424 | { | |
f76ccf60 | 425 | return (i.index + 1 == EDGE_COUNT (ei_container (i))); |
628f6a4e BE |
426 | } |
427 | ||
428 | /* Advance the iterator to the next element. */ | |
429 | static inline void | |
430 | ei_next (edge_iterator *i) | |
431 | { | |
77a74ed7 | 432 | gcc_checking_assert (i->index < EDGE_COUNT (ei_container (*i))); |
628f6a4e BE |
433 | i->index++; |
434 | } | |
435 | ||
436 | /* Move the iterator to the previous element. */ | |
437 | static inline void | |
438 | ei_prev (edge_iterator *i) | |
439 | { | |
77a74ed7 | 440 | gcc_checking_assert (i->index > 0); |
628f6a4e BE |
441 | i->index--; |
442 | } | |
443 | ||
444 | /* Return the edge pointed to by the iterator `i'. */ | |
445 | static inline edge | |
446 | ei_edge (edge_iterator i) | |
447 | { | |
f76ccf60 | 448 | return EDGE_I (ei_container (i), i.index); |
628f6a4e BE |
449 | } |
450 | ||
451 | /* Return an edge pointed to by the iterator. Do it safely so that | |
452 | NULL is returned when the iterator is pointing at the end of the | |
453 | sequence. */ | |
454 | static inline edge | |
455 | ei_safe_edge (edge_iterator i) | |
456 | { | |
457 | return !ei_end_p (i) ? ei_edge (i) : NULL; | |
458 | } | |
459 | ||
f3522a84 KH |
460 | /* Return 1 if we should continue to iterate. Return 0 otherwise. |
461 | *Edge P is set to the next edge if we are to continue to iterate | |
462 | and NULL otherwise. */ | |
463 | ||
464 | static inline bool | |
465 | ei_cond (edge_iterator ei, edge *p) | |
466 | { | |
467 | if (!ei_end_p (ei)) | |
468 | { | |
469 | *p = ei_edge (ei); | |
470 | return 1; | |
471 | } | |
472 | else | |
473 | { | |
474 | *p = NULL; | |
475 | return 0; | |
476 | } | |
477 | } | |
478 | ||
628f6a4e | 479 | /* This macro serves as a convenient way to iterate each edge in a |
c2b7c2d8 | 480 | vector of predecessor or successor edges. It must not be used when |
628f6a4e BE |
481 | an element might be removed during the traversal, otherwise |
482 | elements will be missed. Instead, use a for-loop like that shown | |
483 | in the following pseudo-code: | |
c22cacf3 | 484 | |
628f6a4e BE |
485 | FOR (ei = ei_start (bb->succs); (e = ei_safe_edge (ei)); ) |
486 | { | |
487 | IF (e != taken_edge) | |
d0d2cc21 | 488 | remove_edge (e); |
628f6a4e BE |
489 | ELSE |
490 | ei_next (&ei); | |
491 | } | |
492 | */ | |
493 | ||
f3522a84 KH |
494 | #define FOR_EACH_EDGE(EDGE,ITER,EDGE_VEC) \ |
495 | for ((ITER) = ei_start ((EDGE_VEC)); \ | |
496 | ei_cond ((ITER), &(EDGE)); \ | |
628f6a4e | 497 | ei_next (&(ITER))) |
4262e623 | 498 | |
e0bb17a8 | 499 | #define CLEANUP_EXPENSIVE 1 /* Do relatively expensive optimizations |
46fac664 JH |
500 | except for edge forwarding */ |
501 | #define CLEANUP_CROSSJUMP 2 /* Do crossjumping. */ | |
502 | #define CLEANUP_POST_REGSTACK 4 /* We run after reg-stack and need | |
503 | to care REG_DEAD notes. */ | |
6fb5fa3c DB |
504 | #define CLEANUP_THREADING 8 /* Do jump threading. */ |
505 | #define CLEANUP_NO_INSN_DEL 16 /* Do not try to delete trivially dead | |
95479831 | 506 | insns. */ |
6fb5fa3c | 507 | #define CLEANUP_CFGLAYOUT 32 /* Do cleanup in cfglayout mode. */ |
7d776ee2 | 508 | #define CLEANUP_CFG_CHANGED 64 /* The caller changed the CFG. */ |
6ce2bcb7 | 509 | |
7783daa7 AM |
510 | /* Return true if BB is in a transaction. */ |
511 | ||
512 | static inline bool | |
513 | bb_in_transaction (basic_block bb) | |
514 | { | |
515 | return bb->flags & BB_IN_TRANSACTION; | |
516 | } | |
517 | ||
f66fd328 | 518 | /* Return true when one of the predecessor edges of BB is marked with EDGE_EH. */ |
bae8b6b2 SB |
519 | static inline bool |
520 | bb_has_eh_pred (basic_block bb) | |
fcc42bca AK |
521 | { |
522 | edge e; | |
523 | edge_iterator ei; | |
524 | ||
525 | FOR_EACH_EDGE (e, ei, bb->preds) | |
526 | { | |
527 | if (e->flags & EDGE_EH) | |
528 | return true; | |
529 | } | |
530 | return false; | |
531 | } | |
532 | ||
ba49cb7b KZ |
533 | /* Return true when one of the predecessor edges of BB is marked with EDGE_ABNORMAL. */ |
534 | static inline bool | |
535 | bb_has_abnormal_pred (basic_block bb) | |
536 | { | |
537 | edge e; | |
538 | edge_iterator ei; | |
539 | ||
540 | FOR_EACH_EDGE (e, ei, bb->preds) | |
541 | { | |
542 | if (e->flags & EDGE_ABNORMAL) | |
543 | return true; | |
544 | } | |
545 | return false; | |
546 | } | |
547 | ||
0fd4b31d NF |
548 | /* Return the fallthru edge in EDGES if it exists, NULL otherwise. */ |
549 | static inline edge | |
9771b263 | 550 | find_fallthru_edge (vec<edge, va_gc> *edges) |
0fd4b31d NF |
551 | { |
552 | edge e; | |
553 | edge_iterator ei; | |
554 | ||
555 | FOR_EACH_EDGE (e, ei, edges) | |
556 | if (e->flags & EDGE_FALLTHRU) | |
557 | break; | |
558 | ||
559 | return e; | |
560 | } | |
561 | ||
e78410bf JH |
562 | /* Check tha probability is sane. */ |
563 | ||
564 | static inline void | |
565 | check_probability (int prob) | |
566 | { | |
567 | gcc_checking_assert (prob >= 0 && prob <= REG_BR_PROB_BASE); | |
568 | } | |
569 | ||
570 | /* Given PROB1 and PROB2, return PROB1*PROB2/REG_BR_PROB_BASE. | |
571 | Used to combine BB probabilities. */ | |
572 | ||
573 | static inline int | |
574 | combine_probabilities (int prob1, int prob2) | |
575 | { | |
576 | check_probability (prob1); | |
577 | check_probability (prob2); | |
578 | return RDIV (prob1 * prob2, REG_BR_PROB_BASE); | |
579 | } | |
580 | ||
f41f80f9 TJ |
581 | /* Apply scale factor SCALE on frequency or count FREQ. Use this |
582 | interface when potentially scaling up, so that SCALE is not | |
583 | constrained to be < REG_BR_PROB_BASE. */ | |
584 | ||
585 | static inline gcov_type | |
b9cbfeeb | 586 | apply_scale (gcov_type freq, gcov_type scale) |
f41f80f9 TJ |
587 | { |
588 | return RDIV (freq * scale, REG_BR_PROB_BASE); | |
589 | } | |
590 | ||
e78410bf JH |
591 | /* Apply probability PROB on frequency or count FREQ. */ |
592 | ||
593 | static inline gcov_type | |
594 | apply_probability (gcov_type freq, int prob) | |
595 | { | |
596 | check_probability (prob); | |
f41f80f9 | 597 | return apply_scale (freq, prob); |
e78410bf JH |
598 | } |
599 | ||
600 | /* Return inverse probability for PROB. */ | |
601 | ||
602 | static inline int | |
603 | inverse_probability (int prob1) | |
604 | { | |
605 | check_probability (prob1); | |
606 | return REG_BR_PROB_BASE - prob1; | |
607 | } | |
5e94175f JL |
608 | |
609 | /* Return true if BB has at least one abnormal outgoing edge. */ | |
610 | ||
611 | static inline bool | |
6efe83b2 | 612 | has_abnormal_or_eh_outgoing_edge_p (basic_block bb) |
5e94175f JL |
613 | { |
614 | edge e; | |
615 | edge_iterator ei; | |
616 | ||
617 | FOR_EACH_EDGE (e, ei, bb->succs) | |
6efe83b2 | 618 | if (e->flags & (EDGE_ABNORMAL | EDGE_EH)) |
5e94175f JL |
619 | return true; |
620 | ||
621 | return false; | |
622 | } | |
f1544089 MP |
623 | |
624 | /* Return true when one of the predecessor edges of BB is marked with | |
625 | EDGE_ABNORMAL_CALL or EDGE_EH. */ | |
626 | ||
627 | static inline bool | |
628 | has_abnormal_call_or_eh_pred_edge_p (basic_block bb) | |
629 | { | |
630 | edge e; | |
631 | edge_iterator ei; | |
632 | ||
633 | FOR_EACH_EDGE (e, ei, bb->preds) | |
634 | if (e->flags & (EDGE_ABNORMAL_CALL | EDGE_EH)) | |
635 | return true; | |
636 | ||
637 | return false; | |
638 | } | |
639 | ||
ef30ab83 JH |
640 | /* Return count of edge E. */ |
641 | inline profile_count edge_def::count () const | |
642 | { | |
643 | return src->count.apply_probability (probability); | |
644 | } | |
645 | ||
88657302 | 646 | #endif /* GCC_BASIC_BLOCK_H */ |