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