* tree-ssa-loop-unswitch.c: Include tree-inline.h.
[official-gcc.git] / gcc / cgraphunit.c
blobc4cf9e925805ffa516651e2d8467c7aa559ccabe
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 &eni_inlining_weights);
302 node->local.disregard_inline_limits
303 = lang_hooks.tree_inlining.disregard_inline_limits (fndecl);
304 /* Inlining characteristics are maintained by the
305 cgraph_mark_inline. */
306 node->global.insns = node->local.self_insns;
307 if (flag_really_no_inline && !node->local.disregard_inline_limits)
308 node->local.inlinable = 0;
309 if ((cgraph_state == CGRAPH_STATE_IPA_SSA
310 && !gimple_in_ssa_p (DECL_STRUCT_FUNCTION (fndecl)))
311 /* When not optimizing, be sure we run early local passes anyway
312 to expand OMP. */
313 || !optimize)
314 execute_pass_list (pass_early_local_passes.sub);
315 free_dominance_info (CDI_POST_DOMINATORS);
316 free_dominance_info (CDI_DOMINATORS);
317 pop_cfun ();
318 current_function_decl = NULL;
319 break;
321 case CGRAPH_STATE_EXPANSION:
322 /* Functions created during expansion shall be compiled
323 directly. */
324 node->output = 0;
325 cgraph_expand_function (node);
326 break;
328 default:
329 gcc_unreachable ();
330 break;
333 return output;
336 /* When not doing unit-at-a-time, output all functions enqueued.
337 Return true when such a functions were found. */
339 static bool
340 cgraph_assemble_pending_functions (void)
342 bool output = false;
344 if (flag_unit_at_a_time)
345 return false;
347 cgraph_output_pending_asms ();
349 while (cgraph_nodes_queue)
351 struct cgraph_node *n = cgraph_nodes_queue;
353 cgraph_nodes_queue = cgraph_nodes_queue->next_needed;
354 n->next_needed = NULL;
355 if (!n->global.inlined_to
356 && !n->alias
357 && !DECL_EXTERNAL (n->decl))
359 cgraph_expand_function (n);
360 output = true;
362 output |= cgraph_process_new_functions ();
365 return output;
369 /* As an GCC extension we allow redefinition of the function. The
370 semantics when both copies of bodies differ is not well defined.
371 We replace the old body with new body so in unit at a time mode
372 we always use new body, while in normal mode we may end up with
373 old body inlined into some functions and new body expanded and
374 inlined in others.
376 ??? It may make more sense to use one body for inlining and other
377 body for expanding the function but this is difficult to do. */
379 static void
380 cgraph_reset_node (struct cgraph_node *node)
382 /* If node->output is set, then this is a unit-at-a-time compilation
383 and we have already begun whole-unit analysis. This is *not*
384 testing for whether we've already emitted the function. That
385 case can be sort-of legitimately seen with real function
386 redefinition errors. I would argue that the front end should
387 never present us with such a case, but don't enforce that for now. */
388 gcc_assert (!node->output);
390 /* Reset our data structures so we can analyze the function again. */
391 memset (&node->local, 0, sizeof (node->local));
392 memset (&node->global, 0, sizeof (node->global));
393 memset (&node->rtl, 0, sizeof (node->rtl));
394 node->analyzed = false;
395 node->local.redefined_extern_inline = true;
396 node->local.finalized = false;
398 if (!flag_unit_at_a_time)
400 struct cgraph_node *n, *next;
402 for (n = cgraph_nodes; n; n = next)
404 next = n->next;
405 if (n->global.inlined_to == node)
406 cgraph_remove_node (n);
410 cgraph_node_remove_callees (node);
412 /* We may need to re-queue the node for assembling in case
413 we already proceeded it and ignored as not needed. */
414 if (node->reachable && !flag_unit_at_a_time)
416 struct cgraph_node *n;
418 for (n = cgraph_nodes_queue; n; n = n->next_needed)
419 if (n == node)
420 break;
421 if (!n)
422 node->reachable = 0;
426 static void
427 cgraph_lower_function (struct cgraph_node *node)
429 if (node->lowered)
430 return;
431 tree_lowering_passes (node->decl);
432 node->lowered = true;
435 /* DECL has been parsed. Take it, queue it, compile it at the whim of the
436 logic in effect. If NESTED is true, then our caller cannot stand to have
437 the garbage collector run at the moment. We would need to either create
438 a new GC context, or just not compile right now. */
440 void
441 cgraph_finalize_function (tree decl, bool nested)
443 struct cgraph_node *node = cgraph_node (decl);
445 if (node->local.finalized)
446 cgraph_reset_node (node);
448 node->pid = cgraph_max_pid ++;
449 notice_global_symbol (decl);
450 node->decl = decl;
451 node->local.finalized = true;
452 node->lowered = DECL_STRUCT_FUNCTION (decl)->cfg != NULL;
453 if (node->nested)
454 lower_nested_functions (decl);
455 gcc_assert (!node->nested);
457 /* If not unit at a time, then we need to create the call graph
458 now, so that called functions can be queued and emitted now. */
459 if (!flag_unit_at_a_time)
460 cgraph_analyze_function (node);
462 if (decide_is_function_needed (node, decl))
463 cgraph_mark_needed_node (node);
465 /* Since we reclaim unreachable nodes at the end of every language
466 level unit, we need to be conservative about possible entry points
467 there. */
468 if ((TREE_PUBLIC (decl) && !DECL_COMDAT (decl) && !DECL_EXTERNAL (decl)))
469 cgraph_mark_reachable_node (node);
471 /* If not unit at a time, go ahead and emit everything we've found
472 to be reachable at this time. */
473 if (!nested)
475 if (!cgraph_assemble_pending_functions ())
476 ggc_collect ();
479 /* If we've not yet emitted decl, tell the debug info about it. */
480 if (!TREE_ASM_WRITTEN (decl))
481 (*debug_hooks->deferred_inline_function) (decl);
483 /* Possibly warn about unused parameters. */
484 if (warn_unused_parameter)
485 do_warn_unused_parameter (decl);
488 /* Verify cgraph nodes of given cgraph node. */
489 void
490 verify_cgraph_node (struct cgraph_node *node)
492 struct cgraph_edge *e;
493 struct cgraph_node *main_clone;
494 struct function *this_cfun = DECL_STRUCT_FUNCTION (node->decl);
495 basic_block this_block;
496 block_stmt_iterator bsi;
497 bool error_found = false;
499 if (errorcount || sorrycount)
500 return;
502 timevar_push (TV_CGRAPH_VERIFY);
503 for (e = node->callees; e; e = e->next_callee)
504 if (e->aux)
506 error ("aux field set for edge %s->%s",
507 cgraph_node_name (e->caller), cgraph_node_name (e->callee));
508 error_found = true;
510 if (node->count < 0)
512 error ("Execution count is negative");
513 error_found = true;
515 for (e = node->callers; e; e = e->next_caller)
517 if (e->count < 0)
519 error ("caller edge count is negative");
520 error_found = true;
522 if (!e->inline_failed)
524 if (node->global.inlined_to
525 != (e->caller->global.inlined_to
526 ? e->caller->global.inlined_to : e->caller))
528 error ("inlined_to pointer is wrong");
529 error_found = true;
531 if (node->callers->next_caller)
533 error ("multiple inline callers");
534 error_found = true;
537 else
538 if (node->global.inlined_to)
540 error ("inlined_to pointer set for noninline callers");
541 error_found = true;
544 if (!node->callers && node->global.inlined_to)
546 error ("inlined_to pointer is set but no predecessors found");
547 error_found = true;
549 if (node->global.inlined_to == node)
551 error ("inlined_to pointer refers to itself");
552 error_found = true;
555 for (main_clone = cgraph_node (node->decl); main_clone;
556 main_clone = main_clone->next_clone)
557 if (main_clone == node)
558 break;
559 if (!cgraph_node (node->decl))
561 error ("node not found in cgraph_hash");
562 error_found = true;
565 if (node->analyzed
566 && DECL_SAVED_TREE (node->decl) && !TREE_ASM_WRITTEN (node->decl)
567 && (!DECL_EXTERNAL (node->decl) || node->global.inlined_to))
569 if (this_cfun->cfg)
571 /* The nodes we're interested in are never shared, so walk
572 the tree ignoring duplicates. */
573 struct pointer_set_t *visited_nodes = pointer_set_create ();
574 /* Reach the trees by walking over the CFG, and note the
575 enclosing basic-blocks in the call edges. */
576 FOR_EACH_BB_FN (this_block, this_cfun)
577 for (bsi = bsi_start (this_block); !bsi_end_p (bsi); bsi_next (&bsi))
579 tree stmt = bsi_stmt (bsi);
580 tree call = get_call_expr_in (stmt);
581 tree decl;
582 if (call && (decl = get_callee_fndecl (call)))
584 struct cgraph_edge *e = cgraph_edge (node, stmt);
585 if (e)
587 if (e->aux)
589 error ("shared call_stmt:");
590 debug_generic_stmt (stmt);
591 error_found = true;
593 if (e->callee->decl != cgraph_node (decl)->decl
594 && e->inline_failed)
596 error ("edge points to wrong declaration:");
597 debug_tree (e->callee->decl);
598 fprintf (stderr," Instead of:");
599 debug_tree (decl);
601 e->aux = (void *)1;
603 else
605 error ("missing callgraph edge for call stmt:");
606 debug_generic_stmt (stmt);
607 error_found = true;
611 pointer_set_destroy (visited_nodes);
613 else
614 /* No CFG available?! */
615 gcc_unreachable ();
617 for (e = node->callees; e; e = e->next_callee)
619 if (!e->aux)
621 error ("edge %s->%s has no corresponding call_stmt",
622 cgraph_node_name (e->caller),
623 cgraph_node_name (e->callee));
624 debug_generic_stmt (e->call_stmt);
625 error_found = true;
627 e->aux = 0;
630 if (error_found)
632 dump_cgraph_node (stderr, node);
633 internal_error ("verify_cgraph_node failed");
635 timevar_pop (TV_CGRAPH_VERIFY);
638 /* Verify whole cgraph structure. */
639 void
640 verify_cgraph (void)
642 struct cgraph_node *node;
644 if (sorrycount || errorcount)
645 return;
647 for (node = cgraph_nodes; node; node = node->next)
648 verify_cgraph_node (node);
651 /* Output all asm statements we have stored up to be output. */
653 static void
654 cgraph_output_pending_asms (void)
656 struct cgraph_asm_node *can;
658 if (errorcount || sorrycount)
659 return;
661 for (can = cgraph_asm_nodes; can; can = can->next)
662 assemble_asm (can->asm_str);
663 cgraph_asm_nodes = NULL;
666 /* Analyze the function scheduled to be output. */
667 void
668 cgraph_analyze_function (struct cgraph_node *node)
670 tree decl = node->decl;
672 current_function_decl = decl;
673 push_cfun (DECL_STRUCT_FUNCTION (decl));
674 cgraph_lower_function (node);
676 node->local.estimated_self_stack_size = estimated_stack_frame_size ();
677 node->global.estimated_stack_size = node->local.estimated_self_stack_size;
678 node->global.stack_frame_offset = 0;
679 node->local.inlinable = tree_inlinable_function_p (decl);
680 if (!flag_unit_at_a_time)
681 node->local.self_insns = estimate_num_insns (decl, &eni_inlining_weights);
682 if (node->local.inlinable)
683 node->local.disregard_inline_limits
684 = lang_hooks.tree_inlining.disregard_inline_limits (decl);
685 if (flag_really_no_inline && !node->local.disregard_inline_limits)
686 node->local.inlinable = 0;
687 /* Inlining characteristics are maintained by the cgraph_mark_inline. */
688 node->global.insns = node->local.self_insns;
689 if (!flag_unit_at_a_time)
691 bitmap_obstack_initialize (NULL);
692 tree_register_cfg_hooks ();
693 execute_pass_list (pass_early_local_passes.sub);
694 free_dominance_info (CDI_POST_DOMINATORS);
695 free_dominance_info (CDI_DOMINATORS);
696 bitmap_obstack_release (NULL);
699 node->analyzed = true;
700 pop_cfun ();
701 current_function_decl = NULL;
704 /* Look for externally_visible and used attributes and mark cgraph nodes
705 accordingly.
707 We cannot mark the nodes at the point the attributes are processed (in
708 handle_*_attribute) because the copy of the declarations available at that
709 point may not be canonical. For example, in:
711 void f();
712 void f() __attribute__((used));
714 the declaration we see in handle_used_attribute will be the second
715 declaration -- but the front end will subsequently merge that declaration
716 with the original declaration and discard the second declaration.
718 Furthermore, we can't mark these nodes in cgraph_finalize_function because:
720 void f() {}
721 void f() __attribute__((externally_visible));
723 is valid.
725 So, we walk the nodes at the end of the translation unit, applying the
726 attributes at that point. */
728 static void
729 process_function_and_variable_attributes (struct cgraph_node *first,
730 struct varpool_node *first_var)
732 struct cgraph_node *node;
733 struct varpool_node *vnode;
735 for (node = cgraph_nodes; node != first; node = node->next)
737 tree decl = node->decl;
738 if (lookup_attribute ("used", DECL_ATTRIBUTES (decl)))
740 mark_decl_referenced (decl);
741 if (node->local.finalized)
742 cgraph_mark_needed_node (node);
744 if (lookup_attribute ("externally_visible", DECL_ATTRIBUTES (decl)))
746 if (! TREE_PUBLIC (node->decl))
747 warning (OPT_Wattributes,
748 "%J%<externally_visible%> attribute have effect only on public objects",
749 node->decl);
750 else
752 if (node->local.finalized)
753 cgraph_mark_needed_node (node);
754 node->local.externally_visible = true;
758 for (vnode = varpool_nodes; vnode != first_var; vnode = vnode->next)
760 tree decl = vnode->decl;
761 if (lookup_attribute ("used", DECL_ATTRIBUTES (decl)))
763 mark_decl_referenced (decl);
764 if (vnode->finalized)
765 varpool_mark_needed_node (vnode);
767 if (lookup_attribute ("externally_visible", DECL_ATTRIBUTES (decl)))
769 if (! TREE_PUBLIC (vnode->decl))
770 warning (OPT_Wattributes,
771 "%J%<externally_visible%> attribute have effect only on public objects",
772 vnode->decl);
773 else
775 if (vnode->finalized)
776 varpool_mark_needed_node (vnode);
777 vnode->externally_visible = true;
783 /* Process CGRAPH_NODES_NEEDED queue, analyze each function (and transitively
784 each reachable functions) and build cgraph.
785 The function can be called multiple times after inserting new nodes
786 into beggining of queue. Just the new part of queue is re-scanned then. */
788 static void
789 cgraph_analyze_functions (void)
791 /* Keep track of already processed nodes when called multiple times for
792 intermodule optimization. */
793 static struct cgraph_node *first_analyzed;
794 struct cgraph_node *first_processed = first_analyzed;
795 static struct varpool_node *first_analyzed_var;
796 struct cgraph_node *node, *next;
798 process_function_and_variable_attributes (first_processed,
799 first_analyzed_var);
800 first_processed = cgraph_nodes;
801 first_analyzed_var = varpool_nodes;
802 varpool_analyze_pending_decls ();
803 if (cgraph_dump_file)
805 fprintf (cgraph_dump_file, "Initial entry points:");
806 for (node = cgraph_nodes; node != first_analyzed; node = node->next)
807 if (node->needed && DECL_SAVED_TREE (node->decl))
808 fprintf (cgraph_dump_file, " %s", cgraph_node_name (node));
809 fprintf (cgraph_dump_file, "\n");
811 cgraph_process_new_functions ();
813 /* Propagate reachability flag and lower representation of all reachable
814 functions. In the future, lowering will introduce new functions and
815 new entry points on the way (by template instantiation and virtual
816 method table generation for instance). */
817 while (cgraph_nodes_queue)
819 struct cgraph_edge *edge;
820 tree decl = cgraph_nodes_queue->decl;
822 node = cgraph_nodes_queue;
823 cgraph_nodes_queue = cgraph_nodes_queue->next_needed;
824 node->next_needed = NULL;
826 /* ??? It is possible to create extern inline function and later using
827 weak alias attribute to kill its body. See
828 gcc.c-torture/compile/20011119-1.c */
829 if (!DECL_SAVED_TREE (decl))
831 cgraph_reset_node (node);
832 continue;
835 gcc_assert (!node->analyzed && node->reachable);
836 gcc_assert (DECL_SAVED_TREE (decl));
838 cgraph_analyze_function (node);
840 for (edge = node->callees; edge; edge = edge->next_callee)
841 if (!edge->callee->reachable)
842 cgraph_mark_reachable_node (edge->callee);
844 /* We finalize local static variables during constructing callgraph
845 edges. Process their attributes too. */
846 process_function_and_variable_attributes (first_processed,
847 first_analyzed_var);
848 first_processed = cgraph_nodes;
849 first_analyzed_var = varpool_nodes;
850 varpool_analyze_pending_decls ();
851 cgraph_process_new_functions ();
854 /* Collect entry points to the unit. */
855 if (cgraph_dump_file)
857 fprintf (cgraph_dump_file, "Unit entry points:");
858 for (node = cgraph_nodes; node != first_analyzed; node = node->next)
859 if (node->needed && DECL_SAVED_TREE (node->decl))
860 fprintf (cgraph_dump_file, " %s", cgraph_node_name (node));
861 fprintf (cgraph_dump_file, "\n\nInitial ");
862 dump_cgraph (cgraph_dump_file);
865 if (cgraph_dump_file)
866 fprintf (cgraph_dump_file, "\nReclaiming functions:");
868 for (node = cgraph_nodes; node != first_analyzed; node = next)
870 tree decl = node->decl;
871 next = node->next;
873 if (node->local.finalized && !DECL_SAVED_TREE (decl))
874 cgraph_reset_node (node);
876 if (!node->reachable && DECL_SAVED_TREE (decl))
878 if (cgraph_dump_file)
879 fprintf (cgraph_dump_file, " %s", cgraph_node_name (node));
880 cgraph_remove_node (node);
881 continue;
883 else
884 node->next_needed = NULL;
885 gcc_assert (!node->local.finalized || DECL_SAVED_TREE (decl));
886 gcc_assert (node->analyzed == node->local.finalized);
888 if (cgraph_dump_file)
890 fprintf (cgraph_dump_file, "\n\nReclaimed ");
891 dump_cgraph (cgraph_dump_file);
893 first_analyzed = cgraph_nodes;
894 ggc_collect ();
897 /* Analyze the whole compilation unit once it is parsed completely. */
899 void
900 cgraph_finalize_compilation_unit (void)
902 if (errorcount || sorrycount)
903 return;
905 finish_aliases_1 ();
907 if (!flag_unit_at_a_time)
909 cgraph_output_pending_asms ();
910 cgraph_assemble_pending_functions ();
911 varpool_output_debug_info ();
912 return;
915 if (!quiet_flag)
917 fprintf (stderr, "\nAnalyzing compilation unit\n");
918 fflush (stderr);
921 timevar_push (TV_CGRAPH);
922 cgraph_analyze_functions ();
923 timevar_pop (TV_CGRAPH);
925 /* Figure out what functions we want to assemble. */
927 static void
928 cgraph_mark_functions_to_output (void)
930 struct cgraph_node *node;
932 for (node = cgraph_nodes; node; node = node->next)
934 tree decl = node->decl;
935 struct cgraph_edge *e;
937 gcc_assert (!node->output);
939 for (e = node->callers; e; e = e->next_caller)
940 if (e->inline_failed)
941 break;
943 /* We need to output all local functions that are used and not
944 always inlined, as well as those that are reachable from
945 outside the current compilation unit. */
946 if (DECL_SAVED_TREE (decl)
947 && !node->global.inlined_to
948 && (node->needed
949 || (e && node->reachable))
950 && !TREE_ASM_WRITTEN (decl)
951 && !DECL_EXTERNAL (decl))
952 node->output = 1;
953 else
955 /* We should've reclaimed all functions that are not needed. */
956 #ifdef ENABLE_CHECKING
957 if (!node->global.inlined_to && DECL_SAVED_TREE (decl)
958 && !DECL_EXTERNAL (decl))
960 dump_cgraph_node (stderr, node);
961 internal_error ("failed to reclaim unneeded function");
963 #endif
964 gcc_assert (node->global.inlined_to || !DECL_SAVED_TREE (decl)
965 || DECL_EXTERNAL (decl));
972 /* Expand function specified by NODE. */
974 static void
975 cgraph_expand_function (struct cgraph_node *node)
977 tree decl = node->decl;
979 /* We ought to not compile any inline clones. */
980 gcc_assert (!node->global.inlined_to);
982 if (flag_unit_at_a_time)
983 announce_function (decl);
985 gcc_assert (node->lowered);
987 /* Generate RTL for the body of DECL. */
988 lang_hooks.callgraph.expand_function (decl);
990 /* Make sure that BE didn't give up on compiling. */
991 /* ??? Can happen with nested function of extern inline. */
992 gcc_assert (TREE_ASM_WRITTEN (node->decl));
994 current_function_decl = NULL;
995 if (!cgraph_preserve_function_body_p (node->decl))
997 cgraph_release_function_body (node);
998 /* Eliminate all call edges. This is important so the call_expr no longer
999 points to the dead function body. */
1000 cgraph_node_remove_callees (node);
1003 cgraph_function_flags_ready = true;
1006 /* Return true when CALLER_DECL should be inlined into CALLEE_DECL. */
1008 bool
1009 cgraph_inline_p (struct cgraph_edge *e, const char **reason)
1011 *reason = e->inline_failed;
1012 return !e->inline_failed;
1017 /* Expand all functions that must be output.
1019 Attempt to topologically sort the nodes so function is output when
1020 all called functions are already assembled to allow data to be
1021 propagated across the callgraph. Use a stack to get smaller distance
1022 between a function and its callees (later we may choose to use a more
1023 sophisticated algorithm for function reordering; we will likely want
1024 to use subsections to make the output functions appear in top-down
1025 order). */
1027 static void
1028 cgraph_expand_all_functions (void)
1030 struct cgraph_node *node;
1031 struct cgraph_node **order = XCNEWVEC (struct cgraph_node *, cgraph_n_nodes);
1032 int order_pos = 0, new_order_pos = 0;
1033 int i;
1035 order_pos = cgraph_postorder (order);
1036 gcc_assert (order_pos == cgraph_n_nodes);
1038 /* Garbage collector may remove inline clones we eliminate during
1039 optimization. So we must be sure to not reference them. */
1040 for (i = 0; i < order_pos; i++)
1041 if (order[i]->output)
1042 order[new_order_pos++] = order[i];
1044 for (i = new_order_pos - 1; i >= 0; i--)
1046 node = order[i];
1047 if (node->output)
1049 gcc_assert (node->reachable);
1050 node->output = 0;
1051 cgraph_expand_function (node);
1054 cgraph_process_new_functions ();
1056 free (order);
1060 /* This is used to sort the node types by the cgraph order number. */
1062 struct cgraph_order_sort
1064 enum { ORDER_UNDEFINED = 0, ORDER_FUNCTION, ORDER_VAR, ORDER_ASM } kind;
1065 union
1067 struct cgraph_node *f;
1068 struct varpool_node *v;
1069 struct cgraph_asm_node *a;
1070 } u;
1073 /* Output all functions, variables, and asm statements in the order
1074 according to their order fields, which is the order in which they
1075 appeared in the file. This implements -fno-toplevel-reorder. In
1076 this mode we may output functions and variables which don't really
1077 need to be output. */
1079 static void
1080 cgraph_output_in_order (void)
1082 int max;
1083 size_t size;
1084 struct cgraph_order_sort *nodes;
1085 int i;
1086 struct cgraph_node *pf;
1087 struct varpool_node *pv;
1088 struct cgraph_asm_node *pa;
1090 max = cgraph_order;
1091 size = max * sizeof (struct cgraph_order_sort);
1092 nodes = (struct cgraph_order_sort *) alloca (size);
1093 memset (nodes, 0, size);
1095 varpool_analyze_pending_decls ();
1097 for (pf = cgraph_nodes; pf; pf = pf->next)
1099 if (pf->output)
1101 i = pf->order;
1102 gcc_assert (nodes[i].kind == ORDER_UNDEFINED);
1103 nodes[i].kind = ORDER_FUNCTION;
1104 nodes[i].u.f = pf;
1108 for (pv = varpool_nodes_queue; pv; pv = pv->next_needed)
1110 i = pv->order;
1111 gcc_assert (nodes[i].kind == ORDER_UNDEFINED);
1112 nodes[i].kind = ORDER_VAR;
1113 nodes[i].u.v = pv;
1116 for (pa = cgraph_asm_nodes; pa; pa = pa->next)
1118 i = pa->order;
1119 gcc_assert (nodes[i].kind == ORDER_UNDEFINED);
1120 nodes[i].kind = ORDER_ASM;
1121 nodes[i].u.a = pa;
1124 for (i = 0; i < max; ++i)
1126 switch (nodes[i].kind)
1128 case ORDER_FUNCTION:
1129 nodes[i].u.f->output = 0;
1130 cgraph_expand_function (nodes[i].u.f);
1131 break;
1133 case ORDER_VAR:
1134 varpool_assemble_decl (nodes[i].u.v);
1135 break;
1137 case ORDER_ASM:
1138 assemble_asm (nodes[i].u.a->asm_str);
1139 break;
1141 case ORDER_UNDEFINED:
1142 break;
1144 default:
1145 gcc_unreachable ();
1149 cgraph_asm_nodes = NULL;
1152 /* Return true when function body of DECL still needs to be kept around
1153 for later re-use. */
1154 bool
1155 cgraph_preserve_function_body_p (tree decl)
1157 struct cgraph_node *node;
1158 if (!cgraph_global_info_ready)
1159 return (flag_really_no_inline
1160 ? lang_hooks.tree_inlining.disregard_inline_limits (decl)
1161 : DECL_INLINE (decl));
1162 /* Look if there is any clone around. */
1163 for (node = cgraph_node (decl); node; node = node->next_clone)
1164 if (node->global.inlined_to)
1165 return true;
1166 return false;
1169 static void
1170 ipa_passes (void)
1172 cfun = NULL;
1173 current_function_decl = NULL;
1174 tree_register_cfg_hooks ();
1175 bitmap_obstack_initialize (NULL);
1176 execute_ipa_pass_list (all_ipa_passes);
1177 bitmap_obstack_release (NULL);
1180 /* Perform simple optimizations based on callgraph. */
1182 void
1183 cgraph_optimize (void)
1185 if (errorcount || sorrycount)
1186 return;
1188 #ifdef ENABLE_CHECKING
1189 verify_cgraph ();
1190 #endif
1191 if (!flag_unit_at_a_time)
1193 cgraph_assemble_pending_functions ();
1194 cgraph_process_new_functions ();
1195 cgraph_state = CGRAPH_STATE_FINISHED;
1196 cgraph_output_pending_asms ();
1197 varpool_assemble_pending_decls ();
1198 varpool_output_debug_info ();
1199 return;
1202 /* Frontend may output common variables after the unit has been finalized.
1203 It is safe to deal with them here as they are always zero initialized. */
1204 varpool_analyze_pending_decls ();
1205 cgraph_analyze_functions ();
1207 timevar_push (TV_CGRAPHOPT);
1208 if (pre_ipa_mem_report)
1210 fprintf (stderr, "Memory consumption before IPA\n");
1211 dump_memory_report (false);
1213 if (!quiet_flag)
1214 fprintf (stderr, "Performing interprocedural optimizations\n");
1215 cgraph_state = CGRAPH_STATE_IPA;
1217 /* Don't run the IPA passes if there was any error or sorry messages. */
1218 if (errorcount == 0 && sorrycount == 0)
1219 ipa_passes ();
1221 /* This pass remove bodies of extern inline functions we never inlined.
1222 Do this later so other IPA passes see what is really going on. */
1223 cgraph_remove_unreachable_nodes (false, dump_file);
1224 cgraph_global_info_ready = true;
1225 if (cgraph_dump_file)
1227 fprintf (cgraph_dump_file, "Optimized ");
1228 dump_cgraph (cgraph_dump_file);
1229 dump_varpool (cgraph_dump_file);
1231 if (post_ipa_mem_report)
1233 fprintf (stderr, "Memory consumption after IPA\n");
1234 dump_memory_report (false);
1236 timevar_pop (TV_CGRAPHOPT);
1238 /* Output everything. */
1239 if (!quiet_flag)
1240 fprintf (stderr, "Assembling functions:\n");
1241 #ifdef ENABLE_CHECKING
1242 verify_cgraph ();
1243 #endif
1245 cgraph_mark_functions_to_output ();
1247 cgraph_state = CGRAPH_STATE_EXPANSION;
1248 if (!flag_toplevel_reorder)
1249 cgraph_output_in_order ();
1250 else
1252 cgraph_output_pending_asms ();
1254 cgraph_expand_all_functions ();
1255 varpool_remove_unreferenced_decls ();
1257 varpool_assemble_pending_decls ();
1258 varpool_output_debug_info ();
1260 cgraph_process_new_functions ();
1261 cgraph_state = CGRAPH_STATE_FINISHED;
1263 if (cgraph_dump_file)
1265 fprintf (cgraph_dump_file, "\nFinal ");
1266 dump_cgraph (cgraph_dump_file);
1268 #ifdef ENABLE_CHECKING
1269 verify_cgraph ();
1270 /* Double check that all inline clones are gone and that all
1271 function bodies have been released from memory. */
1272 if (flag_unit_at_a_time
1273 && !(sorrycount || errorcount))
1275 struct cgraph_node *node;
1276 bool error_found = false;
1278 for (node = cgraph_nodes; node; node = node->next)
1279 if (node->analyzed
1280 && (node->global.inlined_to
1281 || DECL_SAVED_TREE (node->decl)))
1283 error_found = true;
1284 dump_cgraph_node (stderr, node);
1286 if (error_found)
1287 internal_error ("nodes with no released memory found");
1289 #endif
1291 /* Generate and emit a static constructor or destructor. WHICH must be
1292 one of 'I' or 'D'. BODY should be a STATEMENT_LIST containing
1293 GENERIC statements. */
1295 void
1296 cgraph_build_static_cdtor (char which, tree body, int priority)
1298 static int counter = 0;
1299 char which_buf[16];
1300 tree decl, name, resdecl;
1302 sprintf (which_buf, "%c_%d", which, counter++);
1303 name = get_file_function_name (which_buf);
1305 decl = build_decl (FUNCTION_DECL, name,
1306 build_function_type (void_type_node, void_list_node));
1307 current_function_decl = decl;
1309 resdecl = build_decl (RESULT_DECL, NULL_TREE, void_type_node);
1310 DECL_ARTIFICIAL (resdecl) = 1;
1311 DECL_IGNORED_P (resdecl) = 1;
1312 DECL_RESULT (decl) = resdecl;
1314 allocate_struct_function (decl);
1316 TREE_STATIC (decl) = 1;
1317 TREE_USED (decl) = 1;
1318 DECL_ARTIFICIAL (decl) = 1;
1319 DECL_IGNORED_P (decl) = 1;
1320 DECL_NO_INSTRUMENT_FUNCTION_ENTRY_EXIT (decl) = 1;
1321 DECL_SAVED_TREE (decl) = body;
1322 TREE_PUBLIC (decl) = ! targetm.have_ctors_dtors;
1323 DECL_UNINLINABLE (decl) = 1;
1325 DECL_INITIAL (decl) = make_node (BLOCK);
1326 TREE_USED (DECL_INITIAL (decl)) = 1;
1328 DECL_SOURCE_LOCATION (decl) = input_location;
1329 cfun->function_end_locus = input_location;
1331 switch (which)
1333 case 'I':
1334 DECL_STATIC_CONSTRUCTOR (decl) = 1;
1335 break;
1336 case 'D':
1337 DECL_STATIC_DESTRUCTOR (decl) = 1;
1338 break;
1339 default:
1340 gcc_unreachable ();
1343 gimplify_function_tree (decl);
1345 cgraph_add_new_function (decl, false);
1346 cgraph_mark_needed_node (cgraph_node (decl));
1348 if (targetm.have_ctors_dtors)
1350 void (*fn) (rtx, int);
1352 if (which == 'I')
1353 fn = targetm.asm_out.constructor;
1354 else
1355 fn = targetm.asm_out.destructor;
1356 fn (XEXP (DECL_RTL (decl), 0), priority);
1360 void
1361 init_cgraph (void)
1363 cgraph_dump_file = dump_begin (TDI_cgraph, NULL);
1366 /* The edges representing the callers of the NEW_VERSION node were
1367 fixed by cgraph_function_versioning (), now the call_expr in their
1368 respective tree code should be updated to call the NEW_VERSION. */
1370 static void
1371 update_call_expr (struct cgraph_node *new_version)
1373 struct cgraph_edge *e;
1375 gcc_assert (new_version);
1376 for (e = new_version->callers; e; e = e->next_caller)
1377 /* Update the call expr on the edges
1378 to call the new version. */
1379 TREE_OPERAND (TREE_OPERAND (get_call_expr_in (e->call_stmt), 0), 0) = new_version->decl;
1383 /* Create a new cgraph node which is the new version of
1384 OLD_VERSION node. REDIRECT_CALLERS holds the callers
1385 edges which should be redirected to point to
1386 NEW_VERSION. ALL the callees edges of OLD_VERSION
1387 are cloned to the new version node. Return the new
1388 version node. */
1390 static struct cgraph_node *
1391 cgraph_copy_node_for_versioning (struct cgraph_node *old_version,
1392 tree new_decl,
1393 VEC(cgraph_edge_p,heap) *redirect_callers)
1395 struct cgraph_node *new_version;
1396 struct cgraph_edge *e, *new_e;
1397 struct cgraph_edge *next_callee;
1398 unsigned i;
1400 gcc_assert (old_version);
1402 new_version = cgraph_node (new_decl);
1404 new_version->analyzed = true;
1405 new_version->local = old_version->local;
1406 new_version->global = old_version->global;
1407 new_version->rtl = new_version->rtl;
1408 new_version->reachable = true;
1409 new_version->count = old_version->count;
1411 /* Clone the old node callees. Recursive calls are
1412 also cloned. */
1413 for (e = old_version->callees;e; e=e->next_callee)
1415 new_e = cgraph_clone_edge (e, new_version, e->call_stmt, 0, e->loop_nest, true);
1416 new_e->count = e->count;
1418 /* Fix recursive calls.
1419 If OLD_VERSION has a recursive call after the
1420 previous edge cloning, the new version will have an edge
1421 pointing to the old version, which is wrong;
1422 Redirect it to point to the new version. */
1423 for (e = new_version->callees ; e; e = next_callee)
1425 next_callee = e->next_callee;
1426 if (e->callee == old_version)
1427 cgraph_redirect_edge_callee (e, new_version);
1429 if (!next_callee)
1430 break;
1432 for (i = 0; VEC_iterate (cgraph_edge_p, redirect_callers, i, e); i++)
1434 /* Redirect calls to the old version node to point to its new
1435 version. */
1436 cgraph_redirect_edge_callee (e, new_version);
1439 return new_version;
1442 /* Perform function versioning.
1443 Function versioning includes copying of the tree and
1444 a callgraph update (creating a new cgraph node and updating
1445 its callees and callers).
1447 REDIRECT_CALLERS varray includes the edges to be redirected
1448 to the new version.
1450 TREE_MAP is a mapping of tree nodes we want to replace with
1451 new ones (according to results of prior analysis).
1452 OLD_VERSION_NODE is the node that is versioned.
1453 It returns the new version's cgraph node. */
1455 struct cgraph_node *
1456 cgraph_function_versioning (struct cgraph_node *old_version_node,
1457 VEC(cgraph_edge_p,heap) *redirect_callers,
1458 varray_type tree_map)
1460 tree old_decl = old_version_node->decl;
1461 struct cgraph_node *new_version_node = NULL;
1462 tree new_decl;
1464 if (!tree_versionable_function_p (old_decl))
1465 return NULL;
1467 /* Make a new FUNCTION_DECL tree node for the
1468 new version. */
1469 new_decl = copy_node (old_decl);
1471 /* Create the new version's call-graph node.
1472 and update the edges of the new node. */
1473 new_version_node =
1474 cgraph_copy_node_for_versioning (old_version_node, new_decl,
1475 redirect_callers);
1477 /* Copy the OLD_VERSION_NODE function tree to the new version. */
1478 tree_function_versioning (old_decl, new_decl, tree_map, false);
1479 /* Update the call_expr on the edges to call the new version node. */
1480 update_call_expr (new_version_node);
1482 /* Update the new version's properties.
1483 Make The new version visible only within this translation unit.
1484 ??? We cannot use COMDAT linkage because there is no
1485 ABI support for this. */
1486 DECL_EXTERNAL (new_version_node->decl) = 0;
1487 DECL_ONE_ONLY (new_version_node->decl) = 0;
1488 TREE_PUBLIC (new_version_node->decl) = 0;
1489 DECL_COMDAT (new_version_node->decl) = 0;
1490 new_version_node->local.externally_visible = 0;
1491 new_version_node->local.local = 1;
1492 new_version_node->lowered = true;
1493 return new_version_node;
1496 /* Produce separate function body for inline clones so the offline copy can be
1497 modified without affecting them. */
1498 struct cgraph_node *
1499 save_inline_function_body (struct cgraph_node *node)
1501 struct cgraph_node *first_clone;
1503 gcc_assert (node == cgraph_node (node->decl));
1505 cgraph_lower_function (node);
1507 /* In non-unit-at-a-time we construct full fledged clone we never output to
1508 assembly file. This clone is pointed out by inline_decl of original function
1509 and inlining infrastructure knows how to deal with this. */
1510 if (!flag_unit_at_a_time)
1512 struct cgraph_edge *e;
1514 first_clone = cgraph_clone_node (node, node->count, 0, false);
1515 first_clone->needed = 0;
1516 first_clone->reachable = 1;
1517 /* Recursively clone all bodies. */
1518 for (e = first_clone->callees; e; e = e->next_callee)
1519 if (!e->inline_failed)
1520 cgraph_clone_inlined_nodes (e, true, false);
1522 else
1523 first_clone = node->next_clone;
1525 first_clone->decl = copy_node (node->decl);
1526 node->next_clone = NULL;
1527 if (!flag_unit_at_a_time)
1528 node->inline_decl = first_clone->decl;
1529 first_clone->prev_clone = NULL;
1530 cgraph_insert_node_to_hashtable (first_clone);
1531 gcc_assert (first_clone == cgraph_node (first_clone->decl));
1533 /* Copy the OLD_VERSION_NODE function tree to the new version. */
1534 tree_function_versioning (node->decl, first_clone->decl, NULL, true);
1536 DECL_EXTERNAL (first_clone->decl) = 0;
1537 DECL_ONE_ONLY (first_clone->decl) = 0;
1538 TREE_PUBLIC (first_clone->decl) = 0;
1539 DECL_COMDAT (first_clone->decl) = 0;
1541 for (node = first_clone->next_clone; node; node = node->next_clone)
1542 node->decl = first_clone->decl;
1543 #ifdef ENABLE_CHECKING
1544 verify_cgraph_node (first_clone);
1545 #endif
1546 return first_clone;