gcc/tree-ssa-copy.c

   1 /* Copy propagation and SSA_NAME replacement support routines.
   2    Copyright (C) 2004-2013 Free Software Foundation, Inc.
   3
   4 This file is part of GCC.
   5
   6 GCC is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 3, or (at your option)
   9 any later version.
  10
  11 GCC is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GCC; see the file COPYING3.  If not see
  18 <http://www.gnu.org/licenses/>.  */
  19
  20 #include "config.h"
  21 #include "system.h"
  22 #include "coretypes.h"
  23 #include "tm.h"
  24 #include "tree.h"
  25 #include "flags.h"
  26 #include "tm_p.h"
  27 #include "basic-block.h"
  28 #include "function.h"
  29 #include "gimple-pretty-print.h"
  30 #include "tree-flow.h"
  31 #include "tree-pass.h"
  32 #include "tree-ssa-propagate.h"
  33 #include "langhooks.h"
  34 #include "cfgloop.h"
  35
  36 /* This file implements the copy propagation pass and provides a
  37    handful of interfaces for performing const/copy propagation and
  38    simple expression replacement which keep variable annotations
  39    up-to-date.
  40
  41    We require that for any copy operation where the RHS and LHS have
  42    a non-null memory tag the memory tag be the same.   It is OK
  43    for one or both of the memory tags to be NULL.
  44
  45    We also require tracking if a variable is dereferenced in a load or
  46    store operation.
  47
  48    We enforce these requirements by having all copy propagation and
  49    replacements of one SSA_NAME with a different SSA_NAME to use the
  50    APIs defined in this file.  */
  51
  52 /* Return true if we may propagate ORIG into DEST, false otherwise.  */
  53
  54 bool
  55 may_propagate_copy (tree dest, tree orig)
  56 {
  57   tree type_d = TREE_TYPE (dest);
  58   tree type_o = TREE_TYPE (orig);
  59
  60   /* If ORIG flows in from an abnormal edge, it cannot be propagated.  */
  61   if (TREE_CODE (orig) == SSA_NAME
  62       && SSA_NAME_OCCURS_IN_ABNORMAL_PHI (orig))
  63     return false;
  64
  65   /* If DEST is an SSA_NAME that flows from an abnormal edge, then it
  66      cannot be replaced.  */
  67   if (TREE_CODE (dest) == SSA_NAME
  68       && SSA_NAME_OCCURS_IN_ABNORMAL_PHI (dest))
  69     return false;
  70
  71   /* Do not copy between types for which we *do* need a conversion.  */
  72   if (!useless_type_conversion_p (type_d, type_o))
  73     return false;
  74
  75   /* Propagating virtual operands is always ok.  */
  76   if (TREE_CODE (dest) == SSA_NAME && virtual_operand_p (dest))
  77     {
  78       /* But only between virtual operands.  */
  79       gcc_assert (TREE_CODE (orig) == SSA_NAME && virtual_operand_p (orig));
  80
  81       return true;
  82     }
  83
  84   /* Anything else is OK.  */
  85   return true;
  86 }
  87
  88 /* Like may_propagate_copy, but use as the destination expression
  89    the principal expression (typically, the RHS) contained in
  90    statement DEST.  This is more efficient when working with the
  91    gimple tuples representation.  */
  92
  93 bool
  94 may_propagate_copy_into_stmt (gimple dest, tree orig)
  95 {
  96   tree type_d;
  97   tree type_o;
  98
  99   /* If the statement is a switch or a single-rhs assignment,
 100      then the expression to be replaced by the propagation may
 101      be an SSA_NAME.  Fortunately, there is an explicit tree
 102      for the expression, so we delegate to may_propagate_copy.  */
 103
 104   if (gimple_assign_single_p (dest))
 105     return may_propagate_copy (gimple_assign_rhs1 (dest), orig);
 106   else if (gimple_code (dest) == GIMPLE_SWITCH)
 107     return may_propagate_copy (gimple_switch_index (dest), orig);
 108
 109   /* In other cases, the expression is not materialized, so there
 110      is no destination to pass to may_propagate_copy.  On the other
 111      hand, the expression cannot be an SSA_NAME, so the analysis
 112      is much simpler.  */
 113
 114   if (TREE_CODE (orig) == SSA_NAME
 115       && SSA_NAME_OCCURS_IN_ABNORMAL_PHI (orig))
 116     return false;
 117
 118   if (is_gimple_assign (dest))
 119     type_d = TREE_TYPE (gimple_assign_lhs (dest));
 120   else if (gimple_code (dest) == GIMPLE_COND)
 121     type_d = boolean_type_node;
 122   else if (is_gimple_call (dest)
 123            && gimple_call_lhs (dest) != NULL_TREE)
 124     type_d = TREE_TYPE (gimple_call_lhs (dest));
 125   else
 126     gcc_unreachable ();
 127
 128   type_o = TREE_TYPE (orig);
 129
 130   if (!useless_type_conversion_p (type_d, type_o))
 131     return false;
 132
 133   return true;
 134 }
 135
 136 /* Similarly, but we know that we're propagating into an ASM_EXPR.  */
 137
 138 bool
 139 may_propagate_copy_into_asm (tree dest ATTRIBUTE_UNUSED)
 140 {
 141   return true;
 142 }
 143
 144
 145 /* Common code for propagate_value and replace_exp.
 146
 147    Replace use operand OP_P with VAL.  FOR_PROPAGATION indicates if the
 148    replacement is done to propagate a value or not.  */
 149
 150 static void
 151 replace_exp_1 (use_operand_p op_p, tree val,
 152                bool for_propagation ATTRIBUTE_UNUSED)
 153 {
 154 #if defined ENABLE_CHECKING
 155   tree op = USE_FROM_PTR (op_p);
 156
 157   gcc_assert (!(for_propagation
 158                 && TREE_CODE (op) == SSA_NAME
 159                 && TREE_CODE (val) == SSA_NAME
 160                 && !may_propagate_copy (op, val)));
 161 #endif
 162
 163   if (TREE_CODE (val) == SSA_NAME)
 164     SET_USE (op_p, val);
 165   else
 166     SET_USE (op_p, unsave_expr_now (val));
 167 }
 168
 169
 170 /* Propagate the value VAL (assumed to be a constant or another SSA_NAME)
 171    into the operand pointed to by OP_P.
 172
 173    Use this version for const/copy propagation as it will perform additional
 174    checks to ensure validity of the const/copy propagation.  */
 175
 176 void
 177 propagate_value (use_operand_p op_p, tree val)
 178 {
 179   replace_exp_1 (op_p, val, true);
 180 }
 181
 182 /* Replace *OP_P with value VAL (assumed to be a constant or another SSA_NAME).
 183
 184    Use this version when not const/copy propagating values.  For example,
 185    PRE uses this version when building expressions as they would appear
 186    in specific blocks taking into account actions of PHI nodes.
 187
 188    The statement in which an expression has been replaced should be
 189    folded using fold_stmt_inplace.  */
 190
 191 void
 192 replace_exp (use_operand_p op_p, tree val)
 193 {
 194   replace_exp_1 (op_p, val, false);
 195 }
 196
 197
 198 /* Propagate the value VAL (assumed to be a constant or another SSA_NAME)
 199    into the tree pointed to by OP_P.
 200
 201    Use this version for const/copy propagation when SSA operands are not
 202    available.  It will perform the additional checks to ensure validity of
 203    the const/copy propagation, but will not update any operand information.
 204    Be sure to mark the stmt as modified.  */
 205
 206 void
 207 propagate_tree_value (tree *op_p, tree val)
 208 {
 209   gcc_checking_assert (!(TREE_CODE (val) == SSA_NAME
 210                          && *op_p
 211                          && TREE_CODE (*op_p) == SSA_NAME
 212                          && !may_propagate_copy (*op_p, val)));
 213
 214   if (TREE_CODE (val) == SSA_NAME)
 215     *op_p = val;
 216   else
 217     *op_p = unsave_expr_now (val);
 218 }
 219
 220
 221 /* Like propagate_tree_value, but use as the operand to replace
 222    the principal expression (typically, the RHS) contained in the
 223    statement referenced by iterator GSI.  Note that it is not
 224    always possible to update the statement in-place, so a new
 225    statement may be created to replace the original.  */
 226
 227 void
 228 propagate_tree_value_into_stmt (gimple_stmt_iterator *gsi, tree val)
 229 {
 230   gimple stmt = gsi_stmt (*gsi);
 231
 232   if (is_gimple_assign (stmt))
 233     {
 234       tree expr = NULL_TREE;
 235       if (gimple_assign_single_p (stmt))
 236         expr = gimple_assign_rhs1 (stmt);
 237       propagate_tree_value (&expr, val);
 238       gimple_assign_set_rhs_from_tree (gsi, expr);
 239     }
 240   else if (gimple_code (stmt) == GIMPLE_COND)
 241     {
 242       tree lhs = NULL_TREE;
 243       tree rhs = build_zero_cst (TREE_TYPE (val));
 244       propagate_tree_value (&lhs, val);
 245       gimple_cond_set_code (stmt, NE_EXPR);
 246       gimple_cond_set_lhs (stmt, lhs);
 247       gimple_cond_set_rhs (stmt, rhs);
 248     }
 249   else if (is_gimple_call (stmt)
 250            && gimple_call_lhs (stmt) != NULL_TREE)
 251     {
 252       tree expr = NULL_TREE;
 253       bool res;
 254       propagate_tree_value (&expr, val);
 255       res = update_call_from_tree (gsi, expr);
 256       gcc_assert (res);
 257     }
 258   else if (gimple_code (stmt) == GIMPLE_SWITCH)
 259     propagate_tree_value (gimple_switch_index_ptr (stmt), val);
 260   else
 261     gcc_unreachable ();
 262 }
 263
 264 /*---------------------------------------------------------------------------
 265                                 Copy propagation
 266 ---------------------------------------------------------------------------*/
 267 /* Lattice for copy-propagation.  The lattice is initialized to
 268    UNDEFINED (value == NULL) for SSA names that can become a copy
 269    of something or VARYING (value == self) if not (see get_copy_of_val
 270    and stmt_may_generate_copy).  Other values make the name a COPY
 271    of that value.
 272
 273    When visiting a statement or PHI node the lattice value for an
 274    SSA name can transition from UNDEFINED to COPY to VARYING.  */
 275
 276 struct prop_value_d {
 277     /* Copy-of value.  */
 278     tree value;
 279 };
 280 typedef struct prop_value_d prop_value_t;
 281
 282 static prop_value_t *copy_of;
 283 static unsigned n_copy_of;
 284
 285
 286 /* Return true if this statement may generate a useful copy.  */
 287
 288 static bool
 289 stmt_may_generate_copy (gimple stmt)
 290 {
 291   if (gimple_code (stmt) == GIMPLE_PHI)
 292     return !SSA_NAME_OCCURS_IN_ABNORMAL_PHI (gimple_phi_result (stmt));
 293
 294   if (gimple_code (stmt) != GIMPLE_ASSIGN)
 295     return false;
 296
 297   /* If the statement has volatile operands, it won't generate a
 298      useful copy.  */
 299   if (gimple_has_volatile_ops (stmt))
 300     return false;
 301
 302   /* Statements with loads and/or stores will never generate a useful copy.  */
 303   if (gimple_vuse (stmt))
 304     return false;
 305
 306   /* Otherwise, the only statements that generate useful copies are
 307      assignments whose RHS is just an SSA name that doesn't flow
 308      through abnormal edges.  */
 309   return ((gimple_assign_rhs_code (stmt) == SSA_NAME
 310            && !SSA_NAME_OCCURS_IN_ABNORMAL_PHI (gimple_assign_rhs1 (stmt)))
 311           || is_gimple_min_invariant (gimple_assign_rhs1 (stmt)));
 312 }
 313
 314
 315 /* Return the copy-of value for VAR.  */
 316
 317 static inline prop_value_t *
 318 get_copy_of_val (tree var)
 319 {
 320   prop_value_t *val = &copy_of[SSA_NAME_VERSION (var)];
 321
 322   if (val->value == NULL_TREE
 323       && !stmt_may_generate_copy (SSA_NAME_DEF_STMT (var)))
 324     {
 325       /* If the variable will never generate a useful copy relation,
 326          make it its own copy.  */
 327       val->value = var;
 328     }
 329
 330   return val;
 331 }
 332
 333 /* Return the variable VAR is a copy of or VAR if VAR isn't the result
 334    of a copy.  */
 335
 336 static inline tree
 337 valueize_val (tree var)
 338 {
 339   if (TREE_CODE (var) == SSA_NAME)
 340     {
 341       tree val = get_copy_of_val (var)->value;
 342       if (val)
 343         return val;
 344     }
 345   return var;
 346 }
 347
 348 /* Set VAL to be the copy of VAR.  If that changed return true.  */
 349
 350 static inline bool
 351 set_copy_of_val (tree var, tree val)
 352 {
 353   unsigned int ver = SSA_NAME_VERSION (var);
 354   tree old;
 355
 356   /* Set FIRST to be the first link in COPY_OF[DEST].  If that
 357      changed, return true.  */
 358   old = copy_of[ver].value;
 359   copy_of[ver].value = val;
 360
 361   if (old != val
 362       || (val && !operand_equal_p (old, val, 0)))
 363     return true;
 364
 365   return false;
 366 }
 367
 368
 369 /* Dump the copy-of value for variable VAR to FILE.  */
 370
 371 static void
 372 dump_copy_of (FILE *file, tree var)
 373 {
 374   tree val;
 375
 376   print_generic_expr (file, var, dump_flags);
 377   if (TREE_CODE (var) != SSA_NAME)
 378     return;
 379
 380   val = copy_of[SSA_NAME_VERSION (var)].value;
 381   fprintf (file, " copy-of chain: ");
 382   print_generic_expr (file, var, 0);
 383   fprintf (file, " ");
 384   if (!val)
 385     fprintf (file, "[UNDEFINED]");
 386   else if (val == var)
 387     fprintf (file, "[NOT A COPY]");
 388   else
 389     {
 390       fprintf (file, "-> ");
 391       print_generic_expr (file, val, 0);
 392       fprintf (file, " ");
 393       fprintf (file, "[COPY]");
 394     }
 395 }
 396
 397
 398 /* Evaluate the RHS of STMT.  If it produces a valid copy, set the LHS
 399    value and store the LHS into *RESULT_P.  */
 400
 401 static enum ssa_prop_result
 402 copy_prop_visit_assignment (gimple stmt, tree *result_p)
 403 {
 404   tree lhs, rhs;
 405
 406   lhs = gimple_assign_lhs (stmt);
 407   rhs = valueize_val (gimple_assign_rhs1 (stmt));
 408
 409   if (TREE_CODE (lhs) == SSA_NAME)
 410     {
 411       /* Straight copy between two SSA names.  First, make sure that
 412          we can propagate the RHS into uses of LHS.  */
 413       if (!may_propagate_copy (lhs, rhs))
 414         return SSA_PROP_VARYING;
 415
 416       *result_p = lhs;
 417       if (set_copy_of_val (*result_p, rhs))
 418         return SSA_PROP_INTERESTING;
 419       else
 420         return SSA_PROP_NOT_INTERESTING;
 421     }
 422
 423   return SSA_PROP_VARYING;
 424 }
 425
 426
 427 /* Visit the GIMPLE_COND STMT.  Return SSA_PROP_INTERESTING
 428    if it can determine which edge will be taken.  Otherwise, return
 429    SSA_PROP_VARYING.  */
 430
 431 static enum ssa_prop_result
 432 copy_prop_visit_cond_stmt (gimple stmt, edge *taken_edge_p)
 433 {
 434   enum ssa_prop_result retval = SSA_PROP_VARYING;
 435   location_t loc = gimple_location (stmt);
 436
 437   tree op0 = gimple_cond_lhs (stmt);
 438   tree op1 = gimple_cond_rhs (stmt);
 439
 440   /* The only conditionals that we may be able to compute statically
 441      are predicates involving two SSA_NAMEs.  */
 442   if (TREE_CODE (op0) == SSA_NAME && TREE_CODE (op1) == SSA_NAME)
 443     {
 444       op0 = valueize_val (op0);
 445       op1 = valueize_val (op1);
 446
 447       /* See if we can determine the predicate's value.  */
 448       if (dump_file && (dump_flags & TDF_DETAILS))
 449         {
 450           fprintf (dump_file, "Trying to determine truth value of ");
 451           fprintf (dump_file, "predicate ");
 452           print_gimple_stmt (dump_file, stmt, 0, 0);
 453         }
 454
 455       /* We can fold COND and get a useful result only when we have
 456          the same SSA_NAME on both sides of a comparison operator.  */
 457       if (op0 == op1)
 458         {
 459           tree folded_cond = fold_binary_loc (loc, gimple_cond_code (stmt),
 460                                           boolean_type_node, op0, op1);
 461           if (folded_cond)
 462             {
 463               basic_block bb = gimple_bb (stmt);
 464               *taken_edge_p = find_taken_edge (bb, folded_cond);
 465               if (*taken_edge_p)
 466                 retval = SSA_PROP_INTERESTING;
 467             }
 468         }
 469     }
 470
 471   if (dump_file && (dump_flags & TDF_DETAILS) && *taken_edge_p)
 472     fprintf (dump_file, "\nConditional will always take edge %d->%d\n",
 473              (*taken_edge_p)->src->index, (*taken_edge_p)->dest->index);
 474
 475   return retval;
 476 }
 477
 478
 479 /* Evaluate statement STMT.  If the statement produces a new output
 480    value, return SSA_PROP_INTERESTING and store the SSA_NAME holding
 481    the new value in *RESULT_P.
 482
 483    If STMT is a conditional branch and we can determine its truth
 484    value, set *TAKEN_EDGE_P accordingly.
 485
 486    If the new value produced by STMT is varying, return
 487    SSA_PROP_VARYING.  */
 488
 489 static enum ssa_prop_result
 490 copy_prop_visit_stmt (gimple stmt, edge *taken_edge_p, tree *result_p)
 491 {
 492   enum ssa_prop_result retval;
 493
 494   if (dump_file && (dump_flags & TDF_DETAILS))
 495     {
 496       fprintf (dump_file, "\nVisiting statement:\n");
 497       print_gimple_stmt (dump_file, stmt, 0, dump_flags);
 498       fprintf (dump_file, "\n");
 499     }
 500
 501   if (gimple_assign_single_p (stmt)
 502       && TREE_CODE (gimple_assign_lhs (stmt)) == SSA_NAME
 503       && (TREE_CODE (gimple_assign_rhs1 (stmt)) == SSA_NAME
 504           || is_gimple_min_invariant (gimple_assign_rhs1 (stmt))))
 505     {
 506       /* If the statement is a copy assignment, evaluate its RHS to
 507          see if the lattice value of its output has changed.  */
 508       retval = copy_prop_visit_assignment (stmt, result_p);
 509     }
 510   else if (gimple_code (stmt) == GIMPLE_COND)
 511     {
 512       /* See if we can determine which edge goes out of a conditional
 513          jump.  */
 514       retval = copy_prop_visit_cond_stmt (stmt, taken_edge_p);
 515     }
 516   else
 517     retval = SSA_PROP_VARYING;
 518
 519   if (retval == SSA_PROP_VARYING)
 520     {
 521       tree def;
 522       ssa_op_iter i;
 523
 524       /* Any other kind of statement is not interesting for constant
 525          propagation and, therefore, not worth simulating.  */
 526       if (dump_file && (dump_flags & TDF_DETAILS))
 527         fprintf (dump_file, "No interesting values produced.\n");
 528
 529       /* The assignment is not a copy operation.  Don't visit this
 530          statement again and mark all the definitions in the statement
 531          to be copies of nothing.  */
 532       FOR_EACH_SSA_TREE_OPERAND (def, stmt, i, SSA_OP_ALL_DEFS)
 533         set_copy_of_val (def, def);
 534     }
 535
 536   return retval;
 537 }
 538
 539
 540 /* Visit PHI node PHI.  If all the arguments produce the same value,
 541    set it to be the value of the LHS of PHI.  */
 542
 543 static enum ssa_prop_result
 544 copy_prop_visit_phi_node (gimple phi)
 545 {
 546   enum ssa_prop_result retval;
 547   unsigned i;
 548   prop_value_t phi_val = { NULL_TREE };
 549
 550   tree lhs = gimple_phi_result (phi);
 551
 552   if (dump_file && (dump_flags & TDF_DETAILS))
 553     {
 554       fprintf (dump_file, "\nVisiting PHI node: ");
 555       print_gimple_stmt (dump_file, phi, 0, dump_flags);
 556     }
 557
 558   for (i = 0; i < gimple_phi_num_args (phi); i++)
 559     {
 560       prop_value_t *arg_val;
 561       tree arg_value;
 562       tree arg = gimple_phi_arg_def (phi, i);
 563       edge e = gimple_phi_arg_edge (phi, i);
 564
 565       /* We don't care about values flowing through non-executable
 566          edges.  */
 567       if (!(e->flags & EDGE_EXECUTABLE))
 568         continue;
 569
 570       /* Names that flow through abnormal edges cannot be used to
 571          derive copies.  */
 572       if (TREE_CODE (arg) == SSA_NAME && SSA_NAME_OCCURS_IN_ABNORMAL_PHI (arg))
 573         {
 574           phi_val.value = lhs;
 575           break;
 576         }
 577
 578       if (dump_file && (dump_flags & TDF_DETAILS))
 579         {
 580           fprintf (dump_file, "\tArgument #%d: ", i);
 581           dump_copy_of (dump_file, arg);
 582           fprintf (dump_file, "\n");
 583         }
 584
 585       if (TREE_CODE (arg) == SSA_NAME)
 586         {
 587           arg_val = get_copy_of_val (arg);
 588
 589           /* If we didn't visit the definition of arg yet treat it as
 590              UNDEFINED.  This also handles PHI arguments that are the
 591              same as lhs.  We'll come here again.  */
 592           if (!arg_val->value)
 593             continue;
 594
 595           arg_value = arg_val->value;
 596         }
 597       else
 598         arg_value = valueize_val (arg);
 599
 600       /* Avoid copy propagation from an inner into an outer loop.
 601          Otherwise, this may move loop variant variables outside of
 602          their loops and prevent coalescing opportunities.  If the
 603          value was loop invariant, it will be hoisted by LICM and
 604          exposed for copy propagation.
 605          ???  The value will be always loop invariant.
 606          In loop-closed SSA form do not copy-propagate through
 607          PHI nodes in blocks with a loop exit edge predecessor.  */
 608       if (current_loops
 609           && TREE_CODE (arg_value) == SSA_NAME
 610           && (loop_depth_of_name (arg_value) > loop_depth_of_name (lhs)
 611               || (loops_state_satisfies_p (LOOP_CLOSED_SSA)
 612                   && loop_exit_edge_p (e->src->loop_father, e))))
 613         {
 614           phi_val.value = lhs;
 615           break;
 616         }
 617
 618       /* If the LHS didn't have a value yet, make it a copy of the
 619          first argument we find.   */
 620       if (phi_val.value == NULL_TREE)
 621         {
 622           phi_val.value = arg_value;
 623           continue;
 624         }
 625
 626       /* If PHI_VAL and ARG don't have a common copy-of chain, then
 627          this PHI node cannot be a copy operation.  */
 628       if (phi_val.value != arg_value
 629           && !operand_equal_p (phi_val.value, arg_value, 0))
 630         {
 631           phi_val.value = lhs;
 632           break;
 633         }
 634     }
 635
 636   if (phi_val.value
 637       && may_propagate_copy (lhs, phi_val.value)
 638       && set_copy_of_val (lhs, phi_val.value))
 639     retval = (phi_val.value != lhs) ? SSA_PROP_INTERESTING : SSA_PROP_VARYING;
 640   else
 641     retval = SSA_PROP_NOT_INTERESTING;
 642
 643   if (dump_file && (dump_flags & TDF_DETAILS))
 644     {
 645       fprintf (dump_file, "PHI node ");
 646       dump_copy_of (dump_file, lhs);
 647       fprintf (dump_file, "\nTelling the propagator to ");
 648       if (retval == SSA_PROP_INTERESTING)
 649         fprintf (dump_file, "add SSA edges out of this PHI and continue.");
 650       else if (retval == SSA_PROP_VARYING)
 651         fprintf (dump_file, "add SSA edges out of this PHI and never visit again.");
 652       else
 653         fprintf (dump_file, "do nothing with SSA edges and keep iterating.");
 654       fprintf (dump_file, "\n\n");
 655     }
 656
 657   return retval;
 658 }
 659
 660
 661 /* Initialize structures used for copy propagation.  */
 662
 663 static void
 664 init_copy_prop (void)
 665 {
 666   basic_block bb;
 667
 668   n_copy_of = num_ssa_names;
 669   copy_of = XCNEWVEC (prop_value_t, n_copy_of);
 670
 671   FOR_EACH_BB (bb)
 672     {
 673       gimple_stmt_iterator si;
 674       int depth = bb_loop_depth (bb);
 675
 676       for (si = gsi_start_bb (bb); !gsi_end_p (si); gsi_next (&si))
 677         {
 678           gimple stmt = gsi_stmt (si);
 679           ssa_op_iter iter;
 680           tree def;
 681
 682           /* The only statements that we care about are those that may
 683              generate useful copies.  We also need to mark conditional
 684              jumps so that their outgoing edges are added to the work
 685              lists of the propagator.
 686
 687              Avoid copy propagation from an inner into an outer loop.
 688              Otherwise, this may move loop variant variables outside of
 689              their loops and prevent coalescing opportunities.  If the
 690              value was loop invariant, it will be hoisted by LICM and
 691              exposed for copy propagation.
 692              ???  This doesn't make sense.  */
 693           if (stmt_ends_bb_p (stmt))
 694             prop_set_simulate_again (stmt, true);
 695           else if (stmt_may_generate_copy (stmt)
 696                    /* Since we are iterating over the statements in
 697                       BB, not the phi nodes, STMT will always be an
 698                       assignment.  */
 699                    && loop_depth_of_name (gimple_assign_rhs1 (stmt)) <= depth)
 700             prop_set_simulate_again (stmt, true);
 701           else
 702             prop_set_simulate_again (stmt, false);
 703
 704           /* Mark all the outputs of this statement as not being
 705              the copy of anything.  */
 706           FOR_EACH_SSA_TREE_OPERAND (def, stmt, iter, SSA_OP_ALL_DEFS)
 707             if (!prop_simulate_again_p (stmt))
 708               set_copy_of_val (def, def);
 709         }
 710
 711       for (si = gsi_start_phis (bb); !gsi_end_p (si); gsi_next (&si))
 712         {
 713           gimple phi = gsi_stmt (si);
 714           tree def;
 715
 716           def = gimple_phi_result (phi);
 717           if (virtual_operand_p (def))
 718             prop_set_simulate_again (phi, false);
 719           else
 720             prop_set_simulate_again (phi, true);
 721
 722           if (!prop_simulate_again_p (phi))
 723             set_copy_of_val (def, def);
 724         }
 725     }
 726 }
 727
 728 /* Callback for substitute_and_fold to get at the final copy-of values.  */
 729
 730 static tree
 731 get_value (tree name)
 732 {
 733   tree val;
 734   if (SSA_NAME_VERSION (name) >= n_copy_of)
 735     return NULL_TREE;
 736   val = copy_of[SSA_NAME_VERSION (name)].value;
 737   if (val && val != name)
 738     return val;
 739   return NULL_TREE;
 740 }
 741
 742 /* Deallocate memory used in copy propagation and do final
 743    substitution.  */
 744
 745 static void
 746 fini_copy_prop (void)
 747 {
 748   unsigned i;
 749
 750   /* Set the final copy-of value for each variable by traversing the
 751      copy-of chains.  */
 752   for (i = 1; i < num_ssa_names; i++)
 753     {
 754       tree var = ssa_name (i);
 755       if (!var
 756           || !copy_of[i].value
 757           || copy_of[i].value == var)
 758         continue;
 759
 760       /* In theory the points-to solution of all members of the
 761          copy chain is their intersection.  For now we do not bother
 762          to compute this but only make sure we do not lose points-to
 763          information completely by setting the points-to solution
 764          of the representative to the first solution we find if
 765          it doesn't have one already.  */
 766       if (copy_of[i].value != var
 767           && TREE_CODE (copy_of[i].value) == SSA_NAME
 768           && POINTER_TYPE_P (TREE_TYPE (var))
 769           && SSA_NAME_PTR_INFO (var)
 770           && !SSA_NAME_PTR_INFO (copy_of[i].value))
 771         duplicate_ssa_name_ptr_info (copy_of[i].value, SSA_NAME_PTR_INFO (var));
 772     }
 773
 774   /* Don't do DCE if we have loops.  That's the simplest way to not
 775      destroy the scev cache.  */
 776   substitute_and_fold (get_value, NULL, !current_loops);
 777
 778   free (copy_of);
 779 }
 780
 781
 782 /* Main entry point to the copy propagator.
 783
 784    PHIS_ONLY is true if we should only consider PHI nodes as generating
 785    copy propagation opportunities.
 786
 787    The algorithm propagates the value COPY-OF using ssa_propagate.  For
 788    every variable X_i, COPY-OF(X_i) indicates which variable is X_i created
 789    from.  The following example shows how the algorithm proceeds at a
 790    high level:
 791
 792             1   a_24 = x_1
 793             2   a_2 = PHI <a_24, x_1>
 794             3   a_5 = PHI <a_2>
 795             4   x_1 = PHI <x_298, a_5, a_2>
 796
 797    The end result should be that a_2, a_5, a_24 and x_1 are a copy of
 798    x_298.  Propagation proceeds as follows.
 799
 800    Visit #1: a_24 is copy-of x_1.  Value changed.
 801    Visit #2: a_2 is copy-of x_1.  Value changed.
 802    Visit #3: a_5 is copy-of x_1.  Value changed.
 803    Visit #4: x_1 is copy-of x_298.  Value changed.
 804    Visit #1: a_24 is copy-of x_298.  Value changed.
 805    Visit #2: a_2 is copy-of x_298.  Value changed.
 806    Visit #3: a_5 is copy-of x_298.  Value changed.
 807    Visit #4: x_1 is copy-of x_298.  Stable state reached.
 808
 809    When visiting PHI nodes, we only consider arguments that flow
 810    through edges marked executable by the propagation engine.  So,
 811    when visiting statement #2 for the first time, we will only look at
 812    the first argument (a_24) and optimistically assume that its value
 813    is the copy of a_24 (x_1).  */
 814
 815 static unsigned int
 816 execute_copy_prop (void)
 817 {
 818   init_copy_prop ();
 819   ssa_propagate (copy_prop_visit_stmt, copy_prop_visit_phi_node);
 820   fini_copy_prop ();
 821   return 0;
 822 }
 823
 824 static bool
 825 gate_copy_prop (void)
 826 {
 827   return flag_tree_copy_prop != 0;
 828 }
 829
 830 struct gimple_opt_pass pass_copy_prop =
 831 {
 832  {
 833   GIMPLE_PASS,
 834   "copyprop",                           /* name */
 835   OPTGROUP_NONE,                        /* optinfo_flags */
 836   gate_copy_prop,                       /* gate */
 837   execute_copy_prop,                    /* execute */
 838   NULL,                                 /* sub */
 839   NULL,                                 /* next */
 840   0,                                    /* static_pass_number */
 841   TV_TREE_COPY_PROP,                    /* tv_id */
 842   PROP_ssa | PROP_cfg,                  /* properties_required */
 843   0,                                    /* properties_provided */
 844   0,                                    /* properties_destroyed */
 845   0,                                    /* todo_flags_start */
 846   TODO_cleanup_cfg
 847     | TODO_ggc_collect
 848     | TODO_verify_ssa
 849     | TODO_update_ssa                   /* todo_flags_finish */
 850  }
 851 };