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_MEMSYMS     (1 << 14)       /* display memory symbols in expr.
  72                                            Implies TDF_VOPS.  */
  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.  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_pta                (1 << 5)
 151 #define PROP_ssa                (1 << 6)
 152 #define PROP_no_crit_edges      (1 << 7)
 153 #define PROP_rtl                (1 << 8)
 154 #define PROP_alias              (1 << 9)
 155 #define PROP_gimple_lomp        (1 << 10)       /* lowered OpenMP directives */
 156
 157 #define PROP_trees \
 158   (PROP_gimple_any | PROP_gimple_lcf | PROP_gimple_leh | PROP_gimple_lomp)
 159
 160 /* To-do flags.  */
 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)
 168 #define TODO_dump_cgraph                (1 << 7)
 169 #define TODO_remove_functions           (1 << 8)
 170
 171 /* To-do flags for calls to update_ssa.  */
 172
 173 /* Update the SSA form inserting PHI nodes for newly exposed symbols
 174    and virtual names marked for updating.  When updating real names,
 175    only insert PHI nodes for a real name O_j in blocks reached by all
 176    the new and old definitions for O_j.  If the iterated dominance
 177    frontier for O_j is not pruned, we may end up inserting PHI nodes
 178    in blocks that have one or more edges with no incoming definition
 179    for O_j.  This would lead to uninitialized warnings for O_j's
 180    symbol.  */
 181 #define TODO_update_ssa                 (1 << 9)
 182
 183 /* Update the SSA form without inserting any new PHI nodes at all.
 184    This is used by passes that have either inserted all the PHI nodes
 185    themselves or passes that need only to patch use-def and def-def
 186    chains for virtuals (e.g., DCE).  */
 187 #define TODO_update_ssa_no_phi          (1 << 10)
 188
 189 /* Insert PHI nodes everywhere they are needed.  No pruning of the
 190    IDF is done.  This is used by passes that need the PHI nodes for
 191    O_j even if it means that some arguments will come from the default
 192    definition of O_j's symbol (e.g., pass_linear_transform).
 193
 194    WARNING: If you need to use this flag, chances are that your pass
 195    may be doing something wrong.  Inserting PHI nodes for an old name
 196    where not all edges carry a new replacement may lead to silent
 197    codegen errors or spurious uninitialized warnings.  */
 198 #define TODO_update_ssa_full_phi        (1 << 11)
 199
 200 /* Passes that update the SSA form on their own may want to delegate
 201    the updating of virtual names to the generic updater.  Since FUD
 202    chains are easier to maintain, this simplifies the work they need
 203    to do.  NOTE: If this flag is used, any OLD->NEW mappings for real
 204    names are explicitly destroyed and only the symbols marked for
 205    renaming are processed.  */
 206 #define TODO_update_ssa_only_virtuals   (1 << 12)
 207
 208 /* Some passes leave unused local variables that can be removed from
 209    cfun->unexpanded_var_list.  This reduces the size of dump files and
 210    the memory footprint for VAR_DECLs.  */
 211 #define TODO_remove_unused_locals       (1 << 13)
 212
 213 /* Internally used for the first in a sequence of passes.  It is set
 214    for the passes that are handed to register_dump_files.  */
 215 #define TODO_set_props                  (1 << 14)
 216
 217 /* Set by passes that may make SMT's that were previously never used
 218    in statements, used.  */
 219 #define TODO_update_smt_usage           (1 << 15)
 220
 221 #define TODO_update_ssa_any             \
 222     (TODO_update_ssa                    \
 223      | TODO_update_ssa_no_phi           \
 224      | TODO_update_ssa_full_phi         \
 225      | TODO_update_ssa_only_virtuals)
 226
 227 #define TODO_verify_all \
 228   (TODO_verify_ssa | TODO_verify_flow | TODO_verify_stmts)
 229
 230 extern void tree_lowering_passes (tree decl);
 231
 232 extern struct tree_opt_pass pass_mudflap_1;
 233 extern struct tree_opt_pass pass_mudflap_2;
 234 extern struct tree_opt_pass pass_remove_useless_stmts;
 235 extern struct tree_opt_pass pass_lower_cf;
 236 extern struct tree_opt_pass pass_lower_eh;
 237 extern struct tree_opt_pass pass_build_cfg;
 238 extern struct tree_opt_pass pass_tree_profile;
 239 extern struct tree_opt_pass pass_early_tree_profile;
 240 extern struct tree_opt_pass pass_cleanup_cfg;
 241 extern struct tree_opt_pass pass_referenced_vars;
 242 extern struct tree_opt_pass pass_sra;
 243 extern struct tree_opt_pass pass_tail_recursion;
 244 extern struct tree_opt_pass pass_tail_calls;
 245 extern struct tree_opt_pass pass_tree_loop;
 246 extern struct tree_opt_pass pass_tree_loop_init;
 247 extern struct tree_opt_pass pass_lim;
 248 extern struct tree_opt_pass pass_tree_unswitch;
 249 extern struct tree_opt_pass pass_iv_canon;
 250 extern struct tree_opt_pass pass_scev_cprop;
 251 extern struct tree_opt_pass pass_empty_loop;
 252 extern struct tree_opt_pass pass_record_bounds;
 253 extern struct tree_opt_pass pass_if_conversion;
 254 extern struct tree_opt_pass pass_vectorize;
 255 extern struct tree_opt_pass pass_complete_unroll;
 256 extern struct tree_opt_pass pass_loop_prefetch;
 257 extern struct tree_opt_pass pass_iv_optimize;
 258 extern struct tree_opt_pass pass_tree_loop_done;
 259 extern struct tree_opt_pass pass_ch;
 260 extern struct tree_opt_pass pass_ccp;
 261 extern struct tree_opt_pass pass_phi_only_cprop;
 262 extern struct tree_opt_pass pass_build_ssa;
 263 extern struct tree_opt_pass pass_del_ssa;
 264 extern struct tree_opt_pass pass_dominator;
 265 extern struct tree_opt_pass pass_dce;
 266 extern struct tree_opt_pass pass_dce_loop;
 267 extern struct tree_opt_pass pass_cd_dce;
 268 extern struct tree_opt_pass pass_merge_phi;
 269 extern struct tree_opt_pass pass_may_alias;
 270 extern struct tree_opt_pass pass_split_crit_edges;
 271 extern struct tree_opt_pass pass_pre;
 272 extern struct tree_opt_pass pass_profile;
 273 extern struct tree_opt_pass pass_lower_complex_O0;
 274 extern struct tree_opt_pass pass_lower_complex;
 275 extern struct tree_opt_pass pass_lower_vector;
 276 extern struct tree_opt_pass pass_lower_vector_ssa;
 277 extern struct tree_opt_pass pass_lower_omp;
 278 extern struct tree_opt_pass pass_expand_omp;
 279 extern struct tree_opt_pass pass_object_sizes;
 280 extern struct tree_opt_pass pass_fold_builtins;
 281 extern struct tree_opt_pass pass_stdarg;
 282 extern struct tree_opt_pass pass_early_warn_uninitialized;
 283 extern struct tree_opt_pass pass_late_warn_uninitialized;
 284 extern struct tree_opt_pass pass_cse_reciprocals;
 285 extern struct tree_opt_pass pass_cse_sincos;
 286 extern struct tree_opt_pass pass_warn_function_return;
 287 extern struct tree_opt_pass pass_warn_function_noreturn;
 288 extern struct tree_opt_pass pass_phiopt;
 289 extern struct tree_opt_pass pass_forwprop;
 290 extern struct tree_opt_pass pass_dse;
 291 extern struct tree_opt_pass pass_nrv;
 292 extern struct tree_opt_pass pass_mark_used_blocks;
 293 extern struct tree_opt_pass pass_rename_ssa_copies;
 294 extern struct tree_opt_pass pass_expand;
 295 extern struct tree_opt_pass pass_rest_of_compilation;
 296 extern struct tree_opt_pass pass_sink_code;
 297 extern struct tree_opt_pass pass_fre;
 298 extern struct tree_opt_pass pass_linear_transform;
 299 extern struct tree_opt_pass pass_copy_prop;
 300 extern struct tree_opt_pass pass_store_ccp;
 301 extern struct tree_opt_pass pass_store_copy_prop;
 302 extern struct tree_opt_pass pass_vrp;
 303 extern struct tree_opt_pass pass_create_structure_vars;
 304 extern struct tree_opt_pass pass_uncprop;
 305 extern struct tree_opt_pass pass_return_slot;
 306 extern struct tree_opt_pass pass_reassoc;
 307 extern struct tree_opt_pass pass_rebuild_cgraph_edges;
 308 extern struct tree_opt_pass pass_build_cgraph_edges;
 309 extern struct tree_opt_pass pass_reset_cc_flags;
 310
 311 /* IPA Passes */
 312 extern struct tree_opt_pass pass_ipa_cp;
 313 extern struct tree_opt_pass pass_ipa_inline;
 314 extern struct tree_opt_pass pass_ipa_early_inline;
 315 extern struct tree_opt_pass pass_ipa_reference;
 316 extern struct tree_opt_pass pass_ipa_pure_const;
 317 extern struct tree_opt_pass pass_ipa_type_escape;
 318 extern struct tree_opt_pass pass_ipa_pta;
 319 extern struct tree_opt_pass pass_early_local_passes;
 320 extern struct tree_opt_pass pass_ipa_increase_alignment;
 321 extern struct tree_opt_pass pass_ipa_function_and_variable_visibility;
 322
 323 extern struct tree_opt_pass pass_all_optimizations;
 324 extern struct tree_opt_pass pass_cleanup_cfg_post_optimizing;
 325 extern struct tree_opt_pass pass_free_cfg_annotations;
 326 extern struct tree_opt_pass pass_free_datastructures;
 327 extern struct tree_opt_pass pass_init_datastructures;
 328 extern struct tree_opt_pass pass_fixup_cfg;
 329
 330 extern struct tree_opt_pass pass_init_function;
 331 extern struct tree_opt_pass pass_jump;
 332 extern struct tree_opt_pass pass_insn_locators_initialize;
 333 extern struct tree_opt_pass pass_rtl_eh;
 334 extern struct tree_opt_pass pass_initial_value_sets;
 335 extern struct tree_opt_pass pass_unshare_all_rtl;
 336 extern struct tree_opt_pass pass_instantiate_virtual_regs;
 337 extern struct tree_opt_pass pass_rtl_fwprop;
 338 extern struct tree_opt_pass pass_rtl_fwprop_addr;
 339 extern struct tree_opt_pass pass_jump2;
 340 extern struct tree_opt_pass pass_cse;
 341 extern struct tree_opt_pass pass_gcse;
 342 extern struct tree_opt_pass pass_jump_bypass;
 343 extern struct tree_opt_pass pass_profiling;
 344 extern struct tree_opt_pass pass_rtl_ifcvt;
 345 extern struct tree_opt_pass pass_tracer;
 346
 347 extern struct tree_opt_pass pass_loop2;
 348 extern struct tree_opt_pass pass_rtl_loop_init;
 349 extern struct tree_opt_pass pass_rtl_move_loop_invariants;
 350 extern struct tree_opt_pass pass_rtl_unswitch;
 351 extern struct tree_opt_pass pass_rtl_unroll_and_peel_loops;
 352 extern struct tree_opt_pass pass_rtl_doloop;
 353 extern struct tree_opt_pass pass_rtl_loop_done;
 354
 355 extern struct tree_opt_pass pass_web;
 356 extern struct tree_opt_pass pass_cse2;
 357 extern struct tree_opt_pass pass_life;
 358 extern struct tree_opt_pass pass_combine;
 359 extern struct tree_opt_pass pass_if_after_combine;
 360 extern struct tree_opt_pass pass_partition_blocks;
 361 extern struct tree_opt_pass pass_regmove;
 362 extern struct tree_opt_pass pass_split_all_insns;
 363 extern struct tree_opt_pass pass_mode_switching;
 364 extern struct tree_opt_pass pass_see;
 365 extern struct tree_opt_pass pass_recompute_reg_usage;
 366 extern struct tree_opt_pass pass_sms;
 367 extern struct tree_opt_pass pass_sched;
 368 extern struct tree_opt_pass pass_local_alloc;
 369 extern struct tree_opt_pass pass_global_alloc;
 370 extern struct tree_opt_pass pass_postreload;
 371 extern struct tree_opt_pass pass_clean_state;
 372 extern struct tree_opt_pass pass_branch_prob;
 373 extern struct tree_opt_pass pass_value_profile_transformations;
 374 extern struct tree_opt_pass pass_remove_death_notes;
 375 extern struct tree_opt_pass pass_postreload_cse;
 376 extern struct tree_opt_pass pass_gcse2;
 377 extern struct tree_opt_pass pass_flow2;
 378 extern struct tree_opt_pass pass_stack_adjustments;
 379 extern struct tree_opt_pass pass_peephole2;
 380 extern struct tree_opt_pass pass_if_after_reload;
 381 extern struct tree_opt_pass pass_regrename;
 382 extern struct tree_opt_pass pass_reorder_blocks;
 383 extern struct tree_opt_pass pass_branch_target_load_optimize;
 384 extern struct tree_opt_pass pass_leaf_regs;
 385 extern struct tree_opt_pass pass_sched2;
 386 extern struct tree_opt_pass pass_stack_regs;
 387 extern struct tree_opt_pass pass_compute_alignments;
 388 extern struct tree_opt_pass pass_duplicate_computed_gotos;
 389 extern struct tree_opt_pass pass_variable_tracking;
 390 extern struct tree_opt_pass pass_free_cfg;
 391 extern struct tree_opt_pass pass_machine_reorg;
 392 extern struct tree_opt_pass pass_cleanup_barriers;
 393 extern struct tree_opt_pass pass_delay_slots;
 394 extern struct tree_opt_pass pass_split_for_shorten_branches;
 395 extern struct tree_opt_pass pass_split_before_regstack;
 396 extern struct tree_opt_pass pass_convert_to_eh_region_ranges;
 397 extern struct tree_opt_pass pass_shorten_branches;
 398 extern struct tree_opt_pass pass_set_nothrow_function_flags;
 399 extern struct tree_opt_pass pass_final;
 400 extern struct tree_opt_pass pass_rtl_seqabstr;
 401 extern struct tree_opt_pass pass_release_ssa_names;
 402 extern struct tree_opt_pass pass_early_inline;
 403 extern struct tree_opt_pass pass_inline_parameters;
 404 extern struct tree_opt_pass pass_apply_inline;
 405 extern struct tree_opt_pass pass_all_early_optimizations;
 406
 407 /* The root of the compilation pass tree, once constructed.  */
 408 extern struct tree_opt_pass *all_passes, *all_ipa_passes, *all_lowering_passes;
 409
 410 extern void execute_pass_list (struct tree_opt_pass *);
 411 extern void execute_ipa_pass_list (struct tree_opt_pass *);
 412
 413 #endif /* GCC_TREE_PASS_H */