1 /* Callgraph handling code.
2 Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008
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
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
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 /* This file contains basic routines manipulating call graph
26 The call-graph is data structure designed for intra-procedural optimization
27 but it is also used in non-unit-at-a-time compilation to allow easier code
30 The call-graph consist of nodes and edges represented via linked lists.
31 Each function (external or not) corresponds to the unique node.
33 The mapping from declarations to call-graph nodes is done using hash table
34 based on DECL_UID. The call-graph nodes are created lazily using
35 cgraph_node function when called for unknown declaration.
37 The callgraph at the moment does not represent indirect calls or calls
38 from other compilation unit. Flag NEEDED is set for each node that may
39 be accessed in such an invisible way and it shall be considered an
40 entry point to the callgraph.
42 Interprocedural information:
44 Callgraph is place to store data needed for interprocedural optimization.
45 All data structures are divided into three components: local_info that
46 is produced while analyzing the function, global_info that is result
47 of global walking of the callgraph on the end of compilation and
48 rtl_info used by RTL backend to propagate data from already compiled
49 functions to their callers.
53 The function inlining information is decided in advance and maintained
54 in the callgraph as so called inline plan.
55 For each inlined call, the callee's node is cloned to represent the
56 new function copy produced by inliner.
57 Each inlined call gets a unique corresponding clone node of the callee
58 and the data structure is updated while inlining is performed, so
59 the clones are eliminated and their callee edges redirected to the
62 Each edge has "inline_failed" field. When the field is set to NULL,
63 the call will be inlined. When it is non-NULL it contains a reason
64 why inlining wasn't performed. */
68 #include "coretypes.h"
71 #include "tree-inline.h"
72 #include "langhooks.h"
79 #include "basic-block.h"
85 #include "tree-dump.h"
86 #include "tree-flow.h"
87 #include "value-prof.h"
89 static void cgraph_node_remove_callers (struct cgraph_node *node);
90 static inline void cgraph_edge_remove_caller (struct cgraph_edge *e);
91 static inline void cgraph_edge_remove_callee (struct cgraph_edge *e);
93 /* Hash table used to convert declarations into nodes. */
94 static GTY((param_is (struct cgraph_node))) htab_t cgraph_hash;
95 /* Hash table used to convert assembler names into nodes. */
96 static GTY((param_is (struct cgraph_node))) htab_t assembler_name_hash;
98 /* The linked list of cgraph nodes. */
99 struct cgraph_node *cgraph_nodes;
101 /* Queue of cgraph nodes scheduled to be lowered. */
102 struct cgraph_node *cgraph_nodes_queue;
104 /* Queue of cgraph nodes scheduled to be added into cgraph. This is a
105 secondary queue used during optimization to accommodate passes that
106 may generate new functions that need to be optimized and expanded. */
107 struct cgraph_node *cgraph_new_nodes;
109 /* Number of nodes in existence. */
112 /* Maximal uid used in cgraph nodes. */
115 /* Maximal uid used in cgraph edges. */
116 int cgraph_edge_max_uid;
118 /* Maximal pid used for profiling */
121 /* Set when whole unit has been analyzed so we can access global info. */
122 bool cgraph_global_info_ready = false;
124 /* What state callgraph is in right now. */
125 enum cgraph_state cgraph_state = CGRAPH_STATE_CONSTRUCTION;
127 /* Set when the cgraph is fully build and the basic flags are computed. */
128 bool cgraph_function_flags_ready = false;
130 /* Linked list of cgraph asm nodes. */
131 struct cgraph_asm_node *cgraph_asm_nodes;
133 /* Last node in cgraph_asm_nodes. */
134 static GTY(()) struct cgraph_asm_node *cgraph_asm_last_node;
136 /* The order index of the next cgraph node to be created. This is
137 used so that we can sort the cgraph nodes in order by when we saw
138 them, to support -fno-toplevel-reorder. */
141 /* List of hooks trigerred on cgraph_edge events. */
142 struct cgraph_edge_hook_list {
143 cgraph_edge_hook hook;
145 struct cgraph_edge_hook_list *next;
148 /* List of hooks trigerred on cgraph_node events. */
149 struct cgraph_node_hook_list {
150 cgraph_node_hook hook;
152 struct cgraph_node_hook_list *next;
155 /* List of hooks trigerred on events involving two cgraph_edges. */
156 struct cgraph_2edge_hook_list {
157 cgraph_2edge_hook hook;
159 struct cgraph_2edge_hook_list *next;
162 /* List of hooks trigerred on events involving two cgraph_nodes. */
163 struct cgraph_2node_hook_list {
164 cgraph_2node_hook hook;
166 struct cgraph_2node_hook_list *next;
169 /* List of hooks triggered when an edge is removed. */
170 struct cgraph_edge_hook_list *first_cgraph_edge_removal_hook;
171 /* List of hooks triggered when a node is removed. */
172 struct cgraph_node_hook_list *first_cgraph_node_removal_hook;
173 /* List of hooks triggered when an edge is duplicated. */
174 struct cgraph_2edge_hook_list *first_cgraph_edge_duplicated_hook;
175 /* List of hooks triggered when a node is duplicated. */
176 struct cgraph_2node_hook_list *first_cgraph_node_duplicated_hook;
177 /* List of hooks triggered when an function is inserted. */
178 struct cgraph_node_hook_list *first_cgraph_function_insertion_hook;
180 /* Head of a linked list of unused (freed) call graph nodes.
181 Do not GTY((delete)) this list so UIDs gets reliably recycled. */
182 static GTY(()) struct cgraph_node *free_nodes;
183 /* Head of a linked list of unused (freed) call graph edges.
184 Do not GTY((delete)) this list so UIDs gets reliably recycled. */
185 static GTY(()) struct cgraph_edge *free_edges;
187 /* Macros to access the next item in the list of free cgraph nodes and
189 #define NEXT_FREE_NODE(NODE) (NODE)->next
190 #define NEXT_FREE_EDGE(EDGE) (EDGE)->prev_caller
192 /* Register HOOK to be called with DATA on each removed edge. */
193 struct cgraph_edge_hook_list *
194 cgraph_add_edge_removal_hook (cgraph_edge_hook hook, void *data)
196 struct cgraph_edge_hook_list *entry;
197 struct cgraph_edge_hook_list **ptr = &first_cgraph_edge_removal_hook;
199 entry = (struct cgraph_edge_hook_list *) xmalloc (sizeof (*entry));
209 /* Remove ENTRY from the list of hooks called on removing edges. */
211 cgraph_remove_edge_removal_hook (struct cgraph_edge_hook_list *entry)
213 struct cgraph_edge_hook_list **ptr = &first_cgraph_edge_removal_hook;
215 while (*ptr != entry)
221 /* Call all edge removal hooks. */
223 cgraph_call_edge_removal_hooks (struct cgraph_edge *e)
225 struct cgraph_edge_hook_list *entry = first_cgraph_edge_removal_hook;
228 entry->hook (e, entry->data);
233 /* Register HOOK to be called with DATA on each removed node. */
234 struct cgraph_node_hook_list *
235 cgraph_add_node_removal_hook (cgraph_node_hook hook, void *data)
237 struct cgraph_node_hook_list *entry;
238 struct cgraph_node_hook_list **ptr = &first_cgraph_node_removal_hook;
240 entry = (struct cgraph_node_hook_list *) xmalloc (sizeof (*entry));
250 /* Remove ENTRY from the list of hooks called on removing nodes. */
252 cgraph_remove_node_removal_hook (struct cgraph_node_hook_list *entry)
254 struct cgraph_node_hook_list **ptr = &first_cgraph_node_removal_hook;
256 while (*ptr != entry)
262 /* Call all node removal hooks. */
264 cgraph_call_node_removal_hooks (struct cgraph_node *node)
266 struct cgraph_node_hook_list *entry = first_cgraph_node_removal_hook;
269 entry->hook (node, entry->data);
274 /* Register HOOK to be called with DATA on each removed node. */
275 struct cgraph_node_hook_list *
276 cgraph_add_function_insertion_hook (cgraph_node_hook hook, void *data)
278 struct cgraph_node_hook_list *entry;
279 struct cgraph_node_hook_list **ptr = &first_cgraph_function_insertion_hook;
281 entry = (struct cgraph_node_hook_list *) xmalloc (sizeof (*entry));
291 /* Remove ENTRY from the list of hooks called on removing nodes. */
293 cgraph_remove_function_insertion_hook (struct cgraph_node_hook_list *entry)
295 struct cgraph_node_hook_list **ptr = &first_cgraph_function_insertion_hook;
297 while (*ptr != entry)
303 /* Call all node removal hooks. */
305 cgraph_call_function_insertion_hooks (struct cgraph_node *node)
307 struct cgraph_node_hook_list *entry = first_cgraph_function_insertion_hook;
310 entry->hook (node, entry->data);
315 /* Register HOOK to be called with DATA on each duplicated edge. */
316 struct cgraph_2edge_hook_list *
317 cgraph_add_edge_duplication_hook (cgraph_2edge_hook hook, void *data)
319 struct cgraph_2edge_hook_list *entry;
320 struct cgraph_2edge_hook_list **ptr = &first_cgraph_edge_duplicated_hook;
322 entry = (struct cgraph_2edge_hook_list *) xmalloc (sizeof (*entry));
332 /* Remove ENTRY from the list of hooks called on duplicating edges. */
334 cgraph_remove_edge_duplication_hook (struct cgraph_2edge_hook_list *entry)
336 struct cgraph_2edge_hook_list **ptr = &first_cgraph_edge_duplicated_hook;
338 while (*ptr != entry)
344 /* Call all edge duplication hooks. */
346 cgraph_call_edge_duplication_hooks (struct cgraph_edge *cs1,
347 struct cgraph_edge *cs2)
349 struct cgraph_2edge_hook_list *entry = first_cgraph_edge_duplicated_hook;
352 entry->hook (cs1, cs2, entry->data);
357 /* Register HOOK to be called with DATA on each duplicated node. */
358 struct cgraph_2node_hook_list *
359 cgraph_add_node_duplication_hook (cgraph_2node_hook hook, void *data)
361 struct cgraph_2node_hook_list *entry;
362 struct cgraph_2node_hook_list **ptr = &first_cgraph_node_duplicated_hook;
364 entry = (struct cgraph_2node_hook_list *) xmalloc (sizeof (*entry));
374 /* Remove ENTRY from the list of hooks called on duplicating nodes. */
376 cgraph_remove_node_duplication_hook (struct cgraph_2node_hook_list *entry)
378 struct cgraph_2node_hook_list **ptr = &first_cgraph_node_duplicated_hook;
380 while (*ptr != entry)
386 /* Call all node duplication hooks. */
388 cgraph_call_node_duplication_hooks (struct cgraph_node *node1,
389 struct cgraph_node *node2)
391 struct cgraph_2node_hook_list *entry = first_cgraph_node_duplicated_hook;
394 entry->hook (node1, node2, entry->data);
399 /* Returns a hash code for P. */
402 hash_node (const void *p)
404 const struct cgraph_node *n = (const struct cgraph_node *) p;
405 return (hashval_t) DECL_UID (n->decl);
408 /* Returns nonzero if P1 and P2 are equal. */
411 eq_node (const void *p1, const void *p2)
413 const struct cgraph_node *n1 = (const struct cgraph_node *) p1;
414 const struct cgraph_node *n2 = (const struct cgraph_node *) p2;
415 return DECL_UID (n1->decl) == DECL_UID (n2->decl);
418 /* Allocate new callgraph node and insert it into basic data structures. */
420 static struct cgraph_node *
421 cgraph_create_node (void)
423 struct cgraph_node *node;
428 free_nodes = NEXT_FREE_NODE (node);
432 node = GGC_CNEW (struct cgraph_node);
433 node->uid = cgraph_max_uid++;
436 node->next = cgraph_nodes;
438 node->order = cgraph_order++;
440 cgraph_nodes->previous = node;
441 node->previous = NULL;
442 node->global.estimated_growth = INT_MIN;
448 /* Return cgraph node assigned to DECL. Create new one when needed. */
451 cgraph_node (tree decl)
453 struct cgraph_node key, *node, **slot;
455 gcc_assert (TREE_CODE (decl) == FUNCTION_DECL);
458 cgraph_hash = htab_create_ggc (10, hash_node, eq_node, NULL);
462 slot = (struct cgraph_node **) htab_find_slot (cgraph_hash, &key, INSERT);
470 node = cgraph_create_node ();
473 if (DECL_CONTEXT (decl) && TREE_CODE (DECL_CONTEXT (decl)) == FUNCTION_DECL)
475 node->origin = cgraph_node (DECL_CONTEXT (decl));
476 node->next_nested = node->origin->nested;
477 node->origin->nested = node;
479 if (assembler_name_hash)
482 tree name = DECL_ASSEMBLER_NAME (decl);
484 aslot = htab_find_slot_with_hash (assembler_name_hash, name,
485 decl_assembler_name_hash (name),
487 /* We can have multiple declarations with same assembler name. For C++
488 it is __builtin_strlen and strlen, for instance. Do we need to
489 record them all? Original implementation marked just first one
490 so lets hope for the best. */
497 /* Insert already constructed node into hashtable. */
500 cgraph_insert_node_to_hashtable (struct cgraph_node *node)
502 struct cgraph_node **slot;
504 slot = (struct cgraph_node **) htab_find_slot (cgraph_hash, node, INSERT);
510 /* Returns a hash code for P. */
513 hash_node_by_assembler_name (const void *p)
515 const struct cgraph_node *n = (const struct cgraph_node *) p;
516 return (hashval_t) decl_assembler_name_hash (DECL_ASSEMBLER_NAME (n->decl));
519 /* Returns nonzero if P1 and P2 are equal. */
522 eq_assembler_name (const void *p1, const void *p2)
524 const struct cgraph_node *n1 = (const struct cgraph_node *) p1;
525 const_tree name = (const_tree)p2;
526 return (decl_assembler_name_equal (n1->decl, name));
529 /* Return the cgraph node that has ASMNAME for its DECL_ASSEMBLER_NAME.
530 Return NULL if there's no such node. */
533 cgraph_node_for_asm (tree asmname)
535 struct cgraph_node *node;
538 if (!assembler_name_hash)
540 assembler_name_hash =
541 htab_create_ggc (10, hash_node_by_assembler_name, eq_assembler_name,
543 for (node = cgraph_nodes; node; node = node->next)
544 if (!node->global.inlined_to)
546 tree name = DECL_ASSEMBLER_NAME (node->decl);
547 slot = htab_find_slot_with_hash (assembler_name_hash, name,
548 decl_assembler_name_hash (name),
550 /* We can have multiple declarations with same assembler name. For C++
551 it is __builtin_strlen and strlen, for instance. Do we need to
552 record them all? Original implementation marked just first one
553 so lets hope for the best. */
560 slot = htab_find_slot_with_hash (assembler_name_hash, asmname,
561 decl_assembler_name_hash (asmname),
565 return (struct cgraph_node *) *slot;
569 /* Returns a hash value for X (which really is a die_struct). */
572 edge_hash (const void *x)
574 return htab_hash_pointer (((const struct cgraph_edge *) x)->call_stmt);
577 /* Return nonzero if decl_id of die_struct X is the same as UID of decl *Y. */
580 edge_eq (const void *x, const void *y)
582 return ((const struct cgraph_edge *) x)->call_stmt == y;
586 /* Return the callgraph edge representing the GIMPLE_CALL statement
590 cgraph_edge (struct cgraph_node *node, gimple call_stmt)
592 struct cgraph_edge *e, *e2;
595 if (node->call_site_hash)
596 return (struct cgraph_edge *)
597 htab_find_with_hash (node->call_site_hash, call_stmt,
598 htab_hash_pointer (call_stmt));
600 /* This loop may turn out to be performance problem. In such case adding
601 hashtables into call nodes with very many edges is probably best
602 solution. It is not good idea to add pointer into CALL_EXPR itself
603 because we want to make possible having multiple cgraph nodes representing
604 different clones of the same body before the body is actually cloned. */
605 for (e = node->callees; e; e= e->next_callee)
607 if (e->call_stmt == call_stmt)
614 node->call_site_hash = htab_create_ggc (120, edge_hash, edge_eq, NULL);
615 for (e2 = node->callees; e2; e2 = e2->next_callee)
618 slot = htab_find_slot_with_hash (node->call_site_hash,
620 htab_hash_pointer (e2->call_stmt),
631 /* Change field call_smt of edge E to NEW_STMT. */
634 cgraph_set_call_stmt (struct cgraph_edge *e, gimple new_stmt)
636 if (e->caller->call_site_hash)
638 htab_remove_elt_with_hash (e->caller->call_site_hash,
640 htab_hash_pointer (e->call_stmt));
642 e->call_stmt = new_stmt;
643 e->can_throw_external = stmt_can_throw_external (new_stmt);
644 if (e->caller->call_site_hash)
647 slot = htab_find_slot_with_hash (e->caller->call_site_hash,
650 (e->call_stmt), INSERT);
656 /* Give initial reasons why inlining would fail on EDGE. This gets either
657 nullified or usually overwritten by more precise reasons later. */
660 initialize_inline_failed (struct cgraph_edge *e)
662 struct cgraph_node *callee = e->callee;
664 if (!callee->analyzed)
665 e->inline_failed = CIF_BODY_NOT_AVAILABLE;
666 else if (callee->local.redefined_extern_inline)
667 e->inline_failed = CIF_REDEFINED_EXTERN_INLINE;
668 else if (!callee->local.inlinable)
669 e->inline_failed = CIF_FUNCTION_NOT_INLINABLE;
670 else if (gimple_call_cannot_inline_p (e->call_stmt))
671 e->inline_failed = CIF_MISMATCHED_ARGUMENTS;
673 e->inline_failed = CIF_FUNCTION_NOT_CONSIDERED;
676 /* Create edge from CALLER to CALLEE in the cgraph. */
679 cgraph_create_edge (struct cgraph_node *caller, struct cgraph_node *callee,
680 gimple call_stmt, gcov_type count, int freq, int nest)
682 struct cgraph_edge *edge;
684 #ifdef ENABLE_CHECKING
685 /* This is rather pricely check possibly trigerring construction of call stmt
687 gcc_assert (!cgraph_edge (caller, call_stmt));
690 gcc_assert (is_gimple_call (call_stmt));
695 free_edges = NEXT_FREE_EDGE (edge);
699 edge = GGC_NEW (struct cgraph_edge);
700 edge->uid = cgraph_edge_max_uid++;
705 edge->caller = caller;
706 edge->callee = callee;
707 edge->call_stmt = call_stmt;
708 edge->can_throw_external = stmt_can_throw_external (call_stmt);
709 edge->prev_caller = NULL;
710 edge->next_caller = callee->callers;
712 callee->callers->prev_caller = edge;
713 edge->prev_callee = NULL;
714 edge->next_callee = caller->callees;
716 caller->callees->prev_callee = edge;
717 caller->callees = edge;
718 callee->callers = edge;
720 gcc_assert (count >= 0);
721 edge->frequency = freq;
722 gcc_assert (freq >= 0);
723 gcc_assert (freq <= CGRAPH_FREQ_MAX);
724 edge->loop_nest = nest;
725 edge->indirect_call = 0;
726 if (caller->call_site_hash)
729 slot = htab_find_slot_with_hash (caller->call_site_hash,
738 initialize_inline_failed (edge);
743 /* Remove the edge E from the list of the callers of the callee. */
746 cgraph_edge_remove_callee (struct cgraph_edge *e)
749 e->prev_caller->next_caller = e->next_caller;
751 e->next_caller->prev_caller = e->prev_caller;
753 e->callee->callers = e->next_caller;
756 /* Remove the edge E from the list of the callees of the caller. */
759 cgraph_edge_remove_caller (struct cgraph_edge *e)
762 e->prev_callee->next_callee = e->next_callee;
764 e->next_callee->prev_callee = e->prev_callee;
766 e->caller->callees = e->next_callee;
767 if (e->caller->call_site_hash)
768 htab_remove_elt_with_hash (e->caller->call_site_hash,
770 htab_hash_pointer (e->call_stmt));
773 /* Put the edge onto the free list. */
776 cgraph_free_edge (struct cgraph_edge *e)
780 /* Clear out the edge so we do not dangle pointers. */
781 memset (e, 0, sizeof (*e));
783 NEXT_FREE_EDGE (e) = free_edges;
787 /* Remove the edge E in the cgraph. */
790 cgraph_remove_edge (struct cgraph_edge *e)
792 /* Call all edge removal hooks. */
793 cgraph_call_edge_removal_hooks (e);
795 /* Remove from callers list of the callee. */
796 cgraph_edge_remove_callee (e);
798 /* Remove from callees list of the callers. */
799 cgraph_edge_remove_caller (e);
801 /* Put the edge onto the free list. */
802 cgraph_free_edge (e);
805 /* Redirect callee of E to N. The function does not update underlying
809 cgraph_redirect_edge_callee (struct cgraph_edge *e, struct cgraph_node *n)
811 /* Remove from callers list of the current callee. */
812 cgraph_edge_remove_callee (e);
814 /* Insert to callers list of the new callee. */
815 e->prev_caller = NULL;
817 n->callers->prev_caller = e;
818 e->next_caller = n->callers;
824 /* Update or remove the corresponding cgraph edge if a GIMPLE_CALL
825 OLD_STMT changed into NEW_STMT. */
828 cgraph_update_edges_for_call_stmt (gimple old_stmt, gimple new_stmt)
830 tree new_call = (is_gimple_call (new_stmt)) ? gimple_call_fn (new_stmt) : 0;
831 tree old_call = (is_gimple_call (old_stmt)) ? gimple_call_fn (old_stmt) : 0;
832 struct cgraph_node *node = cgraph_node (cfun->decl);
834 if (old_call != new_call)
836 struct cgraph_edge *e = cgraph_edge (node, old_stmt);
837 struct cgraph_edge *ne = NULL;
842 gcov_type count = e->count;
843 int frequency = e->frequency;
844 int loop_nest = e->loop_nest;
846 cgraph_remove_edge (e);
849 new_decl = gimple_call_fndecl (new_stmt);
852 ne = cgraph_create_edge (node, cgraph_node (new_decl),
853 new_stmt, count, frequency,
855 gcc_assert (ne->inline_failed);
860 else if (old_stmt != new_stmt)
862 struct cgraph_edge *e = cgraph_edge (node, old_stmt);
865 cgraph_set_call_stmt (e, new_stmt);
870 /* Remove all callees from the node. */
873 cgraph_node_remove_callees (struct cgraph_node *node)
875 struct cgraph_edge *e, *f;
877 /* It is sufficient to remove the edges from the lists of callers of
878 the callees. The callee list of the node can be zapped with one
880 for (e = node->callees; e; e = f)
883 cgraph_call_edge_removal_hooks (e);
884 cgraph_edge_remove_callee (e);
885 cgraph_free_edge (e);
887 node->callees = NULL;
888 if (node->call_site_hash)
890 htab_delete (node->call_site_hash);
891 node->call_site_hash = NULL;
895 /* Remove all callers from the node. */
898 cgraph_node_remove_callers (struct cgraph_node *node)
900 struct cgraph_edge *e, *f;
902 /* It is sufficient to remove the edges from the lists of callees of
903 the callers. The caller list of the node can be zapped with one
905 for (e = node->callers; e; e = f)
908 cgraph_call_edge_removal_hooks (e);
909 cgraph_edge_remove_caller (e);
910 cgraph_free_edge (e);
912 node->callers = NULL;
915 /* Release memory used to represent body of function NODE. */
918 cgraph_release_function_body (struct cgraph_node *node)
920 if (DECL_STRUCT_FUNCTION (node->decl))
922 tree old_decl = current_function_decl;
923 push_cfun (DECL_STRUCT_FUNCTION (node->decl));
926 current_function_decl = node->decl;
928 delete_tree_cfg_annotations ();
930 current_function_decl = old_decl;
934 gcc_assert (dom_computed[0] == DOM_NONE);
935 gcc_assert (dom_computed[1] == DOM_NONE);
938 if (cfun->value_histograms)
940 gcc_assert (!current_loops);
942 gimple_set_body (node->decl, NULL);
943 VEC_free (ipa_opt_pass, heap,
944 DECL_STRUCT_FUNCTION (node->decl)->ipa_transforms_to_apply);
945 /* Struct function hangs a lot of data that would leak if we didn't
946 removed all pointers to it. */
947 ggc_free (DECL_STRUCT_FUNCTION (node->decl));
948 DECL_STRUCT_FUNCTION (node->decl) = NULL;
950 DECL_SAVED_TREE (node->decl) = NULL;
951 /* If the node is abstract and needed, then do not clear DECL_INITIAL
952 of its associated function function declaration because it's
953 needed to emit debug info later. */
954 if (!node->abstract_and_needed)
955 DECL_INITIAL (node->decl) = error_mark_node;
958 /* Remove the node from cgraph. */
961 cgraph_remove_node (struct cgraph_node *node)
964 bool kill_body = false;
965 struct cgraph_node *n;
968 cgraph_call_node_removal_hooks (node);
969 cgraph_node_remove_callers (node);
970 cgraph_node_remove_callees (node);
972 /* Incremental inlining access removed nodes stored in the postorder list.
974 node->needed = node->reachable = false;
975 for (n = node->nested; n; n = n->next_nested)
980 struct cgraph_node **node2 = &node->origin->nested;
982 while (*node2 != node)
983 node2 = &(*node2)->next_nested;
984 *node2 = node->next_nested;
987 node->previous->next = node->next;
989 cgraph_nodes = node->next;
991 node->next->previous = node->previous;
993 node->previous = NULL;
994 slot = htab_find_slot (cgraph_hash, node, NO_INSERT);
997 if (node->next_clone)
999 struct cgraph_node *new_node = node->next_clone;
1002 node->next_clone->prev_clone = NULL;
1006 htab_clear_slot (cgraph_hash, slot);
1012 node->prev_clone->next_clone = node->next_clone;
1013 if (node->next_clone)
1014 node->next_clone->prev_clone = node->prev_clone;
1017 /* While all the clones are removed after being proceeded, the function
1018 itself is kept in the cgraph even after it is compiled. Check whether
1019 we are done with this body and reclaim it proactively if this is the case.
1021 if (!kill_body && *slot)
1023 struct cgraph_node *n = (struct cgraph_node *) *slot;
1024 if (!n->next_clone && !n->global.inlined_to
1025 && (cgraph_global_info_ready
1026 && (TREE_ASM_WRITTEN (n->decl) || DECL_EXTERNAL (n->decl))))
1029 if (assembler_name_hash)
1031 tree name = DECL_ASSEMBLER_NAME (node->decl);
1032 slot = htab_find_slot_with_hash (assembler_name_hash, name,
1033 decl_assembler_name_hash (name),
1035 /* Inline clones are not hashed. */
1036 if (slot && *slot == node)
1037 htab_clear_slot (assembler_name_hash, slot);
1041 cgraph_release_function_body (node);
1043 if (node->call_site_hash)
1045 htab_delete (node->call_site_hash);
1046 node->call_site_hash = NULL;
1050 /* Clear out the node to NULL all pointers and add the node to the free
1052 memset (node, 0, sizeof(*node));
1054 NEXT_FREE_NODE (node) = free_nodes;
1058 /* Notify finalize_compilation_unit that given node is reachable. */
1061 cgraph_mark_reachable_node (struct cgraph_node *node)
1063 if (!node->reachable && node->local.finalized)
1065 notice_global_symbol (node->decl);
1066 node->reachable = 1;
1067 gcc_assert (!cgraph_global_info_ready);
1069 node->next_needed = cgraph_nodes_queue;
1070 cgraph_nodes_queue = node;
1074 /* Likewise indicate that a node is needed, i.e. reachable via some
1078 cgraph_mark_needed_node (struct cgraph_node *node)
1081 cgraph_mark_reachable_node (node);
1084 /* Return local info for the compiled function. */
1086 struct cgraph_local_info *
1087 cgraph_local_info (tree decl)
1089 struct cgraph_node *node;
1091 gcc_assert (TREE_CODE (decl) == FUNCTION_DECL);
1092 node = cgraph_node (decl);
1093 return &node->local;
1096 /* Return local info for the compiled function. */
1098 struct cgraph_global_info *
1099 cgraph_global_info (tree decl)
1101 struct cgraph_node *node;
1103 gcc_assert (TREE_CODE (decl) == FUNCTION_DECL && cgraph_global_info_ready);
1104 node = cgraph_node (decl);
1105 return &node->global;
1108 /* Return local info for the compiled function. */
1110 struct cgraph_rtl_info *
1111 cgraph_rtl_info (tree decl)
1113 struct cgraph_node *node;
1115 gcc_assert (TREE_CODE (decl) == FUNCTION_DECL);
1116 node = cgraph_node (decl);
1117 if (decl != current_function_decl
1118 && !TREE_ASM_WRITTEN (node->decl))
1123 /* Return a string describing the failure REASON. */
1126 cgraph_inline_failed_string (cgraph_inline_failed_t reason)
1129 #define DEFCIFCODE(code, string) string,
1131 static const char *cif_string_table[CIF_N_REASONS] = {
1132 #include "cif-code.def"
1135 /* Signedness of an enum type is implementation defined, so cast it
1136 to unsigned before testing. */
1137 gcc_assert ((unsigned) reason < CIF_N_REASONS);
1138 return cif_string_table[reason];
1141 /* Return name of the node used in debug output. */
1143 cgraph_node_name (struct cgraph_node *node)
1145 return lang_hooks.decl_printable_name (node->decl, 2);
1148 /* Names used to print out the availability enum. */
1149 const char * const cgraph_availability_names[] =
1150 {"unset", "not_available", "overwritable", "available", "local"};
1153 /* Dump call graph node NODE to file F. */
1156 dump_cgraph_node (FILE *f, struct cgraph_node *node)
1158 struct cgraph_edge *edge;
1159 fprintf (f, "%s/%i(%i) [%p]:", cgraph_node_name (node), node->uid,
1160 node->pid, (void *) node);
1161 if (node->global.inlined_to)
1162 fprintf (f, " (inline copy in %s/%i)",
1163 cgraph_node_name (node->global.inlined_to),
1164 node->global.inlined_to->uid);
1165 if (cgraph_function_flags_ready)
1166 fprintf (f, " availability:%s",
1167 cgraph_availability_names [cgraph_function_body_availability (node)]);
1169 fprintf (f, " executed "HOST_WIDEST_INT_PRINT_DEC"x",
1170 (HOST_WIDEST_INT)node->count);
1171 if (node->local.inline_summary.self_insns)
1172 fprintf (f, " %i insns", node->local.inline_summary.self_insns);
1173 if (node->global.insns && node->global.insns
1174 != node->local.inline_summary.self_insns)
1175 fprintf (f, " (%i after inlining)", node->global.insns);
1176 if (node->local.inline_summary.estimated_self_stack_size)
1177 fprintf (f, " %i bytes stack usage", (int)node->local.inline_summary.estimated_self_stack_size);
1178 if (node->global.estimated_stack_size != node->local.inline_summary.estimated_self_stack_size)
1179 fprintf (f, " %i bytes after inlining", (int)node->global.estimated_stack_size);
1181 fprintf (f, " nested in: %s", cgraph_node_name (node->origin));
1183 fprintf (f, " needed");
1184 else if (node->reachable)
1185 fprintf (f, " reachable");
1186 if (gimple_has_body_p (node->decl))
1187 fprintf (f, " body");
1189 fprintf (f, " process");
1190 if (node->local.local)
1191 fprintf (f, " local");
1192 if (node->local.externally_visible)
1193 fprintf (f, " externally_visible");
1194 if (node->local.finalized)
1195 fprintf (f, " finalized");
1196 if (node->local.disregard_inline_limits)
1197 fprintf (f, " always_inline");
1198 else if (node->local.inlinable)
1199 fprintf (f, " inlinable");
1200 if (node->local.redefined_extern_inline)
1201 fprintf (f, " redefined_extern_inline");
1202 if (TREE_ASM_WRITTEN (node->decl))
1203 fprintf (f, " asm_written");
1205 fprintf (f, "\n called by: ");
1206 for (edge = node->callers; edge; edge = edge->next_caller)
1208 fprintf (f, "%s/%i ", cgraph_node_name (edge->caller),
1211 fprintf (f, "("HOST_WIDEST_INT_PRINT_DEC"x) ",
1212 (HOST_WIDEST_INT)edge->count);
1213 if (edge->frequency)
1214 fprintf (f, "(%.2f per call) ",
1215 edge->frequency / (double)CGRAPH_FREQ_BASE);
1216 if (!edge->inline_failed)
1217 fprintf(f, "(inlined) ");
1218 if (edge->indirect_call)
1219 fprintf(f, "(indirect) ");
1220 if (edge->can_throw_external)
1221 fprintf(f, "(can throw external) ");
1224 fprintf (f, "\n calls: ");
1225 for (edge = node->callees; edge; edge = edge->next_callee)
1227 fprintf (f, "%s/%i ", cgraph_node_name (edge->callee),
1229 if (!edge->inline_failed)
1230 fprintf(f, "(inlined) ");
1231 if (edge->indirect_call)
1232 fprintf(f, "(indirect) ");
1234 fprintf (f, "("HOST_WIDEST_INT_PRINT_DEC"x) ",
1235 (HOST_WIDEST_INT)edge->count);
1236 if (edge->frequency)
1237 fprintf (f, "(%.2f per call) ",
1238 edge->frequency / (double)CGRAPH_FREQ_BASE);
1239 if (edge->loop_nest)
1240 fprintf (f, "(nested in %i loops) ", edge->loop_nest);
1246 /* Dump call graph node NODE to stderr. */
1249 debug_cgraph_node (struct cgraph_node *node)
1251 dump_cgraph_node (stderr, node);
1255 /* Dump the callgraph to file F. */
1258 dump_cgraph (FILE *f)
1260 struct cgraph_node *node;
1262 fprintf (f, "callgraph:\n\n");
1263 for (node = cgraph_nodes; node; node = node->next)
1264 dump_cgraph_node (f, node);
1268 /* Dump the call graph to stderr. */
1273 dump_cgraph (stderr);
1277 /* Set the DECL_ASSEMBLER_NAME and update cgraph hashtables. */
1280 change_decl_assembler_name (tree decl, tree name)
1282 gcc_assert (!assembler_name_hash);
1283 if (!DECL_ASSEMBLER_NAME_SET_P (decl))
1285 SET_DECL_ASSEMBLER_NAME (decl, name);
1288 if (name == DECL_ASSEMBLER_NAME (decl))
1291 if (TREE_SYMBOL_REFERENCED (DECL_ASSEMBLER_NAME (decl))
1292 && DECL_RTL_SET_P (decl))
1293 warning (0, "%D renamed after being referenced in assembly", decl);
1295 SET_DECL_ASSEMBLER_NAME (decl, name);
1298 /* Add a top-level asm statement to the list. */
1300 struct cgraph_asm_node *
1301 cgraph_add_asm_node (tree asm_str)
1303 struct cgraph_asm_node *node;
1305 node = GGC_CNEW (struct cgraph_asm_node);
1306 node->asm_str = asm_str;
1307 node->order = cgraph_order++;
1309 if (cgraph_asm_nodes == NULL)
1310 cgraph_asm_nodes = node;
1312 cgraph_asm_last_node->next = node;
1313 cgraph_asm_last_node = node;
1317 /* Return true when the DECL can possibly be inlined. */
1319 cgraph_function_possibly_inlined_p (tree decl)
1321 if (!cgraph_global_info_ready)
1322 return !DECL_UNINLINABLE (decl);
1323 return DECL_POSSIBLY_INLINED (decl);
1326 /* Create clone of E in the node N represented by CALL_EXPR the callgraph. */
1327 struct cgraph_edge *
1328 cgraph_clone_edge (struct cgraph_edge *e, struct cgraph_node *n,
1329 gimple call_stmt, gcov_type count_scale, int freq_scale,
1330 int loop_nest, bool update_original)
1332 struct cgraph_edge *new_edge;
1333 gcov_type count = e->count * count_scale / REG_BR_PROB_BASE;
1334 gcov_type freq = e->frequency * (gcov_type) freq_scale / CGRAPH_FREQ_BASE;
1336 if (freq > CGRAPH_FREQ_MAX)
1337 freq = CGRAPH_FREQ_MAX;
1338 new_edge = cgraph_create_edge (n, e->callee, call_stmt, count, freq,
1339 e->loop_nest + loop_nest);
1341 new_edge->inline_failed = e->inline_failed;
1342 new_edge->indirect_call = e->indirect_call;
1343 if (update_original)
1345 e->count -= new_edge->count;
1349 cgraph_call_edge_duplication_hooks (e, new_edge);
1353 /* Create node representing clone of N executed COUNT times. Decrease
1354 the execution counts from original node too.
1356 When UPDATE_ORIGINAL is true, the counts are subtracted from the original
1357 function's profile to reflect the fact that part of execution is handled
1359 struct cgraph_node *
1360 cgraph_clone_node (struct cgraph_node *n, gcov_type count, int freq,
1361 int loop_nest, bool update_original)
1363 struct cgraph_node *new_node = cgraph_create_node ();
1364 struct cgraph_edge *e;
1365 gcov_type count_scale;
1367 new_node->decl = n->decl;
1368 new_node->origin = n->origin;
1369 if (new_node->origin)
1371 new_node->next_nested = new_node->origin->nested;
1372 new_node->origin->nested = new_node;
1374 new_node->analyzed = n->analyzed;
1375 new_node->local = n->local;
1376 new_node->global = n->global;
1377 new_node->rtl = n->rtl;
1378 new_node->count = count;
1381 if (new_node->count > n->count)
1382 count_scale = REG_BR_PROB_BASE;
1384 count_scale = new_node->count * REG_BR_PROB_BASE / n->count;
1388 if (update_original)
1395 for (e = n->callees;e; e=e->next_callee)
1396 cgraph_clone_edge (e, new_node, e->call_stmt, count_scale, freq, loop_nest,
1399 new_node->next_clone = n->next_clone;
1400 new_node->prev_clone = n;
1401 n->next_clone = new_node;
1402 if (new_node->next_clone)
1403 new_node->next_clone->prev_clone = new_node;
1405 cgraph_call_node_duplication_hooks (n, new_node);
1409 /* NODE is no longer nested function; update cgraph accordingly. */
1411 cgraph_unnest_node (struct cgraph_node *node)
1413 struct cgraph_node **node2 = &node->origin->nested;
1414 gcc_assert (node->origin);
1416 while (*node2 != node)
1417 node2 = &(*node2)->next_nested;
1418 *node2 = node->next_nested;
1419 node->origin = NULL;
1422 /* Return function availability. See cgraph.h for description of individual
1425 cgraph_function_body_availability (struct cgraph_node *node)
1427 enum availability avail;
1428 gcc_assert (cgraph_function_flags_ready);
1429 if (!node->analyzed)
1430 avail = AVAIL_NOT_AVAILABLE;
1431 else if (node->local.local)
1432 avail = AVAIL_LOCAL;
1433 else if (!node->local.externally_visible)
1434 avail = AVAIL_AVAILABLE;
1435 /* Inline functions are safe to be analyzed even if their sybol can
1436 be overwritten at runtime. It is not meaningful to enfore any sane
1437 behaviour on replacing inline function by different body. */
1438 else if (DECL_DECLARED_INLINE_P (node->decl))
1439 avail = AVAIL_AVAILABLE;
1441 /* If the function can be overwritten, return OVERWRITABLE. Take
1442 care at least of two notable extensions - the COMDAT functions
1443 used to share template instantiations in C++ (this is symmetric
1444 to code cp_cannot_inline_tree_fn and probably shall be shared and
1445 the inlinability hooks completely eliminated).
1447 ??? Does the C++ one definition rule allow us to always return
1448 AVAIL_AVAILABLE here? That would be good reason to preserve this
1451 else if (DECL_REPLACEABLE_P (node->decl) && !DECL_EXTERNAL (node->decl))
1452 avail = AVAIL_OVERWRITABLE;
1453 else avail = AVAIL_AVAILABLE;
1458 /* Add the function FNDECL to the call graph.
1459 Unlike cgraph_finalize_function, this function is intended to be used
1460 by middle end and allows insertion of new function at arbitrary point
1461 of compilation. The function can be either in high, low or SSA form
1464 The function is assumed to be reachable and have address taken (so no
1465 API breaking optimizations are performed on it).
1467 Main work done by this function is to enqueue the function for later
1468 processing to avoid need the passes to be re-entrant. */
1471 cgraph_add_new_function (tree fndecl, bool lowered)
1473 struct cgraph_node *node;
1474 switch (cgraph_state)
1476 case CGRAPH_STATE_CONSTRUCTION:
1477 /* Just enqueue function to be processed at nearest occurrence. */
1478 node = cgraph_node (fndecl);
1479 node->next_needed = cgraph_new_nodes;
1481 node->lowered = true;
1482 cgraph_new_nodes = node;
1485 case CGRAPH_STATE_IPA:
1486 case CGRAPH_STATE_IPA_SSA:
1487 case CGRAPH_STATE_EXPANSION:
1488 /* Bring the function into finalized state and enqueue for later
1489 analyzing and compilation. */
1490 node = cgraph_node (fndecl);
1491 node->local.local = false;
1492 node->local.finalized = true;
1493 node->reachable = node->needed = true;
1494 if (!lowered && cgraph_state == CGRAPH_STATE_EXPANSION)
1496 push_cfun (DECL_STRUCT_FUNCTION (fndecl));
1497 current_function_decl = fndecl;
1498 gimple_register_cfg_hooks ();
1499 tree_lowering_passes (fndecl);
1500 bitmap_obstack_initialize (NULL);
1501 if (!gimple_in_ssa_p (DECL_STRUCT_FUNCTION (fndecl)))
1502 execute_pass_list (pass_early_local_passes.pass.sub);
1503 bitmap_obstack_release (NULL);
1505 current_function_decl = NULL;
1510 node->lowered = true;
1511 node->next_needed = cgraph_new_nodes;
1512 cgraph_new_nodes = node;
1515 case CGRAPH_STATE_FINISHED:
1516 /* At the very end of compilation we have to do all the work up
1518 push_cfun (DECL_STRUCT_FUNCTION (fndecl));
1519 current_function_decl = fndecl;
1520 gimple_register_cfg_hooks ();
1522 tree_lowering_passes (fndecl);
1523 bitmap_obstack_initialize (NULL);
1524 if (!gimple_in_ssa_p (DECL_STRUCT_FUNCTION (fndecl)))
1525 execute_pass_list (pass_early_local_passes.pass.sub);
1526 bitmap_obstack_release (NULL);
1527 tree_rest_of_compilation (fndecl);
1529 current_function_decl = NULL;
1534 #include "gt-cgraph.h"