gcc/cgraph.h

   1 /* Callgraph handling code.
   2    Copyright (C) 2003 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, 59 Temple Place - Suite 330, Boston, MA
  20 02111-1307, USA.  */
  21
  22 #ifndef GCC_CGRAPH_H
  23 #define GCC_CGRAPH_H
  24
  25 /* Information about the function collected locally.
  26    Available after function is analyzed.  */
  27
  28 struct cgraph_local_info GTY(())
  29 {
  30   /* Set when function function is visible in current compilation unit only
  31      and it's address is never taken.  */
  32   bool local;
  33   /* Set once it has been finalized so we consider it to be output.  */
  34   bool finalized;
  35
  36   /* False when there something makes inlining impossible (such as va_arg).  */
  37   bool inlinable;
  38   /* True when function should be inlined independently on it's size.  */
  39   bool disregard_inline_limits;
  40   /* Size of the function before inlining.  */
  41   int self_insns;
  42 };
  43
  44 /* Information about the function that needs to be computed globally
  45    once compilation is finished.  Available only with -funit-at-time.  */
  46
  47 struct cgraph_global_info GTY(())
  48 {
  49   /* Set when the function will be inlined exactly once.  */
  50   bool inline_once;
  51
  52   /* Estimated size of the function after inlining.  */
  53   int insns;
  54
  55   /* Number of times given function will be cloned during output.  */
  56   int cloned_times;
  57
  58   /* Set to true for all reachable functions before inlining is decided.
  59      Once we inline all calls to the function and the function is local,
  60      it is set to false.  */
  61   bool will_be_output;
  62
  63   /* Set iff at least one of the caller edges has inline_call flag set.  */
  64   bool inlined;
  65 };
  66
  67 /* Information about the function that is propagated by the RTL backend.
  68    Available only for functions that has been already assembled.  */
  69
  70 struct cgraph_rtl_info GTY(())
  71 {
  72    bool const_function;
  73    bool pure_function;
  74    int preferred_incoming_stack_boundary;
  75 };
  76
  77
  78 /* The cgraph data structure.
  79    Each function decl has assigned cgraph_node listing callees and callers.  */
  80
  81 struct cgraph_node GTY((chain_next ("%h.next"), chain_prev ("%h.previous")))
  82 {
  83   tree decl;
  84   struct cgraph_edge *callees;
  85   struct cgraph_edge *callers;
  86   struct cgraph_node *next;
  87   struct cgraph_node *previous;
  88   /* For nested functions points to function the node is nested in.  */
  89   struct cgraph_node *origin;
  90   /* Points to first nested function, if any.  */
  91   struct cgraph_node *nested;
  92   /* Pointer to the next function with same origin, if any.  */
  93   struct cgraph_node *next_nested;
  94   /* Pointer to the next function in cgraph_nodes_queue.  */
  95   struct cgraph_node *next_needed;
  96   /* Unique id of the node.  */
  97   int uid;
  98   PTR GTY ((skip (""))) aux;
  99
 100   /* Set when function must be output - it is externally visible
 101      or it's address is taken.  */
 102   bool needed;
 103   /* Set when function is reachable by call from other function
 104      that is either reachable or needed.  */
 105   bool reachable;
 106   /* Set once the function has been instantiated and its callee
 107      lists created.  */
 108   bool analyzed;
 109   /* Set when function is scheduled to be assembled.  */
 110   bool output;
 111   struct cgraph_local_info local;
 112   struct cgraph_global_info global;
 113   struct cgraph_rtl_info rtl;
 114 };
 115
 116 struct cgraph_edge GTY(())
 117 {
 118   struct cgraph_node *caller;
 119   struct cgraph_node *callee;
 120   struct cgraph_edge *next_caller;
 121   struct cgraph_edge *next_callee;
 122   /* When NULL, inline this call.  When non-NULL, points to the explanation
 123      why function was not inlined.  */
 124   const char *inline_failed;
 125 };
 126
 127 /* The cgraph_varpool data structure.
 128    Each static variable decl has assigned cgraph_varpool_node.  */
 129
 130 struct cgraph_varpool_node GTY(())
 131 {
 132   tree decl;
 133   /* Pointer to the next function in cgraph_varpool_nodes_queue.  */
 134   struct cgraph_varpool_node *next_needed;
 135
 136   /* Set when function must be output - it is externally visible
 137      or it's address is taken.  */
 138   bool needed;
 139   /* Set once it has been finalized so we consider it to be output.  */
 140   bool finalized;
 141   /* Set when function is scheduled to be assembled.  */
 142   bool output;
 143 };
 144
 145 extern GTY(()) struct cgraph_node *cgraph_nodes;
 146 extern GTY(()) int cgraph_n_nodes;
 147 extern GTY(()) int cgraph_max_uid;
 148 extern bool cgraph_global_info_ready;
 149 extern GTY(()) struct cgraph_node *cgraph_nodes_queue;
 150 extern FILE *cgraph_dump_file;
 151
 152 extern GTY(()) int cgraph_varpool_n_nodes;
 153 extern GTY(()) struct cgraph_varpool_node *cgraph_varpool_nodes_queue;
 154
 155
 156 /* In cgraph.c  */
 157 void dump_cgraph (FILE *);
 158 void cgraph_remove_edge (struct cgraph_node *, struct cgraph_node *);
 159 void cgraph_remove_call (tree, tree);
 160 void cgraph_remove_node (struct cgraph_node *);
 161 struct cgraph_edge *cgraph_record_call (tree, tree);
 162 struct cgraph_node *cgraph_node (tree decl);
 163 struct cgraph_node *cgraph_node_for_identifier (tree id);
 164 bool cgraph_calls_p (tree, tree);
 165 struct cgraph_local_info *cgraph_local_info (tree);
 166 struct cgraph_global_info *cgraph_global_info (tree);
 167 struct cgraph_rtl_info *cgraph_rtl_info (tree);
 168 const char * cgraph_node_name (struct cgraph_node *);
 169
 170 struct cgraph_varpool_node *cgraph_varpool_node (tree decl);
 171 struct cgraph_varpool_node *cgraph_varpool_node_for_identifier (tree id);
 172 void cgraph_varpool_mark_needed_node (struct cgraph_varpool_node *);
 173 void cgraph_varpool_finalize_decl (tree);
 174 bool cgraph_varpool_assemble_pending_decls (void);
 175
 176 bool cgraph_function_possibly_inlined_p (tree);
 177
 178 /* In cgraphunit.c  */
 179 bool cgraph_assemble_pending_functions (void);
 180 void cgraph_finalize_function (tree, bool);
 181 void cgraph_finalize_compilation_unit (void);
 182 void cgraph_create_edges (tree, tree);
 183 void cgraph_optimize (void);
 184 void cgraph_mark_needed_node (struct cgraph_node *);
 185 void cgraph_mark_reachable_node (struct cgraph_node *);
 186 bool cgraph_inline_p (tree, tree, const char **reason);
 187
 188 #endif  /* GCC_CGRAPH_H  */