* config/rl78/rl78-expand.md (umulqihi3): Disable for G10.
[official-gcc.git] / gcc / cfgrtl.c
blob148c19d3b244c9102d011cca011438a4d92dfb6a
1 /* Control flow graph manipulation code for GNU compiler.
2 Copyright (C) 1987-2014 Free Software Foundation, Inc.
4 This file is part of GCC.
6 GCC is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 3, or (at your option) any later
9 version.
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.
16 You should have received a copy of the GNU General Public License
17 along with GCC; see the file COPYING3. If not see
18 <http://www.gnu.org/licenses/>. */
20 /* This file contains low level functions to manipulate the CFG and analyze it
21 that are aware of the RTL intermediate language.
23 Available functionality:
24 - Basic CFG/RTL manipulation API documented in cfghooks.h
25 - CFG-aware instruction chain manipulation
26 delete_insn, delete_insn_chain
27 - Edge splitting and committing to edges
28 insert_insn_on_edge, commit_edge_insertions
29 - CFG updating after insn simplification
30 purge_dead_edges, purge_all_dead_edges
31 - CFG fixing after coarse manipulation
32 fixup_abnormal_edges
34 Functions not supposed for generic use:
35 - Infrastructure to determine quickly basic block for insn
36 compute_bb_for_insn, update_bb_for_insn, set_block_for_insn,
37 - Edge redirection with updating and optimizing of insn chain
38 block_label, tidy_fallthru_edge, force_nonfallthru */
40 #include "config.h"
41 #include "system.h"
42 #include "coretypes.h"
43 #include "tm.h"
44 #include "tree.h"
45 #include "hard-reg-set.h"
46 #include "basic-block.h"
47 #include "bb-reorder.h"
48 #include "regs.h"
49 #include "flags.h"
50 #include "function.h"
51 #include "except.h"
52 #include "rtl-error.h"
53 #include "tm_p.h"
54 #include "obstack.h"
55 #include "insn-attr.h"
56 #include "insn-config.h"
57 #include "expr.h"
58 #include "target.h"
59 #include "common/common-target.h"
60 #include "cfgloop.h"
61 #include "ggc.h"
62 #include "tree-pass.h"
63 #include "df.h"
65 /* Holds the interesting leading and trailing notes for the function.
66 Only applicable if the CFG is in cfglayout mode. */
67 static GTY(()) rtx cfg_layout_function_footer;
68 static GTY(()) rtx cfg_layout_function_header;
70 static rtx skip_insns_after_block (basic_block);
71 static void record_effective_endpoints (void);
72 static rtx label_for_bb (basic_block);
73 static void fixup_reorder_chain (void);
75 void verify_insn_chain (void);
76 static void fixup_fallthru_exit_predecessor (void);
77 static int can_delete_note_p (const_rtx);
78 static int can_delete_label_p (const_rtx);
79 static basic_block rtl_split_edge (edge);
80 static bool rtl_move_block_after (basic_block, basic_block);
81 static int rtl_verify_flow_info (void);
82 static basic_block cfg_layout_split_block (basic_block, void *);
83 static edge cfg_layout_redirect_edge_and_branch (edge, basic_block);
84 static basic_block cfg_layout_redirect_edge_and_branch_force (edge, basic_block);
85 static void cfg_layout_delete_block (basic_block);
86 static void rtl_delete_block (basic_block);
87 static basic_block rtl_redirect_edge_and_branch_force (edge, basic_block);
88 static edge rtl_redirect_edge_and_branch (edge, basic_block);
89 static basic_block rtl_split_block (basic_block, void *);
90 static void rtl_dump_bb (FILE *, basic_block, int, int);
91 static int rtl_verify_flow_info_1 (void);
92 static void rtl_make_forwarder_block (edge);
94 /* Return true if NOTE is not one of the ones that must be kept paired,
95 so that we may simply delete it. */
97 static int
98 can_delete_note_p (const_rtx note)
100 switch (NOTE_KIND (note))
102 case NOTE_INSN_DELETED:
103 case NOTE_INSN_BASIC_BLOCK:
104 case NOTE_INSN_EPILOGUE_BEG:
105 return true;
107 default:
108 return false;
112 /* True if a given label can be deleted. */
114 static int
115 can_delete_label_p (const_rtx label)
117 return (!LABEL_PRESERVE_P (label)
118 /* User declared labels must be preserved. */
119 && LABEL_NAME (label) == 0
120 && !in_expr_list_p (forced_labels, label));
123 /* Delete INSN by patching it out. */
125 void
126 delete_insn (rtx insn)
128 rtx note;
129 bool really_delete = true;
131 if (LABEL_P (insn))
133 /* Some labels can't be directly removed from the INSN chain, as they
134 might be references via variables, constant pool etc.
135 Convert them to the special NOTE_INSN_DELETED_LABEL note. */
136 if (! can_delete_label_p (insn))
138 const char *name = LABEL_NAME (insn);
139 basic_block bb = BLOCK_FOR_INSN (insn);
140 rtx bb_note = NEXT_INSN (insn);
142 really_delete = false;
143 PUT_CODE (insn, NOTE);
144 NOTE_KIND (insn) = NOTE_INSN_DELETED_LABEL;
145 NOTE_DELETED_LABEL_NAME (insn) = name;
147 /* If the note following the label starts a basic block, and the
148 label is a member of the same basic block, interchange the two. */
149 if (bb_note != NULL_RTX
150 && NOTE_INSN_BASIC_BLOCK_P (bb_note)
151 && bb != NULL
152 && bb == BLOCK_FOR_INSN (bb_note))
154 reorder_insns_nobb (insn, insn, bb_note);
155 BB_HEAD (bb) = bb_note;
156 if (BB_END (bb) == bb_note)
157 BB_END (bb) = insn;
161 remove_node_from_expr_list (insn, &nonlocal_goto_handler_labels);
164 if (really_delete)
166 /* If this insn has already been deleted, something is very wrong. */
167 gcc_assert (!INSN_DELETED_P (insn));
168 if (INSN_P (insn))
169 df_insn_delete (insn);
170 remove_insn (insn);
171 INSN_DELETED_P (insn) = 1;
174 /* If deleting a jump, decrement the use count of the label. Deleting
175 the label itself should happen in the normal course of block merging. */
176 if (JUMP_P (insn))
178 if (JUMP_LABEL (insn)
179 && LABEL_P (JUMP_LABEL (insn)))
180 LABEL_NUSES (JUMP_LABEL (insn))--;
182 /* If there are more targets, remove them too. */
183 while ((note
184 = find_reg_note (insn, REG_LABEL_TARGET, NULL_RTX)) != NULL_RTX
185 && LABEL_P (XEXP (note, 0)))
187 LABEL_NUSES (XEXP (note, 0))--;
188 remove_note (insn, note);
192 /* Also if deleting any insn that references a label as an operand. */
193 while ((note = find_reg_note (insn, REG_LABEL_OPERAND, NULL_RTX)) != NULL_RTX
194 && LABEL_P (XEXP (note, 0)))
196 LABEL_NUSES (XEXP (note, 0))--;
197 remove_note (insn, note);
200 if (JUMP_TABLE_DATA_P (insn))
202 rtx pat = PATTERN (insn);
203 int diff_vec_p = GET_CODE (PATTERN (insn)) == ADDR_DIFF_VEC;
204 int len = XVECLEN (pat, diff_vec_p);
205 int i;
207 for (i = 0; i < len; i++)
209 rtx label = XEXP (XVECEXP (pat, diff_vec_p, i), 0);
211 /* When deleting code in bulk (e.g. removing many unreachable
212 blocks) we can delete a label that's a target of the vector
213 before deleting the vector itself. */
214 if (!NOTE_P (label))
215 LABEL_NUSES (label)--;
220 /* Like delete_insn but also purge dead edges from BB. */
222 void
223 delete_insn_and_edges (rtx insn)
225 bool purge = false;
227 if (INSN_P (insn)
228 && BLOCK_FOR_INSN (insn)
229 && BB_END (BLOCK_FOR_INSN (insn)) == insn)
230 purge = true;
231 delete_insn (insn);
232 if (purge)
233 purge_dead_edges (BLOCK_FOR_INSN (insn));
236 /* Unlink a chain of insns between START and FINISH, leaving notes
237 that must be paired. If CLEAR_BB is true, we set bb field for
238 insns that cannot be removed to NULL. */
240 void
241 delete_insn_chain (rtx start, rtx finish, bool clear_bb)
243 rtx prev, current;
245 /* Unchain the insns one by one. It would be quicker to delete all of these
246 with a single unchaining, rather than one at a time, but we need to keep
247 the NOTE's. */
248 current = finish;
249 while (1)
251 prev = PREV_INSN (current);
252 if (NOTE_P (current) && !can_delete_note_p (current))
254 else
255 delete_insn (current);
257 if (clear_bb && !INSN_DELETED_P (current))
258 set_block_for_insn (current, NULL);
260 if (current == start)
261 break;
262 current = prev;
266 /* Create a new basic block consisting of the instructions between HEAD and END
267 inclusive. This function is designed to allow fast BB construction - reuses
268 the note and basic block struct in BB_NOTE, if any and do not grow
269 BASIC_BLOCK chain and should be used directly only by CFG construction code.
270 END can be NULL in to create new empty basic block before HEAD. Both END
271 and HEAD can be NULL to create basic block at the end of INSN chain.
272 AFTER is the basic block we should be put after. */
274 basic_block
275 create_basic_block_structure (rtx head, rtx end, rtx bb_note, basic_block after)
277 basic_block bb;
279 if (bb_note
280 && (bb = NOTE_BASIC_BLOCK (bb_note)) != NULL
281 && bb->aux == NULL)
283 /* If we found an existing note, thread it back onto the chain. */
285 rtx after;
287 if (LABEL_P (head))
288 after = head;
289 else
291 after = PREV_INSN (head);
292 head = bb_note;
295 if (after != bb_note && NEXT_INSN (after) != bb_note)
296 reorder_insns_nobb (bb_note, bb_note, after);
298 else
300 /* Otherwise we must create a note and a basic block structure. */
302 bb = alloc_block ();
304 init_rtl_bb_info (bb);
305 if (!head && !end)
306 head = end = bb_note
307 = emit_note_after (NOTE_INSN_BASIC_BLOCK, get_last_insn ());
308 else if (LABEL_P (head) && end)
310 bb_note = emit_note_after (NOTE_INSN_BASIC_BLOCK, head);
311 if (head == end)
312 end = bb_note;
314 else
316 bb_note = emit_note_before (NOTE_INSN_BASIC_BLOCK, head);
317 head = bb_note;
318 if (!end)
319 end = head;
322 NOTE_BASIC_BLOCK (bb_note) = bb;
325 /* Always include the bb note in the block. */
326 if (NEXT_INSN (end) == bb_note)
327 end = bb_note;
329 BB_HEAD (bb) = head;
330 BB_END (bb) = end;
331 bb->index = last_basic_block_for_fn (cfun)++;
332 bb->flags = BB_NEW | BB_RTL;
333 link_block (bb, after);
334 SET_BASIC_BLOCK_FOR_FN (cfun, bb->index, bb);
335 df_bb_refs_record (bb->index, false);
336 update_bb_for_insn (bb);
337 BB_SET_PARTITION (bb, BB_UNPARTITIONED);
339 /* Tag the block so that we know it has been used when considering
340 other basic block notes. */
341 bb->aux = bb;
343 return bb;
346 /* Create new basic block consisting of instructions in between HEAD and END
347 and place it to the BB chain after block AFTER. END can be NULL to
348 create a new empty basic block before HEAD. Both END and HEAD can be
349 NULL to create basic block at the end of INSN chain. */
351 static basic_block
352 rtl_create_basic_block (void *headp, void *endp, basic_block after)
354 rtx head = (rtx) headp, end = (rtx) endp;
355 basic_block bb;
357 /* Grow the basic block array if needed. */
358 if ((size_t) last_basic_block_for_fn (cfun)
359 >= basic_block_info_for_fn (cfun)->length ())
361 size_t new_size =
362 (last_basic_block_for_fn (cfun)
363 + (last_basic_block_for_fn (cfun) + 3) / 4);
364 vec_safe_grow_cleared (basic_block_info_for_fn (cfun), new_size);
367 n_basic_blocks_for_fn (cfun)++;
369 bb = create_basic_block_structure (head, end, NULL, after);
370 bb->aux = NULL;
371 return bb;
374 static basic_block
375 cfg_layout_create_basic_block (void *head, void *end, basic_block after)
377 basic_block newbb = rtl_create_basic_block (head, end, after);
379 return newbb;
382 /* Delete the insns in a (non-live) block. We physically delete every
383 non-deleted-note insn, and update the flow graph appropriately.
385 Return nonzero if we deleted an exception handler. */
387 /* ??? Preserving all such notes strikes me as wrong. It would be nice
388 to post-process the stream to remove empty blocks, loops, ranges, etc. */
390 static void
391 rtl_delete_block (basic_block b)
393 rtx insn, end;
395 /* If the head of this block is a CODE_LABEL, then it might be the
396 label for an exception handler which can't be reached. We need
397 to remove the label from the exception_handler_label list. */
398 insn = BB_HEAD (b);
400 end = get_last_bb_insn (b);
402 /* Selectively delete the entire chain. */
403 BB_HEAD (b) = NULL;
404 delete_insn_chain (insn, end, true);
407 if (dump_file)
408 fprintf (dump_file, "deleting block %d\n", b->index);
409 df_bb_delete (b->index);
412 /* Records the basic block struct in BLOCK_FOR_INSN for every insn. */
414 void
415 compute_bb_for_insn (void)
417 basic_block bb;
419 FOR_EACH_BB_FN (bb, cfun)
421 rtx end = BB_END (bb);
422 rtx insn;
424 for (insn = BB_HEAD (bb); ; insn = NEXT_INSN (insn))
426 BLOCK_FOR_INSN (insn) = bb;
427 if (insn == end)
428 break;
433 /* Release the basic_block_for_insn array. */
435 unsigned int
436 free_bb_for_insn (void)
438 rtx insn;
439 for (insn = get_insns (); insn; insn = NEXT_INSN (insn))
440 if (!BARRIER_P (insn))
441 BLOCK_FOR_INSN (insn) = NULL;
442 return 0;
445 namespace {
447 const pass_data pass_data_free_cfg =
449 RTL_PASS, /* type */
450 "*free_cfg", /* name */
451 OPTGROUP_NONE, /* optinfo_flags */
452 TV_NONE, /* tv_id */
453 0, /* properties_required */
454 0, /* properties_provided */
455 PROP_cfg, /* properties_destroyed */
456 0, /* todo_flags_start */
457 0, /* todo_flags_finish */
460 class pass_free_cfg : public rtl_opt_pass
462 public:
463 pass_free_cfg (gcc::context *ctxt)
464 : rtl_opt_pass (pass_data_free_cfg, ctxt)
467 /* opt_pass methods: */
468 virtual unsigned int execute (function *);
470 }; // class pass_free_cfg
472 unsigned int
473 pass_free_cfg::execute (function *)
475 #ifdef DELAY_SLOTS
476 /* The resource.c machinery uses DF but the CFG isn't guaranteed to be
477 valid at that point so it would be too late to call df_analyze. */
478 if (optimize > 0 && flag_delayed_branch)
480 df_note_add_problem ();
481 df_analyze ();
483 #endif
485 if (crtl->has_bb_partition)
486 insert_section_boundary_note ();
488 free_bb_for_insn ();
489 return 0;
492 } // anon namespace
494 rtl_opt_pass *
495 make_pass_free_cfg (gcc::context *ctxt)
497 return new pass_free_cfg (ctxt);
500 /* Return RTX to emit after when we want to emit code on the entry of function. */
502 entry_of_function (void)
504 return (n_basic_blocks_for_fn (cfun) > NUM_FIXED_BLOCKS ?
505 BB_HEAD (ENTRY_BLOCK_PTR_FOR_FN (cfun)->next_bb) : get_insns ());
508 /* Emit INSN at the entry point of the function, ensuring that it is only
509 executed once per function. */
510 void
511 emit_insn_at_entry (rtx insn)
513 edge_iterator ei = ei_start (ENTRY_BLOCK_PTR_FOR_FN (cfun)->succs);
514 edge e = ei_safe_edge (ei);
515 gcc_assert (e->flags & EDGE_FALLTHRU);
517 insert_insn_on_edge (insn, e);
518 commit_edge_insertions ();
521 /* Update BLOCK_FOR_INSN of insns between BEGIN and END
522 (or BARRIER if found) and notify df of the bb change.
523 The insn chain range is inclusive
524 (i.e. both BEGIN and END will be updated. */
526 static void
527 update_bb_for_insn_chain (rtx begin, rtx end, basic_block bb)
529 rtx insn;
531 end = NEXT_INSN (end);
532 for (insn = begin; insn != end; insn = NEXT_INSN (insn))
533 if (!BARRIER_P (insn))
534 df_insn_change_bb (insn, bb);
537 /* Update BLOCK_FOR_INSN of insns in BB to BB,
538 and notify df of the change. */
540 void
541 update_bb_for_insn (basic_block bb)
543 update_bb_for_insn_chain (BB_HEAD (bb), BB_END (bb), bb);
547 /* Like active_insn_p, except keep the return value clobber around
548 even after reload. */
550 static bool
551 flow_active_insn_p (const_rtx insn)
553 if (active_insn_p (insn))
554 return true;
556 /* A clobber of the function return value exists for buggy
557 programs that fail to return a value. Its effect is to
558 keep the return value from being live across the entire
559 function. If we allow it to be skipped, we introduce the
560 possibility for register lifetime confusion. */
561 if (GET_CODE (PATTERN (insn)) == CLOBBER
562 && REG_P (XEXP (PATTERN (insn), 0))
563 && REG_FUNCTION_VALUE_P (XEXP (PATTERN (insn), 0)))
564 return true;
566 return false;
569 /* Return true if the block has no effect and only forwards control flow to
570 its single destination. */
572 bool
573 contains_no_active_insn_p (const_basic_block bb)
575 rtx insn;
577 if (bb == EXIT_BLOCK_PTR_FOR_FN (cfun) || bb == ENTRY_BLOCK_PTR_FOR_FN (cfun)
578 || !single_succ_p (bb))
579 return false;
581 for (insn = BB_HEAD (bb); insn != BB_END (bb); insn = NEXT_INSN (insn))
582 if (INSN_P (insn) && flow_active_insn_p (insn))
583 return false;
585 return (!INSN_P (insn)
586 || (JUMP_P (insn) && simplejump_p (insn))
587 || !flow_active_insn_p (insn));
590 /* Likewise, but protect loop latches, headers and preheaders. */
591 /* FIXME: Make this a cfg hook. */
593 bool
594 forwarder_block_p (const_basic_block bb)
596 if (!contains_no_active_insn_p (bb))
597 return false;
599 /* Protect loop latches, headers and preheaders. */
600 if (current_loops)
602 basic_block dest;
603 if (bb->loop_father->header == bb)
604 return false;
605 dest = EDGE_SUCC (bb, 0)->dest;
606 if (dest->loop_father->header == dest)
607 return false;
610 return true;
613 /* Return nonzero if we can reach target from src by falling through. */
614 /* FIXME: Make this a cfg hook, the result is only valid in cfgrtl mode. */
616 bool
617 can_fallthru (basic_block src, basic_block target)
619 rtx insn = BB_END (src);
620 rtx insn2;
621 edge e;
622 edge_iterator ei;
624 if (target == EXIT_BLOCK_PTR_FOR_FN (cfun))
625 return true;
626 if (src->next_bb != target)
627 return false;
629 /* ??? Later we may add code to move jump tables offline. */
630 if (tablejump_p (insn, NULL, NULL))
631 return false;
633 FOR_EACH_EDGE (e, ei, src->succs)
634 if (e->dest == EXIT_BLOCK_PTR_FOR_FN (cfun)
635 && e->flags & EDGE_FALLTHRU)
636 return false;
638 insn2 = BB_HEAD (target);
639 if (!active_insn_p (insn2))
640 insn2 = next_active_insn (insn2);
642 return next_active_insn (insn) == insn2;
645 /* Return nonzero if we could reach target from src by falling through,
646 if the target was made adjacent. If we already have a fall-through
647 edge to the exit block, we can't do that. */
648 static bool
649 could_fall_through (basic_block src, basic_block target)
651 edge e;
652 edge_iterator ei;
654 if (target == EXIT_BLOCK_PTR_FOR_FN (cfun))
655 return true;
656 FOR_EACH_EDGE (e, ei, src->succs)
657 if (e->dest == EXIT_BLOCK_PTR_FOR_FN (cfun)
658 && e->flags & EDGE_FALLTHRU)
659 return 0;
660 return true;
663 /* Return the NOTE_INSN_BASIC_BLOCK of BB. */
665 bb_note (basic_block bb)
667 rtx note;
669 note = BB_HEAD (bb);
670 if (LABEL_P (note))
671 note = NEXT_INSN (note);
673 gcc_assert (NOTE_INSN_BASIC_BLOCK_P (note));
674 return note;
677 /* Return the INSN immediately following the NOTE_INSN_BASIC_BLOCK
678 note associated with the BLOCK. */
680 static rtx
681 first_insn_after_basic_block_note (basic_block block)
683 rtx insn;
685 /* Get the first instruction in the block. */
686 insn = BB_HEAD (block);
688 if (insn == NULL_RTX)
689 return NULL_RTX;
690 if (LABEL_P (insn))
691 insn = NEXT_INSN (insn);
692 gcc_assert (NOTE_INSN_BASIC_BLOCK_P (insn));
694 return NEXT_INSN (insn);
697 /* Creates a new basic block just after basic block B by splitting
698 everything after specified instruction I. */
700 static basic_block
701 rtl_split_block (basic_block bb, void *insnp)
703 basic_block new_bb;
704 rtx insn = (rtx) insnp;
705 edge e;
706 edge_iterator ei;
708 if (!insn)
710 insn = first_insn_after_basic_block_note (bb);
712 if (insn)
714 rtx next = insn;
716 insn = PREV_INSN (insn);
718 /* If the block contains only debug insns, insn would have
719 been NULL in a non-debug compilation, and then we'd end
720 up emitting a DELETED note. For -fcompare-debug
721 stability, emit the note too. */
722 if (insn != BB_END (bb)
723 && DEBUG_INSN_P (next)
724 && DEBUG_INSN_P (BB_END (bb)))
726 while (next != BB_END (bb) && DEBUG_INSN_P (next))
727 next = NEXT_INSN (next);
729 if (next == BB_END (bb))
730 emit_note_after (NOTE_INSN_DELETED, next);
733 else
734 insn = get_last_insn ();
737 /* We probably should check type of the insn so that we do not create
738 inconsistent cfg. It is checked in verify_flow_info anyway, so do not
739 bother. */
740 if (insn == BB_END (bb))
741 emit_note_after (NOTE_INSN_DELETED, insn);
743 /* Create the new basic block. */
744 new_bb = create_basic_block (NEXT_INSN (insn), BB_END (bb), bb);
745 BB_COPY_PARTITION (new_bb, bb);
746 BB_END (bb) = insn;
748 /* Redirect the outgoing edges. */
749 new_bb->succs = bb->succs;
750 bb->succs = NULL;
751 FOR_EACH_EDGE (e, ei, new_bb->succs)
752 e->src = new_bb;
754 /* The new block starts off being dirty. */
755 df_set_bb_dirty (bb);
756 return new_bb;
759 /* Return true if the single edge between blocks A and B is the only place
760 in RTL which holds some unique locus. */
762 static bool
763 unique_locus_on_edge_between_p (basic_block a, basic_block b)
765 const location_t goto_locus = EDGE_SUCC (a, 0)->goto_locus;
766 rtx insn, end;
768 if (LOCATION_LOCUS (goto_locus) == UNKNOWN_LOCATION)
769 return false;
771 /* First scan block A backward. */
772 insn = BB_END (a);
773 end = PREV_INSN (BB_HEAD (a));
774 while (insn != end && (!NONDEBUG_INSN_P (insn) || !INSN_HAS_LOCATION (insn)))
775 insn = PREV_INSN (insn);
777 if (insn != end && INSN_LOCATION (insn) == goto_locus)
778 return false;
780 /* Then scan block B forward. */
781 insn = BB_HEAD (b);
782 if (insn)
784 end = NEXT_INSN (BB_END (b));
785 while (insn != end && !NONDEBUG_INSN_P (insn))
786 insn = NEXT_INSN (insn);
788 if (insn != end && INSN_HAS_LOCATION (insn)
789 && INSN_LOCATION (insn) == goto_locus)
790 return false;
793 return true;
796 /* If the single edge between blocks A and B is the only place in RTL which
797 holds some unique locus, emit a nop with that locus between the blocks. */
799 static void
800 emit_nop_for_unique_locus_between (basic_block a, basic_block b)
802 if (!unique_locus_on_edge_between_p (a, b))
803 return;
805 BB_END (a) = emit_insn_after_noloc (gen_nop (), BB_END (a), a);
806 INSN_LOCATION (BB_END (a)) = EDGE_SUCC (a, 0)->goto_locus;
809 /* Blocks A and B are to be merged into a single block A. The insns
810 are already contiguous. */
812 static void
813 rtl_merge_blocks (basic_block a, basic_block b)
815 rtx b_head = BB_HEAD (b), b_end = BB_END (b), a_end = BB_END (a);
816 rtx del_first = NULL_RTX, del_last = NULL_RTX;
817 rtx b_debug_start = b_end, b_debug_end = b_end;
818 bool forwarder_p = (b->flags & BB_FORWARDER_BLOCK) != 0;
819 int b_empty = 0;
821 if (dump_file)
822 fprintf (dump_file, "Merging block %d into block %d...\n", b->index,
823 a->index);
825 while (DEBUG_INSN_P (b_end))
826 b_end = PREV_INSN (b_debug_start = b_end);
828 /* If there was a CODE_LABEL beginning B, delete it. */
829 if (LABEL_P (b_head))
831 /* Detect basic blocks with nothing but a label. This can happen
832 in particular at the end of a function. */
833 if (b_head == b_end)
834 b_empty = 1;
836 del_first = del_last = b_head;
837 b_head = NEXT_INSN (b_head);
840 /* Delete the basic block note and handle blocks containing just that
841 note. */
842 if (NOTE_INSN_BASIC_BLOCK_P (b_head))
844 if (b_head == b_end)
845 b_empty = 1;
846 if (! del_last)
847 del_first = b_head;
849 del_last = b_head;
850 b_head = NEXT_INSN (b_head);
853 /* If there was a jump out of A, delete it. */
854 if (JUMP_P (a_end))
856 rtx prev;
858 for (prev = PREV_INSN (a_end); ; prev = PREV_INSN (prev))
859 if (!NOTE_P (prev)
860 || NOTE_INSN_BASIC_BLOCK_P (prev)
861 || prev == BB_HEAD (a))
862 break;
864 del_first = a_end;
866 #ifdef HAVE_cc0
867 /* If this was a conditional jump, we need to also delete
868 the insn that set cc0. */
869 if (only_sets_cc0_p (prev))
871 rtx tmp = prev;
873 prev = prev_nonnote_insn (prev);
874 if (!prev)
875 prev = BB_HEAD (a);
876 del_first = tmp;
878 #endif
880 a_end = PREV_INSN (del_first);
882 else if (BARRIER_P (NEXT_INSN (a_end)))
883 del_first = NEXT_INSN (a_end);
885 /* Delete everything marked above as well as crap that might be
886 hanging out between the two blocks. */
887 BB_END (a) = a_end;
888 BB_HEAD (b) = b_empty ? NULL_RTX : b_head;
889 delete_insn_chain (del_first, del_last, true);
891 /* When not optimizing and the edge is the only place in RTL which holds
892 some unique locus, emit a nop with that locus in between. */
893 if (!optimize)
895 emit_nop_for_unique_locus_between (a, b);
896 a_end = BB_END (a);
899 /* Reassociate the insns of B with A. */
900 if (!b_empty)
902 update_bb_for_insn_chain (a_end, b_debug_end, a);
904 BB_END (a) = b_debug_end;
905 BB_HEAD (b) = NULL_RTX;
907 else if (b_end != b_debug_end)
909 /* Move any deleted labels and other notes between the end of A
910 and the debug insns that make up B after the debug insns,
911 bringing the debug insns into A while keeping the notes after
912 the end of A. */
913 if (NEXT_INSN (a_end) != b_debug_start)
914 reorder_insns_nobb (NEXT_INSN (a_end), PREV_INSN (b_debug_start),
915 b_debug_end);
916 update_bb_for_insn_chain (b_debug_start, b_debug_end, a);
917 BB_END (a) = b_debug_end;
920 df_bb_delete (b->index);
922 /* If B was a forwarder block, propagate the locus on the edge. */
923 if (forwarder_p
924 && LOCATION_LOCUS (EDGE_SUCC (b, 0)->goto_locus) == UNKNOWN_LOCATION)
925 EDGE_SUCC (b, 0)->goto_locus = EDGE_SUCC (a, 0)->goto_locus;
927 if (dump_file)
928 fprintf (dump_file, "Merged blocks %d and %d.\n", a->index, b->index);
932 /* Return true when block A and B can be merged. */
934 static bool
935 rtl_can_merge_blocks (basic_block a, basic_block b)
937 /* If we are partitioning hot/cold basic blocks, we don't want to
938 mess up unconditional or indirect jumps that cross between hot
939 and cold sections.
941 Basic block partitioning may result in some jumps that appear to
942 be optimizable (or blocks that appear to be mergeable), but which really
943 must be left untouched (they are required to make it safely across
944 partition boundaries). See the comments at the top of
945 bb-reorder.c:partition_hot_cold_basic_blocks for complete details. */
947 if (BB_PARTITION (a) != BB_PARTITION (b))
948 return false;
950 /* Protect the loop latches. */
951 if (current_loops && b->loop_father->latch == b)
952 return false;
954 /* There must be exactly one edge in between the blocks. */
955 return (single_succ_p (a)
956 && single_succ (a) == b
957 && single_pred_p (b)
958 && a != b
959 /* Must be simple edge. */
960 && !(single_succ_edge (a)->flags & EDGE_COMPLEX)
961 && a->next_bb == b
962 && a != ENTRY_BLOCK_PTR_FOR_FN (cfun)
963 && b != EXIT_BLOCK_PTR_FOR_FN (cfun)
964 /* If the jump insn has side effects,
965 we can't kill the edge. */
966 && (!JUMP_P (BB_END (a))
967 || (reload_completed
968 ? simplejump_p (BB_END (a)) : onlyjump_p (BB_END (a)))));
971 /* Return the label in the head of basic block BLOCK. Create one if it doesn't
972 exist. */
975 block_label (basic_block block)
977 if (block == EXIT_BLOCK_PTR_FOR_FN (cfun))
978 return NULL_RTX;
980 if (!LABEL_P (BB_HEAD (block)))
982 BB_HEAD (block) = emit_label_before (gen_label_rtx (), BB_HEAD (block));
985 return BB_HEAD (block);
988 /* Attempt to perform edge redirection by replacing possibly complex jump
989 instruction by unconditional jump or removing jump completely. This can
990 apply only if all edges now point to the same block. The parameters and
991 return values are equivalent to redirect_edge_and_branch. */
993 edge
994 try_redirect_by_replacing_jump (edge e, basic_block target, bool in_cfglayout)
996 basic_block src = e->src;
997 rtx insn = BB_END (src), kill_from;
998 rtx set;
999 int fallthru = 0;
1001 /* If we are partitioning hot/cold basic blocks, we don't want to
1002 mess up unconditional or indirect jumps that cross between hot
1003 and cold sections.
1005 Basic block partitioning may result in some jumps that appear to
1006 be optimizable (or blocks that appear to be mergeable), but which really
1007 must be left untouched (they are required to make it safely across
1008 partition boundaries). See the comments at the top of
1009 bb-reorder.c:partition_hot_cold_basic_blocks for complete details. */
1011 if (BB_PARTITION (src) != BB_PARTITION (target))
1012 return NULL;
1014 /* We can replace or remove a complex jump only when we have exactly
1015 two edges. Also, if we have exactly one outgoing edge, we can
1016 redirect that. */
1017 if (EDGE_COUNT (src->succs) >= 3
1018 /* Verify that all targets will be TARGET. Specifically, the
1019 edge that is not E must also go to TARGET. */
1020 || (EDGE_COUNT (src->succs) == 2
1021 && EDGE_SUCC (src, EDGE_SUCC (src, 0) == e)->dest != target))
1022 return NULL;
1024 if (!onlyjump_p (insn))
1025 return NULL;
1026 if ((!optimize || reload_completed) && tablejump_p (insn, NULL, NULL))
1027 return NULL;
1029 /* Avoid removing branch with side effects. */
1030 set = single_set (insn);
1031 if (!set || side_effects_p (set))
1032 return NULL;
1034 /* In case we zap a conditional jump, we'll need to kill
1035 the cc0 setter too. */
1036 kill_from = insn;
1037 #ifdef HAVE_cc0
1038 if (reg_mentioned_p (cc0_rtx, PATTERN (insn))
1039 && only_sets_cc0_p (PREV_INSN (insn)))
1040 kill_from = PREV_INSN (insn);
1041 #endif
1043 /* See if we can create the fallthru edge. */
1044 if (in_cfglayout || can_fallthru (src, target))
1046 if (dump_file)
1047 fprintf (dump_file, "Removing jump %i.\n", INSN_UID (insn));
1048 fallthru = 1;
1050 /* Selectively unlink whole insn chain. */
1051 if (in_cfglayout)
1053 rtx insn = BB_FOOTER (src);
1055 delete_insn_chain (kill_from, BB_END (src), false);
1057 /* Remove barriers but keep jumptables. */
1058 while (insn)
1060 if (BARRIER_P (insn))
1062 if (PREV_INSN (insn))
1063 NEXT_INSN (PREV_INSN (insn)) = NEXT_INSN (insn);
1064 else
1065 BB_FOOTER (src) = NEXT_INSN (insn);
1066 if (NEXT_INSN (insn))
1067 PREV_INSN (NEXT_INSN (insn)) = PREV_INSN (insn);
1069 if (LABEL_P (insn))
1070 break;
1071 insn = NEXT_INSN (insn);
1074 else
1075 delete_insn_chain (kill_from, PREV_INSN (BB_HEAD (target)),
1076 false);
1079 /* If this already is simplejump, redirect it. */
1080 else if (simplejump_p (insn))
1082 if (e->dest == target)
1083 return NULL;
1084 if (dump_file)
1085 fprintf (dump_file, "Redirecting jump %i from %i to %i.\n",
1086 INSN_UID (insn), e->dest->index, target->index);
1087 if (!redirect_jump (insn, block_label (target), 0))
1089 gcc_assert (target == EXIT_BLOCK_PTR_FOR_FN (cfun));
1090 return NULL;
1094 /* Cannot do anything for target exit block. */
1095 else if (target == EXIT_BLOCK_PTR_FOR_FN (cfun))
1096 return NULL;
1098 /* Or replace possibly complicated jump insn by simple jump insn. */
1099 else
1101 rtx target_label = block_label (target);
1102 rtx barrier, label, table;
1104 emit_jump_insn_after_noloc (gen_jump (target_label), insn);
1105 JUMP_LABEL (BB_END (src)) = target_label;
1106 LABEL_NUSES (target_label)++;
1107 if (dump_file)
1108 fprintf (dump_file, "Replacing insn %i by jump %i\n",
1109 INSN_UID (insn), INSN_UID (BB_END (src)));
1112 delete_insn_chain (kill_from, insn, false);
1114 /* Recognize a tablejump that we are converting to a
1115 simple jump and remove its associated CODE_LABEL
1116 and ADDR_VEC or ADDR_DIFF_VEC. */
1117 if (tablejump_p (insn, &label, &table))
1118 delete_insn_chain (label, table, false);
1120 barrier = next_nonnote_insn (BB_END (src));
1121 if (!barrier || !BARRIER_P (barrier))
1122 emit_barrier_after (BB_END (src));
1123 else
1125 if (barrier != NEXT_INSN (BB_END (src)))
1127 /* Move the jump before barrier so that the notes
1128 which originally were or were created before jump table are
1129 inside the basic block. */
1130 rtx new_insn = BB_END (src);
1132 update_bb_for_insn_chain (NEXT_INSN (BB_END (src)),
1133 PREV_INSN (barrier), src);
1135 NEXT_INSN (PREV_INSN (new_insn)) = NEXT_INSN (new_insn);
1136 PREV_INSN (NEXT_INSN (new_insn)) = PREV_INSN (new_insn);
1138 NEXT_INSN (new_insn) = barrier;
1139 NEXT_INSN (PREV_INSN (barrier)) = new_insn;
1141 PREV_INSN (new_insn) = PREV_INSN (barrier);
1142 PREV_INSN (barrier) = new_insn;
1147 /* Keep only one edge out and set proper flags. */
1148 if (!single_succ_p (src))
1149 remove_edge (e);
1150 gcc_assert (single_succ_p (src));
1152 e = single_succ_edge (src);
1153 if (fallthru)
1154 e->flags = EDGE_FALLTHRU;
1155 else
1156 e->flags = 0;
1158 e->probability = REG_BR_PROB_BASE;
1159 e->count = src->count;
1161 if (e->dest != target)
1162 redirect_edge_succ (e, target);
1163 return e;
1166 /* Subroutine of redirect_branch_edge that tries to patch the jump
1167 instruction INSN so that it reaches block NEW. Do this
1168 only when it originally reached block OLD. Return true if this
1169 worked or the original target wasn't OLD, return false if redirection
1170 doesn't work. */
1172 static bool
1173 patch_jump_insn (rtx insn, rtx old_label, basic_block new_bb)
1175 rtx tmp;
1176 /* Recognize a tablejump and adjust all matching cases. */
1177 if (tablejump_p (insn, NULL, &tmp))
1179 rtvec vec;
1180 int j;
1181 rtx new_label = block_label (new_bb);
1183 if (new_bb == EXIT_BLOCK_PTR_FOR_FN (cfun))
1184 return false;
1185 if (GET_CODE (PATTERN (tmp)) == ADDR_VEC)
1186 vec = XVEC (PATTERN (tmp), 0);
1187 else
1188 vec = XVEC (PATTERN (tmp), 1);
1190 for (j = GET_NUM_ELEM (vec) - 1; j >= 0; --j)
1191 if (XEXP (RTVEC_ELT (vec, j), 0) == old_label)
1193 RTVEC_ELT (vec, j) = gen_rtx_LABEL_REF (Pmode, new_label);
1194 --LABEL_NUSES (old_label);
1195 ++LABEL_NUSES (new_label);
1198 /* Handle casesi dispatch insns. */
1199 if ((tmp = single_set (insn)) != NULL
1200 && SET_DEST (tmp) == pc_rtx
1201 && GET_CODE (SET_SRC (tmp)) == IF_THEN_ELSE
1202 && GET_CODE (XEXP (SET_SRC (tmp), 2)) == LABEL_REF
1203 && XEXP (XEXP (SET_SRC (tmp), 2), 0) == old_label)
1205 XEXP (SET_SRC (tmp), 2) = gen_rtx_LABEL_REF (Pmode,
1206 new_label);
1207 --LABEL_NUSES (old_label);
1208 ++LABEL_NUSES (new_label);
1211 else if ((tmp = extract_asm_operands (PATTERN (insn))) != NULL)
1213 int i, n = ASM_OPERANDS_LABEL_LENGTH (tmp);
1214 rtx new_label, note;
1216 if (new_bb == EXIT_BLOCK_PTR_FOR_FN (cfun))
1217 return false;
1218 new_label = block_label (new_bb);
1220 for (i = 0; i < n; ++i)
1222 rtx old_ref = ASM_OPERANDS_LABEL (tmp, i);
1223 gcc_assert (GET_CODE (old_ref) == LABEL_REF);
1224 if (XEXP (old_ref, 0) == old_label)
1226 ASM_OPERANDS_LABEL (tmp, i)
1227 = gen_rtx_LABEL_REF (Pmode, new_label);
1228 --LABEL_NUSES (old_label);
1229 ++LABEL_NUSES (new_label);
1233 if (JUMP_LABEL (insn) == old_label)
1235 JUMP_LABEL (insn) = new_label;
1236 note = find_reg_note (insn, REG_LABEL_TARGET, new_label);
1237 if (note)
1238 remove_note (insn, note);
1240 else
1242 note = find_reg_note (insn, REG_LABEL_TARGET, old_label);
1243 if (note)
1244 remove_note (insn, note);
1245 if (JUMP_LABEL (insn) != new_label
1246 && !find_reg_note (insn, REG_LABEL_TARGET, new_label))
1247 add_reg_note (insn, REG_LABEL_TARGET, new_label);
1249 while ((note = find_reg_note (insn, REG_LABEL_OPERAND, old_label))
1250 != NULL_RTX)
1251 XEXP (note, 0) = new_label;
1253 else
1255 /* ?? We may play the games with moving the named labels from
1256 one basic block to the other in case only one computed_jump is
1257 available. */
1258 if (computed_jump_p (insn)
1259 /* A return instruction can't be redirected. */
1260 || returnjump_p (insn))
1261 return false;
1263 if (!currently_expanding_to_rtl || JUMP_LABEL (insn) == old_label)
1265 /* If the insn doesn't go where we think, we're confused. */
1266 gcc_assert (JUMP_LABEL (insn) == old_label);
1268 /* If the substitution doesn't succeed, die. This can happen
1269 if the back end emitted unrecognizable instructions or if
1270 target is exit block on some arches. */
1271 if (!redirect_jump (insn, block_label (new_bb), 0))
1273 gcc_assert (new_bb == EXIT_BLOCK_PTR_FOR_FN (cfun));
1274 return false;
1278 return true;
1282 /* Redirect edge representing branch of (un)conditional jump or tablejump,
1283 NULL on failure */
1284 static edge
1285 redirect_branch_edge (edge e, basic_block target)
1287 rtx old_label = BB_HEAD (e->dest);
1288 basic_block src = e->src;
1289 rtx insn = BB_END (src);
1291 /* We can only redirect non-fallthru edges of jump insn. */
1292 if (e->flags & EDGE_FALLTHRU)
1293 return NULL;
1294 else if (!JUMP_P (insn) && !currently_expanding_to_rtl)
1295 return NULL;
1297 if (!currently_expanding_to_rtl)
1299 if (!patch_jump_insn (insn, old_label, target))
1300 return NULL;
1302 else
1303 /* When expanding this BB might actually contain multiple
1304 jumps (i.e. not yet split by find_many_sub_basic_blocks).
1305 Redirect all of those that match our label. */
1306 FOR_BB_INSNS (src, insn)
1307 if (JUMP_P (insn) && !patch_jump_insn (insn, old_label, target))
1308 return NULL;
1310 if (dump_file)
1311 fprintf (dump_file, "Edge %i->%i redirected to %i\n",
1312 e->src->index, e->dest->index, target->index);
1314 if (e->dest != target)
1315 e = redirect_edge_succ_nodup (e, target);
1317 return e;
1320 /* Called when edge E has been redirected to a new destination,
1321 in order to update the region crossing flag on the edge and
1322 jump. */
1324 static void
1325 fixup_partition_crossing (edge e)
1327 if (e->src == ENTRY_BLOCK_PTR_FOR_FN (cfun) || e->dest
1328 == EXIT_BLOCK_PTR_FOR_FN (cfun))
1329 return;
1330 /* If we redirected an existing edge, it may already be marked
1331 crossing, even though the new src is missing a reg crossing note.
1332 But make sure reg crossing note doesn't already exist before
1333 inserting. */
1334 if (BB_PARTITION (e->src) != BB_PARTITION (e->dest))
1336 e->flags |= EDGE_CROSSING;
1337 if (JUMP_P (BB_END (e->src))
1338 && !CROSSING_JUMP_P (BB_END (e->src)))
1339 CROSSING_JUMP_P (BB_END (e->src)) = 1;
1341 else if (BB_PARTITION (e->src) == BB_PARTITION (e->dest))
1343 e->flags &= ~EDGE_CROSSING;
1344 /* Remove the section crossing note from jump at end of
1345 src if it exists, and if no other successors are
1346 still crossing. */
1347 if (JUMP_P (BB_END (e->src)) && CROSSING_JUMP_P (BB_END (e->src)))
1349 bool has_crossing_succ = false;
1350 edge e2;
1351 edge_iterator ei;
1352 FOR_EACH_EDGE (e2, ei, e->src->succs)
1354 has_crossing_succ |= (e2->flags & EDGE_CROSSING);
1355 if (has_crossing_succ)
1356 break;
1358 if (!has_crossing_succ)
1359 CROSSING_JUMP_P (BB_END (e->src)) = 0;
1364 /* Called when block BB has been reassigned to the cold partition,
1365 because it is now dominated by another cold block,
1366 to ensure that the region crossing attributes are updated. */
1368 static void
1369 fixup_new_cold_bb (basic_block bb)
1371 edge e;
1372 edge_iterator ei;
1374 /* This is called when a hot bb is found to now be dominated
1375 by a cold bb and therefore needs to become cold. Therefore,
1376 its preds will no longer be region crossing. Any non-dominating
1377 preds that were previously hot would also have become cold
1378 in the caller for the same region. Any preds that were previously
1379 region-crossing will be adjusted in fixup_partition_crossing. */
1380 FOR_EACH_EDGE (e, ei, bb->preds)
1382 fixup_partition_crossing (e);
1385 /* Possibly need to make bb's successor edges region crossing,
1386 or remove stale region crossing. */
1387 FOR_EACH_EDGE (e, ei, bb->succs)
1389 /* We can't have fall-through edges across partition boundaries.
1390 Note that force_nonfallthru will do any necessary partition
1391 boundary fixup by calling fixup_partition_crossing itself. */
1392 if ((e->flags & EDGE_FALLTHRU)
1393 && BB_PARTITION (bb) != BB_PARTITION (e->dest)
1394 && e->dest != EXIT_BLOCK_PTR_FOR_FN (cfun))
1395 force_nonfallthru (e);
1396 else
1397 fixup_partition_crossing (e);
1401 /* Attempt to change code to redirect edge E to TARGET. Don't do that on
1402 expense of adding new instructions or reordering basic blocks.
1404 Function can be also called with edge destination equivalent to the TARGET.
1405 Then it should try the simplifications and do nothing if none is possible.
1407 Return edge representing the branch if transformation succeeded. Return NULL
1408 on failure.
1409 We still return NULL in case E already destinated TARGET and we didn't
1410 managed to simplify instruction stream. */
1412 static edge
1413 rtl_redirect_edge_and_branch (edge e, basic_block target)
1415 edge ret;
1416 basic_block src = e->src;
1417 basic_block dest = e->dest;
1419 if (e->flags & (EDGE_ABNORMAL_CALL | EDGE_EH))
1420 return NULL;
1422 if (dest == target)
1423 return e;
1425 if ((ret = try_redirect_by_replacing_jump (e, target, false)) != NULL)
1427 df_set_bb_dirty (src);
1428 fixup_partition_crossing (ret);
1429 return ret;
1432 ret = redirect_branch_edge (e, target);
1433 if (!ret)
1434 return NULL;
1436 df_set_bb_dirty (src);
1437 fixup_partition_crossing (ret);
1438 return ret;
1441 /* Emit a barrier after BB, into the footer if we are in CFGLAYOUT mode. */
1443 void
1444 emit_barrier_after_bb (basic_block bb)
1446 rtx barrier = emit_barrier_after (BB_END (bb));
1447 gcc_assert (current_ir_type () == IR_RTL_CFGRTL
1448 || current_ir_type () == IR_RTL_CFGLAYOUT);
1449 if (current_ir_type () == IR_RTL_CFGLAYOUT)
1450 BB_FOOTER (bb) = unlink_insn_chain (barrier, barrier);
1453 /* Like force_nonfallthru below, but additionally performs redirection
1454 Used by redirect_edge_and_branch_force. JUMP_LABEL is used only
1455 when redirecting to the EXIT_BLOCK, it is either ret_rtx or
1456 simple_return_rtx, indicating which kind of returnjump to create.
1457 It should be NULL otherwise. */
1459 basic_block
1460 force_nonfallthru_and_redirect (edge e, basic_block target, rtx jump_label)
1462 basic_block jump_block, new_bb = NULL, src = e->src;
1463 rtx note;
1464 edge new_edge;
1465 int abnormal_edge_flags = 0;
1466 bool asm_goto_edge = false;
1467 int loc;
1469 /* In the case the last instruction is conditional jump to the next
1470 instruction, first redirect the jump itself and then continue
1471 by creating a basic block afterwards to redirect fallthru edge. */
1472 if (e->src != ENTRY_BLOCK_PTR_FOR_FN (cfun)
1473 && e->dest != EXIT_BLOCK_PTR_FOR_FN (cfun)
1474 && any_condjump_p (BB_END (e->src))
1475 && JUMP_LABEL (BB_END (e->src)) == BB_HEAD (e->dest))
1477 rtx note;
1478 edge b = unchecked_make_edge (e->src, target, 0);
1479 bool redirected;
1481 redirected = redirect_jump (BB_END (e->src), block_label (target), 0);
1482 gcc_assert (redirected);
1484 note = find_reg_note (BB_END (e->src), REG_BR_PROB, NULL_RTX);
1485 if (note)
1487 int prob = XINT (note, 0);
1489 b->probability = prob;
1490 /* Update this to use GCOV_COMPUTE_SCALE. */
1491 b->count = e->count * prob / REG_BR_PROB_BASE;
1492 e->probability -= e->probability;
1493 e->count -= b->count;
1494 if (e->probability < 0)
1495 e->probability = 0;
1496 if (e->count < 0)
1497 e->count = 0;
1501 if (e->flags & EDGE_ABNORMAL)
1503 /* Irritating special case - fallthru edge to the same block as abnormal
1504 edge.
1505 We can't redirect abnormal edge, but we still can split the fallthru
1506 one and create separate abnormal edge to original destination.
1507 This allows bb-reorder to make such edge non-fallthru. */
1508 gcc_assert (e->dest == target);
1509 abnormal_edge_flags = e->flags & ~EDGE_FALLTHRU;
1510 e->flags &= EDGE_FALLTHRU;
1512 else
1514 gcc_assert (e->flags & EDGE_FALLTHRU);
1515 if (e->src == ENTRY_BLOCK_PTR_FOR_FN (cfun))
1517 /* We can't redirect the entry block. Create an empty block
1518 at the start of the function which we use to add the new
1519 jump. */
1520 edge tmp;
1521 edge_iterator ei;
1522 bool found = false;
1524 basic_block bb = create_basic_block (BB_HEAD (e->dest), NULL,
1525 ENTRY_BLOCK_PTR_FOR_FN (cfun));
1527 /* Change the existing edge's source to be the new block, and add
1528 a new edge from the entry block to the new block. */
1529 e->src = bb;
1530 for (ei = ei_start (ENTRY_BLOCK_PTR_FOR_FN (cfun)->succs);
1531 (tmp = ei_safe_edge (ei)); )
1533 if (tmp == e)
1535 ENTRY_BLOCK_PTR_FOR_FN (cfun)->succs->unordered_remove (ei.index);
1536 found = true;
1537 break;
1539 else
1540 ei_next (&ei);
1543 gcc_assert (found);
1545 vec_safe_push (bb->succs, e);
1546 make_single_succ_edge (ENTRY_BLOCK_PTR_FOR_FN (cfun), bb,
1547 EDGE_FALLTHRU);
1551 /* If e->src ends with asm goto, see if any of the ASM_OPERANDS_LABELs
1552 don't point to the target or fallthru label. */
1553 if (JUMP_P (BB_END (e->src))
1554 && target != EXIT_BLOCK_PTR_FOR_FN (cfun)
1555 && (e->flags & EDGE_FALLTHRU)
1556 && (note = extract_asm_operands (PATTERN (BB_END (e->src)))))
1558 int i, n = ASM_OPERANDS_LABEL_LENGTH (note);
1559 bool adjust_jump_target = false;
1561 for (i = 0; i < n; ++i)
1563 if (XEXP (ASM_OPERANDS_LABEL (note, i), 0) == BB_HEAD (e->dest))
1565 LABEL_NUSES (XEXP (ASM_OPERANDS_LABEL (note, i), 0))--;
1566 XEXP (ASM_OPERANDS_LABEL (note, i), 0) = block_label (target);
1567 LABEL_NUSES (XEXP (ASM_OPERANDS_LABEL (note, i), 0))++;
1568 adjust_jump_target = true;
1570 if (XEXP (ASM_OPERANDS_LABEL (note, i), 0) == BB_HEAD (target))
1571 asm_goto_edge = true;
1573 if (adjust_jump_target)
1575 rtx insn = BB_END (e->src), note;
1576 rtx old_label = BB_HEAD (e->dest);
1577 rtx new_label = BB_HEAD (target);
1579 if (JUMP_LABEL (insn) == old_label)
1581 JUMP_LABEL (insn) = new_label;
1582 note = find_reg_note (insn, REG_LABEL_TARGET, new_label);
1583 if (note)
1584 remove_note (insn, note);
1586 else
1588 note = find_reg_note (insn, REG_LABEL_TARGET, old_label);
1589 if (note)
1590 remove_note (insn, note);
1591 if (JUMP_LABEL (insn) != new_label
1592 && !find_reg_note (insn, REG_LABEL_TARGET, new_label))
1593 add_reg_note (insn, REG_LABEL_TARGET, new_label);
1595 while ((note = find_reg_note (insn, REG_LABEL_OPERAND, old_label))
1596 != NULL_RTX)
1597 XEXP (note, 0) = new_label;
1601 if (EDGE_COUNT (e->src->succs) >= 2 || abnormal_edge_flags || asm_goto_edge)
1603 gcov_type count = e->count;
1604 int probability = e->probability;
1605 /* Create the new structures. */
1607 /* If the old block ended with a tablejump, skip its table
1608 by searching forward from there. Otherwise start searching
1609 forward from the last instruction of the old block. */
1610 if (!tablejump_p (BB_END (e->src), NULL, &note))
1611 note = BB_END (e->src);
1612 note = NEXT_INSN (note);
1614 jump_block = create_basic_block (note, NULL, e->src);
1615 jump_block->count = count;
1616 jump_block->frequency = EDGE_FREQUENCY (e);
1618 /* Make sure new block ends up in correct hot/cold section. */
1620 BB_COPY_PARTITION (jump_block, e->src);
1622 /* Wire edge in. */
1623 new_edge = make_edge (e->src, jump_block, EDGE_FALLTHRU);
1624 new_edge->probability = probability;
1625 new_edge->count = count;
1627 /* Redirect old edge. */
1628 redirect_edge_pred (e, jump_block);
1629 e->probability = REG_BR_PROB_BASE;
1631 /* If e->src was previously region crossing, it no longer is
1632 and the reg crossing note should be removed. */
1633 fixup_partition_crossing (new_edge);
1635 /* If asm goto has any label refs to target's label,
1636 add also edge from asm goto bb to target. */
1637 if (asm_goto_edge)
1639 new_edge->probability /= 2;
1640 new_edge->count /= 2;
1641 jump_block->count /= 2;
1642 jump_block->frequency /= 2;
1643 new_edge = make_edge (new_edge->src, target,
1644 e->flags & ~EDGE_FALLTHRU);
1645 new_edge->probability = probability - probability / 2;
1646 new_edge->count = count - count / 2;
1649 new_bb = jump_block;
1651 else
1652 jump_block = e->src;
1654 loc = e->goto_locus;
1655 e->flags &= ~EDGE_FALLTHRU;
1656 if (target == EXIT_BLOCK_PTR_FOR_FN (cfun))
1658 if (jump_label == ret_rtx)
1660 #ifdef HAVE_return
1661 emit_jump_insn_after_setloc (gen_return (), BB_END (jump_block), loc);
1662 #else
1663 gcc_unreachable ();
1664 #endif
1666 else
1668 gcc_assert (jump_label == simple_return_rtx);
1669 #ifdef HAVE_simple_return
1670 emit_jump_insn_after_setloc (gen_simple_return (),
1671 BB_END (jump_block), loc);
1672 #else
1673 gcc_unreachable ();
1674 #endif
1676 set_return_jump_label (BB_END (jump_block));
1678 else
1680 rtx label = block_label (target);
1681 emit_jump_insn_after_setloc (gen_jump (label), BB_END (jump_block), loc);
1682 JUMP_LABEL (BB_END (jump_block)) = label;
1683 LABEL_NUSES (label)++;
1686 /* We might be in cfg layout mode, and if so, the following routine will
1687 insert the barrier correctly. */
1688 emit_barrier_after_bb (jump_block);
1689 redirect_edge_succ_nodup (e, target);
1691 if (abnormal_edge_flags)
1692 make_edge (src, target, abnormal_edge_flags);
1694 df_mark_solutions_dirty ();
1695 fixup_partition_crossing (e);
1696 return new_bb;
1699 /* Edge E is assumed to be fallthru edge. Emit needed jump instruction
1700 (and possibly create new basic block) to make edge non-fallthru.
1701 Return newly created BB or NULL if none. */
1703 static basic_block
1704 rtl_force_nonfallthru (edge e)
1706 return force_nonfallthru_and_redirect (e, e->dest, NULL_RTX);
1709 /* Redirect edge even at the expense of creating new jump insn or
1710 basic block. Return new basic block if created, NULL otherwise.
1711 Conversion must be possible. */
1713 static basic_block
1714 rtl_redirect_edge_and_branch_force (edge e, basic_block target)
1716 if (redirect_edge_and_branch (e, target)
1717 || e->dest == target)
1718 return NULL;
1720 /* In case the edge redirection failed, try to force it to be non-fallthru
1721 and redirect newly created simplejump. */
1722 df_set_bb_dirty (e->src);
1723 return force_nonfallthru_and_redirect (e, target, NULL_RTX);
1726 /* The given edge should potentially be a fallthru edge. If that is in
1727 fact true, delete the jump and barriers that are in the way. */
1729 static void
1730 rtl_tidy_fallthru_edge (edge e)
1732 rtx q;
1733 basic_block b = e->src, c = b->next_bb;
1735 /* ??? In a late-running flow pass, other folks may have deleted basic
1736 blocks by nopping out blocks, leaving multiple BARRIERs between here
1737 and the target label. They ought to be chastised and fixed.
1739 We can also wind up with a sequence of undeletable labels between
1740 one block and the next.
1742 So search through a sequence of barriers, labels, and notes for
1743 the head of block C and assert that we really do fall through. */
1745 for (q = NEXT_INSN (BB_END (b)); q != BB_HEAD (c); q = NEXT_INSN (q))
1746 if (INSN_P (q))
1747 return;
1749 /* Remove what will soon cease being the jump insn from the source block.
1750 If block B consisted only of this single jump, turn it into a deleted
1751 note. */
1752 q = BB_END (b);
1753 if (JUMP_P (q)
1754 && onlyjump_p (q)
1755 && (any_uncondjump_p (q)
1756 || single_succ_p (b)))
1758 #ifdef HAVE_cc0
1759 /* If this was a conditional jump, we need to also delete
1760 the insn that set cc0. */
1761 if (any_condjump_p (q) && only_sets_cc0_p (PREV_INSN (q)))
1762 q = PREV_INSN (q);
1763 #endif
1765 q = PREV_INSN (q);
1768 /* Selectively unlink the sequence. */
1769 if (q != PREV_INSN (BB_HEAD (c)))
1770 delete_insn_chain (NEXT_INSN (q), PREV_INSN (BB_HEAD (c)), false);
1772 e->flags |= EDGE_FALLTHRU;
1775 /* Should move basic block BB after basic block AFTER. NIY. */
1777 static bool
1778 rtl_move_block_after (basic_block bb ATTRIBUTE_UNUSED,
1779 basic_block after ATTRIBUTE_UNUSED)
1781 return false;
1784 /* Locate the last bb in the same partition as START_BB. */
1786 static basic_block
1787 last_bb_in_partition (basic_block start_bb)
1789 basic_block bb;
1790 FOR_BB_BETWEEN (bb, start_bb, EXIT_BLOCK_PTR_FOR_FN (cfun), next_bb)
1792 if (BB_PARTITION (start_bb) != BB_PARTITION (bb->next_bb))
1793 return bb;
1795 /* Return bb before the exit block. */
1796 return bb->prev_bb;
1799 /* Split a (typically critical) edge. Return the new block.
1800 The edge must not be abnormal.
1802 ??? The code generally expects to be called on critical edges.
1803 The case of a block ending in an unconditional jump to a
1804 block with multiple predecessors is not handled optimally. */
1806 static basic_block
1807 rtl_split_edge (edge edge_in)
1809 basic_block bb, new_bb;
1810 rtx before;
1812 /* Abnormal edges cannot be split. */
1813 gcc_assert (!(edge_in->flags & EDGE_ABNORMAL));
1815 /* We are going to place the new block in front of edge destination.
1816 Avoid existence of fallthru predecessors. */
1817 if ((edge_in->flags & EDGE_FALLTHRU) == 0)
1819 edge e = find_fallthru_edge (edge_in->dest->preds);
1821 if (e)
1822 force_nonfallthru (e);
1825 /* Create the basic block note. */
1826 if (edge_in->dest != EXIT_BLOCK_PTR_FOR_FN (cfun))
1827 before = BB_HEAD (edge_in->dest);
1828 else
1829 before = NULL_RTX;
1831 /* If this is a fall through edge to the exit block, the blocks might be
1832 not adjacent, and the right place is after the source. */
1833 if ((edge_in->flags & EDGE_FALLTHRU)
1834 && edge_in->dest == EXIT_BLOCK_PTR_FOR_FN (cfun))
1836 before = NEXT_INSN (BB_END (edge_in->src));
1837 bb = create_basic_block (before, NULL, edge_in->src);
1838 BB_COPY_PARTITION (bb, edge_in->src);
1840 else
1842 if (edge_in->src == ENTRY_BLOCK_PTR_FOR_FN (cfun))
1844 bb = create_basic_block (before, NULL, edge_in->dest->prev_bb);
1845 BB_COPY_PARTITION (bb, edge_in->dest);
1847 else
1849 basic_block after = edge_in->dest->prev_bb;
1850 /* If this is post-bb reordering, and the edge crosses a partition
1851 boundary, the new block needs to be inserted in the bb chain
1852 at the end of the src partition (since we put the new bb into
1853 that partition, see below). Otherwise we may end up creating
1854 an extra partition crossing in the chain, which is illegal.
1855 It can't go after the src, because src may have a fall-through
1856 to a different block. */
1857 if (crtl->bb_reorder_complete
1858 && (edge_in->flags & EDGE_CROSSING))
1860 after = last_bb_in_partition (edge_in->src);
1861 before = NEXT_INSN (BB_END (after));
1862 /* The instruction following the last bb in partition should
1863 be a barrier, since it cannot end in a fall-through. */
1864 gcc_checking_assert (BARRIER_P (before));
1865 before = NEXT_INSN (before);
1867 bb = create_basic_block (before, NULL, after);
1868 /* Put the split bb into the src partition, to avoid creating
1869 a situation where a cold bb dominates a hot bb, in the case
1870 where src is cold and dest is hot. The src will dominate
1871 the new bb (whereas it might not have dominated dest). */
1872 BB_COPY_PARTITION (bb, edge_in->src);
1876 make_single_succ_edge (bb, edge_in->dest, EDGE_FALLTHRU);
1878 /* Can't allow a region crossing edge to be fallthrough. */
1879 if (BB_PARTITION (bb) != BB_PARTITION (edge_in->dest)
1880 && edge_in->dest != EXIT_BLOCK_PTR_FOR_FN (cfun))
1882 new_bb = force_nonfallthru (single_succ_edge (bb));
1883 gcc_assert (!new_bb);
1886 /* For non-fallthru edges, we must adjust the predecessor's
1887 jump instruction to target our new block. */
1888 if ((edge_in->flags & EDGE_FALLTHRU) == 0)
1890 edge redirected = redirect_edge_and_branch (edge_in, bb);
1891 gcc_assert (redirected);
1893 else
1895 if (edge_in->src != ENTRY_BLOCK_PTR_FOR_FN (cfun))
1897 /* For asm goto even splitting of fallthru edge might
1898 need insn patching, as other labels might point to the
1899 old label. */
1900 rtx last = BB_END (edge_in->src);
1901 if (last
1902 && JUMP_P (last)
1903 && edge_in->dest != EXIT_BLOCK_PTR_FOR_FN (cfun)
1904 && extract_asm_operands (PATTERN (last)) != NULL_RTX
1905 && patch_jump_insn (last, before, bb))
1906 df_set_bb_dirty (edge_in->src);
1908 redirect_edge_succ (edge_in, bb);
1911 return bb;
1914 /* Queue instructions for insertion on an edge between two basic blocks.
1915 The new instructions and basic blocks (if any) will not appear in the
1916 CFG until commit_edge_insertions is called. */
1918 void
1919 insert_insn_on_edge (rtx pattern, edge e)
1921 /* We cannot insert instructions on an abnormal critical edge.
1922 It will be easier to find the culprit if we die now. */
1923 gcc_assert (!((e->flags & EDGE_ABNORMAL) && EDGE_CRITICAL_P (e)));
1925 if (e->insns.r == NULL_RTX)
1926 start_sequence ();
1927 else
1928 push_to_sequence (e->insns.r);
1930 emit_insn (pattern);
1932 e->insns.r = get_insns ();
1933 end_sequence ();
1936 /* Update the CFG for the instructions queued on edge E. */
1938 void
1939 commit_one_edge_insertion (edge e)
1941 rtx before = NULL_RTX, after = NULL_RTX, insns, tmp, last;
1942 basic_block bb;
1944 /* Pull the insns off the edge now since the edge might go away. */
1945 insns = e->insns.r;
1946 e->insns.r = NULL_RTX;
1948 /* Figure out where to put these insns. If the destination has
1949 one predecessor, insert there. Except for the exit block. */
1950 if (single_pred_p (e->dest) && e->dest != EXIT_BLOCK_PTR_FOR_FN (cfun))
1952 bb = e->dest;
1954 /* Get the location correct wrt a code label, and "nice" wrt
1955 a basic block note, and before everything else. */
1956 tmp = BB_HEAD (bb);
1957 if (LABEL_P (tmp))
1958 tmp = NEXT_INSN (tmp);
1959 if (NOTE_INSN_BASIC_BLOCK_P (tmp))
1960 tmp = NEXT_INSN (tmp);
1961 if (tmp == BB_HEAD (bb))
1962 before = tmp;
1963 else if (tmp)
1964 after = PREV_INSN (tmp);
1965 else
1966 after = get_last_insn ();
1969 /* If the source has one successor and the edge is not abnormal,
1970 insert there. Except for the entry block.
1971 Don't do this if the predecessor ends in a jump other than
1972 unconditional simple jump. E.g. for asm goto that points all
1973 its labels at the fallthru basic block, we can't insert instructions
1974 before the asm goto, as the asm goto can have various of side effects,
1975 and can't emit instructions after the asm goto, as it must end
1976 the basic block. */
1977 else if ((e->flags & EDGE_ABNORMAL) == 0
1978 && single_succ_p (e->src)
1979 && e->src != ENTRY_BLOCK_PTR_FOR_FN (cfun)
1980 && (!JUMP_P (BB_END (e->src))
1981 || simplejump_p (BB_END (e->src))))
1983 bb = e->src;
1985 /* It is possible to have a non-simple jump here. Consider a target
1986 where some forms of unconditional jumps clobber a register. This
1987 happens on the fr30 for example.
1989 We know this block has a single successor, so we can just emit
1990 the queued insns before the jump. */
1991 if (JUMP_P (BB_END (bb)))
1992 before = BB_END (bb);
1993 else
1995 /* We'd better be fallthru, or we've lost track of what's what. */
1996 gcc_assert (e->flags & EDGE_FALLTHRU);
1998 after = BB_END (bb);
2002 /* Otherwise we must split the edge. */
2003 else
2005 bb = split_edge (e);
2007 /* If E crossed a partition boundary, we needed to make bb end in
2008 a region-crossing jump, even though it was originally fallthru. */
2009 if (JUMP_P (BB_END (bb)))
2010 before = BB_END (bb);
2011 else
2012 after = BB_END (bb);
2015 /* Now that we've found the spot, do the insertion. */
2016 if (before)
2018 emit_insn_before_noloc (insns, before, bb);
2019 last = prev_nonnote_insn (before);
2021 else
2022 last = emit_insn_after_noloc (insns, after, bb);
2024 if (returnjump_p (last))
2026 /* ??? Remove all outgoing edges from BB and add one for EXIT.
2027 This is not currently a problem because this only happens
2028 for the (single) epilogue, which already has a fallthru edge
2029 to EXIT. */
2031 e = single_succ_edge (bb);
2032 gcc_assert (e->dest == EXIT_BLOCK_PTR_FOR_FN (cfun)
2033 && single_succ_p (bb) && (e->flags & EDGE_FALLTHRU));
2035 e->flags &= ~EDGE_FALLTHRU;
2036 emit_barrier_after (last);
2038 if (before)
2039 delete_insn (before);
2041 else
2042 gcc_assert (!JUMP_P (last));
2045 /* Update the CFG for all queued instructions. */
2047 void
2048 commit_edge_insertions (void)
2050 basic_block bb;
2052 /* Optimization passes that invoke this routine can cause hot blocks
2053 previously reached by both hot and cold blocks to become dominated only
2054 by cold blocks. This will cause the verification below to fail,
2055 and lead to now cold code in the hot section. In some cases this
2056 may only be visible after newly unreachable blocks are deleted,
2057 which will be done by fixup_partitions. */
2058 fixup_partitions ();
2060 #ifdef ENABLE_CHECKING
2061 verify_flow_info ();
2062 #endif
2064 FOR_BB_BETWEEN (bb, ENTRY_BLOCK_PTR_FOR_FN (cfun),
2065 EXIT_BLOCK_PTR_FOR_FN (cfun), next_bb)
2067 edge e;
2068 edge_iterator ei;
2070 FOR_EACH_EDGE (e, ei, bb->succs)
2071 if (e->insns.r)
2072 commit_one_edge_insertion (e);
2077 /* Print out RTL-specific basic block information (live information
2078 at start and end with TDF_DETAILS). FLAGS are the TDF_* masks
2079 documented in dumpfile.h. */
2081 static void
2082 rtl_dump_bb (FILE *outf, basic_block bb, int indent, int flags)
2084 rtx insn;
2085 rtx last;
2086 char *s_indent;
2088 s_indent = (char *) alloca ((size_t) indent + 1);
2089 memset (s_indent, ' ', (size_t) indent);
2090 s_indent[indent] = '\0';
2092 if (df && (flags & TDF_DETAILS))
2094 df_dump_top (bb, outf);
2095 putc ('\n', outf);
2098 if (bb->index != ENTRY_BLOCK && bb->index != EXIT_BLOCK)
2099 for (insn = BB_HEAD (bb), last = NEXT_INSN (BB_END (bb)); insn != last;
2100 insn = NEXT_INSN (insn))
2102 if (flags & TDF_DETAILS)
2103 df_dump_insn_top (insn, outf);
2104 if (! (flags & TDF_SLIM))
2105 print_rtl_single (outf, insn);
2106 else
2107 dump_insn_slim (outf, insn);
2108 if (flags & TDF_DETAILS)
2109 df_dump_insn_bottom (insn, outf);
2112 if (df && (flags & TDF_DETAILS))
2114 df_dump_bottom (bb, outf);
2115 putc ('\n', outf);
2120 /* Like dump_function_to_file, but for RTL. Print out dataflow information
2121 for the start of each basic block. FLAGS are the TDF_* masks documented
2122 in dumpfile.h. */
2124 void
2125 print_rtl_with_bb (FILE *outf, const_rtx rtx_first, int flags)
2127 const_rtx tmp_rtx;
2128 if (rtx_first == 0)
2129 fprintf (outf, "(nil)\n");
2130 else
2132 enum bb_state { NOT_IN_BB, IN_ONE_BB, IN_MULTIPLE_BB };
2133 int max_uid = get_max_uid ();
2134 basic_block *start = XCNEWVEC (basic_block, max_uid);
2135 basic_block *end = XCNEWVEC (basic_block, max_uid);
2136 enum bb_state *in_bb_p = XCNEWVEC (enum bb_state, max_uid);
2137 basic_block bb;
2139 /* After freeing the CFG, we still have BLOCK_FOR_INSN set on most
2140 insns, but the CFG is not maintained so the basic block info
2141 is not reliable. Therefore it's omitted from the dumps. */
2142 if (! (cfun->curr_properties & PROP_cfg))
2143 flags &= ~TDF_BLOCKS;
2145 if (df)
2146 df_dump_start (outf);
2148 if (flags & TDF_BLOCKS)
2150 FOR_EACH_BB_REVERSE_FN (bb, cfun)
2152 rtx x;
2154 start[INSN_UID (BB_HEAD (bb))] = bb;
2155 end[INSN_UID (BB_END (bb))] = bb;
2156 for (x = BB_HEAD (bb); x != NULL_RTX; x = NEXT_INSN (x))
2158 enum bb_state state = IN_MULTIPLE_BB;
2160 if (in_bb_p[INSN_UID (x)] == NOT_IN_BB)
2161 state = IN_ONE_BB;
2162 in_bb_p[INSN_UID (x)] = state;
2164 if (x == BB_END (bb))
2165 break;
2170 for (tmp_rtx = rtx_first; NULL != tmp_rtx; tmp_rtx = NEXT_INSN (tmp_rtx))
2172 if (flags & TDF_BLOCKS)
2174 bb = start[INSN_UID (tmp_rtx)];
2175 if (bb != NULL)
2177 dump_bb_info (outf, bb, 0, dump_flags | TDF_COMMENT, true, false);
2178 if (df && (flags & TDF_DETAILS))
2179 df_dump_top (bb, outf);
2182 if (in_bb_p[INSN_UID (tmp_rtx)] == NOT_IN_BB
2183 && !NOTE_P (tmp_rtx)
2184 && !BARRIER_P (tmp_rtx))
2185 fprintf (outf, ";; Insn is not within a basic block\n");
2186 else if (in_bb_p[INSN_UID (tmp_rtx)] == IN_MULTIPLE_BB)
2187 fprintf (outf, ";; Insn is in multiple basic blocks\n");
2190 if (flags & TDF_DETAILS)
2191 df_dump_insn_top (tmp_rtx, outf);
2192 if (! (flags & TDF_SLIM))
2193 print_rtl_single (outf, tmp_rtx);
2194 else
2195 dump_insn_slim (outf, tmp_rtx);
2196 if (flags & TDF_DETAILS)
2197 df_dump_insn_bottom (tmp_rtx, outf);
2199 if (flags & TDF_BLOCKS)
2201 bb = end[INSN_UID (tmp_rtx)];
2202 if (bb != NULL)
2204 dump_bb_info (outf, bb, 0, dump_flags | TDF_COMMENT, false, true);
2205 if (df && (flags & TDF_DETAILS))
2206 df_dump_bottom (bb, outf);
2207 putc ('\n', outf);
2212 free (start);
2213 free (end);
2214 free (in_bb_p);
2218 /* Update the branch probability of BB if a REG_BR_PROB is present. */
2220 void
2221 update_br_prob_note (basic_block bb)
2223 rtx note;
2224 if (!JUMP_P (BB_END (bb)))
2225 return;
2226 note = find_reg_note (BB_END (bb), REG_BR_PROB, NULL_RTX);
2227 if (!note || XINT (note, 0) == BRANCH_EDGE (bb)->probability)
2228 return;
2229 XINT (note, 0) = BRANCH_EDGE (bb)->probability;
2232 /* Get the last insn associated with block BB (that includes barriers and
2233 tablejumps after BB). */
2235 get_last_bb_insn (basic_block bb)
2237 rtx tmp;
2238 rtx end = BB_END (bb);
2240 /* Include any jump table following the basic block. */
2241 if (tablejump_p (end, NULL, &tmp))
2242 end = tmp;
2244 /* Include any barriers that may follow the basic block. */
2245 tmp = next_nonnote_insn_bb (end);
2246 while (tmp && BARRIER_P (tmp))
2248 end = tmp;
2249 tmp = next_nonnote_insn_bb (end);
2252 return end;
2255 /* Sanity check partition hotness to ensure that basic blocks in
2256   the cold partition don't dominate basic blocks in the hot partition.
2257 If FLAG_ONLY is true, report violations as errors. Otherwise
2258 re-mark the dominated blocks as cold, since this is run after
2259 cfg optimizations that may make hot blocks previously reached
2260 by both hot and cold blocks now only reachable along cold paths. */
2262 static vec<basic_block>
2263 find_partition_fixes (bool flag_only)
2265 basic_block bb;
2266 vec<basic_block> bbs_in_cold_partition = vNULL;
2267 vec<basic_block> bbs_to_fix = vNULL;
2269 /* Callers check this. */
2270 gcc_checking_assert (crtl->has_bb_partition);
2272 FOR_EACH_BB_FN (bb, cfun)
2273 if ((BB_PARTITION (bb) == BB_COLD_PARTITION))
2274 bbs_in_cold_partition.safe_push (bb);
2276 if (bbs_in_cold_partition.is_empty ())
2277 return vNULL;
2279 bool dom_calculated_here = !dom_info_available_p (CDI_DOMINATORS);
2281 if (dom_calculated_here)
2282 calculate_dominance_info (CDI_DOMINATORS);
2284 while (! bbs_in_cold_partition.is_empty ())
2286 bb = bbs_in_cold_partition.pop ();
2287 /* Any blocks dominated by a block in the cold section
2288 must also be cold. */
2289 basic_block son;
2290 for (son = first_dom_son (CDI_DOMINATORS, bb);
2291 son;
2292 son = next_dom_son (CDI_DOMINATORS, son))
2294 /* If son is not yet cold, then mark it cold here and
2295 enqueue it for further processing. */
2296 if ((BB_PARTITION (son) != BB_COLD_PARTITION))
2298 if (flag_only)
2299 error ("non-cold basic block %d dominated "
2300 "by a block in the cold partition (%d)", son->index, bb->index);
2301 else
2302 BB_SET_PARTITION (son, BB_COLD_PARTITION);
2303 bbs_to_fix.safe_push (son);
2304 bbs_in_cold_partition.safe_push (son);
2309 if (dom_calculated_here)
2310 free_dominance_info (CDI_DOMINATORS);
2312 return bbs_to_fix;
2315 /* Perform cleanup on the hot/cold bb partitioning after optimization
2316 passes that modify the cfg. */
2318 void
2319 fixup_partitions (void)
2321 basic_block bb;
2323 if (!crtl->has_bb_partition)
2324 return;
2326 /* Delete any blocks that became unreachable and weren't
2327 already cleaned up, for example during edge forwarding
2328 and convert_jumps_to_returns. This will expose more
2329 opportunities for fixing the partition boundaries here.
2330 Also, the calculation of the dominance graph during verification
2331 will assert if there are unreachable nodes. */
2332 delete_unreachable_blocks ();
2334 /* If there are partitions, do a sanity check on them: A basic block in
2335   a cold partition cannot dominate a basic block in a hot partition.
2336 Fixup any that now violate this requirement, as a result of edge
2337 forwarding and unreachable block deletion.  */
2338 vec<basic_block> bbs_to_fix = find_partition_fixes (false);
2340 /* Do the partition fixup after all necessary blocks have been converted to
2341 cold, so that we only update the region crossings the minimum number of
2342 places, which can require forcing edges to be non fallthru. */
2343 while (! bbs_to_fix.is_empty ())
2345 bb = bbs_to_fix.pop ();
2346 fixup_new_cold_bb (bb);
2350 /* Verify, in the basic block chain, that there is at most one switch
2351 between hot/cold partitions. This condition will not be true until
2352 after reorder_basic_blocks is called. */
2354 static int
2355 verify_hot_cold_block_grouping (void)
2357 basic_block bb;
2358 int err = 0;
2359 bool switched_sections = false;
2360 int current_partition = BB_UNPARTITIONED;
2362 /* Even after bb reordering is complete, we go into cfglayout mode
2363 again (in compgoto). Ensure we don't call this before going back
2364 into linearized RTL when any layout fixes would have been committed. */
2365 if (!crtl->bb_reorder_complete
2366 || current_ir_type () != IR_RTL_CFGRTL)
2367 return err;
2369 FOR_EACH_BB_FN (bb, cfun)
2371 if (current_partition != BB_UNPARTITIONED
2372 && BB_PARTITION (bb) != current_partition)
2374 if (switched_sections)
2376 error ("multiple hot/cold transitions found (bb %i)",
2377 bb->index);
2378 err = 1;
2380 else
2381 switched_sections = true;
2383 if (!crtl->has_bb_partition)
2384 error ("partition found but function partition flag not set");
2386 current_partition = BB_PARTITION (bb);
2389 return err;
2393 /* Perform several checks on the edges out of each block, such as
2394 the consistency of the branch probabilities, the correctness
2395 of hot/cold partition crossing edges, and the number of expected
2396 successor edges. Also verify that the dominance relationship
2397 between hot/cold blocks is sane. */
2399 static int
2400 rtl_verify_edges (void)
2402 int err = 0;
2403 basic_block bb;
2405 FOR_EACH_BB_REVERSE_FN (bb, cfun)
2407 int n_fallthru = 0, n_branch = 0, n_abnormal_call = 0, n_sibcall = 0;
2408 int n_eh = 0, n_abnormal = 0;
2409 edge e, fallthru = NULL;
2410 edge_iterator ei;
2411 rtx note;
2412 bool has_crossing_edge = false;
2414 if (JUMP_P (BB_END (bb))
2415 && (note = find_reg_note (BB_END (bb), REG_BR_PROB, NULL_RTX))
2416 && EDGE_COUNT (bb->succs) >= 2
2417 && any_condjump_p (BB_END (bb)))
2419 if (XINT (note, 0) != BRANCH_EDGE (bb)->probability
2420 && profile_status_for_fn (cfun) != PROFILE_ABSENT)
2422 error ("verify_flow_info: REG_BR_PROB does not match cfg %i %i",
2423 XINT (note, 0), BRANCH_EDGE (bb)->probability);
2424 err = 1;
2428 FOR_EACH_EDGE (e, ei, bb->succs)
2430 bool is_crossing;
2432 if (e->flags & EDGE_FALLTHRU)
2433 n_fallthru++, fallthru = e;
2435 is_crossing = (BB_PARTITION (e->src) != BB_PARTITION (e->dest)
2436 && e->src != ENTRY_BLOCK_PTR_FOR_FN (cfun)
2437 && e->dest != EXIT_BLOCK_PTR_FOR_FN (cfun));
2438 has_crossing_edge |= is_crossing;
2439 if (e->flags & EDGE_CROSSING)
2441 if (!is_crossing)
2443 error ("EDGE_CROSSING incorrectly set across same section");
2444 err = 1;
2446 if (e->flags & EDGE_FALLTHRU)
2448 error ("fallthru edge crosses section boundary in bb %i",
2449 e->src->index);
2450 err = 1;
2452 if (e->flags & EDGE_EH)
2454 error ("EH edge crosses section boundary in bb %i",
2455 e->src->index);
2456 err = 1;
2458 if (JUMP_P (BB_END (bb)) && !CROSSING_JUMP_P (BB_END (bb)))
2460 error ("No region crossing jump at section boundary in bb %i",
2461 bb->index);
2462 err = 1;
2465 else if (is_crossing)
2467 error ("EDGE_CROSSING missing across section boundary");
2468 err = 1;
2471 if ((e->flags & ~(EDGE_DFS_BACK
2472 | EDGE_CAN_FALLTHRU
2473 | EDGE_IRREDUCIBLE_LOOP
2474 | EDGE_LOOP_EXIT
2475 | EDGE_CROSSING
2476 | EDGE_PRESERVE)) == 0)
2477 n_branch++;
2479 if (e->flags & EDGE_ABNORMAL_CALL)
2480 n_abnormal_call++;
2482 if (e->flags & EDGE_SIBCALL)
2483 n_sibcall++;
2485 if (e->flags & EDGE_EH)
2486 n_eh++;
2488 if (e->flags & EDGE_ABNORMAL)
2489 n_abnormal++;
2492 if (!has_crossing_edge
2493 && JUMP_P (BB_END (bb))
2494 && CROSSING_JUMP_P (BB_END (bb)))
2496 print_rtl_with_bb (stderr, get_insns (), TDF_RTL | TDF_BLOCKS | TDF_DETAILS);
2497 error ("Region crossing jump across same section in bb %i",
2498 bb->index);
2499 err = 1;
2502 if (n_eh && !find_reg_note (BB_END (bb), REG_EH_REGION, NULL_RTX))
2504 error ("missing REG_EH_REGION note at the end of bb %i", bb->index);
2505 err = 1;
2507 if (n_eh > 1)
2509 error ("too many exception handling edges in bb %i", bb->index);
2510 err = 1;
2512 if (n_branch
2513 && (!JUMP_P (BB_END (bb))
2514 || (n_branch > 1 && (any_uncondjump_p (BB_END (bb))
2515 || any_condjump_p (BB_END (bb))))))
2517 error ("too many outgoing branch edges from bb %i", bb->index);
2518 err = 1;
2520 if (n_fallthru && any_uncondjump_p (BB_END (bb)))
2522 error ("fallthru edge after unconditional jump in bb %i", bb->index);
2523 err = 1;
2525 if (n_branch != 1 && any_uncondjump_p (BB_END (bb)))
2527 error ("wrong number of branch edges after unconditional jump"
2528 " in bb %i", bb->index);
2529 err = 1;
2531 if (n_branch != 1 && any_condjump_p (BB_END (bb))
2532 && JUMP_LABEL (BB_END (bb)) != BB_HEAD (fallthru->dest))
2534 error ("wrong amount of branch edges after conditional jump"
2535 " in bb %i", bb->index);
2536 err = 1;
2538 if (n_abnormal_call && !CALL_P (BB_END (bb)))
2540 error ("abnormal call edges for non-call insn in bb %i", bb->index);
2541 err = 1;
2543 if (n_sibcall && !CALL_P (BB_END (bb)))
2545 error ("sibcall edges for non-call insn in bb %i", bb->index);
2546 err = 1;
2548 if (n_abnormal > n_eh
2549 && !(CALL_P (BB_END (bb))
2550 && n_abnormal == n_abnormal_call + n_sibcall)
2551 && (!JUMP_P (BB_END (bb))
2552 || any_condjump_p (BB_END (bb))
2553 || any_uncondjump_p (BB_END (bb))))
2555 error ("abnormal edges for no purpose in bb %i", bb->index);
2556 err = 1;
2560 /* If there are partitions, do a sanity check on them: A basic block in
2561   a cold partition cannot dominate a basic block in a hot partition.  */
2562 if (crtl->has_bb_partition && !err)
2564 vec<basic_block> bbs_to_fix = find_partition_fixes (true);
2565 err = !bbs_to_fix.is_empty ();
2568 /* Clean up. */
2569 return err;
2572 /* Checks on the instructions within blocks. Currently checks that each
2573 block starts with a basic block note, and that basic block notes and
2574 control flow jumps are not found in the middle of the block. */
2576 static int
2577 rtl_verify_bb_insns (void)
2579 rtx x;
2580 int err = 0;
2581 basic_block bb;
2583 FOR_EACH_BB_REVERSE_FN (bb, cfun)
2585 /* Now check the header of basic
2586 block. It ought to contain optional CODE_LABEL followed
2587 by NOTE_BASIC_BLOCK. */
2588 x = BB_HEAD (bb);
2589 if (LABEL_P (x))
2591 if (BB_END (bb) == x)
2593 error ("NOTE_INSN_BASIC_BLOCK is missing for block %d",
2594 bb->index);
2595 err = 1;
2598 x = NEXT_INSN (x);
2601 if (!NOTE_INSN_BASIC_BLOCK_P (x) || NOTE_BASIC_BLOCK (x) != bb)
2603 error ("NOTE_INSN_BASIC_BLOCK is missing for block %d",
2604 bb->index);
2605 err = 1;
2608 if (BB_END (bb) == x)
2609 /* Do checks for empty blocks here. */
2611 else
2612 for (x = NEXT_INSN (x); x; x = NEXT_INSN (x))
2614 if (NOTE_INSN_BASIC_BLOCK_P (x))
2616 error ("NOTE_INSN_BASIC_BLOCK %d in middle of basic block %d",
2617 INSN_UID (x), bb->index);
2618 err = 1;
2621 if (x == BB_END (bb))
2622 break;
2624 if (control_flow_insn_p (x))
2626 error ("in basic block %d:", bb->index);
2627 fatal_insn ("flow control insn inside a basic block", x);
2632 /* Clean up. */
2633 return err;
2636 /* Verify that block pointers for instructions in basic blocks, headers and
2637 footers are set appropriately. */
2639 static int
2640 rtl_verify_bb_pointers (void)
2642 int err = 0;
2643 basic_block bb;
2645 /* Check the general integrity of the basic blocks. */
2646 FOR_EACH_BB_REVERSE_FN (bb, cfun)
2648 rtx insn;
2650 if (!(bb->flags & BB_RTL))
2652 error ("BB_RTL flag not set for block %d", bb->index);
2653 err = 1;
2656 FOR_BB_INSNS (bb, insn)
2657 if (BLOCK_FOR_INSN (insn) != bb)
2659 error ("insn %d basic block pointer is %d, should be %d",
2660 INSN_UID (insn),
2661 BLOCK_FOR_INSN (insn) ? BLOCK_FOR_INSN (insn)->index : 0,
2662 bb->index);
2663 err = 1;
2666 for (insn = BB_HEADER (bb); insn; insn = NEXT_INSN (insn))
2667 if (!BARRIER_P (insn)
2668 && BLOCK_FOR_INSN (insn) != NULL)
2670 error ("insn %d in header of bb %d has non-NULL basic block",
2671 INSN_UID (insn), bb->index);
2672 err = 1;
2674 for (insn = BB_FOOTER (bb); insn; insn = NEXT_INSN (insn))
2675 if (!BARRIER_P (insn)
2676 && BLOCK_FOR_INSN (insn) != NULL)
2678 error ("insn %d in footer of bb %d has non-NULL basic block",
2679 INSN_UID (insn), bb->index);
2680 err = 1;
2684 /* Clean up. */
2685 return err;
2688 /* Verify the CFG and RTL consistency common for both underlying RTL and
2689 cfglayout RTL.
2691 Currently it does following checks:
2693 - overlapping of basic blocks
2694 - insns with wrong BLOCK_FOR_INSN pointers
2695 - headers of basic blocks (the NOTE_INSN_BASIC_BLOCK note)
2696 - tails of basic blocks (ensure that boundary is necessary)
2697 - scans body of the basic block for JUMP_INSN, CODE_LABEL
2698 and NOTE_INSN_BASIC_BLOCK
2699 - verify that no fall_thru edge crosses hot/cold partition boundaries
2700 - verify that there are no pending RTL branch predictions
2701 - verify that hot blocks are not dominated by cold blocks
2703 In future it can be extended check a lot of other stuff as well
2704 (reachability of basic blocks, life information, etc. etc.). */
2706 static int
2707 rtl_verify_flow_info_1 (void)
2709 int err = 0;
2711 err |= rtl_verify_bb_pointers ();
2713 err |= rtl_verify_bb_insns ();
2715 err |= rtl_verify_edges ();
2717 return err;
2720 /* Walk the instruction chain and verify that bb head/end pointers
2721 are correct, and that instructions are in exactly one bb and have
2722 correct block pointers. */
2724 static int
2725 rtl_verify_bb_insn_chain (void)
2727 basic_block bb;
2728 int err = 0;
2729 rtx x;
2730 rtx last_head = get_last_insn ();
2731 basic_block *bb_info;
2732 const int max_uid = get_max_uid ();
2734 bb_info = XCNEWVEC (basic_block, max_uid);
2736 FOR_EACH_BB_REVERSE_FN (bb, cfun)
2738 rtx head = BB_HEAD (bb);
2739 rtx end = BB_END (bb);
2741 for (x = last_head; x != NULL_RTX; x = PREV_INSN (x))
2743 /* Verify the end of the basic block is in the INSN chain. */
2744 if (x == end)
2745 break;
2747 /* And that the code outside of basic blocks has NULL bb field. */
2748 if (!BARRIER_P (x)
2749 && BLOCK_FOR_INSN (x) != NULL)
2751 error ("insn %d outside of basic blocks has non-NULL bb field",
2752 INSN_UID (x));
2753 err = 1;
2757 if (!x)
2759 error ("end insn %d for block %d not found in the insn stream",
2760 INSN_UID (end), bb->index);
2761 err = 1;
2764 /* Work backwards from the end to the head of the basic block
2765 to verify the head is in the RTL chain. */
2766 for (; x != NULL_RTX; x = PREV_INSN (x))
2768 /* While walking over the insn chain, verify insns appear
2769 in only one basic block. */
2770 if (bb_info[INSN_UID (x)] != NULL)
2772 error ("insn %d is in multiple basic blocks (%d and %d)",
2773 INSN_UID (x), bb->index, bb_info[INSN_UID (x)]->index);
2774 err = 1;
2777 bb_info[INSN_UID (x)] = bb;
2779 if (x == head)
2780 break;
2782 if (!x)
2784 error ("head insn %d for block %d not found in the insn stream",
2785 INSN_UID (head), bb->index);
2786 err = 1;
2789 last_head = PREV_INSN (x);
2792 for (x = last_head; x != NULL_RTX; x = PREV_INSN (x))
2794 /* Check that the code before the first basic block has NULL
2795 bb field. */
2796 if (!BARRIER_P (x)
2797 && BLOCK_FOR_INSN (x) != NULL)
2799 error ("insn %d outside of basic blocks has non-NULL bb field",
2800 INSN_UID (x));
2801 err = 1;
2804 free (bb_info);
2806 return err;
2809 /* Verify that fallthru edges point to adjacent blocks in layout order and
2810 that barriers exist after non-fallthru blocks. */
2812 static int
2813 rtl_verify_fallthru (void)
2815 basic_block bb;
2816 int err = 0;
2818 FOR_EACH_BB_REVERSE_FN (bb, cfun)
2820 edge e;
2822 e = find_fallthru_edge (bb->succs);
2823 if (!e)
2825 rtx insn;
2827 /* Ensure existence of barrier in BB with no fallthru edges. */
2828 for (insn = NEXT_INSN (BB_END (bb)); ; insn = NEXT_INSN (insn))
2830 if (!insn || NOTE_INSN_BASIC_BLOCK_P (insn))
2832 error ("missing barrier after block %i", bb->index);
2833 err = 1;
2834 break;
2836 if (BARRIER_P (insn))
2837 break;
2840 else if (e->src != ENTRY_BLOCK_PTR_FOR_FN (cfun)
2841 && e->dest != EXIT_BLOCK_PTR_FOR_FN (cfun))
2843 rtx insn;
2845 if (e->src->next_bb != e->dest)
2847 error
2848 ("verify_flow_info: Incorrect blocks for fallthru %i->%i",
2849 e->src->index, e->dest->index);
2850 err = 1;
2852 else
2853 for (insn = NEXT_INSN (BB_END (e->src)); insn != BB_HEAD (e->dest);
2854 insn = NEXT_INSN (insn))
2855 if (BARRIER_P (insn) || INSN_P (insn))
2857 error ("verify_flow_info: Incorrect fallthru %i->%i",
2858 e->src->index, e->dest->index);
2859 fatal_insn ("wrong insn in the fallthru edge", insn);
2860 err = 1;
2865 return err;
2868 /* Verify that blocks are laid out in consecutive order. While walking the
2869 instructions, verify that all expected instructions are inside the basic
2870 blocks, and that all returns are followed by barriers. */
2872 static int
2873 rtl_verify_bb_layout (void)
2875 basic_block bb;
2876 int err = 0;
2877 rtx x;
2878 int num_bb_notes;
2879 const rtx rtx_first = get_insns ();
2880 basic_block last_bb_seen = ENTRY_BLOCK_PTR_FOR_FN (cfun), curr_bb = NULL;
2882 num_bb_notes = 0;
2883 last_bb_seen = ENTRY_BLOCK_PTR_FOR_FN (cfun);
2885 for (x = rtx_first; x; x = NEXT_INSN (x))
2887 if (NOTE_INSN_BASIC_BLOCK_P (x))
2889 bb = NOTE_BASIC_BLOCK (x);
2891 num_bb_notes++;
2892 if (bb != last_bb_seen->next_bb)
2893 internal_error ("basic blocks not laid down consecutively");
2895 curr_bb = last_bb_seen = bb;
2898 if (!curr_bb)
2900 switch (GET_CODE (x))
2902 case BARRIER:
2903 case NOTE:
2904 break;
2906 case CODE_LABEL:
2907 /* An ADDR_VEC is placed outside any basic block. */
2908 if (NEXT_INSN (x)
2909 && JUMP_TABLE_DATA_P (NEXT_INSN (x)))
2910 x = NEXT_INSN (x);
2912 /* But in any case, non-deletable labels can appear anywhere. */
2913 break;
2915 default:
2916 fatal_insn ("insn outside basic block", x);
2920 if (JUMP_P (x)
2921 && returnjump_p (x) && ! condjump_p (x)
2922 && ! (next_nonnote_insn (x) && BARRIER_P (next_nonnote_insn (x))))
2923 fatal_insn ("return not followed by barrier", x);
2925 if (curr_bb && x == BB_END (curr_bb))
2926 curr_bb = NULL;
2929 if (num_bb_notes != n_basic_blocks_for_fn (cfun) - NUM_FIXED_BLOCKS)
2930 internal_error
2931 ("number of bb notes in insn chain (%d) != n_basic_blocks (%d)",
2932 num_bb_notes, n_basic_blocks_for_fn (cfun));
2934 return err;
2937 /* Verify the CFG and RTL consistency common for both underlying RTL and
2938 cfglayout RTL, plus consistency checks specific to linearized RTL mode.
2940 Currently it does following checks:
2941 - all checks of rtl_verify_flow_info_1
2942 - test head/end pointers
2943 - check that blocks are laid out in consecutive order
2944 - check that all insns are in the basic blocks
2945 (except the switch handling code, barriers and notes)
2946 - check that all returns are followed by barriers
2947 - check that all fallthru edge points to the adjacent blocks
2948 - verify that there is a single hot/cold partition boundary after bbro */
2950 static int
2951 rtl_verify_flow_info (void)
2953 int err = 0;
2955 err |= rtl_verify_flow_info_1 ();
2957 err |= rtl_verify_bb_insn_chain ();
2959 err |= rtl_verify_fallthru ();
2961 err |= rtl_verify_bb_layout ();
2963 err |= verify_hot_cold_block_grouping ();
2965 return err;
2968 /* Assume that the preceding pass has possibly eliminated jump instructions
2969 or converted the unconditional jumps. Eliminate the edges from CFG.
2970 Return true if any edges are eliminated. */
2972 bool
2973 purge_dead_edges (basic_block bb)
2975 edge e;
2976 rtx insn = BB_END (bb), note;
2977 bool purged = false;
2978 bool found;
2979 edge_iterator ei;
2981 if (DEBUG_INSN_P (insn) && insn != BB_HEAD (bb))
2983 insn = PREV_INSN (insn);
2984 while ((DEBUG_INSN_P (insn) || NOTE_P (insn)) && insn != BB_HEAD (bb));
2986 /* If this instruction cannot trap, remove REG_EH_REGION notes. */
2987 if (NONJUMP_INSN_P (insn)
2988 && (note = find_reg_note (insn, REG_EH_REGION, NULL)))
2990 rtx eqnote;
2992 if (! may_trap_p (PATTERN (insn))
2993 || ((eqnote = find_reg_equal_equiv_note (insn))
2994 && ! may_trap_p (XEXP (eqnote, 0))))
2995 remove_note (insn, note);
2998 /* Cleanup abnormal edges caused by exceptions or non-local gotos. */
2999 for (ei = ei_start (bb->succs); (e = ei_safe_edge (ei)); )
3001 bool remove = false;
3003 /* There are three types of edges we need to handle correctly here: EH
3004 edges, abnormal call EH edges, and abnormal call non-EH edges. The
3005 latter can appear when nonlocal gotos are used. */
3006 if (e->flags & EDGE_ABNORMAL_CALL)
3008 if (!CALL_P (insn))
3009 remove = true;
3010 else if (can_nonlocal_goto (insn))
3012 else if ((e->flags & EDGE_EH) && can_throw_internal (insn))
3014 else if (flag_tm && find_reg_note (insn, REG_TM, NULL))
3016 else
3017 remove = true;
3019 else if (e->flags & EDGE_EH)
3020 remove = !can_throw_internal (insn);
3022 if (remove)
3024 remove_edge (e);
3025 df_set_bb_dirty (bb);
3026 purged = true;
3028 else
3029 ei_next (&ei);
3032 if (JUMP_P (insn))
3034 rtx note;
3035 edge b,f;
3036 edge_iterator ei;
3038 /* We do care only about conditional jumps and simplejumps. */
3039 if (!any_condjump_p (insn)
3040 && !returnjump_p (insn)
3041 && !simplejump_p (insn))
3042 return purged;
3044 /* Branch probability/prediction notes are defined only for
3045 condjumps. We've possibly turned condjump into simplejump. */
3046 if (simplejump_p (insn))
3048 note = find_reg_note (insn, REG_BR_PROB, NULL);
3049 if (note)
3050 remove_note (insn, note);
3051 while ((note = find_reg_note (insn, REG_BR_PRED, NULL)))
3052 remove_note (insn, note);
3055 for (ei = ei_start (bb->succs); (e = ei_safe_edge (ei)); )
3057 /* Avoid abnormal flags to leak from computed jumps turned
3058 into simplejumps. */
3060 e->flags &= ~EDGE_ABNORMAL;
3062 /* See if this edge is one we should keep. */
3063 if ((e->flags & EDGE_FALLTHRU) && any_condjump_p (insn))
3064 /* A conditional jump can fall through into the next
3065 block, so we should keep the edge. */
3067 ei_next (&ei);
3068 continue;
3070 else if (e->dest != EXIT_BLOCK_PTR_FOR_FN (cfun)
3071 && BB_HEAD (e->dest) == JUMP_LABEL (insn))
3072 /* If the destination block is the target of the jump,
3073 keep the edge. */
3075 ei_next (&ei);
3076 continue;
3078 else if (e->dest == EXIT_BLOCK_PTR_FOR_FN (cfun)
3079 && returnjump_p (insn))
3080 /* If the destination block is the exit block, and this
3081 instruction is a return, then keep the edge. */
3083 ei_next (&ei);
3084 continue;
3086 else if ((e->flags & EDGE_EH) && can_throw_internal (insn))
3087 /* Keep the edges that correspond to exceptions thrown by
3088 this instruction and rematerialize the EDGE_ABNORMAL
3089 flag we just cleared above. */
3091 e->flags |= EDGE_ABNORMAL;
3092 ei_next (&ei);
3093 continue;
3096 /* We do not need this edge. */
3097 df_set_bb_dirty (bb);
3098 purged = true;
3099 remove_edge (e);
3102 if (EDGE_COUNT (bb->succs) == 0 || !purged)
3103 return purged;
3105 if (dump_file)
3106 fprintf (dump_file, "Purged edges from bb %i\n", bb->index);
3108 if (!optimize)
3109 return purged;
3111 /* Redistribute probabilities. */
3112 if (single_succ_p (bb))
3114 single_succ_edge (bb)->probability = REG_BR_PROB_BASE;
3115 single_succ_edge (bb)->count = bb->count;
3117 else
3119 note = find_reg_note (insn, REG_BR_PROB, NULL);
3120 if (!note)
3121 return purged;
3123 b = BRANCH_EDGE (bb);
3124 f = FALLTHRU_EDGE (bb);
3125 b->probability = XINT (note, 0);
3126 f->probability = REG_BR_PROB_BASE - b->probability;
3127 /* Update these to use GCOV_COMPUTE_SCALE. */
3128 b->count = bb->count * b->probability / REG_BR_PROB_BASE;
3129 f->count = bb->count * f->probability / REG_BR_PROB_BASE;
3132 return purged;
3134 else if (CALL_P (insn) && SIBLING_CALL_P (insn))
3136 /* First, there should not be any EH or ABCALL edges resulting
3137 from non-local gotos and the like. If there were, we shouldn't
3138 have created the sibcall in the first place. Second, there
3139 should of course never have been a fallthru edge. */
3140 gcc_assert (single_succ_p (bb));
3141 gcc_assert (single_succ_edge (bb)->flags
3142 == (EDGE_SIBCALL | EDGE_ABNORMAL));
3144 return 0;
3147 /* If we don't see a jump insn, we don't know exactly why the block would
3148 have been broken at this point. Look for a simple, non-fallthru edge,
3149 as these are only created by conditional branches. If we find such an
3150 edge we know that there used to be a jump here and can then safely
3151 remove all non-fallthru edges. */
3152 found = false;
3153 FOR_EACH_EDGE (e, ei, bb->succs)
3154 if (! (e->flags & (EDGE_COMPLEX | EDGE_FALLTHRU)))
3156 found = true;
3157 break;
3160 if (!found)
3161 return purged;
3163 /* Remove all but the fake and fallthru edges. The fake edge may be
3164 the only successor for this block in the case of noreturn
3165 calls. */
3166 for (ei = ei_start (bb->succs); (e = ei_safe_edge (ei)); )
3168 if (!(e->flags & (EDGE_FALLTHRU | EDGE_FAKE)))
3170 df_set_bb_dirty (bb);
3171 remove_edge (e);
3172 purged = true;
3174 else
3175 ei_next (&ei);
3178 gcc_assert (single_succ_p (bb));
3180 single_succ_edge (bb)->probability = REG_BR_PROB_BASE;
3181 single_succ_edge (bb)->count = bb->count;
3183 if (dump_file)
3184 fprintf (dump_file, "Purged non-fallthru edges from bb %i\n",
3185 bb->index);
3186 return purged;
3189 /* Search all basic blocks for potentially dead edges and purge them. Return
3190 true if some edge has been eliminated. */
3192 bool
3193 purge_all_dead_edges (void)
3195 int purged = false;
3196 basic_block bb;
3198 FOR_EACH_BB_FN (bb, cfun)
3200 bool purged_here = purge_dead_edges (bb);
3202 purged |= purged_here;
3205 return purged;
3208 /* This is used by a few passes that emit some instructions after abnormal
3209 calls, moving the basic block's end, while they in fact do want to emit
3210 them on the fallthru edge. Look for abnormal call edges, find backward
3211 the call in the block and insert the instructions on the edge instead.
3213 Similarly, handle instructions throwing exceptions internally.
3215 Return true when instructions have been found and inserted on edges. */
3217 bool
3218 fixup_abnormal_edges (void)
3220 bool inserted = false;
3221 basic_block bb;
3223 FOR_EACH_BB_FN (bb, cfun)
3225 edge e;
3226 edge_iterator ei;
3228 /* Look for cases we are interested in - calls or instructions causing
3229 exceptions. */
3230 FOR_EACH_EDGE (e, ei, bb->succs)
3231 if ((e->flags & EDGE_ABNORMAL_CALL)
3232 || ((e->flags & (EDGE_ABNORMAL | EDGE_EH))
3233 == (EDGE_ABNORMAL | EDGE_EH)))
3234 break;
3236 if (e && !CALL_P (BB_END (bb)) && !can_throw_internal (BB_END (bb)))
3238 rtx insn;
3240 /* Get past the new insns generated. Allow notes, as the insns
3241 may be already deleted. */
3242 insn = BB_END (bb);
3243 while ((NONJUMP_INSN_P (insn) || NOTE_P (insn))
3244 && !can_throw_internal (insn)
3245 && insn != BB_HEAD (bb))
3246 insn = PREV_INSN (insn);
3248 if (CALL_P (insn) || can_throw_internal (insn))
3250 rtx stop, next;
3252 e = find_fallthru_edge (bb->succs);
3254 stop = NEXT_INSN (BB_END (bb));
3255 BB_END (bb) = insn;
3257 for (insn = NEXT_INSN (insn); insn != stop; insn = next)
3259 next = NEXT_INSN (insn);
3260 if (INSN_P (insn))
3262 delete_insn (insn);
3264 /* Sometimes there's still the return value USE.
3265 If it's placed after a trapping call (i.e. that
3266 call is the last insn anyway), we have no fallthru
3267 edge. Simply delete this use and don't try to insert
3268 on the non-existent edge. */
3269 if (GET_CODE (PATTERN (insn)) != USE)
3271 /* We're not deleting it, we're moving it. */
3272 INSN_DELETED_P (insn) = 0;
3273 PREV_INSN (insn) = NULL_RTX;
3274 NEXT_INSN (insn) = NULL_RTX;
3276 insert_insn_on_edge (insn, e);
3277 inserted = true;
3280 else if (!BARRIER_P (insn))
3281 set_block_for_insn (insn, NULL);
3285 /* It may be that we don't find any trapping insn. In this
3286 case we discovered quite late that the insn that had been
3287 marked as can_throw_internal in fact couldn't trap at all.
3288 So we should in fact delete the EH edges out of the block. */
3289 else
3290 purge_dead_edges (bb);
3294 return inserted;
3297 /* Cut the insns from FIRST to LAST out of the insns stream. */
3300 unlink_insn_chain (rtx first, rtx last)
3302 rtx prevfirst = PREV_INSN (first);
3303 rtx nextlast = NEXT_INSN (last);
3305 PREV_INSN (first) = NULL;
3306 NEXT_INSN (last) = NULL;
3307 if (prevfirst)
3308 NEXT_INSN (prevfirst) = nextlast;
3309 if (nextlast)
3310 PREV_INSN (nextlast) = prevfirst;
3311 else
3312 set_last_insn (prevfirst);
3313 if (!prevfirst)
3314 set_first_insn (nextlast);
3315 return first;
3318 /* Skip over inter-block insns occurring after BB which are typically
3319 associated with BB (e.g., barriers). If there are any such insns,
3320 we return the last one. Otherwise, we return the end of BB. */
3322 static rtx
3323 skip_insns_after_block (basic_block bb)
3325 rtx insn, last_insn, next_head, prev;
3327 next_head = NULL_RTX;
3328 if (bb->next_bb != EXIT_BLOCK_PTR_FOR_FN (cfun))
3329 next_head = BB_HEAD (bb->next_bb);
3331 for (last_insn = insn = BB_END (bb); (insn = NEXT_INSN (insn)) != 0; )
3333 if (insn == next_head)
3334 break;
3336 switch (GET_CODE (insn))
3338 case BARRIER:
3339 last_insn = insn;
3340 continue;
3342 case NOTE:
3343 switch (NOTE_KIND (insn))
3345 case NOTE_INSN_BLOCK_END:
3346 gcc_unreachable ();
3347 continue;
3348 default:
3349 continue;
3350 break;
3352 break;
3354 case CODE_LABEL:
3355 if (NEXT_INSN (insn)
3356 && JUMP_TABLE_DATA_P (NEXT_INSN (insn)))
3358 insn = NEXT_INSN (insn);
3359 last_insn = insn;
3360 continue;
3362 break;
3364 default:
3365 break;
3368 break;
3371 /* It is possible to hit contradictory sequence. For instance:
3373 jump_insn
3374 NOTE_INSN_BLOCK_BEG
3375 barrier
3377 Where barrier belongs to jump_insn, but the note does not. This can be
3378 created by removing the basic block originally following
3379 NOTE_INSN_BLOCK_BEG. In such case reorder the notes. */
3381 for (insn = last_insn; insn != BB_END (bb); insn = prev)
3383 prev = PREV_INSN (insn);
3384 if (NOTE_P (insn))
3385 switch (NOTE_KIND (insn))
3387 case NOTE_INSN_BLOCK_END:
3388 gcc_unreachable ();
3389 break;
3390 case NOTE_INSN_DELETED:
3391 case NOTE_INSN_DELETED_LABEL:
3392 case NOTE_INSN_DELETED_DEBUG_LABEL:
3393 continue;
3394 default:
3395 reorder_insns (insn, insn, last_insn);
3399 return last_insn;
3402 /* Locate or create a label for a given basic block. */
3404 static rtx
3405 label_for_bb (basic_block bb)
3407 rtx label = BB_HEAD (bb);
3409 if (!LABEL_P (label))
3411 if (dump_file)
3412 fprintf (dump_file, "Emitting label for block %d\n", bb->index);
3414 label = block_label (bb);
3417 return label;
3420 /* Locate the effective beginning and end of the insn chain for each
3421 block, as defined by skip_insns_after_block above. */
3423 static void
3424 record_effective_endpoints (void)
3426 rtx next_insn;
3427 basic_block bb;
3428 rtx insn;
3430 for (insn = get_insns ();
3431 insn
3432 && NOTE_P (insn)
3433 && NOTE_KIND (insn) != NOTE_INSN_BASIC_BLOCK;
3434 insn = NEXT_INSN (insn))
3435 continue;
3436 /* No basic blocks at all? */
3437 gcc_assert (insn);
3439 if (PREV_INSN (insn))
3440 cfg_layout_function_header =
3441 unlink_insn_chain (get_insns (), PREV_INSN (insn));
3442 else
3443 cfg_layout_function_header = NULL_RTX;
3445 next_insn = get_insns ();
3446 FOR_EACH_BB_FN (bb, cfun)
3448 rtx end;
3450 if (PREV_INSN (BB_HEAD (bb)) && next_insn != BB_HEAD (bb))
3451 BB_HEADER (bb) = unlink_insn_chain (next_insn,
3452 PREV_INSN (BB_HEAD (bb)));
3453 end = skip_insns_after_block (bb);
3454 if (NEXT_INSN (BB_END (bb)) && BB_END (bb) != end)
3455 BB_FOOTER (bb) = unlink_insn_chain (NEXT_INSN (BB_END (bb)), end);
3456 next_insn = NEXT_INSN (BB_END (bb));
3459 cfg_layout_function_footer = next_insn;
3460 if (cfg_layout_function_footer)
3461 cfg_layout_function_footer = unlink_insn_chain (cfg_layout_function_footer, get_last_insn ());
3464 namespace {
3466 const pass_data pass_data_into_cfg_layout_mode =
3468 RTL_PASS, /* type */
3469 "into_cfglayout", /* name */
3470 OPTGROUP_NONE, /* optinfo_flags */
3471 TV_CFG, /* tv_id */
3472 0, /* properties_required */
3473 PROP_cfglayout, /* properties_provided */
3474 0, /* properties_destroyed */
3475 0, /* todo_flags_start */
3476 0, /* todo_flags_finish */
3479 class pass_into_cfg_layout_mode : public rtl_opt_pass
3481 public:
3482 pass_into_cfg_layout_mode (gcc::context *ctxt)
3483 : rtl_opt_pass (pass_data_into_cfg_layout_mode, ctxt)
3486 /* opt_pass methods: */
3487 virtual unsigned int execute (function *)
3489 cfg_layout_initialize (0);
3490 return 0;
3493 }; // class pass_into_cfg_layout_mode
3495 } // anon namespace
3497 rtl_opt_pass *
3498 make_pass_into_cfg_layout_mode (gcc::context *ctxt)
3500 return new pass_into_cfg_layout_mode (ctxt);
3503 namespace {
3505 const pass_data pass_data_outof_cfg_layout_mode =
3507 RTL_PASS, /* type */
3508 "outof_cfglayout", /* name */
3509 OPTGROUP_NONE, /* optinfo_flags */
3510 TV_CFG, /* tv_id */
3511 0, /* properties_required */
3512 0, /* properties_provided */
3513 PROP_cfglayout, /* properties_destroyed */
3514 0, /* todo_flags_start */
3515 0, /* todo_flags_finish */
3518 class pass_outof_cfg_layout_mode : public rtl_opt_pass
3520 public:
3521 pass_outof_cfg_layout_mode (gcc::context *ctxt)
3522 : rtl_opt_pass (pass_data_outof_cfg_layout_mode, ctxt)
3525 /* opt_pass methods: */
3526 virtual unsigned int execute (function *);
3528 }; // class pass_outof_cfg_layout_mode
3530 unsigned int
3531 pass_outof_cfg_layout_mode::execute (function *fun)
3533 basic_block bb;
3535 FOR_EACH_BB_FN (bb, fun)
3536 if (bb->next_bb != EXIT_BLOCK_PTR_FOR_FN (fun))
3537 bb->aux = bb->next_bb;
3539 cfg_layout_finalize ();
3541 return 0;
3544 } // anon namespace
3546 rtl_opt_pass *
3547 make_pass_outof_cfg_layout_mode (gcc::context *ctxt)
3549 return new pass_outof_cfg_layout_mode (ctxt);
3553 /* Link the basic blocks in the correct order, compacting the basic
3554 block queue while at it. If STAY_IN_CFGLAYOUT_MODE is false, this
3555 function also clears the basic block header and footer fields.
3557 This function is usually called after a pass (e.g. tracer) finishes
3558 some transformations while in cfglayout mode. The required sequence
3559 of the basic blocks is in a linked list along the bb->aux field.
3560 This functions re-links the basic block prev_bb and next_bb pointers
3561 accordingly, and it compacts and renumbers the blocks.
3563 FIXME: This currently works only for RTL, but the only RTL-specific
3564 bits are the STAY_IN_CFGLAYOUT_MODE bits. The tracer pass was moved
3565 to GIMPLE a long time ago, but it doesn't relink the basic block
3566 chain. It could do that (to give better initial RTL) if this function
3567 is made IR-agnostic (and moved to cfganal.c or cfg.c while at it). */
3569 void
3570 relink_block_chain (bool stay_in_cfglayout_mode)
3572 basic_block bb, prev_bb;
3573 int index;
3575 /* Maybe dump the re-ordered sequence. */
3576 if (dump_file)
3578 fprintf (dump_file, "Reordered sequence:\n");
3579 for (bb = ENTRY_BLOCK_PTR_FOR_FN (cfun)->next_bb, index =
3580 NUM_FIXED_BLOCKS;
3582 bb = (basic_block) bb->aux, index++)
3584 fprintf (dump_file, " %i ", index);
3585 if (get_bb_original (bb))
3586 fprintf (dump_file, "duplicate of %i ",
3587 get_bb_original (bb)->index);
3588 else if (forwarder_block_p (bb)
3589 && !LABEL_P (BB_HEAD (bb)))
3590 fprintf (dump_file, "compensation ");
3591 else
3592 fprintf (dump_file, "bb %i ", bb->index);
3593 fprintf (dump_file, " [%i]\n", bb->frequency);
3597 /* Now reorder the blocks. */
3598 prev_bb = ENTRY_BLOCK_PTR_FOR_FN (cfun);
3599 bb = ENTRY_BLOCK_PTR_FOR_FN (cfun)->next_bb;
3600 for (; bb; prev_bb = bb, bb = (basic_block) bb->aux)
3602 bb->prev_bb = prev_bb;
3603 prev_bb->next_bb = bb;
3605 prev_bb->next_bb = EXIT_BLOCK_PTR_FOR_FN (cfun);
3606 EXIT_BLOCK_PTR_FOR_FN (cfun)->prev_bb = prev_bb;
3608 /* Then, clean up the aux fields. */
3609 FOR_ALL_BB_FN (bb, cfun)
3611 bb->aux = NULL;
3612 if (!stay_in_cfglayout_mode)
3613 BB_HEADER (bb) = BB_FOOTER (bb) = NULL;
3616 /* Maybe reset the original copy tables, they are not valid anymore
3617 when we renumber the basic blocks in compact_blocks. If we are
3618 are going out of cfglayout mode, don't re-allocate the tables. */
3619 free_original_copy_tables ();
3620 if (stay_in_cfglayout_mode)
3621 initialize_original_copy_tables ();
3623 /* Finally, put basic_block_info in the new order. */
3624 compact_blocks ();
3628 /* Given a reorder chain, rearrange the code to match. */
3630 static void
3631 fixup_reorder_chain (void)
3633 basic_block bb;
3634 rtx insn = NULL;
3636 if (cfg_layout_function_header)
3638 set_first_insn (cfg_layout_function_header);
3639 insn = cfg_layout_function_header;
3640 while (NEXT_INSN (insn))
3641 insn = NEXT_INSN (insn);
3644 /* First do the bulk reordering -- rechain the blocks without regard to
3645 the needed changes to jumps and labels. */
3647 for (bb = ENTRY_BLOCK_PTR_FOR_FN (cfun)->next_bb; bb; bb = (basic_block)
3648 bb->aux)
3650 if (BB_HEADER (bb))
3652 if (insn)
3653 NEXT_INSN (insn) = BB_HEADER (bb);
3654 else
3655 set_first_insn (BB_HEADER (bb));
3656 PREV_INSN (BB_HEADER (bb)) = insn;
3657 insn = BB_HEADER (bb);
3658 while (NEXT_INSN (insn))
3659 insn = NEXT_INSN (insn);
3661 if (insn)
3662 NEXT_INSN (insn) = BB_HEAD (bb);
3663 else
3664 set_first_insn (BB_HEAD (bb));
3665 PREV_INSN (BB_HEAD (bb)) = insn;
3666 insn = BB_END (bb);
3667 if (BB_FOOTER (bb))
3669 NEXT_INSN (insn) = BB_FOOTER (bb);
3670 PREV_INSN (BB_FOOTER (bb)) = insn;
3671 while (NEXT_INSN (insn))
3672 insn = NEXT_INSN (insn);
3676 NEXT_INSN (insn) = cfg_layout_function_footer;
3677 if (cfg_layout_function_footer)
3678 PREV_INSN (cfg_layout_function_footer) = insn;
3680 while (NEXT_INSN (insn))
3681 insn = NEXT_INSN (insn);
3683 set_last_insn (insn);
3684 #ifdef ENABLE_CHECKING
3685 verify_insn_chain ();
3686 #endif
3688 /* Now add jumps and labels as needed to match the blocks new
3689 outgoing edges. */
3691 for (bb = ENTRY_BLOCK_PTR_FOR_FN (cfun)->next_bb; bb ; bb = (basic_block)
3692 bb->aux)
3694 edge e_fall, e_taken, e;
3695 rtx bb_end_insn;
3696 rtx ret_label = NULL_RTX;
3697 basic_block nb;
3698 edge_iterator ei;
3700 if (EDGE_COUNT (bb->succs) == 0)
3701 continue;
3703 /* Find the old fallthru edge, and another non-EH edge for
3704 a taken jump. */
3705 e_taken = e_fall = NULL;
3707 FOR_EACH_EDGE (e, ei, bb->succs)
3708 if (e->flags & EDGE_FALLTHRU)
3709 e_fall = e;
3710 else if (! (e->flags & EDGE_EH))
3711 e_taken = e;
3713 bb_end_insn = BB_END (bb);
3714 if (JUMP_P (bb_end_insn))
3716 ret_label = JUMP_LABEL (bb_end_insn);
3717 if (any_condjump_p (bb_end_insn))
3719 /* This might happen if the conditional jump has side
3720 effects and could therefore not be optimized away.
3721 Make the basic block to end with a barrier in order
3722 to prevent rtl_verify_flow_info from complaining. */
3723 if (!e_fall)
3725 gcc_assert (!onlyjump_p (bb_end_insn)
3726 || returnjump_p (bb_end_insn)
3727 || (e_taken->flags & EDGE_CROSSING));
3728 emit_barrier_after (bb_end_insn);
3729 continue;
3732 /* If the old fallthru is still next, nothing to do. */
3733 if (bb->aux == e_fall->dest
3734 || e_fall->dest == EXIT_BLOCK_PTR_FOR_FN (cfun))
3735 continue;
3737 /* The degenerated case of conditional jump jumping to the next
3738 instruction can happen for jumps with side effects. We need
3739 to construct a forwarder block and this will be done just
3740 fine by force_nonfallthru below. */
3741 if (!e_taken)
3744 /* There is another special case: if *neither* block is next,
3745 such as happens at the very end of a function, then we'll
3746 need to add a new unconditional jump. Choose the taken
3747 edge based on known or assumed probability. */
3748 else if (bb->aux != e_taken->dest)
3750 rtx note = find_reg_note (bb_end_insn, REG_BR_PROB, 0);
3752 if (note
3753 && XINT (note, 0) < REG_BR_PROB_BASE / 2
3754 && invert_jump (bb_end_insn,
3755 (e_fall->dest
3756 == EXIT_BLOCK_PTR_FOR_FN (cfun)
3757 ? NULL_RTX
3758 : label_for_bb (e_fall->dest)), 0))
3760 e_fall->flags &= ~EDGE_FALLTHRU;
3761 gcc_checking_assert (could_fall_through
3762 (e_taken->src, e_taken->dest));
3763 e_taken->flags |= EDGE_FALLTHRU;
3764 update_br_prob_note (bb);
3765 e = e_fall, e_fall = e_taken, e_taken = e;
3769 /* If the "jumping" edge is a crossing edge, and the fall
3770 through edge is non-crossing, leave things as they are. */
3771 else if ((e_taken->flags & EDGE_CROSSING)
3772 && !(e_fall->flags & EDGE_CROSSING))
3773 continue;
3775 /* Otherwise we can try to invert the jump. This will
3776 basically never fail, however, keep up the pretense. */
3777 else if (invert_jump (bb_end_insn,
3778 (e_fall->dest
3779 == EXIT_BLOCK_PTR_FOR_FN (cfun)
3780 ? NULL_RTX
3781 : label_for_bb (e_fall->dest)), 0))
3783 e_fall->flags &= ~EDGE_FALLTHRU;
3784 gcc_checking_assert (could_fall_through
3785 (e_taken->src, e_taken->dest));
3786 e_taken->flags |= EDGE_FALLTHRU;
3787 update_br_prob_note (bb);
3788 if (LABEL_NUSES (ret_label) == 0
3789 && single_pred_p (e_taken->dest))
3790 delete_insn (ret_label);
3791 continue;
3794 else if (extract_asm_operands (PATTERN (bb_end_insn)) != NULL)
3796 /* If the old fallthru is still next or if
3797 asm goto doesn't have a fallthru (e.g. when followed by
3798 __builtin_unreachable ()), nothing to do. */
3799 if (! e_fall
3800 || bb->aux == e_fall->dest
3801 || e_fall->dest == EXIT_BLOCK_PTR_FOR_FN (cfun))
3802 continue;
3804 /* Otherwise we'll have to use the fallthru fixup below. */
3806 else
3808 /* Otherwise we have some return, switch or computed
3809 jump. In the 99% case, there should not have been a
3810 fallthru edge. */
3811 gcc_assert (returnjump_p (bb_end_insn) || !e_fall);
3812 continue;
3815 else
3817 /* No fallthru implies a noreturn function with EH edges, or
3818 something similarly bizarre. In any case, we don't need to
3819 do anything. */
3820 if (! e_fall)
3821 continue;
3823 /* If the fallthru block is still next, nothing to do. */
3824 if (bb->aux == e_fall->dest)
3825 continue;
3827 /* A fallthru to exit block. */
3828 if (e_fall->dest == EXIT_BLOCK_PTR_FOR_FN (cfun))
3829 continue;
3832 /* We got here if we need to add a new jump insn.
3833 Note force_nonfallthru can delete E_FALL and thus we have to
3834 save E_FALL->src prior to the call to force_nonfallthru. */
3835 nb = force_nonfallthru_and_redirect (e_fall, e_fall->dest, ret_label);
3836 if (nb)
3838 nb->aux = bb->aux;
3839 bb->aux = nb;
3840 /* Don't process this new block. */
3841 bb = nb;
3845 relink_block_chain (/*stay_in_cfglayout_mode=*/false);
3847 /* Annoying special case - jump around dead jumptables left in the code. */
3848 FOR_EACH_BB_FN (bb, cfun)
3850 edge e = find_fallthru_edge (bb->succs);
3852 if (e && !can_fallthru (e->src, e->dest))
3853 force_nonfallthru (e);
3856 /* Ensure goto_locus from edges has some instructions with that locus
3857 in RTL. */
3858 if (!optimize)
3859 FOR_EACH_BB_FN (bb, cfun)
3861 edge e;
3862 edge_iterator ei;
3864 FOR_EACH_EDGE (e, ei, bb->succs)
3865 if (LOCATION_LOCUS (e->goto_locus) != UNKNOWN_LOCATION
3866 && !(e->flags & EDGE_ABNORMAL))
3868 edge e2;
3869 edge_iterator ei2;
3870 basic_block dest, nb;
3871 rtx end;
3873 insn = BB_END (e->src);
3874 end = PREV_INSN (BB_HEAD (e->src));
3875 while (insn != end
3876 && (!NONDEBUG_INSN_P (insn) || !INSN_HAS_LOCATION (insn)))
3877 insn = PREV_INSN (insn);
3878 if (insn != end
3879 && INSN_LOCATION (insn) == e->goto_locus)
3880 continue;
3881 if (simplejump_p (BB_END (e->src))
3882 && !INSN_HAS_LOCATION (BB_END (e->src)))
3884 INSN_LOCATION (BB_END (e->src)) = e->goto_locus;
3885 continue;
3887 dest = e->dest;
3888 if (dest == EXIT_BLOCK_PTR_FOR_FN (cfun))
3890 /* Non-fallthru edges to the exit block cannot be split. */
3891 if (!(e->flags & EDGE_FALLTHRU))
3892 continue;
3894 else
3896 insn = BB_HEAD (dest);
3897 end = NEXT_INSN (BB_END (dest));
3898 while (insn != end && !NONDEBUG_INSN_P (insn))
3899 insn = NEXT_INSN (insn);
3900 if (insn != end && INSN_HAS_LOCATION (insn)
3901 && INSN_LOCATION (insn) == e->goto_locus)
3902 continue;
3904 nb = split_edge (e);
3905 if (!INSN_P (BB_END (nb)))
3906 BB_END (nb) = emit_insn_after_noloc (gen_nop (), BB_END (nb),
3907 nb);
3908 INSN_LOCATION (BB_END (nb)) = e->goto_locus;
3910 /* If there are other incoming edges to the destination block
3911 with the same goto locus, redirect them to the new block as
3912 well, this can prevent other such blocks from being created
3913 in subsequent iterations of the loop. */
3914 for (ei2 = ei_start (dest->preds); (e2 = ei_safe_edge (ei2)); )
3915 if (LOCATION_LOCUS (e2->goto_locus) != UNKNOWN_LOCATION
3916 && !(e2->flags & (EDGE_ABNORMAL | EDGE_FALLTHRU))
3917 && e->goto_locus == e2->goto_locus)
3918 redirect_edge_and_branch (e2, nb);
3919 else
3920 ei_next (&ei2);
3925 /* Perform sanity checks on the insn chain.
3926 1. Check that next/prev pointers are consistent in both the forward and
3927 reverse direction.
3928 2. Count insns in chain, going both directions, and check if equal.
3929 3. Check that get_last_insn () returns the actual end of chain. */
3931 DEBUG_FUNCTION void
3932 verify_insn_chain (void)
3934 rtx x, prevx, nextx;
3935 int insn_cnt1, insn_cnt2;
3937 for (prevx = NULL, insn_cnt1 = 1, x = get_insns ();
3938 x != 0;
3939 prevx = x, insn_cnt1++, x = NEXT_INSN (x))
3940 gcc_assert (PREV_INSN (x) == prevx);
3942 gcc_assert (prevx == get_last_insn ());
3944 for (nextx = NULL, insn_cnt2 = 1, x = get_last_insn ();
3945 x != 0;
3946 nextx = x, insn_cnt2++, x = PREV_INSN (x))
3947 gcc_assert (NEXT_INSN (x) == nextx);
3949 gcc_assert (insn_cnt1 == insn_cnt2);
3952 /* If we have assembler epilogues, the block falling through to exit must
3953 be the last one in the reordered chain when we reach final. Ensure
3954 that this condition is met. */
3955 static void
3956 fixup_fallthru_exit_predecessor (void)
3958 edge e;
3959 basic_block bb = NULL;
3961 /* This transformation is not valid before reload, because we might
3962 separate a call from the instruction that copies the return
3963 value. */
3964 gcc_assert (reload_completed);
3966 e = find_fallthru_edge (EXIT_BLOCK_PTR_FOR_FN (cfun)->preds);
3967 if (e)
3968 bb = e->src;
3970 if (bb && bb->aux)
3972 basic_block c = ENTRY_BLOCK_PTR_FOR_FN (cfun)->next_bb;
3974 /* If the very first block is the one with the fall-through exit
3975 edge, we have to split that block. */
3976 if (c == bb)
3978 bb = split_block (bb, NULL)->dest;
3979 bb->aux = c->aux;
3980 c->aux = bb;
3981 BB_FOOTER (bb) = BB_FOOTER (c);
3982 BB_FOOTER (c) = NULL;
3985 while (c->aux != bb)
3986 c = (basic_block) c->aux;
3988 c->aux = bb->aux;
3989 while (c->aux)
3990 c = (basic_block) c->aux;
3992 c->aux = bb;
3993 bb->aux = NULL;
3997 /* In case there are more than one fallthru predecessors of exit, force that
3998 there is only one. */
4000 static void
4001 force_one_exit_fallthru (void)
4003 edge e, predecessor = NULL;
4004 bool more = false;
4005 edge_iterator ei;
4006 basic_block forwarder, bb;
4008 FOR_EACH_EDGE (e, ei, EXIT_BLOCK_PTR_FOR_FN (cfun)->preds)
4009 if (e->flags & EDGE_FALLTHRU)
4011 if (predecessor == NULL)
4012 predecessor = e;
4013 else
4015 more = true;
4016 break;
4020 if (!more)
4021 return;
4023 /* Exit has several fallthru predecessors. Create a forwarder block for
4024 them. */
4025 forwarder = split_edge (predecessor);
4026 for (ei = ei_start (EXIT_BLOCK_PTR_FOR_FN (cfun)->preds);
4027 (e = ei_safe_edge (ei)); )
4029 if (e->src == forwarder
4030 || !(e->flags & EDGE_FALLTHRU))
4031 ei_next (&ei);
4032 else
4033 redirect_edge_and_branch_force (e, forwarder);
4036 /* Fix up the chain of blocks -- make FORWARDER immediately precede the
4037 exit block. */
4038 FOR_EACH_BB_FN (bb, cfun)
4040 if (bb->aux == NULL && bb != forwarder)
4042 bb->aux = forwarder;
4043 break;
4048 /* Return true in case it is possible to duplicate the basic block BB. */
4050 static bool
4051 cfg_layout_can_duplicate_bb_p (const_basic_block bb)
4053 /* Do not attempt to duplicate tablejumps, as we need to unshare
4054 the dispatch table. This is difficult to do, as the instructions
4055 computing jump destination may be hoisted outside the basic block. */
4056 if (tablejump_p (BB_END (bb), NULL, NULL))
4057 return false;
4059 /* Do not duplicate blocks containing insns that can't be copied. */
4060 if (targetm.cannot_copy_insn_p)
4062 rtx insn = BB_HEAD (bb);
4063 while (1)
4065 if (INSN_P (insn) && targetm.cannot_copy_insn_p (insn))
4066 return false;
4067 if (insn == BB_END (bb))
4068 break;
4069 insn = NEXT_INSN (insn);
4073 return true;
4077 duplicate_insn_chain (rtx from, rtx to)
4079 rtx insn, next, last, copy;
4081 /* Avoid updating of boundaries of previous basic block. The
4082 note will get removed from insn stream in fixup. */
4083 last = emit_note (NOTE_INSN_DELETED);
4085 /* Create copy at the end of INSN chain. The chain will
4086 be reordered later. */
4087 for (insn = from; insn != NEXT_INSN (to); insn = NEXT_INSN (insn))
4089 switch (GET_CODE (insn))
4091 case DEBUG_INSN:
4092 /* Don't duplicate label debug insns. */
4093 if (TREE_CODE (INSN_VAR_LOCATION_DECL (insn)) == LABEL_DECL)
4094 break;
4095 /* FALLTHRU */
4096 case INSN:
4097 case CALL_INSN:
4098 case JUMP_INSN:
4099 copy = emit_copy_of_insn_after (insn, get_last_insn ());
4100 if (JUMP_P (insn) && JUMP_LABEL (insn) != NULL_RTX
4101 && ANY_RETURN_P (JUMP_LABEL (insn)))
4102 JUMP_LABEL (copy) = JUMP_LABEL (insn);
4103 maybe_copy_prologue_epilogue_insn (insn, copy);
4104 break;
4106 case JUMP_TABLE_DATA:
4107 /* Avoid copying of dispatch tables. We never duplicate
4108 tablejumps, so this can hit only in case the table got
4109 moved far from original jump.
4110 Avoid copying following barrier as well if any
4111 (and debug insns in between). */
4112 for (next = NEXT_INSN (insn);
4113 next != NEXT_INSN (to);
4114 next = NEXT_INSN (next))
4115 if (!DEBUG_INSN_P (next))
4116 break;
4117 if (next != NEXT_INSN (to) && BARRIER_P (next))
4118 insn = next;
4119 break;
4121 case CODE_LABEL:
4122 break;
4124 case BARRIER:
4125 emit_barrier ();
4126 break;
4128 case NOTE:
4129 switch (NOTE_KIND (insn))
4131 /* In case prologue is empty and function contain label
4132 in first BB, we may want to copy the block. */
4133 case NOTE_INSN_PROLOGUE_END:
4135 case NOTE_INSN_DELETED:
4136 case NOTE_INSN_DELETED_LABEL:
4137 case NOTE_INSN_DELETED_DEBUG_LABEL:
4138 /* No problem to strip these. */
4139 case NOTE_INSN_FUNCTION_BEG:
4140 /* There is always just single entry to function. */
4141 case NOTE_INSN_BASIC_BLOCK:
4142 /* We should only switch text sections once. */
4143 case NOTE_INSN_SWITCH_TEXT_SECTIONS:
4144 break;
4146 case NOTE_INSN_EPILOGUE_BEG:
4147 emit_note_copy (insn);
4148 break;
4150 default:
4151 /* All other notes should have already been eliminated. */
4152 gcc_unreachable ();
4154 break;
4155 default:
4156 gcc_unreachable ();
4159 insn = NEXT_INSN (last);
4160 delete_insn (last);
4161 return insn;
4164 /* Create a duplicate of the basic block BB. */
4166 static basic_block
4167 cfg_layout_duplicate_bb (basic_block bb)
4169 rtx insn;
4170 basic_block new_bb;
4172 insn = duplicate_insn_chain (BB_HEAD (bb), BB_END (bb));
4173 new_bb = create_basic_block (insn,
4174 insn ? get_last_insn () : NULL,
4175 EXIT_BLOCK_PTR_FOR_FN (cfun)->prev_bb);
4177 BB_COPY_PARTITION (new_bb, bb);
4178 if (BB_HEADER (bb))
4180 insn = BB_HEADER (bb);
4181 while (NEXT_INSN (insn))
4182 insn = NEXT_INSN (insn);
4183 insn = duplicate_insn_chain (BB_HEADER (bb), insn);
4184 if (insn)
4185 BB_HEADER (new_bb) = unlink_insn_chain (insn, get_last_insn ());
4188 if (BB_FOOTER (bb))
4190 insn = BB_FOOTER (bb);
4191 while (NEXT_INSN (insn))
4192 insn = NEXT_INSN (insn);
4193 insn = duplicate_insn_chain (BB_FOOTER (bb), insn);
4194 if (insn)
4195 BB_FOOTER (new_bb) = unlink_insn_chain (insn, get_last_insn ());
4198 return new_bb;
4202 /* Main entry point to this module - initialize the datastructures for
4203 CFG layout changes. It keeps LOOPS up-to-date if not null.
4205 FLAGS is a set of additional flags to pass to cleanup_cfg(). */
4207 void
4208 cfg_layout_initialize (unsigned int flags)
4210 rtx x;
4211 basic_block bb;
4213 /* Once bb partitioning is complete, cfg layout mode should not be
4214 re-entered. Entering cfg layout mode may require fixups. As an
4215 example, if edge forwarding performed when optimizing the cfg
4216 layout required moving a block from the hot to the cold
4217 section. This would create an illegal partitioning unless some
4218 manual fixup was performed. */
4219 gcc_assert (!(crtl->bb_reorder_complete
4220 && flag_reorder_blocks_and_partition));
4222 initialize_original_copy_tables ();
4224 cfg_layout_rtl_register_cfg_hooks ();
4226 record_effective_endpoints ();
4228 /* Make sure that the targets of non local gotos are marked. */
4229 for (x = nonlocal_goto_handler_labels; x; x = XEXP (x, 1))
4231 bb = BLOCK_FOR_INSN (XEXP (x, 0));
4232 bb->flags |= BB_NON_LOCAL_GOTO_TARGET;
4235 cleanup_cfg (CLEANUP_CFGLAYOUT | flags);
4238 /* Splits superblocks. */
4239 void
4240 break_superblocks (void)
4242 sbitmap superblocks;
4243 bool need = false;
4244 basic_block bb;
4246 superblocks = sbitmap_alloc (last_basic_block_for_fn (cfun));
4247 bitmap_clear (superblocks);
4249 FOR_EACH_BB_FN (bb, cfun)
4250 if (bb->flags & BB_SUPERBLOCK)
4252 bb->flags &= ~BB_SUPERBLOCK;
4253 bitmap_set_bit (superblocks, bb->index);
4254 need = true;
4257 if (need)
4259 rebuild_jump_labels (get_insns ());
4260 find_many_sub_basic_blocks (superblocks);
4263 free (superblocks);
4266 /* Finalize the changes: reorder insn list according to the sequence specified
4267 by aux pointers, enter compensation code, rebuild scope forest. */
4269 void
4270 cfg_layout_finalize (void)
4272 #ifdef ENABLE_CHECKING
4273 verify_flow_info ();
4274 #endif
4275 force_one_exit_fallthru ();
4276 rtl_register_cfg_hooks ();
4277 if (reload_completed
4278 #ifdef HAVE_epilogue
4279 && !HAVE_epilogue
4280 #endif
4282 fixup_fallthru_exit_predecessor ();
4283 fixup_reorder_chain ();
4285 rebuild_jump_labels (get_insns ());
4286 delete_dead_jumptables ();
4288 #ifdef ENABLE_CHECKING
4289 verify_insn_chain ();
4290 verify_flow_info ();
4291 #endif
4295 /* Same as split_block but update cfg_layout structures. */
4297 static basic_block
4298 cfg_layout_split_block (basic_block bb, void *insnp)
4300 rtx insn = (rtx) insnp;
4301 basic_block new_bb = rtl_split_block (bb, insn);
4303 BB_FOOTER (new_bb) = BB_FOOTER (bb);
4304 BB_FOOTER (bb) = NULL;
4306 return new_bb;
4309 /* Redirect Edge to DEST. */
4310 static edge
4311 cfg_layout_redirect_edge_and_branch (edge e, basic_block dest)
4313 basic_block src = e->src;
4314 edge ret;
4316 if (e->flags & (EDGE_ABNORMAL_CALL | EDGE_EH))
4317 return NULL;
4319 if (e->dest == dest)
4320 return e;
4322 if (e->src != ENTRY_BLOCK_PTR_FOR_FN (cfun)
4323 && (ret = try_redirect_by_replacing_jump (e, dest, true)))
4325 df_set_bb_dirty (src);
4326 return ret;
4329 if (e->src == ENTRY_BLOCK_PTR_FOR_FN (cfun)
4330 && (e->flags & EDGE_FALLTHRU) && !(e->flags & EDGE_COMPLEX))
4332 if (dump_file)
4333 fprintf (dump_file, "Redirecting entry edge from bb %i to %i\n",
4334 e->src->index, dest->index);
4336 df_set_bb_dirty (e->src);
4337 redirect_edge_succ (e, dest);
4338 return e;
4341 /* Redirect_edge_and_branch may decide to turn branch into fallthru edge
4342 in the case the basic block appears to be in sequence. Avoid this
4343 transformation. */
4345 if (e->flags & EDGE_FALLTHRU)
4347 /* Redirect any branch edges unified with the fallthru one. */
4348 if (JUMP_P (BB_END (src))
4349 && label_is_jump_target_p (BB_HEAD (e->dest),
4350 BB_END (src)))
4352 edge redirected;
4354 if (dump_file)
4355 fprintf (dump_file, "Fallthru edge unified with branch "
4356 "%i->%i redirected to %i\n",
4357 e->src->index, e->dest->index, dest->index);
4358 e->flags &= ~EDGE_FALLTHRU;
4359 redirected = redirect_branch_edge (e, dest);
4360 gcc_assert (redirected);
4361 redirected->flags |= EDGE_FALLTHRU;
4362 df_set_bb_dirty (redirected->src);
4363 return redirected;
4365 /* In case we are redirecting fallthru edge to the branch edge
4366 of conditional jump, remove it. */
4367 if (EDGE_COUNT (src->succs) == 2)
4369 /* Find the edge that is different from E. */
4370 edge s = EDGE_SUCC (src, EDGE_SUCC (src, 0) == e);
4372 if (s->dest == dest
4373 && any_condjump_p (BB_END (src))
4374 && onlyjump_p (BB_END (src)))
4375 delete_insn (BB_END (src));
4377 if (dump_file)
4378 fprintf (dump_file, "Redirecting fallthru edge %i->%i to %i\n",
4379 e->src->index, e->dest->index, dest->index);
4380 ret = redirect_edge_succ_nodup (e, dest);
4382 else
4383 ret = redirect_branch_edge (e, dest);
4385 /* We don't want simplejumps in the insn stream during cfglayout. */
4386 gcc_assert (!simplejump_p (BB_END (src)));
4388 df_set_bb_dirty (src);
4389 return ret;
4392 /* Simple wrapper as we always can redirect fallthru edges. */
4393 static basic_block
4394 cfg_layout_redirect_edge_and_branch_force (edge e, basic_block dest)
4396 edge redirected = cfg_layout_redirect_edge_and_branch (e, dest);
4398 gcc_assert (redirected);
4399 return NULL;
4402 /* Same as delete_basic_block but update cfg_layout structures. */
4404 static void
4405 cfg_layout_delete_block (basic_block bb)
4407 rtx insn, next, prev = PREV_INSN (BB_HEAD (bb)), *to, remaints;
4409 if (BB_HEADER (bb))
4411 next = BB_HEAD (bb);
4412 if (prev)
4413 NEXT_INSN (prev) = BB_HEADER (bb);
4414 else
4415 set_first_insn (BB_HEADER (bb));
4416 PREV_INSN (BB_HEADER (bb)) = prev;
4417 insn = BB_HEADER (bb);
4418 while (NEXT_INSN (insn))
4419 insn = NEXT_INSN (insn);
4420 NEXT_INSN (insn) = next;
4421 PREV_INSN (next) = insn;
4423 next = NEXT_INSN (BB_END (bb));
4424 if (BB_FOOTER (bb))
4426 insn = BB_FOOTER (bb);
4427 while (insn)
4429 if (BARRIER_P (insn))
4431 if (PREV_INSN (insn))
4432 NEXT_INSN (PREV_INSN (insn)) = NEXT_INSN (insn);
4433 else
4434 BB_FOOTER (bb) = NEXT_INSN (insn);
4435 if (NEXT_INSN (insn))
4436 PREV_INSN (NEXT_INSN (insn)) = PREV_INSN (insn);
4438 if (LABEL_P (insn))
4439 break;
4440 insn = NEXT_INSN (insn);
4442 if (BB_FOOTER (bb))
4444 insn = BB_END (bb);
4445 NEXT_INSN (insn) = BB_FOOTER (bb);
4446 PREV_INSN (BB_FOOTER (bb)) = insn;
4447 while (NEXT_INSN (insn))
4448 insn = NEXT_INSN (insn);
4449 NEXT_INSN (insn) = next;
4450 if (next)
4451 PREV_INSN (next) = insn;
4452 else
4453 set_last_insn (insn);
4456 if (bb->next_bb != EXIT_BLOCK_PTR_FOR_FN (cfun))
4457 to = &BB_HEADER (bb->next_bb);
4458 else
4459 to = &cfg_layout_function_footer;
4461 rtl_delete_block (bb);
4463 if (prev)
4464 prev = NEXT_INSN (prev);
4465 else
4466 prev = get_insns ();
4467 if (next)
4468 next = PREV_INSN (next);
4469 else
4470 next = get_last_insn ();
4472 if (next && NEXT_INSN (next) != prev)
4474 remaints = unlink_insn_chain (prev, next);
4475 insn = remaints;
4476 while (NEXT_INSN (insn))
4477 insn = NEXT_INSN (insn);
4478 NEXT_INSN (insn) = *to;
4479 if (*to)
4480 PREV_INSN (*to) = insn;
4481 *to = remaints;
4485 /* Return true when blocks A and B can be safely merged. */
4487 static bool
4488 cfg_layout_can_merge_blocks_p (basic_block a, basic_block b)
4490 /* If we are partitioning hot/cold basic blocks, we don't want to
4491 mess up unconditional or indirect jumps that cross between hot
4492 and cold sections.
4494 Basic block partitioning may result in some jumps that appear to
4495 be optimizable (or blocks that appear to be mergeable), but which really
4496 must be left untouched (they are required to make it safely across
4497 partition boundaries). See the comments at the top of
4498 bb-reorder.c:partition_hot_cold_basic_blocks for complete details. */
4500 if (BB_PARTITION (a) != BB_PARTITION (b))
4501 return false;
4503 /* Protect the loop latches. */
4504 if (current_loops && b->loop_father->latch == b)
4505 return false;
4507 /* If we would end up moving B's instructions, make sure it doesn't fall
4508 through into the exit block, since we cannot recover from a fallthrough
4509 edge into the exit block occurring in the middle of a function. */
4510 if (NEXT_INSN (BB_END (a)) != BB_HEAD (b))
4512 edge e = find_fallthru_edge (b->succs);
4513 if (e && e->dest == EXIT_BLOCK_PTR_FOR_FN (cfun))
4514 return false;
4517 /* There must be exactly one edge in between the blocks. */
4518 return (single_succ_p (a)
4519 && single_succ (a) == b
4520 && single_pred_p (b) == 1
4521 && a != b
4522 /* Must be simple edge. */
4523 && !(single_succ_edge (a)->flags & EDGE_COMPLEX)
4524 && a != ENTRY_BLOCK_PTR_FOR_FN (cfun)
4525 && b != EXIT_BLOCK_PTR_FOR_FN (cfun)
4526 /* If the jump insn has side effects, we can't kill the edge.
4527 When not optimizing, try_redirect_by_replacing_jump will
4528 not allow us to redirect an edge by replacing a table jump. */
4529 && (!JUMP_P (BB_END (a))
4530 || ((!optimize || reload_completed)
4531 ? simplejump_p (BB_END (a)) : onlyjump_p (BB_END (a)))));
4534 /* Merge block A and B. The blocks must be mergeable. */
4536 static void
4537 cfg_layout_merge_blocks (basic_block a, basic_block b)
4539 bool forwarder_p = (b->flags & BB_FORWARDER_BLOCK) != 0;
4540 rtx insn;
4542 gcc_checking_assert (cfg_layout_can_merge_blocks_p (a, b));
4544 if (dump_file)
4545 fprintf (dump_file, "Merging block %d into block %d...\n", b->index,
4546 a->index);
4548 /* If there was a CODE_LABEL beginning B, delete it. */
4549 if (LABEL_P (BB_HEAD (b)))
4551 delete_insn (BB_HEAD (b));
4554 /* We should have fallthru edge in a, or we can do dummy redirection to get
4555 it cleaned up. */
4556 if (JUMP_P (BB_END (a)))
4557 try_redirect_by_replacing_jump (EDGE_SUCC (a, 0), b, true);
4558 gcc_assert (!JUMP_P (BB_END (a)));
4560 /* When not optimizing and the edge is the only place in RTL which holds
4561 some unique locus, emit a nop with that locus in between. */
4562 if (!optimize)
4563 emit_nop_for_unique_locus_between (a, b);
4565 /* Move things from b->footer after a->footer. */
4566 if (BB_FOOTER (b))
4568 if (!BB_FOOTER (a))
4569 BB_FOOTER (a) = BB_FOOTER (b);
4570 else
4572 rtx last = BB_FOOTER (a);
4574 while (NEXT_INSN (last))
4575 last = NEXT_INSN (last);
4576 NEXT_INSN (last) = BB_FOOTER (b);
4577 PREV_INSN (BB_FOOTER (b)) = last;
4579 BB_FOOTER (b) = NULL;
4582 /* Move things from b->header before a->footer.
4583 Note that this may include dead tablejump data, but we don't clean
4584 those up until we go out of cfglayout mode. */
4585 if (BB_HEADER (b))
4587 if (! BB_FOOTER (a))
4588 BB_FOOTER (a) = BB_HEADER (b);
4589 else
4591 rtx last = BB_HEADER (b);
4593 while (NEXT_INSN (last))
4594 last = NEXT_INSN (last);
4595 NEXT_INSN (last) = BB_FOOTER (a);
4596 PREV_INSN (BB_FOOTER (a)) = last;
4597 BB_FOOTER (a) = BB_HEADER (b);
4599 BB_HEADER (b) = NULL;
4602 /* In the case basic blocks are not adjacent, move them around. */
4603 if (NEXT_INSN (BB_END (a)) != BB_HEAD (b))
4605 insn = unlink_insn_chain (BB_HEAD (b), BB_END (b));
4607 emit_insn_after_noloc (insn, BB_END (a), a);
4609 /* Otherwise just re-associate the instructions. */
4610 else
4612 insn = BB_HEAD (b);
4613 BB_END (a) = BB_END (b);
4616 /* emit_insn_after_noloc doesn't call df_insn_change_bb.
4617 We need to explicitly call. */
4618 update_bb_for_insn_chain (insn, BB_END (b), a);
4620 /* Skip possible DELETED_LABEL insn. */
4621 if (!NOTE_INSN_BASIC_BLOCK_P (insn))
4622 insn = NEXT_INSN (insn);
4623 gcc_assert (NOTE_INSN_BASIC_BLOCK_P (insn));
4624 BB_HEAD (b) = BB_END (b) = NULL;
4625 delete_insn (insn);
4627 df_bb_delete (b->index);
4629 /* If B was a forwarder block, propagate the locus on the edge. */
4630 if (forwarder_p
4631 && LOCATION_LOCUS (EDGE_SUCC (b, 0)->goto_locus) == UNKNOWN_LOCATION)
4632 EDGE_SUCC (b, 0)->goto_locus = EDGE_SUCC (a, 0)->goto_locus;
4634 if (dump_file)
4635 fprintf (dump_file, "Merged blocks %d and %d.\n", a->index, b->index);
4638 /* Split edge E. */
4640 static basic_block
4641 cfg_layout_split_edge (edge e)
4643 basic_block new_bb =
4644 create_basic_block (e->src != ENTRY_BLOCK_PTR_FOR_FN (cfun)
4645 ? NEXT_INSN (BB_END (e->src)) : get_insns (),
4646 NULL_RTX, e->src);
4648 if (e->dest == EXIT_BLOCK_PTR_FOR_FN (cfun))
4649 BB_COPY_PARTITION (new_bb, e->src);
4650 else
4651 BB_COPY_PARTITION (new_bb, e->dest);
4652 make_edge (new_bb, e->dest, EDGE_FALLTHRU);
4653 redirect_edge_and_branch_force (e, new_bb);
4655 return new_bb;
4658 /* Do postprocessing after making a forwarder block joined by edge FALLTHRU. */
4660 static void
4661 rtl_make_forwarder_block (edge fallthru ATTRIBUTE_UNUSED)
4665 /* Return true if BB contains only labels or non-executable
4666 instructions. */
4668 static bool
4669 rtl_block_empty_p (basic_block bb)
4671 rtx insn;
4673 if (bb == ENTRY_BLOCK_PTR_FOR_FN (cfun)
4674 || bb == EXIT_BLOCK_PTR_FOR_FN (cfun))
4675 return true;
4677 FOR_BB_INSNS (bb, insn)
4678 if (NONDEBUG_INSN_P (insn) && !any_uncondjump_p (insn))
4679 return false;
4681 return true;
4684 /* Split a basic block if it ends with a conditional branch and if
4685 the other part of the block is not empty. */
4687 static basic_block
4688 rtl_split_block_before_cond_jump (basic_block bb)
4690 rtx insn;
4691 rtx split_point = NULL;
4692 rtx last = NULL;
4693 bool found_code = false;
4695 FOR_BB_INSNS (bb, insn)
4697 if (any_condjump_p (insn))
4698 split_point = last;
4699 else if (NONDEBUG_INSN_P (insn))
4700 found_code = true;
4701 last = insn;
4704 /* Did not find everything. */
4705 if (found_code && split_point)
4706 return split_block (bb, split_point)->dest;
4707 else
4708 return NULL;
4711 /* Return 1 if BB ends with a call, possibly followed by some
4712 instructions that must stay with the call, 0 otherwise. */
4714 static bool
4715 rtl_block_ends_with_call_p (basic_block bb)
4717 rtx insn = BB_END (bb);
4719 while (!CALL_P (insn)
4720 && insn != BB_HEAD (bb)
4721 && (keep_with_call_p (insn)
4722 || NOTE_P (insn)
4723 || DEBUG_INSN_P (insn)))
4724 insn = PREV_INSN (insn);
4725 return (CALL_P (insn));
4728 /* Return 1 if BB ends with a conditional branch, 0 otherwise. */
4730 static bool
4731 rtl_block_ends_with_condjump_p (const_basic_block bb)
4733 return any_condjump_p (BB_END (bb));
4736 /* Return true if we need to add fake edge to exit.
4737 Helper function for rtl_flow_call_edges_add. */
4739 static bool
4740 need_fake_edge_p (const_rtx insn)
4742 if (!INSN_P (insn))
4743 return false;
4745 if ((CALL_P (insn)
4746 && !SIBLING_CALL_P (insn)
4747 && !find_reg_note (insn, REG_NORETURN, NULL)
4748 && !(RTL_CONST_OR_PURE_CALL_P (insn))))
4749 return true;
4751 return ((GET_CODE (PATTERN (insn)) == ASM_OPERANDS
4752 && MEM_VOLATILE_P (PATTERN (insn)))
4753 || (GET_CODE (PATTERN (insn)) == PARALLEL
4754 && asm_noperands (insn) != -1
4755 && MEM_VOLATILE_P (XVECEXP (PATTERN (insn), 0, 0)))
4756 || GET_CODE (PATTERN (insn)) == ASM_INPUT);
4759 /* Add fake edges to the function exit for any non constant and non noreturn
4760 calls, volatile inline assembly in the bitmap of blocks specified by
4761 BLOCKS or to the whole CFG if BLOCKS is zero. Return the number of blocks
4762 that were split.
4764 The goal is to expose cases in which entering a basic block does not imply
4765 that all subsequent instructions must be executed. */
4767 static int
4768 rtl_flow_call_edges_add (sbitmap blocks)
4770 int i;
4771 int blocks_split = 0;
4772 int last_bb = last_basic_block_for_fn (cfun);
4773 bool check_last_block = false;
4775 if (n_basic_blocks_for_fn (cfun) == NUM_FIXED_BLOCKS)
4776 return 0;
4778 if (! blocks)
4779 check_last_block = true;
4780 else
4781 check_last_block = bitmap_bit_p (blocks,
4782 EXIT_BLOCK_PTR_FOR_FN (cfun)->prev_bb->index);
4784 /* In the last basic block, before epilogue generation, there will be
4785 a fallthru edge to EXIT. Special care is required if the last insn
4786 of the last basic block is a call because make_edge folds duplicate
4787 edges, which would result in the fallthru edge also being marked
4788 fake, which would result in the fallthru edge being removed by
4789 remove_fake_edges, which would result in an invalid CFG.
4791 Moreover, we can't elide the outgoing fake edge, since the block
4792 profiler needs to take this into account in order to solve the minimal
4793 spanning tree in the case that the call doesn't return.
4795 Handle this by adding a dummy instruction in a new last basic block. */
4796 if (check_last_block)
4798 basic_block bb = EXIT_BLOCK_PTR_FOR_FN (cfun)->prev_bb;
4799 rtx insn = BB_END (bb);
4801 /* Back up past insns that must be kept in the same block as a call. */
4802 while (insn != BB_HEAD (bb)
4803 && keep_with_call_p (insn))
4804 insn = PREV_INSN (insn);
4806 if (need_fake_edge_p (insn))
4808 edge e;
4810 e = find_edge (bb, EXIT_BLOCK_PTR_FOR_FN (cfun));
4811 if (e)
4813 insert_insn_on_edge (gen_use (const0_rtx), e);
4814 commit_edge_insertions ();
4819 /* Now add fake edges to the function exit for any non constant
4820 calls since there is no way that we can determine if they will
4821 return or not... */
4823 for (i = NUM_FIXED_BLOCKS; i < last_bb; i++)
4825 basic_block bb = BASIC_BLOCK_FOR_FN (cfun, i);
4826 rtx insn;
4827 rtx prev_insn;
4829 if (!bb)
4830 continue;
4832 if (blocks && !bitmap_bit_p (blocks, i))
4833 continue;
4835 for (insn = BB_END (bb); ; insn = prev_insn)
4837 prev_insn = PREV_INSN (insn);
4838 if (need_fake_edge_p (insn))
4840 edge e;
4841 rtx split_at_insn = insn;
4843 /* Don't split the block between a call and an insn that should
4844 remain in the same block as the call. */
4845 if (CALL_P (insn))
4846 while (split_at_insn != BB_END (bb)
4847 && keep_with_call_p (NEXT_INSN (split_at_insn)))
4848 split_at_insn = NEXT_INSN (split_at_insn);
4850 /* The handling above of the final block before the epilogue
4851 should be enough to verify that there is no edge to the exit
4852 block in CFG already. Calling make_edge in such case would
4853 cause us to mark that edge as fake and remove it later. */
4855 #ifdef ENABLE_CHECKING
4856 if (split_at_insn == BB_END (bb))
4858 e = find_edge (bb, EXIT_BLOCK_PTR_FOR_FN (cfun));
4859 gcc_assert (e == NULL);
4861 #endif
4863 /* Note that the following may create a new basic block
4864 and renumber the existing basic blocks. */
4865 if (split_at_insn != BB_END (bb))
4867 e = split_block (bb, split_at_insn);
4868 if (e)
4869 blocks_split++;
4872 make_edge (bb, EXIT_BLOCK_PTR_FOR_FN (cfun), EDGE_FAKE);
4875 if (insn == BB_HEAD (bb))
4876 break;
4880 if (blocks_split)
4881 verify_flow_info ();
4883 return blocks_split;
4886 /* Add COMP_RTX as a condition at end of COND_BB. FIRST_HEAD is
4887 the conditional branch target, SECOND_HEAD should be the fall-thru
4888 there is no need to handle this here the loop versioning code handles
4889 this. the reason for SECON_HEAD is that it is needed for condition
4890 in trees, and this should be of the same type since it is a hook. */
4891 static void
4892 rtl_lv_add_condition_to_bb (basic_block first_head ,
4893 basic_block second_head ATTRIBUTE_UNUSED,
4894 basic_block cond_bb, void *comp_rtx)
4896 rtx label, seq, jump;
4897 rtx op0 = XEXP ((rtx)comp_rtx, 0);
4898 rtx op1 = XEXP ((rtx)comp_rtx, 1);
4899 enum rtx_code comp = GET_CODE ((rtx)comp_rtx);
4900 enum machine_mode mode;
4903 label = block_label (first_head);
4904 mode = GET_MODE (op0);
4905 if (mode == VOIDmode)
4906 mode = GET_MODE (op1);
4908 start_sequence ();
4909 op0 = force_operand (op0, NULL_RTX);
4910 op1 = force_operand (op1, NULL_RTX);
4911 do_compare_rtx_and_jump (op0, op1, comp, 0,
4912 mode, NULL_RTX, NULL_RTX, label, -1);
4913 jump = get_last_insn ();
4914 JUMP_LABEL (jump) = label;
4915 LABEL_NUSES (label)++;
4916 seq = get_insns ();
4917 end_sequence ();
4919 /* Add the new cond , in the new head. */
4920 emit_insn_after (seq, BB_END (cond_bb));
4924 /* Given a block B with unconditional branch at its end, get the
4925 store the return the branch edge and the fall-thru edge in
4926 BRANCH_EDGE and FALLTHRU_EDGE respectively. */
4927 static void
4928 rtl_extract_cond_bb_edges (basic_block b, edge *branch_edge,
4929 edge *fallthru_edge)
4931 edge e = EDGE_SUCC (b, 0);
4933 if (e->flags & EDGE_FALLTHRU)
4935 *fallthru_edge = e;
4936 *branch_edge = EDGE_SUCC (b, 1);
4938 else
4940 *branch_edge = e;
4941 *fallthru_edge = EDGE_SUCC (b, 1);
4945 void
4946 init_rtl_bb_info (basic_block bb)
4948 gcc_assert (!bb->il.x.rtl);
4949 bb->il.x.head_ = NULL;
4950 bb->il.x.rtl = ggc_cleared_alloc<rtl_bb_info> ();
4953 /* Returns true if it is possible to remove edge E by redirecting
4954 it to the destination of the other edge from E->src. */
4956 static bool
4957 rtl_can_remove_branch_p (const_edge e)
4959 const_basic_block src = e->src;
4960 const_basic_block target = EDGE_SUCC (src, EDGE_SUCC (src, 0) == e)->dest;
4961 const_rtx insn = BB_END (src), set;
4963 /* The conditions are taken from try_redirect_by_replacing_jump. */
4964 if (target == EXIT_BLOCK_PTR_FOR_FN (cfun))
4965 return false;
4967 if (e->flags & (EDGE_ABNORMAL_CALL | EDGE_EH))
4968 return false;
4970 if (BB_PARTITION (src) != BB_PARTITION (target))
4971 return false;
4973 if (!onlyjump_p (insn)
4974 || tablejump_p (insn, NULL, NULL))
4975 return false;
4977 set = single_set (insn);
4978 if (!set || side_effects_p (set))
4979 return false;
4981 return true;
4984 static basic_block
4985 rtl_duplicate_bb (basic_block bb)
4987 bb = cfg_layout_duplicate_bb (bb);
4988 bb->aux = NULL;
4989 return bb;
4992 /* Do book-keeping of basic block BB for the profile consistency checker.
4993 If AFTER_PASS is 0, do pre-pass accounting, or if AFTER_PASS is 1
4994 then do post-pass accounting. Store the counting in RECORD. */
4995 static void
4996 rtl_account_profile_record (basic_block bb, int after_pass,
4997 struct profile_record *record)
4999 rtx insn;
5000 FOR_BB_INSNS (bb, insn)
5001 if (INSN_P (insn))
5003 record->size[after_pass]
5004 += insn_rtx_cost (PATTERN (insn), false);
5005 if (profile_status_for_fn (cfun) == PROFILE_READ)
5006 record->time[after_pass]
5007 += insn_rtx_cost (PATTERN (insn), true) * bb->count;
5008 else if (profile_status_for_fn (cfun) == PROFILE_GUESSED)
5009 record->time[after_pass]
5010 += insn_rtx_cost (PATTERN (insn), true) * bb->frequency;
5014 /* Implementation of CFG manipulation for linearized RTL. */
5015 struct cfg_hooks rtl_cfg_hooks = {
5016 "rtl",
5017 rtl_verify_flow_info,
5018 rtl_dump_bb,
5019 rtl_dump_bb_for_graph,
5020 rtl_create_basic_block,
5021 rtl_redirect_edge_and_branch,
5022 rtl_redirect_edge_and_branch_force,
5023 rtl_can_remove_branch_p,
5024 rtl_delete_block,
5025 rtl_split_block,
5026 rtl_move_block_after,
5027 rtl_can_merge_blocks, /* can_merge_blocks_p */
5028 rtl_merge_blocks,
5029 rtl_predict_edge,
5030 rtl_predicted_by_p,
5031 cfg_layout_can_duplicate_bb_p,
5032 rtl_duplicate_bb,
5033 rtl_split_edge,
5034 rtl_make_forwarder_block,
5035 rtl_tidy_fallthru_edge,
5036 rtl_force_nonfallthru,
5037 rtl_block_ends_with_call_p,
5038 rtl_block_ends_with_condjump_p,
5039 rtl_flow_call_edges_add,
5040 NULL, /* execute_on_growing_pred */
5041 NULL, /* execute_on_shrinking_pred */
5042 NULL, /* duplicate loop for trees */
5043 NULL, /* lv_add_condition_to_bb */
5044 NULL, /* lv_adjust_loop_header_phi*/
5045 NULL, /* extract_cond_bb_edges */
5046 NULL, /* flush_pending_stmts */
5047 rtl_block_empty_p, /* block_empty_p */
5048 rtl_split_block_before_cond_jump, /* split_block_before_cond_jump */
5049 rtl_account_profile_record,
5052 /* Implementation of CFG manipulation for cfg layout RTL, where
5053 basic block connected via fallthru edges does not have to be adjacent.
5054 This representation will hopefully become the default one in future
5055 version of the compiler. */
5057 struct cfg_hooks cfg_layout_rtl_cfg_hooks = {
5058 "cfglayout mode",
5059 rtl_verify_flow_info_1,
5060 rtl_dump_bb,
5061 rtl_dump_bb_for_graph,
5062 cfg_layout_create_basic_block,
5063 cfg_layout_redirect_edge_and_branch,
5064 cfg_layout_redirect_edge_and_branch_force,
5065 rtl_can_remove_branch_p,
5066 cfg_layout_delete_block,
5067 cfg_layout_split_block,
5068 rtl_move_block_after,
5069 cfg_layout_can_merge_blocks_p,
5070 cfg_layout_merge_blocks,
5071 rtl_predict_edge,
5072 rtl_predicted_by_p,
5073 cfg_layout_can_duplicate_bb_p,
5074 cfg_layout_duplicate_bb,
5075 cfg_layout_split_edge,
5076 rtl_make_forwarder_block,
5077 NULL, /* tidy_fallthru_edge */
5078 rtl_force_nonfallthru,
5079 rtl_block_ends_with_call_p,
5080 rtl_block_ends_with_condjump_p,
5081 rtl_flow_call_edges_add,
5082 NULL, /* execute_on_growing_pred */
5083 NULL, /* execute_on_shrinking_pred */
5084 duplicate_loop_to_header_edge, /* duplicate loop for trees */
5085 rtl_lv_add_condition_to_bb, /* lv_add_condition_to_bb */
5086 NULL, /* lv_adjust_loop_header_phi*/
5087 rtl_extract_cond_bb_edges, /* extract_cond_bb_edges */
5088 NULL, /* flush_pending_stmts */
5089 rtl_block_empty_p, /* block_empty_p */
5090 rtl_split_block_before_cond_jump, /* split_block_before_cond_jump */
5091 rtl_account_profile_record,
5094 #include "gt-cfgrtl.h"