Daily bump.
[official-gcc.git] / gcc / cfgrtl.c
blob25a5c9f78b57aa4762607fcd0ba4854335ef54c8
1 /* Control flow graph manipulation code for GNU compiler.
2 Copyright (C) 1987, 1988, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
3 1999, 2000, 2001, 2002 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
10 version.
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
15 for more details.
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
20 02111-1307, USA. */
22 /* This file contains low level functions to manipulate the CFG and analyze it
23 that are aware of the RTL intermediate language.
25 Available functionality:
26 - CFG-aware instruction chain manipulation
27 delete_insn, delete_insn_chain
28 - Basic block manipulation
29 create_basic_block, flow_delete_block, split_block,
30 merge_blocks_nomove
31 - Infrastructure to determine quickly basic block for insn
32 compute_bb_for_insn, update_bb_for_insn, set_block_for_insn,
33 - Edge redirection with updating and optimizing of insn chain
34 block_label, redirect_edge_and_branch,
35 redirect_edge_and_branch_force, tidy_fallthru_edge, force_nonfallthru
36 - Edge splitting and commiting to edges
37 split_edge, insert_insn_on_edge, commit_edge_insertions
38 - Dumping and debugging
39 print_rtl_with_bb, dump_bb, debug_bb, debug_bb_n
40 - Consistency checking
41 verify_flow_info
42 - CFG updating after constant propagation
43 purge_dead_edges, purge_all_dead_edges */
45 #include "config.h"
46 #include "system.h"
47 #include "tree.h"
48 #include "rtl.h"
49 #include "hard-reg-set.h"
50 #include "basic-block.h"
51 #include "regs.h"
52 #include "flags.h"
53 #include "output.h"
54 #include "function.h"
55 #include "except.h"
56 #include "toplev.h"
57 #include "tm_p.h"
58 #include "obstack.h"
59 #include "insn-config.h"
61 /* Stubs in case we don't have a return insn. */
62 #ifndef HAVE_return
63 #define HAVE_return 0
64 #define gen_return() NULL_RTX
65 #endif
67 /* The labels mentioned in non-jump rtl. Valid during find_basic_blocks. */
68 /* ??? Should probably be using LABEL_NUSES instead. It would take a
69 bit of surgery to be able to use or co-opt the routines in jump. */
70 rtx label_value_list;
71 rtx tail_recursion_label_list;
73 static int can_delete_note_p PARAMS ((rtx));
74 static int can_delete_label_p PARAMS ((rtx));
75 static void commit_one_edge_insertion PARAMS ((edge, int));
76 static bool try_redirect_by_replacing_jump PARAMS ((edge, basic_block));
77 static rtx last_loop_beg_note PARAMS ((rtx));
78 static bool back_edge_of_syntactic_loop_p PARAMS ((basic_block, basic_block));
79 static basic_block force_nonfallthru_and_redirect PARAMS ((edge, basic_block));
81 /* Return true if NOTE is not one of the ones that must be kept paired,
82 so that we may simply delete it. */
84 static int
85 can_delete_note_p (note)
86 rtx note;
88 return (NOTE_LINE_NUMBER (note) == NOTE_INSN_DELETED
89 || NOTE_LINE_NUMBER (note) == NOTE_INSN_BASIC_BLOCK
90 || NOTE_LINE_NUMBER (note) == NOTE_INSN_PREDICTION);
93 /* True if a given label can be deleted. */
95 static int
96 can_delete_label_p (label)
97 rtx label;
99 return (!LABEL_PRESERVE_P (label)
100 /* User declared labels must be preserved. */
101 && LABEL_NAME (label) == 0
102 && !in_expr_list_p (forced_labels, label)
103 && !in_expr_list_p (label_value_list, label));
106 /* Delete INSN by patching it out. Return the next insn. */
109 delete_insn (insn)
110 rtx insn;
112 rtx next = NEXT_INSN (insn);
113 rtx note;
114 bool really_delete = true;
116 if (GET_CODE (insn) == CODE_LABEL)
118 /* Some labels can't be directly removed from the INSN chain, as they
119 might be references via variables, constant pool etc.
120 Convert them to the special NOTE_INSN_DELETED_LABEL note. */
121 if (! can_delete_label_p (insn))
123 const char *name = LABEL_NAME (insn);
125 really_delete = false;
126 PUT_CODE (insn, NOTE);
127 NOTE_LINE_NUMBER (insn) = NOTE_INSN_DELETED_LABEL;
128 NOTE_SOURCE_FILE (insn) = name;
131 remove_node_from_expr_list (insn, &nonlocal_goto_handler_labels);
134 if (really_delete)
136 /* If this insn has already been deleted, something is very wrong. */
137 if (INSN_DELETED_P (insn))
138 abort ();
139 remove_insn (insn);
140 INSN_DELETED_P (insn) = 1;
143 /* If deleting a jump, decrement the use count of the label. Deleting
144 the label itself should happen in the normal course of block merging. */
145 if (GET_CODE (insn) == JUMP_INSN
146 && JUMP_LABEL (insn)
147 && GET_CODE (JUMP_LABEL (insn)) == CODE_LABEL)
148 LABEL_NUSES (JUMP_LABEL (insn))--;
150 /* Also if deleting an insn that references a label. */
151 else if ((note = find_reg_note (insn, REG_LABEL, NULL_RTX)) != NULL_RTX
152 && GET_CODE (XEXP (note, 0)) == CODE_LABEL)
153 LABEL_NUSES (XEXP (note, 0))--;
155 if (GET_CODE (insn) == JUMP_INSN
156 && (GET_CODE (PATTERN (insn)) == ADDR_VEC
157 || GET_CODE (PATTERN (insn)) == ADDR_DIFF_VEC))
159 rtx pat = PATTERN (insn);
160 int diff_vec_p = GET_CODE (PATTERN (insn)) == ADDR_DIFF_VEC;
161 int len = XVECLEN (pat, diff_vec_p);
162 int i;
164 for (i = 0; i < len; i++)
166 rtx label = XEXP (XVECEXP (pat, diff_vec_p, i), 0);
168 /* When deleting code in bulk (e.g. removing many unreachable
169 blocks) we can delete a label that's a target of the vector
170 before deleting the vector itself. */
171 if (GET_CODE (label) != NOTE)
172 LABEL_NUSES (label)--;
176 return next;
179 /* Like delete_insn but also purge dead edges from BB. */
181 delete_insn_and_edges (insn)
182 rtx insn;
184 rtx x;
185 bool purge = false;
187 if (INSN_P (insn)
188 && BLOCK_FOR_INSN (insn)
189 && BLOCK_FOR_INSN (insn)->end == insn)
190 purge = true;
191 x = delete_insn (insn);
192 if (purge)
193 purge_dead_edges (BLOCK_FOR_INSN (insn));
194 return x;
197 /* Unlink a chain of insns between START and FINISH, leaving notes
198 that must be paired. */
200 void
201 delete_insn_chain (start, finish)
202 rtx start, finish;
204 rtx next;
206 /* Unchain the insns one by one. It would be quicker to delete all of these
207 with a single unchaining, rather than one at a time, but we need to keep
208 the NOTE's. */
209 while (1)
211 next = NEXT_INSN (start);
212 if (GET_CODE (start) == NOTE && !can_delete_note_p (start))
214 else
215 next = delete_insn (start);
217 if (start == finish)
218 break;
219 start = next;
223 /* Like delete_insn but also purge dead edges from BB. */
224 void
225 delete_insn_chain_and_edges (first, last)
226 rtx first, last;
228 bool purge = false;
230 if (INSN_P (last)
231 && BLOCK_FOR_INSN (last)
232 && BLOCK_FOR_INSN (last)->end == last)
233 purge = true;
234 delete_insn_chain (first, last);
235 if (purge)
236 purge_dead_edges (BLOCK_FOR_INSN (last));
239 /* Create a new basic block consisting of the instructions between HEAD and END
240 inclusive. This function is designed to allow fast BB construction - reuses
241 the note and basic block struct in BB_NOTE, if any and do not grow
242 BASIC_BLOCK chain and should be used directly only by CFG construction code.
243 END can be NULL in to create new empty basic block before HEAD. Both END
244 and HEAD can be NULL to create basic block at the end of INSN chain.
245 AFTER is the basic block we should be put after. */
247 basic_block
248 create_basic_block_structure (head, end, bb_note, after)
249 rtx head, end, bb_note;
250 basic_block after;
252 basic_block bb;
254 if (bb_note
255 && ! RTX_INTEGRATED_P (bb_note)
256 && (bb = NOTE_BASIC_BLOCK (bb_note)) != NULL
257 && bb->aux == NULL)
259 /* If we found an existing note, thread it back onto the chain. */
261 rtx after;
263 if (GET_CODE (head) == CODE_LABEL)
264 after = head;
265 else
267 after = PREV_INSN (head);
268 head = bb_note;
271 if (after != bb_note && NEXT_INSN (after) != bb_note)
272 reorder_insns_nobb (bb_note, bb_note, after);
274 else
276 /* Otherwise we must create a note and a basic block structure. */
278 bb = alloc_block ();
280 if (!head && !end)
281 head = end = bb_note
282 = emit_note_after (NOTE_INSN_BASIC_BLOCK, get_last_insn ());
283 else if (GET_CODE (head) == CODE_LABEL && end)
285 bb_note = emit_note_after (NOTE_INSN_BASIC_BLOCK, head);
286 if (head == end)
287 end = bb_note;
289 else
291 bb_note = emit_note_before (NOTE_INSN_BASIC_BLOCK, head);
292 head = bb_note;
293 if (!end)
294 end = head;
297 NOTE_BASIC_BLOCK (bb_note) = bb;
300 /* Always include the bb note in the block. */
301 if (NEXT_INSN (end) == bb_note)
302 end = bb_note;
304 bb->head = head;
305 bb->end = end;
306 bb->index = last_basic_block++;
307 bb->flags = BB_NEW;
308 link_block (bb, after);
309 BASIC_BLOCK (bb->index) = bb;
310 update_bb_for_insn (bb);
312 /* Tag the block so that we know it has been used when considering
313 other basic block notes. */
314 bb->aux = bb;
316 return bb;
319 /* Create new basic block consisting of instructions in between HEAD and END
320 and place it to the BB chain after block AFTER. END can be NULL in to
321 create new empty basic block before HEAD. Both END and HEAD can be NULL to
322 create basic block at the end of INSN chain. */
324 basic_block
325 create_basic_block (head, end, after)
326 rtx head, end;
327 basic_block after;
329 basic_block bb;
331 /* Place the new block just after the end. */
332 VARRAY_GROW (basic_block_info, last_basic_block+1);
334 n_basic_blocks++;
336 bb = create_basic_block_structure (head, end, NULL, after);
337 bb->aux = NULL;
338 return bb;
341 /* Delete the insns in a (non-live) block. We physically delete every
342 non-deleted-note insn, and update the flow graph appropriately.
344 Return nonzero if we deleted an exception handler. */
346 /* ??? Preserving all such notes strikes me as wrong. It would be nice
347 to post-process the stream to remove empty blocks, loops, ranges, etc. */
350 flow_delete_block_noexpunge (b)
351 basic_block b;
353 int deleted_handler = 0;
354 rtx insn, end, tmp;
356 /* If the head of this block is a CODE_LABEL, then it might be the
357 label for an exception handler which can't be reached.
359 We need to remove the label from the exception_handler_label list
360 and remove the associated NOTE_INSN_EH_REGION_BEG and
361 NOTE_INSN_EH_REGION_END notes. */
363 /* Get rid of all NOTE_INSN_PREDICTIONs hanging before the block. */
365 for (insn = PREV_INSN (b->head); insn; insn = PREV_INSN (insn))
367 if (GET_CODE (insn) != NOTE)
368 break;
369 if (NOTE_LINE_NUMBER (insn) == NOTE_INSN_PREDICTION)
370 NOTE_LINE_NUMBER (insn) = NOTE_INSN_DELETED;
373 insn = b->head;
375 never_reached_warning (insn, b->end);
377 if (GET_CODE (insn) == CODE_LABEL)
378 maybe_remove_eh_handler (insn);
380 /* Include any jump table following the basic block. */
381 end = b->end;
382 if (GET_CODE (end) == JUMP_INSN
383 && (tmp = JUMP_LABEL (end)) != NULL_RTX
384 && (tmp = NEXT_INSN (tmp)) != NULL_RTX
385 && GET_CODE (tmp) == JUMP_INSN
386 && (GET_CODE (PATTERN (tmp)) == ADDR_VEC
387 || GET_CODE (PATTERN (tmp)) == ADDR_DIFF_VEC))
388 end = tmp;
390 /* Include any barrier that may follow the basic block. */
391 tmp = next_nonnote_insn (end);
392 if (tmp && GET_CODE (tmp) == BARRIER)
393 end = tmp;
395 /* Selectively delete the entire chain. */
396 b->head = NULL;
397 delete_insn_chain (insn, end);
399 /* Remove the edges into and out of this block. Note that there may
400 indeed be edges in, if we are removing an unreachable loop. */
401 while (b->pred != NULL)
402 remove_edge (b->pred);
403 while (b->succ != NULL)
404 remove_edge (b->succ);
406 b->pred = NULL;
407 b->succ = NULL;
409 return deleted_handler;
413 flow_delete_block (b)
414 basic_block b;
416 int deleted_handler = flow_delete_block_noexpunge (b);
418 /* Remove the basic block from the array. */
419 expunge_block (b);
421 return deleted_handler;
424 /* Records the basic block struct in BLOCK_FOR_INSN for every insn. */
426 void
427 compute_bb_for_insn ()
429 basic_block bb;
431 FOR_EACH_BB (bb)
433 rtx end = bb->end;
434 rtx insn;
436 for (insn = bb->head; ; insn = NEXT_INSN (insn))
438 BLOCK_FOR_INSN (insn) = bb;
439 if (insn == end)
440 break;
445 /* Release the basic_block_for_insn array. */
447 void
448 free_bb_for_insn ()
450 rtx insn;
451 for (insn = get_insns (); insn; insn = NEXT_INSN (insn))
452 if (GET_CODE (insn) != BARRIER)
453 BLOCK_FOR_INSN (insn) = NULL;
456 /* Update insns block within BB. */
458 void
459 update_bb_for_insn (bb)
460 basic_block bb;
462 rtx insn;
464 for (insn = bb->head; ; insn = NEXT_INSN (insn))
466 set_block_for_insn (insn, bb);
467 if (insn == bb->end)
468 break;
472 /* Split a block BB after insn INSN creating a new fallthru edge.
473 Return the new edge. Note that to keep other parts of the compiler happy,
474 this function renumbers all the basic blocks so that the new
475 one has a number one greater than the block split. */
477 edge
478 split_block (bb, insn)
479 basic_block bb;
480 rtx insn;
482 basic_block new_bb;
483 edge new_edge;
484 edge e;
486 /* There is no point splitting the block after its end. */
487 if (bb->end == insn)
488 return 0;
490 /* Create the new basic block. */
491 new_bb = create_basic_block (NEXT_INSN (insn), bb->end, bb);
492 new_bb->count = bb->count;
493 new_bb->frequency = bb->frequency;
494 new_bb->loop_depth = bb->loop_depth;
495 bb->end = insn;
497 /* Redirect the outgoing edges. */
498 new_bb->succ = bb->succ;
499 bb->succ = NULL;
500 for (e = new_bb->succ; e; e = e->succ_next)
501 e->src = new_bb;
503 new_edge = make_single_succ_edge (bb, new_bb, EDGE_FALLTHRU);
505 if (bb->global_live_at_start)
507 new_bb->global_live_at_start = OBSTACK_ALLOC_REG_SET (&flow_obstack);
508 new_bb->global_live_at_end = OBSTACK_ALLOC_REG_SET (&flow_obstack);
509 COPY_REG_SET (new_bb->global_live_at_end, bb->global_live_at_end);
511 /* We now have to calculate which registers are live at the end
512 of the split basic block and at the start of the new basic
513 block. Start with those registers that are known to be live
514 at the end of the original basic block and get
515 propagate_block to determine which registers are live. */
516 COPY_REG_SET (new_bb->global_live_at_start, bb->global_live_at_end);
517 propagate_block (new_bb, new_bb->global_live_at_start, NULL, NULL, 0);
518 COPY_REG_SET (bb->global_live_at_end,
519 new_bb->global_live_at_start);
520 #ifdef HAVE_conditional_execution
521 /* In the presence of conditional execution we are not able to update
522 liveness precisely. */
523 if (reload_completed)
525 bb->flags |= BB_DIRTY;
526 new_bb->flags |= BB_DIRTY;
528 #endif
531 return new_edge;
534 /* Blocks A and B are to be merged into a single block A. The insns
535 are already contiguous, hence `nomove'. */
537 void
538 merge_blocks_nomove (a, b)
539 basic_block a, b;
541 rtx b_head = b->head, b_end = b->end, a_end = a->end;
542 rtx del_first = NULL_RTX, del_last = NULL_RTX;
543 int b_empty = 0;
544 edge e;
546 /* If there was a CODE_LABEL beginning B, delete it. */
547 if (GET_CODE (b_head) == CODE_LABEL)
549 /* Detect basic blocks with nothing but a label. This can happen
550 in particular at the end of a function. */
551 if (b_head == b_end)
552 b_empty = 1;
554 del_first = del_last = b_head;
555 b_head = NEXT_INSN (b_head);
558 /* Delete the basic block note and handle blocks containing just that
559 note. */
560 if (NOTE_INSN_BASIC_BLOCK_P (b_head))
562 if (b_head == b_end)
563 b_empty = 1;
564 if (! del_last)
565 del_first = b_head;
567 del_last = b_head;
568 b_head = NEXT_INSN (b_head);
571 /* If there was a jump out of A, delete it. */
572 if (GET_CODE (a_end) == JUMP_INSN)
574 rtx prev;
576 for (prev = PREV_INSN (a_end); ; prev = PREV_INSN (prev))
577 if (GET_CODE (prev) != NOTE
578 || NOTE_LINE_NUMBER (prev) == NOTE_INSN_BASIC_BLOCK
579 || prev == a->head)
580 break;
582 del_first = a_end;
584 #ifdef HAVE_cc0
585 /* If this was a conditional jump, we need to also delete
586 the insn that set cc0. */
587 if (only_sets_cc0_p (prev))
589 rtx tmp = prev;
591 prev = prev_nonnote_insn (prev);
592 if (!prev)
593 prev = a->head;
594 del_first = tmp;
596 #endif
598 a_end = PREV_INSN (del_first);
600 else if (GET_CODE (NEXT_INSN (a_end)) == BARRIER)
601 del_first = NEXT_INSN (a_end);
603 /* Normally there should only be one successor of A and that is B, but
604 partway though the merge of blocks for conditional_execution we'll
605 be merging a TEST block with THEN and ELSE successors. Free the
606 whole lot of them and hope the caller knows what they're doing. */
607 while (a->succ)
608 remove_edge (a->succ);
610 /* Adjust the edges out of B for the new owner. */
611 for (e = b->succ; e; e = e->succ_next)
612 e->src = a;
613 a->succ = b->succ;
614 a->flags |= b->flags;
616 /* B hasn't quite yet ceased to exist. Attempt to prevent mishap. */
617 b->pred = b->succ = NULL;
618 a->global_live_at_end = b->global_live_at_end;
620 expunge_block (b);
622 /* Delete everything marked above as well as crap that might be
623 hanging out between the two blocks. */
624 delete_insn_chain (del_first, del_last);
626 /* Reassociate the insns of B with A. */
627 if (!b_empty)
629 rtx x;
631 for (x = a_end; x != b_end; x = NEXT_INSN (x))
632 set_block_for_insn (x, a);
634 set_block_for_insn (b_end, a);
636 a_end = b_end;
639 a->end = a_end;
642 /* Return the label in the head of basic block BLOCK. Create one if it doesn't
643 exist. */
646 block_label (block)
647 basic_block block;
649 if (block == EXIT_BLOCK_PTR)
650 return NULL_RTX;
652 if (GET_CODE (block->head) != CODE_LABEL)
654 block->head = emit_label_before (gen_label_rtx (), block->head);
657 return block->head;
660 /* Attempt to perform edge redirection by replacing possibly complex jump
661 instruction by unconditional jump or removing jump completely. This can
662 apply only if all edges now point to the same block. The parameters and
663 return values are equivalent to redirect_edge_and_branch. */
665 static bool
666 try_redirect_by_replacing_jump (e, target)
667 edge e;
668 basic_block target;
670 basic_block src = e->src;
671 rtx insn = src->end, kill_from;
672 edge tmp;
673 rtx set, table;
674 int fallthru = 0;
676 /* Verify that all targets will be TARGET. */
677 for (tmp = src->succ; tmp; tmp = tmp->succ_next)
678 if (tmp->dest != target && tmp != e)
679 break;
681 if (tmp || !onlyjump_p (insn))
682 return false;
683 if (reload_completed && JUMP_LABEL (insn)
684 && (table = NEXT_INSN (JUMP_LABEL (insn))) != NULL_RTX
685 && GET_CODE (table) == JUMP_INSN
686 && (GET_CODE (PATTERN (table)) == ADDR_VEC
687 || GET_CODE (PATTERN (table)) == ADDR_DIFF_VEC))
688 return false;
690 /* Avoid removing branch with side effects. */
691 set = single_set (insn);
692 if (!set || side_effects_p (set))
693 return false;
695 /* In case we zap a conditional jump, we'll need to kill
696 the cc0 setter too. */
697 kill_from = insn;
698 #ifdef HAVE_cc0
699 if (reg_mentioned_p (cc0_rtx, PATTERN (insn)))
700 kill_from = PREV_INSN (insn);
701 #endif
703 /* See if we can create the fallthru edge. */
704 if (can_fallthru (src, target))
706 if (rtl_dump_file)
707 fprintf (rtl_dump_file, "Removing jump %i.\n", INSN_UID (insn));
708 fallthru = 1;
710 /* Selectively unlink whole insn chain. */
711 delete_insn_chain (kill_from, PREV_INSN (target->head));
714 /* If this already is simplejump, redirect it. */
715 else if (simplejump_p (insn))
717 if (e->dest == target)
718 return false;
719 if (rtl_dump_file)
720 fprintf (rtl_dump_file, "Redirecting jump %i from %i to %i.\n",
721 INSN_UID (insn), e->dest->index, target->index);
722 if (!redirect_jump (insn, block_label (target), 0))
724 if (target == EXIT_BLOCK_PTR)
725 return false;
726 abort ();
730 /* Cannot do anything for target exit block. */
731 else if (target == EXIT_BLOCK_PTR)
732 return false;
734 /* Or replace possibly complicated jump insn by simple jump insn. */
735 else
737 rtx target_label = block_label (target);
738 rtx barrier, tmp;
740 emit_jump_insn_after (gen_jump (target_label), insn);
741 JUMP_LABEL (src->end) = target_label;
742 LABEL_NUSES (target_label)++;
743 if (rtl_dump_file)
744 fprintf (rtl_dump_file, "Replacing insn %i by jump %i\n",
745 INSN_UID (insn), INSN_UID (src->end));
748 delete_insn_chain (kill_from, insn);
750 /* Recognize a tablejump that we are converting to a
751 simple jump and remove its associated CODE_LABEL
752 and ADDR_VEC or ADDR_DIFF_VEC. */
753 if ((tmp = JUMP_LABEL (insn)) != NULL_RTX
754 && (tmp = NEXT_INSN (tmp)) != NULL_RTX
755 && GET_CODE (tmp) == JUMP_INSN
756 && (GET_CODE (PATTERN (tmp)) == ADDR_VEC
757 || GET_CODE (PATTERN (tmp)) == ADDR_DIFF_VEC))
759 delete_insn_chain (JUMP_LABEL (insn), tmp);
762 barrier = next_nonnote_insn (src->end);
763 if (!barrier || GET_CODE (barrier) != BARRIER)
764 emit_barrier_after (src->end);
767 /* Keep only one edge out and set proper flags. */
768 while (src->succ->succ_next)
769 remove_edge (src->succ);
770 e = src->succ;
771 if (fallthru)
772 e->flags = EDGE_FALLTHRU;
773 else
774 e->flags = 0;
776 e->probability = REG_BR_PROB_BASE;
777 e->count = src->count;
779 /* We don't want a block to end on a line-number note since that has
780 the potential of changing the code between -g and not -g. */
781 while (GET_CODE (e->src->end) == NOTE
782 && NOTE_LINE_NUMBER (e->src->end) >= 0)
783 delete_insn (e->src->end);
785 if (e->dest != target)
786 redirect_edge_succ (e, target);
788 return true;
791 /* Return last loop_beg note appearing after INSN, before start of next
792 basic block. Return INSN if there are no such notes.
794 When emitting jump to redirect an fallthru edge, it should always appear
795 after the LOOP_BEG notes, as loop optimizer expect loop to either start by
796 fallthru edge or jump following the LOOP_BEG note jumping to the loop exit
797 test. */
799 static rtx
800 last_loop_beg_note (insn)
801 rtx insn;
803 rtx last = insn;
805 for (insn = NEXT_INSN (insn); insn && GET_CODE (insn) == NOTE
806 && NOTE_LINE_NUMBER (insn) != NOTE_INSN_BASIC_BLOCK;
807 insn = NEXT_INSN (insn))
808 if (NOTE_LINE_NUMBER (insn) == NOTE_INSN_LOOP_BEG)
809 last = insn;
811 return last;
814 /* Attempt to change code to redirect edge E to TARGET. Don't do that on
815 expense of adding new instructions or reordering basic blocks.
817 Function can be also called with edge destination equivalent to the TARGET.
818 Then it should try the simplifications and do nothing if none is possible.
820 Return true if transformation succeeded. We still return false in case E
821 already destinated TARGET and we didn't managed to simplify instruction
822 stream. */
824 bool
825 redirect_edge_and_branch (e, target)
826 edge e;
827 basic_block target;
829 rtx tmp;
830 rtx old_label = e->dest->head;
831 basic_block src = e->src;
832 rtx insn = src->end;
834 if (e->flags & (EDGE_ABNORMAL_CALL | EDGE_EH))
835 return false;
837 if (try_redirect_by_replacing_jump (e, target))
838 return true;
840 /* Do this fast path late, as we want above code to simplify for cases
841 where called on single edge leaving basic block containing nontrivial
842 jump insn. */
843 else if (e->dest == target)
844 return false;
846 /* We can only redirect non-fallthru edges of jump insn. */
847 if (e->flags & EDGE_FALLTHRU)
848 return false;
849 else if (GET_CODE (insn) != JUMP_INSN)
850 return false;
852 /* Recognize a tablejump and adjust all matching cases. */
853 if ((tmp = JUMP_LABEL (insn)) != NULL_RTX
854 && (tmp = NEXT_INSN (tmp)) != NULL_RTX
855 && GET_CODE (tmp) == JUMP_INSN
856 && (GET_CODE (PATTERN (tmp)) == ADDR_VEC
857 || GET_CODE (PATTERN (tmp)) == ADDR_DIFF_VEC))
859 rtvec vec;
860 int j;
861 rtx new_label = block_label (target);
863 if (target == EXIT_BLOCK_PTR)
864 return false;
865 if (GET_CODE (PATTERN (tmp)) == ADDR_VEC)
866 vec = XVEC (PATTERN (tmp), 0);
867 else
868 vec = XVEC (PATTERN (tmp), 1);
870 for (j = GET_NUM_ELEM (vec) - 1; j >= 0; --j)
871 if (XEXP (RTVEC_ELT (vec, j), 0) == old_label)
873 RTVEC_ELT (vec, j) = gen_rtx_LABEL_REF (Pmode, new_label);
874 --LABEL_NUSES (old_label);
875 ++LABEL_NUSES (new_label);
878 /* Handle casesi dispatch insns */
879 if ((tmp = single_set (insn)) != NULL
880 && SET_DEST (tmp) == pc_rtx
881 && GET_CODE (SET_SRC (tmp)) == IF_THEN_ELSE
882 && GET_CODE (XEXP (SET_SRC (tmp), 2)) == LABEL_REF
883 && XEXP (XEXP (SET_SRC (tmp), 2), 0) == old_label)
885 XEXP (SET_SRC (tmp), 2) = gen_rtx_LABEL_REF (VOIDmode,
886 new_label);
887 --LABEL_NUSES (old_label);
888 ++LABEL_NUSES (new_label);
891 else
893 /* ?? We may play the games with moving the named labels from
894 one basic block to the other in case only one computed_jump is
895 available. */
896 if (computed_jump_p (insn)
897 /* A return instruction can't be redirected. */
898 || returnjump_p (insn))
899 return false;
901 /* If the insn doesn't go where we think, we're confused. */
902 if (JUMP_LABEL (insn) != old_label)
903 abort ();
905 /* If the substitution doesn't succeed, die. This can happen
906 if the back end emitted unrecognizable instructions or if
907 target is exit block on some arches. */
908 if (!redirect_jump (insn, block_label (target), 0))
910 if (target == EXIT_BLOCK_PTR)
911 return false;
912 abort ();
916 if (rtl_dump_file)
917 fprintf (rtl_dump_file, "Edge %i->%i redirected to %i\n",
918 e->src->index, e->dest->index, target->index);
920 if (e->dest != target)
921 redirect_edge_succ_nodup (e, target);
923 return true;
926 /* Like force_nonfallthru below, but additionally performs redirection
927 Used by redirect_edge_and_branch_force. */
929 static basic_block
930 force_nonfallthru_and_redirect (e, target)
931 edge e;
932 basic_block target;
934 basic_block jump_block, new_bb = NULL;
935 rtx note;
936 edge new_edge;
938 if (e->flags & EDGE_ABNORMAL)
939 abort ();
940 else if (!(e->flags & EDGE_FALLTHRU))
941 abort ();
942 else if (e->src == ENTRY_BLOCK_PTR)
944 /* We can't redirect the entry block. Create an empty block at the
945 start of the function which we use to add the new jump. */
946 edge *pe1;
947 basic_block bb = create_basic_block (e->dest->head, NULL, ENTRY_BLOCK_PTR);
949 /* Change the existing edge's source to be the new block, and add
950 a new edge from the entry block to the new block. */
951 e->src = bb;
952 for (pe1 = &ENTRY_BLOCK_PTR->succ; *pe1; pe1 = &(*pe1)->succ_next)
953 if (*pe1 == e)
955 *pe1 = e->succ_next;
956 break;
958 e->succ_next = 0;
959 bb->succ = e;
960 make_single_succ_edge (ENTRY_BLOCK_PTR, bb, EDGE_FALLTHRU);
963 if (e->src->succ->succ_next)
965 /* Create the new structures. */
967 /* Position the new block correctly relative to loop notes. */
968 note = last_loop_beg_note (e->src->end);
969 note = NEXT_INSN (note);
971 /* ... and ADDR_VECs. */
972 if (note != NULL
973 && GET_CODE (note) == CODE_LABEL
974 && NEXT_INSN (note)
975 && GET_CODE (NEXT_INSN (note)) == JUMP_INSN
976 && (GET_CODE (PATTERN (NEXT_INSN (note))) == ADDR_DIFF_VEC
977 || GET_CODE (PATTERN (NEXT_INSN (note))) == ADDR_VEC))
978 note = NEXT_INSN (NEXT_INSN (note));
980 jump_block = create_basic_block (note, NULL, e->src);
981 jump_block->count = e->count;
982 jump_block->frequency = EDGE_FREQUENCY (e);
983 jump_block->loop_depth = target->loop_depth;
985 if (target->global_live_at_start)
987 jump_block->global_live_at_start
988 = OBSTACK_ALLOC_REG_SET (&flow_obstack);
989 jump_block->global_live_at_end
990 = OBSTACK_ALLOC_REG_SET (&flow_obstack);
991 COPY_REG_SET (jump_block->global_live_at_start,
992 target->global_live_at_start);
993 COPY_REG_SET (jump_block->global_live_at_end,
994 target->global_live_at_start);
997 /* Wire edge in. */
998 new_edge = make_edge (e->src, jump_block, EDGE_FALLTHRU);
999 new_edge->probability = e->probability;
1000 new_edge->count = e->count;
1002 /* Redirect old edge. */
1003 redirect_edge_pred (e, jump_block);
1004 e->probability = REG_BR_PROB_BASE;
1006 new_bb = jump_block;
1008 else
1009 jump_block = e->src;
1011 e->flags &= ~EDGE_FALLTHRU;
1012 if (target == EXIT_BLOCK_PTR)
1014 if (HAVE_return)
1015 emit_jump_insn_after (gen_return (), jump_block->end);
1016 else
1017 abort ();
1019 else
1021 rtx label = block_label (target);
1022 emit_jump_insn_after (gen_jump (label), jump_block->end);
1023 JUMP_LABEL (jump_block->end) = label;
1024 LABEL_NUSES (label)++;
1027 emit_barrier_after (jump_block->end);
1028 redirect_edge_succ_nodup (e, target);
1030 return new_bb;
1033 /* Edge E is assumed to be fallthru edge. Emit needed jump instruction
1034 (and possibly create new basic block) to make edge non-fallthru.
1035 Return newly created BB or NULL if none. */
1037 basic_block
1038 force_nonfallthru (e)
1039 edge e;
1041 return force_nonfallthru_and_redirect (e, e->dest);
1044 /* Redirect edge even at the expense of creating new jump insn or
1045 basic block. Return new basic block if created, NULL otherwise.
1046 Abort if conversion is impossible. */
1048 basic_block
1049 redirect_edge_and_branch_force (e, target)
1050 edge e;
1051 basic_block target;
1053 if (redirect_edge_and_branch (e, target)
1054 || e->dest == target)
1055 return NULL;
1057 /* In case the edge redirection failed, try to force it to be non-fallthru
1058 and redirect newly created simplejump. */
1059 return force_nonfallthru_and_redirect (e, target);
1062 /* The given edge should potentially be a fallthru edge. If that is in
1063 fact true, delete the jump and barriers that are in the way. */
1065 void
1066 tidy_fallthru_edge (e, b, c)
1067 edge e;
1068 basic_block b, c;
1070 rtx q;
1072 /* ??? In a late-running flow pass, other folks may have deleted basic
1073 blocks by nopping out blocks, leaving multiple BARRIERs between here
1074 and the target label. They ought to be chastized and fixed.
1076 We can also wind up with a sequence of undeletable labels between
1077 one block and the next.
1079 So search through a sequence of barriers, labels, and notes for
1080 the head of block C and assert that we really do fall through. */
1082 for (q = NEXT_INSN (b->end); q != c->head; q = NEXT_INSN (q))
1083 if (INSN_P (q))
1084 return;
1086 /* Remove what will soon cease being the jump insn from the source block.
1087 If block B consisted only of this single jump, turn it into a deleted
1088 note. */
1089 q = b->end;
1090 if (GET_CODE (q) == JUMP_INSN
1091 && onlyjump_p (q)
1092 && (any_uncondjump_p (q)
1093 || (b->succ == e && e->succ_next == NULL)))
1095 #ifdef HAVE_cc0
1096 /* If this was a conditional jump, we need to also delete
1097 the insn that set cc0. */
1098 if (any_condjump_p (q) && only_sets_cc0_p (PREV_INSN (q)))
1099 q = PREV_INSN (q);
1100 #endif
1102 q = PREV_INSN (q);
1104 /* We don't want a block to end on a line-number note since that has
1105 the potential of changing the code between -g and not -g. */
1106 while (GET_CODE (q) == NOTE && NOTE_LINE_NUMBER (q) >= 0)
1107 q = PREV_INSN (q);
1110 /* Selectively unlink the sequence. */
1111 if (q != PREV_INSN (c->head))
1112 delete_insn_chain (NEXT_INSN (q), PREV_INSN (c->head));
1114 e->flags |= EDGE_FALLTHRU;
1117 /* Fix up edges that now fall through, or rather should now fall through
1118 but previously required a jump around now deleted blocks. Simplify
1119 the search by only examining blocks numerically adjacent, since this
1120 is how find_basic_blocks created them. */
1122 void
1123 tidy_fallthru_edges ()
1125 basic_block b, c;
1127 if (ENTRY_BLOCK_PTR->next_bb == EXIT_BLOCK_PTR)
1128 return;
1130 FOR_BB_BETWEEN (b, ENTRY_BLOCK_PTR->next_bb, EXIT_BLOCK_PTR->prev_bb, next_bb)
1132 edge s;
1134 c = b->next_bb;
1136 /* We care about simple conditional or unconditional jumps with
1137 a single successor.
1139 If we had a conditional branch to the next instruction when
1140 find_basic_blocks was called, then there will only be one
1141 out edge for the block which ended with the conditional
1142 branch (since we do not create duplicate edges).
1144 Furthermore, the edge will be marked as a fallthru because we
1145 merge the flags for the duplicate edges. So we do not want to
1146 check that the edge is not a FALLTHRU edge. */
1148 if ((s = b->succ) != NULL
1149 && ! (s->flags & EDGE_COMPLEX)
1150 && s->succ_next == NULL
1151 && s->dest == c
1152 /* If the jump insn has side effects, we can't tidy the edge. */
1153 && (GET_CODE (b->end) != JUMP_INSN
1154 || onlyjump_p (b->end)))
1155 tidy_fallthru_edge (s, b, c);
1159 /* Helper function for split_edge. Return true in case edge BB2 to BB1
1160 is back edge of syntactic loop. */
1162 static bool
1163 back_edge_of_syntactic_loop_p (bb1, bb2)
1164 basic_block bb1, bb2;
1166 rtx insn;
1167 int count = 0;
1168 basic_block bb;
1170 if (bb1 == bb2)
1171 return true;
1173 /* ??? Could we guarantee that bb indices are monotone, so that we could
1174 just compare them? */
1175 for (bb = bb1; bb && bb != bb2; bb = bb->next_bb)
1176 continue;
1178 if (!bb)
1179 return false;
1181 for (insn = bb1->end; insn != bb2->head && count >= 0;
1182 insn = NEXT_INSN (insn))
1183 if (GET_CODE (insn) == NOTE)
1185 if (NOTE_LINE_NUMBER (insn) == NOTE_INSN_LOOP_BEG)
1186 count++;
1187 else if (NOTE_LINE_NUMBER (insn) == NOTE_INSN_LOOP_END)
1188 count--;
1191 return count >= 0;
1194 /* Split a (typically critical) edge. Return the new block.
1195 Abort on abnormal edges.
1197 ??? The code generally expects to be called on critical edges.
1198 The case of a block ending in an unconditional jump to a
1199 block with multiple predecessors is not handled optimally. */
1201 basic_block
1202 split_edge (edge_in)
1203 edge edge_in;
1205 basic_block bb;
1206 edge edge_out;
1207 rtx before;
1209 /* Abnormal edges cannot be split. */
1210 if ((edge_in->flags & EDGE_ABNORMAL) != 0)
1211 abort ();
1213 /* We are going to place the new block in front of edge destination.
1214 Avoid existence of fallthru predecessors. */
1215 if ((edge_in->flags & EDGE_FALLTHRU) == 0)
1217 edge e;
1219 for (e = edge_in->dest->pred; e; e = e->pred_next)
1220 if (e->flags & EDGE_FALLTHRU)
1221 break;
1223 if (e)
1224 force_nonfallthru (e);
1227 /* Create the basic block note.
1229 Where we place the note can have a noticeable impact on the generated
1230 code. Consider this cfg:
1236 +->1-->2--->E
1238 +--+
1240 If we need to insert an insn on the edge from block 0 to block 1,
1241 we want to ensure the instructions we insert are outside of any
1242 loop notes that physically sit between block 0 and block 1. Otherwise
1243 we confuse the loop optimizer into thinking the loop is a phony. */
1245 if (edge_in->dest != EXIT_BLOCK_PTR
1246 && PREV_INSN (edge_in->dest->head)
1247 && GET_CODE (PREV_INSN (edge_in->dest->head)) == NOTE
1248 && (NOTE_LINE_NUMBER (PREV_INSN (edge_in->dest->head))
1249 == NOTE_INSN_LOOP_BEG)
1250 && !back_edge_of_syntactic_loop_p (edge_in->dest, edge_in->src))
1251 before = PREV_INSN (edge_in->dest->head);
1252 else if (edge_in->dest != EXIT_BLOCK_PTR)
1253 before = edge_in->dest->head;
1254 else
1255 before = NULL_RTX;
1257 bb = create_basic_block (before, NULL, edge_in->dest->prev_bb);
1258 bb->count = edge_in->count;
1259 bb->frequency = EDGE_FREQUENCY (edge_in);
1261 /* ??? This info is likely going to be out of date very soon. */
1262 if (edge_in->dest->global_live_at_start)
1264 bb->global_live_at_start = OBSTACK_ALLOC_REG_SET (&flow_obstack);
1265 bb->global_live_at_end = OBSTACK_ALLOC_REG_SET (&flow_obstack);
1266 COPY_REG_SET (bb->global_live_at_start,
1267 edge_in->dest->global_live_at_start);
1268 COPY_REG_SET (bb->global_live_at_end,
1269 edge_in->dest->global_live_at_start);
1272 edge_out = make_single_succ_edge (bb, edge_in->dest, EDGE_FALLTHRU);
1274 /* For non-fallthry edges, we must adjust the predecessor's
1275 jump instruction to target our new block. */
1276 if ((edge_in->flags & EDGE_FALLTHRU) == 0)
1278 if (!redirect_edge_and_branch (edge_in, bb))
1279 abort ();
1281 else
1282 redirect_edge_succ (edge_in, bb);
1284 return bb;
1287 /* Queue instructions for insertion on an edge between two basic blocks.
1288 The new instructions and basic blocks (if any) will not appear in the
1289 CFG until commit_edge_insertions is called. */
1291 void
1292 insert_insn_on_edge (pattern, e)
1293 rtx pattern;
1294 edge e;
1296 /* We cannot insert instructions on an abnormal critical edge.
1297 It will be easier to find the culprit if we die now. */
1298 if ((e->flags & EDGE_ABNORMAL) && EDGE_CRITICAL_P (e))
1299 abort ();
1301 if (e->insns == NULL_RTX)
1302 start_sequence ();
1303 else
1304 push_to_sequence (e->insns);
1306 emit_insn (pattern);
1308 e->insns = get_insns ();
1309 end_sequence ();
1312 /* Update the CFG for the instructions queued on edge E. */
1314 static void
1315 commit_one_edge_insertion (e, watch_calls)
1316 edge e;
1317 int watch_calls;
1319 rtx before = NULL_RTX, after = NULL_RTX, insns, tmp, last;
1320 basic_block bb = NULL;
1322 /* Pull the insns off the edge now since the edge might go away. */
1323 insns = e->insns;
1324 e->insns = NULL_RTX;
1326 /* Special case -- avoid inserting code between call and storing
1327 its return value. */
1328 if (watch_calls && (e->flags & EDGE_FALLTHRU) && !e->dest->pred->pred_next
1329 && e->src != ENTRY_BLOCK_PTR
1330 && GET_CODE (e->src->end) == CALL_INSN)
1332 rtx next = next_nonnote_insn (e->src->end);
1334 after = e->dest->head;
1335 /* The first insn after the call may be a stack pop, skip it. */
1336 while (next
1337 && keep_with_call_p (next))
1339 after = next;
1340 next = next_nonnote_insn (next);
1342 bb = e->dest;
1344 if (!before && !after)
1346 /* Figure out where to put these things. If the destination has
1347 one predecessor, insert there. Except for the exit block. */
1348 if (e->dest->pred->pred_next == NULL && e->dest != EXIT_BLOCK_PTR)
1350 bb = e->dest;
1352 /* Get the location correct wrt a code label, and "nice" wrt
1353 a basic block note, and before everything else. */
1354 tmp = bb->head;
1355 if (GET_CODE (tmp) == CODE_LABEL)
1356 tmp = NEXT_INSN (tmp);
1357 if (NOTE_INSN_BASIC_BLOCK_P (tmp))
1358 tmp = NEXT_INSN (tmp);
1359 if (tmp == bb->head)
1360 before = tmp;
1361 else if (tmp)
1362 after = PREV_INSN (tmp);
1363 else
1364 after = get_last_insn ();
1367 /* If the source has one successor and the edge is not abnormal,
1368 insert there. Except for the entry block. */
1369 else if ((e->flags & EDGE_ABNORMAL) == 0
1370 && e->src->succ->succ_next == NULL
1371 && e->src != ENTRY_BLOCK_PTR)
1373 bb = e->src;
1375 /* It is possible to have a non-simple jump here. Consider a target
1376 where some forms of unconditional jumps clobber a register. This
1377 happens on the fr30 for example.
1379 We know this block has a single successor, so we can just emit
1380 the queued insns before the jump. */
1381 if (GET_CODE (bb->end) == JUMP_INSN)
1382 for (before = bb->end;
1383 GET_CODE (PREV_INSN (before)) == NOTE
1384 && NOTE_LINE_NUMBER (PREV_INSN (before)) ==
1385 NOTE_INSN_LOOP_BEG; before = PREV_INSN (before))
1387 else
1389 /* We'd better be fallthru, or we've lost track of what's what. */
1390 if ((e->flags & EDGE_FALLTHRU) == 0)
1391 abort ();
1393 after = bb->end;
1396 /* Otherwise we must split the edge. */
1397 else
1399 bb = split_edge (e);
1400 after = bb->end;
1404 /* Now that we've found the spot, do the insertion. */
1406 if (before)
1408 emit_insn_before (insns, before);
1409 last = prev_nonnote_insn (before);
1411 else
1412 last = emit_insn_after (insns, after);
1414 if (returnjump_p (last))
1416 /* ??? Remove all outgoing edges from BB and add one for EXIT.
1417 This is not currently a problem because this only happens
1418 for the (single) epilogue, which already has a fallthru edge
1419 to EXIT. */
1421 e = bb->succ;
1422 if (e->dest != EXIT_BLOCK_PTR
1423 || e->succ_next != NULL || (e->flags & EDGE_FALLTHRU) == 0)
1424 abort ();
1426 e->flags &= ~EDGE_FALLTHRU;
1427 emit_barrier_after (last);
1429 if (before)
1430 delete_insn (before);
1432 else if (GET_CODE (last) == JUMP_INSN)
1433 abort ();
1435 find_sub_basic_blocks (bb);
1438 /* Update the CFG for all queued instructions. */
1440 void
1441 commit_edge_insertions ()
1443 basic_block bb;
1445 #ifdef ENABLE_CHECKING
1446 verify_flow_info ();
1447 #endif
1449 FOR_BB_BETWEEN (bb, ENTRY_BLOCK_PTR, EXIT_BLOCK_PTR, next_bb)
1451 edge e, next;
1453 for (e = bb->succ; e; e = next)
1455 next = e->succ_next;
1456 if (e->insns)
1457 commit_one_edge_insertion (e, false);
1462 /* Update the CFG for all queued instructions, taking special care of inserting
1463 code on edges between call and storing its return value. */
1465 void
1466 commit_edge_insertions_watch_calls ()
1468 basic_block bb;
1470 #ifdef ENABLE_CHECKING
1471 verify_flow_info ();
1472 #endif
1474 FOR_BB_BETWEEN (bb, ENTRY_BLOCK_PTR, EXIT_BLOCK_PTR, next_bb)
1476 edge e, next;
1478 for (e = bb->succ; e; e = next)
1480 next = e->succ_next;
1481 if (e->insns)
1482 commit_one_edge_insertion (e, true);
1487 /* Print out one basic block with live information at start and end. */
1489 void
1490 dump_bb (bb, outf)
1491 basic_block bb;
1492 FILE *outf;
1494 rtx insn;
1495 rtx last;
1496 edge e;
1498 fprintf (outf, ";; Basic block %d, loop depth %d, count ",
1499 bb->index, bb->loop_depth);
1500 fprintf (outf, HOST_WIDEST_INT_PRINT_DEC, (HOST_WIDEST_INT) bb->count);
1501 putc ('\n', outf);
1503 fputs (";; Predecessors: ", outf);
1504 for (e = bb->pred; e; e = e->pred_next)
1505 dump_edge_info (outf, e, 0);
1506 putc ('\n', outf);
1508 fputs (";; Registers live at start:", outf);
1509 dump_regset (bb->global_live_at_start, outf);
1510 putc ('\n', outf);
1512 for (insn = bb->head, last = NEXT_INSN (bb->end); insn != last;
1513 insn = NEXT_INSN (insn))
1514 print_rtl_single (outf, insn);
1516 fputs (";; Registers live at end:", outf);
1517 dump_regset (bb->global_live_at_end, outf);
1518 putc ('\n', outf);
1520 fputs (";; Successors: ", outf);
1521 for (e = bb->succ; e; e = e->succ_next)
1522 dump_edge_info (outf, e, 1);
1523 putc ('\n', outf);
1526 void
1527 debug_bb (bb)
1528 basic_block bb;
1530 dump_bb (bb, stderr);
1533 void
1534 debug_bb_n (n)
1535 int n;
1537 dump_bb (BASIC_BLOCK (n), stderr);
1540 /* Like print_rtl, but also print out live information for the start of each
1541 basic block. */
1543 void
1544 print_rtl_with_bb (outf, rtx_first)
1545 FILE *outf;
1546 rtx rtx_first;
1548 rtx tmp_rtx;
1550 if (rtx_first == 0)
1551 fprintf (outf, "(nil)\n");
1552 else
1554 enum bb_state { NOT_IN_BB, IN_ONE_BB, IN_MULTIPLE_BB };
1555 int max_uid = get_max_uid ();
1556 basic_block *start
1557 = (basic_block *) xcalloc (max_uid, sizeof (basic_block));
1558 basic_block *end
1559 = (basic_block *) xcalloc (max_uid, sizeof (basic_block));
1560 enum bb_state *in_bb_p
1561 = (enum bb_state *) xcalloc (max_uid, sizeof (enum bb_state));
1563 basic_block bb;
1565 FOR_EACH_BB_REVERSE (bb)
1567 rtx x;
1569 start[INSN_UID (bb->head)] = bb;
1570 end[INSN_UID (bb->end)] = bb;
1571 for (x = bb->head; x != NULL_RTX; x = NEXT_INSN (x))
1573 enum bb_state state = IN_MULTIPLE_BB;
1575 if (in_bb_p[INSN_UID (x)] == NOT_IN_BB)
1576 state = IN_ONE_BB;
1577 in_bb_p[INSN_UID (x)] = state;
1579 if (x == bb->end)
1580 break;
1584 for (tmp_rtx = rtx_first; NULL != tmp_rtx; tmp_rtx = NEXT_INSN (tmp_rtx))
1586 int did_output;
1588 if ((bb = start[INSN_UID (tmp_rtx)]) != NULL)
1590 fprintf (outf, ";; Start of basic block %d, registers live:",
1591 bb->index);
1592 dump_regset (bb->global_live_at_start, outf);
1593 putc ('\n', outf);
1596 if (in_bb_p[INSN_UID (tmp_rtx)] == NOT_IN_BB
1597 && GET_CODE (tmp_rtx) != NOTE
1598 && GET_CODE (tmp_rtx) != BARRIER)
1599 fprintf (outf, ";; Insn is not within a basic block\n");
1600 else if (in_bb_p[INSN_UID (tmp_rtx)] == IN_MULTIPLE_BB)
1601 fprintf (outf, ";; Insn is in multiple basic blocks\n");
1603 did_output = print_rtl_single (outf, tmp_rtx);
1605 if ((bb = end[INSN_UID (tmp_rtx)]) != NULL)
1607 fprintf (outf, ";; End of basic block %d, registers live:\n",
1608 bb->index);
1609 dump_regset (bb->global_live_at_end, outf);
1610 putc ('\n', outf);
1613 if (did_output)
1614 putc ('\n', outf);
1617 free (start);
1618 free (end);
1619 free (in_bb_p);
1622 if (current_function_epilogue_delay_list != 0)
1624 fprintf (outf, "\n;; Insns in epilogue delay list:\n\n");
1625 for (tmp_rtx = current_function_epilogue_delay_list; tmp_rtx != 0;
1626 tmp_rtx = XEXP (tmp_rtx, 1))
1627 print_rtl_single (outf, XEXP (tmp_rtx, 0));
1631 void
1632 update_br_prob_note (bb)
1633 basic_block bb;
1635 rtx note;
1636 if (GET_CODE (bb->end) != JUMP_INSN)
1637 return;
1638 note = find_reg_note (bb->end, REG_BR_PROB, NULL_RTX);
1639 if (!note || INTVAL (XEXP (note, 0)) == BRANCH_EDGE (bb)->probability)
1640 return;
1641 XEXP (note, 0) = GEN_INT (BRANCH_EDGE (bb)->probability);
1644 /* Verify the CFG consistency. This function check some CFG invariants and
1645 aborts when something is wrong. Hope that this function will help to
1646 convert many optimization passes to preserve CFG consistent.
1648 Currently it does following checks:
1650 - test head/end pointers
1651 - overlapping of basic blocks
1652 - edge list correctness
1653 - headers of basic blocks (the NOTE_INSN_BASIC_BLOCK note)
1654 - tails of basic blocks (ensure that boundary is necessary)
1655 - scans body of the basic block for JUMP_INSN, CODE_LABEL
1656 and NOTE_INSN_BASIC_BLOCK
1657 - check that all insns are in the basic blocks
1658 (except the switch handling code, barriers and notes)
1659 - check that all returns are followed by barriers
1661 In future it can be extended check a lot of other stuff as well
1662 (reachability of basic blocks, life information, etc. etc.). */
1664 void
1665 verify_flow_info ()
1667 const int max_uid = get_max_uid ();
1668 const rtx rtx_first = get_insns ();
1669 rtx last_head = get_last_insn ();
1670 basic_block *bb_info, *last_visited;
1671 size_t *edge_checksum;
1672 rtx x;
1673 int num_bb_notes, err = 0;
1674 basic_block bb, last_bb_seen;
1676 bb_info = (basic_block *) xcalloc (max_uid, sizeof (basic_block));
1677 last_visited = (basic_block *) xcalloc (last_basic_block + 2,
1678 sizeof (basic_block));
1679 edge_checksum = (size_t *) xcalloc (last_basic_block + 2, sizeof (size_t));
1681 /* Check bb chain & numbers. */
1682 last_bb_seen = ENTRY_BLOCK_PTR;
1683 FOR_BB_BETWEEN (bb, ENTRY_BLOCK_PTR->next_bb, NULL, next_bb)
1685 if (bb != EXIT_BLOCK_PTR
1686 && bb != BASIC_BLOCK (bb->index))
1688 error ("bb %d on wrong place", bb->index);
1689 err = 1;
1692 if (bb->prev_bb != last_bb_seen)
1694 error ("prev_bb of %d should be %d, not %d",
1695 bb->index, last_bb_seen->index, bb->prev_bb->index);
1696 err = 1;
1699 last_bb_seen = bb;
1702 FOR_EACH_BB_REVERSE (bb)
1704 rtx head = bb->head;
1705 rtx end = bb->end;
1707 /* Verify the end of the basic block is in the INSN chain. */
1708 for (x = last_head; x != NULL_RTX; x = PREV_INSN (x))
1709 if (x == end)
1710 break;
1712 if (!x)
1714 error ("end insn %d for block %d not found in the insn stream",
1715 INSN_UID (end), bb->index);
1716 err = 1;
1719 /* Work backwards from the end to the head of the basic block
1720 to verify the head is in the RTL chain. */
1721 for (; x != NULL_RTX; x = PREV_INSN (x))
1723 /* While walking over the insn chain, verify insns appear
1724 in only one basic block and initialize the BB_INFO array
1725 used by other passes. */
1726 if (bb_info[INSN_UID (x)] != NULL)
1728 error ("insn %d is in multiple basic blocks (%d and %d)",
1729 INSN_UID (x), bb->index, bb_info[INSN_UID (x)]->index);
1730 err = 1;
1733 bb_info[INSN_UID (x)] = bb;
1735 if (x == head)
1736 break;
1738 if (!x)
1740 error ("head insn %d for block %d not found in the insn stream",
1741 INSN_UID (head), bb->index);
1742 err = 1;
1745 last_head = x;
1748 /* Now check the basic blocks (boundaries etc.) */
1749 FOR_EACH_BB_REVERSE (bb)
1751 int n_fallthru = 0, n_eh = 0, n_call = 0, n_abnormal = 0, n_branch = 0;
1752 edge e;
1753 rtx note;
1755 if (INSN_P (bb->end)
1756 && (note = find_reg_note (bb->end, REG_BR_PROB, NULL_RTX))
1757 && bb->succ && bb->succ->succ_next
1758 && any_condjump_p (bb->end))
1760 if (INTVAL (XEXP (note, 0)) != BRANCH_EDGE (bb)->probability)
1762 error ("verify_flow_info: REG_BR_PROB does not match cfg %i %i",
1763 INTVAL (XEXP (note, 0)), BRANCH_EDGE (bb)->probability);
1764 err = 1;
1767 if (bb->count < 0)
1769 error ("verify_flow_info: Wrong count of block %i %i",
1770 bb->index, (int)bb->count);
1771 err = 1;
1773 if (bb->frequency < 0)
1775 error ("verify_flow_info: Wrong frequency of block %i %i",
1776 bb->index, bb->frequency);
1777 err = 1;
1779 for (e = bb->succ; e; e = e->succ_next)
1781 if (last_visited [e->dest->index + 2] == bb)
1783 error ("verify_flow_info: Duplicate edge %i->%i",
1784 e->src->index, e->dest->index);
1785 err = 1;
1787 if (e->probability < 0 || e->probability > REG_BR_PROB_BASE)
1789 error ("verify_flow_info: Wrong probability of edge %i->%i %i",
1790 e->src->index, e->dest->index, e->probability);
1791 err = 1;
1793 if (e->count < 0)
1795 error ("verify_flow_info: Wrong count of edge %i->%i %i",
1796 e->src->index, e->dest->index, (int)e->count);
1797 err = 1;
1800 last_visited [e->dest->index + 2] = bb;
1802 if (e->flags & EDGE_FALLTHRU)
1803 n_fallthru++;
1805 if ((e->flags & ~EDGE_DFS_BACK) == 0)
1806 n_branch++;
1808 if (e->flags & EDGE_ABNORMAL_CALL)
1809 n_call++;
1811 if (e->flags & EDGE_EH)
1812 n_eh++;
1813 else if (e->flags & EDGE_ABNORMAL)
1814 n_abnormal++;
1816 if ((e->flags & EDGE_FALLTHRU)
1817 && e->src != ENTRY_BLOCK_PTR
1818 && e->dest != EXIT_BLOCK_PTR)
1820 rtx insn;
1822 if (e->src->next_bb != e->dest)
1824 error
1825 ("verify_flow_info: Incorrect blocks for fallthru %i->%i",
1826 e->src->index, e->dest->index);
1827 err = 1;
1829 else
1830 for (insn = NEXT_INSN (e->src->end); insn != e->dest->head;
1831 insn = NEXT_INSN (insn))
1832 if (GET_CODE (insn) == BARRIER
1833 #ifndef CASE_DROPS_THROUGH
1834 || INSN_P (insn)
1835 #else
1836 || (INSN_P (insn) && ! JUMP_TABLE_DATA_P (insn))
1837 #endif
1840 error ("verify_flow_info: Incorrect fallthru %i->%i",
1841 e->src->index, e->dest->index);
1842 fatal_insn ("wrong insn in the fallthru edge", insn);
1843 err = 1;
1847 if (e->src != bb)
1849 error ("verify_flow_info: Basic block %d succ edge is corrupted",
1850 bb->index);
1851 fprintf (stderr, "Predecessor: ");
1852 dump_edge_info (stderr, e, 0);
1853 fprintf (stderr, "\nSuccessor: ");
1854 dump_edge_info (stderr, e, 1);
1855 fprintf (stderr, "\n");
1856 err = 1;
1859 edge_checksum[e->dest->index + 2] += (size_t) e;
1862 if (n_eh && GET_CODE (PATTERN (bb->end)) != RESX
1863 && !find_reg_note (bb->end, REG_EH_REGION, NULL_RTX))
1865 error ("Missing REG_EH_REGION note in the end of bb %i", bb->index);
1866 err = 1;
1868 if (n_branch
1869 && (GET_CODE (bb->end) != JUMP_INSN
1870 || (n_branch > 1 && (any_uncondjump_p (bb->end)
1871 || any_condjump_p (bb->end)))))
1873 error ("Too many outgoing branch edges from bb %i", bb->index);
1874 err = 1;
1876 if (n_fallthru && any_uncondjump_p (bb->end))
1878 error ("Fallthru edge after unconditional jump %i", bb->index);
1879 err = 1;
1881 if (n_branch != 1 && any_uncondjump_p (bb->end))
1883 error ("Wrong amount of branch edges after unconditional jump %i", bb->index);
1884 err = 1;
1886 if (n_branch != 1 && any_condjump_p (bb->end)
1887 && JUMP_LABEL (bb->end) != bb->next_bb->head)
1889 error ("Wrong amount of branch edges after conditional jump %i", bb->index);
1890 err = 1;
1892 if (n_call && GET_CODE (bb->end) != CALL_INSN)
1894 error ("Call edges for non-call insn in bb %i", bb->index);
1895 err = 1;
1897 if (n_abnormal
1898 && (GET_CODE (bb->end) != CALL_INSN && n_call != n_abnormal)
1899 && (GET_CODE (bb->end) != JUMP_INSN
1900 || any_condjump_p (bb->end)
1901 || any_uncondjump_p (bb->end)))
1903 error ("Abnormal edges for no purpose in bb %i", bb->index);
1904 err = 1;
1907 if (!n_fallthru)
1909 rtx insn;
1911 /* Ensure existence of barrier in BB with no fallthru edges. */
1912 for (insn = bb->end; !insn || GET_CODE (insn) != BARRIER;
1913 insn = NEXT_INSN (insn))
1914 if (!insn
1915 || (GET_CODE (insn) == NOTE
1916 && NOTE_LINE_NUMBER (insn) == NOTE_INSN_BASIC_BLOCK))
1918 error ("missing barrier after block %i", bb->index);
1919 err = 1;
1920 break;
1924 for (e = bb->pred; e; e = e->pred_next)
1926 if (e->dest != bb)
1928 error ("basic block %d pred edge is corrupted", bb->index);
1929 fputs ("Predecessor: ", stderr);
1930 dump_edge_info (stderr, e, 0);
1931 fputs ("\nSuccessor: ", stderr);
1932 dump_edge_info (stderr, e, 1);
1933 fputc ('\n', stderr);
1934 err = 1;
1936 edge_checksum[e->dest->index + 2] -= (size_t) e;
1939 for (x = bb->head; x != NEXT_INSN (bb->end); x = NEXT_INSN (x))
1940 if (BLOCK_FOR_INSN (x) != bb)
1942 debug_rtx (x);
1943 if (! BLOCK_FOR_INSN (x))
1944 error
1945 ("insn %d inside basic block %d but block_for_insn is NULL",
1946 INSN_UID (x), bb->index);
1947 else
1948 error
1949 ("insn %d inside basic block %d but block_for_insn is %i",
1950 INSN_UID (x), bb->index, BLOCK_FOR_INSN (x)->index);
1952 err = 1;
1955 /* OK pointers are correct. Now check the header of basic
1956 block. It ought to contain optional CODE_LABEL followed
1957 by NOTE_BASIC_BLOCK. */
1958 x = bb->head;
1959 if (GET_CODE (x) == CODE_LABEL)
1961 if (bb->end == x)
1963 error ("NOTE_INSN_BASIC_BLOCK is missing for block %d",
1964 bb->index);
1965 err = 1;
1968 x = NEXT_INSN (x);
1971 if (!NOTE_INSN_BASIC_BLOCK_P (x) || NOTE_BASIC_BLOCK (x) != bb)
1973 error ("NOTE_INSN_BASIC_BLOCK is missing for block %d",
1974 bb->index);
1975 err = 1;
1978 if (bb->end == x)
1979 /* Do checks for empty blocks her. e */
1981 else
1982 for (x = NEXT_INSN (x); x; x = NEXT_INSN (x))
1984 if (NOTE_INSN_BASIC_BLOCK_P (x))
1986 error ("NOTE_INSN_BASIC_BLOCK %d in middle of basic block %d",
1987 INSN_UID (x), bb->index);
1988 err = 1;
1991 if (x == bb->end)
1992 break;
1994 if (GET_CODE (x) == JUMP_INSN
1995 || GET_CODE (x) == CODE_LABEL
1996 || GET_CODE (x) == BARRIER)
1998 error ("in basic block %d:", bb->index);
1999 fatal_insn ("flow control insn inside a basic block", x);
2004 /* Complete edge checksumming for ENTRY and EXIT. */
2006 edge e;
2008 for (e = ENTRY_BLOCK_PTR->succ; e ; e = e->succ_next)
2009 edge_checksum[e->dest->index + 2] += (size_t) e;
2011 for (e = EXIT_BLOCK_PTR->pred; e ; e = e->pred_next)
2012 edge_checksum[e->dest->index + 2] -= (size_t) e;
2015 FOR_BB_BETWEEN (bb, ENTRY_BLOCK_PTR, NULL, next_bb)
2016 if (edge_checksum[bb->index + 2])
2018 error ("basic block %i edge lists are corrupted", bb->index);
2019 err = 1;
2022 num_bb_notes = 0;
2023 last_bb_seen = ENTRY_BLOCK_PTR;
2025 for (x = rtx_first; x; x = NEXT_INSN (x))
2027 if (NOTE_INSN_BASIC_BLOCK_P (x))
2029 bb = NOTE_BASIC_BLOCK (x);
2031 num_bb_notes++;
2032 if (bb != last_bb_seen->next_bb)
2033 internal_error ("basic blocks not numbered consecutively");
2035 last_bb_seen = bb;
2038 if (!bb_info[INSN_UID (x)])
2040 switch (GET_CODE (x))
2042 case BARRIER:
2043 case NOTE:
2044 break;
2046 case CODE_LABEL:
2047 /* An addr_vec is placed outside any block block. */
2048 if (NEXT_INSN (x)
2049 && GET_CODE (NEXT_INSN (x)) == JUMP_INSN
2050 && (GET_CODE (PATTERN (NEXT_INSN (x))) == ADDR_DIFF_VEC
2051 || GET_CODE (PATTERN (NEXT_INSN (x))) == ADDR_VEC))
2052 x = NEXT_INSN (x);
2054 /* But in any case, non-deletable labels can appear anywhere. */
2055 break;
2057 default:
2058 fatal_insn ("insn outside basic block", x);
2062 if (INSN_P (x)
2063 && GET_CODE (x) == JUMP_INSN
2064 && returnjump_p (x) && ! condjump_p (x)
2065 && ! (NEXT_INSN (x) && GET_CODE (NEXT_INSN (x)) == BARRIER))
2066 fatal_insn ("return not followed by barrier", x);
2069 if (num_bb_notes != n_basic_blocks)
2070 internal_error
2071 ("number of bb notes in insn chain (%d) != n_basic_blocks (%d)",
2072 num_bb_notes, n_basic_blocks);
2074 if (err)
2075 internal_error ("verify_flow_info failed");
2077 /* Clean up. */
2078 free (bb_info);
2079 free (last_visited);
2080 free (edge_checksum);
2083 /* Assume that the preceding pass has possibly eliminated jump instructions
2084 or converted the unconditional jumps. Eliminate the edges from CFG.
2085 Return true if any edges are eliminated. */
2087 bool
2088 purge_dead_edges (bb)
2089 basic_block bb;
2091 edge e, next;
2092 rtx insn = bb->end, note;
2093 bool purged = false;
2095 /* If this instruction cannot trap, remove REG_EH_REGION notes. */
2096 if (GET_CODE (insn) == INSN
2097 && (note = find_reg_note (insn, REG_EH_REGION, NULL)))
2099 rtx eqnote;
2101 if (! may_trap_p (PATTERN (insn))
2102 || ((eqnote = find_reg_equal_equiv_note (insn))
2103 && ! may_trap_p (XEXP (eqnote, 0))))
2104 remove_note (insn, note);
2107 /* Cleanup abnormal edges caused by exceptions or non-local gotos. */
2108 for (e = bb->succ; e; e = next)
2110 next = e->succ_next;
2111 if (e->flags & EDGE_EH)
2113 if (can_throw_internal (bb->end))
2114 continue;
2116 else if (e->flags & EDGE_ABNORMAL_CALL)
2118 if (GET_CODE (bb->end) == CALL_INSN
2119 && (! (note = find_reg_note (insn, REG_EH_REGION, NULL))
2120 || INTVAL (XEXP (note, 0)) >= 0))
2121 continue;
2123 else
2124 continue;
2126 remove_edge (e);
2127 bb->flags |= BB_DIRTY;
2128 purged = true;
2131 if (GET_CODE (insn) == JUMP_INSN)
2133 rtx note;
2134 edge b,f;
2136 /* We do care only about conditional jumps and simplejumps. */
2137 if (!any_condjump_p (insn)
2138 && !returnjump_p (insn)
2139 && !simplejump_p (insn))
2140 return purged;
2142 /* Branch probability/prediction notes are defined only for
2143 condjumps. We've possibly turned condjump into simplejump. */
2144 if (simplejump_p (insn))
2146 note = find_reg_note (insn, REG_BR_PROB, NULL);
2147 if (note)
2148 remove_note (insn, note);
2149 while ((note = find_reg_note (insn, REG_BR_PRED, NULL)))
2150 remove_note (insn, note);
2153 for (e = bb->succ; e; e = next)
2155 next = e->succ_next;
2157 /* Avoid abnormal flags to leak from computed jumps turned
2158 into simplejumps. */
2160 e->flags &= ~EDGE_ABNORMAL;
2162 /* See if this edge is one we should keep. */
2163 if ((e->flags & EDGE_FALLTHRU) && any_condjump_p (insn))
2164 /* A conditional jump can fall through into the next
2165 block, so we should keep the edge. */
2166 continue;
2167 else if (e->dest != EXIT_BLOCK_PTR
2168 && e->dest->head == JUMP_LABEL (insn))
2169 /* If the destination block is the target of the jump,
2170 keep the edge. */
2171 continue;
2172 else if (e->dest == EXIT_BLOCK_PTR && returnjump_p (insn))
2173 /* If the destination block is the exit block, and this
2174 instruction is a return, then keep the edge. */
2175 continue;
2176 else if ((e->flags & EDGE_EH) && can_throw_internal (insn))
2177 /* Keep the edges that correspond to exceptions thrown by
2178 this instruction. */
2179 continue;
2181 /* We do not need this edge. */
2182 bb->flags |= BB_DIRTY;
2183 purged = true;
2184 remove_edge (e);
2187 if (!bb->succ || !purged)
2188 return purged;
2190 if (rtl_dump_file)
2191 fprintf (rtl_dump_file, "Purged edges from bb %i\n", bb->index);
2193 if (!optimize)
2194 return purged;
2196 /* Redistribute probabilities. */
2197 if (!bb->succ->succ_next)
2199 bb->succ->probability = REG_BR_PROB_BASE;
2200 bb->succ->count = bb->count;
2202 else
2204 note = find_reg_note (insn, REG_BR_PROB, NULL);
2205 if (!note)
2206 return purged;
2208 b = BRANCH_EDGE (bb);
2209 f = FALLTHRU_EDGE (bb);
2210 b->probability = INTVAL (XEXP (note, 0));
2211 f->probability = REG_BR_PROB_BASE - b->probability;
2212 b->count = bb->count * b->probability / REG_BR_PROB_BASE;
2213 f->count = bb->count * f->probability / REG_BR_PROB_BASE;
2216 return purged;
2219 /* If we don't see a jump insn, we don't know exactly why the block would
2220 have been broken at this point. Look for a simple, non-fallthru edge,
2221 as these are only created by conditional branches. If we find such an
2222 edge we know that there used to be a jump here and can then safely
2223 remove all non-fallthru edges. */
2224 for (e = bb->succ; e && (e->flags & (EDGE_COMPLEX | EDGE_FALLTHRU));
2225 e = e->succ_next)
2228 if (!e)
2229 return purged;
2231 for (e = bb->succ; e; e = next)
2233 next = e->succ_next;
2234 if (!(e->flags & EDGE_FALLTHRU))
2236 bb->flags |= BB_DIRTY;
2237 remove_edge (e);
2238 purged = true;
2242 if (!bb->succ || bb->succ->succ_next)
2243 abort ();
2245 bb->succ->probability = REG_BR_PROB_BASE;
2246 bb->succ->count = bb->count;
2248 if (rtl_dump_file)
2249 fprintf (rtl_dump_file, "Purged non-fallthru edges from bb %i\n",
2250 bb->index);
2251 return purged;
2254 /* Search all basic blocks for potentially dead edges and purge them. Return
2255 true if some edge has been eliminated. */
2257 bool
2258 purge_all_dead_edges (update_life_p)
2259 int update_life_p;
2261 int purged = false;
2262 sbitmap blocks = 0;
2263 basic_block bb;
2265 if (update_life_p)
2267 blocks = sbitmap_alloc (last_basic_block);
2268 sbitmap_zero (blocks);
2271 FOR_EACH_BB (bb)
2273 bool purged_here = purge_dead_edges (bb);
2275 purged |= purged_here;
2276 if (purged_here && update_life_p)
2277 SET_BIT (blocks, bb->index);
2280 if (update_life_p && purged)
2281 update_life_info (blocks, UPDATE_LIFE_GLOBAL,
2282 PROP_DEATH_NOTES | PROP_SCAN_DEAD_CODE
2283 | PROP_KILL_DEAD_CODE);
2285 if (update_life_p)
2286 sbitmap_free (blocks);
2287 return purged;