2004-10-04 Paul Brook <paul@codesourcery.com>
[official-gcc.git] / gcc / tree-optimize.c
blob1d145dcf73b12d778cb60c0ce06f5aa6c9e68af2
1 /* Top-level control of tree optimizations.
2 Copyright 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
3 Contributed by Diego Novillo <dnovillo@redhat.com>
5 This file is part of GCC.
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.
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.
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. */
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 "expr.h"
33 #include "diagnostic.h"
34 #include "basic-block.h"
35 #include "flags.h"
36 #include "tree-flow.h"
37 #include "tree-dump.h"
38 #include "timevar.h"
39 #include "function.h"
40 #include "langhooks.h"
41 #include "toplev.h"
42 #include "flags.h"
43 #include "cgraph.h"
44 #include "tree-inline.h"
45 #include "tree-mudflap.h"
46 #include "tree-pass.h"
47 #include "ggc.h"
48 #include "cgraph.h"
49 #include "graph.h"
52 /* Global variables used to communicate with passes. */
53 int dump_flags;
54 bitmap vars_to_rename;
55 bool in_gimple_form;
57 /* The root of the compilation pass tree, once constructed. */
58 static struct tree_opt_pass *all_passes;
60 /* Pass: dump the gimplified, inlined, functions. */
62 static struct tree_opt_pass pass_gimple =
64 "gimple", /* name */
65 NULL, /* gate */
66 NULL, /* execute */
67 NULL, /* sub */
68 NULL, /* next */
69 0, /* static_pass_number */
70 0, /* tv_id */
71 0, /* properties_required */
72 PROP_gimple_any, /* properties_provided */
73 0, /* properties_destroyed */
74 0, /* todo_flags_start */
75 TODO_dump_func, /* todo_flags_finish */
76 0 /* letter */
79 /* Gate: execute, or not, all of the non-trivial optimizations. */
81 static bool
82 gate_all_optimizations (void)
84 return (optimize >= 1
85 /* Don't bother doing anything if the program has errors. */
86 && !(errorcount || sorrycount));
89 static struct tree_opt_pass pass_all_optimizations =
91 NULL, /* name */
92 gate_all_optimizations, /* gate */
93 NULL, /* execute */
94 NULL, /* sub */
95 NULL, /* next */
96 0, /* static_pass_number */
97 0, /* tv_id */
98 0, /* properties_required */
99 0, /* properties_provided */
100 0, /* properties_destroyed */
101 0, /* todo_flags_start */
102 0, /* todo_flags_finish */
103 0 /* letter */
106 /* Pass: cleanup the CFG just before expanding trees to RTL.
107 This is just a round of label cleanups and case node grouping
108 because after the tree optimizers have run such cleanups may
109 be necessary. */
111 static void
112 execute_cleanup_cfg_post_optimizing (void)
114 cleanup_tree_cfg ();
115 cleanup_dead_labels ();
116 group_case_labels ();
119 static struct tree_opt_pass pass_cleanup_cfg_post_optimizing =
121 NULL, /* name */
122 NULL, /* gate */
123 execute_cleanup_cfg_post_optimizing, /* execute */
124 NULL, /* sub */
125 NULL, /* next */
126 0, /* static_pass_number */
127 0, /* tv_id */
128 PROP_cfg, /* properties_required */
129 0, /* properties_provided */
130 0, /* properties_destroyed */
131 0, /* todo_flags_start */
132 0, /* todo_flags_finish */
133 0 /* letter */
136 /* Pass: do the actions required to finish with tree-ssa optimization
137 passes. */
139 static void
140 execute_free_datastructures (void)
142 tree *chain;
144 /* ??? This isn't the right place for this. Worse, it got computed
145 more or less at random in various passes. */
146 free_dominance_info (CDI_DOMINATORS);
148 /* Emit gotos for implicit jumps. */
149 disband_implicit_edges ();
151 /* Remove the ssa structures. Do it here since this includes statement
152 annotations that need to be intact during disband_implicit_edges. */
153 delete_tree_ssa ();
155 /* Re-chain the statements from the blocks. */
156 chain = &DECL_SAVED_TREE (current_function_decl);
157 *chain = alloc_stmt_list ();
159 /* And get rid of annotations we no longer need. */
160 delete_tree_cfg_annotations ();
163 static struct tree_opt_pass pass_free_datastructures =
165 NULL, /* name */
166 NULL, /* gate */
167 execute_free_datastructures, /* execute */
168 NULL, /* sub */
169 NULL, /* next */
170 0, /* static_pass_number */
171 0, /* tv_id */
172 PROP_cfg, /* properties_required */
173 0, /* properties_provided */
174 0, /* properties_destroyed */
175 0, /* todo_flags_start */
176 0, /* todo_flags_finish */
177 0 /* letter */
181 /* Do the actions required to initialize internal data structures used
182 in tree-ssa optimization passes. */
184 static void
185 execute_init_datastructures (void)
187 /* Allocate hash tables, arrays and other structures. */
188 init_tree_ssa ();
191 static struct tree_opt_pass pass_init_datastructures =
193 NULL, /* name */
194 NULL, /* gate */
195 execute_init_datastructures, /* execute */
196 NULL, /* sub */
197 NULL, /* next */
198 0, /* static_pass_number */
199 0, /* tv_id */
200 PROP_cfg, /* properties_required */
201 0, /* properties_provided */
202 0, /* properties_destroyed */
203 0, /* todo_flags_start */
204 0, /* todo_flags_finish */
205 0 /* letter */
208 /* Iterate over the pass tree allocating dump file numbers. We want
209 to do this depth first, and independent of whether the pass is
210 enabled or not. */
212 static void
213 register_one_dump_file (struct tree_opt_pass *pass, int n)
215 char *dot_name, *flag_name;
216 char num[10];
218 /* See below in next_pass_1. */
219 num[0] = '\0';
220 if (pass->static_pass_number != -1)
221 sprintf (num, "%d", ((int) pass->static_pass_number < 0
222 ? 1 : pass->static_pass_number));
224 dot_name = concat (".", pass->name, num, NULL);
225 if (pass->properties_provided & PROP_trees)
227 flag_name = concat ("tree-", pass->name, num, NULL);
228 pass->static_pass_number = dump_register (dot_name, flag_name,
229 TDF_TREE, n + TDI_tree_all, 0);
231 else
233 flag_name = concat ("rtl-", pass->name, num, NULL);
234 pass->static_pass_number = dump_register (dot_name, flag_name,
235 TDF_RTL, n, pass->letter);
239 static int
240 register_dump_files (struct tree_opt_pass *pass, int properties)
242 static int n = 0;
245 int new_properties;
246 int pass_number;
248 pass->properties_required = properties;
249 new_properties =
250 (properties | pass->properties_provided) & ~pass->properties_destroyed;
252 /* Reset the counter when we reach RTL-based passes. */
253 if ((pass->properties_provided ^ pass->properties_required) & PROP_rtl)
254 n = 0;
256 pass_number = n;
257 if (pass->name)
258 n++;
260 if (pass->sub)
261 new_properties = register_dump_files (pass->sub, new_properties);
263 /* If we have a gate, combine the properties that we could have with
264 and without the pass being examined. */
265 if (pass->gate)
266 properties &= new_properties;
267 else
268 properties = new_properties;
270 pass->properties_provided = properties;
271 if (pass->name)
272 register_one_dump_file (pass, pass_number);
274 pass = pass->next;
276 while (pass);
278 return properties;
281 /* Add a pass to the pass list. Duplicate the pass if it's already
282 in the list. */
284 static struct tree_opt_pass **
285 next_pass_1 (struct tree_opt_pass **list, struct tree_opt_pass *pass)
288 /* A nonzero static_pass_number indicates that the
289 pass is already in the list. */
290 if (pass->static_pass_number)
292 struct tree_opt_pass *new;
294 new = xmalloc (sizeof (*new));
295 memcpy (new, pass, sizeof (*new));
297 /* Indicate to register_dump_files that this pass has duplicates,
298 and so it should rename the dump file. The first instance will
299 be -1, and be number of duplicates = -static_pass_number - 1.
300 Subsequent instances will be > 0 and just the duplicate number. */
301 if (pass->name)
303 pass->static_pass_number -= 1;
304 new->static_pass_number = -pass->static_pass_number;
307 *list = new;
309 else
311 pass->static_pass_number = -1;
312 *list = pass;
315 return &(*list)->next;
319 /* Construct the pass tree. */
321 void
322 init_tree_optimization_passes (void)
324 struct tree_opt_pass **p;
326 #define NEXT_PASS(PASS) (p = next_pass_1 (p, &PASS))
328 p = &all_passes;
329 NEXT_PASS (pass_gimple);
330 NEXT_PASS (pass_remove_useless_stmts);
331 NEXT_PASS (pass_mudflap_1);
332 NEXT_PASS (pass_lower_cf);
333 NEXT_PASS (pass_lower_eh);
334 NEXT_PASS (pass_build_cfg);
335 NEXT_PASS (pass_pre_expand);
336 NEXT_PASS (pass_tree_profile);
337 NEXT_PASS (pass_init_datastructures);
338 NEXT_PASS (pass_all_optimizations);
339 NEXT_PASS (pass_warn_function_return);
340 NEXT_PASS (pass_mudflap_2);
341 NEXT_PASS (pass_free_datastructures);
342 NEXT_PASS (pass_expand);
343 NEXT_PASS (pass_rest_of_compilation);
344 *p = NULL;
346 p = &pass_all_optimizations.sub;
347 NEXT_PASS (pass_referenced_vars);
348 NEXT_PASS (pass_build_ssa);
349 NEXT_PASS (pass_may_alias);
350 NEXT_PASS (pass_rename_ssa_copies);
351 NEXT_PASS (pass_early_warn_uninitialized);
352 NEXT_PASS (pass_dce);
353 NEXT_PASS (pass_dominator);
354 NEXT_PASS (pass_redundant_phi);
355 NEXT_PASS (pass_dce);
356 NEXT_PASS (pass_forwprop);
357 NEXT_PASS (pass_phiopt);
358 NEXT_PASS (pass_may_alias);
359 NEXT_PASS (pass_tail_recursion);
360 NEXT_PASS (pass_ch);
361 NEXT_PASS (pass_profile);
362 NEXT_PASS (pass_sra);
363 NEXT_PASS (pass_rename_ssa_copies);
364 NEXT_PASS (pass_dominator);
365 NEXT_PASS (pass_redundant_phi);
366 NEXT_PASS (pass_dce);
367 NEXT_PASS (pass_dse);
368 NEXT_PASS (pass_may_alias);
369 NEXT_PASS (pass_forwprop);
370 NEXT_PASS (pass_phiopt);
371 NEXT_PASS (pass_ccp);
372 NEXT_PASS (pass_redundant_phi);
373 NEXT_PASS (pass_fold_builtins);
374 NEXT_PASS (pass_split_crit_edges);
375 NEXT_PASS (pass_pre);
376 NEXT_PASS (pass_loop);
377 NEXT_PASS (pass_dominator);
378 NEXT_PASS (pass_redundant_phi);
379 NEXT_PASS (pass_cd_dce);
380 NEXT_PASS (pass_dse);
381 NEXT_PASS (pass_forwprop);
382 NEXT_PASS (pass_phiopt);
383 NEXT_PASS (pass_tail_calls);
384 NEXT_PASS (pass_late_warn_uninitialized);
385 NEXT_PASS (pass_del_ssa);
386 NEXT_PASS (pass_nrv);
387 NEXT_PASS (pass_remove_useless_vars);
388 NEXT_PASS (pass_cleanup_cfg_post_optimizing);
389 *p = NULL;
391 p = &pass_loop.sub;
392 NEXT_PASS (pass_loop_init);
393 NEXT_PASS (pass_lim);
394 NEXT_PASS (pass_unswitch);
395 NEXT_PASS (pass_iv_canon);
396 NEXT_PASS (pass_record_bounds);
397 NEXT_PASS (pass_if_conversion);
398 NEXT_PASS (pass_vectorize);
399 NEXT_PASS (pass_linear_transform);
400 NEXT_PASS (pass_complete_unroll);
401 NEXT_PASS (pass_iv_optimize);
402 NEXT_PASS (pass_loop_done);
403 *p = NULL;
405 #undef NEXT_PASS
407 /* Register the passes with the tree dump code. */
408 register_dump_files (all_passes, 0);
411 static void execute_pass_list (struct tree_opt_pass *);
413 static unsigned int last_verified;
415 static void
416 execute_todo (int properties, unsigned int flags)
418 if (flags & TODO_rename_vars)
420 rewrite_into_ssa (false);
421 bitmap_clear (vars_to_rename);
424 if ((flags & TODO_dump_func) && dump_file)
426 if (properties & PROP_trees)
427 dump_function_to_file (current_function_decl,
428 dump_file, dump_flags);
429 else if (properties & PROP_cfg)
430 print_rtl_with_bb (dump_file, get_insns ());
431 else
432 print_rtl (dump_file, get_insns ());
434 /* Flush the file. If verification fails, we won't be able to
435 close the file before aborting. */
436 fflush (dump_file);
439 if (flags & TODO_ggc_collect)
440 ggc_collect ();
442 #ifdef ENABLE_CHECKING
443 if (flags & TODO_verify_ssa)
444 verify_ssa ();
445 if (flags & TODO_verify_flow)
446 verify_flow_info ();
447 if (flags & TODO_verify_stmts)
448 verify_stmts ();
449 #endif
452 static bool
453 execute_one_pass (struct tree_opt_pass *pass)
455 unsigned int todo;
457 /* See if we're supposed to run this pass. */
458 if (pass->gate && !pass->gate ())
459 return false;
461 /* Note that the folders should only create gimple expressions.
462 This is a hack until the new folder is ready. */
463 in_gimple_form = (pass->properties_provided & PROP_trees) != 0;
465 /* Run pre-pass verification. */
466 todo = pass->todo_flags_start & ~last_verified;
467 if (todo)
468 execute_todo (pass->properties_required, todo);
470 /* If a dump file name is present, open it if enabled. */
471 if (pass->static_pass_number != -1)
473 bool initializing_dump = !dump_initialized_p (pass->static_pass_number);
474 dump_file_name = get_dump_file_name (pass->static_pass_number);
475 dump_file = dump_begin (pass->static_pass_number, &dump_flags);
476 if (dump_file)
478 const char *dname, *aname;
479 dname = lang_hooks.decl_printable_name (current_function_decl, 2);
480 aname = (IDENTIFIER_POINTER
481 (DECL_ASSEMBLER_NAME (current_function_decl)));
482 fprintf (dump_file, "\n;; Function %s (%s)%s\n\n", dname, aname,
483 cfun->function_frequency == FUNCTION_FREQUENCY_HOT
484 ? " (hot)"
485 : cfun->function_frequency == FUNCTION_FREQUENCY_UNLIKELY_EXECUTED
486 ? " (unlikely executed)"
487 : "");
490 if (initializing_dump
491 && graph_dump_format != no_graph
492 && (pass->properties_provided & (PROP_cfg | PROP_rtl))
493 == (PROP_cfg | PROP_rtl))
494 clean_graph_dump_file (dump_file_name);
497 /* If a timevar is present, start it. */
498 if (pass->tv_id)
499 timevar_push (pass->tv_id);
501 /* Do it! */
502 if (pass->execute)
503 pass->execute ();
505 if (dump_file
506 && (pass->properties_provided & (PROP_cfg | PROP_rtl))
507 == (PROP_cfg | PROP_rtl))
508 print_rtl_graph_with_bb (dump_file_name, get_insns ());
510 /* Run post-pass cleanup and verification. */
511 todo = pass->todo_flags_finish;
512 last_verified = todo & TODO_verify_all;
513 if (todo)
514 execute_todo (pass->properties_provided, todo);
516 /* Close down timevar and dump file. */
517 if (pass->tv_id)
518 timevar_pop (pass->tv_id);
519 if (dump_file_name)
521 free ((char *) dump_file_name);
522 dump_file_name = NULL;
524 if (dump_file)
526 dump_end (pass->static_pass_number, dump_file);
527 dump_file = NULL;
530 return true;
533 static void
534 execute_pass_list (struct tree_opt_pass *pass)
538 if (execute_one_pass (pass) && pass->sub)
539 execute_pass_list (pass->sub);
540 pass = pass->next;
542 while (pass);
546 /* Update recursively all inlined_to pointers of functions
547 inlined into NODE to INLINED_TO. */
548 static void
549 update_inlined_to_pointers (struct cgraph_node *node,
550 struct cgraph_node *inlined_to)
552 struct cgraph_edge *e;
553 for (e = node->callees; e; e = e->next_callee)
555 if (e->callee->global.inlined_to)
557 e->callee->global.inlined_to = inlined_to;
558 update_inlined_to_pointers (e->callee, inlined_to);
564 /* For functions-as-trees languages, this performs all optimization and
565 compilation for FNDECL. */
567 void
568 tree_rest_of_compilation (tree fndecl)
570 location_t saved_loc;
571 struct cgraph_node *saved_node = NULL, *node;
573 timevar_push (TV_EXPAND);
575 gcc_assert (!flag_unit_at_a_time || cgraph_global_info_ready);
577 /* Initialize the RTL code for the function. */
578 current_function_decl = fndecl;
579 saved_loc = input_location;
580 input_location = DECL_SOURCE_LOCATION (fndecl);
581 init_function_start (fndecl);
583 /* Even though we're inside a function body, we still don't want to
584 call expand_expr to calculate the size of a variable-sized array.
585 We haven't necessarily assigned RTL to all variables yet, so it's
586 not safe to try to expand expressions involving them. */
587 cfun->x_dont_save_pending_sizes_p = 1;
589 node = cgraph_node (fndecl);
591 /* We might need the body of this function so that we can expand
592 it inline somewhere else. This means not lowering some constructs
593 such as exception handling. */
594 if (cgraph_preserve_function_body_p (fndecl))
596 if (!flag_unit_at_a_time)
598 struct cgraph_edge *e;
600 saved_node = cgraph_clone_node (node);
601 for (e = saved_node->callees; e; e = e->next_callee)
602 if (!e->inline_failed)
603 cgraph_clone_inlined_nodes (e, true);
605 cfun->saved_static_chain_decl = cfun->static_chain_decl;
606 cfun->saved_tree = save_body (fndecl, &cfun->saved_args,
607 &cfun->saved_static_chain_decl);
610 if (flag_inline_trees)
612 struct cgraph_edge *e;
613 for (e = node->callees; e; e = e->next_callee)
614 if (!e->inline_failed || warn_inline)
615 break;
616 if (e)
618 timevar_push (TV_INTEGRATION);
619 optimize_inline_calls (fndecl);
620 timevar_pop (TV_INTEGRATION);
624 /* We are not going to maintain the cgraph edges up to date.
625 Kill it so it won't confuse us. */
626 while (node->callees)
627 cgraph_remove_edge (node->callees);
629 if (!vars_to_rename)
630 vars_to_rename = BITMAP_XMALLOC ();
632 /* Perform all tree transforms and optimizations. */
633 execute_pass_list (all_passes);
635 /* Restore original body if still needed. */
636 if (cfun->saved_tree)
638 DECL_SAVED_TREE (fndecl) = cfun->saved_tree;
639 DECL_ARGUMENTS (fndecl) = cfun->saved_args;
640 cfun->static_chain_decl = cfun->saved_static_chain_decl;
642 /* When not in unit-at-a-time mode, we must preserve out of line copy
643 representing node before inlining. Restore original outgoing edges
644 using clone we created earlier. */
645 if (!flag_unit_at_a_time)
647 struct cgraph_edge *e;
649 while (node->callees)
650 cgraph_remove_edge (node->callees);
651 node->callees = saved_node->callees;
652 saved_node->callees = NULL;
653 update_inlined_to_pointers (node, node);
654 for (e = node->callees; e; e = e->next_callee)
655 e->caller = node;
656 cgraph_remove_node (saved_node);
659 else
660 DECL_SAVED_TREE (fndecl) = NULL;
661 cfun = 0;
663 /* If requested, warn about function definitions where the function will
664 return a value (usually of some struct or union type) which itself will
665 take up a lot of stack space. */
666 if (warn_larger_than && !DECL_EXTERNAL (fndecl) && TREE_TYPE (fndecl))
668 tree ret_type = TREE_TYPE (TREE_TYPE (fndecl));
670 if (ret_type && TYPE_SIZE_UNIT (ret_type)
671 && TREE_CODE (TYPE_SIZE_UNIT (ret_type)) == INTEGER_CST
672 && 0 < compare_tree_int (TYPE_SIZE_UNIT (ret_type),
673 larger_than_size))
675 unsigned int size_as_int
676 = TREE_INT_CST_LOW (TYPE_SIZE_UNIT (ret_type));
678 if (compare_tree_int (TYPE_SIZE_UNIT (ret_type), size_as_int) == 0)
679 warning ("%Jsize of return value of '%D' is %u bytes",
680 fndecl, fndecl, size_as_int);
681 else
682 warning ("%Jsize of return value of '%D' is larger than %wd bytes",
683 fndecl, fndecl, larger_than_size);
687 if (!flag_inline_trees)
689 DECL_SAVED_TREE (fndecl) = NULL;
690 if (DECL_STRUCT_FUNCTION (fndecl) == 0
691 && !cgraph_node (fndecl)->origin)
693 /* Stop pointing to the local nodes about to be freed.
694 But DECL_INITIAL must remain nonzero so we know this
695 was an actual function definition.
696 For a nested function, this is done in c_pop_function_context.
697 If rest_of_compilation set this to 0, leave it 0. */
698 if (DECL_INITIAL (fndecl) != 0)
699 DECL_INITIAL (fndecl) = error_mark_node;
703 input_location = saved_loc;
705 ggc_collect ();
706 timevar_pop (TV_EXPAND);