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