* config/rx/rx.c (add_vector_labels): New.
[official-gcc.git] / gcc / cfgrtl.c
blob49faf2e0e631485fbcf0acee16f2086ed9d8f319
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 true, /* has_execute */
453 TV_NONE, /* tv_id */
454 0, /* properties_required */
455 0, /* properties_provided */
456 PROP_cfg, /* properties_destroyed */
457 0, /* todo_flags_start */
458 0, /* todo_flags_finish */
461 class pass_free_cfg : public rtl_opt_pass
463 public:
464 pass_free_cfg (gcc::context *ctxt)
465 : rtl_opt_pass (pass_data_free_cfg, ctxt)
468 /* opt_pass methods: */
469 virtual unsigned int execute (function *);
471 }; // class pass_free_cfg
473 unsigned int
474 pass_free_cfg::execute (function *)
476 #ifdef DELAY_SLOTS
477 /* The resource.c machinery uses DF but the CFG isn't guaranteed to be
478 valid at that point so it would be too late to call df_analyze. */
479 if (optimize > 0 && flag_delayed_branch)
481 df_note_add_problem ();
482 df_analyze ();
484 #endif
486 if (crtl->has_bb_partition)
487 insert_section_boundary_note ();
489 free_bb_for_insn ();
490 return 0;
493 } // anon namespace
495 rtl_opt_pass *
496 make_pass_free_cfg (gcc::context *ctxt)
498 return new pass_free_cfg (ctxt);
501 /* Return RTX to emit after when we want to emit code on the entry of function. */
503 entry_of_function (void)
505 return (n_basic_blocks_for_fn (cfun) > NUM_FIXED_BLOCKS ?
506 BB_HEAD (ENTRY_BLOCK_PTR_FOR_FN (cfun)->next_bb) : get_insns ());
509 /* Emit INSN at the entry point of the function, ensuring that it is only
510 executed once per function. */
511 void
512 emit_insn_at_entry (rtx insn)
514 edge_iterator ei = ei_start (ENTRY_BLOCK_PTR_FOR_FN (cfun)->succs);
515 edge e = ei_safe_edge (ei);
516 gcc_assert (e->flags & EDGE_FALLTHRU);
518 insert_insn_on_edge (insn, e);
519 commit_edge_insertions ();
522 /* Update BLOCK_FOR_INSN of insns between BEGIN and END
523 (or BARRIER if found) and notify df of the bb change.
524 The insn chain range is inclusive
525 (i.e. both BEGIN and END will be updated. */
527 static void
528 update_bb_for_insn_chain (rtx begin, rtx end, basic_block bb)
530 rtx insn;
532 end = NEXT_INSN (end);
533 for (insn = begin; insn != end; insn = NEXT_INSN (insn))
534 if (!BARRIER_P (insn))
535 df_insn_change_bb (insn, bb);
538 /* Update BLOCK_FOR_INSN of insns in BB to BB,
539 and notify df of the change. */
541 void
542 update_bb_for_insn (basic_block bb)
544 update_bb_for_insn_chain (BB_HEAD (bb), BB_END (bb), bb);
548 /* Like active_insn_p, except keep the return value clobber around
549 even after reload. */
551 static bool
552 flow_active_insn_p (const_rtx insn)
554 if (active_insn_p (insn))
555 return true;
557 /* A clobber of the function return value exists for buggy
558 programs that fail to return a value. Its effect is to
559 keep the return value from being live across the entire
560 function. If we allow it to be skipped, we introduce the
561 possibility for register lifetime confusion. */
562 if (GET_CODE (PATTERN (insn)) == CLOBBER
563 && REG_P (XEXP (PATTERN (insn), 0))
564 && REG_FUNCTION_VALUE_P (XEXP (PATTERN (insn), 0)))
565 return true;
567 return false;
570 /* Return true if the block has no effect and only forwards control flow to
571 its single destination. */
573 bool
574 contains_no_active_insn_p (const_basic_block bb)
576 rtx insn;
578 if (bb == EXIT_BLOCK_PTR_FOR_FN (cfun) || bb == ENTRY_BLOCK_PTR_FOR_FN (cfun)
579 || !single_succ_p (bb))
580 return false;
582 for (insn = BB_HEAD (bb); insn != BB_END (bb); insn = NEXT_INSN (insn))
583 if (INSN_P (insn) && flow_active_insn_p (insn))
584 return false;
586 return (!INSN_P (insn)
587 || (JUMP_P (insn) && simplejump_p (insn))
588 || !flow_active_insn_p (insn));
591 /* Likewise, but protect loop latches, headers and preheaders. */
592 /* FIXME: Make this a cfg hook. */
594 bool
595 forwarder_block_p (const_basic_block bb)
597 if (!contains_no_active_insn_p (bb))
598 return false;
600 /* Protect loop latches, headers and preheaders. */
601 if (current_loops)
603 basic_block dest;
604 if (bb->loop_father->header == bb)
605 return false;
606 dest = EDGE_SUCC (bb, 0)->dest;
607 if (dest->loop_father->header == dest)
608 return false;
611 return true;
614 /* Return nonzero if we can reach target from src by falling through. */
615 /* FIXME: Make this a cfg hook, the result is only valid in cfgrtl mode. */
617 bool
618 can_fallthru (basic_block src, basic_block target)
620 rtx insn = BB_END (src);
621 rtx insn2;
622 edge e;
623 edge_iterator ei;
625 if (target == EXIT_BLOCK_PTR_FOR_FN (cfun))
626 return true;
627 if (src->next_bb != target)
628 return false;
630 /* ??? Later we may add code to move jump tables offline. */
631 if (tablejump_p (insn, NULL, NULL))
632 return false;
634 FOR_EACH_EDGE (e, ei, src->succs)
635 if (e->dest == EXIT_BLOCK_PTR_FOR_FN (cfun)
636 && e->flags & EDGE_FALLTHRU)
637 return false;
639 insn2 = BB_HEAD (target);
640 if (!active_insn_p (insn2))
641 insn2 = next_active_insn (insn2);
643 return next_active_insn (insn) == insn2;
646 /* Return nonzero if we could reach target from src by falling through,
647 if the target was made adjacent. If we already have a fall-through
648 edge to the exit block, we can't do that. */
649 static bool
650 could_fall_through (basic_block src, basic_block target)
652 edge e;
653 edge_iterator ei;
655 if (target == EXIT_BLOCK_PTR_FOR_FN (cfun))
656 return true;
657 FOR_EACH_EDGE (e, ei, src->succs)
658 if (e->dest == EXIT_BLOCK_PTR_FOR_FN (cfun)
659 && e->flags & EDGE_FALLTHRU)
660 return 0;
661 return true;
664 /* Return the NOTE_INSN_BASIC_BLOCK of BB. */
666 bb_note (basic_block bb)
668 rtx note;
670 note = BB_HEAD (bb);
671 if (LABEL_P (note))
672 note = NEXT_INSN (note);
674 gcc_assert (NOTE_INSN_BASIC_BLOCK_P (note));
675 return note;
678 /* Return the INSN immediately following the NOTE_INSN_BASIC_BLOCK
679 note associated with the BLOCK. */
681 static rtx
682 first_insn_after_basic_block_note (basic_block block)
684 rtx insn;
686 /* Get the first instruction in the block. */
687 insn = BB_HEAD (block);
689 if (insn == NULL_RTX)
690 return NULL_RTX;
691 if (LABEL_P (insn))
692 insn = NEXT_INSN (insn);
693 gcc_assert (NOTE_INSN_BASIC_BLOCK_P (insn));
695 return NEXT_INSN (insn);
698 /* Creates a new basic block just after basic block B by splitting
699 everything after specified instruction I. */
701 static basic_block
702 rtl_split_block (basic_block bb, void *insnp)
704 basic_block new_bb;
705 rtx insn = (rtx) insnp;
706 edge e;
707 edge_iterator ei;
709 if (!insn)
711 insn = first_insn_after_basic_block_note (bb);
713 if (insn)
715 rtx next = insn;
717 insn = PREV_INSN (insn);
719 /* If the block contains only debug insns, insn would have
720 been NULL in a non-debug compilation, and then we'd end
721 up emitting a DELETED note. For -fcompare-debug
722 stability, emit the note too. */
723 if (insn != BB_END (bb)
724 && DEBUG_INSN_P (next)
725 && DEBUG_INSN_P (BB_END (bb)))
727 while (next != BB_END (bb) && DEBUG_INSN_P (next))
728 next = NEXT_INSN (next);
730 if (next == BB_END (bb))
731 emit_note_after (NOTE_INSN_DELETED, next);
734 else
735 insn = get_last_insn ();
738 /* We probably should check type of the insn so that we do not create
739 inconsistent cfg. It is checked in verify_flow_info anyway, so do not
740 bother. */
741 if (insn == BB_END (bb))
742 emit_note_after (NOTE_INSN_DELETED, insn);
744 /* Create the new basic block. */
745 new_bb = create_basic_block (NEXT_INSN (insn), BB_END (bb), bb);
746 BB_COPY_PARTITION (new_bb, bb);
747 BB_END (bb) = insn;
749 /* Redirect the outgoing edges. */
750 new_bb->succs = bb->succs;
751 bb->succs = NULL;
752 FOR_EACH_EDGE (e, ei, new_bb->succs)
753 e->src = new_bb;
755 /* The new block starts off being dirty. */
756 df_set_bb_dirty (bb);
757 return new_bb;
760 /* Return true if the single edge between blocks A and B is the only place
761 in RTL which holds some unique locus. */
763 static bool
764 unique_locus_on_edge_between_p (basic_block a, basic_block b)
766 const location_t goto_locus = EDGE_SUCC (a, 0)->goto_locus;
767 rtx insn, end;
769 if (LOCATION_LOCUS (goto_locus) == UNKNOWN_LOCATION)
770 return false;
772 /* First scan block A backward. */
773 insn = BB_END (a);
774 end = PREV_INSN (BB_HEAD (a));
775 while (insn != end && (!NONDEBUG_INSN_P (insn) || !INSN_HAS_LOCATION (insn)))
776 insn = PREV_INSN (insn);
778 if (insn != end && INSN_LOCATION (insn) == goto_locus)
779 return false;
781 /* Then scan block B forward. */
782 insn = BB_HEAD (b);
783 if (insn)
785 end = NEXT_INSN (BB_END (b));
786 while (insn != end && !NONDEBUG_INSN_P (insn))
787 insn = NEXT_INSN (insn);
789 if (insn != end && INSN_HAS_LOCATION (insn)
790 && INSN_LOCATION (insn) == goto_locus)
791 return false;
794 return true;
797 /* If the single edge between blocks A and B is the only place in RTL which
798 holds some unique locus, emit a nop with that locus between the blocks. */
800 static void
801 emit_nop_for_unique_locus_between (basic_block a, basic_block b)
803 if (!unique_locus_on_edge_between_p (a, b))
804 return;
806 BB_END (a) = emit_insn_after_noloc (gen_nop (), BB_END (a), a);
807 INSN_LOCATION (BB_END (a)) = EDGE_SUCC (a, 0)->goto_locus;
810 /* Blocks A and B are to be merged into a single block A. The insns
811 are already contiguous. */
813 static void
814 rtl_merge_blocks (basic_block a, basic_block b)
816 rtx b_head = BB_HEAD (b), b_end = BB_END (b), a_end = BB_END (a);
817 rtx del_first = NULL_RTX, del_last = NULL_RTX;
818 rtx b_debug_start = b_end, b_debug_end = b_end;
819 bool forwarder_p = (b->flags & BB_FORWARDER_BLOCK) != 0;
820 int b_empty = 0;
822 if (dump_file)
823 fprintf (dump_file, "Merging block %d into block %d...\n", b->index,
824 a->index);
826 while (DEBUG_INSN_P (b_end))
827 b_end = PREV_INSN (b_debug_start = b_end);
829 /* If there was a CODE_LABEL beginning B, delete it. */
830 if (LABEL_P (b_head))
832 /* Detect basic blocks with nothing but a label. This can happen
833 in particular at the end of a function. */
834 if (b_head == b_end)
835 b_empty = 1;
837 del_first = del_last = b_head;
838 b_head = NEXT_INSN (b_head);
841 /* Delete the basic block note and handle blocks containing just that
842 note. */
843 if (NOTE_INSN_BASIC_BLOCK_P (b_head))
845 if (b_head == b_end)
846 b_empty = 1;
847 if (! del_last)
848 del_first = b_head;
850 del_last = b_head;
851 b_head = NEXT_INSN (b_head);
854 /* If there was a jump out of A, delete it. */
855 if (JUMP_P (a_end))
857 rtx prev;
859 for (prev = PREV_INSN (a_end); ; prev = PREV_INSN (prev))
860 if (!NOTE_P (prev)
861 || NOTE_INSN_BASIC_BLOCK_P (prev)
862 || prev == BB_HEAD (a))
863 break;
865 del_first = a_end;
867 #ifdef HAVE_cc0
868 /* If this was a conditional jump, we need to also delete
869 the insn that set cc0. */
870 if (only_sets_cc0_p (prev))
872 rtx tmp = prev;
874 prev = prev_nonnote_insn (prev);
875 if (!prev)
876 prev = BB_HEAD (a);
877 del_first = tmp;
879 #endif
881 a_end = PREV_INSN (del_first);
883 else if (BARRIER_P (NEXT_INSN (a_end)))
884 del_first = NEXT_INSN (a_end);
886 /* Delete everything marked above as well as crap that might be
887 hanging out between the two blocks. */
888 BB_END (a) = a_end;
889 BB_HEAD (b) = b_empty ? NULL_RTX : b_head;
890 delete_insn_chain (del_first, del_last, true);
892 /* When not optimizing and the edge is the only place in RTL which holds
893 some unique locus, emit a nop with that locus in between. */
894 if (!optimize)
896 emit_nop_for_unique_locus_between (a, b);
897 a_end = BB_END (a);
900 /* Reassociate the insns of B with A. */
901 if (!b_empty)
903 update_bb_for_insn_chain (a_end, b_debug_end, a);
905 BB_END (a) = b_debug_end;
906 BB_HEAD (b) = NULL_RTX;
908 else if (b_end != b_debug_end)
910 /* Move any deleted labels and other notes between the end of A
911 and the debug insns that make up B after the debug insns,
912 bringing the debug insns into A while keeping the notes after
913 the end of A. */
914 if (NEXT_INSN (a_end) != b_debug_start)
915 reorder_insns_nobb (NEXT_INSN (a_end), PREV_INSN (b_debug_start),
916 b_debug_end);
917 update_bb_for_insn_chain (b_debug_start, b_debug_end, a);
918 BB_END (a) = b_debug_end;
921 df_bb_delete (b->index);
923 /* If B was a forwarder block, propagate the locus on the edge. */
924 if (forwarder_p
925 && LOCATION_LOCUS (EDGE_SUCC (b, 0)->goto_locus) == UNKNOWN_LOCATION)
926 EDGE_SUCC (b, 0)->goto_locus = EDGE_SUCC (a, 0)->goto_locus;
928 if (dump_file)
929 fprintf (dump_file, "Merged blocks %d and %d.\n", a->index, b->index);
933 /* Return true when block A and B can be merged. */
935 static bool
936 rtl_can_merge_blocks (basic_block a, basic_block b)
938 /* If we are partitioning hot/cold basic blocks, we don't want to
939 mess up unconditional or indirect jumps that cross between hot
940 and cold sections.
942 Basic block partitioning may result in some jumps that appear to
943 be optimizable (or blocks that appear to be mergeable), but which really
944 must be left untouched (they are required to make it safely across
945 partition boundaries). See the comments at the top of
946 bb-reorder.c:partition_hot_cold_basic_blocks for complete details. */
948 if (BB_PARTITION (a) != BB_PARTITION (b))
949 return false;
951 /* Protect the loop latches. */
952 if (current_loops && b->loop_father->latch == b)
953 return false;
955 /* There must be exactly one edge in between the blocks. */
956 return (single_succ_p (a)
957 && single_succ (a) == b
958 && single_pred_p (b)
959 && a != b
960 /* Must be simple edge. */
961 && !(single_succ_edge (a)->flags & EDGE_COMPLEX)
962 && a->next_bb == b
963 && a != ENTRY_BLOCK_PTR_FOR_FN (cfun)
964 && b != EXIT_BLOCK_PTR_FOR_FN (cfun)
965 /* If the jump insn has side effects,
966 we can't kill the edge. */
967 && (!JUMP_P (BB_END (a))
968 || (reload_completed
969 ? simplejump_p (BB_END (a)) : onlyjump_p (BB_END (a)))));
972 /* Return the label in the head of basic block BLOCK. Create one if it doesn't
973 exist. */
976 block_label (basic_block block)
978 if (block == EXIT_BLOCK_PTR_FOR_FN (cfun))
979 return NULL_RTX;
981 if (!LABEL_P (BB_HEAD (block)))
983 BB_HEAD (block) = emit_label_before (gen_label_rtx (), BB_HEAD (block));
986 return BB_HEAD (block);
989 /* Attempt to perform edge redirection by replacing possibly complex jump
990 instruction by unconditional jump or removing jump completely. This can
991 apply only if all edges now point to the same block. The parameters and
992 return values are equivalent to redirect_edge_and_branch. */
994 edge
995 try_redirect_by_replacing_jump (edge e, basic_block target, bool in_cfglayout)
997 basic_block src = e->src;
998 rtx insn = BB_END (src), kill_from;
999 rtx set;
1000 int fallthru = 0;
1002 /* If we are partitioning hot/cold basic blocks, we don't want to
1003 mess up unconditional or indirect jumps that cross between hot
1004 and cold sections.
1006 Basic block partitioning may result in some jumps that appear to
1007 be optimizable (or blocks that appear to be mergeable), but which really
1008 must be left untouched (they are required to make it safely across
1009 partition boundaries). See the comments at the top of
1010 bb-reorder.c:partition_hot_cold_basic_blocks for complete details. */
1012 if (BB_PARTITION (src) != BB_PARTITION (target))
1013 return NULL;
1015 /* We can replace or remove a complex jump only when we have exactly
1016 two edges. Also, if we have exactly one outgoing edge, we can
1017 redirect that. */
1018 if (EDGE_COUNT (src->succs) >= 3
1019 /* Verify that all targets will be TARGET. Specifically, the
1020 edge that is not E must also go to TARGET. */
1021 || (EDGE_COUNT (src->succs) == 2
1022 && EDGE_SUCC (src, EDGE_SUCC (src, 0) == e)->dest != target))
1023 return NULL;
1025 if (!onlyjump_p (insn))
1026 return NULL;
1027 if ((!optimize || reload_completed) && tablejump_p (insn, NULL, NULL))
1028 return NULL;
1030 /* Avoid removing branch with side effects. */
1031 set = single_set (insn);
1032 if (!set || side_effects_p (set))
1033 return NULL;
1035 /* In case we zap a conditional jump, we'll need to kill
1036 the cc0 setter too. */
1037 kill_from = insn;
1038 #ifdef HAVE_cc0
1039 if (reg_mentioned_p (cc0_rtx, PATTERN (insn))
1040 && only_sets_cc0_p (PREV_INSN (insn)))
1041 kill_from = PREV_INSN (insn);
1042 #endif
1044 /* See if we can create the fallthru edge. */
1045 if (in_cfglayout || can_fallthru (src, target))
1047 if (dump_file)
1048 fprintf (dump_file, "Removing jump %i.\n", INSN_UID (insn));
1049 fallthru = 1;
1051 /* Selectively unlink whole insn chain. */
1052 if (in_cfglayout)
1054 rtx insn = BB_FOOTER (src);
1056 delete_insn_chain (kill_from, BB_END (src), false);
1058 /* Remove barriers but keep jumptables. */
1059 while (insn)
1061 if (BARRIER_P (insn))
1063 if (PREV_INSN (insn))
1064 NEXT_INSN (PREV_INSN (insn)) = NEXT_INSN (insn);
1065 else
1066 BB_FOOTER (src) = NEXT_INSN (insn);
1067 if (NEXT_INSN (insn))
1068 PREV_INSN (NEXT_INSN (insn)) = PREV_INSN (insn);
1070 if (LABEL_P (insn))
1071 break;
1072 insn = NEXT_INSN (insn);
1075 else
1076 delete_insn_chain (kill_from, PREV_INSN (BB_HEAD (target)),
1077 false);
1080 /* If this already is simplejump, redirect it. */
1081 else if (simplejump_p (insn))
1083 if (e->dest == target)
1084 return NULL;
1085 if (dump_file)
1086 fprintf (dump_file, "Redirecting jump %i from %i to %i.\n",
1087 INSN_UID (insn), e->dest->index, target->index);
1088 if (!redirect_jump (insn, block_label (target), 0))
1090 gcc_assert (target == EXIT_BLOCK_PTR_FOR_FN (cfun));
1091 return NULL;
1095 /* Cannot do anything for target exit block. */
1096 else if (target == EXIT_BLOCK_PTR_FOR_FN (cfun))
1097 return NULL;
1099 /* Or replace possibly complicated jump insn by simple jump insn. */
1100 else
1102 rtx target_label = block_label (target);
1103 rtx barrier, label, table;
1105 emit_jump_insn_after_noloc (gen_jump (target_label), insn);
1106 JUMP_LABEL (BB_END (src)) = target_label;
1107 LABEL_NUSES (target_label)++;
1108 if (dump_file)
1109 fprintf (dump_file, "Replacing insn %i by jump %i\n",
1110 INSN_UID (insn), INSN_UID (BB_END (src)));
1113 delete_insn_chain (kill_from, insn, false);
1115 /* Recognize a tablejump that we are converting to a
1116 simple jump and remove its associated CODE_LABEL
1117 and ADDR_VEC or ADDR_DIFF_VEC. */
1118 if (tablejump_p (insn, &label, &table))
1119 delete_insn_chain (label, table, false);
1121 barrier = next_nonnote_insn (BB_END (src));
1122 if (!barrier || !BARRIER_P (barrier))
1123 emit_barrier_after (BB_END (src));
1124 else
1126 if (barrier != NEXT_INSN (BB_END (src)))
1128 /* Move the jump before barrier so that the notes
1129 which originally were or were created before jump table are
1130 inside the basic block. */
1131 rtx new_insn = BB_END (src);
1133 update_bb_for_insn_chain (NEXT_INSN (BB_END (src)),
1134 PREV_INSN (barrier), src);
1136 NEXT_INSN (PREV_INSN (new_insn)) = NEXT_INSN (new_insn);
1137 PREV_INSN (NEXT_INSN (new_insn)) = PREV_INSN (new_insn);
1139 NEXT_INSN (new_insn) = barrier;
1140 NEXT_INSN (PREV_INSN (barrier)) = new_insn;
1142 PREV_INSN (new_insn) = PREV_INSN (barrier);
1143 PREV_INSN (barrier) = new_insn;
1148 /* Keep only one edge out and set proper flags. */
1149 if (!single_succ_p (src))
1150 remove_edge (e);
1151 gcc_assert (single_succ_p (src));
1153 e = single_succ_edge (src);
1154 if (fallthru)
1155 e->flags = EDGE_FALLTHRU;
1156 else
1157 e->flags = 0;
1159 e->probability = REG_BR_PROB_BASE;
1160 e->count = src->count;
1162 if (e->dest != target)
1163 redirect_edge_succ (e, target);
1164 return e;
1167 /* Subroutine of redirect_branch_edge that tries to patch the jump
1168 instruction INSN so that it reaches block NEW. Do this
1169 only when it originally reached block OLD. Return true if this
1170 worked or the original target wasn't OLD, return false if redirection
1171 doesn't work. */
1173 static bool
1174 patch_jump_insn (rtx insn, rtx old_label, basic_block new_bb)
1176 rtx tmp;
1177 /* Recognize a tablejump and adjust all matching cases. */
1178 if (tablejump_p (insn, NULL, &tmp))
1180 rtvec vec;
1181 int j;
1182 rtx new_label = block_label (new_bb);
1184 if (new_bb == EXIT_BLOCK_PTR_FOR_FN (cfun))
1185 return false;
1186 if (GET_CODE (PATTERN (tmp)) == ADDR_VEC)
1187 vec = XVEC (PATTERN (tmp), 0);
1188 else
1189 vec = XVEC (PATTERN (tmp), 1);
1191 for (j = GET_NUM_ELEM (vec) - 1; j >= 0; --j)
1192 if (XEXP (RTVEC_ELT (vec, j), 0) == old_label)
1194 RTVEC_ELT (vec, j) = gen_rtx_LABEL_REF (Pmode, new_label);
1195 --LABEL_NUSES (old_label);
1196 ++LABEL_NUSES (new_label);
1199 /* Handle casesi dispatch insns. */
1200 if ((tmp = single_set (insn)) != NULL
1201 && SET_DEST (tmp) == pc_rtx
1202 && GET_CODE (SET_SRC (tmp)) == IF_THEN_ELSE
1203 && GET_CODE (XEXP (SET_SRC (tmp), 2)) == LABEL_REF
1204 && XEXP (XEXP (SET_SRC (tmp), 2), 0) == old_label)
1206 XEXP (SET_SRC (tmp), 2) = gen_rtx_LABEL_REF (Pmode,
1207 new_label);
1208 --LABEL_NUSES (old_label);
1209 ++LABEL_NUSES (new_label);
1212 else if ((tmp = extract_asm_operands (PATTERN (insn))) != NULL)
1214 int i, n = ASM_OPERANDS_LABEL_LENGTH (tmp);
1215 rtx new_label, note;
1217 if (new_bb == EXIT_BLOCK_PTR_FOR_FN (cfun))
1218 return false;
1219 new_label = block_label (new_bb);
1221 for (i = 0; i < n; ++i)
1223 rtx old_ref = ASM_OPERANDS_LABEL (tmp, i);
1224 gcc_assert (GET_CODE (old_ref) == LABEL_REF);
1225 if (XEXP (old_ref, 0) == old_label)
1227 ASM_OPERANDS_LABEL (tmp, i)
1228 = gen_rtx_LABEL_REF (Pmode, new_label);
1229 --LABEL_NUSES (old_label);
1230 ++LABEL_NUSES (new_label);
1234 if (JUMP_LABEL (insn) == old_label)
1236 JUMP_LABEL (insn) = new_label;
1237 note = find_reg_note (insn, REG_LABEL_TARGET, new_label);
1238 if (note)
1239 remove_note (insn, note);
1241 else
1243 note = find_reg_note (insn, REG_LABEL_TARGET, old_label);
1244 if (note)
1245 remove_note (insn, note);
1246 if (JUMP_LABEL (insn) != new_label
1247 && !find_reg_note (insn, REG_LABEL_TARGET, new_label))
1248 add_reg_note (insn, REG_LABEL_TARGET, new_label);
1250 while ((note = find_reg_note (insn, REG_LABEL_OPERAND, old_label))
1251 != NULL_RTX)
1252 XEXP (note, 0) = new_label;
1254 else
1256 /* ?? We may play the games with moving the named labels from
1257 one basic block to the other in case only one computed_jump is
1258 available. */
1259 if (computed_jump_p (insn)
1260 /* A return instruction can't be redirected. */
1261 || returnjump_p (insn))
1262 return false;
1264 if (!currently_expanding_to_rtl || JUMP_LABEL (insn) == old_label)
1266 /* If the insn doesn't go where we think, we're confused. */
1267 gcc_assert (JUMP_LABEL (insn) == old_label);
1269 /* If the substitution doesn't succeed, die. This can happen
1270 if the back end emitted unrecognizable instructions or if
1271 target is exit block on some arches. */
1272 if (!redirect_jump (insn, block_label (new_bb), 0))
1274 gcc_assert (new_bb == EXIT_BLOCK_PTR_FOR_FN (cfun));
1275 return false;
1279 return true;
1283 /* Redirect edge representing branch of (un)conditional jump or tablejump,
1284 NULL on failure */
1285 static edge
1286 redirect_branch_edge (edge e, basic_block target)
1288 rtx old_label = BB_HEAD (e->dest);
1289 basic_block src = e->src;
1290 rtx insn = BB_END (src);
1292 /* We can only redirect non-fallthru edges of jump insn. */
1293 if (e->flags & EDGE_FALLTHRU)
1294 return NULL;
1295 else if (!JUMP_P (insn) && !currently_expanding_to_rtl)
1296 return NULL;
1298 if (!currently_expanding_to_rtl)
1300 if (!patch_jump_insn (insn, old_label, target))
1301 return NULL;
1303 else
1304 /* When expanding this BB might actually contain multiple
1305 jumps (i.e. not yet split by find_many_sub_basic_blocks).
1306 Redirect all of those that match our label. */
1307 FOR_BB_INSNS (src, insn)
1308 if (JUMP_P (insn) && !patch_jump_insn (insn, old_label, target))
1309 return NULL;
1311 if (dump_file)
1312 fprintf (dump_file, "Edge %i->%i redirected to %i\n",
1313 e->src->index, e->dest->index, target->index);
1315 if (e->dest != target)
1316 e = redirect_edge_succ_nodup (e, target);
1318 return e;
1321 /* Called when edge E has been redirected to a new destination,
1322 in order to update the region crossing flag on the edge and
1323 jump. */
1325 static void
1326 fixup_partition_crossing (edge e)
1328 if (e->src == ENTRY_BLOCK_PTR_FOR_FN (cfun) || e->dest
1329 == EXIT_BLOCK_PTR_FOR_FN (cfun))
1330 return;
1331 /* If we redirected an existing edge, it may already be marked
1332 crossing, even though the new src is missing a reg crossing note.
1333 But make sure reg crossing note doesn't already exist before
1334 inserting. */
1335 if (BB_PARTITION (e->src) != BB_PARTITION (e->dest))
1337 e->flags |= EDGE_CROSSING;
1338 if (JUMP_P (BB_END (e->src))
1339 && !CROSSING_JUMP_P (BB_END (e->src)))
1340 CROSSING_JUMP_P (BB_END (e->src)) = 1;
1342 else if (BB_PARTITION (e->src) == BB_PARTITION (e->dest))
1344 e->flags &= ~EDGE_CROSSING;
1345 /* Remove the section crossing note from jump at end of
1346 src if it exists, and if no other successors are
1347 still crossing. */
1348 if (JUMP_P (BB_END (e->src)) && CROSSING_JUMP_P (BB_END (e->src)))
1350 bool has_crossing_succ = false;
1351 edge e2;
1352 edge_iterator ei;
1353 FOR_EACH_EDGE (e2, ei, e->src->succs)
1355 has_crossing_succ |= (e2->flags & EDGE_CROSSING);
1356 if (has_crossing_succ)
1357 break;
1359 if (!has_crossing_succ)
1360 CROSSING_JUMP_P (BB_END (e->src)) = 0;
1365 /* Called when block BB has been reassigned to the cold partition,
1366 because it is now dominated by another cold block,
1367 to ensure that the region crossing attributes are updated. */
1369 static void
1370 fixup_new_cold_bb (basic_block bb)
1372 edge e;
1373 edge_iterator ei;
1375 /* This is called when a hot bb is found to now be dominated
1376 by a cold bb and therefore needs to become cold. Therefore,
1377 its preds will no longer be region crossing. Any non-dominating
1378 preds that were previously hot would also have become cold
1379 in the caller for the same region. Any preds that were previously
1380 region-crossing will be adjusted in fixup_partition_crossing. */
1381 FOR_EACH_EDGE (e, ei, bb->preds)
1383 fixup_partition_crossing (e);
1386 /* Possibly need to make bb's successor edges region crossing,
1387 or remove stale region crossing. */
1388 FOR_EACH_EDGE (e, ei, bb->succs)
1390 /* We can't have fall-through edges across partition boundaries.
1391 Note that force_nonfallthru will do any necessary partition
1392 boundary fixup by calling fixup_partition_crossing itself. */
1393 if ((e->flags & EDGE_FALLTHRU)
1394 && BB_PARTITION (bb) != BB_PARTITION (e->dest)
1395 && e->dest != EXIT_BLOCK_PTR_FOR_FN (cfun))
1396 force_nonfallthru (e);
1397 else
1398 fixup_partition_crossing (e);
1402 /* Attempt to change code to redirect edge E to TARGET. Don't do that on
1403 expense of adding new instructions or reordering basic blocks.
1405 Function can be also called with edge destination equivalent to the TARGET.
1406 Then it should try the simplifications and do nothing if none is possible.
1408 Return edge representing the branch if transformation succeeded. Return NULL
1409 on failure.
1410 We still return NULL in case E already destinated TARGET and we didn't
1411 managed to simplify instruction stream. */
1413 static edge
1414 rtl_redirect_edge_and_branch (edge e, basic_block target)
1416 edge ret;
1417 basic_block src = e->src;
1418 basic_block dest = e->dest;
1420 if (e->flags & (EDGE_ABNORMAL_CALL | EDGE_EH))
1421 return NULL;
1423 if (dest == target)
1424 return e;
1426 if ((ret = try_redirect_by_replacing_jump (e, target, false)) != NULL)
1428 df_set_bb_dirty (src);
1429 fixup_partition_crossing (ret);
1430 return ret;
1433 ret = redirect_branch_edge (e, target);
1434 if (!ret)
1435 return NULL;
1437 df_set_bb_dirty (src);
1438 fixup_partition_crossing (ret);
1439 return ret;
1442 /* Emit a barrier after BB, into the footer if we are in CFGLAYOUT mode. */
1444 void
1445 emit_barrier_after_bb (basic_block bb)
1447 rtx barrier = emit_barrier_after (BB_END (bb));
1448 gcc_assert (current_ir_type () == IR_RTL_CFGRTL
1449 || current_ir_type () == IR_RTL_CFGLAYOUT);
1450 if (current_ir_type () == IR_RTL_CFGLAYOUT)
1451 BB_FOOTER (bb) = unlink_insn_chain (barrier, barrier);
1454 /* Like force_nonfallthru below, but additionally performs redirection
1455 Used by redirect_edge_and_branch_force. JUMP_LABEL is used only
1456 when redirecting to the EXIT_BLOCK, it is either ret_rtx or
1457 simple_return_rtx, indicating which kind of returnjump to create.
1458 It should be NULL otherwise. */
1460 basic_block
1461 force_nonfallthru_and_redirect (edge e, basic_block target, rtx jump_label)
1463 basic_block jump_block, new_bb = NULL, src = e->src;
1464 rtx note;
1465 edge new_edge;
1466 int abnormal_edge_flags = 0;
1467 bool asm_goto_edge = false;
1468 int loc;
1470 /* In the case the last instruction is conditional jump to the next
1471 instruction, first redirect the jump itself and then continue
1472 by creating a basic block afterwards to redirect fallthru edge. */
1473 if (e->src != ENTRY_BLOCK_PTR_FOR_FN (cfun)
1474 && e->dest != EXIT_BLOCK_PTR_FOR_FN (cfun)
1475 && any_condjump_p (BB_END (e->src))
1476 && JUMP_LABEL (BB_END (e->src)) == BB_HEAD (e->dest))
1478 rtx note;
1479 edge b = unchecked_make_edge (e->src, target, 0);
1480 bool redirected;
1482 redirected = redirect_jump (BB_END (e->src), block_label (target), 0);
1483 gcc_assert (redirected);
1485 note = find_reg_note (BB_END (e->src), REG_BR_PROB, NULL_RTX);
1486 if (note)
1488 int prob = XINT (note, 0);
1490 b->probability = prob;
1491 /* Update this to use GCOV_COMPUTE_SCALE. */
1492 b->count = e->count * prob / REG_BR_PROB_BASE;
1493 e->probability -= e->probability;
1494 e->count -= b->count;
1495 if (e->probability < 0)
1496 e->probability = 0;
1497 if (e->count < 0)
1498 e->count = 0;
1502 if (e->flags & EDGE_ABNORMAL)
1504 /* Irritating special case - fallthru edge to the same block as abnormal
1505 edge.
1506 We can't redirect abnormal edge, but we still can split the fallthru
1507 one and create separate abnormal edge to original destination.
1508 This allows bb-reorder to make such edge non-fallthru. */
1509 gcc_assert (e->dest == target);
1510 abnormal_edge_flags = e->flags & ~EDGE_FALLTHRU;
1511 e->flags &= EDGE_FALLTHRU;
1513 else
1515 gcc_assert (e->flags & EDGE_FALLTHRU);
1516 if (e->src == ENTRY_BLOCK_PTR_FOR_FN (cfun))
1518 /* We can't redirect the entry block. Create an empty block
1519 at the start of the function which we use to add the new
1520 jump. */
1521 edge tmp;
1522 edge_iterator ei;
1523 bool found = false;
1525 basic_block bb = create_basic_block (BB_HEAD (e->dest), NULL,
1526 ENTRY_BLOCK_PTR_FOR_FN (cfun));
1528 /* Change the existing edge's source to be the new block, and add
1529 a new edge from the entry block to the new block. */
1530 e->src = bb;
1531 for (ei = ei_start (ENTRY_BLOCK_PTR_FOR_FN (cfun)->succs);
1532 (tmp = ei_safe_edge (ei)); )
1534 if (tmp == e)
1536 ENTRY_BLOCK_PTR_FOR_FN (cfun)->succs->unordered_remove (ei.index);
1537 found = true;
1538 break;
1540 else
1541 ei_next (&ei);
1544 gcc_assert (found);
1546 vec_safe_push (bb->succs, e);
1547 make_single_succ_edge (ENTRY_BLOCK_PTR_FOR_FN (cfun), bb,
1548 EDGE_FALLTHRU);
1552 /* If e->src ends with asm goto, see if any of the ASM_OPERANDS_LABELs
1553 don't point to the target or fallthru label. */
1554 if (JUMP_P (BB_END (e->src))
1555 && target != EXIT_BLOCK_PTR_FOR_FN (cfun)
1556 && (e->flags & EDGE_FALLTHRU)
1557 && (note = extract_asm_operands (PATTERN (BB_END (e->src)))))
1559 int i, n = ASM_OPERANDS_LABEL_LENGTH (note);
1560 bool adjust_jump_target = false;
1562 for (i = 0; i < n; ++i)
1564 if (XEXP (ASM_OPERANDS_LABEL (note, i), 0) == BB_HEAD (e->dest))
1566 LABEL_NUSES (XEXP (ASM_OPERANDS_LABEL (note, i), 0))--;
1567 XEXP (ASM_OPERANDS_LABEL (note, i), 0) = block_label (target);
1568 LABEL_NUSES (XEXP (ASM_OPERANDS_LABEL (note, i), 0))++;
1569 adjust_jump_target = true;
1571 if (XEXP (ASM_OPERANDS_LABEL (note, i), 0) == BB_HEAD (target))
1572 asm_goto_edge = true;
1574 if (adjust_jump_target)
1576 rtx insn = BB_END (e->src), note;
1577 rtx old_label = BB_HEAD (e->dest);
1578 rtx new_label = BB_HEAD (target);
1580 if (JUMP_LABEL (insn) == old_label)
1582 JUMP_LABEL (insn) = new_label;
1583 note = find_reg_note (insn, REG_LABEL_TARGET, new_label);
1584 if (note)
1585 remove_note (insn, note);
1587 else
1589 note = find_reg_note (insn, REG_LABEL_TARGET, old_label);
1590 if (note)
1591 remove_note (insn, note);
1592 if (JUMP_LABEL (insn) != new_label
1593 && !find_reg_note (insn, REG_LABEL_TARGET, new_label))
1594 add_reg_note (insn, REG_LABEL_TARGET, new_label);
1596 while ((note = find_reg_note (insn, REG_LABEL_OPERAND, old_label))
1597 != NULL_RTX)
1598 XEXP (note, 0) = new_label;
1602 if (EDGE_COUNT (e->src->succs) >= 2 || abnormal_edge_flags || asm_goto_edge)
1604 gcov_type count = e->count;
1605 int probability = e->probability;
1606 /* Create the new structures. */
1608 /* If the old block ended with a tablejump, skip its table
1609 by searching forward from there. Otherwise start searching
1610 forward from the last instruction of the old block. */
1611 if (!tablejump_p (BB_END (e->src), NULL, &note))
1612 note = BB_END (e->src);
1613 note = NEXT_INSN (note);
1615 jump_block = create_basic_block (note, NULL, e->src);
1616 jump_block->count = count;
1617 jump_block->frequency = EDGE_FREQUENCY (e);
1619 /* Make sure new block ends up in correct hot/cold section. */
1621 BB_COPY_PARTITION (jump_block, e->src);
1623 /* Wire edge in. */
1624 new_edge = make_edge (e->src, jump_block, EDGE_FALLTHRU);
1625 new_edge->probability = probability;
1626 new_edge->count = count;
1628 /* Redirect old edge. */
1629 redirect_edge_pred (e, jump_block);
1630 e->probability = REG_BR_PROB_BASE;
1632 /* If e->src was previously region crossing, it no longer is
1633 and the reg crossing note should be removed. */
1634 fixup_partition_crossing (new_edge);
1636 /* If asm goto has any label refs to target's label,
1637 add also edge from asm goto bb to target. */
1638 if (asm_goto_edge)
1640 new_edge->probability /= 2;
1641 new_edge->count /= 2;
1642 jump_block->count /= 2;
1643 jump_block->frequency /= 2;
1644 new_edge = make_edge (new_edge->src, target,
1645 e->flags & ~EDGE_FALLTHRU);
1646 new_edge->probability = probability - probability / 2;
1647 new_edge->count = count - count / 2;
1650 new_bb = jump_block;
1652 else
1653 jump_block = e->src;
1655 loc = e->goto_locus;
1656 e->flags &= ~EDGE_FALLTHRU;
1657 if (target == EXIT_BLOCK_PTR_FOR_FN (cfun))
1659 if (jump_label == ret_rtx)
1661 #ifdef HAVE_return
1662 emit_jump_insn_after_setloc (gen_return (), BB_END (jump_block), loc);
1663 #else
1664 gcc_unreachable ();
1665 #endif
1667 else
1669 gcc_assert (jump_label == simple_return_rtx);
1670 #ifdef HAVE_simple_return
1671 emit_jump_insn_after_setloc (gen_simple_return (),
1672 BB_END (jump_block), loc);
1673 #else
1674 gcc_unreachable ();
1675 #endif
1677 set_return_jump_label (BB_END (jump_block));
1679 else
1681 rtx label = block_label (target);
1682 emit_jump_insn_after_setloc (gen_jump (label), BB_END (jump_block), loc);
1683 JUMP_LABEL (BB_END (jump_block)) = label;
1684 LABEL_NUSES (label)++;
1687 /* We might be in cfg layout mode, and if so, the following routine will
1688 insert the barrier correctly. */
1689 emit_barrier_after_bb (jump_block);
1690 redirect_edge_succ_nodup (e, target);
1692 if (abnormal_edge_flags)
1693 make_edge (src, target, abnormal_edge_flags);
1695 df_mark_solutions_dirty ();
1696 fixup_partition_crossing (e);
1697 return new_bb;
1700 /* Edge E is assumed to be fallthru edge. Emit needed jump instruction
1701 (and possibly create new basic block) to make edge non-fallthru.
1702 Return newly created BB or NULL if none. */
1704 static basic_block
1705 rtl_force_nonfallthru (edge e)
1707 return force_nonfallthru_and_redirect (e, e->dest, NULL_RTX);
1710 /* Redirect edge even at the expense of creating new jump insn or
1711 basic block. Return new basic block if created, NULL otherwise.
1712 Conversion must be possible. */
1714 static basic_block
1715 rtl_redirect_edge_and_branch_force (edge e, basic_block target)
1717 if (redirect_edge_and_branch (e, target)
1718 || e->dest == target)
1719 return NULL;
1721 /* In case the edge redirection failed, try to force it to be non-fallthru
1722 and redirect newly created simplejump. */
1723 df_set_bb_dirty (e->src);
1724 return force_nonfallthru_and_redirect (e, target, NULL_RTX);
1727 /* The given edge should potentially be a fallthru edge. If that is in
1728 fact true, delete the jump and barriers that are in the way. */
1730 static void
1731 rtl_tidy_fallthru_edge (edge e)
1733 rtx q;
1734 basic_block b = e->src, c = b->next_bb;
1736 /* ??? In a late-running flow pass, other folks may have deleted basic
1737 blocks by nopping out blocks, leaving multiple BARRIERs between here
1738 and the target label. They ought to be chastised and fixed.
1740 We can also wind up with a sequence of undeletable labels between
1741 one block and the next.
1743 So search through a sequence of barriers, labels, and notes for
1744 the head of block C and assert that we really do fall through. */
1746 for (q = NEXT_INSN (BB_END (b)); q != BB_HEAD (c); q = NEXT_INSN (q))
1747 if (INSN_P (q))
1748 return;
1750 /* Remove what will soon cease being the jump insn from the source block.
1751 If block B consisted only of this single jump, turn it into a deleted
1752 note. */
1753 q = BB_END (b);
1754 if (JUMP_P (q)
1755 && onlyjump_p (q)
1756 && (any_uncondjump_p (q)
1757 || single_succ_p (b)))
1759 #ifdef HAVE_cc0
1760 /* If this was a conditional jump, we need to also delete
1761 the insn that set cc0. */
1762 if (any_condjump_p (q) && only_sets_cc0_p (PREV_INSN (q)))
1763 q = PREV_INSN (q);
1764 #endif
1766 q = PREV_INSN (q);
1769 /* Selectively unlink the sequence. */
1770 if (q != PREV_INSN (BB_HEAD (c)))
1771 delete_insn_chain (NEXT_INSN (q), PREV_INSN (BB_HEAD (c)), false);
1773 e->flags |= EDGE_FALLTHRU;
1776 /* Should move basic block BB after basic block AFTER. NIY. */
1778 static bool
1779 rtl_move_block_after (basic_block bb ATTRIBUTE_UNUSED,
1780 basic_block after ATTRIBUTE_UNUSED)
1782 return false;
1785 /* Locate the last bb in the same partition as START_BB. */
1787 static basic_block
1788 last_bb_in_partition (basic_block start_bb)
1790 basic_block bb;
1791 FOR_BB_BETWEEN (bb, start_bb, EXIT_BLOCK_PTR_FOR_FN (cfun), next_bb)
1793 if (BB_PARTITION (start_bb) != BB_PARTITION (bb->next_bb))
1794 return bb;
1796 /* Return bb before the exit block. */
1797 return bb->prev_bb;
1800 /* Split a (typically critical) edge. Return the new block.
1801 The edge must not be abnormal.
1803 ??? The code generally expects to be called on critical edges.
1804 The case of a block ending in an unconditional jump to a
1805 block with multiple predecessors is not handled optimally. */
1807 static basic_block
1808 rtl_split_edge (edge edge_in)
1810 basic_block bb, new_bb;
1811 rtx before;
1813 /* Abnormal edges cannot be split. */
1814 gcc_assert (!(edge_in->flags & EDGE_ABNORMAL));
1816 /* We are going to place the new block in front of edge destination.
1817 Avoid existence of fallthru predecessors. */
1818 if ((edge_in->flags & EDGE_FALLTHRU) == 0)
1820 edge e = find_fallthru_edge (edge_in->dest->preds);
1822 if (e)
1823 force_nonfallthru (e);
1826 /* Create the basic block note. */
1827 if (edge_in->dest != EXIT_BLOCK_PTR_FOR_FN (cfun))
1828 before = BB_HEAD (edge_in->dest);
1829 else
1830 before = NULL_RTX;
1832 /* If this is a fall through edge to the exit block, the blocks might be
1833 not adjacent, and the right place is after the source. */
1834 if ((edge_in->flags & EDGE_FALLTHRU)
1835 && edge_in->dest == EXIT_BLOCK_PTR_FOR_FN (cfun))
1837 before = NEXT_INSN (BB_END (edge_in->src));
1838 bb = create_basic_block (before, NULL, edge_in->src);
1839 BB_COPY_PARTITION (bb, edge_in->src);
1841 else
1843 if (edge_in->src == ENTRY_BLOCK_PTR_FOR_FN (cfun))
1845 bb = create_basic_block (before, NULL, edge_in->dest->prev_bb);
1846 BB_COPY_PARTITION (bb, edge_in->dest);
1848 else
1850 basic_block after = edge_in->dest->prev_bb;
1851 /* If this is post-bb reordering, and the edge crosses a partition
1852 boundary, the new block needs to be inserted in the bb chain
1853 at the end of the src partition (since we put the new bb into
1854 that partition, see below). Otherwise we may end up creating
1855 an extra partition crossing in the chain, which is illegal.
1856 It can't go after the src, because src may have a fall-through
1857 to a different block. */
1858 if (crtl->bb_reorder_complete
1859 && (edge_in->flags & EDGE_CROSSING))
1861 after = last_bb_in_partition (edge_in->src);
1862 before = NEXT_INSN (BB_END (after));
1863 /* The instruction following the last bb in partition should
1864 be a barrier, since it cannot end in a fall-through. */
1865 gcc_checking_assert (BARRIER_P (before));
1866 before = NEXT_INSN (before);
1868 bb = create_basic_block (before, NULL, after);
1869 /* Put the split bb into the src partition, to avoid creating
1870 a situation where a cold bb dominates a hot bb, in the case
1871 where src is cold and dest is hot. The src will dominate
1872 the new bb (whereas it might not have dominated dest). */
1873 BB_COPY_PARTITION (bb, edge_in->src);
1877 make_single_succ_edge (bb, edge_in->dest, EDGE_FALLTHRU);
1879 /* Can't allow a region crossing edge to be fallthrough. */
1880 if (BB_PARTITION (bb) != BB_PARTITION (edge_in->dest)
1881 && edge_in->dest != EXIT_BLOCK_PTR_FOR_FN (cfun))
1883 new_bb = force_nonfallthru (single_succ_edge (bb));
1884 gcc_assert (!new_bb);
1887 /* For non-fallthru edges, we must adjust the predecessor's
1888 jump instruction to target our new block. */
1889 if ((edge_in->flags & EDGE_FALLTHRU) == 0)
1891 edge redirected = redirect_edge_and_branch (edge_in, bb);
1892 gcc_assert (redirected);
1894 else
1896 if (edge_in->src != ENTRY_BLOCK_PTR_FOR_FN (cfun))
1898 /* For asm goto even splitting of fallthru edge might
1899 need insn patching, as other labels might point to the
1900 old label. */
1901 rtx last = BB_END (edge_in->src);
1902 if (last
1903 && JUMP_P (last)
1904 && edge_in->dest != EXIT_BLOCK_PTR_FOR_FN (cfun)
1905 && extract_asm_operands (PATTERN (last)) != NULL_RTX
1906 && patch_jump_insn (last, before, bb))
1907 df_set_bb_dirty (edge_in->src);
1909 redirect_edge_succ (edge_in, bb);
1912 return bb;
1915 /* Queue instructions for insertion on an edge between two basic blocks.
1916 The new instructions and basic blocks (if any) will not appear in the
1917 CFG until commit_edge_insertions is called. */
1919 void
1920 insert_insn_on_edge (rtx pattern, edge e)
1922 /* We cannot insert instructions on an abnormal critical edge.
1923 It will be easier to find the culprit if we die now. */
1924 gcc_assert (!((e->flags & EDGE_ABNORMAL) && EDGE_CRITICAL_P (e)));
1926 if (e->insns.r == NULL_RTX)
1927 start_sequence ();
1928 else
1929 push_to_sequence (e->insns.r);
1931 emit_insn (pattern);
1933 e->insns.r = get_insns ();
1934 end_sequence ();
1937 /* Update the CFG for the instructions queued on edge E. */
1939 void
1940 commit_one_edge_insertion (edge e)
1942 rtx before = NULL_RTX, after = NULL_RTX, insns, tmp, last;
1943 basic_block bb;
1945 /* Pull the insns off the edge now since the edge might go away. */
1946 insns = e->insns.r;
1947 e->insns.r = NULL_RTX;
1949 /* Figure out where to put these insns. If the destination has
1950 one predecessor, insert there. Except for the exit block. */
1951 if (single_pred_p (e->dest) && e->dest != EXIT_BLOCK_PTR_FOR_FN (cfun))
1953 bb = e->dest;
1955 /* Get the location correct wrt a code label, and "nice" wrt
1956 a basic block note, and before everything else. */
1957 tmp = BB_HEAD (bb);
1958 if (LABEL_P (tmp))
1959 tmp = NEXT_INSN (tmp);
1960 if (NOTE_INSN_BASIC_BLOCK_P (tmp))
1961 tmp = NEXT_INSN (tmp);
1962 if (tmp == BB_HEAD (bb))
1963 before = tmp;
1964 else if (tmp)
1965 after = PREV_INSN (tmp);
1966 else
1967 after = get_last_insn ();
1970 /* If the source has one successor and the edge is not abnormal,
1971 insert there. Except for the entry block.
1972 Don't do this if the predecessor ends in a jump other than
1973 unconditional simple jump. E.g. for asm goto that points all
1974 its labels at the fallthru basic block, we can't insert instructions
1975 before the asm goto, as the asm goto can have various of side effects,
1976 and can't emit instructions after the asm goto, as it must end
1977 the basic block. */
1978 else if ((e->flags & EDGE_ABNORMAL) == 0
1979 && single_succ_p (e->src)
1980 && e->src != ENTRY_BLOCK_PTR_FOR_FN (cfun)
1981 && (!JUMP_P (BB_END (e->src))
1982 || simplejump_p (BB_END (e->src))))
1984 bb = e->src;
1986 /* It is possible to have a non-simple jump here. Consider a target
1987 where some forms of unconditional jumps clobber a register. This
1988 happens on the fr30 for example.
1990 We know this block has a single successor, so we can just emit
1991 the queued insns before the jump. */
1992 if (JUMP_P (BB_END (bb)))
1993 before = BB_END (bb);
1994 else
1996 /* We'd better be fallthru, or we've lost track of what's what. */
1997 gcc_assert (e->flags & EDGE_FALLTHRU);
1999 after = BB_END (bb);
2003 /* Otherwise we must split the edge. */
2004 else
2006 bb = split_edge (e);
2008 /* If E crossed a partition boundary, we needed to make bb end in
2009 a region-crossing jump, even though it was originally fallthru. */
2010 if (JUMP_P (BB_END (bb)))
2011 before = BB_END (bb);
2012 else
2013 after = BB_END (bb);
2016 /* Now that we've found the spot, do the insertion. */
2017 if (before)
2019 emit_insn_before_noloc (insns, before, bb);
2020 last = prev_nonnote_insn (before);
2022 else
2023 last = emit_insn_after_noloc (insns, after, bb);
2025 if (returnjump_p (last))
2027 /* ??? Remove all outgoing edges from BB and add one for EXIT.
2028 This is not currently a problem because this only happens
2029 for the (single) epilogue, which already has a fallthru edge
2030 to EXIT. */
2032 e = single_succ_edge (bb);
2033 gcc_assert (e->dest == EXIT_BLOCK_PTR_FOR_FN (cfun)
2034 && single_succ_p (bb) && (e->flags & EDGE_FALLTHRU));
2036 e->flags &= ~EDGE_FALLTHRU;
2037 emit_barrier_after (last);
2039 if (before)
2040 delete_insn (before);
2042 else
2043 gcc_assert (!JUMP_P (last));
2046 /* Update the CFG for all queued instructions. */
2048 void
2049 commit_edge_insertions (void)
2051 basic_block bb;
2053 /* Optimization passes that invoke this routine can cause hot blocks
2054 previously reached by both hot and cold blocks to become dominated only
2055 by cold blocks. This will cause the verification below to fail,
2056 and lead to now cold code in the hot section. In some cases this
2057 may only be visible after newly unreachable blocks are deleted,
2058 which will be done by fixup_partitions. */
2059 fixup_partitions ();
2061 #ifdef ENABLE_CHECKING
2062 verify_flow_info ();
2063 #endif
2065 FOR_BB_BETWEEN (bb, ENTRY_BLOCK_PTR_FOR_FN (cfun),
2066 EXIT_BLOCK_PTR_FOR_FN (cfun), next_bb)
2068 edge e;
2069 edge_iterator ei;
2071 FOR_EACH_EDGE (e, ei, bb->succs)
2072 if (e->insns.r)
2073 commit_one_edge_insertion (e);
2078 /* Print out RTL-specific basic block information (live information
2079 at start and end with TDF_DETAILS). FLAGS are the TDF_* masks
2080 documented in dumpfile.h. */
2082 static void
2083 rtl_dump_bb (FILE *outf, basic_block bb, int indent, int flags)
2085 rtx insn;
2086 rtx last;
2087 char *s_indent;
2089 s_indent = (char *) alloca ((size_t) indent + 1);
2090 memset (s_indent, ' ', (size_t) indent);
2091 s_indent[indent] = '\0';
2093 if (df && (flags & TDF_DETAILS))
2095 df_dump_top (bb, outf);
2096 putc ('\n', outf);
2099 if (bb->index != ENTRY_BLOCK && bb->index != EXIT_BLOCK)
2100 for (insn = BB_HEAD (bb), last = NEXT_INSN (BB_END (bb)); insn != last;
2101 insn = NEXT_INSN (insn))
2103 if (flags & TDF_DETAILS)
2104 df_dump_insn_top (insn, outf);
2105 if (! (flags & TDF_SLIM))
2106 print_rtl_single (outf, insn);
2107 else
2108 dump_insn_slim (outf, insn);
2109 if (flags & TDF_DETAILS)
2110 df_dump_insn_bottom (insn, outf);
2113 if (df && (flags & TDF_DETAILS))
2115 df_dump_bottom (bb, outf);
2116 putc ('\n', outf);
2121 /* Like dump_function_to_file, but for RTL. Print out dataflow information
2122 for the start of each basic block. FLAGS are the TDF_* masks documented
2123 in dumpfile.h. */
2125 void
2126 print_rtl_with_bb (FILE *outf, const_rtx rtx_first, int flags)
2128 const_rtx tmp_rtx;
2129 if (rtx_first == 0)
2130 fprintf (outf, "(nil)\n");
2131 else
2133 enum bb_state { NOT_IN_BB, IN_ONE_BB, IN_MULTIPLE_BB };
2134 int max_uid = get_max_uid ();
2135 basic_block *start = XCNEWVEC (basic_block, max_uid);
2136 basic_block *end = XCNEWVEC (basic_block, max_uid);
2137 enum bb_state *in_bb_p = XCNEWVEC (enum bb_state, max_uid);
2138 basic_block bb;
2140 /* After freeing the CFG, we still have BLOCK_FOR_INSN set on most
2141 insns, but the CFG is not maintained so the basic block info
2142 is not reliable. Therefore it's omitted from the dumps. */
2143 if (! (cfun->curr_properties & PROP_cfg))
2144 flags &= ~TDF_BLOCKS;
2146 if (df)
2147 df_dump_start (outf);
2149 if (flags & TDF_BLOCKS)
2151 FOR_EACH_BB_REVERSE_FN (bb, cfun)
2153 rtx x;
2155 start[INSN_UID (BB_HEAD (bb))] = bb;
2156 end[INSN_UID (BB_END (bb))] = bb;
2157 for (x = BB_HEAD (bb); x != NULL_RTX; x = NEXT_INSN (x))
2159 enum bb_state state = IN_MULTIPLE_BB;
2161 if (in_bb_p[INSN_UID (x)] == NOT_IN_BB)
2162 state = IN_ONE_BB;
2163 in_bb_p[INSN_UID (x)] = state;
2165 if (x == BB_END (bb))
2166 break;
2171 for (tmp_rtx = rtx_first; NULL != tmp_rtx; tmp_rtx = NEXT_INSN (tmp_rtx))
2173 if (flags & TDF_BLOCKS)
2175 bb = start[INSN_UID (tmp_rtx)];
2176 if (bb != NULL)
2178 dump_bb_info (outf, bb, 0, dump_flags | TDF_COMMENT, true, false);
2179 if (df && (flags & TDF_DETAILS))
2180 df_dump_top (bb, outf);
2183 if (in_bb_p[INSN_UID (tmp_rtx)] == NOT_IN_BB
2184 && !NOTE_P (tmp_rtx)
2185 && !BARRIER_P (tmp_rtx))
2186 fprintf (outf, ";; Insn is not within a basic block\n");
2187 else if (in_bb_p[INSN_UID (tmp_rtx)] == IN_MULTIPLE_BB)
2188 fprintf (outf, ";; Insn is in multiple basic blocks\n");
2191 if (flags & TDF_DETAILS)
2192 df_dump_insn_top (tmp_rtx, outf);
2193 if (! (flags & TDF_SLIM))
2194 print_rtl_single (outf, tmp_rtx);
2195 else
2196 dump_insn_slim (outf, tmp_rtx);
2197 if (flags & TDF_DETAILS)
2198 df_dump_insn_bottom (tmp_rtx, outf);
2200 if (flags & TDF_BLOCKS)
2202 bb = end[INSN_UID (tmp_rtx)];
2203 if (bb != NULL)
2205 dump_bb_info (outf, bb, 0, dump_flags | TDF_COMMENT, false, true);
2206 if (df && (flags & TDF_DETAILS))
2207 df_dump_bottom (bb, outf);
2208 putc ('\n', outf);
2213 free (start);
2214 free (end);
2215 free (in_bb_p);
2219 /* Update the branch probability of BB if a REG_BR_PROB is present. */
2221 void
2222 update_br_prob_note (basic_block bb)
2224 rtx note;
2225 if (!JUMP_P (BB_END (bb)))
2226 return;
2227 note = find_reg_note (BB_END (bb), REG_BR_PROB, NULL_RTX);
2228 if (!note || XINT (note, 0) == BRANCH_EDGE (bb)->probability)
2229 return;
2230 XINT (note, 0) = BRANCH_EDGE (bb)->probability;
2233 /* Get the last insn associated with block BB (that includes barriers and
2234 tablejumps after BB). */
2236 get_last_bb_insn (basic_block bb)
2238 rtx tmp;
2239 rtx end = BB_END (bb);
2241 /* Include any jump table following the basic block. */
2242 if (tablejump_p (end, NULL, &tmp))
2243 end = tmp;
2245 /* Include any barriers that may follow the basic block. */
2246 tmp = next_nonnote_insn_bb (end);
2247 while (tmp && BARRIER_P (tmp))
2249 end = tmp;
2250 tmp = next_nonnote_insn_bb (end);
2253 return end;
2256 /* Sanity check partition hotness to ensure that basic blocks in
2257   the cold partition don't dominate basic blocks in the hot partition.
2258 If FLAG_ONLY is true, report violations as errors. Otherwise
2259 re-mark the dominated blocks as cold, since this is run after
2260 cfg optimizations that may make hot blocks previously reached
2261 by both hot and cold blocks now only reachable along cold paths. */
2263 static vec<basic_block>
2264 find_partition_fixes (bool flag_only)
2266 basic_block bb;
2267 vec<basic_block> bbs_in_cold_partition = vNULL;
2268 vec<basic_block> bbs_to_fix = vNULL;
2270 /* Callers check this. */
2271 gcc_checking_assert (crtl->has_bb_partition);
2273 FOR_EACH_BB_FN (bb, cfun)
2274 if ((BB_PARTITION (bb) == BB_COLD_PARTITION))
2275 bbs_in_cold_partition.safe_push (bb);
2277 if (bbs_in_cold_partition.is_empty ())
2278 return vNULL;
2280 bool dom_calculated_here = !dom_info_available_p (CDI_DOMINATORS);
2282 if (dom_calculated_here)
2283 calculate_dominance_info (CDI_DOMINATORS);
2285 while (! bbs_in_cold_partition.is_empty ())
2287 bb = bbs_in_cold_partition.pop ();
2288 /* Any blocks dominated by a block in the cold section
2289 must also be cold. */
2290 basic_block son;
2291 for (son = first_dom_son (CDI_DOMINATORS, bb);
2292 son;
2293 son = next_dom_son (CDI_DOMINATORS, son))
2295 /* If son is not yet cold, then mark it cold here and
2296 enqueue it for further processing. */
2297 if ((BB_PARTITION (son) != BB_COLD_PARTITION))
2299 if (flag_only)
2300 error ("non-cold basic block %d dominated "
2301 "by a block in the cold partition (%d)", son->index, bb->index);
2302 else
2303 BB_SET_PARTITION (son, BB_COLD_PARTITION);
2304 bbs_to_fix.safe_push (son);
2305 bbs_in_cold_partition.safe_push (son);
2310 if (dom_calculated_here)
2311 free_dominance_info (CDI_DOMINATORS);
2313 return bbs_to_fix;
2316 /* Perform cleanup on the hot/cold bb partitioning after optimization
2317 passes that modify the cfg. */
2319 void
2320 fixup_partitions (void)
2322 basic_block bb;
2324 if (!crtl->has_bb_partition)
2325 return;
2327 /* Delete any blocks that became unreachable and weren't
2328 already cleaned up, for example during edge forwarding
2329 and convert_jumps_to_returns. This will expose more
2330 opportunities for fixing the partition boundaries here.
2331 Also, the calculation of the dominance graph during verification
2332 will assert if there are unreachable nodes. */
2333 delete_unreachable_blocks ();
2335 /* If there are partitions, do a sanity check on them: A basic block in
2336   a cold partition cannot dominate a basic block in a hot partition.
2337 Fixup any that now violate this requirement, as a result of edge
2338 forwarding and unreachable block deletion.  */
2339 vec<basic_block> bbs_to_fix = find_partition_fixes (false);
2341 /* Do the partition fixup after all necessary blocks have been converted to
2342 cold, so that we only update the region crossings the minimum number of
2343 places, which can require forcing edges to be non fallthru. */
2344 while (! bbs_to_fix.is_empty ())
2346 bb = bbs_to_fix.pop ();
2347 fixup_new_cold_bb (bb);
2351 /* Verify, in the basic block chain, that there is at most one switch
2352 between hot/cold partitions. This condition will not be true until
2353 after reorder_basic_blocks is called. */
2355 static int
2356 verify_hot_cold_block_grouping (void)
2358 basic_block bb;
2359 int err = 0;
2360 bool switched_sections = false;
2361 int current_partition = BB_UNPARTITIONED;
2363 /* Even after bb reordering is complete, we go into cfglayout mode
2364 again (in compgoto). Ensure we don't call this before going back
2365 into linearized RTL when any layout fixes would have been committed. */
2366 if (!crtl->bb_reorder_complete
2367 || current_ir_type () != IR_RTL_CFGRTL)
2368 return err;
2370 FOR_EACH_BB_FN (bb, cfun)
2372 if (current_partition != BB_UNPARTITIONED
2373 && BB_PARTITION (bb) != current_partition)
2375 if (switched_sections)
2377 error ("multiple hot/cold transitions found (bb %i)",
2378 bb->index);
2379 err = 1;
2381 else
2382 switched_sections = true;
2384 if (!crtl->has_bb_partition)
2385 error ("partition found but function partition flag not set");
2387 current_partition = BB_PARTITION (bb);
2390 return err;
2394 /* Perform several checks on the edges out of each block, such as
2395 the consistency of the branch probabilities, the correctness
2396 of hot/cold partition crossing edges, and the number of expected
2397 successor edges. Also verify that the dominance relationship
2398 between hot/cold blocks is sane. */
2400 static int
2401 rtl_verify_edges (void)
2403 int err = 0;
2404 basic_block bb;
2406 FOR_EACH_BB_REVERSE_FN (bb, cfun)
2408 int n_fallthru = 0, n_branch = 0, n_abnormal_call = 0, n_sibcall = 0;
2409 int n_eh = 0, n_abnormal = 0;
2410 edge e, fallthru = NULL;
2411 edge_iterator ei;
2412 rtx note;
2413 bool has_crossing_edge = false;
2415 if (JUMP_P (BB_END (bb))
2416 && (note = find_reg_note (BB_END (bb), REG_BR_PROB, NULL_RTX))
2417 && EDGE_COUNT (bb->succs) >= 2
2418 && any_condjump_p (BB_END (bb)))
2420 if (XINT (note, 0) != BRANCH_EDGE (bb)->probability
2421 && profile_status_for_fn (cfun) != PROFILE_ABSENT)
2423 error ("verify_flow_info: REG_BR_PROB does not match cfg %i %i",
2424 XINT (note, 0), BRANCH_EDGE (bb)->probability);
2425 err = 1;
2429 FOR_EACH_EDGE (e, ei, bb->succs)
2431 bool is_crossing;
2433 if (e->flags & EDGE_FALLTHRU)
2434 n_fallthru++, fallthru = e;
2436 is_crossing = (BB_PARTITION (e->src) != BB_PARTITION (e->dest)
2437 && e->src != ENTRY_BLOCK_PTR_FOR_FN (cfun)
2438 && e->dest != EXIT_BLOCK_PTR_FOR_FN (cfun));
2439 has_crossing_edge |= is_crossing;
2440 if (e->flags & EDGE_CROSSING)
2442 if (!is_crossing)
2444 error ("EDGE_CROSSING incorrectly set across same section");
2445 err = 1;
2447 if (e->flags & EDGE_FALLTHRU)
2449 error ("fallthru edge crosses section boundary in bb %i",
2450 e->src->index);
2451 err = 1;
2453 if (e->flags & EDGE_EH)
2455 error ("EH edge crosses section boundary in bb %i",
2456 e->src->index);
2457 err = 1;
2459 if (JUMP_P (BB_END (bb)) && !CROSSING_JUMP_P (BB_END (bb)))
2461 error ("No region crossing jump at section boundary in bb %i",
2462 bb->index);
2463 err = 1;
2466 else if (is_crossing)
2468 error ("EDGE_CROSSING missing across section boundary");
2469 err = 1;
2472 if ((e->flags & ~(EDGE_DFS_BACK
2473 | EDGE_CAN_FALLTHRU
2474 | EDGE_IRREDUCIBLE_LOOP
2475 | EDGE_LOOP_EXIT
2476 | EDGE_CROSSING
2477 | EDGE_PRESERVE)) == 0)
2478 n_branch++;
2480 if (e->flags & EDGE_ABNORMAL_CALL)
2481 n_abnormal_call++;
2483 if (e->flags & EDGE_SIBCALL)
2484 n_sibcall++;
2486 if (e->flags & EDGE_EH)
2487 n_eh++;
2489 if (e->flags & EDGE_ABNORMAL)
2490 n_abnormal++;
2493 if (!has_crossing_edge
2494 && JUMP_P (BB_END (bb))
2495 && CROSSING_JUMP_P (BB_END (bb)))
2497 print_rtl_with_bb (stderr, get_insns (), TDF_RTL | TDF_BLOCKS | TDF_DETAILS);
2498 error ("Region crossing jump across same section in bb %i",
2499 bb->index);
2500 err = 1;
2503 if (n_eh && !find_reg_note (BB_END (bb), REG_EH_REGION, NULL_RTX))
2505 error ("missing REG_EH_REGION note at the end of bb %i", bb->index);
2506 err = 1;
2508 if (n_eh > 1)
2510 error ("too many exception handling edges in bb %i", bb->index);
2511 err = 1;
2513 if (n_branch
2514 && (!JUMP_P (BB_END (bb))
2515 || (n_branch > 1 && (any_uncondjump_p (BB_END (bb))
2516 || any_condjump_p (BB_END (bb))))))
2518 error ("too many outgoing branch edges from bb %i", bb->index);
2519 err = 1;
2521 if (n_fallthru && any_uncondjump_p (BB_END (bb)))
2523 error ("fallthru edge after unconditional jump in bb %i", bb->index);
2524 err = 1;
2526 if (n_branch != 1 && any_uncondjump_p (BB_END (bb)))
2528 error ("wrong number of branch edges after unconditional jump"
2529 " in bb %i", bb->index);
2530 err = 1;
2532 if (n_branch != 1 && any_condjump_p (BB_END (bb))
2533 && JUMP_LABEL (BB_END (bb)) != BB_HEAD (fallthru->dest))
2535 error ("wrong amount of branch edges after conditional jump"
2536 " in bb %i", bb->index);
2537 err = 1;
2539 if (n_abnormal_call && !CALL_P (BB_END (bb)))
2541 error ("abnormal call edges for non-call insn in bb %i", bb->index);
2542 err = 1;
2544 if (n_sibcall && !CALL_P (BB_END (bb)))
2546 error ("sibcall edges for non-call insn in bb %i", bb->index);
2547 err = 1;
2549 if (n_abnormal > n_eh
2550 && !(CALL_P (BB_END (bb))
2551 && n_abnormal == n_abnormal_call + n_sibcall)
2552 && (!JUMP_P (BB_END (bb))
2553 || any_condjump_p (BB_END (bb))
2554 || any_uncondjump_p (BB_END (bb))))
2556 error ("abnormal edges for no purpose in bb %i", bb->index);
2557 err = 1;
2561 /* If there are partitions, do a sanity check on them: A basic block in
2562   a cold partition cannot dominate a basic block in a hot partition.  */
2563 if (crtl->has_bb_partition && !err)
2565 vec<basic_block> bbs_to_fix = find_partition_fixes (true);
2566 err = !bbs_to_fix.is_empty ();
2569 /* Clean up. */
2570 return err;
2573 /* Checks on the instructions within blocks. Currently checks that each
2574 block starts with a basic block note, and that basic block notes and
2575 control flow jumps are not found in the middle of the block. */
2577 static int
2578 rtl_verify_bb_insns (void)
2580 rtx x;
2581 int err = 0;
2582 basic_block bb;
2584 FOR_EACH_BB_REVERSE_FN (bb, cfun)
2586 /* Now check the header of basic
2587 block. It ought to contain optional CODE_LABEL followed
2588 by NOTE_BASIC_BLOCK. */
2589 x = BB_HEAD (bb);
2590 if (LABEL_P (x))
2592 if (BB_END (bb) == x)
2594 error ("NOTE_INSN_BASIC_BLOCK is missing for block %d",
2595 bb->index);
2596 err = 1;
2599 x = NEXT_INSN (x);
2602 if (!NOTE_INSN_BASIC_BLOCK_P (x) || NOTE_BASIC_BLOCK (x) != bb)
2604 error ("NOTE_INSN_BASIC_BLOCK is missing for block %d",
2605 bb->index);
2606 err = 1;
2609 if (BB_END (bb) == x)
2610 /* Do checks for empty blocks here. */
2612 else
2613 for (x = NEXT_INSN (x); x; x = NEXT_INSN (x))
2615 if (NOTE_INSN_BASIC_BLOCK_P (x))
2617 error ("NOTE_INSN_BASIC_BLOCK %d in middle of basic block %d",
2618 INSN_UID (x), bb->index);
2619 err = 1;
2622 if (x == BB_END (bb))
2623 break;
2625 if (control_flow_insn_p (x))
2627 error ("in basic block %d:", bb->index);
2628 fatal_insn ("flow control insn inside a basic block", x);
2633 /* Clean up. */
2634 return err;
2637 /* Verify that block pointers for instructions in basic blocks, headers and
2638 footers are set appropriately. */
2640 static int
2641 rtl_verify_bb_pointers (void)
2643 int err = 0;
2644 basic_block bb;
2646 /* Check the general integrity of the basic blocks. */
2647 FOR_EACH_BB_REVERSE_FN (bb, cfun)
2649 rtx insn;
2651 if (!(bb->flags & BB_RTL))
2653 error ("BB_RTL flag not set for block %d", bb->index);
2654 err = 1;
2657 FOR_BB_INSNS (bb, insn)
2658 if (BLOCK_FOR_INSN (insn) != bb)
2660 error ("insn %d basic block pointer is %d, should be %d",
2661 INSN_UID (insn),
2662 BLOCK_FOR_INSN (insn) ? BLOCK_FOR_INSN (insn)->index : 0,
2663 bb->index);
2664 err = 1;
2667 for (insn = BB_HEADER (bb); insn; insn = NEXT_INSN (insn))
2668 if (!BARRIER_P (insn)
2669 && BLOCK_FOR_INSN (insn) != NULL)
2671 error ("insn %d in header of bb %d has non-NULL basic block",
2672 INSN_UID (insn), bb->index);
2673 err = 1;
2675 for (insn = BB_FOOTER (bb); insn; insn = NEXT_INSN (insn))
2676 if (!BARRIER_P (insn)
2677 && BLOCK_FOR_INSN (insn) != NULL)
2679 error ("insn %d in footer of bb %d has non-NULL basic block",
2680 INSN_UID (insn), bb->index);
2681 err = 1;
2685 /* Clean up. */
2686 return err;
2689 /* Verify the CFG and RTL consistency common for both underlying RTL and
2690 cfglayout RTL.
2692 Currently it does following checks:
2694 - overlapping of basic blocks
2695 - insns with wrong BLOCK_FOR_INSN pointers
2696 - headers of basic blocks (the NOTE_INSN_BASIC_BLOCK note)
2697 - tails of basic blocks (ensure that boundary is necessary)
2698 - scans body of the basic block for JUMP_INSN, CODE_LABEL
2699 and NOTE_INSN_BASIC_BLOCK
2700 - verify that no fall_thru edge crosses hot/cold partition boundaries
2701 - verify that there are no pending RTL branch predictions
2702 - verify that hot blocks are not dominated by cold blocks
2704 In future it can be extended check a lot of other stuff as well
2705 (reachability of basic blocks, life information, etc. etc.). */
2707 static int
2708 rtl_verify_flow_info_1 (void)
2710 int err = 0;
2712 err |= rtl_verify_bb_pointers ();
2714 err |= rtl_verify_bb_insns ();
2716 err |= rtl_verify_edges ();
2718 return err;
2721 /* Walk the instruction chain and verify that bb head/end pointers
2722 are correct, and that instructions are in exactly one bb and have
2723 correct block pointers. */
2725 static int
2726 rtl_verify_bb_insn_chain (void)
2728 basic_block bb;
2729 int err = 0;
2730 rtx x;
2731 rtx last_head = get_last_insn ();
2732 basic_block *bb_info;
2733 const int max_uid = get_max_uid ();
2735 bb_info = XCNEWVEC (basic_block, max_uid);
2737 FOR_EACH_BB_REVERSE_FN (bb, cfun)
2739 rtx head = BB_HEAD (bb);
2740 rtx end = BB_END (bb);
2742 for (x = last_head; x != NULL_RTX; x = PREV_INSN (x))
2744 /* Verify the end of the basic block is in the INSN chain. */
2745 if (x == end)
2746 break;
2748 /* And that the code outside of basic blocks has NULL bb field. */
2749 if (!BARRIER_P (x)
2750 && BLOCK_FOR_INSN (x) != NULL)
2752 error ("insn %d outside of basic blocks has non-NULL bb field",
2753 INSN_UID (x));
2754 err = 1;
2758 if (!x)
2760 error ("end insn %d for block %d not found in the insn stream",
2761 INSN_UID (end), bb->index);
2762 err = 1;
2765 /* Work backwards from the end to the head of the basic block
2766 to verify the head is in the RTL chain. */
2767 for (; x != NULL_RTX; x = PREV_INSN (x))
2769 /* While walking over the insn chain, verify insns appear
2770 in only one basic block. */
2771 if (bb_info[INSN_UID (x)] != NULL)
2773 error ("insn %d is in multiple basic blocks (%d and %d)",
2774 INSN_UID (x), bb->index, bb_info[INSN_UID (x)]->index);
2775 err = 1;
2778 bb_info[INSN_UID (x)] = bb;
2780 if (x == head)
2781 break;
2783 if (!x)
2785 error ("head insn %d for block %d not found in the insn stream",
2786 INSN_UID (head), bb->index);
2787 err = 1;
2790 last_head = PREV_INSN (x);
2793 for (x = last_head; x != NULL_RTX; x = PREV_INSN (x))
2795 /* Check that the code before the first basic block has NULL
2796 bb field. */
2797 if (!BARRIER_P (x)
2798 && BLOCK_FOR_INSN (x) != NULL)
2800 error ("insn %d outside of basic blocks has non-NULL bb field",
2801 INSN_UID (x));
2802 err = 1;
2805 free (bb_info);
2807 return err;
2810 /* Verify that fallthru edges point to adjacent blocks in layout order and
2811 that barriers exist after non-fallthru blocks. */
2813 static int
2814 rtl_verify_fallthru (void)
2816 basic_block bb;
2817 int err = 0;
2819 FOR_EACH_BB_REVERSE_FN (bb, cfun)
2821 edge e;
2823 e = find_fallthru_edge (bb->succs);
2824 if (!e)
2826 rtx insn;
2828 /* Ensure existence of barrier in BB with no fallthru edges. */
2829 for (insn = NEXT_INSN (BB_END (bb)); ; insn = NEXT_INSN (insn))
2831 if (!insn || NOTE_INSN_BASIC_BLOCK_P (insn))
2833 error ("missing barrier after block %i", bb->index);
2834 err = 1;
2835 break;
2837 if (BARRIER_P (insn))
2838 break;
2841 else if (e->src != ENTRY_BLOCK_PTR_FOR_FN (cfun)
2842 && e->dest != EXIT_BLOCK_PTR_FOR_FN (cfun))
2844 rtx insn;
2846 if (e->src->next_bb != e->dest)
2848 error
2849 ("verify_flow_info: Incorrect blocks for fallthru %i->%i",
2850 e->src->index, e->dest->index);
2851 err = 1;
2853 else
2854 for (insn = NEXT_INSN (BB_END (e->src)); insn != BB_HEAD (e->dest);
2855 insn = NEXT_INSN (insn))
2856 if (BARRIER_P (insn) || INSN_P (insn))
2858 error ("verify_flow_info: Incorrect fallthru %i->%i",
2859 e->src->index, e->dest->index);
2860 fatal_insn ("wrong insn in the fallthru edge", insn);
2861 err = 1;
2866 return err;
2869 /* Verify that blocks are laid out in consecutive order. While walking the
2870 instructions, verify that all expected instructions are inside the basic
2871 blocks, and that all returns are followed by barriers. */
2873 static int
2874 rtl_verify_bb_layout (void)
2876 basic_block bb;
2877 int err = 0;
2878 rtx x;
2879 int num_bb_notes;
2880 const rtx rtx_first = get_insns ();
2881 basic_block last_bb_seen = ENTRY_BLOCK_PTR_FOR_FN (cfun), curr_bb = NULL;
2883 num_bb_notes = 0;
2884 last_bb_seen = ENTRY_BLOCK_PTR_FOR_FN (cfun);
2886 for (x = rtx_first; x; x = NEXT_INSN (x))
2888 if (NOTE_INSN_BASIC_BLOCK_P (x))
2890 bb = NOTE_BASIC_BLOCK (x);
2892 num_bb_notes++;
2893 if (bb != last_bb_seen->next_bb)
2894 internal_error ("basic blocks not laid down consecutively");
2896 curr_bb = last_bb_seen = bb;
2899 if (!curr_bb)
2901 switch (GET_CODE (x))
2903 case BARRIER:
2904 case NOTE:
2905 break;
2907 case CODE_LABEL:
2908 /* An ADDR_VEC is placed outside any basic block. */
2909 if (NEXT_INSN (x)
2910 && JUMP_TABLE_DATA_P (NEXT_INSN (x)))
2911 x = NEXT_INSN (x);
2913 /* But in any case, non-deletable labels can appear anywhere. */
2914 break;
2916 default:
2917 fatal_insn ("insn outside basic block", x);
2921 if (JUMP_P (x)
2922 && returnjump_p (x) && ! condjump_p (x)
2923 && ! (next_nonnote_insn (x) && BARRIER_P (next_nonnote_insn (x))))
2924 fatal_insn ("return not followed by barrier", x);
2926 if (curr_bb && x == BB_END (curr_bb))
2927 curr_bb = NULL;
2930 if (num_bb_notes != n_basic_blocks_for_fn (cfun) - NUM_FIXED_BLOCKS)
2931 internal_error
2932 ("number of bb notes in insn chain (%d) != n_basic_blocks (%d)",
2933 num_bb_notes, n_basic_blocks_for_fn (cfun));
2935 return err;
2938 /* Verify the CFG and RTL consistency common for both underlying RTL and
2939 cfglayout RTL, plus consistency checks specific to linearized RTL mode.
2941 Currently it does following checks:
2942 - all checks of rtl_verify_flow_info_1
2943 - test head/end pointers
2944 - check that blocks are laid out in consecutive order
2945 - check that all insns are in the basic blocks
2946 (except the switch handling code, barriers and notes)
2947 - check that all returns are followed by barriers
2948 - check that all fallthru edge points to the adjacent blocks
2949 - verify that there is a single hot/cold partition boundary after bbro */
2951 static int
2952 rtl_verify_flow_info (void)
2954 int err = 0;
2956 err |= rtl_verify_flow_info_1 ();
2958 err |= rtl_verify_bb_insn_chain ();
2960 err |= rtl_verify_fallthru ();
2962 err |= rtl_verify_bb_layout ();
2964 err |= verify_hot_cold_block_grouping ();
2966 return err;
2969 /* Assume that the preceding pass has possibly eliminated jump instructions
2970 or converted the unconditional jumps. Eliminate the edges from CFG.
2971 Return true if any edges are eliminated. */
2973 bool
2974 purge_dead_edges (basic_block bb)
2976 edge e;
2977 rtx insn = BB_END (bb), note;
2978 bool purged = false;
2979 bool found;
2980 edge_iterator ei;
2982 if (DEBUG_INSN_P (insn) && insn != BB_HEAD (bb))
2984 insn = PREV_INSN (insn);
2985 while ((DEBUG_INSN_P (insn) || NOTE_P (insn)) && insn != BB_HEAD (bb));
2987 /* If this instruction cannot trap, remove REG_EH_REGION notes. */
2988 if (NONJUMP_INSN_P (insn)
2989 && (note = find_reg_note (insn, REG_EH_REGION, NULL)))
2991 rtx eqnote;
2993 if (! may_trap_p (PATTERN (insn))
2994 || ((eqnote = find_reg_equal_equiv_note (insn))
2995 && ! may_trap_p (XEXP (eqnote, 0))))
2996 remove_note (insn, note);
2999 /* Cleanup abnormal edges caused by exceptions or non-local gotos. */
3000 for (ei = ei_start (bb->succs); (e = ei_safe_edge (ei)); )
3002 bool remove = false;
3004 /* There are three types of edges we need to handle correctly here: EH
3005 edges, abnormal call EH edges, and abnormal call non-EH edges. The
3006 latter can appear when nonlocal gotos are used. */
3007 if (e->flags & EDGE_ABNORMAL_CALL)
3009 if (!CALL_P (insn))
3010 remove = true;
3011 else if (can_nonlocal_goto (insn))
3013 else if ((e->flags & EDGE_EH) && can_throw_internal (insn))
3015 else if (flag_tm && find_reg_note (insn, REG_TM, NULL))
3017 else
3018 remove = true;
3020 else if (e->flags & EDGE_EH)
3021 remove = !can_throw_internal (insn);
3023 if (remove)
3025 remove_edge (e);
3026 df_set_bb_dirty (bb);
3027 purged = true;
3029 else
3030 ei_next (&ei);
3033 if (JUMP_P (insn))
3035 rtx note;
3036 edge b,f;
3037 edge_iterator ei;
3039 /* We do care only about conditional jumps and simplejumps. */
3040 if (!any_condjump_p (insn)
3041 && !returnjump_p (insn)
3042 && !simplejump_p (insn))
3043 return purged;
3045 /* Branch probability/prediction notes are defined only for
3046 condjumps. We've possibly turned condjump into simplejump. */
3047 if (simplejump_p (insn))
3049 note = find_reg_note (insn, REG_BR_PROB, NULL);
3050 if (note)
3051 remove_note (insn, note);
3052 while ((note = find_reg_note (insn, REG_BR_PRED, NULL)))
3053 remove_note (insn, note);
3056 for (ei = ei_start (bb->succs); (e = ei_safe_edge (ei)); )
3058 /* Avoid abnormal flags to leak from computed jumps turned
3059 into simplejumps. */
3061 e->flags &= ~EDGE_ABNORMAL;
3063 /* See if this edge is one we should keep. */
3064 if ((e->flags & EDGE_FALLTHRU) && any_condjump_p (insn))
3065 /* A conditional jump can fall through into the next
3066 block, so we should keep the edge. */
3068 ei_next (&ei);
3069 continue;
3071 else if (e->dest != EXIT_BLOCK_PTR_FOR_FN (cfun)
3072 && BB_HEAD (e->dest) == JUMP_LABEL (insn))
3073 /* If the destination block is the target of the jump,
3074 keep the edge. */
3076 ei_next (&ei);
3077 continue;
3079 else if (e->dest == EXIT_BLOCK_PTR_FOR_FN (cfun)
3080 && returnjump_p (insn))
3081 /* If the destination block is the exit block, and this
3082 instruction is a return, then keep the edge. */
3084 ei_next (&ei);
3085 continue;
3087 else if ((e->flags & EDGE_EH) && can_throw_internal (insn))
3088 /* Keep the edges that correspond to exceptions thrown by
3089 this instruction and rematerialize the EDGE_ABNORMAL
3090 flag we just cleared above. */
3092 e->flags |= EDGE_ABNORMAL;
3093 ei_next (&ei);
3094 continue;
3097 /* We do not need this edge. */
3098 df_set_bb_dirty (bb);
3099 purged = true;
3100 remove_edge (e);
3103 if (EDGE_COUNT (bb->succs) == 0 || !purged)
3104 return purged;
3106 if (dump_file)
3107 fprintf (dump_file, "Purged edges from bb %i\n", bb->index);
3109 if (!optimize)
3110 return purged;
3112 /* Redistribute probabilities. */
3113 if (single_succ_p (bb))
3115 single_succ_edge (bb)->probability = REG_BR_PROB_BASE;
3116 single_succ_edge (bb)->count = bb->count;
3118 else
3120 note = find_reg_note (insn, REG_BR_PROB, NULL);
3121 if (!note)
3122 return purged;
3124 b = BRANCH_EDGE (bb);
3125 f = FALLTHRU_EDGE (bb);
3126 b->probability = XINT (note, 0);
3127 f->probability = REG_BR_PROB_BASE - b->probability;
3128 /* Update these to use GCOV_COMPUTE_SCALE. */
3129 b->count = bb->count * b->probability / REG_BR_PROB_BASE;
3130 f->count = bb->count * f->probability / REG_BR_PROB_BASE;
3133 return purged;
3135 else if (CALL_P (insn) && SIBLING_CALL_P (insn))
3137 /* First, there should not be any EH or ABCALL edges resulting
3138 from non-local gotos and the like. If there were, we shouldn't
3139 have created the sibcall in the first place. Second, there
3140 should of course never have been a fallthru edge. */
3141 gcc_assert (single_succ_p (bb));
3142 gcc_assert (single_succ_edge (bb)->flags
3143 == (EDGE_SIBCALL | EDGE_ABNORMAL));
3145 return 0;
3148 /* If we don't see a jump insn, we don't know exactly why the block would
3149 have been broken at this point. Look for a simple, non-fallthru edge,
3150 as these are only created by conditional branches. If we find such an
3151 edge we know that there used to be a jump here and can then safely
3152 remove all non-fallthru edges. */
3153 found = false;
3154 FOR_EACH_EDGE (e, ei, bb->succs)
3155 if (! (e->flags & (EDGE_COMPLEX | EDGE_FALLTHRU)))
3157 found = true;
3158 break;
3161 if (!found)
3162 return purged;
3164 /* Remove all but the fake and fallthru edges. The fake edge may be
3165 the only successor for this block in the case of noreturn
3166 calls. */
3167 for (ei = ei_start (bb->succs); (e = ei_safe_edge (ei)); )
3169 if (!(e->flags & (EDGE_FALLTHRU | EDGE_FAKE)))
3171 df_set_bb_dirty (bb);
3172 remove_edge (e);
3173 purged = true;
3175 else
3176 ei_next (&ei);
3179 gcc_assert (single_succ_p (bb));
3181 single_succ_edge (bb)->probability = REG_BR_PROB_BASE;
3182 single_succ_edge (bb)->count = bb->count;
3184 if (dump_file)
3185 fprintf (dump_file, "Purged non-fallthru edges from bb %i\n",
3186 bb->index);
3187 return purged;
3190 /* Search all basic blocks for potentially dead edges and purge them. Return
3191 true if some edge has been eliminated. */
3193 bool
3194 purge_all_dead_edges (void)
3196 int purged = false;
3197 basic_block bb;
3199 FOR_EACH_BB_FN (bb, cfun)
3201 bool purged_here = purge_dead_edges (bb);
3203 purged |= purged_here;
3206 return purged;
3209 /* This is used by a few passes that emit some instructions after abnormal
3210 calls, moving the basic block's end, while they in fact do want to emit
3211 them on the fallthru edge. Look for abnormal call edges, find backward
3212 the call in the block and insert the instructions on the edge instead.
3214 Similarly, handle instructions throwing exceptions internally.
3216 Return true when instructions have been found and inserted on edges. */
3218 bool
3219 fixup_abnormal_edges (void)
3221 bool inserted = false;
3222 basic_block bb;
3224 FOR_EACH_BB_FN (bb, cfun)
3226 edge e;
3227 edge_iterator ei;
3229 /* Look for cases we are interested in - calls or instructions causing
3230 exceptions. */
3231 FOR_EACH_EDGE (e, ei, bb->succs)
3232 if ((e->flags & EDGE_ABNORMAL_CALL)
3233 || ((e->flags & (EDGE_ABNORMAL | EDGE_EH))
3234 == (EDGE_ABNORMAL | EDGE_EH)))
3235 break;
3237 if (e && !CALL_P (BB_END (bb)) && !can_throw_internal (BB_END (bb)))
3239 rtx insn;
3241 /* Get past the new insns generated. Allow notes, as the insns
3242 may be already deleted. */
3243 insn = BB_END (bb);
3244 while ((NONJUMP_INSN_P (insn) || NOTE_P (insn))
3245 && !can_throw_internal (insn)
3246 && insn != BB_HEAD (bb))
3247 insn = PREV_INSN (insn);
3249 if (CALL_P (insn) || can_throw_internal (insn))
3251 rtx stop, next;
3253 e = find_fallthru_edge (bb->succs);
3255 stop = NEXT_INSN (BB_END (bb));
3256 BB_END (bb) = insn;
3258 for (insn = NEXT_INSN (insn); insn != stop; insn = next)
3260 next = NEXT_INSN (insn);
3261 if (INSN_P (insn))
3263 delete_insn (insn);
3265 /* Sometimes there's still the return value USE.
3266 If it's placed after a trapping call (i.e. that
3267 call is the last insn anyway), we have no fallthru
3268 edge. Simply delete this use and don't try to insert
3269 on the non-existent edge. */
3270 if (GET_CODE (PATTERN (insn)) != USE)
3272 /* We're not deleting it, we're moving it. */
3273 INSN_DELETED_P (insn) = 0;
3274 PREV_INSN (insn) = NULL_RTX;
3275 NEXT_INSN (insn) = NULL_RTX;
3277 insert_insn_on_edge (insn, e);
3278 inserted = true;
3281 else if (!BARRIER_P (insn))
3282 set_block_for_insn (insn, NULL);
3286 /* It may be that we don't find any trapping insn. In this
3287 case we discovered quite late that the insn that had been
3288 marked as can_throw_internal in fact couldn't trap at all.
3289 So we should in fact delete the EH edges out of the block. */
3290 else
3291 purge_dead_edges (bb);
3295 return inserted;
3298 /* Cut the insns from FIRST to LAST out of the insns stream. */
3301 unlink_insn_chain (rtx first, rtx last)
3303 rtx prevfirst = PREV_INSN (first);
3304 rtx nextlast = NEXT_INSN (last);
3306 PREV_INSN (first) = NULL;
3307 NEXT_INSN (last) = NULL;
3308 if (prevfirst)
3309 NEXT_INSN (prevfirst) = nextlast;
3310 if (nextlast)
3311 PREV_INSN (nextlast) = prevfirst;
3312 else
3313 set_last_insn (prevfirst);
3314 if (!prevfirst)
3315 set_first_insn (nextlast);
3316 return first;
3319 /* Skip over inter-block insns occurring after BB which are typically
3320 associated with BB (e.g., barriers). If there are any such insns,
3321 we return the last one. Otherwise, we return the end of BB. */
3323 static rtx
3324 skip_insns_after_block (basic_block bb)
3326 rtx insn, last_insn, next_head, prev;
3328 next_head = NULL_RTX;
3329 if (bb->next_bb != EXIT_BLOCK_PTR_FOR_FN (cfun))
3330 next_head = BB_HEAD (bb->next_bb);
3332 for (last_insn = insn = BB_END (bb); (insn = NEXT_INSN (insn)) != 0; )
3334 if (insn == next_head)
3335 break;
3337 switch (GET_CODE (insn))
3339 case BARRIER:
3340 last_insn = insn;
3341 continue;
3343 case NOTE:
3344 switch (NOTE_KIND (insn))
3346 case NOTE_INSN_BLOCK_END:
3347 gcc_unreachable ();
3348 continue;
3349 default:
3350 continue;
3351 break;
3353 break;
3355 case CODE_LABEL:
3356 if (NEXT_INSN (insn)
3357 && JUMP_TABLE_DATA_P (NEXT_INSN (insn)))
3359 insn = NEXT_INSN (insn);
3360 last_insn = insn;
3361 continue;
3363 break;
3365 default:
3366 break;
3369 break;
3372 /* It is possible to hit contradictory sequence. For instance:
3374 jump_insn
3375 NOTE_INSN_BLOCK_BEG
3376 barrier
3378 Where barrier belongs to jump_insn, but the note does not. This can be
3379 created by removing the basic block originally following
3380 NOTE_INSN_BLOCK_BEG. In such case reorder the notes. */
3382 for (insn = last_insn; insn != BB_END (bb); insn = prev)
3384 prev = PREV_INSN (insn);
3385 if (NOTE_P (insn))
3386 switch (NOTE_KIND (insn))
3388 case NOTE_INSN_BLOCK_END:
3389 gcc_unreachable ();
3390 break;
3391 case NOTE_INSN_DELETED:
3392 case NOTE_INSN_DELETED_LABEL:
3393 case NOTE_INSN_DELETED_DEBUG_LABEL:
3394 continue;
3395 default:
3396 reorder_insns (insn, insn, last_insn);
3400 return last_insn;
3403 /* Locate or create a label for a given basic block. */
3405 static rtx
3406 label_for_bb (basic_block bb)
3408 rtx label = BB_HEAD (bb);
3410 if (!LABEL_P (label))
3412 if (dump_file)
3413 fprintf (dump_file, "Emitting label for block %d\n", bb->index);
3415 label = block_label (bb);
3418 return label;
3421 /* Locate the effective beginning and end of the insn chain for each
3422 block, as defined by skip_insns_after_block above. */
3424 static void
3425 record_effective_endpoints (void)
3427 rtx next_insn;
3428 basic_block bb;
3429 rtx insn;
3431 for (insn = get_insns ();
3432 insn
3433 && NOTE_P (insn)
3434 && NOTE_KIND (insn) != NOTE_INSN_BASIC_BLOCK;
3435 insn = NEXT_INSN (insn))
3436 continue;
3437 /* No basic blocks at all? */
3438 gcc_assert (insn);
3440 if (PREV_INSN (insn))
3441 cfg_layout_function_header =
3442 unlink_insn_chain (get_insns (), PREV_INSN (insn));
3443 else
3444 cfg_layout_function_header = NULL_RTX;
3446 next_insn = get_insns ();
3447 FOR_EACH_BB_FN (bb, cfun)
3449 rtx end;
3451 if (PREV_INSN (BB_HEAD (bb)) && next_insn != BB_HEAD (bb))
3452 BB_HEADER (bb) = unlink_insn_chain (next_insn,
3453 PREV_INSN (BB_HEAD (bb)));
3454 end = skip_insns_after_block (bb);
3455 if (NEXT_INSN (BB_END (bb)) && BB_END (bb) != end)
3456 BB_FOOTER (bb) = unlink_insn_chain (NEXT_INSN (BB_END (bb)), end);
3457 next_insn = NEXT_INSN (BB_END (bb));
3460 cfg_layout_function_footer = next_insn;
3461 if (cfg_layout_function_footer)
3462 cfg_layout_function_footer = unlink_insn_chain (cfg_layout_function_footer, get_last_insn ());
3465 namespace {
3467 const pass_data pass_data_into_cfg_layout_mode =
3469 RTL_PASS, /* type */
3470 "into_cfglayout", /* name */
3471 OPTGROUP_NONE, /* optinfo_flags */
3472 true, /* has_execute */
3473 TV_CFG, /* tv_id */
3474 0, /* properties_required */
3475 PROP_cfglayout, /* properties_provided */
3476 0, /* properties_destroyed */
3477 0, /* todo_flags_start */
3478 0, /* todo_flags_finish */
3481 class pass_into_cfg_layout_mode : public rtl_opt_pass
3483 public:
3484 pass_into_cfg_layout_mode (gcc::context *ctxt)
3485 : rtl_opt_pass (pass_data_into_cfg_layout_mode, ctxt)
3488 /* opt_pass methods: */
3489 virtual unsigned int execute (function *)
3491 cfg_layout_initialize (0);
3492 return 0;
3495 }; // class pass_into_cfg_layout_mode
3497 } // anon namespace
3499 rtl_opt_pass *
3500 make_pass_into_cfg_layout_mode (gcc::context *ctxt)
3502 return new pass_into_cfg_layout_mode (ctxt);
3505 namespace {
3507 const pass_data pass_data_outof_cfg_layout_mode =
3509 RTL_PASS, /* type */
3510 "outof_cfglayout", /* name */
3511 OPTGROUP_NONE, /* optinfo_flags */
3512 true, /* has_execute */
3513 TV_CFG, /* tv_id */
3514 0, /* properties_required */
3515 0, /* properties_provided */
3516 PROP_cfglayout, /* properties_destroyed */
3517 0, /* todo_flags_start */
3518 0, /* todo_flags_finish */
3521 class pass_outof_cfg_layout_mode : public rtl_opt_pass
3523 public:
3524 pass_outof_cfg_layout_mode (gcc::context *ctxt)
3525 : rtl_opt_pass (pass_data_outof_cfg_layout_mode, ctxt)
3528 /* opt_pass methods: */
3529 virtual unsigned int execute (function *);
3531 }; // class pass_outof_cfg_layout_mode
3533 unsigned int
3534 pass_outof_cfg_layout_mode::execute (function *fun)
3536 basic_block bb;
3538 FOR_EACH_BB_FN (bb, fun)
3539 if (bb->next_bb != EXIT_BLOCK_PTR_FOR_FN (fun))
3540 bb->aux = bb->next_bb;
3542 cfg_layout_finalize ();
3544 return 0;
3547 } // anon namespace
3549 rtl_opt_pass *
3550 make_pass_outof_cfg_layout_mode (gcc::context *ctxt)
3552 return new pass_outof_cfg_layout_mode (ctxt);
3556 /* Link the basic blocks in the correct order, compacting the basic
3557 block queue while at it. If STAY_IN_CFGLAYOUT_MODE is false, this
3558 function also clears the basic block header and footer fields.
3560 This function is usually called after a pass (e.g. tracer) finishes
3561 some transformations while in cfglayout mode. The required sequence
3562 of the basic blocks is in a linked list along the bb->aux field.
3563 This functions re-links the basic block prev_bb and next_bb pointers
3564 accordingly, and it compacts and renumbers the blocks.
3566 FIXME: This currently works only for RTL, but the only RTL-specific
3567 bits are the STAY_IN_CFGLAYOUT_MODE bits. The tracer pass was moved
3568 to GIMPLE a long time ago, but it doesn't relink the basic block
3569 chain. It could do that (to give better initial RTL) if this function
3570 is made IR-agnostic (and moved to cfganal.c or cfg.c while at it). */
3572 void
3573 relink_block_chain (bool stay_in_cfglayout_mode)
3575 basic_block bb, prev_bb;
3576 int index;
3578 /* Maybe dump the re-ordered sequence. */
3579 if (dump_file)
3581 fprintf (dump_file, "Reordered sequence:\n");
3582 for (bb = ENTRY_BLOCK_PTR_FOR_FN (cfun)->next_bb, index =
3583 NUM_FIXED_BLOCKS;
3585 bb = (basic_block) bb->aux, index++)
3587 fprintf (dump_file, " %i ", index);
3588 if (get_bb_original (bb))
3589 fprintf (dump_file, "duplicate of %i ",
3590 get_bb_original (bb)->index);
3591 else if (forwarder_block_p (bb)
3592 && !LABEL_P (BB_HEAD (bb)))
3593 fprintf (dump_file, "compensation ");
3594 else
3595 fprintf (dump_file, "bb %i ", bb->index);
3596 fprintf (dump_file, " [%i]\n", bb->frequency);
3600 /* Now reorder the blocks. */
3601 prev_bb = ENTRY_BLOCK_PTR_FOR_FN (cfun);
3602 bb = ENTRY_BLOCK_PTR_FOR_FN (cfun)->next_bb;
3603 for (; bb; prev_bb = bb, bb = (basic_block) bb->aux)
3605 bb->prev_bb = prev_bb;
3606 prev_bb->next_bb = bb;
3608 prev_bb->next_bb = EXIT_BLOCK_PTR_FOR_FN (cfun);
3609 EXIT_BLOCK_PTR_FOR_FN (cfun)->prev_bb = prev_bb;
3611 /* Then, clean up the aux fields. */
3612 FOR_ALL_BB_FN (bb, cfun)
3614 bb->aux = NULL;
3615 if (!stay_in_cfglayout_mode)
3616 BB_HEADER (bb) = BB_FOOTER (bb) = NULL;
3619 /* Maybe reset the original copy tables, they are not valid anymore
3620 when we renumber the basic blocks in compact_blocks. If we are
3621 are going out of cfglayout mode, don't re-allocate the tables. */
3622 free_original_copy_tables ();
3623 if (stay_in_cfglayout_mode)
3624 initialize_original_copy_tables ();
3626 /* Finally, put basic_block_info in the new order. */
3627 compact_blocks ();
3631 /* Given a reorder chain, rearrange the code to match. */
3633 static void
3634 fixup_reorder_chain (void)
3636 basic_block bb;
3637 rtx insn = NULL;
3639 if (cfg_layout_function_header)
3641 set_first_insn (cfg_layout_function_header);
3642 insn = cfg_layout_function_header;
3643 while (NEXT_INSN (insn))
3644 insn = NEXT_INSN (insn);
3647 /* First do the bulk reordering -- rechain the blocks without regard to
3648 the needed changes to jumps and labels. */
3650 for (bb = ENTRY_BLOCK_PTR_FOR_FN (cfun)->next_bb; bb; bb = (basic_block)
3651 bb->aux)
3653 if (BB_HEADER (bb))
3655 if (insn)
3656 NEXT_INSN (insn) = BB_HEADER (bb);
3657 else
3658 set_first_insn (BB_HEADER (bb));
3659 PREV_INSN (BB_HEADER (bb)) = insn;
3660 insn = BB_HEADER (bb);
3661 while (NEXT_INSN (insn))
3662 insn = NEXT_INSN (insn);
3664 if (insn)
3665 NEXT_INSN (insn) = BB_HEAD (bb);
3666 else
3667 set_first_insn (BB_HEAD (bb));
3668 PREV_INSN (BB_HEAD (bb)) = insn;
3669 insn = BB_END (bb);
3670 if (BB_FOOTER (bb))
3672 NEXT_INSN (insn) = BB_FOOTER (bb);
3673 PREV_INSN (BB_FOOTER (bb)) = insn;
3674 while (NEXT_INSN (insn))
3675 insn = NEXT_INSN (insn);
3679 NEXT_INSN (insn) = cfg_layout_function_footer;
3680 if (cfg_layout_function_footer)
3681 PREV_INSN (cfg_layout_function_footer) = insn;
3683 while (NEXT_INSN (insn))
3684 insn = NEXT_INSN (insn);
3686 set_last_insn (insn);
3687 #ifdef ENABLE_CHECKING
3688 verify_insn_chain ();
3689 #endif
3691 /* Now add jumps and labels as needed to match the blocks new
3692 outgoing edges. */
3694 for (bb = ENTRY_BLOCK_PTR_FOR_FN (cfun)->next_bb; bb ; bb = (basic_block)
3695 bb->aux)
3697 edge e_fall, e_taken, e;
3698 rtx bb_end_insn;
3699 rtx ret_label = NULL_RTX;
3700 basic_block nb;
3701 edge_iterator ei;
3703 if (EDGE_COUNT (bb->succs) == 0)
3704 continue;
3706 /* Find the old fallthru edge, and another non-EH edge for
3707 a taken jump. */
3708 e_taken = e_fall = NULL;
3710 FOR_EACH_EDGE (e, ei, bb->succs)
3711 if (e->flags & EDGE_FALLTHRU)
3712 e_fall = e;
3713 else if (! (e->flags & EDGE_EH))
3714 e_taken = e;
3716 bb_end_insn = BB_END (bb);
3717 if (JUMP_P (bb_end_insn))
3719 ret_label = JUMP_LABEL (bb_end_insn);
3720 if (any_condjump_p (bb_end_insn))
3722 /* This might happen if the conditional jump has side
3723 effects and could therefore not be optimized away.
3724 Make the basic block to end with a barrier in order
3725 to prevent rtl_verify_flow_info from complaining. */
3726 if (!e_fall)
3728 gcc_assert (!onlyjump_p (bb_end_insn)
3729 || returnjump_p (bb_end_insn)
3730 || (e_taken->flags & EDGE_CROSSING));
3731 emit_barrier_after (bb_end_insn);
3732 continue;
3735 /* If the old fallthru is still next, nothing to do. */
3736 if (bb->aux == e_fall->dest
3737 || e_fall->dest == EXIT_BLOCK_PTR_FOR_FN (cfun))
3738 continue;
3740 /* The degenerated case of conditional jump jumping to the next
3741 instruction can happen for jumps with side effects. We need
3742 to construct a forwarder block and this will be done just
3743 fine by force_nonfallthru below. */
3744 if (!e_taken)
3747 /* There is another special case: if *neither* block is next,
3748 such as happens at the very end of a function, then we'll
3749 need to add a new unconditional jump. Choose the taken
3750 edge based on known or assumed probability. */
3751 else if (bb->aux != e_taken->dest)
3753 rtx note = find_reg_note (bb_end_insn, REG_BR_PROB, 0);
3755 if (note
3756 && XINT (note, 0) < REG_BR_PROB_BASE / 2
3757 && invert_jump (bb_end_insn,
3758 (e_fall->dest
3759 == EXIT_BLOCK_PTR_FOR_FN (cfun)
3760 ? NULL_RTX
3761 : label_for_bb (e_fall->dest)), 0))
3763 e_fall->flags &= ~EDGE_FALLTHRU;
3764 gcc_checking_assert (could_fall_through
3765 (e_taken->src, e_taken->dest));
3766 e_taken->flags |= EDGE_FALLTHRU;
3767 update_br_prob_note (bb);
3768 e = e_fall, e_fall = e_taken, e_taken = e;
3772 /* If the "jumping" edge is a crossing edge, and the fall
3773 through edge is non-crossing, leave things as they are. */
3774 else if ((e_taken->flags & EDGE_CROSSING)
3775 && !(e_fall->flags & EDGE_CROSSING))
3776 continue;
3778 /* Otherwise we can try to invert the jump. This will
3779 basically never fail, however, keep up the pretense. */
3780 else if (invert_jump (bb_end_insn,
3781 (e_fall->dest
3782 == EXIT_BLOCK_PTR_FOR_FN (cfun)
3783 ? NULL_RTX
3784 : label_for_bb (e_fall->dest)), 0))
3786 e_fall->flags &= ~EDGE_FALLTHRU;
3787 gcc_checking_assert (could_fall_through
3788 (e_taken->src, e_taken->dest));
3789 e_taken->flags |= EDGE_FALLTHRU;
3790 update_br_prob_note (bb);
3791 if (LABEL_NUSES (ret_label) == 0
3792 && single_pred_p (e_taken->dest))
3793 delete_insn (ret_label);
3794 continue;
3797 else if (extract_asm_operands (PATTERN (bb_end_insn)) != NULL)
3799 /* If the old fallthru is still next or if
3800 asm goto doesn't have a fallthru (e.g. when followed by
3801 __builtin_unreachable ()), nothing to do. */
3802 if (! e_fall
3803 || bb->aux == e_fall->dest
3804 || e_fall->dest == EXIT_BLOCK_PTR_FOR_FN (cfun))
3805 continue;
3807 /* Otherwise we'll have to use the fallthru fixup below. */
3809 else
3811 /* Otherwise we have some return, switch or computed
3812 jump. In the 99% case, there should not have been a
3813 fallthru edge. */
3814 gcc_assert (returnjump_p (bb_end_insn) || !e_fall);
3815 continue;
3818 else
3820 /* No fallthru implies a noreturn function with EH edges, or
3821 something similarly bizarre. In any case, we don't need to
3822 do anything. */
3823 if (! e_fall)
3824 continue;
3826 /* If the fallthru block is still next, nothing to do. */
3827 if (bb->aux == e_fall->dest)
3828 continue;
3830 /* A fallthru to exit block. */
3831 if (e_fall->dest == EXIT_BLOCK_PTR_FOR_FN (cfun))
3832 continue;
3835 /* We got here if we need to add a new jump insn.
3836 Note force_nonfallthru can delete E_FALL and thus we have to
3837 save E_FALL->src prior to the call to force_nonfallthru. */
3838 nb = force_nonfallthru_and_redirect (e_fall, e_fall->dest, ret_label);
3839 if (nb)
3841 nb->aux = bb->aux;
3842 bb->aux = nb;
3843 /* Don't process this new block. */
3844 bb = nb;
3848 relink_block_chain (/*stay_in_cfglayout_mode=*/false);
3850 /* Annoying special case - jump around dead jumptables left in the code. */
3851 FOR_EACH_BB_FN (bb, cfun)
3853 edge e = find_fallthru_edge (bb->succs);
3855 if (e && !can_fallthru (e->src, e->dest))
3856 force_nonfallthru (e);
3859 /* Ensure goto_locus from edges has some instructions with that locus
3860 in RTL. */
3861 if (!optimize)
3862 FOR_EACH_BB_FN (bb, cfun)
3864 edge e;
3865 edge_iterator ei;
3867 FOR_EACH_EDGE (e, ei, bb->succs)
3868 if (LOCATION_LOCUS (e->goto_locus) != UNKNOWN_LOCATION
3869 && !(e->flags & EDGE_ABNORMAL))
3871 edge e2;
3872 edge_iterator ei2;
3873 basic_block dest, nb;
3874 rtx end;
3876 insn = BB_END (e->src);
3877 end = PREV_INSN (BB_HEAD (e->src));
3878 while (insn != end
3879 && (!NONDEBUG_INSN_P (insn) || !INSN_HAS_LOCATION (insn)))
3880 insn = PREV_INSN (insn);
3881 if (insn != end
3882 && INSN_LOCATION (insn) == e->goto_locus)
3883 continue;
3884 if (simplejump_p (BB_END (e->src))
3885 && !INSN_HAS_LOCATION (BB_END (e->src)))
3887 INSN_LOCATION (BB_END (e->src)) = e->goto_locus;
3888 continue;
3890 dest = e->dest;
3891 if (dest == EXIT_BLOCK_PTR_FOR_FN (cfun))
3893 /* Non-fallthru edges to the exit block cannot be split. */
3894 if (!(e->flags & EDGE_FALLTHRU))
3895 continue;
3897 else
3899 insn = BB_HEAD (dest);
3900 end = NEXT_INSN (BB_END (dest));
3901 while (insn != end && !NONDEBUG_INSN_P (insn))
3902 insn = NEXT_INSN (insn);
3903 if (insn != end && INSN_HAS_LOCATION (insn)
3904 && INSN_LOCATION (insn) == e->goto_locus)
3905 continue;
3907 nb = split_edge (e);
3908 if (!INSN_P (BB_END (nb)))
3909 BB_END (nb) = emit_insn_after_noloc (gen_nop (), BB_END (nb),
3910 nb);
3911 INSN_LOCATION (BB_END (nb)) = e->goto_locus;
3913 /* If there are other incoming edges to the destination block
3914 with the same goto locus, redirect them to the new block as
3915 well, this can prevent other such blocks from being created
3916 in subsequent iterations of the loop. */
3917 for (ei2 = ei_start (dest->preds); (e2 = ei_safe_edge (ei2)); )
3918 if (LOCATION_LOCUS (e2->goto_locus) != UNKNOWN_LOCATION
3919 && !(e2->flags & (EDGE_ABNORMAL | EDGE_FALLTHRU))
3920 && e->goto_locus == e2->goto_locus)
3921 redirect_edge_and_branch (e2, nb);
3922 else
3923 ei_next (&ei2);
3928 /* Perform sanity checks on the insn chain.
3929 1. Check that next/prev pointers are consistent in both the forward and
3930 reverse direction.
3931 2. Count insns in chain, going both directions, and check if equal.
3932 3. Check that get_last_insn () returns the actual end of chain. */
3934 DEBUG_FUNCTION void
3935 verify_insn_chain (void)
3937 rtx x, prevx, nextx;
3938 int insn_cnt1, insn_cnt2;
3940 for (prevx = NULL, insn_cnt1 = 1, x = get_insns ();
3941 x != 0;
3942 prevx = x, insn_cnt1++, x = NEXT_INSN (x))
3943 gcc_assert (PREV_INSN (x) == prevx);
3945 gcc_assert (prevx == get_last_insn ());
3947 for (nextx = NULL, insn_cnt2 = 1, x = get_last_insn ();
3948 x != 0;
3949 nextx = x, insn_cnt2++, x = PREV_INSN (x))
3950 gcc_assert (NEXT_INSN (x) == nextx);
3952 gcc_assert (insn_cnt1 == insn_cnt2);
3955 /* If we have assembler epilogues, the block falling through to exit must
3956 be the last one in the reordered chain when we reach final. Ensure
3957 that this condition is met. */
3958 static void
3959 fixup_fallthru_exit_predecessor (void)
3961 edge e;
3962 basic_block bb = NULL;
3964 /* This transformation is not valid before reload, because we might
3965 separate a call from the instruction that copies the return
3966 value. */
3967 gcc_assert (reload_completed);
3969 e = find_fallthru_edge (EXIT_BLOCK_PTR_FOR_FN (cfun)->preds);
3970 if (e)
3971 bb = e->src;
3973 if (bb && bb->aux)
3975 basic_block c = ENTRY_BLOCK_PTR_FOR_FN (cfun)->next_bb;
3977 /* If the very first block is the one with the fall-through exit
3978 edge, we have to split that block. */
3979 if (c == bb)
3981 bb = split_block (bb, NULL)->dest;
3982 bb->aux = c->aux;
3983 c->aux = bb;
3984 BB_FOOTER (bb) = BB_FOOTER (c);
3985 BB_FOOTER (c) = NULL;
3988 while (c->aux != bb)
3989 c = (basic_block) c->aux;
3991 c->aux = bb->aux;
3992 while (c->aux)
3993 c = (basic_block) c->aux;
3995 c->aux = bb;
3996 bb->aux = NULL;
4000 /* In case there are more than one fallthru predecessors of exit, force that
4001 there is only one. */
4003 static void
4004 force_one_exit_fallthru (void)
4006 edge e, predecessor = NULL;
4007 bool more = false;
4008 edge_iterator ei;
4009 basic_block forwarder, bb;
4011 FOR_EACH_EDGE (e, ei, EXIT_BLOCK_PTR_FOR_FN (cfun)->preds)
4012 if (e->flags & EDGE_FALLTHRU)
4014 if (predecessor == NULL)
4015 predecessor = e;
4016 else
4018 more = true;
4019 break;
4023 if (!more)
4024 return;
4026 /* Exit has several fallthru predecessors. Create a forwarder block for
4027 them. */
4028 forwarder = split_edge (predecessor);
4029 for (ei = ei_start (EXIT_BLOCK_PTR_FOR_FN (cfun)->preds);
4030 (e = ei_safe_edge (ei)); )
4032 if (e->src == forwarder
4033 || !(e->flags & EDGE_FALLTHRU))
4034 ei_next (&ei);
4035 else
4036 redirect_edge_and_branch_force (e, forwarder);
4039 /* Fix up the chain of blocks -- make FORWARDER immediately precede the
4040 exit block. */
4041 FOR_EACH_BB_FN (bb, cfun)
4043 if (bb->aux == NULL && bb != forwarder)
4045 bb->aux = forwarder;
4046 break;
4051 /* Return true in case it is possible to duplicate the basic block BB. */
4053 static bool
4054 cfg_layout_can_duplicate_bb_p (const_basic_block bb)
4056 /* Do not attempt to duplicate tablejumps, as we need to unshare
4057 the dispatch table. This is difficult to do, as the instructions
4058 computing jump destination may be hoisted outside the basic block. */
4059 if (tablejump_p (BB_END (bb), NULL, NULL))
4060 return false;
4062 /* Do not duplicate blocks containing insns that can't be copied. */
4063 if (targetm.cannot_copy_insn_p)
4065 rtx insn = BB_HEAD (bb);
4066 while (1)
4068 if (INSN_P (insn) && targetm.cannot_copy_insn_p (insn))
4069 return false;
4070 if (insn == BB_END (bb))
4071 break;
4072 insn = NEXT_INSN (insn);
4076 return true;
4080 duplicate_insn_chain (rtx from, rtx to)
4082 rtx insn, next, last, copy;
4084 /* Avoid updating of boundaries of previous basic block. The
4085 note will get removed from insn stream in fixup. */
4086 last = emit_note (NOTE_INSN_DELETED);
4088 /* Create copy at the end of INSN chain. The chain will
4089 be reordered later. */
4090 for (insn = from; insn != NEXT_INSN (to); insn = NEXT_INSN (insn))
4092 switch (GET_CODE (insn))
4094 case DEBUG_INSN:
4095 /* Don't duplicate label debug insns. */
4096 if (TREE_CODE (INSN_VAR_LOCATION_DECL (insn)) == LABEL_DECL)
4097 break;
4098 /* FALLTHRU */
4099 case INSN:
4100 case CALL_INSN:
4101 case JUMP_INSN:
4102 copy = emit_copy_of_insn_after (insn, get_last_insn ());
4103 if (JUMP_P (insn) && JUMP_LABEL (insn) != NULL_RTX
4104 && ANY_RETURN_P (JUMP_LABEL (insn)))
4105 JUMP_LABEL (copy) = JUMP_LABEL (insn);
4106 maybe_copy_prologue_epilogue_insn (insn, copy);
4107 break;
4109 case JUMP_TABLE_DATA:
4110 /* Avoid copying of dispatch tables. We never duplicate
4111 tablejumps, so this can hit only in case the table got
4112 moved far from original jump.
4113 Avoid copying following barrier as well if any
4114 (and debug insns in between). */
4115 for (next = NEXT_INSN (insn);
4116 next != NEXT_INSN (to);
4117 next = NEXT_INSN (next))
4118 if (!DEBUG_INSN_P (next))
4119 break;
4120 if (next != NEXT_INSN (to) && BARRIER_P (next))
4121 insn = next;
4122 break;
4124 case CODE_LABEL:
4125 break;
4127 case BARRIER:
4128 emit_barrier ();
4129 break;
4131 case NOTE:
4132 switch (NOTE_KIND (insn))
4134 /* In case prologue is empty and function contain label
4135 in first BB, we may want to copy the block. */
4136 case NOTE_INSN_PROLOGUE_END:
4138 case NOTE_INSN_DELETED:
4139 case NOTE_INSN_DELETED_LABEL:
4140 case NOTE_INSN_DELETED_DEBUG_LABEL:
4141 /* No problem to strip these. */
4142 case NOTE_INSN_FUNCTION_BEG:
4143 /* There is always just single entry to function. */
4144 case NOTE_INSN_BASIC_BLOCK:
4145 /* We should only switch text sections once. */
4146 case NOTE_INSN_SWITCH_TEXT_SECTIONS:
4147 break;
4149 case NOTE_INSN_EPILOGUE_BEG:
4150 emit_note_copy (insn);
4151 break;
4153 default:
4154 /* All other notes should have already been eliminated. */
4155 gcc_unreachable ();
4157 break;
4158 default:
4159 gcc_unreachable ();
4162 insn = NEXT_INSN (last);
4163 delete_insn (last);
4164 return insn;
4167 /* Create a duplicate of the basic block BB. */
4169 static basic_block
4170 cfg_layout_duplicate_bb (basic_block bb)
4172 rtx insn;
4173 basic_block new_bb;
4175 insn = duplicate_insn_chain (BB_HEAD (bb), BB_END (bb));
4176 new_bb = create_basic_block (insn,
4177 insn ? get_last_insn () : NULL,
4178 EXIT_BLOCK_PTR_FOR_FN (cfun)->prev_bb);
4180 BB_COPY_PARTITION (new_bb, bb);
4181 if (BB_HEADER (bb))
4183 insn = BB_HEADER (bb);
4184 while (NEXT_INSN (insn))
4185 insn = NEXT_INSN (insn);
4186 insn = duplicate_insn_chain (BB_HEADER (bb), insn);
4187 if (insn)
4188 BB_HEADER (new_bb) = unlink_insn_chain (insn, get_last_insn ());
4191 if (BB_FOOTER (bb))
4193 insn = BB_FOOTER (bb);
4194 while (NEXT_INSN (insn))
4195 insn = NEXT_INSN (insn);
4196 insn = duplicate_insn_chain (BB_FOOTER (bb), insn);
4197 if (insn)
4198 BB_FOOTER (new_bb) = unlink_insn_chain (insn, get_last_insn ());
4201 return new_bb;
4205 /* Main entry point to this module - initialize the datastructures for
4206 CFG layout changes. It keeps LOOPS up-to-date if not null.
4208 FLAGS is a set of additional flags to pass to cleanup_cfg(). */
4210 void
4211 cfg_layout_initialize (unsigned int flags)
4213 rtx x;
4214 basic_block bb;
4216 /* Once bb partitioning is complete, cfg layout mode should not be
4217 re-entered. Entering cfg layout mode may require fixups. As an
4218 example, if edge forwarding performed when optimizing the cfg
4219 layout required moving a block from the hot to the cold
4220 section. This would create an illegal partitioning unless some
4221 manual fixup was performed. */
4222 gcc_assert (!(crtl->bb_reorder_complete
4223 && flag_reorder_blocks_and_partition));
4225 initialize_original_copy_tables ();
4227 cfg_layout_rtl_register_cfg_hooks ();
4229 record_effective_endpoints ();
4231 /* Make sure that the targets of non local gotos are marked. */
4232 for (x = nonlocal_goto_handler_labels; x; x = XEXP (x, 1))
4234 bb = BLOCK_FOR_INSN (XEXP (x, 0));
4235 bb->flags |= BB_NON_LOCAL_GOTO_TARGET;
4238 cleanup_cfg (CLEANUP_CFGLAYOUT | flags);
4241 /* Splits superblocks. */
4242 void
4243 break_superblocks (void)
4245 sbitmap superblocks;
4246 bool need = false;
4247 basic_block bb;
4249 superblocks = sbitmap_alloc (last_basic_block_for_fn (cfun));
4250 bitmap_clear (superblocks);
4252 FOR_EACH_BB_FN (bb, cfun)
4253 if (bb->flags & BB_SUPERBLOCK)
4255 bb->flags &= ~BB_SUPERBLOCK;
4256 bitmap_set_bit (superblocks, bb->index);
4257 need = true;
4260 if (need)
4262 rebuild_jump_labels (get_insns ());
4263 find_many_sub_basic_blocks (superblocks);
4266 free (superblocks);
4269 /* Finalize the changes: reorder insn list according to the sequence specified
4270 by aux pointers, enter compensation code, rebuild scope forest. */
4272 void
4273 cfg_layout_finalize (void)
4275 #ifdef ENABLE_CHECKING
4276 verify_flow_info ();
4277 #endif
4278 force_one_exit_fallthru ();
4279 rtl_register_cfg_hooks ();
4280 if (reload_completed
4281 #ifdef HAVE_epilogue
4282 && !HAVE_epilogue
4283 #endif
4285 fixup_fallthru_exit_predecessor ();
4286 fixup_reorder_chain ();
4288 rebuild_jump_labels (get_insns ());
4289 delete_dead_jumptables ();
4291 #ifdef ENABLE_CHECKING
4292 verify_insn_chain ();
4293 verify_flow_info ();
4294 #endif
4298 /* Same as split_block but update cfg_layout structures. */
4300 static basic_block
4301 cfg_layout_split_block (basic_block bb, void *insnp)
4303 rtx insn = (rtx) insnp;
4304 basic_block new_bb = rtl_split_block (bb, insn);
4306 BB_FOOTER (new_bb) = BB_FOOTER (bb);
4307 BB_FOOTER (bb) = NULL;
4309 return new_bb;
4312 /* Redirect Edge to DEST. */
4313 static edge
4314 cfg_layout_redirect_edge_and_branch (edge e, basic_block dest)
4316 basic_block src = e->src;
4317 edge ret;
4319 if (e->flags & (EDGE_ABNORMAL_CALL | EDGE_EH))
4320 return NULL;
4322 if (e->dest == dest)
4323 return e;
4325 if (e->src != ENTRY_BLOCK_PTR_FOR_FN (cfun)
4326 && (ret = try_redirect_by_replacing_jump (e, dest, true)))
4328 df_set_bb_dirty (src);
4329 return ret;
4332 if (e->src == ENTRY_BLOCK_PTR_FOR_FN (cfun)
4333 && (e->flags & EDGE_FALLTHRU) && !(e->flags & EDGE_COMPLEX))
4335 if (dump_file)
4336 fprintf (dump_file, "Redirecting entry edge from bb %i to %i\n",
4337 e->src->index, dest->index);
4339 df_set_bb_dirty (e->src);
4340 redirect_edge_succ (e, dest);
4341 return e;
4344 /* Redirect_edge_and_branch may decide to turn branch into fallthru edge
4345 in the case the basic block appears to be in sequence. Avoid this
4346 transformation. */
4348 if (e->flags & EDGE_FALLTHRU)
4350 /* Redirect any branch edges unified with the fallthru one. */
4351 if (JUMP_P (BB_END (src))
4352 && label_is_jump_target_p (BB_HEAD (e->dest),
4353 BB_END (src)))
4355 edge redirected;
4357 if (dump_file)
4358 fprintf (dump_file, "Fallthru edge unified with branch "
4359 "%i->%i redirected to %i\n",
4360 e->src->index, e->dest->index, dest->index);
4361 e->flags &= ~EDGE_FALLTHRU;
4362 redirected = redirect_branch_edge (e, dest);
4363 gcc_assert (redirected);
4364 redirected->flags |= EDGE_FALLTHRU;
4365 df_set_bb_dirty (redirected->src);
4366 return redirected;
4368 /* In case we are redirecting fallthru edge to the branch edge
4369 of conditional jump, remove it. */
4370 if (EDGE_COUNT (src->succs) == 2)
4372 /* Find the edge that is different from E. */
4373 edge s = EDGE_SUCC (src, EDGE_SUCC (src, 0) == e);
4375 if (s->dest == dest
4376 && any_condjump_p (BB_END (src))
4377 && onlyjump_p (BB_END (src)))
4378 delete_insn (BB_END (src));
4380 if (dump_file)
4381 fprintf (dump_file, "Redirecting fallthru edge %i->%i to %i\n",
4382 e->src->index, e->dest->index, dest->index);
4383 ret = redirect_edge_succ_nodup (e, dest);
4385 else
4386 ret = redirect_branch_edge (e, dest);
4388 /* We don't want simplejumps in the insn stream during cfglayout. */
4389 gcc_assert (!simplejump_p (BB_END (src)));
4391 df_set_bb_dirty (src);
4392 return ret;
4395 /* Simple wrapper as we always can redirect fallthru edges. */
4396 static basic_block
4397 cfg_layout_redirect_edge_and_branch_force (edge e, basic_block dest)
4399 edge redirected = cfg_layout_redirect_edge_and_branch (e, dest);
4401 gcc_assert (redirected);
4402 return NULL;
4405 /* Same as delete_basic_block but update cfg_layout structures. */
4407 static void
4408 cfg_layout_delete_block (basic_block bb)
4410 rtx insn, next, prev = PREV_INSN (BB_HEAD (bb)), *to, remaints;
4412 if (BB_HEADER (bb))
4414 next = BB_HEAD (bb);
4415 if (prev)
4416 NEXT_INSN (prev) = BB_HEADER (bb);
4417 else
4418 set_first_insn (BB_HEADER (bb));
4419 PREV_INSN (BB_HEADER (bb)) = prev;
4420 insn = BB_HEADER (bb);
4421 while (NEXT_INSN (insn))
4422 insn = NEXT_INSN (insn);
4423 NEXT_INSN (insn) = next;
4424 PREV_INSN (next) = insn;
4426 next = NEXT_INSN (BB_END (bb));
4427 if (BB_FOOTER (bb))
4429 insn = BB_FOOTER (bb);
4430 while (insn)
4432 if (BARRIER_P (insn))
4434 if (PREV_INSN (insn))
4435 NEXT_INSN (PREV_INSN (insn)) = NEXT_INSN (insn);
4436 else
4437 BB_FOOTER (bb) = NEXT_INSN (insn);
4438 if (NEXT_INSN (insn))
4439 PREV_INSN (NEXT_INSN (insn)) = PREV_INSN (insn);
4441 if (LABEL_P (insn))
4442 break;
4443 insn = NEXT_INSN (insn);
4445 if (BB_FOOTER (bb))
4447 insn = BB_END (bb);
4448 NEXT_INSN (insn) = BB_FOOTER (bb);
4449 PREV_INSN (BB_FOOTER (bb)) = insn;
4450 while (NEXT_INSN (insn))
4451 insn = NEXT_INSN (insn);
4452 NEXT_INSN (insn) = next;
4453 if (next)
4454 PREV_INSN (next) = insn;
4455 else
4456 set_last_insn (insn);
4459 if (bb->next_bb != EXIT_BLOCK_PTR_FOR_FN (cfun))
4460 to = &BB_HEADER (bb->next_bb);
4461 else
4462 to = &cfg_layout_function_footer;
4464 rtl_delete_block (bb);
4466 if (prev)
4467 prev = NEXT_INSN (prev);
4468 else
4469 prev = get_insns ();
4470 if (next)
4471 next = PREV_INSN (next);
4472 else
4473 next = get_last_insn ();
4475 if (next && NEXT_INSN (next) != prev)
4477 remaints = unlink_insn_chain (prev, next);
4478 insn = remaints;
4479 while (NEXT_INSN (insn))
4480 insn = NEXT_INSN (insn);
4481 NEXT_INSN (insn) = *to;
4482 if (*to)
4483 PREV_INSN (*to) = insn;
4484 *to = remaints;
4488 /* Return true when blocks A and B can be safely merged. */
4490 static bool
4491 cfg_layout_can_merge_blocks_p (basic_block a, basic_block b)
4493 /* If we are partitioning hot/cold basic blocks, we don't want to
4494 mess up unconditional or indirect jumps that cross between hot
4495 and cold sections.
4497 Basic block partitioning may result in some jumps that appear to
4498 be optimizable (or blocks that appear to be mergeable), but which really
4499 must be left untouched (they are required to make it safely across
4500 partition boundaries). See the comments at the top of
4501 bb-reorder.c:partition_hot_cold_basic_blocks for complete details. */
4503 if (BB_PARTITION (a) != BB_PARTITION (b))
4504 return false;
4506 /* Protect the loop latches. */
4507 if (current_loops && b->loop_father->latch == b)
4508 return false;
4510 /* If we would end up moving B's instructions, make sure it doesn't fall
4511 through into the exit block, since we cannot recover from a fallthrough
4512 edge into the exit block occurring in the middle of a function. */
4513 if (NEXT_INSN (BB_END (a)) != BB_HEAD (b))
4515 edge e = find_fallthru_edge (b->succs);
4516 if (e && e->dest == EXIT_BLOCK_PTR_FOR_FN (cfun))
4517 return false;
4520 /* There must be exactly one edge in between the blocks. */
4521 return (single_succ_p (a)
4522 && single_succ (a) == b
4523 && single_pred_p (b) == 1
4524 && a != b
4525 /* Must be simple edge. */
4526 && !(single_succ_edge (a)->flags & EDGE_COMPLEX)
4527 && a != ENTRY_BLOCK_PTR_FOR_FN (cfun)
4528 && b != EXIT_BLOCK_PTR_FOR_FN (cfun)
4529 /* If the jump insn has side effects, we can't kill the edge.
4530 When not optimizing, try_redirect_by_replacing_jump will
4531 not allow us to redirect an edge by replacing a table jump. */
4532 && (!JUMP_P (BB_END (a))
4533 || ((!optimize || reload_completed)
4534 ? simplejump_p (BB_END (a)) : onlyjump_p (BB_END (a)))));
4537 /* Merge block A and B. The blocks must be mergeable. */
4539 static void
4540 cfg_layout_merge_blocks (basic_block a, basic_block b)
4542 bool forwarder_p = (b->flags & BB_FORWARDER_BLOCK) != 0;
4543 rtx insn;
4545 gcc_checking_assert (cfg_layout_can_merge_blocks_p (a, b));
4547 if (dump_file)
4548 fprintf (dump_file, "Merging block %d into block %d...\n", b->index,
4549 a->index);
4551 /* If there was a CODE_LABEL beginning B, delete it. */
4552 if (LABEL_P (BB_HEAD (b)))
4554 delete_insn (BB_HEAD (b));
4557 /* We should have fallthru edge in a, or we can do dummy redirection to get
4558 it cleaned up. */
4559 if (JUMP_P (BB_END (a)))
4560 try_redirect_by_replacing_jump (EDGE_SUCC (a, 0), b, true);
4561 gcc_assert (!JUMP_P (BB_END (a)));
4563 /* When not optimizing and the edge is the only place in RTL which holds
4564 some unique locus, emit a nop with that locus in between. */
4565 if (!optimize)
4566 emit_nop_for_unique_locus_between (a, b);
4568 /* Move things from b->footer after a->footer. */
4569 if (BB_FOOTER (b))
4571 if (!BB_FOOTER (a))
4572 BB_FOOTER (a) = BB_FOOTER (b);
4573 else
4575 rtx last = BB_FOOTER (a);
4577 while (NEXT_INSN (last))
4578 last = NEXT_INSN (last);
4579 NEXT_INSN (last) = BB_FOOTER (b);
4580 PREV_INSN (BB_FOOTER (b)) = last;
4582 BB_FOOTER (b) = NULL;
4585 /* Move things from b->header before a->footer.
4586 Note that this may include dead tablejump data, but we don't clean
4587 those up until we go out of cfglayout mode. */
4588 if (BB_HEADER (b))
4590 if (! BB_FOOTER (a))
4591 BB_FOOTER (a) = BB_HEADER (b);
4592 else
4594 rtx last = BB_HEADER (b);
4596 while (NEXT_INSN (last))
4597 last = NEXT_INSN (last);
4598 NEXT_INSN (last) = BB_FOOTER (a);
4599 PREV_INSN (BB_FOOTER (a)) = last;
4600 BB_FOOTER (a) = BB_HEADER (b);
4602 BB_HEADER (b) = NULL;
4605 /* In the case basic blocks are not adjacent, move them around. */
4606 if (NEXT_INSN (BB_END (a)) != BB_HEAD (b))
4608 insn = unlink_insn_chain (BB_HEAD (b), BB_END (b));
4610 emit_insn_after_noloc (insn, BB_END (a), a);
4612 /* Otherwise just re-associate the instructions. */
4613 else
4615 insn = BB_HEAD (b);
4616 BB_END (a) = BB_END (b);
4619 /* emit_insn_after_noloc doesn't call df_insn_change_bb.
4620 We need to explicitly call. */
4621 update_bb_for_insn_chain (insn, BB_END (b), a);
4623 /* Skip possible DELETED_LABEL insn. */
4624 if (!NOTE_INSN_BASIC_BLOCK_P (insn))
4625 insn = NEXT_INSN (insn);
4626 gcc_assert (NOTE_INSN_BASIC_BLOCK_P (insn));
4627 BB_HEAD (b) = BB_END (b) = NULL;
4628 delete_insn (insn);
4630 df_bb_delete (b->index);
4632 /* If B was a forwarder block, propagate the locus on the edge. */
4633 if (forwarder_p
4634 && LOCATION_LOCUS (EDGE_SUCC (b, 0)->goto_locus) == UNKNOWN_LOCATION)
4635 EDGE_SUCC (b, 0)->goto_locus = EDGE_SUCC (a, 0)->goto_locus;
4637 if (dump_file)
4638 fprintf (dump_file, "Merged blocks %d and %d.\n", a->index, b->index);
4641 /* Split edge E. */
4643 static basic_block
4644 cfg_layout_split_edge (edge e)
4646 basic_block new_bb =
4647 create_basic_block (e->src != ENTRY_BLOCK_PTR_FOR_FN (cfun)
4648 ? NEXT_INSN (BB_END (e->src)) : get_insns (),
4649 NULL_RTX, e->src);
4651 if (e->dest == EXIT_BLOCK_PTR_FOR_FN (cfun))
4652 BB_COPY_PARTITION (new_bb, e->src);
4653 else
4654 BB_COPY_PARTITION (new_bb, e->dest);
4655 make_edge (new_bb, e->dest, EDGE_FALLTHRU);
4656 redirect_edge_and_branch_force (e, new_bb);
4658 return new_bb;
4661 /* Do postprocessing after making a forwarder block joined by edge FALLTHRU. */
4663 static void
4664 rtl_make_forwarder_block (edge fallthru ATTRIBUTE_UNUSED)
4668 /* Return true if BB contains only labels or non-executable
4669 instructions. */
4671 static bool
4672 rtl_block_empty_p (basic_block bb)
4674 rtx insn;
4676 if (bb == ENTRY_BLOCK_PTR_FOR_FN (cfun)
4677 || bb == EXIT_BLOCK_PTR_FOR_FN (cfun))
4678 return true;
4680 FOR_BB_INSNS (bb, insn)
4681 if (NONDEBUG_INSN_P (insn) && !any_uncondjump_p (insn))
4682 return false;
4684 return true;
4687 /* Split a basic block if it ends with a conditional branch and if
4688 the other part of the block is not empty. */
4690 static basic_block
4691 rtl_split_block_before_cond_jump (basic_block bb)
4693 rtx insn;
4694 rtx split_point = NULL;
4695 rtx last = NULL;
4696 bool found_code = false;
4698 FOR_BB_INSNS (bb, insn)
4700 if (any_condjump_p (insn))
4701 split_point = last;
4702 else if (NONDEBUG_INSN_P (insn))
4703 found_code = true;
4704 last = insn;
4707 /* Did not find everything. */
4708 if (found_code && split_point)
4709 return split_block (bb, split_point)->dest;
4710 else
4711 return NULL;
4714 /* Return 1 if BB ends with a call, possibly followed by some
4715 instructions that must stay with the call, 0 otherwise. */
4717 static bool
4718 rtl_block_ends_with_call_p (basic_block bb)
4720 rtx insn = BB_END (bb);
4722 while (!CALL_P (insn)
4723 && insn != BB_HEAD (bb)
4724 && (keep_with_call_p (insn)
4725 || NOTE_P (insn)
4726 || DEBUG_INSN_P (insn)))
4727 insn = PREV_INSN (insn);
4728 return (CALL_P (insn));
4731 /* Return 1 if BB ends with a conditional branch, 0 otherwise. */
4733 static bool
4734 rtl_block_ends_with_condjump_p (const_basic_block bb)
4736 return any_condjump_p (BB_END (bb));
4739 /* Return true if we need to add fake edge to exit.
4740 Helper function for rtl_flow_call_edges_add. */
4742 static bool
4743 need_fake_edge_p (const_rtx insn)
4745 if (!INSN_P (insn))
4746 return false;
4748 if ((CALL_P (insn)
4749 && !SIBLING_CALL_P (insn)
4750 && !find_reg_note (insn, REG_NORETURN, NULL)
4751 && !(RTL_CONST_OR_PURE_CALL_P (insn))))
4752 return true;
4754 return ((GET_CODE (PATTERN (insn)) == ASM_OPERANDS
4755 && MEM_VOLATILE_P (PATTERN (insn)))
4756 || (GET_CODE (PATTERN (insn)) == PARALLEL
4757 && asm_noperands (insn) != -1
4758 && MEM_VOLATILE_P (XVECEXP (PATTERN (insn), 0, 0)))
4759 || GET_CODE (PATTERN (insn)) == ASM_INPUT);
4762 /* Add fake edges to the function exit for any non constant and non noreturn
4763 calls, volatile inline assembly in the bitmap of blocks specified by
4764 BLOCKS or to the whole CFG if BLOCKS is zero. Return the number of blocks
4765 that were split.
4767 The goal is to expose cases in which entering a basic block does not imply
4768 that all subsequent instructions must be executed. */
4770 static int
4771 rtl_flow_call_edges_add (sbitmap blocks)
4773 int i;
4774 int blocks_split = 0;
4775 int last_bb = last_basic_block_for_fn (cfun);
4776 bool check_last_block = false;
4778 if (n_basic_blocks_for_fn (cfun) == NUM_FIXED_BLOCKS)
4779 return 0;
4781 if (! blocks)
4782 check_last_block = true;
4783 else
4784 check_last_block = bitmap_bit_p (blocks,
4785 EXIT_BLOCK_PTR_FOR_FN (cfun)->prev_bb->index);
4787 /* In the last basic block, before epilogue generation, there will be
4788 a fallthru edge to EXIT. Special care is required if the last insn
4789 of the last basic block is a call because make_edge folds duplicate
4790 edges, which would result in the fallthru edge also being marked
4791 fake, which would result in the fallthru edge being removed by
4792 remove_fake_edges, which would result in an invalid CFG.
4794 Moreover, we can't elide the outgoing fake edge, since the block
4795 profiler needs to take this into account in order to solve the minimal
4796 spanning tree in the case that the call doesn't return.
4798 Handle this by adding a dummy instruction in a new last basic block. */
4799 if (check_last_block)
4801 basic_block bb = EXIT_BLOCK_PTR_FOR_FN (cfun)->prev_bb;
4802 rtx insn = BB_END (bb);
4804 /* Back up past insns that must be kept in the same block as a call. */
4805 while (insn != BB_HEAD (bb)
4806 && keep_with_call_p (insn))
4807 insn = PREV_INSN (insn);
4809 if (need_fake_edge_p (insn))
4811 edge e;
4813 e = find_edge (bb, EXIT_BLOCK_PTR_FOR_FN (cfun));
4814 if (e)
4816 insert_insn_on_edge (gen_use (const0_rtx), e);
4817 commit_edge_insertions ();
4822 /* Now add fake edges to the function exit for any non constant
4823 calls since there is no way that we can determine if they will
4824 return or not... */
4826 for (i = NUM_FIXED_BLOCKS; i < last_bb; i++)
4828 basic_block bb = BASIC_BLOCK_FOR_FN (cfun, i);
4829 rtx insn;
4830 rtx prev_insn;
4832 if (!bb)
4833 continue;
4835 if (blocks && !bitmap_bit_p (blocks, i))
4836 continue;
4838 for (insn = BB_END (bb); ; insn = prev_insn)
4840 prev_insn = PREV_INSN (insn);
4841 if (need_fake_edge_p (insn))
4843 edge e;
4844 rtx split_at_insn = insn;
4846 /* Don't split the block between a call and an insn that should
4847 remain in the same block as the call. */
4848 if (CALL_P (insn))
4849 while (split_at_insn != BB_END (bb)
4850 && keep_with_call_p (NEXT_INSN (split_at_insn)))
4851 split_at_insn = NEXT_INSN (split_at_insn);
4853 /* The handling above of the final block before the epilogue
4854 should be enough to verify that there is no edge to the exit
4855 block in CFG already. Calling make_edge in such case would
4856 cause us to mark that edge as fake and remove it later. */
4858 #ifdef ENABLE_CHECKING
4859 if (split_at_insn == BB_END (bb))
4861 e = find_edge (bb, EXIT_BLOCK_PTR_FOR_FN (cfun));
4862 gcc_assert (e == NULL);
4864 #endif
4866 /* Note that the following may create a new basic block
4867 and renumber the existing basic blocks. */
4868 if (split_at_insn != BB_END (bb))
4870 e = split_block (bb, split_at_insn);
4871 if (e)
4872 blocks_split++;
4875 make_edge (bb, EXIT_BLOCK_PTR_FOR_FN (cfun), EDGE_FAKE);
4878 if (insn == BB_HEAD (bb))
4879 break;
4883 if (blocks_split)
4884 verify_flow_info ();
4886 return blocks_split;
4889 /* Add COMP_RTX as a condition at end of COND_BB. FIRST_HEAD is
4890 the conditional branch target, SECOND_HEAD should be the fall-thru
4891 there is no need to handle this here the loop versioning code handles
4892 this. the reason for SECON_HEAD is that it is needed for condition
4893 in trees, and this should be of the same type since it is a hook. */
4894 static void
4895 rtl_lv_add_condition_to_bb (basic_block first_head ,
4896 basic_block second_head ATTRIBUTE_UNUSED,
4897 basic_block cond_bb, void *comp_rtx)
4899 rtx label, seq, jump;
4900 rtx op0 = XEXP ((rtx)comp_rtx, 0);
4901 rtx op1 = XEXP ((rtx)comp_rtx, 1);
4902 enum rtx_code comp = GET_CODE ((rtx)comp_rtx);
4903 enum machine_mode mode;
4906 label = block_label (first_head);
4907 mode = GET_MODE (op0);
4908 if (mode == VOIDmode)
4909 mode = GET_MODE (op1);
4911 start_sequence ();
4912 op0 = force_operand (op0, NULL_RTX);
4913 op1 = force_operand (op1, NULL_RTX);
4914 do_compare_rtx_and_jump (op0, op1, comp, 0,
4915 mode, NULL_RTX, NULL_RTX, label, -1);
4916 jump = get_last_insn ();
4917 JUMP_LABEL (jump) = label;
4918 LABEL_NUSES (label)++;
4919 seq = get_insns ();
4920 end_sequence ();
4922 /* Add the new cond , in the new head. */
4923 emit_insn_after (seq, BB_END (cond_bb));
4927 /* Given a block B with unconditional branch at its end, get the
4928 store the return the branch edge and the fall-thru edge in
4929 BRANCH_EDGE and FALLTHRU_EDGE respectively. */
4930 static void
4931 rtl_extract_cond_bb_edges (basic_block b, edge *branch_edge,
4932 edge *fallthru_edge)
4934 edge e = EDGE_SUCC (b, 0);
4936 if (e->flags & EDGE_FALLTHRU)
4938 *fallthru_edge = e;
4939 *branch_edge = EDGE_SUCC (b, 1);
4941 else
4943 *branch_edge = e;
4944 *fallthru_edge = EDGE_SUCC (b, 1);
4948 void
4949 init_rtl_bb_info (basic_block bb)
4951 gcc_assert (!bb->il.x.rtl);
4952 bb->il.x.head_ = NULL;
4953 bb->il.x.rtl = ggc_cleared_alloc<rtl_bb_info> ();
4956 /* Returns true if it is possible to remove edge E by redirecting
4957 it to the destination of the other edge from E->src. */
4959 static bool
4960 rtl_can_remove_branch_p (const_edge e)
4962 const_basic_block src = e->src;
4963 const_basic_block target = EDGE_SUCC (src, EDGE_SUCC (src, 0) == e)->dest;
4964 const_rtx insn = BB_END (src), set;
4966 /* The conditions are taken from try_redirect_by_replacing_jump. */
4967 if (target == EXIT_BLOCK_PTR_FOR_FN (cfun))
4968 return false;
4970 if (e->flags & (EDGE_ABNORMAL_CALL | EDGE_EH))
4971 return false;
4973 if (BB_PARTITION (src) != BB_PARTITION (target))
4974 return false;
4976 if (!onlyjump_p (insn)
4977 || tablejump_p (insn, NULL, NULL))
4978 return false;
4980 set = single_set (insn);
4981 if (!set || side_effects_p (set))
4982 return false;
4984 return true;
4987 static basic_block
4988 rtl_duplicate_bb (basic_block bb)
4990 bb = cfg_layout_duplicate_bb (bb);
4991 bb->aux = NULL;
4992 return bb;
4995 /* Do book-keeping of basic block BB for the profile consistency checker.
4996 If AFTER_PASS is 0, do pre-pass accounting, or if AFTER_PASS is 1
4997 then do post-pass accounting. Store the counting in RECORD. */
4998 static void
4999 rtl_account_profile_record (basic_block bb, int after_pass,
5000 struct profile_record *record)
5002 rtx insn;
5003 FOR_BB_INSNS (bb, insn)
5004 if (INSN_P (insn))
5006 record->size[after_pass]
5007 += insn_rtx_cost (PATTERN (insn), false);
5008 if (profile_status_for_fn (cfun) == PROFILE_READ)
5009 record->time[after_pass]
5010 += insn_rtx_cost (PATTERN (insn), true) * bb->count;
5011 else if (profile_status_for_fn (cfun) == PROFILE_GUESSED)
5012 record->time[after_pass]
5013 += insn_rtx_cost (PATTERN (insn), true) * bb->frequency;
5017 /* Implementation of CFG manipulation for linearized RTL. */
5018 struct cfg_hooks rtl_cfg_hooks = {
5019 "rtl",
5020 rtl_verify_flow_info,
5021 rtl_dump_bb,
5022 rtl_dump_bb_for_graph,
5023 rtl_create_basic_block,
5024 rtl_redirect_edge_and_branch,
5025 rtl_redirect_edge_and_branch_force,
5026 rtl_can_remove_branch_p,
5027 rtl_delete_block,
5028 rtl_split_block,
5029 rtl_move_block_after,
5030 rtl_can_merge_blocks, /* can_merge_blocks_p */
5031 rtl_merge_blocks,
5032 rtl_predict_edge,
5033 rtl_predicted_by_p,
5034 cfg_layout_can_duplicate_bb_p,
5035 rtl_duplicate_bb,
5036 rtl_split_edge,
5037 rtl_make_forwarder_block,
5038 rtl_tidy_fallthru_edge,
5039 rtl_force_nonfallthru,
5040 rtl_block_ends_with_call_p,
5041 rtl_block_ends_with_condjump_p,
5042 rtl_flow_call_edges_add,
5043 NULL, /* execute_on_growing_pred */
5044 NULL, /* execute_on_shrinking_pred */
5045 NULL, /* duplicate loop for trees */
5046 NULL, /* lv_add_condition_to_bb */
5047 NULL, /* lv_adjust_loop_header_phi*/
5048 NULL, /* extract_cond_bb_edges */
5049 NULL, /* flush_pending_stmts */
5050 rtl_block_empty_p, /* block_empty_p */
5051 rtl_split_block_before_cond_jump, /* split_block_before_cond_jump */
5052 rtl_account_profile_record,
5055 /* Implementation of CFG manipulation for cfg layout RTL, where
5056 basic block connected via fallthru edges does not have to be adjacent.
5057 This representation will hopefully become the default one in future
5058 version of the compiler. */
5060 struct cfg_hooks cfg_layout_rtl_cfg_hooks = {
5061 "cfglayout mode",
5062 rtl_verify_flow_info_1,
5063 rtl_dump_bb,
5064 rtl_dump_bb_for_graph,
5065 cfg_layout_create_basic_block,
5066 cfg_layout_redirect_edge_and_branch,
5067 cfg_layout_redirect_edge_and_branch_force,
5068 rtl_can_remove_branch_p,
5069 cfg_layout_delete_block,
5070 cfg_layout_split_block,
5071 rtl_move_block_after,
5072 cfg_layout_can_merge_blocks_p,
5073 cfg_layout_merge_blocks,
5074 rtl_predict_edge,
5075 rtl_predicted_by_p,
5076 cfg_layout_can_duplicate_bb_p,
5077 cfg_layout_duplicate_bb,
5078 cfg_layout_split_edge,
5079 rtl_make_forwarder_block,
5080 NULL, /* tidy_fallthru_edge */
5081 rtl_force_nonfallthru,
5082 rtl_block_ends_with_call_p,
5083 rtl_block_ends_with_condjump_p,
5084 rtl_flow_call_edges_add,
5085 NULL, /* execute_on_growing_pred */
5086 NULL, /* execute_on_shrinking_pred */
5087 duplicate_loop_to_header_edge, /* duplicate loop for trees */
5088 rtl_lv_add_condition_to_bb, /* lv_add_condition_to_bb */
5089 NULL, /* lv_adjust_loop_header_phi*/
5090 rtl_extract_cond_bb_edges, /* extract_cond_bb_edges */
5091 NULL, /* flush_pending_stmts */
5092 rtl_block_empty_p, /* block_empty_p */
5093 rtl_split_block_before_cond_jump, /* split_block_before_cond_jump */
5094 rtl_account_profile_record,
5097 #include "gt-cfgrtl.h"