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