OSDN Git Service

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