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