OSDN Git Service

* basic-block.h (profile_staus): New global variable.
[pf3gnuchains/gcc-fork.git] / gcc / tree-cfg.c
1 /* Control flow functions for trees.
2    Copyright (C) 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
3    Contributed by Diego Novillo <dnovillo@redhat.com>
4
5 This file is part of GCC.
6
7 GCC is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
11
12 GCC is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING.  If not, write to
19 the Free Software Foundation, 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA.  */
21
22 #include "config.h"
23 #include "system.h"
24 #include "coretypes.h"
25 #include "tm.h"
26 #include "tree.h"
27 #include "rtl.h"
28 #include "tm_p.h"
29 #include "hard-reg-set.h"
30 #include "basic-block.h"
31 #include "output.h"
32 #include "errors.h"
33 #include "flags.h"
34 #include "function.h"
35 #include "expr.h"
36 #include "ggc.h"
37 #include "langhooks.h"
38 #include "diagnostic.h"
39 #include "tree-flow.h"
40 #include "timevar.h"
41 #include "tree-dump.h"
42 #include "tree-pass.h"
43 #include "toplev.h"
44 #include "except.h"
45 #include "cfgloop.h"
46
47 /* This file contains functions for building the Control Flow Graph (CFG)
48    for a function tree.  */
49
50 /* Local declarations.  */
51
52 /* Initial capacity for the basic block array.  */
53 static const int initial_cfg_capacity = 20;
54
55 /* Mapping of labels to their associated blocks.  This can greatly speed up
56    building of the CFG in code with lots of gotos.  */
57 static GTY(()) varray_type label_to_block_map;
58
59 /* CFG statistics.  */
60 struct cfg_stats_d
61 {
62   long num_merged_labels;
63 };
64
65 static struct cfg_stats_d cfg_stats;
66
67 /* Nonzero if we found a computed goto while building basic blocks.  */
68 static bool found_computed_goto;
69
70 /* Basic blocks and flowgraphs.  */
71 static basic_block create_bb (void *, void *, basic_block);
72 static void create_block_annotation (basic_block);
73 static void free_blocks_annotations (void);
74 static void clear_blocks_annotations (void);
75 static void make_blocks (tree);
76 static void factor_computed_gotos (void);
77
78 /* Edges.  */
79 static void make_edges (void);
80 static void make_ctrl_stmt_edges (basic_block);
81 static void make_exit_edges (basic_block);
82 static void make_cond_expr_edges (basic_block);
83 static void make_switch_expr_edges (basic_block);
84 static void make_goto_expr_edges (basic_block);
85 static edge tree_redirect_edge_and_branch (edge, basic_block);
86 static edge tree_try_redirect_by_replacing_jump (edge, basic_block);
87 static void split_critical_edges (void);
88
89 /* Various helpers.  */
90 static inline bool stmt_starts_bb_p (tree, tree);
91 static int tree_verify_flow_info (void);
92 static void tree_make_forwarder_block (edge);
93 static bool thread_jumps (void);
94 static bool tree_forwarder_block_p (basic_block);
95 static void bsi_commit_edge_inserts_1 (edge e);
96 static void tree_cfg2vcg (FILE *);
97
98 /* Flowgraph optimization and cleanup.  */
99 static void tree_merge_blocks (basic_block, basic_block);
100 static bool tree_can_merge_blocks_p (basic_block, basic_block);
101 static void remove_bb (basic_block);
102 static bool cleanup_control_flow (void);
103 static bool cleanup_control_expr_graph (basic_block, block_stmt_iterator);
104 static edge find_taken_edge_cond_expr (basic_block, tree);
105 static edge find_taken_edge_switch_expr (basic_block, tree);
106 static tree find_case_label_for_value (tree, tree);
107 static bool phi_alternatives_equal (basic_block, edge, edge);
108
109
110 /*---------------------------------------------------------------------------
111                               Create basic blocks
112 ---------------------------------------------------------------------------*/
113
114 /* Entry point to the CFG builder for trees.  TP points to the list of
115    statements to be added to the flowgraph.  */
116
117 static void
118 build_tree_cfg (tree *tp)
119 {
120   /* Register specific tree functions.  */
121   tree_register_cfg_hooks ();
122
123   /* Initialize rbi_pool.  */
124   alloc_rbi_pool ();
125
126   /* Initialize the basic block array.  */
127   init_flow ();
128   profile_status = PROFILE_ABSENT;
129   n_basic_blocks = 0;
130   last_basic_block = 0;
131   VARRAY_BB_INIT (basic_block_info, initial_cfg_capacity, "basic_block_info");
132   memset ((void *) &cfg_stats, 0, sizeof (cfg_stats));
133
134   /* Build a mapping of labels to their associated blocks.  */
135   VARRAY_BB_INIT (label_to_block_map, initial_cfg_capacity,
136                   "label to block map");
137
138   ENTRY_BLOCK_PTR->next_bb = EXIT_BLOCK_PTR;
139   EXIT_BLOCK_PTR->prev_bb = ENTRY_BLOCK_PTR;
140
141   found_computed_goto = 0;
142   make_blocks (*tp);
143
144   /* Computed gotos are hell to deal with, especially if there are
145      lots of them with a large number of destinations.  So we factor
146      them to a common computed goto location before we build the
147      edge list.  After we convert back to normal form, we will un-factor
148      the computed gotos since factoring introduces an unwanted jump.  */
149   if (found_computed_goto)
150     factor_computed_gotos ();
151
152   /* Make sure there is always at least one block, even if its empty.  */
153   if (n_basic_blocks == 0)
154     create_empty_bb (ENTRY_BLOCK_PTR);
155
156   create_block_annotation (ENTRY_BLOCK_PTR);
157   create_block_annotation (EXIT_BLOCK_PTR);
158   
159   /* Adjust the size of the array.  */
160   VARRAY_GROW (basic_block_info, n_basic_blocks);
161
162   /* To speed up statement iterator walks, we first purge dead labels.  */
163   cleanup_dead_labels ();
164
165   /* Group case nodes to reduce the number of edges.
166      We do this after cleaning up dead labels because otherwise we miss
167      a lot of obvious case merging opportunities.  */
168   group_case_labels ();
169
170   /* Create the edges of the flowgraph.  */
171   make_edges ();
172
173   /* Debugging dumps.  */
174
175   /* Write the flowgraph to a VCG file.  */
176   {
177     int local_dump_flags;
178     FILE *dump_file = dump_begin (TDI_vcg, &local_dump_flags);
179     if (dump_file)
180       {
181         tree_cfg2vcg (dump_file);
182         dump_end (TDI_vcg, dump_file);
183       }
184   }
185
186   /* Dump a textual representation of the flowgraph.  */
187   if (dump_file)
188     dump_tree_cfg (dump_file, dump_flags);
189 }
190
191 static void
192 execute_build_cfg (void)
193 {
194   build_tree_cfg (&DECL_SAVED_TREE (current_function_decl));
195 }
196
197 struct tree_opt_pass pass_build_cfg =
198 {
199   "cfg",                                /* name */
200   NULL,                                 /* gate */
201   execute_build_cfg,                    /* execute */
202   NULL,                                 /* sub */
203   NULL,                                 /* next */
204   0,                                    /* static_pass_number */
205   TV_TREE_CFG,                          /* tv_id */
206   PROP_gimple_leh,                      /* properties_required */
207   PROP_cfg,                             /* properties_provided */
208   0,                                    /* properties_destroyed */
209   0,                                    /* todo_flags_start */
210   TODO_verify_stmts                     /* todo_flags_finish */
211 };
212
213 /* Search the CFG for any computed gotos.  If found, factor them to a 
214    common computed goto site.  Also record the location of that site so
215    that we can un-factor the gotos after we have converted back to 
216    normal form.  */
217
218 static void
219 factor_computed_gotos (void)
220 {
221   basic_block bb;
222   tree factored_label_decl = NULL;
223   tree var = NULL;
224   tree factored_computed_goto_label = NULL;
225   tree factored_computed_goto = NULL;
226
227   /* We know there are one or more computed gotos in this function.
228      Examine the last statement in each basic block to see if the block
229      ends with a computed goto.  */
230         
231   FOR_EACH_BB (bb)
232     {
233       block_stmt_iterator bsi = bsi_last (bb);
234       tree last;
235
236       if (bsi_end_p (bsi))
237         continue;
238       last = bsi_stmt (bsi);
239
240       /* Ignore the computed goto we create when we factor the original
241          computed gotos.  */
242       if (last == factored_computed_goto)
243         continue;
244
245       /* If the last statement is a computed goto, factor it.  */
246       if (computed_goto_p (last))
247         {
248           tree assignment;
249
250           /* The first time we find a computed goto we need to create
251              the factored goto block and the variable each original
252              computed goto will use for their goto destination.  */
253           if (! factored_computed_goto)
254             {
255               basic_block new_bb = create_empty_bb (bb);
256               block_stmt_iterator new_bsi = bsi_start (new_bb);
257
258               /* Create the destination of the factored goto.  Each original
259                  computed goto will put its desired destination into this
260                  variable and jump to the label we create immediately
261                  below.  */
262               var = create_tmp_var (ptr_type_node, "gotovar");
263
264               /* Build a label for the new block which will contain the
265                  factored computed goto.  */
266               factored_label_decl = create_artificial_label ();
267               factored_computed_goto_label
268                 = build1 (LABEL_EXPR, void_type_node, factored_label_decl);
269               bsi_insert_after (&new_bsi, factored_computed_goto_label,
270                                 BSI_NEW_STMT);
271
272               /* Build our new computed goto.  */
273               factored_computed_goto = build1 (GOTO_EXPR, void_type_node, var);
274               bsi_insert_after (&new_bsi, factored_computed_goto,
275                                 BSI_NEW_STMT);
276             }
277
278           /* Copy the original computed goto's destination into VAR.  */
279           assignment = build (MODIFY_EXPR, ptr_type_node,
280                               var, GOTO_DESTINATION (last));
281           bsi_insert_before (&bsi, assignment, BSI_SAME_STMT);
282
283           /* And re-vector the computed goto to the new destination.  */
284           GOTO_DESTINATION (last) = factored_label_decl;
285         }
286     }
287 }
288
289
290 /* Create annotations for a single basic block.  */
291
292 static void
293 create_block_annotation (basic_block bb)
294 {
295   /* Verify that the tree_annotations field is clear.  */
296   if (bb->tree_annotations)
297     abort ();
298   bb->tree_annotations = ggc_alloc_cleared (sizeof (struct bb_ann_d));
299 }
300
301
302 /* Free the annotations for all the basic blocks.  */
303
304 static void free_blocks_annotations (void)
305 {
306   clear_blocks_annotations ();  
307 }
308
309
310 /* Clear the annotations for all the basic blocks.  */
311
312 static void
313 clear_blocks_annotations (void)
314 {
315   basic_block bb;
316
317   FOR_BB_BETWEEN (bb, ENTRY_BLOCK_PTR, NULL, next_bb)
318     bb->tree_annotations = NULL;
319 }
320
321
322 /* Build a flowgraph for the statement_list STMT_LIST.  */
323
324 static void
325 make_blocks (tree stmt_list)
326 {
327   tree_stmt_iterator i = tsi_start (stmt_list);
328   tree stmt = NULL;
329   bool start_new_block = true;
330   bool first_stmt_of_list = true;
331   basic_block bb = ENTRY_BLOCK_PTR;
332
333   while (!tsi_end_p (i))
334     {
335       tree prev_stmt;
336
337       prev_stmt = stmt;
338       stmt = tsi_stmt (i);
339
340       /* If the statement starts a new basic block or if we have determined
341          in a previous pass that we need to create a new block for STMT, do
342          so now.  */
343       if (start_new_block || stmt_starts_bb_p (stmt, prev_stmt))
344         {
345           if (!first_stmt_of_list)
346             stmt_list = tsi_split_statement_list_before (&i);
347           bb = create_basic_block (stmt_list, NULL, bb);
348           start_new_block = false;
349         }
350
351       /* Now add STMT to BB and create the subgraphs for special statement
352          codes.  */
353       set_bb_for_stmt (stmt, bb);
354
355       if (computed_goto_p (stmt))
356         found_computed_goto = true;
357
358       /* If STMT is a basic block terminator, set START_NEW_BLOCK for the
359          next iteration.  */
360       if (stmt_ends_bb_p (stmt))
361         start_new_block = true;
362
363       tsi_next (&i);
364       first_stmt_of_list = false;
365     }
366 }
367
368
369 /* Create and return a new empty basic block after bb AFTER.  */
370
371 static basic_block
372 create_bb (void *h, void *e, basic_block after)
373 {
374   basic_block bb;
375
376   if (e)
377     abort ();
378
379   /* Create and initialize a new basic block.  */
380   bb = alloc_block ();
381   memset (bb, 0, sizeof (*bb));
382
383   bb->index = last_basic_block;
384   bb->flags = BB_NEW;
385   bb->stmt_list = h ? h : alloc_stmt_list ();
386
387   /* Add the new block to the linked list of blocks.  */
388   link_block (bb, after);
389
390   /* Grow the basic block array if needed.  */
391   if ((size_t) last_basic_block == VARRAY_SIZE (basic_block_info))
392     {
393       size_t new_size = last_basic_block + (last_basic_block + 3) / 4;
394       VARRAY_GROW (basic_block_info, new_size);
395     }
396
397   /* Add the newly created block to the array.  */
398   BASIC_BLOCK (last_basic_block) = bb;
399
400   create_block_annotation (bb);
401
402   n_basic_blocks++;
403   last_basic_block++;
404
405   initialize_bb_rbi (bb);
406   return bb;
407 }
408
409
410 /*---------------------------------------------------------------------------
411                                  Edge creation
412 ---------------------------------------------------------------------------*/
413
414 /* Join all the blocks in the flowgraph.  */
415
416 static void
417 make_edges (void)
418 {
419   basic_block bb;
420
421   /* Create an edge from entry to the first block with executable
422      statements in it.  */
423   make_edge (ENTRY_BLOCK_PTR, BASIC_BLOCK (0), EDGE_FALLTHRU);
424
425   /* Traverse basic block array placing edges.  */
426   FOR_EACH_BB (bb)
427     {
428       tree first = first_stmt (bb);
429       tree last = last_stmt (bb);
430
431       if (first)
432         {
433           /* Edges for statements that always alter flow control.  */
434           if (is_ctrl_stmt (last))
435             make_ctrl_stmt_edges (bb);
436
437           /* Edges for statements that sometimes alter flow control.  */
438           if (is_ctrl_altering_stmt (last))
439             make_exit_edges (bb);
440         }
441
442       /* Finally, if no edges were created above, this is a regular
443          basic block that only needs a fallthru edge.  */
444       if (bb->succ == NULL)
445         make_edge (bb, bb->next_bb, EDGE_FALLTHRU);
446     }
447
448   /* We do not care about fake edges, so remove any that the CFG
449      builder inserted for completeness.  */
450   remove_fake_exit_edges ();
451
452   /* Clean up the graph and warn for unreachable code.  */
453   cleanup_tree_cfg ();
454 }
455
456
457 /* Create edges for control statement at basic block BB.  */
458
459 static void
460 make_ctrl_stmt_edges (basic_block bb)
461 {
462   tree last = last_stmt (bb);
463
464 #if defined ENABLE_CHECKING
465   if (last == NULL_TREE)
466     abort();
467 #endif
468
469   switch (TREE_CODE (last))
470     {
471     case GOTO_EXPR:
472       make_goto_expr_edges (bb);
473       break;
474
475     case RETURN_EXPR:
476       make_edge (bb, EXIT_BLOCK_PTR, 0);
477       break;
478
479     case COND_EXPR:
480       make_cond_expr_edges (bb);
481       break;
482
483     case SWITCH_EXPR:
484       make_switch_expr_edges (bb);
485       break;
486
487     case RESX_EXPR:
488       make_eh_edges (last);
489       /* Yet another NORETURN hack.  */
490       if (bb->succ == NULL)
491         make_edge (bb, EXIT_BLOCK_PTR, EDGE_FAKE);
492       break;
493
494     default:
495       abort ();
496     }
497 }
498
499
500 /* Create exit edges for statements in block BB that alter the flow of
501    control.  Statements that alter the control flow are 'goto', 'return'
502    and calls to non-returning functions.  */
503
504 static void
505 make_exit_edges (basic_block bb)
506 {
507   tree last = last_stmt (bb), op;
508
509   if (last == NULL_TREE)
510     abort ();
511
512   switch (TREE_CODE (last))
513     {
514     case CALL_EXPR:
515       /* If this function receives a nonlocal goto, then we need to
516          make edges from this call site to all the nonlocal goto
517          handlers.  */
518       if (TREE_SIDE_EFFECTS (last)
519           && current_function_has_nonlocal_label)
520         make_goto_expr_edges (bb);
521
522       /* If this statement has reachable exception handlers, then
523          create abnormal edges to them.  */
524       make_eh_edges (last);
525
526       /* Some calls are known not to return.  For such calls we create
527          a fake edge.
528
529          We really need to revamp how we build edges so that it's not
530          such a bloody pain to avoid creating edges for this case since
531          all we do is remove these edges when we're done building the
532          CFG.  */
533       if (call_expr_flags (last) & (ECF_NORETURN | ECF_LONGJMP))
534         {
535           make_edge (bb, EXIT_BLOCK_PTR, EDGE_FAKE);
536           return;
537         }
538
539       /* Don't forget the fall-thru edge.  */
540       make_edge (bb, bb->next_bb, EDGE_FALLTHRU);
541       break;
542
543     case MODIFY_EXPR:
544       /* A MODIFY_EXPR may have a CALL_EXPR on its RHS and the CALL_EXPR
545          may have an abnormal edge.  Search the RHS for this case and
546          create any required edges.  */
547       op = get_call_expr_in (last);
548       if (op && TREE_SIDE_EFFECTS (op)
549           && current_function_has_nonlocal_label)
550         make_goto_expr_edges (bb);
551
552       make_eh_edges (last);
553       make_edge (bb, bb->next_bb, EDGE_FALLTHRU);
554       break;
555
556     default:
557       abort ();
558     }
559 }
560
561
562 /* Create the edges for a COND_EXPR starting at block BB.
563    At this point, both clauses must contain only simple gotos.  */
564
565 static void
566 make_cond_expr_edges (basic_block bb)
567 {
568   tree entry = last_stmt (bb);
569   basic_block then_bb, else_bb;
570   tree then_label, else_label;
571
572 #if defined ENABLE_CHECKING
573   if (entry == NULL_TREE || TREE_CODE (entry) != COND_EXPR)
574     abort ();
575 #endif
576
577   /* Entry basic blocks for each component.  */
578   then_label = GOTO_DESTINATION (COND_EXPR_THEN (entry));
579   else_label = GOTO_DESTINATION (COND_EXPR_ELSE (entry));
580   then_bb = label_to_block (then_label);
581   else_bb = label_to_block (else_label);
582
583   make_edge (bb, then_bb, EDGE_TRUE_VALUE);
584   make_edge (bb, else_bb, EDGE_FALSE_VALUE);
585 }
586
587
588 /* Create the edges for a SWITCH_EXPR starting at block BB.
589    At this point, the switch body has been lowered and the
590    SWITCH_LABELS filled in, so this is in effect a multi-way branch.  */
591
592 static void
593 make_switch_expr_edges (basic_block bb)
594 {
595   tree entry = last_stmt (bb);
596   size_t i, n;
597   tree vec;
598
599   vec = SWITCH_LABELS (entry);
600   n = TREE_VEC_LENGTH (vec);
601
602   for (i = 0; i < n; ++i)
603     {
604       tree lab = CASE_LABEL (TREE_VEC_ELT (vec, i));
605       basic_block label_bb = label_to_block (lab);
606       make_edge (bb, label_bb, 0);
607     }
608 }
609
610
611 /* Return the basic block holding label DEST.  */
612
613 basic_block
614 label_to_block (tree dest)
615 {
616   int uid = LABEL_DECL_UID (dest);
617
618   /* We would die hard when faced by undefined label.  Emit label to
619      very first basic block.  This will hopefully make even the dataflow
620      and undefined variable warnings quite right.  */
621   if ((errorcount || sorrycount) && uid < 0)
622     {
623       block_stmt_iterator bsi = bsi_start (BASIC_BLOCK (0));
624       tree stmt;
625
626       stmt = build1 (LABEL_EXPR, void_type_node, dest);
627       bsi_insert_before (&bsi, stmt, BSI_NEW_STMT);
628       uid = LABEL_DECL_UID (dest);
629     }
630   return VARRAY_BB (label_to_block_map, uid);
631 }
632
633
634 /* Create edges for a goto statement at block BB.  */
635
636 static void
637 make_goto_expr_edges (basic_block bb)
638 {
639   tree goto_t, dest;
640   basic_block target_bb;
641   int for_call;
642   block_stmt_iterator last = bsi_last (bb);
643
644   goto_t = bsi_stmt (last);
645
646   /* If the last statement is not a GOTO (i.e., it is a RETURN_EXPR,
647      CALL_EXPR or MODIFY_EXPR), then the edge is an abnormal edge resulting
648      from a nonlocal goto.  */
649   if (TREE_CODE (goto_t) != GOTO_EXPR)
650     {
651       dest = error_mark_node;
652       for_call = 1;
653     }
654   else
655     {
656       dest = GOTO_DESTINATION (goto_t);
657       for_call = 0;
658
659       /* A GOTO to a local label creates normal edges.  */
660       if (simple_goto_p (goto_t))
661         {
662           edge e = make_edge (bb, label_to_block (dest), EDGE_FALLTHRU);
663 #ifdef USE_MAPPED_LOCATION
664           e->goto_locus = EXPR_LOCATION (goto_t);
665 #else
666           e->goto_locus = EXPR_LOCUS (goto_t);
667 #endif
668           bsi_remove (&last);
669           return;
670         }
671
672       /* Nothing more to do for nonlocal gotos.  */
673       if (TREE_CODE (dest) == LABEL_DECL)
674         return;
675
676       /* Computed gotos remain.  */
677     }
678
679   /* Look for the block starting with the destination label.  In the
680      case of a computed goto, make an edge to any label block we find
681      in the CFG.  */
682   FOR_EACH_BB (target_bb)
683     {
684       block_stmt_iterator bsi;
685
686       for (bsi = bsi_start (target_bb); !bsi_end_p (bsi); bsi_next (&bsi))
687         {
688           tree target = bsi_stmt (bsi);
689
690           if (TREE_CODE (target) != LABEL_EXPR)
691             break;
692
693           if (
694               /* Computed GOTOs.  Make an edge to every label block that has
695                  been marked as a potential target for a computed goto.  */
696               (FORCED_LABEL (LABEL_EXPR_LABEL (target)) && for_call == 0)
697               /* Nonlocal GOTO target.  Make an edge to every label block
698                  that has been marked as a potential target for a nonlocal
699                  goto.  */
700               || (DECL_NONLOCAL (LABEL_EXPR_LABEL (target)) && for_call == 1))
701             {
702               make_edge (bb, target_bb, EDGE_ABNORMAL);
703               break;
704             }
705         }
706     }
707
708   /* Degenerate case of computed goto with no labels.  */
709   if (!for_call && !bb->succ)
710     make_edge (bb, EXIT_BLOCK_PTR, EDGE_FAKE);
711 }
712
713
714 /*---------------------------------------------------------------------------
715                                Flowgraph analysis
716 ---------------------------------------------------------------------------*/
717
718 /* Remove unreachable blocks and other miscellaneous clean up work.  */
719
720 void
721 cleanup_tree_cfg (void)
722 {
723   bool something_changed = true;
724
725   timevar_push (TV_TREE_CLEANUP_CFG);
726
727   /* These three transformations can cascade, so we iterate on them until
728      nothing changes.  */
729   while (something_changed)
730     {
731       something_changed = cleanup_control_flow ();
732       something_changed |= delete_unreachable_blocks ();
733       something_changed |= thread_jumps ();
734     }
735
736   /* Merging the blocks creates no new opportunities for the other
737      optimizations, so do it here.  */
738   merge_seq_blocks ();
739
740   compact_blocks ();
741
742 #ifdef ENABLE_CHECKING
743   verify_flow_info ();
744 #endif
745   timevar_pop (TV_TREE_CLEANUP_CFG);
746 }
747
748
749 /* Cleanup useless labels in basic blocks.  This is something we wish
750    to do early because it allows us to group case labels before creating
751    the edges for the CFG, and it speeds up block statement iterators in
752    all passes later on.
753    We only run this pass once, running it more than once is probably not
754    profitable.  */
755
756 /* A map from basic block index to the leading label of that block.  */
757 static tree *label_for_bb;
758
759 /* Callback for for_each_eh_region.  Helper for cleanup_dead_labels.  */
760 static void
761 update_eh_label (struct eh_region *region)
762 {
763   tree old_label = get_eh_region_tree_label (region);
764   if (old_label)
765     {
766       tree new_label;
767       basic_block bb = label_to_block (old_label);
768
769       /* ??? After optimizing, there may be EH regions with labels
770          that have already been removed from the function body, so
771          there is no basic block for them.  */
772       if (! bb)
773         return;
774
775       new_label = label_for_bb[bb->index];
776       set_eh_region_tree_label (region, new_label);
777     }
778 }
779
780 /* Given LABEL return the first label in the same basic block.  */
781 static tree
782 main_block_label (tree label)
783 {
784   basic_block bb = label_to_block (label);
785
786   /* label_to_block possibly inserted undefined label into the chain.  */
787   if (!label_for_bb[bb->index])
788     label_for_bb[bb->index] = label;
789   return label_for_bb[bb->index];
790 }
791
792 /* Cleanup redundant labels.  This is a three-steo process:
793      1) Find the leading label for each block.
794      2) Redirect all references to labels to the leading labels.
795      3) Cleanup all useless labels.  */
796
797 void
798 cleanup_dead_labels (void)
799 {
800   basic_block bb;
801   label_for_bb = xcalloc (last_basic_block, sizeof (tree));
802
803   /* Find a suitable label for each block.  We use the first user-defined
804      label is there is one, or otherwise just the first label we see.  */
805   FOR_EACH_BB (bb)
806     {
807       block_stmt_iterator i;
808
809       for (i = bsi_start (bb); !bsi_end_p (i); bsi_next (&i))
810         {
811           tree label, stmt = bsi_stmt (i);
812
813           if (TREE_CODE (stmt) != LABEL_EXPR)
814             break;
815
816           label = LABEL_EXPR_LABEL (stmt);
817
818           /* If we have not yet seen a label for the current block,
819              remember this one and see if there are more labels.  */
820           if (! label_for_bb[bb->index])
821             {
822               label_for_bb[bb->index] = label;
823               continue;
824             }
825
826           /* If we did see a label for the current block already, but it
827              is an artificially created label, replace it if the current
828              label is a user defined label.  */
829           if (! DECL_ARTIFICIAL (label)
830               && DECL_ARTIFICIAL (label_for_bb[bb->index]))
831             {
832               label_for_bb[bb->index] = label;
833               break;
834             }
835         }
836     }
837
838   /* Now redirect all jumps/branches to the selected label.
839      First do so for each block ending in a control statement.  */
840   FOR_EACH_BB (bb)
841     {
842       tree stmt = last_stmt (bb);
843       if (!stmt)
844         continue;
845
846       switch (TREE_CODE (stmt))
847         {
848         case COND_EXPR:
849           {
850             tree true_branch, false_branch;
851
852             true_branch = COND_EXPR_THEN (stmt);
853             false_branch = COND_EXPR_ELSE (stmt);
854
855             GOTO_DESTINATION (true_branch)
856               = main_block_label (GOTO_DESTINATION (true_branch));
857             GOTO_DESTINATION (false_branch)
858               = main_block_label (GOTO_DESTINATION (false_branch));
859
860             break;
861           }
862   
863         case SWITCH_EXPR:
864           {
865             size_t i;
866             tree vec = SWITCH_LABELS (stmt);
867             size_t n = TREE_VEC_LENGTH (vec);
868   
869             /* Replace all destination labels.  */
870             for (i = 0; i < n; ++i)
871               CASE_LABEL (TREE_VEC_ELT (vec, i))
872                 = main_block_label (CASE_LABEL (TREE_VEC_ELT (vec, i)));
873   
874             break;
875           }
876
877         /* We have to handle GOTO_EXPRs until they're removed, and we don't
878            remove them until after we've created the CFG edges.  */
879         case GOTO_EXPR:
880           if (! computed_goto_p (stmt))
881             {
882               GOTO_DESTINATION (stmt)
883                 = main_block_label (GOTO_DESTINATION (stmt));
884               break;
885             }
886
887         default:
888           break;
889       }
890     }
891
892   for_each_eh_region (update_eh_label);
893
894   /* Finally, purge dead labels.  All user-defined labels and labels that
895      can be the target of non-local gotos are preserved.  */
896   FOR_EACH_BB (bb)
897     {
898       block_stmt_iterator i;
899       tree label_for_this_bb = label_for_bb[bb->index];
900
901       if (! label_for_this_bb)
902         continue;
903
904       for (i = bsi_start (bb); !bsi_end_p (i); )
905         {
906           tree label, stmt = bsi_stmt (i);
907
908           if (TREE_CODE (stmt) != LABEL_EXPR)
909             break;
910
911           label = LABEL_EXPR_LABEL (stmt);
912
913           if (label == label_for_this_bb
914               || ! DECL_ARTIFICIAL (label)
915               || DECL_NONLOCAL (label))
916             bsi_next (&i);
917           else
918             bsi_remove (&i);
919         }
920     }
921
922   free (label_for_bb);
923 }
924
925 /* Look for blocks ending in a multiway branch (a SWITCH_EXPR in GIMPLE),
926    and scan the sorted vector of cases.  Combine the ones jumping to the
927    same label.
928    Eg. three separate entries 1: 2: 3: become one entry 1..3:  */
929
930 void
931 group_case_labels (void)
932 {
933   basic_block bb;
934
935   FOR_EACH_BB (bb)
936     {
937       tree stmt = last_stmt (bb);
938       if (stmt && TREE_CODE (stmt) == SWITCH_EXPR)
939         {
940           tree labels = SWITCH_LABELS (stmt);
941           int old_size = TREE_VEC_LENGTH (labels);
942           int i, j, new_size = old_size;
943           tree default_label = TREE_VEC_ELT (labels, old_size - 1);
944
945           /* Look for possible opportunities to merge cases.
946              Ignore the last element of the label vector because it
947              must be the default case.  */
948           i = 0;
949           while (i < old_size - 2)
950             {
951               tree base_case, base_label, base_high, type;
952               base_case = TREE_VEC_ELT (labels, i);
953
954               if (! base_case)
955                 abort ();
956
957               base_label = CASE_LABEL (base_case);
958
959               /* Discard cases that have the same destination as the
960                  default case.  */
961               if (base_label == default_label)
962                 {
963                   TREE_VEC_ELT (labels, i) = NULL_TREE;
964                   i++;
965                   continue;
966                 }
967
968               type = TREE_TYPE (CASE_LOW (base_case));
969               base_high = CASE_HIGH (base_case) ?
970                 CASE_HIGH (base_case) : CASE_LOW (base_case);
971
972               /* Try to merge case labels.  Break out when we reach the end
973                  of the label vector or when we cannot merge the next case
974                  label with the current one.  */
975               while (i < old_size - 2)
976                 {
977                   tree merge_case = TREE_VEC_ELT (labels, ++i);
978                   tree merge_label = CASE_LABEL (merge_case);
979                   tree t = int_const_binop (PLUS_EXPR, base_high,
980                                             integer_one_node, 1);
981
982                   /* Merge the cases if they jump to the same place,
983                      and their ranges are consecutive.  */
984                   if (merge_label == base_label
985                       && tree_int_cst_equal (CASE_LOW (merge_case), t))
986                     {
987                       base_high = CASE_HIGH (merge_case) ?
988                         CASE_HIGH (merge_case) : CASE_LOW (merge_case);
989                       CASE_HIGH (base_case) = base_high;
990                       TREE_VEC_ELT (labels, i) = NULL_TREE;
991                       new_size--;
992                     }
993                   else
994                     break;
995                 }
996             }
997
998           /* Compress the case labels in the label vector, and adjust the
999              length of the vector.  */
1000           for (i = 0, j = 0; i < new_size; i++)
1001             {
1002               while (! TREE_VEC_ELT (labels, j))
1003                 j++;
1004               TREE_VEC_ELT (labels, i) = TREE_VEC_ELT (labels, j++);
1005             }
1006           TREE_VEC_LENGTH (labels) = new_size;
1007         }
1008     }
1009 }
1010
1011 /* Checks whether we can merge block B into block A.  */
1012
1013 static bool
1014 tree_can_merge_blocks_p (basic_block a, basic_block b)
1015 {
1016   tree stmt;
1017   block_stmt_iterator bsi;
1018
1019   if (!a->succ
1020       || a->succ->succ_next)
1021     return false;
1022
1023   if (a->succ->flags & EDGE_ABNORMAL)
1024     return false;
1025
1026   if (a->succ->dest != b)
1027     return false;
1028
1029   if (b == EXIT_BLOCK_PTR)
1030     return false;
1031   
1032   if (b->pred->pred_next)
1033     return false;
1034
1035   /* If A ends by a statement causing exceptions or something similar, we
1036      cannot merge the blocks.  */
1037   stmt = last_stmt (a);
1038   if (stmt && stmt_ends_bb_p (stmt))
1039     return false;
1040
1041   /* Do not allow a block with only a non-local label to be merged.  */
1042   if (stmt && TREE_CODE (stmt) == LABEL_EXPR
1043       && DECL_NONLOCAL (LABEL_EXPR_LABEL (stmt)))
1044     return false;
1045
1046   /* There may be no phi nodes at the start of b.  Most of these degenerate
1047      phi nodes should be cleaned up by kill_redundant_phi_nodes.  */
1048   if (phi_nodes (b))
1049     return false;
1050
1051   /* Do not remove user labels.  */
1052   for (bsi = bsi_start (b); !bsi_end_p (bsi); bsi_next (&bsi))
1053     {
1054       stmt = bsi_stmt (bsi);
1055       if (TREE_CODE (stmt) != LABEL_EXPR)
1056         break;
1057       if (!DECL_ARTIFICIAL (LABEL_EXPR_LABEL (stmt)))
1058         return false;
1059     }
1060
1061   return true;
1062 }
1063
1064
1065 /* Merge block B into block A.  */
1066
1067 static void
1068 tree_merge_blocks (basic_block a, basic_block b)
1069 {
1070   block_stmt_iterator bsi;
1071   tree_stmt_iterator last;
1072
1073   if (dump_file)
1074     fprintf (dump_file, "Merging blocks %d and %d\n", a->index, b->index);
1075
1076   /* Ensure that B follows A.  */
1077   move_block_after (b, a);
1078
1079   if (!(a->succ->flags & EDGE_FALLTHRU))
1080     abort ();
1081
1082   if (last_stmt (a)
1083       && stmt_ends_bb_p (last_stmt (a)))
1084     abort ();
1085
1086   /* Remove labels from B and set bb_for_stmt to A for other statements.  */
1087   for (bsi = bsi_start (b); !bsi_end_p (bsi);)
1088     {
1089       if (TREE_CODE (bsi_stmt (bsi)) == LABEL_EXPR)
1090         bsi_remove (&bsi);
1091       else
1092         {
1093           set_bb_for_stmt (bsi_stmt (bsi), a);
1094           bsi_next (&bsi);
1095         }
1096     }
1097
1098   /* Merge the chains.  */
1099   last = tsi_last (a->stmt_list);
1100   tsi_link_after (&last, b->stmt_list, TSI_NEW_STMT);
1101   b->stmt_list = NULL;
1102 }
1103
1104
1105 /* Walk the function tree removing unnecessary statements.
1106
1107      * Empty statement nodes are removed
1108
1109      * Unnecessary TRY_FINALLY and TRY_CATCH blocks are removed
1110
1111      * Unnecessary COND_EXPRs are removed
1112
1113      * Some unnecessary BIND_EXPRs are removed
1114
1115    Clearly more work could be done.  The trick is doing the analysis
1116    and removal fast enough to be a net improvement in compile times.
1117
1118    Note that when we remove a control structure such as a COND_EXPR
1119    BIND_EXPR, or TRY block, we will need to repeat this optimization pass
1120    to ensure we eliminate all the useless code.  */
1121
1122 struct rus_data
1123 {
1124   tree *last_goto;
1125   bool repeat;
1126   bool may_throw;
1127   bool may_branch;
1128   bool has_label;
1129 };
1130
1131 static void remove_useless_stmts_1 (tree *, struct rus_data *);
1132
1133 static bool
1134 remove_useless_stmts_warn_notreached (tree stmt)
1135 {
1136   if (EXPR_HAS_LOCATION (stmt))
1137     {
1138       location_t loc = EXPR_LOCATION (stmt);
1139       warning ("%Hwill never be executed", &loc);
1140       return true;
1141     }
1142
1143   switch (TREE_CODE (stmt))
1144     {
1145     case STATEMENT_LIST:
1146       {
1147         tree_stmt_iterator i;
1148         for (i = tsi_start (stmt); !tsi_end_p (i); tsi_next (&i))
1149           if (remove_useless_stmts_warn_notreached (tsi_stmt (i)))
1150             return true;
1151       }
1152       break;
1153
1154     case COND_EXPR:
1155       if (remove_useless_stmts_warn_notreached (COND_EXPR_COND (stmt)))
1156         return true;
1157       if (remove_useless_stmts_warn_notreached (COND_EXPR_THEN (stmt)))
1158         return true;
1159       if (remove_useless_stmts_warn_notreached (COND_EXPR_ELSE (stmt)))
1160         return true;
1161       break;
1162
1163     case TRY_FINALLY_EXPR:
1164     case TRY_CATCH_EXPR:
1165       if (remove_useless_stmts_warn_notreached (TREE_OPERAND (stmt, 0)))
1166         return true;
1167       if (remove_useless_stmts_warn_notreached (TREE_OPERAND (stmt, 1)))
1168         return true;
1169       break;
1170
1171     case CATCH_EXPR:
1172       return remove_useless_stmts_warn_notreached (CATCH_BODY (stmt));
1173     case EH_FILTER_EXPR:
1174       return remove_useless_stmts_warn_notreached (EH_FILTER_FAILURE (stmt));
1175     case BIND_EXPR:
1176       return remove_useless_stmts_warn_notreached (BIND_EXPR_BLOCK (stmt));
1177
1178     default:
1179       /* Not a live container.  */
1180       break;
1181     }
1182
1183   return false;
1184 }
1185
1186 static void
1187 remove_useless_stmts_cond (tree *stmt_p, struct rus_data *data)
1188 {
1189   tree then_clause, else_clause, cond;
1190   bool save_has_label, then_has_label, else_has_label;
1191
1192   save_has_label = data->has_label;
1193   data->has_label = false;
1194   data->last_goto = NULL;
1195
1196   remove_useless_stmts_1 (&COND_EXPR_THEN (*stmt_p), data);
1197
1198   then_has_label = data->has_label;
1199   data->has_label = false;
1200   data->last_goto = NULL;
1201
1202   remove_useless_stmts_1 (&COND_EXPR_ELSE (*stmt_p), data);
1203
1204   else_has_label = data->has_label;
1205   data->has_label = save_has_label | then_has_label | else_has_label;
1206
1207   fold_stmt (stmt_p);
1208   then_clause = COND_EXPR_THEN (*stmt_p);
1209   else_clause = COND_EXPR_ELSE (*stmt_p);
1210   cond = COND_EXPR_COND (*stmt_p);
1211
1212   /* If neither arm does anything at all, we can remove the whole IF.  */
1213   if (!TREE_SIDE_EFFECTS (then_clause) && !TREE_SIDE_EFFECTS (else_clause))
1214     {
1215       *stmt_p = build_empty_stmt ();
1216       data->repeat = true;
1217     }
1218
1219   /* If there are no reachable statements in an arm, then we can
1220      zap the entire conditional.  */
1221   else if (integer_nonzerop (cond) && !else_has_label)
1222     {
1223       if (warn_notreached)
1224         remove_useless_stmts_warn_notreached (else_clause);
1225       *stmt_p = then_clause;
1226       data->repeat = true;
1227     }
1228   else if (integer_zerop (cond) && !then_has_label)
1229     {
1230       if (warn_notreached)
1231         remove_useless_stmts_warn_notreached (then_clause);
1232       *stmt_p = else_clause;
1233       data->repeat = true;
1234     }
1235
1236   /* Check a couple of simple things on then/else with single stmts.  */
1237   else
1238     {
1239       tree then_stmt = expr_only (then_clause);
1240       tree else_stmt = expr_only (else_clause);
1241
1242       /* Notice branches to a common destination.  */
1243       if (then_stmt && else_stmt
1244           && TREE_CODE (then_stmt) == GOTO_EXPR
1245           && TREE_CODE (else_stmt) == GOTO_EXPR
1246           && (GOTO_DESTINATION (then_stmt) == GOTO_DESTINATION (else_stmt)))
1247         {
1248           *stmt_p = then_stmt;
1249           data->repeat = true;
1250         }
1251
1252       /* If the THEN/ELSE clause merely assigns a value to a variable or
1253          parameter which is already known to contain that value, then
1254          remove the useless THEN/ELSE clause.  */
1255       else if (TREE_CODE (cond) == VAR_DECL || TREE_CODE (cond) == PARM_DECL)
1256         {
1257           if (else_stmt
1258               && TREE_CODE (else_stmt) == MODIFY_EXPR
1259               && TREE_OPERAND (else_stmt, 0) == cond
1260               && integer_zerop (TREE_OPERAND (else_stmt, 1)))
1261             COND_EXPR_ELSE (*stmt_p) = alloc_stmt_list ();
1262         }
1263       else if ((TREE_CODE (cond) == EQ_EXPR || TREE_CODE (cond) == NE_EXPR)
1264                && (TREE_CODE (TREE_OPERAND (cond, 0)) == VAR_DECL
1265                    || TREE_CODE (TREE_OPERAND (cond, 0)) == PARM_DECL)
1266                && TREE_CONSTANT (TREE_OPERAND (cond, 1)))
1267         {
1268           tree stmt = (TREE_CODE (cond) == EQ_EXPR
1269                        ? then_stmt : else_stmt);
1270           tree *location = (TREE_CODE (cond) == EQ_EXPR
1271                             ? &COND_EXPR_THEN (*stmt_p)
1272                             : &COND_EXPR_ELSE (*stmt_p));
1273
1274           if (stmt
1275               && TREE_CODE (stmt) == MODIFY_EXPR
1276               && TREE_OPERAND (stmt, 0) == TREE_OPERAND (cond, 0)
1277               && TREE_OPERAND (stmt, 1) == TREE_OPERAND (cond, 1))
1278             *location = alloc_stmt_list ();
1279         }
1280     }
1281
1282   /* Protect GOTOs in the arm of COND_EXPRs from being removed.  They
1283      would be re-introduced during lowering.  */
1284   data->last_goto = NULL;
1285 }
1286
1287
1288 static void
1289 remove_useless_stmts_tf (tree *stmt_p, struct rus_data *data)
1290 {
1291   bool save_may_branch, save_may_throw;
1292   bool this_may_branch, this_may_throw;
1293
1294   /* Collect may_branch and may_throw information for the body only.  */
1295   save_may_branch = data->may_branch;
1296   save_may_throw = data->may_throw;
1297   data->may_branch = false;
1298   data->may_throw = false;
1299   data->last_goto = NULL;
1300
1301   remove_useless_stmts_1 (&TREE_OPERAND (*stmt_p, 0), data);
1302
1303   this_may_branch = data->may_branch;
1304   this_may_throw = data->may_throw;
1305   data->may_branch |= save_may_branch;
1306   data->may_throw |= save_may_throw;
1307   data->last_goto = NULL;
1308
1309   remove_useless_stmts_1 (&TREE_OPERAND (*stmt_p, 1), data);
1310
1311   /* If the body is empty, then we can emit the FINALLY block without
1312      the enclosing TRY_FINALLY_EXPR.  */
1313   if (!TREE_SIDE_EFFECTS (TREE_OPERAND (*stmt_p, 0)))
1314     {
1315       *stmt_p = TREE_OPERAND (*stmt_p, 1);
1316       data->repeat = true;
1317     }
1318
1319   /* If the handler is empty, then we can emit the TRY block without
1320      the enclosing TRY_FINALLY_EXPR.  */
1321   else if (!TREE_SIDE_EFFECTS (TREE_OPERAND (*stmt_p, 1)))
1322     {
1323       *stmt_p = TREE_OPERAND (*stmt_p, 0);
1324       data->repeat = true;
1325     }
1326
1327   /* If the body neither throws, nor branches, then we can safely
1328      string the TRY and FINALLY blocks together.  */
1329   else if (!this_may_branch && !this_may_throw)
1330     {
1331       tree stmt = *stmt_p;
1332       *stmt_p = TREE_OPERAND (stmt, 0);
1333       append_to_statement_list (TREE_OPERAND (stmt, 1), stmt_p);
1334       data->repeat = true;
1335     }
1336 }
1337
1338
1339 static void
1340 remove_useless_stmts_tc (tree *stmt_p, struct rus_data *data)
1341 {
1342   bool save_may_throw, this_may_throw;
1343   tree_stmt_iterator i;
1344   tree stmt;
1345
1346   /* Collect may_throw information for the body only.  */
1347   save_may_throw = data->may_throw;
1348   data->may_throw = false;
1349   data->last_goto = NULL;
1350
1351   remove_useless_stmts_1 (&TREE_OPERAND (*stmt_p, 0), data);
1352
1353   this_may_throw = data->may_throw;
1354   data->may_throw = save_may_throw;
1355
1356   /* If the body cannot throw, then we can drop the entire TRY_CATCH_EXPR.  */
1357   if (!this_may_throw)
1358     {
1359       if (warn_notreached)
1360         remove_useless_stmts_warn_notreached (TREE_OPERAND (*stmt_p, 1));
1361       *stmt_p = TREE_OPERAND (*stmt_p, 0);
1362       data->repeat = true;
1363       return;
1364     }
1365
1366   /* Process the catch clause specially.  We may be able to tell that
1367      no exceptions propagate past this point.  */
1368
1369   this_may_throw = true;
1370   i = tsi_start (TREE_OPERAND (*stmt_p, 1));
1371   stmt = tsi_stmt (i);
1372   data->last_goto = NULL;
1373
1374   switch (TREE_CODE (stmt))
1375     {
1376     case CATCH_EXPR:
1377       for (; !tsi_end_p (i); tsi_next (&i))
1378         {
1379           stmt = tsi_stmt (i);
1380           /* If we catch all exceptions, then the body does not
1381              propagate exceptions past this point.  */
1382           if (CATCH_TYPES (stmt) == NULL)
1383             this_may_throw = false;
1384           data->last_goto = NULL;
1385           remove_useless_stmts_1 (&CATCH_BODY (stmt), data);
1386         }
1387       break;
1388
1389     case EH_FILTER_EXPR:
1390       if (EH_FILTER_MUST_NOT_THROW (stmt))
1391         this_may_throw = false;
1392       else if (EH_FILTER_TYPES (stmt) == NULL)
1393         this_may_throw = false;
1394       remove_useless_stmts_1 (&EH_FILTER_FAILURE (stmt), data);
1395       break;
1396
1397     default:
1398       /* Otherwise this is a cleanup.  */
1399       remove_useless_stmts_1 (&TREE_OPERAND (*stmt_p, 1), data);
1400
1401       /* If the cleanup is empty, then we can emit the TRY block without
1402          the enclosing TRY_CATCH_EXPR.  */
1403       if (!TREE_SIDE_EFFECTS (TREE_OPERAND (*stmt_p, 1)))
1404         {
1405           *stmt_p = TREE_OPERAND (*stmt_p, 0);
1406           data->repeat = true;
1407         }
1408       break;
1409     }
1410   data->may_throw |= this_may_throw;
1411 }
1412
1413
1414 static void
1415 remove_useless_stmts_bind (tree *stmt_p, struct rus_data *data)
1416 {
1417   tree block;
1418
1419   /* First remove anything underneath the BIND_EXPR.  */
1420   remove_useless_stmts_1 (&BIND_EXPR_BODY (*stmt_p), data);
1421
1422   /* If the BIND_EXPR has no variables, then we can pull everything
1423      up one level and remove the BIND_EXPR, unless this is the toplevel
1424      BIND_EXPR for the current function or an inlined function.
1425
1426      When this situation occurs we will want to apply this
1427      optimization again.  */
1428   block = BIND_EXPR_BLOCK (*stmt_p);
1429   if (BIND_EXPR_VARS (*stmt_p) == NULL_TREE
1430       && *stmt_p != DECL_SAVED_TREE (current_function_decl)
1431       && (! block
1432           || ! BLOCK_ABSTRACT_ORIGIN (block)
1433           || (TREE_CODE (BLOCK_ABSTRACT_ORIGIN (block))
1434               != FUNCTION_DECL)))
1435     {
1436       *stmt_p = BIND_EXPR_BODY (*stmt_p);
1437       data->repeat = true;
1438     }
1439 }
1440
1441
1442 static void
1443 remove_useless_stmts_goto (tree *stmt_p, struct rus_data *data)
1444 {
1445   tree dest = GOTO_DESTINATION (*stmt_p);
1446
1447   data->may_branch = true;
1448   data->last_goto = NULL;
1449
1450   /* Record the last goto expr, so that we can delete it if unnecessary.  */
1451   if (TREE_CODE (dest) == LABEL_DECL)
1452     data->last_goto = stmt_p;
1453 }
1454
1455
1456 static void
1457 remove_useless_stmts_label (tree *stmt_p, struct rus_data *data)
1458 {
1459   tree label = LABEL_EXPR_LABEL (*stmt_p);
1460
1461   data->has_label = true;
1462
1463   /* We do want to jump across non-local label receiver code.  */
1464   if (DECL_NONLOCAL (label))
1465     data->last_goto = NULL;
1466
1467   else if (data->last_goto && GOTO_DESTINATION (*data->last_goto) == label)
1468     {
1469       *data->last_goto = build_empty_stmt ();
1470       data->repeat = true;
1471     }
1472
1473   /* ??? Add something here to delete unused labels.  */
1474 }
1475
1476
1477 /* If the function is "const" or "pure", then clear TREE_SIDE_EFFECTS on its
1478    decl.  This allows us to eliminate redundant or useless
1479    calls to "const" functions. 
1480
1481    Gimplifier already does the same operation, but we may notice functions
1482    being const and pure once their calls has been gimplified, so we need
1483    to update the flag.  */
1484
1485 static void
1486 update_call_expr_flags (tree call)
1487 {
1488   tree decl = get_callee_fndecl (call);
1489   if (!decl)
1490     return;
1491   if (call_expr_flags (call) & (ECF_CONST | ECF_PURE))
1492     TREE_SIDE_EFFECTS (call) = 0;
1493   if (TREE_NOTHROW (decl))
1494     TREE_NOTHROW (call) = 1;
1495 }
1496
1497
1498 /* T is CALL_EXPR.  Set current_function_calls_* flags.  */
1499
1500 void
1501 notice_special_calls (tree t)
1502 {
1503   int flags = call_expr_flags (t);
1504
1505   if (flags & ECF_MAY_BE_ALLOCA)
1506     current_function_calls_alloca = true;
1507   if (flags & ECF_RETURNS_TWICE)
1508     current_function_calls_setjmp = true;
1509 }
1510
1511
1512 /* Clear flags set by notice_special_calls.  Used by dead code removal
1513    to update the flags.  */
1514
1515 void
1516 clear_special_calls (void)
1517 {
1518   current_function_calls_alloca = false;
1519   current_function_calls_setjmp = false;
1520 }
1521
1522
1523 static void
1524 remove_useless_stmts_1 (tree *tp, struct rus_data *data)
1525 {
1526   tree t = *tp, op;
1527
1528   switch (TREE_CODE (t))
1529     {
1530     case COND_EXPR:
1531       remove_useless_stmts_cond (tp, data);
1532       break;
1533
1534     case TRY_FINALLY_EXPR:
1535       remove_useless_stmts_tf (tp, data);
1536       break;
1537
1538     case TRY_CATCH_EXPR:
1539       remove_useless_stmts_tc (tp, data);
1540       break;
1541
1542     case BIND_EXPR:
1543       remove_useless_stmts_bind (tp, data);
1544       break;
1545
1546     case GOTO_EXPR:
1547       remove_useless_stmts_goto (tp, data);
1548       break;
1549
1550     case LABEL_EXPR:
1551       remove_useless_stmts_label (tp, data);
1552       break;
1553
1554     case RETURN_EXPR:
1555       fold_stmt (tp);
1556       data->last_goto = NULL;
1557       data->may_branch = true;
1558       break;
1559
1560     case CALL_EXPR:
1561       fold_stmt (tp);
1562       data->last_goto = NULL;
1563       notice_special_calls (t);
1564       update_call_expr_flags (t);
1565       if (tree_could_throw_p (t))
1566         data->may_throw = true;
1567       break;
1568
1569     case MODIFY_EXPR:
1570       data->last_goto = NULL;
1571       fold_stmt (tp);
1572       op = get_call_expr_in (t);
1573       if (op)
1574         {
1575           update_call_expr_flags (op);
1576           notice_special_calls (op);
1577         }
1578       if (tree_could_throw_p (t))
1579         data->may_throw = true;
1580       break;
1581
1582     case STATEMENT_LIST:
1583       {
1584         tree_stmt_iterator i = tsi_start (t);
1585         while (!tsi_end_p (i))
1586           {
1587             t = tsi_stmt (i);
1588             if (IS_EMPTY_STMT (t))
1589               {
1590                 tsi_delink (&i);
1591                 continue;
1592               }
1593             
1594             remove_useless_stmts_1 (tsi_stmt_ptr (i), data);
1595
1596             t = tsi_stmt (i);
1597             if (TREE_CODE (t) == STATEMENT_LIST)
1598               {
1599                 tsi_link_before (&i, t, TSI_SAME_STMT);
1600                 tsi_delink (&i);
1601               }
1602             else
1603               tsi_next (&i);
1604           }
1605       }
1606       break;
1607     case SWITCH_EXPR:
1608       fold_stmt (tp);
1609       data->last_goto = NULL;
1610       break;
1611
1612     default:
1613       data->last_goto = NULL;
1614       break;
1615     }
1616 }
1617
1618 static void
1619 remove_useless_stmts (void)
1620 {
1621   struct rus_data data;
1622
1623   clear_special_calls ();
1624
1625   do
1626     {
1627       memset (&data, 0, sizeof (data));
1628       remove_useless_stmts_1 (&DECL_SAVED_TREE (current_function_decl), &data);
1629     }
1630   while (data.repeat);
1631 }
1632
1633
1634 struct tree_opt_pass pass_remove_useless_stmts = 
1635 {
1636   "useless",                            /* name */
1637   NULL,                                 /* gate */
1638   remove_useless_stmts,                 /* execute */
1639   NULL,                                 /* sub */
1640   NULL,                                 /* next */
1641   0,                                    /* static_pass_number */
1642   0,                                    /* tv_id */
1643   PROP_gimple_any,                      /* properties_required */
1644   0,                                    /* properties_provided */
1645   0,                                    /* properties_destroyed */
1646   0,                                    /* todo_flags_start */
1647   TODO_dump_func                        /* todo_flags_finish */
1648 };
1649
1650
1651 /* Remove obviously useless statements in basic block BB.  */
1652
1653 static void
1654 cfg_remove_useless_stmts_bb (basic_block bb)
1655 {
1656   block_stmt_iterator bsi;
1657   tree stmt = NULL_TREE;
1658   tree cond, var = NULL_TREE, val = NULL_TREE;
1659   struct var_ann_d *ann;
1660
1661   /* Check whether we come here from a condition, and if so, get the
1662      condition.  */
1663   if (!bb->pred
1664       || bb->pred->pred_next
1665       || !(bb->pred->flags & (EDGE_TRUE_VALUE | EDGE_FALSE_VALUE)))
1666     return;
1667
1668   cond = COND_EXPR_COND (last_stmt (bb->pred->src));
1669
1670   if (TREE_CODE (cond) == VAR_DECL || TREE_CODE (cond) == PARM_DECL)
1671     {
1672       var = cond;
1673       val = (bb->pred->flags & EDGE_FALSE_VALUE
1674              ? boolean_false_node : boolean_true_node);
1675     }
1676   else if (TREE_CODE (cond) == TRUTH_NOT_EXPR
1677            && (TREE_CODE (TREE_OPERAND (cond, 0)) == VAR_DECL
1678                || TREE_CODE (TREE_OPERAND (cond, 0)) == PARM_DECL))
1679     {
1680       var = TREE_OPERAND (cond, 0);
1681       val = (bb->pred->flags & EDGE_FALSE_VALUE
1682              ? boolean_true_node : boolean_false_node);
1683     }
1684   else
1685     {
1686       if (bb->pred->flags & EDGE_FALSE_VALUE)
1687         cond = invert_truthvalue (cond);
1688       if (TREE_CODE (cond) == EQ_EXPR
1689           && (TREE_CODE (TREE_OPERAND (cond, 0)) == VAR_DECL
1690               || TREE_CODE (TREE_OPERAND (cond, 0)) == PARM_DECL)
1691           && (TREE_CODE (TREE_OPERAND (cond, 1)) == VAR_DECL
1692               || TREE_CODE (TREE_OPERAND (cond, 1)) == PARM_DECL
1693               || TREE_CONSTANT (TREE_OPERAND (cond, 1))))
1694         {
1695           var = TREE_OPERAND (cond, 0);
1696           val = TREE_OPERAND (cond, 1);
1697         }
1698       else
1699         return;
1700     }
1701
1702   /* Only work for normal local variables.  */
1703   ann = var_ann (var);
1704   if (!ann
1705       || ann->may_aliases
1706       || TREE_ADDRESSABLE (var))
1707     return;
1708
1709   if (! TREE_CONSTANT (val))
1710     {
1711       ann = var_ann (val);
1712       if (!ann
1713           || ann->may_aliases
1714           || TREE_ADDRESSABLE (val))
1715         return;
1716     }
1717
1718   /* Ignore floating point variables, since comparison behaves weird for
1719      them.  */
1720   if (FLOAT_TYPE_P (TREE_TYPE (var)))
1721     return;
1722
1723   for (bsi = bsi_start (bb); !bsi_end_p (bsi);)
1724     {
1725       stmt = bsi_stmt (bsi);
1726
1727       /* If the THEN/ELSE clause merely assigns a value to a variable/parameter
1728          which is already known to contain that value, then remove the useless
1729          THEN/ELSE clause.  */
1730       if (TREE_CODE (stmt) == MODIFY_EXPR
1731           && TREE_OPERAND (stmt, 0) == var
1732           && operand_equal_p (val, TREE_OPERAND (stmt, 1), 0))
1733         {
1734           bsi_remove (&bsi);
1735           continue;
1736         }
1737
1738       /* Invalidate the var if we encounter something that could modify it.  */
1739       if (TREE_CODE (stmt) == ASM_EXPR
1740           || (TREE_CODE (stmt) == MODIFY_EXPR
1741               && TREE_OPERAND (stmt, 0) == var))
1742         return;
1743   
1744       bsi_next (&bsi);
1745     }
1746 }
1747
1748
1749 /* A CFG-aware version of remove_useless_stmts.  */
1750
1751 void
1752 cfg_remove_useless_stmts (void)
1753 {
1754   basic_block bb;
1755
1756 #ifdef ENABLE_CHECKING
1757   verify_flow_info ();
1758 #endif
1759
1760   FOR_EACH_BB (bb)
1761     {
1762       cfg_remove_useless_stmts_bb (bb);
1763     }
1764 }
1765
1766
1767 /* Remove PHI nodes associated with basic block BB and all edges out of BB.  */
1768
1769 static void
1770 remove_phi_nodes_and_edges_for_unreachable_block (basic_block bb)
1771 {
1772   tree phi;
1773
1774   /* Since this block is no longer reachable, we can just delete all
1775      of its PHI nodes.  */
1776   phi = phi_nodes (bb);
1777   while (phi)
1778     {
1779       tree next = PHI_CHAIN (phi);
1780       remove_phi_node (phi, NULL_TREE, bb);
1781       phi = next;
1782     }
1783
1784   /* Remove edges to BB's successors.  */
1785   while (bb->succ != NULL)
1786     ssa_remove_edge (bb->succ);
1787 }
1788
1789
1790 /* Remove statements of basic block BB.  */
1791
1792 static void
1793 remove_bb (basic_block bb)
1794 {
1795   block_stmt_iterator i;
1796   source_locus loc = 0;
1797
1798   if (dump_file)
1799     {
1800       fprintf (dump_file, "Removing basic block %d\n", bb->index);
1801       if (dump_flags & TDF_DETAILS)
1802         {
1803           dump_bb (bb, dump_file, 0);
1804           fprintf (dump_file, "\n");
1805         }
1806     }
1807
1808   /* Remove all the instructions in the block.  */
1809   for (i = bsi_start (bb); !bsi_end_p (i); bsi_remove (&i))
1810     {
1811       tree stmt = bsi_stmt (i);
1812
1813       set_bb_for_stmt (stmt, NULL);
1814
1815       /* Don't warn for removed gotos.  Gotos are often removed due to
1816          jump threading, thus resulting in bogus warnings.  Not great,
1817          since this way we lose warnings for gotos in the original
1818          program that are indeed unreachable.  */
1819       if (TREE_CODE (stmt) != GOTO_EXPR && EXPR_HAS_LOCATION (stmt) && !loc)
1820 #ifdef USE_MAPPED_LOCATION
1821         loc = EXPR_LOCATION (stmt);
1822 #else
1823         loc = EXPR_LOCUS (stmt);
1824 #endif
1825     }
1826
1827   /* If requested, give a warning that the first statement in the
1828      block is unreachable.  We walk statements backwards in the
1829      loop above, so the last statement we process is the first statement
1830      in the block.  */
1831   if (warn_notreached && loc)
1832 #ifdef USE_MAPPED_LOCATION
1833     warning ("%Hwill never be executed", &loc);
1834 #else
1835     warning ("%Hwill never be executed", loc);
1836 #endif
1837
1838   remove_phi_nodes_and_edges_for_unreachable_block (bb);
1839 }
1840
1841
1842 /* Examine BB to determine if it is a forwarding block (a block which only
1843    transfers control to a new destination).  If BB is a forwarding block,
1844    then return the edge leading to the ultimate destination.  */
1845
1846 edge
1847 tree_block_forwards_to (basic_block bb)
1848 {
1849   block_stmt_iterator bsi;
1850   bb_ann_t ann = bb_ann (bb);
1851   tree stmt;
1852
1853   /* If this block is not forwardable, then avoid useless work.  */
1854   if (! ann->forwardable)
1855     return NULL;
1856
1857   /* Set this block to not be forwardable.  This prevents infinite loops since
1858      any block currently under examination is considered non-forwardable.  */
1859   ann->forwardable = 0;
1860
1861   /* No forwarding is possible if this block is a special block (ENTRY/EXIT),
1862      this block has more than one successor, this block's single successor is
1863      reached via an abnormal edge, this block has phi nodes, or this block's
1864      single successor has phi nodes.  */
1865   if (bb == EXIT_BLOCK_PTR
1866       || bb == ENTRY_BLOCK_PTR
1867       || !bb->succ
1868       || bb->succ->succ_next
1869       || bb->succ->dest == EXIT_BLOCK_PTR
1870       || (bb->succ->flags & EDGE_ABNORMAL) != 0
1871       || phi_nodes (bb)
1872       || phi_nodes (bb->succ->dest))
1873     return NULL;
1874
1875   /* Walk past any labels at the start of this block.  */
1876   for (bsi = bsi_start (bb); !bsi_end_p (bsi); bsi_next (&bsi))
1877     {
1878       stmt = bsi_stmt (bsi);
1879       if (TREE_CODE (stmt) != LABEL_EXPR)
1880         break;
1881     }
1882
1883   /* If we reached the end of this block we may be able to optimize this
1884      case.  */
1885   if (bsi_end_p (bsi))
1886     {
1887       edge dest;
1888
1889       /* Recursive call to pick up chains of forwarding blocks.  */
1890       dest = tree_block_forwards_to (bb->succ->dest);
1891
1892       /* If none found, we forward to bb->succ at minimum.  */
1893       if (!dest)
1894         dest = bb->succ;
1895
1896       ann->forwardable = 1;
1897       return dest;
1898     }
1899
1900   /* No forwarding possible.  */
1901   return NULL;
1902 }
1903
1904
1905 /* Try to remove superfluous control structures.  */
1906
1907 static bool
1908 cleanup_control_flow (void)
1909 {
1910   basic_block bb;
1911   block_stmt_iterator bsi;
1912   bool retval = false;
1913   tree stmt;
1914
1915   FOR_EACH_BB (bb)
1916     {
1917       bsi = bsi_last (bb);
1918
1919       if (bsi_end_p (bsi))
1920         continue;
1921       
1922       stmt = bsi_stmt (bsi);
1923       if (TREE_CODE (stmt) == COND_EXPR
1924           || TREE_CODE (stmt) == SWITCH_EXPR)
1925         retval |= cleanup_control_expr_graph (bb, bsi);
1926     }
1927   return retval;
1928 }
1929
1930
1931 /* Disconnect an unreachable block in the control expression starting
1932    at block BB.  */
1933
1934 static bool
1935 cleanup_control_expr_graph (basic_block bb, block_stmt_iterator bsi)
1936 {
1937   edge taken_edge;
1938   bool retval = false;
1939   tree expr = bsi_stmt (bsi), val;
1940
1941   if (bb->succ->succ_next)
1942     {
1943       edge e, next;
1944
1945       switch (TREE_CODE (expr))
1946         {
1947         case COND_EXPR:
1948           val = COND_EXPR_COND (expr);
1949           break;
1950
1951         case SWITCH_EXPR:
1952           val = SWITCH_COND (expr);
1953           if (TREE_CODE (val) != INTEGER_CST)
1954             return false;
1955           break;
1956
1957         default:
1958           abort ();
1959         }
1960
1961       taken_edge = find_taken_edge (bb, val);
1962       if (!taken_edge)
1963         return false;
1964
1965       /* Remove all the edges except the one that is always executed.  */
1966       for (e = bb->succ; e; e = next)
1967         {
1968           next = e->succ_next;
1969           if (e != taken_edge)
1970             {
1971               taken_edge->probability += e->probability;
1972               taken_edge->count += e->count;
1973               ssa_remove_edge (e);
1974               retval = true;
1975             }
1976         }
1977       if (taken_edge->probability > REG_BR_PROB_BASE)
1978         taken_edge->probability = REG_BR_PROB_BASE;
1979     }
1980   else
1981     taken_edge = bb->succ;
1982
1983   bsi_remove (&bsi);
1984   taken_edge->flags = EDGE_FALLTHRU;
1985
1986   /* We removed some paths from the cfg.  */
1987   if (dom_computed[CDI_DOMINATORS] >= DOM_CONS_OK)
1988     dom_computed[CDI_DOMINATORS] = DOM_CONS_OK;
1989
1990   return retval;
1991 }
1992
1993
1994 /* Given a control block BB and a predicate VAL, return the edge that
1995    will be taken out of the block.  If VAL does not match a unique
1996    edge, NULL is returned. */
1997
1998 edge
1999 find_taken_edge (basic_block bb, tree val)
2000 {
2001   tree stmt;
2002
2003   stmt = last_stmt (bb);
2004
2005 #if defined ENABLE_CHECKING
2006   if (stmt == NULL_TREE || !is_ctrl_stmt (stmt))
2007     abort ();
2008 #endif
2009
2010   /* If VAL is a predicate of the form N RELOP N, where N is an
2011      SSA_NAME, we can always determine its truth value (except when
2012      doing floating point comparisons that may involve NaNs).  */
2013   if (val
2014       && TREE_CODE_CLASS (TREE_CODE (val)) == '<'
2015       && TREE_OPERAND (val, 0) == TREE_OPERAND (val, 1)
2016       && TREE_CODE (TREE_OPERAND (val, 0)) == SSA_NAME
2017       && (TREE_CODE (TREE_TYPE (TREE_OPERAND (val, 0))) != REAL_TYPE
2018           || !HONOR_NANS (TYPE_MODE (TREE_TYPE (TREE_OPERAND (val, 0))))))
2019     {
2020       enum tree_code code = TREE_CODE (val);
2021
2022       if (code == EQ_EXPR || code == LE_EXPR || code == GE_EXPR)
2023         val = boolean_true_node;
2024       else if (code == LT_EXPR || code == GT_EXPR || code == NE_EXPR)
2025         val = boolean_false_node;
2026     }
2027
2028   /* If VAL is not a constant, we can't determine which edge might
2029      be taken.  */
2030   if (val == NULL || !really_constant_p (val))
2031     return NULL;
2032
2033   if (TREE_CODE (stmt) == COND_EXPR)
2034     return find_taken_edge_cond_expr (bb, val);
2035
2036   if (TREE_CODE (stmt) == SWITCH_EXPR)
2037     return find_taken_edge_switch_expr (bb, val);
2038
2039   return bb->succ;
2040 }
2041
2042
2043 /* Given a constant value VAL and the entry block BB to a COND_EXPR
2044    statement, determine which of the two edges will be taken out of the
2045    block.  Return NULL if either edge may be taken.  */
2046
2047 static edge
2048 find_taken_edge_cond_expr (basic_block bb, tree val)
2049 {
2050   edge true_edge, false_edge;
2051
2052   extract_true_false_edges_from_block (bb, &true_edge, &false_edge);
2053
2054   /* If both edges of the branch lead to the same basic block, it doesn't
2055      matter which edge is taken.  */
2056   if (true_edge->dest == false_edge->dest)
2057     return true_edge;
2058
2059   /* Otherwise, try to determine which branch of the if() will be taken.
2060      If VAL is a constant but it can't be reduced to a 0 or a 1, then
2061      we don't really know which edge will be taken at runtime.  This
2062      may happen when comparing addresses (e.g., if (&var1 == 4)).  */
2063   if (integer_nonzerop (val))
2064     return true_edge;
2065   else if (integer_zerop (val))
2066     return false_edge;
2067   else
2068     return NULL;
2069 }
2070
2071
2072 /* Given a constant value VAL and the entry block BB to a SWITCH_EXPR
2073    statement, determine which edge will be taken out of the block.  Return
2074    NULL if any edge may be taken.  */
2075
2076 static edge
2077 find_taken_edge_switch_expr (basic_block bb, tree val)
2078 {
2079   tree switch_expr, taken_case;
2080   basic_block dest_bb;
2081   edge e;
2082
2083   if (TREE_CODE (val) != INTEGER_CST)
2084     return NULL;
2085
2086   switch_expr = last_stmt (bb);
2087   taken_case = find_case_label_for_value (switch_expr, val);
2088   dest_bb = label_to_block (CASE_LABEL (taken_case));
2089
2090   e = find_edge (bb, dest_bb);
2091   if (!e)
2092     abort ();
2093   return e;
2094 }
2095
2096
2097 /* Return the CASE_LABEL_EXPR that SWITCH_EXPR will take for VAL.
2098    We can make optimal use here of the fact that the case labels are
2099    sorted: We can do a binary search for a case matching VAL.  */
2100
2101 static tree
2102 find_case_label_for_value (tree switch_expr, tree val)
2103 {
2104   tree vec = SWITCH_LABELS (switch_expr);
2105   size_t low, high, n = TREE_VEC_LENGTH (vec);
2106   tree default_case = TREE_VEC_ELT (vec, n - 1);
2107
2108   for (low = -1, high = n - 1; high - low > 1; )
2109     {
2110       size_t i = (high + low) / 2;
2111       tree t = TREE_VEC_ELT (vec, i);
2112       int cmp;
2113
2114       /* Cache the result of comparing CASE_LOW and val.  */
2115       cmp = tree_int_cst_compare (CASE_LOW (t), val);
2116
2117       if (cmp > 0)
2118         high = i;
2119       else
2120         low = i;
2121
2122       if (CASE_HIGH (t) == NULL)
2123         {
2124           /* A singe-valued case label.  */
2125           if (cmp == 0)
2126             return t;
2127         }
2128       else
2129         {
2130           /* A case range.  We can only handle integer ranges.  */
2131           if (cmp <= 0 && tree_int_cst_compare (CASE_HIGH (t), val) >= 0)
2132             return t;
2133         }
2134     }
2135
2136   return default_case;
2137 }
2138
2139
2140 /* If all the PHI nodes in DEST have alternatives for E1 and E2 and
2141    those alternatives are equal in each of the PHI nodes, then return
2142    true, else return false.  */
2143
2144 static bool
2145 phi_alternatives_equal (basic_block dest, edge e1, edge e2)
2146 {
2147   tree phi, val1, val2;
2148   int n1, n2;
2149
2150   for (phi = phi_nodes (dest); phi; phi = PHI_CHAIN (phi))
2151     {
2152       n1 = phi_arg_from_edge (phi, e1);
2153       n2 = phi_arg_from_edge (phi, e2);
2154
2155 #ifdef ENABLE_CHECKING
2156       if (n1 < 0 || n2 < 0)
2157         abort ();
2158 #endif
2159
2160       val1 = PHI_ARG_DEF (phi, n1);
2161       val2 = PHI_ARG_DEF (phi, n2);
2162
2163       if (!operand_equal_p (val1, val2, 0))
2164         return false;
2165     }
2166
2167   return true;
2168 }
2169
2170
2171 /* Computing the Dominance Frontier:
2172
2173    As described in Morgan, section 3.5, this may be done simply by
2174    walking the dominator tree bottom-up, computing the frontier for
2175    the children before the parent.  When considering a block B,
2176    there are two cases:
2177
2178    (1) A flow graph edge leaving B that does not lead to a child
2179    of B in the dominator tree must be a block that is either equal
2180    to B or not dominated by B.  Such blocks belong in the frontier
2181    of B.
2182
2183    (2) Consider a block X in the frontier of one of the children C
2184    of B.  If X is not equal to B and is not dominated by B, it
2185    is in the frontier of B.  */
2186
2187 static void
2188 compute_dominance_frontiers_1 (bitmap *frontiers, basic_block bb, sbitmap done)
2189 {
2190   edge e;
2191   basic_block c;
2192
2193   SET_BIT (done, bb->index);
2194
2195   /* Do the frontier of the children first.  Not all children in the
2196      dominator tree (blocks dominated by this one) are children in the
2197      CFG, so check all blocks.  */
2198   for (c = first_dom_son (CDI_DOMINATORS, bb);
2199        c;
2200        c = next_dom_son (CDI_DOMINATORS, c))
2201     {
2202       if (! TEST_BIT (done, c->index))
2203         compute_dominance_frontiers_1 (frontiers, c, done);
2204     }
2205       
2206   /* Find blocks conforming to rule (1) above.  */
2207   for (e = bb->succ; e; e = e->succ_next)
2208     {
2209       if (e->dest == EXIT_BLOCK_PTR)
2210         continue;
2211       if (get_immediate_dominator (CDI_DOMINATORS, e->dest) != bb)
2212         bitmap_set_bit (frontiers[bb->index], e->dest->index);
2213     }
2214
2215   /* Find blocks conforming to rule (2).  */
2216   for (c = first_dom_son (CDI_DOMINATORS, bb);
2217        c;
2218        c = next_dom_son (CDI_DOMINATORS, c))
2219     {
2220       int x;
2221
2222       EXECUTE_IF_SET_IN_BITMAP (frontiers[c->index], 0, x,
2223         {
2224           if (get_immediate_dominator (CDI_DOMINATORS, BASIC_BLOCK (x)) != bb)
2225             bitmap_set_bit (frontiers[bb->index], x);
2226         });
2227     }
2228 }
2229
2230
2231 void
2232 compute_dominance_frontiers (bitmap *frontiers)
2233 {
2234   sbitmap done = sbitmap_alloc (last_basic_block);
2235
2236   timevar_push (TV_DOM_FRONTIERS);
2237
2238   sbitmap_zero (done);
2239
2240   compute_dominance_frontiers_1 (frontiers, ENTRY_BLOCK_PTR->succ->dest, done);
2241
2242   sbitmap_free (done);
2243
2244   timevar_pop (TV_DOM_FRONTIERS);
2245 }
2246
2247
2248
2249 /*---------------------------------------------------------------------------
2250                               Debugging functions
2251 ---------------------------------------------------------------------------*/
2252
2253 /* Dump tree-specific information of block BB to file OUTF.  */
2254
2255 void
2256 tree_dump_bb (basic_block bb, FILE *outf, int indent)
2257 {
2258   dump_generic_bb (outf, bb, indent, TDF_VOPS);
2259 }
2260
2261
2262 /* Dump a basic block on stderr.  */
2263
2264 void
2265 debug_tree_bb (basic_block bb)
2266 {
2267   dump_bb (bb, stderr, 0);
2268 }
2269
2270
2271 /* Dump basic block with index N on stderr.  */
2272
2273 basic_block
2274 debug_tree_bb_n (int n)
2275 {
2276   debug_tree_bb (BASIC_BLOCK (n));
2277   return BASIC_BLOCK (n);
2278 }        
2279
2280
2281 /* Dump the CFG on stderr.
2282
2283    FLAGS are the same used by the tree dumping functions
2284    (see TDF_* in tree.h).  */
2285
2286 void
2287 debug_tree_cfg (int flags)
2288 {
2289   dump_tree_cfg (stderr, flags);
2290 }
2291
2292
2293 /* Dump the program showing basic block boundaries on the given FILE.
2294
2295    FLAGS are the same used by the tree dumping functions (see TDF_* in
2296    tree.h).  */
2297
2298 void
2299 dump_tree_cfg (FILE *file, int flags)
2300 {
2301   if (flags & TDF_DETAILS)
2302     {
2303       const char *funcname
2304         = lang_hooks.decl_printable_name (current_function_decl, 2);
2305
2306       fputc ('\n', file);
2307       fprintf (file, ";; Function %s\n\n", funcname);
2308       fprintf (file, ";; \n%d basic blocks, %d edges, last basic block %d.\n\n",
2309                n_basic_blocks, n_edges, last_basic_block);
2310
2311       brief_dump_cfg (file);
2312       fprintf (file, "\n");
2313     }
2314
2315   if (flags & TDF_STATS)
2316     dump_cfg_stats (file);
2317
2318   dump_function_to_file (current_function_decl, file, flags | TDF_BLOCKS);
2319 }
2320
2321
2322 /* Dump CFG statistics on FILE.  */
2323
2324 void
2325 dump_cfg_stats (FILE *file)
2326 {
2327   static long max_num_merged_labels = 0;
2328   unsigned long size, total = 0;
2329   int n_edges;
2330   basic_block bb;
2331   const char * const fmt_str   = "%-30s%-13s%12s\n";
2332   const char * const fmt_str_1 = "%-30s%13d%11lu%c\n";
2333   const char * const fmt_str_3 = "%-43s%11lu%c\n";
2334   const char *funcname
2335     = lang_hooks.decl_printable_name (current_function_decl, 2);
2336
2337
2338   fprintf (file, "\nCFG Statistics for %s\n\n", funcname);
2339
2340   fprintf (file, "---------------------------------------------------------\n");
2341   fprintf (file, fmt_str, "", "  Number of  ", "Memory");
2342   fprintf (file, fmt_str, "", "  instances  ", "used ");
2343   fprintf (file, "---------------------------------------------------------\n");
2344
2345   size = n_basic_blocks * sizeof (struct basic_block_def);
2346   total += size;
2347   fprintf (file, fmt_str_1, "Basic blocks", n_basic_blocks,
2348            SCALE (size), LABEL (size));
2349
2350   n_edges = 0;
2351   FOR_EACH_BB (bb)
2352     {
2353       edge e;
2354       for (e = bb->succ; e; e = e->succ_next)
2355         n_edges++;
2356     }
2357   size = n_edges * sizeof (struct edge_def);
2358   total += size;
2359   fprintf (file, fmt_str_1, "Edges", n_edges, SCALE (size), LABEL (size));
2360
2361   size = n_basic_blocks * sizeof (struct bb_ann_d);
2362   total += size;
2363   fprintf (file, fmt_str_1, "Basic block annotations", n_basic_blocks,
2364            SCALE (size), LABEL (size));
2365
2366   fprintf (file, "---------------------------------------------------------\n");
2367   fprintf (file, fmt_str_3, "Total memory used by CFG data", SCALE (total),
2368            LABEL (total));
2369   fprintf (file, "---------------------------------------------------------\n");
2370   fprintf (file, "\n");
2371
2372   if (cfg_stats.num_merged_labels > max_num_merged_labels)
2373     max_num_merged_labels = cfg_stats.num_merged_labels;
2374
2375   fprintf (file, "Coalesced label blocks: %ld (Max so far: %ld)\n",
2376            cfg_stats.num_merged_labels, max_num_merged_labels);
2377
2378   fprintf (file, "\n");
2379 }
2380
2381
2382 /* Dump CFG statistics on stderr.  Keep extern so that it's always
2383    linked in the final executable.  */
2384
2385 void
2386 debug_cfg_stats (void)
2387 {
2388   dump_cfg_stats (stderr);
2389 }
2390
2391
2392 /* Dump the flowgraph to a .vcg FILE.  */
2393
2394 static void
2395 tree_cfg2vcg (FILE *file)
2396 {
2397   edge e;
2398   basic_block bb;
2399   const char *funcname
2400     = lang_hooks.decl_printable_name (current_function_decl, 2);
2401
2402   /* Write the file header.  */
2403   fprintf (file, "graph: { title: \"%s\"\n", funcname);
2404   fprintf (file, "node: { title: \"ENTRY\" label: \"ENTRY\" }\n");
2405   fprintf (file, "node: { title: \"EXIT\" label: \"EXIT\" }\n");
2406
2407   /* Write blocks and edges.  */
2408   for (e = ENTRY_BLOCK_PTR->succ; e; e = e->succ_next)
2409     {
2410       fprintf (file, "edge: { sourcename: \"ENTRY\" targetname: \"%d\"",
2411                e->dest->index);
2412
2413       if (e->flags & EDGE_FAKE)
2414         fprintf (file, " linestyle: dotted priority: 10");
2415       else
2416         fprintf (file, " linestyle: solid priority: 100");
2417
2418       fprintf (file, " }\n");
2419     }
2420   fputc ('\n', file);
2421
2422   FOR_EACH_BB (bb)
2423     {
2424       enum tree_code head_code, end_code;
2425       const char *head_name, *end_name;
2426       int head_line = 0;
2427       int end_line = 0;
2428       tree first = first_stmt (bb);
2429       tree last = last_stmt (bb);
2430
2431       if (first)
2432         {
2433           head_code = TREE_CODE (first);
2434           head_name = tree_code_name[head_code];
2435           head_line = get_lineno (first);
2436         }
2437       else
2438         head_name = "no-statement";
2439
2440       if (last)
2441         {
2442           end_code = TREE_CODE (last);
2443           end_name = tree_code_name[end_code];
2444           end_line = get_lineno (last);
2445         }
2446       else
2447         end_name = "no-statement";
2448
2449       fprintf (file, "node: { title: \"%d\" label: \"#%d\\n%s (%d)\\n%s (%d)\"}\n",
2450                bb->index, bb->index, head_name, head_line, end_name,
2451                end_line);
2452
2453       for (e = bb->succ; e; e = e->succ_next)
2454         {
2455           if (e->dest == EXIT_BLOCK_PTR)
2456             fprintf (file, "edge: { sourcename: \"%d\" targetname: \"EXIT\"", bb->index);
2457           else
2458             fprintf (file, "edge: { sourcename: \"%d\" targetname: \"%d\"", bb->index, e->dest->index);
2459
2460           if (e->flags & EDGE_FAKE)
2461             fprintf (file, " priority: 10 linestyle: dotted");
2462           else
2463             fprintf (file, " priority: 100 linestyle: solid");
2464
2465           fprintf (file, " }\n");
2466         }
2467
2468       if (bb->next_bb != EXIT_BLOCK_PTR)
2469         fputc ('\n', file);
2470     }
2471
2472   fputs ("}\n\n", file);
2473 }
2474
2475
2476
2477 /*---------------------------------------------------------------------------
2478                              Miscellaneous helpers
2479 ---------------------------------------------------------------------------*/
2480
2481 /* Return true if T represents a stmt that always transfers control.  */
2482
2483 bool
2484 is_ctrl_stmt (tree t)
2485 {
2486   return (TREE_CODE (t) == COND_EXPR
2487           || TREE_CODE (t) == SWITCH_EXPR
2488           || TREE_CODE (t) == GOTO_EXPR
2489           || TREE_CODE (t) == RETURN_EXPR
2490           || TREE_CODE (t) == RESX_EXPR);
2491 }
2492
2493
2494 /* Return true if T is a statement that may alter the flow of control
2495    (e.g., a call to a non-returning function).  */
2496
2497 bool
2498 is_ctrl_altering_stmt (tree t)
2499 {
2500   tree call;
2501
2502 #if defined ENABLE_CHECKING
2503   if (t == NULL)
2504     abort ();
2505 #endif
2506
2507   call = get_call_expr_in (t);
2508   if (call)
2509     {
2510       /* A non-pure/const CALL_EXPR alters flow control if the current
2511          function has nonlocal labels.  */
2512       if (TREE_SIDE_EFFECTS (call) && current_function_has_nonlocal_label)
2513         return true;
2514
2515       /* A CALL_EXPR also alters control flow if it does not return.  */
2516       if (call_expr_flags (call) & (ECF_NORETURN | ECF_LONGJMP))
2517         return true;
2518     }
2519
2520   /* If a statement can throw, it alters control flow.  */
2521   return tree_can_throw_internal (t);
2522 }
2523
2524
2525 /* Return true if T is a computed goto.  */
2526
2527 bool
2528 computed_goto_p (tree t)
2529 {
2530   return (TREE_CODE (t) == GOTO_EXPR
2531           && TREE_CODE (GOTO_DESTINATION (t)) != LABEL_DECL);
2532 }
2533
2534
2535 /* Checks whether EXPR is a simple local goto.  */
2536
2537 bool
2538 simple_goto_p (tree expr)
2539 {
2540   return (TREE_CODE (expr) == GOTO_EXPR
2541           && TREE_CODE (GOTO_DESTINATION (expr)) == LABEL_DECL);
2542 }
2543
2544
2545 /* Return true if T should start a new basic block.  PREV_T is the
2546    statement preceding T.  It is used when T is a label or a case label.
2547    Labels should only start a new basic block if their previous statement
2548    wasn't a label.  Otherwise, sequence of labels would generate
2549    unnecessary basic blocks that only contain a single label.  */
2550
2551 static inline bool
2552 stmt_starts_bb_p (tree t, tree prev_t)
2553 {
2554   enum tree_code code;
2555
2556   if (t == NULL_TREE)
2557     return false;
2558
2559   /* LABEL_EXPRs start a new basic block only if the preceding
2560      statement wasn't a label of the same type.  This prevents the
2561      creation of consecutive blocks that have nothing but a single
2562      label.  */
2563   code = TREE_CODE (t);
2564   if (code == LABEL_EXPR)
2565     {
2566       /* Nonlocal and computed GOTO targets always start a new block.  */
2567       if (code == LABEL_EXPR
2568           && (DECL_NONLOCAL (LABEL_EXPR_LABEL (t))
2569               || FORCED_LABEL (LABEL_EXPR_LABEL (t))))
2570         return true;
2571
2572       if (prev_t && TREE_CODE (prev_t) == code)
2573         {
2574           if (DECL_NONLOCAL (LABEL_EXPR_LABEL (prev_t)))
2575             return true;
2576
2577           cfg_stats.num_merged_labels++;
2578           return false;
2579         }
2580       else
2581         return true;
2582     }
2583
2584   return false;
2585 }
2586
2587
2588 /* Return true if T should end a basic block.  */
2589
2590 bool
2591 stmt_ends_bb_p (tree t)
2592 {
2593   return is_ctrl_stmt (t) || is_ctrl_altering_stmt (t);
2594 }
2595
2596
2597 /* Add gotos that used to be represented implicitly in the CFG.  */
2598
2599 void
2600 disband_implicit_edges (void)
2601 {
2602   basic_block bb;
2603   block_stmt_iterator last;
2604   edge e;
2605   tree stmt, label;
2606
2607   FOR_EACH_BB (bb)
2608     {
2609       last = bsi_last (bb);
2610       stmt = last_stmt (bb);
2611
2612       if (stmt && TREE_CODE (stmt) == COND_EXPR)
2613         {
2614           /* Remove superfluous gotos from COND_EXPR branches.  Moved
2615              from cfg_remove_useless_stmts here since it violates the
2616              invariants for tree--cfg correspondence and thus fits better
2617              here where we do it anyway.  */
2618           for (e = bb->succ; e; e = e->succ_next)
2619             {
2620               if (e->dest != bb->next_bb)
2621                 continue;
2622
2623               if (e->flags & EDGE_TRUE_VALUE)
2624                 COND_EXPR_THEN (stmt) = build_empty_stmt ();
2625               else if (e->flags & EDGE_FALSE_VALUE)
2626                 COND_EXPR_ELSE (stmt) = build_empty_stmt ();
2627               else
2628                 abort ();
2629               e->flags |= EDGE_FALLTHRU;
2630             }
2631
2632           continue;
2633         }
2634
2635       if (stmt && TREE_CODE (stmt) == RETURN_EXPR)
2636         {
2637           /* Remove the RETURN_EXPR if we may fall though to the exit
2638              instead.  */
2639           if (!bb->succ
2640               || bb->succ->succ_next
2641               || bb->succ->dest != EXIT_BLOCK_PTR)
2642             abort ();
2643
2644           if (bb->next_bb == EXIT_BLOCK_PTR
2645               && !TREE_OPERAND (stmt, 0))
2646             {
2647               bsi_remove (&last);
2648               bb->succ->flags |= EDGE_FALLTHRU;
2649             }
2650           continue;
2651         }
2652
2653       /* There can be no fallthru edge if the last statement is a control
2654          one.  */
2655       if (stmt && is_ctrl_stmt (stmt))
2656         continue;
2657
2658       /* Find a fallthru edge and emit the goto if necessary.  */
2659       for (e = bb->succ; e; e = e->succ_next)
2660         if (e->flags & EDGE_FALLTHRU)
2661           break;
2662
2663       if (!e || e->dest == bb->next_bb)
2664         continue;
2665
2666       if (e->dest == EXIT_BLOCK_PTR)
2667         abort ();
2668
2669       label = tree_block_label (e->dest);
2670
2671       stmt = build1 (GOTO_EXPR, void_type_node, label);
2672 #ifdef USE_MAPPED_LOCATION
2673       SET_EXPR_LOCATION (stmt, e->goto_locus);
2674 #else
2675       SET_EXPR_LOCUS (stmt, e->goto_locus);
2676 #endif
2677       bsi_insert_after (&last, stmt, BSI_NEW_STMT);
2678       e->flags &= ~EDGE_FALLTHRU;
2679     }
2680 }
2681
2682 /* Remove block annotations and other datastructures.  */
2683
2684 void
2685 delete_tree_cfg_annotations (void)
2686 {
2687   basic_block bb;
2688   if (n_basic_blocks > 0)
2689     free_blocks_annotations ();
2690
2691   label_to_block_map = NULL;
2692   free_rbi_pool ();
2693   FOR_EACH_BB (bb)
2694     bb->rbi = NULL;
2695 }
2696
2697
2698 /* Return the first statement in basic block BB.  */
2699
2700 tree
2701 first_stmt (basic_block bb)
2702 {
2703   block_stmt_iterator i = bsi_start (bb);
2704   return !bsi_end_p (i) ? bsi_stmt (i) : NULL_TREE;
2705 }
2706
2707
2708 /* Return the last statement in basic block BB.  */
2709
2710 tree
2711 last_stmt (basic_block bb)
2712 {
2713   block_stmt_iterator b = bsi_last (bb);
2714   return !bsi_end_p (b) ? bsi_stmt (b) : NULL_TREE;
2715 }
2716
2717
2718 /* Return a pointer to the last statement in block BB.  */
2719
2720 tree *
2721 last_stmt_ptr (basic_block bb)
2722 {
2723   block_stmt_iterator last = bsi_last (bb);
2724   return !bsi_end_p (last) ? bsi_stmt_ptr (last) : NULL;
2725 }
2726
2727
2728 /* Return the last statement of an otherwise empty block.  Return NULL
2729    if the block is totally empty, or if it contains more than one
2730    statement.  */
2731
2732 tree
2733 last_and_only_stmt (basic_block bb)
2734 {
2735   block_stmt_iterator i = bsi_last (bb);
2736   tree last, prev;
2737
2738   if (bsi_end_p (i))
2739     return NULL_TREE;
2740
2741   last = bsi_stmt (i);
2742   bsi_prev (&i);
2743   if (bsi_end_p (i))
2744     return last;
2745
2746   /* Empty statements should no longer appear in the instruction stream.
2747      Everything that might have appeared before should be deleted by
2748      remove_useless_stmts, and the optimizers should just bsi_remove
2749      instead of smashing with build_empty_stmt.
2750
2751      Thus the only thing that should appear here in a block containing
2752      one executable statement is a label.  */
2753   prev = bsi_stmt (i);
2754   if (TREE_CODE (prev) == LABEL_EXPR)
2755     return last;
2756   else
2757     return NULL_TREE;
2758 }
2759
2760
2761 /* Mark BB as the basic block holding statement T.  */
2762
2763 void
2764 set_bb_for_stmt (tree t, basic_block bb)
2765 {
2766   if (TREE_CODE (t) == STATEMENT_LIST)
2767     {
2768       tree_stmt_iterator i;
2769       for (i = tsi_start (t); !tsi_end_p (i); tsi_next (&i))
2770         set_bb_for_stmt (tsi_stmt (i), bb);
2771     }
2772   else
2773     {
2774       stmt_ann_t ann = get_stmt_ann (t);
2775       ann->bb = bb;
2776
2777       /* If the statement is a label, add the label to block-to-labels map
2778          so that we can speed up edge creation for GOTO_EXPRs.  */
2779       if (TREE_CODE (t) == LABEL_EXPR)
2780         {
2781           int uid;
2782
2783           t = LABEL_EXPR_LABEL (t);
2784           uid = LABEL_DECL_UID (t);
2785           if (uid == -1)
2786             {
2787               LABEL_DECL_UID (t) = uid = cfun->last_label_uid++;
2788               if (VARRAY_SIZE (label_to_block_map) <= (unsigned) uid)
2789                 VARRAY_GROW (label_to_block_map, 3 * uid / 2);
2790             }
2791           else
2792             {
2793 #ifdef ENABLE_CHECKING
2794               /* We're moving an existing label.  Make sure that we've
2795                  removed it from the old block.  */
2796               if (bb && VARRAY_BB (label_to_block_map, uid))
2797                 abort ();
2798 #endif
2799             }
2800           VARRAY_BB (label_to_block_map, uid) = bb;
2801         }
2802     }
2803 }
2804
2805
2806 /* Insert statement (or statement list) T before the statement
2807    pointed-to by iterator I.  M specifies how to update iterator I
2808    after insertion (see enum bsi_iterator_update).  */
2809
2810 void
2811 bsi_insert_before (block_stmt_iterator *i, tree t, enum bsi_iterator_update m)
2812 {
2813   set_bb_for_stmt (t, i->bb);
2814   modify_stmt (t);
2815   tsi_link_before (&i->tsi, t, m);
2816 }
2817
2818
2819 /* Insert statement (or statement list) T after the statement
2820    pointed-to by iterator I.  M specifies how to update iterator I
2821    after insertion (see enum bsi_iterator_update).  */
2822
2823 void
2824 bsi_insert_after (block_stmt_iterator *i, tree t, enum bsi_iterator_update m)
2825 {
2826   set_bb_for_stmt (t, i->bb);
2827   modify_stmt (t);
2828   tsi_link_after (&i->tsi, t, m);
2829 }
2830
2831
2832 /* Remove the statement pointed to by iterator I.  The iterator is updated
2833    to the next statement.  */
2834
2835 void
2836 bsi_remove (block_stmt_iterator *i)
2837 {
2838   tree t = bsi_stmt (*i);
2839   set_bb_for_stmt (t, NULL);
2840   modify_stmt (t);
2841   tsi_delink (&i->tsi);
2842 }
2843
2844
2845 /* Move the statement at FROM so it comes right after the statement at TO.  */
2846
2847 void 
2848 bsi_move_after (block_stmt_iterator *from, block_stmt_iterator *to)
2849 {
2850   tree stmt = bsi_stmt (*from);
2851   bsi_remove (from);
2852   bsi_insert_after (to, stmt, BSI_SAME_STMT);
2853
2854
2855
2856 /* Move the statement at FROM so it comes right before the statement at TO.  */
2857
2858 void 
2859 bsi_move_before (block_stmt_iterator *from, block_stmt_iterator *to)
2860 {
2861   tree stmt = bsi_stmt (*from);
2862   bsi_remove (from);
2863   bsi_insert_before (to, stmt, BSI_SAME_STMT);
2864 }
2865
2866
2867 /* Move the statement at FROM to the end of basic block BB.  */
2868
2869 void
2870 bsi_move_to_bb_end (block_stmt_iterator *from, basic_block bb)
2871 {
2872   block_stmt_iterator last = bsi_last (bb);
2873   
2874   /* Have to check bsi_end_p because it could be an empty block.  */
2875   if (!bsi_end_p (last) && is_ctrl_stmt (bsi_stmt (last)))
2876     bsi_move_before (from, &last);
2877   else
2878     bsi_move_after (from, &last);
2879 }
2880
2881
2882 /* Replace the contents of the statement pointed to by iterator BSI
2883    with STMT.  If PRESERVE_EH_INFO is true, the exception handling
2884    information of the original statement is preserved.  */
2885
2886 void
2887 bsi_replace (const block_stmt_iterator *bsi, tree stmt, bool preserve_eh_info)
2888 {
2889   int eh_region;
2890   tree orig_stmt = bsi_stmt (*bsi);
2891
2892   SET_EXPR_LOCUS (stmt, EXPR_LOCUS (orig_stmt));
2893   set_bb_for_stmt (stmt, bsi->bb);
2894
2895   /* Preserve EH region information from the original statement, if
2896      requested by the caller.  */
2897   if (preserve_eh_info)
2898     {
2899       eh_region = lookup_stmt_eh_region (orig_stmt);
2900       if (eh_region >= 0)
2901         add_stmt_to_eh_region (stmt, eh_region);
2902     }
2903
2904   *bsi_stmt_ptr (*bsi) = stmt;
2905   modify_stmt (stmt);
2906 }
2907
2908
2909 /* Insert the statement pointed-to by BSI into edge E.  Every attempt
2910    is made to place the statement in an existing basic block, but
2911    sometimes that isn't possible.  When it isn't possible, the edge is
2912    split and the statement is added to the new block.
2913
2914    In all cases, the returned *BSI points to the correct location.  The
2915    return value is true if insertion should be done after the location,
2916    or false if it should be done before the location.  */
2917
2918 static bool
2919 tree_find_edge_insert_loc (edge e, block_stmt_iterator *bsi)
2920 {
2921   basic_block dest, src;
2922   tree tmp;
2923
2924   dest = e->dest;
2925  restart:
2926
2927   /* If the destination has one predecessor which has no PHI nodes,
2928      insert there.  Except for the exit block. 
2929
2930      The requirement for no PHI nodes could be relaxed.  Basically we
2931      would have to examine the PHIs to prove that none of them used
2932      the value set by the statement we want to insert on E.   That
2933      hardly seems worth the effort.  */
2934   if (dest->pred->pred_next == NULL
2935       && ! phi_nodes (dest)
2936       && dest != EXIT_BLOCK_PTR)
2937     {
2938       *bsi = bsi_start (dest);
2939       if (bsi_end_p (*bsi))
2940         return true;
2941
2942       /* Make sure we insert after any leading labels.  */
2943       tmp = bsi_stmt (*bsi);
2944       while (TREE_CODE (tmp) == LABEL_EXPR)
2945         {
2946           bsi_next (bsi);
2947           if (bsi_end_p (*bsi))
2948             break;
2949           tmp = bsi_stmt (*bsi);
2950         }
2951
2952       if (bsi_end_p (*bsi))
2953         {
2954           *bsi = bsi_last (dest);
2955           return true;
2956         }
2957       else
2958         return false;
2959     }
2960
2961   /* If the source has one successor, the edge is not abnormal and
2962      the last statement does not end a basic block, insert there.
2963      Except for the entry block.  */
2964   src = e->src;
2965   if ((e->flags & EDGE_ABNORMAL) == 0
2966       && src->succ->succ_next == NULL
2967       && src != ENTRY_BLOCK_PTR)
2968     {
2969       *bsi = bsi_last (src);
2970       if (bsi_end_p (*bsi))
2971         return true;
2972
2973       tmp = bsi_stmt (*bsi);
2974       if (!stmt_ends_bb_p (tmp))
2975         return true;
2976
2977       /* Insert code just before returning the value.  We may need to decompose
2978          the return in the case it contains non-trivial operand.  */
2979       if (TREE_CODE (tmp) == RETURN_EXPR)
2980         {
2981           tree op = TREE_OPERAND (tmp, 0);
2982           if (!is_gimple_val (op))
2983             {
2984               if (TREE_CODE (op) != MODIFY_EXPR)
2985                 abort ();
2986               bsi_insert_before (bsi, op, BSI_NEW_STMT);
2987               TREE_OPERAND (tmp, 0) = TREE_OPERAND (op, 0);
2988             }
2989           bsi_prev (bsi);
2990           return true;
2991         }
2992     }
2993
2994   /* Otherwise, create a new basic block, and split this edge.  */
2995   dest = split_edge (e);
2996   e = dest->pred;
2997   goto restart;
2998 }
2999
3000
3001 /* This routine will commit all pending edge insertions, creating any new
3002    basic blocks which are necessary.
3003
3004    If specified, NEW_BLOCKS returns a count of the number of new basic
3005    blocks which were created.  */
3006
3007 void
3008 bsi_commit_edge_inserts (int *new_blocks)
3009 {
3010   basic_block bb;
3011   edge e;
3012   int blocks;
3013
3014   blocks = n_basic_blocks;
3015
3016   bsi_commit_edge_inserts_1 (ENTRY_BLOCK_PTR->succ);
3017
3018   FOR_EACH_BB (bb)
3019     for (e = bb->succ; e; e = e->succ_next)
3020       bsi_commit_edge_inserts_1 (e);
3021
3022   if (new_blocks)
3023     *new_blocks = n_basic_blocks - blocks;
3024 }
3025
3026
3027 /* Commit insertions pending at edge E.  */
3028
3029 static void
3030 bsi_commit_edge_inserts_1 (edge e)
3031 {
3032   if (PENDING_STMT (e))
3033     {
3034       block_stmt_iterator bsi;
3035       tree stmt = PENDING_STMT (e);
3036
3037       PENDING_STMT (e) = NULL_TREE;
3038
3039       if (tree_find_edge_insert_loc (e, &bsi))
3040         bsi_insert_after (&bsi, stmt, BSI_NEW_STMT);
3041       else
3042         bsi_insert_before (&bsi, stmt, BSI_NEW_STMT);
3043     }
3044 }
3045
3046
3047 /* Add STMT to the pending list of edge E.  No actual insertion is
3048    made until a call to bsi_commit_edge_inserts () is made.  */
3049
3050 void
3051 bsi_insert_on_edge (edge e, tree stmt)
3052 {
3053   append_to_statement_list (stmt, &PENDING_STMT (e));
3054 }
3055
3056
3057 /*---------------------------------------------------------------------------
3058              Tree specific functions for CFG manipulation
3059 ---------------------------------------------------------------------------*/
3060
3061 /* Split a (typically critical) edge EDGE_IN.  Return the new block.
3062    Abort on abnormal edges.  */
3063
3064 static basic_block
3065 tree_split_edge (edge edge_in)
3066 {
3067   basic_block new_bb, after_bb, dest, src;
3068   edge new_edge, e;
3069   tree phi;
3070   int i, num_elem;
3071
3072   /* Abnormal edges cannot be split.  */
3073   if (edge_in->flags & EDGE_ABNORMAL)
3074     abort ();
3075
3076   src = edge_in->src;
3077   dest = edge_in->dest;
3078
3079   /* Place the new block in the block list.  Try to keep the new block
3080      near its "logical" location.  This is of most help to humans looking
3081      at debugging dumps.  */
3082   for (e = dest->pred; e; e = e->pred_next)
3083     if (e->src->next_bb == dest)
3084       break;
3085   if (!e)
3086     after_bb = dest->prev_bb;
3087   else
3088     after_bb = edge_in->src;
3089
3090   new_bb = create_empty_bb (after_bb);
3091   new_edge = make_edge (new_bb, dest, EDGE_FALLTHRU);
3092
3093   /* Find all the PHI arguments on the original edge, and change them to
3094      the new edge.  Do it before redirection, so that the argument does not
3095      get removed.  */
3096   for (phi = phi_nodes (dest); phi; phi = PHI_CHAIN (phi))
3097     {
3098       num_elem = PHI_NUM_ARGS (phi);
3099       for (i = 0; i < num_elem; i++)
3100         if (PHI_ARG_EDGE (phi, i) == edge_in)
3101           {
3102             PHI_ARG_EDGE (phi, i) = new_edge;
3103             break;
3104           }
3105     }
3106
3107   if (!redirect_edge_and_branch (edge_in, new_bb))
3108     abort ();
3109
3110   if (PENDING_STMT (edge_in))
3111     abort ();
3112
3113   return new_bb;
3114 }
3115
3116
3117 /* Return true when BB has label LABEL in it.  */
3118
3119 static bool
3120 has_label_p (basic_block bb, tree label)
3121 {
3122   block_stmt_iterator bsi;
3123
3124   for (bsi = bsi_start (bb); !bsi_end_p (bsi); bsi_next (&bsi))
3125     {
3126       tree stmt = bsi_stmt (bsi);
3127
3128       if (TREE_CODE (stmt) != LABEL_EXPR)
3129         return false;
3130       if (LABEL_EXPR_LABEL (stmt) == label)
3131         return true;
3132     }
3133   return false;
3134 }
3135
3136
3137 /* Callback for walk_tree, check that all elements with address taken are
3138    properly noticed as such.  */
3139
3140 static tree
3141 verify_expr (tree *tp, int *walk_subtrees, void *data ATTRIBUTE_UNUSED)
3142 {
3143   tree t = *tp, x;
3144
3145   if (TYPE_P (t))
3146     *walk_subtrees = 0;
3147   
3148   /* Check operand N for being valid GIMPLE and give error MSG if not. 
3149      We check for constants explicitly since they are not considered
3150      gimple invariants if they overflowed.  */
3151 #define CHECK_OP(N, MSG) \
3152   do { if (TREE_CODE_CLASS (TREE_CODE (TREE_OPERAND (t, N))) != 'c'     \
3153          && !is_gimple_val (TREE_OPERAND (t, N)))                       \
3154        { error (MSG); return TREE_OPERAND (t, N); }} while (0)
3155
3156   switch (TREE_CODE (t))
3157     {
3158     case SSA_NAME:
3159       if (SSA_NAME_IN_FREE_LIST (t))
3160         {
3161           error ("SSA name in freelist but still referenced");
3162           return *tp;
3163         }
3164       break;
3165
3166     case MODIFY_EXPR:
3167       x = TREE_OPERAND (t, 0);
3168       if (TREE_CODE (x) == BIT_FIELD_REF
3169           && is_gimple_reg (TREE_OPERAND (x, 0)))
3170         {
3171           error ("GIMPLE register modified with BIT_FIELD_REF");
3172           return t;
3173         }
3174       break;
3175
3176     case ADDR_EXPR:
3177       /* Skip any references (they will be checked when we recurse down the
3178          tree) and ensure that any variable used as a prefix is marked
3179          addressable.  */
3180       for (x = TREE_OPERAND (t, 0);
3181            (handled_component_p (x)
3182             || TREE_CODE (x) == REALPART_EXPR
3183             || TREE_CODE (x) == IMAGPART_EXPR);
3184            x = TREE_OPERAND (x, 0))
3185         ;
3186
3187       if (TREE_CODE (x) != VAR_DECL && TREE_CODE (x) != PARM_DECL)
3188         return NULL;
3189       if (!TREE_ADDRESSABLE (x))
3190         {
3191           error ("address taken, but ADDRESSABLE bit not set");
3192           return x;
3193         }
3194       break;
3195
3196     case COND_EXPR:
3197       x = TREE_OPERAND (t, 0);
3198       if (TREE_CODE (TREE_TYPE (x)) != BOOLEAN_TYPE)
3199         {
3200           error ("non-boolean used in condition");
3201           return x;
3202         }
3203       break;
3204
3205     case NOP_EXPR:
3206     case CONVERT_EXPR:
3207     case FIX_TRUNC_EXPR:
3208     case FIX_CEIL_EXPR:
3209     case FIX_FLOOR_EXPR:
3210     case FIX_ROUND_EXPR:
3211     case FLOAT_EXPR:
3212     case NEGATE_EXPR:
3213     case ABS_EXPR:
3214     case BIT_NOT_EXPR:
3215     case NON_LVALUE_EXPR:
3216     case TRUTH_NOT_EXPR:
3217       CHECK_OP (0, "Invalid operand to unary operator");
3218       break;
3219
3220     case REALPART_EXPR:
3221     case IMAGPART_EXPR:
3222     case COMPONENT_REF:
3223     case ARRAY_REF:
3224     case ARRAY_RANGE_REF:
3225     case BIT_FIELD_REF:
3226     case VIEW_CONVERT_EXPR:
3227       /* We have a nest of references.  Verify that each of the operands
3228          that determine where to reference is either a constant or a variable,
3229          verify that the base is valid, and then show we've already checked
3230          the subtrees.  */
3231       while (TREE_CODE (t) == REALPART_EXPR || TREE_CODE (t) == IMAGPART_EXPR
3232              || handled_component_p (t))
3233         {
3234           if (TREE_CODE (t) == COMPONENT_REF && TREE_OPERAND (t, 2))
3235             CHECK_OP (2, "Invalid COMPONENT_REF offset operator");
3236           else if (TREE_CODE (t) == ARRAY_REF
3237                    || TREE_CODE (t) == ARRAY_RANGE_REF)
3238             {
3239               CHECK_OP (1, "Invalid array index.");
3240               if (TREE_OPERAND (t, 2))
3241                 CHECK_OP (2, "Invalid array lower bound.");
3242               if (TREE_OPERAND (t, 3))
3243                 CHECK_OP (3, "Invalid array stride.");
3244             }
3245           else if (TREE_CODE (t) == BIT_FIELD_REF)
3246             {
3247               CHECK_OP (1, "Invalid operand to BIT_FIELD_REF");
3248               CHECK_OP (2, "Invalid operand to BIT_FIELD_REF");
3249             }
3250
3251           t = TREE_OPERAND (t, 0);
3252         }
3253
3254       if (TREE_CODE_CLASS (TREE_CODE (t)) != 'c'
3255           && !is_gimple_lvalue (t))
3256         {
3257           error ("Invalid reference prefix.");
3258           return t;
3259         }
3260       *walk_subtrees = 0;
3261       break;
3262
3263     case LT_EXPR:
3264     case LE_EXPR:
3265     case GT_EXPR:
3266     case GE_EXPR:
3267     case EQ_EXPR:
3268     case NE_EXPR:
3269     case UNORDERED_EXPR:
3270     case ORDERED_EXPR:
3271     case UNLT_EXPR:
3272     case UNLE_EXPR:
3273     case UNGT_EXPR:
3274     case UNGE_EXPR:
3275     case UNEQ_EXPR:
3276     case LTGT_EXPR:
3277     case PLUS_EXPR:
3278     case MINUS_EXPR:
3279     case MULT_EXPR:
3280     case TRUNC_DIV_EXPR:
3281     case CEIL_DIV_EXPR:
3282     case FLOOR_DIV_EXPR:
3283     case ROUND_DIV_EXPR:
3284     case TRUNC_MOD_EXPR:
3285     case CEIL_MOD_EXPR:
3286     case FLOOR_MOD_EXPR:
3287     case ROUND_MOD_EXPR:
3288     case RDIV_EXPR:
3289     case EXACT_DIV_EXPR:
3290     case MIN_EXPR:
3291     case MAX_EXPR:
3292     case LSHIFT_EXPR:
3293     case RSHIFT_EXPR:
3294     case LROTATE_EXPR:
3295     case RROTATE_EXPR:
3296     case BIT_IOR_EXPR:
3297     case BIT_XOR_EXPR:
3298     case BIT_AND_EXPR:
3299       CHECK_OP (0, "Invalid operand to binary operator");
3300       CHECK_OP (1, "Invalid operand to binary operator");
3301       break;
3302
3303     default:
3304       break;
3305     }
3306   return NULL;
3307
3308 #undef CHECK_OP
3309 }
3310
3311
3312 /* Verify STMT, return true if STMT is not in GIMPLE form.
3313    TODO: Implement type checking.  */
3314
3315 static bool
3316 verify_stmt (tree stmt, bool last_in_block)
3317 {
3318   tree addr;
3319
3320   if (!is_gimple_stmt (stmt))
3321     {
3322       error ("Is not a valid GIMPLE statement.");
3323       goto fail;
3324     }
3325
3326   addr = walk_tree (&stmt, verify_expr, NULL, NULL);
3327   if (addr)
3328     {
3329       debug_generic_stmt (addr);
3330       return true;
3331     }
3332
3333   /* If the statement is marked as part of an EH region, then it is
3334      expected that the statement could throw.  Verify that when we
3335      have optimizations that simplify statements such that we prove
3336      that they cannot throw, that we update other data structures
3337      to match.  */
3338   if (lookup_stmt_eh_region (stmt) >= 0)
3339     {
3340       if (!tree_could_throw_p (stmt))
3341         {
3342           error ("Statement marked for throw, but doesn't.");
3343           goto fail;
3344         }
3345       if (!last_in_block && tree_can_throw_internal (stmt))
3346         {
3347           error ("Statement marked for throw in middle of block.");
3348           goto fail;
3349         }
3350     }
3351
3352   return false;
3353
3354  fail:
3355   debug_generic_stmt (stmt);
3356   return true;
3357 }
3358
3359
3360 /* Return true when the T can be shared.  */
3361
3362 static bool
3363 tree_node_can_be_shared (tree t)
3364 {
3365   if (TYPE_P (t) || DECL_P (t)
3366       /* We check for constants explicitly since they are not considered
3367          gimple invariants if they overflowed.  */
3368       || TREE_CODE_CLASS (TREE_CODE (t)) == 'c'
3369       || is_gimple_min_invariant (t)
3370       || TREE_CODE (t) == SSA_NAME)
3371     return true;
3372
3373   while (((TREE_CODE (t) == ARRAY_REF || TREE_CODE (t) == ARRAY_RANGE_REF)
3374           /* We check for constants explicitly since they are not considered
3375              gimple invariants if they overflowed.  */
3376           && (TREE_CODE_CLASS (TREE_CODE (TREE_OPERAND (t, 1))) == 'c'
3377               || is_gimple_min_invariant (TREE_OPERAND (t, 1))))
3378          || (TREE_CODE (t) == COMPONENT_REF
3379              || TREE_CODE (t) == REALPART_EXPR
3380              || TREE_CODE (t) == IMAGPART_EXPR))
3381     t = TREE_OPERAND (t, 0);
3382
3383   if (DECL_P (t))
3384     return true;
3385
3386   return false;
3387 }
3388
3389
3390 /* Called via walk_trees.  Verify tree sharing.  */
3391
3392 static tree
3393 verify_node_sharing (tree * tp, int *walk_subtrees, void *data)
3394 {
3395   htab_t htab = (htab_t) data;
3396   void **slot;
3397
3398   if (tree_node_can_be_shared (*tp))
3399     {
3400       *walk_subtrees = false;
3401       return NULL;
3402     }
3403
3404   slot = htab_find_slot (htab, *tp, INSERT);
3405   if (*slot)
3406     return *slot;
3407   *slot = *tp;
3408
3409   return NULL;
3410 }
3411
3412
3413 /* Verify the GIMPLE statement chain.  */
3414
3415 void
3416 verify_stmts (void)
3417 {
3418   basic_block bb;
3419   block_stmt_iterator bsi;
3420   bool err = false;
3421   htab_t htab;
3422   tree addr;
3423
3424   timevar_push (TV_TREE_STMT_VERIFY);
3425   htab = htab_create (37, htab_hash_pointer, htab_eq_pointer, NULL);
3426
3427   FOR_EACH_BB (bb)
3428     {
3429       tree phi;
3430       int i;
3431
3432       for (phi = phi_nodes (bb); phi; phi = PHI_CHAIN (phi))
3433         {
3434           int phi_num_args = PHI_NUM_ARGS (phi);
3435
3436           for (i = 0; i < phi_num_args; i++)
3437             {
3438               tree t = PHI_ARG_DEF (phi, i);
3439               tree addr;
3440
3441               /* Addressable variables do have SSA_NAMEs but they
3442                  are not considered gimple values.  */
3443               if (TREE_CODE (t) != SSA_NAME
3444                   && TREE_CODE (t) != FUNCTION_DECL
3445                   && !is_gimple_val (t))
3446                 {
3447                   error ("PHI def is not a GIMPLE value");
3448                   debug_generic_stmt (phi);
3449                   debug_generic_stmt (t);
3450                   err |= true;
3451                 }
3452
3453               addr = walk_tree (&t, verify_expr, NULL, NULL);
3454               if (addr)
3455                 {
3456                   debug_generic_stmt (addr);
3457                   err |= true;
3458                 }
3459
3460               addr = walk_tree (&t, verify_node_sharing, htab, NULL);
3461               if (addr)
3462                 {
3463                   error ("Incorrect sharing of tree nodes");
3464                   debug_generic_stmt (phi);
3465                   debug_generic_stmt (addr);
3466                   err |= true;
3467                 }
3468             }
3469         }
3470
3471       for (bsi = bsi_start (bb); !bsi_end_p (bsi); )
3472         {
3473           tree stmt = bsi_stmt (bsi);
3474           bsi_next (&bsi);
3475           err |= verify_stmt (stmt, bsi_end_p (bsi));
3476           addr = walk_tree (&stmt, verify_node_sharing, htab, NULL);
3477           if (addr)
3478             {
3479               error ("Incorrect sharing of tree nodes");
3480               debug_generic_stmt (stmt);
3481               debug_generic_stmt (addr);
3482               err |= true;
3483             }
3484         }
3485     }
3486
3487   if (err)
3488     internal_error ("verify_stmts failed.");
3489
3490   htab_delete (htab);
3491   timevar_pop (TV_TREE_STMT_VERIFY);
3492 }
3493
3494
3495 /* Verifies that the flow information is OK.  */
3496
3497 static int
3498 tree_verify_flow_info (void)
3499 {
3500   int err = 0;
3501   basic_block bb;
3502   block_stmt_iterator bsi;
3503   tree stmt;
3504   edge e;
3505
3506   if (ENTRY_BLOCK_PTR->stmt_list)
3507     {
3508       error ("ENTRY_BLOCK has a statement list associated with it\n");
3509       err = 1;
3510     }
3511
3512   if (EXIT_BLOCK_PTR->stmt_list)
3513     {
3514       error ("EXIT_BLOCK has a statement list associated with it\n");
3515       err = 1;
3516     }
3517
3518   for (e = EXIT_BLOCK_PTR->pred; e; e = e->pred_next)
3519     if (e->flags & EDGE_FALLTHRU)
3520       {
3521         error ("Fallthru to exit from bb %d\n", e->src->index);
3522         err = 1;
3523       }
3524
3525   FOR_EACH_BB (bb)
3526     {
3527       bool found_ctrl_stmt = false;
3528
3529       /* Skip labels on the start of basic block.  */
3530       for (bsi = bsi_start (bb); !bsi_end_p (bsi); bsi_next (&bsi))
3531         {
3532           if (TREE_CODE (bsi_stmt (bsi)) != LABEL_EXPR)
3533             break;
3534
3535           if (label_to_block (LABEL_EXPR_LABEL (bsi_stmt (bsi))) != bb)
3536             {
3537               error ("Label %s to block does not match in bb %d\n",
3538                      IDENTIFIER_POINTER (DECL_NAME (bsi_stmt (bsi))),
3539                      bb->index);
3540               err = 1;
3541             }
3542
3543           if (decl_function_context (LABEL_EXPR_LABEL (bsi_stmt (bsi)))
3544               != current_function_decl)
3545             {
3546               error ("Label %s has incorrect context in bb %d\n",
3547                      IDENTIFIER_POINTER (DECL_NAME (bsi_stmt (bsi))),
3548                      bb->index);
3549               err = 1;
3550             }
3551         }
3552
3553       /* Verify that body of basic block BB is free of control flow.  */
3554       for (; !bsi_end_p (bsi); bsi_next (&bsi))
3555         {
3556           tree stmt = bsi_stmt (bsi);
3557
3558           if (found_ctrl_stmt)
3559             {
3560               error ("Control flow in the middle of basic block %d\n",
3561                      bb->index);
3562               err = 1;
3563             }
3564
3565           if (stmt_ends_bb_p (stmt))
3566             found_ctrl_stmt = true;
3567
3568           if (TREE_CODE (stmt) == LABEL_EXPR)
3569             {
3570               error ("Label %s in the middle of basic block %d\n",
3571                      IDENTIFIER_POINTER (DECL_NAME (stmt)),
3572                      bb->index);
3573               err = 1;
3574             }
3575         }
3576       bsi = bsi_last (bb);
3577       if (bsi_end_p (bsi))
3578         continue;
3579
3580       stmt = bsi_stmt (bsi);
3581
3582       if (is_ctrl_stmt (stmt))
3583         {
3584           for (e = bb->succ; e; e = e->succ_next)
3585             if (e->flags & EDGE_FALLTHRU)
3586               {
3587                 error ("Fallthru edge after a control statement in bb %d \n",
3588                        bb->index);
3589                 err = 1;
3590               }
3591         }
3592
3593       switch (TREE_CODE (stmt))
3594         {
3595         case COND_EXPR:
3596           {
3597             edge true_edge;
3598             edge false_edge;
3599             if (TREE_CODE (COND_EXPR_THEN (stmt)) != GOTO_EXPR
3600                 || TREE_CODE (COND_EXPR_ELSE (stmt)) != GOTO_EXPR)
3601               {
3602                 error ("Structured COND_EXPR at the end of bb %d\n", bb->index);
3603                 err = 1;
3604               }
3605
3606             extract_true_false_edges_from_block (bb, &true_edge, &false_edge);
3607
3608             if (!true_edge || !false_edge
3609                 || !(true_edge->flags & EDGE_TRUE_VALUE)
3610                 || !(false_edge->flags & EDGE_FALSE_VALUE)
3611                 || (true_edge->flags & (EDGE_FALLTHRU | EDGE_ABNORMAL))
3612                 || (false_edge->flags & (EDGE_FALLTHRU | EDGE_ABNORMAL))
3613                 || bb->succ->succ_next->succ_next)
3614               {
3615                 error ("Wrong outgoing edge flags at end of bb %d\n",
3616                        bb->index);
3617                 err = 1;
3618               }
3619
3620             if (!has_label_p (true_edge->dest,
3621                               GOTO_DESTINATION (COND_EXPR_THEN (stmt))))
3622               {
3623                 error ("`then' label does not match edge at end of bb %d\n",
3624                        bb->index);
3625                 err = 1;
3626               }
3627
3628             if (!has_label_p (false_edge->dest,
3629                               GOTO_DESTINATION (COND_EXPR_ELSE (stmt))))
3630               {
3631                 error ("`else' label does not match edge at end of bb %d\n",
3632                        bb->index);
3633                 err = 1;
3634               }
3635           }
3636           break;
3637
3638         case GOTO_EXPR:
3639           if (simple_goto_p (stmt))
3640             {
3641               error ("Explicit goto at end of bb %d\n", bb->index);
3642               err = 1;
3643             }
3644           else
3645             {
3646               /* FIXME.  We should double check that the labels in the 
3647                  destination blocks have their address taken.  */
3648               for (e = bb->succ; e; e = e->succ_next)
3649                 if ((e->flags & (EDGE_FALLTHRU | EDGE_TRUE_VALUE
3650                                  | EDGE_FALSE_VALUE))
3651                     || !(e->flags & EDGE_ABNORMAL))
3652                   {
3653                     error ("Wrong outgoing edge flags at end of bb %d\n",
3654                            bb->index);
3655                     err = 1;
3656                   }
3657             }
3658           break;
3659
3660         case RETURN_EXPR:
3661           if (!bb->succ || bb->succ->succ_next
3662               || (bb->succ->flags & (EDGE_FALLTHRU | EDGE_ABNORMAL
3663                                      | EDGE_TRUE_VALUE | EDGE_FALSE_VALUE)))
3664             {
3665               error ("Wrong outgoing edge flags at end of bb %d\n", bb->index);
3666               err = 1;
3667             }
3668           if (bb->succ->dest != EXIT_BLOCK_PTR)
3669             {
3670               error ("Return edge does not point to exit in bb %d\n",
3671                      bb->index);
3672               err = 1;
3673             }
3674           break;
3675
3676         case SWITCH_EXPR:
3677           {
3678             tree prev;
3679             edge e;
3680             size_t i, n;
3681             tree vec;
3682
3683             vec = SWITCH_LABELS (stmt);
3684             n = TREE_VEC_LENGTH (vec);
3685
3686             /* Mark all the destination basic blocks.  */
3687             for (i = 0; i < n; ++i)
3688               {
3689                 tree lab = CASE_LABEL (TREE_VEC_ELT (vec, i));
3690                 basic_block label_bb = label_to_block (lab);
3691
3692                 if (label_bb->aux && label_bb->aux != (void *)1)
3693                   abort ();
3694                 label_bb->aux = (void *)1;
3695               }
3696
3697             /* Verify that the case labels are sorted.  */
3698             prev = TREE_VEC_ELT (vec, 0);
3699             for (i = 1; i < n - 1; ++i)
3700               {
3701                 tree c = TREE_VEC_ELT (vec, i);
3702                 if (! CASE_LOW (c))
3703                   {
3704                     error ("Found default case not at end of case vector");
3705                     err = 1;
3706                     continue;
3707                   }
3708                 if (! tree_int_cst_lt (CASE_LOW (prev), CASE_LOW (c)))
3709                   {
3710                     error ("Case labels not sorted:\n ");
3711                     print_generic_expr (stderr, prev, 0);
3712                     fprintf (stderr," is greater than ");
3713                     print_generic_expr (stderr, c, 0);
3714                     fprintf (stderr," but comes before it.\n");
3715                     err = 1;
3716                   }
3717                 prev = c;
3718               }
3719             if (CASE_LOW (TREE_VEC_ELT (vec, n - 1)))
3720               {
3721                 error ("No default case found at end of case vector");
3722                 err = 1;
3723               }
3724
3725             for (e = bb->succ; e; e = e->succ_next)
3726               {
3727                 if (!e->dest->aux)
3728                   {
3729                     error ("Extra outgoing edge %d->%d\n",
3730                            bb->index, e->dest->index);
3731                     err = 1;
3732                   }
3733                 e->dest->aux = (void *)2;
3734                 if ((e->flags & (EDGE_FALLTHRU | EDGE_ABNORMAL
3735                                  | EDGE_TRUE_VALUE | EDGE_FALSE_VALUE)))
3736                   {
3737                     error ("Wrong outgoing edge flags at end of bb %d\n",
3738                            bb->index);
3739                     err = 1;
3740                   }
3741               }
3742
3743             /* Check that we have all of them.  */
3744             for (i = 0; i < n; ++i)
3745               {
3746                 tree lab = CASE_LABEL (TREE_VEC_ELT (vec, i));
3747                 basic_block label_bb = label_to_block (lab);
3748
3749                 if (label_bb->aux != (void *)2)
3750                   {
3751                     error ("Missing edge %i->%i\n",
3752                            bb->index, label_bb->index);
3753                     err = 1;
3754                   }
3755               }
3756
3757             for (e = bb->succ; e; e = e->succ_next)
3758               e->dest->aux = (void *)0;
3759           }
3760
3761         default: ;
3762         }
3763     }
3764
3765   if (dom_computed[CDI_DOMINATORS] >= DOM_NO_FAST_QUERY)
3766     verify_dominators (CDI_DOMINATORS);
3767
3768   return err;
3769 }
3770
3771
3772 /* Updates phi nodes after creating forwarder block joined
3773    by edge FALLTHRU.  */
3774
3775 static void
3776 tree_make_forwarder_block (edge fallthru)
3777 {
3778   edge e;
3779   basic_block dummy, bb;
3780   tree phi, new_phi, var, prev, next;
3781
3782   dummy = fallthru->src;
3783   bb = fallthru->dest;
3784
3785   if (!bb->pred->pred_next)
3786     return;
3787
3788   /* If we redirected a branch we must create new phi nodes at the
3789      start of BB.  */
3790   for (phi = phi_nodes (dummy); phi; phi = PHI_CHAIN (phi))
3791     {
3792       var = PHI_RESULT (phi);
3793       new_phi = create_phi_node (var, bb);
3794       SSA_NAME_DEF_STMT (var) = new_phi;
3795       SET_PHI_RESULT (phi, make_ssa_name (SSA_NAME_VAR (var), phi));
3796       add_phi_arg (&new_phi, PHI_RESULT (phi), fallthru);
3797     }
3798
3799   /* Ensure that the PHI node chain is in the same order.  */
3800   prev = NULL;
3801   for (phi = phi_nodes (bb); phi; phi = next)
3802     {
3803       next = PHI_CHAIN (phi);
3804       PHI_CHAIN (phi) = prev;
3805       prev = phi;
3806     }
3807   set_phi_nodes (bb, prev);
3808
3809   /* Add the arguments we have stored on edges.  */
3810   for (e = bb->pred; e; e = e->pred_next)
3811     {
3812       if (e == fallthru)
3813         continue;
3814
3815       for (phi = phi_nodes (bb), var = PENDING_STMT (e);
3816            phi;
3817            phi = PHI_CHAIN (phi), var = TREE_CHAIN (var))
3818         add_phi_arg (&phi, TREE_VALUE (var), e);
3819
3820       PENDING_STMT (e) = NULL;
3821     }
3822 }
3823
3824
3825 /* Return true if basic block BB does nothing except pass control
3826    flow to another block and that we can safely insert a label at
3827    the start of the successor block.  */
3828
3829 static bool
3830 tree_forwarder_block_p (basic_block bb)
3831 {
3832   block_stmt_iterator bsi;
3833   edge e;
3834
3835   /* If we have already determined that this block is not forwardable,
3836      then no further checks are necessary.  */
3837   if (! bb_ann (bb)->forwardable)
3838     return false;
3839
3840   /* BB must have a single outgoing normal edge.  Otherwise it can not be
3841      a forwarder block.  */
3842   if (!bb->succ
3843       || bb->succ->succ_next
3844       || bb->succ->dest == EXIT_BLOCK_PTR
3845       || (bb->succ->flags & EDGE_ABNORMAL)
3846       || bb == ENTRY_BLOCK_PTR)
3847     {
3848       bb_ann (bb)->forwardable = 0;
3849       return false; 
3850     }
3851
3852   /* Successors of the entry block are not forwarders.  */
3853   for (e = ENTRY_BLOCK_PTR->succ; e; e = e->succ_next)
3854     if (e->dest == bb)
3855       {
3856         bb_ann (bb)->forwardable = 0;
3857         return false;
3858       }
3859
3860   /* BB can not have any PHI nodes.  This could potentially be relaxed
3861      early in compilation if we re-rewrote the variables appearing in
3862      any PHI nodes in forwarder blocks.  */
3863   if (phi_nodes (bb))
3864     {
3865       bb_ann (bb)->forwardable = 0;
3866       return false; 
3867     }
3868
3869   /* Now walk through the statements.  We can ignore labels, anything else
3870      means this is not a forwarder block.  */
3871   for (bsi = bsi_start (bb); !bsi_end_p (bsi); bsi_next (&bsi))
3872     {
3873       tree stmt = bsi_stmt (bsi);
3874  
3875       switch (TREE_CODE (stmt))
3876         {
3877         case LABEL_EXPR:
3878           if (DECL_NONLOCAL (LABEL_EXPR_LABEL (stmt)))
3879             return false;
3880           break;
3881
3882         default:
3883           bb_ann (bb)->forwardable = 0;
3884           return false;
3885         }
3886     }
3887
3888   return true;
3889 }
3890
3891
3892 /* Thread jumps over empty statements.
3893
3894    This code should _not_ thread over obviously equivalent conditions
3895    as that requires nontrivial updates to the SSA graph.  */
3896    
3897 static bool
3898 thread_jumps (void)
3899 {
3900   edge e, next, last, old;
3901   basic_block bb, dest, tmp, old_dest, dom;
3902   tree phi;
3903   int arg;
3904   bool retval = false;
3905
3906   FOR_EACH_BB (bb)
3907     bb_ann (bb)->forwardable = 1;
3908
3909   FOR_BB_BETWEEN (bb, ENTRY_BLOCK_PTR, EXIT_BLOCK_PTR, next_bb)
3910     {
3911       /* Don't waste time on unreachable blocks.  */
3912       if (!bb->pred)
3913         continue;
3914
3915       /* Nor on forwarders.  */
3916       if (tree_forwarder_block_p (bb))
3917         continue;
3918       
3919       /* This block is now part of a forwarding path, mark it as not
3920          forwardable so that we can detect loops.  This bit will be
3921          reset below.  */
3922       bb_ann (bb)->forwardable = 0;
3923
3924       /* Examine each of our block's successors to see if it is
3925          forwardable.  */
3926       for (e = bb->succ; e; e = next)
3927         {
3928           next = e->succ_next;
3929
3930           /* If the edge is abnormal or its destination is not
3931              forwardable, then there's nothing to do.  */
3932           if ((e->flags & EDGE_ABNORMAL)
3933               || !tree_forwarder_block_p (e->dest))
3934             continue;
3935
3936           /* Now walk through as many forwarder block as possible to
3937              find the ultimate destination we want to thread our jump
3938              to.  */
3939           last = e->dest->succ;
3940           bb_ann (e->dest)->forwardable = 0;
3941           for (dest = e->dest->succ->dest;
3942                tree_forwarder_block_p (dest);
3943                last = dest->succ,
3944                dest = dest->succ->dest)
3945             {
3946               /* An infinite loop detected.  We redirect the edge anyway, so
3947                  that the loop is shrunk into single basic block.  */
3948               if (!bb_ann (dest)->forwardable)
3949                 break;
3950
3951               if (dest->succ->dest == EXIT_BLOCK_PTR)
3952                 break;
3953
3954               bb_ann (dest)->forwardable = 0;
3955             }
3956
3957           /* Reset the forwardable marks to 1.  */
3958           for (tmp = e->dest;
3959                tmp != dest;
3960                tmp = tmp->succ->dest)
3961             bb_ann (tmp)->forwardable = 1;
3962
3963           if (dest == e->dest)
3964             continue;
3965               
3966           old = find_edge (bb, dest);
3967           if (old)
3968             {
3969               /* If there already is an edge, check whether the values
3970                  in phi nodes differ.  */
3971               if (!phi_alternatives_equal (dest, last, old))
3972                 {
3973                   /* The previous block is forwarder.  Redirect our jump
3974                      to that target instead since we know it has no PHI
3975                      nodes that will need updating.  */
3976                   dest = last->src;
3977           
3978                   /* That might mean that no forwarding at all is possible.  */
3979                   if (dest == e->dest)
3980                     continue;
3981
3982                   old = find_edge (bb, dest);
3983                 }
3984             }
3985
3986           /* Perform the redirection.  */
3987           retval = true;
3988           old_dest = e->dest;
3989           e = redirect_edge_and_branch (e, dest);
3990
3991           if (!old)
3992             {
3993               /* Update PHI nodes.   We know that the new argument should
3994                  have the same value as the argument associated with LAST.
3995                  Otherwise we would have changed our target block above.  */
3996               for (phi = phi_nodes (dest); phi; phi = PHI_CHAIN (phi))
3997                 {
3998                   arg = phi_arg_from_edge (phi, last);
3999                   if (arg < 0)
4000                     abort ();
4001                   add_phi_arg (&phi, PHI_ARG_DEF (phi, arg), e);
4002                 }
4003             }
4004
4005           /* Update the dominators.  */
4006           if (dom_computed[CDI_DOMINATORS] >= DOM_CONS_OK)
4007             {
4008               /* Remove the unreachable blocks (observe that if all blocks
4009                  were reachable before, only those in the path we threaded
4010                  over and did not have any predecessor outside of the path
4011                  become unreachable).  */
4012               for (; old_dest != dest; old_dest = tmp)
4013                 {
4014                   tmp = old_dest->succ->dest;
4015
4016                   if (old_dest->pred)
4017                     break;
4018
4019                   delete_basic_block (old_dest);
4020                 }
4021               /* If the dominator of the destination was in the path, set its
4022                  dominator to the start of the redirected edge.  */
4023               if (get_immediate_dominator (CDI_DOMINATORS, old_dest) == NULL)
4024                 set_immediate_dominator (CDI_DOMINATORS, old_dest, bb);
4025
4026               /* Now proceed like if we forwarded just over one edge at a time.
4027                  Algorithm for forwarding over edge A --> B then is
4028
4029                  if (idom (B) == A)
4030                    idom (B) = idom (A);
4031                  recount_idom (A);  */
4032
4033               for (; old_dest != dest; old_dest = tmp)
4034                 {
4035                   tmp = old_dest->succ->dest;
4036
4037                   if (get_immediate_dominator (CDI_DOMINATORS, tmp) == old_dest)
4038                     {
4039                       dom = get_immediate_dominator (CDI_DOMINATORS, old_dest);
4040                       set_immediate_dominator (CDI_DOMINATORS, tmp, dom);
4041                     }
4042
4043                   dom = recount_dominator (CDI_DOMINATORS, old_dest);
4044                   set_immediate_dominator (CDI_DOMINATORS, old_dest, dom);
4045                 }
4046             }
4047         }
4048
4049       /* Reset the forwardable bit on our block since it's no longer in
4050          a forwarding chain path.  */
4051       bb_ann (bb)->forwardable = 1;
4052     }
4053
4054   return retval;
4055 }
4056
4057
4058 /* Return a non-special label in the head of basic block BLOCK.
4059    Create one if it doesn't exist.  */
4060
4061 tree
4062 tree_block_label (basic_block bb)
4063 {
4064   block_stmt_iterator i, s = bsi_start (bb);
4065   bool first = true;
4066   tree label, stmt;
4067
4068   for (i = s; !bsi_end_p (i); first = false, bsi_next (&i))
4069     {
4070       stmt = bsi_stmt (i);
4071       if (TREE_CODE (stmt) != LABEL_EXPR)
4072         break;
4073       label = LABEL_EXPR_LABEL (stmt);
4074       if (!DECL_NONLOCAL (label))
4075         {
4076           if (!first)
4077             bsi_move_before (&i, &s);
4078           return label;
4079         }
4080     }
4081
4082   label = create_artificial_label ();
4083   stmt = build1 (LABEL_EXPR, void_type_node, label);
4084   bsi_insert_before (&s, stmt, BSI_NEW_STMT);
4085   return label;
4086 }
4087
4088
4089 /* Attempt to perform edge redirection by replacing a possibly complex
4090    jump instruction by a goto or by removing the jump completely.
4091    This can apply only if all edges now point to the same block.  The
4092    parameters and return values are equivalent to
4093    redirect_edge_and_branch.  */
4094
4095 static edge
4096 tree_try_redirect_by_replacing_jump (edge e, basic_block target)
4097 {
4098   basic_block src = e->src;
4099   edge tmp;
4100   block_stmt_iterator b;
4101   tree stmt;
4102
4103   /* Verify that all targets will be TARGET.  */
4104   for (tmp = src->succ; tmp; tmp = tmp->succ_next)
4105     if (tmp->dest != target && tmp != e)
4106       break;
4107
4108   if (tmp)
4109     return NULL;
4110
4111   b = bsi_last (src);
4112   if (bsi_end_p (b))
4113     return NULL;
4114   stmt = bsi_stmt (b);
4115
4116   if (TREE_CODE (stmt) == COND_EXPR
4117       || TREE_CODE (stmt) == SWITCH_EXPR)
4118     {
4119       bsi_remove (&b);
4120       e = ssa_redirect_edge (e, target);
4121       e->flags = EDGE_FALLTHRU;
4122       return e;
4123     }
4124
4125   return NULL;
4126 }
4127
4128
4129 /* Redirect E to DEST.  Return NULL on failure.  Otherwise, return the
4130    edge representing the redirected branch.  */
4131
4132 static edge
4133 tree_redirect_edge_and_branch (edge e, basic_block dest)
4134 {
4135   basic_block bb = e->src;
4136   block_stmt_iterator bsi;
4137   edge ret;
4138   tree label, stmt;
4139
4140   if (e->flags & (EDGE_ABNORMAL_CALL | EDGE_EH))
4141     return NULL;
4142
4143   if (e->src != ENTRY_BLOCK_PTR 
4144       && (ret = tree_try_redirect_by_replacing_jump (e, dest)))
4145     return ret;
4146
4147   if (e->dest == dest)
4148     return NULL;
4149
4150   label = tree_block_label (dest);
4151
4152   bsi = bsi_last (bb);
4153   stmt = bsi_end_p (bsi) ? NULL : bsi_stmt (bsi);
4154
4155   switch (stmt ? TREE_CODE (stmt) : ERROR_MARK)
4156     {
4157     case COND_EXPR:
4158       stmt = (e->flags & EDGE_TRUE_VALUE
4159               ? COND_EXPR_THEN (stmt)
4160               : COND_EXPR_ELSE (stmt));
4161       GOTO_DESTINATION (stmt) = label;
4162       break;
4163
4164     case GOTO_EXPR:
4165       /* No non-abnormal edges should lead from a non-simple goto, and
4166          simple ones should be represented implicitly.  */
4167       abort ();
4168
4169     case SWITCH_EXPR:
4170       {
4171         tree vec = SWITCH_LABELS (stmt);
4172         size_t i, n = TREE_VEC_LENGTH (vec);
4173
4174         for (i = 0; i < n; ++i)
4175           {
4176             tree elt = TREE_VEC_ELT (vec, i);
4177             if (label_to_block (CASE_LABEL (elt)) == e->dest)
4178               CASE_LABEL (elt) = label;
4179           }
4180       }
4181       break;
4182
4183     case RETURN_EXPR:
4184       bsi_remove (&bsi);
4185       e->flags |= EDGE_FALLTHRU;
4186       break;
4187
4188     default:
4189       /* Otherwise it must be a fallthru edge, and we don't need to
4190          do anything besides redirecting it.  */
4191       if (!(e->flags & EDGE_FALLTHRU))
4192         abort ();
4193       break;
4194     }
4195
4196   /* Update/insert PHI nodes as necessary.  */
4197
4198   /* Now update the edges in the CFG.  */
4199   e = ssa_redirect_edge (e, dest);
4200
4201   return e;
4202 }
4203
4204
4205 /* Simple wrapper, as we can always redirect fallthru edges.  */
4206
4207 static basic_block
4208 tree_redirect_edge_and_branch_force (edge e, basic_block dest)
4209 {
4210   e = tree_redirect_edge_and_branch (e, dest);
4211   if (!e)
4212     abort ();
4213
4214   return NULL;
4215 }
4216
4217
4218 /* Splits basic block BB after statement STMT (but at least after the
4219    labels).  If STMT is NULL, BB is split just after the labels.  */
4220
4221 static basic_block
4222 tree_split_block (basic_block bb, void *stmt)
4223 {
4224   block_stmt_iterator bsi, bsi_tgt;
4225   tree act;
4226   basic_block new_bb;
4227   edge e;
4228
4229   new_bb = create_empty_bb (bb);
4230
4231   /* Redirect the outgoing edges.  */
4232   new_bb->succ = bb->succ;
4233   bb->succ = NULL;
4234   for (e = new_bb->succ; e; e = e->succ_next)
4235     e->src = new_bb;
4236
4237   if (stmt && TREE_CODE ((tree) stmt) == LABEL_EXPR)
4238     stmt = NULL;
4239
4240   /* Move everything from BSI to the new basic block.  */
4241   for (bsi = bsi_start (bb); !bsi_end_p (bsi); bsi_next (&bsi))
4242     {
4243       act = bsi_stmt (bsi);
4244       if (TREE_CODE (act) == LABEL_EXPR)
4245         continue;
4246
4247       if (!stmt)
4248         break;
4249
4250       if (stmt == act)
4251         {
4252           bsi_next (&bsi);
4253           break;
4254         }
4255     }
4256
4257   bsi_tgt = bsi_start (new_bb);
4258   while (!bsi_end_p (bsi))
4259     {
4260       act = bsi_stmt (bsi);
4261       bsi_remove (&bsi);
4262       bsi_insert_after (&bsi_tgt, act, BSI_NEW_STMT);
4263     }
4264
4265   return new_bb;
4266 }
4267
4268
4269 /* Moves basic block BB after block AFTER.  */
4270
4271 static bool
4272 tree_move_block_after (basic_block bb, basic_block after)
4273 {
4274   if (bb->prev_bb == after)
4275     return true;
4276
4277   unlink_block (bb);
4278   link_block (bb, after);
4279
4280   return true;
4281 }
4282
4283
4284 /* Return true if basic_block can be duplicated.  */
4285
4286 static bool
4287 tree_can_duplicate_bb_p (basic_block bb ATTRIBUTE_UNUSED)
4288 {
4289   return true;
4290 }
4291
4292
4293 /* Create a duplicate of the basic block BB.  NOTE: This does not
4294    preserve SSA form.  */
4295
4296 static basic_block
4297 tree_duplicate_bb (basic_block bb)
4298 {
4299   basic_block new_bb;
4300   block_stmt_iterator bsi, bsi_tgt;
4301   tree phi;
4302   def_optype defs;
4303   v_may_def_optype v_may_defs;
4304   v_must_def_optype v_must_defs;
4305   unsigned j;
4306
4307   new_bb = create_empty_bb (EXIT_BLOCK_PTR->prev_bb);
4308
4309   for (phi = phi_nodes (bb); phi; phi = TREE_CHAIN (phi))
4310     {
4311       mark_for_rewrite (PHI_RESULT (phi));
4312     }
4313
4314   bsi_tgt = bsi_start (new_bb);
4315   for (bsi = bsi_start (bb); !bsi_end_p (bsi); bsi_next (&bsi))
4316     {
4317       tree stmt = bsi_stmt (bsi);
4318       tree copy;
4319
4320       if (TREE_CODE (stmt) == LABEL_EXPR)
4321         continue;
4322
4323       /* Record the definitions.  */
4324       get_stmt_operands (stmt);
4325
4326       defs = STMT_DEF_OPS (stmt);
4327       for (j = 0; j < NUM_DEFS (defs); j++)
4328         mark_for_rewrite (DEF_OP (defs, j));
4329
4330       v_may_defs = STMT_V_MAY_DEF_OPS (stmt);
4331       for (j = 0; j < NUM_V_MAY_DEFS (v_may_defs); j++)
4332         mark_for_rewrite (V_MAY_DEF_RESULT (v_may_defs, j));
4333
4334       v_must_defs = STMT_V_MUST_DEF_OPS (stmt);
4335       for (j = 0; j < NUM_V_MUST_DEFS (v_must_defs); j++)
4336         mark_for_rewrite (V_MUST_DEF_OP (v_must_defs, j));
4337
4338       copy = unshare_expr (stmt);
4339
4340       /* Copy also the virtual operands.  */
4341       get_stmt_ann (copy);
4342       copy_virtual_operands (copy, stmt);
4343       
4344       bsi_insert_after (&bsi_tgt, copy, BSI_NEW_STMT);
4345     }
4346
4347   return new_bb;
4348 }
4349
4350
4351 /* Dump FUNCTION_DECL FN to file FILE using FLAGS (see TDF_* in tree.h)  */
4352
4353 void
4354 dump_function_to_file (tree fn, FILE *file, int flags)
4355 {
4356   tree arg, vars, var;
4357   bool ignore_topmost_bind = false, any_var = false;
4358   basic_block bb;
4359   tree chain;
4360
4361   fprintf (file, "%s (", lang_hooks.decl_printable_name (fn, 2));
4362
4363   arg = DECL_ARGUMENTS (fn);
4364   while (arg)
4365     {
4366       print_generic_expr (file, arg, dump_flags);
4367       if (TREE_CHAIN (arg))
4368         fprintf (file, ", ");
4369       arg = TREE_CHAIN (arg);
4370     }
4371   fprintf (file, ")\n");
4372
4373   if (flags & TDF_RAW)
4374     {
4375       dump_node (fn, TDF_SLIM | flags, file);
4376       return;
4377     }
4378
4379   /* When GIMPLE is lowered, the variables are no longer available in
4380      BIND_EXPRs, so display them separately.  */
4381   if (cfun && cfun->unexpanded_var_list)
4382     {
4383       ignore_topmost_bind = true;
4384
4385       fprintf (file, "{\n");
4386       for (vars = cfun->unexpanded_var_list; vars; vars = TREE_CHAIN (vars))
4387         {
4388           var = TREE_VALUE (vars);
4389
4390           print_generic_decl (file, var, flags);
4391           fprintf (file, "\n");
4392
4393           any_var = true;
4394         }
4395     }
4396
4397   if (basic_block_info)
4398     {
4399       /* Make a CFG based dump.  */
4400       check_bb_profile (ENTRY_BLOCK_PTR, file);
4401       if (!ignore_topmost_bind)
4402         fprintf (file, "{\n");
4403
4404       if (any_var && n_basic_blocks)
4405         fprintf (file, "\n");
4406
4407       FOR_EACH_BB (bb)
4408         dump_generic_bb (file, bb, 2, flags);
4409         
4410       fprintf (file, "}\n");
4411       check_bb_profile (EXIT_BLOCK_PTR, file);
4412     }
4413   else
4414     {
4415       int indent;
4416
4417       /* Make a tree based dump.  */
4418       chain = DECL_SAVED_TREE (fn);
4419
4420       if (TREE_CODE (chain) == BIND_EXPR)
4421         {
4422           if (ignore_topmost_bind)
4423             {
4424               chain = BIND_EXPR_BODY (chain);
4425               indent = 2;
4426             }
4427           else
4428             indent = 0;
4429         }
4430       else
4431         {
4432           if (!ignore_topmost_bind)
4433             fprintf (file, "{\n");
4434           indent = 2;
4435         }
4436
4437       if (any_var)
4438         fprintf (file, "\n");
4439
4440       print_generic_stmt_indented (file, chain, flags, indent);
4441       if (ignore_topmost_bind)
4442         fprintf (file, "}\n");
4443     }
4444
4445   fprintf (file, "\n\n");
4446 }
4447
4448
4449 /* Pretty print of the loops intermediate representation.  */
4450 static void print_loop (FILE *, struct loop *, int);
4451 static void print_pred_bbs (FILE *, edge);
4452 static void print_succ_bbs (FILE *, edge);
4453
4454
4455 /* Print the predecessors indexes of edge E on FILE.  */
4456
4457 static void
4458 print_pred_bbs (FILE *file, edge e)
4459 {
4460   if (e == NULL)
4461     return;
4462   
4463   else if (e->pred_next == NULL)
4464     fprintf (file, "bb_%d", e->src->index);
4465   
4466   else
4467     {
4468       fprintf (file, "bb_%d, ", e->src->index);
4469       print_pred_bbs (file, e->pred_next);
4470     }
4471 }
4472
4473
4474 /* Print the successors indexes of edge E on FILE.  */
4475
4476 static void
4477 print_succ_bbs (FILE *file, edge e)
4478 {
4479   if (e == NULL)
4480     return;
4481   else if (e->succ_next == NULL)
4482     fprintf (file, "bb_%d", e->dest->index);
4483   else
4484     {
4485       fprintf (file, "bb_%d, ", e->dest->index);
4486       print_succ_bbs (file, e->succ_next);
4487     }
4488 }
4489
4490
4491 /* Pretty print LOOP on FILE, indented INDENT spaces.  */
4492
4493 static void
4494 print_loop (FILE *file, struct loop *loop, int indent)
4495 {
4496   char *s_indent;
4497   basic_block bb;
4498   
4499   if (loop == NULL)
4500     return;
4501
4502   s_indent = (char *) alloca ((size_t) indent + 1);
4503   memset ((void *) s_indent, ' ', (size_t) indent);
4504   s_indent[indent] = '\0';
4505
4506   /* Print the loop's header.  */
4507   fprintf (file, "%sloop_%d\n", s_indent, loop->num);
4508   
4509   /* Print the loop's body.  */
4510   fprintf (file, "%s{\n", s_indent);
4511   FOR_EACH_BB (bb)
4512     if (bb->loop_father == loop)
4513       {
4514         /* Print the basic_block's header.  */
4515         fprintf (file, "%s  bb_%d (preds = {", s_indent, bb->index);
4516         print_pred_bbs (file, bb->pred);
4517         fprintf (file, "}, succs = {");
4518         print_succ_bbs (file, bb->succ);
4519         fprintf (file, "})\n");
4520         
4521         /* Print the basic_block's body.  */
4522         fprintf (file, "%s  {\n", s_indent);
4523         tree_dump_bb (bb, file, indent + 4);
4524         fprintf (file, "%s  }\n", s_indent);
4525       }
4526   
4527   print_loop (file, loop->inner, indent + 2);
4528   fprintf (file, "%s}\n", s_indent);
4529   print_loop (file, loop->next, indent);
4530 }
4531
4532
4533 /* Follow a CFG edge from the entry point of the program, and on entry
4534    of a loop, pretty print the loop structure on FILE.  */
4535
4536 void 
4537 print_loop_ir (FILE *file)
4538 {
4539   basic_block bb;
4540   
4541   bb = BASIC_BLOCK (0);
4542   if (bb && bb->loop_father)
4543     print_loop (file, bb->loop_father, 0);
4544 }
4545
4546
4547 /* Debugging loops structure at tree level.  */
4548
4549 void 
4550 debug_loop_ir (void)
4551 {
4552   print_loop_ir (stderr);
4553 }
4554
4555
4556 /* Return true if BB ends with a call, possibly followed by some
4557    instructions that must stay with the call.  Return false,
4558    otherwise.  */
4559
4560 static bool
4561 tree_block_ends_with_call_p (basic_block bb)
4562 {
4563   block_stmt_iterator bsi = bsi_last (bb);
4564   return get_call_expr_in (bsi_stmt (bsi)) != NULL;
4565 }
4566
4567
4568 /* Return true if BB ends with a conditional branch.  Return false,
4569    otherwise.  */
4570
4571 static bool
4572 tree_block_ends_with_condjump_p (basic_block bb)
4573 {
4574   tree stmt = tsi_stmt (bsi_last (bb).tsi);
4575   return (TREE_CODE (stmt) == COND_EXPR);
4576 }
4577
4578
4579 /* Return true if we need to add fake edge to exit at statement T.
4580    Helper function for tree_flow_call_edges_add.  */
4581
4582 static bool
4583 need_fake_edge_p (tree t)
4584 {
4585   tree call;
4586
4587   /* NORETURN and LONGJMP calls already have an edge to exit.
4588      CONST, PURE and ALWAYS_RETURN calls do not need one.
4589      We don't currently check for CONST and PURE here, although
4590      it would be a good idea, because those attributes are
4591      figured out from the RTL in mark_constant_function, and
4592      the counter incrementation code from -fprofile-arcs
4593      leads to different results from -fbranch-probabilities.  */
4594   call = get_call_expr_in (t);
4595   if (call
4596       && !(call_expr_flags (call) & 
4597            (ECF_NORETURN | ECF_LONGJMP | ECF_ALWAYS_RETURN)))
4598     return true;
4599
4600   if (TREE_CODE (t) == ASM_EXPR
4601        && (ASM_VOLATILE_P (t) || ASM_INPUT_P (t)))
4602     return true;
4603
4604   return false;
4605 }
4606
4607
4608 /* Add fake edges to the function exit for any non constant and non
4609    noreturn calls, volatile inline assembly in the bitmap of blocks
4610    specified by BLOCKS or to the whole CFG if BLOCKS is zero.  Return
4611    the number of blocks that were split.
4612
4613    The goal is to expose cases in which entering a basic block does
4614    not imply that all subsequent instructions must be executed.  */
4615
4616 static int
4617 tree_flow_call_edges_add (sbitmap blocks)
4618 {
4619   int i;
4620   int blocks_split = 0;
4621   int last_bb = last_basic_block;
4622   bool check_last_block = false;
4623
4624   if (n_basic_blocks == 0)
4625     return 0;
4626
4627   if (! blocks)
4628     check_last_block = true;
4629   else
4630     check_last_block = TEST_BIT (blocks, EXIT_BLOCK_PTR->prev_bb->index);
4631
4632   /* In the last basic block, before epilogue generation, there will be
4633      a fallthru edge to EXIT.  Special care is required if the last insn
4634      of the last basic block is a call because make_edge folds duplicate
4635      edges, which would result in the fallthru edge also being marked
4636      fake, which would result in the fallthru edge being removed by
4637      remove_fake_edges, which would result in an invalid CFG.
4638
4639      Moreover, we can't elide the outgoing fake edge, since the block
4640      profiler needs to take this into account in order to solve the minimal
4641      spanning tree in the case that the call doesn't return.
4642
4643      Handle this by adding a dummy instruction in a new last basic block.  */
4644   if (check_last_block)
4645     {
4646       basic_block bb = EXIT_BLOCK_PTR->prev_bb;
4647       block_stmt_iterator bsi = bsi_last (bb);
4648       tree t = NULL_TREE;
4649       if (!bsi_end_p (bsi))
4650         t = bsi_stmt (bsi);
4651
4652       if (need_fake_edge_p (t))
4653         {
4654           edge e;
4655
4656           for (e = bb->succ; e; e = e->succ_next)
4657             if (e->dest == EXIT_BLOCK_PTR)
4658               {
4659                 bsi_insert_on_edge (e, build_empty_stmt ());
4660                 bsi_commit_edge_inserts ((int *)NULL);
4661                 break;
4662               }
4663         }
4664     }
4665
4666   /* Now add fake edges to the function exit for any non constant
4667      calls since there is no way that we can determine if they will
4668      return or not...  */
4669   for (i = 0; i < last_bb; i++)
4670     {
4671       basic_block bb = BASIC_BLOCK (i);
4672       block_stmt_iterator bsi;
4673       tree stmt, last_stmt;
4674
4675       if (!bb)
4676         continue;
4677
4678       if (blocks && !TEST_BIT (blocks, i))
4679         continue;
4680
4681       bsi = bsi_last (bb);
4682       if (!bsi_end_p (bsi))
4683         {
4684           last_stmt = bsi_stmt (bsi);
4685           do
4686             {
4687               stmt = bsi_stmt (bsi);
4688               if (need_fake_edge_p (stmt))
4689                 {
4690                   edge e;
4691                   /* The handling above of the final block before the
4692                      epilogue should be enough to verify that there is
4693                      no edge to the exit block in CFG already.
4694                      Calling make_edge in such case would cause us to
4695                      mark that edge as fake and remove it later.  */
4696 #ifdef ENABLE_CHECKING
4697                   if (stmt == last_stmt)
4698                     for (e = bb->succ; e; e = e->succ_next)
4699                       if (e->dest == EXIT_BLOCK_PTR)
4700                         abort ();
4701 #endif
4702
4703                   /* Note that the following may create a new basic block
4704                      and renumber the existing basic blocks.  */
4705                   if (stmt != last_stmt)
4706                     {
4707                       e = split_block (bb, stmt);
4708                       if (e)
4709                         blocks_split++;
4710                     }
4711                   make_edge (bb, EXIT_BLOCK_PTR, EDGE_FAKE);
4712                 }
4713               bsi_prev (&bsi);
4714             }
4715           while (!bsi_end_p (bsi));
4716         }
4717     }
4718
4719   if (blocks_split)
4720     verify_flow_info ();
4721
4722   return blocks_split;
4723 }
4724
4725 bool
4726 tree_purge_dead_eh_edges (basic_block bb)
4727 {
4728   bool changed = false;
4729   edge e, next;
4730   tree stmt = last_stmt (bb);
4731
4732   if (stmt && tree_can_throw_internal (stmt))
4733     return false;
4734
4735   for (e = bb->succ; e ; e = next)
4736     {
4737       next = e->succ_next;
4738       if (e->flags & EDGE_EH)
4739         {
4740           ssa_remove_edge (e);
4741           changed = true;
4742         }
4743     }
4744
4745   return changed;
4746 }
4747
4748 bool
4749 tree_purge_all_dead_eh_edges (bitmap blocks)
4750 {
4751   bool changed = false;
4752   size_t i;
4753
4754   EXECUTE_IF_SET_IN_BITMAP (blocks, 0, i,
4755     { changed |= tree_purge_dead_eh_edges (BASIC_BLOCK (i)); });
4756
4757   return changed;
4758 }
4759
4760 struct cfg_hooks tree_cfg_hooks = {
4761   "tree",
4762   tree_verify_flow_info,
4763   tree_dump_bb,                 /* dump_bb  */
4764   create_bb,                    /* create_basic_block  */
4765   tree_redirect_edge_and_branch,/* redirect_edge_and_branch  */
4766   tree_redirect_edge_and_branch_force,/* redirect_edge_and_branch_force  */
4767   remove_bb,                    /* delete_basic_block  */
4768   tree_split_block,             /* split_block  */
4769   tree_move_block_after,        /* move_block_after  */
4770   tree_can_merge_blocks_p,      /* can_merge_blocks_p  */
4771   tree_merge_blocks,            /* merge_blocks  */
4772   tree_predict_edge,            /* predict_edge  */
4773   tree_predicted_by_p,          /* predicted_by_p  */
4774   tree_can_duplicate_bb_p,      /* can_duplicate_block_p  */
4775   tree_duplicate_bb,            /* duplicate_block  */
4776   tree_split_edge,              /* split_edge  */
4777   tree_make_forwarder_block,    /* make_forward_block  */
4778   NULL,                         /* tidy_fallthru_edge  */
4779   tree_block_ends_with_call_p,  /* block_ends_with_call_p */
4780   tree_block_ends_with_condjump_p, /* block_ends_with_condjump_p */
4781   tree_flow_call_edges_add      /* flow_call_edges_add */
4782 };
4783
4784
4785 /* Split all critical edges.  */
4786
4787 static void
4788 split_critical_edges (void)
4789 {
4790   basic_block bb;
4791   edge e;
4792
4793   FOR_ALL_BB (bb)
4794     {
4795       for (e = bb->succ; e ; e = e->succ_next)
4796         if (EDGE_CRITICAL_P (e) && !(e->flags & EDGE_ABNORMAL))
4797           {
4798             split_edge (e);
4799           }
4800     }
4801 }
4802
4803 struct tree_opt_pass pass_split_crit_edges = 
4804 {
4805   "crited",                          /* name */
4806   NULL,                          /* gate */
4807   split_critical_edges,          /* execute */
4808   NULL,                          /* sub */
4809   NULL,                          /* next */
4810   0,                             /* static_pass_number */
4811   TV_TREE_SPLIT_EDGES,           /* tv_id */
4812   PROP_cfg,                      /* properties required */
4813   PROP_no_crit_edges,            /* properties_provided */
4814   0,                             /* properties_destroyed */
4815   0,                             /* todo_flags_start */
4816   TODO_dump_func,                             /* todo_flags_finish */
4817 };
4818
4819 \f
4820 /* Return EXP if it is a valid GIMPLE rvalue, else gimplify it into
4821    a temporary, make sure and register it to be renamed if necessary,
4822    and finally return the temporary.  Put the statements to compute
4823    EXP before the current statement in BSI.  */
4824
4825 tree
4826 gimplify_val (block_stmt_iterator *bsi, tree type, tree exp)
4827 {
4828   tree t, new_stmt, orig_stmt;
4829
4830   if (is_gimple_val (exp))
4831     return exp;
4832
4833   t = make_rename_temp (type, NULL);
4834   new_stmt = build (MODIFY_EXPR, type, t, exp);
4835
4836   orig_stmt = bsi_stmt (*bsi);
4837   SET_EXPR_LOCUS (new_stmt, EXPR_LOCUS (orig_stmt));
4838   TREE_BLOCK (new_stmt) = TREE_BLOCK (orig_stmt);
4839
4840   bsi_insert_before (bsi, new_stmt, BSI_SAME_STMT);
4841
4842   return t;
4843 }
4844
4845 /* Build a ternary operation and gimplify it.  Emit code before BSI.
4846    Return the gimple_val holding the result.  */
4847
4848 tree
4849 gimplify_build3 (block_stmt_iterator *bsi, enum tree_code code,
4850                  tree type, tree a, tree b, tree c)
4851 {
4852   tree ret;
4853
4854   ret = fold (build3 (code, type, a, b, c));
4855   STRIP_NOPS (ret);
4856
4857   return gimplify_val (bsi, type, ret);
4858 }
4859
4860 /* Build a binary operation and gimplify it.  Emit code before BSI.
4861    Return the gimple_val holding the result.  */
4862
4863 tree
4864 gimplify_build2 (block_stmt_iterator *bsi, enum tree_code code,
4865                  tree type, tree a, tree b)
4866 {
4867   tree ret;
4868
4869   ret = fold (build2 (code, type, a, b));
4870   STRIP_NOPS (ret);
4871
4872   return gimplify_val (bsi, type, ret);
4873 }
4874
4875 /* Build a unary operation and gimplify it.  Emit code before BSI.
4876    Return the gimple_val holding the result.  */
4877
4878 tree
4879 gimplify_build1 (block_stmt_iterator *bsi, enum tree_code code, tree type,
4880                  tree a)
4881 {
4882   tree ret;
4883
4884   ret = fold (build1 (code, type, a));
4885   STRIP_NOPS (ret);
4886
4887   return gimplify_val (bsi, type, ret);
4888 }
4889
4890
4891 \f
4892 /* Emit return warnings.  */
4893
4894 static void
4895 execute_warn_function_return (void)
4896 {
4897 #ifdef USE_MAPPED_LOCATION
4898   source_location location;
4899 #else
4900   location_t *locus;
4901 #endif
4902   tree last;
4903   edge e;
4904
4905   if (warn_missing_noreturn
4906       && !TREE_THIS_VOLATILE (cfun->decl)
4907       && EXIT_BLOCK_PTR->pred == NULL
4908       && !lang_hooks.function.missing_noreturn_ok_p (cfun->decl))
4909     warning ("%Jfunction might be possible candidate for attribute `noreturn'",
4910              cfun->decl);
4911
4912   /* If we have a path to EXIT, then we do return.  */
4913   if (TREE_THIS_VOLATILE (cfun->decl)
4914       && EXIT_BLOCK_PTR->pred != NULL)
4915     {
4916 #ifdef USE_MAPPED_LOCATION
4917       location = UNKNOWN_LOCATION;
4918 #else
4919       locus = NULL;
4920 #endif
4921       for (e = EXIT_BLOCK_PTR->pred; e ; e = e->pred_next)
4922         {
4923           last = last_stmt (e->src);
4924           if (TREE_CODE (last) == RETURN_EXPR
4925 #ifdef USE_MAPPED_LOCATION
4926               && (location = EXPR_LOCATION (last)) != UNKNOWN_LOCATION)
4927 #else
4928               && (locus = EXPR_LOCUS (last)) != NULL)
4929 #endif
4930             break;
4931         }
4932 #ifdef USE_MAPPED_LOCATION
4933       if (location == UNKNOWN_LOCATION)
4934         location = cfun->function_end_locus;
4935       warning ("%H`noreturn' function does return", &location);
4936 #else
4937       if (!locus)
4938         locus = &cfun->function_end_locus;
4939       warning ("%H`noreturn' function does return", locus);
4940 #endif
4941     }
4942
4943   /* If we see "return;" in some basic block, then we do reach the end
4944      without returning a value.  */
4945   else if (warn_return_type
4946            && EXIT_BLOCK_PTR->pred != NULL
4947            && !VOID_TYPE_P (TREE_TYPE (TREE_TYPE (cfun->decl))))
4948     {
4949       for (e = EXIT_BLOCK_PTR->pred; e ; e = e->pred_next)
4950         {
4951           tree last = last_stmt (e->src);
4952           if (TREE_CODE (last) == RETURN_EXPR
4953               && TREE_OPERAND (last, 0) == NULL)
4954             {
4955 #ifdef USE_MAPPED_LOCATION
4956               location = EXPR_LOCATION (last);
4957               if (location == UNKNOWN_LOCATION)
4958                   location = cfun->function_end_locus;
4959               warning ("%Hcontrol reaches end of non-void function", &location);
4960 #else
4961               locus = EXPR_LOCUS (last);
4962               if (!locus)
4963                 locus = &cfun->function_end_locus;
4964               warning ("%Hcontrol reaches end of non-void function", locus);
4965 #endif
4966               break;
4967             }
4968         }
4969     }
4970 }
4971
4972
4973 /* Given a basic block B which ends with a conditional and has
4974    precisely two successors, determine which of the edges is taken if
4975    the conditional is true and which is taken if the conditional is
4976    false.  Set TRUE_EDGE and FALSE_EDGE appropriately.  */
4977
4978 void
4979 extract_true_false_edges_from_block (basic_block b,
4980                                      edge *true_edge,
4981                                      edge *false_edge)
4982 {
4983   edge e = b->succ;
4984
4985   if (e->flags & EDGE_TRUE_VALUE)
4986     {
4987       *true_edge = e;
4988       *false_edge = e->succ_next;
4989     }
4990   else
4991     {
4992       *false_edge = e;
4993       *true_edge = e->succ_next;
4994     }
4995 }
4996
4997 struct tree_opt_pass pass_warn_function_return =
4998 {
4999   NULL,                                 /* name */
5000   NULL,                                 /* gate */
5001   execute_warn_function_return,         /* execute */
5002   NULL,                                 /* sub */
5003   NULL,                                 /* next */
5004   0,                                    /* static_pass_number */
5005   0,                                    /* tv_id */
5006   PROP_cfg,                             /* properties_required */
5007   0,                                    /* properties_provided */
5008   0,                                    /* properties_destroyed */
5009   0,                                    /* todo_flags_start */
5010   0                                     /* todo_flags_finish */
5011 };
5012
5013 #include "gt-tree-cfg.h"