gcc/tree-optimize.c

   1 /* Top-level control of tree optimizations.
   2    Copyright 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
   3    Contributed by Diego Novillo <dnovillo@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, 59 Temple Place - Suite 330,
  20 Boston, MA 02111-1307, USA.  */
  21
  22 #include "config.h"
  23 #include "system.h"
  24 #include "coretypes.h"
  25 #include "tm.h"
  26 #include "tree.h"
  27 #include "rtl.h"
  28 #include "tm_p.h"
  29 #include "hard-reg-set.h"
  30 #include "basic-block.h"
  31 #include "output.h"
  32 #include "expr.h"
  33 #include "diagnostic.h"
  34 #include "basic-block.h"
  35 #include "flags.h"
  36 #include "tree-flow.h"
  37 #include "tree-dump.h"
  38 #include "timevar.h"
  39 #include "function.h"
  40 #include "langhooks.h"
  41 #include "toplev.h"
  42 #include "flags.h"
  43 #include "cgraph.h"
  44 #include "tree-inline.h"
  45 #include "tree-mudflap.h"
  46 #include "tree-pass.h"
  47 #include "tree-alias-common.h"
  48 #include "ggc.h"
  49 #include "cgraph.h"
  50
  51
  52 /* Global variables used to communicate with passes.  */
  53 int dump_flags;
  54 bitmap vars_to_rename;
  55 bool in_gimple_form;
  56
  57 /* The root of the compilation pass tree, once constructed.  */
  58 static struct tree_opt_pass *all_passes;
  59
  60 /* Pass: dump the gimplified, inlined, functions.  */
  61
  62 static struct tree_opt_pass pass_gimple =
  63 {
  64   "gimple",                             /* name */
  65   NULL,                                 /* gate */
  66   NULL,                                 /* execute */
  67   NULL,                                 /* sub */
  68   NULL,                                 /* next */
  69   0,                                    /* static_pass_number */
  70   0,                                    /* tv_id */
  71   0,                                    /* properties_required */
  72   PROP_gimple_any,                      /* properties_provided */
  73   0,                                    /* properties_destroyed */
  74   0,                                    /* todo_flags_start */
  75   TODO_dump_func                        /* todo_flags_finish */
  76 };
  77
  78 /* Gate: execute, or not, all of the non-trivial optimizations.  */
  79
  80 static bool
  81 gate_all_optimizations (void)
  82 {
  83   return (optimize >= 1
  84           /* Don't bother doing anything if the program has errors.  */
  85           && !(errorcount || sorrycount));
  86 }
  87
  88 static struct tree_opt_pass pass_all_optimizations =
  89 {
  90   NULL,                                 /* name */
  91   gate_all_optimizations,               /* gate */
  92   NULL,                                 /* execute */
  93   NULL,                                 /* sub */
  94   NULL,                                 /* next */
  95   0,                                    /* static_pass_number */
  96   0,                                    /* tv_id */
  97   0,                                    /* properties_required */
  98   0,                                    /* properties_provided */
  99   0,                                    /* properties_destroyed */
 100   0,                                    /* todo_flags_start */
 101   0                                     /* todo_flags_finish */
 102 };
 103
 104 /* Pass: do the actions required to finish with tree-ssa optimization
 105    passes.  */
 106
 107 static void
 108 execute_free_datastructures (void)
 109 {
 110   tree *chain;
 111
 112   /* ??? This isn't the right place for this.  Worse, it got computed
 113      more or less at random in various passes.  */
 114   free_dominance_info (CDI_DOMINATORS);
 115
 116   /* Emit gotos for implicit jumps.  */
 117   disband_implicit_edges ();
 118
 119   /* Remove the ssa structures.  Do it here since this includes statement
 120      annotations that need to be intact during disband_implicit_edges.  */
 121   delete_tree_ssa ();
 122
 123   /* Re-chain the statements from the blocks.  */
 124   chain = &DECL_SAVED_TREE (current_function_decl);
 125   *chain = alloc_stmt_list ();
 126
 127   /* And get rid of annotations we no longer need.  */
 128   delete_tree_cfg_annotations ();
 129 }
 130
 131 static struct tree_opt_pass pass_free_datastructures =
 132 {
 133   NULL,                                 /* name */
 134   NULL,                                 /* gate */
 135   execute_free_datastructures,                  /* execute */
 136   NULL,                                 /* sub */
 137   NULL,                                 /* next */
 138   0,                                    /* static_pass_number */
 139   0,                                    /* tv_id */
 140   PROP_cfg,                             /* properties_required */
 141   0,                                    /* properties_provided */
 142   0,                                    /* properties_destroyed */
 143   0,                                    /* todo_flags_start */
 144   0                                     /* todo_flags_finish */
 145 };
 146
 147
 148 /* Do the actions required to initialize internal data structures used
 149    in tree-ssa optimization passes.  */
 150
 151 static void
 152 execute_init_datastructures (void)
 153 {
 154   /* Allocate hash tables, arrays and other structures.  */
 155   init_tree_ssa ();
 156 }
 157
 158 static struct tree_opt_pass pass_init_datastructures =
 159 {
 160   NULL,                                 /* name */
 161   NULL,                                 /* gate */
 162   execute_init_datastructures,          /* execute */
 163   NULL,                                 /* sub */
 164   NULL,                                 /* next */
 165   0,                                    /* static_pass_number */
 166   0,                                    /* tv_id */
 167   PROP_cfg,                             /* properties_required */
 168   0,                                    /* properties_provided */
 169   0,                                    /* properties_destroyed */
 170   0,                                    /* todo_flags_start */
 171   0                                     /* todo_flags_finish */
 172 };
 173
 174 /* Iterate over the pass tree allocating dump file numbers.  We want
 175    to do this depth first, and independent of whether the pass is
 176    enabled or not.  */
 177
 178 static void
 179 register_one_dump_file (struct tree_opt_pass *pass)
 180 {
 181   char *dot_name, *flag_name;
 182   char num[10];
 183
 184   if (!pass->name)
 185     return;
 186
 187   /* See below in dup_pass_1.  */
 188   num[0] = '\0';
 189   if (pass->static_pass_number)
 190     sprintf (num, "%d", ((int) pass->static_pass_number < 0
 191                          ? 1 : pass->static_pass_number));
 192
 193   dot_name = concat (".", pass->name, num, NULL);
 194   flag_name = concat ("tree-", pass->name, num, NULL);
 195
 196   pass->static_pass_number = dump_register (dot_name, flag_name);
 197 }
 198
 199 static int
 200 register_dump_files (struct tree_opt_pass *pass, int properties)
 201 {
 202   do
 203     {
 204       /* Verify that all required properties are present.  */
 205       if (pass->properties_required & ~properties)
 206         abort ();
 207
 208       if (pass->properties_destroyed & pass->properties_provided)
 209         abort ();
 210
 211       pass->properties_required = properties;
 212       pass->properties_provided = properties =
 213         (properties | pass->properties_provided) & ~pass->properties_destroyed;
 214
 215       if (properties & PROP_trees)
 216         register_one_dump_file (pass);
 217       if (pass->sub)
 218         properties = register_dump_files (pass->sub, properties);
 219       pass = pass->next;
 220     }
 221   while (pass);
 222
 223   return properties;
 224 }
 225
 226 /* Duplicate a pass that's to be run more than once.  */
 227
 228 static struct tree_opt_pass *
 229 dup_pass_1 (struct tree_opt_pass *pass)
 230 {
 231   struct tree_opt_pass *new;
 232
 233   new = xmalloc (sizeof (*new));
 234   memcpy (new, pass, sizeof (*new));
 235
 236   /* Indicate to register_dump_files that this pass has duplicates,
 237      and so it should rename the dump file.  The first instance will
 238      be < 0, and be number of duplicates = -static_pass_number + 1.
 239      Subsequent instances will be > 0 and just the duplicate number.  */
 240   if (pass->name)
 241     {
 242       int n, p = pass->static_pass_number;
 243
 244       if (p)
 245         n = -(--p) + 1;
 246       else
 247         n = 2, p = -1;
 248
 249       pass->static_pass_number = p;
 250       new->static_pass_number = n;
 251     }
 252
 253   return new;
 254 }
 255
 256 /* Construct the pass tree.  */
 257
 258 void
 259 init_tree_optimization_passes (void)
 260 {
 261   struct tree_opt_pass **p;
 262
 263 #define NEXT_PASS(PASS) (*p = &PASS, p = &(*p)->next)
 264 #define DUP_PASS(PASS)  (*dup_pass_1 (&PASS))
 265
 266   p = &all_passes;
 267   NEXT_PASS (pass_gimple);
 268   NEXT_PASS (pass_remove_useless_stmts);
 269   NEXT_PASS (pass_mudflap_1);
 270   NEXT_PASS (pass_lower_cf);
 271   NEXT_PASS (pass_lower_eh);
 272   NEXT_PASS (pass_build_cfg);
 273   NEXT_PASS (pass_tree_profile);
 274   NEXT_PASS (pass_init_datastructures);
 275   NEXT_PASS (pass_all_optimizations);
 276   NEXT_PASS (pass_mudflap_2);
 277   NEXT_PASS (pass_free_datastructures);
 278   NEXT_PASS (pass_expand);
 279   NEXT_PASS (pass_rest_of_compilation);
 280   *p = NULL;
 281
 282   p = &pass_all_optimizations.sub;
 283   NEXT_PASS (pass_referenced_vars);
 284   NEXT_PASS (pass_build_pta);
 285   NEXT_PASS (pass_build_ssa);
 286   NEXT_PASS (pass_rename_ssa_copies);
 287   NEXT_PASS (pass_early_warn_uninitialized);
 288   NEXT_PASS (pass_dce);
 289   NEXT_PASS (pass_dominator);
 290   NEXT_PASS (pass_redundant_phi);
 291   NEXT_PASS (DUP_PASS (pass_dce));
 292   NEXT_PASS (pass_forwprop);
 293   NEXT_PASS (pass_phiopt);
 294   NEXT_PASS (pass_may_alias);
 295   NEXT_PASS (pass_tail_recursion);
 296   NEXT_PASS (pass_ch);
 297   NEXT_PASS (pass_profile);
 298   NEXT_PASS (pass_lower_complex);
 299   NEXT_PASS (pass_sra);
 300   NEXT_PASS (DUP_PASS (pass_rename_ssa_copies));
 301   NEXT_PASS (DUP_PASS (pass_dominator));
 302   NEXT_PASS (DUP_PASS (pass_redundant_phi));
 303   NEXT_PASS (DUP_PASS (pass_dce));
 304   NEXT_PASS (pass_dse);
 305   NEXT_PASS (DUP_PASS (pass_may_alias));
 306   NEXT_PASS (DUP_PASS (pass_forwprop));
 307   NEXT_PASS (DUP_PASS (pass_phiopt));
 308   NEXT_PASS (pass_ccp);
 309   NEXT_PASS (DUP_PASS (pass_redundant_phi));
 310   NEXT_PASS (pass_fold_builtins);
 311   NEXT_PASS (pass_split_crit_edges);
 312   NEXT_PASS (pass_pre);
 313   NEXT_PASS (pass_loop);
 314   NEXT_PASS (DUP_PASS (pass_dominator));
 315   NEXT_PASS (DUP_PASS (pass_redundant_phi));
 316   NEXT_PASS (pass_cd_dce);
 317   NEXT_PASS (DUP_PASS (pass_dse));
 318   NEXT_PASS (DUP_PASS (pass_forwprop));
 319   NEXT_PASS (DUP_PASS (pass_phiopt));
 320   NEXT_PASS (pass_tail_calls);
 321   NEXT_PASS (pass_late_warn_uninitialized);
 322   NEXT_PASS (pass_warn_function_return);
 323   NEXT_PASS (pass_del_pta);
 324   NEXT_PASS (pass_del_ssa);
 325   NEXT_PASS (pass_nrv);
 326   NEXT_PASS (pass_remove_useless_vars);
 327   *p = NULL;
 328
 329   p = &pass_loop.sub;
 330   NEXT_PASS (pass_loop_init);
 331   NEXT_PASS (pass_loop_done);
 332   *p = NULL;
 333
 334 #undef NEXT_PASS
 335 #undef DUP_PASS
 336
 337   /* Register the passes with the tree dump code.  */
 338   register_dump_files (all_passes, 0);
 339 }
 340
 341 static void execute_pass_list (struct tree_opt_pass *);
 342
 343 static unsigned int last_verified;
 344
 345 static void
 346 execute_todo (unsigned int flags)
 347 {
 348   if (flags & TODO_rename_vars)
 349     {
 350       rewrite_into_ssa (false);
 351       bitmap_clear (vars_to_rename);
 352     }
 353
 354   if ((flags & TODO_dump_func) && dump_file)
 355     dump_function_to_file (current_function_decl,
 356                            dump_file, dump_flags);
 357
 358   if (flags & TODO_ggc_collect)
 359     ggc_collect ();
 360
 361 #ifdef ENABLE_CHECKING
 362   if (flags & TODO_verify_ssa)
 363     verify_ssa ();
 364   if (flags & TODO_verify_flow)
 365     verify_flow_info ();
 366   if (flags & TODO_verify_stmts)
 367     verify_stmts ();
 368 #endif
 369 }
 370
 371 static bool
 372 execute_one_pass (struct tree_opt_pass *pass)
 373 {
 374   unsigned int todo;
 375
 376   /* See if we're supposed to run this pass.  */
 377   if (pass->gate && !pass->gate ())
 378     return false;
 379
 380   /* Note that the folders should only create gimple expressions.
 381      This is a hack until the new folder is ready.  */
 382   in_gimple_form = (pass->properties_provided & PROP_trees) != 0;
 383
 384   /* Run pre-pass verification.  */
 385   todo = pass->todo_flags_start & ~last_verified;
 386   if (todo)
 387     execute_todo (todo);
 388
 389   /* If a dump file name is present, open it if enabled.  */
 390   if (pass->static_pass_number)
 391     {
 392       dump_file = dump_begin (pass->static_pass_number, &dump_flags);
 393       if (dump_file)
 394         {
 395           const char *dname, *aname;
 396           dname = lang_hooks.decl_printable_name (current_function_decl, 2);
 397           aname = (IDENTIFIER_POINTER
 398                    (DECL_ASSEMBLER_NAME (current_function_decl)));
 399           fprintf (dump_file, "\n;; Function %s (%s)\n\n", dname, aname);
 400         }
 401     }
 402
 403   /* If a timevar is present, start it.  */
 404   if (pass->tv_id)
 405     timevar_push (pass->tv_id);
 406
 407   /* Do it!  */
 408   if (pass->execute)
 409     pass->execute ();
 410
 411   /* Run post-pass cleanup and verification.  */
 412   todo = pass->todo_flags_finish;
 413   last_verified = todo & TODO_verify_all;
 414   if (todo)
 415     execute_todo (todo);
 416
 417   /* Close down timevar and dump file.  */
 418   if (pass->tv_id)
 419     timevar_pop (pass->tv_id);
 420   if (dump_file)
 421     {
 422       dump_end (pass->static_pass_number, dump_file);
 423       dump_file = NULL;
 424     }
 425
 426   return true;
 427 }
 428
 429 static void
 430 execute_pass_list (struct tree_opt_pass *pass)
 431 {
 432   do
 433     {
 434       if (execute_one_pass (pass) && pass->sub)
 435         execute_pass_list (pass->sub);
 436       pass = pass->next;
 437     }
 438   while (pass);
 439 }
 440
 441 \f
 442 /* For functions-as-trees languages, this performs all optimization and
 443    compilation for FNDECL.  */
 444
 445 void
 446 tree_rest_of_compilation (tree fndecl, bool nested_p)
 447 {
 448   location_t saved_loc;
 449   struct cgraph_node *saved_node = NULL, *node;
 450
 451   timevar_push (TV_EXPAND);
 452
 453   if (flag_unit_at_a_time && !cgraph_global_info_ready)
 454     abort ();
 455
 456   /* Initialize the RTL code for the function.  */
 457   current_function_decl = fndecl;
 458   saved_loc = input_location;
 459   input_location = DECL_SOURCE_LOCATION (fndecl);
 460   init_function_start (fndecl);
 461
 462   /* Even though we're inside a function body, we still don't want to
 463      call expand_expr to calculate the size of a variable-sized array.
 464      We haven't necessarily assigned RTL to all variables yet, so it's
 465      not safe to try to expand expressions involving them.  */
 466   cfun->x_dont_save_pending_sizes_p = 1;
 467
 468   node = cgraph_node (fndecl);
 469
 470   /* We might need the body of this function so that we can expand
 471      it inline somewhere else.  This means not lowering some constructs
 472      such as exception handling.  */
 473   if (cgraph_preserve_function_body_p (fndecl))
 474     {
 475       if (!flag_unit_at_a_time)
 476         {
 477           struct cgraph_edge *e;
 478
 479           saved_node = cgraph_clone_node (node);
 480           for (e = saved_node->callees; e; e = e->next_callee)
 481             if (!e->inline_failed)
 482               cgraph_clone_inlined_nodes (e, true);
 483         }
 484       cfun->saved_tree = save_body (fndecl, &cfun->saved_args);
 485     }
 486
 487   if (flag_inline_trees)
 488     {
 489       struct cgraph_edge *e;
 490       for (e = node->callees; e; e = e->next_callee)
 491         if (!e->inline_failed || warn_inline)
 492           break;
 493       if (e)
 494         {
 495           timevar_push (TV_INTEGRATION);
 496           optimize_inline_calls (fndecl);
 497           timevar_pop (TV_INTEGRATION);
 498         }
 499     }
 500
 501   if (!vars_to_rename)
 502     vars_to_rename = BITMAP_XMALLOC ();
 503
 504   /* If this is a nested function, protect the local variables in the stack
 505      above us from being collected while we're compiling this function.  */
 506   if (nested_p)
 507     ggc_push_context ();
 508
 509   /* Perform all tree transforms and optimizations.  */
 510   execute_pass_list (all_passes);
 511
 512   /* Restore original body if still needed.  */
 513   if (cfun->saved_tree)
 514     {
 515       DECL_SAVED_TREE (fndecl) = cfun->saved_tree;
 516       DECL_ARGUMENTS (fndecl) = cfun->saved_args;
 517
 518       /* When not in unit-at-a-time mode, we must preserve out of line copy
 519          representing node before inlining.  Restore original outgoing edges
 520          using clone we created earlier.  */
 521       if (!flag_unit_at_a_time)
 522         {
 523           struct cgraph_edge *e;
 524           while (node->callees)
 525             cgraph_remove_edge (node->callees);
 526           node->callees = saved_node->callees;
 527           saved_node->callees = NULL;
 528           for (e = saved_node->callees; e; e = e->next_callee)
 529             e->caller = node;
 530           cgraph_remove_node (saved_node);
 531         }
 532     }
 533   else
 534     DECL_SAVED_TREE (fndecl) = NULL;
 535   cfun = 0;
 536
 537   /* If requested, warn about function definitions where the function will
 538      return a value (usually of some struct or union type) which itself will
 539      take up a lot of stack space.  */
 540   if (warn_larger_than && !DECL_EXTERNAL (fndecl) && TREE_TYPE (fndecl))
 541     {
 542       tree ret_type = TREE_TYPE (TREE_TYPE (fndecl));
 543
 544       if (ret_type && TYPE_SIZE_UNIT (ret_type)
 545           && TREE_CODE (TYPE_SIZE_UNIT (ret_type)) == INTEGER_CST
 546           && 0 < compare_tree_int (TYPE_SIZE_UNIT (ret_type),
 547                                    larger_than_size))
 548         {
 549           unsigned int size_as_int
 550             = TREE_INT_CST_LOW (TYPE_SIZE_UNIT (ret_type));
 551
 552           if (compare_tree_int (TYPE_SIZE_UNIT (ret_type), size_as_int) == 0)
 553             warning ("%Jsize of return value of '%D' is %u bytes",
 554                      fndecl, fndecl, size_as_int);
 555           else
 556             warning ("%Jsize of return value of '%D' is larger than %wd bytes",
 557                      fndecl, fndecl, larger_than_size);
 558         }
 559     }
 560
 561   if (!nested_p && !flag_inline_trees)
 562     {
 563       DECL_SAVED_TREE (fndecl) = NULL;
 564       if (DECL_STRUCT_FUNCTION (fndecl) == 0
 565           && !cgraph_node (fndecl)->origin)
 566         {
 567           /* Stop pointing to the local nodes about to be freed.
 568              But DECL_INITIAL must remain nonzero so we know this
 569              was an actual function definition.
 570              For a nested function, this is done in c_pop_function_context.
 571              If rest_of_compilation set this to 0, leave it 0.  */
 572           if (DECL_INITIAL (fndecl) != 0)
 573             DECL_INITIAL (fndecl) = error_mark_node;
 574         }
 575     }
 576
 577   input_location = saved_loc;
 578
 579   ggc_collect ();
 580
 581   /* Undo the GC context switch.  */
 582   if (nested_p)
 583     ggc_pop_context ();
 584   timevar_pop (TV_EXPAND);
 585 }