gcc/cgraph.h

   1 /* Callgraph handling code.
   2    Copyright (C) 2003, 2004, 2005 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 /* Information about the function collected locally.
  50    Available after function is analyzed.  */
  51
  52 struct cgraph_local_info GTY(())
  53 {
  54   /* Size of the function before inlining.  */
  55   int self_insns;
  56
  57   /* Set when function function is visible in current compilation unit only
  58      and its address is never taken.  */
  59   bool local;
  60
  61   /* Set when function is visible by other units.  */
  62   bool externally_visible;
  63
  64   /* Set once it has been finalized so we consider it to be output.  */
  65   bool finalized;
  66
  67   /* False when there something makes inlining impossible (such as va_arg).  */
  68   bool inlinable;
  69
  70   /* True when function should be inlined independently on its size.  */
  71   bool disregard_inline_limits;
  72
  73   /* True when the function has been originally extern inline, but it is
  74      redefined now.  */
  75   bool redefined_extern_inline;
  76
  77   /* True if statics_read_for_function and
  78      statics_written_for_function contain valid data.  */
  79   bool for_functions_valid;
  80
  81   /* True if the function is going to be emitted in some other translation
  82      unit, referenced from vtable.  */
  83   bool vtable_method;
  84 };
  85
  86 /* Information about the function that needs to be computed globally
  87    once compilation is finished.  Available only with -funit-at-time.  */
  88
  89 struct cgraph_global_info GTY(())
  90 {
  91   /* For inline clones this points to the function they will be inlined into.  */
  92   struct cgraph_node *inlined_to;
  93
  94   /* Estimated size of the function after inlining.  */
  95   int insns;
  96
  97   /* Estimated growth after inlining.  INT_MIN if not computed.  */
  98   int estimated_growth;
  99
 100   /* Set iff the function has been inlined at least once.  */
 101   bool inlined;
 102 };
 103
 104 /* Information about the function that is propagated by the RTL backend.
 105    Available only for functions that has been already assembled.  */
 106
 107 struct cgraph_rtl_info GTY(())
 108 {
 109    int preferred_incoming_stack_boundary;
 110    bool const_function;
 111    bool pure_function;
 112 };
 113
 114 /* The cgraph data structure.
 115    Each function decl has assigned cgraph_node listing callees and callers.  */
 116
 117 struct cgraph_node GTY((chain_next ("%h.next"), chain_prev ("%h.previous")))
 118 {
 119   tree decl;
 120   struct cgraph_edge *callees;
 121   struct cgraph_edge *callers;
 122   struct cgraph_node *next;
 123   struct cgraph_node *previous;
 124   /* For nested functions points to function the node is nested in.  */
 125   struct cgraph_node *origin;
 126   /* Points to first nested function, if any.  */
 127   struct cgraph_node *nested;
 128   /* Pointer to the next function with same origin, if any.  */
 129   struct cgraph_node *next_nested;
 130   /* Pointer to the next function in cgraph_nodes_queue.  */
 131   struct cgraph_node *next_needed;
 132   /* Pointer to the next clone.  */
 133   struct cgraph_node *next_clone;
 134   struct cgraph_node *prev_clone;
 135   /* Pointer to a single unique cgraph node for this function.  If the
 136      function is to be output, this is the copy that will survive.  */
 137   struct cgraph_node *master_clone;
 138
 139   PTR GTY ((skip)) aux;
 140
 141   struct cgraph_local_info local;
 142   struct cgraph_global_info global;
 143   struct cgraph_rtl_info rtl;
 144
 145   /* Expected number of executions: calculated in profile.c.  */
 146   gcov_type count;
 147   /* Unique id of the node.  */
 148   int uid;
 149   /* Set when function must be output - it is externally visible
 150      or its address is taken.  */
 151   bool needed;
 152   /* Set when function is reachable by call from other function
 153      that is either reachable or needed.  */
 154   bool reachable;
 155   /* Set once the function is lowered (ie it's CFG is built).  */
 156   bool lowered;
 157   /* Set once the function has been instantiated and its callee
 158      lists created.  */
 159   bool analyzed;
 160   /* Set when function is scheduled to be assembled.  */
 161   bool output;
 162   /* Set when function is visible by other units.  */
 163   bool externally_visible;
 164   /* Set for aliases once they got through assemble_alias.  */
 165   bool alias;
 166 };
 167
 168 struct cgraph_edge GTY((chain_next ("%h.next_caller"), chain_prev ("%h.prev_caller")))
 169 {
 170   struct cgraph_node *caller;
 171   struct cgraph_node *callee;
 172   struct cgraph_edge *prev_caller;
 173   struct cgraph_edge *next_caller;
 174   struct cgraph_edge *prev_callee;
 175   struct cgraph_edge *next_callee;
 176   tree call_stmt;
 177   PTR GTY ((skip (""))) aux;
 178   /* When NULL, inline this call.  When non-NULL, points to the explanation
 179      why function was not inlined.  */
 180   const char *inline_failed;
 181   /* Expected number of executions: calculated in profile.c.  */
 182   gcov_type count;
 183   /* Depth of loop nest, 1 means no loop nest.  */
 184   int loop_nest;
 185 };
 186
 187 /* The cgraph_varpool data structure.
 188    Each static variable decl has assigned cgraph_varpool_node.  */
 189
 190 struct cgraph_varpool_node GTY(())
 191 {
 192   tree decl;
 193   /* Pointer to the next function in cgraph_varpool_nodes.  */
 194   struct cgraph_varpool_node *next;
 195   /* Pointer to the next function in cgraph_varpool_nodes_queue.  */
 196   struct cgraph_varpool_node *next_needed;
 197
 198   /* Set when function must be output - it is externally visible
 199      or its address is taken.  */
 200   bool needed;
 201   /* Needed variables might become dead by optimization.  This flag
 202      forces the variable to be output even if it appears dead otherwise.  */
 203   bool force_output;
 204   /* Set once the variable has been instantiated and its callee
 205      lists created.  */
 206   bool analyzed;
 207   /* Set once it has been finalized so we consider it to be output.  */
 208   bool finalized;
 209   /* Set when variable is scheduled to be assembled.  */
 210   bool output;
 211   /* Set when function is visible by other units.  */
 212   bool externally_visible;
 213   /* Set for aliases once they got through assemble_alias.  */
 214   bool alias;
 215 };
 216
 217 extern GTY(()) struct cgraph_node *cgraph_nodes;
 218 extern GTY(()) int cgraph_n_nodes;
 219 extern GTY(()) int cgraph_max_uid;
 220 extern bool cgraph_global_info_ready;
 221 extern bool cgraph_function_flags_ready;
 222 extern GTY(()) struct cgraph_node *cgraph_nodes_queue;
 223
 224 extern GTY(()) struct cgraph_varpool_node *cgraph_varpool_first_unanalyzed_node;
 225 extern GTY(()) struct cgraph_varpool_node *cgraph_varpool_nodes_queue;
 226
 227 /* In cgraph.c  */
 228 void dump_cgraph (FILE *);
 229 void dump_cgraph_node (FILE *, struct cgraph_node *);
 230 void dump_varpool (FILE *);
 231 void dump_cgraph_varpool_node (FILE *, struct cgraph_varpool_node *);
 232 void cgraph_remove_edge (struct cgraph_edge *);
 233 void cgraph_remove_node (struct cgraph_node *);
 234 void cgraph_node_remove_callees (struct cgraph_node *node);
 235 struct cgraph_edge *cgraph_create_edge (struct cgraph_node *,
 236                                         struct cgraph_node *,
 237                                         tree, gcov_type, int);
 238 struct cgraph_node *cgraph_node (tree);
 239 struct cgraph_node *cgraph_node_for_asm (tree asmname);
 240 struct cgraph_edge *cgraph_edge (struct cgraph_node *, tree);
 241 struct cgraph_local_info *cgraph_local_info (tree);
 242 struct cgraph_global_info *cgraph_global_info (tree);
 243 struct cgraph_rtl_info *cgraph_rtl_info (tree);
 244 const char * cgraph_node_name (struct cgraph_node *);
 245 struct cgraph_edge * cgraph_clone_edge (struct cgraph_edge *, struct cgraph_node *, tree, int, int);
 246 struct cgraph_node * cgraph_clone_node (struct cgraph_node *, gcov_type, int);
 247
 248 struct cgraph_varpool_node *cgraph_varpool_node (tree);
 249 struct cgraph_varpool_node *cgraph_varpool_node_for_asm (tree asmname);
 250 void cgraph_varpool_mark_needed_node (struct cgraph_varpool_node *);
 251 void cgraph_varpool_finalize_decl (tree);
 252 void cgraph_redirect_edge_callee (struct cgraph_edge *, struct cgraph_node *);
 253
 254 bool cgraph_function_possibly_inlined_p (tree);
 255 void cgraph_unnest_node (struct cgraph_node *);
 256 void cgraph_varpool_enqueue_needed_node (struct cgraph_varpool_node *);
 257 void cgraph_varpool_reset_queue (void);
 258 bool decide_is_variable_needed (struct cgraph_varpool_node *, tree);
 259
 260 enum availability cgraph_function_body_availability (struct cgraph_node *);
 261 enum availability cgraph_variable_initializer_availability (struct cgraph_varpool_node *);
 262 bool cgraph_is_master_clone (struct cgraph_node *);
 263 struct cgraph_node *cgraph_master_clone (struct cgraph_node *);
 264
 265 /* In cgraphunit.c  */
 266 bool cgraph_assemble_pending_functions (void);
 267 bool cgraph_varpool_assemble_pending_decls (void);
 268 void cgraph_finalize_function (tree, bool);
 269 void cgraph_lower_function (struct cgraph_node *);
 270 void cgraph_finalize_compilation_unit (void);
 271 void cgraph_optimize (void);
 272 void cgraph_mark_needed_node (struct cgraph_node *);
 273 void cgraph_mark_reachable_node (struct cgraph_node *);
 274 bool cgraph_inline_p (struct cgraph_edge *, const char **reason);
 275 bool cgraph_preserve_function_body_p (tree);
 276 void verify_cgraph (void);
 277 void verify_cgraph_node (struct cgraph_node *);
 278 void cgraph_mark_inline_edge (struct cgraph_edge *e);
 279 void cgraph_clone_inlined_nodes (struct cgraph_edge *e, bool duplicate);
 280 void cgraph_build_static_cdtor (char which, tree body, int priority);
 281 void cgraph_reset_static_var_maps (void);
 282 void init_cgraph (void);
 283
 284 /* In ipa.c  */
 285 bool cgraph_remove_unreachable_nodes (bool, FILE *);
 286 int cgraph_postorder (struct cgraph_node **);
 287
 288 /* In ipa-inline.c  */
 289 void cgraph_decide_inlining_incrementally (struct cgraph_node *);
 290 void cgraph_clone_inlined_nodes (struct cgraph_edge *, bool);
 291 void cgraph_mark_inline_edge (struct cgraph_edge *);
 292 bool cgraph_default_inline_p (struct cgraph_node *);
 293 #endif  /* GCC_CGRAPH_H  */