Convert forced_labels from an EXPR_LIST to an INSN_LIST
[platform/upstream/gcc.git] / gcc / cfgbuild.c
1 /* Control flow graph building code for GNU compiler.
2    Copyright (C) 1987-2014 Free Software Foundation, Inc.
3
4 This file is part of GCC.
5
6 GCC is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 3, or (at your option) any later
9 version.
10
11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with GCC; see the file COPYING3.  If not see
18 <http://www.gnu.org/licenses/>.  */
19
20 \f
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 "basic-block.h"
29 #include "regs.h"
30 #include "flags.h"
31 #include "function.h"
32 #include "except.h"
33 #include "expr.h"
34 #include "diagnostic-core.h"
35 #include "timevar.h"
36 #include "sbitmap.h"
37
38 static void make_edges (basic_block, basic_block, int);
39 static void make_label_edge (sbitmap, basic_block, rtx, int);
40 static void find_bb_boundaries (basic_block);
41 static void compute_outgoing_frequencies (basic_block);
42 \f
43 /* Return true if insn is something that should be contained inside basic
44    block.  */
45
46 bool
47 inside_basic_block_p (const_rtx insn)
48 {
49   switch (GET_CODE (insn))
50     {
51     case CODE_LABEL:
52       /* Avoid creating of basic block for jumptables.  */
53       return (NEXT_INSN (insn) == 0
54               || ! JUMP_TABLE_DATA_P (NEXT_INSN (insn)));
55
56     case JUMP_INSN:
57     case CALL_INSN:
58     case INSN:
59     case DEBUG_INSN:
60       return true;
61
62     case JUMP_TABLE_DATA:
63     case BARRIER:
64     case NOTE:
65       return false;
66
67     default:
68       gcc_unreachable ();
69     }
70 }
71
72 /* Return true if INSN may cause control flow transfer, so it should be last in
73    the basic block.  */
74
75 bool
76 control_flow_insn_p (const_rtx insn)
77 {
78   switch (GET_CODE (insn))
79     {
80     case NOTE:
81     case CODE_LABEL:
82     case DEBUG_INSN:
83       return false;
84
85     case JUMP_INSN:
86       return true;
87
88     case CALL_INSN:
89       /* Noreturn and sibling call instructions terminate the basic blocks
90          (but only if they happen unconditionally).  */
91       if ((SIBLING_CALL_P (insn)
92            || find_reg_note (insn, REG_NORETURN, 0))
93           && GET_CODE (PATTERN (insn)) != COND_EXEC)
94         return true;
95
96       /* Call insn may return to the nonlocal goto handler.  */
97       if (can_nonlocal_goto (insn))
98         return true;
99       break;
100
101     case INSN:
102       /* Treat trap instructions like noreturn calls (same provision).  */
103       if (GET_CODE (PATTERN (insn)) == TRAP_IF
104           && XEXP (PATTERN (insn), 0) == const1_rtx)
105         return true;
106       if (!cfun->can_throw_non_call_exceptions)
107         return false;
108       break;
109
110     case JUMP_TABLE_DATA:
111     case BARRIER:
112       /* It is nonsense to reach this when looking for the
113          end of basic block, but before dead code is eliminated
114          this may happen.  */
115       return false;
116
117     default:
118       gcc_unreachable ();
119     }
120
121   return can_throw_internal (insn);
122 }
123
124 \f
125 /* Create an edge between two basic blocks.  FLAGS are auxiliary information
126    about the edge that is accumulated between calls.  */
127
128 /* Create an edge from a basic block to a label.  */
129
130 static void
131 make_label_edge (sbitmap edge_cache, basic_block src, rtx label, int flags)
132 {
133   gcc_assert (LABEL_P (label));
134
135   /* If the label was never emitted, this insn is junk, but avoid a
136      crash trying to refer to BLOCK_FOR_INSN (label).  This can happen
137      as a result of a syntax error and a diagnostic has already been
138      printed.  */
139
140   if (INSN_UID (label) == 0)
141     return;
142
143   cached_make_edge (edge_cache, src, BLOCK_FOR_INSN (label), flags);
144 }
145
146 /* Create the edges generated by INSN in REGION.  */
147
148 void
149 rtl_make_eh_edge (sbitmap edge_cache, basic_block src, rtx insn)
150 {
151   eh_landing_pad lp = get_eh_landing_pad_from_rtx (insn);
152
153   if (lp)
154     {
155       rtx label = lp->landing_pad;
156
157       /* During initial rtl generation, use the post_landing_pad.  */
158       if (label == NULL)
159         {
160           gcc_assert (lp->post_landing_pad);
161           label = label_rtx (lp->post_landing_pad);
162         }
163
164       make_label_edge (edge_cache, src, label,
165                        EDGE_ABNORMAL | EDGE_EH
166                        | (CALL_P (insn) ? EDGE_ABNORMAL_CALL : 0));
167     }
168 }
169
170 /* States of basic block as seen by find_many_sub_basic_blocks.  */
171 enum state {
172   /* Basic blocks created via split_block belong to this state.
173      make_edges will examine these basic blocks to see if we need to
174      create edges going out of them.  */
175   BLOCK_NEW = 0,
176
177   /* Basic blocks that do not need examining belong to this state.
178      These blocks will be left intact.  In particular, make_edges will
179      not create edges going out of these basic blocks.  */
180   BLOCK_ORIGINAL,
181
182   /* Basic blocks that may need splitting (due to a label appearing in
183      the middle, etc) belong to this state.  After splitting them,
184      make_edges will create edges going out of them as needed.  */
185   BLOCK_TO_SPLIT
186 };
187
188 #define STATE(BB) (enum state) ((size_t) (BB)->aux)
189 #define SET_STATE(BB, STATE) ((BB)->aux = (void *) (size_t) (STATE))
190
191 /* Used internally by purge_dead_tablejump_edges, ORed into state.  */
192 #define BLOCK_USED_BY_TABLEJUMP         32
193 #define FULL_STATE(BB) ((size_t) (BB)->aux)
194
195 /* Identify the edges going out of basic blocks between MIN and MAX,
196    inclusive, that have their states set to BLOCK_NEW or
197    BLOCK_TO_SPLIT.
198
199    UPDATE_P should be nonzero if we are updating CFG and zero if we
200    are building CFG from scratch.  */
201
202 static void
203 make_edges (basic_block min, basic_block max, int update_p)
204 {
205   basic_block bb;
206   sbitmap edge_cache = NULL;
207
208   /* Heavy use of computed goto in machine-generated code can lead to
209      nearly fully-connected CFGs.  In that case we spend a significant
210      amount of time searching the edge lists for duplicates.  */
211   if (forced_labels || cfun->cfg->max_jumptable_ents > 100)
212     edge_cache = sbitmap_alloc (last_basic_block_for_fn (cfun));
213
214   /* By nature of the way these get numbered, ENTRY_BLOCK_PTR->next_bb block
215      is always the entry.  */
216   if (min == ENTRY_BLOCK_PTR_FOR_FN (cfun)->next_bb)
217     make_edge (ENTRY_BLOCK_PTR_FOR_FN (cfun), min, EDGE_FALLTHRU);
218
219   FOR_BB_BETWEEN (bb, min, max->next_bb, next_bb)
220     {
221       rtx_insn *insn;
222       enum rtx_code code;
223       edge e;
224       edge_iterator ei;
225
226       if (STATE (bb) == BLOCK_ORIGINAL)
227         continue;
228
229       /* If we have an edge cache, cache edges going out of BB.  */
230       if (edge_cache)
231         {
232           bitmap_clear (edge_cache);
233           if (update_p)
234             {
235               FOR_EACH_EDGE (e, ei, bb->succs)
236                 if (e->dest != EXIT_BLOCK_PTR_FOR_FN (cfun))
237                   bitmap_set_bit (edge_cache, e->dest->index);
238             }
239         }
240
241       if (LABEL_P (BB_HEAD (bb))
242           && LABEL_ALT_ENTRY_P (BB_HEAD (bb)))
243         cached_make_edge (NULL, ENTRY_BLOCK_PTR_FOR_FN (cfun), bb, 0);
244
245       /* Examine the last instruction of the block, and discover the
246          ways we can leave the block.  */
247
248       insn = BB_END (bb);
249       code = GET_CODE (insn);
250
251       /* A branch.  */
252       if (code == JUMP_INSN)
253         {
254           rtx tmp;
255           rtx_jump_table_data *table;
256
257           /* Recognize a non-local goto as a branch outside the
258              current function.  */
259           if (find_reg_note (insn, REG_NON_LOCAL_GOTO, NULL_RTX))
260             ;
261
262           /* Recognize a tablejump and do the right thing.  */
263           else if (tablejump_p (insn, NULL, &table))
264             {
265               rtvec vec = table->get_labels ();
266               int j;
267
268               for (j = GET_NUM_ELEM (vec) - 1; j >= 0; --j)
269                 make_label_edge (edge_cache, bb,
270                                  XEXP (RTVEC_ELT (vec, j), 0), 0);
271
272               /* Some targets (eg, ARM) emit a conditional jump that also
273                  contains the out-of-range target.  Scan for these and
274                  add an edge if necessary.  */
275               if ((tmp = single_set (insn)) != NULL
276                   && SET_DEST (tmp) == pc_rtx
277                   && GET_CODE (SET_SRC (tmp)) == IF_THEN_ELSE
278                   && GET_CODE (XEXP (SET_SRC (tmp), 2)) == LABEL_REF)
279                 make_label_edge (edge_cache, bb,
280                                  XEXP (XEXP (SET_SRC (tmp), 2), 0), 0);
281             }
282
283           /* If this is a computed jump, then mark it as reaching
284              everything on the forced_labels list.  */
285           else if (computed_jump_p (insn))
286             {
287               for (rtx_insn_list *x = forced_labels; x; x = x->next ())
288                 make_label_edge (edge_cache, bb, x->insn (), EDGE_ABNORMAL);
289             }
290
291           /* Returns create an exit out.  */
292           else if (returnjump_p (insn))
293             cached_make_edge (edge_cache, bb, EXIT_BLOCK_PTR_FOR_FN (cfun), 0);
294
295           /* Recognize asm goto and do the right thing.  */
296           else if ((tmp = extract_asm_operands (PATTERN (insn))) != NULL)
297             {
298               int i, n = ASM_OPERANDS_LABEL_LENGTH (tmp);
299               for (i = 0; i < n; ++i)
300                 make_label_edge (edge_cache, bb,
301                                  XEXP (ASM_OPERANDS_LABEL (tmp, i), 0), 0);
302             }
303
304           /* Otherwise, we have a plain conditional or unconditional jump.  */
305           else
306             {
307               gcc_assert (JUMP_LABEL (insn));
308               make_label_edge (edge_cache, bb, JUMP_LABEL (insn), 0);
309             }
310         }
311
312       /* If this is a sibling call insn, then this is in effect a combined call
313          and return, and so we need an edge to the exit block.  No need to
314          worry about EH edges, since we wouldn't have created the sibling call
315          in the first place.  */
316       if (code == CALL_INSN && SIBLING_CALL_P (insn))
317         cached_make_edge (edge_cache, bb, EXIT_BLOCK_PTR_FOR_FN (cfun),
318                           EDGE_SIBCALL | EDGE_ABNORMAL);
319
320       /* If this is a CALL_INSN, then mark it as reaching the active EH
321          handler for this CALL_INSN.  If we're handling non-call
322          exceptions then any insn can reach any of the active handlers.
323          Also mark the CALL_INSN as reaching any nonlocal goto handler.  */
324       else if (code == CALL_INSN || cfun->can_throw_non_call_exceptions)
325         {
326           /* Add any appropriate EH edges.  */
327           rtl_make_eh_edge (edge_cache, bb, insn);
328
329           if (code == CALL_INSN)
330             {
331               if (can_nonlocal_goto (insn))
332                 {
333                   /* ??? This could be made smarter: in some cases it's
334                      possible to tell that certain calls will not do a
335                      nonlocal goto.  For example, if the nested functions
336                      that do the nonlocal gotos do not have their addresses
337                      taken, then only calls to those functions or to other
338                      nested functions that use them could possibly do
339                      nonlocal gotos.  */
340                   for (rtx_insn_list *x = nonlocal_goto_handler_labels;
341                        x;
342                        x = x->next ())
343                     make_label_edge (edge_cache, bb, x->insn (),
344                                      EDGE_ABNORMAL | EDGE_ABNORMAL_CALL);
345                 }
346
347               if (flag_tm)
348                 {
349                   rtx note;
350                   for (note = REG_NOTES (insn); note; note = XEXP (note, 1))
351                     if (REG_NOTE_KIND (note) == REG_TM)
352                       make_label_edge (edge_cache, bb, XEXP (note, 0),
353                                        EDGE_ABNORMAL | EDGE_ABNORMAL_CALL);
354                 }
355             }
356         }
357
358       /* Find out if we can drop through to the next block.  */
359       insn = NEXT_INSN (insn);
360       e = find_edge (bb, EXIT_BLOCK_PTR_FOR_FN (cfun));
361       if (e && e->flags & EDGE_FALLTHRU)
362         insn = NULL;
363
364       while (insn
365              && NOTE_P (insn)
366              && NOTE_KIND (insn) != NOTE_INSN_BASIC_BLOCK)
367         insn = NEXT_INSN (insn);
368
369       if (!insn)
370         cached_make_edge (edge_cache, bb, EXIT_BLOCK_PTR_FOR_FN (cfun),
371                           EDGE_FALLTHRU);
372       else if (bb->next_bb != EXIT_BLOCK_PTR_FOR_FN (cfun))
373         {
374           if (insn == BB_HEAD (bb->next_bb))
375             cached_make_edge (edge_cache, bb, bb->next_bb, EDGE_FALLTHRU);
376         }
377     }
378
379   if (edge_cache)
380     sbitmap_free (edge_cache);
381 }
382 \f
383 static void
384 mark_tablejump_edge (rtx label)
385 {
386   basic_block bb;
387
388   gcc_assert (LABEL_P (label));
389   /* See comment in make_label_edge.  */
390   if (INSN_UID (label) == 0)
391     return;
392   bb = BLOCK_FOR_INSN (label);
393   SET_STATE (bb, FULL_STATE (bb) | BLOCK_USED_BY_TABLEJUMP);
394 }
395
396 static void
397 purge_dead_tablejump_edges (basic_block bb, rtx_jump_table_data *table)
398 {
399   rtx_insn *insn = BB_END (bb);
400   rtx tmp;
401   rtvec vec;
402   int j;
403   edge_iterator ei;
404   edge e;
405
406   vec = table->get_labels ();
407
408   for (j = GET_NUM_ELEM (vec) - 1; j >= 0; --j)
409     mark_tablejump_edge (XEXP (RTVEC_ELT (vec, j), 0));
410
411   /* Some targets (eg, ARM) emit a conditional jump that also
412      contains the out-of-range target.  Scan for these and
413      add an edge if necessary.  */
414   if ((tmp = single_set (insn)) != NULL
415        && SET_DEST (tmp) == pc_rtx
416        && GET_CODE (SET_SRC (tmp)) == IF_THEN_ELSE
417        && GET_CODE (XEXP (SET_SRC (tmp), 2)) == LABEL_REF)
418     mark_tablejump_edge (XEXP (XEXP (SET_SRC (tmp), 2), 0));
419
420   for (ei = ei_start (bb->succs); (e = ei_safe_edge (ei)); )
421     {
422       if (FULL_STATE (e->dest) & BLOCK_USED_BY_TABLEJUMP)
423         SET_STATE (e->dest, FULL_STATE (e->dest)
424                             & ~(size_t) BLOCK_USED_BY_TABLEJUMP);
425       else if (!(e->flags & (EDGE_ABNORMAL | EDGE_EH)))
426         {
427           remove_edge (e);
428           continue;
429         }
430       ei_next (&ei);
431     }
432 }
433
434 /* Scan basic block BB for possible BB boundaries inside the block
435    and create new basic blocks in the progress.  */
436
437 static void
438 find_bb_boundaries (basic_block bb)
439 {
440   basic_block orig_bb = bb;
441   rtx_insn *insn = BB_HEAD (bb);
442   rtx_insn *end = BB_END (bb), *x;
443   rtx_jump_table_data *table;
444   rtx_insn *flow_transfer_insn = NULL;
445   edge fallthru = NULL;
446
447   if (insn == BB_END (bb))
448     return;
449
450   if (LABEL_P (insn))
451     insn = NEXT_INSN (insn);
452
453   /* Scan insn chain and try to find new basic block boundaries.  */
454   while (1)
455     {
456       enum rtx_code code = GET_CODE (insn);
457
458       /* In case we've previously seen an insn that effects a control
459          flow transfer, split the block.  */
460       if ((flow_transfer_insn || code == CODE_LABEL)
461           && inside_basic_block_p (insn))
462         {
463           fallthru = split_block (bb, PREV_INSN (insn));
464           if (flow_transfer_insn)
465             {
466               BB_END (bb) = flow_transfer_insn;
467
468               /* Clean up the bb field for the insns between the blocks.  */
469               for (x = NEXT_INSN (flow_transfer_insn);
470                    x != BB_HEAD (fallthru->dest);
471                    x = NEXT_INSN (x))
472                 if (!BARRIER_P (x))
473                   set_block_for_insn (x, NULL);
474             }
475
476           bb = fallthru->dest;
477           remove_edge (fallthru);
478           flow_transfer_insn = NULL;
479           if (code == CODE_LABEL && LABEL_ALT_ENTRY_P (insn))
480             make_edge (ENTRY_BLOCK_PTR_FOR_FN (cfun), bb, 0);
481         }
482       else if (code == BARRIER)
483         {
484           /* __builtin_unreachable () may cause a barrier to be emitted in
485              the middle of a BB.  We need to split it in the same manner as
486              if the barrier were preceded by a control_flow_insn_p insn.  */
487           if (!flow_transfer_insn)
488             flow_transfer_insn = prev_nonnote_insn_bb (insn);
489         }
490
491       if (control_flow_insn_p (insn))
492         flow_transfer_insn = insn;
493       if (insn == end)
494         break;
495       insn = NEXT_INSN (insn);
496     }
497
498   /* In case expander replaced normal insn by sequence terminating by
499      return and barrier, or possibly other sequence not behaving like
500      ordinary jump, we need to take care and move basic block boundary.  */
501   if (flow_transfer_insn)
502     {
503       BB_END (bb) = flow_transfer_insn;
504
505       /* Clean up the bb field for the insns that do not belong to BB.  */
506       x = flow_transfer_insn;
507       while (x != end)
508         {
509           x = NEXT_INSN (x);
510           if (!BARRIER_P (x))
511             set_block_for_insn (x, NULL);
512         }
513     }
514
515   /* We've possibly replaced the conditional jump by conditional jump
516      followed by cleanup at fallthru edge, so the outgoing edges may
517      be dead.  */
518   purge_dead_edges (bb);
519
520   /* purge_dead_edges doesn't handle tablejump's, but if we have split the
521      basic block, we might need to kill some edges.  */
522   if (bb != orig_bb && tablejump_p (BB_END (bb), NULL, &table))
523     purge_dead_tablejump_edges (bb, table);
524 }
525
526 /*  Assume that frequency of basic block B is known.  Compute frequencies
527     and probabilities of outgoing edges.  */
528
529 static void
530 compute_outgoing_frequencies (basic_block b)
531 {
532   edge e, f;
533   edge_iterator ei;
534
535   if (EDGE_COUNT (b->succs) == 2)
536     {
537       rtx note = find_reg_note (BB_END (b), REG_BR_PROB, NULL);
538       int probability;
539
540       if (note)
541         {
542           probability = XINT (note, 0);
543           e = BRANCH_EDGE (b);
544           e->probability = probability;
545           e->count = apply_probability (b->count, probability);
546           f = FALLTHRU_EDGE (b);
547           f->probability = REG_BR_PROB_BASE - probability;
548           f->count = b->count - e->count;
549           return;
550         }
551       else
552         {
553           guess_outgoing_edge_probabilities (b);
554         }
555     }
556   else if (single_succ_p (b))
557     {
558       e = single_succ_edge (b);
559       e->probability = REG_BR_PROB_BASE;
560       e->count = b->count;
561       return;
562     }
563   else
564     {
565       /* We rely on BBs with more than two successors to have sane probabilities
566          and do not guess them here. For BBs terminated by switch statements
567          expanded to jump-table jump, we have done the right thing during
568          expansion. For EH edges, we still guess the probabilities here.  */
569       bool complex_edge = false;
570       FOR_EACH_EDGE (e, ei, b->succs)
571         if (e->flags & EDGE_COMPLEX)
572           {
573             complex_edge = true;
574             break;
575           }
576       if (complex_edge)
577         guess_outgoing_edge_probabilities (b);
578     }
579
580   if (b->count)
581     FOR_EACH_EDGE (e, ei, b->succs)
582       e->count = apply_probability (b->count, e->probability);
583 }
584
585 /* Assume that some pass has inserted labels or control flow
586    instructions within a basic block.  Split basic blocks as needed
587    and create edges.  */
588
589 void
590 find_many_sub_basic_blocks (sbitmap blocks)
591 {
592   basic_block bb, min, max;
593
594   FOR_EACH_BB_FN (bb, cfun)
595     SET_STATE (bb,
596                bitmap_bit_p (blocks, bb->index) ? BLOCK_TO_SPLIT : BLOCK_ORIGINAL);
597
598   FOR_EACH_BB_FN (bb, cfun)
599     if (STATE (bb) == BLOCK_TO_SPLIT)
600       find_bb_boundaries (bb);
601
602   FOR_EACH_BB_FN (bb, cfun)
603     if (STATE (bb) != BLOCK_ORIGINAL)
604       break;
605
606   min = max = bb;
607   for (; bb != EXIT_BLOCK_PTR_FOR_FN (cfun); bb = bb->next_bb)
608     if (STATE (bb) != BLOCK_ORIGINAL)
609       max = bb;
610
611   /* Now re-scan and wire in all edges.  This expect simple (conditional)
612      jumps at the end of each new basic blocks.  */
613   make_edges (min, max, 1);
614
615   /* Update branch probabilities.  Expect only (un)conditional jumps
616      to be created with only the forward edges.  */
617   if (profile_status_for_fn (cfun) != PROFILE_ABSENT)
618     FOR_BB_BETWEEN (bb, min, max->next_bb, next_bb)
619       {
620         edge e;
621         edge_iterator ei;
622
623         if (STATE (bb) == BLOCK_ORIGINAL)
624           continue;
625         if (STATE (bb) == BLOCK_NEW)
626           {
627             bb->count = 0;
628             bb->frequency = 0;
629             FOR_EACH_EDGE (e, ei, bb->preds)
630               {
631                 bb->count += e->count;
632                 bb->frequency += EDGE_FREQUENCY (e);
633               }
634           }
635
636         compute_outgoing_frequencies (bb);
637       }
638
639   FOR_EACH_BB_FN (bb, cfun)
640     SET_STATE (bb, 0);
641 }