[PATCH 2/2] S/390: Implement "target" attribute.
[official-gcc.git] / gcc / passes.c
blobba9bfc276b193099eb4a99cc6b4c7c9afd03568e
1 /* Top level of GCC compilers (cc1, cc1plus, etc.)
2 Copyright (C) 1987-2015 Free Software Foundation, Inc.
4 This file is part of GCC.
6 GCC is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 3, or (at your option) any later
9 version.
11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 for more details.
16 You should have received a copy of the GNU General Public License
17 along with GCC; see the file COPYING3. If not see
18 <http://www.gnu.org/licenses/>. */
20 /* This is the top level of cc1/c++.
21 It parses command args, opens files, invokes the various passes
22 in the proper order, and counts the time used by each.
23 Error messages and low-level interface to malloc also handled here. */
25 #include "config.h"
26 #include "system.h"
27 #include "coretypes.h"
28 #include "backend.h"
29 #include "target.h"
30 #include "rtl.h"
31 #include "tree.h"
32 #include "gimple.h"
33 #include "cfghooks.h"
34 #include "df.h"
35 #include "tm_p.h"
36 #include "ssa.h"
37 #include "emit-rtl.h"
38 #include "cgraph.h"
39 #include "lto-streamer.h"
40 #include "fold-const.h"
41 #include "varasm.h"
42 #include "output.h"
43 #include "graph.h"
44 #include "debug.h"
45 #include "cfgloop.h"
46 #include "value-prof.h"
47 #include "tree-cfg.h"
48 #include "tree-ssa-loop-manip.h"
49 #include "tree-into-ssa.h"
50 #include "tree-dfa.h"
51 #include "tree-ssa.h"
52 #include "tree-pass.h"
53 #include "plugin.h"
54 #include "ipa-utils.h"
55 #include "tree-pretty-print.h" /* for dump_function_header */
56 #include "context.h"
57 #include "pass_manager.h"
58 #include "cfgrtl.h"
59 #include "tree-ssa-live.h" /* For remove_unused_locals. */
60 #include "tree-cfgcleanup.h"
62 using namespace gcc;
64 /* This is used for debugging. It allows the current pass to printed
65 from anywhere in compilation.
66 The variable current_pass is also used for statistics and plugins. */
67 opt_pass *current_pass;
69 static void register_pass_name (opt_pass *, const char *);
71 /* Most passes are single-instance (within their context) and thus don't
72 need to implement cloning, but passes that support multiple instances
73 *must* provide their own implementation of the clone method.
75 Handle this by providing a default implemenation, but make it a fatal
76 error to call it. */
78 opt_pass *
79 opt_pass::clone ()
81 internal_error ("pass %s does not support cloning", name);
84 void
85 opt_pass::set_pass_param (unsigned int, bool)
87 internal_error ("pass %s needs a set_pass_param implementation to handle the"
88 " extra argument in NEXT_PASS", name);
91 bool
92 opt_pass::gate (function *)
94 return true;
97 unsigned int
98 opt_pass::execute (function *)
100 return 0;
103 opt_pass::opt_pass (const pass_data &data, context *ctxt)
104 : pass_data (data),
105 sub (NULL),
106 next (NULL),
107 static_pass_number (0),
108 m_ctxt (ctxt)
113 void
114 pass_manager::execute_early_local_passes ()
116 execute_pass_list (cfun, pass_build_ssa_passes_1->sub);
117 if (flag_check_pointer_bounds)
118 execute_pass_list (cfun, pass_chkp_instrumentation_passes_1->sub);
119 execute_pass_list (cfun, pass_local_optimization_passes_1->sub);
122 unsigned int
123 pass_manager::execute_pass_mode_switching ()
125 return pass_mode_switching_1->execute (cfun);
129 /* Call from anywhere to find out what pass this is. Useful for
130 printing out debugging information deep inside an service
131 routine. */
132 void
133 print_current_pass (FILE *file)
135 if (current_pass)
136 fprintf (file, "current pass = %s (%d)\n",
137 current_pass->name, current_pass->static_pass_number);
138 else
139 fprintf (file, "no current pass.\n");
143 /* Call from the debugger to get the current pass name. */
144 DEBUG_FUNCTION void
145 debug_pass (void)
147 print_current_pass (stderr);
152 /* Global variables used to communicate with passes. */
153 bool in_gimple_form;
156 /* This is called from various places for FUNCTION_DECL, VAR_DECL,
157 and TYPE_DECL nodes.
159 This does nothing for local (non-static) variables, unless the
160 variable is a register variable with DECL_ASSEMBLER_NAME set. In
161 that case, or if the variable is not an automatic, it sets up the
162 RTL and outputs any assembler code (label definition, storage
163 allocation and initialization).
165 DECL is the declaration. TOP_LEVEL is nonzero
166 if this declaration is not within a function. */
168 void
169 rest_of_decl_compilation (tree decl,
170 int top_level,
171 int at_end)
173 bool finalize = true;
175 /* We deferred calling assemble_alias so that we could collect
176 other attributes such as visibility. Emit the alias now. */
177 if (!in_lto_p)
179 tree alias;
180 alias = lookup_attribute ("alias", DECL_ATTRIBUTES (decl));
181 if (alias)
183 alias = TREE_VALUE (TREE_VALUE (alias));
184 alias = get_identifier (TREE_STRING_POINTER (alias));
185 /* A quirk of the initial implementation of aliases required that the
186 user add "extern" to all of them. Which is silly, but now
187 historical. Do note that the symbol is in fact locally defined. */
188 DECL_EXTERNAL (decl) = 0;
189 TREE_STATIC (decl) = 1;
190 assemble_alias (decl, alias);
191 finalize = false;
195 /* Can't defer this, because it needs to happen before any
196 later function definitions are processed. */
197 if (DECL_ASSEMBLER_NAME_SET_P (decl) && DECL_REGISTER (decl))
198 make_decl_rtl (decl);
200 /* Forward declarations for nested functions are not "external",
201 but we need to treat them as if they were. */
202 if (TREE_STATIC (decl) || DECL_EXTERNAL (decl)
203 || TREE_CODE (decl) == FUNCTION_DECL)
205 timevar_push (TV_VARCONST);
207 /* Don't output anything when a tentative file-scope definition
208 is seen. But at end of compilation, do output code for them.
210 We do output all variables and rely on
211 callgraph code to defer them except for forward declarations
212 (see gcc.c-torture/compile/920624-1.c) */
213 if ((at_end
214 || !DECL_DEFER_OUTPUT (decl)
215 || DECL_INITIAL (decl))
216 && (TREE_CODE (decl) != VAR_DECL || !DECL_HAS_VALUE_EXPR_P (decl))
217 && !DECL_EXTERNAL (decl))
219 /* When reading LTO unit, we also read varpool, so do not
220 rebuild it. */
221 if (in_lto_p && !at_end)
223 else if (finalize && TREE_CODE (decl) != FUNCTION_DECL)
224 varpool_node::finalize_decl (decl);
227 #ifdef ASM_FINISH_DECLARE_OBJECT
228 if (decl == last_assemble_variable_decl)
230 ASM_FINISH_DECLARE_OBJECT (asm_out_file, decl,
231 top_level, at_end);
233 #endif
235 /* Now that we have activated any function-specific attributes
236 that might affect function decl, particularly align, relayout it. */
237 if (TREE_CODE (decl) == FUNCTION_DECL)
238 targetm.target_option.relayout_function (decl);
240 timevar_pop (TV_VARCONST);
242 else if (TREE_CODE (decl) == TYPE_DECL
243 /* Like in rest_of_type_compilation, avoid confusing the debug
244 information machinery when there are errors. */
245 && !seen_error ())
247 timevar_push (TV_SYMOUT);
248 debug_hooks->type_decl (decl, !top_level);
249 timevar_pop (TV_SYMOUT);
252 /* Let cgraph know about the existence of variables. */
253 if (in_lto_p && !at_end)
255 else if (TREE_CODE (decl) == VAR_DECL && !DECL_EXTERNAL (decl)
256 && TREE_STATIC (decl))
257 varpool_node::get_create (decl);
259 /* Generate early debug for global variables. Any local variables will
260 be handled by either handling reachable functions from
261 finalize_compilation_unit (and by consequence, locally scoped
262 symbols), or by rest_of_type_compilation below.
264 Also, pick up function prototypes, which will be mostly ignored
265 by the different early_global_decl() hooks, but will at least be
266 used by Go's hijack of the debug_hooks to implement
267 -fdump-go-spec. */
268 if (!in_lto_p
269 && (TREE_CODE (decl) != FUNCTION_DECL
270 /* This will pick up function prototypes with no bodies,
271 which are not visible in finalize_compilation_unit()
272 while iterating with FOR_EACH_*_FUNCTION through the
273 symbol table. */
274 || !DECL_SAVED_TREE (decl))
276 /* We need to check both decl_function_context and
277 current_function_decl here to make sure local extern
278 declarations end up with the correct context.
280 For local extern declarations, decl_function_context is
281 empty, but current_function_decl is set to the function where
282 the extern was declared . Without the check for
283 !current_function_decl below, the local extern ends up
284 incorrectly with a top-level context.
286 For example:
288 namespace S
294 int i = 42;
296 extern int i; // Local extern declaration.
297 return i;
303 && !decl_function_context (decl)
304 && !current_function_decl
305 && DECL_SOURCE_LOCATION (decl) != BUILTINS_LOCATION
306 && (!decl_type_context (decl)
307 /* If we created a varpool node for the decl make sure to
308 call early_global_decl. Otherwise we miss changes
309 introduced by member definitions like
310 struct A { static int staticdatamember; };
311 int A::staticdatamember;
312 and thus have incomplete early debug and late debug
313 called from varpool node removal fails to handle it
314 properly. */
315 || (finalize
316 && TREE_CODE (decl) == VAR_DECL
317 && TREE_STATIC (decl) && !DECL_EXTERNAL (decl)))
318 /* Avoid confusing the debug information machinery when there are
319 errors. */
320 && !seen_error ())
321 (*debug_hooks->early_global_decl) (decl);
324 /* Called after finishing a record, union or enumeral type. */
326 void
327 rest_of_type_compilation (tree type, int toplev)
329 /* Avoid confusing the debug information machinery when there are
330 errors. */
331 if (seen_error ())
332 return;
334 timevar_push (TV_SYMOUT);
335 debug_hooks->type_decl (TYPE_STUB_DECL (type), !toplev);
336 timevar_pop (TV_SYMOUT);
341 void
342 pass_manager::
343 finish_optimization_passes (void)
345 int i;
346 struct dump_file_info *dfi;
347 char *name;
348 gcc::dump_manager *dumps = m_ctxt->get_dumps ();
350 timevar_push (TV_DUMP);
351 if (profile_arc_flag || flag_test_coverage || flag_branch_probabilities)
353 dumps->dump_start (pass_profile_1->static_pass_number, NULL);
354 end_branch_prob ();
355 dumps->dump_finish (pass_profile_1->static_pass_number);
358 if (optimize > 0)
360 dumps->dump_start (pass_profile_1->static_pass_number, NULL);
361 print_combine_total_stats ();
362 dumps->dump_finish (pass_profile_1->static_pass_number);
365 /* Do whatever is necessary to finish printing the graphs. */
366 for (i = TDI_end; (dfi = dumps->get_dump_file_info (i)) != NULL; ++i)
367 if (dumps->dump_initialized_p (i)
368 && (dfi->pflags & TDF_GRAPH) != 0
369 && (name = dumps->get_dump_file_name (i)) != NULL)
371 finish_graph_dump_file (name);
372 free (name);
375 timevar_pop (TV_DUMP);
378 static unsigned int
379 execute_build_ssa_passes (void)
381 /* Once this pass (and its sub-passes) are complete, all functions
382 will be in SSA form. Technically this state change is happening
383 a tad early, since the sub-passes have not yet run, but since
384 none of the sub-passes are IPA passes and do not create new
385 functions, this is ok. We're setting this value for the benefit
386 of IPA passes that follow. */
387 if (symtab->state < IPA_SSA)
388 symtab->state = IPA_SSA;
389 return 0;
392 namespace {
394 const pass_data pass_data_build_ssa_passes =
396 SIMPLE_IPA_PASS, /* type */
397 "build_ssa_passes", /* name */
398 OPTGROUP_NONE, /* optinfo_flags */
399 TV_EARLY_LOCAL, /* tv_id */
400 0, /* properties_required */
401 0, /* properties_provided */
402 0, /* properties_destroyed */
403 0, /* todo_flags_start */
404 /* todo_flags_finish is executed before subpases. For this reason
405 it makes no sense to remove unreachable functions here. */
406 0, /* todo_flags_finish */
409 class pass_build_ssa_passes : public simple_ipa_opt_pass
411 public:
412 pass_build_ssa_passes (gcc::context *ctxt)
413 : simple_ipa_opt_pass (pass_data_build_ssa_passes, ctxt)
416 /* opt_pass methods: */
417 virtual bool gate (function *)
419 /* Don't bother doing anything if the program has errors. */
420 return (!seen_error () && !in_lto_p);
423 virtual unsigned int execute (function *)
425 return execute_build_ssa_passes ();
428 }; // class pass_build_ssa_passes
430 const pass_data pass_data_chkp_instrumentation_passes =
432 SIMPLE_IPA_PASS, /* type */
433 "chkp_passes", /* name */
434 OPTGROUP_NONE, /* optinfo_flags */
435 TV_NONE, /* tv_id */
436 0, /* properties_required */
437 0, /* properties_provided */
438 0, /* properties_destroyed */
439 0, /* todo_flags_start */
440 0, /* todo_flags_finish */
443 class pass_chkp_instrumentation_passes : public simple_ipa_opt_pass
445 public:
446 pass_chkp_instrumentation_passes (gcc::context *ctxt)
447 : simple_ipa_opt_pass (pass_data_chkp_instrumentation_passes, ctxt)
450 /* opt_pass methods: */
451 virtual bool gate (function *)
453 /* Don't bother doing anything if the program has errors. */
454 return (flag_check_pointer_bounds
455 && !seen_error () && !in_lto_p);
458 }; // class pass_chkp_instrumentation_passes
460 const pass_data pass_data_local_optimization_passes =
462 SIMPLE_IPA_PASS, /* type */
463 "opt_local_passes", /* name */
464 OPTGROUP_NONE, /* optinfo_flags */
465 TV_NONE, /* tv_id */
466 0, /* properties_required */
467 0, /* properties_provided */
468 0, /* properties_destroyed */
469 0, /* todo_flags_start */
470 0, /* todo_flags_finish */
473 class pass_local_optimization_passes : public simple_ipa_opt_pass
475 public:
476 pass_local_optimization_passes (gcc::context *ctxt)
477 : simple_ipa_opt_pass (pass_data_local_optimization_passes, ctxt)
480 /* opt_pass methods: */
481 virtual bool gate (function *)
483 /* Don't bother doing anything if the program has errors. */
484 return (!seen_error () && !in_lto_p);
487 }; // class pass_local_optimization_passes
489 } // anon namespace
491 simple_ipa_opt_pass *
492 make_pass_build_ssa_passes (gcc::context *ctxt)
494 return new pass_build_ssa_passes (ctxt);
497 simple_ipa_opt_pass *
498 make_pass_chkp_instrumentation_passes (gcc::context *ctxt)
500 return new pass_chkp_instrumentation_passes (ctxt);
503 simple_ipa_opt_pass *
504 make_pass_local_optimization_passes (gcc::context *ctxt)
506 return new pass_local_optimization_passes (ctxt);
509 namespace {
511 const pass_data pass_data_all_early_optimizations =
513 GIMPLE_PASS, /* type */
514 "early_optimizations", /* name */
515 OPTGROUP_NONE, /* optinfo_flags */
516 TV_NONE, /* tv_id */
517 0, /* properties_required */
518 0, /* properties_provided */
519 0, /* properties_destroyed */
520 0, /* todo_flags_start */
521 0, /* todo_flags_finish */
524 class pass_all_early_optimizations : public gimple_opt_pass
526 public:
527 pass_all_early_optimizations (gcc::context *ctxt)
528 : gimple_opt_pass (pass_data_all_early_optimizations, ctxt)
531 /* opt_pass methods: */
532 virtual bool gate (function *)
534 return (optimize >= 1
535 /* Don't bother doing anything if the program has errors. */
536 && !seen_error ());
539 }; // class pass_all_early_optimizations
541 } // anon namespace
543 static gimple_opt_pass *
544 make_pass_all_early_optimizations (gcc::context *ctxt)
546 return new pass_all_early_optimizations (ctxt);
549 namespace {
551 const pass_data pass_data_all_optimizations =
553 GIMPLE_PASS, /* type */
554 "*all_optimizations", /* name */
555 OPTGROUP_NONE, /* optinfo_flags */
556 TV_OPTIMIZE, /* tv_id */
557 0, /* properties_required */
558 0, /* properties_provided */
559 0, /* properties_destroyed */
560 0, /* todo_flags_start */
561 0, /* todo_flags_finish */
564 class pass_all_optimizations : public gimple_opt_pass
566 public:
567 pass_all_optimizations (gcc::context *ctxt)
568 : gimple_opt_pass (pass_data_all_optimizations, ctxt)
571 /* opt_pass methods: */
572 virtual bool gate (function *) { return optimize >= 1 && !optimize_debug; }
574 }; // class pass_all_optimizations
576 } // anon namespace
578 static gimple_opt_pass *
579 make_pass_all_optimizations (gcc::context *ctxt)
581 return new pass_all_optimizations (ctxt);
584 namespace {
586 const pass_data pass_data_all_optimizations_g =
588 GIMPLE_PASS, /* type */
589 "*all_optimizations_g", /* name */
590 OPTGROUP_NONE, /* optinfo_flags */
591 TV_OPTIMIZE, /* tv_id */
592 0, /* properties_required */
593 0, /* properties_provided */
594 0, /* properties_destroyed */
595 0, /* todo_flags_start */
596 0, /* todo_flags_finish */
599 class pass_all_optimizations_g : public gimple_opt_pass
601 public:
602 pass_all_optimizations_g (gcc::context *ctxt)
603 : gimple_opt_pass (pass_data_all_optimizations_g, ctxt)
606 /* opt_pass methods: */
607 virtual bool gate (function *) { return optimize >= 1 && optimize_debug; }
609 }; // class pass_all_optimizations_g
611 } // anon namespace
613 static gimple_opt_pass *
614 make_pass_all_optimizations_g (gcc::context *ctxt)
616 return new pass_all_optimizations_g (ctxt);
619 namespace {
621 const pass_data pass_data_rest_of_compilation =
623 RTL_PASS, /* type */
624 "*rest_of_compilation", /* name */
625 OPTGROUP_NONE, /* optinfo_flags */
626 TV_REST_OF_COMPILATION, /* tv_id */
627 PROP_rtl, /* properties_required */
628 0, /* properties_provided */
629 0, /* properties_destroyed */
630 0, /* todo_flags_start */
631 0, /* todo_flags_finish */
634 class pass_rest_of_compilation : public rtl_opt_pass
636 public:
637 pass_rest_of_compilation (gcc::context *ctxt)
638 : rtl_opt_pass (pass_data_rest_of_compilation, ctxt)
641 /* opt_pass methods: */
642 virtual bool gate (function *)
644 /* Early return if there were errors. We can run afoul of our
645 consistency checks, and there's not really much point in fixing them. */
646 return !(rtl_dump_and_exit || flag_syntax_only || seen_error ());
649 }; // class pass_rest_of_compilation
651 } // anon namespace
653 static rtl_opt_pass *
654 make_pass_rest_of_compilation (gcc::context *ctxt)
656 return new pass_rest_of_compilation (ctxt);
659 namespace {
661 const pass_data pass_data_postreload =
663 RTL_PASS, /* type */
664 "*all-postreload", /* name */
665 OPTGROUP_NONE, /* optinfo_flags */
666 TV_POSTRELOAD, /* tv_id */
667 PROP_rtl, /* properties_required */
668 0, /* properties_provided */
669 0, /* properties_destroyed */
670 0, /* todo_flags_start */
671 0, /* todo_flags_finish */
674 class pass_postreload : public rtl_opt_pass
676 public:
677 pass_postreload (gcc::context *ctxt)
678 : rtl_opt_pass (pass_data_postreload, ctxt)
681 /* opt_pass methods: */
682 virtual bool gate (function *) { return reload_completed; }
684 }; // class pass_postreload
686 } // anon namespace
688 static rtl_opt_pass *
689 make_pass_postreload (gcc::context *ctxt)
691 return new pass_postreload (ctxt);
694 namespace {
696 const pass_data pass_data_late_compilation =
698 RTL_PASS, /* type */
699 "*all-late_compilation", /* name */
700 OPTGROUP_NONE, /* optinfo_flags */
701 TV_LATE_COMPILATION, /* tv_id */
702 PROP_rtl, /* properties_required */
703 0, /* properties_provided */
704 0, /* properties_destroyed */
705 0, /* todo_flags_start */
706 0, /* todo_flags_finish */
709 class pass_late_compilation : public rtl_opt_pass
711 public:
712 pass_late_compilation (gcc::context *ctxt)
713 : rtl_opt_pass (pass_data_late_compilation, ctxt)
716 /* opt_pass methods: */
717 virtual bool gate (function *)
719 return reload_completed || targetm.no_register_allocation;
722 }; // class pass_late_compilation
724 } // anon namespace
726 static rtl_opt_pass *
727 make_pass_late_compilation (gcc::context *ctxt)
729 return new pass_late_compilation (ctxt);
734 /* Set the static pass number of pass PASS to ID and record that
735 in the mapping from static pass number to pass. */
737 void
738 pass_manager::
739 set_pass_for_id (int id, opt_pass *pass)
741 pass->static_pass_number = id;
742 if (passes_by_id_size <= id)
744 passes_by_id = XRESIZEVEC (opt_pass *, passes_by_id, id + 1);
745 memset (passes_by_id + passes_by_id_size, 0,
746 (id + 1 - passes_by_id_size) * sizeof (void *));
747 passes_by_id_size = id + 1;
749 passes_by_id[id] = pass;
752 /* Return the pass with the static pass number ID. */
754 opt_pass *
755 pass_manager::get_pass_for_id (int id) const
757 if (id >= passes_by_id_size)
758 return NULL;
759 return passes_by_id[id];
762 /* Iterate over the pass tree allocating dump file numbers. We want
763 to do this depth first, and independent of whether the pass is
764 enabled or not. */
766 void
767 register_one_dump_file (opt_pass *pass)
769 g->get_passes ()->register_one_dump_file (pass);
772 void
773 pass_manager::register_one_dump_file (opt_pass *pass)
775 char *dot_name, *flag_name, *glob_name;
776 const char *name, *full_name, *prefix;
777 char num[10];
778 int flags, id;
779 int optgroup_flags = OPTGROUP_NONE;
780 gcc::dump_manager *dumps = m_ctxt->get_dumps ();
782 /* See below in next_pass_1. */
783 num[0] = '\0';
784 if (pass->static_pass_number != -1)
785 sprintf (num, "%d", ((int) pass->static_pass_number < 0
786 ? 1 : pass->static_pass_number));
788 /* The name is both used to identify the pass for the purposes of plugins,
789 and to specify dump file name and option.
790 The latter two might want something short which is not quite unique; for
791 that reason, we may have a disambiguating prefix, followed by a space
792 to mark the start of the following dump file name / option string. */
793 name = strchr (pass->name, ' ');
794 name = name ? name + 1 : pass->name;
795 dot_name = concat (".", name, num, NULL);
796 if (pass->type == SIMPLE_IPA_PASS || pass->type == IPA_PASS)
798 prefix = "ipa-";
799 flags = TDF_IPA;
800 optgroup_flags |= OPTGROUP_IPA;
802 else if (pass->type == GIMPLE_PASS)
804 prefix = "tree-";
805 flags = TDF_TREE;
807 else
809 prefix = "rtl-";
810 flags = TDF_RTL;
813 flag_name = concat (prefix, name, num, NULL);
814 glob_name = concat (prefix, name, NULL);
815 optgroup_flags |= pass->optinfo_flags;
816 /* For any passes that do not have an optgroup set, and which are not
817 IPA passes setup above, set the optgroup to OPTGROUP_OTHER so that
818 any dump messages are emitted properly under -fopt-info(-optall). */
819 if (optgroup_flags == OPTGROUP_NONE)
820 optgroup_flags = OPTGROUP_OTHER;
821 id = dumps->dump_register (dot_name, flag_name, glob_name, flags,
822 optgroup_flags,
823 true);
824 set_pass_for_id (id, pass);
825 full_name = concat (prefix, pass->name, num, NULL);
826 register_pass_name (pass, full_name);
827 free (CONST_CAST (char *, full_name));
830 /* Register the dump files for the pass_manager starting at PASS. */
832 void
833 pass_manager::register_dump_files (opt_pass *pass)
837 if (pass->name && pass->name[0] != '*')
838 register_one_dump_file (pass);
840 if (pass->sub)
841 register_dump_files (pass->sub);
843 pass = pass->next;
845 while (pass);
848 static hash_map<nofree_string_hash, opt_pass *> *name_to_pass_map;
850 /* Register PASS with NAME. */
852 static void
853 register_pass_name (opt_pass *pass, const char *name)
855 if (!name_to_pass_map)
856 name_to_pass_map = new hash_map<nofree_string_hash, opt_pass *> (256);
858 if (name_to_pass_map->get (name))
859 return; /* Ignore plugin passes. */
861 const char *unique_name = xstrdup (name);
862 name_to_pass_map->put (unique_name, pass);
865 /* Map from pass id to canonicalized pass name. */
867 typedef const char *char_ptr;
868 static vec<char_ptr> pass_tab = vNULL;
870 /* Callback function for traversing NAME_TO_PASS_MAP. */
872 bool
873 passes_pass_traverse (const char *const &name, opt_pass *const &pass, void *)
875 gcc_assert (pass->static_pass_number > 0);
876 gcc_assert (pass_tab.exists ());
878 pass_tab[pass->static_pass_number] = name;
880 return 1;
883 /* The function traverses NAME_TO_PASS_MAP and creates a pass info
884 table for dumping purpose. */
886 static void
887 create_pass_tab (void)
889 if (!flag_dump_passes)
890 return;
892 pass_tab.safe_grow_cleared (g->get_passes ()->passes_by_id_size + 1);
893 name_to_pass_map->traverse <void *, passes_pass_traverse> (NULL);
896 static bool override_gate_status (opt_pass *, tree, bool);
898 /* Dump the instantiated name for PASS. IS_ON indicates if PASS
899 is turned on or not. */
901 static void
902 dump_one_pass (opt_pass *pass, int pass_indent)
904 int indent = 3 * pass_indent;
905 const char *pn;
906 bool is_on, is_really_on;
908 is_on = pass->gate (cfun);
909 is_really_on = override_gate_status (pass, current_function_decl, is_on);
911 if (pass->static_pass_number <= 0)
912 pn = pass->name;
913 else
914 pn = pass_tab[pass->static_pass_number];
916 fprintf (stderr, "%*s%-40s%*s:%s%s\n", indent, " ", pn,
917 (15 - indent < 0 ? 0 : 15 - indent), " ",
918 is_on ? " ON" : " OFF",
919 ((!is_on) == (!is_really_on) ? ""
920 : (is_really_on ? " (FORCED_ON)" : " (FORCED_OFF)")));
923 /* Dump pass list PASS with indentation INDENT. */
925 static void
926 dump_pass_list (opt_pass *pass, int indent)
930 dump_one_pass (pass, indent);
931 if (pass->sub)
932 dump_pass_list (pass->sub, indent + 1);
933 pass = pass->next;
935 while (pass);
938 /* Dump all optimization passes. */
940 void
941 dump_passes (void)
943 g->get_passes ()->dump_passes ();
946 void
947 pass_manager::dump_passes () const
949 push_dummy_function (true);
951 create_pass_tab ();
953 dump_pass_list (all_lowering_passes, 1);
954 dump_pass_list (all_small_ipa_passes, 1);
955 dump_pass_list (all_regular_ipa_passes, 1);
956 dump_pass_list (all_late_ipa_passes, 1);
957 dump_pass_list (all_passes, 1);
959 pop_dummy_function ();
962 /* Returns the pass with NAME. */
964 static opt_pass *
965 get_pass_by_name (const char *name)
967 opt_pass **p = name_to_pass_map->get (name);
968 if (p)
969 return *p;
971 return NULL;
975 /* Range [start, last]. */
977 struct uid_range
979 unsigned int start;
980 unsigned int last;
981 const char *assem_name;
982 struct uid_range *next;
985 typedef struct uid_range *uid_range_p;
988 static vec<uid_range_p>
989 enabled_pass_uid_range_tab = vNULL;
990 static vec<uid_range_p>
991 disabled_pass_uid_range_tab = vNULL;
994 /* Parse option string for -fdisable- and -fenable-
995 The syntax of the options:
997 -fenable-<pass_name>
998 -fdisable-<pass_name>
1000 -fenable-<pass_name>=s1:e1,s2:e2,...
1001 -fdisable-<pass_name>=s1:e1,s2:e2,...
1004 static void
1005 enable_disable_pass (const char *arg, bool is_enable)
1007 opt_pass *pass;
1008 char *range_str, *phase_name;
1009 char *argstr = xstrdup (arg);
1010 vec<uid_range_p> *tab = 0;
1012 range_str = strchr (argstr,'=');
1013 if (range_str)
1015 *range_str = '\0';
1016 range_str++;
1019 phase_name = argstr;
1020 if (!*phase_name)
1022 if (is_enable)
1023 error ("unrecognized option -fenable");
1024 else
1025 error ("unrecognized option -fdisable");
1026 free (argstr);
1027 return;
1029 pass = get_pass_by_name (phase_name);
1030 if (!pass || pass->static_pass_number == -1)
1032 if (is_enable)
1033 error ("unknown pass %s specified in -fenable", phase_name);
1034 else
1035 error ("unknown pass %s specified in -fdisable", phase_name);
1036 free (argstr);
1037 return;
1040 if (is_enable)
1041 tab = &enabled_pass_uid_range_tab;
1042 else
1043 tab = &disabled_pass_uid_range_tab;
1045 if ((unsigned) pass->static_pass_number >= tab->length ())
1046 tab->safe_grow_cleared (pass->static_pass_number + 1);
1048 if (!range_str)
1050 uid_range_p slot;
1051 uid_range_p new_range = XCNEW (struct uid_range);
1053 new_range->start = 0;
1054 new_range->last = (unsigned)-1;
1056 slot = (*tab)[pass->static_pass_number];
1057 new_range->next = slot;
1058 (*tab)[pass->static_pass_number] = new_range;
1059 if (is_enable)
1060 inform (UNKNOWN_LOCATION, "enable pass %s for functions in the range "
1061 "of [%u, %u]", phase_name, new_range->start, new_range->last);
1062 else
1063 inform (UNKNOWN_LOCATION, "disable pass %s for functions in the range "
1064 "of [%u, %u]", phase_name, new_range->start, new_range->last);
1066 else
1068 char *next_range = NULL;
1069 char *one_range = range_str;
1070 char *end_val = NULL;
1074 uid_range_p slot;
1075 uid_range_p new_range;
1076 char *invalid = NULL;
1077 long start;
1078 char *func_name = NULL;
1080 next_range = strchr (one_range, ',');
1081 if (next_range)
1083 *next_range = '\0';
1084 next_range++;
1087 end_val = strchr (one_range, ':');
1088 if (end_val)
1090 *end_val = '\0';
1091 end_val++;
1093 start = strtol (one_range, &invalid, 10);
1094 if (*invalid || start < 0)
1096 if (end_val || (one_range[0] >= '0'
1097 && one_range[0] <= '9'))
1099 error ("Invalid range %s in option %s",
1100 one_range,
1101 is_enable ? "-fenable" : "-fdisable");
1102 free (argstr);
1103 return;
1105 func_name = one_range;
1107 if (!end_val)
1109 new_range = XCNEW (struct uid_range);
1110 if (!func_name)
1112 new_range->start = (unsigned) start;
1113 new_range->last = (unsigned) start;
1115 else
1117 new_range->start = (unsigned) -1;
1118 new_range->last = (unsigned) -1;
1119 new_range->assem_name = xstrdup (func_name);
1122 else
1124 long last = strtol (end_val, &invalid, 10);
1125 if (*invalid || last < start)
1127 error ("Invalid range %s in option %s",
1128 end_val,
1129 is_enable ? "-fenable" : "-fdisable");
1130 free (argstr);
1131 return;
1133 new_range = XCNEW (struct uid_range);
1134 new_range->start = (unsigned) start;
1135 new_range->last = (unsigned) last;
1138 slot = (*tab)[pass->static_pass_number];
1139 new_range->next = slot;
1140 (*tab)[pass->static_pass_number] = new_range;
1141 if (is_enable)
1143 if (new_range->assem_name)
1144 inform (UNKNOWN_LOCATION,
1145 "enable pass %s for function %s",
1146 phase_name, new_range->assem_name);
1147 else
1148 inform (UNKNOWN_LOCATION,
1149 "enable pass %s for functions in the range of [%u, %u]",
1150 phase_name, new_range->start, new_range->last);
1152 else
1154 if (new_range->assem_name)
1155 inform (UNKNOWN_LOCATION,
1156 "disable pass %s for function %s",
1157 phase_name, new_range->assem_name);
1158 else
1159 inform (UNKNOWN_LOCATION,
1160 "disable pass %s for functions in the range of [%u, %u]",
1161 phase_name, new_range->start, new_range->last);
1164 one_range = next_range;
1165 } while (next_range);
1168 free (argstr);
1171 /* Enable pass specified by ARG. */
1173 void
1174 enable_pass (const char *arg)
1176 enable_disable_pass (arg, true);
1179 /* Disable pass specified by ARG. */
1181 void
1182 disable_pass (const char *arg)
1184 enable_disable_pass (arg, false);
1187 /* Returns true if PASS is explicitly enabled/disabled for FUNC. */
1189 static bool
1190 is_pass_explicitly_enabled_or_disabled (opt_pass *pass,
1191 tree func,
1192 vec<uid_range_p> tab)
1194 uid_range_p slot, range;
1195 int cgraph_uid;
1196 const char *aname = NULL;
1198 if (!tab.exists ()
1199 || (unsigned) pass->static_pass_number >= tab.length ()
1200 || pass->static_pass_number == -1)
1201 return false;
1203 slot = tab[pass->static_pass_number];
1204 if (!slot)
1205 return false;
1207 cgraph_uid = func ? cgraph_node::get (func)->uid : 0;
1208 if (func && DECL_ASSEMBLER_NAME_SET_P (func))
1209 aname = IDENTIFIER_POINTER (DECL_ASSEMBLER_NAME (func));
1211 range = slot;
1212 while (range)
1214 if ((unsigned) cgraph_uid >= range->start
1215 && (unsigned) cgraph_uid <= range->last)
1216 return true;
1217 if (range->assem_name && aname
1218 && !strcmp (range->assem_name, aname))
1219 return true;
1220 range = range->next;
1223 return false;
1227 /* Update static_pass_number for passes (and the flag
1228 TODO_mark_first_instance).
1230 Passes are constructed with static_pass_number preinitialized to 0
1232 This field is used in two different ways: initially as instance numbers
1233 of their kind, and then as ids within the entire pass manager.
1235 Within pass_manager::pass_manager:
1237 * In add_pass_instance(), as called by next_pass_1 in
1238 NEXT_PASS in init_optimization_passes
1240 * When the initial instance of a pass within a pass manager is seen,
1241 it is flagged, and its static_pass_number is set to -1
1243 * On subsequent times that it is seen, the static pass number
1244 is decremented each time, so that if there are e.g. 4 dups,
1245 they have static_pass_number -4, 2, 3, 4 respectively (note
1246 how the initial one is negative and gives the count); these
1247 can be thought of as instance numbers of the specific pass
1249 * Within the register_dump_files () traversal, set_pass_for_id()
1250 is called on each pass, using these instance numbers to create
1251 dumpfile switches, and then overwriting them with a pass id,
1252 which are global to the whole pass manager (based on
1253 (TDI_end + current value of extra_dump_files_in_use) ) */
1255 static void
1256 add_pass_instance (opt_pass *new_pass, bool track_duplicates,
1257 opt_pass *initial_pass)
1259 /* Are we dealing with the first pass of its kind, or a clone? */
1260 if (new_pass != initial_pass)
1262 /* We're dealing with a clone. */
1263 new_pass->todo_flags_start &= ~TODO_mark_first_instance;
1265 /* Indicate to register_dump_files that this pass has duplicates,
1266 and so it should rename the dump file. The first instance will
1267 be -1, and be number of duplicates = -static_pass_number - 1.
1268 Subsequent instances will be > 0 and just the duplicate number. */
1269 if ((new_pass->name && new_pass->name[0] != '*') || track_duplicates)
1271 initial_pass->static_pass_number -= 1;
1272 new_pass->static_pass_number = -initial_pass->static_pass_number;
1275 else
1277 /* We're dealing with the first pass of its kind. */
1278 new_pass->todo_flags_start |= TODO_mark_first_instance;
1279 new_pass->static_pass_number = -1;
1281 invoke_plugin_callbacks (PLUGIN_NEW_PASS, new_pass);
1285 /* Add a pass to the pass list. Duplicate the pass if it's already
1286 in the list. */
1288 static opt_pass **
1289 next_pass_1 (opt_pass **list, opt_pass *pass, opt_pass *initial_pass)
1291 /* Every pass should have a name so that plugins can refer to them. */
1292 gcc_assert (pass->name != NULL);
1294 add_pass_instance (pass, false, initial_pass);
1295 *list = pass;
1297 return &(*list)->next;
1300 /* List node for an inserted pass instance. We need to keep track of all
1301 the newly-added pass instances (with 'added_pass_nodes' defined below)
1302 so that we can register their dump files after pass-positioning is finished.
1303 Registering dumping files needs to be post-processed or the
1304 static_pass_number of the opt_pass object would be modified and mess up
1305 the dump file names of future pass instances to be added. */
1307 struct pass_list_node
1309 opt_pass *pass;
1310 struct pass_list_node *next;
1313 static struct pass_list_node *added_pass_nodes = NULL;
1314 static struct pass_list_node *prev_added_pass_node;
1316 /* Insert the pass at the proper position. Return true if the pass
1317 is successfully added.
1319 NEW_PASS_INFO - new pass to be inserted
1320 PASS_LIST - root of the pass list to insert the new pass to */
1322 static bool
1323 position_pass (struct register_pass_info *new_pass_info, opt_pass **pass_list)
1325 opt_pass *pass = *pass_list, *prev_pass = NULL;
1326 bool success = false;
1328 for ( ; pass; prev_pass = pass, pass = pass->next)
1330 /* Check if the current pass is of the same type as the new pass and
1331 matches the name and the instance number of the reference pass. */
1332 if (pass->type == new_pass_info->pass->type
1333 && pass->name
1334 && !strcmp (pass->name, new_pass_info->reference_pass_name)
1335 && ((new_pass_info->ref_pass_instance_number == 0)
1336 || (new_pass_info->ref_pass_instance_number ==
1337 pass->static_pass_number)
1338 || (new_pass_info->ref_pass_instance_number == 1
1339 && pass->todo_flags_start & TODO_mark_first_instance)))
1341 opt_pass *new_pass;
1342 struct pass_list_node *new_pass_node;
1344 if (new_pass_info->ref_pass_instance_number == 0)
1346 new_pass = new_pass_info->pass->clone ();
1347 add_pass_instance (new_pass, true, new_pass_info->pass);
1349 else
1351 new_pass = new_pass_info->pass;
1352 add_pass_instance (new_pass, true, new_pass);
1355 /* Insert the new pass instance based on the positioning op. */
1356 switch (new_pass_info->pos_op)
1358 case PASS_POS_INSERT_AFTER:
1359 new_pass->next = pass->next;
1360 pass->next = new_pass;
1362 /* Skip newly inserted pass to avoid repeated
1363 insertions in the case where the new pass and the
1364 existing one have the same name. */
1365 pass = new_pass;
1366 break;
1367 case PASS_POS_INSERT_BEFORE:
1368 new_pass->next = pass;
1369 if (prev_pass)
1370 prev_pass->next = new_pass;
1371 else
1372 *pass_list = new_pass;
1373 break;
1374 case PASS_POS_REPLACE:
1375 new_pass->next = pass->next;
1376 if (prev_pass)
1377 prev_pass->next = new_pass;
1378 else
1379 *pass_list = new_pass;
1380 new_pass->sub = pass->sub;
1381 new_pass->tv_id = pass->tv_id;
1382 pass = new_pass;
1383 break;
1384 default:
1385 error ("invalid pass positioning operation");
1386 return false;
1389 /* Save the newly added pass (instance) in the added_pass_nodes
1390 list so that we can register its dump file later. Note that
1391 we cannot register the dump file now because doing so will modify
1392 the static_pass_number of the opt_pass object and therefore
1393 mess up the dump file name of future instances. */
1394 new_pass_node = XCNEW (struct pass_list_node);
1395 new_pass_node->pass = new_pass;
1396 if (!added_pass_nodes)
1397 added_pass_nodes = new_pass_node;
1398 else
1399 prev_added_pass_node->next = new_pass_node;
1400 prev_added_pass_node = new_pass_node;
1402 success = true;
1405 if (pass->sub && position_pass (new_pass_info, &pass->sub))
1406 success = true;
1409 return success;
1412 /* Hooks a new pass into the pass lists.
1414 PASS_INFO - pass information that specifies the opt_pass object,
1415 reference pass, instance number, and how to position
1416 the pass */
1418 void
1419 register_pass (struct register_pass_info *pass_info)
1421 g->get_passes ()->register_pass (pass_info);
1424 void
1425 register_pass (opt_pass* pass, pass_positioning_ops pos,
1426 const char* ref_pass_name, int ref_pass_inst_number)
1428 register_pass_info i;
1429 i.pass = pass;
1430 i.reference_pass_name = ref_pass_name;
1431 i.ref_pass_instance_number = ref_pass_inst_number;
1432 i.pos_op = pos;
1434 g->get_passes ()->register_pass (&i);
1437 void
1438 pass_manager::register_pass (struct register_pass_info *pass_info)
1440 bool all_instances, success;
1441 gcc::dump_manager *dumps = m_ctxt->get_dumps ();
1443 /* The checks below could fail in buggy plugins. Existing GCC
1444 passes should never fail these checks, so we mention plugin in
1445 the messages. */
1446 if (!pass_info->pass)
1447 fatal_error (input_location, "plugin cannot register a missing pass");
1449 if (!pass_info->pass->name)
1450 fatal_error (input_location, "plugin cannot register an unnamed pass");
1452 if (!pass_info->reference_pass_name)
1453 fatal_error
1454 (input_location,
1455 "plugin cannot register pass %qs without reference pass name",
1456 pass_info->pass->name);
1458 /* Try to insert the new pass to the pass lists. We need to check
1459 all five lists as the reference pass could be in one (or all) of
1460 them. */
1461 all_instances = pass_info->ref_pass_instance_number == 0;
1462 success = position_pass (pass_info, &all_lowering_passes);
1463 if (!success || all_instances)
1464 success |= position_pass (pass_info, &all_small_ipa_passes);
1465 if (!success || all_instances)
1466 success |= position_pass (pass_info, &all_regular_ipa_passes);
1467 if (!success || all_instances)
1468 success |= position_pass (pass_info, &all_late_ipa_passes);
1469 if (!success || all_instances)
1470 success |= position_pass (pass_info, &all_passes);
1471 if (!success)
1472 fatal_error
1473 (input_location,
1474 "pass %qs not found but is referenced by new pass %qs",
1475 pass_info->reference_pass_name, pass_info->pass->name);
1477 /* OK, we have successfully inserted the new pass. We need to register
1478 the dump files for the newly added pass and its duplicates (if any).
1479 Because the registration of plugin/backend passes happens after the
1480 command-line options are parsed, the options that specify single
1481 pass dumping (e.g. -fdump-tree-PASSNAME) cannot be used for new
1482 passes. Therefore we currently can only enable dumping of
1483 new passes when the 'dump-all' flags (e.g. -fdump-tree-all)
1484 are specified. While doing so, we also delete the pass_list_node
1485 objects created during pass positioning. */
1486 while (added_pass_nodes)
1488 struct pass_list_node *next_node = added_pass_nodes->next;
1489 enum tree_dump_index tdi;
1490 register_one_dump_file (added_pass_nodes->pass);
1491 if (added_pass_nodes->pass->type == SIMPLE_IPA_PASS
1492 || added_pass_nodes->pass->type == IPA_PASS)
1493 tdi = TDI_ipa_all;
1494 else if (added_pass_nodes->pass->type == GIMPLE_PASS)
1495 tdi = TDI_tree_all;
1496 else
1497 tdi = TDI_rtl_all;
1498 /* Check if dump-all flag is specified. */
1499 if (dumps->get_dump_file_info (tdi)->pstate)
1500 dumps->get_dump_file_info (added_pass_nodes->pass->static_pass_number)
1501 ->pstate = dumps->get_dump_file_info (tdi)->pstate;
1502 XDELETE (added_pass_nodes);
1503 added_pass_nodes = next_node;
1507 /* Construct the pass tree. The sequencing of passes is driven by
1508 the cgraph routines:
1510 finalize_compilation_unit ()
1511 for each node N in the cgraph
1512 cgraph_analyze_function (N)
1513 cgraph_lower_function (N) -> all_lowering_passes
1515 If we are optimizing, compile is then invoked:
1517 compile ()
1518 ipa_passes () -> all_small_ipa_passes
1519 -> Analysis of all_regular_ipa_passes
1520 * possible LTO streaming at copmilation time *
1521 -> Execution of all_regular_ipa_passes
1522 * possible LTO streaming at link time *
1523 -> all_late_ipa_passes
1524 expand_all_functions ()
1525 for each node N in the cgraph
1526 expand_function (N) -> Transformation of all_regular_ipa_passes
1527 -> all_passes
1530 void *
1531 pass_manager::operator new (size_t sz)
1533 /* Ensure that all fields of the pass manager are zero-initialized. */
1534 return xcalloc (1, sz);
1537 void
1538 pass_manager::operator delete (void *ptr)
1540 free (ptr);
1543 pass_manager::pass_manager (context *ctxt)
1544 : all_passes (NULL), all_small_ipa_passes (NULL), all_lowering_passes (NULL),
1545 all_regular_ipa_passes (NULL),
1546 all_late_ipa_passes (NULL), passes_by_id (NULL), passes_by_id_size (0),
1547 m_ctxt (ctxt)
1549 opt_pass **p;
1551 /* Initialize the pass_lists array. */
1552 #define DEF_PASS_LIST(LIST) pass_lists[PASS_LIST_NO_##LIST] = &LIST;
1553 GCC_PASS_LISTS
1554 #undef DEF_PASS_LIST
1556 /* Build the tree of passes. */
1558 #define INSERT_PASSES_AFTER(PASS) \
1559 p = &(PASS);
1561 #define PUSH_INSERT_PASSES_WITHIN(PASS) \
1563 opt_pass **p = &(PASS ## _1)->sub;
1565 #define POP_INSERT_PASSES() \
1568 #define NEXT_PASS(PASS, NUM) \
1569 do { \
1570 gcc_assert (NULL == PASS ## _ ## NUM); \
1571 if ((NUM) == 1) \
1572 PASS ## _1 = make_##PASS (m_ctxt); \
1573 else \
1575 gcc_assert (PASS ## _1); \
1576 PASS ## _ ## NUM = PASS ## _1->clone (); \
1578 p = next_pass_1 (p, PASS ## _ ## NUM, PASS ## _1); \
1579 } while (0)
1581 #define NEXT_PASS_WITH_ARG(PASS, NUM, ARG) \
1582 do { \
1583 NEXT_PASS (PASS, NUM); \
1584 PASS ## _ ## NUM->set_pass_param (0, ARG); \
1585 } while (0)
1587 #define TERMINATE_PASS_LIST() \
1588 *p = NULL;
1590 #include "pass-instances.def"
1592 #undef INSERT_PASSES_AFTER
1593 #undef PUSH_INSERT_PASSES_WITHIN
1594 #undef POP_INSERT_PASSES
1595 #undef NEXT_PASS
1596 #undef NEXT_PASS_WITH_ARG
1597 #undef TERMINATE_PASS_LIST
1599 /* Register the passes with the tree dump code. */
1600 register_dump_files (all_lowering_passes);
1601 register_dump_files (all_small_ipa_passes);
1602 register_dump_files (all_regular_ipa_passes);
1603 register_dump_files (all_late_ipa_passes);
1604 register_dump_files (all_passes);
1607 static void
1608 delete_pass_tree (opt_pass *pass)
1610 while (pass)
1612 /* Recurse into child passes. */
1613 delete_pass_tree (pass->sub);
1615 opt_pass *next = pass->next;
1617 /* Delete this pass. */
1618 delete pass;
1620 /* Iterate onto sibling passes. */
1621 pass = next;
1625 pass_manager::~pass_manager ()
1627 XDELETEVEC (passes_by_id);
1629 /* Call delete_pass_tree on each of the pass_lists. */
1630 #define DEF_PASS_LIST(LIST) \
1631 delete_pass_tree (*pass_lists[PASS_LIST_NO_##LIST]);
1632 GCC_PASS_LISTS
1633 #undef DEF_PASS_LIST
1637 /* If we are in IPA mode (i.e., current_function_decl is NULL), call
1638 function CALLBACK for every function in the call graph. Otherwise,
1639 call CALLBACK on the current function. */
1641 static void
1642 do_per_function (void (*callback) (function *, void *data), void *data)
1644 if (current_function_decl)
1645 callback (cfun, data);
1646 else
1648 struct cgraph_node *node;
1649 FOR_EACH_DEFINED_FUNCTION (node)
1650 if (node->analyzed && (gimple_has_body_p (node->decl) && !in_lto_p)
1651 && (!node->clone_of || node->decl != node->clone_of->decl))
1652 callback (DECL_STRUCT_FUNCTION (node->decl), data);
1656 /* Because inlining might remove no-longer reachable nodes, we need to
1657 keep the array visible to garbage collector to avoid reading collected
1658 out nodes. */
1659 static int nnodes;
1660 static GTY ((length ("nnodes"))) cgraph_node **order;
1662 /* Hook called when NODE is removed and therefore should be
1663 excluded from order vector. DATA is an array of integers.
1664 DATA[0] holds max index it may be accessed by. For cgraph
1665 node DATA[node->uid + 1] holds index of this node in order
1666 vector. */
1667 static void
1668 remove_cgraph_node_from_order (cgraph_node *node, void *data)
1670 int *order_idx = (int *)data;
1672 if (node->uid >= order_idx[0])
1673 return;
1675 int idx = order_idx[node->uid + 1];
1676 if (idx >= 0 && idx < nnodes && order[idx] == node)
1677 order[idx] = NULL;
1680 /* If we are in IPA mode (i.e., current_function_decl is NULL), call
1681 function CALLBACK for every function in the call graph. Otherwise,
1682 call CALLBACK on the current function.
1683 This function is global so that plugins can use it. */
1684 void
1685 do_per_function_toporder (void (*callback) (function *, void *data), void *data)
1687 int i;
1689 if (current_function_decl)
1690 callback (cfun, data);
1691 else
1693 cgraph_node_hook_list *hook;
1694 int *order_idx;
1695 gcc_assert (!order);
1696 order = ggc_vec_alloc<cgraph_node *> (symtab->cgraph_count);
1698 order_idx = XALLOCAVEC (int, symtab->cgraph_max_uid + 1);
1699 memset (order_idx + 1, -1, sizeof (int) * symtab->cgraph_max_uid);
1700 order_idx[0] = symtab->cgraph_max_uid;
1702 nnodes = ipa_reverse_postorder (order);
1703 for (i = nnodes - 1; i >= 0; i--)
1705 order[i]->process = 1;
1706 order_idx[order[i]->uid + 1] = i;
1708 hook = symtab->add_cgraph_removal_hook (remove_cgraph_node_from_order,
1709 order_idx);
1710 for (i = nnodes - 1; i >= 0; i--)
1712 /* Function could be inlined and removed as unreachable. */
1713 if (!order[i])
1714 continue;
1716 struct cgraph_node *node = order[i];
1718 /* Allow possibly removed nodes to be garbage collected. */
1719 order[i] = NULL;
1720 node->process = 0;
1721 if (node->has_gimple_body_p ())
1723 struct function *fn = DECL_STRUCT_FUNCTION (node->decl);
1724 push_cfun (fn);
1725 callback (fn, data);
1726 pop_cfun ();
1729 symtab->remove_cgraph_removal_hook (hook);
1731 ggc_free (order);
1732 order = NULL;
1733 nnodes = 0;
1736 /* Helper function to perform function body dump. */
1738 static void
1739 execute_function_dump (function *fn, void *data)
1741 opt_pass *pass = (opt_pass *)data;
1743 if (dump_file)
1745 push_cfun (fn);
1747 if (fn->curr_properties & PROP_trees)
1748 dump_function_to_file (fn->decl, dump_file, dump_flags);
1749 else
1750 print_rtl_with_bb (dump_file, get_insns (), dump_flags);
1752 /* Flush the file. If verification fails, we won't be able to
1753 close the file before aborting. */
1754 fflush (dump_file);
1756 if ((fn->curr_properties & PROP_cfg)
1757 && (dump_flags & TDF_GRAPH))
1759 if (!pass->graph_dump_initialized)
1761 clean_graph_dump_file (dump_file_name);
1762 pass->graph_dump_initialized = true;
1764 print_graph_cfg (dump_file_name, fn);
1767 pop_cfun ();
1771 static struct profile_record *profile_record;
1773 /* Do profile consistency book-keeping for the pass with static number INDEX.
1774 If SUBPASS is zero, we run _before_ the pass, and if SUBPASS is one, then
1775 we run _after_ the pass. RUN is true if the pass really runs, or FALSE
1776 if we are only book-keeping on passes that may have selectively disabled
1777 themselves on a given function. */
1778 static void
1779 check_profile_consistency (int index, int subpass, bool run)
1781 pass_manager *passes = g->get_passes ();
1782 if (index == -1)
1783 return;
1784 if (!profile_record)
1785 profile_record = XCNEWVEC (struct profile_record,
1786 passes->passes_by_id_size);
1787 gcc_assert (index < passes->passes_by_id_size && index >= 0);
1788 gcc_assert (subpass < 2);
1789 profile_record[index].run |= run;
1790 account_profile_record (&profile_record[index], subpass);
1793 /* Output profile consistency. */
1795 void
1796 dump_profile_report (void)
1798 g->get_passes ()->dump_profile_report ();
1801 void
1802 pass_manager::dump_profile_report () const
1804 int i, j;
1805 int last_freq_in = 0, last_count_in = 0, last_freq_out = 0, last_count_out = 0;
1806 gcov_type last_time = 0, last_size = 0;
1807 double rel_time_change, rel_size_change;
1808 int last_reported = 0;
1810 if (!profile_record)
1811 return;
1812 fprintf (stderr, "\nProfile consistency report:\n\n");
1813 fprintf (stderr, "Pass name |mismatch in |mismated out|Overall\n");
1814 fprintf (stderr, " |freq count |freq count |size time\n");
1816 for (i = 0; i < passes_by_id_size; i++)
1817 for (j = 0 ; j < 2; j++)
1818 if (profile_record[i].run)
1820 if (last_time)
1821 rel_time_change = (profile_record[i].time[j]
1822 - (double)last_time) * 100 / (double)last_time;
1823 else
1824 rel_time_change = 0;
1825 if (last_size)
1826 rel_size_change = (profile_record[i].size[j]
1827 - (double)last_size) * 100 / (double)last_size;
1828 else
1829 rel_size_change = 0;
1831 if (profile_record[i].num_mismatched_freq_in[j] != last_freq_in
1832 || profile_record[i].num_mismatched_freq_out[j] != last_freq_out
1833 || profile_record[i].num_mismatched_count_in[j] != last_count_in
1834 || profile_record[i].num_mismatched_count_out[j] != last_count_out
1835 || rel_time_change || rel_size_change)
1837 last_reported = i;
1838 fprintf (stderr, "%-20s %s",
1839 passes_by_id [i]->name,
1840 j ? "(after TODO)" : " ");
1841 if (profile_record[i].num_mismatched_freq_in[j] != last_freq_in)
1842 fprintf (stderr, "| %+5i",
1843 profile_record[i].num_mismatched_freq_in[j]
1844 - last_freq_in);
1845 else
1846 fprintf (stderr, "| ");
1847 if (profile_record[i].num_mismatched_count_in[j] != last_count_in)
1848 fprintf (stderr, " %+5i",
1849 profile_record[i].num_mismatched_count_in[j]
1850 - last_count_in);
1851 else
1852 fprintf (stderr, " ");
1853 if (profile_record[i].num_mismatched_freq_out[j] != last_freq_out)
1854 fprintf (stderr, "| %+5i",
1855 profile_record[i].num_mismatched_freq_out[j]
1856 - last_freq_out);
1857 else
1858 fprintf (stderr, "| ");
1859 if (profile_record[i].num_mismatched_count_out[j] != last_count_out)
1860 fprintf (stderr, " %+5i",
1861 profile_record[i].num_mismatched_count_out[j]
1862 - last_count_out);
1863 else
1864 fprintf (stderr, " ");
1866 /* Size/time units change across gimple and RTL. */
1867 if (i == pass_expand_1->static_pass_number)
1868 fprintf (stderr, "|----------");
1869 else
1871 if (rel_size_change)
1872 fprintf (stderr, "| %+8.4f%%", rel_size_change);
1873 else
1874 fprintf (stderr, "| ");
1875 if (rel_time_change)
1876 fprintf (stderr, " %+8.4f%%", rel_time_change);
1878 fprintf (stderr, "\n");
1879 last_freq_in = profile_record[i].num_mismatched_freq_in[j];
1880 last_freq_out = profile_record[i].num_mismatched_freq_out[j];
1881 last_count_in = profile_record[i].num_mismatched_count_in[j];
1882 last_count_out = profile_record[i].num_mismatched_count_out[j];
1884 else if (j && last_reported != i)
1886 last_reported = i;
1887 fprintf (stderr, "%-20s ------------| | |\n",
1888 passes_by_id [i]->name);
1890 last_time = profile_record[i].time[j];
1891 last_size = profile_record[i].size[j];
1895 /* Perform all TODO actions that ought to be done on each function. */
1897 static void
1898 execute_function_todo (function *fn, void *data)
1900 bool from_ipa_pass = (cfun == NULL);
1901 unsigned int flags = (size_t)data;
1902 flags &= ~fn->last_verified;
1903 if (!flags)
1904 return;
1906 push_cfun (fn);
1908 /* Always cleanup the CFG before trying to update SSA. */
1909 if (flags & TODO_cleanup_cfg)
1911 cleanup_tree_cfg ();
1913 /* When cleanup_tree_cfg merges consecutive blocks, it may
1914 perform some simplistic propagation when removing single
1915 valued PHI nodes. This propagation may, in turn, cause the
1916 SSA form to become out-of-date (see PR 22037). So, even
1917 if the parent pass had not scheduled an SSA update, we may
1918 still need to do one. */
1919 if (!(flags & TODO_update_ssa_any) && need_ssa_update_p (cfun))
1920 flags |= TODO_update_ssa;
1923 if (flags & TODO_update_ssa_any)
1925 unsigned update_flags = flags & TODO_update_ssa_any;
1926 update_ssa (update_flags);
1929 if (flag_tree_pta && (flags & TODO_rebuild_alias))
1930 compute_may_aliases ();
1932 if (optimize && (flags & TODO_update_address_taken))
1933 execute_update_addresses_taken ();
1935 if (flags & TODO_remove_unused_locals)
1936 remove_unused_locals ();
1938 if (flags & TODO_rebuild_frequencies)
1939 rebuild_frequencies ();
1941 if (flags & TODO_rebuild_cgraph_edges)
1942 cgraph_edge::rebuild_edges ();
1944 gcc_assert (dom_info_state (fn, CDI_POST_DOMINATORS) == DOM_NONE);
1945 /* If we've seen errors do not bother running any verifiers. */
1946 if (flag_checking && !seen_error ())
1948 dom_state pre_verify_state = dom_info_state (fn, CDI_DOMINATORS);
1949 dom_state pre_verify_pstate = dom_info_state (fn, CDI_POST_DOMINATORS);
1951 if (flags & TODO_verify_il)
1953 if (cfun->curr_properties & PROP_trees)
1955 if (cfun->curr_properties & PROP_cfg)
1956 /* IPA passes leave stmts to be fixed up, so make sure to
1957 not verify stmts really throw. */
1958 verify_gimple_in_cfg (cfun, !from_ipa_pass);
1959 else
1960 verify_gimple_in_seq (gimple_body (cfun->decl));
1962 if (cfun->curr_properties & PROP_ssa)
1963 /* IPA passes leave stmts to be fixed up, so make sure to
1964 not verify SSA operands whose verifier will choke on that. */
1965 verify_ssa (true, !from_ipa_pass);
1966 /* IPA passes leave basic-blocks unsplit, so make sure to
1967 not trip on that. */
1968 if ((cfun->curr_properties & PROP_cfg)
1969 && !from_ipa_pass)
1970 verify_flow_info ();
1971 if (current_loops
1972 && loops_state_satisfies_p (LOOP_CLOSED_SSA))
1973 verify_loop_closed_ssa (false);
1974 if (cfun->curr_properties & PROP_rtl)
1975 verify_rtl_sharing ();
1978 /* Make sure verifiers don't change dominator state. */
1979 gcc_assert (dom_info_state (fn, CDI_DOMINATORS) == pre_verify_state);
1980 gcc_assert (dom_info_state (fn, CDI_POST_DOMINATORS) == pre_verify_pstate);
1983 fn->last_verified = flags & TODO_verify_all;
1985 pop_cfun ();
1987 /* For IPA passes make sure to release dominator info, it can be
1988 computed by non-verifying TODOs. */
1989 if (from_ipa_pass)
1991 free_dominance_info (fn, CDI_DOMINATORS);
1992 free_dominance_info (fn, CDI_POST_DOMINATORS);
1996 /* Perform all TODO actions. */
1997 static void
1998 execute_todo (unsigned int flags)
2000 if (flag_checking
2001 && cfun
2002 && need_ssa_update_p (cfun))
2003 gcc_assert (flags & TODO_update_ssa_any);
2005 timevar_push (TV_TODO);
2007 statistics_fini_pass ();
2009 if (flags)
2010 do_per_function (execute_function_todo, (void *)(size_t) flags);
2012 /* At this point we should not have any unreachable code in the
2013 CFG, so it is safe to flush the pending freelist for SSA_NAMES. */
2014 if (cfun && cfun->gimple_df)
2015 flush_ssaname_freelist ();
2017 /* Always remove functions just as before inlining: IPA passes might be
2018 interested to see bodies of extern inline functions that are not inlined
2019 to analyze side effects. The full removal is done just at the end
2020 of IPA pass queue. */
2021 if (flags & TODO_remove_functions)
2023 gcc_assert (!cfun);
2024 symtab->remove_unreachable_nodes (dump_file);
2027 if ((flags & TODO_dump_symtab) && dump_file && !current_function_decl)
2029 gcc_assert (!cfun);
2030 symtab_node::dump_table (dump_file);
2031 /* Flush the file. If verification fails, we won't be able to
2032 close the file before aborting. */
2033 fflush (dump_file);
2036 /* Now that the dumping has been done, we can get rid of the optional
2037 df problems. */
2038 if (flags & TODO_df_finish)
2039 df_finish_pass ((flags & TODO_df_verify) != 0);
2041 timevar_pop (TV_TODO);
2044 /* Verify invariants that should hold between passes. This is a place
2045 to put simple sanity checks. */
2047 static void
2048 verify_interpass_invariants (void)
2050 gcc_checking_assert (!fold_deferring_overflow_warnings_p ());
2053 /* Clear the last verified flag. */
2055 static void
2056 clear_last_verified (function *fn, void *data ATTRIBUTE_UNUSED)
2058 fn->last_verified = 0;
2061 /* Helper function. Verify that the properties has been turn into the
2062 properties expected by the pass. */
2064 static void
2065 verify_curr_properties (function *fn, void *data)
2067 unsigned int props = (size_t)data;
2068 gcc_assert ((fn->curr_properties & props) == props);
2071 /* Release dump file name if set. */
2073 static void
2074 release_dump_file_name (void)
2076 if (dump_file_name)
2078 free (CONST_CAST (char *, dump_file_name));
2079 dump_file_name = NULL;
2083 /* Initialize pass dump file. */
2084 /* This is non-static so that the plugins can use it. */
2086 bool
2087 pass_init_dump_file (opt_pass *pass)
2089 /* If a dump file name is present, open it if enabled. */
2090 if (pass->static_pass_number != -1)
2092 timevar_push (TV_DUMP);
2093 gcc::dump_manager *dumps = g->get_dumps ();
2094 bool initializing_dump =
2095 !dumps->dump_initialized_p (pass->static_pass_number);
2096 release_dump_file_name ();
2097 dump_file_name = dumps->get_dump_file_name (pass->static_pass_number);
2098 dumps->dump_start (pass->static_pass_number, &dump_flags);
2099 if (dump_file && current_function_decl)
2100 dump_function_header (dump_file, current_function_decl, dump_flags);
2101 if (initializing_dump
2102 && dump_file && (dump_flags & TDF_GRAPH)
2103 && cfun && (cfun->curr_properties & PROP_cfg))
2105 clean_graph_dump_file (dump_file_name);
2106 pass->graph_dump_initialized = true;
2108 timevar_pop (TV_DUMP);
2109 return initializing_dump;
2111 else
2112 return false;
2115 /* Flush PASS dump file. */
2116 /* This is non-static so that plugins can use it. */
2118 void
2119 pass_fini_dump_file (opt_pass *pass)
2121 timevar_push (TV_DUMP);
2123 /* Flush and close dump file. */
2124 release_dump_file_name ();
2126 g->get_dumps ()->dump_finish (pass->static_pass_number);
2127 timevar_pop (TV_DUMP);
2130 /* After executing the pass, apply expected changes to the function
2131 properties. */
2133 static void
2134 update_properties_after_pass (function *fn, void *data)
2136 opt_pass *pass = (opt_pass *) data;
2137 fn->curr_properties = (fn->curr_properties | pass->properties_provided)
2138 & ~pass->properties_destroyed;
2141 /* Execute summary generation for all of the passes in IPA_PASS. */
2143 void
2144 execute_ipa_summary_passes (ipa_opt_pass_d *ipa_pass)
2146 while (ipa_pass)
2148 opt_pass *pass = ipa_pass;
2150 /* Execute all of the IPA_PASSes in the list. */
2151 if (ipa_pass->type == IPA_PASS
2152 && pass->gate (cfun)
2153 && ipa_pass->generate_summary)
2155 pass_init_dump_file (pass);
2157 /* If a timevar is present, start it. */
2158 if (pass->tv_id)
2159 timevar_push (pass->tv_id);
2161 current_pass = pass;
2162 ipa_pass->generate_summary ();
2164 /* Stop timevar. */
2165 if (pass->tv_id)
2166 timevar_pop (pass->tv_id);
2168 pass_fini_dump_file (pass);
2170 ipa_pass = (ipa_opt_pass_d *)ipa_pass->next;
2174 /* Execute IPA_PASS function transform on NODE. */
2176 static void
2177 execute_one_ipa_transform_pass (struct cgraph_node *node,
2178 ipa_opt_pass_d *ipa_pass)
2180 opt_pass *pass = ipa_pass;
2181 unsigned int todo_after = 0;
2183 current_pass = pass;
2184 if (!ipa_pass->function_transform)
2185 return;
2187 /* Note that the folders should only create gimple expressions.
2188 This is a hack until the new folder is ready. */
2189 in_gimple_form = (cfun && (cfun->curr_properties & PROP_trees)) != 0;
2191 pass_init_dump_file (pass);
2193 /* Run pre-pass verification. */
2194 execute_todo (ipa_pass->function_transform_todo_flags_start);
2196 /* If a timevar is present, start it. */
2197 if (pass->tv_id != TV_NONE)
2198 timevar_push (pass->tv_id);
2200 /* Do it! */
2201 todo_after = ipa_pass->function_transform (node);
2203 /* Stop timevar. */
2204 if (pass->tv_id != TV_NONE)
2205 timevar_pop (pass->tv_id);
2207 if (profile_report && cfun && (cfun->curr_properties & PROP_cfg))
2208 check_profile_consistency (pass->static_pass_number, 0, true);
2210 /* Run post-pass cleanup and verification. */
2211 execute_todo (todo_after);
2212 verify_interpass_invariants ();
2213 if (profile_report && cfun && (cfun->curr_properties & PROP_cfg))
2214 check_profile_consistency (pass->static_pass_number, 1, true);
2216 if (dump_file)
2217 do_per_function (execute_function_dump, NULL);
2218 pass_fini_dump_file (pass);
2220 current_pass = NULL;
2221 redirect_edge_var_map_empty ();
2223 /* Signal this is a suitable GC collection point. */
2224 if (!(todo_after & TODO_do_not_ggc_collect))
2225 ggc_collect ();
2228 /* For the current function, execute all ipa transforms. */
2230 void
2231 execute_all_ipa_transforms (void)
2233 struct cgraph_node *node;
2234 if (!cfun)
2235 return;
2236 node = cgraph_node::get (current_function_decl);
2238 if (node->ipa_transforms_to_apply.exists ())
2240 unsigned int i;
2242 for (i = 0; i < node->ipa_transforms_to_apply.length (); i++)
2243 execute_one_ipa_transform_pass (node, node->ipa_transforms_to_apply[i]);
2244 node->ipa_transforms_to_apply.release ();
2248 /* Check if PASS is explicitly disabled or enabled and return
2249 the gate status. FUNC is the function to be processed, and
2250 GATE_STATUS is the gate status determined by pass manager by
2251 default. */
2253 static bool
2254 override_gate_status (opt_pass *pass, tree func, bool gate_status)
2256 bool explicitly_enabled = false;
2257 bool explicitly_disabled = false;
2259 explicitly_enabled
2260 = is_pass_explicitly_enabled_or_disabled (pass, func,
2261 enabled_pass_uid_range_tab);
2262 explicitly_disabled
2263 = is_pass_explicitly_enabled_or_disabled (pass, func,
2264 disabled_pass_uid_range_tab);
2266 gate_status = !explicitly_disabled && (gate_status || explicitly_enabled);
2268 return gate_status;
2272 /* Execute PASS. */
2274 bool
2275 execute_one_pass (opt_pass *pass)
2277 unsigned int todo_after = 0;
2279 bool gate_status;
2281 /* IPA passes are executed on whole program, so cfun should be NULL.
2282 Other passes need function context set. */
2283 if (pass->type == SIMPLE_IPA_PASS || pass->type == IPA_PASS)
2284 gcc_assert (!cfun && !current_function_decl);
2285 else
2286 gcc_assert (cfun && current_function_decl);
2288 current_pass = pass;
2290 /* Check whether gate check should be avoided.
2291 User controls the value of the gate through the parameter "gate_status". */
2292 gate_status = pass->gate (cfun);
2293 gate_status = override_gate_status (pass, current_function_decl, gate_status);
2295 /* Override gate with plugin. */
2296 invoke_plugin_callbacks (PLUGIN_OVERRIDE_GATE, &gate_status);
2298 if (!gate_status)
2300 /* Run so passes selectively disabling themselves on a given function
2301 are not miscounted. */
2302 if (profile_report && cfun && (cfun->curr_properties & PROP_cfg))
2304 check_profile_consistency (pass->static_pass_number, 0, false);
2305 check_profile_consistency (pass->static_pass_number, 1, false);
2307 current_pass = NULL;
2308 return false;
2311 /* Pass execution event trigger: useful to identify passes being
2312 executed. */
2313 invoke_plugin_callbacks (PLUGIN_PASS_EXECUTION, pass);
2315 if (!quiet_flag && !cfun)
2316 fprintf (stderr, " <%s>", pass->name ? pass->name : "");
2318 /* Note that the folders should only create gimple expressions.
2319 This is a hack until the new folder is ready. */
2320 in_gimple_form = (cfun && (cfun->curr_properties & PROP_trees)) != 0;
2322 pass_init_dump_file (pass);
2324 /* Run pre-pass verification. */
2325 execute_todo (pass->todo_flags_start);
2327 if (flag_checking)
2328 do_per_function (verify_curr_properties,
2329 (void *)(size_t)pass->properties_required);
2331 /* If a timevar is present, start it. */
2332 if (pass->tv_id != TV_NONE)
2333 timevar_push (pass->tv_id);
2335 /* Do it! */
2336 todo_after = pass->execute (cfun);
2337 do_per_function (clear_last_verified, NULL);
2339 /* Stop timevar. */
2340 if (pass->tv_id != TV_NONE)
2341 timevar_pop (pass->tv_id);
2343 do_per_function (update_properties_after_pass, pass);
2345 if (profile_report && cfun && (cfun->curr_properties & PROP_cfg))
2346 check_profile_consistency (pass->static_pass_number, 0, true);
2348 /* Run post-pass cleanup and verification. */
2349 execute_todo (todo_after | pass->todo_flags_finish | TODO_verify_il);
2350 if (profile_report && cfun && (cfun->curr_properties & PROP_cfg))
2351 check_profile_consistency (pass->static_pass_number, 1, true);
2353 verify_interpass_invariants ();
2354 if (dump_file)
2355 do_per_function (execute_function_dump, pass);
2356 if (pass->type == IPA_PASS)
2358 struct cgraph_node *node;
2359 if (((ipa_opt_pass_d *)pass)->function_transform)
2360 FOR_EACH_FUNCTION_WITH_GIMPLE_BODY (node)
2361 node->ipa_transforms_to_apply.safe_push ((ipa_opt_pass_d *)pass);
2364 if (!current_function_decl)
2365 symtab->process_new_functions ();
2367 pass_fini_dump_file (pass);
2369 if (pass->type != SIMPLE_IPA_PASS && pass->type != IPA_PASS)
2370 gcc_assert (!(cfun->curr_properties & PROP_trees)
2371 || pass->type != RTL_PASS);
2373 current_pass = NULL;
2374 redirect_edge_var_map_empty ();
2376 if (todo_after & TODO_discard_function)
2378 gcc_assert (cfun);
2379 /* As cgraph_node::release_body expects release dominators info,
2380 we have to release it. */
2381 if (dom_info_available_p (CDI_DOMINATORS))
2382 free_dominance_info (CDI_DOMINATORS);
2384 if (dom_info_available_p (CDI_POST_DOMINATORS))
2385 free_dominance_info (CDI_POST_DOMINATORS);
2387 tree fn = cfun->decl;
2388 pop_cfun ();
2389 gcc_assert (!cfun);
2390 cgraph_node::get (fn)->release_body ();
2393 /* Signal this is a suitable GC collection point. */
2394 if (!((todo_after | pass->todo_flags_finish) & TODO_do_not_ggc_collect))
2395 ggc_collect ();
2397 return true;
2400 static void
2401 execute_pass_list_1 (opt_pass *pass)
2405 gcc_assert (pass->type == GIMPLE_PASS
2406 || pass->type == RTL_PASS);
2408 if (cfun == NULL)
2409 return;
2410 if (execute_one_pass (pass) && pass->sub)
2411 execute_pass_list_1 (pass->sub);
2412 pass = pass->next;
2414 while (pass);
2417 void
2418 execute_pass_list (function *fn, opt_pass *pass)
2420 gcc_assert (fn == cfun);
2421 execute_pass_list_1 (pass);
2422 if (cfun && fn->cfg)
2424 free_dominance_info (CDI_DOMINATORS);
2425 free_dominance_info (CDI_POST_DOMINATORS);
2429 /* Write out all LTO data. */
2430 static void
2431 write_lto (void)
2433 timevar_push (TV_IPA_LTO_GIMPLE_OUT);
2434 lto_output ();
2435 timevar_pop (TV_IPA_LTO_GIMPLE_OUT);
2436 timevar_push (TV_IPA_LTO_DECL_OUT);
2437 produce_asm_for_decls ();
2438 timevar_pop (TV_IPA_LTO_DECL_OUT);
2441 /* Same as execute_pass_list but assume that subpasses of IPA passes
2442 are local passes. If SET is not NULL, write out summaries of only
2443 those node in SET. */
2445 static void
2446 ipa_write_summaries_2 (opt_pass *pass, struct lto_out_decl_state *state)
2448 while (pass)
2450 ipa_opt_pass_d *ipa_pass = (ipa_opt_pass_d *)pass;
2451 gcc_assert (!current_function_decl);
2452 gcc_assert (!cfun);
2453 gcc_assert (pass->type == SIMPLE_IPA_PASS || pass->type == IPA_PASS);
2454 if (pass->type == IPA_PASS
2455 && ipa_pass->write_summary
2456 && pass->gate (cfun))
2458 /* If a timevar is present, start it. */
2459 if (pass->tv_id)
2460 timevar_push (pass->tv_id);
2462 pass_init_dump_file (pass);
2464 current_pass = pass;
2465 ipa_pass->write_summary ();
2467 pass_fini_dump_file (pass);
2469 /* If a timevar is present, start it. */
2470 if (pass->tv_id)
2471 timevar_pop (pass->tv_id);
2474 if (pass->sub && pass->sub->type != GIMPLE_PASS)
2475 ipa_write_summaries_2 (pass->sub, state);
2477 pass = pass->next;
2481 /* Helper function of ipa_write_summaries. Creates and destroys the
2482 decl state and calls ipa_write_summaries_2 for all passes that have
2483 summaries. SET is the set of nodes to be written. */
2485 static void
2486 ipa_write_summaries_1 (lto_symtab_encoder_t encoder)
2488 pass_manager *passes = g->get_passes ();
2489 struct lto_out_decl_state *state = lto_new_out_decl_state ();
2490 state->symtab_node_encoder = encoder;
2492 lto_output_init_mode_table ();
2493 lto_push_out_decl_state (state);
2495 gcc_assert (!flag_wpa);
2496 ipa_write_summaries_2 (passes->all_regular_ipa_passes, state);
2498 write_lto ();
2500 gcc_assert (lto_get_out_decl_state () == state);
2501 lto_pop_out_decl_state ();
2502 lto_delete_out_decl_state (state);
2505 /* Write out summaries for all the nodes in the callgraph. */
2507 void
2508 ipa_write_summaries (void)
2510 lto_symtab_encoder_t encoder;
2511 int i, order_pos;
2512 varpool_node *vnode;
2513 struct cgraph_node *node;
2514 struct cgraph_node **order;
2516 if ((!flag_generate_lto && !flag_generate_offload) || seen_error ())
2517 return;
2519 select_what_to_stream ();
2521 encoder = lto_symtab_encoder_new (false);
2523 /* Create the callgraph set in the same order used in
2524 cgraph_expand_all_functions. This mostly facilitates debugging,
2525 since it causes the gimple file to be processed in the same order
2526 as the source code. */
2527 order = XCNEWVEC (struct cgraph_node *, symtab->cgraph_count);
2528 order_pos = ipa_reverse_postorder (order);
2529 gcc_assert (order_pos == symtab->cgraph_count);
2531 for (i = order_pos - 1; i >= 0; i--)
2533 struct cgraph_node *node = order[i];
2535 if (node->has_gimple_body_p ())
2537 /* When streaming out references to statements as part of some IPA
2538 pass summary, the statements need to have uids assigned and the
2539 following does that for all the IPA passes here. Naturally, this
2540 ordering then matches the one IPA-passes get in their stmt_fixup
2541 hooks. */
2543 push_cfun (DECL_STRUCT_FUNCTION (node->decl));
2544 renumber_gimple_stmt_uids ();
2545 pop_cfun ();
2547 if (node->definition && node->need_lto_streaming)
2548 lto_set_symtab_encoder_in_partition (encoder, node);
2551 FOR_EACH_DEFINED_FUNCTION (node)
2552 if (node->alias && node->need_lto_streaming)
2553 lto_set_symtab_encoder_in_partition (encoder, node);
2554 FOR_EACH_DEFINED_VARIABLE (vnode)
2555 if (vnode->need_lto_streaming)
2556 lto_set_symtab_encoder_in_partition (encoder, vnode);
2558 ipa_write_summaries_1 (compute_ltrans_boundary (encoder));
2560 free (order);
2563 /* Same as execute_pass_list but assume that subpasses of IPA passes
2564 are local passes. If SET is not NULL, write out optimization summaries of
2565 only those node in SET. */
2567 static void
2568 ipa_write_optimization_summaries_1 (opt_pass *pass,
2569 struct lto_out_decl_state *state)
2571 while (pass)
2573 ipa_opt_pass_d *ipa_pass = (ipa_opt_pass_d *)pass;
2574 gcc_assert (!current_function_decl);
2575 gcc_assert (!cfun);
2576 gcc_assert (pass->type == SIMPLE_IPA_PASS || pass->type == IPA_PASS);
2577 if (pass->type == IPA_PASS
2578 && ipa_pass->write_optimization_summary
2579 && pass->gate (cfun))
2581 /* If a timevar is present, start it. */
2582 if (pass->tv_id)
2583 timevar_push (pass->tv_id);
2585 pass_init_dump_file (pass);
2587 current_pass = pass;
2588 ipa_pass->write_optimization_summary ();
2590 pass_fini_dump_file (pass);
2592 /* If a timevar is present, start it. */
2593 if (pass->tv_id)
2594 timevar_pop (pass->tv_id);
2597 if (pass->sub && pass->sub->type != GIMPLE_PASS)
2598 ipa_write_optimization_summaries_1 (pass->sub, state);
2600 pass = pass->next;
2604 /* Write all the optimization summaries for the cgraph nodes in SET. If SET is
2605 NULL, write out all summaries of all nodes. */
2607 void
2608 ipa_write_optimization_summaries (lto_symtab_encoder_t encoder)
2610 struct lto_out_decl_state *state = lto_new_out_decl_state ();
2611 lto_symtab_encoder_iterator lsei;
2612 state->symtab_node_encoder = encoder;
2614 lto_output_init_mode_table ();
2615 lto_push_out_decl_state (state);
2616 for (lsei = lsei_start_function_in_partition (encoder);
2617 !lsei_end_p (lsei); lsei_next_function_in_partition (&lsei))
2619 struct cgraph_node *node = lsei_cgraph_node (lsei);
2620 /* When streaming out references to statements as part of some IPA
2621 pass summary, the statements need to have uids assigned.
2623 For functions newly born at WPA stage we need to initialize
2624 the uids here. */
2625 if (node->definition
2626 && gimple_has_body_p (node->decl))
2628 push_cfun (DECL_STRUCT_FUNCTION (node->decl));
2629 renumber_gimple_stmt_uids ();
2630 pop_cfun ();
2634 gcc_assert (flag_wpa);
2635 pass_manager *passes = g->get_passes ();
2636 ipa_write_optimization_summaries_1 (passes->all_regular_ipa_passes, state);
2638 write_lto ();
2640 gcc_assert (lto_get_out_decl_state () == state);
2641 lto_pop_out_decl_state ();
2642 lto_delete_out_decl_state (state);
2645 /* Same as execute_pass_list but assume that subpasses of IPA passes
2646 are local passes. */
2648 static void
2649 ipa_read_summaries_1 (opt_pass *pass)
2651 while (pass)
2653 ipa_opt_pass_d *ipa_pass = (ipa_opt_pass_d *) pass;
2655 gcc_assert (!current_function_decl);
2656 gcc_assert (!cfun);
2657 gcc_assert (pass->type == SIMPLE_IPA_PASS || pass->type == IPA_PASS);
2659 if (pass->gate (cfun))
2661 if (pass->type == IPA_PASS && ipa_pass->read_summary)
2663 /* If a timevar is present, start it. */
2664 if (pass->tv_id)
2665 timevar_push (pass->tv_id);
2667 pass_init_dump_file (pass);
2669 current_pass = pass;
2670 ipa_pass->read_summary ();
2672 pass_fini_dump_file (pass);
2674 /* Stop timevar. */
2675 if (pass->tv_id)
2676 timevar_pop (pass->tv_id);
2679 if (pass->sub && pass->sub->type != GIMPLE_PASS)
2680 ipa_read_summaries_1 (pass->sub);
2682 pass = pass->next;
2687 /* Read all the summaries for all_regular_ipa_passes. */
2689 void
2690 ipa_read_summaries (void)
2692 pass_manager *passes = g->get_passes ();
2693 ipa_read_summaries_1 (passes->all_regular_ipa_passes);
2696 /* Same as execute_pass_list but assume that subpasses of IPA passes
2697 are local passes. */
2699 static void
2700 ipa_read_optimization_summaries_1 (opt_pass *pass)
2702 while (pass)
2704 ipa_opt_pass_d *ipa_pass = (ipa_opt_pass_d *) pass;
2706 gcc_assert (!current_function_decl);
2707 gcc_assert (!cfun);
2708 gcc_assert (pass->type == SIMPLE_IPA_PASS || pass->type == IPA_PASS);
2710 if (pass->gate (cfun))
2712 if (pass->type == IPA_PASS && ipa_pass->read_optimization_summary)
2714 /* If a timevar is present, start it. */
2715 if (pass->tv_id)
2716 timevar_push (pass->tv_id);
2718 pass_init_dump_file (pass);
2720 current_pass = pass;
2721 ipa_pass->read_optimization_summary ();
2723 pass_fini_dump_file (pass);
2725 /* Stop timevar. */
2726 if (pass->tv_id)
2727 timevar_pop (pass->tv_id);
2730 if (pass->sub && pass->sub->type != GIMPLE_PASS)
2731 ipa_read_optimization_summaries_1 (pass->sub);
2733 pass = pass->next;
2737 /* Read all the summaries for all_regular_ipa_passes. */
2739 void
2740 ipa_read_optimization_summaries (void)
2742 pass_manager *passes = g->get_passes ();
2743 ipa_read_optimization_summaries_1 (passes->all_regular_ipa_passes);
2746 /* Same as execute_pass_list but assume that subpasses of IPA passes
2747 are local passes. */
2748 void
2749 execute_ipa_pass_list (opt_pass *pass)
2753 gcc_assert (!current_function_decl);
2754 gcc_assert (!cfun);
2755 gcc_assert (pass->type == SIMPLE_IPA_PASS || pass->type == IPA_PASS);
2756 if (execute_one_pass (pass) && pass->sub)
2758 if (pass->sub->type == GIMPLE_PASS)
2760 invoke_plugin_callbacks (PLUGIN_EARLY_GIMPLE_PASSES_START, NULL);
2761 do_per_function_toporder ((void (*)(function *, void *))
2762 execute_pass_list,
2763 pass->sub);
2764 invoke_plugin_callbacks (PLUGIN_EARLY_GIMPLE_PASSES_END, NULL);
2766 else if (pass->sub->type == SIMPLE_IPA_PASS
2767 || pass->sub->type == IPA_PASS)
2768 execute_ipa_pass_list (pass->sub);
2769 else
2770 gcc_unreachable ();
2772 gcc_assert (!current_function_decl);
2773 symtab->process_new_functions ();
2774 pass = pass->next;
2776 while (pass);
2779 /* Execute stmt fixup hooks of all passes in PASS for NODE and STMTS. */
2781 static void
2782 execute_ipa_stmt_fixups (opt_pass *pass,
2783 struct cgraph_node *node, gimple **stmts)
2785 while (pass)
2787 /* Execute all of the IPA_PASSes in the list. */
2788 if (pass->type == IPA_PASS
2789 && pass->gate (cfun))
2791 ipa_opt_pass_d *ipa_pass = (ipa_opt_pass_d *) pass;
2793 if (ipa_pass->stmt_fixup)
2795 pass_init_dump_file (pass);
2796 /* If a timevar is present, start it. */
2797 if (pass->tv_id)
2798 timevar_push (pass->tv_id);
2800 current_pass = pass;
2801 ipa_pass->stmt_fixup (node, stmts);
2803 /* Stop timevar. */
2804 if (pass->tv_id)
2805 timevar_pop (pass->tv_id);
2806 pass_fini_dump_file (pass);
2808 if (pass->sub)
2809 execute_ipa_stmt_fixups (pass->sub, node, stmts);
2811 pass = pass->next;
2815 /* Execute stmt fixup hooks of all IPA passes for NODE and STMTS. */
2817 void
2818 execute_all_ipa_stmt_fixups (struct cgraph_node *node, gimple **stmts)
2820 pass_manager *passes = g->get_passes ();
2821 execute_ipa_stmt_fixups (passes->all_regular_ipa_passes, node, stmts);
2825 extern void debug_properties (unsigned int);
2826 extern void dump_properties (FILE *, unsigned int);
2828 DEBUG_FUNCTION void
2829 dump_properties (FILE *dump, unsigned int props)
2831 fprintf (dump, "Properties:\n");
2832 if (props & PROP_gimple_any)
2833 fprintf (dump, "PROP_gimple_any\n");
2834 if (props & PROP_gimple_lcf)
2835 fprintf (dump, "PROP_gimple_lcf\n");
2836 if (props & PROP_gimple_leh)
2837 fprintf (dump, "PROP_gimple_leh\n");
2838 if (props & PROP_cfg)
2839 fprintf (dump, "PROP_cfg\n");
2840 if (props & PROP_ssa)
2841 fprintf (dump, "PROP_ssa\n");
2842 if (props & PROP_no_crit_edges)
2843 fprintf (dump, "PROP_no_crit_edges\n");
2844 if (props & PROP_rtl)
2845 fprintf (dump, "PROP_rtl\n");
2846 if (props & PROP_gimple_lomp)
2847 fprintf (dump, "PROP_gimple_lomp\n");
2848 if (props & PROP_gimple_lcx)
2849 fprintf (dump, "PROP_gimple_lcx\n");
2850 if (props & PROP_gimple_lvec)
2851 fprintf (dump, "PROP_gimple_lvec\n");
2852 if (props & PROP_cfglayout)
2853 fprintf (dump, "PROP_cfglayout\n");
2856 DEBUG_FUNCTION void
2857 debug_properties (unsigned int props)
2859 dump_properties (stderr, props);
2862 /* Called by local passes to see if function is called by already processed nodes.
2863 Because we process nodes in topological order, this means that function is
2864 in recursive cycle or we introduced new direct calls. */
2865 bool
2866 function_called_by_processed_nodes_p (void)
2868 struct cgraph_edge *e;
2869 for (e = cgraph_node::get (current_function_decl)->callers;
2871 e = e->next_caller)
2873 if (e->caller->decl == current_function_decl)
2874 continue;
2875 if (!e->caller->has_gimple_body_p ())
2876 continue;
2877 if (TREE_ASM_WRITTEN (e->caller->decl))
2878 continue;
2879 if (!e->caller->process && !e->caller->global.inlined_to)
2880 break;
2882 if (dump_file && e)
2884 fprintf (dump_file, "Already processed call to:\n");
2885 e->caller->dump (dump_file);
2887 return e != NULL;
2890 #include "gt-passes.h"