1 /* Definitions for describing one tree-ssa optimization pass.
2 Copyright (C) 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
3 Contributed by Richard Henderson <rth@redhat.com>
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GCC is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING. If not, write to
19 the Free Software Foundation, 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
23 #ifndef GCC_TREE_PASS_H
24 #define GCC_TREE_PASS_H 1
28 /* Different tree dump places. When you add new tree dump places,
29 extend the DUMP_FILES array in tree-dump.c. */
32 TDI_none
, /* No dump */
33 TDI_cgraph
, /* dump function call graph. */
34 TDI_tu
, /* dump the whole translation unit. */
35 TDI_class
, /* dump class hierarchy. */
36 TDI_original
, /* dump each function before optimizing it */
37 TDI_generic
, /* dump each function after genericizing it */
38 TDI_nested
, /* dump each function after unnesting it */
39 TDI_inlined
, /* dump each function after inlining
41 TDI_vcg
, /* create a VCG graph file for each
42 function's flowgraph. */
43 TDI_tree_all
, /* enable all the GENERIC/GIMPLE dumps. */
44 TDI_rtl_all
, /* enable all the RTL dumps. */
45 TDI_ipa_all
, /* enable all the IPA dumps. */
50 /* Bit masks to control dumping. Not all values are applicable to
51 all dumps. Add new ones at the end. When you define new
52 values, extend the DUMP_OPTIONS array in tree-dump.c */
53 #define TDF_ADDRESS (1 << 0) /* dump node addresses */
54 #define TDF_SLIM (1 << 1) /* don't go wild following links */
55 #define TDF_RAW (1 << 2) /* don't unparse the function */
56 #define TDF_DETAILS (1 << 3) /* show more detailed info about
58 #define TDF_STATS (1 << 4) /* dump various statistics about
60 #define TDF_BLOCKS (1 << 5) /* display basic block boundaries */
61 #define TDF_VOPS (1 << 6) /* display virtual operands */
62 #define TDF_LINENO (1 << 7) /* display statement line numbers */
63 #define TDF_UID (1 << 8) /* display decl UIDs */
65 #define TDF_TREE (1 << 9) /* is a tree dump */
66 #define TDF_RTL (1 << 10) /* is a RTL dump */
67 #define TDF_IPA (1 << 11) /* is an IPA dump */
68 #define TDF_STMTADDR (1 << 12) /* Address of stmt. */
70 #define TDF_GRAPH (1 << 13) /* a graph dump is being emitted */
71 #define TDF_MEMSYMS (1 << 14) /* display memory symbols in expr.
74 #define TDF_DIAGNOSTIC (1 << 15) /* A dump to be put in a diagnostic
77 extern char *get_dump_file_name (enum tree_dump_index
);
78 extern int dump_enabled_p (enum tree_dump_index
);
79 extern int dump_initialized_p (enum tree_dump_index
);
80 extern FILE *dump_begin (enum tree_dump_index
, int *);
81 extern void dump_end (enum tree_dump_index
, FILE *);
82 extern void dump_node (tree
, int, FILE *);
83 extern int dump_switch_p (const char *);
84 extern const char *dump_flag_name (enum tree_dump_index
);
86 /* Global variables used to communicate with passes. */
87 extern FILE *dump_file
;
88 extern int dump_flags
;
89 extern const char *dump_file_name
;
91 /* Return the dump_file_info for the given phase. */
92 extern struct dump_file_info
*get_dump_file_info (enum tree_dump_index
);
94 /* Describe one pass. */
97 /* Terse name of the pass used as a fragment of the dump file name. */
100 /* If non-null, this pass and all sub-passes are executed only if
101 the function returns true. */
104 /* This is the code to run. If null, then there should be sub-passes
105 otherwise this pass does nothing. The return value contains
106 TODOs to execute in addition to those in TODO_flags_finish. */
107 unsigned int (*execute
) (void);
109 /* A list of sub-passes to run, dependent on gate predicate. */
110 struct tree_opt_pass
*sub
;
112 /* Next in the list of passes to run, independent of gate predicate. */
113 struct tree_opt_pass
*next
;
115 /* Static pass number, used as a fragment of the dump file name. */
116 int static_pass_number
;
118 /* The timevar id associated with this pass. */
119 /* ??? Ideally would be dynamically assigned. */
122 /* Sets of properties input and output from this pass. */
123 unsigned int properties_required
;
124 unsigned int properties_provided
;
125 unsigned int properties_destroyed
;
127 /* Flags indicating common sets things to do before and after. */
128 unsigned int todo_flags_start
;
129 unsigned int todo_flags_finish
;
131 /* Letter for RTL dumps. */
135 /* Define a tree dump switch. */
136 struct dump_file_info
138 const char *suffix
; /* suffix to give output file. */
139 const char *swtch
; /* command line switch */
140 const char *glob
; /* command line glob */
141 int flags
; /* user flags */
142 int state
; /* state of play */
143 int num
; /* dump file number */
144 int letter
; /* enabling letter for RTL dumps */
147 /* Pass properties. */
148 #define PROP_gimple_any (1 << 0) /* entire gimple grammar */
149 #define PROP_gimple_lcf (1 << 1) /* lowered control flow */
150 #define PROP_gimple_leh (1 << 2) /* lowered eh */
151 #define PROP_cfg (1 << 3)
152 #define PROP_referenced_vars (1 << 4)
153 #define PROP_pta (1 << 5)
154 #define PROP_ssa (1 << 6)
155 #define PROP_no_crit_edges (1 << 7)
156 #define PROP_rtl (1 << 8)
157 #define PROP_alias (1 << 9)
158 #define PROP_gimple_lomp (1 << 10) /* lowered OpenMP directives */
161 (PROP_gimple_any | PROP_gimple_lcf | PROP_gimple_leh | PROP_gimple_lomp)
164 #define TODO_dump_func (1 << 0)
165 #define TODO_ggc_collect (1 << 1)
166 #define TODO_verify_ssa (1 << 2)
167 #define TODO_verify_flow (1 << 3)
168 #define TODO_verify_stmts (1 << 4)
169 #define TODO_cleanup_cfg (1 << 5)
170 #define TODO_verify_loops (1 << 6)
171 #define TODO_dump_cgraph (1 << 7)
172 #define TODO_remove_functions (1 << 8)
173 #define TODO_rebuild_frequencies (1 << 9)
175 /* To-do flags for calls to update_ssa. */
177 /* Update the SSA form inserting PHI nodes for newly exposed symbols
178 and virtual names marked for updating. When updating real names,
179 only insert PHI nodes for a real name O_j in blocks reached by all
180 the new and old definitions for O_j. If the iterated dominance
181 frontier for O_j is not pruned, we may end up inserting PHI nodes
182 in blocks that have one or more edges with no incoming definition
183 for O_j. This would lead to uninitialized warnings for O_j's
185 #define TODO_update_ssa (1 << 10)
187 /* Update the SSA form without inserting any new PHI nodes at all.
188 This is used by passes that have either inserted all the PHI nodes
189 themselves or passes that need only to patch use-def and def-def
190 chains for virtuals (e.g., DCE). */
191 #define TODO_update_ssa_no_phi (1 << 11)
193 /* Insert PHI nodes everywhere they are needed. No pruning of the
194 IDF is done. This is used by passes that need the PHI nodes for
195 O_j even if it means that some arguments will come from the default
196 definition of O_j's symbol (e.g., pass_linear_transform).
198 WARNING: If you need to use this flag, chances are that your pass
199 may be doing something wrong. Inserting PHI nodes for an old name
200 where not all edges carry a new replacement may lead to silent
201 codegen errors or spurious uninitialized warnings. */
202 #define TODO_update_ssa_full_phi (1 << 12)
204 /* Passes that update the SSA form on their own may want to delegate
205 the updating of virtual names to the generic updater. Since FUD
206 chains are easier to maintain, this simplifies the work they need
207 to do. NOTE: If this flag is used, any OLD->NEW mappings for real
208 names are explicitly destroyed and only the symbols marked for
209 renaming are processed. */
210 #define TODO_update_ssa_only_virtuals (1 << 13)
212 /* Some passes leave unused local variables that can be removed from
213 cfun->unexpanded_var_list. This reduces the size of dump files and
214 the memory footprint for VAR_DECLs. */
215 #define TODO_remove_unused_locals (1 << 14)
217 /* Internally used for the first in a sequence of passes. It is set
218 for the passes that are handed to register_dump_files. */
219 #define TODO_set_props (1 << 15)
221 #define TODO_update_ssa_any \
223 | TODO_update_ssa_no_phi \
224 | TODO_update_ssa_full_phi \
225 | TODO_update_ssa_only_virtuals)
227 #define TODO_verify_all \
228 (TODO_verify_ssa | TODO_verify_flow | TODO_verify_stmts)
230 extern void tree_lowering_passes (tree decl
);
232 extern struct tree_opt_pass pass_mudflap_1
;
233 extern struct tree_opt_pass pass_mudflap_2
;
234 extern struct tree_opt_pass pass_remove_useless_stmts
;
235 extern struct tree_opt_pass pass_lower_cf
;
236 extern struct tree_opt_pass pass_lower_eh
;
237 extern struct tree_opt_pass pass_build_cfg
;
238 extern struct tree_opt_pass pass_tree_profile
;
239 extern struct tree_opt_pass pass_early_tree_profile
;
240 extern struct tree_opt_pass pass_cleanup_cfg
;
241 extern struct tree_opt_pass pass_referenced_vars
;
242 extern struct tree_opt_pass pass_sra
;
243 extern struct tree_opt_pass pass_sra_early
;
244 extern struct tree_opt_pass pass_tail_recursion
;
245 extern struct tree_opt_pass pass_tail_calls
;
246 extern struct tree_opt_pass pass_tree_loop
;
247 extern struct tree_opt_pass pass_tree_loop_init
;
248 extern struct tree_opt_pass pass_lim
;
249 extern struct tree_opt_pass pass_tree_unswitch
;
250 extern struct tree_opt_pass pass_iv_canon
;
251 extern struct tree_opt_pass pass_scev_cprop
;
252 extern struct tree_opt_pass pass_empty_loop
;
253 extern struct tree_opt_pass pass_record_bounds
;
254 extern struct tree_opt_pass pass_if_conversion
;
255 extern struct tree_opt_pass pass_vectorize
;
256 extern struct tree_opt_pass pass_complete_unroll
;
257 extern struct tree_opt_pass pass_loop_prefetch
;
258 extern struct tree_opt_pass pass_iv_optimize
;
259 extern struct tree_opt_pass pass_tree_loop_done
;
260 extern struct tree_opt_pass pass_ch
;
261 extern struct tree_opt_pass pass_ccp
;
262 extern struct tree_opt_pass pass_phi_only_cprop
;
263 extern struct tree_opt_pass pass_build_ssa
;
264 extern struct tree_opt_pass pass_del_ssa
;
265 extern struct tree_opt_pass pass_dominator
;
266 extern struct tree_opt_pass pass_dce
;
267 extern struct tree_opt_pass pass_dce_loop
;
268 extern struct tree_opt_pass pass_cd_dce
;
269 extern struct tree_opt_pass pass_merge_phi
;
270 extern struct tree_opt_pass pass_may_alias
;
271 extern struct tree_opt_pass pass_split_crit_edges
;
272 extern struct tree_opt_pass pass_pre
;
273 extern struct tree_opt_pass pass_profile
;
274 extern struct tree_opt_pass pass_lower_complex_O0
;
275 extern struct tree_opt_pass pass_lower_complex
;
276 extern struct tree_opt_pass pass_lower_vector
;
277 extern struct tree_opt_pass pass_lower_vector_ssa
;
278 extern struct tree_opt_pass pass_lower_omp
;
279 extern struct tree_opt_pass pass_expand_omp
;
280 extern struct tree_opt_pass pass_object_sizes
;
281 extern struct tree_opt_pass pass_fold_builtins
;
282 extern struct tree_opt_pass pass_stdarg
;
283 extern struct tree_opt_pass pass_early_warn_uninitialized
;
284 extern struct tree_opt_pass pass_late_warn_uninitialized
;
285 extern struct tree_opt_pass pass_cse_reciprocals
;
286 extern struct tree_opt_pass pass_cse_sincos
;
287 extern struct tree_opt_pass pass_warn_function_return
;
288 extern struct tree_opt_pass pass_warn_function_noreturn
;
289 extern struct tree_opt_pass pass_phiopt
;
290 extern struct tree_opt_pass pass_forwprop
;
291 extern struct tree_opt_pass pass_phiprop
;
292 extern struct tree_opt_pass pass_dse
;
293 extern struct tree_opt_pass pass_nrv
;
294 extern struct tree_opt_pass pass_mark_used_blocks
;
295 extern struct tree_opt_pass pass_rename_ssa_copies
;
296 extern struct tree_opt_pass pass_expand
;
297 extern struct tree_opt_pass pass_rest_of_compilation
;
298 extern struct tree_opt_pass pass_sink_code
;
299 extern struct tree_opt_pass pass_fre
;
300 extern struct tree_opt_pass pass_linear_transform
;
301 extern struct tree_opt_pass pass_check_data_deps
;
302 extern struct tree_opt_pass pass_copy_prop
;
303 extern struct tree_opt_pass pass_store_ccp
;
304 extern struct tree_opt_pass pass_store_copy_prop
;
305 extern struct tree_opt_pass pass_vrp
;
306 extern struct tree_opt_pass pass_create_structure_vars
;
307 extern struct tree_opt_pass pass_uncprop
;
308 extern struct tree_opt_pass pass_return_slot
;
309 extern struct tree_opt_pass pass_reassoc
;
310 extern struct tree_opt_pass pass_rebuild_cgraph_edges
;
311 extern struct tree_opt_pass pass_build_cgraph_edges
;
312 extern struct tree_opt_pass pass_reset_cc_flags
;
315 extern struct tree_opt_pass pass_ipa_cp
;
316 extern struct tree_opt_pass pass_ipa_inline
;
317 extern struct tree_opt_pass pass_ipa_early_inline
;
318 extern struct tree_opt_pass pass_ipa_reference
;
319 extern struct tree_opt_pass pass_ipa_pure_const
;
320 extern struct tree_opt_pass pass_ipa_type_escape
;
321 extern struct tree_opt_pass pass_ipa_pta
;
322 extern struct tree_opt_pass pass_early_local_passes
;
323 extern struct tree_opt_pass pass_ipa_increase_alignment
;
324 extern struct tree_opt_pass pass_ipa_function_and_variable_visibility
;
326 extern struct tree_opt_pass pass_all_optimizations
;
327 extern struct tree_opt_pass pass_cleanup_cfg_post_optimizing
;
328 extern struct tree_opt_pass pass_free_cfg_annotations
;
329 extern struct tree_opt_pass pass_free_datastructures
;
330 extern struct tree_opt_pass pass_init_datastructures
;
331 extern struct tree_opt_pass pass_fixup_cfg
;
333 extern struct tree_opt_pass pass_init_function
;
334 extern struct tree_opt_pass pass_jump
;
335 extern struct tree_opt_pass pass_insn_locators_initialize
;
336 extern struct tree_opt_pass pass_rtl_eh
;
337 extern struct tree_opt_pass pass_initial_value_sets
;
338 extern struct tree_opt_pass pass_unshare_all_rtl
;
339 extern struct tree_opt_pass pass_instantiate_virtual_regs
;
340 extern struct tree_opt_pass pass_rtl_fwprop
;
341 extern struct tree_opt_pass pass_rtl_fwprop_addr
;
342 extern struct tree_opt_pass pass_jump2
;
343 extern struct tree_opt_pass pass_lower_subreg
;
344 extern struct tree_opt_pass pass_cse
;
345 extern struct tree_opt_pass pass_gcse
;
346 extern struct tree_opt_pass pass_jump_bypass
;
347 extern struct tree_opt_pass pass_profiling
;
348 extern struct tree_opt_pass pass_rtl_ifcvt
;
349 extern struct tree_opt_pass pass_tracer
;
351 extern struct tree_opt_pass pass_into_cfg_layout_mode
;
352 extern struct tree_opt_pass pass_outof_cfg_layout_mode
;
354 extern struct tree_opt_pass pass_loop2
;
355 extern struct tree_opt_pass pass_rtl_loop_init
;
356 extern struct tree_opt_pass pass_rtl_move_loop_invariants
;
357 extern struct tree_opt_pass pass_rtl_unswitch
;
358 extern struct tree_opt_pass pass_rtl_unroll_and_peel_loops
;
359 extern struct tree_opt_pass pass_rtl_doloop
;
360 extern struct tree_opt_pass pass_rtl_loop_done
;
362 extern struct tree_opt_pass pass_web
;
363 extern struct tree_opt_pass pass_cse2
;
364 extern struct tree_opt_pass pass_life
;
365 extern struct tree_opt_pass pass_combine
;
366 extern struct tree_opt_pass pass_if_after_combine
;
367 extern struct tree_opt_pass pass_partition_blocks
;
368 extern struct tree_opt_pass pass_regmove
;
369 extern struct tree_opt_pass pass_split_all_insns
;
370 extern struct tree_opt_pass pass_lower_subreg2
;
371 extern struct tree_opt_pass pass_mode_switching
;
372 extern struct tree_opt_pass pass_see
;
373 extern struct tree_opt_pass pass_recompute_reg_usage
;
374 extern struct tree_opt_pass pass_sms
;
375 extern struct tree_opt_pass pass_sched
;
376 extern struct tree_opt_pass pass_local_alloc
;
377 extern struct tree_opt_pass pass_global_alloc
;
378 extern struct tree_opt_pass pass_postreload
;
379 extern struct tree_opt_pass pass_clean_state
;
380 extern struct tree_opt_pass pass_branch_prob
;
381 extern struct tree_opt_pass pass_value_profile_transformations
;
382 extern struct tree_opt_pass pass_remove_death_notes
;
383 extern struct tree_opt_pass pass_postreload_cse
;
384 extern struct tree_opt_pass pass_gcse2
;
385 extern struct tree_opt_pass pass_flow2
;
386 extern struct tree_opt_pass pass_stack_adjustments
;
387 extern struct tree_opt_pass pass_peephole2
;
388 extern struct tree_opt_pass pass_if_after_reload
;
389 extern struct tree_opt_pass pass_regrename
;
390 extern struct tree_opt_pass pass_reorder_blocks
;
391 extern struct tree_opt_pass pass_branch_target_load_optimize
;
392 extern struct tree_opt_pass pass_leaf_regs
;
393 extern struct tree_opt_pass pass_sched2
;
394 extern struct tree_opt_pass pass_stack_regs
;
395 extern struct tree_opt_pass pass_compute_alignments
;
396 extern struct tree_opt_pass pass_duplicate_computed_gotos
;
397 extern struct tree_opt_pass pass_variable_tracking
;
398 extern struct tree_opt_pass pass_free_cfg
;
399 extern struct tree_opt_pass pass_machine_reorg
;
400 extern struct tree_opt_pass pass_cleanup_barriers
;
401 extern struct tree_opt_pass pass_delay_slots
;
402 extern struct tree_opt_pass pass_split_for_shorten_branches
;
403 extern struct tree_opt_pass pass_split_before_regstack
;
404 extern struct tree_opt_pass pass_convert_to_eh_region_ranges
;
405 extern struct tree_opt_pass pass_shorten_branches
;
406 extern struct tree_opt_pass pass_set_nothrow_function_flags
;
407 extern struct tree_opt_pass pass_final
;
408 extern struct tree_opt_pass pass_rtl_seqabstr
;
409 extern struct tree_opt_pass pass_release_ssa_names
;
410 extern struct tree_opt_pass pass_early_inline
;
411 extern struct tree_opt_pass pass_inline_parameters
;
412 extern struct tree_opt_pass pass_apply_inline
;
413 extern struct tree_opt_pass pass_all_early_optimizations
;
415 /* The root of the compilation pass tree, once constructed. */
416 extern struct tree_opt_pass
*all_passes
, *all_ipa_passes
, *all_lowering_passes
;
418 extern void execute_pass_list (struct tree_opt_pass
*);
419 extern void execute_ipa_pass_list (struct tree_opt_pass
*);
421 #endif /* GCC_TREE_PASS_H */