IPA ICF pass, part 3/5
[gcc.git] / gcc / passes.def
1 /* Description of pass structure
2 Copyright (C) 1987-2014 Free Software Foundation, Inc.
3
4 This file is part of GCC.
5
6 GCC is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 3, or (at your option) any later
9 version.
10
11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with GCC; see the file COPYING3. If not see
18 <http://www.gnu.org/licenses/>. */
19
20 /*
21 Macros that should be defined when using this file:
22 INSERT_PASSES_AFTER (PASS)
23 PUSH_INSERT_PASSES_WITHIN (PASS)
24 POP_INSERT_PASSES ()
25 NEXT_PASS (PASS)
26 TERMINATE_PASS_LIST ()
27 */
28
29 /* All passes needed to lower the function into shape optimizers can
30 operate on. These passes are always run first on the function, but
31 backend might produce already lowered functions that are not processed
32 by these passes. */
33 INSERT_PASSES_AFTER (all_lowering_passes)
34 NEXT_PASS (pass_warn_unused_result);
35 NEXT_PASS (pass_diagnose_omp_blocks);
36 NEXT_PASS (pass_diagnose_tm_blocks);
37 NEXT_PASS (pass_lower_omp);
38 NEXT_PASS (pass_lower_cf);
39 NEXT_PASS (pass_lower_tm);
40 NEXT_PASS (pass_refactor_eh);
41 NEXT_PASS (pass_lower_eh);
42 NEXT_PASS (pass_build_cfg);
43 NEXT_PASS (pass_warn_function_return);
44 NEXT_PASS (pass_expand_omp);
45 NEXT_PASS (pass_build_cgraph_edges);
46 TERMINATE_PASS_LIST ()
47
48 /* Interprocedural optimization passes. */
49 INSERT_PASSES_AFTER (all_small_ipa_passes)
50 NEXT_PASS (pass_ipa_free_lang_data);
51 NEXT_PASS (pass_ipa_function_and_variable_visibility);
52 NEXT_PASS (pass_early_local_passes);
53 PUSH_INSERT_PASSES_WITHIN (pass_early_local_passes)
54 NEXT_PASS (pass_fixup_cfg);
55 NEXT_PASS (pass_init_datastructures);
56
57 NEXT_PASS (pass_build_ssa);
58 NEXT_PASS (pass_ubsan);
59 NEXT_PASS (pass_early_warn_uninitialized);
60 NEXT_PASS (pass_rebuild_cgraph_edges);
61 NEXT_PASS (pass_inline_parameters);
62 NEXT_PASS (pass_early_inline);
63 NEXT_PASS (pass_all_early_optimizations);
64 PUSH_INSERT_PASSES_WITHIN (pass_all_early_optimizations)
65 NEXT_PASS (pass_remove_cgraph_callee_edges);
66 NEXT_PASS (pass_rename_ssa_copies);
67 NEXT_PASS (pass_ccp);
68 /* After CCP we rewrite no longer addressed locals into SSA
69 form if possible. */
70 NEXT_PASS (pass_forwprop);
71 NEXT_PASS (pass_sra_early);
72 /* pass_build_ealias is a dummy pass that ensures that we
73 execute TODO_rebuild_alias at this point. */
74 NEXT_PASS (pass_build_ealias);
75 NEXT_PASS (pass_fre);
76 NEXT_PASS (pass_merge_phi);
77 NEXT_PASS (pass_cd_dce);
78 NEXT_PASS (pass_early_ipa_sra);
79 NEXT_PASS (pass_tail_recursion);
80 NEXT_PASS (pass_convert_switch);
81 NEXT_PASS (pass_cleanup_eh);
82 NEXT_PASS (pass_profile);
83 NEXT_PASS (pass_local_pure_const);
84 /* Split functions creates parts that are not run through
85 early optimizations again. It is thus good idea to do this
86 late. */
87 NEXT_PASS (pass_split_functions);
88 POP_INSERT_PASSES ()
89 NEXT_PASS (pass_release_ssa_names);
90 NEXT_PASS (pass_rebuild_cgraph_edges);
91 NEXT_PASS (pass_inline_parameters);
92 POP_INSERT_PASSES ()
93 NEXT_PASS (pass_ipa_free_inline_summary);
94 NEXT_PASS (pass_ipa_tree_profile);
95 PUSH_INSERT_PASSES_WITHIN (pass_ipa_tree_profile)
96 NEXT_PASS (pass_feedback_split_functions);
97 POP_INSERT_PASSES ()
98 NEXT_PASS (pass_ipa_increase_alignment);
99 NEXT_PASS (pass_ipa_tm);
100 NEXT_PASS (pass_ipa_lower_emutls);
101 TERMINATE_PASS_LIST ()
102
103 INSERT_PASSES_AFTER (all_regular_ipa_passes)
104 NEXT_PASS (pass_ipa_whole_program_visibility);
105 NEXT_PASS (pass_ipa_profile);
106 NEXT_PASS (pass_ipa_icf);
107 NEXT_PASS (pass_ipa_devirt);
108 NEXT_PASS (pass_ipa_cp);
109 NEXT_PASS (pass_ipa_cdtor_merge);
110 NEXT_PASS (pass_ipa_inline);
111 NEXT_PASS (pass_ipa_pure_const);
112 NEXT_PASS (pass_ipa_reference);
113 /* This pass needs to be scheduled after any IP code duplication. */
114 NEXT_PASS (pass_ipa_single_use);
115 /* Comdat privatization come last, as direct references to comdat local
116 symbols are not allowed outside of the comdat group. Privatizing early
117 would result in missed optimizations due to this restriction. */
118 NEXT_PASS (pass_ipa_comdats);
119 TERMINATE_PASS_LIST ()
120
121 /* Simple IPA passes executed after the regular passes. In WHOPR mode the
122 passes are executed after partitioning and thus see just parts of the
123 compiled unit. */
124 INSERT_PASSES_AFTER (all_late_ipa_passes)
125 NEXT_PASS (pass_ipa_pta);
126 NEXT_PASS (pass_omp_simd_clone);
127 TERMINATE_PASS_LIST ()
128
129 /* These passes are run after IPA passes on every function that is being
130 output to the assembler file. */
131 INSERT_PASSES_AFTER (all_passes)
132 NEXT_PASS (pass_fixup_cfg);
133 NEXT_PASS (pass_lower_eh_dispatch);
134 NEXT_PASS (pass_all_optimizations);
135 PUSH_INSERT_PASSES_WITHIN (pass_all_optimizations)
136 NEXT_PASS (pass_remove_cgraph_callee_edges);
137 /* Initial scalar cleanups before alias computation.
138 They ensure memory accesses are not indirect wherever possible. */
139 NEXT_PASS (pass_strip_predict_hints);
140 NEXT_PASS (pass_rename_ssa_copies);
141 NEXT_PASS (pass_ccp);
142 /* After CCP we rewrite no longer addressed locals into SSA
143 form if possible. */
144 NEXT_PASS (pass_copy_prop);
145 NEXT_PASS (pass_complete_unrolli);
146 NEXT_PASS (pass_phiprop);
147 NEXT_PASS (pass_forwprop);
148 NEXT_PASS (pass_object_sizes);
149 /* pass_build_alias is a dummy pass that ensures that we
150 execute TODO_rebuild_alias at this point. */
151 NEXT_PASS (pass_build_alias);
152 NEXT_PASS (pass_return_slot);
153 NEXT_PASS (pass_fre);
154 NEXT_PASS (pass_merge_phi);
155 NEXT_PASS (pass_vrp);
156 NEXT_PASS (pass_dce);
157 NEXT_PASS (pass_call_cdce);
158 NEXT_PASS (pass_cselim);
159 NEXT_PASS (pass_copy_prop);
160 NEXT_PASS (pass_tree_ifcombine);
161 NEXT_PASS (pass_phiopt);
162 NEXT_PASS (pass_tail_recursion);
163 NEXT_PASS (pass_ch);
164 NEXT_PASS (pass_stdarg);
165 NEXT_PASS (pass_lower_complex);
166 NEXT_PASS (pass_sra);
167 NEXT_PASS (pass_rename_ssa_copies);
168 /* The dom pass will also resolve all __builtin_constant_p calls
169 that are still there to 0. This has to be done after some
170 propagations have already run, but before some more dead code
171 is removed, and this place fits nicely. Remember this when
172 trying to move or duplicate pass_dominator somewhere earlier. */
173 NEXT_PASS (pass_dominator);
174 /* At this point the majority of const/copy propagations
175 are exposed. Go ahead and identify paths that should never
176 be executed in a conforming program and isolate those paths.
177
178 This will expose more degenerate PHIs in the main path and
179 expose more PRE/DOM optimization opportunities. */
180 NEXT_PASS (pass_isolate_erroneous_paths);
181 /* The only const/copy propagation opportunities left after
182 DOM and erroneous path isolation should be due to degenerate PHI nodes.
183 So rather than run the full propagators, run a specialized pass which
184 only examines PHIs to discover const/copy propagation
185 opportunities. */
186 NEXT_PASS (pass_phi_only_cprop);
187 NEXT_PASS (pass_dse);
188 NEXT_PASS (pass_reassoc);
189 NEXT_PASS (pass_dce);
190 NEXT_PASS (pass_forwprop);
191 NEXT_PASS (pass_phiopt);
192 NEXT_PASS (pass_ccp);
193 /* After CCP we rewrite no longer addressed locals into SSA
194 form if possible. */
195 NEXT_PASS (pass_copy_prop);
196 NEXT_PASS (pass_cse_sincos);
197 NEXT_PASS (pass_optimize_bswap);
198 NEXT_PASS (pass_split_crit_edges);
199 NEXT_PASS (pass_pre);
200 NEXT_PASS (pass_sink_code);
201 NEXT_PASS (pass_asan);
202 NEXT_PASS (pass_tsan);
203 /* Pass group that runs when 1) enabled, 2) there are loops
204 in the function. Make sure to run pass_fix_loops before
205 to discover/remove loops before running the gate function
206 of pass_tree_loop. */
207 NEXT_PASS (pass_fix_loops);
208 NEXT_PASS (pass_tree_loop);
209 PUSH_INSERT_PASSES_WITHIN (pass_tree_loop)
210 NEXT_PASS (pass_tree_loop_init);
211 NEXT_PASS (pass_lim);
212 NEXT_PASS (pass_copy_prop);
213 NEXT_PASS (pass_dce);
214 NEXT_PASS (pass_tree_unswitch);
215 NEXT_PASS (pass_scev_cprop);
216 NEXT_PASS (pass_record_bounds);
217 NEXT_PASS (pass_check_data_deps);
218 NEXT_PASS (pass_loop_distribution);
219 NEXT_PASS (pass_copy_prop);
220 NEXT_PASS (pass_graphite);
221 PUSH_INSERT_PASSES_WITHIN (pass_graphite)
222 NEXT_PASS (pass_graphite_transforms);
223 NEXT_PASS (pass_lim);
224 NEXT_PASS (pass_copy_prop);
225 NEXT_PASS (pass_dce);
226 POP_INSERT_PASSES ()
227 NEXT_PASS (pass_iv_canon);
228 NEXT_PASS (pass_parallelize_loops);
229 NEXT_PASS (pass_if_conversion);
230 /* pass_vectorize must immediately follow pass_if_conversion.
231 Please do not add any other passes in between. */
232 NEXT_PASS (pass_vectorize);
233 PUSH_INSERT_PASSES_WITHIN (pass_vectorize)
234 NEXT_PASS (pass_dce);
235 POP_INSERT_PASSES ()
236 NEXT_PASS (pass_predcom);
237 NEXT_PASS (pass_complete_unroll);
238 NEXT_PASS (pass_slp_vectorize);
239 NEXT_PASS (pass_loop_prefetch);
240 /* Run IVOPTs after the last pass that uses data-reference analysis
241 as that doesn't handle TARGET_MEM_REFs. */
242 NEXT_PASS (pass_iv_optimize);
243 NEXT_PASS (pass_lim);
244 NEXT_PASS (pass_tree_loop_done);
245 POP_INSERT_PASSES ()
246 /* Pass group that runs when pass_tree_loop is disabled or there
247 are no loops in the function. */
248 NEXT_PASS (pass_tree_no_loop);
249 PUSH_INSERT_PASSES_WITHIN (pass_tree_no_loop)
250 NEXT_PASS (pass_slp_vectorize);
251 POP_INSERT_PASSES ()
252 NEXT_PASS (pass_lower_vector_ssa);
253 NEXT_PASS (pass_cse_reciprocals);
254 NEXT_PASS (pass_reassoc);
255 NEXT_PASS (pass_strength_reduction);
256 NEXT_PASS (pass_tracer);
257 NEXT_PASS (pass_dominator);
258 NEXT_PASS (pass_strlen);
259 NEXT_PASS (pass_vrp);
260 /* The only const/copy propagation opportunities left after
261 DOM and VRP should be due to degenerate PHI nodes. So rather than
262 run the full propagators, run a specialized pass which
263 only examines PHIs to discover const/copy propagation
264 opportunities. */
265 NEXT_PASS (pass_phi_only_cprop);
266 NEXT_PASS (pass_cd_dce);
267 NEXT_PASS (pass_dse);
268 NEXT_PASS (pass_forwprop);
269 NEXT_PASS (pass_phiopt);
270 NEXT_PASS (pass_fold_builtins);
271 NEXT_PASS (pass_optimize_widening_mul);
272 NEXT_PASS (pass_tail_calls);
273 NEXT_PASS (pass_rename_ssa_copies);
274 /* FIXME: If DCE is not run before checking for uninitialized uses,
275 we may get false warnings (e.g., testsuite/gcc.dg/uninit-5.c).
276 However, this also causes us to misdiagnose cases that should be
277 real warnings (e.g., testsuite/gcc.dg/pr18501.c).
278
279 To fix the false positives in uninit-5.c, we would have to
280 account for the predicates protecting the set and the use of each
281 variable. Using a representation like Gated Single Assignment
282 may help. */
283 /* Split critical edges before late uninit warning to reduce the
284 number of false positives from it. */
285 NEXT_PASS (pass_split_crit_edges);
286 NEXT_PASS (pass_late_warn_uninitialized);
287 NEXT_PASS (pass_uncprop);
288 NEXT_PASS (pass_local_pure_const);
289 POP_INSERT_PASSES ()
290 NEXT_PASS (pass_all_optimizations_g);
291 PUSH_INSERT_PASSES_WITHIN (pass_all_optimizations_g)
292 NEXT_PASS (pass_remove_cgraph_callee_edges);
293 NEXT_PASS (pass_strip_predict_hints);
294 /* Lower remaining pieces of GIMPLE. */
295 NEXT_PASS (pass_lower_complex);
296 NEXT_PASS (pass_lower_vector_ssa);
297 /* Perform simple scalar cleanup which is constant/copy propagation. */
298 NEXT_PASS (pass_ccp);
299 NEXT_PASS (pass_object_sizes);
300 /* Fold remaining builtins. */
301 NEXT_PASS (pass_fold_builtins);
302 /* Copy propagation also copy-propagates constants, this is necessary
303 to forward object-size and builtin folding results properly. */
304 NEXT_PASS (pass_copy_prop);
305 NEXT_PASS (pass_dce);
306 NEXT_PASS (pass_asan);
307 NEXT_PASS (pass_tsan);
308 NEXT_PASS (pass_rename_ssa_copies);
309 /* ??? We do want some kind of loop invariant motion, but we possibly
310 need to adjust LIM to be more friendly towards preserving accurate
311 debug information here. */
312 /* Split critical edges before late uninit warning to reduce the
313 number of false positives from it. */
314 NEXT_PASS (pass_split_crit_edges);
315 NEXT_PASS (pass_late_warn_uninitialized);
316 NEXT_PASS (pass_uncprop);
317 NEXT_PASS (pass_local_pure_const);
318 POP_INSERT_PASSES ()
319 NEXT_PASS (pass_tm_init);
320 PUSH_INSERT_PASSES_WITHIN (pass_tm_init)
321 NEXT_PASS (pass_tm_mark);
322 NEXT_PASS (pass_tm_memopt);
323 NEXT_PASS (pass_tm_edges);
324 POP_INSERT_PASSES ()
325 NEXT_PASS (pass_vtable_verify);
326 NEXT_PASS (pass_lower_vector);
327 NEXT_PASS (pass_lower_complex_O0);
328 NEXT_PASS (pass_asan_O0);
329 NEXT_PASS (pass_tsan_O0);
330 NEXT_PASS (pass_sanopt);
331 NEXT_PASS (pass_cleanup_eh);
332 NEXT_PASS (pass_lower_resx);
333 NEXT_PASS (pass_nrv);
334 NEXT_PASS (pass_cleanup_cfg_post_optimizing);
335 NEXT_PASS (pass_warn_function_noreturn);
336
337 NEXT_PASS (pass_expand);
338
339 NEXT_PASS (pass_rest_of_compilation);
340 PUSH_INSERT_PASSES_WITHIN (pass_rest_of_compilation)
341 NEXT_PASS (pass_instantiate_virtual_regs);
342 NEXT_PASS (pass_into_cfg_layout_mode);
343 NEXT_PASS (pass_jump);
344 NEXT_PASS (pass_lower_subreg);
345 NEXT_PASS (pass_df_initialize_opt);
346 NEXT_PASS (pass_cse);
347 NEXT_PASS (pass_rtl_fwprop);
348 NEXT_PASS (pass_rtl_cprop);
349 NEXT_PASS (pass_rtl_pre);
350 NEXT_PASS (pass_rtl_hoist);
351 NEXT_PASS (pass_rtl_cprop);
352 NEXT_PASS (pass_rtl_store_motion);
353 NEXT_PASS (pass_cse_after_global_opts);
354 NEXT_PASS (pass_rtl_ifcvt);
355 NEXT_PASS (pass_reginfo_init);
356 /* Perform loop optimizations. It might be better to do them a bit
357 sooner, but we want the profile feedback to work more
358 efficiently. */
359 NEXT_PASS (pass_loop2);
360 PUSH_INSERT_PASSES_WITHIN (pass_loop2)
361 NEXT_PASS (pass_rtl_loop_init);
362 NEXT_PASS (pass_rtl_move_loop_invariants);
363 NEXT_PASS (pass_rtl_unroll_loops);
364 NEXT_PASS (pass_rtl_doloop);
365 NEXT_PASS (pass_rtl_loop_done);
366 TERMINATE_PASS_LIST ()
367 POP_INSERT_PASSES ()
368 NEXT_PASS (pass_web);
369 NEXT_PASS (pass_rtl_cprop);
370 NEXT_PASS (pass_cse2);
371 NEXT_PASS (pass_rtl_dse1);
372 NEXT_PASS (pass_rtl_fwprop_addr);
373 NEXT_PASS (pass_inc_dec);
374 NEXT_PASS (pass_initialize_regs);
375 NEXT_PASS (pass_ud_rtl_dce);
376 NEXT_PASS (pass_combine);
377 NEXT_PASS (pass_if_after_combine);
378 NEXT_PASS (pass_partition_blocks);
379 NEXT_PASS (pass_outof_cfg_layout_mode);
380 NEXT_PASS (pass_split_all_insns);
381 NEXT_PASS (pass_lower_subreg2);
382 NEXT_PASS (pass_df_initialize_no_opt);
383 NEXT_PASS (pass_stack_ptr_mod);
384 NEXT_PASS (pass_mode_switching);
385 NEXT_PASS (pass_match_asm_constraints);
386 NEXT_PASS (pass_sms);
387 NEXT_PASS (pass_live_range_shrinkage);
388 NEXT_PASS (pass_sched);
389 NEXT_PASS (pass_ira);
390 NEXT_PASS (pass_reload);
391 NEXT_PASS (pass_postreload);
392 PUSH_INSERT_PASSES_WITHIN (pass_postreload)
393 NEXT_PASS (pass_postreload_cse);
394 NEXT_PASS (pass_gcse2);
395 NEXT_PASS (pass_split_after_reload);
396 NEXT_PASS (pass_ree);
397 NEXT_PASS (pass_compare_elim_after_reload);
398 NEXT_PASS (pass_branch_target_load_optimize1);
399 NEXT_PASS (pass_thread_prologue_and_epilogue);
400 NEXT_PASS (pass_rtl_dse2);
401 NEXT_PASS (pass_stack_adjustments);
402 NEXT_PASS (pass_jump2);
403 NEXT_PASS (pass_duplicate_computed_gotos);
404 NEXT_PASS (pass_peephole2);
405 NEXT_PASS (pass_if_after_reload);
406 NEXT_PASS (pass_regrename);
407 NEXT_PASS (pass_cprop_hardreg);
408 NEXT_PASS (pass_fast_rtl_dce);
409 NEXT_PASS (pass_reorder_blocks);
410 NEXT_PASS (pass_branch_target_load_optimize2);
411 NEXT_PASS (pass_leaf_regs);
412 NEXT_PASS (pass_split_before_sched2);
413 NEXT_PASS (pass_sched2);
414 NEXT_PASS (pass_stack_regs);
415 PUSH_INSERT_PASSES_WITHIN (pass_stack_regs)
416 NEXT_PASS (pass_split_before_regstack);
417 NEXT_PASS (pass_stack_regs_run);
418 POP_INSERT_PASSES ()
419 NEXT_PASS (pass_compute_alignments);
420 NEXT_PASS (pass_variable_tracking);
421 NEXT_PASS (pass_free_cfg);
422 NEXT_PASS (pass_machine_reorg);
423 NEXT_PASS (pass_cleanup_barriers);
424 NEXT_PASS (pass_delay_slots);
425 NEXT_PASS (pass_split_for_shorten_branches);
426 NEXT_PASS (pass_convert_to_eh_region_ranges);
427 NEXT_PASS (pass_shorten_branches);
428 NEXT_PASS (pass_set_nothrow_function_flags);
429 NEXT_PASS (pass_dwarf2_frame);
430 NEXT_PASS (pass_final);
431 POP_INSERT_PASSES ()
432 NEXT_PASS (pass_df_finish);
433 POP_INSERT_PASSES ()
434 NEXT_PASS (pass_clean_state);
435 TERMINATE_PASS_LIST ()