gcc/cgraph.h

   1 /* Callgraph handling code.
   2    Copyright (C) 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
   3    Contributed by Jan Hubicka
   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 2, 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 COPYING.  If not, write to the Free
  19 Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
  20 02110-1301, USA.  */
  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   /* Estimated stack frame consumption by the function.  */
  57   HOST_WIDE_INT estimated_self_stack_size;
  58
  59   /* Size of the function before inlining.  */
  60   int self_insns;
  61
  62   /* Set when function function is visible in current compilation unit only
  63      and its address is never taken.  */
  64   unsigned local : 1;
  65
  66   /* Set when function is visible by other units.  */
  67   unsigned externally_visible : 1;
  68
  69   /* Set once it has been finalized so we consider it to be output.  */
  70   unsigned finalized : 1;
  71
  72   /* False when there something makes inlining impossible (such as va_arg).  */
  73   unsigned inlinable : 1;
  74
  75   /* True when function should be inlined independently on its size.  */
  76   unsigned disregard_inline_limits : 1;
  77
  78   /* True when the function has been originally extern inline, but it is
  79      redefined now.  */
  80   unsigned redefined_extern_inline : 1;
  81
  82   /* True if statics_read_for_function and
  83      statics_written_for_function contain valid data.  */
  84   unsigned for_functions_valid : 1;
  85
  86   /* True if the function is going to be emitted in some other translation
  87      unit, referenced from vtable.  */
  88   unsigned vtable_method : 1;
  89 };
  90
  91 /* Information about the function that needs to be computed globally
  92    once compilation is finished.  Available only with -funit-at-time.  */
  93
  94 struct cgraph_global_info GTY(())
  95 {
  96   /* Estimated stack frame consumption by the function.  */
  97   HOST_WIDE_INT estimated_stack_size;
  98   /* Expected offset of the stack frame of inlined function.  */
  99   HOST_WIDE_INT stack_frame_offset;
 100
 101   /* For inline clones this points to the function they will be inlined into.  */
 102   struct cgraph_node *inlined_to;
 103
 104   /* Estimated size of the function after inlining.  */
 105   int insns;
 106
 107   /* Estimated growth after inlining.  INT_MIN if not computed.  */
 108   int estimated_growth;
 109
 110   /* Set iff the function has been inlined at least once.  */
 111   bool inlined;
 112 };
 113
 114 /* Information about the function that is propagated by the RTL backend.
 115    Available only for functions that has been already assembled.  */
 116
 117 struct cgraph_rtl_info GTY(())
 118 {
 119    int preferred_incoming_stack_boundary;
 120 };
 121
 122 /* The cgraph data structure.
 123    Each function decl has assigned cgraph_node listing callees and callers.  */
 124
 125 struct cgraph_node GTY((chain_next ("%h.next"), chain_prev ("%h.previous")))
 126 {
 127   tree decl;
 128   struct cgraph_edge *callees;
 129   struct cgraph_edge *callers;
 130   struct cgraph_node *next;
 131   struct cgraph_node *previous;
 132   /* For nested functions points to function the node is nested in.  */
 133   struct cgraph_node *origin;
 134   /* Points to first nested function, if any.  */
 135   struct cgraph_node *nested;
 136   /* Pointer to the next function with same origin, if any.  */
 137   struct cgraph_node *next_nested;
 138   /* Pointer to the next function in cgraph_nodes_queue.  */
 139   struct cgraph_node *next_needed;
 140   /* Pointer to the next clone.  */
 141   struct cgraph_node *next_clone;
 142   struct cgraph_node *prev_clone;
 143   /* Pointer to a single unique cgraph node for this function.  If the
 144      function is to be output, this is the copy that will survive.  */
 145   struct cgraph_node *master_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   /* Set when function must be output - it is externally visible
 164      or its address is taken.  */
 165   unsigned needed : 1;
 166   /* Set when function is reachable by call from other function
 167      that is either reachable or needed.  */
 168   unsigned reachable : 1;
 169   /* Set once the function is lowered (i.e. its CFG is built).  */
 170   unsigned lowered : 1;
 171   /* Set once the function has been instantiated and its callee
 172      lists created.  */
 173   unsigned analyzed : 1;
 174   /* Set when function is scheduled to be assembled.  */
 175   unsigned output : 1;
 176   /* Set for aliases once they got through assemble_alias.  */
 177   unsigned alias : 1;
 178
 179   /* In non-unit-at-a-time mode the function body of inline candidates is saved
 180      into clone before compiling so the function in original form can be
 181      inlined later.  This pointer points to the clone.  */
 182   tree inline_decl;
 183
 184   /* unique id for profiling. pid is not suitable because of different
 185      number of cfg nodes with -fprofile-generate and -fprofile-use */
 186   int pid;
 187 };
 188
 189 struct cgraph_edge GTY((chain_next ("%h.next_caller"), chain_prev ("%h.prev_caller")))
 190 {
 191   struct cgraph_node *caller;
 192   struct cgraph_node *callee;
 193   struct cgraph_edge *prev_caller;
 194   struct cgraph_edge *next_caller;
 195   struct cgraph_edge *prev_callee;
 196   struct cgraph_edge *next_callee;
 197   tree call_stmt;
 198   PTR GTY ((skip (""))) aux;
 199   /* When NULL, inline this call.  When non-NULL, points to the explanation
 200      why function was not inlined.  */
 201   const char *inline_failed;
 202   /* Expected number of executions: calculated in profile.c.  */
 203   gcov_type count;
 204   /* Expected frequency of executions within the function.
 205      When set to CGRAPH_FREQ_BASE, the edge is expected to be called once
 206      per function call.  The range is 0 to CGRAPH_FREQ_MAX.  */
 207   int frequency;
 208   /* Depth of loop nest, 1 means no loop nest.  */
 209   int loop_nest;
 210 };
 211
 212 #define CGRAPH_FREQ_BASE 1000
 213 #define CGRAPH_FREQ_MAX 100000
 214
 215 typedef struct cgraph_edge *cgraph_edge_p;
 216
 217 DEF_VEC_P(cgraph_edge_p);
 218 DEF_VEC_ALLOC_P(cgraph_edge_p,heap);
 219
 220 /* The varpool data structure.
 221    Each static variable decl has assigned varpool_node.  */
 222
 223 struct varpool_node GTY(())
 224 {
 225   tree decl;
 226   /* Pointer to the next function in varpool_nodes.  */
 227   struct varpool_node *next;
 228   /* Pointer to the next function in varpool_nodes_queue.  */
 229   struct varpool_node *next_needed;
 230   /* Ordering of all cgraph nodes.  */
 231   int order;
 232
 233   /* Set when function must be output - it is externally visible
 234      or its address is taken.  */
 235   unsigned needed : 1;
 236   /* Needed variables might become dead by optimization.  This flag
 237      forces the variable to be output even if it appears dead otherwise.  */
 238   unsigned force_output : 1;
 239   /* Set once the variable has been instantiated and its callee
 240      lists created.  */
 241   unsigned analyzed : 1;
 242   /* Set once it has been finalized so we consider it to be output.  */
 243   unsigned finalized : 1;
 244   /* Set when variable is scheduled to be assembled.  */
 245   unsigned output : 1;
 246   /* Set when function is visible by other units.  */
 247   unsigned externally_visible : 1;
 248   /* Set for aliases once they got through assemble_alias.  */
 249   unsigned alias : 1;
 250 };
 251
 252 /* Every top level asm statement is put into a cgraph_asm_node.  */
 253
 254 struct cgraph_asm_node GTY(())
 255 {
 256   /* Next asm node.  */
 257   struct cgraph_asm_node *next;
 258   /* String for this asm node.  */
 259   tree asm_str;
 260   /* Ordering of all cgraph nodes.  */
 261   int order;
 262 };
 263
 264 extern GTY(()) struct cgraph_node *cgraph_nodes;
 265 extern GTY(()) int cgraph_n_nodes;
 266 extern GTY(()) int cgraph_max_uid;
 267 extern GTY(()) int cgraph_max_pid;
 268 extern bool cgraph_global_info_ready;
 269 enum cgraph_state
 270 {
 271   /* Callgraph is being constructed.  It is safe to add new functions.  */
 272   CGRAPH_STATE_CONSTRUCTION,
 273   /* Callgraph is built and IPA passes are being run.  */
 274   CGRAPH_STATE_IPA,
 275   /* Callgraph is built and all functions are transformed to SSA form.  */
 276   CGRAPH_STATE_IPA_SSA,
 277   /* Functions are now ordered and being passed to RTL expanders.  */
 278   CGRAPH_STATE_EXPANSION,
 279   /* All cgraph expansion is done.  */
 280   CGRAPH_STATE_FINISHED
 281 };
 282 extern enum cgraph_state cgraph_state;
 283 extern bool cgraph_function_flags_ready;
 284 extern GTY(()) struct cgraph_node *cgraph_nodes_queue;
 285 extern GTY(()) struct cgraph_node *cgraph_new_nodes;
 286
 287 extern GTY(()) struct cgraph_asm_node *cgraph_asm_nodes;
 288 extern GTY(()) int cgraph_order;
 289
 290 /* In cgraph.c  */
 291 void dump_cgraph (FILE *);
 292 void dump_cgraph_node (FILE *, struct cgraph_node *);
 293 void cgraph_insert_node_to_hashtable (struct cgraph_node *node);
 294 void cgraph_remove_edge (struct cgraph_edge *);
 295 void cgraph_remove_node (struct cgraph_node *);
 296 void cgraph_release_function_body (struct cgraph_node *);
 297 void cgraph_node_remove_callees (struct cgraph_node *node);
 298 struct cgraph_edge *cgraph_create_edge (struct cgraph_node *,
 299                                         struct cgraph_node *,
 300                                         tree, gcov_type, int, int);
 301 struct cgraph_node *cgraph_node (tree);
 302 struct cgraph_node *cgraph_node_for_asm (tree asmname);
 303 struct cgraph_edge *cgraph_edge (struct cgraph_node *, tree);
 304 void cgraph_set_call_stmt (struct cgraph_edge *, tree);
 305 struct cgraph_local_info *cgraph_local_info (tree);
 306 struct cgraph_global_info *cgraph_global_info (tree);
 307 struct cgraph_rtl_info *cgraph_rtl_info (tree);
 308 const char * cgraph_node_name (struct cgraph_node *);
 309 struct cgraph_edge * cgraph_clone_edge (struct cgraph_edge *,
 310                                         struct cgraph_node *,
 311                                         tree, gcov_type, int, int, bool);
 312 struct cgraph_node * cgraph_clone_node (struct cgraph_node *, gcov_type, int,
 313                                         int, bool);
 314
 315 void cgraph_redirect_edge_callee (struct cgraph_edge *, struct cgraph_node *);
 316
 317 struct cgraph_asm_node *cgraph_add_asm_node (tree);
 318
 319 bool cgraph_function_possibly_inlined_p (tree);
 320 void cgraph_unnest_node (struct cgraph_node *);
 321
 322 enum availability cgraph_function_body_availability (struct cgraph_node *);
 323 bool cgraph_is_master_clone (struct cgraph_node *);
 324 struct cgraph_node *cgraph_master_clone (struct cgraph_node *);
 325 void cgraph_add_new_function (tree, bool);
 326
 327 /* In cgraphunit.c  */
 328 void cgraph_finalize_function (tree, bool);
 329 void cgraph_finalize_compilation_unit (void);
 330 void cgraph_optimize (void);
 331 void cgraph_mark_needed_node (struct cgraph_node *);
 332 void cgraph_mark_reachable_node (struct cgraph_node *);
 333 bool cgraph_inline_p (struct cgraph_edge *, const char **reason);
 334 bool cgraph_preserve_function_body_p (tree);
 335 void verify_cgraph (void);
 336 void verify_cgraph_node (struct cgraph_node *);
 337 void cgraph_build_static_cdtor (char which, tree body, int priority);
 338 void cgraph_reset_static_var_maps (void);
 339 void init_cgraph (void);
 340 struct cgraph_node *cgraph_function_versioning (struct cgraph_node *,
 341                                                 VEC(cgraph_edge_p,heap)*,
 342                                                 varray_type);
 343 void cgraph_analyze_function (struct cgraph_node *);
 344 struct cgraph_node *save_inline_function_body (struct cgraph_node *);
 345 void record_references_in_initializer (tree);
 346 bool cgraph_process_new_functions (void);
 347
 348 /* In ipa.c  */
 349 bool cgraph_remove_unreachable_nodes (bool, FILE *);
 350 int cgraph_postorder (struct cgraph_node **);
 351
 352 /* In varpool.c  */
 353
 354 extern GTY(()) struct varpool_node *varpool_nodes_queue;
 355 extern GTY(()) struct varpool_node *varpool_nodes;
 356
 357 struct varpool_node *varpool_node (tree);
 358 struct varpool_node *varpool_node_for_asm (tree asmname);
 359 void varpool_mark_needed_node (struct varpool_node *);
 360 void dump_varpool (FILE *);
 361 void dump_varpool_node (FILE *, struct varpool_node *);
 362
 363 void varpool_finalize_decl (tree);
 364 bool decide_is_variable_needed (struct varpool_node *, tree);
 365 enum availability cgraph_variable_initializer_availability (struct varpool_node *);
 366
 367 bool varpool_assemble_pending_decls (void);
 368 bool varpool_assemble_decl (struct varpool_node *node);
 369 bool varpool_analyze_pending_decls (void);
 370 void varpool_output_debug_info (void);
 371 void varpool_remove_unreferenced_decls (void);
 372
 373 /* Walk all reachable static variables.  */
 374 #define FOR_EACH_STATIC_VARIABLE(node) \
 375    for ((node) = varpool_nodes_queue; (node); (node) = (node)->next_needed)
 376
 377 /* Return first reachable static variable with initializer.  */
 378 static inline struct varpool_node *
 379 varpool_first_static_initializer (void)
 380 {
 381   struct varpool_node *node;
 382   for (node = varpool_nodes_queue; node; node = node->next_needed)
 383     {
 384       gcc_assert (TREE_CODE (node->decl) == VAR_DECL);
 385       if (DECL_INITIAL (node->decl))
 386         return node;
 387     }
 388   return NULL;
 389 }
 390
 391 /* Return next reachable static variable with initializer after NODE.  */
 392 static inline struct varpool_node *
 393 varpool_next_static_initializer (struct varpool_node *node)
 394 {
 395   for (node = node->next_needed; node; node = node->next_needed)
 396     {
 397       gcc_assert (TREE_CODE (node->decl) == VAR_DECL);
 398       if (DECL_INITIAL (node->decl))
 399         return node;
 400     }
 401   return NULL;
 402 }
 403
 404 /* Walk all static variables with initializer set.  */
 405 #define FOR_EACH_STATIC_INITIALIZER(node) \
 406    for ((node) = varpool_first_static_initializer (); (node); \
 407         (node) = varpool_next_static_initializer (node))
 408
 409 /* In ipa-inline.c  */
 410 void cgraph_clone_inlined_nodes (struct cgraph_edge *, bool, bool);
 411 void cgraph_mark_inline_edge (struct cgraph_edge *, bool);
 412 bool cgraph_default_inline_p (struct cgraph_node *, const char **);
 413 #endif  /* GCC_CGRAPH_H  */