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