OSDN Git Service

Daily bump.
[pf3gnuchains/gcc-fork.git] / gcc / tree-pass.h
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>
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 3, 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 COPYING3.  If not see
19 <http://www.gnu.org/licenses/>.  */
20
21
22 #ifndef GCC_TREE_PASS_H
23 #define GCC_TREE_PASS_H 1
24
25 /* In tree-dump.c */
26
27 /* Different tree dump places.  When you add new tree dump places,
28    extend the DUMP_FILES array in tree-dump.c.  */
29 enum tree_dump_index
30 {
31   TDI_none,                     /* No dump */
32   TDI_cgraph,                   /* dump function call graph.  */
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_vcg,                      /* create a VCG graph file for each
39                                    function's flowgraph.  */
40   TDI_tree_all,                 /* enable all the GENERIC/GIMPLE dumps.  */
41   TDI_rtl_all,                  /* enable all the RTL dumps.  */
42   TDI_ipa_all,                  /* enable all the IPA dumps.  */
43
44   TDI_end
45 };
46
47 /* Bit masks to control dumping. Not all values are applicable to
48    all dumps. Add new ones at the end. When you define new
49    values, extend the DUMP_OPTIONS array in tree-dump.c */
50 #define TDF_ADDRESS     (1 << 0)        /* dump node addresses */
51 #define TDF_SLIM        (1 << 1)        /* don't go wild following links */
52 #define TDF_RAW         (1 << 2)        /* don't unparse the function */
53 #define TDF_DETAILS     (1 << 3)        /* show more detailed info about
54                                            each pass */
55 #define TDF_STATS       (1 << 4)        /* dump various statistics about
56                                            each pass */
57 #define TDF_BLOCKS      (1 << 5)        /* display basic block boundaries */
58 #define TDF_VOPS        (1 << 6)        /* display virtual operands */
59 #define TDF_LINENO      (1 << 7)        /* display statement line numbers */
60 #define TDF_UID         (1 << 8)        /* display decl UIDs */
61
62 #define TDF_TREE        (1 << 9)        /* is a tree dump */
63 #define TDF_RTL         (1 << 10)       /* is a RTL dump */
64 #define TDF_IPA         (1 << 11)       /* is an IPA dump */
65 #define TDF_STMTADDR    (1 << 12)       /* Address of stmt.  */
66
67 #define TDF_GRAPH       (1 << 13)       /* a graph dump is being emitted */
68 #define TDF_MEMSYMS     (1 << 14)       /* display memory symbols in expr.
69                                            Implies TDF_VOPS.  */
70
71 #define TDF_DIAGNOSTIC  (1 << 15)       /* A dump to be put in a diagnostic
72                                            message.  */
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 (const_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.  The return value contains
103      TODOs to execute in addition to those in TODO_flags_finish.   */
104   unsigned int (*execute) (void);
105
106   /* A list of sub-passes to run, dependent on gate predicate.  */
107   struct tree_opt_pass *sub;
108
109   /* Next in the list of passes to run, independent of gate predicate.  */
110   struct tree_opt_pass *next;
111
112   /* Static pass number, used as a fragment of the dump file name.  */
113   int static_pass_number;
114
115   /* The timevar id associated with this pass.  */
116   /* ??? Ideally would be dynamically assigned.  */
117   unsigned int tv_id;
118
119   /* Sets of properties input and output from this pass.  */
120   unsigned int properties_required;
121   unsigned int properties_provided;
122   unsigned int properties_destroyed;
123
124   /* Flags indicating common sets things to do before and after.  */
125   unsigned int todo_flags_start;
126   unsigned int todo_flags_finish;
127
128   /* Letter for RTL dumps.  */
129   char letter;
130 };
131
132 /* Define a tree dump switch.  */
133 struct dump_file_info
134 {
135   const char *suffix;           /* suffix to give output file.  */
136   const char *swtch;            /* command line switch */
137   const char *glob;             /* command line glob  */
138   int flags;                    /* user flags */
139   int state;                    /* state of play */
140   int num;                      /* dump file number */
141   int letter;                   /* enabling letter for RTL dumps */
142 };
143
144 /* Pass properties.  */
145 #define PROP_gimple_any         (1 << 0)        /* entire gimple grammar */
146 #define PROP_gimple_lcf         (1 << 1)        /* lowered control flow */
147 #define PROP_gimple_leh         (1 << 2)        /* lowered eh */
148 #define PROP_cfg                (1 << 3)
149 #define PROP_referenced_vars    (1 << 4)
150 #define PROP_ssa                (1 << 5)
151 #define PROP_no_crit_edges      (1 << 6)
152 #define PROP_rtl                (1 << 7)
153 #define PROP_alias              (1 << 8)
154 #define PROP_gimple_lomp        (1 << 9)        /* 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 #define TODO_remove_functions           (1 << 8)
169 #define TODO_rebuild_frequencies        (1 << 9)
170 #define TODO_verify_rtl_sharing         (1 << 10)
171
172 /* To-do flags for calls to update_ssa.  */
173
174 /* Update the SSA form inserting PHI nodes for newly exposed symbols
175    and virtual names marked for updating.  When updating real names,
176    only insert PHI nodes for a real name O_j in blocks reached by all
177    the new and old definitions for O_j.  If the iterated dominance
178    frontier for O_j is not pruned, we may end up inserting PHI nodes
179    in blocks that have one or more edges with no incoming definition
180    for O_j.  This would lead to uninitialized warnings for O_j's
181    symbol.  */
182 #define TODO_update_ssa                 (1 << 11)
183
184 /* Update the SSA form without inserting any new PHI nodes at all.
185    This is used by passes that have either inserted all the PHI nodes
186    themselves or passes that need only to patch use-def and def-def
187    chains for virtuals (e.g., DCE).  */
188 #define TODO_update_ssa_no_phi          (1 << 12)
189
190 /* Insert PHI nodes everywhere they are needed.  No pruning of the
191    IDF is done.  This is used by passes that need the PHI nodes for
192    O_j even if it means that some arguments will come from the default
193    definition of O_j's symbol (e.g., pass_linear_transform).
194    
195    WARNING: If you need to use this flag, chances are that your pass
196    may be doing something wrong.  Inserting PHI nodes for an old name
197    where not all edges carry a new replacement may lead to silent
198    codegen errors or spurious uninitialized warnings.  */
199 #define TODO_update_ssa_full_phi        (1 << 13)
200
201 /* Passes that update the SSA form on their own may want to delegate
202    the updating of virtual names to the generic updater.  Since FUD
203    chains are easier to maintain, this simplifies the work they need
204    to do.  NOTE: If this flag is used, any OLD->NEW mappings for real
205    names are explicitly destroyed and only the symbols marked for
206    renaming are processed.  */
207 #define TODO_update_ssa_only_virtuals   (1 << 14)
208
209 /* Some passes leave unused local variables that can be removed from
210    cfun->unexpanded_var_list.  This reduces the size of dump files and
211    the memory footprint for VAR_DECLs.  */
212 #define TODO_remove_unused_locals       (1 << 15)
213
214 /* Internally used for the first in a sequence of passes.  It is set
215    for the passes that are handed to register_dump_files.  */
216 #define TODO_set_props                  (1 << 16)
217
218 /* Call df_finish at the end of the pass.  This is done after all of
219    the dumpers have been allowed to run so that they have access to
220    the instance before it is destroyed.  */
221 #define TODO_df_finish                  (1 << 17)
222
223 /* Call df_verify at the end of the pass if checking is enabled.  */
224 #define TODO_df_verify                  (1 << 18)
225
226 /* Internally used for the first instance of a pass.  */
227 #define TODO_mark_first_instance        (1 << 19)
228
229 /* Rebuild aliasing info.  */
230 #define TODO_rebuild_alias                (1 << 20)
231
232 #define TODO_update_ssa_any             \
233     (TODO_update_ssa                    \
234      | TODO_update_ssa_no_phi           \
235      | TODO_update_ssa_full_phi         \
236      | TODO_update_ssa_only_virtuals)
237
238 #define TODO_verify_all \
239   (TODO_verify_ssa | TODO_verify_flow | TODO_verify_stmts)
240
241 extern void tree_lowering_passes (tree decl);
242
243 extern struct tree_opt_pass pass_mudflap_1;
244 extern struct tree_opt_pass pass_mudflap_2;
245 extern struct tree_opt_pass pass_remove_useless_stmts;
246 extern struct tree_opt_pass pass_lower_cf;
247 extern struct tree_opt_pass pass_refactor_eh;
248 extern struct tree_opt_pass pass_lower_eh;
249 extern struct tree_opt_pass pass_build_cfg;
250 extern struct tree_opt_pass pass_tree_profile;
251 extern struct tree_opt_pass pass_early_tree_profile;
252 extern struct tree_opt_pass pass_cleanup_cfg;
253 extern struct tree_opt_pass pass_referenced_vars;
254 extern struct tree_opt_pass pass_sra;
255 extern struct tree_opt_pass pass_sra_early;
256 extern struct tree_opt_pass pass_tail_recursion;
257 extern struct tree_opt_pass pass_tail_calls;
258 extern struct tree_opt_pass pass_tree_loop;
259 extern struct tree_opt_pass pass_tree_loop_init;
260 extern struct tree_opt_pass pass_lim;
261 extern struct tree_opt_pass pass_tree_unswitch;
262 extern struct tree_opt_pass pass_predcom;
263 extern struct tree_opt_pass pass_iv_canon;
264 extern struct tree_opt_pass pass_scev_cprop;
265 extern struct tree_opt_pass pass_empty_loop;
266 extern struct tree_opt_pass pass_record_bounds;
267 extern struct tree_opt_pass pass_if_conversion;
268 extern struct tree_opt_pass pass_vectorize;
269 extern struct tree_opt_pass pass_complete_unroll;
270 extern struct tree_opt_pass pass_parallelize_loops;
271 extern struct tree_opt_pass pass_loop_prefetch;
272 extern struct tree_opt_pass pass_iv_optimize;
273 extern struct tree_opt_pass pass_tree_loop_done;
274 extern struct tree_opt_pass pass_ch;
275 extern struct tree_opt_pass pass_ccp;
276 extern struct tree_opt_pass pass_phi_only_cprop;
277 extern struct tree_opt_pass pass_build_ssa;
278 extern struct tree_opt_pass pass_del_ssa;
279 extern struct tree_opt_pass pass_build_alias;
280 extern struct tree_opt_pass pass_dominator;
281 extern struct tree_opt_pass pass_dce;
282 extern struct tree_opt_pass pass_dce_loop;
283 extern struct tree_opt_pass pass_cd_dce;
284 extern struct tree_opt_pass pass_merge_phi;
285 extern struct tree_opt_pass pass_split_crit_edges;
286 extern struct tree_opt_pass pass_pre;
287 extern struct tree_opt_pass pass_profile;
288 extern struct tree_opt_pass pass_lower_complex_O0;
289 extern struct tree_opt_pass pass_lower_complex;
290 extern struct tree_opt_pass pass_lower_vector;
291 extern struct tree_opt_pass pass_lower_vector_ssa;
292 extern struct tree_opt_pass pass_lower_omp;
293 extern struct tree_opt_pass pass_expand_omp;
294 extern struct tree_opt_pass pass_expand_omp_ssa;
295 extern struct tree_opt_pass pass_object_sizes;
296 extern struct tree_opt_pass pass_fold_builtins;
297 extern struct tree_opt_pass pass_stdarg;
298 extern struct tree_opt_pass pass_early_warn_uninitialized;
299 extern struct tree_opt_pass pass_late_warn_uninitialized;
300 extern struct tree_opt_pass pass_cse_reciprocals;
301 extern struct tree_opt_pass pass_cse_sincos;
302 extern struct tree_opt_pass pass_convert_to_rsqrt;
303 extern struct tree_opt_pass pass_warn_function_return;
304 extern struct tree_opt_pass pass_warn_function_noreturn;
305 extern struct tree_opt_pass pass_cselim;
306 extern struct tree_opt_pass pass_phiopt;
307 extern struct tree_opt_pass pass_forwprop;
308 extern struct tree_opt_pass pass_phiprop;
309 extern struct tree_opt_pass pass_tree_ifcombine;
310 extern struct tree_opt_pass pass_dse;
311 extern struct tree_opt_pass pass_simple_dse;
312 extern struct tree_opt_pass pass_nrv;
313 extern struct tree_opt_pass pass_mark_used_blocks;
314 extern struct tree_opt_pass pass_rename_ssa_copies;
315 extern struct tree_opt_pass pass_expand;
316 extern struct tree_opt_pass pass_rest_of_compilation;
317 extern struct tree_opt_pass pass_sink_code;
318 extern struct tree_opt_pass pass_fre;
319 extern struct tree_opt_pass pass_linear_transform;
320 extern struct tree_opt_pass pass_check_data_deps;
321 extern struct tree_opt_pass pass_copy_prop;
322 extern struct tree_opt_pass pass_store_ccp;
323 extern struct tree_opt_pass pass_vrp;
324 extern struct tree_opt_pass pass_create_structure_vars;
325 extern struct tree_opt_pass pass_uncprop;
326 extern struct tree_opt_pass pass_return_slot;
327 extern struct tree_opt_pass pass_reassoc;
328 extern struct tree_opt_pass pass_rebuild_cgraph_edges;
329 extern struct tree_opt_pass pass_build_cgraph_edges;
330 extern struct tree_opt_pass pass_reset_cc_flags;
331
332 /* IPA Passes */
333 extern struct tree_opt_pass pass_ipa_matrix_reorg;
334 extern struct tree_opt_pass pass_ipa_cp;
335 extern struct tree_opt_pass pass_ipa_inline;
336 extern struct tree_opt_pass pass_ipa_early_inline;
337 extern struct tree_opt_pass pass_ipa_reference;
338 extern struct tree_opt_pass pass_ipa_pure_const;
339 extern struct tree_opt_pass pass_ipa_type_escape;
340 extern struct tree_opt_pass pass_ipa_pta;
341 extern struct tree_opt_pass pass_ipa_struct_reorg;
342 extern struct tree_opt_pass pass_early_local_passes;
343 extern struct tree_opt_pass pass_ipa_increase_alignment;
344 extern struct tree_opt_pass pass_ipa_function_and_variable_visibility;
345
346 extern struct tree_opt_pass pass_all_optimizations;
347 extern struct tree_opt_pass pass_cleanup_cfg_post_optimizing;
348 extern struct tree_opt_pass pass_free_cfg_annotations;
349 extern struct tree_opt_pass pass_free_datastructures;
350 extern struct tree_opt_pass pass_init_datastructures;
351 extern struct tree_opt_pass pass_fixup_cfg;
352
353 extern struct tree_opt_pass pass_init_function;
354 extern struct tree_opt_pass pass_jump;
355 extern struct tree_opt_pass pass_rtl_eh;
356 extern struct tree_opt_pass pass_initial_value_sets;
357 extern struct tree_opt_pass pass_unshare_all_rtl;
358 extern struct tree_opt_pass pass_instantiate_virtual_regs;
359 extern struct tree_opt_pass pass_rtl_fwprop;
360 extern struct tree_opt_pass pass_rtl_fwprop_addr;
361 extern struct tree_opt_pass pass_jump2;
362 extern struct tree_opt_pass pass_lower_subreg;
363 extern struct tree_opt_pass pass_cse;
364 extern struct tree_opt_pass pass_fast_rtl_dce;
365 extern struct tree_opt_pass pass_ud_rtl_dce;
366 extern struct tree_opt_pass pass_rtl_dce;
367 extern struct tree_opt_pass pass_rtl_dse1;
368 extern struct tree_opt_pass pass_rtl_dse2;
369 extern struct tree_opt_pass pass_rtl_dse3;
370 extern struct tree_opt_pass pass_gcse;
371 extern struct tree_opt_pass pass_jump_bypass;
372 extern struct tree_opt_pass pass_profiling;
373 extern struct tree_opt_pass pass_rtl_ifcvt;
374 extern struct tree_opt_pass pass_tracer;
375
376 extern struct tree_opt_pass pass_into_cfg_layout_mode;
377 extern struct tree_opt_pass pass_outof_cfg_layout_mode;
378
379 extern struct tree_opt_pass pass_loop2;
380 extern struct tree_opt_pass pass_rtl_loop_init;
381 extern struct tree_opt_pass pass_rtl_move_loop_invariants;
382 extern struct tree_opt_pass pass_rtl_unswitch;
383 extern struct tree_opt_pass pass_rtl_unroll_and_peel_loops;
384 extern struct tree_opt_pass pass_rtl_doloop;
385 extern struct tree_opt_pass pass_rtl_loop_done;
386
387 extern struct tree_opt_pass pass_web;
388 extern struct tree_opt_pass pass_cse2;
389 extern struct tree_opt_pass pass_df_initialize_opt;
390 extern struct tree_opt_pass pass_df_initialize_no_opt;
391 extern struct tree_opt_pass pass_regclass_init;
392 extern struct tree_opt_pass pass_subregs_of_mode_init;
393 extern struct tree_opt_pass pass_subregs_of_mode_finish;
394 extern struct tree_opt_pass pass_inc_dec;
395 extern struct tree_opt_pass pass_stack_ptr_mod;
396 extern struct tree_opt_pass pass_initialize_regs;
397 extern struct tree_opt_pass pass_combine;
398 extern struct tree_opt_pass pass_if_after_combine;
399 extern struct tree_opt_pass pass_partition_blocks;
400 extern struct tree_opt_pass pass_match_asm_constraints;
401 extern struct tree_opt_pass pass_regmove;
402 extern struct tree_opt_pass pass_split_all_insns;
403 extern struct tree_opt_pass pass_lower_subreg2;
404 extern struct tree_opt_pass pass_mode_switching;
405 extern struct tree_opt_pass pass_see;
406 extern struct tree_opt_pass pass_sms;
407 extern struct tree_opt_pass pass_sched;
408 extern struct tree_opt_pass pass_local_alloc;
409 extern struct tree_opt_pass pass_global_alloc;
410 extern struct tree_opt_pass pass_postreload;
411 extern struct tree_opt_pass pass_clean_state;
412 extern struct tree_opt_pass pass_branch_prob;
413 extern struct tree_opt_pass pass_value_profile_transformations;
414 extern struct tree_opt_pass pass_postreload_cse;
415 extern struct tree_opt_pass pass_gcse2;
416 extern struct tree_opt_pass pass_split_after_reload;
417 extern struct tree_opt_pass pass_branch_target_load_optimize1;
418 extern struct tree_opt_pass pass_thread_prologue_and_epilogue;
419 extern struct tree_opt_pass pass_stack_adjustments;
420 extern struct tree_opt_pass pass_peephole2;
421 extern struct tree_opt_pass pass_if_after_reload;
422 extern struct tree_opt_pass pass_regrename;
423 extern struct tree_opt_pass pass_cprop_hardreg;
424 extern struct tree_opt_pass pass_reorder_blocks;
425 extern struct tree_opt_pass pass_branch_target_load_optimize2;
426 extern struct tree_opt_pass pass_leaf_regs;
427 extern struct tree_opt_pass pass_split_before_sched2;
428 extern struct tree_opt_pass pass_sched2;
429 extern struct tree_opt_pass pass_stack_regs;
430 extern struct tree_opt_pass pass_stack_regs_run;
431 extern struct tree_opt_pass pass_df_finish;
432 extern struct tree_opt_pass pass_compute_alignments;
433 extern struct tree_opt_pass pass_duplicate_computed_gotos;
434 extern struct tree_opt_pass pass_variable_tracking;
435 extern struct tree_opt_pass pass_free_cfg;
436 extern struct tree_opt_pass pass_machine_reorg;
437 extern struct tree_opt_pass pass_cleanup_barriers;
438 extern struct tree_opt_pass pass_delay_slots;
439 extern struct tree_opt_pass pass_split_for_shorten_branches;
440 extern struct tree_opt_pass pass_split_before_regstack;
441 extern struct tree_opt_pass pass_convert_to_eh_region_ranges;
442 extern struct tree_opt_pass pass_shorten_branches;
443 extern struct tree_opt_pass pass_set_nothrow_function_flags;
444 extern struct tree_opt_pass pass_final;
445 extern struct tree_opt_pass pass_rtl_seqabstr;
446 extern struct tree_opt_pass pass_release_ssa_names;
447 extern struct tree_opt_pass pass_early_inline;
448 extern struct tree_opt_pass pass_inline_parameters;
449 extern struct tree_opt_pass pass_apply_inline;
450 extern struct tree_opt_pass pass_all_early_optimizations;
451 extern struct tree_opt_pass pass_update_address_taken;
452
453 /* The root of the compilation pass tree, once constructed.  */
454 extern struct tree_opt_pass *all_passes, *all_ipa_passes, *all_lowering_passes;
455
456 extern void execute_pass_list (struct tree_opt_pass *);
457 extern void execute_ipa_pass_list (struct tree_opt_pass *);
458 extern void print_current_pass (FILE *);
459 extern void debug_pass (void);
460
461 /* Set to true if the pass is called the first time during compilation of the
462    current function.  Note that using this information in the optimization
463    passes is considered not to be clean, and it should be avoided if possible.
464    This flag is currently used to prevent loops from being peeled repeatedly
465    in jump threading; it will be removed once we preserve loop structures
466    throughout the compilation -- we will be able to mark the affected loops
467    directly in jump threading, and avoid peeling them next time.  */
468 extern bool first_pass_instance;
469
470 #endif /* GCC_TREE_PASS_H */