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_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 extern char *get_dump_file_name (enum tree_dump_index);
  71 extern int dump_enabled_p (enum tree_dump_index);
  72 extern int dump_initialized_p (enum tree_dump_index);
  73 extern FILE *dump_begin (enum tree_dump_index, int *);
  74 extern void dump_end (enum tree_dump_index, FILE *);
  75 extern void dump_node (tree, int, FILE *);
  76 extern int dump_switch_p (const char *);
  77 extern const char *dump_flag_name (enum tree_dump_index);
  78
  79 /* Global variables used to communicate with passes.  */
  80 extern FILE *dump_file;
  81 extern int dump_flags;
  82 extern const char *dump_file_name;
  83
  84 /* Return the dump_file_info for the given phase.  */
  85 extern struct dump_file_info *get_dump_file_info (enum tree_dump_index);
  86
  87 /* Describe one pass.  */
  88 struct 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.  */
 108   int static_pass_number;
 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;
 122
 123   /* Letter for RTL dumps.  */
 124   char letter;
 125 };
 126
 127 /* Define a tree dump switch.  */
 128 struct dump_file_info
 129 {
 130   const char *suffix;           /* suffix to give output file.  */
 131   const char *swtch;            /* command line switch */
 132   const char *glob;             /* command line glob  */
 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 */
 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)
 148 #define PROP_rtl                (1 << 8)
 149 #define PROP_alias              (1 << 9)
 150
 151 #define PROP_trees \
 152   (PROP_gimple_any | PROP_gimple_lcf | PROP_gimple_leh)
 153
 154 /* To-do flags.  */
 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)
 162 #define TODO_dump_cgraph                (1 << 7)
 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
 182 /* Insert PHI nodes everywhere they are needed.  No pruning of the
 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)
 206
 207 #define TODO_verify_all \
 208   (TODO_verify_ssa | TODO_verify_flow | TODO_verify_stmts)
 209
 210 extern void tree_lowering_passes (tree decl);
 211
 212 extern struct tree_opt_pass pass_mudflap_1;
 213 extern struct tree_opt_pass pass_mudflap_2;
 214 extern struct tree_opt_pass pass_remove_useless_stmts;
 215 extern struct tree_opt_pass pass_lower_cf;
 216 extern struct tree_opt_pass pass_lower_eh;
 217 extern struct tree_opt_pass pass_build_cfg;
 218 extern struct tree_opt_pass pass_tree_profile;
 219 extern struct tree_opt_pass pass_early_tree_profile;
 220 extern struct tree_opt_pass pass_cleanup_cfg;
 221 extern struct tree_opt_pass pass_referenced_vars;
 222 extern struct tree_opt_pass pass_sra;
 223 extern struct tree_opt_pass pass_tail_recursion;
 224 extern struct tree_opt_pass pass_tail_calls;
 225 extern struct tree_opt_pass pass_tree_loop;
 226 extern struct tree_opt_pass pass_tree_loop_init;
 227 extern struct tree_opt_pass pass_lim;
 228 extern struct tree_opt_pass pass_tree_unswitch;
 229 extern struct tree_opt_pass pass_iv_canon;
 230 extern struct tree_opt_pass pass_scev_cprop;
 231 extern struct tree_opt_pass pass_empty_loop;
 232 extern struct tree_opt_pass pass_record_bounds;
 233 extern struct tree_opt_pass pass_if_conversion;
 234 extern struct tree_opt_pass pass_vectorize;
 235 extern struct tree_opt_pass pass_complete_unroll;
 236 extern struct tree_opt_pass pass_iv_optimize;
 237 extern struct tree_opt_pass pass_tree_loop_done;
 238 extern struct tree_opt_pass pass_ch;
 239 extern struct tree_opt_pass pass_ccp;
 240 extern struct tree_opt_pass pass_build_ssa;
 241 extern struct tree_opt_pass pass_del_ssa;
 242 extern struct tree_opt_pass pass_dominator;
 243 extern struct tree_opt_pass pass_dce;
 244 extern struct tree_opt_pass pass_cd_dce;
 245 extern struct tree_opt_pass pass_merge_phi;
 246 extern struct tree_opt_pass pass_may_alias;
 247 extern struct tree_opt_pass pass_split_crit_edges;
 248 extern struct tree_opt_pass pass_pre;
 249 extern struct tree_opt_pass pass_profile;
 250 extern struct tree_opt_pass pass_lower_complex_O0;
 251 extern struct tree_opt_pass pass_lower_complex;
 252 extern struct tree_opt_pass pass_lower_vector;
 253 extern struct tree_opt_pass pass_lower_vector_ssa;
 254 extern struct tree_opt_pass pass_object_sizes;
 255 extern struct tree_opt_pass pass_fold_builtins;
 256 extern struct tree_opt_pass pass_stdarg;
 257 extern struct tree_opt_pass pass_early_warn_uninitialized;
 258 extern struct tree_opt_pass pass_late_warn_uninitialized;
 259 extern struct tree_opt_pass pass_cse_reciprocals;
 260 extern struct tree_opt_pass pass_warn_function_return;
 261 extern struct tree_opt_pass pass_warn_function_noreturn;
 262 extern struct tree_opt_pass pass_phiopt;
 263 extern struct tree_opt_pass pass_forwprop;
 264 extern struct tree_opt_pass pass_redundant_phi;
 265 extern struct tree_opt_pass pass_dse;
 266 extern struct tree_opt_pass pass_nrv;
 267 extern struct tree_opt_pass pass_remove_useless_vars;
 268 extern struct tree_opt_pass pass_mark_used_blocks;
 269 extern struct tree_opt_pass pass_rename_ssa_copies;
 270 extern struct tree_opt_pass pass_expand;
 271 extern struct tree_opt_pass pass_rest_of_compilation;
 272 extern struct tree_opt_pass pass_sink_code;
 273 extern struct tree_opt_pass pass_fre;
 274 extern struct tree_opt_pass pass_linear_transform;
 275 extern struct tree_opt_pass pass_copy_prop;
 276 extern struct tree_opt_pass pass_store_ccp;
 277 extern struct tree_opt_pass pass_store_copy_prop;
 278 extern struct tree_opt_pass pass_vrp;
 279 extern struct tree_opt_pass pass_create_structure_vars;
 280 extern struct tree_opt_pass pass_uncprop;
 281 extern struct tree_opt_pass pass_return_slot;
 282 extern struct tree_opt_pass pass_reassoc;
 283 extern struct tree_opt_pass pass_rebuild_cgraph_edges;
 284 extern struct tree_opt_pass pass_eliminate_useless_stores;
 285
 286 /* IPA Passes */
 287 extern struct tree_opt_pass pass_ipa_cp;
 288 extern struct tree_opt_pass pass_ipa_inline;
 289 extern struct tree_opt_pass pass_early_ipa_inline;
 290 extern struct tree_opt_pass pass_ipa_reference;
 291 extern struct tree_opt_pass pass_ipa_pure_const;
 292 extern struct tree_opt_pass pass_ipa_type_escape;
 293 extern struct tree_opt_pass pass_early_local_passes;
 294
 295 extern struct tree_opt_pass pass_all_optimizations;
 296 extern struct tree_opt_pass pass_cleanup_cfg_post_optimizing;
 297 extern struct tree_opt_pass pass_free_cfg_annotations;
 298 extern struct tree_opt_pass pass_free_datastructures;
 299 extern struct tree_opt_pass pass_init_datastructures;
 300 extern struct tree_opt_pass pass_fixup_cfg;
 301
 302 extern struct tree_opt_pass pass_remove_unnecessary_notes;
 303 extern struct tree_opt_pass pass_init_function;
 304 extern struct tree_opt_pass pass_jump;
 305 extern struct tree_opt_pass pass_insn_locators_initialize;
 306 extern struct tree_opt_pass pass_rtl_eh;
 307 extern struct tree_opt_pass pass_initial_value_sets;
 308 extern struct tree_opt_pass pass_unshare_all_rtl;
 309 extern struct tree_opt_pass pass_instantiate_virtual_regs;
 310 extern struct tree_opt_pass pass_jump2;
 311 extern struct tree_opt_pass pass_cse;
 312 extern struct tree_opt_pass pass_gcse;
 313 extern struct tree_opt_pass pass_loop_optimize;
 314 extern struct tree_opt_pass pass_jump_bypass;
 315 extern struct tree_opt_pass pass_cfg;
 316 extern struct tree_opt_pass pass_profiling;
 317 extern struct tree_opt_pass pass_rtl_ifcvt;
 318 extern struct tree_opt_pass pass_tracer;
 319
 320 extern struct tree_opt_pass pass_loop2;
 321 extern struct tree_opt_pass pass_rtl_loop_init;
 322 extern struct tree_opt_pass pass_rtl_move_loop_invariants;
 323 extern struct tree_opt_pass pass_rtl_unswitch;
 324 extern struct tree_opt_pass pass_rtl_unroll_and_peel_loops;
 325 extern struct tree_opt_pass pass_rtl_doloop;
 326 extern struct tree_opt_pass pass_rtl_loop_done;
 327
 328 extern struct tree_opt_pass pass_web;
 329 extern struct tree_opt_pass pass_cse2;
 330 extern struct tree_opt_pass pass_life;
 331 extern struct tree_opt_pass pass_combine;
 332 extern struct tree_opt_pass pass_if_after_combine;
 333 extern struct tree_opt_pass pass_partition_blocks;
 334 extern struct tree_opt_pass pass_partition_blocks;
 335 extern struct tree_opt_pass pass_regmove;
 336 extern struct tree_opt_pass pass_split_all_insns;
 337 extern struct tree_opt_pass pass_mode_switching;
 338 extern struct tree_opt_pass pass_recompute_reg_usage;
 339 extern struct tree_opt_pass pass_sms;
 340 extern struct tree_opt_pass pass_sched;
 341 extern struct tree_opt_pass pass_local_alloc;
 342 extern struct tree_opt_pass pass_global_alloc;
 343 extern struct tree_opt_pass pass_postreload;
 344 extern struct tree_opt_pass pass_clean_state;
 345 extern struct tree_opt_pass pass_branch_prob;
 346 extern struct tree_opt_pass pass_value_profile_transformations;
 347 extern struct tree_opt_pass pass_remove_death_notes;
 348 extern struct tree_opt_pass pass_postreload_cse;
 349 extern struct tree_opt_pass pass_gcse2;
 350 extern struct tree_opt_pass pass_flow2;
 351 extern struct tree_opt_pass pass_stack_adjustments;
 352 extern struct tree_opt_pass pass_peephole2;
 353 extern struct tree_opt_pass pass_if_after_reload;
 354 extern struct tree_opt_pass pass_regrename;
 355 extern struct tree_opt_pass pass_reorder_blocks;
 356 extern struct tree_opt_pass pass_branch_target_load_optimize;
 357 extern struct tree_opt_pass pass_leaf_regs;
 358 extern struct tree_opt_pass pass_sched2;
 359 extern struct tree_opt_pass pass_stack_regs;
 360 extern struct tree_opt_pass pass_compute_alignments;
 361 extern struct tree_opt_pass pass_duplicate_computed_gotos;
 362 extern struct tree_opt_pass pass_variable_tracking;
 363 extern struct tree_opt_pass pass_free_cfg;
 364 extern struct tree_opt_pass pass_machine_reorg;
 365 extern struct tree_opt_pass pass_purge_lineno_notes;
 366 extern struct tree_opt_pass pass_cleanup_barriers;
 367 extern struct tree_opt_pass pass_delay_slots;
 368 extern struct tree_opt_pass pass_split_for_shorten_branches;
 369 extern struct tree_opt_pass pass_split_before_regstack;
 370 extern struct tree_opt_pass pass_convert_to_eh_region_ranges;
 371 extern struct tree_opt_pass pass_shorten_branches;
 372 extern struct tree_opt_pass pass_set_nothrow_function_flags;
 373 extern struct tree_opt_pass pass_final;
 374
 375 /* The root of the compilation pass tree, once constructed.  */
 376 extern struct tree_opt_pass *all_passes, *all_ipa_passes, *all_lowering_passes;
 377
 378 extern void execute_pass_list (struct tree_opt_pass *);
 379 extern void execute_ipa_pass_list (struct tree_opt_pass *);
 380
 381 #endif /* GCC_TREE_PASS_H */