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_del_pta);
 298   NEXT_PASS (pass_profile);
 299   NEXT_PASS (pass_lower_complex);
 300   NEXT_PASS (pass_sra);
 301   NEXT_PASS (DUP_PASS (pass_rename_ssa_copies));
 302   NEXT_PASS (DUP_PASS (pass_dominator));
 303   NEXT_PASS (DUP_PASS (pass_redundant_phi));
 304   NEXT_PASS (DUP_PASS (pass_dce));
 305   NEXT_PASS (pass_dse);
 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_ssa);
 324   NEXT_PASS (pass_nrv);
 325   NEXT_PASS (pass_remove_useless_vars);
 326   *p = NULL;
 327
 328   p = &pass_loop.sub;
 329   NEXT_PASS (pass_loop_init);
 330   NEXT_PASS (pass_loop_done);
 331   *p = NULL;
 332
 333 #undef NEXT_PASS
 334 #undef DUP_PASS
 335
 336   /* Register the passes with the tree dump code.  */
 337   register_dump_files (all_passes, 0);
 338 }
 339
 340 static void execute_pass_list (struct tree_opt_pass *);
 341
 342 static unsigned int last_verified;
 343
 344 static void
 345 execute_todo (unsigned int flags)
 346 {
 347   if (flags & TODO_rename_vars)
 348     {
 349       rewrite_into_ssa (false);
 350       bitmap_clear (vars_to_rename);
 351     }
 352
 353   if ((flags & TODO_dump_func) && dump_file)
 354     dump_function_to_file (current_function_decl,
 355                            dump_file, dump_flags);
 356
 357   if (flags & TODO_ggc_collect)
 358     ggc_collect ();
 359
 360 #ifdef ENABLE_CHECKING
 361   if (flags & TODO_verify_ssa)
 362     verify_ssa ();
 363   if (flags & TODO_verify_flow)
 364     verify_flow_info ();
 365   if (flags & TODO_verify_stmts)
 366     verify_stmts ();
 367 #endif
 368 }
 369
 370 static bool
 371 execute_one_pass (struct tree_opt_pass *pass)
 372 {
 373   unsigned int todo;
 374
 375   /* See if we're supposed to run this pass.  */
 376   if (pass->gate && !pass->gate ())
 377     return false;
 378
 379   /* Note that the folders should only create gimple expressions.
 380      This is a hack until the new folder is ready.  */
 381   in_gimple_form = (pass->properties_provided & PROP_trees) != 0;
 382
 383   /* Run pre-pass verification.  */
 384   todo = pass->todo_flags_start & ~last_verified;
 385   if (todo)
 386     execute_todo (todo);
 387
 388   /* If a dump file name is present, open it if enabled.  */
 389   if (pass->static_pass_number)
 390     {
 391       dump_file = dump_begin (pass->static_pass_number, &dump_flags);
 392       if (dump_file)
 393         {
 394           const char *dname, *aname;
 395           dname = lang_hooks.decl_printable_name (current_function_decl, 2);
 396           aname = (IDENTIFIER_POINTER
 397                    (DECL_ASSEMBLER_NAME (current_function_decl)));
 398           fprintf (dump_file, "\n;; Function %s (%s)\n\n", dname, aname);
 399         }
 400     }
 401
 402   /* If a timevar is present, start it.  */
 403   if (pass->tv_id)
 404     timevar_push (pass->tv_id);
 405
 406   /* Do it!  */
 407   if (pass->execute)
 408     pass->execute ();
 409
 410   /* Run post-pass cleanup and verification.  */
 411   todo = pass->todo_flags_finish;
 412   last_verified = todo & TODO_verify_all;
 413   if (todo)
 414     execute_todo (todo);
 415
 416   /* Close down timevar and dump file.  */
 417   if (pass->tv_id)
 418     timevar_pop (pass->tv_id);
 419   if (dump_file)
 420     {
 421       dump_end (pass->static_pass_number, dump_file);
 422       dump_file = NULL;
 423     }
 424
 425   return true;
 426 }
 427
 428 static void
 429 execute_pass_list (struct tree_opt_pass *pass)
 430 {
 431   do
 432     {
 433       if (execute_one_pass (pass) && pass->sub)
 434         execute_pass_list (pass->sub);
 435       pass = pass->next;
 436     }
 437   while (pass);
 438 }
 439
 440 \f
 441 /* For functions-as-trees languages, this performs all optimization and
 442    compilation for FNDECL.  */
 443
 444 void
 445 tree_rest_of_compilation (tree fndecl, bool nested_p)
 446 {
 447   location_t saved_loc;
 448   struct cgraph_node *saved_node = NULL, *node;
 449
 450   timevar_push (TV_EXPAND);
 451
 452   if (flag_unit_at_a_time && !cgraph_global_info_ready)
 453     abort ();
 454
 455   /* Initialize the RTL code for the function.  */
 456   current_function_decl = fndecl;
 457   saved_loc = input_location;
 458   input_location = DECL_SOURCE_LOCATION (fndecl);
 459   init_function_start (fndecl);
 460
 461   /* Even though we're inside a function body, we still don't want to
 462      call expand_expr to calculate the size of a variable-sized array.
 463      We haven't necessarily assigned RTL to all variables yet, so it's
 464      not safe to try to expand expressions involving them.  */
 465   cfun->x_dont_save_pending_sizes_p = 1;
 466
 467   node = cgraph_node (fndecl);
 468
 469   /* We might need the body of this function so that we can expand
 470      it inline somewhere else.  This means not lowering some constructs
 471      such as exception handling.  */
 472   if (cgraph_preserve_function_body_p (fndecl))
 473     {
 474       if (!flag_unit_at_a_time)
 475         {
 476           struct cgraph_edge *e;
 477
 478           saved_node = cgraph_clone_node (node);
 479           for (e = saved_node->callees; e; e = e->next_callee)
 480             if (!e->inline_failed)
 481               cgraph_clone_inlined_nodes (e, true);
 482         }
 483       cfun->saved_tree = save_body (fndecl, &cfun->saved_args);
 484     }
 485
 486   if (flag_inline_trees)
 487     {
 488       struct cgraph_edge *e;
 489       for (e = node->callees; e; e = e->next_callee)
 490         if (!e->inline_failed || warn_inline)
 491           break;
 492       if (e)
 493         {
 494           timevar_push (TV_INTEGRATION);
 495           optimize_inline_calls (fndecl);
 496           timevar_pop (TV_INTEGRATION);
 497         }
 498     }
 499
 500   if (!vars_to_rename)
 501     vars_to_rename = BITMAP_XMALLOC ();
 502
 503   /* If this is a nested function, protect the local variables in the stack
 504      above us from being collected while we're compiling this function.  */
 505   if (nested_p)
 506     ggc_push_context ();
 507
 508   /* Perform all tree transforms and optimizations.  */
 509   execute_pass_list (all_passes);
 510
 511   /* Restore original body if still needed.  */
 512   if (cfun->saved_tree)
 513     {
 514       DECL_SAVED_TREE (fndecl) = cfun->saved_tree;
 515       DECL_ARGUMENTS (fndecl) = cfun->saved_args;
 516
 517       /* When not in unit-at-a-time mode, we must preserve out of line copy
 518          representing node before inlining.  Restore original outgoing edges
 519          using clone we created earlier.  */
 520       if (!flag_unit_at_a_time)
 521         {
 522           struct cgraph_edge *e;
 523           while (node->callees)
 524             cgraph_remove_edge (node->callees);
 525           node->callees = saved_node->callees;
 526           saved_node->callees = NULL;
 527           for (e = saved_node->callees; e; e = e->next_callee)
 528             e->caller = node;
 529           cgraph_remove_node (saved_node);
 530         }
 531     }
 532   else
 533     DECL_SAVED_TREE (fndecl) = NULL;
 534   cfun = 0;
 535
 536   /* If requested, warn about function definitions where the function will
 537      return a value (usually of some struct or union type) which itself will
 538      take up a lot of stack space.  */
 539   if (warn_larger_than && !DECL_EXTERNAL (fndecl) && TREE_TYPE (fndecl))
 540     {
 541       tree ret_type = TREE_TYPE (TREE_TYPE (fndecl));
 542
 543       if (ret_type && TYPE_SIZE_UNIT (ret_type)
 544           && TREE_CODE (TYPE_SIZE_UNIT (ret_type)) == INTEGER_CST
 545           && 0 < compare_tree_int (TYPE_SIZE_UNIT (ret_type),
 546                                    larger_than_size))
 547         {
 548           unsigned int size_as_int
 549             = TREE_INT_CST_LOW (TYPE_SIZE_UNIT (ret_type));
 550
 551           if (compare_tree_int (TYPE_SIZE_UNIT (ret_type), size_as_int) == 0)
 552             warning ("%Jsize of return value of '%D' is %u bytes",
 553                      fndecl, fndecl, size_as_int);
 554           else
 555             warning ("%Jsize of return value of '%D' is larger than %wd bytes",
 556                      fndecl, fndecl, larger_than_size);
 557         }
 558     }
 559
 560   if (!nested_p && !flag_inline_trees)
 561     {
 562       DECL_SAVED_TREE (fndecl) = NULL;
 563       if (DECL_STRUCT_FUNCTION (fndecl) == 0
 564           && !cgraph_node (fndecl)->origin)
 565         {
 566           /* Stop pointing to the local nodes about to be freed.
 567              But DECL_INITIAL must remain nonzero so we know this
 568              was an actual function definition.
 569              For a nested function, this is done in c_pop_function_context.
 570              If rest_of_compilation set this to 0, leave it 0.  */
 571           if (DECL_INITIAL (fndecl) != 0)
 572             DECL_INITIAL (fndecl) = error_mark_node;
 573         }
 574     }
 575
 576   input_location = saved_loc;
 577
 578   ggc_collect ();
 579
 580   /* Undo the GC context switch.  */
 581   if (nested_p)
 582     ggc_pop_context ();
 583   timevar_pop (TV_EXPAND);
 584 }