* cgraph.h (cgraph_decide_inlining_incrementally): Kill.
[official-gcc.git] / gcc / cgraphunit.c
blob5a0b9a99c499db0c293cd5d7a2ef132063d9ffbb
1 /* Callgraph based interprocedural optimizations.
2 Copyright (C) 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
3 Contributed by Jan Hubicka
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
10 version.
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 for more details.
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING. If not, write to the Free
19 Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
20 02110-1301, USA. */
22 /* This module implements main driver of compilation process as well as
23 few basic interprocedural optimizers.
25 The main scope of this file is to act as an interface in between
26 tree based frontends and the backend (and middle end)
28 The front-end is supposed to use following functionality:
30 - cgraph_finalize_function
32 This function is called once front-end has parsed whole body of function
33 and it is certain that the function body nor the declaration will change.
35 (There is one exception needed for implementing GCC extern inline
36 function.)
38 - varpool_finalize_variable
40 This function has same behavior as the above but is used for static
41 variables.
43 - cgraph_finalize_compilation_unit
45 This function is called once (source level) compilation unit is finalized
46 and it will no longer change.
48 In the unit-at-a-time the call-graph construction and local function
49 analysis takes place here. Bodies of unreachable functions are released
50 to conserve memory usage.
52 The function can be called multiple times when multiple source level
53 compilation units are combined (such as in C frontend)
55 - cgraph_optimize
57 In this unit-at-a-time compilation the intra procedural analysis takes
58 place here. In particular the static functions whose address is never
59 taken are marked as local. Backend can then use this information to
60 modify calling conventions, do better inlining or similar optimizations.
62 - cgraph_mark_needed_node
63 - varpool_mark_needed_node
65 When function or variable is referenced by some hidden way the call-graph
66 data structure must be updated accordingly by this function.
67 There should be little need to call this function and all the references
68 should be made explicit to cgraph code. At present these functions are
69 used by C++ frontend to explicitly mark the keyed methods.
71 - analyze_expr callback
73 This function is responsible for lowering tree nodes not understood by
74 generic code into understandable ones or alternatively marking
75 callgraph and varpool nodes referenced by the as needed.
77 ??? On the tree-ssa genericizing should take place here and we will avoid
78 need for these hooks (replacing them by genericizing hook)
80 - expand_function callback
82 This function is used to expand function and pass it into RTL back-end.
83 Front-end should not make any assumptions about when this function can be
84 called. In particular cgraph_assemble_pending_functions,
85 varpool_assemble_pending_variables, cgraph_finalize_function,
86 varpool_finalize_function, cgraph_optimize can cause arbitrarily
87 previously finalized functions to be expanded.
89 We implement two compilation modes.
91 - unit-at-a-time: In this mode analyzing of all functions is deferred
92 to cgraph_finalize_compilation_unit and expansion into cgraph_optimize.
94 In cgraph_finalize_compilation_unit the reachable functions are
95 analyzed. During analysis the call-graph edges from reachable
96 functions are constructed and their destinations are marked as
97 reachable. References to functions and variables are discovered too
98 and variables found to be needed output to the assembly file. Via
99 mark_referenced call in assemble_variable functions referenced by
100 static variables are noticed too.
102 The intra-procedural information is produced and its existence
103 indicated by global_info_ready. Once this flag is set it is impossible
104 to change function from !reachable to reachable and thus
105 assemble_variable no longer call mark_referenced.
107 Finally the call-graph is topologically sorted and all reachable functions
108 that has not been completely inlined or are not external are output.
110 ??? It is possible that reference to function or variable is optimized
111 out. We can not deal with this nicely because topological order is not
112 suitable for it. For tree-ssa we may consider another pass doing
113 optimization and re-discovering reachable functions.
115 ??? Reorganize code so variables are output very last and only if they
116 really has been referenced by produced code, so we catch more cases
117 where reference has been optimized out.
119 - non-unit-at-a-time
121 All functions are variables are output as early as possible to conserve
122 memory consumption. This may or may not result in less memory used but
123 it is still needed for some legacy code that rely on particular ordering
124 of things output from the compiler.
126 Varpool data structures are not used and variables are output directly.
128 Functions are output early using call of
129 cgraph_assemble_pending_function from cgraph_finalize_function. The
130 decision on whether function is needed is made more conservative so
131 uninlininable static functions are needed too. During the call-graph
132 construction the edge destinations are not marked as reachable and it
133 is completely relied upn assemble_variable to mark them. */
136 #include "config.h"
137 #include "system.h"
138 #include "coretypes.h"
139 #include "tm.h"
140 #include "tree.h"
141 #include "rtl.h"
142 #include "tree-flow.h"
143 #include "tree-inline.h"
144 #include "langhooks.h"
145 #include "pointer-set.h"
146 #include "toplev.h"
147 #include "flags.h"
148 #include "ggc.h"
149 #include "debug.h"
150 #include "target.h"
151 #include "cgraph.h"
152 #include "diagnostic.h"
153 #include "timevar.h"
154 #include "params.h"
155 #include "fibheap.h"
156 #include "c-common.h"
157 #include "intl.h"
158 #include "function.h"
159 #include "ipa-prop.h"
160 #include "tree-gimple.h"
161 #include "tree-pass.h"
162 #include "output.h"
164 static void cgraph_expand_all_functions (void);
165 static void cgraph_mark_functions_to_output (void);
166 static void cgraph_expand_function (struct cgraph_node *);
167 static void cgraph_output_pending_asms (void);
169 static FILE *cgraph_dump_file;
171 /* Determine if function DECL is needed. That is, visible to something
172 either outside this translation unit, something magic in the system
173 configury, or (if not doing unit-at-a-time) to something we havn't
174 seen yet. */
176 static bool
177 decide_is_function_needed (struct cgraph_node *node, tree decl)
179 tree origin;
180 if (MAIN_NAME_P (DECL_NAME (decl))
181 && TREE_PUBLIC (decl))
183 node->local.externally_visible = true;
184 return true;
187 /* If the user told us it is used, then it must be so. */
188 if (node->local.externally_visible)
189 return true;
191 if (!flag_unit_at_a_time && lookup_attribute ("used", DECL_ATTRIBUTES (decl)))
192 return true;
194 /* ??? If the assembler name is set by hand, it is possible to assemble
195 the name later after finalizing the function and the fact is noticed
196 in assemble_name then. This is arguably a bug. */
197 if (DECL_ASSEMBLER_NAME_SET_P (decl)
198 && TREE_SYMBOL_REFERENCED (DECL_ASSEMBLER_NAME (decl)))
199 return true;
201 /* If we decided it was needed before, but at the time we didn't have
202 the body of the function available, then it's still needed. We have
203 to go back and re-check its dependencies now. */
204 if (node->needed)
205 return true;
207 /* Externally visible functions must be output. The exception is
208 COMDAT functions that must be output only when they are needed.
210 When not optimizing, also output the static functions. (see
211 PR24561), but don't do so for always_inline functions, functions
212 declared inline and nested functions. These was optimized out
213 in the original implementation and it is unclear whether we want
214 to change the behavior here. */
215 if (((TREE_PUBLIC (decl)
216 || (!optimize && !node->local.disregard_inline_limits
217 && !DECL_DECLARED_INLINE_P (decl)
218 && !node->origin))
219 && !flag_whole_program)
220 && !DECL_COMDAT (decl) && !DECL_EXTERNAL (decl))
221 return true;
223 /* Constructors and destructors are reachable from the runtime by
224 some mechanism. */
225 if (DECL_STATIC_CONSTRUCTOR (decl) || DECL_STATIC_DESTRUCTOR (decl))
226 return true;
228 if (flag_unit_at_a_time)
229 return false;
231 /* If not doing unit at a time, then we'll only defer this function
232 if its marked for inlining. Otherwise we want to emit it now. */
234 /* "extern inline" functions are never output locally. */
235 if (DECL_EXTERNAL (decl))
236 return false;
237 /* Nested functions of extern inline function shall not be emit unless
238 we inlined the origin. */
239 for (origin = decl_function_context (decl); origin;
240 origin = decl_function_context (origin))
241 if (DECL_EXTERNAL (origin))
242 return false;
243 /* We want to emit COMDAT functions only when absolutely necessary. */
244 if (DECL_COMDAT (decl))
245 return false;
246 if (!DECL_INLINE (decl)
247 || (!node->local.disregard_inline_limits
248 /* When declared inline, defer even the uninlinable functions.
249 This allows them to be eliminated when unused. */
250 && !DECL_DECLARED_INLINE_P (decl)
251 && (!node->local.inlinable || !cgraph_default_inline_p (node, NULL))))
252 return true;
254 return false;
257 /* Process CGRAPH_NEW_FUNCTIONS and perform actions necessary to add these
258 functions into callgraph in a way so they look like ordinary reachable
259 functions inserted into callgraph already at construction time. */
261 bool
262 cgraph_process_new_functions (void)
264 bool output = false;
265 tree fndecl;
266 struct cgraph_node *node;
268 /* Note that this queue may grow as its being processed, as the new
269 functions may generate new ones. */
270 while (cgraph_new_nodes)
272 node = cgraph_new_nodes;
273 fndecl = node->decl;
274 cgraph_new_nodes = cgraph_new_nodes->next_needed;
275 switch (cgraph_state)
277 case CGRAPH_STATE_CONSTRUCTION:
278 /* At construction time we just need to finalize function and move
279 it into reachable functions list. */
281 node->next_needed = NULL;
282 node->needed = node->reachable = false;
283 cgraph_finalize_function (fndecl, false);
284 cgraph_mark_reachable_node (node);
285 output = true;
286 break;
288 case CGRAPH_STATE_IPA:
289 case CGRAPH_STATE_IPA_SSA:
290 /* When IPA optimization already started, do all essential
291 transformations that has been already performed on the whole
292 cgraph but not on this function. */
294 tree_register_cfg_hooks ();
295 if (!node->analyzed)
296 cgraph_analyze_function (node);
297 push_cfun (DECL_STRUCT_FUNCTION (fndecl));
298 current_function_decl = fndecl;
299 node->local.inlinable = tree_inlinable_function_p (fndecl);
300 node->local.self_insns = estimate_num_insns (fndecl);
301 node->local.disregard_inline_limits
302 = lang_hooks.tree_inlining.disregard_inline_limits (fndecl);
303 /* Inlining characteristics are maintained by the
304 cgraph_mark_inline. */
305 node->global.insns = node->local.self_insns;
306 if (flag_really_no_inline && !node->local.disregard_inline_limits)
307 node->local.inlinable = 0;
308 if ((cgraph_state == CGRAPH_STATE_IPA_SSA
309 && !gimple_in_ssa_p (DECL_STRUCT_FUNCTION (fndecl)))
310 /* When not optimizing, be sure we run early local passes anyway
311 to expand OMP. */
312 || !optimize)
313 execute_pass_list (pass_early_local_passes.sub);
314 free_dominance_info (CDI_POST_DOMINATORS);
315 free_dominance_info (CDI_DOMINATORS);
316 pop_cfun ();
317 current_function_decl = NULL;
318 break;
320 case CGRAPH_STATE_EXPANSION:
321 /* Functions created during expansion shall be compiled
322 directly. */
323 node->output = 0;
324 cgraph_expand_function (node);
325 break;
327 default:
328 gcc_unreachable ();
329 break;
332 return output;
335 /* When not doing unit-at-a-time, output all functions enqueued.
336 Return true when such a functions were found. */
338 static bool
339 cgraph_assemble_pending_functions (void)
341 bool output = false;
343 if (flag_unit_at_a_time)
344 return false;
346 cgraph_output_pending_asms ();
348 while (cgraph_nodes_queue)
350 struct cgraph_node *n = cgraph_nodes_queue;
352 cgraph_nodes_queue = cgraph_nodes_queue->next_needed;
353 n->next_needed = NULL;
354 if (!n->global.inlined_to
355 && !n->alias
356 && !DECL_EXTERNAL (n->decl))
358 cgraph_expand_function (n);
359 output = true;
361 output |= cgraph_process_new_functions ();
364 return output;
368 /* As an GCC extension we allow redefinition of the function. The
369 semantics when both copies of bodies differ is not well defined.
370 We replace the old body with new body so in unit at a time mode
371 we always use new body, while in normal mode we may end up with
372 old body inlined into some functions and new body expanded and
373 inlined in others.
375 ??? It may make more sense to use one body for inlining and other
376 body for expanding the function but this is difficult to do. */
378 static void
379 cgraph_reset_node (struct cgraph_node *node)
381 /* If node->output is set, then this is a unit-at-a-time compilation
382 and we have already begun whole-unit analysis. This is *not*
383 testing for whether we've already emitted the function. That
384 case can be sort-of legitimately seen with real function
385 redefinition errors. I would argue that the front end should
386 never present us with such a case, but don't enforce that for now. */
387 gcc_assert (!node->output);
389 /* Reset our data structures so we can analyze the function again. */
390 memset (&node->local, 0, sizeof (node->local));
391 memset (&node->global, 0, sizeof (node->global));
392 memset (&node->rtl, 0, sizeof (node->rtl));
393 node->analyzed = false;
394 node->local.redefined_extern_inline = true;
395 node->local.finalized = false;
397 if (!flag_unit_at_a_time)
399 struct cgraph_node *n, *next;
401 for (n = cgraph_nodes; n; n = next)
403 next = n->next;
404 if (n->global.inlined_to == node)
405 cgraph_remove_node (n);
409 cgraph_node_remove_callees (node);
411 /* We may need to re-queue the node for assembling in case
412 we already proceeded it and ignored as not needed. */
413 if (node->reachable && !flag_unit_at_a_time)
415 struct cgraph_node *n;
417 for (n = cgraph_nodes_queue; n; n = n->next_needed)
418 if (n == node)
419 break;
420 if (!n)
421 node->reachable = 0;
425 static void
426 cgraph_lower_function (struct cgraph_node *node)
428 if (node->lowered)
429 return;
430 tree_lowering_passes (node->decl);
431 node->lowered = true;
434 /* DECL has been parsed. Take it, queue it, compile it at the whim of the
435 logic in effect. If NESTED is true, then our caller cannot stand to have
436 the garbage collector run at the moment. We would need to either create
437 a new GC context, or just not compile right now. */
439 void
440 cgraph_finalize_function (tree decl, bool nested)
442 struct cgraph_node *node = cgraph_node (decl);
444 if (node->local.finalized)
445 cgraph_reset_node (node);
447 notice_global_symbol (decl);
448 node->decl = decl;
449 node->local.finalized = true;
450 node->lowered = DECL_STRUCT_FUNCTION (decl)->cfg != NULL;
451 if (node->nested)
452 lower_nested_functions (decl);
453 gcc_assert (!node->nested);
455 /* If not unit at a time, then we need to create the call graph
456 now, so that called functions can be queued and emitted now. */
457 if (!flag_unit_at_a_time)
458 cgraph_analyze_function (node);
460 if (decide_is_function_needed (node, decl))
461 cgraph_mark_needed_node (node);
463 /* Since we reclaim unreachable nodes at the end of every language
464 level unit, we need to be conservative about possible entry points
465 there. */
466 if ((TREE_PUBLIC (decl) && !DECL_COMDAT (decl) && !DECL_EXTERNAL (decl)))
467 cgraph_mark_reachable_node (node);
469 /* If not unit at a time, go ahead and emit everything we've found
470 to be reachable at this time. */
471 if (!nested)
473 if (!cgraph_assemble_pending_functions ())
474 ggc_collect ();
477 /* If we've not yet emitted decl, tell the debug info about it. */
478 if (!TREE_ASM_WRITTEN (decl))
479 (*debug_hooks->deferred_inline_function) (decl);
481 /* Possibly warn about unused parameters. */
482 if (warn_unused_parameter)
483 do_warn_unused_parameter (decl);
486 /* Verify cgraph nodes of given cgraph node. */
487 void
488 verify_cgraph_node (struct cgraph_node *node)
490 struct cgraph_edge *e;
491 struct cgraph_node *main_clone;
492 struct function *this_cfun = DECL_STRUCT_FUNCTION (node->decl);
493 basic_block this_block;
494 block_stmt_iterator bsi;
495 bool error_found = false;
497 if (errorcount || sorrycount)
498 return;
500 timevar_push (TV_CGRAPH_VERIFY);
501 for (e = node->callees; e; e = e->next_callee)
502 if (e->aux)
504 error ("aux field set for edge %s->%s",
505 cgraph_node_name (e->caller), cgraph_node_name (e->callee));
506 error_found = true;
508 if (node->count < 0)
510 error ("Execution count is negative");
511 error_found = true;
513 for (e = node->callers; e; e = e->next_caller)
515 if (e->count < 0)
517 error ("caller edge count is negative");
518 error_found = true;
520 if (!e->inline_failed)
522 if (node->global.inlined_to
523 != (e->caller->global.inlined_to
524 ? e->caller->global.inlined_to : e->caller))
526 error ("inlined_to pointer is wrong");
527 error_found = true;
529 if (node->callers->next_caller)
531 error ("multiple inline callers");
532 error_found = true;
535 else
536 if (node->global.inlined_to)
538 error ("inlined_to pointer set for noninline callers");
539 error_found = true;
542 if (!node->callers && node->global.inlined_to)
544 error ("inlined_to pointer is set but no predecessors found");
545 error_found = true;
547 if (node->global.inlined_to == node)
549 error ("inlined_to pointer refers to itself");
550 error_found = true;
553 for (main_clone = cgraph_node (node->decl); main_clone;
554 main_clone = main_clone->next_clone)
555 if (main_clone == node)
556 break;
557 if (!cgraph_node (node->decl))
559 error ("node not found in cgraph_hash");
560 error_found = true;
563 if (node->analyzed
564 && DECL_SAVED_TREE (node->decl) && !TREE_ASM_WRITTEN (node->decl)
565 && (!DECL_EXTERNAL (node->decl) || node->global.inlined_to))
567 if (this_cfun->cfg)
569 /* The nodes we're interested in are never shared, so walk
570 the tree ignoring duplicates. */
571 struct pointer_set_t *visited_nodes = pointer_set_create ();
572 /* Reach the trees by walking over the CFG, and note the
573 enclosing basic-blocks in the call edges. */
574 FOR_EACH_BB_FN (this_block, this_cfun)
575 for (bsi = bsi_start (this_block); !bsi_end_p (bsi); bsi_next (&bsi))
577 tree stmt = bsi_stmt (bsi);
578 tree call = get_call_expr_in (stmt);
579 tree decl;
580 if (call && (decl = get_callee_fndecl (call)))
582 struct cgraph_edge *e = cgraph_edge (node, stmt);
583 if (e)
585 if (e->aux)
587 error ("shared call_stmt:");
588 debug_generic_stmt (stmt);
589 error_found = true;
591 if (e->callee->decl != cgraph_node (decl)->decl
592 && e->inline_failed)
594 error ("edge points to wrong declaration:");
595 debug_tree (e->callee->decl);
596 fprintf (stderr," Instead of:");
597 debug_tree (decl);
599 e->aux = (void *)1;
601 else
603 error ("missing callgraph edge for call stmt:");
604 debug_generic_stmt (stmt);
605 error_found = true;
609 pointer_set_destroy (visited_nodes);
611 else
612 /* No CFG available?! */
613 gcc_unreachable ();
615 for (e = node->callees; e; e = e->next_callee)
617 if (!e->aux)
619 error ("edge %s->%s has no corresponding call_stmt",
620 cgraph_node_name (e->caller),
621 cgraph_node_name (e->callee));
622 debug_generic_stmt (e->call_stmt);
623 error_found = true;
625 e->aux = 0;
628 if (error_found)
630 dump_cgraph_node (stderr, node);
631 internal_error ("verify_cgraph_node failed");
633 timevar_pop (TV_CGRAPH_VERIFY);
636 /* Verify whole cgraph structure. */
637 void
638 verify_cgraph (void)
640 struct cgraph_node *node;
642 if (sorrycount || errorcount)
643 return;
645 for (node = cgraph_nodes; node; node = node->next)
646 verify_cgraph_node (node);
649 /* Output all asm statements we have stored up to be output. */
651 static void
652 cgraph_output_pending_asms (void)
654 struct cgraph_asm_node *can;
656 if (errorcount || sorrycount)
657 return;
659 for (can = cgraph_asm_nodes; can; can = can->next)
660 assemble_asm (can->asm_str);
661 cgraph_asm_nodes = NULL;
664 /* Analyze the function scheduled to be output. */
665 void
666 cgraph_analyze_function (struct cgraph_node *node)
668 tree decl = node->decl;
670 current_function_decl = decl;
671 push_cfun (DECL_STRUCT_FUNCTION (decl));
672 cgraph_lower_function (node);
674 node->local.estimated_self_stack_size = estimated_stack_frame_size ();
675 node->global.estimated_stack_size = node->local.estimated_self_stack_size;
676 node->global.stack_frame_offset = 0;
677 node->local.inlinable = tree_inlinable_function_p (decl);
678 if (!flag_unit_at_a_time)
679 node->local.self_insns = estimate_num_insns (decl);
680 if (node->local.inlinable)
681 node->local.disregard_inline_limits
682 = lang_hooks.tree_inlining.disregard_inline_limits (decl);
683 if (flag_really_no_inline && !node->local.disregard_inline_limits)
684 node->local.inlinable = 0;
685 /* Inlining characteristics are maintained by the cgraph_mark_inline. */
686 node->global.insns = node->local.self_insns;
687 if (!flag_unit_at_a_time)
689 bitmap_obstack_initialize (NULL);
690 tree_register_cfg_hooks ();
691 execute_pass_list (pass_early_local_passes.sub);
692 free_dominance_info (CDI_POST_DOMINATORS);
693 free_dominance_info (CDI_DOMINATORS);
694 bitmap_obstack_release (NULL);
697 node->analyzed = true;
698 pop_cfun ();
699 current_function_decl = NULL;
702 /* Look for externally_visible and used attributes and mark cgraph nodes
703 accordingly.
705 We cannot mark the nodes at the point the attributes are processed (in
706 handle_*_attribute) because the copy of the declarations available at that
707 point may not be canonical. For example, in:
709 void f();
710 void f() __attribute__((used));
712 the declaration we see in handle_used_attribute will be the second
713 declaration -- but the front end will subsequently merge that declaration
714 with the original declaration and discard the second declaration.
716 Furthermore, we can't mark these nodes in cgraph_finalize_function because:
718 void f() {}
719 void f() __attribute__((externally_visible));
721 is valid.
723 So, we walk the nodes at the end of the translation unit, applying the
724 attributes at that point. */
726 static void
727 process_function_and_variable_attributes (struct cgraph_node *first,
728 struct varpool_node *first_var)
730 struct cgraph_node *node;
731 struct varpool_node *vnode;
733 for (node = cgraph_nodes; node != first; node = node->next)
735 tree decl = node->decl;
736 if (lookup_attribute ("used", DECL_ATTRIBUTES (decl)))
738 mark_decl_referenced (decl);
739 if (node->local.finalized)
740 cgraph_mark_needed_node (node);
742 if (lookup_attribute ("externally_visible", DECL_ATTRIBUTES (decl)))
744 if (! TREE_PUBLIC (node->decl))
745 warning (OPT_Wattributes,
746 "%J%<externally_visible%> attribute have effect only on public objects",
747 node->decl);
748 else
750 if (node->local.finalized)
751 cgraph_mark_needed_node (node);
752 node->local.externally_visible = true;
756 for (vnode = varpool_nodes; vnode != first_var; vnode = vnode->next)
758 tree decl = vnode->decl;
759 if (lookup_attribute ("used", DECL_ATTRIBUTES (decl)))
761 mark_decl_referenced (decl);
762 if (vnode->finalized)
763 varpool_mark_needed_node (vnode);
765 if (lookup_attribute ("externally_visible", DECL_ATTRIBUTES (decl)))
767 if (! TREE_PUBLIC (vnode->decl))
768 warning (OPT_Wattributes,
769 "%J%<externally_visible%> attribute have effect only on public objects",
770 vnode->decl);
771 else
773 if (vnode->finalized)
774 varpool_mark_needed_node (vnode);
775 vnode->externally_visible = true;
781 /* Process CGRAPH_NODES_NEEDED queue, analyze each function (and transitively
782 each reachable functions) and build cgraph.
783 The function can be called multiple times after inserting new nodes
784 into beggining of queue. Just the new part of queue is re-scanned then. */
786 static void
787 cgraph_analyze_functions (void)
789 /* Keep track of already processed nodes when called multiple times for
790 intermodule optimization. */
791 static struct cgraph_node *first_analyzed;
792 struct cgraph_node *first_processed = first_analyzed;
793 static struct varpool_node *first_analyzed_var;
794 struct cgraph_node *node, *next;
796 process_function_and_variable_attributes (first_processed,
797 first_analyzed_var);
798 first_processed = cgraph_nodes;
799 first_analyzed_var = varpool_nodes;
800 varpool_analyze_pending_decls ();
801 if (cgraph_dump_file)
803 fprintf (cgraph_dump_file, "Initial entry points:");
804 for (node = cgraph_nodes; node != first_analyzed; node = node->next)
805 if (node->needed && DECL_SAVED_TREE (node->decl))
806 fprintf (cgraph_dump_file, " %s", cgraph_node_name (node));
807 fprintf (cgraph_dump_file, "\n");
809 cgraph_process_new_functions ();
811 /* Propagate reachability flag and lower representation of all reachable
812 functions. In the future, lowering will introduce new functions and
813 new entry points on the way (by template instantiation and virtual
814 method table generation for instance). */
815 while (cgraph_nodes_queue)
817 struct cgraph_edge *edge;
818 tree decl = cgraph_nodes_queue->decl;
820 node = cgraph_nodes_queue;
821 cgraph_nodes_queue = cgraph_nodes_queue->next_needed;
822 node->next_needed = NULL;
824 /* ??? It is possible to create extern inline function and later using
825 weak alias attribute to kill its body. See
826 gcc.c-torture/compile/20011119-1.c */
827 if (!DECL_SAVED_TREE (decl))
829 cgraph_reset_node (node);
830 continue;
833 gcc_assert (!node->analyzed && node->reachable);
834 gcc_assert (DECL_SAVED_TREE (decl));
836 cgraph_analyze_function (node);
838 for (edge = node->callees; edge; edge = edge->next_callee)
839 if (!edge->callee->reachable)
840 cgraph_mark_reachable_node (edge->callee);
842 /* We finalize local static variables during constructing callgraph
843 edges. Process their attributes too. */
844 process_function_and_variable_attributes (first_processed,
845 first_analyzed_var);
846 first_processed = cgraph_nodes;
847 first_analyzed_var = varpool_nodes;
848 varpool_analyze_pending_decls ();
849 cgraph_process_new_functions ();
852 /* Collect entry points to the unit. */
853 if (cgraph_dump_file)
855 fprintf (cgraph_dump_file, "Unit entry points:");
856 for (node = cgraph_nodes; node != first_analyzed; node = node->next)
857 if (node->needed && DECL_SAVED_TREE (node->decl))
858 fprintf (cgraph_dump_file, " %s", cgraph_node_name (node));
859 fprintf (cgraph_dump_file, "\n\nInitial ");
860 dump_cgraph (cgraph_dump_file);
863 if (cgraph_dump_file)
864 fprintf (cgraph_dump_file, "\nReclaiming functions:");
866 for (node = cgraph_nodes; node != first_analyzed; node = next)
868 tree decl = node->decl;
869 next = node->next;
871 if (node->local.finalized && !DECL_SAVED_TREE (decl))
872 cgraph_reset_node (node);
874 if (!node->reachable && DECL_SAVED_TREE (decl))
876 if (cgraph_dump_file)
877 fprintf (cgraph_dump_file, " %s", cgraph_node_name (node));
878 cgraph_remove_node (node);
879 continue;
881 else
882 node->next_needed = NULL;
883 gcc_assert (!node->local.finalized || DECL_SAVED_TREE (decl));
884 gcc_assert (node->analyzed == node->local.finalized);
886 if (cgraph_dump_file)
888 fprintf (cgraph_dump_file, "\n\nReclaimed ");
889 dump_cgraph (cgraph_dump_file);
891 first_analyzed = cgraph_nodes;
892 ggc_collect ();
895 /* Analyze the whole compilation unit once it is parsed completely. */
897 void
898 cgraph_finalize_compilation_unit (void)
900 if (errorcount || sorrycount)
901 return;
903 finish_aliases_1 ();
905 if (!flag_unit_at_a_time)
907 cgraph_output_pending_asms ();
908 cgraph_assemble_pending_functions ();
909 varpool_output_debug_info ();
910 return;
913 if (!quiet_flag)
915 fprintf (stderr, "\nAnalyzing compilation unit\n");
916 fflush (stderr);
919 timevar_push (TV_CGRAPH);
920 cgraph_analyze_functions ();
921 timevar_pop (TV_CGRAPH);
923 /* Figure out what functions we want to assemble. */
925 static void
926 cgraph_mark_functions_to_output (void)
928 struct cgraph_node *node;
930 for (node = cgraph_nodes; node; node = node->next)
932 tree decl = node->decl;
933 struct cgraph_edge *e;
935 gcc_assert (!node->output);
937 for (e = node->callers; e; e = e->next_caller)
938 if (e->inline_failed)
939 break;
941 /* We need to output all local functions that are used and not
942 always inlined, as well as those that are reachable from
943 outside the current compilation unit. */
944 if (DECL_SAVED_TREE (decl)
945 && !node->global.inlined_to
946 && (node->needed
947 || (e && node->reachable))
948 && !TREE_ASM_WRITTEN (decl)
949 && !DECL_EXTERNAL (decl))
950 node->output = 1;
951 else
953 /* We should've reclaimed all functions that are not needed. */
954 #ifdef ENABLE_CHECKING
955 if (!node->global.inlined_to && DECL_SAVED_TREE (decl)
956 && !DECL_EXTERNAL (decl))
958 dump_cgraph_node (stderr, node);
959 internal_error ("failed to reclaim unneeded function");
961 #endif
962 gcc_assert (node->global.inlined_to || !DECL_SAVED_TREE (decl)
963 || DECL_EXTERNAL (decl));
970 /* Expand function specified by NODE. */
972 static void
973 cgraph_expand_function (struct cgraph_node *node)
975 tree decl = node->decl;
977 /* We ought to not compile any inline clones. */
978 gcc_assert (!node->global.inlined_to);
980 if (flag_unit_at_a_time)
981 announce_function (decl);
983 gcc_assert (node->lowered);
985 /* Generate RTL for the body of DECL. */
986 lang_hooks.callgraph.expand_function (decl);
988 /* Make sure that BE didn't give up on compiling. */
989 /* ??? Can happen with nested function of extern inline. */
990 gcc_assert (TREE_ASM_WRITTEN (node->decl));
992 current_function_decl = NULL;
993 if (!cgraph_preserve_function_body_p (node->decl))
995 cgraph_release_function_body (node);
996 /* Eliminate all call edges. This is important so the call_expr no longer
997 points to the dead function body. */
998 cgraph_node_remove_callees (node);
1001 cgraph_function_flags_ready = true;
1004 /* Return true when CALLER_DECL should be inlined into CALLEE_DECL. */
1006 bool
1007 cgraph_inline_p (struct cgraph_edge *e, const char **reason)
1009 *reason = e->inline_failed;
1010 return !e->inline_failed;
1015 /* Expand all functions that must be output.
1017 Attempt to topologically sort the nodes so function is output when
1018 all called functions are already assembled to allow data to be
1019 propagated across the callgraph. Use a stack to get smaller distance
1020 between a function and its callees (later we may choose to use a more
1021 sophisticated algorithm for function reordering; we will likely want
1022 to use subsections to make the output functions appear in top-down
1023 order). */
1025 static void
1026 cgraph_expand_all_functions (void)
1028 struct cgraph_node *node;
1029 struct cgraph_node **order = XCNEWVEC (struct cgraph_node *, cgraph_n_nodes);
1030 int order_pos = 0, new_order_pos = 0;
1031 int i;
1033 order_pos = cgraph_postorder (order);
1034 gcc_assert (order_pos == cgraph_n_nodes);
1036 /* Garbage collector may remove inline clones we eliminate during
1037 optimization. So we must be sure to not reference them. */
1038 for (i = 0; i < order_pos; i++)
1039 if (order[i]->output)
1040 order[new_order_pos++] = order[i];
1042 for (i = new_order_pos - 1; i >= 0; i--)
1044 node = order[i];
1045 if (node->output)
1047 gcc_assert (node->reachable);
1048 node->output = 0;
1049 cgraph_expand_function (node);
1052 cgraph_process_new_functions ();
1054 free (order);
1058 /* This is used to sort the node types by the cgraph order number. */
1060 struct cgraph_order_sort
1062 enum { ORDER_UNDEFINED = 0, ORDER_FUNCTION, ORDER_VAR, ORDER_ASM } kind;
1063 union
1065 struct cgraph_node *f;
1066 struct varpool_node *v;
1067 struct cgraph_asm_node *a;
1068 } u;
1071 /* Output all functions, variables, and asm statements in the order
1072 according to their order fields, which is the order in which they
1073 appeared in the file. This implements -fno-toplevel-reorder. In
1074 this mode we may output functions and variables which don't really
1075 need to be output. */
1077 static void
1078 cgraph_output_in_order (void)
1080 int max;
1081 size_t size;
1082 struct cgraph_order_sort *nodes;
1083 int i;
1084 struct cgraph_node *pf;
1085 struct varpool_node *pv;
1086 struct cgraph_asm_node *pa;
1088 max = cgraph_order;
1089 size = max * sizeof (struct cgraph_order_sort);
1090 nodes = (struct cgraph_order_sort *) alloca (size);
1091 memset (nodes, 0, size);
1093 varpool_analyze_pending_decls ();
1095 for (pf = cgraph_nodes; pf; pf = pf->next)
1097 if (pf->output)
1099 i = pf->order;
1100 gcc_assert (nodes[i].kind == ORDER_UNDEFINED);
1101 nodes[i].kind = ORDER_FUNCTION;
1102 nodes[i].u.f = pf;
1106 for (pv = varpool_nodes_queue; pv; pv = pv->next_needed)
1108 i = pv->order;
1109 gcc_assert (nodes[i].kind == ORDER_UNDEFINED);
1110 nodes[i].kind = ORDER_VAR;
1111 nodes[i].u.v = pv;
1114 for (pa = cgraph_asm_nodes; pa; pa = pa->next)
1116 i = pa->order;
1117 gcc_assert (nodes[i].kind == ORDER_UNDEFINED);
1118 nodes[i].kind = ORDER_ASM;
1119 nodes[i].u.a = pa;
1122 for (i = 0; i < max; ++i)
1124 switch (nodes[i].kind)
1126 case ORDER_FUNCTION:
1127 nodes[i].u.f->output = 0;
1128 cgraph_expand_function (nodes[i].u.f);
1129 break;
1131 case ORDER_VAR:
1132 varpool_assemble_decl (nodes[i].u.v);
1133 break;
1135 case ORDER_ASM:
1136 assemble_asm (nodes[i].u.a->asm_str);
1137 break;
1139 case ORDER_UNDEFINED:
1140 break;
1142 default:
1143 gcc_unreachable ();
1147 cgraph_asm_nodes = NULL;
1150 /* Return true when function body of DECL still needs to be kept around
1151 for later re-use. */
1152 bool
1153 cgraph_preserve_function_body_p (tree decl)
1155 struct cgraph_node *node;
1156 if (!cgraph_global_info_ready)
1157 return (flag_really_no_inline
1158 ? lang_hooks.tree_inlining.disregard_inline_limits (decl)
1159 : DECL_INLINE (decl));
1160 /* Look if there is any clone around. */
1161 for (node = cgraph_node (decl); node; node = node->next_clone)
1162 if (node->global.inlined_to)
1163 return true;
1164 return false;
1167 static void
1168 ipa_passes (void)
1170 cfun = NULL;
1171 current_function_decl = NULL;
1172 tree_register_cfg_hooks ();
1173 bitmap_obstack_initialize (NULL);
1174 execute_ipa_pass_list (all_ipa_passes);
1175 bitmap_obstack_release (NULL);
1178 /* Perform simple optimizations based on callgraph. */
1180 void
1181 cgraph_optimize (void)
1183 if (errorcount || sorrycount)
1184 return;
1186 #ifdef ENABLE_CHECKING
1187 verify_cgraph ();
1188 #endif
1189 if (!flag_unit_at_a_time)
1191 cgraph_assemble_pending_functions ();
1192 cgraph_process_new_functions ();
1193 cgraph_state = CGRAPH_STATE_FINISHED;
1194 cgraph_output_pending_asms ();
1195 varpool_assemble_pending_decls ();
1196 varpool_output_debug_info ();
1197 return;
1200 /* Frontend may output common variables after the unit has been finalized.
1201 It is safe to deal with them here as they are always zero initialized. */
1202 varpool_analyze_pending_decls ();
1203 cgraph_analyze_functions ();
1205 timevar_push (TV_CGRAPHOPT);
1206 if (pre_ipa_mem_report)
1208 fprintf (stderr, "Memory consumption before IPA\n");
1209 dump_memory_report (false);
1211 if (!quiet_flag)
1212 fprintf (stderr, "Performing interprocedural optimizations\n");
1213 cgraph_state = CGRAPH_STATE_IPA;
1215 /* Don't run the IPA passes if there was any error or sorry messages. */
1216 if (errorcount == 0 && sorrycount == 0)
1217 ipa_passes ();
1219 /* This pass remove bodies of extern inline functions we never inlined.
1220 Do this later so other IPA passes see what is really going on. */
1221 cgraph_remove_unreachable_nodes (false, dump_file);
1222 cgraph_global_info_ready = true;
1223 if (cgraph_dump_file)
1225 fprintf (cgraph_dump_file, "Optimized ");
1226 dump_cgraph (cgraph_dump_file);
1227 dump_varpool (cgraph_dump_file);
1229 if (post_ipa_mem_report)
1231 fprintf (stderr, "Memory consumption after IPA\n");
1232 dump_memory_report (false);
1234 timevar_pop (TV_CGRAPHOPT);
1236 /* Output everything. */
1237 if (!quiet_flag)
1238 fprintf (stderr, "Assembling functions:\n");
1239 #ifdef ENABLE_CHECKING
1240 verify_cgraph ();
1241 #endif
1243 cgraph_mark_functions_to_output ();
1245 cgraph_state = CGRAPH_STATE_EXPANSION;
1246 if (!flag_toplevel_reorder)
1247 cgraph_output_in_order ();
1248 else
1250 cgraph_output_pending_asms ();
1252 cgraph_expand_all_functions ();
1253 varpool_remove_unreferenced_decls ();
1255 varpool_assemble_pending_decls ();
1256 varpool_output_debug_info ();
1258 cgraph_process_new_functions ();
1259 cgraph_state = CGRAPH_STATE_FINISHED;
1261 if (cgraph_dump_file)
1263 fprintf (cgraph_dump_file, "\nFinal ");
1264 dump_cgraph (cgraph_dump_file);
1266 #ifdef ENABLE_CHECKING
1267 verify_cgraph ();
1268 /* Double check that all inline clones are gone and that all
1269 function bodies have been released from memory. */
1270 if (flag_unit_at_a_time
1271 && !(sorrycount || errorcount))
1273 struct cgraph_node *node;
1274 bool error_found = false;
1276 for (node = cgraph_nodes; node; node = node->next)
1277 if (node->analyzed
1278 && (node->global.inlined_to
1279 || DECL_SAVED_TREE (node->decl)))
1281 error_found = true;
1282 dump_cgraph_node (stderr, node);
1284 if (error_found)
1285 internal_error ("nodes with no released memory found");
1287 #endif
1289 /* Generate and emit a static constructor or destructor. WHICH must be
1290 one of 'I' or 'D'. BODY should be a STATEMENT_LIST containing
1291 GENERIC statements. */
1293 void
1294 cgraph_build_static_cdtor (char which, tree body, int priority)
1296 static int counter = 0;
1297 char which_buf[16];
1298 tree decl, name, resdecl;
1300 sprintf (which_buf, "%c_%d", which, counter++);
1301 name = get_file_function_name (which_buf);
1303 decl = build_decl (FUNCTION_DECL, name,
1304 build_function_type (void_type_node, void_list_node));
1305 current_function_decl = decl;
1307 resdecl = build_decl (RESULT_DECL, NULL_TREE, void_type_node);
1308 DECL_ARTIFICIAL (resdecl) = 1;
1309 DECL_IGNORED_P (resdecl) = 1;
1310 DECL_RESULT (decl) = resdecl;
1312 allocate_struct_function (decl);
1314 TREE_STATIC (decl) = 1;
1315 TREE_USED (decl) = 1;
1316 DECL_ARTIFICIAL (decl) = 1;
1317 DECL_IGNORED_P (decl) = 1;
1318 DECL_NO_INSTRUMENT_FUNCTION_ENTRY_EXIT (decl) = 1;
1319 DECL_SAVED_TREE (decl) = body;
1320 TREE_PUBLIC (decl) = ! targetm.have_ctors_dtors;
1321 DECL_UNINLINABLE (decl) = 1;
1323 DECL_INITIAL (decl) = make_node (BLOCK);
1324 TREE_USED (DECL_INITIAL (decl)) = 1;
1326 DECL_SOURCE_LOCATION (decl) = input_location;
1327 cfun->function_end_locus = input_location;
1329 switch (which)
1331 case 'I':
1332 DECL_STATIC_CONSTRUCTOR (decl) = 1;
1333 break;
1334 case 'D':
1335 DECL_STATIC_DESTRUCTOR (decl) = 1;
1336 break;
1337 default:
1338 gcc_unreachable ();
1341 gimplify_function_tree (decl);
1343 cgraph_add_new_function (decl, false);
1344 cgraph_mark_needed_node (cgraph_node (decl));
1346 if (targetm.have_ctors_dtors)
1348 void (*fn) (rtx, int);
1350 if (which == 'I')
1351 fn = targetm.asm_out.constructor;
1352 else
1353 fn = targetm.asm_out.destructor;
1354 fn (XEXP (DECL_RTL (decl), 0), priority);
1358 void
1359 init_cgraph (void)
1361 cgraph_dump_file = dump_begin (TDI_cgraph, NULL);
1364 /* The edges representing the callers of the NEW_VERSION node were
1365 fixed by cgraph_function_versioning (), now the call_expr in their
1366 respective tree code should be updated to call the NEW_VERSION. */
1368 static void
1369 update_call_expr (struct cgraph_node *new_version)
1371 struct cgraph_edge *e;
1373 gcc_assert (new_version);
1374 for (e = new_version->callers; e; e = e->next_caller)
1375 /* Update the call expr on the edges
1376 to call the new version. */
1377 TREE_OPERAND (TREE_OPERAND (get_call_expr_in (e->call_stmt), 0), 0) = new_version->decl;
1381 /* Create a new cgraph node which is the new version of
1382 OLD_VERSION node. REDIRECT_CALLERS holds the callers
1383 edges which should be redirected to point to
1384 NEW_VERSION. ALL the callees edges of OLD_VERSION
1385 are cloned to the new version node. Return the new
1386 version node. */
1388 static struct cgraph_node *
1389 cgraph_copy_node_for_versioning (struct cgraph_node *old_version,
1390 tree new_decl,
1391 VEC(cgraph_edge_p,heap) *redirect_callers)
1393 struct cgraph_node *new_version;
1394 struct cgraph_edge *e, *new_e;
1395 struct cgraph_edge *next_callee;
1396 unsigned i;
1398 gcc_assert (old_version);
1400 new_version = cgraph_node (new_decl);
1402 new_version->analyzed = true;
1403 new_version->local = old_version->local;
1404 new_version->global = old_version->global;
1405 new_version->rtl = new_version->rtl;
1406 new_version->reachable = true;
1407 new_version->count = old_version->count;
1409 /* Clone the old node callees. Recursive calls are
1410 also cloned. */
1411 for (e = old_version->callees;e; e=e->next_callee)
1413 new_e = cgraph_clone_edge (e, new_version, e->call_stmt, 0, e->loop_nest, true);
1414 new_e->count = e->count;
1416 /* Fix recursive calls.
1417 If OLD_VERSION has a recursive call after the
1418 previous edge cloning, the new version will have an edge
1419 pointing to the old version, which is wrong;
1420 Redirect it to point to the new version. */
1421 for (e = new_version->callees ; e; e = next_callee)
1423 next_callee = e->next_callee;
1424 if (e->callee == old_version)
1425 cgraph_redirect_edge_callee (e, new_version);
1427 if (!next_callee)
1428 break;
1430 for (i = 0; VEC_iterate (cgraph_edge_p, redirect_callers, i, e); i++)
1432 /* Redirect calls to the old version node to point to its new
1433 version. */
1434 cgraph_redirect_edge_callee (e, new_version);
1437 return new_version;
1440 /* Perform function versioning.
1441 Function versioning includes copying of the tree and
1442 a callgraph update (creating a new cgraph node and updating
1443 its callees and callers).
1445 REDIRECT_CALLERS varray includes the edges to be redirected
1446 to the new version.
1448 TREE_MAP is a mapping of tree nodes we want to replace with
1449 new ones (according to results of prior analysis).
1450 OLD_VERSION_NODE is the node that is versioned.
1451 It returns the new version's cgraph node. */
1453 struct cgraph_node *
1454 cgraph_function_versioning (struct cgraph_node *old_version_node,
1455 VEC(cgraph_edge_p,heap) *redirect_callers,
1456 varray_type tree_map)
1458 tree old_decl = old_version_node->decl;
1459 struct cgraph_node *new_version_node = NULL;
1460 tree new_decl;
1462 if (!tree_versionable_function_p (old_decl))
1463 return NULL;
1465 /* Make a new FUNCTION_DECL tree node for the
1466 new version. */
1467 new_decl = copy_node (old_decl);
1469 /* Create the new version's call-graph node.
1470 and update the edges of the new node. */
1471 new_version_node =
1472 cgraph_copy_node_for_versioning (old_version_node, new_decl,
1473 redirect_callers);
1475 /* Copy the OLD_VERSION_NODE function tree to the new version. */
1476 tree_function_versioning (old_decl, new_decl, tree_map, false);
1477 /* Update the call_expr on the edges to call the new version node. */
1478 update_call_expr (new_version_node);
1480 /* Update the new version's properties.
1481 Make The new version visible only within this translation unit.
1482 ??? We cannot use COMDAT linkage because there is no
1483 ABI support for this. */
1484 DECL_EXTERNAL (new_version_node->decl) = 0;
1485 DECL_ONE_ONLY (new_version_node->decl) = 0;
1486 TREE_PUBLIC (new_version_node->decl) = 0;
1487 DECL_COMDAT (new_version_node->decl) = 0;
1488 new_version_node->local.externally_visible = 0;
1489 new_version_node->local.local = 1;
1490 new_version_node->lowered = true;
1491 return new_version_node;
1494 /* Produce separate function body for inline clones so the offline copy can be
1495 modified without affecting them. */
1496 struct cgraph_node *
1497 save_inline_function_body (struct cgraph_node *node)
1499 struct cgraph_node *first_clone;
1501 gcc_assert (node == cgraph_node (node->decl));
1503 cgraph_lower_function (node);
1505 /* In non-unit-at-a-time we construct full fledged clone we never output to
1506 assembly file. This clone is pointed out by inline_decl of original function
1507 and inlining infrastructure knows how to deal with this. */
1508 if (!flag_unit_at_a_time)
1510 struct cgraph_edge *e;
1512 first_clone = cgraph_clone_node (node, node->count, 0, false);
1513 first_clone->needed = 0;
1514 first_clone->reachable = 1;
1515 /* Recursively clone all bodies. */
1516 for (e = first_clone->callees; e; e = e->next_callee)
1517 if (!e->inline_failed)
1518 cgraph_clone_inlined_nodes (e, true, false);
1520 else
1521 first_clone = node->next_clone;
1523 first_clone->decl = copy_node (node->decl);
1524 node->next_clone = NULL;
1525 if (!flag_unit_at_a_time)
1526 node->inline_decl = first_clone->decl;
1527 first_clone->prev_clone = NULL;
1528 cgraph_insert_node_to_hashtable (first_clone);
1529 gcc_assert (first_clone == cgraph_node (first_clone->decl));
1531 /* Copy the OLD_VERSION_NODE function tree to the new version. */
1532 tree_function_versioning (node->decl, first_clone->decl, NULL, true);
1534 DECL_EXTERNAL (first_clone->decl) = 0;
1535 DECL_ONE_ONLY (first_clone->decl) = 0;
1536 TREE_PUBLIC (first_clone->decl) = 0;
1537 DECL_COMDAT (first_clone->decl) = 0;
1539 for (node = first_clone->next_clone; node; node = node->next_clone)
1540 node->decl = first_clone->decl;
1541 #ifdef ENABLE_CHECKING
1542 verify_cgraph_node (first_clone);
1543 #endif
1544 return first_clone;