1 /* Control flow graph building code for GNU compiler.
2 Copyright (C) 1987, 1988, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
3 1999, 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
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 2, 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 COPYING. If not, write to the Free
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
22 /* find_basic_blocks divides the current function's rtl into basic
23 blocks and constructs the CFG. The blocks are recorded in the
24 basic_block_info array; the CFG exists in the edge structures
25 referenced by the blocks.
27 find_basic_blocks also finds any unreachable loops and deletes them.
29 Available functionality:
32 - Local CFG construction
33 find_sub_basic_blocks */
37 #include "coretypes.h"
41 #include "hard-reg-set.h"
42 #include "basic-block.h"
51 static int count_basic_blocks (rtx
);
52 static void find_basic_blocks_1 (rtx
);
53 static void make_edges (basic_block
, basic_block
, int);
54 static void make_label_edge (sbitmap
*, basic_block
, rtx
, int);
55 static void find_bb_boundaries (basic_block
);
56 static void compute_outgoing_frequencies (basic_block
);
58 /* Return true if insn is something that should be contained inside basic
62 inside_basic_block_p (rtx insn
)
64 switch (GET_CODE (insn
))
67 /* Avoid creating of basic block for jumptables. */
68 return (NEXT_INSN (insn
) == 0
69 || !JUMP_P (NEXT_INSN (insn
))
70 || (GET_CODE (PATTERN (NEXT_INSN (insn
))) != ADDR_VEC
71 && GET_CODE (PATTERN (NEXT_INSN (insn
))) != ADDR_DIFF_VEC
));
74 return (GET_CODE (PATTERN (insn
)) != ADDR_VEC
75 && GET_CODE (PATTERN (insn
)) != ADDR_DIFF_VEC
);
90 /* Return true if INSN may cause control flow transfer, so it should be last in
94 control_flow_insn_p (rtx insn
)
98 switch (GET_CODE (insn
))
105 /* Jump insn always causes control transfer except for tablejumps. */
106 return (GET_CODE (PATTERN (insn
)) != ADDR_VEC
107 && GET_CODE (PATTERN (insn
)) != ADDR_DIFF_VEC
);
110 /* Noreturn and sibling call instructions terminate the basic blocks
111 (but only if they happen unconditionally). */
112 if ((SIBLING_CALL_P (insn
)
113 || find_reg_note (insn
, REG_NORETURN
, 0))
114 && GET_CODE (PATTERN (insn
)) != COND_EXEC
)
116 /* Call insn may return to the nonlocal goto handler. */
117 return ((nonlocal_goto_handler_labels
118 && (0 == (note
= find_reg_note (insn
, REG_EH_REGION
,
120 || INTVAL (XEXP (note
, 0)) >= 0))
122 || can_throw_internal (insn
));
125 return (flag_non_call_exceptions
&& can_throw_internal (insn
));
128 /* It is nonsense to reach barrier when looking for the
129 end of basic block, but before dead code is eliminated
138 /* Count the basic blocks of the function. */
141 count_basic_blocks (rtx f
)
144 bool saw_insn
= false;
147 for (insn
= f
; insn
; insn
= NEXT_INSN (insn
))
149 /* Code labels and barriers causes current basic block to be
150 terminated at previous real insn. */
151 if ((LABEL_P (insn
) || BARRIER_P (insn
))
153 count
++, saw_insn
= false;
155 /* Start basic block if needed. */
156 if (!saw_insn
&& inside_basic_block_p (insn
))
159 /* Control flow insn causes current basic block to be terminated. */
160 if (saw_insn
&& control_flow_insn_p (insn
))
161 count
++, saw_insn
= false;
167 /* The rest of the compiler works a bit smoother when we don't have to
168 check for the edge case of do-nothing functions with no basic blocks. */
171 emit_insn (gen_rtx_USE (VOIDmode
, const0_rtx
));
178 /* Create an edge between two basic blocks. FLAGS are auxiliary information
179 about the edge that is accumulated between calls. */
181 /* Create an edge from a basic block to a label. */
184 make_label_edge (sbitmap
*edge_cache
, basic_block src
, rtx label
, int flags
)
186 gcc_assert (LABEL_P (label
));
188 /* If the label was never emitted, this insn is junk, but avoid a
189 crash trying to refer to BLOCK_FOR_INSN (label). This can happen
190 as a result of a syntax error and a diagnostic has already been
193 if (INSN_UID (label
) == 0)
196 cached_make_edge (edge_cache
, src
, BLOCK_FOR_INSN (label
), flags
);
199 /* Create the edges generated by INSN in REGION. */
202 rtl_make_eh_edge (sbitmap
*edge_cache
, basic_block src
, rtx insn
)
204 int is_call
= CALL_P (insn
) ? EDGE_ABNORMAL_CALL
: 0;
207 handlers
= reachable_handlers (insn
);
209 for (i
= handlers
; i
; i
= XEXP (i
, 1))
210 make_label_edge (edge_cache
, src
, XEXP (i
, 0),
211 EDGE_ABNORMAL
| EDGE_EH
| is_call
);
213 free_INSN_LIST_list (&handlers
);
216 /* Identify the edges between basic blocks MIN to MAX.
218 NONLOCAL_LABEL_LIST is a list of non-local labels in the function. Blocks
219 that are otherwise unreachable may be reachable with a non-local goto.
221 BB_EH_END is an array indexed by basic block number in which we record
222 the list of exception regions active at the end of the basic block. */
225 make_edges (basic_block min
, basic_block max
, int update_p
)
228 sbitmap
*edge_cache
= NULL
;
230 /* Assume no computed jump; revise as we create edges. */
231 current_function_has_computed_jump
= 0;
233 /* If we are partitioning hot and cold basic blocks into separate
234 sections, we cannot assume there is no computed jump (partitioning
235 sometimes requires the use of indirect jumps; see comments about
236 partitioning at the top of bb-reorder.c:partition_hot_cold_basic_blocks
237 for complete details). */
239 if (flag_reorder_blocks_and_partition
)
240 current_function_has_computed_jump
= 1;
242 /* Heavy use of computed goto in machine-generated code can lead to
243 nearly fully-connected CFGs. In that case we spend a significant
244 amount of time searching the edge lists for duplicates. */
245 if (forced_labels
|| cfun
->max_jumptable_ents
> 100)
247 edge_cache
= sbitmap_vector_alloc (last_basic_block
, last_basic_block
);
248 sbitmap_vector_zero (edge_cache
, last_basic_block
);
251 FOR_BB_BETWEEN (bb
, min
, max
->next_bb
, next_bb
)
256 FOR_EACH_EDGE (e
, ei
, bb
->succs
)
257 if (e
->dest
!= EXIT_BLOCK_PTR
)
258 SET_BIT (edge_cache
[bb
->index
], e
->dest
->index
);
262 /* By nature of the way these get numbered, ENTRY_BLOCK_PTR->next_bb block
263 is always the entry. */
264 if (min
== ENTRY_BLOCK_PTR
->next_bb
)
265 cached_make_edge (edge_cache
, ENTRY_BLOCK_PTR
, min
,
268 FOR_BB_BETWEEN (bb
, min
, max
->next_bb
, next_bb
)
272 int force_fallthru
= 0;
276 if (LABEL_P (BB_HEAD (bb
))
277 && LABEL_ALT_ENTRY_P (BB_HEAD (bb
)))
278 cached_make_edge (NULL
, ENTRY_BLOCK_PTR
, bb
, 0);
280 /* Examine the last instruction of the block, and discover the
281 ways we can leave the block. */
284 code
= GET_CODE (insn
);
287 if (code
== JUMP_INSN
)
291 /* Recognize exception handling placeholders. */
292 if (GET_CODE (PATTERN (insn
)) == RESX
)
293 rtl_make_eh_edge (edge_cache
, bb
, insn
);
295 /* Recognize a non-local goto as a branch outside the
297 else if (find_reg_note (insn
, REG_NON_LOCAL_GOTO
, NULL_RTX
))
300 /* Recognize a tablejump and do the right thing. */
301 else if (tablejump_p (insn
, NULL
, &tmp
))
306 if (GET_CODE (PATTERN (tmp
)) == ADDR_VEC
)
307 vec
= XVEC (PATTERN (tmp
), 0);
309 vec
= XVEC (PATTERN (tmp
), 1);
311 for (j
= GET_NUM_ELEM (vec
) - 1; j
>= 0; --j
)
312 make_label_edge (edge_cache
, bb
,
313 XEXP (RTVEC_ELT (vec
, j
), 0), 0);
315 /* Some targets (eg, ARM) emit a conditional jump that also
316 contains the out-of-range target. Scan for these and
317 add an edge if necessary. */
318 if ((tmp
= single_set (insn
)) != NULL
319 && SET_DEST (tmp
) == pc_rtx
320 && GET_CODE (SET_SRC (tmp
)) == IF_THEN_ELSE
321 && GET_CODE (XEXP (SET_SRC (tmp
), 2)) == LABEL_REF
)
322 make_label_edge (edge_cache
, bb
,
323 XEXP (XEXP (SET_SRC (tmp
), 2), 0), 0);
325 #ifdef CASE_DROPS_THROUGH
326 /* Silly VAXen. The ADDR_VEC is going to be in the way of
327 us naturally detecting fallthru into the next block. */
332 /* If this is a computed jump, then mark it as reaching
333 everything on the forced_labels list. */
334 else if (computed_jump_p (insn
))
336 current_function_has_computed_jump
= 1;
338 for (x
= forced_labels
; x
; x
= XEXP (x
, 1))
339 make_label_edge (edge_cache
, bb
, XEXP (x
, 0), EDGE_ABNORMAL
);
342 /* Returns create an exit out. */
343 else if (returnjump_p (insn
))
344 cached_make_edge (edge_cache
, bb
, EXIT_BLOCK_PTR
, 0);
346 /* Otherwise, we have a plain conditional or unconditional jump. */
349 gcc_assert (JUMP_LABEL (insn
));
350 make_label_edge (edge_cache
, bb
, JUMP_LABEL (insn
), 0);
354 /* If this is a sibling call insn, then this is in effect a combined call
355 and return, and so we need an edge to the exit block. No need to
356 worry about EH edges, since we wouldn't have created the sibling call
357 in the first place. */
358 if (code
== CALL_INSN
&& SIBLING_CALL_P (insn
))
359 cached_make_edge (edge_cache
, bb
, EXIT_BLOCK_PTR
,
360 EDGE_SIBCALL
| EDGE_ABNORMAL
);
362 /* If this is a CALL_INSN, then mark it as reaching the active EH
363 handler for this CALL_INSN. If we're handling non-call
364 exceptions then any insn can reach any of the active handlers.
365 Also mark the CALL_INSN as reaching any nonlocal goto handler. */
366 else if (code
== CALL_INSN
|| flag_non_call_exceptions
)
368 /* Add any appropriate EH edges. */
369 rtl_make_eh_edge (edge_cache
, bb
, insn
);
371 if (code
== CALL_INSN
&& nonlocal_goto_handler_labels
)
373 /* ??? This could be made smarter: in some cases it's possible
374 to tell that certain calls will not do a nonlocal goto.
375 For example, if the nested functions that do the nonlocal
376 gotos do not have their addresses taken, then only calls to
377 those functions or to other nested functions that use them
378 could possibly do nonlocal gotos. */
380 /* We do know that a REG_EH_REGION note with a value less
381 than 0 is guaranteed not to perform a non-local goto. */
382 rtx note
= find_reg_note (insn
, REG_EH_REGION
, NULL_RTX
);
384 if (!note
|| INTVAL (XEXP (note
, 0)) >= 0)
385 for (x
= nonlocal_goto_handler_labels
; x
; x
= XEXP (x
, 1))
386 make_label_edge (edge_cache
, bb
, XEXP (x
, 0),
387 EDGE_ABNORMAL
| EDGE_ABNORMAL_CALL
);
391 /* Find out if we can drop through to the next block. */
392 insn
= NEXT_INSN (insn
);
393 FOR_EACH_EDGE (e
, ei
, bb
->succs
)
394 if (e
->dest
== EXIT_BLOCK_PTR
&& e
->flags
& EDGE_FALLTHRU
)
401 && NOTE_LINE_NUMBER (insn
) != NOTE_INSN_BASIC_BLOCK
)
402 insn
= NEXT_INSN (insn
);
404 if (!insn
|| (bb
->next_bb
== EXIT_BLOCK_PTR
&& force_fallthru
))
405 cached_make_edge (edge_cache
, bb
, EXIT_BLOCK_PTR
, EDGE_FALLTHRU
);
406 else if (bb
->next_bb
!= EXIT_BLOCK_PTR
)
408 if (force_fallthru
|| insn
== BB_HEAD (bb
->next_bb
))
409 cached_make_edge (edge_cache
, bb
, bb
->next_bb
, EDGE_FALLTHRU
);
414 sbitmap_vector_free (edge_cache
);
417 /* Find all basic blocks of the function whose first insn is F.
419 Collect and return a list of labels whose addresses are taken. This
420 will be used in make_edges for use with computed gotos. */
423 find_basic_blocks_1 (rtx f
)
426 rtx bb_note
= NULL_RTX
;
429 basic_block prev
= ENTRY_BLOCK_PTR
;
431 /* We process the instructions in a slightly different way than we did
432 previously. This is so that we see a NOTE_BASIC_BLOCK after we have
433 closed out the previous block, so that it gets attached at the proper
434 place. Since this form should be equivalent to the previous,
435 count_basic_blocks continues to use the old form as a check. */
437 for (insn
= f
; insn
; insn
= next
)
439 enum rtx_code code
= GET_CODE (insn
);
441 next
= NEXT_INSN (insn
);
443 if ((LABEL_P (insn
) || BARRIER_P (insn
))
446 prev
= create_basic_block_structure (head
, end
, bb_note
, prev
);
447 head
= end
= NULL_RTX
;
451 if (inside_basic_block_p (insn
))
453 if (head
== NULL_RTX
)
458 if (head
&& control_flow_insn_p (insn
))
460 prev
= create_basic_block_structure (head
, end
, bb_note
, prev
);
461 head
= end
= NULL_RTX
;
469 int kind
= NOTE_LINE_NUMBER (insn
);
471 /* Look for basic block notes with which to keep the
472 basic_block_info pointers stable. Unthread the note now;
473 we'll put it back at the right place in create_basic_block.
474 Or not at all if we've already found a note in this block. */
475 if (kind
== NOTE_INSN_BASIC_BLOCK
)
477 if (bb_note
== NULL_RTX
)
480 next
= delete_insn (insn
);
497 if (head
!= NULL_RTX
)
498 create_basic_block_structure (head
, end
, bb_note
, prev
);
500 delete_insn (bb_note
);
502 gcc_assert (last_basic_block
== n_basic_blocks
);
504 clear_aux_for_blocks ();
508 /* Find basic blocks of the current function.
509 F is the first insn of the function and NREGS the number of register
513 find_basic_blocks (rtx f
, int nregs ATTRIBUTE_UNUSED
,
514 FILE *file ATTRIBUTE_UNUSED
)
518 timevar_push (TV_CFG
);
520 /* Flush out existing data. */
521 if (basic_block_info
!= NULL
)
525 /* Clear bb->aux on all extant basic blocks. We'll use this as a
526 tag for reuse during create_basic_block, just in case some pass
527 copies around basic block notes improperly. */
531 basic_block_info
= NULL
;
534 n_basic_blocks
= count_basic_blocks (f
);
535 last_basic_block
= 0;
536 ENTRY_BLOCK_PTR
->next_bb
= EXIT_BLOCK_PTR
;
537 EXIT_BLOCK_PTR
->prev_bb
= ENTRY_BLOCK_PTR
;
539 /* Size the basic block table. The actual structures will be allocated
540 by find_basic_blocks_1, since we want to keep the structure pointers
541 stable across calls to find_basic_blocks. */
542 /* ??? This whole issue would be much simpler if we called find_basic_blocks
543 exactly once, and thereafter we don't have a single long chain of
544 instructions at all until close to the end of compilation when we
545 actually lay them out. */
547 VARRAY_BB_INIT (basic_block_info
, n_basic_blocks
, "basic_block_info");
549 find_basic_blocks_1 (f
);
551 profile_status
= PROFILE_ABSENT
;
553 /* Discover the edges of our cfg. */
554 make_edges (ENTRY_BLOCK_PTR
->next_bb
, EXIT_BLOCK_PTR
->prev_bb
, 0);
556 /* Do very simple cleanup now, for the benefit of code that runs between
557 here and cleanup_cfg, e.g. thread_prologue_and_epilogue_insns. */
558 tidy_fallthru_edges ();
560 #ifdef ENABLE_CHECKING
563 timevar_pop (TV_CFG
);
566 /* State of basic block as seen by find_sub_basic_blocks. */
567 enum state
{BLOCK_NEW
= 0, BLOCK_ORIGINAL
, BLOCK_TO_SPLIT
};
569 #define STATE(BB) (enum state) ((size_t) (BB)->aux)
570 #define SET_STATE(BB, STATE) ((BB)->aux = (void *) (size_t) (STATE))
572 /* Scan basic block BB for possible BB boundaries inside the block
573 and create new basic blocks in the progress. */
576 find_bb_boundaries (basic_block bb
)
578 rtx insn
= BB_HEAD (bb
);
579 rtx end
= BB_END (bb
);
580 rtx flow_transfer_insn
= NULL_RTX
;
581 edge fallthru
= NULL
;
583 if (insn
== BB_END (bb
))
587 insn
= NEXT_INSN (insn
);
589 /* Scan insn chain and try to find new basic block boundaries. */
592 enum rtx_code code
= GET_CODE (insn
);
594 /* On code label, split current basic block. */
595 if (code
== CODE_LABEL
)
597 fallthru
= split_block (bb
, PREV_INSN (insn
));
598 if (flow_transfer_insn
)
599 BB_END (bb
) = flow_transfer_insn
;
602 remove_edge (fallthru
);
603 flow_transfer_insn
= NULL_RTX
;
604 if (LABEL_ALT_ENTRY_P (insn
))
605 make_edge (ENTRY_BLOCK_PTR
, bb
, 0);
608 /* In case we've previously seen an insn that effects a control
609 flow transfer, split the block. */
610 if (flow_transfer_insn
&& inside_basic_block_p (insn
))
612 fallthru
= split_block (bb
, PREV_INSN (insn
));
613 BB_END (bb
) = flow_transfer_insn
;
615 remove_edge (fallthru
);
616 flow_transfer_insn
= NULL_RTX
;
619 if (control_flow_insn_p (insn
))
620 flow_transfer_insn
= insn
;
623 insn
= NEXT_INSN (insn
);
626 /* In case expander replaced normal insn by sequence terminating by
627 return and barrier, or possibly other sequence not behaving like
628 ordinary jump, we need to take care and move basic block boundary. */
629 if (flow_transfer_insn
)
630 BB_END (bb
) = flow_transfer_insn
;
632 /* We've possibly replaced the conditional jump by conditional jump
633 followed by cleanup at fallthru edge, so the outgoing edges may
635 purge_dead_edges (bb
);
638 /* Assume that frequency of basic block B is known. Compute frequencies
639 and probabilities of outgoing edges. */
642 compute_outgoing_frequencies (basic_block b
)
647 if (EDGE_COUNT (b
->succs
) == 2)
649 rtx note
= find_reg_note (BB_END (b
), REG_BR_PROB
, NULL
);
654 probability
= INTVAL (XEXP (note
, 0));
656 e
->probability
= probability
;
657 e
->count
= ((b
->count
* probability
+ REG_BR_PROB_BASE
/ 2)
659 f
= FALLTHRU_EDGE (b
);
660 f
->probability
= REG_BR_PROB_BASE
- probability
;
661 f
->count
= b
->count
- e
->count
;
666 if (EDGE_COUNT (b
->succs
) == 1)
668 e
= EDGE_SUCC (b
, 0);
669 e
->probability
= REG_BR_PROB_BASE
;
673 guess_outgoing_edge_probabilities (b
);
675 FOR_EACH_EDGE (e
, ei
, b
->succs
)
676 e
->count
= ((b
->count
* e
->probability
+ REG_BR_PROB_BASE
/ 2)
680 /* Assume that someone emitted code with control flow instructions to the
681 basic block. Update the data structure. */
684 find_many_sub_basic_blocks (sbitmap blocks
)
686 basic_block bb
, min
, max
;
690 TEST_BIT (blocks
, bb
->index
) ? BLOCK_TO_SPLIT
: BLOCK_ORIGINAL
);
693 if (STATE (bb
) == BLOCK_TO_SPLIT
)
694 find_bb_boundaries (bb
);
697 if (STATE (bb
) != BLOCK_ORIGINAL
)
701 for (; bb
!= EXIT_BLOCK_PTR
; bb
= bb
->next_bb
)
702 if (STATE (bb
) != BLOCK_ORIGINAL
)
705 /* Now re-scan and wire in all edges. This expect simple (conditional)
706 jumps at the end of each new basic blocks. */
707 make_edges (min
, max
, 1);
709 /* Update branch probabilities. Expect only (un)conditional jumps
710 to be created with only the forward edges. */
711 if (profile_status
!= PROFILE_ABSENT
)
712 FOR_BB_BETWEEN (bb
, min
, max
->next_bb
, next_bb
)
717 if (STATE (bb
) == BLOCK_ORIGINAL
)
719 if (STATE (bb
) == BLOCK_NEW
)
723 FOR_EACH_EDGE (e
, ei
, bb
->preds
)
725 bb
->count
+= e
->count
;
726 bb
->frequency
+= EDGE_FREQUENCY (e
);
730 compute_outgoing_frequencies (bb
);
737 /* Like above but for single basic block only. */
740 find_sub_basic_blocks (basic_block bb
)
742 basic_block min
, max
, b
;
743 basic_block next
= bb
->next_bb
;
746 find_bb_boundaries (bb
);
749 /* Now re-scan and wire in all edges. This expect simple (conditional)
750 jumps at the end of each new basic blocks. */
751 make_edges (min
, max
, 1);
753 /* Update branch probabilities. Expect only (un)conditional jumps
754 to be created with only the forward edges. */
755 FOR_BB_BETWEEN (b
, min
, max
->next_bb
, next_bb
)
764 FOR_EACH_EDGE (e
, ei
, b
->preds
)
766 b
->count
+= e
->count
;
767 b
->frequency
+= EDGE_FREQUENCY (e
);
771 compute_outgoing_frequencies (b
);