basic-block.h (BB_FLAGS_TO_PRESERVE): New define.
[platform/upstream/gcc.git] / gcc / cfgrtl.c
1 /* Control flow graph manipulation code for GNU compiler.
2    Copyright (C) 1987, 1988, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
3    1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
4    2011, 2012 Free Software Foundation, Inc.
5
6 This file is part of GCC.
7
8 GCC is free software; you can redistribute it and/or modify it under
9 the terms of the GNU General Public License as published by the Free
10 Software Foundation; either version 3, or (at your option) any later
11 version.
12
13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
16 for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING3.  If not see
20 <http://www.gnu.org/licenses/>.  */
21
22 /* This file contains low level functions to manipulate the CFG and analyze it
23    that are aware of the RTL intermediate language.
24
25    Available functionality:
26      - Basic CFG/RTL manipulation API documented in cfghooks.h
27      - CFG-aware instruction chain manipulation
28          delete_insn, delete_insn_chain
29      - Edge splitting and committing to edges
30          insert_insn_on_edge, commit_edge_insertions
31      - CFG updating after insn simplification
32          purge_dead_edges, purge_all_dead_edges
33      - CFG fixing after coarse manipulation
34         fixup_abnormal_edges
35
36    Functions not supposed for generic use:
37      - Infrastructure to determine quickly basic block for insn
38          compute_bb_for_insn, update_bb_for_insn, set_block_for_insn,
39      - Edge redirection with updating and optimizing of insn chain
40          block_label, tidy_fallthru_edge, force_nonfallthru  */
41 \f
42 #include "config.h"
43 #include "system.h"
44 #include "coretypes.h"
45 #include "tm.h"
46 #include "tree.h"
47 #include "hard-reg-set.h"
48 #include "basic-block.h"
49 #include "regs.h"
50 #include "flags.h"
51 #include "function.h"
52 #include "except.h"
53 #include "rtl-error.h"
54 #include "tm_p.h"
55 #include "obstack.h"
56 #include "insn-attr.h"
57 #include "insn-config.h"
58 #include "expr.h"
59 #include "target.h"
60 #include "common/common-target.h"
61 #include "cfgloop.h"
62 #include "ggc.h"
63 #include "tree-pass.h"
64 #include "df.h"
65
66 /* Holds the interesting leading and trailing notes for the function.
67    Only applicable if the CFG is in cfglayout mode.  */
68 static GTY(()) rtx cfg_layout_function_footer;
69 static GTY(()) rtx cfg_layout_function_header;
70
71 static rtx skip_insns_after_block (basic_block);
72 static void record_effective_endpoints (void);
73 static rtx label_for_bb (basic_block);
74 static void fixup_reorder_chain (void);
75
76 void verify_insn_chain (void);
77 static void fixup_fallthru_exit_predecessor (void);
78 static int can_delete_note_p (const_rtx);
79 static int can_delete_label_p (const_rtx);
80 static basic_block rtl_split_edge (edge);
81 static bool rtl_move_block_after (basic_block, basic_block);
82 static int rtl_verify_flow_info (void);
83 static basic_block cfg_layout_split_block (basic_block, void *);
84 static edge cfg_layout_redirect_edge_and_branch (edge, basic_block);
85 static basic_block cfg_layout_redirect_edge_and_branch_force (edge, basic_block);
86 static void cfg_layout_delete_block (basic_block);
87 static void rtl_delete_block (basic_block);
88 static basic_block rtl_redirect_edge_and_branch_force (edge, basic_block);
89 static edge rtl_redirect_edge_and_branch (edge, basic_block);
90 static basic_block rtl_split_block (basic_block, void *);
91 static void rtl_dump_bb (FILE *, basic_block, int, int);
92 static int rtl_verify_flow_info_1 (void);
93 static void rtl_make_forwarder_block (edge);
94 \f
95 /* Return true if NOTE is not one of the ones that must be kept paired,
96    so that we may simply delete it.  */
97
98 static int
99 can_delete_note_p (const_rtx note)
100 {
101   switch (NOTE_KIND (note))
102     {
103     case NOTE_INSN_DELETED:
104     case NOTE_INSN_BASIC_BLOCK:
105     case NOTE_INSN_EPILOGUE_BEG:
106       return true;
107
108     default:
109       return false;
110     }
111 }
112
113 /* True if a given label can be deleted.  */
114
115 static int
116 can_delete_label_p (const_rtx label)
117 {
118   return (!LABEL_PRESERVE_P (label)
119           /* User declared labels must be preserved.  */
120           && LABEL_NAME (label) == 0
121           && !in_expr_list_p (forced_labels, label));
122 }
123
124 /* Delete INSN by patching it out.  */
125
126 void
127 delete_insn (rtx insn)
128 {
129   rtx note;
130   bool really_delete = true;
131
132   if (LABEL_P (insn))
133     {
134       /* Some labels can't be directly removed from the INSN chain, as they
135          might be references via variables, constant pool etc.
136          Convert them to the special NOTE_INSN_DELETED_LABEL note.  */
137       if (! can_delete_label_p (insn))
138         {
139           const char *name = LABEL_NAME (insn);
140           basic_block bb = BLOCK_FOR_INSN (insn);
141           rtx bb_note = NEXT_INSN (insn);
142
143           really_delete = false;
144           PUT_CODE (insn, NOTE);
145           NOTE_KIND (insn) = NOTE_INSN_DELETED_LABEL;
146           NOTE_DELETED_LABEL_NAME (insn) = name;
147
148           if (bb_note != NULL_RTX && NOTE_INSN_BASIC_BLOCK_P (bb_note)
149               && BLOCK_FOR_INSN (bb_note) == bb)
150             {
151               reorder_insns_nobb (insn, insn, bb_note);
152               BB_HEAD (bb) = bb_note;
153               if (BB_END (bb) == bb_note)
154                 BB_END (bb) = insn;
155             }
156         }
157
158       remove_node_from_expr_list (insn, &nonlocal_goto_handler_labels);
159     }
160
161   if (really_delete)
162     {
163       /* If this insn has already been deleted, something is very wrong.  */
164       gcc_assert (!INSN_DELETED_P (insn));
165       remove_insn (insn);
166       INSN_DELETED_P (insn) = 1;
167     }
168
169   /* If deleting a jump, decrement the use count of the label.  Deleting
170      the label itself should happen in the normal course of block merging.  */
171   if (JUMP_P (insn))
172     {
173       if (JUMP_LABEL (insn)
174           && LABEL_P (JUMP_LABEL (insn)))
175         LABEL_NUSES (JUMP_LABEL (insn))--;
176
177       /* If there are more targets, remove them too.  */
178       while ((note
179               = find_reg_note (insn, REG_LABEL_TARGET, NULL_RTX)) != NULL_RTX
180              && LABEL_P (XEXP (note, 0)))
181         {
182           LABEL_NUSES (XEXP (note, 0))--;
183           remove_note (insn, note);
184         }
185     }
186
187   /* Also if deleting any insn that references a label as an operand.  */
188   while ((note = find_reg_note (insn, REG_LABEL_OPERAND, NULL_RTX)) != NULL_RTX
189          && LABEL_P (XEXP (note, 0)))
190     {
191       LABEL_NUSES (XEXP (note, 0))--;
192       remove_note (insn, note);
193     }
194
195   if (JUMP_TABLE_DATA_P (insn))
196     {
197       rtx pat = PATTERN (insn);
198       int diff_vec_p = GET_CODE (PATTERN (insn)) == ADDR_DIFF_VEC;
199       int len = XVECLEN (pat, diff_vec_p);
200       int i;
201
202       for (i = 0; i < len; i++)
203         {
204           rtx label = XEXP (XVECEXP (pat, diff_vec_p, i), 0);
205
206           /* When deleting code in bulk (e.g. removing many unreachable
207              blocks) we can delete a label that's a target of the vector
208              before deleting the vector itself.  */
209           if (!NOTE_P (label))
210             LABEL_NUSES (label)--;
211         }
212     }
213 }
214
215 /* Like delete_insn but also purge dead edges from BB.  */
216
217 void
218 delete_insn_and_edges (rtx insn)
219 {
220   bool purge = false;
221
222   if (INSN_P (insn)
223       && BLOCK_FOR_INSN (insn)
224       && BB_END (BLOCK_FOR_INSN (insn)) == insn)
225     purge = true;
226   delete_insn (insn);
227   if (purge)
228     purge_dead_edges (BLOCK_FOR_INSN (insn));
229 }
230
231 /* Unlink a chain of insns between START and FINISH, leaving notes
232    that must be paired.  If CLEAR_BB is true, we set bb field for
233    insns that cannot be removed to NULL.  */
234
235 void
236 delete_insn_chain (rtx start, rtx finish, bool clear_bb)
237 {
238   rtx prev, current;
239
240   /* Unchain the insns one by one.  It would be quicker to delete all of these
241      with a single unchaining, rather than one at a time, but we need to keep
242      the NOTE's.  */
243   current = finish;
244   while (1)
245     {
246       prev = PREV_INSN (current);
247       if (NOTE_P (current) && !can_delete_note_p (current))
248         ;
249       else
250         delete_insn (current);
251
252       if (clear_bb && !INSN_DELETED_P (current))
253         set_block_for_insn (current, NULL);
254
255       if (current == start)
256         break;
257       current = prev;
258     }
259 }
260 \f
261 /* Create a new basic block consisting of the instructions between HEAD and END
262    inclusive.  This function is designed to allow fast BB construction - reuses
263    the note and basic block struct in BB_NOTE, if any and do not grow
264    BASIC_BLOCK chain and should be used directly only by CFG construction code.
265    END can be NULL in to create new empty basic block before HEAD.  Both END
266    and HEAD can be NULL to create basic block at the end of INSN chain.
267    AFTER is the basic block we should be put after.  */
268
269 basic_block
270 create_basic_block_structure (rtx head, rtx end, rtx bb_note, basic_block after)
271 {
272   basic_block bb;
273
274   if (bb_note
275       && (bb = NOTE_BASIC_BLOCK (bb_note)) != NULL
276       && bb->aux == NULL)
277     {
278       /* If we found an existing note, thread it back onto the chain.  */
279
280       rtx after;
281
282       if (LABEL_P (head))
283         after = head;
284       else
285         {
286           after = PREV_INSN (head);
287           head = bb_note;
288         }
289
290       if (after != bb_note && NEXT_INSN (after) != bb_note)
291         reorder_insns_nobb (bb_note, bb_note, after);
292     }
293   else
294     {
295       /* Otherwise we must create a note and a basic block structure.  */
296
297       bb = alloc_block ();
298
299       init_rtl_bb_info (bb);
300       if (!head && !end)
301         head = end = bb_note
302           = emit_note_after (NOTE_INSN_BASIC_BLOCK, get_last_insn ());
303       else if (LABEL_P (head) && end)
304         {
305           bb_note = emit_note_after (NOTE_INSN_BASIC_BLOCK, head);
306           if (head == end)
307             end = bb_note;
308         }
309       else
310         {
311           bb_note = emit_note_before (NOTE_INSN_BASIC_BLOCK, head);
312           head = bb_note;
313           if (!end)
314             end = head;
315         }
316
317       NOTE_BASIC_BLOCK (bb_note) = bb;
318     }
319
320   /* Always include the bb note in the block.  */
321   if (NEXT_INSN (end) == bb_note)
322     end = bb_note;
323
324   BB_HEAD (bb) = head;
325   BB_END (bb) = end;
326   bb->index = last_basic_block++;
327   bb->flags = BB_NEW | BB_RTL;
328   link_block (bb, after);
329   SET_BASIC_BLOCK (bb->index, bb);
330   df_bb_refs_record (bb->index, false);
331   update_bb_for_insn (bb);
332   BB_SET_PARTITION (bb, BB_UNPARTITIONED);
333
334   /* Tag the block so that we know it has been used when considering
335      other basic block notes.  */
336   bb->aux = bb;
337
338   return bb;
339 }
340
341 /* Create new basic block consisting of instructions in between HEAD and END
342    and place it to the BB chain after block AFTER.  END can be NULL to
343    create a new empty basic block before HEAD.  Both END and HEAD can be
344    NULL to create basic block at the end of INSN chain.  */
345
346 static basic_block
347 rtl_create_basic_block (void *headp, void *endp, basic_block after)
348 {
349   rtx head = (rtx) headp, end = (rtx) endp;
350   basic_block bb;
351
352   /* Grow the basic block array if needed.  */
353   if ((size_t) last_basic_block >= VEC_length (basic_block, basic_block_info))
354     {
355       size_t new_size = last_basic_block + (last_basic_block + 3) / 4;
356       VEC_safe_grow_cleared (basic_block, gc, basic_block_info, new_size);
357     }
358
359   n_basic_blocks++;
360
361   bb = create_basic_block_structure (head, end, NULL, after);
362   bb->aux = NULL;
363   return bb;
364 }
365
366 static basic_block
367 cfg_layout_create_basic_block (void *head, void *end, basic_block after)
368 {
369   basic_block newbb = rtl_create_basic_block (head, end, after);
370
371   return newbb;
372 }
373 \f
374 /* Delete the insns in a (non-live) block.  We physically delete every
375    non-deleted-note insn, and update the flow graph appropriately.
376
377    Return nonzero if we deleted an exception handler.  */
378
379 /* ??? Preserving all such notes strikes me as wrong.  It would be nice
380    to post-process the stream to remove empty blocks, loops, ranges, etc.  */
381
382 static void
383 rtl_delete_block (basic_block b)
384 {
385   rtx insn, end;
386
387   /* If the head of this block is a CODE_LABEL, then it might be the
388      label for an exception handler which can't be reached.  We need
389      to remove the label from the exception_handler_label list.  */
390   insn = BB_HEAD (b);
391
392   end = get_last_bb_insn (b);
393
394   /* Selectively delete the entire chain.  */
395   BB_HEAD (b) = NULL;
396   delete_insn_chain (insn, end, true);
397
398
399   if (dump_file)
400     fprintf (dump_file, "deleting block %d\n", b->index);
401   df_bb_delete (b->index);
402 }
403 \f
404 /* Records the basic block struct in BLOCK_FOR_INSN for every insn.  */
405
406 void
407 compute_bb_for_insn (void)
408 {
409   basic_block bb;
410
411   FOR_EACH_BB (bb)
412     {
413       rtx end = BB_END (bb);
414       rtx insn;
415
416       for (insn = BB_HEAD (bb); ; insn = NEXT_INSN (insn))
417         {
418           BLOCK_FOR_INSN (insn) = bb;
419           if (insn == end)
420             break;
421         }
422     }
423 }
424
425 /* Release the basic_block_for_insn array.  */
426
427 unsigned int
428 free_bb_for_insn (void)
429 {
430   rtx insn;
431   for (insn = get_insns (); insn; insn = NEXT_INSN (insn))
432     if (!BARRIER_P (insn))
433       BLOCK_FOR_INSN (insn) = NULL;
434   return 0;
435 }
436
437 static unsigned int
438 rest_of_pass_free_cfg (void)
439 {
440 #ifdef DELAY_SLOTS
441   /* The resource.c machinery uses DF but the CFG isn't guaranteed to be
442      valid at that point so it would be too late to call df_analyze.  */
443   if (optimize > 0 && flag_delayed_branch)
444     {
445       df_note_add_problem ();
446       df_analyze ();
447     }
448 #endif
449
450   free_bb_for_insn ();
451   return 0;
452 }
453
454 struct rtl_opt_pass pass_free_cfg =
455 {
456  {
457   RTL_PASS,
458   "*free_cfg",                          /* name */
459   NULL,                                 /* gate */
460   rest_of_pass_free_cfg,                /* execute */
461   NULL,                                 /* sub */
462   NULL,                                 /* next */
463   0,                                    /* static_pass_number */
464   TV_NONE,                              /* tv_id */
465   0,                                    /* properties_required */
466   0,                                    /* properties_provided */
467   PROP_cfg,                             /* properties_destroyed */
468   0,                                    /* todo_flags_start */
469   0,                                    /* todo_flags_finish */
470  }
471 };
472
473 /* Return RTX to emit after when we want to emit code on the entry of function.  */
474 rtx
475 entry_of_function (void)
476 {
477   return (n_basic_blocks > NUM_FIXED_BLOCKS ?
478           BB_HEAD (ENTRY_BLOCK_PTR->next_bb) : get_insns ());
479 }
480
481 /* Emit INSN at the entry point of the function, ensuring that it is only
482    executed once per function.  */
483 void
484 emit_insn_at_entry (rtx insn)
485 {
486   edge_iterator ei = ei_start (ENTRY_BLOCK_PTR->succs);
487   edge e = ei_safe_edge (ei);
488   gcc_assert (e->flags & EDGE_FALLTHRU);
489
490   insert_insn_on_edge (insn, e);
491   commit_edge_insertions ();
492 }
493
494 /* Update BLOCK_FOR_INSN of insns between BEGIN and END
495    (or BARRIER if found) and notify df of the bb change.
496    The insn chain range is inclusive
497    (i.e. both BEGIN and END will be updated. */
498
499 static void
500 update_bb_for_insn_chain (rtx begin, rtx end, basic_block bb)
501 {
502   rtx insn;
503
504   end = NEXT_INSN (end);
505   for (insn = begin; insn != end; insn = NEXT_INSN (insn))
506     if (!BARRIER_P (insn))
507       df_insn_change_bb (insn, bb);
508 }
509
510 /* Update BLOCK_FOR_INSN of insns in BB to BB,
511    and notify df of the change.  */
512
513 void
514 update_bb_for_insn (basic_block bb)
515 {
516   update_bb_for_insn_chain (BB_HEAD (bb), BB_END (bb), bb);
517 }
518
519 \f
520 /* Like active_insn_p, except keep the return value clobber around
521    even after reload.  */
522
523 static bool
524 flow_active_insn_p (const_rtx insn)
525 {
526   if (active_insn_p (insn))
527     return true;
528
529   /* A clobber of the function return value exists for buggy
530      programs that fail to return a value.  Its effect is to
531      keep the return value from being live across the entire
532      function.  If we allow it to be skipped, we introduce the
533      possibility for register lifetime confusion.  */
534   if (GET_CODE (PATTERN (insn)) == CLOBBER
535       && REG_P (XEXP (PATTERN (insn), 0))
536       && REG_FUNCTION_VALUE_P (XEXP (PATTERN (insn), 0)))
537     return true;
538
539   return false;
540 }
541
542 /* Return true if the block has no effect and only forwards control flow to
543    its single destination.  */
544 /* FIXME: Make this a cfg hook.  */
545
546 bool
547 forwarder_block_p (const_basic_block bb)
548 {
549   rtx insn;
550
551   if (bb == EXIT_BLOCK_PTR || bb == ENTRY_BLOCK_PTR
552       || !single_succ_p (bb))
553     return false;
554
555   /* Protect loop latches, headers and preheaders.  */
556   if (current_loops)
557     {
558       basic_block dest;
559       if (bb->loop_father->header == bb)
560         return false;
561       dest = EDGE_SUCC (bb, 0)->dest;
562       if (dest->loop_father->header == dest)
563         return false;
564     }
565
566   for (insn = BB_HEAD (bb); insn != BB_END (bb); insn = NEXT_INSN (insn))
567     if (INSN_P (insn) && flow_active_insn_p (insn))
568       return false;
569
570   return (!INSN_P (insn)
571           || (JUMP_P (insn) && simplejump_p (insn))
572           || !flow_active_insn_p (insn));
573 }
574
575 /* Return nonzero if we can reach target from src by falling through.  */
576 /* FIXME: Make this a cfg hook.  */
577
578 bool
579 can_fallthru (basic_block src, basic_block target)
580 {
581   rtx insn = BB_END (src);
582   rtx insn2;
583   edge e;
584   edge_iterator ei;
585
586   if (target == EXIT_BLOCK_PTR)
587     return true;
588   if (src->next_bb != target)
589     return 0;
590   FOR_EACH_EDGE (e, ei, src->succs)
591     if (e->dest == EXIT_BLOCK_PTR
592         && e->flags & EDGE_FALLTHRU)
593       return 0;
594
595   insn2 = BB_HEAD (target);
596   if (insn2 && !active_insn_p (insn2))
597     insn2 = next_active_insn (insn2);
598
599   /* ??? Later we may add code to move jump tables offline.  */
600   return next_active_insn (insn) == insn2;
601 }
602
603 /* Return nonzero if we could reach target from src by falling through,
604    if the target was made adjacent.  If we already have a fall-through
605    edge to the exit block, we can't do that.  */
606 static bool
607 could_fall_through (basic_block src, basic_block target)
608 {
609   edge e;
610   edge_iterator ei;
611
612   if (target == EXIT_BLOCK_PTR)
613     return true;
614   FOR_EACH_EDGE (e, ei, src->succs)
615     if (e->dest == EXIT_BLOCK_PTR
616         && e->flags & EDGE_FALLTHRU)
617       return 0;
618   return true;
619 }
620 \f
621 /* Return the NOTE_INSN_BASIC_BLOCK of BB.  */
622 rtx
623 bb_note (basic_block bb)
624 {
625   rtx note;
626
627   note = BB_HEAD (bb);
628   if (LABEL_P (note))
629     note = NEXT_INSN (note);
630
631   gcc_assert (NOTE_INSN_BASIC_BLOCK_P (note));
632   return note;
633 }
634
635 /* Return the INSN immediately following the NOTE_INSN_BASIC_BLOCK
636    note associated with the BLOCK.  */
637
638 static rtx
639 first_insn_after_basic_block_note (basic_block block)
640 {
641   rtx insn;
642
643   /* Get the first instruction in the block.  */
644   insn = BB_HEAD (block);
645
646   if (insn == NULL_RTX)
647     return NULL_RTX;
648   if (LABEL_P (insn))
649     insn = NEXT_INSN (insn);
650   gcc_assert (NOTE_INSN_BASIC_BLOCK_P (insn));
651
652   return NEXT_INSN (insn);
653 }
654
655 /* Creates a new basic block just after basic block B by splitting
656    everything after specified instruction I.  */
657
658 static basic_block
659 rtl_split_block (basic_block bb, void *insnp)
660 {
661   basic_block new_bb;
662   rtx insn = (rtx) insnp;
663   edge e;
664   edge_iterator ei;
665
666   if (!insn)
667     {
668       insn = first_insn_after_basic_block_note (bb);
669
670       if (insn)
671         {
672           rtx next = insn;
673
674           insn = PREV_INSN (insn);
675
676           /* If the block contains only debug insns, insn would have
677              been NULL in a non-debug compilation, and then we'd end
678              up emitting a DELETED note.  For -fcompare-debug
679              stability, emit the note too.  */
680           if (insn != BB_END (bb)
681               && DEBUG_INSN_P (next)
682               && DEBUG_INSN_P (BB_END (bb)))
683             {
684               while (next != BB_END (bb) && DEBUG_INSN_P (next))
685                 next = NEXT_INSN (next);
686
687               if (next == BB_END (bb))
688                 emit_note_after (NOTE_INSN_DELETED, next);
689             }
690         }
691       else
692         insn = get_last_insn ();
693     }
694
695   /* We probably should check type of the insn so that we do not create
696      inconsistent cfg.  It is checked in verify_flow_info anyway, so do not
697      bother.  */
698   if (insn == BB_END (bb))
699     emit_note_after (NOTE_INSN_DELETED, insn);
700
701   /* Create the new basic block.  */
702   new_bb = create_basic_block (NEXT_INSN (insn), BB_END (bb), bb);
703   BB_COPY_PARTITION (new_bb, bb);
704   BB_END (bb) = insn;
705
706   /* Redirect the outgoing edges.  */
707   new_bb->succs = bb->succs;
708   bb->succs = NULL;
709   FOR_EACH_EDGE (e, ei, new_bb->succs)
710     e->src = new_bb;
711
712   /* The new block starts off being dirty.  */
713   df_set_bb_dirty (bb);
714   return new_bb;
715 }
716
717 /* Return true if the single edge between blocks A and B is the only place
718    in RTL which holds some unique locus.  */
719
720 static bool
721 unique_locus_on_edge_between_p (basic_block a, basic_block b)
722 {
723   const int goto_locus = EDGE_SUCC (a, 0)->goto_locus;
724   rtx insn, end;
725
726   if (!goto_locus)
727     return false;
728
729   /* First scan block A backward.  */
730   insn = BB_END (a);
731   end = PREV_INSN (BB_HEAD (a));
732   while (insn != end && (!NONDEBUG_INSN_P (insn) || INSN_LOCATOR (insn) == 0))
733     insn = PREV_INSN (insn);
734
735   if (insn != end && locator_eq (INSN_LOCATOR (insn), goto_locus))
736     return false;
737
738   /* Then scan block B forward.  */
739   insn = BB_HEAD (b);
740   if (insn)
741     {
742       end = NEXT_INSN (BB_END (b));
743       while (insn != end && !NONDEBUG_INSN_P (insn))
744         insn = NEXT_INSN (insn);
745
746       if (insn != end && INSN_LOCATOR (insn) != 0
747           && locator_eq (INSN_LOCATOR (insn), goto_locus))
748         return false;
749     }
750
751   return true;
752 }
753
754 /* If the single edge between blocks A and B is the only place in RTL which
755    holds some unique locus, emit a nop with that locus between the blocks.  */
756
757 static void
758 emit_nop_for_unique_locus_between (basic_block a, basic_block b)
759 {
760   if (!unique_locus_on_edge_between_p (a, b))
761     return;
762
763   BB_END (a) = emit_insn_after_noloc (gen_nop (), BB_END (a), a);
764   INSN_LOCATOR (BB_END (a)) = EDGE_SUCC (a, 0)->goto_locus;
765 }
766
767 /* Blocks A and B are to be merged into a single block A.  The insns
768    are already contiguous.  */
769
770 static void
771 rtl_merge_blocks (basic_block a, basic_block b)
772 {
773   rtx b_head = BB_HEAD (b), b_end = BB_END (b), a_end = BB_END (a);
774   rtx del_first = NULL_RTX, del_last = NULL_RTX;
775   rtx b_debug_start = b_end, b_debug_end = b_end;
776   bool forwarder_p = (b->flags & BB_FORWARDER_BLOCK) != 0;
777   int b_empty = 0;
778
779   if (dump_file)
780     fprintf (dump_file, "Merging block %d into block %d...\n", b->index,
781              a->index);
782
783   while (DEBUG_INSN_P (b_end))
784     b_end = PREV_INSN (b_debug_start = b_end);
785
786   /* If there was a CODE_LABEL beginning B, delete it.  */
787   if (LABEL_P (b_head))
788     {
789       /* Detect basic blocks with nothing but a label.  This can happen
790          in particular at the end of a function.  */
791       if (b_head == b_end)
792         b_empty = 1;
793
794       del_first = del_last = b_head;
795       b_head = NEXT_INSN (b_head);
796     }
797
798   /* Delete the basic block note and handle blocks containing just that
799      note.  */
800   if (NOTE_INSN_BASIC_BLOCK_P (b_head))
801     {
802       if (b_head == b_end)
803         b_empty = 1;
804       if (! del_last)
805         del_first = b_head;
806
807       del_last = b_head;
808       b_head = NEXT_INSN (b_head);
809     }
810
811   /* If there was a jump out of A, delete it.  */
812   if (JUMP_P (a_end))
813     {
814       rtx prev;
815
816       for (prev = PREV_INSN (a_end); ; prev = PREV_INSN (prev))
817         if (!NOTE_P (prev)
818             || NOTE_INSN_BASIC_BLOCK_P (prev)
819             || prev == BB_HEAD (a))
820           break;
821
822       del_first = a_end;
823
824 #ifdef HAVE_cc0
825       /* If this was a conditional jump, we need to also delete
826          the insn that set cc0.  */
827       if (only_sets_cc0_p (prev))
828         {
829           rtx tmp = prev;
830
831           prev = prev_nonnote_insn (prev);
832           if (!prev)
833             prev = BB_HEAD (a);
834           del_first = tmp;
835         }
836 #endif
837
838       a_end = PREV_INSN (del_first);
839     }
840   else if (BARRIER_P (NEXT_INSN (a_end)))
841     del_first = NEXT_INSN (a_end);
842
843   /* Delete everything marked above as well as crap that might be
844      hanging out between the two blocks.  */
845   BB_END (a) = a_end;
846   BB_HEAD (b) = b_empty ? NULL_RTX : b_head;
847   delete_insn_chain (del_first, del_last, true);
848
849   /* When not optimizing CFG and the edge is the only place in RTL which holds
850      some unique locus, emit a nop with that locus in between.  */
851   if (!optimize)
852     {
853       emit_nop_for_unique_locus_between (a, b);
854       a_end = BB_END (a);
855     }
856
857   /* Reassociate the insns of B with A.  */
858   if (!b_empty)
859     {
860       update_bb_for_insn_chain (a_end, b_debug_end, a);
861
862       BB_END (a) = b_debug_end;
863       BB_HEAD (b) = NULL_RTX;
864     }
865   else if (b_end != b_debug_end)
866     {
867       /* Move any deleted labels and other notes between the end of A
868          and the debug insns that make up B after the debug insns,
869          bringing the debug insns into A while keeping the notes after
870          the end of A.  */
871       if (NEXT_INSN (a_end) != b_debug_start)
872         reorder_insns_nobb (NEXT_INSN (a_end), PREV_INSN (b_debug_start),
873                             b_debug_end);
874       update_bb_for_insn_chain (b_debug_start, b_debug_end, a);
875       BB_END (a) = b_debug_end;
876     }
877
878   df_bb_delete (b->index);
879
880   /* If B was a forwarder block, propagate the locus on the edge.  */
881   if (forwarder_p && !EDGE_SUCC (b, 0)->goto_locus)
882     EDGE_SUCC (b, 0)->goto_locus = EDGE_SUCC (a, 0)->goto_locus;
883
884   if (dump_file)
885     fprintf (dump_file, "Merged blocks %d and %d.\n", a->index, b->index);
886 }
887
888
889 /* Return true when block A and B can be merged.  */
890
891 static bool
892 rtl_can_merge_blocks (basic_block a, basic_block b)
893 {
894   /* If we are partitioning hot/cold basic blocks, we don't want to
895      mess up unconditional or indirect jumps that cross between hot
896      and cold sections.
897
898      Basic block partitioning may result in some jumps that appear to
899      be optimizable (or blocks that appear to be mergeable), but which really
900      must be left untouched (they are required to make it safely across
901      partition boundaries).  See  the comments at the top of
902      bb-reorder.c:partition_hot_cold_basic_blocks for complete details.  */
903
904   if (BB_PARTITION (a) != BB_PARTITION (b))
905     return false;
906
907   /* Protect the loop latches.  */
908   if (current_loops && b->loop_father->latch == b)
909     return false;
910
911   /* There must be exactly one edge in between the blocks.  */
912   return (single_succ_p (a)
913           && single_succ (a) == b
914           && single_pred_p (b)
915           && a != b
916           /* Must be simple edge.  */
917           && !(single_succ_edge (a)->flags & EDGE_COMPLEX)
918           && a->next_bb == b
919           && a != ENTRY_BLOCK_PTR && b != EXIT_BLOCK_PTR
920           /* If the jump insn has side effects,
921              we can't kill the edge.  */
922           && (!JUMP_P (BB_END (a))
923               || (reload_completed
924                   ? simplejump_p (BB_END (a)) : onlyjump_p (BB_END (a)))));
925 }
926 \f
927 /* Return the label in the head of basic block BLOCK.  Create one if it doesn't
928    exist.  */
929
930 rtx
931 block_label (basic_block block)
932 {
933   if (block == EXIT_BLOCK_PTR)
934     return NULL_RTX;
935
936   if (!LABEL_P (BB_HEAD (block)))
937     {
938       BB_HEAD (block) = emit_label_before (gen_label_rtx (), BB_HEAD (block));
939     }
940
941   return BB_HEAD (block);
942 }
943
944 /* Attempt to perform edge redirection by replacing possibly complex jump
945    instruction by unconditional jump or removing jump completely.  This can
946    apply only if all edges now point to the same block.  The parameters and
947    return values are equivalent to redirect_edge_and_branch.  */
948
949 edge
950 try_redirect_by_replacing_jump (edge e, basic_block target, bool in_cfglayout)
951 {
952   basic_block src = e->src;
953   rtx insn = BB_END (src), kill_from;
954   rtx set;
955   int fallthru = 0;
956
957   /* If we are partitioning hot/cold basic blocks, we don't want to
958      mess up unconditional or indirect jumps that cross between hot
959      and cold sections.
960
961      Basic block partitioning may result in some jumps that appear to
962      be optimizable (or blocks that appear to be mergeable), but which really
963      must be left untouched (they are required to make it safely across
964      partition boundaries).  See  the comments at the top of
965      bb-reorder.c:partition_hot_cold_basic_blocks for complete details.  */
966
967   if (find_reg_note (insn, REG_CROSSING_JUMP, NULL_RTX)
968       || BB_PARTITION (src) != BB_PARTITION (target))
969     return NULL;
970
971   /* We can replace or remove a complex jump only when we have exactly
972      two edges.  Also, if we have exactly one outgoing edge, we can
973      redirect that.  */
974   if (EDGE_COUNT (src->succs) >= 3
975       /* Verify that all targets will be TARGET.  Specifically, the
976          edge that is not E must also go to TARGET.  */
977       || (EDGE_COUNT (src->succs) == 2
978           && EDGE_SUCC (src, EDGE_SUCC (src, 0) == e)->dest != target))
979     return NULL;
980
981   if (!onlyjump_p (insn))
982     return NULL;
983   if ((!optimize || reload_completed) && tablejump_p (insn, NULL, NULL))
984     return NULL;
985
986   /* Avoid removing branch with side effects.  */
987   set = single_set (insn);
988   if (!set || side_effects_p (set))
989     return NULL;
990
991   /* In case we zap a conditional jump, we'll need to kill
992      the cc0 setter too.  */
993   kill_from = insn;
994 #ifdef HAVE_cc0
995   if (reg_mentioned_p (cc0_rtx, PATTERN (insn))
996       && only_sets_cc0_p (PREV_INSN (insn)))
997     kill_from = PREV_INSN (insn);
998 #endif
999
1000   /* See if we can create the fallthru edge.  */
1001   if (in_cfglayout || can_fallthru (src, target))
1002     {
1003       if (dump_file)
1004         fprintf (dump_file, "Removing jump %i.\n", INSN_UID (insn));
1005       fallthru = 1;
1006
1007       /* Selectively unlink whole insn chain.  */
1008       if (in_cfglayout)
1009         {
1010           rtx insn = BB_FOOTER (src);
1011
1012           delete_insn_chain (kill_from, BB_END (src), false);
1013
1014           /* Remove barriers but keep jumptables.  */
1015           while (insn)
1016             {
1017               if (BARRIER_P (insn))
1018                 {
1019                   if (PREV_INSN (insn))
1020                     NEXT_INSN (PREV_INSN (insn)) = NEXT_INSN (insn);
1021                   else
1022                     BB_FOOTER (src) = NEXT_INSN (insn);
1023                   if (NEXT_INSN (insn))
1024                     PREV_INSN (NEXT_INSN (insn)) = PREV_INSN (insn);
1025                 }
1026               if (LABEL_P (insn))
1027                 break;
1028               insn = NEXT_INSN (insn);
1029             }
1030         }
1031       else
1032         delete_insn_chain (kill_from, PREV_INSN (BB_HEAD (target)),
1033                            false);
1034     }
1035
1036   /* If this already is simplejump, redirect it.  */
1037   else if (simplejump_p (insn))
1038     {
1039       if (e->dest == target)
1040         return NULL;
1041       if (dump_file)
1042         fprintf (dump_file, "Redirecting jump %i from %i to %i.\n",
1043                  INSN_UID (insn), e->dest->index, target->index);
1044       if (!redirect_jump (insn, block_label (target), 0))
1045         {
1046           gcc_assert (target == EXIT_BLOCK_PTR);
1047           return NULL;
1048         }
1049     }
1050
1051   /* Cannot do anything for target exit block.  */
1052   else if (target == EXIT_BLOCK_PTR)
1053     return NULL;
1054
1055   /* Or replace possibly complicated jump insn by simple jump insn.  */
1056   else
1057     {
1058       rtx target_label = block_label (target);
1059       rtx barrier, label, table;
1060
1061       emit_jump_insn_after_noloc (gen_jump (target_label), insn);
1062       JUMP_LABEL (BB_END (src)) = target_label;
1063       LABEL_NUSES (target_label)++;
1064       if (dump_file)
1065         fprintf (dump_file, "Replacing insn %i by jump %i\n",
1066                  INSN_UID (insn), INSN_UID (BB_END (src)));
1067
1068
1069       delete_insn_chain (kill_from, insn, false);
1070
1071       /* Recognize a tablejump that we are converting to a
1072          simple jump and remove its associated CODE_LABEL
1073          and ADDR_VEC or ADDR_DIFF_VEC.  */
1074       if (tablejump_p (insn, &label, &table))
1075         delete_insn_chain (label, table, false);
1076
1077       barrier = next_nonnote_insn (BB_END (src));
1078       if (!barrier || !BARRIER_P (barrier))
1079         emit_barrier_after (BB_END (src));
1080       else
1081         {
1082           if (barrier != NEXT_INSN (BB_END (src)))
1083             {
1084               /* Move the jump before barrier so that the notes
1085                  which originally were or were created before jump table are
1086                  inside the basic block.  */
1087               rtx new_insn = BB_END (src);
1088
1089               update_bb_for_insn_chain (NEXT_INSN (BB_END (src)),
1090                                         PREV_INSN (barrier), src);
1091
1092               NEXT_INSN (PREV_INSN (new_insn)) = NEXT_INSN (new_insn);
1093               PREV_INSN (NEXT_INSN (new_insn)) = PREV_INSN (new_insn);
1094
1095               NEXT_INSN (new_insn) = barrier;
1096               NEXT_INSN (PREV_INSN (barrier)) = new_insn;
1097
1098               PREV_INSN (new_insn) = PREV_INSN (barrier);
1099               PREV_INSN (barrier) = new_insn;
1100             }
1101         }
1102     }
1103
1104   /* Keep only one edge out and set proper flags.  */
1105   if (!single_succ_p (src))
1106     remove_edge (e);
1107   gcc_assert (single_succ_p (src));
1108
1109   e = single_succ_edge (src);
1110   if (fallthru)
1111     e->flags = EDGE_FALLTHRU;
1112   else
1113     e->flags = 0;
1114
1115   e->probability = REG_BR_PROB_BASE;
1116   e->count = src->count;
1117
1118   if (e->dest != target)
1119     redirect_edge_succ (e, target);
1120   return e;
1121 }
1122
1123 /* Subroutine of redirect_branch_edge that tries to patch the jump
1124    instruction INSN so that it reaches block NEW.  Do this
1125    only when it originally reached block OLD.  Return true if this
1126    worked or the original target wasn't OLD, return false if redirection
1127    doesn't work.  */
1128
1129 static bool
1130 patch_jump_insn (rtx insn, rtx old_label, basic_block new_bb)
1131 {
1132   rtx tmp;
1133   /* Recognize a tablejump and adjust all matching cases.  */
1134   if (tablejump_p (insn, NULL, &tmp))
1135     {
1136       rtvec vec;
1137       int j;
1138       rtx new_label = block_label (new_bb);
1139
1140       if (new_bb == EXIT_BLOCK_PTR)
1141         return false;
1142       if (GET_CODE (PATTERN (tmp)) == ADDR_VEC)
1143         vec = XVEC (PATTERN (tmp), 0);
1144       else
1145         vec = XVEC (PATTERN (tmp), 1);
1146
1147       for (j = GET_NUM_ELEM (vec) - 1; j >= 0; --j)
1148         if (XEXP (RTVEC_ELT (vec, j), 0) == old_label)
1149           {
1150             RTVEC_ELT (vec, j) = gen_rtx_LABEL_REF (Pmode, new_label);
1151             --LABEL_NUSES (old_label);
1152             ++LABEL_NUSES (new_label);
1153           }
1154
1155       /* Handle casesi dispatch insns.  */
1156       if ((tmp = single_set (insn)) != NULL
1157           && SET_DEST (tmp) == pc_rtx
1158           && GET_CODE (SET_SRC (tmp)) == IF_THEN_ELSE
1159           && GET_CODE (XEXP (SET_SRC (tmp), 2)) == LABEL_REF
1160           && XEXP (XEXP (SET_SRC (tmp), 2), 0) == old_label)
1161         {
1162           XEXP (SET_SRC (tmp), 2) = gen_rtx_LABEL_REF (Pmode,
1163                                                        new_label);
1164           --LABEL_NUSES (old_label);
1165           ++LABEL_NUSES (new_label);
1166         }
1167     }
1168   else if ((tmp = extract_asm_operands (PATTERN (insn))) != NULL)
1169     {
1170       int i, n = ASM_OPERANDS_LABEL_LENGTH (tmp);
1171       rtx new_label, note;
1172
1173       if (new_bb == EXIT_BLOCK_PTR)
1174         return false;
1175       new_label = block_label (new_bb);
1176
1177       for (i = 0; i < n; ++i)
1178         {
1179           rtx old_ref = ASM_OPERANDS_LABEL (tmp, i);
1180           gcc_assert (GET_CODE (old_ref) == LABEL_REF);
1181           if (XEXP (old_ref, 0) == old_label)
1182             {
1183               ASM_OPERANDS_LABEL (tmp, i)
1184                 = gen_rtx_LABEL_REF (Pmode, new_label);
1185               --LABEL_NUSES (old_label);
1186               ++LABEL_NUSES (new_label);
1187             }
1188         }
1189
1190       if (JUMP_LABEL (insn) == old_label)
1191         {
1192           JUMP_LABEL (insn) = new_label;
1193           note = find_reg_note (insn, REG_LABEL_TARGET, new_label);
1194           if (note)
1195             remove_note (insn, note);
1196         }
1197       else
1198         {
1199           note = find_reg_note (insn, REG_LABEL_TARGET, old_label);
1200           if (note)
1201             remove_note (insn, note);
1202           if (JUMP_LABEL (insn) != new_label
1203               && !find_reg_note (insn, REG_LABEL_TARGET, new_label))
1204             add_reg_note (insn, REG_LABEL_TARGET, new_label);
1205         }
1206       while ((note = find_reg_note (insn, REG_LABEL_OPERAND, old_label))
1207              != NULL_RTX)
1208         XEXP (note, 0) = new_label;
1209     }
1210   else
1211     {
1212       /* ?? We may play the games with moving the named labels from
1213          one basic block to the other in case only one computed_jump is
1214          available.  */
1215       if (computed_jump_p (insn)
1216           /* A return instruction can't be redirected.  */
1217           || returnjump_p (insn))
1218         return false;
1219
1220       if (!currently_expanding_to_rtl || JUMP_LABEL (insn) == old_label)
1221         {
1222           /* If the insn doesn't go where we think, we're confused.  */
1223           gcc_assert (JUMP_LABEL (insn) == old_label);
1224
1225           /* If the substitution doesn't succeed, die.  This can happen
1226              if the back end emitted unrecognizable instructions or if
1227              target is exit block on some arches.  */
1228           if (!redirect_jump (insn, block_label (new_bb), 0))
1229             {
1230               gcc_assert (new_bb == EXIT_BLOCK_PTR);
1231               return false;
1232             }
1233         }
1234     }
1235   return true;
1236 }
1237
1238
1239 /* Redirect edge representing branch of (un)conditional jump or tablejump,
1240    NULL on failure  */
1241 static edge
1242 redirect_branch_edge (edge e, basic_block target)
1243 {
1244   rtx old_label = BB_HEAD (e->dest);
1245   basic_block src = e->src;
1246   rtx insn = BB_END (src);
1247
1248   /* We can only redirect non-fallthru edges of jump insn.  */
1249   if (e->flags & EDGE_FALLTHRU)
1250     return NULL;
1251   else if (!JUMP_P (insn) && !currently_expanding_to_rtl)
1252     return NULL;
1253
1254   if (!currently_expanding_to_rtl)
1255     {
1256       if (!patch_jump_insn (insn, old_label, target))
1257         return NULL;
1258     }
1259   else
1260     /* When expanding this BB might actually contain multiple
1261        jumps (i.e. not yet split by find_many_sub_basic_blocks).
1262        Redirect all of those that match our label.  */
1263     FOR_BB_INSNS (src, insn)
1264       if (JUMP_P (insn) && !patch_jump_insn (insn, old_label, target))
1265         return NULL;
1266
1267   if (dump_file)
1268     fprintf (dump_file, "Edge %i->%i redirected to %i\n",
1269              e->src->index, e->dest->index, target->index);
1270
1271   if (e->dest != target)
1272     e = redirect_edge_succ_nodup (e, target);
1273
1274   return e;
1275 }
1276
1277 /* Attempt to change code to redirect edge E to TARGET.  Don't do that on
1278    expense of adding new instructions or reordering basic blocks.
1279
1280    Function can be also called with edge destination equivalent to the TARGET.
1281    Then it should try the simplifications and do nothing if none is possible.
1282
1283    Return edge representing the branch if transformation succeeded.  Return NULL
1284    on failure.
1285    We still return NULL in case E already destinated TARGET and we didn't
1286    managed to simplify instruction stream.  */
1287
1288 static edge
1289 rtl_redirect_edge_and_branch (edge e, basic_block target)
1290 {
1291   edge ret;
1292   basic_block src = e->src;
1293
1294   if (e->flags & (EDGE_ABNORMAL_CALL | EDGE_EH))
1295     return NULL;
1296
1297   if (e->dest == target)
1298     return e;
1299
1300   if ((ret = try_redirect_by_replacing_jump (e, target, false)) != NULL)
1301     {
1302       df_set_bb_dirty (src);
1303       return ret;
1304     }
1305
1306   ret = redirect_branch_edge (e, target);
1307   if (!ret)
1308     return NULL;
1309
1310   df_set_bb_dirty (src);
1311   return ret;
1312 }
1313
1314 /* Like force_nonfallthru below, but additionally performs redirection
1315    Used by redirect_edge_and_branch_force.  JUMP_LABEL is used only
1316    when redirecting to the EXIT_BLOCK, it is either ret_rtx or
1317    simple_return_rtx, indicating which kind of returnjump to create.
1318    It should be NULL otherwise.  */
1319
1320 basic_block
1321 force_nonfallthru_and_redirect (edge e, basic_block target, rtx jump_label)
1322 {
1323   basic_block jump_block, new_bb = NULL, src = e->src;
1324   rtx note;
1325   edge new_edge;
1326   int abnormal_edge_flags = 0;
1327   bool asm_goto_edge = false;
1328   int loc;
1329
1330   /* In the case the last instruction is conditional jump to the next
1331      instruction, first redirect the jump itself and then continue
1332      by creating a basic block afterwards to redirect fallthru edge.  */
1333   if (e->src != ENTRY_BLOCK_PTR && e->dest != EXIT_BLOCK_PTR
1334       && any_condjump_p (BB_END (e->src))
1335       && JUMP_LABEL (BB_END (e->src)) == BB_HEAD (e->dest))
1336     {
1337       rtx note;
1338       edge b = unchecked_make_edge (e->src, target, 0);
1339       bool redirected;
1340
1341       redirected = redirect_jump (BB_END (e->src), block_label (target), 0);
1342       gcc_assert (redirected);
1343
1344       note = find_reg_note (BB_END (e->src), REG_BR_PROB, NULL_RTX);
1345       if (note)
1346         {
1347           int prob = INTVAL (XEXP (note, 0));
1348
1349           b->probability = prob;
1350           b->count = e->count * prob / REG_BR_PROB_BASE;
1351           e->probability -= e->probability;
1352           e->count -= b->count;
1353           if (e->probability < 0)
1354             e->probability = 0;
1355           if (e->count < 0)
1356             e->count = 0;
1357         }
1358     }
1359
1360   if (e->flags & EDGE_ABNORMAL)
1361     {
1362       /* Irritating special case - fallthru edge to the same block as abnormal
1363          edge.
1364          We can't redirect abnormal edge, but we still can split the fallthru
1365          one and create separate abnormal edge to original destination.
1366          This allows bb-reorder to make such edge non-fallthru.  */
1367       gcc_assert (e->dest == target);
1368       abnormal_edge_flags = e->flags & ~EDGE_FALLTHRU;
1369       e->flags &= EDGE_FALLTHRU;
1370     }
1371   else
1372     {
1373       gcc_assert (e->flags & EDGE_FALLTHRU);
1374       if (e->src == ENTRY_BLOCK_PTR)
1375         {
1376           /* We can't redirect the entry block.  Create an empty block
1377              at the start of the function which we use to add the new
1378              jump.  */
1379           edge tmp;
1380           edge_iterator ei;
1381           bool found = false;
1382
1383           basic_block bb = create_basic_block (BB_HEAD (e->dest), NULL, ENTRY_BLOCK_PTR);
1384
1385           /* Change the existing edge's source to be the new block, and add
1386              a new edge from the entry block to the new block.  */
1387           e->src = bb;
1388           for (ei = ei_start (ENTRY_BLOCK_PTR->succs); (tmp = ei_safe_edge (ei)); )
1389             {
1390               if (tmp == e)
1391                 {
1392                   VEC_unordered_remove (edge, ENTRY_BLOCK_PTR->succs, ei.index);
1393                   found = true;
1394                   break;
1395                 }
1396               else
1397                 ei_next (&ei);
1398             }
1399
1400           gcc_assert (found);
1401
1402           VEC_safe_push (edge, gc, bb->succs, e);
1403           make_single_succ_edge (ENTRY_BLOCK_PTR, bb, EDGE_FALLTHRU);
1404         }
1405     }
1406
1407   /* If e->src ends with asm goto, see if any of the ASM_OPERANDS_LABELs
1408      don't point to the target or fallthru label.  */
1409   if (JUMP_P (BB_END (e->src))
1410       && target != EXIT_BLOCK_PTR
1411       && (e->flags & EDGE_FALLTHRU)
1412       && (note = extract_asm_operands (PATTERN (BB_END (e->src)))))
1413     {
1414       int i, n = ASM_OPERANDS_LABEL_LENGTH (note);
1415
1416       for (i = 0; i < n; ++i)
1417         {
1418           if (XEXP (ASM_OPERANDS_LABEL (note, i), 0) == BB_HEAD (e->dest))
1419             XEXP (ASM_OPERANDS_LABEL (note, i), 0) = block_label (target);
1420           if (XEXP (ASM_OPERANDS_LABEL (note, i), 0) == BB_HEAD (target))
1421             asm_goto_edge = true;
1422         }
1423     }
1424
1425   if (EDGE_COUNT (e->src->succs) >= 2 || abnormal_edge_flags || asm_goto_edge)
1426     {
1427       gcov_type count = e->count;
1428       int probability = e->probability;
1429       /* Create the new structures.  */
1430
1431       /* If the old block ended with a tablejump, skip its table
1432          by searching forward from there.  Otherwise start searching
1433          forward from the last instruction of the old block.  */
1434       if (!tablejump_p (BB_END (e->src), NULL, &note))
1435         note = BB_END (e->src);
1436       note = NEXT_INSN (note);
1437
1438       jump_block = create_basic_block (note, NULL, e->src);
1439       jump_block->count = count;
1440       jump_block->frequency = EDGE_FREQUENCY (e);
1441       jump_block->loop_depth = target->loop_depth;
1442
1443       /* Make sure new block ends up in correct hot/cold section.  */
1444
1445       BB_COPY_PARTITION (jump_block, e->src);
1446       if (flag_reorder_blocks_and_partition
1447           && targetm_common.have_named_sections
1448           && JUMP_P (BB_END (jump_block))
1449           && !any_condjump_p (BB_END (jump_block))
1450           && (EDGE_SUCC (jump_block, 0)->flags & EDGE_CROSSING))
1451         add_reg_note (BB_END (jump_block), REG_CROSSING_JUMP, NULL_RTX);
1452
1453       /* Wire edge in.  */
1454       new_edge = make_edge (e->src, jump_block, EDGE_FALLTHRU);
1455       new_edge->probability = probability;
1456       new_edge->count = count;
1457
1458       /* Redirect old edge.  */
1459       redirect_edge_pred (e, jump_block);
1460       e->probability = REG_BR_PROB_BASE;
1461
1462       /* If asm goto has any label refs to target's label,
1463          add also edge from asm goto bb to target.  */
1464       if (asm_goto_edge)
1465         {
1466           new_edge->probability /= 2;
1467           new_edge->count /= 2;
1468           jump_block->count /= 2;
1469           jump_block->frequency /= 2;
1470           new_edge = make_edge (new_edge->src, target,
1471                                 e->flags & ~EDGE_FALLTHRU);
1472           new_edge->probability = probability - probability / 2;
1473           new_edge->count = count - count / 2;
1474         }
1475
1476       new_bb = jump_block;
1477     }
1478   else
1479     jump_block = e->src;
1480
1481   if (e->goto_locus && e->goto_block == NULL)
1482     loc = e->goto_locus;
1483   else
1484     loc = 0;
1485   e->flags &= ~EDGE_FALLTHRU;
1486   if (target == EXIT_BLOCK_PTR)
1487     {
1488       if (jump_label == ret_rtx)
1489         {
1490 #ifdef HAVE_return
1491           emit_jump_insn_after_setloc (gen_return (), BB_END (jump_block), loc);
1492 #else
1493           gcc_unreachable ();
1494 #endif
1495         }
1496       else
1497         {
1498           gcc_assert (jump_label == simple_return_rtx);
1499 #ifdef HAVE_simple_return
1500           emit_jump_insn_after_setloc (gen_simple_return (),
1501                                        BB_END (jump_block), loc);
1502 #else
1503           gcc_unreachable ();
1504 #endif
1505         }
1506       set_return_jump_label (BB_END (jump_block));
1507     }
1508   else
1509     {
1510       rtx label = block_label (target);
1511       emit_jump_insn_after_setloc (gen_jump (label), BB_END (jump_block), loc);
1512       JUMP_LABEL (BB_END (jump_block)) = label;
1513       LABEL_NUSES (label)++;
1514     }
1515
1516   emit_barrier_after (BB_END (jump_block));
1517   redirect_edge_succ_nodup (e, target);
1518
1519   if (abnormal_edge_flags)
1520     make_edge (src, target, abnormal_edge_flags);
1521
1522   df_mark_solutions_dirty ();
1523   return new_bb;
1524 }
1525
1526 /* Edge E is assumed to be fallthru edge.  Emit needed jump instruction
1527    (and possibly create new basic block) to make edge non-fallthru.
1528    Return newly created BB or NULL if none.  */
1529
1530 static basic_block
1531 rtl_force_nonfallthru (edge e)
1532 {
1533   return force_nonfallthru_and_redirect (e, e->dest, NULL_RTX);
1534 }
1535
1536 /* Redirect edge even at the expense of creating new jump insn or
1537    basic block.  Return new basic block if created, NULL otherwise.
1538    Conversion must be possible.  */
1539
1540 static basic_block
1541 rtl_redirect_edge_and_branch_force (edge e, basic_block target)
1542 {
1543   if (redirect_edge_and_branch (e, target)
1544       || e->dest == target)
1545     return NULL;
1546
1547   /* In case the edge redirection failed, try to force it to be non-fallthru
1548      and redirect newly created simplejump.  */
1549   df_set_bb_dirty (e->src);
1550   return force_nonfallthru_and_redirect (e, target, NULL_RTX);
1551 }
1552
1553 /* The given edge should potentially be a fallthru edge.  If that is in
1554    fact true, delete the jump and barriers that are in the way.  */
1555
1556 static void
1557 rtl_tidy_fallthru_edge (edge e)
1558 {
1559   rtx q;
1560   basic_block b = e->src, c = b->next_bb;
1561
1562   /* ??? In a late-running flow pass, other folks may have deleted basic
1563      blocks by nopping out blocks, leaving multiple BARRIERs between here
1564      and the target label. They ought to be chastised and fixed.
1565
1566      We can also wind up with a sequence of undeletable labels between
1567      one block and the next.
1568
1569      So search through a sequence of barriers, labels, and notes for
1570      the head of block C and assert that we really do fall through.  */
1571
1572   for (q = NEXT_INSN (BB_END (b)); q != BB_HEAD (c); q = NEXT_INSN (q))
1573     if (INSN_P (q))
1574       return;
1575
1576   /* Remove what will soon cease being the jump insn from the source block.
1577      If block B consisted only of this single jump, turn it into a deleted
1578      note.  */
1579   q = BB_END (b);
1580   if (JUMP_P (q)
1581       && onlyjump_p (q)
1582       && (any_uncondjump_p (q)
1583           || single_succ_p (b)))
1584     {
1585 #ifdef HAVE_cc0
1586       /* If this was a conditional jump, we need to also delete
1587          the insn that set cc0.  */
1588       if (any_condjump_p (q) && only_sets_cc0_p (PREV_INSN (q)))
1589         q = PREV_INSN (q);
1590 #endif
1591
1592       q = PREV_INSN (q);
1593     }
1594
1595   /* Selectively unlink the sequence.  */
1596   if (q != PREV_INSN (BB_HEAD (c)))
1597     delete_insn_chain (NEXT_INSN (q), PREV_INSN (BB_HEAD (c)), false);
1598
1599   e->flags |= EDGE_FALLTHRU;
1600 }
1601 \f
1602 /* Should move basic block BB after basic block AFTER.  NIY.  */
1603
1604 static bool
1605 rtl_move_block_after (basic_block bb ATTRIBUTE_UNUSED,
1606                       basic_block after ATTRIBUTE_UNUSED)
1607 {
1608   return false;
1609 }
1610
1611 /* Split a (typically critical) edge.  Return the new block.
1612    The edge must not be abnormal.
1613
1614    ??? The code generally expects to be called on critical edges.
1615    The case of a block ending in an unconditional jump to a
1616    block with multiple predecessors is not handled optimally.  */
1617
1618 static basic_block
1619 rtl_split_edge (edge edge_in)
1620 {
1621   basic_block bb;
1622   rtx before;
1623
1624   /* Abnormal edges cannot be split.  */
1625   gcc_assert (!(edge_in->flags & EDGE_ABNORMAL));
1626
1627   /* We are going to place the new block in front of edge destination.
1628      Avoid existence of fallthru predecessors.  */
1629   if ((edge_in->flags & EDGE_FALLTHRU) == 0)
1630     {
1631       edge e = find_fallthru_edge (edge_in->dest->preds);
1632
1633       if (e)
1634         force_nonfallthru (e);
1635     }
1636
1637   /* Create the basic block note.  */
1638   if (edge_in->dest != EXIT_BLOCK_PTR)
1639     before = BB_HEAD (edge_in->dest);
1640   else
1641     before = NULL_RTX;
1642
1643   /* If this is a fall through edge to the exit block, the blocks might be
1644      not adjacent, and the right place is after the source.  */
1645   if ((edge_in->flags & EDGE_FALLTHRU) && edge_in->dest == EXIT_BLOCK_PTR)
1646     {
1647       before = NEXT_INSN (BB_END (edge_in->src));
1648       bb = create_basic_block (before, NULL, edge_in->src);
1649       BB_COPY_PARTITION (bb, edge_in->src);
1650     }
1651   else
1652     {
1653       bb = create_basic_block (before, NULL, edge_in->dest->prev_bb);
1654       /* ??? Why not edge_in->dest->prev_bb here?  */
1655       BB_COPY_PARTITION (bb, edge_in->dest);
1656     }
1657
1658   make_single_succ_edge (bb, edge_in->dest, EDGE_FALLTHRU);
1659
1660   /* For non-fallthru edges, we must adjust the predecessor's
1661      jump instruction to target our new block.  */
1662   if ((edge_in->flags & EDGE_FALLTHRU) == 0)
1663     {
1664       edge redirected = redirect_edge_and_branch (edge_in, bb);
1665       gcc_assert (redirected);
1666     }
1667   else
1668     {
1669       if (edge_in->src != ENTRY_BLOCK_PTR)
1670         {
1671           /* For asm goto even splitting of fallthru edge might
1672              need insn patching, as other labels might point to the
1673              old label.  */
1674           rtx last = BB_END (edge_in->src);
1675           if (last
1676               && JUMP_P (last)
1677               && edge_in->dest != EXIT_BLOCK_PTR
1678               && extract_asm_operands (PATTERN (last)) != NULL_RTX
1679               && patch_jump_insn (last, before, bb))
1680             df_set_bb_dirty (edge_in->src);
1681         }
1682       redirect_edge_succ (edge_in, bb);
1683     }
1684
1685   return bb;
1686 }
1687
1688 /* Queue instructions for insertion on an edge between two basic blocks.
1689    The new instructions and basic blocks (if any) will not appear in the
1690    CFG until commit_edge_insertions is called.  */
1691
1692 void
1693 insert_insn_on_edge (rtx pattern, edge e)
1694 {
1695   /* We cannot insert instructions on an abnormal critical edge.
1696      It will be easier to find the culprit if we die now.  */
1697   gcc_assert (!((e->flags & EDGE_ABNORMAL) && EDGE_CRITICAL_P (e)));
1698
1699   if (e->insns.r == NULL_RTX)
1700     start_sequence ();
1701   else
1702     push_to_sequence (e->insns.r);
1703
1704   emit_insn (pattern);
1705
1706   e->insns.r = get_insns ();
1707   end_sequence ();
1708 }
1709
1710 /* Update the CFG for the instructions queued on edge E.  */
1711
1712 void
1713 commit_one_edge_insertion (edge e)
1714 {
1715   rtx before = NULL_RTX, after = NULL_RTX, insns, tmp, last;
1716   basic_block bb;
1717
1718   /* Pull the insns off the edge now since the edge might go away.  */
1719   insns = e->insns.r;
1720   e->insns.r = NULL_RTX;
1721
1722   /* Figure out where to put these insns.  If the destination has
1723      one predecessor, insert there.  Except for the exit block.  */
1724   if (single_pred_p (e->dest) && e->dest != EXIT_BLOCK_PTR)
1725     {
1726       bb = e->dest;
1727
1728       /* Get the location correct wrt a code label, and "nice" wrt
1729          a basic block note, and before everything else.  */
1730       tmp = BB_HEAD (bb);
1731       if (LABEL_P (tmp))
1732         tmp = NEXT_INSN (tmp);
1733       if (NOTE_INSN_BASIC_BLOCK_P (tmp))
1734         tmp = NEXT_INSN (tmp);
1735       if (tmp == BB_HEAD (bb))
1736         before = tmp;
1737       else if (tmp)
1738         after = PREV_INSN (tmp);
1739       else
1740         after = get_last_insn ();
1741     }
1742
1743   /* If the source has one successor and the edge is not abnormal,
1744      insert there.  Except for the entry block.  */
1745   else if ((e->flags & EDGE_ABNORMAL) == 0
1746            && single_succ_p (e->src)
1747            && e->src != ENTRY_BLOCK_PTR)
1748     {
1749       bb = e->src;
1750
1751       /* It is possible to have a non-simple jump here.  Consider a target
1752          where some forms of unconditional jumps clobber a register.  This
1753          happens on the fr30 for example.
1754
1755          We know this block has a single successor, so we can just emit
1756          the queued insns before the jump.  */
1757       if (JUMP_P (BB_END (bb)))
1758         before = BB_END (bb);
1759       else
1760         {
1761           /* We'd better be fallthru, or we've lost track of what's what.  */
1762           gcc_assert (e->flags & EDGE_FALLTHRU);
1763
1764           after = BB_END (bb);
1765         }
1766     }
1767
1768   /* Otherwise we must split the edge.  */
1769   else
1770     {
1771       bb = split_edge (e);
1772       after = BB_END (bb);
1773
1774       if (flag_reorder_blocks_and_partition
1775           && targetm_common.have_named_sections
1776           && e->src != ENTRY_BLOCK_PTR
1777           && BB_PARTITION (e->src) == BB_COLD_PARTITION
1778           && !(e->flags & EDGE_CROSSING)
1779           && JUMP_P (after)
1780           && !any_condjump_p (after)
1781           && (single_succ_edge (bb)->flags & EDGE_CROSSING))
1782         add_reg_note (after, REG_CROSSING_JUMP, NULL_RTX);
1783     }
1784
1785   /* Now that we've found the spot, do the insertion.  */
1786   if (before)
1787     {
1788       emit_insn_before_noloc (insns, before, bb);
1789       last = prev_nonnote_insn (before);
1790     }
1791   else
1792     last = emit_insn_after_noloc (insns, after, bb);
1793
1794   if (returnjump_p (last))
1795     {
1796       /* ??? Remove all outgoing edges from BB and add one for EXIT.
1797          This is not currently a problem because this only happens
1798          for the (single) epilogue, which already has a fallthru edge
1799          to EXIT.  */
1800
1801       e = single_succ_edge (bb);
1802       gcc_assert (e->dest == EXIT_BLOCK_PTR
1803                   && single_succ_p (bb) && (e->flags & EDGE_FALLTHRU));
1804
1805       e->flags &= ~EDGE_FALLTHRU;
1806       emit_barrier_after (last);
1807
1808       if (before)
1809         delete_insn (before);
1810     }
1811   else
1812     gcc_assert (!JUMP_P (last));
1813 }
1814
1815 /* Update the CFG for all queued instructions.  */
1816
1817 void
1818 commit_edge_insertions (void)
1819 {
1820   basic_block bb;
1821
1822 #ifdef ENABLE_CHECKING
1823   verify_flow_info ();
1824 #endif
1825
1826   FOR_BB_BETWEEN (bb, ENTRY_BLOCK_PTR, EXIT_BLOCK_PTR, next_bb)
1827     {
1828       edge e;
1829       edge_iterator ei;
1830
1831       FOR_EACH_EDGE (e, ei, bb->succs)
1832         if (e->insns.r)
1833           commit_one_edge_insertion (e);
1834     }
1835 }
1836 \f
1837
1838 /* Print out RTL-specific basic block information (live information
1839    at start and end with TDF_DETAILS).  FLAGS are the TDF_* masks
1840    documented in dumpfile.h.  */
1841
1842 static void
1843 rtl_dump_bb (FILE *outf, basic_block bb, int indent, int flags)
1844 {
1845   rtx insn;
1846   rtx last;
1847   char *s_indent;
1848
1849   s_indent = (char *) alloca ((size_t) indent + 1);
1850   memset (s_indent, ' ', (size_t) indent);
1851   s_indent[indent] = '\0';
1852
1853   if (df && (flags & TDF_DETAILS))
1854     {
1855       df_dump_top (bb, outf);
1856       putc ('\n', outf);
1857     }
1858
1859   if (bb->index != ENTRY_BLOCK && bb->index != EXIT_BLOCK)
1860     for (insn = BB_HEAD (bb), last = NEXT_INSN (BB_END (bb)); insn != last;
1861          insn = NEXT_INSN (insn))
1862       {
1863         if (! (flags & TDF_SLIM))
1864           print_rtl_single (outf, insn);
1865         else
1866           dump_insn_slim (outf, insn);
1867
1868       }
1869
1870   if (df && (flags & TDF_DETAILS))
1871     {
1872       df_dump_bottom (bb, outf);
1873       putc ('\n', outf);
1874     }
1875
1876 }
1877 \f
1878 /* Like dump_function_to_file, but for RTL.  Print out dataflow information
1879    for the start of each basic block.  FLAGS are the TDF_* masks documented
1880    in dumpfile.h.  */
1881
1882 void
1883 print_rtl_with_bb (FILE *outf, const_rtx rtx_first, int flags)
1884 {
1885   const_rtx tmp_rtx;
1886   if (rtx_first == 0)
1887     fprintf (outf, "(nil)\n");
1888   else
1889     {
1890       enum bb_state { NOT_IN_BB, IN_ONE_BB, IN_MULTIPLE_BB };
1891       int max_uid = get_max_uid ();
1892       basic_block *start = XCNEWVEC (basic_block, max_uid);
1893       basic_block *end = XCNEWVEC (basic_block, max_uid);
1894       enum bb_state *in_bb_p = XCNEWVEC (enum bb_state, max_uid);
1895       basic_block bb;
1896
1897       /* After freeing the CFG, we still have BLOCK_FOR_INSN set on most
1898          insns, but the CFG is not maintained so the basic block info
1899          is not reliable.  Therefore it's omitted from the dumps.  */
1900       if (! (cfun->curr_properties & PROP_cfg))
1901         flags &= ~TDF_BLOCKS;
1902
1903       if (df)
1904         df_dump_start (outf);
1905
1906       if (flags & TDF_BLOCKS)
1907         {
1908           FOR_EACH_BB_REVERSE (bb)
1909             {
1910               rtx x;
1911
1912               start[INSN_UID (BB_HEAD (bb))] = bb;
1913               end[INSN_UID (BB_END (bb))] = bb;
1914               for (x = BB_HEAD (bb); x != NULL_RTX; x = NEXT_INSN (x))
1915                 {
1916                   enum bb_state state = IN_MULTIPLE_BB;
1917
1918                   if (in_bb_p[INSN_UID (x)] == NOT_IN_BB)
1919                     state = IN_ONE_BB;
1920                   in_bb_p[INSN_UID (x)] = state;
1921
1922                   if (x == BB_END (bb))
1923                     break;
1924                 }
1925             }
1926         }
1927
1928       for (tmp_rtx = rtx_first; NULL != tmp_rtx; tmp_rtx = NEXT_INSN (tmp_rtx))
1929         {
1930           if (flags & TDF_BLOCKS)
1931             {
1932               bb = start[INSN_UID (tmp_rtx)];
1933               if (bb != NULL)
1934                 {
1935                   dump_bb_info (outf, bb, 0, dump_flags | TDF_COMMENT, true, false);
1936                   if (df && (flags & TDF_DETAILS))
1937                     df_dump_top (bb, outf);
1938                 }
1939
1940               if (in_bb_p[INSN_UID (tmp_rtx)] == NOT_IN_BB
1941                   && !NOTE_P (tmp_rtx)
1942                   && !BARRIER_P (tmp_rtx))
1943                 fprintf (outf, ";; Insn is not within a basic block\n");
1944               else if (in_bb_p[INSN_UID (tmp_rtx)] == IN_MULTIPLE_BB)
1945                 fprintf (outf, ";; Insn is in multiple basic blocks\n");
1946             }
1947
1948           if (! (flags & TDF_SLIM))
1949             print_rtl_single (outf, tmp_rtx);
1950           else
1951             dump_insn_slim (outf, tmp_rtx);
1952
1953           if (flags & TDF_BLOCKS)
1954             {
1955               bb = end[INSN_UID (tmp_rtx)];
1956               if (bb != NULL)
1957                 {
1958                   dump_bb_info (outf, bb, 0, dump_flags | TDF_COMMENT, false, true);
1959                   if (df && (flags & TDF_DETAILS))
1960                     df_dump_bottom (bb, outf);
1961                 }
1962             }
1963
1964           putc ('\n', outf);
1965         }
1966
1967       free (start);
1968       free (end);
1969       free (in_bb_p);
1970     }
1971
1972   if (crtl->epilogue_delay_list != 0)
1973     {
1974       fprintf (outf, "\n;; Insns in epilogue delay list:\n\n");
1975       for (tmp_rtx = crtl->epilogue_delay_list; tmp_rtx != 0;
1976            tmp_rtx = XEXP (tmp_rtx, 1))
1977         print_rtl_single (outf, XEXP (tmp_rtx, 0));
1978     }
1979 }
1980 \f
1981 /* Update the branch probability of BB if a REG_BR_PROB is present.  */
1982
1983 void
1984 update_br_prob_note (basic_block bb)
1985 {
1986   rtx note;
1987   if (!JUMP_P (BB_END (bb)))
1988     return;
1989   note = find_reg_note (BB_END (bb), REG_BR_PROB, NULL_RTX);
1990   if (!note || INTVAL (XEXP (note, 0)) == BRANCH_EDGE (bb)->probability)
1991     return;
1992   XEXP (note, 0) = GEN_INT (BRANCH_EDGE (bb)->probability);
1993 }
1994
1995 /* Get the last insn associated with block BB (that includes barriers and
1996    tablejumps after BB).  */
1997 rtx
1998 get_last_bb_insn (basic_block bb)
1999 {
2000   rtx tmp;
2001   rtx end = BB_END (bb);
2002
2003   /* Include any jump table following the basic block.  */
2004   if (tablejump_p (end, NULL, &tmp))
2005     end = tmp;
2006
2007   /* Include any barriers that may follow the basic block.  */
2008   tmp = next_nonnote_insn_bb (end);
2009   while (tmp && BARRIER_P (tmp))
2010     {
2011       end = tmp;
2012       tmp = next_nonnote_insn_bb (end);
2013     }
2014
2015   return end;
2016 }
2017 \f
2018 /* Verify the CFG and RTL consistency common for both underlying RTL and
2019    cfglayout RTL.
2020
2021    Currently it does following checks:
2022
2023    - overlapping of basic blocks
2024    - insns with wrong BLOCK_FOR_INSN pointers
2025    - headers of basic blocks (the NOTE_INSN_BASIC_BLOCK note)
2026    - tails of basic blocks (ensure that boundary is necessary)
2027    - scans body of the basic block for JUMP_INSN, CODE_LABEL
2028      and NOTE_INSN_BASIC_BLOCK
2029    - verify that no fall_thru edge crosses hot/cold partition boundaries
2030    - verify that there are no pending RTL branch predictions
2031
2032    In future it can be extended check a lot of other stuff as well
2033    (reachability of basic blocks, life information, etc. etc.).  */
2034
2035 static int
2036 rtl_verify_flow_info_1 (void)
2037 {
2038   rtx x;
2039   int err = 0;
2040   basic_block bb;
2041
2042   /* Check the general integrity of the basic blocks.  */
2043   FOR_EACH_BB_REVERSE (bb)
2044     {
2045       rtx insn;
2046
2047       if (!(bb->flags & BB_RTL))
2048         {
2049           error ("BB_RTL flag not set for block %d", bb->index);
2050           err = 1;
2051         }
2052
2053       FOR_BB_INSNS (bb, insn)
2054         if (BLOCK_FOR_INSN (insn) != bb)
2055           {
2056             error ("insn %d basic block pointer is %d, should be %d",
2057                    INSN_UID (insn),
2058                    BLOCK_FOR_INSN (insn) ? BLOCK_FOR_INSN (insn)->index : 0,
2059                    bb->index);
2060             err = 1;
2061           }
2062
2063       for (insn = BB_HEADER (bb); insn; insn = NEXT_INSN (insn))
2064         if (!BARRIER_P (insn)
2065             && BLOCK_FOR_INSN (insn) != NULL)
2066           {
2067             error ("insn %d in header of bb %d has non-NULL basic block",
2068                    INSN_UID (insn), bb->index);
2069             err = 1;
2070           }
2071       for (insn = BB_FOOTER (bb); insn; insn = NEXT_INSN (insn))
2072         if (!BARRIER_P (insn)
2073             && BLOCK_FOR_INSN (insn) != NULL)
2074           {
2075             error ("insn %d in footer of bb %d has non-NULL basic block",
2076                    INSN_UID (insn), bb->index);
2077             err = 1;
2078           }
2079     }
2080
2081   /* Now check the basic blocks (boundaries etc.) */
2082   FOR_EACH_BB_REVERSE (bb)
2083     {
2084       int n_fallthru = 0, n_eh = 0, n_call = 0, n_abnormal = 0, n_branch = 0;
2085       edge e, fallthru = NULL;
2086       rtx note;
2087       edge_iterator ei;
2088
2089       if (JUMP_P (BB_END (bb))
2090           && (note = find_reg_note (BB_END (bb), REG_BR_PROB, NULL_RTX))
2091           && EDGE_COUNT (bb->succs) >= 2
2092           && any_condjump_p (BB_END (bb)))
2093         {
2094           if (INTVAL (XEXP (note, 0)) != BRANCH_EDGE (bb)->probability
2095               && profile_status != PROFILE_ABSENT)
2096             {
2097               error ("verify_flow_info: REG_BR_PROB does not match cfg %wi %i",
2098                      INTVAL (XEXP (note, 0)), BRANCH_EDGE (bb)->probability);
2099               err = 1;
2100             }
2101         }
2102       FOR_EACH_EDGE (e, ei, bb->succs)
2103         {
2104           bool is_crossing;
2105
2106           if (e->flags & EDGE_FALLTHRU)
2107             n_fallthru++, fallthru = e;
2108
2109           is_crossing = (BB_PARTITION (e->src) != BB_PARTITION (e->dest)
2110                          && e->src != ENTRY_BLOCK_PTR
2111                          && e->dest != EXIT_BLOCK_PTR);
2112           if (e->flags & EDGE_CROSSING)
2113             {
2114               if (!is_crossing)
2115                 {
2116                   error ("EDGE_CROSSING incorrectly set across same section");
2117                   err = 1;
2118                 }
2119               if (e->flags & EDGE_FALLTHRU)
2120                 {
2121                   error ("fallthru edge crosses section boundary (bb %i)",
2122                          e->src->index);
2123                   err = 1;
2124                 }
2125               if (e->flags & EDGE_EH)
2126                 {
2127                   error ("EH edge crosses section boundary (bb %i)",
2128                          e->src->index);
2129                   err = 1;
2130                 }
2131             }
2132           else if (is_crossing)
2133             {
2134               error ("EDGE_CROSSING missing across section boundary");
2135               err = 1;
2136             }
2137
2138           if ((e->flags & ~(EDGE_DFS_BACK
2139                             | EDGE_CAN_FALLTHRU
2140                             | EDGE_IRREDUCIBLE_LOOP
2141                             | EDGE_LOOP_EXIT
2142                             | EDGE_CROSSING
2143                             | EDGE_PRESERVE)) == 0)
2144             n_branch++;
2145
2146           if (e->flags & EDGE_ABNORMAL_CALL)
2147             n_call++;
2148
2149           if (e->flags & EDGE_EH)
2150             n_eh++;
2151           else if (e->flags & EDGE_ABNORMAL)
2152             n_abnormal++;
2153         }
2154
2155       if (n_eh && !find_reg_note (BB_END (bb), REG_EH_REGION, NULL_RTX))
2156         {
2157           error ("missing REG_EH_REGION note in the end of bb %i", bb->index);
2158           err = 1;
2159         }
2160       if (n_eh > 1)
2161         {
2162           error ("too many eh edges %i", bb->index);
2163           err = 1;
2164         }
2165       if (n_branch
2166           && (!JUMP_P (BB_END (bb))
2167               || (n_branch > 1 && (any_uncondjump_p (BB_END (bb))
2168                                    || any_condjump_p (BB_END (bb))))))
2169         {
2170           error ("too many outgoing branch edges from bb %i", bb->index);
2171           err = 1;
2172         }
2173       if (n_fallthru && any_uncondjump_p (BB_END (bb)))
2174         {
2175           error ("fallthru edge after unconditional jump %i", bb->index);
2176           err = 1;
2177         }
2178       if (n_branch != 1 && any_uncondjump_p (BB_END (bb)))
2179         {
2180           error ("wrong number of branch edges after unconditional jump %i",
2181                  bb->index);
2182           err = 1;
2183         }
2184       if (n_branch != 1 && any_condjump_p (BB_END (bb))
2185           && JUMP_LABEL (BB_END (bb)) != BB_HEAD (fallthru->dest))
2186         {
2187           error ("wrong amount of branch edges after conditional jump %i",
2188                  bb->index);
2189           err = 1;
2190         }
2191       if (n_call && !CALL_P (BB_END (bb)))
2192         {
2193           error ("call edges for non-call insn in bb %i", bb->index);
2194           err = 1;
2195         }
2196       if (n_abnormal
2197           && (!CALL_P (BB_END (bb)) && n_call != n_abnormal)
2198           && (!JUMP_P (BB_END (bb))
2199               || any_condjump_p (BB_END (bb))
2200               || any_uncondjump_p (BB_END (bb))))
2201         {
2202           error ("abnormal edges for no purpose in bb %i", bb->index);
2203           err = 1;
2204         }
2205
2206       for (x = BB_HEAD (bb); x != NEXT_INSN (BB_END (bb)); x = NEXT_INSN (x))
2207         /* We may have a barrier inside a basic block before dead code
2208            elimination.  There is no BLOCK_FOR_INSN field in a barrier.  */
2209         if (!BARRIER_P (x) && BLOCK_FOR_INSN (x) != bb)
2210           {
2211             debug_rtx (x);
2212             if (! BLOCK_FOR_INSN (x))
2213               error
2214                 ("insn %d inside basic block %d but block_for_insn is NULL",
2215                  INSN_UID (x), bb->index);
2216             else
2217               error
2218                 ("insn %d inside basic block %d but block_for_insn is %i",
2219                  INSN_UID (x), bb->index, BLOCK_FOR_INSN (x)->index);
2220
2221             err = 1;
2222           }
2223
2224       /* OK pointers are correct.  Now check the header of basic
2225          block.  It ought to contain optional CODE_LABEL followed
2226          by NOTE_BASIC_BLOCK.  */
2227       x = BB_HEAD (bb);
2228       if (LABEL_P (x))
2229         {
2230           if (BB_END (bb) == x)
2231             {
2232               error ("NOTE_INSN_BASIC_BLOCK is missing for block %d",
2233                      bb->index);
2234               err = 1;
2235             }
2236
2237           x = NEXT_INSN (x);
2238         }
2239
2240       if (!NOTE_INSN_BASIC_BLOCK_P (x) || NOTE_BASIC_BLOCK (x) != bb)
2241         {
2242           error ("NOTE_INSN_BASIC_BLOCK is missing for block %d",
2243                  bb->index);
2244           err = 1;
2245         }
2246
2247       if (BB_END (bb) == x)
2248         /* Do checks for empty blocks here.  */
2249         ;
2250       else
2251         for (x = NEXT_INSN (x); x; x = NEXT_INSN (x))
2252           {
2253             if (NOTE_INSN_BASIC_BLOCK_P (x))
2254               {
2255                 error ("NOTE_INSN_BASIC_BLOCK %d in middle of basic block %d",
2256                        INSN_UID (x), bb->index);
2257                 err = 1;
2258               }
2259
2260             if (x == BB_END (bb))
2261               break;
2262
2263             if (control_flow_insn_p (x))
2264               {
2265                 error ("in basic block %d:", bb->index);
2266                 fatal_insn ("flow control insn inside a basic block", x);
2267               }
2268           }
2269     }
2270
2271   /* Clean up.  */
2272   return err;
2273 }
2274
2275 /* Verify the CFG and RTL consistency common for both underlying RTL and
2276    cfglayout RTL.
2277
2278    Currently it does following checks:
2279    - all checks of rtl_verify_flow_info_1
2280    - test head/end pointers
2281    - check that all insns are in the basic blocks
2282      (except the switch handling code, barriers and notes)
2283    - check that all returns are followed by barriers
2284    - check that all fallthru edge points to the adjacent blocks.  */
2285
2286 static int
2287 rtl_verify_flow_info (void)
2288 {
2289   basic_block bb;
2290   int err = rtl_verify_flow_info_1 ();
2291   rtx x;
2292   rtx last_head = get_last_insn ();
2293   basic_block *bb_info;
2294   int num_bb_notes;
2295   const rtx rtx_first = get_insns ();
2296   basic_block last_bb_seen = ENTRY_BLOCK_PTR, curr_bb = NULL;
2297   const int max_uid = get_max_uid ();
2298
2299   bb_info = XCNEWVEC (basic_block, max_uid);
2300
2301   FOR_EACH_BB_REVERSE (bb)
2302     {
2303       edge e;
2304       rtx head = BB_HEAD (bb);
2305       rtx end = BB_END (bb);
2306
2307       for (x = last_head; x != NULL_RTX; x = PREV_INSN (x))
2308         {
2309           /* Verify the end of the basic block is in the INSN chain.  */
2310           if (x == end)
2311             break;
2312
2313           /* And that the code outside of basic blocks has NULL bb field.  */
2314         if (!BARRIER_P (x)
2315             && BLOCK_FOR_INSN (x) != NULL)
2316           {
2317             error ("insn %d outside of basic blocks has non-NULL bb field",
2318                    INSN_UID (x));
2319             err = 1;
2320           }
2321         }
2322
2323       if (!x)
2324         {
2325           error ("end insn %d for block %d not found in the insn stream",
2326                  INSN_UID (end), bb->index);
2327           err = 1;
2328         }
2329
2330       /* Work backwards from the end to the head of the basic block
2331          to verify the head is in the RTL chain.  */
2332       for (; x != NULL_RTX; x = PREV_INSN (x))
2333         {
2334           /* While walking over the insn chain, verify insns appear
2335              in only one basic block.  */
2336           if (bb_info[INSN_UID (x)] != NULL)
2337             {
2338               error ("insn %d is in multiple basic blocks (%d and %d)",
2339                      INSN_UID (x), bb->index, bb_info[INSN_UID (x)]->index);
2340               err = 1;
2341             }
2342
2343           bb_info[INSN_UID (x)] = bb;
2344
2345           if (x == head)
2346             break;
2347         }
2348       if (!x)
2349         {
2350           error ("head insn %d for block %d not found in the insn stream",
2351                  INSN_UID (head), bb->index);
2352           err = 1;
2353         }
2354
2355       last_head = PREV_INSN (x);
2356
2357       e = find_fallthru_edge (bb->succs);
2358       if (!e)
2359         {
2360           rtx insn;
2361
2362           /* Ensure existence of barrier in BB with no fallthru edges.  */
2363           for (insn = NEXT_INSN (BB_END (bb)); ; insn = NEXT_INSN (insn))
2364             {
2365               if (!insn || NOTE_INSN_BASIC_BLOCK_P (insn))
2366                 {
2367                   error ("missing barrier after block %i", bb->index);
2368                   err = 1;
2369                   break;
2370                 }
2371               if (BARRIER_P (insn))
2372                 break;
2373             }
2374         }
2375       else if (e->src != ENTRY_BLOCK_PTR
2376                && e->dest != EXIT_BLOCK_PTR)
2377         {
2378           rtx insn;
2379
2380           if (e->src->next_bb != e->dest)
2381             {
2382               error
2383                 ("verify_flow_info: Incorrect blocks for fallthru %i->%i",
2384                  e->src->index, e->dest->index);
2385               err = 1;
2386             }
2387           else
2388             for (insn = NEXT_INSN (BB_END (e->src)); insn != BB_HEAD (e->dest);
2389                  insn = NEXT_INSN (insn))
2390               if (BARRIER_P (insn) || INSN_P (insn))
2391                 {
2392                   error ("verify_flow_info: Incorrect fallthru %i->%i",
2393                          e->src->index, e->dest->index);
2394                   fatal_insn ("wrong insn in the fallthru edge", insn);
2395                   err = 1;
2396                 }
2397         }
2398     }
2399
2400   for (x = last_head; x != NULL_RTX; x = PREV_INSN (x))
2401     {
2402       /* Check that the code before the first basic block has NULL
2403          bb field.  */
2404       if (!BARRIER_P (x)
2405           && BLOCK_FOR_INSN (x) != NULL)
2406         {
2407           error ("insn %d outside of basic blocks has non-NULL bb field",
2408                  INSN_UID (x));
2409           err = 1;
2410         }
2411     }
2412   free (bb_info);
2413
2414   num_bb_notes = 0;
2415   last_bb_seen = ENTRY_BLOCK_PTR;
2416
2417   for (x = rtx_first; x; x = NEXT_INSN (x))
2418     {
2419       if (NOTE_INSN_BASIC_BLOCK_P (x))
2420         {
2421           bb = NOTE_BASIC_BLOCK (x);
2422
2423           num_bb_notes++;
2424           if (bb != last_bb_seen->next_bb)
2425             internal_error ("basic blocks not laid down consecutively");
2426
2427           curr_bb = last_bb_seen = bb;
2428         }
2429
2430       if (!curr_bb)
2431         {
2432           switch (GET_CODE (x))
2433             {
2434             case BARRIER:
2435             case NOTE:
2436               break;
2437
2438             case CODE_LABEL:
2439               /* An addr_vec is placed outside any basic block.  */
2440               if (NEXT_INSN (x)
2441                   && JUMP_TABLE_DATA_P (NEXT_INSN (x)))
2442                 x = NEXT_INSN (x);
2443
2444               /* But in any case, non-deletable labels can appear anywhere.  */
2445               break;
2446
2447             default:
2448               fatal_insn ("insn outside basic block", x);
2449             }
2450         }
2451
2452       if (JUMP_P (x)
2453           && returnjump_p (x) && ! condjump_p (x)
2454           && ! (next_nonnote_insn (x) && BARRIER_P (next_nonnote_insn (x))))
2455             fatal_insn ("return not followed by barrier", x);
2456       if (curr_bb && x == BB_END (curr_bb))
2457         curr_bb = NULL;
2458     }
2459
2460   if (num_bb_notes != n_basic_blocks - NUM_FIXED_BLOCKS)
2461     internal_error
2462       ("number of bb notes in insn chain (%d) != n_basic_blocks (%d)",
2463        num_bb_notes, n_basic_blocks);
2464
2465    return err;
2466 }
2467 \f
2468 /* Assume that the preceding pass has possibly eliminated jump instructions
2469    or converted the unconditional jumps.  Eliminate the edges from CFG.
2470    Return true if any edges are eliminated.  */
2471
2472 bool
2473 purge_dead_edges (basic_block bb)
2474 {
2475   edge e;
2476   rtx insn = BB_END (bb), note;
2477   bool purged = false;
2478   bool found;
2479   edge_iterator ei;
2480
2481   if (DEBUG_INSN_P (insn) && insn != BB_HEAD (bb))
2482     do
2483       insn = PREV_INSN (insn);
2484     while ((DEBUG_INSN_P (insn) || NOTE_P (insn)) && insn != BB_HEAD (bb));
2485
2486   /* If this instruction cannot trap, remove REG_EH_REGION notes.  */
2487   if (NONJUMP_INSN_P (insn)
2488       && (note = find_reg_note (insn, REG_EH_REGION, NULL)))
2489     {
2490       rtx eqnote;
2491
2492       if (! may_trap_p (PATTERN (insn))
2493           || ((eqnote = find_reg_equal_equiv_note (insn))
2494               && ! may_trap_p (XEXP (eqnote, 0))))
2495         remove_note (insn, note);
2496     }
2497
2498   /* Cleanup abnormal edges caused by exceptions or non-local gotos.  */
2499   for (ei = ei_start (bb->succs); (e = ei_safe_edge (ei)); )
2500     {
2501       bool remove = false;
2502
2503       /* There are three types of edges we need to handle correctly here: EH
2504          edges, abnormal call EH edges, and abnormal call non-EH edges.  The
2505          latter can appear when nonlocal gotos are used.  */
2506       if (e->flags & EDGE_ABNORMAL_CALL)
2507         {
2508           if (!CALL_P (insn))
2509             remove = true;
2510           else if (can_nonlocal_goto (insn))
2511             ;
2512           else if ((e->flags & EDGE_EH) && can_throw_internal (insn))
2513             ;
2514           else if (flag_tm && find_reg_note (insn, REG_TM, NULL))
2515             ;
2516           else
2517             remove = true;
2518         }
2519       else if (e->flags & EDGE_EH)
2520         remove = !can_throw_internal (insn);
2521
2522       if (remove)
2523         {
2524           remove_edge (e);
2525           df_set_bb_dirty (bb);
2526           purged = true;
2527         }
2528       else
2529         ei_next (&ei);
2530     }
2531
2532   if (JUMP_P (insn))
2533     {
2534       rtx note;
2535       edge b,f;
2536       edge_iterator ei;
2537
2538       /* We do care only about conditional jumps and simplejumps.  */
2539       if (!any_condjump_p (insn)
2540           && !returnjump_p (insn)
2541           && !simplejump_p (insn))
2542         return purged;
2543
2544       /* Branch probability/prediction notes are defined only for
2545          condjumps.  We've possibly turned condjump into simplejump.  */
2546       if (simplejump_p (insn))
2547         {
2548           note = find_reg_note (insn, REG_BR_PROB, NULL);
2549           if (note)
2550             remove_note (insn, note);
2551           while ((note = find_reg_note (insn, REG_BR_PRED, NULL)))
2552             remove_note (insn, note);
2553         }
2554
2555       for (ei = ei_start (bb->succs); (e = ei_safe_edge (ei)); )
2556         {
2557           /* Avoid abnormal flags to leak from computed jumps turned
2558              into simplejumps.  */
2559
2560           e->flags &= ~EDGE_ABNORMAL;
2561
2562           /* See if this edge is one we should keep.  */
2563           if ((e->flags & EDGE_FALLTHRU) && any_condjump_p (insn))
2564             /* A conditional jump can fall through into the next
2565                block, so we should keep the edge.  */
2566             {
2567               ei_next (&ei);
2568               continue;
2569             }
2570           else if (e->dest != EXIT_BLOCK_PTR
2571                    && BB_HEAD (e->dest) == JUMP_LABEL (insn))
2572             /* If the destination block is the target of the jump,
2573                keep the edge.  */
2574             {
2575               ei_next (&ei);
2576               continue;
2577             }
2578           else if (e->dest == EXIT_BLOCK_PTR && returnjump_p (insn))
2579             /* If the destination block is the exit block, and this
2580                instruction is a return, then keep the edge.  */
2581             {
2582               ei_next (&ei);
2583               continue;
2584             }
2585           else if ((e->flags & EDGE_EH) && can_throw_internal (insn))
2586             /* Keep the edges that correspond to exceptions thrown by
2587                this instruction and rematerialize the EDGE_ABNORMAL
2588                flag we just cleared above.  */
2589             {
2590               e->flags |= EDGE_ABNORMAL;
2591               ei_next (&ei);
2592               continue;
2593             }
2594
2595           /* We do not need this edge.  */
2596           df_set_bb_dirty (bb);
2597           purged = true;
2598           remove_edge (e);
2599         }
2600
2601       if (EDGE_COUNT (bb->succs) == 0 || !purged)
2602         return purged;
2603
2604       if (dump_file)
2605         fprintf (dump_file, "Purged edges from bb %i\n", bb->index);
2606
2607       if (!optimize)
2608         return purged;
2609
2610       /* Redistribute probabilities.  */
2611       if (single_succ_p (bb))
2612         {
2613           single_succ_edge (bb)->probability = REG_BR_PROB_BASE;
2614           single_succ_edge (bb)->count = bb->count;
2615         }
2616       else
2617         {
2618           note = find_reg_note (insn, REG_BR_PROB, NULL);
2619           if (!note)
2620             return purged;
2621
2622           b = BRANCH_EDGE (bb);
2623           f = FALLTHRU_EDGE (bb);
2624           b->probability = INTVAL (XEXP (note, 0));
2625           f->probability = REG_BR_PROB_BASE - b->probability;
2626           b->count = bb->count * b->probability / REG_BR_PROB_BASE;
2627           f->count = bb->count * f->probability / REG_BR_PROB_BASE;
2628         }
2629
2630       return purged;
2631     }
2632   else if (CALL_P (insn) && SIBLING_CALL_P (insn))
2633     {
2634       /* First, there should not be any EH or ABCALL edges resulting
2635          from non-local gotos and the like.  If there were, we shouldn't
2636          have created the sibcall in the first place.  Second, there
2637          should of course never have been a fallthru edge.  */
2638       gcc_assert (single_succ_p (bb));
2639       gcc_assert (single_succ_edge (bb)->flags
2640                   == (EDGE_SIBCALL | EDGE_ABNORMAL));
2641
2642       return 0;
2643     }
2644
2645   /* If we don't see a jump insn, we don't know exactly why the block would
2646      have been broken at this point.  Look for a simple, non-fallthru edge,
2647      as these are only created by conditional branches.  If we find such an
2648      edge we know that there used to be a jump here and can then safely
2649      remove all non-fallthru edges.  */
2650   found = false;
2651   FOR_EACH_EDGE (e, ei, bb->succs)
2652     if (! (e->flags & (EDGE_COMPLEX | EDGE_FALLTHRU)))
2653       {
2654         found = true;
2655         break;
2656       }
2657
2658   if (!found)
2659     return purged;
2660
2661   /* Remove all but the fake and fallthru edges.  The fake edge may be
2662      the only successor for this block in the case of noreturn
2663      calls.  */
2664   for (ei = ei_start (bb->succs); (e = ei_safe_edge (ei)); )
2665     {
2666       if (!(e->flags & (EDGE_FALLTHRU | EDGE_FAKE)))
2667         {
2668           df_set_bb_dirty (bb);
2669           remove_edge (e);
2670           purged = true;
2671         }
2672       else
2673         ei_next (&ei);
2674     }
2675
2676   gcc_assert (single_succ_p (bb));
2677
2678   single_succ_edge (bb)->probability = REG_BR_PROB_BASE;
2679   single_succ_edge (bb)->count = bb->count;
2680
2681   if (dump_file)
2682     fprintf (dump_file, "Purged non-fallthru edges from bb %i\n",
2683              bb->index);
2684   return purged;
2685 }
2686
2687 /* Search all basic blocks for potentially dead edges and purge them.  Return
2688    true if some edge has been eliminated.  */
2689
2690 bool
2691 purge_all_dead_edges (void)
2692 {
2693   int purged = false;
2694   basic_block bb;
2695
2696   FOR_EACH_BB (bb)
2697     {
2698       bool purged_here = purge_dead_edges (bb);
2699
2700       purged |= purged_here;
2701     }
2702
2703   return purged;
2704 }
2705
2706 /* This is used by a few passes that emit some instructions after abnormal
2707    calls, moving the basic block's end, while they in fact do want to emit
2708    them on the fallthru edge.  Look for abnormal call edges, find backward
2709    the call in the block and insert the instructions on the edge instead.
2710
2711    Similarly, handle instructions throwing exceptions internally.
2712
2713    Return true when instructions have been found and inserted on edges.  */
2714
2715 bool
2716 fixup_abnormal_edges (void)
2717 {
2718   bool inserted = false;
2719   basic_block bb;
2720
2721   FOR_EACH_BB (bb)
2722     {
2723       edge e;
2724       edge_iterator ei;
2725
2726       /* Look for cases we are interested in - calls or instructions causing
2727          exceptions.  */
2728       FOR_EACH_EDGE (e, ei, bb->succs)
2729         if ((e->flags & EDGE_ABNORMAL_CALL)
2730             || ((e->flags & (EDGE_ABNORMAL | EDGE_EH))
2731                 == (EDGE_ABNORMAL | EDGE_EH)))
2732           break;
2733
2734       if (e && !CALL_P (BB_END (bb)) && !can_throw_internal (BB_END (bb)))
2735         {
2736           rtx insn;
2737
2738           /* Get past the new insns generated.  Allow notes, as the insns
2739              may be already deleted.  */
2740           insn = BB_END (bb);
2741           while ((NONJUMP_INSN_P (insn) || NOTE_P (insn))
2742                  && !can_throw_internal (insn)
2743                  && insn != BB_HEAD (bb))
2744             insn = PREV_INSN (insn);
2745
2746           if (CALL_P (insn) || can_throw_internal (insn))
2747             {
2748               rtx stop, next;
2749
2750               e = find_fallthru_edge (bb->succs);
2751
2752               stop = NEXT_INSN (BB_END (bb));
2753               BB_END (bb) = insn;
2754
2755               for (insn = NEXT_INSN (insn); insn != stop; insn = next)
2756                 {
2757                   next = NEXT_INSN (insn);
2758                   if (INSN_P (insn))
2759                     {
2760                       delete_insn (insn);
2761
2762                       /* Sometimes there's still the return value USE.
2763                          If it's placed after a trapping call (i.e. that
2764                          call is the last insn anyway), we have no fallthru
2765                          edge.  Simply delete this use and don't try to insert
2766                          on the non-existent edge.  */
2767                       if (GET_CODE (PATTERN (insn)) != USE)
2768                         {
2769                           /* We're not deleting it, we're moving it.  */
2770                           INSN_DELETED_P (insn) = 0;
2771                           PREV_INSN (insn) = NULL_RTX;
2772                           NEXT_INSN (insn) = NULL_RTX;
2773
2774                           insert_insn_on_edge (insn, e);
2775                           inserted = true;
2776                         }
2777                     }
2778                   else if (!BARRIER_P (insn))
2779                     set_block_for_insn (insn, NULL);
2780                 }
2781             }
2782
2783           /* It may be that we don't find any trapping insn.  In this
2784              case we discovered quite late that the insn that had been
2785              marked as can_throw_internal in fact couldn't trap at all.
2786              So we should in fact delete the EH edges out of the block.  */
2787           else
2788             purge_dead_edges (bb);
2789         }
2790     }
2791
2792   return inserted;
2793 }
2794 \f
2795 /* Cut the insns from FIRST to LAST out of the insns stream.  */
2796
2797 rtx
2798 unlink_insn_chain (rtx first, rtx last)
2799 {
2800   rtx prevfirst = PREV_INSN (first);
2801   rtx nextlast = NEXT_INSN (last);
2802
2803   PREV_INSN (first) = NULL;
2804   NEXT_INSN (last) = NULL;
2805   if (prevfirst)
2806     NEXT_INSN (prevfirst) = nextlast;
2807   if (nextlast)
2808     PREV_INSN (nextlast) = prevfirst;
2809   else
2810     set_last_insn (prevfirst);
2811   if (!prevfirst)
2812     set_first_insn (nextlast);
2813   return first;
2814 }
2815 \f
2816 /* Skip over inter-block insns occurring after BB which are typically
2817    associated with BB (e.g., barriers). If there are any such insns,
2818    we return the last one. Otherwise, we return the end of BB.  */
2819
2820 static rtx
2821 skip_insns_after_block (basic_block bb)
2822 {
2823   rtx insn, last_insn, next_head, prev;
2824
2825   next_head = NULL_RTX;
2826   if (bb->next_bb != EXIT_BLOCK_PTR)
2827     next_head = BB_HEAD (bb->next_bb);
2828
2829   for (last_insn = insn = BB_END (bb); (insn = NEXT_INSN (insn)) != 0; )
2830     {
2831       if (insn == next_head)
2832         break;
2833
2834       switch (GET_CODE (insn))
2835         {
2836         case BARRIER:
2837           last_insn = insn;
2838           continue;
2839
2840         case NOTE:
2841           switch (NOTE_KIND (insn))
2842             {
2843             case NOTE_INSN_BLOCK_END:
2844               gcc_unreachable ();
2845               continue;
2846             default:
2847               continue;
2848               break;
2849             }
2850           break;
2851
2852         case CODE_LABEL:
2853           if (NEXT_INSN (insn)
2854               && JUMP_TABLE_DATA_P (NEXT_INSN (insn)))
2855             {
2856               insn = NEXT_INSN (insn);
2857               last_insn = insn;
2858               continue;
2859             }
2860           break;
2861
2862         default:
2863           break;
2864         }
2865
2866       break;
2867     }
2868
2869   /* It is possible to hit contradictory sequence.  For instance:
2870
2871      jump_insn
2872      NOTE_INSN_BLOCK_BEG
2873      barrier
2874
2875      Where barrier belongs to jump_insn, but the note does not.  This can be
2876      created by removing the basic block originally following
2877      NOTE_INSN_BLOCK_BEG.  In such case reorder the notes.  */
2878
2879   for (insn = last_insn; insn != BB_END (bb); insn = prev)
2880     {
2881       prev = PREV_INSN (insn);
2882       if (NOTE_P (insn))
2883         switch (NOTE_KIND (insn))
2884           {
2885           case NOTE_INSN_BLOCK_END:
2886             gcc_unreachable ();
2887             break;
2888           case NOTE_INSN_DELETED:
2889           case NOTE_INSN_DELETED_LABEL:
2890           case NOTE_INSN_DELETED_DEBUG_LABEL:
2891             continue;
2892           default:
2893             reorder_insns (insn, insn, last_insn);
2894           }
2895     }
2896
2897   return last_insn;
2898 }
2899
2900 /* Locate or create a label for a given basic block.  */
2901
2902 static rtx
2903 label_for_bb (basic_block bb)
2904 {
2905   rtx label = BB_HEAD (bb);
2906
2907   if (!LABEL_P (label))
2908     {
2909       if (dump_file)
2910         fprintf (dump_file, "Emitting label for block %d\n", bb->index);
2911
2912       label = block_label (bb);
2913     }
2914
2915   return label;
2916 }
2917
2918 /* Locate the effective beginning and end of the insn chain for each
2919    block, as defined by skip_insns_after_block above.  */
2920
2921 static void
2922 record_effective_endpoints (void)
2923 {
2924   rtx next_insn;
2925   basic_block bb;
2926   rtx insn;
2927
2928   for (insn = get_insns ();
2929        insn
2930        && NOTE_P (insn)
2931        && NOTE_KIND (insn) != NOTE_INSN_BASIC_BLOCK;
2932        insn = NEXT_INSN (insn))
2933     continue;
2934   /* No basic blocks at all?  */
2935   gcc_assert (insn);
2936
2937   if (PREV_INSN (insn))
2938     cfg_layout_function_header =
2939             unlink_insn_chain (get_insns (), PREV_INSN (insn));
2940   else
2941     cfg_layout_function_header = NULL_RTX;
2942
2943   next_insn = get_insns ();
2944   FOR_EACH_BB (bb)
2945     {
2946       rtx end;
2947
2948       if (PREV_INSN (BB_HEAD (bb)) && next_insn != BB_HEAD (bb))
2949         BB_HEADER (bb) = unlink_insn_chain (next_insn,
2950                                               PREV_INSN (BB_HEAD (bb)));
2951       end = skip_insns_after_block (bb);
2952       if (NEXT_INSN (BB_END (bb)) && BB_END (bb) != end)
2953         BB_FOOTER (bb) = unlink_insn_chain (NEXT_INSN (BB_END (bb)), end);
2954       next_insn = NEXT_INSN (BB_END (bb));
2955     }
2956
2957   cfg_layout_function_footer = next_insn;
2958   if (cfg_layout_function_footer)
2959     cfg_layout_function_footer = unlink_insn_chain (cfg_layout_function_footer, get_last_insn ());
2960 }
2961 \f
2962 static unsigned int
2963 into_cfg_layout_mode (void)
2964 {
2965   cfg_layout_initialize (0);
2966   return 0;
2967 }
2968
2969 static unsigned int
2970 outof_cfg_layout_mode (void)
2971 {
2972   basic_block bb;
2973
2974   FOR_EACH_BB (bb)
2975     if (bb->next_bb != EXIT_BLOCK_PTR)
2976       bb->aux = bb->next_bb;
2977
2978   cfg_layout_finalize ();
2979
2980   return 0;
2981 }
2982
2983 struct rtl_opt_pass pass_into_cfg_layout_mode =
2984 {
2985  {
2986   RTL_PASS,
2987   "into_cfglayout",                     /* name */
2988   NULL,                                 /* gate */
2989   into_cfg_layout_mode,                 /* execute */
2990   NULL,                                 /* sub */
2991   NULL,                                 /* next */
2992   0,                                    /* static_pass_number */
2993   TV_CFG,                               /* tv_id */
2994   0,                                    /* properties_required */
2995   PROP_cfglayout,                       /* properties_provided */
2996   0,                                    /* properties_destroyed */
2997   0,                                    /* todo_flags_start */
2998   0                                     /* todo_flags_finish */
2999  }
3000 };
3001
3002 struct rtl_opt_pass pass_outof_cfg_layout_mode =
3003 {
3004  {
3005   RTL_PASS,
3006   "outof_cfglayout",                    /* name */
3007   NULL,                                 /* gate */
3008   outof_cfg_layout_mode,                /* execute */
3009   NULL,                                 /* sub */
3010   NULL,                                 /* next */
3011   0,                                    /* static_pass_number */
3012   TV_CFG,                               /* tv_id */
3013   0,                                    /* properties_required */
3014   0,                                    /* properties_provided */
3015   PROP_cfglayout,                       /* properties_destroyed */
3016   0,                                    /* todo_flags_start */
3017   0                                     /* todo_flags_finish */
3018  }
3019 };
3020 \f
3021
3022 /* Link the basic blocks in the correct order, compacting the basic
3023    block queue while at it.  If STAY_IN_CFGLAYOUT_MODE is false, this
3024    function also clears the basic block header and footer fields.
3025
3026    This function is usually called after a pass (e.g. tracer) finishes
3027    some transformations while in cfglayout mode.  The required sequence
3028    of the basic blocks is in a linked list along the bb->aux field.
3029    This functions re-links the basic block prev_bb and next_bb pointers
3030    accordingly, and it compacts and renumbers the blocks.
3031
3032    FIXME: This currently works only for RTL, but the only RTL-specific
3033    bits are the STAY_IN_CFGLAYOUT_MODE bits.  The tracer pass was moved
3034    to GIMPLE a long time ago, but it doesn't relink the basic block
3035    chain.  It could do that (to give better initial RTL) if this function
3036    is made IR-agnostic (and moved to cfganal.c or cfg.c while at it).  */
3037
3038 void
3039 relink_block_chain (bool stay_in_cfglayout_mode)
3040 {
3041   basic_block bb, prev_bb;
3042   int index;
3043
3044   /* Maybe dump the re-ordered sequence.  */
3045   if (dump_file)
3046     {
3047       fprintf (dump_file, "Reordered sequence:\n");
3048       for (bb = ENTRY_BLOCK_PTR->next_bb, index = NUM_FIXED_BLOCKS;
3049            bb;
3050            bb = (basic_block) bb->aux, index++)
3051         {
3052           fprintf (dump_file, " %i ", index);
3053           if (get_bb_original (bb))
3054             fprintf (dump_file, "duplicate of %i ",
3055                      get_bb_original (bb)->index);
3056           else if (forwarder_block_p (bb)
3057                    && !LABEL_P (BB_HEAD (bb)))
3058             fprintf (dump_file, "compensation ");
3059           else
3060             fprintf (dump_file, "bb %i ", bb->index);
3061           fprintf (dump_file, " [%i]\n", bb->frequency);
3062         }
3063     }
3064
3065   /* Now reorder the blocks.  */
3066   prev_bb = ENTRY_BLOCK_PTR;
3067   bb = ENTRY_BLOCK_PTR->next_bb;
3068   for (; bb; prev_bb = bb, bb = (basic_block) bb->aux)
3069     {
3070       bb->prev_bb = prev_bb;
3071       prev_bb->next_bb = bb;
3072     }
3073   prev_bb->next_bb = EXIT_BLOCK_PTR;
3074   EXIT_BLOCK_PTR->prev_bb = prev_bb;
3075
3076   /* Then, clean up the aux fields.  */
3077   FOR_ALL_BB (bb)
3078     {
3079       bb->aux = NULL;
3080       if (!stay_in_cfglayout_mode)
3081         BB_HEADER (bb) = BB_FOOTER (bb) = NULL;
3082     }
3083
3084   /* Maybe reset the original copy tables, they are not valid anymore
3085      when we renumber the basic blocks in compact_blocks.  If we are
3086      are going out of cfglayout mode, don't re-allocate the tables.  */
3087   free_original_copy_tables ();
3088   if (stay_in_cfglayout_mode)
3089     initialize_original_copy_tables ();
3090
3091   /* Finally, put basic_block_info in the new order.  */
3092   compact_blocks ();
3093 }
3094 \f
3095
3096 /* Given a reorder chain, rearrange the code to match.  */
3097
3098 static void
3099 fixup_reorder_chain (void)
3100 {
3101   basic_block bb;
3102   rtx insn = NULL;
3103
3104   if (cfg_layout_function_header)
3105     {
3106       set_first_insn (cfg_layout_function_header);
3107       insn = cfg_layout_function_header;
3108       while (NEXT_INSN (insn))
3109         insn = NEXT_INSN (insn);
3110     }
3111
3112   /* First do the bulk reordering -- rechain the blocks without regard to
3113      the needed changes to jumps and labels.  */
3114
3115   for (bb = ENTRY_BLOCK_PTR->next_bb; bb; bb = (basic_block) bb->aux)
3116     {
3117       if (BB_HEADER (bb))
3118         {
3119           if (insn)
3120             NEXT_INSN (insn) = BB_HEADER (bb);
3121           else
3122             set_first_insn (BB_HEADER (bb));
3123           PREV_INSN (BB_HEADER (bb)) = insn;
3124           insn = BB_HEADER (bb);
3125           while (NEXT_INSN (insn))
3126             insn = NEXT_INSN (insn);
3127         }
3128       if (insn)
3129         NEXT_INSN (insn) = BB_HEAD (bb);
3130       else
3131         set_first_insn (BB_HEAD (bb));
3132       PREV_INSN (BB_HEAD (bb)) = insn;
3133       insn = BB_END (bb);
3134       if (BB_FOOTER (bb))
3135         {
3136           NEXT_INSN (insn) = BB_FOOTER (bb);
3137           PREV_INSN (BB_FOOTER (bb)) = insn;
3138           while (NEXT_INSN (insn))
3139             insn = NEXT_INSN (insn);
3140         }
3141     }
3142
3143   NEXT_INSN (insn) = cfg_layout_function_footer;
3144   if (cfg_layout_function_footer)
3145     PREV_INSN (cfg_layout_function_footer) = insn;
3146
3147   while (NEXT_INSN (insn))
3148     insn = NEXT_INSN (insn);
3149
3150   set_last_insn (insn);
3151 #ifdef ENABLE_CHECKING
3152   verify_insn_chain ();
3153 #endif
3154
3155   /* Now add jumps and labels as needed to match the blocks new
3156      outgoing edges.  */
3157
3158   for (bb = ENTRY_BLOCK_PTR->next_bb; bb ; bb = (basic_block) bb->aux)
3159     {
3160       edge e_fall, e_taken, e;
3161       rtx bb_end_insn;
3162       rtx ret_label = NULL_RTX;
3163       basic_block nb, src_bb;
3164       edge_iterator ei;
3165
3166       if (EDGE_COUNT (bb->succs) == 0)
3167         continue;
3168
3169       /* Find the old fallthru edge, and another non-EH edge for
3170          a taken jump.  */
3171       e_taken = e_fall = NULL;
3172
3173       FOR_EACH_EDGE (e, ei, bb->succs)
3174         if (e->flags & EDGE_FALLTHRU)
3175           e_fall = e;
3176         else if (! (e->flags & EDGE_EH))
3177           e_taken = e;
3178
3179       bb_end_insn = BB_END (bb);
3180       if (JUMP_P (bb_end_insn))
3181         {
3182           ret_label = JUMP_LABEL (bb_end_insn);
3183           if (any_condjump_p (bb_end_insn))
3184             {
3185               /* This might happen if the conditional jump has side
3186                  effects and could therefore not be optimized away.
3187                  Make the basic block to end with a barrier in order
3188                  to prevent rtl_verify_flow_info from complaining.  */
3189               if (!e_fall)
3190                 {
3191                   gcc_assert (!onlyjump_p (bb_end_insn)
3192                               || returnjump_p (bb_end_insn));
3193                   BB_FOOTER (bb) = emit_barrier_after (bb_end_insn);
3194                   continue;
3195                 }
3196
3197               /* If the old fallthru is still next, nothing to do.  */
3198               if (bb->aux == e_fall->dest
3199                   || e_fall->dest == EXIT_BLOCK_PTR)
3200                 continue;
3201
3202               /* The degenerated case of conditional jump jumping to the next
3203                  instruction can happen for jumps with side effects.  We need
3204                  to construct a forwarder block and this will be done just
3205                  fine by force_nonfallthru below.  */
3206               if (!e_taken)
3207                 ;
3208
3209               /* There is another special case: if *neither* block is next,
3210                  such as happens at the very end of a function, then we'll
3211                  need to add a new unconditional jump.  Choose the taken
3212                  edge based on known or assumed probability.  */
3213               else if (bb->aux != e_taken->dest)
3214                 {
3215                   rtx note = find_reg_note (bb_end_insn, REG_BR_PROB, 0);
3216
3217                   if (note
3218                       && INTVAL (XEXP (note, 0)) < REG_BR_PROB_BASE / 2
3219                       && invert_jump (bb_end_insn,
3220                                       (e_fall->dest == EXIT_BLOCK_PTR
3221                                        ? NULL_RTX
3222                                        : label_for_bb (e_fall->dest)), 0))
3223                     {
3224                       e_fall->flags &= ~EDGE_FALLTHRU;
3225                       gcc_checking_assert (could_fall_through
3226                                            (e_taken->src, e_taken->dest));
3227                       e_taken->flags |= EDGE_FALLTHRU;
3228                       update_br_prob_note (bb);
3229                       e = e_fall, e_fall = e_taken, e_taken = e;
3230                     }
3231                 }
3232
3233               /* If the "jumping" edge is a crossing edge, and the fall
3234                  through edge is non-crossing, leave things as they are.  */
3235               else if ((e_taken->flags & EDGE_CROSSING)
3236                        && !(e_fall->flags & EDGE_CROSSING))
3237                 continue;
3238
3239               /* Otherwise we can try to invert the jump.  This will
3240                  basically never fail, however, keep up the pretense.  */
3241               else if (invert_jump (bb_end_insn,
3242                                     (e_fall->dest == EXIT_BLOCK_PTR
3243                                      ? NULL_RTX
3244                                      : label_for_bb (e_fall->dest)), 0))
3245                 {
3246                   e_fall->flags &= ~EDGE_FALLTHRU;
3247                   gcc_checking_assert (could_fall_through
3248                                        (e_taken->src, e_taken->dest));
3249                   e_taken->flags |= EDGE_FALLTHRU;
3250                   update_br_prob_note (bb);
3251                   if (LABEL_NUSES (ret_label) == 0
3252                       && single_pred_p (e_taken->dest))
3253                     delete_insn (ret_label);
3254                   continue;
3255                 }
3256             }
3257           else if (extract_asm_operands (PATTERN (bb_end_insn)) != NULL)
3258             {
3259               /* If the old fallthru is still next or if
3260                  asm goto doesn't have a fallthru (e.g. when followed by
3261                  __builtin_unreachable ()), nothing to do.  */
3262               if (! e_fall
3263                   || bb->aux == e_fall->dest
3264                   || e_fall->dest == EXIT_BLOCK_PTR)
3265                 continue;
3266
3267               /* Otherwise we'll have to use the fallthru fixup below.  */
3268             }
3269           else
3270             {
3271               /* Otherwise we have some return, switch or computed
3272                  jump.  In the 99% case, there should not have been a
3273                  fallthru edge.  */
3274               gcc_assert (returnjump_p (bb_end_insn) || !e_fall);
3275               continue;
3276             }
3277         }
3278       else
3279         {
3280           /* No fallthru implies a noreturn function with EH edges, or
3281              something similarly bizarre.  In any case, we don't need to
3282              do anything.  */
3283           if (! e_fall)
3284             continue;
3285
3286           /* If the fallthru block is still next, nothing to do.  */
3287           if (bb->aux == e_fall->dest)
3288             continue;
3289
3290           /* A fallthru to exit block.  */
3291           if (e_fall->dest == EXIT_BLOCK_PTR)
3292             continue;
3293         }
3294
3295       /* We got here if we need to add a new jump insn. 
3296          Note force_nonfallthru can delete E_FALL and thus we have to
3297          save E_FALL->src prior to the call to force_nonfallthru.  */
3298       src_bb = e_fall->src;
3299       nb = force_nonfallthru_and_redirect (e_fall, e_fall->dest, ret_label);
3300       if (nb)
3301         {
3302           nb->aux = bb->aux;
3303           bb->aux = nb;
3304           /* Don't process this new block.  */
3305           bb = nb;
3306
3307           /* Make sure new bb is tagged for correct section (same as
3308              fall-thru source, since you cannot fall-thru across
3309              section boundaries).  */
3310           BB_COPY_PARTITION (src_bb, single_pred (bb));
3311           if (flag_reorder_blocks_and_partition
3312               && targetm_common.have_named_sections
3313               && JUMP_P (BB_END (bb))
3314               && !any_condjump_p (BB_END (bb))
3315               && (EDGE_SUCC (bb, 0)->flags & EDGE_CROSSING))
3316             add_reg_note (BB_END (bb), REG_CROSSING_JUMP, NULL_RTX);
3317         }
3318     }
3319
3320   relink_block_chain (/*stay_in_cfglayout_mode=*/false);
3321
3322   /* Annoying special case - jump around dead jumptables left in the code.  */
3323   FOR_EACH_BB (bb)
3324     {
3325       edge e = find_fallthru_edge (bb->succs);
3326
3327       if (e && !can_fallthru (e->src, e->dest))
3328         force_nonfallthru (e);
3329     }
3330
3331   /* Ensure goto_locus from edges has some instructions with that locus
3332      in RTL.  */
3333   if (!optimize)
3334     FOR_EACH_BB (bb)
3335       {
3336         edge e;
3337         edge_iterator ei;
3338
3339         FOR_EACH_EDGE (e, ei, bb->succs)
3340           if (e->goto_locus && !(e->flags & EDGE_ABNORMAL))
3341             {
3342               edge e2;
3343               edge_iterator ei2;
3344               basic_block dest, nb;
3345               rtx end;
3346
3347               insn = BB_END (e->src);
3348               end = PREV_INSN (BB_HEAD (e->src));
3349               while (insn != end
3350                      && (!NONDEBUG_INSN_P (insn) || INSN_LOCATOR (insn) == 0))
3351                 insn = PREV_INSN (insn);
3352               if (insn != end
3353                   && locator_eq (INSN_LOCATOR (insn), (int) e->goto_locus))
3354                 continue;
3355               if (simplejump_p (BB_END (e->src))
3356                   && INSN_LOCATOR (BB_END (e->src)) == 0)
3357                 {
3358                   INSN_LOCATOR (BB_END (e->src)) = e->goto_locus;
3359                   continue;
3360                 }
3361               dest = e->dest;
3362               if (dest == EXIT_BLOCK_PTR)
3363                 {
3364                   /* Non-fallthru edges to the exit block cannot be split.  */
3365                   if (!(e->flags & EDGE_FALLTHRU))
3366                     continue;
3367                 }
3368               else
3369                 {
3370                   insn = BB_HEAD (dest);
3371                   end = NEXT_INSN (BB_END (dest));
3372                   while (insn != end && !NONDEBUG_INSN_P (insn))
3373                     insn = NEXT_INSN (insn);
3374                   if (insn != end && INSN_LOCATOR (insn)
3375                       && locator_eq (INSN_LOCATOR (insn), (int) e->goto_locus))
3376                     continue;
3377                 }
3378               nb = split_edge (e);
3379               if (!INSN_P (BB_END (nb)))
3380                 BB_END (nb) = emit_insn_after_noloc (gen_nop (), BB_END (nb),
3381                                                      nb);
3382               INSN_LOCATOR (BB_END (nb)) = e->goto_locus;
3383
3384               /* If there are other incoming edges to the destination block
3385                  with the same goto locus, redirect them to the new block as
3386                  well, this can prevent other such blocks from being created
3387                  in subsequent iterations of the loop.  */
3388               for (ei2 = ei_start (dest->preds); (e2 = ei_safe_edge (ei2)); )
3389                 if (e2->goto_locus
3390                     && !(e2->flags & (EDGE_ABNORMAL | EDGE_FALLTHRU))
3391                     && locator_eq (e->goto_locus, e2->goto_locus))
3392                   redirect_edge_and_branch (e2, nb);
3393                 else
3394                   ei_next (&ei2);
3395             }
3396       }
3397 }
3398 \f
3399 /* Perform sanity checks on the insn chain.
3400    1. Check that next/prev pointers are consistent in both the forward and
3401       reverse direction.
3402    2. Count insns in chain, going both directions, and check if equal.
3403    3. Check that get_last_insn () returns the actual end of chain.  */
3404
3405 DEBUG_FUNCTION void
3406 verify_insn_chain (void)
3407 {
3408   rtx x, prevx, nextx;
3409   int insn_cnt1, insn_cnt2;
3410
3411   for (prevx = NULL, insn_cnt1 = 1, x = get_insns ();
3412        x != 0;
3413        prevx = x, insn_cnt1++, x = NEXT_INSN (x))
3414     gcc_assert (PREV_INSN (x) == prevx);
3415
3416   gcc_assert (prevx == get_last_insn ());
3417
3418   for (nextx = NULL, insn_cnt2 = 1, x = get_last_insn ();
3419        x != 0;
3420        nextx = x, insn_cnt2++, x = PREV_INSN (x))
3421     gcc_assert (NEXT_INSN (x) == nextx);
3422
3423   gcc_assert (insn_cnt1 == insn_cnt2);
3424 }
3425 \f
3426 /* If we have assembler epilogues, the block falling through to exit must
3427    be the last one in the reordered chain when we reach final.  Ensure
3428    that this condition is met.  */
3429 static void
3430 fixup_fallthru_exit_predecessor (void)
3431 {
3432   edge e;
3433   basic_block bb = NULL;
3434
3435   /* This transformation is not valid before reload, because we might
3436      separate a call from the instruction that copies the return
3437      value.  */
3438   gcc_assert (reload_completed);
3439
3440   e = find_fallthru_edge (EXIT_BLOCK_PTR->preds);
3441   if (e)
3442     bb = e->src;
3443
3444   if (bb && bb->aux)
3445     {
3446       basic_block c = ENTRY_BLOCK_PTR->next_bb;
3447
3448       /* If the very first block is the one with the fall-through exit
3449          edge, we have to split that block.  */
3450       if (c == bb)
3451         {
3452           bb = split_block (bb, NULL)->dest;
3453           bb->aux = c->aux;
3454           c->aux = bb;
3455           BB_FOOTER (bb) = BB_FOOTER (c);
3456           BB_FOOTER (c) = NULL;
3457         }
3458
3459       while (c->aux != bb)
3460         c = (basic_block) c->aux;
3461
3462       c->aux = bb->aux;
3463       while (c->aux)
3464         c = (basic_block) c->aux;
3465
3466       c->aux = bb;
3467       bb->aux = NULL;
3468     }
3469 }
3470
3471 /* In case there are more than one fallthru predecessors of exit, force that
3472    there is only one.  */
3473
3474 static void
3475 force_one_exit_fallthru (void)
3476 {
3477   edge e, predecessor = NULL;
3478   bool more = false;
3479   edge_iterator ei;
3480   basic_block forwarder, bb;
3481
3482   FOR_EACH_EDGE (e, ei, EXIT_BLOCK_PTR->preds)
3483     if (e->flags & EDGE_FALLTHRU)
3484       {
3485         if (predecessor == NULL)
3486           predecessor = e;
3487         else
3488           {
3489             more = true;
3490             break;
3491           }
3492       }
3493
3494   if (!more)
3495     return;
3496
3497   /* Exit has several fallthru predecessors.  Create a forwarder block for
3498      them.  */
3499   forwarder = split_edge (predecessor);
3500   for (ei = ei_start (EXIT_BLOCK_PTR->preds); (e = ei_safe_edge (ei)); )
3501     {
3502       if (e->src == forwarder
3503           || !(e->flags & EDGE_FALLTHRU))
3504         ei_next (&ei);
3505       else
3506         redirect_edge_and_branch_force (e, forwarder);
3507     }
3508
3509   /* Fix up the chain of blocks -- make FORWARDER immediately precede the
3510      exit block.  */
3511   FOR_EACH_BB (bb)
3512     {
3513       if (bb->aux == NULL && bb != forwarder)
3514         {
3515           bb->aux = forwarder;
3516           break;
3517         }
3518     }
3519 }
3520 \f
3521 /* Return true in case it is possible to duplicate the basic block BB.  */
3522
3523 static bool
3524 cfg_layout_can_duplicate_bb_p (const_basic_block bb)
3525 {
3526   /* Do not attempt to duplicate tablejumps, as we need to unshare
3527      the dispatch table.  This is difficult to do, as the instructions
3528      computing jump destination may be hoisted outside the basic block.  */
3529   if (tablejump_p (BB_END (bb), NULL, NULL))
3530     return false;
3531
3532   /* Do not duplicate blocks containing insns that can't be copied.  */
3533   if (targetm.cannot_copy_insn_p)
3534     {
3535       rtx insn = BB_HEAD (bb);
3536       while (1)
3537         {
3538           if (INSN_P (insn) && targetm.cannot_copy_insn_p (insn))
3539             return false;
3540           if (insn == BB_END (bb))
3541             break;
3542           insn = NEXT_INSN (insn);
3543         }
3544     }
3545
3546   return true;
3547 }
3548
3549 rtx
3550 duplicate_insn_chain (rtx from, rtx to)
3551 {
3552   rtx insn, last, copy;
3553
3554   /* Avoid updating of boundaries of previous basic block.  The
3555      note will get removed from insn stream in fixup.  */
3556   last = emit_note (NOTE_INSN_DELETED);
3557
3558   /* Create copy at the end of INSN chain.  The chain will
3559      be reordered later.  */
3560   for (insn = from; insn != NEXT_INSN (to); insn = NEXT_INSN (insn))
3561     {
3562       switch (GET_CODE (insn))
3563         {
3564         case DEBUG_INSN:
3565           /* Don't duplicate label debug insns.  */
3566           if (TREE_CODE (INSN_VAR_LOCATION_DECL (insn)) == LABEL_DECL)
3567             break;
3568           /* FALLTHRU */
3569         case INSN:
3570         case CALL_INSN:
3571         case JUMP_INSN:
3572           /* Avoid copying of dispatch tables.  We never duplicate
3573              tablejumps, so this can hit only in case the table got
3574              moved far from original jump.  */
3575           if (GET_CODE (PATTERN (insn)) == ADDR_VEC
3576               || GET_CODE (PATTERN (insn)) == ADDR_DIFF_VEC)
3577             {
3578               /* Avoid copying following barrier as well if any
3579                  (and debug insns in between).  */
3580               rtx next;
3581
3582               for (next = NEXT_INSN (insn);
3583                    next != NEXT_INSN (to);
3584                    next = NEXT_INSN (next))
3585                 if (!DEBUG_INSN_P (next))
3586                   break;
3587               if (next != NEXT_INSN (to) && BARRIER_P (next))
3588                 insn = next;
3589               break;
3590             }
3591           copy = emit_copy_of_insn_after (insn, get_last_insn ());
3592           if (JUMP_P (insn) && JUMP_LABEL (insn) != NULL_RTX
3593               && ANY_RETURN_P (JUMP_LABEL (insn)))
3594             JUMP_LABEL (copy) = JUMP_LABEL (insn);
3595           maybe_copy_prologue_epilogue_insn (insn, copy);
3596           break;
3597
3598         case CODE_LABEL:
3599           break;
3600
3601         case BARRIER:
3602           emit_barrier ();
3603           break;
3604
3605         case NOTE:
3606           switch (NOTE_KIND (insn))
3607             {
3608               /* In case prologue is empty and function contain label
3609                  in first BB, we may want to copy the block.  */
3610             case NOTE_INSN_PROLOGUE_END:
3611
3612             case NOTE_INSN_DELETED:
3613             case NOTE_INSN_DELETED_LABEL:
3614             case NOTE_INSN_DELETED_DEBUG_LABEL:
3615               /* No problem to strip these.  */
3616             case NOTE_INSN_FUNCTION_BEG:
3617               /* There is always just single entry to function.  */
3618             case NOTE_INSN_BASIC_BLOCK:
3619               break;
3620
3621             case NOTE_INSN_EPILOGUE_BEG:
3622             case NOTE_INSN_SWITCH_TEXT_SECTIONS:
3623               emit_note_copy (insn);
3624               break;
3625
3626             default:
3627               /* All other notes should have already been eliminated.  */
3628               gcc_unreachable ();
3629             }
3630           break;
3631         default:
3632           gcc_unreachable ();
3633         }
3634     }
3635   insn = NEXT_INSN (last);
3636   delete_insn (last);
3637   return insn;
3638 }
3639
3640 /* Create a duplicate of the basic block BB.  */
3641
3642 static basic_block
3643 cfg_layout_duplicate_bb (basic_block bb)
3644 {
3645   rtx insn;
3646   basic_block new_bb;
3647
3648   insn = duplicate_insn_chain (BB_HEAD (bb), BB_END (bb));
3649   new_bb = create_basic_block (insn,
3650                                insn ? get_last_insn () : NULL,
3651                                EXIT_BLOCK_PTR->prev_bb);
3652
3653   BB_COPY_PARTITION (new_bb, bb);
3654   if (BB_HEADER (bb))
3655     {
3656       insn = BB_HEADER (bb);
3657       while (NEXT_INSN (insn))
3658         insn = NEXT_INSN (insn);
3659       insn = duplicate_insn_chain (BB_HEADER (bb), insn);
3660       if (insn)
3661         BB_HEADER (new_bb) = unlink_insn_chain (insn, get_last_insn ());
3662     }
3663
3664   if (BB_FOOTER (bb))
3665     {
3666       insn = BB_FOOTER (bb);
3667       while (NEXT_INSN (insn))
3668         insn = NEXT_INSN (insn);
3669       insn = duplicate_insn_chain (BB_FOOTER (bb), insn);
3670       if (insn)
3671         BB_FOOTER (new_bb) = unlink_insn_chain (insn, get_last_insn ());
3672     }
3673
3674   return new_bb;
3675 }
3676
3677 \f
3678 /* Main entry point to this module - initialize the datastructures for
3679    CFG layout changes.  It keeps LOOPS up-to-date if not null.
3680
3681    FLAGS is a set of additional flags to pass to cleanup_cfg().  */
3682
3683 void
3684 cfg_layout_initialize (unsigned int flags)
3685 {
3686   rtx x;
3687   basic_block bb;
3688
3689   initialize_original_copy_tables ();
3690
3691   cfg_layout_rtl_register_cfg_hooks ();
3692
3693   record_effective_endpoints ();
3694
3695   /* Make sure that the targets of non local gotos are marked.  */
3696   for (x = nonlocal_goto_handler_labels; x; x = XEXP (x, 1))
3697     {
3698       bb = BLOCK_FOR_INSN (XEXP (x, 0));
3699       bb->flags |= BB_NON_LOCAL_GOTO_TARGET;
3700     }
3701
3702   cleanup_cfg (CLEANUP_CFGLAYOUT | flags);
3703 }
3704
3705 /* Splits superblocks.  */
3706 void
3707 break_superblocks (void)
3708 {
3709   sbitmap superblocks;
3710   bool need = false;
3711   basic_block bb;
3712
3713   superblocks = sbitmap_alloc (last_basic_block);
3714   sbitmap_zero (superblocks);
3715
3716   FOR_EACH_BB (bb)
3717     if (bb->flags & BB_SUPERBLOCK)
3718       {
3719         bb->flags &= ~BB_SUPERBLOCK;
3720         SET_BIT (superblocks, bb->index);
3721         need = true;
3722       }
3723
3724   if (need)
3725     {
3726       rebuild_jump_labels (get_insns ());
3727       find_many_sub_basic_blocks (superblocks);
3728     }
3729
3730   free (superblocks);
3731 }
3732
3733 /* Finalize the changes: reorder insn list according to the sequence specified
3734    by aux pointers, enter compensation code, rebuild scope forest.  */
3735
3736 void
3737 cfg_layout_finalize (void)
3738 {
3739 #ifdef ENABLE_CHECKING
3740   verify_flow_info ();
3741 #endif
3742   force_one_exit_fallthru ();
3743   rtl_register_cfg_hooks ();
3744   if (reload_completed
3745 #ifdef HAVE_epilogue
3746       && !HAVE_epilogue
3747 #endif
3748       )
3749     fixup_fallthru_exit_predecessor ();
3750   fixup_reorder_chain ();
3751
3752   rebuild_jump_labels (get_insns ());
3753   delete_dead_jumptables ();
3754
3755 #ifdef ENABLE_CHECKING
3756   verify_insn_chain ();
3757   verify_flow_info ();
3758 #endif
3759 }
3760
3761
3762 /* Same as split_block but update cfg_layout structures.  */
3763
3764 static basic_block
3765 cfg_layout_split_block (basic_block bb, void *insnp)
3766 {
3767   rtx insn = (rtx) insnp;
3768   basic_block new_bb = rtl_split_block (bb, insn);
3769
3770   BB_FOOTER (new_bb) = BB_FOOTER (bb);
3771   BB_FOOTER (bb) = NULL;
3772
3773   return new_bb;
3774 }
3775
3776 /* Redirect Edge to DEST.  */
3777 static edge
3778 cfg_layout_redirect_edge_and_branch (edge e, basic_block dest)
3779 {
3780   basic_block src = e->src;
3781   edge ret;
3782
3783   if (e->flags & (EDGE_ABNORMAL_CALL | EDGE_EH))
3784     return NULL;
3785
3786   if (e->dest == dest)
3787     return e;
3788
3789   if (e->src != ENTRY_BLOCK_PTR
3790       && (ret = try_redirect_by_replacing_jump (e, dest, true)))
3791     {
3792       df_set_bb_dirty (src);
3793       return ret;
3794     }
3795
3796   if (e->src == ENTRY_BLOCK_PTR
3797       && (e->flags & EDGE_FALLTHRU) && !(e->flags & EDGE_COMPLEX))
3798     {
3799       if (dump_file)
3800         fprintf (dump_file, "Redirecting entry edge from bb %i to %i\n",
3801                  e->src->index, dest->index);
3802
3803       df_set_bb_dirty (e->src);
3804       redirect_edge_succ (e, dest);
3805       return e;
3806     }
3807
3808   /* Redirect_edge_and_branch may decide to turn branch into fallthru edge
3809      in the case the basic block appears to be in sequence.  Avoid this
3810      transformation.  */
3811
3812   if (e->flags & EDGE_FALLTHRU)
3813     {
3814       /* Redirect any branch edges unified with the fallthru one.  */
3815       if (JUMP_P (BB_END (src))
3816           && label_is_jump_target_p (BB_HEAD (e->dest),
3817                                      BB_END (src)))
3818         {
3819           edge redirected;
3820
3821           if (dump_file)
3822             fprintf (dump_file, "Fallthru edge unified with branch "
3823                      "%i->%i redirected to %i\n",
3824                      e->src->index, e->dest->index, dest->index);
3825           e->flags &= ~EDGE_FALLTHRU;
3826           redirected = redirect_branch_edge (e, dest);
3827           gcc_assert (redirected);
3828           redirected->flags |= EDGE_FALLTHRU;
3829           df_set_bb_dirty (redirected->src);
3830           return redirected;
3831         }
3832       /* In case we are redirecting fallthru edge to the branch edge
3833          of conditional jump, remove it.  */
3834       if (EDGE_COUNT (src->succs) == 2)
3835         {
3836           /* Find the edge that is different from E.  */
3837           edge s = EDGE_SUCC (src, EDGE_SUCC (src, 0) == e);
3838
3839           if (s->dest == dest
3840               && any_condjump_p (BB_END (src))
3841               && onlyjump_p (BB_END (src)))
3842             delete_insn (BB_END (src));
3843         }
3844       if (dump_file)
3845         fprintf (dump_file, "Redirecting fallthru edge %i->%i to %i\n",
3846                  e->src->index, e->dest->index, dest->index);
3847       ret = redirect_edge_succ_nodup (e, dest);
3848     }
3849   else
3850     ret = redirect_branch_edge (e, dest);
3851
3852   /* We don't want simplejumps in the insn stream during cfglayout.  */
3853   gcc_assert (!simplejump_p (BB_END (src)));
3854
3855   df_set_bb_dirty (src);
3856   return ret;
3857 }
3858
3859 /* Simple wrapper as we always can redirect fallthru edges.  */
3860 static basic_block
3861 cfg_layout_redirect_edge_and_branch_force (edge e, basic_block dest)
3862 {
3863   edge redirected = cfg_layout_redirect_edge_and_branch (e, dest);
3864
3865   gcc_assert (redirected);
3866   return NULL;
3867 }
3868
3869 /* Same as delete_basic_block but update cfg_layout structures.  */
3870
3871 static void
3872 cfg_layout_delete_block (basic_block bb)
3873 {
3874   rtx insn, next, prev = PREV_INSN (BB_HEAD (bb)), *to, remaints;
3875
3876   if (BB_HEADER (bb))
3877     {
3878       next = BB_HEAD (bb);
3879       if (prev)
3880         NEXT_INSN (prev) = BB_HEADER (bb);
3881       else
3882         set_first_insn (BB_HEADER (bb));
3883       PREV_INSN (BB_HEADER (bb)) = prev;
3884       insn = BB_HEADER (bb);
3885       while (NEXT_INSN (insn))
3886         insn = NEXT_INSN (insn);
3887       NEXT_INSN (insn) = next;
3888       PREV_INSN (next) = insn;
3889     }
3890   next = NEXT_INSN (BB_END (bb));
3891   if (BB_FOOTER (bb))
3892     {
3893       insn = BB_FOOTER (bb);
3894       while (insn)
3895         {
3896           if (BARRIER_P (insn))
3897             {
3898               if (PREV_INSN (insn))
3899                 NEXT_INSN (PREV_INSN (insn)) = NEXT_INSN (insn);
3900               else
3901                 BB_FOOTER (bb) = NEXT_INSN (insn);
3902               if (NEXT_INSN (insn))
3903                 PREV_INSN (NEXT_INSN (insn)) = PREV_INSN (insn);
3904             }
3905           if (LABEL_P (insn))
3906             break;
3907           insn = NEXT_INSN (insn);
3908         }
3909       if (BB_FOOTER (bb))
3910         {
3911           insn = BB_END (bb);
3912           NEXT_INSN (insn) = BB_FOOTER (bb);
3913           PREV_INSN (BB_FOOTER (bb)) = insn;
3914           while (NEXT_INSN (insn))
3915             insn = NEXT_INSN (insn);
3916           NEXT_INSN (insn) = next;
3917           if (next)
3918             PREV_INSN (next) = insn;
3919           else
3920             set_last_insn (insn);
3921         }
3922     }
3923   if (bb->next_bb != EXIT_BLOCK_PTR)
3924     to = &BB_HEADER (bb->next_bb);
3925   else
3926     to = &cfg_layout_function_footer;
3927
3928   rtl_delete_block (bb);
3929
3930   if (prev)
3931     prev = NEXT_INSN (prev);
3932   else
3933     prev = get_insns ();
3934   if (next)
3935     next = PREV_INSN (next);
3936   else
3937     next = get_last_insn ();
3938
3939   if (next && NEXT_INSN (next) != prev)
3940     {
3941       remaints = unlink_insn_chain (prev, next);
3942       insn = remaints;
3943       while (NEXT_INSN (insn))
3944         insn = NEXT_INSN (insn);
3945       NEXT_INSN (insn) = *to;
3946       if (*to)
3947         PREV_INSN (*to) = insn;
3948       *to = remaints;
3949     }
3950 }
3951
3952 /* Return true when blocks A and B can be safely merged.  */
3953
3954 static bool
3955 cfg_layout_can_merge_blocks_p (basic_block a, basic_block b)
3956 {
3957   /* If we are partitioning hot/cold basic blocks, we don't want to
3958      mess up unconditional or indirect jumps that cross between hot
3959      and cold sections.
3960
3961      Basic block partitioning may result in some jumps that appear to
3962      be optimizable (or blocks that appear to be mergeable), but which really
3963      must be left untouched (they are required to make it safely across
3964      partition boundaries).  See  the comments at the top of
3965      bb-reorder.c:partition_hot_cold_basic_blocks for complete details.  */
3966
3967   if (BB_PARTITION (a) != BB_PARTITION (b))
3968     return false;
3969
3970   /* Protect the loop latches.  */
3971   if (current_loops && b->loop_father->latch == b)
3972     return false;
3973
3974   /* If we would end up moving B's instructions, make sure it doesn't fall
3975      through into the exit block, since we cannot recover from a fallthrough
3976      edge into the exit block occurring in the middle of a function.  */
3977   if (NEXT_INSN (BB_END (a)) != BB_HEAD (b))
3978     {
3979       edge e = find_fallthru_edge (b->succs);
3980       if (e && e->dest == EXIT_BLOCK_PTR)
3981         return false;
3982     }
3983
3984   /* There must be exactly one edge in between the blocks.  */
3985   return (single_succ_p (a)
3986           && single_succ (a) == b
3987           && single_pred_p (b) == 1
3988           && a != b
3989           /* Must be simple edge.  */
3990           && !(single_succ_edge (a)->flags & EDGE_COMPLEX)
3991           && a != ENTRY_BLOCK_PTR && b != EXIT_BLOCK_PTR
3992           /* If the jump insn has side effects, we can't kill the edge.
3993              When not optimizing, try_redirect_by_replacing_jump will
3994              not allow us to redirect an edge by replacing a table jump.  */
3995           && (!JUMP_P (BB_END (a))
3996               || ((!optimize || reload_completed)
3997                   ? simplejump_p (BB_END (a)) : onlyjump_p (BB_END (a)))));
3998 }
3999
4000 /* Merge block A and B.  The blocks must be mergeable.  */
4001
4002 static void
4003 cfg_layout_merge_blocks (basic_block a, basic_block b)
4004 {
4005   bool forwarder_p = (b->flags & BB_FORWARDER_BLOCK) != 0;
4006   rtx insn;
4007
4008   gcc_checking_assert (cfg_layout_can_merge_blocks_p (a, b));
4009
4010   if (dump_file)
4011     fprintf (dump_file, "Merging block %d into block %d...\n", b->index,
4012                          a->index);
4013
4014   /* If there was a CODE_LABEL beginning B, delete it.  */
4015   if (LABEL_P (BB_HEAD (b)))
4016     {
4017       delete_insn (BB_HEAD (b));
4018     }
4019
4020   /* We should have fallthru edge in a, or we can do dummy redirection to get
4021      it cleaned up.  */
4022   if (JUMP_P (BB_END (a)))
4023     try_redirect_by_replacing_jump (EDGE_SUCC (a, 0), b, true);
4024   gcc_assert (!JUMP_P (BB_END (a)));
4025
4026   /* When not optimizing CFG and the edge is the only place in RTL which holds
4027      some unique locus, emit a nop with that locus in between.  */
4028   if (!optimize)
4029     emit_nop_for_unique_locus_between (a, b);
4030
4031   /* Possible line number notes should appear in between.  */
4032   if (BB_HEADER (b))
4033     {
4034       rtx first = BB_END (a), last;
4035
4036       last = emit_insn_after_noloc (BB_HEADER (b), BB_END (a), a);
4037       /* The above might add a BARRIER as BB_END, but as barriers
4038          aren't valid parts of a bb, remove_insn doesn't update
4039          BB_END if it is a barrier.  So adjust BB_END here.  */
4040       while (BB_END (a) != first && BARRIER_P (BB_END (a)))
4041         BB_END (a) = PREV_INSN (BB_END (a));
4042       delete_insn_chain (NEXT_INSN (first), last, false);
4043       BB_HEADER (b) = NULL;
4044     }
4045
4046   /* In the case basic blocks are not adjacent, move them around.  */
4047   if (NEXT_INSN (BB_END (a)) != BB_HEAD (b))
4048     {
4049       insn = unlink_insn_chain (BB_HEAD (b), BB_END (b));
4050
4051       emit_insn_after_noloc (insn, BB_END (a), a);
4052     }
4053   /* Otherwise just re-associate the instructions.  */
4054   else
4055     {
4056       insn = BB_HEAD (b);
4057       BB_END (a) = BB_END (b);
4058     }
4059
4060   /* emit_insn_after_noloc doesn't call df_insn_change_bb.
4061      We need to explicitly call. */
4062   update_bb_for_insn_chain (insn, BB_END (b), a);
4063
4064   /* Skip possible DELETED_LABEL insn.  */
4065   if (!NOTE_INSN_BASIC_BLOCK_P (insn))
4066     insn = NEXT_INSN (insn);
4067   gcc_assert (NOTE_INSN_BASIC_BLOCK_P (insn));
4068   BB_HEAD (b) = NULL;
4069   delete_insn (insn);
4070
4071   df_bb_delete (b->index);
4072
4073   /* Possible tablejumps and barriers should appear after the block.  */
4074   if (BB_FOOTER (b))
4075     {
4076       if (!BB_FOOTER (a))
4077         BB_FOOTER (a) = BB_FOOTER (b);
4078       else
4079         {
4080           rtx last = BB_FOOTER (a);
4081
4082           while (NEXT_INSN (last))
4083             last = NEXT_INSN (last);
4084           NEXT_INSN (last) = BB_FOOTER (b);
4085           PREV_INSN (BB_FOOTER (b)) = last;
4086         }
4087       BB_FOOTER (b) = NULL;
4088     }
4089
4090   /* If B was a forwarder block, propagate the locus on the edge.  */
4091   if (forwarder_p && !EDGE_SUCC (b, 0)->goto_locus)
4092     EDGE_SUCC (b, 0)->goto_locus = EDGE_SUCC (a, 0)->goto_locus;
4093
4094   if (dump_file)
4095     fprintf (dump_file, "Merged blocks %d and %d.\n", a->index, b->index);
4096 }
4097
4098 /* Split edge E.  */
4099
4100 static basic_block
4101 cfg_layout_split_edge (edge e)
4102 {
4103   basic_block new_bb =
4104     create_basic_block (e->src != ENTRY_BLOCK_PTR
4105                         ? NEXT_INSN (BB_END (e->src)) : get_insns (),
4106                         NULL_RTX, e->src);
4107
4108   if (e->dest == EXIT_BLOCK_PTR)
4109     BB_COPY_PARTITION (new_bb, e->src);
4110   else
4111     BB_COPY_PARTITION (new_bb, e->dest);
4112   make_edge (new_bb, e->dest, EDGE_FALLTHRU);
4113   redirect_edge_and_branch_force (e, new_bb);
4114
4115   return new_bb;
4116 }
4117
4118 /* Do postprocessing after making a forwarder block joined by edge FALLTHRU.  */
4119
4120 static void
4121 rtl_make_forwarder_block (edge fallthru ATTRIBUTE_UNUSED)
4122 {
4123 }
4124
4125 /* Return 1 if BB ends with a call, possibly followed by some
4126    instructions that must stay with the call, 0 otherwise.  */
4127
4128 static bool
4129 rtl_block_ends_with_call_p (basic_block bb)
4130 {
4131   rtx insn = BB_END (bb);
4132
4133   while (!CALL_P (insn)
4134          && insn != BB_HEAD (bb)
4135          && (keep_with_call_p (insn)
4136              || NOTE_P (insn)
4137              || DEBUG_INSN_P (insn)))
4138     insn = PREV_INSN (insn);
4139   return (CALL_P (insn));
4140 }
4141
4142 /* Return 1 if BB ends with a conditional branch, 0 otherwise.  */
4143
4144 static bool
4145 rtl_block_ends_with_condjump_p (const_basic_block bb)
4146 {
4147   return any_condjump_p (BB_END (bb));
4148 }
4149
4150 /* Return true if we need to add fake edge to exit.
4151    Helper function for rtl_flow_call_edges_add.  */
4152
4153 static bool
4154 need_fake_edge_p (const_rtx insn)
4155 {
4156   if (!INSN_P (insn))
4157     return false;
4158
4159   if ((CALL_P (insn)
4160        && !SIBLING_CALL_P (insn)
4161        && !find_reg_note (insn, REG_NORETURN, NULL)
4162        && !(RTL_CONST_OR_PURE_CALL_P (insn))))
4163     return true;
4164
4165   return ((GET_CODE (PATTERN (insn)) == ASM_OPERANDS
4166            && MEM_VOLATILE_P (PATTERN (insn)))
4167           || (GET_CODE (PATTERN (insn)) == PARALLEL
4168               && asm_noperands (insn) != -1
4169               && MEM_VOLATILE_P (XVECEXP (PATTERN (insn), 0, 0)))
4170           || GET_CODE (PATTERN (insn)) == ASM_INPUT);
4171 }
4172
4173 /* Add fake edges to the function exit for any non constant and non noreturn
4174    calls, volatile inline assembly in the bitmap of blocks specified by
4175    BLOCKS or to the whole CFG if BLOCKS is zero.  Return the number of blocks
4176    that were split.
4177
4178    The goal is to expose cases in which entering a basic block does not imply
4179    that all subsequent instructions must be executed.  */
4180
4181 static int
4182 rtl_flow_call_edges_add (sbitmap blocks)
4183 {
4184   int i;
4185   int blocks_split = 0;
4186   int last_bb = last_basic_block;
4187   bool check_last_block = false;
4188
4189   if (n_basic_blocks == NUM_FIXED_BLOCKS)
4190     return 0;
4191
4192   if (! blocks)
4193     check_last_block = true;
4194   else
4195     check_last_block = TEST_BIT (blocks, EXIT_BLOCK_PTR->prev_bb->index);
4196
4197   /* In the last basic block, before epilogue generation, there will be
4198      a fallthru edge to EXIT.  Special care is required if the last insn
4199      of the last basic block is a call because make_edge folds duplicate
4200      edges, which would result in the fallthru edge also being marked
4201      fake, which would result in the fallthru edge being removed by
4202      remove_fake_edges, which would result in an invalid CFG.
4203
4204      Moreover, we can't elide the outgoing fake edge, since the block
4205      profiler needs to take this into account in order to solve the minimal
4206      spanning tree in the case that the call doesn't return.
4207
4208      Handle this by adding a dummy instruction in a new last basic block.  */
4209   if (check_last_block)
4210     {
4211       basic_block bb = EXIT_BLOCK_PTR->prev_bb;
4212       rtx insn = BB_END (bb);
4213
4214       /* Back up past insns that must be kept in the same block as a call.  */
4215       while (insn != BB_HEAD (bb)
4216              && keep_with_call_p (insn))
4217         insn = PREV_INSN (insn);
4218
4219       if (need_fake_edge_p (insn))
4220         {
4221           edge e;
4222
4223           e = find_edge (bb, EXIT_BLOCK_PTR);
4224           if (e)
4225             {
4226               insert_insn_on_edge (gen_use (const0_rtx), e);
4227               commit_edge_insertions ();
4228             }
4229         }
4230     }
4231
4232   /* Now add fake edges to the function exit for any non constant
4233      calls since there is no way that we can determine if they will
4234      return or not...  */
4235
4236   for (i = NUM_FIXED_BLOCKS; i < last_bb; i++)
4237     {
4238       basic_block bb = BASIC_BLOCK (i);
4239       rtx insn;
4240       rtx prev_insn;
4241
4242       if (!bb)
4243         continue;
4244
4245       if (blocks && !TEST_BIT (blocks, i))
4246         continue;
4247
4248       for (insn = BB_END (bb); ; insn = prev_insn)
4249         {
4250           prev_insn = PREV_INSN (insn);
4251           if (need_fake_edge_p (insn))
4252             {
4253               edge e;
4254               rtx split_at_insn = insn;
4255
4256               /* Don't split the block between a call and an insn that should
4257                  remain in the same block as the call.  */
4258               if (CALL_P (insn))
4259                 while (split_at_insn != BB_END (bb)
4260                        && keep_with_call_p (NEXT_INSN (split_at_insn)))
4261                   split_at_insn = NEXT_INSN (split_at_insn);
4262
4263               /* The handling above of the final block before the epilogue
4264                  should be enough to verify that there is no edge to the exit
4265                  block in CFG already.  Calling make_edge in such case would
4266                  cause us to mark that edge as fake and remove it later.  */
4267
4268 #ifdef ENABLE_CHECKING
4269               if (split_at_insn == BB_END (bb))
4270                 {
4271                   e = find_edge (bb, EXIT_BLOCK_PTR);
4272                   gcc_assert (e == NULL);
4273                 }
4274 #endif
4275
4276               /* Note that the following may create a new basic block
4277                  and renumber the existing basic blocks.  */
4278               if (split_at_insn != BB_END (bb))
4279                 {
4280                   e = split_block (bb, split_at_insn);
4281                   if (e)
4282                     blocks_split++;
4283                 }
4284
4285               make_edge (bb, EXIT_BLOCK_PTR, EDGE_FAKE);
4286             }
4287
4288           if (insn == BB_HEAD (bb))
4289             break;
4290         }
4291     }
4292
4293   if (blocks_split)
4294     verify_flow_info ();
4295
4296   return blocks_split;
4297 }
4298
4299 /* Add COMP_RTX as a condition at end of COND_BB.  FIRST_HEAD is
4300    the conditional branch target, SECOND_HEAD should be the fall-thru
4301    there is no need to handle this here the loop versioning code handles
4302    this.  the reason for SECON_HEAD is that it is needed for condition
4303    in trees, and this should be of the same type since it is a hook.  */
4304 static void
4305 rtl_lv_add_condition_to_bb (basic_block first_head ,
4306                             basic_block second_head ATTRIBUTE_UNUSED,
4307                             basic_block cond_bb, void *comp_rtx)
4308 {
4309   rtx label, seq, jump;
4310   rtx op0 = XEXP ((rtx)comp_rtx, 0);
4311   rtx op1 = XEXP ((rtx)comp_rtx, 1);
4312   enum rtx_code comp = GET_CODE ((rtx)comp_rtx);
4313   enum machine_mode mode;
4314
4315
4316   label = block_label (first_head);
4317   mode = GET_MODE (op0);
4318   if (mode == VOIDmode)
4319     mode = GET_MODE (op1);
4320
4321   start_sequence ();
4322   op0 = force_operand (op0, NULL_RTX);
4323   op1 = force_operand (op1, NULL_RTX);
4324   do_compare_rtx_and_jump (op0, op1, comp, 0,
4325                            mode, NULL_RTX, NULL_RTX, label, -1);
4326   jump = get_last_insn ();
4327   JUMP_LABEL (jump) = label;
4328   LABEL_NUSES (label)++;
4329   seq = get_insns ();
4330   end_sequence ();
4331
4332   /* Add the new cond , in the new head.  */
4333   emit_insn_after(seq, BB_END(cond_bb));
4334 }
4335
4336
4337 /* Given a block B with unconditional branch at its end, get the
4338    store the return the branch edge and the fall-thru edge in
4339    BRANCH_EDGE and FALLTHRU_EDGE respectively.  */
4340 static void
4341 rtl_extract_cond_bb_edges (basic_block b, edge *branch_edge,
4342                            edge *fallthru_edge)
4343 {
4344   edge e = EDGE_SUCC (b, 0);
4345
4346   if (e->flags & EDGE_FALLTHRU)
4347     {
4348       *fallthru_edge = e;
4349       *branch_edge = EDGE_SUCC (b, 1);
4350     }
4351   else
4352     {
4353       *branch_edge = e;
4354       *fallthru_edge = EDGE_SUCC (b, 1);
4355     }
4356 }
4357
4358 void
4359 init_rtl_bb_info (basic_block bb)
4360 {
4361   gcc_assert (!bb->il.x.rtl);
4362   bb->il.x.head_ = NULL;
4363   bb->il.x.rtl = ggc_alloc_cleared_rtl_bb_info ();
4364 }
4365
4366 /* Returns true if it is possible to remove edge E by redirecting
4367    it to the destination of the other edge from E->src.  */
4368
4369 static bool
4370 rtl_can_remove_branch_p (const_edge e)
4371 {
4372   const_basic_block src = e->src;
4373   const_basic_block target = EDGE_SUCC (src, EDGE_SUCC (src, 0) == e)->dest;
4374   const_rtx insn = BB_END (src), set;
4375
4376   /* The conditions are taken from try_redirect_by_replacing_jump.  */
4377   if (target == EXIT_BLOCK_PTR)
4378     return false;
4379
4380   if (e->flags & (EDGE_ABNORMAL_CALL | EDGE_EH))
4381     return false;
4382
4383   if (find_reg_note (insn, REG_CROSSING_JUMP, NULL_RTX)
4384       || BB_PARTITION (src) != BB_PARTITION (target))
4385     return false;
4386
4387   if (!onlyjump_p (insn)
4388       || tablejump_p (insn, NULL, NULL))
4389     return false;
4390
4391   set = single_set (insn);
4392   if (!set || side_effects_p (set))
4393     return false;
4394
4395   return true;
4396 }
4397
4398 static basic_block
4399 rtl_duplicate_bb (basic_block bb)
4400 {
4401   bb = cfg_layout_duplicate_bb (bb);
4402   bb->aux = NULL;
4403   return bb;
4404 }
4405
4406 /* Implementation of CFG manipulation for linearized RTL.  */
4407 struct cfg_hooks rtl_cfg_hooks = {
4408   "rtl",
4409   rtl_verify_flow_info,
4410   rtl_dump_bb,
4411   rtl_create_basic_block,
4412   rtl_redirect_edge_and_branch,
4413   rtl_redirect_edge_and_branch_force,
4414   rtl_can_remove_branch_p,
4415   rtl_delete_block,
4416   rtl_split_block,
4417   rtl_move_block_after,
4418   rtl_can_merge_blocks,  /* can_merge_blocks_p */
4419   rtl_merge_blocks,
4420   rtl_predict_edge,
4421   rtl_predicted_by_p,
4422   cfg_layout_can_duplicate_bb_p,
4423   rtl_duplicate_bb,
4424   rtl_split_edge,
4425   rtl_make_forwarder_block,
4426   rtl_tidy_fallthru_edge,
4427   rtl_force_nonfallthru,
4428   rtl_block_ends_with_call_p,
4429   rtl_block_ends_with_condjump_p,
4430   rtl_flow_call_edges_add,
4431   NULL, /* execute_on_growing_pred */
4432   NULL, /* execute_on_shrinking_pred */
4433   NULL, /* duplicate loop for trees */
4434   NULL, /* lv_add_condition_to_bb */
4435   NULL, /* lv_adjust_loop_header_phi*/
4436   NULL, /* extract_cond_bb_edges */
4437   NULL          /* flush_pending_stmts */
4438 };
4439
4440 /* Implementation of CFG manipulation for cfg layout RTL, where
4441    basic block connected via fallthru edges does not have to be adjacent.
4442    This representation will hopefully become the default one in future
4443    version of the compiler.  */
4444
4445 struct cfg_hooks cfg_layout_rtl_cfg_hooks = {
4446   "cfglayout mode",
4447   rtl_verify_flow_info_1,
4448   rtl_dump_bb,
4449   cfg_layout_create_basic_block,
4450   cfg_layout_redirect_edge_and_branch,
4451   cfg_layout_redirect_edge_and_branch_force,
4452   rtl_can_remove_branch_p,
4453   cfg_layout_delete_block,
4454   cfg_layout_split_block,
4455   rtl_move_block_after,
4456   cfg_layout_can_merge_blocks_p,
4457   cfg_layout_merge_blocks,
4458   rtl_predict_edge,
4459   rtl_predicted_by_p,
4460   cfg_layout_can_duplicate_bb_p,
4461   cfg_layout_duplicate_bb,
4462   cfg_layout_split_edge,
4463   rtl_make_forwarder_block,
4464   NULL, /* tidy_fallthru_edge */
4465   rtl_force_nonfallthru,
4466   rtl_block_ends_with_call_p,
4467   rtl_block_ends_with_condjump_p,
4468   rtl_flow_call_edges_add,
4469   NULL, /* execute_on_growing_pred */
4470   NULL, /* execute_on_shrinking_pred */
4471   duplicate_loop_to_header_edge, /* duplicate loop for trees */
4472   rtl_lv_add_condition_to_bb, /* lv_add_condition_to_bb */
4473   NULL, /* lv_adjust_loop_header_phi*/
4474   rtl_extract_cond_bb_edges, /* extract_cond_bb_edges */
4475   NULL          /* flush_pending_stmts */
4476 };
4477
4478 #include "gt-cfgrtl.h"