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 if (e->caller->call_site_hash)
646 slot = htab_find_slot_with_hash (e->caller->call_site_hash,
649 (e->call_stmt), INSERT);
655 /* Create edge from CALLER to CALLEE in the cgraph. */
658 cgraph_create_edge (struct cgraph_node *caller, struct cgraph_node *callee,
659 gimple call_stmt, gcov_type count, int freq, int nest)
661 struct cgraph_edge *edge;
663 #ifdef ENABLE_CHECKING
664 /* This is rather pricely check possibly trigerring construction of call stmt
666 gcc_assert (!cgraph_edge (caller, call_stmt));
669 gcc_assert (is_gimple_call (call_stmt));
674 free_edges = NEXT_FREE_EDGE (edge);
678 edge = GGC_NEW (struct cgraph_edge);
679 edge->uid = cgraph_edge_max_uid++;
682 if (!callee->analyzed)
683 edge->inline_failed = N_("function body not available");
684 else if (callee->local.redefined_extern_inline)
685 edge->inline_failed = N_("redefined extern inline functions are not "
686 "considered for inlining");
687 else if (callee->local.inlinable)
688 edge->inline_failed = N_("function not considered for inlining");
690 edge->inline_failed = N_("function not inlinable");
694 edge->caller = caller;
695 edge->callee = callee;
696 edge->call_stmt = call_stmt;
697 edge->prev_caller = NULL;
698 edge->next_caller = callee->callers;
700 callee->callers->prev_caller = edge;
701 edge->prev_callee = NULL;
702 edge->next_callee = caller->callees;
704 caller->callees->prev_callee = edge;
705 caller->callees = edge;
706 callee->callers = edge;
708 gcc_assert (count >= 0);
709 edge->frequency = freq;
710 gcc_assert (freq >= 0);
711 gcc_assert (freq <= CGRAPH_FREQ_MAX);
712 edge->loop_nest = nest;
713 edge->indirect_call = 0;
714 if (caller->call_site_hash)
717 slot = htab_find_slot_with_hash (caller->call_site_hash,
728 /* Remove the edge E from the list of the callers of the callee. */
731 cgraph_edge_remove_callee (struct cgraph_edge *e)
734 e->prev_caller->next_caller = e->next_caller;
736 e->next_caller->prev_caller = e->prev_caller;
738 e->callee->callers = e->next_caller;
741 /* Remove the edge E from the list of the callees of the caller. */
744 cgraph_edge_remove_caller (struct cgraph_edge *e)
747 e->prev_callee->next_callee = e->next_callee;
749 e->next_callee->prev_callee = e->prev_callee;
751 e->caller->callees = e->next_callee;
752 if (e->caller->call_site_hash)
753 htab_remove_elt_with_hash (e->caller->call_site_hash,
755 htab_hash_pointer (e->call_stmt));
758 /* Put the edge onto the free list. */
761 cgraph_free_edge (struct cgraph_edge *e)
765 /* Clear out the edge so we do not dangle pointers. */
766 memset (e, 0, sizeof (*e));
768 NEXT_FREE_EDGE (e) = free_edges;
772 /* Remove the edge E in the cgraph. */
775 cgraph_remove_edge (struct cgraph_edge *e)
777 /* Call all edge removal hooks. */
778 cgraph_call_edge_removal_hooks (e);
780 /* Remove from callers list of the callee. */
781 cgraph_edge_remove_callee (e);
783 /* Remove from callees list of the callers. */
784 cgraph_edge_remove_caller (e);
786 /* Put the edge onto the free list. */
787 cgraph_free_edge (e);
790 /* Redirect callee of E to N. The function does not update underlying
794 cgraph_redirect_edge_callee (struct cgraph_edge *e, struct cgraph_node *n)
796 /* Remove from callers list of the current callee. */
797 cgraph_edge_remove_callee (e);
799 /* Insert to callers list of the new callee. */
800 e->prev_caller = NULL;
802 n->callers->prev_caller = e;
803 e->next_caller = n->callers;
809 /* Update or remove the corresponding cgraph edge if a GIMPLE_CALL
810 OLD_STMT changed into NEW_STMT. */
813 cgraph_update_edges_for_call_stmt (gimple old_stmt, gimple new_stmt)
815 tree new_call = (is_gimple_call (new_stmt)) ? gimple_call_fn (new_stmt) : 0;
816 tree old_call = (is_gimple_call (old_stmt)) ? gimple_call_fn (old_stmt) : 0;
817 struct cgraph_node *node = cgraph_node (cfun->decl);
819 if (old_call != new_call)
821 struct cgraph_edge *e = cgraph_edge (node, old_stmt);
822 struct cgraph_edge *ne = NULL;
827 gcov_type count = e->count;
828 int frequency = e->frequency;
829 int loop_nest = e->loop_nest;
831 cgraph_remove_edge (e);
834 new_decl = gimple_call_fndecl (new_stmt);
837 ne = cgraph_create_edge (node, cgraph_node (new_decl),
838 new_stmt, count, frequency,
840 gcc_assert (ne->inline_failed);
845 else if (old_stmt != new_stmt)
847 struct cgraph_edge *e = cgraph_edge (node, old_stmt);
850 cgraph_set_call_stmt (e, new_stmt);
855 /* Remove all callees from the node. */
858 cgraph_node_remove_callees (struct cgraph_node *node)
860 struct cgraph_edge *e, *f;
862 /* It is sufficient to remove the edges from the lists of callers of
863 the callees. The callee list of the node can be zapped with one
865 for (e = node->callees; e; e = f)
868 cgraph_call_edge_removal_hooks (e);
869 cgraph_edge_remove_callee (e);
870 cgraph_free_edge (e);
872 node->callees = NULL;
873 if (node->call_site_hash)
875 htab_delete (node->call_site_hash);
876 node->call_site_hash = NULL;
880 /* Remove all callers from the node. */
883 cgraph_node_remove_callers (struct cgraph_node *node)
885 struct cgraph_edge *e, *f;
887 /* It is sufficient to remove the edges from the lists of callees of
888 the callers. The caller list of the node can be zapped with one
890 for (e = node->callers; e; e = f)
893 cgraph_call_edge_removal_hooks (e);
894 cgraph_edge_remove_caller (e);
895 cgraph_free_edge (e);
897 node->callers = NULL;
900 /* Release memory used to represent body of function NODE. */
903 cgraph_release_function_body (struct cgraph_node *node)
905 if (DECL_STRUCT_FUNCTION (node->decl))
907 tree old_decl = current_function_decl;
908 push_cfun (DECL_STRUCT_FUNCTION (node->decl));
911 current_function_decl = node->decl;
913 delete_tree_cfg_annotations ();
915 current_function_decl = old_decl;
919 gcc_assert (dom_computed[0] == DOM_NONE);
920 gcc_assert (dom_computed[1] == DOM_NONE);
923 if (cfun->value_histograms)
925 gcc_assert (!current_loops);
927 gimple_set_body (node->decl, NULL);
928 VEC_free (ipa_opt_pass, heap,
929 DECL_STRUCT_FUNCTION (node->decl)->ipa_transforms_to_apply);
930 /* Struct function hangs a lot of data that would leak if we didn't
931 removed all pointers to it. */
932 ggc_free (DECL_STRUCT_FUNCTION (node->decl));
933 DECL_STRUCT_FUNCTION (node->decl) = NULL;
935 DECL_SAVED_TREE (node->decl) = NULL;
936 /* If the node is abstract and needed, then do not clear DECL_INITIAL
937 of its associated function function declaration because it's
938 needed to emit debug info later. */
939 if (!node->abstract_and_needed)
940 DECL_INITIAL (node->decl) = error_mark_node;
943 /* Remove the node from cgraph. */
946 cgraph_remove_node (struct cgraph_node *node)
949 bool kill_body = false;
950 struct cgraph_node *n;
953 cgraph_call_node_removal_hooks (node);
954 cgraph_node_remove_callers (node);
955 cgraph_node_remove_callees (node);
957 /* Incremental inlining access removed nodes stored in the postorder list.
959 node->needed = node->reachable = false;
960 for (n = node->nested; n; n = n->next_nested)
965 struct cgraph_node **node2 = &node->origin->nested;
967 while (*node2 != node)
968 node2 = &(*node2)->next_nested;
969 *node2 = node->next_nested;
972 node->previous->next = node->next;
974 cgraph_nodes = node->next;
976 node->next->previous = node->previous;
978 node->previous = NULL;
979 slot = htab_find_slot (cgraph_hash, node, NO_INSERT);
982 if (node->next_clone)
984 struct cgraph_node *new_node = node->next_clone;
987 node->next_clone->prev_clone = NULL;
991 htab_clear_slot (cgraph_hash, slot);
997 node->prev_clone->next_clone = node->next_clone;
998 if (node->next_clone)
999 node->next_clone->prev_clone = node->prev_clone;
1002 /* While all the clones are removed after being proceeded, the function
1003 itself is kept in the cgraph even after it is compiled. Check whether
1004 we are done with this body and reclaim it proactively if this is the case.
1006 if (!kill_body && *slot)
1008 struct cgraph_node *n = (struct cgraph_node *) *slot;
1009 if (!n->next_clone && !n->global.inlined_to
1010 && (cgraph_global_info_ready
1011 && (TREE_ASM_WRITTEN (n->decl) || DECL_EXTERNAL (n->decl))))
1014 if (assembler_name_hash)
1016 tree name = DECL_ASSEMBLER_NAME (node->decl);
1017 slot = htab_find_slot_with_hash (assembler_name_hash, name,
1018 decl_assembler_name_hash (name),
1020 /* Inline clones are not hashed. */
1021 if (slot && *slot == node)
1022 htab_clear_slot (assembler_name_hash, slot);
1026 cgraph_release_function_body (node);
1028 if (node->call_site_hash)
1030 htab_delete (node->call_site_hash);
1031 node->call_site_hash = NULL;
1035 /* Clear out the node to NULL all pointers and add the node to the free
1037 memset (node, 0, sizeof(*node));
1039 NEXT_FREE_NODE (node) = free_nodes;
1043 /* Notify finalize_compilation_unit that given node is reachable. */
1046 cgraph_mark_reachable_node (struct cgraph_node *node)
1048 if (!node->reachable && node->local.finalized)
1050 notice_global_symbol (node->decl);
1051 node->reachable = 1;
1052 gcc_assert (!cgraph_global_info_ready);
1054 node->next_needed = cgraph_nodes_queue;
1055 cgraph_nodes_queue = node;
1059 /* Likewise indicate that a node is needed, i.e. reachable via some
1063 cgraph_mark_needed_node (struct cgraph_node *node)
1066 cgraph_mark_reachable_node (node);
1069 /* Return local info for the compiled function. */
1071 struct cgraph_local_info *
1072 cgraph_local_info (tree decl)
1074 struct cgraph_node *node;
1076 gcc_assert (TREE_CODE (decl) == FUNCTION_DECL);
1077 node = cgraph_node (decl);
1078 return &node->local;
1081 /* Return local info for the compiled function. */
1083 struct cgraph_global_info *
1084 cgraph_global_info (tree decl)
1086 struct cgraph_node *node;
1088 gcc_assert (TREE_CODE (decl) == FUNCTION_DECL && cgraph_global_info_ready);
1089 node = cgraph_node (decl);
1090 return &node->global;
1093 /* Return local info for the compiled function. */
1095 struct cgraph_rtl_info *
1096 cgraph_rtl_info (tree decl)
1098 struct cgraph_node *node;
1100 gcc_assert (TREE_CODE (decl) == FUNCTION_DECL);
1101 node = cgraph_node (decl);
1102 if (decl != current_function_decl
1103 && !TREE_ASM_WRITTEN (node->decl))
1108 /* Return name of the node used in debug output. */
1110 cgraph_node_name (struct cgraph_node *node)
1112 return lang_hooks.decl_printable_name (node->decl, 2);
1115 /* Names used to print out the availability enum. */
1116 const char * const cgraph_availability_names[] =
1117 {"unset", "not_available", "overwritable", "available", "local"};
1120 /* Dump call graph node NODE to file F. */
1123 dump_cgraph_node (FILE *f, struct cgraph_node *node)
1125 struct cgraph_edge *edge;
1126 fprintf (f, "%s/%i(%i):", cgraph_node_name (node), node->uid, node->pid);
1127 if (node->global.inlined_to)
1128 fprintf (f, " (inline copy in %s/%i)",
1129 cgraph_node_name (node->global.inlined_to),
1130 node->global.inlined_to->uid);
1131 if (cgraph_function_flags_ready)
1132 fprintf (f, " availability:%s",
1133 cgraph_availability_names [cgraph_function_body_availability (node)]);
1135 fprintf (f, " executed "HOST_WIDEST_INT_PRINT_DEC"x",
1136 (HOST_WIDEST_INT)node->count);
1137 if (node->local.inline_summary.self_insns)
1138 fprintf (f, " %i insns", node->local.inline_summary.self_insns);
1139 if (node->global.insns && node->global.insns
1140 != node->local.inline_summary.self_insns)
1141 fprintf (f, " (%i after inlining)", node->global.insns);
1142 if (node->local.inline_summary.estimated_self_stack_size)
1143 fprintf (f, " %i bytes stack usage", (int)node->local.inline_summary.estimated_self_stack_size);
1144 if (node->global.estimated_stack_size != node->local.inline_summary.estimated_self_stack_size)
1145 fprintf (f, " %i bytes after inlining", (int)node->global.estimated_stack_size);
1147 fprintf (f, " nested in: %s", cgraph_node_name (node->origin));
1149 fprintf (f, " needed");
1150 else if (node->reachable)
1151 fprintf (f, " reachable");
1152 if (gimple_has_body_p (node->decl))
1153 fprintf (f, " body");
1155 fprintf (f, " output");
1156 if (node->local.local)
1157 fprintf (f, " local");
1158 if (node->local.externally_visible)
1159 fprintf (f, " externally_visible");
1160 if (node->local.finalized)
1161 fprintf (f, " finalized");
1162 if (node->local.disregard_inline_limits)
1163 fprintf (f, " always_inline");
1164 else if (node->local.inlinable)
1165 fprintf (f, " inlinable");
1166 if (node->local.redefined_extern_inline)
1167 fprintf (f, " redefined_extern_inline");
1168 if (TREE_ASM_WRITTEN (node->decl))
1169 fprintf (f, " asm_written");
1171 fprintf (f, "\n called by: ");
1172 for (edge = node->callers; edge; edge = edge->next_caller)
1174 fprintf (f, "%s/%i ", cgraph_node_name (edge->caller),
1177 fprintf (f, "("HOST_WIDEST_INT_PRINT_DEC"x) ",
1178 (HOST_WIDEST_INT)edge->count);
1179 if (edge->frequency)
1180 fprintf (f, "(%.2f per call) ",
1181 edge->frequency / (double)CGRAPH_FREQ_BASE);
1182 if (!edge->inline_failed)
1183 fprintf(f, "(inlined) ");
1184 if (edge->indirect_call)
1185 fprintf(f, "(indirect) ");
1188 fprintf (f, "\n calls: ");
1189 for (edge = node->callees; edge; edge = edge->next_callee)
1191 fprintf (f, "%s/%i ", cgraph_node_name (edge->callee),
1193 if (!edge->inline_failed)
1194 fprintf(f, "(inlined) ");
1195 if (edge->indirect_call)
1196 fprintf(f, "(indirect) ");
1198 fprintf (f, "("HOST_WIDEST_INT_PRINT_DEC"x) ",
1199 (HOST_WIDEST_INT)edge->count);
1200 if (edge->frequency)
1201 fprintf (f, "(%.2f per call) ",
1202 edge->frequency / (double)CGRAPH_FREQ_BASE);
1203 if (edge->loop_nest)
1204 fprintf (f, "(nested in %i loops) ", edge->loop_nest);
1210 /* Dump call graph node NODE to stderr. */
1213 debug_cgraph_node (struct cgraph_node *node)
1215 dump_cgraph_node (stderr, node);
1219 /* Dump the callgraph to file F. */
1222 dump_cgraph (FILE *f)
1224 struct cgraph_node *node;
1226 fprintf (f, "callgraph:\n\n");
1227 for (node = cgraph_nodes; node; node = node->next)
1228 dump_cgraph_node (f, node);
1232 /* Dump the call graph to stderr. */
1237 dump_cgraph (stderr);
1241 /* Set the DECL_ASSEMBLER_NAME and update cgraph hashtables. */
1244 change_decl_assembler_name (tree decl, tree name)
1246 gcc_assert (!assembler_name_hash);
1247 if (!DECL_ASSEMBLER_NAME_SET_P (decl))
1249 SET_DECL_ASSEMBLER_NAME (decl, name);
1252 if (name == DECL_ASSEMBLER_NAME (decl))
1255 if (TREE_SYMBOL_REFERENCED (DECL_ASSEMBLER_NAME (decl))
1256 && DECL_RTL_SET_P (decl))
1257 warning (0, "%D renamed after being referenced in assembly", decl);
1259 SET_DECL_ASSEMBLER_NAME (decl, name);
1262 /* Add a top-level asm statement to the list. */
1264 struct cgraph_asm_node *
1265 cgraph_add_asm_node (tree asm_str)
1267 struct cgraph_asm_node *node;
1269 node = GGC_CNEW (struct cgraph_asm_node);
1270 node->asm_str = asm_str;
1271 node->order = cgraph_order++;
1273 if (cgraph_asm_nodes == NULL)
1274 cgraph_asm_nodes = node;
1276 cgraph_asm_last_node->next = node;
1277 cgraph_asm_last_node = node;
1281 /* Return true when the DECL can possibly be inlined. */
1283 cgraph_function_possibly_inlined_p (tree decl)
1285 if (!cgraph_global_info_ready)
1286 return !DECL_UNINLINABLE (decl);
1287 return DECL_POSSIBLY_INLINED (decl);
1290 /* Create clone of E in the node N represented by CALL_EXPR the callgraph. */
1291 struct cgraph_edge *
1292 cgraph_clone_edge (struct cgraph_edge *e, struct cgraph_node *n,
1293 gimple call_stmt, gcov_type count_scale, int freq_scale,
1294 int loop_nest, bool update_original)
1296 struct cgraph_edge *new_edge;
1297 gcov_type count = e->count * count_scale / REG_BR_PROB_BASE;
1298 gcov_type freq = e->frequency * (gcov_type) freq_scale / CGRAPH_FREQ_BASE;
1300 if (freq > CGRAPH_FREQ_MAX)
1301 freq = CGRAPH_FREQ_MAX;
1302 new_edge = cgraph_create_edge (n, e->callee, call_stmt, count, freq,
1303 e->loop_nest + loop_nest);
1305 new_edge->inline_failed = e->inline_failed;
1306 new_edge->indirect_call = e->indirect_call;
1307 if (update_original)
1309 e->count -= new_edge->count;
1313 cgraph_call_edge_duplication_hooks (e, new_edge);
1317 /* Create node representing clone of N executed COUNT times. Decrease
1318 the execution counts from original node too.
1320 When UPDATE_ORIGINAL is true, the counts are subtracted from the original
1321 function's profile to reflect the fact that part of execution is handled
1323 struct cgraph_node *
1324 cgraph_clone_node (struct cgraph_node *n, gcov_type count, int freq,
1325 int loop_nest, bool update_original)
1327 struct cgraph_node *new_node = cgraph_create_node ();
1328 struct cgraph_edge *e;
1329 gcov_type count_scale;
1331 new_node->decl = n->decl;
1332 new_node->origin = n->origin;
1333 if (new_node->origin)
1335 new_node->next_nested = new_node->origin->nested;
1336 new_node->origin->nested = new_node;
1338 new_node->analyzed = n->analyzed;
1339 new_node->local = n->local;
1340 new_node->global = n->global;
1341 new_node->rtl = n->rtl;
1342 new_node->count = count;
1345 if (new_node->count > n->count)
1346 count_scale = REG_BR_PROB_BASE;
1348 count_scale = new_node->count * REG_BR_PROB_BASE / n->count;
1352 if (update_original)
1359 for (e = n->callees;e; e=e->next_callee)
1360 cgraph_clone_edge (e, new_node, e->call_stmt, count_scale, freq, loop_nest,
1363 new_node->next_clone = n->next_clone;
1364 new_node->prev_clone = n;
1365 n->next_clone = new_node;
1366 if (new_node->next_clone)
1367 new_node->next_clone->prev_clone = new_node;
1369 cgraph_call_node_duplication_hooks (n, new_node);
1373 /* NODE is no longer nested function; update cgraph accordingly. */
1375 cgraph_unnest_node (struct cgraph_node *node)
1377 struct cgraph_node **node2 = &node->origin->nested;
1378 gcc_assert (node->origin);
1380 while (*node2 != node)
1381 node2 = &(*node2)->next_nested;
1382 *node2 = node->next_nested;
1383 node->origin = NULL;
1386 /* Return function availability. See cgraph.h for description of individual
1389 cgraph_function_body_availability (struct cgraph_node *node)
1391 enum availability avail;
1392 gcc_assert (cgraph_function_flags_ready);
1393 if (!node->analyzed)
1394 avail = AVAIL_NOT_AVAILABLE;
1395 else if (node->local.local)
1396 avail = AVAIL_LOCAL;
1397 else if (!node->local.externally_visible)
1398 avail = AVAIL_AVAILABLE;
1399 /* Inline functions are safe to be analyzed even if their sybol can
1400 be overwritten at runtime. It is not meaningful to enfore any sane
1401 behaviour on replacing inline function by different body. */
1402 else if (DECL_DECLARED_INLINE_P (node->decl))
1403 avail = AVAIL_AVAILABLE;
1405 /* If the function can be overwritten, return OVERWRITABLE. Take
1406 care at least of two notable extensions - the COMDAT functions
1407 used to share template instantiations in C++ (this is symmetric
1408 to code cp_cannot_inline_tree_fn and probably shall be shared and
1409 the inlinability hooks completely eliminated).
1411 ??? Does the C++ one definition rule allow us to always return
1412 AVAIL_AVAILABLE here? That would be good reason to preserve this
1415 else if (DECL_REPLACEABLE_P (node->decl) && !DECL_EXTERNAL (node->decl))
1416 avail = AVAIL_OVERWRITABLE;
1417 else avail = AVAIL_AVAILABLE;
1422 /* Add the function FNDECL to the call graph.
1423 Unlike cgraph_finalize_function, this function is intended to be used
1424 by middle end and allows insertion of new function at arbitrary point
1425 of compilation. The function can be either in high, low or SSA form
1428 The function is assumed to be reachable and have address taken (so no
1429 API breaking optimizations are performed on it).
1431 Main work done by this function is to enqueue the function for later
1432 processing to avoid need the passes to be re-entrant. */
1435 cgraph_add_new_function (tree fndecl, bool lowered)
1437 struct cgraph_node *node;
1438 switch (cgraph_state)
1440 case CGRAPH_STATE_CONSTRUCTION:
1441 /* Just enqueue function to be processed at nearest occurrence. */
1442 node = cgraph_node (fndecl);
1443 node->next_needed = cgraph_new_nodes;
1445 node->lowered = true;
1446 cgraph_new_nodes = node;
1449 case CGRAPH_STATE_IPA:
1450 case CGRAPH_STATE_IPA_SSA:
1451 case CGRAPH_STATE_EXPANSION:
1452 /* Bring the function into finalized state and enqueue for later
1453 analyzing and compilation. */
1454 node = cgraph_node (fndecl);
1455 node->local.local = false;
1456 node->local.finalized = true;
1457 node->reachable = node->needed = true;
1458 if (!lowered && cgraph_state == CGRAPH_STATE_EXPANSION)
1460 push_cfun (DECL_STRUCT_FUNCTION (fndecl));
1461 current_function_decl = fndecl;
1462 gimple_register_cfg_hooks ();
1463 tree_lowering_passes (fndecl);
1464 bitmap_obstack_initialize (NULL);
1465 if (!gimple_in_ssa_p (DECL_STRUCT_FUNCTION (fndecl)))
1466 execute_pass_list (pass_early_local_passes.pass.sub);
1467 bitmap_obstack_release (NULL);
1469 current_function_decl = NULL;
1474 node->lowered = true;
1475 node->next_needed = cgraph_new_nodes;
1476 cgraph_new_nodes = node;
1479 case CGRAPH_STATE_FINISHED:
1480 /* At the very end of compilation we have to do all the work up
1482 push_cfun (DECL_STRUCT_FUNCTION (fndecl));
1483 current_function_decl = fndecl;
1484 gimple_register_cfg_hooks ();
1486 tree_lowering_passes (fndecl);
1487 bitmap_obstack_initialize (NULL);
1488 if (!gimple_in_ssa_p (DECL_STRUCT_FUNCTION (fndecl)))
1489 execute_pass_list (pass_early_local_passes.pass.sub);
1490 bitmap_obstack_release (NULL);
1491 tree_rest_of_compilation (fndecl);
1493 current_function_decl = NULL;
1498 #include "gt-cgraph.h"