gcc/tree-phinodes.c

   1 /* Generic routines for manipulating PHIs
   2    Copyright (C) 2003, 2005 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 2, 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 COPYING.  If not, write to
  18 the Free Software Foundation, 59 Temple Place - Suite 330,
  19 Boston, MA 02111-1307, USA.  */
  20
  21 #include "config.h"
  22 #include "system.h"
  23 #include "coretypes.h"
  24 #include "tm.h"
  25 #include "tree.h"
  26 #include "rtl.h"
  27 #include "varray.h"
  28 #include "ggc.h"
  29 #include "basic-block.h"
  30 #include "tree-flow.h"
  31 #include "toplev.h"
  32
  33 /* Rewriting a function into SSA form can create a huge number of PHIs
  34    many of which may be thrown away shortly after their creation if jumps
  35    were threaded through PHI nodes.
  36
  37    While our garbage collection mechanisms will handle this situation, it
  38    is extremely wasteful to create nodes and throw them away, especially
  39    when the nodes can be reused.
  40
  41    For PR 8361, we can significantly reduce the number of nodes allocated
  42    and thus the total amount of memory allocated by managing PHIs a
  43    little.  This additionally helps reduce the amount of work done by the
  44    garbage collector.  Similar results have been seen on a wider variety
  45    of tests (such as the compiler itself).
  46
  47    Right now we maintain our free list on a per-function basis.  It may
  48    or may not make sense to maintain the free list for the duration of
  49    a compilation unit.
  50
  51    We could also use a zone allocator for these objects since they have
  52    a very well defined lifetime.  If someone wants to experiment with that
  53    this is the place to try it.
  54
  55    PHI nodes have different sizes, so we can't have a single list of all
  56    the PHI nodes as it would be too expensive to walk down that list to
  57    find a PHI of a suitable size.
  58
  59    Instead we have an array of lists of free PHI nodes.  The array is
  60    indexed by the number of PHI alternatives that PHI node can hold.
  61    Except for the last array member, which holds all remaining PHI
  62    nodes.
  63
  64    So to find a free PHI node, we compute its index into the free PHI
  65    node array and see if there are any elements with an exact match.
  66    If so, then we are done.  Otherwise, we test the next larger size
  67    up and continue until we are in the last array element.
  68
  69    We do not actually walk members of the last array element.  While it
  70    might allow us to pick up a few reusable PHI nodes, it could potentially
  71    be very expensive if the program has released a bunch of large PHI nodes,
  72    but keeps asking for even larger PHI nodes.  Experiments have shown that
  73    walking the elements of the last array entry would result in finding less
  74    than .1% additional reusable PHI nodes.
  75
  76    Note that we can never have less than two PHI argument slots.  Thus,
  77    the -2 on all the calculations below.  */
  78
  79 #define NUM_BUCKETS 10
  80 static GTY ((deletable (""))) tree free_phinodes[NUM_BUCKETS - 2];
  81 static unsigned long free_phinode_count;
  82
  83 static int ideal_phi_node_len (int);
  84 static void resize_phi_node (tree *, int);
  85
  86 #ifdef GATHER_STATISTICS
  87 unsigned int phi_nodes_reused;
  88 unsigned int phi_nodes_created;
  89 #endif
  90
  91 /* Initialize management of PHIs.  */
  92
  93 void
  94 init_phinodes (void)
  95 {
  96   int i;
  97
  98   for (i = 0; i < NUM_BUCKETS - 2; i++)
  99     free_phinodes[i] = NULL;
 100   free_phinode_count = 0;
 101 }
 102
 103 /* Finalize management of PHIs.  */
 104
 105 void
 106 fini_phinodes (void)
 107 {
 108   int i;
 109
 110   for (i = 0; i < NUM_BUCKETS - 2; i++)
 111     free_phinodes[i] = NULL;
 112   free_phinode_count = 0;
 113 }
 114
 115 /* Dump some simple statistics regarding the re-use of PHI nodes.  */
 116
 117 #ifdef GATHER_STATISTICS
 118 void
 119 phinodes_print_statistics (void)
 120 {
 121   fprintf (stderr, "PHI nodes allocated: %u\n", phi_nodes_created);
 122   fprintf (stderr, "PHI nodes reused: %u\n", phi_nodes_reused);
 123 }
 124 #endif
 125
 126 /* Allocate a PHI node with at least LEN arguments.  If the free list
 127    happens to contain a PHI node with LEN arguments or more, return
 128    that one.  */
 129
 130 static inline tree
 131 allocate_phi_node (int len)
 132 {
 133   tree phi;
 134   int bucket = NUM_BUCKETS - 2;
 135   int size = (sizeof (struct tree_phi_node)
 136               + (len - 1) * sizeof (struct phi_arg_d));
 137
 138   if (free_phinode_count)
 139     for (bucket = len - 2; bucket < NUM_BUCKETS - 2; bucket++)
 140       if (free_phinodes[bucket])
 141         break;
 142
 143   /* If our free list has an element, then use it.  */
 144   if (bucket < NUM_BUCKETS - 2
 145       && PHI_ARG_CAPACITY (free_phinodes[bucket]) >= len)
 146     {
 147       free_phinode_count--;
 148       phi = free_phinodes[bucket];
 149       free_phinodes[bucket] = PHI_CHAIN (free_phinodes[bucket]);
 150 #ifdef GATHER_STATISTICS
 151       phi_nodes_reused++;
 152 #endif
 153     }
 154   else
 155     {
 156       phi = ggc_alloc (size);
 157 #ifdef GATHER_STATISTICS
 158       phi_nodes_created++;
 159       tree_node_counts[(int) phi_kind]++;
 160       tree_node_sizes[(int) phi_kind] += size;
 161 #endif
 162     }
 163
 164   return phi;
 165 }
 166
 167 /* Given LEN, the original number of requested PHI arguments, return
 168    a new, "ideal" length for the PHI node.  The "ideal" length rounds
 169    the total size of the PHI node up to the next power of two bytes.
 170
 171    Rounding up will not result in wasting any memory since the size request
 172    will be rounded up by the GC system anyway.  [ Note this is not entirely
 173    true since the original length might have fit on one of the special
 174    GC pages. ]  By rounding up, we may avoid the need to reallocate the
 175    PHI node later if we increase the number of arguments for the PHI.  */
 176
 177 static int
 178 ideal_phi_node_len (int len)
 179 {
 180   size_t size, new_size;
 181   int log2, new_len;
 182
 183   /* We do not support allocations of less than two PHI argument slots.  */
 184   if (len < 2)
 185     len = 2;
 186
 187   /* Compute the number of bytes of the original request.  */
 188   size = sizeof (struct tree_phi_node) + (len - 1) * sizeof (struct phi_arg_d);
 189
 190   /* Round it up to the next power of two.  */
 191   log2 = ceil_log2 (size);
 192   new_size = 1 << log2;
 193
 194   /* Now compute and return the number of PHI argument slots given an
 195      ideal size allocation.  */
 196   new_len = len + (new_size - size) / sizeof (struct phi_arg_d);
 197   return new_len;
 198 }
 199
 200 /* Return a PHI node for variable VAR defined in statement STMT.
 201    STMT may be an empty statement for artificial references (e.g., default
 202    definitions created when a variable is used without a preceding
 203    definition).  */
 204
 205 static tree
 206 make_phi_node (tree var, int len)
 207 {
 208   tree phi;
 209   int capacity, i;
 210
 211   capacity = ideal_phi_node_len (len);
 212
 213   phi = allocate_phi_node (capacity);
 214
 215   /* We need to clear the entire PHI node, including the argument
 216      portion, because we represent a "missing PHI argument" by placing
 217      NULL_TREE in PHI_ARG_DEF.  */
 218   memset (phi, 0, (sizeof (struct tree_phi_node) - sizeof (struct phi_arg_d)
 219                    + sizeof (struct phi_arg_d) * len));
 220   TREE_SET_CODE (phi, PHI_NODE);
 221   PHI_NUM_ARGS (phi) = len;
 222   PHI_ARG_CAPACITY (phi) = capacity;
 223   TREE_TYPE (phi) = TREE_TYPE (var);
 224   if (TREE_CODE (var) == SSA_NAME)
 225     SET_PHI_RESULT (phi, var);
 226   else
 227     SET_PHI_RESULT (phi, make_ssa_name (var, phi));
 228
 229   for (i = 0; i < capacity; i++)
 230     {
 231       ssa_imm_use_t * imm;
 232       imm = &(PHI_ARG_IMM_USE_NODE (phi, i));
 233       imm->use = &(PHI_ARG_DEF_TREE (phi, i));
 234       imm->prev = NULL;
 235       imm->next = NULL;
 236       imm->stmt = phi;
 237     }
 238   return phi;
 239 }
 240
 241 /* We no longer need PHI, release it so that it may be reused.  */
 242
 243 void
 244 release_phi_node (tree phi)
 245 {
 246   int bucket;
 247   int len = PHI_ARG_CAPACITY (phi);
 248   int x;
 249
 250   for (x = 0; x < PHI_NUM_ARGS (phi); x++)
 251     {
 252       ssa_imm_use_t * imm;
 253       imm = &(PHI_ARG_IMM_USE_NODE (phi, x));
 254       delink_imm_use (imm);
 255     }
 256
 257   bucket = len > NUM_BUCKETS - 1 ? NUM_BUCKETS - 1 : len;
 258   bucket -= 2;
 259   PHI_CHAIN (phi) = free_phinodes[bucket];
 260   free_phinodes[bucket] = phi;
 261   free_phinode_count++;
 262 }
 263
 264 /* Resize an existing PHI node.  The only way is up.  Return the
 265    possibly relocated phi.  */
 266
 267 static void
 268 resize_phi_node (tree *phi, int len)
 269 {
 270   int old_size, i;
 271   tree new_phi;
 272
 273   gcc_assert (len > PHI_ARG_CAPACITY (*phi));
 274
 275   /* The garbage collector will not look at the PHI node beyond the
 276      first PHI_NUM_ARGS elements.  Therefore, all we have to copy is a
 277      portion of the PHI node currently in use.  */
 278   old_size = (sizeof (struct tree_phi_node)
 279              + (PHI_NUM_ARGS (*phi) - 1) * sizeof (struct phi_arg_d));
 280
 281   new_phi = allocate_phi_node (len);
 282
 283   memcpy (new_phi, *phi, old_size);
 284
 285   for (i = 0; i < PHI_NUM_ARGS (new_phi); i++)
 286     {
 287       ssa_imm_use_t *imm, *old_imm;
 288       imm = &(PHI_ARG_IMM_USE_NODE (new_phi, i));
 289       old_imm = &(PHI_ARG_IMM_USE_NODE (*phi, i));
 290       imm->use = &(PHI_ARG_DEF_TREE (new_phi, i));
 291       relink_imm_use_stmt (imm, old_imm, new_phi);
 292     }
 293
 294   PHI_ARG_CAPACITY (new_phi) = len;
 295
 296   for (i = PHI_NUM_ARGS (new_phi); i < len; i++)
 297     {
 298       ssa_imm_use_t * imm;
 299       imm = &(PHI_ARG_IMM_USE_NODE (new_phi, i));
 300       imm->use = &(PHI_ARG_DEF_TREE (new_phi, i));
 301       imm->prev = NULL;
 302       imm->next = NULL;
 303       imm->stmt = new_phi;
 304     }
 305
 306
 307   *phi = new_phi;
 308 }
 309
 310 /* Reserve PHI arguments for a new edge to basic block BB.  */
 311
 312 void
 313 reserve_phi_args_for_new_edge (basic_block bb)
 314 {
 315   tree *loc;
 316   int len = EDGE_COUNT (bb->preds);
 317   int cap = ideal_phi_node_len (len + 4);
 318
 319   for (loc = &(bb_ann (bb)->phi_nodes);
 320        *loc;
 321        loc = &PHI_CHAIN (*loc))
 322     {
 323       if (len > PHI_ARG_CAPACITY (*loc))
 324         {
 325           tree old_phi = *loc;
 326
 327           resize_phi_node (loc, cap);
 328
 329           /* The result of the phi is defined by this phi node.  */
 330           SSA_NAME_DEF_STMT (PHI_RESULT (*loc)) = *loc;
 331
 332           release_phi_node (old_phi);
 333         }
 334
 335       /* We represent a "missing PHI argument" by placing NULL_TREE in
 336          the corresponding slot.  If PHI arguments were added
 337          immediately after an edge is created, this zeroing would not
 338          be necessary, but unfortunately this is not the case.  For
 339          example, the loop optimizer duplicates several basic blocks,
 340          redirects edges, and then fixes up PHI arguments later in
 341          batch.  */
 342       SET_PHI_ARG_DEF (*loc, len - 1, NULL_TREE);
 343
 344       PHI_NUM_ARGS (*loc)++;
 345     }
 346 }
 347
 348 /* Create a new PHI node for variable VAR at basic block BB.  */
 349
 350 tree
 351 create_phi_node (tree var, basic_block bb)
 352 {
 353   tree phi;
 354
 355   phi = make_phi_node (var, EDGE_COUNT (bb->preds));
 356
 357   /* Add the new PHI node to the list of PHI nodes for block BB.  */
 358   PHI_CHAIN (phi) = phi_nodes (bb);
 359   bb_ann (bb)->phi_nodes = phi;
 360
 361   /* Associate BB to the PHI node.  */
 362   set_bb_for_stmt (phi, bb);
 363
 364   return phi;
 365 }
 366
 367 /* Add a new argument to PHI node PHI.  DEF is the incoming reaching
 368    definition and E is the edge through which DEF reaches PHI.  The new
 369    argument is added at the end of the argument list.
 370    If PHI has reached its maximum capacity, add a few slots.  In this case,
 371    PHI points to the reallocated phi node when we return.  */
 372
 373 void
 374 add_phi_arg (tree phi, tree def, edge e)
 375 {
 376   basic_block bb = e->dest;
 377
 378   gcc_assert (bb == bb_for_stmt (phi));
 379
 380   /* We resize PHI nodes upon edge creation.  We should always have
 381      enough room at this point.  */
 382   gcc_assert (PHI_NUM_ARGS (phi) <= PHI_ARG_CAPACITY (phi));
 383
 384   /* We resize PHI nodes upon edge creation.  We should always have
 385      enough room at this point.  */
 386   gcc_assert (e->dest_idx < (unsigned int) PHI_NUM_ARGS (phi));
 387
 388   /* Copy propagation needs to know what object occur in abnormal
 389      PHI nodes.  This is a convenient place to record such information.  */
 390   if (e->flags & EDGE_ABNORMAL)
 391     {
 392       SSA_NAME_OCCURS_IN_ABNORMAL_PHI (def) = 1;
 393       SSA_NAME_OCCURS_IN_ABNORMAL_PHI (PHI_RESULT (phi)) = 1;
 394     }
 395
 396   SET_PHI_ARG_DEF (phi, e->dest_idx, def);
 397   PHI_ARG_NONZERO (phi, e->dest_idx) = false;
 398 }
 399
 400 /* Remove the Ith argument from PHI's argument list.  This routine
 401    implements removal by swapping the last alternative with the
 402    alternative we want to delete and then shrinking the vector, which
 403    is consistent with how we remove an edge from the edge vector.  */
 404
 405 static void
 406 remove_phi_arg_num (tree phi, int i)
 407 {
 408   int num_elem = PHI_NUM_ARGS (phi);
 409
 410   gcc_assert (i < num_elem);
 411
 412   /* Delink the last item, which is being removed.  */
 413   delink_imm_use (&(PHI_ARG_IMM_USE_NODE (phi, num_elem - 1)));
 414
 415   /* If we are not at the last element, switch the last element
 416      with the element we want to delete.  */
 417   if (i != num_elem - 1)
 418     {
 419       SET_PHI_ARG_DEF (phi, i, PHI_ARG_DEF (phi, num_elem - 1));
 420       PHI_ARG_NONZERO (phi, i) = PHI_ARG_NONZERO (phi, num_elem - 1);
 421     }
 422
 423   /* Shrink the vector and return.  Note that we do not have to clear
 424      PHI_ARG_DEF or PHI_ARG_NONZERO because the garbage collector will
 425      not look at those elements beyond the first PHI_NUM_ARGS elements
 426      of the array.  */
 427   PHI_NUM_ARGS (phi)--;
 428 }
 429
 430 /* Remove all PHI arguments associated with edge E.  */
 431
 432 void
 433 remove_phi_args (edge e)
 434 {
 435   tree phi;
 436
 437   for (phi = phi_nodes (e->dest); phi; phi = PHI_CHAIN (phi))
 438     remove_phi_arg_num (phi, e->dest_idx);
 439 }
 440
 441 /* Remove PHI node PHI from basic block BB.  If PREV is non-NULL, it is
 442    used as the node immediately before PHI in the linked list.  */
 443
 444 void
 445 remove_phi_node (tree phi, tree prev)
 446 {
 447   tree *loc;
 448
 449   if (prev)
 450     {
 451       loc = &PHI_CHAIN (prev);
 452     }
 453   else
 454     {
 455       for (loc = &(bb_ann (bb_for_stmt (phi))->phi_nodes);
 456            *loc != phi;
 457            loc = &PHI_CHAIN (*loc))
 458         ;
 459     }
 460
 461   /* Remove PHI from the chain.  */
 462   *loc = PHI_CHAIN (phi);
 463
 464   /* If we are deleting the PHI node, then we should release the
 465      SSA_NAME node so that it can be reused.  */
 466   release_phi_node (phi);
 467   release_ssa_name (PHI_RESULT (phi));
 468 }
 469
 470
 471 /* Remove all the PHI nodes for variables in the VARS bitmap.  */
 472
 473 void
 474 remove_all_phi_nodes_for (bitmap vars)
 475 {
 476   basic_block bb;
 477
 478   FOR_EACH_BB (bb)
 479     {
 480       /* Build a new PHI list for BB without variables in VARS.  */
 481       tree phi, new_phi_list, next;
 482       tree *lastp = &new_phi_list;
 483
 484       for (phi = phi_nodes (bb); phi; phi = next)
 485         {
 486           tree var = SSA_NAME_VAR (PHI_RESULT (phi));
 487
 488           next = PHI_CHAIN (phi);
 489           /* Only add PHI nodes for variables not in VARS.  */
 490           if (!bitmap_bit_p (vars, var_ann (var)->uid))
 491             {
 492               /* If we're not removing this PHI node, then it must have
 493                  been rewritten by a previous call into the SSA rewriter.
 494                  Note that fact in PHI_REWRITTEN.  */
 495               PHI_REWRITTEN (phi) = 1;
 496
 497               *lastp = phi;
 498               lastp = &PHI_CHAIN (phi);
 499             }
 500           else
 501             {
 502               /* If we are deleting the PHI node, then we should release the
 503                  SSA_NAME node so that it can be reused.  */
 504               release_phi_node (phi);
 505               release_ssa_name (PHI_RESULT (phi));
 506             }
 507         }
 508
 509       /* Make sure the last node in the new list has no successors.  */
 510       *lastp = NULL;
 511       bb_ann (bb)->phi_nodes = new_phi_list;
 512
 513 #if defined ENABLE_CHECKING
 514       for (phi = phi_nodes (bb); phi; phi = PHI_CHAIN (phi))
 515         {
 516           tree var = SSA_NAME_VAR (PHI_RESULT (phi));
 517           gcc_assert (!bitmap_bit_p (vars, var_ann (var)->uid));
 518         }
 519 #endif
 520     }
 521 }
 522
 523 /* Reverse the order of PHI nodes in the chain PHI.
 524    Return the new head of the chain (old last PHI node).  */
 525
 526 tree
 527 phi_reverse (tree phi)
 528 {
 529   tree prev = NULL_TREE, next;
 530   for (; phi; phi = next)
 531     {
 532       next = PHI_CHAIN (phi);
 533       PHI_CHAIN (phi) = prev;
 534       prev = phi;
 535     }
 536   return prev;
 537 }
 538
 539 #include "gt-tree-phinodes.h"
 540