gcc/ipa.c

   1 /* Basic IPA optimizations and utilities.
   2    Copyright (C) 2003, 2004, 2005, 2007, 2008 Free Software Foundation,
   3    Inc.
   4
   5 This file is part of GCC.
   6
   7 GCC is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 3, or (at your option) any later
  10 version.
  11
  12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GCC; see the file COPYING3.  If not see
  19 <http://www.gnu.org/licenses/>.  */
  20
  21 #include "config.h"
  22 #include "system.h"
  23 #include "coretypes.h"
  24 #include "tm.h"
  25 #include "cgraph.h"
  26 #include "tree-pass.h"
  27 #include "timevar.h"
  28 #include "gimple.h"
  29 #include "ggc.h"
  30
  31 /* Fill array order with all nodes with output flag set in the reverse
  32    topological order.  */
  33
  34 int
  35 cgraph_postorder (struct cgraph_node **order)
  36 {
  37   struct cgraph_node *node, *node2;
  38   int stack_size = 0;
  39   int order_pos = 0;
  40   struct cgraph_edge *edge, last;
  41   int pass;
  42
  43   struct cgraph_node **stack =
  44     XCNEWVEC (struct cgraph_node *, cgraph_n_nodes);
  45
  46   /* We have to deal with cycles nicely, so use a depth first traversal
  47      output algorithm.  Ignore the fact that some functions won't need
  48      to be output and put them into order as well, so we get dependencies
  49      right through inline functions.  */
  50   for (node = cgraph_nodes; node; node = node->next)
  51     node->aux = NULL;
  52   for (pass = 0; pass < 2; pass++)
  53     for (node = cgraph_nodes; node; node = node->next)
  54       if (!node->aux
  55           && (pass
  56               || (!cgraph_only_called_directly_p (node)
  57                   && !node->address_taken)))
  58         {
  59           node2 = node;
  60           if (!node->callers)
  61             node->aux = &last;
  62           else
  63             node->aux = node->callers;
  64           while (node2)
  65             {
  66               while (node2->aux != &last)
  67                 {
  68                   edge = (struct cgraph_edge *) node2->aux;
  69                   if (edge->next_caller)
  70                     node2->aux = edge->next_caller;
  71                   else
  72                     node2->aux = &last;
  73                   if (!edge->caller->aux)
  74                     {
  75                       if (!edge->caller->callers)
  76                         edge->caller->aux = &last;
  77                       else
  78                         edge->caller->aux = edge->caller->callers;
  79                       stack[stack_size++] = node2;
  80                       node2 = edge->caller;
  81                       break;
  82                     }
  83                 }
  84               if (node2->aux == &last)
  85                 {
  86                   order[order_pos++] = node2;
  87                   if (stack_size)
  88                     node2 = stack[--stack_size];
  89                   else
  90                     node2 = NULL;
  91                 }
  92             }
  93         }
  94   free (stack);
  95   for (node = cgraph_nodes; node; node = node->next)
  96     node->aux = NULL;
  97   return order_pos;
  98 }
  99
 100 /* Look for all functions inlined to NODE and update their inlined_to pointers
 101    to INLINED_TO.  */
 102
 103 static void
 104 update_inlined_to_pointer (struct cgraph_node *node, struct cgraph_node *inlined_to)
 105 {
 106   struct cgraph_edge *e;
 107   for (e = node->callees; e; e = e->next_callee)
 108     if (e->callee->global.inlined_to)
 109       {
 110         e->callee->global.inlined_to = inlined_to;
 111         update_inlined_to_pointer (e->callee, inlined_to);
 112       }
 113 }
 114
 115 /* Perform reachability analysis and reclaim all unreachable nodes.
 116    If BEFORE_INLINING_P is true this function is called before inlining
 117    decisions has been made.  If BEFORE_INLINING_P is false this function also
 118    removes unneeded bodies of extern inline functions.  */
 119
 120 bool
 121 cgraph_remove_unreachable_nodes (bool before_inlining_p, FILE *file)
 122 {
 123   struct cgraph_node *first = (struct cgraph_node *) (void *) 1;
 124   struct cgraph_node *node, *next;
 125   bool changed = false;
 126
 127 #ifdef ENABLE_CHECKING
 128   verify_cgraph ();
 129 #endif
 130   if (file)
 131     fprintf (file, "\nReclaiming functions:");
 132 #ifdef ENABLE_CHECKING
 133   for (node = cgraph_nodes; node; node = node->next)
 134     gcc_assert (!node->aux);
 135 #endif
 136   for (node = cgraph_nodes; node; node = node->next)
 137     if (!cgraph_can_remove_if_no_direct_calls_p (node)
 138         && ((!DECL_EXTERNAL (node->decl))
 139             || !node->analyzed
 140             || before_inlining_p))
 141       {
 142         gcc_assert (!node->global.inlined_to);
 143         node->aux = first;
 144         first = node;
 145       }
 146     else
 147       gcc_assert (!node->aux);
 148
 149   /* Perform reachability analysis.  As a special case do not consider
 150      extern inline functions not inlined as live because we won't output
 151      them at all.  */
 152   while (first != (void *) 1)
 153     {
 154       struct cgraph_edge *e;
 155       node = first;
 156       first = (struct cgraph_node *) first->aux;
 157
 158       for (e = node->callees; e; e = e->next_callee)
 159         if (!e->callee->aux
 160             && node->analyzed
 161             && (!e->inline_failed || !e->callee->analyzed
 162                 || (!DECL_EXTERNAL (e->callee->decl))
 163                 || before_inlining_p))
 164           {
 165             e->callee->aux = first;
 166             first = e->callee;
 167           }
 168       while (node->clone_of && !node->clone_of->aux && !gimple_has_body_p (node->decl))
 169         {
 170           node = node->clone_of;
 171           node->aux = first;
 172           first = node;
 173         }
 174     }
 175
 176   /* Remove unreachable nodes.  Extern inline functions need special care;
 177      Unreachable extern inline functions shall be removed.
 178      Reachable extern inline functions we never inlined shall get their bodies
 179      eliminated.
 180      Reachable extern inline functions we sometimes inlined will be turned into
 181      unanalyzed nodes so they look like for true extern functions to the rest
 182      of code.  Body of such functions is released via remove_node once the
 183      inline clones are eliminated.  */
 184   for (node = cgraph_nodes; node; node = next)
 185     {
 186       next = node->next;
 187       if (!node->aux)
 188         {
 189           node->global.inlined_to = NULL;
 190           if (file)
 191             fprintf (file, " %s", cgraph_node_name (node));
 192           if (!node->analyzed || !DECL_EXTERNAL (node->decl)
 193               || before_inlining_p)
 194             cgraph_remove_node (node);
 195           else
 196             {
 197               struct cgraph_edge *e;
 198
 199               /* See if there is reachable caller.  */
 200               for (e = node->callers; e; e = e->next_caller)
 201                 if (e->caller->aux)
 202                   break;
 203
 204               /* If so, we need to keep node in the callgraph.  */
 205               if (e || node->needed)
 206                 {
 207                   struct cgraph_node *clone;
 208
 209                   /* If there are still clones, we must keep body around.
 210                      Otherwise we can just remove the body but keep the clone.  */
 211                   for (clone = node->clones; clone;
 212                        clone = clone->next_sibling_clone)
 213                     if (clone->aux)
 214                       break;
 215                   if (!clone)
 216                     {
 217                       cgraph_release_function_body (node);
 218                       cgraph_node_remove_callees (node);
 219                       node->analyzed = false;
 220                       node->local.inlinable = false;
 221                     }
 222                 }
 223               else
 224                 cgraph_remove_node (node);
 225             }
 226           changed = true;
 227         }
 228     }
 229   for (node = cgraph_nodes; node; node = node->next)
 230     {
 231       /* Inline clones might be kept around so their materializing allows further
 232          cloning.  If the function the clone is inlined into is removed, we need
 233          to turn it into normal cone.  */
 234       if (node->global.inlined_to
 235           && !node->callers)
 236         {
 237           gcc_assert (node->clones);
 238           node->global.inlined_to = NULL;
 239           update_inlined_to_pointer (node, node);
 240         }
 241       node->aux = NULL;
 242     }
 243 #ifdef ENABLE_CHECKING
 244   verify_cgraph ();
 245 #endif
 246
 247   /* Reclaim alias pairs for functions that have disappeared from the
 248      call graph.  */
 249   remove_unreachable_alias_pairs ();
 250
 251   return changed;
 252 }
 253
 254 static bool
 255 cgraph_externally_visible_p (struct cgraph_node *node, bool whole_program)
 256 {
 257   if (!node->local.finalized)
 258     return false;
 259   if (!DECL_COMDAT (node->decl)
 260       && (!TREE_PUBLIC (node->decl) || DECL_EXTERNAL (node->decl)))
 261     return false;
 262   if (!whole_program)
 263     return true;
 264   /* COMDAT functions must be shared only if they have address taken,
 265      otherwise we can produce our own private implementation with
 266      -fwhole-program.  */
 267   if (DECL_COMDAT (node->decl) && (node->address_taken || !node->analyzed))
 268     return true;
 269   if (MAIN_NAME_P (DECL_NAME (node->decl)))
 270     return true;
 271   if (lookup_attribute ("externally_visible", DECL_ATTRIBUTES (node->decl)))
 272     return true;
 273   return false;
 274 }
 275
 276 /* Mark visibility of all functions.
 277
 278    A local function is one whose calls can occur only in the current
 279    compilation unit and all its calls are explicit, so we can change
 280    its calling convention.  We simply mark all static functions whose
 281    address is not taken as local.
 282
 283    We also change the TREE_PUBLIC flag of all declarations that are public
 284    in language point of view but we want to overwrite this default
 285    via visibilities for the backend point of view.  */
 286
 287 static unsigned int
 288 function_and_variable_visibility (bool whole_program)
 289 {
 290   struct cgraph_node *node;
 291   struct varpool_node *vnode;
 292
 293   for (node = cgraph_nodes; node; node = node->next)
 294     {
 295       if (cgraph_externally_visible_p (node, whole_program))
 296         {
 297           gcc_assert (!node->global.inlined_to);
 298           node->local.externally_visible = true;
 299         }
 300       else
 301         node->local.externally_visible = false;
 302       if (!node->local.externally_visible && node->analyzed
 303           && !DECL_EXTERNAL (node->decl))
 304         {
 305           gcc_assert (whole_program || !TREE_PUBLIC (node->decl));
 306           TREE_PUBLIC (node->decl) = 0;
 307           DECL_COMDAT (node->decl) = 0;
 308           DECL_WEAK (node->decl) = 0;
 309         }
 310       node->local.local = (cgraph_only_called_directly_p (node)
 311                            && node->analyzed
 312                            && !DECL_EXTERNAL (node->decl)
 313                            && !node->local.externally_visible);
 314     }
 315   for (vnode = varpool_nodes_queue; vnode; vnode = vnode->next_needed)
 316     {
 317       if (!vnode->finalized)
 318         continue;
 319       if (vnode->needed
 320           && (DECL_COMDAT (vnode->decl) || TREE_PUBLIC (vnode->decl))
 321           && (!whole_program
 322               /* We can privatize comdat readonly variables whose address is not taken,
 323                  but doing so is not going to bring us optimization oppurtunities until
 324                  we start reordering datastructures.  */
 325               || DECL_COMDAT (vnode->decl)
 326               || DECL_WEAK (vnode->decl)
 327               || lookup_attribute ("externally_visible",
 328                                    DECL_ATTRIBUTES (vnode->decl))))
 329         vnode->externally_visible = true;
 330       else
 331         vnode->externally_visible = false;
 332       if (!vnode->externally_visible)
 333         {
 334           gcc_assert (whole_program || !TREE_PUBLIC (vnode->decl));
 335           TREE_PUBLIC (vnode->decl) = 0;
 336         }
 337      gcc_assert (TREE_STATIC (vnode->decl));
 338     }
 339
 340   if (dump_file)
 341     {
 342       fprintf (dump_file, "\nMarking local functions:");
 343       for (node = cgraph_nodes; node; node = node->next)
 344         if (node->local.local)
 345           fprintf (dump_file, " %s", cgraph_node_name (node));
 346       fprintf (dump_file, "\n\n");
 347       fprintf (dump_file, "\nMarking externally visible functions:");
 348       for (node = cgraph_nodes; node; node = node->next)
 349         if (node->local.externally_visible)
 350           fprintf (dump_file, " %s", cgraph_node_name (node));
 351       fprintf (dump_file, "\n\n");
 352     }
 353   cgraph_function_flags_ready = true;
 354   return 0;
 355 }
 356
 357 /* Local function pass handling visibilities.  This happens before LTO streaming
 358    so in particular -fwhole-program should be ignored at this level.  */
 359
 360 static unsigned int
 361 local_function_and_variable_visibility (void)
 362 {
 363   return function_and_variable_visibility (flag_whole_program && !flag_lto && !flag_whopr);
 364 }
 365
 366 struct simple_ipa_opt_pass pass_ipa_function_and_variable_visibility =
 367 {
 368  {
 369   SIMPLE_IPA_PASS,
 370   "visibility",                         /* name */
 371   NULL,                                 /* gate */
 372   local_function_and_variable_visibility,/* execute */
 373   NULL,                                 /* sub */
 374   NULL,                                 /* next */
 375   0,                                    /* static_pass_number */
 376   TV_CGRAPHOPT,                         /* tv_id */
 377   0,                                    /* properties_required */
 378   0,                                    /* properties_provided */
 379   0,                                    /* properties_destroyed */
 380   0,                                    /* todo_flags_start */
 381   TODO_remove_functions | TODO_dump_cgraph/* todo_flags_finish */
 382  }
 383 };
 384
 385 /* Do not re-run on ltrans stage.  */
 386
 387 static bool
 388 gate_whole_program_function_and_variable_visibility (void)
 389 {
 390   return !flag_ltrans;
 391 }
 392
 393 /* Bring functionss local at LTO time whith -fwhole-program.  */
 394
 395 static unsigned int
 396 whole_program_function_and_variable_visibility (void)
 397 {
 398   struct cgraph_node *node;
 399   struct varpool_node *vnode;
 400
 401   function_and_variable_visibility (flag_whole_program);
 402
 403   for (node = cgraph_nodes; node; node = node->next)
 404     if ((node->local.externally_visible && !DECL_COMDAT (node->decl))
 405         && node->local.finalized)
 406       cgraph_mark_needed_node (node);
 407   for (vnode = varpool_nodes_queue; vnode; vnode = vnode->next_needed)
 408     if (vnode->externally_visible && !DECL_COMDAT (vnode->decl))
 409       varpool_mark_needed_node (vnode);
 410   return 0;
 411 }
 412
 413 struct ipa_opt_pass_d pass_ipa_whole_program_visibility =
 414 {
 415  {
 416   IPA_PASS,
 417   "whole-program",                      /* name */
 418   gate_whole_program_function_and_variable_visibility,/* gate */
 419   whole_program_function_and_variable_visibility,/* execute */
 420   NULL,                                 /* sub */
 421   NULL,                                 /* next */
 422   0,                                    /* static_pass_number */
 423   TV_CGRAPHOPT,                         /* tv_id */
 424   0,                                    /* properties_required */
 425   0,                                    /* properties_provided */
 426   0,                                    /* properties_destroyed */
 427   0,                                    /* todo_flags_start */
 428   TODO_dump_cgraph | TODO_remove_functions/* todo_flags_finish */
 429  },
 430  NULL,                                  /* generate_summary */
 431  NULL,                                  /* write_summary */
 432  NULL,                                  /* read_summary */
 433  NULL,                                  /* function_read_summary */
 434  NULL,                                  /* stmt_fixup */
 435  0,                                     /* TODOs */
 436  NULL,                                  /* function_transform */
 437  NULL,                                  /* variable_transform */
 438 };
 439
 440 /* Hash a cgraph node set element.  */
 441
 442 static hashval_t
 443 hash_cgraph_node_set_element (const void *p)
 444 {
 445   const_cgraph_node_set_element element = (const_cgraph_node_set_element) p;
 446   return htab_hash_pointer (element->node);
 447 }
 448
 449 /* Compare two cgraph node set elements.  */
 450
 451 static int
 452 eq_cgraph_node_set_element (const void *p1, const void *p2)
 453 {
 454   const_cgraph_node_set_element e1 = (const_cgraph_node_set_element) p1;
 455   const_cgraph_node_set_element e2 = (const_cgraph_node_set_element) p2;
 456
 457   return e1->node == e2->node;
 458 }
 459
 460 /* Create a new cgraph node set.  */
 461
 462 cgraph_node_set
 463 cgraph_node_set_new (void)
 464 {
 465   cgraph_node_set new_node_set;
 466
 467   new_node_set = GGC_NEW (struct cgraph_node_set_def);
 468   new_node_set->hashtab = htab_create_ggc (10,
 469                                            hash_cgraph_node_set_element,
 470                                            eq_cgraph_node_set_element,
 471                                            NULL);
 472   new_node_set->nodes = NULL;
 473   return new_node_set;
 474 }
 475
 476 /* Add cgraph_node NODE to cgraph_node_set SET.  */
 477
 478 void
 479 cgraph_node_set_add (cgraph_node_set set, struct cgraph_node *node)
 480 {
 481   void **slot;
 482   cgraph_node_set_element element;
 483   struct cgraph_node_set_element_def dummy;
 484
 485   dummy.node = node;
 486   slot = htab_find_slot (set->hashtab, &dummy, INSERT);
 487
 488   if (*slot != HTAB_EMPTY_ENTRY)
 489     {
 490       element = (cgraph_node_set_element) *slot;
 491       gcc_assert (node == element->node
 492                   && (VEC_index (cgraph_node_ptr, set->nodes, element->index)
 493                       == node));
 494       return;
 495     }
 496
 497   /* Insert node into hash table.  */
 498   element =
 499     (cgraph_node_set_element) GGC_NEW (struct cgraph_node_set_element_def);
 500   element->node = node;
 501   element->index = VEC_length (cgraph_node_ptr, set->nodes);
 502   *slot = element;
 503
 504   /* Insert into node vector.  */
 505   VEC_safe_push (cgraph_node_ptr, gc, set->nodes, node);
 506 }
 507
 508 /* Remove cgraph_node NODE from cgraph_node_set SET.  */
 509
 510 void
 511 cgraph_node_set_remove (cgraph_node_set set, struct cgraph_node *node)
 512 {
 513   void **slot, **last_slot;
 514   cgraph_node_set_element element, last_element;
 515   struct cgraph_node *last_node;
 516   struct cgraph_node_set_element_def dummy;
 517
 518   dummy.node = node;
 519   slot = htab_find_slot (set->hashtab, &dummy, NO_INSERT);
 520   if (slot == NULL)
 521     return;
 522
 523   element = (cgraph_node_set_element) *slot;
 524   gcc_assert (VEC_index (cgraph_node_ptr, set->nodes, element->index)
 525               == node);
 526
 527   /* Remove from vector. We do this by swapping node with the last element
 528      of the vector.  */
 529   last_node = VEC_pop (cgraph_node_ptr, set->nodes);
 530   if (last_node != node)
 531     {
 532       dummy.node = last_node;
 533       last_slot = htab_find_slot (set->hashtab, &dummy, NO_INSERT);
 534       last_element = (cgraph_node_set_element) *last_slot;
 535       gcc_assert (last_element);
 536
 537       /* Move the last element to the original spot of NODE.  */
 538       last_element->index = element->index;
 539       VEC_replace (cgraph_node_ptr, set->nodes, last_element->index,
 540                    last_node);
 541     }
 542
 543   /* Remove element from hash table.  */
 544   htab_clear_slot (set->hashtab, slot);
 545   ggc_free (element);
 546 }
 547
 548 /* Find NODE in SET and return an iterator to it if found.  A null iterator
 549    is returned if NODE is not in SET.  */
 550
 551 cgraph_node_set_iterator
 552 cgraph_node_set_find (cgraph_node_set set, struct cgraph_node *node)
 553 {
 554   void **slot;
 555   struct cgraph_node_set_element_def dummy;
 556   cgraph_node_set_element element;
 557   cgraph_node_set_iterator csi;
 558
 559   dummy.node = node;
 560   slot = htab_find_slot (set->hashtab, &dummy, NO_INSERT);
 561   if (slot == NULL)
 562     csi.index = (unsigned) ~0;
 563   else
 564     {
 565       element = (cgraph_node_set_element) *slot;
 566       gcc_assert (VEC_index (cgraph_node_ptr, set->nodes, element->index)
 567                   == node);
 568       csi.index = element->index;
 569     }
 570   csi.set = set;
 571
 572   return csi;
 573 }
 574
 575 /* Dump content of SET to file F.  */
 576
 577 void
 578 dump_cgraph_node_set (FILE *f, cgraph_node_set set)
 579 {
 580   cgraph_node_set_iterator iter;
 581
 582   for (iter = csi_start (set); !csi_end_p (iter); csi_next (&iter))
 583     {
 584       struct cgraph_node *node = csi_node (iter);
 585       dump_cgraph_node (f, node);
 586     }
 587 }
 588
 589 /* Dump content of SET to stderr.  */
 590
 591 void
 592 debug_cgraph_node_set (cgraph_node_set set)
 593 {
 594   dump_cgraph_node_set (stderr, set);
 595 }
 596