* varasm.c (default_assemble_integer): Return false for values wider
[official-gcc.git] / gcc / bb-reorder.c
blob11db0c58bd848d0e7015c5a3ad02a8a2fa0ad532
1 /* Basic block reordering routines for the GNU compiler.
2 Copyright (C) 2000, 2002, 2003, 2004 Free Software Foundation, Inc.
4 This file is part of GCC.
6 GCC is free software; you can redistribute it and/or modify it
7 under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
9 any later version.
11 GCC is distributed in the hope that it will be useful, but WITHOUT
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
14 License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GCC; see the file COPYING. If not, write to the Free
18 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
19 02111-1307, USA. */
21 /* This (greedy) algorithm constructs traces in several rounds.
22 The construction starts from "seeds". The seed for the first round
23 is the entry point of function. When there are more than one seed
24 that one is selected first that has the lowest key in the heap
25 (see function bb_to_key). Then the algorithm repeatedly adds the most
26 probable successor to the end of a trace. Finally it connects the traces.
28 There are two parameters: Branch Threshold and Exec Threshold.
29 If the edge to a successor of the actual basic block is lower than
30 Branch Threshold or the frequency of the successor is lower than
31 Exec Threshold the successor will be the seed in one of the next rounds.
32 Each round has these parameters lower than the previous one.
33 The last round has to have these parameters set to zero
34 so that the remaining blocks are picked up.
36 The algorithm selects the most probable successor from all unvisited
37 successors and successors that have been added to this trace.
38 The other successors (that has not been "sent" to the next round) will be
39 other seeds for this round and the secondary traces will start in them.
40 If the successor has not been visited in this trace it is added to the trace
41 (however, there is some heuristic for simple branches).
42 If the successor has been visited in this trace the loop has been found.
43 If the loop has many iterations the loop is rotated so that the
44 source block of the most probable edge going out from the loop
45 is the last block of the trace.
46 If the loop has few iterations and there is no edge from the last block of
47 the loop going out from loop the loop header is duplicated.
48 Finally, the construction of the trace is terminated.
50 When connecting traces it first checks whether there is an edge from the
51 last block of one trace to the first block of another trace.
52 When there are still some unconnected traces it checks whether there exists
53 a basic block BB such that BB is a successor of the last bb of one trace
54 and BB is a predecessor of the first block of another trace. In this case,
55 BB is duplicated and the traces are connected through this duplicate.
56 The rest of traces are simply connected so there will be a jump to the
57 beginning of the rest of trace.
60 References:
62 "Software Trace Cache"
63 A. Ramirez, J. Larriba-Pey, C. Navarro, J. Torrellas and M. Valero; 1999
64 http://citeseer.nj.nec.com/15361.html
68 #include "config.h"
69 #include "system.h"
70 #include "coretypes.h"
71 #include "tm.h"
72 #include "rtl.h"
73 #include "basic-block.h"
74 #include "flags.h"
75 #include "timevar.h"
76 #include "output.h"
77 #include "cfglayout.h"
78 #include "fibheap.h"
79 #include "target.h"
80 #include "function.h"
81 #include "tm_p.h"
82 #include "obstack.h"
83 #include "expr.h"
84 #include "regs.h"
86 /* The number of rounds. In most cases there will only be 4 rounds, but
87 when partitioning hot and cold basic blocks into separate sections of
88 the .o file there will be an extra round.*/
89 #define N_ROUNDS 5
91 /* Stubs in case we don't have a return insn.
92 We have to check at runtime too, not only compiletime. */
94 #ifndef HAVE_return
95 #define HAVE_return 0
96 #define gen_return() NULL_RTX
97 #endif
100 /* Branch thresholds in thousandths (per mille) of the REG_BR_PROB_BASE. */
101 static int branch_threshold[N_ROUNDS] = {400, 200, 100, 0, 0};
103 /* Exec thresholds in thousandths (per mille) of the frequency of bb 0. */
104 static int exec_threshold[N_ROUNDS] = {500, 200, 50, 0, 0};
106 /* If edge frequency is lower than DUPLICATION_THRESHOLD per mille of entry
107 block the edge destination is not duplicated while connecting traces. */
108 #define DUPLICATION_THRESHOLD 100
110 /* Length of unconditional jump instruction. */
111 static int uncond_jump_length;
113 /* Structure to hold needed information for each basic block. */
114 typedef struct bbro_basic_block_data_def
116 /* Which trace is the bb start of (-1 means it is not a start of a trace). */
117 int start_of_trace;
119 /* Which trace is the bb end of (-1 means it is not an end of a trace). */
120 int end_of_trace;
122 /* Which heap is BB in (if any)? */
123 fibheap_t heap;
125 /* Which heap node is BB in (if any)? */
126 fibnode_t node;
127 } bbro_basic_block_data;
129 /* The current size of the following dynamic array. */
130 static int array_size;
132 /* The array which holds needed information for basic blocks. */
133 static bbro_basic_block_data *bbd;
135 /* To avoid frequent reallocation the size of arrays is greater than needed,
136 the number of elements is (not less than) 1.25 * size_wanted. */
137 #define GET_ARRAY_SIZE(X) ((((X) / 4) + 1) * 5)
139 /* Free the memory and set the pointer to NULL. */
140 #define FREE(P) (gcc_assert (P), free (P), P = 0)
142 /* Structure for holding information about a trace. */
143 struct trace
145 /* First and last basic block of the trace. */
146 basic_block first, last;
148 /* The round of the STC creation which this trace was found in. */
149 int round;
151 /* The length (i.e. the number of basic blocks) of the trace. */
152 int length;
155 /* Maximum frequency and count of one of the entry blocks. */
156 int max_entry_frequency;
157 gcov_type max_entry_count;
159 /* Local function prototypes. */
160 static void find_traces (int *, struct trace *);
161 static basic_block rotate_loop (edge, struct trace *, int);
162 static void mark_bb_visited (basic_block, int);
163 static void find_traces_1_round (int, int, gcov_type, struct trace *, int *,
164 int, fibheap_t *, int);
165 static basic_block copy_bb (basic_block, edge, basic_block, int);
166 static fibheapkey_t bb_to_key (basic_block);
167 static bool better_edge_p (basic_block, edge, int, int, int, int, edge);
168 static void connect_traces (int, struct trace *);
169 static bool copy_bb_p (basic_block, int);
170 static int get_uncond_jump_length (void);
171 static bool push_to_next_round_p (basic_block, int, int, int, gcov_type);
172 static void add_unlikely_executed_notes (void);
173 static void find_rarely_executed_basic_blocks_and_crossing_edges (edge *,
174 int *,
175 int *);
176 static void mark_bb_for_unlikely_executed_section (basic_block);
177 static void add_labels_and_missing_jumps (edge *, int);
178 static void add_reg_crossing_jump_notes (void);
179 static void fix_up_fall_thru_edges (void);
180 static void fix_edges_for_rarely_executed_code (edge *, int);
181 static void fix_crossing_conditional_branches (void);
182 static void fix_crossing_unconditional_branches (void);
184 /* Check to see if bb should be pushed into the next round of trace
185 collections or not. Reasons for pushing the block forward are 1).
186 If the block is cold, we are doing partitioning, and there will be
187 another round (cold partition blocks are not supposed to be
188 collected into traces until the very last round); or 2). There will
189 be another round, and the basic block is not "hot enough" for the
190 current round of trace collection. */
192 static bool
193 push_to_next_round_p (basic_block bb, int round, int number_of_rounds,
194 int exec_th, gcov_type count_th)
196 bool there_exists_another_round;
197 bool cold_block;
198 bool block_not_hot_enough;
199 bool next_round_is_last;
201 there_exists_another_round = round < number_of_rounds - 1;
202 next_round_is_last = round + 1 == number_of_rounds - 1;
204 cold_block = (flag_reorder_blocks_and_partition
205 && BB_PARTITION (bb) == BB_COLD_PARTITION);
207 block_not_hot_enough = (bb->frequency < exec_th
208 || bb->count < count_th
209 || probably_never_executed_bb_p (bb));
211 if (flag_reorder_blocks_and_partition
212 && next_round_is_last
213 && BB_PARTITION (bb) != BB_COLD_PARTITION)
214 return false;
215 else if (there_exists_another_round
216 && (cold_block || block_not_hot_enough))
217 return true;
218 else
219 return false;
222 /* Find the traces for Software Trace Cache. Chain each trace through
223 RBI()->next. Store the number of traces to N_TRACES and description of
224 traces to TRACES. */
226 static void
227 find_traces (int *n_traces, struct trace *traces)
229 int i;
230 int number_of_rounds;
231 edge e;
232 fibheap_t heap;
234 /* Add one extra round of trace collection when partitioning hot/cold
235 basic blocks into separate sections. The last round is for all the
236 cold blocks (and ONLY the cold blocks). */
238 number_of_rounds = N_ROUNDS - 1;
239 if (flag_reorder_blocks_and_partition)
240 number_of_rounds = N_ROUNDS;
242 /* Insert entry points of function into heap. */
243 heap = fibheap_new ();
244 max_entry_frequency = 0;
245 max_entry_count = 0;
246 for (e = ENTRY_BLOCK_PTR->succ; e; e = e->succ_next)
248 bbd[e->dest->index].heap = heap;
249 bbd[e->dest->index].node = fibheap_insert (heap, bb_to_key (e->dest),
250 e->dest);
251 if (e->dest->frequency > max_entry_frequency)
252 max_entry_frequency = e->dest->frequency;
253 if (e->dest->count > max_entry_count)
254 max_entry_count = e->dest->count;
257 /* Find the traces. */
258 for (i = 0; i < number_of_rounds; i++)
260 gcov_type count_threshold;
262 if (dump_file)
263 fprintf (dump_file, "STC - round %d\n", i + 1);
265 if (max_entry_count < INT_MAX / 1000)
266 count_threshold = max_entry_count * exec_threshold[i] / 1000;
267 else
268 count_threshold = max_entry_count / 1000 * exec_threshold[i];
270 find_traces_1_round (REG_BR_PROB_BASE * branch_threshold[i] / 1000,
271 max_entry_frequency * exec_threshold[i] / 1000,
272 count_threshold, traces, n_traces, i, &heap,
273 number_of_rounds);
275 fibheap_delete (heap);
277 if (dump_file)
279 for (i = 0; i < *n_traces; i++)
281 basic_block bb;
282 fprintf (dump_file, "Trace %d (round %d): ", i + 1,
283 traces[i].round + 1);
284 for (bb = traces[i].first; bb != traces[i].last; bb = bb->rbi->next)
285 fprintf (dump_file, "%d [%d] ", bb->index, bb->frequency);
286 fprintf (dump_file, "%d [%d]\n", bb->index, bb->frequency);
288 fflush (dump_file);
292 /* Rotate loop whose back edge is BACK_EDGE in the tail of trace TRACE
293 (with sequential number TRACE_N). */
295 static basic_block
296 rotate_loop (edge back_edge, struct trace *trace, int trace_n)
298 basic_block bb;
300 /* Information about the best end (end after rotation) of the loop. */
301 basic_block best_bb = NULL;
302 edge best_edge = NULL;
303 int best_freq = -1;
304 gcov_type best_count = -1;
305 /* The best edge is preferred when its destination is not visited yet
306 or is a start block of some trace. */
307 bool is_preferred = false;
309 /* Find the most frequent edge that goes out from current trace. */
310 bb = back_edge->dest;
313 edge e;
314 for (e = bb->succ; e; e = e->succ_next)
315 if (e->dest != EXIT_BLOCK_PTR
316 && e->dest->rbi->visited != trace_n
317 && (e->flags & EDGE_CAN_FALLTHRU)
318 && !(e->flags & EDGE_COMPLEX))
320 if (is_preferred)
322 /* The best edge is preferred. */
323 if (!e->dest->rbi->visited
324 || bbd[e->dest->index].start_of_trace >= 0)
326 /* The current edge E is also preferred. */
327 int freq = EDGE_FREQUENCY (e);
328 if (freq > best_freq || e->count > best_count)
330 best_freq = freq;
331 best_count = e->count;
332 best_edge = e;
333 best_bb = bb;
337 else
339 if (!e->dest->rbi->visited
340 || bbd[e->dest->index].start_of_trace >= 0)
342 /* The current edge E is preferred. */
343 is_preferred = true;
344 best_freq = EDGE_FREQUENCY (e);
345 best_count = e->count;
346 best_edge = e;
347 best_bb = bb;
349 else
351 int freq = EDGE_FREQUENCY (e);
352 if (!best_edge || freq > best_freq || e->count > best_count)
354 best_freq = freq;
355 best_count = e->count;
356 best_edge = e;
357 best_bb = bb;
362 bb = bb->rbi->next;
364 while (bb != back_edge->dest);
366 if (best_bb)
368 /* Rotate the loop so that the BEST_EDGE goes out from the last block of
369 the trace. */
370 if (back_edge->dest == trace->first)
372 trace->first = best_bb->rbi->next;
374 else
376 basic_block prev_bb;
378 for (prev_bb = trace->first;
379 prev_bb->rbi->next != back_edge->dest;
380 prev_bb = prev_bb->rbi->next)
382 prev_bb->rbi->next = best_bb->rbi->next;
384 /* Try to get rid of uncond jump to cond jump. */
385 if (prev_bb->succ && !prev_bb->succ->succ_next)
387 basic_block header = prev_bb->succ->dest;
389 /* Duplicate HEADER if it is a small block containing cond jump
390 in the end. */
391 if (any_condjump_p (BB_END (header)) && copy_bb_p (header, 0)
392 && !find_reg_note (BB_END (header), REG_CROSSING_JUMP,
393 NULL_RTX))
395 copy_bb (header, prev_bb->succ, prev_bb, trace_n);
400 else
402 /* We have not found suitable loop tail so do no rotation. */
403 best_bb = back_edge->src;
405 best_bb->rbi->next = NULL;
406 return best_bb;
409 /* This function marks BB that it was visited in trace number TRACE. */
411 static void
412 mark_bb_visited (basic_block bb, int trace)
414 bb->rbi->visited = trace;
415 if (bbd[bb->index].heap)
417 fibheap_delete_node (bbd[bb->index].heap, bbd[bb->index].node);
418 bbd[bb->index].heap = NULL;
419 bbd[bb->index].node = NULL;
423 /* One round of finding traces. Find traces for BRANCH_TH and EXEC_TH i.e. do
424 not include basic blocks their probability is lower than BRANCH_TH or their
425 frequency is lower than EXEC_TH into traces (or count is lower than
426 COUNT_TH). It stores the new traces into TRACES and modifies the number of
427 traces *N_TRACES. Sets the round (which the trace belongs to) to ROUND. It
428 expects that starting basic blocks are in *HEAP and at the end it deletes
429 *HEAP and stores starting points for the next round into new *HEAP. */
431 static void
432 find_traces_1_round (int branch_th, int exec_th, gcov_type count_th,
433 struct trace *traces, int *n_traces, int round,
434 fibheap_t *heap, int number_of_rounds)
436 /* The following variable refers to the last round in which non-"cold"
437 blocks may be collected into a trace. */
439 int last_round = N_ROUNDS - 1;
441 /* Heap for discarded basic blocks which are possible starting points for
442 the next round. */
443 fibheap_t new_heap = fibheap_new ();
445 while (!fibheap_empty (*heap))
447 basic_block bb;
448 struct trace *trace;
449 edge best_edge, e;
450 fibheapkey_t key;
452 bb = fibheap_extract_min (*heap);
453 bbd[bb->index].heap = NULL;
454 bbd[bb->index].node = NULL;
456 if (dump_file)
457 fprintf (dump_file, "Getting bb %d\n", bb->index);
459 /* If the BB's frequency is too low send BB to the next round. When
460 partitioning hot/cold blocks into separate sections, make sure all
461 the cold blocks (and ONLY the cold blocks) go into the (extra) final
462 round. */
464 if (push_to_next_round_p (bb, round, number_of_rounds, exec_th,
465 count_th))
467 int key = bb_to_key (bb);
468 bbd[bb->index].heap = new_heap;
469 bbd[bb->index].node = fibheap_insert (new_heap, key, bb);
471 if (dump_file)
472 fprintf (dump_file,
473 " Possible start point of next round: %d (key: %d)\n",
474 bb->index, key);
475 continue;
478 trace = traces + *n_traces;
479 trace->first = bb;
480 trace->round = round;
481 trace->length = 0;
482 (*n_traces)++;
486 int prob, freq;
488 /* The probability and frequency of the best edge. */
489 int best_prob = INT_MIN / 2;
490 int best_freq = INT_MIN / 2;
492 best_edge = NULL;
493 mark_bb_visited (bb, *n_traces);
494 trace->length++;
496 if (dump_file)
497 fprintf (dump_file, "Basic block %d was visited in trace %d\n",
498 bb->index, *n_traces - 1);
500 /* Select the successor that will be placed after BB. */
501 for (e = bb->succ; e; e = e->succ_next)
503 gcc_assert (!(e->flags & EDGE_FAKE));
505 if (e->dest == EXIT_BLOCK_PTR)
506 continue;
508 if (e->dest->rbi->visited
509 && e->dest->rbi->visited != *n_traces)
510 continue;
512 if (BB_PARTITION (e->dest) == BB_COLD_PARTITION
513 && round < last_round)
514 continue;
516 prob = e->probability;
517 freq = EDGE_FREQUENCY (e);
519 /* Edge that cannot be fallthru or improbable or infrequent
520 successor (i.e. it is unsuitable successor). */
521 if (!(e->flags & EDGE_CAN_FALLTHRU) || (e->flags & EDGE_COMPLEX)
522 || prob < branch_th || freq < exec_th || e->count < count_th)
523 continue;
525 /* If partitioning hot/cold basic blocks, don't consider edges
526 that cross section boundaries. */
528 if (better_edge_p (bb, e, prob, freq, best_prob, best_freq,
529 best_edge))
531 best_edge = e;
532 best_prob = prob;
533 best_freq = freq;
537 /* If the best destination has multiple predecessors, and can be
538 duplicated cheaper than a jump, don't allow it to be added
539 to a trace. We'll duplicate it when connecting traces. */
540 if (best_edge && best_edge->dest->pred->pred_next
541 && copy_bb_p (best_edge->dest, 0))
542 best_edge = NULL;
544 /* Add all non-selected successors to the heaps. */
545 for (e = bb->succ; e; e = e->succ_next)
547 if (e == best_edge
548 || e->dest == EXIT_BLOCK_PTR
549 || e->dest->rbi->visited)
550 continue;
552 key = bb_to_key (e->dest);
554 if (bbd[e->dest->index].heap)
556 /* E->DEST is already in some heap. */
557 if (key != bbd[e->dest->index].node->key)
559 if (dump_file)
561 fprintf (dump_file,
562 "Changing key for bb %d from %ld to %ld.\n",
563 e->dest->index,
564 (long) bbd[e->dest->index].node->key,
565 key);
567 fibheap_replace_key (bbd[e->dest->index].heap,
568 bbd[e->dest->index].node, key);
571 else
573 fibheap_t which_heap = *heap;
575 prob = e->probability;
576 freq = EDGE_FREQUENCY (e);
578 if (!(e->flags & EDGE_CAN_FALLTHRU)
579 || (e->flags & EDGE_COMPLEX)
580 || prob < branch_th || freq < exec_th
581 || e->count < count_th)
583 /* When partitioning hot/cold basic blocks, make sure
584 the cold blocks (and only the cold blocks) all get
585 pushed to the last round of trace collection. */
587 if (push_to_next_round_p (e->dest, round,
588 number_of_rounds,
589 exec_th, count_th))
590 which_heap = new_heap;
593 bbd[e->dest->index].heap = which_heap;
594 bbd[e->dest->index].node = fibheap_insert (which_heap,
595 key, e->dest);
597 if (dump_file)
599 fprintf (dump_file,
600 " Possible start of %s round: %d (key: %ld)\n",
601 (which_heap == new_heap) ? "next" : "this",
602 e->dest->index, (long) key);
608 if (best_edge) /* Suitable successor was found. */
610 if (best_edge->dest->rbi->visited == *n_traces)
612 /* We do nothing with one basic block loops. */
613 if (best_edge->dest != bb)
615 if (EDGE_FREQUENCY (best_edge)
616 > 4 * best_edge->dest->frequency / 5)
618 /* The loop has at least 4 iterations. If the loop
619 header is not the first block of the function
620 we can rotate the loop. */
622 if (best_edge->dest != ENTRY_BLOCK_PTR->next_bb)
624 if (dump_file)
626 fprintf (dump_file,
627 "Rotating loop %d - %d\n",
628 best_edge->dest->index, bb->index);
630 bb->rbi->next = best_edge->dest;
631 bb = rotate_loop (best_edge, trace, *n_traces);
634 else
636 /* The loop has less than 4 iterations. */
638 /* Check whether there is another edge from BB. */
639 edge another_edge;
640 for (another_edge = bb->succ;
641 another_edge;
642 another_edge = another_edge->succ_next)
643 if (another_edge != best_edge)
644 break;
646 if (!another_edge && copy_bb_p (best_edge->dest,
647 !optimize_size))
649 bb = copy_bb (best_edge->dest, best_edge, bb,
650 *n_traces);
655 /* Terminate the trace. */
656 break;
658 else
660 /* Check for a situation
668 where
669 EDGE_FREQUENCY (AB) + EDGE_FREQUENCY (BC)
670 >= EDGE_FREQUENCY (AC).
671 (i.e. 2 * B->frequency >= EDGE_FREQUENCY (AC) )
672 Best ordering is then A B C.
674 This situation is created for example by:
676 if (A) B;
681 for (e = bb->succ; e; e = e->succ_next)
682 if (e != best_edge
683 && (e->flags & EDGE_CAN_FALLTHRU)
684 && !(e->flags & EDGE_COMPLEX)
685 && !e->dest->rbi->visited
686 && !e->dest->pred->pred_next
687 && !(e->flags & EDGE_CROSSING)
688 && e->dest->succ
689 && (e->dest->succ->flags & EDGE_CAN_FALLTHRU)
690 && !(e->dest->succ->flags & EDGE_COMPLEX)
691 && !e->dest->succ->succ_next
692 && e->dest->succ->dest == best_edge->dest
693 && 2 * e->dest->frequency >= EDGE_FREQUENCY (best_edge))
695 best_edge = e;
696 if (dump_file)
697 fprintf (dump_file, "Selecting BB %d\n",
698 best_edge->dest->index);
699 break;
702 bb->rbi->next = best_edge->dest;
703 bb = best_edge->dest;
707 while (best_edge);
708 trace->last = bb;
709 bbd[trace->first->index].start_of_trace = *n_traces - 1;
710 bbd[trace->last->index].end_of_trace = *n_traces - 1;
712 /* The trace is terminated so we have to recount the keys in heap
713 (some block can have a lower key because now one of its predecessors
714 is an end of the trace). */
715 for (e = bb->succ; e; e = e->succ_next)
717 if (e->dest == EXIT_BLOCK_PTR
718 || e->dest->rbi->visited)
719 continue;
721 if (bbd[e->dest->index].heap)
723 key = bb_to_key (e->dest);
724 if (key != bbd[e->dest->index].node->key)
726 if (dump_file)
728 fprintf (dump_file,
729 "Changing key for bb %d from %ld to %ld.\n",
730 e->dest->index,
731 (long) bbd[e->dest->index].node->key, key);
733 fibheap_replace_key (bbd[e->dest->index].heap,
734 bbd[e->dest->index].node,
735 key);
741 fibheap_delete (*heap);
743 /* "Return" the new heap. */
744 *heap = new_heap;
747 /* Create a duplicate of the basic block OLD_BB and redirect edge E to it, add
748 it to trace after BB, mark OLD_BB visited and update pass' data structures
749 (TRACE is a number of trace which OLD_BB is duplicated to). */
751 static basic_block
752 copy_bb (basic_block old_bb, edge e, basic_block bb, int trace)
754 basic_block new_bb;
756 new_bb = duplicate_block (old_bb, e);
757 BB_COPY_PARTITION (new_bb, old_bb);
759 gcc_assert (e->dest == new_bb);
760 gcc_assert (!e->dest->rbi->visited);
762 if (dump_file)
763 fprintf (dump_file,
764 "Duplicated bb %d (created bb %d)\n",
765 old_bb->index, new_bb->index);
766 new_bb->rbi->visited = trace;
767 new_bb->rbi->next = bb->rbi->next;
768 bb->rbi->next = new_bb;
770 if (new_bb->index >= array_size || last_basic_block > array_size)
772 int i;
773 int new_size;
775 new_size = MAX (last_basic_block, new_bb->index + 1);
776 new_size = GET_ARRAY_SIZE (new_size);
777 bbd = xrealloc (bbd, new_size * sizeof (bbro_basic_block_data));
778 for (i = array_size; i < new_size; i++)
780 bbd[i].start_of_trace = -1;
781 bbd[i].end_of_trace = -1;
782 bbd[i].heap = NULL;
783 bbd[i].node = NULL;
785 array_size = new_size;
787 if (dump_file)
789 fprintf (dump_file,
790 "Growing the dynamic array to %d elements.\n",
791 array_size);
795 return new_bb;
798 /* Compute and return the key (for the heap) of the basic block BB. */
800 static fibheapkey_t
801 bb_to_key (basic_block bb)
803 edge e;
805 int priority = 0;
807 /* Do not start in probably never executed blocks. */
809 if (BB_PARTITION (bb) == BB_COLD_PARTITION
810 || probably_never_executed_bb_p (bb))
811 return BB_FREQ_MAX;
813 /* Prefer blocks whose predecessor is an end of some trace
814 or whose predecessor edge is EDGE_DFS_BACK. */
815 for (e = bb->pred; e; e = e->pred_next)
817 if ((e->src != ENTRY_BLOCK_PTR && bbd[e->src->index].end_of_trace >= 0)
818 || (e->flags & EDGE_DFS_BACK))
820 int edge_freq = EDGE_FREQUENCY (e);
822 if (edge_freq > priority)
823 priority = edge_freq;
827 if (priority)
828 /* The block with priority should have significantly lower key. */
829 return -(100 * BB_FREQ_MAX + 100 * priority + bb->frequency);
830 return -bb->frequency;
833 /* Return true when the edge E from basic block BB is better than the temporary
834 best edge (details are in function). The probability of edge E is PROB. The
835 frequency of the successor is FREQ. The current best probability is
836 BEST_PROB, the best frequency is BEST_FREQ.
837 The edge is considered to be equivalent when PROB does not differ much from
838 BEST_PROB; similarly for frequency. */
840 static bool
841 better_edge_p (basic_block bb, edge e, int prob, int freq, int best_prob,
842 int best_freq, edge cur_best_edge)
844 bool is_better_edge;
846 /* The BEST_* values do not have to be best, but can be a bit smaller than
847 maximum values. */
848 int diff_prob = best_prob / 10;
849 int diff_freq = best_freq / 10;
851 if (prob > best_prob + diff_prob)
852 /* The edge has higher probability than the temporary best edge. */
853 is_better_edge = true;
854 else if (prob < best_prob - diff_prob)
855 /* The edge has lower probability than the temporary best edge. */
856 is_better_edge = false;
857 else if (freq < best_freq - diff_freq)
858 /* The edge and the temporary best edge have almost equivalent
859 probabilities. The higher frequency of a successor now means
860 that there is another edge going into that successor.
861 This successor has lower frequency so it is better. */
862 is_better_edge = true;
863 else if (freq > best_freq + diff_freq)
864 /* This successor has higher frequency so it is worse. */
865 is_better_edge = false;
866 else if (e->dest->prev_bb == bb)
867 /* The edges have equivalent probabilities and the successors
868 have equivalent frequencies. Select the previous successor. */
869 is_better_edge = true;
870 else
871 is_better_edge = false;
873 /* If we are doing hot/cold partitioning, make sure that we always favor
874 non-crossing edges over crossing edges. */
876 if (!is_better_edge
877 && flag_reorder_blocks_and_partition
878 && cur_best_edge
879 && (cur_best_edge->flags & EDGE_CROSSING)
880 && !(e->flags & EDGE_CROSSING))
881 is_better_edge = true;
883 return is_better_edge;
886 /* Connect traces in array TRACES, N_TRACES is the count of traces. */
888 static void
889 connect_traces (int n_traces, struct trace *traces)
891 int i;
892 int unconnected_hot_trace_count = 0;
893 bool cold_connected = true;
894 bool *connected;
895 bool *cold_traces;
896 int last_trace;
897 int freq_threshold;
898 gcov_type count_threshold;
900 freq_threshold = max_entry_frequency * DUPLICATION_THRESHOLD / 1000;
901 if (max_entry_count < INT_MAX / 1000)
902 count_threshold = max_entry_count * DUPLICATION_THRESHOLD / 1000;
903 else
904 count_threshold = max_entry_count / 1000 * DUPLICATION_THRESHOLD;
906 connected = xcalloc (n_traces, sizeof (bool));
907 last_trace = -1;
909 /* If we are partitioning hot/cold basic blocks, mark the cold
910 traces as already connected, to remove them from consideration
911 for connection to the hot traces. After the hot traces have all
912 been connected (determined by "unconnected_hot_trace_count"), we
913 will go back and connect the cold traces. */
915 cold_traces = xcalloc (n_traces, sizeof (bool));
917 if (flag_reorder_blocks_and_partition)
918 for (i = 0; i < n_traces; i++)
920 if (BB_PARTITION (traces[i].first) == BB_COLD_PARTITION)
922 connected[i] = true;
923 cold_traces[i] = true;
924 cold_connected = false;
926 else
927 unconnected_hot_trace_count++;
930 for (i = 0; i < n_traces || !cold_connected ; i++)
932 int t = i;
933 int t2;
934 edge e, best;
935 int best_len;
937 /* If we are partitioning hot/cold basic blocks, check to see
938 if all the hot traces have been connected. If so, go back
939 and mark the cold traces as unconnected so we can connect
940 them up too. Re-set "i" to the first (unconnected) cold
941 trace. Use flag "cold_connected" to make sure we don't do
942 this step more than once. */
944 if (flag_reorder_blocks_and_partition
945 && (i >= n_traces || unconnected_hot_trace_count <= 0)
946 && !cold_connected)
948 int j;
949 int first_cold_trace = -1;
951 for (j = 0; j < n_traces; j++)
952 if (cold_traces[j])
954 connected[j] = false;
955 if (first_cold_trace == -1)
956 first_cold_trace = j;
958 i = t = first_cold_trace;
959 cold_connected = true;
962 if (connected[t])
963 continue;
965 connected[t] = true;
966 if (unconnected_hot_trace_count > 0)
967 unconnected_hot_trace_count--;
969 /* Find the predecessor traces. */
970 for (t2 = t; t2 > 0;)
972 best = NULL;
973 best_len = 0;
974 for (e = traces[t2].first->pred; e; e = e->pred_next)
976 int si = e->src->index;
978 if (e->src != ENTRY_BLOCK_PTR
979 && (e->flags & EDGE_CAN_FALLTHRU)
980 && !(e->flags & EDGE_COMPLEX)
981 && bbd[si].end_of_trace >= 0
982 && !connected[bbd[si].end_of_trace]
983 && (!best
984 || e->probability > best->probability
985 || (e->probability == best->probability
986 && traces[bbd[si].end_of_trace].length > best_len)))
988 best = e;
989 best_len = traces[bbd[si].end_of_trace].length;
992 if (best)
994 best->src->rbi->next = best->dest;
995 t2 = bbd[best->src->index].end_of_trace;
996 connected[t2] = true;
998 if (unconnected_hot_trace_count > 0)
999 unconnected_hot_trace_count--;
1001 if (dump_file)
1003 fprintf (dump_file, "Connection: %d %d\n",
1004 best->src->index, best->dest->index);
1007 else
1008 break;
1011 if (last_trace >= 0)
1012 traces[last_trace].last->rbi->next = traces[t2].first;
1013 last_trace = t;
1015 /* Find the successor traces. */
1016 while (1)
1018 /* Find the continuation of the chain. */
1019 best = NULL;
1020 best_len = 0;
1021 for (e = traces[t].last->succ; e; e = e->succ_next)
1023 int di = e->dest->index;
1025 if (e->dest != EXIT_BLOCK_PTR
1026 && (e->flags & EDGE_CAN_FALLTHRU)
1027 && !(e->flags & EDGE_COMPLEX)
1028 && bbd[di].start_of_trace >= 0
1029 && !connected[bbd[di].start_of_trace]
1030 && (!best
1031 || e->probability > best->probability
1032 || (e->probability == best->probability
1033 && traces[bbd[di].start_of_trace].length > best_len)))
1035 best = e;
1036 best_len = traces[bbd[di].start_of_trace].length;
1040 if (best)
1042 if (dump_file)
1044 fprintf (dump_file, "Connection: %d %d\n",
1045 best->src->index, best->dest->index);
1047 t = bbd[best->dest->index].start_of_trace;
1048 traces[last_trace].last->rbi->next = traces[t].first;
1049 connected[t] = true;
1050 if (unconnected_hot_trace_count > 0)
1051 unconnected_hot_trace_count--;
1052 last_trace = t;
1054 else
1056 /* Try to connect the traces by duplication of 1 block. */
1057 edge e2;
1058 basic_block next_bb = NULL;
1059 bool try_copy = false;
1061 for (e = traces[t].last->succ; e; e = e->succ_next)
1062 if (e->dest != EXIT_BLOCK_PTR
1063 && (e->flags & EDGE_CAN_FALLTHRU)
1064 && !(e->flags & EDGE_COMPLEX)
1065 && (!best || e->probability > best->probability))
1067 edge best2 = NULL;
1068 int best2_len = 0;
1070 /* If the destination is a start of a trace which is only
1071 one block long, then no need to search the successor
1072 blocks of the trace. Accept it. */
1073 if (bbd[e->dest->index].start_of_trace >= 0
1074 && traces[bbd[e->dest->index].start_of_trace].length
1075 == 1)
1077 best = e;
1078 try_copy = true;
1079 continue;
1082 for (e2 = e->dest->succ; e2; e2 = e2->succ_next)
1084 int di = e2->dest->index;
1086 if (e2->dest == EXIT_BLOCK_PTR
1087 || ((e2->flags & EDGE_CAN_FALLTHRU)
1088 && !(e2->flags & EDGE_COMPLEX)
1089 && bbd[di].start_of_trace >= 0
1090 && !connected[bbd[di].start_of_trace]
1091 && (EDGE_FREQUENCY (e2) >= freq_threshold)
1092 && (e2->count >= count_threshold)
1093 && (!best2
1094 || e2->probability > best2->probability
1095 || (e2->probability == best2->probability
1096 && traces[bbd[di].start_of_trace].length
1097 > best2_len))))
1099 best = e;
1100 best2 = e2;
1101 if (e2->dest != EXIT_BLOCK_PTR)
1102 best2_len = traces[bbd[di].start_of_trace].length;
1103 else
1104 best2_len = INT_MAX;
1105 next_bb = e2->dest;
1106 try_copy = true;
1111 if (flag_reorder_blocks_and_partition)
1112 try_copy = false;
1114 /* Copy tiny blocks always; copy larger blocks only when the
1115 edge is traversed frequently enough. */
1116 if (try_copy
1117 && copy_bb_p (best->dest,
1118 !optimize_size
1119 && EDGE_FREQUENCY (best) >= freq_threshold
1120 && best->count >= count_threshold))
1122 basic_block new_bb;
1124 if (dump_file)
1126 fprintf (dump_file, "Connection: %d %d ",
1127 traces[t].last->index, best->dest->index);
1128 if (!next_bb)
1129 fputc ('\n', dump_file);
1130 else if (next_bb == EXIT_BLOCK_PTR)
1131 fprintf (dump_file, "exit\n");
1132 else
1133 fprintf (dump_file, "%d\n", next_bb->index);
1136 new_bb = copy_bb (best->dest, best, traces[t].last, t);
1137 traces[t].last = new_bb;
1138 if (next_bb && next_bb != EXIT_BLOCK_PTR)
1140 t = bbd[next_bb->index].start_of_trace;
1141 traces[last_trace].last->rbi->next = traces[t].first;
1142 connected[t] = true;
1143 if (unconnected_hot_trace_count > 0)
1144 unconnected_hot_trace_count--;
1145 last_trace = t;
1147 else
1148 break; /* Stop finding the successor traces. */
1150 else
1151 break; /* Stop finding the successor traces. */
1156 if (dump_file)
1158 basic_block bb;
1160 fprintf (dump_file, "Final order:\n");
1161 for (bb = traces[0].first; bb; bb = bb->rbi->next)
1162 fprintf (dump_file, "%d ", bb->index);
1163 fprintf (dump_file, "\n");
1164 fflush (dump_file);
1167 FREE (connected);
1168 FREE (cold_traces);
1171 /* Return true when BB can and should be copied. CODE_MAY_GROW is true
1172 when code size is allowed to grow by duplication. */
1174 static bool
1175 copy_bb_p (basic_block bb, int code_may_grow)
1177 int size = 0;
1178 int max_size = uncond_jump_length;
1179 rtx insn;
1180 int n_succ;
1181 edge e;
1183 if (!bb->frequency)
1184 return false;
1185 if (!bb->pred || !bb->pred->pred_next)
1186 return false;
1187 if (!can_duplicate_block_p (bb))
1188 return false;
1190 /* Avoid duplicating blocks which have many successors (PR/13430). */
1191 n_succ = 0;
1192 for (e = bb->succ; e; e = e->succ_next)
1194 n_succ++;
1195 if (n_succ > 8)
1196 return false;
1199 if (code_may_grow && maybe_hot_bb_p (bb))
1200 max_size *= 8;
1202 for (insn = BB_HEAD (bb); insn != NEXT_INSN (BB_END (bb));
1203 insn = NEXT_INSN (insn))
1205 if (INSN_P (insn))
1206 size += get_attr_length (insn);
1209 if (size <= max_size)
1210 return true;
1212 if (dump_file)
1214 fprintf (dump_file,
1215 "Block %d can't be copied because its size = %d.\n",
1216 bb->index, size);
1219 return false;
1222 /* Return the length of unconditional jump instruction. */
1224 static int
1225 get_uncond_jump_length (void)
1227 rtx label, jump;
1228 int length;
1230 label = emit_label_before (gen_label_rtx (), get_insns ());
1231 jump = emit_jump_insn (gen_jump (label));
1233 length = get_attr_length (jump);
1235 delete_insn (jump);
1236 delete_insn (label);
1237 return length;
1240 static void
1241 add_unlikely_executed_notes (void)
1243 basic_block bb;
1245 /* Add the UNLIKELY_EXECUTED_NOTES to each cold basic block. */
1247 FOR_EACH_BB (bb)
1248 if (BB_PARTITION (bb) == BB_COLD_PARTITION)
1249 mark_bb_for_unlikely_executed_section (bb);
1252 /* Find the basic blocks that are rarely executed and need to be moved to
1253 a separate section of the .o file (to cut down on paging and improve
1254 cache locality). */
1256 static void
1257 find_rarely_executed_basic_blocks_and_crossing_edges (edge *crossing_edges,
1258 int *n_crossing_edges,
1259 int *max_idx)
1261 basic_block bb;
1262 bool has_hot_blocks = false;
1263 edge e;
1264 int i;
1266 /* Mark which partition (hot/cold) each basic block belongs in. */
1268 FOR_EACH_BB (bb)
1270 if (probably_never_executed_bb_p (bb))
1271 BB_SET_PARTITION (bb, BB_COLD_PARTITION);
1272 else
1274 BB_SET_PARTITION (bb, BB_HOT_PARTITION);
1275 has_hot_blocks = true;
1279 /* Since all "hot" basic blocks will eventually be scheduled before all
1280 cold basic blocks, make *sure* the real function entry block is in
1281 the hot partition (if there is one). */
1283 if (has_hot_blocks)
1284 for (e = ENTRY_BLOCK_PTR->succ; e; e = e->succ_next)
1285 if (e->dest->index >= 0)
1287 BB_SET_PARTITION (e->dest, BB_HOT_PARTITION);
1288 break;
1291 /* Mark every edge that crosses between sections. */
1293 i = 0;
1294 if (targetm.have_named_sections)
1296 FOR_EACH_BB (bb)
1297 for (e = bb->succ; e; e = e->succ_next)
1299 if (e->src != ENTRY_BLOCK_PTR
1300 && e->dest != EXIT_BLOCK_PTR
1301 && BB_PARTITION (e->src) != BB_PARTITION (e->dest))
1303 e->flags |= EDGE_CROSSING;
1304 if (i == *max_idx)
1306 *max_idx *= 2;
1307 crossing_edges = xrealloc (crossing_edges,
1308 (*max_idx) * sizeof (edge));
1310 crossing_edges[i++] = e;
1312 else
1313 e->flags &= ~EDGE_CROSSING;
1316 *n_crossing_edges = i;
1319 /* Add NOTE_INSN_UNLIKELY_EXECUTED_CODE to top of basic block. This note
1320 is later used to mark the basic block to be put in the
1321 unlikely-to-be-executed section of the .o file. */
1323 static void
1324 mark_bb_for_unlikely_executed_section (basic_block bb)
1326 rtx cur_insn;
1327 rtx insert_insn = NULL;
1328 rtx new_note;
1330 /* Insert new NOTE immediately after BASIC_BLOCK note. */
1332 for (cur_insn = BB_HEAD (bb); cur_insn != NEXT_INSN (BB_END (bb));
1333 cur_insn = NEXT_INSN (cur_insn))
1334 if (GET_CODE (cur_insn) == NOTE
1335 && NOTE_LINE_NUMBER (cur_insn) == NOTE_INSN_BASIC_BLOCK)
1337 insert_insn = cur_insn;
1338 break;
1341 /* If basic block does not contain a NOTE_INSN_BASIC_BLOCK, there is
1342 a major problem. */
1343 gcc_assert (insert_insn);
1345 /* Insert note and assign basic block number to it. */
1347 new_note = emit_note_after (NOTE_INSN_UNLIKELY_EXECUTED_CODE,
1348 insert_insn);
1349 NOTE_BASIC_BLOCK (new_note) = bb;
1352 /* If any destination of a crossing edge does not have a label, add label;
1353 Convert any fall-through crossing edges (for blocks that do not contain
1354 a jump) to unconditional jumps. */
1356 static void
1357 add_labels_and_missing_jumps (edge *crossing_edges, int n_crossing_edges)
1359 int i;
1360 basic_block src;
1361 basic_block dest;
1362 rtx label;
1363 rtx barrier;
1364 rtx new_jump;
1366 for (i=0; i < n_crossing_edges; i++)
1368 if (crossing_edges[i])
1370 src = crossing_edges[i]->src;
1371 dest = crossing_edges[i]->dest;
1373 /* Make sure dest has a label. */
1375 if (dest && (dest != EXIT_BLOCK_PTR))
1377 label = block_label (dest);
1379 /* Make sure source block ends with a jump. */
1381 if (src && (src != ENTRY_BLOCK_PTR))
1383 if (!JUMP_P (BB_END (src)))
1384 /* bb just falls through. */
1386 /* make sure there's only one successor */
1387 gcc_assert (src->succ && !src->succ->succ_next);
1389 /* Find label in dest block. */
1390 label = block_label (dest);
1392 new_jump = emit_jump_insn_after (gen_jump (label),
1393 BB_END (src));
1394 barrier = emit_barrier_after (new_jump);
1395 JUMP_LABEL (new_jump) = label;
1396 LABEL_NUSES (label) += 1;
1397 src->rbi->footer = unlink_insn_chain (barrier, barrier);
1398 /* Mark edge as non-fallthru. */
1399 crossing_edges[i]->flags &= ~EDGE_FALLTHRU;
1400 } /* end: 'if (GET_CODE ... ' */
1401 } /* end: 'if (src && src->index...' */
1402 } /* end: 'if (dest && dest->index...' */
1403 } /* end: 'if (crossing_edges[i]...' */
1404 } /* end for loop */
1407 /* Find any bb's where the fall-through edge is a crossing edge (note that
1408 these bb's must also contain a conditional jump; we've already
1409 dealt with fall-through edges for blocks that didn't have a
1410 conditional jump in the call to add_labels_and_missing_jumps).
1411 Convert the fall-through edge to non-crossing edge by inserting a
1412 new bb to fall-through into. The new bb will contain an
1413 unconditional jump (crossing edge) to the original fall through
1414 destination. */
1416 static void
1417 fix_up_fall_thru_edges (void)
1419 basic_block cur_bb;
1420 basic_block new_bb;
1421 edge succ1;
1422 edge succ2;
1423 edge fall_thru;
1424 edge cond_jump = NULL;
1425 edge e;
1426 bool cond_jump_crosses;
1427 int invert_worked;
1428 rtx old_jump;
1429 rtx fall_thru_label;
1430 rtx barrier;
1432 FOR_EACH_BB (cur_bb)
1434 fall_thru = NULL;
1435 succ1 = cur_bb->succ;
1436 if (succ1)
1437 succ2 = succ1->succ_next;
1438 else
1439 succ2 = NULL;
1441 /* Find the fall-through edge. */
1443 if (succ1
1444 && (succ1->flags & EDGE_FALLTHRU))
1446 fall_thru = succ1;
1447 cond_jump = succ2;
1449 else if (succ2
1450 && (succ2->flags & EDGE_FALLTHRU))
1452 fall_thru = succ2;
1453 cond_jump = succ1;
1456 if (fall_thru && (fall_thru->dest != EXIT_BLOCK_PTR))
1458 /* Check to see if the fall-thru edge is a crossing edge. */
1460 if (fall_thru->flags & EDGE_CROSSING)
1462 /* The fall_thru edge crosses; now check the cond jump edge, if
1463 it exists. */
1465 cond_jump_crosses = true;
1466 invert_worked = 0;
1467 old_jump = BB_END (cur_bb);
1469 /* Find the jump instruction, if there is one. */
1471 if (cond_jump)
1473 if (!(cond_jump->flags & EDGE_CROSSING))
1474 cond_jump_crosses = false;
1476 /* We know the fall-thru edge crosses; if the cond
1477 jump edge does NOT cross, and its destination is the
1478 next block in the bb order, invert the jump
1479 (i.e. fix it so the fall thru does not cross and
1480 the cond jump does). */
1482 if (!cond_jump_crosses
1483 && cur_bb->rbi->next == cond_jump->dest)
1485 /* Find label in fall_thru block. We've already added
1486 any missing labels, so there must be one. */
1488 fall_thru_label = block_label (fall_thru->dest);
1490 if (old_jump && fall_thru_label)
1491 invert_worked = invert_jump (old_jump,
1492 fall_thru_label,0);
1493 if (invert_worked)
1495 fall_thru->flags &= ~EDGE_FALLTHRU;
1496 cond_jump->flags |= EDGE_FALLTHRU;
1497 update_br_prob_note (cur_bb);
1498 e = fall_thru;
1499 fall_thru = cond_jump;
1500 cond_jump = e;
1501 cond_jump->flags |= EDGE_CROSSING;
1502 fall_thru->flags &= ~EDGE_CROSSING;
1507 if (cond_jump_crosses || !invert_worked)
1509 /* This is the case where both edges out of the basic
1510 block are crossing edges. Here we will fix up the
1511 fall through edge. The jump edge will be taken care
1512 of later. */
1514 new_bb = force_nonfallthru (fall_thru);
1516 if (new_bb)
1518 new_bb->rbi->next = cur_bb->rbi->next;
1519 cur_bb->rbi->next = new_bb;
1521 /* Make sure new fall-through bb is in same
1522 partition as bb it's falling through from. */
1524 BB_COPY_PARTITION (new_bb, cur_bb);
1525 new_bb->succ->flags |= EDGE_CROSSING;
1528 /* Add barrier after new jump */
1530 if (new_bb)
1532 barrier = emit_barrier_after (BB_END (new_bb));
1533 new_bb->rbi->footer = unlink_insn_chain (barrier,
1534 barrier);
1536 else
1538 barrier = emit_barrier_after (BB_END (cur_bb));
1539 cur_bb->rbi->footer = unlink_insn_chain (barrier,
1540 barrier);
1548 /* This function checks the destination blockof a "crossing jump" to
1549 see if it has any crossing predecessors that begin with a code label
1550 and end with an unconditional jump. If so, it returns that predecessor
1551 block. (This is to avoid creating lots of new basic blocks that all
1552 contain unconditional jumps to the same destination). */
1554 static basic_block
1555 find_jump_block (basic_block jump_dest)
1557 basic_block source_bb = NULL;
1558 edge e;
1559 rtx insn;
1561 for (e = jump_dest->pred; e; e = e->pred_next)
1562 if (e->flags & EDGE_CROSSING)
1564 basic_block src = e->src;
1566 /* Check each predecessor to see if it has a label, and contains
1567 only one executable instruction, which is an unconditional jump.
1568 If so, we can use it. */
1570 if (LABEL_P (BB_HEAD (src)))
1571 for (insn = BB_HEAD (src);
1572 !INSN_P (insn) && insn != NEXT_INSN (BB_END (src));
1573 insn = NEXT_INSN (insn))
1575 if (INSN_P (insn)
1576 && insn == BB_END (src)
1577 && JUMP_P (insn)
1578 && !any_condjump_p (insn))
1580 source_bb = src;
1581 break;
1585 if (source_bb)
1586 break;
1589 return source_bb;
1592 /* Find all BB's with conditional jumps that are crossing edges;
1593 insert a new bb and make the conditional jump branch to the new
1594 bb instead (make the new bb same color so conditional branch won't
1595 be a 'crossing' edge). Insert an unconditional jump from the
1596 new bb to the original destination of the conditional jump. */
1598 static void
1599 fix_crossing_conditional_branches (void)
1601 basic_block cur_bb;
1602 basic_block new_bb;
1603 basic_block last_bb;
1604 basic_block dest;
1605 basic_block prev_bb;
1606 edge succ1;
1607 edge succ2;
1608 edge crossing_edge;
1609 edge new_edge;
1610 rtx old_jump;
1611 rtx set_src;
1612 rtx old_label = NULL_RTX;
1613 rtx new_label;
1614 rtx new_jump;
1615 rtx barrier;
1617 last_bb = EXIT_BLOCK_PTR->prev_bb;
1619 FOR_EACH_BB (cur_bb)
1621 crossing_edge = NULL;
1622 succ1 = cur_bb->succ;
1623 if (succ1)
1624 succ2 = succ1->succ_next;
1625 else
1626 succ2 = NULL;
1628 /* We already took care of fall-through edges, so only one successor
1629 can be a crossing edge. */
1631 if (succ1 && (succ1->flags & EDGE_CROSSING))
1632 crossing_edge = succ1;
1633 else if (succ2 && (succ2->flags & EDGE_CROSSING))
1634 crossing_edge = succ2;
1636 if (crossing_edge)
1638 old_jump = BB_END (cur_bb);
1640 /* Check to make sure the jump instruction is a
1641 conditional jump. */
1643 set_src = NULL_RTX;
1645 if (any_condjump_p (old_jump))
1647 if (GET_CODE (PATTERN (old_jump)) == SET)
1648 set_src = SET_SRC (PATTERN (old_jump));
1649 else if (GET_CODE (PATTERN (old_jump)) == PARALLEL)
1651 set_src = XVECEXP (PATTERN (old_jump), 0,0);
1652 if (GET_CODE (set_src) == SET)
1653 set_src = SET_SRC (set_src);
1654 else
1655 set_src = NULL_RTX;
1659 if (set_src && (GET_CODE (set_src) == IF_THEN_ELSE))
1661 if (GET_CODE (XEXP (set_src, 1)) == PC)
1662 old_label = XEXP (set_src, 2);
1663 else if (GET_CODE (XEXP (set_src, 2)) == PC)
1664 old_label = XEXP (set_src, 1);
1666 /* Check to see if new bb for jumping to that dest has
1667 already been created; if so, use it; if not, create
1668 a new one. */
1670 new_bb = find_jump_block (crossing_edge->dest);
1672 if (new_bb)
1673 new_label = block_label (new_bb);
1674 else
1676 /* Create new basic block to be dest for
1677 conditional jump. */
1679 new_bb = create_basic_block (NULL, NULL, last_bb);
1680 new_bb->rbi->next = last_bb->rbi->next;
1681 last_bb->rbi->next = new_bb;
1682 prev_bb = last_bb;
1683 last_bb = new_bb;
1685 /* Update register liveness information. */
1687 new_bb->global_live_at_start =
1688 OBSTACK_ALLOC_REG_SET (&flow_obstack);
1689 new_bb->global_live_at_end =
1690 OBSTACK_ALLOC_REG_SET (&flow_obstack);
1691 COPY_REG_SET (new_bb->global_live_at_end,
1692 prev_bb->global_live_at_end);
1693 COPY_REG_SET (new_bb->global_live_at_start,
1694 prev_bb->global_live_at_end);
1696 /* Put appropriate instructions in new bb. */
1698 new_label = gen_label_rtx ();
1699 emit_label_before (new_label, BB_HEAD (new_bb));
1700 BB_HEAD (new_bb) = new_label;
1702 if (GET_CODE (old_label) == LABEL_REF)
1704 old_label = JUMP_LABEL (old_jump);
1705 new_jump = emit_jump_insn_after (gen_jump
1706 (old_label),
1707 BB_END (new_bb));
1709 else
1711 gcc_assert (HAVE_return
1712 && GET_CODE (old_label) == RETURN);
1713 new_jump = emit_jump_insn_after (gen_return (),
1714 BB_END (new_bb));
1717 barrier = emit_barrier_after (new_jump);
1718 JUMP_LABEL (new_jump) = old_label;
1719 new_bb->rbi->footer = unlink_insn_chain (barrier,
1720 barrier);
1722 /* Make sure new bb is in same partition as source
1723 of conditional branch. */
1724 BB_COPY_PARTITION (new_bb, cur_bb);
1727 /* Make old jump branch to new bb. */
1729 redirect_jump (old_jump, new_label, 0);
1731 /* Remove crossing_edge as predecessor of 'dest'. */
1733 dest = crossing_edge->dest;
1735 redirect_edge_succ (crossing_edge, new_bb);
1737 /* Make a new edge from new_bb to old dest; new edge
1738 will be a successor for new_bb and a predecessor
1739 for 'dest'. */
1741 if (!new_bb->succ)
1742 new_edge = make_edge (new_bb, dest, 0);
1743 else
1744 new_edge = new_bb->succ;
1746 crossing_edge->flags &= ~EDGE_CROSSING;
1747 new_edge->flags |= EDGE_CROSSING;
1753 /* Find any unconditional branches that cross between hot and cold
1754 sections. Convert them into indirect jumps instead. */
1756 static void
1757 fix_crossing_unconditional_branches (void)
1759 basic_block cur_bb;
1760 rtx last_insn;
1761 rtx label;
1762 rtx label_addr;
1763 rtx indirect_jump_sequence;
1764 rtx jump_insn = NULL_RTX;
1765 rtx new_reg;
1766 rtx cur_insn;
1767 edge succ;
1769 FOR_EACH_BB (cur_bb)
1771 last_insn = BB_END (cur_bb);
1772 succ = cur_bb->succ;
1774 /* Check to see if bb ends in a crossing (unconditional) jump. At
1775 this point, no crossing jumps should be conditional. */
1777 if (JUMP_P (last_insn)
1778 && (succ->flags & EDGE_CROSSING))
1780 rtx label2, table;
1782 gcc_assert (!any_condjump_p (last_insn));
1784 /* Make sure the jump is not already an indirect or table jump. */
1786 if (!computed_jump_p (last_insn)
1787 && !tablejump_p (last_insn, &label2, &table))
1789 /* We have found a "crossing" unconditional branch. Now
1790 we must convert it to an indirect jump. First create
1791 reference of label, as target for jump. */
1793 label = JUMP_LABEL (last_insn);
1794 label_addr = gen_rtx_LABEL_REF (Pmode, label);
1795 LABEL_NUSES (label) += 1;
1797 /* Get a register to use for the indirect jump. */
1799 new_reg = gen_reg_rtx (Pmode);
1801 /* Generate indirect the jump sequence. */
1803 start_sequence ();
1804 emit_move_insn (new_reg, label_addr);
1805 emit_indirect_jump (new_reg);
1806 indirect_jump_sequence = get_insns ();
1807 end_sequence ();
1809 /* Make sure every instruction in the new jump sequence has
1810 its basic block set to be cur_bb. */
1812 for (cur_insn = indirect_jump_sequence; cur_insn;
1813 cur_insn = NEXT_INSN (cur_insn))
1815 BLOCK_FOR_INSN (cur_insn) = cur_bb;
1816 if (JUMP_P (cur_insn))
1817 jump_insn = cur_insn;
1820 /* Insert the new (indirect) jump sequence immediately before
1821 the unconditional jump, then delete the unconditional jump. */
1823 emit_insn_before (indirect_jump_sequence, last_insn);
1824 delete_insn (last_insn);
1826 /* Make BB_END for cur_bb be the jump instruction (NOT the
1827 barrier instruction at the end of the sequence...). */
1829 BB_END (cur_bb) = jump_insn;
1835 /* Add REG_CROSSING_JUMP note to all crossing jump insns. */
1837 static void
1838 add_reg_crossing_jump_notes (void)
1840 basic_block bb;
1841 edge e;
1843 FOR_EACH_BB (bb)
1844 for (e = bb->succ; e; e = e->succ_next)
1845 if ((e->flags & EDGE_CROSSING)
1846 && JUMP_P (BB_END (e->src)))
1847 REG_NOTES (BB_END (e->src)) = gen_rtx_EXPR_LIST (REG_CROSSING_JUMP,
1848 NULL_RTX,
1849 REG_NOTES (BB_END
1850 (e->src)));
1853 /* Basic blocks containing NOTE_INSN_UNLIKELY_EXECUTED_CODE will be
1854 put in a separate section of the .o file, to reduce paging and
1855 improve cache performance (hopefully). This can result in bits of
1856 code from the same function being widely separated in the .o file.
1857 However this is not obvious to the current bb structure. Therefore
1858 we must take care to ensure that: 1). There are no fall_thru edges
1859 that cross between sections; 2). For those architectures which
1860 have "short" conditional branches, all conditional branches that
1861 attempt to cross between sections are converted to unconditional
1862 branches; and, 3). For those architectures which have "short"
1863 unconditional branches, all unconditional branches that attempt
1864 to cross between sections are converted to indirect jumps.
1866 The code for fixing up fall_thru edges that cross between hot and
1867 cold basic blocks does so by creating new basic blocks containing
1868 unconditional branches to the appropriate label in the "other"
1869 section. The new basic block is then put in the same (hot or cold)
1870 section as the original conditional branch, and the fall_thru edge
1871 is modified to fall into the new basic block instead. By adding
1872 this level of indirection we end up with only unconditional branches
1873 crossing between hot and cold sections.
1875 Conditional branches are dealt with by adding a level of indirection.
1876 A new basic block is added in the same (hot/cold) section as the
1877 conditional branch, and the conditional branch is retargeted to the
1878 new basic block. The new basic block contains an unconditional branch
1879 to the original target of the conditional branch (in the other section).
1881 Unconditional branches are dealt with by converting them into
1882 indirect jumps. */
1884 static void
1885 fix_edges_for_rarely_executed_code (edge *crossing_edges,
1886 int n_crossing_edges)
1888 /* Make sure the source of any crossing edge ends in a jump and the
1889 destination of any crossing edge has a label. */
1891 add_labels_and_missing_jumps (crossing_edges, n_crossing_edges);
1893 /* Convert all crossing fall_thru edges to non-crossing fall
1894 thrus to unconditional jumps (that jump to the original fall
1895 thru dest). */
1897 fix_up_fall_thru_edges ();
1899 /* Only do the parts necessary for writing separate sections if
1900 the target architecture has the ability to write separate sections
1901 (i.e. it has named sections). Otherwise, the hot/cold partitioning
1902 information will be used when reordering blocks to try to put all
1903 the hot blocks together, then all the cold blocks, but no actual
1904 section partitioning will be done. */
1906 if (targetm.have_named_sections)
1908 /* If the architecture does not have conditional branches that can
1909 span all of memory, convert crossing conditional branches into
1910 crossing unconditional branches. */
1912 if (!HAS_LONG_COND_BRANCH)
1913 fix_crossing_conditional_branches ();
1915 /* If the architecture does not have unconditional branches that
1916 can span all of memory, convert crossing unconditional branches
1917 into indirect jumps. Since adding an indirect jump also adds
1918 a new register usage, update the register usage information as
1919 well. */
1921 if (!HAS_LONG_UNCOND_BRANCH)
1923 fix_crossing_unconditional_branches ();
1924 reg_scan (get_insns(), max_reg_num (), 1);
1927 add_reg_crossing_jump_notes ();
1931 /* Reorder basic blocks. The main entry point to this file. FLAGS is
1932 the set of flags to pass to cfg_layout_initialize(). */
1934 void
1935 reorder_basic_blocks (unsigned int flags)
1937 int n_traces;
1938 int i;
1939 struct trace *traces;
1941 if (n_basic_blocks <= 1)
1942 return;
1944 if (targetm.cannot_modify_jumps_p ())
1945 return;
1947 timevar_push (TV_REORDER_BLOCKS);
1949 cfg_layout_initialize (flags);
1951 set_edge_can_fallthru_flag ();
1952 mark_dfs_back_edges ();
1954 /* We are estimating the length of uncond jump insn only once since the code
1955 for getting the insn length always returns the minimal length now. */
1956 if (uncond_jump_length == 0)
1957 uncond_jump_length = get_uncond_jump_length ();
1959 /* We need to know some information for each basic block. */
1960 array_size = GET_ARRAY_SIZE (last_basic_block);
1961 bbd = xmalloc (array_size * sizeof (bbro_basic_block_data));
1962 for (i = 0; i < array_size; i++)
1964 bbd[i].start_of_trace = -1;
1965 bbd[i].end_of_trace = -1;
1966 bbd[i].heap = NULL;
1967 bbd[i].node = NULL;
1970 traces = xmalloc (n_basic_blocks * sizeof (struct trace));
1971 n_traces = 0;
1972 find_traces (&n_traces, traces);
1973 connect_traces (n_traces, traces);
1974 FREE (traces);
1975 FREE (bbd);
1977 if (dump_file)
1978 dump_flow_info (dump_file);
1980 if (flag_reorder_blocks_and_partition
1981 && targetm.have_named_sections)
1982 add_unlikely_executed_notes ();
1984 cfg_layout_finalize ();
1986 timevar_pop (TV_REORDER_BLOCKS);
1989 /* This function is the main 'entrance' for the optimization that
1990 partitions hot and cold basic blocks into separate sections of the
1991 .o file (to improve performance and cache locality). Ideally it
1992 would be called after all optimizations that rearrange the CFG have
1993 been called. However part of this optimization may introduce new
1994 register usage, so it must be called before register allocation has
1995 occurred. This means that this optimization is actually called
1996 well before the optimization that reorders basic blocks (see
1997 function above).
1999 This optimization checks the feedback information to determine
2000 which basic blocks are hot/cold and causes reorder_basic_blocks to
2001 add NOTE_INSN_UNLIKELY_EXECUTED_CODE to non-hot basic blocks. The
2002 presence or absence of this note is later used for writing out
2003 sections in the .o file. Because hot and cold sections can be
2004 arbitrarily large (within the bounds of memory), far beyond the
2005 size of a single function, it is necessary to fix up all edges that
2006 cross section boundaries, to make sure the instructions used can
2007 actually span the required distance. The fixes are described
2008 below.
2010 Fall-through edges must be changed into jumps; it is not safe or
2011 legal to fall through across a section boundary. Whenever a
2012 fall-through edge crossing a section boundary is encountered, a new
2013 basic block is inserted (in the same section as the fall-through
2014 source), and the fall through edge is redirected to the new basic
2015 block. The new basic block contains an unconditional jump to the
2016 original fall-through target. (If the unconditional jump is
2017 insufficient to cross section boundaries, that is dealt with a
2018 little later, see below).
2020 In order to deal with architectures that have short conditional
2021 branches (which cannot span all of memory) we take any conditional
2022 jump that attempts to cross a section boundary and add a level of
2023 indirection: it becomes a conditional jump to a new basic block, in
2024 the same section. The new basic block contains an unconditional
2025 jump to the original target, in the other section.
2027 For those architectures whose unconditional branch is also
2028 incapable of reaching all of memory, those unconditional jumps are
2029 converted into indirect jumps, through a register.
2031 IMPORTANT NOTE: This optimization causes some messy interactions
2032 with the cfg cleanup optimizations; those optimizations want to
2033 merge blocks wherever possible, and to collapse indirect jump
2034 sequences (change "A jumps to B jumps to C" directly into "A jumps
2035 to C"). Those optimizations can undo the jump fixes that
2036 partitioning is required to make (see above), in order to ensure
2037 that jumps attempting to cross section boundaries are really able
2038 to cover whatever distance the jump requires (on many architectures
2039 conditional or unconditional jumps are not able to reach all of
2040 memory). Therefore tests have to be inserted into each such
2041 optimization to make sure that it does not undo stuff necessary to
2042 cross partition boundaries. This would be much less of a problem
2043 if we could perform this optimization later in the compilation, but
2044 unfortunately the fact that we may need to create indirect jumps
2045 (through registers) requires that this optimization be performed
2046 before register allocation. */
2048 void
2049 partition_hot_cold_basic_blocks (void)
2051 basic_block cur_bb;
2052 edge *crossing_edges;
2053 int n_crossing_edges;
2054 int max_edges = 2 * last_basic_block;
2056 if (n_basic_blocks <= 1)
2057 return;
2059 crossing_edges = xcalloc (max_edges, sizeof (edge));
2061 cfg_layout_initialize (0);
2063 FOR_EACH_BB (cur_bb)
2064 if (cur_bb->index >= 0
2065 && cur_bb->next_bb->index >= 0)
2066 cur_bb->rbi->next = cur_bb->next_bb;
2068 find_rarely_executed_basic_blocks_and_crossing_edges (crossing_edges,
2069 &n_crossing_edges,
2070 &max_edges);
2072 if (n_crossing_edges > 0)
2073 fix_edges_for_rarely_executed_code (crossing_edges, n_crossing_edges);
2075 free (crossing_edges);
2077 cfg_layout_finalize();