]> git.ipfire.org Git - thirdparty/gcc.git/blame - gcc/tree-pass.h
2005-07-05 Paolo Bonzini <bonzini@gnu.org>
[thirdparty/gcc.git] / gcc / tree-pass.h
CommitLineData
4ee9c684 1/* Definitions for describing one tree-ssa optimization pass.
2b4876d2 2 Copyright (C) 2004, 2005 Free Software Foundation, Inc.
4ee9c684 3 Contributed by Richard Henderson <rth@redhat.com>
4
5This file is part of GCC.
6
7GCC is free software; you can redistribute it and/or modify
8it under the terms of the GNU General Public License as published by
9the Free Software Foundation; either version 2, or (at your option)
10any later version.
11
12GCC is distributed in the hope that it will be useful,
13but WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15GNU General Public License for more details.
16
17You should have received a copy of the GNU General Public License
18along with GCC; see the file COPYING. If not, write to
67ce556b 19the Free Software Foundation, 51 Franklin Street, Fifth Floor,
20Boston, MA 02110-1301, USA. */
4ee9c684 21
22
23#ifndef GCC_TREE_PASS_H
24#define GCC_TREE_PASS_H 1
25
77fce4cd 26/* In tree-dump.c */
27
28/* Different tree dump places. When you add new tree dump places,
29 extend the DUMP_FILES array in tree-dump.c. */
30enum tree_dump_index
31{
32 TDI_none, /* No dump */
33 TDI_tu, /* dump the whole translation unit. */
34 TDI_class, /* dump class hierarchy. */
35 TDI_original, /* dump each function before optimizing it */
36 TDI_generic, /* dump each function after genericizing it */
37 TDI_nested, /* dump each function after unnesting it */
38 TDI_inlined, /* dump each function after inlining
39 within it. */
40 TDI_vcg, /* create a VCG graph file for each
41 function's flowgraph. */
42 TDI_tree_all, /* enable all the GENERIC/GIMPLE dumps. */
43 TDI_rtl_all, /* enable all the RTL dumps. */
44 TDI_ipa_all, /* enable all the IPA dumps. */
45
46 TDI_cgraph, /* dump function call graph. */
47 TDI_end
48};
49
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
57 each pass */
58#define TDF_STATS (1 << 4) /* dump various statistics about
59 each pass */
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 */
64
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. */
69
70extern char *get_dump_file_name (enum tree_dump_index);
71extern int dump_enabled_p (enum tree_dump_index);
72extern int dump_initialized_p (enum tree_dump_index);
73extern FILE *dump_begin (enum tree_dump_index, int *);
74extern void dump_end (enum tree_dump_index, FILE *);
75extern void dump_node (tree, int, FILE *);
76extern int dump_switch_p (const char *);
77extern const char *dump_flag_name (enum tree_dump_index);
78
4ee9c684 79/* Global variables used to communicate with passes. */
80extern FILE *dump_file;
81extern int dump_flags;
0f9005dd 82extern const char *dump_file_name;
4ee9c684 83
0f9005dd 84/* Return the dump_file_info for the given phase. */
85extern struct dump_file_info *get_dump_file_info (enum tree_dump_index);
86
4ee9c684 87/* Describe one pass. */
88struct tree_opt_pass
89{
90 /* Terse name of the pass used as a fragment of the dump file name. */
91 const char *name;
92
93 /* If non-null, this pass and all sub-passes are executed only if
94 the function returns true. */
95 bool (*gate) (void);
96
97 /* This is the code to run. If null, then there should be sub-passes
98 otherwise this pass does nothing. */
99 void (*execute) (void);
100
101 /* A list of sub-passes to run, dependent on gate predicate. */
102 struct tree_opt_pass *sub;
103
104 /* Next in the list of passes to run, independent of gate predicate. */
105 struct tree_opt_pass *next;
106
107 /* Static pass number, used as a fragment of the dump file name. */
865a4105 108 int static_pass_number;
4ee9c684 109
110 /* The timevar id associated with this pass. */
111 /* ??? Ideally would be dynamically assigned. */
112 unsigned int tv_id;
113
114 /* Sets of properties input and output from this pass. */
115 unsigned int properties_required;
116 unsigned int properties_provided;
117 unsigned int properties_destroyed;
118
119 /* Flags indicating common sets things to do before and after. */
120 unsigned int todo_flags_start;
121 unsigned int todo_flags_finish;
0f9005dd 122
123 /* Letter for RTL dumps. */
124 char letter;
125};
126
127/* Define a tree dump switch. */
128struct dump_file_info
129{
130 const char *suffix; /* suffix to give output file. */
131 const char *swtch; /* command line switch */
53907817 132 const char *glob; /* command line glob */
0f9005dd 133 int flags; /* user flags */
134 int state; /* state of play */
135 int num; /* dump file number */
136 int letter; /* enabling letter for RTL dumps */
4ee9c684 137};
138
139/* Pass properties. */
140#define PROP_gimple_any (1 << 0) /* entire gimple grammar */
141#define PROP_gimple_lcf (1 << 1) /* lowered control flow */
142#define PROP_gimple_leh (1 << 2) /* lowered eh */
143#define PROP_cfg (1 << 3)
144#define PROP_referenced_vars (1 << 4)
145#define PROP_pta (1 << 5)
146#define PROP_ssa (1 << 6)
147#define PROP_no_crit_edges (1 << 7)
5290ebdb 148#define PROP_rtl (1 << 8)
f45a1ca1 149#define PROP_alias (1 << 9)
5290ebdb 150
151#define PROP_trees \
152 (PROP_gimple_any | PROP_gimple_lcf | PROP_gimple_leh)
4ee9c684 153
154/* To-do flags. */
88dbf20f 155#define TODO_dump_func (1 << 0)
156#define TODO_ggc_collect (1 << 1)
157#define TODO_verify_ssa (1 << 2)
158#define TODO_verify_flow (1 << 3)
159#define TODO_verify_stmts (1 << 4)
160#define TODO_cleanup_cfg (1 << 5)
161#define TODO_verify_loops (1 << 6)
f1e2a033 162#define TODO_dump_cgraph (1 << 7)
88dbf20f 163
164/* To-do flags for calls to update_ssa. */
165
166/* Update the SSA form inserting PHI nodes for newly exposed symbols
167 and virtual names marked for updating. When updating real names,
168 only insert PHI nodes for a real name O_j in blocks reached by all
169 the new and old definitions for O_j. If the iterated dominance
170 frontier for O_j is not pruned, we may end up inserting PHI nodes
171 in blocks that have one or more edges with no incoming definition
172 for O_j. This would lead to uninitialized warnings for O_j's
173 symbol. */
174#define TODO_update_ssa (1 << 7)
175
176/* Update the SSA form without inserting any new PHI nodes at all.
177 This is used by passes that have either inserted all the PHI nodes
178 themselves or passes that need only to patch use-def and def-def
179 chains for virtuals (e.g., DCE). */
180#define TODO_update_ssa_no_phi (1 << 8)
181
442e3cb9 182/* Insert PHI nodes everywhere they are needed. No pruning of the
88dbf20f 183 IDF is done. This is used by passes that need the PHI nodes for
184 O_j even if it means that some arguments will come from the default
185 definition of O_j's symbol (e.g., pass_linear_transform).
186
187 WARNING: If you need to use this flag, chances are that your pass
188 may be doing something wrong. Inserting PHI nodes for an old name
189 where not all edges carry a new replacement may lead to silent
190 codegen errors or spurious uninitialized warnings. */
191#define TODO_update_ssa_full_phi (1 << 9)
192
193/* Passes that update the SSA form on their own may want to delegate
194 the updating of virtual names to the generic updater. Since FUD
195 chains are easier to maintain, this simplifies the work they need
196 to do. NOTE: If this flag is used, any OLD->NEW mappings for real
197 names are explicitly destroyed and only the symbols marked for
198 renaming are processed. */
199#define TODO_update_ssa_only_virtuals (1 << 10)
200
201#define TODO_update_ssa_any \
202 (TODO_update_ssa \
203 | TODO_update_ssa_no_phi \
204 | TODO_update_ssa_full_phi \
205 | TODO_update_ssa_only_virtuals)
4ee9c684 206
207#define TODO_verify_all \
208 (TODO_verify_ssa | TODO_verify_flow | TODO_verify_stmts)
209
e27482aa 210extern void tree_lowering_passes (tree decl);
f1e2a033 211
4ee9c684 212extern struct tree_opt_pass pass_mudflap_1;
213extern struct tree_opt_pass pass_mudflap_2;
214extern struct tree_opt_pass pass_remove_useless_stmts;
215extern struct tree_opt_pass pass_lower_cf;
216extern struct tree_opt_pass pass_lower_eh;
217extern struct tree_opt_pass pass_build_cfg;
218extern struct tree_opt_pass pass_tree_profile;
9e0baf4d 219extern struct tree_opt_pass pass_early_tree_profile;
77fce4cd 220extern struct tree_opt_pass pass_cleanup_cfg;
4ee9c684 221extern struct tree_opt_pass pass_referenced_vars;
4ee9c684 222extern struct tree_opt_pass pass_sra;
223extern struct tree_opt_pass pass_tail_recursion;
224extern struct tree_opt_pass pass_tail_calls;
225extern struct tree_opt_pass pass_loop;
dcb9eccb 226extern struct tree_opt_pass pass_loop_init;
7d23383d 227extern struct tree_opt_pass pass_lim;
e12d0591 228extern struct tree_opt_pass pass_unswitch;
bb445479 229extern struct tree_opt_pass pass_iv_canon;
10fec820 230extern struct tree_opt_pass pass_scev_cprop;
41fc6ce4 231extern struct tree_opt_pass pass_record_bounds;
07c03fb0 232extern struct tree_opt_pass pass_if_conversion;
c91e8223 233extern struct tree_opt_pass pass_vectorize;
bb445479 234extern struct tree_opt_pass pass_complete_unroll;
dec41e98 235extern struct tree_opt_pass pass_iv_optimize;
dcb9eccb 236extern struct tree_opt_pass pass_loop_done;
4ee9c684 237extern struct tree_opt_pass pass_ch;
238extern struct tree_opt_pass pass_ccp;
239extern struct tree_opt_pass pass_build_ssa;
240extern struct tree_opt_pass pass_del_ssa;
241extern struct tree_opt_pass pass_dominator;
242extern struct tree_opt_pass pass_dce;
243extern struct tree_opt_pass pass_cd_dce;
9cd34e71 244extern struct tree_opt_pass pass_merge_phi;
4ee9c684 245extern struct tree_opt_pass pass_may_alias;
246extern struct tree_opt_pass pass_split_crit_edges;
247extern struct tree_opt_pass pass_pre;
248extern struct tree_opt_pass pass_profile;
50c96bdc 249extern struct tree_opt_pass pass_lower_complex_O0;
0501cacc 250extern struct tree_opt_pass pass_lower_complex;
251extern struct tree_opt_pass pass_lower_vector;
83e2a11b 252extern struct tree_opt_pass pass_lower_vector_ssa;
0a39fd54 253extern struct tree_opt_pass pass_object_sizes;
4ee9c684 254extern struct tree_opt_pass pass_fold_builtins;
a6c787e5 255extern struct tree_opt_pass pass_stdarg;
4ee9c684 256extern struct tree_opt_pass pass_early_warn_uninitialized;
257extern struct tree_opt_pass pass_late_warn_uninitialized;
429f2f90 258extern struct tree_opt_pass pass_cse_reciprocals;
4ee9c684 259extern struct tree_opt_pass pass_warn_function_return;
73d5fb10 260extern struct tree_opt_pass pass_warn_function_noreturn;
4ee9c684 261extern struct tree_opt_pass pass_phiopt;
262extern struct tree_opt_pass pass_forwprop;
263extern struct tree_opt_pass pass_redundant_phi;
264extern struct tree_opt_pass pass_dse;
265extern struct tree_opt_pass pass_nrv;
266extern struct tree_opt_pass pass_remove_useless_vars;
9e45f419 267extern struct tree_opt_pass pass_mark_used_blocks;
4ee9c684 268extern struct tree_opt_pass pass_rename_ssa_copies;
5290ebdb 269extern struct tree_opt_pass pass_expand;
270extern struct tree_opt_pass pass_rest_of_compilation;
5e733b02 271extern struct tree_opt_pass pass_sink_code;
591c2a30 272extern struct tree_opt_pass pass_fre;
60cfcb79 273extern struct tree_opt_pass pass_linear_transform;
88dbf20f 274extern struct tree_opt_pass pass_copy_prop;
275extern struct tree_opt_pass pass_store_ccp;
276extern struct tree_opt_pass pass_store_copy_prop;
277extern struct tree_opt_pass pass_vrp;
2be14d8b 278extern struct tree_opt_pass pass_create_structure_vars;
29fd4364 279extern struct tree_opt_pass pass_build_pta;
280extern struct tree_opt_pass pass_del_pta;
5f718c29 281extern struct tree_opt_pass pass_uncprop;
ea523851 282extern struct tree_opt_pass pass_return_slot;
3dec5460 283extern struct tree_opt_pass pass_reassoc;
9e0baf4d 284extern struct tree_opt_pass pass_rebuild_cgraph_edges;
4ee9c684 285
3dec5460 286/* IPA Passes */
f1e2a033 287extern struct tree_opt_pass pass_ipa_inline;
9e0baf4d 288extern struct tree_opt_pass pass_early_ipa_inline;
77fce4cd 289extern struct tree_opt_pass pass_early_local_passes;
290
291extern struct tree_opt_pass pass_all_optimizations;
292extern struct tree_opt_pass pass_cleanup_cfg_post_optimizing;
293extern struct tree_opt_pass pass_free_cfg_annotations;
294extern struct tree_opt_pass pass_free_datastructures;
295extern struct tree_opt_pass pass_init_datastructures;
296extern struct tree_opt_pass pass_fixup_cfg;
297
298extern struct tree_opt_pass pass_remove_unnecessary_notes;
299extern struct tree_opt_pass pass_init_function;
300extern struct tree_opt_pass pass_jump;
301extern struct tree_opt_pass pass_insn_locators_initialize;
302extern struct tree_opt_pass pass_rtl_eh;
303extern struct tree_opt_pass pass_initial_value_sets;
304extern struct tree_opt_pass pass_unshare_all_rtl;
305extern struct tree_opt_pass pass_instantiate_virtual_regs;
306extern struct tree_opt_pass pass_jump2;
307extern struct tree_opt_pass pass_cse;
308extern struct tree_opt_pass pass_gcse;
309extern struct tree_opt_pass pass_loop_optimize;
310extern struct tree_opt_pass pass_jump_bypass;
311extern struct tree_opt_pass pass_cfg;
312extern struct tree_opt_pass pass_profiling;
313extern struct tree_opt_pass pass_rtl_ifcvt;
314extern struct tree_opt_pass pass_tracer;
315extern struct tree_opt_pass pass_loop2;
316extern struct tree_opt_pass pass_web;
317extern struct tree_opt_pass pass_cse2;
318extern struct tree_opt_pass pass_life;
319extern struct tree_opt_pass pass_combine;
320extern struct tree_opt_pass pass_if_after_combine;
321extern struct tree_opt_pass pass_partition_blocks;
322extern struct tree_opt_pass pass_partition_blocks;
323extern struct tree_opt_pass pass_regmove;
324extern struct tree_opt_pass pass_split_all_insns;
325extern struct tree_opt_pass pass_mode_switching;
326extern struct tree_opt_pass pass_recompute_reg_usage;
327extern struct tree_opt_pass pass_sms;
328extern struct tree_opt_pass pass_sched;
329extern struct tree_opt_pass pass_local_alloc;
330extern struct tree_opt_pass pass_global_alloc;
331extern struct tree_opt_pass pass_postreload;
332extern struct tree_opt_pass pass_clean_state;
333extern struct tree_opt_pass pass_branch_prob;
334extern struct tree_opt_pass pass_value_profile_transformations;
335extern struct tree_opt_pass pass_remove_death_notes;
336extern struct tree_opt_pass pass_postreload_cse;
337extern struct tree_opt_pass pass_gcse2;
338extern struct tree_opt_pass pass_flow2;
339extern struct tree_opt_pass pass_stack_adjustments;
340extern struct tree_opt_pass pass_peephole2;
341extern struct tree_opt_pass pass_if_after_reload;
342extern struct tree_opt_pass pass_regrename;
343extern struct tree_opt_pass pass_reorder_blocks;
344extern struct tree_opt_pass pass_branch_target_load_optimize;
345extern struct tree_opt_pass pass_leaf_regs;
346extern struct tree_opt_pass pass_sched2;
347extern struct tree_opt_pass pass_stack_regs;
348extern struct tree_opt_pass pass_compute_alignments;
349extern struct tree_opt_pass pass_duplicate_computed_gotos;
350extern struct tree_opt_pass pass_variable_tracking;
351extern struct tree_opt_pass pass_free_cfg;
352extern struct tree_opt_pass pass_machine_reorg;
353extern struct tree_opt_pass pass_purge_lineno_notes;
354extern struct tree_opt_pass pass_cleanup_barriers;
355extern struct tree_opt_pass pass_delay_slots;
356extern struct tree_opt_pass pass_split_for_shorten_branches;
357extern struct tree_opt_pass pass_split_before_regstack;
358extern struct tree_opt_pass pass_convert_to_eh_region_ranges;
359extern struct tree_opt_pass pass_shorten_branches;
360extern struct tree_opt_pass pass_set_nothrow_function_flags;
361extern struct tree_opt_pass pass_final;
362
363/* The root of the compilation pass tree, once constructed. */
364extern struct tree_opt_pass *all_passes, *all_ipa_passes, *all_lowering_passes;
365
366extern void execute_pass_list (struct tree_opt_pass *);
367extern void execute_ipa_pass_list (struct tree_opt_pass *);
f1e2a033 368
4ee9c684 369#endif /* GCC_TREE_PASS_H */