re checking -fdump-passes
[official-gcc.git] / gcc / cgraph.h
blob055ab4884ef98e0d2d1fd99a058d2799f62154bf
1 /* Callgraph handling code.
2 Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
3 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" /* FIXME: inappropriate dependency of cgraph on IPA. */
32 enum availability
34 /* Not yet set by cgraph_function_body_availability. */
35 AVAIL_UNSET,
36 /* Function body/variable initializer is unknown. */
37 AVAIL_NOT_AVAILABLE,
38 /* Function body/variable initializer is known but might be replaced
39 by a different one from other compilation unit and thus needs to
40 be dealt with a care. Like AVAIL_NOT_AVAILABLE it can have
41 arbitrary side effects on escaping variables and functions, while
42 like AVAILABLE it might access static variables. */
43 AVAIL_OVERWRITABLE,
44 /* Function body/variable initializer is known and will be used in final
45 program. */
46 AVAIL_AVAILABLE,
47 /* Function body/variable initializer is known and all it's uses are explicitly
48 visible within current unit (ie it's address is never taken and it is not
49 exported to other units).
50 Currently used only for functions. */
51 AVAIL_LOCAL
54 /* This is the information that is put into the cgraph local structure
55 to recover a function. */
56 struct lto_file_decl_data;
58 extern const char * const cgraph_availability_names[];
59 extern const char * const ld_plugin_symbol_resolution_names[];
61 /* Information about thunk, used only for same body aliases. */
63 struct GTY(()) cgraph_thunk_info {
64 /* Information about the thunk. */
65 HOST_WIDE_INT fixed_offset;
66 HOST_WIDE_INT virtual_value;
67 tree alias;
68 bool this_adjusting;
69 bool virtual_offset_p;
70 /* Set to true when alias node is thunk. */
71 bool thunk_p;
74 /* Information about the function collected locally.
75 Available after function is analyzed. */
77 struct GTY(()) cgraph_local_info {
78 /* File stream where this node is being written to. */
79 struct lto_file_decl_data * lto_file_data;
81 /* Set when function function is visible in current compilation unit only
82 and its address is never taken. */
83 unsigned local : 1;
85 /* Set when function is visible by other units. */
86 unsigned externally_visible : 1;
88 /* Set once it has been finalized so we consider it to be output. */
89 unsigned finalized : 1;
91 /* False when function calling convention and signature can not be changed.
92 This is the case when __builtin_apply_args is used. */
93 unsigned can_change_signature : 1;
95 /* True when the function has been originally extern inline, but it is
96 redefined now. */
97 unsigned redefined_extern_inline : 1;
100 /* Information about the function that needs to be computed globally
101 once compilation is finished. Available only with -funit-at-a-time. */
103 struct GTY(()) cgraph_global_info {
104 /* For inline clones this points to the function they will be
105 inlined into. */
106 struct cgraph_node *inlined_to;
109 /* Information about the function that is propagated by the RTL backend.
110 Available only for functions that has been already assembled. */
112 struct GTY(()) cgraph_rtl_info {
113 unsigned int preferred_incoming_stack_boundary;
116 /* Represent which DECL tree (or reference to such tree)
117 will be replaced by another tree while versioning. */
118 struct GTY(()) ipa_replace_map
120 /* The tree that will be replaced. */
121 tree old_tree;
122 /* The new (replacing) tree. */
123 tree new_tree;
124 /* Parameter number to replace, when old_tree is NULL. */
125 int parm_num;
126 /* True when a substitution should be done, false otherwise. */
127 bool replace_p;
128 /* True when we replace a reference to old_tree. */
129 bool ref_p;
131 typedef struct ipa_replace_map *ipa_replace_map_p;
132 DEF_VEC_P(ipa_replace_map_p);
133 DEF_VEC_ALLOC_P(ipa_replace_map_p,gc);
135 struct GTY(()) cgraph_clone_info
137 VEC(ipa_replace_map_p,gc)* tree_map;
138 bitmap args_to_skip;
139 bitmap combined_args_to_skip;
143 /* The cgraph data structure.
144 Each function decl has assigned cgraph_node listing callees and callers. */
146 struct GTY((chain_next ("%h.next"), chain_prev ("%h.previous"))) cgraph_node {
147 tree decl;
148 struct cgraph_edge *callees;
149 struct cgraph_edge *callers;
150 struct cgraph_node *next;
151 struct cgraph_node *previous;
152 /* List of edges representing indirect calls with a yet undetermined
153 callee. */
154 struct cgraph_edge *indirect_calls;
155 /* For nested functions points to function the node is nested in. */
156 struct cgraph_node *origin;
157 /* Points to first nested function, if any. */
158 struct cgraph_node *nested;
159 /* Pointer to the next function with same origin, if any. */
160 struct cgraph_node *next_nested;
161 /* Pointer to the next function in cgraph_nodes_queue. */
162 struct cgraph_node *next_needed;
163 /* Pointer to the next clone. */
164 struct cgraph_node *next_sibling_clone;
165 struct cgraph_node *prev_sibling_clone;
166 struct cgraph_node *clones;
167 struct cgraph_node *clone_of;
168 /* For normal nodes pointer to the list of alias and thunk nodes,
169 in alias/thunk nodes pointer to the normal node. */
170 struct cgraph_node *same_body;
171 /* Circular list of nodes in the same comdat group if non-NULL. */
172 struct cgraph_node *same_comdat_group;
173 /* For functions with many calls sites it holds map from call expression
174 to the edge to speed up cgraph_edge function. */
175 htab_t GTY((param_is (struct cgraph_edge))) call_site_hash;
176 /* Declaration node used to be clone of. */
177 tree former_clone_of;
179 PTR GTY ((skip)) aux;
181 /* Interprocedural passes scheduled to have their transform functions
182 applied next time we execute local pass on them. We maintain it
183 per-function in order to allow IPA passes to introduce new functions. */
184 VEC(ipa_opt_pass,heap) * GTY((skip)) ipa_transforms_to_apply;
186 struct ipa_ref_list ref_list;
187 struct cgraph_local_info local;
188 struct cgraph_global_info global;
189 struct cgraph_rtl_info rtl;
190 struct cgraph_clone_info clone;
191 struct cgraph_thunk_info thunk;
193 /* Expected number of executions: calculated in profile.c. */
194 gcov_type count;
195 /* How to scale counts at materialization time; used to merge
196 LTO units with different number of profile runs. */
197 int count_materialization_scale;
198 /* Unique id of the node. */
199 int uid;
200 /* Ordering of all cgraph nodes. */
201 int order;
203 enum ld_plugin_symbol_resolution resolution;
205 /* Set when function must be output for some reason. The primary
206 use of this flag is to mark functions needed to be output for
207 non-standard reason. Functions that are externally visible
208 or reachable from functions needed to be output are marked
209 by specialized flags. */
210 unsigned needed : 1;
211 /* Set when function has address taken.
212 In current implementation it imply needed flag. */
213 unsigned address_taken : 1;
214 /* Set when decl is an abstract function pointed to by the
215 ABSTRACT_DECL_ORIGIN of a reachable function. */
216 unsigned abstract_and_needed : 1;
217 /* Set when function is reachable by call from other function
218 that is either reachable or needed.
219 This flag is computed at original cgraph construction and then
220 updated in cgraph_remove_unreachable_nodes. Note that after
221 cgraph_remove_unreachable_nodes cgraph still can contain unreachable
222 nodes when they are needed for virtual clone instantiation. */
223 unsigned reachable : 1;
224 /* Set when function is reachable by call from other LTRANS partition. */
225 unsigned reachable_from_other_partition : 1;
226 /* Set once the function is lowered (i.e. its CFG is built). */
227 unsigned lowered : 1;
228 /* Set once the function has been instantiated and its callee
229 lists created. */
230 unsigned analyzed : 1;
231 /* Set when function is available in the other LTRANS partition.
232 During WPA output it is used to mark nodes that are present in
233 multiple partitions. */
234 unsigned in_other_partition : 1;
235 /* Set when function is scheduled to be processed by local passes. */
236 unsigned process : 1;
237 /* Set for aliases once they got through assemble_alias. */
238 unsigned alias : 1;
239 /* Set for alias and thunk nodes, same_body points to the node they are alias
240 of and they are linked through the next/previous pointers. */
241 unsigned same_body_alias : 1;
242 /* How commonly executed the node is. Initialized during branch
243 probabilities pass. */
244 ENUM_BITFIELD (node_frequency) frequency : 2;
245 /* True when function can only be called at startup (from static ctor). */
246 unsigned only_called_at_startup : 1;
247 /* True when function can only be called at startup (from static dtor). */
248 unsigned only_called_at_exit : 1;
251 typedef struct cgraph_node *cgraph_node_ptr;
253 DEF_VEC_P(cgraph_node_ptr);
254 DEF_VEC_ALLOC_P(cgraph_node_ptr,heap);
255 DEF_VEC_ALLOC_P(cgraph_node_ptr,gc);
257 /* A cgraph node set is a collection of cgraph nodes. A cgraph node
258 can appear in multiple sets. */
259 struct cgraph_node_set_def
261 struct pointer_map_t *map;
262 VEC(cgraph_node_ptr, heap) *nodes;
265 typedef struct varpool_node *varpool_node_ptr;
267 DEF_VEC_P(varpool_node_ptr);
268 DEF_VEC_ALLOC_P(varpool_node_ptr,heap);
269 DEF_VEC_ALLOC_P(varpool_node_ptr,gc);
271 /* A varpool node set is a collection of varpool nodes. A varpool node
272 can appear in multiple sets. */
273 struct varpool_node_set_def
275 struct pointer_map_t * map;
276 VEC(varpool_node_ptr, heap) *nodes;
279 typedef struct cgraph_node_set_def *cgraph_node_set;
281 DEF_VEC_P(cgraph_node_set);
282 DEF_VEC_ALLOC_P(cgraph_node_set,gc);
283 DEF_VEC_ALLOC_P(cgraph_node_set,heap);
285 typedef struct varpool_node_set_def *varpool_node_set;
287 DEF_VEC_P(varpool_node_set);
288 DEF_VEC_ALLOC_P(varpool_node_set,gc);
289 DEF_VEC_ALLOC_P(varpool_node_set,heap);
291 /* Iterator structure for cgraph node sets. */
292 typedef struct
294 cgraph_node_set set;
295 unsigned index;
296 } cgraph_node_set_iterator;
298 /* Iterator structure for varpool node sets. */
299 typedef struct
301 varpool_node_set set;
302 unsigned index;
303 } varpool_node_set_iterator;
305 #define DEFCIFCODE(code, string) CIF_ ## code,
306 /* Reasons for inlining failures. */
307 typedef enum cgraph_inline_failed_enum {
308 #include "cif-code.def"
309 CIF_N_REASONS
310 } cgraph_inline_failed_t;
312 /* Structure containing additional information about an indirect call. */
314 struct GTY(()) cgraph_indirect_call_info
316 /* Offset accumulated from ancestor jump functions of inlined call graph
317 edges. */
318 HOST_WIDE_INT anc_offset;
319 /* OBJ_TYPE_REF_TOKEN of a polymorphic call (if polymorphic is set). */
320 HOST_WIDE_INT otr_token;
321 /* Delta by which must be added to this parameter to compensate for a skipped
322 this adjusting thunk. */
323 HOST_WIDE_INT thunk_delta;
324 /* Type of the object from OBJ_TYPE_REF_OBJECT. */
325 tree otr_type;
326 /* Index of the parameter that is called. */
327 int param_index;
328 /* ECF flags determined from the caller. */
329 int ecf_flags;
331 /* Set when the call is a virtual call with the parameter being the
332 associated object pointer rather than a simple direct call. */
333 unsigned polymorphic : 1;
336 struct GTY((chain_next ("%h.next_caller"), chain_prev ("%h.prev_caller"))) cgraph_edge {
337 /* Expected number of executions: calculated in profile.c. */
338 gcov_type count;
339 struct cgraph_node *caller;
340 struct cgraph_node *callee;
341 struct cgraph_edge *prev_caller;
342 struct cgraph_edge *next_caller;
343 struct cgraph_edge *prev_callee;
344 struct cgraph_edge *next_callee;
345 gimple call_stmt;
346 /* Additional information about an indirect call. Not cleared when an edge
347 becomes direct. */
348 struct cgraph_indirect_call_info *indirect_info;
349 PTR GTY ((skip (""))) aux;
350 /* When equal to CIF_OK, inline this call. Otherwise, points to the
351 explanation why function was not inlined. */
352 cgraph_inline_failed_t inline_failed;
353 /* The stmt_uid of call_stmt. This is used by LTO to recover the call_stmt
354 when the function is serialized in. */
355 unsigned int lto_stmt_uid;
356 /* Expected frequency of executions within the function.
357 When set to CGRAPH_FREQ_BASE, the edge is expected to be called once
358 per function call. The range is 0 to CGRAPH_FREQ_MAX. */
359 int frequency;
360 /* Unique id of the edge. */
361 int uid;
362 /* Whether this edge was made direct by indirect inlining. */
363 unsigned int indirect_inlining_edge : 1;
364 /* Whether this edge describes an indirect call with an undetermined
365 callee. */
366 unsigned int indirect_unknown_callee : 1;
367 /* Whether this edge is still a dangling */
368 /* True if the corresponding CALL stmt cannot be inlined. */
369 unsigned int call_stmt_cannot_inline_p : 1;
370 /* Can this call throw externally? */
371 unsigned int can_throw_external : 1;
374 #define CGRAPH_FREQ_BASE 1000
375 #define CGRAPH_FREQ_MAX 100000
377 typedef struct cgraph_edge *cgraph_edge_p;
379 DEF_VEC_P(cgraph_edge_p);
380 DEF_VEC_ALLOC_P(cgraph_edge_p,heap);
382 /* The varpool data structure.
383 Each static variable decl has assigned varpool_node. */
385 struct GTY((chain_next ("%h.next"), chain_prev ("%h.prev"))) varpool_node {
386 tree decl;
387 /* Pointer to the next function in varpool_nodes. */
388 struct varpool_node *next, *prev;
389 /* Pointer to the next function in varpool_nodes_queue. */
390 struct varpool_node *next_needed, *prev_needed;
391 /* For normal nodes a pointer to the first extra name alias. For alias
392 nodes a pointer to the normal node. */
393 struct varpool_node *extra_name;
394 /* Circular list of nodes in the same comdat group if non-NULL. */
395 struct varpool_node *same_comdat_group;
396 struct ipa_ref_list ref_list;
397 /* File stream where this node is being written to. */
398 struct lto_file_decl_data * lto_file_data;
399 PTR GTY ((skip)) aux;
400 /* Ordering of all cgraph nodes. */
401 int order;
402 enum ld_plugin_symbol_resolution resolution;
404 /* Set when function must be output - it is externally visible
405 or its address is taken. */
406 unsigned needed : 1;
407 /* Needed variables might become dead by optimization. This flag
408 forces the variable to be output even if it appears dead otherwise. */
409 unsigned force_output : 1;
410 /* Set once the variable has been instantiated and its callee
411 lists created. */
412 unsigned analyzed : 1;
413 /* Set once it has been finalized so we consider it to be output. */
414 unsigned finalized : 1;
415 /* Set when variable is scheduled to be assembled. */
416 unsigned output : 1;
417 /* Set when function is visible by other units. */
418 unsigned externally_visible : 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 /* Set when variable is used from other LTRANS partition. */
423 unsigned used_from_other_partition : 1;
424 /* Set when variable is available in the other LTRANS partition.
425 During WPA output it is used to mark nodes that are present in
426 multiple partitions. */
427 unsigned in_other_partition : 1;
430 /* Every top level asm statement is put into a cgraph_asm_node. */
432 struct GTY(()) cgraph_asm_node {
433 /* Next asm node. */
434 struct cgraph_asm_node *next;
435 /* String for this asm node. */
436 tree asm_str;
437 /* Ordering of all cgraph nodes. */
438 int order;
441 extern GTY(()) struct cgraph_node *cgraph_nodes;
442 extern GTY(()) int cgraph_n_nodes;
443 extern GTY(()) int cgraph_max_uid;
444 extern GTY(()) int cgraph_edge_max_uid;
445 extern bool cgraph_global_info_ready;
446 enum cgraph_state
448 /* Callgraph is being constructed. It is safe to add new functions. */
449 CGRAPH_STATE_CONSTRUCTION,
450 /* Callgraph is built and IPA passes are being run. */
451 CGRAPH_STATE_IPA,
452 /* Callgraph is built and all functions are transformed to SSA form. */
453 CGRAPH_STATE_IPA_SSA,
454 /* Functions are now ordered and being passed to RTL expanders. */
455 CGRAPH_STATE_EXPANSION,
456 /* All cgraph expansion is done. */
457 CGRAPH_STATE_FINISHED
459 extern enum cgraph_state cgraph_state;
460 extern bool cgraph_function_flags_ready;
461 extern GTY(()) struct cgraph_node *cgraph_nodes_queue;
462 extern GTY(()) struct cgraph_node *cgraph_new_nodes;
464 extern GTY(()) struct cgraph_asm_node *cgraph_asm_nodes;
465 extern GTY(()) int cgraph_order;
467 /* In cgraph.c */
468 void dump_cgraph (FILE *);
469 void debug_cgraph (void);
470 void dump_cgraph_node (FILE *, struct cgraph_node *);
471 void debug_cgraph_node (struct cgraph_node *);
472 void cgraph_insert_node_to_hashtable (struct cgraph_node *node);
473 void cgraph_remove_edge (struct cgraph_edge *);
474 void cgraph_remove_node (struct cgraph_node *);
475 void cgraph_remove_node_and_inline_clones (struct cgraph_node *);
476 void cgraph_release_function_body (struct cgraph_node *);
477 void cgraph_node_remove_callees (struct cgraph_node *node);
478 struct cgraph_edge *cgraph_create_edge (struct cgraph_node *,
479 struct cgraph_node *,
480 gimple, gcov_type, int);
481 struct cgraph_edge *cgraph_create_indirect_edge (struct cgraph_node *, gimple,
482 int, gcov_type, int);
483 struct cgraph_indirect_call_info *cgraph_allocate_init_indirect_info (void);
484 struct cgraph_node * cgraph_get_node (const_tree);
485 struct cgraph_node * cgraph_get_node_or_alias (const_tree);
486 struct cgraph_node * cgraph_create_node (tree);
487 struct cgraph_node * cgraph_get_create_node (tree);
488 struct cgraph_node * cgraph_same_body_alias (struct cgraph_node *, tree, tree);
489 struct cgraph_node * cgraph_add_thunk (struct cgraph_node *, tree, tree, bool, HOST_WIDE_INT,
490 HOST_WIDE_INT, tree, tree);
491 void cgraph_remove_same_body_alias (struct cgraph_node *);
492 struct cgraph_node *cgraph_node_for_asm (tree);
493 struct cgraph_edge *cgraph_edge (struct cgraph_node *, gimple);
494 void cgraph_set_call_stmt (struct cgraph_edge *, gimple);
495 void cgraph_set_call_stmt_including_clones (struct cgraph_node *, gimple, gimple);
496 void cgraph_create_edge_including_clones (struct cgraph_node *,
497 struct cgraph_node *,
498 gimple, gimple, gcov_type, int,
499 cgraph_inline_failed_t);
500 void cgraph_update_edges_for_call_stmt (gimple, tree, gimple);
501 struct cgraph_local_info *cgraph_local_info (tree);
502 struct cgraph_global_info *cgraph_global_info (tree);
503 struct cgraph_rtl_info *cgraph_rtl_info (tree);
504 const char * cgraph_node_name (struct cgraph_node *);
505 struct cgraph_edge * cgraph_clone_edge (struct cgraph_edge *,
506 struct cgraph_node *, gimple,
507 unsigned, gcov_type, int, bool);
508 struct cgraph_node * cgraph_clone_node (struct cgraph_node *, tree, gcov_type,
509 int, bool, VEC(cgraph_edge_p,heap) *,
510 bool);
512 void cgraph_redirect_edge_callee (struct cgraph_edge *, struct cgraph_node *);
513 void cgraph_make_edge_direct (struct cgraph_edge *, struct cgraph_node *,
514 HOST_WIDE_INT);
515 bool cgraph_only_called_directly_p (struct cgraph_node *);
517 struct cgraph_asm_node *cgraph_add_asm_node (tree);
519 bool cgraph_function_possibly_inlined_p (tree);
520 void cgraph_unnest_node (struct cgraph_node *);
522 enum availability cgraph_function_body_availability (struct cgraph_node *);
523 void cgraph_add_new_function (tree, bool);
524 const char* cgraph_inline_failed_string (cgraph_inline_failed_t);
525 struct cgraph_node * cgraph_create_virtual_clone (struct cgraph_node *old_node,
526 VEC(cgraph_edge_p,heap)*,
527 VEC(ipa_replace_map_p,gc)* tree_map,
528 bitmap args_to_skip,
529 const char *clone_name);
531 void cgraph_set_nothrow_flag (struct cgraph_node *, bool);
532 void cgraph_set_const_flag (struct cgraph_node *, bool, bool);
533 void cgraph_set_pure_flag (struct cgraph_node *, bool, bool);
534 tree clone_function_name (tree decl, const char *);
535 bool cgraph_node_cannot_return (struct cgraph_node *);
536 bool cgraph_edge_cannot_lead_to_return (struct cgraph_edge *);
537 bool cgraph_will_be_removed_from_program_if_no_direct_calls
538 (struct cgraph_node *node);
539 bool cgraph_can_remove_if_no_direct_calls_and_refs_p
540 (struct cgraph_node *node);
541 bool resolution_used_from_other_file_p (enum ld_plugin_symbol_resolution);
542 bool cgraph_used_from_object_file_p (struct cgraph_node *);
543 bool varpool_used_from_object_file_p (struct varpool_node *);
544 bool cgraph_for_node_thunks_and_aliases (struct cgraph_node *,
545 bool (*) (struct cgraph_node *, void *),
546 void *,
547 bool);
548 bool cgraph_for_node_and_aliases (struct cgraph_node *,
549 bool (*) (struct cgraph_node *, void *),
550 void *, bool);
551 VEC (cgraph_edge_p, heap) * collect_callers_of_node (struct cgraph_node *node);
554 /* In cgraphunit.c */
555 extern FILE *cgraph_dump_file;
556 void cgraph_finalize_function (tree, bool);
557 void cgraph_mark_if_needed (tree);
558 void cgraph_analyze_function (struct cgraph_node *);
559 void cgraph_finalize_compilation_unit (void);
560 void cgraph_optimize (void);
561 void cgraph_mark_needed_node (struct cgraph_node *);
562 void cgraph_mark_address_taken_node (struct cgraph_node *);
563 void cgraph_mark_reachable_node (struct cgraph_node *);
564 bool cgraph_inline_p (struct cgraph_edge *, cgraph_inline_failed_t *reason);
565 bool cgraph_preserve_function_body_p (struct cgraph_node *);
566 void verify_cgraph (void);
567 void verify_cgraph_node (struct cgraph_node *);
568 void cgraph_build_static_cdtor (char which, tree body, int priority);
569 void cgraph_reset_static_var_maps (void);
570 void init_cgraph (void);
571 struct cgraph_node *cgraph_function_versioning (struct cgraph_node *,
572 VEC(cgraph_edge_p,heap)*,
573 VEC(ipa_replace_map_p,gc)*,
574 bitmap, bitmap, basic_block,
575 const char *);
576 void tree_function_versioning (tree, tree, VEC (ipa_replace_map_p,gc)*, bool, bitmap,
577 bitmap, basic_block);
578 void record_references_in_initializer (tree, bool);
579 bool cgraph_process_new_functions (void);
581 bool cgraph_decide_is_function_needed (struct cgraph_node *, tree);
583 typedef void (*cgraph_edge_hook)(struct cgraph_edge *, void *);
584 typedef void (*cgraph_node_hook)(struct cgraph_node *, void *);
585 typedef void (*cgraph_2edge_hook)(struct cgraph_edge *, struct cgraph_edge *,
586 void *);
587 typedef void (*cgraph_2node_hook)(struct cgraph_node *, struct cgraph_node *,
588 void *);
589 struct cgraph_edge_hook_list;
590 struct cgraph_node_hook_list;
591 struct cgraph_2edge_hook_list;
592 struct cgraph_2node_hook_list;
593 struct cgraph_edge_hook_list *cgraph_add_edge_removal_hook (cgraph_edge_hook, void *);
594 void cgraph_remove_edge_removal_hook (struct cgraph_edge_hook_list *);
595 struct cgraph_node_hook_list *cgraph_add_node_removal_hook (cgraph_node_hook,
596 void *);
597 void cgraph_remove_node_removal_hook (struct cgraph_node_hook_list *);
598 struct cgraph_node_hook_list *cgraph_add_function_insertion_hook (cgraph_node_hook,
599 void *);
600 void cgraph_remove_function_insertion_hook (struct cgraph_node_hook_list *);
601 void cgraph_call_function_insertion_hooks (struct cgraph_node *node);
602 struct cgraph_2edge_hook_list *cgraph_add_edge_duplication_hook (cgraph_2edge_hook, void *);
603 void cgraph_remove_edge_duplication_hook (struct cgraph_2edge_hook_list *);
604 struct cgraph_2node_hook_list *cgraph_add_node_duplication_hook (cgraph_2node_hook, void *);
605 void cgraph_remove_node_duplication_hook (struct cgraph_2node_hook_list *);
606 void cgraph_materialize_all_clones (void);
607 gimple cgraph_redirect_edge_call_stmt_to_callee (struct cgraph_edge *);
608 bool cgraph_propagate_frequency (struct cgraph_node *node);
609 /* In cgraphbuild.c */
610 unsigned int rebuild_cgraph_edges (void);
611 void cgraph_rebuild_references (void);
612 void reset_inline_failed (struct cgraph_node *);
613 int compute_call_stmt_bb_frequency (tree, basic_block bb);
615 /* In ipa.c */
616 bool cgraph_remove_unreachable_nodes (bool, FILE *);
617 cgraph_node_set cgraph_node_set_new (void);
618 cgraph_node_set_iterator cgraph_node_set_find (cgraph_node_set,
619 struct cgraph_node *);
620 void cgraph_node_set_add (cgraph_node_set, struct cgraph_node *);
621 void cgraph_node_set_remove (cgraph_node_set, struct cgraph_node *);
622 void dump_cgraph_node_set (FILE *, cgraph_node_set);
623 void debug_cgraph_node_set (cgraph_node_set);
624 void free_cgraph_node_set (cgraph_node_set);
626 varpool_node_set varpool_node_set_new (void);
627 varpool_node_set_iterator varpool_node_set_find (varpool_node_set,
628 struct varpool_node *);
629 void varpool_node_set_add (varpool_node_set, struct varpool_node *);
630 void varpool_node_set_remove (varpool_node_set, struct varpool_node *);
631 void dump_varpool_node_set (FILE *, varpool_node_set);
632 void debug_varpool_node_set (varpool_node_set);
633 void free_varpool_node_set (varpool_node_set);
634 void ipa_discover_readonly_nonaddressable_vars (void);
635 bool cgraph_comdat_can_be_unshared_p (struct cgraph_node *);
637 /* In predict.c */
638 bool cgraph_maybe_hot_edge_p (struct cgraph_edge *e);
639 bool cgraph_optimize_for_size_p (struct cgraph_node *);
641 /* In varpool.c */
642 extern GTY(()) struct varpool_node *varpool_nodes_queue;
643 extern GTY(()) struct varpool_node *varpool_nodes;
645 struct varpool_node *varpool_node (tree);
646 struct varpool_node *varpool_node_for_asm (tree asmname);
647 void varpool_mark_needed_node (struct varpool_node *);
648 void debug_varpool (void);
649 void dump_varpool (FILE *);
650 void dump_varpool_node (FILE *, struct varpool_node *);
652 void varpool_finalize_decl (tree);
653 bool decide_is_variable_needed (struct varpool_node *, tree);
654 enum availability cgraph_variable_initializer_availability (struct varpool_node *);
655 void cgraph_make_decl_local (tree);
656 void cgraph_make_node_local (struct cgraph_node *);
657 bool cgraph_node_can_be_local_p (struct cgraph_node *);
660 struct varpool_node * varpool_get_node (const_tree decl);
661 void varpool_remove_node (struct varpool_node *node);
662 void varpool_finalize_named_section_flags (struct varpool_node *node);
663 bool varpool_assemble_pending_decls (void);
664 bool varpool_assemble_decl (struct varpool_node *node);
665 bool varpool_analyze_pending_decls (void);
666 void varpool_remove_unreferenced_decls (void);
667 void varpool_empty_needed_queue (void);
668 struct varpool_node * varpool_extra_name_alias (tree, tree);
669 const char * varpool_node_name (struct varpool_node *node);
670 void varpool_reset_queue (void);
671 bool const_value_known_p (tree);
673 /* Walk all reachable static variables. */
674 #define FOR_EACH_STATIC_VARIABLE(node) \
675 for ((node) = varpool_nodes_queue; (node); (node) = (node)->next_needed)
677 /* Return first reachable static variable with initializer. */
678 static inline struct varpool_node *
679 varpool_first_static_initializer (void)
681 struct varpool_node *node;
682 for (node = varpool_nodes_queue; node; node = node->next_needed)
684 gcc_checking_assert (TREE_CODE (node->decl) == VAR_DECL);
685 if (DECL_INITIAL (node->decl))
686 return node;
688 return NULL;
691 /* Return next reachable static variable with initializer after NODE. */
692 static inline struct varpool_node *
693 varpool_next_static_initializer (struct varpool_node *node)
695 for (node = node->next_needed; node; node = node->next_needed)
697 gcc_checking_assert (TREE_CODE (node->decl) == VAR_DECL);
698 if (DECL_INITIAL (node->decl))
699 return node;
701 return NULL;
704 /* Walk all static variables with initializer set. */
705 #define FOR_EACH_STATIC_INITIALIZER(node) \
706 for ((node) = varpool_first_static_initializer (); (node); \
707 (node) = varpool_next_static_initializer (node))
709 /* Return first function with body defined. */
710 static inline struct cgraph_node *
711 cgraph_first_defined_function (void)
713 struct cgraph_node *node;
714 for (node = cgraph_nodes; node; node = node->next)
716 if (node->analyzed)
717 return node;
719 return NULL;
722 /* Return next reachable static variable with initializer after NODE. */
723 static inline struct cgraph_node *
724 cgraph_next_defined_function (struct cgraph_node *node)
726 for (node = node->next; node; node = node->next)
728 if (node->analyzed)
729 return node;
731 return NULL;
734 /* Walk all functions with body defined. */
735 #define FOR_EACH_DEFINED_FUNCTION(node) \
736 for ((node) = cgraph_first_defined_function (); (node); \
737 (node) = cgraph_next_defined_function (node))
740 /* Return true when NODE is a function with Gimple body defined
741 in current unit. Functions can also be define externally or they
742 can be thunks with no Gimple representation.
744 Note that at WPA stage, the function body may not be present in memory. */
746 static inline bool
747 cgraph_function_with_gimple_body_p (struct cgraph_node *node)
749 return node->analyzed && !node->thunk.thunk_p;
752 /* Return first function with body defined. */
753 static inline struct cgraph_node *
754 cgraph_first_function_with_gimple_body (void)
756 struct cgraph_node *node;
757 for (node = cgraph_nodes; node; node = node->next)
759 if (cgraph_function_with_gimple_body_p (node))
760 return node;
762 return NULL;
765 /* Return next reachable static variable with initializer after NODE. */
766 static inline struct cgraph_node *
767 cgraph_next_function_with_gimple_body (struct cgraph_node *node)
769 for (node = node->next; node; node = node->next)
771 if (cgraph_function_with_gimple_body_p (node))
772 return node;
774 return NULL;
777 /* Walk all functions with body defined. */
778 #define FOR_EACH_FUNCTION_WITH_GIMPLE_BODY(node) \
779 for ((node) = cgraph_first_function_with_gimple_body (); (node); \
780 (node) = cgraph_next_function_with_gimple_body (node))
782 /* Create a new static variable of type TYPE. */
783 tree add_new_static_var (tree type);
785 /* Return true if iterator CSI points to nothing. */
786 static inline bool
787 csi_end_p (cgraph_node_set_iterator csi)
789 return csi.index >= VEC_length (cgraph_node_ptr, csi.set->nodes);
792 /* Advance iterator CSI. */
793 static inline void
794 csi_next (cgraph_node_set_iterator *csi)
796 csi->index++;
799 /* Return the node pointed to by CSI. */
800 static inline struct cgraph_node *
801 csi_node (cgraph_node_set_iterator csi)
803 return VEC_index (cgraph_node_ptr, csi.set->nodes, csi.index);
806 /* Return an iterator to the first node in SET. */
807 static inline cgraph_node_set_iterator
808 csi_start (cgraph_node_set set)
810 cgraph_node_set_iterator csi;
812 csi.set = set;
813 csi.index = 0;
814 return csi;
817 /* Return true if SET contains NODE. */
818 static inline bool
819 cgraph_node_in_set_p (struct cgraph_node *node, cgraph_node_set set)
821 cgraph_node_set_iterator csi;
822 csi = cgraph_node_set_find (set, node);
823 return !csi_end_p (csi);
826 /* Return number of nodes in SET. */
827 static inline size_t
828 cgraph_node_set_size (cgraph_node_set set)
830 return VEC_length (cgraph_node_ptr, set->nodes);
833 /* Return true if iterator VSI points to nothing. */
834 static inline bool
835 vsi_end_p (varpool_node_set_iterator vsi)
837 return vsi.index >= VEC_length (varpool_node_ptr, vsi.set->nodes);
840 /* Advance iterator VSI. */
841 static inline void
842 vsi_next (varpool_node_set_iterator *vsi)
844 vsi->index++;
847 /* Return the node pointed to by VSI. */
848 static inline struct varpool_node *
849 vsi_node (varpool_node_set_iterator vsi)
851 return VEC_index (varpool_node_ptr, vsi.set->nodes, vsi.index);
854 /* Return an iterator to the first node in SET. */
855 static inline varpool_node_set_iterator
856 vsi_start (varpool_node_set set)
858 varpool_node_set_iterator vsi;
860 vsi.set = set;
861 vsi.index = 0;
862 return vsi;
865 /* Return true if SET contains NODE. */
866 static inline bool
867 varpool_node_in_set_p (struct varpool_node *node, varpool_node_set set)
869 varpool_node_set_iterator vsi;
870 vsi = varpool_node_set_find (set, node);
871 return !vsi_end_p (vsi);
874 /* Return number of nodes in SET. */
875 static inline size_t
876 varpool_node_set_size (varpool_node_set set)
878 return VEC_length (varpool_node_ptr, set->nodes);
881 /* Uniquize all constants that appear in memory.
882 Each constant in memory thus far output is recorded
883 in `const_desc_table'. */
885 struct GTY(()) constant_descriptor_tree {
886 /* A MEM for the constant. */
887 rtx rtl;
889 /* The value of the constant. */
890 tree value;
892 /* Hash of value. Computing the hash from value each time
893 hashfn is called can't work properly, as that means recursive
894 use of the hash table during hash table expansion. */
895 hashval_t hash;
898 /* Return true if set is nonempty. */
899 static inline bool
900 cgraph_node_set_nonempty_p (cgraph_node_set set)
902 return !VEC_empty (cgraph_node_ptr, set->nodes);
905 /* Return true if set is nonempty. */
906 static inline bool
907 varpool_node_set_nonempty_p (varpool_node_set set)
909 return !VEC_empty (varpool_node_ptr, set->nodes);
912 /* Return true when function NODE is only called directly or it has alias.
913 i.e. it is not externally visible, address was not taken and
914 it is not used in any other non-standard way. */
916 static inline bool
917 cgraph_only_called_directly_or_aliased_p (struct cgraph_node *node)
919 gcc_assert (!node->global.inlined_to);
920 return (!node->needed && !node->address_taken
921 && !node->reachable_from_other_partition
922 && !DECL_STATIC_CONSTRUCTOR (node->decl)
923 && !DECL_STATIC_DESTRUCTOR (node->decl)
924 && !node->local.externally_visible);
927 /* Return true when function NODE can be removed from callgraph
928 if all direct calls are eliminated. */
930 static inline bool
931 cgraph_can_remove_if_no_direct_calls_p (struct cgraph_node *node)
933 /* Extern inlines can always go, we will use the external definition. */
934 if (DECL_EXTERNAL (node->decl))
935 return true;
936 return (!node->address_taken
937 && cgraph_can_remove_if_no_direct_calls_and_refs_p (node));
940 /* Return true when function NODE can be removed from callgraph
941 if all direct calls are eliminated. */
943 static inline bool
944 varpool_can_remove_if_no_refs (struct varpool_node *node)
946 return (!node->force_output && !node->used_from_other_partition
947 && (flag_toplevel_reorder || DECL_COMDAT (node->decl)
948 || DECL_ARTIFICIAL (node->decl))
949 && (DECL_COMDAT (node->decl) || !node->externally_visible));
952 /* Return true when all references to VNODE must be visible in ipa_ref_list.
953 i.e. if the variable is not externally visible or not used in some magic
954 way (asm statement or such).
955 The magic uses are all summarized in force_output flag. */
957 static inline bool
958 varpool_all_refs_explicit_p (struct varpool_node *vnode)
960 return (!vnode->externally_visible
961 && !vnode->used_from_other_partition
962 && !vnode->force_output);
965 /* Constant pool accessor function. */
966 htab_t constant_pool_htab (void);
968 /* FIXME: inappropriate dependency of cgraph on IPA. */
969 #include "ipa-ref-inline.h"
971 /* Given NODE, walk the alias chain to return the function NODE is alias of.
972 Walk through thunk, too.
973 When AVAILABILITY is non-NULL, get minimal availablity in the chain. */
975 static inline struct cgraph_node *
976 cgraph_function_node (struct cgraph_node *node, enum availability *availability)
978 if (availability)
979 *availability = cgraph_function_body_availability (node);
980 while (node)
982 if (node->thunk.thunk_p)
983 node = node->callees->callee;
984 else
985 return node;
986 if (availability)
988 enum availability a;
989 a = cgraph_function_body_availability (node);
990 if (a < *availability)
991 *availability = a;
994 return NULL;
997 /* Given NODE, walk the alias chain to return the function NODE is alias of.
998 Do not walk through thunks.
999 When AVAILABILITY is non-NULL, get minimal availablity in the chain. */
1001 static inline struct cgraph_node *
1002 cgraph_function_or_thunk_node (struct cgraph_node *node, enum availability *availability)
1004 if (availability)
1005 *availability = cgraph_function_body_availability (node);
1006 return node;
1007 return NULL;
1010 /* Return true when the edge E represents a direct recursion. */
1011 static inline bool
1012 cgraph_edge_recursive_p (struct cgraph_edge *e)
1014 struct cgraph_node *callee = cgraph_function_or_thunk_node (e->callee, NULL);
1015 if (e->caller->global.inlined_to)
1016 return e->caller->global.inlined_to->decl == callee->decl;
1017 else
1018 return e->caller->decl == callee->decl;
1020 #endif /* GCC_CGRAPH_H */