OSDN Git Service

In libobjc/:
[pf3gnuchains/gcc-fork.git] / gcc / cfglayout.c
1 /* Basic block reordering routines for the GNU compiler.
2    Copyright (C) 2000, 2001, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
3    Free Software Foundation, Inc.
4
5 This file is part of GCC.
6
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 3, or (at your option) any later
10 version.
11
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
15 for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING3.  If not see
19 <http://www.gnu.org/licenses/>.  */
20
21 #include "config.h"
22 #include "system.h"
23 #include "coretypes.h"
24 #include "tm.h"
25 #include "tree.h"
26 #include "rtl.h"
27 #include "hard-reg-set.h"
28 #include "obstack.h"
29 #include "basic-block.h"
30 #include "insn-config.h"
31 #include "output.h"
32 #include "function.h"
33 #include "cfglayout.h"
34 #include "cfgloop.h"
35 #include "target.h"
36 #include "ggc.h"
37 #include "alloc-pool.h"
38 #include "flags.h"
39 #include "tree-pass.h"
40 #include "df.h"
41 #include "vecprim.h"
42 #include "emit-rtl.h"
43
44 /* Holds the interesting trailing notes for the function.  */
45 rtx cfg_layout_function_footer;
46 rtx cfg_layout_function_header;
47
48 static rtx skip_insns_after_block (basic_block);
49 static void record_effective_endpoints (void);
50 static rtx label_for_bb (basic_block);
51 static void fixup_reorder_chain (void);
52
53 static void change_scope (rtx, tree, tree);
54
55 void verify_insn_chain (void);
56 static void fixup_fallthru_exit_predecessor (void);
57 static tree insn_scope (const_rtx);
58 \f
59 rtx
60 unlink_insn_chain (rtx first, rtx last)
61 {
62   rtx prevfirst = PREV_INSN (first);
63   rtx nextlast = NEXT_INSN (last);
64
65   PREV_INSN (first) = NULL;
66   NEXT_INSN (last) = NULL;
67   if (prevfirst)
68     NEXT_INSN (prevfirst) = nextlast;
69   if (nextlast)
70     PREV_INSN (nextlast) = prevfirst;
71   else
72     set_last_insn (prevfirst);
73   if (!prevfirst)
74     set_first_insn (nextlast);
75   return first;
76 }
77 \f
78 /* Skip over inter-block insns occurring after BB which are typically
79    associated with BB (e.g., barriers). If there are any such insns,
80    we return the last one. Otherwise, we return the end of BB.  */
81
82 static rtx
83 skip_insns_after_block (basic_block bb)
84 {
85   rtx insn, last_insn, next_head, prev;
86
87   next_head = NULL_RTX;
88   if (bb->next_bb != EXIT_BLOCK_PTR)
89     next_head = BB_HEAD (bb->next_bb);
90
91   for (last_insn = insn = BB_END (bb); (insn = NEXT_INSN (insn)) != 0; )
92     {
93       if (insn == next_head)
94         break;
95
96       switch (GET_CODE (insn))
97         {
98         case BARRIER:
99           last_insn = insn;
100           continue;
101
102         case NOTE:
103           switch (NOTE_KIND (insn))
104             {
105             case NOTE_INSN_BLOCK_END:
106               gcc_unreachable ();
107               continue;
108             default:
109               continue;
110               break;
111             }
112           break;
113
114         case CODE_LABEL:
115           if (NEXT_INSN (insn)
116               && JUMP_TABLE_DATA_P (NEXT_INSN (insn)))
117             {
118               insn = NEXT_INSN (insn);
119               last_insn = insn;
120               continue;
121             }
122           break;
123
124         default:
125           break;
126         }
127
128       break;
129     }
130
131   /* It is possible to hit contradictory sequence.  For instance:
132
133      jump_insn
134      NOTE_INSN_BLOCK_BEG
135      barrier
136
137      Where barrier belongs to jump_insn, but the note does not.  This can be
138      created by removing the basic block originally following
139      NOTE_INSN_BLOCK_BEG.  In such case reorder the notes.  */
140
141   for (insn = last_insn; insn != BB_END (bb); insn = prev)
142     {
143       prev = PREV_INSN (insn);
144       if (NOTE_P (insn))
145         switch (NOTE_KIND (insn))
146           {
147           case NOTE_INSN_BLOCK_END:
148             gcc_unreachable ();
149             break;
150           case NOTE_INSN_DELETED:
151           case NOTE_INSN_DELETED_LABEL:
152             continue;
153           default:
154             reorder_insns (insn, insn, last_insn);
155           }
156     }
157
158   return last_insn;
159 }
160
161 /* Locate or create a label for a given basic block.  */
162
163 static rtx
164 label_for_bb (basic_block bb)
165 {
166   rtx label = BB_HEAD (bb);
167
168   if (!LABEL_P (label))
169     {
170       if (dump_file)
171         fprintf (dump_file, "Emitting label for block %d\n", bb->index);
172
173       label = block_label (bb);
174     }
175
176   return label;
177 }
178
179 /* Locate the effective beginning and end of the insn chain for each
180    block, as defined by skip_insns_after_block above.  */
181
182 static void
183 record_effective_endpoints (void)
184 {
185   rtx next_insn;
186   basic_block bb;
187   rtx insn;
188
189   for (insn = get_insns ();
190        insn
191        && NOTE_P (insn)
192        && NOTE_KIND (insn) != NOTE_INSN_BASIC_BLOCK;
193        insn = NEXT_INSN (insn))
194     continue;
195   /* No basic blocks at all?  */
196   gcc_assert (insn);
197
198   if (PREV_INSN (insn))
199     cfg_layout_function_header =
200             unlink_insn_chain (get_insns (), PREV_INSN (insn));
201   else
202     cfg_layout_function_header = NULL_RTX;
203
204   next_insn = get_insns ();
205   FOR_EACH_BB (bb)
206     {
207       rtx end;
208
209       if (PREV_INSN (BB_HEAD (bb)) && next_insn != BB_HEAD (bb))
210         bb->il.rtl->header = unlink_insn_chain (next_insn,
211                                               PREV_INSN (BB_HEAD (bb)));
212       end = skip_insns_after_block (bb);
213       if (NEXT_INSN (BB_END (bb)) && BB_END (bb) != end)
214         bb->il.rtl->footer = unlink_insn_chain (NEXT_INSN (BB_END (bb)), end);
215       next_insn = NEXT_INSN (BB_END (bb));
216     }
217
218   cfg_layout_function_footer = next_insn;
219   if (cfg_layout_function_footer)
220     cfg_layout_function_footer = unlink_insn_chain (cfg_layout_function_footer, get_last_insn ());
221 }
222 \f
223 /* Data structures representing mapping of INSN_LOCATOR into scope blocks, line
224    numbers and files.  In order to be GGC friendly we need to use separate
225    varrays.  This also slightly improve the memory locality in binary search.
226    The _locs array contains locators where the given property change.  The
227    block_locators_blocks contains the scope block that is used for all insn
228    locator greater than corresponding block_locators_locs value and smaller
229    than the following one.  Similarly for the other properties.  */
230 static VEC(int,heap) *block_locators_locs;
231 static GTY(()) VEC(tree,gc) *block_locators_blocks;
232 static VEC(int,heap) *locations_locators_locs;
233 DEF_VEC_O(location_t);
234 DEF_VEC_ALLOC_O(location_t,heap);
235 static VEC(location_t,heap) *locations_locators_vals;
236 int prologue_locator;
237 int epilogue_locator;
238
239 /* Hold current location information and last location information, so the
240    datastructures are built lazily only when some instructions in given
241    place are needed.  */
242 static location_t curr_location, last_location;
243 static tree curr_block, last_block;
244 static int curr_rtl_loc = -1;
245
246 /* Allocate insn locator datastructure.  */
247 void
248 insn_locators_alloc (void)
249 {
250   prologue_locator = epilogue_locator = 0;
251
252   block_locators_locs = VEC_alloc (int, heap, 32);
253   block_locators_blocks = VEC_alloc (tree, gc, 32);
254   locations_locators_locs = VEC_alloc (int, heap, 32);
255   locations_locators_vals = VEC_alloc (location_t, heap, 32);
256
257   last_location = -1;
258   curr_location = -1;
259   curr_block = NULL;
260   last_block = NULL;
261   curr_rtl_loc = 0;
262 }
263
264 /* At the end of emit stage, clear current location.  */
265 void
266 insn_locators_finalize (void)
267 {
268   if (curr_rtl_loc >= 0)
269     epilogue_locator = curr_insn_locator ();
270   curr_rtl_loc = -1;
271 }
272
273 /* Allocate insn locator datastructure.  */
274 void
275 insn_locators_free (void)
276 {
277   prologue_locator = epilogue_locator = 0;
278
279   VEC_free (int, heap, block_locators_locs);
280   VEC_free (tree,gc, block_locators_blocks);
281   VEC_free (int, heap, locations_locators_locs);
282   VEC_free (location_t, heap, locations_locators_vals);
283 }
284
285
286 /* Set current location.  */
287 void
288 set_curr_insn_source_location (location_t location)
289 {
290   /* IV opts calls into RTL expansion to compute costs of operations.  At this
291      time locators are not initialized.  */
292   if (curr_rtl_loc == -1)
293     return;
294   curr_location = location;
295 }
296
297 /* Get current location.  */
298 location_t
299 get_curr_insn_source_location (void)
300 {
301   return curr_location;
302 }
303
304 /* Set current scope block.  */
305 void
306 set_curr_insn_block (tree b)
307 {
308   /* IV opts calls into RTL expansion to compute costs of operations.  At this
309      time locators are not initialized.  */
310   if (curr_rtl_loc == -1)
311     return;
312   if (b)
313     curr_block = b;
314 }
315
316 /* Get current scope block.  */
317 tree
318 get_curr_insn_block (void)
319 {
320   return curr_block;
321 }
322
323 /* Return current insn locator.  */
324 int
325 curr_insn_locator (void)
326 {
327   if (curr_rtl_loc == -1)
328     return 0;
329   if (last_block != curr_block)
330     {
331       curr_rtl_loc++;
332       VEC_safe_push (int, heap, block_locators_locs, curr_rtl_loc);
333       VEC_safe_push (tree, gc, block_locators_blocks, curr_block);
334       last_block = curr_block;
335     }
336   if (last_location != curr_location)
337     {
338       curr_rtl_loc++;
339       VEC_safe_push (int, heap, locations_locators_locs, curr_rtl_loc);
340       VEC_safe_push (location_t, heap, locations_locators_vals, &curr_location);
341       last_location = curr_location;
342     }
343   return curr_rtl_loc;
344 }
345
346 static unsigned int
347 into_cfg_layout_mode (void)
348 {
349   cfg_layout_initialize (0);
350   return 0;
351 }
352
353 static unsigned int
354 outof_cfg_layout_mode (void)
355 {
356   basic_block bb;
357
358   FOR_EACH_BB (bb)
359     if (bb->next_bb != EXIT_BLOCK_PTR)
360       bb->aux = bb->next_bb;
361
362   cfg_layout_finalize ();
363
364   return 0;
365 }
366
367 struct rtl_opt_pass pass_into_cfg_layout_mode =
368 {
369  {
370   RTL_PASS,
371   "into_cfglayout",                     /* name */
372   NULL,                                 /* gate */
373   into_cfg_layout_mode,                 /* execute */
374   NULL,                                 /* sub */
375   NULL,                                 /* next */
376   0,                                    /* static_pass_number */
377   TV_NONE,                              /* tv_id */
378   0,                                    /* properties_required */
379   PROP_cfglayout,                       /* properties_provided */
380   0,                                    /* properties_destroyed */
381   0,                                    /* todo_flags_start */
382   TODO_dump_func,                       /* todo_flags_finish */
383  }
384 };
385
386 struct rtl_opt_pass pass_outof_cfg_layout_mode =
387 {
388  {
389   RTL_PASS,
390   "outof_cfglayout",                    /* name */
391   NULL,                                 /* gate */
392   outof_cfg_layout_mode,                /* execute */
393   NULL,                                 /* sub */
394   NULL,                                 /* next */
395   0,                                    /* static_pass_number */
396   TV_NONE,                              /* tv_id */
397   0,                                    /* properties_required */
398   0,                                    /* properties_provided */
399   PROP_cfglayout,                       /* properties_destroyed */
400   0,                                    /* todo_flags_start */
401   TODO_dump_func,                       /* todo_flags_finish */
402  }
403 };
404 \f
405 /* Return scope resulting from combination of S1 and S2.  */
406 static tree
407 choose_inner_scope (tree s1, tree s2)
408 {
409    if (!s1)
410      return s2;
411    if (!s2)
412      return s1;
413    if (BLOCK_NUMBER (s1) > BLOCK_NUMBER (s2))
414      return s1;
415    return s2;
416 }
417 \f
418 /* Emit lexical block notes needed to change scope from S1 to S2.  */
419
420 static void
421 change_scope (rtx orig_insn, tree s1, tree s2)
422 {
423   rtx insn = orig_insn;
424   tree com = NULL_TREE;
425   tree ts1 = s1, ts2 = s2;
426   tree s;
427
428   while (ts1 != ts2)
429     {
430       gcc_assert (ts1 && ts2);
431       if (BLOCK_NUMBER (ts1) > BLOCK_NUMBER (ts2))
432         ts1 = BLOCK_SUPERCONTEXT (ts1);
433       else if (BLOCK_NUMBER (ts1) < BLOCK_NUMBER (ts2))
434         ts2 = BLOCK_SUPERCONTEXT (ts2);
435       else
436         {
437           ts1 = BLOCK_SUPERCONTEXT (ts1);
438           ts2 = BLOCK_SUPERCONTEXT (ts2);
439         }
440     }
441   com = ts1;
442
443   /* Close scopes.  */
444   s = s1;
445   while (s != com)
446     {
447       rtx note = emit_note_before (NOTE_INSN_BLOCK_END, insn);
448       NOTE_BLOCK (note) = s;
449       s = BLOCK_SUPERCONTEXT (s);
450     }
451
452   /* Open scopes.  */
453   s = s2;
454   while (s != com)
455     {
456       insn = emit_note_before (NOTE_INSN_BLOCK_BEG, insn);
457       NOTE_BLOCK (insn) = s;
458       s = BLOCK_SUPERCONTEXT (s);
459     }
460 }
461
462 /* Return lexical scope block locator belongs to.  */
463 static tree
464 locator_scope (int loc)
465 {
466   int max = VEC_length (int, block_locators_locs);
467   int min = 0;
468
469   /* When block_locators_locs was initialized, the pro- and epilogue
470      insns didn't exist yet and can therefore not be found this way.
471      But we know that they belong to the outer most block of the
472      current function.
473      Without this test, the prologue would be put inside the block of
474      the first valid instruction in the function and when that first
475      insn is part of an inlined function then the low_pc of that
476      inlined function is messed up.  Likewise for the epilogue and
477      the last valid instruction.  */
478   if (loc == prologue_locator || loc == epilogue_locator)
479     return DECL_INITIAL (cfun->decl);
480
481   if (!max || !loc)
482     return NULL;
483   while (1)
484     {
485       int pos = (min + max) / 2;
486       int tmp = VEC_index (int, block_locators_locs, pos);
487
488       if (tmp <= loc && min != pos)
489         min = pos;
490       else if (tmp > loc && max != pos)
491         max = pos;
492       else
493         {
494           min = pos;
495           break;
496         }
497     }
498   return VEC_index (tree, block_locators_blocks, min);
499 }
500
501 /* Return lexical scope block insn belongs to.  */
502 static tree
503 insn_scope (const_rtx insn)
504 {
505   return locator_scope (INSN_LOCATOR (insn));
506 }
507
508 /* Return line number of the statement specified by the locator.  */
509 location_t
510 locator_location (int loc)
511 {
512   int max = VEC_length (int, locations_locators_locs);
513   int min = 0;
514
515   while (1)
516     {
517       int pos = (min + max) / 2;
518       int tmp = VEC_index (int, locations_locators_locs, pos);
519
520       if (tmp <= loc && min != pos)
521         min = pos;
522       else if (tmp > loc && max != pos)
523         max = pos;
524       else
525         {
526           min = pos;
527           break;
528         }
529     }
530   return *VEC_index (location_t, locations_locators_vals, min);
531 }
532
533 /* Return source line of the statement that produced this insn.  */
534 int
535 locator_line (int loc)
536 {
537   expanded_location xloc;
538   if (!loc)
539     return 0;
540   else
541     xloc = expand_location (locator_location (loc));
542   return xloc.line;
543 }
544
545 /* Return line number of the statement that produced this insn.  */
546 int
547 insn_line (const_rtx insn)
548 {
549   return locator_line (INSN_LOCATOR (insn));
550 }
551
552 /* Return source file of the statement specified by LOC.  */
553 const char *
554 locator_file (int loc)
555 {
556   expanded_location xloc;
557   if (!loc)
558     return 0;
559   else
560     xloc = expand_location (locator_location (loc));
561   return xloc.file;
562 }
563
564 /* Return source file of the statement that produced this insn.  */
565 const char *
566 insn_file (const_rtx insn)
567 {
568   return locator_file (INSN_LOCATOR (insn));
569 }
570
571 /* Return true if LOC1 and LOC2 locators have the same location and scope.  */
572 bool
573 locator_eq (int loc1, int loc2)
574 {
575   if (loc1 == loc2)
576     return true;
577   if (locator_location (loc1) != locator_location (loc2))
578     return false;
579   return locator_scope (loc1) == locator_scope (loc2);
580 }
581
582 /* Rebuild all the NOTE_INSN_BLOCK_BEG and NOTE_INSN_BLOCK_END notes based
583    on the scope tree and the newly reordered instructions.  */
584
585 void
586 reemit_insn_block_notes (void)
587 {
588   tree cur_block = DECL_INITIAL (cfun->decl);
589   rtx insn, note;
590
591   insn = get_insns ();
592   if (!active_insn_p (insn))
593     insn = next_active_insn (insn);
594   for (; insn; insn = next_active_insn (insn))
595     {
596       tree this_block;
597
598       /* Avoid putting scope notes between jump table and its label.  */
599       if (JUMP_TABLE_DATA_P (insn))
600         continue;
601
602       this_block = insn_scope (insn);
603       /* For sequences compute scope resulting from merging all scopes
604          of instructions nested inside.  */
605       if (GET_CODE (PATTERN (insn)) == SEQUENCE)
606         {
607           int i;
608           rtx body = PATTERN (insn);
609
610           this_block = NULL;
611           for (i = 0; i < XVECLEN (body, 0); i++)
612             this_block = choose_inner_scope (this_block,
613                                          insn_scope (XVECEXP (body, 0, i)));
614         }
615       if (! this_block)
616         continue;
617
618       if (this_block != cur_block)
619         {
620           change_scope (insn, cur_block, this_block);
621           cur_block = this_block;
622         }
623     }
624
625   /* change_scope emits before the insn, not after.  */
626   note = emit_note (NOTE_INSN_DELETED);
627   change_scope (note, cur_block, DECL_INITIAL (cfun->decl));
628   delete_insn (note);
629
630   reorder_blocks ();
631 }
632 \f
633
634 /* Link the basic blocks in the correct order, compacting the basic
635    block queue while at it.  This also clears the visited flag on
636    all basic blocks.  If STAY_IN_CFGLAYOUT_MODE is false, this function
637    also clears the basic block header and footer fields.
638
639    This function is usually called after a pass (e.g. tracer) finishes
640    some transformations while in cfglayout mode.  The required sequence
641    of the basic blocks is in a linked list along the bb->aux field.
642    This functions re-links the basic block prev_bb and next_bb pointers
643    accordingly, and it compacts and renumbers the blocks.  */
644
645 void
646 relink_block_chain (bool stay_in_cfglayout_mode)
647 {
648   basic_block bb, prev_bb;
649   int index;
650
651   /* Maybe dump the re-ordered sequence.  */
652   if (dump_file)
653     {
654       fprintf (dump_file, "Reordered sequence:\n");
655       for (bb = ENTRY_BLOCK_PTR->next_bb, index = NUM_FIXED_BLOCKS;
656            bb;
657            bb = (basic_block) bb->aux, index++)
658         {
659           fprintf (dump_file, " %i ", index);
660           if (get_bb_original (bb))
661             fprintf (dump_file, "duplicate of %i ",
662                      get_bb_original (bb)->index);
663           else if (forwarder_block_p (bb)
664                    && !LABEL_P (BB_HEAD (bb)))
665             fprintf (dump_file, "compensation ");
666           else
667             fprintf (dump_file, "bb %i ", bb->index);
668           fprintf (dump_file, " [%i]\n", bb->frequency);
669         }
670     }
671
672   /* Now reorder the blocks.  */
673   prev_bb = ENTRY_BLOCK_PTR;
674   bb = ENTRY_BLOCK_PTR->next_bb;
675   for (; bb; prev_bb = bb, bb = (basic_block) bb->aux)
676     {
677       bb->prev_bb = prev_bb;
678       prev_bb->next_bb = bb;
679     }
680   prev_bb->next_bb = EXIT_BLOCK_PTR;
681   EXIT_BLOCK_PTR->prev_bb = prev_bb;
682
683   /* Then, clean up the aux and visited fields.  */
684   FOR_ALL_BB (bb)
685     {
686       bb->aux = NULL;
687       bb->il.rtl->visited = 0;
688       if (!stay_in_cfglayout_mode)
689         bb->il.rtl->header = bb->il.rtl->footer = NULL;
690     }
691
692   /* Maybe reset the original copy tables, they are not valid anymore
693      when we renumber the basic blocks in compact_blocks.  If we are
694      are going out of cfglayout mode, don't re-allocate the tables.  */
695   free_original_copy_tables ();
696   if (stay_in_cfglayout_mode)
697     initialize_original_copy_tables ();
698
699   /* Finally, put basic_block_info in the new order.  */
700   compact_blocks ();
701 }
702 \f
703
704 /* Given a reorder chain, rearrange the code to match.  */
705
706 static void
707 fixup_reorder_chain (void)
708 {
709   basic_block bb;
710   rtx insn = NULL;
711
712   if (cfg_layout_function_header)
713     {
714       set_first_insn (cfg_layout_function_header);
715       insn = cfg_layout_function_header;
716       while (NEXT_INSN (insn))
717         insn = NEXT_INSN (insn);
718     }
719
720   /* First do the bulk reordering -- rechain the blocks without regard to
721      the needed changes to jumps and labels.  */
722
723   for (bb = ENTRY_BLOCK_PTR->next_bb; bb; bb = (basic_block) bb->aux)
724     {
725       if (bb->il.rtl->header)
726         {
727           if (insn)
728             NEXT_INSN (insn) = bb->il.rtl->header;
729           else
730             set_first_insn (bb->il.rtl->header);
731           PREV_INSN (bb->il.rtl->header) = insn;
732           insn = bb->il.rtl->header;
733           while (NEXT_INSN (insn))
734             insn = NEXT_INSN (insn);
735         }
736       if (insn)
737         NEXT_INSN (insn) = BB_HEAD (bb);
738       else
739         set_first_insn (BB_HEAD (bb));
740       PREV_INSN (BB_HEAD (bb)) = insn;
741       insn = BB_END (bb);
742       if (bb->il.rtl->footer)
743         {
744           NEXT_INSN (insn) = bb->il.rtl->footer;
745           PREV_INSN (bb->il.rtl->footer) = insn;
746           while (NEXT_INSN (insn))
747             insn = NEXT_INSN (insn);
748         }
749     }
750
751   NEXT_INSN (insn) = cfg_layout_function_footer;
752   if (cfg_layout_function_footer)
753     PREV_INSN (cfg_layout_function_footer) = insn;
754
755   while (NEXT_INSN (insn))
756     insn = NEXT_INSN (insn);
757
758   set_last_insn (insn);
759 #ifdef ENABLE_CHECKING
760   verify_insn_chain ();
761 #endif
762
763   /* Now add jumps and labels as needed to match the blocks new
764      outgoing edges.  */
765
766   for (bb = ENTRY_BLOCK_PTR->next_bb; bb ; bb = (basic_block) bb->aux)
767     {
768       edge e_fall, e_taken, e;
769       rtx bb_end_insn;
770       basic_block nb;
771       edge_iterator ei;
772
773       if (EDGE_COUNT (bb->succs) == 0)
774         continue;
775
776       /* Find the old fallthru edge, and another non-EH edge for
777          a taken jump.  */
778       e_taken = e_fall = NULL;
779
780       FOR_EACH_EDGE (e, ei, bb->succs)
781         if (e->flags & EDGE_FALLTHRU)
782           e_fall = e;
783         else if (! (e->flags & EDGE_EH))
784           e_taken = e;
785
786       bb_end_insn = BB_END (bb);
787       if (JUMP_P (bb_end_insn))
788         {
789           if (any_condjump_p (bb_end_insn))
790             {
791               /* This might happen if the conditional jump has side
792                  effects and could therefore not be optimized away.
793                  Make the basic block to end with a barrier in order
794                  to prevent rtl_verify_flow_info from complaining.  */
795               if (!e_fall)
796                 {
797                   gcc_assert (!onlyjump_p (bb_end_insn)
798                               || returnjump_p (bb_end_insn));
799                   bb->il.rtl->footer = emit_barrier_after (bb_end_insn);
800                   continue;
801                 }
802
803               /* If the old fallthru is still next, nothing to do.  */
804               if (bb->aux == e_fall->dest
805                   || e_fall->dest == EXIT_BLOCK_PTR)
806                 continue;
807
808               /* The degenerated case of conditional jump jumping to the next
809                  instruction can happen for jumps with side effects.  We need
810                  to construct a forwarder block and this will be done just
811                  fine by force_nonfallthru below.  */
812               if (!e_taken)
813                 ;
814
815               /* There is another special case: if *neither* block is next,
816                  such as happens at the very end of a function, then we'll
817                  need to add a new unconditional jump.  Choose the taken
818                  edge based on known or assumed probability.  */
819               else if (bb->aux != e_taken->dest)
820                 {
821                   rtx note = find_reg_note (bb_end_insn, REG_BR_PROB, 0);
822
823                   if (note
824                       && INTVAL (XEXP (note, 0)) < REG_BR_PROB_BASE / 2
825                       && invert_jump (bb_end_insn,
826                                       (e_fall->dest == EXIT_BLOCK_PTR
827                                        ? NULL_RTX
828                                        : label_for_bb (e_fall->dest)), 0))
829                     {
830                       e_fall->flags &= ~EDGE_FALLTHRU;
831 #ifdef ENABLE_CHECKING
832                       gcc_assert (could_fall_through
833                                   (e_taken->src, e_taken->dest));
834 #endif
835                       e_taken->flags |= EDGE_FALLTHRU;
836                       update_br_prob_note (bb);
837                       e = e_fall, e_fall = e_taken, e_taken = e;
838                     }
839                 }
840
841               /* If the "jumping" edge is a crossing edge, and the fall
842                  through edge is non-crossing, leave things as they are.  */
843               else if ((e_taken->flags & EDGE_CROSSING)
844                        && !(e_fall->flags & EDGE_CROSSING))
845                 continue;
846
847               /* Otherwise we can try to invert the jump.  This will
848                  basically never fail, however, keep up the pretense.  */
849               else if (invert_jump (bb_end_insn,
850                                     (e_fall->dest == EXIT_BLOCK_PTR
851                                      ? NULL_RTX
852                                      : label_for_bb (e_fall->dest)), 0))
853                 {
854                   e_fall->flags &= ~EDGE_FALLTHRU;
855 #ifdef ENABLE_CHECKING
856                   gcc_assert (could_fall_through
857                               (e_taken->src, e_taken->dest));
858 #endif
859                   e_taken->flags |= EDGE_FALLTHRU;
860                   update_br_prob_note (bb);
861                   continue;
862                 }
863             }
864           else if (extract_asm_operands (PATTERN (bb_end_insn)) != NULL)
865             {
866               /* If the old fallthru is still next or if
867                  asm goto doesn't have a fallthru (e.g. when followed by
868                  __builtin_unreachable ()), nothing to do.  */
869               if (! e_fall
870                   || bb->aux == e_fall->dest
871                   || e_fall->dest == EXIT_BLOCK_PTR)
872                 continue;
873
874               /* Otherwise we'll have to use the fallthru fixup below.  */
875             }
876           else
877             {
878               /* Otherwise we have some return, switch or computed
879                  jump.  In the 99% case, there should not have been a
880                  fallthru edge.  */
881               gcc_assert (returnjump_p (bb_end_insn) || !e_fall);
882               continue;
883             }
884         }
885       else
886         {
887           /* No fallthru implies a noreturn function with EH edges, or
888              something similarly bizarre.  In any case, we don't need to
889              do anything.  */
890           if (! e_fall)
891             continue;
892
893           /* If the fallthru block is still next, nothing to do.  */
894           if (bb->aux == e_fall->dest)
895             continue;
896
897           /* A fallthru to exit block.  */
898           if (e_fall->dest == EXIT_BLOCK_PTR)
899             continue;
900         }
901
902       /* We got here if we need to add a new jump insn.  */
903       nb = force_nonfallthru (e_fall);
904       if (nb)
905         {
906           nb->il.rtl->visited = 1;
907           nb->aux = bb->aux;
908           bb->aux = nb;
909           /* Don't process this new block.  */
910           bb = nb;
911
912           /* Make sure new bb is tagged for correct section (same as
913              fall-thru source, since you cannot fall-throu across
914              section boundaries).  */
915           BB_COPY_PARTITION (e_fall->src, single_pred (bb));
916           if (flag_reorder_blocks_and_partition
917               && targetm.have_named_sections
918               && JUMP_P (BB_END (bb))
919               && !any_condjump_p (BB_END (bb))
920               && (EDGE_SUCC (bb, 0)->flags & EDGE_CROSSING))
921             add_reg_note (BB_END (bb), REG_CROSSING_JUMP, NULL_RTX);
922         }
923     }
924
925   relink_block_chain (/*stay_in_cfglayout_mode=*/false);
926
927   /* Annoying special case - jump around dead jumptables left in the code.  */
928   FOR_EACH_BB (bb)
929     {
930       edge e;
931       edge_iterator ei;
932
933       FOR_EACH_EDGE (e, ei, bb->succs)
934         if (e->flags & EDGE_FALLTHRU)
935           break;
936
937       if (e && !can_fallthru (e->src, e->dest))
938         force_nonfallthru (e);
939     }
940
941   /* Ensure goto_locus from edges has some instructions with that locus
942      in RTL.  */
943   if (!optimize)
944     FOR_EACH_BB (bb)
945       {
946         edge e;
947         edge_iterator ei;
948
949         FOR_EACH_EDGE (e, ei, bb->succs)
950           if (e->goto_locus && !(e->flags & EDGE_ABNORMAL))
951             {
952               basic_block nb;
953               rtx end;
954
955               insn = BB_END (e->src);
956               end = PREV_INSN (BB_HEAD (e->src));
957               while (insn != end
958                      && (!NONDEBUG_INSN_P (insn) || INSN_LOCATOR (insn) == 0))
959                 insn = PREV_INSN (insn);
960               if (insn != end
961                   && locator_eq (INSN_LOCATOR (insn), (int) e->goto_locus))
962                 continue;
963               if (simplejump_p (BB_END (e->src))
964                   && INSN_LOCATOR (BB_END (e->src)) == 0)
965                 {
966                   INSN_LOCATOR (BB_END (e->src)) = e->goto_locus;
967                   continue;
968                 }
969               if (e->dest != EXIT_BLOCK_PTR)
970                 {
971                   insn = BB_HEAD (e->dest);
972                   end = NEXT_INSN (BB_END (e->dest));
973                   while (insn != end && !NONDEBUG_INSN_P (insn))
974                     insn = NEXT_INSN (insn);
975                   if (insn != end && INSN_LOCATOR (insn)
976                       && locator_eq (INSN_LOCATOR (insn), (int) e->goto_locus))
977                     continue;
978                 }
979               nb = split_edge (e);
980               if (!INSN_P (BB_END (nb)))
981                 BB_END (nb) = emit_insn_after_noloc (gen_nop (), BB_END (nb),
982                                                      nb);
983               INSN_LOCATOR (BB_END (nb)) = e->goto_locus;
984             }
985       }
986 }
987 \f
988 /* Perform sanity checks on the insn chain.
989    1. Check that next/prev pointers are consistent in both the forward and
990       reverse direction.
991    2. Count insns in chain, going both directions, and check if equal.
992    3. Check that get_last_insn () returns the actual end of chain.  */
993
994 DEBUG_FUNCTION void
995 verify_insn_chain (void)
996 {
997   rtx x, prevx, nextx;
998   int insn_cnt1, insn_cnt2;
999
1000   for (prevx = NULL, insn_cnt1 = 1, x = get_insns ();
1001        x != 0;
1002        prevx = x, insn_cnt1++, x = NEXT_INSN (x))
1003     gcc_assert (PREV_INSN (x) == prevx);
1004
1005   gcc_assert (prevx == get_last_insn ());
1006
1007   for (nextx = NULL, insn_cnt2 = 1, x = get_last_insn ();
1008        x != 0;
1009        nextx = x, insn_cnt2++, x = PREV_INSN (x))
1010     gcc_assert (NEXT_INSN (x) == nextx);
1011
1012   gcc_assert (insn_cnt1 == insn_cnt2);
1013 }
1014 \f
1015 /* If we have assembler epilogues, the block falling through to exit must
1016    be the last one in the reordered chain when we reach final.  Ensure
1017    that this condition is met.  */
1018 static void
1019 fixup_fallthru_exit_predecessor (void)
1020 {
1021   edge e;
1022   edge_iterator ei;
1023   basic_block bb = NULL;
1024
1025   /* This transformation is not valid before reload, because we might
1026      separate a call from the instruction that copies the return
1027      value.  */
1028   gcc_assert (reload_completed);
1029
1030   FOR_EACH_EDGE (e, ei, EXIT_BLOCK_PTR->preds)
1031     if (e->flags & EDGE_FALLTHRU)
1032       bb = e->src;
1033
1034   if (bb && bb->aux)
1035     {
1036       basic_block c = ENTRY_BLOCK_PTR->next_bb;
1037
1038       /* If the very first block is the one with the fall-through exit
1039          edge, we have to split that block.  */
1040       if (c == bb)
1041         {
1042           bb = split_block (bb, NULL)->dest;
1043           bb->aux = c->aux;
1044           c->aux = bb;
1045           bb->il.rtl->footer = c->il.rtl->footer;
1046           c->il.rtl->footer = NULL;
1047         }
1048
1049       while (c->aux != bb)
1050         c = (basic_block) c->aux;
1051
1052       c->aux = bb->aux;
1053       while (c->aux)
1054         c = (basic_block) c->aux;
1055
1056       c->aux = bb;
1057       bb->aux = NULL;
1058     }
1059 }
1060
1061 /* In case there are more than one fallthru predecessors of exit, force that
1062    there is only one.  */
1063
1064 static void
1065 force_one_exit_fallthru (void)
1066 {
1067   edge e, predecessor = NULL;
1068   bool more = false;
1069   edge_iterator ei;
1070   basic_block forwarder, bb;
1071
1072   FOR_EACH_EDGE (e, ei, EXIT_BLOCK_PTR->preds)
1073     if (e->flags & EDGE_FALLTHRU)
1074       {
1075         if (predecessor == NULL)
1076           predecessor = e;
1077         else
1078           {
1079             more = true;
1080             break;
1081           }
1082       }
1083
1084   if (!more)
1085     return;
1086
1087   /* Exit has several fallthru predecessors.  Create a forwarder block for
1088      them.  */
1089   forwarder = split_edge (predecessor);
1090   for (ei = ei_start (EXIT_BLOCK_PTR->preds); (e = ei_safe_edge (ei)); )
1091     {
1092       if (e->src == forwarder
1093           || !(e->flags & EDGE_FALLTHRU))
1094         ei_next (&ei);
1095       else
1096         redirect_edge_and_branch_force (e, forwarder);
1097     }
1098
1099   /* Fix up the chain of blocks -- make FORWARDER immediately precede the
1100      exit block.  */
1101   FOR_EACH_BB (bb)
1102     {
1103       if (bb->aux == NULL && bb != forwarder)
1104         {
1105           bb->aux = forwarder;
1106           break;
1107         }
1108     }
1109 }
1110 \f
1111 /* Return true in case it is possible to duplicate the basic block BB.  */
1112
1113 /* We do not want to declare the function in a header file, since it should
1114    only be used through the cfghooks interface, and we do not want to move
1115    it to cfgrtl.c since it would require also moving quite a lot of related
1116    code.  */
1117 extern bool cfg_layout_can_duplicate_bb_p (const_basic_block);
1118
1119 bool
1120 cfg_layout_can_duplicate_bb_p (const_basic_block bb)
1121 {
1122   /* Do not attempt to duplicate tablejumps, as we need to unshare
1123      the dispatch table.  This is difficult to do, as the instructions
1124      computing jump destination may be hoisted outside the basic block.  */
1125   if (tablejump_p (BB_END (bb), NULL, NULL))
1126     return false;
1127
1128   /* Do not duplicate blocks containing insns that can't be copied.  */
1129   if (targetm.cannot_copy_insn_p)
1130     {
1131       rtx insn = BB_HEAD (bb);
1132       while (1)
1133         {
1134           if (INSN_P (insn) && targetm.cannot_copy_insn_p (insn))
1135             return false;
1136           if (insn == BB_END (bb))
1137             break;
1138           insn = NEXT_INSN (insn);
1139         }
1140     }
1141
1142   return true;
1143 }
1144
1145 rtx
1146 duplicate_insn_chain (rtx from, rtx to)
1147 {
1148   rtx insn, last, copy;
1149
1150   /* Avoid updating of boundaries of previous basic block.  The
1151      note will get removed from insn stream in fixup.  */
1152   last = emit_note (NOTE_INSN_DELETED);
1153
1154   /* Create copy at the end of INSN chain.  The chain will
1155      be reordered later.  */
1156   for (insn = from; insn != NEXT_INSN (to); insn = NEXT_INSN (insn))
1157     {
1158       switch (GET_CODE (insn))
1159         {
1160         case DEBUG_INSN:
1161         case INSN:
1162         case CALL_INSN:
1163         case JUMP_INSN:
1164           /* Avoid copying of dispatch tables.  We never duplicate
1165              tablejumps, so this can hit only in case the table got
1166              moved far from original jump.  */
1167           if (GET_CODE (PATTERN (insn)) == ADDR_VEC
1168               || GET_CODE (PATTERN (insn)) == ADDR_DIFF_VEC)
1169             break;
1170           copy = emit_copy_of_insn_after (insn, get_last_insn ());
1171           maybe_copy_epilogue_insn (insn, copy);
1172           break;
1173
1174         case CODE_LABEL:
1175           break;
1176
1177         case BARRIER:
1178           emit_barrier ();
1179           break;
1180
1181         case NOTE:
1182           switch (NOTE_KIND (insn))
1183             {
1184               /* In case prologue is empty and function contain label
1185                  in first BB, we may want to copy the block.  */
1186             case NOTE_INSN_PROLOGUE_END:
1187
1188             case NOTE_INSN_DELETED:
1189             case NOTE_INSN_DELETED_LABEL:
1190               /* No problem to strip these.  */
1191             case NOTE_INSN_FUNCTION_BEG:
1192               /* There is always just single entry to function.  */
1193             case NOTE_INSN_BASIC_BLOCK:
1194               break;
1195
1196             case NOTE_INSN_EPILOGUE_BEG:
1197             case NOTE_INSN_SWITCH_TEXT_SECTIONS:
1198               emit_note_copy (insn);
1199               break;
1200
1201             default:
1202               /* All other notes should have already been eliminated.  */
1203               gcc_unreachable ();
1204             }
1205           break;
1206         default:
1207           gcc_unreachable ();
1208         }
1209     }
1210   insn = NEXT_INSN (last);
1211   delete_insn (last);
1212   return insn;
1213 }
1214 /* Create a duplicate of the basic block BB.  */
1215
1216 /* We do not want to declare the function in a header file, since it should
1217    only be used through the cfghooks interface, and we do not want to move
1218    it to cfgrtl.c since it would require also moving quite a lot of related
1219    code.  */
1220 extern basic_block cfg_layout_duplicate_bb (basic_block);
1221
1222 basic_block
1223 cfg_layout_duplicate_bb (basic_block bb)
1224 {
1225   rtx insn;
1226   basic_block new_bb;
1227
1228   insn = duplicate_insn_chain (BB_HEAD (bb), BB_END (bb));
1229   new_bb = create_basic_block (insn,
1230                                insn ? get_last_insn () : NULL,
1231                                EXIT_BLOCK_PTR->prev_bb);
1232
1233   BB_COPY_PARTITION (new_bb, bb);
1234   if (bb->il.rtl->header)
1235     {
1236       insn = bb->il.rtl->header;
1237       while (NEXT_INSN (insn))
1238         insn = NEXT_INSN (insn);
1239       insn = duplicate_insn_chain (bb->il.rtl->header, insn);
1240       if (insn)
1241         new_bb->il.rtl->header = unlink_insn_chain (insn, get_last_insn ());
1242     }
1243
1244   if (bb->il.rtl->footer)
1245     {
1246       insn = bb->il.rtl->footer;
1247       while (NEXT_INSN (insn))
1248         insn = NEXT_INSN (insn);
1249       insn = duplicate_insn_chain (bb->il.rtl->footer, insn);
1250       if (insn)
1251         new_bb->il.rtl->footer = unlink_insn_chain (insn, get_last_insn ());
1252     }
1253
1254   return new_bb;
1255 }
1256
1257 \f
1258 /* Main entry point to this module - initialize the datastructures for
1259    CFG layout changes.  It keeps LOOPS up-to-date if not null.
1260
1261    FLAGS is a set of additional flags to pass to cleanup_cfg().  */
1262
1263 void
1264 cfg_layout_initialize (unsigned int flags)
1265 {
1266   rtx x;
1267   basic_block bb;
1268
1269   initialize_original_copy_tables ();
1270
1271   cfg_layout_rtl_register_cfg_hooks ();
1272
1273   record_effective_endpoints ();
1274
1275   /* Make sure that the targets of non local gotos are marked.  */
1276   for (x = nonlocal_goto_handler_labels; x; x = XEXP (x, 1))
1277     {
1278       bb = BLOCK_FOR_INSN (XEXP (x, 0));
1279       bb->flags |= BB_NON_LOCAL_GOTO_TARGET;
1280     }
1281
1282   cleanup_cfg (CLEANUP_CFGLAYOUT | flags);
1283 }
1284
1285 /* Splits superblocks.  */
1286 void
1287 break_superblocks (void)
1288 {
1289   sbitmap superblocks;
1290   bool need = false;
1291   basic_block bb;
1292
1293   superblocks = sbitmap_alloc (last_basic_block);
1294   sbitmap_zero (superblocks);
1295
1296   FOR_EACH_BB (bb)
1297     if (bb->flags & BB_SUPERBLOCK)
1298       {
1299         bb->flags &= ~BB_SUPERBLOCK;
1300         SET_BIT (superblocks, bb->index);
1301         need = true;
1302       }
1303
1304   if (need)
1305     {
1306       rebuild_jump_labels (get_insns ());
1307       find_many_sub_basic_blocks (superblocks);
1308     }
1309
1310   free (superblocks);
1311 }
1312
1313 /* Finalize the changes: reorder insn list according to the sequence specified
1314    by aux pointers, enter compensation code, rebuild scope forest.  */
1315
1316 void
1317 cfg_layout_finalize (void)
1318 {
1319 #ifdef ENABLE_CHECKING
1320   verify_flow_info ();
1321 #endif
1322   force_one_exit_fallthru ();
1323   rtl_register_cfg_hooks ();
1324   if (reload_completed
1325 #ifdef HAVE_epilogue
1326       && !HAVE_epilogue
1327 #endif
1328       )
1329     fixup_fallthru_exit_predecessor ();
1330   fixup_reorder_chain ();
1331
1332   rebuild_jump_labels (get_insns ());
1333   delete_dead_jumptables ();
1334
1335 #ifdef ENABLE_CHECKING
1336   verify_insn_chain ();
1337   verify_flow_info ();
1338 #endif
1339 }
1340
1341 /* Checks whether all N blocks in BBS array can be copied.  */
1342 bool
1343 can_copy_bbs_p (basic_block *bbs, unsigned n)
1344 {
1345   unsigned i;
1346   edge e;
1347   int ret = true;
1348
1349   for (i = 0; i < n; i++)
1350     bbs[i]->flags |= BB_DUPLICATED;
1351
1352   for (i = 0; i < n; i++)
1353     {
1354       /* In case we should redirect abnormal edge during duplication, fail.  */
1355       edge_iterator ei;
1356       FOR_EACH_EDGE (e, ei, bbs[i]->succs)
1357         if ((e->flags & EDGE_ABNORMAL)
1358             && (e->dest->flags & BB_DUPLICATED))
1359           {
1360             ret = false;
1361             goto end;
1362           }
1363
1364       if (!can_duplicate_block_p (bbs[i]))
1365         {
1366           ret = false;
1367           break;
1368         }
1369     }
1370
1371 end:
1372   for (i = 0; i < n; i++)
1373     bbs[i]->flags &= ~BB_DUPLICATED;
1374
1375   return ret;
1376 }
1377
1378 /* Duplicates N basic blocks stored in array BBS.  Newly created basic blocks
1379    are placed into array NEW_BBS in the same order.  Edges from basic blocks
1380    in BBS are also duplicated and copies of those of them
1381    that lead into BBS are redirected to appropriate newly created block.  The
1382    function assigns bbs into loops (copy of basic block bb is assigned to
1383    bb->loop_father->copy loop, so this must be set up correctly in advance)
1384    and updates dominators locally (LOOPS structure that contains the information
1385    about dominators is passed to enable this).
1386
1387    BASE is the superloop to that basic block belongs; if its header or latch
1388    is copied, we do not set the new blocks as header or latch.
1389
1390    Created copies of N_EDGES edges in array EDGES are stored in array NEW_EDGES,
1391    also in the same order.
1392
1393    Newly created basic blocks are put after the basic block AFTER in the
1394    instruction stream, and the order of the blocks in BBS array is preserved.  */
1395
1396 void
1397 copy_bbs (basic_block *bbs, unsigned n, basic_block *new_bbs,
1398           edge *edges, unsigned num_edges, edge *new_edges,
1399           struct loop *base, basic_block after)
1400 {
1401   unsigned i, j;
1402   basic_block bb, new_bb, dom_bb;
1403   edge e;
1404
1405   /* Duplicate bbs, update dominators, assign bbs to loops.  */
1406   for (i = 0; i < n; i++)
1407     {
1408       /* Duplicate.  */
1409       bb = bbs[i];
1410       new_bb = new_bbs[i] = duplicate_block (bb, NULL, after);
1411       after = new_bb;
1412       bb->flags |= BB_DUPLICATED;
1413       /* Possibly set loop header.  */
1414       if (bb->loop_father->header == bb && bb->loop_father != base)
1415         new_bb->loop_father->header = new_bb;
1416       /* Or latch.  */
1417       if (bb->loop_father->latch == bb && bb->loop_father != base)
1418         new_bb->loop_father->latch = new_bb;
1419     }
1420
1421   /* Set dominators.  */
1422   for (i = 0; i < n; i++)
1423     {
1424       bb = bbs[i];
1425       new_bb = new_bbs[i];
1426
1427       dom_bb = get_immediate_dominator (CDI_DOMINATORS, bb);
1428       if (dom_bb->flags & BB_DUPLICATED)
1429         {
1430           dom_bb = get_bb_copy (dom_bb);
1431           set_immediate_dominator (CDI_DOMINATORS, new_bb, dom_bb);
1432         }
1433     }
1434
1435   /* Redirect edges.  */
1436   for (j = 0; j < num_edges; j++)
1437     new_edges[j] = NULL;
1438   for (i = 0; i < n; i++)
1439     {
1440       edge_iterator ei;
1441       new_bb = new_bbs[i];
1442       bb = bbs[i];
1443
1444       FOR_EACH_EDGE (e, ei, new_bb->succs)
1445         {
1446           for (j = 0; j < num_edges; j++)
1447             if (edges[j] && edges[j]->src == bb && edges[j]->dest == e->dest)
1448               new_edges[j] = e;
1449
1450           if (!(e->dest->flags & BB_DUPLICATED))
1451             continue;
1452           redirect_edge_and_branch_force (e, get_bb_copy (e->dest));
1453         }
1454     }
1455
1456   /* Clear information about duplicates.  */
1457   for (i = 0; i < n; i++)
1458     bbs[i]->flags &= ~BB_DUPLICATED;
1459 }
1460
1461 #include "gt-cfglayout.h"