gcc/cgraph.h

   1 /* Callgraph handling code.
   2    Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008
   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 #include "tree.h"
  25 #include "basic-block.h"
  26
  27 enum availability
  28 {
  29   /* Not yet set by cgraph_function_body_availability.  */
  30   AVAIL_UNSET,
  31   /* Function body/variable initializer is unknown.  */
  32   AVAIL_NOT_AVAILABLE,
  33   /* Function body/variable initializer is known but might be replaced
  34      by a different one from other compilation unit and thus needs to
  35      be dealt with a care.  Like AVAIL_NOT_AVAILABLE it can have
  36      arbitrary side effects on escaping variables and functions, while
  37      like AVAILABLE it might access static variables.  */
  38   AVAIL_OVERWRITABLE,
  39   /* Function body/variable initializer is known and will be used in final
  40      program.  */
  41   AVAIL_AVAILABLE,
  42   /* Function body/variable initializer is known and all it's uses are explicitly
  43      visible within current unit (ie it's address is never taken and it is not
  44      exported to other units).
  45      Currently used only for functions.  */
  46   AVAIL_LOCAL
  47 };
  48
  49 extern const char * const cgraph_availability_names[];
  50
  51 /* Information about the function collected locally.
  52    Available after function is analyzed.  */
  53
  54 struct cgraph_local_info GTY(())
  55 {
  56   struct inline_summary {
  57     /* Estimated stack frame consumption by the function.  */
  58     HOST_WIDE_INT estimated_self_stack_size;
  59
  60     /* Size of the function before inlining.  */
  61     int self_insns;
  62   } inline_summary;
  63
  64   /* Set when function function is visible in current compilation unit only
  65      and its address is never taken.  */
  66   unsigned local : 1;
  67
  68   /* Set when function is visible by other units.  */
  69   unsigned externally_visible : 1;
  70
  71   /* Set once it has been finalized so we consider it to be output.  */
  72   unsigned finalized : 1;
  73
  74   /* False when there something makes inlining impossible (such as va_arg).  */
  75   unsigned inlinable : 1;
  76
  77   /* True when function should be inlined independently on its size.  */
  78   unsigned disregard_inline_limits : 1;
  79
  80   /* True when the function has been originally extern inline, but it is
  81      redefined now.  */
  82   unsigned redefined_extern_inline : 1;
  83
  84   /* True if statics_read_for_function and
  85      statics_written_for_function contain valid data.  */
  86   unsigned for_functions_valid : 1;
  87
  88   /* True if the function is going to be emitted in some other translation
  89      unit, referenced from vtable.  */
  90   unsigned vtable_method : 1;
  91 };
  92
  93 /* Information about the function that needs to be computed globally
  94    once compilation is finished.  Available only with -funit-at-a-time.  */
  95
  96 struct cgraph_global_info GTY(())
  97 {
  98   /* Estimated stack frame consumption by the function.  */
  99   HOST_WIDE_INT estimated_stack_size;
 100   /* Expected offset of the stack frame of inlined function.  */
 101   HOST_WIDE_INT stack_frame_offset;
 102
 103   /* For inline clones this points to the function they will be
 104      inlined into.  */
 105   struct cgraph_node *inlined_to;
 106
 107   /* Estimated size of the function after inlining.  */
 108   int insns;
 109
 110   /* Estimated growth after inlining.  INT_MIN if not computed.  */
 111   int estimated_growth;
 112
 113   /* Set iff the function has been inlined at least once.  */
 114   bool inlined;
 115 };
 116
 117 /* Information about the function that is propagated by the RTL backend.
 118    Available only for functions that has been already assembled.  */
 119
 120 struct cgraph_rtl_info GTY(())
 121 {
 122    unsigned int preferred_incoming_stack_boundary;
 123 };
 124
 125 /* The cgraph data structure.
 126    Each function decl has assigned cgraph_node listing callees and callers.  */
 127
 128 struct cgraph_node GTY((chain_next ("%h.next"), chain_prev ("%h.previous")))
 129 {
 130   tree decl;
 131   struct cgraph_edge *callees;
 132   struct cgraph_edge *callers;
 133   struct cgraph_node *next;
 134   struct cgraph_node *previous;
 135   /* For nested functions points to function the node is nested in.  */
 136   struct cgraph_node *origin;
 137   /* Points to first nested function, if any.  */
 138   struct cgraph_node *nested;
 139   /* Pointer to the next function with same origin, if any.  */
 140   struct cgraph_node *next_nested;
 141   /* Pointer to the next function in cgraph_nodes_queue.  */
 142   struct cgraph_node *next_needed;
 143   /* Pointer to the next clone.  */
 144   struct cgraph_node *next_clone;
 145   struct cgraph_node *prev_clone;
 146   /* For functions with many calls sites it holds map from call expression
 147      to the edge to speed up cgraph_edge function.  */
 148   htab_t GTY((param_is (struct cgraph_edge))) call_site_hash;
 149
 150   PTR GTY ((skip)) aux;
 151
 152   struct cgraph_local_info local;
 153   struct cgraph_global_info global;
 154   struct cgraph_rtl_info rtl;
 155
 156   /* Expected number of executions: calculated in profile.c.  */
 157   gcov_type count;
 158   /* Unique id of the node.  */
 159   int uid;
 160   /* Ordering of all cgraph nodes.  */
 161   int order;
 162
 163   /* unique id for profiling. pid is not suitable because of different
 164      number of cfg nodes with -fprofile-generate and -fprofile-use */
 165   int pid;
 166
 167   /* Set when function must be output - it is externally visible
 168      or its address is taken.  */
 169   unsigned needed : 1;
 170   /* Set when decl is an abstract function pointed to by the
 171      ABSTRACT_DECL_ORIGIN of a reachable function.  */
 172   unsigned abstract_and_needed : 1;
 173   /* Set when function is reachable by call from other function
 174      that is either reachable or needed.  */
 175   unsigned reachable : 1;
 176   /* Set once the function is lowered (i.e. its CFG is built).  */
 177   unsigned lowered : 1;
 178   /* Set once the function has been instantiated and its callee
 179      lists created.  */
 180   unsigned analyzed : 1;
 181   /* Set when function is scheduled to be assembled.  */
 182   unsigned output : 1;
 183   /* Set for aliases once they got through assemble_alias.  */
 184   unsigned alias : 1;
 185
 186   /* In non-unit-at-a-time mode the function body of inline candidates is saved
 187      into clone before compiling so the function in original form can be
 188      inlined later.  This pointer points to the clone.  */
 189   tree inline_decl;
 190 };
 191
 192 struct cgraph_edge GTY((chain_next ("%h.next_caller"), chain_prev ("%h.prev_caller")))
 193 {
 194   struct cgraph_node *caller;
 195   struct cgraph_node *callee;
 196   struct cgraph_edge *prev_caller;
 197   struct cgraph_edge *next_caller;
 198   struct cgraph_edge *prev_callee;
 199   struct cgraph_edge *next_callee;
 200   gimple call_stmt;
 201   PTR GTY ((skip (""))) aux;
 202   /* When NULL, inline this call.  When non-NULL, points to the explanation
 203      why function was not inlined.  */
 204   const char *inline_failed;
 205   /* Expected number of executions: calculated in profile.c.  */
 206   gcov_type count;
 207   /* Expected frequency of executions within the function.
 208      When set to CGRAPH_FREQ_BASE, the edge is expected to be called once
 209      per function call.  The range is 0 to CGRAPH_FREQ_MAX.  */
 210   int frequency;
 211   /* Depth of loop nest, 1 means no loop nest.  */
 212   unsigned int loop_nest : 31;
 213   /* Whether this edge describes a call that was originally indirect.  */
 214   unsigned int indirect_call : 1;
 215   /* Unique id of the edge.  */
 216   int uid;
 217 };
 218
 219 #define CGRAPH_FREQ_BASE 1000
 220 #define CGRAPH_FREQ_MAX 100000
 221
 222 typedef struct cgraph_edge *cgraph_edge_p;
 223
 224 DEF_VEC_P(cgraph_edge_p);
 225 DEF_VEC_ALLOC_P(cgraph_edge_p,heap);
 226
 227 /* The varpool data structure.
 228    Each static variable decl has assigned varpool_node.  */
 229
 230 struct varpool_node GTY((chain_next ("%h.next")))
 231 {
 232   tree decl;
 233   /* Pointer to the next function in varpool_nodes.  */
 234   struct varpool_node *next;
 235   /* Pointer to the next function in varpool_nodes_queue.  */
 236   struct varpool_node *next_needed;
 237   /* Ordering of all cgraph nodes.  */
 238   int order;
 239
 240   /* Set when function must be output - it is externally visible
 241      or its address is taken.  */
 242   unsigned needed : 1;
 243   /* Needed variables might become dead by optimization.  This flag
 244      forces the variable to be output even if it appears dead otherwise.  */
 245   unsigned force_output : 1;
 246   /* Set once the variable has been instantiated and its callee
 247      lists created.  */
 248   unsigned analyzed : 1;
 249   /* Set once it has been finalized so we consider it to be output.  */
 250   unsigned finalized : 1;
 251   /* Set when variable is scheduled to be assembled.  */
 252   unsigned output : 1;
 253   /* Set when function is visible by other units.  */
 254   unsigned externally_visible : 1;
 255   /* Set for aliases once they got through assemble_alias.  */
 256   unsigned alias : 1;
 257 };
 258
 259 /* Every top level asm statement is put into a cgraph_asm_node.  */
 260
 261 struct cgraph_asm_node GTY(())
 262 {
 263   /* Next asm node.  */
 264   struct cgraph_asm_node *next;
 265   /* String for this asm node.  */
 266   tree asm_str;
 267   /* Ordering of all cgraph nodes.  */
 268   int order;
 269 };
 270
 271 extern GTY(()) struct cgraph_node *cgraph_nodes;
 272 extern GTY(()) int cgraph_n_nodes;
 273 extern GTY(()) int cgraph_max_uid;
 274 extern GTY(()) int cgraph_edge_max_uid;
 275 extern GTY(()) int cgraph_max_pid;
 276 extern bool cgraph_global_info_ready;
 277 enum cgraph_state
 278 {
 279   /* Callgraph is being constructed.  It is safe to add new functions.  */
 280   CGRAPH_STATE_CONSTRUCTION,
 281   /* Callgraph is built and IPA passes are being run.  */
 282   CGRAPH_STATE_IPA,
 283   /* Callgraph is built and all functions are transformed to SSA form.  */
 284   CGRAPH_STATE_IPA_SSA,
 285   /* Functions are now ordered and being passed to RTL expanders.  */
 286   CGRAPH_STATE_EXPANSION,
 287   /* All cgraph expansion is done.  */
 288   CGRAPH_STATE_FINISHED
 289 };
 290 extern enum cgraph_state cgraph_state;
 291 extern bool cgraph_function_flags_ready;
 292 extern GTY(()) struct cgraph_node *cgraph_nodes_queue;
 293 extern GTY(()) struct cgraph_node *cgraph_new_nodes;
 294
 295 extern GTY(()) struct cgraph_asm_node *cgraph_asm_nodes;
 296 extern GTY(()) int cgraph_order;
 297
 298 /* In cgraph.c  */
 299 void dump_cgraph (FILE *);
 300 void debug_cgraph (void);
 301 void dump_cgraph_node (FILE *, struct cgraph_node *);
 302 void debug_cgraph_node (struct cgraph_node *);
 303 void cgraph_insert_node_to_hashtable (struct cgraph_node *node);
 304 void cgraph_remove_edge (struct cgraph_edge *);
 305 void cgraph_remove_node (struct cgraph_node *);
 306 void cgraph_release_function_body (struct cgraph_node *);
 307 void cgraph_node_remove_callees (struct cgraph_node *node);
 308 struct cgraph_edge *cgraph_create_edge (struct cgraph_node *,
 309                                         struct cgraph_node *,
 310                                         gimple, gcov_type, int, int);
 311 struct cgraph_node *cgraph_node (tree);
 312 struct cgraph_node *cgraph_node_for_asm (tree asmname);
 313 struct cgraph_edge *cgraph_edge (struct cgraph_node *, gimple);
 314 void cgraph_set_call_stmt (struct cgraph_edge *, gimple);
 315 void cgraph_update_edges_for_call_stmt (gimple, gimple);
 316 struct cgraph_local_info *cgraph_local_info (tree);
 317 struct cgraph_global_info *cgraph_global_info (tree);
 318 struct cgraph_rtl_info *cgraph_rtl_info (tree);
 319 const char * cgraph_node_name (struct cgraph_node *);
 320 struct cgraph_edge * cgraph_clone_edge (struct cgraph_edge *,
 321                                         struct cgraph_node *,
 322                                         gimple, gcov_type, int, int, bool);
 323 struct cgraph_node * cgraph_clone_node (struct cgraph_node *, gcov_type, int,
 324                                         int, bool);
 325
 326 void cgraph_redirect_edge_callee (struct cgraph_edge *, struct cgraph_node *);
 327
 328 struct cgraph_asm_node *cgraph_add_asm_node (tree);
 329
 330 bool cgraph_function_possibly_inlined_p (tree);
 331 void cgraph_unnest_node (struct cgraph_node *);
 332
 333 enum availability cgraph_function_body_availability (struct cgraph_node *);
 334 void cgraph_add_new_function (tree, bool);
 335
 336 /* In cgraphunit.c  */
 337 void cgraph_finalize_function (tree, bool);
 338 void cgraph_mark_if_needed (tree);
 339 void cgraph_finalize_compilation_unit (void);
 340 void cgraph_optimize (void);
 341 void cgraph_mark_needed_node (struct cgraph_node *);
 342 void cgraph_mark_reachable_node (struct cgraph_node *);
 343 bool cgraph_inline_p (struct cgraph_edge *, const char **reason);
 344 bool cgraph_preserve_function_body_p (tree);
 345 void verify_cgraph (void);
 346 void verify_cgraph_node (struct cgraph_node *);
 347 void cgraph_build_static_cdtor (char which, tree body, int priority);
 348 void cgraph_reset_static_var_maps (void);
 349 void init_cgraph (void);
 350 struct cgraph_node *cgraph_function_versioning (struct cgraph_node *,
 351                                                 VEC(cgraph_edge_p,heap)*,
 352                                                 varray_type,
 353                                                 bitmap);
 354 void cgraph_analyze_function (struct cgraph_node *);
 355 struct cgraph_node *save_inline_function_body (struct cgraph_node *);
 356 void record_references_in_initializer (tree);
 357 bool cgraph_process_new_functions (void);
 358
 359 typedef void (*cgraph_edge_hook)(struct cgraph_edge *, void *);
 360 typedef void (*cgraph_node_hook)(struct cgraph_node *, void *);
 361 typedef void (*cgraph_2edge_hook)(struct cgraph_edge *, struct cgraph_edge *,
 362                                   void *);
 363 typedef void (*cgraph_2node_hook)(struct cgraph_node *, struct cgraph_node *,
 364                                   void *);
 365 struct cgraph_edge_hook_list;
 366 struct cgraph_node_hook_list;
 367 struct cgraph_2edge_hook_list;
 368 struct cgraph_2node_hook_list;
 369 struct cgraph_edge_hook_list *cgraph_add_edge_removal_hook (cgraph_edge_hook, void *);
 370 void cgraph_remove_edge_removal_hook (struct cgraph_edge_hook_list *);
 371 struct cgraph_node_hook_list *cgraph_add_node_removal_hook (cgraph_node_hook,
 372                                                             void *);
 373 void cgraph_remove_node_removal_hook (struct cgraph_node_hook_list *);
 374 struct cgraph_node_hook_list *cgraph_add_function_insertion_hook (cgraph_node_hook,
 375                                                                   void *);
 376 void cgraph_remove_function_insertion_hook (struct cgraph_node_hook_list *);
 377 void cgraph_call_function_insertion_hooks (struct cgraph_node *node);
 378 struct cgraph_2edge_hook_list *cgraph_add_edge_duplication_hook (cgraph_2edge_hook, void *);
 379 void cgraph_remove_edge_duplication_hook (struct cgraph_2edge_hook_list *);
 380 struct cgraph_2node_hook_list *cgraph_add_node_duplication_hook (cgraph_2node_hook, void *);
 381 void cgraph_remove_node_duplication_hook (struct cgraph_2node_hook_list *);
 382
 383 /* In cgraphbuild.c  */
 384 unsigned int rebuild_cgraph_edges (void);
 385 int compute_call_stmt_bb_frequency (basic_block bb);
 386
 387 /* In ipa.c  */
 388 bool cgraph_remove_unreachable_nodes (bool, FILE *);
 389 int cgraph_postorder (struct cgraph_node **);
 390
 391 bool cgraph_maybe_hot_edge_p (struct cgraph_edge *e);
 392
 393 /* In varpool.c  */
 394
 395 extern GTY(()) struct varpool_node *varpool_nodes_queue;
 396 extern GTY(()) struct varpool_node *varpool_nodes;
 397
 398 struct varpool_node *varpool_node (tree);
 399 struct varpool_node *varpool_node_for_asm (tree asmname);
 400 void varpool_mark_needed_node (struct varpool_node *);
 401 void dump_varpool (FILE *);
 402 void dump_varpool_node (FILE *, struct varpool_node *);
 403
 404 void varpool_finalize_decl (tree);
 405 bool decide_is_variable_needed (struct varpool_node *, tree);
 406 enum availability cgraph_variable_initializer_availability (struct varpool_node *);
 407
 408 bool varpool_assemble_pending_decls (void);
 409 bool varpool_assemble_decl (struct varpool_node *node);
 410 bool varpool_analyze_pending_decls (void);
 411 void varpool_remove_unreferenced_decls (void);
 412 void varpool_empty_needed_queue (void);
 413
 414 /* Walk all reachable static variables.  */
 415 #define FOR_EACH_STATIC_VARIABLE(node) \
 416    for ((node) = varpool_nodes_queue; (node); (node) = (node)->next_needed)
 417
 418 /* Return first reachable static variable with initializer.  */
 419 static inline struct varpool_node *
 420 varpool_first_static_initializer (void)
 421 {
 422   struct varpool_node *node;
 423   for (node = varpool_nodes_queue; node; node = node->next_needed)
 424     {
 425       gcc_assert (TREE_CODE (node->decl) == VAR_DECL);
 426       if (DECL_INITIAL (node->decl))
 427         return node;
 428     }
 429   return NULL;
 430 }
 431
 432 /* Return next reachable static variable with initializer after NODE.  */
 433 static inline struct varpool_node *
 434 varpool_next_static_initializer (struct varpool_node *node)
 435 {
 436   for (node = node->next_needed; node; node = node->next_needed)
 437     {
 438       gcc_assert (TREE_CODE (node->decl) == VAR_DECL);
 439       if (DECL_INITIAL (node->decl))
 440         return node;
 441     }
 442   return NULL;
 443 }
 444
 445 /* Walk all static variables with initializer set.  */
 446 #define FOR_EACH_STATIC_INITIALIZER(node) \
 447    for ((node) = varpool_first_static_initializer (); (node); \
 448         (node) = varpool_next_static_initializer (node))
 449
 450 /* In ipa-inline.c  */
 451 void cgraph_clone_inlined_nodes (struct cgraph_edge *, bool, bool);
 452 bool cgraph_default_inline_p (struct cgraph_node *, const char **);
 453 unsigned int compute_inline_parameters (struct cgraph_node *);
 454
 455
 456 /* Create a new static variable of type TYPE.  */
 457 tree add_new_static_var (tree type);
 458
 459 #endif  /* GCC_CGRAPH_H  */