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   /* Depth of loop nest, 1 means no loop nest.  */
 205   int loop_nest;
 206 };
 207
 208 typedef struct cgraph_edge *cgraph_edge_p;
 209
 210 DEF_VEC_P(cgraph_edge_p);
 211 DEF_VEC_ALLOC_P(cgraph_edge_p,heap);
 212
 213 /* The varpool data structure.
 214    Each static variable decl has assigned varpool_node.  */
 215
 216 struct varpool_node GTY(())
 217 {
 218   tree decl;
 219   /* Pointer to the next function in varpool_nodes.  */
 220   struct varpool_node *next;
 221   /* Pointer to the next function in varpool_nodes_queue.  */
 222   struct varpool_node *next_needed;
 223   /* Ordering of all cgraph nodes.  */
 224   int order;
 225
 226   /* Set when function must be output - it is externally visible
 227      or its address is taken.  */
 228   unsigned needed : 1;
 229   /* Needed variables might become dead by optimization.  This flag
 230      forces the variable to be output even if it appears dead otherwise.  */
 231   unsigned force_output : 1;
 232   /* Set once the variable has been instantiated and its callee
 233      lists created.  */
 234   unsigned analyzed : 1;
 235   /* Set once it has been finalized so we consider it to be output.  */
 236   unsigned finalized : 1;
 237   /* Set when variable is scheduled to be assembled.  */
 238   unsigned output : 1;
 239   /* Set when function is visible by other units.  */
 240   unsigned externally_visible : 1;
 241   /* Set for aliases once they got through assemble_alias.  */
 242   unsigned alias : 1;
 243 };
 244
 245 /* Every top level asm statement is put into a cgraph_asm_node.  */
 246
 247 struct cgraph_asm_node GTY(())
 248 {
 249   /* Next asm node.  */
 250   struct cgraph_asm_node *next;
 251   /* String for this asm node.  */
 252   tree asm_str;
 253   /* Ordering of all cgraph nodes.  */
 254   int order;
 255 };
 256
 257 extern GTY(()) struct cgraph_node *cgraph_nodes;
 258 extern GTY(()) int cgraph_n_nodes;
 259 extern GTY(()) int cgraph_max_uid;
 260 extern GTY(()) int cgraph_max_pid;
 261 extern bool cgraph_global_info_ready;
 262 enum cgraph_state
 263 {
 264   /* Callgraph is being constructed.  It is safe to add new functions.  */
 265   CGRAPH_STATE_CONSTRUCTION,
 266   /* Callgraph is built and IPA passes are being run.  */
 267   CGRAPH_STATE_IPA,
 268   /* Callgraph is built and all functions are transformed to SSA form.  */
 269   CGRAPH_STATE_IPA_SSA,
 270   /* Functions are now ordered and being passed to RTL expanders.  */
 271   CGRAPH_STATE_EXPANSION,
 272   /* All cgraph expansion is done.  */
 273   CGRAPH_STATE_FINISHED
 274 };
 275 extern enum cgraph_state cgraph_state;
 276 extern bool cgraph_function_flags_ready;
 277 extern GTY(()) struct cgraph_node *cgraph_nodes_queue;
 278 extern GTY(()) struct cgraph_node *cgraph_new_nodes;
 279
 280 extern GTY(()) struct cgraph_asm_node *cgraph_asm_nodes;
 281 extern GTY(()) int cgraph_order;
 282
 283 /* In cgraph.c  */
 284 void dump_cgraph (FILE *);
 285 void dump_cgraph_node (FILE *, struct cgraph_node *);
 286 void cgraph_insert_node_to_hashtable (struct cgraph_node *node);
 287 void cgraph_remove_edge (struct cgraph_edge *);
 288 void cgraph_remove_node (struct cgraph_node *);
 289 void cgraph_release_function_body (struct cgraph_node *);
 290 void cgraph_node_remove_callees (struct cgraph_node *node);
 291 struct cgraph_edge *cgraph_create_edge (struct cgraph_node *,
 292                                         struct cgraph_node *,
 293                                         tree, gcov_type, int);
 294 struct cgraph_node *cgraph_node (tree);
 295 struct cgraph_node *cgraph_node_for_asm (tree asmname);
 296 struct cgraph_edge *cgraph_edge (struct cgraph_node *, tree);
 297 void cgraph_set_call_stmt (struct cgraph_edge *, tree);
 298 struct cgraph_local_info *cgraph_local_info (tree);
 299 struct cgraph_global_info *cgraph_global_info (tree);
 300 struct cgraph_rtl_info *cgraph_rtl_info (tree);
 301 const char * cgraph_node_name (struct cgraph_node *);
 302 struct cgraph_edge * cgraph_clone_edge (struct cgraph_edge *,
 303                                         struct cgraph_node *,
 304                                         tree, gcov_type, int, bool);
 305 struct cgraph_node * cgraph_clone_node (struct cgraph_node *, gcov_type,
 306                                         int, bool);
 307
 308 void cgraph_redirect_edge_callee (struct cgraph_edge *, struct cgraph_node *);
 309
 310 struct cgraph_asm_node *cgraph_add_asm_node (tree);
 311
 312 bool cgraph_function_possibly_inlined_p (tree);
 313 void cgraph_unnest_node (struct cgraph_node *);
 314
 315 enum availability cgraph_function_body_availability (struct cgraph_node *);
 316 bool cgraph_is_master_clone (struct cgraph_node *);
 317 struct cgraph_node *cgraph_master_clone (struct cgraph_node *);
 318 void cgraph_add_new_function (tree, bool);
 319
 320 /* In cgraphunit.c  */
 321 void cgraph_finalize_function (tree, bool);
 322 void cgraph_finalize_compilation_unit (void);
 323 void cgraph_optimize (void);
 324 void cgraph_mark_needed_node (struct cgraph_node *);
 325 void cgraph_mark_reachable_node (struct cgraph_node *);
 326 bool cgraph_inline_p (struct cgraph_edge *, const char **reason);
 327 bool cgraph_preserve_function_body_p (tree);
 328 void verify_cgraph (void);
 329 void verify_cgraph_node (struct cgraph_node *);
 330 void cgraph_build_static_cdtor (char which, tree body, int priority);
 331 void cgraph_reset_static_var_maps (void);
 332 void init_cgraph (void);
 333 struct cgraph_node *cgraph_function_versioning (struct cgraph_node *,
 334                                                 VEC(cgraph_edge_p,heap)*,
 335                                                 varray_type);
 336 void cgraph_analyze_function (struct cgraph_node *);
 337 struct cgraph_node *save_inline_function_body (struct cgraph_node *);
 338 void record_references_in_initializer (tree);
 339 bool cgraph_process_new_functions (void);
 340
 341 /* In ipa.c  */
 342 bool cgraph_remove_unreachable_nodes (bool, FILE *);
 343 int cgraph_postorder (struct cgraph_node **);
 344
 345 /* In varpool.c  */
 346
 347 extern GTY(()) struct varpool_node *varpool_nodes_queue;
 348 extern GTY(()) struct varpool_node *varpool_nodes;
 349
 350 struct varpool_node *varpool_node (tree);
 351 struct varpool_node *varpool_node_for_asm (tree asmname);
 352 void varpool_mark_needed_node (struct varpool_node *);
 353 void dump_varpool (FILE *);
 354 void dump_varpool_node (FILE *, struct varpool_node *);
 355
 356 void varpool_finalize_decl (tree);
 357 bool decide_is_variable_needed (struct varpool_node *, tree);
 358 enum availability cgraph_variable_initializer_availability (struct varpool_node *);
 359
 360 bool varpool_assemble_pending_decls (void);
 361 bool varpool_assemble_decl (struct varpool_node *node);
 362 bool varpool_analyze_pending_decls (void);
 363 void varpool_output_debug_info (void);
 364 void varpool_remove_unreferenced_decls (void);
 365
 366 /* Walk all reachable static variables.  */
 367 #define FOR_EACH_STATIC_VARIABLE(node) \
 368    for ((node) = varpool_nodes_queue; (node); (node) = (node)->next_needed)
 369
 370 /* Return first reachable static variable with initializer.  */
 371 static inline struct varpool_node *
 372 varpool_first_static_initializer (void)
 373 {
 374   struct varpool_node *node;
 375   for (node = varpool_nodes_queue; node; node = node->next_needed)
 376     {
 377       gcc_assert (TREE_CODE (node->decl) == VAR_DECL);
 378       if (DECL_INITIAL (node->decl))
 379         return node;
 380     }
 381   return NULL;
 382 }
 383
 384 /* Return next reachable static variable with initializer after NODE.  */
 385 static inline struct varpool_node *
 386 varpool_next_static_initializer (struct varpool_node *node)
 387 {
 388   for (node = node->next_needed; node; node = node->next_needed)
 389     {
 390       gcc_assert (TREE_CODE (node->decl) == VAR_DECL);
 391       if (DECL_INITIAL (node->decl))
 392         return node;
 393     }
 394   return NULL;
 395 }
 396
 397 /* Walk all static variables with initializer set.  */
 398 #define FOR_EACH_STATIC_INITIALIZER(node) \
 399    for ((node) = varpool_first_static_initializer (); (node); \
 400         (node) = varpool_next_static_initializer (node))
 401
 402 /* In ipa-inline.c  */
 403 void cgraph_clone_inlined_nodes (struct cgraph_edge *, bool, bool);
 404 void cgraph_mark_inline_edge (struct cgraph_edge *, bool);
 405 bool cgraph_default_inline_p (struct cgraph_node *, const char **);
 406 #endif  /* GCC_CGRAPH_H  */