OSDN Git Service

2006-02-08 Paolo Bonzini <bonzini@gnu.org>
[pf3gnuchains/gcc-fork.git] / gcc / tree-pass.h
1 /* Definitions for describing one tree-ssa optimization pass.
2    Copyright (C) 2004, 2005 Free Software Foundation, Inc.
3    Contributed by Richard Henderson <rth@redhat.com>
4
5 This file is part of GCC.
6
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)
10 any later version.
11
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.
16
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.  */
21
22
23 #ifndef GCC_TREE_PASS_H
24 #define GCC_TREE_PASS_H 1
25
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.  */
30 enum tree_dump_index
31 {
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
40                                    within it.  */
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.  */
46
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
70 #define TDF_GRAPH       (1 << 13)       /* a graph dump is being emitted */
71 #define TDF_CHAIN       (1 << 14)       /* Follow TREE_CHAIN when
72                                            dumping *_DECLs.  */
73
74 extern char *get_dump_file_name (enum tree_dump_index);
75 extern int dump_enabled_p (enum tree_dump_index);
76 extern int dump_initialized_p (enum tree_dump_index);
77 extern FILE *dump_begin (enum tree_dump_index, int *);
78 extern void dump_end (enum tree_dump_index, FILE *);
79 extern void dump_node (tree, int, FILE *);
80 extern int dump_switch_p (const char *);
81 extern const char *dump_flag_name (enum tree_dump_index);
82
83 /* Global variables used to communicate with passes.  */
84 extern FILE *dump_file;
85 extern int dump_flags;
86 extern const char *dump_file_name;
87
88 /* Return the dump_file_info for the given phase.  */
89 extern struct dump_file_info *get_dump_file_info (enum tree_dump_index);
90
91 /* Describe one pass.  */
92 struct tree_opt_pass
93 {
94   /* Terse name of the pass used as a fragment of the dump file name.  */
95   const char *name;
96
97   /* If non-null, this pass and all sub-passes are executed only if
98      the function returns true.  */
99   bool (*gate) (void);
100
101   /* This is the code to run.  If null, then there should be sub-passes
102      otherwise this pass does nothing.  */
103   void (*execute) (void);
104
105   /* A list of sub-passes to run, dependent on gate predicate.  */
106   struct tree_opt_pass *sub;
107
108   /* Next in the list of passes to run, independent of gate predicate.  */
109   struct tree_opt_pass *next;
110
111   /* Static pass number, used as a fragment of the dump file name.  */
112   int static_pass_number;
113
114   /* The timevar id associated with this pass.  */
115   /* ??? Ideally would be dynamically assigned.  */
116   unsigned int tv_id;
117
118   /* Sets of properties input and output from this pass.  */
119   unsigned int properties_required;
120   unsigned int properties_provided;
121   unsigned int properties_destroyed;
122
123   /* Flags indicating common sets things to do before and after.  */
124   unsigned int todo_flags_start;
125   unsigned int todo_flags_finish;
126
127   /* Letter for RTL dumps.  */
128   char letter;
129 };
130
131 /* Define a tree dump switch.  */
132 struct dump_file_info
133 {
134   const char *suffix;           /* suffix to give output file.  */
135   const char *swtch;            /* command line switch */
136   const char *glob;             /* command line glob  */
137   int flags;                    /* user flags */
138   int state;                    /* state of play */
139   int num;                      /* dump file number */
140   int letter;                   /* enabling letter for RTL dumps */
141 };
142
143 /* Pass properties.  */
144 #define PROP_gimple_any         (1 << 0)        /* entire gimple grammar */
145 #define PROP_gimple_lcf         (1 << 1)        /* lowered control flow */
146 #define PROP_gimple_leh         (1 << 2)        /* lowered eh */
147 #define PROP_cfg                (1 << 3)
148 #define PROP_referenced_vars    (1 << 4)
149 #define PROP_pta                (1 << 5)
150 #define PROP_ssa                (1 << 6)
151 #define PROP_no_crit_edges      (1 << 7)
152 #define PROP_rtl                (1 << 8)
153 #define PROP_alias              (1 << 9)
154 #define PROP_gimple_lomp        (1 << 10)       /* lowered OpenMP directives */
155
156 #define PROP_trees \
157   (PROP_gimple_any | PROP_gimple_lcf | PROP_gimple_leh | PROP_gimple_lomp)
158
159 /* To-do flags.  */
160 #define TODO_dump_func                  (1 << 0)
161 #define TODO_ggc_collect                (1 << 1)
162 #define TODO_verify_ssa                 (1 << 2) 
163 #define TODO_verify_flow                (1 << 3)
164 #define TODO_verify_stmts               (1 << 4)
165 #define TODO_cleanup_cfg                (1 << 5)
166 #define TODO_verify_loops               (1 << 6)
167 #define TODO_dump_cgraph                (1 << 7)
168
169 /* To-do flags for calls to update_ssa.  */
170
171 /* Update the SSA form inserting PHI nodes for newly exposed symbols
172    and virtual names marked for updating.  When updating real names,
173    only insert PHI nodes for a real name O_j in blocks reached by all
174    the new and old definitions for O_j.  If the iterated dominance
175    frontier for O_j is not pruned, we may end up inserting PHI nodes
176    in blocks that have one or more edges with no incoming definition
177    for O_j.  This would lead to uninitialized warnings for O_j's
178    symbol.  */
179 #define TODO_update_ssa                 (1 << 7)
180
181 /* Update the SSA form without inserting any new PHI nodes at all.
182    This is used by passes that have either inserted all the PHI nodes
183    themselves or passes that need only to patch use-def and def-def
184    chains for virtuals (e.g., DCE).  */
185 #define TODO_update_ssa_no_phi          (1 << 8)
186
187 /* Insert PHI nodes everywhere they are needed.  No pruning of the
188    IDF is done.  This is used by passes that need the PHI nodes for
189    O_j even if it means that some arguments will come from the default
190    definition of O_j's symbol (e.g., pass_linear_transform).
191    
192    WARNING: If you need to use this flag, chances are that your pass
193    may be doing something wrong.  Inserting PHI nodes for an old name
194    where not all edges carry a new replacement may lead to silent
195    codegen errors or spurious uninitialized warnings.  */
196 #define TODO_update_ssa_full_phi        (1 << 9)
197
198 /* Passes that update the SSA form on their own may want to delegate
199    the updating of virtual names to the generic updater.  Since FUD
200    chains are easier to maintain, this simplifies the work they need
201    to do.  NOTE: If this flag is used, any OLD->NEW mappings for real
202    names are explicitly destroyed and only the symbols marked for
203    renaming are processed.  */
204 #define TODO_update_ssa_only_virtuals   (1 << 10)
205
206 /* Some passes leave unused local variables that can be removed from
207    cfun->unexpanded_var_list.  This reduces the size of dump files and
208    the memory footprint for VAR_DECLs.  */
209 #define TODO_remove_unused_locals       (1 << 11)
210
211 /* Internally used for the first in a sequence of passes.  It is set
212    for the passes that are handed to register_dump_files.  */
213 #define TODO_set_props                  (1 << 12)
214
215 #define TODO_update_ssa_any             \
216     (TODO_update_ssa                    \
217      | TODO_update_ssa_no_phi           \
218      | TODO_update_ssa_full_phi         \
219      | TODO_update_ssa_only_virtuals)
220
221 #define TODO_verify_all \
222   (TODO_verify_ssa | TODO_verify_flow | TODO_verify_stmts)
223
224 extern void tree_lowering_passes (tree decl);
225
226 extern struct tree_opt_pass pass_mudflap_1;
227 extern struct tree_opt_pass pass_mudflap_2;
228 extern struct tree_opt_pass pass_remove_useless_stmts;
229 extern struct tree_opt_pass pass_lower_cf;
230 extern struct tree_opt_pass pass_lower_eh;
231 extern struct tree_opt_pass pass_build_cfg;
232 extern struct tree_opt_pass pass_tree_profile;
233 extern struct tree_opt_pass pass_early_tree_profile;
234 extern struct tree_opt_pass pass_cleanup_cfg;
235 extern struct tree_opt_pass pass_referenced_vars;
236 extern struct tree_opt_pass pass_sra;
237 extern struct tree_opt_pass pass_tail_recursion;
238 extern struct tree_opt_pass pass_tail_calls;
239 extern struct tree_opt_pass pass_tree_loop;
240 extern struct tree_opt_pass pass_tree_loop_init;
241 extern struct tree_opt_pass pass_lim;
242 extern struct tree_opt_pass pass_tree_unswitch;
243 extern struct tree_opt_pass pass_iv_canon;
244 extern struct tree_opt_pass pass_scev_cprop;
245 extern struct tree_opt_pass pass_empty_loop;
246 extern struct tree_opt_pass pass_record_bounds;
247 extern struct tree_opt_pass pass_if_conversion;
248 extern struct tree_opt_pass pass_vectorize;
249 extern struct tree_opt_pass pass_complete_unroll;
250 extern struct tree_opt_pass pass_iv_optimize;
251 extern struct tree_opt_pass pass_tree_loop_done;
252 extern struct tree_opt_pass pass_ch;
253 extern struct tree_opt_pass pass_ccp;
254 extern struct tree_opt_pass pass_build_ssa;
255 extern struct tree_opt_pass pass_del_ssa;
256 extern struct tree_opt_pass pass_dominator;
257 extern struct tree_opt_pass pass_dce;
258 extern struct tree_opt_pass pass_dce_loop;
259 extern struct tree_opt_pass pass_cd_dce;
260 extern struct tree_opt_pass pass_merge_phi;
261 extern struct tree_opt_pass pass_may_alias;
262 extern struct tree_opt_pass pass_split_crit_edges;
263 extern struct tree_opt_pass pass_pre;
264 extern struct tree_opt_pass pass_profile;
265 extern struct tree_opt_pass pass_lower_complex_O0;
266 extern struct tree_opt_pass pass_lower_complex;
267 extern struct tree_opt_pass pass_lower_vector;
268 extern struct tree_opt_pass pass_lower_vector_ssa;
269 extern struct tree_opt_pass pass_lower_omp;
270 extern struct tree_opt_pass pass_expand_omp;
271 extern struct tree_opt_pass pass_object_sizes;
272 extern struct tree_opt_pass pass_fold_builtins;
273 extern struct tree_opt_pass pass_stdarg;
274 extern struct tree_opt_pass pass_early_warn_uninitialized;
275 extern struct tree_opt_pass pass_late_warn_uninitialized;
276 extern struct tree_opt_pass pass_cse_reciprocals;
277 extern struct tree_opt_pass pass_warn_function_return;
278 extern struct tree_opt_pass pass_warn_function_noreturn;
279 extern struct tree_opt_pass pass_phiopt;
280 extern struct tree_opt_pass pass_forwprop;
281 extern struct tree_opt_pass pass_redundant_phi;
282 extern struct tree_opt_pass pass_dse;
283 extern struct tree_opt_pass pass_nrv;
284 extern struct tree_opt_pass pass_mark_used_blocks;
285 extern struct tree_opt_pass pass_rename_ssa_copies;
286 extern struct tree_opt_pass pass_expand;
287 extern struct tree_opt_pass pass_rest_of_compilation;
288 extern struct tree_opt_pass pass_sink_code;
289 extern struct tree_opt_pass pass_fre;
290 extern struct tree_opt_pass pass_linear_transform;
291 extern struct tree_opt_pass pass_copy_prop;
292 extern struct tree_opt_pass pass_phi_only_copy_prop;
293 extern struct tree_opt_pass pass_store_ccp;
294 extern struct tree_opt_pass pass_store_copy_prop;
295 extern struct tree_opt_pass pass_vrp;
296 extern struct tree_opt_pass pass_create_structure_vars;
297 extern struct tree_opt_pass pass_uncprop;
298 extern struct tree_opt_pass pass_return_slot;
299 extern struct tree_opt_pass pass_reassoc;
300 extern struct tree_opt_pass pass_rebuild_cgraph_edges;
301
302 /* IPA Passes */
303 extern struct tree_opt_pass pass_ipa_cp;
304 extern struct tree_opt_pass pass_ipa_inline;
305 extern struct tree_opt_pass pass_early_ipa_inline;
306 extern struct tree_opt_pass pass_ipa_reference;
307 extern struct tree_opt_pass pass_ipa_pure_const;
308 extern struct tree_opt_pass pass_ipa_type_escape;
309 extern struct tree_opt_pass pass_ipa_pta;
310 extern struct tree_opt_pass pass_early_local_passes;
311
312 extern struct tree_opt_pass pass_all_optimizations;
313 extern struct tree_opt_pass pass_cleanup_cfg_post_optimizing;
314 extern struct tree_opt_pass pass_free_cfg_annotations;
315 extern struct tree_opt_pass pass_free_datastructures;
316 extern struct tree_opt_pass pass_init_datastructures;
317 extern struct tree_opt_pass pass_fixup_cfg;
318
319 extern struct tree_opt_pass pass_remove_unnecessary_notes;
320 extern struct tree_opt_pass pass_init_function;
321 extern struct tree_opt_pass pass_jump;
322 extern struct tree_opt_pass pass_insn_locators_initialize;
323 extern struct tree_opt_pass pass_rtl_eh;
324 extern struct tree_opt_pass pass_initial_value_sets;
325 extern struct tree_opt_pass pass_unshare_all_rtl;
326 extern struct tree_opt_pass pass_instantiate_virtual_regs;
327 extern struct tree_opt_pass pass_jump2;
328 extern struct tree_opt_pass pass_cse;
329 extern struct tree_opt_pass pass_gcse;
330 extern struct tree_opt_pass pass_loop_optimize;
331 extern struct tree_opt_pass pass_jump_bypass;
332 extern struct tree_opt_pass pass_cfg;
333 extern struct tree_opt_pass pass_profiling;
334 extern struct tree_opt_pass pass_rtl_ifcvt;
335 extern struct tree_opt_pass pass_tracer;
336
337 extern struct tree_opt_pass pass_loop2;
338 extern struct tree_opt_pass pass_rtl_loop_init;
339 extern struct tree_opt_pass pass_rtl_move_loop_invariants;
340 extern struct tree_opt_pass pass_rtl_unswitch;
341 extern struct tree_opt_pass pass_rtl_unroll_and_peel_loops;
342 extern struct tree_opt_pass pass_rtl_doloop;
343 extern struct tree_opt_pass pass_rtl_loop_done;
344
345 extern struct tree_opt_pass pass_web;
346 extern struct tree_opt_pass pass_cse2;
347 extern struct tree_opt_pass pass_life;
348 extern struct tree_opt_pass pass_combine;
349 extern struct tree_opt_pass pass_if_after_combine;
350 extern struct tree_opt_pass pass_partition_blocks;
351 extern struct tree_opt_pass pass_partition_blocks;
352 extern struct tree_opt_pass pass_regmove;
353 extern struct tree_opt_pass pass_split_all_insns;
354 extern struct tree_opt_pass pass_mode_switching;
355 extern struct tree_opt_pass pass_recompute_reg_usage;
356 extern struct tree_opt_pass pass_sms;
357 extern struct tree_opt_pass pass_sched;
358 extern struct tree_opt_pass pass_local_alloc;
359 extern struct tree_opt_pass pass_global_alloc;
360 extern struct tree_opt_pass pass_postreload;
361 extern struct tree_opt_pass pass_clean_state;
362 extern struct tree_opt_pass pass_branch_prob;
363 extern struct tree_opt_pass pass_value_profile_transformations;
364 extern struct tree_opt_pass pass_remove_death_notes;
365 extern struct tree_opt_pass pass_postreload_cse;
366 extern struct tree_opt_pass pass_gcse2;
367 extern struct tree_opt_pass pass_flow2;
368 extern struct tree_opt_pass pass_stack_adjustments;
369 extern struct tree_opt_pass pass_peephole2;
370 extern struct tree_opt_pass pass_if_after_reload;
371 extern struct tree_opt_pass pass_regrename;
372 extern struct tree_opt_pass pass_reorder_blocks;
373 extern struct tree_opt_pass pass_branch_target_load_optimize;
374 extern struct tree_opt_pass pass_leaf_regs;
375 extern struct tree_opt_pass pass_sched2;
376 extern struct tree_opt_pass pass_stack_regs;
377 extern struct tree_opt_pass pass_compute_alignments;
378 extern struct tree_opt_pass pass_duplicate_computed_gotos;
379 extern struct tree_opt_pass pass_variable_tracking;
380 extern struct tree_opt_pass pass_free_cfg;
381 extern struct tree_opt_pass pass_machine_reorg;
382 extern struct tree_opt_pass pass_purge_lineno_notes;
383 extern struct tree_opt_pass pass_cleanup_barriers;
384 extern struct tree_opt_pass pass_delay_slots;
385 extern struct tree_opt_pass pass_split_for_shorten_branches;
386 extern struct tree_opt_pass pass_split_before_regstack;
387 extern struct tree_opt_pass pass_convert_to_eh_region_ranges;
388 extern struct tree_opt_pass pass_shorten_branches;
389 extern struct tree_opt_pass pass_set_nothrow_function_flags;
390 extern struct tree_opt_pass pass_final;
391 extern struct tree_opt_pass pass_rtl_seqabstr;
392
393 /* The root of the compilation pass tree, once constructed.  */
394 extern struct tree_opt_pass *all_passes, *all_ipa_passes, *all_lowering_passes;
395
396 extern void execute_pass_list (struct tree_opt_pass *);
397 extern void execute_ipa_pass_list (struct tree_opt_pass *);
398
399 #endif /* GCC_TREE_PASS_H */