gcc/cgraph.h

   1 /* Callgraph handling code.
   2    Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
   3    Free Software Foundation, Inc.
   4    Contributed by Jan Hubicka
   5
   6 This file is part of GCC.
   7
   8 GCC is free software; you can redistribute it and/or modify it under
   9 the terms of the GNU General Public License as published by the Free
  10 Software Foundation; either version 3, or (at your option) any later
  11 version.
  12
  13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  15 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  16 for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with GCC; see the file COPYING3.  If not see
  20 <http://www.gnu.org/licenses/>.  */
  21
  22 #ifndef GCC_CGRAPH_H
  23 #define GCC_CGRAPH_H
  24
  25 #include "plugin-api.h"
  26 #include "vec.h"
  27 #include "tree.h"
  28 #include "basic-block.h"
  29 #include "function.h"
  30 #include "ipa-ref.h"    /* FIXME: inappropriate dependency of cgraph on IPA.  */
  31
  32 enum availability
  33 {
  34   /* Not yet set by cgraph_function_body_availability.  */
  35   AVAIL_UNSET,
  36   /* Function body/variable initializer is unknown.  */
  37   AVAIL_NOT_AVAILABLE,
  38   /* Function body/variable initializer is known but might be replaced
  39      by a different one from other compilation unit and thus needs to
  40      be dealt with a care.  Like AVAIL_NOT_AVAILABLE it can have
  41      arbitrary side effects on escaping variables and functions, while
  42      like AVAILABLE it might access static variables.  */
  43   AVAIL_OVERWRITABLE,
  44   /* Function body/variable initializer is known and will be used in final
  45      program.  */
  46   AVAIL_AVAILABLE,
  47   /* Function body/variable initializer is known and all it's uses are explicitly
  48      visible within current unit (ie it's address is never taken and it is not
  49      exported to other units).
  50      Currently used only for functions.  */
  51   AVAIL_LOCAL
  52 };
  53
  54 /* This is the information that is put into the cgraph local structure
  55    to recover a function.  */
  56 struct lto_file_decl_data;
  57
  58 extern const char * const cgraph_availability_names[];
  59 extern const char * const ld_plugin_symbol_resolution_names[];
  60
  61 /* Information about thunk, used only for same body aliases.  */
  62
  63 struct GTY(()) cgraph_thunk_info {
  64   /* Information about the thunk.  */
  65   HOST_WIDE_INT fixed_offset;
  66   HOST_WIDE_INT virtual_value;
  67   tree alias;
  68   bool this_adjusting;
  69   bool virtual_offset_p;
  70   /* Set to true when alias node is thunk.  */
  71   bool thunk_p;
  72 };
  73
  74 /* Information about the function collected locally.
  75    Available after function is analyzed.  */
  76
  77 struct GTY(()) cgraph_local_info {
  78   /* File stream where this node is being written to.  */
  79   struct lto_file_decl_data * lto_file_data;
  80
  81   /* Set when function function is visible in current compilation unit only
  82      and its address is never taken.  */
  83   unsigned local : 1;
  84
  85   /* Set when function is visible by other units.  */
  86   unsigned externally_visible : 1;
  87
  88   /* Set once it has been finalized so we consider it to be output.  */
  89   unsigned finalized : 1;
  90
  91   /* False when function calling convention and signature can not be changed.
  92      This is the case when __builtin_apply_args is used.  */
  93   unsigned can_change_signature : 1;
  94
  95   /* True when the function has been originally extern inline, but it is
  96      redefined now.  */
  97   unsigned redefined_extern_inline : 1;
  98 };
  99
 100 /* Information about the function that needs to be computed globally
 101    once compilation is finished.  Available only with -funit-at-a-time.  */
 102
 103 struct GTY(()) cgraph_global_info {
 104   /* For inline clones this points to the function they will be
 105      inlined into.  */
 106   struct cgraph_node *inlined_to;
 107 };
 108
 109 /* Information about the function that is propagated by the RTL backend.
 110    Available only for functions that has been already assembled.  */
 111
 112 struct GTY(()) cgraph_rtl_info {
 113    unsigned int preferred_incoming_stack_boundary;
 114 };
 115
 116 /* Represent which DECL tree (or reference to such tree)
 117    will be replaced by another tree while versioning.  */
 118 struct GTY(()) ipa_replace_map
 119 {
 120   /* The tree that will be replaced.  */
 121   tree old_tree;
 122   /* The new (replacing) tree.  */
 123   tree new_tree;
 124   /* Parameter number to replace, when old_tree is NULL.  */
 125   int parm_num;
 126   /* True when a substitution should be done, false otherwise.  */
 127   bool replace_p;
 128   /* True when we replace a reference to old_tree.  */
 129   bool ref_p;
 130 };
 131 typedef struct ipa_replace_map *ipa_replace_map_p;
 132 DEF_VEC_P(ipa_replace_map_p);
 133 DEF_VEC_ALLOC_P(ipa_replace_map_p,gc);
 134
 135 struct GTY(()) cgraph_clone_info
 136 {
 137   VEC(ipa_replace_map_p,gc)* tree_map;
 138   bitmap args_to_skip;
 139   bitmap combined_args_to_skip;
 140 };
 141
 142
 143 /* The cgraph data structure.
 144    Each function decl has assigned cgraph_node listing callees and callers.  */
 145
 146 struct GTY((chain_next ("%h.next"), chain_prev ("%h.previous"))) cgraph_node {
 147   tree decl;
 148   struct cgraph_edge *callees;
 149   struct cgraph_edge *callers;
 150   struct cgraph_node *next;
 151   struct cgraph_node *previous;
 152   /* List of edges representing indirect calls with a yet undetermined
 153      callee.  */
 154   struct cgraph_edge *indirect_calls;
 155   /* For nested functions points to function the node is nested in.  */
 156   struct cgraph_node *origin;
 157   /* Points to first nested function, if any.  */
 158   struct cgraph_node *nested;
 159   /* Pointer to the next function with same origin, if any.  */
 160   struct cgraph_node *next_nested;
 161   /* Pointer to the next function in cgraph_nodes_queue.  */
 162   struct cgraph_node *next_needed;
 163   /* Pointer to the next clone.  */
 164   struct cgraph_node *next_sibling_clone;
 165   struct cgraph_node *prev_sibling_clone;
 166   struct cgraph_node *clones;
 167   struct cgraph_node *clone_of;
 168   /* Circular list of nodes in the same comdat group if non-NULL.  */
 169   struct cgraph_node *same_comdat_group;
 170   /* For functions with many calls sites it holds map from call expression
 171      to the edge to speed up cgraph_edge function.  */
 172   htab_t GTY((param_is (struct cgraph_edge))) call_site_hash;
 173   /* Declaration node used to be clone of. */
 174   tree former_clone_of;
 175
 176   PTR GTY ((skip)) aux;
 177
 178   /* Interprocedural passes scheduled to have their transform functions
 179      applied next time we execute local pass on them.  We maintain it
 180      per-function in order to allow IPA passes to introduce new functions.  */
 181   VEC(ipa_opt_pass,heap) * GTY((skip)) ipa_transforms_to_apply;
 182
 183   struct ipa_ref_list ref_list;
 184   struct cgraph_local_info local;
 185   struct cgraph_global_info global;
 186   struct cgraph_rtl_info rtl;
 187   struct cgraph_clone_info clone;
 188   struct cgraph_thunk_info thunk;
 189
 190   /* Expected number of executions: calculated in profile.c.  */
 191   gcov_type count;
 192   /* How to scale counts at materialization time; used to merge
 193      LTO units with different number of profile runs.  */
 194   int count_materialization_scale;
 195   /* Unique id of the node.  */
 196   int uid;
 197   /* Ordering of all cgraph nodes.  */
 198   int order;
 199
 200   enum ld_plugin_symbol_resolution resolution;
 201
 202   /* Set when function must be output for some reason.  The primary
 203      use of this flag is to mark functions needed to be output for
 204      non-standard reason.  Functions that are externally visible
 205      or reachable from functions needed to be output are marked
 206      by specialized flags.  */
 207   unsigned needed : 1;
 208   /* Set when function has address taken.
 209      In current implementation it imply needed flag. */
 210   unsigned address_taken : 1;
 211   /* Set when decl is an abstract function pointed to by the
 212      ABSTRACT_DECL_ORIGIN of a reachable function.  */
 213   unsigned abstract_and_needed : 1;
 214   /* Set when function is reachable by call from other function
 215      that is either reachable or needed.
 216      This flag is computed at original cgraph construction and then
 217      updated in cgraph_remove_unreachable_nodes.  Note that after
 218      cgraph_remove_unreachable_nodes cgraph still can contain unreachable
 219      nodes when they are needed for virtual clone instantiation.  */
 220   unsigned reachable : 1;
 221   /* Set when function is reachable by call from other LTRANS partition.  */
 222   unsigned reachable_from_other_partition : 1;
 223   /* Set once the function is lowered (i.e. its CFG is built).  */
 224   unsigned lowered : 1;
 225   /* Set once the function has been instantiated and its callee
 226      lists created.  */
 227   unsigned analyzed : 1;
 228   /* Set when function is available in the other LTRANS partition.
 229      During WPA output it is used to mark nodes that are present in
 230      multiple partitions.  */
 231   unsigned in_other_partition : 1;
 232   /* Set when function is scheduled to be processed by local passes.  */
 233   unsigned process : 1;
 234   /* Set for aliases once they got through assemble_alias.  */
 235   unsigned alias : 1;
 236   /* Set for aliases created as C++ same body aliases.  */
 237   unsigned same_body_alias : 1;
 238   /* How commonly executed the node is.  Initialized during branch
 239      probabilities pass.  */
 240   ENUM_BITFIELD (node_frequency) frequency : 2;
 241   /* True when function can only be called at startup (from static ctor).  */
 242   unsigned only_called_at_startup : 1;
 243   /* True when function can only be called at startup (from static dtor).  */
 244   unsigned only_called_at_exit : 1;
 245 };
 246
 247 typedef struct cgraph_node *cgraph_node_ptr;
 248
 249 DEF_VEC_P(cgraph_node_ptr);
 250 DEF_VEC_ALLOC_P(cgraph_node_ptr,heap);
 251 DEF_VEC_ALLOC_P(cgraph_node_ptr,gc);
 252
 253 /* A cgraph node set is a collection of cgraph nodes.  A cgraph node
 254    can appear in multiple sets.  */
 255 struct cgraph_node_set_def
 256 {
 257   struct pointer_map_t *map;
 258   VEC(cgraph_node_ptr, heap) *nodes;
 259 };
 260
 261 typedef struct varpool_node *varpool_node_ptr;
 262
 263 DEF_VEC_P(varpool_node_ptr);
 264 DEF_VEC_ALLOC_P(varpool_node_ptr,heap);
 265 DEF_VEC_ALLOC_P(varpool_node_ptr,gc);
 266
 267 /* A varpool node set is a collection of varpool nodes.  A varpool node
 268    can appear in multiple sets.  */
 269 struct varpool_node_set_def
 270 {
 271   struct pointer_map_t * map;
 272   VEC(varpool_node_ptr, heap) *nodes;
 273 };
 274
 275 typedef struct cgraph_node_set_def *cgraph_node_set;
 276
 277 DEF_VEC_P(cgraph_node_set);
 278 DEF_VEC_ALLOC_P(cgraph_node_set,gc);
 279 DEF_VEC_ALLOC_P(cgraph_node_set,heap);
 280
 281 typedef struct varpool_node_set_def *varpool_node_set;
 282
 283 DEF_VEC_P(varpool_node_set);
 284 DEF_VEC_ALLOC_P(varpool_node_set,gc);
 285 DEF_VEC_ALLOC_P(varpool_node_set,heap);
 286
 287 /* Iterator structure for cgraph node sets.  */
 288 typedef struct
 289 {
 290   cgraph_node_set set;
 291   unsigned index;
 292 } cgraph_node_set_iterator;
 293
 294 /* Iterator structure for varpool node sets.  */
 295 typedef struct
 296 {
 297   varpool_node_set set;
 298   unsigned index;
 299 } varpool_node_set_iterator;
 300
 301 #define DEFCIFCODE(code, string)        CIF_ ## code,
 302 /* Reasons for inlining failures.  */
 303 typedef enum cgraph_inline_failed_enum {
 304 #include "cif-code.def"
 305   CIF_N_REASONS
 306 } cgraph_inline_failed_t;
 307
 308 /* Structure containing additional information about an indirect call.  */
 309
 310 struct GTY(()) cgraph_indirect_call_info
 311 {
 312   /* Offset accumulated from ancestor jump functions of inlined call graph
 313      edges.  */
 314   HOST_WIDE_INT anc_offset;
 315   /* OBJ_TYPE_REF_TOKEN of a polymorphic call (if polymorphic is set).  */
 316   HOST_WIDE_INT otr_token;
 317   /* Delta by which must be added to this parameter to compensate for a skipped
 318      this adjusting thunk.  */
 319   HOST_WIDE_INT thunk_delta;
 320   /* Type of the object from OBJ_TYPE_REF_OBJECT. */
 321   tree otr_type;
 322   /* Index of the parameter that is called.  */
 323   int param_index;
 324   /* ECF flags determined from the caller.  */
 325   int ecf_flags;
 326
 327   /* Set when the call is a virtual call with the parameter being the
 328      associated object pointer rather than a simple direct call.  */
 329   unsigned polymorphic : 1;
 330 };
 331
 332 struct GTY((chain_next ("%h.next_caller"), chain_prev ("%h.prev_caller"))) cgraph_edge {
 333   /* Expected number of executions: calculated in profile.c.  */
 334   gcov_type count;
 335   struct cgraph_node *caller;
 336   struct cgraph_node *callee;
 337   struct cgraph_edge *prev_caller;
 338   struct cgraph_edge *next_caller;
 339   struct cgraph_edge *prev_callee;
 340   struct cgraph_edge *next_callee;
 341   gimple call_stmt;
 342   /* Additional information about an indirect call.  Not cleared when an edge
 343      becomes direct.  */
 344   struct cgraph_indirect_call_info *indirect_info;
 345   PTR GTY ((skip (""))) aux;
 346   /* When equal to CIF_OK, inline this call.  Otherwise, points to the
 347      explanation why function was not inlined.  */
 348   cgraph_inline_failed_t inline_failed;
 349   /* The stmt_uid of call_stmt.  This is used by LTO to recover the call_stmt
 350      when the function is serialized in.  */
 351   unsigned int lto_stmt_uid;
 352   /* Expected frequency of executions within the function.
 353      When set to CGRAPH_FREQ_BASE, the edge is expected to be called once
 354      per function call.  The range is 0 to CGRAPH_FREQ_MAX.  */
 355   int frequency;
 356   /* Unique id of the edge.  */
 357   int uid;
 358   /* Whether this edge was made direct by indirect inlining.  */
 359   unsigned int indirect_inlining_edge : 1;
 360   /* Whether this edge describes an indirect call with an undetermined
 361      callee.  */
 362   unsigned int indirect_unknown_callee : 1;
 363   /* Whether this edge is still a dangling  */
 364   /* True if the corresponding CALL stmt cannot be inlined.  */
 365   unsigned int call_stmt_cannot_inline_p : 1;
 366   /* Can this call throw externally?  */
 367   unsigned int can_throw_external : 1;
 368 };
 369
 370 #define CGRAPH_FREQ_BASE 1000
 371 #define CGRAPH_FREQ_MAX 100000
 372
 373 typedef struct cgraph_edge *cgraph_edge_p;
 374
 375 DEF_VEC_P(cgraph_edge_p);
 376 DEF_VEC_ALLOC_P(cgraph_edge_p,heap);
 377
 378 /* The varpool data structure.
 379    Each static variable decl has assigned varpool_node.  */
 380
 381 struct GTY((chain_next ("%h.next"), chain_prev ("%h.prev"))) varpool_node {
 382   tree decl;
 383   /* For aliases points to declaration DECL is alias of.  */
 384   tree alias_of;
 385   /* Pointer to the next function in varpool_nodes.  */
 386   struct varpool_node *next, *prev;
 387   /* Pointer to the next function in varpool_nodes_queue.  */
 388   struct varpool_node *next_needed, *prev_needed;
 389   /* Circular list of nodes in the same comdat group if non-NULL.  */
 390   struct varpool_node *same_comdat_group;
 391   struct ipa_ref_list ref_list;
 392   /* File stream where this node is being written to.  */
 393   struct lto_file_decl_data * lto_file_data;
 394   PTR GTY ((skip)) aux;
 395   /* Ordering of all cgraph nodes.  */
 396   int order;
 397   enum ld_plugin_symbol_resolution resolution;
 398
 399   /* Set when function must be output - it is externally visible
 400      or its address is taken.  */
 401   unsigned needed : 1;
 402   /* Needed variables might become dead by optimization.  This flag
 403      forces the variable to be output even if it appears dead otherwise.  */
 404   unsigned force_output : 1;
 405   /* Set once the variable has been instantiated and its callee
 406      lists created.  */
 407   unsigned analyzed : 1;
 408   /* Set once it has been finalized so we consider it to be output.  */
 409   unsigned finalized : 1;
 410   /* Set when variable is scheduled to be assembled.  */
 411   unsigned output : 1;
 412   /* Set when function is visible by other units.  */
 413   unsigned externally_visible : 1;
 414   /* Set for aliases once they got through assemble_alias.  Also set for
 415      extra name aliases in varpool_extra_name_alias.  */
 416   unsigned alias : 1;
 417   unsigned extra_name_alias : 1;
 418   /* Set when variable is used from other LTRANS partition.  */
 419   unsigned used_from_other_partition : 1;
 420   /* Set when variable is available in the other LTRANS partition.
 421      During WPA output it is used to mark nodes that are present in
 422      multiple partitions.  */
 423   unsigned in_other_partition : 1;
 424 };
 425
 426 /* Every top level asm statement is put into a cgraph_asm_node.  */
 427
 428 struct GTY(()) cgraph_asm_node {
 429   /* Next asm node.  */
 430   struct cgraph_asm_node *next;
 431   /* String for this asm node.  */
 432   tree asm_str;
 433   /* Ordering of all cgraph nodes.  */
 434   int order;
 435 };
 436
 437 extern GTY(()) struct cgraph_node *cgraph_nodes;
 438 extern GTY(()) int cgraph_n_nodes;
 439 extern GTY(()) int cgraph_max_uid;
 440 extern GTY(()) int cgraph_edge_max_uid;
 441 extern bool cgraph_global_info_ready;
 442 enum cgraph_state
 443 {
 444   /* Callgraph is being constructed.  It is safe to add new functions.  */
 445   CGRAPH_STATE_CONSTRUCTION,
 446   /* Callgraph is built and IPA passes are being run.  */
 447   CGRAPH_STATE_IPA,
 448   /* Callgraph is built and all functions are transformed to SSA form.  */
 449   CGRAPH_STATE_IPA_SSA,
 450   /* Functions are now ordered and being passed to RTL expanders.  */
 451   CGRAPH_STATE_EXPANSION,
 452   /* All cgraph expansion is done.  */
 453   CGRAPH_STATE_FINISHED
 454 };
 455 extern enum cgraph_state cgraph_state;
 456 extern bool cgraph_function_flags_ready;
 457 extern GTY(()) struct cgraph_node *cgraph_nodes_queue;
 458 extern GTY(()) struct cgraph_node *cgraph_new_nodes;
 459
 460 extern GTY(()) struct cgraph_asm_node *cgraph_asm_nodes;
 461 extern GTY(()) int cgraph_order;
 462 extern bool same_body_aliases_done;
 463
 464 /* In cgraph.c  */
 465 void dump_cgraph (FILE *);
 466 void debug_cgraph (void);
 467 void dump_cgraph_node (FILE *, struct cgraph_node *);
 468 void debug_cgraph_node (struct cgraph_node *);
 469 void cgraph_insert_node_to_hashtable (struct cgraph_node *node);
 470 void cgraph_remove_edge (struct cgraph_edge *);
 471 void cgraph_remove_node (struct cgraph_node *);
 472 void cgraph_add_to_same_comdat_group (struct cgraph_node *, struct cgraph_node *);
 473 void cgraph_remove_node_and_inline_clones (struct cgraph_node *);
 474 void cgraph_release_function_body (struct cgraph_node *);
 475 void cgraph_node_remove_callees (struct cgraph_node *node);
 476 struct cgraph_edge *cgraph_create_edge (struct cgraph_node *,
 477                                         struct cgraph_node *,
 478                                         gimple, gcov_type, int);
 479 struct cgraph_edge *cgraph_create_indirect_edge (struct cgraph_node *, gimple,
 480                                                  int, gcov_type, int);
 481 struct cgraph_indirect_call_info *cgraph_allocate_init_indirect_info (void);
 482 struct cgraph_node * cgraph_get_node (const_tree);
 483 struct cgraph_node * cgraph_create_node (tree);
 484 struct cgraph_node * cgraph_get_create_node (tree);
 485 struct cgraph_node * cgraph_same_body_alias (struct cgraph_node *, tree, tree);
 486 struct cgraph_node * cgraph_add_thunk (struct cgraph_node *, tree, tree, bool, HOST_WIDE_INT,
 487                                        HOST_WIDE_INT, tree, tree);
 488 struct cgraph_node *cgraph_node_for_asm (tree);
 489 struct cgraph_edge *cgraph_edge (struct cgraph_node *, gimple);
 490 void cgraph_set_call_stmt (struct cgraph_edge *, gimple);
 491 void cgraph_set_call_stmt_including_clones (struct cgraph_node *, gimple, gimple);
 492 void cgraph_create_edge_including_clones (struct cgraph_node *,
 493                                           struct cgraph_node *,
 494                                           gimple, gimple, gcov_type, int,
 495                                           cgraph_inline_failed_t);
 496 void cgraph_update_edges_for_call_stmt (gimple, tree, gimple);
 497 struct cgraph_local_info *cgraph_local_info (tree);
 498 struct cgraph_global_info *cgraph_global_info (tree);
 499 struct cgraph_rtl_info *cgraph_rtl_info (tree);
 500 const char * cgraph_node_name (struct cgraph_node *);
 501 struct cgraph_edge * cgraph_clone_edge (struct cgraph_edge *,
 502                                         struct cgraph_node *, gimple,
 503                                         unsigned, gcov_type, int, bool);
 504 struct cgraph_node * cgraph_clone_node (struct cgraph_node *, tree, gcov_type,
 505                                         int, bool, VEC(cgraph_edge_p,heap) *,
 506                                         bool);
 507 struct cgraph_node *cgraph_create_function_alias (tree, tree);
 508
 509 void cgraph_redirect_edge_callee (struct cgraph_edge *, struct cgraph_node *);
 510 void cgraph_make_edge_direct (struct cgraph_edge *, struct cgraph_node *,
 511                               HOST_WIDE_INT);
 512 bool cgraph_only_called_directly_p (struct cgraph_node *);
 513
 514 struct cgraph_asm_node *cgraph_add_asm_node (tree);
 515
 516 bool cgraph_function_possibly_inlined_p (tree);
 517 void cgraph_unnest_node (struct cgraph_node *);
 518
 519 enum availability cgraph_function_body_availability (struct cgraph_node *);
 520 void cgraph_add_new_function (tree, bool);
 521 const char* cgraph_inline_failed_string (cgraph_inline_failed_t);
 522 struct cgraph_node * cgraph_create_virtual_clone (struct cgraph_node *old_node,
 523                                                   VEC(cgraph_edge_p,heap)*,
 524                                                   VEC(ipa_replace_map_p,gc)* tree_map,
 525                                                   bitmap args_to_skip,
 526                                                   const char *clone_name);
 527
 528 void cgraph_set_nothrow_flag (struct cgraph_node *, bool);
 529 void cgraph_set_const_flag (struct cgraph_node *, bool, bool);
 530 void cgraph_set_pure_flag (struct cgraph_node *, bool, bool);
 531 tree clone_function_name (tree decl, const char *);
 532 bool cgraph_node_cannot_return (struct cgraph_node *);
 533 bool cgraph_edge_cannot_lead_to_return (struct cgraph_edge *);
 534 bool cgraph_will_be_removed_from_program_if_no_direct_calls
 535   (struct cgraph_node *node);
 536 bool cgraph_can_remove_if_no_direct_calls_and_refs_p
 537   (struct cgraph_node *node);
 538 bool cgraph_can_remove_if_no_direct_calls_p (struct cgraph_node *node);
 539 bool resolution_used_from_other_file_p (enum ld_plugin_symbol_resolution);
 540 bool cgraph_used_from_object_file_p (struct cgraph_node *);
 541 bool varpool_used_from_object_file_p (struct varpool_node *);
 542 bool cgraph_for_node_thunks_and_aliases (struct cgraph_node *,
 543                                          bool (*) (struct cgraph_node *, void *),
 544                                          void *,
 545                                          bool);
 546 bool cgraph_for_node_and_aliases (struct cgraph_node *,
 547                                   bool (*) (struct cgraph_node *, void *),
 548                                   void *, bool);
 549 VEC (cgraph_edge_p, heap) * collect_callers_of_node (struct cgraph_node *node);
 550
 551
 552 /* In cgraphunit.c  */
 553 extern FILE *cgraph_dump_file;
 554 void cgraph_finalize_function (tree, bool);
 555 void cgraph_mark_if_needed (tree);
 556 void cgraph_analyze_function (struct cgraph_node *);
 557 void cgraph_finalize_compilation_unit (void);
 558 void cgraph_optimize (void);
 559 void cgraph_mark_needed_node (struct cgraph_node *);
 560 void cgraph_mark_address_taken_node (struct cgraph_node *);
 561 void cgraph_mark_reachable_node (struct cgraph_node *);
 562 bool cgraph_inline_p (struct cgraph_edge *, cgraph_inline_failed_t *reason);
 563 bool cgraph_preserve_function_body_p (struct cgraph_node *);
 564 void verify_cgraph (void);
 565 void verify_cgraph_node (struct cgraph_node *);
 566 void cgraph_build_static_cdtor (char which, tree body, int priority);
 567 void cgraph_reset_static_var_maps (void);
 568 void init_cgraph (void);
 569 struct cgraph_node *cgraph_function_versioning (struct cgraph_node *,
 570                                                 VEC(cgraph_edge_p,heap)*,
 571                                                 VEC(ipa_replace_map_p,gc)*,
 572                                                 bitmap, bitmap, basic_block,
 573                                                 const char *);
 574 void tree_function_versioning (tree, tree, VEC (ipa_replace_map_p,gc)*, bool, bitmap,
 575                                bitmap, basic_block);
 576 void record_references_in_initializer (tree, bool);
 577 bool cgraph_process_new_functions (void);
 578 void cgraph_process_same_body_aliases (void);
 579
 580 bool cgraph_decide_is_function_needed (struct cgraph_node *, tree);
 581
 582 typedef void (*cgraph_edge_hook)(struct cgraph_edge *, void *);
 583 typedef void (*cgraph_node_hook)(struct cgraph_node *, void *);
 584 typedef void (*cgraph_2edge_hook)(struct cgraph_edge *, struct cgraph_edge *,
 585                                   void *);
 586 typedef void (*cgraph_2node_hook)(struct cgraph_node *, struct cgraph_node *,
 587                                   void *);
 588 struct cgraph_edge_hook_list;
 589 struct cgraph_node_hook_list;
 590 struct cgraph_2edge_hook_list;
 591 struct cgraph_2node_hook_list;
 592 struct cgraph_edge_hook_list *cgraph_add_edge_removal_hook (cgraph_edge_hook, void *);
 593 void cgraph_remove_edge_removal_hook (struct cgraph_edge_hook_list *);
 594 struct cgraph_node_hook_list *cgraph_add_node_removal_hook (cgraph_node_hook,
 595                                                             void *);
 596 void cgraph_remove_node_removal_hook (struct cgraph_node_hook_list *);
 597 struct cgraph_node_hook_list *cgraph_add_function_insertion_hook (cgraph_node_hook,
 598                                                                   void *);
 599 void cgraph_remove_function_insertion_hook (struct cgraph_node_hook_list *);
 600 void cgraph_call_function_insertion_hooks (struct cgraph_node *node);
 601 struct cgraph_2edge_hook_list *cgraph_add_edge_duplication_hook (cgraph_2edge_hook, void *);
 602 void cgraph_remove_edge_duplication_hook (struct cgraph_2edge_hook_list *);
 603 struct cgraph_2node_hook_list *cgraph_add_node_duplication_hook (cgraph_2node_hook, void *);
 604 void cgraph_remove_node_duplication_hook (struct cgraph_2node_hook_list *);
 605 void cgraph_materialize_all_clones (void);
 606 gimple cgraph_redirect_edge_call_stmt_to_callee (struct cgraph_edge *);
 607 bool cgraph_propagate_frequency (struct cgraph_node *node);
 608 /* In cgraphbuild.c  */
 609 unsigned int rebuild_cgraph_edges (void);
 610 void cgraph_rebuild_references (void);
 611 void reset_inline_failed (struct cgraph_node *);
 612 int compute_call_stmt_bb_frequency (tree, basic_block bb);
 613
 614 /* In ipa.c  */
 615 bool cgraph_remove_unreachable_nodes (bool, FILE *);
 616 cgraph_node_set cgraph_node_set_new (void);
 617 cgraph_node_set_iterator cgraph_node_set_find (cgraph_node_set,
 618                                                struct cgraph_node *);
 619 void cgraph_node_set_add (cgraph_node_set, struct cgraph_node *);
 620 void cgraph_node_set_remove (cgraph_node_set, struct cgraph_node *);
 621 void dump_cgraph_node_set (FILE *, cgraph_node_set);
 622 void debug_cgraph_node_set (cgraph_node_set);
 623 void free_cgraph_node_set (cgraph_node_set);
 624
 625 varpool_node_set varpool_node_set_new (void);
 626 varpool_node_set_iterator varpool_node_set_find (varpool_node_set,
 627                                                struct varpool_node *);
 628 void varpool_node_set_add (varpool_node_set, struct varpool_node *);
 629 void varpool_node_set_remove (varpool_node_set, struct varpool_node *);
 630 void dump_varpool_node_set (FILE *, varpool_node_set);
 631 void debug_varpool_node_set (varpool_node_set);
 632 void free_varpool_node_set (varpool_node_set);
 633 void ipa_discover_readonly_nonaddressable_vars (void);
 634 bool cgraph_comdat_can_be_unshared_p (struct cgraph_node *);
 635
 636 /* In predict.c  */
 637 bool cgraph_maybe_hot_edge_p (struct cgraph_edge *e);
 638 bool cgraph_optimize_for_size_p (struct cgraph_node *);
 639
 640 /* In varpool.c  */
 641 extern GTY(()) struct varpool_node *varpool_nodes_queue;
 642 extern GTY(()) struct varpool_node *varpool_nodes;
 643
 644 struct varpool_node *varpool_node (tree);
 645 struct varpool_node *varpool_node_for_asm (tree asmname);
 646 void varpool_mark_needed_node (struct varpool_node *);
 647 void debug_varpool (void);
 648 void dump_varpool (FILE *);
 649 void dump_varpool_node (FILE *, struct varpool_node *);
 650
 651 void varpool_finalize_decl (tree);
 652 bool decide_is_variable_needed (struct varpool_node *, tree);
 653 enum availability cgraph_variable_initializer_availability (struct varpool_node *);
 654 void cgraph_make_decl_local (tree);
 655 void cgraph_make_node_local (struct cgraph_node *);
 656 bool cgraph_node_can_be_local_p (struct cgraph_node *);
 657
 658
 659 struct varpool_node * varpool_get_node (const_tree decl);
 660 void varpool_remove_node (struct varpool_node *node);
 661 void varpool_finalize_named_section_flags (struct varpool_node *node);
 662 bool varpool_assemble_pending_decls (void);
 663 bool varpool_assemble_decl (struct varpool_node *node);
 664 bool varpool_analyze_pending_decls (void);
 665 void varpool_remove_unreferenced_decls (void);
 666 void varpool_empty_needed_queue (void);
 667 struct varpool_node * varpool_extra_name_alias (tree, tree);
 668 struct varpool_node * varpool_create_variable_alias (tree, tree);
 669 const char * varpool_node_name (struct varpool_node *node);
 670 void varpool_reset_queue (void);
 671 bool const_value_known_p (tree);
 672 bool varpool_for_node_and_aliases (struct varpool_node *,
 673                                    bool (*) (struct varpool_node *, void *),
 674                                    void *, bool);
 675
 676 /* Walk all reachable static variables.  */
 677 #define FOR_EACH_STATIC_VARIABLE(node) \
 678    for ((node) = varpool_nodes_queue; (node); (node) = (node)->next_needed)
 679
 680 /* Return first reachable static variable with initializer.  */
 681 static inline struct varpool_node *
 682 varpool_first_static_initializer (void)
 683 {
 684   struct varpool_node *node;
 685   for (node = varpool_nodes_queue; node; node = node->next_needed)
 686     {
 687       gcc_checking_assert (TREE_CODE (node->decl) == VAR_DECL);
 688       if (DECL_INITIAL (node->decl))
 689         return node;
 690     }
 691   return NULL;
 692 }
 693
 694 /* Return next reachable static variable with initializer after NODE.  */
 695 static inline struct varpool_node *
 696 varpool_next_static_initializer (struct varpool_node *node)
 697 {
 698   for (node = node->next_needed; node; node = node->next_needed)
 699     {
 700       gcc_checking_assert (TREE_CODE (node->decl) == VAR_DECL);
 701       if (DECL_INITIAL (node->decl))
 702         return node;
 703     }
 704   return NULL;
 705 }
 706
 707 /* Walk all static variables with initializer set.  */
 708 #define FOR_EACH_STATIC_INITIALIZER(node) \
 709    for ((node) = varpool_first_static_initializer (); (node); \
 710         (node) = varpool_next_static_initializer (node))
 711
 712 /* Return first function with body defined.  */
 713 static inline struct cgraph_node *
 714 cgraph_first_defined_function (void)
 715 {
 716   struct cgraph_node *node;
 717   for (node = cgraph_nodes; node; node = node->next)
 718     {
 719       if (node->analyzed)
 720         return node;
 721     }
 722   return NULL;
 723 }
 724
 725 /* Return next reachable static variable with initializer after NODE.  */
 726 static inline struct cgraph_node *
 727 cgraph_next_defined_function (struct cgraph_node *node)
 728 {
 729   for (node = node->next; node; node = node->next)
 730     {
 731       if (node->analyzed)
 732         return node;
 733     }
 734   return NULL;
 735 }
 736
 737 /* Walk all functions with body defined.  */
 738 #define FOR_EACH_DEFINED_FUNCTION(node) \
 739    for ((node) = cgraph_first_defined_function (); (node); \
 740         (node) = cgraph_next_defined_function (node))
 741
 742
 743 /* Return true when NODE is a function with Gimple body defined
 744    in current unit.  Functions can also be define externally or they
 745    can be thunks with no Gimple representation.
 746
 747    Note that at WPA stage, the function body may not be present in memory.  */
 748
 749 static inline bool
 750 cgraph_function_with_gimple_body_p (struct cgraph_node *node)
 751 {
 752   return node->analyzed && !node->thunk.thunk_p && !node->alias;
 753 }
 754
 755 /* Return first function with body defined.  */
 756 static inline struct cgraph_node *
 757 cgraph_first_function_with_gimple_body (void)
 758 {
 759   struct cgraph_node *node;
 760   for (node = cgraph_nodes; node; node = node->next)
 761     {
 762       if (cgraph_function_with_gimple_body_p (node))
 763         return node;
 764     }
 765   return NULL;
 766 }
 767
 768 /* Return next reachable static variable with initializer after NODE.  */
 769 static inline struct cgraph_node *
 770 cgraph_next_function_with_gimple_body (struct cgraph_node *node)
 771 {
 772   for (node = node->next; node; node = node->next)
 773     {
 774       if (cgraph_function_with_gimple_body_p (node))
 775         return node;
 776     }
 777   return NULL;
 778 }
 779
 780 /* Walk all functions with body defined.  */
 781 #define FOR_EACH_FUNCTION_WITH_GIMPLE_BODY(node) \
 782    for ((node) = cgraph_first_function_with_gimple_body (); (node); \
 783         (node) = cgraph_next_function_with_gimple_body (node))
 784
 785 /* Create a new static variable of type TYPE.  */
 786 tree add_new_static_var (tree type);
 787
 788 /* Return true if iterator CSI points to nothing.  */
 789 static inline bool
 790 csi_end_p (cgraph_node_set_iterator csi)
 791 {
 792   return csi.index >= VEC_length (cgraph_node_ptr, csi.set->nodes);
 793 }
 794
 795 /* Advance iterator CSI.  */
 796 static inline void
 797 csi_next (cgraph_node_set_iterator *csi)
 798 {
 799   csi->index++;
 800 }
 801
 802 /* Return the node pointed to by CSI.  */
 803 static inline struct cgraph_node *
 804 csi_node (cgraph_node_set_iterator csi)
 805 {
 806   return VEC_index (cgraph_node_ptr, csi.set->nodes, csi.index);
 807 }
 808
 809 /* Return an iterator to the first node in SET.  */
 810 static inline cgraph_node_set_iterator
 811 csi_start (cgraph_node_set set)
 812 {
 813   cgraph_node_set_iterator csi;
 814
 815   csi.set = set;
 816   csi.index = 0;
 817   return csi;
 818 }
 819
 820 /* Return true if SET contains NODE.  */
 821 static inline bool
 822 cgraph_node_in_set_p (struct cgraph_node *node, cgraph_node_set set)
 823 {
 824   cgraph_node_set_iterator csi;
 825   csi = cgraph_node_set_find (set, node);
 826   return !csi_end_p (csi);
 827 }
 828
 829 /* Return number of nodes in SET.  */
 830 static inline size_t
 831 cgraph_node_set_size (cgraph_node_set set)
 832 {
 833   return VEC_length (cgraph_node_ptr, set->nodes);
 834 }
 835
 836 /* Return true if iterator VSI points to nothing.  */
 837 static inline bool
 838 vsi_end_p (varpool_node_set_iterator vsi)
 839 {
 840   return vsi.index >= VEC_length (varpool_node_ptr, vsi.set->nodes);
 841 }
 842
 843 /* Advance iterator VSI.  */
 844 static inline void
 845 vsi_next (varpool_node_set_iterator *vsi)
 846 {
 847   vsi->index++;
 848 }
 849
 850 /* Return the node pointed to by VSI.  */
 851 static inline struct varpool_node *
 852 vsi_node (varpool_node_set_iterator vsi)
 853 {
 854   return VEC_index (varpool_node_ptr, vsi.set->nodes, vsi.index);
 855 }
 856
 857 /* Return an iterator to the first node in SET.  */
 858 static inline varpool_node_set_iterator
 859 vsi_start (varpool_node_set set)
 860 {
 861   varpool_node_set_iterator vsi;
 862
 863   vsi.set = set;
 864   vsi.index = 0;
 865   return vsi;
 866 }
 867
 868 /* Return true if SET contains NODE.  */
 869 static inline bool
 870 varpool_node_in_set_p (struct varpool_node *node, varpool_node_set set)
 871 {
 872   varpool_node_set_iterator vsi;
 873   vsi = varpool_node_set_find (set, node);
 874   return !vsi_end_p (vsi);
 875 }
 876
 877 /* Return number of nodes in SET.  */
 878 static inline size_t
 879 varpool_node_set_size (varpool_node_set set)
 880 {
 881   return VEC_length (varpool_node_ptr, set->nodes);
 882 }
 883
 884 /* Uniquize all constants that appear in memory.
 885    Each constant in memory thus far output is recorded
 886    in `const_desc_table'.  */
 887
 888 struct GTY(()) constant_descriptor_tree {
 889   /* A MEM for the constant.  */
 890   rtx rtl;
 891
 892   /* The value of the constant.  */
 893   tree value;
 894
 895   /* Hash of value.  Computing the hash from value each time
 896      hashfn is called can't work properly, as that means recursive
 897      use of the hash table during hash table expansion.  */
 898   hashval_t hash;
 899 };
 900
 901 /* Return true if set is nonempty.  */
 902 static inline bool
 903 cgraph_node_set_nonempty_p (cgraph_node_set set)
 904 {
 905   return !VEC_empty (cgraph_node_ptr, set->nodes);
 906 }
 907
 908 /* Return true if set is nonempty.  */
 909 static inline bool
 910 varpool_node_set_nonempty_p (varpool_node_set set)
 911 {
 912   return !VEC_empty (varpool_node_ptr, set->nodes);
 913 }
 914
 915 /* Return true when function NODE is only called directly or it has alias.
 916    i.e. it is not externally visible, address was not taken and
 917    it is not used in any other non-standard way.  */
 918
 919 static inline bool
 920 cgraph_only_called_directly_or_aliased_p (struct cgraph_node *node)
 921 {
 922   gcc_assert (!node->global.inlined_to);
 923   return (!node->needed && !node->address_taken
 924           && !node->reachable_from_other_partition
 925           && !DECL_STATIC_CONSTRUCTOR (node->decl)
 926           && !DECL_STATIC_DESTRUCTOR (node->decl)
 927           && !node->local.externally_visible);
 928 }
 929
 930 /* Return true when function NODE can be removed from callgraph
 931    if all direct calls are eliminated.  */
 932
 933 static inline bool
 934 varpool_can_remove_if_no_refs (struct varpool_node *node)
 935 {
 936   return (!node->force_output && !node->used_from_other_partition
 937           && (flag_toplevel_reorder || DECL_COMDAT (node->decl)
 938               || DECL_ARTIFICIAL (node->decl))
 939           && (DECL_COMDAT (node->decl) || !node->externally_visible));
 940 }
 941
 942 /* Return true when all references to VNODE must be visible in ipa_ref_list.
 943    i.e. if the variable is not externally visible or not used in some magic
 944    way (asm statement or such).
 945    The magic uses are all summarized in force_output flag.  */
 946
 947 static inline bool
 948 varpool_all_refs_explicit_p (struct varpool_node *vnode)
 949 {
 950   return (vnode->analyzed
 951           && !vnode->externally_visible
 952           && !vnode->used_from_other_partition
 953           && !vnode->force_output);
 954 }
 955
 956 /* Constant pool accessor function.  */
 957 htab_t constant_pool_htab (void);
 958
 959 /* FIXME: inappropriate dependency of cgraph on IPA.  */
 960 #include "ipa-ref-inline.h"
 961
 962 /* Return node that alias N is aliasing.  */
 963
 964 static inline struct cgraph_node *
 965 cgraph_alias_aliased_node (struct cgraph_node *n)
 966 {
 967   struct ipa_ref *ref;
 968
 969   ipa_ref_list_reference_iterate (&n->ref_list, 0, ref);
 970   gcc_checking_assert (ref->use == IPA_REF_ALIAS);
 971   if (ref->refered_type == IPA_REF_CGRAPH)
 972     return ipa_ref_node (ref);
 973   return NULL;
 974 }
 975
 976 /* Return node that alias N is aliasing.  */
 977
 978 static inline struct varpool_node *
 979 varpool_alias_aliased_node (struct varpool_node *n)
 980 {
 981   struct ipa_ref *ref;
 982
 983   ipa_ref_list_reference_iterate (&n->ref_list, 0, ref);
 984   gcc_checking_assert (ref->use == IPA_REF_ALIAS);
 985   if (ref->refered_type == IPA_REF_VARPOOL)
 986     return ipa_ref_varpool_node (ref);
 987   return NULL;
 988 }
 989
 990 /* Given NODE, walk the alias chain to return the function NODE is alias of.
 991    Walk through thunk, too.
 992    When AVAILABILITY is non-NULL, get minimal availablity in the chain.  */
 993
 994 static inline struct cgraph_node *
 995 cgraph_function_node (struct cgraph_node *node, enum availability *availability)
 996 {
 997   if (availability)
 998     *availability = cgraph_function_body_availability (node);
 999   while (node)
1000     {
1001       if (node->alias && node->analyzed)
1002         node = cgraph_alias_aliased_node (node);
1003       else if (node->thunk.thunk_p)
1004         node = node->callees->callee;
1005       else
1006         return node;
1007       if (node && availability)
1008         {
1009           enum availability a;
1010           a = cgraph_function_body_availability (node);
1011           if (a < *availability)
1012             *availability = a;
1013         }
1014     }
1015   if (availability)
1016     *availability = AVAIL_NOT_AVAILABLE;
1017   return NULL;
1018 }
1019
1020 /* Given NODE, walk the alias chain to return the function NODE is alias of.
1021    Do not walk through thunks.
1022    When AVAILABILITY is non-NULL, get minimal availablity in the chain.  */
1023
1024 static inline struct cgraph_node *
1025 cgraph_function_or_thunk_node (struct cgraph_node *node, enum availability *availability)
1026 {
1027   if (availability)
1028     *availability = cgraph_function_body_availability (node);
1029   while (node)
1030     {
1031       if (node->alias && node->analyzed)
1032         node = cgraph_alias_aliased_node (node);
1033       else
1034         return node;
1035       if (node && availability)
1036         {
1037           enum availability a;
1038           a = cgraph_function_body_availability (node);
1039           if (a < *availability)
1040             *availability = a;
1041         }
1042     }
1043   if (availability)
1044     *availability = AVAIL_NOT_AVAILABLE;
1045   return NULL;
1046 }
1047
1048 /* Given NODE, walk the alias chain to return the function NODE is alias of.
1049    Do not walk through thunks.
1050    When AVAILABILITY is non-NULL, get minimal availablity in the chain.  */
1051
1052 static inline struct varpool_node *
1053 varpool_variable_node (struct varpool_node *node, enum availability *availability)
1054 {
1055   if (availability)
1056     *availability = cgraph_variable_initializer_availability (node);
1057   while (node)
1058     {
1059       if (node->alias && node->analyzed)
1060         node = varpool_alias_aliased_node (node);
1061       else
1062         return node;
1063       if (node && availability)
1064         {
1065           enum availability a;
1066           a = cgraph_variable_initializer_availability (node);
1067           if (a < *availability)
1068             *availability = a;
1069         }
1070     }
1071   if (availability)
1072     *availability = AVAIL_NOT_AVAILABLE;
1073   return NULL;
1074 }
1075
1076 /* Return true when the edge E represents a direct recursion.  */
1077 static inline bool
1078 cgraph_edge_recursive_p (struct cgraph_edge *e)
1079 {
1080   struct cgraph_node *callee = cgraph_function_or_thunk_node (e->callee, NULL);
1081   if (e->caller->global.inlined_to)
1082     return e->caller->global.inlined_to->decl == callee->decl;
1083   else
1084     return e->caller->decl == callee->decl;
1085 }
1086 #endif  /* GCC_CGRAPH_H  */