2012-07-09 Tom de Vries <tom@codesourcery.com>
[official-gcc.git] / gcc / cgraph.h
blob7b9098bad04cf2f8e48fad929e5dc3ed10b8fe30
1 /* Callgraph handling code.
2 Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011,
3 2012 Free Software Foundation, Inc.
4 Contributed by Jan Hubicka
6 This file is part of GCC.
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.
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.
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/>. */
22 #ifndef GCC_CGRAPH_H
23 #define GCC_CGRAPH_H
25 #include "plugin-api.h"
26 #include "vec.h"
27 #include "tree.h"
28 #include "basic-block.h"
29 #include "function.h"
30 #include "ipa-ref.h"
32 /* Symbol table consists of functions and variables.
33 TODO: add labels, constant pool and aliases. */
34 enum symtab_type
36 SYMTAB_SYMBOL,
37 SYMTAB_FUNCTION,
38 SYMTAB_VARIABLE
41 /* Base of all entries in the symbol table.
42 The symtab_node is inherited by cgraph and varpol nodes. */
43 struct GTY(()) symtab_node_base
45 /* Type of the symbol. */
46 enum symtab_type type;
47 tree decl;
48 struct ipa_ref_list ref_list;
49 /* Circular list of nodes in the same comdat group if non-NULL. */
50 symtab_node same_comdat_group;
51 /* Ordering of all symtab entries. */
52 int order;
53 enum ld_plugin_symbol_resolution resolution;
54 /* File stream where this node is being written to. */
55 struct lto_file_decl_data * lto_file_data;
57 /* Linked list of symbol table entries starting with symtab_nodes. */
58 symtab_node next;
59 symtab_node previous;
60 /* Linked list of symbols with the same asm name. There may be multiple
61 entries for single symbol name in the case of LTO resolutions,
62 existence of inline clones, or duplicated declaration. The last case
63 is a long standing bug frontends and builtin handling. */
64 symtab_node next_sharing_asm_name;
65 symtab_node previous_sharing_asm_name;
67 PTR GTY ((skip)) aux;
69 /* Set when function has address taken.
70 In current implementation it imply needed flag. */
71 unsigned address_taken : 1;
72 /* Set when variable is used from other LTRANS partition. */
73 unsigned used_from_other_partition : 1;
74 /* Set when function is available in the other LTRANS partition.
75 During WPA output it is used to mark nodes that are present in
76 multiple partitions. */
77 unsigned in_other_partition : 1;
78 /* Set when function is visible by other units. */
79 unsigned externally_visible : 1;
80 /* Needed variables might become dead by optimization. This flag
81 forces the variable to be output even if it appears dead otherwise. */
82 unsigned force_output : 1;
85 enum availability
87 /* Not yet set by cgraph_function_body_availability. */
88 AVAIL_UNSET,
89 /* Function body/variable initializer is unknown. */
90 AVAIL_NOT_AVAILABLE,
91 /* Function body/variable initializer is known but might be replaced
92 by a different one from other compilation unit and thus needs to
93 be dealt with a care. Like AVAIL_NOT_AVAILABLE it can have
94 arbitrary side effects on escaping variables and functions, while
95 like AVAILABLE it might access static variables. */
96 AVAIL_OVERWRITABLE,
97 /* Function body/variable initializer is known and will be used in final
98 program. */
99 AVAIL_AVAILABLE,
100 /* Function body/variable initializer is known and all it's uses are explicitly
101 visible within current unit (ie it's address is never taken and it is not
102 exported to other units).
103 Currently used only for functions. */
104 AVAIL_LOCAL
107 /* This is the information that is put into the cgraph local structure
108 to recover a function. */
109 struct lto_file_decl_data;
111 extern const char * const cgraph_availability_names[];
112 extern const char * const ld_plugin_symbol_resolution_names[];
114 /* Information about thunk, used only for same body aliases. */
116 struct GTY(()) cgraph_thunk_info {
117 /* Information about the thunk. */
118 HOST_WIDE_INT fixed_offset;
119 HOST_WIDE_INT virtual_value;
120 tree alias;
121 bool this_adjusting;
122 bool virtual_offset_p;
123 /* Set to true when alias node is thunk. */
124 bool thunk_p;
127 /* Information about the function collected locally.
128 Available after function is analyzed. */
130 struct GTY(()) cgraph_local_info {
131 /* Set when function function is visible in current compilation unit only
132 and its address is never taken. */
133 unsigned local : 1;
135 /* Set once it has been finalized so we consider it to be output. */
136 unsigned finalized : 1;
138 /* False when there is something makes versioning impossible. */
139 unsigned versionable : 1;
141 /* False when function calling convention and signature can not be changed.
142 This is the case when __builtin_apply_args is used. */
143 unsigned can_change_signature : 1;
145 /* True when the function has been originally extern inline, but it is
146 redefined now. */
147 unsigned redefined_extern_inline : 1;
149 /* True if the function may enter serial irrevocable mode. */
150 unsigned tm_may_enter_irr : 1;
153 /* Information about the function that needs to be computed globally
154 once compilation is finished. Available only with -funit-at-a-time. */
156 struct GTY(()) cgraph_global_info {
157 /* For inline clones this points to the function they will be
158 inlined into. */
159 struct cgraph_node *inlined_to;
162 /* Information about the function that is propagated by the RTL backend.
163 Available only for functions that has been already assembled. */
165 struct GTY(()) cgraph_rtl_info {
166 unsigned int preferred_incoming_stack_boundary;
169 /* Represent which DECL tree (or reference to such tree)
170 will be replaced by another tree while versioning. */
171 struct GTY(()) ipa_replace_map
173 /* The tree that will be replaced. */
174 tree old_tree;
175 /* The new (replacing) tree. */
176 tree new_tree;
177 /* Parameter number to replace, when old_tree is NULL. */
178 int parm_num;
179 /* True when a substitution should be done, false otherwise. */
180 bool replace_p;
181 /* True when we replace a reference to old_tree. */
182 bool ref_p;
184 typedef struct ipa_replace_map *ipa_replace_map_p;
185 DEF_VEC_P(ipa_replace_map_p);
186 DEF_VEC_ALLOC_P(ipa_replace_map_p,gc);
188 struct GTY(()) cgraph_clone_info
190 VEC(ipa_replace_map_p,gc)* tree_map;
191 bitmap args_to_skip;
192 bitmap combined_args_to_skip;
196 /* The cgraph data structure.
197 Each function decl has assigned cgraph_node listing callees and callers. */
199 struct GTY(()) cgraph_node {
200 struct symtab_node_base symbol;
201 struct cgraph_edge *callees;
202 struct cgraph_edge *callers;
203 /* List of edges representing indirect calls with a yet undetermined
204 callee. */
205 struct cgraph_edge *indirect_calls;
206 /* For nested functions points to function the node is nested in. */
207 struct cgraph_node *
208 GTY ((nested_ptr (union symtab_node_def, "(struct cgraph_node *)(%h)", "(symtab_node)%h")))
209 origin;
210 /* Points to first nested function, if any. */
211 struct cgraph_node *
212 GTY ((nested_ptr (union symtab_node_def, "(struct cgraph_node *)(%h)", "(symtab_node)%h")))
213 nested;
214 /* Pointer to the next function with same origin, if any. */
215 struct cgraph_node *
216 GTY ((nested_ptr (union symtab_node_def, "(struct cgraph_node *)(%h)", "(symtab_node)%h")))
217 next_nested;
218 /* Pointer to the next clone. */
219 struct cgraph_node *next_sibling_clone;
220 struct cgraph_node *prev_sibling_clone;
221 struct cgraph_node *clones;
222 struct cgraph_node *clone_of;
223 /* For functions with many calls sites it holds map from call expression
224 to the edge to speed up cgraph_edge function. */
225 htab_t GTY((param_is (struct cgraph_edge))) call_site_hash;
226 /* Declaration node used to be clone of. */
227 tree former_clone_of;
229 /* Interprocedural passes scheduled to have their transform functions
230 applied next time we execute local pass on them. We maintain it
231 per-function in order to allow IPA passes to introduce new functions. */
232 VEC(ipa_opt_pass,heap) * GTY((skip)) ipa_transforms_to_apply;
234 struct cgraph_local_info local;
235 struct cgraph_global_info global;
236 struct cgraph_rtl_info rtl;
237 struct cgraph_clone_info clone;
238 struct cgraph_thunk_info thunk;
240 /* Expected number of executions: calculated in profile.c. */
241 gcov_type count;
242 /* How to scale counts at materialization time; used to merge
243 LTO units with different number of profile runs. */
244 int count_materialization_scale;
245 /* Unique id of the node. */
246 int uid;
248 /* Set when decl is an abstract function pointed to by the
249 ABSTRACT_DECL_ORIGIN of a reachable function. */
250 unsigned abstract_and_needed : 1;
251 /* Set once the function is lowered (i.e. its CFG is built). */
252 unsigned lowered : 1;
253 /* Set once the function has been instantiated and its callee
254 lists created. */
255 unsigned analyzed : 1;
256 /* Set when function is scheduled to be processed by local passes. */
257 unsigned process : 1;
258 /* Set for aliases once they got through assemble_alias. */
259 unsigned alias : 1;
260 /* Set for aliases created as C++ same body aliases. */
261 unsigned same_body_alias : 1;
262 /* How commonly executed the node is. Initialized during branch
263 probabilities pass. */
264 ENUM_BITFIELD (node_frequency) frequency : 2;
265 /* True when function can only be called at startup (from static ctor). */
266 unsigned only_called_at_startup : 1;
267 /* True when function can only be called at startup (from static dtor). */
268 unsigned only_called_at_exit : 1;
269 /* True when function is the transactional clone of a function which
270 is called only from inside transactions. */
271 /* ?? We should be able to remove this. We have enough bits in
272 cgraph to calculate it. */
273 unsigned tm_clone : 1;
276 typedef struct cgraph_node *cgraph_node_ptr;
278 DEF_VEC_P(cgraph_node_ptr);
279 DEF_VEC_ALLOC_P(cgraph_node_ptr,heap);
280 DEF_VEC_ALLOC_P(cgraph_node_ptr,gc);
282 /* A cgraph node set is a collection of cgraph nodes. A cgraph node
283 can appear in multiple sets. */
284 struct cgraph_node_set_def
286 struct pointer_map_t *map;
287 VEC(cgraph_node_ptr, heap) *nodes;
290 typedef struct varpool_node *varpool_node_ptr;
292 DEF_VEC_P(varpool_node_ptr);
293 DEF_VEC_ALLOC_P(varpool_node_ptr,heap);
294 DEF_VEC_ALLOC_P(varpool_node_ptr,gc);
296 /* A varpool node set is a collection of varpool nodes. A varpool node
297 can appear in multiple sets. */
298 struct varpool_node_set_def
300 struct pointer_map_t * map;
301 VEC(varpool_node_ptr, heap) *nodes;
304 typedef struct cgraph_node_set_def *cgraph_node_set;
306 DEF_VEC_P(cgraph_node_set);
307 DEF_VEC_ALLOC_P(cgraph_node_set,gc);
308 DEF_VEC_ALLOC_P(cgraph_node_set,heap);
310 typedef struct varpool_node_set_def *varpool_node_set;
312 DEF_VEC_P(varpool_node_set);
313 DEF_VEC_ALLOC_P(varpool_node_set,gc);
314 DEF_VEC_ALLOC_P(varpool_node_set,heap);
316 /* Iterator structure for cgraph node sets. */
317 typedef struct
319 cgraph_node_set set;
320 unsigned index;
321 } cgraph_node_set_iterator;
323 /* Iterator structure for varpool node sets. */
324 typedef struct
326 varpool_node_set set;
327 unsigned index;
328 } varpool_node_set_iterator;
330 #define DEFCIFCODE(code, string) CIF_ ## code,
331 /* Reasons for inlining failures. */
332 typedef enum cgraph_inline_failed_enum {
333 #include "cif-code.def"
334 CIF_N_REASONS
335 } cgraph_inline_failed_t;
337 /* Structure containing additional information about an indirect call. */
339 struct GTY(()) cgraph_indirect_call_info
341 /* Offset accumulated from ancestor jump functions of inlined call graph
342 edges. */
343 HOST_WIDE_INT anc_offset;
344 /* OBJ_TYPE_REF_TOKEN of a polymorphic call (if polymorphic is set). */
345 HOST_WIDE_INT otr_token;
346 /* Type of the object from OBJ_TYPE_REF_OBJECT. */
347 tree otr_type;
348 /* Index of the parameter that is called. */
349 int param_index;
350 /* ECF flags determined from the caller. */
351 int ecf_flags;
353 /* Set when the call is a virtual call with the parameter being the
354 associated object pointer rather than a simple direct call. */
355 unsigned polymorphic : 1;
358 struct GTY((chain_next ("%h.next_caller"), chain_prev ("%h.prev_caller"))) cgraph_edge {
359 /* Expected number of executions: calculated in profile.c. */
360 gcov_type count;
361 struct cgraph_node *caller;
362 struct cgraph_node *callee;
363 struct cgraph_edge *prev_caller;
364 struct cgraph_edge *next_caller;
365 struct cgraph_edge *prev_callee;
366 struct cgraph_edge *next_callee;
367 gimple call_stmt;
368 /* Additional information about an indirect call. Not cleared when an edge
369 becomes direct. */
370 struct cgraph_indirect_call_info *indirect_info;
371 PTR GTY ((skip (""))) aux;
372 /* When equal to CIF_OK, inline this call. Otherwise, points to the
373 explanation why function was not inlined. */
374 cgraph_inline_failed_t inline_failed;
375 /* The stmt_uid of call_stmt. This is used by LTO to recover the call_stmt
376 when the function is serialized in. */
377 unsigned int lto_stmt_uid;
378 /* Expected frequency of executions within the function.
379 When set to CGRAPH_FREQ_BASE, the edge is expected to be called once
380 per function call. The range is 0 to CGRAPH_FREQ_MAX. */
381 int frequency;
382 /* Unique id of the edge. */
383 int uid;
384 /* Whether this edge was made direct by indirect inlining. */
385 unsigned int indirect_inlining_edge : 1;
386 /* Whether this edge describes an indirect call with an undetermined
387 callee. */
388 unsigned int indirect_unknown_callee : 1;
389 /* Whether this edge is still a dangling */
390 /* True if the corresponding CALL stmt cannot be inlined. */
391 unsigned int call_stmt_cannot_inline_p : 1;
392 /* Can this call throw externally? */
393 unsigned int can_throw_external : 1;
396 #define CGRAPH_FREQ_BASE 1000
397 #define CGRAPH_FREQ_MAX 100000
399 typedef struct cgraph_edge *cgraph_edge_p;
401 DEF_VEC_P(cgraph_edge_p);
402 DEF_VEC_ALLOC_P(cgraph_edge_p,heap);
404 /* The varpool data structure.
405 Each static variable decl has assigned varpool_node. */
407 struct GTY(()) varpool_node {
408 struct symtab_node_base symbol;
409 /* For aliases points to declaration DECL is alias of. */
410 tree alias_of;
412 /* Set once the variable has been instantiated and its callee
413 lists created. */
414 unsigned analyzed : 1;
415 /* Set once it has been finalized so we consider it to be output. */
416 unsigned finalized : 1;
417 /* Set when variable is scheduled to be assembled. */
418 unsigned output : 1;
419 /* Set for aliases once they got through assemble_alias. Also set for
420 extra name aliases in varpool_extra_name_alias. */
421 unsigned alias : 1;
422 unsigned extra_name_alias : 1;
425 /* Every top level asm statement is put into a asm_node. */
427 struct GTY(()) asm_node {
428 /* Next asm node. */
429 struct asm_node *next;
430 /* String for this asm node. */
431 tree asm_str;
432 /* Ordering of all cgraph nodes. */
433 int order;
436 /* Symbol table entry. */
437 union GTY((desc ("%h.symbol.type"), chain_next ("%h.symbol.next"),
438 chain_prev ("%h.symbol.previous"))) symtab_node_def {
439 struct symtab_node_base GTY ((tag ("SYMTAB_SYMBOL"))) symbol;
440 /* Use cgraph (symbol) accessor to get cgraph_node. */
441 struct cgraph_node GTY ((tag ("SYMTAB_FUNCTION"))) x_function;
442 /* Use varpool (symbol) accessor to get varpool_node. */
443 struct varpool_node GTY ((tag ("SYMTAB_VARIABLE"))) x_variable;
446 extern GTY(()) symtab_node symtab_nodes;
447 extern GTY(()) int cgraph_n_nodes;
448 extern GTY(()) int cgraph_max_uid;
449 extern GTY(()) int cgraph_edge_max_uid;
450 extern bool cgraph_global_info_ready;
451 enum cgraph_state
453 /* Frontend is parsing and finalizing functions. */
454 CGRAPH_STATE_PARSING,
455 /* Callgraph is being constructed. It is safe to add new functions. */
456 CGRAPH_STATE_CONSTRUCTION,
457 /* Callgraph is built and IPA passes are being run. */
458 CGRAPH_STATE_IPA,
459 /* Callgraph is built and all functions are transformed to SSA form. */
460 CGRAPH_STATE_IPA_SSA,
461 /* Functions are now ordered and being passed to RTL expanders. */
462 CGRAPH_STATE_EXPANSION,
463 /* All cgraph expansion is done. */
464 CGRAPH_STATE_FINISHED
466 extern enum cgraph_state cgraph_state;
467 extern bool cgraph_function_flags_ready;
468 extern cgraph_node_set cgraph_new_nodes;
470 extern GTY(()) struct asm_node *asm_nodes;
471 extern GTY(()) int symtab_order;
472 extern bool same_body_aliases_done;
474 /* In symtab.c */
475 void symtab_register_node (symtab_node);
476 void symtab_unregister_node (symtab_node);
477 void symtab_remove_node (symtab_node);
478 symtab_node symtab_get_node (const_tree);
479 symtab_node symtab_node_for_asm (const_tree asmname);
480 const char * symtab_node_asm_name (symtab_node);
481 const char * symtab_node_name (symtab_node);
482 void symtab_insert_node_to_hashtable (symtab_node);
483 void symtab_add_to_same_comdat_group (symtab_node, symtab_node);
484 void symtab_dissolve_same_comdat_group_list (symtab_node node);
485 void dump_symtab (FILE *);
486 void debug_symtab (void);
487 void dump_symtab_node (FILE *, symtab_node);
488 void debug_symtab_node (symtab_node);
489 void dump_symtab_base (FILE *, symtab_node);
490 void verify_symtab (void);
491 void verify_symtab_node (symtab_node);
492 bool verify_symtab_base (symtab_node);
493 bool symtab_used_from_object_file_p (symtab_node);
494 void symtab_make_decl_local (tree);
496 /* In cgraph.c */
497 void dump_cgraph (FILE *);
498 void debug_cgraph (void);
499 void dump_cgraph_node (FILE *, struct cgraph_node *);
500 void debug_cgraph_node (struct cgraph_node *);
501 void cgraph_remove_edge (struct cgraph_edge *);
502 void cgraph_remove_node (struct cgraph_node *);
503 void cgraph_release_function_body (struct cgraph_node *);
504 void cgraph_node_remove_callees (struct cgraph_node *node);
505 struct cgraph_edge *cgraph_create_edge (struct cgraph_node *,
506 struct cgraph_node *,
507 gimple, gcov_type, int);
508 struct cgraph_edge *cgraph_create_indirect_edge (struct cgraph_node *, gimple,
509 int, gcov_type, int);
510 struct cgraph_indirect_call_info *cgraph_allocate_init_indirect_info (void);
511 struct cgraph_node * cgraph_create_node (tree);
512 struct cgraph_node * cgraph_create_empty_node (void);
513 struct cgraph_node * cgraph_get_create_node (tree);
514 struct cgraph_node * cgraph_same_body_alias (struct cgraph_node *, tree, tree);
515 struct cgraph_node * cgraph_add_thunk (struct cgraph_node *, tree, tree, bool, HOST_WIDE_INT,
516 HOST_WIDE_INT, tree, tree);
517 struct cgraph_node *cgraph_node_for_asm (tree);
518 struct cgraph_edge *cgraph_edge (struct cgraph_node *, gimple);
519 void cgraph_set_call_stmt (struct cgraph_edge *, gimple);
520 void cgraph_update_edges_for_call_stmt (gimple, tree, gimple);
521 struct cgraph_local_info *cgraph_local_info (tree);
522 struct cgraph_global_info *cgraph_global_info (tree);
523 struct cgraph_rtl_info *cgraph_rtl_info (tree);
524 struct cgraph_node *cgraph_create_function_alias (tree, tree);
525 void cgraph_call_node_duplication_hooks (struct cgraph_node *,
526 struct cgraph_node *);
527 void cgraph_call_edge_duplication_hooks (struct cgraph_edge *,
528 struct cgraph_edge *);
530 void cgraph_redirect_edge_callee (struct cgraph_edge *, struct cgraph_node *);
531 void cgraph_make_edge_direct (struct cgraph_edge *, struct cgraph_node *);
532 bool cgraph_only_called_directly_p (struct cgraph_node *);
534 bool cgraph_function_possibly_inlined_p (tree);
535 void cgraph_unnest_node (struct cgraph_node *);
537 enum availability cgraph_function_body_availability (struct cgraph_node *);
538 void cgraph_add_new_function (tree, bool);
539 const char* cgraph_inline_failed_string (cgraph_inline_failed_t);
541 void cgraph_set_nothrow_flag (struct cgraph_node *, bool);
542 void cgraph_set_const_flag (struct cgraph_node *, bool, bool);
543 void cgraph_set_pure_flag (struct cgraph_node *, bool, bool);
544 bool cgraph_node_cannot_return (struct cgraph_node *);
545 bool cgraph_edge_cannot_lead_to_return (struct cgraph_edge *);
546 bool cgraph_will_be_removed_from_program_if_no_direct_calls
547 (struct cgraph_node *node);
548 bool cgraph_can_remove_if_no_direct_calls_and_refs_p
549 (struct cgraph_node *node);
550 bool cgraph_can_remove_if_no_direct_calls_p (struct cgraph_node *node);
551 bool resolution_used_from_other_file_p (enum ld_plugin_symbol_resolution);
552 bool cgraph_for_node_thunks_and_aliases (struct cgraph_node *,
553 bool (*) (struct cgraph_node *, void *),
554 void *,
555 bool);
556 bool cgraph_for_node_and_aliases (struct cgraph_node *,
557 bool (*) (struct cgraph_node *, void *),
558 void *, bool);
559 VEC (cgraph_edge_p, heap) * collect_callers_of_node (struct cgraph_node *node);
560 void verify_cgraph (void);
561 void verify_cgraph_node (struct cgraph_node *);
562 void cgraph_mark_address_taken_node (struct cgraph_node *);
564 typedef void (*cgraph_edge_hook)(struct cgraph_edge *, void *);
565 typedef void (*cgraph_node_hook)(struct cgraph_node *, void *);
566 typedef void (*cgraph_2edge_hook)(struct cgraph_edge *, struct cgraph_edge *,
567 void *);
568 typedef void (*cgraph_2node_hook)(struct cgraph_node *, struct cgraph_node *,
569 void *);
570 struct cgraph_edge_hook_list;
571 struct cgraph_node_hook_list;
572 struct cgraph_2edge_hook_list;
573 struct cgraph_2node_hook_list;
574 struct cgraph_edge_hook_list *cgraph_add_edge_removal_hook (cgraph_edge_hook, void *);
575 void cgraph_remove_edge_removal_hook (struct cgraph_edge_hook_list *);
576 struct cgraph_node_hook_list *cgraph_add_node_removal_hook (cgraph_node_hook,
577 void *);
578 void cgraph_remove_node_removal_hook (struct cgraph_node_hook_list *);
579 struct cgraph_node_hook_list *cgraph_add_function_insertion_hook (cgraph_node_hook,
580 void *);
581 void cgraph_remove_function_insertion_hook (struct cgraph_node_hook_list *);
582 void cgraph_call_function_insertion_hooks (struct cgraph_node *node);
583 struct cgraph_2edge_hook_list *cgraph_add_edge_duplication_hook (cgraph_2edge_hook, void *);
584 void cgraph_remove_edge_duplication_hook (struct cgraph_2edge_hook_list *);
585 struct cgraph_2node_hook_list *cgraph_add_node_duplication_hook (cgraph_2node_hook, void *);
586 void cgraph_remove_node_duplication_hook (struct cgraph_2node_hook_list *);
587 gimple cgraph_redirect_edge_call_stmt_to_callee (struct cgraph_edge *);
588 bool cgraph_propagate_frequency (struct cgraph_node *node);
590 /* In cgraphunit.c */
591 struct asm_node *add_asm_node (tree);
592 extern FILE *cgraph_dump_file;
593 void cgraph_finalize_function (tree, bool);
594 void finalize_compilation_unit (void);
595 void compile (void);
596 void init_cgraph (void);
597 bool cgraph_process_new_functions (void);
598 void cgraph_process_same_body_aliases (void);
599 void fixup_same_cpp_alias_visibility (symtab_node node, symtab_node target, tree alias);
601 /* In cgraphclones.c */
603 struct cgraph_edge * cgraph_clone_edge (struct cgraph_edge *,
604 struct cgraph_node *, gimple,
605 unsigned, gcov_type, int, bool);
606 struct cgraph_node * cgraph_clone_node (struct cgraph_node *, tree, gcov_type,
607 int, bool, VEC(cgraph_edge_p,heap) *,
608 bool);
609 tree clone_function_name (tree decl, const char *);
610 struct cgraph_node * cgraph_create_virtual_clone (struct cgraph_node *old_node,
611 VEC(cgraph_edge_p,heap)*,
612 VEC(ipa_replace_map_p,gc)* tree_map,
613 bitmap args_to_skip,
614 const char *clone_name);
615 struct cgraph_node *cgraph_find_replacement_node (struct cgraph_node *);
616 bool cgraph_remove_node_and_inline_clones (struct cgraph_node *, struct cgraph_node *);
617 void cgraph_set_call_stmt_including_clones (struct cgraph_node *, gimple, gimple);
618 void cgraph_create_edge_including_clones (struct cgraph_node *,
619 struct cgraph_node *,
620 gimple, gimple, gcov_type, int,
621 cgraph_inline_failed_t);
622 void cgraph_materialize_all_clones (void);
623 struct cgraph_node * cgraph_copy_node_for_versioning (struct cgraph_node *,
624 tree, VEC(cgraph_edge_p,heap)*, bitmap);
625 struct cgraph_node *cgraph_function_versioning (struct cgraph_node *,
626 VEC(cgraph_edge_p,heap)*,
627 VEC(ipa_replace_map_p,gc)*,
628 bitmap, bool, bitmap,
629 basic_block, const char *);
630 void tree_function_versioning (tree, tree, VEC (ipa_replace_map_p,gc)*,
631 bool, bitmap, bool, bitmap, basic_block);
633 /* In cgraphbuild.c */
634 unsigned int rebuild_cgraph_edges (void);
635 void cgraph_rebuild_references (void);
636 int compute_call_stmt_bb_frequency (tree, basic_block bb);
637 void record_references_in_initializer (tree, bool);
639 /* In ipa.c */
640 bool symtab_remove_unreachable_nodes (bool, FILE *);
641 cgraph_node_set cgraph_node_set_new (void);
642 cgraph_node_set_iterator cgraph_node_set_find (cgraph_node_set,
643 struct cgraph_node *);
644 void cgraph_node_set_add (cgraph_node_set, struct cgraph_node *);
645 void cgraph_node_set_remove (cgraph_node_set, struct cgraph_node *);
646 void dump_cgraph_node_set (FILE *, cgraph_node_set);
647 void debug_cgraph_node_set (cgraph_node_set);
648 void free_cgraph_node_set (cgraph_node_set);
649 void cgraph_build_static_cdtor (char which, tree body, int priority);
651 varpool_node_set varpool_node_set_new (void);
652 varpool_node_set_iterator varpool_node_set_find (varpool_node_set,
653 struct varpool_node *);
654 void varpool_node_set_add (varpool_node_set, struct varpool_node *);
655 void varpool_node_set_remove (varpool_node_set, struct varpool_node *);
656 void dump_varpool_node_set (FILE *, varpool_node_set);
657 void debug_varpool_node_set (varpool_node_set);
658 void free_varpool_node_set (varpool_node_set);
659 void ipa_discover_readonly_nonaddressable_vars (void);
660 bool cgraph_comdat_can_be_unshared_p (struct cgraph_node *);
661 bool varpool_externally_visible_p (struct varpool_node *, bool);
663 /* In predict.c */
664 bool cgraph_maybe_hot_edge_p (struct cgraph_edge *e);
665 bool cgraph_optimize_for_size_p (struct cgraph_node *);
667 /* In varpool.c */
668 struct varpool_node *varpool_node (tree);
669 struct varpool_node *varpool_node_for_asm (tree asmname);
670 void varpool_mark_needed_node (struct varpool_node *);
671 void debug_varpool (void);
672 void dump_varpool (FILE *);
673 void dump_varpool_node (FILE *, struct varpool_node *);
675 void varpool_finalize_decl (tree);
676 bool decide_is_variable_needed (struct varpool_node *, tree);
677 enum availability cgraph_variable_initializer_availability (struct varpool_node *);
678 void cgraph_make_node_local (struct cgraph_node *);
679 bool cgraph_node_can_be_local_p (struct cgraph_node *);
682 void varpool_remove_node (struct varpool_node *node);
683 void varpool_finalize_named_section_flags (struct varpool_node *node);
684 bool varpool_output_variables (void);
685 bool varpool_assemble_decl (struct varpool_node *node);
686 void varpool_analyze_node (struct varpool_node *);
687 struct varpool_node * varpool_extra_name_alias (tree, tree);
688 struct varpool_node * varpool_create_variable_alias (tree, tree);
689 void varpool_reset_queue (void);
690 bool const_value_known_p (tree);
691 bool varpool_for_node_and_aliases (struct varpool_node *,
692 bool (*) (struct varpool_node *, void *),
693 void *, bool);
694 void varpool_add_new_variable (tree);
696 /* Return true when NODE is function. */
697 static inline bool
698 symtab_function_p (symtab_node node)
700 return node->symbol.type == SYMTAB_FUNCTION;
703 /* Return true when NODE is variable. */
704 static inline bool
705 symtab_variable_p (symtab_node node)
707 return node->symbol.type == SYMTAB_VARIABLE;
710 /* Return callgraph node for given symbol and check it is a function. */
711 static inline struct cgraph_node *
712 cgraph (symtab_node node)
714 gcc_checking_assert (!node || node->symbol.type == SYMTAB_FUNCTION);
715 return (struct cgraph_node *)node;
718 /* Return varpool node for given symbol and check it is a variable. */
719 static inline struct varpool_node *
720 varpool (symtab_node node)
722 gcc_checking_assert (!node || node->symbol.type == SYMTAB_VARIABLE);
723 return (struct varpool_node *)node;
726 /* Return callgraph node for given symbol and check it is a function. */
727 static inline struct cgraph_node *
728 cgraph_get_node (const_tree decl)
730 gcc_checking_assert (TREE_CODE (decl) == FUNCTION_DECL);
731 return cgraph (symtab_get_node (decl));
734 /* Return varpool node for given symbol and check it is a function. */
735 static inline struct varpool_node *
736 varpool_get_node (const_tree decl)
738 gcc_checking_assert (TREE_CODE (decl) == VAR_DECL);
739 return varpool (symtab_get_node (decl));
742 /* Return asm name of cgraph node. */
743 static inline const char *
744 cgraph_node_asm_name(struct cgraph_node *node)
746 return symtab_node_asm_name ((symtab_node)node);
749 /* Return asm name of varpool node. */
750 static inline const char *
751 varpool_node_asm_name(struct varpool_node *node)
753 return symtab_node_asm_name ((symtab_node)node);
756 /* Return name of cgraph node. */
757 static inline const char *
758 cgraph_node_name(struct cgraph_node *node)
760 return symtab_node_name ((symtab_node)node);
763 /* Return name of varpool node. */
764 static inline const char *
765 varpool_node_name(struct varpool_node *node)
767 return symtab_node_name ((symtab_node)node);
770 /* Walk all symbols. */
771 #define FOR_EACH_SYMBOL(node) \
772 for ((node) = symtab_nodes; (node); (node) = (node)->symbol.next)
775 /* Return first variable. */
776 static inline struct varpool_node *
777 varpool_first_variable (void)
779 symtab_node node;
780 for (node = symtab_nodes; node; node = node->symbol.next)
782 if (symtab_variable_p (node))
783 return varpool (node);
785 return NULL;
788 /* Return next variable after NODE. */
789 static inline struct varpool_node *
790 varpool_next_variable (struct varpool_node *node)
792 symtab_node node1 = (symtab_node) node->symbol.next;
793 for (; node1; node1 = node1->symbol.next)
795 if (symtab_variable_p (node1))
796 return varpool (node1);
798 return NULL;
800 /* Walk all variables. */
801 #define FOR_EACH_VARIABLE(node) \
802 for ((node) = varpool_first_variable (); \
803 (node); \
804 (node) = varpool_next_variable ((node)))
806 /* Return first reachable static variable with initializer. */
807 static inline struct varpool_node *
808 varpool_first_static_initializer (void)
810 symtab_node node;
811 for (node = symtab_nodes; node; node = node->symbol.next)
813 if (symtab_variable_p (node)
814 && DECL_INITIAL (node->symbol.decl))
815 return varpool (node);
817 return NULL;
820 /* Return next reachable static variable with initializer after NODE. */
821 static inline struct varpool_node *
822 varpool_next_static_initializer (struct varpool_node *node)
824 symtab_node node1 = (symtab_node) node->symbol.next;
825 for (; node1; node1 = node1->symbol.next)
827 if (symtab_variable_p (node1)
828 && DECL_INITIAL (node1->symbol.decl))
829 return varpool (node1);
831 return NULL;
834 /* Walk all static variables with initializer set. */
835 #define FOR_EACH_STATIC_INITIALIZER(node) \
836 for ((node) = varpool_first_static_initializer (); (node); \
837 (node) = varpool_next_static_initializer (node))
839 /* Return first reachable static variable with initializer. */
840 static inline struct varpool_node *
841 varpool_first_defined_variable (void)
843 symtab_node node;
844 for (node = symtab_nodes; node; node = node->symbol.next)
846 if (symtab_variable_p (node) && varpool (node)->analyzed)
847 return varpool (node);
849 return NULL;
852 /* Return next reachable static variable with initializer after NODE. */
853 static inline struct varpool_node *
854 varpool_next_defined_variable (struct varpool_node *node)
856 symtab_node node1 = (symtab_node) node->symbol.next;
857 for (; node1; node1 = node1->symbol.next)
859 if (symtab_variable_p (node1) && varpool (node1)->analyzed)
860 return varpool (node1);
862 return NULL;
864 /* Walk all variables with definitions in current unit. */
865 #define FOR_EACH_DEFINED_VARIABLE(node) \
866 for ((node) = varpool_first_defined_variable (); (node); \
867 (node) = varpool_next_defined_variable (node))
869 /* Return first function with body defined. */
870 static inline struct cgraph_node *
871 cgraph_first_defined_function (void)
873 symtab_node node;
874 for (node = symtab_nodes; node; node = node->symbol.next)
876 if (symtab_function_p (node) && cgraph (node)->analyzed)
877 return cgraph (node);
879 return NULL;
882 /* Return next function with body defined after NODE. */
883 static inline struct cgraph_node *
884 cgraph_next_defined_function (struct cgraph_node *node)
886 symtab_node node1 = (symtab_node) node->symbol.next;
887 for (; node1; node1 = node1->symbol.next)
889 if (symtab_function_p (node1) && cgraph (node1)->analyzed)
890 return cgraph (node1);
892 return NULL;
895 /* Walk all functions with body defined. */
896 #define FOR_EACH_DEFINED_FUNCTION(node) \
897 for ((node) = cgraph_first_defined_function (); (node); \
898 (node) = cgraph_next_defined_function ((node)))
900 /* Return first function. */
901 static inline struct cgraph_node *
902 cgraph_first_function (void)
904 symtab_node node;
905 for (node = symtab_nodes; node; node = node->symbol.next)
907 if (symtab_function_p (node))
908 return cgraph (node);
910 return NULL;
913 /* Return next function. */
914 static inline struct cgraph_node *
915 cgraph_next_function (struct cgraph_node *node)
917 symtab_node node1 = (symtab_node) node->symbol.next;
918 for (; node1; node1 = node1->symbol.next)
920 if (symtab_function_p (node1))
921 return cgraph (node1);
923 return NULL;
925 /* Walk all functions. */
926 #define FOR_EACH_FUNCTION(node) \
927 for ((node) = cgraph_first_function (); (node); \
928 (node) = cgraph_next_function ((node)))
930 /* Return true when NODE is a function with Gimple body defined
931 in current unit. Functions can also be define externally or they
932 can be thunks with no Gimple representation.
934 Note that at WPA stage, the function body may not be present in memory. */
936 static inline bool
937 cgraph_function_with_gimple_body_p (struct cgraph_node *node)
939 return node->analyzed && !node->thunk.thunk_p && !node->alias;
942 /* Return first function with body defined. */
943 static inline struct cgraph_node *
944 cgraph_first_function_with_gimple_body (void)
946 symtab_node node;
947 for (node = symtab_nodes; node; node = node->symbol.next)
949 if (symtab_function_p (node)
950 && cgraph_function_with_gimple_body_p (cgraph (node)))
951 return cgraph (node);
953 return NULL;
956 /* Return next reachable static variable with initializer after NODE. */
957 static inline struct cgraph_node *
958 cgraph_next_function_with_gimple_body (struct cgraph_node *node)
960 symtab_node node1 = node->symbol.next;
961 for (; node1; node1 = node1->symbol.next)
963 if (symtab_function_p (node1)
964 && cgraph_function_with_gimple_body_p (cgraph (node1)))
965 return cgraph (node1);
967 return NULL;
970 /* Walk all functions with body defined. */
971 #define FOR_EACH_FUNCTION_WITH_GIMPLE_BODY(node) \
972 for ((node) = cgraph_first_function_with_gimple_body (); (node); \
973 (node) = cgraph_next_function_with_gimple_body (node))
975 /* Create a new static variable of type TYPE. */
976 tree add_new_static_var (tree type);
978 /* Return true if iterator CSI points to nothing. */
979 static inline bool
980 csi_end_p (cgraph_node_set_iterator csi)
982 return csi.index >= VEC_length (cgraph_node_ptr, csi.set->nodes);
985 /* Advance iterator CSI. */
986 static inline void
987 csi_next (cgraph_node_set_iterator *csi)
989 csi->index++;
992 /* Return the node pointed to by CSI. */
993 static inline struct cgraph_node *
994 csi_node (cgraph_node_set_iterator csi)
996 return VEC_index (cgraph_node_ptr, csi.set->nodes, csi.index);
999 /* Return an iterator to the first node in SET. */
1000 static inline cgraph_node_set_iterator
1001 csi_start (cgraph_node_set set)
1003 cgraph_node_set_iterator csi;
1005 csi.set = set;
1006 csi.index = 0;
1007 return csi;
1010 /* Return true if SET contains NODE. */
1011 static inline bool
1012 cgraph_node_in_set_p (struct cgraph_node *node, cgraph_node_set set)
1014 cgraph_node_set_iterator csi;
1015 csi = cgraph_node_set_find (set, node);
1016 return !csi_end_p (csi);
1019 /* Return number of nodes in SET. */
1020 static inline size_t
1021 cgraph_node_set_size (cgraph_node_set set)
1023 return VEC_length (cgraph_node_ptr, set->nodes);
1026 /* Return true if iterator VSI points to nothing. */
1027 static inline bool
1028 vsi_end_p (varpool_node_set_iterator vsi)
1030 return vsi.index >= VEC_length (varpool_node_ptr, vsi.set->nodes);
1033 /* Advance iterator VSI. */
1034 static inline void
1035 vsi_next (varpool_node_set_iterator *vsi)
1037 vsi->index++;
1040 /* Return the node pointed to by VSI. */
1041 static inline struct varpool_node *
1042 vsi_node (varpool_node_set_iterator vsi)
1044 return VEC_index (varpool_node_ptr, vsi.set->nodes, vsi.index);
1047 /* Return an iterator to the first node in SET. */
1048 static inline varpool_node_set_iterator
1049 vsi_start (varpool_node_set set)
1051 varpool_node_set_iterator vsi;
1053 vsi.set = set;
1054 vsi.index = 0;
1055 return vsi;
1058 /* Return true if SET contains NODE. */
1059 static inline bool
1060 varpool_node_in_set_p (struct varpool_node *node, varpool_node_set set)
1062 varpool_node_set_iterator vsi;
1063 vsi = varpool_node_set_find (set, node);
1064 return !vsi_end_p (vsi);
1067 /* Return number of nodes in SET. */
1068 static inline size_t
1069 varpool_node_set_size (varpool_node_set set)
1071 return VEC_length (varpool_node_ptr, set->nodes);
1074 /* Uniquize all constants that appear in memory.
1075 Each constant in memory thus far output is recorded
1076 in `const_desc_table'. */
1078 struct GTY(()) constant_descriptor_tree {
1079 /* A MEM for the constant. */
1080 rtx rtl;
1082 /* The value of the constant. */
1083 tree value;
1085 /* Hash of value. Computing the hash from value each time
1086 hashfn is called can't work properly, as that means recursive
1087 use of the hash table during hash table expansion. */
1088 hashval_t hash;
1091 /* Return true if set is nonempty. */
1092 static inline bool
1093 cgraph_node_set_nonempty_p (cgraph_node_set set)
1095 return !VEC_empty (cgraph_node_ptr, set->nodes);
1098 /* Return true if set is nonempty. */
1099 static inline bool
1100 varpool_node_set_nonempty_p (varpool_node_set set)
1102 return !VEC_empty (varpool_node_ptr, set->nodes);
1105 /* Return true when function NODE is only called directly or it has alias.
1106 i.e. it is not externally visible, address was not taken and
1107 it is not used in any other non-standard way. */
1109 static inline bool
1110 cgraph_only_called_directly_or_aliased_p (struct cgraph_node *node)
1112 gcc_assert (!node->global.inlined_to);
1113 return (!node->symbol.force_output && !node->symbol.address_taken
1114 && !node->symbol.used_from_other_partition
1115 && !DECL_STATIC_CONSTRUCTOR (node->symbol.decl)
1116 && !DECL_STATIC_DESTRUCTOR (node->symbol.decl)
1117 && !node->symbol.externally_visible);
1120 /* Return true when function NODE can be removed from callgraph
1121 if all direct calls are eliminated. */
1123 static inline bool
1124 varpool_can_remove_if_no_refs (struct varpool_node *node)
1126 if (DECL_EXTERNAL (node->symbol.decl))
1127 return true;
1128 return (!node->symbol.force_output && !node->symbol.used_from_other_partition
1129 && ((DECL_COMDAT (node->symbol.decl)
1130 && !symtab_used_from_object_file_p ((symtab_node) node))
1131 || !node->symbol.externally_visible
1132 || DECL_HAS_VALUE_EXPR_P (node->symbol.decl)));
1135 /* Return true when all references to VNODE must be visible in ipa_ref_list.
1136 i.e. if the variable is not externally visible or not used in some magic
1137 way (asm statement or such).
1138 The magic uses are all summarized in force_output flag. */
1140 static inline bool
1141 varpool_all_refs_explicit_p (struct varpool_node *vnode)
1143 return (vnode->analyzed
1144 && !vnode->symbol.externally_visible
1145 && !vnode->symbol.used_from_other_partition
1146 && !vnode->symbol.force_output);
1149 /* Constant pool accessor function. */
1150 htab_t constant_pool_htab (void);
1152 /* FIXME: inappropriate dependency of cgraph on IPA. */
1153 #include "ipa-ref-inline.h"
1155 /* Return node that alias N is aliasing. */
1157 static inline struct cgraph_node *
1158 cgraph_alias_aliased_node (struct cgraph_node *n)
1160 struct ipa_ref *ref;
1162 ipa_ref_list_reference_iterate (&n->symbol.ref_list, 0, ref);
1163 gcc_checking_assert (ref->use == IPA_REF_ALIAS);
1164 if (symtab_function_p (ref->referred))
1165 return ipa_ref_node (ref);
1166 return NULL;
1169 /* Return node that alias N is aliasing. */
1171 static inline struct varpool_node *
1172 varpool_alias_aliased_node (struct varpool_node *n)
1174 struct ipa_ref *ref;
1176 ipa_ref_list_reference_iterate (&n->symbol.ref_list, 0, ref);
1177 gcc_checking_assert (ref->use == IPA_REF_ALIAS);
1178 if (symtab_variable_p (ref->referred))
1179 return ipa_ref_varpool_node (ref);
1180 return NULL;
1183 /* Given NODE, walk the alias chain to return the function NODE is alias of.
1184 Walk through thunk, too.
1185 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
1187 static inline struct cgraph_node *
1188 cgraph_function_node (struct cgraph_node *node, enum availability *availability)
1190 if (availability)
1191 *availability = cgraph_function_body_availability (node);
1192 while (node)
1194 if (node->alias && node->analyzed)
1195 node = cgraph_alias_aliased_node (node);
1196 else if (node->thunk.thunk_p)
1197 node = node->callees->callee;
1198 else
1199 return node;
1200 if (node && availability)
1202 enum availability a;
1203 a = cgraph_function_body_availability (node);
1204 if (a < *availability)
1205 *availability = a;
1208 if (availability)
1209 *availability = AVAIL_NOT_AVAILABLE;
1210 return NULL;
1213 /* Given NODE, walk the alias chain to return the function NODE is alias of.
1214 Do not walk through thunks.
1215 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
1217 static inline struct cgraph_node *
1218 cgraph_function_or_thunk_node (struct cgraph_node *node, enum availability *availability)
1220 if (availability)
1221 *availability = cgraph_function_body_availability (node);
1222 while (node)
1224 if (node->alias && node->analyzed)
1225 node = cgraph_alias_aliased_node (node);
1226 else
1227 return node;
1228 if (node && availability)
1230 enum availability a;
1231 a = cgraph_function_body_availability (node);
1232 if (a < *availability)
1233 *availability = a;
1236 if (availability)
1237 *availability = AVAIL_NOT_AVAILABLE;
1238 return NULL;
1241 /* Given NODE, walk the alias chain to return the function NODE is alias of.
1242 Do not walk through thunks.
1243 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
1245 static inline struct varpool_node *
1246 varpool_variable_node (struct varpool_node *node, enum availability *availability)
1248 if (availability)
1249 *availability = cgraph_variable_initializer_availability (node);
1250 while (node)
1252 if (node->alias && node->analyzed)
1253 node = varpool_alias_aliased_node (node);
1254 else
1255 return node;
1256 if (node && availability)
1258 enum availability a;
1259 a = cgraph_variable_initializer_availability (node);
1260 if (a < *availability)
1261 *availability = a;
1264 if (availability)
1265 *availability = AVAIL_NOT_AVAILABLE;
1266 return NULL;
1269 /* Return true when the edge E represents a direct recursion. */
1270 static inline bool
1271 cgraph_edge_recursive_p (struct cgraph_edge *e)
1273 struct cgraph_node *callee = cgraph_function_or_thunk_node (e->callee, NULL);
1274 if (e->caller->global.inlined_to)
1275 return e->caller->global.inlined_to->symbol.decl == callee->symbol.decl;
1276 else
1277 return e->caller->symbol.decl == callee->symbol.decl;
1280 /* Return true if the TM_CLONE bit is set for a given FNDECL. */
1281 static inline bool
1282 decl_is_tm_clone (const_tree fndecl)
1284 struct cgraph_node *n = cgraph_get_node (fndecl);
1285 if (n)
1286 return n->tm_clone;
1287 return false;
1290 /* Likewise indicate that a node is needed, i.e. reachable via some
1291 external means. */
1293 static inline void
1294 cgraph_mark_force_output_node (struct cgraph_node *node)
1296 node->symbol.force_output = 1;
1297 gcc_checking_assert (!node->global.inlined_to);
1300 #endif /* GCC_CGRAPH_H */