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